From 15ab3b149a131b69092d2b45740ab3a2946ff2a2 Mon Sep 17 00:00:00 2001 From: GH Action CI Stream Date: Wed, 27 Aug 2025 07:52:32 +0000 Subject: [PATCH] Update video openapi Spec --- openapi/chat-openapi-clientside.json | 2 +- openapi/chat-openapi-clientside.yaml | 271 +- openapi/chat-openapi.json | 2 +- openapi/chat-openapi.yaml | 426 +- openapi/clientside-api.json | 2 +- openapi/clientside-api.yaml | 42689 ++++++++++++-------- openapi/moderation-clientside-api.json | 2 +- openapi/moderation-clientside-api.yaml | 351 +- openapi/moderation-serverside-api.json | 2 +- openapi/moderation-serverside-api.yaml | 711 +- openapi/serverside-api.json | 2 +- openapi/serverside-api.yaml | 32017 ++++++++++----- openapi/v2/chat-clientside-api.json | 2 +- openapi/v2/chat-clientside-api.yaml | 522 +- openapi/v2/chat-serverside-api.json | 2 +- openapi/v2/chat-serverside-api.yaml | 1027 +- openapi/v2/clientside-api.json | 2 +- openapi/v2/clientside-api.yaml | 42689 ++++++++++++-------- openapi/v2/feeds-clientside-api.json | 1 + openapi/v2/feeds-clientside-api.yaml | 19841 +++++++++ openapi/v2/feeds-serverside-api.json | 1 + openapi/v2/feeds-serverside-api.yaml | 26098 ++++++++++++ openapi/v2/moderation-clientside-api.json | 2 +- openapi/v2/moderation-clientside-api.yaml | 351 +- openapi/v2/moderation-serverside-api.json | 2 +- openapi/v2/moderation-serverside-api.yaml | 711 +- openapi/v2/serverside-api.json | 2 +- openapi/v2/serverside-api.yaml | 32017 ++++++++++----- openapi/v2/video-clientside-api.json | 2 +- openapi/v2/video-clientside-api.yaml | 238 +- openapi/v2/video-serverside-api.json | 2 +- openapi/v2/video-serverside-api.yaml | 285 +- openapi/video-openapi-clientside.json | 2 +- openapi/video-openapi-clientside.yaml | 157 +- openapi/video-openapi.json | 2 +- openapi/video-openapi.yaml | 180 +- 36 files changed, 144049 insertions(+), 56566 deletions(-) create mode 100644 openapi/v2/feeds-clientside-api.json create mode 100644 openapi/v2/feeds-clientside-api.yaml create mode 100644 openapi/v2/feeds-serverside-api.json create mode 100644 openapi/v2/feeds-serverside-api.yaml diff --git a/openapi/chat-openapi-clientside.json b/openapi/chat-openapi-clientside.json index f0afa6a62..2389dcedc 100644 --- a/openapi/chat-openapi-clientside.json +++ b/openapi/chat-openapi-clientside.json @@ -1 +1 @@ -{"components":{"schemas":{"AIIndicatorClearEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"ai_indicator.clear","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"AIIndicatorClearEvent","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"},"AIIndicatorStopEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"ai_indicator.stop","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"AIIndicatorStopEvent","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"},"AIIndicatorUpdateEvent":{"properties":{"ai_message":{"type":"string","x-stream-index":"005"},"ai_state":{"type":"string","x-stream-index":"004"},"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"message_id":{"type":"string","x-stream-index":"003"},"type":{"default":"ai_indicator.update","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","cid","channel_id","channel_type","message_id","ai_state"],"title":"AIIndicatorUpdateEvent","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"},"APIError":{"nullable":true,"properties":{"StatusCode":{"description":"Response HTTP status code","format":"int32","title":"Status code","type":"integer","x-stream-index":"004"},"code":{"description":"API error code","format":"int32","title":"Code","type":"integer","x-stream-index":"001"},"details":{"description":"Additional error-specific information","items":{"type":"integer"},"title":"Details","type":"array","x-stream-index":"007"},"duration":{"description":"Request duration","title":"Duration","type":"string","x-stream-index":"005"},"exception_fields":{"additionalProperties":{"type":"string"},"description":"Additional error info","title":"Exception fields","type":"object","x-stream-index":"003"},"message":{"description":"Message describing an error","title":"Message","type":"string","x-stream-index":"002"},"more_info":{"description":"URL with additional information","title":"More info","type":"string","x-stream-index":"006"},"unrecoverable":{"description":"Flag that indicates if the error is unrecoverable, requests that return unrecoverable errors should not be retried, this error only applies to the request that caused it","title":"Unrecoverable","type":"boolean","x-stream-index":"008"}},"required":["code","message","StatusCode","duration","more_info","details"],"title":"Error response","type":"object"},"Action":{"nullable":true,"properties":{"name":{"type":"string","x-stream-index":"001"},"style":{"type":"string","x-stream-index":"003"},"text":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"004"},"value":{"type":"string","x-stream-index":"005"}},"required":["name","text","type"],"type":"object"},"ActivityMarkedEvent":{"properties":{"all_read":{"type":"boolean","x-stream-index":"006"},"all_seen":{"type":"boolean","x-stream-index":"007"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"feed_id":{"type":"string","x-stream-index":"003"},"marked_read":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"marked_watched":{"items":{"type":"string"},"type":"array","x-stream-index":"005"},"type":{"default":"activity.marked","type":"string","x-stream-index":"001.001"},"user_id":{"type":"string","x-stream-index":"002"}},"required":["type","created_at","user_id","feed_id","all_read","all_seen"],"title":"ActivityMarkedEvent","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"},"AnyEvent":{"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"*","type":"string","x-stream-index":"001.001"}},"required":["type","created_at"],"title":"AnyEvent","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"},"AppEventResponse":{"properties":{"async_url_enrich_enabled":{"description":"boolean","title":"Async URL Enrichment Enabled","type":"boolean","x-stream-index":"002"},"auto_translation_enabled":{"description":"boolean","title":"Auto Translation Enabled","type":"boolean","x-stream-index":"003"},"file_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","description":"file upload config","title":"File Upload Config","x-stream-index":"004"},"image_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","description":"file upload config","title":"Image Upload Config","x-stream-index":"005"},"name":{"description":"string","title":"App name","type":"string","x-stream-index":"001"}},"required":["name","auto_translation_enabled"],"type":"object"},"AppResponseFields":{"properties":{"async_url_enrich_enabled":{"type":"boolean","x-stream-index":"017"},"auto_translation_enabled":{"type":"boolean","x-stream-index":"020"},"file_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","x-stream-index":"030"},"image_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","x-stream-index":"031"},"name":{"type":"string","x-stream-index":"001"}},"required":["name","organization","push_notifications","webhook_url","moderation_webhook_url","channel_configs","call_types","policies","suspended","suspended_explanation","disable_auth_checks","disable_permissions_checks","permission_version","user_search_disallowed_roles","multi_tenant_enabled","image_moderation_enabled","async_url_enrich_enabled","auto_translation_enabled","custom_action_handler_url","enforce_unique_usernames","sqs_url","sqs_key","sqs_secret","sns_topic_arn","sns_key","sns_secret","file_upload_config","image_upload_config","grants","campaign_enabled","webhook_events","reminders_interval","cdn_expiration_seconds","video_provider","moderation_enabled","moderation_multitenant_blocklist_enabled","guest_user_creation_disabled","event_hooks","use_hook_v2","user_response_time_enabled","moderation_bulk_submit_action_enabled"],"type":"object"},"AppUpdatedEvent":{"description":"Emitted when app settings are updated","nullable":true,"properties":{"app":{"$ref":"#/components/schemas/AppEventResponse","description":"application configuration","title":"App settings","x-stream-index":"002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"received_at":{"format":"date-time","type":"string","x-stream-index":"001.004"},"type":{"default":"app.updated","description":"The type of event: \"app.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.002"}},"required":["type","created_at","custom","app"],"title":"AppUpdatedEvent","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"},"Attachment":{"description":"An attachment is a message object that represents a file uploaded by a user.","nullable":true,"properties":{"actions":{"items":{"$ref":"#/components/schemas/Action"},"type":"array","x-stream-index":"015"},"asset_url":{"type":"string","x-stream-index":"017"},"author_icon":{"type":"string","x-stream-index":"007"},"author_link":{"type":"string","x-stream-index":"006"},"author_name":{"type":"string","x-stream-index":"005"},"color":{"type":"string","x-stream-index":"003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"018"},"fallback":{"type":"string","x-stream-index":"002"},"fields":{"items":{"$ref":"#/components/schemas/Field"},"type":"array","x-stream-index":"016"},"footer":{"type":"string","x-stream-index":"013"},"footer_icon":{"type":"string","x-stream-index":"014"},"giphy":{"$ref":"#/components/schemas/Images","x-stream-index":"019"},"image_url":{"type":"string","x-stream-index":"011"},"og_scrape_url":{"type":"string","x-stream-index":"020"},"original_height":{"format":"int32","type":"integer","x-stream-index":"022"},"original_width":{"format":"int32","type":"integer","x-stream-index":"021"},"pretext":{"type":"string","x-stream-index":"004"},"text":{"type":"string","x-stream-index":"010"},"thumb_url":{"type":"string","x-stream-index":"012"},"title":{"type":"string","x-stream-index":"008"},"title_link":{"type":"string","x-stream-index":"009"},"type":{"description":"Attachment type (e.g. image, video, url)","title":"Type","type":"string","x-stream-index":"001"}},"required":["custom"],"title":"Attachment","type":"object","x-stream-docs-page-id":"file_uploads"},"AutomodDetails":{"properties":{"action":{"type":"string","x-stream-index":"001"},"image_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"005"},"message_details":{"$ref":"#/components/schemas/FlagMessageDetails","x-stream-index":"004"},"original_message_type":{"type":"string","x-stream-index":"002"},"result":{"$ref":"#/components/schemas/MessageModerationResult","x-stream-index":"003"}},"type":"object"},"BanRequest":{"nullable":true,"properties":{"banned_by":{"$ref":"#/components/schemas/UserRequest","description":"User who issued a ban","title":"Banned by","x-stream-index":"010"},"banned_by_id":{"description":"User ID who issued a ban","title":"Banned by ID","type":"string","x-stream-index":"009"},"channel_cid":{"description":"Channel CID to ban user in eg. messaging:123","title":"Channel CID","type":"string","x-stream-index":"006"},"delete_messages":{"enum":["soft","pruning","hard"],"type":"string","x-stream-index":"011"},"ip_ban":{"description":"Whether to perform IP ban or not","title":"IP ban","type":"boolean","x-stream-index":"008"},"reason":{"description":"Ban reason","title":"Reason","type":"string","x-stream-index":"003"},"shadow":{"description":"Whether to perform shadow ban or not","title":"Shadow","type":"boolean","x-stream-index":"007"},"target_user_id":{"description":"ID of user to ban","title":"Target user ID","type":"string","x-stream-index":"001"},"timeout":{"description":"Timeout of ban in minutes. User will be unbanned after this period of time","title":"Timeout","type":"integer","x-stream-index":"002"}},"required":["target_user_id"],"type":"object"},"BanResponse":{"nullable":true,"properties":{"banned_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"006"},"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"007"},"expires":{"format":"date-time","type":"string","x-stream-index":"003"},"reason":{"type":"string","x-stream-index":"004"},"shadow":{"type":"boolean","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"}},"required":["created_at"],"type":"object"},"BlockListOptions":{"properties":{"behavior":{"description":"Blocklist behavior","enum":["flag","block","shadow_block"],"title":"Behavior","type":"string","x-stream-index":"002"},"blocklist":{"description":"Blocklist name","title":"Blocklist","type":"string","x-stream-index":"001"}},"required":["blocklist","behavior"],"type":"object"},"BlockListResponse":{"description":"Block list contains restricted words","properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001"},"id":{"type":"string","x-stream-index":"003"},"name":{"description":"Block list name","title":"Name","type":"string","x-stream-index":"004"},"team":{"type":"string","x-stream-index":"007"},"type":{"description":"Block list type.","title":"Type","type":"string","x-stream-index":"005"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"002"},"words":{"description":"List of words to block","items":{"type":"string"},"title":"Words","type":"array","x-stream-index":"006"}},"required":["name","type","words"],"title":"Block list","type":"object","x-stream-docs-page-id":"block_lists"},"BlockUsersRequest":{"nullable":true,"properties":{"blocked_user_id":{"description":"User id to block","title":"BlockedUserID","type":"string","x-stream-index":"001"}},"required":["blocked_user_id"],"type":"object"},"BlockUsersResponse":{"nullable":true,"properties":{"blocked_by_user_id":{"description":"User id who blocked another user","title":"BlockedByUserID","type":"string","x-stream-index":"002"},"blocked_user_id":{"description":"User id who got blocked","title":"BlockedUserID","type":"string","x-stream-index":"003"},"created_at":{"description":"Timestamp when the user was blocked","format":"date-time","title":"CreatedAt","type":"string","x-stream-index":"004"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration","blocked_by_user_id","blocked_user_id","created_at"],"type":"object"},"BlockedUserResponse":{"nullable":true,"properties":{"blocked_user":{"$ref":"#/components/schemas/UserResponse","description":"User who got blocked","title":"User","x-stream-index":"003"},"blocked_user_id":{"description":"ID of the user who got blocked","title":"UserID","type":"string","x-stream-index":"004"},"created_at":{"format":"date-time","type":"string","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who blocked another user","title":"User","x-stream-index":"001"},"user_id":{"description":"ID of the user who blocked another user","title":"UserID","type":"string","x-stream-index":"002"}},"required":["user","user_id","blocked_user","blocked_user_id","created_at"],"type":"object"},"CastPollVoteRequest":{"nullable":true,"properties":{"vote":{"$ref":"#/components/schemas/VoteData","description":"Vote data","title":"VoteData","x-stream-index":"004"}},"type":"object"},"Channel":{"properties":{"active_live_locations":{"items":{"$ref":"#/components/schemas/SharedLocation"},"type":"array","x-stream-index":"034"},"auto_translation_enabled":{"type":"boolean","x-stream-index":"029"},"auto_translation_language":{"type":"string","x-stream-index":"030"},"cid":{"type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/ChannelConfig","x-stream-index":"026"},"config_overrides":{"$ref":"#/components/schemas/ConfigOverrides","x-stream-index":"027"},"cooldown":{"format":"int32","type":"integer","x-stream-index":"031"},"created_at":{"format":"date-time","type":"string","x-stream-index":"009"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"019"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"011"},"disabled":{"type":"boolean","x-stream-index":"017"},"frozen":{"type":"boolean","x-stream-index":"016"},"id":{"type":"string","x-stream-index":"004"},"invites":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"022"},"last_campaigns":{"type":"string","x-stream-index":"032"},"last_message_at":{"format":"date-time","type":"string","x-stream-index":"006"},"member_count":{"format":"int32","type":"integer","x-stream-index":"021"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"020"},"team":{"type":"string","x-stream-index":"028"},"truncated_by":{"$ref":"#/components/schemas/User","x-stream-index":"015"},"type":{"type":"string","x-stream-index":"005"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"010"}},"required":["cid","id","type","created_at","updated_at","frozen","disabled","custom","auto_translation_language"],"type":"object"},"ChannelConfig":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.026"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.021"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.022"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.027"},"blocklist":{"type":"string","x-stream-index":"001.023"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.024"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.025"},"commands":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"connect_events":{"type":"boolean","x-stream-index":"001.004"},"created_at":{"format":"date-time","type":"string","x-stream-index":"002.003"},"custom_events":{"type":"boolean","x-stream-index":"001.012"},"mark_messages_pending":{"type":"boolean","x-stream-index":"001.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"001.020"},"mutes":{"type":"boolean","x-stream-index":"001.009"},"name":{"type":"string","x-stream-index":"001.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"001.028"},"partition_ttl":{"type":"integer","x-stream-index":"001.029"},"polls":{"type":"boolean","x-stream-index":"001.016"},"push_notifications":{"type":"boolean","x-stream-index":"001.013"},"quotes":{"type":"boolean","x-stream-index":"001.008"},"reactions":{"type":"boolean","x-stream-index":"001.006"},"read_events":{"type":"boolean","x-stream-index":"001.003"},"reminders":{"type":"boolean","x-stream-index":"001.014"},"replies":{"type":"boolean","x-stream-index":"001.007"},"search":{"type":"boolean","x-stream-index":"001.005"},"shared_locations":{"type":"boolean","x-stream-index":"001.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.030"},"typing_events":{"type":"boolean","x-stream-index":"001.002"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"002.004"},"uploads":{"type":"boolean","x-stream-index":"001.010"},"url_enrichment":{"type":"boolean","x-stream-index":"001.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"001.017"}},"required":["name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","created_at","updated_at","commands"],"type":"object"},"ChannelConfigWithInfo":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.002.026"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.002.021"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.022"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.002.027"},"blocklist":{"type":"string","x-stream-index":"001.002.023"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.024"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.002.025"},"commands":{"items":{"$ref":"#/components/schemas/Command"},"type":"array","x-stream-index":"001.003"},"connect_events":{"type":"boolean","x-stream-index":"001.002.004"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.001.003"},"custom_events":{"type":"boolean","x-stream-index":"001.002.012"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"002"},"mark_messages_pending":{"type":"boolean","x-stream-index":"001.002.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"001.002.020"},"mutes":{"type":"boolean","x-stream-index":"001.002.009"},"name":{"type":"string","x-stream-index":"001.002.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"001.002.028"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"001.002.029"},"polls":{"type":"boolean","x-stream-index":"001.002.016"},"push_notifications":{"type":"boolean","x-stream-index":"001.002.013"},"quotes":{"type":"boolean","x-stream-index":"001.002.008"},"reactions":{"type":"boolean","x-stream-index":"001.002.006"},"read_events":{"type":"boolean","x-stream-index":"001.002.003"},"reminders":{"type":"boolean","x-stream-index":"001.002.014"},"replies":{"type":"boolean","x-stream-index":"001.002.007"},"search":{"type":"boolean","x-stream-index":"001.002.005"},"shared_locations":{"type":"boolean","x-stream-index":"001.002.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.002.030"},"typing_events":{"type":"boolean","x-stream-index":"001.002.002"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"001.001.004"},"uploads":{"type":"boolean","x-stream-index":"001.002.010"},"url_enrichment":{"type":"boolean","x-stream-index":"001.002.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"001.002.017"}},"required":["created_at","updated_at","name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","commands"],"type":"object"},"ChannelCreatedEvent":{"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"channel.created","type":"string","x-stream-index":"001.001"}},"required":["type","created_at"],"title":"ChannelCreatedEvent","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"},"ChannelDeletedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003.004"},"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"003.005"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"002.002"},"team":{"type":"string","x-stream-index":"001.001"},"type":{"default":"channel.deleted","type":"string","x-stream-index":"002.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"ChannelDeletedEvent","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"},"ChannelFrozenEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"channel.frozen","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"ChannelFrozenEvent","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"},"ChannelGetOrCreateRequest":{"nullable":true,"properties":{"data":{"$ref":"#/components/schemas/ChannelInput","x-stream-index":"003"},"hide_for_creator":{"description":"Whether this channel will be hidden for the user who created the channel or not","title":"Hide for creator","type":"boolean","x-stream-index":"007"},"members":{"$ref":"#/components/schemas/PaginationParams","x-stream-index":"010"},"messages":{"$ref":"#/components/schemas/MessagePaginationParams","x-stream-index":"009"},"presence":{"description":"Fetch user presence info","title":"Presence","type":"boolean","x-stream-index":"006"},"state":{"description":"Refresh channel state","title":"State","type":"boolean","x-stream-index":"005"},"thread_unread_counts":{"type":"boolean","x-stream-index":"008"},"watch":{"description":"Start watching the channel","title":"Watch","type":"boolean","x-stream-index":"004"},"watchers":{"$ref":"#/components/schemas/PaginationParams","x-stream-index":"011"}},"type":"object"},"ChannelHiddenEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003.004"},"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"003.005"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"clear_history":{"type":"boolean","x-stream-index":"001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"004.002"},"type":{"default":"channel.hidden","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["clear_history","cid","channel_id","channel_type","channel_member_count","type","created_at"],"title":"ChannelHiddenEvent","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"},"ChannelInput":{"properties":{"auto_translation_enabled":{"description":"Enable or disable auto translation","title":"Auto translation","type":"boolean","x-stream-index":"005"},"auto_translation_language":{"description":"Switch auto translation language","title":"Auto translation language","type":"string","x-stream-index":"006"},"config_overrides":{"$ref":"#/components/schemas/ChannelConfig","x-stream-index":"024"},"created_by":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"009"},"created_by_id":{"type":"string","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"015"},"disabled":{"type":"boolean","x-stream-index":"014"},"frozen":{"description":"Freeze or unfreeze the channel","title":"Frozen","type":"boolean","x-stream-index":"013"},"invites":{"items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"type":"array","x-stream-index":"016"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"type":"array","x-stream-index":"018"},"team":{"description":"Team the channel belongs to (if multi-tenant mode is enabled)","title":"Team","type":"string","x-stream-index":"004"},"truncated_by_id":{"type":"string","x-stream-index":"010"}},"type":"object"},"ChannelKickedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002.004"},"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"002.005"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"channel.kicked","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"ChannelKickedEvent","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"},"ChannelMember":{"nullable":true,"properties":{"archived_at":{"format":"date-time","type":"string","x-stream-index":"015"},"ban_expires":{"description":"Expiration date of the ban","format":"date-time","title":"Ban expires","type":"string","x-stream-index":"013"},"banned":{"description":"Whether member is banned this channel or not","title":"Banned","type":"boolean","x-stream-index":"012"},"channel_role":{"description":"Role of the member in the channel","title":"Channel Role","type":"string","x-stream-index":"018"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"011"},"invite_accepted_at":{"description":"Date when invite was accepted","format":"date-time","title":"Invited accepted at","type":"string","x-stream-index":"006"},"invite_rejected_at":{"description":"Date when invite was rejected","format":"date-time","title":"Invited rejected at","type":"string","x-stream-index":"007"},"invited":{"description":"Whether member was invited or not","title":"Invited","type":"boolean","x-stream-index":"005"},"is_moderator":{"description":"Whether member is channel moderator or not","title":"Is moderator","type":"boolean","x-stream-index":"003"},"notifications_muted":{"type":"boolean","x-stream-index":"019"},"pinned_at":{"format":"date-time","type":"string","x-stream-index":"016"},"role":{"description":"Permission level of the member in the channel (DEPRECATED: use channel_role instead)","enum":["member","moderator","admin","owner"],"title":"Role","type":"string","x-stream-index":"017"},"shadow_banned":{"description":"Whether member is shadow banned in this channel or not","title":"Shadow banned","type":"boolean","x-stream-index":"014"},"status":{"type":"string","x-stream-index":"008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"},"user_id":{"title":"User ID","type":"string","x-stream-index":"001"}},"required":["custom","created_at","updated_at","banned","shadow_banned","channel_role","notifications_muted"],"title":"Channel member","type":"object"},"ChannelMemberResponse":{"nullable":true,"properties":{"archived_at":{"format":"date-time","type":"string","x-stream-index":"016"},"ban_expires":{"description":"Expiration date of the ban","format":"date-time","title":"Ban expires","type":"string","x-stream-index":"013"},"banned":{"description":"Whether member is banned this channel or not","title":"Banned","type":"boolean","x-stream-index":"012"},"channel_role":{"description":"Role of the member in the channel","title":"Channel Role","type":"string","x-stream-index":"018"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"011"},"invite_accepted_at":{"description":"Date when invite was accepted","format":"date-time","title":"Invited accepted at","type":"string","x-stream-index":"006"},"invite_rejected_at":{"description":"Date when invite was rejected","format":"date-time","title":"Invited rejected at","type":"string","x-stream-index":"007"},"invited":{"description":"Whether member was invited or not","title":"Invited","type":"boolean","x-stream-index":"005"},"is_moderator":{"description":"Whether member is channel moderator or not","title":"Is moderator","type":"boolean","x-stream-index":"003"},"notifications_muted":{"type":"boolean","x-stream-index":"019"},"pinned_at":{"format":"date-time","type":"string","x-stream-index":"015"},"role":{"description":"Permission level of the member in the channel (DEPRECATED: use channel_role instead)","enum":["member","moderator","admin","owner"],"title":"Role","type":"string","x-stream-index":"017"},"shadow_banned":{"description":"Whether member is shadow banned in this channel or not","title":"Shadow banned","type":"boolean","x-stream-index":"014"},"status":{"type":"string","x-stream-index":"008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"},"user_id":{"title":"User ID","type":"string","x-stream-index":"001"}},"required":["custom","created_at","updated_at","banned","shadow_banned","channel_role","notifications_muted"],"title":"Channel member","type":"object"},"ChannelMute":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel that is muted","title":"Channel","x-stream-index":"002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"004"},"expires":{"description":"Date/time of mute expiration","format":"date-time","title":"Expires","type":"string","x-stream-index":"003"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Owner of channel mute","title":"User","x-stream-index":"001"}},"required":["created_at","updated_at"],"type":"object"},"ChannelOwnCapability":{"description":"All possibility of string to use","enum":["ban-channel-members","cast-poll-vote","connect-events","create-attachment","delete-any-message","delete-channel","delete-own-message","flag-message","freeze-channel","join-channel","leave-channel","mute-channel","pin-message","query-poll-votes","quote-message","read-events","search-messages","send-custom-events","send-links","send-message","send-poll","send-reaction","send-reply","send-restricted-visibility-message","send-typing-events","set-channel-cooldown","share-location","skip-slow-mode","slow-mode","typing-events","update-any-message","update-channel","update-channel-members","update-own-message","update-thread","upload-file"],"title":"ChannelOwnCapability","type":"string"},"ChannelPushPreferences":{"properties":{"chat_level":{"type":"string","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"string","x-stream-index":"002"}},"type":"object"},"ChannelResponse":{"description":"Represents channel in chat","properties":{"auto_translation_enabled":{"description":"Whether auto translation is enabled or not","title":"Auto translation","type":"boolean","x-stream-index":"017"},"auto_translation_language":{"description":"Language to translate to when auto translation is active","title":"Auto translation language","type":"string","x-stream-index":"018"},"blocked":{"description":"Whether this channel is blocked by current user or not","title":"Blocked","type":"boolean","x-stream-index":"023"},"cid":{"description":"Channel CID (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/ChannelConfigWithInfo","description":"Channel configuration","title":"ChannelConfigWithInfo","x-stream-index":"013"},"cooldown":{"description":"Cooldown period after sending each message","format":"int32","title":"Cooldown","type":"integer","x-stream-index":"020"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"005"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"Creator of the channel","title":"UserResponse","x-stream-index":"008"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"026"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"string","x-stream-index":"007"},"disabled":{"type":"boolean","x-stream-index":"010"},"frozen":{"description":"Whether channel is frozen or not","title":"Frozen","type":"boolean","x-stream-index":"009"},"hidden":{"description":"Whether this channel is hidden by current user or not","title":"Hidden","type":"boolean","x-stream-index":"022"},"hide_messages_before":{"description":"Date since when the message history is accessible","format":"date-time","title":"Hide messages before","type":"string","x-stream-index":"019"},"id":{"description":"Channel unique ID","title":"ID","type":"string","x-stream-index":"001"},"last_message_at":{"description":"Date of the last message sent","format":"date-time","title":"Last message at","type":"string","x-stream-index":"004"},"member_count":{"description":"Number of members in the channel","format":"int32","title":"Member count","type":"integer","x-stream-index":"012"},"members":{"description":"List of channel members (max 100)","items":{"$ref":"#/components/schemas/ChannelMember"},"title":"ChannelMembers","type":"array","x-stream-index":"011"},"mute_expires_at":{"description":"Date of mute expiration","format":"date-time","title":"Mute expires at","type":"string","x-stream-index":"015"},"muted":{"description":"Whether this channel is muted or not","title":"Muted","type":"boolean","x-stream-index":"014"},"own_capabilities":{"description":"List of channel capabilities of authenticated user","items":{"$ref":"#/components/schemas/ChannelOwnCapability"},"title":"ChannelOwnCapability","type":"array","x-stream-index":"021"},"team":{"description":"Team the channel belongs to (multi-tenant only)","title":"Team","type":"string","x-stream-index":"016"},"truncated_at":{"description":"Date of the latest truncation of the channel","format":"date-time","title":"UserResponse","type":"string","x-stream-index":"024"},"truncated_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"025"},"type":{"description":"Type of the channel","title":"Type","type":"string","x-stream-docs-page-id":"channel_features","x-stream-index":"002"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"006"}},"required":["id","type","cid","created_at","updated_at","frozen","disabled","custom"],"title":"Channel","type":"object"},"ChannelStateResponse":{"nullable":true,"properties":{"active_live_locations":{"items":{"$ref":"#/components/schemas/SharedLocationResponseData"},"type":"array","x-stream-index":"001.015"},"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001.001"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001.014"},"duration":{"type":"string","x-stream-index":"002.001"},"hidden":{"type":"boolean","x-stream-index":"001.011"},"hide_messages_before":{"format":"date-time","type":"string","x-stream-index":"001.012"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"001.007"},"membership":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"001.008"},"messages":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","x-stream-index":"001.002"},"pending_messages":{"items":{"$ref":"#/components/schemas/PendingMessageResponse"},"type":"array","x-stream-index":"001.013"},"pinned_messages":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","x-stream-index":"001.003"},"push_preferences":{"$ref":"#/components/schemas/ChannelPushPreferences","x-stream-index":"001.009"},"read":{"items":{"$ref":"#/components/schemas/ReadStateResponse"},"type":"array","x-stream-index":"001.006"},"threads":{"items":{"$ref":"#/components/schemas/ThreadStateResponse"},"type":"array","x-stream-index":"001.010"},"watcher_count":{"format":"int32","type":"integer","x-stream-index":"001.004"},"watchers":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"001.005"}},"required":["messages","pinned_messages","members","threads","duration"],"type":"object"},"ChannelStateResponseFields":{"properties":{"active_live_locations":{"description":"Active live locations in the channel","items":{"$ref":"#/components/schemas/SharedLocationResponseData"},"title":"Active Live Locations","type":"array","x-stream-index":"015"},"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"014"},"hidden":{"description":"Whether this channel is hidden or not","title":"Hidden","type":"boolean","x-stream-index":"011"},"hide_messages_before":{"description":"Messages before this date are hidden from the user","format":"date-time","title":"Hide messages before","type":"string","x-stream-index":"012"},"members":{"description":"List of channel members","items":{"$ref":"#/components/schemas/ChannelMember"},"title":"Members","type":"array","x-stream-index":"007"},"membership":{"$ref":"#/components/schemas/ChannelMember","description":"Current user membership object","title":"Membership","x-stream-index":"008"},"messages":{"description":"List of channel messages","items":{"$ref":"#/components/schemas/MessageResponse"},"title":"Message","type":"array","x-stream-index":"002"},"pending_messages":{"description":"Pending messages that this user has sent","items":{"$ref":"#/components/schemas/PendingMessageResponse"},"title":"Pending messages","type":"array","x-stream-index":"013"},"pinned_messages":{"description":"List of pinned messages in the channel","items":{"$ref":"#/components/schemas/MessageResponse"},"title":"Pinned messages","type":"array","x-stream-docs-page-id":"pinned_messages","x-stream-index":"003"},"push_preferences":{"$ref":"#/components/schemas/ChannelPushPreferences","x-stream-index":"009"},"read":{"description":"List of read states","items":{"$ref":"#/components/schemas/ReadStateResponse"},"title":"Read","type":"array","x-stream-index":"006"},"threads":{"items":{"$ref":"#/components/schemas/ThreadStateResponse"},"type":"array","x-stream-index":"010"},"watcher_count":{"description":"Number of channel watchers","format":"int32","title":"Watcher count","type":"integer","x-stream-index":"004"},"watchers":{"description":"List of user who is watching the channel","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Watchers","type":"array","x-stream-index":"005"}},"required":["messages","pinned_messages","members","threads"],"type":"object"},"ChannelStopWatchingRequest":{"nullable":true,"type":"object"},"ChannelTruncatedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001.004"},"channel_id":{"type":"string","x-stream-index":"001.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"001.005"},"channel_type":{"type":"string","x-stream-index":"001.003"},"cid":{"type":"string","x-stream-index":"001.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"002.002"},"type":{"default":"channel.truncated","type":"string","x-stream-index":"002.001"}},"required":["cid","channel_id","channel_type","channel_member_count","type","created_at"],"title":"ChannelTruncatedEvent","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"},"ChannelUnFrozenEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"channel.unfrozen","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"ChannelUnFrozenEvent","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"},"ChannelUpdatedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"004.004"},"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"004.005"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"003.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"002.001"},"type":{"default":"channel.updated","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"ChannelUpdatedEvent","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"},"ChannelVisibleEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"001.002"},"channel_type":{"type":"string","x-stream-index":"001.003"},"cid":{"type":"string","x-stream-index":"001.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"003.002"},"type":{"default":"channel.visible","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"ChannelVisibleEvent","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"},"Command":{"description":"Represents custom chat command","nullable":true,"properties":{"args":{"description":"Arguments help text, shown in commands auto-completion","title":"Arguments","type":"string","x-stream-index":"006"},"created_at":{"description":"Date/time of creation","format":"date-time","readOnly":true,"title":"Created at","type":"string","x-stream-index":"001"},"description":{"description":"Description, shown in commands auto-completion","title":"Description","type":"string","x-stream-index":"005"},"name":{"description":"Unique command name","title":"Name","type":"string","x-stream-index":"004"},"set":{"description":"Set name used for grouping commands","title":"Set","type":"string","x-stream-index":"007"},"updated_at":{"description":"Date/time of the last update","format":"date-time","readOnly":true,"title":"Updated at","type":"string","x-stream-index":"002"}},"required":["name","description","args","set"],"title":"Command","type":"object"},"ConfigOverrides":{"properties":{"blocklist":{"type":"string","x-stream-index":"008"},"blocklist_behavior":{"enum":["flag","block"],"type":"string","x-stream-index":"009"},"commands":{"items":{"type":"string"},"type":"array","x-stream-index":"011"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"010"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"007"},"quotes":{"type":"boolean","x-stream-index":"004"},"reactions":{"type":"boolean","x-stream-index":"002"},"replies":{"type":"boolean","x-stream-index":"003"},"shared_locations":{"type":"boolean","x-stream-index":"013"},"typing_events":{"type":"boolean","x-stream-index":"001"},"uploads":{"type":"boolean","x-stream-index":"005"},"url_enrichment":{"type":"boolean","x-stream-index":"006"},"user_message_reminders":{"type":"boolean","x-stream-index":"012"}},"required":["grants","commands"],"type":"object"},"ConnectRequest":{"properties":{"device":{"$ref":"#/components/schemas/DeviceFields","x-stream-index":"001.002"},"user_details":{"$ref":"#/components/schemas/User","x-stream-index":"001.001"}},"required":["user_details"],"type":"object"},"CreateBlockListRequest":{"description":"Block list contains restricted words","nullable":true,"properties":{"name":{"description":"Block list name","maxLength":255,"title":"Name","type":"string","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"004"},"type":{"description":"Block list type.","enum":["regex","domain","domain_allowlist","email","word"],"title":"Type","type":"string","x-stream-index":"003"},"words":{"description":"List of words to block","items":{"type":"string"},"minimum":1,"title":"Words","type":"array","x-stream-index":"002"}},"required":["name","words"],"title":"Block list","type":"object","x-stream-docs-page-id":"block_lists"},"CreateBlockListResponse":{"description":"Basic response information","nullable":true,"properties":{"blocklist":{"$ref":"#/components/schemas/BlockListResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["duration"],"title":"Response","type":"object"},"CreateDeviceRequest":{"description":"Create device request","nullable":true,"properties":{"id":{"description":"Device ID","maxLength":255,"minLength":1,"title":"ID","type":"string","x-stream-index":"001"},"push_provider":{"description":"Push provider","enum":["firebase","apn","huawei","xiaomi"],"title":"PushProvider","type":"string","x-stream-index":"002"},"push_provider_name":{"description":"Push provider name","title":"PushProviderName","type":"string","x-stream-index":"003"},"voip_token":{"description":"When true the token is for Apple VoIP push notifications","title":"VoipToken","type":"boolean","x-stream-index":"004"}},"required":["id","push_provider"],"title":"CreateDeviceRequest","type":"object"},"CreateDraftRequest":{"nullable":true,"properties":{"message":{"$ref":"#/components/schemas/MessageRequest","x-stream-index":"001"}},"required":["message"],"type":"object"},"CreateDraftResponse":{"description":"Basic response information","nullable":true,"properties":{"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["draft","duration"],"title":"Response","type":"object"},"CreateGuestRequest":{"nullable":true,"properties":{"user":{"$ref":"#/components/schemas/UserRequest","description":"User object which server acts upon","title":"User","x-stream-index":"001"}},"required":["user"],"type":"object"},"CreateGuestResponse":{"nullable":true,"properties":{"access_token":{"description":"the access token to authenticate the user","title":"Access token","type":"string","x-stream-index":"002"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User object which server acts upon","title":"User","x-stream-index":"001"}},"required":["user","access_token","duration"],"type":"object"},"CreatePollOptionRequest":{"nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"003"},"text":{"description":"Option text","title":"string","type":"string","x-stream-index":"002"}},"required":["text"],"type":"object"},"CreatePollRequest":{"description":"Contains all information needed to create a new poll","nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"011"},"allow_answers":{"description":"Indicates whether users can suggest user defined answers","title":"Allow answers","type":"boolean","x-stream-index":"009"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"008"},"description":{"description":"A description of the poll","title":"Description","type":"string","x-stream-index":"003"},"enforce_unique_vote":{"description":"Indicates whether users can cast multiple votes","title":"Multiple choice","type":"boolean","x-stream-index":"006"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"is_closed":{"description":"Indicates whether the poll is open for voting","title":"Is closed","type":"boolean","x-stream-index":"010"},"max_votes_allowed":{"description":"Indicates the maximum amount of votes a user can cast","format":"int32","maximum":10,"title":"Maximum votes allowed","type":"integer","x-stream-index":"007"},"name":{"description":"The name of the poll","title":"Name","type":"string","x-stream-index":"002"},"options":{"items":{"$ref":"#/components/schemas/PollOptionInput"},"maximum":100,"type":"array","x-stream-index":"004"},"voting_visibility":{"enum":["anonymous","public"],"type":"string","x-stream-index":"005"}},"required":["name"],"title":"Create Poll Request","type":"object"},"CreateReminderRequest":{"nullable":true,"properties":{"remind_at":{"format":"date-time","type":"string","x-stream-index":"001"}},"type":"object"},"DeleteChannelResponse":{"description":"Basic response information","nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"Response","type":"object"},"DeleteChannelsRequest":{"nullable":true,"properties":{"cids":{"description":"All channels that should be deleted","items":{"type":"string"},"maximum":100,"minimum":1,"title":"Channels CID","type":"array","x-stream-index":"001"},"hard_delete":{"description":"Specify if channels and all ressources should be hard deleted","title":"Hard delete","type":"boolean","x-stream-index":"002"}},"required":["cids"],"type":"object"},"DeleteChannelsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"result":{"additionalProperties":{"$ref":"#/components/schemas/DeleteChannelsResultResponse"},"description":"Map of channel IDs and their deletion results","title":"Result","type":"object","x-stream-index":"001"},"task_id":{"type":"string","x-stream-index":"002"}},"required":["duration"],"type":"object"},"DeleteChannelsResultResponse":{"nullable":true,"properties":{"error":{"type":"string","x-stream-index":"002"},"status":{"type":"string","x-stream-index":"001"}},"required":["status"],"type":"object"},"DeleteMessageResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001"}},"required":["message","duration"],"title":"Response","type":"object"},"DeleteReactionResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001"},"reaction":{"$ref":"#/components/schemas/ReactionResponse","x-stream-index":"002"}},"required":["message","reaction","duration"],"title":"Response","type":"object"},"DeleteReminderResponse":{"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"},"Device":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"002.002"},"disabled":{"type":"boolean","x-stream-index":"002.003"},"disabled_reason":{"type":"string","x-stream-index":"002.004"},"id":{"type":"string","x-stream-index":"002.001.004"},"push_provider":{"enum":["firebase","apn","huawei","xiaomi"],"type":"string","x-stream-index":"002.001.001"},"push_provider_name":{"type":"string","x-stream-index":"002.001.003"},"user_id":{"type":"string","x-stream-index":"004"},"voip":{"type":"boolean","x-stream-index":"002.001.005"}},"required":["push_provider","id","created_at","user_id"],"type":"object"},"DeviceFields":{"properties":{"id":{"type":"string","x-stream-index":"004"},"push_provider":{"enum":["firebase","apn","huawei","xiaomi"],"type":"string","x-stream-index":"001"},"push_provider_name":{"type":"string","x-stream-index":"003"},"voip":{"type":"boolean","x-stream-index":"005"}},"required":["push_provider","id"],"type":"object"},"DeviceResponse":{"description":"Response for Device","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"004"},"disabled":{"description":"Whether device is disabled or not","title":"Disabled","type":"boolean","x-stream-index":"005"},"disabled_reason":{"description":"Reason explaining why device had been disabled","title":"Reason","type":"string","x-stream-index":"006"},"id":{"description":"Device ID","title":"ID","type":"string","x-stream-index":"003"},"push_provider":{"description":"Push provider","title":"PushProvider","type":"string","x-stream-index":"001"},"push_provider_name":{"description":"Push provider name","title":"PushProviderName","type":"string","x-stream-index":"002"},"user_id":{"description":"User ID","title":"UserID","type":"string","x-stream-index":"008"},"voip":{"description":"When true the token is for Apple VoIP push notifications","title":"Voip","type":"boolean","x-stream-index":"007"}},"required":["push_provider","id","created_at","user_id"],"title":"DeviceResponse","type":"object"},"DraftDeletedEvent":{"description":"Emitted when a Draft is deleted.","nullable":true,"properties":{"cid":{"description":"The CID of the channel where the draft was created","title":"Channel CID","type":"string","x-stream-index":"001.001.002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.001.007"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001.003"},"parent_id":{"description":"The ID of the parent message","title":"Message ID","type":"string","x-stream-index":"001.002"},"received_at":{"format":"date-time","type":"string","x-stream-index":"001.001.001.004"},"type":{"default":"draft.deleted","description":"The type of event: \"draft.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.001.002"}},"required":["type","created_at","custom"],"title":"DraftDeletedEvent","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"},"DraftPayloadResponse":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"html":{"type":"string","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"001"},"mentioned_users":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"008"},"mml":{"type":"string","x-stream-index":"003"},"parent_id":{"type":"string","x-stream-index":"005"},"poll_id":{"type":"string","x-stream-index":"013"},"quoted_message_id":{"type":"string","x-stream-index":"009"},"show_in_channel":{"type":"boolean","x-stream-index":"006"},"silent":{"type":"boolean","x-stream-index":"012"},"text":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"011"}},"required":["id","text","custom"],"type":"object"},"DraftResponse":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003"},"channel_cid":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"string","x-stream-index":"007"},"message":{"$ref":"#/components/schemas/DraftPayloadResponse","x-stream-index":"001"},"parent_id":{"type":"string","x-stream-index":"004"},"parent_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"005"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"006"}},"required":["message","channel_cid","created_at"],"type":"object"},"DraftUpdatedEvent":{"description":"Emitted when a Draft is created or updated.","nullable":true,"properties":{"cid":{"description":"The CID of the channel where the draft was created/updated","title":"Channel CID","type":"string","x-stream-index":"001.001.002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.001.007"},"draft":{"$ref":"#/components/schemas/DraftResponse","description":"The draft object which was created/updated","title":"Draft","x-stream-index":"001.003"},"parent_id":{"description":"The ID of the parent message","title":"Parent ID","type":"string","x-stream-index":"001.002"},"received_at":{"format":"date-time","type":"string","x-stream-index":"001.001.001.004"},"type":{"default":"draft.updated","description":"The type of event: \"draft.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.001.002"}},"required":["type","created_at","custom"],"title":"DraftUpdatedEvent","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"},"EventRequest":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"parent_id":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"001"}},"required":["type"],"type":"object"},"EventResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"event":{"$ref":"#/components/schemas/WSEvent","x-stream-index":"001"}},"required":["event","duration"],"title":"Response","type":"object"},"Field":{"nullable":true,"properties":{"short":{"type":"boolean","x-stream-index":"003"},"title":{"type":"string","x-stream-index":"001"},"value":{"type":"string","x-stream-index":"002"}},"required":["title","value","short"],"type":"object"},"FileUploadConfig":{"properties":{"allowed_file_extensions":{"items":{"type":"string"},"type":"array","x-stream-index":"001"},"allowed_mime_types":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"blocked_file_extensions":{"items":{"type":"string"},"type":"array","x-stream-index":"002"},"blocked_mime_types":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"size_limit":{"format":"int32","maximum":104857600,"minimum":0,"type":"integer","x-stream-index":"005"}},"required":["allowed_file_extensions","blocked_file_extensions","allowed_mime_types","blocked_mime_types","size_limit"],"type":"object"},"FileUploadRequest":{"nullable":true,"properties":{"file":{"description":"file field","title":"File","type":"string","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/OnlyUserID","description":"user for the request **server side only**","title":"User","x-stream-index":"003"}},"type":"object"},"FileUploadResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"file":{"description":"URL to the uploaded asset. Should be used to put to `asset_url` attachment field","title":"File","type":"string","x-stream-index":"001"},"thumb_url":{"description":"URL of the file thumbnail for supported file formats. Should be put to `thumb_url` attachment field","title":"Thumbnail URL","type":"string","x-stream-index":"002"}},"required":["duration"],"type":"object"},"Flag":{"description":"Contains information about flagged user or message","properties":{"approved_at":{"description":"Date of the approval","format":"date-time","title":"Approved at","type":"string","x-stream-index":"015"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"011"},"created_by_automod":{"type":"boolean","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"022"},"details":{"$ref":"#/components/schemas/FlagDetails","x-stream-index":"021"},"reason":{"type":"string","x-stream-index":"020"},"rejected_at":{"description":"Date of the rejection","format":"date-time","title":"Rejected at","type":"string","x-stream-index":"016"},"reviewed_at":{"description":"Date of the review","format":"date-time","title":"Reviewed at","type":"string","x-stream-index":"013"},"reviewed_by":{"type":"string","x-stream-index":"014"},"target_message":{"$ref":"#/components/schemas/Message","x-stream-index":"008"},"target_message_id":{"description":"ID of flagged message","title":"Target Message ID","type":"string","x-stream-index":"007"},"target_user":{"$ref":"#/components/schemas/User","description":"Flagged user","title":"User","x-stream-index":"010"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"012"},"user":{"$ref":"#/components/schemas/User","description":"User who flagged a message or a user","title":"User","x-stream-index":"006"}},"required":["created_by_automod","created_at","updated_at"],"title":"Flag","type":"object"},"FlagDetails":{"properties":{"Extra":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"002"},"automod":{"$ref":"#/components/schemas/AutomodDetails","x-stream-index":"001"},"original_text":{"type":"string","x-stream-index":"003"}},"required":["Extra","original_text"],"type":"object"},"FlagFeedback":{"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"005"},"labels":{"items":{"$ref":"#/components/schemas/Label"},"type":"array","x-stream-index":"006"},"message_id":{"type":"string","x-stream-index":"004"}},"required":["message_id","created_at","labels"],"type":"object"},"FlagMessageDetails":{"properties":{"pin_changed":{"type":"boolean","x-stream-index":"002"},"should_enrich":{"type":"boolean","x-stream-index":"003"},"skip_push":{"type":"boolean","x-stream-index":"004"},"updated_by_id":{"type":"string","x-stream-index":"001"}},"type":"object"},"FlagRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"reason":{"maxLength":255,"type":"string","x-stream-index":"003"},"target_message_id":{"description":"ID of the message when reporting a message","title":"Target Message ID","type":"string","x-stream-index":"001"},"target_user_id":{"description":"ID of the user when reporting a user","title":"Target User ID","type":"string","x-stream-index":"002"}},"type":"object"},"FlagResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"flag":{"$ref":"#/components/schemas/Flag","x-stream-index":"001"},"review_queue_item_id":{"type":"string","x-stream-index":"002"}},"required":["review_queue_item_id","duration"],"title":"Response","type":"object"},"FullUserResponse":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"ban_expires":{"format":"date-time","type":"string","x-stream-index":"015"},"banned":{"type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"014"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"007"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"string","x-stream-index":"001.016"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"001.011"},"devices":{"items":{"$ref":"#/components/schemas/DeviceResponse"},"type":"array","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001.001"},"image":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"005"},"language":{"type":"string","x-stream-index":"001.005"},"last_active":{"format":"date-time","type":"string","x-stream-index":"001.014"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"012"},"mutes":{"items":{"$ref":"#/components/schemas/UserMuteResponse"},"type":"array","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"001.002"},"online":{"type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"003"},"revoke_tokens_issued_before":{"format":"date-time","type":"string","x-stream-index":"001.015"},"role":{"type":"string","x-stream-index":"001.006"},"shadow_banned":{"type":"boolean","x-stream-index":"013"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"009"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"010"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"008"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"011"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","devices","invisible","mutes","channel_mutes","unread_count","total_unread_count","unread_channels","unread_threads","shadow_banned","blocked_user_ids"],"type":"object"},"GetApplicationResponse":{"description":"Basic response information","nullable":true,"properties":{"app":{"$ref":"#/components/schemas/AppResponseFields","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["app","duration"],"title":"Response","type":"object"},"GetBlockedUsersResponse":{"nullable":true,"properties":{"blocks":{"description":"Array of blocked user object","items":{"$ref":"#/components/schemas/BlockedUserResponse"},"title":"Blocks","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["blocks","duration"],"type":"object"},"GetDraftResponse":{"description":"Basic response information","nullable":true,"properties":{"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["draft","duration"],"title":"Response","type":"object"},"GetManyMessagesResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.002.001"},"messages":{"description":"List of messages","items":{"$ref":"#/components/schemas/MessageResponse"},"title":"Messages","type":"array","x-stream-index":"001.001"}},"required":["messages","duration"],"type":"object"},"GetMessageResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageWithChannelResponse","x-stream-index":"001"},"pending_message_metadata":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"002"}},"required":["message","duration"],"title":"Response","type":"object"},"GetOGResponse":{"nullable":true,"properties":{"actions":{"items":{"$ref":"#/components/schemas/Action"},"type":"array","x-stream-index":"001.015"},"asset_url":{"description":"URL of detected video or audio","title":"Image URL","type":"string","x-stream-index":"001.017"},"author_icon":{"type":"string","x-stream-index":"001.007"},"author_link":{"description":"og:site","title":"Author Link","type":"string","x-stream-index":"001.006"},"author_name":{"description":"og:site_name","title":"Author Name","type":"string","x-stream-index":"001.005"},"color":{"type":"string","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.018"},"duration":{"type":"string","x-stream-index":"002.001"},"fallback":{"type":"string","x-stream-index":"001.002"},"fields":{"items":{"$ref":"#/components/schemas/Field"},"type":"array","x-stream-index":"001.016"},"footer":{"type":"string","x-stream-index":"001.013"},"footer_icon":{"type":"string","x-stream-index":"001.014"},"giphy":{"$ref":"#/components/schemas/Images","x-stream-index":"001.019"},"image_url":{"description":"URL of detected image","title":"Image URL","type":"string","x-stream-index":"001.011"},"og_scrape_url":{"description":"extracted url from the text","title":"OG Scrape URL","type":"string","x-stream-index":"001.020"},"original_height":{"format":"int32","type":"integer","x-stream-index":"001.022"},"original_width":{"format":"int32","type":"integer","x-stream-index":"001.021"},"pretext":{"type":"string","x-stream-index":"001.004"},"text":{"description":"og:description","title":"Text","type":"string","x-stream-index":"001.010"},"thumb_url":{"description":"URL of detected thumb image","title":"Image URL","type":"string","x-stream-index":"001.012"},"title":{"description":"og:title","title":"Title","type":"string","x-stream-index":"001.008"},"title_link":{"description":"og:url","title":"Title Link","type":"string","x-stream-index":"001.009"},"type":{"description":"Attachment type, could be empty, image, audio or video","title":"Type","type":"string","x-stream-index":"001.001"}},"required":["custom","duration"],"title":"Get OG Attachment","type":"object","x-stream-docs-page-id":"og"},"GetReactionsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"reactions":{"description":"List of reactions","items":{"$ref":"#/components/schemas/Reaction"},"title":"Reactions","type":"array","x-stream-index":"001"}},"required":["reactions","duration"],"type":"object"},"GetRepliesResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"messages":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","x-stream-index":"001"}},"required":["messages","duration"],"title":"Response","type":"object"},"GetThreadResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"thread":{"$ref":"#/components/schemas/ThreadStateResponse","description":"Enriched thread state","title":"Thread","x-stream-index":"001"}},"required":["thread","duration"],"type":"object"},"HealthCheckEvent":{"nullable":true,"properties":{"cid":{"type":"string","x-stream-index":"003"},"connection_id":{"type":"string","x-stream-index":"001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"004.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004.007"},"me":{"$ref":"#/components/schemas/OwnUserResponse","x-stream-index":"002"},"received_at":{"format":"date-time","type":"string","x-stream-index":"004.004"},"type":{"default":"health.check","type":"string","x-stream-index":"004.002"}},"required":["connection_id","type","created_at","custom"],"title":"HealthCheckEvent","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"},"HideChannelRequest":{"nullable":true,"properties":{"clear_history":{"description":"Whether to clear message history of the channel or not","title":"Clear history","type":"boolean","x-stream-index":"001"}},"type":"object"},"HideChannelResponse":{"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"},"ImageData":{"properties":{"frames":{"type":"string","x-stream-index":"005"},"height":{"type":"string","x-stream-index":"003"},"size":{"type":"string","x-stream-index":"004"},"url":{"type":"string","x-stream-index":"001"},"width":{"type":"string","x-stream-index":"002"}},"required":["url","width","height","size","frames"],"type":"object"},"ImageSize":{"properties":{"crop":{"description":"Crop mode","enum":["top","bottom","left","right","center"],"title":"Crop","type":"string","x-stream-index":"001"},"height":{"description":"Target image height","format":"int32","title":"Height","type":"integer","x-stream-index":"003"},"resize":{"description":"Resize method","enum":["clip","crop","scale","fill"],"title":"Resize","type":"string","x-stream-index":"002"},"width":{"description":"Target image width","format":"int32","title":"Width","type":"integer","x-stream-index":"004"}},"title":"Image size configuration","type":"object"},"ImageUploadRequest":{"nullable":true,"properties":{"file":{"type":"string","x-stream-index":"001.002"},"upload_sizes":{"description":"field with JSON-encoded array of image size configurations","items":{"$ref":"#/components/schemas/ImageSize"},"title":"Upload sizes","type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/OnlyUserID","x-stream-index":"001.003"}},"type":"object"},"ImageUploadResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.003.001"},"file":{"type":"string","x-stream-index":"001.001"},"thumb_url":{"type":"string","x-stream-index":"001.002"},"upload_sizes":{"description":"Array of image size configurations","items":{"$ref":"#/components/schemas/ImageSize"},"title":"Upload sizes","type":"array","x-stream-index":"002"}},"required":["duration"],"type":"object"},"Images":{"properties":{"fixed_height":{"$ref":"#/components/schemas/ImageData","x-stream-index":"002"},"fixed_height_downsampled":{"$ref":"#/components/schemas/ImageData","x-stream-index":"004"},"fixed_height_still":{"$ref":"#/components/schemas/ImageData","x-stream-index":"003"},"fixed_width":{"$ref":"#/components/schemas/ImageData","x-stream-index":"005"},"fixed_width_downsampled":{"$ref":"#/components/schemas/ImageData","x-stream-index":"007"},"fixed_width_still":{"$ref":"#/components/schemas/ImageData","x-stream-index":"006"},"original":{"$ref":"#/components/schemas/ImageData","x-stream-index":"001"}},"required":["original","fixed_height","fixed_height_still","fixed_height_downsampled","fixed_width","fixed_width_still","fixed_width_downsampled"],"type":"object"},"Label":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"phrase_list_ids":{"items":{"format":"int32","type":"integer"},"type":"array","x-stream-index":"002"}},"required":["name"],"type":"object"},"LabelThresholds":{"properties":{"block":{"description":"Threshold for automatic message block","format":"float","maximum":1,"minimum":0,"title":"Block","type":"number","x-stream-index":"002"},"flag":{"description":"Threshold for automatic message flag","format":"float","maximum":1,"minimum":0,"title":"Flag","type":"number","x-stream-index":"001"}},"type":"object"},"ListBlockListResponse":{"description":"Basic response information","nullable":true,"properties":{"blocklists":{"items":{"$ref":"#/components/schemas/BlockListResponse"},"type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["blocklists","duration"],"title":"Response","type":"object"},"ListDevicesResponse":{"description":"List devices response","nullable":true,"properties":{"devices":{"description":"List of devices","items":{"$ref":"#/components/schemas/DeviceResponse"},"title":"Devices","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["devices","duration"],"title":"ListDevicesResponse","type":"object"},"MarkChannelsReadRequest":{"nullable":true,"properties":{"read_by_channel":{"additionalProperties":{"type":"string"},"description":"Map of channel ID to last read message ID","maximum":30,"title":"Read by channel","type":"object","x-stream-index":"001"}},"type":"object"},"MarkReadRequest":{"nullable":true,"properties":{"message_id":{"description":"ID of the message that is considered last read by client","title":"Message ID","type":"string","x-stream-index":"001"},"thread_id":{"description":"Optional Thread ID to specifically mark a given thread as read","title":"Thread ID","type":"string","x-stream-index":"002"}},"type":"object"},"MarkReadResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"event":{"$ref":"#/components/schemas/MessageReadEvent","description":"Mark read event","title":"Event","x-stream-index":"001"}},"required":["duration"],"type":"object"},"MarkUnreadRequest":{"nullable":true,"properties":{"message_id":{"description":"ID of the message from where the channel is marked unread","title":"Message ID","type":"string","x-stream-index":"001"},"thread_id":{"description":"Mark a thread unread, specify both the thread and message id","title":"Thread ID","type":"string","x-stream-index":"003"}},"type":"object"},"MemberAddedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"003.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"002.001"},"type":{"default":"member.added","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MemberAddedEvent","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"},"MemberRemovedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"002.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"001.001"},"type":{"default":"member.removed","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MemberRemovedEvent","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"},"MemberUpdatedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"005.002"},"channel_type":{"type":"string","x-stream-index":"005.003"},"cid":{"type":"string","x-stream-index":"005.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"003.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"002.001"},"type":{"default":"member.updated","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MemberUpdatedEvent","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"},"MembersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"members":{"description":"List of found members","items":{"$ref":"#/components/schemas/ChannelMember"},"title":"Members","type":"array","x-stream-index":"001"}},"required":["members","duration"],"type":"object"},"Message":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"012"},"before_message_send_failed":{"type":"boolean","x-stream-index":"046"},"cid":{"type":"string","x-stream-index":"028"},"command":{"type":"string","x-stream-index":"006"},"created_at":{"format":"date-time","type":"string","x-stream-index":"030"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"034"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"033"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"023"},"html":{"type":"string","x-stream-index":"007"},"i18n":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"044"},"id":{"type":"string","x-stream-index":"002"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"040"},"latest_reactions":{"items":{"$ref":"#/components/schemas/Reaction"},"type":"array","x-stream-index":"013"},"mentioned_users":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"043"},"message_text_updated_at":{"format":"date-time","type":"string","x-stream-index":"052"},"mml":{"type":"string","x-stream-index":"005"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"056"},"own_reactions":{"items":{"$ref":"#/components/schemas/Reaction"},"type":"array","x-stream-index":"014"},"parent_id":{"type":"string","x-stream-index":"019"},"pin_expires":{"format":"date-time","type":"string","x-stream-index":"051"},"pinned":{"type":"boolean","x-stream-index":"047"},"pinned_at":{"format":"date-time","type":"string","x-stream-index":"048"},"pinned_by":{"$ref":"#/components/schemas/User","x-stream-index":"050"},"poll":{"$ref":"#/components/schemas/Poll","x-stream-index":"054"},"poll_id":{"type":"string","x-stream-index":"053"},"quoted_message":{"$ref":"#/components/schemas/Message","x-stream-index":"025"},"quoted_message_id":{"type":"string","x-stream-index":"024"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"015"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"017"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"016"},"reminder":{"$ref":"#/components/schemas/MessageReminder","x-stream-index":"058"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"022"},"restricted_visibility":{"items":{"type":"string"},"type":"array","x-stream-index":"011"},"shadowed":{"type":"boolean","x-stream-index":"036"},"shared_location":{"$ref":"#/components/schemas/SharedLocation","x-stream-index":"055"},"show_in_channel":{"type":"boolean","x-stream-index":"021"},"silent":{"type":"boolean","x-stream-index":"045"},"text":{"type":"string","x-stream-index":"004"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"027"},"type":{"type":"string","x-stream-index":"008"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"031"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"010"}},"required":["id","text","html","type","restricted_visibility","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reaction_groups","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned"],"type":"object"},"MessageActionRequest":{"nullable":true,"properties":{"form_data":{"additionalProperties":{"type":"string"},"description":"ReadOnlyData to execute command with","title":"Form data","type":"object","x-stream-index":"002"}},"required":["form_data"],"type":"object"},"MessageChangeSet":{"properties":{"attachments":{"type":"boolean","x-stream-index":"005"},"custom":{"type":"boolean","x-stream-index":"001"},"html":{"type":"boolean","x-stream-index":"004"},"mentioned_user_ids":{"type":"boolean","x-stream-index":"006"},"mml":{"type":"boolean","x-stream-index":"003"},"pin":{"type":"boolean","x-stream-index":"009"},"quoted_message_id":{"type":"boolean","x-stream-index":"007"},"silent":{"type":"boolean","x-stream-index":"008"},"text":{"type":"boolean","x-stream-index":"002"}},"required":["custom","text","mml","html","attachments","mentioned_user_ids","quoted_message_id","silent","pin"],"type":"object"},"MessageDeletedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"006.002"},"hard_delete":{"type":"boolean","x-stream-index":"002.001"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"005.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"message.deleted","type":"string","x-stream-index":"006.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["hard_delete","cid","channel_id","channel_type","type","created_at"],"title":"MessageDeletedEvent","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":{"approved_at":{"format":"date-time","type":"string","x-stream-index":"013"},"created_at":{"format":"date-time","type":"string","x-stream-index":"009"},"created_by_automod":{"type":"boolean","x-stream-index":"001"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"008"},"details":{"$ref":"#/components/schemas/FlagDetails","x-stream-index":"006"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"005"},"moderation_feedback":{"$ref":"#/components/schemas/FlagFeedback","x-stream-index":"003"},"moderation_result":{"$ref":"#/components/schemas/MessageModerationResult","x-stream-index":"002"},"reason":{"type":"string","x-stream-index":"007"},"rejected_at":{"format":"date-time","type":"string","x-stream-index":"014"},"reviewed_at":{"format":"date-time","type":"string","x-stream-index":"011"},"reviewed_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"012"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"004"}},"required":["created_by_automod","created_at","updated_at"],"type":"object"},"MessageModerationResult":{"description":"Result of the message moderation","properties":{"action":{"description":"Action taken by automod","title":"Action","type":"string","x-stream-index":"002"},"ai_moderation_response":{"$ref":"#/components/schemas/ModerationResponse","description":"Response from AI moderation","title":"ModerationResponse","x-stream-index":"007"},"blocked_word":{"description":"Word that was blocked","title":"Blocked word","type":"string","x-stream-index":"004"},"blocklist_name":{"description":"Name of the blocklist","title":"Blocklist name","type":"string","x-stream-index":"005"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"010"},"message_id":{"description":"ID of the message","title":"Message ID","type":"string","x-stream-index":"001"},"moderated_by":{"description":"User who moderated the message","title":"Moderated by","type":"string","x-stream-index":"003"},"moderation_thresholds":{"$ref":"#/components/schemas/Thresholds","description":"Thresholds for AI moderation","title":"Thresholds","x-stream-index":"006"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"011"},"user_bad_karma":{"description":"Whether user has bad karma","title":"User bad karma","type":"boolean","x-stream-index":"009"},"user_karma":{"description":"Karma of the user","format":"float","title":"User karma","type":"number","x-stream-index":"008"}},"required":["message_id","action","user_karma","user_bad_karma","created_at","updated_at"],"title":"Message moderation result","type":"object"},"MessageNewEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"005.002"},"channel_type":{"type":"string","x-stream-index":"005.003"},"cid":{"type":"string","x-stream-index":"005.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"004.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"006.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"notification.thread_message_new","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"},"watcher_count":{"format":"int32","type":"integer","x-stream-index":"002.001"}},"required":["watcher_count","type","created_at","cid","channel_id","channel_type"],"title":"MessageNewEvent","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"},"MessageOptions":{"properties":{"include_thread_participants":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"MessagePaginationParams":{"type":"object"},"MessageReadEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"003"},"channel_last_message_at":{"format":"date-time","type":"string","x-stream-index":"005"},"channel_type":{"type":"string","x-stream-index":"004"},"cid":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"string","x-stream-index":"009"},"last_read_message_id":{"type":"string","x-stream-index":"010"},"team":{"type":"string","x-stream-index":"006"},"thread":{"$ref":"#/components/schemas/ThreadResponse","x-stream-index":"008"},"type":{"default":"message.read","type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","x-stream-index":"007"}},"required":["type","cid","channel_id","channel_type","created_at"],"type":"object"},"MessageReminder":{"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"004"},"channel_cid":{"type":"string","x-stream-index":"003"},"created_at":{"format":"date-time","type":"string","x-stream-index":"011"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"006"},"message_id":{"type":"string","x-stream-index":"005"},"remind_at":{"format":"date-time","type":"string","x-stream-index":"009"},"task_id":{"type":"string","x-stream-index":"010"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"012"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"user_id":{"type":"string","x-stream-index":"007"}},"required":["channel_cid","message_id","user_id","task_id","created_at","updated_at"],"type":"object"},"MessageRequest":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"maximum":30,"type":"array","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"mentioned_users":{"items":{"type":"string"},"maximum":100,"type":"array","x-stream-index":"008"},"mml":{"type":"string","x-stream-index":"003"},"parent_id":{"type":"string","x-stream-index":"005"},"pin_expires":{"format":"date-time","type":"string","x-stream-index":"015"},"pinned":{"type":"boolean","x-stream-index":"013"},"pinned_at":{"format":"date-time","nullable":true,"type":"string","x-stream-index":"014"},"poll_id":{"type":"string","x-stream-index":"039"},"quoted_message_id":{"type":"string","x-stream-index":"009"},"restricted_visibility":{"items":{"type":"string"},"maximum":10,"type":"array","x-stream-index":"016"},"shared_location":{"$ref":"#/components/schemas/SharedLocation","x-stream-index":"040"},"show_in_channel":{"type":"boolean","x-stream-index":"006"},"silent":{"type":"boolean","x-stream-index":"012"},"text":{"type":"string","x-stream-index":"002"},"type":{"enum":["''","regular","system"],"type":"string","x-stream-index":"011"}},"type":"object"},"MessageResponse":{"description":"Represents any chat message","properties":{"attachments":{"description":"Array of message attachments","items":{"$ref":"#/components/schemas/Attachment"},"title":"Message attachments","type":"array","x-stream-docs-page-id":"message_format#attachment-format","x-stream-index":"008"},"cid":{"description":"Channel unique identifier in \u003ctype\u003e:\u003cid\u003e format","title":"Channel CID","type":"string","x-stream-index":"022"},"command":{"description":"Contains provided slash command","title":"Command","type":"string","x-stream-docs-page-id":"custom_commands_webhook","x-stream-index":"004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"023"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"026"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"string","x-stream-index":"025"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"018"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"041"},"html":{"description":"Contains HTML markup of the message. Can only be set when using server-side API","title":"HTML content","type":"string","x-stream-index":"005"},"i18n":{"additionalProperties":{"type":"string"},"description":"Object with translations. Key `language` contains the original language key. Other keys contain translations","title":"Internationalization info","type":"object","x-stream-docs-page-id":"translation","x-stream-index":"030"},"id":{"description":"Message ID is unique string identifier of the message","title":"ID","type":"string","x-stream-index":"001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"Contains image moderation information","title":"Image moderation labels","type":"object","x-stream-index":"028"},"latest_reactions":{"description":"List of 10 latest reactions to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Latest reactions","type":"array","x-stream-index":"009"},"mentioned_users":{"description":"List of mentioned users","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Mentioned Users","type":"array","x-stream-index":"029"},"message_text_updated_at":{"format":"date-time","type":"string","x-stream-index":"036"},"mml":{"description":"Should be empty if `text` is provided. Can only be set when using server-side API","title":"Messaging Markup Language","type":"string","x-stream-docs-page-id":"mml_overview","x-stream-index":"003"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"039"},"own_reactions":{"description":"List of 10 latest reactions of authenticated user to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Own reactions","type":"array","x-stream-index":"010"},"parent_id":{"description":"ID of parent message (thread)","title":"Parent message ID","type":"string","x-stream-docs-page-id":"threads","x-stream-index":"015"},"pin_expires":{"description":"Date when pinned message expires","format":"date-time","title":"Pin expiration date","type":"string","x-stream-docs-page-id":"pinned_messages","x-stream-index":"035"},"pinned":{"description":"Whether message is pinned or not","title":"Pinned","type":"boolean","x-stream-docs-page-id":"pinned_messages","x-stream-index":"032"},"pinned_at":{"description":"Date when message got pinned","format":"date-time","title":"Pinned at","type":"string","x-stream-docs-page-id":"pinned_messages","x-stream-index":"033"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","description":"Contains user who pinned the message","title":"Pinned by","x-stream-docs-page-id":"pinned_messages","x-stream-index":"034"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"038"},"poll_id":{"description":"Identifier of the poll to include in the message","title":"Poll ID","type":"string","x-stream-index":"037"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","description":"Contains quoted message","title":"Quoted message","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"020"},"quoted_message_id":{"title":"ID of quoted message","type":"string","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"019"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing number of reactions of each type. Key: reaction type (string), value: number of reactions (int)","title":"Reaction counts","type":"object","x-stream-index":"011"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"014"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing scores of reactions of each type. Key: reaction type (string), value: total score of reactions (int)","title":"Reaction scores","type":"object","x-stream-index":"012"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"042"},"reply_count":{"description":"Number of replies to this message","format":"int32","title":"Reply count","type":"integer","x-stream-index":"017"},"restricted_visibility":{"description":"A list of user ids that have restricted visibility to the message, if the list is not empty, the message is only visible to the users in the list","items":{"type":"string"},"title":"Restricted visibility","type":"array","x-stream-index":"040"},"shadowed":{"description":"Whether the message was shadowed or not","title":"Shadowed","type":"boolean","x-stream-docs-page-id":"moderation#shadow-ban","x-stream-index":"027"},"shared_location":{"$ref":"#/components/schemas/SharedLocationResponseData","description":"Contains shared location data","title":"Shared Location","x-stream-index":"043"},"show_in_channel":{"description":"Whether thread reply should be shown in the channel as well","title":"Show in channel","type":"boolean","x-stream-docs-page-id":"threads","x-stream-index":"016"},"silent":{"description":"Whether message is silent or not","title":"Silent","type":"boolean","x-stream-index":"031"},"text":{"description":"Text of the message. Should be empty if `mml` is provided","title":"Text","type":"string","x-stream-index":"002"},"thread_participants":{"description":"List of users who participate in thread","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Thread participants","type":"array","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"021"},"type":{"description":"Contains type of the message","enum":["regular","ephemeral","error","reply","system","deleted"],"title":"Message Type","type":"string","x-stream-docs-page-id":"message_format#message-types","x-stream-index":"006"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"024"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Sender of the message. Required when using server-side API","title":"User object","x-stream-index":"007"}},"required":["id","text","html","type","user","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned","restricted_visibility"],"title":"Message","type":"object","x-stream-docs-page-id":"send_message"},"MessageUndeletedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"005.002"},"channel_type":{"type":"string","x-stream-index":"005.003"},"cid":{"type":"string","x-stream-index":"005.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"004.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"002.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"message.undeleted","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MessageUndeletedEvent","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"},"MessageUpdate":{"properties":{"change_set":{"$ref":"#/components/schemas/MessageChangeSet","x-stream-index":"002"},"old_text":{"type":"string","x-stream-index":"001"}},"type":"object"},"MessageUpdatedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"005.002"},"channel_type":{"type":"string","x-stream-index":"005.003"},"cid":{"type":"string","x-stream-index":"005.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"004.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"002.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"message.updated","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MessageUpdatedEvent","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"},"MessageWithChannelResponse":{"description":"Represents any chat message","properties":{"attachments":{"description":"Array of message attachments","items":{"$ref":"#/components/schemas/Attachment"},"title":"Message attachments","type":"array","x-stream-docs-page-id":"message_format#attachment-format","x-stream-index":"001.008"},"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel object","title":"Channel","x-stream-index":"002"},"cid":{"description":"Channel unique identifier in \u003ctype\u003e:\u003cid\u003e format","title":"Channel CID","type":"string","x-stream-index":"001.022"},"command":{"description":"Contains provided slash command","title":"Command","type":"string","x-stream-docs-page-id":"custom_commands_webhook","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.023"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.026"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"string","x-stream-index":"001.025"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"001.018"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001.041"},"html":{"description":"Contains HTML markup of the message. Can only be set when using server-side API","title":"HTML content","type":"string","x-stream-index":"001.005"},"i18n":{"additionalProperties":{"type":"string"},"description":"Object with translations. Key `language` contains the original language key. Other keys contain translations","title":"Internationalization info","type":"object","x-stream-docs-page-id":"translation","x-stream-index":"001.030"},"id":{"description":"Message ID is unique string identifier of the message","title":"ID","type":"string","x-stream-index":"001.001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"Contains image moderation information","title":"Image moderation labels","type":"object","x-stream-index":"001.028"},"latest_reactions":{"description":"List of 10 latest reactions to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Latest reactions","type":"array","x-stream-index":"001.009"},"mentioned_users":{"description":"List of mentioned users","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Mentioned Users","type":"array","x-stream-index":"001.029"},"message_text_updated_at":{"format":"date-time","type":"string","x-stream-index":"001.036"},"mml":{"description":"Should be empty if `text` is provided. Can only be set when using server-side API","title":"Messaging Markup Language","type":"string","x-stream-docs-page-id":"mml_overview","x-stream-index":"001.003"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"001.039"},"own_reactions":{"description":"List of 10 latest reactions of authenticated user to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Own reactions","type":"array","x-stream-index":"001.010"},"parent_id":{"description":"ID of parent message (thread)","title":"Parent message ID","type":"string","x-stream-docs-page-id":"threads","x-stream-index":"001.015"},"pin_expires":{"description":"Date when pinned message expires","format":"date-time","title":"Pin expiration date","type":"string","x-stream-docs-page-id":"pinned_messages","x-stream-index":"001.035"},"pinned":{"description":"Whether message is pinned or not","title":"Pinned","type":"boolean","x-stream-docs-page-id":"pinned_messages","x-stream-index":"001.032"},"pinned_at":{"description":"Date when message got pinned","format":"date-time","title":"Pinned at","type":"string","x-stream-docs-page-id":"pinned_messages","x-stream-index":"001.033"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","description":"Contains user who pinned the message","title":"Pinned by","x-stream-docs-page-id":"pinned_messages","x-stream-index":"001.034"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001.038"},"poll_id":{"description":"Identifier of the poll to include in the message","title":"Poll ID","type":"string","x-stream-index":"001.037"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","description":"Contains quoted message","title":"Quoted message","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"001.020"},"quoted_message_id":{"title":"ID of quoted message","type":"string","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"001.019"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing number of reactions of each type. Key: reaction type (string), value: number of reactions (int)","title":"Reaction counts","type":"object","x-stream-index":"001.011"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"001.014"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing scores of reactions of each type. Key: reaction type (string), value: total score of reactions (int)","title":"Reaction scores","type":"object","x-stream-index":"001.012"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"001.042"},"reply_count":{"description":"Number of replies to this message","format":"int32","title":"Reply count","type":"integer","x-stream-index":"001.017"},"restricted_visibility":{"description":"A list of user ids that have restricted visibility to the message, if the list is not empty, the message is only visible to the users in the list","items":{"type":"string"},"title":"Restricted visibility","type":"array","x-stream-index":"001.040"},"shadowed":{"description":"Whether the message was shadowed or not","title":"Shadowed","type":"boolean","x-stream-docs-page-id":"moderation#shadow-ban","x-stream-index":"001.027"},"shared_location":{"$ref":"#/components/schemas/SharedLocationResponseData","description":"Contains shared location data","title":"Shared Location","x-stream-index":"001.043"},"show_in_channel":{"description":"Whether thread reply should be shown in the channel as well","title":"Show in channel","type":"boolean","x-stream-docs-page-id":"threads","x-stream-index":"001.016"},"silent":{"description":"Whether message is silent or not","title":"Silent","type":"boolean","x-stream-index":"001.031"},"text":{"description":"Text of the message. Should be empty if `mml` is provided","title":"Text","type":"string","x-stream-index":"001.002"},"thread_participants":{"description":"List of users who participate in thread","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Thread participants","type":"array","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"001.021"},"type":{"description":"Contains type of the message","enum":["regular","ephemeral","error","reply","system","deleted"],"title":"Message Type","type":"string","x-stream-docs-page-id":"message_format#message-types","x-stream-index":"001.006"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"001.024"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Sender of the message. Required when using server-side API","title":"User object","x-stream-index":"001.007"}},"required":["id","text","html","type","user","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned","restricted_visibility","channel"],"title":"Message","type":"object","x-stream-docs-page-id":"send_message"},"ModerationResponse":{"properties":{"action":{"type":"string","x-stream-index":"004"},"explicit":{"format":"float","type":"number","x-stream-index":"002"},"spam":{"format":"float","type":"number","x-stream-index":"003"},"toxic":{"format":"float","type":"number","x-stream-index":"001"}},"required":["toxic","explicit","spam","action","automod_response"],"type":"object"},"ModerationV2Response":{"properties":{"action":{"type":"string","x-stream-index":"001"},"blocklist_matched":{"type":"string","x-stream-index":"005"},"image_harms":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"original_text":{"type":"string","x-stream-index":"002"},"platform_circumvented":{"type":"boolean","x-stream-index":"007"},"semantic_filter_matched":{"type":"string","x-stream-index":"006"},"text_harms":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"required":["action","original_text"],"type":"object"},"MuteChannelRequest":{"nullable":true,"properties":{"channel_cids":{"description":"Channel CIDs to mute (if multiple channels)","items":{"type":"string"},"maximum":25,"title":"Channel CIDs","type":"array","x-stream-index":"002"},"expiration":{"description":"Duration of mute in milliseconds","title":"Expiration","type":"integer","x-stream-index":"003"}},"type":"object"},"MuteChannelResponse":{"nullable":true,"properties":{"channel_mute":{"$ref":"#/components/schemas/ChannelMute","description":"Object with channel mute (if one channel was muted)","title":"Channel mute","x-stream-index":"001"},"channel_mutes":{"description":"Object with mutes (if multiple channels were muted)","items":{"$ref":"#/components/schemas/ChannelMute"},"title":"Channel mutes","type":"array","x-stream-index":"002"},"duration":{"type":"string","x-stream-index":"004.001"},"own_user":{"$ref":"#/components/schemas/OwnUser","description":"Authorized user object with fresh mutes information","title":"Own user","x-stream-index":"003"}},"required":["duration"],"type":"object"},"MuteUserRequest":{"nullable":true,"properties":{"target_ids":{"description":"User IDs to mute (if multiple users)","items":{"type":"string"},"maximum":1000,"title":"Target IDs","type":"array","x-stream-index":"002"},"timeout":{"description":"Duration of mute in minutes","minimum":0,"title":"Timeout","type":"integer","x-stream-index":"003"}},"required":["timeout"],"type":"object"},"MuteUserResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"005.001"},"mute":{"$ref":"#/components/schemas/UserMute","description":"Object with user mute (if one user was muted)","title":"Mute","x-stream-index":"001"},"mutes":{"description":"Object with mutes (if multiple users were muted)","items":{"$ref":"#/components/schemas/UserMute"},"title":"Mutes","type":"array","x-stream-index":"002"},"non_existing_users":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"own_user":{"$ref":"#/components/schemas/OwnUser","description":"Authorized user object with fresh mutes information","title":"Own user","x-stream-index":"003"}},"required":["duration"],"type":"object"},"NotificationAddedToChannelEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003.004"},"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"003.005"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"002.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"001.001"},"type":{"default":"notification.added_to_channel","type":"string","x-stream-index":"002.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"NotificationAddedToChannelEvent","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"},"NotificationChannelDeletedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003.004"},"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"003.005"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"002.002"},"team":{"type":"string","x-stream-index":"001.001"},"type":{"default":"notification.channel_deleted","type":"string","x-stream-index":"002.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"NotificationChannelDeletedEvent","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"},"NotificationChannelMutesUpdatedEvent":{"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"002.002"},"me":{"$ref":"#/components/schemas/OwnUser","x-stream-index":"001"},"type":{"default":"notification.channel_mutes_updated","type":"string","x-stream-index":"002.001"}},"required":["me","type","created_at"],"title":"NotificationChannelMutesUpdatedEvent","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"},"NotificationChannelTruncatedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002.004"},"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"002.005"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"notification.channel_truncated","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"NotificationChannelTruncatedEvent","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"},"NotificationInviteAcceptedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002.004"},"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"002.005"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"004.001"},"type":{"default":"notification.invite_accepted","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"NotificationInviteAcceptedEvent","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"},"NotificationInviteRejectedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002.004"},"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"002.005"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"004.001"},"type":{"default":"notification.invite_rejected","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"NotificationInviteRejectedEvent","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"},"NotificationInvitedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002.004"},"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"002.005"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"004.001"},"type":{"default":"notification.invited","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"NotificationInvitedEvent","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"},"NotificationMarkReadEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003.004"},"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"003.005"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"team":{"type":"string","x-stream-index":"002.001"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"006"},"type":{"default":"notification.mark_read","type":"string","x-stream-index":"001.001"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"007"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"005"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"008"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count","unread_count","total_unread_count","unread_channels","unread_threads"],"title":"NotificationMarkReadEvent","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"},"NotificationMarkUnreadEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003.004"},"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"003.005"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"first_unread_message_id":{"type":"string","x-stream-index":"005"},"last_read_at":{"format":"date-time","type":"string","x-stream-index":"006"},"last_read_message_id":{"type":"string","x-stream-index":"012"},"team":{"type":"string","x-stream-index":"002.001"},"thread_id":{"type":"string","x-stream-index":"013"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"009"},"type":{"default":"notification.mark_unread","type":"string","x-stream-index":"001.001"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"010"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"008"},"unread_messages":{"format":"int32","type":"integer","x-stream-index":"007"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"011"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count","first_unread_message_id","last_read_at","unread_messages","unread_count","total_unread_count","unread_channels","unread_threads"],"title":"NotificationMarkUnreadEvent","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"},"NotificationMutesUpdatedEvent":{"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"002.002"},"me":{"$ref":"#/components/schemas/OwnUser","x-stream-index":"001"},"type":{"default":"notification.mutes_updated","type":"string","x-stream-index":"002.001"}},"required":["me","type","created_at"],"title":"NotificationMutesUpdatedEvent","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"},"NotificationNewMessageEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"004.004"},"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"004.005"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"003.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"002.001"},"type":{"default":"notification.message_new","type":"string","x-stream-index":"003.001"}},"required":["message","type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"NotificationNewMessageEvent","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"},"NotificationRemovedFromChannelEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002.004"},"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"002.005"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"004.001"},"type":{"default":"notification.removed_from_channel","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"NotificationRemovedFromChannelEvent","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"},"OnlyUserID":{"properties":{"id":{"type":"string","x-stream-index":"001"}},"required":["id"],"type":"object"},"OwnUser":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"046"},"banned":{"type":"boolean","x-stream-index":"016"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"045"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"029"},"created_at":{"format":"date-time","type":"string","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"deactivated_at":{"format":"date-time","type":"string","x-stream-index":"014"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"013"},"devices":{"items":{"$ref":"#/components/schemas/Device"},"type":"array","x-stream-index":"027"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"023"},"language":{"type":"string","x-stream-index":"035"},"last_active":{"format":"date-time","type":"string","x-stream-index":"011"},"last_engaged_at":{"format":"date-time","type":"string","x-stream-index":"012"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"037"},"mutes":{"items":{"$ref":"#/components/schemas/UserMute"},"type":"array","x-stream-index":"028"},"online":{"type":"boolean","x-stream-index":"022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"026"},"push_preferences":{"$ref":"#/components/schemas/PushPreferences","x-stream-index":"025"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"005"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"031"},"total_unread_count_by_team":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"032"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"033"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"030"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"034"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"009"}},"required":["id","role","custom","created_at","updated_at","banned","online","devices","mutes","channel_mutes","unread_count","total_unread_count","total_unread_count_by_team","unread_channels","unread_threads","language"],"type":"object"},"OwnUserResponse":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"banned":{"type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"015"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"007"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"string","x-stream-index":"001.016"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"001.011"},"devices":{"items":{"$ref":"#/components/schemas/DeviceResponse"},"title":"Devices","type":"array","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001.001"},"image":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"005"},"language":{"type":"string","x-stream-index":"001.005"},"last_active":{"format":"date-time","type":"string","x-stream-index":"001.014"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"013"},"mutes":{"items":{"$ref":"#/components/schemas/UserMuteResponse"},"type":"array","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"001.002"},"online":{"type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"003"},"push_preferences":{"$ref":"#/components/schemas/PushPreferences","x-stream-index":"002"},"revoke_tokens_issued_before":{"format":"date-time","type":"string","x-stream-index":"001.015"},"role":{"type":"string","x-stream-index":"001.006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"009"},"total_unread_count_by_team":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"010"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"011"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"008"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"012"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","devices","invisible","mutes","channel_mutes","unread_count","total_unread_count","unread_channels","unread_threads"],"type":"object"},"PaginationParams":{"properties":{"limit":{"format":"int32","minimum":0,"type":"integer","x-stream-index":"001"},"offset":{"format":"int32","type":"integer","x-stream-index":"002"}},"type":"object"},"PendingMessageEvent":{"description":"Pending message event for async moderation","nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"002.007"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"message":{"$ref":"#/components/schemas/Message","description":"The pending message","title":"Message","x-stream-index":"002.009"},"metadata":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"002.010"},"method":{"description":"The method used for the pending message","title":"Method","type":"string","x-stream-index":"003"},"received_at":{"format":"date-time","type":"string","x-stream-index":"001.004"},"type":{"default":"message.pending","description":"The type of event: \"message.pending\" in this case","title":"Event Type","type":"string","x-stream-index":"001.002"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.002"}},"required":["type","custom","method","created_at"],"title":"PendingMessageEvent","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"},"PendingMessageResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"003"},"metadata":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"}},"type":"object"},"Poll":{"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"023"},"allow_answers":{"type":"boolean","x-stream-index":"010"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"009"},"answers_count":{"format":"int32","type":"integer","x-stream-index":"015"},"created_at":{"format":"date-time","type":"string","x-stream-index":"021"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"020"},"created_by_id":{"type":"string","x-stream-index":"019"},"description":{"type":"string","x-stream-index":"005"},"enforce_unique_vote":{"type":"boolean","x-stream-index":"007"},"id":{"type":"string","x-stream-index":"003"},"is_closed":{"type":"boolean","x-stream-index":"011"},"latest_answers":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array","x-stream-index":"017"},"latest_votes_by_option":{"additionalProperties":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array"},"type":"object","x-stream-index":"016"},"max_votes_allowed":{"format":"int32","type":"integer","x-stream-index":"008"},"name":{"type":"string","x-stream-index":"004"},"options":{"items":{"$ref":"#/components/schemas/PollOption"},"type":"array","x-stream-index":"013"},"own_votes":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array","x-stream-index":"018"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"022"},"vote_count":{"format":"int32","type":"integer","x-stream-index":"012"},"vote_counts_by_option":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"014"},"voting_visibility":{"type":"string","x-stream-index":"006"}},"required":["id","name","description","enforce_unique_vote","allow_user_suggested_options","allow_answers","vote_count","options","vote_counts_by_option","answers_count","latest_votes_by_option","latest_answers","own_votes","created_by_id","created_at","updated_at","Custom"],"type":"object"},"PollClosedEvent":{"description":"Emitted when a poll is closed.","nullable":true,"properties":{"activity_id":{"type":"string","x-stream-index":"001.003"},"cid":{"description":"The CID of the channel containing the poll","title":"Channel CID","type":"string","x-stream-index":"001.001.002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.001.007"},"message_id":{"description":"The ID of the message containing the poll","title":"Message ID","type":"string","x-stream-index":"001.002"},"poll":{"$ref":"#/components/schemas/PollResponseData","description":"The poll object which was closed","title":"Poll","x-stream-index":"001.004"},"received_at":{"format":"date-time","type":"string","x-stream-index":"001.001.001.004"},"type":{"default":"poll.closed","description":"The type of event: \"poll.closed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.001.002"}},"required":["type","created_at","custom","poll"],"title":"PollClosedEvent","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"},"PollDeletedEvent":{"description":"Emitted when a poll is deleted.","nullable":true,"properties":{"activity_id":{"type":"string","x-stream-index":"001.003"},"cid":{"description":"The CID of the channel containing the poll","title":"Channel CID","type":"string","x-stream-index":"001.001.002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.001.007"},"message_id":{"description":"The ID of the message containing the poll","title":"Message ID","type":"string","x-stream-index":"001.002"},"poll":{"$ref":"#/components/schemas/PollResponseData","description":"The poll object which was deleted","title":"Poll","x-stream-index":"001.004"},"received_at":{"format":"date-time","type":"string","x-stream-index":"001.001.001.004"},"type":{"default":"poll.deleted","description":"The type of event: \"poll.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.001.002"}},"required":["type","created_at","custom","poll"],"title":"PollDeletedEvent","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"},"PollOption":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id","text","custom"],"type":"object"},"PollOptionInput":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"text":{"type":"string","x-stream-index":"002"}},"type":"object"},"PollOptionRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id"],"type":"object"},"PollOptionResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"poll_option":{"$ref":"#/components/schemas/PollOptionResponseData","description":"Poll option","title":"PollOptionResponseData","x-stream-index":"001"}},"required":["poll_option","duration"],"type":"object"},"PollOptionResponseData":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id","text","custom"],"type":"object"},"PollResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"poll":{"$ref":"#/components/schemas/PollResponseData","description":"Poll","title":"PollResponseData","x-stream-index":"001"}},"required":["poll","duration"],"type":"object"},"PollResponseData":{"properties":{"allow_answers":{"type":"boolean","x-stream-index":"008"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"007"},"answers_count":{"format":"int32","type":"integer","x-stream-index":"012"},"created_at":{"format":"date-time","type":"string","x-stream-index":"019"},"created_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"018"},"created_by_id":{"type":"string","x-stream-index":"017"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"021"},"description":{"type":"string","x-stream-index":"003"},"enforce_unique_vote":{"type":"boolean","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"is_closed":{"type":"boolean","x-stream-index":"009"},"latest_answers":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array","x-stream-index":"015"},"latest_votes_by_option":{"additionalProperties":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array"},"type":"object","x-stream-index":"014"},"max_votes_allowed":{"format":"int32","type":"integer","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"002"},"options":{"items":{"$ref":"#/components/schemas/PollOptionResponseData"},"type":"array","x-stream-index":"011"},"own_votes":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array","x-stream-index":"016"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"020"},"vote_count":{"format":"int32","type":"integer","x-stream-index":"010"},"vote_counts_by_option":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"013"},"voting_visibility":{"type":"string","x-stream-index":"004"}},"required":["id","name","description","voting_visibility","enforce_unique_vote","allow_user_suggested_options","allow_answers","vote_count","options","answers_count","vote_counts_by_option","latest_votes_by_option","latest_answers","own_votes","created_by_id","created_at","updated_at","custom"],"type":"object"},"PollUpdatedEvent":{"description":"Emitted when a poll is updated.","nullable":true,"properties":{"activity_id":{"type":"string","x-stream-index":"001.003"},"cid":{"description":"The CID of the channel containing the poll","title":"Channel CID","type":"string","x-stream-index":"001.001.002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.001.007"},"message_id":{"description":"The ID of the message containing the poll","title":"Message ID","type":"string","x-stream-index":"001.002"},"poll":{"$ref":"#/components/schemas/PollResponseData","description":"The poll object which was updated","title":"Poll","x-stream-index":"001.004"},"received_at":{"format":"date-time","type":"string","x-stream-index":"001.001.001.004"},"type":{"default":"poll.updated","description":"The type of event: \"poll.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.001.002"}},"required":["type","created_at","custom","poll"],"title":"PollUpdatedEvent","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"},"PollVote":{"nullable":true,"properties":{"answer_text":{"type":"string","x-stream-index":"007"},"created_at":{"format":"date-time","type":"string","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"004"},"is_answer":{"type":"boolean","x-stream-index":"006"},"option_id":{"type":"string","x-stream-index":"005"},"poll_id":{"type":"string","x-stream-index":"003"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"011"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"009"},"user_id":{"type":"string","x-stream-index":"008"}},"required":["poll_id","id","option_id","created_at","updated_at"],"type":"object"},"PollVoteCastedEvent":{"description":"Emitted when a vote is cast on a poll.","nullable":true,"properties":{"activity_id":{"type":"string","x-stream-index":"001.001.003"},"cid":{"description":"The CID of the channel containing the poll","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"},"message_id":{"description":"The ID of the message containing the poll","title":"Message ID","type":"string","x-stream-index":"001.001.002"},"poll":{"$ref":"#/components/schemas/PollResponseData","description":"The poll object","title":"Poll","x-stream-index":"001.001.004"},"poll_vote":{"$ref":"#/components/schemas/PollVoteResponseData","description":"The vote that was cast","title":"Poll Vote","x-stream-index":"001.002"},"received_at":{"format":"date-time","type":"string","x-stream-index":"001.001.001.001.004"},"type":{"default":"poll.vote_casted","description":"The type of event: \"poll.vote_casted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.001.001.002"}},"required":["type","created_at","custom","poll","poll_vote"],"title":"PollVoteCastedEvent","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"},"PollVoteChangedEvent":{"description":"Emitted when a vote on a poll is changed.","nullable":true,"properties":{"activity_id":{"type":"string","x-stream-index":"001.001.003"},"cid":{"description":"The CID of the channel containing the poll","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"},"message_id":{"description":"The ID of the message containing the poll","title":"Message ID","type":"string","x-stream-index":"001.001.002"},"poll":{"$ref":"#/components/schemas/PollResponseData","description":"The poll object","title":"Poll","x-stream-index":"001.001.004"},"poll_vote":{"$ref":"#/components/schemas/PollVoteResponseData","description":"The updated vote","title":"Poll Vote","x-stream-index":"001.002"},"received_at":{"format":"date-time","type":"string","x-stream-index":"001.001.001.001.004"},"type":{"default":"poll.vote_changed","description":"The type of event: \"poll.vote_changed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.001.001.002"}},"required":["type","created_at","custom","poll","poll_vote"],"title":"PollVoteChangedEvent","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"},"PollVoteRemovedEvent":{"description":"Emitted when a vote is removed from a poll.","nullable":true,"properties":{"activity_id":{"type":"string","x-stream-index":"001.001.003"},"cid":{"description":"The CID of the channel containing the poll","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"},"message_id":{"description":"The ID of the message containing the poll","title":"Message ID","type":"string","x-stream-index":"001.001.002"},"poll":{"$ref":"#/components/schemas/PollResponseData","description":"The poll object","title":"Poll","x-stream-index":"001.001.004"},"poll_vote":{"$ref":"#/components/schemas/PollVoteResponseData","description":"The vote that was removed","title":"Poll Vote","x-stream-index":"001.002"},"received_at":{"format":"date-time","type":"string","x-stream-index":"001.001.001.001.004"},"type":{"default":"poll.vote_removed","description":"The type of event: \"poll.vote_removed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.001.001.002"}},"required":["type","created_at","custom","poll","poll_vote"],"title":"PollVoteRemovedEvent","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"},"PollVoteResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"vote":{"$ref":"#/components/schemas/PollVoteResponseData","description":"Poll vote","title":"PollVoteResponseData","x-stream-index":"001"}},"required":["duration"],"type":"object"},"PollVoteResponseData":{"nullable":true,"properties":{"answer_text":{"type":"string","x-stream-index":"005"},"created_at":{"format":"date-time","type":"string","x-stream-index":"008"},"id":{"type":"string","x-stream-index":"002"},"is_answer":{"type":"boolean","x-stream-index":"004"},"option_id":{"type":"string","x-stream-index":"003"},"poll_id":{"type":"string","x-stream-index":"001"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"007"},"user_id":{"type":"string","x-stream-index":"006"}},"required":["poll_id","id","option_id","created_at","updated_at"],"type":"object"},"PollVotesResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"votes":{"description":"Poll votes","items":{"$ref":"#/components/schemas/PollVoteResponseData"},"title":"PollVoteResponseList","type":"array","x-stream-index":"001"}},"required":["votes","duration"],"type":"object"},"PrivacySettings":{"properties":{"read_receipts":{"$ref":"#/components/schemas/ReadReceipts","x-stream-index":"002"},"typing_indicators":{"$ref":"#/components/schemas/TypingIndicators","x-stream-index":"001"}},"type":"object"},"PrivacySettingsResponse":{"properties":{"read_receipts":{"$ref":"#/components/schemas/ReadReceiptsResponse","x-stream-index":"002"},"typing_indicators":{"$ref":"#/components/schemas/TypingIndicatorsResponse","x-stream-index":"001"}},"type":"object"},"PushPreferenceInput":{"nullable":true,"properties":{"call_level":{"description":"Set the level of call push notifications for the user. One of all, none, default","enum":["all","none","default"],"type":"string","x-stream-index":"004"},"channel_cid":{"description":"Set the push preferences for a specific channel. If empty it sets the default for the user","type":"string","x-stream-index":"002"},"chat_level":{"description":"Set the level of chat push notifications for the user. One of all, mentions, none, default","enum":["all","mentions","none","default"],"type":"string","x-stream-index":"003"},"disabled_until":{"description":"Disable push notifications till a certain time","format":"date-time","type":"string","x-stream-index":"005"},"remove_disable":{"description":"Remove the disabled until time. (IE stop snoozing notifications)","type":"boolean","x-stream-index":"006"},"user_id":{"description":"The user id for which to set the push preferences. Required when using server side auths, defaults to current user with client side auth.","type":"string","x-stream-index":"001"}},"type":"object"},"PushPreferences":{"properties":{"call_level":{"type":"string","x-stream-index":"002"},"chat_level":{"type":"string","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"string","x-stream-index":"003"}},"type":"object"},"QueryBannedUsersPayload":{"properties":{"exclude_expired_bans":{"description":"Whether to exclude expired bans or not","title":"Exclude expired bans","type":"boolean","x-stream-index":"004"},"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"description":"Number of records to return","format":"int32","maximum":300,"minimum":0,"title":"Limit","type":"integer","x-stream-index":"003.003"},"offset":{"description":"Number of records to offset","format":"int32","maximum":10000,"title":"Offset","type":"integer","x-stream-index":"003.004"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":1,"title":"Sort","type":"array","x-stream-index":"002"}},"required":["filter_conditions"],"type":"object"},"QueryBannedUsersResponse":{"nullable":true,"properties":{"bans":{"description":"List of found bans","items":{"$ref":"#/components/schemas/BanResponse"},"title":"BanResponse","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["bans","duration"],"type":"object"},"QueryChannelsRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"description":"Number of channels to limit","format":"int32","title":"Limit","type":"integer","x-stream-index":"008"},"member_limit":{"description":"Number of members to limit","format":"int32","maximum":100,"minimum":0,"title":"Member limit","type":"integer","x-stream-index":"007"},"message_limit":{"description":"Number of messages to limit","format":"int32","minimum":0,"title":"Message limit","type":"integer","x-stream-index":"006"},"offset":{"description":"Channel pagination offset","format":"int32","title":"Offset","type":"integer","x-stream-index":"009"},"presence":{"title":"Presence","type":"boolean","x-stream-index":"005"},"sort":{"description":"List of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"002"},"state":{"description":"Whether to update channel state or not","title":"State","type":"boolean","x-stream-index":"004"},"watch":{"description":"Whether to start watching found channels or not","title":"Watch","type":"boolean","x-stream-index":"003"}},"title":"Query Channels Request","type":"object","x-stream-docs-page-id":"query_channels"},"QueryChannelsResponse":{"nullable":true,"properties":{"channels":{"description":"List of channels","items":{"$ref":"#/components/schemas/ChannelStateResponseFields"},"title":"Channels","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["channels","duration"],"title":"Channels list","type":"object"},"QueryDraftsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","maximum":3,"title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"002"}},"type":"object"},"QueryDraftsResponse":{"nullable":true,"properties":{"drafts":{"description":"Drafts","items":{"$ref":"#/components/schemas/DraftResponse"},"title":"DraftsResponseList","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["drafts","duration"],"type":"object"},"QueryMembersPayload":{"description":"Client request","properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"002"},"limit":{"format":"int32","maximum":300,"minimum":0,"type":"integer","x-stream-index":"006.003"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"type":"array","x-stream-index":"003"},"offset":{"format":"int32","maximum":10000,"type":"integer","x-stream-index":"006.004"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":1,"type":"array","x-stream-index":"005"},"type":{"maxLength":64,"type":"string","x-stream-index":"001"}},"required":["type","filter_conditions"],"title":"ClientRequest","type":"object"},"QueryMessageFlagsPayload":{"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":300,"minimum":0,"type":"integer","x-stream-index":"003.003"},"offset":{"format":"int32","maximum":10000,"type":"integer","x-stream-index":"003.004"},"show_deleted_messages":{"description":"Whether to include deleted messages in the results","title":"ShowDeletedMessages","type":"boolean","x-stream-index":"002"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"type":"array","x-stream-index":"003.005"}},"type":"object"},"QueryMessageFlagsResponse":{"description":"Query message flags response","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"flags":{"description":"The flags that match the query","items":{"$ref":"#/components/schemas/MessageFlagResponse"},"title":"MessageFlagResponseList","type":"array","x-stream-index":"001"}},"required":["flags","duration"],"title":"QueryMessageFlagsResponse","type":"object"},"QueryPollVotesRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","title":"Filter","type":"object","x-stream-index":"003"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"004"}},"type":"object"},"QueryPollsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","title":"Filter","type":"object","x-stream-index":"002"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"003"}},"type":"object"},"QueryPollsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"polls":{"description":"Polls data returned by the query","items":{"$ref":"#/components/schemas/PollResponseData"},"title":"PollsResponseData","type":"array","x-stream-index":"001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["polls","duration"],"type":"object"},"QueryReactionsRequest":{"properties":{"filter":{"additionalProperties":{},"type":"object","x-stream-index":"002"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"006.001"},"next":{"type":"string","x-stream-index":"006.002"},"prev":{"type":"string","x-stream-index":"006.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":2,"type":"array","x-stream-index":"003"}},"type":"object"},"QueryReactionsResponse":{"description":"Basic response information","properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"next":{"type":"string","x-stream-index":"003.001"},"prev":{"type":"string","x-stream-index":"003.002"},"reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"001"}},"required":["reactions","duration"],"title":"Response","type":"object"},"QueryRemindersRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"002"}},"type":"object"},"QueryRemindersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"reminders":{"description":"MessageReminders data returned by the query","items":{"$ref":"#/components/schemas/ReminderResponseData"},"title":"RemindersResponseData","type":"array","x-stream-index":"001"}},"required":["reminders","duration"],"type":"object"},"QueryThreadsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter conditions to apply to threads","title":"Filter","type":"object","x-stream-index":"006"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"008.001"},"member_limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005"},"next":{"type":"string","x-stream-index":"008.002"},"participant_limit":{"description":"Limit the number of participants returned per each thread","format":"int32","maximum":100,"minimum":0,"title":"Participant limit","type":"integer","x-stream-index":"004"},"prev":{"type":"string","x-stream-index":"008.003"},"reply_limit":{"description":"Limit the number of replies returned per each thread","format":"int32","maximum":10,"minimum":0,"title":"Reply limit","type":"integer","x-stream-index":"003"},"sort":{"description":"Sort conditions to apply to threads","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"007"},"watch":{"description":"Start watching the channel this thread belongs to","title":"Watch","type":"boolean","x-stream-index":"001"}},"type":"object"},"QueryThreadsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"threads":{"description":"List of enriched thread states","items":{"$ref":"#/components/schemas/ThreadStateResponse"},"title":"Threads","type":"array","x-stream-index":"001"}},"required":["threads","duration"],"type":"object"},"QueryUsersPayload":{"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"include_deactivated_users":{"type":"boolean","x-stream-index":"004"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.003"},"offset":{"format":"int32","maximum":1000,"type":"integer","x-stream-index":"005.004"},"presence":{"type":"boolean","x-stream-index":"003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"type":"array","x-stream-index":"002"}},"required":["filter_conditions"],"type":"object"},"QueryUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"users":{"description":"Array of users as result of filters applied.","items":{"$ref":"#/components/schemas/FullUserResponse"},"title":"Users","type":"array","x-stream-index":"001"}},"required":["users","duration"],"type":"object"},"Reaction":{"nullable":true,"properties":{"created_at":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"message_id":{"type":"string","x-stream-index":"003"},"score":{"format":"int32","type":"integer","x-stream-index":"007"},"type":{"maxLength":30,"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["message_id","type","score","created_at","updated_at","custom"],"type":"object"},"ReactionDeletedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"006.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"002"},"team":{"type":"string","x-stream-index":"005.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"reaction.deleted","type":"string","x-stream-index":"006.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"ReactionDeletedEvent","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"},"ReactionGroupResponse":{"description":"ReactionGroupResponse contains all information about a reaction of the same type.","nullable":true,"properties":{"count":{"description":"Count is the number of reactions of this type.","format":"int32","title":"Count","type":"integer","x-stream-index":"001"},"first_reaction_at":{"description":"FirstReactionAt is the time of the first reaction of this type. This is the same also if all reaction of this type are deleted, because if someone will react again with the same type, will be preserved the sorting.","format":"date-time","title":"FirstReactionAt","type":"string","x-stream-index":"003"},"last_reaction_at":{"description":"LastReactionAt is the time of the last reaction of this type.","format":"date-time","title":"LastReactionAt","type":"string","x-stream-index":"004"},"sum_scores":{"description":"SumScores is the sum of all scores of reactions of this type. Medium allows you to clap articles more than once and shows the sum of all claps from all users. For example, you can send `clap` x5 using `score: 5`.","format":"int32","title":"SumScores","type":"integer","x-stream-index":"002"}},"required":["count","sum_scores","first_reaction_at","last_reaction_at"],"title":"ReactionGroupResponse","type":"object"},"ReactionNewEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"006.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"002"},"team":{"type":"string","x-stream-index":"005.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"reaction.new","type":"string","x-stream-index":"006.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"ReactionNewEvent","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"},"ReactionRequest":{"description":"Represents user reaction to a message","properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"score":{"description":"Reaction score. If not specified reaction has score of 1","format":"int32","title":"Score","type":"integer","x-stream-index":"002"},"type":{"description":"The type of reaction (e.g. 'like', 'laugh', 'wow')","maxLength":30,"title":"Type","type":"string","x-stream-index":"001"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"004"}},"required":["type"],"title":"Reaction","type":"object","x-stream-docs-page-id":"send_reaction"},"ReactionResponse":{"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"006"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"008"},"message_id":{"description":"Message ID","title":"Message ID","type":"string","x-stream-index":"001"},"score":{"description":"Score of the reaction","format":"int32","title":"Score","type":"integer","x-stream-index":"005"},"type":{"description":"Type of reaction","title":"Type","type":"string","x-stream-index":"004"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"007"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User","title":"UserResponse","x-stream-index":"003"},"user_id":{"description":"User ID","title":"User ID","type":"string","x-stream-index":"002"}},"required":["message_id","user_id","user","type","score","created_at","updated_at","custom"],"type":"object"},"ReactionUpdatedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"006.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"002"},"team":{"type":"string","x-stream-index":"005.001"},"type":{"default":"reaction.updated","type":"string","x-stream-index":"006.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["message","reaction","cid","channel_id","channel_type","type","created_at"],"title":"ReactionUpdatedEvent","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"},"ReadReceipts":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"ReadReceiptsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"ReadStateResponse":{"properties":{"last_read":{"format":"date-time","type":"string","x-stream-index":"002"},"last_read_message_id":{"type":"string","x-stream-index":"004"},"unread_messages":{"format":"int32","type":"integer","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"}},"required":["user","last_read","unread_messages"],"type":"object"},"ReminderCreatedEvent":{"description":"Emitted when a reminder is created.","nullable":true,"properties":{"cid":{"description":"The CID of the Channel for which the reminder was created","title":"Channel CID","type":"string","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.007"},"message_id":{"description":"The ID of the message for which the reminder was created","title":"Message ID","type":"string","x-stream-index":"001.002"},"parent_id":{"description":"The ID of the parent message, if the reminder is for a thread message","title":"Parent ID","type":"string","x-stream-index":"001.005"},"received_at":{"format":"date-time","type":"string","x-stream-index":"001.001.004"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","description":"The reminder object which was created","title":"MessageReminder","x-stream-index":"001.006"},"type":{"default":"reminder.created","description":"The type of event: \"reminder.created\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.002"},"user_id":{"description":"The ID of the user for whom the reminder was created","title":"User ID","type":"string","x-stream-index":"001.003"}},"required":["type","created_at","custom","message_id","user_id","cid"],"title":"ReminderCreatedEvent","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"},"ReminderDeletedEvent":{"description":"Emitted when a reminder is deleted.","nullable":true,"properties":{"cid":{"description":"The CID of the Channel for which the reminder was created","title":"Channel CID","type":"string","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.007"},"message_id":{"description":"The ID of the message for which the reminder was created","title":"Message ID","type":"string","x-stream-index":"001.002"},"parent_id":{"description":"The ID of the parent message, if the reminder is for a thread message","title":"Parent ID","type":"string","x-stream-index":"001.005"},"received_at":{"format":"date-time","type":"string","x-stream-index":"001.001.004"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","description":"The reminder object which was created","title":"MessageReminder","x-stream-index":"001.006"},"type":{"default":"reminder.deleted","description":"The type of event: \"reminder.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.002"},"user_id":{"description":"The ID of the user for whom the reminder was created","title":"User ID","type":"string","x-stream-index":"001.003"}},"required":["type","created_at","custom","message_id","user_id","cid"],"title":"ReminderDeletedEvent","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"},"ReminderNotificationEvent":{"description":"Emitted when a reminder becomes due, triggering a notification for the user.","nullable":true,"properties":{"cid":{"description":"The CID of the Channel for which the reminder was created","title":"Channel CID","type":"string","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.007"},"message_id":{"description":"The ID of the message for which the reminder was created","title":"Message ID","type":"string","x-stream-index":"001.002"},"parent_id":{"type":"string","x-stream-index":"001.005"},"received_at":{"format":"date-time","type":"string","x-stream-index":"001.001.004"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","description":"The reminder object which was created","title":"MessageReminder","x-stream-index":"001.006"},"type":{"default":"notification.reminder_due","description":"The type of event: \"notification.reminder_due\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.002"},"user_id":{"description":"The ID of the user for whom the reminder was created","title":"User ID","type":"string","x-stream-index":"001.003"}},"required":["type","created_at","custom","message_id","user_id","cid"],"title":"ReminderNotificationEvent","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"},"ReminderResponseData":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003"},"channel_cid":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"string","x-stream-index":"008"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"005"},"message_id":{"type":"string","x-stream-index":"004"},"remind_at":{"format":"date-time","type":"string","x-stream-index":"001"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007"},"user_id":{"type":"string","x-stream-index":"006"}},"required":["channel_cid","message_id","user_id","created_at","updated_at"],"type":"object"},"ReminderUpdatedEvent":{"description":"Emitted when a reminder is updated.","nullable":true,"properties":{"cid":{"description":"The CID of the Channel for which the reminder was created","title":"Channel CID","type":"string","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.007"},"message_id":{"description":"The ID of the message for which the reminder was created","title":"Message ID","type":"string","x-stream-index":"001.002"},"parent_id":{"description":"The ID of the parent message, if the reminder is for a thread message","title":"Parent ID","type":"string","x-stream-index":"001.005"},"received_at":{"format":"date-time","type":"string","x-stream-index":"001.001.004"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","description":"The reminder object which was created","title":"MessageReminder","x-stream-index":"001.006"},"type":{"default":"reminder.updated","description":"The type of event: \"reminder.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.002"},"user_id":{"description":"The ID of the user for whom the reminder was created","title":"User ID","type":"string","x-stream-index":"001.003"}},"required":["type","created_at","custom","message_id","user_id","cid"],"title":"ReminderUpdatedEvent","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"},"Response":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001"}},"required":["duration"],"title":"Response","type":"object"},"SearchPayload":{"properties":{"filter_conditions":{"additionalProperties":{},"description":"Channel filter conditions","maximum":100,"minimum":1,"title":"Channel filter","type":"object","x-stream-docs-page-id":"query_channels","x-stream-index":"002"},"limit":{"description":"Number of messages to return","format":"int32","title":"Limit","type":"integer","x-stream-index":"005"},"message_filter_conditions":{"additionalProperties":{},"description":"Message filter conditions","title":"Message filter","type":"object","x-stream-index":"003"},"message_options":{"$ref":"#/components/schemas/MessageOptions","x-stream-index":"004"},"next":{"description":"Pagination parameter. Cannot be used with non-zero offset.","title":"Next","type":"string","x-stream-index":"008"},"offset":{"description":"Pagination offset. Cannot be used with sort or next.","format":"int32","title":"Offset","type":"integer","x-stream-index":"006"},"query":{"description":"Search phrase","title":"Query","type":"string","x-stream-index":"001"},"sort":{"description":"Sort parameters. Cannot be used with non-zero offset","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"007"}},"required":["filter_conditions"],"type":"object"},"SearchResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"005.001"},"next":{"description":"Value to pass to the next search query in order to paginate","title":"Next","type":"string","x-stream-index":"003"},"previous":{"description":"Value that points to the previous page. Pass as the next value in a search query to paginate backwards","title":"Previous","type":"string","x-stream-index":"004"},"results":{"description":"Search results","items":{"$ref":"#/components/schemas/SearchResult"},"title":"Results","type":"array","x-stream-index":"001"},"results_warning":{"$ref":"#/components/schemas/SearchWarning","description":"Warning about the search results","title":"Results Warning","x-stream-index":"002"}},"required":["results","duration"],"type":"object"},"SearchResult":{"properties":{"message":{"$ref":"#/components/schemas/SearchResultMessage","description":"Found message","title":"Message","x-stream-index":"001"}},"type":"object"},"SearchResultMessage":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"001.008"},"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel object","title":"Channel","x-stream-index":"002"},"cid":{"type":"string","x-stream-index":"001.022"},"command":{"type":"string","x-stream-index":"001.004"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.023"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.026"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"001.025"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"001.018"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001.041"},"html":{"type":"string","x-stream-index":"001.005"},"i18n":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.030"},"id":{"type":"string","x-stream-index":"001.001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"001.028"},"latest_reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"001.009"},"mentioned_users":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"001.029"},"message_text_updated_at":{"format":"date-time","type":"string","x-stream-index":"001.036"},"mml":{"type":"string","x-stream-index":"001.003"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"001.039"},"own_reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"001.010"},"parent_id":{"type":"string","x-stream-index":"001.015"},"pin_expires":{"format":"date-time","type":"string","x-stream-index":"001.035"},"pinned":{"type":"boolean","x-stream-index":"001.032"},"pinned_at":{"format":"date-time","type":"string","x-stream-index":"001.033"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001.034"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001.038"},"poll_id":{"type":"string","x-stream-index":"001.037"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001.020"},"quoted_message_id":{"type":"string","x-stream-index":"001.019"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001.011"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"001.014"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001.012"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"001.042"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"001.017"},"restricted_visibility":{"items":{"type":"string"},"type":"array","x-stream-index":"001.040"},"shadowed":{"type":"boolean","x-stream-index":"001.027"},"shared_location":{"$ref":"#/components/schemas/SharedLocationResponseData","x-stream-index":"001.043"},"show_in_channel":{"type":"boolean","x-stream-index":"001.016"},"silent":{"type":"boolean","x-stream-index":"001.031"},"text":{"type":"string","x-stream-index":"001.002"},"thread_participants":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"001.021"},"type":{"type":"string","x-stream-index":"001.006"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"001.024"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001.007"}},"required":["id","text","html","type","user","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned","restricted_visibility"],"type":"object"},"SearchWarning":{"properties":{"channel_search_cids":{"description":"Channel CIDs for the searched channels","items":{"type":"string"},"title":"Channel Search CIDs","type":"array","x-stream-index":"004"},"channel_search_count":{"description":"Number of channels searched","format":"int32","title":"Channel Search Count","type":"integer","x-stream-index":"003"},"warning_code":{"description":"Code corresponding to the warning","format":"int32","title":"Warning Code","type":"integer","x-stream-index":"002"},"warning_description":{"description":"Description of the warning","title":"Warning Description","type":"string","x-stream-index":"001"}},"required":["warning_description","warning_code"],"type":"object"},"SendEventRequest":{"nullable":true,"properties":{"event":{"$ref":"#/components/schemas/EventRequest","x-stream-index":"001"}},"required":["event"],"type":"object"},"SendMessageRequest":{"nullable":true,"properties":{"keep_channel_hidden":{"type":"boolean","x-stream-index":"008"},"message":{"$ref":"#/components/schemas/MessageRequest","x-stream-index":"001"},"skip_enrich_url":{"type":"boolean","x-stream-index":"003"},"skip_push":{"type":"boolean","x-stream-index":"002"}},"required":["message"],"type":"object"},"SendMessageResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Message response","title":"Message","x-stream-index":"001"},"pending_message_metadata":{"additionalProperties":{"type":"string"},"description":"Pending message metadata","title":"Pending message metadata","type":"object","x-stream-index":"002"}},"required":["message","duration"],"type":"object"},"SendReactionRequest":{"nullable":true,"properties":{"enforce_unique":{"description":"Whether to replace all existing user reactions","title":"Enforce unique","type":"boolean","x-stream-index":"003"},"reaction":{"$ref":"#/components/schemas/ReactionRequest","x-stream-index":"002"},"skip_push":{"description":"Skips any mobile push notifications","title":"Skip push","type":"boolean","x-stream-index":"004"}},"required":["reaction"],"type":"object"},"SendReactionResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001"},"reaction":{"$ref":"#/components/schemas/ReactionResponse","x-stream-index":"002"}},"required":["message","reaction","duration"],"title":"Response","type":"object"},"SharedLocation":{"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"013"},"channel_cid":{"type":"string","x-stream-index":"003"},"created_at":{"format":"date-time","type":"string","x-stream-index":"010"},"created_by_device_id":{"type":"string","x-stream-index":"008"},"end_at":{"format":"date-time","type":"string","x-stream-index":"009"},"latitude":{"format":"float","maximum":90,"minimum":18446744073709552000,"type":"number","x-stream-index":"006"},"longitude":{"format":"float","maximum":180,"minimum":18446744073709552000,"type":"number","x-stream-index":"007"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"012"},"message_id":{"type":"string","x-stream-index":"004"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"011"},"user_id":{"type":"string","x-stream-index":"005"}},"required":["channel_cid","message_id","user_id","created_by_device_id","created_at","updated_at"],"type":"object"},"SharedLocationResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001.011"},"channel_cid":{"description":"Channel CID","title":"string","type":"string","x-stream-index":"001.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.008"},"created_by_device_id":{"description":"Device ID that created the live location","title":"string","type":"string","x-stream-index":"001.006"},"duration":{"type":"string","x-stream-index":"002.001"},"end_at":{"description":"Time when the live location expires","format":"date-time","title":"string","type":"string","x-stream-index":"001.007"},"latitude":{"description":"Latitude coordinate","format":"float","title":"number","type":"number","x-stream-index":"001.004"},"longitude":{"description":"Longitude coordinate","format":"float","title":"number","type":"number","x-stream-index":"001.005"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001.010"},"message_id":{"description":"Message ID","title":"string","type":"string","x-stream-index":"001.002"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"001.009"},"user_id":{"description":"User ID","title":"string","type":"string","x-stream-index":"001.003"}},"required":["channel_cid","message_id","user_id","latitude","longitude","created_by_device_id","created_at","updated_at","duration"],"type":"object"},"SharedLocationResponseData":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"011"},"channel_cid":{"type":"string","x-stream-index":"001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"008"},"created_by_device_id":{"type":"string","x-stream-index":"006"},"end_at":{"format":"date-time","type":"string","x-stream-index":"007"},"latitude":{"format":"float","type":"number","x-stream-index":"004"},"longitude":{"format":"float","type":"number","x-stream-index":"005"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"010"},"message_id":{"type":"string","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"009"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["channel_cid","message_id","user_id","latitude","longitude","created_by_device_id","created_at","updated_at"],"type":"object"},"SharedLocationsResponse":{"nullable":true,"properties":{"active_live_locations":{"items":{"$ref":"#/components/schemas/SharedLocationResponseData"},"type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["active_live_locations","duration"],"type":"object"},"ShowChannelRequest":{"nullable":true,"type":"object"},"ShowChannelResponse":{"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"},"SortParamRequest":{"nullable":true,"properties":{"direction":{"description":"Direction of sorting, 1 for Ascending, -1 for Descending, default is 1","format":"int32","title":"Direction","type":"integer","x-stream-index":"002"},"field":{"description":"Name of field to sort by","title":"Field","type":"string","x-stream-index":"001"}},"type":"object"},"SyncRequest":{"description":"Sync request","nullable":true,"properties":{"channel_cids":{"description":"List of channel CIDs to sync","items":{"type":"string"},"maximum":255,"minimum":1,"title":"Channel CIDs","type":"array","x-stream-index":"001"},"last_sync_at":{"description":"Date from which synchronization should happen","format":"date-time","title":"Last sync at","type":"string","x-stream-index":"002"}},"required":["channel_cids","last_sync_at"],"title":"SyncRequest","type":"object"},"SyncResponse":{"description":"Sync response","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"events":{"description":"List of events","items":{"$ref":"#/components/schemas/WSEvent"},"title":"Events","type":"array","x-stream-index":"001"},"inaccessible_cids":{"description":"List of CIDs that user can't access","items":{"type":"string"},"title":"Inaccessible CIDs","type":"array","x-stream-index":"002"}},"required":["events","duration"],"title":"SyncResponse","type":"object"},"ThreadParticipant":{"description":"Represents a user that is participating in a thread.","nullable":true,"properties":{"app_pk":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"001"},"channel_cid":{"type":"string","x-stream-index":"002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"007"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"last_read_at":{"format":"date-time","type":"string","x-stream-index":"009"},"last_thread_message_at":{"format":"date-time","type":"string","x-stream-index":"003"},"left_thread_at":{"description":"Left Thread At is the time when the user left the thread","format":"date-time","title":"Left Thread At","type":"string","x-stream-index":"008"},"thread_id":{"description":"Thead ID is unique string identifier of the thread","title":"ID","type":"string","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User is the user object","title":"User","x-stream-index":"006"},"user_id":{"description":"User ID is unique string identifier of the user","title":"User ID","type":"string","x-stream-index":"005"}},"required":["app_pk","channel_cid","created_at","last_read_at","custom"],"title":"ThreadParticipant","type":"object"},"ThreadResponse":{"properties":{"active_participant_count":{"description":"Active Participant Count","format":"int32","title":"Active Participant Count","type":"integer","x-stream-index":"009"},"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel","title":"ChannelResponse","x-stream-index":"002"},"channel_cid":{"description":"Channel CID","title":"Channel CID","type":"string","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"012"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"Created By User","title":"User","x-stream-index":"006"},"created_by_user_id":{"description":"Created By User ID","title":"Created By User ID","type":"string","x-stream-index":"005"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"016"},"deleted_at":{"description":"Deleted At","format":"date-time","title":"Deleted At","type":"string","x-stream-index":"014"},"last_message_at":{"description":"Last Message At","format":"date-time","title":"Last Message At","type":"string","x-stream-index":"011"},"parent_message":{"$ref":"#/components/schemas/MessageResponse","description":"Parent Message","title":"Message","x-stream-index":"004"},"parent_message_id":{"description":"Parent Message ID","title":"Parent Message ID","type":"string","x-stream-index":"003"},"participant_count":{"description":"Participant Count","format":"int32","title":"Participant Count","type":"integer","x-stream-index":"008"},"reply_count":{"description":"Reply Count","format":"int32","title":"Reply Count","type":"integer","x-stream-index":"007"},"thread_participants":{"description":"Thread Participants","items":{"$ref":"#/components/schemas/ThreadParticipant"},"title":"ThreadParticipants","type":"array","x-stream-index":"010"},"title":{"description":"Title","title":"Title","type":"string","x-stream-index":"015"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"013"}},"required":["channel_cid","parent_message_id","created_by_user_id","created_at","updated_at","title","custom"],"type":"object"},"ThreadStateResponse":{"nullable":true,"properties":{"active_participant_count":{"description":"Active Participant Count","format":"int32","title":"Active Participant Count","type":"integer","x-stream-index":"001.009"},"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel","title":"ChannelResponse","x-stream-index":"001.002"},"channel_cid":{"description":"Channel CID","title":"Channel CID","type":"string","x-stream-index":"001.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.012"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"Created By User","title":"User","x-stream-index":"001.006"},"created_by_user_id":{"description":"Created By User ID","title":"Created By User ID","type":"string","x-stream-index":"001.005"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"001.016"},"deleted_at":{"description":"Deleted At","format":"date-time","title":"Deleted At","type":"string","x-stream-index":"001.014"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"004"},"last_message_at":{"description":"Last Message At","format":"date-time","title":"Last Message At","type":"string","x-stream-index":"001.011"},"latest_replies":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","x-stream-index":"002"},"parent_message":{"$ref":"#/components/schemas/MessageResponse","description":"Parent Message","title":"Message","x-stream-index":"001.004"},"parent_message_id":{"description":"Parent Message ID","title":"Parent Message ID","type":"string","x-stream-index":"001.003"},"participant_count":{"description":"Participant Count","format":"int32","title":"Participant Count","type":"integer","x-stream-index":"001.008"},"read":{"items":{"$ref":"#/components/schemas/ReadStateResponse"},"type":"array","x-stream-index":"003"},"reply_count":{"description":"Reply Count","format":"int32","title":"Reply Count","type":"integer","x-stream-index":"001.007"},"thread_participants":{"description":"Thread Participants","items":{"$ref":"#/components/schemas/ThreadParticipant"},"title":"ThreadParticipants","type":"array","x-stream-index":"001.010"},"title":{"description":"Title","title":"Title","type":"string","x-stream-index":"001.015"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"001.013"}},"required":["channel_cid","parent_message_id","created_by_user_id","created_at","updated_at","title","custom","latest_replies"],"type":"object"},"ThreadUpdatedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"001.002"},"channel_type":{"type":"string","x-stream-index":"001.003"},"cid":{"type":"string","x-stream-index":"001.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"004.002"},"thread":{"$ref":"#/components/schemas/ThreadResponse","x-stream-index":"003.001"},"type":{"default":"thread.updated","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"ThreadUpdatedEvent","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"},"Thresholds":{"description":"Sets thresholds for AI moderation","properties":{"explicit":{"$ref":"#/components/schemas/LabelThresholds","description":"Thresholds for explicit messages","title":"LabelThresholds","x-stream-index":"001"},"spam":{"$ref":"#/components/schemas/LabelThresholds","description":"Thresholds for spam","title":"LabelThresholds","x-stream-index":"002"},"toxic":{"$ref":"#/components/schemas/LabelThresholds","description":"Thresholds for toxic messages","title":"LabelThresholds","x-stream-index":"003"}},"title":"Auto moderation thresholds","type":"object"},"TranslateMessageRequest":{"nullable":true,"properties":{"language":{"description":"Language to translate message to","enum":["af","sq","am","ar","az","bn","bs","bg","zh","zh-TW","hr","cs","da","fa-AF","nl","en","et","fi","fr","fr-CA","ka","de","el","ha","he","hi","hu","id","it","ja","ko","lv","ms","no","fa","ps","pl","pt","ro","ru","sr","sk","sl","so","es","es-MX","sw","sv","tl","ta","th","tr","uk","ur","vi","lt","ht"],"title":"Language","type":"string","x-stream-index":"001"}},"required":["language"],"type":"object"},"TruncateChannelRequest":{"nullable":true,"properties":{"hard_delete":{"description":"Permanently delete channel data (messages, reactions, etc.)","title":"Hard delete","type":"boolean","x-stream-index":"002"},"member_ids":{"description":"List of member IDs to hide message history for. If empty, truncates the channel for all members","items":{"type":"string"},"maximum":100,"title":"Member IDs","type":"array","x-stream-index":"007"},"message":{"$ref":"#/components/schemas/MessageRequest","x-stream-index":"004"},"skip_push":{"description":"When `message` is set disables all push notifications for it","title":"Skip push","type":"boolean","x-stream-index":"005"},"truncated_at":{"description":"Truncate channel data up to `truncated_at`. The system message (if provided) creation time is always greater than `truncated_at`","format":"date-time","title":"Truncated at","type":"string","x-stream-index":"006"}},"type":"object"},"TruncateChannelResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Truncated channel object","title":"Channel","x-stream-index":"002"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Truncated message object","title":"Message","x-stream-index":"003"}},"required":["duration"],"type":"object"},"TypingIndicators":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"TypingIndicatorsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"TypingStartEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"004.002"},"parent_id":{"type":"string","x-stream-index":"001"},"type":{"default":"typing.start","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"TypingStartEvent","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"},"TypingStopEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"004.002"},"parent_id":{"type":"string","x-stream-index":"001"},"type":{"default":"typing.stop","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"TypingStopEvent","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"},"UnblockUsersRequest":{"nullable":true,"properties":{"blocked_user_id":{"type":"string","x-stream-index":"001"}},"required":["blocked_user_id"],"type":"object"},"UnblockUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"UnmuteChannelRequest":{"nullable":true,"properties":{"channel_cids":{"description":"Channel CIDs to mute (if multiple channels)","items":{"type":"string"},"maximum":25,"title":"Channel CIDs","type":"array","x-stream-index":"001.002"},"expiration":{"description":"Duration of mute in milliseconds","title":"Expiration","type":"integer","x-stream-index":"001.003"}},"type":"object"},"UnmuteResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"non_existing_users":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"required":["duration"],"title":"Response","type":"object"},"UnmuteUserRequest":{"nullable":true,"properties":{"target_ids":{"description":"User IDs to mute (if multiple users)","items":{"type":"string"},"maximum":1000,"title":"Target IDs","type":"array","x-stream-index":"001.002"},"timeout":{"description":"Duration of mute in minutes","minimum":0,"title":"Timeout","type":"integer","x-stream-index":"001.003"}},"required":["timeout"],"type":"object"},"UnreadCountsChannel":{"properties":{"channel_id":{"type":"string","x-stream-index":"001"},"last_read":{"format":"date-time","type":"string","x-stream-index":"003"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["channel_id","unread_count","last_read"],"type":"object"},"UnreadCountsChannelType":{"properties":{"channel_count":{"format":"int32","type":"integer","x-stream-index":"002"},"channel_type":{"type":"string","x-stream-index":"001"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["channel_type","channel_count","unread_count"],"type":"object"},"UnreadCountsThread":{"properties":{"last_read":{"format":"date-time","type":"string","x-stream-index":"002"},"last_read_message_id":{"type":"string","x-stream-index":"003"},"parent_message_id":{"type":"string","x-stream-index":"004"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"001"}},"required":["unread_count","last_read","last_read_message_id","parent_message_id"],"type":"object"},"UpdateBlockListRequest":{"nullable":true,"properties":{"team":{"type":"string","x-stream-index":"002"},"words":{"description":"List of words to block","items":{"type":"string"},"minimum":1,"title":"Words","type":"array","x-stream-index":"003"}},"title":"Update block list","type":"object","x-stream-docs-page-id":"update_block_list"},"UpdateBlockListResponse":{"description":"Basic response information","nullable":true,"properties":{"blocklist":{"$ref":"#/components/schemas/BlockListResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["duration"],"title":"Response","type":"object"},"UpdateChannelPartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"type":"object","x-stream-index":"002.001"},"unset":{"items":{"type":"string"},"type":"array","x-stream-index":"002.002"}},"title":"UpdateChannelPartialRequest","type":"object"},"UpdateChannelPartialResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Updated channel object","title":"Channel","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"members":{"description":"List of updated members","items":{"$ref":"#/components/schemas/ChannelMemberResponse"},"title":"ChannelMemberResponse","type":"array","x-stream-index":"002"}},"required":["members","duration"],"type":"object"},"UpdateChannelRequest":{"nullable":true,"properties":{"accept_invite":{"description":"Set to `true` to accept the invite","title":"Accept invite","type":"boolean","x-stream-index":"008"},"add_members":{"description":"List of user IDs to add to the channel","items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"title":"Add members","type":"array","x-stream-index":"001"},"add_moderators":{"description":"List of user IDs to make channel moderators","items":{"type":"string"},"maximum":100,"title":"Add moderators","type":"array","x-stream-index":"003"},"assign_roles":{"description":"List of channel member role assignments. If any specified user is not part of the channel, the request will fail","items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"title":"Assign roles","type":"array","x-stream-index":"006"},"cooldown":{"description":"Sets cool down period for the channel in seconds","format":"int32","maximum":120,"minimum":0,"title":"Cool down","type":"integer","x-stream-index":"007"},"data":{"$ref":"#/components/schemas/ChannelInput","x-stream-index":"013.001"},"demote_moderators":{"description":"List of user IDs to take away moderators status from","items":{"type":"string"},"maximum":100,"title":"Demote moderators","type":"array","x-stream-index":"004"},"hide_history":{"description":"Set to `true` to hide channel's history when adding new members","title":"Hide history","type":"boolean","x-stream-index":"012"},"invites":{"description":"List of user IDs to invite to the channel","items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"title":"Invites","type":"array","x-stream-index":"005"},"message":{"$ref":"#/components/schemas/MessageRequest","description":"Message to send to the chat when channel is successfully updated","title":"Message","x-stream-index":"010"},"reject_invite":{"description":"Set to `true` to reject the invite","title":"Reject invite","type":"boolean","x-stream-index":"009"},"remove_members":{"description":"List of user IDs to remove from the channel","items":{"type":"string"},"maximum":100,"title":"Remove members","type":"array","x-stream-index":"002"},"skip_push":{"description":"When `message` is set disables all push notifications for it","title":"Skip push","type":"boolean","x-stream-index":"011"}},"title":"Channel update request","type":"object","x-stream-docs-page-id":"channel_update"},"UpdateChannelResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Updated channel","title":"Channel","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"004.001"},"members":{"description":"List of channel members","items":{"$ref":"#/components/schemas/ChannelMember"},"title":"Members","type":"array","x-stream-index":"003"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Message sent to the chat","title":"Message","x-stream-index":"002"}},"required":["members","duration"],"type":"object"},"UpdateLiveLocationRequest":{"nullable":true,"properties":{"end_at":{"description":"Time when the live location expires","format":"date-time","title":"string","type":"string","x-stream-index":"004"},"latitude":{"description":"Latitude coordinate","format":"float","maximum":90,"minimum":18446744073709552000,"title":"number","type":"number","x-stream-index":"002"},"longitude":{"description":"Longitude coordinate","format":"float","maximum":180,"minimum":18446744073709552000,"title":"number","type":"number","x-stream-index":"003"},"message_id":{"description":"Live location ID","title":"string","type":"string","x-stream-index":"001"}},"required":["message_id"],"type":"object"},"UpdateMemberPartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"type":"object","x-stream-index":"002.001"},"unset":{"items":{"type":"string"},"type":"array","x-stream-index":"002.002"}},"type":"object"},"UpdateMemberPartialResponse":{"nullable":true,"properties":{"channel_member":{"$ref":"#/components/schemas/ChannelMemberResponse","description":"Updated channel member","title":"Channel member","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["duration"],"type":"object"},"UpdateMessagePartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"description":"Sets new field values","title":"Set","type":"object","x-stream-index":"002.001","x-stream-map":{"key":"field","title":"Value","description":"New value to set"}},"skip_enrich_url":{"description":"Skip enriching the URL in the message","title":"SkipEnrichURL","type":"boolean","x-stream-index":"001"},"unset":{"description":"Array of field names to unset","items":{"type":"string"},"title":"Unset","type":"array","x-stream-index":"002.002"}},"type":"object"},"UpdateMessagePartialResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Updated message","title":"Message","x-stream-index":"001"},"pending_message_metadata":{"additionalProperties":{"type":"string"},"description":"Pending message metadata","title":"PendingMessageMetadata","type":"object","x-stream-index":"002"}},"required":["duration"],"type":"object"},"UpdateMessageRequest":{"nullable":true,"properties":{"message":{"$ref":"#/components/schemas/MessageRequest","description":"Message","title":"MessageRequest","x-stream-index":"001"},"skip_enrich_url":{"description":"Skip enrich URL","title":"boolean","type":"boolean","x-stream-index":"003"},"skip_push":{"type":"boolean","x-stream-index":"002"}},"required":["message"],"type":"object"},"UpdateMessageResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001"},"pending_message_metadata":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"002"}},"required":["message","duration"],"title":"Response","type":"object"},"UpdatePollOptionRequest":{"nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"004"},"id":{"description":"Option ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"},"text":{"description":"Option text","title":"string","type":"string","x-stream-index":"003"}},"required":["id","text"],"type":"object"},"UpdatePollPartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"description":"Sets new field values","title":"Set","type":"object","x-stream-index":"002.001","x-stream-map":{"key":"field","title":"Value","description":"New value to set"}},"unset":{"description":"Array of field names to unset","items":{"type":"string"},"title":"Unset","type":"array","x-stream-index":"002.002"}},"type":"object"},"UpdatePollRequest":{"nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"011"},"allow_answers":{"description":"Allow answers","title":"boolean","type":"boolean","x-stream-index":"009"},"allow_user_suggested_options":{"description":"Allow user suggested options","title":"boolean","type":"boolean","x-stream-index":"008"},"description":{"description":"Poll description","title":"string","type":"string","x-stream-index":"003"},"enforce_unique_vote":{"description":"Enforce unique vote","title":"boolean","type":"boolean","x-stream-index":"005"},"id":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"},"is_closed":{"description":"Is closed","title":"boolean","type":"boolean","x-stream-index":"010"},"max_votes_allowed":{"description":"Max votes allowed","format":"int32","maximum":10,"title":"integer","type":"integer","x-stream-index":"007"},"name":{"description":"Poll name","title":"string","type":"string","x-stream-index":"002"},"options":{"description":"Poll options","items":{"$ref":"#/components/schemas/PollOptionRequest"},"maximum":100,"title":"PollOptions","type":"array","x-stream-index":"004"},"voting_visibility":{"description":"Voting visibility","enum":["anonymous","public"],"title":"string","type":"string","x-stream-index":"006"}},"required":["id","name"],"type":"object"},"UpdateReminderRequest":{"nullable":true,"properties":{"remind_at":{"format":"date-time","type":"string","x-stream-index":"001"}},"type":"object"},"UpdateReminderResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"001"}},"required":["reminder","duration"],"title":"Response","type":"object"},"UpdateThreadPartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"description":"Sets new field values","title":"Set","type":"object","x-stream-index":"004.001","x-stream-map":{"key":"field","title":"Value","description":"New value to set"}},"unset":{"description":"Array of field names to unset","items":{"type":"string"},"title":"Unset","type":"array","x-stream-index":"004.002"}},"type":"object"},"UpdateThreadPartialResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"thread":{"$ref":"#/components/schemas/ThreadResponse","description":"Updated thread (not enriched)","title":"Thread","x-stream-index":"001"}},"required":["thread","duration"],"type":"object"},"UpdateUserPartialRequest":{"properties":{"id":{"description":"User ID to update","title":"ID","type":"string","x-stream-index":"001"},"set":{"additionalProperties":{},"type":"object","x-stream-index":"002.001"},"unset":{"items":{"type":"string"},"type":"array","x-stream-index":"002.002"}},"required":["id"],"type":"object"},"UpdateUsersPartialRequest":{"nullable":true,"properties":{"users":{"items":{"$ref":"#/components/schemas/UpdateUserPartialRequest"},"maximum":100,"type":"array","x-stream-index":"001"}},"required":["users"],"type":"object"},"UpdateUsersRequest":{"nullable":true,"properties":{"users":{"additionalProperties":{"$ref":"#/components/schemas/UserRequest"},"description":"Object containing users","title":"Users","type":"object","x-stream-index":"001","x-stream-map":{"key":"user_id"}}},"required":["users"],"type":"object"},"UpdateUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"membership_deletion_task_id":{"type":"string","x-stream-index":"002"},"users":{"additionalProperties":{"$ref":"#/components/schemas/FullUserResponse"},"description":"Object containing users","title":"Users","type":"object","x-stream-index":"001","x-stream-map":{"key":"user_id"}}},"required":["users","membership_deletion_task_id","duration"],"type":"object"},"UpsertPushPreferencesRequest":{"nullable":true,"properties":{"preferences":{"description":"A list of push preferences for channels, calls, or the user.","items":{"$ref":"#/components/schemas/PushPreferenceInput"},"type":"array","x-stream-index":"001"}},"required":["preferences"],"type":"object"},"UpsertPushPreferencesResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"user_channel_preferences":{"additionalProperties":{"additionalProperties":{"$ref":"#/components/schemas/ChannelPushPreferences"},"type":"object"},"description":"The channel specific push notification preferences, only returned for channels you've edited.","title":"User Channel Notification Preferences","type":"object","x-stream-index":"002"},"user_preferences":{"additionalProperties":{"$ref":"#/components/schemas/PushPreferences"},"description":"The user preferences, always returned regardless if you edited it","title":"User Preferences","type":"object","x-stream-index":"001"}},"required":["user_preferences","user_channel_preferences","duration"],"type":"object"},"User":{"properties":{"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"046"},"ban_expires":{"format":"date-time","type":"string","x-stream-index":"017"},"banned":{"type":"boolean","x-stream-index":"016"},"created_at":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"013"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"023"},"language":{"type":"string","x-stream-index":"035"},"last_active":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"026"},"revoke_tokens_issued_before":{"format":"date-time","type":"string","x-stream-index":"042"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"005"},"updated_at":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"009"}},"required":["id","role","teams_role","custom","banned","online"],"type":"object"},"UserBannedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"006.002"},"channel_type":{"type":"string","x-stream-index":"006.003"},"cid":{"type":"string","x-stream-index":"006.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"008.002"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"001"},"expiration":{"format":"date-time","type":"string","x-stream-index":"003"},"reason":{"type":"string","x-stream-index":"004"},"shadow":{"type":"boolean","x-stream-index":"002"},"team":{"type":"string","x-stream-index":"005.001"},"type":{"default":"user.banned","type":"string","x-stream-index":"008.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007.001"}},"required":["created_by","shadow","cid","channel_id","channel_type","type","created_at"],"title":"UserBannedEvent","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"},"UserDeactivatedEvent":{"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"003.002"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"001"},"type":{"default":"user.deactivated","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["created_by","type","created_at"],"title":"UserDeactivatedEvent","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"},"UserDeletedEvent":{"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"002.002"},"delete_conversation_channels":{"type":"boolean","x-stream-index":"005"},"hard_delete":{"type":"boolean","x-stream-index":"003.001"},"mark_messages_deleted":{"type":"boolean","x-stream-index":"004"},"type":{"default":"user.deleted","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"001.001"}},"required":["type","created_at","hard_delete","mark_messages_deleted","delete_conversation_channels"],"title":"UserDeletedEvent","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"},"UserMute":{"nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"009"},"expires":{"description":"Date/time of mute expiration","format":"date-time","title":"Expires","type":"string","x-stream-index":"008"},"target":{"$ref":"#/components/schemas/User","description":"User who's muted","title":"Target","x-stream-index":"007"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/User","description":"Owner of channel mute","title":"User","x-stream-index":"005"}},"required":["created_at","updated_at"],"type":"object"},"UserMuteResponse":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"004"},"expires":{"format":"date-time","type":"string","x-stream-index":"003"},"target":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"}},"required":["created_at","updated_at"],"type":"object"},"UserMutedEvent":{"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"004.002"},"target_user":{"type":"string","x-stream-index":"001"},"target_users":{"items":{"type":"string"},"type":"array","x-stream-index":"002"},"type":{"default":"user.muted","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"UserMutedEvent","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"},"UserPresenceChangedEvent":{"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"002.002"},"type":{"default":"user.presence.changed","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"001.001"}},"required":["type","created_at"],"title":"UserPresenceChangedEvent","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"},"UserReactivatedEvent":{"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"002.002"},"type":{"default":"user.reactivated","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"001"}},"required":["type","created_at"],"title":"UserReactivatedEvent","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"},"UserRequest":{"description":"User request object","properties":{"custom":{"additionalProperties":{},"description":"Custom user data","title":"Custom","type":"object","x-stream-index":"004"},"id":{"description":"User ID","title":"ID","type":"string","x-stream-index":"001"},"image":{"description":"User's profile image URL","title":"Image","type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"006"},"language":{"type":"string","x-stream-index":"005"},"name":{"description":"Optional name of user","title":"Name","type":"string","x-stream-index":"002"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"007"}},"required":["id"],"title":"UserRequest","type":"object"},"UserResponse":{"description":"User response object","properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"banned":{"description":"Whether a user is banned or not","title":"Banned","type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.017"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"001.004"},"deactivated_at":{"description":"Date of deactivation","format":"date-time","title":"Deactivated at","type":"string","x-stream-index":"001.016"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"string","x-stream-index":"001.011"},"id":{"description":"Unique user identifier","title":"ID","type":"string","x-stream-index":"001.001"},"image":{"title":"Image","type":"string","x-stream-index":"001.003"},"language":{"description":"Preferred language of a user","title":"Language","type":"string","x-stream-index":"001.005"},"last_active":{"description":"Date of last activity","format":"date-time","title":"Last active","type":"string","x-stream-index":"001.014"},"name":{"description":"Optional name of user","title":"Name","type":"string","x-stream-index":"001.002"},"online":{"description":"Whether a user online or not","title":"Online","type":"boolean","x-stream-index":"001.013"},"revoke_tokens_issued_before":{"description":"Revocation date for tokens","format":"date-time","title":"Revoke tokens issued before","type":"string","x-stream-index":"001.015"},"role":{"description":"Determines the set of user permissions","title":"Role","type":"string","x-stream-index":"001.006"},"teams":{"description":"List of teams user is a part of","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids","shadow_banned","invisible"],"title":"UserResponse","type":"object"},"UserResponseCommonFields":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"018"},"banned":{"type":"boolean","x-stream-index":"012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"017"},"created_at":{"format":"date-time","type":"string","x-stream-index":"009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"deactivated_at":{"format":"date-time","type":"string","x-stream-index":"016"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"011"},"id":{"type":"string","x-stream-index":"001"},"image":{"type":"string","x-stream-index":"003"},"language":{"type":"string","x-stream-index":"005"},"last_active":{"format":"date-time","type":"string","x-stream-index":"014"},"name":{"type":"string","x-stream-index":"002"},"online":{"type":"boolean","x-stream-index":"013"},"revoke_tokens_issued_before":{"format":"date-time","type":"string","x-stream-index":"015"},"role":{"type":"string","x-stream-index":"006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"008"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids"],"type":"object"},"UserResponsePrivacyFields":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"banned":{"type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.017"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"string","x-stream-index":"001.016"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"001.011"},"id":{"type":"string","x-stream-index":"001.001"},"image":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"003"},"language":{"type":"string","x-stream-index":"001.005"},"last_active":{"format":"date-time","type":"string","x-stream-index":"001.014"},"name":{"type":"string","x-stream-index":"001.002"},"online":{"type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"002"},"revoke_tokens_issued_before":{"format":"date-time","type":"string","x-stream-index":"001.015"},"role":{"type":"string","x-stream-index":"001.006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids"],"type":"object"},"UserUnbannedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"005.002"},"shadow":{"type":"boolean","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"004.001"},"type":{"default":"user.unbanned","type":"string","x-stream-index":"005.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["shadow","cid","channel_id","channel_type","type","created_at"],"title":"UserUnbannedEvent","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"},"UserUpdatedEvent":{"description":"This event is sent when a user gets updated. The event contains information about the updated user.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"received_at":{"format":"date-time","type":"string","x-stream-index":"001.004"},"type":{"default":"user.updated","description":"The type of event: \"user.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.002"},"user":{"$ref":"#/components/schemas/UserResponsePrivacyFields","description":"The updated user","title":"User","x-stream-index":"002.001"}},"required":["type","created_at","custom","user"],"title":"UserUpdatedEvent","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"},"UserWatchingStartEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"003.002"},"team":{"type":"string","x-stream-index":"002.001"},"type":{"default":"user.watching.start","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005.001"},"watcher_count":{"format":"int32","type":"integer","x-stream-index":"001.001"}},"required":["watcher_count","type","created_at","cid","channel_id","channel_type"],"title":"UserWatchingStartEvent","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"},"UserWatchingStopEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"002.002"},"type":{"default":"user.watching.stop","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"},"watcher_count":{"format":"int32","type":"integer","x-stream-index":"001.001"}},"required":["watcher_count","type","created_at","cid","channel_id","channel_type"],"title":"UserWatchingStopEvent","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"},"VoteData":{"properties":{"answer_text":{"type":"string","x-stream-index":"002"},"option_id":{"maxLength":255,"type":"string","x-stream-index":"001"}},"type":"object"},"WSClientEvent":{"description":"The discriminator object for all websocket client events, it maps events' payload to the final type","discriminator":{"mapping":{"app.updated":"#/components/schemas/AppUpdatedEvent","draft.deleted":"#/components/schemas/DraftDeletedEvent","draft.updated":"#/components/schemas/DraftUpdatedEvent","health.check":"#/components/schemas/HealthCheckEvent","message.pending":"#/components/schemas/PendingMessageEvent","notification.reminder_due":"#/components/schemas/ReminderNotificationEvent","poll.closed":"#/components/schemas/PollClosedEvent","poll.deleted":"#/components/schemas/PollDeletedEvent","poll.updated":"#/components/schemas/PollUpdatedEvent","poll.vote_casted":"#/components/schemas/PollVoteCastedEvent","poll.vote_changed":"#/components/schemas/PollVoteChangedEvent","poll.vote_removed":"#/components/schemas/PollVoteRemovedEvent","reminder.created":"#/components/schemas/ReminderCreatedEvent","reminder.deleted":"#/components/schemas/ReminderDeletedEvent","reminder.updated":"#/components/schemas/ReminderUpdatedEvent","user.updated":"#/components/schemas/UserUpdatedEvent"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/AppUpdatedEvent"},{"$ref":"#/components/schemas/DraftDeletedEvent"},{"$ref":"#/components/schemas/DraftUpdatedEvent"},{"$ref":"#/components/schemas/HealthCheckEvent"},{"$ref":"#/components/schemas/PendingMessageEvent"},{"$ref":"#/components/schemas/PollClosedEvent"},{"$ref":"#/components/schemas/PollDeletedEvent"},{"$ref":"#/components/schemas/PollUpdatedEvent"},{"$ref":"#/components/schemas/PollVoteCastedEvent"},{"$ref":"#/components/schemas/PollVoteChangedEvent"},{"$ref":"#/components/schemas/PollVoteRemovedEvent"},{"$ref":"#/components/schemas/ReminderCreatedEvent"},{"$ref":"#/components/schemas/ReminderDeletedEvent"},{"$ref":"#/components/schemas/ReminderNotificationEvent"},{"$ref":"#/components/schemas/ReminderUpdatedEvent"},{"$ref":"#/components/schemas/UserUpdatedEvent"}]},"WSEvent":{"description":"The discriminator object for all websocket events, it maps events' payload to the final type","discriminator":{"mapping":{"*":"#/components/schemas/AnyEvent","activity.marked":"#/components/schemas/ActivityMarkedEvent","ai_indicator.clear":"#/components/schemas/AIIndicatorClearEvent","ai_indicator.stop":"#/components/schemas/AIIndicatorStopEvent","ai_indicator.update":"#/components/schemas/AIIndicatorUpdateEvent","app.updated":"#/components/schemas/AppUpdatedEvent","channel.created":"#/components/schemas/ChannelCreatedEvent","channel.deleted":"#/components/schemas/ChannelDeletedEvent","channel.frozen":"#/components/schemas/ChannelFrozenEvent","channel.hidden":"#/components/schemas/ChannelHiddenEvent","channel.kicked":"#/components/schemas/ChannelKickedEvent","channel.truncated":"#/components/schemas/ChannelTruncatedEvent","channel.unfrozen":"#/components/schemas/ChannelUnFrozenEvent","channel.updated":"#/components/schemas/ChannelUpdatedEvent","channel.visible":"#/components/schemas/ChannelVisibleEvent","draft.deleted":"#/components/schemas/DraftDeletedEvent","draft.updated":"#/components/schemas/DraftUpdatedEvent","health.check":"#/components/schemas/HealthCheckEvent","member.added":"#/components/schemas/MemberAddedEvent","member.removed":"#/components/schemas/MemberRemovedEvent","member.updated":"#/components/schemas/MemberUpdatedEvent","message.deleted":"#/components/schemas/MessageDeletedEvent","message.new":"#/components/schemas/MessageNewEvent","message.pending":"#/components/schemas/PendingMessageEvent","message.read":"#/components/schemas/MessageReadEvent","message.undeleted":"#/components/schemas/MessageUndeletedEvent","message.updated":"#/components/schemas/MessageUpdatedEvent","notification.added_to_channel":"#/components/schemas/NotificationAddedToChannelEvent","notification.channel_deleted":"#/components/schemas/NotificationChannelDeletedEvent","notification.channel_mutes_updated":"#/components/schemas/NotificationChannelMutesUpdatedEvent","notification.channel_truncated":"#/components/schemas/NotificationChannelTruncatedEvent","notification.invite_accepted":"#/components/schemas/NotificationInviteAcceptedEvent","notification.invite_rejected":"#/components/schemas/NotificationInviteRejectedEvent","notification.invited":"#/components/schemas/NotificationInvitedEvent","notification.mark_read":"#/components/schemas/NotificationMarkReadEvent","notification.mark_unread":"#/components/schemas/NotificationMarkUnreadEvent","notification.message_new":"#/components/schemas/NotificationNewMessageEvent","notification.mutes_updated":"#/components/schemas/NotificationMutesUpdatedEvent","notification.reminder_due":"#/components/schemas/ReminderNotificationEvent","notification.removed_from_channel":"#/components/schemas/NotificationRemovedFromChannelEvent","notification.thread_message_new":"#/components/schemas/MessageNewEvent","poll.closed":"#/components/schemas/PollClosedEvent","poll.deleted":"#/components/schemas/PollDeletedEvent","poll.updated":"#/components/schemas/PollUpdatedEvent","poll.vote_casted":"#/components/schemas/PollVoteCastedEvent","poll.vote_changed":"#/components/schemas/PollVoteChangedEvent","poll.vote_removed":"#/components/schemas/PollVoteRemovedEvent","reaction.deleted":"#/components/schemas/ReactionDeletedEvent","reaction.new":"#/components/schemas/ReactionNewEvent","reaction.updated":"#/components/schemas/ReactionUpdatedEvent","reminder.created":"#/components/schemas/ReminderCreatedEvent","reminder.deleted":"#/components/schemas/ReminderDeletedEvent","reminder.updated":"#/components/schemas/ReminderUpdatedEvent","thread.updated":"#/components/schemas/ThreadUpdatedEvent","typing.start":"#/components/schemas/TypingStartEvent","typing.stop":"#/components/schemas/TypingStopEvent","user.banned":"#/components/schemas/UserBannedEvent","user.deactivated":"#/components/schemas/UserDeactivatedEvent","user.deleted":"#/components/schemas/UserDeletedEvent","user.muted":"#/components/schemas/UserMutedEvent","user.presence.changed":"#/components/schemas/UserPresenceChangedEvent","user.reactivated":"#/components/schemas/UserReactivatedEvent","user.unbanned":"#/components/schemas/UserUnbannedEvent","user.updated":"#/components/schemas/UserUpdatedEvent","user.watching.start":"#/components/schemas/UserWatchingStartEvent","user.watching.stop":"#/components/schemas/UserWatchingStopEvent"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/AIIndicatorClearEvent"},{"$ref":"#/components/schemas/AIIndicatorStopEvent"},{"$ref":"#/components/schemas/AIIndicatorUpdateEvent"},{"$ref":"#/components/schemas/ActivityMarkedEvent"},{"$ref":"#/components/schemas/AnyEvent"},{"$ref":"#/components/schemas/AppUpdatedEvent"},{"$ref":"#/components/schemas/ChannelCreatedEvent"},{"$ref":"#/components/schemas/ChannelDeletedEvent"},{"$ref":"#/components/schemas/ChannelFrozenEvent"},{"$ref":"#/components/schemas/ChannelHiddenEvent"},{"$ref":"#/components/schemas/ChannelKickedEvent"},{"$ref":"#/components/schemas/ChannelTruncatedEvent"},{"$ref":"#/components/schemas/ChannelUnFrozenEvent"},{"$ref":"#/components/schemas/ChannelUpdatedEvent"},{"$ref":"#/components/schemas/ChannelVisibleEvent"},{"$ref":"#/components/schemas/DraftDeletedEvent"},{"$ref":"#/components/schemas/DraftUpdatedEvent"},{"$ref":"#/components/schemas/HealthCheckEvent"},{"$ref":"#/components/schemas/MemberAddedEvent"},{"$ref":"#/components/schemas/MemberRemovedEvent"},{"$ref":"#/components/schemas/MemberUpdatedEvent"},{"$ref":"#/components/schemas/MessageDeletedEvent"},{"$ref":"#/components/schemas/MessageNewEvent"},{"$ref":"#/components/schemas/MessageNewEvent"},{"$ref":"#/components/schemas/MessageReadEvent"},{"$ref":"#/components/schemas/MessageUndeletedEvent"},{"$ref":"#/components/schemas/MessageUpdatedEvent"},{"$ref":"#/components/schemas/NotificationAddedToChannelEvent"},{"$ref":"#/components/schemas/NotificationChannelDeletedEvent"},{"$ref":"#/components/schemas/NotificationChannelMutesUpdatedEvent"},{"$ref":"#/components/schemas/NotificationChannelTruncatedEvent"},{"$ref":"#/components/schemas/NotificationInviteAcceptedEvent"},{"$ref":"#/components/schemas/NotificationInviteRejectedEvent"},{"$ref":"#/components/schemas/NotificationInvitedEvent"},{"$ref":"#/components/schemas/NotificationMarkReadEvent"},{"$ref":"#/components/schemas/NotificationMarkUnreadEvent"},{"$ref":"#/components/schemas/NotificationMutesUpdatedEvent"},{"$ref":"#/components/schemas/NotificationNewMessageEvent"},{"$ref":"#/components/schemas/NotificationRemovedFromChannelEvent"},{"$ref":"#/components/schemas/PendingMessageEvent"},{"$ref":"#/components/schemas/PollClosedEvent"},{"$ref":"#/components/schemas/PollDeletedEvent"},{"$ref":"#/components/schemas/PollUpdatedEvent"},{"$ref":"#/components/schemas/PollVoteCastedEvent"},{"$ref":"#/components/schemas/PollVoteChangedEvent"},{"$ref":"#/components/schemas/PollVoteRemovedEvent"},{"$ref":"#/components/schemas/ReactionDeletedEvent"},{"$ref":"#/components/schemas/ReactionNewEvent"},{"$ref":"#/components/schemas/ReactionUpdatedEvent"},{"$ref":"#/components/schemas/ReminderCreatedEvent"},{"$ref":"#/components/schemas/ReminderDeletedEvent"},{"$ref":"#/components/schemas/ReminderNotificationEvent"},{"$ref":"#/components/schemas/ReminderUpdatedEvent"},{"$ref":"#/components/schemas/ThreadUpdatedEvent"},{"$ref":"#/components/schemas/TypingStartEvent"},{"$ref":"#/components/schemas/TypingStopEvent"},{"$ref":"#/components/schemas/UserBannedEvent"},{"$ref":"#/components/schemas/UserDeactivatedEvent"},{"$ref":"#/components/schemas/UserDeletedEvent"},{"$ref":"#/components/schemas/UserMutedEvent"},{"$ref":"#/components/schemas/UserPresenceChangedEvent"},{"$ref":"#/components/schemas/UserReactivatedEvent"},{"$ref":"#/components/schemas/UserUnbannedEvent"},{"$ref":"#/components/schemas/UserUpdatedEvent"},{"$ref":"#/components/schemas/UserWatchingStartEvent"},{"$ref":"#/components/schemas/UserWatchingStopEvent"}]},"WrappedUnreadCountsResponse":{"description":"Basic response information","nullable":true,"properties":{"channel_type":{"items":{"$ref":"#/components/schemas/UnreadCountsChannelType"},"type":"array","x-stream-index":"001.005"},"channels":{"items":{"$ref":"#/components/schemas/UnreadCountsChannel"},"type":"array","x-stream-index":"001.004"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"threads":{"items":{"$ref":"#/components/schemas/UnreadCountsThread"},"type":"array","x-stream-index":"001.006"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"001.001"},"total_unread_count_by_team":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001.003"},"total_unread_threads_count":{"format":"int32","type":"integer","x-stream-index":"001.002"}},"required":["total_unread_count","total_unread_threads_count","channels","channel_type","threads","duration"],"title":"Response","type":"object"},"connectRequestQuery":{"nullable":true,"type":"object"}},"securitySchemes":{"JWT":{"description":"JWT should be always provided when stream-auth-type=jwt.\n\nUsing JWT auth request could be authenticated as user or as server-side.\n\nWhen using user authentication permission checking is going to be applied to requests based on the user that is\nperforming a request.\n\nThe `authorization` header should be a JWT string signed using the secret attached to the API key used to perform\nrequests.\n\n**WARNING** all client-side official SDK do not ship with token generation; this is to make sure that the API secret is not\nshared with an untrusted party such as a browser or a iOS/Android application. Tokens **must** be generated server-side.\nIf you wish, you can configure your application to ignore authentication (see `disable_auth_check`)\nThe JWT string must include only the user_id claim and can include any built-in JWT claim such as iat, exp as well.\n","in":"header","name":"Authorization","type":"apiKey"},"api_key":{"description":"Application API key should be always set in order to authenticate the request.","in":"query","name":"api_key","type":"apiKey"},"stream-auth-type":{"description":"Stream-Auth-Type should be always set in order to authenticate the request. Possible\nvalues: `jwt` or `anonymous`.\n\n`jwt` allows you to authenticate as a user. With this auth type you should also provide valid JWT in Authorization\nheader.\n\n`anonymous` allows you to authenticate as anonymous user. Please note that most advanced features are not available\nto anonymous users.","in":"header","name":"Stream-Auth-Type","type":"apiKey"}}},"info":{"title":"Stream API","version":"v187.13.0"},"openapi":"3.0.3","paths":{"/app":{"get":{"description":"This Method returns the application settings\n","operationId":"GetApp","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetApplicationResponse"}}},"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":"Get App Settings","tags":["product:chat"]}},"/blocklists":{"get":{"description":"Returns all available block lists\n","operationId":"ListBlockLists","parameters":[{"in":"query","name":"team","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListBlockListResponse"}}},"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":"List block lists","tags":["product:chat"]},"post":{"description":"Creates a new application blocklist, once created the blocklist can be used by any channel type\n","operationId":"CreateBlockList","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBlockListRequest"}}},"description":"Block list","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBlockListResponse"}}},"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":"Create block list","tags":["product:chat"]}},"/blocklists/{name}":{"delete":{"description":"Deletes previously created application blocklist\n","operationId":"DeleteBlockList","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"team","schema":{"type":"string","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete block list","tags":["product:chat"]},"put":{"description":"Updates contents of the block list\n","operationId":"UpdateBlockList","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Block list name","title":"Name","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBlockListRequest"}}},"description":"Update block list","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBlockListResponse"}}},"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":"Update block list","tags":["product:chat"]}},"/channels":{"post":{"description":"Query channels with filter query\n","operationId":"QueryChannels","parameters":[{"in":"query","name":"connection_id","schema":{"description":"Websocket connection ID to interact with. You can pass it as Body or URL parameter","title":"Connection ID","type":"string","x-stream-index":"011.003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryChannelsRequest"}}},"description":"Query Channels Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryChannelsResponse"}}},"description":"Channels list"},"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":"Query channels","tags":["product:chat"]}},"/channels/delete":{"post":{"description":"Allows to delete several channels at once asynchronously\n\nSends events:\n- channel.deleted\n- channel.deleted\n","operationId":"DeleteChannels","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteChannelsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteChannelsResponse"}}},"description":"Successful 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":"Deletes channels asynchronously","tags":["product:chat"]}},"/channels/read":{"post":{"description":"Marks channels as read up to the specific message. If no channels is given, mark all channel as read\n\nSends events:\n- message.read\n- message.read\n","operationId":"MarkChannelsRead","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkChannelsReadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkReadResponse"}}},"description":"Successful 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 channels as read","tags":["product:chat"]}},"/channels/{type}/query":{"post":{"description":"This Method creates a channel or returns an existing one with matching attributes\n\nSends events:\n- channel.created\n- member.added\n- member.removed\n- member.updated\n- user.watching.start\n","operationId":"GetOrCreateDistinctChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"connection_id","schema":{"description":"Websocket connection ID to interact with. You can pass it as Body or URL parameter","title":"Connection ID","type":"string","x-stream-index":"012.003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelGetOrCreateRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelStateResponse"}}},"description":"Successful 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":"Get or create channel","tags":["product:chat"]}},"/channels/{type}/{id}":{"delete":{"description":"Deletes channel\n\nSends events:\n- channel.deleted\n- channel.deleted\n","operationId":"DeleteChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"query","name":"hard_delete","schema":{"type":"boolean","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteChannelResponse"}}},"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":"Delete channel","tags":["product:chat"]},"patch":{"description":"Updates certain fields of the channel\n\nSends events:\n- channel.updated\n- channel.updated\n","operationId":"UpdateChannelPartial","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelPartialRequest"}}},"description":"UpdateChannelPartialRequest","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelPartialResponse"}}},"description":"Successful 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":"Partially update channel","tags":["product:chat"]},"post":{"description":"Change channel data\n\nSends events:\n- channel.updated\n- member.added\n- member.removed\n- member.updated\n- message.new\n- channel.updated\n- member.added\n- member.removed\n- member.updated\n- message.new\n","operationId":"UpdateChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"013.002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"013.002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelRequest"}}},"description":"Channel update request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelResponse"}}},"description":"Successful 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":"Update channel","tags":["product:chat"]}},"/channels/{type}/{id}/draft":{"delete":{"description":"Deletes a draft\n\nSends events:\n- draft.deleted\n","operationId":"DeleteDraft","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"parent_id","schema":{"description":"Parent message ID","title":"string","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete draft","tags":["product:chat"]},"get":{"description":"Get a draft\n","operationId":"GetDraft","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"parent_id","schema":{"description":"Parent message ID","title":"string","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetDraftResponse"}}},"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":"Get draft","tags":["product:chat"]},"post":{"description":"Creates a draft\n\nSends events:\n- draft.updated\n","operationId":"CreateDraft","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDraftRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDraftResponse"}}},"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":"Create a draft","tags":["product:chat"]}},"/channels/{type}/{id}/event":{"post":{"description":"Sends event to the channel\n","operationId":"SendEvent","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendEventRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventResponse"}}},"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":"Send event","tags":["product:chat"]}},"/channels/{type}/{id}/file":{"delete":{"description":"Deletes previously uploaded file\n","operationId":"DeleteFile","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of file","title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"File ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"url","schema":{"description":"File URL to delete","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete file","tags":["product:chat"]},"post":{"description":"Uploads file\n","operationId":"UploadFile","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/FileUploadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileUploadResponse"}}},"description":"Successful 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":"Upload file","tags":["product:chat"]}},"/channels/{type}/{id}/hide":{"post":{"description":"Marks channel as hidden for current user\n\nSends events:\n- channel.hidden\n- channel.hidden\n","operationId":"HideChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HideChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HideChannelResponse"}}},"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":"Hide channel","tags":["product:chat"]}},"/channels/{type}/{id}/image":{"delete":{"description":"Deletes previously uploaded image\n","operationId":"DeleteImage","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of file","title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"File ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"url","schema":{"description":"File URL to delete","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete image","tags":["product:chat"]},"post":{"description":"Uploads image\n","operationId":"UploadImage","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.001.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.001.002"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/ImageUploadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageUploadResponse"}}},"description":"Successful 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":"Upload image","tags":["product:chat"]}},"/channels/{type}/{id}/member":{"patch":{"description":"\n","operationId":"UpdateMemberPartial","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMemberPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMemberPartialResponse"}}},"description":"Successful 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":"Partially channel member update","tags":["product:chat"]}},"/channels/{type}/{id}/message":{"post":{"description":"Sends new message to the specified channel\n\nSends events:\n- message.new\n- message.updated\n- message.new\n- message.updated\n","operationId":"SendMessage","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"009.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"009.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendMessageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendMessageResponse"}}},"description":"Successful 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":"Send new message","tags":["product:chat"]}},"/channels/{type}/{id}/messages":{"get":{"description":"Returns list messages found by IDs\n","operationId":"GetManyMessages","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"ids","required":true,"schema":{"description":"List of comma-separated IDs","items":{"type":"string"},"maximum":50,"minimum":1,"title":"IDs","type":"array","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetManyMessagesResponse"}}},"description":"Successful 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":"Get many messages","tags":["product:chat"]}},"/channels/{type}/{id}/query":{"post":{"description":"This Method creates a channel or returns an existing one with matching attributes\n\nSends events:\n- channel.created\n- member.added\n- member.removed\n- member.updated\n- user.watching.start\n","operationId":"GetOrCreateChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID (maximum length of 64 characters)","title":"ID","type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"connection_id","schema":{"description":"Websocket connection ID to interact with. You can pass it as Body or URL parameter","title":"Connection ID","type":"string","x-stream-index":"012.003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelGetOrCreateRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelStateResponse"}}},"description":"Successful 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":"Get or create channel","tags":["product:chat"]}},"/channels/{type}/{id}/read":{"post":{"description":"Marks channel as read up to the specific message\n\nSends events:\n- message.read\n- message.read\n","operationId":"MarkRead","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkReadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkReadResponse"}}},"description":"Successful 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 read","tags":["product:chat"]}},"/channels/{type}/{id}/show":{"post":{"description":"Shows previously hidden channel\n\nSends events:\n- channel.visible\n- channel.visible\n","operationId":"ShowChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShowChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShowChannelResponse"}}},"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":"Show channel","tags":["product:chat"]}},"/channels/{type}/{id}/stop-watching":{"post":{"description":"Call this Method to stop receiving channel events\n\nSends events:\n- user.watching.stop\n- user.watching.stop\n","operationId":"StopWatchingChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"connection_id","schema":{"type":"string","x-stream-index":"001.003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelStopWatchingRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Stop watching channel","tags":["product:chat"]}},"/channels/{type}/{id}/truncate":{"post":{"description":"Truncates messages from a channel. Can be applied to the entire channel or scoped to specific members.\n\nSends events:\n- channel.truncated\n- channel.truncated\n","operationId":"TruncateChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TruncateChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TruncateChannelResponse"}}},"description":"Successful 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":"Truncate channel","tags":["product:chat"]}},"/channels/{type}/{id}/unread":{"post":{"description":"Marks channel as unread from a specific message\n","operationId":"MarkUnread","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkUnreadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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 unread","tags":["product:chat"]}},"/devices":{"delete":{"description":"Deletes one device\n","operationId":"DeleteDevice","parameters":[{"in":"query","name":"id","required":true,"schema":{"description":"Device ID to delete","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete device","tags":["product:chat"]},"get":{"description":"Returns all available devices\n","operationId":"ListDevices","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDevicesResponse"}}},"description":"ListDevicesResponse"},"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":"List devices","tags":["product:chat"]},"post":{"description":"Adds a new device to a user, if the same device already exists the call will have no effect\n","operationId":"CreateDevice","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDeviceRequest"}}},"description":"CreateDeviceRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Create device","tags":["product:chat"]}},"/drafts/query":{"post":{"description":"Queries draft messages for a user\n","operationId":"QueryDrafts","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryDraftsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryDraftsResponse"}}},"description":"Successful 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":"Query draft messages","tags":["product:chat"]}},"/guest":{"post":{"description":"\n","operationId":"CreateGuest","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGuestRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGuestResponse"}}},"description":"Successful 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":"Create Guest","tags":["product:chat"]}},"/longpoll":{"get":{"description":"WebSocket fallback transport endpoint\n\nSends events:\n- user.updated\n","operationId":"LongPoll","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectRequest","x-stream-index":"001"}}},"in":"query","name":"json"},{"in":"query","name":"connection_id","schema":{"maxLength":36,"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"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":"Long Poll (Transport)","tags":["product:chat"]}},"/members":{"get":{"description":"Find and filter channel members\n","operationId":"QueryMembers","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryMembersPayload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MembersResponse"}}},"description":"Successful 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":"Query members","tags":["product:chat"]}},"/messages/{id}":{"delete":{"description":"Deletes message\n\nSends events:\n- message.deleted\n- message.deleted\n","operationId":"DeleteMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID to delete","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"hard","schema":{"description":"Delete all message reactions and replies as well","title":"Hard","type":"boolean","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"deleted_by","schema":{"type":"string","writeOnly":true,"x-stream-index":"003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteMessageResponse"}}},"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":"Delete message","tags":["product:chat"]},"get":{"description":"Returns message by ID\n","operationId":"GetMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"ID of the message","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetMessageResponse"}}},"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":"Get message","tags":["product:chat"]},"post":{"description":"Updates message with new data\n\nSends events:\n- message.updated\n- message.updated\n","operationId":"UpdateMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"004.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessageResponse"}}},"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":"Update message","tags":["product:chat"]},"put":{"description":"Updates certain fields of the message\n\nSends events:\n- message.updated\n- message.updated\n","operationId":"UpdateMessagePartial","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessagePartialRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessagePartialResponse"}}},"description":"Successful 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":"Partially message update","tags":["product:chat"]}},"/messages/{id}/action":{"post":{"description":"Executes message command action with given parameters\n\nSends events:\n- message.new\n- message.new\n","operationId":"RunMessageAction","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageActionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}},"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":"Run message command action","tags":["product:chat"]}},"/messages/{id}/reaction":{"post":{"description":"Sends reaction to specified message\n\nSends events:\n- reaction.new\n- reaction.updated\n","operationId":"SendReaction","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID to send reaction for","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendReactionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendReactionResponse"}}},"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":"Send reaction","tags":["product:chat"]}},"/messages/{id}/reaction/{type}":{"delete":{"description":"Removes user reaction from the message\n\nSends events:\n- reaction.deleted\n","operationId":"DeleteReaction","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID to remove reaction from","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"type","required":true,"schema":{"description":"Reaction type to remove","title":"Type","type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"description":"**Server-side only**. User ID which server acts upon","title":"User ID","type":"string","writeOnly":true,"x-stream-index":"003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteReactionResponse"}}},"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":"Delete reaction","tags":["product:chat"]}},"/messages/{id}/reactions":{"get":{"description":"Returns list of reactions of specific message\n","operationId":"GetReactions","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"limit","schema":{"description":"Number of records to return","format":"int32","title":"Limit","type":"integer","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"offset","schema":{"description":"Number of records to offset","format":"int32","title":"Offset","type":"integer","writeOnly":true,"x-stream-index":"003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetReactionsResponse"}}},"description":"Successful 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":"Get reactions","tags":["product:chat"]},"post":{"description":"Get reactions on a message\n","operationId":"QueryReactions","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryReactionsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryReactionsResponse"}}},"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"}},"tags":["product:chat"]}},"/messages/{id}/translate":{"post":{"description":"Translates message to a given language using automated translation software\n\nSends events:\n- message.updated\n- message.updated\n","operationId":"TranslateMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TranslateMessageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}},"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":"Translate message","tags":["product:chat"]}},"/messages/{message_id}/polls/{poll_id}/vote":{"post":{"description":"Cast a vote on a poll\n\nSends events:\n- feeds.poll.vote_casted\n- feeds.poll.vote_changed\n- feeds.poll.vote_removed\n- poll.vote_casted\n- poll.vote_changed\n- poll.vote_removed\n","operationId":"CastPollVote","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CastPollVoteRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollVoteResponse"}}},"description":"Successful 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":"Cast vote","tags":["product:chat"]}},"/messages/{message_id}/polls/{poll_id}/vote/{vote_id}":{"delete":{"description":"Delete a vote from a poll\n\nSends events:\n- feeds.poll.vote_removed\n- poll.vote_removed\n","operationId":"DeletePollVote","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"004"}},{"in":"path","name":"vote_id","required":true,"schema":{"description":"Vote ID","maxLength":255,"title":"string","type":"string","x-stream-index":"005"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollVoteResponse"}}},"description":"Successful 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":"Delete vote","tags":["product:chat"]}},"/messages/{message_id}/reminders":{"delete":{"description":"Deletes a user's created reminder\n\nSends events:\n- reminder.deleted\n","operationId":"DeleteReminder","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteReminderResponse"}}},"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":"Delete reminder","tags":["product:chat"]},"patch":{"description":"Updates an existing reminder\n\nSends events:\n- reminder.updated\n","operationId":"UpdateReminder","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateReminderRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateReminderResponse"}}},"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":"Updates Reminder","tags":["product:chat"]},"post":{"description":"Creates a new reminder\n\nSends events:\n- reminder.created\n","operationId":"CreateReminder","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateReminderRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReminderResponseData"}}},"description":"Successful 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":"Create reminder","tags":["product:chat"]}},"/messages/{parent_id}/replies":{"get":{"description":"Returns replies (thread) of the message\n","operationId":"GetReplies","parameters":[{"in":"path","name":"parent_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"sort","schema":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":1,"type":"array","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"limit","schema":{"description":"The maximum number of messages to return (max limit ","format":"int32","minimum":0,"title":"Limit","type":"integer","x-stream-index":"003.001"}},{"in":"query","name":"offset","schema":{"description":"The offset to start from","format":"int32","title":"Offset","type":"integer","x-stream-index":"003.002"}},{"in":"query","name":"id_gte","schema":{"description":"The ID of the message to get messages with a timestamp greater than or equal to","title":"IDGTE","type":"string","x-stream-index":"003.003"}},{"in":"query","name":"id_gt","schema":{"description":"The ID of the message to get messages with a timestamp greater than","title":"IDGT","type":"string","x-stream-index":"003.004"}},{"in":"query","name":"id_lte","schema":{"description":"The ID of the message to get messages with a timestamp smaller than or equal to","title":"IDLTE","type":"string","x-stream-index":"003.005"}},{"in":"query","name":"id_lt","schema":{"description":"The ID of the message to get messages with a timestamp smaller than","title":"IDLT","type":"string","x-stream-index":"003.006"}},{"in":"query","name":"created_at_after_or_equal","schema":{"description":"The timestamp to get messages with a created_at timestamp greater than or equal to","format":"date-time","title":"Created_at after or equal","type":"string","x-stream-index":"003.007"}},{"in":"query","name":"created_at_after","schema":{"description":"The timestamp to get messages with a created_at timestamp greater than","format":"date-time","title":"Created_at after","type":"string","x-stream-index":"003.008"}},{"in":"query","name":"created_at_before_or_equal","schema":{"description":"The timestamp to get messages with a created_at timestamp smaller than or equal to","format":"date-time","title":"Created_at after before or equal","type":"string","x-stream-index":"003.009"}},{"in":"query","name":"created_at_before","schema":{"description":"The timestamp to get messages with a created_at timestamp smaller than","format":"date-time","title":"Created_at after before","type":"string","x-stream-index":"003.010"}},{"in":"query","name":"id_around","schema":{"description":"The result will be a set of messages, that are both older and newer than the message with the provided ID, and the message with the ID provided will be in the middle of the set","title":"Id around","type":"string","x-stream-index":"003.011"}},{"in":"query","name":"created_at_around","schema":{"description":"The result will be a set of messages, that are both older and newer than the created_at timestamp provided, distributed evenly around the timestamp","format":"date-time","title":"Created_at around","type":"string","x-stream-index":"003.012"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRepliesResponse"}}},"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":"Get replies","tags":["product:chat"]}},"/moderation/ban":{"delete":{"description":"Removes previously applied ban\n\nSends events:\n- user.unbanned\n- user.unbanned\n","operationId":"Unban","parameters":[{"in":"query","name":"target_user_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"channel_cid","schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"created_by","schema":{"type":"string","writeOnly":true,"x-stream-index":"005"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Unban user","tags":["product:chat"]},"post":{"description":"Restricts user activity either in specific channel or globally\n\nSends events:\n- user.banned\n- user.banned\n","operationId":"Ban","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BanRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Ban user","tags":["product:chat"]}},"/moderation/flag":{"post":{"description":"Reports message or user for review by moderators\n\nSends events:\n- message.flagged\n- user.flagged\n- message.flagged\n- user.flagged\n","operationId":"Flag","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlagRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlagResponse"}}},"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":"Flag","tags":["product:chat"]}},"/moderation/flags/message":{"get":{"description":"Find and filter message flags\n","operationId":"QueryMessageFlags","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryMessageFlagsPayload","description":"JSON object with query message flags payload","title":"Payload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryMessageFlagsResponse"}}},"description":"QueryMessageFlagsResponse"},"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":"Query Message Flags","tags":["product:chat"]}},"/moderation/mute":{"post":{"description":"Mutes one or several users\n\nSends events:\n- user.unmuted\n- user.muted\n","operationId":"MuteUser","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteUserRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteUserResponse"}}},"description":"Successful 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":"Mute user","tags":["product:chat"]}},"/moderation/mute/channel":{"post":{"description":"Mutes channel for user\n\nSends events:\n- channel.muted\n- channel.muted\n","operationId":"MuteChannel","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteChannelResponse"}}},"description":"Successful 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":"Mute channel","tags":["product:chat"]}},"/moderation/unmute":{"post":{"description":"Unmutes previously muted user\n\nSends events:\n- user.unmuted\n- user.unmuted\n","operationId":"UnmuteUser","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnmuteUserRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnmuteResponse"}}},"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":"Unmute user","tags":["product:chat"]}},"/moderation/unmute/channel":{"post":{"description":"Unmutes channel for user\n\nSends events:\n- channel.unmuted\n- channel.unmuted\n","operationId":"UnmuteChannel","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnmuteChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnmuteResponse"}}},"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":"Unmute channel","tags":["product:chat"]}},"/og":{"get":{"description":"Get an OpenGraph attachment for a link\n","operationId":"GetOG","parameters":[{"in":"query","name":"url","required":true,"schema":{"description":"URL to be scraped","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOGResponse"}}},"description":"Get OG Attachment"},"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":"Get OG","tags":["product:chat"]}},"/polls":{"post":{"description":"Creates a new poll\n","operationId":"CreatePoll","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePollRequest"}}},"description":"Create Poll Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Create poll","tags":["product:chat"]},"put":{"description":"Updates a poll\n\nSends events:\n- feeds.poll.closed\n- feeds.poll.updated\n- poll.closed\n- poll.updated\n","operationId":"UpdatePoll","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePollRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Update poll","tags":["product:chat"]}},"/polls/query":{"post":{"description":"Queries polls\n","operationId":"QueryPolls","parameters":[{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryPollsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryPollsResponse"}}},"description":"Successful 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":"Query polls","tags":["product:chat"]}},"/polls/{poll_id}":{"delete":{"description":"Deletes a poll\n\nSends events:\n- feeds.poll.deleted\n- poll.deleted\n","operationId":"DeletePoll","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete poll","tags":["product:chat"]},"get":{"description":"Retrieves a poll\n","operationId":"GetPoll","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Get poll","tags":["product:chat"]},"patch":{"description":"Updates a poll partially\n\nSends events:\n- feeds.poll.closed\n- feeds.poll.updated\n- poll.closed\n- poll.updated\n","operationId":"UpdatePollPartial","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePollPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Partial update poll","tags":["product:chat"]}},"/polls/{poll_id}/options":{"post":{"description":"Creates a poll option\n\nSends events:\n- feeds.poll.updated\n- poll.updated\n","operationId":"CreatePollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePollOptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollOptionResponse"}}},"description":"Successful 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":"Create poll option","tags":["product:chat"]},"put":{"description":"Updates a poll option\n\nSends events:\n- feeds.poll.updated\n- poll.updated\n","operationId":"UpdatePollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePollOptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollOptionResponse"}}},"description":"Successful 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":"Update poll option","tags":["product:chat"]}},"/polls/{poll_id}/options/{option_id}":{"delete":{"description":"Deletes a poll option\n\nSends events:\n- feeds.poll.updated\n- poll.updated\n","operationId":"DeletePollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"path","name":"option_id","required":true,"schema":{"description":"Option ID","maxLength":255,"title":"string","type":"string","x-stream-index":"003"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete poll option","tags":["product:chat"]},"get":{"description":"Retrieves a poll option\n","operationId":"GetPollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"path","name":"option_id","required":true,"schema":{"description":"Option ID","maxLength":255,"title":"string","type":"string","x-stream-index":"003"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollOptionResponse"}}},"description":"Successful 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":"Get poll option","tags":["product:chat"]}},"/polls/{poll_id}/votes":{"post":{"description":"Queries votes\n","operationId":"QueryPollVotes","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryPollVotesRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollVotesResponse"}}},"description":"Successful 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":"Query votes","tags":["product:chat"]}},"/push_preferences":{"post":{"description":"Update the push preferences for a user and or channel member. Set to all, mentions or none\n","operationId":"UpdatePushNotificationPreferences","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertPushPreferencesRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertPushPreferencesResponse"}}},"description":"Successful 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":"Push notification preferences","tags":["product:chat"]}},"/query_banned_users":{"get":{"description":"Find and filter channel scoped or global user bans\n","operationId":"QueryBannedUsers","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryBannedUsersPayload","description":"JSON object with query user bans payload","title":"Payload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryBannedUsersResponse"}}},"description":"Successful 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":"Query Banned Users","tags":["product:chat"]}},"/reminders/query":{"post":{"description":"Queries reminders\n","operationId":"QueryReminders","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryRemindersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryRemindersResponse"}}},"description":"Successful 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":"Query reminders","tags":["product:chat"]}},"/search":{"get":{"description":"Search messages across channels\n","operationId":"Search","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchPayload","description":"JSON object with search payload","title":"Payload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchResponse"}}},"description":"Successful 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":"Search messages","tags":["product:chat"]}},"/sync":{"post":{"description":"Returns all events happened since client disconnect in specified channels\n","operationId":"Sync","parameters":[{"in":"query","name":"with_inaccessible_cids","schema":{"description":"If set to true this will add 'inaccessible_cids' to response type","title":"With inaccessible CIDs","type":"boolean","x-stream-index":"003"}},{"in":"query","name":"watch","schema":{"description":"If set to true this will start watching requested and newly added channels that user has access to. If error occurred with this option enabled and it is not an input error - channels will still be watched.","title":"Watch synced channels","type":"boolean","x-stream-index":"004"}},{"in":"query","name":"connection_id","schema":{"type":"string","x-stream-index":"006.003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncRequest"}}},"description":"SyncRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncResponse"}}},"description":"SyncResponse"},"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":"Sync","tags":["product:chat"]}},"/threads":{"post":{"description":"Returns the list of threads for specific user\n","operationId":"QueryThreads","parameters":[{"in":"query","name":"connection_id","schema":{"type":"string","x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryThreadsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryThreadsResponse"}}},"description":"Successful 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":"Query Threads","tags":["product:chat"]}},"/threads/{message_id}":{"get":{"description":"Return a specific thread\n","operationId":"GetThread","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"watch","schema":{"description":"Start watching the channel this thread belongs to","title":"Watch","type":"boolean","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"connection_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"003"}},{"in":"query","name":"reply_limit","schema":{"description":"Limit the number of replies returned","format":"int32","minimum":0,"title":"Reply limit","type":"integer","writeOnly":true,"x-stream-index":"004"}},{"in":"query","name":"participant_limit","schema":{"description":"Limit the number of participants returned","format":"int32","maximum":100,"minimum":0,"title":"Participant limit","type":"integer","writeOnly":true,"x-stream-index":"005"}},{"in":"query","name":"member_limit","schema":{"description":"Limit the number of members returned per thread channel","format":"int32","maximum":100,"minimum":0,"title":"Member limit","type":"integer","writeOnly":true,"x-stream-index":"006"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetThreadResponse"}}},"description":"Successful 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":"Get Thread","tags":["product:chat"]},"patch":{"description":"Updates certain fields of the thread\n\nSends events:\n- thread.updated\n- thread.updated\n","operationId":"UpdateThreadPartial","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateThreadPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateThreadPartialResponse"}}},"description":"Successful 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":"Partially update thread","tags":["product:chat"]}},"/unread":{"get":{"description":"Fetch unread counts for a single user\n","operationId":"UnreadCounts","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WrappedUnreadCountsResponse"}}},"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":"Unread counts","tags":["product:chat"]}},"/uploads/file":{"delete":{"description":"Deletes previously uploaded file\n","operationId":"DeleteFileGlobal","parameters":[{"in":"query","name":"url","schema":{"description":"File URL to delete","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete file","tags":["product:chat"],"x-stream-sdk-name":"DeleteFile"},"post":{"description":"Uploads file\n","operationId":"UploadFileGlobal","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/FileUploadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileUploadResponse"}}},"description":"Successful 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":"Upload file","tags":["product:chat"],"x-stream-sdk-name":"UploadFile"}},"/uploads/image":{"delete":{"description":"Deletes previously uploaded image\n","operationId":"DeleteImageGlobal","parameters":[{"in":"query","name":"url","schema":{"description":"File URL to delete","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete image","tags":["product:chat"],"x-stream-sdk-name":"DeleteImage"},"post":{"description":"Uploads image\n","operationId":"UploadImageGlobal","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/ImageUploadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageUploadResponse"}}},"description":"Successful 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":"Upload image","tags":["product:chat"],"x-stream-sdk-name":"UploadImage"}},"/users":{"get":{"description":"Find and filter users\n","operationId":"QueryUsers","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryUsersPayload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryUsersResponse"}}},"description":"Successful 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":"Query users","tags":["product:chat"]},"patch":{"description":"Updates certain fields of the user\n\nSends events:\n- user.presence.changed\n- user.updated\n- user.presence.changed\n","operationId":"UpdateUsersPartial","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersResponse"}}},"description":"Successful 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":"Partially update user","tags":["product:chat"]},"post":{"description":"Update or create users in bulk\n\nSends events:\n- user.updated\n","operationId":"UpdateUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersResponse"}}},"description":"Successful 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":"Upsert users","tags":["product:chat"]}},"/users/block":{"get":{"description":"Get list of blocked Users\n","operationId":"GetBlockedUsers","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBlockedUsersResponse"}}},"description":"Successful 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":"Get list of blocked Users","tags":["product:chat"]},"post":{"description":"Block users\n","operationId":"BlockUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUsersResponse"}}},"description":"Successful 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":"Block user","tags":["product:chat"]}},"/users/live_locations":{"get":{"description":"Retrieves all active live locations for a user\n","operationId":"GetUserLiveLocations","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SharedLocationsResponse"}}},"description":"Successful 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":"Get user live locations","tags":["product:chat"]},"put":{"description":"Updates an existing live location with new coordinates or expiration time\n","operationId":"UpdateLiveLocation","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateLiveLocationRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SharedLocationResponse"}}},"description":"Successful 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":"Update live location","tags":["product:chat"]}},"/users/unblock":{"post":{"description":"Unblock users\n","operationId":"UnblockUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUsersResponse"}}},"description":"Successful 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":"Unblock user","tags":["product:chat"]}}},"security":[{"JWT":[],"api_key":[],"stream-auth-type":[]},{"api_key":[],"stream-auth-type":[]}],"servers":[{"description":"Stream API","url":"https://chat.stream-io-api.com"}]} \ No newline at end of file +{"components":{"schemas":{"AIIndicatorClearEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"ai_indicator.clear","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"AIIndicatorClearEvent","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"},"AIIndicatorStopEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"ai_indicator.stop","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"AIIndicatorStopEvent","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"},"AIIndicatorUpdateEvent":{"properties":{"ai_message":{"type":"string","x-stream-index":"005"},"ai_state":{"type":"string","x-stream-index":"004"},"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"message_id":{"type":"string","x-stream-index":"003"},"type":{"default":"ai_indicator.update","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","cid","channel_id","channel_type","message_id","ai_state"],"title":"AIIndicatorUpdateEvent","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"},"APIError":{"nullable":true,"properties":{"StatusCode":{"description":"Response HTTP status code","format":"int32","title":"Status code","type":"integer","x-stream-index":"004"},"code":{"description":"API error code","format":"int32","title":"Code","type":"integer","x-stream-index":"001"},"details":{"description":"Additional error-specific information","items":{"type":"integer"},"title":"Details","type":"array","x-stream-index":"007"},"duration":{"description":"Request duration","title":"Duration","type":"string","x-stream-index":"005"},"exception_fields":{"additionalProperties":{"type":"string"},"description":"Additional error info","title":"Exception fields","type":"object","x-stream-index":"003"},"message":{"description":"Message describing an error","title":"Message","type":"string","x-stream-index":"002"},"more_info":{"description":"URL with additional information","title":"More info","type":"string","x-stream-index":"006"},"unrecoverable":{"description":"Flag that indicates if the error is unrecoverable, requests that return unrecoverable errors should not be retried, this error only applies to the request that caused it","title":"Unrecoverable","type":"boolean","x-stream-index":"008"}},"required":["code","message","StatusCode","duration","more_info","details"],"title":"Error response","type":"object"},"Action":{"nullable":true,"properties":{"name":{"type":"string","x-stream-index":"001"},"style":{"type":"string","x-stream-index":"003"},"text":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"004"},"value":{"type":"string","x-stream-index":"005"}},"required":["name","text","type"],"type":"object"},"ActivityMarkedEvent":{"properties":{"all_read":{"type":"boolean","x-stream-index":"006"},"all_seen":{"type":"boolean","x-stream-index":"007"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"feed_id":{"type":"string","x-stream-index":"003"},"marked_read":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"marked_watched":{"items":{"type":"string"},"type":"array","x-stream-index":"005"},"type":{"default":"activity.marked","type":"string","x-stream-index":"001.001"},"user_id":{"type":"string","x-stream-index":"002"}},"required":["type","created_at","user_id","feed_id","all_read","all_seen"],"title":"ActivityMarkedEvent","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"},"AnyEvent":{"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"*","type":"string","x-stream-index":"001.001"}},"required":["type","created_at"],"title":"AnyEvent","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"},"AppEventResponse":{"properties":{"async_url_enrich_enabled":{"description":"boolean","title":"Async URL Enrichment Enabled","type":"boolean","x-stream-index":"002"},"auto_translation_enabled":{"description":"boolean","title":"Auto Translation Enabled","type":"boolean","x-stream-index":"003"},"file_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","description":"file upload config","title":"File Upload Config","x-stream-index":"004"},"image_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","description":"file upload config","title":"Image Upload Config","x-stream-index":"005"},"name":{"description":"string","title":"App name","type":"string","x-stream-index":"001"}},"required":["name","auto_translation_enabled"],"type":"object"},"AppResponseFields":{"properties":{"async_url_enrich_enabled":{"type":"boolean","x-stream-index":"017"},"auto_translation_enabled":{"type":"boolean","x-stream-index":"020"},"file_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","x-stream-index":"030"},"image_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","x-stream-index":"031"},"name":{"type":"string","x-stream-index":"001"}},"required":["name","organization","push_notifications","webhook_url","moderation_webhook_url","channel_configs","call_types","policies","suspended","suspended_explanation","disable_auth_checks","disable_permissions_checks","permission_version","user_search_disallowed_roles","multi_tenant_enabled","image_moderation_enabled","async_url_enrich_enabled","auto_translation_enabled","custom_action_handler_url","enforce_unique_usernames","sqs_url","sqs_key","sqs_secret","sns_topic_arn","sns_key","sns_secret","file_upload_config","image_upload_config","grants","campaign_enabled","webhook_events","reminders_interval","cdn_expiration_seconds","video_provider","moderation_enabled","moderation_multitenant_blocklist_enabled","guest_user_creation_disabled","event_hooks","use_hook_v2","user_response_time_enabled","moderation_bulk_submit_action_enabled","moderation_llm_configurability_enabled"],"type":"object"},"AppUpdatedEvent":{"description":"Emitted when app settings are updated","nullable":true,"properties":{"app":{"$ref":"#/components/schemas/AppEventResponse","description":"application configuration","title":"App settings","x-stream-index":"002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"received_at":{"format":"date-time","type":"string","x-stream-index":"001.004"},"type":{"default":"app.updated","description":"The type of event: \"app.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.002"}},"required":["type","created_at","custom","app"],"title":"AppUpdatedEvent","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"},"Attachment":{"description":"An attachment is a message object that represents a file uploaded by a user.","nullable":true,"properties":{"actions":{"items":{"$ref":"#/components/schemas/Action"},"type":"array","x-stream-index":"015"},"asset_url":{"type":"string","x-stream-index":"017"},"author_icon":{"type":"string","x-stream-index":"007"},"author_link":{"type":"string","x-stream-index":"006"},"author_name":{"type":"string","x-stream-index":"005"},"color":{"type":"string","x-stream-index":"003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"018"},"fallback":{"type":"string","x-stream-index":"002"},"fields":{"items":{"$ref":"#/components/schemas/Field"},"type":"array","x-stream-index":"016"},"footer":{"type":"string","x-stream-index":"013"},"footer_icon":{"type":"string","x-stream-index":"014"},"giphy":{"$ref":"#/components/schemas/Images","x-stream-index":"019"},"image_url":{"type":"string","x-stream-index":"011"},"og_scrape_url":{"type":"string","x-stream-index":"020"},"original_height":{"format":"int32","type":"integer","x-stream-index":"022"},"original_width":{"format":"int32","type":"integer","x-stream-index":"021"},"pretext":{"type":"string","x-stream-index":"004"},"text":{"type":"string","x-stream-index":"010"},"thumb_url":{"type":"string","x-stream-index":"012"},"title":{"type":"string","x-stream-index":"008"},"title_link":{"type":"string","x-stream-index":"009"},"type":{"description":"Attachment type (e.g. image, video, url)","title":"Type","type":"string","x-stream-index":"001"}},"required":["custom"],"title":"Attachment","type":"object","x-stream-docs-page-id":"file_uploads"},"AutomodDetails":{"properties":{"action":{"type":"string","x-stream-index":"001"},"image_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"005"},"message_details":{"$ref":"#/components/schemas/FlagMessageDetails","x-stream-index":"004"},"original_message_type":{"type":"string","x-stream-index":"002"},"result":{"$ref":"#/components/schemas/MessageModerationResult","x-stream-index":"003"}},"type":"object"},"BanRequest":{"nullable":true,"properties":{"banned_by":{"$ref":"#/components/schemas/UserRequest","description":"User who issued a ban","title":"Banned by","x-stream-index":"010"},"banned_by_id":{"description":"User ID who issued a ban","title":"Banned by ID","type":"string","x-stream-index":"009"},"channel_cid":{"description":"Channel CID to ban user in eg. messaging:123","title":"Channel CID","type":"string","x-stream-index":"006"},"delete_messages":{"enum":["soft","pruning","hard"],"type":"string","x-stream-index":"011"},"ip_ban":{"description":"Whether to perform IP ban or not","title":"IP ban","type":"boolean","x-stream-index":"008"},"reason":{"description":"Ban reason","title":"Reason","type":"string","x-stream-index":"003"},"shadow":{"description":"Whether to perform shadow ban or not","title":"Shadow","type":"boolean","x-stream-index":"007"},"target_user_id":{"description":"ID of user to ban","title":"Target user ID","type":"string","x-stream-index":"001"},"timeout":{"description":"Timeout of ban in minutes. User will be unbanned after this period of time","title":"Timeout","type":"integer","x-stream-index":"002"}},"required":["target_user_id"],"type":"object"},"BanResponse":{"nullable":true,"properties":{"banned_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"006"},"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"007"},"expires":{"format":"date-time","type":"string","x-stream-index":"003"},"reason":{"type":"string","x-stream-index":"004"},"shadow":{"type":"boolean","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"}},"required":["created_at"],"type":"object"},"BlockListOptions":{"properties":{"behavior":{"description":"Blocklist behavior","enum":["flag","block","shadow_block"],"title":"Behavior","type":"string","x-stream-index":"002"},"blocklist":{"description":"Blocklist name","title":"Blocklist","type":"string","x-stream-index":"001"}},"required":["blocklist","behavior"],"type":"object"},"BlockListResponse":{"description":"Block list contains restricted words","properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001"},"id":{"type":"string","x-stream-index":"003"},"name":{"description":"Block list name","title":"Name","type":"string","x-stream-index":"004"},"team":{"type":"string","x-stream-index":"007"},"type":{"description":"Block list type.","title":"Type","type":"string","x-stream-index":"005"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"002"},"words":{"description":"List of words to block","items":{"type":"string"},"title":"Words","type":"array","x-stream-index":"006"}},"required":["name","type","words"],"title":"Block list","type":"object","x-stream-docs-page-id":"block_lists"},"BlockUsersRequest":{"nullable":true,"properties":{"blocked_user_id":{"description":"User id to block","title":"BlockedUserID","type":"string","x-stream-index":"001"}},"required":["blocked_user_id"],"type":"object"},"BlockUsersResponse":{"nullable":true,"properties":{"blocked_by_user_id":{"description":"User id who blocked another user","title":"BlockedByUserID","type":"string","x-stream-index":"002"},"blocked_user_id":{"description":"User id who got blocked","title":"BlockedUserID","type":"string","x-stream-index":"003"},"created_at":{"description":"Timestamp when the user was blocked","format":"date-time","title":"CreatedAt","type":"string","x-stream-index":"004"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration","blocked_by_user_id","blocked_user_id","created_at"],"type":"object"},"BlockedUserResponse":{"nullable":true,"properties":{"blocked_user":{"$ref":"#/components/schemas/UserResponse","description":"User who got blocked","title":"User","x-stream-index":"003"},"blocked_user_id":{"description":"ID of the user who got blocked","title":"UserID","type":"string","x-stream-index":"004"},"created_at":{"format":"date-time","type":"string","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who blocked another user","title":"User","x-stream-index":"001"},"user_id":{"description":"ID of the user who blocked another user","title":"UserID","type":"string","x-stream-index":"002"}},"required":["user","user_id","blocked_user","blocked_user_id","created_at"],"type":"object"},"CastPollVoteRequest":{"nullable":true,"properties":{"vote":{"$ref":"#/components/schemas/VoteData","description":"Vote data","title":"VoteData","x-stream-index":"004"}},"type":"object"},"Channel":{"properties":{"active_live_locations":{"items":{"$ref":"#/components/schemas/SharedLocation"},"type":"array","x-stream-index":"034"},"auto_translation_enabled":{"type":"boolean","x-stream-index":"029"},"auto_translation_language":{"type":"string","x-stream-index":"030"},"cid":{"type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/ChannelConfig","x-stream-index":"026"},"config_overrides":{"$ref":"#/components/schemas/ConfigOverrides","x-stream-index":"027"},"cooldown":{"format":"int32","type":"integer","x-stream-index":"031"},"created_at":{"format":"date-time","type":"string","x-stream-index":"009"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"019"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"011"},"disabled":{"type":"boolean","x-stream-index":"017"},"frozen":{"type":"boolean","x-stream-index":"016"},"id":{"type":"string","x-stream-index":"004"},"invites":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"022"},"last_campaigns":{"type":"string","x-stream-index":"032"},"last_message_at":{"format":"date-time","type":"string","x-stream-index":"006"},"member_count":{"format":"int32","type":"integer","x-stream-index":"021"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"020"},"message_count":{"format":"int64","type":"integer","x-stream-index":"035"},"message_count_updated_at":{"format":"date-time","type":"string","x-stream-index":"036"},"team":{"type":"string","x-stream-index":"028"},"truncated_by":{"$ref":"#/components/schemas/User","x-stream-index":"015"},"type":{"type":"string","x-stream-index":"005"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"010"}},"required":["cid","id","type","created_at","updated_at","frozen","disabled","custom","auto_translation_language"],"type":"object"},"ChannelConfig":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.027"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.022"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.023"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.028"},"blocklist":{"type":"string","x-stream-index":"001.024"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.025"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.026"},"commands":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"connect_events":{"type":"boolean","x-stream-index":"001.004"},"count_messages":{"type":"boolean","x-stream-index":"001.019"},"created_at":{"format":"date-time","type":"string","x-stream-index":"002.003"},"custom_events":{"type":"boolean","x-stream-index":"001.012"},"mark_messages_pending":{"type":"boolean","x-stream-index":"001.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"001.021"},"mutes":{"type":"boolean","x-stream-index":"001.009"},"name":{"type":"string","x-stream-index":"001.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"001.029"},"partition_ttl":{"type":"integer","x-stream-index":"001.030"},"polls":{"type":"boolean","x-stream-index":"001.016"},"push_notifications":{"type":"boolean","x-stream-index":"001.013"},"quotes":{"type":"boolean","x-stream-index":"001.008"},"reactions":{"type":"boolean","x-stream-index":"001.006"},"read_events":{"type":"boolean","x-stream-index":"001.003"},"reminders":{"type":"boolean","x-stream-index":"001.014"},"replies":{"type":"boolean","x-stream-index":"001.007"},"search":{"type":"boolean","x-stream-index":"001.005"},"shared_locations":{"type":"boolean","x-stream-index":"001.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.031"},"typing_events":{"type":"boolean","x-stream-index":"001.002"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"002.004"},"uploads":{"type":"boolean","x-stream-index":"001.010"},"url_enrichment":{"type":"boolean","x-stream-index":"001.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"001.017"}},"required":["name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","count_messages","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","created_at","updated_at","commands"],"type":"object"},"ChannelConfigWithInfo":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.002.027"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.002.022"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.023"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.002.028"},"blocklist":{"type":"string","x-stream-index":"001.002.024"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.025"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.002.026"},"commands":{"items":{"$ref":"#/components/schemas/Command"},"type":"array","x-stream-index":"001.003"},"connect_events":{"type":"boolean","x-stream-index":"001.002.004"},"count_messages":{"type":"boolean","x-stream-index":"001.002.019"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.001.003"},"custom_events":{"type":"boolean","x-stream-index":"001.002.012"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"002"},"mark_messages_pending":{"type":"boolean","x-stream-index":"001.002.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"001.002.021"},"mutes":{"type":"boolean","x-stream-index":"001.002.009"},"name":{"type":"string","x-stream-index":"001.002.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"001.002.029"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"001.002.030"},"polls":{"type":"boolean","x-stream-index":"001.002.016"},"push_notifications":{"type":"boolean","x-stream-index":"001.002.013"},"quotes":{"type":"boolean","x-stream-index":"001.002.008"},"reactions":{"type":"boolean","x-stream-index":"001.002.006"},"read_events":{"type":"boolean","x-stream-index":"001.002.003"},"reminders":{"type":"boolean","x-stream-index":"001.002.014"},"replies":{"type":"boolean","x-stream-index":"001.002.007"},"search":{"type":"boolean","x-stream-index":"001.002.005"},"shared_locations":{"type":"boolean","x-stream-index":"001.002.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.002.031"},"typing_events":{"type":"boolean","x-stream-index":"001.002.002"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"001.001.004"},"uploads":{"type":"boolean","x-stream-index":"001.002.010"},"url_enrichment":{"type":"boolean","x-stream-index":"001.002.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"001.002.017"}},"required":["created_at","updated_at","name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","count_messages","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","commands"],"type":"object"},"ChannelCreatedEvent":{"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"channel.created","type":"string","x-stream-index":"001.001"}},"required":["type","created_at"],"title":"ChannelCreatedEvent","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"},"ChannelDeletedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003.004"},"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"003.005"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"002.002"},"team":{"type":"string","x-stream-index":"001.001"},"type":{"default":"channel.deleted","type":"string","x-stream-index":"002.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"ChannelDeletedEvent","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"},"ChannelFrozenEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"channel.frozen","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"ChannelFrozenEvent","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"},"ChannelGetOrCreateRequest":{"nullable":true,"properties":{"data":{"$ref":"#/components/schemas/ChannelInput","x-stream-index":"003"},"hide_for_creator":{"description":"Whether this channel will be hidden for the user who created the channel or not","title":"Hide for creator","type":"boolean","x-stream-index":"007"},"members":{"$ref":"#/components/schemas/PaginationParams","x-stream-index":"010"},"messages":{"$ref":"#/components/schemas/MessagePaginationParams","x-stream-index":"009"},"presence":{"description":"Fetch user presence info","title":"Presence","type":"boolean","x-stream-index":"006"},"state":{"description":"Refresh channel state","title":"State","type":"boolean","x-stream-index":"005"},"thread_unread_counts":{"type":"boolean","x-stream-index":"008"},"watch":{"description":"Start watching the channel","title":"Watch","type":"boolean","x-stream-index":"004"},"watchers":{"$ref":"#/components/schemas/PaginationParams","x-stream-index":"011"}},"type":"object"},"ChannelHiddenEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003.004"},"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"003.005"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"clear_history":{"type":"boolean","x-stream-index":"001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"004.002"},"type":{"default":"channel.hidden","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["clear_history","cid","channel_id","channel_type","channel_member_count","type","created_at"],"title":"ChannelHiddenEvent","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"},"ChannelInput":{"properties":{"auto_translation_enabled":{"description":"Enable or disable auto translation","title":"Auto translation","type":"boolean","x-stream-index":"005"},"auto_translation_language":{"description":"Switch auto translation language","title":"Auto translation language","type":"string","x-stream-index":"006"},"config_overrides":{"$ref":"#/components/schemas/ChannelConfig","x-stream-index":"024"},"created_by":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"009"},"created_by_id":{"type":"string","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"015"},"disabled":{"type":"boolean","x-stream-index":"014"},"frozen":{"description":"Freeze or unfreeze the channel","title":"Frozen","type":"boolean","x-stream-index":"013"},"invites":{"items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"type":"array","x-stream-index":"016"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"type":"array","x-stream-index":"018"},"team":{"description":"Team the channel belongs to (if multi-tenant mode is enabled)","title":"Team","type":"string","x-stream-index":"004"},"truncated_by_id":{"type":"string","x-stream-index":"010"}},"type":"object"},"ChannelKickedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002.004"},"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"002.005"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"channel.kicked","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"ChannelKickedEvent","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"},"ChannelMember":{"nullable":true,"properties":{"archived_at":{"format":"date-time","type":"string","x-stream-index":"015"},"ban_expires":{"description":"Expiration date of the ban","format":"date-time","title":"Ban expires","type":"string","x-stream-index":"013"},"banned":{"description":"Whether member is banned this channel or not","title":"Banned","type":"boolean","x-stream-index":"012"},"channel_role":{"description":"Role of the member in the channel","title":"Channel Role","type":"string","x-stream-index":"018"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"011"},"deleted_messages":{"items":{"type":"string"},"type":"array","x-stream-index":"020"},"invite_accepted_at":{"description":"Date when invite was accepted","format":"date-time","title":"Invited accepted at","type":"string","x-stream-index":"006"},"invite_rejected_at":{"description":"Date when invite was rejected","format":"date-time","title":"Invited rejected at","type":"string","x-stream-index":"007"},"invited":{"description":"Whether member was invited or not","title":"Invited","type":"boolean","x-stream-index":"005"},"is_moderator":{"description":"Whether member is channel moderator or not","title":"Is moderator","type":"boolean","x-stream-index":"003"},"notifications_muted":{"type":"boolean","x-stream-index":"019"},"pinned_at":{"format":"date-time","type":"string","x-stream-index":"016"},"role":{"description":"Permission level of the member in the channel (DEPRECATED: use channel_role instead)","enum":["member","moderator","admin","owner"],"title":"Role","type":"string","x-stream-index":"017"},"shadow_banned":{"description":"Whether member is shadow banned in this channel or not","title":"Shadow banned","type":"boolean","x-stream-index":"014"},"status":{"type":"string","x-stream-index":"008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"},"user_id":{"title":"User ID","type":"string","x-stream-index":"001"}},"required":["custom","created_at","updated_at","banned","shadow_banned","channel_role","notifications_muted"],"title":"Channel member","type":"object"},"ChannelMemberResponse":{"nullable":true,"properties":{"archived_at":{"format":"date-time","type":"string","x-stream-index":"016"},"ban_expires":{"description":"Expiration date of the ban","format":"date-time","title":"Ban expires","type":"string","x-stream-index":"013"},"banned":{"description":"Whether member is banned this channel or not","title":"Banned","type":"boolean","x-stream-index":"012"},"channel_role":{"description":"Role of the member in the channel","title":"Channel Role","type":"string","x-stream-index":"018"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"011"},"invite_accepted_at":{"description":"Date when invite was accepted","format":"date-time","title":"Invited accepted at","type":"string","x-stream-index":"006"},"invite_rejected_at":{"description":"Date when invite was rejected","format":"date-time","title":"Invited rejected at","type":"string","x-stream-index":"007"},"invited":{"description":"Whether member was invited or not","title":"Invited","type":"boolean","x-stream-index":"005"},"is_moderator":{"description":"Whether member is channel moderator or not","title":"Is moderator","type":"boolean","x-stream-index":"003"},"notifications_muted":{"type":"boolean","x-stream-index":"019"},"pinned_at":{"format":"date-time","type":"string","x-stream-index":"015"},"role":{"description":"Permission level of the member in the channel (DEPRECATED: use channel_role instead)","enum":["member","moderator","admin","owner"],"title":"Role","type":"string","x-stream-index":"017"},"shadow_banned":{"description":"Whether member is shadow banned in this channel or not","title":"Shadow banned","type":"boolean","x-stream-index":"014"},"status":{"type":"string","x-stream-index":"008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"},"user_id":{"title":"User ID","type":"string","x-stream-index":"001"}},"required":["custom","created_at","updated_at","banned","shadow_banned","channel_role","notifications_muted"],"title":"Channel member","type":"object"},"ChannelMute":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel that is muted","title":"Channel","x-stream-index":"002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"004"},"expires":{"description":"Date/time of mute expiration","format":"date-time","title":"Expires","type":"string","x-stream-index":"003"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Owner of channel mute","title":"User","x-stream-index":"001"}},"required":["created_at","updated_at"],"type":"object"},"ChannelOwnCapability":{"description":"All possibility of string to use","enum":["ban-channel-members","cast-poll-vote","connect-events","create-attachment","delete-any-message","delete-channel","delete-own-message","flag-message","freeze-channel","join-channel","leave-channel","mute-channel","pin-message","query-poll-votes","quote-message","read-events","search-messages","send-custom-events","send-links","send-message","send-poll","send-reaction","send-reply","send-restricted-visibility-message","send-typing-events","set-channel-cooldown","share-location","skip-slow-mode","slow-mode","typing-events","update-any-message","update-channel","update-channel-members","update-own-message","update-thread","upload-file"],"title":"ChannelOwnCapability","type":"string"},"ChannelPushPreferences":{"properties":{"chat_level":{"type":"string","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"string","x-stream-index":"002"}},"type":"object"},"ChannelResponse":{"description":"Represents channel in chat","properties":{"auto_translation_enabled":{"description":"Whether auto translation is enabled or not","title":"Auto translation","type":"boolean","x-stream-index":"017"},"auto_translation_language":{"description":"Language to translate to when auto translation is active","title":"Auto translation language","type":"string","x-stream-index":"018"},"blocked":{"description":"Whether this channel is blocked by current user or not","title":"Blocked","type":"boolean","x-stream-index":"023"},"cid":{"description":"Channel CID (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/ChannelConfigWithInfo","description":"Channel configuration","title":"ChannelConfigWithInfo","x-stream-index":"013"},"cooldown":{"description":"Cooldown period after sending each message","format":"int32","title":"Cooldown","type":"integer","x-stream-index":"020"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"005"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"Creator of the channel","title":"UserResponse","x-stream-index":"008"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"026"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"string","x-stream-index":"007"},"disabled":{"type":"boolean","x-stream-index":"010"},"frozen":{"description":"Whether channel is frozen or not","title":"Frozen","type":"boolean","x-stream-index":"009"},"hidden":{"description":"Whether this channel is hidden by current user or not","title":"Hidden","type":"boolean","x-stream-index":"022"},"hide_messages_before":{"description":"Date since when the message history is accessible","format":"date-time","title":"Hide messages before","type":"string","x-stream-index":"019"},"id":{"description":"Channel unique ID","title":"ID","type":"string","x-stream-index":"001"},"last_message_at":{"description":"Date of the last message sent","format":"date-time","title":"Last message at","type":"string","x-stream-index":"004"},"member_count":{"description":"Number of members in the channel","format":"int32","title":"Member count","type":"integer","x-stream-index":"012"},"members":{"description":"List of channel members (max 100)","items":{"$ref":"#/components/schemas/ChannelMember"},"title":"ChannelMembers","type":"array","x-stream-index":"011"},"message_count":{"description":"Number of messages in the channel","format":"int64","title":"Message count","type":"integer","x-stream-index":"027"},"mute_expires_at":{"description":"Date of mute expiration","format":"date-time","title":"Mute expires at","type":"string","x-stream-index":"015"},"muted":{"description":"Whether this channel is muted or not","title":"Muted","type":"boolean","x-stream-index":"014"},"own_capabilities":{"description":"List of channel capabilities of authenticated user","items":{"$ref":"#/components/schemas/ChannelOwnCapability"},"title":"ChannelOwnCapability","type":"array","x-stream-index":"021"},"team":{"description":"Team the channel belongs to (multi-tenant only)","title":"Team","type":"string","x-stream-index":"016"},"truncated_at":{"description":"Date of the latest truncation of the channel","format":"date-time","title":"UserResponse","type":"string","x-stream-index":"024"},"truncated_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"025"},"type":{"description":"Type of the channel","title":"Type","type":"string","x-stream-docs-page-id":"channel_features","x-stream-index":"002"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"006"}},"required":["id","type","cid","created_at","updated_at","frozen","disabled","custom"],"title":"Channel","type":"object"},"ChannelStateResponse":{"nullable":true,"properties":{"active_live_locations":{"items":{"$ref":"#/components/schemas/SharedLocationResponseData"},"type":"array","x-stream-index":"001.015"},"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001.001"},"deleted_messages":{"items":{"type":"string"},"type":"array","x-stream-index":"001.016"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001.014"},"duration":{"type":"string","x-stream-index":"002.001"},"hidden":{"type":"boolean","x-stream-index":"001.011"},"hide_messages_before":{"format":"date-time","type":"string","x-stream-index":"001.012"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"001.007"},"membership":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"001.008"},"messages":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","x-stream-index":"001.002"},"pending_messages":{"items":{"$ref":"#/components/schemas/PendingMessageResponse"},"type":"array","x-stream-index":"001.013"},"pinned_messages":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","x-stream-index":"001.003"},"push_preferences":{"$ref":"#/components/schemas/ChannelPushPreferences","x-stream-index":"001.009"},"read":{"items":{"$ref":"#/components/schemas/ReadStateResponse"},"type":"array","x-stream-index":"001.006"},"threads":{"items":{"$ref":"#/components/schemas/ThreadStateResponse"},"type":"array","x-stream-index":"001.010"},"watcher_count":{"format":"int32","type":"integer","x-stream-index":"001.004"},"watchers":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"001.005"}},"required":["messages","pinned_messages","members","threads","duration"],"type":"object"},"ChannelStateResponseFields":{"properties":{"active_live_locations":{"description":"Active live locations in the channel","items":{"$ref":"#/components/schemas/SharedLocationResponseData"},"title":"Active Live Locations","type":"array","x-stream-index":"015"},"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001"},"deleted_messages":{"items":{"type":"string"},"type":"array","x-stream-index":"016"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"014"},"hidden":{"description":"Whether this channel is hidden or not","title":"Hidden","type":"boolean","x-stream-index":"011"},"hide_messages_before":{"description":"Messages before this date are hidden from the user","format":"date-time","title":"Hide messages before","type":"string","x-stream-index":"012"},"members":{"description":"List of channel members","items":{"$ref":"#/components/schemas/ChannelMember"},"title":"Members","type":"array","x-stream-index":"007"},"membership":{"$ref":"#/components/schemas/ChannelMember","description":"Current user membership object","title":"Membership","x-stream-index":"008"},"messages":{"description":"List of channel messages","items":{"$ref":"#/components/schemas/MessageResponse"},"title":"Message","type":"array","x-stream-index":"002"},"pending_messages":{"description":"Pending messages that this user has sent","items":{"$ref":"#/components/schemas/PendingMessageResponse"},"title":"Pending messages","type":"array","x-stream-index":"013"},"pinned_messages":{"description":"List of pinned messages in the channel","items":{"$ref":"#/components/schemas/MessageResponse"},"title":"Pinned messages","type":"array","x-stream-docs-page-id":"pinned_messages","x-stream-index":"003"},"push_preferences":{"$ref":"#/components/schemas/ChannelPushPreferences","x-stream-index":"009"},"read":{"description":"List of read states","items":{"$ref":"#/components/schemas/ReadStateResponse"},"title":"Read","type":"array","x-stream-index":"006"},"threads":{"items":{"$ref":"#/components/schemas/ThreadStateResponse"},"type":"array","x-stream-index":"010"},"watcher_count":{"description":"Number of channel watchers","format":"int32","title":"Watcher count","type":"integer","x-stream-index":"004"},"watchers":{"description":"List of user who is watching the channel","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Watchers","type":"array","x-stream-index":"005"}},"required":["messages","pinned_messages","members","threads"],"type":"object"},"ChannelStopWatchingRequest":{"nullable":true,"type":"object"},"ChannelTruncatedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001.004"},"channel_id":{"type":"string","x-stream-index":"001.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"001.005"},"channel_type":{"type":"string","x-stream-index":"001.003"},"cid":{"type":"string","x-stream-index":"001.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"002.002"},"type":{"default":"channel.truncated","type":"string","x-stream-index":"002.001"}},"required":["cid","channel_id","channel_type","channel_member_count","type","created_at"],"title":"ChannelTruncatedEvent","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"},"ChannelUnFrozenEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"channel.unfrozen","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"ChannelUnFrozenEvent","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"},"ChannelUpdatedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"004.004"},"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"004.005"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"003.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"002.001"},"type":{"default":"channel.updated","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"ChannelUpdatedEvent","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"},"ChannelVisibleEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"001.002"},"channel_type":{"type":"string","x-stream-index":"001.003"},"cid":{"type":"string","x-stream-index":"001.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"003.002"},"type":{"default":"channel.visible","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"ChannelVisibleEvent","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"},"Command":{"description":"Represents custom chat command","nullable":true,"properties":{"args":{"description":"Arguments help text, shown in commands auto-completion","title":"Arguments","type":"string","x-stream-index":"006"},"created_at":{"description":"Date/time of creation","format":"date-time","readOnly":true,"title":"Created at","type":"string","x-stream-index":"001"},"description":{"description":"Description, shown in commands auto-completion","title":"Description","type":"string","x-stream-index":"005"},"name":{"description":"Unique command name","title":"Name","type":"string","x-stream-index":"004"},"set":{"description":"Set name used for grouping commands","title":"Set","type":"string","x-stream-index":"007"},"updated_at":{"description":"Date/time of the last update","format":"date-time","readOnly":true,"title":"Updated at","type":"string","x-stream-index":"002"}},"required":["name","description","args","set"],"title":"Command","type":"object"},"ConfigOverrides":{"properties":{"blocklist":{"type":"string","x-stream-index":"008"},"blocklist_behavior":{"enum":["flag","block"],"type":"string","x-stream-index":"009"},"commands":{"items":{"type":"string"},"type":"array","x-stream-index":"011"},"count_messages":{"type":"boolean","x-stream-index":"014"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"010"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"007"},"quotes":{"type":"boolean","x-stream-index":"004"},"reactions":{"type":"boolean","x-stream-index":"002"},"replies":{"type":"boolean","x-stream-index":"003"},"shared_locations":{"type":"boolean","x-stream-index":"013"},"typing_events":{"type":"boolean","x-stream-index":"001"},"uploads":{"type":"boolean","x-stream-index":"005"},"url_enrichment":{"type":"boolean","x-stream-index":"006"},"user_message_reminders":{"type":"boolean","x-stream-index":"012"}},"required":["grants","commands"],"type":"object"},"ConnectRequest":{"properties":{"device":{"$ref":"#/components/schemas/DeviceFields","x-stream-index":"001.002"},"user_details":{"$ref":"#/components/schemas/User","x-stream-index":"001.001"}},"required":["user_details"],"type":"object"},"CreateBlockListRequest":{"description":"Block list contains restricted words","nullable":true,"properties":{"name":{"description":"Block list name","maxLength":255,"title":"Name","type":"string","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"004"},"type":{"description":"Block list type.","enum":["regex","domain","domain_allowlist","email","word"],"title":"Type","type":"string","x-stream-index":"003"},"words":{"description":"List of words to block","items":{"type":"string"},"minimum":1,"title":"Words","type":"array","x-stream-index":"002"}},"required":["name","words"],"title":"Block list","type":"object","x-stream-docs-page-id":"block_lists"},"CreateBlockListResponse":{"description":"Basic response information","nullable":true,"properties":{"blocklist":{"$ref":"#/components/schemas/BlockListResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["duration"],"title":"Response","type":"object"},"CreateDeviceRequest":{"description":"Create device request","nullable":true,"properties":{"id":{"description":"Device ID","maxLength":255,"minLength":1,"title":"ID","type":"string","x-stream-index":"001"},"push_provider":{"description":"Push provider","enum":["firebase","apn","huawei","xiaomi"],"title":"PushProvider","type":"string","x-stream-index":"002"},"push_provider_name":{"description":"Push provider name","title":"PushProviderName","type":"string","x-stream-index":"003"},"voip_token":{"description":"When true the token is for Apple VoIP push notifications","title":"VoipToken","type":"boolean","x-stream-index":"004"}},"required":["id","push_provider"],"title":"CreateDeviceRequest","type":"object"},"CreateDraftRequest":{"nullable":true,"properties":{"message":{"$ref":"#/components/schemas/MessageRequest","x-stream-index":"001"}},"required":["message"],"type":"object"},"CreateDraftResponse":{"description":"Basic response information","nullable":true,"properties":{"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["draft","duration"],"title":"Response","type":"object"},"CreateGuestRequest":{"nullable":true,"properties":{"user":{"$ref":"#/components/schemas/UserRequest","description":"User object which server acts upon","title":"User","x-stream-index":"001"}},"required":["user"],"type":"object"},"CreateGuestResponse":{"nullable":true,"properties":{"access_token":{"description":"the access token to authenticate the user","title":"Access token","type":"string","x-stream-index":"002"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User object which server acts upon","title":"User","x-stream-index":"001"}},"required":["user","access_token","duration"],"type":"object"},"CreatePollOptionRequest":{"nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"003"},"text":{"description":"Option text","title":"string","type":"string","x-stream-index":"002"}},"required":["text"],"type":"object"},"CreatePollRequest":{"description":"Contains all information needed to create a new poll","nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"011"},"allow_answers":{"description":"Indicates whether users can suggest user defined answers","title":"Allow answers","type":"boolean","x-stream-index":"009"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"008"},"description":{"description":"A description of the poll","title":"Description","type":"string","x-stream-index":"003"},"enforce_unique_vote":{"description":"Indicates whether users can cast multiple votes","title":"Multiple choice","type":"boolean","x-stream-index":"006"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"is_closed":{"description":"Indicates whether the poll is open for voting","title":"Is closed","type":"boolean","x-stream-index":"010"},"max_votes_allowed":{"description":"Indicates the maximum amount of votes a user can cast","format":"int32","maximum":10,"title":"Maximum votes allowed","type":"integer","x-stream-index":"007"},"name":{"description":"The name of the poll","title":"Name","type":"string","x-stream-index":"002"},"options":{"items":{"$ref":"#/components/schemas/PollOptionInput"},"maximum":100,"type":"array","x-stream-index":"004"},"voting_visibility":{"enum":["anonymous","public"],"type":"string","x-stream-index":"005"}},"required":["name"],"title":"Create Poll Request","type":"object"},"CreateReminderRequest":{"nullable":true,"properties":{"remind_at":{"format":"date-time","type":"string","x-stream-index":"001"}},"type":"object"},"DeleteChannelResponse":{"description":"Basic response information","nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"Response","type":"object"},"DeleteChannelsRequest":{"nullable":true,"properties":{"cids":{"description":"All channels that should be deleted","items":{"type":"string"},"maximum":100,"minimum":1,"title":"Channels CID","type":"array","x-stream-index":"001"},"hard_delete":{"description":"Specify if channels and all ressources should be hard deleted","title":"Hard delete","type":"boolean","x-stream-index":"002"}},"required":["cids"],"type":"object"},"DeleteChannelsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"result":{"additionalProperties":{"$ref":"#/components/schemas/DeleteChannelsResultResponse"},"description":"Map of channel IDs and their deletion results","title":"Result","type":"object","x-stream-index":"001"},"task_id":{"type":"string","x-stream-index":"002"}},"required":["duration"],"type":"object"},"DeleteChannelsResultResponse":{"nullable":true,"properties":{"error":{"type":"string","x-stream-index":"002"},"status":{"type":"string","x-stream-index":"001"}},"required":["status"],"type":"object"},"DeleteMessageResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001"}},"required":["message","duration"],"title":"Response","type":"object"},"DeleteReactionResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001"},"reaction":{"$ref":"#/components/schemas/ReactionResponse","x-stream-index":"002"}},"required":["message","reaction","duration"],"title":"Response","type":"object"},"DeleteReminderResponse":{"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"},"Device":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"002.002"},"disabled":{"type":"boolean","x-stream-index":"002.003"},"disabled_reason":{"type":"string","x-stream-index":"002.004"},"id":{"type":"string","x-stream-index":"002.001.004"},"push_provider":{"enum":["firebase","apn","huawei","xiaomi"],"type":"string","x-stream-index":"002.001.001"},"push_provider_name":{"type":"string","x-stream-index":"002.001.003"},"user_id":{"type":"string","x-stream-index":"004"},"voip":{"type":"boolean","x-stream-index":"002.001.005"}},"required":["push_provider","id","created_at","user_id"],"type":"object"},"DeviceFields":{"properties":{"id":{"type":"string","x-stream-index":"004"},"push_provider":{"enum":["firebase","apn","huawei","xiaomi"],"type":"string","x-stream-index":"001"},"push_provider_name":{"type":"string","x-stream-index":"003"},"voip":{"type":"boolean","x-stream-index":"005"}},"required":["push_provider","id"],"type":"object"},"DeviceResponse":{"description":"Response for Device","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"004"},"disabled":{"description":"Whether device is disabled or not","title":"Disabled","type":"boolean","x-stream-index":"005"},"disabled_reason":{"description":"Reason explaining why device had been disabled","title":"Reason","type":"string","x-stream-index":"006"},"id":{"description":"Device ID","title":"ID","type":"string","x-stream-index":"003"},"push_provider":{"description":"Push provider","title":"PushProvider","type":"string","x-stream-index":"001"},"push_provider_name":{"description":"Push provider name","title":"PushProviderName","type":"string","x-stream-index":"002"},"user_id":{"description":"User ID","title":"UserID","type":"string","x-stream-index":"008"},"voip":{"description":"When true the token is for Apple VoIP push notifications","title":"Voip","type":"boolean","x-stream-index":"007"}},"required":["push_provider","id","created_at","user_id"],"title":"DeviceResponse","type":"object"},"DraftDeletedEvent":{"description":"Emitted when a Draft is deleted.","nullable":true,"properties":{"cid":{"description":"The CID of the channel where the draft was created","title":"Channel CID","type":"string","x-stream-index":"001.001.002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.001.007"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001.003"},"parent_id":{"description":"The ID of the parent message","title":"Message ID","type":"string","x-stream-index":"001.002"},"received_at":{"format":"date-time","type":"string","x-stream-index":"001.001.001.004"},"type":{"default":"draft.deleted","description":"The type of event: \"draft.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.001.002"}},"required":["type","created_at","custom"],"title":"DraftDeletedEvent","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"},"DraftPayloadResponse":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"html":{"type":"string","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"001"},"mentioned_users":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"008"},"mml":{"type":"string","x-stream-index":"003"},"parent_id":{"type":"string","x-stream-index":"005"},"poll_id":{"type":"string","x-stream-index":"013"},"quoted_message_id":{"type":"string","x-stream-index":"009"},"show_in_channel":{"type":"boolean","x-stream-index":"006"},"silent":{"type":"boolean","x-stream-index":"012"},"text":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"011"}},"required":["id","text","custom"],"type":"object"},"DraftResponse":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003"},"channel_cid":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"string","x-stream-index":"007"},"message":{"$ref":"#/components/schemas/DraftPayloadResponse","x-stream-index":"001"},"parent_id":{"type":"string","x-stream-index":"004"},"parent_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"005"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"006"}},"required":["message","channel_cid","created_at"],"type":"object"},"DraftUpdatedEvent":{"description":"Emitted when a Draft is created or updated.","nullable":true,"properties":{"cid":{"description":"The CID of the channel where the draft was created/updated","title":"Channel CID","type":"string","x-stream-index":"001.001.002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.001.007"},"draft":{"$ref":"#/components/schemas/DraftResponse","description":"The draft object which was created/updated","title":"Draft","x-stream-index":"001.003"},"parent_id":{"description":"The ID of the parent message","title":"Parent ID","type":"string","x-stream-index":"001.002"},"received_at":{"format":"date-time","type":"string","x-stream-index":"001.001.001.004"},"type":{"default":"draft.updated","description":"The type of event: \"draft.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.001.002"}},"required":["type","created_at","custom"],"title":"DraftUpdatedEvent","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"},"EventRequest":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"parent_id":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"001"}},"required":["type"],"type":"object"},"EventResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"event":{"$ref":"#/components/schemas/WSEvent","x-stream-index":"001"}},"required":["event","duration"],"title":"Response","type":"object"},"FeedsEventPreferences":{"properties":{"comments":{"type":"string","x-stream-index":"002"},"mentions":{"type":"string","x-stream-index":"004"},"new_followers":{"type":"string","x-stream-index":"003"},"reactions":{"type":"string","x-stream-index":"001"}},"type":"object"},"FeedsEventPreferencesInput":{"properties":{"comments":{"enum":["all","none"],"type":"string","x-stream-index":"002"},"mentions":{"enum":["all","none"],"type":"string","x-stream-index":"004"},"new_followers":{"enum":["all","none"],"type":"string","x-stream-index":"003"},"reactions":{"enum":["all","none"],"type":"string","x-stream-index":"001"}},"type":"object"},"Field":{"nullable":true,"properties":{"short":{"type":"boolean","x-stream-index":"003"},"title":{"type":"string","x-stream-index":"001"},"value":{"type":"string","x-stream-index":"002"}},"required":["title","value","short"],"type":"object"},"FileUploadConfig":{"properties":{"allowed_file_extensions":{"items":{"type":"string"},"type":"array","x-stream-index":"001"},"allowed_mime_types":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"blocked_file_extensions":{"items":{"type":"string"},"type":"array","x-stream-index":"002"},"blocked_mime_types":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"size_limit":{"format":"int32","maximum":104857600,"minimum":0,"type":"integer","x-stream-index":"005"}},"required":["allowed_file_extensions","blocked_file_extensions","allowed_mime_types","blocked_mime_types","size_limit"],"type":"object"},"FileUploadRequest":{"nullable":true,"properties":{"file":{"description":"file field","title":"File","type":"string","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/OnlyUserID","description":"user for the request **server side only**","title":"User","x-stream-index":"003"}},"type":"object"},"FileUploadResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"file":{"description":"URL to the uploaded asset. Should be used to put to `asset_url` attachment field","title":"File","type":"string","x-stream-index":"001"},"thumb_url":{"description":"URL of the file thumbnail for supported file formats. Should be put to `thumb_url` attachment field","title":"Thumbnail URL","type":"string","x-stream-index":"002"}},"required":["duration"],"type":"object"},"Flag":{"description":"Contains information about flagged user or message","properties":{"approved_at":{"description":"Date of the approval","format":"date-time","title":"Approved at","type":"string","x-stream-index":"015"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"011"},"created_by_automod":{"type":"boolean","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"022"},"details":{"$ref":"#/components/schemas/FlagDetails","x-stream-index":"021"},"reason":{"type":"string","x-stream-index":"020"},"rejected_at":{"description":"Date of the rejection","format":"date-time","title":"Rejected at","type":"string","x-stream-index":"016"},"reviewed_at":{"description":"Date of the review","format":"date-time","title":"Reviewed at","type":"string","x-stream-index":"013"},"reviewed_by":{"type":"string","x-stream-index":"014"},"target_message":{"$ref":"#/components/schemas/Message","x-stream-index":"008"},"target_message_id":{"description":"ID of flagged message","title":"Target Message ID","type":"string","x-stream-index":"007"},"target_user":{"$ref":"#/components/schemas/User","description":"Flagged user","title":"User","x-stream-index":"010"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"012"},"user":{"$ref":"#/components/schemas/User","description":"User who flagged a message or a user","title":"User","x-stream-index":"006"}},"required":["created_by_automod","created_at","updated_at"],"title":"Flag","type":"object"},"FlagDetails":{"properties":{"Extra":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"002"},"automod":{"$ref":"#/components/schemas/AutomodDetails","x-stream-index":"001"},"original_text":{"type":"string","x-stream-index":"003"}},"required":["Extra","original_text"],"type":"object"},"FlagFeedback":{"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"005"},"labels":{"items":{"$ref":"#/components/schemas/Label"},"type":"array","x-stream-index":"006"},"message_id":{"type":"string","x-stream-index":"004"}},"required":["message_id","created_at","labels"],"type":"object"},"FlagMessageDetails":{"properties":{"pin_changed":{"type":"boolean","x-stream-index":"002"},"should_enrich":{"type":"boolean","x-stream-index":"003"},"skip_push":{"type":"boolean","x-stream-index":"004"},"updated_by_id":{"type":"string","x-stream-index":"001"}},"type":"object"},"FlagRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"reason":{"maxLength":255,"type":"string","x-stream-index":"003"},"target_message_id":{"description":"ID of the message when reporting a message","title":"Target Message ID","type":"string","x-stream-index":"001"},"target_user_id":{"description":"ID of the user when reporting a user","title":"Target User ID","type":"string","x-stream-index":"002"}},"type":"object"},"FlagResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"flag":{"$ref":"#/components/schemas/Flag","x-stream-index":"001"},"review_queue_item_id":{"type":"string","x-stream-index":"002"}},"required":["review_queue_item_id","duration"],"title":"Response","type":"object"},"FullUserResponse":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"ban_expires":{"format":"date-time","type":"string","x-stream-index":"015"},"banned":{"type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"014"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"007"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"string","x-stream-index":"001.016"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"001.011"},"devices":{"items":{"$ref":"#/components/schemas/DeviceResponse"},"type":"array","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001.001"},"image":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"005"},"language":{"type":"string","x-stream-index":"001.005"},"last_active":{"format":"date-time","type":"string","x-stream-index":"001.014"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"012"},"mutes":{"items":{"$ref":"#/components/schemas/UserMuteResponse"},"type":"array","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"001.002"},"online":{"type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"003"},"revoke_tokens_issued_before":{"format":"date-time","type":"string","x-stream-index":"001.015"},"role":{"type":"string","x-stream-index":"001.006"},"shadow_banned":{"type":"boolean","x-stream-index":"013"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"009"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"010"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"008"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"011"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","devices","invisible","mutes","channel_mutes","unread_count","total_unread_count","unread_channels","unread_threads","shadow_banned","blocked_user_ids"],"type":"object"},"GetApplicationResponse":{"description":"Basic response information","nullable":true,"properties":{"app":{"$ref":"#/components/schemas/AppResponseFields","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["app","duration"],"title":"Response","type":"object"},"GetBlockedUsersResponse":{"nullable":true,"properties":{"blocks":{"description":"Array of blocked user object","items":{"$ref":"#/components/schemas/BlockedUserResponse"},"title":"Blocks","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["blocks","duration"],"type":"object"},"GetDraftResponse":{"description":"Basic response information","nullable":true,"properties":{"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["draft","duration"],"title":"Response","type":"object"},"GetManyMessagesResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.002.001"},"messages":{"description":"List of messages","items":{"$ref":"#/components/schemas/MessageResponse"},"title":"Messages","type":"array","x-stream-index":"001.001"}},"required":["messages","duration"],"type":"object"},"GetMessageResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageWithChannelResponse","x-stream-index":"001"},"pending_message_metadata":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"002"}},"required":["message","duration"],"title":"Response","type":"object"},"GetOGResponse":{"nullable":true,"properties":{"actions":{"items":{"$ref":"#/components/schemas/Action"},"type":"array","x-stream-index":"001.015"},"asset_url":{"description":"URL of detected video or audio","title":"Image URL","type":"string","x-stream-index":"001.017"},"author_icon":{"type":"string","x-stream-index":"001.007"},"author_link":{"description":"og:site","title":"Author Link","type":"string","x-stream-index":"001.006"},"author_name":{"description":"og:site_name","title":"Author Name","type":"string","x-stream-index":"001.005"},"color":{"type":"string","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.018"},"duration":{"type":"string","x-stream-index":"002.001"},"fallback":{"type":"string","x-stream-index":"001.002"},"fields":{"items":{"$ref":"#/components/schemas/Field"},"type":"array","x-stream-index":"001.016"},"footer":{"type":"string","x-stream-index":"001.013"},"footer_icon":{"type":"string","x-stream-index":"001.014"},"giphy":{"$ref":"#/components/schemas/Images","x-stream-index":"001.019"},"image_url":{"description":"URL of detected image","title":"Image URL","type":"string","x-stream-index":"001.011"},"og_scrape_url":{"description":"extracted url from the text","title":"OG Scrape URL","type":"string","x-stream-index":"001.020"},"original_height":{"format":"int32","type":"integer","x-stream-index":"001.022"},"original_width":{"format":"int32","type":"integer","x-stream-index":"001.021"},"pretext":{"type":"string","x-stream-index":"001.004"},"text":{"description":"og:description","title":"Text","type":"string","x-stream-index":"001.010"},"thumb_url":{"description":"URL of detected thumb image","title":"Image URL","type":"string","x-stream-index":"001.012"},"title":{"description":"og:title","title":"Title","type":"string","x-stream-index":"001.008"},"title_link":{"description":"og:url","title":"Title Link","type":"string","x-stream-index":"001.009"},"type":{"description":"Attachment type, could be empty, image, audio or video","title":"Type","type":"string","x-stream-index":"001.001"}},"required":["custom","duration"],"title":"Get OG Attachment","type":"object","x-stream-docs-page-id":"og"},"GetReactionsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"reactions":{"description":"List of reactions","items":{"$ref":"#/components/schemas/Reaction"},"title":"Reactions","type":"array","x-stream-index":"001"}},"required":["reactions","duration"],"type":"object"},"GetRepliesResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"messages":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","x-stream-index":"001"}},"required":["messages","duration"],"title":"Response","type":"object"},"GetThreadResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"thread":{"$ref":"#/components/schemas/ThreadStateResponse","description":"Enriched thread state","title":"Thread","x-stream-index":"001"}},"required":["thread","duration"],"type":"object"},"HealthCheckEvent":{"nullable":true,"properties":{"cid":{"type":"string","x-stream-index":"003"},"connection_id":{"type":"string","x-stream-index":"001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"004.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004.007"},"me":{"$ref":"#/components/schemas/OwnUserResponse","x-stream-index":"002"},"received_at":{"format":"date-time","type":"string","x-stream-index":"004.004"},"type":{"default":"health.check","type":"string","x-stream-index":"004.002"}},"required":["connection_id","type","created_at","custom"],"title":"HealthCheckEvent","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"},"HideChannelRequest":{"nullable":true,"properties":{"clear_history":{"description":"Whether to clear message history of the channel or not","title":"Clear history","type":"boolean","x-stream-index":"001"}},"type":"object"},"HideChannelResponse":{"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"},"ImageData":{"properties":{"frames":{"type":"string","x-stream-index":"005"},"height":{"type":"string","x-stream-index":"003"},"size":{"type":"string","x-stream-index":"004"},"url":{"type":"string","x-stream-index":"001"},"width":{"type":"string","x-stream-index":"002"}},"required":["url","width","height","size","frames"],"type":"object"},"ImageSize":{"properties":{"crop":{"description":"Crop mode","enum":["top","bottom","left","right","center"],"title":"Crop","type":"string","x-stream-index":"001"},"height":{"description":"Target image height","format":"int32","title":"Height","type":"integer","x-stream-index":"003"},"resize":{"description":"Resize method","enum":["clip","crop","scale","fill"],"title":"Resize","type":"string","x-stream-index":"002"},"width":{"description":"Target image width","format":"int32","title":"Width","type":"integer","x-stream-index":"004"}},"title":"Image size configuration","type":"object"},"ImageUploadRequest":{"nullable":true,"properties":{"file":{"type":"string","x-stream-index":"001.002"},"upload_sizes":{"description":"field with JSON-encoded array of image size configurations","items":{"$ref":"#/components/schemas/ImageSize"},"title":"Upload sizes","type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/OnlyUserID","x-stream-index":"001.003"}},"type":"object"},"ImageUploadResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.003.001"},"file":{"type":"string","x-stream-index":"001.001"},"thumb_url":{"type":"string","x-stream-index":"001.002"},"upload_sizes":{"description":"Array of image size configurations","items":{"$ref":"#/components/schemas/ImageSize"},"title":"Upload sizes","type":"array","x-stream-index":"002"}},"required":["duration"],"type":"object"},"Images":{"properties":{"fixed_height":{"$ref":"#/components/schemas/ImageData","x-stream-index":"002"},"fixed_height_downsampled":{"$ref":"#/components/schemas/ImageData","x-stream-index":"004"},"fixed_height_still":{"$ref":"#/components/schemas/ImageData","x-stream-index":"003"},"fixed_width":{"$ref":"#/components/schemas/ImageData","x-stream-index":"005"},"fixed_width_downsampled":{"$ref":"#/components/schemas/ImageData","x-stream-index":"007"},"fixed_width_still":{"$ref":"#/components/schemas/ImageData","x-stream-index":"006"},"original":{"$ref":"#/components/schemas/ImageData","x-stream-index":"001"}},"required":["original","fixed_height","fixed_height_still","fixed_height_downsampled","fixed_width","fixed_width_still","fixed_width_downsampled"],"type":"object"},"Label":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"phrase_list_ids":{"items":{"format":"int32","type":"integer"},"type":"array","x-stream-index":"002"}},"required":["name"],"type":"object"},"LabelThresholds":{"properties":{"block":{"description":"Threshold for automatic message block","format":"float","maximum":1,"minimum":0,"title":"Block","type":"number","x-stream-index":"002"},"flag":{"description":"Threshold for automatic message flag","format":"float","maximum":1,"minimum":0,"title":"Flag","type":"number","x-stream-index":"001"}},"type":"object"},"ListBlockListResponse":{"description":"Basic response information","nullable":true,"properties":{"blocklists":{"items":{"$ref":"#/components/schemas/BlockListResponse"},"type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["blocklists","duration"],"title":"Response","type":"object"},"ListDevicesResponse":{"description":"List devices response","nullable":true,"properties":{"devices":{"description":"List of devices","items":{"$ref":"#/components/schemas/DeviceResponse"},"title":"Devices","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["devices","duration"],"title":"ListDevicesResponse","type":"object"},"MarkChannelsReadRequest":{"nullable":true,"properties":{"read_by_channel":{"additionalProperties":{"type":"string"},"description":"Map of channel ID to last read message ID","maximum":30,"title":"Read by channel","type":"object","x-stream-index":"001"}},"type":"object"},"MarkReadRequest":{"nullable":true,"properties":{"message_id":{"description":"ID of the message that is considered last read by client","title":"Message ID","type":"string","x-stream-index":"001"},"thread_id":{"description":"Optional Thread ID to specifically mark a given thread as read","title":"Thread ID","type":"string","x-stream-index":"002"}},"type":"object"},"MarkReadResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"event":{"$ref":"#/components/schemas/MessageReadEvent","description":"Mark read event","title":"Event","x-stream-index":"001"}},"required":["duration"],"type":"object"},"MarkUnreadRequest":{"nullable":true,"properties":{"message_id":{"description":"ID of the message from where the channel is marked unread","title":"Message ID","type":"string","x-stream-index":"001"},"thread_id":{"description":"Mark a thread unread, specify both the thread and message id","title":"Thread ID","type":"string","x-stream-index":"003"}},"type":"object"},"MemberAddedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"003.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"002.001"},"type":{"default":"member.added","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MemberAddedEvent","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"},"MemberRemovedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"002.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"001.001"},"type":{"default":"member.removed","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MemberRemovedEvent","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"},"MemberUpdatedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"005.002"},"channel_type":{"type":"string","x-stream-index":"005.003"},"cid":{"type":"string","x-stream-index":"005.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"003.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"002.001"},"type":{"default":"member.updated","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MemberUpdatedEvent","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"},"MembersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"members":{"description":"List of found members","items":{"$ref":"#/components/schemas/ChannelMember"},"title":"Members","type":"array","x-stream-index":"001"}},"required":["members","duration"],"type":"object"},"Message":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"012"},"before_message_send_failed":{"type":"boolean","x-stream-index":"046"},"cid":{"type":"string","x-stream-index":"028"},"command":{"type":"string","x-stream-index":"006"},"created_at":{"format":"date-time","type":"string","x-stream-index":"030"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"034"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"033"},"deleted_for_me":{"type":"boolean","x-stream-index":"059"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"023"},"html":{"type":"string","x-stream-index":"007"},"i18n":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"044"},"id":{"type":"string","x-stream-index":"002"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"040"},"latest_reactions":{"items":{"$ref":"#/components/schemas/Reaction"},"type":"array","x-stream-index":"013"},"mentioned_users":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"043"},"message_text_updated_at":{"format":"date-time","type":"string","x-stream-index":"052"},"mml":{"type":"string","x-stream-index":"005"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"056"},"own_reactions":{"items":{"$ref":"#/components/schemas/Reaction"},"type":"array","x-stream-index":"014"},"parent_id":{"type":"string","x-stream-index":"019"},"pin_expires":{"format":"date-time","type":"string","x-stream-index":"051"},"pinned":{"type":"boolean","x-stream-index":"047"},"pinned_at":{"format":"date-time","type":"string","x-stream-index":"048"},"pinned_by":{"$ref":"#/components/schemas/User","x-stream-index":"050"},"poll":{"$ref":"#/components/schemas/Poll","x-stream-index":"054"},"poll_id":{"type":"string","x-stream-index":"053"},"quoted_message":{"$ref":"#/components/schemas/Message","x-stream-index":"025"},"quoted_message_id":{"type":"string","x-stream-index":"024"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"015"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"017"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"016"},"reminder":{"$ref":"#/components/schemas/MessageReminder","x-stream-index":"058"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"022"},"restricted_visibility":{"items":{"type":"string"},"type":"array","x-stream-index":"011"},"shadowed":{"type":"boolean","x-stream-index":"036"},"shared_location":{"$ref":"#/components/schemas/SharedLocation","x-stream-index":"055"},"show_in_channel":{"type":"boolean","x-stream-index":"021"},"silent":{"type":"boolean","x-stream-index":"045"},"text":{"type":"string","x-stream-index":"004"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"027"},"type":{"type":"string","x-stream-index":"008"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"031"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"010"}},"required":["id","text","html","type","restricted_visibility","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reaction_groups","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned"],"type":"object"},"MessageActionRequest":{"nullable":true,"properties":{"form_data":{"additionalProperties":{"type":"string"},"description":"ReadOnlyData to execute command with","title":"Form data","type":"object","x-stream-index":"002"}},"required":["form_data"],"type":"object"},"MessageChangeSet":{"properties":{"attachments":{"type":"boolean","x-stream-index":"005"},"custom":{"type":"boolean","x-stream-index":"001"},"html":{"type":"boolean","x-stream-index":"004"},"mentioned_user_ids":{"type":"boolean","x-stream-index":"006"},"mml":{"type":"boolean","x-stream-index":"003"},"pin":{"type":"boolean","x-stream-index":"009"},"quoted_message_id":{"type":"boolean","x-stream-index":"007"},"silent":{"type":"boolean","x-stream-index":"008"},"text":{"type":"boolean","x-stream-index":"002"}},"required":["custom","text","mml","html","attachments","mentioned_user_ids","quoted_message_id","silent","pin"],"type":"object"},"MessageDeletedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"007.002"},"deleted_for_me":{"type":"boolean","x-stream-index":"003"},"hard_delete":{"type":"boolean","x-stream-index":"002.001"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"006.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"message.deleted","type":"string","x-stream-index":"007.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005.001"}},"required":["hard_delete","cid","channel_id","channel_type","type","created_at"],"title":"MessageDeletedEvent","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":{"approved_at":{"format":"date-time","type":"string","x-stream-index":"013"},"created_at":{"format":"date-time","type":"string","x-stream-index":"009"},"created_by_automod":{"type":"boolean","x-stream-index":"001"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"008"},"details":{"$ref":"#/components/schemas/FlagDetails","x-stream-index":"006"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"005"},"moderation_feedback":{"$ref":"#/components/schemas/FlagFeedback","x-stream-index":"003"},"moderation_result":{"$ref":"#/components/schemas/MessageModerationResult","x-stream-index":"002"},"reason":{"type":"string","x-stream-index":"007"},"rejected_at":{"format":"date-time","type":"string","x-stream-index":"014"},"reviewed_at":{"format":"date-time","type":"string","x-stream-index":"011"},"reviewed_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"012"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"004"}},"required":["created_by_automod","created_at","updated_at"],"type":"object"},"MessageModerationResult":{"description":"Result of the message moderation","properties":{"action":{"description":"Action taken by automod","title":"Action","type":"string","x-stream-index":"002"},"ai_moderation_response":{"$ref":"#/components/schemas/ModerationResponse","description":"Response from AI moderation","title":"ModerationResponse","x-stream-index":"007"},"blocked_word":{"description":"Word that was blocked","title":"Blocked word","type":"string","x-stream-index":"004"},"blocklist_name":{"description":"Name of the blocklist","title":"Blocklist name","type":"string","x-stream-index":"005"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"010"},"message_id":{"description":"ID of the message","title":"Message ID","type":"string","x-stream-index":"001"},"moderated_by":{"description":"User who moderated the message","title":"Moderated by","type":"string","x-stream-index":"003"},"moderation_thresholds":{"$ref":"#/components/schemas/Thresholds","description":"Thresholds for AI moderation","title":"Thresholds","x-stream-index":"006"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"011"},"user_bad_karma":{"description":"Whether user has bad karma","title":"User bad karma","type":"boolean","x-stream-index":"009"},"user_karma":{"description":"Karma of the user","format":"float","title":"User karma","type":"number","x-stream-index":"008"}},"required":["message_id","action","user_karma","user_bad_karma","created_at","updated_at"],"title":"Message moderation result","type":"object"},"MessageNewEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"005.002"},"channel_type":{"type":"string","x-stream-index":"005.003"},"cid":{"type":"string","x-stream-index":"005.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"004.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"006.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"notification.thread_message_new","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"},"watcher_count":{"format":"int32","type":"integer","x-stream-index":"002.001"}},"required":["watcher_count","type","created_at","cid","channel_id","channel_type"],"title":"MessageNewEvent","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"},"MessageOptions":{"properties":{"include_thread_participants":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"MessagePaginationParams":{"type":"object"},"MessageReadEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"003"},"channel_last_message_at":{"format":"date-time","type":"string","x-stream-index":"005"},"channel_type":{"type":"string","x-stream-index":"004"},"cid":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"string","x-stream-index":"009"},"last_read_message_id":{"type":"string","x-stream-index":"010"},"team":{"type":"string","x-stream-index":"006"},"thread":{"$ref":"#/components/schemas/ThreadResponse","x-stream-index":"008"},"type":{"default":"message.read","type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","x-stream-index":"007"}},"required":["type","cid","channel_id","channel_type","created_at"],"type":"object"},"MessageReminder":{"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"004"},"channel_cid":{"type":"string","x-stream-index":"003"},"created_at":{"format":"date-time","type":"string","x-stream-index":"011"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"006"},"message_id":{"type":"string","x-stream-index":"005"},"remind_at":{"format":"date-time","type":"string","x-stream-index":"009"},"task_id":{"type":"string","x-stream-index":"010"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"012"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"user_id":{"type":"string","x-stream-index":"007"}},"required":["channel_cid","message_id","user_id","task_id","created_at","updated_at"],"type":"object"},"MessageRequest":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"maximum":30,"type":"array","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"mentioned_users":{"items":{"type":"string"},"maximum":100,"type":"array","x-stream-index":"008"},"mml":{"type":"string","x-stream-index":"003"},"parent_id":{"type":"string","x-stream-index":"005"},"pin_expires":{"format":"date-time","type":"string","x-stream-index":"015"},"pinned":{"type":"boolean","x-stream-index":"013"},"pinned_at":{"format":"date-time","nullable":true,"type":"string","x-stream-index":"014"},"poll_id":{"type":"string","x-stream-index":"039"},"quoted_message_id":{"type":"string","x-stream-index":"009"},"restricted_visibility":{"items":{"type":"string"},"maximum":10,"type":"array","x-stream-index":"016"},"shared_location":{"$ref":"#/components/schemas/SharedLocation","x-stream-index":"040"},"show_in_channel":{"type":"boolean","x-stream-index":"006"},"silent":{"type":"boolean","x-stream-index":"012"},"text":{"type":"string","x-stream-index":"002"},"type":{"enum":["''","regular","system"],"type":"string","x-stream-index":"011"}},"type":"object"},"MessageResponse":{"description":"Represents any chat message","properties":{"attachments":{"description":"Array of message attachments","items":{"$ref":"#/components/schemas/Attachment"},"title":"Message attachments","type":"array","x-stream-docs-page-id":"message_format#attachment-format","x-stream-index":"008"},"cid":{"description":"Channel unique identifier in \u003ctype\u003e:\u003cid\u003e format","title":"Channel CID","type":"string","x-stream-index":"022"},"command":{"description":"Contains provided slash command","title":"Command","type":"string","x-stream-docs-page-id":"custom_commands_webhook","x-stream-index":"004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"023"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"026"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"string","x-stream-index":"025"},"deleted_for_me":{"type":"boolean","x-stream-index":"044"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"018"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"041"},"html":{"description":"Contains HTML markup of the message. Can only be set when using server-side API","title":"HTML content","type":"string","x-stream-index":"005"},"i18n":{"additionalProperties":{"type":"string"},"description":"Object with translations. Key `language` contains the original language key. Other keys contain translations","title":"Internationalization info","type":"object","x-stream-docs-page-id":"translation","x-stream-index":"030"},"id":{"description":"Message ID is unique string identifier of the message","title":"ID","type":"string","x-stream-index":"001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"Contains image moderation information","title":"Image moderation labels","type":"object","x-stream-index":"028"},"latest_reactions":{"description":"List of 10 latest reactions to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Latest reactions","type":"array","x-stream-index":"009"},"mentioned_users":{"description":"List of mentioned users","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Mentioned Users","type":"array","x-stream-index":"029"},"message_text_updated_at":{"format":"date-time","type":"string","x-stream-index":"036"},"mml":{"description":"Should be empty if `text` is provided. Can only be set when using server-side API","title":"Messaging Markup Language","type":"string","x-stream-docs-page-id":"mml_overview","x-stream-index":"003"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"039"},"own_reactions":{"description":"List of 10 latest reactions of authenticated user to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Own reactions","type":"array","x-stream-index":"010"},"parent_id":{"description":"ID of parent message (thread)","title":"Parent message ID","type":"string","x-stream-docs-page-id":"threads","x-stream-index":"015"},"pin_expires":{"description":"Date when pinned message expires","format":"date-time","title":"Pin expiration date","type":"string","x-stream-docs-page-id":"pinned_messages","x-stream-index":"035"},"pinned":{"description":"Whether message is pinned or not","title":"Pinned","type":"boolean","x-stream-docs-page-id":"pinned_messages","x-stream-index":"032"},"pinned_at":{"description":"Date when message got pinned","format":"date-time","title":"Pinned at","type":"string","x-stream-docs-page-id":"pinned_messages","x-stream-index":"033"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","description":"Contains user who pinned the message","title":"Pinned by","x-stream-docs-page-id":"pinned_messages","x-stream-index":"034"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"038"},"poll_id":{"description":"Identifier of the poll to include in the message","title":"Poll ID","type":"string","x-stream-index":"037"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","description":"Contains quoted message","title":"Quoted message","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"020"},"quoted_message_id":{"title":"ID of quoted message","type":"string","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"019"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing number of reactions of each type. Key: reaction type (string), value: number of reactions (int)","title":"Reaction counts","type":"object","x-stream-index":"011"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"014"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing scores of reactions of each type. Key: reaction type (string), value: total score of reactions (int)","title":"Reaction scores","type":"object","x-stream-index":"012"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"042"},"reply_count":{"description":"Number of replies to this message","format":"int32","title":"Reply count","type":"integer","x-stream-index":"017"},"restricted_visibility":{"description":"A list of user ids that have restricted visibility to the message, if the list is not empty, the message is only visible to the users in the list","items":{"type":"string"},"title":"Restricted visibility","type":"array","x-stream-index":"040"},"shadowed":{"description":"Whether the message was shadowed or not","title":"Shadowed","type":"boolean","x-stream-docs-page-id":"moderation#shadow-ban","x-stream-index":"027"},"shared_location":{"$ref":"#/components/schemas/SharedLocationResponseData","description":"Contains shared location data","title":"Shared Location","x-stream-index":"043"},"show_in_channel":{"description":"Whether thread reply should be shown in the channel as well","title":"Show in channel","type":"boolean","x-stream-docs-page-id":"threads","x-stream-index":"016"},"silent":{"description":"Whether message is silent or not","title":"Silent","type":"boolean","x-stream-index":"031"},"text":{"description":"Text of the message. Should be empty if `mml` is provided","title":"Text","type":"string","x-stream-index":"002"},"thread_participants":{"description":"List of users who participate in thread","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Thread participants","type":"array","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"021"},"type":{"description":"Contains type of the message","enum":["regular","ephemeral","error","reply","system","deleted"],"title":"Message Type","type":"string","x-stream-docs-page-id":"message_format#message-types","x-stream-index":"006"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"024"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Sender of the message. Required when using server-side API","title":"User object","x-stream-index":"007"}},"required":["id","text","html","type","user","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned","restricted_visibility"],"title":"Message","type":"object","x-stream-docs-page-id":"send_message"},"MessageUndeletedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"005.002"},"channel_type":{"type":"string","x-stream-index":"005.003"},"cid":{"type":"string","x-stream-index":"005.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"004.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"002.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"message.undeleted","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MessageUndeletedEvent","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"},"MessageUpdate":{"properties":{"change_set":{"$ref":"#/components/schemas/MessageChangeSet","x-stream-index":"002"},"old_text":{"type":"string","x-stream-index":"001"}},"type":"object"},"MessageUpdatedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"005.002"},"channel_type":{"type":"string","x-stream-index":"005.003"},"cid":{"type":"string","x-stream-index":"005.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"004.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"002.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"message.updated","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MessageUpdatedEvent","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"},"MessageWithChannelResponse":{"description":"Represents any chat message","properties":{"attachments":{"description":"Array of message attachments","items":{"$ref":"#/components/schemas/Attachment"},"title":"Message attachments","type":"array","x-stream-docs-page-id":"message_format#attachment-format","x-stream-index":"001.008"},"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel object","title":"Channel","x-stream-index":"002"},"cid":{"description":"Channel unique identifier in \u003ctype\u003e:\u003cid\u003e format","title":"Channel CID","type":"string","x-stream-index":"001.022"},"command":{"description":"Contains provided slash command","title":"Command","type":"string","x-stream-docs-page-id":"custom_commands_webhook","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.023"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.026"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"string","x-stream-index":"001.025"},"deleted_for_me":{"type":"boolean","x-stream-index":"001.044"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"001.018"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001.041"},"html":{"description":"Contains HTML markup of the message. Can only be set when using server-side API","title":"HTML content","type":"string","x-stream-index":"001.005"},"i18n":{"additionalProperties":{"type":"string"},"description":"Object with translations. Key `language` contains the original language key. Other keys contain translations","title":"Internationalization info","type":"object","x-stream-docs-page-id":"translation","x-stream-index":"001.030"},"id":{"description":"Message ID is unique string identifier of the message","title":"ID","type":"string","x-stream-index":"001.001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"Contains image moderation information","title":"Image moderation labels","type":"object","x-stream-index":"001.028"},"latest_reactions":{"description":"List of 10 latest reactions to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Latest reactions","type":"array","x-stream-index":"001.009"},"mentioned_users":{"description":"List of mentioned users","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Mentioned Users","type":"array","x-stream-index":"001.029"},"message_text_updated_at":{"format":"date-time","type":"string","x-stream-index":"001.036"},"mml":{"description":"Should be empty if `text` is provided. Can only be set when using server-side API","title":"Messaging Markup Language","type":"string","x-stream-docs-page-id":"mml_overview","x-stream-index":"001.003"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"001.039"},"own_reactions":{"description":"List of 10 latest reactions of authenticated user to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Own reactions","type":"array","x-stream-index":"001.010"},"parent_id":{"description":"ID of parent message (thread)","title":"Parent message ID","type":"string","x-stream-docs-page-id":"threads","x-stream-index":"001.015"},"pin_expires":{"description":"Date when pinned message expires","format":"date-time","title":"Pin expiration date","type":"string","x-stream-docs-page-id":"pinned_messages","x-stream-index":"001.035"},"pinned":{"description":"Whether message is pinned or not","title":"Pinned","type":"boolean","x-stream-docs-page-id":"pinned_messages","x-stream-index":"001.032"},"pinned_at":{"description":"Date when message got pinned","format":"date-time","title":"Pinned at","type":"string","x-stream-docs-page-id":"pinned_messages","x-stream-index":"001.033"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","description":"Contains user who pinned the message","title":"Pinned by","x-stream-docs-page-id":"pinned_messages","x-stream-index":"001.034"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001.038"},"poll_id":{"description":"Identifier of the poll to include in the message","title":"Poll ID","type":"string","x-stream-index":"001.037"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","description":"Contains quoted message","title":"Quoted message","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"001.020"},"quoted_message_id":{"title":"ID of quoted message","type":"string","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"001.019"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing number of reactions of each type. Key: reaction type (string), value: number of reactions (int)","title":"Reaction counts","type":"object","x-stream-index":"001.011"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"001.014"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing scores of reactions of each type. Key: reaction type (string), value: total score of reactions (int)","title":"Reaction scores","type":"object","x-stream-index":"001.012"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"001.042"},"reply_count":{"description":"Number of replies to this message","format":"int32","title":"Reply count","type":"integer","x-stream-index":"001.017"},"restricted_visibility":{"description":"A list of user ids that have restricted visibility to the message, if the list is not empty, the message is only visible to the users in the list","items":{"type":"string"},"title":"Restricted visibility","type":"array","x-stream-index":"001.040"},"shadowed":{"description":"Whether the message was shadowed or not","title":"Shadowed","type":"boolean","x-stream-docs-page-id":"moderation#shadow-ban","x-stream-index":"001.027"},"shared_location":{"$ref":"#/components/schemas/SharedLocationResponseData","description":"Contains shared location data","title":"Shared Location","x-stream-index":"001.043"},"show_in_channel":{"description":"Whether thread reply should be shown in the channel as well","title":"Show in channel","type":"boolean","x-stream-docs-page-id":"threads","x-stream-index":"001.016"},"silent":{"description":"Whether message is silent or not","title":"Silent","type":"boolean","x-stream-index":"001.031"},"text":{"description":"Text of the message. Should be empty if `mml` is provided","title":"Text","type":"string","x-stream-index":"001.002"},"thread_participants":{"description":"List of users who participate in thread","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Thread participants","type":"array","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"001.021"},"type":{"description":"Contains type of the message","enum":["regular","ephemeral","error","reply","system","deleted"],"title":"Message Type","type":"string","x-stream-docs-page-id":"message_format#message-types","x-stream-index":"001.006"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"001.024"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Sender of the message. Required when using server-side API","title":"User object","x-stream-index":"001.007"}},"required":["id","text","html","type","user","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned","restricted_visibility","channel"],"title":"Message","type":"object","x-stream-docs-page-id":"send_message"},"ModerationResponse":{"properties":{"action":{"type":"string","x-stream-index":"004"},"explicit":{"format":"float","type":"number","x-stream-index":"002"},"spam":{"format":"float","type":"number","x-stream-index":"003"},"toxic":{"format":"float","type":"number","x-stream-index":"001"}},"required":["toxic","explicit","spam","action","automod_response"],"type":"object"},"ModerationV2Response":{"properties":{"action":{"type":"string","x-stream-index":"001"},"blocklist_matched":{"type":"string","x-stream-index":"005"},"image_harms":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"original_text":{"type":"string","x-stream-index":"002"},"platform_circumvented":{"type":"boolean","x-stream-index":"007"},"semantic_filter_matched":{"type":"string","x-stream-index":"006"},"text_harms":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"required":["action","original_text"],"type":"object"},"MuteChannelRequest":{"nullable":true,"properties":{"channel_cids":{"description":"Channel CIDs to mute (if multiple channels)","items":{"type":"string"},"maximum":25,"title":"Channel CIDs","type":"array","x-stream-index":"002"},"expiration":{"description":"Duration of mute in milliseconds","title":"Expiration","type":"integer","x-stream-index":"003"}},"type":"object"},"MuteChannelResponse":{"nullable":true,"properties":{"channel_mute":{"$ref":"#/components/schemas/ChannelMute","description":"Object with channel mute (if one channel was muted)","title":"Channel mute","x-stream-index":"001"},"channel_mutes":{"description":"Object with mutes (if multiple channels were muted)","items":{"$ref":"#/components/schemas/ChannelMute"},"title":"Channel mutes","type":"array","x-stream-index":"002"},"duration":{"type":"string","x-stream-index":"004.001"},"own_user":{"$ref":"#/components/schemas/OwnUser","description":"Authorized user object with fresh mutes information","title":"Own user","x-stream-index":"003"}},"required":["duration"],"type":"object"},"MuteUserRequest":{"nullable":true,"properties":{"target_ids":{"description":"User IDs to mute (if multiple users)","items":{"type":"string"},"maximum":1000,"title":"Target IDs","type":"array","x-stream-index":"002"},"timeout":{"description":"Duration of mute in minutes","minimum":0,"title":"Timeout","type":"integer","x-stream-index":"003"}},"required":["timeout"],"type":"object"},"MuteUserResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"005.001"},"mute":{"$ref":"#/components/schemas/UserMute","description":"Object with user mute (if one user was muted)","title":"Mute","x-stream-index":"001"},"mutes":{"description":"Object with mutes (if multiple users were muted)","items":{"$ref":"#/components/schemas/UserMute"},"title":"Mutes","type":"array","x-stream-index":"002"},"non_existing_users":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"own_user":{"$ref":"#/components/schemas/OwnUser","description":"Authorized user object with fresh mutes information","title":"Own user","x-stream-index":"003"}},"required":["duration"],"type":"object"},"NotificationAddedToChannelEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003.004"},"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"003.005"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"002.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"001.001"},"type":{"default":"notification.added_to_channel","type":"string","x-stream-index":"002.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"NotificationAddedToChannelEvent","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"},"NotificationChannelDeletedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003.004"},"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"003.005"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"002.002"},"team":{"type":"string","x-stream-index":"001.001"},"type":{"default":"notification.channel_deleted","type":"string","x-stream-index":"002.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"NotificationChannelDeletedEvent","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"},"NotificationChannelMutesUpdatedEvent":{"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"002.002"},"me":{"$ref":"#/components/schemas/OwnUser","x-stream-index":"001"},"type":{"default":"notification.channel_mutes_updated","type":"string","x-stream-index":"002.001"}},"required":["me","type","created_at"],"title":"NotificationChannelMutesUpdatedEvent","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"},"NotificationChannelTruncatedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002.004"},"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"002.005"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"notification.channel_truncated","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"NotificationChannelTruncatedEvent","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"},"NotificationInviteAcceptedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002.004"},"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"002.005"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"004.001"},"type":{"default":"notification.invite_accepted","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"NotificationInviteAcceptedEvent","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"},"NotificationInviteRejectedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002.004"},"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"002.005"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"004.001"},"type":{"default":"notification.invite_rejected","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"NotificationInviteRejectedEvent","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"},"NotificationInvitedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002.004"},"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"002.005"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"004.001"},"type":{"default":"notification.invited","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"NotificationInvitedEvent","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"},"NotificationMarkReadEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003.004"},"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"003.005"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"team":{"type":"string","x-stream-index":"002.001"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"006"},"type":{"default":"notification.mark_read","type":"string","x-stream-index":"001.001"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"007"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"005"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"008"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count","unread_count","total_unread_count","unread_channels","unread_threads"],"title":"NotificationMarkReadEvent","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"},"NotificationMarkUnreadEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003.004"},"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"003.005"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"first_unread_message_id":{"type":"string","x-stream-index":"005"},"last_read_at":{"format":"date-time","type":"string","x-stream-index":"006"},"last_read_message_id":{"type":"string","x-stream-index":"012"},"team":{"type":"string","x-stream-index":"002.001"},"thread_id":{"type":"string","x-stream-index":"013"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"009"},"type":{"default":"notification.mark_unread","type":"string","x-stream-index":"001.001"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"010"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"008"},"unread_messages":{"format":"int32","type":"integer","x-stream-index":"007"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"011"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count","first_unread_message_id","last_read_at","unread_messages","unread_count","total_unread_count","unread_channels","unread_threads"],"title":"NotificationMarkUnreadEvent","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"},"NotificationMutesUpdatedEvent":{"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"002.002"},"me":{"$ref":"#/components/schemas/OwnUser","x-stream-index":"001"},"type":{"default":"notification.mutes_updated","type":"string","x-stream-index":"002.001"}},"required":["me","type","created_at"],"title":"NotificationMutesUpdatedEvent","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"},"NotificationNewMessageEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"004.004"},"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"004.005"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"003.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"002.001"},"type":{"default":"notification.message_new","type":"string","x-stream-index":"003.001"}},"required":["message","type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"NotificationNewMessageEvent","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"},"NotificationRemovedFromChannelEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002.004"},"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"002.005"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"004.001"},"type":{"default":"notification.removed_from_channel","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"NotificationRemovedFromChannelEvent","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"},"OnlyUserID":{"properties":{"id":{"type":"string","x-stream-index":"001"}},"required":["id"],"type":"object"},"OwnUser":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"046"},"banned":{"type":"boolean","x-stream-index":"016"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"045"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"029"},"created_at":{"format":"date-time","type":"string","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"deactivated_at":{"format":"date-time","type":"string","x-stream-index":"014"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"013"},"devices":{"items":{"$ref":"#/components/schemas/Device"},"type":"array","x-stream-index":"027"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"023"},"language":{"type":"string","x-stream-index":"035"},"last_active":{"format":"date-time","type":"string","x-stream-index":"011"},"last_engaged_at":{"format":"date-time","type":"string","x-stream-index":"012"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"037"},"mutes":{"items":{"$ref":"#/components/schemas/UserMute"},"type":"array","x-stream-index":"028"},"online":{"type":"boolean","x-stream-index":"022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"026"},"push_preferences":{"$ref":"#/components/schemas/PushPreferences","x-stream-index":"025"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"005"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"031"},"total_unread_count_by_team":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"032"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"033"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"030"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"034"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"009"}},"required":["id","role","custom","created_at","updated_at","banned","online","devices","mutes","channel_mutes","unread_count","total_unread_count","total_unread_count_by_team","unread_channels","unread_threads","language"],"type":"object"},"OwnUserResponse":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"banned":{"type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"015"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"007"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"string","x-stream-index":"001.016"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"001.011"},"devices":{"items":{"$ref":"#/components/schemas/DeviceResponse"},"title":"Devices","type":"array","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001.001"},"image":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"005"},"language":{"type":"string","x-stream-index":"001.005"},"last_active":{"format":"date-time","type":"string","x-stream-index":"001.014"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"013"},"mutes":{"items":{"$ref":"#/components/schemas/UserMuteResponse"},"type":"array","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"001.002"},"online":{"type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"003"},"push_preferences":{"$ref":"#/components/schemas/PushPreferences","x-stream-index":"002"},"revoke_tokens_issued_before":{"format":"date-time","type":"string","x-stream-index":"001.015"},"role":{"type":"string","x-stream-index":"001.006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"009"},"total_unread_count_by_team":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"010"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"011"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"008"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"012"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","devices","invisible","mutes","channel_mutes","unread_count","total_unread_count","unread_channels","unread_threads"],"type":"object"},"PaginationParams":{"properties":{"limit":{"format":"int32","minimum":0,"type":"integer","x-stream-index":"001"},"offset":{"format":"int32","type":"integer","x-stream-index":"002"}},"type":"object"},"PendingMessageEvent":{"description":"Pending message event for async moderation","nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"002.007"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"message":{"$ref":"#/components/schemas/Message","description":"The pending message","title":"Message","x-stream-index":"002.009"},"metadata":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"002.010"},"method":{"description":"The method used for the pending message","title":"Method","type":"string","x-stream-index":"003"},"received_at":{"format":"date-time","type":"string","x-stream-index":"001.004"},"type":{"default":"message.pending","description":"The type of event: \"message.pending\" in this case","title":"Event Type","type":"string","x-stream-index":"001.002"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.002"}},"required":["type","custom","method","created_at"],"title":"PendingMessageEvent","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"},"PendingMessageResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"003"},"metadata":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"}},"type":"object"},"Poll":{"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"023"},"allow_answers":{"type":"boolean","x-stream-index":"010"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"009"},"answers_count":{"format":"int32","type":"integer","x-stream-index":"015"},"created_at":{"format":"date-time","type":"string","x-stream-index":"021"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"020"},"created_by_id":{"type":"string","x-stream-index":"019"},"description":{"type":"string","x-stream-index":"005"},"enforce_unique_vote":{"type":"boolean","x-stream-index":"007"},"id":{"type":"string","x-stream-index":"003"},"is_closed":{"type":"boolean","x-stream-index":"011"},"latest_answers":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array","x-stream-index":"017"},"latest_votes_by_option":{"additionalProperties":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array"},"type":"object","x-stream-index":"016"},"max_votes_allowed":{"format":"int32","type":"integer","x-stream-index":"008"},"name":{"type":"string","x-stream-index":"004"},"options":{"items":{"$ref":"#/components/schemas/PollOption"},"type":"array","x-stream-index":"013"},"own_votes":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array","x-stream-index":"018"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"022"},"vote_count":{"format":"int32","type":"integer","x-stream-index":"012"},"vote_counts_by_option":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"014"},"voting_visibility":{"type":"string","x-stream-index":"006"}},"required":["id","name","description","enforce_unique_vote","allow_user_suggested_options","allow_answers","vote_count","options","vote_counts_by_option","answers_count","latest_votes_by_option","latest_answers","own_votes","created_by_id","created_at","updated_at","Custom"],"type":"object"},"PollClosedEvent":{"description":"Emitted when a poll is closed.","nullable":true,"properties":{"activity_id":{"type":"string","x-stream-index":"001.003"},"cid":{"description":"The CID of the channel containing the poll","title":"Channel CID","type":"string","x-stream-index":"001.001.002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.001.007"},"message_id":{"description":"The ID of the message containing the poll","title":"Message ID","type":"string","x-stream-index":"001.002"},"poll":{"$ref":"#/components/schemas/PollResponseData","description":"The poll object which was closed","title":"Poll","x-stream-index":"001.004"},"received_at":{"format":"date-time","type":"string","x-stream-index":"001.001.001.004"},"type":{"default":"poll.closed","description":"The type of event: \"poll.closed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.001.002"}},"required":["type","created_at","custom","poll"],"title":"PollClosedEvent","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"},"PollDeletedEvent":{"description":"Emitted when a poll is deleted.","nullable":true,"properties":{"activity_id":{"type":"string","x-stream-index":"001.003"},"cid":{"description":"The CID of the channel containing the poll","title":"Channel CID","type":"string","x-stream-index":"001.001.002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.001.007"},"message_id":{"description":"The ID of the message containing the poll","title":"Message ID","type":"string","x-stream-index":"001.002"},"poll":{"$ref":"#/components/schemas/PollResponseData","description":"The poll object which was deleted","title":"Poll","x-stream-index":"001.004"},"received_at":{"format":"date-time","type":"string","x-stream-index":"001.001.001.004"},"type":{"default":"poll.deleted","description":"The type of event: \"poll.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.001.002"}},"required":["type","created_at","custom","poll"],"title":"PollDeletedEvent","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"},"PollOption":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id","text","custom"],"type":"object"},"PollOptionInput":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"text":{"type":"string","x-stream-index":"002"}},"type":"object"},"PollOptionRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id"],"type":"object"},"PollOptionResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"poll_option":{"$ref":"#/components/schemas/PollOptionResponseData","description":"Poll option","title":"PollOptionResponseData","x-stream-index":"001"}},"required":["poll_option","duration"],"type":"object"},"PollOptionResponseData":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id","text","custom"],"type":"object"},"PollResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"poll":{"$ref":"#/components/schemas/PollResponseData","description":"Poll","title":"PollResponseData","x-stream-index":"001"}},"required":["poll","duration"],"type":"object"},"PollResponseData":{"properties":{"allow_answers":{"type":"boolean","x-stream-index":"008"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"007"},"answers_count":{"format":"int32","type":"integer","x-stream-index":"012"},"created_at":{"format":"date-time","type":"string","x-stream-index":"019"},"created_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"018"},"created_by_id":{"type":"string","x-stream-index":"017"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"021"},"description":{"type":"string","x-stream-index":"003"},"enforce_unique_vote":{"type":"boolean","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"is_closed":{"type":"boolean","x-stream-index":"009"},"latest_answers":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array","x-stream-index":"015"},"latest_votes_by_option":{"additionalProperties":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array"},"type":"object","x-stream-index":"014"},"max_votes_allowed":{"format":"int32","type":"integer","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"002"},"options":{"items":{"$ref":"#/components/schemas/PollOptionResponseData"},"type":"array","x-stream-index":"011"},"own_votes":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array","x-stream-index":"016"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"020"},"vote_count":{"format":"int32","type":"integer","x-stream-index":"010"},"vote_counts_by_option":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"013"},"voting_visibility":{"type":"string","x-stream-index":"004"}},"required":["id","name","description","voting_visibility","enforce_unique_vote","allow_user_suggested_options","allow_answers","vote_count","options","answers_count","vote_counts_by_option","latest_votes_by_option","latest_answers","own_votes","created_by_id","created_at","updated_at","custom"],"type":"object"},"PollUpdatedEvent":{"description":"Emitted when a poll is updated.","nullable":true,"properties":{"activity_id":{"type":"string","x-stream-index":"001.003"},"cid":{"description":"The CID of the channel containing the poll","title":"Channel CID","type":"string","x-stream-index":"001.001.002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.001.007"},"message_id":{"description":"The ID of the message containing the poll","title":"Message ID","type":"string","x-stream-index":"001.002"},"poll":{"$ref":"#/components/schemas/PollResponseData","description":"The poll object which was updated","title":"Poll","x-stream-index":"001.004"},"received_at":{"format":"date-time","type":"string","x-stream-index":"001.001.001.004"},"type":{"default":"poll.updated","description":"The type of event: \"poll.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.001.002"}},"required":["type","created_at","custom","poll"],"title":"PollUpdatedEvent","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"},"PollVote":{"nullable":true,"properties":{"answer_text":{"type":"string","x-stream-index":"007"},"created_at":{"format":"date-time","type":"string","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"004"},"is_answer":{"type":"boolean","x-stream-index":"006"},"option_id":{"type":"string","x-stream-index":"005"},"poll_id":{"type":"string","x-stream-index":"003"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"011"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"009"},"user_id":{"type":"string","x-stream-index":"008"}},"required":["poll_id","id","option_id","created_at","updated_at"],"type":"object"},"PollVoteCastedEvent":{"description":"Emitted when a vote is cast on a poll.","nullable":true,"properties":{"activity_id":{"type":"string","x-stream-index":"001.001.003"},"cid":{"description":"The CID of the channel containing the poll","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"},"message_id":{"description":"The ID of the message containing the poll","title":"Message ID","type":"string","x-stream-index":"001.001.002"},"poll":{"$ref":"#/components/schemas/PollResponseData","description":"The poll object","title":"Poll","x-stream-index":"001.001.004"},"poll_vote":{"$ref":"#/components/schemas/PollVoteResponseData","description":"The vote that was cast","title":"Poll Vote","x-stream-index":"001.002"},"received_at":{"format":"date-time","type":"string","x-stream-index":"001.001.001.001.004"},"type":{"default":"poll.vote_casted","description":"The type of event: \"poll.vote_casted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.001.001.002"}},"required":["type","created_at","custom","poll","poll_vote"],"title":"PollVoteCastedEvent","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"},"PollVoteChangedEvent":{"description":"Emitted when a vote on a poll is changed.","nullable":true,"properties":{"activity_id":{"type":"string","x-stream-index":"001.001.003"},"cid":{"description":"The CID of the channel containing the poll","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"},"message_id":{"description":"The ID of the message containing the poll","title":"Message ID","type":"string","x-stream-index":"001.001.002"},"poll":{"$ref":"#/components/schemas/PollResponseData","description":"The poll object","title":"Poll","x-stream-index":"001.001.004"},"poll_vote":{"$ref":"#/components/schemas/PollVoteResponseData","description":"The updated vote","title":"Poll Vote","x-stream-index":"001.002"},"received_at":{"format":"date-time","type":"string","x-stream-index":"001.001.001.001.004"},"type":{"default":"poll.vote_changed","description":"The type of event: \"poll.vote_changed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.001.001.002"}},"required":["type","created_at","custom","poll","poll_vote"],"title":"PollVoteChangedEvent","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"},"PollVoteRemovedEvent":{"description":"Emitted when a vote is removed from a poll.","nullable":true,"properties":{"activity_id":{"type":"string","x-stream-index":"001.001.003"},"cid":{"description":"The CID of the channel containing the poll","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"},"message_id":{"description":"The ID of the message containing the poll","title":"Message ID","type":"string","x-stream-index":"001.001.002"},"poll":{"$ref":"#/components/schemas/PollResponseData","description":"The poll object","title":"Poll","x-stream-index":"001.001.004"},"poll_vote":{"$ref":"#/components/schemas/PollVoteResponseData","description":"The vote that was removed","title":"Poll Vote","x-stream-index":"001.002"},"received_at":{"format":"date-time","type":"string","x-stream-index":"001.001.001.001.004"},"type":{"default":"poll.vote_removed","description":"The type of event: \"poll.vote_removed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.001.001.002"}},"required":["type","created_at","custom","poll","poll_vote"],"title":"PollVoteRemovedEvent","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"},"PollVoteResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"vote":{"$ref":"#/components/schemas/PollVoteResponseData","description":"Poll vote","title":"PollVoteResponseData","x-stream-index":"001"}},"required":["duration"],"type":"object"},"PollVoteResponseData":{"nullable":true,"properties":{"answer_text":{"type":"string","x-stream-index":"005"},"created_at":{"format":"date-time","type":"string","x-stream-index":"008"},"id":{"type":"string","x-stream-index":"002"},"is_answer":{"type":"boolean","x-stream-index":"004"},"option_id":{"type":"string","x-stream-index":"003"},"poll_id":{"type":"string","x-stream-index":"001"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"007"},"user_id":{"type":"string","x-stream-index":"006"}},"required":["poll_id","id","option_id","created_at","updated_at"],"type":"object"},"PollVotesResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"votes":{"description":"Poll votes","items":{"$ref":"#/components/schemas/PollVoteResponseData"},"title":"PollVoteResponseList","type":"array","x-stream-index":"001"}},"required":["votes","duration"],"type":"object"},"PrivacySettings":{"properties":{"read_receipts":{"$ref":"#/components/schemas/ReadReceipts","x-stream-index":"002"},"typing_indicators":{"$ref":"#/components/schemas/TypingIndicators","x-stream-index":"001"}},"type":"object"},"PrivacySettingsResponse":{"properties":{"read_receipts":{"$ref":"#/components/schemas/ReadReceiptsResponse","x-stream-index":"002"},"typing_indicators":{"$ref":"#/components/schemas/TypingIndicatorsResponse","x-stream-index":"001"}},"type":"object"},"PushPreferenceInput":{"nullable":true,"properties":{"call_level":{"description":"Set the level of call push notifications for the user. One of all, none, default","enum":["all","none","default"],"type":"string","x-stream-index":"004"},"channel_cid":{"description":"Set the push preferences for a specific channel. If empty it sets the default for the user","type":"string","x-stream-index":"002"},"chat_level":{"description":"Set the level of chat push notifications for the user. One of all, mentions, none, default","enum":["all","mentions","none","default"],"type":"string","x-stream-index":"003"},"disabled_until":{"description":"Disable push notifications till a certain time","format":"date-time","type":"string","x-stream-index":"007"},"feeds_events":{"$ref":"#/components/schemas/FeedsEventPreferencesInput","description":"Set granular feeds event preferences for reactions, comments, new followers, and mentions","x-stream-index":"006"},"feeds_level":{"description":"Set the level of feeds push notifications for the user. One of all, none, default","enum":["all","none","default"],"type":"string","x-stream-index":"005"},"remove_disable":{"description":"Remove the disabled until time. (IE stop snoozing notifications)","type":"boolean","x-stream-index":"008"},"user_id":{"description":"The user id for which to set the push preferences. Required when using server side auths, defaults to current user with client side auth.","type":"string","x-stream-index":"001"}},"type":"object"},"PushPreferences":{"properties":{"call_level":{"type":"string","x-stream-index":"002"},"chat_level":{"type":"string","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"string","x-stream-index":"005"},"feeds_events":{"$ref":"#/components/schemas/FeedsEventPreferences","x-stream-index":"004"},"feeds_level":{"type":"string","x-stream-index":"003"}},"type":"object"},"QueryBannedUsersPayload":{"properties":{"exclude_expired_bans":{"description":"Whether to exclude expired bans or not","title":"Exclude expired bans","type":"boolean","x-stream-index":"004"},"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"description":"Number of records to return","format":"int32","maximum":300,"minimum":0,"title":"Limit","type":"integer","x-stream-index":"003.003"},"offset":{"description":"Number of records to offset","format":"int32","maximum":10000,"title":"Offset","type":"integer","x-stream-index":"003.004"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":1,"title":"Sort","type":"array","x-stream-index":"002"}},"required":["filter_conditions"],"type":"object"},"QueryBannedUsersResponse":{"nullable":true,"properties":{"bans":{"description":"List of found bans","items":{"$ref":"#/components/schemas/BanResponse"},"title":"BanResponse","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["bans","duration"],"type":"object"},"QueryChannelsRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"description":"Number of channels to limit","format":"int32","title":"Limit","type":"integer","x-stream-index":"008"},"member_limit":{"description":"Number of members to limit","format":"int32","maximum":100,"minimum":0,"title":"Member limit","type":"integer","x-stream-index":"007"},"message_limit":{"description":"Number of messages to limit","format":"int32","minimum":0,"title":"Message limit","type":"integer","x-stream-index":"006"},"offset":{"description":"Channel pagination offset","format":"int32","title":"Offset","type":"integer","x-stream-index":"009"},"presence":{"title":"Presence","type":"boolean","x-stream-index":"005"},"sort":{"description":"List of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"002"},"state":{"description":"Whether to update channel state or not","title":"State","type":"boolean","x-stream-index":"004"},"watch":{"description":"Whether to start watching found channels or not","title":"Watch","type":"boolean","x-stream-index":"003"}},"title":"Query Channels Request","type":"object","x-stream-docs-page-id":"query_channels"},"QueryChannelsResponse":{"nullable":true,"properties":{"channels":{"description":"List of channels","items":{"$ref":"#/components/schemas/ChannelStateResponseFields"},"title":"Channels","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["channels","duration"],"title":"Channels list","type":"object"},"QueryDraftsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","maximum":3,"title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"002"}},"type":"object"},"QueryDraftsResponse":{"nullable":true,"properties":{"drafts":{"description":"Drafts","items":{"$ref":"#/components/schemas/DraftResponse"},"title":"DraftsResponseList","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["drafts","duration"],"type":"object"},"QueryMembersPayload":{"description":"Client request","properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"002"},"limit":{"format":"int32","maximum":300,"minimum":0,"type":"integer","x-stream-index":"006.003"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"type":"array","x-stream-index":"003"},"offset":{"format":"int32","maximum":10000,"type":"integer","x-stream-index":"006.004"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":1,"type":"array","x-stream-index":"005"},"type":{"maxLength":64,"type":"string","x-stream-index":"001"}},"required":["type","filter_conditions"],"title":"ClientRequest","type":"object"},"QueryMessageFlagsPayload":{"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":300,"minimum":0,"type":"integer","x-stream-index":"003.003"},"offset":{"format":"int32","maximum":10000,"type":"integer","x-stream-index":"003.004"},"show_deleted_messages":{"description":"Whether to include deleted messages in the results","title":"ShowDeletedMessages","type":"boolean","x-stream-index":"002"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"type":"array","x-stream-index":"003.005"}},"type":"object"},"QueryMessageFlagsResponse":{"description":"Query message flags response","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"flags":{"description":"The flags that match the query","items":{"$ref":"#/components/schemas/MessageFlagResponse"},"title":"MessageFlagResponseList","type":"array","x-stream-index":"001"}},"required":["flags","duration"],"title":"QueryMessageFlagsResponse","type":"object"},"QueryPollVotesRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","title":"Filter","type":"object","x-stream-index":"003"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"004"}},"type":"object"},"QueryPollsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","title":"Filter","type":"object","x-stream-index":"002"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"003"}},"type":"object"},"QueryPollsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"polls":{"description":"Polls data returned by the query","items":{"$ref":"#/components/schemas/PollResponseData"},"title":"PollsResponseData","type":"array","x-stream-index":"001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["polls","duration"],"type":"object"},"QueryReactionsRequest":{"properties":{"filter":{"additionalProperties":{},"type":"object","x-stream-index":"002"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"006.001"},"next":{"type":"string","x-stream-index":"006.002"},"prev":{"type":"string","x-stream-index":"006.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":2,"type":"array","x-stream-index":"003"}},"type":"object"},"QueryReactionsResponse":{"description":"Basic response information","properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"next":{"type":"string","x-stream-index":"003.001"},"prev":{"type":"string","x-stream-index":"003.002"},"reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"001"}},"required":["reactions","duration"],"title":"Response","type":"object"},"QueryRemindersRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"002"}},"type":"object"},"QueryRemindersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"reminders":{"description":"MessageReminders data returned by the query","items":{"$ref":"#/components/schemas/ReminderResponseData"},"title":"RemindersResponseData","type":"array","x-stream-index":"001"}},"required":["reminders","duration"],"type":"object"},"QueryThreadsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter conditions to apply to threads","title":"Filter","type":"object","x-stream-index":"006"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"008.001"},"member_limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005"},"next":{"type":"string","x-stream-index":"008.002"},"participant_limit":{"description":"Limit the number of participants returned per each thread","format":"int32","maximum":100,"minimum":0,"title":"Participant limit","type":"integer","x-stream-index":"004"},"prev":{"type":"string","x-stream-index":"008.003"},"reply_limit":{"description":"Limit the number of replies returned per each thread","format":"int32","maximum":10,"minimum":0,"title":"Reply limit","type":"integer","x-stream-index":"003"},"sort":{"description":"Sort conditions to apply to threads","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"007"},"watch":{"description":"Start watching the channel this thread belongs to","title":"Watch","type":"boolean","x-stream-index":"001"}},"type":"object"},"QueryThreadsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"threads":{"description":"List of enriched thread states","items":{"$ref":"#/components/schemas/ThreadStateResponse"},"title":"Threads","type":"array","x-stream-index":"001"}},"required":["threads","duration"],"type":"object"},"QueryUsersPayload":{"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"include_deactivated_users":{"type":"boolean","x-stream-index":"004"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.003"},"offset":{"format":"int32","maximum":1000,"type":"integer","x-stream-index":"005.004"},"presence":{"type":"boolean","x-stream-index":"003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"type":"array","x-stream-index":"002"}},"required":["filter_conditions"],"type":"object"},"QueryUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"users":{"description":"Array of users as result of filters applied.","items":{"$ref":"#/components/schemas/FullUserResponse"},"title":"Users","type":"array","x-stream-index":"001"}},"required":["users","duration"],"type":"object"},"Reaction":{"nullable":true,"properties":{"created_at":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"message_id":{"type":"string","x-stream-index":"003"},"score":{"format":"int32","type":"integer","x-stream-index":"007"},"type":{"maxLength":30,"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["message_id","type","score","created_at","updated_at","custom"],"type":"object"},"ReactionDeletedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"006.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"002"},"team":{"type":"string","x-stream-index":"005.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"reaction.deleted","type":"string","x-stream-index":"006.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"ReactionDeletedEvent","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"},"ReactionGroupResponse":{"description":"ReactionGroupResponse contains all information about a reaction of the same type.","nullable":true,"properties":{"count":{"description":"Count is the number of reactions of this type.","format":"int32","title":"Count","type":"integer","x-stream-index":"001"},"first_reaction_at":{"description":"FirstReactionAt is the time of the first reaction of this type. This is the same also if all reaction of this type are deleted, because if someone will react again with the same type, will be preserved the sorting.","format":"date-time","title":"FirstReactionAt","type":"string","x-stream-index":"003"},"last_reaction_at":{"description":"LastReactionAt is the time of the last reaction of this type.","format":"date-time","title":"LastReactionAt","type":"string","x-stream-index":"004"},"sum_scores":{"description":"SumScores is the sum of all scores of reactions of this type. Medium allows you to clap articles more than once and shows the sum of all claps from all users. For example, you can send `clap` x5 using `score: 5`.","format":"int32","title":"SumScores","type":"integer","x-stream-index":"002"}},"required":["count","sum_scores","first_reaction_at","last_reaction_at"],"title":"ReactionGroupResponse","type":"object"},"ReactionNewEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"006.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"002"},"team":{"type":"string","x-stream-index":"005.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"reaction.new","type":"string","x-stream-index":"006.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"ReactionNewEvent","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"},"ReactionRequest":{"description":"Represents user reaction to a message","properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"score":{"description":"Reaction score. If not specified reaction has score of 1","format":"int32","title":"Score","type":"integer","x-stream-index":"002"},"type":{"description":"The type of reaction (e.g. 'like', 'laugh', 'wow')","maxLength":30,"title":"Type","type":"string","x-stream-index":"001"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"004"}},"required":["type"],"title":"Reaction","type":"object","x-stream-docs-page-id":"send_reaction"},"ReactionResponse":{"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"006"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"008"},"message_id":{"description":"Message ID","title":"Message ID","type":"string","x-stream-index":"001"},"score":{"description":"Score of the reaction","format":"int32","title":"Score","type":"integer","x-stream-index":"005"},"type":{"description":"Type of reaction","title":"Type","type":"string","x-stream-index":"004"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"007"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User","title":"UserResponse","x-stream-index":"003"},"user_id":{"description":"User ID","title":"User ID","type":"string","x-stream-index":"002"}},"required":["message_id","user_id","user","type","score","created_at","updated_at","custom"],"type":"object"},"ReactionUpdatedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"006.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"002"},"team":{"type":"string","x-stream-index":"005.001"},"type":{"default":"reaction.updated","type":"string","x-stream-index":"006.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["message","reaction","cid","channel_id","channel_type","type","created_at"],"title":"ReactionUpdatedEvent","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"},"ReadReceipts":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"ReadReceiptsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"ReadStateResponse":{"properties":{"last_read":{"format":"date-time","type":"string","x-stream-index":"002"},"last_read_message_id":{"type":"string","x-stream-index":"004"},"unread_messages":{"format":"int32","type":"integer","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"}},"required":["user","last_read","unread_messages"],"type":"object"},"ReminderCreatedEvent":{"description":"Emitted when a reminder is created.","nullable":true,"properties":{"cid":{"description":"The CID of the Channel for which the reminder was created","title":"Channel CID","type":"string","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.007"},"message_id":{"description":"The ID of the message for which the reminder was created","title":"Message ID","type":"string","x-stream-index":"001.002"},"parent_id":{"description":"The ID of the parent message, if the reminder is for a thread message","title":"Parent ID","type":"string","x-stream-index":"001.005"},"received_at":{"format":"date-time","type":"string","x-stream-index":"001.001.004"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","description":"The reminder object which was created","title":"MessageReminder","x-stream-index":"001.006"},"type":{"default":"reminder.created","description":"The type of event: \"reminder.created\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.002"},"user_id":{"description":"The ID of the user for whom the reminder was created","title":"User ID","type":"string","x-stream-index":"001.003"}},"required":["type","created_at","custom","message_id","user_id","cid"],"title":"ReminderCreatedEvent","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"},"ReminderDeletedEvent":{"description":"Emitted when a reminder is deleted.","nullable":true,"properties":{"cid":{"description":"The CID of the Channel for which the reminder was created","title":"Channel CID","type":"string","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.007"},"message_id":{"description":"The ID of the message for which the reminder was created","title":"Message ID","type":"string","x-stream-index":"001.002"},"parent_id":{"description":"The ID of the parent message, if the reminder is for a thread message","title":"Parent ID","type":"string","x-stream-index":"001.005"},"received_at":{"format":"date-time","type":"string","x-stream-index":"001.001.004"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","description":"The reminder object which was created","title":"MessageReminder","x-stream-index":"001.006"},"type":{"default":"reminder.deleted","description":"The type of event: \"reminder.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.002"},"user_id":{"description":"The ID of the user for whom the reminder was created","title":"User ID","type":"string","x-stream-index":"001.003"}},"required":["type","created_at","custom","message_id","user_id","cid"],"title":"ReminderDeletedEvent","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"},"ReminderNotificationEvent":{"description":"Emitted when a reminder becomes due, triggering a notification for the user.","nullable":true,"properties":{"cid":{"description":"The CID of the Channel for which the reminder was created","title":"Channel CID","type":"string","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.007"},"message_id":{"description":"The ID of the message for which the reminder was created","title":"Message ID","type":"string","x-stream-index":"001.002"},"parent_id":{"type":"string","x-stream-index":"001.005"},"received_at":{"format":"date-time","type":"string","x-stream-index":"001.001.004"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","description":"The reminder object which was created","title":"MessageReminder","x-stream-index":"001.006"},"type":{"default":"notification.reminder_due","description":"The type of event: \"notification.reminder_due\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.002"},"user_id":{"description":"The ID of the user for whom the reminder was created","title":"User ID","type":"string","x-stream-index":"001.003"}},"required":["type","created_at","custom","message_id","user_id","cid"],"title":"ReminderNotificationEvent","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"},"ReminderResponseData":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003"},"channel_cid":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"string","x-stream-index":"008"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"005"},"message_id":{"type":"string","x-stream-index":"004"},"remind_at":{"format":"date-time","type":"string","x-stream-index":"001"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007"},"user_id":{"type":"string","x-stream-index":"006"}},"required":["channel_cid","message_id","user_id","created_at","updated_at"],"type":"object"},"ReminderUpdatedEvent":{"description":"Emitted when a reminder is updated.","nullable":true,"properties":{"cid":{"description":"The CID of the Channel for which the reminder was created","title":"Channel CID","type":"string","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.007"},"message_id":{"description":"The ID of the message for which the reminder was created","title":"Message ID","type":"string","x-stream-index":"001.002"},"parent_id":{"description":"The ID of the parent message, if the reminder is for a thread message","title":"Parent ID","type":"string","x-stream-index":"001.005"},"received_at":{"format":"date-time","type":"string","x-stream-index":"001.001.004"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","description":"The reminder object which was created","title":"MessageReminder","x-stream-index":"001.006"},"type":{"default":"reminder.updated","description":"The type of event: \"reminder.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.002"},"user_id":{"description":"The ID of the user for whom the reminder was created","title":"User ID","type":"string","x-stream-index":"001.003"}},"required":["type","created_at","custom","message_id","user_id","cid"],"title":"ReminderUpdatedEvent","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"},"Response":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001"}},"required":["duration"],"title":"Response","type":"object"},"SearchPayload":{"properties":{"filter_conditions":{"additionalProperties":{},"description":"Channel filter conditions","maximum":100,"minimum":1,"title":"Channel filter","type":"object","x-stream-docs-page-id":"query_channels","x-stream-index":"002"},"limit":{"description":"Number of messages to return","format":"int32","title":"Limit","type":"integer","x-stream-index":"005"},"message_filter_conditions":{"additionalProperties":{},"description":"Message filter conditions","title":"Message filter","type":"object","x-stream-index":"003"},"message_options":{"$ref":"#/components/schemas/MessageOptions","x-stream-index":"004"},"next":{"description":"Pagination parameter. Cannot be used with non-zero offset.","title":"Next","type":"string","x-stream-index":"008"},"offset":{"description":"Pagination offset. Cannot be used with sort or next.","format":"int32","title":"Offset","type":"integer","x-stream-index":"006"},"query":{"description":"Search phrase","title":"Query","type":"string","x-stream-index":"001"},"sort":{"description":"Sort parameters. Cannot be used with non-zero offset","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"007"}},"required":["filter_conditions"],"type":"object"},"SearchResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"005.001"},"next":{"description":"Value to pass to the next search query in order to paginate","title":"Next","type":"string","x-stream-index":"003"},"previous":{"description":"Value that points to the previous page. Pass as the next value in a search query to paginate backwards","title":"Previous","type":"string","x-stream-index":"004"},"results":{"description":"Search results","items":{"$ref":"#/components/schemas/SearchResult"},"title":"Results","type":"array","x-stream-index":"001"},"results_warning":{"$ref":"#/components/schemas/SearchWarning","description":"Warning about the search results","title":"Results Warning","x-stream-index":"002"}},"required":["results","duration"],"type":"object"},"SearchResult":{"properties":{"message":{"$ref":"#/components/schemas/SearchResultMessage","description":"Found message","title":"Message","x-stream-index":"001"}},"type":"object"},"SearchResultMessage":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"001.008"},"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel object","title":"Channel","x-stream-index":"002"},"cid":{"type":"string","x-stream-index":"001.022"},"command":{"type":"string","x-stream-index":"001.004"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.023"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.026"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"001.025"},"deleted_for_me":{"type":"boolean","x-stream-index":"001.044"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"001.018"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001.041"},"html":{"type":"string","x-stream-index":"001.005"},"i18n":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.030"},"id":{"type":"string","x-stream-index":"001.001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"001.028"},"latest_reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"001.009"},"mentioned_users":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"001.029"},"message_text_updated_at":{"format":"date-time","type":"string","x-stream-index":"001.036"},"mml":{"type":"string","x-stream-index":"001.003"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"001.039"},"own_reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"001.010"},"parent_id":{"type":"string","x-stream-index":"001.015"},"pin_expires":{"format":"date-time","type":"string","x-stream-index":"001.035"},"pinned":{"type":"boolean","x-stream-index":"001.032"},"pinned_at":{"format":"date-time","type":"string","x-stream-index":"001.033"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001.034"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001.038"},"poll_id":{"type":"string","x-stream-index":"001.037"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001.020"},"quoted_message_id":{"type":"string","x-stream-index":"001.019"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001.011"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"001.014"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001.012"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"001.042"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"001.017"},"restricted_visibility":{"items":{"type":"string"},"type":"array","x-stream-index":"001.040"},"shadowed":{"type":"boolean","x-stream-index":"001.027"},"shared_location":{"$ref":"#/components/schemas/SharedLocationResponseData","x-stream-index":"001.043"},"show_in_channel":{"type":"boolean","x-stream-index":"001.016"},"silent":{"type":"boolean","x-stream-index":"001.031"},"text":{"type":"string","x-stream-index":"001.002"},"thread_participants":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"001.021"},"type":{"type":"string","x-stream-index":"001.006"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"001.024"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001.007"}},"required":["id","text","html","type","user","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned","restricted_visibility"],"type":"object"},"SearchWarning":{"properties":{"channel_search_cids":{"description":"Channel CIDs for the searched channels","items":{"type":"string"},"title":"Channel Search CIDs","type":"array","x-stream-index":"004"},"channel_search_count":{"description":"Number of channels searched","format":"int32","title":"Channel Search Count","type":"integer","x-stream-index":"003"},"warning_code":{"description":"Code corresponding to the warning","format":"int32","title":"Warning Code","type":"integer","x-stream-index":"002"},"warning_description":{"description":"Description of the warning","title":"Warning Description","type":"string","x-stream-index":"001"}},"required":["warning_description","warning_code"],"type":"object"},"SendEventRequest":{"nullable":true,"properties":{"event":{"$ref":"#/components/schemas/EventRequest","x-stream-index":"001"}},"required":["event"],"type":"object"},"SendMessageRequest":{"nullable":true,"properties":{"keep_channel_hidden":{"type":"boolean","x-stream-index":"008"},"message":{"$ref":"#/components/schemas/MessageRequest","x-stream-index":"001"},"skip_enrich_url":{"type":"boolean","x-stream-index":"003"},"skip_push":{"type":"boolean","x-stream-index":"002"}},"required":["message"],"type":"object"},"SendMessageResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Message response","title":"Message","x-stream-index":"001"},"pending_message_metadata":{"additionalProperties":{"type":"string"},"description":"Pending message metadata","title":"Pending message metadata","type":"object","x-stream-index":"002"}},"required":["message","duration"],"type":"object"},"SendReactionRequest":{"nullable":true,"properties":{"enforce_unique":{"description":"Whether to replace all existing user reactions","title":"Enforce unique","type":"boolean","x-stream-index":"003"},"reaction":{"$ref":"#/components/schemas/ReactionRequest","x-stream-index":"002"},"skip_push":{"description":"Skips any mobile push notifications","title":"Skip push","type":"boolean","x-stream-index":"004"}},"required":["reaction"],"type":"object"},"SendReactionResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001"},"reaction":{"$ref":"#/components/schemas/ReactionResponse","x-stream-index":"002"}},"required":["message","reaction","duration"],"title":"Response","type":"object"},"SharedLocation":{"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"013"},"channel_cid":{"type":"string","x-stream-index":"003"},"created_at":{"format":"date-time","type":"string","x-stream-index":"010"},"created_by_device_id":{"type":"string","x-stream-index":"008"},"end_at":{"format":"date-time","type":"string","x-stream-index":"009"},"latitude":{"format":"float","maximum":90,"minimum":18446744073709552000,"type":"number","x-stream-index":"006"},"longitude":{"format":"float","maximum":180,"minimum":18446744073709552000,"type":"number","x-stream-index":"007"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"012"},"message_id":{"type":"string","x-stream-index":"004"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"011"},"user_id":{"type":"string","x-stream-index":"005"}},"required":["channel_cid","message_id","user_id","created_by_device_id","created_at","updated_at"],"type":"object"},"SharedLocationResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001.011"},"channel_cid":{"description":"Channel CID","title":"string","type":"string","x-stream-index":"001.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.008"},"created_by_device_id":{"description":"Device ID that created the live location","title":"string","type":"string","x-stream-index":"001.006"},"duration":{"type":"string","x-stream-index":"002.001"},"end_at":{"description":"Time when the live location expires","format":"date-time","title":"string","type":"string","x-stream-index":"001.007"},"latitude":{"description":"Latitude coordinate","format":"float","title":"number","type":"number","x-stream-index":"001.004"},"longitude":{"description":"Longitude coordinate","format":"float","title":"number","type":"number","x-stream-index":"001.005"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001.010"},"message_id":{"description":"Message ID","title":"string","type":"string","x-stream-index":"001.002"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"001.009"},"user_id":{"description":"User ID","title":"string","type":"string","x-stream-index":"001.003"}},"required":["channel_cid","message_id","user_id","latitude","longitude","created_by_device_id","created_at","updated_at","duration"],"type":"object"},"SharedLocationResponseData":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"011"},"channel_cid":{"type":"string","x-stream-index":"001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"008"},"created_by_device_id":{"type":"string","x-stream-index":"006"},"end_at":{"format":"date-time","type":"string","x-stream-index":"007"},"latitude":{"format":"float","type":"number","x-stream-index":"004"},"longitude":{"format":"float","type":"number","x-stream-index":"005"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"010"},"message_id":{"type":"string","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"009"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["channel_cid","message_id","user_id","latitude","longitude","created_by_device_id","created_at","updated_at"],"type":"object"},"SharedLocationsResponse":{"nullable":true,"properties":{"active_live_locations":{"items":{"$ref":"#/components/schemas/SharedLocationResponseData"},"type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["active_live_locations","duration"],"type":"object"},"ShowChannelRequest":{"nullable":true,"type":"object"},"ShowChannelResponse":{"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"},"SortParamRequest":{"nullable":true,"properties":{"direction":{"description":"Direction of sorting, 1 for Ascending, -1 for Descending, default is 1","format":"int32","title":"Direction","type":"integer","x-stream-index":"002"},"field":{"description":"Name of field to sort by","title":"Field","type":"string","x-stream-index":"001"}},"type":"object"},"SyncRequest":{"description":"Sync request","nullable":true,"properties":{"channel_cids":{"description":"List of channel CIDs to sync","items":{"type":"string"},"maximum":255,"minimum":1,"title":"Channel CIDs","type":"array","x-stream-index":"001"},"last_sync_at":{"description":"Date from which synchronization should happen","format":"date-time","title":"Last sync at","type":"string","x-stream-index":"002"}},"required":["channel_cids","last_sync_at"],"title":"SyncRequest","type":"object"},"SyncResponse":{"description":"Sync response","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"events":{"description":"List of events","items":{"$ref":"#/components/schemas/WSEvent"},"title":"Events","type":"array","x-stream-index":"001"},"inaccessible_cids":{"description":"List of CIDs that user can't access","items":{"type":"string"},"title":"Inaccessible CIDs","type":"array","x-stream-index":"002"}},"required":["events","duration"],"title":"SyncResponse","type":"object"},"ThreadParticipant":{"description":"Represents a user that is participating in a thread.","nullable":true,"properties":{"app_pk":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"001"},"channel_cid":{"type":"string","x-stream-index":"002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"007"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"last_read_at":{"format":"date-time","type":"string","x-stream-index":"009"},"last_thread_message_at":{"format":"date-time","type":"string","x-stream-index":"003"},"left_thread_at":{"description":"Left Thread At is the time when the user left the thread","format":"date-time","title":"Left Thread At","type":"string","x-stream-index":"008"},"thread_id":{"description":"Thead ID is unique string identifier of the thread","title":"ID","type":"string","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User is the user object","title":"User","x-stream-index":"006"},"user_id":{"description":"User ID is unique string identifier of the user","title":"User ID","type":"string","x-stream-index":"005"}},"required":["app_pk","channel_cid","created_at","last_read_at","custom"],"title":"ThreadParticipant","type":"object"},"ThreadResponse":{"properties":{"active_participant_count":{"description":"Active Participant Count","format":"int32","title":"Active Participant Count","type":"integer","x-stream-index":"009"},"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel","title":"ChannelResponse","x-stream-index":"002"},"channel_cid":{"description":"Channel CID","title":"Channel CID","type":"string","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"012"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"Created By User","title":"User","x-stream-index":"006"},"created_by_user_id":{"description":"Created By User ID","title":"Created By User ID","type":"string","x-stream-index":"005"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"016"},"deleted_at":{"description":"Deleted At","format":"date-time","title":"Deleted At","type":"string","x-stream-index":"014"},"last_message_at":{"description":"Last Message At","format":"date-time","title":"Last Message At","type":"string","x-stream-index":"011"},"parent_message":{"$ref":"#/components/schemas/MessageResponse","description":"Parent Message","title":"Message","x-stream-index":"004"},"parent_message_id":{"description":"Parent Message ID","title":"Parent Message ID","type":"string","x-stream-index":"003"},"participant_count":{"description":"Participant Count","format":"int32","title":"Participant Count","type":"integer","x-stream-index":"008"},"reply_count":{"description":"Reply Count","format":"int32","title":"Reply Count","type":"integer","x-stream-index":"007"},"thread_participants":{"description":"Thread Participants","items":{"$ref":"#/components/schemas/ThreadParticipant"},"title":"ThreadParticipants","type":"array","x-stream-index":"010"},"title":{"description":"Title","title":"Title","type":"string","x-stream-index":"015"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"013"}},"required":["channel_cid","parent_message_id","created_by_user_id","created_at","updated_at","title","custom"],"type":"object"},"ThreadStateResponse":{"nullable":true,"properties":{"active_participant_count":{"description":"Active Participant Count","format":"int32","title":"Active Participant Count","type":"integer","x-stream-index":"001.009"},"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel","title":"ChannelResponse","x-stream-index":"001.002"},"channel_cid":{"description":"Channel CID","title":"Channel CID","type":"string","x-stream-index":"001.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.012"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"Created By User","title":"User","x-stream-index":"001.006"},"created_by_user_id":{"description":"Created By User ID","title":"Created By User ID","type":"string","x-stream-index":"001.005"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"001.016"},"deleted_at":{"description":"Deleted At","format":"date-time","title":"Deleted At","type":"string","x-stream-index":"001.014"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"004"},"last_message_at":{"description":"Last Message At","format":"date-time","title":"Last Message At","type":"string","x-stream-index":"001.011"},"latest_replies":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","x-stream-index":"002"},"parent_message":{"$ref":"#/components/schemas/MessageResponse","description":"Parent Message","title":"Message","x-stream-index":"001.004"},"parent_message_id":{"description":"Parent Message ID","title":"Parent Message ID","type":"string","x-stream-index":"001.003"},"participant_count":{"description":"Participant Count","format":"int32","title":"Participant Count","type":"integer","x-stream-index":"001.008"},"read":{"items":{"$ref":"#/components/schemas/ReadStateResponse"},"type":"array","x-stream-index":"003"},"reply_count":{"description":"Reply Count","format":"int32","title":"Reply Count","type":"integer","x-stream-index":"001.007"},"thread_participants":{"description":"Thread Participants","items":{"$ref":"#/components/schemas/ThreadParticipant"},"title":"ThreadParticipants","type":"array","x-stream-index":"001.010"},"title":{"description":"Title","title":"Title","type":"string","x-stream-index":"001.015"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"001.013"}},"required":["channel_cid","parent_message_id","created_by_user_id","created_at","updated_at","title","custom","latest_replies"],"type":"object"},"ThreadUpdatedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"001.002"},"channel_type":{"type":"string","x-stream-index":"001.003"},"cid":{"type":"string","x-stream-index":"001.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"004.002"},"thread":{"$ref":"#/components/schemas/ThreadResponse","x-stream-index":"003.001"},"type":{"default":"thread.updated","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"ThreadUpdatedEvent","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"},"Thresholds":{"description":"Sets thresholds for AI moderation","properties":{"explicit":{"$ref":"#/components/schemas/LabelThresholds","description":"Thresholds for explicit messages","title":"LabelThresholds","x-stream-index":"001"},"spam":{"$ref":"#/components/schemas/LabelThresholds","description":"Thresholds for spam","title":"LabelThresholds","x-stream-index":"002"},"toxic":{"$ref":"#/components/schemas/LabelThresholds","description":"Thresholds for toxic messages","title":"LabelThresholds","x-stream-index":"003"}},"title":"Auto moderation thresholds","type":"object"},"TranslateMessageRequest":{"nullable":true,"properties":{"language":{"description":"Language to translate message to","enum":["af","sq","am","ar","az","bn","bs","bg","zh","zh-TW","hr","cs","da","fa-AF","nl","en","et","fi","fr","fr-CA","ka","de","el","ha","he","hi","hu","id","it","ja","ko","lv","ms","no","fa","ps","pl","pt","ro","ru","sr","sk","sl","so","es","es-MX","sw","sv","tl","ta","th","tr","uk","ur","vi","lt","ht"],"title":"Language","type":"string","x-stream-index":"001"}},"required":["language"],"type":"object"},"TruncateChannelRequest":{"nullable":true,"properties":{"hard_delete":{"description":"Permanently delete channel data (messages, reactions, etc.)","title":"Hard delete","type":"boolean","x-stream-index":"002"},"member_ids":{"description":"List of member IDs to hide message history for. If empty, truncates the channel for all members","items":{"type":"string"},"maximum":100,"title":"Member IDs","type":"array","x-stream-index":"007"},"message":{"$ref":"#/components/schemas/MessageRequest","x-stream-index":"004"},"skip_push":{"description":"When `message` is set disables all push notifications for it","title":"Skip push","type":"boolean","x-stream-index":"005"},"truncated_at":{"description":"Truncate channel data up to `truncated_at`. The system message (if provided) creation time is always greater than `truncated_at`","format":"date-time","title":"Truncated at","type":"string","x-stream-index":"006"}},"type":"object"},"TruncateChannelResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Truncated channel object","title":"Channel","x-stream-index":"002"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Truncated message object","title":"Message","x-stream-index":"003"}},"required":["duration"],"type":"object"},"TypingIndicators":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"TypingIndicatorsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"TypingStartEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"004.002"},"parent_id":{"type":"string","x-stream-index":"001"},"type":{"default":"typing.start","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"TypingStartEvent","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"},"TypingStopEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"004.002"},"parent_id":{"type":"string","x-stream-index":"001"},"type":{"default":"typing.stop","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"TypingStopEvent","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"},"UnblockUsersRequest":{"nullable":true,"properties":{"blocked_user_id":{"type":"string","x-stream-index":"001"}},"required":["blocked_user_id"],"type":"object"},"UnblockUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"UnmuteChannelRequest":{"nullable":true,"properties":{"channel_cids":{"description":"Channel CIDs to mute (if multiple channels)","items":{"type":"string"},"maximum":25,"title":"Channel CIDs","type":"array","x-stream-index":"001.002"},"expiration":{"description":"Duration of mute in milliseconds","title":"Expiration","type":"integer","x-stream-index":"001.003"}},"type":"object"},"UnmuteResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"non_existing_users":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"required":["duration"],"title":"Response","type":"object"},"UnmuteUserRequest":{"nullable":true,"properties":{"target_ids":{"description":"User IDs to mute (if multiple users)","items":{"type":"string"},"maximum":1000,"title":"Target IDs","type":"array","x-stream-index":"001.002"},"timeout":{"description":"Duration of mute in minutes","minimum":0,"title":"Timeout","type":"integer","x-stream-index":"001.003"}},"required":["timeout"],"type":"object"},"UnreadCountsChannel":{"properties":{"channel_id":{"type":"string","x-stream-index":"001"},"last_read":{"format":"date-time","type":"string","x-stream-index":"003"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["channel_id","unread_count","last_read"],"type":"object"},"UnreadCountsChannelType":{"properties":{"channel_count":{"format":"int32","type":"integer","x-stream-index":"002"},"channel_type":{"type":"string","x-stream-index":"001"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["channel_type","channel_count","unread_count"],"type":"object"},"UnreadCountsThread":{"properties":{"last_read":{"format":"date-time","type":"string","x-stream-index":"002"},"last_read_message_id":{"type":"string","x-stream-index":"003"},"parent_message_id":{"type":"string","x-stream-index":"004"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"001"}},"required":["unread_count","last_read","last_read_message_id","parent_message_id"],"type":"object"},"UpdateBlockListRequest":{"nullable":true,"properties":{"team":{"type":"string","x-stream-index":"002"},"words":{"description":"List of words to block","items":{"type":"string"},"minimum":1,"title":"Words","type":"array","x-stream-index":"003"}},"title":"Update block list","type":"object","x-stream-docs-page-id":"update_block_list"},"UpdateBlockListResponse":{"description":"Basic response information","nullable":true,"properties":{"blocklist":{"$ref":"#/components/schemas/BlockListResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["duration"],"title":"Response","type":"object"},"UpdateChannelPartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"type":"object","x-stream-index":"002.001"},"unset":{"items":{"type":"string"},"type":"array","x-stream-index":"002.002"}},"title":"UpdateChannelPartialRequest","type":"object"},"UpdateChannelPartialResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Updated channel object","title":"Channel","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"members":{"description":"List of updated members","items":{"$ref":"#/components/schemas/ChannelMemberResponse"},"title":"ChannelMemberResponse","type":"array","x-stream-index":"002"}},"required":["members","duration"],"type":"object"},"UpdateChannelRequest":{"nullable":true,"properties":{"accept_invite":{"description":"Set to `true` to accept the invite","title":"Accept invite","type":"boolean","x-stream-index":"008"},"add_members":{"description":"List of user IDs to add to the channel","items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"title":"Add members","type":"array","x-stream-index":"001"},"add_moderators":{"description":"List of user IDs to make channel moderators","items":{"type":"string"},"maximum":100,"title":"Add moderators","type":"array","x-stream-index":"003"},"assign_roles":{"description":"List of channel member role assignments. If any specified user is not part of the channel, the request will fail","items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"title":"Assign roles","type":"array","x-stream-index":"006"},"cooldown":{"description":"Sets cool down period for the channel in seconds","format":"int32","maximum":120,"minimum":0,"title":"Cool down","type":"integer","x-stream-index":"007"},"data":{"$ref":"#/components/schemas/ChannelInput","x-stream-index":"013.001"},"demote_moderators":{"description":"List of user IDs to take away moderators status from","items":{"type":"string"},"maximum":100,"title":"Demote moderators","type":"array","x-stream-index":"004"},"hide_history":{"description":"Set to `true` to hide channel's history when adding new members","title":"Hide history","type":"boolean","x-stream-index":"012"},"invites":{"description":"List of user IDs to invite to the channel","items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"title":"Invites","type":"array","x-stream-index":"005"},"message":{"$ref":"#/components/schemas/MessageRequest","description":"Message to send to the chat when channel is successfully updated","title":"Message","x-stream-index":"010"},"reject_invite":{"description":"Set to `true` to reject the invite","title":"Reject invite","type":"boolean","x-stream-index":"009"},"remove_members":{"description":"List of user IDs to remove from the channel","items":{"type":"string"},"maximum":100,"title":"Remove members","type":"array","x-stream-index":"002"},"skip_push":{"description":"When `message` is set disables all push notifications for it","title":"Skip push","type":"boolean","x-stream-index":"011"}},"title":"Channel update request","type":"object","x-stream-docs-page-id":"channel_update"},"UpdateChannelResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Updated channel","title":"Channel","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"004.001"},"members":{"description":"List of channel members","items":{"$ref":"#/components/schemas/ChannelMember"},"title":"Members","type":"array","x-stream-index":"003"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Message sent to the chat","title":"Message","x-stream-index":"002"}},"required":["members","duration"],"type":"object"},"UpdateLiveLocationRequest":{"nullable":true,"properties":{"end_at":{"description":"Time when the live location expires","format":"date-time","title":"string","type":"string","x-stream-index":"004"},"latitude":{"description":"Latitude coordinate","format":"float","maximum":90,"minimum":18446744073709552000,"title":"number","type":"number","x-stream-index":"002"},"longitude":{"description":"Longitude coordinate","format":"float","maximum":180,"minimum":18446744073709552000,"title":"number","type":"number","x-stream-index":"003"},"message_id":{"description":"Live location ID","title":"string","type":"string","x-stream-index":"001"}},"required":["message_id"],"type":"object"},"UpdateMemberPartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"type":"object","x-stream-index":"002.001"},"unset":{"items":{"type":"string"},"type":"array","x-stream-index":"002.002"}},"type":"object"},"UpdateMemberPartialResponse":{"nullable":true,"properties":{"channel_member":{"$ref":"#/components/schemas/ChannelMemberResponse","description":"Updated channel member","title":"Channel member","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["duration"],"type":"object"},"UpdateMessagePartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"description":"Sets new field values","title":"Set","type":"object","x-stream-index":"002.001","x-stream-map":{"key":"field","title":"Value","description":"New value to set"}},"skip_enrich_url":{"description":"Skip enriching the URL in the message","title":"SkipEnrichURL","type":"boolean","x-stream-index":"001"},"unset":{"description":"Array of field names to unset","items":{"type":"string"},"title":"Unset","type":"array","x-stream-index":"002.002"}},"type":"object"},"UpdateMessagePartialResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Updated message","title":"Message","x-stream-index":"001"},"pending_message_metadata":{"additionalProperties":{"type":"string"},"description":"Pending message metadata","title":"PendingMessageMetadata","type":"object","x-stream-index":"002"}},"required":["duration"],"type":"object"},"UpdateMessageRequest":{"nullable":true,"properties":{"message":{"$ref":"#/components/schemas/MessageRequest","description":"Message","title":"MessageRequest","x-stream-index":"001"},"skip_enrich_url":{"description":"Skip enrich URL","title":"boolean","type":"boolean","x-stream-index":"003"},"skip_push":{"type":"boolean","x-stream-index":"002"}},"required":["message"],"type":"object"},"UpdateMessageResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001"},"pending_message_metadata":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"002"}},"required":["message","duration"],"title":"Response","type":"object"},"UpdatePollOptionRequest":{"nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"004"},"id":{"description":"Option ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"},"text":{"description":"Option text","title":"string","type":"string","x-stream-index":"003"}},"required":["id","text"],"type":"object"},"UpdatePollPartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"description":"Sets new field values","title":"Set","type":"object","x-stream-index":"002.001","x-stream-map":{"key":"field","title":"Value","description":"New value to set"}},"unset":{"description":"Array of field names to unset","items":{"type":"string"},"title":"Unset","type":"array","x-stream-index":"002.002"}},"type":"object"},"UpdatePollRequest":{"nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"011"},"allow_answers":{"description":"Allow answers","title":"boolean","type":"boolean","x-stream-index":"009"},"allow_user_suggested_options":{"description":"Allow user suggested options","title":"boolean","type":"boolean","x-stream-index":"008"},"description":{"description":"Poll description","title":"string","type":"string","x-stream-index":"003"},"enforce_unique_vote":{"description":"Enforce unique vote","title":"boolean","type":"boolean","x-stream-index":"005"},"id":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"},"is_closed":{"description":"Is closed","title":"boolean","type":"boolean","x-stream-index":"010"},"max_votes_allowed":{"description":"Max votes allowed","format":"int32","maximum":10,"title":"integer","type":"integer","x-stream-index":"007"},"name":{"description":"Poll name","title":"string","type":"string","x-stream-index":"002"},"options":{"description":"Poll options","items":{"$ref":"#/components/schemas/PollOptionRequest"},"maximum":100,"title":"PollOptions","type":"array","x-stream-index":"004"},"voting_visibility":{"description":"Voting visibility","enum":["anonymous","public"],"title":"string","type":"string","x-stream-index":"006"}},"required":["id","name"],"type":"object"},"UpdateReminderRequest":{"nullable":true,"properties":{"remind_at":{"format":"date-time","type":"string","x-stream-index":"001"}},"type":"object"},"UpdateReminderResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"001"}},"required":["reminder","duration"],"title":"Response","type":"object"},"UpdateThreadPartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"description":"Sets new field values","title":"Set","type":"object","x-stream-index":"004.001","x-stream-map":{"key":"field","title":"Value","description":"New value to set"}},"unset":{"description":"Array of field names to unset","items":{"type":"string"},"title":"Unset","type":"array","x-stream-index":"004.002"}},"type":"object"},"UpdateThreadPartialResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"thread":{"$ref":"#/components/schemas/ThreadResponse","description":"Updated thread (not enriched)","title":"Thread","x-stream-index":"001"}},"required":["thread","duration"],"type":"object"},"UpdateUserPartialRequest":{"properties":{"id":{"description":"User ID to update","title":"ID","type":"string","x-stream-index":"001"},"set":{"additionalProperties":{},"type":"object","x-stream-index":"002.001"},"unset":{"items":{"type":"string"},"type":"array","x-stream-index":"002.002"}},"required":["id"],"type":"object"},"UpdateUsersPartialRequest":{"nullable":true,"properties":{"users":{"items":{"$ref":"#/components/schemas/UpdateUserPartialRequest"},"maximum":100,"type":"array","x-stream-index":"001"}},"required":["users"],"type":"object"},"UpdateUsersRequest":{"nullable":true,"properties":{"users":{"additionalProperties":{"$ref":"#/components/schemas/UserRequest"},"description":"Object containing users","title":"Users","type":"object","x-stream-index":"001","x-stream-map":{"key":"user_id"}}},"required":["users"],"type":"object"},"UpdateUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"membership_deletion_task_id":{"type":"string","x-stream-index":"002"},"users":{"additionalProperties":{"$ref":"#/components/schemas/FullUserResponse"},"description":"Object containing users","title":"Users","type":"object","x-stream-index":"001","x-stream-map":{"key":"user_id"}}},"required":["users","membership_deletion_task_id","duration"],"type":"object"},"UpsertPushPreferencesRequest":{"nullable":true,"properties":{"preferences":{"description":"A list of push preferences for channels, calls, or the user.","items":{"$ref":"#/components/schemas/PushPreferenceInput"},"type":"array","x-stream-index":"001"}},"required":["preferences"],"type":"object"},"UpsertPushPreferencesResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"user_channel_preferences":{"additionalProperties":{"additionalProperties":{"$ref":"#/components/schemas/ChannelPushPreferences"},"type":"object"},"description":"The channel specific push notification preferences, only returned for channels you've edited.","title":"User Channel Notification Preferences","type":"object","x-stream-index":"002"},"user_preferences":{"additionalProperties":{"$ref":"#/components/schemas/PushPreferences"},"description":"The user preferences, always returned regardless if you edited it","title":"User Preferences","type":"object","x-stream-index":"001"}},"required":["user_preferences","user_channel_preferences","duration"],"type":"object"},"User":{"properties":{"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"046"},"ban_expires":{"format":"date-time","type":"string","x-stream-index":"017"},"banned":{"type":"boolean","x-stream-index":"016"},"created_at":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"013"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"023"},"language":{"type":"string","x-stream-index":"035"},"last_active":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"026"},"revoke_tokens_issued_before":{"format":"date-time","type":"string","x-stream-index":"042"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"005"},"updated_at":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"009"}},"required":["id","role","teams_role","custom","banned","online"],"type":"object"},"UserBannedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"006.002"},"channel_type":{"type":"string","x-stream-index":"006.003"},"cid":{"type":"string","x-stream-index":"006.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"008.002"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"001"},"expiration":{"format":"date-time","type":"string","x-stream-index":"003"},"reason":{"type":"string","x-stream-index":"004"},"shadow":{"type":"boolean","x-stream-index":"002"},"team":{"type":"string","x-stream-index":"005.001"},"type":{"default":"user.banned","type":"string","x-stream-index":"008.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007.001"}},"required":["created_by","shadow","cid","channel_id","channel_type","type","created_at"],"title":"UserBannedEvent","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"},"UserDeactivatedEvent":{"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"003.002"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"001"},"type":{"default":"user.deactivated","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["created_by","type","created_at"],"title":"UserDeactivatedEvent","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"},"UserDeletedEvent":{"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"002.002"},"delete_conversation_channels":{"type":"boolean","x-stream-index":"005"},"hard_delete":{"type":"boolean","x-stream-index":"003.001"},"mark_messages_deleted":{"type":"boolean","x-stream-index":"004"},"type":{"default":"user.deleted","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"001.001"}},"required":["type","created_at","hard_delete","mark_messages_deleted","delete_conversation_channels"],"title":"UserDeletedEvent","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"},"UserMessagesDeletedEvent":{"description":"This event is sent when a user's message get deleted. The event contains information about the user whose messages got deleted.","nullable":true,"properties":{"channel_custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.005"},"channel_id":{"description":"The ID of the channel where the target user's messages were deleted","title":"Channel ID","type":"string","x-stream-index":"001.002.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"001.001.004"},"channel_type":{"description":"The type of the channel where the target user's messages were deleted","title":"Channel Type","type":"string","x-stream-index":"001.002.001"},"cid":{"description":"The CID of the channel where the target user's messages were deleted","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"},"hard_delete":{"description":"Whether Messages were hard deleted","title":"Hard Delete","type":"boolean","x-stream-index":"003"},"received_at":{"format":"date-time","type":"string","x-stream-index":"001.001.001.001.004"},"team":{"description":"The team of the channel where the target user's messages were deleted","title":"Team","type":"string","x-stream-index":"001.001.003"},"type":{"default":"user.messages.deleted","description":"The type of event: \"user.messages.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.001.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The target user whose messages got deleted","title":"User","x-stream-index":"002.001"}},"required":["type","created_at","custom","user"],"title":"UserMessagesDeletedEvent","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"},"UserMute":{"nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"009"},"expires":{"description":"Date/time of mute expiration","format":"date-time","title":"Expires","type":"string","x-stream-index":"008"},"target":{"$ref":"#/components/schemas/User","description":"User who's muted","title":"Target","x-stream-index":"007"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/User","description":"Owner of channel mute","title":"User","x-stream-index":"005"}},"required":["created_at","updated_at"],"type":"object"},"UserMuteResponse":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"004"},"expires":{"format":"date-time","type":"string","x-stream-index":"003"},"target":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"}},"required":["created_at","updated_at"],"type":"object"},"UserMutedEvent":{"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"004.002"},"target_user":{"type":"string","x-stream-index":"001"},"target_users":{"items":{"type":"string"},"type":"array","x-stream-index":"002"},"type":{"default":"user.muted","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"UserMutedEvent","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"},"UserPresenceChangedEvent":{"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"002.002"},"type":{"default":"user.presence.changed","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"001.001"}},"required":["type","created_at"],"title":"UserPresenceChangedEvent","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"},"UserReactivatedEvent":{"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"002.002"},"type":{"default":"user.reactivated","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"001"}},"required":["type","created_at"],"title":"UserReactivatedEvent","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"},"UserRequest":{"description":"User request object","properties":{"custom":{"additionalProperties":{},"description":"Custom user data","title":"Custom","type":"object","x-stream-index":"004"},"id":{"description":"User ID","title":"ID","type":"string","x-stream-index":"001"},"image":{"description":"User's profile image URL","title":"Image","type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"006"},"language":{"type":"string","x-stream-index":"005"},"name":{"description":"Optional name of user","title":"Name","type":"string","x-stream-index":"002"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"007"}},"required":["id"],"title":"UserRequest","type":"object"},"UserResponse":{"description":"User response object","properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"banned":{"description":"Whether a user is banned or not","title":"Banned","type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.017"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"001.004"},"deactivated_at":{"description":"Date of deactivation","format":"date-time","title":"Deactivated at","type":"string","x-stream-index":"001.016"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"string","x-stream-index":"001.011"},"id":{"description":"Unique user identifier","title":"ID","type":"string","x-stream-index":"001.001"},"image":{"title":"Image","type":"string","x-stream-index":"001.003"},"language":{"description":"Preferred language of a user","title":"Language","type":"string","x-stream-index":"001.005"},"last_active":{"description":"Date of last activity","format":"date-time","title":"Last active","type":"string","x-stream-index":"001.014"},"name":{"description":"Optional name of user","title":"Name","type":"string","x-stream-index":"001.002"},"online":{"description":"Whether a user online or not","title":"Online","type":"boolean","x-stream-index":"001.013"},"revoke_tokens_issued_before":{"description":"Revocation date for tokens","format":"date-time","title":"Revoke tokens issued before","type":"string","x-stream-index":"001.015"},"role":{"description":"Determines the set of user permissions","title":"Role","type":"string","x-stream-index":"001.006"},"teams":{"description":"List of teams user is a part of","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids","shadow_banned","invisible"],"title":"UserResponse","type":"object"},"UserResponseCommonFields":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"018"},"banned":{"type":"boolean","x-stream-index":"012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"017"},"created_at":{"format":"date-time","type":"string","x-stream-index":"009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"deactivated_at":{"format":"date-time","type":"string","x-stream-index":"016"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"011"},"id":{"type":"string","x-stream-index":"001"},"image":{"type":"string","x-stream-index":"003"},"language":{"type":"string","x-stream-index":"005"},"last_active":{"format":"date-time","type":"string","x-stream-index":"014"},"name":{"type":"string","x-stream-index":"002"},"online":{"type":"boolean","x-stream-index":"013"},"revoke_tokens_issued_before":{"format":"date-time","type":"string","x-stream-index":"015"},"role":{"type":"string","x-stream-index":"006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"008"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids"],"type":"object"},"UserResponsePrivacyFields":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"banned":{"type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.017"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"string","x-stream-index":"001.016"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"001.011"},"id":{"type":"string","x-stream-index":"001.001"},"image":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"003"},"language":{"type":"string","x-stream-index":"001.005"},"last_active":{"format":"date-time","type":"string","x-stream-index":"001.014"},"name":{"type":"string","x-stream-index":"001.002"},"online":{"type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"002"},"revoke_tokens_issued_before":{"format":"date-time","type":"string","x-stream-index":"001.015"},"role":{"type":"string","x-stream-index":"001.006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids"],"type":"object"},"UserUnbannedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"005.002"},"shadow":{"type":"boolean","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"004.001"},"type":{"default":"user.unbanned","type":"string","x-stream-index":"005.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["shadow","cid","channel_id","channel_type","type","created_at"],"title":"UserUnbannedEvent","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"},"UserUpdatedEvent":{"description":"This event is sent when a user gets updated. The event contains information about the updated user.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"received_at":{"format":"date-time","type":"string","x-stream-index":"001.004"},"type":{"default":"user.updated","description":"The type of event: \"user.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.002"},"user":{"$ref":"#/components/schemas/UserResponsePrivacyFields","description":"The updated user","title":"User","x-stream-index":"002.001"}},"required":["type","created_at","custom","user"],"title":"UserUpdatedEvent","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"},"UserWatchingStartEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"003.002"},"team":{"type":"string","x-stream-index":"002.001"},"type":{"default":"user.watching.start","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005.001"},"watcher_count":{"format":"int32","type":"integer","x-stream-index":"001.001"}},"required":["watcher_count","type","created_at","cid","channel_id","channel_type"],"title":"UserWatchingStartEvent","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"},"UserWatchingStopEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"002.002"},"type":{"default":"user.watching.stop","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"},"watcher_count":{"format":"int32","type":"integer","x-stream-index":"001.001"}},"required":["watcher_count","type","created_at","cid","channel_id","channel_type"],"title":"UserWatchingStopEvent","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"},"VoteData":{"properties":{"answer_text":{"type":"string","x-stream-index":"002"},"option_id":{"maxLength":255,"type":"string","x-stream-index":"001"}},"type":"object"},"WSClientEvent":{"description":"The discriminator object for all websocket client events, it maps events' payload to the final type","discriminator":{"mapping":{"app.updated":"#/components/schemas/AppUpdatedEvent","draft.deleted":"#/components/schemas/DraftDeletedEvent","draft.updated":"#/components/schemas/DraftUpdatedEvent","health.check":"#/components/schemas/HealthCheckEvent","message.pending":"#/components/schemas/PendingMessageEvent","notification.reminder_due":"#/components/schemas/ReminderNotificationEvent","poll.closed":"#/components/schemas/PollClosedEvent","poll.deleted":"#/components/schemas/PollDeletedEvent","poll.updated":"#/components/schemas/PollUpdatedEvent","poll.vote_casted":"#/components/schemas/PollVoteCastedEvent","poll.vote_changed":"#/components/schemas/PollVoteChangedEvent","poll.vote_removed":"#/components/schemas/PollVoteRemovedEvent","reminder.created":"#/components/schemas/ReminderCreatedEvent","reminder.deleted":"#/components/schemas/ReminderDeletedEvent","reminder.updated":"#/components/schemas/ReminderUpdatedEvent","user.messages.deleted":"#/components/schemas/UserMessagesDeletedEvent","user.updated":"#/components/schemas/UserUpdatedEvent"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/AppUpdatedEvent"},{"$ref":"#/components/schemas/DraftDeletedEvent"},{"$ref":"#/components/schemas/DraftUpdatedEvent"},{"$ref":"#/components/schemas/HealthCheckEvent"},{"$ref":"#/components/schemas/PendingMessageEvent"},{"$ref":"#/components/schemas/PollClosedEvent"},{"$ref":"#/components/schemas/PollDeletedEvent"},{"$ref":"#/components/schemas/PollUpdatedEvent"},{"$ref":"#/components/schemas/PollVoteCastedEvent"},{"$ref":"#/components/schemas/PollVoteChangedEvent"},{"$ref":"#/components/schemas/PollVoteRemovedEvent"},{"$ref":"#/components/schemas/ReminderCreatedEvent"},{"$ref":"#/components/schemas/ReminderDeletedEvent"},{"$ref":"#/components/schemas/ReminderNotificationEvent"},{"$ref":"#/components/schemas/ReminderUpdatedEvent"},{"$ref":"#/components/schemas/UserMessagesDeletedEvent"},{"$ref":"#/components/schemas/UserUpdatedEvent"}]},"WSEvent":{"description":"The discriminator object for all websocket events, it maps events' payload to the final type","discriminator":{"mapping":{"*":"#/components/schemas/AnyEvent","activity.marked":"#/components/schemas/ActivityMarkedEvent","ai_indicator.clear":"#/components/schemas/AIIndicatorClearEvent","ai_indicator.stop":"#/components/schemas/AIIndicatorStopEvent","ai_indicator.update":"#/components/schemas/AIIndicatorUpdateEvent","app.updated":"#/components/schemas/AppUpdatedEvent","channel.created":"#/components/schemas/ChannelCreatedEvent","channel.deleted":"#/components/schemas/ChannelDeletedEvent","channel.frozen":"#/components/schemas/ChannelFrozenEvent","channel.hidden":"#/components/schemas/ChannelHiddenEvent","channel.kicked":"#/components/schemas/ChannelKickedEvent","channel.truncated":"#/components/schemas/ChannelTruncatedEvent","channel.unfrozen":"#/components/schemas/ChannelUnFrozenEvent","channel.updated":"#/components/schemas/ChannelUpdatedEvent","channel.visible":"#/components/schemas/ChannelVisibleEvent","draft.deleted":"#/components/schemas/DraftDeletedEvent","draft.updated":"#/components/schemas/DraftUpdatedEvent","health.check":"#/components/schemas/HealthCheckEvent","member.added":"#/components/schemas/MemberAddedEvent","member.removed":"#/components/schemas/MemberRemovedEvent","member.updated":"#/components/schemas/MemberUpdatedEvent","message.deleted":"#/components/schemas/MessageDeletedEvent","message.new":"#/components/schemas/MessageNewEvent","message.pending":"#/components/schemas/PendingMessageEvent","message.read":"#/components/schemas/MessageReadEvent","message.undeleted":"#/components/schemas/MessageUndeletedEvent","message.updated":"#/components/schemas/MessageUpdatedEvent","notification.added_to_channel":"#/components/schemas/NotificationAddedToChannelEvent","notification.channel_deleted":"#/components/schemas/NotificationChannelDeletedEvent","notification.channel_mutes_updated":"#/components/schemas/NotificationChannelMutesUpdatedEvent","notification.channel_truncated":"#/components/schemas/NotificationChannelTruncatedEvent","notification.invite_accepted":"#/components/schemas/NotificationInviteAcceptedEvent","notification.invite_rejected":"#/components/schemas/NotificationInviteRejectedEvent","notification.invited":"#/components/schemas/NotificationInvitedEvent","notification.mark_read":"#/components/schemas/NotificationMarkReadEvent","notification.mark_unread":"#/components/schemas/NotificationMarkUnreadEvent","notification.message_new":"#/components/schemas/NotificationNewMessageEvent","notification.mutes_updated":"#/components/schemas/NotificationMutesUpdatedEvent","notification.reminder_due":"#/components/schemas/ReminderNotificationEvent","notification.removed_from_channel":"#/components/schemas/NotificationRemovedFromChannelEvent","notification.thread_message_new":"#/components/schemas/MessageNewEvent","poll.closed":"#/components/schemas/PollClosedEvent","poll.deleted":"#/components/schemas/PollDeletedEvent","poll.updated":"#/components/schemas/PollUpdatedEvent","poll.vote_casted":"#/components/schemas/PollVoteCastedEvent","poll.vote_changed":"#/components/schemas/PollVoteChangedEvent","poll.vote_removed":"#/components/schemas/PollVoteRemovedEvent","reaction.deleted":"#/components/schemas/ReactionDeletedEvent","reaction.new":"#/components/schemas/ReactionNewEvent","reaction.updated":"#/components/schemas/ReactionUpdatedEvent","reminder.created":"#/components/schemas/ReminderCreatedEvent","reminder.deleted":"#/components/schemas/ReminderDeletedEvent","reminder.updated":"#/components/schemas/ReminderUpdatedEvent","thread.updated":"#/components/schemas/ThreadUpdatedEvent","typing.start":"#/components/schemas/TypingStartEvent","typing.stop":"#/components/schemas/TypingStopEvent","user.banned":"#/components/schemas/UserBannedEvent","user.deactivated":"#/components/schemas/UserDeactivatedEvent","user.deleted":"#/components/schemas/UserDeletedEvent","user.messages.deleted":"#/components/schemas/UserMessagesDeletedEvent","user.muted":"#/components/schemas/UserMutedEvent","user.presence.changed":"#/components/schemas/UserPresenceChangedEvent","user.reactivated":"#/components/schemas/UserReactivatedEvent","user.unbanned":"#/components/schemas/UserUnbannedEvent","user.updated":"#/components/schemas/UserUpdatedEvent","user.watching.start":"#/components/schemas/UserWatchingStartEvent","user.watching.stop":"#/components/schemas/UserWatchingStopEvent"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/AIIndicatorClearEvent"},{"$ref":"#/components/schemas/AIIndicatorStopEvent"},{"$ref":"#/components/schemas/AIIndicatorUpdateEvent"},{"$ref":"#/components/schemas/ActivityMarkedEvent"},{"$ref":"#/components/schemas/AnyEvent"},{"$ref":"#/components/schemas/AppUpdatedEvent"},{"$ref":"#/components/schemas/ChannelCreatedEvent"},{"$ref":"#/components/schemas/ChannelDeletedEvent"},{"$ref":"#/components/schemas/ChannelFrozenEvent"},{"$ref":"#/components/schemas/ChannelHiddenEvent"},{"$ref":"#/components/schemas/ChannelKickedEvent"},{"$ref":"#/components/schemas/ChannelTruncatedEvent"},{"$ref":"#/components/schemas/ChannelUnFrozenEvent"},{"$ref":"#/components/schemas/ChannelUpdatedEvent"},{"$ref":"#/components/schemas/ChannelVisibleEvent"},{"$ref":"#/components/schemas/DraftDeletedEvent"},{"$ref":"#/components/schemas/DraftUpdatedEvent"},{"$ref":"#/components/schemas/HealthCheckEvent"},{"$ref":"#/components/schemas/MemberAddedEvent"},{"$ref":"#/components/schemas/MemberRemovedEvent"},{"$ref":"#/components/schemas/MemberUpdatedEvent"},{"$ref":"#/components/schemas/MessageDeletedEvent"},{"$ref":"#/components/schemas/MessageNewEvent"},{"$ref":"#/components/schemas/MessageNewEvent"},{"$ref":"#/components/schemas/MessageReadEvent"},{"$ref":"#/components/schemas/MessageUndeletedEvent"},{"$ref":"#/components/schemas/MessageUpdatedEvent"},{"$ref":"#/components/schemas/NotificationAddedToChannelEvent"},{"$ref":"#/components/schemas/NotificationChannelDeletedEvent"},{"$ref":"#/components/schemas/NotificationChannelMutesUpdatedEvent"},{"$ref":"#/components/schemas/NotificationChannelTruncatedEvent"},{"$ref":"#/components/schemas/NotificationInviteAcceptedEvent"},{"$ref":"#/components/schemas/NotificationInviteRejectedEvent"},{"$ref":"#/components/schemas/NotificationInvitedEvent"},{"$ref":"#/components/schemas/NotificationMarkReadEvent"},{"$ref":"#/components/schemas/NotificationMarkUnreadEvent"},{"$ref":"#/components/schemas/NotificationMutesUpdatedEvent"},{"$ref":"#/components/schemas/NotificationNewMessageEvent"},{"$ref":"#/components/schemas/NotificationRemovedFromChannelEvent"},{"$ref":"#/components/schemas/PendingMessageEvent"},{"$ref":"#/components/schemas/PollClosedEvent"},{"$ref":"#/components/schemas/PollDeletedEvent"},{"$ref":"#/components/schemas/PollUpdatedEvent"},{"$ref":"#/components/schemas/PollVoteCastedEvent"},{"$ref":"#/components/schemas/PollVoteChangedEvent"},{"$ref":"#/components/schemas/PollVoteRemovedEvent"},{"$ref":"#/components/schemas/ReactionDeletedEvent"},{"$ref":"#/components/schemas/ReactionNewEvent"},{"$ref":"#/components/schemas/ReactionUpdatedEvent"},{"$ref":"#/components/schemas/ReminderCreatedEvent"},{"$ref":"#/components/schemas/ReminderDeletedEvent"},{"$ref":"#/components/schemas/ReminderNotificationEvent"},{"$ref":"#/components/schemas/ReminderUpdatedEvent"},{"$ref":"#/components/schemas/ThreadUpdatedEvent"},{"$ref":"#/components/schemas/TypingStartEvent"},{"$ref":"#/components/schemas/TypingStopEvent"},{"$ref":"#/components/schemas/UserBannedEvent"},{"$ref":"#/components/schemas/UserDeactivatedEvent"},{"$ref":"#/components/schemas/UserDeletedEvent"},{"$ref":"#/components/schemas/UserMessagesDeletedEvent"},{"$ref":"#/components/schemas/UserMutedEvent"},{"$ref":"#/components/schemas/UserPresenceChangedEvent"},{"$ref":"#/components/schemas/UserReactivatedEvent"},{"$ref":"#/components/schemas/UserUnbannedEvent"},{"$ref":"#/components/schemas/UserUpdatedEvent"},{"$ref":"#/components/schemas/UserWatchingStartEvent"},{"$ref":"#/components/schemas/UserWatchingStopEvent"}]},"WrappedUnreadCountsResponse":{"description":"Basic response information","nullable":true,"properties":{"channel_type":{"items":{"$ref":"#/components/schemas/UnreadCountsChannelType"},"type":"array","x-stream-index":"001.005"},"channels":{"items":{"$ref":"#/components/schemas/UnreadCountsChannel"},"type":"array","x-stream-index":"001.004"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"threads":{"items":{"$ref":"#/components/schemas/UnreadCountsThread"},"type":"array","x-stream-index":"001.006"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"001.001"},"total_unread_count_by_team":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001.003"},"total_unread_threads_count":{"format":"int32","type":"integer","x-stream-index":"001.002"}},"required":["total_unread_count","total_unread_threads_count","channels","channel_type","threads","duration"],"title":"Response","type":"object"},"connectRequestQuery":{"nullable":true,"type":"object"}},"securitySchemes":{"JWT":{"description":"JWT should be always provided when stream-auth-type=jwt.\n\nUsing JWT auth request could be authenticated as user or as server-side.\n\nWhen using user authentication permission checking is going to be applied to requests based on the user that is\nperforming a request.\n\nThe `authorization` header should be a JWT string signed using the secret attached to the API key used to perform\nrequests.\n\n**WARNING** all client-side official SDK do not ship with token generation; this is to make sure that the API secret is not\nshared with an untrusted party such as a browser or a iOS/Android application. Tokens **must** be generated server-side.\nIf you wish, you can configure your application to ignore authentication (see `disable_auth_check`)\nThe JWT string must include only the user_id claim and can include any built-in JWT claim such as iat, exp as well.\n","in":"header","name":"Authorization","type":"apiKey"},"api_key":{"description":"Application API key should be always set in order to authenticate the request.","in":"query","name":"api_key","type":"apiKey"},"stream-auth-type":{"description":"Stream-Auth-Type should be always set in order to authenticate the request. Possible\nvalues: `jwt` or `anonymous`.\n\n`jwt` allows you to authenticate as a user. With this auth type you should also provide valid JWT in Authorization\nheader.\n\n`anonymous` allows you to authenticate as anonymous user. Please note that most advanced features are not available\nto anonymous users.","in":"header","name":"Stream-Auth-Type","type":"apiKey"}}},"info":{"title":"Stream API","version":"v191.1.0"},"openapi":"3.0.3","paths":{"/app":{"get":{"description":"This Method returns the application settings\n","operationId":"GetApp","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetApplicationResponse"}}},"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":"Get App Settings","tags":["product:chat"]}},"/blocklists":{"get":{"description":"Returns all available block lists\n","operationId":"ListBlockLists","parameters":[{"in":"query","name":"team","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListBlockListResponse"}}},"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":"List block lists","tags":["product:chat"]},"post":{"description":"Creates a new application blocklist, once created the blocklist can be used by any channel type\n","operationId":"CreateBlockList","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBlockListRequest"}}},"description":"Block list","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBlockListResponse"}}},"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":"Create block list","tags":["product:chat"]}},"/blocklists/{name}":{"delete":{"description":"Deletes previously created application blocklist\n","operationId":"DeleteBlockList","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"team","schema":{"type":"string","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete block list","tags":["product:chat"]},"put":{"description":"Updates contents of the block list\n","operationId":"UpdateBlockList","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Block list name","title":"Name","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBlockListRequest"}}},"description":"Update block list","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBlockListResponse"}}},"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":"Update block list","tags":["product:chat"]}},"/channels":{"post":{"description":"Query channels with filter query\n","operationId":"QueryChannels","parameters":[{"in":"query","name":"connection_id","schema":{"description":"Websocket connection ID to interact with. You can pass it as Body or URL parameter","title":"Connection ID","type":"string","x-stream-index":"011.003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryChannelsRequest"}}},"description":"Query Channels Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryChannelsResponse"}}},"description":"Channels list"},"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":"Query channels","tags":["product:chat"]}},"/channels/delete":{"post":{"description":"Allows to delete several channels at once asynchronously\n\nSends events:\n- channel.deleted\n- channel.deleted\n","operationId":"DeleteChannels","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteChannelsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteChannelsResponse"}}},"description":"Successful 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":"Deletes channels asynchronously","tags":["product:chat"]}},"/channels/read":{"post":{"description":"Marks channels as read up to the specific message. If no channels is given, mark all channel as read\n\nSends events:\n- message.read\n- message.read\n","operationId":"MarkChannelsRead","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkChannelsReadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkReadResponse"}}},"description":"Successful 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 channels as read","tags":["product:chat"]}},"/channels/{type}/query":{"post":{"description":"This Method creates a channel or returns an existing one with matching attributes\n\nSends events:\n- channel.created\n- member.added\n- member.removed\n- member.updated\n- user.watching.start\n","operationId":"GetOrCreateDistinctChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"connection_id","schema":{"description":"Websocket connection ID to interact with. You can pass it as Body or URL parameter","title":"Connection ID","type":"string","x-stream-index":"012.003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelGetOrCreateRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelStateResponse"}}},"description":"Successful 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":"Get or create channel","tags":["product:chat"]}},"/channels/{type}/{id}":{"delete":{"description":"Deletes channel\n\nSends events:\n- channel.deleted\n- channel.deleted\n","operationId":"DeleteChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"query","name":"hard_delete","schema":{"type":"boolean","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteChannelResponse"}}},"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":"Delete channel","tags":["product:chat"]},"patch":{"description":"Updates certain fields of the channel\n\nSends events:\n- channel.updated\n- channel.updated\n","operationId":"UpdateChannelPartial","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelPartialRequest"}}},"description":"UpdateChannelPartialRequest","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelPartialResponse"}}},"description":"Successful 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":"Partially update channel","tags":["product:chat"]},"post":{"description":"Change channel data\n\nSends events:\n- channel.updated\n- member.added\n- member.removed\n- member.updated\n- message.new\n- channel.updated\n- member.added\n- member.removed\n- member.updated\n- message.new\n","operationId":"UpdateChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"013.002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"013.002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelRequest"}}},"description":"Channel update request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelResponse"}}},"description":"Successful 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":"Update channel","tags":["product:chat"]}},"/channels/{type}/{id}/draft":{"delete":{"description":"Deletes a draft\n\nSends events:\n- draft.deleted\n","operationId":"DeleteDraft","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"parent_id","schema":{"description":"Parent message ID","title":"string","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete draft","tags":["product:chat"]},"get":{"description":"Get a draft\n","operationId":"GetDraft","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"parent_id","schema":{"description":"Parent message ID","title":"string","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetDraftResponse"}}},"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":"Get draft","tags":["product:chat"]},"post":{"description":"Creates a draft\n\nSends events:\n- draft.updated\n","operationId":"CreateDraft","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDraftRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDraftResponse"}}},"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":"Create a draft","tags":["product:chat"]}},"/channels/{type}/{id}/event":{"post":{"description":"Sends event to the channel\n","operationId":"SendEvent","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendEventRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventResponse"}}},"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":"Send event","tags":["product:chat"]}},"/channels/{type}/{id}/file":{"delete":{"description":"Deletes previously uploaded file\n","operationId":"DeleteFile","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of file","title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"File ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"url","schema":{"description":"File URL to delete","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete file","tags":["product:chat"]},"post":{"description":"Uploads file\n","operationId":"UploadFile","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/FileUploadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileUploadResponse"}}},"description":"Successful 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":"Upload file","tags":["product:chat"]}},"/channels/{type}/{id}/hide":{"post":{"description":"Marks channel as hidden for current user\n\nSends events:\n- channel.hidden\n- channel.hidden\n","operationId":"HideChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HideChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HideChannelResponse"}}},"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":"Hide channel","tags":["product:chat"]}},"/channels/{type}/{id}/image":{"delete":{"description":"Deletes previously uploaded image\n","operationId":"DeleteImage","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of file","title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"File ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"url","schema":{"description":"File URL to delete","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete image","tags":["product:chat"]},"post":{"description":"Uploads image\n","operationId":"UploadImage","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.001.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.001.002"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/ImageUploadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageUploadResponse"}}},"description":"Successful 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":"Upload image","tags":["product:chat"]}},"/channels/{type}/{id}/member":{"patch":{"description":"\n","operationId":"UpdateMemberPartial","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMemberPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMemberPartialResponse"}}},"description":"Successful 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":"Partially channel member update","tags":["product:chat"]}},"/channels/{type}/{id}/message":{"post":{"description":"Sends new message to the specified channel\n\nSends events:\n- message.new\n- message.updated\n- message.new\n- message.updated\n","operationId":"SendMessage","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"009.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"009.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendMessageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendMessageResponse"}}},"description":"Successful 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":"Send new message","tags":["product:chat"]}},"/channels/{type}/{id}/messages":{"get":{"description":"Returns list messages found by IDs\n","operationId":"GetManyMessages","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"ids","required":true,"schema":{"description":"List of comma-separated IDs","items":{"type":"string"},"maximum":50,"minimum":1,"title":"IDs","type":"array","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetManyMessagesResponse"}}},"description":"Successful 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":"Get many messages","tags":["product:chat"]}},"/channels/{type}/{id}/query":{"post":{"description":"This Method creates a channel or returns an existing one with matching attributes\n\nSends events:\n- channel.created\n- member.added\n- member.removed\n- member.updated\n- user.watching.start\n","operationId":"GetOrCreateChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID (maximum length of 64 characters)","title":"ID","type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"connection_id","schema":{"description":"Websocket connection ID to interact with. You can pass it as Body or URL parameter","title":"Connection ID","type":"string","x-stream-index":"012.003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelGetOrCreateRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelStateResponse"}}},"description":"Successful 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":"Get or create channel","tags":["product:chat"]}},"/channels/{type}/{id}/read":{"post":{"description":"Marks channel as read up to the specific message\n\nSends events:\n- message.read\n- message.read\n","operationId":"MarkRead","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkReadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkReadResponse"}}},"description":"Successful 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 read","tags":["product:chat"]}},"/channels/{type}/{id}/show":{"post":{"description":"Shows previously hidden channel\n\nSends events:\n- channel.visible\n- channel.visible\n","operationId":"ShowChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShowChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShowChannelResponse"}}},"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":"Show channel","tags":["product:chat"]}},"/channels/{type}/{id}/stop-watching":{"post":{"description":"Call this Method to stop receiving channel events\n\nSends events:\n- user.watching.stop\n- user.watching.stop\n","operationId":"StopWatchingChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"connection_id","schema":{"type":"string","x-stream-index":"001.003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelStopWatchingRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Stop watching channel","tags":["product:chat"]}},"/channels/{type}/{id}/truncate":{"post":{"description":"Truncates messages from a channel. Can be applied to the entire channel or scoped to specific members.\n\nSends events:\n- channel.truncated\n- channel.truncated\n","operationId":"TruncateChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TruncateChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TruncateChannelResponse"}}},"description":"Successful 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":"Truncate channel","tags":["product:chat"]}},"/channels/{type}/{id}/unread":{"post":{"description":"Marks channel as unread from a specific message\n","operationId":"MarkUnread","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkUnreadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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 unread","tags":["product:chat"]}},"/devices":{"delete":{"description":"Deletes one device\n","operationId":"DeleteDevice","parameters":[{"in":"query","name":"id","required":true,"schema":{"description":"Device ID to delete","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete device","tags":["product:chat"]},"get":{"description":"Returns all available devices\n","operationId":"ListDevices","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDevicesResponse"}}},"description":"ListDevicesResponse"},"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":"List devices","tags":["product:chat"]},"post":{"description":"Adds a new device to a user, if the same device already exists the call will have no effect\n","operationId":"CreateDevice","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDeviceRequest"}}},"description":"CreateDeviceRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Create device","tags":["product:chat"]}},"/drafts/query":{"post":{"description":"Queries draft messages for a user\n","operationId":"QueryDrafts","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryDraftsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryDraftsResponse"}}},"description":"Successful 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":"Query draft messages","tags":["product:chat"]}},"/guest":{"post":{"description":"\n","operationId":"CreateGuest","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGuestRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGuestResponse"}}},"description":"Successful 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":"Create Guest","tags":["product:chat"]}},"/longpoll":{"get":{"description":"WebSocket fallback transport endpoint\n\nSends events:\n- user.updated\n","operationId":"LongPoll","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectRequest","x-stream-index":"001"}}},"in":"query","name":"json"},{"in":"query","name":"connection_id","schema":{"maxLength":36,"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"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":"Long Poll (Transport)","tags":["product:chat"]}},"/members":{"get":{"description":"Find and filter channel members\n","operationId":"QueryMembers","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryMembersPayload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MembersResponse"}}},"description":"Successful 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":"Query members","tags":["product:chat"]}},"/messages/{id}":{"delete":{"description":"Deletes message\n\nSends events:\n- message.deleted\n- message.deleted\n","operationId":"DeleteMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID to delete","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"hard","schema":{"description":"Delete all message reactions and replies as well","title":"Hard","type":"boolean","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"deleted_by","schema":{"type":"string","writeOnly":true,"x-stream-index":"003"}},{"in":"query","name":"delete_for_me","schema":{"description":"Delete the message only for the user making the request","title":"Delete for me","type":"boolean","writeOnly":true,"x-stream-index":"004"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteMessageResponse"}}},"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":"Delete message","tags":["product:chat"]},"get":{"description":"Returns message by ID\n","operationId":"GetMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"ID of the message","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetMessageResponse"}}},"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":"Get message","tags":["product:chat"]},"post":{"description":"Updates message with new data\n\nSends events:\n- message.updated\n- message.updated\n","operationId":"UpdateMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"004.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessageResponse"}}},"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":"Update message","tags":["product:chat"]},"put":{"description":"Updates certain fields of the message\n\nSends events:\n- message.updated\n- message.updated\n","operationId":"UpdateMessagePartial","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessagePartialRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessagePartialResponse"}}},"description":"Successful 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":"Partially message update","tags":["product:chat"]}},"/messages/{id}/action":{"post":{"description":"Executes message command action with given parameters\n\nSends events:\n- message.new\n- message.new\n","operationId":"RunMessageAction","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageActionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}},"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":"Run message command action","tags":["product:chat"]}},"/messages/{id}/reaction":{"post":{"description":"Sends reaction to specified message\n\nSends events:\n- reaction.new\n- reaction.updated\n","operationId":"SendReaction","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID to send reaction for","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendReactionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendReactionResponse"}}},"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":"Send reaction","tags":["product:chat"]}},"/messages/{id}/reaction/{type}":{"delete":{"description":"Removes user reaction from the message\n\nSends events:\n- reaction.deleted\n","operationId":"DeleteReaction","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID to remove reaction from","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"type","required":true,"schema":{"description":"Reaction type to remove","title":"Type","type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"description":"**Server-side only**. User ID which server acts upon","title":"User ID","type":"string","writeOnly":true,"x-stream-index":"003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteReactionResponse"}}},"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":"Delete reaction","tags":["product:chat"]}},"/messages/{id}/reactions":{"get":{"description":"Returns list of reactions of specific message\n","operationId":"GetReactions","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"limit","schema":{"description":"Number of records to return","format":"int32","title":"Limit","type":"integer","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"offset","schema":{"description":"Number of records to offset","format":"int32","title":"Offset","type":"integer","writeOnly":true,"x-stream-index":"003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetReactionsResponse"}}},"description":"Successful 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":"Get reactions","tags":["product:chat"]},"post":{"description":"Get reactions on a message\n","operationId":"QueryReactions","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryReactionsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryReactionsResponse"}}},"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"}},"tags":["product:chat"]}},"/messages/{id}/translate":{"post":{"description":"Translates message to a given language using automated translation software\n\nSends events:\n- message.updated\n- message.updated\n","operationId":"TranslateMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TranslateMessageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}},"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":"Translate message","tags":["product:chat"]}},"/messages/{message_id}/polls/{poll_id}/vote":{"post":{"description":"Cast a vote on a poll\n\nSends events:\n- feeds.poll.vote_casted\n- feeds.poll.vote_changed\n- feeds.poll.vote_removed\n- poll.vote_casted\n- poll.vote_changed\n- poll.vote_removed\n","operationId":"CastPollVote","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CastPollVoteRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollVoteResponse"}}},"description":"Successful 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":"Cast vote","tags":["product:chat"]}},"/messages/{message_id}/polls/{poll_id}/vote/{vote_id}":{"delete":{"description":"Delete a vote from a poll\n\nSends events:\n- feeds.poll.vote_removed\n- poll.vote_removed\n","operationId":"DeletePollVote","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"004"}},{"in":"path","name":"vote_id","required":true,"schema":{"description":"Vote ID","maxLength":255,"title":"string","type":"string","x-stream-index":"005"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollVoteResponse"}}},"description":"Successful 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":"Delete vote","tags":["product:chat"]}},"/messages/{message_id}/reminders":{"delete":{"description":"Deletes a user's created reminder\n\nSends events:\n- reminder.deleted\n","operationId":"DeleteReminder","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteReminderResponse"}}},"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":"Delete reminder","tags":["product:chat"]},"patch":{"description":"Updates an existing reminder\n\nSends events:\n- reminder.updated\n","operationId":"UpdateReminder","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateReminderRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateReminderResponse"}}},"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":"Updates Reminder","tags":["product:chat"]},"post":{"description":"Creates a new reminder\n\nSends events:\n- reminder.created\n","operationId":"CreateReminder","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateReminderRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReminderResponseData"}}},"description":"Successful 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":"Create reminder","tags":["product:chat"]}},"/messages/{parent_id}/replies":{"get":{"description":"Returns replies (thread) of the message\n","operationId":"GetReplies","parameters":[{"in":"path","name":"parent_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"sort","schema":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":1,"type":"array","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"limit","schema":{"description":"The maximum number of messages to return (max limit ","format":"int32","minimum":0,"title":"Limit","type":"integer","x-stream-index":"003.001"}},{"in":"query","name":"offset","schema":{"description":"The offset to start from","format":"int32","title":"Offset","type":"integer","x-stream-index":"003.002"}},{"in":"query","name":"id_gte","schema":{"description":"The ID of the message to get messages with a timestamp greater than or equal to","title":"IDGTE","type":"string","x-stream-index":"003.003"}},{"in":"query","name":"id_gt","schema":{"description":"The ID of the message to get messages with a timestamp greater than","title":"IDGT","type":"string","x-stream-index":"003.004"}},{"in":"query","name":"id_lte","schema":{"description":"The ID of the message to get messages with a timestamp smaller than or equal to","title":"IDLTE","type":"string","x-stream-index":"003.005"}},{"in":"query","name":"id_lt","schema":{"description":"The ID of the message to get messages with a timestamp smaller than","title":"IDLT","type":"string","x-stream-index":"003.006"}},{"in":"query","name":"created_at_after_or_equal","schema":{"description":"The timestamp to get messages with a created_at timestamp greater than or equal to","format":"date-time","title":"Created_at after or equal","type":"string","x-stream-index":"003.007"}},{"in":"query","name":"created_at_after","schema":{"description":"The timestamp to get messages with a created_at timestamp greater than","format":"date-time","title":"Created_at after","type":"string","x-stream-index":"003.008"}},{"in":"query","name":"created_at_before_or_equal","schema":{"description":"The timestamp to get messages with a created_at timestamp smaller than or equal to","format":"date-time","title":"Created_at after before or equal","type":"string","x-stream-index":"003.009"}},{"in":"query","name":"created_at_before","schema":{"description":"The timestamp to get messages with a created_at timestamp smaller than","format":"date-time","title":"Created_at after before","type":"string","x-stream-index":"003.010"}},{"in":"query","name":"id_around","schema":{"description":"The result will be a set of messages, that are both older and newer than the message with the provided ID, and the message with the ID provided will be in the middle of the set","title":"Id around","type":"string","x-stream-index":"003.011"}},{"in":"query","name":"created_at_around","schema":{"description":"The result will be a set of messages, that are both older and newer than the created_at timestamp provided, distributed evenly around the timestamp","format":"date-time","title":"Created_at around","type":"string","x-stream-index":"003.012"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRepliesResponse"}}},"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":"Get replies","tags":["product:chat"]}},"/moderation/ban":{"delete":{"description":"Removes previously applied ban\n\nSends events:\n- user.unbanned\n- user.unbanned\n","operationId":"Unban","parameters":[{"in":"query","name":"target_user_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"channel_cid","schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"created_by","schema":{"type":"string","writeOnly":true,"x-stream-index":"005"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Unban user","tags":["product:chat"]},"post":{"description":"Restricts user activity either in specific channel or globally\n\nSends events:\n- user.banned\n- user.messages.deleted\n- user.banned\n","operationId":"Ban","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BanRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Ban user","tags":["product:chat"]}},"/moderation/flag":{"post":{"description":"Reports message or user for review by moderators\n\nSends events:\n- message.flagged\n- user.flagged\n- message.flagged\n- user.flagged\n","operationId":"Flag","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlagRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlagResponse"}}},"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":"Flag","tags":["product:chat"]}},"/moderation/flags/message":{"get":{"description":"Find and filter message flags\n","operationId":"QueryMessageFlags","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryMessageFlagsPayload","description":"JSON object with query message flags payload","title":"Payload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryMessageFlagsResponse"}}},"description":"QueryMessageFlagsResponse"},"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":"Query Message Flags","tags":["product:chat"]}},"/moderation/mute":{"post":{"description":"Mutes one or several users\n\nSends events:\n- user.unmuted\n- user.muted\n","operationId":"MuteUser","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteUserRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteUserResponse"}}},"description":"Successful 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":"Mute user","tags":["product:chat"]}},"/moderation/mute/channel":{"post":{"description":"Mutes channel for user\n\nSends events:\n- channel.muted\n- channel.muted\n","operationId":"MuteChannel","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteChannelResponse"}}},"description":"Successful 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":"Mute channel","tags":["product:chat"]}},"/moderation/unmute":{"post":{"description":"Unmutes previously muted user\n\nSends events:\n- user.unmuted\n- user.unmuted\n","operationId":"UnmuteUser","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnmuteUserRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnmuteResponse"}}},"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":"Unmute user","tags":["product:chat"]}},"/moderation/unmute/channel":{"post":{"description":"Unmutes channel for user\n\nSends events:\n- channel.unmuted\n- channel.unmuted\n","operationId":"UnmuteChannel","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnmuteChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnmuteResponse"}}},"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":"Unmute channel","tags":["product:chat"]}},"/og":{"get":{"description":"Get an OpenGraph attachment for a link\n","operationId":"GetOG","parameters":[{"in":"query","name":"url","required":true,"schema":{"description":"URL to be scraped","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOGResponse"}}},"description":"Get OG Attachment"},"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":"Get OG","tags":["product:chat"]}},"/polls":{"post":{"description":"Creates a new poll\n","operationId":"CreatePoll","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePollRequest"}}},"description":"Create Poll Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Create poll","tags":["product:chat"]},"put":{"description":"Updates a poll\n\nSends events:\n- feeds.poll.closed\n- feeds.poll.updated\n- poll.closed\n- poll.updated\n","operationId":"UpdatePoll","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePollRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Update poll","tags":["product:chat"]}},"/polls/query":{"post":{"description":"Queries polls\n","operationId":"QueryPolls","parameters":[{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryPollsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryPollsResponse"}}},"description":"Successful 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":"Query polls","tags":["product:chat"]}},"/polls/{poll_id}":{"delete":{"description":"Deletes a poll\n\nSends events:\n- feeds.poll.deleted\n- poll.deleted\n","operationId":"DeletePoll","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete poll","tags":["product:chat"]},"get":{"description":"Retrieves a poll\n","operationId":"GetPoll","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Get poll","tags":["product:chat"]},"patch":{"description":"Updates a poll partially\n\nSends events:\n- feeds.poll.closed\n- feeds.poll.updated\n- poll.closed\n- poll.updated\n","operationId":"UpdatePollPartial","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePollPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Partial update poll","tags":["product:chat"]}},"/polls/{poll_id}/options":{"post":{"description":"Creates a poll option\n\nSends events:\n- feeds.poll.updated\n- poll.updated\n","operationId":"CreatePollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePollOptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollOptionResponse"}}},"description":"Successful 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":"Create poll option","tags":["product:chat"]},"put":{"description":"Updates a poll option\n\nSends events:\n- feeds.poll.updated\n- poll.updated\n","operationId":"UpdatePollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePollOptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollOptionResponse"}}},"description":"Successful 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":"Update poll option","tags":["product:chat"]}},"/polls/{poll_id}/options/{option_id}":{"delete":{"description":"Deletes a poll option\n\nSends events:\n- feeds.poll.updated\n- poll.updated\n","operationId":"DeletePollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"path","name":"option_id","required":true,"schema":{"description":"Option ID","maxLength":255,"title":"string","type":"string","x-stream-index":"003"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete poll option","tags":["product:chat"]},"get":{"description":"Retrieves a poll option\n","operationId":"GetPollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"path","name":"option_id","required":true,"schema":{"description":"Option ID","maxLength":255,"title":"string","type":"string","x-stream-index":"003"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollOptionResponse"}}},"description":"Successful 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":"Get poll option","tags":["product:chat"]}},"/polls/{poll_id}/votes":{"post":{"description":"Queries votes\n","operationId":"QueryPollVotes","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryPollVotesRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollVotesResponse"}}},"description":"Successful 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":"Query votes","tags":["product:chat"]}},"/push_preferences":{"post":{"description":"Update the push preferences for a user and or channel member. Set to all, mentions or none\n","operationId":"UpdatePushNotificationPreferences","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertPushPreferencesRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertPushPreferencesResponse"}}},"description":"Successful 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":"Push notification preferences","tags":["product:chat"]}},"/query_banned_users":{"get":{"description":"Find and filter channel scoped or global user bans\n","operationId":"QueryBannedUsers","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryBannedUsersPayload","description":"JSON object with query user bans payload","title":"Payload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryBannedUsersResponse"}}},"description":"Successful 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":"Query Banned Users","tags":["product:chat"]}},"/reminders/query":{"post":{"description":"Queries reminders\n","operationId":"QueryReminders","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryRemindersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryRemindersResponse"}}},"description":"Successful 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":"Query reminders","tags":["product:chat"]}},"/search":{"get":{"description":"Search messages across channels\n","operationId":"Search","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchPayload","description":"JSON object with search payload","title":"Payload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchResponse"}}},"description":"Successful 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":"Search messages","tags":["product:chat"]}},"/sync":{"post":{"description":"Returns all events happened since client disconnect in specified channels\n","operationId":"Sync","parameters":[{"in":"query","name":"with_inaccessible_cids","schema":{"description":"If set to true this will add 'inaccessible_cids' to response type","title":"With inaccessible CIDs","type":"boolean","x-stream-index":"003"}},{"in":"query","name":"watch","schema":{"description":"If set to true this will start watching requested and newly added channels that user has access to. If error occurred with this option enabled and it is not an input error - channels will still be watched.","title":"Watch synced channels","type":"boolean","x-stream-index":"004"}},{"in":"query","name":"connection_id","schema":{"type":"string","x-stream-index":"006.003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncRequest"}}},"description":"SyncRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncResponse"}}},"description":"SyncResponse"},"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":"Sync","tags":["product:chat"]}},"/threads":{"post":{"description":"Returns the list of threads for specific user\n","operationId":"QueryThreads","parameters":[{"in":"query","name":"connection_id","schema":{"type":"string","x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryThreadsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryThreadsResponse"}}},"description":"Successful 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":"Query Threads","tags":["product:chat"]}},"/threads/{message_id}":{"get":{"description":"Return a specific thread\n","operationId":"GetThread","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"watch","schema":{"description":"Start watching the channel this thread belongs to","title":"Watch","type":"boolean","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"connection_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"003"}},{"in":"query","name":"reply_limit","schema":{"description":"Limit the number of replies returned","format":"int32","minimum":0,"title":"Reply limit","type":"integer","writeOnly":true,"x-stream-index":"004"}},{"in":"query","name":"participant_limit","schema":{"description":"Limit the number of participants returned","format":"int32","maximum":100,"minimum":0,"title":"Participant limit","type":"integer","writeOnly":true,"x-stream-index":"005"}},{"in":"query","name":"member_limit","schema":{"description":"Limit the number of members returned per thread channel","format":"int32","maximum":100,"minimum":0,"title":"Member limit","type":"integer","writeOnly":true,"x-stream-index":"006"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetThreadResponse"}}},"description":"Successful 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":"Get Thread","tags":["product:chat"]},"patch":{"description":"Updates certain fields of the thread\n\nSends events:\n- thread.updated\n- thread.updated\n","operationId":"UpdateThreadPartial","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateThreadPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateThreadPartialResponse"}}},"description":"Successful 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":"Partially update thread","tags":["product:chat"]}},"/unread":{"get":{"description":"Fetch unread counts for a single user\n","operationId":"UnreadCounts","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WrappedUnreadCountsResponse"}}},"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":"Unread counts","tags":["product:chat"]}},"/uploads/file":{"delete":{"description":"Deletes previously uploaded file\n","operationId":"DeleteFileGlobal","parameters":[{"in":"query","name":"url","schema":{"description":"File URL to delete","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete file","tags":["product:chat"],"x-stream-sdk-name":"DeleteFile"},"post":{"description":"Uploads file\n","operationId":"UploadFileGlobal","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/FileUploadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileUploadResponse"}}},"description":"Successful 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":"Upload file","tags":["product:chat"],"x-stream-sdk-name":"UploadFile"}},"/uploads/image":{"delete":{"description":"Deletes previously uploaded image\n","operationId":"DeleteImageGlobal","parameters":[{"in":"query","name":"url","schema":{"description":"File URL to delete","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete image","tags":["product:chat"],"x-stream-sdk-name":"DeleteImage"},"post":{"description":"Uploads image\n","operationId":"UploadImageGlobal","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/ImageUploadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageUploadResponse"}}},"description":"Successful 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":"Upload image","tags":["product:chat"],"x-stream-sdk-name":"UploadImage"}},"/users":{"get":{"description":"Find and filter users\n","operationId":"QueryUsers","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryUsersPayload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryUsersResponse"}}},"description":"Successful 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":"Query users","tags":["product:chat"]},"patch":{"description":"Updates certain fields of the user\n\nSends events:\n- user.presence.changed\n- user.updated\n- user.presence.changed\n","operationId":"UpdateUsersPartial","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersResponse"}}},"description":"Successful 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":"Partially update user","tags":["product:chat"]},"post":{"description":"Update or create users in bulk\n\nSends events:\n- user.updated\n","operationId":"UpdateUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersResponse"}}},"description":"Successful 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":"Upsert users","tags":["product:chat"]}},"/users/block":{"get":{"description":"Get list of blocked Users\n","operationId":"GetBlockedUsers","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBlockedUsersResponse"}}},"description":"Successful 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":"Get list of blocked Users","tags":["product:chat"]},"post":{"description":"Block users\n","operationId":"BlockUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUsersResponse"}}},"description":"Successful 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":"Block user","tags":["product:chat"]}},"/users/live_locations":{"get":{"description":"Retrieves all active live locations for a user\n","operationId":"GetUserLiveLocations","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SharedLocationsResponse"}}},"description":"Successful 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":"Get user live locations","tags":["product:chat"]},"put":{"description":"Updates an existing live location with new coordinates or expiration time\n","operationId":"UpdateLiveLocation","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateLiveLocationRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SharedLocationResponse"}}},"description":"Successful 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":"Update live location","tags":["product:chat"]}},"/users/unblock":{"post":{"description":"Unblock users\n","operationId":"UnblockUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUsersResponse"}}},"description":"Successful 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":"Unblock user","tags":["product:chat"]}}},"security":[{"JWT":[],"api_key":[],"stream-auth-type":[]},{"api_key":[],"stream-auth-type":[]}],"servers":[{"description":"Stream API","url":"https://chat.stream-io-api.com"}]} \ No newline at end of file diff --git a/openapi/chat-openapi-clientside.yaml b/openapi/chat-openapi-clientside.yaml index 13335f32d..9f97026ce 100644 --- a/openapi/chat-openapi-clientside.yaml +++ b/openapi/chat-openapi-clientside.yaml @@ -341,6 +341,7 @@ components: - use_hook_v2 - user_response_time_enabled - moderation_bulk_submit_action_enabled + - moderation_llm_configurability_enabled type: object AppUpdatedEvent: description: Emitted when app settings are updated @@ -790,6 +791,14 @@ components: $ref: '#/components/schemas/ChannelMember' type: array x-stream-index: "020" + message_count: + format: int64 + type: integer + x-stream-index: "035" + message_count_updated_at: + format: date-time + type: string + x-stream-index: "036" team: type: string x-stream-index: "028" @@ -820,39 +829,39 @@ components: items: type: string type: array - x-stream-index: "001.026" + x-stream-index: "001.027" automod: enum: - disabled - simple - AI type: string - x-stream-index: "001.021" + x-stream-index: "001.022" automod_behavior: enum: - flag - block - shadow_block type: string - x-stream-index: "001.022" + x-stream-index: "001.023" automod_thresholds: $ref: '#/components/schemas/Thresholds' - x-stream-index: "001.027" + x-stream-index: "001.028" blocklist: type: string - x-stream-index: "001.023" + x-stream-index: "001.024" blocklist_behavior: enum: - flag - block - shadow_block type: string - x-stream-index: "001.024" + x-stream-index: "001.025" blocklists: items: $ref: '#/components/schemas/BlockListOptions' type: array - x-stream-index: "001.025" + x-stream-index: "001.026" commands: items: type: string @@ -861,6 +870,9 @@ components: connect_events: type: boolean x-stream-index: "001.004" + count_messages: + type: boolean + x-stream-index: "001.019" created_at: format: date-time type: string @@ -875,7 +887,7 @@ components: format: int32 maximum: 20000 type: integer - x-stream-index: "001.020" + x-stream-index: "001.021" mutes: type: boolean x-stream-index: "001.009" @@ -885,10 +897,10 @@ components: partition_size: format: int32 type: integer - x-stream-index: "001.028" + x-stream-index: "001.029" partition_ttl: type: integer - x-stream-index: "001.029" + x-stream-index: "001.030" polls: type: boolean x-stream-index: "001.016" @@ -918,7 +930,7 @@ components: x-stream-index: "001.018" skip_last_msg_update_for_system_msgs: type: boolean - x-stream-index: "001.030" + x-stream-index: "001.031" typing_events: type: boolean x-stream-index: "001.002" @@ -954,6 +966,7 @@ components: - polls - user_message_reminders - shared_locations + - count_messages - message_retention - max_message_length - automod @@ -969,39 +982,39 @@ components: items: type: string type: array - x-stream-index: 001.002.026 + x-stream-index: 001.002.027 automod: enum: - disabled - simple - AI type: string - x-stream-index: 001.002.021 + x-stream-index: 001.002.022 automod_behavior: enum: - flag - block - shadow_block type: string - x-stream-index: 001.002.022 + x-stream-index: 001.002.023 automod_thresholds: $ref: '#/components/schemas/Thresholds' - x-stream-index: 001.002.027 + x-stream-index: 001.002.028 blocklist: type: string - x-stream-index: 001.002.023 + x-stream-index: 001.002.024 blocklist_behavior: enum: - flag - block - shadow_block type: string - x-stream-index: 001.002.024 + x-stream-index: 001.002.025 blocklists: items: $ref: '#/components/schemas/BlockListOptions' type: array - x-stream-index: 001.002.025 + x-stream-index: 001.002.026 commands: items: $ref: '#/components/schemas/Command' @@ -1010,6 +1023,9 @@ components: connect_events: type: boolean x-stream-index: 001.002.004 + count_messages: + type: boolean + x-stream-index: 001.002.019 created_at: format: date-time type: string @@ -1031,7 +1047,7 @@ components: format: int32 maximum: 20000 type: integer - x-stream-index: 001.002.020 + x-stream-index: 001.002.021 mutes: type: boolean x-stream-index: 001.002.009 @@ -1041,13 +1057,13 @@ components: partition_size: format: int32 type: integer - x-stream-index: 001.002.028 + x-stream-index: 001.002.029 partition_ttl: example: 24h format: duration nullable: true type: string - x-stream-index: 001.002.029 + x-stream-index: 001.002.030 polls: type: boolean x-stream-index: 001.002.016 @@ -1077,7 +1093,7 @@ components: x-stream-index: 001.002.018 skip_last_msg_update_for_system_msgs: type: boolean - x-stream-index: 001.002.030 + x-stream-index: 001.002.031 typing_events: type: boolean x-stream-index: 001.002.002 @@ -1115,6 +1131,7 @@ components: - polls - user_message_reminders - shared_locations + - count_messages - message_retention - max_message_length - automod @@ -1430,6 +1447,11 @@ components: format: date-time type: string x-stream-index: "011" + deleted_messages: + items: + type: string + type: array + x-stream-index: "020" invite_accepted_at: description: Date when invite was accepted format: date-time @@ -1795,6 +1817,12 @@ components: title: ChannelMembers type: array x-stream-index: "011" + message_count: + description: Number of messages in the channel + format: int64 + title: Message count + type: integer + x-stream-index: "027" mute_expires_at: description: Date of mute expiration format: date-time @@ -1861,6 +1889,11 @@ components: channel: $ref: '#/components/schemas/ChannelResponse' x-stream-index: "001.001" + deleted_messages: + items: + type: string + type: array + x-stream-index: "001.016" draft: $ref: '#/components/schemas/DraftResponse' x-stream-index: "001.014" @@ -1938,6 +1971,11 @@ components: channel: $ref: '#/components/schemas/ChannelResponse' x-stream-index: "001" + deleted_messages: + items: + type: string + type: array + x-stream-index: "016" draft: $ref: '#/components/schemas/DraftResponse' x-stream-index: "014" @@ -2236,6 +2274,9 @@ components: type: string type: array x-stream-index: "011" + count_messages: + type: boolean + x-stream-index: "014" grants: additionalProperties: items: @@ -2967,6 +3008,48 @@ components: - duration title: Response type: object + FeedsEventPreferences: + properties: + comments: + type: string + x-stream-index: "002" + mentions: + type: string + x-stream-index: "004" + new_followers: + type: string + x-stream-index: "003" + reactions: + type: string + x-stream-index: "001" + type: object + FeedsEventPreferencesInput: + properties: + comments: + enum: + - all + - none + type: string + x-stream-index: "002" + mentions: + enum: + - all + - none + type: string + x-stream-index: "004" + new_followers: + enum: + - all + - none + type: string + x-stream-index: "003" + reactions: + enum: + - all + - none + type: string + x-stream-index: "001" + type: object Field: nullable: true properties: @@ -4101,6 +4184,9 @@ components: format: date-time type: string x-stream-index: "033" + deleted_for_me: + type: boolean + x-stream-index: "059" deleted_reply_count: format: int32 type: integer @@ -4316,17 +4402,20 @@ components: properties: channel_id: type: string - x-stream-index: "003.002" + x-stream-index: "004.002" channel_type: type: string - x-stream-index: "003.003" + x-stream-index: "004.003" cid: type: string - x-stream-index: "003.001" + x-stream-index: "004.001" created_at: format: date-time type: string - x-stream-index: "006.002" + x-stream-index: "007.002" + deleted_for_me: + type: boolean + x-stream-index: "003" hard_delete: type: boolean x-stream-index: "002.001" @@ -4335,7 +4424,7 @@ components: x-stream-index: "001.001" team: type: string - x-stream-index: "005.001" + x-stream-index: "006.001" thread_participants: items: $ref: '#/components/schemas/User' @@ -4344,10 +4433,10 @@ components: type: default: message.deleted type: string - x-stream-index: "006.001" + x-stream-index: "007.001" user: $ref: '#/components/schemas/User' - x-stream-index: "004.001" + x-stream-index: "005.001" required: - hard_delete - cid @@ -4740,6 +4829,9 @@ components: title: Deleted at type: string x-stream-index: "025" + deleted_for_me: + type: boolean + x-stream-index: "044" deleted_reply_count: format: int32 type: integer @@ -5129,6 +5221,9 @@ components: title: Deleted at type: string x-stream-index: "001.025" + deleted_for_me: + type: boolean + x-stream-index: "001.044" deleted_reply_count: format: int32 type: integer @@ -7250,11 +7345,25 @@ components: description: Disable push notifications till a certain time format: date-time type: string + x-stream-index: "007" + feeds_events: + $ref: '#/components/schemas/FeedsEventPreferencesInput' + description: Set granular feeds event preferences for reactions, comments, + new followers, and mentions + x-stream-index: "006" + feeds_level: + description: Set the level of feeds push notifications for the user. One + of all, none, default + enum: + - all + - none + - default + type: string x-stream-index: "005" remove_disable: description: Remove the disabled until time. (IE stop snoozing notifications) type: boolean - x-stream-index: "006" + x-stream-index: "008" user_id: description: The user id for which to set the push preferences. Required when using server side auths, defaults to current user with client side @@ -7272,6 +7381,12 @@ components: x-stream-index: "001" disabled_until: format: date-time + type: string + x-stream-index: "005" + feeds_events: + $ref: '#/components/schemas/FeedsEventPreferences' + x-stream-index: "004" + feeds_level: type: string x-stream-index: "003" type: object @@ -8661,6 +8776,9 @@ components: format: date-time type: string x-stream-index: "001.025" + deleted_for_me: + type: boolean + x-stream-index: "001.044" deleted_reply_count: format: int32 type: integer @@ -10732,6 +10850,84 @@ components: x-stream-event-doc-group: other x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent + UserMessagesDeletedEvent: + description: This event is sent when a user's message get deleted. The event + contains information about the user whose messages got deleted. + nullable: true + properties: + channel_custom: + additionalProperties: {} + type: object + x-stream-index: 001.001.005 + channel_id: + description: The ID of the channel where the target user's messages were + deleted + title: Channel ID + type: string + x-stream-index: 001.002.002 + channel_member_count: + format: int32 + type: integer + x-stream-index: 001.001.004 + channel_type: + description: The type of the channel where the target user's messages were + deleted + title: Channel Type + type: string + x-stream-index: 001.002.001 + cid: + description: The CID of the channel where the target user's messages were + deleted + 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 + hard_delete: + description: Whether Messages were hard deleted + title: Hard Delete + type: boolean + x-stream-index: "003" + received_at: + format: date-time + type: string + x-stream-index: 001.001.001.001.004 + team: + description: The team of the channel where the target user's messages were + deleted + title: Team + type: string + x-stream-index: 001.001.003 + type: + default: user.messages.deleted + description: 'The type of event: "user.messages.deleted" in this case' + title: Event Type + type: string + x-stream-index: 001.001.001.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The target user whose messages got deleted + title: User + x-stream-index: "002.001" + required: + - type + - created_at + - custom + - user + title: UserMessagesDeletedEvent + 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 UserMute: nullable: true properties: @@ -11381,6 +11577,7 @@ components: reminder.created: '#/components/schemas/ReminderCreatedEvent' reminder.deleted: '#/components/schemas/ReminderDeletedEvent' reminder.updated: '#/components/schemas/ReminderUpdatedEvent' + user.messages.deleted: '#/components/schemas/UserMessagesDeletedEvent' user.updated: '#/components/schemas/UserUpdatedEvent' propertyName: type oneOf: @@ -11399,6 +11596,7 @@ components: - $ref: '#/components/schemas/ReminderDeletedEvent' - $ref: '#/components/schemas/ReminderNotificationEvent' - $ref: '#/components/schemas/ReminderUpdatedEvent' + - $ref: '#/components/schemas/UserMessagesDeletedEvent' - $ref: '#/components/schemas/UserUpdatedEvent' WSEvent: description: The discriminator object for all websocket events, it maps events' @@ -11464,6 +11662,7 @@ components: user.banned: '#/components/schemas/UserBannedEvent' user.deactivated: '#/components/schemas/UserDeactivatedEvent' user.deleted: '#/components/schemas/UserDeletedEvent' + user.messages.deleted: '#/components/schemas/UserMessagesDeletedEvent' user.muted: '#/components/schemas/UserMutedEvent' user.presence.changed: '#/components/schemas/UserPresenceChangedEvent' user.reactivated: '#/components/schemas/UserReactivatedEvent' @@ -11532,6 +11731,7 @@ components: - $ref: '#/components/schemas/UserBannedEvent' - $ref: '#/components/schemas/UserDeactivatedEvent' - $ref: '#/components/schemas/UserDeletedEvent' + - $ref: '#/components/schemas/UserMessagesDeletedEvent' - $ref: '#/components/schemas/UserMutedEvent' - $ref: '#/components/schemas/UserPresenceChangedEvent' - $ref: '#/components/schemas/UserReactivatedEvent' @@ -11630,7 +11830,7 @@ components: type: apiKey info: title: Stream API - version: v187.13.0 + version: v191.1.0 openapi: 3.0.3 paths: /app: @@ -13382,6 +13582,14 @@ paths: type: string writeOnly: true x-stream-index: "003" + - in: query + name: delete_for_me + schema: + description: Delete the message only for the user making the request + title: Delete for me + type: boolean + writeOnly: true + x-stream-index: "004" responses: "200": content: @@ -14272,6 +14480,7 @@ paths: Sends events: - user.banned + - user.messages.deleted - user.banned operationId: Ban requestBody: diff --git a/openapi/chat-openapi.json b/openapi/chat-openapi.json index dd9c9628e..53252faab 100644 --- a/openapi/chat-openapi.json +++ b/openapi/chat-openapi.json @@ -1 +1 @@ -{"components":{"schemas":{"APIError":{"nullable":true,"properties":{"StatusCode":{"description":"Response HTTP status code","format":"int32","title":"Status code","type":"integer","x-stream-index":"004"},"code":{"description":"API error code","format":"int32","title":"Code","type":"integer","x-stream-index":"001"},"details":{"description":"Additional error-specific information","items":{"type":"integer"},"title":"Details","type":"array","x-stream-index":"007"},"duration":{"description":"Request duration","title":"Duration","type":"string","x-stream-index":"005"},"exception_fields":{"additionalProperties":{"type":"string"},"description":"Additional error info","title":"Exception fields","type":"object","x-stream-index":"003"},"message":{"description":"Message describing an error","title":"Message","type":"string","x-stream-index":"002"},"more_info":{"description":"URL with additional information","title":"More info","type":"string","x-stream-index":"006"},"unrecoverable":{"description":"Flag that indicates if the error is unrecoverable, requests that return unrecoverable errors should not be retried, this error only applies to the request that caused it","title":"Unrecoverable","type":"boolean","x-stream-index":"008"}},"required":["code","message","StatusCode","duration","more_info","details"],"title":"Error response","type":"object"},"APNConfig":{"properties":{"Disabled":{"type":"boolean","writeOnly":true,"x-stream-index":"005"},"auth_key":{"type":"string","x-stream-index":"006.001"},"auth_type":{"enum":["certificate","token"],"type":"string","x-stream-index":"001"},"bundle_id":{"type":"string","x-stream-index":"004"},"development":{"type":"boolean","x-stream-index":"002"},"host":{"type":"string","x-stream-index":"003"},"key_id":{"type":"string","x-stream-index":"006.002"},"notification_template":{"type":"string","x-stream-index":"008"},"p12_cert":{"type":"string","x-stream-index":"007.001"},"team_id":{"type":"string","x-stream-index":"006.003"}},"type":"object"},"APNConfigFields":{"properties":{"auth_key":{"type":"string","x-stream-index":"009"},"auth_type":{"type":"string","x-stream-index":"003"},"bundle_id":{"type":"string","x-stream-index":"006"},"development":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"host":{"type":"string","x-stream-index":"005"},"key_id":{"type":"string","x-stream-index":"008"},"notification_template":{"type":"string","x-stream-index":"004"},"p12_cert":{"type":"string","x-stream-index":"010"},"team_id":{"type":"string","x-stream-index":"007"}},"required":["enabled","development"],"type":"object"},"APNS":{"properties":{"body":{"type":"string","x-stream-index":"002"},"content-available":{"format":"int32","type":"integer","x-stream-index":"004"},"data":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"mutable-content":{"format":"int32","type":"integer","x-stream-index":"005"},"sound":{"type":"string","x-stream-index":"003"},"title":{"type":"string","x-stream-index":"001"}},"required":["title","body"],"type":"object"},"Action":{"nullable":true,"properties":{"name":{"type":"string","x-stream-index":"001"},"style":{"type":"string","x-stream-index":"003"},"text":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"004"},"value":{"type":"string","x-stream-index":"005"}},"required":["name","text","type"],"type":"object"},"ActivityMarkedEvent":{"properties":{"all_read":{"type":"boolean","x-stream-index":"006"},"all_seen":{"type":"boolean","x-stream-index":"007"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"feed_id":{"type":"string","x-stream-index":"003"},"marked_read":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"marked_watched":{"items":{"type":"string"},"type":"array","x-stream-index":"005"},"type":{"default":"activity.marked","type":"string","x-stream-index":"001.001"},"user_id":{"type":"string","x-stream-index":"002"}},"required":["type","created_at","user_id","feed_id","all_read","all_seen"],"title":"ActivityMarkedEvent","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"},"AnyEvent":{"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"*","type":"string","x-stream-index":"001.001"}},"required":["type","created_at"],"title":"AnyEvent","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"},"AppResponseFields":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"019"},"async_url_enrich_enabled":{"type":"boolean","x-stream-index":"017"},"auto_translation_enabled":{"type":"boolean","x-stream-index":"020"},"before_message_send_hook_url":{"type":"string","x-stream-index":"021"},"call_types":{"additionalProperties":{"$ref":"#/components/schemas/CallType"},"type":"object","x-stream-index":"007"},"campaign_enabled":{"type":"boolean","x-stream-index":"034"},"cdn_expiration_seconds":{"format":"int32","type":"integer","x-stream-index":"037"},"channel_configs":{"additionalProperties":{"$ref":"#/components/schemas/ChannelConfig"},"type":"object","x-stream-index":"006"},"custom_action_handler_url":{"type":"string","x-stream-index":"022"},"datadog_info":{"$ref":"#/components/schemas/DataDogInfo","x-stream-index":"040"},"disable_auth_checks":{"type":"boolean","x-stream-index":"011"},"disable_permissions_checks":{"type":"boolean","x-stream-index":"012"},"enforce_unique_usernames":{"type":"string","x-stream-index":"023"},"event_hooks":{"items":{"$ref":"#/components/schemas/EventHook"},"type":"array","x-stream-index":"045"},"file_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","x-stream-index":"030"},"geofences":{"items":{"$ref":"#/components/schemas/GeofenceResponse"},"type":"array","x-stream-index":"039"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"033"},"guest_user_creation_disabled":{"type":"boolean","x-stream-index":"043"},"image_moderation_enabled":{"type":"boolean","x-stream-index":"016"},"image_moderation_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"018"},"image_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","x-stream-index":"031"},"moderation_bulk_submit_action_enabled":{"type":"boolean","x-stream-index":"048"},"moderation_dashboard_preferences":{"$ref":"#/components/schemas/ModerationDashboardPreferences","x-stream-index":"044"},"moderation_enabled":{"type":"boolean","x-stream-index":"041"},"moderation_multitenant_blocklist_enabled":{"type":"boolean","x-stream-index":"042"},"moderation_webhook_url":{"type":"string","x-stream-index":"005"},"multi_tenant_enabled":{"type":"boolean","x-stream-index":"015"},"name":{"type":"string","x-stream-index":"001"},"organization":{"type":"string","x-stream-index":"002"},"permission_version":{"type":"string","x-stream-index":"013"},"policies":{"additionalProperties":{"items":{"$ref":"#/components/schemas/Policy"},"type":"array"},"type":"object","x-stream-index":"008"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationFields","x-stream-index":"003"},"reminders_interval":{"format":"int32","type":"integer","x-stream-index":"036"},"revoke_tokens_issued_before":{"format":"date-time","type":"string","x-stream-index":"032"},"sns_key":{"type":"string","x-stream-index":"028"},"sns_secret":{"type":"string","x-stream-index":"029"},"sns_topic_arn":{"type":"string","x-stream-index":"027"},"sqs_key":{"type":"string","x-stream-index":"025"},"sqs_secret":{"type":"string","x-stream-index":"026"},"sqs_url":{"type":"string","x-stream-index":"024"},"suspended":{"type":"boolean","x-stream-index":"009"},"suspended_explanation":{"type":"string","x-stream-index":"010"},"use_hook_v2":{"type":"boolean","x-stream-index":"046"},"user_response_time_enabled":{"type":"boolean","x-stream-index":"047"},"user_search_disallowed_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"014"},"webhook_events":{"items":{"type":"string"},"type":"array","x-stream-index":"035"},"webhook_url":{"type":"string","x-stream-index":"004"}},"required":["name","organization","push_notifications","webhook_url","moderation_webhook_url","channel_configs","call_types","policies","suspended","suspended_explanation","disable_auth_checks","disable_permissions_checks","permission_version","user_search_disallowed_roles","multi_tenant_enabled","image_moderation_enabled","async_url_enrich_enabled","auto_translation_enabled","custom_action_handler_url","enforce_unique_usernames","sqs_url","sqs_key","sqs_secret","sns_topic_arn","sns_key","sns_secret","file_upload_config","image_upload_config","grants","campaign_enabled","webhook_events","reminders_interval","cdn_expiration_seconds","video_provider","moderation_enabled","moderation_multitenant_blocklist_enabled","guest_user_creation_disabled","event_hooks","use_hook_v2","user_response_time_enabled","moderation_bulk_submit_action_enabled"],"type":"object"},"AsyncBulkImageModerationEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"003.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.007"},"finished_at":{"format":"date-time","type":"string","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"string","x-stream-index":"003.004"},"started_at":{"format":"date-time","type":"string","x-stream-index":"002.002"},"task_id":{"type":"string","x-stream-index":"002.001"},"type":{"default":"export.bulk_image_moderation.success","type":"string","x-stream-index":"003.002"},"url":{"type":"string","x-stream-index":"001"}},"required":["url","task_id","started_at","finished_at","type","created_at","custom"],"title":"AsyncBulkImageModerationEvent","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"},"AsyncExportChannelsEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"003.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.007"},"finished_at":{"format":"date-time","type":"string","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"string","x-stream-index":"003.004"},"started_at":{"format":"date-time","type":"string","x-stream-index":"002.002"},"task_id":{"type":"string","x-stream-index":"002.001"},"type":{"default":"export.channels.success","type":"string","x-stream-index":"003.002"},"url":{"type":"string","x-stream-index":"001"}},"required":["url","task_id","started_at","finished_at","type","created_at","custom"],"title":"AsyncExportChannelsEvent","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"},"AsyncExportErrorEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"003.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.007"},"error":{"type":"string","x-stream-index":"001"},"finished_at":{"format":"date-time","type":"string","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"string","x-stream-index":"003.004"},"started_at":{"format":"date-time","type":"string","x-stream-index":"002.002"},"task_id":{"type":"string","x-stream-index":"002.001"},"type":{"default":"export.channels.error","type":"string","x-stream-index":"003.002"}},"required":["error","task_id","started_at","finished_at","type","created_at","custom"],"title":"AsyncExportErrorEvent","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"},"AsyncExportModerationLogsEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"003.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.007"},"finished_at":{"format":"date-time","type":"string","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"string","x-stream-index":"003.004"},"started_at":{"format":"date-time","type":"string","x-stream-index":"002.002"},"task_id":{"type":"string","x-stream-index":"002.001"},"type":{"default":"export.moderation_logs.success","type":"string","x-stream-index":"003.002"},"url":{"type":"string","x-stream-index":"001"}},"required":["url","task_id","started_at","finished_at","type","created_at","custom"],"title":"AsyncExportModerationLogsEvent","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"},"AsyncExportUsersEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"003.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.007"},"finished_at":{"format":"date-time","type":"string","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"string","x-stream-index":"003.004"},"started_at":{"format":"date-time","type":"string","x-stream-index":"002.002"},"task_id":{"type":"string","x-stream-index":"002.001"},"type":{"default":"export.users.success","type":"string","x-stream-index":"003.002"},"url":{"type":"string","x-stream-index":"001"}},"required":["url","task_id","started_at","finished_at","type","created_at","custom"],"title":"AsyncExportUsersEvent","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"},"AsyncModerationCallbackConfig":{"properties":{"mode":{"enum":["CALLBACK_MODE_NONE","CALLBACK_MODE_REST","CALLBACK_MODE_TWIRP"],"type":"string","x-stream-index":"002"},"server_url":{"type":"string","x-stream-index":"001"}},"type":"object"},"AsyncModerationConfiguration":{"properties":{"callback":{"$ref":"#/components/schemas/AsyncModerationCallbackConfig","x-stream-index":"002"},"timeout_ms":{"format":"int32","type":"integer","x-stream-index":"001"}},"type":"object"},"Attachment":{"description":"An attachment is a message object that represents a file uploaded by a user.","nullable":true,"properties":{"actions":{"items":{"$ref":"#/components/schemas/Action"},"type":"array","x-stream-index":"015"},"asset_url":{"type":"string","x-stream-index":"017"},"author_icon":{"type":"string","x-stream-index":"007"},"author_link":{"type":"string","x-stream-index":"006"},"author_name":{"type":"string","x-stream-index":"005"},"color":{"type":"string","x-stream-index":"003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"018"},"fallback":{"type":"string","x-stream-index":"002"},"fields":{"items":{"$ref":"#/components/schemas/Field"},"type":"array","x-stream-index":"016"},"footer":{"type":"string","x-stream-index":"013"},"footer_icon":{"type":"string","x-stream-index":"014"},"giphy":{"$ref":"#/components/schemas/Images","x-stream-index":"019"},"image_url":{"type":"string","x-stream-index":"011"},"og_scrape_url":{"type":"string","x-stream-index":"020"},"original_height":{"format":"int32","type":"integer","x-stream-index":"022"},"original_width":{"format":"int32","type":"integer","x-stream-index":"021"},"pretext":{"type":"string","x-stream-index":"004"},"text":{"type":"string","x-stream-index":"010"},"thumb_url":{"type":"string","x-stream-index":"012"},"title":{"type":"string","x-stream-index":"008"},"title_link":{"type":"string","x-stream-index":"009"},"type":{"description":"Attachment type (e.g. image, video, url)","title":"Type","type":"string","x-stream-index":"001"}},"required":["custom"],"title":"Attachment","type":"object","x-stream-docs-page-id":"file_uploads"},"AudioSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"001"},"default_device":{"enum":["speaker","earpiece"],"type":"string","x-stream-index":"006"},"mic_default_on":{"type":"boolean","x-stream-index":"004"},"noise_cancellation":{"$ref":"#/components/schemas/NoiseCancellationSettings","x-stream-index":"007"},"opus_dtx_enabled":{"type":"boolean","x-stream-index":"002"},"redundant_coding_enabled":{"type":"boolean","x-stream-index":"003"},"speaker_default_on":{"type":"boolean","x-stream-index":"005"}},"required":["access_request_enabled","opus_dtx_enabled","redundant_coding_enabled","mic_default_on","speaker_default_on","default_device"],"type":"object"},"AutomodDetails":{"properties":{"action":{"type":"string","x-stream-index":"001"},"image_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"005"},"message_details":{"$ref":"#/components/schemas/FlagMessageDetails","x-stream-index":"004"},"original_message_type":{"type":"string","x-stream-index":"002"},"result":{"$ref":"#/components/schemas/MessageModerationResult","x-stream-index":"003"}},"type":"object"},"AzureRequest":{"description":"Config for creating Azure Blob Storage storage","properties":{"abs_account_name":{"description":"The account name","title":"AccountName","type":"string","x-stream-index":"001"},"abs_client_id":{"description":"The client id","title":"ClientID","type":"string","x-stream-index":"003"},"abs_client_secret":{"description":"The client secret","title":"ClientSecret","type":"string","x-stream-index":"004"},"abs_tenant_id":{"description":"The tenant id","title":"TenantID","type":"string","x-stream-index":"002"}},"required":["abs_account_name","abs_tenant_id","abs_client_id","abs_client_secret"],"title":"AzureRequest","type":"object"},"BackstageSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"BanRequest":{"nullable":true,"properties":{"banned_by":{"$ref":"#/components/schemas/UserRequest","description":"User who issued a ban","title":"Banned by","x-stream-index":"010"},"banned_by_id":{"description":"User ID who issued a ban","title":"Banned by ID","type":"string","x-stream-index":"009"},"channel_cid":{"description":"Channel CID to ban user in eg. messaging:123","title":"Channel CID","type":"string","x-stream-index":"006"},"delete_messages":{"enum":["soft","pruning","hard"],"type":"string","x-stream-index":"011"},"ip_ban":{"description":"Whether to perform IP ban or not","title":"IP ban","type":"boolean","x-stream-index":"008"},"reason":{"description":"Ban reason","title":"Reason","type":"string","x-stream-index":"003"},"shadow":{"description":"Whether to perform shadow ban or not","title":"Shadow","type":"boolean","x-stream-index":"007"},"target_user_id":{"description":"ID of user to ban","title":"Target user ID","type":"string","x-stream-index":"001"},"timeout":{"description":"Timeout of ban in minutes. User will be unbanned after this period of time","title":"Timeout","type":"integer","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"012.002"},"user_id":{"type":"string","x-stream-index":"012.001"}},"required":["target_user_id"],"type":"object"},"BanResponse":{"nullable":true,"properties":{"banned_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"006"},"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"007"},"expires":{"format":"date-time","type":"string","x-stream-index":"003"},"reason":{"type":"string","x-stream-index":"004"},"shadow":{"type":"boolean","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"}},"required":["created_at"],"type":"object"},"BlockListOptions":{"properties":{"behavior":{"description":"Blocklist behavior","enum":["flag","block","shadow_block"],"title":"Behavior","type":"string","x-stream-index":"002"},"blocklist":{"description":"Blocklist name","title":"Blocklist","type":"string","x-stream-index":"001"}},"required":["blocklist","behavior"],"type":"object"},"BlockListResponse":{"description":"Block list contains restricted words","properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001"},"id":{"type":"string","x-stream-index":"003"},"name":{"description":"Block list name","title":"Name","type":"string","x-stream-index":"004"},"team":{"type":"string","x-stream-index":"007"},"type":{"description":"Block list type.","title":"Type","type":"string","x-stream-index":"005"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"002"},"words":{"description":"List of words to block","items":{"type":"string"},"title":"Words","type":"array","x-stream-index":"006"}},"required":["name","type","words"],"title":"Block list","type":"object","x-stream-docs-page-id":"block_lists"},"BlockUsersRequest":{"nullable":true,"properties":{"blocked_user_id":{"description":"User id to block","title":"BlockedUserID","type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"required":["blocked_user_id"],"type":"object"},"BlockUsersResponse":{"nullable":true,"properties":{"blocked_by_user_id":{"description":"User id who blocked another user","title":"BlockedByUserID","type":"string","x-stream-index":"002"},"blocked_user_id":{"description":"User id who got blocked","title":"BlockedUserID","type":"string","x-stream-index":"003"},"created_at":{"description":"Timestamp when the user was blocked","format":"date-time","title":"CreatedAt","type":"string","x-stream-index":"004"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration","blocked_by_user_id","blocked_user_id","created_at"],"type":"object"},"BlockedUserResponse":{"nullable":true,"properties":{"blocked_user":{"$ref":"#/components/schemas/UserResponse","description":"User who got blocked","title":"User","x-stream-index":"003"},"blocked_user_id":{"description":"ID of the user who got blocked","title":"UserID","type":"string","x-stream-index":"004"},"created_at":{"format":"date-time","type":"string","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who blocked another user","title":"User","x-stream-index":"001"},"user_id":{"description":"ID of the user who blocked another user","title":"UserID","type":"string","x-stream-index":"002"}},"required":["user","user_id","blocked_user","blocked_user_id","created_at"],"type":"object"},"BroadcastSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettings","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettings","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"CallSettings":{"properties":{"audio":{"$ref":"#/components/schemas/AudioSettings","x-stream-index":"001"},"backstage":{"$ref":"#/components/schemas/BackstageSettings","x-stream-index":"002"},"broadcasting":{"$ref":"#/components/schemas/BroadcastSettings","x-stream-index":"007"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordSettings","x-stream-index":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettings","x-stream-index":"008"},"ingress":{"$ref":"#/components/schemas/IngressSettings","x-stream-index":"014"},"limits":{"$ref":"#/components/schemas/LimitsSettings","x-stream-index":"012"},"recording":{"$ref":"#/components/schemas/RecordSettings","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettings","x-stream-index":"010"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettings","x-stream-index":"004"},"session":{"$ref":"#/components/schemas/SessionSettings","x-stream-index":"013"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettings","x-stream-index":"011"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettings","x-stream-index":"009"},"video":{"$ref":"#/components/schemas/VideoSettings","x-stream-index":"003"}},"type":"object"},"CallType":{"nullable":true,"properties":{"AppPK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"003"},"CreatedAt":{"format":"date-time","type":"string","writeOnly":true,"x-stream-index":"005"},"ExternalStorage":{"type":"string","writeOnly":true,"x-stream-index":"009"},"Name":{"type":"string","writeOnly":true,"x-stream-index":"004"},"NotificationSettings":{"$ref":"#/components/schemas/NotificationSettings","x-stream-index":"008"},"PK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"002"},"Settings":{"$ref":"#/components/schemas/CallSettings","x-stream-index":"007"},"UpdatedAt":{"format":"date-time","type":"string","writeOnly":true,"x-stream-index":"006"}},"required":["PK","AppPK","Name","CreatedAt","UpdatedAt","ExternalStorage"],"type":"object"},"CampaignChannelTemplate":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"002"},"members":{"items":{"type":"string"},"maximum":1000,"type":"array","x-stream-index":"003"},"team":{"maxLength":1000,"type":"string","x-stream-index":"004"},"type":{"maxLength":64,"type":"string","x-stream-index":"001"}},"required":["type","custom"],"type":"object"},"CampaignCompletedEvent":{"nullable":true,"properties":{"campaign":{"$ref":"#/components/schemas/CampaignResponse","x-stream-index":"002"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"received_at":{"format":"date-time","type":"string","x-stream-index":"001.004"},"type":{"default":"campaign.completed","type":"string","x-stream-index":"001.002"}},"required":["type","created_at","custom"],"title":"CampaignCompletedEvent","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"},"CampaignMessageTemplate":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"maximum":30,"type":"array","x-stream-index":"002"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"poll_id":{"type":"string","x-stream-index":"003"},"text":{"type":"string","x-stream-index":"001"}},"required":["text","attachments","poll_id","custom"],"type":"object"},"CampaignResponse":{"properties":{"channel_template":{"$ref":"#/components/schemas/CampaignChannelTemplate","x-stream-index":"016"},"create_channels":{"type":"boolean","x-stream-index":"008"},"created_at":{"format":"date-time","type":"string","x-stream-index":"020"},"description":{"type":"string","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"001"},"message_template":{"$ref":"#/components/schemas/CampaignMessageTemplate","x-stream-index":"015"},"name":{"type":"string","x-stream-index":"007"},"scheduled_for":{"format":"date-time","type":"string","x-stream-index":"013"},"segment_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"002"},"segments":{"items":{"$ref":"#/components/schemas/Segment"},"type":"array","x-stream-index":"003"},"sender":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"005"},"sender_id":{"type":"string","x-stream-index":"004"},"sender_mode":{"type":"string","x-stream-index":"006"},"show_channels":{"type":"boolean","x-stream-index":"009"},"skip_push":{"type":"boolean","x-stream-index":"011"},"skip_webhook":{"type":"boolean","x-stream-index":"012"},"stats":{"$ref":"#/components/schemas/CampaignStatsResponse","x-stream-index":"022"},"status":{"type":"string","x-stream-index":"019"},"stop_at":{"format":"date-time","type":"string","x-stream-index":"014"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"021"},"user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"017"},"users":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"018"}},"required":["id","segment_ids","segments","sender_id","sender_mode","name","create_channels","show_channels","description","skip_push","skip_webhook","user_ids","users","status","created_at","updated_at","stats"],"type":"object"},"CampaignStartedEvent":{"nullable":true,"properties":{"campaign":{"$ref":"#/components/schemas/CampaignResponse","x-stream-index":"002"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"received_at":{"format":"date-time","type":"string","x-stream-index":"001.004"},"type":{"default":"campaign.started","type":"string","x-stream-index":"001.002"}},"required":["type","created_at","custom"],"title":"CampaignStartedEvent","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"},"CampaignStatsResponse":{"properties":{"progress":{"format":"float","type":"number","x-stream-index":"005"},"stats_channels_created":{"format":"int32","type":"integer","x-stream-index":"004"},"stats_completed_at":{"format":"date-time","type":"string","x-stream-index":"002"},"stats_messages_sent":{"format":"int32","type":"integer","x-stream-index":"003"},"stats_started_at":{"format":"date-time","type":"string","x-stream-index":"001"},"stats_users_read":{"format":"int32","type":"integer","x-stream-index":"007"},"stats_users_sent":{"format":"int32","type":"integer","x-stream-index":"006"}},"required":["stats_started_at","stats_completed_at","stats_messages_sent","stats_channels_created","progress","stats_users_sent","stats_users_read"],"type":"object"},"CastPollVoteRequest":{"nullable":true,"properties":{"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"005.002"},"user_id":{"type":"string","x-stream-index":"005.001"},"vote":{"$ref":"#/components/schemas/VoteData","description":"Vote data","title":"VoteData","x-stream-index":"004"}},"type":"object"},"Channel":{"properties":{"active_live_locations":{"items":{"$ref":"#/components/schemas/SharedLocation"},"type":"array","x-stream-index":"034"},"auto_translation_enabled":{"type":"boolean","x-stream-index":"029"},"auto_translation_language":{"type":"string","x-stream-index":"030"},"cid":{"type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/ChannelConfig","x-stream-index":"026"},"config_overrides":{"$ref":"#/components/schemas/ConfigOverrides","x-stream-index":"027"},"cooldown":{"format":"int32","type":"integer","x-stream-index":"031"},"created_at":{"format":"date-time","type":"string","x-stream-index":"009"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"019"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"011"},"disabled":{"type":"boolean","x-stream-index":"017"},"frozen":{"type":"boolean","x-stream-index":"016"},"id":{"type":"string","x-stream-index":"004"},"invites":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"022"},"last_campaigns":{"type":"string","x-stream-index":"032"},"last_message_at":{"format":"date-time","type":"string","x-stream-index":"006"},"member_count":{"format":"int32","type":"integer","x-stream-index":"021"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"020"},"team":{"type":"string","x-stream-index":"028"},"truncated_by":{"$ref":"#/components/schemas/User","x-stream-index":"015"},"type":{"type":"string","x-stream-index":"005"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"010"}},"required":["cid","id","type","created_at","updated_at","frozen","disabled","custom","auto_translation_language"],"type":"object"},"ChannelConfig":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.026"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.021"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.022"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.027"},"blocklist":{"type":"string","x-stream-index":"001.023"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.024"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.025"},"commands":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"connect_events":{"type":"boolean","x-stream-index":"001.004"},"created_at":{"format":"date-time","type":"string","x-stream-index":"002.003"},"custom_events":{"type":"boolean","x-stream-index":"001.012"},"mark_messages_pending":{"type":"boolean","x-stream-index":"001.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"001.020"},"mutes":{"type":"boolean","x-stream-index":"001.009"},"name":{"type":"string","x-stream-index":"001.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"001.028"},"partition_ttl":{"type":"integer","x-stream-index":"001.029"},"polls":{"type":"boolean","x-stream-index":"001.016"},"push_notifications":{"type":"boolean","x-stream-index":"001.013"},"quotes":{"type":"boolean","x-stream-index":"001.008"},"reactions":{"type":"boolean","x-stream-index":"001.006"},"read_events":{"type":"boolean","x-stream-index":"001.003"},"reminders":{"type":"boolean","x-stream-index":"001.014"},"replies":{"type":"boolean","x-stream-index":"001.007"},"search":{"type":"boolean","x-stream-index":"001.005"},"shared_locations":{"type":"boolean","x-stream-index":"001.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.030"},"typing_events":{"type":"boolean","x-stream-index":"001.002"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"002.004"},"uploads":{"type":"boolean","x-stream-index":"001.010"},"url_enrichment":{"type":"boolean","x-stream-index":"001.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"001.017"}},"required":["name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","created_at","updated_at","commands"],"type":"object"},"ChannelConfigWithInfo":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.002.026"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.002.021"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.022"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.002.027"},"blocklist":{"type":"string","x-stream-index":"001.002.023"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.024"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.002.025"},"commands":{"items":{"$ref":"#/components/schemas/Command"},"type":"array","x-stream-index":"001.003"},"connect_events":{"type":"boolean","x-stream-index":"001.002.004"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.001.003"},"custom_events":{"type":"boolean","x-stream-index":"001.002.012"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"002"},"mark_messages_pending":{"type":"boolean","x-stream-index":"001.002.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"001.002.020"},"mutes":{"type":"boolean","x-stream-index":"001.002.009"},"name":{"type":"string","x-stream-index":"001.002.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"001.002.028"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"001.002.029"},"polls":{"type":"boolean","x-stream-index":"001.002.016"},"push_notifications":{"type":"boolean","x-stream-index":"001.002.013"},"quotes":{"type":"boolean","x-stream-index":"001.002.008"},"reactions":{"type":"boolean","x-stream-index":"001.002.006"},"read_events":{"type":"boolean","x-stream-index":"001.002.003"},"reminders":{"type":"boolean","x-stream-index":"001.002.014"},"replies":{"type":"boolean","x-stream-index":"001.002.007"},"search":{"type":"boolean","x-stream-index":"001.002.005"},"shared_locations":{"type":"boolean","x-stream-index":"001.002.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.002.030"},"typing_events":{"type":"boolean","x-stream-index":"001.002.002"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"001.001.004"},"uploads":{"type":"boolean","x-stream-index":"001.002.010"},"url_enrichment":{"type":"boolean","x-stream-index":"001.002.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"001.002.017"}},"required":["created_at","updated_at","name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","commands"],"type":"object"},"ChannelCreatedEvent":{"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"channel.created","type":"string","x-stream-index":"001.001"}},"required":["type","created_at"],"title":"ChannelCreatedEvent","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"},"ChannelDeletedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003.004"},"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"003.005"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"002.002"},"team":{"type":"string","x-stream-index":"001.001"},"type":{"default":"channel.deleted","type":"string","x-stream-index":"002.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"ChannelDeletedEvent","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"},"ChannelExport":{"properties":{"cid":{"type":"string","x-stream-index":"003"},"id":{"description":"Channel ID","title":"ID","type":"string","x-stream-index":"002"},"messages_since":{"description":"Date to export messages since","format":"date-time","title":"Messages since","type":"string","x-stream-index":"004"},"messages_until":{"description":"Date to export messages until","format":"date-time","title":"Messages until","type":"string","x-stream-index":"005"},"type":{"description":"Channel type","title":"Type","type":"string","x-stream-index":"001"}},"title":"Channel Export","type":"object"},"ChannelFrozenEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"channel.frozen","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"ChannelFrozenEvent","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"},"ChannelGetOrCreateRequest":{"nullable":true,"properties":{"data":{"$ref":"#/components/schemas/ChannelInput","x-stream-index":"003"},"hide_for_creator":{"description":"Whether this channel will be hidden for the user who created the channel or not","title":"Hide for creator","type":"boolean","x-stream-index":"007"},"members":{"$ref":"#/components/schemas/PaginationParams","x-stream-index":"010"},"messages":{"$ref":"#/components/schemas/MessagePaginationParams","x-stream-index":"009"},"state":{"description":"Refresh channel state","title":"State","type":"boolean","x-stream-index":"005"},"thread_unread_counts":{"type":"boolean","x-stream-index":"008"},"watchers":{"$ref":"#/components/schemas/PaginationParams","x-stream-index":"011"}},"type":"object"},"ChannelHiddenEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003.004"},"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"003.005"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"clear_history":{"type":"boolean","x-stream-index":"001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"004.002"},"type":{"default":"channel.hidden","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["clear_history","cid","channel_id","channel_type","channel_member_count","type","created_at"],"title":"ChannelHiddenEvent","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"},"ChannelInput":{"properties":{"auto_translation_enabled":{"description":"Enable or disable auto translation","title":"Auto translation","type":"boolean","x-stream-index":"005"},"auto_translation_language":{"description":"Switch auto translation language","title":"Auto translation language","type":"string","x-stream-index":"006"},"config_overrides":{"$ref":"#/components/schemas/ChannelConfig","x-stream-index":"024"},"created_by":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"009"},"created_by_id":{"type":"string","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"015"},"disabled":{"type":"boolean","x-stream-index":"014"},"frozen":{"description":"Freeze or unfreeze the channel","title":"Frozen","type":"boolean","x-stream-index":"013"},"invites":{"items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"type":"array","x-stream-index":"016"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"type":"array","x-stream-index":"018"},"team":{"description":"Team the channel belongs to (if multi-tenant mode is enabled)","title":"Team","type":"string","x-stream-index":"004"},"truncated_by_id":{"type":"string","x-stream-index":"010"}},"type":"object"},"ChannelMember":{"nullable":true,"properties":{"archived_at":{"format":"date-time","type":"string","x-stream-index":"015"},"ban_expires":{"description":"Expiration date of the ban","format":"date-time","title":"Ban expires","type":"string","x-stream-index":"013"},"banned":{"description":"Whether member is banned this channel or not","title":"Banned","type":"boolean","x-stream-index":"012"},"channel_role":{"description":"Role of the member in the channel","title":"Channel Role","type":"string","x-stream-index":"018"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"011"},"invite_accepted_at":{"description":"Date when invite was accepted","format":"date-time","title":"Invited accepted at","type":"string","x-stream-index":"006"},"invite_rejected_at":{"description":"Date when invite was rejected","format":"date-time","title":"Invited rejected at","type":"string","x-stream-index":"007"},"invited":{"description":"Whether member was invited or not","title":"Invited","type":"boolean","x-stream-index":"005"},"is_moderator":{"description":"Whether member is channel moderator or not","title":"Is moderator","type":"boolean","x-stream-index":"003"},"notifications_muted":{"type":"boolean","x-stream-index":"019"},"pinned_at":{"format":"date-time","type":"string","x-stream-index":"016"},"role":{"description":"Permission level of the member in the channel (DEPRECATED: use channel_role instead)","enum":["member","moderator","admin","owner"],"title":"Role","type":"string","x-stream-index":"017"},"shadow_banned":{"description":"Whether member is shadow banned in this channel or not","title":"Shadow banned","type":"boolean","x-stream-index":"014"},"status":{"type":"string","x-stream-index":"008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"},"user_id":{"title":"User ID","type":"string","x-stream-index":"001"}},"required":["custom","created_at","updated_at","banned","shadow_banned","channel_role","notifications_muted"],"title":"Channel member","type":"object"},"ChannelMemberResponse":{"nullable":true,"properties":{"archived_at":{"format":"date-time","type":"string","x-stream-index":"016"},"ban_expires":{"description":"Expiration date of the ban","format":"date-time","title":"Ban expires","type":"string","x-stream-index":"013"},"banned":{"description":"Whether member is banned this channel or not","title":"Banned","type":"boolean","x-stream-index":"012"},"channel_role":{"description":"Role of the member in the channel","title":"Channel Role","type":"string","x-stream-index":"018"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"011"},"invite_accepted_at":{"description":"Date when invite was accepted","format":"date-time","title":"Invited accepted at","type":"string","x-stream-index":"006"},"invite_rejected_at":{"description":"Date when invite was rejected","format":"date-time","title":"Invited rejected at","type":"string","x-stream-index":"007"},"invited":{"description":"Whether member was invited or not","title":"Invited","type":"boolean","x-stream-index":"005"},"is_moderator":{"description":"Whether member is channel moderator or not","title":"Is moderator","type":"boolean","x-stream-index":"003"},"notifications_muted":{"type":"boolean","x-stream-index":"019"},"pinned_at":{"format":"date-time","type":"string","x-stream-index":"015"},"role":{"description":"Permission level of the member in the channel (DEPRECATED: use channel_role instead)","enum":["member","moderator","admin","owner"],"title":"Role","type":"string","x-stream-index":"017"},"shadow_banned":{"description":"Whether member is shadow banned in this channel or not","title":"Shadow banned","type":"boolean","x-stream-index":"014"},"status":{"type":"string","x-stream-index":"008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"},"user_id":{"title":"User ID","type":"string","x-stream-index":"001"}},"required":["custom","created_at","updated_at","banned","shadow_banned","channel_role","notifications_muted"],"title":"Channel member","type":"object"},"ChannelMessages":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001"},"messages":{"items":{"$ref":"#/components/schemas/Message"},"type":"array","x-stream-index":"002"}},"required":["messages"],"type":"object"},"ChannelMute":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel that is muted","title":"Channel","x-stream-index":"002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"004"},"expires":{"description":"Date/time of mute expiration","format":"date-time","title":"Expires","type":"string","x-stream-index":"003"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Owner of channel mute","title":"User","x-stream-index":"001"}},"required":["created_at","updated_at"],"type":"object"},"ChannelMutedEvent":{"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"channel.muted","type":"string","x-stream-index":"001.001"}},"required":["type","created_at"],"title":"ChannelMutedEvent","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"},"ChannelOwnCapability":{"description":"All possibility of string to use","enum":["ban-channel-members","cast-poll-vote","connect-events","create-attachment","delete-any-message","delete-channel","delete-own-message","flag-message","freeze-channel","join-channel","leave-channel","mute-channel","pin-message","query-poll-votes","quote-message","read-events","search-messages","send-custom-events","send-links","send-message","send-poll","send-reaction","send-reply","send-restricted-visibility-message","send-typing-events","set-channel-cooldown","share-location","skip-slow-mode","slow-mode","typing-events","update-any-message","update-channel","update-channel-members","update-own-message","update-thread","upload-file"],"title":"ChannelOwnCapability","type":"string"},"ChannelPushPreferences":{"properties":{"chat_level":{"type":"string","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"string","x-stream-index":"002"}},"type":"object"},"ChannelResponse":{"description":"Represents channel in chat","properties":{"auto_translation_enabled":{"description":"Whether auto translation is enabled or not","title":"Auto translation","type":"boolean","x-stream-index":"017"},"auto_translation_language":{"description":"Language to translate to when auto translation is active","title":"Auto translation language","type":"string","x-stream-index":"018"},"blocked":{"description":"Whether this channel is blocked by current user or not","title":"Blocked","type":"boolean","x-stream-index":"023"},"cid":{"description":"Channel CID (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/ChannelConfigWithInfo","description":"Channel configuration","title":"ChannelConfigWithInfo","x-stream-index":"013"},"cooldown":{"description":"Cooldown period after sending each message","format":"int32","title":"Cooldown","type":"integer","x-stream-index":"020"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"005"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"Creator of the channel","title":"UserResponse","x-stream-index":"008"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"026"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"string","x-stream-index":"007"},"disabled":{"type":"boolean","x-stream-index":"010"},"frozen":{"description":"Whether channel is frozen or not","title":"Frozen","type":"boolean","x-stream-index":"009"},"hidden":{"description":"Whether this channel is hidden by current user or not","title":"Hidden","type":"boolean","x-stream-index":"022"},"hide_messages_before":{"description":"Date since when the message history is accessible","format":"date-time","title":"Hide messages before","type":"string","x-stream-index":"019"},"id":{"description":"Channel unique ID","title":"ID","type":"string","x-stream-index":"001"},"last_message_at":{"description":"Date of the last message sent","format":"date-time","title":"Last message at","type":"string","x-stream-index":"004"},"member_count":{"description":"Number of members in the channel","format":"int32","title":"Member count","type":"integer","x-stream-index":"012"},"members":{"description":"List of channel members (max 100)","items":{"$ref":"#/components/schemas/ChannelMember"},"title":"ChannelMembers","type":"array","x-stream-index":"011"},"mute_expires_at":{"description":"Date of mute expiration","format":"date-time","title":"Mute expires at","type":"string","x-stream-index":"015"},"muted":{"description":"Whether this channel is muted or not","title":"Muted","type":"boolean","x-stream-index":"014"},"own_capabilities":{"description":"List of channel capabilities of authenticated user","items":{"$ref":"#/components/schemas/ChannelOwnCapability"},"title":"ChannelOwnCapability","type":"array","x-stream-index":"021"},"team":{"description":"Team the channel belongs to (multi-tenant only)","title":"Team","type":"string","x-stream-index":"016"},"truncated_at":{"description":"Date of the latest truncation of the channel","format":"date-time","title":"UserResponse","type":"string","x-stream-index":"024"},"truncated_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"025"},"type":{"description":"Type of the channel","title":"Type","type":"string","x-stream-docs-page-id":"channel_features","x-stream-index":"002"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"006"}},"required":["id","type","cid","created_at","updated_at","frozen","disabled","custom"],"title":"Channel","type":"object"},"ChannelStateResponse":{"nullable":true,"properties":{"active_live_locations":{"items":{"$ref":"#/components/schemas/SharedLocationResponseData"},"type":"array","x-stream-index":"001.015"},"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001.001"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001.014"},"duration":{"type":"string","x-stream-index":"002.001"},"hidden":{"type":"boolean","x-stream-index":"001.011"},"hide_messages_before":{"format":"date-time","type":"string","x-stream-index":"001.012"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"001.007"},"membership":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"001.008"},"messages":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","x-stream-index":"001.002"},"pending_messages":{"items":{"$ref":"#/components/schemas/PendingMessageResponse"},"type":"array","x-stream-index":"001.013"},"pinned_messages":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","x-stream-index":"001.003"},"push_preferences":{"$ref":"#/components/schemas/ChannelPushPreferences","x-stream-index":"001.009"},"read":{"items":{"$ref":"#/components/schemas/ReadStateResponse"},"type":"array","x-stream-index":"001.006"},"threads":{"items":{"$ref":"#/components/schemas/ThreadStateResponse"},"type":"array","x-stream-index":"001.010"},"watcher_count":{"format":"int32","type":"integer","x-stream-index":"001.004"},"watchers":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"001.005"}},"required":["messages","pinned_messages","members","threads","duration"],"type":"object"},"ChannelStateResponseFields":{"properties":{"active_live_locations":{"description":"Active live locations in the channel","items":{"$ref":"#/components/schemas/SharedLocationResponseData"},"title":"Active Live Locations","type":"array","x-stream-index":"015"},"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"014"},"hidden":{"description":"Whether this channel is hidden or not","title":"Hidden","type":"boolean","x-stream-index":"011"},"hide_messages_before":{"description":"Messages before this date are hidden from the user","format":"date-time","title":"Hide messages before","type":"string","x-stream-index":"012"},"members":{"description":"List of channel members","items":{"$ref":"#/components/schemas/ChannelMember"},"title":"Members","type":"array","x-stream-index":"007"},"membership":{"$ref":"#/components/schemas/ChannelMember","description":"Current user membership object","title":"Membership","x-stream-index":"008"},"messages":{"description":"List of channel messages","items":{"$ref":"#/components/schemas/MessageResponse"},"title":"Message","type":"array","x-stream-index":"002"},"pending_messages":{"description":"Pending messages that this user has sent","items":{"$ref":"#/components/schemas/PendingMessageResponse"},"title":"Pending messages","type":"array","x-stream-index":"013"},"pinned_messages":{"description":"List of pinned messages in the channel","items":{"$ref":"#/components/schemas/MessageResponse"},"title":"Pinned messages","type":"array","x-stream-docs-page-id":"pinned_messages","x-stream-index":"003"},"push_preferences":{"$ref":"#/components/schemas/ChannelPushPreferences","x-stream-index":"009"},"read":{"description":"List of read states","items":{"$ref":"#/components/schemas/ReadStateResponse"},"title":"Read","type":"array","x-stream-index":"006"},"threads":{"items":{"$ref":"#/components/schemas/ThreadStateResponse"},"type":"array","x-stream-index":"010"},"watcher_count":{"description":"Number of channel watchers","format":"int32","title":"Watcher count","type":"integer","x-stream-index":"004"},"watchers":{"description":"List of user who is watching the channel","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Watchers","type":"array","x-stream-index":"005"}},"required":["messages","pinned_messages","members","threads"],"type":"object"},"ChannelTruncatedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001.004"},"channel_id":{"type":"string","x-stream-index":"001.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"001.005"},"channel_type":{"type":"string","x-stream-index":"001.003"},"cid":{"type":"string","x-stream-index":"001.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"002.002"},"type":{"default":"channel.truncated","type":"string","x-stream-index":"002.001"}},"required":["cid","channel_id","channel_type","channel_member_count","type","created_at"],"title":"ChannelTruncatedEvent","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"},"ChannelTypeConfig":{"nullable":true,"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"003.002.026"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"003.002.021"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.002.022"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"003.002.027"},"blocklist":{"type":"string","x-stream-index":"003.002.023"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.002.024"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"003.002.025"},"commands":{"items":{"$ref":"#/components/schemas/Command"},"type":"array","x-stream-index":"003.003"},"connect_events":{"type":"boolean","x-stream-index":"003.002.004"},"created_at":{"format":"date-time","type":"string","x-stream-index":"003.001.003"},"custom_events":{"type":"boolean","x-stream-index":"003.002.012"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"002"},"mark_messages_pending":{"type":"boolean","x-stream-index":"003.002.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"003.002.020"},"mutes":{"type":"boolean","x-stream-index":"003.002.009"},"name":{"type":"string","x-stream-index":"003.002.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"003.002.028"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"003.002.029"},"permissions":{"items":{"$ref":"#/components/schemas/PolicyRequest"},"type":"array","x-stream-index":"001"},"polls":{"type":"boolean","x-stream-index":"003.002.016"},"push_notifications":{"type":"boolean","x-stream-index":"003.002.013"},"quotes":{"type":"boolean","x-stream-index":"003.002.008"},"reactions":{"type":"boolean","x-stream-index":"003.002.006"},"read_events":{"type":"boolean","x-stream-index":"003.002.003"},"reminders":{"type":"boolean","x-stream-index":"003.002.014"},"replies":{"type":"boolean","x-stream-index":"003.002.007"},"search":{"type":"boolean","x-stream-index":"003.002.005"},"shared_locations":{"type":"boolean","x-stream-index":"003.002.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"003.002.030"},"typing_events":{"type":"boolean","x-stream-index":"003.002.002"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"003.001.004"},"uploads":{"type":"boolean","x-stream-index":"003.002.010"},"url_enrichment":{"type":"boolean","x-stream-index":"003.002.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"003.002.017"}},"required":["permissions","grants","created_at","updated_at","name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","commands"],"type":"object"},"ChannelUnFrozenEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"channel.unfrozen","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"ChannelUnFrozenEvent","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"},"ChannelUnmutedEvent":{"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"channel.unmuted","type":"string","x-stream-index":"001.001"}},"required":["type","created_at"],"title":"ChannelUnmutedEvent","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"},"ChannelUpdatedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"004.004"},"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"004.005"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"003.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"002.001"},"type":{"default":"channel.updated","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"ChannelUpdatedEvent","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"},"ChannelVisibleEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"001.002"},"channel_type":{"type":"string","x-stream-index":"001.003"},"cid":{"type":"string","x-stream-index":"001.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"003.002"},"type":{"default":"channel.visible","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"ChannelVisibleEvent","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"},"CheckExternalStorageResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"file_url":{"type":"string","x-stream-index":"002"}},"required":["duration","file_url"],"title":"Response","type":"object"},"CheckPushRequest":{"description":"Check push request","nullable":true,"properties":{"apn_template":{"description":"Push message template for APN","title":"APN template","type":"string","x-stream-docs-page-id":"push_template","x-stream-index":"002"},"event_type":{"description":"Type of event for push templates (default: message.new)","enum":["message.new","message.updated","reaction.new","reaction.updated","notification.reminder_due"],"title":"Event type","type":"string","x-stream-index":"008"},"firebase_data_template":{"description":"Push message data template for Firebase","title":"Firebase data template","type":"string","x-stream-docs-page-id":"push_template","x-stream-index":"004"},"firebase_template":{"description":"Push message template for Firebase","title":"Firebase template","type":"string","x-stream-docs-page-id":"push_template","x-stream-index":"003"},"message_id":{"description":"Message ID to send push notification for","title":"Message ID","type":"string","x-stream-index":"001"},"push_provider_name":{"description":"Name of push provider","title":"Name of push provider","type":"string","x-stream-index":"007"},"push_provider_type":{"description":"Push provider type","enum":["firebase","apn","huawei","xiaomi"],"title":"Type of push provider","type":"string","x-stream-index":"006"},"skip_devices":{"description":"Don't require existing devices to render templates","title":"Skip devices","type":"boolean","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"009.002"},"user_id":{"type":"string","x-stream-index":"009.001"}},"title":"CheckPushRequest","type":"object"},"CheckPushResponse":{"nullable":true,"properties":{"device_errors":{"additionalProperties":{"$ref":"#/components/schemas/DeviceErrorInfo"},"description":"Object with device errors","title":"Device errors","type":"object","x-stream-index":"001","x-stream-map":{"key":"device_id"}},"duration":{"type":"string","x-stream-index":"008.001"},"event_type":{"description":"The event type that was tested","title":"Event type","type":"string","x-stream-index":"004"},"general_errors":{"description":"List of general errors","items":{"type":"string"},"title":"General errors","type":"array","x-stream-index":"002"},"rendered_apn_template":{"title":"Rendered APN template","type":"string","x-stream-index":"005"},"rendered_firebase_template":{"title":"Rendered Firebase template","type":"string","x-stream-index":"006"},"rendered_message":{"additionalProperties":{"type":"string"},"title":"Rendered message","type":"object","x-stream-index":"007"},"skip_devices":{"description":"Don't require existing devices to render templates","title":"Skip devices","type":"boolean","x-stream-index":"003"}},"required":["duration"],"type":"object"},"CheckSNSRequest":{"nullable":true,"properties":{"sns_key":{"description":"AWS SNS access key","title":"SNS key","type":"string","x-stream-index":"002"},"sns_secret":{"description":"AWS SNS key secret","title":"SNS secret","type":"string","x-stream-index":"003"},"sns_topic_arn":{"description":"AWS SNS topic ARN","title":"SNS Topic ARN","type":"string","x-stream-index":"001"}},"type":"object"},"CheckSNSResponse":{"nullable":true,"properties":{"data":{"additionalProperties":{},"description":"Error data","title":"ReadOnlyData","type":"object","x-stream-index":"003"},"duration":{"type":"string","x-stream-index":"004.001"},"error":{"description":"Error text","title":"Error","type":"string","x-stream-index":"002"},"status":{"description":"Validation result","enum":["ok","error"],"title":"Status","type":"string","x-stream-index":"001"}},"required":["status","duration"],"type":"object"},"CheckSQSRequest":{"nullable":true,"properties":{"sqs_key":{"description":"AWS SQS access key","title":"SQS key","type":"string","x-stream-index":"002"},"sqs_secret":{"description":"AWS SQS key secret","title":"SQS secret","type":"string","x-stream-index":"003"},"sqs_url":{"description":"AWS SQS endpoint URL","title":"SQS URL","type":"string","x-stream-index":"001"}},"type":"object"},"CheckSQSResponse":{"nullable":true,"properties":{"data":{"additionalProperties":{},"description":"Error data","title":"ReadOnlyData","type":"object","x-stream-index":"003"},"duration":{"type":"string","x-stream-index":"004.001"},"error":{"description":"Error text","title":"Error","type":"string","x-stream-index":"002"},"status":{"description":"Validation result","enum":["ok","error"],"title":"Status","type":"string","x-stream-index":"001"}},"required":["status","duration"],"type":"object"},"Command":{"description":"Represents custom chat command","nullable":true,"properties":{"args":{"description":"Arguments help text, shown in commands auto-completion","title":"Arguments","type":"string","x-stream-index":"006"},"created_at":{"description":"Date/time of creation","format":"date-time","readOnly":true,"title":"Created at","type":"string","x-stream-index":"001"},"description":{"description":"Description, shown in commands auto-completion","title":"Description","type":"string","x-stream-index":"005"},"name":{"description":"Unique command name","title":"Name","type":"string","x-stream-index":"004"},"set":{"description":"Set name used for grouping commands","title":"Set","type":"string","x-stream-index":"007"},"updated_at":{"description":"Date/time of the last update","format":"date-time","readOnly":true,"title":"Updated at","type":"string","x-stream-index":"002"}},"required":["name","description","args","set"],"title":"Command","type":"object"},"CommitMessageRequest":{"nullable":true,"type":"object"},"ConfigOverrides":{"properties":{"blocklist":{"type":"string","x-stream-index":"008"},"blocklist_behavior":{"enum":["flag","block"],"type":"string","x-stream-index":"009"},"commands":{"items":{"type":"string"},"type":"array","x-stream-index":"011"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"010"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"007"},"quotes":{"type":"boolean","x-stream-index":"004"},"reactions":{"type":"boolean","x-stream-index":"002"},"replies":{"type":"boolean","x-stream-index":"003"},"shared_locations":{"type":"boolean","x-stream-index":"013"},"typing_events":{"type":"boolean","x-stream-index":"001"},"uploads":{"type":"boolean","x-stream-index":"005"},"url_enrichment":{"type":"boolean","x-stream-index":"006"},"user_message_reminders":{"type":"boolean","x-stream-index":"012"}},"required":["grants","commands"],"type":"object"},"CreateBlockListRequest":{"description":"Block list contains restricted words","nullable":true,"properties":{"name":{"description":"Block list name","maxLength":255,"title":"Name","type":"string","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"004"},"type":{"description":"Block list type.","enum":["regex","domain","domain_allowlist","email","word"],"title":"Type","type":"string","x-stream-index":"003"},"words":{"description":"List of words to block","items":{"type":"string"},"minimum":1,"title":"Words","type":"array","x-stream-index":"002"}},"required":["name","words"],"title":"Block list","type":"object","x-stream-docs-page-id":"block_lists"},"CreateBlockListResponse":{"description":"Basic response information","nullable":true,"properties":{"blocklist":{"$ref":"#/components/schemas/BlockListResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["duration"],"title":"Response","type":"object"},"CreateChannelTypeRequest":{"nullable":true,"properties":{"automod":{"description":"Automod","enum":["disabled","simple","AI"],"title":"Automod","type":"string","x-stream-index":"019"},"automod_behavior":{"description":"Automod behavior","enum":["flag","block"],"title":"Automod behavior","type":"string","x-stream-index":"020"},"blocklist":{"description":"Blocklist","title":"Blocklist","type":"string","x-stream-index":"024"},"blocklist_behavior":{"description":"Blocklist behavior","enum":["flag","block","shadow_block"],"title":"Blocklist behavior","type":"string","x-stream-index":"025"},"blocklists":{"description":"Blocklists","items":{"$ref":"#/components/schemas/BlockListOptions"},"title":"Blocklists","type":"array","x-stream-index":"026"},"commands":{"description":"List of commands that channel supports","items":{"type":"string"},"title":"Commands","type":"array","x-stream-index":"021"},"connect_events":{"description":"Connect events","title":"Connect events","type":"boolean","x-stream-index":"004"},"custom_events":{"description":"Custom events","title":"Custom events","type":"boolean","x-stream-index":"011"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"List of grants for the channel type","title":"Grants","type":"object","x-stream-index":"023"},"mark_messages_pending":{"description":"Mark messages pending","title":"Mark messages pending","type":"boolean","x-stream-index":"013"},"max_message_length":{"description":"Max message length","format":"int32","title":"Max message length","type":"integer","x-stream-index":"018"},"message_retention":{"description":"Message retention","enum":["infinite","numeric"],"title":"Message retention","type":"string","x-stream-index":"017"},"mutes":{"description":"Mutes","title":"Mutes","type":"boolean","x-stream-index":"008"},"name":{"description":"Channel type name","title":"Name","type":"string","x-stream-index":"001"},"partition_size":{"description":"Partition size","format":"int32","minimum":10,"title":"Partition size","type":"integer","x-stream-index":"027"},"partition_ttl":{"description":"Partition TTL","example":"24h","format":"duration","nullable":true,"title":"Partition TTL","type":"string","x-stream-index":"028"},"permissions":{"description":"List of permissions for the channel type","items":{"$ref":"#/components/schemas/PolicyRequest"},"title":"Permissions","type":"array","x-stream-index":"022"},"polls":{"description":"Polls","title":"Polls","type":"boolean","x-stream-index":"014"},"push_notifications":{"description":"Push notifications","title":"Push notifications","type":"boolean","x-stream-index":"012"},"reactions":{"description":"Reactions","title":"Reactions","type":"boolean","x-stream-index":"005"},"read_events":{"description":"Read events","title":"Read events","type":"boolean","x-stream-index":"003"},"replies":{"description":"Replies","title":"Replies","type":"boolean","x-stream-index":"006"},"search":{"description":"Search","title":"Search","type":"boolean","x-stream-index":"007"},"shared_locations":{"description":"Enables shared location messages","title":"Shared locations","type":"boolean","x-stream-index":"016"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"029"},"typing_events":{"description":"Typing events","title":"Typing events","type":"boolean","x-stream-index":"002"},"uploads":{"description":"Uploads","title":"Uploads","type":"boolean","x-stream-index":"009"},"url_enrichment":{"description":"URL enrichment","title":"URL enrichment","type":"boolean","x-stream-index":"010"},"user_message_reminders":{"type":"boolean","x-stream-index":"015"}},"required":["name","max_message_length","automod","automod_behavior"],"title":"CreateChannelTypeRequest","type":"object"},"CreateChannelTypeResponse":{"nullable":true,"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.001.026"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.001.021"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.001.022"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.001.027"},"blocklist":{"type":"string","x-stream-index":"001.001.023"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.001.024"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.001.025"},"commands":{"items":{"type":"string"},"type":"array","x-stream-index":"001.003"},"connect_events":{"type":"boolean","x-stream-index":"001.001.004"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002.003"},"custom_events":{"type":"boolean","x-stream-index":"001.001.012"},"duration":{"type":"string","x-stream-index":"004.001"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"003"},"mark_messages_pending":{"type":"boolean","x-stream-index":"001.001.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"001.001.020"},"mutes":{"type":"boolean","x-stream-index":"001.001.009"},"name":{"type":"string","x-stream-index":"001.001.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"001.001.028"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"001.001.029"},"permissions":{"items":{"$ref":"#/components/schemas/PolicyRequest"},"type":"array","x-stream-index":"002"},"polls":{"type":"boolean","x-stream-index":"001.001.016"},"push_notifications":{"type":"boolean","x-stream-index":"001.001.013"},"quotes":{"type":"boolean","x-stream-index":"001.001.008"},"reactions":{"type":"boolean","x-stream-index":"001.001.006"},"read_events":{"type":"boolean","x-stream-index":"001.001.003"},"reminders":{"type":"boolean","x-stream-index":"001.001.014"},"replies":{"type":"boolean","x-stream-index":"001.001.007"},"search":{"type":"boolean","x-stream-index":"001.001.005"},"shared_locations":{"type":"boolean","x-stream-index":"001.001.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.001.030"},"typing_events":{"type":"boolean","x-stream-index":"001.001.002"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"001.002.004"},"uploads":{"type":"boolean","x-stream-index":"001.001.010"},"url_enrichment":{"type":"boolean","x-stream-index":"001.001.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"001.001.017"}},"required":["name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","created_at","updated_at","commands","permissions","grants","duration"],"type":"object"},"CreateCommandRequest":{"description":"Create a new command","nullable":true,"properties":{"args":{"description":"Arguments help text, shown in commands auto-completion","maxLength":255,"title":"Arguments","type":"string","x-stream-index":"003"},"description":{"description":"Description, shown in commands auto-completion","maxLength":255,"title":"Description","type":"string","x-stream-index":"002"},"name":{"description":"Unique command name","maxLength":255,"minLength":1,"title":"Name","type":"string","x-stream-index":"001"},"set":{"description":"Set name used for grouping commands","maxLength":255,"title":"Set","type":"string","x-stream-index":"004"}},"required":["name","description"],"title":"CreateCommandRequest","type":"object"},"CreateCommandResponse":{"nullable":true,"properties":{"command":{"$ref":"#/components/schemas/Command","description":"Command object","title":"Command","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["duration"],"title":"CreateCommandResponse","type":"object"},"CreateDeviceRequest":{"description":"Create device request","nullable":true,"properties":{"id":{"description":"Device ID","maxLength":255,"minLength":1,"title":"ID","type":"string","x-stream-index":"001"},"push_provider":{"description":"Push provider","enum":["firebase","apn","huawei","xiaomi"],"title":"PushProvider","type":"string","x-stream-index":"002"},"push_provider_name":{"description":"Push provider name","title":"PushProviderName","type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"005.002"},"user_id":{"description":"**Server-side only**. User ID which server acts upon","title":"User ID","type":"string","x-stream-index":"005.001"},"voip_token":{"description":"When true the token is for Apple VoIP push notifications","title":"VoipToken","type":"boolean","x-stream-index":"004"}},"required":["id","push_provider"],"title":"CreateDeviceRequest","type":"object"},"CreateExternalStorageRequest":{"description":"Create external storage","nullable":true,"properties":{"aws_s3":{"$ref":"#/components/schemas/S3Request","description":"Only required if you want to create an Amazon S3 storage","title":"AwsS3","x-stream-index":"003.004"},"azure_blob":{"$ref":"#/components/schemas/AzureRequest","description":"Only required if you want to create an Azure Blob Storage","title":"AzureBlob","x-stream-index":"003.006"},"bucket":{"description":"The name of the bucket on the service provider","title":"Bucket","type":"string","x-stream-index":"003.002"},"gcs_credentials":{"type":"string","x-stream-index":"003.005"},"name":{"description":"The name of the provider, this must be unique","title":"Name","type":"string","x-stream-index":"001"},"path":{"description":"The path prefix to use for storing files","title":"Path","type":"string","x-stream-index":"003.003"},"storage_type":{"description":"The type of storage to use","enum":["s3","gcs","abs"],"title":"StorageType","type":"string","x-stream-index":"003.001"}},"required":["name","storage_type","bucket"],"title":"CreateExternalStorageRequest","type":"object"},"CreateExternalStorageResponse":{"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"},"CreateGuestRequest":{"nullable":true,"properties":{"user":{"$ref":"#/components/schemas/UserRequest","description":"User object which server acts upon","title":"User","x-stream-index":"001"}},"required":["user"],"type":"object"},"CreateGuestResponse":{"nullable":true,"properties":{"access_token":{"description":"the access token to authenticate the user","title":"Access token","type":"string","x-stream-index":"002"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User object which server acts upon","title":"User","x-stream-index":"001"}},"required":["user","access_token","duration"],"type":"object"},"CreateImportRequest":{"nullable":true,"properties":{"mode":{"enum":["insert","upsert"],"type":"string","x-stream-index":"002"},"path":{"type":"string","x-stream-index":"001"}},"required":["path","mode"],"type":"object"},"CreateImportResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"import_task":{"$ref":"#/components/schemas/ImportTask","x-stream-index":"001"}},"required":["duration"],"title":"Response","type":"object"},"CreateImportURLRequest":{"nullable":true,"properties":{"filename":{"type":"string","x-stream-index":"001"}},"type":"object"},"CreateImportURLResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"path":{"type":"string","x-stream-index":"001"},"upload_url":{"type":"string","x-stream-index":"002"}},"required":["path","upload_url","duration"],"title":"Response","type":"object"},"CreatePollOptionRequest":{"nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"003"},"text":{"description":"Option text","title":"string","type":"string","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"required":["text"],"type":"object"},"CreatePollRequest":{"description":"Contains all information needed to create a new poll","nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"011"},"allow_answers":{"description":"Indicates whether users can suggest user defined answers","title":"Allow answers","type":"boolean","x-stream-index":"009"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"008"},"description":{"description":"A description of the poll","title":"Description","type":"string","x-stream-index":"003"},"enforce_unique_vote":{"description":"Indicates whether users can cast multiple votes","title":"Multiple choice","type":"boolean","x-stream-index":"006"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"is_closed":{"description":"Indicates whether the poll is open for voting","title":"Is closed","type":"boolean","x-stream-index":"010"},"max_votes_allowed":{"description":"Indicates the maximum amount of votes a user can cast","format":"int32","maximum":10,"title":"Maximum votes allowed","type":"integer","x-stream-index":"007"},"name":{"description":"The name of the poll","title":"Name","type":"string","x-stream-index":"002"},"options":{"items":{"$ref":"#/components/schemas/PollOptionInput"},"maximum":100,"type":"array","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"012.002"},"user_id":{"type":"string","x-stream-index":"012.001"},"voting_visibility":{"enum":["anonymous","public"],"type":"string","x-stream-index":"005"}},"required":["name"],"title":"Create Poll Request","type":"object"},"CreateReminderRequest":{"nullable":true,"properties":{"remind_at":{"format":"date-time","type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"type":"object"},"CreateRoleRequest":{"nullable":true,"properties":{"name":{"description":"Role name","maxLength":64,"title":"Name","type":"string","x-stream-index":"001"}},"required":["name"],"type":"object"},"CreateRoleResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"role":{"$ref":"#/components/schemas/Role","x-stream-index":"002"}},"required":["duration","role"],"title":"Response","type":"object"},"DataDogInfo":{"properties":{"api_key":{"type":"string","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"003"},"site":{"type":"string","x-stream-index":"002"}},"type":"object"},"DeactivateUserRequest":{"nullable":true,"properties":{"created_by_id":{"description":"ID of the user who deactivated the user","title":"Created by ID","type":"string","x-stream-index":"003"},"mark_messages_deleted":{"description":"Makes messages appear to be deleted","title":"Mark messages deleted","type":"boolean","x-stream-index":"002"}},"type":"object"},"DeactivateUserResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Deactivated user object","title":"User","x-stream-index":"001"}},"required":["duration"],"type":"object"},"DeactivateUsersRequest":{"description":"Deactivate users request","nullable":true,"properties":{"created_by_id":{"description":"ID of the user who deactivated the users","title":"Created by ID","type":"string","x-stream-index":"003"},"mark_channels_deleted":{"type":"boolean","x-stream-index":"004"},"mark_messages_deleted":{"description":"Makes messages appear to be deleted","title":"Mark messages deleted","type":"boolean","x-stream-index":"002"},"user_ids":{"description":"User IDs to deactivate","items":{"type":"string"},"maximum":100,"minimum":1,"title":"User IDs","type":"array","x-stream-index":"001"}},"required":["user_ids"],"title":"DeactivateUsersRequest","type":"object"},"DeactivateUsersResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"task_id":{"type":"string","x-stream-index":"001"}},"required":["task_id","duration"],"title":"Response","type":"object"},"DeleteChannelResponse":{"description":"Basic response information","nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"Response","type":"object"},"DeleteChannelsRequest":{"nullable":true,"properties":{"cids":{"description":"All channels that should be deleted","items":{"type":"string"},"maximum":100,"minimum":1,"title":"Channels CID","type":"array","x-stream-index":"001"},"hard_delete":{"description":"Specify if channels and all ressources should be hard deleted","title":"Hard delete","type":"boolean","x-stream-index":"002"}},"required":["cids"],"type":"object"},"DeleteChannelsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"result":{"additionalProperties":{"$ref":"#/components/schemas/DeleteChannelsResultResponse"},"description":"Map of channel IDs and their deletion results","title":"Result","type":"object","x-stream-index":"001"},"task_id":{"type":"string","x-stream-index":"002"}},"required":["duration"],"type":"object"},"DeleteChannelsResultResponse":{"nullable":true,"properties":{"error":{"type":"string","x-stream-index":"002"},"status":{"type":"string","x-stream-index":"001"}},"required":["status"],"type":"object"},"DeleteCommandResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"name":{"description":"Command name","title":"Name","type":"string","x-stream-index":"001"}},"required":["name","duration"],"title":"DeleteCommandResponse","type":"object"},"DeleteExternalStorageResponse":{"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"},"DeleteMessageResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001"}},"required":["message","duration"],"title":"Response","type":"object"},"DeleteReactionResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001"},"reaction":{"$ref":"#/components/schemas/ReactionResponse","x-stream-index":"002"}},"required":["message","reaction","duration"],"title":"Response","type":"object"},"DeleteReminderResponse":{"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"},"DeleteSegmentTargetsRequest":{"nullable":true,"properties":{"target_ids":{"description":"Target IDs","items":{"type":"string"},"maximum":100,"minimum":1,"title":"[]string","type":"array","x-stream-index":"002"}},"required":["target_ids"],"type":"object"},"DeleteUsersRequest":{"nullable":true,"properties":{"calls":{"description":"Calls delete mode.\nAffected calls are those that include exactly two members, one of whom is the user being deleted.\n\n* null or empty string - doesn't delete any calls\n* soft - marks user's calls and their related data as deleted (soft-delete)\n* hard - deletes user's calls and their data completely (hard-delete)\n","enum":["soft","hard"],"title":"Delete User's calls","type":"string","x-stream-index":"001.002.004"},"conversations":{"description":"Conversation channels delete mode.\nConversation channel is any channel which only has two members one of which is the user being deleted.\n\n* null or empty string - doesn't delete any conversation channels\n* soft - marks all conversation channels as deleted (same effect as Delete Channels with 'hard' option disabled)\n* hard - deletes channel and all its data completely including messages (same effect as Delete Channels with 'hard' option enabled)\n","enum":["soft","hard"],"title":"Delete Conversations","type":"string","x-stream-index":"001.002.003"},"files":{"description":"Delete user files.\n* false or empty string - doesn't delete any files\n* true - deletes all files uploaded by the user, including images and attachments.\n","title":"Delete User's files","type":"boolean","x-stream-index":"001.002.005"},"messages":{"description":"Message delete mode.\n\n* null or empty string - doesn't delete user messages\n* soft - marks all user messages as deleted without removing any related message data\n* pruning - marks all user messages as deleted, nullifies message information and removes some message data such as reactions and flags\n* hard - deletes messages completely with all related information\n","enum":["soft","pruning","hard"],"title":"Delete Messages","type":"string","x-stream-index":"001.002.002"},"new_call_owner_id":{"type":"string","x-stream-index":"001.002.007"},"new_channel_owner_id":{"type":"string","x-stream-index":"001.002.006"},"user":{"description":"User delete mode.\n\n* soft - marks user as deleted and retains all user data\n* pruning - marks user as deleted and nullifies user information\n* hard - deletes user completely. Requires 'hard' option for messages and conversations as well\n","enum":["soft","pruning","hard"],"title":"Delete User","type":"string","x-stream-index":"001.002.001"},"user_ids":{"description":"IDs of users to delete","items":{"type":"string"},"maximum":100,"minimum":1,"title":"User IDs","type":"array","x-stream-index":"001.001"}},"required":["user_ids"],"type":"object"},"DeleteUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"task_id":{"description":"ID of the task to delete users","title":"Task ID","type":"string","x-stream-index":"001"}},"required":["task_id","duration"],"type":"object"},"Device":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"002.002"},"disabled":{"type":"boolean","x-stream-index":"002.003"},"disabled_reason":{"type":"string","x-stream-index":"002.004"},"id":{"type":"string","x-stream-index":"002.001.004"},"push_provider":{"enum":["firebase","apn","huawei","xiaomi"],"type":"string","x-stream-index":"002.001.001"},"push_provider_name":{"type":"string","x-stream-index":"002.001.003"},"user_id":{"type":"string","x-stream-index":"004"},"voip":{"type":"boolean","x-stream-index":"002.001.005"}},"required":["push_provider","id","created_at","user_id"],"type":"object"},"DeviceErrorInfo":{"properties":{"error_message":{"type":"string","x-stream-index":"003"},"provider":{"type":"string","x-stream-index":"001"},"provider_name":{"type":"string","x-stream-index":"002"}},"required":["provider","provider_name","error_message"],"type":"object"},"DeviceResponse":{"description":"Response for Device","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"004"},"disabled":{"description":"Whether device is disabled or not","title":"Disabled","type":"boolean","x-stream-index":"005"},"disabled_reason":{"description":"Reason explaining why device had been disabled","title":"Reason","type":"string","x-stream-index":"006"},"id":{"description":"Device ID","title":"ID","type":"string","x-stream-index":"003"},"push_provider":{"description":"Push provider","title":"PushProvider","type":"string","x-stream-index":"001"},"push_provider_name":{"description":"Push provider name","title":"PushProviderName","type":"string","x-stream-index":"002"},"user_id":{"description":"User ID","title":"UserID","type":"string","x-stream-index":"008"},"voip":{"description":"When true the token is for Apple VoIP push notifications","title":"Voip","type":"boolean","x-stream-index":"007"}},"required":["push_provider","id","created_at","user_id"],"title":"DeviceResponse","type":"object"},"DraftPayloadResponse":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"html":{"type":"string","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"001"},"mentioned_users":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"008"},"mml":{"type":"string","x-stream-index":"003"},"parent_id":{"type":"string","x-stream-index":"005"},"poll_id":{"type":"string","x-stream-index":"013"},"quoted_message_id":{"type":"string","x-stream-index":"009"},"show_in_channel":{"type":"boolean","x-stream-index":"006"},"silent":{"type":"boolean","x-stream-index":"012"},"text":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"011"}},"required":["id","text","custom"],"type":"object"},"DraftResponse":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003"},"channel_cid":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"string","x-stream-index":"007"},"message":{"$ref":"#/components/schemas/DraftPayloadResponse","x-stream-index":"001"},"parent_id":{"type":"string","x-stream-index":"004"},"parent_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"005"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"006"}},"required":["message","channel_cid","created_at"],"type":"object"},"ErrorResult":{"properties":{"stacktrace":{"type":"string","x-stream-index":"003"},"type":{"type":"string","x-stream-index":"001"},"version":{"type":"string","x-stream-index":"004"}},"required":["type","description"],"type":"object"},"EventHook":{"nullable":true,"properties":{"callback":{"$ref":"#/components/schemas/AsyncModerationCallbackConfig","x-stream-index":"018.001.002"},"created_at":{"format":"date-time","type":"string","x-stream-index":"019"},"enabled":{"type":"boolean","x-stream-index":"003"},"event_types":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"hook_type":{"type":"string","x-stream-index":"002"},"id":{"type":"string","x-stream-index":"001"},"sns_auth_type":{"type":"string","x-stream-index":"014"},"sns_key":{"type":"string","x-stream-index":"015"},"sns_region":{"type":"string","x-stream-index":"013"},"sns_role_arn":{"type":"string","x-stream-index":"017"},"sns_secret":{"type":"string","x-stream-index":"016"},"sns_topic_arn":{"type":"string","x-stream-index":"012"},"sqs_auth_type":{"type":"string","x-stream-index":"008"},"sqs_key":{"type":"string","x-stream-index":"009"},"sqs_queue_url":{"type":"string","x-stream-index":"006"},"sqs_region":{"type":"string","x-stream-index":"007"},"sqs_role_arn":{"type":"string","x-stream-index":"011"},"sqs_secret":{"type":"string","x-stream-index":"010"},"timeout_ms":{"format":"int32","type":"integer","x-stream-index":"018.001.001"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"020"},"webhook_url":{"type":"string","x-stream-index":"005"}},"type":"object"},"EventNotificationSettings":{"properties":{"apns":{"$ref":"#/components/schemas/APNS","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"fcm":{"$ref":"#/components/schemas/FCM","x-stream-index":"003"}},"required":["enabled","apns","fcm"],"type":"object"},"EventRequest":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"parent_id":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"required":["type"],"type":"object"},"EventResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"event":{"$ref":"#/components/schemas/WSEvent","x-stream-index":"001"}},"required":["event","duration"],"title":"Response","type":"object"},"ExportChannelsRequest":{"nullable":true,"properties":{"channels":{"description":"Export options for channels","items":{"$ref":"#/components/schemas/ChannelExport"},"maximum":100,"minimum":1,"title":"Channels","type":"array","x-stream-index":"002.001"},"clear_deleted_message_text":{"description":"Set if deleted message text should be cleared","title":"Clear deleted message text","type":"boolean","x-stream-index":"002.002"},"export_users":{"type":"boolean","x-stream-index":"002.005"},"include_soft_deleted_channels":{"description":"Set if you want to include deleted channels","title":"Include soft deleted channels","type":"boolean","x-stream-index":"002.004"},"include_truncated_messages":{"description":"Set if you want to include truncated messages","title":"Include truncated messages","type":"boolean","x-stream-index":"002.003"},"version":{"description":"Export version","title":"Version","type":"string","x-stream-index":"001"}},"required":["channels"],"type":"object"},"ExportChannelsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"task_id":{"description":"ID of the task to export channels","title":"Task ID","type":"string","x-stream-index":"001"}},"required":["task_id","duration"],"type":"object"},"ExportUserResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"004.001"},"messages":{"description":"List of exported messages","items":{"$ref":"#/components/schemas/MessageResponse"},"title":"Messages","type":"array","x-stream-index":"002"},"reactions":{"description":"List of exported reactions","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Reactions","type":"array","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Exported user object","title":"User","x-stream-index":"001"}},"required":["duration"],"type":"object"},"ExportUsersRequest":{"nullable":true,"properties":{"user_ids":{"items":{"type":"string"},"maximum":25,"minimum":1,"type":"array","x-stream-index":"001"}},"required":["user_ids"],"type":"object"},"ExportUsersResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"task_id":{"type":"string","x-stream-index":"001"}},"required":["task_id","duration"],"title":"Response","type":"object"},"ExternalStorageResponse":{"properties":{"bucket":{"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"path":{"type":"string","x-stream-index":"004"},"type":{"enum":["s3","gcs","abs"],"type":"string","x-stream-index":"002"}},"required":["name","type","bucket","path"],"type":"object"},"FCM":{"properties":{"data":{"additionalProperties":{},"type":"object","x-stream-index":"001"}},"type":"object"},"Field":{"nullable":true,"properties":{"short":{"type":"boolean","x-stream-index":"003"},"title":{"type":"string","x-stream-index":"001"},"value":{"type":"string","x-stream-index":"002"}},"required":["title","value","short"],"type":"object"},"FileUploadConfig":{"properties":{"allowed_file_extensions":{"items":{"type":"string"},"type":"array","x-stream-index":"001"},"allowed_mime_types":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"blocked_file_extensions":{"items":{"type":"string"},"type":"array","x-stream-index":"002"},"blocked_mime_types":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"size_limit":{"format":"int32","maximum":104857600,"minimum":0,"type":"integer","x-stream-index":"005"}},"required":["size_limit"],"type":"object"},"FileUploadRequest":{"nullable":true,"properties":{"file":{"description":"file field","title":"File","type":"string","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/OnlyUserID","description":"user for the request **server side only**","title":"User","x-stream-index":"003"}},"type":"object"},"FileUploadResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"file":{"description":"URL to the uploaded asset. Should be used to put to `asset_url` attachment field","title":"File","type":"string","x-stream-index":"001"},"thumb_url":{"description":"URL of the file thumbnail for supported file formats. Should be put to `thumb_url` attachment field","title":"Thumbnail URL","type":"string","x-stream-index":"002"}},"required":["duration"],"type":"object"},"FirebaseConfig":{"properties":{"Disabled":{"type":"boolean","writeOnly":true,"x-stream-index":"001"},"apn_template":{"type":"string","x-stream-index":"005"},"credentials_json":{"type":"string","x-stream-index":"006"},"data_template":{"type":"string","x-stream-index":"004"},"notification_template":{"type":"string","x-stream-index":"003"},"server_key":{"type":"string","x-stream-index":"002"}},"type":"object"},"FirebaseConfigFields":{"properties":{"apn_template":{"type":"string","x-stream-index":"004"},"credentials_json":{"type":"string","x-stream-index":"006"},"data_template":{"type":"string","x-stream-index":"003"},"enabled":{"type":"boolean","x-stream-index":"001"},"notification_template":{"type":"string","x-stream-index":"002"},"server_key":{"type":"string","x-stream-index":"005"}},"required":["enabled"],"type":"object"},"Flag":{"description":"Contains information about flagged user or message","properties":{"approved_at":{"description":"Date of the approval","format":"date-time","title":"Approved at","type":"string","x-stream-index":"015"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"011"},"created_by_automod":{"type":"boolean","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"022"},"details":{"$ref":"#/components/schemas/FlagDetails","x-stream-index":"021"},"reason":{"type":"string","x-stream-index":"020"},"rejected_at":{"description":"Date of the rejection","format":"date-time","title":"Rejected at","type":"string","x-stream-index":"016"},"reviewed_at":{"description":"Date of the review","format":"date-time","title":"Reviewed at","type":"string","x-stream-index":"013"},"reviewed_by":{"type":"string","x-stream-index":"014"},"target_message":{"$ref":"#/components/schemas/Message","x-stream-index":"008"},"target_message_id":{"description":"ID of flagged message","title":"Target Message ID","type":"string","x-stream-index":"007"},"target_user":{"$ref":"#/components/schemas/User","description":"Flagged user","title":"User","x-stream-index":"010"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"012"},"user":{"$ref":"#/components/schemas/User","description":"User who flagged a message or a user","title":"User","x-stream-index":"006"}},"required":["created_by_automod","created_at","updated_at"],"title":"Flag","type":"object"},"FlagDetails":{"properties":{"Extra":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"002"},"automod":{"$ref":"#/components/schemas/AutomodDetails","x-stream-index":"001"},"original_text":{"type":"string","x-stream-index":"003"}},"required":["Extra","original_text"],"type":"object"},"FlagFeedback":{"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"005"},"labels":{"items":{"$ref":"#/components/schemas/Label"},"type":"array","x-stream-index":"006"},"message_id":{"type":"string","x-stream-index":"004"}},"required":["message_id","created_at","labels"],"type":"object"},"FlagMessageDetails":{"properties":{"pin_changed":{"type":"boolean","x-stream-index":"002"},"should_enrich":{"type":"boolean","x-stream-index":"003"},"skip_push":{"type":"boolean","x-stream-index":"004"},"updated_by_id":{"type":"string","x-stream-index":"001"}},"type":"object"},"FlagRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"reason":{"maxLength":255,"type":"string","x-stream-index":"003"},"target_message_id":{"description":"ID of the message when reporting a message","title":"Target Message ID","type":"string","x-stream-index":"001"},"target_user_id":{"description":"ID of the user when reporting a user","title":"Target User ID","type":"string","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"005.002"},"user_id":{"type":"string","x-stream-index":"005.001"}},"type":"object"},"FlagResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"flag":{"$ref":"#/components/schemas/Flag","x-stream-index":"001"},"review_queue_item_id":{"type":"string","x-stream-index":"002"}},"required":["review_queue_item_id","duration"],"title":"Response","type":"object"},"FlagUpdatedEvent":{"nullable":true,"properties":{"CreatedBy":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"004"},"Message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"002"},"User":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"003"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"received_at":{"format":"date-time","type":"string","x-stream-index":"001.004"},"type":{"default":"flag.updated","type":"string","x-stream-index":"001.002"}},"required":["type","created_at","custom"],"title":"FlagUpdatedEvent","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"},"FrameRecordSettings":{"properties":{"capture_interval_in_seconds":{"format":"int32","maximum":60,"minimum":2,"type":"integer","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"},"quality":{"type":"string","x-stream-index":"002"}},"required":["mode","capture_interval_in_seconds"],"type":"object"},"FullUserResponse":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"ban_expires":{"format":"date-time","type":"string","x-stream-index":"015"},"banned":{"type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"014"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"007"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"string","x-stream-index":"001.016"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"001.011"},"devices":{"items":{"$ref":"#/components/schemas/DeviceResponse"},"type":"array","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001.001"},"image":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"005"},"language":{"type":"string","x-stream-index":"001.005"},"last_active":{"format":"date-time","type":"string","x-stream-index":"001.014"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"012"},"mutes":{"items":{"$ref":"#/components/schemas/UserMuteResponse"},"type":"array","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"001.002"},"online":{"type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"003"},"revoke_tokens_issued_before":{"format":"date-time","type":"string","x-stream-index":"001.015"},"role":{"type":"string","x-stream-index":"001.006"},"shadow_banned":{"type":"boolean","x-stream-index":"013"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"009"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"010"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"008"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"011"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","devices","invisible","mutes","channel_mutes","unread_count","total_unread_count","unread_channels","unread_threads","shadow_banned","blocked_user_ids"],"type":"object"},"GeofenceResponse":{"nullable":true,"properties":{"country_codes":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"description":{"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"type":{"type":"string","x-stream-index":"002"}},"required":["name"],"type":"object"},"GeofenceSettings":{"properties":{"names":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"required":["names"],"type":"object"},"GetApplicationResponse":{"description":"Basic response information","nullable":true,"properties":{"app":{"$ref":"#/components/schemas/AppResponseFields","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["app","duration"],"title":"Response","type":"object"},"GetBlockListResponse":{"description":"Response for get block list","nullable":true,"properties":{"blocklist":{"$ref":"#/components/schemas/BlockListResponse","description":"Block list object","title":"BlockListResponse","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["duration"],"title":"GetBlockListResponse","type":"object","x-stream-docs-page-id":"get_block_list"},"GetBlockedUsersResponse":{"nullable":true,"properties":{"blocks":{"description":"Array of blocked user object","items":{"$ref":"#/components/schemas/BlockedUserResponse"},"title":"Blocks","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["blocks","duration"],"type":"object"},"GetCampaignResponse":{"description":"Basic response information","nullable":true,"properties":{"campaign":{"$ref":"#/components/schemas/CampaignResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"users":{"$ref":"#/components/schemas/PagerResponse","x-stream-index":"002"}},"required":["duration"],"title":"Response","type":"object"},"GetChannelTypeResponse":{"description":"Basic response information","nullable":true,"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"003.002.026"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"003.002.021"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.002.022"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"003.002.027"},"blocklist":{"type":"string","x-stream-index":"003.002.023"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.002.024"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"003.002.025"},"commands":{"items":{"$ref":"#/components/schemas/Command"},"type":"array","x-stream-index":"003.003"},"connect_events":{"type":"boolean","x-stream-index":"003.002.004"},"created_at":{"format":"date-time","type":"string","x-stream-index":"003.001.003"},"custom_events":{"type":"boolean","x-stream-index":"003.002.012"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"004.001"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"002"},"mark_messages_pending":{"type":"boolean","x-stream-index":"003.002.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"003.002.020"},"mutes":{"type":"boolean","x-stream-index":"003.002.009"},"name":{"type":"string","x-stream-index":"003.002.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"003.002.028"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"003.002.029"},"permissions":{"items":{"$ref":"#/components/schemas/PolicyRequest"},"type":"array","x-stream-index":"001"},"polls":{"type":"boolean","x-stream-index":"003.002.016"},"push_notifications":{"type":"boolean","x-stream-index":"003.002.013"},"quotes":{"type":"boolean","x-stream-index":"003.002.008"},"reactions":{"type":"boolean","x-stream-index":"003.002.006"},"read_events":{"type":"boolean","x-stream-index":"003.002.003"},"reminders":{"type":"boolean","x-stream-index":"003.002.014"},"replies":{"type":"boolean","x-stream-index":"003.002.007"},"search":{"type":"boolean","x-stream-index":"003.002.005"},"shared_locations":{"type":"boolean","x-stream-index":"003.002.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"003.002.030"},"typing_events":{"type":"boolean","x-stream-index":"003.002.002"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"003.001.004"},"uploads":{"type":"boolean","x-stream-index":"003.002.010"},"url_enrichment":{"type":"boolean","x-stream-index":"003.002.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"003.002.017"}},"required":["permissions","grants","created_at","updated_at","name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","commands","duration"],"title":"Response","type":"object"},"GetCommandResponse":{"nullable":true,"properties":{"args":{"type":"string","x-stream-index":"001.006"},"created_at":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"001.001"},"description":{"type":"string","x-stream-index":"001.005"},"duration":{"type":"string","x-stream-index":"002.001"},"name":{"type":"string","x-stream-index":"001.004"},"set":{"type":"string","x-stream-index":"001.007"},"updated_at":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"001.002"}},"required":["name","description","args","set","duration"],"title":"GetCommandResponse","type":"object"},"GetCustomPermissionResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"permission":{"$ref":"#/components/schemas/Permission","x-stream-index":"001"}},"required":["permission","duration"],"title":"Response","type":"object"},"GetDraftResponse":{"description":"Basic response information","nullable":true,"properties":{"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["draft","duration"],"title":"Response","type":"object"},"GetImportResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"import_task":{"$ref":"#/components/schemas/ImportTask","x-stream-index":"001"}},"required":["duration"],"title":"Response","type":"object"},"GetManyMessagesResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.002.001"},"messages":{"description":"List of messages","items":{"$ref":"#/components/schemas/MessageResponse"},"title":"Messages","type":"array","x-stream-index":"001.001"}},"required":["messages","duration"],"type":"object"},"GetMessageResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageWithChannelResponse","x-stream-index":"001"},"pending_message_metadata":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"002"}},"required":["message","duration"],"title":"Response","type":"object"},"GetOGResponse":{"nullable":true,"properties":{"actions":{"items":{"$ref":"#/components/schemas/Action"},"type":"array","x-stream-index":"001.015"},"asset_url":{"description":"URL of detected video or audio","title":"Image URL","type":"string","x-stream-index":"001.017"},"author_icon":{"type":"string","x-stream-index":"001.007"},"author_link":{"description":"og:site","title":"Author Link","type":"string","x-stream-index":"001.006"},"author_name":{"description":"og:site_name","title":"Author Name","type":"string","x-stream-index":"001.005"},"color":{"type":"string","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.018"},"duration":{"type":"string","x-stream-index":"002.001"},"fallback":{"type":"string","x-stream-index":"001.002"},"fields":{"items":{"$ref":"#/components/schemas/Field"},"type":"array","x-stream-index":"001.016"},"footer":{"type":"string","x-stream-index":"001.013"},"footer_icon":{"type":"string","x-stream-index":"001.014"},"giphy":{"$ref":"#/components/schemas/Images","x-stream-index":"001.019"},"image_url":{"description":"URL of detected image","title":"Image URL","type":"string","x-stream-index":"001.011"},"og_scrape_url":{"description":"extracted url from the text","title":"OG Scrape URL","type":"string","x-stream-index":"001.020"},"original_height":{"format":"int32","type":"integer","x-stream-index":"001.022"},"original_width":{"format":"int32","type":"integer","x-stream-index":"001.021"},"pretext":{"type":"string","x-stream-index":"001.004"},"text":{"description":"og:description","title":"Text","type":"string","x-stream-index":"001.010"},"thumb_url":{"description":"URL of detected thumb image","title":"Image URL","type":"string","x-stream-index":"001.012"},"title":{"description":"og:title","title":"Title","type":"string","x-stream-index":"001.008"},"title_link":{"description":"og:url","title":"Title Link","type":"string","x-stream-index":"001.009"},"type":{"description":"Attachment type, could be empty, image, audio or video","title":"Type","type":"string","x-stream-index":"001.001"}},"required":["custom","duration"],"title":"Get OG Attachment","type":"object","x-stream-docs-page-id":"og"},"GetPushTemplatesResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"templates":{"items":{"$ref":"#/components/schemas/PushTemplate"},"type":"array","x-stream-index":"002"}},"required":["duration","templates"],"title":"Response","type":"object"},"GetRateLimitsResponse":{"nullable":true,"properties":{"android":{"additionalProperties":{"$ref":"#/components/schemas/LimitInfo"},"description":"Map of endpoint rate limits for the Android platform","title":"Android","type":"object","x-stream-index":"002","x-stream-map":{"key":"endpoint","title":"Endpoint name","description":"The name of the endpoint for which the limits apply"}},"duration":{"type":"string","x-stream-index":"005.001"},"ios":{"additionalProperties":{"$ref":"#/components/schemas/LimitInfo"},"description":"Map of endpoint rate limits for the iOS platform","title":"iOS","type":"object","x-stream-index":"003","x-stream-map":{"key":"endpoint","title":"Endpoint name","description":"The name of the endpoint for which the limits apply"}},"server_side":{"additionalProperties":{"$ref":"#/components/schemas/LimitInfo"},"description":"Map of endpoint rate limits for the server-side platform","title":"Server-side","type":"object","x-stream-index":"001","x-stream-map":{"key":"endpoint","title":"Endpoint name","description":"The name of the endpoint for which the limits apply"}},"web":{"additionalProperties":{"$ref":"#/components/schemas/LimitInfo"},"description":"Map of endpoint rate limits for the web platform","title":"Web","type":"object","x-stream-index":"004","x-stream-map":{"key":"endpoint","title":"Endpoint name","description":"The name of the endpoint for which the limits apply"}}},"required":["duration"],"title":"Get Rate Limits Response","type":"object","x-stream-docs-page-id":"rate_limits"},"GetReactionsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"reactions":{"description":"List of reactions","items":{"$ref":"#/components/schemas/Reaction"},"title":"Reactions","type":"array","x-stream-index":"001"}},"required":["reactions","duration"],"type":"object"},"GetRepliesResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"messages":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","x-stream-index":"001"}},"required":["messages","duration"],"title":"Response","type":"object"},"GetSegmentResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"segment":{"$ref":"#/components/schemas/SegmentResponse","description":"Segment","title":"SegmentResponse","x-stream-index":"001"}},"required":["duration"],"type":"object"},"GetTaskResponse":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"001.003"},"duration":{"type":"string","x-stream-index":"004.001"},"error":{"$ref":"#/components/schemas/ErrorResult","description":"Error produced by task","title":"Error","x-stream-index":"003"},"result":{"additionalProperties":{},"description":"Result produced by task after completion","title":"Result","type":"object","x-stream-index":"002"},"status":{"description":"Current status of task","title":"Status","type":"string","x-stream-index":"001.002"},"task_id":{"description":"ID of task","title":"Task ID","type":"string","x-stream-index":"001.001"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"001.004"}},"required":["task_id","status","created_at","updated_at","duration"],"title":"Get Task Response","type":"object","x-stream-docs-page-id":"tasks"},"GetThreadResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"thread":{"$ref":"#/components/schemas/ThreadStateResponse","description":"Enriched thread state","title":"Thread","x-stream-index":"001"}},"required":["thread","duration"],"type":"object"},"HLSSettings":{"properties":{"auto_on":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"004"},"quality_tracks":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"required":["auto_on","enabled","quality_tracks"],"type":"object"},"HideChannelRequest":{"nullable":true,"properties":{"clear_history":{"description":"Whether to clear message history of the channel or not","title":"Clear history","type":"boolean","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"type":"object"},"HideChannelResponse":{"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"},"HuaweiConfig":{"properties":{"Disabled":{"type":"boolean","writeOnly":true,"x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"secret":{"type":"string","x-stream-index":"002"}},"type":"object"},"HuaweiConfigFields":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"id":{"type":"string","x-stream-index":"002"},"secret":{"type":"string","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"ImageData":{"properties":{"frames":{"type":"string","x-stream-index":"005"},"height":{"type":"string","x-stream-index":"003"},"size":{"type":"string","x-stream-index":"004"},"url":{"type":"string","x-stream-index":"001"},"width":{"type":"string","x-stream-index":"002"}},"required":["url","width","height","size","frames"],"type":"object"},"ImageSize":{"properties":{"crop":{"description":"Crop mode","enum":["top","bottom","left","right","center"],"title":"Crop","type":"string","x-stream-index":"001"},"height":{"description":"Target image height","format":"int32","title":"Height","type":"integer","x-stream-index":"003"},"resize":{"description":"Resize method","enum":["clip","crop","scale","fill"],"title":"Resize","type":"string","x-stream-index":"002"},"width":{"description":"Target image width","format":"int32","title":"Width","type":"integer","x-stream-index":"004"}},"title":"Image size configuration","type":"object"},"ImageUploadRequest":{"nullable":true,"properties":{"file":{"type":"string","x-stream-index":"001.002"},"upload_sizes":{"description":"field with JSON-encoded array of image size configurations","items":{"$ref":"#/components/schemas/ImageSize"},"title":"Upload sizes","type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/OnlyUserID","x-stream-index":"001.003"}},"type":"object"},"ImageUploadResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.003.001"},"file":{"type":"string","x-stream-index":"001.001"},"thumb_url":{"type":"string","x-stream-index":"001.002"},"upload_sizes":{"description":"Array of image size configurations","items":{"$ref":"#/components/schemas/ImageSize"},"title":"Upload sizes","type":"array","x-stream-index":"002"}},"required":["duration"],"type":"object"},"Images":{"properties":{"fixed_height":{"$ref":"#/components/schemas/ImageData","x-stream-index":"002"},"fixed_height_downsampled":{"$ref":"#/components/schemas/ImageData","x-stream-index":"004"},"fixed_height_still":{"$ref":"#/components/schemas/ImageData","x-stream-index":"003"},"fixed_width":{"$ref":"#/components/schemas/ImageData","x-stream-index":"005"},"fixed_width_downsampled":{"$ref":"#/components/schemas/ImageData","x-stream-index":"007"},"fixed_width_still":{"$ref":"#/components/schemas/ImageData","x-stream-index":"006"},"original":{"$ref":"#/components/schemas/ImageData","x-stream-index":"001"}},"required":["original","fixed_height","fixed_height_still","fixed_height_downsampled","fixed_width","fixed_width_still","fixed_width_downsampled"],"type":"object"},"ImportTask":{"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"011"},"history":{"items":{"$ref":"#/components/schemas/ImportTaskHistory"},"type":"array","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"003"},"mode":{"type":"string","x-stream-index":"006"},"path":{"type":"string","x-stream-index":"005"},"size":{"format":"int64","type":"integer","x-stream-index":"007"},"state":{"type":"string","x-stream-index":"008"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"012"}},"required":["id","path","mode","state","history","created_at","updated_at"],"type":"object"},"ImportTaskHistory":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"007"},"next_state":{"type":"string","x-stream-index":"006"},"prev_state":{"type":"string","x-stream-index":"005"}},"required":["prev_state","next_state","created_at"],"type":"object"},"IngressAudioEncodingOptions":{"properties":{"bitrate":{"maximum":128000,"minimum":16000,"type":"integer","x-stream-index":"003"},"channels":{"enum":["1","2"],"format":"int32","type":"integer","x-stream-index":"001"},"enable_dtx":{"type":"boolean","x-stream-index":"002"}},"required":["channels","enable_dtx","bitrate"],"type":"object"},"IngressSettings":{"properties":{"audio_encoding_options":{"$ref":"#/components/schemas/IngressAudioEncodingOptions","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"video_encoding_options":{"additionalProperties":{"$ref":"#/components/schemas/IngressVideoEncodingOptions"},"type":"object","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"IngressVideoEncodingOptions":{"properties":{"layers":{"items":{"$ref":"#/components/schemas/IngressVideoLayer"},"minimum":1,"type":"array","x-stream-index":"001"}},"required":["layers"],"type":"object"},"IngressVideoLayer":{"nullable":true,"properties":{"bitrate":{"minimum":1000,"type":"integer","x-stream-index":"002"},"codec":{"enum":["h264","vp8"],"type":"string","x-stream-index":"001"},"frame_rate":{"maximum":60,"minimum":1,"type":"integer","x-stream-index":"003"},"max_dimension":{"minimum":240,"type":"integer","x-stream-index":"005"},"min_dimension":{"minimum":240,"type":"integer","x-stream-index":"004"}},"required":["codec","bitrate","frame_rate","min_dimension","max_dimension"],"type":"object"},"Label":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"phrase_list_ids":{"items":{"format":"int32","type":"integer"},"type":"array","x-stream-index":"002"}},"required":["name"],"type":"object"},"LabelThresholds":{"properties":{"block":{"description":"Threshold for automatic message block","format":"float","maximum":1,"minimum":0,"title":"Block","type":"number","x-stream-index":"002"},"flag":{"description":"Threshold for automatic message flag","format":"float","maximum":1,"minimum":0,"title":"Flag","type":"number","x-stream-index":"001"}},"type":"object"},"LayoutSettings":{"properties":{"detect_orientation":{"type":"boolean","x-stream-index":"005"},"external_app_url":{"type":"string","x-stream-index":"003"},"external_css_url":{"type":"string","x-stream-index":"004"},"name":{"enum":["spotlight","grid","single-participant","mobile","custom"],"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"required":["name","external_app_url","external_css_url"],"type":"object"},"LimitInfo":{"properties":{"limit":{"description":"The maximum number of calls allowed for the time window","format":"int32","title":"Limit","type":"integer","x-stream-index":"001"},"remaining":{"description":"The number of remaining calls in the current window","format":"int64","title":"Remaining","type":"integer","x-stream-index":"002"},"reset":{"description":"The Unix timestamp of the next window","format":"int64","title":"Reset","type":"integer","x-stream-index":"003"}},"required":["limit","remaining","reset"],"title":"Rate Limit info","type":"object","x-stream-docs-page-id":"rate_limits"},"LimitsSettings":{"properties":{"max_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"004"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"},"max_participants_exclude_owner":{"type":"boolean","x-stream-index":"003"},"max_participants_exclude_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"002"}},"required":["max_participants_exclude_roles"],"type":"object"},"ListBlockListResponse":{"description":"Basic response information","nullable":true,"properties":{"blocklists":{"items":{"$ref":"#/components/schemas/BlockListResponse"},"type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["blocklists","duration"],"title":"Response","type":"object"},"ListChannelTypesResponse":{"nullable":true,"properties":{"channel_types":{"additionalProperties":{"$ref":"#/components/schemas/ChannelTypeConfig"},"description":"Object with all channel types","title":"Channel types","type":"object","x-stream-index":"001","x-stream-map":{"key":"channel_type","title":"Channel type","description":"Channel type config object"}},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["channel_types","duration"],"title":"ListChannelTypesResponse","type":"object"},"ListCommandsResponse":{"nullable":true,"properties":{"commands":{"description":"List of commands","items":{"$ref":"#/components/schemas/Command"},"title":"Commands","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["commands","duration"],"title":"ListCommandsResponse","type":"object"},"ListDevicesResponse":{"description":"List devices response","nullable":true,"properties":{"devices":{"description":"List of devices","items":{"$ref":"#/components/schemas/DeviceResponse"},"title":"Devices","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["devices","duration"],"title":"ListDevicesResponse","type":"object"},"ListExternalStorageResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"external_storages":{"additionalProperties":{"$ref":"#/components/schemas/ExternalStorageResponse"},"type":"object","x-stream-index":"002"}},"required":["duration","external_storages"],"title":"Response","type":"object"},"ListImportsResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"import_tasks":{"items":{"$ref":"#/components/schemas/ImportTask"},"type":"array","x-stream-index":"001"}},"required":["import_tasks","duration"],"title":"Response","type":"object"},"ListPermissionsResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"permissions":{"items":{"$ref":"#/components/schemas/Permission"},"type":"array","x-stream-index":"001"}},"required":["permissions","duration"],"title":"Response","type":"object"},"ListPushProvidersResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"push_providers":{"items":{"$ref":"#/components/schemas/PushProviderResponse"},"type":"array","x-stream-index":"001"}},"required":["push_providers","duration"],"title":"Response","type":"object"},"ListRolesResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"roles":{"items":{"$ref":"#/components/schemas/Role"},"type":"array","x-stream-index":"001"}},"required":["roles","duration"],"title":"Response","type":"object"},"MarkChannelsReadRequest":{"nullable":true,"properties":{"read_by_channel":{"additionalProperties":{"type":"string"},"description":"Map of channel ID to last read message ID","maximum":30,"title":"Read by channel","type":"object","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"002.002"},"user_id":{"type":"string","x-stream-index":"002.001"}},"type":"object"},"MarkReadRequest":{"nullable":true,"properties":{"message_id":{"description":"ID of the message that is considered last read by client","title":"Message ID","type":"string","x-stream-index":"001"},"thread_id":{"description":"Optional Thread ID to specifically mark a given thread as read","title":"Thread ID","type":"string","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"type":"object"},"MarkReadResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"event":{"$ref":"#/components/schemas/MessageReadEvent","description":"Mark read event","title":"Event","x-stream-index":"001"}},"required":["duration"],"type":"object"},"MarkUnreadRequest":{"nullable":true,"properties":{"message_id":{"description":"ID of the message from where the channel is marked unread","title":"Message ID","type":"string","x-stream-index":"001"},"thread_id":{"description":"Mark a thread unread, specify both the thread and message id","title":"Thread ID","type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"type":"object"},"MemberAddedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"003.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"002.001"},"type":{"default":"member.added","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MemberAddedEvent","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"},"MemberRemovedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"002.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"001.001"},"type":{"default":"member.removed","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MemberRemovedEvent","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"},"MemberUpdatedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"005.002"},"channel_type":{"type":"string","x-stream-index":"005.003"},"cid":{"type":"string","x-stream-index":"005.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"003.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"002.001"},"type":{"default":"member.updated","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MemberUpdatedEvent","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"},"MembersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"members":{"description":"List of found members","items":{"$ref":"#/components/schemas/ChannelMember"},"title":"Members","type":"array","x-stream-index":"001"}},"required":["members","duration"],"type":"object"},"Message":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"012"},"before_message_send_failed":{"type":"boolean","x-stream-index":"046"},"cid":{"type":"string","x-stream-index":"028"},"command":{"type":"string","x-stream-index":"006"},"created_at":{"format":"date-time","type":"string","x-stream-index":"030"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"034"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"033"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"023"},"html":{"type":"string","x-stream-index":"007"},"i18n":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"044"},"id":{"type":"string","x-stream-index":"002"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"040"},"latest_reactions":{"items":{"$ref":"#/components/schemas/Reaction"},"type":"array","x-stream-index":"013"},"mentioned_users":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"043"},"message_text_updated_at":{"format":"date-time","type":"string","x-stream-index":"052"},"mml":{"type":"string","x-stream-index":"005"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"056"},"own_reactions":{"items":{"$ref":"#/components/schemas/Reaction"},"type":"array","x-stream-index":"014"},"parent_id":{"type":"string","x-stream-index":"019"},"pin_expires":{"format":"date-time","type":"string","x-stream-index":"051"},"pinned":{"type":"boolean","x-stream-index":"047"},"pinned_at":{"format":"date-time","type":"string","x-stream-index":"048"},"pinned_by":{"$ref":"#/components/schemas/User","x-stream-index":"050"},"poll":{"$ref":"#/components/schemas/Poll","x-stream-index":"054"},"poll_id":{"type":"string","x-stream-index":"053"},"quoted_message":{"$ref":"#/components/schemas/Message","x-stream-index":"025"},"quoted_message_id":{"type":"string","x-stream-index":"024"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"015"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"017"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"016"},"reminder":{"$ref":"#/components/schemas/MessageReminder","x-stream-index":"058"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"022"},"restricted_visibility":{"items":{"type":"string"},"type":"array","x-stream-index":"011"},"shadowed":{"type":"boolean","x-stream-index":"036"},"shared_location":{"$ref":"#/components/schemas/SharedLocation","x-stream-index":"055"},"show_in_channel":{"type":"boolean","x-stream-index":"021"},"silent":{"type":"boolean","x-stream-index":"045"},"text":{"type":"string","x-stream-index":"004"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"027"},"type":{"type":"string","x-stream-index":"008"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"031"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"010"}},"required":["id","text","html","type","restricted_visibility","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reaction_groups","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned"],"type":"object"},"MessageActionRequest":{"nullable":true,"properties":{"form_data":{"additionalProperties":{"type":"string"},"description":"ReadOnlyData to execute command with","title":"Form data","type":"object","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"required":["form_data"],"type":"object"},"MessageChangeSet":{"properties":{"attachments":{"type":"boolean","x-stream-index":"005"},"custom":{"type":"boolean","x-stream-index":"001"},"html":{"type":"boolean","x-stream-index":"004"},"mentioned_user_ids":{"type":"boolean","x-stream-index":"006"},"mml":{"type":"boolean","x-stream-index":"003"},"pin":{"type":"boolean","x-stream-index":"009"},"quoted_message_id":{"type":"boolean","x-stream-index":"007"},"silent":{"type":"boolean","x-stream-index":"008"},"text":{"type":"boolean","x-stream-index":"002"}},"required":["custom","text","mml","html","attachments","mentioned_user_ids","quoted_message_id","silent","pin"],"type":"object"},"MessageDeletedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"006.002"},"hard_delete":{"type":"boolean","x-stream-index":"002.001"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"005.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"message.deleted","type":"string","x-stream-index":"006.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["hard_delete","cid","channel_id","channel_type","type","created_at"],"title":"MessageDeletedEvent","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":{"approved_at":{"format":"date-time","type":"string","x-stream-index":"013"},"created_at":{"format":"date-time","type":"string","x-stream-index":"009"},"created_by_automod":{"type":"boolean","x-stream-index":"001"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"008"},"details":{"$ref":"#/components/schemas/FlagDetails","x-stream-index":"006"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"005"},"moderation_feedback":{"$ref":"#/components/schemas/FlagFeedback","x-stream-index":"003"},"moderation_result":{"$ref":"#/components/schemas/MessageModerationResult","x-stream-index":"002"},"reason":{"type":"string","x-stream-index":"007"},"rejected_at":{"format":"date-time","type":"string","x-stream-index":"014"},"reviewed_at":{"format":"date-time","type":"string","x-stream-index":"011"},"reviewed_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"012"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"004"}},"required":["created_by_automod","created_at","updated_at"],"type":"object"},"MessageFlaggedEvent":{"properties":{"cid":{"type":"string","x-stream-index":"001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"005.002"},"flag":{"$ref":"#/components/schemas/Flag","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"002.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"002.002"},"type":{"default":"message.flagged","type":"string","x-stream-index":"005.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004"}},"required":["cid","type","created_at"],"title":"MessageFlaggedEvent","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"},"MessageHistoryEntryResponse":{"nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"007"},"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"006"},"is_deleted":{"type":"boolean","x-stream-index":"004"},"message_id":{"type":"string","x-stream-index":"001"},"message_updated_at":{"format":"date-time","type":"string","x-stream-index":"003"},"message_updated_by_id":{"type":"string","x-stream-index":"002"},"text":{"type":"string","x-stream-index":"005"}},"required":["message_id","message_updated_by_id","message_updated_at","is_deleted","text","attachments","Custom"],"type":"object"},"MessageModerationResult":{"description":"Result of the message moderation","properties":{"action":{"description":"Action taken by automod","title":"Action","type":"string","x-stream-index":"002"},"ai_moderation_response":{"$ref":"#/components/schemas/ModerationResponse","description":"Response from AI moderation","title":"ModerationResponse","x-stream-index":"007"},"blocked_word":{"description":"Word that was blocked","title":"Blocked word","type":"string","x-stream-index":"004"},"blocklist_name":{"description":"Name of the blocklist","title":"Blocklist name","type":"string","x-stream-index":"005"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"010"},"message_id":{"description":"ID of the message","title":"Message ID","type":"string","x-stream-index":"001"},"moderated_by":{"description":"User who moderated the message","title":"Moderated by","type":"string","x-stream-index":"003"},"moderation_thresholds":{"$ref":"#/components/schemas/Thresholds","description":"Thresholds for AI moderation","title":"Thresholds","x-stream-index":"006"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"011"},"user_bad_karma":{"description":"Whether user has bad karma","title":"User bad karma","type":"boolean","x-stream-index":"009"},"user_karma":{"description":"Karma of the user","format":"float","title":"User karma","type":"number","x-stream-index":"008"}},"required":["message_id","action","user_karma","user_bad_karma","created_at","updated_at"],"title":"Message moderation result","type":"object"},"MessageNewEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"005.002"},"channel_type":{"type":"string","x-stream-index":"005.003"},"cid":{"type":"string","x-stream-index":"005.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"004.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"006.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"notification.thread_message_new","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"},"watcher_count":{"format":"int32","type":"integer","x-stream-index":"002.001"}},"required":["watcher_count","type","created_at","cid","channel_id","channel_type"],"title":"MessageNewEvent","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"},"MessageOptions":{"properties":{"include_thread_participants":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"MessagePaginationParams":{"type":"object"},"MessageReadEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"003"},"channel_last_message_at":{"format":"date-time","type":"string","x-stream-index":"005"},"channel_type":{"type":"string","x-stream-index":"004"},"cid":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"string","x-stream-index":"009"},"last_read_message_id":{"type":"string","x-stream-index":"010"},"team":{"type":"string","x-stream-index":"006"},"thread":{"$ref":"#/components/schemas/ThreadResponse","x-stream-index":"008"},"type":{"default":"message.read","type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","x-stream-index":"007"}},"required":["type","cid","channel_id","channel_type","created_at"],"type":"object"},"MessageReminder":{"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"004"},"channel_cid":{"type":"string","x-stream-index":"003"},"created_at":{"format":"date-time","type":"string","x-stream-index":"011"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"006"},"message_id":{"type":"string","x-stream-index":"005"},"remind_at":{"format":"date-time","type":"string","x-stream-index":"009"},"task_id":{"type":"string","x-stream-index":"010"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"012"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"user_id":{"type":"string","x-stream-index":"007"}},"required":["channel_cid","message_id","user_id","task_id","created_at","updated_at"],"type":"object"},"MessageRequest":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"maximum":30,"type":"array","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"html":{"type":"string","x-stream-index":"010"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"mentioned_users":{"items":{"type":"string"},"maximum":100,"type":"array","x-stream-index":"008"},"mml":{"type":"string","x-stream-index":"003"},"parent_id":{"type":"string","x-stream-index":"005"},"pin_expires":{"format":"date-time","type":"string","x-stream-index":"015"},"pinned":{"type":"boolean","x-stream-index":"013"},"pinned_at":{"format":"date-time","nullable":true,"type":"string","x-stream-index":"014"},"poll_id":{"type":"string","x-stream-index":"039"},"quoted_message_id":{"type":"string","x-stream-index":"009"},"restricted_visibility":{"items":{"type":"string"},"maximum":10,"type":"array","x-stream-index":"016"},"shared_location":{"$ref":"#/components/schemas/SharedLocation","x-stream-index":"040"},"show_in_channel":{"type":"boolean","x-stream-index":"006"},"silent":{"type":"boolean","x-stream-index":"012"},"text":{"type":"string","x-stream-index":"002"},"type":{"enum":["''","regular","system"],"type":"string","x-stream-index":"011"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"021.002"},"user_id":{"type":"string","x-stream-index":"021.001"}},"type":"object"},"MessageResponse":{"description":"Represents any chat message","properties":{"attachments":{"description":"Array of message attachments","items":{"$ref":"#/components/schemas/Attachment"},"title":"Message attachments","type":"array","x-stream-docs-page-id":"message_format#attachment-format","x-stream-index":"008"},"cid":{"description":"Channel unique identifier in \u003ctype\u003e:\u003cid\u003e format","title":"Channel CID","type":"string","x-stream-index":"022"},"command":{"description":"Contains provided slash command","title":"Command","type":"string","x-stream-docs-page-id":"custom_commands_webhook","x-stream-index":"004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"023"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"026"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"string","x-stream-index":"025"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"018"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"041"},"html":{"description":"Contains HTML markup of the message. Can only be set when using server-side API","title":"HTML content","type":"string","x-stream-index":"005"},"i18n":{"additionalProperties":{"type":"string"},"description":"Object with translations. Key `language` contains the original language key. Other keys contain translations","title":"Internationalization info","type":"object","x-stream-docs-page-id":"translation","x-stream-index":"030"},"id":{"description":"Message ID is unique string identifier of the message","title":"ID","type":"string","x-stream-index":"001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"Contains image moderation information","title":"Image moderation labels","type":"object","x-stream-index":"028"},"latest_reactions":{"description":"List of 10 latest reactions to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Latest reactions","type":"array","x-stream-index":"009"},"mentioned_users":{"description":"List of mentioned users","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Mentioned Users","type":"array","x-stream-index":"029"},"message_text_updated_at":{"format":"date-time","type":"string","x-stream-index":"036"},"mml":{"description":"Should be empty if `text` is provided. Can only be set when using server-side API","title":"Messaging Markup Language","type":"string","x-stream-docs-page-id":"mml_overview","x-stream-index":"003"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"039"},"own_reactions":{"description":"List of 10 latest reactions of authenticated user to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Own reactions","type":"array","x-stream-index":"010"},"parent_id":{"description":"ID of parent message (thread)","title":"Parent message ID","type":"string","x-stream-docs-page-id":"threads","x-stream-index":"015"},"pin_expires":{"description":"Date when pinned message expires","format":"date-time","title":"Pin expiration date","type":"string","x-stream-docs-page-id":"pinned_messages","x-stream-index":"035"},"pinned":{"description":"Whether message is pinned or not","title":"Pinned","type":"boolean","x-stream-docs-page-id":"pinned_messages","x-stream-index":"032"},"pinned_at":{"description":"Date when message got pinned","format":"date-time","title":"Pinned at","type":"string","x-stream-docs-page-id":"pinned_messages","x-stream-index":"033"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","description":"Contains user who pinned the message","title":"Pinned by","x-stream-docs-page-id":"pinned_messages","x-stream-index":"034"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"038"},"poll_id":{"description":"Identifier of the poll to include in the message","title":"Poll ID","type":"string","x-stream-index":"037"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","description":"Contains quoted message","title":"Quoted message","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"020"},"quoted_message_id":{"title":"ID of quoted message","type":"string","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"019"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing number of reactions of each type. Key: reaction type (string), value: number of reactions (int)","title":"Reaction counts","type":"object","x-stream-index":"011"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"014"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing scores of reactions of each type. Key: reaction type (string), value: total score of reactions (int)","title":"Reaction scores","type":"object","x-stream-index":"012"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"042"},"reply_count":{"description":"Number of replies to this message","format":"int32","title":"Reply count","type":"integer","x-stream-index":"017"},"restricted_visibility":{"description":"A list of user ids that have restricted visibility to the message, if the list is not empty, the message is only visible to the users in the list","items":{"type":"string"},"title":"Restricted visibility","type":"array","x-stream-index":"040"},"shadowed":{"description":"Whether the message was shadowed or not","title":"Shadowed","type":"boolean","x-stream-docs-page-id":"moderation#shadow-ban","x-stream-index":"027"},"shared_location":{"$ref":"#/components/schemas/SharedLocationResponseData","description":"Contains shared location data","title":"Shared Location","x-stream-index":"043"},"show_in_channel":{"description":"Whether thread reply should be shown in the channel as well","title":"Show in channel","type":"boolean","x-stream-docs-page-id":"threads","x-stream-index":"016"},"silent":{"description":"Whether message is silent or not","title":"Silent","type":"boolean","x-stream-index":"031"},"text":{"description":"Text of the message. Should be empty if `mml` is provided","title":"Text","type":"string","x-stream-index":"002"},"thread_participants":{"description":"List of users who participate in thread","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Thread participants","type":"array","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"021"},"type":{"description":"Contains type of the message","enum":["regular","ephemeral","error","reply","system","deleted"],"title":"Message Type","type":"string","x-stream-docs-page-id":"message_format#message-types","x-stream-index":"006"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"024"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Sender of the message. Required when using server-side API","title":"User object","x-stream-index":"007"}},"required":["id","text","html","type","user","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned","restricted_visibility"],"title":"Message","type":"object","x-stream-docs-page-id":"send_message"},"MessageUnblockedEvent":{"properties":{"cid":{"type":"string","x-stream-index":"001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"004.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"002.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"002.002"},"type":{"default":"message.unblocked","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["cid","type","created_at"],"title":"MessageUnblockedEvent","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"},"MessageUndeletedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"005.002"},"channel_type":{"type":"string","x-stream-index":"005.003"},"cid":{"type":"string","x-stream-index":"005.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"004.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"002.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"message.undeleted","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MessageUndeletedEvent","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"},"MessageUpdate":{"properties":{"change_set":{"$ref":"#/components/schemas/MessageChangeSet","x-stream-index":"002"},"old_text":{"type":"string","x-stream-index":"001"}},"type":"object"},"MessageUpdatedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"005.002"},"channel_type":{"type":"string","x-stream-index":"005.003"},"cid":{"type":"string","x-stream-index":"005.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"004.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"002.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"message.updated","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MessageUpdatedEvent","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"},"MessageWithChannelResponse":{"description":"Represents any chat message","properties":{"attachments":{"description":"Array of message attachments","items":{"$ref":"#/components/schemas/Attachment"},"title":"Message attachments","type":"array","x-stream-docs-page-id":"message_format#attachment-format","x-stream-index":"001.008"},"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel object","title":"Channel","x-stream-index":"002"},"cid":{"description":"Channel unique identifier in \u003ctype\u003e:\u003cid\u003e format","title":"Channel CID","type":"string","x-stream-index":"001.022"},"command":{"description":"Contains provided slash command","title":"Command","type":"string","x-stream-docs-page-id":"custom_commands_webhook","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.023"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.026"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"string","x-stream-index":"001.025"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"001.018"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001.041"},"html":{"description":"Contains HTML markup of the message. Can only be set when using server-side API","title":"HTML content","type":"string","x-stream-index":"001.005"},"i18n":{"additionalProperties":{"type":"string"},"description":"Object with translations. Key `language` contains the original language key. Other keys contain translations","title":"Internationalization info","type":"object","x-stream-docs-page-id":"translation","x-stream-index":"001.030"},"id":{"description":"Message ID is unique string identifier of the message","title":"ID","type":"string","x-stream-index":"001.001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"Contains image moderation information","title":"Image moderation labels","type":"object","x-stream-index":"001.028"},"latest_reactions":{"description":"List of 10 latest reactions to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Latest reactions","type":"array","x-stream-index":"001.009"},"mentioned_users":{"description":"List of mentioned users","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Mentioned Users","type":"array","x-stream-index":"001.029"},"message_text_updated_at":{"format":"date-time","type":"string","x-stream-index":"001.036"},"mml":{"description":"Should be empty if `text` is provided. Can only be set when using server-side API","title":"Messaging Markup Language","type":"string","x-stream-docs-page-id":"mml_overview","x-stream-index":"001.003"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"001.039"},"own_reactions":{"description":"List of 10 latest reactions of authenticated user to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Own reactions","type":"array","x-stream-index":"001.010"},"parent_id":{"description":"ID of parent message (thread)","title":"Parent message ID","type":"string","x-stream-docs-page-id":"threads","x-stream-index":"001.015"},"pin_expires":{"description":"Date when pinned message expires","format":"date-time","title":"Pin expiration date","type":"string","x-stream-docs-page-id":"pinned_messages","x-stream-index":"001.035"},"pinned":{"description":"Whether message is pinned or not","title":"Pinned","type":"boolean","x-stream-docs-page-id":"pinned_messages","x-stream-index":"001.032"},"pinned_at":{"description":"Date when message got pinned","format":"date-time","title":"Pinned at","type":"string","x-stream-docs-page-id":"pinned_messages","x-stream-index":"001.033"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","description":"Contains user who pinned the message","title":"Pinned by","x-stream-docs-page-id":"pinned_messages","x-stream-index":"001.034"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001.038"},"poll_id":{"description":"Identifier of the poll to include in the message","title":"Poll ID","type":"string","x-stream-index":"001.037"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","description":"Contains quoted message","title":"Quoted message","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"001.020"},"quoted_message_id":{"title":"ID of quoted message","type":"string","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"001.019"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing number of reactions of each type. Key: reaction type (string), value: number of reactions (int)","title":"Reaction counts","type":"object","x-stream-index":"001.011"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"001.014"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing scores of reactions of each type. Key: reaction type (string), value: total score of reactions (int)","title":"Reaction scores","type":"object","x-stream-index":"001.012"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"001.042"},"reply_count":{"description":"Number of replies to this message","format":"int32","title":"Reply count","type":"integer","x-stream-index":"001.017"},"restricted_visibility":{"description":"A list of user ids that have restricted visibility to the message, if the list is not empty, the message is only visible to the users in the list","items":{"type":"string"},"title":"Restricted visibility","type":"array","x-stream-index":"001.040"},"shadowed":{"description":"Whether the message was shadowed or not","title":"Shadowed","type":"boolean","x-stream-docs-page-id":"moderation#shadow-ban","x-stream-index":"001.027"},"shared_location":{"$ref":"#/components/schemas/SharedLocationResponseData","description":"Contains shared location data","title":"Shared Location","x-stream-index":"001.043"},"show_in_channel":{"description":"Whether thread reply should be shown in the channel as well","title":"Show in channel","type":"boolean","x-stream-docs-page-id":"threads","x-stream-index":"001.016"},"silent":{"description":"Whether message is silent or not","title":"Silent","type":"boolean","x-stream-index":"001.031"},"text":{"description":"Text of the message. Should be empty if `mml` is provided","title":"Text","type":"string","x-stream-index":"001.002"},"thread_participants":{"description":"List of users who participate in thread","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Thread participants","type":"array","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"001.021"},"type":{"description":"Contains type of the message","enum":["regular","ephemeral","error","reply","system","deleted"],"title":"Message Type","type":"string","x-stream-docs-page-id":"message_format#message-types","x-stream-index":"001.006"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"001.024"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Sender of the message. Required when using server-side API","title":"User object","x-stream-index":"001.007"}},"required":["id","text","html","type","user","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned","restricted_visibility","channel"],"title":"Message","type":"object","x-stream-docs-page-id":"send_message"},"ModerationDashboardPreferences":{"properties":{"flag_user_on_flagged_content":{"type":"boolean","x-stream-index":"002"},"media_queue_blur_enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"ModerationResponse":{"properties":{"action":{"type":"string","x-stream-index":"004"},"explicit":{"format":"float","type":"number","x-stream-index":"002"},"spam":{"format":"float","type":"number","x-stream-index":"003"},"toxic":{"format":"float","type":"number","x-stream-index":"001"}},"required":["toxic","explicit","spam","action","automod_response"],"type":"object"},"ModerationV2Response":{"properties":{"action":{"type":"string","x-stream-index":"001"},"blocklist_matched":{"type":"string","x-stream-index":"005"},"image_harms":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"original_text":{"type":"string","x-stream-index":"002"},"platform_circumvented":{"type":"boolean","x-stream-index":"007"},"semantic_filter_matched":{"type":"string","x-stream-index":"006"},"text_harms":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"required":["action","original_text"],"type":"object"},"MuteChannelRequest":{"nullable":true,"properties":{"channel_cids":{"description":"Channel CIDs to mute (if multiple channels)","items":{"type":"string"},"maximum":25,"title":"Channel CIDs","type":"array","x-stream-index":"002"},"expiration":{"description":"Duration of mute in milliseconds","title":"Expiration","type":"integer","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"type":"object"},"MuteChannelResponse":{"nullable":true,"properties":{"channel_mute":{"$ref":"#/components/schemas/ChannelMute","description":"Object with channel mute (if one channel was muted)","title":"Channel mute","x-stream-index":"001"},"channel_mutes":{"description":"Object with mutes (if multiple channels were muted)","items":{"$ref":"#/components/schemas/ChannelMute"},"title":"Channel mutes","type":"array","x-stream-index":"002"},"duration":{"type":"string","x-stream-index":"004.001"},"own_user":{"$ref":"#/components/schemas/OwnUser","description":"Authorized user object with fresh mutes information","title":"Own user","x-stream-index":"003"}},"required":["duration"],"type":"object"},"MuteUserRequest":{"nullable":true,"properties":{"target_ids":{"description":"User IDs to mute (if multiple users)","items":{"type":"string"},"maximum":1000,"title":"Target IDs","type":"array","x-stream-index":"002"},"timeout":{"description":"Duration of mute in minutes","minimum":0,"title":"Timeout","type":"integer","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"required":["timeout"],"type":"object"},"MuteUserResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"005.001"},"mute":{"$ref":"#/components/schemas/UserMute","description":"Object with user mute (if one user was muted)","title":"Mute","x-stream-index":"001"},"mutes":{"description":"Object with mutes (if multiple users were muted)","items":{"$ref":"#/components/schemas/UserMute"},"title":"Mutes","type":"array","x-stream-index":"002"},"non_existing_users":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"own_user":{"$ref":"#/components/schemas/OwnUser","description":"Authorized user object with fresh mutes information","title":"Own user","x-stream-index":"003"}},"required":["duration"],"type":"object"},"NoiseCancellationSettings":{"properties":{"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode"],"type":"object"},"NotificationMarkUnreadEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003.004"},"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"003.005"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"first_unread_message_id":{"type":"string","x-stream-index":"005"},"last_read_at":{"format":"date-time","type":"string","x-stream-index":"006"},"last_read_message_id":{"type":"string","x-stream-index":"012"},"team":{"type":"string","x-stream-index":"002.001"},"thread_id":{"type":"string","x-stream-index":"013"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"009"},"type":{"default":"notification.mark_unread","type":"string","x-stream-index":"001.001"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"010"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"008"},"unread_messages":{"format":"int32","type":"integer","x-stream-index":"007"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"011"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count","first_unread_message_id","last_read_at","unread_messages","unread_count","total_unread_count","unread_channels","unread_threads"],"title":"NotificationMarkUnreadEvent","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"},"NotificationSettings":{"properties":{"call_live_started":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"002"},"call_missed":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"006"},"call_notification":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"004"},"call_ring":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"session_started":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"003"}},"required":["enabled","call_live_started","session_started","call_notification","call_ring","call_missed"],"type":"object"},"OnlyUserID":{"properties":{"id":{"type":"string","x-stream-index":"001"}},"required":["id"],"type":"object"},"OwnUser":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"046"},"banned":{"type":"boolean","x-stream-index":"016"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"045"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"029"},"created_at":{"format":"date-time","type":"string","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"deactivated_at":{"format":"date-time","type":"string","x-stream-index":"014"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"013"},"devices":{"items":{"$ref":"#/components/schemas/Device"},"type":"array","x-stream-index":"027"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"023"},"language":{"type":"string","x-stream-index":"035"},"last_active":{"format":"date-time","type":"string","x-stream-index":"011"},"last_engaged_at":{"format":"date-time","type":"string","x-stream-index":"012"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"037"},"mutes":{"items":{"$ref":"#/components/schemas/UserMute"},"type":"array","x-stream-index":"028"},"online":{"type":"boolean","x-stream-index":"022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"026"},"push_preferences":{"$ref":"#/components/schemas/PushPreferences","x-stream-index":"025"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"005"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"031"},"total_unread_count_by_team":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"032"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"033"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"030"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"034"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"009"}},"required":["id","role","custom","created_at","updated_at","banned","online","devices","mutes","channel_mutes","unread_count","total_unread_count","total_unread_count_by_team","unread_channels","unread_threads","language"],"type":"object"},"OwnUserResponse":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"banned":{"type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"015"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"007"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"string","x-stream-index":"001.016"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"001.011"},"devices":{"items":{"$ref":"#/components/schemas/DeviceResponse"},"title":"Devices","type":"array","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001.001"},"image":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"005"},"language":{"type":"string","x-stream-index":"001.005"},"last_active":{"format":"date-time","type":"string","x-stream-index":"001.014"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"013"},"mutes":{"items":{"$ref":"#/components/schemas/UserMuteResponse"},"type":"array","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"001.002"},"online":{"type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"003"},"push_preferences":{"$ref":"#/components/schemas/PushPreferences","x-stream-index":"002"},"revoke_tokens_issued_before":{"format":"date-time","type":"string","x-stream-index":"001.015"},"role":{"type":"string","x-stream-index":"001.006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"009"},"total_unread_count_by_team":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"010"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"011"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"008"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"012"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","devices","invisible","mutes","channel_mutes","unread_count","total_unread_count","unread_channels","unread_threads"],"type":"object"},"PagerResponse":{"properties":{"next":{"type":"string","x-stream-index":"001"},"prev":{"type":"string","x-stream-index":"002"}},"type":"object"},"PaginationParams":{"properties":{"limit":{"format":"int32","minimum":0,"type":"integer","x-stream-index":"001"},"offset":{"format":"int32","type":"integer","x-stream-index":"002"}},"type":"object"},"PendingMessageEvent":{"description":"Pending message event for async moderation","nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"002.007"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"message":{"$ref":"#/components/schemas/Message","description":"The pending message","title":"Message","x-stream-index":"002.009"},"metadata":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"002.010"},"method":{"description":"The method used for the pending message","title":"Method","type":"string","x-stream-index":"003"},"received_at":{"format":"date-time","type":"string","x-stream-index":"001.004"},"type":{"default":"message.pending","description":"The type of event: \"message.pending\" in this case","title":"Event Type","type":"string","x-stream-index":"001.002"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.002"}},"required":["type","custom","method","created_at"],"title":"PendingMessageEvent","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"},"PendingMessageResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"003"},"metadata":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"}},"type":"object"},"Permission":{"properties":{"action":{"description":"Action name this permission is for (e.g. SendMessage)","title":"Action","type":"string","x-stream-index":"004"},"condition":{"additionalProperties":{},"description":"MongoDB style condition which decides whether or not the permission is granted","title":"Condition","type":"object","x-stream-index":"007"},"custom":{"description":"Whether this is a custom permission or built-in","title":"Custom","type":"boolean","x-stream-index":"009"},"description":{"description":"Description of the permission","title":"Description","type":"string","x-stream-index":"003"},"id":{"description":"Unique permission ID","title":"ID","type":"string","x-stream-index":"001"},"level":{"description":"Level at which permission could be applied (app or channel)","enum":["app","channel"],"title":"Level","type":"string","x-stream-index":"010"},"name":{"description":"Name of the permission","title":"Name","type":"string","x-stream-index":"002"},"owner":{"description":"Whether this permission applies to resource owner or not","title":"Owner","type":"boolean","x-stream-index":"005"},"same_team":{"description":"Whether this permission applies to teammates (multi-tenancy mode only)","title":"Same team","type":"boolean","x-stream-index":"006"},"tags":{"description":"List of tags of the permission","items":{"type":"string"},"title":"Tags","type":"array","x-stream-index":"011"}},"required":["id","name","description","action","owner","same_team","custom","level","tags"],"type":"object"},"Policy":{"properties":{"action":{"type":"integer","x-stream-index":"007"},"created_at":{"format":"date-time","type":"string","x-stream-index":"010"},"name":{"type":"string","x-stream-index":"004"},"owner":{"type":"boolean","x-stream-index":"008"},"priority":{"format":"int32","type":"integer","x-stream-index":"009"},"resources":{"items":{"type":"string"},"type":"array","x-stream-index":"005"},"roles":{"items":{"type":"string"},"type":"array","x-stream-index":"006"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"011"}},"required":["name","resources","roles","action","owner","priority","created_at","updated_at"],"type":"object"},"PolicyRequest":{"description":"Policy request","properties":{"action":{"enum":["Deny","Allow"],"title":"Action","type":"string","x-stream-index":"001"},"name":{"description":"User-friendly policy name","title":"Name","type":"string","x-stream-index":"002"},"owner":{"description":"Whether policy applies to resource owner or not","title":"Owner","type":"boolean","x-stream-index":"005"},"priority":{"description":"Policy priority","format":"int32","maximum":999,"minimum":1,"title":"Priority","type":"integer","x-stream-index":"006"},"resources":{"description":"List of resources to apply policy to","items":{"type":"string"},"minimum":1,"title":"Resources","type":"array","x-stream-index":"003"},"roles":{"description":"List of roles to apply policy to","items":{"type":"string"},"title":"Roles","type":"array","x-stream-index":"004"}},"required":["action","name","resources","roles","owner","priority"],"title":"PolicyRequest","type":"object"},"Poll":{"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"023"},"allow_answers":{"type":"boolean","x-stream-index":"010"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"009"},"answers_count":{"format":"int32","type":"integer","x-stream-index":"015"},"created_at":{"format":"date-time","type":"string","x-stream-index":"021"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"020"},"created_by_id":{"type":"string","x-stream-index":"019"},"description":{"type":"string","x-stream-index":"005"},"enforce_unique_vote":{"type":"boolean","x-stream-index":"007"},"id":{"type":"string","x-stream-index":"003"},"is_closed":{"type":"boolean","x-stream-index":"011"},"latest_answers":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array","x-stream-index":"017"},"latest_votes_by_option":{"additionalProperties":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array"},"type":"object","x-stream-index":"016"},"max_votes_allowed":{"format":"int32","type":"integer","x-stream-index":"008"},"name":{"type":"string","x-stream-index":"004"},"options":{"items":{"$ref":"#/components/schemas/PollOption"},"type":"array","x-stream-index":"013"},"own_votes":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array","x-stream-index":"018"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"022"},"vote_count":{"format":"int32","type":"integer","x-stream-index":"012"},"vote_counts_by_option":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"014"},"voting_visibility":{"type":"string","x-stream-index":"006"}},"required":["id","name","description","enforce_unique_vote","allow_user_suggested_options","allow_answers","vote_count","options","vote_counts_by_option","answers_count","latest_votes_by_option","latest_answers","own_votes","created_by_id","created_at","updated_at","Custom"],"type":"object"},"PollOption":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id","text","custom"],"type":"object"},"PollOptionInput":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"text":{"type":"string","x-stream-index":"002"}},"type":"object"},"PollOptionRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id"],"type":"object"},"PollOptionResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"poll_option":{"$ref":"#/components/schemas/PollOptionResponseData","description":"Poll option","title":"PollOptionResponseData","x-stream-index":"001"}},"required":["poll_option","duration"],"type":"object"},"PollOptionResponseData":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id","text","custom"],"type":"object"},"PollResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"poll":{"$ref":"#/components/schemas/PollResponseData","description":"Poll","title":"PollResponseData","x-stream-index":"001"}},"required":["poll","duration"],"type":"object"},"PollResponseData":{"properties":{"allow_answers":{"type":"boolean","x-stream-index":"008"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"007"},"answers_count":{"format":"int32","type":"integer","x-stream-index":"012"},"created_at":{"format":"date-time","type":"string","x-stream-index":"019"},"created_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"018"},"created_by_id":{"type":"string","x-stream-index":"017"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"021"},"description":{"type":"string","x-stream-index":"003"},"enforce_unique_vote":{"type":"boolean","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"is_closed":{"type":"boolean","x-stream-index":"009"},"latest_answers":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array","x-stream-index":"015"},"latest_votes_by_option":{"additionalProperties":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array"},"type":"object","x-stream-index":"014"},"max_votes_allowed":{"format":"int32","type":"integer","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"002"},"options":{"items":{"$ref":"#/components/schemas/PollOptionResponseData"},"type":"array","x-stream-index":"011"},"own_votes":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array","x-stream-index":"016"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"020"},"vote_count":{"format":"int32","type":"integer","x-stream-index":"010"},"vote_counts_by_option":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"013"},"voting_visibility":{"type":"string","x-stream-index":"004"}},"required":["id","name","description","voting_visibility","enforce_unique_vote","allow_user_suggested_options","allow_answers","vote_count","options","answers_count","vote_counts_by_option","latest_votes_by_option","latest_answers","own_votes","created_by_id","created_at","updated_at","custom"],"type":"object"},"PollVote":{"nullable":true,"properties":{"answer_text":{"type":"string","x-stream-index":"007"},"created_at":{"format":"date-time","type":"string","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"004"},"is_answer":{"type":"boolean","x-stream-index":"006"},"option_id":{"type":"string","x-stream-index":"005"},"poll_id":{"type":"string","x-stream-index":"003"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"011"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"009"},"user_id":{"type":"string","x-stream-index":"008"}},"required":["poll_id","id","option_id","created_at","updated_at"],"type":"object"},"PollVoteResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"vote":{"$ref":"#/components/schemas/PollVoteResponseData","description":"Poll vote","title":"PollVoteResponseData","x-stream-index":"001"}},"required":["duration"],"type":"object"},"PollVoteResponseData":{"nullable":true,"properties":{"answer_text":{"type":"string","x-stream-index":"005"},"created_at":{"format":"date-time","type":"string","x-stream-index":"008"},"id":{"type":"string","x-stream-index":"002"},"is_answer":{"type":"boolean","x-stream-index":"004"},"option_id":{"type":"string","x-stream-index":"003"},"poll_id":{"type":"string","x-stream-index":"001"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"007"},"user_id":{"type":"string","x-stream-index":"006"}},"required":["poll_id","id","option_id","created_at","updated_at"],"type":"object"},"PollVotesResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"votes":{"description":"Poll votes","items":{"$ref":"#/components/schemas/PollVoteResponseData"},"title":"PollVoteResponseList","type":"array","x-stream-index":"001"}},"required":["votes","duration"],"type":"object"},"PrivacySettings":{"properties":{"read_receipts":{"$ref":"#/components/schemas/ReadReceipts","x-stream-index":"002"},"typing_indicators":{"$ref":"#/components/schemas/TypingIndicators","x-stream-index":"001"}},"type":"object"},"PrivacySettingsResponse":{"properties":{"read_receipts":{"$ref":"#/components/schemas/ReadReceiptsResponse","x-stream-index":"002"},"typing_indicators":{"$ref":"#/components/schemas/TypingIndicatorsResponse","x-stream-index":"001"}},"type":"object"},"PushConfig":{"properties":{"offline_only":{"type":"boolean","x-stream-index":"002"},"version":{"enum":["v1","v2","v3"],"type":"string","x-stream-index":"001"}},"required":["version"],"type":"object"},"PushNotificationFields":{"properties":{"apn":{"$ref":"#/components/schemas/APNConfigFields","x-stream-index":"002"},"firebase":{"$ref":"#/components/schemas/FirebaseConfigFields","x-stream-index":"003"},"huawei":{"$ref":"#/components/schemas/HuaweiConfigFields","x-stream-index":"004"},"offline_only":{"type":"boolean","x-stream-index":"001.002"},"providers":{"items":{"$ref":"#/components/schemas/PushProvider"},"type":"array","x-stream-index":"006"},"version":{"type":"string","x-stream-index":"001.001"},"xiaomi":{"$ref":"#/components/schemas/XiaomiConfigFields","x-stream-index":"005"}},"required":["version","offline_only","apn","firebase","huawei","xiaomi"],"type":"object"},"PushNotificationSettingsResponse":{"properties":{"disabled":{"type":"boolean","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"string","x-stream-index":"002"}},"type":"object"},"PushPreferenceInput":{"nullable":true,"properties":{"call_level":{"description":"Set the level of call push notifications for the user. One of all, none, default","enum":["all","none","default"],"type":"string","x-stream-index":"004"},"channel_cid":{"description":"Set the push preferences for a specific channel. If empty it sets the default for the user","type":"string","x-stream-index":"002"},"chat_level":{"description":"Set the level of chat push notifications for the user. One of all, mentions, none, default","enum":["all","mentions","none","default"],"type":"string","x-stream-index":"003"},"disabled_until":{"description":"Disable push notifications till a certain time","format":"date-time","type":"string","x-stream-index":"005"},"remove_disable":{"description":"Remove the disabled until time. (IE stop snoozing notifications)","type":"boolean","x-stream-index":"006"},"user_id":{"description":"The user id for which to set the push preferences. Required when using server side auths, defaults to current user with client side auth.","type":"string","x-stream-index":"001"}},"type":"object"},"PushPreferences":{"properties":{"call_level":{"type":"string","x-stream-index":"002"},"chat_level":{"type":"string","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"string","x-stream-index":"003"}},"type":"object"},"PushProvider":{"nullable":true,"properties":{"apn_auth_key":{"type":"string","x-stream-index":"012"},"apn_auth_type":{"type":"string","x-stream-index":"017"},"apn_development":{"type":"boolean","x-stream-index":"018"},"apn_host":{"type":"string","x-stream-index":"019"},"apn_key_id":{"type":"string","x-stream-index":"013"},"apn_notification_template":{"type":"string","x-stream-index":"020"},"apn_p12_cert":{"type":"string","x-stream-index":"014"},"apn_team_id":{"type":"string","x-stream-index":"015"},"apn_topic":{"type":"string","x-stream-index":"016"},"created_at":{"format":"date-time","type":"string","x-stream-index":"008"},"description":{"maxLength":128,"type":"string","x-stream-index":"007"},"disabled_at":{"format":"date-time","type":"string","x-stream-index":"010"},"disabled_reason":{"maxLength":255,"type":"string","x-stream-index":"011"},"firebase_apn_template":{"type":"string","x-stream-index":"025"},"firebase_credentials":{"type":"string","x-stream-index":"022"},"firebase_data_template":{"type":"string","x-stream-index":"023"},"firebase_host":{"type":"string","x-stream-index":"026"},"firebase_notification_template":{"type":"string","x-stream-index":"024"},"firebase_server_key":{"type":"string","x-stream-index":"021"},"huawei_app_id":{"type":"string","x-stream-index":"027"},"huawei_app_secret":{"type":"string","x-stream-index":"028"},"name":{"maxLength":36,"minLength":1,"type":"string","x-stream-index":"005"},"push_templates":{"items":{"$ref":"#/components/schemas/PushTemplate"},"type":"array","x-stream-index":"031"},"type":{"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"009"},"xiaomi_app_secret":{"type":"string","x-stream-index":"030"},"xiaomi_package_name":{"type":"string","x-stream-index":"029"}},"required":["name","type","created_at","updated_at"],"type":"object"},"PushProviderResponse":{"properties":{"apn_auth_key":{"type":"string","x-stream-index":"008"},"apn_auth_type":{"type":"string","x-stream-index":"013"},"apn_development":{"type":"boolean","x-stream-index":"014"},"apn_host":{"type":"string","x-stream-index":"015"},"apn_key_id":{"type":"string","x-stream-index":"009"},"apn_p12_cert":{"type":"string","x-stream-index":"010"},"apn_sandbox_certificate":{"type":"boolean","x-stream-index":"016"},"apn_supports_remote_notifications":{"type":"boolean","x-stream-index":"018"},"apn_supports_voip_notifications":{"type":"boolean","x-stream-index":"017"},"apn_team_id":{"type":"string","x-stream-index":"011"},"apn_topic":{"type":"string","x-stream-index":"012"},"created_at":{"format":"date-time","type":"string","x-stream-index":"004"},"description":{"type":"string","x-stream-index":"003"},"disabled_at":{"format":"date-time","type":"string","x-stream-index":"006"},"disabled_reason":{"type":"string","x-stream-index":"007"},"firebase_apn_template":{"type":"string","x-stream-index":"023"},"firebase_credentials":{"type":"string","x-stream-index":"020"},"firebase_data_template":{"type":"string","x-stream-index":"021"},"firebase_host":{"type":"string","x-stream-index":"024"},"firebase_notification_template":{"type":"string","x-stream-index":"022"},"firebase_server_key":{"type":"string","x-stream-index":"019"},"huawei_app_id":{"type":"string","x-stream-index":"025"},"huawei_app_secret":{"type":"string","x-stream-index":"026"},"name":{"type":"string","x-stream-index":"001"},"type":{"type":"string","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"005"},"xiaomi_app_secret":{"type":"string","x-stream-index":"028"},"xiaomi_package_name":{"type":"string","x-stream-index":"027"}},"required":["name","type","created_at","updated_at"],"type":"object"},"PushTemplate":{"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"007"},"enable_push":{"type":"boolean","x-stream-index":"003"},"event_type":{"enum":["message.new","message.updated","reaction.new","notification.reminder_due"],"type":"string","x-stream-index":"005"},"template":{"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"008"}},"required":["enable_push","event_type","created_at","updated_at"],"type":"object"},"QueryBannedUsersPayload":{"properties":{"exclude_expired_bans":{"description":"Whether to exclude expired bans or not","title":"Exclude expired bans","type":"boolean","x-stream-index":"004"},"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"description":"Number of records to return","format":"int32","maximum":300,"minimum":0,"title":"Limit","type":"integer","x-stream-index":"003.003"},"offset":{"description":"Number of records to offset","format":"int32","maximum":10000,"title":"Offset","type":"integer","x-stream-index":"003.004"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":1,"title":"Sort","type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"005.002"},"user_id":{"type":"string","x-stream-index":"005.001"}},"required":["filter_conditions"],"type":"object"},"QueryBannedUsersResponse":{"nullable":true,"properties":{"bans":{"description":"List of found bans","items":{"$ref":"#/components/schemas/BanResponse"},"title":"BanResponse","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["bans","duration"],"type":"object"},"QueryCampaignsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"004.001"},"next":{"type":"string","x-stream-index":"004.002"},"prev":{"type":"string","x-stream-index":"004.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"type":"array","x-stream-index":"002"},"user_limit":{"format":"int32","maximum":1000,"minimum":0,"type":"integer","x-stream-index":"003"}},"type":"object"},"QueryCampaignsResponse":{"description":"Basic response information","nullable":true,"properties":{"campaigns":{"items":{"$ref":"#/components/schemas/CampaignResponse"},"type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["campaigns","duration"],"title":"Response","type":"object"},"QueryChannelsRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"description":"Number of channels to limit","format":"int32","title":"Limit","type":"integer","x-stream-index":"008"},"member_limit":{"description":"Number of members to limit","format":"int32","maximum":100,"minimum":0,"title":"Member limit","type":"integer","x-stream-index":"007"},"message_limit":{"description":"Number of messages to limit","format":"int32","minimum":0,"title":"Message limit","type":"integer","x-stream-index":"006"},"offset":{"description":"Channel pagination offset","format":"int32","title":"Offset","type":"integer","x-stream-index":"009"},"sort":{"description":"List of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"002"},"state":{"description":"Whether to update channel state or not","title":"State","type":"boolean","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"010.002"},"user_id":{"type":"string","x-stream-index":"010.001"}},"title":"Query Channels Request","type":"object","x-stream-docs-page-id":"query_channels"},"QueryChannelsResponse":{"nullable":true,"properties":{"channels":{"description":"List of channels","items":{"$ref":"#/components/schemas/ChannelStateResponseFields"},"title":"Channels","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["channels","duration"],"title":"Channels list","type":"object"},"QueryDraftsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","maximum":3,"title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"type":"object"},"QueryDraftsResponse":{"nullable":true,"properties":{"drafts":{"description":"Drafts","items":{"$ref":"#/components/schemas/DraftResponse"},"title":"DraftsResponseList","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["drafts","duration"],"type":"object"},"QueryMembersPayload":{"description":"Client request","properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"002"},"limit":{"format":"int32","maximum":300,"minimum":0,"type":"integer","x-stream-index":"006.003"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"type":"array","x-stream-index":"003"},"offset":{"format":"int32","maximum":10000,"type":"integer","x-stream-index":"006.004"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":1,"type":"array","x-stream-index":"005"},"type":{"maxLength":64,"type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"007.002"},"user_id":{"type":"string","x-stream-index":"007.001"}},"required":["type","filter_conditions"],"title":"ClientRequest","type":"object"},"QueryMessageFlagsPayload":{"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":300,"minimum":0,"type":"integer","x-stream-index":"003.003"},"offset":{"format":"int32","maximum":10000,"type":"integer","x-stream-index":"003.004"},"show_deleted_messages":{"description":"Whether to include deleted messages in the results","title":"ShowDeletedMessages","type":"boolean","x-stream-index":"002"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"type":"array","x-stream-index":"003.005"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"type":"object"},"QueryMessageFlagsResponse":{"description":"Query message flags response","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"flags":{"description":"The flags that match the query","items":{"$ref":"#/components/schemas/MessageFlagResponse"},"title":"MessageFlagResponseList","type":"array","x-stream-index":"001"}},"required":["flags","duration"],"title":"QueryMessageFlagsResponse","type":"object"},"QueryMessageHistoryRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","maximum":3,"minimum":1,"title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"004.001"},"next":{"type":"string","x-stream-index":"004.002"},"prev":{"type":"string","x-stream-index":"004.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"002"}},"required":["filter"],"type":"object"},"QueryMessageHistoryResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message_history":{"description":"Message history entries","items":{"$ref":"#/components/schemas/MessageHistoryEntryResponse"},"title":"MessageHistoryEntryResponseList","type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["message_history","duration"],"type":"object"},"QueryPollVotesRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","title":"Filter","type":"object","x-stream-index":"003"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"004"}},"type":"object"},"QueryPollsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","title":"Filter","type":"object","x-stream-index":"002"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"003"}},"type":"object"},"QueryPollsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"polls":{"description":"Polls data returned by the query","items":{"$ref":"#/components/schemas/PollResponseData"},"title":"PollsResponseData","type":"array","x-stream-index":"001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["polls","duration"],"type":"object"},"QueryReactionsRequest":{"properties":{"filter":{"additionalProperties":{},"type":"object","x-stream-index":"002"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"006.001"},"next":{"type":"string","x-stream-index":"006.002"},"prev":{"type":"string","x-stream-index":"006.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":2,"type":"array","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"type":"object"},"QueryReactionsResponse":{"description":"Basic response information","properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"next":{"type":"string","x-stream-index":"003.001"},"prev":{"type":"string","x-stream-index":"003.002"},"reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"001"}},"required":["reactions","duration"],"title":"Response","type":"object"},"QueryRemindersRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"type":"object"},"QueryRemindersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"reminders":{"description":"MessageReminders data returned by the query","items":{"$ref":"#/components/schemas/ReminderResponseData"},"title":"RemindersResponseData","type":"array","x-stream-index":"001"}},"required":["reminders","duration"],"type":"object"},"QuerySegmentTargetsRequest":{"nullable":true,"properties":{"Filter":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"005"},"Sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"type":"array","writeOnly":true,"x-stream-index":"006"},"limit":{"description":"Limit","format":"int32","maximum":10000,"minimum":0,"title":"int","type":"integer","x-stream-index":"002"},"next":{"description":"Next","title":"string","type":"string","x-stream-index":"003"},"prev":{"description":"Prev","title":"string","type":"string","x-stream-index":"004"}},"type":"object"},"QuerySegmentTargetsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"targets":{"description":"Targets","items":{"$ref":"#/components/schemas/SegmentTargetResponse"},"title":"SegmentTargetResponseList","type":"array","x-stream-index":"001"}},"required":["targets","duration"],"type":"object"},"QuerySegmentsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"002"}},"required":["filter"],"type":"object"},"QuerySegmentsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"segments":{"description":"Segments","items":{"$ref":"#/components/schemas/SegmentResponse"},"title":"SegmentResponses","type":"array","x-stream-index":"001"}},"required":["segments","duration"],"type":"object"},"QueryThreadsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter conditions to apply to threads","title":"Filter","type":"object","x-stream-index":"006"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"008.001"},"member_limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005"},"next":{"type":"string","x-stream-index":"008.002"},"participant_limit":{"description":"Limit the number of participants returned per each thread","format":"int32","maximum":100,"minimum":0,"title":"Participant limit","type":"integer","x-stream-index":"004"},"prev":{"type":"string","x-stream-index":"008.003"},"reply_limit":{"description":"Limit the number of replies returned per each thread","format":"int32","maximum":10,"minimum":0,"title":"Reply limit","type":"integer","x-stream-index":"003"},"sort":{"description":"Sort conditions to apply to threads","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"007"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"010.002"},"user_id":{"type":"string","x-stream-index":"010.001"}},"type":"object"},"QueryThreadsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"threads":{"description":"List of enriched thread states","items":{"$ref":"#/components/schemas/ThreadStateResponse"},"title":"Threads","type":"array","x-stream-index":"001"}},"required":["threads","duration"],"type":"object"},"QueryUsersPayload":{"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"include_deactivated_users":{"type":"boolean","x-stream-index":"004"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.003"},"offset":{"format":"int32","maximum":1000,"type":"integer","x-stream-index":"005.004"},"presence":{"type":"boolean","x-stream-index":"003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"006.002"},"user_id":{"type":"string","x-stream-index":"006.001"}},"required":["filter_conditions"],"type":"object"},"QueryUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"users":{"description":"Array of users as result of filters applied.","items":{"$ref":"#/components/schemas/FullUserResponse"},"title":"Users","type":"array","x-stream-index":"001"}},"required":["users","duration"],"type":"object"},"RTMPLocation":{"properties":{"name":{"type":"string","x-stream-index":"001"},"stream_key":{"type":"string","x-stream-index":"003"},"stream_url":{"type":"string","x-stream-index":"002"}},"required":["name","stream_url","stream_key"],"type":"object"},"RTMPSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"003"},"location":{"$ref":"#/components/schemas/RTMPLocation","x-stream-index":"004"},"quality_name":{"type":"string","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"Reaction":{"nullable":true,"properties":{"created_at":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"message_id":{"type":"string","x-stream-index":"003"},"score":{"format":"int32","type":"integer","x-stream-index":"007"},"type":{"maxLength":30,"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["message_id","type","score","created_at","updated_at","custom"],"type":"object"},"ReactionDeletedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"006.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"002"},"team":{"type":"string","x-stream-index":"005.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"reaction.deleted","type":"string","x-stream-index":"006.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"ReactionDeletedEvent","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"},"ReactionGroupResponse":{"description":"ReactionGroupResponse contains all information about a reaction of the same type.","nullable":true,"properties":{"count":{"description":"Count is the number of reactions of this type.","format":"int32","title":"Count","type":"integer","x-stream-index":"001"},"first_reaction_at":{"description":"FirstReactionAt is the time of the first reaction of this type. This is the same also if all reaction of this type are deleted, because if someone will react again with the same type, will be preserved the sorting.","format":"date-time","title":"FirstReactionAt","type":"string","x-stream-index":"003"},"last_reaction_at":{"description":"LastReactionAt is the time of the last reaction of this type.","format":"date-time","title":"LastReactionAt","type":"string","x-stream-index":"004"},"sum_scores":{"description":"SumScores is the sum of all scores of reactions of this type. Medium allows you to clap articles more than once and shows the sum of all claps from all users. For example, you can send `clap` x5 using `score: 5`.","format":"int32","title":"SumScores","type":"integer","x-stream-index":"002"}},"required":["count","sum_scores","first_reaction_at","last_reaction_at"],"title":"ReactionGroupResponse","type":"object"},"ReactionNewEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"006.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"002"},"team":{"type":"string","x-stream-index":"005.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"reaction.new","type":"string","x-stream-index":"006.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"ReactionNewEvent","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"},"ReactionRequest":{"description":"Represents user reaction to a message","properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"score":{"description":"Reaction score. If not specified reaction has score of 1","format":"int32","title":"Score","type":"integer","x-stream-index":"002"},"type":{"description":"The type of reaction (e.g. 'like', 'laugh', 'wow')","maxLength":30,"title":"Type","type":"string","x-stream-index":"001"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"006.002"},"user_id":{"type":"string","x-stream-index":"006.001"}},"required":["type"],"title":"Reaction","type":"object","x-stream-docs-page-id":"send_reaction"},"ReactionResponse":{"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"006"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"008"},"message_id":{"description":"Message ID","title":"Message ID","type":"string","x-stream-index":"001"},"score":{"description":"Score of the reaction","format":"int32","title":"Score","type":"integer","x-stream-index":"005"},"type":{"description":"Type of reaction","title":"Type","type":"string","x-stream-index":"004"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"007"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User","title":"UserResponse","x-stream-index":"003"},"user_id":{"description":"User ID","title":"User ID","type":"string","x-stream-index":"002"}},"required":["message_id","user_id","user","type","score","created_at","updated_at","custom"],"type":"object"},"ReactionUpdatedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"006.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"002"},"team":{"type":"string","x-stream-index":"005.001"},"type":{"default":"reaction.updated","type":"string","x-stream-index":"006.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["message","reaction","cid","channel_id","channel_type","type","created_at"],"title":"ReactionUpdatedEvent","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"},"ReactivateUserRequest":{"nullable":true,"properties":{"created_by_id":{"description":"ID of the user who's reactivating the user","title":"Created by ID","type":"string","x-stream-index":"004"},"name":{"description":"Set this field to put new name for the user","title":"Name","type":"string","x-stream-index":"003"},"restore_messages":{"description":"Restore previously deleted messages","title":"Restore messages","type":"boolean","x-stream-index":"002"}},"type":"object"},"ReactivateUserResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.002.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Deactivated user object","title":"User","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"ReactivateUsersRequest":{"description":"Reactivate users in batches","nullable":true,"properties":{"created_by_id":{"description":"ID of the user who's reactivating the users","title":"Created by ID","type":"string","x-stream-index":"003"},"restore_channels":{"type":"boolean","x-stream-index":"004"},"restore_messages":{"description":"Restore previously deleted messages","title":"Restore messages","type":"boolean","x-stream-index":"002"},"user_ids":{"description":"User IDs to reactivate","items":{"type":"string"},"maximum":100,"minimum":1,"title":"User IDs","type":"array","x-stream-index":"001"}},"required":["user_ids"],"title":"ReactivateUsersRequest","type":"object"},"ReactivateUsersResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.002.001"},"task_id":{"type":"string","x-stream-index":"001.001"}},"required":["task_id","duration"],"title":"Response","type":"object"},"ReadReceipts":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"ReadReceiptsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"ReadStateResponse":{"properties":{"last_read":{"format":"date-time","type":"string","x-stream-index":"002"},"last_read_message_id":{"type":"string","x-stream-index":"004"},"unread_messages":{"format":"int32","type":"integer","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"}},"required":["user","last_read","unread_messages"],"type":"object"},"RecordSettings":{"properties":{"audio_only":{"type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"004"},"mode":{"type":"string","x-stream-index":"002"},"quality":{"type":"string","x-stream-index":"003"}},"required":["mode"],"type":"object"},"ReminderCreatedEvent":{"description":"Emitted when a reminder is created.","nullable":true,"properties":{"cid":{"description":"The CID of the Channel for which the reminder was created","title":"Channel CID","type":"string","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.007"},"message_id":{"description":"The ID of the message for which the reminder was created","title":"Message ID","type":"string","x-stream-index":"001.002"},"parent_id":{"description":"The ID of the parent message, if the reminder is for a thread message","title":"Parent ID","type":"string","x-stream-index":"001.005"},"received_at":{"format":"date-time","type":"string","x-stream-index":"001.001.004"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","description":"The reminder object which was created","title":"MessageReminder","x-stream-index":"001.006"},"type":{"default":"reminder.created","description":"The type of event: \"reminder.created\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.002"},"user_id":{"description":"The ID of the user for whom the reminder was created","title":"User ID","type":"string","x-stream-index":"001.003"}},"required":["type","created_at","custom","message_id","user_id","cid"],"title":"ReminderCreatedEvent","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"},"ReminderDeletedEvent":{"description":"Emitted when a reminder is deleted.","nullable":true,"properties":{"cid":{"description":"The CID of the Channel for which the reminder was created","title":"Channel CID","type":"string","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.007"},"message_id":{"description":"The ID of the message for which the reminder was created","title":"Message ID","type":"string","x-stream-index":"001.002"},"parent_id":{"description":"The ID of the parent message, if the reminder is for a thread message","title":"Parent ID","type":"string","x-stream-index":"001.005"},"received_at":{"format":"date-time","type":"string","x-stream-index":"001.001.004"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","description":"The reminder object which was created","title":"MessageReminder","x-stream-index":"001.006"},"type":{"default":"reminder.deleted","description":"The type of event: \"reminder.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.002"},"user_id":{"description":"The ID of the user for whom the reminder was created","title":"User ID","type":"string","x-stream-index":"001.003"}},"required":["type","created_at","custom","message_id","user_id","cid"],"title":"ReminderDeletedEvent","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"},"ReminderNotificationEvent":{"description":"Emitted when a reminder becomes due, triggering a notification for the user.","nullable":true,"properties":{"cid":{"description":"The CID of the Channel for which the reminder was created","title":"Channel CID","type":"string","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.007"},"message_id":{"description":"The ID of the message for which the reminder was created","title":"Message ID","type":"string","x-stream-index":"001.002"},"parent_id":{"type":"string","x-stream-index":"001.005"},"received_at":{"format":"date-time","type":"string","x-stream-index":"001.001.004"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","description":"The reminder object which was created","title":"MessageReminder","x-stream-index":"001.006"},"type":{"default":"notification.reminder_due","description":"The type of event: \"notification.reminder_due\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.002"},"user_id":{"description":"The ID of the user for whom the reminder was created","title":"User ID","type":"string","x-stream-index":"001.003"}},"required":["type","created_at","custom","message_id","user_id","cid"],"title":"ReminderNotificationEvent","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"},"ReminderResponseData":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003"},"channel_cid":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"string","x-stream-index":"008"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"005"},"message_id":{"type":"string","x-stream-index":"004"},"remind_at":{"format":"date-time","type":"string","x-stream-index":"001"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007"},"user_id":{"type":"string","x-stream-index":"006"}},"required":["channel_cid","message_id","user_id","created_at","updated_at"],"type":"object"},"ReminderUpdatedEvent":{"description":"Emitted when a reminder is updated.","nullable":true,"properties":{"cid":{"description":"The CID of the Channel for which the reminder was created","title":"Channel CID","type":"string","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.007"},"message_id":{"description":"The ID of the message for which the reminder was created","title":"Message ID","type":"string","x-stream-index":"001.002"},"parent_id":{"description":"The ID of the parent message, if the reminder is for a thread message","title":"Parent ID","type":"string","x-stream-index":"001.005"},"received_at":{"format":"date-time","type":"string","x-stream-index":"001.001.004"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","description":"The reminder object which was created","title":"MessageReminder","x-stream-index":"001.006"},"type":{"default":"reminder.updated","description":"The type of event: \"reminder.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.002"},"user_id":{"description":"The ID of the user for whom the reminder was created","title":"User ID","type":"string","x-stream-index":"001.003"}},"required":["type","created_at","custom","message_id","user_id","cid"],"title":"ReminderUpdatedEvent","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"},"Response":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001"}},"required":["duration"],"title":"Response","type":"object"},"RestoreUsersRequest":{"nullable":true,"properties":{"user_ids":{"items":{"type":"string"},"maximum":100,"minimum":1,"type":"array","x-stream-index":"001"}},"required":["user_ids"],"type":"object"},"RingSettings":{"properties":{"auto_cancel_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_timeout_ms","missed_call_timeout_ms"],"type":"object"},"Role":{"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"004"},"custom":{"description":"Whether this is a custom role or built-in","title":"Custom","type":"boolean","x-stream-index":"002"},"name":{"description":"Unique role name","title":"Name","type":"string","x-stream-index":"001"},"scopes":{"description":"List of scopes where this role is currently present. `.app` means that role is present in app-level grants","items":{"type":"string"},"title":"Scopes","type":"array","x-stream-index":"003"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"005"}},"required":["name","custom","scopes","created_at","updated_at"],"type":"object"},"S3Request":{"description":"Config for creating Amazon S3 storage.","properties":{"s3_api_key":{"description":"The AWS API key. To use Amazon S3 as your storage provider, you have two authentication options: IAM role or API key. If you do not specify the `s3_api_key` parameter, Stream will use IAM role authentication. In that case make sure to have the correct IAM role configured for your application.","title":"S3ApiKey","type":"string","x-stream-index":"002"},"s3_custom_endpoint_url":{"description":"The custom endpoint for S3. If you want to use a custom endpoint, you must also provide the `s3_api_key` and `s3_secret` parameters.","title":"S3CustomEndpointURL","type":"string","x-stream-index":"004"},"s3_region":{"description":"The AWS region where the bucket is hosted","title":"S3Region","type":"string","x-stream-index":"001"},"s3_secret":{"description":"The AWS API Secret","title":"S3Secret","type":"string","x-stream-index":"003"}},"required":["s3_region"],"title":"S3Request","type":"object"},"ScreensharingSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled"],"type":"object"},"SearchPayload":{"properties":{"filter_conditions":{"additionalProperties":{},"description":"Channel filter conditions","maximum":100,"minimum":1,"title":"Channel filter","type":"object","x-stream-docs-page-id":"query_channels","x-stream-index":"002"},"limit":{"description":"Number of messages to return","format":"int32","title":"Limit","type":"integer","x-stream-index":"005"},"message_filter_conditions":{"additionalProperties":{},"description":"Message filter conditions","title":"Message filter","type":"object","x-stream-index":"003"},"message_options":{"$ref":"#/components/schemas/MessageOptions","x-stream-index":"004"},"next":{"description":"Pagination parameter. Cannot be used with non-zero offset.","title":"Next","type":"string","x-stream-index":"008"},"offset":{"description":"Pagination offset. Cannot be used with sort or next.","format":"int32","title":"Offset","type":"integer","x-stream-index":"006"},"query":{"description":"Search phrase","title":"Query","type":"string","x-stream-index":"001"},"sort":{"description":"Sort parameters. Cannot be used with non-zero offset","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"007"}},"required":["filter_conditions"],"type":"object"},"SearchResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"005.001"},"next":{"description":"Value to pass to the next search query in order to paginate","title":"Next","type":"string","x-stream-index":"003"},"previous":{"description":"Value that points to the previous page. Pass as the next value in a search query to paginate backwards","title":"Previous","type":"string","x-stream-index":"004"},"results":{"description":"Search results","items":{"$ref":"#/components/schemas/SearchResult"},"title":"Results","type":"array","x-stream-index":"001"},"results_warning":{"$ref":"#/components/schemas/SearchWarning","description":"Warning about the search results","title":"Results Warning","x-stream-index":"002"}},"required":["results","duration"],"type":"object"},"SearchResult":{"properties":{"message":{"$ref":"#/components/schemas/SearchResultMessage","description":"Found message","title":"Message","x-stream-index":"001"}},"type":"object"},"SearchResultMessage":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"001.008"},"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel object","title":"Channel","x-stream-index":"002"},"cid":{"type":"string","x-stream-index":"001.022"},"command":{"type":"string","x-stream-index":"001.004"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.023"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.026"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"001.025"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"001.018"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001.041"},"html":{"type":"string","x-stream-index":"001.005"},"i18n":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.030"},"id":{"type":"string","x-stream-index":"001.001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"001.028"},"latest_reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"001.009"},"mentioned_users":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"001.029"},"message_text_updated_at":{"format":"date-time","type":"string","x-stream-index":"001.036"},"mml":{"type":"string","x-stream-index":"001.003"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"001.039"},"own_reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"001.010"},"parent_id":{"type":"string","x-stream-index":"001.015"},"pin_expires":{"format":"date-time","type":"string","x-stream-index":"001.035"},"pinned":{"type":"boolean","x-stream-index":"001.032"},"pinned_at":{"format":"date-time","type":"string","x-stream-index":"001.033"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001.034"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001.038"},"poll_id":{"type":"string","x-stream-index":"001.037"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001.020"},"quoted_message_id":{"type":"string","x-stream-index":"001.019"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001.011"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"001.014"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001.012"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"001.042"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"001.017"},"restricted_visibility":{"items":{"type":"string"},"type":"array","x-stream-index":"001.040"},"shadowed":{"type":"boolean","x-stream-index":"001.027"},"shared_location":{"$ref":"#/components/schemas/SharedLocationResponseData","x-stream-index":"001.043"},"show_in_channel":{"type":"boolean","x-stream-index":"001.016"},"silent":{"type":"boolean","x-stream-index":"001.031"},"text":{"type":"string","x-stream-index":"001.002"},"thread_participants":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"001.021"},"type":{"type":"string","x-stream-index":"001.006"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"001.024"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001.007"}},"required":["id","text","html","type","user","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned","restricted_visibility"],"type":"object"},"SearchWarning":{"properties":{"channel_search_cids":{"description":"Channel CIDs for the searched channels","items":{"type":"string"},"title":"Channel Search CIDs","type":"array","x-stream-index":"004"},"channel_search_count":{"description":"Number of channels searched","format":"int32","title":"Channel Search Count","type":"integer","x-stream-index":"003"},"warning_code":{"description":"Code corresponding to the warning","format":"int32","title":"Warning Code","type":"integer","x-stream-index":"002"},"warning_description":{"description":"Description of the warning","title":"Warning Description","type":"string","x-stream-index":"001"}},"required":["warning_description","warning_code"],"type":"object"},"Segment":{"nullable":true,"properties":{"all_sender_channels":{"type":"boolean","x-stream-index":"007"},"all_users":{"type":"boolean","x-stream-index":"006"},"created_at":{"format":"date-time","type":"string","x-stream-index":"010"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"012"},"description":{"type":"string","x-stream-index":"004"},"filter":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"name":{"type":"string","x-stream-index":"003"},"size":{"format":"int32","type":"integer","x-stream-index":"009"},"task_id":{"type":"string","x-stream-index":"008"},"type":{"type":"string","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"011"}},"required":["id","type","name","all_users","all_sender_channels","size","created_at","updated_at"],"type":"object"},"SegmentResponse":{"properties":{"all_sender_channels":{"type":"boolean","x-stream-index":"007"},"all_users":{"type":"boolean","x-stream-index":"006"},"created_at":{"format":"date-time","type":"string","x-stream-index":"009"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"011"},"description":{"type":"string","x-stream-index":"004"},"filter":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"name":{"type":"string","x-stream-index":"003"},"size":{"format":"int32","type":"integer","x-stream-index":"008"},"type":{"type":"string","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"010"}},"required":["id","type","name","description","filter","all_users","all_sender_channels","size","created_at","updated_at","deleted_at"],"type":"object"},"SegmentTargetResponse":{"nullable":true,"properties":{"app_pk":{"format":"int32","type":"integer","x-stream-index":"001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"004"},"segment_id":{"type":"string","x-stream-index":"002"},"target_id":{"type":"string","x-stream-index":"003"}},"required":["app_pk","segment_id","target_id","created_at"],"type":"object"},"SendEventRequest":{"nullable":true,"properties":{"event":{"$ref":"#/components/schemas/EventRequest","x-stream-index":"001"}},"required":["event"],"type":"object"},"SendMessageRequest":{"nullable":true,"properties":{"force_moderation":{"type":"boolean","x-stream-index":"007"},"keep_channel_hidden":{"type":"boolean","x-stream-index":"008"},"message":{"$ref":"#/components/schemas/MessageRequest","x-stream-index":"001"},"pending":{"type":"boolean","x-stream-index":"006"},"pending_message_metadata":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"005"},"skip_enrich_url":{"type":"boolean","x-stream-index":"003"},"skip_push":{"type":"boolean","x-stream-index":"002"}},"required":["message"],"type":"object"},"SendMessageResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Message response","title":"Message","x-stream-index":"001"},"pending_message_metadata":{"additionalProperties":{"type":"string"},"description":"Pending message metadata","title":"Pending message metadata","type":"object","x-stream-index":"002"}},"required":["message","duration"],"type":"object"},"SendReactionRequest":{"nullable":true,"properties":{"enforce_unique":{"description":"Whether to replace all existing user reactions","title":"Enforce unique","type":"boolean","x-stream-index":"003"},"reaction":{"$ref":"#/components/schemas/ReactionRequest","x-stream-index":"002"},"skip_push":{"description":"Skips any mobile push notifications","title":"Skip push","type":"boolean","x-stream-index":"004"}},"required":["reaction"],"type":"object"},"SendReactionResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001"},"reaction":{"$ref":"#/components/schemas/ReactionResponse","x-stream-index":"002"}},"required":["message","reaction","duration"],"title":"Response","type":"object"},"SendUserCustomEventRequest":{"nullable":true,"properties":{"event":{"$ref":"#/components/schemas/UserCustomEventRequest","x-stream-index":"001"}},"required":["event"],"type":"object"},"SessionSettings":{"properties":{"inactivity_timeout_seconds":{"format":"int32","maximum":900,"minimum":5,"type":"integer","x-stream-index":"001"}},"required":["inactivity_timeout_seconds"],"type":"object"},"SharedLocation":{"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"013"},"channel_cid":{"type":"string","x-stream-index":"003"},"created_at":{"format":"date-time","type":"string","x-stream-index":"010"},"created_by_device_id":{"type":"string","x-stream-index":"008"},"end_at":{"format":"date-time","type":"string","x-stream-index":"009"},"latitude":{"format":"float","maximum":90,"minimum":18446744073709552000,"type":"number","x-stream-index":"006"},"longitude":{"format":"float","maximum":180,"minimum":18446744073709552000,"type":"number","x-stream-index":"007"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"012"},"message_id":{"type":"string","x-stream-index":"004"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"011"},"user_id":{"type":"string","x-stream-index":"005"}},"required":["channel_cid","message_id","user_id","created_by_device_id","created_at","updated_at"],"type":"object"},"SharedLocationResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001.011"},"channel_cid":{"description":"Channel CID","title":"string","type":"string","x-stream-index":"001.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.008"},"created_by_device_id":{"description":"Device ID that created the live location","title":"string","type":"string","x-stream-index":"001.006"},"duration":{"type":"string","x-stream-index":"002.001"},"end_at":{"description":"Time when the live location expires","format":"date-time","title":"string","type":"string","x-stream-index":"001.007"},"latitude":{"description":"Latitude coordinate","format":"float","title":"number","type":"number","x-stream-index":"001.004"},"longitude":{"description":"Longitude coordinate","format":"float","title":"number","type":"number","x-stream-index":"001.005"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001.010"},"message_id":{"description":"Message ID","title":"string","type":"string","x-stream-index":"001.002"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"001.009"},"user_id":{"description":"User ID","title":"string","type":"string","x-stream-index":"001.003"}},"required":["channel_cid","message_id","user_id","latitude","longitude","created_by_device_id","created_at","updated_at","duration"],"type":"object"},"SharedLocationResponseData":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"011"},"channel_cid":{"type":"string","x-stream-index":"001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"008"},"created_by_device_id":{"type":"string","x-stream-index":"006"},"end_at":{"format":"date-time","type":"string","x-stream-index":"007"},"latitude":{"format":"float","type":"number","x-stream-index":"004"},"longitude":{"format":"float","type":"number","x-stream-index":"005"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"010"},"message_id":{"type":"string","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"009"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["channel_cid","message_id","user_id","latitude","longitude","created_by_device_id","created_at","updated_at"],"type":"object"},"SharedLocationsResponse":{"nullable":true,"properties":{"active_live_locations":{"items":{"$ref":"#/components/schemas/SharedLocationResponseData"},"type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["active_live_locations","duration"],"type":"object"},"ShowChannelRequest":{"nullable":true,"properties":{"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"002.002"},"user_id":{"type":"string","x-stream-index":"002.001"}},"type":"object"},"ShowChannelResponse":{"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"},"SortParamRequest":{"nullable":true,"properties":{"direction":{"description":"Direction of sorting, 1 for Ascending, -1 for Descending, default is 1","format":"int32","title":"Direction","type":"integer","x-stream-index":"002"},"field":{"description":"Name of field to sort by","title":"Field","type":"string","x-stream-index":"001"}},"type":"object"},"StartCampaignRequest":{"nullable":true,"properties":{"scheduled_for":{"format":"date-time","type":"string","x-stream-index":"002"},"stop_at":{"format":"date-time","type":"string","x-stream-index":"003"}},"type":"object"},"StartCampaignResponse":{"description":"Basic response information","nullable":true,"properties":{"campaign":{"$ref":"#/components/schemas/CampaignResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"users":{"$ref":"#/components/schemas/PagerResponse","x-stream-index":"002"}},"required":["duration"],"title":"Response","type":"object"},"StopCampaignRequest":{"nullable":true,"type":"object"},"TargetResolution":{"properties":{"bitrate":{"format":"int32","maximum":6000000,"type":"integer","x-stream-index":"003"},"height":{"format":"int32","maximum":3840,"minimum":240,"type":"integer","x-stream-index":"002"},"width":{"format":"int32","maximum":3840,"minimum":240,"type":"integer","x-stream-index":"001"}},"required":["width","height","bitrate"],"type":"object"},"ThreadParticipant":{"description":"Represents a user that is participating in a thread.","nullable":true,"properties":{"app_pk":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"001"},"channel_cid":{"type":"string","x-stream-index":"002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"007"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"last_read_at":{"format":"date-time","type":"string","x-stream-index":"009"},"last_thread_message_at":{"format":"date-time","type":"string","x-stream-index":"003"},"left_thread_at":{"description":"Left Thread At is the time when the user left the thread","format":"date-time","title":"Left Thread At","type":"string","x-stream-index":"008"},"thread_id":{"description":"Thead ID is unique string identifier of the thread","title":"ID","type":"string","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User is the user object","title":"User","x-stream-index":"006"},"user_id":{"description":"User ID is unique string identifier of the user","title":"User ID","type":"string","x-stream-index":"005"}},"required":["app_pk","channel_cid","created_at","last_read_at","custom"],"title":"ThreadParticipant","type":"object"},"ThreadResponse":{"properties":{"active_participant_count":{"description":"Active Participant Count","format":"int32","title":"Active Participant Count","type":"integer","x-stream-index":"009"},"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel","title":"ChannelResponse","x-stream-index":"002"},"channel_cid":{"description":"Channel CID","title":"Channel CID","type":"string","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"012"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"Created By User","title":"User","x-stream-index":"006"},"created_by_user_id":{"description":"Created By User ID","title":"Created By User ID","type":"string","x-stream-index":"005"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"016"},"deleted_at":{"description":"Deleted At","format":"date-time","title":"Deleted At","type":"string","x-stream-index":"014"},"last_message_at":{"description":"Last Message At","format":"date-time","title":"Last Message At","type":"string","x-stream-index":"011"},"parent_message":{"$ref":"#/components/schemas/MessageResponse","description":"Parent Message","title":"Message","x-stream-index":"004"},"parent_message_id":{"description":"Parent Message ID","title":"Parent Message ID","type":"string","x-stream-index":"003"},"participant_count":{"description":"Participant Count","format":"int32","title":"Participant Count","type":"integer","x-stream-index":"008"},"reply_count":{"description":"Reply Count","format":"int32","title":"Reply Count","type":"integer","x-stream-index":"007"},"thread_participants":{"description":"Thread Participants","items":{"$ref":"#/components/schemas/ThreadParticipant"},"title":"ThreadParticipants","type":"array","x-stream-index":"010"},"title":{"description":"Title","title":"Title","type":"string","x-stream-index":"015"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"013"}},"required":["channel_cid","parent_message_id","created_by_user_id","created_at","updated_at","title","custom"],"type":"object"},"ThreadStateResponse":{"nullable":true,"properties":{"active_participant_count":{"description":"Active Participant Count","format":"int32","title":"Active Participant Count","type":"integer","x-stream-index":"001.009"},"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel","title":"ChannelResponse","x-stream-index":"001.002"},"channel_cid":{"description":"Channel CID","title":"Channel CID","type":"string","x-stream-index":"001.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.012"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"Created By User","title":"User","x-stream-index":"001.006"},"created_by_user_id":{"description":"Created By User ID","title":"Created By User ID","type":"string","x-stream-index":"001.005"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"001.016"},"deleted_at":{"description":"Deleted At","format":"date-time","title":"Deleted At","type":"string","x-stream-index":"001.014"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"004"},"last_message_at":{"description":"Last Message At","format":"date-time","title":"Last Message At","type":"string","x-stream-index":"001.011"},"latest_replies":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","x-stream-index":"002"},"parent_message":{"$ref":"#/components/schemas/MessageResponse","description":"Parent Message","title":"Message","x-stream-index":"001.004"},"parent_message_id":{"description":"Parent Message ID","title":"Parent Message ID","type":"string","x-stream-index":"001.003"},"participant_count":{"description":"Participant Count","format":"int32","title":"Participant Count","type":"integer","x-stream-index":"001.008"},"read":{"items":{"$ref":"#/components/schemas/ReadStateResponse"},"type":"array","x-stream-index":"003"},"reply_count":{"description":"Reply Count","format":"int32","title":"Reply Count","type":"integer","x-stream-index":"001.007"},"thread_participants":{"description":"Thread Participants","items":{"$ref":"#/components/schemas/ThreadParticipant"},"title":"ThreadParticipants","type":"array","x-stream-index":"001.010"},"title":{"description":"Title","title":"Title","type":"string","x-stream-index":"001.015"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"001.013"}},"required":["channel_cid","parent_message_id","created_by_user_id","created_at","updated_at","title","custom","latest_replies"],"type":"object"},"ThreadUpdatedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"001.002"},"channel_type":{"type":"string","x-stream-index":"001.003"},"cid":{"type":"string","x-stream-index":"001.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"004.002"},"thread":{"$ref":"#/components/schemas/ThreadResponse","x-stream-index":"003.001"},"type":{"default":"thread.updated","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"ThreadUpdatedEvent","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"},"Thresholds":{"description":"Sets thresholds for AI moderation","properties":{"explicit":{"$ref":"#/components/schemas/LabelThresholds","description":"Thresholds for explicit messages","title":"LabelThresholds","x-stream-index":"001"},"spam":{"$ref":"#/components/schemas/LabelThresholds","description":"Thresholds for spam","title":"LabelThresholds","x-stream-index":"002"},"toxic":{"$ref":"#/components/schemas/LabelThresholds","description":"Thresholds for toxic messages","title":"LabelThresholds","x-stream-index":"003"}},"title":"Auto moderation thresholds","type":"object"},"ThumbnailsSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"TranscriptionSettings":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"title":"Mode","type":"string","x-stream-index":"002"},"language":{"description":"The language used in this call as a two letter code","enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"title":"Language","type":"string","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"title":"Mode","type":"string","x-stream-index":"001"}},"required":["mode","closed_caption_mode","languages","language"],"type":"object"},"TranslateMessageRequest":{"nullable":true,"properties":{"language":{"description":"Language to translate message to","enum":["af","sq","am","ar","az","bn","bs","bg","zh","zh-TW","hr","cs","da","fa-AF","nl","en","et","fi","fr","fr-CA","ka","de","el","ha","he","hi","hu","id","it","ja","ko","lv","ms","no","fa","ps","pl","pt","ro","ru","sr","sk","sl","so","es","es-MX","sw","sv","tl","ta","th","tr","uk","ur","vi","lt","ht"],"title":"Language","type":"string","x-stream-index":"001"}},"required":["language"],"type":"object"},"TruncateChannelRequest":{"nullable":true,"properties":{"hard_delete":{"description":"Permanently delete channel data (messages, reactions, etc.)","title":"Hard delete","type":"boolean","x-stream-index":"002"},"member_ids":{"description":"List of member IDs to hide message history for. If empty, truncates the channel for all members","items":{"type":"string"},"maximum":100,"title":"Member IDs","type":"array","x-stream-index":"007"},"message":{"$ref":"#/components/schemas/MessageRequest","x-stream-index":"004"},"skip_push":{"description":"When `message` is set disables all push notifications for it","title":"Skip push","type":"boolean","x-stream-index":"005"},"truncated_at":{"description":"Truncate channel data up to `truncated_at`. The system message (if provided) creation time is always greater than `truncated_at`","format":"date-time","title":"Truncated at","type":"string","x-stream-index":"006"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"008.002"},"user_id":{"type":"string","x-stream-index":"008.001"}},"type":"object"},"TruncateChannelResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Truncated channel object","title":"Channel","x-stream-index":"002"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Truncated message object","title":"Message","x-stream-index":"003"}},"required":["duration"],"type":"object"},"TypingIndicators":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"TypingIndicatorsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"UnblockUsersRequest":{"nullable":true,"properties":{"blocked_user_id":{"type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"required":["blocked_user_id"],"type":"object"},"UnblockUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"UnmuteChannelRequest":{"nullable":true,"properties":{"channel_cids":{"description":"Channel CIDs to mute (if multiple channels)","items":{"type":"string"},"maximum":25,"title":"Channel CIDs","type":"array","x-stream-index":"001.002"},"expiration":{"description":"Duration of mute in milliseconds","title":"Expiration","type":"integer","x-stream-index":"001.003"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"002.002"},"user_id":{"type":"string","x-stream-index":"002.001"}},"type":"object"},"UnmuteResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"non_existing_users":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"required":["duration"],"title":"Response","type":"object"},"UnmuteUserRequest":{"nullable":true,"properties":{"target_ids":{"description":"User IDs to mute (if multiple users)","items":{"type":"string"},"maximum":1000,"title":"Target IDs","type":"array","x-stream-index":"001.002"},"timeout":{"description":"Duration of mute in minutes","minimum":0,"title":"Timeout","type":"integer","x-stream-index":"001.003"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"002.002"},"user_id":{"type":"string","x-stream-index":"002.001"}},"required":["timeout"],"type":"object"},"UnreadCountsBatchRequest":{"nullable":true,"properties":{"user_ids":{"items":{"type":"string"},"maximum":100,"type":"array","x-stream-index":"001"}},"required":["user_ids"],"type":"object"},"UnreadCountsBatchResponse":{"description":"Basic response information","nullable":true,"properties":{"counts_by_user":{"additionalProperties":{"$ref":"#/components/schemas/UnreadCountsResponse"},"type":"object","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["counts_by_user","duration"],"title":"Response","type":"object"},"UnreadCountsChannel":{"properties":{"channel_id":{"type":"string","x-stream-index":"001"},"last_read":{"format":"date-time","type":"string","x-stream-index":"003"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["channel_id","unread_count","last_read"],"type":"object"},"UnreadCountsChannelType":{"properties":{"channel_count":{"format":"int32","type":"integer","x-stream-index":"002"},"channel_type":{"type":"string","x-stream-index":"001"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["channel_type","channel_count","unread_count"],"type":"object"},"UnreadCountsResponse":{"nullable":true,"properties":{"channel_type":{"items":{"$ref":"#/components/schemas/UnreadCountsChannelType"},"type":"array","x-stream-index":"005"},"channels":{"items":{"$ref":"#/components/schemas/UnreadCountsChannel"},"type":"array","x-stream-index":"004"},"threads":{"items":{"$ref":"#/components/schemas/UnreadCountsThread"},"type":"array","x-stream-index":"006"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"001"},"total_unread_count_by_team":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"003"},"total_unread_threads_count":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["total_unread_count","total_unread_threads_count","channels","channel_type","threads"],"type":"object"},"UnreadCountsThread":{"properties":{"last_read":{"format":"date-time","type":"string","x-stream-index":"002"},"last_read_message_id":{"type":"string","x-stream-index":"003"},"parent_message_id":{"type":"string","x-stream-index":"004"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"001"}},"required":["unread_count","last_read","last_read_message_id","parent_message_id"],"type":"object"},"UpdateAppRequest":{"nullable":true,"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.017"},"apn_config":{"$ref":"#/components/schemas/APNConfig","x-stream-index":"001.003"},"async_moderation_config":{"$ref":"#/components/schemas/AsyncModerationConfiguration","x-stream-index":"001.039"},"async_url_enrich_enabled":{"type":"boolean","x-stream-index":"001.019"},"auto_translation_enabled":{"type":"boolean","x-stream-index":"001.018"},"before_message_send_hook_url":{"type":"string","x-stream-index":"001.020"},"cdn_expiration_seconds":{"format":"int32","maximum":1209600,"minimum":14400,"type":"integer","x-stream-index":"001.038"},"channel_hide_members_only":{"type":"boolean","x-stream-index":"001.033"},"custom_action_handler_url":{"type":"string","x-stream-index":"001.021"},"datadog_info":{"$ref":"#/components/schemas/DataDogInfo","x-stream-index":"001.040"},"disable_auth_checks":{"type":"boolean","x-stream-index":"001.001"},"disable_permissions_checks":{"type":"boolean","x-stream-index":"001.002"},"enforce_unique_usernames":{"enum":["no","app","team"],"type":"string","x-stream-index":"001.022"},"event_hooks":{"items":{"$ref":"#/components/schemas/EventHook"},"type":"array","x-stream-index":"001.046"},"feeds_moderation_enabled":{"type":"boolean","x-stream-index":"001.042"},"feeds_v2_region":{"type":"string","x-stream-index":"001.041"},"file_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","x-stream-index":"001.030"},"firebase_config":{"$ref":"#/components/schemas/FirebaseConfig","x-stream-index":"001.004"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"001.034"},"guest_user_creation_disabled":{"type":"boolean","x-stream-index":"001.043"},"huawei_config":{"$ref":"#/components/schemas/HuaweiConfig","x-stream-index":"001.005"},"image_moderation_block_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001.015"},"image_moderation_enabled":{"type":"boolean","x-stream-index":"001.016"},"image_moderation_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001.014"},"image_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","x-stream-index":"001.029"},"migrate_permissions_to_v2":{"type":"boolean","x-stream-index":"001.035"},"moderation_dashboard_preferences":{"$ref":"#/components/schemas/ModerationDashboardPreferences","x-stream-index":"001.044"},"moderation_enabled":{"type":"boolean","x-stream-index":"001.009"},"moderation_webhook_url":{"type":"string","x-stream-index":"001.010"},"multi_tenant_enabled":{"type":"boolean","x-stream-index":"001.013"},"permission_version":{"enum":["v1","v2"],"type":"string","x-stream-index":"001.011"},"push_config":{"$ref":"#/components/schemas/PushConfig","x-stream-index":"001.007"},"reminders_interval":{"format":"int32","maximum":86400,"minimum":60,"type":"integer","x-stream-index":"001.036"},"reminders_max_members":{"format":"int32","minimum":2,"type":"integer","x-stream-index":"001.037"},"revoke_tokens_issued_before":{"format":"date-time","type":"string","x-stream-index":"001.031"},"sns_key":{"type":"string","x-stream-index":"001.027"},"sns_secret":{"type":"string","x-stream-index":"001.028"},"sns_topic_arn":{"type":"string","x-stream-index":"001.026"},"sqs_key":{"type":"string","x-stream-index":"001.024"},"sqs_secret":{"type":"string","x-stream-index":"001.025"},"sqs_url":{"type":"string","x-stream-index":"001.023"},"user_response_time_enabled":{"type":"boolean","x-stream-index":"001.048"},"user_search_disallowed_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"001.012"},"webhook_events":{"items":{"type":"string"},"type":"array","x-stream-index":"001.032"},"webhook_url":{"type":"string","x-stream-index":"001.008"},"xiaomi_config":{"$ref":"#/components/schemas/XiaomiConfig","x-stream-index":"001.006"}},"type":"object"},"UpdateBlockListRequest":{"nullable":true,"properties":{"team":{"type":"string","x-stream-index":"002"},"words":{"description":"List of words to block","items":{"type":"string"},"minimum":1,"title":"Words","type":"array","x-stream-index":"003"}},"title":"Update block list","type":"object","x-stream-docs-page-id":"update_block_list"},"UpdateBlockListResponse":{"description":"Basic response information","nullable":true,"properties":{"blocklist":{"$ref":"#/components/schemas/BlockListResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["duration"],"title":"Response","type":"object"},"UpdateChannelPartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"type":"object","x-stream-index":"002.001"},"unset":{"items":{"type":"string"},"type":"array","x-stream-index":"002.002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"title":"UpdateChannelPartialRequest","type":"object"},"UpdateChannelPartialResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Updated channel object","title":"Channel","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"members":{"description":"List of updated members","items":{"$ref":"#/components/schemas/ChannelMemberResponse"},"title":"ChannelMemberResponse","type":"array","x-stream-index":"002"}},"required":["members","duration"],"type":"object"},"UpdateChannelRequest":{"nullable":true,"properties":{"accept_invite":{"description":"Set to `true` to accept the invite","title":"Accept invite","type":"boolean","x-stream-index":"008"},"add_members":{"description":"List of user IDs to add to the channel","items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"title":"Add members","type":"array","x-stream-index":"001"},"add_moderators":{"description":"List of user IDs to make channel moderators","items":{"type":"string"},"maximum":100,"title":"Add moderators","type":"array","x-stream-index":"003"},"assign_roles":{"description":"List of channel member role assignments. If any specified user is not part of the channel, the request will fail","items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"title":"Assign roles","type":"array","x-stream-index":"006"},"cooldown":{"description":"Sets cool down period for the channel in seconds","format":"int32","maximum":120,"minimum":0,"title":"Cool down","type":"integer","x-stream-index":"007"},"data":{"$ref":"#/components/schemas/ChannelInput","x-stream-index":"013.001"},"demote_moderators":{"description":"List of user IDs to take away moderators status from","items":{"type":"string"},"maximum":100,"title":"Demote moderators","type":"array","x-stream-index":"004"},"hide_history":{"description":"Set to `true` to hide channel's history when adding new members","title":"Hide history","type":"boolean","x-stream-index":"012"},"invites":{"description":"List of user IDs to invite to the channel","items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"title":"Invites","type":"array","x-stream-index":"005"},"message":{"$ref":"#/components/schemas/MessageRequest","description":"Message to send to the chat when channel is successfully updated","title":"Message","x-stream-index":"010"},"reject_invite":{"description":"Set to `true` to reject the invite","title":"Reject invite","type":"boolean","x-stream-index":"009"},"remove_members":{"description":"List of user IDs to remove from the channel","items":{"type":"string"},"maximum":100,"title":"Remove members","type":"array","x-stream-index":"002"},"skip_push":{"description":"When `message` is set disables all push notifications for it","title":"Skip push","type":"boolean","x-stream-index":"011"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"014.002"},"user_id":{"type":"string","x-stream-index":"014.001"}},"title":"Channel update request","type":"object","x-stream-docs-page-id":"channel_update"},"UpdateChannelResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Updated channel","title":"Channel","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"004.001"},"members":{"description":"List of channel members","items":{"$ref":"#/components/schemas/ChannelMember"},"title":"Members","type":"array","x-stream-index":"003"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Message sent to the chat","title":"Message","x-stream-index":"002"}},"required":["members","duration"],"type":"object"},"UpdateChannelTypeRequest":{"nullable":true,"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"009.001.026"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"009.001.021"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"009.001.022"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"009.001.027"},"blocklist":{"type":"string","x-stream-index":"009.001.023"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"009.001.024"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"009.001.025"},"commands":{"description":"List of commands that channel supports","items":{"type":"string"},"title":"Commands","type":"array","x-stream-index":"009.003"},"connect_events":{"type":"boolean","x-stream-index":"009.001.004"},"custom_events":{"type":"boolean","x-stream-index":"009.001.012"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"004"},"mark_messages_pending":{"type":"boolean","x-stream-index":"009.001.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"009.001.020"},"mutes":{"type":"boolean","x-stream-index":"009.001.009"},"partition_size":{"format":"int32","minimum":0,"type":"integer","x-stream-index":"007"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"008"},"permissions":{"items":{"$ref":"#/components/schemas/PolicyRequest"},"type":"array","x-stream-index":"003"},"polls":{"type":"boolean","x-stream-index":"009.001.016"},"push_notifications":{"type":"boolean","x-stream-index":"009.001.013"},"quotes":{"type":"boolean","x-stream-index":"009.001.008"},"reactions":{"type":"boolean","x-stream-index":"009.001.006"},"read_events":{"type":"boolean","x-stream-index":"009.001.003"},"reminders":{"type":"boolean","x-stream-index":"009.001.014"},"replies":{"type":"boolean","x-stream-index":"009.001.007"},"search":{"type":"boolean","x-stream-index":"009.001.005"},"shared_locations":{"type":"boolean","x-stream-index":"009.001.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"009.001.030"},"typing_events":{"type":"boolean","x-stream-index":"009.001.002"},"uploads":{"type":"boolean","x-stream-index":"009.001.010"},"url_enrichment":{"type":"boolean","x-stream-index":"009.001.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"009.001.017"}},"required":["max_message_length","automod","automod_behavior"],"type":"object"},"UpdateChannelTypeResponse":{"nullable":true,"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"003.001.026"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"003.001.021"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.001.022"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"003.001.027"},"blocklist":{"type":"string","x-stream-index":"003.001.023"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.001.024"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"003.001.025"},"commands":{"items":{"type":"string"},"type":"array","x-stream-index":"003.003"},"connect_events":{"type":"boolean","x-stream-index":"003.001.004"},"created_at":{"format":"date-time","type":"string","x-stream-index":"003.002.003"},"custom_events":{"type":"boolean","x-stream-index":"003.001.012"},"duration":{"type":"string","x-stream-index":"004.001"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"002"},"mark_messages_pending":{"type":"boolean","x-stream-index":"003.001.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"003.001.020"},"mutes":{"type":"boolean","x-stream-index":"003.001.009"},"name":{"type":"string","x-stream-index":"003.001.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"003.001.028"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"003.001.029"},"permissions":{"items":{"$ref":"#/components/schemas/PolicyRequest"},"type":"array","x-stream-index":"001"},"polls":{"type":"boolean","x-stream-index":"003.001.016"},"push_notifications":{"type":"boolean","x-stream-index":"003.001.013"},"quotes":{"type":"boolean","x-stream-index":"003.001.008"},"reactions":{"type":"boolean","x-stream-index":"003.001.006"},"read_events":{"type":"boolean","x-stream-index":"003.001.003"},"reminders":{"type":"boolean","x-stream-index":"003.001.014"},"replies":{"type":"boolean","x-stream-index":"003.001.007"},"search":{"type":"boolean","x-stream-index":"003.001.005"},"shared_locations":{"type":"boolean","x-stream-index":"003.001.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"003.001.030"},"typing_events":{"type":"boolean","x-stream-index":"003.001.002"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"003.002.004"},"uploads":{"type":"boolean","x-stream-index":"003.001.010"},"url_enrichment":{"type":"boolean","x-stream-index":"003.001.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"003.001.017"}},"required":["permissions","grants","name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","created_at","updated_at","commands","duration"],"type":"object"},"UpdateCommandRequest":{"nullable":true,"properties":{"args":{"description":"Arguments help text, shown in commands auto-completion","maxLength":255,"title":"Arguments","type":"string","x-stream-index":"003"},"description":{"description":"Description, shown in commands auto-completion","maxLength":255,"title":"Description","type":"string","x-stream-index":"002"},"set":{"description":"Set name used for grouping commands","maxLength":255,"title":"Set","type":"string","x-stream-index":"004"}},"required":["description"],"title":"UpdateCommandRequest","type":"object"},"UpdateCommandResponse":{"nullable":true,"properties":{"command":{"$ref":"#/components/schemas/Command","description":"Command object","title":"Command","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["duration"],"title":"UpdateCommandResponse","type":"object"},"UpdateExternalStorageRequest":{"description":"External storage","nullable":true,"properties":{"aws_s3":{"$ref":"#/components/schemas/S3Request","description":"Only required if you want to create an Amazon S3 storage","title":"AwsS3","x-stream-index":"003.004"},"azure_blob":{"$ref":"#/components/schemas/AzureRequest","description":"Only required if you want to create an Azure Blob Storage","title":"AzureBlob","x-stream-index":"003.006"},"bucket":{"description":"The name of the bucket on the service provider","title":"Bucket","type":"string","x-stream-index":"003.002"},"gcs_credentials":{"type":"string","x-stream-index":"003.005"},"path":{"description":"The path prefix to use for storing files","title":"Path","type":"string","x-stream-index":"003.003"},"storage_type":{"description":"The type of storage to use","enum":["s3","gcs","abs"],"title":"StorageType","type":"string","x-stream-index":"003.001"}},"required":["storage_type","bucket"],"title":"ExternalStorageRequest","type":"object"},"UpdateExternalStorageResponse":{"description":"Basic response information","nullable":true,"properties":{"bucket":{"type":"string","x-stream-index":"001.003"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"name":{"type":"string","x-stream-index":"001.001"},"path":{"type":"string","x-stream-index":"001.004"},"type":{"enum":["s3","gcs","abs"],"type":"string","x-stream-index":"001.002"}},"required":["name","type","bucket","path","duration"],"title":"Response","type":"object"},"UpdateLiveLocationRequest":{"nullable":true,"properties":{"end_at":{"description":"Time when the live location expires","format":"date-time","title":"string","type":"string","x-stream-index":"004"},"latitude":{"description":"Latitude coordinate","format":"float","maximum":90,"minimum":18446744073709552000,"title":"number","type":"number","x-stream-index":"002"},"longitude":{"description":"Longitude coordinate","format":"float","maximum":180,"minimum":18446744073709552000,"title":"number","type":"number","x-stream-index":"003"},"message_id":{"description":"Live location ID","title":"string","type":"string","x-stream-index":"001"}},"required":["message_id"],"type":"object"},"UpdateMemberPartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"type":"object","x-stream-index":"002.001"},"unset":{"items":{"type":"string"},"type":"array","x-stream-index":"002.002"}},"type":"object"},"UpdateMemberPartialResponse":{"nullable":true,"properties":{"channel_member":{"$ref":"#/components/schemas/ChannelMemberResponse","description":"Updated channel member","title":"Channel member","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["duration"],"type":"object"},"UpdateMessagePartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"description":"Sets new field values","title":"Set","type":"object","x-stream-index":"002.001","x-stream-map":{"key":"field","title":"Value","description":"New value to set"}},"skip_enrich_url":{"description":"Skip enriching the URL in the message","title":"SkipEnrichURL","type":"boolean","x-stream-index":"001"},"unset":{"description":"Array of field names to unset","items":{"type":"string"},"title":"Unset","type":"array","x-stream-index":"002.002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"type":"object"},"UpdateMessagePartialResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Updated message","title":"Message","x-stream-index":"001"},"pending_message_metadata":{"additionalProperties":{"type":"string"},"description":"Pending message metadata","title":"PendingMessageMetadata","type":"object","x-stream-index":"002"}},"required":["duration"],"type":"object"},"UpdateMessageRequest":{"nullable":true,"properties":{"message":{"$ref":"#/components/schemas/MessageRequest","description":"Message","title":"MessageRequest","x-stream-index":"001"},"skip_enrich_url":{"description":"Skip enrich URL","title":"boolean","type":"boolean","x-stream-index":"003"},"skip_push":{"type":"boolean","x-stream-index":"002"}},"required":["message"],"type":"object"},"UpdateMessageResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001"},"pending_message_metadata":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"002"}},"required":["message","duration"],"title":"Response","type":"object"},"UpdatePollOptionRequest":{"nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"004"},"id":{"description":"Option ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"},"text":{"description":"Option text","title":"string","type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"005.002"},"user_id":{"type":"string","x-stream-index":"005.001"}},"required":["id","text"],"type":"object"},"UpdatePollPartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"description":"Sets new field values","title":"Set","type":"object","x-stream-index":"002.001","x-stream-map":{"key":"field","title":"Value","description":"New value to set"}},"unset":{"description":"Array of field names to unset","items":{"type":"string"},"title":"Unset","type":"array","x-stream-index":"002.002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"type":"object"},"UpdatePollRequest":{"nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"011"},"allow_answers":{"description":"Allow answers","title":"boolean","type":"boolean","x-stream-index":"009"},"allow_user_suggested_options":{"description":"Allow user suggested options","title":"boolean","type":"boolean","x-stream-index":"008"},"description":{"description":"Poll description","title":"string","type":"string","x-stream-index":"003"},"enforce_unique_vote":{"description":"Enforce unique vote","title":"boolean","type":"boolean","x-stream-index":"005"},"id":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"},"is_closed":{"description":"Is closed","title":"boolean","type":"boolean","x-stream-index":"010"},"max_votes_allowed":{"description":"Max votes allowed","format":"int32","maximum":10,"title":"integer","type":"integer","x-stream-index":"007"},"name":{"description":"Poll name","title":"string","type":"string","x-stream-index":"002"},"options":{"description":"Poll options","items":{"$ref":"#/components/schemas/PollOptionRequest"},"maximum":100,"title":"PollOptions","type":"array","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"012.002"},"user_id":{"type":"string","x-stream-index":"012.001"},"voting_visibility":{"description":"Voting visibility","enum":["anonymous","public"],"title":"string","type":"string","x-stream-index":"006"}},"required":["id","name"],"type":"object"},"UpdateReminderRequest":{"nullable":true,"properties":{"remind_at":{"format":"date-time","type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"type":"object"},"UpdateReminderResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"001"}},"required":["reminder","duration"],"title":"Response","type":"object"},"UpdateThreadPartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"description":"Sets new field values","title":"Set","type":"object","x-stream-index":"004.001","x-stream-map":{"key":"field","title":"Value","description":"New value to set"}},"unset":{"description":"Array of field names to unset","items":{"type":"string"},"title":"Unset","type":"array","x-stream-index":"004.002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"type":"object"},"UpdateThreadPartialResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"thread":{"$ref":"#/components/schemas/ThreadResponse","description":"Updated thread (not enriched)","title":"Thread","x-stream-index":"001"}},"required":["thread","duration"],"type":"object"},"UpdateUserPartialRequest":{"properties":{"id":{"description":"User ID to update","title":"ID","type":"string","x-stream-index":"001"},"set":{"additionalProperties":{},"type":"object","x-stream-index":"002.001"},"unset":{"items":{"type":"string"},"type":"array","x-stream-index":"002.002"}},"required":["id"],"type":"object"},"UpdateUsersPartialRequest":{"nullable":true,"properties":{"users":{"items":{"$ref":"#/components/schemas/UpdateUserPartialRequest"},"maximum":100,"type":"array","x-stream-index":"001"}},"required":["users"],"type":"object"},"UpdateUsersRequest":{"nullable":true,"properties":{"users":{"additionalProperties":{"$ref":"#/components/schemas/UserRequest"},"description":"Object containing users","title":"Users","type":"object","x-stream-index":"001","x-stream-map":{"key":"user_id"}}},"required":["users"],"type":"object"},"UpdateUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"membership_deletion_task_id":{"type":"string","x-stream-index":"002"},"users":{"additionalProperties":{"$ref":"#/components/schemas/FullUserResponse"},"description":"Object containing users","title":"Users","type":"object","x-stream-index":"001","x-stream-map":{"key":"user_id"}}},"required":["users","membership_deletion_task_id","duration"],"type":"object"},"UpsertPushPreferencesRequest":{"nullable":true,"properties":{"preferences":{"description":"A list of push preferences for channels, calls, or the user.","items":{"$ref":"#/components/schemas/PushPreferenceInput"},"type":"array","x-stream-index":"001"}},"required":["preferences"],"type":"object"},"UpsertPushPreferencesResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"user_channel_preferences":{"additionalProperties":{"additionalProperties":{"$ref":"#/components/schemas/ChannelPushPreferences"},"type":"object"},"description":"The channel specific push notification preferences, only returned for channels you've edited.","title":"User Channel Notification Preferences","type":"object","x-stream-index":"002"},"user_preferences":{"additionalProperties":{"$ref":"#/components/schemas/PushPreferences"},"description":"The user preferences, always returned regardless if you edited it","title":"User Preferences","type":"object","x-stream-index":"001"}},"required":["user_preferences","user_channel_preferences","duration"],"type":"object"},"UpsertPushProviderRequest":{"nullable":true,"properties":{"push_provider":{"$ref":"#/components/schemas/PushProvider","x-stream-index":"001"}},"type":"object"},"UpsertPushProviderResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"push_provider":{"$ref":"#/components/schemas/PushProviderResponse","x-stream-index":"001"}},"required":["push_provider","duration"],"title":"Response","type":"object"},"UpsertPushTemplateRequest":{"nullable":true,"properties":{"enable_push":{"description":"Whether to send push notification for this event","title":"boolean","type":"boolean","x-stream-index":"002"},"event_type":{"description":"Event type (message.new, message.updated, reaction.new)","enum":["message.new","message.updated","reaction.new","notification.reminder_due"],"title":"string","type":"string","x-stream-index":"003"},"push_provider_name":{"description":"Push provider name","title":"string","type":"string","x-stream-index":"004"},"push_provider_type":{"description":"Push provider type (firebase, apn)","enum":["firebase","apn"],"title":"string","type":"string","x-stream-index":"005"},"template":{"description":"Push template","title":"string","type":"string","x-stream-index":"006"}},"required":["event_type","push_provider_type"],"type":"object"},"UpsertPushTemplateResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"template":{"$ref":"#/components/schemas/PushTemplate","x-stream-index":"002"}},"required":["duration"],"title":"Response","type":"object"},"User":{"properties":{"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"046"},"ban_expires":{"format":"date-time","type":"string","x-stream-index":"017"},"banned":{"type":"boolean","x-stream-index":"016"},"created_at":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"013"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"023"},"language":{"type":"string","x-stream-index":"035"},"last_active":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"026"},"revoke_tokens_issued_before":{"format":"date-time","type":"string","x-stream-index":"042"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"005"},"updated_at":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"009"}},"required":["id","role","teams_role","custom","banned","online"],"type":"object"},"UserBannedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"006.002"},"channel_type":{"type":"string","x-stream-index":"006.003"},"cid":{"type":"string","x-stream-index":"006.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"008.002"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"001"},"expiration":{"format":"date-time","type":"string","x-stream-index":"003"},"reason":{"type":"string","x-stream-index":"004"},"shadow":{"type":"boolean","x-stream-index":"002"},"team":{"type":"string","x-stream-index":"005.001"},"type":{"default":"user.banned","type":"string","x-stream-index":"008.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007.001"}},"required":["created_by","shadow","cid","channel_id","channel_type","type","created_at"],"title":"UserBannedEvent","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"},"UserCustomEventRequest":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"001"}},"required":["type"],"type":"object"},"UserDeactivatedEvent":{"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"003.002"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"001"},"type":{"default":"user.deactivated","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["created_by","type","created_at"],"title":"UserDeactivatedEvent","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"},"UserDeletedEvent":{"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"002.002"},"delete_conversation_channels":{"type":"boolean","x-stream-index":"005"},"hard_delete":{"type":"boolean","x-stream-index":"003.001"},"mark_messages_deleted":{"type":"boolean","x-stream-index":"004"},"type":{"default":"user.deleted","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"001.001"}},"required":["type","created_at","hard_delete","mark_messages_deleted","delete_conversation_channels"],"title":"UserDeletedEvent","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"},"UserFlaggedEvent":{"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"004.002"},"target_user":{"type":"string","x-stream-index":"002"},"target_users":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"type":{"default":"user.flagged","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"001"}},"required":["type","created_at"],"title":"UserFlaggedEvent","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"},"UserMute":{"nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"009"},"expires":{"description":"Date/time of mute expiration","format":"date-time","title":"Expires","type":"string","x-stream-index":"008"},"target":{"$ref":"#/components/schemas/User","description":"User who's muted","title":"Target","x-stream-index":"007"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/User","description":"Owner of channel mute","title":"User","x-stream-index":"005"}},"required":["created_at","updated_at"],"type":"object"},"UserMuteResponse":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"004"},"expires":{"format":"date-time","type":"string","x-stream-index":"003"},"target":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"}},"required":["created_at","updated_at"],"type":"object"},"UserMutedEvent":{"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"004.002"},"target_user":{"type":"string","x-stream-index":"001"},"target_users":{"items":{"type":"string"},"type":"array","x-stream-index":"002"},"type":{"default":"user.muted","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"UserMutedEvent","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"},"UserReactivatedEvent":{"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"002.002"},"type":{"default":"user.reactivated","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"001"}},"required":["type","created_at"],"title":"UserReactivatedEvent","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"},"UserRequest":{"description":"User request object","properties":{"custom":{"additionalProperties":{},"description":"Custom user data","title":"Custom","type":"object","x-stream-index":"004"},"id":{"description":"User ID","title":"ID","type":"string","x-stream-index":"001"},"image":{"description":"User's profile image URL","title":"Image","type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"006"},"language":{"type":"string","x-stream-index":"005"},"name":{"description":"Optional name of user","title":"Name","type":"string","x-stream-index":"002"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"007"},"role":{"description":"User's global role","title":"Role","type":"string","x-stream-index":"008"},"teams":{"description":"List of teams the user belongs to","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"010"},"teams_role":{"additionalProperties":{"type":"string"},"description":"Map of team-specific roles for the user","title":"TeamsRole","type":"object","x-stream-index":"009"}},"required":["id"],"title":"UserRequest","type":"object"},"UserResponse":{"description":"User response object","properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"ban_expires":{"description":"Date when ban expires","format":"date-time","title":"Ban expires","type":"string","x-stream-index":"003"},"banned":{"description":"Whether a user is banned or not","title":"Banned","type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.017"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"001.004"},"deactivated_at":{"description":"Date of deactivation","format":"date-time","title":"Deactivated at","type":"string","x-stream-index":"001.016"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"string","x-stream-index":"001.011"},"devices":{"description":"List of devices user is using","items":{"$ref":"#/components/schemas/DeviceResponse"},"title":"Devices","type":"array","x-stream-index":"006"},"id":{"description":"Unique user identifier","title":"ID","type":"string","x-stream-index":"001.001"},"image":{"title":"Image","type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"007"},"language":{"description":"Preferred language of a user","title":"Language","type":"string","x-stream-index":"001.005"},"last_active":{"description":"Date of last activity","format":"date-time","title":"Last active","type":"string","x-stream-index":"001.014"},"name":{"description":"Optional name of user","title":"Name","type":"string","x-stream-index":"001.002"},"online":{"description":"Whether a user online or not","title":"Online","type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","description":"User privacy settings","title":"Privacy settings","x-stream-index":"005"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettingsResponse","description":"User push notification settings","title":"Push notifications","x-stream-index":"004"},"revoke_tokens_issued_before":{"description":"Revocation date for tokens","format":"date-time","title":"Revoke tokens issued before","type":"string","x-stream-index":"001.015"},"role":{"description":"Determines the set of user permissions","title":"Role","type":"string","x-stream-index":"001.006"},"shadow_banned":{"description":"Whether a user is shadow banned","title":"Shadow banned","type":"boolean","x-stream-index":"002"},"teams":{"description":"List of teams user is a part of","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids","shadow_banned","invisible"],"title":"UserResponse","type":"object"},"UserResponseCommonFields":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"018"},"banned":{"type":"boolean","x-stream-index":"012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"017"},"created_at":{"format":"date-time","type":"string","x-stream-index":"009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"deactivated_at":{"format":"date-time","type":"string","x-stream-index":"016"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"011"},"id":{"type":"string","x-stream-index":"001"},"image":{"type":"string","x-stream-index":"003"},"language":{"type":"string","x-stream-index":"005"},"last_active":{"format":"date-time","type":"string","x-stream-index":"014"},"name":{"type":"string","x-stream-index":"002"},"online":{"type":"boolean","x-stream-index":"013"},"revoke_tokens_issued_before":{"format":"date-time","type":"string","x-stream-index":"015"},"role":{"type":"string","x-stream-index":"006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"008"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids"],"type":"object"},"UserResponsePrivacyFields":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"banned":{"type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.017"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"string","x-stream-index":"001.016"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"001.011"},"id":{"type":"string","x-stream-index":"001.001"},"image":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"003"},"language":{"type":"string","x-stream-index":"001.005"},"last_active":{"format":"date-time","type":"string","x-stream-index":"001.014"},"name":{"type":"string","x-stream-index":"001.002"},"online":{"type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"002"},"revoke_tokens_issued_before":{"format":"date-time","type":"string","x-stream-index":"001.015"},"role":{"type":"string","x-stream-index":"001.006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids"],"type":"object"},"UserUnbannedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"005.002"},"shadow":{"type":"boolean","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"004.001"},"type":{"default":"user.unbanned","type":"string","x-stream-index":"005.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["shadow","cid","channel_id","channel_type","type","created_at"],"title":"UserUnbannedEvent","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"},"UserUnmutedEvent":{"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"004.002"},"target_user":{"type":"string","x-stream-index":"002"},"target_users":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"type":{"default":"user.unmuted","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"001"}},"required":["type","created_at"],"title":"UserUnmutedEvent","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"},"UserUnreadReminderEvent":{"properties":{"channels":{"additionalProperties":{"$ref":"#/components/schemas/ChannelMessages"},"type":"object","x-stream-index":"003"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"user.unread_message_reminder","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002"}},"required":["type","created_at","channels"],"title":"UserUnreadReminderEvent","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"},"UserUpdatedEvent":{"description":"This event is sent when a user gets updated. The event contains information about the updated user.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"received_at":{"format":"date-time","type":"string","x-stream-index":"001.004"},"type":{"default":"user.updated","description":"The type of event: \"user.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.002"},"user":{"$ref":"#/components/schemas/UserResponsePrivacyFields","description":"The updated user","title":"User","x-stream-index":"002.001"}},"required":["type","created_at","custom","user"],"title":"UserUpdatedEvent","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"},"VideoSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"camera_default_on":{"type":"boolean","x-stream-index":"004"},"camera_facing":{"enum":["front","back","external"],"type":"string","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled","target_resolution","camera_default_on","camera_facing"],"type":"object"},"VoteData":{"properties":{"answer_text":{"type":"string","x-stream-index":"002"},"option_id":{"maxLength":255,"type":"string","x-stream-index":"001"}},"type":"object"},"WSEvent":{"description":"Represents an BaseEvent that happened in Stream Chat","properties":{"automoderation":{"type":"boolean","x-stream-index":"023"},"automoderation_scores":{"$ref":"#/components/schemas/ModerationResponse","x-stream-index":"024"},"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"011"},"channel_id":{"type":"string","x-stream-index":"004"},"channel_last_message_at":{"format":"date-time","type":"string","x-stream-index":"007"},"channel_type":{"type":"string","x-stream-index":"005"},"cid":{"type":"string","x-stream-index":"003"},"connection_id":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"string","x-stream-index":"028"},"created_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"022"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"027"},"me":{"$ref":"#/components/schemas/OwnUserResponse","x-stream-index":"019"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"014"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"008"},"message_update":{"$ref":"#/components/schemas/MessageUpdate","x-stream-index":"009"},"parent_id":{"type":"string","x-stream-index":"025"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"015"},"poll_vote":{"$ref":"#/components/schemas/PollVoteResponseData","x-stream-index":"016"},"reaction":{"$ref":"#/components/schemas/ReactionResponse","x-stream-index":"010"},"reason":{"type":"string","x-stream-index":"021"},"team":{"type":"string","x-stream-index":"026"},"thread":{"$ref":"#/components/schemas/ThreadResponse","x-stream-index":"013"},"thread_id":{"type":"string","x-stream-index":"012"},"type":{"type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"017"},"user_id":{"type":"string","x-stream-index":"018"},"watcher_count":{"format":"int32","type":"integer","x-stream-index":"020"}},"required":["type","custom","created_at"],"title":"Event","type":"object","x-stream-docs-page-id":"event_object"},"WebhookEvent":{"description":"The discriminator object for all webhook events, it maps events' payload to the final type","discriminator":{"mapping":{"*":"#/components/schemas/AnyEvent","activity.marked":"#/components/schemas/ActivityMarkedEvent","campaign.completed":"#/components/schemas/CampaignCompletedEvent","campaign.started":"#/components/schemas/CampaignStartedEvent","channel.created":"#/components/schemas/ChannelCreatedEvent","channel.deleted":"#/components/schemas/ChannelDeletedEvent","channel.frozen":"#/components/schemas/ChannelFrozenEvent","channel.hidden":"#/components/schemas/ChannelHiddenEvent","channel.muted":"#/components/schemas/ChannelMutedEvent","channel.truncated":"#/components/schemas/ChannelTruncatedEvent","channel.unfrozen":"#/components/schemas/ChannelUnFrozenEvent","channel.unmuted":"#/components/schemas/ChannelUnmutedEvent","channel.updated":"#/components/schemas/ChannelUpdatedEvent","channel.visible":"#/components/schemas/ChannelVisibleEvent","export.bulk_image_moderation.error":"#/components/schemas/AsyncExportErrorEvent","export.bulk_image_moderation.success":"#/components/schemas/AsyncBulkImageModerationEvent","export.channels.error":"#/components/schemas/AsyncExportErrorEvent","export.channels.success":"#/components/schemas/AsyncExportChannelsEvent","export.moderation_logs.error":"#/components/schemas/AsyncExportErrorEvent","export.moderation_logs.success":"#/components/schemas/AsyncExportModerationLogsEvent","export.users.error":"#/components/schemas/AsyncExportErrorEvent","export.users.success":"#/components/schemas/AsyncExportUsersEvent","flag.updated":"#/components/schemas/FlagUpdatedEvent","member.added":"#/components/schemas/MemberAddedEvent","member.removed":"#/components/schemas/MemberRemovedEvent","member.updated":"#/components/schemas/MemberUpdatedEvent","message.deleted":"#/components/schemas/MessageDeletedEvent","message.flagged":"#/components/schemas/MessageFlaggedEvent","message.new":"#/components/schemas/MessageNewEvent","message.pending":"#/components/schemas/PendingMessageEvent","message.read":"#/components/schemas/MessageReadEvent","message.unblocked":"#/components/schemas/MessageUnblockedEvent","message.undeleted":"#/components/schemas/MessageUndeletedEvent","message.updated":"#/components/schemas/MessageUpdatedEvent","notification.mark_unread":"#/components/schemas/NotificationMarkUnreadEvent","notification.reminder_due":"#/components/schemas/ReminderNotificationEvent","notification.thread_message_new":"#/components/schemas/MessageNewEvent","reaction.deleted":"#/components/schemas/ReactionDeletedEvent","reaction.new":"#/components/schemas/ReactionNewEvent","reaction.updated":"#/components/schemas/ReactionUpdatedEvent","reminder.created":"#/components/schemas/ReminderCreatedEvent","reminder.deleted":"#/components/schemas/ReminderDeletedEvent","reminder.updated":"#/components/schemas/ReminderUpdatedEvent","thread.updated":"#/components/schemas/ThreadUpdatedEvent","user.banned":"#/components/schemas/UserBannedEvent","user.deactivated":"#/components/schemas/UserDeactivatedEvent","user.deleted":"#/components/schemas/UserDeletedEvent","user.flagged":"#/components/schemas/UserFlaggedEvent","user.muted":"#/components/schemas/UserMutedEvent","user.reactivated":"#/components/schemas/UserReactivatedEvent","user.unbanned":"#/components/schemas/UserUnbannedEvent","user.unmuted":"#/components/schemas/UserUnmutedEvent","user.unread_message_reminder":"#/components/schemas/UserUnreadReminderEvent","user.updated":"#/components/schemas/UserUpdatedEvent"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/ActivityMarkedEvent"},{"$ref":"#/components/schemas/AnyEvent"},{"$ref":"#/components/schemas/AsyncBulkImageModerationEvent"},{"$ref":"#/components/schemas/AsyncExportChannelsEvent"},{"$ref":"#/components/schemas/AsyncExportErrorEvent"},{"$ref":"#/components/schemas/AsyncExportErrorEvent"},{"$ref":"#/components/schemas/AsyncExportErrorEvent"},{"$ref":"#/components/schemas/AsyncExportErrorEvent"},{"$ref":"#/components/schemas/AsyncExportModerationLogsEvent"},{"$ref":"#/components/schemas/AsyncExportUsersEvent"},{"$ref":"#/components/schemas/CampaignCompletedEvent"},{"$ref":"#/components/schemas/CampaignStartedEvent"},{"$ref":"#/components/schemas/ChannelCreatedEvent"},{"$ref":"#/components/schemas/ChannelDeletedEvent"},{"$ref":"#/components/schemas/ChannelFrozenEvent"},{"$ref":"#/components/schemas/ChannelHiddenEvent"},{"$ref":"#/components/schemas/ChannelMutedEvent"},{"$ref":"#/components/schemas/ChannelTruncatedEvent"},{"$ref":"#/components/schemas/ChannelUnFrozenEvent"},{"$ref":"#/components/schemas/ChannelUnmutedEvent"},{"$ref":"#/components/schemas/ChannelUpdatedEvent"},{"$ref":"#/components/schemas/ChannelVisibleEvent"},{"$ref":"#/components/schemas/FlagUpdatedEvent"},{"$ref":"#/components/schemas/MemberAddedEvent"},{"$ref":"#/components/schemas/MemberRemovedEvent"},{"$ref":"#/components/schemas/MemberUpdatedEvent"},{"$ref":"#/components/schemas/MessageDeletedEvent"},{"$ref":"#/components/schemas/MessageFlaggedEvent"},{"$ref":"#/components/schemas/MessageNewEvent"},{"$ref":"#/components/schemas/MessageNewEvent"},{"$ref":"#/components/schemas/MessageReadEvent"},{"$ref":"#/components/schemas/MessageUnblockedEvent"},{"$ref":"#/components/schemas/MessageUndeletedEvent"},{"$ref":"#/components/schemas/MessageUpdatedEvent"},{"$ref":"#/components/schemas/NotificationMarkUnreadEvent"},{"$ref":"#/components/schemas/PendingMessageEvent"},{"$ref":"#/components/schemas/ReactionDeletedEvent"},{"$ref":"#/components/schemas/ReactionNewEvent"},{"$ref":"#/components/schemas/ReactionUpdatedEvent"},{"$ref":"#/components/schemas/ReminderCreatedEvent"},{"$ref":"#/components/schemas/ReminderDeletedEvent"},{"$ref":"#/components/schemas/ReminderNotificationEvent"},{"$ref":"#/components/schemas/ReminderUpdatedEvent"},{"$ref":"#/components/schemas/ThreadUpdatedEvent"},{"$ref":"#/components/schemas/UserBannedEvent"},{"$ref":"#/components/schemas/UserDeactivatedEvent"},{"$ref":"#/components/schemas/UserDeletedEvent"},{"$ref":"#/components/schemas/UserFlaggedEvent"},{"$ref":"#/components/schemas/UserMutedEvent"},{"$ref":"#/components/schemas/UserReactivatedEvent"},{"$ref":"#/components/schemas/UserUnbannedEvent"},{"$ref":"#/components/schemas/UserUnmutedEvent"},{"$ref":"#/components/schemas/UserUnreadReminderEvent"},{"$ref":"#/components/schemas/UserUpdatedEvent"}]},"WrappedUnreadCountsResponse":{"description":"Basic response information","nullable":true,"properties":{"channel_type":{"items":{"$ref":"#/components/schemas/UnreadCountsChannelType"},"type":"array","x-stream-index":"001.005"},"channels":{"items":{"$ref":"#/components/schemas/UnreadCountsChannel"},"type":"array","x-stream-index":"001.004"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"threads":{"items":{"$ref":"#/components/schemas/UnreadCountsThread"},"type":"array","x-stream-index":"001.006"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"001.001"},"total_unread_count_by_team":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001.003"},"total_unread_threads_count":{"format":"int32","type":"integer","x-stream-index":"001.002"}},"required":["total_unread_count","total_unread_threads_count","channels","channel_type","threads","duration"],"title":"Response","type":"object"},"XiaomiConfig":{"properties":{"Disabled":{"type":"boolean","writeOnly":true,"x-stream-index":"003"},"package_name":{"type":"string","x-stream-index":"001"},"secret":{"type":"string","x-stream-index":"002"}},"type":"object"},"XiaomiConfigFields":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"package_name":{"type":"string","x-stream-index":"002"},"secret":{"type":"string","x-stream-index":"003"}},"required":["enabled"],"type":"object"}},"securitySchemes":{"JWT":{"description":"JWT should be always provided when stream-auth-type=jwt.\n\nUsing JWT auth request could be authenticated as user or as server-side.\n\nWhen using user authentication permission checking is going to be applied to requests based on the user that is\nperforming a request.\n\nThe `authorization` header should be a JWT string signed using the secret attached to the API key used to perform\nrequests.\n\n**WARNING** all client-side official SDK do not ship with token generation; this is to make sure that the API secret is not\nshared with an untrusted party such as a browser or a iOS/Android application. Tokens **must** be generated server-side.\nIf you wish, you can configure your application to ignore authentication (see `disable_auth_check`)\nThe JWT string must include only the user_id claim and can include any built-in JWT claim such as iat, exp as well.\n","in":"header","name":"Authorization","type":"apiKey"},"api_key":{"description":"Application API key should be always set in order to authenticate the request.","in":"query","name":"api_key","type":"apiKey"},"stream-auth-type":{"description":"Stream-Auth-Type should be always set in order to authenticate the request. Possible\nvalues: `jwt` or `anonymous`.\n\n`jwt` allows you to authenticate as a user. With this auth type you should also provide valid JWT in Authorization\nheader.\n\n`anonymous` allows you to authenticate as anonymous user. Please note that most advanced features are not available\nto anonymous users.","in":"header","name":"Stream-Auth-Type","type":"apiKey"}}},"info":{"title":"Stream API","version":"v187.13.0"},"openapi":"3.0.3","paths":{"/app":{"get":{"description":"This Method returns the application settings\n","operationId":"GetApp","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetApplicationResponse"}}},"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":"Get App Settings","tags":["product:chat"]},"patch":{"description":"This Method updates one or more application settings\n","operationId":"UpdateApp","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAppRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Update App Settings","tags":["product:chat"]}},"/blocklists":{"get":{"description":"Returns all available block lists\n","operationId":"ListBlockLists","parameters":[{"in":"query","name":"team","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListBlockListResponse"}}},"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":"List block lists","tags":["product:chat"]},"post":{"description":"Creates a new application blocklist, once created the blocklist can be used by any channel type\n","operationId":"CreateBlockList","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBlockListRequest"}}},"description":"Block list","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBlockListResponse"}}},"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":"Create block list","tags":["product:chat"]}},"/blocklists/{name}":{"delete":{"description":"Deletes previously created application blocklist\n","operationId":"DeleteBlockList","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"team","schema":{"type":"string","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete block list","tags":["product:chat"]},"get":{"description":"Returns block list by given name\n","operationId":"GetBlockList","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Block list name","title":"Name","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"team","schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBlockListResponse"}}},"description":"GetBlockListResponse"},"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":"Get block list","tags":["product:chat"]},"put":{"description":"Updates contents of the block list\n","operationId":"UpdateBlockList","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Block list name","title":"Name","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBlockListRequest"}}},"description":"Update block list","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBlockListResponse"}}},"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":"Update block list","tags":["product:chat"]}},"/campaigns/query":{"post":{"description":"Query campaigns with filter query\n","operationId":"QueryCampaigns","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCampaignsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCampaignsResponse"}}},"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":"Query campaigns","tags":["product:chat"]}},"/campaigns/{id}":{"get":{"description":"Get campaign by ID.\n","operationId":"GetCampaign","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"The ID of the campaign (uuid)","maxLength":255,"title":"Campaign ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"prev","schema":{"description":"Token for the previous page of campaign users","title":"Previous Users Page","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"query","name":"next","schema":{"description":"Token for the next page of campaign users","title":"Next Users Page","type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"limit","schema":{"description":"Maximum number of campaign users to return in a single request (max: 1000)","format":"int32","maximum":1000,"minimum":0,"title":"Users Limit","type":"integer","writeOnly":true,"x-stream-index":"002.003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCampaignResponse"}}},"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":"Get campaign","tags":["product:chat"]}},"/campaigns/{id}/start":{"post":{"description":"Starts or schedules a campaign\n","operationId":"StartCampaign","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartCampaignRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartCampaignResponse"}}},"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":"Start/schedule campaign","tags":["product:chat"]}},"/campaigns/{id}/stop":{"post":{"description":"Stops a campaign\n","operationId":"ScheduleCampaign","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignResponse"}}},"description":"Successful 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":"Stop campaign","tags":["product:chat"]}},"/channels":{"post":{"description":"Query channels with filter query\n","operationId":"QueryChannels","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryChannelsRequest"}}},"description":"Query Channels Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryChannelsResponse"}}},"description":"Channels list"},"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":"Query channels","tags":["product:chat"]}},"/channels/delete":{"post":{"description":"Allows to delete several channels at once asynchronously\n\nSends events:\n- channel.deleted\n- channel.deleted\n","operationId":"DeleteChannels","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteChannelsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteChannelsResponse"}}},"description":"Successful 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":"Deletes channels asynchronously","tags":["product:chat"]}},"/channels/read":{"post":{"description":"Marks channels as read up to the specific message. If no channels is given, mark all channel as read\n\nSends events:\n- message.read\n- message.read\n","operationId":"MarkChannelsRead","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkChannelsReadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkReadResponse"}}},"description":"Successful 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 channels as read","tags":["product:chat"]}},"/channels/{type}/query":{"post":{"description":"This Method creates a channel or returns an existing one with matching attributes\n\nSends events:\n- channel.created\n- member.added\n- member.removed\n- member.updated\n- user.watching.start\n","operationId":"GetOrCreateDistinctChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelGetOrCreateRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelStateResponse"}}},"description":"Successful 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":"Get or create channel","tags":["product:chat"]}},"/channels/{type}/{id}":{"delete":{"description":"Deletes channel\n\nSends events:\n- channel.deleted\n- channel.deleted\n","operationId":"DeleteChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"query","name":"hard_delete","schema":{"type":"boolean","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteChannelResponse"}}},"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":"Delete channel","tags":["product:chat"]},"patch":{"description":"Updates certain fields of the channel\n\nSends events:\n- channel.updated\n- channel.updated\n","operationId":"UpdateChannelPartial","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelPartialRequest"}}},"description":"UpdateChannelPartialRequest","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelPartialResponse"}}},"description":"Successful 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":"Partially update channel","tags":["product:chat"]},"post":{"description":"Change channel data\n\nSends events:\n- channel.updated\n- member.added\n- member.removed\n- member.updated\n- message.new\n- channel.updated\n- member.added\n- member.removed\n- member.updated\n- message.new\n","operationId":"UpdateChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"013.002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"013.002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelRequest"}}},"description":"Channel update request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelResponse"}}},"description":"Successful 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":"Update channel","tags":["product:chat"]}},"/channels/{type}/{id}/draft":{"delete":{"description":"Deletes a draft\n\nSends events:\n- draft.deleted\n","operationId":"DeleteDraft","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"parent_id","schema":{"description":"Parent message ID","title":"string","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"003.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete draft","tags":["product:chat"]},"get":{"description":"Get a draft\n","operationId":"GetDraft","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"parent_id","schema":{"description":"Parent message ID","title":"string","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"003.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetDraftResponse"}}},"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":"Get draft","tags":["product:chat"]}},"/channels/{type}/{id}/event":{"post":{"description":"Sends event to the channel\n","operationId":"SendEvent","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendEventRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventResponse"}}},"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":"Send event","tags":["product:chat"]}},"/channels/{type}/{id}/file":{"delete":{"description":"Deletes previously uploaded file\n","operationId":"DeleteFile","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of file","title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"File ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"url","schema":{"description":"File URL to delete","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete file","tags":["product:chat"]},"post":{"description":"Uploads file\n","operationId":"UploadFile","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/FileUploadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileUploadResponse"}}},"description":"Successful 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":"Upload file","tags":["product:chat"]}},"/channels/{type}/{id}/hide":{"post":{"description":"Marks channel as hidden for current user\n\nSends events:\n- channel.hidden\n- channel.hidden\n","operationId":"HideChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HideChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HideChannelResponse"}}},"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":"Hide channel","tags":["product:chat"]}},"/channels/{type}/{id}/image":{"delete":{"description":"Deletes previously uploaded image\n","operationId":"DeleteImage","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of file","title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"File ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"url","schema":{"description":"File URL to delete","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete image","tags":["product:chat"]},"post":{"description":"Uploads image\n","operationId":"UploadImage","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.001.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.001.002"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/ImageUploadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageUploadResponse"}}},"description":"Successful 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":"Upload image","tags":["product:chat"]}},"/channels/{type}/{id}/member":{"patch":{"description":"\n","operationId":"UpdateMemberPartial","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"005.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMemberPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMemberPartialResponse"}}},"description":"Successful 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":"Partially channel member update","tags":["product:chat"]}},"/channels/{type}/{id}/message":{"post":{"description":"Sends new message to the specified channel\n\nSends events:\n- message.new\n- message.updated\n- message.new\n- message.updated\n","operationId":"SendMessage","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"009.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"009.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendMessageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendMessageResponse"}}},"description":"Successful 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":"Send new message","tags":["product:chat"]}},"/channels/{type}/{id}/messages":{"get":{"description":"Returns list messages found by IDs\n","operationId":"GetManyMessages","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"ids","required":true,"schema":{"description":"List of comma-separated IDs","items":{"type":"string"},"maximum":50,"minimum":1,"title":"IDs","type":"array","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetManyMessagesResponse"}}},"description":"Successful 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":"Get many messages","tags":["product:chat"]}},"/channels/{type}/{id}/query":{"post":{"description":"This Method creates a channel or returns an existing one with matching attributes\n\nSends events:\n- channel.created\n- member.added\n- member.removed\n- member.updated\n- user.watching.start\n","operationId":"GetOrCreateChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID (maximum length of 64 characters)","title":"ID","type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelGetOrCreateRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelStateResponse"}}},"description":"Successful 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":"Get or create channel","tags":["product:chat"]}},"/channels/{type}/{id}/read":{"post":{"description":"Marks channel as read up to the specific message\n\nSends events:\n- message.read\n- message.read\n","operationId":"MarkRead","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkReadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkReadResponse"}}},"description":"Successful 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 read","tags":["product:chat"]}},"/channels/{type}/{id}/show":{"post":{"description":"Shows previously hidden channel\n\nSends events:\n- channel.visible\n- channel.visible\n","operationId":"ShowChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShowChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShowChannelResponse"}}},"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":"Show channel","tags":["product:chat"]}},"/channels/{type}/{id}/truncate":{"post":{"description":"Truncates messages from a channel. Can be applied to the entire channel or scoped to specific members.\n\nSends events:\n- channel.truncated\n- channel.truncated\n","operationId":"TruncateChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TruncateChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TruncateChannelResponse"}}},"description":"Successful 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":"Truncate channel","tags":["product:chat"]}},"/channels/{type}/{id}/unread":{"post":{"description":"Marks channel as unread from a specific message\n","operationId":"MarkUnread","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkUnreadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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 unread","tags":["product:chat"]}},"/channeltypes":{"get":{"description":"Lists all available channel types\n","operationId":"ListChannelTypes","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListChannelTypesResponse"}}},"description":"ListChannelTypesResponse"},"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":"List channel types","tags":["product:chat"]},"post":{"description":"Creates new channel type\n","operationId":"CreateChannelType","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateChannelTypeRequest"}}},"description":"CreateChannelTypeRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateChannelTypeResponse"}}},"description":"Successful 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":"Create channel type","tags":["product:chat"]}},"/channeltypes/{name}":{"delete":{"description":"Deletes channel type\n","operationId":"DeleteChannelType","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Channel type name","title":"Name","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete channel type","tags":["product:chat"]},"get":{"description":"Gets channel type\n","operationId":"GetChannelType","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Channel type name","title":"Name","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetChannelTypeResponse"}}},"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":"Get channel type","tags":["product:chat"]},"put":{"description":"Updates channel type\n","operationId":"UpdateChannelType","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelTypeRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelTypeResponse"}}},"description":"Successful 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":"Update channel type","tags":["product:chat"]}},"/check_push":{"post":{"description":"Sends a test message via push, this is a test endpoint to verify your push settings\n","operationId":"CheckPush","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckPushRequest"}}},"description":"CheckPushRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckPushResponse"}}},"description":"Successful 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":"Check push","tags":["product:chat"]}},"/check_sns":{"post":{"description":"Validates Amazon SNS configuration\n","operationId":"CheckSNS","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSNSRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSNSResponse"}}},"description":"Successful 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":"Check SNS","tags":["product:chat"]}},"/check_sqs":{"post":{"description":"Validates Amazon SQS credentials\n","operationId":"CheckSQS","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSQSRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSQSResponse"}}},"description":"Successful 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":"Check SQS","tags":["product:chat"]}},"/commands":{"get":{"description":"Returns all custom commands\n","operationId":"ListCommands","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListCommandsResponse"}}},"description":"ListCommandsResponse"},"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":"List commands","tags":["product:chat"]},"post":{"description":"Creates custom chat command\n","operationId":"CreateCommand","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCommandRequest"}}},"description":"CreateCommandRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCommandResponse"}}},"description":"CreateCommandResponse"},"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":"Create command","tags":["product:chat"]}},"/commands/{name}":{"delete":{"description":"Deletes custom chat command\n","operationId":"DeleteCommand","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Command name","title":"Name","type":"string","x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCommandResponse"}}},"description":"DeleteCommandResponse"},"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":"Delete command","tags":["product:chat"]},"get":{"description":"Returns custom command by its name\n","operationId":"GetCommand","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Command name","title":"Name","type":"string","x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCommandResponse"}}},"description":"GetCommandResponse"},"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":"Get command","tags":["product:chat"]},"put":{"description":"Updates custom chat command\n","operationId":"UpdateCommand","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Unique command name","title":"Name","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCommandRequest"}}},"description":"UpdateCommandRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCommandResponse"}}},"description":"UpdateCommandResponse"},"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":"Update command","tags":["product:chat"]}},"/devices":{"delete":{"description":"Deletes one device\n","operationId":"DeleteDevice","parameters":[{"in":"query","name":"id","required":true,"schema":{"description":"Device ID to delete","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"user_id","schema":{"description":"**Server-side only**. User ID which server acts upon","title":"User ID","type":"string","writeOnly":true,"x-stream-index":"002.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete device","tags":["product:chat"]},"get":{"description":"Returns all available devices\n","operationId":"ListDevices","parameters":[{"in":"query","name":"user_id","schema":{"description":"**Server-side only**. User ID which server acts upon","title":"User ID","type":"string","writeOnly":true,"x-stream-index":"001.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDevicesResponse"}}},"description":"ListDevicesResponse"},"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":"List devices","tags":["product:chat"]},"post":{"description":"Adds a new device to a user, if the same device already exists the call will have no effect\n","operationId":"CreateDevice","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDeviceRequest"}}},"description":"CreateDeviceRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Create device","tags":["product:chat"]}},"/drafts/query":{"post":{"description":"Queries draft messages for a user\n","operationId":"QueryDrafts","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryDraftsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryDraftsResponse"}}},"description":"Successful 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":"Query draft messages","tags":["product:chat"]}},"/export/users":{"post":{"description":"Exports user profile, reactions and messages for list of given users\n","operationId":"ExportUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportUsersResponse"}}},"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":"Export users","tags":["product:chat"]}},"/export_channels":{"post":{"description":"Exports channel data to JSON file\n","operationId":"ExportChannels","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportChannelsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportChannelsResponse"}}},"description":"Successful 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":"Export channels","tags":["product:chat"]}},"/external_storage":{"get":{"description":"Lists external storage\n","operationId":"ListExternalStorage","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListExternalStorageResponse"}}},"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":"List external storage","tags":["product:chat"]},"post":{"description":"Creates new external storage\n","operationId":"CreateExternalStorage","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateExternalStorageRequest"}}},"description":"CreateExternalStorageRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateExternalStorageResponse"}}},"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":"Create external storage","tags":["product:chat"]}},"/external_storage/{name}":{"delete":{"description":"Deletes external storage\n","operationId":"DeleteExternalStorage","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteExternalStorageResponse"}}},"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":"Delete external storage","tags":["product:chat"]},"put":{"description":"\n","operationId":"UpdateExternalStorage","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateExternalStorageRequest"}}},"description":"ExternalStorageRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateExternalStorageResponse"}}},"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":"Update External Storage","tags":["product:chat"]}},"/external_storage/{name}/check":{"get":{"description":"\n","operationId":"CheckExternalStorage","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckExternalStorageResponse"}}},"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":"Check External Storage","tags":["product:chat"]}},"/guest":{"post":{"description":"\n","operationId":"CreateGuest","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGuestRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGuestResponse"}}},"description":"Successful 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":"Create Guest","tags":["product:chat"]}},"/import_urls":{"post":{"description":"Creates a new import URL\n","operationId":"CreateImportURL","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateImportURLRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateImportURLResponse"}}},"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":"Create import URL","tags":["product:chat"]}},"/imports":{"get":{"description":"Gets an import\n","operationId":"ListImports","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListImportsResponse"}}},"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":"Get import","tags":["product:chat"]},"post":{"description":"Creates a new import\n","operationId":"CreateImport","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateImportRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateImportResponse"}}},"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":"Create import","tags":["product:chat"]}},"/imports/{id}":{"get":{"description":"Gets an import\n","operationId":"GetImport","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetImportResponse"}}},"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":"Get import","tags":["product:chat"]}},"/members":{"get":{"description":"Find and filter channel members\n","operationId":"QueryMembers","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryMembersPayload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MembersResponse"}}},"description":"Successful 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":"Query members","tags":["product:chat"]}},"/messages/history":{"post":{"description":"Queries history for one message\n","operationId":"QueryMessageHistory","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryMessageHistoryRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryMessageHistoryResponse"}}},"description":"Successful 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":"Query message history","tags":["product:chat"]}},"/messages/{id}":{"delete":{"description":"Deletes message\n\nSends events:\n- message.deleted\n- message.deleted\n","operationId":"DeleteMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID to delete","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"hard","schema":{"description":"Delete all message reactions and replies as well","title":"Hard","type":"boolean","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"deleted_by","schema":{"type":"string","writeOnly":true,"x-stream-index":"003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteMessageResponse"}}},"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":"Delete message","tags":["product:chat"]},"get":{"description":"Returns message by ID\n","operationId":"GetMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"ID of the message","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"show_deleted_message","schema":{"description":"Whether to show deleted message","title":"Show deleted message","type":"boolean","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetMessageResponse"}}},"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":"Get message","tags":["product:chat"]},"post":{"description":"Updates message with new data\n\nSends events:\n- message.updated\n- message.updated\n","operationId":"UpdateMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"004.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessageResponse"}}},"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":"Update message","tags":["product:chat"]},"put":{"description":"Updates certain fields of the message\n\nSends events:\n- message.updated\n- message.updated\n","operationId":"UpdateMessagePartial","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessagePartialRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessagePartialResponse"}}},"description":"Successful 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":"Partially message update","tags":["product:chat"]}},"/messages/{id}/action":{"post":{"description":"Executes message command action with given parameters\n\nSends events:\n- message.new\n- message.new\n","operationId":"RunMessageAction","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageActionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}},"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":"Run message command action","tags":["product:chat"]}},"/messages/{id}/commit":{"post":{"description":"Commits a pending message, which will make it visible in the channel\n\nSends events:\n- message.new\n- message.updated\n- message.new\n- message.updated\n","operationId":"CommitMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}},"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":"Commit message","tags":["product:chat"]}},"/messages/{id}/reaction":{"post":{"description":"Sends reaction to specified message\n\nSends events:\n- reaction.new\n- reaction.updated\n","operationId":"SendReaction","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID to send reaction for","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendReactionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendReactionResponse"}}},"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":"Send reaction","tags":["product:chat"]}},"/messages/{id}/reaction/{type}":{"delete":{"description":"Removes user reaction from the message\n\nSends events:\n- reaction.deleted\n","operationId":"DeleteReaction","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID to remove reaction from","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"type","required":true,"schema":{"description":"Reaction type to remove","title":"Type","type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"description":"**Server-side only**. User ID which server acts upon","title":"User ID","type":"string","writeOnly":true,"x-stream-index":"003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteReactionResponse"}}},"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":"Delete reaction","tags":["product:chat"]}},"/messages/{id}/reactions":{"get":{"description":"Returns list of reactions of specific message\n","operationId":"GetReactions","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"limit","schema":{"description":"Number of records to return","format":"int32","title":"Limit","type":"integer","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"offset","schema":{"description":"Number of records to offset","format":"int32","title":"Offset","type":"integer","writeOnly":true,"x-stream-index":"003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetReactionsResponse"}}},"description":"Successful 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":"Get reactions","tags":["product:chat"]},"post":{"description":"Get reactions on a message\n","operationId":"QueryReactions","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryReactionsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryReactionsResponse"}}},"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"}},"tags":["product:chat"]}},"/messages/{id}/translate":{"post":{"description":"Translates message to a given language using automated translation software\n\nSends events:\n- message.updated\n- message.updated\n","operationId":"TranslateMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TranslateMessageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}},"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":"Translate message","tags":["product:chat"]}},"/messages/{id}/undelete":{"post":{"description":"Undelete a message that was previously soft-deleted\n\nSends events:\n- message.undeleted\n- message.undeleted\n","operationId":"UndeleteMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"004.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessageResponse"}}},"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":"Undelete message","tags":["product:chat"]}},"/messages/{message_id}/polls/{poll_id}/vote":{"post":{"description":"Cast a vote on a poll\n\nSends events:\n- feeds.poll.vote_casted\n- feeds.poll.vote_changed\n- feeds.poll.vote_removed\n- poll.vote_casted\n- poll.vote_changed\n- poll.vote_removed\n","operationId":"CastPollVote","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CastPollVoteRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollVoteResponse"}}},"description":"Successful 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":"Cast vote","tags":["product:chat"]}},"/messages/{message_id}/polls/{poll_id}/vote/{vote_id}":{"delete":{"description":"Delete a vote from a poll\n\nSends events:\n- feeds.poll.vote_removed\n- poll.vote_removed\n","operationId":"DeletePollVote","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"004"}},{"in":"path","name":"vote_id","required":true,"schema":{"description":"Vote ID","maxLength":255,"title":"string","type":"string","x-stream-index":"005"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollVoteResponse"}}},"description":"Successful 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":"Delete vote","tags":["product:chat"]}},"/messages/{message_id}/reminders":{"delete":{"description":"Deletes a user's created reminder\n\nSends events:\n- reminder.deleted\n","operationId":"DeleteReminder","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteReminderResponse"}}},"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":"Delete reminder","tags":["product:chat"]},"patch":{"description":"Updates an existing reminder\n\nSends events:\n- reminder.updated\n","operationId":"UpdateReminder","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateReminderRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateReminderResponse"}}},"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":"Updates Reminder","tags":["product:chat"]},"post":{"description":"Creates a new reminder\n\nSends events:\n- reminder.created\n","operationId":"CreateReminder","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateReminderRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReminderResponseData"}}},"description":"Successful 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":"Create reminder","tags":["product:chat"]}},"/messages/{parent_id}/replies":{"get":{"description":"Returns replies (thread) of the message\n","operationId":"GetReplies","parameters":[{"in":"path","name":"parent_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"sort","schema":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":1,"type":"array","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"limit","schema":{"description":"The maximum number of messages to return (max limit ","format":"int32","minimum":0,"title":"Limit","type":"integer","x-stream-index":"003.001"}},{"in":"query","name":"offset","schema":{"description":"The offset to start from","format":"int32","title":"Offset","type":"integer","x-stream-index":"003.002"}},{"in":"query","name":"id_gte","schema":{"description":"The ID of the message to get messages with a timestamp greater than or equal to","title":"IDGTE","type":"string","x-stream-index":"003.003"}},{"in":"query","name":"id_gt","schema":{"description":"The ID of the message to get messages with a timestamp greater than","title":"IDGT","type":"string","x-stream-index":"003.004"}},{"in":"query","name":"id_lte","schema":{"description":"The ID of the message to get messages with a timestamp smaller than or equal to","title":"IDLTE","type":"string","x-stream-index":"003.005"}},{"in":"query","name":"id_lt","schema":{"description":"The ID of the message to get messages with a timestamp smaller than","title":"IDLT","type":"string","x-stream-index":"003.006"}},{"in":"query","name":"created_at_after_or_equal","schema":{"description":"The timestamp to get messages with a created_at timestamp greater than or equal to","format":"date-time","title":"Created_at after or equal","type":"string","x-stream-index":"003.007"}},{"in":"query","name":"created_at_after","schema":{"description":"The timestamp to get messages with a created_at timestamp greater than","format":"date-time","title":"Created_at after","type":"string","x-stream-index":"003.008"}},{"in":"query","name":"created_at_before_or_equal","schema":{"description":"The timestamp to get messages with a created_at timestamp smaller than or equal to","format":"date-time","title":"Created_at after before or equal","type":"string","x-stream-index":"003.009"}},{"in":"query","name":"created_at_before","schema":{"description":"The timestamp to get messages with a created_at timestamp smaller than","format":"date-time","title":"Created_at after before","type":"string","x-stream-index":"003.010"}},{"in":"query","name":"id_around","schema":{"description":"The result will be a set of messages, that are both older and newer than the message with the provided ID, and the message with the ID provided will be in the middle of the set","title":"Id around","type":"string","x-stream-index":"003.011"}},{"in":"query","name":"created_at_around","schema":{"description":"The result will be a set of messages, that are both older and newer than the created_at timestamp provided, distributed evenly around the timestamp","format":"date-time","title":"Created_at around","type":"string","x-stream-index":"003.012"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRepliesResponse"}}},"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":"Get replies","tags":["product:chat"]}},"/moderation/ban":{"delete":{"description":"Removes previously applied ban\n\nSends events:\n- user.unbanned\n- user.unbanned\n","operationId":"Unban","parameters":[{"in":"query","name":"target_user_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"channel_cid","schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"created_by","schema":{"type":"string","writeOnly":true,"x-stream-index":"005"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Unban user","tags":["product:chat"]},"post":{"description":"Restricts user activity either in specific channel or globally\n\nSends events:\n- user.banned\n- user.banned\n","operationId":"Ban","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BanRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Ban user","tags":["product:chat"]}},"/moderation/flag":{"post":{"description":"Reports message or user for review by moderators\n\nSends events:\n- message.flagged\n- user.flagged\n- message.flagged\n- user.flagged\n","operationId":"Flag","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlagRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlagResponse"}}},"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":"Flag","tags":["product:chat"]}},"/moderation/flags/message":{"get":{"description":"Find and filter message flags\n","operationId":"QueryMessageFlags","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryMessageFlagsPayload","description":"JSON object with query message flags payload","title":"Payload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryMessageFlagsResponse"}}},"description":"QueryMessageFlagsResponse"},"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":"Query Message Flags","tags":["product:chat"]}},"/moderation/mute":{"post":{"description":"Mutes one or several users\n\nSends events:\n- user.unmuted\n- user.muted\n","operationId":"MuteUser","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteUserRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteUserResponse"}}},"description":"Successful 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":"Mute user","tags":["product:chat"]}},"/moderation/mute/channel":{"post":{"description":"Mutes channel for user\n\nSends events:\n- channel.muted\n- channel.muted\n","operationId":"MuteChannel","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteChannelResponse"}}},"description":"Successful 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":"Mute channel","tags":["product:chat"]}},"/moderation/unmute":{"post":{"description":"Unmutes previously muted user\n\nSends events:\n- user.unmuted\n- user.unmuted\n","operationId":"UnmuteUser","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnmuteUserRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnmuteResponse"}}},"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":"Unmute user","tags":["product:chat"]}},"/moderation/unmute/channel":{"post":{"description":"Unmutes channel for user\n\nSends events:\n- channel.unmuted\n- channel.unmuted\n","operationId":"UnmuteChannel","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnmuteChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnmuteResponse"}}},"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":"Unmute channel","tags":["product:chat"]}},"/og":{"get":{"description":"Get an OpenGraph attachment for a link\n","operationId":"GetOG","parameters":[{"in":"query","name":"url","required":true,"schema":{"description":"URL to be scraped","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOGResponse"}}},"description":"Get OG Attachment"},"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":"Get OG","tags":["product:chat"]}},"/permissions":{"get":{"description":"Lists all available permissions\n","operationId":"ListPermissions","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPermissionsResponse"}}},"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":"List permissions","tags":["product:chat"]}},"/permissions/{id}":{"get":{"description":"Gets custom permission\n","operationId":"GetPermission","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Permission ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCustomPermissionResponse"}}},"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":"Get permission","tags":["product:chat"]}},"/polls":{"post":{"description":"Creates a new poll\n","operationId":"CreatePoll","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePollRequest"}}},"description":"Create Poll Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Create poll","tags":["product:chat"]},"put":{"description":"Updates a poll\n\nSends events:\n- feeds.poll.closed\n- feeds.poll.updated\n- poll.closed\n- poll.updated\n","operationId":"UpdatePoll","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePollRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Update poll","tags":["product:chat"]}},"/polls/query":{"post":{"description":"Queries polls\n","operationId":"QueryPolls","parameters":[{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryPollsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryPollsResponse"}}},"description":"Successful 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":"Query polls","tags":["product:chat"]}},"/polls/{poll_id}":{"delete":{"description":"Deletes a poll\n\nSends events:\n- feeds.poll.deleted\n- poll.deleted\n","operationId":"DeletePoll","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete poll","tags":["product:chat"]},"get":{"description":"Retrieves a poll\n","operationId":"GetPoll","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Get poll","tags":["product:chat"]},"patch":{"description":"Updates a poll partially\n\nSends events:\n- feeds.poll.closed\n- feeds.poll.updated\n- poll.closed\n- poll.updated\n","operationId":"UpdatePollPartial","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePollPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Partial update poll","tags":["product:chat"]}},"/polls/{poll_id}/options":{"post":{"description":"Creates a poll option\n\nSends events:\n- feeds.poll.updated\n- poll.updated\n","operationId":"CreatePollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePollOptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollOptionResponse"}}},"description":"Successful 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":"Create poll option","tags":["product:chat"]},"put":{"description":"Updates a poll option\n\nSends events:\n- feeds.poll.updated\n- poll.updated\n","operationId":"UpdatePollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePollOptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollOptionResponse"}}},"description":"Successful 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":"Update poll option","tags":["product:chat"]}},"/polls/{poll_id}/options/{option_id}":{"delete":{"description":"Deletes a poll option\n\nSends events:\n- feeds.poll.updated\n- poll.updated\n","operationId":"DeletePollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"path","name":"option_id","required":true,"schema":{"description":"Option ID","maxLength":255,"title":"string","type":"string","x-stream-index":"003"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete poll option","tags":["product:chat"]},"get":{"description":"Retrieves a poll option\n","operationId":"GetPollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"path","name":"option_id","required":true,"schema":{"description":"Option ID","maxLength":255,"title":"string","type":"string","x-stream-index":"003"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollOptionResponse"}}},"description":"Successful 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":"Get poll option","tags":["product:chat"]}},"/polls/{poll_id}/votes":{"post":{"description":"Queries votes\n","operationId":"QueryPollVotes","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryPollVotesRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollVotesResponse"}}},"description":"Successful 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":"Query votes","tags":["product:chat"]}},"/push_preferences":{"post":{"description":"Update the push preferences for a user and or channel member. Set to all, mentions or none\n","operationId":"UpdatePushNotificationPreferences","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertPushPreferencesRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertPushPreferencesResponse"}}},"description":"Successful 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":"Push notification preferences","tags":["product:chat"]}},"/push_providers":{"get":{"description":"List details of all push providers.\n","operationId":"ListPushProviders","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPushProvidersResponse"}}},"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":"List push providers","tags":["product:chat"]},"post":{"description":"Upsert a push provider for v2 with multi bundle/package support\n","operationId":"UpsertPushProvider","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertPushProviderRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertPushProviderResponse"}}},"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":"Upsert a push provider","tags":["product:chat"]}},"/push_providers/{type}/{name}":{"delete":{"description":"Delete a push provider from v2 with multi bundle/package support. v1 isn't supported in this endpoint\n","operationId":"DeletePushProvider","parameters":[{"in":"path","name":"type","required":true,"schema":{"enum":["apn","firebase","huawei","xiaomi"],"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"name","required":true,"schema":{"maxLength":36,"minLength":1,"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete a push provider","tags":["product:chat"]}},"/push_templates":{"get":{"description":"Retrieve push notification templates for Chat.\n","operationId":"GetPushTemplates","parameters":[{"in":"query","name":"push_provider_name","schema":{"description":"Push provider name to filter templates","title":"string","type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"push_provider_type","required":true,"schema":{"description":"Push provider type (firebase, apn) to filter templates","enum":["firebase","apn"],"title":"string","type":"string","writeOnly":true,"x-stream-index":"003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPushTemplatesResponse"}}},"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":"Get push notification templates","tags":["product:chat"]},"post":{"description":"Create or update a push notification template for a specific event type and push provider\n","operationId":"UpsertPushTemplate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertPushTemplateRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertPushTemplateResponse"}}},"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":"Upsert a push notification template","tags":["product:chat"]}},"/query_banned_users":{"get":{"description":"Find and filter channel scoped or global user bans\n","operationId":"QueryBannedUsers","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryBannedUsersPayload","description":"JSON object with query user bans payload","title":"Payload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryBannedUsersResponse"}}},"description":"Successful 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":"Query Banned Users","tags":["product:chat"]}},"/rate_limits":{"get":{"description":"Get rate limits usage and quotas\n","operationId":"GetRateLimits","parameters":[{"in":"query","name":"server_side","schema":{"description":"Whether to include server-side platform limits or not","title":"Server-side","type":"boolean","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"android","schema":{"description":"Whether to include Android platform limits or not","title":"Android","type":"boolean","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"ios","schema":{"description":"Whether to include iOS platform limits or not","title":"iOS","type":"boolean","writeOnly":true,"x-stream-index":"003"}},{"in":"query","name":"web","schema":{"description":"Whether to include web platform limits or not","title":"Web","type":"boolean","writeOnly":true,"x-stream-index":"004"}},{"in":"query","name":"endpoints","schema":{"description":"Specific endpoints to show limits for, as a comma-separated list of values","title":"Endpoints","type":"string","writeOnly":true,"x-stream-index":"005"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRateLimitsResponse"}}},"description":"Get Rate Limits 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":"Get rate limits","tags":["product:chat"]}},"/reminders/query":{"post":{"description":"Queries reminders\n","operationId":"QueryReminders","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryRemindersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryRemindersResponse"}}},"description":"Successful 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":"Query reminders","tags":["product:chat"]}},"/roles":{"get":{"description":"Lists all available roles\n","operationId":"ListRoles","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListRolesResponse"}}},"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":"List roles","tags":["product:chat"]},"post":{"description":"Creates custom role\n","operationId":"CreateRole","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRoleRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRoleResponse"}}},"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":"Create role","tags":["product:chat"]}},"/roles/{name}":{"delete":{"description":"Deletes custom role\n","operationId":"DeleteRole","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Role name","title":"Name","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete role","tags":["product:chat"]}},"/search":{"get":{"description":"Search messages across channels\n","operationId":"Search","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchPayload","description":"JSON object with search payload","title":"Payload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchResponse"}}},"description":"Successful 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":"Search messages","tags":["product:chat"]}},"/segments/query":{"post":{"description":"Query segments\n","operationId":"QuerySegments","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuerySegmentsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuerySegmentsResponse"}}},"description":"Successful 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":"Query segments","tags":["product:chat"]}},"/segments/{id}":{"delete":{"description":"Delete a segment\n","operationId":"DeleteSegment","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete segment","tags":["product:chat"]},"get":{"description":"Get segment\n","operationId":"GetSegment","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetSegmentResponse"}}},"description":"Successful 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":"Get segment","tags":["product:chat"]}},"/segments/{id}/deletetargets":{"post":{"description":"Delete targets from a segment\n","operationId":"DeleteSegmentTargets","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteSegmentTargetsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete targets from a segment","tags":["product:chat"]}},"/segments/{id}/target/{target_id}":{"get":{"description":"Check whether a target exists in a segment. Returns 200 if the target exists, 404 otherwise\n","operationId":"SegmentTargetExists","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"target_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Check whether a target exists in a segment","tags":["product:chat"]}},"/segments/{id}/targets/query":{"post":{"description":"Query segment targets\n","operationId":"QuerySegmentTargets","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuerySegmentTargetsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuerySegmentTargetsResponse"}}},"description":"Successful 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":"Query segment targets","tags":["product:chat"]}},"/tasks/{id}":{"get":{"description":"Gets status of a task\n","operationId":"GetTask","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Task ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetTaskResponse"}}},"description":"Get Task 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":"Get status of a task","tags":["product:chat"]}},"/threads":{"post":{"description":"Returns the list of threads for specific user\n","operationId":"QueryThreads","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryThreadsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryThreadsResponse"}}},"description":"Successful 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":"Query Threads","tags":["product:chat"]}},"/threads/{message_id}":{"get":{"description":"Return a specific thread\n","operationId":"GetThread","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"reply_limit","schema":{"description":"Limit the number of replies returned","format":"int32","minimum":0,"title":"Reply limit","type":"integer","writeOnly":true,"x-stream-index":"004"}},{"in":"query","name":"participant_limit","schema":{"description":"Limit the number of participants returned","format":"int32","maximum":100,"minimum":0,"title":"Participant limit","type":"integer","writeOnly":true,"x-stream-index":"005"}},{"in":"query","name":"member_limit","schema":{"description":"Limit the number of members returned per thread channel","format":"int32","maximum":100,"minimum":0,"title":"Member limit","type":"integer","writeOnly":true,"x-stream-index":"006"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetThreadResponse"}}},"description":"Successful 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":"Get Thread","tags":["product:chat"]},"patch":{"description":"Updates certain fields of the thread\n\nSends events:\n- thread.updated\n- thread.updated\n","operationId":"UpdateThreadPartial","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateThreadPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateThreadPartialResponse"}}},"description":"Successful 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":"Partially update thread","tags":["product:chat"]}},"/unread":{"get":{"description":"Fetch unread counts for a single user\n","operationId":"UnreadCounts","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WrappedUnreadCountsResponse"}}},"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":"Unread counts","tags":["product:chat"]}},"/unread_batch":{"post":{"description":"Fetch unread counts in batch for multiple users in one call\n","operationId":"UnreadCountsBatch","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnreadCountsBatchRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnreadCountsBatchResponse"}}},"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":"Batch unread counts","tags":["product:chat"]}},"/uploads/file":{"delete":{"description":"Deletes previously uploaded file\n","operationId":"DeleteFileGlobal","parameters":[{"in":"query","name":"url","schema":{"description":"File URL to delete","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete file","tags":["product:chat"],"x-stream-sdk-name":"DeleteFile"},"post":{"description":"Uploads file\n","operationId":"UploadFileGlobal","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/FileUploadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileUploadResponse"}}},"description":"Successful 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":"Upload file","tags":["product:chat"],"x-stream-sdk-name":"UploadFile"}},"/uploads/image":{"delete":{"description":"Deletes previously uploaded image\n","operationId":"DeleteImageGlobal","parameters":[{"in":"query","name":"url","schema":{"description":"File URL to delete","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete image","tags":["product:chat"],"x-stream-sdk-name":"DeleteImage"},"post":{"description":"Uploads image\n","operationId":"UploadImageGlobal","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/ImageUploadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageUploadResponse"}}},"description":"Successful 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":"Upload image","tags":["product:chat"],"x-stream-sdk-name":"UploadImage"}},"/users":{"get":{"description":"Find and filter users\n","operationId":"QueryUsers","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryUsersPayload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryUsersResponse"}}},"description":"Successful 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":"Query users","tags":["product:chat"]},"patch":{"description":"Updates certain fields of the user\n\nSends events:\n- user.presence.changed\n- user.updated\n- user.presence.changed\n","operationId":"UpdateUsersPartial","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersResponse"}}},"description":"Successful 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":"Partially update user","tags":["product:chat"]},"post":{"description":"Update or create users in bulk\n\nSends events:\n- user.updated\n","operationId":"UpdateUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersResponse"}}},"description":"Successful 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":"Upsert users","tags":["product:chat"]}},"/users/block":{"get":{"description":"Get list of blocked Users\n","operationId":"GetBlockedUsers","parameters":[{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBlockedUsersResponse"}}},"description":"Successful 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":"Get list of blocked Users","tags":["product:chat"]},"post":{"description":"Block users\n","operationId":"BlockUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUsersResponse"}}},"description":"Successful 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":"Block user","tags":["product:chat"]}},"/users/deactivate":{"post":{"description":"Deactivate users in batches\n\nSends events:\n- user.deactivated\n","operationId":"DeactivateUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeactivateUsersRequest"}}},"description":"DeactivateUsersRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeactivateUsersResponse"}}},"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":"Deactivate users","tags":["product:chat"]}},"/users/delete":{"post":{"description":"Deletes users and optionally all their belongings asynchronously.\n\nSends events:\n- channel.deleted\n- user.deleted\n","operationId":"DeleteUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteUsersResponse"}}},"description":"Successful 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":"Delete Users","tags":["product:chat"]}},"/users/live_locations":{"get":{"description":"Retrieves all active live locations for a user\n","operationId":"GetUserLiveLocations","parameters":[{"in":"query","name":"user_id","schema":{"description":"User ID to get live locations for. If not provided, returns live locations for the authenticated user.","title":"string","type":"string","writeOnly":true,"x-stream-index":"001.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SharedLocationsResponse"}}},"description":"Successful 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":"Get user live locations","tags":["product:chat"]},"put":{"description":"Updates an existing live location with new coordinates or expiration time\n","operationId":"UpdateLiveLocation","parameters":[{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"005.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateLiveLocationRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SharedLocationResponse"}}},"description":"Successful 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":"Update live location","tags":["product:chat"]}},"/users/reactivate":{"post":{"description":"Reactivate users in batches\n\nSends events:\n- user.reactivated\n- user.reactivated\n","operationId":"ReactivateUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReactivateUsersRequest"}}},"description":"ReactivateUsersRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReactivateUsersResponse"}}},"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":"Reactivate users","tags":["product:chat"]}},"/users/restore":{"post":{"description":"Restore soft deleted users\n","operationId":"RestoreUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestoreUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Restore users","tags":["product:chat"]}},"/users/unblock":{"post":{"description":"Unblock users\n","operationId":"UnblockUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUsersResponse"}}},"description":"Successful 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":"Unblock user","tags":["product:chat"]}},"/users/{user_id}/deactivate":{"post":{"description":"Deactivates user with possibility to activate it back\n\nSends events:\n- user.deactivated\n","operationId":"DeactivateUser","parameters":[{"in":"path","name":"user_id","required":true,"schema":{"title":"User ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeactivateUserRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeactivateUserResponse"}}},"description":"Successful 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":"Deactivate user","tags":["product:chat"]}},"/users/{user_id}/event":{"post":{"description":"Sends a custom event to a user\n\nSends events:\n- *\n","operationId":"SendUserCustomEvent","parameters":[{"in":"path","name":"user_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendUserCustomEventRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Send user event","tags":["product:chat"]}},"/users/{user_id}/export":{"get":{"description":"Exports the user's profile, reactions and messages. Raises an error if a user has more than 10k messages or reactions\n","operationId":"ExportUser","parameters":[{"in":"path","name":"user_id","required":true,"schema":{"title":"User ID","type":"string","x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportUserResponse"}}},"description":"Successful 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":"Export user","tags":["product:chat"]}},"/users/{user_id}/reactivate":{"post":{"description":"Activates user who's been deactivated previously\n\nSends events:\n- user.reactivated\n","operationId":"ReactivateUser","parameters":[{"in":"path","name":"user_id","required":true,"schema":{"title":"User ID","type":"string","x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReactivateUserRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReactivateUserResponse"}}},"description":"Successful 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":"Reactivate user","tags":["product:chat"]}}},"security":[{"JWT":[],"api_key":[],"stream-auth-type":[]},{"api_key":[],"stream-auth-type":[]}],"servers":[{"description":"Stream API","url":"https://chat.stream-io-api.com"}]} \ No newline at end of file +{"components":{"schemas":{"APIError":{"nullable":true,"properties":{"StatusCode":{"description":"Response HTTP status code","format":"int32","title":"Status code","type":"integer","x-stream-index":"004"},"code":{"description":"API error code","format":"int32","title":"Code","type":"integer","x-stream-index":"001"},"details":{"description":"Additional error-specific information","items":{"type":"integer"},"title":"Details","type":"array","x-stream-index":"007"},"duration":{"description":"Request duration","title":"Duration","type":"string","x-stream-index":"005"},"exception_fields":{"additionalProperties":{"type":"string"},"description":"Additional error info","title":"Exception fields","type":"object","x-stream-index":"003"},"message":{"description":"Message describing an error","title":"Message","type":"string","x-stream-index":"002"},"more_info":{"description":"URL with additional information","title":"More info","type":"string","x-stream-index":"006"},"unrecoverable":{"description":"Flag that indicates if the error is unrecoverable, requests that return unrecoverable errors should not be retried, this error only applies to the request that caused it","title":"Unrecoverable","type":"boolean","x-stream-index":"008"}},"required":["code","message","StatusCode","duration","more_info","details"],"title":"Error response","type":"object"},"APNConfig":{"properties":{"Disabled":{"type":"boolean","writeOnly":true,"x-stream-index":"005"},"auth_key":{"type":"string","x-stream-index":"006.001"},"auth_type":{"enum":["certificate","token"],"type":"string","x-stream-index":"001"},"bundle_id":{"type":"string","x-stream-index":"004"},"development":{"type":"boolean","x-stream-index":"002"},"host":{"type":"string","x-stream-index":"003"},"key_id":{"type":"string","x-stream-index":"006.002"},"notification_template":{"type":"string","x-stream-index":"008"},"p12_cert":{"type":"string","x-stream-index":"007.001"},"team_id":{"type":"string","x-stream-index":"006.003"}},"type":"object"},"APNConfigFields":{"properties":{"auth_key":{"type":"string","x-stream-index":"009"},"auth_type":{"type":"string","x-stream-index":"003"},"bundle_id":{"type":"string","x-stream-index":"006"},"development":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"host":{"type":"string","x-stream-index":"005"},"key_id":{"type":"string","x-stream-index":"008"},"notification_template":{"type":"string","x-stream-index":"004"},"p12_cert":{"type":"string","x-stream-index":"010"},"team_id":{"type":"string","x-stream-index":"007"}},"required":["enabled","development"],"type":"object"},"APNS":{"properties":{"body":{"type":"string","x-stream-index":"002"},"content-available":{"format":"int32","type":"integer","x-stream-index":"004"},"data":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"mutable-content":{"format":"int32","type":"integer","x-stream-index":"005"},"sound":{"type":"string","x-stream-index":"003"},"title":{"type":"string","x-stream-index":"001"}},"required":["title","body"],"type":"object"},"Action":{"nullable":true,"properties":{"name":{"type":"string","x-stream-index":"001"},"style":{"type":"string","x-stream-index":"003"},"text":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"004"},"value":{"type":"string","x-stream-index":"005"}},"required":["name","text","type"],"type":"object"},"ActivityMarkedEvent":{"properties":{"all_read":{"type":"boolean","x-stream-index":"006"},"all_seen":{"type":"boolean","x-stream-index":"007"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"feed_id":{"type":"string","x-stream-index":"003"},"marked_read":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"marked_watched":{"items":{"type":"string"},"type":"array","x-stream-index":"005"},"type":{"default":"activity.marked","type":"string","x-stream-index":"001.001"},"user_id":{"type":"string","x-stream-index":"002"}},"required":["type","created_at","user_id","feed_id","all_read","all_seen"],"title":"ActivityMarkedEvent","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"},"AnyEvent":{"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"*","type":"string","x-stream-index":"001.001"}},"required":["type","created_at"],"title":"AnyEvent","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"},"AppResponseFields":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"019"},"async_url_enrich_enabled":{"type":"boolean","x-stream-index":"017"},"auto_translation_enabled":{"type":"boolean","x-stream-index":"020"},"before_message_send_hook_url":{"type":"string","x-stream-index":"021"},"call_types":{"additionalProperties":{"$ref":"#/components/schemas/CallType"},"type":"object","x-stream-index":"007"},"campaign_enabled":{"type":"boolean","x-stream-index":"034"},"cdn_expiration_seconds":{"format":"int32","type":"integer","x-stream-index":"037"},"channel_configs":{"additionalProperties":{"$ref":"#/components/schemas/ChannelConfig"},"type":"object","x-stream-index":"006"},"custom_action_handler_url":{"type":"string","x-stream-index":"022"},"datadog_info":{"$ref":"#/components/schemas/DataDogInfo","x-stream-index":"040"},"disable_auth_checks":{"type":"boolean","x-stream-index":"011"},"disable_permissions_checks":{"type":"boolean","x-stream-index":"012"},"enforce_unique_usernames":{"type":"string","x-stream-index":"023"},"event_hooks":{"items":{"$ref":"#/components/schemas/EventHook"},"type":"array","x-stream-index":"045"},"file_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","x-stream-index":"030"},"geofences":{"items":{"$ref":"#/components/schemas/GeofenceResponse"},"type":"array","x-stream-index":"039"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"033"},"guest_user_creation_disabled":{"type":"boolean","x-stream-index":"043"},"image_moderation_enabled":{"type":"boolean","x-stream-index":"016"},"image_moderation_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"018"},"image_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","x-stream-index":"031"},"moderation_bulk_submit_action_enabled":{"type":"boolean","x-stream-index":"048"},"moderation_dashboard_preferences":{"$ref":"#/components/schemas/ModerationDashboardPreferences","x-stream-index":"044"},"moderation_enabled":{"type":"boolean","x-stream-index":"041"},"moderation_llm_configurability_enabled":{"type":"boolean","x-stream-index":"049"},"moderation_multitenant_blocklist_enabled":{"type":"boolean","x-stream-index":"042"},"moderation_webhook_url":{"type":"string","x-stream-index":"005"},"multi_tenant_enabled":{"type":"boolean","x-stream-index":"015"},"name":{"type":"string","x-stream-index":"001"},"organization":{"type":"string","x-stream-index":"002"},"permission_version":{"type":"string","x-stream-index":"013"},"policies":{"additionalProperties":{"items":{"$ref":"#/components/schemas/Policy"},"type":"array"},"type":"object","x-stream-index":"008"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationFields","x-stream-index":"003"},"reminders_interval":{"format":"int32","type":"integer","x-stream-index":"036"},"revoke_tokens_issued_before":{"format":"date-time","type":"string","x-stream-index":"032"},"sns_key":{"type":"string","x-stream-index":"028"},"sns_secret":{"type":"string","x-stream-index":"029"},"sns_topic_arn":{"type":"string","x-stream-index":"027"},"sqs_key":{"type":"string","x-stream-index":"025"},"sqs_secret":{"type":"string","x-stream-index":"026"},"sqs_url":{"type":"string","x-stream-index":"024"},"suspended":{"type":"boolean","x-stream-index":"009"},"suspended_explanation":{"type":"string","x-stream-index":"010"},"use_hook_v2":{"type":"boolean","x-stream-index":"046"},"user_response_time_enabled":{"type":"boolean","x-stream-index":"047"},"user_search_disallowed_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"014"},"webhook_events":{"items":{"type":"string"},"type":"array","x-stream-index":"035"},"webhook_url":{"type":"string","x-stream-index":"004"}},"required":["name","organization","push_notifications","webhook_url","moderation_webhook_url","channel_configs","call_types","policies","suspended","suspended_explanation","disable_auth_checks","disable_permissions_checks","permission_version","user_search_disallowed_roles","multi_tenant_enabled","image_moderation_enabled","async_url_enrich_enabled","auto_translation_enabled","custom_action_handler_url","enforce_unique_usernames","sqs_url","sqs_key","sqs_secret","sns_topic_arn","sns_key","sns_secret","file_upload_config","image_upload_config","grants","campaign_enabled","webhook_events","reminders_interval","cdn_expiration_seconds","video_provider","moderation_enabled","moderation_multitenant_blocklist_enabled","guest_user_creation_disabled","event_hooks","use_hook_v2","user_response_time_enabled","moderation_bulk_submit_action_enabled","moderation_llm_configurability_enabled"],"type":"object"},"AsyncBulkImageModerationEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"003.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.007"},"finished_at":{"format":"date-time","type":"string","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"string","x-stream-index":"003.004"},"started_at":{"format":"date-time","type":"string","x-stream-index":"002.002"},"task_id":{"type":"string","x-stream-index":"002.001"},"type":{"default":"export.bulk_image_moderation.success","type":"string","x-stream-index":"003.002"},"url":{"type":"string","x-stream-index":"001"}},"required":["url","task_id","started_at","finished_at","type","created_at","custom"],"title":"AsyncBulkImageModerationEvent","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"},"AsyncExportChannelsEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"003.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.007"},"finished_at":{"format":"date-time","type":"string","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"string","x-stream-index":"003.004"},"started_at":{"format":"date-time","type":"string","x-stream-index":"002.002"},"task_id":{"type":"string","x-stream-index":"002.001"},"type":{"default":"export.channels.success","type":"string","x-stream-index":"003.002"},"url":{"type":"string","x-stream-index":"001"}},"required":["url","task_id","started_at","finished_at","type","created_at","custom"],"title":"AsyncExportChannelsEvent","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"},"AsyncExportErrorEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"003.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.007"},"error":{"type":"string","x-stream-index":"001"},"finished_at":{"format":"date-time","type":"string","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"string","x-stream-index":"003.004"},"started_at":{"format":"date-time","type":"string","x-stream-index":"002.002"},"task_id":{"type":"string","x-stream-index":"002.001"},"type":{"default":"export.users.error","type":"string","x-stream-index":"003.002"}},"required":["error","task_id","started_at","finished_at","type","created_at","custom"],"title":"AsyncExportErrorEvent","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"},"AsyncExportModerationLogsEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"003.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.007"},"finished_at":{"format":"date-time","type":"string","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"string","x-stream-index":"003.004"},"started_at":{"format":"date-time","type":"string","x-stream-index":"002.002"},"task_id":{"type":"string","x-stream-index":"002.001"},"type":{"default":"export.moderation_logs.success","type":"string","x-stream-index":"003.002"},"url":{"type":"string","x-stream-index":"001"}},"required":["url","task_id","started_at","finished_at","type","created_at","custom"],"title":"AsyncExportModerationLogsEvent","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"},"AsyncExportUsersEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"003.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.007"},"finished_at":{"format":"date-time","type":"string","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"string","x-stream-index":"003.004"},"started_at":{"format":"date-time","type":"string","x-stream-index":"002.002"},"task_id":{"type":"string","x-stream-index":"002.001"},"type":{"default":"export.users.success","type":"string","x-stream-index":"003.002"},"url":{"type":"string","x-stream-index":"001"}},"required":["url","task_id","started_at","finished_at","type","created_at","custom"],"title":"AsyncExportUsersEvent","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"},"AsyncModerationCallbackConfig":{"properties":{"mode":{"enum":["CALLBACK_MODE_NONE","CALLBACK_MODE_REST","CALLBACK_MODE_TWIRP"],"type":"string","x-stream-index":"002"},"server_url":{"type":"string","x-stream-index":"001"}},"type":"object"},"AsyncModerationConfiguration":{"properties":{"callback":{"$ref":"#/components/schemas/AsyncModerationCallbackConfig","x-stream-index":"002"},"timeout_ms":{"format":"int32","type":"integer","x-stream-index":"001"}},"type":"object"},"Attachment":{"description":"An attachment is a message object that represents a file uploaded by a user.","nullable":true,"properties":{"actions":{"items":{"$ref":"#/components/schemas/Action"},"type":"array","x-stream-index":"015"},"asset_url":{"type":"string","x-stream-index":"017"},"author_icon":{"type":"string","x-stream-index":"007"},"author_link":{"type":"string","x-stream-index":"006"},"author_name":{"type":"string","x-stream-index":"005"},"color":{"type":"string","x-stream-index":"003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"018"},"fallback":{"type":"string","x-stream-index":"002"},"fields":{"items":{"$ref":"#/components/schemas/Field"},"type":"array","x-stream-index":"016"},"footer":{"type":"string","x-stream-index":"013"},"footer_icon":{"type":"string","x-stream-index":"014"},"giphy":{"$ref":"#/components/schemas/Images","x-stream-index":"019"},"image_url":{"type":"string","x-stream-index":"011"},"og_scrape_url":{"type":"string","x-stream-index":"020"},"original_height":{"format":"int32","type":"integer","x-stream-index":"022"},"original_width":{"format":"int32","type":"integer","x-stream-index":"021"},"pretext":{"type":"string","x-stream-index":"004"},"text":{"type":"string","x-stream-index":"010"},"thumb_url":{"type":"string","x-stream-index":"012"},"title":{"type":"string","x-stream-index":"008"},"title_link":{"type":"string","x-stream-index":"009"},"type":{"description":"Attachment type (e.g. image, video, url)","title":"Type","type":"string","x-stream-index":"001"}},"required":["custom"],"title":"Attachment","type":"object","x-stream-docs-page-id":"file_uploads"},"AudioSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"001"},"default_device":{"enum":["speaker","earpiece"],"type":"string","x-stream-index":"006"},"mic_default_on":{"type":"boolean","x-stream-index":"004"},"noise_cancellation":{"$ref":"#/components/schemas/NoiseCancellationSettings","x-stream-index":"007"},"opus_dtx_enabled":{"type":"boolean","x-stream-index":"002"},"redundant_coding_enabled":{"type":"boolean","x-stream-index":"003"},"speaker_default_on":{"type":"boolean","x-stream-index":"005"}},"required":["access_request_enabled","opus_dtx_enabled","redundant_coding_enabled","mic_default_on","speaker_default_on","default_device"],"type":"object"},"AutomodDetails":{"properties":{"action":{"type":"string","x-stream-index":"001"},"image_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"005"},"message_details":{"$ref":"#/components/schemas/FlagMessageDetails","x-stream-index":"004"},"original_message_type":{"type":"string","x-stream-index":"002"},"result":{"$ref":"#/components/schemas/MessageModerationResult","x-stream-index":"003"}},"type":"object"},"AzureRequest":{"description":"Config for creating Azure Blob Storage storage","properties":{"abs_account_name":{"description":"The account name","title":"AccountName","type":"string","x-stream-index":"001"},"abs_client_id":{"description":"The client id","title":"ClientID","type":"string","x-stream-index":"003"},"abs_client_secret":{"description":"The client secret","title":"ClientSecret","type":"string","x-stream-index":"004"},"abs_tenant_id":{"description":"The tenant id","title":"TenantID","type":"string","x-stream-index":"002"}},"required":["abs_account_name","abs_tenant_id","abs_client_id","abs_client_secret"],"title":"AzureRequest","type":"object"},"BackstageSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"BanRequest":{"nullable":true,"properties":{"banned_by":{"$ref":"#/components/schemas/UserRequest","description":"User who issued a ban","title":"Banned by","x-stream-index":"010"},"banned_by_id":{"description":"User ID who issued a ban","title":"Banned by ID","type":"string","x-stream-index":"009"},"channel_cid":{"description":"Channel CID to ban user in eg. messaging:123","title":"Channel CID","type":"string","x-stream-index":"006"},"delete_messages":{"enum":["soft","pruning","hard"],"type":"string","x-stream-index":"011"},"ip_ban":{"description":"Whether to perform IP ban or not","title":"IP ban","type":"boolean","x-stream-index":"008"},"reason":{"description":"Ban reason","title":"Reason","type":"string","x-stream-index":"003"},"shadow":{"description":"Whether to perform shadow ban or not","title":"Shadow","type":"boolean","x-stream-index":"007"},"target_user_id":{"description":"ID of user to ban","title":"Target user ID","type":"string","x-stream-index":"001"},"timeout":{"description":"Timeout of ban in minutes. User will be unbanned after this period of time","title":"Timeout","type":"integer","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"012.002"},"user_id":{"type":"string","x-stream-index":"012.001"}},"required":["target_user_id"],"type":"object"},"BanResponse":{"nullable":true,"properties":{"banned_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"006"},"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"007"},"expires":{"format":"date-time","type":"string","x-stream-index":"003"},"reason":{"type":"string","x-stream-index":"004"},"shadow":{"type":"boolean","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"}},"required":["created_at"],"type":"object"},"BlockListOptions":{"properties":{"behavior":{"description":"Blocklist behavior","enum":["flag","block","shadow_block"],"title":"Behavior","type":"string","x-stream-index":"002"},"blocklist":{"description":"Blocklist name","title":"Blocklist","type":"string","x-stream-index":"001"}},"required":["blocklist","behavior"],"type":"object"},"BlockListResponse":{"description":"Block list contains restricted words","properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001"},"id":{"type":"string","x-stream-index":"003"},"name":{"description":"Block list name","title":"Name","type":"string","x-stream-index":"004"},"team":{"type":"string","x-stream-index":"007"},"type":{"description":"Block list type.","title":"Type","type":"string","x-stream-index":"005"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"002"},"words":{"description":"List of words to block","items":{"type":"string"},"title":"Words","type":"array","x-stream-index":"006"}},"required":["name","type","words"],"title":"Block list","type":"object","x-stream-docs-page-id":"block_lists"},"BlockUsersRequest":{"nullable":true,"properties":{"blocked_user_id":{"description":"User id to block","title":"BlockedUserID","type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"required":["blocked_user_id"],"type":"object"},"BlockUsersResponse":{"nullable":true,"properties":{"blocked_by_user_id":{"description":"User id who blocked another user","title":"BlockedByUserID","type":"string","x-stream-index":"002"},"blocked_user_id":{"description":"User id who got blocked","title":"BlockedUserID","type":"string","x-stream-index":"003"},"created_at":{"description":"Timestamp when the user was blocked","format":"date-time","title":"CreatedAt","type":"string","x-stream-index":"004"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration","blocked_by_user_id","blocked_user_id","created_at"],"type":"object"},"BlockedUserResponse":{"nullable":true,"properties":{"blocked_user":{"$ref":"#/components/schemas/UserResponse","description":"User who got blocked","title":"User","x-stream-index":"003"},"blocked_user_id":{"description":"ID of the user who got blocked","title":"UserID","type":"string","x-stream-index":"004"},"created_at":{"format":"date-time","type":"string","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who blocked another user","title":"User","x-stream-index":"001"},"user_id":{"description":"ID of the user who blocked another user","title":"UserID","type":"string","x-stream-index":"002"}},"required":["user","user_id","blocked_user","blocked_user_id","created_at"],"type":"object"},"BroadcastSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettings","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettings","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"CallSettings":{"properties":{"audio":{"$ref":"#/components/schemas/AudioSettings","x-stream-index":"001"},"backstage":{"$ref":"#/components/schemas/BackstageSettings","x-stream-index":"002"},"broadcasting":{"$ref":"#/components/schemas/BroadcastSettings","x-stream-index":"007"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordSettings","x-stream-index":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettings","x-stream-index":"008"},"ingress":{"$ref":"#/components/schemas/IngressSettings","x-stream-index":"014"},"limits":{"$ref":"#/components/schemas/LimitsSettings","x-stream-index":"012"},"recording":{"$ref":"#/components/schemas/RecordSettings","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettings","x-stream-index":"010"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettings","x-stream-index":"004"},"session":{"$ref":"#/components/schemas/SessionSettings","x-stream-index":"013"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettings","x-stream-index":"011"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettings","x-stream-index":"009"},"video":{"$ref":"#/components/schemas/VideoSettings","x-stream-index":"003"}},"type":"object"},"CallType":{"nullable":true,"properties":{"AppPK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"003"},"CreatedAt":{"format":"date-time","type":"string","writeOnly":true,"x-stream-index":"005"},"ExternalStorage":{"type":"string","writeOnly":true,"x-stream-index":"009"},"Name":{"type":"string","writeOnly":true,"x-stream-index":"004"},"NotificationSettings":{"$ref":"#/components/schemas/NotificationSettings","x-stream-index":"008"},"PK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"002"},"Settings":{"$ref":"#/components/schemas/CallSettings","x-stream-index":"007"},"UpdatedAt":{"format":"date-time","type":"string","writeOnly":true,"x-stream-index":"006"}},"required":["PK","AppPK","Name","CreatedAt","UpdatedAt","ExternalStorage"],"type":"object"},"CampaignChannelTemplate":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"002"},"members":{"items":{"type":"string"},"maximum":1000,"type":"array","x-stream-index":"003"},"team":{"maxLength":1000,"type":"string","x-stream-index":"004"},"type":{"maxLength":64,"type":"string","x-stream-index":"001"}},"required":["type","custom"],"type":"object"},"CampaignCompletedEvent":{"nullable":true,"properties":{"campaign":{"$ref":"#/components/schemas/CampaignResponse","x-stream-index":"002"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"received_at":{"format":"date-time","type":"string","x-stream-index":"001.004"},"type":{"default":"campaign.completed","type":"string","x-stream-index":"001.002"}},"required":["type","created_at","custom"],"title":"CampaignCompletedEvent","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"},"CampaignMessageTemplate":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"maximum":30,"type":"array","x-stream-index":"002"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"poll_id":{"type":"string","x-stream-index":"003"},"text":{"type":"string","x-stream-index":"001"}},"required":["text","attachments","poll_id","custom"],"type":"object"},"CampaignResponse":{"properties":{"channel_template":{"$ref":"#/components/schemas/CampaignChannelTemplate","x-stream-index":"016"},"create_channels":{"type":"boolean","x-stream-index":"008"},"created_at":{"format":"date-time","type":"string","x-stream-index":"020"},"description":{"type":"string","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"001"},"message_template":{"$ref":"#/components/schemas/CampaignMessageTemplate","x-stream-index":"015"},"name":{"type":"string","x-stream-index":"007"},"scheduled_for":{"format":"date-time","type":"string","x-stream-index":"013"},"segment_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"002"},"segments":{"items":{"$ref":"#/components/schemas/Segment"},"type":"array","x-stream-index":"003"},"sender":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"005"},"sender_id":{"type":"string","x-stream-index":"004"},"sender_mode":{"type":"string","x-stream-index":"006"},"show_channels":{"type":"boolean","x-stream-index":"009"},"skip_push":{"type":"boolean","x-stream-index":"011"},"skip_webhook":{"type":"boolean","x-stream-index":"012"},"stats":{"$ref":"#/components/schemas/CampaignStatsResponse","x-stream-index":"022"},"status":{"type":"string","x-stream-index":"019"},"stop_at":{"format":"date-time","type":"string","x-stream-index":"014"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"021"},"user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"017"},"users":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"018"}},"required":["id","segment_ids","segments","sender_id","sender_mode","name","create_channels","show_channels","description","skip_push","skip_webhook","user_ids","users","status","created_at","updated_at","stats"],"type":"object"},"CampaignStartedEvent":{"nullable":true,"properties":{"campaign":{"$ref":"#/components/schemas/CampaignResponse","x-stream-index":"002"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"received_at":{"format":"date-time","type":"string","x-stream-index":"001.004"},"type":{"default":"campaign.started","type":"string","x-stream-index":"001.002"}},"required":["type","created_at","custom"],"title":"CampaignStartedEvent","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"},"CampaignStatsResponse":{"properties":{"progress":{"format":"float","type":"number","x-stream-index":"005"},"stats_channels_created":{"format":"int32","type":"integer","x-stream-index":"004"},"stats_completed_at":{"format":"date-time","type":"string","x-stream-index":"002"},"stats_messages_sent":{"format":"int32","type":"integer","x-stream-index":"003"},"stats_started_at":{"format":"date-time","type":"string","x-stream-index":"001"},"stats_users_read":{"format":"int32","type":"integer","x-stream-index":"007"},"stats_users_sent":{"format":"int32","type":"integer","x-stream-index":"006"}},"required":["stats_started_at","stats_completed_at","stats_messages_sent","stats_channels_created","progress","stats_users_sent","stats_users_read"],"type":"object"},"CastPollVoteRequest":{"nullable":true,"properties":{"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"005.002"},"user_id":{"type":"string","x-stream-index":"005.001"},"vote":{"$ref":"#/components/schemas/VoteData","description":"Vote data","title":"VoteData","x-stream-index":"004"}},"type":"object"},"Channel":{"properties":{"active_live_locations":{"items":{"$ref":"#/components/schemas/SharedLocation"},"type":"array","x-stream-index":"034"},"auto_translation_enabled":{"type":"boolean","x-stream-index":"029"},"auto_translation_language":{"type":"string","x-stream-index":"030"},"cid":{"type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/ChannelConfig","x-stream-index":"026"},"config_overrides":{"$ref":"#/components/schemas/ConfigOverrides","x-stream-index":"027"},"cooldown":{"format":"int32","type":"integer","x-stream-index":"031"},"created_at":{"format":"date-time","type":"string","x-stream-index":"009"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"019"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"011"},"disabled":{"type":"boolean","x-stream-index":"017"},"frozen":{"type":"boolean","x-stream-index":"016"},"id":{"type":"string","x-stream-index":"004"},"invites":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"022"},"last_campaigns":{"type":"string","x-stream-index":"032"},"last_message_at":{"format":"date-time","type":"string","x-stream-index":"006"},"member_count":{"format":"int32","type":"integer","x-stream-index":"021"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"020"},"message_count":{"format":"int64","type":"integer","x-stream-index":"035"},"message_count_updated_at":{"format":"date-time","type":"string","x-stream-index":"036"},"team":{"type":"string","x-stream-index":"028"},"truncated_by":{"$ref":"#/components/schemas/User","x-stream-index":"015"},"type":{"type":"string","x-stream-index":"005"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"010"}},"required":["cid","id","type","created_at","updated_at","frozen","disabled","custom","auto_translation_language"],"type":"object"},"ChannelConfig":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.027"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.022"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.023"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.028"},"blocklist":{"type":"string","x-stream-index":"001.024"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.025"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.026"},"commands":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"connect_events":{"type":"boolean","x-stream-index":"001.004"},"count_messages":{"type":"boolean","x-stream-index":"001.019"},"created_at":{"format":"date-time","type":"string","x-stream-index":"002.003"},"custom_events":{"type":"boolean","x-stream-index":"001.012"},"mark_messages_pending":{"type":"boolean","x-stream-index":"001.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"001.021"},"mutes":{"type":"boolean","x-stream-index":"001.009"},"name":{"type":"string","x-stream-index":"001.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"001.029"},"partition_ttl":{"type":"integer","x-stream-index":"001.030"},"polls":{"type":"boolean","x-stream-index":"001.016"},"push_notifications":{"type":"boolean","x-stream-index":"001.013"},"quotes":{"type":"boolean","x-stream-index":"001.008"},"reactions":{"type":"boolean","x-stream-index":"001.006"},"read_events":{"type":"boolean","x-stream-index":"001.003"},"reminders":{"type":"boolean","x-stream-index":"001.014"},"replies":{"type":"boolean","x-stream-index":"001.007"},"search":{"type":"boolean","x-stream-index":"001.005"},"shared_locations":{"type":"boolean","x-stream-index":"001.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.031"},"typing_events":{"type":"boolean","x-stream-index":"001.002"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"002.004"},"uploads":{"type":"boolean","x-stream-index":"001.010"},"url_enrichment":{"type":"boolean","x-stream-index":"001.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"001.017"}},"required":["name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","count_messages","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","created_at","updated_at","commands"],"type":"object"},"ChannelConfigWithInfo":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.002.027"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.002.022"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.023"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.002.028"},"blocklist":{"type":"string","x-stream-index":"001.002.024"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.025"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.002.026"},"commands":{"items":{"$ref":"#/components/schemas/Command"},"type":"array","x-stream-index":"001.003"},"connect_events":{"type":"boolean","x-stream-index":"001.002.004"},"count_messages":{"type":"boolean","x-stream-index":"001.002.019"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.001.003"},"custom_events":{"type":"boolean","x-stream-index":"001.002.012"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"002"},"mark_messages_pending":{"type":"boolean","x-stream-index":"001.002.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"001.002.021"},"mutes":{"type":"boolean","x-stream-index":"001.002.009"},"name":{"type":"string","x-stream-index":"001.002.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"001.002.029"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"001.002.030"},"polls":{"type":"boolean","x-stream-index":"001.002.016"},"push_notifications":{"type":"boolean","x-stream-index":"001.002.013"},"quotes":{"type":"boolean","x-stream-index":"001.002.008"},"reactions":{"type":"boolean","x-stream-index":"001.002.006"},"read_events":{"type":"boolean","x-stream-index":"001.002.003"},"reminders":{"type":"boolean","x-stream-index":"001.002.014"},"replies":{"type":"boolean","x-stream-index":"001.002.007"},"search":{"type":"boolean","x-stream-index":"001.002.005"},"shared_locations":{"type":"boolean","x-stream-index":"001.002.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.002.031"},"typing_events":{"type":"boolean","x-stream-index":"001.002.002"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"001.001.004"},"uploads":{"type":"boolean","x-stream-index":"001.002.010"},"url_enrichment":{"type":"boolean","x-stream-index":"001.002.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"001.002.017"}},"required":["created_at","updated_at","name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","count_messages","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","commands"],"type":"object"},"ChannelCreatedEvent":{"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"channel.created","type":"string","x-stream-index":"001.001"}},"required":["type","created_at"],"title":"ChannelCreatedEvent","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"},"ChannelDeletedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003.004"},"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"003.005"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"002.002"},"team":{"type":"string","x-stream-index":"001.001"},"type":{"default":"channel.deleted","type":"string","x-stream-index":"002.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"ChannelDeletedEvent","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"},"ChannelExport":{"properties":{"cid":{"type":"string","x-stream-index":"003"},"id":{"description":"Channel ID","title":"ID","type":"string","x-stream-index":"002"},"messages_since":{"description":"Date to export messages since","format":"date-time","title":"Messages since","type":"string","x-stream-index":"004"},"messages_until":{"description":"Date to export messages until","format":"date-time","title":"Messages until","type":"string","x-stream-index":"005"},"type":{"description":"Channel type","title":"Type","type":"string","x-stream-index":"001"}},"title":"Channel Export","type":"object"},"ChannelFrozenEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"channel.frozen","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"ChannelFrozenEvent","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"},"ChannelGetOrCreateRequest":{"nullable":true,"properties":{"data":{"$ref":"#/components/schemas/ChannelInput","x-stream-index":"003"},"hide_for_creator":{"description":"Whether this channel will be hidden for the user who created the channel or not","title":"Hide for creator","type":"boolean","x-stream-index":"007"},"members":{"$ref":"#/components/schemas/PaginationParams","x-stream-index":"010"},"messages":{"$ref":"#/components/schemas/MessagePaginationParams","x-stream-index":"009"},"state":{"description":"Refresh channel state","title":"State","type":"boolean","x-stream-index":"005"},"thread_unread_counts":{"type":"boolean","x-stream-index":"008"},"watchers":{"$ref":"#/components/schemas/PaginationParams","x-stream-index":"011"}},"type":"object"},"ChannelHiddenEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003.004"},"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"003.005"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"clear_history":{"type":"boolean","x-stream-index":"001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"004.002"},"type":{"default":"channel.hidden","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["clear_history","cid","channel_id","channel_type","channel_member_count","type","created_at"],"title":"ChannelHiddenEvent","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"},"ChannelInput":{"properties":{"auto_translation_enabled":{"description":"Enable or disable auto translation","title":"Auto translation","type":"boolean","x-stream-index":"005"},"auto_translation_language":{"description":"Switch auto translation language","title":"Auto translation language","type":"string","x-stream-index":"006"},"config_overrides":{"$ref":"#/components/schemas/ChannelConfig","x-stream-index":"024"},"created_by":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"009"},"created_by_id":{"type":"string","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"015"},"disabled":{"type":"boolean","x-stream-index":"014"},"frozen":{"description":"Freeze or unfreeze the channel","title":"Frozen","type":"boolean","x-stream-index":"013"},"invites":{"items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"type":"array","x-stream-index":"016"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"type":"array","x-stream-index":"018"},"team":{"description":"Team the channel belongs to (if multi-tenant mode is enabled)","title":"Team","type":"string","x-stream-index":"004"},"truncated_by_id":{"type":"string","x-stream-index":"010"}},"type":"object"},"ChannelMember":{"nullable":true,"properties":{"archived_at":{"format":"date-time","type":"string","x-stream-index":"015"},"ban_expires":{"description":"Expiration date of the ban","format":"date-time","title":"Ban expires","type":"string","x-stream-index":"013"},"banned":{"description":"Whether member is banned this channel or not","title":"Banned","type":"boolean","x-stream-index":"012"},"channel_role":{"description":"Role of the member in the channel","title":"Channel Role","type":"string","x-stream-index":"018"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"011"},"deleted_messages":{"items":{"type":"string"},"type":"array","x-stream-index":"020"},"invite_accepted_at":{"description":"Date when invite was accepted","format":"date-time","title":"Invited accepted at","type":"string","x-stream-index":"006"},"invite_rejected_at":{"description":"Date when invite was rejected","format":"date-time","title":"Invited rejected at","type":"string","x-stream-index":"007"},"invited":{"description":"Whether member was invited or not","title":"Invited","type":"boolean","x-stream-index":"005"},"is_moderator":{"description":"Whether member is channel moderator or not","title":"Is moderator","type":"boolean","x-stream-index":"003"},"notifications_muted":{"type":"boolean","x-stream-index":"019"},"pinned_at":{"format":"date-time","type":"string","x-stream-index":"016"},"role":{"description":"Permission level of the member in the channel (DEPRECATED: use channel_role instead)","enum":["member","moderator","admin","owner"],"title":"Role","type":"string","x-stream-index":"017"},"shadow_banned":{"description":"Whether member is shadow banned in this channel or not","title":"Shadow banned","type":"boolean","x-stream-index":"014"},"status":{"type":"string","x-stream-index":"008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"},"user_id":{"title":"User ID","type":"string","x-stream-index":"001"}},"required":["custom","created_at","updated_at","banned","shadow_banned","channel_role","notifications_muted"],"title":"Channel member","type":"object"},"ChannelMemberResponse":{"nullable":true,"properties":{"archived_at":{"format":"date-time","type":"string","x-stream-index":"016"},"ban_expires":{"description":"Expiration date of the ban","format":"date-time","title":"Ban expires","type":"string","x-stream-index":"013"},"banned":{"description":"Whether member is banned this channel or not","title":"Banned","type":"boolean","x-stream-index":"012"},"channel_role":{"description":"Role of the member in the channel","title":"Channel Role","type":"string","x-stream-index":"018"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"011"},"invite_accepted_at":{"description":"Date when invite was accepted","format":"date-time","title":"Invited accepted at","type":"string","x-stream-index":"006"},"invite_rejected_at":{"description":"Date when invite was rejected","format":"date-time","title":"Invited rejected at","type":"string","x-stream-index":"007"},"invited":{"description":"Whether member was invited or not","title":"Invited","type":"boolean","x-stream-index":"005"},"is_moderator":{"description":"Whether member is channel moderator or not","title":"Is moderator","type":"boolean","x-stream-index":"003"},"notifications_muted":{"type":"boolean","x-stream-index":"019"},"pinned_at":{"format":"date-time","type":"string","x-stream-index":"015"},"role":{"description":"Permission level of the member in the channel (DEPRECATED: use channel_role instead)","enum":["member","moderator","admin","owner"],"title":"Role","type":"string","x-stream-index":"017"},"shadow_banned":{"description":"Whether member is shadow banned in this channel or not","title":"Shadow banned","type":"boolean","x-stream-index":"014"},"status":{"type":"string","x-stream-index":"008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"},"user_id":{"title":"User ID","type":"string","x-stream-index":"001"}},"required":["custom","created_at","updated_at","banned","shadow_banned","channel_role","notifications_muted"],"title":"Channel member","type":"object"},"ChannelMessages":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001"},"messages":{"items":{"$ref":"#/components/schemas/Message"},"type":"array","x-stream-index":"002"}},"required":["messages"],"type":"object"},"ChannelMute":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel that is muted","title":"Channel","x-stream-index":"002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"004"},"expires":{"description":"Date/time of mute expiration","format":"date-time","title":"Expires","type":"string","x-stream-index":"003"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Owner of channel mute","title":"User","x-stream-index":"001"}},"required":["created_at","updated_at"],"type":"object"},"ChannelMutedEvent":{"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"channel.muted","type":"string","x-stream-index":"001.001"}},"required":["type","created_at"],"title":"ChannelMutedEvent","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"},"ChannelOwnCapability":{"description":"All possibility of string to use","enum":["ban-channel-members","cast-poll-vote","connect-events","create-attachment","delete-any-message","delete-channel","delete-own-message","flag-message","freeze-channel","join-channel","leave-channel","mute-channel","pin-message","query-poll-votes","quote-message","read-events","search-messages","send-custom-events","send-links","send-message","send-poll","send-reaction","send-reply","send-restricted-visibility-message","send-typing-events","set-channel-cooldown","share-location","skip-slow-mode","slow-mode","typing-events","update-any-message","update-channel","update-channel-members","update-own-message","update-thread","upload-file"],"title":"ChannelOwnCapability","type":"string"},"ChannelPushPreferences":{"properties":{"chat_level":{"type":"string","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"string","x-stream-index":"002"}},"type":"object"},"ChannelResponse":{"description":"Represents channel in chat","properties":{"auto_translation_enabled":{"description":"Whether auto translation is enabled or not","title":"Auto translation","type":"boolean","x-stream-index":"017"},"auto_translation_language":{"description":"Language to translate to when auto translation is active","title":"Auto translation language","type":"string","x-stream-index":"018"},"blocked":{"description":"Whether this channel is blocked by current user or not","title":"Blocked","type":"boolean","x-stream-index":"023"},"cid":{"description":"Channel CID (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/ChannelConfigWithInfo","description":"Channel configuration","title":"ChannelConfigWithInfo","x-stream-index":"013"},"cooldown":{"description":"Cooldown period after sending each message","format":"int32","title":"Cooldown","type":"integer","x-stream-index":"020"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"005"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"Creator of the channel","title":"UserResponse","x-stream-index":"008"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"026"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"string","x-stream-index":"007"},"disabled":{"type":"boolean","x-stream-index":"010"},"frozen":{"description":"Whether channel is frozen or not","title":"Frozen","type":"boolean","x-stream-index":"009"},"hidden":{"description":"Whether this channel is hidden by current user or not","title":"Hidden","type":"boolean","x-stream-index":"022"},"hide_messages_before":{"description":"Date since when the message history is accessible","format":"date-time","title":"Hide messages before","type":"string","x-stream-index":"019"},"id":{"description":"Channel unique ID","title":"ID","type":"string","x-stream-index":"001"},"last_message_at":{"description":"Date of the last message sent","format":"date-time","title":"Last message at","type":"string","x-stream-index":"004"},"member_count":{"description":"Number of members in the channel","format":"int32","title":"Member count","type":"integer","x-stream-index":"012"},"members":{"description":"List of channel members (max 100)","items":{"$ref":"#/components/schemas/ChannelMember"},"title":"ChannelMembers","type":"array","x-stream-index":"011"},"message_count":{"description":"Number of messages in the channel","format":"int64","title":"Message count","type":"integer","x-stream-index":"027"},"mute_expires_at":{"description":"Date of mute expiration","format":"date-time","title":"Mute expires at","type":"string","x-stream-index":"015"},"muted":{"description":"Whether this channel is muted or not","title":"Muted","type":"boolean","x-stream-index":"014"},"own_capabilities":{"description":"List of channel capabilities of authenticated user","items":{"$ref":"#/components/schemas/ChannelOwnCapability"},"title":"ChannelOwnCapability","type":"array","x-stream-index":"021"},"team":{"description":"Team the channel belongs to (multi-tenant only)","title":"Team","type":"string","x-stream-index":"016"},"truncated_at":{"description":"Date of the latest truncation of the channel","format":"date-time","title":"UserResponse","type":"string","x-stream-index":"024"},"truncated_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"025"},"type":{"description":"Type of the channel","title":"Type","type":"string","x-stream-docs-page-id":"channel_features","x-stream-index":"002"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"006"}},"required":["id","type","cid","created_at","updated_at","frozen","disabled","custom"],"title":"Channel","type":"object"},"ChannelStateResponse":{"nullable":true,"properties":{"active_live_locations":{"items":{"$ref":"#/components/schemas/SharedLocationResponseData"},"type":"array","x-stream-index":"001.015"},"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001.001"},"deleted_messages":{"items":{"type":"string"},"type":"array","x-stream-index":"001.016"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001.014"},"duration":{"type":"string","x-stream-index":"002.001"},"hidden":{"type":"boolean","x-stream-index":"001.011"},"hide_messages_before":{"format":"date-time","type":"string","x-stream-index":"001.012"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"001.007"},"membership":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"001.008"},"messages":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","x-stream-index":"001.002"},"pending_messages":{"items":{"$ref":"#/components/schemas/PendingMessageResponse"},"type":"array","x-stream-index":"001.013"},"pinned_messages":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","x-stream-index":"001.003"},"push_preferences":{"$ref":"#/components/schemas/ChannelPushPreferences","x-stream-index":"001.009"},"read":{"items":{"$ref":"#/components/schemas/ReadStateResponse"},"type":"array","x-stream-index":"001.006"},"threads":{"items":{"$ref":"#/components/schemas/ThreadStateResponse"},"type":"array","x-stream-index":"001.010"},"watcher_count":{"format":"int32","type":"integer","x-stream-index":"001.004"},"watchers":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"001.005"}},"required":["messages","pinned_messages","members","threads","duration"],"type":"object"},"ChannelStateResponseFields":{"properties":{"active_live_locations":{"description":"Active live locations in the channel","items":{"$ref":"#/components/schemas/SharedLocationResponseData"},"title":"Active Live Locations","type":"array","x-stream-index":"015"},"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001"},"deleted_messages":{"items":{"type":"string"},"type":"array","x-stream-index":"016"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"014"},"hidden":{"description":"Whether this channel is hidden or not","title":"Hidden","type":"boolean","x-stream-index":"011"},"hide_messages_before":{"description":"Messages before this date are hidden from the user","format":"date-time","title":"Hide messages before","type":"string","x-stream-index":"012"},"members":{"description":"List of channel members","items":{"$ref":"#/components/schemas/ChannelMember"},"title":"Members","type":"array","x-stream-index":"007"},"membership":{"$ref":"#/components/schemas/ChannelMember","description":"Current user membership object","title":"Membership","x-stream-index":"008"},"messages":{"description":"List of channel messages","items":{"$ref":"#/components/schemas/MessageResponse"},"title":"Message","type":"array","x-stream-index":"002"},"pending_messages":{"description":"Pending messages that this user has sent","items":{"$ref":"#/components/schemas/PendingMessageResponse"},"title":"Pending messages","type":"array","x-stream-index":"013"},"pinned_messages":{"description":"List of pinned messages in the channel","items":{"$ref":"#/components/schemas/MessageResponse"},"title":"Pinned messages","type":"array","x-stream-docs-page-id":"pinned_messages","x-stream-index":"003"},"push_preferences":{"$ref":"#/components/schemas/ChannelPushPreferences","x-stream-index":"009"},"read":{"description":"List of read states","items":{"$ref":"#/components/schemas/ReadStateResponse"},"title":"Read","type":"array","x-stream-index":"006"},"threads":{"items":{"$ref":"#/components/schemas/ThreadStateResponse"},"type":"array","x-stream-index":"010"},"watcher_count":{"description":"Number of channel watchers","format":"int32","title":"Watcher count","type":"integer","x-stream-index":"004"},"watchers":{"description":"List of user who is watching the channel","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Watchers","type":"array","x-stream-index":"005"}},"required":["messages","pinned_messages","members","threads"],"type":"object"},"ChannelTruncatedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001.004"},"channel_id":{"type":"string","x-stream-index":"001.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"001.005"},"channel_type":{"type":"string","x-stream-index":"001.003"},"cid":{"type":"string","x-stream-index":"001.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"002.002"},"type":{"default":"channel.truncated","type":"string","x-stream-index":"002.001"}},"required":["cid","channel_id","channel_type","channel_member_count","type","created_at"],"title":"ChannelTruncatedEvent","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"},"ChannelTypeConfig":{"nullable":true,"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"003.002.027"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"003.002.022"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.002.023"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"003.002.028"},"blocklist":{"type":"string","x-stream-index":"003.002.024"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.002.025"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"003.002.026"},"commands":{"items":{"$ref":"#/components/schemas/Command"},"type":"array","x-stream-index":"003.003"},"connect_events":{"type":"boolean","x-stream-index":"003.002.004"},"count_messages":{"type":"boolean","x-stream-index":"003.002.019"},"created_at":{"format":"date-time","type":"string","x-stream-index":"003.001.003"},"custom_events":{"type":"boolean","x-stream-index":"003.002.012"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"002"},"mark_messages_pending":{"type":"boolean","x-stream-index":"003.002.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"003.002.021"},"mutes":{"type":"boolean","x-stream-index":"003.002.009"},"name":{"type":"string","x-stream-index":"003.002.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"003.002.029"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"003.002.030"},"permissions":{"items":{"$ref":"#/components/schemas/PolicyRequest"},"type":"array","x-stream-index":"001"},"polls":{"type":"boolean","x-stream-index":"003.002.016"},"push_notifications":{"type":"boolean","x-stream-index":"003.002.013"},"quotes":{"type":"boolean","x-stream-index":"003.002.008"},"reactions":{"type":"boolean","x-stream-index":"003.002.006"},"read_events":{"type":"boolean","x-stream-index":"003.002.003"},"reminders":{"type":"boolean","x-stream-index":"003.002.014"},"replies":{"type":"boolean","x-stream-index":"003.002.007"},"search":{"type":"boolean","x-stream-index":"003.002.005"},"shared_locations":{"type":"boolean","x-stream-index":"003.002.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"003.002.031"},"typing_events":{"type":"boolean","x-stream-index":"003.002.002"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"003.001.004"},"uploads":{"type":"boolean","x-stream-index":"003.002.010"},"url_enrichment":{"type":"boolean","x-stream-index":"003.002.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"003.002.017"}},"required":["permissions","grants","created_at","updated_at","name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","count_messages","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","commands"],"type":"object"},"ChannelUnFrozenEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"channel.unfrozen","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"ChannelUnFrozenEvent","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"},"ChannelUnmutedEvent":{"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"channel.unmuted","type":"string","x-stream-index":"001.001"}},"required":["type","created_at"],"title":"ChannelUnmutedEvent","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"},"ChannelUpdatedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"004.004"},"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"004.005"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"003.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"002.001"},"type":{"default":"channel.updated","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"ChannelUpdatedEvent","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"},"ChannelVisibleEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"001.002"},"channel_type":{"type":"string","x-stream-index":"001.003"},"cid":{"type":"string","x-stream-index":"001.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"003.002"},"type":{"default":"channel.visible","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"ChannelVisibleEvent","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"},"CheckExternalStorageResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"file_url":{"type":"string","x-stream-index":"002"}},"required":["duration","file_url"],"title":"Response","type":"object"},"CheckPushRequest":{"description":"Check push request","nullable":true,"properties":{"apn_template":{"description":"Push message template for APN","title":"APN template","type":"string","x-stream-docs-page-id":"push_template","x-stream-index":"002"},"event_type":{"description":"Type of event for push templates (default: message.new)","enum":["message.new","message.updated","reaction.new","reaction.updated","notification.reminder_due"],"title":"Event type","type":"string","x-stream-index":"008"},"firebase_data_template":{"description":"Push message data template for Firebase","title":"Firebase data template","type":"string","x-stream-docs-page-id":"push_template","x-stream-index":"004"},"firebase_template":{"description":"Push message template for Firebase","title":"Firebase template","type":"string","x-stream-docs-page-id":"push_template","x-stream-index":"003"},"message_id":{"description":"Message ID to send push notification for","title":"Message ID","type":"string","x-stream-index":"001"},"push_provider_name":{"description":"Name of push provider","title":"Name of push provider","type":"string","x-stream-index":"007"},"push_provider_type":{"description":"Push provider type","enum":["firebase","apn","huawei","xiaomi"],"title":"Type of push provider","type":"string","x-stream-index":"006"},"skip_devices":{"description":"Don't require existing devices to render templates","title":"Skip devices","type":"boolean","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"009.002"},"user_id":{"type":"string","x-stream-index":"009.001"}},"title":"CheckPushRequest","type":"object"},"CheckPushResponse":{"nullable":true,"properties":{"device_errors":{"additionalProperties":{"$ref":"#/components/schemas/DeviceErrorInfo"},"description":"Object with device errors","title":"Device errors","type":"object","x-stream-index":"001","x-stream-map":{"key":"device_id"}},"duration":{"type":"string","x-stream-index":"008.001"},"event_type":{"description":"The event type that was tested","title":"Event type","type":"string","x-stream-index":"004"},"general_errors":{"description":"List of general errors","items":{"type":"string"},"title":"General errors","type":"array","x-stream-index":"002"},"rendered_apn_template":{"title":"Rendered APN template","type":"string","x-stream-index":"005"},"rendered_firebase_template":{"title":"Rendered Firebase template","type":"string","x-stream-index":"006"},"rendered_message":{"additionalProperties":{"type":"string"},"title":"Rendered message","type":"object","x-stream-index":"007"},"skip_devices":{"description":"Don't require existing devices to render templates","title":"Skip devices","type":"boolean","x-stream-index":"003"}},"required":["duration"],"type":"object"},"CheckSNSRequest":{"nullable":true,"properties":{"sns_key":{"description":"AWS SNS access key","title":"SNS key","type":"string","x-stream-index":"002"},"sns_secret":{"description":"AWS SNS key secret","title":"SNS secret","type":"string","x-stream-index":"003"},"sns_topic_arn":{"description":"AWS SNS topic ARN","title":"SNS Topic ARN","type":"string","x-stream-index":"001"}},"type":"object"},"CheckSNSResponse":{"nullable":true,"properties":{"data":{"additionalProperties":{},"description":"Error data","title":"ReadOnlyData","type":"object","x-stream-index":"003"},"duration":{"type":"string","x-stream-index":"004.001"},"error":{"description":"Error text","title":"Error","type":"string","x-stream-index":"002"},"status":{"description":"Validation result","enum":["ok","error"],"title":"Status","type":"string","x-stream-index":"001"}},"required":["status","duration"],"type":"object"},"CheckSQSRequest":{"nullable":true,"properties":{"sqs_key":{"description":"AWS SQS access key","title":"SQS key","type":"string","x-stream-index":"002"},"sqs_secret":{"description":"AWS SQS key secret","title":"SQS secret","type":"string","x-stream-index":"003"},"sqs_url":{"description":"AWS SQS endpoint URL","title":"SQS URL","type":"string","x-stream-index":"001"}},"type":"object"},"CheckSQSResponse":{"nullable":true,"properties":{"data":{"additionalProperties":{},"description":"Error data","title":"ReadOnlyData","type":"object","x-stream-index":"003"},"duration":{"type":"string","x-stream-index":"004.001"},"error":{"description":"Error text","title":"Error","type":"string","x-stream-index":"002"},"status":{"description":"Validation result","enum":["ok","error"],"title":"Status","type":"string","x-stream-index":"001"}},"required":["status","duration"],"type":"object"},"Command":{"description":"Represents custom chat command","nullable":true,"properties":{"args":{"description":"Arguments help text, shown in commands auto-completion","title":"Arguments","type":"string","x-stream-index":"006"},"created_at":{"description":"Date/time of creation","format":"date-time","readOnly":true,"title":"Created at","type":"string","x-stream-index":"001"},"description":{"description":"Description, shown in commands auto-completion","title":"Description","type":"string","x-stream-index":"005"},"name":{"description":"Unique command name","title":"Name","type":"string","x-stream-index":"004"},"set":{"description":"Set name used for grouping commands","title":"Set","type":"string","x-stream-index":"007"},"updated_at":{"description":"Date/time of the last update","format":"date-time","readOnly":true,"title":"Updated at","type":"string","x-stream-index":"002"}},"required":["name","description","args","set"],"title":"Command","type":"object"},"CommitMessageRequest":{"nullable":true,"type":"object"},"ConfigOverrides":{"properties":{"blocklist":{"type":"string","x-stream-index":"008"},"blocklist_behavior":{"enum":["flag","block"],"type":"string","x-stream-index":"009"},"commands":{"items":{"type":"string"},"type":"array","x-stream-index":"011"},"count_messages":{"type":"boolean","x-stream-index":"014"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"010"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"007"},"quotes":{"type":"boolean","x-stream-index":"004"},"reactions":{"type":"boolean","x-stream-index":"002"},"replies":{"type":"boolean","x-stream-index":"003"},"shared_locations":{"type":"boolean","x-stream-index":"013"},"typing_events":{"type":"boolean","x-stream-index":"001"},"uploads":{"type":"boolean","x-stream-index":"005"},"url_enrichment":{"type":"boolean","x-stream-index":"006"},"user_message_reminders":{"type":"boolean","x-stream-index":"012"}},"required":["grants","commands"],"type":"object"},"CreateBlockListRequest":{"description":"Block list contains restricted words","nullable":true,"properties":{"name":{"description":"Block list name","maxLength":255,"title":"Name","type":"string","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"004"},"type":{"description":"Block list type.","enum":["regex","domain","domain_allowlist","email","word"],"title":"Type","type":"string","x-stream-index":"003"},"words":{"description":"List of words to block","items":{"type":"string"},"minimum":1,"title":"Words","type":"array","x-stream-index":"002"}},"required":["name","words"],"title":"Block list","type":"object","x-stream-docs-page-id":"block_lists"},"CreateBlockListResponse":{"description":"Basic response information","nullable":true,"properties":{"blocklist":{"$ref":"#/components/schemas/BlockListResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["duration"],"title":"Response","type":"object"},"CreateChannelTypeRequest":{"nullable":true,"properties":{"automod":{"description":"Automod","enum":["disabled","simple","AI"],"title":"Automod","type":"string","x-stream-index":"019"},"automod_behavior":{"description":"Automod behavior","enum":["flag","block"],"title":"Automod behavior","type":"string","x-stream-index":"020"},"blocklist":{"description":"Blocklist","title":"Blocklist","type":"string","x-stream-index":"024"},"blocklist_behavior":{"description":"Blocklist behavior","enum":["flag","block","shadow_block"],"title":"Blocklist behavior","type":"string","x-stream-index":"025"},"blocklists":{"description":"Blocklists","items":{"$ref":"#/components/schemas/BlockListOptions"},"title":"Blocklists","type":"array","x-stream-index":"026"},"commands":{"description":"List of commands that channel supports","items":{"type":"string"},"title":"Commands","type":"array","x-stream-index":"021"},"connect_events":{"description":"Connect events","title":"Connect events","type":"boolean","x-stream-index":"004"},"custom_events":{"description":"Custom events","title":"Custom events","type":"boolean","x-stream-index":"011"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"List of grants for the channel type","title":"Grants","type":"object","x-stream-index":"023"},"mark_messages_pending":{"description":"Mark messages pending","title":"Mark messages pending","type":"boolean","x-stream-index":"013"},"max_message_length":{"description":"Max message length","format":"int32","title":"Max message length","type":"integer","x-stream-index":"018"},"message_retention":{"description":"Message retention","enum":["infinite","numeric"],"title":"Message retention","type":"string","x-stream-index":"017"},"mutes":{"description":"Mutes","title":"Mutes","type":"boolean","x-stream-index":"008"},"name":{"description":"Channel type name","title":"Name","type":"string","x-stream-index":"001"},"partition_size":{"description":"Partition size","format":"int32","minimum":10,"title":"Partition size","type":"integer","x-stream-index":"027"},"partition_ttl":{"description":"Partition TTL","example":"24h","format":"duration","nullable":true,"title":"Partition TTL","type":"string","x-stream-index":"028"},"permissions":{"description":"List of permissions for the channel type","items":{"$ref":"#/components/schemas/PolicyRequest"},"title":"Permissions","type":"array","x-stream-index":"022"},"polls":{"description":"Polls","title":"Polls","type":"boolean","x-stream-index":"014"},"push_notifications":{"description":"Push notifications","title":"Push notifications","type":"boolean","x-stream-index":"012"},"reactions":{"description":"Reactions","title":"Reactions","type":"boolean","x-stream-index":"005"},"read_events":{"description":"Read events","title":"Read events","type":"boolean","x-stream-index":"003"},"replies":{"description":"Replies","title":"Replies","type":"boolean","x-stream-index":"006"},"search":{"description":"Search","title":"Search","type":"boolean","x-stream-index":"007"},"shared_locations":{"description":"Enables shared location messages","title":"Shared locations","type":"boolean","x-stream-index":"016"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"029"},"typing_events":{"description":"Typing events","title":"Typing events","type":"boolean","x-stream-index":"002"},"uploads":{"description":"Uploads","title":"Uploads","type":"boolean","x-stream-index":"009"},"url_enrichment":{"description":"URL enrichment","title":"URL enrichment","type":"boolean","x-stream-index":"010"},"user_message_reminders":{"type":"boolean","x-stream-index":"015"}},"required":["name","max_message_length","automod","automod_behavior"],"title":"CreateChannelTypeRequest","type":"object"},"CreateChannelTypeResponse":{"nullable":true,"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.001.027"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.001.022"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.001.023"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.001.028"},"blocklist":{"type":"string","x-stream-index":"001.001.024"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.001.025"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.001.026"},"commands":{"items":{"type":"string"},"type":"array","x-stream-index":"001.003"},"connect_events":{"type":"boolean","x-stream-index":"001.001.004"},"count_messages":{"type":"boolean","x-stream-index":"001.001.019"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002.003"},"custom_events":{"type":"boolean","x-stream-index":"001.001.012"},"duration":{"type":"string","x-stream-index":"004.001"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"003"},"mark_messages_pending":{"type":"boolean","x-stream-index":"001.001.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"001.001.021"},"mutes":{"type":"boolean","x-stream-index":"001.001.009"},"name":{"type":"string","x-stream-index":"001.001.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"001.001.029"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"001.001.030"},"permissions":{"items":{"$ref":"#/components/schemas/PolicyRequest"},"type":"array","x-stream-index":"002"},"polls":{"type":"boolean","x-stream-index":"001.001.016"},"push_notifications":{"type":"boolean","x-stream-index":"001.001.013"},"quotes":{"type":"boolean","x-stream-index":"001.001.008"},"reactions":{"type":"boolean","x-stream-index":"001.001.006"},"read_events":{"type":"boolean","x-stream-index":"001.001.003"},"reminders":{"type":"boolean","x-stream-index":"001.001.014"},"replies":{"type":"boolean","x-stream-index":"001.001.007"},"search":{"type":"boolean","x-stream-index":"001.001.005"},"shared_locations":{"type":"boolean","x-stream-index":"001.001.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.001.031"},"typing_events":{"type":"boolean","x-stream-index":"001.001.002"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"001.002.004"},"uploads":{"type":"boolean","x-stream-index":"001.001.010"},"url_enrichment":{"type":"boolean","x-stream-index":"001.001.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"001.001.017"}},"required":["name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","count_messages","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","created_at","updated_at","commands","permissions","grants","duration"],"type":"object"},"CreateCommandRequest":{"description":"Create a new command","nullable":true,"properties":{"args":{"description":"Arguments help text, shown in commands auto-completion","maxLength":255,"title":"Arguments","type":"string","x-stream-index":"003"},"description":{"description":"Description, shown in commands auto-completion","maxLength":255,"title":"Description","type":"string","x-stream-index":"002"},"name":{"description":"Unique command name","maxLength":255,"minLength":1,"title":"Name","type":"string","x-stream-index":"001"},"set":{"description":"Set name used for grouping commands","maxLength":255,"title":"Set","type":"string","x-stream-index":"004"}},"required":["name","description"],"title":"CreateCommandRequest","type":"object"},"CreateCommandResponse":{"nullable":true,"properties":{"command":{"$ref":"#/components/schemas/Command","description":"Command object","title":"Command","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["duration"],"title":"CreateCommandResponse","type":"object"},"CreateDeviceRequest":{"description":"Create device request","nullable":true,"properties":{"id":{"description":"Device ID","maxLength":255,"minLength":1,"title":"ID","type":"string","x-stream-index":"001"},"push_provider":{"description":"Push provider","enum":["firebase","apn","huawei","xiaomi"],"title":"PushProvider","type":"string","x-stream-index":"002"},"push_provider_name":{"description":"Push provider name","title":"PushProviderName","type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"005.002"},"user_id":{"description":"**Server-side only**. User ID which server acts upon","title":"User ID","type":"string","x-stream-index":"005.001"},"voip_token":{"description":"When true the token is for Apple VoIP push notifications","title":"VoipToken","type":"boolean","x-stream-index":"004"}},"required":["id","push_provider"],"title":"CreateDeviceRequest","type":"object"},"CreateExternalStorageRequest":{"description":"Create external storage","nullable":true,"properties":{"aws_s3":{"$ref":"#/components/schemas/S3Request","description":"Only required if you want to create an Amazon S3 storage","title":"AwsS3","x-stream-index":"003.004"},"azure_blob":{"$ref":"#/components/schemas/AzureRequest","description":"Only required if you want to create an Azure Blob Storage","title":"AzureBlob","x-stream-index":"003.006"},"bucket":{"description":"The name of the bucket on the service provider","title":"Bucket","type":"string","x-stream-index":"003.002"},"gcs_credentials":{"type":"string","x-stream-index":"003.005"},"name":{"description":"The name of the provider, this must be unique","title":"Name","type":"string","x-stream-index":"001"},"path":{"description":"The path prefix to use for storing files","title":"Path","type":"string","x-stream-index":"003.003"},"storage_type":{"description":"The type of storage to use","enum":["s3","gcs","abs"],"title":"StorageType","type":"string","x-stream-index":"003.001"}},"required":["name","storage_type","bucket"],"title":"CreateExternalStorageRequest","type":"object"},"CreateExternalStorageResponse":{"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"},"CreateGuestRequest":{"nullable":true,"properties":{"user":{"$ref":"#/components/schemas/UserRequest","description":"User object which server acts upon","title":"User","x-stream-index":"001"}},"required":["user"],"type":"object"},"CreateGuestResponse":{"nullable":true,"properties":{"access_token":{"description":"the access token to authenticate the user","title":"Access token","type":"string","x-stream-index":"002"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User object which server acts upon","title":"User","x-stream-index":"001"}},"required":["user","access_token","duration"],"type":"object"},"CreateImportRequest":{"nullable":true,"properties":{"mode":{"enum":["insert","upsert"],"type":"string","x-stream-index":"002"},"path":{"type":"string","x-stream-index":"001"}},"required":["path","mode"],"type":"object"},"CreateImportResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"import_task":{"$ref":"#/components/schemas/ImportTask","x-stream-index":"001"}},"required":["duration"],"title":"Response","type":"object"},"CreateImportURLRequest":{"nullable":true,"properties":{"filename":{"type":"string","x-stream-index":"001"}},"type":"object"},"CreateImportURLResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"path":{"type":"string","x-stream-index":"001"},"upload_url":{"type":"string","x-stream-index":"002"}},"required":["path","upload_url","duration"],"title":"Response","type":"object"},"CreatePollOptionRequest":{"nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"003"},"text":{"description":"Option text","title":"string","type":"string","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"required":["text"],"type":"object"},"CreatePollRequest":{"description":"Contains all information needed to create a new poll","nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"011"},"allow_answers":{"description":"Indicates whether users can suggest user defined answers","title":"Allow answers","type":"boolean","x-stream-index":"009"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"008"},"description":{"description":"A description of the poll","title":"Description","type":"string","x-stream-index":"003"},"enforce_unique_vote":{"description":"Indicates whether users can cast multiple votes","title":"Multiple choice","type":"boolean","x-stream-index":"006"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"is_closed":{"description":"Indicates whether the poll is open for voting","title":"Is closed","type":"boolean","x-stream-index":"010"},"max_votes_allowed":{"description":"Indicates the maximum amount of votes a user can cast","format":"int32","maximum":10,"title":"Maximum votes allowed","type":"integer","x-stream-index":"007"},"name":{"description":"The name of the poll","title":"Name","type":"string","x-stream-index":"002"},"options":{"items":{"$ref":"#/components/schemas/PollOptionInput"},"maximum":100,"type":"array","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"012.002"},"user_id":{"type":"string","x-stream-index":"012.001"},"voting_visibility":{"enum":["anonymous","public"],"type":"string","x-stream-index":"005"}},"required":["name"],"title":"Create Poll Request","type":"object"},"CreateReminderRequest":{"nullable":true,"properties":{"remind_at":{"format":"date-time","type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"type":"object"},"CreateRoleRequest":{"nullable":true,"properties":{"name":{"description":"Role name","maxLength":64,"title":"Name","type":"string","x-stream-index":"001"}},"required":["name"],"type":"object"},"CreateRoleResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"role":{"$ref":"#/components/schemas/Role","x-stream-index":"002"}},"required":["duration","role"],"title":"Response","type":"object"},"DataDogInfo":{"properties":{"api_key":{"type":"string","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"003"},"site":{"type":"string","x-stream-index":"002"}},"type":"object"},"DeactivateUserRequest":{"nullable":true,"properties":{"created_by_id":{"description":"ID of the user who deactivated the user","title":"Created by ID","type":"string","x-stream-index":"003"},"mark_messages_deleted":{"description":"Makes messages appear to be deleted","title":"Mark messages deleted","type":"boolean","x-stream-index":"002"}},"type":"object"},"DeactivateUserResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Deactivated user object","title":"User","x-stream-index":"001"}},"required":["duration"],"type":"object"},"DeactivateUsersRequest":{"description":"Deactivate users request","nullable":true,"properties":{"created_by_id":{"description":"ID of the user who deactivated the users","title":"Created by ID","type":"string","x-stream-index":"003"},"mark_channels_deleted":{"type":"boolean","x-stream-index":"004"},"mark_messages_deleted":{"description":"Makes messages appear to be deleted","title":"Mark messages deleted","type":"boolean","x-stream-index":"002"},"user_ids":{"description":"User IDs to deactivate","items":{"type":"string"},"maximum":100,"minimum":1,"title":"User IDs","type":"array","x-stream-index":"001"}},"required":["user_ids"],"title":"DeactivateUsersRequest","type":"object"},"DeactivateUsersResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"task_id":{"type":"string","x-stream-index":"001"}},"required":["task_id","duration"],"title":"Response","type":"object"},"DeleteChannelResponse":{"description":"Basic response information","nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"Response","type":"object"},"DeleteChannelsRequest":{"nullable":true,"properties":{"cids":{"description":"All channels that should be deleted","items":{"type":"string"},"maximum":100,"minimum":1,"title":"Channels CID","type":"array","x-stream-index":"001"},"hard_delete":{"description":"Specify if channels and all ressources should be hard deleted","title":"Hard delete","type":"boolean","x-stream-index":"002"}},"required":["cids"],"type":"object"},"DeleteChannelsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"result":{"additionalProperties":{"$ref":"#/components/schemas/DeleteChannelsResultResponse"},"description":"Map of channel IDs and their deletion results","title":"Result","type":"object","x-stream-index":"001"},"task_id":{"type":"string","x-stream-index":"002"}},"required":["duration"],"type":"object"},"DeleteChannelsResultResponse":{"nullable":true,"properties":{"error":{"type":"string","x-stream-index":"002"},"status":{"type":"string","x-stream-index":"001"}},"required":["status"],"type":"object"},"DeleteCommandResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"name":{"description":"Command name","title":"Name","type":"string","x-stream-index":"001"}},"required":["name","duration"],"title":"DeleteCommandResponse","type":"object"},"DeleteExternalStorageResponse":{"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"},"DeleteMessageResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001"}},"required":["message","duration"],"title":"Response","type":"object"},"DeleteReactionResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001"},"reaction":{"$ref":"#/components/schemas/ReactionResponse","x-stream-index":"002"}},"required":["message","reaction","duration"],"title":"Response","type":"object"},"DeleteReminderResponse":{"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"},"DeleteSegmentTargetsRequest":{"nullable":true,"properties":{"target_ids":{"description":"Target IDs","items":{"type":"string"},"maximum":100,"minimum":1,"title":"[]string","type":"array","x-stream-index":"002"}},"required":["target_ids"],"type":"object"},"DeleteUsersRequest":{"nullable":true,"properties":{"calls":{"description":"Calls delete mode.\nAffected calls are those that include exactly two members, one of whom is the user being deleted.\n\n* null or empty string - doesn't delete any calls\n* soft - marks user's calls and their related data as deleted (soft-delete)\n* hard - deletes user's calls and their data completely (hard-delete)\n","enum":["soft","hard"],"title":"Delete User's calls","type":"string","x-stream-index":"001.002.004"},"conversations":{"description":"Conversation channels delete mode.\nConversation channel is any channel which only has two members one of which is the user being deleted.\n\n* null or empty string - doesn't delete any conversation channels\n* soft - marks all conversation channels as deleted (same effect as Delete Channels with 'hard' option disabled)\n* hard - deletes channel and all its data completely including messages (same effect as Delete Channels with 'hard' option enabled)\n","enum":["soft","hard"],"title":"Delete Conversations","type":"string","x-stream-index":"001.002.003"},"files":{"description":"Delete user files.\n* false or empty string - doesn't delete any files\n* true - deletes all files uploaded by the user, including images and attachments.\n","title":"Delete User's files","type":"boolean","x-stream-index":"001.002.005"},"messages":{"description":"Message delete mode.\n\n* null or empty string - doesn't delete user messages\n* soft - marks all user messages as deleted without removing any related message data\n* pruning - marks all user messages as deleted, nullifies message information and removes some message data such as reactions and flags\n* hard - deletes messages completely with all related information\n","enum":["soft","pruning","hard"],"title":"Delete Messages","type":"string","x-stream-index":"001.002.002"},"new_call_owner_id":{"type":"string","x-stream-index":"001.002.007"},"new_channel_owner_id":{"type":"string","x-stream-index":"001.002.006"},"user":{"description":"User delete mode.\n\n* soft - marks user as deleted and retains all user data\n* pruning - marks user as deleted and nullifies user information\n* hard - deletes user completely. Requires 'hard' option for messages and conversations as well\n","enum":["soft","pruning","hard"],"title":"Delete User","type":"string","x-stream-index":"001.002.001"},"user_ids":{"description":"IDs of users to delete","items":{"type":"string"},"maximum":100,"minimum":1,"title":"User IDs","type":"array","x-stream-index":"001.001"}},"required":["user_ids"],"type":"object"},"DeleteUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"task_id":{"description":"ID of the task to delete users","title":"Task ID","type":"string","x-stream-index":"001"}},"required":["task_id","duration"],"type":"object"},"Device":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"002.002"},"disabled":{"type":"boolean","x-stream-index":"002.003"},"disabled_reason":{"type":"string","x-stream-index":"002.004"},"id":{"type":"string","x-stream-index":"002.001.004"},"push_provider":{"enum":["firebase","apn","huawei","xiaomi"],"type":"string","x-stream-index":"002.001.001"},"push_provider_name":{"type":"string","x-stream-index":"002.001.003"},"user_id":{"type":"string","x-stream-index":"004"},"voip":{"type":"boolean","x-stream-index":"002.001.005"}},"required":["push_provider","id","created_at","user_id"],"type":"object"},"DeviceErrorInfo":{"properties":{"error_message":{"type":"string","x-stream-index":"003"},"provider":{"type":"string","x-stream-index":"001"},"provider_name":{"type":"string","x-stream-index":"002"}},"required":["provider","provider_name","error_message"],"type":"object"},"DeviceResponse":{"description":"Response for Device","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"004"},"disabled":{"description":"Whether device is disabled or not","title":"Disabled","type":"boolean","x-stream-index":"005"},"disabled_reason":{"description":"Reason explaining why device had been disabled","title":"Reason","type":"string","x-stream-index":"006"},"id":{"description":"Device ID","title":"ID","type":"string","x-stream-index":"003"},"push_provider":{"description":"Push provider","title":"PushProvider","type":"string","x-stream-index":"001"},"push_provider_name":{"description":"Push provider name","title":"PushProviderName","type":"string","x-stream-index":"002"},"user_id":{"description":"User ID","title":"UserID","type":"string","x-stream-index":"008"},"voip":{"description":"When true the token is for Apple VoIP push notifications","title":"Voip","type":"boolean","x-stream-index":"007"}},"required":["push_provider","id","created_at","user_id"],"title":"DeviceResponse","type":"object"},"DraftPayloadResponse":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"html":{"type":"string","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"001"},"mentioned_users":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"008"},"mml":{"type":"string","x-stream-index":"003"},"parent_id":{"type":"string","x-stream-index":"005"},"poll_id":{"type":"string","x-stream-index":"013"},"quoted_message_id":{"type":"string","x-stream-index":"009"},"show_in_channel":{"type":"boolean","x-stream-index":"006"},"silent":{"type":"boolean","x-stream-index":"012"},"text":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"011"}},"required":["id","text","custom"],"type":"object"},"DraftResponse":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003"},"channel_cid":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"string","x-stream-index":"007"},"message":{"$ref":"#/components/schemas/DraftPayloadResponse","x-stream-index":"001"},"parent_id":{"type":"string","x-stream-index":"004"},"parent_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"005"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"006"}},"required":["message","channel_cid","created_at"],"type":"object"},"ErrorResult":{"properties":{"stacktrace":{"type":"string","x-stream-index":"003"},"type":{"type":"string","x-stream-index":"001"},"version":{"type":"string","x-stream-index":"004"}},"required":["type","description"],"type":"object"},"EventHook":{"nullable":true,"properties":{"callback":{"$ref":"#/components/schemas/AsyncModerationCallbackConfig","x-stream-index":"019.001.002"},"created_at":{"format":"date-time","type":"string","x-stream-index":"020"},"enabled":{"type":"boolean","x-stream-index":"003"},"event_types":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"hook_type":{"type":"string","x-stream-index":"002"},"id":{"type":"string","x-stream-index":"001"},"product":{"type":"string","x-stream-index":"018"},"sns_auth_type":{"type":"string","x-stream-index":"014"},"sns_key":{"type":"string","x-stream-index":"015"},"sns_region":{"type":"string","x-stream-index":"013"},"sns_role_arn":{"type":"string","x-stream-index":"017"},"sns_secret":{"type":"string","x-stream-index":"016"},"sns_topic_arn":{"type":"string","x-stream-index":"012"},"sqs_auth_type":{"type":"string","x-stream-index":"008"},"sqs_key":{"type":"string","x-stream-index":"009"},"sqs_queue_url":{"type":"string","x-stream-index":"006"},"sqs_region":{"type":"string","x-stream-index":"007"},"sqs_role_arn":{"type":"string","x-stream-index":"011"},"sqs_secret":{"type":"string","x-stream-index":"010"},"timeout_ms":{"format":"int32","type":"integer","x-stream-index":"019.001.001"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"021"},"webhook_url":{"type":"string","x-stream-index":"005"}},"type":"object"},"EventNotificationSettings":{"properties":{"apns":{"$ref":"#/components/schemas/APNS","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"fcm":{"$ref":"#/components/schemas/FCM","x-stream-index":"003"}},"required":["enabled","apns","fcm"],"type":"object"},"EventRequest":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"parent_id":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"required":["type"],"type":"object"},"EventResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"event":{"$ref":"#/components/schemas/WSEvent","x-stream-index":"001"}},"required":["event","duration"],"title":"Response","type":"object"},"ExportChannelsRequest":{"nullable":true,"properties":{"channels":{"description":"Export options for channels","items":{"$ref":"#/components/schemas/ChannelExport"},"maximum":100,"minimum":1,"title":"Channels","type":"array","x-stream-index":"002.001"},"clear_deleted_message_text":{"description":"Set if deleted message text should be cleared","title":"Clear deleted message text","type":"boolean","x-stream-index":"002.002"},"export_users":{"type":"boolean","x-stream-index":"002.005"},"include_soft_deleted_channels":{"description":"Set if you want to include deleted channels","title":"Include soft deleted channels","type":"boolean","x-stream-index":"002.004"},"include_truncated_messages":{"description":"Set if you want to include truncated messages","title":"Include truncated messages","type":"boolean","x-stream-index":"002.003"},"version":{"description":"Export version","title":"Version","type":"string","x-stream-index":"001"}},"required":["channels"],"type":"object"},"ExportChannelsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"task_id":{"description":"ID of the task to export channels","title":"Task ID","type":"string","x-stream-index":"001"}},"required":["task_id","duration"],"type":"object"},"ExportUserResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"004.001"},"messages":{"description":"List of exported messages","items":{"$ref":"#/components/schemas/MessageResponse"},"title":"Messages","type":"array","x-stream-index":"002"},"reactions":{"description":"List of exported reactions","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Reactions","type":"array","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Exported user object","title":"User","x-stream-index":"001"}},"required":["duration"],"type":"object"},"ExportUsersRequest":{"nullable":true,"properties":{"user_ids":{"items":{"type":"string"},"maximum":25,"minimum":1,"type":"array","x-stream-index":"001"}},"required":["user_ids"],"type":"object"},"ExportUsersResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"task_id":{"type":"string","x-stream-index":"001"}},"required":["task_id","duration"],"title":"Response","type":"object"},"ExternalStorageResponse":{"properties":{"bucket":{"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"path":{"type":"string","x-stream-index":"004"},"type":{"enum":["s3","gcs","abs"],"type":"string","x-stream-index":"002"}},"required":["name","type","bucket","path"],"type":"object"},"FCM":{"properties":{"data":{"additionalProperties":{},"type":"object","x-stream-index":"001"}},"type":"object"},"FeedsEventPreferences":{"properties":{"comments":{"type":"string","x-stream-index":"002"},"mentions":{"type":"string","x-stream-index":"004"},"new_followers":{"type":"string","x-stream-index":"003"},"reactions":{"type":"string","x-stream-index":"001"}},"type":"object"},"FeedsEventPreferencesInput":{"properties":{"comments":{"enum":["all","none"],"type":"string","x-stream-index":"002"},"mentions":{"enum":["all","none"],"type":"string","x-stream-index":"004"},"new_followers":{"enum":["all","none"],"type":"string","x-stream-index":"003"},"reactions":{"enum":["all","none"],"type":"string","x-stream-index":"001"}},"type":"object"},"Field":{"nullable":true,"properties":{"short":{"type":"boolean","x-stream-index":"003"},"title":{"type":"string","x-stream-index":"001"},"value":{"type":"string","x-stream-index":"002"}},"required":["title","value","short"],"type":"object"},"FileUploadConfig":{"properties":{"allowed_file_extensions":{"items":{"type":"string"},"type":"array","x-stream-index":"001"},"allowed_mime_types":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"blocked_file_extensions":{"items":{"type":"string"},"type":"array","x-stream-index":"002"},"blocked_mime_types":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"size_limit":{"format":"int32","maximum":104857600,"minimum":0,"type":"integer","x-stream-index":"005"}},"required":["size_limit"],"type":"object"},"FileUploadRequest":{"nullable":true,"properties":{"file":{"description":"file field","title":"File","type":"string","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/OnlyUserID","description":"user for the request **server side only**","title":"User","x-stream-index":"003"}},"type":"object"},"FileUploadResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"file":{"description":"URL to the uploaded asset. Should be used to put to `asset_url` attachment field","title":"File","type":"string","x-stream-index":"001"},"thumb_url":{"description":"URL of the file thumbnail for supported file formats. Should be put to `thumb_url` attachment field","title":"Thumbnail URL","type":"string","x-stream-index":"002"}},"required":["duration"],"type":"object"},"FirebaseConfig":{"properties":{"Disabled":{"type":"boolean","writeOnly":true,"x-stream-index":"001"},"apn_template":{"type":"string","x-stream-index":"005"},"credentials_json":{"type":"string","x-stream-index":"006"},"data_template":{"type":"string","x-stream-index":"004"},"notification_template":{"type":"string","x-stream-index":"003"},"server_key":{"type":"string","x-stream-index":"002"}},"type":"object"},"FirebaseConfigFields":{"properties":{"apn_template":{"type":"string","x-stream-index":"004"},"credentials_json":{"type":"string","x-stream-index":"006"},"data_template":{"type":"string","x-stream-index":"003"},"enabled":{"type":"boolean","x-stream-index":"001"},"notification_template":{"type":"string","x-stream-index":"002"},"server_key":{"type":"string","x-stream-index":"005"}},"required":["enabled"],"type":"object"},"Flag":{"description":"Contains information about flagged user or message","properties":{"approved_at":{"description":"Date of the approval","format":"date-time","title":"Approved at","type":"string","x-stream-index":"015"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"011"},"created_by_automod":{"type":"boolean","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"022"},"details":{"$ref":"#/components/schemas/FlagDetails","x-stream-index":"021"},"reason":{"type":"string","x-stream-index":"020"},"rejected_at":{"description":"Date of the rejection","format":"date-time","title":"Rejected at","type":"string","x-stream-index":"016"},"reviewed_at":{"description":"Date of the review","format":"date-time","title":"Reviewed at","type":"string","x-stream-index":"013"},"reviewed_by":{"type":"string","x-stream-index":"014"},"target_message":{"$ref":"#/components/schemas/Message","x-stream-index":"008"},"target_message_id":{"description":"ID of flagged message","title":"Target Message ID","type":"string","x-stream-index":"007"},"target_user":{"$ref":"#/components/schemas/User","description":"Flagged user","title":"User","x-stream-index":"010"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"012"},"user":{"$ref":"#/components/schemas/User","description":"User who flagged a message or a user","title":"User","x-stream-index":"006"}},"required":["created_by_automod","created_at","updated_at"],"title":"Flag","type":"object"},"FlagDetails":{"properties":{"Extra":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"002"},"automod":{"$ref":"#/components/schemas/AutomodDetails","x-stream-index":"001"},"original_text":{"type":"string","x-stream-index":"003"}},"required":["Extra","original_text"],"type":"object"},"FlagFeedback":{"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"005"},"labels":{"items":{"$ref":"#/components/schemas/Label"},"type":"array","x-stream-index":"006"},"message_id":{"type":"string","x-stream-index":"004"}},"required":["message_id","created_at","labels"],"type":"object"},"FlagMessageDetails":{"properties":{"pin_changed":{"type":"boolean","x-stream-index":"002"},"should_enrich":{"type":"boolean","x-stream-index":"003"},"skip_push":{"type":"boolean","x-stream-index":"004"},"updated_by_id":{"type":"string","x-stream-index":"001"}},"type":"object"},"FlagRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"reason":{"maxLength":255,"type":"string","x-stream-index":"003"},"target_message_id":{"description":"ID of the message when reporting a message","title":"Target Message ID","type":"string","x-stream-index":"001"},"target_user_id":{"description":"ID of the user when reporting a user","title":"Target User ID","type":"string","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"005.002"},"user_id":{"type":"string","x-stream-index":"005.001"}},"type":"object"},"FlagResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"flag":{"$ref":"#/components/schemas/Flag","x-stream-index":"001"},"review_queue_item_id":{"type":"string","x-stream-index":"002"}},"required":["review_queue_item_id","duration"],"title":"Response","type":"object"},"FlagUpdatedEvent":{"nullable":true,"properties":{"CreatedBy":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"004"},"Message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"002"},"User":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"003"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"received_at":{"format":"date-time","type":"string","x-stream-index":"001.004"},"type":{"default":"flag.updated","type":"string","x-stream-index":"001.002"}},"required":["type","created_at","custom"],"title":"FlagUpdatedEvent","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"},"FrameRecordSettings":{"properties":{"capture_interval_in_seconds":{"format":"int32","maximum":60,"minimum":2,"type":"integer","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"},"quality":{"type":"string","x-stream-index":"002"}},"required":["mode","capture_interval_in_seconds"],"type":"object"},"FullUserResponse":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"ban_expires":{"format":"date-time","type":"string","x-stream-index":"015"},"banned":{"type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"014"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"007"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"string","x-stream-index":"001.016"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"001.011"},"devices":{"items":{"$ref":"#/components/schemas/DeviceResponse"},"type":"array","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001.001"},"image":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"005"},"language":{"type":"string","x-stream-index":"001.005"},"last_active":{"format":"date-time","type":"string","x-stream-index":"001.014"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"012"},"mutes":{"items":{"$ref":"#/components/schemas/UserMuteResponse"},"type":"array","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"001.002"},"online":{"type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"003"},"revoke_tokens_issued_before":{"format":"date-time","type":"string","x-stream-index":"001.015"},"role":{"type":"string","x-stream-index":"001.006"},"shadow_banned":{"type":"boolean","x-stream-index":"013"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"009"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"010"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"008"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"011"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","devices","invisible","mutes","channel_mutes","unread_count","total_unread_count","unread_channels","unread_threads","shadow_banned","blocked_user_ids"],"type":"object"},"GeofenceResponse":{"nullable":true,"properties":{"country_codes":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"description":{"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"type":{"type":"string","x-stream-index":"002"}},"required":["name"],"type":"object"},"GeofenceSettings":{"properties":{"names":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"required":["names"],"type":"object"},"GetApplicationResponse":{"description":"Basic response information","nullable":true,"properties":{"app":{"$ref":"#/components/schemas/AppResponseFields","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["app","duration"],"title":"Response","type":"object"},"GetBlockListResponse":{"description":"Response for get block list","nullable":true,"properties":{"blocklist":{"$ref":"#/components/schemas/BlockListResponse","description":"Block list object","title":"BlockListResponse","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["duration"],"title":"GetBlockListResponse","type":"object","x-stream-docs-page-id":"get_block_list"},"GetBlockedUsersResponse":{"nullable":true,"properties":{"blocks":{"description":"Array of blocked user object","items":{"$ref":"#/components/schemas/BlockedUserResponse"},"title":"Blocks","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["blocks","duration"],"type":"object"},"GetCampaignResponse":{"description":"Basic response information","nullable":true,"properties":{"campaign":{"$ref":"#/components/schemas/CampaignResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"users":{"$ref":"#/components/schemas/PagerResponse","x-stream-index":"002"}},"required":["duration"],"title":"Response","type":"object"},"GetChannelTypeResponse":{"description":"Basic response information","nullable":true,"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"003.002.027"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"003.002.022"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.002.023"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"003.002.028"},"blocklist":{"type":"string","x-stream-index":"003.002.024"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.002.025"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"003.002.026"},"commands":{"items":{"$ref":"#/components/schemas/Command"},"type":"array","x-stream-index":"003.003"},"connect_events":{"type":"boolean","x-stream-index":"003.002.004"},"count_messages":{"type":"boolean","x-stream-index":"003.002.019"},"created_at":{"format":"date-time","type":"string","x-stream-index":"003.001.003"},"custom_events":{"type":"boolean","x-stream-index":"003.002.012"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"004.001"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"002"},"mark_messages_pending":{"type":"boolean","x-stream-index":"003.002.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"003.002.021"},"mutes":{"type":"boolean","x-stream-index":"003.002.009"},"name":{"type":"string","x-stream-index":"003.002.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"003.002.029"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"003.002.030"},"permissions":{"items":{"$ref":"#/components/schemas/PolicyRequest"},"type":"array","x-stream-index":"001"},"polls":{"type":"boolean","x-stream-index":"003.002.016"},"push_notifications":{"type":"boolean","x-stream-index":"003.002.013"},"quotes":{"type":"boolean","x-stream-index":"003.002.008"},"reactions":{"type":"boolean","x-stream-index":"003.002.006"},"read_events":{"type":"boolean","x-stream-index":"003.002.003"},"reminders":{"type":"boolean","x-stream-index":"003.002.014"},"replies":{"type":"boolean","x-stream-index":"003.002.007"},"search":{"type":"boolean","x-stream-index":"003.002.005"},"shared_locations":{"type":"boolean","x-stream-index":"003.002.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"003.002.031"},"typing_events":{"type":"boolean","x-stream-index":"003.002.002"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"003.001.004"},"uploads":{"type":"boolean","x-stream-index":"003.002.010"},"url_enrichment":{"type":"boolean","x-stream-index":"003.002.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"003.002.017"}},"required":["permissions","grants","created_at","updated_at","name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","count_messages","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","commands","duration"],"title":"Response","type":"object"},"GetCommandResponse":{"nullable":true,"properties":{"args":{"type":"string","x-stream-index":"001.006"},"created_at":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"001.001"},"description":{"type":"string","x-stream-index":"001.005"},"duration":{"type":"string","x-stream-index":"002.001"},"name":{"type":"string","x-stream-index":"001.004"},"set":{"type":"string","x-stream-index":"001.007"},"updated_at":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"001.002"}},"required":["name","description","args","set","duration"],"title":"GetCommandResponse","type":"object"},"GetCustomPermissionResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"permission":{"$ref":"#/components/schemas/Permission","x-stream-index":"001"}},"required":["permission","duration"],"title":"Response","type":"object"},"GetDraftResponse":{"description":"Basic response information","nullable":true,"properties":{"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["draft","duration"],"title":"Response","type":"object"},"GetImportResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"import_task":{"$ref":"#/components/schemas/ImportTask","x-stream-index":"001"}},"required":["duration"],"title":"Response","type":"object"},"GetManyMessagesResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.002.001"},"messages":{"description":"List of messages","items":{"$ref":"#/components/schemas/MessageResponse"},"title":"Messages","type":"array","x-stream-index":"001.001"}},"required":["messages","duration"],"type":"object"},"GetMessageResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageWithChannelResponse","x-stream-index":"001"},"pending_message_metadata":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"002"}},"required":["message","duration"],"title":"Response","type":"object"},"GetOGResponse":{"nullable":true,"properties":{"actions":{"items":{"$ref":"#/components/schemas/Action"},"type":"array","x-stream-index":"001.015"},"asset_url":{"description":"URL of detected video or audio","title":"Image URL","type":"string","x-stream-index":"001.017"},"author_icon":{"type":"string","x-stream-index":"001.007"},"author_link":{"description":"og:site","title":"Author Link","type":"string","x-stream-index":"001.006"},"author_name":{"description":"og:site_name","title":"Author Name","type":"string","x-stream-index":"001.005"},"color":{"type":"string","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.018"},"duration":{"type":"string","x-stream-index":"002.001"},"fallback":{"type":"string","x-stream-index":"001.002"},"fields":{"items":{"$ref":"#/components/schemas/Field"},"type":"array","x-stream-index":"001.016"},"footer":{"type":"string","x-stream-index":"001.013"},"footer_icon":{"type":"string","x-stream-index":"001.014"},"giphy":{"$ref":"#/components/schemas/Images","x-stream-index":"001.019"},"image_url":{"description":"URL of detected image","title":"Image URL","type":"string","x-stream-index":"001.011"},"og_scrape_url":{"description":"extracted url from the text","title":"OG Scrape URL","type":"string","x-stream-index":"001.020"},"original_height":{"format":"int32","type":"integer","x-stream-index":"001.022"},"original_width":{"format":"int32","type":"integer","x-stream-index":"001.021"},"pretext":{"type":"string","x-stream-index":"001.004"},"text":{"description":"og:description","title":"Text","type":"string","x-stream-index":"001.010"},"thumb_url":{"description":"URL of detected thumb image","title":"Image URL","type":"string","x-stream-index":"001.012"},"title":{"description":"og:title","title":"Title","type":"string","x-stream-index":"001.008"},"title_link":{"description":"og:url","title":"Title Link","type":"string","x-stream-index":"001.009"},"type":{"description":"Attachment type, could be empty, image, audio or video","title":"Type","type":"string","x-stream-index":"001.001"}},"required":["custom","duration"],"title":"Get OG Attachment","type":"object","x-stream-docs-page-id":"og"},"GetPushTemplatesResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"templates":{"items":{"$ref":"#/components/schemas/PushTemplate"},"type":"array","x-stream-index":"002"}},"required":["duration","templates"],"title":"Response","type":"object"},"GetRateLimitsResponse":{"nullable":true,"properties":{"android":{"additionalProperties":{"$ref":"#/components/schemas/LimitInfo"},"description":"Map of endpoint rate limits for the Android platform","title":"Android","type":"object","x-stream-index":"002","x-stream-map":{"key":"endpoint","title":"Endpoint name","description":"The name of the endpoint for which the limits apply"}},"duration":{"type":"string","x-stream-index":"005.001"},"ios":{"additionalProperties":{"$ref":"#/components/schemas/LimitInfo"},"description":"Map of endpoint rate limits for the iOS platform","title":"iOS","type":"object","x-stream-index":"003","x-stream-map":{"key":"endpoint","title":"Endpoint name","description":"The name of the endpoint for which the limits apply"}},"server_side":{"additionalProperties":{"$ref":"#/components/schemas/LimitInfo"},"description":"Map of endpoint rate limits for the server-side platform","title":"Server-side","type":"object","x-stream-index":"001","x-stream-map":{"key":"endpoint","title":"Endpoint name","description":"The name of the endpoint for which the limits apply"}},"web":{"additionalProperties":{"$ref":"#/components/schemas/LimitInfo"},"description":"Map of endpoint rate limits for the web platform","title":"Web","type":"object","x-stream-index":"004","x-stream-map":{"key":"endpoint","title":"Endpoint name","description":"The name of the endpoint for which the limits apply"}}},"required":["duration"],"title":"Get Rate Limits Response","type":"object","x-stream-docs-page-id":"rate_limits"},"GetReactionsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"reactions":{"description":"List of reactions","items":{"$ref":"#/components/schemas/Reaction"},"title":"Reactions","type":"array","x-stream-index":"001"}},"required":["reactions","duration"],"type":"object"},"GetRepliesResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"messages":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","x-stream-index":"001"}},"required":["messages","duration"],"title":"Response","type":"object"},"GetSegmentResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"segment":{"$ref":"#/components/schemas/SegmentResponse","description":"Segment","title":"SegmentResponse","x-stream-index":"001"}},"required":["duration"],"type":"object"},"GetTaskResponse":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"001.003"},"duration":{"type":"string","x-stream-index":"004.001"},"error":{"$ref":"#/components/schemas/ErrorResult","description":"Error produced by task","title":"Error","x-stream-index":"003"},"result":{"additionalProperties":{},"description":"Result produced by task after completion","title":"Result","type":"object","x-stream-index":"002"},"status":{"description":"Current status of task","title":"Status","type":"string","x-stream-index":"001.002"},"task_id":{"description":"ID of task","title":"Task ID","type":"string","x-stream-index":"001.001"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"001.004"}},"required":["task_id","status","created_at","updated_at","duration"],"title":"Get Task Response","type":"object","x-stream-docs-page-id":"tasks"},"GetThreadResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"thread":{"$ref":"#/components/schemas/ThreadStateResponse","description":"Enriched thread state","title":"Thread","x-stream-index":"001"}},"required":["thread","duration"],"type":"object"},"HLSSettings":{"properties":{"auto_on":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"004"},"quality_tracks":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"required":["auto_on","enabled","quality_tracks"],"type":"object"},"HideChannelRequest":{"nullable":true,"properties":{"clear_history":{"description":"Whether to clear message history of the channel or not","title":"Clear history","type":"boolean","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"type":"object"},"HideChannelResponse":{"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"},"HuaweiConfig":{"properties":{"Disabled":{"type":"boolean","writeOnly":true,"x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"secret":{"type":"string","x-stream-index":"002"}},"type":"object"},"HuaweiConfigFields":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"id":{"type":"string","x-stream-index":"002"},"secret":{"type":"string","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"ImageData":{"properties":{"frames":{"type":"string","x-stream-index":"005"},"height":{"type":"string","x-stream-index":"003"},"size":{"type":"string","x-stream-index":"004"},"url":{"type":"string","x-stream-index":"001"},"width":{"type":"string","x-stream-index":"002"}},"required":["url","width","height","size","frames"],"type":"object"},"ImageSize":{"properties":{"crop":{"description":"Crop mode","enum":["top","bottom","left","right","center"],"title":"Crop","type":"string","x-stream-index":"001"},"height":{"description":"Target image height","format":"int32","title":"Height","type":"integer","x-stream-index":"003"},"resize":{"description":"Resize method","enum":["clip","crop","scale","fill"],"title":"Resize","type":"string","x-stream-index":"002"},"width":{"description":"Target image width","format":"int32","title":"Width","type":"integer","x-stream-index":"004"}},"title":"Image size configuration","type":"object"},"ImageUploadRequest":{"nullable":true,"properties":{"file":{"type":"string","x-stream-index":"001.002"},"upload_sizes":{"description":"field with JSON-encoded array of image size configurations","items":{"$ref":"#/components/schemas/ImageSize"},"title":"Upload sizes","type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/OnlyUserID","x-stream-index":"001.003"}},"type":"object"},"ImageUploadResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.003.001"},"file":{"type":"string","x-stream-index":"001.001"},"thumb_url":{"type":"string","x-stream-index":"001.002"},"upload_sizes":{"description":"Array of image size configurations","items":{"$ref":"#/components/schemas/ImageSize"},"title":"Upload sizes","type":"array","x-stream-index":"002"}},"required":["duration"],"type":"object"},"Images":{"properties":{"fixed_height":{"$ref":"#/components/schemas/ImageData","x-stream-index":"002"},"fixed_height_downsampled":{"$ref":"#/components/schemas/ImageData","x-stream-index":"004"},"fixed_height_still":{"$ref":"#/components/schemas/ImageData","x-stream-index":"003"},"fixed_width":{"$ref":"#/components/schemas/ImageData","x-stream-index":"005"},"fixed_width_downsampled":{"$ref":"#/components/schemas/ImageData","x-stream-index":"007"},"fixed_width_still":{"$ref":"#/components/schemas/ImageData","x-stream-index":"006"},"original":{"$ref":"#/components/schemas/ImageData","x-stream-index":"001"}},"required":["original","fixed_height","fixed_height_still","fixed_height_downsampled","fixed_width","fixed_width_still","fixed_width_downsampled"],"type":"object"},"ImportTask":{"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"011"},"history":{"items":{"$ref":"#/components/schemas/ImportTaskHistory"},"type":"array","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"003"},"mode":{"type":"string","x-stream-index":"006"},"path":{"type":"string","x-stream-index":"005"},"size":{"format":"int64","type":"integer","x-stream-index":"007"},"state":{"type":"string","x-stream-index":"008"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"012"}},"required":["id","path","mode","state","history","created_at","updated_at"],"type":"object"},"ImportTaskHistory":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"007"},"next_state":{"type":"string","x-stream-index":"006"},"prev_state":{"type":"string","x-stream-index":"005"}},"required":["prev_state","next_state","created_at"],"type":"object"},"IngressAudioEncodingOptions":{"properties":{"bitrate":{"maximum":128000,"minimum":16000,"type":"integer","x-stream-index":"003"},"channels":{"enum":["1","2"],"format":"int32","type":"integer","x-stream-index":"001"},"enable_dtx":{"type":"boolean","x-stream-index":"002"}},"required":["channels","enable_dtx","bitrate"],"type":"object"},"IngressSettings":{"properties":{"audio_encoding_options":{"$ref":"#/components/schemas/IngressAudioEncodingOptions","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"video_encoding_options":{"additionalProperties":{"$ref":"#/components/schemas/IngressVideoEncodingOptions"},"type":"object","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"IngressVideoEncodingOptions":{"properties":{"layers":{"items":{"$ref":"#/components/schemas/IngressVideoLayer"},"minimum":1,"type":"array","x-stream-index":"001"}},"required":["layers"],"type":"object"},"IngressVideoLayer":{"nullable":true,"properties":{"bitrate":{"minimum":1000,"type":"integer","x-stream-index":"002"},"codec":{"enum":["h264","vp8"],"type":"string","x-stream-index":"001"},"frame_rate":{"maximum":60,"minimum":1,"type":"integer","x-stream-index":"003"},"max_dimension":{"minimum":240,"type":"integer","x-stream-index":"005"},"min_dimension":{"minimum":240,"type":"integer","x-stream-index":"004"}},"required":["codec","bitrate","frame_rate","min_dimension","max_dimension"],"type":"object"},"Label":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"phrase_list_ids":{"items":{"format":"int32","type":"integer"},"type":"array","x-stream-index":"002"}},"required":["name"],"type":"object"},"LabelThresholds":{"properties":{"block":{"description":"Threshold for automatic message block","format":"float","maximum":1,"minimum":0,"title":"Block","type":"number","x-stream-index":"002"},"flag":{"description":"Threshold for automatic message flag","format":"float","maximum":1,"minimum":0,"title":"Flag","type":"number","x-stream-index":"001"}},"type":"object"},"LayoutSettings":{"properties":{"detect_orientation":{"type":"boolean","x-stream-index":"005"},"external_app_url":{"type":"string","x-stream-index":"003"},"external_css_url":{"type":"string","x-stream-index":"004"},"name":{"enum":["spotlight","grid","single-participant","mobile","custom"],"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"required":["name","external_app_url","external_css_url"],"type":"object"},"LimitInfo":{"properties":{"limit":{"description":"The maximum number of calls allowed for the time window","format":"int32","title":"Limit","type":"integer","x-stream-index":"001"},"remaining":{"description":"The number of remaining calls in the current window","format":"int64","title":"Remaining","type":"integer","x-stream-index":"002"},"reset":{"description":"The Unix timestamp of the next window","format":"int64","title":"Reset","type":"integer","x-stream-index":"003"}},"required":["limit","remaining","reset"],"title":"Rate Limit info","type":"object","x-stream-docs-page-id":"rate_limits"},"LimitsSettings":{"properties":{"max_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"004"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"},"max_participants_exclude_owner":{"type":"boolean","x-stream-index":"003"},"max_participants_exclude_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"002"}},"required":["max_participants_exclude_roles"],"type":"object"},"ListBlockListResponse":{"description":"Basic response information","nullable":true,"properties":{"blocklists":{"items":{"$ref":"#/components/schemas/BlockListResponse"},"type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["blocklists","duration"],"title":"Response","type":"object"},"ListChannelTypesResponse":{"nullable":true,"properties":{"channel_types":{"additionalProperties":{"$ref":"#/components/schemas/ChannelTypeConfig"},"description":"Object with all channel types","title":"Channel types","type":"object","x-stream-index":"001","x-stream-map":{"key":"channel_type","title":"Channel type","description":"Channel type config object"}},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["channel_types","duration"],"title":"ListChannelTypesResponse","type":"object"},"ListCommandsResponse":{"nullable":true,"properties":{"commands":{"description":"List of commands","items":{"$ref":"#/components/schemas/Command"},"title":"Commands","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["commands","duration"],"title":"ListCommandsResponse","type":"object"},"ListDevicesResponse":{"description":"List devices response","nullable":true,"properties":{"devices":{"description":"List of devices","items":{"$ref":"#/components/schemas/DeviceResponse"},"title":"Devices","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["devices","duration"],"title":"ListDevicesResponse","type":"object"},"ListExternalStorageResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"external_storages":{"additionalProperties":{"$ref":"#/components/schemas/ExternalStorageResponse"},"type":"object","x-stream-index":"002"}},"required":["duration","external_storages"],"title":"Response","type":"object"},"ListImportsResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"import_tasks":{"items":{"$ref":"#/components/schemas/ImportTask"},"type":"array","x-stream-index":"001"}},"required":["import_tasks","duration"],"title":"Response","type":"object"},"ListPermissionsResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"permissions":{"items":{"$ref":"#/components/schemas/Permission"},"type":"array","x-stream-index":"001"}},"required":["permissions","duration"],"title":"Response","type":"object"},"ListPushProvidersResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"push_providers":{"items":{"$ref":"#/components/schemas/PushProviderResponse"},"type":"array","x-stream-index":"001"}},"required":["push_providers","duration"],"title":"Response","type":"object"},"ListRolesResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"roles":{"items":{"$ref":"#/components/schemas/Role"},"type":"array","x-stream-index":"001"}},"required":["roles","duration"],"title":"Response","type":"object"},"MarkChannelsReadRequest":{"nullable":true,"properties":{"read_by_channel":{"additionalProperties":{"type":"string"},"description":"Map of channel ID to last read message ID","maximum":30,"title":"Read by channel","type":"object","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"002.002"},"user_id":{"type":"string","x-stream-index":"002.001"}},"type":"object"},"MarkReadRequest":{"nullable":true,"properties":{"message_id":{"description":"ID of the message that is considered last read by client","title":"Message ID","type":"string","x-stream-index":"001"},"thread_id":{"description":"Optional Thread ID to specifically mark a given thread as read","title":"Thread ID","type":"string","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"type":"object"},"MarkReadResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"event":{"$ref":"#/components/schemas/MessageReadEvent","description":"Mark read event","title":"Event","x-stream-index":"001"}},"required":["duration"],"type":"object"},"MarkUnreadRequest":{"nullable":true,"properties":{"message_id":{"description":"ID of the message from where the channel is marked unread","title":"Message ID","type":"string","x-stream-index":"001"},"thread_id":{"description":"Mark a thread unread, specify both the thread and message id","title":"Thread ID","type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"type":"object"},"MemberAddedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"003.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"002.001"},"type":{"default":"member.added","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MemberAddedEvent","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"},"MemberRemovedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"002.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"001.001"},"type":{"default":"member.removed","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MemberRemovedEvent","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"},"MemberUpdatedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"005.002"},"channel_type":{"type":"string","x-stream-index":"005.003"},"cid":{"type":"string","x-stream-index":"005.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"003.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"002.001"},"type":{"default":"member.updated","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MemberUpdatedEvent","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"},"MembersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"members":{"description":"List of found members","items":{"$ref":"#/components/schemas/ChannelMember"},"title":"Members","type":"array","x-stream-index":"001"}},"required":["members","duration"],"type":"object"},"Message":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"012"},"before_message_send_failed":{"type":"boolean","x-stream-index":"046"},"cid":{"type":"string","x-stream-index":"028"},"command":{"type":"string","x-stream-index":"006"},"created_at":{"format":"date-time","type":"string","x-stream-index":"030"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"034"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"033"},"deleted_for_me":{"type":"boolean","x-stream-index":"059"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"023"},"html":{"type":"string","x-stream-index":"007"},"i18n":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"044"},"id":{"type":"string","x-stream-index":"002"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"040"},"latest_reactions":{"items":{"$ref":"#/components/schemas/Reaction"},"type":"array","x-stream-index":"013"},"mentioned_users":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"043"},"message_text_updated_at":{"format":"date-time","type":"string","x-stream-index":"052"},"mml":{"type":"string","x-stream-index":"005"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"056"},"own_reactions":{"items":{"$ref":"#/components/schemas/Reaction"},"type":"array","x-stream-index":"014"},"parent_id":{"type":"string","x-stream-index":"019"},"pin_expires":{"format":"date-time","type":"string","x-stream-index":"051"},"pinned":{"type":"boolean","x-stream-index":"047"},"pinned_at":{"format":"date-time","type":"string","x-stream-index":"048"},"pinned_by":{"$ref":"#/components/schemas/User","x-stream-index":"050"},"poll":{"$ref":"#/components/schemas/Poll","x-stream-index":"054"},"poll_id":{"type":"string","x-stream-index":"053"},"quoted_message":{"$ref":"#/components/schemas/Message","x-stream-index":"025"},"quoted_message_id":{"type":"string","x-stream-index":"024"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"015"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"017"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"016"},"reminder":{"$ref":"#/components/schemas/MessageReminder","x-stream-index":"058"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"022"},"restricted_visibility":{"items":{"type":"string"},"type":"array","x-stream-index":"011"},"shadowed":{"type":"boolean","x-stream-index":"036"},"shared_location":{"$ref":"#/components/schemas/SharedLocation","x-stream-index":"055"},"show_in_channel":{"type":"boolean","x-stream-index":"021"},"silent":{"type":"boolean","x-stream-index":"045"},"text":{"type":"string","x-stream-index":"004"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"027"},"type":{"type":"string","x-stream-index":"008"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"031"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"010"}},"required":["id","text","html","type","restricted_visibility","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reaction_groups","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned"],"type":"object"},"MessageActionRequest":{"nullable":true,"properties":{"form_data":{"additionalProperties":{"type":"string"},"description":"ReadOnlyData to execute command with","title":"Form data","type":"object","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"required":["form_data"],"type":"object"},"MessageChangeSet":{"properties":{"attachments":{"type":"boolean","x-stream-index":"005"},"custom":{"type":"boolean","x-stream-index":"001"},"html":{"type":"boolean","x-stream-index":"004"},"mentioned_user_ids":{"type":"boolean","x-stream-index":"006"},"mml":{"type":"boolean","x-stream-index":"003"},"pin":{"type":"boolean","x-stream-index":"009"},"quoted_message_id":{"type":"boolean","x-stream-index":"007"},"silent":{"type":"boolean","x-stream-index":"008"},"text":{"type":"boolean","x-stream-index":"002"}},"required":["custom","text","mml","html","attachments","mentioned_user_ids","quoted_message_id","silent","pin"],"type":"object"},"MessageDeletedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"007.002"},"deleted_for_me":{"type":"boolean","x-stream-index":"003"},"hard_delete":{"type":"boolean","x-stream-index":"002.001"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"006.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"message.deleted","type":"string","x-stream-index":"007.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005.001"}},"required":["hard_delete","cid","channel_id","channel_type","type","created_at"],"title":"MessageDeletedEvent","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":{"approved_at":{"format":"date-time","type":"string","x-stream-index":"013"},"created_at":{"format":"date-time","type":"string","x-stream-index":"009"},"created_by_automod":{"type":"boolean","x-stream-index":"001"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"008"},"details":{"$ref":"#/components/schemas/FlagDetails","x-stream-index":"006"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"005"},"moderation_feedback":{"$ref":"#/components/schemas/FlagFeedback","x-stream-index":"003"},"moderation_result":{"$ref":"#/components/schemas/MessageModerationResult","x-stream-index":"002"},"reason":{"type":"string","x-stream-index":"007"},"rejected_at":{"format":"date-time","type":"string","x-stream-index":"014"},"reviewed_at":{"format":"date-time","type":"string","x-stream-index":"011"},"reviewed_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"012"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"004"}},"required":["created_by_automod","created_at","updated_at"],"type":"object"},"MessageFlaggedEvent":{"properties":{"cid":{"type":"string","x-stream-index":"001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"005.002"},"flag":{"$ref":"#/components/schemas/Flag","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"002.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"002.002"},"type":{"default":"message.flagged","type":"string","x-stream-index":"005.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004"}},"required":["cid","type","created_at"],"title":"MessageFlaggedEvent","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"},"MessageHistoryEntryResponse":{"nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"007"},"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"006"},"is_deleted":{"type":"boolean","x-stream-index":"004"},"message_id":{"type":"string","x-stream-index":"001"},"message_updated_at":{"format":"date-time","type":"string","x-stream-index":"003"},"message_updated_by_id":{"type":"string","x-stream-index":"002"},"text":{"type":"string","x-stream-index":"005"}},"required":["message_id","message_updated_by_id","message_updated_at","is_deleted","text","attachments","Custom"],"type":"object"},"MessageModerationResult":{"description":"Result of the message moderation","properties":{"action":{"description":"Action taken by automod","title":"Action","type":"string","x-stream-index":"002"},"ai_moderation_response":{"$ref":"#/components/schemas/ModerationResponse","description":"Response from AI moderation","title":"ModerationResponse","x-stream-index":"007"},"blocked_word":{"description":"Word that was blocked","title":"Blocked word","type":"string","x-stream-index":"004"},"blocklist_name":{"description":"Name of the blocklist","title":"Blocklist name","type":"string","x-stream-index":"005"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"010"},"message_id":{"description":"ID of the message","title":"Message ID","type":"string","x-stream-index":"001"},"moderated_by":{"description":"User who moderated the message","title":"Moderated by","type":"string","x-stream-index":"003"},"moderation_thresholds":{"$ref":"#/components/schemas/Thresholds","description":"Thresholds for AI moderation","title":"Thresholds","x-stream-index":"006"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"011"},"user_bad_karma":{"description":"Whether user has bad karma","title":"User bad karma","type":"boolean","x-stream-index":"009"},"user_karma":{"description":"Karma of the user","format":"float","title":"User karma","type":"number","x-stream-index":"008"}},"required":["message_id","action","user_karma","user_bad_karma","created_at","updated_at"],"title":"Message moderation result","type":"object"},"MessageNewEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"005.002"},"channel_type":{"type":"string","x-stream-index":"005.003"},"cid":{"type":"string","x-stream-index":"005.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"004.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"006.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"notification.thread_message_new","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"},"watcher_count":{"format":"int32","type":"integer","x-stream-index":"002.001"}},"required":["watcher_count","type","created_at","cid","channel_id","channel_type"],"title":"MessageNewEvent","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"},"MessageOptions":{"properties":{"include_thread_participants":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"MessagePaginationParams":{"type":"object"},"MessageReadEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"003"},"channel_last_message_at":{"format":"date-time","type":"string","x-stream-index":"005"},"channel_type":{"type":"string","x-stream-index":"004"},"cid":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"string","x-stream-index":"009"},"last_read_message_id":{"type":"string","x-stream-index":"010"},"team":{"type":"string","x-stream-index":"006"},"thread":{"$ref":"#/components/schemas/ThreadResponse","x-stream-index":"008"},"type":{"default":"message.read","type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","x-stream-index":"007"}},"required":["type","cid","channel_id","channel_type","created_at"],"type":"object"},"MessageReminder":{"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"004"},"channel_cid":{"type":"string","x-stream-index":"003"},"created_at":{"format":"date-time","type":"string","x-stream-index":"011"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"006"},"message_id":{"type":"string","x-stream-index":"005"},"remind_at":{"format":"date-time","type":"string","x-stream-index":"009"},"task_id":{"type":"string","x-stream-index":"010"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"012"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"user_id":{"type":"string","x-stream-index":"007"}},"required":["channel_cid","message_id","user_id","task_id","created_at","updated_at"],"type":"object"},"MessageRequest":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"maximum":30,"type":"array","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"html":{"type":"string","x-stream-index":"010"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"mentioned_users":{"items":{"type":"string"},"maximum":100,"type":"array","x-stream-index":"008"},"mml":{"type":"string","x-stream-index":"003"},"parent_id":{"type":"string","x-stream-index":"005"},"pin_expires":{"format":"date-time","type":"string","x-stream-index":"015"},"pinned":{"type":"boolean","x-stream-index":"013"},"pinned_at":{"format":"date-time","nullable":true,"type":"string","x-stream-index":"014"},"poll_id":{"type":"string","x-stream-index":"039"},"quoted_message_id":{"type":"string","x-stream-index":"009"},"restricted_visibility":{"items":{"type":"string"},"maximum":10,"type":"array","x-stream-index":"016"},"shared_location":{"$ref":"#/components/schemas/SharedLocation","x-stream-index":"040"},"show_in_channel":{"type":"boolean","x-stream-index":"006"},"silent":{"type":"boolean","x-stream-index":"012"},"text":{"type":"string","x-stream-index":"002"},"type":{"enum":["''","regular","system"],"type":"string","x-stream-index":"011"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"021.002"},"user_id":{"type":"string","x-stream-index":"021.001"}},"type":"object"},"MessageResponse":{"description":"Represents any chat message","properties":{"attachments":{"description":"Array of message attachments","items":{"$ref":"#/components/schemas/Attachment"},"title":"Message attachments","type":"array","x-stream-docs-page-id":"message_format#attachment-format","x-stream-index":"008"},"cid":{"description":"Channel unique identifier in \u003ctype\u003e:\u003cid\u003e format","title":"Channel CID","type":"string","x-stream-index":"022"},"command":{"description":"Contains provided slash command","title":"Command","type":"string","x-stream-docs-page-id":"custom_commands_webhook","x-stream-index":"004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"023"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"026"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"string","x-stream-index":"025"},"deleted_for_me":{"type":"boolean","x-stream-index":"044"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"018"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"041"},"html":{"description":"Contains HTML markup of the message. Can only be set when using server-side API","title":"HTML content","type":"string","x-stream-index":"005"},"i18n":{"additionalProperties":{"type":"string"},"description":"Object with translations. Key `language` contains the original language key. Other keys contain translations","title":"Internationalization info","type":"object","x-stream-docs-page-id":"translation","x-stream-index":"030"},"id":{"description":"Message ID is unique string identifier of the message","title":"ID","type":"string","x-stream-index":"001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"Contains image moderation information","title":"Image moderation labels","type":"object","x-stream-index":"028"},"latest_reactions":{"description":"List of 10 latest reactions to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Latest reactions","type":"array","x-stream-index":"009"},"mentioned_users":{"description":"List of mentioned users","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Mentioned Users","type":"array","x-stream-index":"029"},"message_text_updated_at":{"format":"date-time","type":"string","x-stream-index":"036"},"mml":{"description":"Should be empty if `text` is provided. Can only be set when using server-side API","title":"Messaging Markup Language","type":"string","x-stream-docs-page-id":"mml_overview","x-stream-index":"003"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"039"},"own_reactions":{"description":"List of 10 latest reactions of authenticated user to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Own reactions","type":"array","x-stream-index":"010"},"parent_id":{"description":"ID of parent message (thread)","title":"Parent message ID","type":"string","x-stream-docs-page-id":"threads","x-stream-index":"015"},"pin_expires":{"description":"Date when pinned message expires","format":"date-time","title":"Pin expiration date","type":"string","x-stream-docs-page-id":"pinned_messages","x-stream-index":"035"},"pinned":{"description":"Whether message is pinned or not","title":"Pinned","type":"boolean","x-stream-docs-page-id":"pinned_messages","x-stream-index":"032"},"pinned_at":{"description":"Date when message got pinned","format":"date-time","title":"Pinned at","type":"string","x-stream-docs-page-id":"pinned_messages","x-stream-index":"033"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","description":"Contains user who pinned the message","title":"Pinned by","x-stream-docs-page-id":"pinned_messages","x-stream-index":"034"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"038"},"poll_id":{"description":"Identifier of the poll to include in the message","title":"Poll ID","type":"string","x-stream-index":"037"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","description":"Contains quoted message","title":"Quoted message","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"020"},"quoted_message_id":{"title":"ID of quoted message","type":"string","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"019"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing number of reactions of each type. Key: reaction type (string), value: number of reactions (int)","title":"Reaction counts","type":"object","x-stream-index":"011"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"014"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing scores of reactions of each type. Key: reaction type (string), value: total score of reactions (int)","title":"Reaction scores","type":"object","x-stream-index":"012"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"042"},"reply_count":{"description":"Number of replies to this message","format":"int32","title":"Reply count","type":"integer","x-stream-index":"017"},"restricted_visibility":{"description":"A list of user ids that have restricted visibility to the message, if the list is not empty, the message is only visible to the users in the list","items":{"type":"string"},"title":"Restricted visibility","type":"array","x-stream-index":"040"},"shadowed":{"description":"Whether the message was shadowed or not","title":"Shadowed","type":"boolean","x-stream-docs-page-id":"moderation#shadow-ban","x-stream-index":"027"},"shared_location":{"$ref":"#/components/schemas/SharedLocationResponseData","description":"Contains shared location data","title":"Shared Location","x-stream-index":"043"},"show_in_channel":{"description":"Whether thread reply should be shown in the channel as well","title":"Show in channel","type":"boolean","x-stream-docs-page-id":"threads","x-stream-index":"016"},"silent":{"description":"Whether message is silent or not","title":"Silent","type":"boolean","x-stream-index":"031"},"text":{"description":"Text of the message. Should be empty if `mml` is provided","title":"Text","type":"string","x-stream-index":"002"},"thread_participants":{"description":"List of users who participate in thread","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Thread participants","type":"array","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"021"},"type":{"description":"Contains type of the message","enum":["regular","ephemeral","error","reply","system","deleted"],"title":"Message Type","type":"string","x-stream-docs-page-id":"message_format#message-types","x-stream-index":"006"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"024"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Sender of the message. Required when using server-side API","title":"User object","x-stream-index":"007"}},"required":["id","text","html","type","user","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned","restricted_visibility"],"title":"Message","type":"object","x-stream-docs-page-id":"send_message"},"MessageUnblockedEvent":{"properties":{"cid":{"type":"string","x-stream-index":"001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"004.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"002.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"002.002"},"type":{"default":"message.unblocked","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["cid","type","created_at"],"title":"MessageUnblockedEvent","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"},"MessageUndeletedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"005.002"},"channel_type":{"type":"string","x-stream-index":"005.003"},"cid":{"type":"string","x-stream-index":"005.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"004.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"002.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"message.undeleted","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MessageUndeletedEvent","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"},"MessageUpdate":{"properties":{"change_set":{"$ref":"#/components/schemas/MessageChangeSet","x-stream-index":"002"},"old_text":{"type":"string","x-stream-index":"001"}},"type":"object"},"MessageUpdatedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"005.002"},"channel_type":{"type":"string","x-stream-index":"005.003"},"cid":{"type":"string","x-stream-index":"005.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"004.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"002.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"message.updated","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MessageUpdatedEvent","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"},"MessageWithChannelResponse":{"description":"Represents any chat message","properties":{"attachments":{"description":"Array of message attachments","items":{"$ref":"#/components/schemas/Attachment"},"title":"Message attachments","type":"array","x-stream-docs-page-id":"message_format#attachment-format","x-stream-index":"001.008"},"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel object","title":"Channel","x-stream-index":"002"},"cid":{"description":"Channel unique identifier in \u003ctype\u003e:\u003cid\u003e format","title":"Channel CID","type":"string","x-stream-index":"001.022"},"command":{"description":"Contains provided slash command","title":"Command","type":"string","x-stream-docs-page-id":"custom_commands_webhook","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.023"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.026"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"string","x-stream-index":"001.025"},"deleted_for_me":{"type":"boolean","x-stream-index":"001.044"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"001.018"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001.041"},"html":{"description":"Contains HTML markup of the message. Can only be set when using server-side API","title":"HTML content","type":"string","x-stream-index":"001.005"},"i18n":{"additionalProperties":{"type":"string"},"description":"Object with translations. Key `language` contains the original language key. Other keys contain translations","title":"Internationalization info","type":"object","x-stream-docs-page-id":"translation","x-stream-index":"001.030"},"id":{"description":"Message ID is unique string identifier of the message","title":"ID","type":"string","x-stream-index":"001.001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"Contains image moderation information","title":"Image moderation labels","type":"object","x-stream-index":"001.028"},"latest_reactions":{"description":"List of 10 latest reactions to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Latest reactions","type":"array","x-stream-index":"001.009"},"mentioned_users":{"description":"List of mentioned users","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Mentioned Users","type":"array","x-stream-index":"001.029"},"message_text_updated_at":{"format":"date-time","type":"string","x-stream-index":"001.036"},"mml":{"description":"Should be empty if `text` is provided. Can only be set when using server-side API","title":"Messaging Markup Language","type":"string","x-stream-docs-page-id":"mml_overview","x-stream-index":"001.003"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"001.039"},"own_reactions":{"description":"List of 10 latest reactions of authenticated user to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Own reactions","type":"array","x-stream-index":"001.010"},"parent_id":{"description":"ID of parent message (thread)","title":"Parent message ID","type":"string","x-stream-docs-page-id":"threads","x-stream-index":"001.015"},"pin_expires":{"description":"Date when pinned message expires","format":"date-time","title":"Pin expiration date","type":"string","x-stream-docs-page-id":"pinned_messages","x-stream-index":"001.035"},"pinned":{"description":"Whether message is pinned or not","title":"Pinned","type":"boolean","x-stream-docs-page-id":"pinned_messages","x-stream-index":"001.032"},"pinned_at":{"description":"Date when message got pinned","format":"date-time","title":"Pinned at","type":"string","x-stream-docs-page-id":"pinned_messages","x-stream-index":"001.033"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","description":"Contains user who pinned the message","title":"Pinned by","x-stream-docs-page-id":"pinned_messages","x-stream-index":"001.034"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001.038"},"poll_id":{"description":"Identifier of the poll to include in the message","title":"Poll ID","type":"string","x-stream-index":"001.037"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","description":"Contains quoted message","title":"Quoted message","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"001.020"},"quoted_message_id":{"title":"ID of quoted message","type":"string","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"001.019"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing number of reactions of each type. Key: reaction type (string), value: number of reactions (int)","title":"Reaction counts","type":"object","x-stream-index":"001.011"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"001.014"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing scores of reactions of each type. Key: reaction type (string), value: total score of reactions (int)","title":"Reaction scores","type":"object","x-stream-index":"001.012"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"001.042"},"reply_count":{"description":"Number of replies to this message","format":"int32","title":"Reply count","type":"integer","x-stream-index":"001.017"},"restricted_visibility":{"description":"A list of user ids that have restricted visibility to the message, if the list is not empty, the message is only visible to the users in the list","items":{"type":"string"},"title":"Restricted visibility","type":"array","x-stream-index":"001.040"},"shadowed":{"description":"Whether the message was shadowed or not","title":"Shadowed","type":"boolean","x-stream-docs-page-id":"moderation#shadow-ban","x-stream-index":"001.027"},"shared_location":{"$ref":"#/components/schemas/SharedLocationResponseData","description":"Contains shared location data","title":"Shared Location","x-stream-index":"001.043"},"show_in_channel":{"description":"Whether thread reply should be shown in the channel as well","title":"Show in channel","type":"boolean","x-stream-docs-page-id":"threads","x-stream-index":"001.016"},"silent":{"description":"Whether message is silent or not","title":"Silent","type":"boolean","x-stream-index":"001.031"},"text":{"description":"Text of the message. Should be empty if `mml` is provided","title":"Text","type":"string","x-stream-index":"001.002"},"thread_participants":{"description":"List of users who participate in thread","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Thread participants","type":"array","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"001.021"},"type":{"description":"Contains type of the message","enum":["regular","ephemeral","error","reply","system","deleted"],"title":"Message Type","type":"string","x-stream-docs-page-id":"message_format#message-types","x-stream-index":"001.006"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"001.024"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Sender of the message. Required when using server-side API","title":"User object","x-stream-index":"001.007"}},"required":["id","text","html","type","user","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned","restricted_visibility","channel"],"title":"Message","type":"object","x-stream-docs-page-id":"send_message"},"ModerationDashboardPreferences":{"properties":{"flag_user_on_flagged_content":{"type":"boolean","x-stream-index":"002"},"media_queue_blur_enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"ModerationResponse":{"properties":{"action":{"type":"string","x-stream-index":"004"},"explicit":{"format":"float","type":"number","x-stream-index":"002"},"spam":{"format":"float","type":"number","x-stream-index":"003"},"toxic":{"format":"float","type":"number","x-stream-index":"001"}},"required":["toxic","explicit","spam","action","automod_response"],"type":"object"},"ModerationV2Response":{"properties":{"action":{"type":"string","x-stream-index":"001"},"blocklist_matched":{"type":"string","x-stream-index":"005"},"image_harms":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"original_text":{"type":"string","x-stream-index":"002"},"platform_circumvented":{"type":"boolean","x-stream-index":"007"},"semantic_filter_matched":{"type":"string","x-stream-index":"006"},"text_harms":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"required":["action","original_text"],"type":"object"},"MuteChannelRequest":{"nullable":true,"properties":{"channel_cids":{"description":"Channel CIDs to mute (if multiple channels)","items":{"type":"string"},"maximum":25,"title":"Channel CIDs","type":"array","x-stream-index":"002"},"expiration":{"description":"Duration of mute in milliseconds","title":"Expiration","type":"integer","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"type":"object"},"MuteChannelResponse":{"nullable":true,"properties":{"channel_mute":{"$ref":"#/components/schemas/ChannelMute","description":"Object with channel mute (if one channel was muted)","title":"Channel mute","x-stream-index":"001"},"channel_mutes":{"description":"Object with mutes (if multiple channels were muted)","items":{"$ref":"#/components/schemas/ChannelMute"},"title":"Channel mutes","type":"array","x-stream-index":"002"},"duration":{"type":"string","x-stream-index":"004.001"},"own_user":{"$ref":"#/components/schemas/OwnUser","description":"Authorized user object with fresh mutes information","title":"Own user","x-stream-index":"003"}},"required":["duration"],"type":"object"},"MuteUserRequest":{"nullable":true,"properties":{"target_ids":{"description":"User IDs to mute (if multiple users)","items":{"type":"string"},"maximum":1000,"title":"Target IDs","type":"array","x-stream-index":"002"},"timeout":{"description":"Duration of mute in minutes","minimum":0,"title":"Timeout","type":"integer","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"required":["timeout"],"type":"object"},"MuteUserResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"005.001"},"mute":{"$ref":"#/components/schemas/UserMute","description":"Object with user mute (if one user was muted)","title":"Mute","x-stream-index":"001"},"mutes":{"description":"Object with mutes (if multiple users were muted)","items":{"$ref":"#/components/schemas/UserMute"},"title":"Mutes","type":"array","x-stream-index":"002"},"non_existing_users":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"own_user":{"$ref":"#/components/schemas/OwnUser","description":"Authorized user object with fresh mutes information","title":"Own user","x-stream-index":"003"}},"required":["duration"],"type":"object"},"NoiseCancellationSettings":{"properties":{"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode"],"type":"object"},"NotificationMarkUnreadEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003.004"},"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"003.005"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"first_unread_message_id":{"type":"string","x-stream-index":"005"},"last_read_at":{"format":"date-time","type":"string","x-stream-index":"006"},"last_read_message_id":{"type":"string","x-stream-index":"012"},"team":{"type":"string","x-stream-index":"002.001"},"thread_id":{"type":"string","x-stream-index":"013"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"009"},"type":{"default":"notification.mark_unread","type":"string","x-stream-index":"001.001"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"010"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"008"},"unread_messages":{"format":"int32","type":"integer","x-stream-index":"007"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"011"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count","first_unread_message_id","last_read_at","unread_messages","unread_count","total_unread_count","unread_channels","unread_threads"],"title":"NotificationMarkUnreadEvent","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"},"NotificationSettings":{"properties":{"call_live_started":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"002"},"call_missed":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"006"},"call_notification":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"004"},"call_ring":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"session_started":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"003"}},"required":["enabled","call_live_started","session_started","call_notification","call_ring","call_missed"],"type":"object"},"OnlyUserID":{"properties":{"id":{"type":"string","x-stream-index":"001"}},"required":["id"],"type":"object"},"OwnUser":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"046"},"banned":{"type":"boolean","x-stream-index":"016"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"045"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"029"},"created_at":{"format":"date-time","type":"string","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"deactivated_at":{"format":"date-time","type":"string","x-stream-index":"014"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"013"},"devices":{"items":{"$ref":"#/components/schemas/Device"},"type":"array","x-stream-index":"027"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"023"},"language":{"type":"string","x-stream-index":"035"},"last_active":{"format":"date-time","type":"string","x-stream-index":"011"},"last_engaged_at":{"format":"date-time","type":"string","x-stream-index":"012"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"037"},"mutes":{"items":{"$ref":"#/components/schemas/UserMute"},"type":"array","x-stream-index":"028"},"online":{"type":"boolean","x-stream-index":"022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"026"},"push_preferences":{"$ref":"#/components/schemas/PushPreferences","x-stream-index":"025"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"005"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"031"},"total_unread_count_by_team":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"032"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"033"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"030"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"034"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"009"}},"required":["id","role","custom","created_at","updated_at","banned","online","devices","mutes","channel_mutes","unread_count","total_unread_count","total_unread_count_by_team","unread_channels","unread_threads","language"],"type":"object"},"OwnUserResponse":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"banned":{"type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"015"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"007"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"string","x-stream-index":"001.016"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"001.011"},"devices":{"items":{"$ref":"#/components/schemas/DeviceResponse"},"title":"Devices","type":"array","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001.001"},"image":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"005"},"language":{"type":"string","x-stream-index":"001.005"},"last_active":{"format":"date-time","type":"string","x-stream-index":"001.014"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"013"},"mutes":{"items":{"$ref":"#/components/schemas/UserMuteResponse"},"type":"array","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"001.002"},"online":{"type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"003"},"push_preferences":{"$ref":"#/components/schemas/PushPreferences","x-stream-index":"002"},"revoke_tokens_issued_before":{"format":"date-time","type":"string","x-stream-index":"001.015"},"role":{"type":"string","x-stream-index":"001.006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"009"},"total_unread_count_by_team":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"010"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"011"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"008"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"012"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","devices","invisible","mutes","channel_mutes","unread_count","total_unread_count","unread_channels","unread_threads"],"type":"object"},"PagerResponse":{"properties":{"next":{"type":"string","x-stream-index":"001"},"prev":{"type":"string","x-stream-index":"002"}},"type":"object"},"PaginationParams":{"properties":{"limit":{"format":"int32","minimum":0,"type":"integer","x-stream-index":"001"},"offset":{"format":"int32","type":"integer","x-stream-index":"002"}},"type":"object"},"PendingMessageEvent":{"description":"Pending message event for async moderation","nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"002.007"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"message":{"$ref":"#/components/schemas/Message","description":"The pending message","title":"Message","x-stream-index":"002.009"},"metadata":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"002.010"},"method":{"description":"The method used for the pending message","title":"Method","type":"string","x-stream-index":"003"},"received_at":{"format":"date-time","type":"string","x-stream-index":"001.004"},"type":{"default":"message.pending","description":"The type of event: \"message.pending\" in this case","title":"Event Type","type":"string","x-stream-index":"001.002"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.002"}},"required":["type","custom","method","created_at"],"title":"PendingMessageEvent","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"},"PendingMessageResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"003"},"metadata":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"}},"type":"object"},"Permission":{"properties":{"action":{"description":"Action name this permission is for (e.g. SendMessage)","title":"Action","type":"string","x-stream-index":"004"},"condition":{"additionalProperties":{},"description":"MongoDB style condition which decides whether or not the permission is granted","title":"Condition","type":"object","x-stream-index":"007"},"custom":{"description":"Whether this is a custom permission or built-in","title":"Custom","type":"boolean","x-stream-index":"009"},"description":{"description":"Description of the permission","title":"Description","type":"string","x-stream-index":"003"},"id":{"description":"Unique permission ID","title":"ID","type":"string","x-stream-index":"001"},"level":{"description":"Level at which permission could be applied (app or channel)","enum":["app","channel"],"title":"Level","type":"string","x-stream-index":"010"},"name":{"description":"Name of the permission","title":"Name","type":"string","x-stream-index":"002"},"owner":{"description":"Whether this permission applies to resource owner or not","title":"Owner","type":"boolean","x-stream-index":"005"},"same_team":{"description":"Whether this permission applies to teammates (multi-tenancy mode only)","title":"Same team","type":"boolean","x-stream-index":"006"},"tags":{"description":"List of tags of the permission","items":{"type":"string"},"title":"Tags","type":"array","x-stream-index":"011"}},"required":["id","name","description","action","owner","same_team","custom","level","tags"],"type":"object"},"Policy":{"properties":{"action":{"type":"integer","x-stream-index":"007"},"created_at":{"format":"date-time","type":"string","x-stream-index":"010"},"name":{"type":"string","x-stream-index":"004"},"owner":{"type":"boolean","x-stream-index":"008"},"priority":{"format":"int32","type":"integer","x-stream-index":"009"},"resources":{"items":{"type":"string"},"type":"array","x-stream-index":"005"},"roles":{"items":{"type":"string"},"type":"array","x-stream-index":"006"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"011"}},"required":["name","resources","roles","action","owner","priority","created_at","updated_at"],"type":"object"},"PolicyRequest":{"description":"Policy request","properties":{"action":{"enum":["Deny","Allow"],"title":"Action","type":"string","x-stream-index":"001"},"name":{"description":"User-friendly policy name","title":"Name","type":"string","x-stream-index":"002"},"owner":{"description":"Whether policy applies to resource owner or not","title":"Owner","type":"boolean","x-stream-index":"005"},"priority":{"description":"Policy priority","format":"int32","maximum":999,"minimum":1,"title":"Priority","type":"integer","x-stream-index":"006"},"resources":{"description":"List of resources to apply policy to","items":{"type":"string"},"minimum":1,"title":"Resources","type":"array","x-stream-index":"003"},"roles":{"description":"List of roles to apply policy to","items":{"type":"string"},"title":"Roles","type":"array","x-stream-index":"004"}},"required":["action","name","resources","roles","owner","priority"],"title":"PolicyRequest","type":"object"},"Poll":{"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"023"},"allow_answers":{"type":"boolean","x-stream-index":"010"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"009"},"answers_count":{"format":"int32","type":"integer","x-stream-index":"015"},"created_at":{"format":"date-time","type":"string","x-stream-index":"021"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"020"},"created_by_id":{"type":"string","x-stream-index":"019"},"description":{"type":"string","x-stream-index":"005"},"enforce_unique_vote":{"type":"boolean","x-stream-index":"007"},"id":{"type":"string","x-stream-index":"003"},"is_closed":{"type":"boolean","x-stream-index":"011"},"latest_answers":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array","x-stream-index":"017"},"latest_votes_by_option":{"additionalProperties":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array"},"type":"object","x-stream-index":"016"},"max_votes_allowed":{"format":"int32","type":"integer","x-stream-index":"008"},"name":{"type":"string","x-stream-index":"004"},"options":{"items":{"$ref":"#/components/schemas/PollOption"},"type":"array","x-stream-index":"013"},"own_votes":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array","x-stream-index":"018"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"022"},"vote_count":{"format":"int32","type":"integer","x-stream-index":"012"},"vote_counts_by_option":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"014"},"voting_visibility":{"type":"string","x-stream-index":"006"}},"required":["id","name","description","enforce_unique_vote","allow_user_suggested_options","allow_answers","vote_count","options","vote_counts_by_option","answers_count","latest_votes_by_option","latest_answers","own_votes","created_by_id","created_at","updated_at","Custom"],"type":"object"},"PollOption":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id","text","custom"],"type":"object"},"PollOptionInput":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"text":{"type":"string","x-stream-index":"002"}},"type":"object"},"PollOptionRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id"],"type":"object"},"PollOptionResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"poll_option":{"$ref":"#/components/schemas/PollOptionResponseData","description":"Poll option","title":"PollOptionResponseData","x-stream-index":"001"}},"required":["poll_option","duration"],"type":"object"},"PollOptionResponseData":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id","text","custom"],"type":"object"},"PollResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"poll":{"$ref":"#/components/schemas/PollResponseData","description":"Poll","title":"PollResponseData","x-stream-index":"001"}},"required":["poll","duration"],"type":"object"},"PollResponseData":{"properties":{"allow_answers":{"type":"boolean","x-stream-index":"008"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"007"},"answers_count":{"format":"int32","type":"integer","x-stream-index":"012"},"created_at":{"format":"date-time","type":"string","x-stream-index":"019"},"created_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"018"},"created_by_id":{"type":"string","x-stream-index":"017"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"021"},"description":{"type":"string","x-stream-index":"003"},"enforce_unique_vote":{"type":"boolean","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"is_closed":{"type":"boolean","x-stream-index":"009"},"latest_answers":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array","x-stream-index":"015"},"latest_votes_by_option":{"additionalProperties":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array"},"type":"object","x-stream-index":"014"},"max_votes_allowed":{"format":"int32","type":"integer","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"002"},"options":{"items":{"$ref":"#/components/schemas/PollOptionResponseData"},"type":"array","x-stream-index":"011"},"own_votes":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array","x-stream-index":"016"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"020"},"vote_count":{"format":"int32","type":"integer","x-stream-index":"010"},"vote_counts_by_option":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"013"},"voting_visibility":{"type":"string","x-stream-index":"004"}},"required":["id","name","description","voting_visibility","enforce_unique_vote","allow_user_suggested_options","allow_answers","vote_count","options","answers_count","vote_counts_by_option","latest_votes_by_option","latest_answers","own_votes","created_by_id","created_at","updated_at","custom"],"type":"object"},"PollVote":{"nullable":true,"properties":{"answer_text":{"type":"string","x-stream-index":"007"},"created_at":{"format":"date-time","type":"string","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"004"},"is_answer":{"type":"boolean","x-stream-index":"006"},"option_id":{"type":"string","x-stream-index":"005"},"poll_id":{"type":"string","x-stream-index":"003"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"011"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"009"},"user_id":{"type":"string","x-stream-index":"008"}},"required":["poll_id","id","option_id","created_at","updated_at"],"type":"object"},"PollVoteResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"vote":{"$ref":"#/components/schemas/PollVoteResponseData","description":"Poll vote","title":"PollVoteResponseData","x-stream-index":"001"}},"required":["duration"],"type":"object"},"PollVoteResponseData":{"nullable":true,"properties":{"answer_text":{"type":"string","x-stream-index":"005"},"created_at":{"format":"date-time","type":"string","x-stream-index":"008"},"id":{"type":"string","x-stream-index":"002"},"is_answer":{"type":"boolean","x-stream-index":"004"},"option_id":{"type":"string","x-stream-index":"003"},"poll_id":{"type":"string","x-stream-index":"001"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"007"},"user_id":{"type":"string","x-stream-index":"006"}},"required":["poll_id","id","option_id","created_at","updated_at"],"type":"object"},"PollVotesResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"votes":{"description":"Poll votes","items":{"$ref":"#/components/schemas/PollVoteResponseData"},"title":"PollVoteResponseList","type":"array","x-stream-index":"001"}},"required":["votes","duration"],"type":"object"},"PrivacySettings":{"properties":{"read_receipts":{"$ref":"#/components/schemas/ReadReceipts","x-stream-index":"002"},"typing_indicators":{"$ref":"#/components/schemas/TypingIndicators","x-stream-index":"001"}},"type":"object"},"PrivacySettingsResponse":{"properties":{"read_receipts":{"$ref":"#/components/schemas/ReadReceiptsResponse","x-stream-index":"002"},"typing_indicators":{"$ref":"#/components/schemas/TypingIndicatorsResponse","x-stream-index":"001"}},"type":"object"},"PushConfig":{"properties":{"offline_only":{"type":"boolean","x-stream-index":"002"},"version":{"enum":["v1","v2","v3"],"type":"string","x-stream-index":"001"}},"required":["version"],"type":"object"},"PushNotificationFields":{"properties":{"apn":{"$ref":"#/components/schemas/APNConfigFields","x-stream-index":"002"},"firebase":{"$ref":"#/components/schemas/FirebaseConfigFields","x-stream-index":"003"},"huawei":{"$ref":"#/components/schemas/HuaweiConfigFields","x-stream-index":"004"},"offline_only":{"type":"boolean","x-stream-index":"001.002"},"providers":{"items":{"$ref":"#/components/schemas/PushProvider"},"type":"array","x-stream-index":"006"},"version":{"type":"string","x-stream-index":"001.001"},"xiaomi":{"$ref":"#/components/schemas/XiaomiConfigFields","x-stream-index":"005"}},"required":["version","offline_only","apn","firebase","huawei","xiaomi"],"type":"object"},"PushNotificationSettingsResponse":{"properties":{"disabled":{"type":"boolean","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"string","x-stream-index":"002"}},"type":"object"},"PushPreferenceInput":{"nullable":true,"properties":{"call_level":{"description":"Set the level of call push notifications for the user. One of all, none, default","enum":["all","none","default"],"type":"string","x-stream-index":"004"},"channel_cid":{"description":"Set the push preferences for a specific channel. If empty it sets the default for the user","type":"string","x-stream-index":"002"},"chat_level":{"description":"Set the level of chat push notifications for the user. One of all, mentions, none, default","enum":["all","mentions","none","default"],"type":"string","x-stream-index":"003"},"disabled_until":{"description":"Disable push notifications till a certain time","format":"date-time","type":"string","x-stream-index":"007"},"feeds_events":{"$ref":"#/components/schemas/FeedsEventPreferencesInput","description":"Set granular feeds event preferences for reactions, comments, new followers, and mentions","x-stream-index":"006"},"feeds_level":{"description":"Set the level of feeds push notifications for the user. One of all, none, default","enum":["all","none","default"],"type":"string","x-stream-index":"005"},"remove_disable":{"description":"Remove the disabled until time. (IE stop snoozing notifications)","type":"boolean","x-stream-index":"008"},"user_id":{"description":"The user id for which to set the push preferences. Required when using server side auths, defaults to current user with client side auth.","type":"string","x-stream-index":"001"}},"type":"object"},"PushPreferences":{"properties":{"call_level":{"type":"string","x-stream-index":"002"},"chat_level":{"type":"string","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"string","x-stream-index":"005"},"feeds_events":{"$ref":"#/components/schemas/FeedsEventPreferences","x-stream-index":"004"},"feeds_level":{"type":"string","x-stream-index":"003"}},"type":"object"},"PushProvider":{"nullable":true,"properties":{"apn_auth_key":{"type":"string","x-stream-index":"012"},"apn_auth_type":{"type":"string","x-stream-index":"017"},"apn_development":{"type":"boolean","x-stream-index":"018"},"apn_host":{"type":"string","x-stream-index":"019"},"apn_key_id":{"type":"string","x-stream-index":"013"},"apn_notification_template":{"type":"string","x-stream-index":"020"},"apn_p12_cert":{"type":"string","x-stream-index":"014"},"apn_team_id":{"type":"string","x-stream-index":"015"},"apn_topic":{"type":"string","x-stream-index":"016"},"created_at":{"format":"date-time","type":"string","x-stream-index":"008"},"description":{"maxLength":128,"type":"string","x-stream-index":"007"},"disabled_at":{"format":"date-time","type":"string","x-stream-index":"010"},"disabled_reason":{"maxLength":255,"type":"string","x-stream-index":"011"},"firebase_apn_template":{"type":"string","x-stream-index":"025"},"firebase_credentials":{"type":"string","x-stream-index":"022"},"firebase_data_template":{"type":"string","x-stream-index":"023"},"firebase_host":{"type":"string","x-stream-index":"026"},"firebase_notification_template":{"type":"string","x-stream-index":"024"},"firebase_server_key":{"type":"string","x-stream-index":"021"},"huawei_app_id":{"type":"string","x-stream-index":"027"},"huawei_app_secret":{"type":"string","x-stream-index":"028"},"name":{"maxLength":36,"minLength":1,"type":"string","x-stream-index":"005"},"push_templates":{"items":{"$ref":"#/components/schemas/PushTemplate"},"type":"array","x-stream-index":"031"},"type":{"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"009"},"xiaomi_app_secret":{"type":"string","x-stream-index":"030"},"xiaomi_package_name":{"type":"string","x-stream-index":"029"}},"required":["name","type","created_at","updated_at"],"type":"object"},"PushProviderResponse":{"properties":{"apn_auth_key":{"type":"string","x-stream-index":"008"},"apn_auth_type":{"type":"string","x-stream-index":"013"},"apn_development":{"type":"boolean","x-stream-index":"014"},"apn_host":{"type":"string","x-stream-index":"015"},"apn_key_id":{"type":"string","x-stream-index":"009"},"apn_p12_cert":{"type":"string","x-stream-index":"010"},"apn_sandbox_certificate":{"type":"boolean","x-stream-index":"016"},"apn_supports_remote_notifications":{"type":"boolean","x-stream-index":"018"},"apn_supports_voip_notifications":{"type":"boolean","x-stream-index":"017"},"apn_team_id":{"type":"string","x-stream-index":"011"},"apn_topic":{"type":"string","x-stream-index":"012"},"created_at":{"format":"date-time","type":"string","x-stream-index":"004"},"description":{"type":"string","x-stream-index":"003"},"disabled_at":{"format":"date-time","type":"string","x-stream-index":"006"},"disabled_reason":{"type":"string","x-stream-index":"007"},"firebase_apn_template":{"type":"string","x-stream-index":"023"},"firebase_credentials":{"type":"string","x-stream-index":"020"},"firebase_data_template":{"type":"string","x-stream-index":"021"},"firebase_host":{"type":"string","x-stream-index":"024"},"firebase_notification_template":{"type":"string","x-stream-index":"022"},"firebase_server_key":{"type":"string","x-stream-index":"019"},"huawei_app_id":{"type":"string","x-stream-index":"025"},"huawei_app_secret":{"type":"string","x-stream-index":"026"},"name":{"type":"string","x-stream-index":"001"},"type":{"type":"string","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"005"},"xiaomi_app_secret":{"type":"string","x-stream-index":"028"},"xiaomi_package_name":{"type":"string","x-stream-index":"027"}},"required":["name","type","created_at","updated_at"],"type":"object"},"PushTemplate":{"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"007"},"enable_push":{"type":"boolean","x-stream-index":"003"},"event_type":{"enum":["message.new","message.updated","reaction.new","notification.reminder_due","feeds.activity.added","feeds.comment.added","feeds.activity.reaction.added","feeds.comment.reaction.added","feeds.follow.created","feeds.notification_feed.updated"],"type":"string","x-stream-index":"005"},"template":{"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"008"}},"required":["enable_push","event_type","created_at","updated_at"],"type":"object"},"QueryBannedUsersPayload":{"properties":{"exclude_expired_bans":{"description":"Whether to exclude expired bans or not","title":"Exclude expired bans","type":"boolean","x-stream-index":"004"},"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"description":"Number of records to return","format":"int32","maximum":300,"minimum":0,"title":"Limit","type":"integer","x-stream-index":"003.003"},"offset":{"description":"Number of records to offset","format":"int32","maximum":10000,"title":"Offset","type":"integer","x-stream-index":"003.004"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":1,"title":"Sort","type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"005.002"},"user_id":{"type":"string","x-stream-index":"005.001"}},"required":["filter_conditions"],"type":"object"},"QueryBannedUsersResponse":{"nullable":true,"properties":{"bans":{"description":"List of found bans","items":{"$ref":"#/components/schemas/BanResponse"},"title":"BanResponse","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["bans","duration"],"type":"object"},"QueryCampaignsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"004.001"},"next":{"type":"string","x-stream-index":"004.002"},"prev":{"type":"string","x-stream-index":"004.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"type":"array","x-stream-index":"002"},"user_limit":{"format":"int32","maximum":1000,"minimum":0,"type":"integer","x-stream-index":"003"}},"type":"object"},"QueryCampaignsResponse":{"description":"Basic response information","nullable":true,"properties":{"campaigns":{"items":{"$ref":"#/components/schemas/CampaignResponse"},"type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["campaigns","duration"],"title":"Response","type":"object"},"QueryChannelsRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"description":"Number of channels to limit","format":"int32","title":"Limit","type":"integer","x-stream-index":"008"},"member_limit":{"description":"Number of members to limit","format":"int32","maximum":100,"minimum":0,"title":"Member limit","type":"integer","x-stream-index":"007"},"message_limit":{"description":"Number of messages to limit","format":"int32","minimum":0,"title":"Message limit","type":"integer","x-stream-index":"006"},"offset":{"description":"Channel pagination offset","format":"int32","title":"Offset","type":"integer","x-stream-index":"009"},"sort":{"description":"List of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"002"},"state":{"description":"Whether to update channel state or not","title":"State","type":"boolean","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"010.002"},"user_id":{"type":"string","x-stream-index":"010.001"}},"title":"Query Channels Request","type":"object","x-stream-docs-page-id":"query_channels"},"QueryChannelsResponse":{"nullable":true,"properties":{"channels":{"description":"List of channels","items":{"$ref":"#/components/schemas/ChannelStateResponseFields"},"title":"Channels","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["channels","duration"],"title":"Channels list","type":"object"},"QueryDraftsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","maximum":3,"title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"type":"object"},"QueryDraftsResponse":{"nullable":true,"properties":{"drafts":{"description":"Drafts","items":{"$ref":"#/components/schemas/DraftResponse"},"title":"DraftsResponseList","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["drafts","duration"],"type":"object"},"QueryMembersPayload":{"description":"Client request","properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"002"},"limit":{"format":"int32","maximum":300,"minimum":0,"type":"integer","x-stream-index":"006.003"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"type":"array","x-stream-index":"003"},"offset":{"format":"int32","maximum":10000,"type":"integer","x-stream-index":"006.004"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":1,"type":"array","x-stream-index":"005"},"type":{"maxLength":64,"type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"007.002"},"user_id":{"type":"string","x-stream-index":"007.001"}},"required":["type","filter_conditions"],"title":"ClientRequest","type":"object"},"QueryMessageFlagsPayload":{"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":300,"minimum":0,"type":"integer","x-stream-index":"003.003"},"offset":{"format":"int32","maximum":10000,"type":"integer","x-stream-index":"003.004"},"show_deleted_messages":{"description":"Whether to include deleted messages in the results","title":"ShowDeletedMessages","type":"boolean","x-stream-index":"002"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"type":"array","x-stream-index":"003.005"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"type":"object"},"QueryMessageFlagsResponse":{"description":"Query message flags response","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"flags":{"description":"The flags that match the query","items":{"$ref":"#/components/schemas/MessageFlagResponse"},"title":"MessageFlagResponseList","type":"array","x-stream-index":"001"}},"required":["flags","duration"],"title":"QueryMessageFlagsResponse","type":"object"},"QueryMessageHistoryRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","maximum":3,"minimum":1,"title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"004.001"},"next":{"type":"string","x-stream-index":"004.002"},"prev":{"type":"string","x-stream-index":"004.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"002"}},"required":["filter"],"type":"object"},"QueryMessageHistoryResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message_history":{"description":"Message history entries","items":{"$ref":"#/components/schemas/MessageHistoryEntryResponse"},"title":"MessageHistoryEntryResponseList","type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["message_history","duration"],"type":"object"},"QueryPollVotesRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","title":"Filter","type":"object","x-stream-index":"003"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"004"}},"type":"object"},"QueryPollsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","title":"Filter","type":"object","x-stream-index":"002"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"003"}},"type":"object"},"QueryPollsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"polls":{"description":"Polls data returned by the query","items":{"$ref":"#/components/schemas/PollResponseData"},"title":"PollsResponseData","type":"array","x-stream-index":"001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["polls","duration"],"type":"object"},"QueryReactionsRequest":{"properties":{"filter":{"additionalProperties":{},"type":"object","x-stream-index":"002"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"006.001"},"next":{"type":"string","x-stream-index":"006.002"},"prev":{"type":"string","x-stream-index":"006.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":2,"type":"array","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"type":"object"},"QueryReactionsResponse":{"description":"Basic response information","properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"next":{"type":"string","x-stream-index":"003.001"},"prev":{"type":"string","x-stream-index":"003.002"},"reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"001"}},"required":["reactions","duration"],"title":"Response","type":"object"},"QueryRemindersRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"type":"object"},"QueryRemindersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"reminders":{"description":"MessageReminders data returned by the query","items":{"$ref":"#/components/schemas/ReminderResponseData"},"title":"RemindersResponseData","type":"array","x-stream-index":"001"}},"required":["reminders","duration"],"type":"object"},"QuerySegmentTargetsRequest":{"nullable":true,"properties":{"Filter":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"005"},"Sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"type":"array","writeOnly":true,"x-stream-index":"006"},"limit":{"description":"Limit","format":"int32","maximum":10000,"minimum":0,"title":"int","type":"integer","x-stream-index":"002"},"next":{"description":"Next","title":"string","type":"string","x-stream-index":"003"},"prev":{"description":"Prev","title":"string","type":"string","x-stream-index":"004"}},"type":"object"},"QuerySegmentTargetsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"targets":{"description":"Targets","items":{"$ref":"#/components/schemas/SegmentTargetResponse"},"title":"SegmentTargetResponseList","type":"array","x-stream-index":"001"}},"required":["targets","duration"],"type":"object"},"QuerySegmentsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"002"}},"required":["filter"],"type":"object"},"QuerySegmentsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"segments":{"description":"Segments","items":{"$ref":"#/components/schemas/SegmentResponse"},"title":"SegmentResponses","type":"array","x-stream-index":"001"}},"required":["segments","duration"],"type":"object"},"QueryThreadsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter conditions to apply to threads","title":"Filter","type":"object","x-stream-index":"006"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"008.001"},"member_limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005"},"next":{"type":"string","x-stream-index":"008.002"},"participant_limit":{"description":"Limit the number of participants returned per each thread","format":"int32","maximum":100,"minimum":0,"title":"Participant limit","type":"integer","x-stream-index":"004"},"prev":{"type":"string","x-stream-index":"008.003"},"reply_limit":{"description":"Limit the number of replies returned per each thread","format":"int32","maximum":10,"minimum":0,"title":"Reply limit","type":"integer","x-stream-index":"003"},"sort":{"description":"Sort conditions to apply to threads","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"007"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"010.002"},"user_id":{"type":"string","x-stream-index":"010.001"}},"type":"object"},"QueryThreadsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"threads":{"description":"List of enriched thread states","items":{"$ref":"#/components/schemas/ThreadStateResponse"},"title":"Threads","type":"array","x-stream-index":"001"}},"required":["threads","duration"],"type":"object"},"QueryUsersPayload":{"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"include_deactivated_users":{"type":"boolean","x-stream-index":"004"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.003"},"offset":{"format":"int32","maximum":1000,"type":"integer","x-stream-index":"005.004"},"presence":{"type":"boolean","x-stream-index":"003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"006.002"},"user_id":{"type":"string","x-stream-index":"006.001"}},"required":["filter_conditions"],"type":"object"},"QueryUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"users":{"description":"Array of users as result of filters applied.","items":{"$ref":"#/components/schemas/FullUserResponse"},"title":"Users","type":"array","x-stream-index":"001"}},"required":["users","duration"],"type":"object"},"RTMPLocation":{"properties":{"name":{"type":"string","x-stream-index":"001"},"stream_key":{"type":"string","x-stream-index":"003"},"stream_url":{"type":"string","x-stream-index":"002"}},"required":["name","stream_url","stream_key"],"type":"object"},"RTMPSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"003"},"location":{"$ref":"#/components/schemas/RTMPLocation","x-stream-index":"004"},"quality_name":{"type":"string","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"Reaction":{"nullable":true,"properties":{"created_at":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"message_id":{"type":"string","x-stream-index":"003"},"score":{"format":"int32","type":"integer","x-stream-index":"007"},"type":{"maxLength":30,"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["message_id","type","score","created_at","updated_at","custom"],"type":"object"},"ReactionDeletedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"006.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"002"},"team":{"type":"string","x-stream-index":"005.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"reaction.deleted","type":"string","x-stream-index":"006.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"ReactionDeletedEvent","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"},"ReactionGroupResponse":{"description":"ReactionGroupResponse contains all information about a reaction of the same type.","nullable":true,"properties":{"count":{"description":"Count is the number of reactions of this type.","format":"int32","title":"Count","type":"integer","x-stream-index":"001"},"first_reaction_at":{"description":"FirstReactionAt is the time of the first reaction of this type. This is the same also if all reaction of this type are deleted, because if someone will react again with the same type, will be preserved the sorting.","format":"date-time","title":"FirstReactionAt","type":"string","x-stream-index":"003"},"last_reaction_at":{"description":"LastReactionAt is the time of the last reaction of this type.","format":"date-time","title":"LastReactionAt","type":"string","x-stream-index":"004"},"sum_scores":{"description":"SumScores is the sum of all scores of reactions of this type. Medium allows you to clap articles more than once and shows the sum of all claps from all users. For example, you can send `clap` x5 using `score: 5`.","format":"int32","title":"SumScores","type":"integer","x-stream-index":"002"}},"required":["count","sum_scores","first_reaction_at","last_reaction_at"],"title":"ReactionGroupResponse","type":"object"},"ReactionNewEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"006.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"002"},"team":{"type":"string","x-stream-index":"005.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"reaction.new","type":"string","x-stream-index":"006.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"ReactionNewEvent","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"},"ReactionRequest":{"description":"Represents user reaction to a message","properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"score":{"description":"Reaction score. If not specified reaction has score of 1","format":"int32","title":"Score","type":"integer","x-stream-index":"002"},"type":{"description":"The type of reaction (e.g. 'like', 'laugh', 'wow')","maxLength":30,"title":"Type","type":"string","x-stream-index":"001"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"006.002"},"user_id":{"type":"string","x-stream-index":"006.001"}},"required":["type"],"title":"Reaction","type":"object","x-stream-docs-page-id":"send_reaction"},"ReactionResponse":{"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"006"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"008"},"message_id":{"description":"Message ID","title":"Message ID","type":"string","x-stream-index":"001"},"score":{"description":"Score of the reaction","format":"int32","title":"Score","type":"integer","x-stream-index":"005"},"type":{"description":"Type of reaction","title":"Type","type":"string","x-stream-index":"004"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"007"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User","title":"UserResponse","x-stream-index":"003"},"user_id":{"description":"User ID","title":"User ID","type":"string","x-stream-index":"002"}},"required":["message_id","user_id","user","type","score","created_at","updated_at","custom"],"type":"object"},"ReactionUpdatedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"006.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"002"},"team":{"type":"string","x-stream-index":"005.001"},"type":{"default":"reaction.updated","type":"string","x-stream-index":"006.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["message","reaction","cid","channel_id","channel_type","type","created_at"],"title":"ReactionUpdatedEvent","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"},"ReactivateUserRequest":{"nullable":true,"properties":{"created_by_id":{"description":"ID of the user who's reactivating the user","title":"Created by ID","type":"string","x-stream-index":"004"},"name":{"description":"Set this field to put new name for the user","title":"Name","type":"string","x-stream-index":"003"},"restore_messages":{"description":"Restore previously deleted messages","title":"Restore messages","type":"boolean","x-stream-index":"002"}},"type":"object"},"ReactivateUserResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.002.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Deactivated user object","title":"User","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"ReactivateUsersRequest":{"description":"Reactivate users in batches","nullable":true,"properties":{"created_by_id":{"description":"ID of the user who's reactivating the users","title":"Created by ID","type":"string","x-stream-index":"003"},"restore_channels":{"type":"boolean","x-stream-index":"004"},"restore_messages":{"description":"Restore previously deleted messages","title":"Restore messages","type":"boolean","x-stream-index":"002"},"user_ids":{"description":"User IDs to reactivate","items":{"type":"string"},"maximum":100,"minimum":1,"title":"User IDs","type":"array","x-stream-index":"001"}},"required":["user_ids"],"title":"ReactivateUsersRequest","type":"object"},"ReactivateUsersResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.002.001"},"task_id":{"type":"string","x-stream-index":"001.001"}},"required":["task_id","duration"],"title":"Response","type":"object"},"ReadReceipts":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"ReadReceiptsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"ReadStateResponse":{"properties":{"last_read":{"format":"date-time","type":"string","x-stream-index":"002"},"last_read_message_id":{"type":"string","x-stream-index":"004"},"unread_messages":{"format":"int32","type":"integer","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"}},"required":["user","last_read","unread_messages"],"type":"object"},"RecordSettings":{"properties":{"audio_only":{"type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"004"},"mode":{"type":"string","x-stream-index":"002"},"quality":{"type":"string","x-stream-index":"003"}},"required":["mode"],"type":"object"},"ReminderCreatedEvent":{"description":"Emitted when a reminder is created.","nullable":true,"properties":{"cid":{"description":"The CID of the Channel for which the reminder was created","title":"Channel CID","type":"string","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.007"},"message_id":{"description":"The ID of the message for which the reminder was created","title":"Message ID","type":"string","x-stream-index":"001.002"},"parent_id":{"description":"The ID of the parent message, if the reminder is for a thread message","title":"Parent ID","type":"string","x-stream-index":"001.005"},"received_at":{"format":"date-time","type":"string","x-stream-index":"001.001.004"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","description":"The reminder object which was created","title":"MessageReminder","x-stream-index":"001.006"},"type":{"default":"reminder.created","description":"The type of event: \"reminder.created\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.002"},"user_id":{"description":"The ID of the user for whom the reminder was created","title":"User ID","type":"string","x-stream-index":"001.003"}},"required":["type","created_at","custom","message_id","user_id","cid"],"title":"ReminderCreatedEvent","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"},"ReminderDeletedEvent":{"description":"Emitted when a reminder is deleted.","nullable":true,"properties":{"cid":{"description":"The CID of the Channel for which the reminder was created","title":"Channel CID","type":"string","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.007"},"message_id":{"description":"The ID of the message for which the reminder was created","title":"Message ID","type":"string","x-stream-index":"001.002"},"parent_id":{"description":"The ID of the parent message, if the reminder is for a thread message","title":"Parent ID","type":"string","x-stream-index":"001.005"},"received_at":{"format":"date-time","type":"string","x-stream-index":"001.001.004"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","description":"The reminder object which was created","title":"MessageReminder","x-stream-index":"001.006"},"type":{"default":"reminder.deleted","description":"The type of event: \"reminder.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.002"},"user_id":{"description":"The ID of the user for whom the reminder was created","title":"User ID","type":"string","x-stream-index":"001.003"}},"required":["type","created_at","custom","message_id","user_id","cid"],"title":"ReminderDeletedEvent","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"},"ReminderNotificationEvent":{"description":"Emitted when a reminder becomes due, triggering a notification for the user.","nullable":true,"properties":{"cid":{"description":"The CID of the Channel for which the reminder was created","title":"Channel CID","type":"string","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.007"},"message_id":{"description":"The ID of the message for which the reminder was created","title":"Message ID","type":"string","x-stream-index":"001.002"},"parent_id":{"type":"string","x-stream-index":"001.005"},"received_at":{"format":"date-time","type":"string","x-stream-index":"001.001.004"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","description":"The reminder object which was created","title":"MessageReminder","x-stream-index":"001.006"},"type":{"default":"notification.reminder_due","description":"The type of event: \"notification.reminder_due\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.002"},"user_id":{"description":"The ID of the user for whom the reminder was created","title":"User ID","type":"string","x-stream-index":"001.003"}},"required":["type","created_at","custom","message_id","user_id","cid"],"title":"ReminderNotificationEvent","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"},"ReminderResponseData":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003"},"channel_cid":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"string","x-stream-index":"008"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"005"},"message_id":{"type":"string","x-stream-index":"004"},"remind_at":{"format":"date-time","type":"string","x-stream-index":"001"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007"},"user_id":{"type":"string","x-stream-index":"006"}},"required":["channel_cid","message_id","user_id","created_at","updated_at"],"type":"object"},"ReminderUpdatedEvent":{"description":"Emitted when a reminder is updated.","nullable":true,"properties":{"cid":{"description":"The CID of the Channel for which the reminder was created","title":"Channel CID","type":"string","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.007"},"message_id":{"description":"The ID of the message for which the reminder was created","title":"Message ID","type":"string","x-stream-index":"001.002"},"parent_id":{"description":"The ID of the parent message, if the reminder is for a thread message","title":"Parent ID","type":"string","x-stream-index":"001.005"},"received_at":{"format":"date-time","type":"string","x-stream-index":"001.001.004"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","description":"The reminder object which was created","title":"MessageReminder","x-stream-index":"001.006"},"type":{"default":"reminder.updated","description":"The type of event: \"reminder.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.002"},"user_id":{"description":"The ID of the user for whom the reminder was created","title":"User ID","type":"string","x-stream-index":"001.003"}},"required":["type","created_at","custom","message_id","user_id","cid"],"title":"ReminderUpdatedEvent","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"},"Response":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001"}},"required":["duration"],"title":"Response","type":"object"},"RestoreUsersRequest":{"nullable":true,"properties":{"user_ids":{"items":{"type":"string"},"maximum":100,"minimum":1,"type":"array","x-stream-index":"001"}},"required":["user_ids"],"type":"object"},"RingSettings":{"properties":{"auto_cancel_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_timeout_ms","missed_call_timeout_ms"],"type":"object"},"Role":{"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"004"},"custom":{"description":"Whether this is a custom role or built-in","title":"Custom","type":"boolean","x-stream-index":"002"},"name":{"description":"Unique role name","title":"Name","type":"string","x-stream-index":"001"},"scopes":{"description":"List of scopes where this role is currently present. `.app` means that role is present in app-level grants","items":{"type":"string"},"title":"Scopes","type":"array","x-stream-index":"003"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"005"}},"required":["name","custom","scopes","created_at","updated_at"],"type":"object"},"S3Request":{"description":"Config for creating Amazon S3 storage.","properties":{"s3_api_key":{"description":"The AWS API key. To use Amazon S3 as your storage provider, you have two authentication options: IAM role or API key. If you do not specify the `s3_api_key` parameter, Stream will use IAM role authentication. In that case make sure to have the correct IAM role configured for your application.","title":"S3ApiKey","type":"string","x-stream-index":"002"},"s3_custom_endpoint_url":{"description":"The custom endpoint for S3. If you want to use a custom endpoint, you must also provide the `s3_api_key` and `s3_secret` parameters.","title":"S3CustomEndpointURL","type":"string","x-stream-index":"004"},"s3_region":{"description":"The AWS region where the bucket is hosted","title":"S3Region","type":"string","x-stream-index":"001"},"s3_secret":{"description":"The AWS API Secret","title":"S3Secret","type":"string","x-stream-index":"003"}},"required":["s3_region"],"title":"S3Request","type":"object"},"ScreensharingSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled"],"type":"object"},"SearchPayload":{"properties":{"filter_conditions":{"additionalProperties":{},"description":"Channel filter conditions","maximum":100,"minimum":1,"title":"Channel filter","type":"object","x-stream-docs-page-id":"query_channels","x-stream-index":"002"},"limit":{"description":"Number of messages to return","format":"int32","title":"Limit","type":"integer","x-stream-index":"005"},"message_filter_conditions":{"additionalProperties":{},"description":"Message filter conditions","title":"Message filter","type":"object","x-stream-index":"003"},"message_options":{"$ref":"#/components/schemas/MessageOptions","x-stream-index":"004"},"next":{"description":"Pagination parameter. Cannot be used with non-zero offset.","title":"Next","type":"string","x-stream-index":"008"},"offset":{"description":"Pagination offset. Cannot be used with sort or next.","format":"int32","title":"Offset","type":"integer","x-stream-index":"006"},"query":{"description":"Search phrase","title":"Query","type":"string","x-stream-index":"001"},"sort":{"description":"Sort parameters. Cannot be used with non-zero offset","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"007"}},"required":["filter_conditions"],"type":"object"},"SearchResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"005.001"},"next":{"description":"Value to pass to the next search query in order to paginate","title":"Next","type":"string","x-stream-index":"003"},"previous":{"description":"Value that points to the previous page. Pass as the next value in a search query to paginate backwards","title":"Previous","type":"string","x-stream-index":"004"},"results":{"description":"Search results","items":{"$ref":"#/components/schemas/SearchResult"},"title":"Results","type":"array","x-stream-index":"001"},"results_warning":{"$ref":"#/components/schemas/SearchWarning","description":"Warning about the search results","title":"Results Warning","x-stream-index":"002"}},"required":["results","duration"],"type":"object"},"SearchResult":{"properties":{"message":{"$ref":"#/components/schemas/SearchResultMessage","description":"Found message","title":"Message","x-stream-index":"001"}},"type":"object"},"SearchResultMessage":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"001.008"},"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel object","title":"Channel","x-stream-index":"002"},"cid":{"type":"string","x-stream-index":"001.022"},"command":{"type":"string","x-stream-index":"001.004"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.023"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.026"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"001.025"},"deleted_for_me":{"type":"boolean","x-stream-index":"001.044"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"001.018"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001.041"},"html":{"type":"string","x-stream-index":"001.005"},"i18n":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.030"},"id":{"type":"string","x-stream-index":"001.001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"001.028"},"latest_reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"001.009"},"mentioned_users":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"001.029"},"message_text_updated_at":{"format":"date-time","type":"string","x-stream-index":"001.036"},"mml":{"type":"string","x-stream-index":"001.003"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"001.039"},"own_reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"001.010"},"parent_id":{"type":"string","x-stream-index":"001.015"},"pin_expires":{"format":"date-time","type":"string","x-stream-index":"001.035"},"pinned":{"type":"boolean","x-stream-index":"001.032"},"pinned_at":{"format":"date-time","type":"string","x-stream-index":"001.033"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001.034"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001.038"},"poll_id":{"type":"string","x-stream-index":"001.037"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001.020"},"quoted_message_id":{"type":"string","x-stream-index":"001.019"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001.011"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"001.014"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001.012"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"001.042"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"001.017"},"restricted_visibility":{"items":{"type":"string"},"type":"array","x-stream-index":"001.040"},"shadowed":{"type":"boolean","x-stream-index":"001.027"},"shared_location":{"$ref":"#/components/schemas/SharedLocationResponseData","x-stream-index":"001.043"},"show_in_channel":{"type":"boolean","x-stream-index":"001.016"},"silent":{"type":"boolean","x-stream-index":"001.031"},"text":{"type":"string","x-stream-index":"001.002"},"thread_participants":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"001.021"},"type":{"type":"string","x-stream-index":"001.006"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"001.024"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001.007"}},"required":["id","text","html","type","user","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned","restricted_visibility"],"type":"object"},"SearchWarning":{"properties":{"channel_search_cids":{"description":"Channel CIDs for the searched channels","items":{"type":"string"},"title":"Channel Search CIDs","type":"array","x-stream-index":"004"},"channel_search_count":{"description":"Number of channels searched","format":"int32","title":"Channel Search Count","type":"integer","x-stream-index":"003"},"warning_code":{"description":"Code corresponding to the warning","format":"int32","title":"Warning Code","type":"integer","x-stream-index":"002"},"warning_description":{"description":"Description of the warning","title":"Warning Description","type":"string","x-stream-index":"001"}},"required":["warning_description","warning_code"],"type":"object"},"Segment":{"nullable":true,"properties":{"all_sender_channels":{"type":"boolean","x-stream-index":"007"},"all_users":{"type":"boolean","x-stream-index":"006"},"created_at":{"format":"date-time","type":"string","x-stream-index":"010"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"012"},"description":{"type":"string","x-stream-index":"004"},"filter":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"name":{"type":"string","x-stream-index":"003"},"size":{"format":"int32","type":"integer","x-stream-index":"009"},"task_id":{"type":"string","x-stream-index":"008"},"type":{"type":"string","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"011"}},"required":["id","type","name","all_users","all_sender_channels","size","created_at","updated_at"],"type":"object"},"SegmentResponse":{"properties":{"all_sender_channels":{"type":"boolean","x-stream-index":"007"},"all_users":{"type":"boolean","x-stream-index":"006"},"created_at":{"format":"date-time","type":"string","x-stream-index":"009"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"011"},"description":{"type":"string","x-stream-index":"004"},"filter":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"name":{"type":"string","x-stream-index":"003"},"size":{"format":"int32","type":"integer","x-stream-index":"008"},"type":{"type":"string","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"010"}},"required":["id","type","name","description","filter","all_users","all_sender_channels","size","created_at","updated_at","deleted_at"],"type":"object"},"SegmentTargetResponse":{"nullable":true,"properties":{"app_pk":{"format":"int32","type":"integer","x-stream-index":"001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"004"},"segment_id":{"type":"string","x-stream-index":"002"},"target_id":{"type":"string","x-stream-index":"003"}},"required":["app_pk","segment_id","target_id","created_at"],"type":"object"},"SendEventRequest":{"nullable":true,"properties":{"event":{"$ref":"#/components/schemas/EventRequest","x-stream-index":"001"}},"required":["event"],"type":"object"},"SendMessageRequest":{"nullable":true,"properties":{"force_moderation":{"type":"boolean","x-stream-index":"007"},"keep_channel_hidden":{"type":"boolean","x-stream-index":"008"},"message":{"$ref":"#/components/schemas/MessageRequest","x-stream-index":"001"},"pending":{"type":"boolean","x-stream-index":"006"},"pending_message_metadata":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"005"},"skip_enrich_url":{"type":"boolean","x-stream-index":"003"},"skip_push":{"type":"boolean","x-stream-index":"002"}},"required":["message"],"type":"object"},"SendMessageResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Message response","title":"Message","x-stream-index":"001"},"pending_message_metadata":{"additionalProperties":{"type":"string"},"description":"Pending message metadata","title":"Pending message metadata","type":"object","x-stream-index":"002"}},"required":["message","duration"],"type":"object"},"SendReactionRequest":{"nullable":true,"properties":{"enforce_unique":{"description":"Whether to replace all existing user reactions","title":"Enforce unique","type":"boolean","x-stream-index":"003"},"reaction":{"$ref":"#/components/schemas/ReactionRequest","x-stream-index":"002"},"skip_push":{"description":"Skips any mobile push notifications","title":"Skip push","type":"boolean","x-stream-index":"004"}},"required":["reaction"],"type":"object"},"SendReactionResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001"},"reaction":{"$ref":"#/components/schemas/ReactionResponse","x-stream-index":"002"}},"required":["message","reaction","duration"],"title":"Response","type":"object"},"SendUserCustomEventRequest":{"nullable":true,"properties":{"event":{"$ref":"#/components/schemas/UserCustomEventRequest","x-stream-index":"001"}},"required":["event"],"type":"object"},"SessionSettings":{"properties":{"inactivity_timeout_seconds":{"format":"int32","maximum":900,"minimum":5,"type":"integer","x-stream-index":"001"}},"required":["inactivity_timeout_seconds"],"type":"object"},"SharedLocation":{"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"013"},"channel_cid":{"type":"string","x-stream-index":"003"},"created_at":{"format":"date-time","type":"string","x-stream-index":"010"},"created_by_device_id":{"type":"string","x-stream-index":"008"},"end_at":{"format":"date-time","type":"string","x-stream-index":"009"},"latitude":{"format":"float","maximum":90,"minimum":18446744073709552000,"type":"number","x-stream-index":"006"},"longitude":{"format":"float","maximum":180,"minimum":18446744073709552000,"type":"number","x-stream-index":"007"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"012"},"message_id":{"type":"string","x-stream-index":"004"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"011"},"user_id":{"type":"string","x-stream-index":"005"}},"required":["channel_cid","message_id","user_id","created_by_device_id","created_at","updated_at"],"type":"object"},"SharedLocationResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001.011"},"channel_cid":{"description":"Channel CID","title":"string","type":"string","x-stream-index":"001.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.008"},"created_by_device_id":{"description":"Device ID that created the live location","title":"string","type":"string","x-stream-index":"001.006"},"duration":{"type":"string","x-stream-index":"002.001"},"end_at":{"description":"Time when the live location expires","format":"date-time","title":"string","type":"string","x-stream-index":"001.007"},"latitude":{"description":"Latitude coordinate","format":"float","title":"number","type":"number","x-stream-index":"001.004"},"longitude":{"description":"Longitude coordinate","format":"float","title":"number","type":"number","x-stream-index":"001.005"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001.010"},"message_id":{"description":"Message ID","title":"string","type":"string","x-stream-index":"001.002"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"001.009"},"user_id":{"description":"User ID","title":"string","type":"string","x-stream-index":"001.003"}},"required":["channel_cid","message_id","user_id","latitude","longitude","created_by_device_id","created_at","updated_at","duration"],"type":"object"},"SharedLocationResponseData":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"011"},"channel_cid":{"type":"string","x-stream-index":"001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"008"},"created_by_device_id":{"type":"string","x-stream-index":"006"},"end_at":{"format":"date-time","type":"string","x-stream-index":"007"},"latitude":{"format":"float","type":"number","x-stream-index":"004"},"longitude":{"format":"float","type":"number","x-stream-index":"005"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"010"},"message_id":{"type":"string","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"009"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["channel_cid","message_id","user_id","latitude","longitude","created_by_device_id","created_at","updated_at"],"type":"object"},"SharedLocationsResponse":{"nullable":true,"properties":{"active_live_locations":{"items":{"$ref":"#/components/schemas/SharedLocationResponseData"},"type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["active_live_locations","duration"],"type":"object"},"ShowChannelRequest":{"nullable":true,"properties":{"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"002.002"},"user_id":{"type":"string","x-stream-index":"002.001"}},"type":"object"},"ShowChannelResponse":{"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"},"SortParamRequest":{"nullable":true,"properties":{"direction":{"description":"Direction of sorting, 1 for Ascending, -1 for Descending, default is 1","format":"int32","title":"Direction","type":"integer","x-stream-index":"002"},"field":{"description":"Name of field to sort by","title":"Field","type":"string","x-stream-index":"001"}},"type":"object"},"StartCampaignRequest":{"nullable":true,"properties":{"scheduled_for":{"format":"date-time","type":"string","x-stream-index":"002"},"stop_at":{"format":"date-time","type":"string","x-stream-index":"003"}},"type":"object"},"StartCampaignResponse":{"description":"Basic response information","nullable":true,"properties":{"campaign":{"$ref":"#/components/schemas/CampaignResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"users":{"$ref":"#/components/schemas/PagerResponse","x-stream-index":"002"}},"required":["duration"],"title":"Response","type":"object"},"StopCampaignRequest":{"nullable":true,"type":"object"},"TargetResolution":{"properties":{"bitrate":{"format":"int32","maximum":6000000,"type":"integer","x-stream-index":"003"},"height":{"format":"int32","maximum":3840,"minimum":240,"type":"integer","x-stream-index":"002"},"width":{"format":"int32","maximum":3840,"minimum":240,"type":"integer","x-stream-index":"001"}},"required":["width","height","bitrate"],"type":"object"},"ThreadParticipant":{"description":"Represents a user that is participating in a thread.","nullable":true,"properties":{"app_pk":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"001"},"channel_cid":{"type":"string","x-stream-index":"002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"007"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"last_read_at":{"format":"date-time","type":"string","x-stream-index":"009"},"last_thread_message_at":{"format":"date-time","type":"string","x-stream-index":"003"},"left_thread_at":{"description":"Left Thread At is the time when the user left the thread","format":"date-time","title":"Left Thread At","type":"string","x-stream-index":"008"},"thread_id":{"description":"Thead ID is unique string identifier of the thread","title":"ID","type":"string","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User is the user object","title":"User","x-stream-index":"006"},"user_id":{"description":"User ID is unique string identifier of the user","title":"User ID","type":"string","x-stream-index":"005"}},"required":["app_pk","channel_cid","created_at","last_read_at","custom"],"title":"ThreadParticipant","type":"object"},"ThreadResponse":{"properties":{"active_participant_count":{"description":"Active Participant Count","format":"int32","title":"Active Participant Count","type":"integer","x-stream-index":"009"},"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel","title":"ChannelResponse","x-stream-index":"002"},"channel_cid":{"description":"Channel CID","title":"Channel CID","type":"string","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"012"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"Created By User","title":"User","x-stream-index":"006"},"created_by_user_id":{"description":"Created By User ID","title":"Created By User ID","type":"string","x-stream-index":"005"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"016"},"deleted_at":{"description":"Deleted At","format":"date-time","title":"Deleted At","type":"string","x-stream-index":"014"},"last_message_at":{"description":"Last Message At","format":"date-time","title":"Last Message At","type":"string","x-stream-index":"011"},"parent_message":{"$ref":"#/components/schemas/MessageResponse","description":"Parent Message","title":"Message","x-stream-index":"004"},"parent_message_id":{"description":"Parent Message ID","title":"Parent Message ID","type":"string","x-stream-index":"003"},"participant_count":{"description":"Participant Count","format":"int32","title":"Participant Count","type":"integer","x-stream-index":"008"},"reply_count":{"description":"Reply Count","format":"int32","title":"Reply Count","type":"integer","x-stream-index":"007"},"thread_participants":{"description":"Thread Participants","items":{"$ref":"#/components/schemas/ThreadParticipant"},"title":"ThreadParticipants","type":"array","x-stream-index":"010"},"title":{"description":"Title","title":"Title","type":"string","x-stream-index":"015"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"013"}},"required":["channel_cid","parent_message_id","created_by_user_id","created_at","updated_at","title","custom"],"type":"object"},"ThreadStateResponse":{"nullable":true,"properties":{"active_participant_count":{"description":"Active Participant Count","format":"int32","title":"Active Participant Count","type":"integer","x-stream-index":"001.009"},"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel","title":"ChannelResponse","x-stream-index":"001.002"},"channel_cid":{"description":"Channel CID","title":"Channel CID","type":"string","x-stream-index":"001.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.012"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"Created By User","title":"User","x-stream-index":"001.006"},"created_by_user_id":{"description":"Created By User ID","title":"Created By User ID","type":"string","x-stream-index":"001.005"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"001.016"},"deleted_at":{"description":"Deleted At","format":"date-time","title":"Deleted At","type":"string","x-stream-index":"001.014"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"004"},"last_message_at":{"description":"Last Message At","format":"date-time","title":"Last Message At","type":"string","x-stream-index":"001.011"},"latest_replies":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","x-stream-index":"002"},"parent_message":{"$ref":"#/components/schemas/MessageResponse","description":"Parent Message","title":"Message","x-stream-index":"001.004"},"parent_message_id":{"description":"Parent Message ID","title":"Parent Message ID","type":"string","x-stream-index":"001.003"},"participant_count":{"description":"Participant Count","format":"int32","title":"Participant Count","type":"integer","x-stream-index":"001.008"},"read":{"items":{"$ref":"#/components/schemas/ReadStateResponse"},"type":"array","x-stream-index":"003"},"reply_count":{"description":"Reply Count","format":"int32","title":"Reply Count","type":"integer","x-stream-index":"001.007"},"thread_participants":{"description":"Thread Participants","items":{"$ref":"#/components/schemas/ThreadParticipant"},"title":"ThreadParticipants","type":"array","x-stream-index":"001.010"},"title":{"description":"Title","title":"Title","type":"string","x-stream-index":"001.015"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"001.013"}},"required":["channel_cid","parent_message_id","created_by_user_id","created_at","updated_at","title","custom","latest_replies"],"type":"object"},"ThreadUpdatedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"001.002"},"channel_type":{"type":"string","x-stream-index":"001.003"},"cid":{"type":"string","x-stream-index":"001.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"004.002"},"thread":{"$ref":"#/components/schemas/ThreadResponse","x-stream-index":"003.001"},"type":{"default":"thread.updated","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"ThreadUpdatedEvent","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"},"Thresholds":{"description":"Sets thresholds for AI moderation","properties":{"explicit":{"$ref":"#/components/schemas/LabelThresholds","description":"Thresholds for explicit messages","title":"LabelThresholds","x-stream-index":"001"},"spam":{"$ref":"#/components/schemas/LabelThresholds","description":"Thresholds for spam","title":"LabelThresholds","x-stream-index":"002"},"toxic":{"$ref":"#/components/schemas/LabelThresholds","description":"Thresholds for toxic messages","title":"LabelThresholds","x-stream-index":"003"}},"title":"Auto moderation thresholds","type":"object"},"ThumbnailsSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"TranscriptionSettings":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"title":"Mode","type":"string","x-stream-index":"002"},"language":{"description":"The language used in this call as a two letter code","enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"title":"Language","type":"string","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"title":"Mode","type":"string","x-stream-index":"001"}},"required":["mode","closed_caption_mode","languages","language"],"type":"object"},"TranslateMessageRequest":{"nullable":true,"properties":{"language":{"description":"Language to translate message to","enum":["af","sq","am","ar","az","bn","bs","bg","zh","zh-TW","hr","cs","da","fa-AF","nl","en","et","fi","fr","fr-CA","ka","de","el","ha","he","hi","hu","id","it","ja","ko","lv","ms","no","fa","ps","pl","pt","ro","ru","sr","sk","sl","so","es","es-MX","sw","sv","tl","ta","th","tr","uk","ur","vi","lt","ht"],"title":"Language","type":"string","x-stream-index":"001"}},"required":["language"],"type":"object"},"TruncateChannelRequest":{"nullable":true,"properties":{"hard_delete":{"description":"Permanently delete channel data (messages, reactions, etc.)","title":"Hard delete","type":"boolean","x-stream-index":"002"},"member_ids":{"description":"List of member IDs to hide message history for. If empty, truncates the channel for all members","items":{"type":"string"},"maximum":100,"title":"Member IDs","type":"array","x-stream-index":"007"},"message":{"$ref":"#/components/schemas/MessageRequest","x-stream-index":"004"},"skip_push":{"description":"When `message` is set disables all push notifications for it","title":"Skip push","type":"boolean","x-stream-index":"005"},"truncated_at":{"description":"Truncate channel data up to `truncated_at`. The system message (if provided) creation time is always greater than `truncated_at`","format":"date-time","title":"Truncated at","type":"string","x-stream-index":"006"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"008.002"},"user_id":{"type":"string","x-stream-index":"008.001"}},"type":"object"},"TruncateChannelResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Truncated channel object","title":"Channel","x-stream-index":"002"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Truncated message object","title":"Message","x-stream-index":"003"}},"required":["duration"],"type":"object"},"TypingIndicators":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"TypingIndicatorsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"UnblockUsersRequest":{"nullable":true,"properties":{"blocked_user_id":{"type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"required":["blocked_user_id"],"type":"object"},"UnblockUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"UnmuteChannelRequest":{"nullable":true,"properties":{"channel_cids":{"description":"Channel CIDs to mute (if multiple channels)","items":{"type":"string"},"maximum":25,"title":"Channel CIDs","type":"array","x-stream-index":"001.002"},"expiration":{"description":"Duration of mute in milliseconds","title":"Expiration","type":"integer","x-stream-index":"001.003"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"002.002"},"user_id":{"type":"string","x-stream-index":"002.001"}},"type":"object"},"UnmuteResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"non_existing_users":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"required":["duration"],"title":"Response","type":"object"},"UnmuteUserRequest":{"nullable":true,"properties":{"target_ids":{"description":"User IDs to mute (if multiple users)","items":{"type":"string"},"maximum":1000,"title":"Target IDs","type":"array","x-stream-index":"001.002"},"timeout":{"description":"Duration of mute in minutes","minimum":0,"title":"Timeout","type":"integer","x-stream-index":"001.003"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"002.002"},"user_id":{"type":"string","x-stream-index":"002.001"}},"required":["timeout"],"type":"object"},"UnreadCountsBatchRequest":{"nullable":true,"properties":{"user_ids":{"items":{"type":"string"},"maximum":100,"type":"array","x-stream-index":"001"}},"required":["user_ids"],"type":"object"},"UnreadCountsBatchResponse":{"description":"Basic response information","nullable":true,"properties":{"counts_by_user":{"additionalProperties":{"$ref":"#/components/schemas/UnreadCountsResponse"},"type":"object","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["counts_by_user","duration"],"title":"Response","type":"object"},"UnreadCountsChannel":{"properties":{"channel_id":{"type":"string","x-stream-index":"001"},"last_read":{"format":"date-time","type":"string","x-stream-index":"003"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["channel_id","unread_count","last_read"],"type":"object"},"UnreadCountsChannelType":{"properties":{"channel_count":{"format":"int32","type":"integer","x-stream-index":"002"},"channel_type":{"type":"string","x-stream-index":"001"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["channel_type","channel_count","unread_count"],"type":"object"},"UnreadCountsResponse":{"nullable":true,"properties":{"channel_type":{"items":{"$ref":"#/components/schemas/UnreadCountsChannelType"},"type":"array","x-stream-index":"005"},"channels":{"items":{"$ref":"#/components/schemas/UnreadCountsChannel"},"type":"array","x-stream-index":"004"},"threads":{"items":{"$ref":"#/components/schemas/UnreadCountsThread"},"type":"array","x-stream-index":"006"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"001"},"total_unread_count_by_team":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"003"},"total_unread_threads_count":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["total_unread_count","total_unread_threads_count","channels","channel_type","threads"],"type":"object"},"UnreadCountsThread":{"properties":{"last_read":{"format":"date-time","type":"string","x-stream-index":"002"},"last_read_message_id":{"type":"string","x-stream-index":"003"},"parent_message_id":{"type":"string","x-stream-index":"004"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"001"}},"required":["unread_count","last_read","last_read_message_id","parent_message_id"],"type":"object"},"UpdateAppRequest":{"nullable":true,"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.017"},"apn_config":{"$ref":"#/components/schemas/APNConfig","x-stream-index":"001.003"},"async_moderation_config":{"$ref":"#/components/schemas/AsyncModerationConfiguration","x-stream-index":"001.039"},"async_url_enrich_enabled":{"type":"boolean","x-stream-index":"001.019"},"auto_translation_enabled":{"type":"boolean","x-stream-index":"001.018"},"before_message_send_hook_url":{"type":"string","x-stream-index":"001.020"},"cdn_expiration_seconds":{"format":"int32","maximum":1209600,"minimum":14400,"type":"integer","x-stream-index":"001.038"},"channel_hide_members_only":{"type":"boolean","x-stream-index":"001.033"},"custom_action_handler_url":{"type":"string","x-stream-index":"001.021"},"datadog_info":{"$ref":"#/components/schemas/DataDogInfo","x-stream-index":"001.040"},"disable_auth_checks":{"type":"boolean","x-stream-index":"001.001"},"disable_permissions_checks":{"type":"boolean","x-stream-index":"001.002"},"enforce_unique_usernames":{"enum":["no","app","team"],"type":"string","x-stream-index":"001.022"},"event_hooks":{"items":{"$ref":"#/components/schemas/EventHook"},"type":"array","x-stream-index":"001.046"},"feeds_moderation_enabled":{"type":"boolean","x-stream-index":"001.042"},"feeds_v2_region":{"type":"string","x-stream-index":"001.041"},"file_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","x-stream-index":"001.030"},"firebase_config":{"$ref":"#/components/schemas/FirebaseConfig","x-stream-index":"001.004"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"001.034"},"guest_user_creation_disabled":{"type":"boolean","x-stream-index":"001.043"},"huawei_config":{"$ref":"#/components/schemas/HuaweiConfig","x-stream-index":"001.005"},"image_moderation_block_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001.015"},"image_moderation_enabled":{"type":"boolean","x-stream-index":"001.016"},"image_moderation_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001.014"},"image_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","x-stream-index":"001.029"},"max_aggregated_activities_length":{"format":"int32","type":"integer","x-stream-index":"001.049"},"migrate_permissions_to_v2":{"type":"boolean","x-stream-index":"001.035"},"moderation_dashboard_preferences":{"$ref":"#/components/schemas/ModerationDashboardPreferences","x-stream-index":"001.044"},"moderation_enabled":{"type":"boolean","x-stream-index":"001.009"},"moderation_webhook_url":{"type":"string","x-stream-index":"001.010"},"multi_tenant_enabled":{"type":"boolean","x-stream-index":"001.013"},"permission_version":{"enum":["v1","v2"],"type":"string","x-stream-index":"001.011"},"push_config":{"$ref":"#/components/schemas/PushConfig","x-stream-index":"001.007"},"reminders_interval":{"format":"int32","maximum":86400,"minimum":60,"type":"integer","x-stream-index":"001.036"},"reminders_max_members":{"format":"int32","minimum":2,"type":"integer","x-stream-index":"001.037"},"revoke_tokens_issued_before":{"format":"date-time","type":"string","x-stream-index":"001.031"},"sns_key":{"type":"string","x-stream-index":"001.027"},"sns_secret":{"type":"string","x-stream-index":"001.028"},"sns_topic_arn":{"type":"string","x-stream-index":"001.026"},"sqs_key":{"type":"string","x-stream-index":"001.024"},"sqs_secret":{"type":"string","x-stream-index":"001.025"},"sqs_url":{"type":"string","x-stream-index":"001.023"},"user_response_time_enabled":{"type":"boolean","x-stream-index":"001.048"},"user_search_disallowed_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"001.012"},"webhook_events":{"items":{"type":"string"},"type":"array","x-stream-index":"001.032"},"webhook_url":{"type":"string","x-stream-index":"001.008"},"xiaomi_config":{"$ref":"#/components/schemas/XiaomiConfig","x-stream-index":"001.006"}},"type":"object"},"UpdateBlockListRequest":{"nullable":true,"properties":{"team":{"type":"string","x-stream-index":"002"},"words":{"description":"List of words to block","items":{"type":"string"},"minimum":1,"title":"Words","type":"array","x-stream-index":"003"}},"title":"Update block list","type":"object","x-stream-docs-page-id":"update_block_list"},"UpdateBlockListResponse":{"description":"Basic response information","nullable":true,"properties":{"blocklist":{"$ref":"#/components/schemas/BlockListResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["duration"],"title":"Response","type":"object"},"UpdateChannelPartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"type":"object","x-stream-index":"002.001"},"unset":{"items":{"type":"string"},"type":"array","x-stream-index":"002.002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"title":"UpdateChannelPartialRequest","type":"object"},"UpdateChannelPartialResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Updated channel object","title":"Channel","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"members":{"description":"List of updated members","items":{"$ref":"#/components/schemas/ChannelMemberResponse"},"title":"ChannelMemberResponse","type":"array","x-stream-index":"002"}},"required":["members","duration"],"type":"object"},"UpdateChannelRequest":{"nullable":true,"properties":{"accept_invite":{"description":"Set to `true` to accept the invite","title":"Accept invite","type":"boolean","x-stream-index":"008"},"add_members":{"description":"List of user IDs to add to the channel","items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"title":"Add members","type":"array","x-stream-index":"001"},"add_moderators":{"description":"List of user IDs to make channel moderators","items":{"type":"string"},"maximum":100,"title":"Add moderators","type":"array","x-stream-index":"003"},"assign_roles":{"description":"List of channel member role assignments. If any specified user is not part of the channel, the request will fail","items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"title":"Assign roles","type":"array","x-stream-index":"006"},"cooldown":{"description":"Sets cool down period for the channel in seconds","format":"int32","maximum":120,"minimum":0,"title":"Cool down","type":"integer","x-stream-index":"007"},"data":{"$ref":"#/components/schemas/ChannelInput","x-stream-index":"013.001"},"demote_moderators":{"description":"List of user IDs to take away moderators status from","items":{"type":"string"},"maximum":100,"title":"Demote moderators","type":"array","x-stream-index":"004"},"hide_history":{"description":"Set to `true` to hide channel's history when adding new members","title":"Hide history","type":"boolean","x-stream-index":"012"},"invites":{"description":"List of user IDs to invite to the channel","items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"title":"Invites","type":"array","x-stream-index":"005"},"message":{"$ref":"#/components/schemas/MessageRequest","description":"Message to send to the chat when channel is successfully updated","title":"Message","x-stream-index":"010"},"reject_invite":{"description":"Set to `true` to reject the invite","title":"Reject invite","type":"boolean","x-stream-index":"009"},"remove_members":{"description":"List of user IDs to remove from the channel","items":{"type":"string"},"maximum":100,"title":"Remove members","type":"array","x-stream-index":"002"},"skip_push":{"description":"When `message` is set disables all push notifications for it","title":"Skip push","type":"boolean","x-stream-index":"011"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"014.002"},"user_id":{"type":"string","x-stream-index":"014.001"}},"title":"Channel update request","type":"object","x-stream-docs-page-id":"channel_update"},"UpdateChannelResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Updated channel","title":"Channel","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"004.001"},"members":{"description":"List of channel members","items":{"$ref":"#/components/schemas/ChannelMember"},"title":"Members","type":"array","x-stream-index":"003"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Message sent to the chat","title":"Message","x-stream-index":"002"}},"required":["members","duration"],"type":"object"},"UpdateChannelTypeRequest":{"nullable":true,"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"009.001.027"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"009.001.022"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"009.001.023"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"009.001.028"},"blocklist":{"type":"string","x-stream-index":"009.001.024"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"009.001.025"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"009.001.026"},"commands":{"description":"List of commands that channel supports","items":{"type":"string"},"title":"Commands","type":"array","x-stream-index":"009.003"},"connect_events":{"type":"boolean","x-stream-index":"009.001.004"},"count_messages":{"type":"boolean","x-stream-index":"009.001.019"},"custom_events":{"type":"boolean","x-stream-index":"009.001.012"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"004"},"mark_messages_pending":{"type":"boolean","x-stream-index":"009.001.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"009.001.021"},"mutes":{"type":"boolean","x-stream-index":"009.001.009"},"partition_size":{"format":"int32","minimum":0,"type":"integer","x-stream-index":"007"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"008"},"permissions":{"items":{"$ref":"#/components/schemas/PolicyRequest"},"type":"array","x-stream-index":"003"},"polls":{"type":"boolean","x-stream-index":"009.001.016"},"push_notifications":{"type":"boolean","x-stream-index":"009.001.013"},"quotes":{"type":"boolean","x-stream-index":"009.001.008"},"reactions":{"type":"boolean","x-stream-index":"009.001.006"},"read_events":{"type":"boolean","x-stream-index":"009.001.003"},"reminders":{"type":"boolean","x-stream-index":"009.001.014"},"replies":{"type":"boolean","x-stream-index":"009.001.007"},"search":{"type":"boolean","x-stream-index":"009.001.005"},"shared_locations":{"type":"boolean","x-stream-index":"009.001.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"009.001.031"},"typing_events":{"type":"boolean","x-stream-index":"009.001.002"},"uploads":{"type":"boolean","x-stream-index":"009.001.010"},"url_enrichment":{"type":"boolean","x-stream-index":"009.001.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"009.001.017"}},"required":["max_message_length","automod","automod_behavior"],"type":"object"},"UpdateChannelTypeResponse":{"nullable":true,"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"003.001.027"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"003.001.022"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.001.023"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"003.001.028"},"blocklist":{"type":"string","x-stream-index":"003.001.024"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.001.025"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"003.001.026"},"commands":{"items":{"type":"string"},"type":"array","x-stream-index":"003.003"},"connect_events":{"type":"boolean","x-stream-index":"003.001.004"},"count_messages":{"type":"boolean","x-stream-index":"003.001.019"},"created_at":{"format":"date-time","type":"string","x-stream-index":"003.002.003"},"custom_events":{"type":"boolean","x-stream-index":"003.001.012"},"duration":{"type":"string","x-stream-index":"004.001"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"002"},"mark_messages_pending":{"type":"boolean","x-stream-index":"003.001.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"003.001.021"},"mutes":{"type":"boolean","x-stream-index":"003.001.009"},"name":{"type":"string","x-stream-index":"003.001.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"003.001.029"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"003.001.030"},"permissions":{"items":{"$ref":"#/components/schemas/PolicyRequest"},"type":"array","x-stream-index":"001"},"polls":{"type":"boolean","x-stream-index":"003.001.016"},"push_notifications":{"type":"boolean","x-stream-index":"003.001.013"},"quotes":{"type":"boolean","x-stream-index":"003.001.008"},"reactions":{"type":"boolean","x-stream-index":"003.001.006"},"read_events":{"type":"boolean","x-stream-index":"003.001.003"},"reminders":{"type":"boolean","x-stream-index":"003.001.014"},"replies":{"type":"boolean","x-stream-index":"003.001.007"},"search":{"type":"boolean","x-stream-index":"003.001.005"},"shared_locations":{"type":"boolean","x-stream-index":"003.001.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"003.001.031"},"typing_events":{"type":"boolean","x-stream-index":"003.001.002"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"003.002.004"},"uploads":{"type":"boolean","x-stream-index":"003.001.010"},"url_enrichment":{"type":"boolean","x-stream-index":"003.001.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"003.001.017"}},"required":["permissions","grants","name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","count_messages","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","created_at","updated_at","commands","duration"],"type":"object"},"UpdateCommandRequest":{"nullable":true,"properties":{"args":{"description":"Arguments help text, shown in commands auto-completion","maxLength":255,"title":"Arguments","type":"string","x-stream-index":"003"},"description":{"description":"Description, shown in commands auto-completion","maxLength":255,"title":"Description","type":"string","x-stream-index":"002"},"set":{"description":"Set name used for grouping commands","maxLength":255,"title":"Set","type":"string","x-stream-index":"004"}},"required":["description"],"title":"UpdateCommandRequest","type":"object"},"UpdateCommandResponse":{"nullable":true,"properties":{"command":{"$ref":"#/components/schemas/Command","description":"Command object","title":"Command","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["duration"],"title":"UpdateCommandResponse","type":"object"},"UpdateExternalStorageRequest":{"description":"External storage","nullable":true,"properties":{"aws_s3":{"$ref":"#/components/schemas/S3Request","description":"Only required if you want to create an Amazon S3 storage","title":"AwsS3","x-stream-index":"003.004"},"azure_blob":{"$ref":"#/components/schemas/AzureRequest","description":"Only required if you want to create an Azure Blob Storage","title":"AzureBlob","x-stream-index":"003.006"},"bucket":{"description":"The name of the bucket on the service provider","title":"Bucket","type":"string","x-stream-index":"003.002"},"gcs_credentials":{"type":"string","x-stream-index":"003.005"},"path":{"description":"The path prefix to use for storing files","title":"Path","type":"string","x-stream-index":"003.003"},"storage_type":{"description":"The type of storage to use","enum":["s3","gcs","abs"],"title":"StorageType","type":"string","x-stream-index":"003.001"}},"required":["storage_type","bucket"],"title":"ExternalStorageRequest","type":"object"},"UpdateExternalStorageResponse":{"description":"Basic response information","nullable":true,"properties":{"bucket":{"type":"string","x-stream-index":"001.003"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"name":{"type":"string","x-stream-index":"001.001"},"path":{"type":"string","x-stream-index":"001.004"},"type":{"enum":["s3","gcs","abs"],"type":"string","x-stream-index":"001.002"}},"required":["name","type","bucket","path","duration"],"title":"Response","type":"object"},"UpdateLiveLocationRequest":{"nullable":true,"properties":{"end_at":{"description":"Time when the live location expires","format":"date-time","title":"string","type":"string","x-stream-index":"004"},"latitude":{"description":"Latitude coordinate","format":"float","maximum":90,"minimum":18446744073709552000,"title":"number","type":"number","x-stream-index":"002"},"longitude":{"description":"Longitude coordinate","format":"float","maximum":180,"minimum":18446744073709552000,"title":"number","type":"number","x-stream-index":"003"},"message_id":{"description":"Live location ID","title":"string","type":"string","x-stream-index":"001"}},"required":["message_id"],"type":"object"},"UpdateMemberPartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"type":"object","x-stream-index":"002.001"},"unset":{"items":{"type":"string"},"type":"array","x-stream-index":"002.002"}},"type":"object"},"UpdateMemberPartialResponse":{"nullable":true,"properties":{"channel_member":{"$ref":"#/components/schemas/ChannelMemberResponse","description":"Updated channel member","title":"Channel member","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["duration"],"type":"object"},"UpdateMessagePartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"description":"Sets new field values","title":"Set","type":"object","x-stream-index":"002.001","x-stream-map":{"key":"field","title":"Value","description":"New value to set"}},"skip_enrich_url":{"description":"Skip enriching the URL in the message","title":"SkipEnrichURL","type":"boolean","x-stream-index":"001"},"unset":{"description":"Array of field names to unset","items":{"type":"string"},"title":"Unset","type":"array","x-stream-index":"002.002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"type":"object"},"UpdateMessagePartialResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Updated message","title":"Message","x-stream-index":"001"},"pending_message_metadata":{"additionalProperties":{"type":"string"},"description":"Pending message metadata","title":"PendingMessageMetadata","type":"object","x-stream-index":"002"}},"required":["duration"],"type":"object"},"UpdateMessageRequest":{"nullable":true,"properties":{"message":{"$ref":"#/components/schemas/MessageRequest","description":"Message","title":"MessageRequest","x-stream-index":"001"},"skip_enrich_url":{"description":"Skip enrich URL","title":"boolean","type":"boolean","x-stream-index":"003"},"skip_push":{"type":"boolean","x-stream-index":"002"}},"required":["message"],"type":"object"},"UpdateMessageResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001"},"pending_message_metadata":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"002"}},"required":["message","duration"],"title":"Response","type":"object"},"UpdatePollOptionRequest":{"nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"004"},"id":{"description":"Option ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"},"text":{"description":"Option text","title":"string","type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"005.002"},"user_id":{"type":"string","x-stream-index":"005.001"}},"required":["id","text"],"type":"object"},"UpdatePollPartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"description":"Sets new field values","title":"Set","type":"object","x-stream-index":"002.001","x-stream-map":{"key":"field","title":"Value","description":"New value to set"}},"unset":{"description":"Array of field names to unset","items":{"type":"string"},"title":"Unset","type":"array","x-stream-index":"002.002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"type":"object"},"UpdatePollRequest":{"nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"011"},"allow_answers":{"description":"Allow answers","title":"boolean","type":"boolean","x-stream-index":"009"},"allow_user_suggested_options":{"description":"Allow user suggested options","title":"boolean","type":"boolean","x-stream-index":"008"},"description":{"description":"Poll description","title":"string","type":"string","x-stream-index":"003"},"enforce_unique_vote":{"description":"Enforce unique vote","title":"boolean","type":"boolean","x-stream-index":"005"},"id":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"},"is_closed":{"description":"Is closed","title":"boolean","type":"boolean","x-stream-index":"010"},"max_votes_allowed":{"description":"Max votes allowed","format":"int32","maximum":10,"title":"integer","type":"integer","x-stream-index":"007"},"name":{"description":"Poll name","title":"string","type":"string","x-stream-index":"002"},"options":{"description":"Poll options","items":{"$ref":"#/components/schemas/PollOptionRequest"},"maximum":100,"title":"PollOptions","type":"array","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"012.002"},"user_id":{"type":"string","x-stream-index":"012.001"},"voting_visibility":{"description":"Voting visibility","enum":["anonymous","public"],"title":"string","type":"string","x-stream-index":"006"}},"required":["id","name"],"type":"object"},"UpdateReminderRequest":{"nullable":true,"properties":{"remind_at":{"format":"date-time","type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"type":"object"},"UpdateReminderResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"001"}},"required":["reminder","duration"],"title":"Response","type":"object"},"UpdateThreadPartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"description":"Sets new field values","title":"Set","type":"object","x-stream-index":"004.001","x-stream-map":{"key":"field","title":"Value","description":"New value to set"}},"unset":{"description":"Array of field names to unset","items":{"type":"string"},"title":"Unset","type":"array","x-stream-index":"004.002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"type":"object"},"UpdateThreadPartialResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"thread":{"$ref":"#/components/schemas/ThreadResponse","description":"Updated thread (not enriched)","title":"Thread","x-stream-index":"001"}},"required":["thread","duration"],"type":"object"},"UpdateUserPartialRequest":{"properties":{"id":{"description":"User ID to update","title":"ID","type":"string","x-stream-index":"001"},"set":{"additionalProperties":{},"type":"object","x-stream-index":"002.001"},"unset":{"items":{"type":"string"},"type":"array","x-stream-index":"002.002"}},"required":["id"],"type":"object"},"UpdateUsersPartialRequest":{"nullable":true,"properties":{"users":{"items":{"$ref":"#/components/schemas/UpdateUserPartialRequest"},"maximum":100,"type":"array","x-stream-index":"001"}},"required":["users"],"type":"object"},"UpdateUsersRequest":{"nullable":true,"properties":{"users":{"additionalProperties":{"$ref":"#/components/schemas/UserRequest"},"description":"Object containing users","title":"Users","type":"object","x-stream-index":"001","x-stream-map":{"key":"user_id"}}},"required":["users"],"type":"object"},"UpdateUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"membership_deletion_task_id":{"type":"string","x-stream-index":"002"},"users":{"additionalProperties":{"$ref":"#/components/schemas/FullUserResponse"},"description":"Object containing users","title":"Users","type":"object","x-stream-index":"001","x-stream-map":{"key":"user_id"}}},"required":["users","membership_deletion_task_id","duration"],"type":"object"},"UpsertPushPreferencesRequest":{"nullable":true,"properties":{"preferences":{"description":"A list of push preferences for channels, calls, or the user.","items":{"$ref":"#/components/schemas/PushPreferenceInput"},"type":"array","x-stream-index":"001"}},"required":["preferences"],"type":"object"},"UpsertPushPreferencesResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"user_channel_preferences":{"additionalProperties":{"additionalProperties":{"$ref":"#/components/schemas/ChannelPushPreferences"},"type":"object"},"description":"The channel specific push notification preferences, only returned for channels you've edited.","title":"User Channel Notification Preferences","type":"object","x-stream-index":"002"},"user_preferences":{"additionalProperties":{"$ref":"#/components/schemas/PushPreferences"},"description":"The user preferences, always returned regardless if you edited it","title":"User Preferences","type":"object","x-stream-index":"001"}},"required":["user_preferences","user_channel_preferences","duration"],"type":"object"},"UpsertPushProviderRequest":{"nullable":true,"properties":{"push_provider":{"$ref":"#/components/schemas/PushProvider","x-stream-index":"001"}},"type":"object"},"UpsertPushProviderResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"push_provider":{"$ref":"#/components/schemas/PushProviderResponse","x-stream-index":"001"}},"required":["push_provider","duration"],"title":"Response","type":"object"},"UpsertPushTemplateRequest":{"nullable":true,"properties":{"enable_push":{"description":"Whether to send push notification for this event","title":"boolean","type":"boolean","x-stream-index":"002"},"event_type":{"description":"Event type (message.new, message.updated, reaction.new)","enum":["message.new","message.updated","reaction.new","notification.reminder_due","feeds.activity.added","feeds.comment.added","feeds.activity.reaction.added","feeds.comment.reaction.added","feeds.follow.created","feeds.notification_feed.updated"],"title":"string","type":"string","x-stream-index":"003"},"push_provider_name":{"description":"Push provider name","title":"string","type":"string","x-stream-index":"004"},"push_provider_type":{"description":"Push provider type (firebase, apn)","enum":["firebase","apn"],"title":"string","type":"string","x-stream-index":"005"},"template":{"description":"Push template","title":"string","type":"string","x-stream-index":"006"}},"required":["event_type","push_provider_type"],"type":"object"},"UpsertPushTemplateResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"template":{"$ref":"#/components/schemas/PushTemplate","x-stream-index":"002"}},"required":["duration"],"title":"Response","type":"object"},"User":{"properties":{"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"046"},"ban_expires":{"format":"date-time","type":"string","x-stream-index":"017"},"banned":{"type":"boolean","x-stream-index":"016"},"created_at":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"013"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"023"},"language":{"type":"string","x-stream-index":"035"},"last_active":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"026"},"revoke_tokens_issued_before":{"format":"date-time","type":"string","x-stream-index":"042"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"005"},"updated_at":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"009"}},"required":["id","role","teams_role","custom","banned","online"],"type":"object"},"UserBannedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"006.002"},"channel_type":{"type":"string","x-stream-index":"006.003"},"cid":{"type":"string","x-stream-index":"006.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"008.002"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"001"},"expiration":{"format":"date-time","type":"string","x-stream-index":"003"},"reason":{"type":"string","x-stream-index":"004"},"shadow":{"type":"boolean","x-stream-index":"002"},"team":{"type":"string","x-stream-index":"005.001"},"type":{"default":"user.banned","type":"string","x-stream-index":"008.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007.001"}},"required":["created_by","shadow","cid","channel_id","channel_type","type","created_at"],"title":"UserBannedEvent","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"},"UserCustomEventRequest":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"001"}},"required":["type"],"type":"object"},"UserDeactivatedEvent":{"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"003.002"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"001"},"type":{"default":"user.deactivated","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["created_by","type","created_at"],"title":"UserDeactivatedEvent","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"},"UserDeletedEvent":{"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"002.002"},"delete_conversation_channels":{"type":"boolean","x-stream-index":"005"},"hard_delete":{"type":"boolean","x-stream-index":"003.001"},"mark_messages_deleted":{"type":"boolean","x-stream-index":"004"},"type":{"default":"user.deleted","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"001.001"}},"required":["type","created_at","hard_delete","mark_messages_deleted","delete_conversation_channels"],"title":"UserDeletedEvent","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"},"UserFlaggedEvent":{"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"004.002"},"target_user":{"type":"string","x-stream-index":"002"},"target_users":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"type":{"default":"user.flagged","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"001"}},"required":["type","created_at"],"title":"UserFlaggedEvent","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"},"UserMessagesDeletedEvent":{"description":"This event is sent when a user's message get deleted. The event contains information about the user whose messages got deleted.","nullable":true,"properties":{"channel_custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.005"},"channel_id":{"description":"The ID of the channel where the target user's messages were deleted","title":"Channel ID","type":"string","x-stream-index":"001.002.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"001.001.004"},"channel_type":{"description":"The type of the channel where the target user's messages were deleted","title":"Channel Type","type":"string","x-stream-index":"001.002.001"},"cid":{"description":"The CID of the channel where the target user's messages were deleted","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"},"hard_delete":{"description":"Whether Messages were hard deleted","title":"Hard Delete","type":"boolean","x-stream-index":"003"},"received_at":{"format":"date-time","type":"string","x-stream-index":"001.001.001.001.004"},"team":{"description":"The team of the channel where the target user's messages were deleted","title":"Team","type":"string","x-stream-index":"001.001.003"},"type":{"default":"user.messages.deleted","description":"The type of event: \"user.messages.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.001.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The target user whose messages got deleted","title":"User","x-stream-index":"002.001"}},"required":["type","created_at","custom","user"],"title":"UserMessagesDeletedEvent","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"},"UserMute":{"nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"009"},"expires":{"description":"Date/time of mute expiration","format":"date-time","title":"Expires","type":"string","x-stream-index":"008"},"target":{"$ref":"#/components/schemas/User","description":"User who's muted","title":"Target","x-stream-index":"007"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/User","description":"Owner of channel mute","title":"User","x-stream-index":"005"}},"required":["created_at","updated_at"],"type":"object"},"UserMuteResponse":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"004"},"expires":{"format":"date-time","type":"string","x-stream-index":"003"},"target":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"}},"required":["created_at","updated_at"],"type":"object"},"UserMutedEvent":{"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"004.002"},"target_user":{"type":"string","x-stream-index":"001"},"target_users":{"items":{"type":"string"},"type":"array","x-stream-index":"002"},"type":{"default":"user.muted","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"UserMutedEvent","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"},"UserReactivatedEvent":{"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"002.002"},"type":{"default":"user.reactivated","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"001"}},"required":["type","created_at"],"title":"UserReactivatedEvent","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"},"UserRequest":{"description":"User request object","properties":{"custom":{"additionalProperties":{},"description":"Custom user data","title":"Custom","type":"object","x-stream-index":"004"},"id":{"description":"User ID","title":"ID","type":"string","x-stream-index":"001"},"image":{"description":"User's profile image URL","title":"Image","type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"006"},"language":{"type":"string","x-stream-index":"005"},"name":{"description":"Optional name of user","title":"Name","type":"string","x-stream-index":"002"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"007"},"role":{"description":"User's global role","title":"Role","type":"string","x-stream-index":"008"},"teams":{"description":"List of teams the user belongs to","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"010"},"teams_role":{"additionalProperties":{"type":"string"},"description":"Map of team-specific roles for the user","title":"TeamsRole","type":"object","x-stream-index":"009"}},"required":["id"],"title":"UserRequest","type":"object"},"UserResponse":{"description":"User response object","properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"ban_expires":{"description":"Date when ban expires","format":"date-time","title":"Ban expires","type":"string","x-stream-index":"003"},"banned":{"description":"Whether a user is banned or not","title":"Banned","type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.017"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"001.004"},"deactivated_at":{"description":"Date of deactivation","format":"date-time","title":"Deactivated at","type":"string","x-stream-index":"001.016"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"string","x-stream-index":"001.011"},"devices":{"description":"List of devices user is using","items":{"$ref":"#/components/schemas/DeviceResponse"},"title":"Devices","type":"array","x-stream-index":"006"},"id":{"description":"Unique user identifier","title":"ID","type":"string","x-stream-index":"001.001"},"image":{"title":"Image","type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"007"},"language":{"description":"Preferred language of a user","title":"Language","type":"string","x-stream-index":"001.005"},"last_active":{"description":"Date of last activity","format":"date-time","title":"Last active","type":"string","x-stream-index":"001.014"},"name":{"description":"Optional name of user","title":"Name","type":"string","x-stream-index":"001.002"},"online":{"description":"Whether a user online or not","title":"Online","type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","description":"User privacy settings","title":"Privacy settings","x-stream-index":"005"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettingsResponse","description":"User push notification settings","title":"Push notifications","x-stream-index":"004"},"revoke_tokens_issued_before":{"description":"Revocation date for tokens","format":"date-time","title":"Revoke tokens issued before","type":"string","x-stream-index":"001.015"},"role":{"description":"Determines the set of user permissions","title":"Role","type":"string","x-stream-index":"001.006"},"shadow_banned":{"description":"Whether a user is shadow banned","title":"Shadow banned","type":"boolean","x-stream-index":"002"},"teams":{"description":"List of teams user is a part of","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids","shadow_banned","invisible"],"title":"UserResponse","type":"object"},"UserResponseCommonFields":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"018"},"banned":{"type":"boolean","x-stream-index":"012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"017"},"created_at":{"format":"date-time","type":"string","x-stream-index":"009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"deactivated_at":{"format":"date-time","type":"string","x-stream-index":"016"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"011"},"id":{"type":"string","x-stream-index":"001"},"image":{"type":"string","x-stream-index":"003"},"language":{"type":"string","x-stream-index":"005"},"last_active":{"format":"date-time","type":"string","x-stream-index":"014"},"name":{"type":"string","x-stream-index":"002"},"online":{"type":"boolean","x-stream-index":"013"},"revoke_tokens_issued_before":{"format":"date-time","type":"string","x-stream-index":"015"},"role":{"type":"string","x-stream-index":"006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"008"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids"],"type":"object"},"UserResponsePrivacyFields":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"banned":{"type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.017"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"string","x-stream-index":"001.016"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"001.011"},"id":{"type":"string","x-stream-index":"001.001"},"image":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"003"},"language":{"type":"string","x-stream-index":"001.005"},"last_active":{"format":"date-time","type":"string","x-stream-index":"001.014"},"name":{"type":"string","x-stream-index":"001.002"},"online":{"type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"002"},"revoke_tokens_issued_before":{"format":"date-time","type":"string","x-stream-index":"001.015"},"role":{"type":"string","x-stream-index":"001.006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids"],"type":"object"},"UserUnbannedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"005.002"},"shadow":{"type":"boolean","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"004.001"},"type":{"default":"user.unbanned","type":"string","x-stream-index":"005.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["shadow","cid","channel_id","channel_type","type","created_at"],"title":"UserUnbannedEvent","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"},"UserUnmutedEvent":{"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"004.002"},"target_user":{"type":"string","x-stream-index":"002"},"target_users":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"type":{"default":"user.unmuted","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"001"}},"required":["type","created_at"],"title":"UserUnmutedEvent","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"},"UserUnreadReminderEvent":{"properties":{"channels":{"additionalProperties":{"$ref":"#/components/schemas/ChannelMessages"},"type":"object","x-stream-index":"003"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"user.unread_message_reminder","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002"}},"required":["type","created_at","channels"],"title":"UserUnreadReminderEvent","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"},"UserUpdatedEvent":{"description":"This event is sent when a user gets updated. The event contains information about the updated user.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"received_at":{"format":"date-time","type":"string","x-stream-index":"001.004"},"type":{"default":"user.updated","description":"The type of event: \"user.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.002"},"user":{"$ref":"#/components/schemas/UserResponsePrivacyFields","description":"The updated user","title":"User","x-stream-index":"002.001"}},"required":["type","created_at","custom","user"],"title":"UserUpdatedEvent","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"},"VideoSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"camera_default_on":{"type":"boolean","x-stream-index":"004"},"camera_facing":{"enum":["front","back","external"],"type":"string","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled","target_resolution","camera_default_on","camera_facing"],"type":"object"},"VoteData":{"properties":{"answer_text":{"type":"string","x-stream-index":"002"},"option_id":{"maxLength":255,"type":"string","x-stream-index":"001"}},"type":"object"},"WSEvent":{"description":"Represents an BaseEvent that happened in Stream Chat","properties":{"automoderation":{"type":"boolean","x-stream-index":"023"},"automoderation_scores":{"$ref":"#/components/schemas/ModerationResponse","x-stream-index":"024"},"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"011"},"channel_id":{"type":"string","x-stream-index":"004"},"channel_last_message_at":{"format":"date-time","type":"string","x-stream-index":"007"},"channel_type":{"type":"string","x-stream-index":"005"},"cid":{"type":"string","x-stream-index":"003"},"connection_id":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"string","x-stream-index":"028"},"created_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"022"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"027"},"me":{"$ref":"#/components/schemas/OwnUserResponse","x-stream-index":"019"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"014"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"008"},"message_update":{"$ref":"#/components/schemas/MessageUpdate","x-stream-index":"009"},"parent_id":{"type":"string","x-stream-index":"025"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"015"},"poll_vote":{"$ref":"#/components/schemas/PollVoteResponseData","x-stream-index":"016"},"reaction":{"$ref":"#/components/schemas/ReactionResponse","x-stream-index":"010"},"reason":{"type":"string","x-stream-index":"021"},"team":{"type":"string","x-stream-index":"026"},"thread":{"$ref":"#/components/schemas/ThreadResponse","x-stream-index":"013"},"thread_id":{"type":"string","x-stream-index":"012"},"type":{"type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"017"},"user_id":{"type":"string","x-stream-index":"018"},"watcher_count":{"format":"int32","type":"integer","x-stream-index":"020"}},"required":["type","custom","created_at"],"title":"Event","type":"object","x-stream-docs-page-id":"event_object"},"WebhookEvent":{"description":"The discriminator object for all webhook events, it maps events' payload to the final type","discriminator":{"mapping":{"*":"#/components/schemas/AnyEvent","activity.marked":"#/components/schemas/ActivityMarkedEvent","campaign.completed":"#/components/schemas/CampaignCompletedEvent","campaign.started":"#/components/schemas/CampaignStartedEvent","channel.created":"#/components/schemas/ChannelCreatedEvent","channel.deleted":"#/components/schemas/ChannelDeletedEvent","channel.frozen":"#/components/schemas/ChannelFrozenEvent","channel.hidden":"#/components/schemas/ChannelHiddenEvent","channel.muted":"#/components/schemas/ChannelMutedEvent","channel.truncated":"#/components/schemas/ChannelTruncatedEvent","channel.unfrozen":"#/components/schemas/ChannelUnFrozenEvent","channel.unmuted":"#/components/schemas/ChannelUnmutedEvent","channel.updated":"#/components/schemas/ChannelUpdatedEvent","channel.visible":"#/components/schemas/ChannelVisibleEvent","export.bulk_image_moderation.error":"#/components/schemas/AsyncExportErrorEvent","export.bulk_image_moderation.success":"#/components/schemas/AsyncBulkImageModerationEvent","export.channels.error":"#/components/schemas/AsyncExportErrorEvent","export.channels.success":"#/components/schemas/AsyncExportChannelsEvent","export.moderation_logs.error":"#/components/schemas/AsyncExportErrorEvent","export.moderation_logs.success":"#/components/schemas/AsyncExportModerationLogsEvent","export.users.error":"#/components/schemas/AsyncExportErrorEvent","export.users.success":"#/components/schemas/AsyncExportUsersEvent","flag.updated":"#/components/schemas/FlagUpdatedEvent","member.added":"#/components/schemas/MemberAddedEvent","member.removed":"#/components/schemas/MemberRemovedEvent","member.updated":"#/components/schemas/MemberUpdatedEvent","message.deleted":"#/components/schemas/MessageDeletedEvent","message.flagged":"#/components/schemas/MessageFlaggedEvent","message.new":"#/components/schemas/MessageNewEvent","message.pending":"#/components/schemas/PendingMessageEvent","message.read":"#/components/schemas/MessageReadEvent","message.unblocked":"#/components/schemas/MessageUnblockedEvent","message.undeleted":"#/components/schemas/MessageUndeletedEvent","message.updated":"#/components/schemas/MessageUpdatedEvent","notification.mark_unread":"#/components/schemas/NotificationMarkUnreadEvent","notification.reminder_due":"#/components/schemas/ReminderNotificationEvent","notification.thread_message_new":"#/components/schemas/MessageNewEvent","reaction.deleted":"#/components/schemas/ReactionDeletedEvent","reaction.new":"#/components/schemas/ReactionNewEvent","reaction.updated":"#/components/schemas/ReactionUpdatedEvent","reminder.created":"#/components/schemas/ReminderCreatedEvent","reminder.deleted":"#/components/schemas/ReminderDeletedEvent","reminder.updated":"#/components/schemas/ReminderUpdatedEvent","thread.updated":"#/components/schemas/ThreadUpdatedEvent","user.banned":"#/components/schemas/UserBannedEvent","user.deactivated":"#/components/schemas/UserDeactivatedEvent","user.deleted":"#/components/schemas/UserDeletedEvent","user.flagged":"#/components/schemas/UserFlaggedEvent","user.messages.deleted":"#/components/schemas/UserMessagesDeletedEvent","user.muted":"#/components/schemas/UserMutedEvent","user.reactivated":"#/components/schemas/UserReactivatedEvent","user.unbanned":"#/components/schemas/UserUnbannedEvent","user.unmuted":"#/components/schemas/UserUnmutedEvent","user.unread_message_reminder":"#/components/schemas/UserUnreadReminderEvent","user.updated":"#/components/schemas/UserUpdatedEvent"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/ActivityMarkedEvent"},{"$ref":"#/components/schemas/AnyEvent"},{"$ref":"#/components/schemas/AsyncBulkImageModerationEvent"},{"$ref":"#/components/schemas/AsyncExportChannelsEvent"},{"$ref":"#/components/schemas/AsyncExportErrorEvent"},{"$ref":"#/components/schemas/AsyncExportErrorEvent"},{"$ref":"#/components/schemas/AsyncExportErrorEvent"},{"$ref":"#/components/schemas/AsyncExportErrorEvent"},{"$ref":"#/components/schemas/AsyncExportModerationLogsEvent"},{"$ref":"#/components/schemas/AsyncExportUsersEvent"},{"$ref":"#/components/schemas/CampaignCompletedEvent"},{"$ref":"#/components/schemas/CampaignStartedEvent"},{"$ref":"#/components/schemas/ChannelCreatedEvent"},{"$ref":"#/components/schemas/ChannelDeletedEvent"},{"$ref":"#/components/schemas/ChannelFrozenEvent"},{"$ref":"#/components/schemas/ChannelHiddenEvent"},{"$ref":"#/components/schemas/ChannelMutedEvent"},{"$ref":"#/components/schemas/ChannelTruncatedEvent"},{"$ref":"#/components/schemas/ChannelUnFrozenEvent"},{"$ref":"#/components/schemas/ChannelUnmutedEvent"},{"$ref":"#/components/schemas/ChannelUpdatedEvent"},{"$ref":"#/components/schemas/ChannelVisibleEvent"},{"$ref":"#/components/schemas/FlagUpdatedEvent"},{"$ref":"#/components/schemas/MemberAddedEvent"},{"$ref":"#/components/schemas/MemberRemovedEvent"},{"$ref":"#/components/schemas/MemberUpdatedEvent"},{"$ref":"#/components/schemas/MessageDeletedEvent"},{"$ref":"#/components/schemas/MessageFlaggedEvent"},{"$ref":"#/components/schemas/MessageNewEvent"},{"$ref":"#/components/schemas/MessageNewEvent"},{"$ref":"#/components/schemas/MessageReadEvent"},{"$ref":"#/components/schemas/MessageUnblockedEvent"},{"$ref":"#/components/schemas/MessageUndeletedEvent"},{"$ref":"#/components/schemas/MessageUpdatedEvent"},{"$ref":"#/components/schemas/NotificationMarkUnreadEvent"},{"$ref":"#/components/schemas/PendingMessageEvent"},{"$ref":"#/components/schemas/ReactionDeletedEvent"},{"$ref":"#/components/schemas/ReactionNewEvent"},{"$ref":"#/components/schemas/ReactionUpdatedEvent"},{"$ref":"#/components/schemas/ReminderCreatedEvent"},{"$ref":"#/components/schemas/ReminderDeletedEvent"},{"$ref":"#/components/schemas/ReminderNotificationEvent"},{"$ref":"#/components/schemas/ReminderUpdatedEvent"},{"$ref":"#/components/schemas/ThreadUpdatedEvent"},{"$ref":"#/components/schemas/UserBannedEvent"},{"$ref":"#/components/schemas/UserDeactivatedEvent"},{"$ref":"#/components/schemas/UserDeletedEvent"},{"$ref":"#/components/schemas/UserFlaggedEvent"},{"$ref":"#/components/schemas/UserMessagesDeletedEvent"},{"$ref":"#/components/schemas/UserMutedEvent"},{"$ref":"#/components/schemas/UserReactivatedEvent"},{"$ref":"#/components/schemas/UserUnbannedEvent"},{"$ref":"#/components/schemas/UserUnmutedEvent"},{"$ref":"#/components/schemas/UserUnreadReminderEvent"},{"$ref":"#/components/schemas/UserUpdatedEvent"}]},"WrappedUnreadCountsResponse":{"description":"Basic response information","nullable":true,"properties":{"channel_type":{"items":{"$ref":"#/components/schemas/UnreadCountsChannelType"},"type":"array","x-stream-index":"001.005"},"channels":{"items":{"$ref":"#/components/schemas/UnreadCountsChannel"},"type":"array","x-stream-index":"001.004"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"threads":{"items":{"$ref":"#/components/schemas/UnreadCountsThread"},"type":"array","x-stream-index":"001.006"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"001.001"},"total_unread_count_by_team":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001.003"},"total_unread_threads_count":{"format":"int32","type":"integer","x-stream-index":"001.002"}},"required":["total_unread_count","total_unread_threads_count","channels","channel_type","threads","duration"],"title":"Response","type":"object"},"XiaomiConfig":{"properties":{"Disabled":{"type":"boolean","writeOnly":true,"x-stream-index":"003"},"package_name":{"type":"string","x-stream-index":"001"},"secret":{"type":"string","x-stream-index":"002"}},"type":"object"},"XiaomiConfigFields":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"package_name":{"type":"string","x-stream-index":"002"},"secret":{"type":"string","x-stream-index":"003"}},"required":["enabled"],"type":"object"}},"securitySchemes":{"JWT":{"description":"JWT should be always provided when stream-auth-type=jwt.\n\nUsing JWT auth request could be authenticated as user or as server-side.\n\nWhen using user authentication permission checking is going to be applied to requests based on the user that is\nperforming a request.\n\nThe `authorization` header should be a JWT string signed using the secret attached to the API key used to perform\nrequests.\n\n**WARNING** all client-side official SDK do not ship with token generation; this is to make sure that the API secret is not\nshared with an untrusted party such as a browser or a iOS/Android application. Tokens **must** be generated server-side.\nIf you wish, you can configure your application to ignore authentication (see `disable_auth_check`)\nThe JWT string must include only the user_id claim and can include any built-in JWT claim such as iat, exp as well.\n","in":"header","name":"Authorization","type":"apiKey"},"api_key":{"description":"Application API key should be always set in order to authenticate the request.","in":"query","name":"api_key","type":"apiKey"},"stream-auth-type":{"description":"Stream-Auth-Type should be always set in order to authenticate the request. Possible\nvalues: `jwt` or `anonymous`.\n\n`jwt` allows you to authenticate as a user. With this auth type you should also provide valid JWT in Authorization\nheader.\n\n`anonymous` allows you to authenticate as anonymous user. Please note that most advanced features are not available\nto anonymous users.","in":"header","name":"Stream-Auth-Type","type":"apiKey"}}},"info":{"title":"Stream API","version":"v191.1.0"},"openapi":"3.0.3","paths":{"/app":{"get":{"description":"This Method returns the application settings\n","operationId":"GetApp","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetApplicationResponse"}}},"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":"Get App Settings","tags":["product:chat"]},"patch":{"description":"This Method updates one or more application settings\n","operationId":"UpdateApp","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAppRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Update App Settings","tags":["product:chat"]}},"/blocklists":{"get":{"description":"Returns all available block lists\n","operationId":"ListBlockLists","parameters":[{"in":"query","name":"team","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListBlockListResponse"}}},"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":"List block lists","tags":["product:chat"]},"post":{"description":"Creates a new application blocklist, once created the blocklist can be used by any channel type\n","operationId":"CreateBlockList","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBlockListRequest"}}},"description":"Block list","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBlockListResponse"}}},"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":"Create block list","tags":["product:chat"]}},"/blocklists/{name}":{"delete":{"description":"Deletes previously created application blocklist\n","operationId":"DeleteBlockList","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"team","schema":{"type":"string","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete block list","tags":["product:chat"]},"get":{"description":"Returns block list by given name\n","operationId":"GetBlockList","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Block list name","title":"Name","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"team","schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBlockListResponse"}}},"description":"GetBlockListResponse"},"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":"Get block list","tags":["product:chat"]},"put":{"description":"Updates contents of the block list\n","operationId":"UpdateBlockList","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Block list name","title":"Name","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBlockListRequest"}}},"description":"Update block list","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBlockListResponse"}}},"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":"Update block list","tags":["product:chat"]}},"/campaigns/query":{"post":{"description":"Query campaigns with filter query\n","operationId":"QueryCampaigns","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCampaignsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCampaignsResponse"}}},"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":"Query campaigns","tags":["product:chat"]}},"/campaigns/{id}":{"get":{"description":"Get campaign by ID.\n","operationId":"GetCampaign","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"The ID of the campaign (uuid)","maxLength":255,"title":"Campaign ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"prev","schema":{"description":"Token for the previous page of campaign users","title":"Previous Users Page","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"query","name":"next","schema":{"description":"Token for the next page of campaign users","title":"Next Users Page","type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"limit","schema":{"description":"Maximum number of campaign users to return in a single request (max: 1000)","format":"int32","maximum":1000,"minimum":0,"title":"Users Limit","type":"integer","writeOnly":true,"x-stream-index":"002.003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCampaignResponse"}}},"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":"Get campaign","tags":["product:chat"]}},"/campaigns/{id}/start":{"post":{"description":"Starts or schedules a campaign\n","operationId":"StartCampaign","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartCampaignRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartCampaignResponse"}}},"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":"Start/schedule campaign","tags":["product:chat"]}},"/campaigns/{id}/stop":{"post":{"description":"Stops a campaign\n","operationId":"ScheduleCampaign","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignResponse"}}},"description":"Successful 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":"Stop campaign","tags":["product:chat"]}},"/channels":{"post":{"description":"Query channels with filter query\n","operationId":"QueryChannels","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryChannelsRequest"}}},"description":"Query Channels Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryChannelsResponse"}}},"description":"Channels list"},"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":"Query channels","tags":["product:chat"]}},"/channels/delete":{"post":{"description":"Allows to delete several channels at once asynchronously\n\nSends events:\n- channel.deleted\n- channel.deleted\n","operationId":"DeleteChannels","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteChannelsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteChannelsResponse"}}},"description":"Successful 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":"Deletes channels asynchronously","tags":["product:chat"]}},"/channels/read":{"post":{"description":"Marks channels as read up to the specific message. If no channels is given, mark all channel as read\n\nSends events:\n- message.read\n- message.read\n","operationId":"MarkChannelsRead","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkChannelsReadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkReadResponse"}}},"description":"Successful 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 channels as read","tags":["product:chat"]}},"/channels/{type}/query":{"post":{"description":"This Method creates a channel or returns an existing one with matching attributes\n\nSends events:\n- channel.created\n- member.added\n- member.removed\n- member.updated\n- user.watching.start\n","operationId":"GetOrCreateDistinctChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelGetOrCreateRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelStateResponse"}}},"description":"Successful 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":"Get or create channel","tags":["product:chat"]}},"/channels/{type}/{id}":{"delete":{"description":"Deletes channel\n\nSends events:\n- channel.deleted\n- channel.deleted\n","operationId":"DeleteChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"query","name":"hard_delete","schema":{"type":"boolean","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteChannelResponse"}}},"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":"Delete channel","tags":["product:chat"]},"patch":{"description":"Updates certain fields of the channel\n\nSends events:\n- channel.updated\n- channel.updated\n","operationId":"UpdateChannelPartial","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelPartialRequest"}}},"description":"UpdateChannelPartialRequest","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelPartialResponse"}}},"description":"Successful 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":"Partially update channel","tags":["product:chat"]},"post":{"description":"Change channel data\n\nSends events:\n- channel.updated\n- member.added\n- member.removed\n- member.updated\n- message.new\n- channel.updated\n- member.added\n- member.removed\n- member.updated\n- message.new\n","operationId":"UpdateChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"013.002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"013.002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelRequest"}}},"description":"Channel update request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelResponse"}}},"description":"Successful 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":"Update channel","tags":["product:chat"]}},"/channels/{type}/{id}/draft":{"delete":{"description":"Deletes a draft\n\nSends events:\n- draft.deleted\n","operationId":"DeleteDraft","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"parent_id","schema":{"description":"Parent message ID","title":"string","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"003.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete draft","tags":["product:chat"]},"get":{"description":"Get a draft\n","operationId":"GetDraft","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"parent_id","schema":{"description":"Parent message ID","title":"string","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"003.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetDraftResponse"}}},"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":"Get draft","tags":["product:chat"]}},"/channels/{type}/{id}/event":{"post":{"description":"Sends event to the channel\n","operationId":"SendEvent","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendEventRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventResponse"}}},"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":"Send event","tags":["product:chat"]}},"/channels/{type}/{id}/file":{"delete":{"description":"Deletes previously uploaded file\n","operationId":"DeleteFile","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of file","title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"File ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"url","schema":{"description":"File URL to delete","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete file","tags":["product:chat"]},"post":{"description":"Uploads file\n","operationId":"UploadFile","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/FileUploadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileUploadResponse"}}},"description":"Successful 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":"Upload file","tags":["product:chat"]}},"/channels/{type}/{id}/hide":{"post":{"description":"Marks channel as hidden for current user\n\nSends events:\n- channel.hidden\n- channel.hidden\n","operationId":"HideChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HideChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HideChannelResponse"}}},"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":"Hide channel","tags":["product:chat"]}},"/channels/{type}/{id}/image":{"delete":{"description":"Deletes previously uploaded image\n","operationId":"DeleteImage","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of file","title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"File ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"url","schema":{"description":"File URL to delete","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete image","tags":["product:chat"]},"post":{"description":"Uploads image\n","operationId":"UploadImage","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.001.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.001.002"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/ImageUploadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageUploadResponse"}}},"description":"Successful 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":"Upload image","tags":["product:chat"]}},"/channels/{type}/{id}/member":{"patch":{"description":"\n","operationId":"UpdateMemberPartial","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"005.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMemberPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMemberPartialResponse"}}},"description":"Successful 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":"Partially channel member update","tags":["product:chat"]}},"/channels/{type}/{id}/message":{"post":{"description":"Sends new message to the specified channel\n\nSends events:\n- message.new\n- message.updated\n- message.new\n- message.updated\n","operationId":"SendMessage","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"009.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"009.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendMessageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendMessageResponse"}}},"description":"Successful 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":"Send new message","tags":["product:chat"]}},"/channels/{type}/{id}/messages":{"get":{"description":"Returns list messages found by IDs\n","operationId":"GetManyMessages","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"ids","required":true,"schema":{"description":"List of comma-separated IDs","items":{"type":"string"},"maximum":50,"minimum":1,"title":"IDs","type":"array","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetManyMessagesResponse"}}},"description":"Successful 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":"Get many messages","tags":["product:chat"]}},"/channels/{type}/{id}/query":{"post":{"description":"This Method creates a channel or returns an existing one with matching attributes\n\nSends events:\n- channel.created\n- member.added\n- member.removed\n- member.updated\n- user.watching.start\n","operationId":"GetOrCreateChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID (maximum length of 64 characters)","title":"ID","type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelGetOrCreateRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelStateResponse"}}},"description":"Successful 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":"Get or create channel","tags":["product:chat"]}},"/channels/{type}/{id}/read":{"post":{"description":"Marks channel as read up to the specific message\n\nSends events:\n- message.read\n- message.read\n","operationId":"MarkRead","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkReadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkReadResponse"}}},"description":"Successful 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 read","tags":["product:chat"]}},"/channels/{type}/{id}/show":{"post":{"description":"Shows previously hidden channel\n\nSends events:\n- channel.visible\n- channel.visible\n","operationId":"ShowChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShowChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShowChannelResponse"}}},"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":"Show channel","tags":["product:chat"]}},"/channels/{type}/{id}/truncate":{"post":{"description":"Truncates messages from a channel. Can be applied to the entire channel or scoped to specific members.\n\nSends events:\n- channel.truncated\n- channel.truncated\n","operationId":"TruncateChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TruncateChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TruncateChannelResponse"}}},"description":"Successful 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":"Truncate channel","tags":["product:chat"]}},"/channels/{type}/{id}/unread":{"post":{"description":"Marks channel as unread from a specific message\n","operationId":"MarkUnread","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkUnreadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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 unread","tags":["product:chat"]}},"/channeltypes":{"get":{"description":"Lists all available channel types\n","operationId":"ListChannelTypes","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListChannelTypesResponse"}}},"description":"ListChannelTypesResponse"},"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":"List channel types","tags":["product:chat"]},"post":{"description":"Creates new channel type\n","operationId":"CreateChannelType","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateChannelTypeRequest"}}},"description":"CreateChannelTypeRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateChannelTypeResponse"}}},"description":"Successful 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":"Create channel type","tags":["product:chat"]}},"/channeltypes/{name}":{"delete":{"description":"Deletes channel type\n","operationId":"DeleteChannelType","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Channel type name","title":"Name","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete channel type","tags":["product:chat"]},"get":{"description":"Gets channel type\n","operationId":"GetChannelType","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Channel type name","title":"Name","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetChannelTypeResponse"}}},"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":"Get channel type","tags":["product:chat"]},"put":{"description":"Updates channel type\n","operationId":"UpdateChannelType","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelTypeRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelTypeResponse"}}},"description":"Successful 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":"Update channel type","tags":["product:chat"]}},"/check_push":{"post":{"description":"Sends a test message via push, this is a test endpoint to verify your push settings\n","operationId":"CheckPush","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckPushRequest"}}},"description":"CheckPushRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckPushResponse"}}},"description":"Successful 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":"Check push","tags":["product:chat"]}},"/check_sns":{"post":{"description":"Validates Amazon SNS configuration\n","operationId":"CheckSNS","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSNSRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSNSResponse"}}},"description":"Successful 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":"Check SNS","tags":["product:chat"]}},"/check_sqs":{"post":{"description":"Validates Amazon SQS credentials\n","operationId":"CheckSQS","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSQSRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSQSResponse"}}},"description":"Successful 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":"Check SQS","tags":["product:chat"]}},"/commands":{"get":{"description":"Returns all custom commands\n","operationId":"ListCommands","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListCommandsResponse"}}},"description":"ListCommandsResponse"},"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":"List commands","tags":["product:chat"]},"post":{"description":"Creates custom chat command\n","operationId":"CreateCommand","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCommandRequest"}}},"description":"CreateCommandRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCommandResponse"}}},"description":"CreateCommandResponse"},"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":"Create command","tags":["product:chat"]}},"/commands/{name}":{"delete":{"description":"Deletes custom chat command\n","operationId":"DeleteCommand","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Command name","title":"Name","type":"string","x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCommandResponse"}}},"description":"DeleteCommandResponse"},"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":"Delete command","tags":["product:chat"]},"get":{"description":"Returns custom command by its name\n","operationId":"GetCommand","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Command name","title":"Name","type":"string","x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCommandResponse"}}},"description":"GetCommandResponse"},"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":"Get command","tags":["product:chat"]},"put":{"description":"Updates custom chat command\n","operationId":"UpdateCommand","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Unique command name","title":"Name","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCommandRequest"}}},"description":"UpdateCommandRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCommandResponse"}}},"description":"UpdateCommandResponse"},"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":"Update command","tags":["product:chat"]}},"/devices":{"delete":{"description":"Deletes one device\n","operationId":"DeleteDevice","parameters":[{"in":"query","name":"id","required":true,"schema":{"description":"Device ID to delete","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"user_id","schema":{"description":"**Server-side only**. User ID which server acts upon","title":"User ID","type":"string","writeOnly":true,"x-stream-index":"002.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete device","tags":["product:chat"]},"get":{"description":"Returns all available devices\n","operationId":"ListDevices","parameters":[{"in":"query","name":"user_id","schema":{"description":"**Server-side only**. User ID which server acts upon","title":"User ID","type":"string","writeOnly":true,"x-stream-index":"001.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDevicesResponse"}}},"description":"ListDevicesResponse"},"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":"List devices","tags":["product:chat"]},"post":{"description":"Adds a new device to a user, if the same device already exists the call will have no effect\n","operationId":"CreateDevice","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDeviceRequest"}}},"description":"CreateDeviceRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Create device","tags":["product:chat"]}},"/drafts/query":{"post":{"description":"Queries draft messages for a user\n","operationId":"QueryDrafts","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryDraftsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryDraftsResponse"}}},"description":"Successful 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":"Query draft messages","tags":["product:chat"]}},"/export/users":{"post":{"description":"Exports user profile, reactions and messages for list of given users\n","operationId":"ExportUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportUsersResponse"}}},"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":"Export users","tags":["product:chat"]}},"/export_channels":{"post":{"description":"Exports channel data to JSON file\n","operationId":"ExportChannels","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportChannelsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportChannelsResponse"}}},"description":"Successful 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":"Export channels","tags":["product:chat"]}},"/external_storage":{"get":{"description":"Lists external storage\n","operationId":"ListExternalStorage","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListExternalStorageResponse"}}},"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":"List external storage","tags":["product:chat"]},"post":{"description":"Creates new external storage\n","operationId":"CreateExternalStorage","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateExternalStorageRequest"}}},"description":"CreateExternalStorageRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateExternalStorageResponse"}}},"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":"Create external storage","tags":["product:chat"]}},"/external_storage/{name}":{"delete":{"description":"Deletes external storage\n","operationId":"DeleteExternalStorage","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteExternalStorageResponse"}}},"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":"Delete external storage","tags":["product:chat"]},"put":{"description":"\n","operationId":"UpdateExternalStorage","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateExternalStorageRequest"}}},"description":"ExternalStorageRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateExternalStorageResponse"}}},"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":"Update External Storage","tags":["product:chat"]}},"/external_storage/{name}/check":{"get":{"description":"\n","operationId":"CheckExternalStorage","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckExternalStorageResponse"}}},"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":"Check External Storage","tags":["product:chat"]}},"/guest":{"post":{"description":"\n","operationId":"CreateGuest","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGuestRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGuestResponse"}}},"description":"Successful 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":"Create Guest","tags":["product:chat"]}},"/import_urls":{"post":{"description":"Creates a new import URL\n","operationId":"CreateImportURL","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateImportURLRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateImportURLResponse"}}},"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":"Create import URL","tags":["product:chat"]}},"/imports":{"get":{"description":"Gets an import\n","operationId":"ListImports","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListImportsResponse"}}},"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":"Get import","tags":["product:chat"]},"post":{"description":"Creates a new import\n","operationId":"CreateImport","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateImportRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateImportResponse"}}},"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":"Create import","tags":["product:chat"]}},"/imports/{id}":{"get":{"description":"Gets an import\n","operationId":"GetImport","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetImportResponse"}}},"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":"Get import","tags":["product:chat"]}},"/members":{"get":{"description":"Find and filter channel members\n","operationId":"QueryMembers","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryMembersPayload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MembersResponse"}}},"description":"Successful 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":"Query members","tags":["product:chat"]}},"/messages/history":{"post":{"description":"Queries history for one message\n","operationId":"QueryMessageHistory","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryMessageHistoryRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryMessageHistoryResponse"}}},"description":"Successful 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":"Query message history","tags":["product:chat"]}},"/messages/{id}":{"delete":{"description":"Deletes message\n\nSends events:\n- message.deleted\n- message.deleted\n","operationId":"DeleteMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID to delete","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"hard","schema":{"description":"Delete all message reactions and replies as well","title":"Hard","type":"boolean","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"deleted_by","schema":{"type":"string","writeOnly":true,"x-stream-index":"003"}},{"in":"query","name":"delete_for_me","schema":{"description":"Delete the message only for the user making the request","title":"Delete for me","type":"boolean","writeOnly":true,"x-stream-index":"004"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteMessageResponse"}}},"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":"Delete message","tags":["product:chat"]},"get":{"description":"Returns message by ID\n","operationId":"GetMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"ID of the message","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"show_deleted_message","schema":{"description":"Whether to show deleted message","title":"Show deleted message","type":"boolean","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetMessageResponse"}}},"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":"Get message","tags":["product:chat"]},"post":{"description":"Updates message with new data\n\nSends events:\n- message.updated\n- message.updated\n","operationId":"UpdateMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"004.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessageResponse"}}},"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":"Update message","tags":["product:chat"]},"put":{"description":"Updates certain fields of the message\n\nSends events:\n- message.updated\n- message.updated\n","operationId":"UpdateMessagePartial","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessagePartialRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessagePartialResponse"}}},"description":"Successful 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":"Partially message update","tags":["product:chat"]}},"/messages/{id}/action":{"post":{"description":"Executes message command action with given parameters\n\nSends events:\n- message.new\n- message.new\n","operationId":"RunMessageAction","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageActionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}},"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":"Run message command action","tags":["product:chat"]}},"/messages/{id}/commit":{"post":{"description":"Commits a pending message, which will make it visible in the channel\n\nSends events:\n- message.new\n- message.updated\n- message.new\n- message.updated\n","operationId":"CommitMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}},"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":"Commit message","tags":["product:chat"]}},"/messages/{id}/reaction":{"post":{"description":"Sends reaction to specified message\n\nSends events:\n- reaction.new\n- reaction.updated\n","operationId":"SendReaction","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID to send reaction for","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendReactionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendReactionResponse"}}},"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":"Send reaction","tags":["product:chat"]}},"/messages/{id}/reaction/{type}":{"delete":{"description":"Removes user reaction from the message\n\nSends events:\n- reaction.deleted\n","operationId":"DeleteReaction","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID to remove reaction from","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"type","required":true,"schema":{"description":"Reaction type to remove","title":"Type","type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"description":"**Server-side only**. User ID which server acts upon","title":"User ID","type":"string","writeOnly":true,"x-stream-index":"003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteReactionResponse"}}},"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":"Delete reaction","tags":["product:chat"]}},"/messages/{id}/reactions":{"get":{"description":"Returns list of reactions of specific message\n","operationId":"GetReactions","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"limit","schema":{"description":"Number of records to return","format":"int32","title":"Limit","type":"integer","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"offset","schema":{"description":"Number of records to offset","format":"int32","title":"Offset","type":"integer","writeOnly":true,"x-stream-index":"003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetReactionsResponse"}}},"description":"Successful 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":"Get reactions","tags":["product:chat"]},"post":{"description":"Get reactions on a message\n","operationId":"QueryReactions","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryReactionsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryReactionsResponse"}}},"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"}},"tags":["product:chat"]}},"/messages/{id}/translate":{"post":{"description":"Translates message to a given language using automated translation software\n\nSends events:\n- message.updated\n- message.updated\n","operationId":"TranslateMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TranslateMessageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}},"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":"Translate message","tags":["product:chat"]}},"/messages/{id}/undelete":{"post":{"description":"Undelete a message that was previously soft-deleted\n\nSends events:\n- message.undeleted\n- message.undeleted\n","operationId":"UndeleteMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"004.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessageResponse"}}},"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":"Undelete message","tags":["product:chat"]}},"/messages/{message_id}/polls/{poll_id}/vote":{"post":{"description":"Cast a vote on a poll\n\nSends events:\n- feeds.poll.vote_casted\n- feeds.poll.vote_changed\n- feeds.poll.vote_removed\n- poll.vote_casted\n- poll.vote_changed\n- poll.vote_removed\n","operationId":"CastPollVote","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CastPollVoteRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollVoteResponse"}}},"description":"Successful 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":"Cast vote","tags":["product:chat"]}},"/messages/{message_id}/polls/{poll_id}/vote/{vote_id}":{"delete":{"description":"Delete a vote from a poll\n\nSends events:\n- feeds.poll.vote_removed\n- poll.vote_removed\n","operationId":"DeletePollVote","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"004"}},{"in":"path","name":"vote_id","required":true,"schema":{"description":"Vote ID","maxLength":255,"title":"string","type":"string","x-stream-index":"005"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollVoteResponse"}}},"description":"Successful 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":"Delete vote","tags":["product:chat"]}},"/messages/{message_id}/reminders":{"delete":{"description":"Deletes a user's created reminder\n\nSends events:\n- reminder.deleted\n","operationId":"DeleteReminder","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteReminderResponse"}}},"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":"Delete reminder","tags":["product:chat"]},"patch":{"description":"Updates an existing reminder\n\nSends events:\n- reminder.updated\n","operationId":"UpdateReminder","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateReminderRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateReminderResponse"}}},"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":"Updates Reminder","tags":["product:chat"]},"post":{"description":"Creates a new reminder\n\nSends events:\n- reminder.created\n","operationId":"CreateReminder","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateReminderRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReminderResponseData"}}},"description":"Successful 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":"Create reminder","tags":["product:chat"]}},"/messages/{parent_id}/replies":{"get":{"description":"Returns replies (thread) of the message\n","operationId":"GetReplies","parameters":[{"in":"path","name":"parent_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"sort","schema":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":1,"type":"array","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"limit","schema":{"description":"The maximum number of messages to return (max limit ","format":"int32","minimum":0,"title":"Limit","type":"integer","x-stream-index":"003.001"}},{"in":"query","name":"offset","schema":{"description":"The offset to start from","format":"int32","title":"Offset","type":"integer","x-stream-index":"003.002"}},{"in":"query","name":"id_gte","schema":{"description":"The ID of the message to get messages with a timestamp greater than or equal to","title":"IDGTE","type":"string","x-stream-index":"003.003"}},{"in":"query","name":"id_gt","schema":{"description":"The ID of the message to get messages with a timestamp greater than","title":"IDGT","type":"string","x-stream-index":"003.004"}},{"in":"query","name":"id_lte","schema":{"description":"The ID of the message to get messages with a timestamp smaller than or equal to","title":"IDLTE","type":"string","x-stream-index":"003.005"}},{"in":"query","name":"id_lt","schema":{"description":"The ID of the message to get messages with a timestamp smaller than","title":"IDLT","type":"string","x-stream-index":"003.006"}},{"in":"query","name":"created_at_after_or_equal","schema":{"description":"The timestamp to get messages with a created_at timestamp greater than or equal to","format":"date-time","title":"Created_at after or equal","type":"string","x-stream-index":"003.007"}},{"in":"query","name":"created_at_after","schema":{"description":"The timestamp to get messages with a created_at timestamp greater than","format":"date-time","title":"Created_at after","type":"string","x-stream-index":"003.008"}},{"in":"query","name":"created_at_before_or_equal","schema":{"description":"The timestamp to get messages with a created_at timestamp smaller than or equal to","format":"date-time","title":"Created_at after before or equal","type":"string","x-stream-index":"003.009"}},{"in":"query","name":"created_at_before","schema":{"description":"The timestamp to get messages with a created_at timestamp smaller than","format":"date-time","title":"Created_at after before","type":"string","x-stream-index":"003.010"}},{"in":"query","name":"id_around","schema":{"description":"The result will be a set of messages, that are both older and newer than the message with the provided ID, and the message with the ID provided will be in the middle of the set","title":"Id around","type":"string","x-stream-index":"003.011"}},{"in":"query","name":"created_at_around","schema":{"description":"The result will be a set of messages, that are both older and newer than the created_at timestamp provided, distributed evenly around the timestamp","format":"date-time","title":"Created_at around","type":"string","x-stream-index":"003.012"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRepliesResponse"}}},"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":"Get replies","tags":["product:chat"]}},"/moderation/ban":{"delete":{"description":"Removes previously applied ban\n\nSends events:\n- user.unbanned\n- user.unbanned\n","operationId":"Unban","parameters":[{"in":"query","name":"target_user_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"channel_cid","schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"created_by","schema":{"type":"string","writeOnly":true,"x-stream-index":"005"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Unban user","tags":["product:chat"]},"post":{"description":"Restricts user activity either in specific channel or globally\n\nSends events:\n- user.banned\n- user.messages.deleted\n- user.banned\n","operationId":"Ban","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BanRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Ban user","tags":["product:chat"]}},"/moderation/flag":{"post":{"description":"Reports message or user for review by moderators\n\nSends events:\n- message.flagged\n- user.flagged\n- message.flagged\n- user.flagged\n","operationId":"Flag","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlagRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlagResponse"}}},"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":"Flag","tags":["product:chat"]}},"/moderation/flags/message":{"get":{"description":"Find and filter message flags\n","operationId":"QueryMessageFlags","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryMessageFlagsPayload","description":"JSON object with query message flags payload","title":"Payload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryMessageFlagsResponse"}}},"description":"QueryMessageFlagsResponse"},"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":"Query Message Flags","tags":["product:chat"]}},"/moderation/mute":{"post":{"description":"Mutes one or several users\n\nSends events:\n- user.unmuted\n- user.muted\n","operationId":"MuteUser","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteUserRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteUserResponse"}}},"description":"Successful 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":"Mute user","tags":["product:chat"]}},"/moderation/mute/channel":{"post":{"description":"Mutes channel for user\n\nSends events:\n- channel.muted\n- channel.muted\n","operationId":"MuteChannel","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteChannelResponse"}}},"description":"Successful 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":"Mute channel","tags":["product:chat"]}},"/moderation/unmute":{"post":{"description":"Unmutes previously muted user\n\nSends events:\n- user.unmuted\n- user.unmuted\n","operationId":"UnmuteUser","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnmuteUserRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnmuteResponse"}}},"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":"Unmute user","tags":["product:chat"]}},"/moderation/unmute/channel":{"post":{"description":"Unmutes channel for user\n\nSends events:\n- channel.unmuted\n- channel.unmuted\n","operationId":"UnmuteChannel","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnmuteChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnmuteResponse"}}},"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":"Unmute channel","tags":["product:chat"]}},"/og":{"get":{"description":"Get an OpenGraph attachment for a link\n","operationId":"GetOG","parameters":[{"in":"query","name":"url","required":true,"schema":{"description":"URL to be scraped","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOGResponse"}}},"description":"Get OG Attachment"},"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":"Get OG","tags":["product:chat"]}},"/permissions":{"get":{"description":"Lists all available permissions\n","operationId":"ListPermissions","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPermissionsResponse"}}},"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":"List permissions","tags":["product:chat"]}},"/permissions/{id}":{"get":{"description":"Gets custom permission\n","operationId":"GetPermission","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Permission ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCustomPermissionResponse"}}},"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":"Get permission","tags":["product:chat"]}},"/polls":{"post":{"description":"Creates a new poll\n","operationId":"CreatePoll","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePollRequest"}}},"description":"Create Poll Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Create poll","tags":["product:chat"]},"put":{"description":"Updates a poll\n\nSends events:\n- feeds.poll.closed\n- feeds.poll.updated\n- poll.closed\n- poll.updated\n","operationId":"UpdatePoll","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePollRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Update poll","tags":["product:chat"]}},"/polls/query":{"post":{"description":"Queries polls\n","operationId":"QueryPolls","parameters":[{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryPollsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryPollsResponse"}}},"description":"Successful 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":"Query polls","tags":["product:chat"]}},"/polls/{poll_id}":{"delete":{"description":"Deletes a poll\n\nSends events:\n- feeds.poll.deleted\n- poll.deleted\n","operationId":"DeletePoll","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete poll","tags":["product:chat"]},"get":{"description":"Retrieves a poll\n","operationId":"GetPoll","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Get poll","tags":["product:chat"]},"patch":{"description":"Updates a poll partially\n\nSends events:\n- feeds.poll.closed\n- feeds.poll.updated\n- poll.closed\n- poll.updated\n","operationId":"UpdatePollPartial","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePollPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Partial update poll","tags":["product:chat"]}},"/polls/{poll_id}/options":{"post":{"description":"Creates a poll option\n\nSends events:\n- feeds.poll.updated\n- poll.updated\n","operationId":"CreatePollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePollOptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollOptionResponse"}}},"description":"Successful 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":"Create poll option","tags":["product:chat"]},"put":{"description":"Updates a poll option\n\nSends events:\n- feeds.poll.updated\n- poll.updated\n","operationId":"UpdatePollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePollOptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollOptionResponse"}}},"description":"Successful 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":"Update poll option","tags":["product:chat"]}},"/polls/{poll_id}/options/{option_id}":{"delete":{"description":"Deletes a poll option\n\nSends events:\n- feeds.poll.updated\n- poll.updated\n","operationId":"DeletePollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"path","name":"option_id","required":true,"schema":{"description":"Option ID","maxLength":255,"title":"string","type":"string","x-stream-index":"003"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete poll option","tags":["product:chat"]},"get":{"description":"Retrieves a poll option\n","operationId":"GetPollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"path","name":"option_id","required":true,"schema":{"description":"Option ID","maxLength":255,"title":"string","type":"string","x-stream-index":"003"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollOptionResponse"}}},"description":"Successful 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":"Get poll option","tags":["product:chat"]}},"/polls/{poll_id}/votes":{"post":{"description":"Queries votes\n","operationId":"QueryPollVotes","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryPollVotesRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollVotesResponse"}}},"description":"Successful 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":"Query votes","tags":["product:chat"]}},"/push_preferences":{"post":{"description":"Update the push preferences for a user and or channel member. Set to all, mentions or none\n","operationId":"UpdatePushNotificationPreferences","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertPushPreferencesRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertPushPreferencesResponse"}}},"description":"Successful 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":"Push notification preferences","tags":["product:chat"]}},"/push_providers":{"get":{"description":"List details of all push providers.\n","operationId":"ListPushProviders","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPushProvidersResponse"}}},"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":"List push providers","tags":["product:chat"]},"post":{"description":"Upsert a push provider for v2 with multi bundle/package support\n","operationId":"UpsertPushProvider","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertPushProviderRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertPushProviderResponse"}}},"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":"Upsert a push provider","tags":["product:chat"]}},"/push_providers/{type}/{name}":{"delete":{"description":"Delete a push provider from v2 with multi bundle/package support. v1 isn't supported in this endpoint\n","operationId":"DeletePushProvider","parameters":[{"in":"path","name":"type","required":true,"schema":{"enum":["apn","firebase","huawei","xiaomi"],"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"name","required":true,"schema":{"maxLength":36,"minLength":1,"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete a push provider","tags":["product:chat"]}},"/push_templates":{"get":{"description":"Retrieve push notification templates for Chat.\n","operationId":"GetPushTemplates","parameters":[{"in":"query","name":"push_provider_name","schema":{"description":"Push provider name to filter templates","title":"string","type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"push_provider_type","required":true,"schema":{"description":"Push provider type (firebase, apn) to filter templates","enum":["firebase","apn"],"title":"string","type":"string","writeOnly":true,"x-stream-index":"003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPushTemplatesResponse"}}},"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":"Get push notification templates","tags":["product:chat"]},"post":{"description":"Create or update a push notification template for a specific event type and push provider\n","operationId":"UpsertPushTemplate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertPushTemplateRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertPushTemplateResponse"}}},"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":"Upsert a push notification template","tags":["product:chat"]}},"/query_banned_users":{"get":{"description":"Find and filter channel scoped or global user bans\n","operationId":"QueryBannedUsers","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryBannedUsersPayload","description":"JSON object with query user bans payload","title":"Payload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryBannedUsersResponse"}}},"description":"Successful 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":"Query Banned Users","tags":["product:chat"]}},"/rate_limits":{"get":{"description":"Get rate limits usage and quotas\n","operationId":"GetRateLimits","parameters":[{"in":"query","name":"server_side","schema":{"description":"Whether to include server-side platform limits or not","title":"Server-side","type":"boolean","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"android","schema":{"description":"Whether to include Android platform limits or not","title":"Android","type":"boolean","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"ios","schema":{"description":"Whether to include iOS platform limits or not","title":"iOS","type":"boolean","writeOnly":true,"x-stream-index":"003"}},{"in":"query","name":"web","schema":{"description":"Whether to include web platform limits or not","title":"Web","type":"boolean","writeOnly":true,"x-stream-index":"004"}},{"in":"query","name":"endpoints","schema":{"description":"Specific endpoints to show limits for, as a comma-separated list of values","title":"Endpoints","type":"string","writeOnly":true,"x-stream-index":"005"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRateLimitsResponse"}}},"description":"Get Rate Limits 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":"Get rate limits","tags":["product:chat"]}},"/reminders/query":{"post":{"description":"Queries reminders\n","operationId":"QueryReminders","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryRemindersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryRemindersResponse"}}},"description":"Successful 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":"Query reminders","tags":["product:chat"]}},"/roles":{"get":{"description":"Lists all available roles\n","operationId":"ListRoles","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListRolesResponse"}}},"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":"List roles","tags":["product:chat"]},"post":{"description":"Creates custom role\n","operationId":"CreateRole","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRoleRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRoleResponse"}}},"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":"Create role","tags":["product:chat"]}},"/roles/{name}":{"delete":{"description":"Deletes custom role\n","operationId":"DeleteRole","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Role name","title":"Name","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete role","tags":["product:chat"]}},"/search":{"get":{"description":"Search messages across channels\n","operationId":"Search","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchPayload","description":"JSON object with search payload","title":"Payload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchResponse"}}},"description":"Successful 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":"Search messages","tags":["product:chat"]}},"/segments/query":{"post":{"description":"Query segments\n","operationId":"QuerySegments","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuerySegmentsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuerySegmentsResponse"}}},"description":"Successful 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":"Query segments","tags":["product:chat"]}},"/segments/{id}":{"delete":{"description":"Delete a segment\n","operationId":"DeleteSegment","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete segment","tags":["product:chat"]},"get":{"description":"Get segment\n","operationId":"GetSegment","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetSegmentResponse"}}},"description":"Successful 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":"Get segment","tags":["product:chat"]}},"/segments/{id}/deletetargets":{"post":{"description":"Delete targets from a segment\n","operationId":"DeleteSegmentTargets","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteSegmentTargetsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete targets from a segment","tags":["product:chat"]}},"/segments/{id}/target/{target_id}":{"get":{"description":"Check whether a target exists in a segment. Returns 200 if the target exists, 404 otherwise\n","operationId":"SegmentTargetExists","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"target_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Check whether a target exists in a segment","tags":["product:chat"]}},"/segments/{id}/targets/query":{"post":{"description":"Query segment targets\n","operationId":"QuerySegmentTargets","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuerySegmentTargetsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuerySegmentTargetsResponse"}}},"description":"Successful 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":"Query segment targets","tags":["product:chat"]}},"/tasks/{id}":{"get":{"description":"Gets status of a task\n","operationId":"GetTask","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Task ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetTaskResponse"}}},"description":"Get Task 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":"Get status of a task","tags":["product:chat"]}},"/threads":{"post":{"description":"Returns the list of threads for specific user\n","operationId":"QueryThreads","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryThreadsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryThreadsResponse"}}},"description":"Successful 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":"Query Threads","tags":["product:chat"]}},"/threads/{message_id}":{"get":{"description":"Return a specific thread\n","operationId":"GetThread","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"reply_limit","schema":{"description":"Limit the number of replies returned","format":"int32","minimum":0,"title":"Reply limit","type":"integer","writeOnly":true,"x-stream-index":"004"}},{"in":"query","name":"participant_limit","schema":{"description":"Limit the number of participants returned","format":"int32","maximum":100,"minimum":0,"title":"Participant limit","type":"integer","writeOnly":true,"x-stream-index":"005"}},{"in":"query","name":"member_limit","schema":{"description":"Limit the number of members returned per thread channel","format":"int32","maximum":100,"minimum":0,"title":"Member limit","type":"integer","writeOnly":true,"x-stream-index":"006"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetThreadResponse"}}},"description":"Successful 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":"Get Thread","tags":["product:chat"]},"patch":{"description":"Updates certain fields of the thread\n\nSends events:\n- thread.updated\n- thread.updated\n","operationId":"UpdateThreadPartial","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateThreadPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateThreadPartialResponse"}}},"description":"Successful 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":"Partially update thread","tags":["product:chat"]}},"/unread":{"get":{"description":"Fetch unread counts for a single user\n","operationId":"UnreadCounts","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WrappedUnreadCountsResponse"}}},"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":"Unread counts","tags":["product:chat"]}},"/unread_batch":{"post":{"description":"Fetch unread counts in batch for multiple users in one call\n","operationId":"UnreadCountsBatch","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnreadCountsBatchRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnreadCountsBatchResponse"}}},"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":"Batch unread counts","tags":["product:chat"]}},"/uploads/file":{"delete":{"description":"Deletes previously uploaded file\n","operationId":"DeleteFileGlobal","parameters":[{"in":"query","name":"url","schema":{"description":"File URL to delete","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete file","tags":["product:chat"],"x-stream-sdk-name":"DeleteFile"},"post":{"description":"Uploads file\n","operationId":"UploadFileGlobal","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/FileUploadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileUploadResponse"}}},"description":"Successful 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":"Upload file","tags":["product:chat"],"x-stream-sdk-name":"UploadFile"}},"/uploads/image":{"delete":{"description":"Deletes previously uploaded image\n","operationId":"DeleteImageGlobal","parameters":[{"in":"query","name":"url","schema":{"description":"File URL to delete","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete image","tags":["product:chat"],"x-stream-sdk-name":"DeleteImage"},"post":{"description":"Uploads image\n","operationId":"UploadImageGlobal","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/ImageUploadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageUploadResponse"}}},"description":"Successful 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":"Upload image","tags":["product:chat"],"x-stream-sdk-name":"UploadImage"}},"/users":{"get":{"description":"Find and filter users\n","operationId":"QueryUsers","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryUsersPayload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryUsersResponse"}}},"description":"Successful 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":"Query users","tags":["product:chat"]},"patch":{"description":"Updates certain fields of the user\n\nSends events:\n- user.presence.changed\n- user.updated\n- user.presence.changed\n","operationId":"UpdateUsersPartial","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersResponse"}}},"description":"Successful 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":"Partially update user","tags":["product:chat"]},"post":{"description":"Update or create users in bulk\n\nSends events:\n- user.updated\n","operationId":"UpdateUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersResponse"}}},"description":"Successful 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":"Upsert users","tags":["product:chat"]}},"/users/block":{"get":{"description":"Get list of blocked Users\n","operationId":"GetBlockedUsers","parameters":[{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBlockedUsersResponse"}}},"description":"Successful 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":"Get list of blocked Users","tags":["product:chat"]},"post":{"description":"Block users\n","operationId":"BlockUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUsersResponse"}}},"description":"Successful 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":"Block user","tags":["product:chat"]}},"/users/deactivate":{"post":{"description":"Deactivate users in batches\n\nSends events:\n- user.deactivated\n","operationId":"DeactivateUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeactivateUsersRequest"}}},"description":"DeactivateUsersRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeactivateUsersResponse"}}},"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":"Deactivate users","tags":["product:chat"]}},"/users/delete":{"post":{"description":"Deletes users and optionally all their belongings asynchronously.\n\nSends events:\n- channel.deleted\n- user.deleted\n","operationId":"DeleteUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteUsersResponse"}}},"description":"Successful 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":"Delete Users","tags":["product:chat"]}},"/users/live_locations":{"get":{"description":"Retrieves all active live locations for a user\n","operationId":"GetUserLiveLocations","parameters":[{"in":"query","name":"user_id","schema":{"description":"User ID to get live locations for. If not provided, returns live locations for the authenticated user.","title":"string","type":"string","writeOnly":true,"x-stream-index":"001.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SharedLocationsResponse"}}},"description":"Successful 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":"Get user live locations","tags":["product:chat"]},"put":{"description":"Updates an existing live location with new coordinates or expiration time\n","operationId":"UpdateLiveLocation","parameters":[{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"005.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateLiveLocationRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SharedLocationResponse"}}},"description":"Successful 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":"Update live location","tags":["product:chat"]}},"/users/reactivate":{"post":{"description":"Reactivate users in batches\n\nSends events:\n- user.reactivated\n- user.reactivated\n","operationId":"ReactivateUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReactivateUsersRequest"}}},"description":"ReactivateUsersRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReactivateUsersResponse"}}},"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":"Reactivate users","tags":["product:chat"]}},"/users/restore":{"post":{"description":"Restore soft deleted users\n","operationId":"RestoreUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestoreUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Restore users","tags":["product:chat"]}},"/users/unblock":{"post":{"description":"Unblock users\n","operationId":"UnblockUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUsersResponse"}}},"description":"Successful 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":"Unblock user","tags":["product:chat"]}},"/users/{user_id}/deactivate":{"post":{"description":"Deactivates user with possibility to activate it back\n\nSends events:\n- user.deactivated\n","operationId":"DeactivateUser","parameters":[{"in":"path","name":"user_id","required":true,"schema":{"title":"User ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeactivateUserRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeactivateUserResponse"}}},"description":"Successful 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":"Deactivate user","tags":["product:chat"]}},"/users/{user_id}/event":{"post":{"description":"Sends a custom event to a user\n\nSends events:\n- *\n","operationId":"SendUserCustomEvent","parameters":[{"in":"path","name":"user_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendUserCustomEventRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Send user event","tags":["product:chat"]}},"/users/{user_id}/export":{"get":{"description":"Exports the user's profile, reactions and messages. Raises an error if a user has more than 10k messages or reactions\n","operationId":"ExportUser","parameters":[{"in":"path","name":"user_id","required":true,"schema":{"title":"User ID","type":"string","x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportUserResponse"}}},"description":"Successful 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":"Export user","tags":["product:chat"]}},"/users/{user_id}/reactivate":{"post":{"description":"Activates user who's been deactivated previously\n\nSends events:\n- user.reactivated\n","operationId":"ReactivateUser","parameters":[{"in":"path","name":"user_id","required":true,"schema":{"title":"User ID","type":"string","x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReactivateUserRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReactivateUserResponse"}}},"description":"Successful 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":"Reactivate user","tags":["product:chat"]}}},"security":[{"JWT":[],"api_key":[],"stream-auth-type":[]},{"api_key":[],"stream-auth-type":[]}],"servers":[{"description":"Stream API","url":"https://chat.stream-io-api.com"}]} \ No newline at end of file diff --git a/openapi/chat-openapi.yaml b/openapi/chat-openapi.yaml index 9808e3dbc..98b556593 100644 --- a/openapi/chat-openapi.yaml +++ b/openapi/chat-openapi.yaml @@ -338,6 +338,9 @@ components: moderation_enabled: type: boolean x-stream-index: "041" + moderation_llm_configurability_enabled: + type: boolean + x-stream-index: "049" moderation_multitenant_blocklist_enabled: type: boolean x-stream-index: "042" @@ -459,6 +462,7 @@ components: - use_hook_v2 - user_response_time_enabled - moderation_bulk_submit_action_enabled + - moderation_llm_configurability_enabled type: object AsyncBulkImageModerationEvent: nullable: true @@ -584,7 +588,7 @@ components: type: string x-stream-index: "002.001" type: - default: export.channels.error + default: export.users.error type: string x-stream-index: "003.002" required: @@ -1577,6 +1581,14 @@ components: $ref: '#/components/schemas/ChannelMember' type: array x-stream-index: "020" + message_count: + format: int64 + type: integer + x-stream-index: "035" + message_count_updated_at: + format: date-time + type: string + x-stream-index: "036" team: type: string x-stream-index: "028" @@ -1607,39 +1619,39 @@ components: items: type: string type: array - x-stream-index: "001.026" + x-stream-index: "001.027" automod: enum: - disabled - simple - AI type: string - x-stream-index: "001.021" + x-stream-index: "001.022" automod_behavior: enum: - flag - block - shadow_block type: string - x-stream-index: "001.022" + x-stream-index: "001.023" automod_thresholds: $ref: '#/components/schemas/Thresholds' - x-stream-index: "001.027" + x-stream-index: "001.028" blocklist: type: string - x-stream-index: "001.023" + x-stream-index: "001.024" blocklist_behavior: enum: - flag - block - shadow_block type: string - x-stream-index: "001.024" + x-stream-index: "001.025" blocklists: items: $ref: '#/components/schemas/BlockListOptions' type: array - x-stream-index: "001.025" + x-stream-index: "001.026" commands: items: type: string @@ -1648,6 +1660,9 @@ components: connect_events: type: boolean x-stream-index: "001.004" + count_messages: + type: boolean + x-stream-index: "001.019" created_at: format: date-time type: string @@ -1662,7 +1677,7 @@ components: format: int32 maximum: 20000 type: integer - x-stream-index: "001.020" + x-stream-index: "001.021" mutes: type: boolean x-stream-index: "001.009" @@ -1672,10 +1687,10 @@ components: partition_size: format: int32 type: integer - x-stream-index: "001.028" + x-stream-index: "001.029" partition_ttl: type: integer - x-stream-index: "001.029" + x-stream-index: "001.030" polls: type: boolean x-stream-index: "001.016" @@ -1705,7 +1720,7 @@ components: x-stream-index: "001.018" skip_last_msg_update_for_system_msgs: type: boolean - x-stream-index: "001.030" + x-stream-index: "001.031" typing_events: type: boolean x-stream-index: "001.002" @@ -1741,6 +1756,7 @@ components: - polls - user_message_reminders - shared_locations + - count_messages - message_retention - max_message_length - automod @@ -1756,39 +1772,39 @@ components: items: type: string type: array - x-stream-index: 001.002.026 + x-stream-index: 001.002.027 automod: enum: - disabled - simple - AI type: string - x-stream-index: 001.002.021 + x-stream-index: 001.002.022 automod_behavior: enum: - flag - block - shadow_block type: string - x-stream-index: 001.002.022 + x-stream-index: 001.002.023 automod_thresholds: $ref: '#/components/schemas/Thresholds' - x-stream-index: 001.002.027 + x-stream-index: 001.002.028 blocklist: type: string - x-stream-index: 001.002.023 + x-stream-index: 001.002.024 blocklist_behavior: enum: - flag - block - shadow_block type: string - x-stream-index: 001.002.024 + x-stream-index: 001.002.025 blocklists: items: $ref: '#/components/schemas/BlockListOptions' type: array - x-stream-index: 001.002.025 + x-stream-index: 001.002.026 commands: items: $ref: '#/components/schemas/Command' @@ -1797,6 +1813,9 @@ components: connect_events: type: boolean x-stream-index: 001.002.004 + count_messages: + type: boolean + x-stream-index: 001.002.019 created_at: format: date-time type: string @@ -1818,7 +1837,7 @@ components: format: int32 maximum: 20000 type: integer - x-stream-index: 001.002.020 + x-stream-index: 001.002.021 mutes: type: boolean x-stream-index: 001.002.009 @@ -1828,13 +1847,13 @@ components: partition_size: format: int32 type: integer - x-stream-index: 001.002.028 + x-stream-index: 001.002.029 partition_ttl: example: 24h format: duration nullable: true type: string - x-stream-index: 001.002.029 + x-stream-index: 001.002.030 polls: type: boolean x-stream-index: 001.002.016 @@ -1864,7 +1883,7 @@ components: x-stream-index: 001.002.018 skip_last_msg_update_for_system_msgs: type: boolean - x-stream-index: 001.002.030 + x-stream-index: 001.002.031 typing_events: type: boolean x-stream-index: 001.002.002 @@ -1902,6 +1921,7 @@ components: - polls - user_message_reminders - shared_locations + - count_messages - message_retention - max_message_length - automod @@ -2197,6 +2217,11 @@ components: format: date-time type: string x-stream-index: "011" + deleted_messages: + items: + type: string + type: array + x-stream-index: "020" invite_accepted_at: description: Date when invite was accepted format: date-time @@ -2595,6 +2620,12 @@ components: title: ChannelMembers type: array x-stream-index: "011" + message_count: + description: Number of messages in the channel + format: int64 + title: Message count + type: integer + x-stream-index: "027" mute_expires_at: description: Date of mute expiration format: date-time @@ -2661,6 +2692,11 @@ components: channel: $ref: '#/components/schemas/ChannelResponse' x-stream-index: "001.001" + deleted_messages: + items: + type: string + type: array + x-stream-index: "001.016" draft: $ref: '#/components/schemas/DraftResponse' x-stream-index: "001.014" @@ -2738,6 +2774,11 @@ components: channel: $ref: '#/components/schemas/ChannelResponse' x-stream-index: "001" + deleted_messages: + items: + type: string + type: array + x-stream-index: "016" draft: $ref: '#/components/schemas/DraftResponse' x-stream-index: "014" @@ -2866,39 +2907,39 @@ components: items: type: string type: array - x-stream-index: 003.002.026 + x-stream-index: 003.002.027 automod: enum: - disabled - simple - AI type: string - x-stream-index: 003.002.021 + x-stream-index: 003.002.022 automod_behavior: enum: - flag - block - shadow_block type: string - x-stream-index: 003.002.022 + x-stream-index: 003.002.023 automod_thresholds: $ref: '#/components/schemas/Thresholds' - x-stream-index: 003.002.027 + x-stream-index: 003.002.028 blocklist: type: string - x-stream-index: 003.002.023 + x-stream-index: 003.002.024 blocklist_behavior: enum: - flag - block - shadow_block type: string - x-stream-index: 003.002.024 + x-stream-index: 003.002.025 blocklists: items: $ref: '#/components/schemas/BlockListOptions' type: array - x-stream-index: 003.002.025 + x-stream-index: 003.002.026 commands: items: $ref: '#/components/schemas/Command' @@ -2907,6 +2948,9 @@ components: connect_events: type: boolean x-stream-index: 003.002.004 + count_messages: + type: boolean + x-stream-index: 003.002.019 created_at: format: date-time type: string @@ -2928,7 +2972,7 @@ components: format: int32 maximum: 20000 type: integer - x-stream-index: 003.002.020 + x-stream-index: 003.002.021 mutes: type: boolean x-stream-index: 003.002.009 @@ -2938,13 +2982,13 @@ components: partition_size: format: int32 type: integer - x-stream-index: 003.002.028 + x-stream-index: 003.002.029 partition_ttl: example: 24h format: duration nullable: true type: string - x-stream-index: 003.002.029 + x-stream-index: 003.002.030 permissions: items: $ref: '#/components/schemas/PolicyRequest' @@ -2979,7 +3023,7 @@ components: x-stream-index: 003.002.018 skip_last_msg_update_for_system_msgs: type: boolean - x-stream-index: 003.002.030 + x-stream-index: 003.002.031 typing_events: type: boolean x-stream-index: 003.002.002 @@ -3019,6 +3063,7 @@ components: - polls - user_message_reminders - shared_locations + - count_messages - message_retention - max_message_length - automod @@ -3450,6 +3495,9 @@ components: type: string type: array x-stream-index: "011" + count_messages: + type: boolean + x-stream-index: "014" grants: additionalProperties: items: @@ -3732,39 +3780,39 @@ components: items: type: string type: array - x-stream-index: 001.001.026 + x-stream-index: 001.001.027 automod: enum: - disabled - simple - AI type: string - x-stream-index: 001.001.021 + x-stream-index: 001.001.022 automod_behavior: enum: - flag - block - shadow_block type: string - x-stream-index: 001.001.022 + x-stream-index: 001.001.023 automod_thresholds: $ref: '#/components/schemas/Thresholds' - x-stream-index: 001.001.027 + x-stream-index: 001.001.028 blocklist: type: string - x-stream-index: 001.001.023 + x-stream-index: 001.001.024 blocklist_behavior: enum: - flag - block - shadow_block type: string - x-stream-index: 001.001.024 + x-stream-index: 001.001.025 blocklists: items: $ref: '#/components/schemas/BlockListOptions' type: array - x-stream-index: 001.001.025 + x-stream-index: 001.001.026 commands: items: type: string @@ -3773,6 +3821,9 @@ components: connect_events: type: boolean x-stream-index: 001.001.004 + count_messages: + type: boolean + x-stream-index: 001.001.019 created_at: format: date-time type: string @@ -3797,7 +3848,7 @@ components: format: int32 maximum: 20000 type: integer - x-stream-index: 001.001.020 + x-stream-index: 001.001.021 mutes: type: boolean x-stream-index: 001.001.009 @@ -3807,13 +3858,13 @@ components: partition_size: format: int32 type: integer - x-stream-index: 001.001.028 + x-stream-index: 001.001.029 partition_ttl: example: 24h format: duration nullable: true type: string - x-stream-index: 001.001.029 + x-stream-index: 001.001.030 permissions: items: $ref: '#/components/schemas/PolicyRequest' @@ -3848,7 +3899,7 @@ components: x-stream-index: 001.001.018 skip_last_msg_update_for_system_msgs: type: boolean - x-stream-index: 001.001.030 + x-stream-index: 001.001.031 typing_events: type: boolean x-stream-index: 001.001.002 @@ -3884,6 +3935,7 @@ components: - polls - user_message_reminders - shared_locations + - count_messages - message_retention - max_message_length - automod @@ -4841,11 +4893,11 @@ components: properties: callback: $ref: '#/components/schemas/AsyncModerationCallbackConfig' - x-stream-index: 018.001.002 + x-stream-index: 019.001.002 created_at: format: date-time type: string - x-stream-index: "019" + x-stream-index: "020" enabled: type: boolean x-stream-index: "003" @@ -4860,6 +4912,9 @@ components: id: type: string x-stream-index: "001" + product: + type: string + x-stream-index: "018" sns_auth_type: type: string x-stream-index: "014" @@ -4899,11 +4954,11 @@ components: timeout_ms: format: int32 type: integer - x-stream-index: 018.001.001 + x-stream-index: 019.001.001 updated_at: format: date-time type: string - x-stream-index: "020" + x-stream-index: "021" webhook_url: type: string x-stream-index: "005" @@ -5108,6 +5163,48 @@ components: type: object x-stream-index: "001" type: object + FeedsEventPreferences: + properties: + comments: + type: string + x-stream-index: "002" + mentions: + type: string + x-stream-index: "004" + new_followers: + type: string + x-stream-index: "003" + reactions: + type: string + x-stream-index: "001" + type: object + FeedsEventPreferencesInput: + properties: + comments: + enum: + - all + - none + type: string + x-stream-index: "002" + mentions: + enum: + - all + - none + type: string + x-stream-index: "004" + new_followers: + enum: + - all + - none + type: string + x-stream-index: "003" + reactions: + enum: + - all + - none + type: string + x-stream-index: "001" + type: object Field: nullable: true properties: @@ -5720,39 +5817,39 @@ components: items: type: string type: array - x-stream-index: 003.002.026 + x-stream-index: 003.002.027 automod: enum: - disabled - simple - AI type: string - x-stream-index: 003.002.021 + x-stream-index: 003.002.022 automod_behavior: enum: - flag - block - shadow_block type: string - x-stream-index: 003.002.022 + x-stream-index: 003.002.023 automod_thresholds: $ref: '#/components/schemas/Thresholds' - x-stream-index: 003.002.027 + x-stream-index: 003.002.028 blocklist: type: string - x-stream-index: 003.002.023 + x-stream-index: 003.002.024 blocklist_behavior: enum: - flag - block - shadow_block type: string - x-stream-index: 003.002.024 + x-stream-index: 003.002.025 blocklists: items: $ref: '#/components/schemas/BlockListOptions' type: array - x-stream-index: 003.002.025 + x-stream-index: 003.002.026 commands: items: $ref: '#/components/schemas/Command' @@ -5761,6 +5858,9 @@ components: connect_events: type: boolean x-stream-index: 003.002.004 + count_messages: + type: boolean + x-stream-index: 003.002.019 created_at: format: date-time type: string @@ -5787,7 +5887,7 @@ components: format: int32 maximum: 20000 type: integer - x-stream-index: 003.002.020 + x-stream-index: 003.002.021 mutes: type: boolean x-stream-index: 003.002.009 @@ -5797,13 +5897,13 @@ components: partition_size: format: int32 type: integer - x-stream-index: 003.002.028 + x-stream-index: 003.002.029 partition_ttl: example: 24h format: duration nullable: true type: string - x-stream-index: 003.002.029 + x-stream-index: 003.002.030 permissions: items: $ref: '#/components/schemas/PolicyRequest' @@ -5838,7 +5938,7 @@ components: x-stream-index: 003.002.018 skip_last_msg_update_for_system_msgs: type: boolean - x-stream-index: 003.002.030 + x-stream-index: 003.002.031 typing_events: type: boolean x-stream-index: 003.002.002 @@ -5878,6 +5978,7 @@ components: - polls - user_message_reminders - shared_locations + - count_messages - message_retention - max_message_length - automod @@ -7178,6 +7279,9 @@ components: format: date-time type: string x-stream-index: "033" + deleted_for_me: + type: boolean + x-stream-index: "059" deleted_reply_count: format: int32 type: integer @@ -7399,17 +7503,20 @@ components: properties: channel_id: type: string - x-stream-index: "003.002" + x-stream-index: "004.002" channel_type: type: string - x-stream-index: "003.003" + x-stream-index: "004.003" cid: type: string - x-stream-index: "003.001" + x-stream-index: "004.001" created_at: format: date-time type: string - x-stream-index: "006.002" + x-stream-index: "007.002" + deleted_for_me: + type: boolean + x-stream-index: "003" hard_delete: type: boolean x-stream-index: "002.001" @@ -7418,7 +7525,7 @@ components: x-stream-index: "001.001" team: type: string - x-stream-index: "005.001" + x-stream-index: "006.001" thread_participants: items: $ref: '#/components/schemas/User' @@ -7427,10 +7534,10 @@ components: type: default: message.deleted type: string - x-stream-index: "006.001" + x-stream-index: "007.001" user: $ref: '#/components/schemas/User' - x-stream-index: "004.001" + x-stream-index: "005.001" required: - hard_delete - cid @@ -7907,6 +8014,9 @@ components: title: Deleted at type: string x-stream-index: "025" + deleted_for_me: + type: boolean + x-stream-index: "044" deleted_reply_count: format: int32 type: integer @@ -8330,6 +8440,9 @@ components: title: Deleted at type: string x-stream-index: "001.025" + deleted_for_me: + type: boolean + x-stream-index: "001.044" deleted_reply_count: format: int32 type: integer @@ -9949,11 +10062,25 @@ components: description: Disable push notifications till a certain time format: date-time type: string + x-stream-index: "007" + feeds_events: + $ref: '#/components/schemas/FeedsEventPreferencesInput' + description: Set granular feeds event preferences for reactions, comments, + new followers, and mentions + x-stream-index: "006" + feeds_level: + description: Set the level of feeds push notifications for the user. One + of all, none, default + enum: + - all + - none + - default + type: string x-stream-index: "005" remove_disable: description: Remove the disabled until time. (IE stop snoozing notifications) type: boolean - x-stream-index: "006" + x-stream-index: "008" user_id: description: The user id for which to set the push preferences. Required when using server side auths, defaults to current user with client side @@ -9971,6 +10098,12 @@ components: x-stream-index: "001" disabled_until: format: date-time + type: string + x-stream-index: "005" + feeds_events: + $ref: '#/components/schemas/FeedsEventPreferences' + x-stream-index: "004" + feeds_level: type: string x-stream-index: "003" type: object @@ -10183,6 +10316,12 @@ components: - message.updated - reaction.new - notification.reminder_due + - feeds.activity.added + - feeds.comment.added + - feeds.activity.reaction.added + - feeds.comment.reaction.added + - feeds.follow.created + - feeds.notification_feed.updated type: string x-stream-index: "005" template: @@ -12109,6 +12248,9 @@ components: format: date-time type: string x-stream-index: "001.025" + deleted_for_me: + type: boolean + x-stream-index: "001.044" deleted_reply_count: format: int32 type: integer @@ -13710,6 +13852,10 @@ components: image_upload_config: $ref: '#/components/schemas/FileUploadConfig' x-stream-index: "001.029" + max_aggregated_activities_length: + format: int32 + type: integer + x-stream-index: "001.049" migrate_permissions_to_v2: type: boolean x-stream-index: "001.035" @@ -13997,39 +14143,39 @@ components: items: type: string type: array - x-stream-index: 009.001.026 + x-stream-index: 009.001.027 automod: enum: - disabled - simple - AI type: string - x-stream-index: 009.001.021 + x-stream-index: 009.001.022 automod_behavior: enum: - flag - block - shadow_block type: string - x-stream-index: 009.001.022 + x-stream-index: 009.001.023 automod_thresholds: $ref: '#/components/schemas/Thresholds' - x-stream-index: 009.001.027 + x-stream-index: 009.001.028 blocklist: type: string - x-stream-index: 009.001.023 + x-stream-index: 009.001.024 blocklist_behavior: enum: - flag - block - shadow_block type: string - x-stream-index: 009.001.024 + x-stream-index: 009.001.025 blocklists: items: $ref: '#/components/schemas/BlockListOptions' type: array - x-stream-index: 009.001.025 + x-stream-index: 009.001.026 commands: description: List of commands that channel supports items: @@ -14040,6 +14186,9 @@ components: connect_events: type: boolean x-stream-index: 009.001.004 + count_messages: + type: boolean + x-stream-index: 009.001.019 custom_events: type: boolean x-stream-index: 009.001.012 @@ -14057,7 +14206,7 @@ components: format: int32 maximum: 20000 type: integer - x-stream-index: 009.001.020 + x-stream-index: 009.001.021 mutes: type: boolean x-stream-index: 009.001.009 @@ -14106,7 +14255,7 @@ components: x-stream-index: 009.001.018 skip_last_msg_update_for_system_msgs: type: boolean - x-stream-index: 009.001.030 + x-stream-index: 009.001.031 typing_events: type: boolean x-stream-index: 009.001.002 @@ -14131,39 +14280,39 @@ components: items: type: string type: array - x-stream-index: 003.001.026 + x-stream-index: 003.001.027 automod: enum: - disabled - simple - AI type: string - x-stream-index: 003.001.021 + x-stream-index: 003.001.022 automod_behavior: enum: - flag - block - shadow_block type: string - x-stream-index: 003.001.022 + x-stream-index: 003.001.023 automod_thresholds: $ref: '#/components/schemas/Thresholds' - x-stream-index: 003.001.027 + x-stream-index: 003.001.028 blocklist: type: string - x-stream-index: 003.001.023 + x-stream-index: 003.001.024 blocklist_behavior: enum: - flag - block - shadow_block type: string - x-stream-index: 003.001.024 + x-stream-index: 003.001.025 blocklists: items: $ref: '#/components/schemas/BlockListOptions' type: array - x-stream-index: 003.001.025 + x-stream-index: 003.001.026 commands: items: type: string @@ -14172,6 +14321,9 @@ components: connect_events: type: boolean x-stream-index: 003.001.004 + count_messages: + type: boolean + x-stream-index: 003.001.019 created_at: format: date-time type: string @@ -14196,7 +14348,7 @@ components: format: int32 maximum: 20000 type: integer - x-stream-index: 003.001.020 + x-stream-index: 003.001.021 mutes: type: boolean x-stream-index: 003.001.009 @@ -14206,13 +14358,13 @@ components: partition_size: format: int32 type: integer - x-stream-index: 003.001.028 + x-stream-index: 003.001.029 partition_ttl: example: 24h format: duration nullable: true type: string - x-stream-index: 003.001.029 + x-stream-index: 003.001.030 permissions: items: $ref: '#/components/schemas/PolicyRequest' @@ -14247,7 +14399,7 @@ components: x-stream-index: 003.001.018 skip_last_msg_update_for_system_msgs: type: boolean - x-stream-index: 003.001.030 + x-stream-index: 003.001.031 typing_events: type: boolean x-stream-index: 003.001.002 @@ -14285,6 +14437,7 @@ components: - polls - user_message_reminders - shared_locations + - count_messages - message_retention - max_message_length - automod @@ -14928,6 +15081,12 @@ components: - message.updated - reaction.new - notification.reminder_due + - feeds.activity.added + - feeds.comment.added + - feeds.activity.reaction.added + - feeds.comment.reaction.added + - feeds.follow.created + - feeds.notification_feed.updated title: string type: string x-stream-index: "003" @@ -15212,6 +15371,84 @@ components: x-stream-event-doc-group: other x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent + UserMessagesDeletedEvent: + description: This event is sent when a user's message get deleted. The event + contains information about the user whose messages got deleted. + nullable: true + properties: + channel_custom: + additionalProperties: {} + type: object + x-stream-index: 001.001.005 + channel_id: + description: The ID of the channel where the target user's messages were + deleted + title: Channel ID + type: string + x-stream-index: 001.002.002 + channel_member_count: + format: int32 + type: integer + x-stream-index: 001.001.004 + channel_type: + description: The type of the channel where the target user's messages were + deleted + title: Channel Type + type: string + x-stream-index: 001.002.001 + cid: + description: The CID of the channel where the target user's messages were + deleted + 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 + hard_delete: + description: Whether Messages were hard deleted + title: Hard Delete + type: boolean + x-stream-index: "003" + received_at: + format: date-time + type: string + x-stream-index: 001.001.001.001.004 + team: + description: The team of the channel where the target user's messages were + deleted + title: Team + type: string + x-stream-index: 001.001.003 + type: + default: user.messages.deleted + description: 'The type of event: "user.messages.deleted" in this case' + title: Event Type + type: string + x-stream-index: 001.001.001.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The target user whose messages got deleted + title: User + x-stream-index: "002.001" + required: + - type + - created_at + - custom + - user + title: UserMessagesDeletedEvent + 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 UserMute: nullable: true properties: @@ -16022,6 +16259,7 @@ components: user.deactivated: '#/components/schemas/UserDeactivatedEvent' user.deleted: '#/components/schemas/UserDeletedEvent' user.flagged: '#/components/schemas/UserFlaggedEvent' + user.messages.deleted: '#/components/schemas/UserMessagesDeletedEvent' user.muted: '#/components/schemas/UserMutedEvent' user.reactivated: '#/components/schemas/UserReactivatedEvent' user.unbanned: '#/components/schemas/UserUnbannedEvent' @@ -16078,6 +16316,7 @@ components: - $ref: '#/components/schemas/UserDeactivatedEvent' - $ref: '#/components/schemas/UserDeletedEvent' - $ref: '#/components/schemas/UserFlaggedEvent' + - $ref: '#/components/schemas/UserMessagesDeletedEvent' - $ref: '#/components/schemas/UserMutedEvent' - $ref: '#/components/schemas/UserReactivatedEvent' - $ref: '#/components/schemas/UserUnbannedEvent' @@ -16199,7 +16438,7 @@ components: type: apiKey info: title: Stream API - version: v187.13.0 + version: v191.1.0 openapi: 3.0.3 paths: /app: @@ -18873,6 +19112,14 @@ paths: type: string writeOnly: true x-stream-index: "003" + - in: query + name: delete_for_me + schema: + description: Delete the message only for the user making the request + title: Delete for me + type: boolean + writeOnly: true + x-stream-index: "004" responses: "200": content: @@ -19898,6 +20145,7 @@ paths: Sends events: - user.banned + - user.messages.deleted - user.banned operationId: Ban requestBody: diff --git a/openapi/clientside-api.json b/openapi/clientside-api.json index 9745beb4a..cf395ea2a 100644 --- a/openapi/clientside-api.json +++ b/openapi/clientside-api.json @@ -1 +1 @@ -{"components":{"schemas":{"AIImageConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"ocr_rules":{"items":{"$ref":"#/components/schemas/OCRRule"},"type":"array","x-stream-index":"004"},"rules":{"items":{"$ref":"#/components/schemas/AWSRekognitionRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules","ocr_rules"],"type":"object"},"AIIndicatorClearEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"ai_indicator.clear","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"AIIndicatorClearEvent","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"},"AIIndicatorStopEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"ai_indicator.stop","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"AIIndicatorStopEvent","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"},"AIIndicatorUpdateEvent":{"properties":{"ai_message":{"type":"string","x-stream-index":"005"},"ai_state":{"type":"string","x-stream-index":"004"},"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"message_id":{"type":"string","x-stream-index":"003"},"type":{"default":"ai_indicator.update","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","cid","channel_id","channel_type","message_id","ai_state"],"title":"AIIndicatorUpdateEvent","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"},"AITextConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"profile":{"type":"string","x-stream-index":"003"},"rules":{"items":{"$ref":"#/components/schemas/BodyguardRule"},"type":"array","x-stream-index":"004"},"severity_rules":{"items":{"$ref":"#/components/schemas/BodyguardSeverityRule"},"type":"array","x-stream-index":"005"}},"required":["enabled","profile","rules","severity_rules"],"type":"object"},"AIVideoConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AWSRekognitionRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"APIError":{"properties":{"StatusCode":{"description":"Response HTTP status code","format":"int32","title":"Status code","type":"integer","x-stream-index":"004"},"code":{"description":"API error code","format":"int32","title":"Code","type":"integer","x-stream-index":"001"},"details":{"description":"Additional error-specific information","items":{"type":"integer"},"title":"Details","type":"array","x-stream-index":"007"},"duration":{"description":"Request duration","title":"Duration","type":"string","x-stream-index":"005"},"exception_fields":{"additionalProperties":{"type":"string"},"description":"Additional error info","title":"Exception fields","type":"object","x-stream-index":"003"},"message":{"description":"Message describing an error","title":"Message","type":"string","x-stream-index":"002"},"more_info":{"description":"URL with additional information","title":"More info","type":"string","x-stream-index":"006"},"unrecoverable":{"description":"Flag that indicates if the error is unrecoverable, requests that return unrecoverable errors should not be retried, this error only applies to the request that caused it","title":"Unrecoverable","type":"boolean","x-stream-index":"008"}},"required":["code","message","StatusCode","duration","more_info","details"],"title":"Error response","type":"object"},"APNS":{"properties":{"body":{"type":"string","x-stream-index":"002"},"content-available":{"format":"int32","type":"integer","x-stream-index":"004"},"data":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"mutable-content":{"format":"int32","type":"integer","x-stream-index":"005"},"sound":{"type":"string","x-stream-index":"003"},"title":{"type":"string","x-stream-index":"001"}},"required":["title","body"],"type":"object"},"AWSRekognitionRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"},"min_confidence":{"format":"float","maximum":100,"minimum":0,"type":"number","x-stream-index":"003"}},"required":["label","action","min_confidence"],"type":"object"},"AcceptCallRequest":{"description":"AcceptCallRequest is the payload for accepting a call.","nullable":true,"title":"AcceptCallRequest","type":"object"},"AcceptCallResponse":{"description":"AcceptCallResponse is the payload for accepting a call.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"AcceptCallResponse","type":"object"},"Action":{"nullable":true,"properties":{"name":{"type":"string","x-stream-index":"001"},"style":{"type":"string","x-stream-index":"003"},"text":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"004"},"value":{"type":"string","x-stream-index":"005"}},"required":["name","text","type"],"type":"object"},"ActionLog":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"002"},"reason":{"type":"string","x-stream-index":"008"},"reporter_type":{"type":"string","x-stream-index":"009"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"014"},"review_queue_item_id":{"type":"string","x-stream-index":"012"},"target_user":{"$ref":"#/components/schemas/User","x-stream-index":"013"},"target_user_id":{"type":"string","x-stream-index":"011"},"type":{"type":"string","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007"}},"required":["id","created_at","type","reason","reporter_type","custom","target_user_id","review_queue_item_id"],"type":"object"},"ActionLogResponse":{"nullable":true,"properties":{"created_at":{"description":"Timestamp when the action was taken","format":"date-time","title":"Created At","type":"number","x-stream-index":"002"},"custom":{"additionalProperties":{},"description":"Additional metadata about the action","title":"Custom","type":"object","x-stream-index":"007"},"id":{"description":"Unique identifier of the action log","title":"ID","type":"string","x-stream-index":"001"},"reason":{"description":"Reason for the moderation action","title":"Reason","type":"string","x-stream-index":"006"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"Associated review queue item","title":"Review Queue Item","x-stream-index":"008"},"target_user":{"$ref":"#/components/schemas/UserResponse","description":"User who was the target of the action","title":"Target User","x-stream-index":"009"},"target_user_id":{"description":"ID of the user who was the target of the action","title":"Target User ID","type":"string","x-stream-index":"010"},"type":{"description":"Type of moderation action","title":"Type","type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who performed the action","title":"User","x-stream-index":"004"},"user_id":{"description":"ID of the user who performed the action","title":"User ID","type":"string","x-stream-index":"005"}},"required":["id","created_at","type","user_id","reason","custom","target_user_id"],"type":"object"},"ActionSequence":{"properties":{"action":{"type":"string","x-stream-index":"001"},"blur":{"type":"boolean","x-stream-index":"005"},"cooldown_period":{"format":"int32","type":"integer","x-stream-index":"004"},"threshold":{"format":"int32","type":"integer","x-stream-index":"002"},"time_window":{"format":"int32","type":"integer","x-stream-index":"003"},"warning":{"type":"boolean","x-stream-index":"006"},"warning_text":{"type":"string","x-stream-index":"007"}},"required":["action","threshold","time_window","cooldown_period","blur","warning","warning_text"],"type":"object"},"ActivityMarkedEvent":{"properties":{"all_read":{"type":"boolean","x-stream-index":"006"},"all_seen":{"type":"boolean","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"feed_id":{"type":"string","x-stream-index":"003"},"marked_read":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"marked_watched":{"items":{"type":"string"},"type":"array","x-stream-index":"005"},"type":{"default":"activity.marked","type":"string","x-stream-index":"001.001"},"user_id":{"type":"string","x-stream-index":"002"}},"required":["type","created_at","user_id","feed_id","all_read","all_seen"],"title":"ActivityMarkedEvent","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"},"AnyEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"*","type":"string","x-stream-index":"001.001"}},"required":["type","created_at"],"title":"AnyEvent","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"},"AppEventResponse":{"properties":{"async_url_enrich_enabled":{"description":"boolean","title":"Async URL Enrichment Enabled","type":"boolean","x-stream-index":"002"},"auto_translation_enabled":{"description":"boolean","title":"Auto Translation Enabled","type":"boolean","x-stream-index":"003"},"file_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","description":"file upload config","title":"File Upload Config","x-stream-index":"004"},"image_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","description":"file upload config","title":"Image Upload Config","x-stream-index":"005"},"name":{"description":"string","title":"App name","type":"string","x-stream-index":"001"}},"required":["name","auto_translation_enabled"],"type":"object"},"AppResponseFields":{"properties":{"async_url_enrich_enabled":{"type":"boolean","x-stream-index":"017"},"auto_translation_enabled":{"type":"boolean","x-stream-index":"020"},"file_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","x-stream-index":"030"},"image_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","x-stream-index":"031"},"name":{"type":"string","x-stream-index":"001"}},"required":["name","organization","push_notifications","webhook_url","moderation_webhook_url","channel_configs","call_types","policies","suspended","suspended_explanation","disable_auth_checks","disable_permissions_checks","permission_version","user_search_disallowed_roles","multi_tenant_enabled","image_moderation_enabled","async_url_enrich_enabled","auto_translation_enabled","custom_action_handler_url","enforce_unique_usernames","sqs_url","sqs_key","sqs_secret","sns_topic_arn","sns_key","sns_secret","file_upload_config","image_upload_config","grants","campaign_enabled","webhook_events","reminders_interval","cdn_expiration_seconds","video_provider","moderation_enabled","moderation_multitenant_blocklist_enabled","guest_user_creation_disabled","event_hooks","use_hook_v2","user_response_time_enabled","moderation_bulk_submit_action_enabled"],"type":"object"},"AppUpdatedEvent":{"description":"Emitted when app settings are updated","nullable":true,"properties":{"app":{"$ref":"#/components/schemas/AppEventResponse","description":"application configuration","title":"App settings","x-stream-index":"002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"type":{"default":"app.updated","description":"The type of event: \"app.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.002"}},"required":["type","created_at","custom","app"],"title":"AppUpdatedEvent","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"},"Attachment":{"description":"An attachment is a message object that represents a file uploaded by a user.","nullable":true,"properties":{"actions":{"items":{"$ref":"#/components/schemas/Action"},"type":"array","x-stream-index":"015"},"asset_url":{"type":"string","x-stream-index":"017"},"author_icon":{"type":"string","x-stream-index":"007"},"author_link":{"type":"string","x-stream-index":"006"},"author_name":{"type":"string","x-stream-index":"005"},"color":{"type":"string","x-stream-index":"003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"018"},"fallback":{"type":"string","x-stream-index":"002"},"fields":{"items":{"$ref":"#/components/schemas/Field"},"type":"array","x-stream-index":"016"},"footer":{"type":"string","x-stream-index":"013"},"footer_icon":{"type":"string","x-stream-index":"014"},"giphy":{"$ref":"#/components/schemas/Images","x-stream-index":"019"},"image_url":{"type":"string","x-stream-index":"011"},"og_scrape_url":{"type":"string","x-stream-index":"020"},"original_height":{"format":"int32","type":"integer","x-stream-index":"022"},"original_width":{"format":"int32","type":"integer","x-stream-index":"021"},"pretext":{"type":"string","x-stream-index":"004"},"text":{"type":"string","x-stream-index":"010"},"thumb_url":{"type":"string","x-stream-index":"012"},"title":{"type":"string","x-stream-index":"008"},"title_link":{"type":"string","x-stream-index":"009"},"type":{"description":"Attachment type (e.g. image, video, url)","title":"Type","type":"string","x-stream-index":"001"}},"required":["custom"],"title":"Attachment","type":"object","x-stream-docs-page-id":"file_uploads"},"AudioSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"001"},"default_device":{"enum":["speaker","earpiece"],"type":"string","x-stream-index":"006"},"mic_default_on":{"type":"boolean","x-stream-index":"004"},"noise_cancellation":{"$ref":"#/components/schemas/NoiseCancellationSettings","x-stream-index":"007"},"opus_dtx_enabled":{"type":"boolean","x-stream-index":"002"},"redundant_coding_enabled":{"type":"boolean","x-stream-index":"003"},"speaker_default_on":{"type":"boolean","x-stream-index":"005"}},"required":["access_request_enabled","opus_dtx_enabled","redundant_coding_enabled","mic_default_on","speaker_default_on","default_device"],"type":"object"},"AudioSettingsRequest":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"001"},"default_device":{"enum":["speaker","earpiece"],"type":"string","x-stream-index":"006"},"mic_default_on":{"type":"boolean","x-stream-index":"004"},"noise_cancellation":{"$ref":"#/components/schemas/NoiseCancellationSettings","x-stream-index":"007"},"opus_dtx_enabled":{"type":"boolean","x-stream-index":"002"},"redundant_coding_enabled":{"type":"boolean","x-stream-index":"003"},"speaker_default_on":{"type":"boolean","x-stream-index":"005"}},"required":["default_device"],"type":"object"},"AudioSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"001"},"default_device":{"enum":["speaker","earpiece"],"type":"string","x-stream-index":"006"},"mic_default_on":{"type":"boolean","x-stream-index":"004"},"noise_cancellation":{"$ref":"#/components/schemas/NoiseCancellationSettings","x-stream-index":"007"},"opus_dtx_enabled":{"type":"boolean","x-stream-index":"002"},"redundant_coding_enabled":{"type":"boolean","x-stream-index":"003"},"speaker_default_on":{"type":"boolean","x-stream-index":"005"}},"required":["access_request_enabled","opus_dtx_enabled","redundant_coding_enabled","mic_default_on","speaker_default_on","default_device"],"type":"object"},"AutomodDetails":{"properties":{"action":{"type":"string","x-stream-index":"001"},"image_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"005"},"message_details":{"$ref":"#/components/schemas/FlagMessageDetails","x-stream-index":"004"},"original_message_type":{"type":"string","x-stream-index":"002"},"result":{"$ref":"#/components/schemas/MessageModerationResult","x-stream-index":"003"}},"type":"object"},"AutomodPlatformCircumventionConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AutomodRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"AutomodRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"003"},"label":{"type":"string","x-stream-index":"001"},"threshold":{"format":"float","maximum":1,"minimum":0,"type":"number","x-stream-index":"002"}},"required":["label","threshold","action"],"type":"object"},"AutomodSemanticFiltersConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AutomodSemanticFiltersRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"AutomodSemanticFiltersRule":{"properties":{"action":{"enum":["flag","shadow","remove"],"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"threshold":{"format":"float","maximum":1,"minimum":0,"type":"number","x-stream-index":"002"}},"required":["name","threshold","action"],"type":"object"},"AutomodToxicityConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AutomodRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"BackstageSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"BackstageSettingsRequest":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"002"}},"type":"object"},"BackstageSettingsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"Ban":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"012"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"011"},"expires":{"format":"date-time","type":"number","x-stream-index":"007"},"reason":{"type":"string","x-stream-index":"008"},"shadow":{"type":"boolean","x-stream-index":"009"},"target":{"$ref":"#/components/schemas/User","x-stream-index":"006"}},"required":["shadow","created_at"],"type":"object"},"BanActionRequest":{"properties":{"channel_ban_only":{"type":"boolean","x-stream-index":"003"},"delete_messages":{"enum":["soft","pruning","hard"],"type":"string","x-stream-index":"005"},"ip_ban":{"type":"boolean","x-stream-index":"004"},"reason":{"type":"string","x-stream-index":"002"},"shadow":{"type":"boolean","x-stream-index":"001"},"timeout":{"format":"int32","type":"integer","x-stream-index":"006"}},"type":"object"},"BanOptions":{"properties":{"duration":{"format":"int32","type":"integer","x-stream-index":"001"},"ip_ban":{"type":"boolean","x-stream-index":"004"},"reason":{"type":"string","x-stream-index":"002"},"shadow_ban":{"type":"boolean","x-stream-index":"003"}},"required":["duration","reason","shadow_ban","ip_ban"],"type":"object"},"BanRequest":{"nullable":true,"properties":{"banned_by":{"$ref":"#/components/schemas/UserRequest","description":"Details about the user performing the ban","title":"Banned By","x-stream-index":"008"},"banned_by_id":{"description":"ID of the user performing the ban","title":"Banned By ID","type":"string","x-stream-index":"007"},"channel_cid":{"description":"Channel where the ban applies","title":"Channel CID","type":"string","x-stream-index":"004"},"delete_messages":{"enum":["soft","pruning","hard"],"type":"string","x-stream-index":"009"},"ip_ban":{"description":"Whether to ban the user's IP address","title":"IP Ban","type":"boolean","x-stream-index":"006"},"reason":{"description":"Optional explanation for the ban","title":"Reason","type":"string","x-stream-index":"003"},"shadow":{"description":"Whether this is a shadow ban","title":"Shadow","type":"boolean","x-stream-index":"005"},"target_user_id":{"description":"ID of the user to ban","title":"Target User ID","type":"string","x-stream-index":"001"},"timeout":{"description":"Duration of the ban in minutes","minimum":0,"title":"Timeout","type":"integer","x-stream-index":"002"}},"required":["target_user_id"],"type":"object"},"BanResponse":{"nullable":true,"properties":{"banned_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"006"},"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"expires":{"format":"date-time","type":"number","x-stream-index":"003"},"reason":{"type":"string","x-stream-index":"004"},"shadow":{"type":"boolean","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"}},"required":["created_at"],"type":"object"},"BlockContentOptions":{"properties":{"reason":{"type":"string","x-stream-index":"001"}},"required":["reason"],"type":"object"},"BlockListConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/BlockListRule"},"maximum":10,"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"BlockListOptions":{"properties":{"behavior":{"description":"Blocklist behavior","enum":["flag","block","shadow_block"],"title":"Behavior","type":"string","x-stream-index":"002"},"blocklist":{"description":"Blocklist name","title":"Blocklist","type":"string","x-stream-index":"001"}},"required":["blocklist","behavior"],"type":"object"},"BlockListResponse":{"description":"Block list contains restricted words","properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001"},"id":{"type":"string","x-stream-index":"003"},"name":{"description":"Block list name","title":"Name","type":"string","x-stream-index":"004"},"team":{"type":"string","x-stream-index":"007"},"type":{"description":"Block list type.","title":"Type","type":"string","x-stream-index":"005"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"002"},"words":{"description":"List of words to block","items":{"type":"string"},"title":"Words","type":"array","x-stream-index":"006"}},"required":["name","type","words"],"title":"Block list","type":"object","x-stream-docs-page-id":"block_lists"},"BlockListRule":{"properties":{"action":{"enum":["flag","mask_flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"002"}},"required":["name","team","action"],"type":"object"},"BlockUserRequest":{"description":"BlockUserRequest is the payload for blocking a user.","nullable":true,"properties":{"user_id":{"description":"the user to block","title":"UserID","type":"string","x-stream-index":"003"}},"required":["user_id"],"title":"BlockUserRequest","type":"object"},"BlockUserResponse":{"description":"BlockUserResponse is the payload for blocking a user.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"BlockUserResponse","type":"object"},"BlockUsersRequest":{"nullable":true,"properties":{"blocked_user_id":{"description":"User id to block","title":"BlockedUserID","type":"string","x-stream-index":"001"}},"required":["blocked_user_id"],"type":"object"},"BlockUsersResponse":{"nullable":true,"properties":{"blocked_by_user_id":{"description":"User id who blocked another user","title":"BlockedByUserID","type":"string","x-stream-index":"002"},"blocked_user_id":{"description":"User id who got blocked","title":"BlockedUserID","type":"string","x-stream-index":"003"},"created_at":{"description":"Timestamp when the user was blocked","format":"date-time","title":"CreatedAt","type":"number","x-stream-index":"004"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration","blocked_by_user_id","blocked_user_id","created_at"],"type":"object"},"BlockedUserEvent":{"description":"This event is sent to call participants to notify when a user is blocked on a call, clients can use this event to show a notification.\nIf the user is the current user, the client should leave the call screen as well","properties":{"blocked_by_user":{"$ref":"#/components/schemas/UserResponse","description":"The user that blocked the user, null if the user was blocked by server-side","title":"Blocked by","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.blocked_user","description":"The type of event: \"call.blocked_user\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user that was blocked","title":"User","x-stream-index":"003"}},"required":["type","created_at","call_cid","user"],"title":"BlockedUserEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"BlockedUserResponse":{"nullable":true,"properties":{"blocked_user":{"$ref":"#/components/schemas/UserResponse","description":"User who got blocked","title":"User","x-stream-index":"003"},"blocked_user_id":{"description":"ID of the user who got blocked","title":"UserID","type":"string","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who blocked another user","title":"User","x-stream-index":"001"},"user_id":{"description":"ID of the user who blocked another user","title":"UserID","type":"string","x-stream-index":"002"}},"required":["user","user_id","blocked_user","blocked_user_id","created_at"],"type":"object"},"BodyguardRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"},"severity_rules":{"items":{"$ref":"#/components/schemas/BodyguardSeverityRule"},"type":"array","x-stream-index":"003"}},"required":["label","action","severity_rules"],"type":"object"},"BodyguardSeverityRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"severity":{"enum":["low","medium","high","critical"],"type":"string","x-stream-index":"001"}},"required":["severity","action"],"type":"object"},"Bound":{"properties":{"inclusive":{"type":"boolean","x-stream-index":"002"},"value":{"format":"float","type":"number","x-stream-index":"001"}},"required":["value","inclusive"],"type":"object"},"BroadcastSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettings","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettings","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"BroadcastSettingsRequest":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettingsRequest","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettingsRequest","x-stream-index":"003"}},"type":"object"},"BroadcastSettingsResponse":{"description":"BroadcastSettingsResponse is the payload for broadcasting settings","properties":{"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettingsResponse","title":"HLS","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettingsResponse","title":"RTMP","x-stream-index":"003"}},"required":["enabled","hls","rtmp"],"title":"BroadcastSettingsResponse","type":"object"},"Call":{"properties":{"AppPK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"002"},"Backstage":{"type":"boolean","writeOnly":true,"x-stream-index":"023"},"BlockedUserIDs":{"items":{"type":"string"},"type":"array","writeOnly":true,"x-stream-index":"018"},"BlockedUsers":{"items":{"$ref":"#/components/schemas/User"},"type":"array","writeOnly":true,"x-stream-index":"019"},"CID":{"type":"string","writeOnly":true,"x-stream-index":"005"},"CallType":{"$ref":"#/components/schemas/CallType","x-stream-index":"020"},"ChannelCID":{"type":"string","writeOnly":true,"x-stream-index":"032"},"CreatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"013"},"CreatedBy":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"CreatedByUserID":{"type":"string","writeOnly":true,"x-stream-index":"007"},"CurrentSessionID":{"type":"string","writeOnly":true,"x-stream-index":"024"},"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"012"},"DeletedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"028"},"EgressUpdatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"027"},"Egresses":{"items":{"$ref":"#/components/schemas/CallEgress"},"type":"array","writeOnly":true,"x-stream-index":"015"},"EndedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"017"},"ID":{"type":"string","writeOnly":true,"x-stream-index":"004"},"JoinAheadTimeSeconds":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"031"},"LastHeartbeatAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"030"},"LastSessionID":{"type":"string","writeOnly":true,"x-stream-index":"025"},"MemberCount":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"010"},"MemberLookup":{"$ref":"#/components/schemas/MemberLookup","x-stream-index":"011"},"Members":{"items":{"$ref":"#/components/schemas/CallMember"},"type":"array","writeOnly":true,"x-stream-index":"009"},"Session":{"$ref":"#/components/schemas/CallSession","x-stream-index":"026"},"Settings":{"$ref":"#/components/schemas/CallSettings","x-stream-index":"022"},"SettingsOverrides":{"$ref":"#/components/schemas/CallSettings","x-stream-index":"021"},"StartsAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"016"},"Team":{"type":"string","writeOnly":true,"x-stream-index":"006"},"ThumbnailURL":{"type":"string","writeOnly":true,"x-stream-index":"029"},"Type":{"type":"string","writeOnly":true,"x-stream-index":"003"},"UpdatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"014"}},"required":["AppPK","Type","ID","CID","Team","CreatedByUserID","Members","Custom","CreatedAt","UpdatedAt","Egresses","BlockedUserIDs","BlockedUsers","Backstage","CurrentSessionID","LastSessionID","ThumbnailURL","ChannelCID"],"type":"object"},"CallAcceptedEvent":{"description":"This event is sent when a user accepts a notification to join a call.","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.accepted","description":"The type of event: \"call.accepted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who accepted the call","title":"User","x-stream-index":"004"}},"required":["type","created_at","call_cid","call","user"],"title":"CallAcceptedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallClosedCaption":{"description":"CallClosedCaption represents a closed caption of a call.","properties":{"end_time":{"format":"date-time","title":"The end time of the closed caption.","type":"number","x-stream-index":"003"},"speaker_id":{"title":"The speaker ID of the closed caption.","type":"string","x-stream-index":"004"},"start_time":{"format":"date-time","title":"The start time of the closed caption.","type":"number","x-stream-index":"002"},"text":{"title":"The text of the closed caption.","type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserResponse","title":"The full user for the closed caption.","x-stream-index":"005"}},"required":["text","start_time","end_time","speaker_id","user"],"title":"CallClosedCaption","type":"object"},"CallClosedCaptionsFailedEvent":{"description":"This event is sent when call closed captions has failed","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.closed_captions_failed","description":"The type of event: \"call.closed_captions_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallClosedCaptionsFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallClosedCaptionsStartedEvent":{"description":"This event is sent when call closed caption has started","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.closed_captions_started","description":"The type of event: \"call.closed_captions_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallClosedCaptionsStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallClosedCaptionsStoppedEvent":{"description":"This event is sent when call closed captions has stopped","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.closed_captions_stopped","description":"The type of event: \"call.transcription_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallClosedCaptionsStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallCreatedEvent":{"description":"This event is sent when a call is created. Clients receiving this event should check if the ringing\nfield is set to true and if so, show the call screen","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"the members added to this call","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"004"},"type":{"default":"call.created","description":"The type of event: \"call.created\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","members"],"title":"CallCreatedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallDeletedEvent":{"description":"This event is sent when a call is deleted. Clients receiving this event should leave the call screen","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.deleted","description":"The type of event: \"call.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call"],"title":"CallDeletedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallDurationReport":{"properties":{"histogram":{"items":{"$ref":"#/components/schemas/ReportByHistogramBucket"},"type":"array","x-stream-index":"001"}},"required":["histogram"],"type":"object"},"CallDurationReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateCallDurationReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"CallEgress":{"nullable":true,"properties":{"app_pk":{"format":"int32","type":"integer","x-stream-index":"002"},"call_id":{"type":"string","x-stream-index":"004"},"call_type":{"type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/EgressTaskConfig","x-stream-index":"007"},"egress_id":{"type":"string","x-stream-index":"005"},"egress_type":{"type":"string","x-stream-index":"006"},"instance_ip":{"type":"string","x-stream-index":"008"},"started_at":{"format":"date-time","type":"number","x-stream-index":"010"},"state":{"type":"string","x-stream-index":"009"},"stopped_at":{"format":"date-time","type":"number","x-stream-index":"011"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"012"}},"required":["app_pk","call_type","call_id","egress_id","egress_type","instance_ip","state","started_at","updated_at"],"type":"object"},"CallEndedEvent":{"description":"This event is sent when a call is mark as ended for all its participants. Clients receiving this event should leave the call screen","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"reason":{"description":"The reason why the call ended, if available","title":"CallEndedReason","type":"string","x-stream-index":"005"},"type":{"default":"call.ended","description":"The type of event: \"call.ended\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who ended the call, null if the call was ended by the server","title":"User","x-stream-index":"004"}},"required":["type","created_at","call_cid","call"],"title":"CallEndedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallFrameRecordingFailedEvent":{"description":"This event is sent when frame recording has failed","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.frame_recording_failed","description":"The type of event: \"call.frame_recording_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","egress_id"],"title":"CallFrameRecordingFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallFrameRecordingFrameReadyEvent":{"description":"This event is sent when a frame is captured from a call","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"captured_at":{"description":"The time the frame was captured","format":"date-time","title":"CapturedAt","type":"number","x-stream-index":"006"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"008"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"track_type":{"description":"The type of the track frame was captured from (TRACK_TYPE_VIDEO|TRACK_TYPE_SCREEN_SHARE)","title":"TrackType","type":"string","x-stream-index":"004"},"type":{"default":"call.frame_recording_ready","description":"The type of event: \"call.frame_recording_ready\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"url":{"description":"The URL of the frame","title":"URL","type":"string","x-stream-index":"005"},"users":{"additionalProperties":{"$ref":"#/components/schemas/UserResponse"},"description":"The users in the frame","title":"Users","type":"object","x-stream-index":"007"}},"required":["type","created_at","call_cid","session_id","track_type","url","captured_at","users","egress_id"],"title":"CallFrameRecordingFrameReadyEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallFrameRecordingStartedEvent":{"description":"This event is sent when frame recording has started","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.frame_recording_started","description":"The type of event: \"call.frame_recording_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","egress_id"],"title":"CallFrameRecordingStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallFrameRecordingStoppedEvent":{"description":"This event is sent when frame recording has stopped","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.frame_recording_stopped","description":"The type of event: \"call.frame_recording_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","egress_id"],"title":"CallFrameRecordingStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallHLSBroadcastingFailedEvent":{"description":"This event is sent when HLS broadcasting has failed","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.hls_broadcasting_failed","description":"The type of event: \"call.hls_broadcasting_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallHLSBroadcastingFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallHLSBroadcastingStartedEvent":{"description":"This event is sent when HLS broadcasting has started","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"hls_playlist_url":{"type":"string","x-stream-index":"004"},"type":{"default":"call.hls_broadcasting_started","description":"The type of event: \"call.hls_broadcasting_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","hls_playlist_url"],"title":"CallHLSBroadcastingStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallHLSBroadcastingStoppedEvent":{"description":"This event is sent when HLS broadcasting has stopped","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.hls_broadcasting_stopped","description":"The type of event: \"call.hls_broadcasting_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallHLSBroadcastingStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallIngressResponse":{"description":"CallIngressResponse is the payload for ingress settings","properties":{"rtmp":{"$ref":"#/components/schemas/RTMPIngress","title":"RTMP","x-stream-index":"001"}},"required":["rtmp"],"title":"CallIngressResponse","type":"object"},"CallLiveStartedEvent":{"description":"This event is sent when a call is started. Clients receiving this event should start the call.","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.live_started","description":"The type of event: \"call.live_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call"],"title":"CallLiveStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMember":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"010"},"role":{"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["user_id","role","custom","created_at","updated_at"],"type":"object"},"CallMemberAddedEvent":{"description":"This event is sent when one or more members are added to a call","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"the members added to this call","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"004"},"type":{"default":"call.member_added","description":"The type of event: \"call.member_added\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","members"],"title":"CallMemberAddedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMemberRemovedEvent":{"description":"This event is sent when one or more members are removed from a call","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"the list of member IDs removed from the call","items":{"type":"string"},"title":"Members","type":"array","x-stream-index":"004"},"type":{"default":"call.member_removed","description":"The type of event: \"call.member_removed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","members"],"title":"CallMemberRemovedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMemberUpdatedEvent":{"description":"This event is sent when one or more members are updated","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"The list of members that were updated","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"004"},"type":{"default":"call.member_updated","description":"The type of event: \"call.member_updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","members"],"title":"CallMemberUpdatedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMemberUpdatedPermissionEvent":{"description":"This event is sent when one or more members get its role updated","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"capabilities_by_role":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"The capabilities by role for this call","title":"CapabilitiesByRole","type":"object","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"The list of members that were updated","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"005"},"type":{"default":"call.member_updated_permission","description":"The type of event: \"call.member_added\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","capabilities_by_role","members"],"title":"CallMemberUpdatedPermissionEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMissedEvent":{"description":"This event is sent to call members who did not accept/reject/join the call to notify they missed the call","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"List of members who missed the call","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"005"},"notify_user":{"type":"boolean","x-stream-index":"007"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.missed","description":"The type of event: \"call.notification\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The caller from whom the call was missed","title":"User","x-stream-index":"006"}},"required":["type","created_at","call_cid","session_id","call","members","user","notify_user"],"title":"CallMissedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallModerationBlurEvent":{"properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"type":{"default":"call.moderation_blur","type":"string","x-stream-index":"001.001"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["type","created_at","call_cid","user_id","custom"],"title":"CallModerationBlurEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallModerationWarningEvent":{"properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"message":{"type":"string","x-stream-index":"004"},"type":{"default":"call.moderation_warning","type":"string","x-stream-index":"001.001"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["type","created_at","call_cid","user_id","message","custom"],"title":"CallModerationWarningEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallNotificationEvent":{"description":"This event is sent to all call members to notify they are getting called","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"Call members","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"005"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.notification","description":"The type of event: \"call.notification\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user that sent the call notification","title":"User","x-stream-index":"006"}},"required":["type","created_at","call_cid","session_id","call","members","user"],"title":"CallNotificationEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallParticipant":{"nullable":true,"properties":{"JoinedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"004"},"Role":{"type":"string","writeOnly":true,"x-stream-index":"002"},"UserSessionID":{"type":"string","writeOnly":true,"x-stream-index":"003"},"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"001.046"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"001.017"},"banned":{"type":"boolean","x-stream-index":"001.016"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.013"},"id":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"001.023"},"language":{"type":"string","x-stream-index":"001.035"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"001.022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"001.026"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.042"},"role":{"type":"string","x-stream-index":"001.004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.005"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.009"}},"required":["id","role","teams_role","custom","banned","online","Role","UserSessionID","JoinedAt"],"type":"object"},"CallParticipantCountReport":{"properties":{"histogram":{"items":{"$ref":"#/components/schemas/ReportByHistogramBucket"},"type":"array","x-stream-index":"001"}},"required":["histogram"],"type":"object"},"CallParticipantCountReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateCallParticipantCountReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"CallParticipantResponse":{"properties":{"joined_at":{"format":"date-time","type":"number","x-stream-index":"004"},"role":{"type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"},"user_session_id":{"type":"string","x-stream-index":"002"}},"required":["user","user_session_id","role","joined_at"],"type":"object"},"CallReactionEvent":{"description":"This event is sent when a reaction is sent in a call, clients should use this to show the reaction in the call screen","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"reaction":{"$ref":"#/components/schemas/ReactionResponse","description":"the reaction object sent by the user on the call","title":"reaction","x-stream-index":"003"},"type":{"default":"call.reaction_new","description":"The type of event: \"call.reaction_new\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","reaction"],"title":"CallReactionEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRecording":{"description":"CallRecording represents a recording of a call.","properties":{"end_time":{"format":"date-time","title":"The end time of the recording.","type":"number","x-stream-index":"004"},"filename":{"title":"The filename of the recording.","type":"string","x-stream-index":"001"},"session_id":{"title":"The session ID of the recording.","type":"string","x-stream-index":"005"},"start_time":{"format":"date-time","title":"The start time of the recording.","type":"number","x-stream-index":"003"},"url":{"title":"The URL of the recording.","type":"string","x-stream-index":"002"}},"required":["filename","url","start_time","end_time","session_id"],"title":"CallRecording","type":"object"},"CallRecordingFailedEvent":{"description":"This event is sent when call recording has failed","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"003"},"type":{"default":"call.recording_failed","description":"The type of event: \"call.recording_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","egress_id"],"title":"CallRecordingFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRecordingReadyEvent":{"description":"This event is sent when call recording is ready","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"call_recording":{"$ref":"#/components/schemas/CallRecording","description":"The call recording object","title":"CallRecording","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.recording_ready","description":"The type of event: \"call.recording_ready\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call_recording","egress_id"],"title":"CallRecordingReadyEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRecordingStartedEvent":{"description":"This event is sent when call recording has started","properties":{"call_cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"egress_id":{"type":"string","x-stream-index":"001"},"type":{"default":"call.recording_started","description":"The type of event: \"call.recording_started\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001"}},"required":["egress_id","type","created_at","call_cid"],"title":"CallRecordingStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRecordingStoppedEvent":{"description":"This event is sent when call recording has stopped","properties":{"call_cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"egress_id":{"type":"string","x-stream-index":"001"},"type":{"default":"call.recording_stopped","description":"The type of event: \"call.recording_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001"}},"required":["egress_id","type","created_at","call_cid"],"title":"CallRecordingStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRejectedEvent":{"description":"This event is sent when a user rejects a notification to join a call.","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"reason":{"description":"Provides information about why the call was rejected. You can provide any value, but the Stream API and SDKs use these default values: rejected, cancel, timeout and busy","title":"Reason","type":"string","x-stream-index":"005"},"type":{"default":"call.rejected","description":"The type of event: \"call.rejected\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who rejected the call","title":"User","x-stream-index":"004"}},"required":["type","created_at","call_cid","call","user"],"title":"CallRejectedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallReportResponse":{"properties":{"ended_at":{"format":"date-time","type":"number","x-stream-index":"003"},"score":{"format":"float","type":"number","x-stream-index":"001"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002"}},"required":["score"],"type":"object"},"CallRequest":{"description":"CallRequest is the payload for creating a call.","properties":{"channel_cid":{"type":"string","x-stream-index":"009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"members":{"items":{"$ref":"#/components/schemas/MemberRequest"},"maximum":100,"type":"array","x-stream-index":"005"},"settings_override":{"$ref":"#/components/schemas/CallSettingsRequest","x-stream-index":"006"},"starts_at":{"format":"date-time","type":"number","x-stream-index":"007"},"team":{"type":"string","x-stream-index":"001"},"video":{"type":"boolean","x-stream-index":"008"}},"title":"CallRequest","type":"object"},"CallResponse":{"description":"Represents a call","properties":{"backstage":{"type":"boolean","x-stream-index":"016"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"018"},"captioning":{"type":"boolean","x-stream-index":"013"},"channel_cid":{"type":"string","x-stream-index":"024"},"cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"The user that created the call","title":"Created By","x-stream-index":"007"},"current_session_id":{"type":"string","x-stream-index":"005"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"008"},"egress":{"$ref":"#/components/schemas/EgressResponse","x-stream-index":"021"},"ended_at":{"description":"Date/time when the call ended","format":"date-time","title":"Ended At","type":"number","x-stream-index":"014"},"id":{"description":"Call ID","title":"ID","type":"string","x-stream-index":"003"},"ingress":{"$ref":"#/components/schemas/CallIngressResponse","x-stream-index":"019"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"023"},"recording":{"type":"boolean","x-stream-index":"011"},"session":{"$ref":"#/components/schemas/CallSessionResponse","x-stream-index":"020"},"settings":{"$ref":"#/components/schemas/CallSettingsResponse","x-stream-index":"017"},"starts_at":{"description":"Date/time when the call will start","format":"date-time","title":"Starts At","type":"number","x-stream-index":"015"},"team":{"type":"string","x-stream-index":"006"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailResponse","x-stream-index":"022"},"transcribing":{"type":"boolean","x-stream-index":"012"},"type":{"description":"The type of call","title":"Type","type":"string","x-stream-index":"002"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"}},"required":["type","id","cid","current_session_id","created_by","custom","created_at","updated_at","recording","transcribing","captioning","backstage","settings","blocked_user_ids","ingress","egress"],"title":"CallResponse","type":"object"},"CallRingEvent":{"description":"This event is sent to all call members to notify they are getting called","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"005"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"Call members","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"006"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.ring","description":"The type of event: \"call.notification\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user that sent the call notification","title":"User","x-stream-index":"007"},"video":{"type":"boolean","x-stream-index":"008"}},"required":["type","created_at","call_cid","session_id","call","members","user","video"],"title":"CallRingEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRtmpBroadcastFailedEvent":{"description":"This event is sent when a call RTMP broadcast has failed","properties":{"call_cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"002.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.002"},"name":{"description":"Name of the given RTMP broadcast","title":"Name","type":"string","x-stream-index":"003"},"type":{"default":"call.rtmp_broadcast_failed","description":"The type of event: \"call.rtmp_broadcast_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","name"],"title":"CallRtmpBroadcastFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRtmpBroadcastStartedEvent":{"description":"This event is sent when RTMP broadcast has started","properties":{"call_cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"002.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.002"},"name":{"description":"Name of the given RTMP broadcast","title":"Name","type":"string","x-stream-index":"003"},"type":{"default":"call.rtmp_broadcast_started","description":"The type of event: \"call.rtmp_broadcast_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","name"],"title":"CallRtmpBroadcastStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRtmpBroadcastStoppedEvent":{"description":"This event is sent when RTMP broadcast has stopped","properties":{"call_cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"002.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.002"},"name":{"description":"Name of the given RTMP broadcast","title":"Name","type":"string","x-stream-index":"003"},"type":{"default":"call.rtmp_broadcast_stopped","description":"The type of event: \"call.rtmp_broadcast_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","name"],"title":"CallRtmpBroadcastStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSession":{"properties":{"AcceptedBy":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","writeOnly":true,"x-stream-index":"008"},"ActiveSFUs":{"items":{"$ref":"#/components/schemas/SFUIDLastSeen"},"type":"array","writeOnly":true,"x-stream-index":"016"},"AnonymousParticipantCount":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"019"},"AppPK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"002.001"},"CallID":{"type":"string","writeOnly":true,"x-stream-index":"002.003"},"CallType":{"type":"string","writeOnly":true,"x-stream-index":"002.002"},"CreatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"003"},"DeletedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"004"},"EndedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"006"},"LiveEndedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"013"},"LiveStartedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"012"},"MissedBy":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","writeOnly":true,"x-stream-index":"010"},"Participants":{"items":{"$ref":"#/components/schemas/CallParticipant"},"type":"array","writeOnly":true,"x-stream-index":"011"},"ParticipantsCountByRole":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","writeOnly":true,"x-stream-index":"018"},"RejectedBy":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","writeOnly":true,"x-stream-index":"009"},"RingAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"007"},"SFUIDs":{"items":{"type":"string"},"type":"array","writeOnly":true,"x-stream-index":"015"},"SessionID":{"type":"string","writeOnly":true,"x-stream-index":"002.004"},"StartedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"005"},"TimerEndsAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"014"},"UserPermissionOverrides":{"additionalProperties":{"additionalProperties":{"type":"boolean"},"type":"object"},"type":"object","writeOnly":true,"x-stream-index":"017"}},"required":["AppPK","CallType","CallID","SessionID","CreatedAt","AcceptedBy","RejectedBy","MissedBy","Participants","SFUIDs","ActiveSFUs","UserPermissionOverrides","ParticipantsCountByRole","AnonymousParticipantCount"],"type":"object"},"CallSessionEndedEvent":{"description":"This event is sent when a call session ends","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_ended","description":"The type of event: \"call.session_ended\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","call"],"title":"CallSessionEndedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSessionParticipantCountsUpdatedEvent":{"description":"This event is sent when the participant counts in a call session are updated","properties":{"anonymous_participant_count":{"format":"int32","type":"integer","x-stream-index":"005"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"participants_count_by_role":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"004"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_participant_count_updated","description":"The type of event: \"call.session_participant_count_updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","participants_count_by_role","anonymous_participant_count"],"title":"CallSessionParticipantCountsUpdatedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSessionParticipantJoinedEvent":{"description":"This event is sent when a participant joins a call session","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"participant":{"$ref":"#/components/schemas/CallParticipantResponse","description":"The participant that joined the session","title":"Participant","x-stream-index":"004"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_participant_joined","description":"The type of event: \"call.session_participant_joined\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","participant"],"title":"CallSessionParticipantJoinedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSessionParticipantLeftEvent":{"description":"This event is sent when a participant leaves a call session","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"duration_seconds":{"description":"The duration participant was in the session in seconds","format":"int32","title":"Duration","type":"integer","x-stream-index":"005"},"participant":{"$ref":"#/components/schemas/CallParticipantResponse","description":"The participant that left the session","title":"Participant","x-stream-index":"004"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_participant_left","description":"The type of event: \"call.session_participant_left\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","participant","duration_seconds"],"title":"CallSessionParticipantLeftEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSessionResponse":{"properties":{"accepted_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"008"},"anonymous_participant_count":{"format":"int32","type":"integer","x-stream-index":"006"},"ended_at":{"format":"date-time","type":"number","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"live_ended_at":{"format":"date-time","type":"number","x-stream-index":"011"},"live_started_at":{"format":"date-time","type":"number","x-stream-index":"010"},"missed_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"009"},"participants":{"items":{"$ref":"#/components/schemas/CallParticipantResponse"},"type":"array","x-stream-index":"004"},"participants_count_by_role":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"005"},"rejected_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"007"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002"},"timer_ends_at":{"format":"date-time","type":"number","x-stream-index":"012"}},"required":["id","participants","participants_count_by_role","anonymous_participant_count","rejected_by","accepted_by","missed_by"],"type":"object"},"CallSessionStartedEvent":{"description":"This event is sent when a call session starts","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_started","description":"The type of event: \"call.session_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","call"],"title":"CallSessionStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSettings":{"properties":{"audio":{"$ref":"#/components/schemas/AudioSettings","x-stream-index":"001"},"backstage":{"$ref":"#/components/schemas/BackstageSettings","x-stream-index":"002"},"broadcasting":{"$ref":"#/components/schemas/BroadcastSettings","x-stream-index":"007"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordSettings","x-stream-index":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettings","x-stream-index":"008"},"ingress":{"$ref":"#/components/schemas/IngressSettings","x-stream-index":"014"},"limits":{"$ref":"#/components/schemas/LimitsSettings","x-stream-index":"012"},"recording":{"$ref":"#/components/schemas/RecordSettings","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettings","x-stream-index":"010"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettings","x-stream-index":"004"},"session":{"$ref":"#/components/schemas/SessionSettings","x-stream-index":"013"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettings","x-stream-index":"011"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettings","x-stream-index":"009"},"video":{"$ref":"#/components/schemas/VideoSettings","x-stream-index":"003"}},"type":"object"},"CallSettingsRequest":{"properties":{"audio":{"$ref":"#/components/schemas/AudioSettingsRequest","x-stream-index":"001"},"backstage":{"$ref":"#/components/schemas/BackstageSettingsRequest","x-stream-index":"002"},"broadcasting":{"$ref":"#/components/schemas/BroadcastSettingsRequest","x-stream-index":"010"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordingSettingsRequest","x-stream-index":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettingsRequest","x-stream-index":"003"},"ingress":{"$ref":"#/components/schemas/IngressSettingsRequest","x-stream-index":"014"},"limits":{"$ref":"#/components/schemas/LimitsSettingsRequest","x-stream-index":"012"},"recording":{"$ref":"#/components/schemas/RecordSettingsRequest","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettingsRequest","x-stream-index":"007"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettingsRequest","x-stream-index":"008"},"session":{"$ref":"#/components/schemas/SessionSettingsRequest","x-stream-index":"013"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettingsRequest","x-stream-index":"011"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettingsRequest","x-stream-index":"009"},"video":{"$ref":"#/components/schemas/VideoSettingsRequest","x-stream-index":"004"}},"type":"object"},"CallSettingsResponse":{"properties":{"audio":{"$ref":"#/components/schemas/AudioSettingsResponse","x-stream-index":"001"},"backstage":{"$ref":"#/components/schemas/BackstageSettingsResponse","x-stream-index":"002"},"broadcasting":{"$ref":"#/components/schemas/BroadcastSettingsResponse","x-stream-index":"003"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordingSettingsResponse","x-stream-index":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettingsResponse","x-stream-index":"004"},"ingress":{"$ref":"#/components/schemas/IngressSettingsResponse","x-stream-index":"014"},"limits":{"$ref":"#/components/schemas/LimitsSettingsResponse","x-stream-index":"012"},"recording":{"$ref":"#/components/schemas/RecordSettingsResponse","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettingsResponse","x-stream-index":"007"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettingsResponse","x-stream-index":"008"},"session":{"$ref":"#/components/schemas/SessionSettingsResponse","x-stream-index":"013"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettingsResponse","x-stream-index":"011"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettingsResponse","x-stream-index":"009"},"video":{"$ref":"#/components/schemas/VideoSettingsResponse","x-stream-index":"010"}},"required":["audio","backstage","broadcasting","geofencing","recording","frame_recording","ring","screensharing","transcription","video","thumbnails","limits","session"],"type":"object"},"CallStateResponseFields":{"description":"CallStateResponseFields is the payload for call state response","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001"},"members":{"description":"List of call members","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"002"},"membership":{"$ref":"#/components/schemas/MemberResponse","description":"Current user membership object","title":"Membership","x-stream-index":"003"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"004"}},"required":["call","members","own_capabilities","blocked_users"],"title":"CallStateResponseFields","type":"object"},"CallStatsReportReadyEvent":{"description":"This event is sent when the insights report is ready","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.stats_report_ready","description":"The type of event, \"call.report_ready\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id"],"title":"CallStatsReportReadyEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallStatsReportSummaryResponse":{"properties":{"call_cid":{"type":"string","x-stream-index":"001"},"call_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"008"},"call_session_id":{"type":"string","x-stream-index":"002"},"call_status":{"type":"string","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"first_stats_time":{"format":"date-time","type":"number","x-stream-index":"003"},"min_user_rating":{"format":"int32","type":"integer","x-stream-index":"006"},"quality_score":{"format":"int32","type":"integer","x-stream-index":"005"}},"required":["call_cid","call_session_id","first_stats_time","call_status","call_duration_seconds"],"type":"object"},"CallTranscription":{"description":"CallTranscription represents a transcription of a call.","properties":{"end_time":{"format":"date-time","title":"The end time of the transcription.","type":"number","x-stream-index":"004"},"filename":{"title":"The filename of the transcription.","type":"string","x-stream-index":"001"},"session_id":{"title":"The session ID of the transcription.","type":"string","x-stream-index":"005"},"start_time":{"format":"date-time","title":"The start time of the transcription.","type":"number","x-stream-index":"003"},"url":{"title":"The URL of the transcription.","type":"string","x-stream-index":"002"}},"required":["filename","url","start_time","end_time","session_id"],"title":"CallTranscription","type":"object"},"CallTranscriptionFailedEvent":{"description":"This event is sent when call transcription has failed","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"003"},"error":{"description":"The error message detailing why transcription failed.","title":"string","type":"string","x-stream-index":"004"},"type":{"default":"call.transcription_failed","description":"The type of event: \"call.transcription_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","egress_id"],"title":"CallTranscriptionFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallTranscriptionReadyEvent":{"description":"This event is sent when call transcription is ready","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"call_transcription":{"$ref":"#/components/schemas/CallTranscription","description":"The call transcription object","title":"CallTranscription","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.transcription_ready","description":"The type of event: \"call.transcription_ready\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call_transcription","egress_id"],"title":"CallTranscriptionReadyEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallTranscriptionStartedEvent":{"description":"This event is sent when call transcription has started","properties":{"call_cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"egress_id":{"type":"string","x-stream-index":"001"},"type":{"default":"call.transcription_started","description":"The type of event: \"call.transcription_started\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001"}},"required":["egress_id","type","created_at","call_cid"],"title":"CallTranscriptionStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallTranscriptionStoppedEvent":{"description":"This event is sent when call transcription has stopped","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"003"},"type":{"default":"call.transcription_stopped","description":"The type of event: \"call.transcription_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","egress_id"],"title":"CallTranscriptionStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallType":{"properties":{"AppPK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"003"},"CreatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"005"},"ExternalStorage":{"type":"string","writeOnly":true,"x-stream-index":"009"},"Name":{"type":"string","writeOnly":true,"x-stream-index":"004"},"NotificationSettings":{"$ref":"#/components/schemas/NotificationSettings","x-stream-index":"008"},"PK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"002"},"Settings":{"$ref":"#/components/schemas/CallSettings","x-stream-index":"007"},"UpdatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"006"}},"required":["PK","AppPK","Name","CreatedAt","UpdatedAt","ExternalStorage"],"type":"object"},"CallUpdatedEvent":{"description":"This event is sent when a call is updated, clients should use this update the local state of the call.\nThis event also contains the capabilities by role for the call, clients should update the own_capability for the current.","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"capabilities_by_role":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"The capabilities by role for this call","title":"CapabilitiesByRole","type":"object","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.updated","description":"The type of event: \"call.ended\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","capabilities_by_role"],"title":"CallUpdatedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallUserFeedbackSubmittedEvent":{"description":"This event is sent when a user submits feedback for a call.","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"custom":{"additionalProperties":{},"description":"Custom data provided by the user","title":"Custom","type":"object","x-stream-index":"007"},"rating":{"description":"The rating given by the user (1-5)","format":"int32","title":"Rating","type":"integer","x-stream-index":"005"},"reason":{"description":"The reason provided by the user for the rating","title":"Reason","type":"string","x-stream-index":"006"},"sdk":{"type":"string","x-stream-index":"008"},"sdk_version":{"type":"string","x-stream-index":"009"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.user_feedback_submitted","description":"The type of event, \"call.user_feedback\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who submitted the feedback","title":"User","x-stream-index":"004"}},"required":["type","created_at","call_cid","session_id","user","rating"],"title":"CallUserFeedbackSubmittedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallUserMutedEvent":{"description":"This event is sent when a call member is muted","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"from_user_id":{"type":"string","x-stream-index":"003"},"muted_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"type":{"default":"call.user_muted","description":"The type of event: \"call.user_muted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","from_user_id","muted_user_ids"],"title":"CallUserMutedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallsPerDayReport":{"properties":{"count":{"format":"int64","type":"integer","x-stream-index":"001"}},"required":["count"],"type":"object"},"CallsPerDayReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateCallsPerDayReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"CastPollVoteRequest":{"nullable":true,"properties":{"vote":{"$ref":"#/components/schemas/VoteData","description":"Vote data","title":"VoteData","x-stream-index":"004"}},"type":"object"},"Channel":{"properties":{"active_live_locations":{"items":{"$ref":"#/components/schemas/SharedLocation"},"type":"array","x-stream-index":"034"},"auto_translation_enabled":{"type":"boolean","x-stream-index":"029"},"auto_translation_language":{"type":"string","x-stream-index":"030"},"cid":{"type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/ChannelConfig","x-stream-index":"026"},"config_overrides":{"$ref":"#/components/schemas/ConfigOverrides","x-stream-index":"027"},"cooldown":{"format":"int32","type":"integer","x-stream-index":"031"},"created_at":{"format":"date-time","type":"number","x-stream-index":"009"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"019"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"disabled":{"type":"boolean","x-stream-index":"017"},"frozen":{"type":"boolean","x-stream-index":"016"},"id":{"type":"string","x-stream-index":"004"},"invites":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"022"},"last_campaigns":{"type":"string","x-stream-index":"032"},"last_message_at":{"format":"date-time","type":"number","x-stream-index":"006"},"member_count":{"format":"int32","type":"integer","x-stream-index":"021"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"020"},"team":{"type":"string","x-stream-index":"028"},"truncated_by":{"$ref":"#/components/schemas/User","x-stream-index":"015"},"type":{"type":"string","x-stream-index":"005"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"010"}},"required":["cid","id","type","created_at","updated_at","frozen","disabled","custom","auto_translation_language"],"type":"object"},"ChannelConfig":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.026"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.021"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.022"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.027"},"blocklist":{"type":"string","x-stream-index":"001.023"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.024"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.025"},"commands":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"connect_events":{"type":"boolean","x-stream-index":"001.004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"custom_events":{"type":"boolean","x-stream-index":"001.012"},"mark_messages_pending":{"type":"boolean","x-stream-index":"001.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"001.020"},"mutes":{"type":"boolean","x-stream-index":"001.009"},"name":{"type":"string","x-stream-index":"001.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"001.028"},"partition_ttl":{"type":"integer","x-stream-index":"001.029"},"polls":{"type":"boolean","x-stream-index":"001.016"},"push_notifications":{"type":"boolean","x-stream-index":"001.013"},"quotes":{"type":"boolean","x-stream-index":"001.008"},"reactions":{"type":"boolean","x-stream-index":"001.006"},"read_events":{"type":"boolean","x-stream-index":"001.003"},"reminders":{"type":"boolean","x-stream-index":"001.014"},"replies":{"type":"boolean","x-stream-index":"001.007"},"search":{"type":"boolean","x-stream-index":"001.005"},"shared_locations":{"type":"boolean","x-stream-index":"001.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.030"},"typing_events":{"type":"boolean","x-stream-index":"001.002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"002.004"},"uploads":{"type":"boolean","x-stream-index":"001.010"},"url_enrichment":{"type":"boolean","x-stream-index":"001.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"001.017"}},"required":["name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","created_at","updated_at","commands"],"type":"object"},"ChannelConfigWithInfo":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.002.026"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.002.021"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.022"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.002.027"},"blocklist":{"type":"string","x-stream-index":"001.002.023"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.024"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.002.025"},"commands":{"items":{"$ref":"#/components/schemas/Command"},"type":"array","x-stream-index":"001.003"},"connect_events":{"type":"boolean","x-stream-index":"001.002.004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.001.003"},"custom_events":{"type":"boolean","x-stream-index":"001.002.012"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"002"},"mark_messages_pending":{"type":"boolean","x-stream-index":"001.002.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"001.002.020"},"mutes":{"type":"boolean","x-stream-index":"001.002.009"},"name":{"type":"string","x-stream-index":"001.002.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"001.002.028"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"001.002.029"},"polls":{"type":"boolean","x-stream-index":"001.002.016"},"push_notifications":{"type":"boolean","x-stream-index":"001.002.013"},"quotes":{"type":"boolean","x-stream-index":"001.002.008"},"reactions":{"type":"boolean","x-stream-index":"001.002.006"},"read_events":{"type":"boolean","x-stream-index":"001.002.003"},"reminders":{"type":"boolean","x-stream-index":"001.002.014"},"replies":{"type":"boolean","x-stream-index":"001.002.007"},"search":{"type":"boolean","x-stream-index":"001.002.005"},"shared_locations":{"type":"boolean","x-stream-index":"001.002.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.002.030"},"typing_events":{"type":"boolean","x-stream-index":"001.002.002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"uploads":{"type":"boolean","x-stream-index":"001.002.010"},"url_enrichment":{"type":"boolean","x-stream-index":"001.002.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"001.002.017"}},"required":["created_at","updated_at","name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","commands"],"type":"object"},"ChannelCreatedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"channel.created","type":"string","x-stream-index":"001.001"}},"required":["type","created_at"],"title":"ChannelCreatedEvent","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"},"ChannelDeletedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003.004"},"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"003.005"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"team":{"type":"string","x-stream-index":"001.001"},"type":{"default":"channel.deleted","type":"string","x-stream-index":"002.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"ChannelDeletedEvent","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"},"ChannelFrozenEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"channel.frozen","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"ChannelFrozenEvent","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"},"ChannelGetOrCreateRequest":{"nullable":true,"properties":{"data":{"$ref":"#/components/schemas/ChannelInput","x-stream-index":"003"},"hide_for_creator":{"description":"Whether this channel will be hidden for the user who created the channel or not","title":"Hide for creator","type":"boolean","x-stream-index":"007"},"members":{"$ref":"#/components/schemas/PaginationParams","x-stream-index":"010"},"messages":{"$ref":"#/components/schemas/MessagePaginationParams","x-stream-index":"009"},"presence":{"description":"Fetch user presence info","title":"Presence","type":"boolean","x-stream-index":"006"},"state":{"description":"Refresh channel state","title":"State","type":"boolean","x-stream-index":"005"},"thread_unread_counts":{"type":"boolean","x-stream-index":"008"},"watch":{"description":"Start watching the channel","title":"Watch","type":"boolean","x-stream-index":"004"},"watchers":{"$ref":"#/components/schemas/PaginationParams","x-stream-index":"011"}},"type":"object"},"ChannelHiddenEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003.004"},"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"003.005"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"clear_history":{"type":"boolean","x-stream-index":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"type":{"default":"channel.hidden","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["clear_history","cid","channel_id","channel_type","channel_member_count","type","created_at"],"title":"ChannelHiddenEvent","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"},"ChannelInput":{"properties":{"auto_translation_enabled":{"description":"Enable or disable auto translation","title":"Auto translation","type":"boolean","x-stream-index":"005"},"auto_translation_language":{"description":"Switch auto translation language","title":"Auto translation language","type":"string","x-stream-index":"006"},"config_overrides":{"$ref":"#/components/schemas/ChannelConfig","x-stream-index":"024"},"created_by":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"009"},"created_by_id":{"type":"string","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"015"},"disabled":{"type":"boolean","x-stream-index":"014"},"frozen":{"description":"Freeze or unfreeze the channel","title":"Frozen","type":"boolean","x-stream-index":"013"},"invites":{"items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"type":"array","x-stream-index":"016"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"type":"array","x-stream-index":"018"},"team":{"description":"Team the channel belongs to (if multi-tenant mode is enabled)","title":"Team","type":"string","x-stream-index":"004"},"truncated_by_id":{"type":"string","x-stream-index":"010"}},"type":"object"},"ChannelKickedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002.004"},"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"002.005"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"channel.kicked","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"ChannelKickedEvent","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"},"ChannelMember":{"nullable":true,"properties":{"archived_at":{"format":"date-time","type":"number","x-stream-index":"015"},"ban_expires":{"description":"Expiration date of the ban","format":"date-time","title":"Ban expires","type":"number","x-stream-index":"013"},"banned":{"description":"Whether member is banned this channel or not","title":"Banned","type":"boolean","x-stream-index":"012"},"channel_role":{"description":"Role of the member in the channel","title":"Channel Role","type":"string","x-stream-index":"018"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"invite_accepted_at":{"description":"Date when invite was accepted","format":"date-time","title":"Invited accepted at","type":"number","x-stream-index":"006"},"invite_rejected_at":{"description":"Date when invite was rejected","format":"date-time","title":"Invited rejected at","type":"number","x-stream-index":"007"},"invited":{"description":"Whether member was invited or not","title":"Invited","type":"boolean","x-stream-index":"005"},"is_moderator":{"description":"Whether member is channel moderator or not","title":"Is moderator","type":"boolean","x-stream-index":"003"},"notifications_muted":{"type":"boolean","x-stream-index":"019"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"016"},"role":{"description":"Permission level of the member in the channel (DEPRECATED: use channel_role instead)","enum":["member","moderator","admin","owner"],"title":"Role","type":"string","x-stream-index":"017"},"shadow_banned":{"description":"Whether member is shadow banned in this channel or not","title":"Shadow banned","type":"boolean","x-stream-index":"014"},"status":{"type":"string","x-stream-index":"008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"},"user_id":{"title":"User ID","type":"string","x-stream-index":"001"}},"required":["custom","created_at","updated_at","banned","shadow_banned","channel_role","notifications_muted"],"title":"Channel member","type":"object"},"ChannelMemberResponse":{"nullable":true,"properties":{"archived_at":{"format":"date-time","type":"number","x-stream-index":"016"},"ban_expires":{"description":"Expiration date of the ban","format":"date-time","title":"Ban expires","type":"number","x-stream-index":"013"},"banned":{"description":"Whether member is banned this channel or not","title":"Banned","type":"boolean","x-stream-index":"012"},"channel_role":{"description":"Role of the member in the channel","title":"Channel Role","type":"string","x-stream-index":"018"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"invite_accepted_at":{"description":"Date when invite was accepted","format":"date-time","title":"Invited accepted at","type":"number","x-stream-index":"006"},"invite_rejected_at":{"description":"Date when invite was rejected","format":"date-time","title":"Invited rejected at","type":"number","x-stream-index":"007"},"invited":{"description":"Whether member was invited or not","title":"Invited","type":"boolean","x-stream-index":"005"},"is_moderator":{"description":"Whether member is channel moderator or not","title":"Is moderator","type":"boolean","x-stream-index":"003"},"notifications_muted":{"type":"boolean","x-stream-index":"019"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"015"},"role":{"description":"Permission level of the member in the channel (DEPRECATED: use channel_role instead)","enum":["member","moderator","admin","owner"],"title":"Role","type":"string","x-stream-index":"017"},"shadow_banned":{"description":"Whether member is shadow banned in this channel or not","title":"Shadow banned","type":"boolean","x-stream-index":"014"},"status":{"type":"string","x-stream-index":"008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"},"user_id":{"title":"User ID","type":"string","x-stream-index":"001"}},"required":["custom","created_at","updated_at","banned","shadow_banned","channel_role","notifications_muted"],"title":"Channel member","type":"object"},"ChannelMute":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel that is muted","title":"Channel","x-stream-index":"002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"004"},"expires":{"description":"Date/time of mute expiration","format":"date-time","title":"Expires","type":"number","x-stream-index":"003"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Owner of channel mute","title":"User","x-stream-index":"001"}},"required":["created_at","updated_at"],"type":"object"},"ChannelOwnCapability":{"description":"All possibility of string to use","enum":["ban-channel-members","cast-poll-vote","connect-events","create-attachment","delete-any-message","delete-channel","delete-own-message","flag-message","freeze-channel","join-channel","leave-channel","mute-channel","pin-message","query-poll-votes","quote-message","read-events","search-messages","send-custom-events","send-links","send-message","send-poll","send-reaction","send-reply","send-restricted-visibility-message","send-typing-events","set-channel-cooldown","share-location","skip-slow-mode","slow-mode","typing-events","update-any-message","update-channel","update-channel-members","update-own-message","update-thread","upload-file"],"title":"ChannelOwnCapability","type":"string"},"ChannelPushPreferences":{"properties":{"chat_level":{"type":"string","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"number","x-stream-index":"002"}},"type":"object"},"ChannelResponse":{"description":"Represents channel in chat","properties":{"auto_translation_enabled":{"description":"Whether auto translation is enabled or not","title":"Auto translation","type":"boolean","x-stream-index":"017"},"auto_translation_language":{"description":"Language to translate to when auto translation is active","title":"Auto translation language","type":"string","x-stream-index":"018"},"blocked":{"description":"Whether this channel is blocked by current user or not","title":"Blocked","type":"boolean","x-stream-index":"023"},"cid":{"description":"Channel CID (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/ChannelConfigWithInfo","description":"Channel configuration","title":"ChannelConfigWithInfo","x-stream-index":"013"},"cooldown":{"description":"Cooldown period after sending each message","format":"int32","title":"Cooldown","type":"integer","x-stream-index":"020"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"005"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"Creator of the channel","title":"UserResponse","x-stream-index":"008"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"026"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"007"},"disabled":{"type":"boolean","x-stream-index":"010"},"frozen":{"description":"Whether channel is frozen or not","title":"Frozen","type":"boolean","x-stream-index":"009"},"hidden":{"description":"Whether this channel is hidden by current user or not","title":"Hidden","type":"boolean","x-stream-index":"022"},"hide_messages_before":{"description":"Date since when the message history is accessible","format":"date-time","title":"Hide messages before","type":"number","x-stream-index":"019"},"id":{"description":"Channel unique ID","title":"ID","type":"string","x-stream-index":"001"},"last_message_at":{"description":"Date of the last message sent","format":"date-time","title":"Last message at","type":"number","x-stream-index":"004"},"member_count":{"description":"Number of members in the channel","format":"int32","title":"Member count","type":"integer","x-stream-index":"012"},"members":{"description":"List of channel members (max 100)","items":{"$ref":"#/components/schemas/ChannelMember"},"title":"ChannelMembers","type":"array","x-stream-index":"011"},"mute_expires_at":{"description":"Date of mute expiration","format":"date-time","title":"Mute expires at","type":"number","x-stream-index":"015"},"muted":{"description":"Whether this channel is muted or not","title":"Muted","type":"boolean","x-stream-index":"014"},"own_capabilities":{"description":"List of channel capabilities of authenticated user","items":{"$ref":"#/components/schemas/ChannelOwnCapability"},"title":"ChannelOwnCapability","type":"array","x-stream-index":"021"},"team":{"description":"Team the channel belongs to (multi-tenant only)","title":"Team","type":"string","x-stream-index":"016"},"truncated_at":{"description":"Date of the latest truncation of the channel","format":"date-time","title":"UserResponse","type":"number","x-stream-index":"024"},"truncated_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"025"},"type":{"description":"Type of the channel","title":"Type","type":"string","x-stream-docs-page-id":"channel_features","x-stream-index":"002"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"006"}},"required":["id","type","cid","created_at","updated_at","frozen","disabled","custom"],"title":"Channel","type":"object"},"ChannelStateResponse":{"nullable":true,"properties":{"active_live_locations":{"items":{"$ref":"#/components/schemas/SharedLocationResponseData"},"type":"array","x-stream-index":"001.015"},"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001.001"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001.014"},"duration":{"type":"string","x-stream-index":"002.001"},"hidden":{"type":"boolean","x-stream-index":"001.011"},"hide_messages_before":{"format":"date-time","type":"number","x-stream-index":"001.012"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"001.007"},"membership":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"001.008"},"messages":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","x-stream-index":"001.002"},"pending_messages":{"items":{"$ref":"#/components/schemas/PendingMessageResponse"},"type":"array","x-stream-index":"001.013"},"pinned_messages":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","x-stream-index":"001.003"},"push_preferences":{"$ref":"#/components/schemas/ChannelPushPreferences","x-stream-index":"001.009"},"read":{"items":{"$ref":"#/components/schemas/ReadStateResponse"},"type":"array","x-stream-index":"001.006"},"threads":{"items":{"$ref":"#/components/schemas/ThreadStateResponse"},"type":"array","x-stream-index":"001.010"},"watcher_count":{"format":"int32","type":"integer","x-stream-index":"001.004"},"watchers":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"001.005"}},"required":["messages","pinned_messages","members","threads","duration"],"type":"object"},"ChannelStateResponseFields":{"properties":{"active_live_locations":{"description":"Active live locations in the channel","items":{"$ref":"#/components/schemas/SharedLocationResponseData"},"title":"Active Live Locations","type":"array","x-stream-index":"015"},"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"014"},"hidden":{"description":"Whether this channel is hidden or not","title":"Hidden","type":"boolean","x-stream-index":"011"},"hide_messages_before":{"description":"Messages before this date are hidden from the user","format":"date-time","title":"Hide messages before","type":"number","x-stream-index":"012"},"members":{"description":"List of channel members","items":{"$ref":"#/components/schemas/ChannelMember"},"title":"Members","type":"array","x-stream-index":"007"},"membership":{"$ref":"#/components/schemas/ChannelMember","description":"Current user membership object","title":"Membership","x-stream-index":"008"},"messages":{"description":"List of channel messages","items":{"$ref":"#/components/schemas/MessageResponse"},"title":"Message","type":"array","x-stream-index":"002"},"pending_messages":{"description":"Pending messages that this user has sent","items":{"$ref":"#/components/schemas/PendingMessageResponse"},"title":"Pending messages","type":"array","x-stream-index":"013"},"pinned_messages":{"description":"List of pinned messages in the channel","items":{"$ref":"#/components/schemas/MessageResponse"},"title":"Pinned messages","type":"array","x-stream-docs-page-id":"pinned_messages","x-stream-index":"003"},"push_preferences":{"$ref":"#/components/schemas/ChannelPushPreferences","x-stream-index":"009"},"read":{"description":"List of read states","items":{"$ref":"#/components/schemas/ReadStateResponse"},"title":"Read","type":"array","x-stream-index":"006"},"threads":{"items":{"$ref":"#/components/schemas/ThreadStateResponse"},"type":"array","x-stream-index":"010"},"watcher_count":{"description":"Number of channel watchers","format":"int32","title":"Watcher count","type":"integer","x-stream-index":"004"},"watchers":{"description":"List of user who is watching the channel","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Watchers","type":"array","x-stream-index":"005"}},"required":["messages","pinned_messages","members","threads"],"type":"object"},"ChannelStopWatchingRequest":{"nullable":true,"type":"object"},"ChannelTruncatedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001.004"},"channel_id":{"type":"string","x-stream-index":"001.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"001.005"},"channel_type":{"type":"string","x-stream-index":"001.003"},"cid":{"type":"string","x-stream-index":"001.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"type":{"default":"channel.truncated","type":"string","x-stream-index":"002.001"}},"required":["cid","channel_id","channel_type","channel_member_count","type","created_at"],"title":"ChannelTruncatedEvent","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"},"ChannelUnFrozenEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"channel.unfrozen","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"ChannelUnFrozenEvent","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"},"ChannelUpdatedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"004.004"},"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"004.005"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"002.001"},"type":{"default":"channel.updated","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"ChannelUpdatedEvent","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"},"ChannelVisibleEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"001.002"},"channel_type":{"type":"string","x-stream-index":"001.003"},"cid":{"type":"string","x-stream-index":"001.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"type":{"default":"channel.visible","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"ChannelVisibleEvent","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"},"ChatActivityStatsResponse":{"properties":{"Messages":{"$ref":"#/components/schemas/MessageStatsResponse","x-stream-index":"001"}},"type":"object"},"ClosedCaptionEvent":{"description":"This event is sent when closed captions are being sent in a call, clients should use this to show the closed captions in the call screen","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"closed_caption":{"$ref":"#/components/schemas/CallClosedCaption","description":"The closed caption object","title":"CallClosedCaption","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.closed_caption","description":"The type of event: \"call.closed_caption\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","closed_caption"],"title":"ClosedCaptionEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CollectUserFeedbackRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"009"},"rating":{"format":"int32","maximum":5,"minimum":1,"type":"integer","x-stream-index":"007"},"reason":{"maxLength":1000,"type":"string","x-stream-index":"008"},"sdk":{"maxLength":50,"type":"string","x-stream-index":"005"},"sdk_version":{"maxLength":50,"type":"string","x-stream-index":"006"},"user_session_id":{"maxLength":50,"type":"string","x-stream-index":"004"}},"required":["sdk","sdk_version","rating"],"type":"object"},"CollectUserFeedbackResponse":{"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"},"Command":{"description":"Represents custom chat command","nullable":true,"properties":{"args":{"description":"Arguments help text, shown in commands auto-completion","title":"Arguments","type":"string","x-stream-index":"006"},"created_at":{"description":"Date/time of creation","format":"date-time","readOnly":true,"title":"Created at","type":"number","x-stream-index":"001"},"description":{"description":"Description, shown in commands auto-completion","title":"Description","type":"string","x-stream-index":"005"},"name":{"description":"Unique command name","title":"Name","type":"string","x-stream-index":"004"},"set":{"description":"Set name used for grouping commands","title":"Set","type":"string","x-stream-index":"007"},"updated_at":{"description":"Date/time of the last update","format":"date-time","readOnly":true,"title":"Updated at","type":"number","x-stream-index":"002"}},"required":["name","description","args","set"],"title":"Command","type":"object"},"CompositeAppSettings":{"properties":{"json_encoded_settings":{"type":"string","x-stream-index":"005"},"url":{"type":"string","x-stream-index":"004"}},"type":"object"},"ConfigOverrides":{"properties":{"blocklist":{"type":"string","x-stream-index":"008"},"blocklist_behavior":{"enum":["flag","block"],"type":"string","x-stream-index":"009"},"commands":{"items":{"type":"string"},"type":"array","x-stream-index":"011"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"010"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"007"},"quotes":{"type":"boolean","x-stream-index":"004"},"reactions":{"type":"boolean","x-stream-index":"002"},"replies":{"type":"boolean","x-stream-index":"003"},"shared_locations":{"type":"boolean","x-stream-index":"013"},"typing_events":{"type":"boolean","x-stream-index":"001"},"uploads":{"type":"boolean","x-stream-index":"005"},"url_enrichment":{"type":"boolean","x-stream-index":"006"},"user_message_reminders":{"type":"boolean","x-stream-index":"012"}},"required":["grants","commands"],"type":"object"},"ConfigResponse":{"properties":{"ai_image_config":{"$ref":"#/components/schemas/AIImageConfig","description":"Configuration for AI image analysis","title":"AI Image Config","x-stream-index":"009"},"ai_text_config":{"$ref":"#/components/schemas/AITextConfig","description":"Configuration for AI text analysis","title":"AI Text Config","x-stream-index":"008"},"ai_video_config":{"$ref":"#/components/schemas/AIVideoConfig","description":"Configuration for AI video analysis","title":"AI Video Config","x-stream-index":"010"},"async":{"description":"Whether moderation should be performed asynchronously","title":"Async","type":"boolean","x-stream-index":"003"},"automod_platform_circumvention_config":{"$ref":"#/components/schemas/AutomodPlatformCircumventionConfig","description":"Configuration for platform circumvention detection","title":"Automod Platform Circumvention Config","x-stream-index":"005"},"automod_semantic_filters_config":{"$ref":"#/components/schemas/AutomodSemanticFiltersConfig","description":"Configuration for semantic filtering","title":"Automod Semantic Filters Config","x-stream-index":"006"},"automod_toxicity_config":{"$ref":"#/components/schemas/AutomodToxicityConfig","description":"Configuration for toxicity detection","title":"Automod Toxicity Config","x-stream-index":"004"},"block_list_config":{"$ref":"#/components/schemas/BlockListConfig","description":"Configuration for block list filtering","title":"Block List Config","x-stream-index":"007"},"created_at":{"description":"When the configuration was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"012"},"key":{"description":"Unique identifier for the moderation configuration","title":"Key","type":"string","x-stream-index":"001"},"rule_builder_config":{"$ref":"#/components/schemas/RuleBuilderConfig","x-stream-index":"015"},"team":{"description":"Team associated with the configuration","title":"Team","type":"string","x-stream-index":"002"},"updated_at":{"description":"When the configuration was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"013"},"velocity_filter_config":{"$ref":"#/components/schemas/VelocityFilterConfig","description":"Configuration for velocity-based filtering","title":"Velocity Filter Config","x-stream-index":"011"},"video_call_rule_config":{"$ref":"#/components/schemas/VideoCallRuleConfig","x-stream-index":"014"}},"required":["key","team","async","created_at","updated_at"],"type":"object"},"ConnectUserDetailsRequest":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001"},"image":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"006"},"language":{"type":"string","x-stream-index":"005"},"name":{"type":"string","x-stream-index":"002"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"007"}},"required":["id"],"type":"object"},"ConnectedEvent":{"description":"This event is sent when the WS connection is established and authenticated, this event contains the full user object as it is stored on the server","properties":{"connection_id":{"description":"The connection_id for this client","title":"Connection ID","type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"me":{"$ref":"#/components/schemas/OwnUserResponse","description":"The full user object as it is stored on the server","title":"OwnUserResponse","x-stream-index":"003"},"type":{"default":"connection.ok","description":"The type of event: \"connection.ok\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","connection_id","me"],"title":"ConnectedEvent","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"},"ConnectionErrorEvent":{"description":"This event is sent when the WS connection fails","properties":{"connection_id":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"error":{"$ref":"#/components/schemas/APIError","description":"The error that caused the connection to fail","title":"Error","x-stream-index":"003"},"type":{"default":"connection.error","description":"The type of event: \"connection.ok\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","connection_id","error"],"title":"ConnectionErrorEvent","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"},"ContentCountRuleParameters":{"properties":{"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"required":["threshold","time_window"],"type":"object"},"CountByMinuteResponse":{"nullable":true,"properties":{"count":{"format":"int32","type":"integer","x-stream-index":"002"},"start_ts":{"format":"date-time","type":"number","x-stream-index":"001"}},"required":["start_ts","count"],"type":"object"},"CreateBlockListRequest":{"description":"Block list contains restricted words","nullable":true,"properties":{"name":{"description":"Block list name","maxLength":255,"title":"Name","type":"string","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"004"},"type":{"description":"Block list type.","enum":["regex","domain","domain_allowlist","email","word"],"title":"Type","type":"string","x-stream-index":"003"},"words":{"description":"List of words to block","items":{"type":"string"},"minimum":1,"title":"Words","type":"array","x-stream-index":"002"}},"required":["name","words"],"title":"Block list","type":"object","x-stream-docs-page-id":"block_lists"},"CreateBlockListResponse":{"description":"Basic response information","nullable":true,"properties":{"blocklist":{"$ref":"#/components/schemas/BlockListResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["duration"],"title":"Response","type":"object"},"CreateDeviceRequest":{"description":"Create device request","nullable":true,"properties":{"id":{"description":"Device ID","maxLength":255,"minLength":1,"title":"ID","type":"string","x-stream-index":"001"},"push_provider":{"description":"Push provider","enum":["firebase","apn","huawei","xiaomi"],"title":"PushProvider","type":"string","x-stream-index":"002"},"push_provider_name":{"description":"Push provider name","title":"PushProviderName","type":"string","x-stream-index":"003"},"voip_token":{"description":"When true the token is for Apple VoIP push notifications","title":"VoipToken","type":"boolean","x-stream-index":"004"}},"required":["id","push_provider"],"title":"CreateDeviceRequest","type":"object"},"CreateDraftRequest":{"nullable":true,"properties":{"message":{"$ref":"#/components/schemas/MessageRequest","x-stream-index":"001"}},"required":["message"],"type":"object"},"CreateDraftResponse":{"description":"Basic response information","nullable":true,"properties":{"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["draft","duration"],"title":"Response","type":"object"},"CreateGuestRequest":{"nullable":true,"properties":{"user":{"$ref":"#/components/schemas/UserRequest","description":"User object which server acts upon","title":"User","x-stream-index":"001"}},"required":["user"],"type":"object"},"CreateGuestResponse":{"nullable":true,"properties":{"access_token":{"description":"the access token to authenticate the user","title":"Access token","type":"string","x-stream-index":"002"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User object which server acts upon","title":"User","x-stream-index":"001"}},"required":["user","access_token","duration"],"type":"object"},"CreatePollOptionRequest":{"nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"003"},"text":{"description":"Option text","title":"string","type":"string","x-stream-index":"002"}},"required":["text"],"type":"object"},"CreatePollRequest":{"description":"Contains all information needed to create a new poll","nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"011"},"allow_answers":{"description":"Indicates whether users can suggest user defined answers","title":"Allow answers","type":"boolean","x-stream-index":"009"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"008"},"description":{"description":"A description of the poll","title":"Description","type":"string","x-stream-index":"003"},"enforce_unique_vote":{"description":"Indicates whether users can cast multiple votes","title":"Multiple choice","type":"boolean","x-stream-index":"006"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"is_closed":{"description":"Indicates whether the poll is open for voting","title":"Is closed","type":"boolean","x-stream-index":"010"},"max_votes_allowed":{"description":"Indicates the maximum amount of votes a user can cast","format":"int32","maximum":10,"title":"Maximum votes allowed","type":"integer","x-stream-index":"007"},"name":{"description":"The name of the poll","title":"Name","type":"string","x-stream-index":"002"},"options":{"items":{"$ref":"#/components/schemas/PollOptionInput"},"maximum":100,"type":"array","x-stream-index":"004"},"voting_visibility":{"enum":["anonymous","public"],"type":"string","x-stream-index":"005"}},"required":["name"],"title":"Create Poll Request","type":"object"},"CreateReminderRequest":{"nullable":true,"properties":{"remind_at":{"format":"date-time","type":"number","x-stream-index":"001"}},"type":"object"},"Credentials":{"properties":{"ice_servers":{"items":{"$ref":"#/components/schemas/ICEServer"},"type":"array","x-stream-index":"003"},"server":{"$ref":"#/components/schemas/SFUResponse","x-stream-index":"001"},"token":{"type":"string","x-stream-index":"002"}},"required":["server","token","ice_servers"],"type":"object"},"CustomActionRequest":{"properties":{"id":{"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"type":"object"},"CustomVideoEvent":{"description":"A custom event, this event is used to send custom events to other participants in the call.","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"003"},"type":{"default":"custom","description":"The type of event, \"custom\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"004"}},"required":["type","created_at","call_cid","custom","user"],"title":"CustomVideoEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"DailyAggregateCallDurationReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/CallDurationReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateCallParticipantCountReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/CallParticipantCountReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateCallsPerDayReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/CallsPerDayReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateQualityScoreReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/QualityScoreReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateSDKUsageReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/SDKUsageReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateUserFeedbackReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/UserFeedbackReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"Data":{"properties":{"id":{"type":"string","x-stream-index":"001"}},"required":["id"],"type":"object"},"DeleteActivityRequest":{"properties":{"hard_delete":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"DeleteCallRequest":{"description":"DeleteCallRequest is the payload for deleting a call.","nullable":true,"properties":{"hard":{"description":"if true the call will be hard deleted along with all related data","title":"Hard","type":"boolean","x-stream-index":"001"}},"title":"DeleteCallRequest","type":"object"},"DeleteCallResponse":{"description":"DeleteCallResponse is the payload for deleting a call.","nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","title":"Call","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"task_id":{"title":"TaskID","type":"string","x-stream-index":"002"}},"required":["call","duration"],"title":"DeleteCallResponse","type":"object"},"DeleteChannelResponse":{"description":"Basic response information","nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"Response","type":"object"},"DeleteChannelsRequest":{"nullable":true,"properties":{"cids":{"description":"All channels that should be deleted","items":{"type":"string"},"maximum":100,"minimum":1,"title":"Channels CID","type":"array","x-stream-index":"001"},"hard_delete":{"description":"Specify if channels and all ressources should be hard deleted","title":"Hard delete","type":"boolean","x-stream-index":"002"}},"required":["cids"],"type":"object"},"DeleteChannelsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"result":{"additionalProperties":{"$ref":"#/components/schemas/DeleteChannelsResultResponse"},"description":"Map of channel IDs and their deletion results","title":"Result","type":"object","x-stream-index":"001"},"task_id":{"type":"string","x-stream-index":"002"}},"required":["duration"],"type":"object"},"DeleteChannelsResultResponse":{"nullable":true,"properties":{"error":{"type":"string","x-stream-index":"002"},"status":{"type":"string","x-stream-index":"001"}},"required":["status"],"type":"object"},"DeleteMessageRequest":{"properties":{"hard_delete":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"DeleteMessageResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001"}},"required":["message","duration"],"title":"Response","type":"object"},"DeleteModerationConfigResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"DeleteReactionRequest":{"properties":{"hard_delete":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"DeleteReactionResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001"},"reaction":{"$ref":"#/components/schemas/ReactionResponse","x-stream-index":"002"}},"required":["message","reaction","duration"],"title":"Response","type":"object"},"DeleteRecordingResponse":{"description":"Response for DeleteRecording","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"DeleteRecordingResponse","type":"object"},"DeleteReminderResponse":{"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"},"DeleteTranscriptionResponse":{"description":"DeleteTranscriptionResponse is the payload for deleting a transcription.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"DeleteTranscriptionResponse","type":"object"},"DeleteUserRequest":{"properties":{"delete_conversation_channels":{"type":"boolean","x-stream-index":"003"},"delete_feeds_content":{"type":"boolean","x-stream-index":"004"},"hard_delete":{"type":"boolean","x-stream-index":"001"},"mark_messages_deleted":{"type":"boolean","x-stream-index":"002"}},"type":"object"},"Device":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"disabled":{"type":"boolean","x-stream-index":"002.003"},"disabled_reason":{"type":"string","x-stream-index":"002.004"},"id":{"type":"string","x-stream-index":"002.001.004"},"push_provider":{"enum":["firebase","apn","huawei","xiaomi"],"type":"string","x-stream-index":"002.001.001"},"push_provider_name":{"type":"string","x-stream-index":"002.001.003"},"user_id":{"type":"string","x-stream-index":"004"},"voip":{"type":"boolean","x-stream-index":"002.001.005"}},"required":["push_provider","id","created_at","user_id"],"type":"object"},"DeviceResponse":{"description":"Response for Device","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"004"},"disabled":{"description":"Whether device is disabled or not","title":"Disabled","type":"boolean","x-stream-index":"005"},"disabled_reason":{"description":"Reason explaining why device had been disabled","title":"Reason","type":"string","x-stream-index":"006"},"id":{"description":"Device ID","title":"ID","type":"string","x-stream-index":"003"},"push_provider":{"description":"Push provider","title":"PushProvider","type":"string","x-stream-index":"001"},"push_provider_name":{"description":"Push provider name","title":"PushProviderName","type":"string","x-stream-index":"002"},"user_id":{"description":"User ID","title":"UserID","type":"string","x-stream-index":"008"},"voip":{"description":"When true the token is for Apple VoIP push notifications","title":"Voip","type":"boolean","x-stream-index":"007"}},"required":["push_provider","id","created_at","user_id"],"title":"DeviceResponse","type":"object"},"DraftDeletedEvent":{"description":"Emitted when a Draft is deleted.","nullable":true,"properties":{"cid":{"description":"The CID of the channel where the draft was created","title":"Channel CID","type":"string","x-stream-index":"001.001.002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.001.007"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001.003"},"parent_id":{"description":"The ID of the parent message","title":"Message ID","type":"string","x-stream-index":"001.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.001.004"},"type":{"default":"draft.deleted","description":"The type of event: \"draft.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.001.002"}},"required":["type","created_at","custom"],"title":"DraftDeletedEvent","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"},"DraftPayloadResponse":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"html":{"type":"string","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"001"},"mentioned_users":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"008"},"mml":{"type":"string","x-stream-index":"003"},"parent_id":{"type":"string","x-stream-index":"005"},"poll_id":{"type":"string","x-stream-index":"013"},"quoted_message_id":{"type":"string","x-stream-index":"009"},"show_in_channel":{"type":"boolean","x-stream-index":"006"},"silent":{"type":"boolean","x-stream-index":"012"},"text":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"011"}},"required":["id","text","custom"],"type":"object"},"DraftResponse":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003"},"channel_cid":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"message":{"$ref":"#/components/schemas/DraftPayloadResponse","x-stream-index":"001"},"parent_id":{"type":"string","x-stream-index":"004"},"parent_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"005"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"006"}},"required":["message","channel_cid","created_at"],"type":"object"},"DraftUpdatedEvent":{"description":"Emitted when a Draft is created or updated.","nullable":true,"properties":{"cid":{"description":"The CID of the channel where the draft was created/updated","title":"Channel CID","type":"string","x-stream-index":"001.001.002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.001.007"},"draft":{"$ref":"#/components/schemas/DraftResponse","description":"The draft object which was created/updated","title":"Draft","x-stream-index":"001.003"},"parent_id":{"description":"The ID of the parent message","title":"Parent ID","type":"string","x-stream-index":"001.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.001.004"},"type":{"default":"draft.updated","description":"The type of event: \"draft.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.001.002"}},"required":["type","created_at","custom"],"title":"DraftUpdatedEvent","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"},"EdgeResponse":{"properties":{"continent_code":{"type":"string","x-stream-index":"007.003"},"country_iso_code":{"type":"string","x-stream-index":"007.002"},"green":{"format":"int32","type":"integer","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"latency_test_url":{"type":"string","x-stream-index":"002"},"latitude":{"format":"float","type":"number","x-stream-index":"006.001"},"longitude":{"format":"float","type":"number","x-stream-index":"006.002"},"red":{"format":"int32","type":"integer","x-stream-index":"005"},"subdivision_iso_code":{"type":"string","x-stream-index":"007.001"},"yellow":{"format":"int32","type":"integer","x-stream-index":"004"}},"required":["id","latency_test_url","green","yellow","red","latitude","longitude","subdivision_iso_code","country_iso_code","continent_code"],"type":"object"},"EgressHLSResponse":{"properties":{"playlist_url":{"type":"string","x-stream-index":"001"},"status":{"type":"string","x-stream-index":"002"}},"required":["playlist_url","status"],"type":"object"},"EgressRTMPResponse":{"properties":{"name":{"type":"string","x-stream-index":"001"},"started_at":{"format":"date-time","type":"number","x-stream-index":"004"},"stream_key":{"type":"string","x-stream-index":"003"},"stream_url":{"type":"string","x-stream-index":"002"}},"required":["name","started_at"],"type":"object"},"EgressResponse":{"properties":{"broadcasting":{"type":"boolean","x-stream-index":"001"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordingResponse","x-stream-index":"004"},"hls":{"$ref":"#/components/schemas/EgressHLSResponse","x-stream-index":"002"},"rtmps":{"items":{"$ref":"#/components/schemas/EgressRTMPResponse"},"type":"array","x-stream-index":"003"}},"required":["broadcasting","rtmps"],"type":"object"},"EgressTaskConfig":{"properties":{"egress_user":{"$ref":"#/components/schemas/EgressUser","x-stream-index":"008"},"frame_recording_egress_config":{"$ref":"#/components/schemas/FrameRecordingEgressConfig","x-stream-index":"009"},"hls_egress_config":{"$ref":"#/components/schemas/HLSEgressConfig","x-stream-index":"007"},"recording_egress_config":{"$ref":"#/components/schemas/RecordingEgressConfig","x-stream-index":"006"},"rtmp_egress_config":{"$ref":"#/components/schemas/RTMPEgressConfig","x-stream-index":"004"},"stt_egress_config":{"$ref":"#/components/schemas/STTEgressConfig","x-stream-index":"005"}},"type":"object"},"EgressUser":{"properties":{"token":{"type":"string","x-stream-index":"004"}},"type":"object"},"EndCallRequest":{"description":"Request for ending a call","nullable":true,"title":"EndCallRequest","type":"object"},"EndCallResponse":{"description":"Response for ending a call","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"EndCallResponse","type":"object"},"EnrichedActivity":{"properties":{"actor":{"$ref":"#/components/schemas/Data","x-stream-index":"002"},"foreign_id":{"type":"string","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"latest_reactions":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"013"},"object":{"$ref":"#/components/schemas/Data","x-stream-index":"004"},"origin":{"$ref":"#/components/schemas/Data","x-stream-index":"008"},"own_reactions":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"012"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"011"},"score":{"format":"float","type":"number","x-stream-index":"010"},"target":{"$ref":"#/components/schemas/Data","x-stream-index":"006"},"to":{"items":{"type":"string"},"type":"array","x-stream-index":"009"},"verb":{"type":"string","x-stream-index":"003"}},"type":"object"},"EnrichedReaction":{"nullable":true,"properties":{"activity_id":{"type":"string","x-stream-index":"003"},"children_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"010"},"created_at":{"$ref":"#/components/schemas/Time","x-stream-index":"012"},"data":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"kind":{"type":"string","x-stream-index":"002"},"latest_children":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"008"},"own_children":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"009"},"parent":{"type":"string","x-stream-index":"007"},"target_feeds":{"items":{"type":"string"},"type":"array","x-stream-index":"006"},"updated_at":{"$ref":"#/components/schemas/Time","x-stream-index":"013"},"user":{"$ref":"#/components/schemas/Data","x-stream-index":"011"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["kind","activity_id","user_id"],"type":"object"},"EntityCreator":{"properties":{"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"001.046"},"ban_count":{"format":"int32","type":"integer","x-stream-index":"002"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"001.017"},"banned":{"type":"boolean","x-stream-index":"001.016"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.013"},"deleted_content_count":{"format":"int32","type":"integer","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"001.023"},"language":{"type":"string","x-stream-index":"001.035"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"001.022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"001.026"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.042"},"role":{"type":"string","x-stream-index":"001.004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.005"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.009"}},"required":["id","role","teams_role","custom","banned","online","ban_count","deleted_content_count"],"type":"object"},"EntityCreatorResponse":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.001.018"},"ban_count":{"description":"Number of minor actions performed on the user","format":"int32","title":"Ban Count","type":"integer","x-stream-index":"002"},"banned":{"type":"boolean","x-stream-index":"001.001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.001.017"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.001.016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.001.011"},"deleted_content_count":{"description":"Number of major actions performed on the user","format":"int32","title":"Deleted Content Count","type":"integer","x-stream-index":"003"},"flagged_count":{"description":"Number of flag actions performed on the user","format":"int32","title":"Flagged Count","type":"integer","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001.001.001"},"image":{"type":"string","x-stream-index":"001.001.003"},"language":{"type":"string","x-stream-index":"001.001.005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"001.001.014"},"name":{"type":"string","x-stream-index":"001.001.002"},"online":{"type":"boolean","x-stream-index":"001.001.013"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.001.015"},"role":{"type":"string","x-stream-index":"001.001.006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.001.008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids","shadow_banned","invisible","ban_count","deleted_content_count","flagged_count"],"type":"object"},"EventNotificationSettings":{"properties":{"apns":{"$ref":"#/components/schemas/APNS","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"fcm":{"$ref":"#/components/schemas/FCM","x-stream-index":"003"}},"required":["enabled","apns","fcm"],"type":"object"},"EventRequest":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"parent_id":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"001"}},"required":["type"],"type":"object"},"EventResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"event":{"$ref":"#/components/schemas/WSEvent","x-stream-index":"001"}},"required":["event","duration"],"title":"Response","type":"object"},"ExternalStorage":{"properties":{"abs_account_name":{"type":"string","x-stream-index":"011"},"abs_client_id":{"type":"string","x-stream-index":"013"},"abs_client_secret":{"type":"string","x-stream-index":"014"},"abs_tenant_id":{"type":"string","x-stream-index":"012"},"bucket":{"type":"string","x-stream-index":"005"},"gcs_credentials":{"type":"string","x-stream-index":"010"},"path":{"type":"string","x-stream-index":"006"},"s3_api_key":{"type":"string","x-stream-index":"007"},"s3_custom_endpoint":{"type":"string","x-stream-index":"016"},"s3_region":{"type":"string","x-stream-index":"009"},"s3_secret_key":{"type":"string","x-stream-index":"008"},"storage_name":{"type":"string","x-stream-index":"015"},"storage_type":{"type":"integer","x-stream-index":"004"}},"type":"object"},"FCM":{"properties":{"data":{"additionalProperties":{},"type":"object","x-stream-index":"001"}},"type":"object"},"Field":{"nullable":true,"properties":{"short":{"type":"boolean","x-stream-index":"003"},"title":{"type":"string","x-stream-index":"001"},"value":{"type":"string","x-stream-index":"002"}},"required":["title","value","short"],"type":"object"},"FileUploadConfig":{"properties":{"allowed_file_extensions":{"items":{"type":"string"},"type":"array","x-stream-index":"001"},"allowed_mime_types":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"blocked_file_extensions":{"items":{"type":"string"},"type":"array","x-stream-index":"002"},"blocked_mime_types":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"size_limit":{"format":"int32","maximum":104857600,"minimum":0,"type":"integer","x-stream-index":"005"}},"required":["allowed_file_extensions","blocked_file_extensions","allowed_mime_types","blocked_mime_types","size_limit"],"type":"object"},"FileUploadRequest":{"nullable":true,"properties":{"file":{"description":"file field","title":"File","type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/OnlyUserID","description":"user for the request **server side only**","title":"User","x-stream-index":"002"}},"type":"object"},"FileUploadResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"file":{"description":"URL to the uploaded asset. Should be used to put to `asset_url` attachment field","title":"File","type":"string","x-stream-index":"001"},"thumb_url":{"description":"URL of the file thumbnail for supported file formats. Should be put to `thumb_url` attachment field","title":"Thumbnail URL","type":"string","x-stream-index":"002"}},"required":["duration"],"type":"object"},"Flag":{"description":"Contains information about flagged user or message","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"019"},"custom":{"additionalProperties":{},"description":"Additional metadata about the flag","title":"Custom","type":"object","x-stream-index":"014"},"entity_creator_id":{"description":"ID of the user who created the flagged entity","title":"Entity Creator ID","type":"string","x-stream-index":"009"},"entity_id":{"description":"Unique identifier of the entity being flagged","title":"Entity ID","type":"string","x-stream-index":"008"},"entity_type":{"description":"Type of entity being flagged (e.g., message, user)","title":"Entity Type","type":"string","x-stream-index":"007"},"is_streamed_content":{"type":"boolean","x-stream-index":"012"},"labels":{"description":"Labels from bodyguard, API calls, our own AI etc","items":{"type":"string"},"title":"Labels","type":"array","x-stream-index":"015"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content being flagged","title":"Moderation Payload","x-stream-index":"010"},"moderation_payload_hash":{"type":"string","x-stream-index":"011"},"reason":{"description":"Optional explanation for why the content is being flagged","title":"Reason","type":"string","x-stream-index":"013"},"result":{"description":"Result of bodyguard, API calls, our own AI etc","items":{"additionalProperties":{},"type":"object"},"title":"Result","type":"array","x-stream-index":"016"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"018"},"review_queue_item_id":{"description":"ID of the review queue item","title":"Review Queue Item ID","type":"string","x-stream-index":"017"},"type":{"type":"string","x-stream-index":"004"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"020"},"user":{"$ref":"#/components/schemas/User","description":"User who flagged a message or a user","title":"User","x-stream-index":"006"}},"required":["entity_type","entity_id","result","created_at","updated_at"],"title":"Flag","type":"object"},"FlagContentOptions":{"properties":{"reason":{"type":"string","x-stream-index":"001"}},"required":["reason"],"type":"object"},"FlagDetails":{"properties":{"Extra":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"002"},"automod":{"$ref":"#/components/schemas/AutomodDetails","x-stream-index":"001"},"original_text":{"type":"string","x-stream-index":"003"}},"required":["Extra","original_text"],"type":"object"},"FlagFeedback":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"005"},"labels":{"items":{"$ref":"#/components/schemas/Label"},"type":"array","x-stream-index":"006"},"message_id":{"type":"string","x-stream-index":"004"}},"required":["message_id","created_at","labels"],"type":"object"},"FlagMessageDetails":{"properties":{"pin_changed":{"type":"boolean","x-stream-index":"002"},"should_enrich":{"type":"boolean","x-stream-index":"003"},"skip_push":{"type":"boolean","x-stream-index":"004"},"updated_by_id":{"type":"string","x-stream-index":"001"}},"type":"object"},"FlagRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"description":"Additional metadata about the flag","title":"Custom","type":"object","x-stream-index":"006"},"entity_creator_id":{"description":"ID of the user who created the flagged entity","title":"Entity Creator ID","type":"string","x-stream-index":"003"},"entity_id":{"description":"Unique identifier of the entity being flagged","title":"Entity ID","type":"string","x-stream-index":"002"},"entity_type":{"description":"Type of entity being flagged (e.g., message, user)","title":"Entity Type","type":"string","x-stream-index":"001"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content being flagged","title":"Moderation Payload","x-stream-index":"005"},"reason":{"description":"Optional explanation for why the content is being flagged","maxLength":255,"title":"Reason","type":"string","x-stream-index":"004"}},"required":["entity_type","entity_id"],"type":"object"},"FlagResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"item_id":{"description":"Unique identifier of the created moderation item","title":"Item ID","type":"string","x-stream-index":"001"}},"required":["item_id","duration"],"type":"object"},"FlagUserOptions":{"properties":{"reason":{"type":"string","x-stream-index":"001"}},"required":["reason"],"type":"object"},"FrameRecordSettings":{"properties":{"capture_interval_in_seconds":{"format":"int32","maximum":60,"minimum":2,"type":"integer","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"},"quality":{"type":"string","x-stream-index":"002"}},"required":["mode","capture_interval_in_seconds"],"type":"object"},"FrameRecordingEgressConfig":{"properties":{"capture_interval_in_seconds":{"format":"int32","type":"integer","x-stream-index":"007"},"external_storage":{"$ref":"#/components/schemas/ExternalStorage","x-stream-index":"006"},"quality":{"$ref":"#/components/schemas/Quality","x-stream-index":"004"},"storage_name":{"type":"string","x-stream-index":"005"}},"type":"object"},"FrameRecordingResponse":{"properties":{"status":{"type":"string","x-stream-index":"001"}},"required":["status"],"type":"object"},"FrameRecordingSettingsRequest":{"properties":{"capture_interval_in_seconds":{"format":"int32","maximum":60,"minimum":2,"type":"integer","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"},"quality":{"enum":["360p","480p","720p","1080p","1440p"],"type":"string","x-stream-index":"002"}},"required":["mode","capture_interval_in_seconds"],"type":"object"},"FrameRecordingSettingsResponse":{"properties":{"capture_interval_in_seconds":{"format":"int32","maximum":60,"minimum":2,"type":"integer","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"},"quality":{"type":"string","x-stream-index":"002"}},"required":["mode","capture_interval_in_seconds"],"type":"object"},"FullUserResponse":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"015"},"banned":{"type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"014"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.011"},"devices":{"items":{"$ref":"#/components/schemas/DeviceResponse"},"type":"array","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001.001"},"image":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"005"},"language":{"type":"string","x-stream-index":"001.005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"001.014"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"012"},"mutes":{"items":{"$ref":"#/components/schemas/UserMuteResponse"},"type":"array","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"001.002"},"online":{"type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"003"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.015"},"role":{"type":"string","x-stream-index":"001.006"},"shadow_banned":{"type":"boolean","x-stream-index":"013"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"009"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"010"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"008"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"011"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","devices","invisible","mutes","channel_mutes","unread_count","total_unread_count","unread_channels","unread_threads","shadow_banned","blocked_user_ids"],"type":"object"},"GeofenceSettings":{"properties":{"names":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"required":["names"],"type":"object"},"GeofenceSettingsRequest":{"properties":{"names":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"type":"object"},"GeofenceSettingsResponse":{"properties":{"names":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"required":["names"],"type":"object"},"GetApplicationResponse":{"description":"Basic response information","nullable":true,"properties":{"app":{"$ref":"#/components/schemas/AppResponseFields","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["app","duration"],"title":"Response","type":"object"},"GetBlockedUsersResponse":{"nullable":true,"properties":{"blocks":{"description":"Array of blocked user object","items":{"$ref":"#/components/schemas/BlockedUserResponse"},"title":"Blocks","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["blocks","duration"],"type":"object"},"GetCallReportResponse":{"description":"Basic response information","nullable":true,"properties":{"chat_activity":{"$ref":"#/components/schemas/ChatActivityStatsResponse","x-stream-index":"004"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"report":{"$ref":"#/components/schemas/ReportResponse","x-stream-index":"003"},"session_id":{"type":"string","x-stream-index":"002"},"video_reactions":{"items":{"$ref":"#/components/schemas/VideoReactionsResponse"},"type":"array","x-stream-index":"005"}},"required":["duration","session_id","report"],"title":"Response","type":"object"},"GetCallResponse":{"nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001.001"},"duration":{"type":"string","x-stream-index":"002.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001.002"},"membership":{"$ref":"#/components/schemas/MemberResponse","x-stream-index":"001.003"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"001.004"}},"required":["call","members","own_capabilities","blocked_users","duration"],"title":"GetCallResponse","type":"object"},"GetConfigResponse":{"nullable":true,"properties":{"config":{"$ref":"#/components/schemas/ConfigResponse","description":"The retrieved moderation configuration","title":"Config","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["duration"],"type":"object"},"GetDraftResponse":{"description":"Basic response information","nullable":true,"properties":{"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["draft","duration"],"title":"Response","type":"object"},"GetEdgesResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"edges":{"items":{"$ref":"#/components/schemas/EdgeResponse"},"type":"array","x-stream-index":"001"}},"required":["edges","duration"],"title":"Response","type":"object"},"GetManyMessagesResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.002.001"},"messages":{"description":"List of messages","items":{"$ref":"#/components/schemas/MessageResponse"},"title":"Messages","type":"array","x-stream-index":"001.001"}},"required":["messages","duration"],"type":"object"},"GetMessageResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageWithChannelResponse","x-stream-index":"001"},"pending_message_metadata":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"002"}},"required":["message","duration"],"title":"Response","type":"object"},"GetOGResponse":{"nullable":true,"properties":{"actions":{"items":{"$ref":"#/components/schemas/Action"},"type":"array","x-stream-index":"001.015"},"asset_url":{"description":"URL of detected video or audio","title":"Image URL","type":"string","x-stream-index":"001.017"},"author_icon":{"type":"string","x-stream-index":"001.007"},"author_link":{"description":"og:site","title":"Author Link","type":"string","x-stream-index":"001.006"},"author_name":{"description":"og:site_name","title":"Author Name","type":"string","x-stream-index":"001.005"},"color":{"type":"string","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.018"},"duration":{"type":"string","x-stream-index":"002.001"},"fallback":{"type":"string","x-stream-index":"001.002"},"fields":{"items":{"$ref":"#/components/schemas/Field"},"type":"array","x-stream-index":"001.016"},"footer":{"type":"string","x-stream-index":"001.013"},"footer_icon":{"type":"string","x-stream-index":"001.014"},"giphy":{"$ref":"#/components/schemas/Images","x-stream-index":"001.019"},"image_url":{"description":"URL of detected image","title":"Image URL","type":"string","x-stream-index":"001.011"},"og_scrape_url":{"description":"extracted url from the text","title":"OG Scrape URL","type":"string","x-stream-index":"001.020"},"original_height":{"format":"int32","type":"integer","x-stream-index":"001.022"},"original_width":{"format":"int32","type":"integer","x-stream-index":"001.021"},"pretext":{"type":"string","x-stream-index":"001.004"},"text":{"description":"og:description","title":"Text","type":"string","x-stream-index":"001.010"},"thumb_url":{"description":"URL of detected thumb image","title":"Image URL","type":"string","x-stream-index":"001.012"},"title":{"description":"og:title","title":"Title","type":"string","x-stream-index":"001.008"},"title_link":{"description":"og:url","title":"Title Link","type":"string","x-stream-index":"001.009"},"type":{"description":"Attachment type, could be empty, image, audio or video","title":"Type","type":"string","x-stream-index":"001.001"}},"required":["custom","duration"],"title":"Get OG Attachment","type":"object","x-stream-docs-page-id":"og"},"GetOrCreateCallRequest":{"nullable":true,"properties":{"data":{"$ref":"#/components/schemas/CallRequest","title":"ReadOnlyData","x-stream-index":"003"},"members_limit":{"format":"int32","maximum":100,"type":"integer","x-stream-index":"007"},"notify":{"description":"if provided it sends a notification event to the members for this call","title":"Notify","type":"boolean","x-stream-index":"005"},"ring":{"description":"if provided it sends a ring event to the members for this call","title":"Ring","type":"boolean","x-stream-index":"004"},"video":{"type":"boolean","x-stream-index":"006"}},"title":"GetOrCreateCallRequest","type":"object"},"GetOrCreateCallResponse":{"nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001.001"},"created":{"type":"boolean","x-stream-index":"002"},"duration":{"type":"string","x-stream-index":"003.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001.002"},"membership":{"$ref":"#/components/schemas/MemberResponse","x-stream-index":"001.003"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"001.004"}},"required":["call","members","own_capabilities","blocked_users","created","duration"],"title":"GetOrCreateCallResponse","type":"object"},"GetReactionsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"reactions":{"description":"List of reactions","items":{"$ref":"#/components/schemas/Reaction"},"title":"Reactions","type":"array","x-stream-index":"001"}},"required":["reactions","duration"],"type":"object"},"GetRepliesResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"messages":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","x-stream-index":"001"}},"required":["messages","duration"],"title":"Response","type":"object"},"GetThreadResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"thread":{"$ref":"#/components/schemas/ThreadStateResponse","description":"Enriched thread state","title":"Thread","x-stream-index":"001"}},"required":["thread","duration"],"type":"object"},"GoLiveRequest":{"nullable":true,"properties":{"recording_storage_name":{"type":"string","x-stream-index":"005"},"start_closed_caption":{"type":"boolean","x-stream-index":"008"},"start_hls":{"type":"boolean","x-stream-index":"003"},"start_recording":{"type":"boolean","x-stream-index":"004"},"start_transcription":{"type":"boolean","x-stream-index":"007"},"transcription_storage_name":{"type":"string","x-stream-index":"006"}},"title":"GoLiveRequest","type":"object"},"GoLiveResponse":{"description":"Basic response information","nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["call","duration"],"title":"Response","type":"object"},"GoogleVisionConfig":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"GroupedStatsResponse":{"nullable":true,"properties":{"name":{"type":"string","x-stream-index":"001"},"unique":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["name","unique"],"type":"object"},"HLSEgressConfig":{"properties":{"composite_app_settings":{"$ref":"#/components/schemas/CompositeAppSettings","x-stream-index":"005"},"playlist_url":{"type":"string","x-stream-index":"007"},"qualities":{"items":{"$ref":"#/components/schemas/Quality"},"type":"array","x-stream-index":"004"},"start_unix_nano":{"format":"int64","type":"integer","x-stream-index":"006"}},"type":"object"},"HLSSettings":{"properties":{"auto_on":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"004"},"quality_tracks":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"required":["auto_on","enabled","quality_tracks"],"type":"object"},"HLSSettingsRequest":{"properties":{"auto_on":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"quality_tracks":{"items":{"type":"string"},"maximum":3,"minimum":1,"type":"array","x-stream-index":"003"}},"required":["quality_tracks"],"title":"HLSSettingsRequest","type":"object"},"HLSSettingsResponse":{"description":"HLSSettings is the payload for HLS settings","properties":{"auto_on":{"title":"Auto On","type":"boolean","x-stream-index":"001"},"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"002"},"quality_tracks":{"items":{"type":"string"},"title":"Quality Tracks","type":"array","x-stream-index":"003"}},"required":["auto_on","enabled","quality_tracks","layout"],"title":"HLSSettingsResponse","type":"object"},"HarmConfig":{"properties":{"action_sequences":{"items":{"$ref":"#/components/schemas/ActionSequence"},"type":"array","x-stream-index":"001"},"severity":{"type":"integer","x-stream-index":"002"}},"required":["action_sequences","severity"],"type":"object"},"HealthCheckEvent":{"nullable":true,"properties":{"cid":{"type":"string","x-stream-index":"003"},"connection_id":{"type":"string","x-stream-index":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004.007"},"me":{"$ref":"#/components/schemas/OwnUserResponse","x-stream-index":"002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"004.004"},"type":{"default":"health.check","type":"string","x-stream-index":"004.002"}},"required":["connection_id","type","created_at","custom"],"title":"HealthCheckEvent","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"},"HideChannelRequest":{"nullable":true,"properties":{"clear_history":{"description":"Whether to clear message history of the channel or not","title":"Clear history","type":"boolean","x-stream-index":"001"}},"type":"object"},"HideChannelResponse":{"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"},"ICEServer":{"properties":{"password":{"type":"string","x-stream-index":"003"},"urls":{"items":{"type":"string"},"type":"array","x-stream-index":"001"},"username":{"type":"string","x-stream-index":"002"}},"required":["urls","username","password"],"type":"object"},"ImageContentParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"type":"object"},"ImageData":{"properties":{"frames":{"type":"string","x-stream-index":"005"},"height":{"type":"string","x-stream-index":"003"},"size":{"type":"string","x-stream-index":"004"},"url":{"type":"string","x-stream-index":"001"},"width":{"type":"string","x-stream-index":"002"}},"required":["url","width","height","size","frames"],"type":"object"},"ImageRuleParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"required":["threshold","time_window"],"type":"object"},"ImageSize":{"properties":{"crop":{"description":"Crop mode","enum":["top","bottom","left","right","center"],"title":"Crop","type":"string","x-stream-index":"001"},"height":{"description":"Target image height","format":"int32","title":"Height","type":"integer","x-stream-index":"003"},"resize":{"description":"Resize method","enum":["clip","crop","scale","fill"],"title":"Resize","type":"string","x-stream-index":"002"},"width":{"description":"Target image width","format":"int32","title":"Width","type":"integer","x-stream-index":"004"}},"title":"Image size configuration","type":"object"},"ImageUploadRequest":{"nullable":true,"properties":{"file":{"type":"string","x-stream-index":"001.001"},"upload_sizes":{"description":"field with JSON-encoded array of image size configurations","items":{"$ref":"#/components/schemas/ImageSize"},"title":"Upload sizes","type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/OnlyUserID","x-stream-index":"001.002"}},"type":"object"},"ImageUploadResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.003.001"},"file":{"type":"string","x-stream-index":"001.001"},"thumb_url":{"type":"string","x-stream-index":"001.002"},"upload_sizes":{"description":"Array of image size configurations","items":{"$ref":"#/components/schemas/ImageSize"},"title":"Upload sizes","type":"array","x-stream-index":"002"}},"required":["duration"],"type":"object"},"Images":{"properties":{"fixed_height":{"$ref":"#/components/schemas/ImageData","x-stream-index":"002"},"fixed_height_downsampled":{"$ref":"#/components/schemas/ImageData","x-stream-index":"004"},"fixed_height_still":{"$ref":"#/components/schemas/ImageData","x-stream-index":"003"},"fixed_width":{"$ref":"#/components/schemas/ImageData","x-stream-index":"005"},"fixed_width_downsampled":{"$ref":"#/components/schemas/ImageData","x-stream-index":"007"},"fixed_width_still":{"$ref":"#/components/schemas/ImageData","x-stream-index":"006"},"original":{"$ref":"#/components/schemas/ImageData","x-stream-index":"001"}},"required":["original","fixed_height","fixed_height_still","fixed_height_downsampled","fixed_width","fixed_width_still","fixed_width_downsampled"],"type":"object"},"IngressAudioEncodingOptions":{"properties":{"bitrate":{"maximum":128000,"minimum":16000,"type":"integer","x-stream-index":"003"},"channels":{"enum":["1","2"],"format":"int32","type":"integer","x-stream-index":"001"},"enable_dtx":{"type":"boolean","x-stream-index":"002"}},"required":["channels","enable_dtx","bitrate"],"type":"object"},"IngressAudioEncodingOptionsRequest":{"properties":{"bitrate":{"maximum":128000,"minimum":16000,"type":"integer","x-stream-index":"003"},"channels":{"enum":["1","2"],"format":"int32","type":"integer","x-stream-index":"001"},"enable_dtx":{"type":"boolean","x-stream-index":"002"}},"required":["channels","bitrate"],"type":"object"},"IngressAudioEncodingResponse":{"properties":{"bitrate":{"format":"int32","type":"integer","x-stream-index":"003"},"channels":{"format":"int32","type":"integer","x-stream-index":"001"},"enable_dtx":{"type":"boolean","x-stream-index":"002"}},"required":["channels","enable_dtx","bitrate"],"type":"object"},"IngressSettings":{"properties":{"audio_encoding_options":{"$ref":"#/components/schemas/IngressAudioEncodingOptions","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"video_encoding_options":{"additionalProperties":{"$ref":"#/components/schemas/IngressVideoEncodingOptions"},"type":"object","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"IngressSettingsRequest":{"properties":{"audio_encoding_options":{"$ref":"#/components/schemas/IngressAudioEncodingOptionsRequest","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"video_encoding_options":{"additionalProperties":{"$ref":"#/components/schemas/IngressVideoEncodingOptionsRequest"},"type":"object","x-stream-index":"003"}},"type":"object"},"IngressSettingsResponse":{"properties":{"audio_encoding_options":{"$ref":"#/components/schemas/IngressAudioEncodingResponse","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"video_encoding_options":{"additionalProperties":{"$ref":"#/components/schemas/IngressVideoEncodingResponse"},"type":"object","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"IngressVideoEncodingOptions":{"properties":{"layers":{"items":{"$ref":"#/components/schemas/IngressVideoLayer"},"minimum":1,"type":"array","x-stream-index":"001"}},"required":["layers"],"type":"object"},"IngressVideoEncodingOptionsRequest":{"properties":{"layers":{"items":{"$ref":"#/components/schemas/IngressVideoLayerRequest"},"minimum":1,"type":"array","x-stream-index":"001"}},"required":["layers"],"type":"object"},"IngressVideoEncodingResponse":{"properties":{"layers":{"items":{"$ref":"#/components/schemas/IngressVideoLayerResponse"},"type":"array","x-stream-index":"001"}},"required":["layers"],"type":"object"},"IngressVideoLayer":{"nullable":true,"properties":{"bitrate":{"minimum":1000,"type":"integer","x-stream-index":"002"},"codec":{"enum":["h264","vp8"],"type":"string","x-stream-index":"001"},"frame_rate":{"maximum":60,"minimum":1,"type":"integer","x-stream-index":"003"},"max_dimension":{"minimum":240,"type":"integer","x-stream-index":"005"},"min_dimension":{"minimum":240,"type":"integer","x-stream-index":"004"}},"required":["codec","bitrate","frame_rate","min_dimension","max_dimension"],"type":"object"},"IngressVideoLayerRequest":{"nullable":true,"properties":{"bitrate":{"format":"int32","minimum":1000,"type":"integer","x-stream-index":"002"},"codec":{"enum":["h264","vp8"],"type":"string","x-stream-index":"001"},"frame_rate_limit":{"maximum":60,"minimum":1,"type":"integer","x-stream-index":"005"},"max_dimension":{"minimum":240,"type":"integer","x-stream-index":"004"},"min_dimension":{"minimum":240,"type":"integer","x-stream-index":"003"}},"required":["codec","bitrate","min_dimension","max_dimension","frame_rate_limit"],"type":"object"},"IngressVideoLayerResponse":{"nullable":true,"properties":{"bitrate":{"type":"integer","x-stream-index":"002"},"codec":{"type":"string","x-stream-index":"001"},"frame_rate_limit":{"type":"integer","x-stream-index":"005"},"max_dimension":{"type":"integer","x-stream-index":"004"},"min_dimension":{"type":"integer","x-stream-index":"003"}},"required":["codec","bitrate","min_dimension","max_dimension","frame_rate_limit"],"type":"object"},"JoinCallRequest":{"nullable":true,"properties":{"create":{"description":"if true the call will be created if it doesn't exist","title":"Create","type":"boolean","x-stream-index":"002"},"data":{"$ref":"#/components/schemas/CallRequest","x-stream-index":"003"},"location":{"title":"Location","type":"string","x-stream-index":"009"},"members_limit":{"format":"int32","maximum":100,"title":"The amount of members that should be returned","type":"integer","x-stream-index":"007"},"migrating_from":{"description":"If the participant is migrating from another SFU, then this is the ID of the previous SFU","title":"MigratingFrom","type":"string","x-stream-index":"010"},"notify":{"type":"boolean","x-stream-index":"005"},"ring":{"description":"if true and the call is created, the notification will include ring=true","title":"Ring","type":"boolean","x-stream-index":"004"},"video":{"type":"boolean","x-stream-index":"006"}},"required":["location"],"title":"JoinCallRequest","type":"object"},"JoinCallResponse":{"nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001.001"},"created":{"title":"Created","type":"boolean","x-stream-index":"002"},"credentials":{"$ref":"#/components/schemas/Credentials","title":"Credentials","x-stream-index":"003"},"duration":{"type":"string","x-stream-index":"005.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001.002"},"membership":{"$ref":"#/components/schemas/MemberResponse","x-stream-index":"001.003"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"001.004"},"stats_options":{"$ref":"#/components/schemas/StatsOptions","x-stream-index":"004"}},"required":["call","members","own_capabilities","blocked_users","created","credentials","stats_options","duration"],"title":"JoinCallResponse","type":"object"},"Label":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"phrase_list_ids":{"items":{"format":"int32","type":"integer"},"type":"array","x-stream-index":"002"}},"required":["name"],"type":"object"},"LabelThresholds":{"properties":{"block":{"description":"Threshold for automatic message block","format":"float","maximum":1,"minimum":0,"title":"Block","type":"number","x-stream-index":"002"},"flag":{"description":"Threshold for automatic message flag","format":"float","maximum":1,"minimum":0,"title":"Flag","type":"number","x-stream-index":"001"}},"type":"object"},"LayoutSettings":{"properties":{"detect_orientation":{"type":"boolean","x-stream-index":"005"},"external_app_url":{"type":"string","x-stream-index":"003"},"external_css_url":{"type":"string","x-stream-index":"004"},"name":{"enum":["spotlight","grid","single-participant","mobile","custom"],"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"required":["name","external_app_url","external_css_url"],"type":"object"},"LayoutSettingsRequest":{"properties":{"detect_orientation":{"type":"boolean","x-stream-index":"005"},"external_app_url":{"type":"string","x-stream-index":"003"},"external_css_url":{"type":"string","x-stream-index":"004"},"name":{"enum":["spotlight","grid","single-participant","mobile","custom"],"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"required":["name"],"type":"object"},"LimitsSettings":{"properties":{"max_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"004"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"},"max_participants_exclude_owner":{"type":"boolean","x-stream-index":"003"},"max_participants_exclude_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"002"}},"required":["max_participants_exclude_roles"],"type":"object"},"LimitsSettingsRequest":{"properties":{"max_duration_seconds":{"format":"int32","minimum":0,"type":"integer","x-stream-index":"004"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"},"max_participants_exclude_owner":{"type":"boolean","x-stream-index":"003"},"max_participants_exclude_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"002"}},"type":"object"},"LimitsSettingsResponse":{"properties":{"max_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"004"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"},"max_participants_exclude_owner":{"type":"boolean","x-stream-index":"003"},"max_participants_exclude_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"002"}},"required":["max_participants_exclude_roles"],"type":"object"},"ListBlockListResponse":{"description":"Basic response information","nullable":true,"properties":{"blocklists":{"items":{"$ref":"#/components/schemas/BlockListResponse"},"type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["blocklists","duration"],"title":"Response","type":"object"},"ListDevicesResponse":{"description":"List devices response","nullable":true,"properties":{"devices":{"description":"List of devices","items":{"$ref":"#/components/schemas/DeviceResponse"},"title":"Devices","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["devices","duration"],"title":"ListDevicesResponse","type":"object"},"ListRecordingsResponse":{"description":"Response for listing recordings","nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"},"recordings":{"items":{"$ref":"#/components/schemas/CallRecording"},"title":"The list of recordings.","type":"array","x-stream-index":"002"}},"required":["duration","recordings"],"title":"ListRecordingsResponse","type":"object"},"ListTranscriptionsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"},"transcriptions":{"description":"List of transcriptions for the call","items":{"$ref":"#/components/schemas/CallTranscription"},"title":"Transcriptions","type":"array","x-stream-index":"002"}},"required":["duration","transcriptions"],"title":"ListTranscriptionsResponse","type":"object"},"MarkChannelsReadRequest":{"nullable":true,"properties":{"read_by_channel":{"additionalProperties":{"type":"string"},"description":"Map of channel ID to last read message ID","maximum":30,"title":"Read by channel","type":"object","x-stream-index":"001"}},"type":"object"},"MarkReadRequest":{"nullable":true,"properties":{"message_id":{"description":"ID of the message that is considered last read by client","title":"Message ID","type":"string","x-stream-index":"001"},"thread_id":{"description":"Optional Thread ID to specifically mark a given thread as read","title":"Thread ID","type":"string","x-stream-index":"002"}},"type":"object"},"MarkReadResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"event":{"$ref":"#/components/schemas/MessageReadEvent","description":"Mark read event","title":"Event","x-stream-index":"001"}},"required":["duration"],"type":"object"},"MarkReviewedRequest":{"properties":{"content_to_mark_as_reviewed_limit":{"format":"int32","maximum":2500,"type":"integer","x-stream-index":"002"},"disable_marking_content_as_reviewed":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"MarkUnreadRequest":{"nullable":true,"properties":{"message_id":{"description":"ID of the message from where the channel is marked unread","title":"Message ID","type":"string","x-stream-index":"001"},"thread_id":{"description":"Mark a thread unread, specify both the thread and message id","title":"Thread ID","type":"string","x-stream-index":"003"}},"type":"object"},"MemberAddedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"002.001"},"type":{"default":"member.added","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MemberAddedEvent","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"},"MemberLookup":{"properties":{"Limit":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"001"}},"required":["Limit"],"type":"object"},"MemberRemovedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"001.001"},"type":{"default":"member.removed","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MemberRemovedEvent","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"},"MemberRequest":{"description":"MemberRequest is the payload for adding a member to a call.","properties":{"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"003"},"role":{"title":"Role","type":"string","x-stream-index":"002"},"user_id":{"minLength":1,"title":"User ID","type":"string","x-stream-index":"001"}},"required":["user_id"],"title":"MemberRequest","type":"object"},"MemberResponse":{"description":"MemberResponse is the payload for a member of a call.","properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"005"},"custom":{"additionalProperties":{},"description":"Custom member response data","title":"Custom","type":"object","x-stream-index":"004"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"007"},"role":{"title":"Role","type":"string","x-stream-index":"003"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"006"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"},"user_id":{"type":"string","x-stream-index":"002"}},"required":["user","user_id","custom","created_at","updated_at"],"title":"MemberResponse","type":"object"},"MemberUpdatedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"005.002"},"channel_type":{"type":"string","x-stream-index":"005.003"},"cid":{"type":"string","x-stream-index":"005.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"002.001"},"type":{"default":"member.updated","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MemberUpdatedEvent","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"},"MembersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"members":{"description":"List of found members","items":{"$ref":"#/components/schemas/ChannelMember"},"title":"Members","type":"array","x-stream-index":"001"}},"required":["members","duration"],"type":"object"},"Message":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"012"},"before_message_send_failed":{"type":"boolean","x-stream-index":"046"},"cid":{"type":"string","x-stream-index":"028"},"command":{"type":"string","x-stream-index":"006"},"created_at":{"format":"date-time","type":"number","x-stream-index":"030"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"034"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"033"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"023"},"html":{"type":"string","x-stream-index":"007"},"i18n":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"044"},"id":{"type":"string","x-stream-index":"002"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"040"},"latest_reactions":{"items":{"$ref":"#/components/schemas/Reaction"},"type":"array","x-stream-index":"013"},"mentioned_users":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"043"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"052"},"mml":{"type":"string","x-stream-index":"005"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"056"},"own_reactions":{"items":{"$ref":"#/components/schemas/Reaction"},"type":"array","x-stream-index":"014"},"parent_id":{"type":"string","x-stream-index":"019"},"pin_expires":{"format":"date-time","type":"number","x-stream-index":"051"},"pinned":{"type":"boolean","x-stream-index":"047"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"048"},"pinned_by":{"$ref":"#/components/schemas/User","x-stream-index":"050"},"poll":{"$ref":"#/components/schemas/Poll","x-stream-index":"054"},"poll_id":{"type":"string","x-stream-index":"053"},"quoted_message":{"$ref":"#/components/schemas/Message","x-stream-index":"025"},"quoted_message_id":{"type":"string","x-stream-index":"024"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"015"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"017"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"016"},"reminder":{"$ref":"#/components/schemas/MessageReminder","x-stream-index":"058"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"022"},"restricted_visibility":{"items":{"type":"string"},"type":"array","x-stream-index":"011"},"shadowed":{"type":"boolean","x-stream-index":"036"},"shared_location":{"$ref":"#/components/schemas/SharedLocation","x-stream-index":"055"},"show_in_channel":{"type":"boolean","x-stream-index":"021"},"silent":{"type":"boolean","x-stream-index":"045"},"text":{"type":"string","x-stream-index":"004"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"027"},"type":{"type":"string","x-stream-index":"008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"031"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"010"}},"required":["id","text","html","type","restricted_visibility","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reaction_groups","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned"],"type":"object"},"MessageActionRequest":{"nullable":true,"properties":{"form_data":{"additionalProperties":{"type":"string"},"description":"ReadOnlyData to execute command with","title":"Form data","type":"object","x-stream-index":"002"}},"required":["form_data"],"type":"object"},"MessageChangeSet":{"properties":{"attachments":{"type":"boolean","x-stream-index":"005"},"custom":{"type":"boolean","x-stream-index":"001"},"html":{"type":"boolean","x-stream-index":"004"},"mentioned_user_ids":{"type":"boolean","x-stream-index":"006"},"mml":{"type":"boolean","x-stream-index":"003"},"pin":{"type":"boolean","x-stream-index":"009"},"quoted_message_id":{"type":"boolean","x-stream-index":"007"},"silent":{"type":"boolean","x-stream-index":"008"},"text":{"type":"boolean","x-stream-index":"002"}},"required":["custom","text","mml","html","attachments","mentioned_user_ids","quoted_message_id","silent","pin"],"type":"object"},"MessageDeletedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"006.002"},"hard_delete":{"type":"boolean","x-stream-index":"002.001"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"005.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"message.deleted","type":"string","x-stream-index":"006.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["hard_delete","cid","channel_id","channel_type","type","created_at"],"title":"MessageDeletedEvent","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":{"approved_at":{"format":"date-time","type":"number","x-stream-index":"013"},"created_at":{"format":"date-time","type":"number","x-stream-index":"009"},"created_by_automod":{"type":"boolean","x-stream-index":"001"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"008"},"details":{"$ref":"#/components/schemas/FlagDetails","x-stream-index":"006"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"005"},"moderation_feedback":{"$ref":"#/components/schemas/FlagFeedback","x-stream-index":"003"},"moderation_result":{"$ref":"#/components/schemas/MessageModerationResult","x-stream-index":"002"},"reason":{"type":"string","x-stream-index":"007"},"rejected_at":{"format":"date-time","type":"number","x-stream-index":"014"},"reviewed_at":{"format":"date-time","type":"number","x-stream-index":"011"},"reviewed_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"012"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"004"}},"required":["created_by_automod","created_at","updated_at"],"type":"object"},"MessageModerationResult":{"description":"Result of the message moderation","properties":{"action":{"description":"Action taken by automod","title":"Action","type":"string","x-stream-index":"002"},"ai_moderation_response":{"$ref":"#/components/schemas/ModerationResponse","description":"Response from AI moderation","title":"ModerationResponse","x-stream-index":"007"},"blocked_word":{"description":"Word that was blocked","title":"Blocked word","type":"string","x-stream-index":"004"},"blocklist_name":{"description":"Name of the blocklist","title":"Blocklist name","type":"string","x-stream-index":"005"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"010"},"message_id":{"description":"ID of the message","title":"Message ID","type":"string","x-stream-index":"001"},"moderated_by":{"description":"User who moderated the message","title":"Moderated by","type":"string","x-stream-index":"003"},"moderation_thresholds":{"$ref":"#/components/schemas/Thresholds","description":"Thresholds for AI moderation","title":"Thresholds","x-stream-index":"006"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"011"},"user_bad_karma":{"description":"Whether user has bad karma","title":"User bad karma","type":"boolean","x-stream-index":"009"},"user_karma":{"description":"Karma of the user","format":"float","title":"User karma","type":"number","x-stream-index":"008"}},"required":["message_id","action","user_karma","user_bad_karma","created_at","updated_at"],"title":"Message moderation result","type":"object"},"MessageNewEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"005.002"},"channel_type":{"type":"string","x-stream-index":"005.003"},"cid":{"type":"string","x-stream-index":"005.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"006.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"notification.thread_message_new","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"},"watcher_count":{"format":"int32","type":"integer","x-stream-index":"002.001"}},"required":["watcher_count","type","created_at","cid","channel_id","channel_type"],"title":"MessageNewEvent","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"},"MessageOptions":{"properties":{"include_thread_participants":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"MessagePaginationParams":{"type":"object"},"MessageReadEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"003"},"channel_last_message_at":{"format":"date-time","type":"number","x-stream-index":"005"},"channel_type":{"type":"string","x-stream-index":"004"},"cid":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"009"},"last_read_message_id":{"type":"string","x-stream-index":"010"},"team":{"type":"string","x-stream-index":"006"},"thread":{"$ref":"#/components/schemas/ThreadResponse","x-stream-index":"008"},"type":{"default":"message.read","type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","x-stream-index":"007"}},"required":["type","cid","channel_id","channel_type","created_at"],"type":"object"},"MessageReminder":{"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"004"},"channel_cid":{"type":"string","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"011"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"006"},"message_id":{"type":"string","x-stream-index":"005"},"remind_at":{"format":"date-time","type":"number","x-stream-index":"009"},"task_id":{"type":"string","x-stream-index":"010"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"012"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"user_id":{"type":"string","x-stream-index":"007"}},"required":["channel_cid","message_id","user_id","task_id","created_at","updated_at"],"type":"object"},"MessageRequest":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"maximum":30,"type":"array","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"mentioned_users":{"items":{"type":"string"},"maximum":100,"type":"array","x-stream-index":"008"},"mml":{"type":"string","x-stream-index":"003"},"parent_id":{"type":"string","x-stream-index":"005"},"pin_expires":{"format":"date-time","type":"number","x-stream-index":"015"},"pinned":{"type":"boolean","x-stream-index":"013"},"pinned_at":{"format":"date-time","nullable":true,"type":"string","x-stream-index":"014"},"poll_id":{"type":"string","x-stream-index":"039"},"quoted_message_id":{"type":"string","x-stream-index":"009"},"restricted_visibility":{"items":{"type":"string"},"maximum":10,"type":"array","x-stream-index":"016"},"shared_location":{"$ref":"#/components/schemas/SharedLocation","x-stream-index":"040"},"show_in_channel":{"type":"boolean","x-stream-index":"006"},"silent":{"type":"boolean","x-stream-index":"012"},"text":{"type":"string","x-stream-index":"002"},"type":{"enum":["''","regular","system"],"type":"string","x-stream-index":"011"}},"type":"object"},"MessageResponse":{"description":"Represents any chat message","properties":{"attachments":{"description":"Array of message attachments","items":{"$ref":"#/components/schemas/Attachment"},"title":"Message attachments","type":"array","x-stream-docs-page-id":"message_format#attachment-format","x-stream-index":"008"},"cid":{"description":"Channel unique identifier in \u003ctype\u003e:\u003cid\u003e format","title":"Channel CID","type":"string","x-stream-index":"022"},"command":{"description":"Contains provided slash command","title":"Command","type":"string","x-stream-docs-page-id":"custom_commands_webhook","x-stream-index":"004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"023"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"026"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"025"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"018"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"041"},"html":{"description":"Contains HTML markup of the message. Can only be set when using server-side API","title":"HTML content","type":"string","x-stream-index":"005"},"i18n":{"additionalProperties":{"type":"string"},"description":"Object with translations. Key `language` contains the original language key. Other keys contain translations","title":"Internationalization info","type":"object","x-stream-docs-page-id":"translation","x-stream-index":"030"},"id":{"description":"Message ID is unique string identifier of the message","title":"ID","type":"string","x-stream-index":"001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"Contains image moderation information","title":"Image moderation labels","type":"object","x-stream-index":"028"},"latest_reactions":{"description":"List of 10 latest reactions to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Latest reactions","type":"array","x-stream-index":"009"},"mentioned_users":{"description":"List of mentioned users","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Mentioned Users","type":"array","x-stream-index":"029"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"036"},"mml":{"description":"Should be empty if `text` is provided. Can only be set when using server-side API","title":"Messaging Markup Language","type":"string","x-stream-docs-page-id":"mml_overview","x-stream-index":"003"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"039"},"own_reactions":{"description":"List of 10 latest reactions of authenticated user to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Own reactions","type":"array","x-stream-index":"010"},"parent_id":{"description":"ID of parent message (thread)","title":"Parent message ID","type":"string","x-stream-docs-page-id":"threads","x-stream-index":"015"},"pin_expires":{"description":"Date when pinned message expires","format":"date-time","title":"Pin expiration date","type":"number","x-stream-docs-page-id":"pinned_messages","x-stream-index":"035"},"pinned":{"description":"Whether message is pinned or not","title":"Pinned","type":"boolean","x-stream-docs-page-id":"pinned_messages","x-stream-index":"032"},"pinned_at":{"description":"Date when message got pinned","format":"date-time","title":"Pinned at","type":"number","x-stream-docs-page-id":"pinned_messages","x-stream-index":"033"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","description":"Contains user who pinned the message","title":"Pinned by","x-stream-docs-page-id":"pinned_messages","x-stream-index":"034"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"038"},"poll_id":{"description":"Identifier of the poll to include in the message","title":"Poll ID","type":"string","x-stream-index":"037"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","description":"Contains quoted message","title":"Quoted message","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"020"},"quoted_message_id":{"title":"ID of quoted message","type":"string","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"019"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing number of reactions of each type. Key: reaction type (string), value: number of reactions (int)","title":"Reaction counts","type":"object","x-stream-index":"011"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"014"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing scores of reactions of each type. Key: reaction type (string), value: total score of reactions (int)","title":"Reaction scores","type":"object","x-stream-index":"012"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"042"},"reply_count":{"description":"Number of replies to this message","format":"int32","title":"Reply count","type":"integer","x-stream-index":"017"},"restricted_visibility":{"description":"A list of user ids that have restricted visibility to the message, if the list is not empty, the message is only visible to the users in the list","items":{"type":"string"},"title":"Restricted visibility","type":"array","x-stream-index":"040"},"shadowed":{"description":"Whether the message was shadowed or not","title":"Shadowed","type":"boolean","x-stream-docs-page-id":"moderation#shadow-ban","x-stream-index":"027"},"shared_location":{"$ref":"#/components/schemas/SharedLocationResponseData","description":"Contains shared location data","title":"Shared Location","x-stream-index":"043"},"show_in_channel":{"description":"Whether thread reply should be shown in the channel as well","title":"Show in channel","type":"boolean","x-stream-docs-page-id":"threads","x-stream-index":"016"},"silent":{"description":"Whether message is silent or not","title":"Silent","type":"boolean","x-stream-index":"031"},"text":{"description":"Text of the message. Should be empty if `mml` is provided","title":"Text","type":"string","x-stream-index":"002"},"thread_participants":{"description":"List of users who participate in thread","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Thread participants","type":"array","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"021"},"type":{"description":"Contains type of the message","enum":["regular","ephemeral","error","reply","system","deleted"],"title":"Message Type","type":"string","x-stream-docs-page-id":"message_format#message-types","x-stream-index":"006"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"024"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Sender of the message. Required when using server-side API","title":"User object","x-stream-index":"007"}},"required":["id","text","html","type","user","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned","restricted_visibility"],"title":"Message","type":"object","x-stream-docs-page-id":"send_message"},"MessageStatsResponse":{"properties":{"count_over_time":{"items":{"$ref":"#/components/schemas/CountByMinuteResponse"},"type":"array","x-stream-index":"001"}},"type":"object"},"MessageUndeletedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"005.002"},"channel_type":{"type":"string","x-stream-index":"005.003"},"cid":{"type":"string","x-stream-index":"005.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"002.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"message.undeleted","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MessageUndeletedEvent","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"},"MessageUpdate":{"properties":{"change_set":{"$ref":"#/components/schemas/MessageChangeSet","x-stream-index":"002"},"old_text":{"type":"string","x-stream-index":"001"}},"type":"object"},"MessageUpdatedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"005.002"},"channel_type":{"type":"string","x-stream-index":"005.003"},"cid":{"type":"string","x-stream-index":"005.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"002.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"message.updated","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MessageUpdatedEvent","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"},"MessageWithChannelResponse":{"description":"Represents any chat message","properties":{"attachments":{"description":"Array of message attachments","items":{"$ref":"#/components/schemas/Attachment"},"title":"Message attachments","type":"array","x-stream-docs-page-id":"message_format#attachment-format","x-stream-index":"001.008"},"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel object","title":"Channel","x-stream-index":"002"},"cid":{"description":"Channel unique identifier in \u003ctype\u003e:\u003cid\u003e format","title":"Channel CID","type":"string","x-stream-index":"001.022"},"command":{"description":"Contains provided slash command","title":"Command","type":"string","x-stream-docs-page-id":"custom_commands_webhook","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.023"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.026"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"001.025"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"001.018"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001.041"},"html":{"description":"Contains HTML markup of the message. Can only be set when using server-side API","title":"HTML content","type":"string","x-stream-index":"001.005"},"i18n":{"additionalProperties":{"type":"string"},"description":"Object with translations. Key `language` contains the original language key. Other keys contain translations","title":"Internationalization info","type":"object","x-stream-docs-page-id":"translation","x-stream-index":"001.030"},"id":{"description":"Message ID is unique string identifier of the message","title":"ID","type":"string","x-stream-index":"001.001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"Contains image moderation information","title":"Image moderation labels","type":"object","x-stream-index":"001.028"},"latest_reactions":{"description":"List of 10 latest reactions to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Latest reactions","type":"array","x-stream-index":"001.009"},"mentioned_users":{"description":"List of mentioned users","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Mentioned Users","type":"array","x-stream-index":"001.029"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"001.036"},"mml":{"description":"Should be empty if `text` is provided. Can only be set when using server-side API","title":"Messaging Markup Language","type":"string","x-stream-docs-page-id":"mml_overview","x-stream-index":"001.003"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"001.039"},"own_reactions":{"description":"List of 10 latest reactions of authenticated user to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Own reactions","type":"array","x-stream-index":"001.010"},"parent_id":{"description":"ID of parent message (thread)","title":"Parent message ID","type":"string","x-stream-docs-page-id":"threads","x-stream-index":"001.015"},"pin_expires":{"description":"Date when pinned message expires","format":"date-time","title":"Pin expiration date","type":"number","x-stream-docs-page-id":"pinned_messages","x-stream-index":"001.035"},"pinned":{"description":"Whether message is pinned or not","title":"Pinned","type":"boolean","x-stream-docs-page-id":"pinned_messages","x-stream-index":"001.032"},"pinned_at":{"description":"Date when message got pinned","format":"date-time","title":"Pinned at","type":"number","x-stream-docs-page-id":"pinned_messages","x-stream-index":"001.033"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","description":"Contains user who pinned the message","title":"Pinned by","x-stream-docs-page-id":"pinned_messages","x-stream-index":"001.034"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001.038"},"poll_id":{"description":"Identifier of the poll to include in the message","title":"Poll ID","type":"string","x-stream-index":"001.037"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","description":"Contains quoted message","title":"Quoted message","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"001.020"},"quoted_message_id":{"title":"ID of quoted message","type":"string","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"001.019"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing number of reactions of each type. Key: reaction type (string), value: number of reactions (int)","title":"Reaction counts","type":"object","x-stream-index":"001.011"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"001.014"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing scores of reactions of each type. Key: reaction type (string), value: total score of reactions (int)","title":"Reaction scores","type":"object","x-stream-index":"001.012"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"001.042"},"reply_count":{"description":"Number of replies to this message","format":"int32","title":"Reply count","type":"integer","x-stream-index":"001.017"},"restricted_visibility":{"description":"A list of user ids that have restricted visibility to the message, if the list is not empty, the message is only visible to the users in the list","items":{"type":"string"},"title":"Restricted visibility","type":"array","x-stream-index":"001.040"},"shadowed":{"description":"Whether the message was shadowed or not","title":"Shadowed","type":"boolean","x-stream-docs-page-id":"moderation#shadow-ban","x-stream-index":"001.027"},"shared_location":{"$ref":"#/components/schemas/SharedLocationResponseData","description":"Contains shared location data","title":"Shared Location","x-stream-index":"001.043"},"show_in_channel":{"description":"Whether thread reply should be shown in the channel as well","title":"Show in channel","type":"boolean","x-stream-docs-page-id":"threads","x-stream-index":"001.016"},"silent":{"description":"Whether message is silent or not","title":"Silent","type":"boolean","x-stream-index":"001.031"},"text":{"description":"Text of the message. Should be empty if `mml` is provided","title":"Text","type":"string","x-stream-index":"001.002"},"thread_participants":{"description":"List of users who participate in thread","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Thread participants","type":"array","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"001.021"},"type":{"description":"Contains type of the message","enum":["regular","ephemeral","error","reply","system","deleted"],"title":"Message Type","type":"string","x-stream-docs-page-id":"message_format#message-types","x-stream-index":"001.006"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.024"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Sender of the message. Required when using server-side API","title":"User object","x-stream-index":"001.007"}},"required":["id","text","html","type","user","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned","restricted_visibility","channel"],"title":"Message","type":"object","x-stream-docs-page-id":"send_message"},"ModerationActionConfig":{"nullable":true,"properties":{"action":{"type":"string","x-stream-index":"006"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"009"},"description":{"type":"string","x-stream-index":"008"},"entity_type":{"type":"string","x-stream-index":"004"},"icon":{"type":"string","x-stream-index":"007"},"order":{"format":"int32","type":"integer","x-stream-index":"005"}},"required":["entity_type","order","action","icon","description","custom"],"type":"object"},"ModerationCustomActionEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"001"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"002"},"type":{"default":"moderation.custom_action","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationCustomActionEvent","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"},"ModerationFlaggedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"item":{"type":"string","x-stream-index":"001"},"object_id":{"type":"string","x-stream-index":"002"},"type":{"default":"moderation.flagged","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationFlaggedEvent","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"},"ModerationMarkReviewedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"001"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"002"},"type":{"default":"moderation.mark_reviewed","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationMarkReviewedEvent","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"},"ModerationPayload":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"images":{"items":{"type":"string"},"maximum":30,"type":"array","x-stream-index":"002"},"texts":{"items":{"type":"string"},"type":"array","x-stream-index":"001"},"videos":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"type":"object"},"ModerationResponse":{"properties":{"action":{"type":"string","x-stream-index":"004"},"explicit":{"format":"float","type":"number","x-stream-index":"002"},"spam":{"format":"float","type":"number","x-stream-index":"003"},"toxic":{"format":"float","type":"number","x-stream-index":"001"}},"required":["toxic","explicit","spam","action","automod_response"],"type":"object"},"ModerationV2Response":{"properties":{"action":{"type":"string","x-stream-index":"001"},"blocklist_matched":{"type":"string","x-stream-index":"005"},"image_harms":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"original_text":{"type":"string","x-stream-index":"002"},"platform_circumvented":{"type":"boolean","x-stream-index":"007"},"semantic_filter_matched":{"type":"string","x-stream-index":"006"},"text_harms":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"required":["action","original_text"],"type":"object"},"MuteChannelRequest":{"nullable":true,"properties":{"channel_cids":{"description":"Channel CIDs to mute (if multiple channels)","items":{"type":"string"},"maximum":25,"title":"Channel CIDs","type":"array","x-stream-index":"002"},"expiration":{"description":"Duration of mute in milliseconds","title":"Expiration","type":"integer","x-stream-index":"003"}},"type":"object"},"MuteChannelResponse":{"nullable":true,"properties":{"channel_mute":{"$ref":"#/components/schemas/ChannelMute","description":"Object with channel mute (if one channel was muted)","title":"Channel mute","x-stream-index":"001"},"channel_mutes":{"description":"Object with mutes (if multiple channels were muted)","items":{"$ref":"#/components/schemas/ChannelMute"},"title":"Channel mutes","type":"array","x-stream-index":"002"},"duration":{"type":"string","x-stream-index":"004.001"},"own_user":{"$ref":"#/components/schemas/OwnUser","description":"Authorized user object with fresh mutes information","title":"Own user","x-stream-index":"003"}},"required":["duration"],"type":"object"},"MuteRequest":{"nullable":true,"properties":{"target_ids":{"description":"User IDs to mute (if multiple users)","items":{"type":"string"},"title":"Target IDs","type":"array","x-stream-index":"001"},"timeout":{"description":"Duration of mute in minutes","minimum":0,"title":"Timeout","type":"integer","x-stream-index":"002"}},"required":["target_ids"],"title":"MuteRequest","type":"object"},"MuteResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"004.001"},"mutes":{"description":"Object with mutes (if multiple users were muted)","items":{"$ref":"#/components/schemas/UserMute"},"title":"Mutes","type":"array","x-stream-index":"001"},"non_existing_users":{"description":"A list of users that can't be found. Common cause for this is deleted users","items":{"type":"string"},"title":"Non Existing Users","type":"array","x-stream-index":"003"},"own_user":{"$ref":"#/components/schemas/OwnUser","description":"Authorized user object with fresh mutes information","title":"Own User","x-stream-index":"002"}},"required":["duration"],"title":"MuteResponse","type":"object"},"MuteUsersRequest":{"nullable":true,"properties":{"audio":{"title":"Audio","type":"boolean","x-stream-index":"005"},"mute_all_users":{"type":"boolean","x-stream-index":"003"},"screenshare":{"title":"Screenshare","type":"boolean","x-stream-index":"007"},"screenshare_audio":{"title":"ScreenshareAudio","type":"boolean","x-stream-index":"008"},"user_ids":{"items":{"type":"string"},"title":"UserIDs","type":"array","x-stream-index":"004"},"video":{"title":"Video","type":"boolean","x-stream-index":"006"}},"title":"MuteUsersRequest","type":"object"},"MuteUsersResponse":{"description":"MuteUsersResponse is the response payload for the mute users endpoint.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"MuteUsersResponse","type":"object"},"NetworkMetricsReportResponse":{"properties":{"average_connection_time":{"format":"float","type":"number","x-stream-index":"003"},"average_jitter":{"format":"float","type":"number","x-stream-index":"002"},"average_latency":{"format":"float","type":"number","x-stream-index":"001"},"average_time_to_reconnect":{"format":"float","type":"number","x-stream-index":"004"}},"type":"object"},"NoiseCancellationSettings":{"properties":{"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode"],"type":"object"},"NotificationAddedToChannelEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003.004"},"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"003.005"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"001.001"},"type":{"default":"notification.added_to_channel","type":"string","x-stream-index":"002.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"NotificationAddedToChannelEvent","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"},"NotificationChannelDeletedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003.004"},"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"003.005"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"team":{"type":"string","x-stream-index":"001.001"},"type":{"default":"notification.channel_deleted","type":"string","x-stream-index":"002.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"NotificationChannelDeletedEvent","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"},"NotificationChannelMutesUpdatedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"me":{"$ref":"#/components/schemas/OwnUser","x-stream-index":"001"},"type":{"default":"notification.channel_mutes_updated","type":"string","x-stream-index":"002.001"}},"required":["me","type","created_at"],"title":"NotificationChannelMutesUpdatedEvent","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"},"NotificationChannelTruncatedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002.004"},"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"002.005"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"notification.channel_truncated","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"NotificationChannelTruncatedEvent","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"},"NotificationInviteAcceptedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002.004"},"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"002.005"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"004.001"},"type":{"default":"notification.invite_accepted","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"NotificationInviteAcceptedEvent","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"},"NotificationInviteRejectedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002.004"},"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"002.005"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"004.001"},"type":{"default":"notification.invite_rejected","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"NotificationInviteRejectedEvent","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"},"NotificationInvitedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002.004"},"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"002.005"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"004.001"},"type":{"default":"notification.invited","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"NotificationInvitedEvent","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"},"NotificationMarkReadEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003.004"},"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"003.005"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"team":{"type":"string","x-stream-index":"002.001"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"006"},"type":{"default":"notification.mark_read","type":"string","x-stream-index":"001.001"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"007"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"005"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"008"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count","unread_count","total_unread_count","unread_channels","unread_threads"],"title":"NotificationMarkReadEvent","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"},"NotificationMarkUnreadEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003.004"},"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"003.005"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"first_unread_message_id":{"type":"string","x-stream-index":"005"},"last_read_at":{"format":"date-time","type":"number","x-stream-index":"006"},"last_read_message_id":{"type":"string","x-stream-index":"012"},"team":{"type":"string","x-stream-index":"002.001"},"thread_id":{"type":"string","x-stream-index":"013"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"009"},"type":{"default":"notification.mark_unread","type":"string","x-stream-index":"001.001"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"010"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"008"},"unread_messages":{"format":"int32","type":"integer","x-stream-index":"007"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"011"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count","first_unread_message_id","last_read_at","unread_messages","unread_count","total_unread_count","unread_channels","unread_threads"],"title":"NotificationMarkUnreadEvent","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"},"NotificationMutesUpdatedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"me":{"$ref":"#/components/schemas/OwnUser","x-stream-index":"001"},"type":{"default":"notification.mutes_updated","type":"string","x-stream-index":"002.001"}},"required":["me","type","created_at"],"title":"NotificationMutesUpdatedEvent","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"},"NotificationNewMessageEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"004.004"},"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"004.005"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"002.001"},"type":{"default":"notification.message_new","type":"string","x-stream-index":"003.001"}},"required":["message","type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"NotificationNewMessageEvent","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"},"NotificationRemovedFromChannelEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002.004"},"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"002.005"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"004.001"},"type":{"default":"notification.removed_from_channel","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"NotificationRemovedFromChannelEvent","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"},"NotificationSettings":{"properties":{"call_live_started":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"002"},"call_missed":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"006"},"call_notification":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"004"},"call_ring":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"session_started":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"003"}},"required":["enabled","call_live_started","session_started","call_notification","call_ring","call_missed"],"type":"object"},"NullTime":{"type":"object"},"OCRRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"}},"required":["label","action"],"type":"object"},"OnlyUserID":{"properties":{"id":{"type":"string","x-stream-index":"001"}},"required":["id"],"type":"object"},"OwnCapability":{"description":"All possibility of string to use","enum":["block-users","change-max-duration","create-call","create-reaction","enable-noise-cancellation","end-call","join-backstage","join-call","join-ended-call","mute-users","pin-for-everyone","read-call","remove-call-member","screenshare","send-audio","send-video","start-broadcast-call","start-closed-captions-call","start-frame-record-call","start-record-call","start-transcription-call","stop-broadcast-call","stop-closed-captions-call","stop-frame-record-call","stop-record-call","stop-transcription-call","update-call","update-call-member","update-call-permissions","update-call-settings"],"title":"OwnCapability","type":"string"},"OwnUser":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"046"},"banned":{"type":"boolean","x-stream-index":"016"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"045"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"029"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"014"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"013"},"devices":{"items":{"$ref":"#/components/schemas/Device"},"type":"array","x-stream-index":"027"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"023"},"language":{"type":"string","x-stream-index":"035"},"last_active":{"format":"date-time","type":"number","x-stream-index":"011"},"last_engaged_at":{"format":"date-time","type":"number","x-stream-index":"012"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"037"},"mutes":{"items":{"$ref":"#/components/schemas/UserMute"},"type":"array","x-stream-index":"028"},"online":{"type":"boolean","x-stream-index":"022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"026"},"push_preferences":{"$ref":"#/components/schemas/PushPreferences","x-stream-index":"025"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"005"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"031"},"total_unread_count_by_team":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"032"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"033"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"030"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"034"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"}},"required":["id","role","custom","created_at","updated_at","banned","online","devices","mutes","channel_mutes","unread_count","total_unread_count","total_unread_count_by_team","unread_channels","unread_threads","language"],"type":"object"},"OwnUserResponse":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"banned":{"type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"015"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.011"},"devices":{"items":{"$ref":"#/components/schemas/DeviceResponse"},"title":"Devices","type":"array","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001.001"},"image":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"005"},"language":{"type":"string","x-stream-index":"001.005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"001.014"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"013"},"mutes":{"items":{"$ref":"#/components/schemas/UserMuteResponse"},"type":"array","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"001.002"},"online":{"type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"003"},"push_preferences":{"$ref":"#/components/schemas/PushPreferences","x-stream-index":"002"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.015"},"role":{"type":"string","x-stream-index":"001.006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"009"},"total_unread_count_by_team":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"010"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"011"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"008"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"012"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","devices","invisible","mutes","channel_mutes","unread_count","total_unread_count","unread_channels","unread_threads"],"type":"object"},"PaginationParams":{"properties":{"limit":{"format":"int32","minimum":0,"type":"integer","x-stream-index":"001"},"offset":{"format":"int32","type":"integer","x-stream-index":"002"}},"type":"object"},"ParticipantCountByMinuteResponse":{"nullable":true,"properties":{"first":{"format":"int32","type":"integer","x-stream-index":"002"},"last":{"format":"int32","type":"integer","x-stream-index":"003"},"max":{"format":"int32","type":"integer","x-stream-index":"004"},"min":{"format":"int32","type":"integer","x-stream-index":"005"},"start_ts":{"format":"date-time","type":"number","x-stream-index":"001"}},"required":["start_ts","first","last","max","min"],"type":"object"},"ParticipantCountOverTimeResponse":{"properties":{"by_minute":{"items":{"$ref":"#/components/schemas/ParticipantCountByMinuteResponse"},"type":"array","x-stream-index":"001"}},"type":"object"},"ParticipantReportResponse":{"properties":{"by_browser":{"items":{"$ref":"#/components/schemas/GroupedStatsResponse"},"type":"array","x-stream-index":"008"},"by_country":{"items":{"$ref":"#/components/schemas/GroupedStatsResponse"},"type":"array","x-stream-index":"005"},"by_device":{"items":{"$ref":"#/components/schemas/GroupedStatsResponse"},"type":"array","x-stream-index":"006"},"by_operating_system":{"items":{"$ref":"#/components/schemas/GroupedStatsResponse"},"type":"array","x-stream-index":"007"},"count_over_time":{"$ref":"#/components/schemas/ParticipantCountOverTimeResponse","x-stream-index":"004"},"max_concurrent":{"format":"int32","type":"integer","x-stream-index":"003"},"publishers":{"$ref":"#/components/schemas/PublisherStatsResponse","x-stream-index":"009"},"subscribers":{"$ref":"#/components/schemas/SubscriberStatsResponse","x-stream-index":"010"},"sum":{"format":"int32","type":"integer","x-stream-index":"001"},"unique":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["sum","unique"],"type":"object"},"PendingMessageEvent":{"description":"Pending message event for async moderation","nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"002.007"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"message":{"$ref":"#/components/schemas/Message","description":"The pending message","title":"Message","x-stream-index":"002.009"},"metadata":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"002.010"},"method":{"description":"The method used for the pending message","title":"Method","type":"string","x-stream-index":"003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"type":{"default":"message.pending","description":"The type of event: \"message.pending\" in this case","title":"Event Type","type":"string","x-stream-index":"001.002"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.002"}},"required":["type","custom","method","created_at"],"title":"PendingMessageEvent","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"},"PendingMessageResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"003"},"metadata":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"}},"type":"object"},"PerSDKUsageReport":{"nullable":true,"properties":{"by_version":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"002"},"total":{"format":"int32","type":"integer","x-stream-index":"001"}},"required":["total","by_version"],"type":"object"},"PermissionRequestEvent":{"description":"This event is sent when a user requests access to a feature on a call,\nclients receiving this event should display a permission request to the user","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"permissions":{"description":"The list of permissions requested by the user","items":{"type":"string"},"title":"Permissions","type":"array","x-stream-index":"004"},"type":{"default":"call.permission_request","description":"The type of event: \"call.permission_request\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who sent the permission request","title":"User","x-stream-index":"003"}},"required":["type","created_at","call_cid","user","permissions"],"title":"PermissionRequestEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"PinRequest":{"description":"PinRequest is the payload for pinning a message.","nullable":true,"properties":{"session_id":{"description":"the session ID of the user who pinned the message","title":"SessionID","type":"string","x-stream-index":"003"},"user_id":{"description":"the user ID of the user who pinned the message","title":"UserID","type":"string","x-stream-index":"002"}},"required":["user_id","session_id"],"title":"PinRequest","type":"object"},"PinResponse":{"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"},"Poll":{"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"023"},"allow_answers":{"type":"boolean","x-stream-index":"010"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"009"},"answers_count":{"format":"int32","type":"integer","x-stream-index":"015"},"created_at":{"format":"date-time","type":"number","x-stream-index":"021"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"020"},"created_by_id":{"type":"string","x-stream-index":"019"},"description":{"type":"string","x-stream-index":"005"},"enforce_unique_vote":{"type":"boolean","x-stream-index":"007"},"id":{"type":"string","x-stream-index":"003"},"is_closed":{"type":"boolean","x-stream-index":"011"},"latest_answers":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array","x-stream-index":"017"},"latest_votes_by_option":{"additionalProperties":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array"},"type":"object","x-stream-index":"016"},"max_votes_allowed":{"format":"int32","type":"integer","x-stream-index":"008"},"name":{"type":"string","x-stream-index":"004"},"options":{"items":{"$ref":"#/components/schemas/PollOption"},"type":"array","x-stream-index":"013"},"own_votes":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array","x-stream-index":"018"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"022"},"vote_count":{"format":"int32","type":"integer","x-stream-index":"012"},"vote_counts_by_option":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"014"},"voting_visibility":{"type":"string","x-stream-index":"006"}},"required":["id","name","description","enforce_unique_vote","allow_user_suggested_options","allow_answers","vote_count","options","vote_counts_by_option","answers_count","latest_votes_by_option","latest_answers","own_votes","created_by_id","created_at","updated_at","Custom"],"type":"object"},"PollClosedEvent":{"description":"Emitted when a poll is closed.","nullable":true,"properties":{"activity_id":{"type":"string","x-stream-index":"001.003"},"cid":{"description":"The CID of the channel containing the poll","title":"Channel CID","type":"string","x-stream-index":"001.001.002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.001.007"},"message_id":{"description":"The ID of the message containing the poll","title":"Message ID","type":"string","x-stream-index":"001.002"},"poll":{"$ref":"#/components/schemas/PollResponseData","description":"The poll object which was closed","title":"Poll","x-stream-index":"001.004"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.001.004"},"type":{"default":"poll.closed","description":"The type of event: \"poll.closed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.001.002"}},"required":["type","created_at","custom","poll"],"title":"PollClosedEvent","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"},"PollDeletedEvent":{"description":"Emitted when a poll is deleted.","nullable":true,"properties":{"activity_id":{"type":"string","x-stream-index":"001.003"},"cid":{"description":"The CID of the channel containing the poll","title":"Channel CID","type":"string","x-stream-index":"001.001.002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.001.007"},"message_id":{"description":"The ID of the message containing the poll","title":"Message ID","type":"string","x-stream-index":"001.002"},"poll":{"$ref":"#/components/schemas/PollResponseData","description":"The poll object which was deleted","title":"Poll","x-stream-index":"001.004"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.001.004"},"type":{"default":"poll.deleted","description":"The type of event: \"poll.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.001.002"}},"required":["type","created_at","custom","poll"],"title":"PollDeletedEvent","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"},"PollOption":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id","text","custom"],"type":"object"},"PollOptionInput":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"text":{"type":"string","x-stream-index":"002"}},"type":"object"},"PollOptionRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id"],"type":"object"},"PollOptionResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"poll_option":{"$ref":"#/components/schemas/PollOptionResponseData","description":"Poll option","title":"PollOptionResponseData","x-stream-index":"001"}},"required":["poll_option","duration"],"type":"object"},"PollOptionResponseData":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id","text","custom"],"type":"object"},"PollResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"poll":{"$ref":"#/components/schemas/PollResponseData","description":"Poll","title":"PollResponseData","x-stream-index":"001"}},"required":["poll","duration"],"type":"object"},"PollResponseData":{"properties":{"allow_answers":{"type":"boolean","x-stream-index":"008"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"007"},"answers_count":{"format":"int32","type":"integer","x-stream-index":"012"},"created_at":{"format":"date-time","type":"number","x-stream-index":"019"},"created_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"018"},"created_by_id":{"type":"string","x-stream-index":"017"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"021"},"description":{"type":"string","x-stream-index":"003"},"enforce_unique_vote":{"type":"boolean","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"is_closed":{"type":"boolean","x-stream-index":"009"},"latest_answers":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array","x-stream-index":"015"},"latest_votes_by_option":{"additionalProperties":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array"},"type":"object","x-stream-index":"014"},"max_votes_allowed":{"format":"int32","type":"integer","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"002"},"options":{"items":{"$ref":"#/components/schemas/PollOptionResponseData"},"type":"array","x-stream-index":"011"},"own_votes":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array","x-stream-index":"016"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"020"},"vote_count":{"format":"int32","type":"integer","x-stream-index":"010"},"vote_counts_by_option":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"013"},"voting_visibility":{"type":"string","x-stream-index":"004"}},"required":["id","name","description","voting_visibility","enforce_unique_vote","allow_user_suggested_options","allow_answers","vote_count","options","answers_count","vote_counts_by_option","latest_votes_by_option","latest_answers","own_votes","created_by_id","created_at","updated_at","custom"],"type":"object"},"PollUpdatedEvent":{"description":"Emitted when a poll is updated.","nullable":true,"properties":{"activity_id":{"type":"string","x-stream-index":"001.003"},"cid":{"description":"The CID of the channel containing the poll","title":"Channel CID","type":"string","x-stream-index":"001.001.002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.001.007"},"message_id":{"description":"The ID of the message containing the poll","title":"Message ID","type":"string","x-stream-index":"001.002"},"poll":{"$ref":"#/components/schemas/PollResponseData","description":"The poll object which was updated","title":"Poll","x-stream-index":"001.004"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.001.004"},"type":{"default":"poll.updated","description":"The type of event: \"poll.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.001.002"}},"required":["type","created_at","custom","poll"],"title":"PollUpdatedEvent","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"},"PollVote":{"nullable":true,"properties":{"answer_text":{"type":"string","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"004"},"is_answer":{"type":"boolean","x-stream-index":"006"},"option_id":{"type":"string","x-stream-index":"005"},"poll_id":{"type":"string","x-stream-index":"003"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"011"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"009"},"user_id":{"type":"string","x-stream-index":"008"}},"required":["poll_id","id","option_id","created_at","updated_at"],"type":"object"},"PollVoteCastedEvent":{"description":"Emitted when a vote is cast on a poll.","nullable":true,"properties":{"activity_id":{"type":"string","x-stream-index":"001.001.003"},"cid":{"description":"The CID of the channel containing the poll","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":"number","x-stream-index":"001.001.001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.001.001.007"},"message_id":{"description":"The ID of the message containing the poll","title":"Message ID","type":"string","x-stream-index":"001.001.002"},"poll":{"$ref":"#/components/schemas/PollResponseData","description":"The poll object","title":"Poll","x-stream-index":"001.001.004"},"poll_vote":{"$ref":"#/components/schemas/PollVoteResponseData","description":"The vote that was cast","title":"Poll Vote","x-stream-index":"001.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.001.001.004"},"type":{"default":"poll.vote_casted","description":"The type of event: \"poll.vote_casted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.001.001.002"}},"required":["type","created_at","custom","poll","poll_vote"],"title":"PollVoteCastedEvent","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"},"PollVoteChangedEvent":{"description":"Emitted when a vote on a poll is changed.","nullable":true,"properties":{"activity_id":{"type":"string","x-stream-index":"001.001.003"},"cid":{"description":"The CID of the channel containing the poll","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":"number","x-stream-index":"001.001.001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.001.001.007"},"message_id":{"description":"The ID of the message containing the poll","title":"Message ID","type":"string","x-stream-index":"001.001.002"},"poll":{"$ref":"#/components/schemas/PollResponseData","description":"The poll object","title":"Poll","x-stream-index":"001.001.004"},"poll_vote":{"$ref":"#/components/schemas/PollVoteResponseData","description":"The updated vote","title":"Poll Vote","x-stream-index":"001.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.001.001.004"},"type":{"default":"poll.vote_changed","description":"The type of event: \"poll.vote_changed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.001.001.002"}},"required":["type","created_at","custom","poll","poll_vote"],"title":"PollVoteChangedEvent","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"},"PollVoteRemovedEvent":{"description":"Emitted when a vote is removed from a poll.","nullable":true,"properties":{"activity_id":{"type":"string","x-stream-index":"001.001.003"},"cid":{"description":"The CID of the channel containing the poll","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":"number","x-stream-index":"001.001.001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.001.001.007"},"message_id":{"description":"The ID of the message containing the poll","title":"Message ID","type":"string","x-stream-index":"001.001.002"},"poll":{"$ref":"#/components/schemas/PollResponseData","description":"The poll object","title":"Poll","x-stream-index":"001.001.004"},"poll_vote":{"$ref":"#/components/schemas/PollVoteResponseData","description":"The vote that was removed","title":"Poll Vote","x-stream-index":"001.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.001.001.004"},"type":{"default":"poll.vote_removed","description":"The type of event: \"poll.vote_removed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.001.001.002"}},"required":["type","created_at","custom","poll","poll_vote"],"title":"PollVoteRemovedEvent","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"},"PollVoteResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"vote":{"$ref":"#/components/schemas/PollVoteResponseData","description":"Poll vote","title":"PollVoteResponseData","x-stream-index":"001"}},"required":["duration"],"type":"object"},"PollVoteResponseData":{"nullable":true,"properties":{"answer_text":{"type":"string","x-stream-index":"005"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"id":{"type":"string","x-stream-index":"002"},"is_answer":{"type":"boolean","x-stream-index":"004"},"option_id":{"type":"string","x-stream-index":"003"},"poll_id":{"type":"string","x-stream-index":"001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"007"},"user_id":{"type":"string","x-stream-index":"006"}},"required":["poll_id","id","option_id","created_at","updated_at"],"type":"object"},"PollVotesResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"votes":{"description":"Poll votes","items":{"$ref":"#/components/schemas/PollVoteResponseData"},"title":"PollVoteResponseList","type":"array","x-stream-index":"001"}},"required":["votes","duration"],"type":"object"},"PrivacySettings":{"properties":{"read_receipts":{"$ref":"#/components/schemas/ReadReceipts","x-stream-index":"002"},"typing_indicators":{"$ref":"#/components/schemas/TypingIndicators","x-stream-index":"001"}},"type":"object"},"PrivacySettingsResponse":{"properties":{"read_receipts":{"$ref":"#/components/schemas/ReadReceiptsResponse","x-stream-index":"002"},"typing_indicators":{"$ref":"#/components/schemas/TypingIndicatorsResponse","x-stream-index":"001"}},"type":"object"},"PublisherStatsResponse":{"properties":{"by_track":{"items":{"$ref":"#/components/schemas/TrackStatsResponse"},"type":"array","x-stream-index":"003"},"total":{"format":"int32","type":"integer","x-stream-index":"001"},"unique":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["total","unique"],"type":"object"},"PushPreferenceInput":{"nullable":true,"properties":{"call_level":{"description":"Set the level of call push notifications for the user. One of all, none, default","enum":["all","none","default"],"type":"string","x-stream-index":"004"},"channel_cid":{"description":"Set the push preferences for a specific channel. If empty it sets the default for the user","type":"string","x-stream-index":"002"},"chat_level":{"description":"Set the level of chat push notifications for the user. One of all, mentions, none, default","enum":["all","mentions","none","default"],"type":"string","x-stream-index":"003"},"disabled_until":{"description":"Disable push notifications till a certain time","format":"date-time","type":"number","x-stream-index":"005"},"remove_disable":{"description":"Remove the disabled until time. (IE stop snoozing notifications)","type":"boolean","x-stream-index":"006"},"user_id":{"description":"The user id for which to set the push preferences. Required when using server side auths, defaults to current user with client side auth.","type":"string","x-stream-index":"001"}},"type":"object"},"PushPreferences":{"properties":{"call_level":{"type":"string","x-stream-index":"002"},"chat_level":{"type":"string","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"number","x-stream-index":"003"}},"type":"object"},"Quality":{"properties":{"bitdepth":{"format":"int32","type":"integer","x-stream-index":"007"},"framerate":{"format":"int32","type":"integer","x-stream-index":"008"},"height":{"format":"int32","type":"integer","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"004"},"video_bitrate":{"format":"int32","type":"integer","x-stream-index":"009"},"width":{"format":"int32","type":"integer","x-stream-index":"005"}},"type":"object"},"QualityScoreReport":{"properties":{"histogram":{"items":{"$ref":"#/components/schemas/ReportByHistogramBucket"},"type":"array","x-stream-index":"001"}},"required":["histogram"],"type":"object"},"QualityScoreReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateQualityScoreReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"QueryAggregateCallStatsRequest":{"nullable":true,"properties":{"from":{"type":"string","x-stream-index":"002"},"report_types":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"to":{"type":"string","x-stream-index":"003"}},"type":"object"},"QueryAggregateCallStatsResponse":{"description":"Basic response information","nullable":true,"properties":{"call_duration_report":{"$ref":"#/components/schemas/CallDurationReportResponse","x-stream-index":"002"},"call_participant_count_report":{"$ref":"#/components/schemas/CallParticipantCountReportResponse","x-stream-index":"004"},"calls_per_day_report":{"$ref":"#/components/schemas/CallsPerDayReportResponse","x-stream-index":"003"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"network_metrics_report":{"$ref":"#/components/schemas/NetworkMetricsReportResponse","x-stream-index":"008"},"quality_score_report":{"$ref":"#/components/schemas/QualityScoreReportResponse","x-stream-index":"005"},"sdk_usage_report":{"$ref":"#/components/schemas/SDKUsageReportResponse","x-stream-index":"006"},"user_feedback_report":{"$ref":"#/components/schemas/UserFeedbackReportResponse","x-stream-index":"007"}},"required":["duration"],"title":"Response","type":"object"},"QueryBannedUsersPayload":{"properties":{"exclude_expired_bans":{"description":"Whether to exclude expired bans or not","title":"Exclude expired bans","type":"boolean","x-stream-index":"004"},"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"description":"Number of records to return","format":"int32","maximum":300,"minimum":0,"title":"Limit","type":"integer","x-stream-index":"003.003"},"offset":{"description":"Number of records to offset","format":"int32","maximum":10000,"title":"Offset","type":"integer","x-stream-index":"003.004"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":1,"title":"Sort","type":"array","x-stream-index":"002"}},"required":["filter_conditions"],"type":"object"},"QueryBannedUsersResponse":{"nullable":true,"properties":{"bans":{"description":"List of found bans","items":{"$ref":"#/components/schemas/BanResponse"},"title":"BanResponse","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["bans","duration"],"type":"object"},"QueryCallMembersRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"002"},"id":{"maxLength":64,"type":"string","x-stream-index":"001.002"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"004.001"},"next":{"type":"string","x-stream-index":"004.002"},"prev":{"type":"string","x-stream-index":"004.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":1,"type":"array","x-stream-index":"003"},"type":{"maxLength":64,"type":"string","x-stream-index":"001.001"}},"required":["type","id"],"type":"object"},"QueryCallMembersResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["members","duration"],"title":"Response","type":"object"},"QueryCallParticipantsRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"003"}},"type":"object"},"QueryCallParticipantsResponse":{"nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001.001"},"duration":{"type":"string","x-stream-index":"004.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001.002"},"membership":{"$ref":"#/components/schemas/MemberResponse","x-stream-index":"001.003"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"001.004"},"participants":{"description":"List of call participants","items":{"$ref":"#/components/schemas/CallParticipantResponse"},"title":"[]CallParticipantResponse","type":"array","x-stream-index":"002"},"total_participants":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["call","members","own_capabilities","blocked_users","participants","total_participants","duration"],"type":"object"},"QueryCallStatsRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"004.001"},"next":{"type":"string","x-stream-index":"004.002"},"prev":{"type":"string","x-stream-index":"004.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":2,"type":"array","x-stream-index":"002"}},"type":"object"},"QueryCallStatsResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"next":{"type":"string","x-stream-index":"003.001"},"prev":{"type":"string","x-stream-index":"003.002"},"reports":{"items":{"$ref":"#/components/schemas/CallStatsReportSummaryResponse"},"type":"array","x-stream-index":"001"}},"required":["reports","duration"],"title":"Response","type":"object"},"QueryCallsRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"title":"Filters","type":"object","x-stream-index":"003"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"006.001"},"next":{"type":"string","x-stream-index":"006.002"},"prev":{"type":"string","x-stream-index":"006.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":2,"title":"Sort","type":"array","x-stream-index":"004"},"watch":{"title":"Watch","type":"boolean","x-stream-index":"001"}},"title":"QueryCallsRequest","type":"object"},"QueryCallsResponse":{"nullable":true,"properties":{"calls":{"items":{"$ref":"#/components/schemas/CallStateResponseFields"},"title":"Calls","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["calls","duration"],"title":"QueryCallsResponse","type":"object"},"QueryChannelsRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"description":"Number of channels to limit","format":"int32","title":"Limit","type":"integer","x-stream-index":"008"},"member_limit":{"description":"Number of members to limit","format":"int32","maximum":100,"minimum":0,"title":"Member limit","type":"integer","x-stream-index":"007"},"message_limit":{"description":"Number of messages to limit","format":"int32","minimum":0,"title":"Message limit","type":"integer","x-stream-index":"006"},"offset":{"description":"Channel pagination offset","format":"int32","title":"Offset","type":"integer","x-stream-index":"009"},"presence":{"title":"Presence","type":"boolean","x-stream-index":"005"},"sort":{"description":"List of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"002"},"state":{"description":"Whether to update channel state or not","title":"State","type":"boolean","x-stream-index":"004"},"watch":{"description":"Whether to start watching found channels or not","title":"Watch","type":"boolean","x-stream-index":"003"}},"title":"Query Channels Request","type":"object","x-stream-docs-page-id":"query_channels"},"QueryChannelsResponse":{"nullable":true,"properties":{"channels":{"description":"List of channels","items":{"$ref":"#/components/schemas/ChannelStateResponseFields"},"title":"Channels","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["channels","duration"],"title":"Channels list","type":"object"},"QueryDraftsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","maximum":3,"title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"002"}},"type":"object"},"QueryDraftsResponse":{"nullable":true,"properties":{"drafts":{"description":"Drafts","items":{"$ref":"#/components/schemas/DraftResponse"},"title":"DraftsResponseList","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["drafts","duration"],"type":"object"},"QueryMembersPayload":{"description":"Client request","properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"002"},"limit":{"format":"int32","maximum":300,"minimum":0,"type":"integer","x-stream-index":"006.003"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"type":"array","x-stream-index":"003"},"offset":{"format":"int32","maximum":10000,"type":"integer","x-stream-index":"006.004"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":1,"type":"array","x-stream-index":"005"},"type":{"maxLength":64,"type":"string","x-stream-index":"001"}},"required":["type","filter_conditions"],"title":"ClientRequest","type":"object"},"QueryMessageFlagsPayload":{"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":300,"minimum":0,"type":"integer","x-stream-index":"003.003"},"offset":{"format":"int32","maximum":10000,"type":"integer","x-stream-index":"003.004"},"show_deleted_messages":{"description":"Whether to include deleted messages in the results","title":"ShowDeletedMessages","type":"boolean","x-stream-index":"002"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"type":"array","x-stream-index":"003.005"}},"type":"object"},"QueryMessageFlagsResponse":{"description":"Query message flags response","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"flags":{"description":"The flags that match the query","items":{"$ref":"#/components/schemas/MessageFlagResponse"},"title":"MessageFlagResponseList","type":"array","x-stream-index":"001"}},"required":["flags","duration"],"title":"QueryMessageFlagsResponse","type":"object"},"QueryModerationConfigsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter conditions for moderation configs","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"Sorting parameters for the results","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"002"}},"type":"object"},"QueryModerationConfigsResponse":{"nullable":true,"properties":{"configs":{"description":"List of moderation configurations","items":{"$ref":"#/components/schemas/ConfigResponse"},"title":"Configs","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["configs","duration"],"type":"object"},"QueryPollVotesRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","title":"Filter","type":"object","x-stream-index":"003"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"004"}},"type":"object"},"QueryPollsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","title":"Filter","type":"object","x-stream-index":"002"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"003"}},"type":"object"},"QueryPollsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"polls":{"description":"Polls data returned by the query","items":{"$ref":"#/components/schemas/PollResponseData"},"title":"PollsResponseData","type":"array","x-stream-index":"001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["polls","duration"],"type":"object"},"QueryReactionsRequest":{"properties":{"filter":{"additionalProperties":{},"type":"object","x-stream-index":"002"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"006.001"},"next":{"type":"string","x-stream-index":"006.002"},"prev":{"type":"string","x-stream-index":"006.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":2,"type":"array","x-stream-index":"003"}},"type":"object"},"QueryReactionsResponse":{"description":"Basic response information","properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"next":{"type":"string","x-stream-index":"003.001"},"prev":{"type":"string","x-stream-index":"003.002"},"reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"001"}},"required":["reactions","duration"],"title":"Response","type":"object"},"QueryRemindersRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"002"}},"type":"object"},"QueryRemindersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"reminders":{"description":"MessageReminders data returned by the query","items":{"$ref":"#/components/schemas/ReminderResponseData"},"title":"RemindersResponseData","type":"array","x-stream-index":"001"}},"required":["reminders","duration"],"type":"object"},"QueryReviewQueueRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter conditions for review queue items","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"007.001"},"lock_count":{"description":"Number of items to lock (1-25)","format":"int32","maximum":25,"minimum":1,"title":"Lock Count","type":"integer","x-stream-index":"005"},"lock_duration":{"description":"Duration for which items should be locked","title":"Lock Duration","type":"integer","x-stream-index":"004"},"lock_items":{"description":"Whether to lock items for review (true), unlock items (false), or just fetch (nil)","title":"Lock Items","type":"boolean","x-stream-index":"003"},"next":{"type":"string","x-stream-index":"007.002"},"prev":{"type":"string","x-stream-index":"007.003"},"sort":{"description":"Sorting parameters for the results","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"002"},"stats_only":{"description":"Whether to return only statistics","title":"Stats Only","type":"boolean","x-stream-index":"006"}},"type":"object"},"QueryReviewQueueResponse":{"nullable":true,"properties":{"action_config":{"additionalProperties":{"items":{"$ref":"#/components/schemas/ModerationActionConfig"},"type":"array"},"description":"Configuration for moderation actions","title":"Action Config","type":"object","x-stream-index":"002"},"duration":{"type":"string","x-stream-index":"005.001"},"items":{"description":"List of review queue items","items":{"$ref":"#/components/schemas/ReviewQueueItemResponse"},"title":"Items","type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"004.001"},"prev":{"type":"string","x-stream-index":"004.002"},"stats":{"additionalProperties":{},"description":"Statistics about the review queue","title":"Stats","type":"object","x-stream-index":"003"}},"required":["items","action_config","stats","duration"],"type":"object"},"QueryThreadsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter conditions to apply to threads","title":"Filter","type":"object","x-stream-index":"006"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"008.001"},"member_limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005"},"next":{"type":"string","x-stream-index":"008.002"},"participant_limit":{"description":"Limit the number of participants returned per each thread","format":"int32","maximum":100,"minimum":0,"title":"Participant limit","type":"integer","x-stream-index":"004"},"prev":{"type":"string","x-stream-index":"008.003"},"reply_limit":{"description":"Limit the number of replies returned per each thread","format":"int32","maximum":10,"minimum":0,"title":"Reply limit","type":"integer","x-stream-index":"003"},"sort":{"description":"Sort conditions to apply to threads","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"007"},"watch":{"description":"Start watching the channel this thread belongs to","title":"Watch","type":"boolean","x-stream-index":"001"}},"type":"object"},"QueryThreadsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"threads":{"description":"List of enriched thread states","items":{"$ref":"#/components/schemas/ThreadStateResponse"},"title":"Threads","type":"array","x-stream-index":"001"}},"required":["threads","duration"],"type":"object"},"QueryUsersPayload":{"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"include_deactivated_users":{"type":"boolean","x-stream-index":"004"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.003"},"offset":{"format":"int32","maximum":1000,"type":"integer","x-stream-index":"005.004"},"presence":{"type":"boolean","x-stream-index":"003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"type":"array","x-stream-index":"002"}},"required":["filter_conditions"],"type":"object"},"QueryUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"users":{"description":"Array of users as result of filters applied.","items":{"$ref":"#/components/schemas/FullUserResponse"},"title":"Users","type":"array","x-stream-index":"001"}},"required":["users","duration"],"type":"object"},"RTMPBroadcastRequest":{"description":"RTMPBroadcastRequest is the payload for starting an RTMP broadcast.","properties":{"layout":{"$ref":"#/components/schemas/LayoutSettingsRequest","description":"If provided, will override the call's RTMP settings layout","title":"Layout","x-stream-index":"005"},"name":{"description":"Name identifier for RTMP broadcast, must be unique in call","maxLength":255,"title":"Name","type":"string","x-stream-index":"001"},"quality":{"description":"If provided, will override the call's RTMP settings quality","enum":["360p","480p","720p","1080p","1440p","portrait-360x640","portrait-480x854","portrait-720x1280","portrait-1080x1920","portrait-1440x2560"],"title":"Quality","type":"string","x-stream-index":"004"},"stream_key":{"description":"If provided, will be appended at the end of stream_url","title":"Stream Key","type":"string","x-stream-index":"003"},"stream_url":{"description":"URL for the RTMP server to send the call to","maxLength":255,"title":"Stream URL","type":"string","x-stream-index":"002"}},"required":["name","stream_url"],"title":"RTMPBroadcastRequest","type":"object"},"RTMPEgressConfig":{"properties":{"composite_app_settings":{"$ref":"#/components/schemas/CompositeAppSettings","x-stream-index":"005"},"quality":{"$ref":"#/components/schemas/Quality","x-stream-index":"004"},"rtmp_location":{"type":"string","x-stream-index":"006"}},"type":"object"},"RTMPIngress":{"description":"RTMP input settings","properties":{"address":{"title":"Address","type":"string","x-stream-index":"001"}},"required":["address"],"title":"RTMPIngress","type":"object"},"RTMPLocation":{"properties":{"name":{"type":"string","x-stream-index":"001"},"stream_key":{"type":"string","x-stream-index":"003"},"stream_url":{"type":"string","x-stream-index":"002"}},"required":["name","stream_url","stream_key"],"type":"object"},"RTMPSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"003"},"location":{"$ref":"#/components/schemas/RTMPLocation","x-stream-index":"004"},"quality_name":{"type":"string","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"RTMPSettingsRequest":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"quality":{"description":"Resolution to set for the RTMP stream","enum":["360p","480p","720p","1080p","1440p","portrait-360x640","portrait-480x854","portrait-720x1280","portrait-1080x1920","portrait-1440x2560"],"title":"Quality","type":"string","x-stream-index":"002"}},"title":"RTMPSettingsRequest","type":"object"},"RTMPSettingsResponse":{"description":"RTMPSettingsResponse is the payload for RTMP settings","properties":{"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"001"},"quality":{"title":"Quality","type":"string","x-stream-index":"002"}},"required":["enabled","quality","layout"],"title":"RTMPSettingsResponse","type":"object"},"Reaction":{"nullable":true,"properties":{"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"message_id":{"type":"string","x-stream-index":"003"},"score":{"format":"int32","type":"integer","x-stream-index":"007"},"type":{"maxLength":30,"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["message_id","type","score","created_at","updated_at","custom"],"type":"object"},"ReactionDeletedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"006.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"002"},"team":{"type":"string","x-stream-index":"005.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"reaction.deleted","type":"string","x-stream-index":"006.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"ReactionDeletedEvent","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"},"ReactionGroupResponse":{"description":"ReactionGroupResponse contains all information about a reaction of the same type.","nullable":true,"properties":{"count":{"description":"Count is the number of reactions of this type.","format":"int32","title":"Count","type":"integer","x-stream-index":"001"},"first_reaction_at":{"description":"FirstReactionAt is the time of the first reaction of this type. This is the same also if all reaction of this type are deleted, because if someone will react again with the same type, will be preserved the sorting.","format":"date-time","title":"FirstReactionAt","type":"number","x-stream-index":"003"},"last_reaction_at":{"description":"LastReactionAt is the time of the last reaction of this type.","format":"date-time","title":"LastReactionAt","type":"number","x-stream-index":"004"},"sum_scores":{"description":"SumScores is the sum of all scores of reactions of this type. Medium allows you to clap articles more than once and shows the sum of all claps from all users. For example, you can send `clap` x5 using `score: 5`.","format":"int32","title":"SumScores","type":"integer","x-stream-index":"002"}},"required":["count","sum_scores","first_reaction_at","last_reaction_at"],"title":"ReactionGroupResponse","type":"object"},"ReactionNewEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"006.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"002"},"team":{"type":"string","x-stream-index":"005.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"reaction.new","type":"string","x-stream-index":"006.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"ReactionNewEvent","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"},"ReactionRequest":{"description":"Represents user reaction to a message","properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"score":{"description":"Reaction score. If not specified reaction has score of 1","format":"int32","title":"Score","type":"integer","x-stream-index":"002"},"type":{"description":"The type of reaction (e.g. 'like', 'laugh', 'wow')","maxLength":30,"title":"Type","type":"string","x-stream-index":"001"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"004"}},"required":["type"],"title":"Reaction","type":"object","x-stream-docs-page-id":"send_reaction"},"ReactionResponse":{"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"006"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"008"},"message_id":{"description":"Message ID","title":"Message ID","type":"string","x-stream-index":"001"},"score":{"description":"Score of the reaction","format":"int32","title":"Score","type":"integer","x-stream-index":"005"},"type":{"description":"Type of reaction","title":"Type","type":"string","x-stream-index":"004"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"007"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User","title":"UserResponse","x-stream-index":"003"},"user_id":{"description":"User ID","title":"User ID","type":"string","x-stream-index":"002"}},"required":["message_id","user_id","user","type","score","created_at","updated_at","custom"],"type":"object"},"ReactionUpdatedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"006.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"002"},"team":{"type":"string","x-stream-index":"005.001"},"type":{"default":"reaction.updated","type":"string","x-stream-index":"006.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["message","reaction","cid","channel_id","channel_type","type","created_at"],"title":"ReactionUpdatedEvent","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"},"ReadReceipts":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"ReadReceiptsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"ReadStateResponse":{"properties":{"last_read":{"format":"date-time","type":"number","x-stream-index":"002"},"last_read_message_id":{"type":"string","x-stream-index":"004"},"unread_messages":{"format":"int32","type":"integer","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"}},"required":["user","last_read","unread_messages"],"type":"object"},"RecordSettings":{"properties":{"audio_only":{"type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"004"},"mode":{"type":"string","x-stream-index":"002"},"quality":{"type":"string","x-stream-index":"003"}},"required":["mode"],"type":"object"},"RecordSettingsRequest":{"properties":{"audio_only":{"type":"boolean","x-stream-index":"001"},"mode":{"enum":["available","disabled","auto-on"],"title":"Mode","type":"string","x-stream-index":"002"},"quality":{"enum":["360p","480p","720p","1080p","1440p","portrait-360x640","portrait-480x854","portrait-720x1280","portrait-1080x1920","portrait-1440x2560"],"type":"string","x-stream-index":"003"}},"required":["mode"],"title":"RecordSettingsRequest","type":"object"},"RecordSettingsResponse":{"description":"RecordSettings is the payload for recording settings","properties":{"audio_only":{"title":"Audio Only","type":"boolean","x-stream-index":"001"},"mode":{"title":"Mode","type":"string","x-stream-index":"002"},"quality":{"title":"Quality","type":"string","x-stream-index":"003"}},"required":["audio_only","mode","quality","layout"],"title":"RecordSettingsResponse","type":"object"},"RecordingEgressConfig":{"properties":{"audio_only":{"type":"boolean","x-stream-index":"006"},"composite_app_settings":{"$ref":"#/components/schemas/CompositeAppSettings","x-stream-index":"005"},"external_storage":{"$ref":"#/components/schemas/ExternalStorage","x-stream-index":"008"},"quality":{"$ref":"#/components/schemas/Quality","x-stream-index":"004"},"storage_name":{"type":"string","x-stream-index":"007"},"video_orientation_hint":{"$ref":"#/components/schemas/VideoOrientation","x-stream-index":"009"}},"type":"object"},"RejectCallRequest":{"nullable":true,"properties":{"reason":{"description":"Reason for rejecting the call","title":"Reason","type":"string","x-stream-index":"003"}},"title":"RejectCallRequest","type":"object"},"RejectCallResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"RejectCallResponse","type":"object"},"ReminderCreatedEvent":{"description":"Emitted when a reminder is created.","nullable":true,"properties":{"cid":{"description":"The CID of the Channel for which the reminder was created","title":"Channel CID","type":"string","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.007"},"message_id":{"description":"The ID of the message for which the reminder was created","title":"Message ID","type":"string","x-stream-index":"001.002"},"parent_id":{"description":"The ID of the parent message, if the reminder is for a thread message","title":"Parent ID","type":"string","x-stream-index":"001.005"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","description":"The reminder object which was created","title":"MessageReminder","x-stream-index":"001.006"},"type":{"default":"reminder.created","description":"The type of event: \"reminder.created\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.002"},"user_id":{"description":"The ID of the user for whom the reminder was created","title":"User ID","type":"string","x-stream-index":"001.003"}},"required":["type","created_at","custom","message_id","user_id","cid"],"title":"ReminderCreatedEvent","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"},"ReminderDeletedEvent":{"description":"Emitted when a reminder is deleted.","nullable":true,"properties":{"cid":{"description":"The CID of the Channel for which the reminder was created","title":"Channel CID","type":"string","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.007"},"message_id":{"description":"The ID of the message for which the reminder was created","title":"Message ID","type":"string","x-stream-index":"001.002"},"parent_id":{"description":"The ID of the parent message, if the reminder is for a thread message","title":"Parent ID","type":"string","x-stream-index":"001.005"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","description":"The reminder object which was created","title":"MessageReminder","x-stream-index":"001.006"},"type":{"default":"reminder.deleted","description":"The type of event: \"reminder.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.002"},"user_id":{"description":"The ID of the user for whom the reminder was created","title":"User ID","type":"string","x-stream-index":"001.003"}},"required":["type","created_at","custom","message_id","user_id","cid"],"title":"ReminderDeletedEvent","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"},"ReminderNotificationEvent":{"description":"Emitted when a reminder becomes due, triggering a notification for the user.","nullable":true,"properties":{"cid":{"description":"The CID of the Channel for which the reminder was created","title":"Channel CID","type":"string","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.007"},"message_id":{"description":"The ID of the message for which the reminder was created","title":"Message ID","type":"string","x-stream-index":"001.002"},"parent_id":{"type":"string","x-stream-index":"001.005"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","description":"The reminder object which was created","title":"MessageReminder","x-stream-index":"001.006"},"type":{"default":"notification.reminder_due","description":"The type of event: \"notification.reminder_due\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.002"},"user_id":{"description":"The ID of the user for whom the reminder was created","title":"User ID","type":"string","x-stream-index":"001.003"}},"required":["type","created_at","custom","message_id","user_id","cid"],"title":"ReminderNotificationEvent","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"},"ReminderResponseData":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003"},"channel_cid":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"005"},"message_id":{"type":"string","x-stream-index":"004"},"remind_at":{"format":"date-time","type":"number","x-stream-index":"001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007"},"user_id":{"type":"string","x-stream-index":"006"}},"required":["channel_cid","message_id","user_id","created_at","updated_at"],"type":"object"},"ReminderUpdatedEvent":{"description":"Emitted when a reminder is updated.","nullable":true,"properties":{"cid":{"description":"The CID of the Channel for which the reminder was created","title":"Channel CID","type":"string","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.007"},"message_id":{"description":"The ID of the message for which the reminder was created","title":"Message ID","type":"string","x-stream-index":"001.002"},"parent_id":{"description":"The ID of the parent message, if the reminder is for a thread message","title":"Parent ID","type":"string","x-stream-index":"001.005"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","description":"The reminder object which was created","title":"MessageReminder","x-stream-index":"001.006"},"type":{"default":"reminder.updated","description":"The type of event: \"reminder.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.002"},"user_id":{"description":"The ID of the user for whom the reminder was created","title":"User ID","type":"string","x-stream-index":"001.003"}},"required":["type","created_at","custom","message_id","user_id","cid"],"title":"ReminderUpdatedEvent","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"},"ReportByHistogramBucket":{"properties":{"category":{"type":"string","x-stream-index":"001"},"count":{"format":"int32","type":"integer","x-stream-index":"005"},"lower_bound":{"$ref":"#/components/schemas/Bound","x-stream-index":"002"},"sum":{"format":"float","type":"number","x-stream-index":"004"},"upper_bound":{"$ref":"#/components/schemas/Bound","x-stream-index":"003"}},"required":["category","sum","count"],"type":"object"},"ReportResponse":{"properties":{"call":{"$ref":"#/components/schemas/CallReportResponse","x-stream-index":"003"},"participants":{"$ref":"#/components/schemas/ParticipantReportResponse","x-stream-index":"001"},"user_ratings":{"$ref":"#/components/schemas/UserRatingReportResponse","x-stream-index":"002"}},"required":["participants","user_ratings","call"],"type":"object"},"RequestPermissionRequest":{"nullable":true,"properties":{"permissions":{"items":{"type":"string"},"title":"Permissions","type":"array","x-stream-index":"003"}},"required":["permissions"],"title":"RequestPermissionRequest","type":"object"},"RequestPermissionResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"RequestPermissionResponse","type":"object"},"Response":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001"}},"required":["duration"],"title":"Response","type":"object"},"RestoreActionRequest":{"type":"object"},"ReviewQueueItem":{"properties":{"actions":{"items":{"$ref":"#/components/schemas/ActionLog"},"type":"array","x-stream-index":"035"},"activity":{"$ref":"#/components/schemas/EnrichedActivity","x-stream-index":"028"},"ai_text_severity":{"type":"string","x-stream-index":"021"},"archived_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"043"},"assigned_to":{"$ref":"#/components/schemas/User","x-stream-index":"032"},"bans":{"items":{"$ref":"#/components/schemas/Ban"},"type":"array","x-stream-index":"033"},"bounce_count":{"format":"int32","type":"integer","x-stream-index":"025"},"call":{"$ref":"#/components/schemas/Call","x-stream-index":"031"},"completed_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"018"},"config_key":{"type":"string","x-stream-index":"009"},"content_changed":{"type":"boolean","x-stream-index":"036"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"entity_creator":{"$ref":"#/components/schemas/EntityCreator","x-stream-index":"030"},"entity_id":{"type":"string","x-stream-index":"007"},"entity_type":{"type":"string","x-stream-index":"006"},"feeds_v2_activity":{"$ref":"#/components/schemas/EnrichedActivity","x-stream-index":"041"},"feeds_v2_reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"042"},"flag_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"045"},"flag_types":{"items":{"type":"string"},"type":"array","x-stream-index":"044"},"flags":{"items":{"$ref":"#/components/schemas/Flag"},"type":"array","x-stream-index":"034"},"flags_count":{"format":"int32","type":"integer","x-stream-index":"026"},"has_image":{"type":"boolean","x-stream-index":"012"},"has_text":{"type":"boolean","x-stream-index":"014"},"has_video":{"type":"boolean","x-stream-index":"013"},"id":{"type":"string","x-stream-index":"003"},"languages":{"items":{"type":"string"},"type":"array","x-stream-index":"019"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"027"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"010"},"moderation_payload_hash":{"type":"string","x-stream-index":"011"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"029"},"recommended_action":{"type":"string","x-stream-index":"017"},"reporter_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"046"},"reviewed_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"022"},"reviewed_by":{"type":"string","x-stream-index":"023"},"severity":{"format":"int32","type":"integer","x-stream-index":"020"},"status":{"type":"string","x-stream-index":"016"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"015"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"005"}},"required":["id","created_at","updated_at","entity_type","entity_id","config_key","moderation_payload_hash","has_image","has_video","has_text","teams","status","recommended_action","completed_at","languages","severity","ai_text_severity","reviewed_at","reviewed_by","bounce_count","flags_count","bans","flags","actions","content_changed","archived_at","flag_types","flag_labels","reporter_ids"],"type":"object"},"ReviewQueueItemResponse":{"nullable":true,"properties":{"actions":{"description":"Moderation actions taken","items":{"$ref":"#/components/schemas/ActionLogResponse"},"title":"Actions","type":"array","x-stream-index":"024"},"activity":{"$ref":"#/components/schemas/EnrichedActivity","x-stream-index":"016"},"ai_text_severity":{"description":"AI-determined text severity","title":"AI Text Severity","type":"string","x-stream-index":"014"},"assigned_to":{"$ref":"#/components/schemas/UserResponse","description":"Moderator assigned to review this item","title":"Assigned To","x-stream-index":"021"},"bans":{"description":"Associated ban records","items":{"$ref":"#/components/schemas/Ban"},"title":"Bans","type":"array","x-stream-index":"022"},"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"018"},"completed_at":{"description":"When the review was completed","format":"date-time","title":"Completed At","type":"number","x-stream-index":"009"},"config_key":{"type":"string","x-stream-index":"028"},"created_at":{"description":"When the item was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"002"},"entity_creator":{"$ref":"#/components/schemas/EntityCreatorResponse","description":"Details about who created the entity","title":"Entity Creator","x-stream-index":"019"},"entity_creator_id":{"description":"ID of who created the entity","title":"Entity Creator ID","type":"string","x-stream-index":"020"},"entity_id":{"description":"ID of the entity being reviewed","title":"Entity ID","type":"string","x-stream-index":"005"},"entity_type":{"description":"Type of entity being reviewed","title":"Entity Type","type":"string","x-stream-index":"004"},"feeds_v2_activity":{"$ref":"#/components/schemas/EnrichedActivity","description":"Associated feed activity","title":"Feeds V2 Activity","x-stream-index":"025"},"feeds_v2_reaction":{"$ref":"#/components/schemas/Reaction","description":"Associated feed reaction","title":"Feeds V2 Reaction","x-stream-index":"026"},"flags":{"description":"Associated flag records","items":{"$ref":"#/components/schemas/FlagResponse"},"title":"Flags","type":"array","x-stream-index":"023"},"flags_count":{"format":"int32","type":"integer","x-stream-index":"029"},"id":{"description":"Unique identifier of the review queue item","title":"ID","type":"string","x-stream-index":"001"},"languages":{"description":"Detected languages in the content","items":{"type":"string"},"title":"Languages","type":"array","x-stream-index":"012"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Associated message details","title":"Message","x-stream-index":"015"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content being moderated","title":"Moderation Payload","x-stream-index":"006"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"017"},"recommended_action":{"description":"Suggested moderation action","title":"Recommended Action","type":"string","x-stream-index":"008"},"reviewed_at":{"description":"When the item was reviewed","format":"date-time","title":"Reviewed At","type":"number","x-stream-index":"010"},"reviewed_by":{"description":"ID of the moderator who reviewed the item","title":"Reviewed By","type":"string","x-stream-index":"011"},"severity":{"description":"Severity level of the content","format":"int32","title":"Severity","type":"integer","x-stream-index":"013"},"status":{"description":"Current status of the review","title":"Status","type":"string","x-stream-index":"007"},"teams":{"description":"Teams associated with this item","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"027"},"updated_at":{"description":"When the item was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"003"}},"required":["id","created_at","updated_at","entity_type","entity_id","status","recommended_action","reviewed_by","languages","severity","ai_text_severity","bans","flags","actions","flags_count"],"type":"object"},"RingSettings":{"properties":{"auto_cancel_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_timeout_ms","missed_call_timeout_ms"],"type":"object"},"RingSettingsRequest":{"properties":{"auto_cancel_timeout_ms":{"description":"When none of the callees accept a ring call in this time a rejection will be sent by the caller with reason 'timeout' by the SDKs","format":"int32","maximum":180000,"minimum":5000,"title":"AutoCancelTimeoutMs","type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"description":"When a callee is online but doesn't answer a ring call in this time a rejection will be sent with reason 'timeout' by the SDKs","format":"int32","maximum":180000,"minimum":5000,"title":"IncomingCallTimeoutMs","type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"description":"When a callee doesn't accept or reject a ring call in this time a missed call event will be sent","format":"int32","maximum":180000,"minimum":5000,"title":"MissedCallTimeoutMs","type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_timeout_ms"],"title":"RingSettingsRequest","type":"object"},"RingSettingsResponse":{"properties":{"auto_cancel_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_timeout_ms","missed_call_timeout_ms"],"type":"object"},"RuleBuilderAction":{"properties":{"ban_options":{"$ref":"#/components/schemas/BanOptions","x-stream-index":"002"},"flag_content_options":{"$ref":"#/components/schemas/FlagContentOptions","x-stream-index":"004"},"flag_user_options":{"$ref":"#/components/schemas/FlagUserOptions","x-stream-index":"003"},"remove_content_options":{"$ref":"#/components/schemas/BlockContentOptions","x-stream-index":"005"},"type":{"type":"string","x-stream-index":"001"}},"required":["type"],"type":"object"},"RuleBuilderCondition":{"properties":{"confidence":{"format":"float","type":"number","x-stream-index":"002"},"content_count_rule_params":{"$ref":"#/components/schemas/ContentCountRuleParameters","x-stream-index":"007"},"image_content_params":{"$ref":"#/components/schemas/ImageContentParameters","x-stream-index":"009"},"image_rule_params":{"$ref":"#/components/schemas/ImageRuleParameters","x-stream-index":"004"},"text_content_params":{"$ref":"#/components/schemas/TextContentParameters","x-stream-index":"008"},"text_rule_params":{"$ref":"#/components/schemas/TextRuleParameters","x-stream-index":"003"},"type":{"type":"string","x-stream-index":"001"},"user_created_within_params":{"$ref":"#/components/schemas/UserCreatedWithinParameters","x-stream-index":"011"},"user_rule_params":{"$ref":"#/components/schemas/UserRuleParameters","x-stream-index":"006"},"video_content_params":{"$ref":"#/components/schemas/VideoContentParameters","x-stream-index":"010"},"video_rule_params":{"$ref":"#/components/schemas/VideoRuleParameters","x-stream-index":"005"}},"required":["type"],"type":"object"},"RuleBuilderConditionGroup":{"properties":{"conditions":{"items":{"$ref":"#/components/schemas/RuleBuilderCondition"},"type":"array","x-stream-index":"002"},"logic":{"type":"string","x-stream-index":"001"}},"required":["logic","conditions"],"type":"object"},"RuleBuilderConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"rules":{"items":{"$ref":"#/components/schemas/RuleBuilderRule"},"type":"array","x-stream-index":"002"}},"required":["rules"],"type":"object"},"RuleBuilderRule":{"properties":{"action":{"$ref":"#/components/schemas/RuleBuilderAction","x-stream-index":"007"},"conditions":{"items":{"$ref":"#/components/schemas/RuleBuilderCondition"},"type":"array","x-stream-index":"004"},"cooldown_period":{"type":"string","x-stream-index":"009"},"enabled":{"type":"boolean","x-stream-index":"008"},"groups":{"items":{"$ref":"#/components/schemas/RuleBuilderConditionGroup"},"type":"array","x-stream-index":"006"},"id":{"type":"string","x-stream-index":"001"},"logic":{"type":"string","x-stream-index":"005"},"name":{"type":"string","x-stream-index":"002"},"rule_type":{"type":"string","x-stream-index":"003"}},"required":["id","name","rule_type","action","enabled"],"type":"object"},"SDKUsageReport":{"properties":{"per_sdk_usage":{"additionalProperties":{"$ref":"#/components/schemas/PerSDKUsageReport"},"type":"object","x-stream-index":"001"}},"required":["per_sdk_usage"],"type":"object"},"SDKUsageReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateSDKUsageReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"SFUIDLastSeen":{"properties":{"id":{"type":"string","x-stream-index":"001.001"},"last_seen":{"format":"date-time","type":"number","x-stream-index":"002"},"process_start_time":{"format":"int64","type":"integer","x-stream-index":"001.002"}},"required":["id","process_start_time","last_seen"],"type":"object"},"SFUResponse":{"properties":{"edge_name":{"type":"string","x-stream-index":"001"},"url":{"type":"string","x-stream-index":"002"},"ws_endpoint":{"type":"string","x-stream-index":"003"}},"required":["edge_name","url","ws_endpoint"],"type":"object"},"STTEgressConfig":{"properties":{"closed_captions_enabled":{"type":"boolean","x-stream-index":"005"},"external_storage":{"$ref":"#/components/schemas/ExternalStorage","x-stream-index":"011"},"language":{"type":"string","x-stream-index":"008"},"storage_name":{"type":"string","x-stream-index":"010"},"translation_languages":{"items":{"type":"string"},"type":"array","x-stream-index":"009"},"translations_enabled":{"type":"boolean","x-stream-index":"006"},"upload_transcriptions":{"type":"boolean","x-stream-index":"004"},"whisper_server_base_url":{"type":"string","x-stream-index":"007"}},"type":"object"},"ScreensharingSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled"],"type":"object"},"ScreensharingSettingsRequest":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"type":"object"},"ScreensharingSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled"],"type":"object"},"SearchPayload":{"properties":{"filter_conditions":{"additionalProperties":{},"description":"Channel filter conditions","maximum":100,"minimum":1,"title":"Channel filter","type":"object","x-stream-docs-page-id":"query_channels","x-stream-index":"002"},"limit":{"description":"Number of messages to return","format":"int32","title":"Limit","type":"integer","x-stream-index":"005"},"message_filter_conditions":{"additionalProperties":{},"description":"Message filter conditions","title":"Message filter","type":"object","x-stream-index":"003"},"message_options":{"$ref":"#/components/schemas/MessageOptions","x-stream-index":"004"},"next":{"description":"Pagination parameter. Cannot be used with non-zero offset.","title":"Next","type":"string","x-stream-index":"008"},"offset":{"description":"Pagination offset. Cannot be used with sort or next.","format":"int32","title":"Offset","type":"integer","x-stream-index":"006"},"query":{"description":"Search phrase","title":"Query","type":"string","x-stream-index":"001"},"sort":{"description":"Sort parameters. Cannot be used with non-zero offset","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"007"}},"required":["filter_conditions"],"type":"object"},"SearchResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"005.001"},"next":{"description":"Value to pass to the next search query in order to paginate","title":"Next","type":"string","x-stream-index":"003"},"previous":{"description":"Value that points to the previous page. Pass as the next value in a search query to paginate backwards","title":"Previous","type":"string","x-stream-index":"004"},"results":{"description":"Search results","items":{"$ref":"#/components/schemas/SearchResult"},"title":"Results","type":"array","x-stream-index":"001"},"results_warning":{"$ref":"#/components/schemas/SearchWarning","description":"Warning about the search results","title":"Results Warning","x-stream-index":"002"}},"required":["results","duration"],"type":"object"},"SearchResult":{"properties":{"message":{"$ref":"#/components/schemas/SearchResultMessage","description":"Found message","title":"Message","x-stream-index":"001"}},"type":"object"},"SearchResultMessage":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"001.008"},"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel object","title":"Channel","x-stream-index":"002"},"cid":{"type":"string","x-stream-index":"001.022"},"command":{"type":"string","x-stream-index":"001.004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.023"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.026"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.025"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"001.018"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001.041"},"html":{"type":"string","x-stream-index":"001.005"},"i18n":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.030"},"id":{"type":"string","x-stream-index":"001.001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"001.028"},"latest_reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"001.009"},"mentioned_users":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"001.029"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"001.036"},"mml":{"type":"string","x-stream-index":"001.003"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"001.039"},"own_reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"001.010"},"parent_id":{"type":"string","x-stream-index":"001.015"},"pin_expires":{"format":"date-time","type":"number","x-stream-index":"001.035"},"pinned":{"type":"boolean","x-stream-index":"001.032"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"001.033"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001.034"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001.038"},"poll_id":{"type":"string","x-stream-index":"001.037"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001.020"},"quoted_message_id":{"type":"string","x-stream-index":"001.019"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001.011"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"001.014"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001.012"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"001.042"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"001.017"},"restricted_visibility":{"items":{"type":"string"},"type":"array","x-stream-index":"001.040"},"shadowed":{"type":"boolean","x-stream-index":"001.027"},"shared_location":{"$ref":"#/components/schemas/SharedLocationResponseData","x-stream-index":"001.043"},"show_in_channel":{"type":"boolean","x-stream-index":"001.016"},"silent":{"type":"boolean","x-stream-index":"001.031"},"text":{"type":"string","x-stream-index":"001.002"},"thread_participants":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"001.021"},"type":{"type":"string","x-stream-index":"001.006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.024"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001.007"}},"required":["id","text","html","type","user","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned","restricted_visibility"],"type":"object"},"SearchWarning":{"properties":{"channel_search_cids":{"description":"Channel CIDs for the searched channels","items":{"type":"string"},"title":"Channel Search CIDs","type":"array","x-stream-index":"004"},"channel_search_count":{"description":"Number of channels searched","format":"int32","title":"Channel Search Count","type":"integer","x-stream-index":"003"},"warning_code":{"description":"Code corresponding to the warning","format":"int32","title":"Warning Code","type":"integer","x-stream-index":"002"},"warning_description":{"description":"Description of the warning","title":"Warning Description","type":"string","x-stream-index":"001"}},"required":["warning_description","warning_code"],"type":"object"},"SendCallEventRequest":{"description":"Send a call event to the other user","nullable":true,"properties":{"custom":{"additionalProperties":{},"title":"Custom","type":"object","x-stream-index":"004"}},"title":"SendCallEventRequest","type":"object"},"SendCallEventResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"SendCallEventResponse","type":"object"},"SendEventRequest":{"nullable":true,"properties":{"event":{"$ref":"#/components/schemas/EventRequest","x-stream-index":"001"}},"required":["event"],"type":"object"},"SendMessageRequest":{"nullable":true,"properties":{"keep_channel_hidden":{"type":"boolean","x-stream-index":"008"},"message":{"$ref":"#/components/schemas/MessageRequest","x-stream-index":"001"},"skip_enrich_url":{"type":"boolean","x-stream-index":"003"},"skip_push":{"type":"boolean","x-stream-index":"002"}},"required":["message"],"type":"object"},"SendMessageResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Message response","title":"Message","x-stream-index":"001"},"pending_message_metadata":{"additionalProperties":{"type":"string"},"description":"Pending message metadata","title":"Pending message metadata","type":"object","x-stream-index":"002"}},"required":["message","duration"],"type":"object"},"SendReactionRequest":{"nullable":true,"properties":{"enforce_unique":{"description":"Whether to replace all existing user reactions","title":"Enforce unique","type":"boolean","x-stream-index":"003"},"reaction":{"$ref":"#/components/schemas/ReactionRequest","x-stream-index":"002"},"skip_push":{"description":"Skips any mobile push notifications","title":"Skip push","type":"boolean","x-stream-index":"004"}},"required":["reaction"],"type":"object"},"SendReactionResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001"},"reaction":{"$ref":"#/components/schemas/ReactionResponse","x-stream-index":"002"}},"required":["message","reaction","duration"],"title":"Response","type":"object"},"SessionSettings":{"properties":{"inactivity_timeout_seconds":{"format":"int32","maximum":900,"minimum":5,"type":"integer","x-stream-index":"001"}},"required":["inactivity_timeout_seconds"],"type":"object"},"SessionSettingsRequest":{"properties":{"inactivity_timeout_seconds":{"format":"int32","maximum":900,"minimum":5,"type":"integer","x-stream-index":"001"}},"required":["inactivity_timeout_seconds"],"type":"object"},"SessionSettingsResponse":{"properties":{"inactivity_timeout_seconds":{"format":"int32","maximum":900,"minimum":5,"type":"integer","x-stream-index":"001"}},"required":["inactivity_timeout_seconds"],"type":"object"},"ShadowBlockActionRequest":{"type":"object"},"SharedLocation":{"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"013"},"channel_cid":{"type":"string","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"010"},"created_by_device_id":{"type":"string","x-stream-index":"008"},"end_at":{"format":"date-time","type":"number","x-stream-index":"009"},"latitude":{"format":"float","maximum":90,"minimum":18446744073709552000,"type":"number","x-stream-index":"006"},"longitude":{"format":"float","maximum":180,"minimum":18446744073709552000,"type":"number","x-stream-index":"007"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"012"},"message_id":{"type":"string","x-stream-index":"004"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"011"},"user_id":{"type":"string","x-stream-index":"005"}},"required":["channel_cid","message_id","user_id","created_by_device_id","created_at","updated_at"],"type":"object"},"SharedLocationResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001.011"},"channel_cid":{"description":"Channel CID","title":"string","type":"string","x-stream-index":"001.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.008"},"created_by_device_id":{"description":"Device ID that created the live location","title":"string","type":"string","x-stream-index":"001.006"},"duration":{"type":"string","x-stream-index":"002.001"},"end_at":{"description":"Time when the live location expires","format":"date-time","title":"string","type":"number","x-stream-index":"001.007"},"latitude":{"description":"Latitude coordinate","format":"float","title":"number","type":"number","x-stream-index":"001.004"},"longitude":{"description":"Longitude coordinate","format":"float","title":"number","type":"number","x-stream-index":"001.005"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001.010"},"message_id":{"description":"Message ID","title":"string","type":"string","x-stream-index":"001.002"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.009"},"user_id":{"description":"User ID","title":"string","type":"string","x-stream-index":"001.003"}},"required":["channel_cid","message_id","user_id","latitude","longitude","created_by_device_id","created_at","updated_at","duration"],"type":"object"},"SharedLocationResponseData":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"011"},"channel_cid":{"type":"string","x-stream-index":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"created_by_device_id":{"type":"string","x-stream-index":"006"},"end_at":{"format":"date-time","type":"number","x-stream-index":"007"},"latitude":{"format":"float","type":"number","x-stream-index":"004"},"longitude":{"format":"float","type":"number","x-stream-index":"005"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"010"},"message_id":{"type":"string","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["channel_cid","message_id","user_id","latitude","longitude","created_by_device_id","created_at","updated_at"],"type":"object"},"SharedLocationsResponse":{"nullable":true,"properties":{"active_live_locations":{"items":{"$ref":"#/components/schemas/SharedLocationResponseData"},"type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["active_live_locations","duration"],"type":"object"},"ShowChannelRequest":{"nullable":true,"type":"object"},"ShowChannelResponse":{"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"},"SortParamRequest":{"nullable":true,"properties":{"direction":{"description":"Direction of sorting, 1 for Ascending, -1 for Descending, default is 1","format":"int32","title":"Direction","type":"integer","x-stream-index":"002"},"field":{"description":"Name of field to sort by","title":"Field","type":"string","x-stream-index":"001"}},"type":"object"},"StartClosedCaptionsRequest":{"nullable":true,"properties":{"enable_transcription":{"description":"Enable transcriptions along with closed captions","title":"Enable Transcription","type":"boolean","x-stream-index":"002"},"external_storage":{"description":"Which external storage to use for transcriptions (only applicable if enable_transcription is true)","title":"External Storage","type":"string","x-stream-index":"003"},"language":{"description":"The spoken language in the call, if not provided the language defined in the transcription settings will be used","enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"title":"Language","type":"string","x-stream-index":"004"}},"type":"object"},"StartClosedCaptionsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"StartFrameRecordingRequest":{"nullable":true,"properties":{"recording_external_storage":{"type":"string","x-stream-index":"002"}},"title":"StartFrameRecordingRequest","type":"object"},"StartFrameRecordingResponse":{"description":"StartFrameRecordingResponse is the response payload for the start frame recording endpoint.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StartFrameRecordingResponse","type":"object"},"StartHLSBroadcastingRequest":{"description":"StartHLSBroadcastingRequest is the payload for starting an HLS broadcasting.","nullable":true,"title":"StartHLSBroadcastingRequest","type":"object"},"StartHLSBroadcastingResponse":{"description":"StartHLSBroadcastingResponse is the payload for starting an HLS broadcasting.","nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"},"playlist_url":{"description":"the URL of the HLS playlist","title":"PlaylistURL","type":"string","x-stream-index":"002"}},"required":["duration","playlist_url"],"title":"StartHLSBroadcastingResponse","type":"object"},"StartRTMPBroadcastsRequest":{"description":"StartRTMPBroadcastsRequest is the payload for starting RTMP broadcasts.","nullable":true,"properties":{"broadcasts":{"description":"List of broadcasts to start","items":{"$ref":"#/components/schemas/RTMPBroadcastRequest"},"maximum":1,"minimum":1,"title":"Broadcasts","type":"array","x-stream-index":"002"}},"required":["broadcasts"],"title":"StartRTMPBroadcastsRequest","type":"object"},"StartRTMPBroadcastsResponse":{"description":"StartRTMPBroadcastsResponse is the payload for starting an RTMP broadcast.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StartRTMPBroadcastsResponse","type":"object"},"StartRecordingRequest":{"nullable":true,"properties":{"recording_external_storage":{"type":"string","x-stream-index":"002"}},"title":"StartRecordingRequest","type":"object"},"StartRecordingResponse":{"description":"StartRecordingResponse is the response payload for the start recording endpoint.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StartRecordingResponse","type":"object"},"StartTranscriptionRequest":{"nullable":true,"properties":{"enable_closed_captions":{"description":"Enable closed captions along with transcriptions","title":"Enable Closed Captions","type":"boolean","x-stream-index":"003"},"language":{"description":"The spoken language in the call, if not provided the language defined in the transcription settings will be used","enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"title":"Language","type":"string","x-stream-index":"004"},"transcription_external_storage":{"description":"Store transcriptions in this external storage","title":"External Storage","type":"string","x-stream-index":"002"}},"type":"object"},"StartTranscriptionResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StartTranscriptionResponse","type":"object"},"StatsOptions":{"properties":{"enable_rtc_stats":{"type":"boolean","x-stream-index":"002"},"reporting_interval_ms":{"format":"int32","type":"integer","x-stream-index":"001"}},"required":["reporting_interval_ms","enable_rtc_stats"],"type":"object"},"StopAllRTMPBroadcastsRequest":{"nullable":true,"title":"StopAllRTMPBroadcastsRequest","type":"object"},"StopAllRTMPBroadcastsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StopAllRTMPBroadcastsResponse","type":"object"},"StopClosedCaptionsRequest":{"nullable":true,"properties":{"stop_transcription":{"type":"boolean","x-stream-index":"003"}},"type":"object"},"StopClosedCaptionsResponse":{"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"},"StopFrameRecordingRequest":{"nullable":true,"type":"object"},"StopFrameRecordingResponse":{"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"},"StopHLSBroadcastingRequest":{"nullable":true,"type":"object"},"StopHLSBroadcastingResponse":{"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"},"StopLiveRequest":{"nullable":true,"properties":{"continue_closed_caption":{"type":"boolean","x-stream-index":"006"},"continue_hls":{"type":"boolean","x-stream-index":"003"},"continue_recording":{"type":"boolean","x-stream-index":"004"},"continue_rtmp_broadcasts":{"type":"boolean","x-stream-index":"007"},"continue_transcription":{"type":"boolean","x-stream-index":"005"}},"title":"StopLiveRequest","type":"object"},"StopLiveResponse":{"nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"The call that was stopped","title":"Call","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["call","duration"],"title":"StopLiveResponse","type":"object"},"StopRTMPBroadcastsRequest":{"description":"Request for stopping RTMP broadcasts","nullable":true,"title":"StopRTMPBroadcastsRequest","type":"object"},"StopRTMPBroadcastsResponse":{"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"},"StopRecordingRequest":{"nullable":true,"type":"object"},"StopRecordingResponse":{"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"},"StopTranscriptionRequest":{"nullable":true,"properties":{"stop_closed_captions":{"type":"boolean","x-stream-index":"003"}},"type":"object"},"StopTranscriptionResponse":{"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"},"SubmitActionRequest":{"nullable":true,"properties":{"action_type":{"description":"Type of moderation action to perform (mark_reviewed, delete_message, etc.)","enum":["mark_reviewed","delete_message","delete_activity","delete_reaction","ban","custom","unban","restore","delete_user","unblock","shadow_block","unmask","kick_user","end_call"],"title":"Action Type","type":"string","x-stream-index":"002"},"ban":{"$ref":"#/components/schemas/BanActionRequest","description":"Configuration for ban action","title":"Ban","x-stream-index":"008"},"custom":{"$ref":"#/components/schemas/CustomActionRequest","description":"Configuration for custom action","title":"Custom","x-stream-index":"009"},"delete_activity":{"$ref":"#/components/schemas/DeleteActivityRequest","description":"Configuration for activity deletion action","title":"Delete Activity","x-stream-index":"004"},"delete_message":{"$ref":"#/components/schemas/DeleteMessageRequest","description":"Configuration for message deletion action","title":"Delete Message","x-stream-index":"003"},"delete_reaction":{"$ref":"#/components/schemas/DeleteReactionRequest","description":"Configuration for reaction deletion action","title":"Delete Reaction","x-stream-index":"005"},"delete_user":{"$ref":"#/components/schemas/DeleteUserRequest","description":"Configuration for user deletion action","title":"Delete User","x-stream-index":"006"},"item_id":{"description":"UUID of the review queue item to act on","title":"Item ID","type":"string","x-stream-index":"001"},"mark_reviewed":{"$ref":"#/components/schemas/MarkReviewedRequest","description":"Configuration for marking item as reviewed","title":"Mark Reviewed","x-stream-index":"007"},"unban":{"$ref":"#/components/schemas/UnbanActionRequest","description":"Configuration for unban action","title":"Unban","x-stream-index":"010"}},"required":["item_id","action_type"],"type":"object"},"SubmitActionResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"Updated review queue item after action was performed","title":"Item","x-stream-index":"001"}},"required":["duration"],"type":"object"},"SubscriberStatsResponse":{"properties":{"total":{"format":"int32","type":"integer","x-stream-index":"001"},"total_subscribed_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"003"},"unique":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["total","unique","total_subscribed_duration_seconds"],"type":"object"},"SyncRequest":{"description":"Sync request","nullable":true,"properties":{"channel_cids":{"description":"List of channel CIDs to sync","items":{"type":"string"},"maximum":255,"minimum":1,"title":"Channel CIDs","type":"array","x-stream-index":"001"},"last_sync_at":{"description":"Date from which synchronization should happen","format":"date-time","title":"Last sync at","type":"number","x-stream-index":"002"}},"required":["channel_cids","last_sync_at"],"title":"SyncRequest","type":"object"},"SyncResponse":{"description":"Sync response","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"events":{"description":"List of events","items":{"$ref":"#/components/schemas/WSEvent"},"title":"Events","type":"array","x-stream-index":"001"},"inaccessible_cids":{"description":"List of CIDs that user can't access","items":{"type":"string"},"title":"Inaccessible CIDs","type":"array","x-stream-index":"002"}},"required":["events","duration"],"title":"SyncResponse","type":"object"},"TargetResolution":{"properties":{"bitrate":{"format":"int32","maximum":6000000,"type":"integer","x-stream-index":"003"},"height":{"format":"int32","maximum":3840,"minimum":240,"type":"integer","x-stream-index":"002"},"width":{"format":"int32","maximum":3840,"minimum":240,"type":"integer","x-stream-index":"001"}},"required":["width","height"],"type":"object"},"TextContentParameters":{"properties":{"blocklist_match":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"contains_url":{"type":"boolean","x-stream-index":"002"},"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001"},"severity":{"type":"string","x-stream-index":"003"}},"type":"object"},"TextRuleParameters":{"properties":{"blocklist_match":{"items":{"type":"string"},"type":"array","x-stream-index":"006"},"contains_url":{"type":"boolean","x-stream-index":"004"},"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"severity":{"type":"string","x-stream-index":"005"},"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"required":["threshold","time_window"],"type":"object"},"ThreadParticipant":{"description":"Represents a user that is participating in a thread.","nullable":true,"properties":{"app_pk":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"001"},"channel_cid":{"type":"string","x-stream-index":"002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"007"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"last_read_at":{"format":"date-time","type":"number","x-stream-index":"009"},"last_thread_message_at":{"format":"date-time","type":"number","x-stream-index":"003"},"left_thread_at":{"description":"Left Thread At is the time when the user left the thread","format":"date-time","title":"Left Thread At","type":"number","x-stream-index":"008"},"thread_id":{"description":"Thead ID is unique string identifier of the thread","title":"ID","type":"string","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User is the user object","title":"User","x-stream-index":"006"},"user_id":{"description":"User ID is unique string identifier of the user","title":"User ID","type":"string","x-stream-index":"005"}},"required":["app_pk","channel_cid","created_at","last_read_at","custom"],"title":"ThreadParticipant","type":"object"},"ThreadResponse":{"properties":{"active_participant_count":{"description":"Active Participant Count","format":"int32","title":"Active Participant Count","type":"integer","x-stream-index":"009"},"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel","title":"ChannelResponse","x-stream-index":"002"},"channel_cid":{"description":"Channel CID","title":"Channel CID","type":"string","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"012"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"Created By User","title":"User","x-stream-index":"006"},"created_by_user_id":{"description":"Created By User ID","title":"Created By User ID","type":"string","x-stream-index":"005"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"016"},"deleted_at":{"description":"Deleted At","format":"date-time","title":"Deleted At","type":"number","x-stream-index":"014"},"last_message_at":{"description":"Last Message At","format":"date-time","title":"Last Message At","type":"number","x-stream-index":"011"},"parent_message":{"$ref":"#/components/schemas/MessageResponse","description":"Parent Message","title":"Message","x-stream-index":"004"},"parent_message_id":{"description":"Parent Message ID","title":"Parent Message ID","type":"string","x-stream-index":"003"},"participant_count":{"description":"Participant Count","format":"int32","title":"Participant Count","type":"integer","x-stream-index":"008"},"reply_count":{"description":"Reply Count","format":"int32","title":"Reply Count","type":"integer","x-stream-index":"007"},"thread_participants":{"description":"Thread Participants","items":{"$ref":"#/components/schemas/ThreadParticipant"},"title":"ThreadParticipants","type":"array","x-stream-index":"010"},"title":{"description":"Title","title":"Title","type":"string","x-stream-index":"015"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"013"}},"required":["channel_cid","parent_message_id","created_by_user_id","created_at","updated_at","title","custom"],"type":"object"},"ThreadStateResponse":{"nullable":true,"properties":{"active_participant_count":{"description":"Active Participant Count","format":"int32","title":"Active Participant Count","type":"integer","x-stream-index":"001.009"},"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel","title":"ChannelResponse","x-stream-index":"001.002"},"channel_cid":{"description":"Channel CID","title":"Channel CID","type":"string","x-stream-index":"001.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.012"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"Created By User","title":"User","x-stream-index":"001.006"},"created_by_user_id":{"description":"Created By User ID","title":"Created By User ID","type":"string","x-stream-index":"001.005"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"001.016"},"deleted_at":{"description":"Deleted At","format":"date-time","title":"Deleted At","type":"number","x-stream-index":"001.014"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"004"},"last_message_at":{"description":"Last Message At","format":"date-time","title":"Last Message At","type":"number","x-stream-index":"001.011"},"latest_replies":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","x-stream-index":"002"},"parent_message":{"$ref":"#/components/schemas/MessageResponse","description":"Parent Message","title":"Message","x-stream-index":"001.004"},"parent_message_id":{"description":"Parent Message ID","title":"Parent Message ID","type":"string","x-stream-index":"001.003"},"participant_count":{"description":"Participant Count","format":"int32","title":"Participant Count","type":"integer","x-stream-index":"001.008"},"read":{"items":{"$ref":"#/components/schemas/ReadStateResponse"},"type":"array","x-stream-index":"003"},"reply_count":{"description":"Reply Count","format":"int32","title":"Reply Count","type":"integer","x-stream-index":"001.007"},"thread_participants":{"description":"Thread Participants","items":{"$ref":"#/components/schemas/ThreadParticipant"},"title":"ThreadParticipants","type":"array","x-stream-index":"001.010"},"title":{"description":"Title","title":"Title","type":"string","x-stream-index":"001.015"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.013"}},"required":["channel_cid","parent_message_id","created_by_user_id","created_at","updated_at","title","custom","latest_replies"],"type":"object"},"ThreadUpdatedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"001.002"},"channel_type":{"type":"string","x-stream-index":"001.003"},"cid":{"type":"string","x-stream-index":"001.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"thread":{"$ref":"#/components/schemas/ThreadResponse","x-stream-index":"003.001"},"type":{"default":"thread.updated","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"ThreadUpdatedEvent","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"},"Thresholds":{"description":"Sets thresholds for AI moderation","properties":{"explicit":{"$ref":"#/components/schemas/LabelThresholds","description":"Thresholds for explicit messages","title":"LabelThresholds","x-stream-index":"001"},"spam":{"$ref":"#/components/schemas/LabelThresholds","description":"Thresholds for spam","title":"LabelThresholds","x-stream-index":"002"},"toxic":{"$ref":"#/components/schemas/LabelThresholds","description":"Thresholds for toxic messages","title":"LabelThresholds","x-stream-index":"003"}},"title":"Auto moderation thresholds","type":"object"},"ThumbnailResponse":{"properties":{"image_url":{"type":"string","x-stream-index":"001"}},"required":["image_url"],"type":"object"},"ThumbnailsSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"ThumbnailsSettingsRequest":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"ThumbnailsSettingsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"Time":{"type":"object"},"TrackStatsResponse":{"nullable":true,"properties":{"duration_seconds":{"format":"int32","type":"integer","x-stream-index":"002"},"track_type":{"type":"string","x-stream-index":"001"}},"required":["track_type","duration_seconds"],"type":"object"},"TranscriptionSettings":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"title":"Mode","type":"string","x-stream-index":"002"},"language":{"description":"The language used in this call as a two letter code","enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"title":"Language","type":"string","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"title":"Mode","type":"string","x-stream-index":"001"}},"required":["mode","closed_caption_mode","languages","language"],"type":"object"},"TranscriptionSettingsRequest":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"002"},"language":{"enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"type":"string","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode"],"type":"object"},"TranscriptionSettingsResponse":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"002"},"language":{"enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"type":"string","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode","closed_caption_mode","languages","language"],"type":"object"},"TranslateMessageRequest":{"nullable":true,"properties":{"language":{"description":"Language to translate message to","enum":["af","sq","am","ar","az","bn","bs","bg","zh","zh-TW","hr","cs","da","fa-AF","nl","en","et","fi","fr","fr-CA","ka","de","el","ha","he","hi","hu","id","it","ja","ko","lv","ms","no","fa","ps","pl","pt","ro","ru","sr","sk","sl","so","es","es-MX","sw","sv","tl","ta","th","tr","uk","ur","vi","lt","ht"],"title":"Language","type":"string","x-stream-index":"001"}},"required":["language"],"type":"object"},"TruncateChannelRequest":{"nullable":true,"properties":{"hard_delete":{"description":"Permanently delete channel data (messages, reactions, etc.)","title":"Hard delete","type":"boolean","x-stream-index":"002"},"member_ids":{"description":"List of member IDs to hide message history for. If empty, truncates the channel for all members","items":{"type":"string"},"maximum":100,"title":"Member IDs","type":"array","x-stream-index":"007"},"message":{"$ref":"#/components/schemas/MessageRequest","x-stream-index":"004"},"skip_push":{"description":"When `message` is set disables all push notifications for it","title":"Skip push","type":"boolean","x-stream-index":"005"},"truncated_at":{"description":"Truncate channel data up to `truncated_at`. The system message (if provided) creation time is always greater than `truncated_at`","format":"date-time","title":"Truncated at","type":"number","x-stream-index":"006"}},"type":"object"},"TruncateChannelResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Truncated channel object","title":"Channel","x-stream-index":"002"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Truncated message object","title":"Message","x-stream-index":"003"}},"required":["duration"],"type":"object"},"TypingIndicators":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"TypingIndicatorsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"TypingStartEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"parent_id":{"type":"string","x-stream-index":"001"},"type":{"default":"typing.start","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"TypingStartEvent","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"},"TypingStopEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"parent_id":{"type":"string","x-stream-index":"001"},"type":{"default":"typing.stop","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"TypingStopEvent","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"},"UnbanActionRequest":{"type":"object"},"UnblockActionRequest":{"type":"object"},"UnblockUserRequest":{"description":"UnblockUserRequest is the payload for unblocking a user.","nullable":true,"properties":{"user_id":{"description":"the user to unblock","title":"UserID","type":"string","x-stream-index":"003"}},"required":["user_id"],"title":"UnblockUserRequest","type":"object"},"UnblockUserResponse":{"description":"UnblockUserResponse is the payload for unblocking a user.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"UnblockUserResponse","type":"object"},"UnblockUsersRequest":{"nullable":true,"properties":{"blocked_user_id":{"type":"string","x-stream-index":"001"}},"required":["blocked_user_id"],"type":"object"},"UnblockUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"UnblockedUserEvent":{"description":"This event is sent when a user is unblocked on a call,\nthis can be useful to notify the user that they can now join the call again","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.unblocked_user","description":"The type of event: \"call.unblocked_user\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user that was unblocked","title":"User","x-stream-index":"003"}},"required":["type","created_at","call_cid","user"],"title":"UnblockedUserEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"UnmuteChannelRequest":{"nullable":true,"properties":{"channel_cids":{"description":"Channel CIDs to mute (if multiple channels)","items":{"type":"string"},"maximum":25,"title":"Channel CIDs","type":"array","x-stream-index":"001.002"},"expiration":{"description":"Duration of mute in milliseconds","title":"Expiration","type":"integer","x-stream-index":"001.003"}},"type":"object"},"UnmuteResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"non_existing_users":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"required":["duration"],"title":"Response","type":"object"},"UnpinRequest":{"description":"UnpinRequest is the payload for unpinning a message.","nullable":true,"properties":{"session_id":{"description":"the session ID of the user who pinned the message","title":"SessionID","type":"string","x-stream-index":"003"},"user_id":{"description":"the user ID of the user who pinned the message","title":"UserID","type":"string","x-stream-index":"002"}},"required":["user_id","session_id"],"title":"UnpinRequest","type":"object"},"UnpinResponse":{"description":"UnpinResponse is the payload for unpinning a message.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"UnpinResponse","type":"object"},"UnreadCountsChannel":{"properties":{"channel_id":{"type":"string","x-stream-index":"001"},"last_read":{"format":"date-time","type":"number","x-stream-index":"003"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["channel_id","unread_count","last_read"],"type":"object"},"UnreadCountsChannelType":{"properties":{"channel_count":{"format":"int32","type":"integer","x-stream-index":"002"},"channel_type":{"type":"string","x-stream-index":"001"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["channel_type","channel_count","unread_count"],"type":"object"},"UnreadCountsThread":{"properties":{"last_read":{"format":"date-time","type":"number","x-stream-index":"002"},"last_read_message_id":{"type":"string","x-stream-index":"003"},"parent_message_id":{"type":"string","x-stream-index":"004"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"001"}},"required":["unread_count","last_read","last_read_message_id","parent_message_id"],"type":"object"},"UpdateBlockListRequest":{"nullable":true,"properties":{"team":{"type":"string","x-stream-index":"002"},"words":{"description":"List of words to block","items":{"type":"string"},"minimum":1,"title":"Words","type":"array","x-stream-index":"003"}},"title":"Update block list","type":"object","x-stream-docs-page-id":"update_block_list"},"UpdateBlockListResponse":{"description":"Basic response information","nullable":true,"properties":{"blocklist":{"$ref":"#/components/schemas/BlockListResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["duration"],"title":"Response","type":"object"},"UpdateCallMembersRequest":{"description":"Update call members","nullable":true,"properties":{"remove_members":{"description":"List of userID to remove","items":{"type":"string"},"maximum":100,"title":"Remove Members","type":"array","x-stream-index":"003"},"update_members":{"description":"List of members to update or insert","items":{"$ref":"#/components/schemas/MemberRequest"},"maximum":100,"title":"Update Members","type":"array","x-stream-index":"004"}},"title":"UpdateCallMembersRequest","type":"object"},"UpdateCallMembersResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"002"}},"required":["duration","members"],"title":"Response","type":"object"},"UpdateCallRequest":{"description":"Request for updating a call","nullable":true,"properties":{"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"003"},"settings_override":{"$ref":"#/components/schemas/CallSettingsRequest","description":"the settings to change for this call","title":"Settings Override","x-stream-index":"004"},"starts_at":{"description":"the time the call is scheduled to start","format":"date-time","title":"Starts At","type":"number","x-stream-index":"005"}},"title":"UpdateCallRequest","type":"object"},"UpdateCallResponse":{"description":"Response for updating a call","nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001.001"},"duration":{"type":"string","x-stream-index":"002.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001.002"},"membership":{"$ref":"#/components/schemas/MemberResponse","x-stream-index":"001.003"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"001.004"}},"required":["call","members","own_capabilities","blocked_users","duration"],"title":"UpdateCallResponse","type":"object"},"UpdateChannelPartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"type":"object","x-stream-index":"002.001"},"unset":{"items":{"type":"string"},"type":"array","x-stream-index":"002.002"}},"title":"UpdateChannelPartialRequest","type":"object"},"UpdateChannelPartialResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Updated channel object","title":"Channel","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"members":{"description":"List of updated members","items":{"$ref":"#/components/schemas/ChannelMemberResponse"},"title":"ChannelMemberResponse","type":"array","x-stream-index":"002"}},"required":["members","duration"],"type":"object"},"UpdateChannelRequest":{"nullable":true,"properties":{"accept_invite":{"description":"Set to `true` to accept the invite","title":"Accept invite","type":"boolean","x-stream-index":"008"},"add_members":{"description":"List of user IDs to add to the channel","items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"title":"Add members","type":"array","x-stream-index":"001"},"add_moderators":{"description":"List of user IDs to make channel moderators","items":{"type":"string"},"maximum":100,"title":"Add moderators","type":"array","x-stream-index":"003"},"assign_roles":{"description":"List of channel member role assignments. If any specified user is not part of the channel, the request will fail","items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"title":"Assign roles","type":"array","x-stream-index":"006"},"cooldown":{"description":"Sets cool down period for the channel in seconds","format":"int32","maximum":120,"minimum":0,"title":"Cool down","type":"integer","x-stream-index":"007"},"data":{"$ref":"#/components/schemas/ChannelInput","x-stream-index":"013.001"},"demote_moderators":{"description":"List of user IDs to take away moderators status from","items":{"type":"string"},"maximum":100,"title":"Demote moderators","type":"array","x-stream-index":"004"},"hide_history":{"description":"Set to `true` to hide channel's history when adding new members","title":"Hide history","type":"boolean","x-stream-index":"012"},"invites":{"description":"List of user IDs to invite to the channel","items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"title":"Invites","type":"array","x-stream-index":"005"},"message":{"$ref":"#/components/schemas/MessageRequest","description":"Message to send to the chat when channel is successfully updated","title":"Message","x-stream-index":"010"},"reject_invite":{"description":"Set to `true` to reject the invite","title":"Reject invite","type":"boolean","x-stream-index":"009"},"remove_members":{"description":"List of user IDs to remove from the channel","items":{"type":"string"},"maximum":100,"title":"Remove members","type":"array","x-stream-index":"002"},"skip_push":{"description":"When `message` is set disables all push notifications for it","title":"Skip push","type":"boolean","x-stream-index":"011"}},"title":"Channel update request","type":"object","x-stream-docs-page-id":"channel_update"},"UpdateChannelResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Updated channel","title":"Channel","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"004.001"},"members":{"description":"List of channel members","items":{"$ref":"#/components/schemas/ChannelMember"},"title":"Members","type":"array","x-stream-index":"003"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Message sent to the chat","title":"Message","x-stream-index":"002"}},"required":["members","duration"],"type":"object"},"UpdateLiveLocationRequest":{"nullable":true,"properties":{"end_at":{"description":"Time when the live location expires","format":"date-time","title":"string","type":"number","x-stream-index":"004"},"latitude":{"description":"Latitude coordinate","format":"float","maximum":90,"minimum":18446744073709552000,"title":"number","type":"number","x-stream-index":"002"},"longitude":{"description":"Longitude coordinate","format":"float","maximum":180,"minimum":18446744073709552000,"title":"number","type":"number","x-stream-index":"003"},"message_id":{"description":"Live location ID","title":"string","type":"string","x-stream-index":"001"}},"required":["message_id"],"type":"object"},"UpdateMemberPartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"type":"object","x-stream-index":"002.001"},"unset":{"items":{"type":"string"},"type":"array","x-stream-index":"002.002"}},"type":"object"},"UpdateMemberPartialResponse":{"nullable":true,"properties":{"channel_member":{"$ref":"#/components/schemas/ChannelMemberResponse","description":"Updated channel member","title":"Channel member","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["duration"],"type":"object"},"UpdateMessagePartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"description":"Sets new field values","title":"Set","type":"object","x-stream-index":"002.001","x-stream-map":{"key":"field","title":"Value","description":"New value to set"}},"skip_enrich_url":{"description":"Skip enriching the URL in the message","title":"SkipEnrichURL","type":"boolean","x-stream-index":"001"},"unset":{"description":"Array of field names to unset","items":{"type":"string"},"title":"Unset","type":"array","x-stream-index":"002.002"}},"type":"object"},"UpdateMessagePartialResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Updated message","title":"Message","x-stream-index":"001"},"pending_message_metadata":{"additionalProperties":{"type":"string"},"description":"Pending message metadata","title":"PendingMessageMetadata","type":"object","x-stream-index":"002"}},"required":["duration"],"type":"object"},"UpdateMessageRequest":{"nullable":true,"properties":{"message":{"$ref":"#/components/schemas/MessageRequest","description":"Message","title":"MessageRequest","x-stream-index":"001"},"skip_enrich_url":{"description":"Skip enrich URL","title":"boolean","type":"boolean","x-stream-index":"003"},"skip_push":{"type":"boolean","x-stream-index":"002"}},"required":["message"],"type":"object"},"UpdateMessageResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001"},"pending_message_metadata":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"002"}},"required":["message","duration"],"title":"Response","type":"object"},"UpdatePollOptionRequest":{"nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"004"},"id":{"description":"Option ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"},"text":{"description":"Option text","title":"string","type":"string","x-stream-index":"003"}},"required":["id","text"],"type":"object"},"UpdatePollPartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"description":"Sets new field values","title":"Set","type":"object","x-stream-index":"002.001","x-stream-map":{"key":"field","title":"Value","description":"New value to set"}},"unset":{"description":"Array of field names to unset","items":{"type":"string"},"title":"Unset","type":"array","x-stream-index":"002.002"}},"type":"object"},"UpdatePollRequest":{"nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"011"},"allow_answers":{"description":"Allow answers","title":"boolean","type":"boolean","x-stream-index":"009"},"allow_user_suggested_options":{"description":"Allow user suggested options","title":"boolean","type":"boolean","x-stream-index":"008"},"description":{"description":"Poll description","title":"string","type":"string","x-stream-index":"003"},"enforce_unique_vote":{"description":"Enforce unique vote","title":"boolean","type":"boolean","x-stream-index":"005"},"id":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"},"is_closed":{"description":"Is closed","title":"boolean","type":"boolean","x-stream-index":"010"},"max_votes_allowed":{"description":"Max votes allowed","format":"int32","maximum":10,"title":"integer","type":"integer","x-stream-index":"007"},"name":{"description":"Poll name","title":"string","type":"string","x-stream-index":"002"},"options":{"description":"Poll options","items":{"$ref":"#/components/schemas/PollOptionRequest"},"maximum":100,"title":"PollOptions","type":"array","x-stream-index":"004"},"voting_visibility":{"description":"Voting visibility","enum":["anonymous","public"],"title":"string","type":"string","x-stream-index":"006"}},"required":["id","name"],"type":"object"},"UpdateReminderRequest":{"nullable":true,"properties":{"remind_at":{"format":"date-time","type":"number","x-stream-index":"001"}},"type":"object"},"UpdateReminderResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"001"}},"required":["reminder","duration"],"title":"Response","type":"object"},"UpdateThreadPartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"description":"Sets new field values","title":"Set","type":"object","x-stream-index":"004.001","x-stream-map":{"key":"field","title":"Value","description":"New value to set"}},"unset":{"description":"Array of field names to unset","items":{"type":"string"},"title":"Unset","type":"array","x-stream-index":"004.002"}},"type":"object"},"UpdateThreadPartialResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"thread":{"$ref":"#/components/schemas/ThreadResponse","description":"Updated thread (not enriched)","title":"Thread","x-stream-index":"001"}},"required":["thread","duration"],"type":"object"},"UpdateUserPartialRequest":{"properties":{"id":{"description":"User ID to update","title":"ID","type":"string","x-stream-index":"001"},"set":{"additionalProperties":{},"type":"object","x-stream-index":"002.001"},"unset":{"items":{"type":"string"},"type":"array","x-stream-index":"002.002"}},"required":["id"],"type":"object"},"UpdateUserPermissionsRequest":{"nullable":true,"properties":{"grant_permissions":{"items":{"type":"string"},"type":"array","x-stream-index":"002"},"revoke_permissions":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"user_id":{"type":"string","x-stream-index":"001"}},"required":["user_id"],"type":"object"},"UpdateUserPermissionsResponse":{"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"},"UpdateUsersPartialRequest":{"nullable":true,"properties":{"users":{"items":{"$ref":"#/components/schemas/UpdateUserPartialRequest"},"maximum":100,"type":"array","x-stream-index":"001"}},"required":["users"],"type":"object"},"UpdateUsersRequest":{"nullable":true,"properties":{"users":{"additionalProperties":{"$ref":"#/components/schemas/UserRequest"},"description":"Object containing users","title":"Users","type":"object","x-stream-index":"001","x-stream-map":{"key":"user_id"}}},"required":["users"],"type":"object"},"UpdateUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"membership_deletion_task_id":{"type":"string","x-stream-index":"002"},"users":{"additionalProperties":{"$ref":"#/components/schemas/FullUserResponse"},"description":"Object containing users","title":"Users","type":"object","x-stream-index":"001","x-stream-map":{"key":"user_id"}}},"required":["users","membership_deletion_task_id","duration"],"type":"object"},"UpdatedCallPermissionsEvent":{"description":"This event is sent to notify about permission changes for a user, clients receiving this event should update their UI accordingly","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"own_capabilities":{"description":"The capabilities of the current user","items":{"$ref":"#/components/schemas/OwnCapability"},"title":"Own capabilities","type":"array","x-stream-index":"004"},"type":{"default":"call.permissions_updated","description":"The type of event: \"call.permissions_updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who received the new permissions","title":"User","x-stream-index":"003"}},"required":["type","created_at","call_cid","user","own_capabilities"],"title":"UpdatedCallPermissionsEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"UpsertConfigRequest":{"nullable":true,"properties":{"ai_image_config":{"$ref":"#/components/schemas/AIImageConfig","description":"Configuration for AI image analysis","title":"AI Image Config","x-stream-index":"010"},"ai_text_config":{"$ref":"#/components/schemas/AITextConfig","description":"Configuration for AI text analysis","title":"AI Text Config","x-stream-index":"008"},"ai_video_config":{"$ref":"#/components/schemas/AIVideoConfig","description":"Configuration for AI video analysis","title":"AI Video Config","x-stream-index":"011"},"async":{"description":"Whether moderation should be performed asynchronously","title":"Async","type":"boolean","x-stream-index":"003"},"automod_platform_circumvention_config":{"$ref":"#/components/schemas/AutomodPlatformCircumventionConfig","description":"Configuration for platform circumvention detection","title":"Automod Platform Circumvention Config","x-stream-index":"005"},"automod_semantic_filters_config":{"$ref":"#/components/schemas/AutomodSemanticFiltersConfig","description":"Configuration for semantic filtering","title":"Automod Semantic Filters Config","x-stream-index":"006"},"automod_toxicity_config":{"$ref":"#/components/schemas/AutomodToxicityConfig","description":"Configuration for toxicity detection","title":"Automod Toxicity Config","x-stream-index":"004"},"aws_rekognition_config":{"$ref":"#/components/schemas/AIImageConfig","x-stream-index":"015"},"block_list_config":{"$ref":"#/components/schemas/BlockListConfig","description":"Configuration for block list filtering","title":"Block List Config","x-stream-index":"007"},"bodyguard_config":{"$ref":"#/components/schemas/AITextConfig","x-stream-index":"014"},"google_vision_config":{"$ref":"#/components/schemas/GoogleVisionConfig","description":"Configuration for Google Vision integration","title":"Google Vision Config","x-stream-index":"009"},"key":{"description":"Unique identifier for the moderation configuration","title":"Key","type":"string","x-stream-index":"001"},"rule_builder_config":{"$ref":"#/components/schemas/RuleBuilderConfig","description":"Configuration for custom rule builder (max 3 rules, max 5 conditions per rule)","title":"Rule Builder Config","x-stream-index":"013"},"team":{"description":"Team associated with the configuration","maxLength":128,"minLength":1,"title":"Team","type":"string","x-stream-index":"002"},"velocity_filter_config":{"$ref":"#/components/schemas/VelocityFilterConfig","description":"Configuration for velocity-based filtering","title":"Velocity Filter Config","x-stream-index":"012"},"video_call_rule_config":{"$ref":"#/components/schemas/VideoCallRuleConfig","x-stream-index":"016"}},"required":["key"],"type":"object"},"UpsertConfigResponse":{"nullable":true,"properties":{"config":{"$ref":"#/components/schemas/ConfigResponse","description":"The created or updated moderation configuration","title":"Config","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["duration"],"type":"object"},"UpsertPushPreferencesRequest":{"nullable":true,"properties":{"preferences":{"description":"A list of push preferences for channels, calls, or the user.","items":{"$ref":"#/components/schemas/PushPreferenceInput"},"type":"array","x-stream-index":"001"}},"required":["preferences"],"type":"object"},"UpsertPushPreferencesResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"user_channel_preferences":{"additionalProperties":{"additionalProperties":{"$ref":"#/components/schemas/ChannelPushPreferences"},"type":"object"},"description":"The channel specific push notification preferences, only returned for channels you've edited.","title":"User Channel Notification Preferences","type":"object","x-stream-index":"002"},"user_preferences":{"additionalProperties":{"$ref":"#/components/schemas/PushPreferences"},"description":"The user preferences, always returned regardless if you edited it","title":"User Preferences","type":"object","x-stream-index":"001"}},"required":["user_preferences","user_channel_preferences","duration"],"type":"object"},"User":{"properties":{"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"046"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"017"},"banned":{"type":"boolean","x-stream-index":"016"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"013"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"023"},"language":{"type":"string","x-stream-index":"035"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"026"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"042"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"005"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"009"}},"required":["id","role","teams_role","custom","banned","online"],"type":"object"},"UserBannedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"006.002"},"channel_type":{"type":"string","x-stream-index":"006.003"},"cid":{"type":"string","x-stream-index":"006.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008.002"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"001"},"expiration":{"format":"date-time","type":"number","x-stream-index":"003"},"reason":{"type":"string","x-stream-index":"004"},"shadow":{"type":"boolean","x-stream-index":"002"},"team":{"type":"string","x-stream-index":"005.001"},"type":{"default":"user.banned","type":"string","x-stream-index":"008.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007.001"}},"required":["created_by","shadow","cid","channel_id","channel_type","type","created_at"],"title":"UserBannedEvent","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"},"UserCreatedWithinParameters":{"properties":{"max_age":{"type":"string","x-stream-index":"001"}},"type":"object"},"UserDeactivatedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"001"},"type":{"default":"user.deactivated","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["created_by","type","created_at"],"title":"UserDeactivatedEvent","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"},"UserDeletedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"delete_conversation_channels":{"type":"boolean","x-stream-index":"005"},"hard_delete":{"type":"boolean","x-stream-index":"003.001"},"mark_messages_deleted":{"type":"boolean","x-stream-index":"004"},"type":{"default":"user.deleted","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"001.001"}},"required":["type","created_at","hard_delete","mark_messages_deleted","delete_conversation_channels"],"title":"UserDeletedEvent","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"},"UserFeedbackReport":{"properties":{"count_by_rating":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001"},"unreported_count":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["count_by_rating","unreported_count"],"type":"object"},"UserFeedbackReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateUserFeedbackReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"UserMute":{"nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"expires":{"description":"Date/time of mute expiration","format":"date-time","title":"Expires","type":"number","x-stream-index":"008"},"target":{"$ref":"#/components/schemas/User","description":"User who's muted","title":"Target","x-stream-index":"007"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/User","description":"Owner of channel mute","title":"User","x-stream-index":"005"}},"required":["created_at","updated_at"],"type":"object"},"UserMuteResponse":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"expires":{"format":"date-time","type":"number","x-stream-index":"003"},"target":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"}},"required":["created_at","updated_at"],"type":"object"},"UserMutedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"target_user":{"type":"string","x-stream-index":"001"},"target_users":{"items":{"type":"string"},"type":"array","x-stream-index":"002"},"type":{"default":"user.muted","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"UserMutedEvent","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"},"UserPresenceChangedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"type":{"default":"user.presence.changed","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"001.001"}},"required":["type","created_at"],"title":"UserPresenceChangedEvent","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"},"UserRatingReportResponse":{"properties":{"average":{"format":"float","type":"number","x-stream-index":"002"},"count":{"format":"int32","type":"integer","x-stream-index":"001"}},"required":["count","average"],"type":"object"},"UserReactivatedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"type":{"default":"user.reactivated","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"001"}},"required":["type","created_at"],"title":"UserReactivatedEvent","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"},"UserRequest":{"description":"User request object","properties":{"custom":{"additionalProperties":{},"description":"Custom user data","title":"Custom","type":"object","x-stream-index":"004"},"id":{"description":"User ID","title":"ID","type":"string","x-stream-index":"001"},"image":{"description":"User's profile image URL","title":"Image","type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"006"},"language":{"type":"string","x-stream-index":"005"},"name":{"description":"Optional name of user","title":"Name","type":"string","x-stream-index":"002"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"007"}},"required":["id"],"title":"UserRequest","type":"object"},"UserResponse":{"description":"User response object","properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"banned":{"description":"Whether a user is banned or not","title":"Banned","type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.017"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"001.004"},"deactivated_at":{"description":"Date of deactivation","format":"date-time","title":"Deactivated at","type":"number","x-stream-index":"001.016"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"001.011"},"id":{"description":"Unique user identifier","title":"ID","type":"string","x-stream-index":"001.001"},"image":{"title":"Image","type":"string","x-stream-index":"001.003"},"language":{"description":"Preferred language of a user","title":"Language","type":"string","x-stream-index":"001.005"},"last_active":{"description":"Date of last activity","format":"date-time","title":"Last active","type":"number","x-stream-index":"001.014"},"name":{"description":"Optional name of user","title":"Name","type":"string","x-stream-index":"001.002"},"online":{"description":"Whether a user online or not","title":"Online","type":"boolean","x-stream-index":"001.013"},"revoke_tokens_issued_before":{"description":"Revocation date for tokens","format":"date-time","title":"Revoke tokens issued before","type":"number","x-stream-index":"001.015"},"role":{"description":"Determines the set of user permissions","title":"Role","type":"string","x-stream-index":"001.006"},"teams":{"description":"List of teams user is a part of","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids","shadow_banned","invisible"],"title":"UserResponse","type":"object"},"UserResponseCommonFields":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"018"},"banned":{"type":"boolean","x-stream-index":"012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"017"},"created_at":{"format":"date-time","type":"number","x-stream-index":"009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"id":{"type":"string","x-stream-index":"001"},"image":{"type":"string","x-stream-index":"003"},"language":{"type":"string","x-stream-index":"005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"014"},"name":{"type":"string","x-stream-index":"002"},"online":{"type":"boolean","x-stream-index":"013"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"015"},"role":{"type":"string","x-stream-index":"006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids"],"type":"object"},"UserResponsePrivacyFields":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"banned":{"type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.017"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.011"},"id":{"type":"string","x-stream-index":"001.001"},"image":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"003"},"language":{"type":"string","x-stream-index":"001.005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"001.014"},"name":{"type":"string","x-stream-index":"001.002"},"online":{"type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"002"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.015"},"role":{"type":"string","x-stream-index":"001.006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids"],"type":"object"},"UserRuleParameters":{"properties":{"max_age":{"type":"string","x-stream-index":"001"}},"type":"object"},"UserUnbannedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"005.002"},"shadow":{"type":"boolean","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"004.001"},"type":{"default":"user.unbanned","type":"string","x-stream-index":"005.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["shadow","cid","channel_id","channel_type","type","created_at"],"title":"UserUnbannedEvent","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"},"UserUpdatedEvent":{"description":"This event is sent when a user gets updated. The event contains information about the updated user.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"type":{"default":"user.updated","description":"The type of event: \"user.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.002"},"user":{"$ref":"#/components/schemas/UserResponsePrivacyFields","description":"The updated user","title":"User","x-stream-index":"002.001"}},"required":["type","created_at","custom","user"],"title":"UserUpdatedEvent","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"},"UserWatchingStartEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"team":{"type":"string","x-stream-index":"002.001"},"type":{"default":"user.watching.start","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005.001"},"watcher_count":{"format":"int32","type":"integer","x-stream-index":"001.001"}},"required":["watcher_count","type","created_at","cid","channel_id","channel_type"],"title":"UserWatchingStartEvent","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"},"UserWatchingStopEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"type":{"default":"user.watching.stop","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"},"watcher_count":{"format":"int32","type":"integer","x-stream-index":"001.001"}},"required":["watcher_count","type","created_at","cid","channel_id","channel_type"],"title":"UserWatchingStopEvent","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"},"VelocityFilterConfig":{"properties":{"advanced_filters":{"type":"boolean","x-stream-index":"007"},"async":{"type":"boolean","x-stream-index":"001"},"cascading_actions":{"type":"boolean","x-stream-index":"004"},"cids_per_user":{"format":"int32","type":"integer","x-stream-index":"006"},"enabled":{"type":"boolean","x-stream-index":"002"},"first_message_only":{"type":"boolean","x-stream-index":"005"},"rules":{"items":{"$ref":"#/components/schemas/VelocityFilterConfigRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules","cascading_actions","first_message_only","cids_per_user","advanced_filters"],"type":"object"},"VelocityFilterConfigRule":{"properties":{"action":{"enum":["flag","shadow","remove","ban"],"type":"string","x-stream-index":"001"},"ban_duration":{"format":"int32","type":"integer","x-stream-index":"002"},"cascading_action":{"enum":["flag","shadow","remove","ban"],"type":"string","x-stream-index":"006"},"cascading_threshold":{"format":"int64","type":"integer","x-stream-index":"005"},"check_message_context":{"type":"boolean","x-stream-index":"009"},"fast_spam_threshold":{"format":"int32","type":"integer","x-stream-index":"007"},"fast_spam_ttl":{"format":"int32","type":"integer","x-stream-index":"010"},"ip_ban":{"type":"boolean","x-stream-index":"004"},"probation_period":{"format":"int32","type":"integer","x-stream-index":"014"},"shadow_ban":{"type":"boolean","x-stream-index":"003"},"slow_spam_ban_duration":{"format":"int32","type":"integer","x-stream-index":"012"},"slow_spam_threshold":{"format":"int32","type":"integer","x-stream-index":"008"},"slow_spam_ttl":{"format":"int32","type":"integer","x-stream-index":"011"},"url_only":{"type":"boolean","x-stream-index":"013"}},"required":["action","ban_duration","shadow_ban","ip_ban","cascading_threshold","cascading_action","fast_spam_threshold","slow_spam_threshold","check_message_context","fast_spam_ttl","slow_spam_ttl","url_only","probation_period"],"type":"object"},"VideoCallRuleConfig":{"properties":{"rules":{"additionalProperties":{"$ref":"#/components/schemas/HarmConfig"},"type":"object","x-stream-index":"001"}},"required":["rules"],"type":"object"},"VideoContentParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"type":"object"},"VideoEndCallRequest":{"type":"object"},"VideoKickUserRequest":{"type":"object"},"VideoOrientation":{"properties":{"orientation":{"type":"integer","x-stream-index":"004"}},"type":"object"},"VideoReactionOverTimeResponse":{"properties":{"by_minute":{"items":{"$ref":"#/components/schemas/CountByMinuteResponse"},"type":"array","x-stream-index":"001"}},"type":"object"},"VideoReactionsResponse":{"nullable":true,"properties":{"count_over_time":{"$ref":"#/components/schemas/VideoReactionOverTimeResponse","x-stream-index":"002"},"reaction":{"type":"string","x-stream-index":"001"}},"required":["reaction"],"type":"object"},"VideoRuleParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"required":["threshold","time_window"],"type":"object"},"VideoSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"camera_default_on":{"type":"boolean","x-stream-index":"004"},"camera_facing":{"enum":["front","back","external"],"type":"string","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled","target_resolution","camera_default_on","camera_facing"],"type":"object"},"VideoSettingsRequest":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"camera_default_on":{"type":"boolean","x-stream-index":"004"},"camera_facing":{"enum":["front","back","external"],"type":"string","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"type":"object"},"VideoSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"camera_default_on":{"type":"boolean","x-stream-index":"004"},"camera_facing":{"enum":["front","back","external"],"type":"string","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled","target_resolution","camera_default_on","camera_facing"],"type":"object"},"VoteData":{"properties":{"answer_text":{"type":"string","x-stream-index":"002"},"option_id":{"maxLength":255,"type":"string","x-stream-index":"001"}},"type":"object"},"WSAuthMessage":{"description":"Websocket auth message","nullable":true,"properties":{"products":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"token":{"title":"Token","type":"string","x-stream-index":"002"},"user_details":{"$ref":"#/components/schemas/ConnectUserDetailsRequest","x-stream-index":"001"}},"required":["user_details","token"],"title":"WSAuthMessage","type":"object"},"WSClientEvent":{"description":"The discriminator object for all websocket client events, it maps events' payload to the final type","discriminator":{"mapping":{"app.updated":"#/components/schemas/AppUpdatedEvent","draft.deleted":"#/components/schemas/DraftDeletedEvent","draft.updated":"#/components/schemas/DraftUpdatedEvent","health.check":"#/components/schemas/HealthCheckEvent","message.pending":"#/components/schemas/PendingMessageEvent","notification.reminder_due":"#/components/schemas/ReminderNotificationEvent","poll.closed":"#/components/schemas/PollClosedEvent","poll.deleted":"#/components/schemas/PollDeletedEvent","poll.updated":"#/components/schemas/PollUpdatedEvent","poll.vote_casted":"#/components/schemas/PollVoteCastedEvent","poll.vote_changed":"#/components/schemas/PollVoteChangedEvent","poll.vote_removed":"#/components/schemas/PollVoteRemovedEvent","reminder.created":"#/components/schemas/ReminderCreatedEvent","reminder.deleted":"#/components/schemas/ReminderDeletedEvent","reminder.updated":"#/components/schemas/ReminderUpdatedEvent","user.updated":"#/components/schemas/UserUpdatedEvent"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/AppUpdatedEvent"},{"$ref":"#/components/schemas/DraftDeletedEvent"},{"$ref":"#/components/schemas/DraftUpdatedEvent"},{"$ref":"#/components/schemas/HealthCheckEvent"},{"$ref":"#/components/schemas/PendingMessageEvent"},{"$ref":"#/components/schemas/PollClosedEvent"},{"$ref":"#/components/schemas/PollDeletedEvent"},{"$ref":"#/components/schemas/PollUpdatedEvent"},{"$ref":"#/components/schemas/PollVoteCastedEvent"},{"$ref":"#/components/schemas/PollVoteChangedEvent"},{"$ref":"#/components/schemas/PollVoteRemovedEvent"},{"$ref":"#/components/schemas/ReminderCreatedEvent"},{"$ref":"#/components/schemas/ReminderDeletedEvent"},{"$ref":"#/components/schemas/ReminderNotificationEvent"},{"$ref":"#/components/schemas/ReminderUpdatedEvent"},{"$ref":"#/components/schemas/UserUpdatedEvent"}]},"WSEvent":{"description":"The discriminator object for all websocket events, it maps events' payload to the final type","discriminator":{"mapping":{"*":"#/components/schemas/AnyEvent","activity.marked":"#/components/schemas/ActivityMarkedEvent","ai_indicator.clear":"#/components/schemas/AIIndicatorClearEvent","ai_indicator.stop":"#/components/schemas/AIIndicatorStopEvent","ai_indicator.update":"#/components/schemas/AIIndicatorUpdateEvent","app.updated":"#/components/schemas/AppUpdatedEvent","call.accepted":"#/components/schemas/CallAcceptedEvent","call.blocked_user":"#/components/schemas/BlockedUserEvent","call.closed_caption":"#/components/schemas/ClosedCaptionEvent","call.closed_captions_failed":"#/components/schemas/CallClosedCaptionsFailedEvent","call.closed_captions_started":"#/components/schemas/CallClosedCaptionsStartedEvent","call.closed_captions_stopped":"#/components/schemas/CallClosedCaptionsStoppedEvent","call.created":"#/components/schemas/CallCreatedEvent","call.deleted":"#/components/schemas/CallDeletedEvent","call.ended":"#/components/schemas/CallEndedEvent","call.frame_recording_failed":"#/components/schemas/CallFrameRecordingFailedEvent","call.frame_recording_ready":"#/components/schemas/CallFrameRecordingFrameReadyEvent","call.frame_recording_started":"#/components/schemas/CallFrameRecordingStartedEvent","call.frame_recording_stopped":"#/components/schemas/CallFrameRecordingStoppedEvent","call.hls_broadcasting_failed":"#/components/schemas/CallHLSBroadcastingFailedEvent","call.hls_broadcasting_started":"#/components/schemas/CallHLSBroadcastingStartedEvent","call.hls_broadcasting_stopped":"#/components/schemas/CallHLSBroadcastingStoppedEvent","call.live_started":"#/components/schemas/CallLiveStartedEvent","call.member_added":"#/components/schemas/CallMemberAddedEvent","call.member_removed":"#/components/schemas/CallMemberRemovedEvent","call.member_updated":"#/components/schemas/CallMemberUpdatedEvent","call.member_updated_permission":"#/components/schemas/CallMemberUpdatedPermissionEvent","call.missed":"#/components/schemas/CallMissedEvent","call.moderation_blur":"#/components/schemas/CallModerationBlurEvent","call.moderation_warning":"#/components/schemas/CallModerationWarningEvent","call.notification":"#/components/schemas/CallNotificationEvent","call.permission_request":"#/components/schemas/PermissionRequestEvent","call.permissions_updated":"#/components/schemas/UpdatedCallPermissionsEvent","call.reaction_new":"#/components/schemas/CallReactionEvent","call.recording_failed":"#/components/schemas/CallRecordingFailedEvent","call.recording_ready":"#/components/schemas/CallRecordingReadyEvent","call.recording_started":"#/components/schemas/CallRecordingStartedEvent","call.recording_stopped":"#/components/schemas/CallRecordingStoppedEvent","call.rejected":"#/components/schemas/CallRejectedEvent","call.ring":"#/components/schemas/CallRingEvent","call.rtmp_broadcast_failed":"#/components/schemas/CallRtmpBroadcastFailedEvent","call.rtmp_broadcast_started":"#/components/schemas/CallRtmpBroadcastStartedEvent","call.rtmp_broadcast_stopped":"#/components/schemas/CallRtmpBroadcastStoppedEvent","call.session_ended":"#/components/schemas/CallSessionEndedEvent","call.session_participant_count_updated":"#/components/schemas/CallSessionParticipantCountsUpdatedEvent","call.session_participant_joined":"#/components/schemas/CallSessionParticipantJoinedEvent","call.session_participant_left":"#/components/schemas/CallSessionParticipantLeftEvent","call.session_started":"#/components/schemas/CallSessionStartedEvent","call.stats_report_ready":"#/components/schemas/CallStatsReportReadyEvent","call.transcription_failed":"#/components/schemas/CallTranscriptionFailedEvent","call.transcription_ready":"#/components/schemas/CallTranscriptionReadyEvent","call.transcription_started":"#/components/schemas/CallTranscriptionStartedEvent","call.transcription_stopped":"#/components/schemas/CallTranscriptionStoppedEvent","call.unblocked_user":"#/components/schemas/UnblockedUserEvent","call.updated":"#/components/schemas/CallUpdatedEvent","call.user_feedback_submitted":"#/components/schemas/CallUserFeedbackSubmittedEvent","call.user_muted":"#/components/schemas/CallUserMutedEvent","channel.created":"#/components/schemas/ChannelCreatedEvent","channel.deleted":"#/components/schemas/ChannelDeletedEvent","channel.frozen":"#/components/schemas/ChannelFrozenEvent","channel.hidden":"#/components/schemas/ChannelHiddenEvent","channel.kicked":"#/components/schemas/ChannelKickedEvent","channel.truncated":"#/components/schemas/ChannelTruncatedEvent","channel.unfrozen":"#/components/schemas/ChannelUnFrozenEvent","channel.updated":"#/components/schemas/ChannelUpdatedEvent","channel.visible":"#/components/schemas/ChannelVisibleEvent","connection.error":"#/components/schemas/ConnectionErrorEvent","connection.ok":"#/components/schemas/ConnectedEvent","custom":"#/components/schemas/CustomVideoEvent","draft.deleted":"#/components/schemas/DraftDeletedEvent","draft.updated":"#/components/schemas/DraftUpdatedEvent","health.check":"#/components/schemas/HealthCheckEvent","member.added":"#/components/schemas/MemberAddedEvent","member.removed":"#/components/schemas/MemberRemovedEvent","member.updated":"#/components/schemas/MemberUpdatedEvent","message.deleted":"#/components/schemas/MessageDeletedEvent","message.new":"#/components/schemas/MessageNewEvent","message.pending":"#/components/schemas/PendingMessageEvent","message.read":"#/components/schemas/MessageReadEvent","message.undeleted":"#/components/schemas/MessageUndeletedEvent","message.updated":"#/components/schemas/MessageUpdatedEvent","moderation.custom_action":"#/components/schemas/ModerationCustomActionEvent","moderation.flagged":"#/components/schemas/ModerationFlaggedEvent","moderation.mark_reviewed":"#/components/schemas/ModerationMarkReviewedEvent","notification.added_to_channel":"#/components/schemas/NotificationAddedToChannelEvent","notification.channel_deleted":"#/components/schemas/NotificationChannelDeletedEvent","notification.channel_mutes_updated":"#/components/schemas/NotificationChannelMutesUpdatedEvent","notification.channel_truncated":"#/components/schemas/NotificationChannelTruncatedEvent","notification.invite_accepted":"#/components/schemas/NotificationInviteAcceptedEvent","notification.invite_rejected":"#/components/schemas/NotificationInviteRejectedEvent","notification.invited":"#/components/schemas/NotificationInvitedEvent","notification.mark_read":"#/components/schemas/NotificationMarkReadEvent","notification.mark_unread":"#/components/schemas/NotificationMarkUnreadEvent","notification.message_new":"#/components/schemas/NotificationNewMessageEvent","notification.mutes_updated":"#/components/schemas/NotificationMutesUpdatedEvent","notification.reminder_due":"#/components/schemas/ReminderNotificationEvent","notification.removed_from_channel":"#/components/schemas/NotificationRemovedFromChannelEvent","notification.thread_message_new":"#/components/schemas/MessageNewEvent","poll.closed":"#/components/schemas/PollClosedEvent","poll.deleted":"#/components/schemas/PollDeletedEvent","poll.updated":"#/components/schemas/PollUpdatedEvent","poll.vote_casted":"#/components/schemas/PollVoteCastedEvent","poll.vote_changed":"#/components/schemas/PollVoteChangedEvent","poll.vote_removed":"#/components/schemas/PollVoteRemovedEvent","reaction.deleted":"#/components/schemas/ReactionDeletedEvent","reaction.new":"#/components/schemas/ReactionNewEvent","reaction.updated":"#/components/schemas/ReactionUpdatedEvent","reminder.created":"#/components/schemas/ReminderCreatedEvent","reminder.deleted":"#/components/schemas/ReminderDeletedEvent","reminder.updated":"#/components/schemas/ReminderUpdatedEvent","thread.updated":"#/components/schemas/ThreadUpdatedEvent","typing.start":"#/components/schemas/TypingStartEvent","typing.stop":"#/components/schemas/TypingStopEvent","user.banned":"#/components/schemas/UserBannedEvent","user.deactivated":"#/components/schemas/UserDeactivatedEvent","user.deleted":"#/components/schemas/UserDeletedEvent","user.muted":"#/components/schemas/UserMutedEvent","user.presence.changed":"#/components/schemas/UserPresenceChangedEvent","user.reactivated":"#/components/schemas/UserReactivatedEvent","user.unbanned":"#/components/schemas/UserUnbannedEvent","user.updated":"#/components/schemas/UserUpdatedEvent","user.watching.start":"#/components/schemas/UserWatchingStartEvent","user.watching.stop":"#/components/schemas/UserWatchingStopEvent"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/AIIndicatorClearEvent"},{"$ref":"#/components/schemas/AIIndicatorStopEvent"},{"$ref":"#/components/schemas/AIIndicatorUpdateEvent"},{"$ref":"#/components/schemas/ActivityMarkedEvent"},{"$ref":"#/components/schemas/AnyEvent"},{"$ref":"#/components/schemas/AppUpdatedEvent"},{"$ref":"#/components/schemas/BlockedUserEvent"},{"$ref":"#/components/schemas/CallAcceptedEvent"},{"$ref":"#/components/schemas/CallClosedCaptionsFailedEvent"},{"$ref":"#/components/schemas/CallClosedCaptionsStartedEvent"},{"$ref":"#/components/schemas/CallClosedCaptionsStoppedEvent"},{"$ref":"#/components/schemas/CallCreatedEvent"},{"$ref":"#/components/schemas/CallDeletedEvent"},{"$ref":"#/components/schemas/CallEndedEvent"},{"$ref":"#/components/schemas/CallFrameRecordingFailedEvent"},{"$ref":"#/components/schemas/CallFrameRecordingFrameReadyEvent"},{"$ref":"#/components/schemas/CallFrameRecordingStartedEvent"},{"$ref":"#/components/schemas/CallFrameRecordingStoppedEvent"},{"$ref":"#/components/schemas/CallHLSBroadcastingFailedEvent"},{"$ref":"#/components/schemas/CallHLSBroadcastingStartedEvent"},{"$ref":"#/components/schemas/CallHLSBroadcastingStoppedEvent"},{"$ref":"#/components/schemas/CallLiveStartedEvent"},{"$ref":"#/components/schemas/CallMemberAddedEvent"},{"$ref":"#/components/schemas/CallMemberRemovedEvent"},{"$ref":"#/components/schemas/CallMemberUpdatedEvent"},{"$ref":"#/components/schemas/CallMemberUpdatedPermissionEvent"},{"$ref":"#/components/schemas/CallMissedEvent"},{"$ref":"#/components/schemas/CallModerationBlurEvent"},{"$ref":"#/components/schemas/CallModerationWarningEvent"},{"$ref":"#/components/schemas/CallNotificationEvent"},{"$ref":"#/components/schemas/CallReactionEvent"},{"$ref":"#/components/schemas/CallRecordingFailedEvent"},{"$ref":"#/components/schemas/CallRecordingReadyEvent"},{"$ref":"#/components/schemas/CallRecordingStartedEvent"},{"$ref":"#/components/schemas/CallRecordingStoppedEvent"},{"$ref":"#/components/schemas/CallRejectedEvent"},{"$ref":"#/components/schemas/CallRingEvent"},{"$ref":"#/components/schemas/CallRtmpBroadcastFailedEvent"},{"$ref":"#/components/schemas/CallRtmpBroadcastStartedEvent"},{"$ref":"#/components/schemas/CallRtmpBroadcastStoppedEvent"},{"$ref":"#/components/schemas/CallSessionEndedEvent"},{"$ref":"#/components/schemas/CallSessionParticipantCountsUpdatedEvent"},{"$ref":"#/components/schemas/CallSessionParticipantJoinedEvent"},{"$ref":"#/components/schemas/CallSessionParticipantLeftEvent"},{"$ref":"#/components/schemas/CallSessionStartedEvent"},{"$ref":"#/components/schemas/CallStatsReportReadyEvent"},{"$ref":"#/components/schemas/CallTranscriptionFailedEvent"},{"$ref":"#/components/schemas/CallTranscriptionReadyEvent"},{"$ref":"#/components/schemas/CallTranscriptionStartedEvent"},{"$ref":"#/components/schemas/CallTranscriptionStoppedEvent"},{"$ref":"#/components/schemas/CallUpdatedEvent"},{"$ref":"#/components/schemas/CallUserFeedbackSubmittedEvent"},{"$ref":"#/components/schemas/CallUserMutedEvent"},{"$ref":"#/components/schemas/ChannelCreatedEvent"},{"$ref":"#/components/schemas/ChannelDeletedEvent"},{"$ref":"#/components/schemas/ChannelFrozenEvent"},{"$ref":"#/components/schemas/ChannelHiddenEvent"},{"$ref":"#/components/schemas/ChannelKickedEvent"},{"$ref":"#/components/schemas/ChannelTruncatedEvent"},{"$ref":"#/components/schemas/ChannelUnFrozenEvent"},{"$ref":"#/components/schemas/ChannelUpdatedEvent"},{"$ref":"#/components/schemas/ChannelVisibleEvent"},{"$ref":"#/components/schemas/ClosedCaptionEvent"},{"$ref":"#/components/schemas/ConnectedEvent"},{"$ref":"#/components/schemas/ConnectionErrorEvent"},{"$ref":"#/components/schemas/CustomVideoEvent"},{"$ref":"#/components/schemas/DraftDeletedEvent"},{"$ref":"#/components/schemas/DraftUpdatedEvent"},{"$ref":"#/components/schemas/HealthCheckEvent"},{"$ref":"#/components/schemas/MemberAddedEvent"},{"$ref":"#/components/schemas/MemberRemovedEvent"},{"$ref":"#/components/schemas/MemberUpdatedEvent"},{"$ref":"#/components/schemas/MessageDeletedEvent"},{"$ref":"#/components/schemas/MessageNewEvent"},{"$ref":"#/components/schemas/MessageNewEvent"},{"$ref":"#/components/schemas/MessageReadEvent"},{"$ref":"#/components/schemas/MessageUndeletedEvent"},{"$ref":"#/components/schemas/MessageUpdatedEvent"},{"$ref":"#/components/schemas/ModerationCustomActionEvent"},{"$ref":"#/components/schemas/ModerationFlaggedEvent"},{"$ref":"#/components/schemas/ModerationMarkReviewedEvent"},{"$ref":"#/components/schemas/NotificationAddedToChannelEvent"},{"$ref":"#/components/schemas/NotificationChannelDeletedEvent"},{"$ref":"#/components/schemas/NotificationChannelMutesUpdatedEvent"},{"$ref":"#/components/schemas/NotificationChannelTruncatedEvent"},{"$ref":"#/components/schemas/NotificationInviteAcceptedEvent"},{"$ref":"#/components/schemas/NotificationInviteRejectedEvent"},{"$ref":"#/components/schemas/NotificationInvitedEvent"},{"$ref":"#/components/schemas/NotificationMarkReadEvent"},{"$ref":"#/components/schemas/NotificationMarkUnreadEvent"},{"$ref":"#/components/schemas/NotificationMutesUpdatedEvent"},{"$ref":"#/components/schemas/NotificationNewMessageEvent"},{"$ref":"#/components/schemas/NotificationRemovedFromChannelEvent"},{"$ref":"#/components/schemas/PendingMessageEvent"},{"$ref":"#/components/schemas/PermissionRequestEvent"},{"$ref":"#/components/schemas/PollClosedEvent"},{"$ref":"#/components/schemas/PollDeletedEvent"},{"$ref":"#/components/schemas/PollUpdatedEvent"},{"$ref":"#/components/schemas/PollVoteCastedEvent"},{"$ref":"#/components/schemas/PollVoteChangedEvent"},{"$ref":"#/components/schemas/PollVoteRemovedEvent"},{"$ref":"#/components/schemas/ReactionDeletedEvent"},{"$ref":"#/components/schemas/ReactionNewEvent"},{"$ref":"#/components/schemas/ReactionUpdatedEvent"},{"$ref":"#/components/schemas/ReminderCreatedEvent"},{"$ref":"#/components/schemas/ReminderDeletedEvent"},{"$ref":"#/components/schemas/ReminderNotificationEvent"},{"$ref":"#/components/schemas/ReminderUpdatedEvent"},{"$ref":"#/components/schemas/ThreadUpdatedEvent"},{"$ref":"#/components/schemas/TypingStartEvent"},{"$ref":"#/components/schemas/TypingStopEvent"},{"$ref":"#/components/schemas/UnblockedUserEvent"},{"$ref":"#/components/schemas/UpdatedCallPermissionsEvent"},{"$ref":"#/components/schemas/UserBannedEvent"},{"$ref":"#/components/schemas/UserDeactivatedEvent"},{"$ref":"#/components/schemas/UserDeletedEvent"},{"$ref":"#/components/schemas/UserMutedEvent"},{"$ref":"#/components/schemas/UserPresenceChangedEvent"},{"$ref":"#/components/schemas/UserReactivatedEvent"},{"$ref":"#/components/schemas/UserUnbannedEvent"},{"$ref":"#/components/schemas/UserUpdatedEvent"},{"$ref":"#/components/schemas/UserWatchingStartEvent"},{"$ref":"#/components/schemas/UserWatchingStopEvent"}]},"WrappedUnreadCountsResponse":{"description":"Basic response information","nullable":true,"properties":{"channel_type":{"items":{"$ref":"#/components/schemas/UnreadCountsChannelType"},"type":"array","x-stream-index":"001.005"},"channels":{"items":{"$ref":"#/components/schemas/UnreadCountsChannel"},"type":"array","x-stream-index":"001.004"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"threads":{"items":{"$ref":"#/components/schemas/UnreadCountsThread"},"type":"array","x-stream-index":"001.006"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"001.001"},"total_unread_count_by_team":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001.003"},"total_unread_threads_count":{"format":"int32","type":"integer","x-stream-index":"001.002"}},"required":["total_unread_count","total_unread_threads_count","channels","channel_type","threads","duration"],"title":"Response","type":"object"}},"securitySchemes":{"JWT":{"description":"JWT should be always provided when stream-auth-type=jwt.\n\nUsing JWT auth request could be authenticated as user or as server-side.\n\nWhen using user authentication permission checking is going to be applied to requests based on the user that is\nperforming a request.\n\nThe `authorization` header should be a JWT string signed using the secret attached to the API key used to perform\nrequests.\n\n**WARNING** all client-side official SDK do not ship with token generation; this is to make sure that the API secret is not\nshared with an untrusted party such as a browser or a iOS/Android application. Tokens **must** be generated server-side.\nIf you wish, you can configure your application to ignore authentication (see `disable_auth_check`)\nThe JWT string must include only the user_id claim and can include any built-in JWT claim such as iat, exp as well.\n","in":"header","name":"Authorization","type":"apiKey"},"api_key":{"description":"Application API key should be always set in order to authenticate the request.","in":"query","name":"api_key","type":"apiKey"},"stream-auth-type":{"description":"Stream-Auth-Type should be always set in order to authenticate the request. Possible\nvalues: `jwt` or `anonymous`.\n\n`jwt` allows you to authenticate as a user. With this auth type you should also provide valid JWT in Authorization\nheader.\n\n`anonymous` allows you to authenticate as anonymous user. Please note that most advanced features are not available\nto anonymous users.","in":"header","name":"Stream-Auth-Type","type":"apiKey"}}},"info":{"title":"Stream API","version":"v187.13.0"},"openapi":"3.0.3","paths":{"/api/v2/app":{"get":{"description":"This Method returns the application settings\n","operationId":"GetApp","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetApplicationResponse"}}},"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":"Get App Settings","tags":["product:common"]}},"/api/v2/blocklists":{"get":{"description":"Returns all available block lists\n","operationId":"ListBlockLists","parameters":[{"in":"query","name":"team","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListBlockListResponse"}}},"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":"List block lists","tags":["product:common"]},"post":{"description":"Creates a new application blocklist, once created the blocklist can be used by any channel type\n","operationId":"CreateBlockList","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBlockListRequest"}}},"description":"Block list","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBlockListResponse"}}},"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":"Create block list","tags":["product:common"]}},"/api/v2/blocklists/{name}":{"delete":{"description":"Deletes previously created application blocklist\n","operationId":"DeleteBlockList","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"team","schema":{"type":"string","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete block list","tags":["product:common"]},"put":{"description":"Updates contents of the block list\n","operationId":"UpdateBlockList","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Block list name","title":"Name","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBlockListRequest"}}},"description":"Update block list","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBlockListResponse"}}},"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":"Update block list","tags":["product:common"]}},"/api/v2/chat/channels":{"post":{"description":"Query channels with filter query\n","operationId":"QueryChannels","parameters":[{"in":"query","name":"connection_id","schema":{"description":"Websocket connection ID to interact with. You can pass it as Body or URL parameter","title":"Connection ID","type":"string","x-stream-index":"011.003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryChannelsRequest"}}},"description":"Query Channels Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryChannelsResponse"}}},"description":"Channels list"},"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":"Query channels","tags":["product:chat"]}},"/api/v2/chat/channels/delete":{"post":{"description":"Allows to delete several channels at once asynchronously\n\nSends events:\n- channel.deleted\n- channel.deleted\n","operationId":"DeleteChannels","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteChannelsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteChannelsResponse"}}},"description":"Successful 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":"Deletes channels asynchronously","tags":["product:chat"]}},"/api/v2/chat/channels/read":{"post":{"description":"Marks channels as read up to the specific message. If no channels is given, mark all channel as read\n\nSends events:\n- message.read\n- message.read\n","operationId":"MarkChannelsRead","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkChannelsReadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkReadResponse"}}},"description":"Successful 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 channels as read","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/query":{"post":{"description":"This Method creates a channel or returns an existing one with matching attributes\n\nSends events:\n- channel.created\n- member.added\n- member.removed\n- member.updated\n- user.watching.start\n","operationId":"GetOrCreateDistinctChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"connection_id","schema":{"description":"Websocket connection ID to interact with. You can pass it as Body or URL parameter","title":"Connection ID","type":"string","x-stream-index":"012.003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelGetOrCreateRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelStateResponse"}}},"description":"Successful 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":"Get or create channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}":{"delete":{"description":"Deletes channel\n\nSends events:\n- channel.deleted\n- channel.deleted\n","operationId":"DeleteChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"query","name":"hard_delete","schema":{"type":"boolean","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteChannelResponse"}}},"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":"Delete channel","tags":["product:chat"]},"patch":{"description":"Updates certain fields of the channel\n\nSends events:\n- channel.updated\n- channel.updated\n","operationId":"UpdateChannelPartial","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelPartialRequest"}}},"description":"UpdateChannelPartialRequest","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelPartialResponse"}}},"description":"Successful 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":"Partially update channel","tags":["product:chat"]},"post":{"description":"Change channel data\n\nSends events:\n- channel.updated\n- member.added\n- member.removed\n- member.updated\n- message.new\n- channel.updated\n- member.added\n- member.removed\n- member.updated\n- message.new\n","operationId":"UpdateChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"013.002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"013.002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelRequest"}}},"description":"Channel update request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelResponse"}}},"description":"Successful 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":"Update channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/draft":{"delete":{"description":"Deletes a draft\n\nSends events:\n- draft.deleted\n","operationId":"DeleteDraft","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"parent_id","schema":{"description":"Parent message ID","title":"string","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete draft","tags":["product:chat"]},"get":{"description":"Get a draft\n","operationId":"GetDraft","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"parent_id","schema":{"description":"Parent message ID","title":"string","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetDraftResponse"}}},"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":"Get draft","tags":["product:chat"]},"post":{"description":"Creates a draft\n\nSends events:\n- draft.updated\n","operationId":"CreateDraft","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDraftRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDraftResponse"}}},"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":"Create a draft","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/event":{"post":{"description":"Sends event to the channel\n","operationId":"SendEvent","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendEventRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventResponse"}}},"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":"Send event","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/file":{"delete":{"description":"Deletes previously uploaded file\n","operationId":"DeleteFile","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of file","title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"File ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"url","schema":{"description":"File URL to delete","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete file","tags":["product:chat"]},"post":{"description":"Uploads file\n","operationId":"UploadFile","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/FileUploadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileUploadResponse"}}},"description":"Successful 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":"Upload file","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/hide":{"post":{"description":"Marks channel as hidden for current user\n\nSends events:\n- channel.hidden\n- channel.hidden\n","operationId":"HideChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HideChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HideChannelResponse"}}},"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":"Hide channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/image":{"delete":{"description":"Deletes previously uploaded image\n","operationId":"DeleteImage","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of file","title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"File ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"url","schema":{"description":"File URL to delete","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete image","tags":["product:chat"]},"post":{"description":"Uploads image\n","operationId":"UploadImage","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.001.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.001.002"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/ImageUploadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageUploadResponse"}}},"description":"Successful 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":"Upload image","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/member":{"patch":{"description":"\n","operationId":"UpdateMemberPartial","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMemberPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMemberPartialResponse"}}},"description":"Successful 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":"Partially channel member update","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/message":{"post":{"description":"Sends new message to the specified channel\n\nSends events:\n- message.new\n- message.updated\n- message.new\n- message.updated\n","operationId":"SendMessage","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"009.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"009.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendMessageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendMessageResponse"}}},"description":"Successful 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":"Send new message","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/messages":{"get":{"description":"Returns list messages found by IDs\n","operationId":"GetManyMessages","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"ids","required":true,"schema":{"description":"List of comma-separated IDs","items":{"type":"string"},"maximum":50,"minimum":1,"title":"IDs","type":"array","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetManyMessagesResponse"}}},"description":"Successful 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":"Get many messages","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/query":{"post":{"description":"This Method creates a channel or returns an existing one with matching attributes\n\nSends events:\n- channel.created\n- member.added\n- member.removed\n- member.updated\n- user.watching.start\n","operationId":"GetOrCreateChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID (maximum length of 64 characters)","title":"ID","type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"connection_id","schema":{"description":"Websocket connection ID to interact with. You can pass it as Body or URL parameter","title":"Connection ID","type":"string","x-stream-index":"012.003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelGetOrCreateRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelStateResponse"}}},"description":"Successful 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":"Get or create channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/read":{"post":{"description":"Marks channel as read up to the specific message\n\nSends events:\n- message.read\n- message.read\n","operationId":"MarkRead","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkReadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkReadResponse"}}},"description":"Successful 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 read","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/show":{"post":{"description":"Shows previously hidden channel\n\nSends events:\n- channel.visible\n- channel.visible\n","operationId":"ShowChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShowChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShowChannelResponse"}}},"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":"Show channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/stop-watching":{"post":{"description":"Call this Method to stop receiving channel events\n\nSends events:\n- user.watching.stop\n- user.watching.stop\n","operationId":"StopWatchingChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"connection_id","schema":{"type":"string","x-stream-index":"001.003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelStopWatchingRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Stop watching channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/truncate":{"post":{"description":"Truncates messages from a channel. Can be applied to the entire channel or scoped to specific members.\n\nSends events:\n- channel.truncated\n- channel.truncated\n","operationId":"TruncateChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TruncateChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TruncateChannelResponse"}}},"description":"Successful 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":"Truncate channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/unread":{"post":{"description":"Marks channel as unread from a specific message\n","operationId":"MarkUnread","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkUnreadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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 unread","tags":["product:chat"]}},"/api/v2/chat/drafts/query":{"post":{"description":"Queries draft messages for a user\n","operationId":"QueryDrafts","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryDraftsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryDraftsResponse"}}},"description":"Successful 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":"Query draft messages","tags":["product:chat"]}},"/api/v2/chat/members":{"get":{"description":"Find and filter channel members\n","operationId":"QueryMembers","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryMembersPayload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MembersResponse"}}},"description":"Successful 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":"Query members","tags":["product:chat"]}},"/api/v2/chat/messages/{id}":{"delete":{"description":"Deletes message\n\nSends events:\n- message.deleted\n- message.deleted\n","operationId":"DeleteMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID to delete","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"hard","schema":{"description":"Delete all message reactions and replies as well","title":"Hard","type":"boolean","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"deleted_by","schema":{"type":"string","writeOnly":true,"x-stream-index":"003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteMessageResponse"}}},"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":"Delete message","tags":["product:chat"]},"get":{"description":"Returns message by ID\n","operationId":"GetMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"ID of the message","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetMessageResponse"}}},"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":"Get message","tags":["product:chat"]},"post":{"description":"Updates message with new data\n\nSends events:\n- message.updated\n- message.updated\n","operationId":"UpdateMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"004.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessageResponse"}}},"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":"Update message","tags":["product:chat"]},"put":{"description":"Updates certain fields of the message\n\nSends events:\n- message.updated\n- message.updated\n","operationId":"UpdateMessagePartial","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessagePartialRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessagePartialResponse"}}},"description":"Successful 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":"Partially message update","tags":["product:chat"]}},"/api/v2/chat/messages/{id}/action":{"post":{"description":"Executes message command action with given parameters\n\nSends events:\n- message.new\n- message.new\n","operationId":"RunMessageAction","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageActionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}},"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":"Run message command action","tags":["product:chat"]}},"/api/v2/chat/messages/{id}/reaction":{"post":{"description":"Sends reaction to specified message\n\nSends events:\n- reaction.new\n- reaction.updated\n","operationId":"SendReaction","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID to send reaction for","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendReactionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendReactionResponse"}}},"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":"Send reaction","tags":["product:chat"]}},"/api/v2/chat/messages/{id}/reaction/{type}":{"delete":{"description":"Removes user reaction from the message\n\nSends events:\n- reaction.deleted\n","operationId":"DeleteReaction","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID to remove reaction from","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"type","required":true,"schema":{"description":"Reaction type to remove","title":"Type","type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"description":"**Server-side only**. User ID which server acts upon","title":"User ID","type":"string","writeOnly":true,"x-stream-index":"003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteReactionResponse"}}},"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":"Delete reaction","tags":["product:chat"]}},"/api/v2/chat/messages/{id}/reactions":{"get":{"description":"Returns list of reactions of specific message\n","operationId":"GetReactions","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"limit","schema":{"description":"Number of records to return","format":"int32","title":"Limit","type":"integer","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"offset","schema":{"description":"Number of records to offset","format":"int32","title":"Offset","type":"integer","writeOnly":true,"x-stream-index":"003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetReactionsResponse"}}},"description":"Successful 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":"Get reactions","tags":["product:chat"]},"post":{"description":"Get reactions on a message\n","operationId":"QueryReactions","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryReactionsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryReactionsResponse"}}},"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"}},"tags":["product:chat"]}},"/api/v2/chat/messages/{id}/translate":{"post":{"description":"Translates message to a given language using automated translation software\n\nSends events:\n- message.updated\n- message.updated\n","operationId":"TranslateMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TranslateMessageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}},"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":"Translate message","tags":["product:chat"]}},"/api/v2/chat/messages/{message_id}/polls/{poll_id}/vote":{"post":{"description":"Cast a vote on a poll\n\nSends events:\n- feeds.poll.vote_casted\n- feeds.poll.vote_changed\n- feeds.poll.vote_removed\n- poll.vote_casted\n- poll.vote_changed\n- poll.vote_removed\n","operationId":"CastPollVote","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CastPollVoteRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollVoteResponse"}}},"description":"Successful 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":"Cast vote","tags":["product:chat"]}},"/api/v2/chat/messages/{message_id}/polls/{poll_id}/vote/{vote_id}":{"delete":{"description":"Delete a vote from a poll\n\nSends events:\n- feeds.poll.vote_removed\n- poll.vote_removed\n","operationId":"DeletePollVote","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"004"}},{"in":"path","name":"vote_id","required":true,"schema":{"description":"Vote ID","maxLength":255,"title":"string","type":"string","x-stream-index":"005"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollVoteResponse"}}},"description":"Successful 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":"Delete vote","tags":["product:chat"]}},"/api/v2/chat/messages/{message_id}/reminders":{"delete":{"description":"Deletes a user's created reminder\n\nSends events:\n- reminder.deleted\n","operationId":"DeleteReminder","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteReminderResponse"}}},"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":"Delete reminder","tags":["product:chat"]},"patch":{"description":"Updates an existing reminder\n\nSends events:\n- reminder.updated\n","operationId":"UpdateReminder","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateReminderRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateReminderResponse"}}},"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":"Updates Reminder","tags":["product:chat"]},"post":{"description":"Creates a new reminder\n\nSends events:\n- reminder.created\n","operationId":"CreateReminder","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateReminderRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReminderResponseData"}}},"description":"Successful 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":"Create reminder","tags":["product:chat"]}},"/api/v2/chat/messages/{parent_id}/replies":{"get":{"description":"Returns replies (thread) of the message\n","operationId":"GetReplies","parameters":[{"in":"path","name":"parent_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"sort","schema":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":1,"type":"array","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"limit","schema":{"description":"The maximum number of messages to return (max limit ","format":"int32","minimum":0,"title":"Limit","type":"integer","x-stream-index":"003.001"}},{"in":"query","name":"offset","schema":{"description":"The offset to start from","format":"int32","title":"Offset","type":"integer","x-stream-index":"003.002"}},{"in":"query","name":"id_gte","schema":{"description":"The ID of the message to get messages with a timestamp greater than or equal to","title":"IDGTE","type":"string","x-stream-index":"003.003"}},{"in":"query","name":"id_gt","schema":{"description":"The ID of the message to get messages with a timestamp greater than","title":"IDGT","type":"string","x-stream-index":"003.004"}},{"in":"query","name":"id_lte","schema":{"description":"The ID of the message to get messages with a timestamp smaller than or equal to","title":"IDLTE","type":"string","x-stream-index":"003.005"}},{"in":"query","name":"id_lt","schema":{"description":"The ID of the message to get messages with a timestamp smaller than","title":"IDLT","type":"string","x-stream-index":"003.006"}},{"in":"query","name":"created_at_after_or_equal","schema":{"description":"The timestamp to get messages with a created_at timestamp greater than or equal to","format":"date-time","title":"Created_at after or equal","type":"number","x-stream-index":"003.007"}},{"in":"query","name":"created_at_after","schema":{"description":"The timestamp to get messages with a created_at timestamp greater than","format":"date-time","title":"Created_at after","type":"number","x-stream-index":"003.008"}},{"in":"query","name":"created_at_before_or_equal","schema":{"description":"The timestamp to get messages with a created_at timestamp smaller than or equal to","format":"date-time","title":"Created_at after before or equal","type":"number","x-stream-index":"003.009"}},{"in":"query","name":"created_at_before","schema":{"description":"The timestamp to get messages with a created_at timestamp smaller than","format":"date-time","title":"Created_at after before","type":"number","x-stream-index":"003.010"}},{"in":"query","name":"id_around","schema":{"description":"The result will be a set of messages, that are both older and newer than the message with the provided ID, and the message with the ID provided will be in the middle of the set","title":"Id around","type":"string","x-stream-index":"003.011"}},{"in":"query","name":"created_at_around","schema":{"description":"The result will be a set of messages, that are both older and newer than the created_at timestamp provided, distributed evenly around the timestamp","format":"date-time","title":"Created_at around","type":"number","x-stream-index":"003.012"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRepliesResponse"}}},"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":"Get replies","tags":["product:chat"]}},"/api/v2/chat/moderation/flags/message":{"get":{"description":"Find and filter message flags\n","operationId":"QueryMessageFlags","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryMessageFlagsPayload","description":"JSON object with query message flags payload","title":"Payload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryMessageFlagsResponse"}}},"description":"QueryMessageFlagsResponse"},"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":"Query Message Flags","tags":["product:chat"]}},"/api/v2/chat/moderation/mute/channel":{"post":{"description":"Mutes channel for user\n\nSends events:\n- channel.muted\n- channel.muted\n","operationId":"MuteChannel","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteChannelResponse"}}},"description":"Successful 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":"Mute channel","tags":["product:chat"]}},"/api/v2/chat/moderation/unmute/channel":{"post":{"description":"Unmutes channel for user\n\nSends events:\n- channel.unmuted\n- channel.unmuted\n","operationId":"UnmuteChannel","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnmuteChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnmuteResponse"}}},"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":"Unmute channel","tags":["product:chat"]}},"/api/v2/chat/push_preferences":{"post":{"description":"Update the push preferences for a user and or channel member. Set to all, mentions or none\n","operationId":"UpdatePushNotificationPreferences","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertPushPreferencesRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertPushPreferencesResponse"}}},"description":"Successful 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":"Push notification preferences","tags":["product:chat"]}},"/api/v2/chat/query_banned_users":{"get":{"description":"Find and filter channel scoped or global user bans\n","operationId":"QueryBannedUsers","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryBannedUsersPayload","description":"JSON object with query user bans payload","title":"Payload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryBannedUsersResponse"}}},"description":"Successful 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":"Query Banned Users","tags":["product:chat"]}},"/api/v2/chat/reminders/query":{"post":{"description":"Queries reminders\n","operationId":"QueryReminders","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryRemindersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryRemindersResponse"}}},"description":"Successful 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":"Query reminders","tags":["product:chat"]}},"/api/v2/chat/search":{"get":{"description":"Search messages across channels\n","operationId":"Search","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchPayload","description":"JSON object with search payload","title":"Payload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchResponse"}}},"description":"Successful 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":"Search messages","tags":["product:chat"]}},"/api/v2/chat/sync":{"post":{"description":"Returns all events happened since client disconnect in specified channels\n","operationId":"Sync","parameters":[{"in":"query","name":"with_inaccessible_cids","schema":{"description":"If set to true this will add 'inaccessible_cids' to response type","title":"With inaccessible CIDs","type":"boolean","x-stream-index":"003"}},{"in":"query","name":"watch","schema":{"description":"If set to true this will start watching requested and newly added channels that user has access to. If error occurred with this option enabled and it is not an input error - channels will still be watched.","title":"Watch synced channels","type":"boolean","x-stream-index":"004"}},{"in":"query","name":"connection_id","schema":{"type":"string","x-stream-index":"006.003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncRequest"}}},"description":"SyncRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncResponse"}}},"description":"SyncResponse"},"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":"Sync","tags":["product:chat"]}},"/api/v2/chat/threads":{"post":{"description":"Returns the list of threads for specific user\n","operationId":"QueryThreads","parameters":[{"in":"query","name":"connection_id","schema":{"type":"string","x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryThreadsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryThreadsResponse"}}},"description":"Successful 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":"Query Threads","tags":["product:chat"]}},"/api/v2/chat/threads/{message_id}":{"get":{"description":"Return a specific thread\n","operationId":"GetThread","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"watch","schema":{"description":"Start watching the channel this thread belongs to","title":"Watch","type":"boolean","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"connection_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"003"}},{"in":"query","name":"reply_limit","schema":{"description":"Limit the number of replies returned","format":"int32","minimum":0,"title":"Reply limit","type":"integer","writeOnly":true,"x-stream-index":"004"}},{"in":"query","name":"participant_limit","schema":{"description":"Limit the number of participants returned","format":"int32","maximum":100,"minimum":0,"title":"Participant limit","type":"integer","writeOnly":true,"x-stream-index":"005"}},{"in":"query","name":"member_limit","schema":{"description":"Limit the number of members returned per thread channel","format":"int32","maximum":100,"minimum":0,"title":"Member limit","type":"integer","writeOnly":true,"x-stream-index":"006"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetThreadResponse"}}},"description":"Successful 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":"Get Thread","tags":["product:chat"]},"patch":{"description":"Updates certain fields of the thread\n\nSends events:\n- thread.updated\n- thread.updated\n","operationId":"UpdateThreadPartial","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateThreadPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateThreadPartialResponse"}}},"description":"Successful 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":"Partially update thread","tags":["product:chat"]}},"/api/v2/chat/unread":{"get":{"description":"Fetch unread counts for a single user\n","operationId":"UnreadCounts","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WrappedUnreadCountsResponse"}}},"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":"Unread counts","tags":["product:chat"]}},"/api/v2/devices":{"delete":{"description":"Deletes one device\n","operationId":"DeleteDevice","parameters":[{"in":"query","name":"id","required":true,"schema":{"description":"Device ID to delete","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete device","tags":["product:common"]},"get":{"description":"Returns all available devices\n","operationId":"ListDevices","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDevicesResponse"}}},"description":"ListDevicesResponse"},"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":"List devices","tags":["product:common"]},"post":{"description":"Adds a new device to a user, if the same device already exists the call will have no effect\n","operationId":"CreateDevice","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDeviceRequest"}}},"description":"CreateDeviceRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Create device","tags":["product:common"]}},"/api/v2/guest":{"post":{"description":"\n","operationId":"CreateGuest","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGuestRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGuestResponse"}}},"description":"Successful 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":"Create Guest","tags":["product:common"]}},"/api/v2/longpoll":{"get":{"description":"WebSocket fallback transport endpoint\n\nSends events:\n- user.updated\n","operationId":"LongPoll","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WSAuthMessage","x-stream-index":"001"}}},"in":"query","name":"json"},{"in":"query","name":"connection_id","schema":{"maxLength":36,"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"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":"Long Poll (Transport)","tags":["product:common"]}},"/api/v2/moderation/ban":{"post":{"description":"Ban a user from a channel or the entire app\n","operationId":"ban","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BanRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BanResponse"}}},"description":"Successful 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":"Ban","tags":["product:moderation"]}},"/api/v2/moderation/config":{"post":{"description":"Create a new moderation configuration or update an existing one. Configure settings for content filtering, AI analysis, toxicity detection, and other moderation features.\n","operationId":"upsert_config","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertConfigRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertConfigResponse"}}},"description":"Successful 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":"Create or update moderation configuration","tags":["product:moderation"]}},"/api/v2/moderation/config/{key}":{"delete":{"description":"Delete a specific moderation policy by its name\n","operationId":"delete_config","parameters":[{"in":"path","name":"key","required":true,"schema":{"description":"Key of the moderation configuration to delete","title":"Key","type":"string","x-stream-index":"001"}},{"in":"query","name":"team","schema":{"description":"Team associated with the configuration","title":"Team","type":"string","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteModerationConfigResponse"}}},"description":"Successful 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":"Delete a moderation policy","tags":["product:moderation"]},"get":{"description":"Retrieve a specific moderation configuration by its key and team. This configuration contains settings for various moderation features like toxicity detection, AI analysis, and filtering rules.\n","operationId":"get_config","parameters":[{"in":"path","name":"key","required":true,"schema":{"description":"Key of the moderation configuration to retrieve","title":"Key","type":"string","x-stream-index":"001"}},{"in":"query","name":"team","schema":{"description":"Team associated with the configuration","title":"Team","type":"string","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetConfigResponse"}}},"description":"Successful 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":"Get moderation configuration","tags":["product:moderation"]}},"/api/v2/moderation/configs":{"post":{"description":"Search and filter moderation configurations across your application. This endpoint is designed for building moderation dashboards and managing multiple configuration sets.\n","operationId":"query_moderation_configs","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationConfigsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationConfigsResponse"}}},"description":"Successful 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":"Query moderation configurations","tags":["product:moderation"]}},"/api/v2/moderation/flag":{"post":{"description":"Flag any type of content (messages, users, channels, activities) for moderation review. Supports custom content types and additional metadata for flagged content.\n","operationId":"flag","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlagRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlagResponse"}}},"description":"Successful 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":"Flag content for moderation","tags":["product:moderation"]}},"/api/v2/moderation/mute":{"post":{"description":"Mute a user. Mutes are generally not visible to the user you mute, while block is something you notice.\n","operationId":"mute","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteRequest"}}},"description":"MuteRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteResponse"}}},"description":"MuteResponse"},"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":"Mute","tags":["product:moderation"]}},"/api/v2/moderation/review_queue":{"post":{"description":"Query review queue items allows you to filter the review queue items. This is used for building a moderation dashboard.\n","operationId":"query_review_queue","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryReviewQueueRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryReviewQueueResponse"}}},"description":"Successful 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":"Query review queue items","tags":["product:moderation"]}},"/api/v2/moderation/submit_action":{"post":{"description":"Take action on flagged content, such as marking content as safe, deleting content, banning users, or executing custom moderation actions. Supports various action types with configurable parameters.\n","operationId":"submit_action","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitActionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitActionResponse"}}},"description":"Successful 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":"Submit moderation action","tags":["product:moderation"]}},"/api/v2/og":{"get":{"description":"Get an OpenGraph attachment for a link\n","operationId":"GetOG","parameters":[{"in":"query","name":"url","required":true,"schema":{"description":"URL to be scraped","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOGResponse"}}},"description":"Get OG Attachment"},"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":"Get OG","tags":["product:common"]}},"/api/v2/polls":{"post":{"description":"Creates a new poll\n","operationId":"CreatePoll","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePollRequest"}}},"description":"Create Poll Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Create poll","tags":["product:common"]},"put":{"description":"Updates a poll\n\nSends events:\n- feeds.poll.closed\n- feeds.poll.updated\n- poll.closed\n- poll.updated\n","operationId":"UpdatePoll","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePollRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Update poll","tags":["product:common"]}},"/api/v2/polls/query":{"post":{"description":"Queries polls\n","operationId":"QueryPolls","parameters":[{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryPollsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryPollsResponse"}}},"description":"Successful 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":"Query polls","tags":["product:common"]}},"/api/v2/polls/{poll_id}":{"delete":{"description":"Deletes a poll\n\nSends events:\n- feeds.poll.deleted\n- poll.deleted\n","operationId":"DeletePoll","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete poll","tags":["product:common"]},"get":{"description":"Retrieves a poll\n","operationId":"GetPoll","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Get poll","tags":["product:common"]},"patch":{"description":"Updates a poll partially\n\nSends events:\n- feeds.poll.closed\n- feeds.poll.updated\n- poll.closed\n- poll.updated\n","operationId":"UpdatePollPartial","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePollPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Partial update poll","tags":["product:common"]}},"/api/v2/polls/{poll_id}/options":{"post":{"description":"Creates a poll option\n\nSends events:\n- feeds.poll.updated\n- poll.updated\n","operationId":"CreatePollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePollOptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollOptionResponse"}}},"description":"Successful 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":"Create poll option","tags":["product:common"]},"put":{"description":"Updates a poll option\n\nSends events:\n- feeds.poll.updated\n- poll.updated\n","operationId":"UpdatePollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePollOptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollOptionResponse"}}},"description":"Successful 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":"Update poll option","tags":["product:common"]}},"/api/v2/polls/{poll_id}/options/{option_id}":{"delete":{"description":"Deletes a poll option\n\nSends events:\n- feeds.poll.updated\n- poll.updated\n","operationId":"DeletePollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"path","name":"option_id","required":true,"schema":{"description":"Option ID","maxLength":255,"title":"string","type":"string","x-stream-index":"003"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete poll option","tags":["product:common"]},"get":{"description":"Retrieves a poll option\n","operationId":"GetPollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"path","name":"option_id","required":true,"schema":{"description":"Option ID","maxLength":255,"title":"string","type":"string","x-stream-index":"003"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollOptionResponse"}}},"description":"Successful 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":"Get poll option","tags":["product:common"]}},"/api/v2/polls/{poll_id}/votes":{"post":{"description":"Queries votes\n","operationId":"QueryPollVotes","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryPollVotesRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollVotesResponse"}}},"description":"Successful 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":"Query votes","tags":["product:common"]}},"/api/v2/uploads/file":{"delete":{"description":"Deletes previously uploaded file\n","operationId":"DeleteFileGlobal","parameters":[{"in":"query","name":"url","schema":{"description":"File URL to delete","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete file","tags":["product:common"],"x-stream-sdk-name":"DeleteFile"},"post":{"description":"Uploads file\n","operationId":"UploadFileGlobal","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/FileUploadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileUploadResponse"}}},"description":"Successful 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":"Upload file","tags":["product:common"],"x-stream-sdk-name":"UploadFile"}},"/api/v2/uploads/image":{"delete":{"description":"Deletes previously uploaded image\n","operationId":"DeleteImageGlobal","parameters":[{"in":"query","name":"url","schema":{"description":"File URL to delete","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete image","tags":["product:common"],"x-stream-sdk-name":"DeleteImage"},"post":{"description":"Uploads image\n","operationId":"UploadImageGlobal","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/ImageUploadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageUploadResponse"}}},"description":"Successful 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":"Upload image","tags":["product:common"],"x-stream-sdk-name":"UploadImage"}},"/api/v2/users":{"get":{"description":"Find and filter users\n","operationId":"QueryUsers","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryUsersPayload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryUsersResponse"}}},"description":"Successful 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":"Query users","tags":["product:common"]},"patch":{"description":"Updates certain fields of the user\n\nSends events:\n- user.presence.changed\n- user.updated\n- user.presence.changed\n","operationId":"UpdateUsersPartial","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersResponse"}}},"description":"Successful 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":"Partially update user","tags":["product:common"]},"post":{"description":"Update or create users in bulk\n\nSends events:\n- user.updated\n","operationId":"UpdateUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersResponse"}}},"description":"Successful 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":"Upsert users","tags":["product:common"]}},"/api/v2/users/block":{"get":{"description":"Get list of blocked Users\n","operationId":"GetBlockedUsers","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBlockedUsersResponse"}}},"description":"Successful 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":"Get list of blocked Users","tags":["product:common"]},"post":{"description":"Block users\n","operationId":"BlockUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUsersResponse"}}},"description":"Successful 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":"Block user","tags":["product:common"]}},"/api/v2/users/live_locations":{"get":{"description":"Retrieves all active live locations for a user\n","operationId":"GetUserLiveLocations","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SharedLocationsResponse"}}},"description":"Successful 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":"Get user live locations","tags":["product:common"]},"put":{"description":"Updates an existing live location with new coordinates or expiration time\n","operationId":"UpdateLiveLocation","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateLiveLocationRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SharedLocationResponse"}}},"description":"Successful 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":"Update live location","tags":["product:common"]}},"/api/v2/users/unblock":{"post":{"description":"Unblock users\n","operationId":"UnblockUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUsersResponse"}}},"description":"Successful 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":"Unblock user","tags":["product:common"]}},"/api/v2/video/call/members":{"post":{"description":"Query call members with filter query\n","operationId":"QueryCallMembers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallMembersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallMembersResponse"}}},"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":"Query call members","tags":["product:video"]}},"/api/v2/video/call/stats":{"post":{"description":"\n","operationId":"QueryCallStats","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallStatsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallStatsResponse"}}},"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":"Query Call Stats","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}":{"get":{"description":"\n","operationId":"GetCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"query","name":"connection_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"003"}},{"in":"query","name":"members_limit","schema":{"format":"int32","maximum":100,"minimum":0,"type":"integer","writeOnly":true,"x-stream-index":"004"}},{"in":"query","name":"ring","schema":{"type":"boolean","writeOnly":true,"x-stream-index":"005"}},{"in":"query","name":"notify","schema":{"type":"boolean","writeOnly":true,"x-stream-index":"006"}},{"in":"query","name":"video","schema":{"type":"boolean","writeOnly":true,"x-stream-index":"007"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCallResponse"}}},"description":"GetCallResponse"},"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":"Get Call","tags":["product:video"]},"patch":{"description":"\n\nSends events:\n- call.updated\n","operationId":"UpdateCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallRequest"}}},"description":"UpdateCallRequest","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallResponse"}}},"description":"UpdateCallResponse"},"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":"Update Call","tags":["product:video"]},"post":{"description":"Gets or creates a new call\n\nSends events:\n- call.created\n- call.notification\n- call.ring\n","operationId":"GetOrCreateCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"connection_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"008"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrCreateCallRequest"}}},"description":"GetOrCreateCallRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrCreateCallResponse"}}},"description":"GetOrCreateCallResponse"},"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":"Get or create a call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/accept":{"post":{"description":"\n\nSends events:\n- call.accepted\n","operationId":"AcceptCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcceptCallResponse"}}},"description":"AcceptCallResponse"},"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":"Accept Call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/block":{"post":{"description":"Block a user, preventing them from joining the call until they are unblocked.\n\nSends events:\n- call.blocked_user\n","operationId":"BlockUser","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUserRequest"}}},"description":"BlockUserRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUserResponse"}}},"description":"BlockUserResponse"},"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":"Block user on a call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/delete":{"post":{"description":"\n\nSends events:\n- call.deleted\n","operationId":"DeleteCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCallRequest"}}},"description":"DeleteCallRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCallResponse"}}},"description":"DeleteCallResponse"},"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":"Delete Call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/event":{"post":{"description":"Sends custom event to the call\n\nSends events:\n- custom\n","operationId":"SendCallEvent","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendCallEventRequest"}}},"description":"SendCallEventRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendCallEventResponse"}}},"description":"SendCallEventResponse"},"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":"Send custom event","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/feedback":{"post":{"description":"\n\nSends events:\n- call.user_feedback_submitted\n","operationId":"CollectUserFeedback","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectUserFeedbackRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectUserFeedbackResponse"}}},"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":"Collect user feedback","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/go_live":{"post":{"description":"\n\nSends events:\n- call.live_started\n","operationId":"GoLive","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoLiveRequest"}}},"description":"GoLiveRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoLiveResponse"}}},"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":"Set call as live","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/join":{"post":{"description":"Request to join a call\n","operationId":"JoinCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"query","name":"connection_id","schema":{"title":"ConnectionID","type":"string","writeOnly":true,"x-stream-index":"008"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JoinCallRequest"}}},"description":"JoinCallRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JoinCallResponse"}}},"description":"JoinCallResponse"},"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":"Join call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/mark_ended":{"post":{"description":"\n\nSends events:\n- call.ended\n","operationId":"EndCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EndCallResponse"}}},"description":"EndCallResponse"},"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":"End call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/members":{"post":{"description":"\n\nSends events:\n- call.member_added\n- call.member_removed\n- call.member_updated\n","operationId":"UpdateCallMembers","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallMembersRequest"}}},"description":"UpdateCallMembersRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallMembersResponse"}}},"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":"Update Call Member","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/mute_users":{"post":{"description":"Mutes users in a call\n","operationId":"MuteUsers","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteUsersRequest"}}},"description":"MuteUsersRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteUsersResponse"}}},"description":"MuteUsersResponse"},"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":"Mute users","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/participants":{"post":{"description":"Returns a list of participants connected to the call\n","operationId":"QueryCallParticipants","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"type","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"limit","schema":{"format":"int32","maximum":100,"type":"integer","x-stream-index":"004"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallParticipantsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallParticipantsResponse"}}},"description":"Successful 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":"Query call participants","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/pin":{"post":{"description":"Pins a track for all users in the call.\n","operationId":"VideoPin","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PinRequest"}}},"description":"PinRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PinResponse"}}},"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":"Pin","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/reaction":{"post":{"description":"Sends reaction to the call\n\nSends events:\n- call.reaction_new\n","operationId":"SendVideoReaction","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendReactionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendReactionResponse"}}},"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":"Send reaction to the call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/recordings":{"get":{"description":"Lists recordings\n","operationId":"ListRecordings","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListRecordingsResponse"}}},"description":"ListRecordingsResponse"},"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":"List recordings","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/reject":{"post":{"description":"\n\nSends events:\n- call.rejected\n","operationId":"RejectCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RejectCallRequest"}}},"description":"RejectCallRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RejectCallResponse"}}},"description":"RejectCallResponse"},"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":"Reject Call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/report":{"get":{"description":"\n","operationId":"GetCallReport","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"query","name":"session_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCallReportResponse"}}},"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":"Get call report","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/request_permission":{"post":{"description":"Request permission to perform an action\n\nSends events:\n- call.permission_request\n","operationId":"RequestPermission","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestPermissionRequest"}}},"description":"RequestPermissionRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestPermissionResponse"}}},"description":"RequestPermissionResponse"},"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":"Request permission","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/rtmp_broadcasts":{"post":{"description":"Starts RTMP broadcasts for the provided RTMP destinations\n","operationId":"StartRTMPBroadcasts","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRTMPBroadcastsRequest"}}},"description":"StartRTMPBroadcastsRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRTMPBroadcastsResponse"}}},"description":"StartRTMPBroadcastsResponse"},"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":"Start RTMP broadcasts","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/rtmp_broadcasts/stop":{"post":{"description":"Stop all RTMP broadcasts for the provided call\n","operationId":"StopAllRTMPBroadcasts","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopAllRTMPBroadcastsResponse"}}},"description":"StopAllRTMPBroadcastsResponse"},"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":"Stop all RTMP broadcasts for a call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/rtmp_broadcasts/{name}/stop":{"post":{"description":"Stop RTMP broadcasts for the provided RTMP destinations\n","operationId":"StopRTMPBroadcast","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopRTMPBroadcastsRequest"}}},"description":"StopRTMPBroadcastsRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopRTMPBroadcastsResponse"}}},"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":"Stop RTMP broadcasts","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/start_broadcasting":{"post":{"description":"Starts HLS broadcasting\n","operationId":"StartHLSBroadcasting","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartHLSBroadcastingResponse"}}},"description":"StartHLSBroadcastingResponse"},"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":"Start HLS broadcasting","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/start_closed_captions":{"post":{"description":"Starts closed captions\n","operationId":"StartClosedCaptions","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartClosedCaptionsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartClosedCaptionsResponse"}}},"description":"Successful 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":"Start closed captions","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/start_frame_recording":{"post":{"description":"Starts frame by frame recording\n\nSends events:\n- call.frame_recording_started\n","operationId":"StartFrameRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartFrameRecordingRequest"}}},"description":"StartFrameRecordingRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartFrameRecordingResponse"}}},"description":"StartFrameRecordingResponse"},"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":"Start frame recording","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/start_recording":{"post":{"description":"Starts recording\n\nSends events:\n- call.recording_started\n","operationId":"StartRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRecordingRequest"}}},"description":"StartRecordingRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRecordingResponse"}}},"description":"StartRecordingResponse"},"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":"Start recording","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/start_transcription":{"post":{"description":"Starts transcription\n","operationId":"StartTranscription","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartTranscriptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartTranscriptionResponse"}}},"description":"StartTranscriptionResponse"},"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":"Start transcription","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_broadcasting":{"post":{"description":"Stops HLS broadcasting\n","operationId":"StopHLSBroadcasting","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopHLSBroadcastingResponse"}}},"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":"Stop HLS broadcasting","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_closed_captions":{"post":{"description":"Stops closed captions\n\nSends events:\n- call.transcription_stopped\n","operationId":"StopClosedCaptions","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopClosedCaptionsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopClosedCaptionsResponse"}}},"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":"Stop closed captions","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_frame_recording":{"post":{"description":"Stops frame recording\n\nSends events:\n- call.frame_recording_stopped\n","operationId":"StopFrameRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopFrameRecordingResponse"}}},"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":"Stop frame recording","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_live":{"post":{"description":"\n\nSends events:\n- call.updated\n","operationId":"StopLive","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopLiveRequest"}}},"description":"StopLiveRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopLiveResponse"}}},"description":"StopLiveResponse"},"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":"Set call as not live","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_recording":{"post":{"description":"Stops recording\n\nSends events:\n- call.recording_stopped\n","operationId":"StopRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopRecordingResponse"}}},"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":"Stop recording","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_transcription":{"post":{"description":"Stops transcription\n\nSends events:\n- call.transcription_stopped\n","operationId":"StopTranscription","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopTranscriptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopTranscriptionResponse"}}},"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":"Stop transcription","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/transcriptions":{"get":{"description":"Lists transcriptions\n","operationId":"ListTranscriptions","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTranscriptionsResponse"}}},"description":"ListTranscriptionsResponse"},"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":"List transcriptions","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/unblock":{"post":{"description":"Removes the block for a user on a call. The user will be able to join the call again.\n\nSends events:\n- call.unblocked_user\n","operationId":"UnblockUser","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUserRequest"}}},"description":"UnblockUserRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUserResponse"}}},"description":"UnblockUserResponse"},"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":"Unblocks user on a call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/unpin":{"post":{"description":"Unpins a track for all users in the call.\n","operationId":"VideoUnpin","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnpinRequest"}}},"description":"UnpinRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnpinResponse"}}},"description":"UnpinResponse"},"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":"Unpin","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/user_permissions":{"post":{"description":"Updates user permissions\n\nSends events:\n- call.permissions_updated\n","operationId":"UpdateUserPermissions","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"005.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"005.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUserPermissionsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUserPermissionsResponse"}}},"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":"Update user permissions","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/{session}/recordings/{filename}":{"delete":{"description":"Deletes recording\n","operationId":"DeleteRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"path","name":"session","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"003"}},{"in":"path","name":"filename","required":true,"schema":{"maxLength":256,"type":"string","writeOnly":true,"x-stream-index":"004"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteRecordingResponse"}}},"description":"DeleteRecordingResponse"},"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":"Delete recording","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/{session}/transcriptions/{filename}":{"delete":{"description":"Deletes transcription\n","operationId":"DeleteTranscription","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"path","name":"session","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"003"}},{"in":"path","name":"filename","required":true,"schema":{"maxLength":256,"type":"string","writeOnly":true,"x-stream-index":"004"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteTranscriptionResponse"}}},"description":"DeleteTranscriptionResponse"},"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":"Delete transcription","tags":["product:video"]}},"/api/v2/video/calls":{"post":{"description":"Query calls with filter query\n","operationId":"QueryCalls","parameters":[{"in":"query","name":"connection_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallsRequest"}}},"description":"QueryCallsRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallsResponse"}}},"description":"QueryCallsResponse"},"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":"Query call","tags":["product:video"]}},"/api/v2/video/edges":{"get":{"description":"Returns the list of all edges available for video calls.\n","operationId":"GetEdges","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetEdgesResponse"}}},"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":"Get Edges","tags":["product:video"]}},"/api/v2/video/stats":{"post":{"description":"\n","operationId":"QueryAggregateCallStats","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryAggregateCallStatsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryAggregateCallStatsResponse"}}},"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":"Query Aggregate call Stats","tags":["product:video"]}}},"security":[{"JWT":[],"api_key":[],"stream-auth-type":[]},{"api_key":[],"stream-auth-type":[]}],"servers":[{"description":"Stream API","url":"https://chat.stream-io-api.com"}]} \ No newline at end of file +{"components":{"schemas":{"AIImageConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"ocr_rules":{"items":{"$ref":"#/components/schemas/OCRRule"},"type":"array","x-stream-index":"004"},"rules":{"items":{"$ref":"#/components/schemas/AWSRekognitionRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules","ocr_rules"],"type":"object"},"AIIndicatorClearEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"ai_indicator.clear","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"AIIndicatorClearEvent","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"},"AIIndicatorStopEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"ai_indicator.stop","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"AIIndicatorStopEvent","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"},"AIIndicatorUpdateEvent":{"properties":{"ai_message":{"type":"string","x-stream-index":"005"},"ai_state":{"type":"string","x-stream-index":"004"},"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"message_id":{"type":"string","x-stream-index":"003"},"type":{"default":"ai_indicator.update","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","cid","channel_id","channel_type","message_id","ai_state"],"title":"AIIndicatorUpdateEvent","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"},"AITextConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"profile":{"type":"string","x-stream-index":"003"},"rules":{"items":{"$ref":"#/components/schemas/BodyguardRule"},"type":"array","x-stream-index":"004"},"severity_rules":{"items":{"$ref":"#/components/schemas/BodyguardSeverityRule"},"type":"array","x-stream-index":"005"}},"required":["enabled","profile","rules","severity_rules"],"type":"object"},"AIVideoConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AWSRekognitionRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"APIError":{"properties":{"StatusCode":{"description":"Response HTTP status code","format":"int32","title":"Status code","type":"integer","x-stream-index":"004"},"code":{"description":"API error code","format":"int32","title":"Code","type":"integer","x-stream-index":"001"},"details":{"description":"Additional error-specific information","items":{"type":"integer"},"title":"Details","type":"array","x-stream-index":"007"},"duration":{"description":"Request duration","title":"Duration","type":"string","x-stream-index":"005"},"exception_fields":{"additionalProperties":{"type":"string"},"description":"Additional error info","title":"Exception fields","type":"object","x-stream-index":"003"},"message":{"description":"Message describing an error","title":"Message","type":"string","x-stream-index":"002"},"more_info":{"description":"URL with additional information","title":"More info","type":"string","x-stream-index":"006"},"unrecoverable":{"description":"Flag that indicates if the error is unrecoverable, requests that return unrecoverable errors should not be retried, this error only applies to the request that caused it","title":"Unrecoverable","type":"boolean","x-stream-index":"008"}},"required":["code","message","StatusCode","duration","more_info","details"],"title":"Error response","type":"object"},"APNS":{"properties":{"body":{"type":"string","x-stream-index":"002"},"content-available":{"format":"int32","type":"integer","x-stream-index":"004"},"data":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"mutable-content":{"format":"int32","type":"integer","x-stream-index":"005"},"sound":{"type":"string","x-stream-index":"003"},"title":{"type":"string","x-stream-index":"001"}},"required":["title","body"],"type":"object"},"AWSRekognitionRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"},"min_confidence":{"format":"float","maximum":100,"minimum":0,"type":"number","x-stream-index":"003"}},"required":["label","action","min_confidence"],"type":"object"},"AcceptCallRequest":{"description":"AcceptCallRequest is the payload for accepting a call.","nullable":true,"title":"AcceptCallRequest","type":"object"},"AcceptCallResponse":{"description":"AcceptCallResponse is the payload for accepting a call.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"AcceptCallResponse","type":"object"},"AcceptFeedMemberInviteRequest":{"nullable":true,"title":"Accept Feed Member Invite Request","type":"object"},"AcceptFeedMemberInviteResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"member":{"$ref":"#/components/schemas/FeedMemberResponse","description":"The feed member after accepting the invite","title":"Feed Member","x-stream-index":"001"}},"required":["member","duration"],"title":"Accept Feed Member Invite Response","type":"object"},"AcceptFollowRequest":{"nullable":true,"properties":{"follower_role":{"description":"Optional role for the follower in the follow relationship","title":"Follower Role","type":"string","x-stream-index":"003"},"source":{"description":"Fully qualified ID of the source feed","maxLength":255,"title":"Source Feed ID","type":"string","x-stream-index":"001"},"target":{"description":"Fully qualified ID of the target feed","maxLength":255,"title":"Target Feed ID","type":"string","x-stream-index":"002"}},"required":["source","target"],"title":"Accept Follow Request","type":"object"},"AcceptFollowResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"follow":{"$ref":"#/components/schemas/FollowResponse","description":"The accepted follow relationship","title":"Follow","x-stream-index":"001"}},"required":["follow","duration"],"title":"Accept Follow Response","type":"object"},"Action":{"nullable":true,"properties":{"name":{"type":"string","x-stream-index":"001"},"style":{"type":"string","x-stream-index":"003"},"text":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"004"},"value":{"type":"string","x-stream-index":"005"}},"required":["name","text","type"],"type":"object"},"ActionLog":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"002"},"reason":{"type":"string","x-stream-index":"008"},"reporter_type":{"type":"string","x-stream-index":"009"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"014"},"review_queue_item_id":{"type":"string","x-stream-index":"012"},"target_user":{"$ref":"#/components/schemas/User","x-stream-index":"013"},"target_user_id":{"type":"string","x-stream-index":"011"},"type":{"type":"string","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007"}},"required":["id","created_at","type","reason","reporter_type","custom","target_user_id","review_queue_item_id"],"type":"object"},"ActionLogResponse":{"nullable":true,"properties":{"created_at":{"description":"Timestamp when the action was taken","format":"date-time","title":"Created At","type":"number","x-stream-index":"002"},"custom":{"additionalProperties":{},"description":"Additional metadata about the action","title":"Custom","type":"object","x-stream-index":"007"},"id":{"description":"Unique identifier of the action log","title":"ID","type":"string","x-stream-index":"001"},"reason":{"description":"Reason for the moderation action","title":"Reason","type":"string","x-stream-index":"006"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"Associated review queue item","title":"Review Queue Item","x-stream-index":"008"},"target_user":{"$ref":"#/components/schemas/UserResponse","description":"User who was the target of the action","title":"Target User","x-stream-index":"009"},"target_user_id":{"description":"ID of the user who was the target of the action","title":"Target User ID","type":"string","x-stream-index":"010"},"type":{"description":"Type of moderation action","title":"Type","type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who performed the action","title":"User","x-stream-index":"004"},"user_id":{"description":"ID of the user who performed the action","title":"User ID","type":"string","x-stream-index":"005"}},"required":["id","created_at","type","user_id","reason","custom","target_user_id"],"type":"object"},"ActionSequence":{"properties":{"action":{"type":"string","x-stream-index":"001"},"blur":{"type":"boolean","x-stream-index":"005"},"cooldown_period":{"format":"int32","type":"integer","x-stream-index":"004"},"threshold":{"format":"int32","type":"integer","x-stream-index":"002"},"time_window":{"format":"int32","type":"integer","x-stream-index":"003"},"warning":{"type":"boolean","x-stream-index":"006"},"warning_text":{"type":"string","x-stream-index":"007"}},"required":["action","threshold","time_window","cooldown_period","blur","warning","warning_text"],"type":"object"},"ActivityAddedEvent":{"description":"Emitted when an activity is added to a feed.","nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","description":"The activity that was added","title":"Activity","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"type":"string","x-stream-index":"002.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.activity.added","description":"The type of event: \"feeds.activity.added\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who added the activity","title":"User","x-stream-index":"003.001"}},"required":["activity","type","created_at","custom","fid"],"title":"ActivityAddedEvent","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"},"ActivityDeletedEvent":{"description":"Emitted when an activity is deleted.","nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","description":"The activity that was updated","title":"Activity","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"type":"string","x-stream-index":"002.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.activity.deleted","description":"The type of event: \"feeds.activity.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","x-stream-index":"003.001"}},"required":["activity","type","created_at","custom","fid"],"title":"ActivityDeletedEvent","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"},"ActivityFeedbackRequest":{"description":"Request to provide feedback on an activity","nullable":true,"properties":{"hide":{"description":"Whether to hide this activity","title":"bool","type":"boolean","x-stream-index":"003"},"mute_user":{"description":"Whether to mute the user who created this activity","title":"bool","type":"boolean","x-stream-index":"005"},"reason":{"description":"Reason for the feedback (optional)","maxLength":1000,"title":"string","type":"string","x-stream-index":"006"},"report":{"description":"Whether to report this activity","title":"bool","type":"boolean","x-stream-index":"004"},"show_less":{"description":"Whether to show less content like this","title":"bool","type":"boolean","x-stream-index":"002"}},"title":"Activity Feedback Request","type":"object"},"ActivityFeedbackResponse":{"description":"Response for activity feedback submission","nullable":true,"properties":{"activity_id":{"description":"The ID of the activity that received feedback","title":"string","type":"string","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["activity_id","duration"],"title":"Activity Feedback Response","type":"object"},"ActivityLocation":{"properties":{"lat":{"description":"Latitude coordinate","format":"float","title":"Latitude","type":"number","x-stream-index":"001"},"lng":{"description":"Longitude coordinate","format":"float","title":"Longitude","type":"number","x-stream-index":"002"}},"required":["lat","lng"],"title":"Activity Location","type":"object"},"ActivityMarkEvent":{"description":"Emitted when activities are marked as read, seen, or watched.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"006.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006.001.007"},"feed_visibility":{"type":"string","x-stream-index":"006.003"},"fid":{"type":"string","x-stream-index":"006.002"},"mark_all_read":{"description":"Whether all activities were marked as read","title":"Mark All Read","type":"boolean","x-stream-index":"004"},"mark_all_seen":{"description":"Whether all activities were marked as seen","title":"Mark All Seen","type":"boolean","x-stream-index":"005"},"mark_read":{"description":"The IDs of activities marked as read","items":{"type":"string"},"title":"Mark Read","type":"array","x-stream-index":"001"},"mark_seen":{"description":"The IDs of activities marked as seen","items":{"type":"string"},"title":"Mark Seen","type":"array","x-stream-index":"002"},"mark_watched":{"description":"The IDs of activities marked as watched","items":{"type":"string"},"title":"Mark Watched","type":"array","x-stream-index":"003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"006.001.004"},"type":{"default":"feeds.activity.marked","description":"The type of event: \"feeds.activity.marked\" in this case","title":"Event Type","type":"string","x-stream-index":"006.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who marked the activities","title":"User","x-stream-index":"007.001"}},"required":["type","created_at","custom","fid"],"title":"ActivityMarkEvent","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"},"ActivityMarkedEvent":{"properties":{"all_read":{"type":"boolean","x-stream-index":"006"},"all_seen":{"type":"boolean","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"feed_id":{"type":"string","x-stream-index":"003"},"marked_read":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"marked_watched":{"items":{"type":"string"},"type":"array","x-stream-index":"005"},"type":{"default":"activity.marked","type":"string","x-stream-index":"001.001"},"user_id":{"type":"string","x-stream-index":"002"}},"required":["type","created_at","user_id","feed_id","all_read","all_seen"],"title":"ActivityMarkedEvent","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"},"ActivityPinResponse":{"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","description":"The pinned activity","title":"Activity","x-stream-index":"002"},"created_at":{"description":"When the pin was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"004"},"feed":{"description":"ID of the feed where activity is pinned","title":"Feed ID","type":"string","x-stream-index":"003"},"updated_at":{"description":"When the pin was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who pinned the activity","title":"User","x-stream-index":"001"}},"required":["user","activity","feed","created_at","updated_at"],"title":"Activity Pin","type":"object"},"ActivityPinnedEvent":{"description":"Emitted when an activity is pinned.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"description":"The ID of the feed","title":"Feed ID","type":"string","x-stream-index":"002.002"},"pinned_activity":{"$ref":"#/components/schemas/PinActivityResponse","x-stream-index":"001"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.activity.pinned","description":"The type of event: \"feeds.activity.pinned\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who pinned the activity","title":"User","x-stream-index":"003.001"}},"required":["pinned_activity","type","created_at","custom","fid"],"title":"ActivityPinnedEvent","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"},"ActivityProcessorConfig":{"nullable":true,"properties":{"config":{"additionalProperties":{},"type":"object","x-stream-index":"002"},"openai_key":{"type":"string","x-stream-index":"003"},"type":{"type":"string","x-stream-index":"001"}},"required":["type"],"type":"object"},"ActivityReactionAddedEvent":{"description":"Emitted when a reaction is added to an activity.","nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"003.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.001.007"},"feed_visibility":{"type":"string","x-stream-index":"003.003"},"fid":{"type":"string","x-stream-index":"003.002"},"reaction":{"$ref":"#/components/schemas/FeedsReactionResponse","description":"The reaction that was added","title":"Reaction","x-stream-index":"002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.001.004"},"type":{"default":"feeds.activity.reaction.added","description":"The type of event: \"feeds.activity.reaction.added\" in this case","title":"Event Type","type":"string","x-stream-index":"003.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who added the reaction","title":"User","x-stream-index":"004.001"}},"required":["activity","reaction","type","created_at","custom","fid"],"title":"ActivityReactionAddedEvent","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"},"ActivityReactionDeletedEvent":{"description":"Emitted when a reaction is deleted from an activity.","nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"003.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.001.007"},"feed_visibility":{"type":"string","x-stream-index":"003.003"},"fid":{"type":"string","x-stream-index":"003.002"},"reaction":{"$ref":"#/components/schemas/FeedsReactionResponse","x-stream-index":"002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.001.004"},"type":{"default":"feeds.activity.reaction.deleted","description":"The type of the reaction that was removed","title":"Type","type":"string","x-stream-index":"003.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who removed the reaction","title":"User","x-stream-index":"004.001"}},"required":["activity","reaction","type","created_at","custom","fid"],"title":"ActivityReactionDeletedEvent","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"},"ActivityReactionUpdatedEvent":{"description":"Emitted when a reaction is updated on an activity.","nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"003.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.001.007"},"feed_visibility":{"type":"string","x-stream-index":"003.003"},"fid":{"type":"string","x-stream-index":"003.002"},"reaction":{"$ref":"#/components/schemas/FeedsReactionResponse","description":"The reaction that was updated","title":"Reaction","x-stream-index":"002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.001.004"},"type":{"default":"feeds.activity.reaction.updated","description":"The type of event: \"feeds.activity.reaction.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"003.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who updated the reaction","title":"User","x-stream-index":"004.001"}},"required":["activity","reaction","type","created_at","custom","fid"],"title":"ActivityReactionUpdatedEvent","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"},"ActivityRemovedFromFeedEvent":{"description":"Emitted when an activity is removed from a feed.","nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"type":"string","x-stream-index":"002.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.activity.removed_from_feed","description":"The type of event: \"feeds.activity.removed_from_feed\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who removed the activity","title":"User","x-stream-index":"003.001"}},"required":["activity","type","created_at","custom","fid"],"title":"ActivityRemovedFromFeedEvent","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"},"ActivityRequest":{"properties":{"attachments":{"description":"List of attachments for the activity","items":{"$ref":"#/components/schemas/Attachment"},"title":"Attachments","type":"array","x-stream-index":"006"},"custom":{"additionalProperties":{},"description":"Custom data for the activity","title":"Custom Data","type":"object","x-stream-index":"017"},"expires_at":{"description":"Expiration time for the activity","title":"Expires At","type":"string","x-stream-index":"010"},"feeds":{"description":"List of feed IDs to add the activity to","items":{"type":"string"},"maximum":255,"minimum":1,"title":"Feed IDs","type":"array","x-stream-index":"004"},"filter_tags":{"description":"Tags for filtering activities","items":{"type":"string"},"maximum":255,"title":"Filter Tags","type":"array","x-stream-index":"013"},"id":{"description":"Optional ID for the activity","maxLength":255,"title":"Activity ID","type":"string","x-stream-index":"001"},"interest_tags":{"description":"Tags for indicating user interests","items":{"type":"string"},"maximum":255,"title":"Interest Tags","type":"array","x-stream-index":"014"},"location":{"$ref":"#/components/schemas/ActivityLocation","description":"Geographic location related to the activity","title":"Location","x-stream-index":"009"},"mentioned_user_ids":{"description":"List of users mentioned in the activity","items":{"type":"string"},"maximum":255,"title":"Mentioned User IDs","type":"array","x-stream-index":"011"},"parent_id":{"description":"ID of parent activity for replies/comments","maxLength":255,"title":"Parent ID","type":"string","x-stream-index":"015"},"poll_id":{"description":"ID of a poll to attach to activity","title":"Poll ID","type":"string","x-stream-index":"016"},"search_data":{"additionalProperties":{},"description":"Additional data for search indexing","title":"Search Data","type":"object","x-stream-index":"012"},"text":{"description":"Text content of the activity","title":"Text","type":"string","x-stream-index":"005"},"type":{"description":"Type of activity","maxLength":255,"title":"Activity Type","type":"string","x-stream-index":"002"},"visibility":{"description":"Visibility setting for the activity","enum":["public","private","tag"],"title":"Visibility","type":"string","x-stream-index":"007"},"visibility_tag":{"description":"If visibility is 'tag', this is the tag name and is required","maxLength":32,"title":"Visibility Tag","type":"string","x-stream-index":"008"}},"required":["type","feeds"],"title":"Activity Request","type":"object"},"ActivityResponse":{"properties":{"attachments":{"description":"Media attachments for the activity","items":{"$ref":"#/components/schemas/Attachment"},"title":"Attachments","type":"array","x-stream-index":"009"},"bookmark_count":{"description":"Number of bookmarks on the activity","format":"int32","title":"Bookmark Count","type":"integer","x-stream-index":"028"},"comment_count":{"description":"Number of comments on the activity","format":"int32","title":"Comment Count","type":"integer","x-stream-index":"027"},"comments":{"description":"Comments on this activity","items":{"$ref":"#/components/schemas/CommentResponse"},"title":"Comments","type":"array","x-stream-index":"015"},"created_at":{"description":"When the activity was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"007"},"current_feed":{"$ref":"#/components/schemas/FeedResponse","description":"Feed context for this activity view. If an activity is added only to one feed, it's always set. If an activity is added to multiple feeds, it's only set when calling the GetOrCreateFeed endpoint.","title":"Current Feed","x-stream-index":"035"},"custom":{"additionalProperties":{},"description":"Custom data for the activity","title":"Custom Data","type":"object","x-stream-index":"011"},"deleted_at":{"description":"When the activity was deleted","format":"date-time","title":"Deleted At","type":"number","x-stream-index":"021"},"edited_at":{"description":"When the activity was last edited","format":"date-time","title":"Edited At","type":"number","x-stream-index":"020"},"expires_at":{"description":"When the activity will expire","format":"date-time","title":"Expires At","type":"number","x-stream-index":"022"},"feeds":{"description":"List of feed IDs containing this activity","items":{"type":"string"},"title":"Feeds","type":"array","x-stream-index":"004"},"filter_tags":{"description":"Tags for filtering","items":{"type":"string"},"title":"Filter Tags","type":"array","x-stream-index":"024"},"hidden":{"description":"If this activity is hidden for this user. For premium content where you want to show a preview","title":"Hidden","type":"boolean","x-stream-index":"036"},"id":{"description":"Unique identifier for the activity","title":"ID","type":"string","x-stream-index":"001"},"interest_tags":{"description":"Tags for user interests","items":{"type":"string"},"title":"Interest Tags","type":"array","x-stream-index":"025"},"latest_reactions":{"description":"Recent reactions to the activity","items":{"$ref":"#/components/schemas/FeedsReactionResponse"},"title":"Latest Reactions","type":"array","x-stream-index":"031"},"location":{"$ref":"#/components/schemas/ActivityLocation","description":"Geographic location related to the activity","title":"Location","x-stream-index":"017"},"mentioned_users":{"description":"Users mentioned in the activity","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Mentioned Users","type":"array","x-stream-index":"010"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","description":"Moderation information","title":"Moderation","x-stream-index":"026"},"notification_context":{"additionalProperties":{},"description":"Notification context data for the activity (if this is a reaction, comment, follow, etc.)","title":"Notification Context","type":"object","x-stream-index":"012"},"own_bookmarks":{"description":"Current user's bookmarks for this activity","items":{"$ref":"#/components/schemas/BookmarkResponse"},"title":"Own Bookmarks","type":"array","x-stream-index":"034"},"own_reactions":{"description":"Current user's reactions to this activity","items":{"$ref":"#/components/schemas/FeedsReactionResponse"},"title":"Own Reactions","type":"array","x-stream-index":"033"},"parent":{"$ref":"#/components/schemas/ActivityResponse","description":"Parent activity (if this is a reply/comment)","title":"Parent","x-stream-index":"018"},"poll":{"$ref":"#/components/schemas/PollResponseData","description":"Poll attached to this activity","title":"Poll","x-stream-index":"019"},"popularity":{"description":"Popularity score of the activity","format":"int32","title":"Popularity","type":"integer","x-stream-index":"013"},"reaction_count":{"description":"Number of reactions to the activity","format":"int32","title":"Reaction Count","type":"integer","x-stream-index":"030"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"description":"Grouped reactions by type","title":"Reaction Groups","type":"object","x-stream-index":"032"},"score":{"description":"Ranking score for this activity","format":"float","title":"Score","type":"number","x-stream-index":"014"},"search_data":{"additionalProperties":{},"description":"Data for search indexing","title":"Search Data","type":"object","x-stream-index":"023"},"share_count":{"description":"Number of times the activity was shared","format":"int32","title":"Share Count","type":"integer","x-stream-index":"029"},"text":{"description":"Text content of the activity","title":"Text","type":"string","x-stream-index":"016"},"type":{"description":"Type of activity","title":"Type","type":"string","x-stream-index":"002"},"updated_at":{"description":"When the activity was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"008"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who created the activity","title":"User","x-stream-index":"003"},"visibility":{"description":"Visibility setting for the activity","enum":["public","private","tag"],"title":"Visibility","type":"string","x-stream-index":"005"},"visibility_tag":{"description":"If visibility is 'tag', this is the tag name","title":"Visibility Tag","type":"string","x-stream-index":"006"}},"required":["id","type","user","feeds","visibility","created_at","updated_at","attachments","mentioned_users","custom","popularity","score","comments","search_data","filter_tags","interest_tags","comment_count","bookmark_count","share_count","reaction_count","latest_reactions","reaction_groups","own_reactions","own_bookmarks"],"title":"Base Activity","type":"object"},"ActivitySelectorConfig":{"nullable":true,"properties":{"cutoff_time":{"format":"date-time","type":"number","x-stream-index":"004"},"filter":{"additionalProperties":{},"type":"object","x-stream-index":"002"},"min_popularity":{"format":"int32","type":"integer","x-stream-index":"005"},"sort":{"items":{"$ref":"#/components/schemas/SortParam"},"type":"array","x-stream-index":"003"},"type":{"type":"string","x-stream-index":"001"}},"required":["cutoff_time"],"type":"object"},"ActivityUnpinnedEvent":{"description":"Emitted when an activity is unpinned.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"description":"The ID of the feed","title":"Feed ID","type":"string","x-stream-index":"002.002"},"pinned_activity":{"$ref":"#/components/schemas/PinActivityResponse","x-stream-index":"001"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.activity.unpinned","description":"The type of event: \"feeds.activity.unpinned\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who unpinned the activity","title":"User","x-stream-index":"003.001"}},"required":["pinned_activity","type","created_at","custom","fid"],"title":"ActivityUnpinnedEvent","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"},"ActivityUpdatedEvent":{"description":"Emitted when an activity is updated.","nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","description":"The activity that was updated","title":"Activity","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"type":"string","x-stream-index":"002.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.activity.updated","description":"The type of the event","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who updated the activity","title":"User","x-stream-index":"003.001"}},"required":["activity","type","created_at","custom","fid"],"title":"ActivityUpdatedEvent","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"},"AddActivityRequest":{"nullable":true,"properties":{"attachments":{"description":"List of attachments for the activity","items":{"$ref":"#/components/schemas/Attachment"},"title":"Attachments","type":"array","x-stream-index":"001.006"},"custom":{"additionalProperties":{},"description":"Custom data for the activity","title":"Custom Data","type":"object","x-stream-index":"001.017"},"expires_at":{"description":"Expiration time for the activity","title":"Expires At","type":"string","x-stream-index":"001.010"},"feeds":{"description":"List of feed IDs to add the activity to","items":{"type":"string"},"maximum":255,"minimum":1,"title":"Feed IDs","type":"array","x-stream-index":"001.004"},"filter_tags":{"description":"Tags for filtering activities","items":{"type":"string"},"maximum":255,"title":"Filter Tags","type":"array","x-stream-index":"001.013"},"id":{"description":"Optional ID for the activity","maxLength":255,"title":"Activity ID","type":"string","x-stream-index":"001.001"},"interest_tags":{"description":"Tags for indicating user interests","items":{"type":"string"},"maximum":255,"title":"Interest Tags","type":"array","x-stream-index":"001.014"},"location":{"$ref":"#/components/schemas/ActivityLocation","description":"Geographic location related to the activity","title":"Location","x-stream-index":"001.009"},"mentioned_user_ids":{"description":"List of users mentioned in the activity","items":{"type":"string"},"maximum":255,"title":"Mentioned User IDs","type":"array","x-stream-index":"001.011"},"parent_id":{"description":"ID of parent activity for replies/comments","maxLength":255,"title":"Parent ID","type":"string","x-stream-index":"001.015"},"poll_id":{"description":"ID of a poll to attach to activity","title":"Poll ID","type":"string","x-stream-index":"001.016"},"search_data":{"additionalProperties":{},"description":"Additional data for search indexing","title":"Search Data","type":"object","x-stream-index":"001.012"},"text":{"description":"Text content of the activity","title":"Text","type":"string","x-stream-index":"001.005"},"type":{"description":"Type of activity","maxLength":255,"title":"Activity Type","type":"string","x-stream-index":"001.002"},"visibility":{"description":"Visibility setting for the activity","enum":["public","private","tag"],"title":"Visibility","type":"string","x-stream-index":"001.007"},"visibility_tag":{"description":"If visibility is 'tag', this is the tag name and is required","maxLength":32,"title":"Visibility Tag","type":"string","x-stream-index":"001.008"}},"required":["type","feeds"],"title":"Activity Request","type":"object"},"AddActivityResponse":{"nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","description":"The created activity","title":"Activity","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["activity","duration"],"title":"Add Activity Response","type":"object"},"AddBookmarkRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"description":"Custom data for the bookmark","title":"Custom Data","type":"object","x-stream-index":"004"},"folder_id":{"description":"ID of the folder to add the bookmark to","maxLength":255,"title":"Folder ID","type":"string","x-stream-index":"002"},"new_folder":{"$ref":"#/components/schemas/AddFolderRequest","description":"Create a new folder for this bookmark","title":"New Folder","x-stream-index":"003"}},"title":"Add Bookmark Request","type":"object"},"AddBookmarkResponse":{"nullable":true,"properties":{"bookmark":{"$ref":"#/components/schemas/BookmarkResponse","description":"The created bookmark","title":"Bookmark","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["bookmark","duration"],"title":"Add Bookmark Response","type":"object"},"AddCommentReactionRequest":{"nullable":true,"properties":{"create_notification_activity":{"description":"Whether to create a notification activity for this reaction","title":"boolean","type":"boolean","x-stream-index":"004"},"custom":{"additionalProperties":{},"description":"Optional custom data to add to the reaction","title":"object","type":"object","x-stream-index":"003"},"skip_push":{"type":"boolean","x-stream-index":"005"},"type":{"description":"The type of reaction, eg upvote, like, ...","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},"required":["type"],"type":"object"},"AddCommentReactionResponse":{"nullable":true,"properties":{"comment":{"$ref":"#/components/schemas/CommentResponse","description":"The comment the reaction was added to","title":"object","x-stream-index":"001"},"duration":{"description":"Duration of the request","title":"string","type":"string","x-stream-index":"003.001"},"reaction":{"$ref":"#/components/schemas/FeedsReactionResponse","description":"The created or updated reaction","title":"object","x-stream-index":"002"}},"required":["comment","reaction","duration"],"type":"object"},"AddCommentRequest":{"nullable":true,"properties":{"attachments":{"description":"Media attachments for the reply","items":{"$ref":"#/components/schemas/Attachment"},"title":"Attachments","type":"array","x-stream-index":"004"},"comment":{"description":"Text content of the comment","title":"Comment","type":"string","x-stream-index":"003"},"create_notification_activity":{"description":"Whether to create a notification activity for this comment","title":"Create Notification Activity","type":"boolean","x-stream-index":"008"},"custom":{"additionalProperties":{},"description":"Custom data for the comment","title":"Custom Data","type":"object","x-stream-index":"007"},"mentioned_user_ids":{"description":"List of users mentioned in the reply","items":{"type":"string"},"maximum":255,"title":"Mentioned User IDs","type":"array","x-stream-index":"005"},"object_id":{"description":"ID of the object to comment on","title":"Object ID","type":"string","x-stream-index":"001"},"object_type":{"description":"Type of the object to comment on","title":"Object Type","type":"string","x-stream-index":"002"},"parent_id":{"description":"ID of parent comment for replies","title":"Parent ID","type":"string","x-stream-index":"006"},"skip_push":{"type":"boolean","x-stream-index":"009"}},"required":["object_id","object_type","comment"],"title":"Add Comment Request","type":"object"},"AddCommentResponse":{"nullable":true,"properties":{"comment":{"$ref":"#/components/schemas/CommentResponse","description":"The created comment","title":"Comment","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["comment","duration"],"title":"Add Comment Response","type":"object"},"AddCommentsBatchRequest":{"nullable":true,"properties":{"comments":{"description":"List of comments to add","items":{"$ref":"#/components/schemas/AddCommentRequest"},"title":"Comments","type":"array","x-stream-index":"001"}},"required":["comments"],"title":"Add Comments Batch Request","type":"object"},"AddCommentsBatchResponse":{"nullable":true,"properties":{"comments":{"description":"List of comments added","items":{"$ref":"#/components/schemas/CommentResponse"},"title":"Comments","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["comments","duration"],"title":"Add Comments Batch Response","type":"object"},"AddFolderRequest":{"properties":{"custom":{"additionalProperties":{},"description":"Custom data for the folder","title":"Custom Data","type":"object","x-stream-index":"002"},"name":{"description":"Name of the folder","maxLength":255,"title":"Name","type":"string","x-stream-index":"001"}},"required":["name"],"title":"Add Folder Request","type":"object"},"AddReactionRequest":{"nullable":true,"properties":{"create_notification_activity":{"description":"Whether to create a notification activity for this reaction","title":"Create Notification Activity","type":"boolean","x-stream-index":"004"},"custom":{"additionalProperties":{},"description":"Custom data for the reaction","title":"Custom Data","type":"object","x-stream-index":"003"},"skip_push":{"type":"boolean","x-stream-index":"005"},"type":{"description":"Type of reaction","maxLength":255,"title":"Reaction Type","type":"string","x-stream-index":"002"}},"required":["type"],"title":"Add Reaction Request","type":"object"},"AddReactionResponse":{"nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"reaction":{"$ref":"#/components/schemas/FeedsReactionResponse","description":"The created reaction","title":"Reaction","x-stream-index":"002"}},"required":["activity","reaction","duration"],"title":"Add Reaction Response","type":"object"},"AggregatedActivityResponse":{"properties":{"activities":{"description":"List of activities in this aggregation","items":{"$ref":"#/components/schemas/ActivityResponse"},"title":"Activities","type":"array","x-stream-index":"001"},"activity_count":{"description":"Number of activities in this aggregation","format":"int32","title":"Activity Count","type":"integer","x-stream-index":"002"},"created_at":{"description":"When the aggregation was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"006"},"group":{"description":"Grouping identifier","title":"Group","type":"string","x-stream-index":"004"},"score":{"description":"Ranking score for this aggregation","format":"float","title":"Score","type":"number","x-stream-index":"005"},"updated_at":{"description":"When the aggregation was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"007"},"user_count":{"description":"Number of unique users in this aggregation","format":"int32","title":"User Count","type":"integer","x-stream-index":"003"}},"required":["activities","activity_count","user_count","group","score","created_at","updated_at"],"title":"Aggregated Activity","type":"object"},"AggregationConfig":{"properties":{"format":{"type":"string","x-stream-index":"001"},"group_size":{"format":"int32","type":"integer","x-stream-index":"002"}},"type":"object"},"AnyEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"*","type":"string","x-stream-index":"001.001"}},"required":["type","created_at"],"title":"AnyEvent","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"},"AppEventResponse":{"properties":{"async_url_enrich_enabled":{"description":"boolean","title":"Async URL Enrichment Enabled","type":"boolean","x-stream-index":"002"},"auto_translation_enabled":{"description":"boolean","title":"Auto Translation Enabled","type":"boolean","x-stream-index":"003"},"file_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","description":"file upload config","title":"File Upload Config","x-stream-index":"004"},"image_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","description":"file upload config","title":"Image Upload Config","x-stream-index":"005"},"name":{"description":"string","title":"App name","type":"string","x-stream-index":"001"}},"required":["name","auto_translation_enabled"],"type":"object"},"AppResponseFields":{"properties":{"async_url_enrich_enabled":{"type":"boolean","x-stream-index":"017"},"auto_translation_enabled":{"type":"boolean","x-stream-index":"020"},"file_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","x-stream-index":"030"},"image_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","x-stream-index":"031"},"name":{"type":"string","x-stream-index":"001"}},"required":["name","organization","push_notifications","webhook_url","moderation_webhook_url","channel_configs","call_types","policies","suspended","suspended_explanation","disable_auth_checks","disable_permissions_checks","permission_version","user_search_disallowed_roles","multi_tenant_enabled","image_moderation_enabled","async_url_enrich_enabled","auto_translation_enabled","custom_action_handler_url","enforce_unique_usernames","sqs_url","sqs_key","sqs_secret","sns_topic_arn","sns_key","sns_secret","file_upload_config","image_upload_config","grants","campaign_enabled","webhook_events","reminders_interval","cdn_expiration_seconds","video_provider","moderation_enabled","moderation_multitenant_blocklist_enabled","guest_user_creation_disabled","event_hooks","use_hook_v2","user_response_time_enabled","moderation_bulk_submit_action_enabled","moderation_llm_configurability_enabled"],"type":"object"},"AppUpdatedEvent":{"description":"Emitted when app settings are updated","nullable":true,"properties":{"app":{"$ref":"#/components/schemas/AppEventResponse","description":"application configuration","title":"App settings","x-stream-index":"002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"type":{"default":"app.updated","description":"The type of event: \"app.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.002"}},"required":["type","created_at","custom","app"],"title":"AppUpdatedEvent","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"},"Attachment":{"description":"An attachment is a message object that represents a file uploaded by a user.","nullable":true,"properties":{"actions":{"items":{"$ref":"#/components/schemas/Action"},"type":"array","x-stream-index":"015"},"asset_url":{"type":"string","x-stream-index":"017"},"author_icon":{"type":"string","x-stream-index":"007"},"author_link":{"type":"string","x-stream-index":"006"},"author_name":{"type":"string","x-stream-index":"005"},"color":{"type":"string","x-stream-index":"003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"018"},"fallback":{"type":"string","x-stream-index":"002"},"fields":{"items":{"$ref":"#/components/schemas/Field"},"type":"array","x-stream-index":"016"},"footer":{"type":"string","x-stream-index":"013"},"footer_icon":{"type":"string","x-stream-index":"014"},"giphy":{"$ref":"#/components/schemas/Images","x-stream-index":"019"},"image_url":{"type":"string","x-stream-index":"011"},"og_scrape_url":{"type":"string","x-stream-index":"020"},"original_height":{"format":"int32","type":"integer","x-stream-index":"022"},"original_width":{"format":"int32","type":"integer","x-stream-index":"021"},"pretext":{"type":"string","x-stream-index":"004"},"text":{"type":"string","x-stream-index":"010"},"thumb_url":{"type":"string","x-stream-index":"012"},"title":{"type":"string","x-stream-index":"008"},"title_link":{"type":"string","x-stream-index":"009"},"type":{"description":"Attachment type (e.g. image, video, url)","title":"Type","type":"string","x-stream-index":"001"}},"required":["custom"],"title":"Attachment","type":"object","x-stream-docs-page-id":"file_uploads"},"AudioSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"001"},"default_device":{"enum":["speaker","earpiece"],"type":"string","x-stream-index":"006"},"mic_default_on":{"type":"boolean","x-stream-index":"004"},"noise_cancellation":{"$ref":"#/components/schemas/NoiseCancellationSettings","x-stream-index":"007"},"opus_dtx_enabled":{"type":"boolean","x-stream-index":"002"},"redundant_coding_enabled":{"type":"boolean","x-stream-index":"003"},"speaker_default_on":{"type":"boolean","x-stream-index":"005"}},"required":["access_request_enabled","opus_dtx_enabled","redundant_coding_enabled","mic_default_on","speaker_default_on","default_device"],"type":"object"},"AudioSettingsRequest":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"001"},"default_device":{"enum":["speaker","earpiece"],"type":"string","x-stream-index":"006"},"mic_default_on":{"type":"boolean","x-stream-index":"004"},"noise_cancellation":{"$ref":"#/components/schemas/NoiseCancellationSettings","x-stream-index":"007"},"opus_dtx_enabled":{"type":"boolean","x-stream-index":"002"},"redundant_coding_enabled":{"type":"boolean","x-stream-index":"003"},"speaker_default_on":{"type":"boolean","x-stream-index":"005"}},"required":["default_device"],"type":"object"},"AudioSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"001"},"default_device":{"enum":["speaker","earpiece"],"type":"string","x-stream-index":"006"},"mic_default_on":{"type":"boolean","x-stream-index":"004"},"noise_cancellation":{"$ref":"#/components/schemas/NoiseCancellationSettings","x-stream-index":"007"},"opus_dtx_enabled":{"type":"boolean","x-stream-index":"002"},"redundant_coding_enabled":{"type":"boolean","x-stream-index":"003"},"speaker_default_on":{"type":"boolean","x-stream-index":"005"}},"required":["access_request_enabled","opus_dtx_enabled","redundant_coding_enabled","mic_default_on","speaker_default_on","default_device"],"type":"object"},"AutomodDetails":{"properties":{"action":{"type":"string","x-stream-index":"001"},"image_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"005"},"message_details":{"$ref":"#/components/schemas/FlagMessageDetails","x-stream-index":"004"},"original_message_type":{"type":"string","x-stream-index":"002"},"result":{"$ref":"#/components/schemas/MessageModerationResult","x-stream-index":"003"}},"type":"object"},"AutomodPlatformCircumventionConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AutomodRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"AutomodRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"003"},"label":{"type":"string","x-stream-index":"001"},"threshold":{"format":"float","maximum":1,"minimum":0,"type":"number","x-stream-index":"002"}},"required":["label","threshold","action"],"type":"object"},"AutomodSemanticFiltersConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AutomodSemanticFiltersRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"AutomodSemanticFiltersRule":{"properties":{"action":{"enum":["flag","shadow","remove"],"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"threshold":{"format":"float","maximum":1,"minimum":0,"type":"number","x-stream-index":"002"}},"required":["name","threshold","action"],"type":"object"},"AutomodToxicityConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AutomodRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"BackstageSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"BackstageSettingsRequest":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"002"}},"type":"object"},"BackstageSettingsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"Ban":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"012"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"011"},"expires":{"format":"date-time","type":"number","x-stream-index":"007"},"reason":{"type":"string","x-stream-index":"008"},"shadow":{"type":"boolean","x-stream-index":"009"},"target":{"$ref":"#/components/schemas/User","x-stream-index":"006"}},"required":["shadow","created_at"],"type":"object"},"BanActionRequest":{"properties":{"channel_ban_only":{"type":"boolean","x-stream-index":"003"},"delete_messages":{"enum":["soft","pruning","hard"],"type":"string","x-stream-index":"005"},"ip_ban":{"type":"boolean","x-stream-index":"004"},"reason":{"type":"string","x-stream-index":"002"},"shadow":{"type":"boolean","x-stream-index":"001"},"timeout":{"format":"int32","type":"integer","x-stream-index":"006"}},"type":"object"},"BanOptions":{"properties":{"duration":{"format":"int32","type":"integer","x-stream-index":"001"},"ip_ban":{"type":"boolean","x-stream-index":"004"},"reason":{"type":"string","x-stream-index":"002"},"shadow_ban":{"type":"boolean","x-stream-index":"003"}},"type":"object"},"BanRequest":{"nullable":true,"properties":{"banned_by":{"$ref":"#/components/schemas/UserRequest","description":"Details about the user performing the ban","title":"Banned By","x-stream-index":"008"},"banned_by_id":{"description":"ID of the user performing the ban","title":"Banned By ID","type":"string","x-stream-index":"007"},"channel_cid":{"description":"Channel where the ban applies","title":"Channel CID","type":"string","x-stream-index":"004"},"delete_messages":{"enum":["soft","pruning","hard"],"type":"string","x-stream-index":"009"},"ip_ban":{"description":"Whether to ban the user's IP address","title":"IP Ban","type":"boolean","x-stream-index":"006"},"reason":{"description":"Optional explanation for the ban","title":"Reason","type":"string","x-stream-index":"003"},"shadow":{"description":"Whether this is a shadow ban","title":"Shadow","type":"boolean","x-stream-index":"005"},"target_user_id":{"description":"ID of the user to ban","title":"Target User ID","type":"string","x-stream-index":"001"},"timeout":{"description":"Duration of the ban in minutes","minimum":0,"title":"Timeout","type":"integer","x-stream-index":"002"}},"required":["target_user_id"],"type":"object"},"BanResponse":{"nullable":true,"properties":{"banned_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"006"},"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"expires":{"format":"date-time","type":"number","x-stream-index":"003"},"reason":{"type":"string","x-stream-index":"004"},"shadow":{"type":"boolean","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"}},"required":["created_at"],"type":"object"},"BlockContentOptions":{"properties":{"reason":{"type":"string","x-stream-index":"001"}},"type":"object"},"BlockListConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/BlockListRule"},"maximum":10,"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"BlockListOptions":{"properties":{"behavior":{"description":"Blocklist behavior","enum":["flag","block","shadow_block"],"title":"Behavior","type":"string","x-stream-index":"002"},"blocklist":{"description":"Blocklist name","title":"Blocklist","type":"string","x-stream-index":"001"}},"required":["blocklist","behavior"],"type":"object"},"BlockListResponse":{"description":"Block list contains restricted words","properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001"},"id":{"type":"string","x-stream-index":"003"},"name":{"description":"Block list name","title":"Name","type":"string","x-stream-index":"004"},"team":{"type":"string","x-stream-index":"007"},"type":{"description":"Block list type.","title":"Type","type":"string","x-stream-index":"005"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"002"},"words":{"description":"List of words to block","items":{"type":"string"},"title":"Words","type":"array","x-stream-index":"006"}},"required":["name","type","words"],"title":"Block list","type":"object","x-stream-docs-page-id":"block_lists"},"BlockListRule":{"properties":{"action":{"enum":["flag","mask_flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"002"}},"required":["name","team","action"],"type":"object"},"BlockUserRequest":{"description":"BlockUserRequest is the payload for blocking a user.","nullable":true,"properties":{"user_id":{"description":"the user to block","title":"UserID","type":"string","x-stream-index":"003"}},"required":["user_id"],"title":"BlockUserRequest","type":"object"},"BlockUserResponse":{"description":"BlockUserResponse is the payload for blocking a user.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"BlockUserResponse","type":"object"},"BlockUsersRequest":{"nullable":true,"properties":{"blocked_user_id":{"description":"User id to block","title":"BlockedUserID","type":"string","x-stream-index":"001"}},"required":["blocked_user_id"],"type":"object"},"BlockUsersResponse":{"nullable":true,"properties":{"blocked_by_user_id":{"description":"User id who blocked another user","title":"BlockedByUserID","type":"string","x-stream-index":"002"},"blocked_user_id":{"description":"User id who got blocked","title":"BlockedUserID","type":"string","x-stream-index":"003"},"created_at":{"description":"Timestamp when the user was blocked","format":"date-time","title":"CreatedAt","type":"number","x-stream-index":"004"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration","blocked_by_user_id","blocked_user_id","created_at"],"type":"object"},"BlockedUserEvent":{"description":"This event is sent to call participants to notify when a user is blocked on a call, clients can use this event to show a notification.\nIf the user is the current user, the client should leave the call screen as well","properties":{"blocked_by_user":{"$ref":"#/components/schemas/UserResponse","description":"The user that blocked the user, null if the user was blocked by server-side","title":"Blocked by","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.blocked_user","description":"The type of event: \"call.blocked_user\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user that was blocked","title":"User","x-stream-index":"003"}},"required":["type","created_at","call_cid","user"],"title":"BlockedUserEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"BlockedUserResponse":{"nullable":true,"properties":{"blocked_user":{"$ref":"#/components/schemas/UserResponse","description":"User who got blocked","title":"User","x-stream-index":"003"},"blocked_user_id":{"description":"ID of the user who got blocked","title":"UserID","type":"string","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who blocked another user","title":"User","x-stream-index":"001"},"user_id":{"description":"ID of the user who blocked another user","title":"UserID","type":"string","x-stream-index":"002"}},"required":["user","user_id","blocked_user","blocked_user_id","created_at"],"type":"object"},"BodyguardRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"},"severity_rules":{"items":{"$ref":"#/components/schemas/BodyguardSeverityRule"},"type":"array","x-stream-index":"003"}},"required":["label","action","severity_rules"],"type":"object"},"BodyguardSeverityRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"severity":{"enum":["low","medium","high","critical"],"type":"string","x-stream-index":"001"}},"required":["severity","action"],"type":"object"},"BookmarkAddedEvent":{"description":"Emitted when a user bookmarks an activity.","nullable":true,"properties":{"bookmark":{"$ref":"#/components/schemas/BookmarkResponse","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.bookmark.added","description":"The type of event: \"feeds.bookmark.added\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who added the bookmark","title":"User","x-stream-index":"003.001"}},"required":["bookmark","type","created_at","custom"],"title":"BookmarkAddedEvent","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"},"BookmarkDeletedEvent":{"description":"Emitted when a user deletes a bookmark from an activity.","nullable":true,"properties":{"bookmark":{"$ref":"#/components/schemas/BookmarkResponse","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.bookmark.deleted","description":"The type of event: \"feeds.bookmark.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who removed the bookmark","title":"User","x-stream-index":"003.001"}},"required":["bookmark","type","created_at","custom"],"title":"BookmarkDeletedEvent","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"},"BookmarkFolderDeletedEvent":{"description":"Emitted when a bookmark folder is deleted.","nullable":true,"properties":{"bookmark_folder":{"$ref":"#/components/schemas/BookmarkFolderResponse","description":"The bookmark folder that was deleted","title":"Bookmark Folder","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.bookmark_folder.deleted","description":"The type of event: \"feeds.bookmark_folder.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who deleted the bookmark folder","title":"User","x-stream-index":"003.001"}},"required":["bookmark_folder","type","created_at","custom"],"title":"BookmarkFolderDeletedEvent","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"},"BookmarkFolderResponse":{"properties":{"created_at":{"description":"When the folder was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"004"},"custom":{"additionalProperties":{},"description":"Custom data for the folder","title":"Custom Data","type":"object","x-stream-index":"003"},"id":{"description":"Unique identifier for the folder","title":"ID","type":"string","x-stream-index":"001"},"name":{"description":"Name of the folder","title":"Name","type":"string","x-stream-index":"002"},"updated_at":{"description":"When the folder was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"005"}},"required":["id","name","created_at","updated_at"],"title":"Bookmark Folder","type":"object"},"BookmarkFolderUpdatedEvent":{"description":"Emitted when a bookmark folder is updated.","nullable":true,"properties":{"bookmark_folder":{"$ref":"#/components/schemas/BookmarkFolderResponse","description":"The bookmark folder that was updated","title":"Bookmark Folder","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.bookmark_folder.updated","description":"The type of event: \"feeds.bookmark_folder.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who updated the bookmark folder","title":"User","x-stream-index":"003.001"}},"required":["bookmark_folder","type","created_at","custom"],"title":"BookmarkFolderUpdatedEvent","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"},"BookmarkResponse":{"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","description":"The bookmarked activity","title":"Activity","x-stream-index":"002"},"created_at":{"description":"When the bookmark was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"005"},"custom":{"additionalProperties":{},"description":"Custom data for the bookmark","title":"Custom Data","type":"object","x-stream-index":"004"},"folder":{"$ref":"#/components/schemas/BookmarkFolderResponse","description":"Folder containing this bookmark","title":"Folder","x-stream-index":"003"},"updated_at":{"description":"When the bookmark was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"006"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who created the bookmark","title":"User","x-stream-index":"001"}},"required":["user","activity","created_at","updated_at"],"title":"Bookmark","type":"object"},"BookmarkUpdatedEvent":{"description":"Emitted when a user updates a bookmark.","nullable":true,"properties":{"bookmark":{"$ref":"#/components/schemas/BookmarkResponse","description":"The updated bookmark","title":"Bookmark","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.bookmark.updated","description":"The type of event: \"feeds.bookmark.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who updated the bookmark","title":"User","x-stream-index":"003.001"}},"required":["bookmark","type","created_at","custom"],"title":"BookmarkUpdatedEvent","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"},"Bound":{"properties":{"inclusive":{"type":"boolean","x-stream-index":"002"},"value":{"format":"float","type":"number","x-stream-index":"001"}},"required":["value","inclusive"],"type":"object"},"BroadcastSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettings","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettings","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"BroadcastSettingsRequest":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettingsRequest","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettingsRequest","x-stream-index":"003"}},"type":"object"},"BroadcastSettingsResponse":{"description":"BroadcastSettingsResponse is the payload for broadcasting settings","properties":{"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettingsResponse","title":"HLS","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettingsResponse","title":"RTMP","x-stream-index":"003"}},"required":["enabled","hls","rtmp"],"title":"BroadcastSettingsResponse","type":"object"},"Call":{"properties":{"AppPK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"002"},"Backstage":{"type":"boolean","writeOnly":true,"x-stream-index":"023"},"BlockedUserIDs":{"items":{"type":"string"},"type":"array","writeOnly":true,"x-stream-index":"018"},"BlockedUsers":{"items":{"$ref":"#/components/schemas/User"},"type":"array","writeOnly":true,"x-stream-index":"019"},"CID":{"type":"string","writeOnly":true,"x-stream-index":"005"},"CallType":{"$ref":"#/components/schemas/CallType","x-stream-index":"020"},"ChannelCID":{"type":"string","writeOnly":true,"x-stream-index":"032"},"CreatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"013"},"CreatedBy":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"CreatedByUserID":{"type":"string","writeOnly":true,"x-stream-index":"007"},"CurrentSessionID":{"type":"string","writeOnly":true,"x-stream-index":"024"},"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"012"},"DeletedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"028"},"EgressUpdatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"027"},"Egresses":{"items":{"$ref":"#/components/schemas/CallEgress"},"type":"array","writeOnly":true,"x-stream-index":"015"},"EndedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"017"},"ID":{"type":"string","writeOnly":true,"x-stream-index":"004"},"JoinAheadTimeSeconds":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"031"},"LastHeartbeatAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"030"},"LastSessionID":{"type":"string","writeOnly":true,"x-stream-index":"025"},"MemberCount":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"010"},"MemberLookup":{"$ref":"#/components/schemas/MemberLookup","x-stream-index":"011"},"Members":{"items":{"$ref":"#/components/schemas/CallMember"},"type":"array","writeOnly":true,"x-stream-index":"009"},"Session":{"$ref":"#/components/schemas/CallSession","x-stream-index":"026"},"Settings":{"$ref":"#/components/schemas/CallSettings","x-stream-index":"022"},"SettingsOverrides":{"$ref":"#/components/schemas/CallSettings","x-stream-index":"021"},"StartsAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"016"},"Team":{"type":"string","writeOnly":true,"x-stream-index":"006"},"ThumbnailURL":{"type":"string","writeOnly":true,"x-stream-index":"029"},"Type":{"type":"string","writeOnly":true,"x-stream-index":"003"},"UpdatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"014"}},"required":["AppPK","Type","ID","CID","Team","CreatedByUserID","Members","Custom","CreatedAt","UpdatedAt","Egresses","BlockedUserIDs","BlockedUsers","Backstage","CurrentSessionID","LastSessionID","ThumbnailURL","ChannelCID"],"type":"object"},"CallAcceptedEvent":{"description":"This event is sent when a user accepts a notification to join a call.","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.accepted","description":"The type of event: \"call.accepted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who accepted the call","title":"User","x-stream-index":"004"}},"required":["type","created_at","call_cid","call","user"],"title":"CallAcceptedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallClosedCaption":{"description":"CallClosedCaption represents a closed caption of a call.","properties":{"end_time":{"format":"date-time","title":"The end time of the closed caption.","type":"number","x-stream-index":"003"},"speaker_id":{"title":"The speaker ID of the closed caption.","type":"string","x-stream-index":"004"},"start_time":{"format":"date-time","title":"The start time of the closed caption.","type":"number","x-stream-index":"002"},"text":{"title":"The text of the closed caption.","type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserResponse","title":"The full user for the closed caption.","x-stream-index":"005"}},"required":["text","start_time","end_time","speaker_id","user"],"title":"CallClosedCaption","type":"object"},"CallClosedCaptionsFailedEvent":{"description":"This event is sent when call closed captions has failed","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.closed_captions_failed","description":"The type of event: \"call.closed_captions_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallClosedCaptionsFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallClosedCaptionsStartedEvent":{"description":"This event is sent when call closed caption has started","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.closed_captions_started","description":"The type of event: \"call.closed_captions_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallClosedCaptionsStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallClosedCaptionsStoppedEvent":{"description":"This event is sent when call closed captions has stopped","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.closed_captions_stopped","description":"The type of event: \"call.transcription_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallClosedCaptionsStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallCreatedEvent":{"description":"This event is sent when a call is created. Clients receiving this event should check if the ringing\nfield is set to true and if so, show the call screen","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"the members added to this call","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"004"},"type":{"default":"call.created","description":"The type of event: \"call.created\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","members"],"title":"CallCreatedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallDeletedEvent":{"description":"This event is sent when a call is deleted. Clients receiving this event should leave the call screen","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.deleted","description":"The type of event: \"call.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call"],"title":"CallDeletedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallDurationReport":{"properties":{"histogram":{"items":{"$ref":"#/components/schemas/ReportByHistogramBucket"},"type":"array","x-stream-index":"001"}},"required":["histogram"],"type":"object"},"CallDurationReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateCallDurationReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"CallEgress":{"nullable":true,"properties":{"app_pk":{"format":"int32","type":"integer","x-stream-index":"002"},"call_id":{"type":"string","x-stream-index":"004"},"call_type":{"type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/EgressTaskConfig","x-stream-index":"007"},"egress_id":{"type":"string","x-stream-index":"005"},"egress_type":{"type":"string","x-stream-index":"006"},"instance_ip":{"type":"string","x-stream-index":"008"},"started_at":{"format":"date-time","type":"number","x-stream-index":"010"},"state":{"type":"string","x-stream-index":"009"},"stopped_at":{"format":"date-time","type":"number","x-stream-index":"011"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"012"}},"required":["app_pk","call_type","call_id","egress_id","egress_type","instance_ip","state","started_at","updated_at"],"type":"object"},"CallEndedEvent":{"description":"This event is sent when a call is mark as ended for all its participants. Clients receiving this event should leave the call screen","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"reason":{"description":"The reason why the call ended, if available","title":"CallEndedReason","type":"string","x-stream-index":"005"},"type":{"default":"call.ended","description":"The type of event: \"call.ended\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who ended the call, null if the call was ended by the server","title":"User","x-stream-index":"004"}},"required":["type","created_at","call_cid","call"],"title":"CallEndedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallFrameRecordingFailedEvent":{"description":"This event is sent when frame recording has failed","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.frame_recording_failed","description":"The type of event: \"call.frame_recording_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","egress_id"],"title":"CallFrameRecordingFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallFrameRecordingFrameReadyEvent":{"description":"This event is sent when a frame is captured from a call","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"captured_at":{"description":"The time the frame was captured","format":"date-time","title":"CapturedAt","type":"number","x-stream-index":"006"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"008"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"track_type":{"description":"The type of the track frame was captured from (TRACK_TYPE_VIDEO|TRACK_TYPE_SCREEN_SHARE)","title":"TrackType","type":"string","x-stream-index":"004"},"type":{"default":"call.frame_recording_ready","description":"The type of event: \"call.frame_recording_ready\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"url":{"description":"The URL of the frame","title":"URL","type":"string","x-stream-index":"005"},"users":{"additionalProperties":{"$ref":"#/components/schemas/UserResponse"},"description":"The users in the frame","title":"Users","type":"object","x-stream-index":"007"}},"required":["type","created_at","call_cid","session_id","track_type","url","captured_at","users","egress_id"],"title":"CallFrameRecordingFrameReadyEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallFrameRecordingStartedEvent":{"description":"This event is sent when frame recording has started","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.frame_recording_started","description":"The type of event: \"call.frame_recording_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","egress_id"],"title":"CallFrameRecordingStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallFrameRecordingStoppedEvent":{"description":"This event is sent when frame recording has stopped","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.frame_recording_stopped","description":"The type of event: \"call.frame_recording_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","egress_id"],"title":"CallFrameRecordingStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallHLSBroadcastingFailedEvent":{"description":"This event is sent when HLS broadcasting has failed","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.hls_broadcasting_failed","description":"The type of event: \"call.hls_broadcasting_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallHLSBroadcastingFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallHLSBroadcastingStartedEvent":{"description":"This event is sent when HLS broadcasting has started","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"hls_playlist_url":{"type":"string","x-stream-index":"004"},"type":{"default":"call.hls_broadcasting_started","description":"The type of event: \"call.hls_broadcasting_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","hls_playlist_url"],"title":"CallHLSBroadcastingStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallHLSBroadcastingStoppedEvent":{"description":"This event is sent when HLS broadcasting has stopped","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.hls_broadcasting_stopped","description":"The type of event: \"call.hls_broadcasting_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallHLSBroadcastingStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallIngressResponse":{"description":"CallIngressResponse is the payload for ingress settings","properties":{"rtmp":{"$ref":"#/components/schemas/RTMPIngress","title":"RTMP","x-stream-index":"001"}},"required":["rtmp"],"title":"CallIngressResponse","type":"object"},"CallLiveStartedEvent":{"description":"This event is sent when a call is started. Clients receiving this event should start the call.","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.live_started","description":"The type of event: \"call.live_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call"],"title":"CallLiveStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMember":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"010"},"role":{"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["user_id","role","custom","created_at","updated_at"],"type":"object"},"CallMemberAddedEvent":{"description":"This event is sent when one or more members are added to a call","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"the members added to this call","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"004"},"type":{"default":"call.member_added","description":"The type of event: \"call.member_added\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","members"],"title":"CallMemberAddedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMemberRemovedEvent":{"description":"This event is sent when one or more members are removed from a call","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"the list of member IDs removed from the call","items":{"type":"string"},"title":"Members","type":"array","x-stream-index":"004"},"type":{"default":"call.member_removed","description":"The type of event: \"call.member_removed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","members"],"title":"CallMemberRemovedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMemberUpdatedEvent":{"description":"This event is sent when one or more members are updated","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"The list of members that were updated","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"004"},"type":{"default":"call.member_updated","description":"The type of event: \"call.member_updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","members"],"title":"CallMemberUpdatedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMemberUpdatedPermissionEvent":{"description":"This event is sent when one or more members get its role updated","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"capabilities_by_role":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"The capabilities by role for this call","title":"CapabilitiesByRole","type":"object","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"The list of members that were updated","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"005"},"type":{"default":"call.member_updated_permission","description":"The type of event: \"call.member_added\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","capabilities_by_role","members"],"title":"CallMemberUpdatedPermissionEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMissedEvent":{"description":"This event is sent to call members who did not accept/reject/join the call to notify they missed the call","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"List of members who missed the call","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"005"},"notify_user":{"type":"boolean","x-stream-index":"007"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.missed","description":"The type of event: \"call.notification\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The caller from whom the call was missed","title":"User","x-stream-index":"006"}},"required":["type","created_at","call_cid","session_id","call","members","user","notify_user"],"title":"CallMissedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallModerationBlurEvent":{"properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"type":{"default":"call.moderation_blur","type":"string","x-stream-index":"001.001"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["type","created_at","call_cid","user_id","custom"],"title":"CallModerationBlurEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallModerationWarningEvent":{"properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"message":{"type":"string","x-stream-index":"004"},"type":{"default":"call.moderation_warning","type":"string","x-stream-index":"001.001"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["type","created_at","call_cid","user_id","message","custom"],"title":"CallModerationWarningEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallNotificationEvent":{"description":"This event is sent to all call members to notify they are getting called","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"Call members","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"005"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.notification","description":"The type of event: \"call.notification\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user that sent the call notification","title":"User","x-stream-index":"006"}},"required":["type","created_at","call_cid","session_id","call","members","user"],"title":"CallNotificationEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallParticipant":{"nullable":true,"properties":{"JoinedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"004"},"Role":{"type":"string","writeOnly":true,"x-stream-index":"002"},"UserSessionID":{"type":"string","writeOnly":true,"x-stream-index":"003"},"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"001.046"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"001.017"},"banned":{"type":"boolean","x-stream-index":"001.016"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.013"},"id":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"001.023"},"language":{"type":"string","x-stream-index":"001.035"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"001.022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"001.026"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.042"},"role":{"type":"string","x-stream-index":"001.004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.005"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.009"}},"required":["id","role","teams_role","custom","banned","online","Role","UserSessionID","JoinedAt"],"type":"object"},"CallParticipantCountReport":{"properties":{"histogram":{"items":{"$ref":"#/components/schemas/ReportByHistogramBucket"},"type":"array","x-stream-index":"001"}},"required":["histogram"],"type":"object"},"CallParticipantCountReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateCallParticipantCountReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"CallParticipantResponse":{"properties":{"joined_at":{"format":"date-time","type":"number","x-stream-index":"004"},"role":{"type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"},"user_session_id":{"type":"string","x-stream-index":"002"}},"required":["user","user_session_id","role","joined_at"],"type":"object"},"CallReactionEvent":{"description":"This event is sent when a reaction is sent in a call, clients should use this to show the reaction in the call screen","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"reaction":{"$ref":"#/components/schemas/ReactionResponse","description":"the reaction object sent by the user on the call","title":"reaction","x-stream-index":"003"},"type":{"default":"call.reaction_new","description":"The type of event: \"call.reaction_new\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","reaction"],"title":"CallReactionEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRecording":{"description":"CallRecording represents a recording of a call.","properties":{"end_time":{"format":"date-time","title":"The end time of the recording.","type":"number","x-stream-index":"004"},"filename":{"title":"The filename of the recording.","type":"string","x-stream-index":"001"},"session_id":{"title":"The session ID of the recording.","type":"string","x-stream-index":"005"},"start_time":{"format":"date-time","title":"The start time of the recording.","type":"number","x-stream-index":"003"},"url":{"title":"The URL of the recording.","type":"string","x-stream-index":"002"}},"required":["filename","url","start_time","end_time","session_id"],"title":"CallRecording","type":"object"},"CallRecordingFailedEvent":{"description":"This event is sent when call recording has failed","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"003"},"type":{"default":"call.recording_failed","description":"The type of event: \"call.recording_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","egress_id"],"title":"CallRecordingFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRecordingReadyEvent":{"description":"This event is sent when call recording is ready","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"call_recording":{"$ref":"#/components/schemas/CallRecording","description":"The call recording object","title":"CallRecording","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.recording_ready","description":"The type of event: \"call.recording_ready\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call_recording","egress_id"],"title":"CallRecordingReadyEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRecordingStartedEvent":{"description":"This event is sent when call recording has started","properties":{"call_cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"egress_id":{"type":"string","x-stream-index":"001"},"type":{"default":"call.recording_started","description":"The type of event: \"call.recording_started\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001"}},"required":["egress_id","type","created_at","call_cid"],"title":"CallRecordingStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRecordingStoppedEvent":{"description":"This event is sent when call recording has stopped","properties":{"call_cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"egress_id":{"type":"string","x-stream-index":"001"},"type":{"default":"call.recording_stopped","description":"The type of event: \"call.recording_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001"}},"required":["egress_id","type","created_at","call_cid"],"title":"CallRecordingStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRejectedEvent":{"description":"This event is sent when a user rejects a notification to join a call.","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"reason":{"description":"Provides information about why the call was rejected. You can provide any value, but the Stream API and SDKs use these default values: rejected, cancel, timeout and busy","title":"Reason","type":"string","x-stream-index":"005"},"type":{"default":"call.rejected","description":"The type of event: \"call.rejected\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who rejected the call","title":"User","x-stream-index":"004"}},"required":["type","created_at","call_cid","call","user"],"title":"CallRejectedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallReportResponse":{"properties":{"ended_at":{"format":"date-time","type":"number","x-stream-index":"003"},"score":{"format":"float","type":"number","x-stream-index":"001"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002"}},"required":["score"],"type":"object"},"CallRequest":{"description":"CallRequest is the payload for creating a call.","properties":{"channel_cid":{"type":"string","x-stream-index":"009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"members":{"items":{"$ref":"#/components/schemas/MemberRequest"},"maximum":100,"type":"array","x-stream-index":"005"},"settings_override":{"$ref":"#/components/schemas/CallSettingsRequest","x-stream-index":"006"},"starts_at":{"format":"date-time","type":"number","x-stream-index":"007"},"team":{"type":"string","x-stream-index":"001"},"video":{"type":"boolean","x-stream-index":"008"}},"title":"CallRequest","type":"object"},"CallResponse":{"description":"Represents a call","properties":{"backstage":{"type":"boolean","x-stream-index":"016"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"018"},"captioning":{"type":"boolean","x-stream-index":"013"},"channel_cid":{"type":"string","x-stream-index":"024"},"cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"The user that created the call","title":"Created By","x-stream-index":"007"},"current_session_id":{"type":"string","x-stream-index":"005"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"008"},"egress":{"$ref":"#/components/schemas/EgressResponse","x-stream-index":"021"},"ended_at":{"description":"Date/time when the call ended","format":"date-time","title":"Ended At","type":"number","x-stream-index":"014"},"id":{"description":"Call ID","title":"ID","type":"string","x-stream-index":"003"},"ingress":{"$ref":"#/components/schemas/CallIngressResponse","x-stream-index":"019"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"023"},"recording":{"type":"boolean","x-stream-index":"011"},"session":{"$ref":"#/components/schemas/CallSessionResponse","x-stream-index":"020"},"settings":{"$ref":"#/components/schemas/CallSettingsResponse","x-stream-index":"017"},"starts_at":{"description":"Date/time when the call will start","format":"date-time","title":"Starts At","type":"number","x-stream-index":"015"},"team":{"type":"string","x-stream-index":"006"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailResponse","x-stream-index":"022"},"transcribing":{"type":"boolean","x-stream-index":"012"},"type":{"description":"The type of call","title":"Type","type":"string","x-stream-index":"002"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"}},"required":["type","id","cid","current_session_id","created_by","custom","created_at","updated_at","recording","transcribing","captioning","backstage","settings","blocked_user_ids","ingress","egress"],"title":"CallResponse","type":"object"},"CallRingEvent":{"description":"This event is sent to all call members to notify they are getting called","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"005"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"Call members","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"006"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.ring","description":"The type of event: \"call.notification\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user that sent the call notification","title":"User","x-stream-index":"007"},"video":{"type":"boolean","x-stream-index":"008"}},"required":["type","created_at","call_cid","session_id","call","members","user","video"],"title":"CallRingEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRtmpBroadcastFailedEvent":{"description":"This event is sent when a call RTMP broadcast has failed","properties":{"call_cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"002.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.002"},"name":{"description":"Name of the given RTMP broadcast","title":"Name","type":"string","x-stream-index":"003"},"type":{"default":"call.rtmp_broadcast_failed","description":"The type of event: \"call.rtmp_broadcast_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","name"],"title":"CallRtmpBroadcastFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRtmpBroadcastStartedEvent":{"description":"This event is sent when RTMP broadcast has started","properties":{"call_cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"002.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.002"},"name":{"description":"Name of the given RTMP broadcast","title":"Name","type":"string","x-stream-index":"003"},"type":{"default":"call.rtmp_broadcast_started","description":"The type of event: \"call.rtmp_broadcast_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","name"],"title":"CallRtmpBroadcastStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRtmpBroadcastStoppedEvent":{"description":"This event is sent when RTMP broadcast has stopped","properties":{"call_cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"002.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.002"},"name":{"description":"Name of the given RTMP broadcast","title":"Name","type":"string","x-stream-index":"003"},"type":{"default":"call.rtmp_broadcast_stopped","description":"The type of event: \"call.rtmp_broadcast_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","name"],"title":"CallRtmpBroadcastStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSession":{"properties":{"AcceptedBy":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","writeOnly":true,"x-stream-index":"008"},"ActiveSFUs":{"items":{"$ref":"#/components/schemas/SFUIDLastSeen"},"type":"array","writeOnly":true,"x-stream-index":"016"},"AnonymousParticipantCount":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"019"},"AppPK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"002.001"},"CallID":{"type":"string","writeOnly":true,"x-stream-index":"002.003"},"CallType":{"type":"string","writeOnly":true,"x-stream-index":"002.002"},"CreatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"003"},"DeletedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"004"},"EndedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"006"},"LiveEndedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"013"},"LiveStartedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"012"},"MissedBy":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","writeOnly":true,"x-stream-index":"010"},"Participants":{"items":{"$ref":"#/components/schemas/CallParticipant"},"type":"array","writeOnly":true,"x-stream-index":"011"},"ParticipantsCountByRole":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","writeOnly":true,"x-stream-index":"018"},"RejectedBy":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","writeOnly":true,"x-stream-index":"009"},"RingAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"007"},"SFUIDs":{"items":{"type":"string"},"type":"array","writeOnly":true,"x-stream-index":"015"},"SessionID":{"type":"string","writeOnly":true,"x-stream-index":"002.004"},"StartedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"005"},"TimerEndsAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"014"},"UserPermissionOverrides":{"additionalProperties":{"additionalProperties":{"type":"boolean"},"type":"object"},"type":"object","writeOnly":true,"x-stream-index":"017"}},"required":["AppPK","CallType","CallID","SessionID","CreatedAt","AcceptedBy","RejectedBy","MissedBy","Participants","SFUIDs","ActiveSFUs","UserPermissionOverrides","ParticipantsCountByRole","AnonymousParticipantCount"],"type":"object"},"CallSessionEndedEvent":{"description":"This event is sent when a call session ends","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_ended","description":"The type of event: \"call.session_ended\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","call"],"title":"CallSessionEndedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSessionParticipantCountsUpdatedEvent":{"description":"This event is sent when the participant counts in a call session are updated","properties":{"anonymous_participant_count":{"format":"int32","type":"integer","x-stream-index":"005"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"participants_count_by_role":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"004"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_participant_count_updated","description":"The type of event: \"call.session_participant_count_updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","participants_count_by_role","anonymous_participant_count"],"title":"CallSessionParticipantCountsUpdatedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSessionParticipantJoinedEvent":{"description":"This event is sent when a participant joins a call session","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"participant":{"$ref":"#/components/schemas/CallParticipantResponse","description":"The participant that joined the session","title":"Participant","x-stream-index":"004"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_participant_joined","description":"The type of event: \"call.session_participant_joined\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","participant"],"title":"CallSessionParticipantJoinedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSessionParticipantLeftEvent":{"description":"This event is sent when a participant leaves a call session","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"duration_seconds":{"description":"The duration participant was in the session in seconds","format":"int32","title":"Duration","type":"integer","x-stream-index":"005"},"participant":{"$ref":"#/components/schemas/CallParticipantResponse","description":"The participant that left the session","title":"Participant","x-stream-index":"004"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_participant_left","description":"The type of event: \"call.session_participant_left\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","participant","duration_seconds"],"title":"CallSessionParticipantLeftEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSessionResponse":{"properties":{"accepted_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"008"},"anonymous_participant_count":{"format":"int32","type":"integer","x-stream-index":"006"},"ended_at":{"format":"date-time","type":"number","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"live_ended_at":{"format":"date-time","type":"number","x-stream-index":"011"},"live_started_at":{"format":"date-time","type":"number","x-stream-index":"010"},"missed_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"009"},"participants":{"items":{"$ref":"#/components/schemas/CallParticipantResponse"},"type":"array","x-stream-index":"004"},"participants_count_by_role":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"005"},"rejected_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"007"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002"},"timer_ends_at":{"format":"date-time","type":"number","x-stream-index":"012"}},"required":["id","participants","participants_count_by_role","anonymous_participant_count","rejected_by","accepted_by","missed_by"],"type":"object"},"CallSessionStartedEvent":{"description":"This event is sent when a call session starts","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_started","description":"The type of event: \"call.session_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","call"],"title":"CallSessionStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSettings":{"properties":{"audio":{"$ref":"#/components/schemas/AudioSettings","x-stream-index":"001"},"backstage":{"$ref":"#/components/schemas/BackstageSettings","x-stream-index":"002"},"broadcasting":{"$ref":"#/components/schemas/BroadcastSettings","x-stream-index":"007"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordSettings","x-stream-index":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettings","x-stream-index":"008"},"ingress":{"$ref":"#/components/schemas/IngressSettings","x-stream-index":"014"},"limits":{"$ref":"#/components/schemas/LimitsSettings","x-stream-index":"012"},"recording":{"$ref":"#/components/schemas/RecordSettings","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettings","x-stream-index":"010"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettings","x-stream-index":"004"},"session":{"$ref":"#/components/schemas/SessionSettings","x-stream-index":"013"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettings","x-stream-index":"011"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettings","x-stream-index":"009"},"video":{"$ref":"#/components/schemas/VideoSettings","x-stream-index":"003"}},"type":"object"},"CallSettingsRequest":{"properties":{"audio":{"$ref":"#/components/schemas/AudioSettingsRequest","x-stream-index":"001"},"backstage":{"$ref":"#/components/schemas/BackstageSettingsRequest","x-stream-index":"002"},"broadcasting":{"$ref":"#/components/schemas/BroadcastSettingsRequest","x-stream-index":"010"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordingSettingsRequest","x-stream-index":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettingsRequest","x-stream-index":"003"},"ingress":{"$ref":"#/components/schemas/IngressSettingsRequest","x-stream-index":"014"},"limits":{"$ref":"#/components/schemas/LimitsSettingsRequest","x-stream-index":"012"},"recording":{"$ref":"#/components/schemas/RecordSettingsRequest","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettingsRequest","x-stream-index":"007"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettingsRequest","x-stream-index":"008"},"session":{"$ref":"#/components/schemas/SessionSettingsRequest","x-stream-index":"013"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettingsRequest","x-stream-index":"011"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettingsRequest","x-stream-index":"009"},"video":{"$ref":"#/components/schemas/VideoSettingsRequest","x-stream-index":"004"}},"type":"object"},"CallSettingsResponse":{"properties":{"audio":{"$ref":"#/components/schemas/AudioSettingsResponse","x-stream-index":"001"},"backstage":{"$ref":"#/components/schemas/BackstageSettingsResponse","x-stream-index":"002"},"broadcasting":{"$ref":"#/components/schemas/BroadcastSettingsResponse","x-stream-index":"003"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordingSettingsResponse","x-stream-index":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettingsResponse","x-stream-index":"004"},"ingress":{"$ref":"#/components/schemas/IngressSettingsResponse","x-stream-index":"014"},"limits":{"$ref":"#/components/schemas/LimitsSettingsResponse","x-stream-index":"012"},"recording":{"$ref":"#/components/schemas/RecordSettingsResponse","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettingsResponse","x-stream-index":"007"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettingsResponse","x-stream-index":"008"},"session":{"$ref":"#/components/schemas/SessionSettingsResponse","x-stream-index":"013"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettingsResponse","x-stream-index":"011"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettingsResponse","x-stream-index":"009"},"video":{"$ref":"#/components/schemas/VideoSettingsResponse","x-stream-index":"010"}},"required":["audio","backstage","broadcasting","geofencing","recording","frame_recording","ring","screensharing","transcription","video","thumbnails","limits","session"],"type":"object"},"CallStateResponseFields":{"description":"CallStateResponseFields is the payload for call state response","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001"},"members":{"description":"List of call members","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"002"},"membership":{"$ref":"#/components/schemas/MemberResponse","description":"Current user membership object","title":"Membership","x-stream-index":"003"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"004"}},"required":["call","members","own_capabilities","blocked_users"],"title":"CallStateResponseFields","type":"object"},"CallStatsReportReadyEvent":{"description":"This event is sent when the insights report is ready","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.stats_report_ready","description":"The type of event, \"call.report_ready\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id"],"title":"CallStatsReportReadyEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallStatsReportSummaryResponse":{"properties":{"call_cid":{"type":"string","x-stream-index":"001"},"call_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"008"},"call_session_id":{"type":"string","x-stream-index":"002"},"call_status":{"type":"string","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"first_stats_time":{"format":"date-time","type":"number","x-stream-index":"003"},"min_user_rating":{"format":"int32","type":"integer","x-stream-index":"006"},"quality_score":{"format":"int32","type":"integer","x-stream-index":"005"}},"required":["call_cid","call_session_id","first_stats_time","call_status","call_duration_seconds"],"type":"object"},"CallTranscription":{"description":"CallTranscription represents a transcription of a call.","properties":{"end_time":{"format":"date-time","title":"The end time of the transcription.","type":"number","x-stream-index":"004"},"filename":{"title":"The filename of the transcription.","type":"string","x-stream-index":"001"},"session_id":{"title":"The session ID of the transcription.","type":"string","x-stream-index":"005"},"start_time":{"format":"date-time","title":"The start time of the transcription.","type":"number","x-stream-index":"003"},"url":{"title":"The URL of the transcription.","type":"string","x-stream-index":"002"}},"required":["filename","url","start_time","end_time","session_id"],"title":"CallTranscription","type":"object"},"CallTranscriptionFailedEvent":{"description":"This event is sent when call transcription has failed","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"003"},"error":{"description":"The error message detailing why transcription failed.","title":"string","type":"string","x-stream-index":"004"},"type":{"default":"call.transcription_failed","description":"The type of event: \"call.transcription_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","egress_id"],"title":"CallTranscriptionFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallTranscriptionReadyEvent":{"description":"This event is sent when call transcription is ready","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"call_transcription":{"$ref":"#/components/schemas/CallTranscription","description":"The call transcription object","title":"CallTranscription","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.transcription_ready","description":"The type of event: \"call.transcription_ready\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call_transcription","egress_id"],"title":"CallTranscriptionReadyEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallTranscriptionStartedEvent":{"description":"This event is sent when call transcription has started","properties":{"call_cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"egress_id":{"type":"string","x-stream-index":"001"},"type":{"default":"call.transcription_started","description":"The type of event: \"call.transcription_started\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001"}},"required":["egress_id","type","created_at","call_cid"],"title":"CallTranscriptionStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallTranscriptionStoppedEvent":{"description":"This event is sent when call transcription has stopped","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"003"},"type":{"default":"call.transcription_stopped","description":"The type of event: \"call.transcription_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","egress_id"],"title":"CallTranscriptionStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallType":{"properties":{"AppPK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"003"},"CreatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"005"},"ExternalStorage":{"type":"string","writeOnly":true,"x-stream-index":"009"},"Name":{"type":"string","writeOnly":true,"x-stream-index":"004"},"NotificationSettings":{"$ref":"#/components/schemas/NotificationSettings","x-stream-index":"008"},"PK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"002"},"Settings":{"$ref":"#/components/schemas/CallSettings","x-stream-index":"007"},"UpdatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"006"}},"required":["PK","AppPK","Name","CreatedAt","UpdatedAt","ExternalStorage"],"type":"object"},"CallUpdatedEvent":{"description":"This event is sent when a call is updated, clients should use this update the local state of the call.\nThis event also contains the capabilities by role for the call, clients should update the own_capability for the current.","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"capabilities_by_role":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"The capabilities by role for this call","title":"CapabilitiesByRole","type":"object","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.updated","description":"The type of event: \"call.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","capabilities_by_role"],"title":"CallUpdatedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallUserFeedbackSubmittedEvent":{"description":"This event is sent when a user submits feedback for a call.","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"custom":{"additionalProperties":{},"description":"Custom data provided by the user","title":"Custom","type":"object","x-stream-index":"007"},"rating":{"description":"The rating given by the user (1-5)","format":"int32","title":"Rating","type":"integer","x-stream-index":"005"},"reason":{"description":"The reason provided by the user for the rating","title":"Reason","type":"string","x-stream-index":"006"},"sdk":{"type":"string","x-stream-index":"008"},"sdk_version":{"type":"string","x-stream-index":"009"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.user_feedback_submitted","description":"The type of event, \"call.user_feedback\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who submitted the feedback","title":"User","x-stream-index":"004"}},"required":["type","created_at","call_cid","session_id","user","rating"],"title":"CallUserFeedbackSubmittedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallUserMutedEvent":{"description":"This event is sent when a call member is muted","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"from_user_id":{"type":"string","x-stream-index":"003"},"muted_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"type":{"default":"call.user_muted","description":"The type of event: \"call.user_muted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","from_user_id","muted_user_ids"],"title":"CallUserMutedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallsPerDayReport":{"properties":{"count":{"format":"int64","type":"integer","x-stream-index":"001"}},"required":["count"],"type":"object"},"CallsPerDayReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateCallsPerDayReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"CastPollVoteRequest":{"nullable":true,"properties":{"vote":{"$ref":"#/components/schemas/VoteData","description":"Vote data","title":"VoteData","x-stream-index":"004"}},"type":"object"},"Channel":{"properties":{"active_live_locations":{"items":{"$ref":"#/components/schemas/SharedLocation"},"type":"array","x-stream-index":"034"},"auto_translation_enabled":{"type":"boolean","x-stream-index":"029"},"auto_translation_language":{"type":"string","x-stream-index":"030"},"cid":{"type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/ChannelConfig","x-stream-index":"026"},"config_overrides":{"$ref":"#/components/schemas/ConfigOverrides","x-stream-index":"027"},"cooldown":{"format":"int32","type":"integer","x-stream-index":"031"},"created_at":{"format":"date-time","type":"number","x-stream-index":"009"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"019"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"disabled":{"type":"boolean","x-stream-index":"017"},"frozen":{"type":"boolean","x-stream-index":"016"},"id":{"type":"string","x-stream-index":"004"},"invites":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"022"},"last_campaigns":{"type":"string","x-stream-index":"032"},"last_message_at":{"format":"date-time","type":"number","x-stream-index":"006"},"member_count":{"format":"int32","type":"integer","x-stream-index":"021"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"020"},"message_count":{"format":"int64","type":"integer","x-stream-index":"035"},"message_count_updated_at":{"format":"date-time","type":"number","x-stream-index":"036"},"team":{"type":"string","x-stream-index":"028"},"truncated_by":{"$ref":"#/components/schemas/User","x-stream-index":"015"},"type":{"type":"string","x-stream-index":"005"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"010"}},"required":["cid","id","type","created_at","updated_at","frozen","disabled","custom","auto_translation_language"],"type":"object"},"ChannelConfig":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.027"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.022"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.023"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.028"},"blocklist":{"type":"string","x-stream-index":"001.024"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.025"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.026"},"commands":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"connect_events":{"type":"boolean","x-stream-index":"001.004"},"count_messages":{"type":"boolean","x-stream-index":"001.019"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"custom_events":{"type":"boolean","x-stream-index":"001.012"},"mark_messages_pending":{"type":"boolean","x-stream-index":"001.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"001.021"},"mutes":{"type":"boolean","x-stream-index":"001.009"},"name":{"type":"string","x-stream-index":"001.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"001.029"},"partition_ttl":{"type":"integer","x-stream-index":"001.030"},"polls":{"type":"boolean","x-stream-index":"001.016"},"push_notifications":{"type":"boolean","x-stream-index":"001.013"},"quotes":{"type":"boolean","x-stream-index":"001.008"},"reactions":{"type":"boolean","x-stream-index":"001.006"},"read_events":{"type":"boolean","x-stream-index":"001.003"},"reminders":{"type":"boolean","x-stream-index":"001.014"},"replies":{"type":"boolean","x-stream-index":"001.007"},"search":{"type":"boolean","x-stream-index":"001.005"},"shared_locations":{"type":"boolean","x-stream-index":"001.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.031"},"typing_events":{"type":"boolean","x-stream-index":"001.002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"002.004"},"uploads":{"type":"boolean","x-stream-index":"001.010"},"url_enrichment":{"type":"boolean","x-stream-index":"001.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"001.017"}},"required":["name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","count_messages","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","created_at","updated_at","commands"],"type":"object"},"ChannelConfigWithInfo":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.002.027"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.002.022"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.023"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.002.028"},"blocklist":{"type":"string","x-stream-index":"001.002.024"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.025"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.002.026"},"commands":{"items":{"$ref":"#/components/schemas/Command"},"type":"array","x-stream-index":"001.003"},"connect_events":{"type":"boolean","x-stream-index":"001.002.004"},"count_messages":{"type":"boolean","x-stream-index":"001.002.019"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.001.003"},"custom_events":{"type":"boolean","x-stream-index":"001.002.012"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"002"},"mark_messages_pending":{"type":"boolean","x-stream-index":"001.002.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"001.002.021"},"mutes":{"type":"boolean","x-stream-index":"001.002.009"},"name":{"type":"string","x-stream-index":"001.002.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"001.002.029"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"001.002.030"},"polls":{"type":"boolean","x-stream-index":"001.002.016"},"push_notifications":{"type":"boolean","x-stream-index":"001.002.013"},"quotes":{"type":"boolean","x-stream-index":"001.002.008"},"reactions":{"type":"boolean","x-stream-index":"001.002.006"},"read_events":{"type":"boolean","x-stream-index":"001.002.003"},"reminders":{"type":"boolean","x-stream-index":"001.002.014"},"replies":{"type":"boolean","x-stream-index":"001.002.007"},"search":{"type":"boolean","x-stream-index":"001.002.005"},"shared_locations":{"type":"boolean","x-stream-index":"001.002.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.002.031"},"typing_events":{"type":"boolean","x-stream-index":"001.002.002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"uploads":{"type":"boolean","x-stream-index":"001.002.010"},"url_enrichment":{"type":"boolean","x-stream-index":"001.002.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"001.002.017"}},"required":["created_at","updated_at","name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","count_messages","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","commands"],"type":"object"},"ChannelCreatedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"channel.created","type":"string","x-stream-index":"001.001"}},"required":["type","created_at"],"title":"ChannelCreatedEvent","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"},"ChannelDeletedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003.004"},"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"003.005"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"team":{"type":"string","x-stream-index":"001.001"},"type":{"default":"channel.deleted","type":"string","x-stream-index":"002.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"ChannelDeletedEvent","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"},"ChannelFrozenEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"channel.frozen","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"ChannelFrozenEvent","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"},"ChannelGetOrCreateRequest":{"nullable":true,"properties":{"data":{"$ref":"#/components/schemas/ChannelInput","x-stream-index":"003"},"hide_for_creator":{"description":"Whether this channel will be hidden for the user who created the channel or not","title":"Hide for creator","type":"boolean","x-stream-index":"007"},"members":{"$ref":"#/components/schemas/PaginationParams","x-stream-index":"010"},"messages":{"$ref":"#/components/schemas/MessagePaginationParams","x-stream-index":"009"},"presence":{"description":"Fetch user presence info","title":"Presence","type":"boolean","x-stream-index":"006"},"state":{"description":"Refresh channel state","title":"State","type":"boolean","x-stream-index":"005"},"thread_unread_counts":{"type":"boolean","x-stream-index":"008"},"watch":{"description":"Start watching the channel","title":"Watch","type":"boolean","x-stream-index":"004"},"watchers":{"$ref":"#/components/schemas/PaginationParams","x-stream-index":"011"}},"type":"object"},"ChannelHiddenEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003.004"},"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"003.005"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"clear_history":{"type":"boolean","x-stream-index":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"type":{"default":"channel.hidden","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["clear_history","cid","channel_id","channel_type","channel_member_count","type","created_at"],"title":"ChannelHiddenEvent","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"},"ChannelInput":{"properties":{"auto_translation_enabled":{"description":"Enable or disable auto translation","title":"Auto translation","type":"boolean","x-stream-index":"005"},"auto_translation_language":{"description":"Switch auto translation language","title":"Auto translation language","type":"string","x-stream-index":"006"},"config_overrides":{"$ref":"#/components/schemas/ChannelConfig","x-stream-index":"024"},"created_by":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"009"},"created_by_id":{"type":"string","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"015"},"disabled":{"type":"boolean","x-stream-index":"014"},"frozen":{"description":"Freeze or unfreeze the channel","title":"Frozen","type":"boolean","x-stream-index":"013"},"invites":{"items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"type":"array","x-stream-index":"016"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"type":"array","x-stream-index":"018"},"team":{"description":"Team the channel belongs to (if multi-tenant mode is enabled)","title":"Team","type":"string","x-stream-index":"004"},"truncated_by_id":{"type":"string","x-stream-index":"010"}},"type":"object"},"ChannelKickedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002.004"},"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"002.005"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"channel.kicked","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"ChannelKickedEvent","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"},"ChannelMember":{"nullable":true,"properties":{"archived_at":{"format":"date-time","type":"number","x-stream-index":"015"},"ban_expires":{"description":"Expiration date of the ban","format":"date-time","title":"Ban expires","type":"number","x-stream-index":"013"},"banned":{"description":"Whether member is banned this channel or not","title":"Banned","type":"boolean","x-stream-index":"012"},"channel_role":{"description":"Role of the member in the channel","title":"Channel Role","type":"string","x-stream-index":"018"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"deleted_messages":{"items":{"type":"string"},"type":"array","x-stream-index":"020"},"invite_accepted_at":{"description":"Date when invite was accepted","format":"date-time","title":"Invited accepted at","type":"number","x-stream-index":"006"},"invite_rejected_at":{"description":"Date when invite was rejected","format":"date-time","title":"Invited rejected at","type":"number","x-stream-index":"007"},"invited":{"description":"Whether member was invited or not","title":"Invited","type":"boolean","x-stream-index":"005"},"is_moderator":{"description":"Whether member is channel moderator or not","title":"Is moderator","type":"boolean","x-stream-index":"003"},"notifications_muted":{"type":"boolean","x-stream-index":"019"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"016"},"role":{"description":"Permission level of the member in the channel (DEPRECATED: use channel_role instead)","enum":["member","moderator","admin","owner"],"title":"Role","type":"string","x-stream-index":"017"},"shadow_banned":{"description":"Whether member is shadow banned in this channel or not","title":"Shadow banned","type":"boolean","x-stream-index":"014"},"status":{"type":"string","x-stream-index":"008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"},"user_id":{"title":"User ID","type":"string","x-stream-index":"001"}},"required":["custom","created_at","updated_at","banned","shadow_banned","channel_role","notifications_muted"],"title":"Channel member","type":"object"},"ChannelMemberResponse":{"nullable":true,"properties":{"archived_at":{"format":"date-time","type":"number","x-stream-index":"016"},"ban_expires":{"description":"Expiration date of the ban","format":"date-time","title":"Ban expires","type":"number","x-stream-index":"013"},"banned":{"description":"Whether member is banned this channel or not","title":"Banned","type":"boolean","x-stream-index":"012"},"channel_role":{"description":"Role of the member in the channel","title":"Channel Role","type":"string","x-stream-index":"018"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"invite_accepted_at":{"description":"Date when invite was accepted","format":"date-time","title":"Invited accepted at","type":"number","x-stream-index":"006"},"invite_rejected_at":{"description":"Date when invite was rejected","format":"date-time","title":"Invited rejected at","type":"number","x-stream-index":"007"},"invited":{"description":"Whether member was invited or not","title":"Invited","type":"boolean","x-stream-index":"005"},"is_moderator":{"description":"Whether member is channel moderator or not","title":"Is moderator","type":"boolean","x-stream-index":"003"},"notifications_muted":{"type":"boolean","x-stream-index":"019"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"015"},"role":{"description":"Permission level of the member in the channel (DEPRECATED: use channel_role instead)","enum":["member","moderator","admin","owner"],"title":"Role","type":"string","x-stream-index":"017"},"shadow_banned":{"description":"Whether member is shadow banned in this channel or not","title":"Shadow banned","type":"boolean","x-stream-index":"014"},"status":{"type":"string","x-stream-index":"008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"},"user_id":{"title":"User ID","type":"string","x-stream-index":"001"}},"required":["custom","created_at","updated_at","banned","shadow_banned","channel_role","notifications_muted"],"title":"Channel member","type":"object"},"ChannelMute":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel that is muted","title":"Channel","x-stream-index":"002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"004"},"expires":{"description":"Date/time of mute expiration","format":"date-time","title":"Expires","type":"number","x-stream-index":"003"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Owner of channel mute","title":"User","x-stream-index":"001"}},"required":["created_at","updated_at"],"type":"object"},"ChannelOwnCapability":{"description":"All possibility of string to use","enum":["ban-channel-members","cast-poll-vote","connect-events","create-attachment","delete-any-message","delete-channel","delete-own-message","flag-message","freeze-channel","join-channel","leave-channel","mute-channel","pin-message","query-poll-votes","quote-message","read-events","search-messages","send-custom-events","send-links","send-message","send-poll","send-reaction","send-reply","send-restricted-visibility-message","send-typing-events","set-channel-cooldown","share-location","skip-slow-mode","slow-mode","typing-events","update-any-message","update-channel","update-channel-members","update-own-message","update-thread","upload-file"],"title":"ChannelOwnCapability","type":"string"},"ChannelPushPreferences":{"properties":{"chat_level":{"type":"string","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"number","x-stream-index":"002"}},"type":"object"},"ChannelResponse":{"description":"Represents channel in chat","properties":{"auto_translation_enabled":{"description":"Whether auto translation is enabled or not","title":"Auto translation","type":"boolean","x-stream-index":"017"},"auto_translation_language":{"description":"Language to translate to when auto translation is active","title":"Auto translation language","type":"string","x-stream-index":"018"},"blocked":{"description":"Whether this channel is blocked by current user or not","title":"Blocked","type":"boolean","x-stream-index":"023"},"cid":{"description":"Channel CID (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/ChannelConfigWithInfo","description":"Channel configuration","title":"ChannelConfigWithInfo","x-stream-index":"013"},"cooldown":{"description":"Cooldown period after sending each message","format":"int32","title":"Cooldown","type":"integer","x-stream-index":"020"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"005"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"Creator of the channel","title":"UserResponse","x-stream-index":"008"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"026"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"007"},"disabled":{"type":"boolean","x-stream-index":"010"},"frozen":{"description":"Whether channel is frozen or not","title":"Frozen","type":"boolean","x-stream-index":"009"},"hidden":{"description":"Whether this channel is hidden by current user or not","title":"Hidden","type":"boolean","x-stream-index":"022"},"hide_messages_before":{"description":"Date since when the message history is accessible","format":"date-time","title":"Hide messages before","type":"number","x-stream-index":"019"},"id":{"description":"Channel unique ID","title":"ID","type":"string","x-stream-index":"001"},"last_message_at":{"description":"Date of the last message sent","format":"date-time","title":"Last message at","type":"number","x-stream-index":"004"},"member_count":{"description":"Number of members in the channel","format":"int32","title":"Member count","type":"integer","x-stream-index":"012"},"members":{"description":"List of channel members (max 100)","items":{"$ref":"#/components/schemas/ChannelMember"},"title":"ChannelMembers","type":"array","x-stream-index":"011"},"message_count":{"description":"Number of messages in the channel","format":"int64","title":"Message count","type":"integer","x-stream-index":"027"},"mute_expires_at":{"description":"Date of mute expiration","format":"date-time","title":"Mute expires at","type":"number","x-stream-index":"015"},"muted":{"description":"Whether this channel is muted or not","title":"Muted","type":"boolean","x-stream-index":"014"},"own_capabilities":{"description":"List of channel capabilities of authenticated user","items":{"$ref":"#/components/schemas/ChannelOwnCapability"},"title":"ChannelOwnCapability","type":"array","x-stream-index":"021"},"team":{"description":"Team the channel belongs to (multi-tenant only)","title":"Team","type":"string","x-stream-index":"016"},"truncated_at":{"description":"Date of the latest truncation of the channel","format":"date-time","title":"UserResponse","type":"number","x-stream-index":"024"},"truncated_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"025"},"type":{"description":"Type of the channel","title":"Type","type":"string","x-stream-docs-page-id":"channel_features","x-stream-index":"002"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"006"}},"required":["id","type","cid","created_at","updated_at","frozen","disabled","custom"],"title":"Channel","type":"object"},"ChannelStateResponse":{"nullable":true,"properties":{"active_live_locations":{"items":{"$ref":"#/components/schemas/SharedLocationResponseData"},"type":"array","x-stream-index":"001.015"},"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001.001"},"deleted_messages":{"items":{"type":"string"},"type":"array","x-stream-index":"001.016"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001.014"},"duration":{"type":"string","x-stream-index":"002.001"},"hidden":{"type":"boolean","x-stream-index":"001.011"},"hide_messages_before":{"format":"date-time","type":"number","x-stream-index":"001.012"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"001.007"},"membership":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"001.008"},"messages":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","x-stream-index":"001.002"},"pending_messages":{"items":{"$ref":"#/components/schemas/PendingMessageResponse"},"type":"array","x-stream-index":"001.013"},"pinned_messages":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","x-stream-index":"001.003"},"push_preferences":{"$ref":"#/components/schemas/ChannelPushPreferences","x-stream-index":"001.009"},"read":{"items":{"$ref":"#/components/schemas/ReadStateResponse"},"type":"array","x-stream-index":"001.006"},"threads":{"items":{"$ref":"#/components/schemas/ThreadStateResponse"},"type":"array","x-stream-index":"001.010"},"watcher_count":{"format":"int32","type":"integer","x-stream-index":"001.004"},"watchers":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"001.005"}},"required":["messages","pinned_messages","members","threads","duration"],"type":"object"},"ChannelStateResponseFields":{"properties":{"active_live_locations":{"description":"Active live locations in the channel","items":{"$ref":"#/components/schemas/SharedLocationResponseData"},"title":"Active Live Locations","type":"array","x-stream-index":"015"},"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001"},"deleted_messages":{"items":{"type":"string"},"type":"array","x-stream-index":"016"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"014"},"hidden":{"description":"Whether this channel is hidden or not","title":"Hidden","type":"boolean","x-stream-index":"011"},"hide_messages_before":{"description":"Messages before this date are hidden from the user","format":"date-time","title":"Hide messages before","type":"number","x-stream-index":"012"},"members":{"description":"List of channel members","items":{"$ref":"#/components/schemas/ChannelMember"},"title":"Members","type":"array","x-stream-index":"007"},"membership":{"$ref":"#/components/schemas/ChannelMember","description":"Current user membership object","title":"Membership","x-stream-index":"008"},"messages":{"description":"List of channel messages","items":{"$ref":"#/components/schemas/MessageResponse"},"title":"Message","type":"array","x-stream-index":"002"},"pending_messages":{"description":"Pending messages that this user has sent","items":{"$ref":"#/components/schemas/PendingMessageResponse"},"title":"Pending messages","type":"array","x-stream-index":"013"},"pinned_messages":{"description":"List of pinned messages in the channel","items":{"$ref":"#/components/schemas/MessageResponse"},"title":"Pinned messages","type":"array","x-stream-docs-page-id":"pinned_messages","x-stream-index":"003"},"push_preferences":{"$ref":"#/components/schemas/ChannelPushPreferences","x-stream-index":"009"},"read":{"description":"List of read states","items":{"$ref":"#/components/schemas/ReadStateResponse"},"title":"Read","type":"array","x-stream-index":"006"},"threads":{"items":{"$ref":"#/components/schemas/ThreadStateResponse"},"type":"array","x-stream-index":"010"},"watcher_count":{"description":"Number of channel watchers","format":"int32","title":"Watcher count","type":"integer","x-stream-index":"004"},"watchers":{"description":"List of user who is watching the channel","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Watchers","type":"array","x-stream-index":"005"}},"required":["messages","pinned_messages","members","threads"],"type":"object"},"ChannelStopWatchingRequest":{"nullable":true,"type":"object"},"ChannelTruncatedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001.004"},"channel_id":{"type":"string","x-stream-index":"001.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"001.005"},"channel_type":{"type":"string","x-stream-index":"001.003"},"cid":{"type":"string","x-stream-index":"001.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"type":{"default":"channel.truncated","type":"string","x-stream-index":"002.001"}},"required":["cid","channel_id","channel_type","channel_member_count","type","created_at"],"title":"ChannelTruncatedEvent","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"},"ChannelUnFrozenEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"channel.unfrozen","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"ChannelUnFrozenEvent","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"},"ChannelUpdatedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"004.004"},"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"004.005"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"002.001"},"type":{"default":"channel.updated","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"ChannelUpdatedEvent","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"},"ChannelVisibleEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"001.002"},"channel_type":{"type":"string","x-stream-index":"001.003"},"cid":{"type":"string","x-stream-index":"001.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"type":{"default":"channel.visible","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"ChannelVisibleEvent","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"},"ChatActivityStatsResponse":{"properties":{"Messages":{"$ref":"#/components/schemas/MessageStatsResponse","x-stream-index":"001"}},"type":"object"},"ClosedCaptionEvent":{"description":"This event is sent when closed captions are being sent in a call, clients should use this to show the closed captions in the call screen","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"closed_caption":{"$ref":"#/components/schemas/CallClosedCaption","description":"The closed caption object","title":"CallClosedCaption","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.closed_caption","description":"The type of event: \"call.closed_caption\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","closed_caption"],"title":"ClosedCaptionEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CollectUserFeedbackRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"009"},"rating":{"format":"int32","maximum":5,"minimum":1,"type":"integer","x-stream-index":"007"},"reason":{"maxLength":1000,"type":"string","x-stream-index":"008"},"sdk":{"maxLength":50,"type":"string","x-stream-index":"005"},"sdk_version":{"maxLength":50,"type":"string","x-stream-index":"006"},"user_session_id":{"maxLength":50,"type":"string","x-stream-index":"004"}},"required":["sdk","sdk_version","rating"],"type":"object"},"CollectUserFeedbackResponse":{"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"},"Command":{"description":"Represents custom chat command","nullable":true,"properties":{"args":{"description":"Arguments help text, shown in commands auto-completion","title":"Arguments","type":"string","x-stream-index":"006"},"created_at":{"description":"Date/time of creation","format":"date-time","readOnly":true,"title":"Created at","type":"number","x-stream-index":"001"},"description":{"description":"Description, shown in commands auto-completion","title":"Description","type":"string","x-stream-index":"005"},"name":{"description":"Unique command name","title":"Name","type":"string","x-stream-index":"004"},"set":{"description":"Set name used for grouping commands","title":"Set","type":"string","x-stream-index":"007"},"updated_at":{"description":"Date/time of the last update","format":"date-time","readOnly":true,"title":"Updated at","type":"number","x-stream-index":"002"}},"required":["name","description","args","set"],"title":"Command","type":"object"},"CommentAddedEvent":{"description":"Emitted when a comment is added to an activity.","nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","x-stream-index":"002"},"comment":{"$ref":"#/components/schemas/CommentResponse","description":"The comment that was added","title":"Text","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"003.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.001.007"},"feed_visibility":{"type":"string","x-stream-index":"003.003"},"fid":{"type":"string","x-stream-index":"003.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.001.004"},"type":{"default":"feeds.comment.added","description":"The type of event: \"feeds.comment.added\" in this case","title":"Event Type","type":"string","x-stream-index":"003.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who added the comment","title":"User","x-stream-index":"004.001"}},"required":["comment","activity","type","created_at","custom","fid"],"title":"CommentAddedEvent","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"},"CommentDeletedEvent":{"description":"Emitted when a comment is deleted.","nullable":true,"properties":{"comment":{"$ref":"#/components/schemas/CommentResponse","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"type":"string","x-stream-index":"002.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.comment.deleted","description":"The type of event: \"feeds.comment.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who deleted the comment","title":"User","x-stream-index":"003.001"}},"required":["comment","type","created_at","custom","fid"],"title":"CommentDeletedEvent","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"},"CommentReactionAddedEvent":{"description":"Emitted when a reaction is added to a comment.","nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","x-stream-index":"003"},"comment":{"$ref":"#/components/schemas/CommentResponse","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"004.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004.001.007"},"feed_visibility":{"type":"string","x-stream-index":"004.003"},"fid":{"type":"string","x-stream-index":"004.002"},"reaction":{"$ref":"#/components/schemas/FeedsReactionResponse","description":"The reaction that was added","title":"Reaction","x-stream-index":"002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"004.001.004"},"type":{"default":"feeds.comment.reaction.added","description":"The type of event: \"feeds.comment.reaction.added\" in this case","title":"Event Type","type":"string","x-stream-index":"004.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who added the reaction","title":"User","x-stream-index":"005.001"}},"required":["comment","reaction","activity","type","created_at","custom","fid"],"title":"CommentReactionAddedEvent","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"},"CommentReactionDeletedEvent":{"description":"Emitted when a reaction is deleted from a comment.","nullable":true,"properties":{"comment":{"$ref":"#/components/schemas/CommentResponse","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"003.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.001.007"},"feed_visibility":{"type":"string","x-stream-index":"003.003"},"fid":{"type":"string","x-stream-index":"003.002"},"reaction":{"$ref":"#/components/schemas/FeedsReactionResponse","x-stream-index":"002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.001.004"},"type":{"default":"feeds.comment.reaction.deleted","description":"The type of reaction that was removed","title":"Type","type":"string","x-stream-index":"003.001.002"}},"required":["comment","reaction","type","created_at","custom","fid"],"title":"CommentReactionDeletedEvent","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"},"CommentReactionUpdatedEvent":{"description":"Emitted when a reaction is updated on a comment.","nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","x-stream-index":"003"},"comment":{"$ref":"#/components/schemas/CommentResponse","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"004.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004.001.007"},"feed_visibility":{"type":"string","x-stream-index":"004.003"},"fid":{"type":"string","x-stream-index":"004.002"},"reaction":{"$ref":"#/components/schemas/FeedsReactionResponse","description":"The reaction that was updated","title":"Reaction","x-stream-index":"002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"004.001.004"},"type":{"default":"feeds.comment.reaction.updated","description":"The type of event: \"feeds.comment.reaction.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"004.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who updated the reaction","title":"User","x-stream-index":"005.001"}},"required":["comment","reaction","activity","type","created_at","custom","fid"],"title":"CommentReactionUpdatedEvent","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"},"CommentResponse":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"011"},"confidence_score":{"description":"Confidence score of the comment","format":"float","title":"Confidence Score","type":"number","x-stream-index":"022"},"controversy_score":{"description":"Controversy score of the comment","format":"float","title":"Controversy Score","type":"number","x-stream-index":"023"},"created_at":{"description":"When the comment was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"014"},"custom":{"additionalProperties":{},"description":"Custom data for the comment","title":"Custom Data","type":"object","x-stream-index":"006"},"deleted_at":{"description":"When the comment was deleted","format":"date-time","title":"Deleted At","type":"number","x-stream-index":"016"},"downvote_count":{"description":"Number of downvotes for this comment","format":"int32","title":"Downvote Count","type":"integer","x-stream-index":"020"},"id":{"description":"Unique identifier for the comment","title":"ID","type":"string","x-stream-index":"001"},"latest_reactions":{"description":"Recent reactions to the comment","items":{"$ref":"#/components/schemas/FeedsReactionResponse"},"title":"Latest Reactions","type":"array","x-stream-index":"009"},"mentioned_users":{"description":"Users mentioned in the comment","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Mention Users","type":"array","x-stream-index":"012"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"017"},"object_id":{"description":"ID of the object this comment is associated with","title":"Object ID","type":"string","x-stream-index":"002"},"object_type":{"description":"Type of the object this comment is associated with","title":"Object Type","type":"string","x-stream-index":"003"},"own_reactions":{"description":"Current user's reactions to this activity","items":{"$ref":"#/components/schemas/FeedsReactionResponse"},"title":"Own Reactions","type":"array","x-stream-index":"024"},"parent_id":{"description":"ID of parent comment for nested replies","title":"Parent ID","type":"string","x-stream-index":"007"},"reaction_count":{"description":"Number of reactions to this comment","format":"int32","title":"Reaction Count","type":"integer","x-stream-index":"008"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"description":"Grouped reactions by type","title":"Reaction Groups","type":"object","x-stream-index":"010"},"reply_count":{"description":"Number of replies to this comment","format":"int32","title":"Reply Count","type":"integer","x-stream-index":"018"},"score":{"description":"Score of the comment based on reactions","format":"int32","title":"Score","type":"integer","x-stream-index":"021"},"status":{"description":"Status of the comment (e.g., active, deleted)","title":"Status","type":"string","x-stream-index":"013"},"text":{"description":"Text content of the comment","title":"Text","type":"string","x-stream-index":"005"},"updated_at":{"description":"When the comment was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"015"},"upvote_count":{"description":"Number of upvotes for this comment","format":"int32","title":"Upvote Count","type":"integer","x-stream-index":"019"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who created the comment","title":"User","x-stream-index":"004"}},"required":["id","object_id","object_type","user","reaction_count","mentioned_users","status","created_at","updated_at","reply_count","upvote_count","downvote_count","score","confidence_score","own_reactions"],"title":"Comment","type":"object"},"CommentUpdatedEvent":{"description":"Emitted when a comment is updated.","nullable":true,"properties":{"comment":{"$ref":"#/components/schemas/CommentResponse","description":"The comment that was updated","title":"Text","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"type":"string","x-stream-index":"002.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.comment.updated","description":"The type of event: \"feeds.comment.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who updated the comment","title":"User","x-stream-index":"003.001"}},"required":["comment","type","created_at","custom","fid"],"title":"CommentUpdatedEvent","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"},"CompositeAppSettings":{"properties":{"json_encoded_settings":{"type":"string","x-stream-index":"005"},"url":{"type":"string","x-stream-index":"004"}},"type":"object"},"ConfigOverrides":{"properties":{"blocklist":{"type":"string","x-stream-index":"008"},"blocklist_behavior":{"enum":["flag","block"],"type":"string","x-stream-index":"009"},"commands":{"items":{"type":"string"},"type":"array","x-stream-index":"011"},"count_messages":{"type":"boolean","x-stream-index":"014"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"010"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"007"},"quotes":{"type":"boolean","x-stream-index":"004"},"reactions":{"type":"boolean","x-stream-index":"002"},"replies":{"type":"boolean","x-stream-index":"003"},"shared_locations":{"type":"boolean","x-stream-index":"013"},"typing_events":{"type":"boolean","x-stream-index":"001"},"uploads":{"type":"boolean","x-stream-index":"005"},"url_enrichment":{"type":"boolean","x-stream-index":"006"},"user_message_reminders":{"type":"boolean","x-stream-index":"012"}},"required":["grants","commands"],"type":"object"},"ConfigResponse":{"properties":{"ai_image_config":{"$ref":"#/components/schemas/AIImageConfig","description":"Configuration for AI image analysis","title":"AI Image Config","x-stream-index":"010"},"ai_text_config":{"$ref":"#/components/schemas/AITextConfig","description":"Configuration for AI text analysis","title":"AI Text Config","x-stream-index":"008"},"ai_video_config":{"$ref":"#/components/schemas/AIVideoConfig","description":"Configuration for AI video analysis","title":"AI Video Config","x-stream-index":"011"},"async":{"description":"Whether moderation should be performed asynchronously","title":"Async","type":"boolean","x-stream-index":"003"},"automod_platform_circumvention_config":{"$ref":"#/components/schemas/AutomodPlatformCircumventionConfig","description":"Configuration for platform circumvention detection","title":"Automod Platform Circumvention Config","x-stream-index":"005"},"automod_semantic_filters_config":{"$ref":"#/components/schemas/AutomodSemanticFiltersConfig","description":"Configuration for semantic filtering","title":"Automod Semantic Filters Config","x-stream-index":"006"},"automod_toxicity_config":{"$ref":"#/components/schemas/AutomodToxicityConfig","description":"Configuration for toxicity detection","title":"Automod Toxicity Config","x-stream-index":"004"},"block_list_config":{"$ref":"#/components/schemas/BlockListConfig","description":"Configuration for block list filtering","title":"Block List Config","x-stream-index":"007"},"created_at":{"description":"When the configuration was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"013"},"key":{"description":"Unique identifier for the moderation configuration","title":"Key","type":"string","x-stream-index":"001"},"llm_config":{"$ref":"#/components/schemas/LLMConfig","description":"Configuration for customer-configured LLM moderation","title":"LLM Config","x-stream-index":"009"},"team":{"description":"Team associated with the configuration","title":"Team","type":"string","x-stream-index":"002"},"updated_at":{"description":"When the configuration was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"014"},"velocity_filter_config":{"$ref":"#/components/schemas/VelocityFilterConfig","description":"Configuration for velocity-based filtering","title":"Velocity Filter Config","x-stream-index":"012"},"video_call_rule_config":{"$ref":"#/components/schemas/VideoCallRuleConfig","x-stream-index":"015"}},"required":["key","team","async","created_at","updated_at"],"type":"object"},"ConnectUserDetailsRequest":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001"},"image":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"006"},"language":{"type":"string","x-stream-index":"005"},"name":{"type":"string","x-stream-index":"002"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"007"}},"required":["id"],"type":"object"},"ConnectedEvent":{"description":"This event is sent when the WS connection is established and authenticated, this event contains the full user object as it is stored on the server","properties":{"connection_id":{"description":"The connection_id for this client","title":"Connection ID","type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"me":{"$ref":"#/components/schemas/OwnUserResponse","description":"The full user object as it is stored on the server","title":"OwnUserResponse","x-stream-index":"003"},"type":{"default":"connection.ok","description":"The type of event: \"connection.ok\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","connection_id","me"],"title":"ConnectedEvent","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"},"ConnectionErrorEvent":{"description":"This event is sent when the WS connection fails","properties":{"connection_id":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"error":{"$ref":"#/components/schemas/APIError","description":"The error that caused the connection to fail","title":"Error","x-stream-index":"003"},"type":{"default":"connection.error","description":"The type of event: \"connection.ok\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","connection_id","error"],"title":"ConnectionErrorEvent","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"},"ContentCountRuleParameters":{"properties":{"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"type":"object"},"CountByMinuteResponse":{"nullable":true,"properties":{"count":{"format":"int32","type":"integer","x-stream-index":"002"},"start_ts":{"format":"date-time","type":"number","x-stream-index":"001"}},"required":["start_ts","count"],"type":"object"},"CreateBlockListRequest":{"description":"Block list contains restricted words","nullable":true,"properties":{"name":{"description":"Block list name","maxLength":255,"title":"Name","type":"string","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"004"},"type":{"description":"Block list type.","enum":["regex","domain","domain_allowlist","email","word"],"title":"Type","type":"string","x-stream-index":"003"},"words":{"description":"List of words to block","items":{"type":"string"},"minimum":1,"title":"Words","type":"array","x-stream-index":"002"}},"required":["name","words"],"title":"Block list","type":"object","x-stream-docs-page-id":"block_lists"},"CreateBlockListResponse":{"description":"Basic response information","nullable":true,"properties":{"blocklist":{"$ref":"#/components/schemas/BlockListResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["duration"],"title":"Response","type":"object"},"CreateDeviceRequest":{"description":"Create device request","nullable":true,"properties":{"id":{"description":"Device ID","maxLength":255,"minLength":1,"title":"ID","type":"string","x-stream-index":"001"},"push_provider":{"description":"Push provider","enum":["firebase","apn","huawei","xiaomi"],"title":"PushProvider","type":"string","x-stream-index":"002"},"push_provider_name":{"description":"Push provider name","title":"PushProviderName","type":"string","x-stream-index":"003"},"voip_token":{"description":"When true the token is for Apple VoIP push notifications","title":"VoipToken","type":"boolean","x-stream-index":"004"}},"required":["id","push_provider"],"title":"CreateDeviceRequest","type":"object"},"CreateDraftRequest":{"nullable":true,"properties":{"message":{"$ref":"#/components/schemas/MessageRequest","x-stream-index":"001"}},"required":["message"],"type":"object"},"CreateDraftResponse":{"description":"Basic response information","nullable":true,"properties":{"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["draft","duration"],"title":"Response","type":"object"},"CreateFeedsBatchRequest":{"nullable":true,"properties":{"feeds":{"description":"List of feeds to create","items":{"$ref":"#/components/schemas/FeedRequest"},"maximum":1000,"minimum":1,"title":"Feeds","type":"array","x-stream-index":"001"}},"required":["feeds"],"title":"Create Feeds Batch Request","type":"object"},"CreateFeedsBatchResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"feeds":{"description":"List of created feeds","items":{"$ref":"#/components/schemas/FeedResponse"},"title":"Feeds","type":"array","x-stream-index":"001"}},"required":["feeds","duration"],"title":"Create Feeds Batch Response","type":"object"},"CreateGuestRequest":{"nullable":true,"properties":{"user":{"$ref":"#/components/schemas/UserRequest","description":"User object which server acts upon","title":"User","x-stream-index":"001"}},"required":["user"],"type":"object"},"CreateGuestResponse":{"nullable":true,"properties":{"access_token":{"description":"the access token to authenticate the user","title":"Access token","type":"string","x-stream-index":"002"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User object which server acts upon","title":"User","x-stream-index":"001"}},"required":["user","access_token","duration"],"type":"object"},"CreatePollOptionRequest":{"nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"003"},"text":{"description":"Option text","title":"string","type":"string","x-stream-index":"002"}},"required":["text"],"type":"object"},"CreatePollRequest":{"description":"Contains all information needed to create a new poll","nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"011"},"allow_answers":{"description":"Indicates whether users can suggest user defined answers","title":"Allow answers","type":"boolean","x-stream-index":"009"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"008"},"description":{"description":"A description of the poll","title":"Description","type":"string","x-stream-index":"003"},"enforce_unique_vote":{"description":"Indicates whether users can cast multiple votes","title":"Multiple choice","type":"boolean","x-stream-index":"006"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"is_closed":{"description":"Indicates whether the poll is open for voting","title":"Is closed","type":"boolean","x-stream-index":"010"},"max_votes_allowed":{"description":"Indicates the maximum amount of votes a user can cast","format":"int32","maximum":10,"title":"Maximum votes allowed","type":"integer","x-stream-index":"007"},"name":{"description":"The name of the poll","title":"Name","type":"string","x-stream-index":"002"},"options":{"items":{"$ref":"#/components/schemas/PollOptionInput"},"maximum":100,"type":"array","x-stream-index":"004"},"voting_visibility":{"enum":["anonymous","public"],"type":"string","x-stream-index":"005"}},"required":["name"],"title":"Create Poll Request","type":"object"},"CreateReminderRequest":{"nullable":true,"properties":{"remind_at":{"format":"date-time","type":"number","x-stream-index":"001"}},"type":"object"},"Credentials":{"properties":{"ice_servers":{"items":{"$ref":"#/components/schemas/ICEServer"},"type":"array","x-stream-index":"003"},"server":{"$ref":"#/components/schemas/SFUResponse","x-stream-index":"001"},"token":{"type":"string","x-stream-index":"002"}},"required":["server","token","ice_servers"],"type":"object"},"CustomActionRequest":{"properties":{"id":{"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"type":"object"},"CustomVideoEvent":{"description":"A custom event, this event is used to send custom events to other participants in the call.","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"003"},"type":{"default":"custom","description":"The type of event, \"custom\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"004"}},"required":["type","created_at","call_cid","custom","user"],"title":"CustomVideoEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"DailyAggregateCallDurationReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/CallDurationReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateCallParticipantCountReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/CallParticipantCountReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateCallsPerDayReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/CallsPerDayReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateQualityScoreReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/QualityScoreReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateSDKUsageReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/SDKUsageReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateUserFeedbackReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/UserFeedbackReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"Data":{"properties":{"id":{"type":"string","x-stream-index":"001"}},"required":["id"],"type":"object"},"DecayFunctionConfig":{"properties":{"base":{"type":"string","x-stream-index":"001"},"decay":{"type":"string","x-stream-index":"005"},"direction":{"type":"string","x-stream-index":"006"},"offset":{"type":"string","x-stream-index":"004"},"origin":{"type":"string","x-stream-index":"002"},"scale":{"type":"string","x-stream-index":"003"}},"type":"object"},"DeleteActivitiesRequest":{"nullable":true,"properties":{"hard_delete":{"description":"Whether to permanently delete the activities","title":"Hard Delete","type":"boolean","x-stream-index":"002"},"ids":{"description":"List of activity IDs to delete","items":{"type":"string"},"minimum":1,"title":"Activity IDs","type":"array","x-stream-index":"001"}},"required":["ids"],"title":"Delete Activities Request","type":"object"},"DeleteActivitiesResponse":{"nullable":true,"properties":{"deleted_ids":{"description":"List of activity IDs that were successfully deleted","items":{"type":"string"},"title":"Deleted Activity IDs","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["deleted_ids","duration"],"title":"Delete Activities Response","type":"object"},"DeleteActivityReactionResponse":{"nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"reaction":{"$ref":"#/components/schemas/FeedsReactionResponse","x-stream-index":"002"}},"required":["activity","reaction","duration"],"title":"Delete Activity Reaction Response","type":"object"},"DeleteActivityRequest":{"properties":{"hard_delete":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"DeleteActivityResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"Delete Activity Response","type":"object"},"DeleteBookmarkFolderResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"Delete Bookmark Folder Response","type":"object"},"DeleteBookmarkResponse":{"nullable":true,"properties":{"bookmark":{"$ref":"#/components/schemas/BookmarkResponse","description":"The deleted bookmark","title":"Bookmark","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["bookmark","duration"],"title":"Delete Bookmark Response","type":"object"},"DeleteCallRequest":{"description":"DeleteCallRequest is the payload for deleting a call.","nullable":true,"properties":{"hard":{"description":"if true the call will be hard deleted along with all related data","title":"Hard","type":"boolean","x-stream-index":"001"}},"title":"DeleteCallRequest","type":"object"},"DeleteCallResponse":{"description":"DeleteCallResponse is the payload for deleting a call.","nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","title":"Call","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"task_id":{"title":"TaskID","type":"string","x-stream-index":"002"}},"required":["call","duration"],"title":"DeleteCallResponse","type":"object"},"DeleteChannelResponse":{"description":"Basic response information","nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"Response","type":"object"},"DeleteChannelsRequest":{"nullable":true,"properties":{"cids":{"description":"All channels that should be deleted","items":{"type":"string"},"maximum":100,"minimum":1,"title":"Channels CID","type":"array","x-stream-index":"001"},"hard_delete":{"description":"Specify if channels and all ressources should be hard deleted","title":"Hard delete","type":"boolean","x-stream-index":"002"}},"required":["cids"],"type":"object"},"DeleteChannelsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"result":{"additionalProperties":{"$ref":"#/components/schemas/DeleteChannelsResultResponse"},"description":"Map of channel IDs and their deletion results","title":"Result","type":"object","x-stream-index":"001"},"task_id":{"type":"string","x-stream-index":"002"}},"required":["duration"],"type":"object"},"DeleteChannelsResultResponse":{"nullable":true,"properties":{"error":{"type":"string","x-stream-index":"002"},"status":{"type":"string","x-stream-index":"001"}},"required":["status"],"type":"object"},"DeleteCommentReactionResponse":{"nullable":true,"properties":{"comment":{"$ref":"#/components/schemas/CommentResponse","description":"The comment after reaction removal","title":"Comment","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"reaction":{"$ref":"#/components/schemas/FeedsReactionResponse","description":"The removed reaction","title":"Reaction","x-stream-index":"002"}},"required":["comment","reaction","duration"],"title":"Delete Comment Reaction Response","type":"object"},"DeleteCommentResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"Delete Comment Response","type":"object"},"DeleteFeedResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"Delete Feed Response","type":"object"},"DeleteMessageRequest":{"properties":{"hard_delete":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"DeleteMessageResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001"}},"required":["message","duration"],"title":"Response","type":"object"},"DeleteModerationConfigResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"DeleteReactionRequest":{"properties":{"hard_delete":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"DeleteReactionResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001"},"reaction":{"$ref":"#/components/schemas/ReactionResponse","x-stream-index":"002"}},"required":["message","reaction","duration"],"title":"Response","type":"object"},"DeleteRecordingResponse":{"description":"Response for DeleteRecording","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"DeleteRecordingResponse","type":"object"},"DeleteReminderResponse":{"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"},"DeleteTranscriptionResponse":{"description":"DeleteTranscriptionResponse is the payload for deleting a transcription.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"DeleteTranscriptionResponse","type":"object"},"DeleteUserRequest":{"properties":{"delete_conversation_channels":{"type":"boolean","x-stream-index":"003"},"delete_feeds_content":{"type":"boolean","x-stream-index":"004"},"hard_delete":{"type":"boolean","x-stream-index":"001"},"mark_messages_deleted":{"type":"boolean","x-stream-index":"002"}},"type":"object"},"Device":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"disabled":{"type":"boolean","x-stream-index":"002.003"},"disabled_reason":{"type":"string","x-stream-index":"002.004"},"id":{"type":"string","x-stream-index":"002.001.004"},"push_provider":{"enum":["firebase","apn","huawei","xiaomi"],"type":"string","x-stream-index":"002.001.001"},"push_provider_name":{"type":"string","x-stream-index":"002.001.003"},"user_id":{"type":"string","x-stream-index":"004"},"voip":{"type":"boolean","x-stream-index":"002.001.005"}},"required":["push_provider","id","created_at","user_id"],"type":"object"},"DeviceResponse":{"description":"Response for Device","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"004"},"disabled":{"description":"Whether device is disabled or not","title":"Disabled","type":"boolean","x-stream-index":"005"},"disabled_reason":{"description":"Reason explaining why device had been disabled","title":"Reason","type":"string","x-stream-index":"006"},"id":{"description":"Device ID","title":"ID","type":"string","x-stream-index":"003"},"push_provider":{"description":"Push provider","title":"PushProvider","type":"string","x-stream-index":"001"},"push_provider_name":{"description":"Push provider name","title":"PushProviderName","type":"string","x-stream-index":"002"},"user_id":{"description":"User ID","title":"UserID","type":"string","x-stream-index":"008"},"voip":{"description":"When true the token is for Apple VoIP push notifications","title":"Voip","type":"boolean","x-stream-index":"007"}},"required":["push_provider","id","created_at","user_id"],"title":"DeviceResponse","type":"object"},"DraftDeletedEvent":{"description":"Emitted when a Draft is deleted.","nullable":true,"properties":{"cid":{"description":"The CID of the channel where the draft was created","title":"Channel CID","type":"string","x-stream-index":"001.001.002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.001.007"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001.003"},"parent_id":{"description":"The ID of the parent message","title":"Message ID","type":"string","x-stream-index":"001.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.001.004"},"type":{"default":"draft.deleted","description":"The type of event: \"draft.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.001.002"}},"required":["type","created_at","custom"],"title":"DraftDeletedEvent","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"},"DraftPayloadResponse":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"html":{"type":"string","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"001"},"mentioned_users":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"008"},"mml":{"type":"string","x-stream-index":"003"},"parent_id":{"type":"string","x-stream-index":"005"},"poll_id":{"type":"string","x-stream-index":"013"},"quoted_message_id":{"type":"string","x-stream-index":"009"},"show_in_channel":{"type":"boolean","x-stream-index":"006"},"silent":{"type":"boolean","x-stream-index":"012"},"text":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"011"}},"required":["id","text","custom"],"type":"object"},"DraftResponse":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003"},"channel_cid":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"message":{"$ref":"#/components/schemas/DraftPayloadResponse","x-stream-index":"001"},"parent_id":{"type":"string","x-stream-index":"004"},"parent_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"005"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"006"}},"required":["message","channel_cid","created_at"],"type":"object"},"DraftUpdatedEvent":{"description":"Emitted when a Draft is created or updated.","nullable":true,"properties":{"cid":{"description":"The CID of the channel where the draft was created/updated","title":"Channel CID","type":"string","x-stream-index":"001.001.002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.001.007"},"draft":{"$ref":"#/components/schemas/DraftResponse","description":"The draft object which was created/updated","title":"Draft","x-stream-index":"001.003"},"parent_id":{"description":"The ID of the parent message","title":"Parent ID","type":"string","x-stream-index":"001.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.001.004"},"type":{"default":"draft.updated","description":"The type of event: \"draft.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.001.002"}},"required":["type","created_at","custom"],"title":"DraftUpdatedEvent","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"},"EdgeResponse":{"properties":{"continent_code":{"type":"string","x-stream-index":"007.003"},"country_iso_code":{"type":"string","x-stream-index":"007.002"},"green":{"format":"int32","type":"integer","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"latency_test_url":{"type":"string","x-stream-index":"002"},"latitude":{"format":"float","type":"number","x-stream-index":"006.001"},"longitude":{"format":"float","type":"number","x-stream-index":"006.002"},"red":{"format":"int32","type":"integer","x-stream-index":"005"},"subdivision_iso_code":{"type":"string","x-stream-index":"007.001"},"yellow":{"format":"int32","type":"integer","x-stream-index":"004"}},"required":["id","latency_test_url","green","yellow","red","latitude","longitude","subdivision_iso_code","country_iso_code","continent_code"],"type":"object"},"EgressHLSResponse":{"properties":{"playlist_url":{"type":"string","x-stream-index":"001"},"status":{"type":"string","x-stream-index":"002"}},"required":["playlist_url","status"],"type":"object"},"EgressRTMPResponse":{"properties":{"name":{"type":"string","x-stream-index":"001"},"started_at":{"format":"date-time","type":"number","x-stream-index":"004"},"stream_key":{"type":"string","x-stream-index":"003"},"stream_url":{"type":"string","x-stream-index":"002"}},"required":["name","started_at"],"type":"object"},"EgressResponse":{"properties":{"broadcasting":{"type":"boolean","x-stream-index":"001"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordingResponse","x-stream-index":"004"},"hls":{"$ref":"#/components/schemas/EgressHLSResponse","x-stream-index":"002"},"rtmps":{"items":{"$ref":"#/components/schemas/EgressRTMPResponse"},"type":"array","x-stream-index":"003"}},"required":["broadcasting","rtmps"],"type":"object"},"EgressTaskConfig":{"properties":{"egress_user":{"$ref":"#/components/schemas/EgressUser","x-stream-index":"008"},"frame_recording_egress_config":{"$ref":"#/components/schemas/FrameRecordingEgressConfig","x-stream-index":"009"},"hls_egress_config":{"$ref":"#/components/schemas/HLSEgressConfig","x-stream-index":"007"},"recording_egress_config":{"$ref":"#/components/schemas/RecordingEgressConfig","x-stream-index":"006"},"rtmp_egress_config":{"$ref":"#/components/schemas/RTMPEgressConfig","x-stream-index":"004"},"stt_egress_config":{"$ref":"#/components/schemas/STTEgressConfig","x-stream-index":"005"}},"type":"object"},"EgressUser":{"properties":{"token":{"type":"string","x-stream-index":"004"}},"type":"object"},"EndCallRequest":{"description":"Request for ending a call","nullable":true,"title":"EndCallRequest","type":"object"},"EndCallResponse":{"description":"Response for ending a call","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"EndCallResponse","type":"object"},"EnrichedActivity":{"properties":{"actor":{"$ref":"#/components/schemas/Data","x-stream-index":"002"},"foreign_id":{"type":"string","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"latest_reactions":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"013"},"object":{"$ref":"#/components/schemas/Data","x-stream-index":"004"},"origin":{"$ref":"#/components/schemas/Data","x-stream-index":"008"},"own_reactions":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"012"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"011"},"score":{"format":"float","type":"number","x-stream-index":"010"},"target":{"$ref":"#/components/schemas/Data","x-stream-index":"006"},"to":{"items":{"type":"string"},"type":"array","x-stream-index":"009"},"verb":{"type":"string","x-stream-index":"003"}},"type":"object"},"EnrichedReaction":{"nullable":true,"properties":{"activity_id":{"type":"string","x-stream-index":"003"},"children_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"010"},"created_at":{"$ref":"#/components/schemas/Time","x-stream-index":"012"},"data":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"kind":{"type":"string","x-stream-index":"002"},"latest_children":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"008"},"own_children":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"009"},"parent":{"type":"string","x-stream-index":"007"},"target_feeds":{"items":{"type":"string"},"type":"array","x-stream-index":"006"},"updated_at":{"$ref":"#/components/schemas/Time","x-stream-index":"013"},"user":{"$ref":"#/components/schemas/Data","x-stream-index":"011"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["kind","activity_id","user_id"],"type":"object"},"EntityCreator":{"properties":{"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"001.046"},"ban_count":{"format":"int32","type":"integer","x-stream-index":"002"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"001.017"},"banned":{"type":"boolean","x-stream-index":"001.016"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.013"},"deleted_content_count":{"format":"int32","type":"integer","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"001.023"},"language":{"type":"string","x-stream-index":"001.035"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"001.022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"001.026"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.042"},"role":{"type":"string","x-stream-index":"001.004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.005"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.009"}},"required":["id","role","teams_role","custom","banned","online","ban_count","deleted_content_count"],"type":"object"},"EntityCreatorResponse":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.001.018"},"ban_count":{"description":"Number of minor actions performed on the user","format":"int32","title":"Ban Count","type":"integer","x-stream-index":"002"},"banned":{"type":"boolean","x-stream-index":"001.001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.001.017"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.001.016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.001.011"},"deleted_content_count":{"description":"Number of major actions performed on the user","format":"int32","title":"Deleted Content Count","type":"integer","x-stream-index":"003"},"flagged_count":{"description":"Number of flag actions performed on the user","format":"int32","title":"Flagged Count","type":"integer","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001.001.001"},"image":{"type":"string","x-stream-index":"001.001.003"},"language":{"type":"string","x-stream-index":"001.001.005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"001.001.014"},"name":{"type":"string","x-stream-index":"001.001.002"},"online":{"type":"boolean","x-stream-index":"001.001.013"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.001.015"},"role":{"type":"string","x-stream-index":"001.001.006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.001.008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids","shadow_banned","invisible","ban_count","deleted_content_count","flagged_count"],"type":"object"},"EventNotificationSettings":{"properties":{"apns":{"$ref":"#/components/schemas/APNS","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"fcm":{"$ref":"#/components/schemas/FCM","x-stream-index":"003"}},"required":["enabled","apns","fcm"],"type":"object"},"EventRequest":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"parent_id":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"001"}},"required":["type"],"type":"object"},"EventResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"event":{"$ref":"#/components/schemas/WSEvent","x-stream-index":"001"}},"required":["event","duration"],"title":"Response","type":"object"},"ExternalStorage":{"properties":{"abs_account_name":{"type":"string","x-stream-index":"011"},"abs_client_id":{"type":"string","x-stream-index":"013"},"abs_client_secret":{"type":"string","x-stream-index":"014"},"abs_tenant_id":{"type":"string","x-stream-index":"012"},"bucket":{"type":"string","x-stream-index":"005"},"gcs_credentials":{"type":"string","x-stream-index":"010"},"path":{"type":"string","x-stream-index":"006"},"s3_api_key":{"type":"string","x-stream-index":"007"},"s3_custom_endpoint":{"type":"string","x-stream-index":"016"},"s3_region":{"type":"string","x-stream-index":"009"},"s3_secret_key":{"type":"string","x-stream-index":"008"},"storage_name":{"type":"string","x-stream-index":"015"},"storage_type":{"type":"integer","x-stream-index":"004"}},"type":"object"},"FCM":{"properties":{"data":{"additionalProperties":{},"type":"object","x-stream-index":"001"}},"type":"object"},"FeedCreatedEvent":{"description":"Emitted when a feed is created.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"003.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.001.007"},"feed":{"$ref":"#/components/schemas/FeedResponse","description":"The feed that was created","title":"Feed","x-stream-index":"001"},"feed_visibility":{"type":"string","x-stream-index":"003.003"},"fid":{"type":"string","x-stream-index":"003.002"},"members":{"items":{"$ref":"#/components/schemas/FeedMemberResponse"},"type":"array","x-stream-index":"002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.001.004"},"type":{"default":"feeds.feed.created","description":"The type of event: \"feeds.feed.created\" in this case","title":"Event Type","type":"string","x-stream-index":"003.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who created the feed","title":"User","x-stream-index":"004.001"}},"required":["feed","members","type","created_at","custom","fid","user"],"title":"FeedCreatedEvent","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"},"FeedDeletedEvent":{"description":"Emitted when a feed is deleted.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.007"},"feed_visibility":{"type":"string","x-stream-index":"001.003"},"fid":{"type":"string","x-stream-index":"001.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"type":{"default":"feeds.feed.deleted","description":"The type of event: \"feeds.feed.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who deleted the feed","title":"User","x-stream-index":"002.001"}},"required":["type","created_at","custom","fid"],"title":"FeedDeletedEvent","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"},"FeedGroup":{"properties":{"ActivityProcessors":{"items":{"$ref":"#/components/schemas/ActivityProcessorConfig"},"type":"array","writeOnly":true,"x-stream-index":"012"},"ActivitySelectors":{"items":{"$ref":"#/components/schemas/ActivitySelectorConfig"},"type":"array","writeOnly":true,"x-stream-index":"013"},"Aggregation":{"$ref":"#/components/schemas/AggregationConfig","x-stream-index":"015"},"AggregationVersion":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"016"},"AppPK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"002"},"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"007"},"DefaultVisibility":{"type":"string","writeOnly":true,"x-stream-index":"006"},"DeletedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"010"},"ID":{"type":"string","writeOnly":true,"x-stream-index":"003"},"LastFeedGetAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"017"},"Notification":{"$ref":"#/components/schemas/NotificationConfig","x-stream-index":"004"},"PushNotification":{"$ref":"#/components/schemas/PushNotificationConfig","x-stream-index":"005"},"Ranking":{"$ref":"#/components/schemas/RankingConfig","x-stream-index":"014"},"Stories":{"$ref":"#/components/schemas/StoriesConfig","x-stream-index":"011"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"}},"required":["AppPK","ID","DefaultVisibility","Custom","created_at","updated_at","ActivityProcessors","ActivitySelectors","AggregationVersion"],"type":"object"},"FeedGroupChangedEvent":{"description":"Emitted when a feed group is changed.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.007"},"feed_group":{"$ref":"#/components/schemas/FeedGroup","description":"The feed group that was changed","title":"Feed Type","x-stream-index":"003"},"feed_visibility":{"type":"string","x-stream-index":"001.003"},"fid":{"type":"string","x-stream-index":"001.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"type":{"default":"feeds.feed_group.changed","description":"The type of event: \"feeds.feed_group.changed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who changed the feed group","title":"User","x-stream-index":"002.001"}},"required":["type","created_at","custom","fid"],"title":"FeedGroupChangedEvent","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"},"FeedGroupDeletedEvent":{"description":"Emitted when a feed group is deleted.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"type":"string","x-stream-index":"002.002"},"group_id":{"description":"The ID of the feed group that was deleted","title":"Group ID","type":"string","x-stream-index":"001"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.feed_group.deleted","description":"The type of event: \"feeds.feed_group.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"}},"required":["group_id","type","created_at","custom","fid"],"title":"FeedGroupDeletedEvent","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"},"FeedInput":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"description":{"maxLength":1000,"type":"string","x-stream-index":"002"},"filter_tags":{"items":{"type":"string"},"maximum":255,"type":"array","x-stream-index":"005"},"members":{"items":{"$ref":"#/components/schemas/FeedMemberRequest"},"type":"array","x-stream-index":"006"},"name":{"maxLength":255,"type":"string","x-stream-index":"001"},"visibility":{"enum":["public","visible","followers","members","private"],"type":"string","x-stream-index":"003"}},"type":"object"},"FeedMemberAddedEvent":{"description":"Emitted when a feed member is added.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"003.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.001.007"},"feed_visibility":{"type":"string","x-stream-index":"003.003"},"fid":{"type":"string","x-stream-index":"003.002"},"member":{"$ref":"#/components/schemas/FeedMemberResponse","description":"The member that was added","title":"Member","x-stream-index":"001"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.001.004"},"type":{"default":"feeds.feed_member.added","description":"The type of event: \"feeds.feed_member.added\" in this case","title":"Event Type","type":"string","x-stream-index":"003.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who added the member","title":"User","x-stream-index":"002.001"}},"required":["member","type","created_at","custom","fid"],"title":"FeedMemberAddedEvent","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"},"FeedMemberRemovedEvent":{"description":"Emitted when a feed member is removed.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"003.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.001.007"},"feed_visibility":{"type":"string","x-stream-index":"003.003"},"fid":{"type":"string","x-stream-index":"003.002"},"member_id":{"type":"string","x-stream-index":"001"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.001.004"},"type":{"default":"feeds.feed_member.removed","description":"The type of event: \"feeds.feed_member.removed\" in this case","title":"Event Type","type":"string","x-stream-index":"003.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who removed the member","title":"User","x-stream-index":"002.001"}},"required":["member_id","type","created_at","custom","fid"],"title":"FeedMemberRemovedEvent","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"},"FeedMemberRequest":{"properties":{"custom":{"additionalProperties":{},"description":"Custom data for the member","title":"Custom Data","type":"object","x-stream-index":"004"},"invite":{"description":"Whether this is an invite to become a member","title":"Invite","type":"boolean","x-stream-index":"005"},"membership_level":{"description":"ID of the membership level to assign to the member","maxLength":255,"title":"Membership Level","type":"string","x-stream-index":"003"},"role":{"description":"Role of the member in the feed","maxLength":255,"title":"Role","type":"string","x-stream-index":"002"},"user_id":{"description":"ID of the user to add as a member","maxLength":255,"title":"User ID","type":"string","x-stream-index":"001"}},"required":["user_id"],"title":"Feed Member Payload","type":"object"},"FeedMemberResponse":{"properties":{"created_at":{"description":"When the membership was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"description":"Custom data for the membership","title":"Custom Data","type":"object","x-stream-index":"007"},"invite_accepted_at":{"description":"When the invite was accepted","format":"date-time","title":"Invite Accepted At","type":"number","x-stream-index":"005"},"invite_rejected_at":{"description":"When the invite was rejected","format":"date-time","title":"Invite Rejected At","type":"number","x-stream-index":"006"},"membership_level":{"$ref":"#/components/schemas/MembershipLevelResponse","description":"Membership level assigned to the member","title":"Membership Level","x-stream-index":"004"},"role":{"description":"Role of the member in the feed","title":"Role","type":"string","x-stream-index":"002"},"status":{"description":"Status of the membership","enum":["member","pending","rejected"],"title":"Status","type":"string","x-stream-index":"003"},"updated_at":{"description":"When the membership was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who is a member","title":"User","x-stream-index":"001"}},"required":["user","role","status","created_at","updated_at"],"title":"Feed Member","type":"object"},"FeedMemberUpdatedEvent":{"description":"Emitted when a feed member is updated.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"003.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.001.007"},"feed_visibility":{"type":"string","x-stream-index":"003.003"},"fid":{"type":"string","x-stream-index":"003.002"},"member":{"$ref":"#/components/schemas/FeedMemberResponse","description":"The member that was updated","title":"Member","x-stream-index":"001"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.001.004"},"type":{"default":"feeds.feed_member.updated","description":"The type of event: \"feeds.feed_member.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"003.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who updated the member","title":"User","x-stream-index":"002.001"}},"required":["member","type","created_at","custom","fid"],"title":"FeedMemberUpdatedEvent","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"},"FeedOwnCapability":{"description":"All possibility of string to use","enum":["add-activity","add-activity-reaction","add-comment","add-comment-reaction","bookmark-activity","create-feed","delete-bookmark","delete-comment","delete-feed","edit-bookmark","follow","invite-feed","join-feed","leave-feed","manage-feed-group","mark-activity","pin-activity","query-feed-members","query-follows","read-activities","read-feed","remove-activity","remove-activity-reaction","remove-comment-reaction","unfollow","update-activity","update-comment","update-feed","update-feed-followers","update-feed-members"],"title":"FeedOwnCapability","type":"string"},"FeedRequest":{"properties":{"created_by_id":{"description":"ID of the feed creator","title":"Created By ID","type":"string","x-stream-index":"003"},"custom":{"additionalProperties":{},"description":"Custom data for the feed","title":"Custom Data","type":"object","x-stream-index":"004.004"},"description":{"description":"Description of the feed","maxLength":1000,"title":"Description","type":"string","x-stream-index":"004.002"},"feed_group_id":{"description":"ID of the feed group","maxLength":255,"title":"Feed Group ID","type":"string","x-stream-index":"001"},"feed_id":{"description":"ID of the feed","maxLength":255,"title":"Feed ID","type":"string","x-stream-index":"002"},"filter_tags":{"description":"Tags used for filtering feeds","items":{"type":"string"},"maximum":255,"title":"Filter Tags","type":"array","x-stream-index":"004.005"},"members":{"description":"Initial members for the feed","items":{"$ref":"#/components/schemas/FeedMemberRequest"},"title":"Members","type":"array","x-stream-index":"004.006"},"name":{"description":"Name of the feed","maxLength":255,"title":"Name","type":"string","x-stream-index":"004.001"},"visibility":{"description":"Visibility setting for the feed","enum":["public","visible","followers","members","private"],"title":"Visibility","type":"string","x-stream-index":"004.003"}},"required":["feed_group_id","feed_id"],"title":"Feed Payload","type":"object"},"FeedResponse":{"properties":{"created_at":{"description":"When the feed was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"015"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"User who created the feed","title":"Created By","x-stream-index":"009"},"custom":{"additionalProperties":{},"description":"Custom data for the feed","title":"Custom Data","type":"object","x-stream-index":"006"},"deleted_at":{"description":"When the feed was deleted","format":"date-time","title":"Deleted At","type":"number","x-stream-index":"017"},"description":{"description":"Description of the feed","title":"Description","type":"string","x-stream-index":"005"},"feed":{"description":"Fully qualified feed ID (group_id:id)","title":"FID","type":"string","x-stream-index":"003"},"filter_tags":{"description":"Tags used for filtering feeds","items":{"type":"string"},"title":"Filter Tags","type":"array","x-stream-index":"007"},"follower_count":{"description":"Number of followers of this feed","format":"int32","title":"Follower Count","type":"integer","x-stream-index":"011"},"following_count":{"description":"Number of feeds this feed follows","format":"int32","title":"Following Count","type":"integer","x-stream-index":"012"},"group_id":{"description":"Group this feed belongs to","title":"Group ID","type":"string","x-stream-index":"001"},"id":{"description":"Unique identifier for the feed","title":"ID","type":"string","x-stream-index":"002"},"member_count":{"description":"Number of members in this feed","format":"int32","title":"Member Count","type":"integer","x-stream-index":"010"},"name":{"description":"Name of the feed","title":"Name","type":"string","x-stream-index":"004"},"own_follows":{"description":"Follow relationships where the current user's feeds are following this feed","items":{"$ref":"#/components/schemas/FollowResponse"},"title":"Own Follows","type":"array","x-stream-index":"014"},"pin_count":{"description":"Number of pinned activities in this feed","format":"int32","title":"Pin Count","type":"integer","x-stream-index":"013"},"updated_at":{"description":"When the feed was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"016"},"visibility":{"description":"Visibility setting for the feed","title":"Visibility","type":"string","x-stream-index":"008"}},"required":["group_id","id","feed","name","description","created_by","member_count","follower_count","following_count","pin_count","created_at","updated_at"],"title":"Feed","type":"object"},"FeedUpdatedEvent":{"description":"Emitted when a feed is created.","nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed":{"$ref":"#/components/schemas/FeedResponse","description":"The feed that was created","title":"Feed","x-stream-index":"001"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"type":"string","x-stream-index":"002.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.feed.updated","description":"The type of event: \"feeds.feed.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who created the feed","title":"User","x-stream-index":"003.001"}},"required":["feed","type","created_at","custom","fid"],"title":"FeedUpdatedEvent","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"},"FeedsEventPreferences":{"properties":{"comments":{"type":"string","x-stream-index":"002"},"mentions":{"type":"string","x-stream-index":"004"},"new_followers":{"type":"string","x-stream-index":"003"},"reactions":{"type":"string","x-stream-index":"001"}},"type":"object"},"FeedsEventPreferencesInput":{"properties":{"comments":{"enum":["all","none"],"type":"string","x-stream-index":"002"},"mentions":{"enum":["all","none"],"type":"string","x-stream-index":"004"},"new_followers":{"enum":["all","none"],"type":"string","x-stream-index":"003"},"reactions":{"enum":["all","none"],"type":"string","x-stream-index":"001"}},"type":"object"},"FeedsReactionResponse":{"properties":{"activity_id":{"description":"ID of the activity that was reacted to","title":"Activity ID","type":"string","x-stream-index":"002"},"comment_id":{"description":"ID of the comment that was reacted to","title":"Comment ID","type":"string","x-stream-index":"003"},"created_at":{"description":"When the reaction was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"006"},"custom":{"additionalProperties":{},"description":"Custom data for the reaction","title":"Custom Data","type":"object","x-stream-index":"005"},"type":{"description":"Type of reaction","title":"Type","type":"string","x-stream-index":"004"},"updated_at":{"description":"When the reaction was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"007"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who created the reaction","title":"User","x-stream-index":"001"}},"required":["user","activity_id","type","created_at","updated_at"],"title":"Activity Reaction","type":"object"},"Field":{"nullable":true,"properties":{"short":{"type":"boolean","x-stream-index":"003"},"title":{"type":"string","x-stream-index":"001"},"value":{"type":"string","x-stream-index":"002"}},"required":["title","value","short"],"type":"object"},"FileUploadConfig":{"properties":{"allowed_file_extensions":{"items":{"type":"string"},"type":"array","x-stream-index":"001"},"allowed_mime_types":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"blocked_file_extensions":{"items":{"type":"string"},"type":"array","x-stream-index":"002"},"blocked_mime_types":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"size_limit":{"format":"int32","maximum":104857600,"minimum":0,"type":"integer","x-stream-index":"005"}},"required":["allowed_file_extensions","blocked_file_extensions","allowed_mime_types","blocked_mime_types","size_limit"],"type":"object"},"FileUploadRequest":{"nullable":true,"properties":{"file":{"description":"file field","title":"File","type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/OnlyUserID","description":"user for the request **server side only**","title":"User","x-stream-index":"002"}},"type":"object"},"FileUploadResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"file":{"description":"URL to the uploaded asset. Should be used to put to `asset_url` attachment field","title":"File","type":"string","x-stream-index":"001"},"thumb_url":{"description":"URL of the file thumbnail for supported file formats. Should be put to `thumb_url` attachment field","title":"Thumbnail URL","type":"string","x-stream-index":"002"}},"required":["duration"],"type":"object"},"Flag":{"description":"Contains information about flagged user or message","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"019"},"custom":{"additionalProperties":{},"description":"Additional metadata about the flag","title":"Custom","type":"object","x-stream-index":"014"},"entity_creator_id":{"description":"ID of the user who created the flagged entity","title":"Entity Creator ID","type":"string","x-stream-index":"009"},"entity_id":{"description":"Unique identifier of the entity being flagged","title":"Entity ID","type":"string","x-stream-index":"008"},"entity_type":{"description":"Type of entity being flagged (e.g., message, user)","title":"Entity Type","type":"string","x-stream-index":"007"},"is_streamed_content":{"type":"boolean","x-stream-index":"012"},"labels":{"description":"Labels from bodyguard, API calls, our own AI etc","items":{"type":"string"},"title":"Labels","type":"array","x-stream-index":"015"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content being flagged","title":"Moderation Payload","x-stream-index":"010"},"moderation_payload_hash":{"type":"string","x-stream-index":"011"},"reason":{"description":"Optional explanation for why the content is being flagged","title":"Reason","type":"string","x-stream-index":"013"},"result":{"description":"Result of bodyguard, API calls, our own AI etc","items":{"additionalProperties":{},"type":"object"},"title":"Result","type":"array","x-stream-index":"016"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"018"},"review_queue_item_id":{"description":"ID of the review queue item","title":"Review Queue Item ID","type":"string","x-stream-index":"017"},"type":{"type":"string","x-stream-index":"004"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"020"},"user":{"$ref":"#/components/schemas/User","description":"User who flagged a message or a user","title":"User","x-stream-index":"006"}},"required":["entity_type","entity_id","result","created_at","updated_at"],"title":"Flag","type":"object"},"FlagContentOptions":{"properties":{"reason":{"type":"string","x-stream-index":"001"}},"type":"object"},"FlagDetails":{"properties":{"Extra":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"002"},"automod":{"$ref":"#/components/schemas/AutomodDetails","x-stream-index":"001"},"original_text":{"type":"string","x-stream-index":"003"}},"required":["Extra","original_text"],"type":"object"},"FlagFeedback":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"005"},"labels":{"items":{"$ref":"#/components/schemas/Label"},"type":"array","x-stream-index":"006"},"message_id":{"type":"string","x-stream-index":"004"}},"required":["message_id","created_at","labels"],"type":"object"},"FlagMessageDetails":{"properties":{"pin_changed":{"type":"boolean","x-stream-index":"002"},"should_enrich":{"type":"boolean","x-stream-index":"003"},"skip_push":{"type":"boolean","x-stream-index":"004"},"updated_by_id":{"type":"string","x-stream-index":"001"}},"type":"object"},"FlagRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"description":"Additional metadata about the flag","title":"Custom","type":"object","x-stream-index":"006"},"entity_creator_id":{"description":"ID of the user who created the flagged entity","title":"Entity Creator ID","type":"string","x-stream-index":"003"},"entity_id":{"description":"Unique identifier of the entity being flagged","title":"Entity ID","type":"string","x-stream-index":"002"},"entity_type":{"description":"Type of entity being flagged (e.g., message, user)","title":"Entity Type","type":"string","x-stream-index":"001"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content being flagged","title":"Moderation Payload","x-stream-index":"005"},"reason":{"description":"Optional explanation for why the content is being flagged","maxLength":255,"title":"Reason","type":"string","x-stream-index":"004"}},"required":["entity_type","entity_id"],"type":"object"},"FlagResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"item_id":{"description":"Unique identifier of the created moderation item","title":"Item ID","type":"string","x-stream-index":"001"}},"required":["item_id","duration"],"type":"object"},"FlagUserOptions":{"properties":{"reason":{"type":"string","x-stream-index":"001"}},"type":"object"},"FollowBatchRequest":{"nullable":true,"properties":{"follows":{"description":"List of follow relationships to create","items":{"$ref":"#/components/schemas/FollowRequest"},"maximum":1000,"minimum":1,"title":"Follows","type":"array","x-stream-index":"001"}},"required":["follows"],"title":"Follow Batch Request","type":"object"},"FollowBatchResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"follows":{"description":"List of created follow relationships","items":{"$ref":"#/components/schemas/FollowResponse"},"title":"Follows","type":"array","x-stream-index":"001"}},"required":["follows","duration"],"title":"Follow Batch Response","type":"object"},"FollowCreatedEvent":{"description":"Emitted when a feed follows another feed.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"type":"string","x-stream-index":"002.002"},"follow":{"$ref":"#/components/schemas/FollowResponse","x-stream-index":"001"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.follow.created","description":"The type of event: \"feeds.follow.created\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"}},"required":["follow","type","created_at","custom","fid"],"title":"FollowCreatedEvent","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"},"FollowDeletedEvent":{"description":"Emitted when a feed unfollows another feed.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"type":"string","x-stream-index":"002.002"},"follow":{"$ref":"#/components/schemas/FollowResponse","x-stream-index":"001"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.follow.deleted","description":"The type of event: \"feeds.follow.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"}},"required":["follow","type","created_at","custom","fid"],"title":"FollowDeletedEvent","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"},"FollowRequest":{"nullable":true,"properties":{"create_notification_activity":{"description":"Whether to create a notification activity for this follow","title":"Create Notification Activity","type":"boolean","x-stream-index":"004"},"custom":{"additionalProperties":{},"description":"Custom data for the follow relationship","title":"Custom Data","type":"object","x-stream-index":"002"},"push_preference":{"description":"Push preference for the follow relationship","enum":["all","none"],"title":"Push Preference","type":"string","x-stream-index":"003"},"skip_push":{"type":"boolean","x-stream-index":"005"},"source":{"description":"Fully qualified ID of the source feed","maxLength":255,"title":"Source Feed","type":"string","x-stream-index":"001.001"},"target":{"description":"Fully qualified ID of the target feed","maxLength":255,"title":"Target Feed","type":"string","x-stream-index":"001.002"}},"required":["source","target"],"title":"Follow Request","type":"object"},"FollowResponse":{"properties":{"created_at":{"description":"When the follow relationship was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"009"},"custom":{"additionalProperties":{},"description":"Custom data for the follow relationship","title":"Custom Data","type":"object","x-stream-index":"004"},"follower_role":{"description":"Role of the follower (source user) in the follow relationship","title":"Follower Role","type":"string","x-stream-index":"008"},"push_preference":{"description":"Push preference for notifications","enum":["all","none"],"title":"Push Preference","type":"string","x-stream-index":"003"},"request_accepted_at":{"description":"When the follow request was accepted","format":"date-time","title":"Request Accepted At","type":"number","x-stream-index":"005"},"request_rejected_at":{"description":"When the follow request was rejected","format":"date-time","title":"Request Rejected At","type":"number","x-stream-index":"006"},"source_feed":{"$ref":"#/components/schemas/FeedResponse","description":"Source feed object","title":"Source Feed","x-stream-index":"001"},"status":{"description":"Status of the follow relationship","enum":["accepted","pending","rejected"],"title":"Status","type":"string","x-stream-index":"007"},"target_feed":{"$ref":"#/components/schemas/FeedResponse","description":"Target feed object","title":"Target Feed","x-stream-index":"002"},"updated_at":{"description":"When the follow relationship was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"010"}},"required":["source_feed","target_feed","push_preference","status","follower_role","created_at","updated_at"],"title":"Follow","type":"object"},"FollowUpdatedEvent":{"description":"Emitted when a follow relationship is updated.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"type":"string","x-stream-index":"002.002"},"follow":{"$ref":"#/components/schemas/FollowResponse","x-stream-index":"001"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.follow.updated","description":"The type of event: \"feeds.follow.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"}},"required":["follow","type","created_at","custom","fid"],"title":"FollowUpdatedEvent","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"},"FrameRecordSettings":{"properties":{"capture_interval_in_seconds":{"format":"int32","maximum":60,"minimum":2,"type":"integer","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"},"quality":{"type":"string","x-stream-index":"002"}},"required":["mode","capture_interval_in_seconds"],"type":"object"},"FrameRecordingEgressConfig":{"properties":{"capture_interval_in_seconds":{"format":"int32","type":"integer","x-stream-index":"007"},"external_storage":{"$ref":"#/components/schemas/ExternalStorage","x-stream-index":"006"},"quality":{"$ref":"#/components/schemas/Quality","x-stream-index":"004"},"storage_name":{"type":"string","x-stream-index":"005"}},"type":"object"},"FrameRecordingResponse":{"properties":{"status":{"type":"string","x-stream-index":"001"}},"required":["status"],"type":"object"},"FrameRecordingSettingsRequest":{"properties":{"capture_interval_in_seconds":{"format":"int32","maximum":60,"minimum":2,"type":"integer","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"},"quality":{"enum":["360p","480p","720p","1080p","1440p"],"type":"string","x-stream-index":"002"}},"required":["mode","capture_interval_in_seconds"],"type":"object"},"FrameRecordingSettingsResponse":{"properties":{"capture_interval_in_seconds":{"format":"int32","maximum":60,"minimum":2,"type":"integer","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"},"quality":{"type":"string","x-stream-index":"002"}},"required":["mode","capture_interval_in_seconds"],"type":"object"},"FullUserResponse":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"015"},"banned":{"type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"014"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.011"},"devices":{"items":{"$ref":"#/components/schemas/DeviceResponse"},"type":"array","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001.001"},"image":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"005"},"language":{"type":"string","x-stream-index":"001.005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"001.014"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"012"},"mutes":{"items":{"$ref":"#/components/schemas/UserMuteResponse"},"type":"array","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"001.002"},"online":{"type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"003"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.015"},"role":{"type":"string","x-stream-index":"001.006"},"shadow_banned":{"type":"boolean","x-stream-index":"013"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"009"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"010"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"008"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"011"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","devices","invisible","mutes","channel_mutes","unread_count","total_unread_count","unread_channels","unread_threads","shadow_banned","blocked_user_ids"],"type":"object"},"GeofenceSettings":{"properties":{"names":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"required":["names"],"type":"object"},"GeofenceSettingsRequest":{"properties":{"names":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"type":"object"},"GeofenceSettingsResponse":{"properties":{"names":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"required":["names"],"type":"object"},"GetActivityResponse":{"nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","description":"The requested activity","title":"Activity","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["activity","duration"],"title":"Get Activity Response","type":"object"},"GetApplicationResponse":{"description":"Basic response information","nullable":true,"properties":{"app":{"$ref":"#/components/schemas/AppResponseFields","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["app","duration"],"title":"Response","type":"object"},"GetBlockedUsersResponse":{"nullable":true,"properties":{"blocks":{"description":"Array of blocked user object","items":{"$ref":"#/components/schemas/BlockedUserResponse"},"title":"Blocks","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["blocks","duration"],"type":"object"},"GetCallReportResponse":{"description":"Basic response information","nullable":true,"properties":{"chat_activity":{"$ref":"#/components/schemas/ChatActivityStatsResponse","x-stream-index":"004"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"report":{"$ref":"#/components/schemas/ReportResponse","x-stream-index":"003"},"session_id":{"type":"string","x-stream-index":"002"},"video_reactions":{"items":{"$ref":"#/components/schemas/VideoReactionsResponse"},"type":"array","x-stream-index":"005"}},"required":["duration","session_id","report"],"title":"Response","type":"object"},"GetCallResponse":{"nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001.001"},"duration":{"type":"string","x-stream-index":"002.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001.002"},"membership":{"$ref":"#/components/schemas/MemberResponse","x-stream-index":"001.003"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"001.004"}},"required":["call","members","own_capabilities","blocked_users","duration"],"title":"GetCallResponse","type":"object"},"GetCommentRepliesResponse":{"nullable":true,"properties":{"comments":{"description":"Threaded listing of replies to the comment","items":{"$ref":"#/components/schemas/ThreadedCommentResponse"},"title":"Comments","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["comments","duration"],"title":"Get Comment Replies Response","type":"object"},"GetCommentResponse":{"nullable":true,"properties":{"comment":{"$ref":"#/components/schemas/CommentResponse","description":"Comment","title":"Comment","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["comment","duration"],"title":"Get Comment Response","type":"object"},"GetCommentsResponse":{"nullable":true,"properties":{"comments":{"description":"Threaded listing for the activity","items":{"$ref":"#/components/schemas/ThreadedCommentResponse"},"title":"Comments","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["comments","duration"],"title":"Get Comments Response","type":"object"},"GetConfigResponse":{"nullable":true,"properties":{"config":{"$ref":"#/components/schemas/ConfigResponse","description":"The retrieved moderation configuration","title":"Config","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["duration"],"type":"object"},"GetDraftResponse":{"description":"Basic response information","nullable":true,"properties":{"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["draft","duration"],"title":"Response","type":"object"},"GetEdgesResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"edges":{"items":{"$ref":"#/components/schemas/EdgeResponse"},"type":"array","x-stream-index":"001"}},"required":["edges","duration"],"title":"Response","type":"object"},"GetFollowSuggestionsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"suggestions":{"description":"List of suggested feeds to follow","items":{"$ref":"#/components/schemas/FeedResponse"},"title":"Suggestions","type":"array","x-stream-index":"001"}},"required":["suggestions","duration"],"title":"Follow Suggestions Response","type":"object"},"GetManyMessagesResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.002.001"},"messages":{"description":"List of messages","items":{"$ref":"#/components/schemas/MessageResponse"},"title":"Messages","type":"array","x-stream-index":"001.001"}},"required":["messages","duration"],"type":"object"},"GetMessageResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageWithChannelResponse","x-stream-index":"001"},"pending_message_metadata":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"002"}},"required":["message","duration"],"title":"Response","type":"object"},"GetOGResponse":{"nullable":true,"properties":{"actions":{"items":{"$ref":"#/components/schemas/Action"},"type":"array","x-stream-index":"001.015"},"asset_url":{"description":"URL of detected video or audio","title":"Image URL","type":"string","x-stream-index":"001.017"},"author_icon":{"type":"string","x-stream-index":"001.007"},"author_link":{"description":"og:site","title":"Author Link","type":"string","x-stream-index":"001.006"},"author_name":{"description":"og:site_name","title":"Author Name","type":"string","x-stream-index":"001.005"},"color":{"type":"string","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.018"},"duration":{"type":"string","x-stream-index":"002.001"},"fallback":{"type":"string","x-stream-index":"001.002"},"fields":{"items":{"$ref":"#/components/schemas/Field"},"type":"array","x-stream-index":"001.016"},"footer":{"type":"string","x-stream-index":"001.013"},"footer_icon":{"type":"string","x-stream-index":"001.014"},"giphy":{"$ref":"#/components/schemas/Images","x-stream-index":"001.019"},"image_url":{"description":"URL of detected image","title":"Image URL","type":"string","x-stream-index":"001.011"},"og_scrape_url":{"description":"extracted url from the text","title":"OG Scrape URL","type":"string","x-stream-index":"001.020"},"original_height":{"format":"int32","type":"integer","x-stream-index":"001.022"},"original_width":{"format":"int32","type":"integer","x-stream-index":"001.021"},"pretext":{"type":"string","x-stream-index":"001.004"},"text":{"description":"og:description","title":"Text","type":"string","x-stream-index":"001.010"},"thumb_url":{"description":"URL of detected thumb image","title":"Image URL","type":"string","x-stream-index":"001.012"},"title":{"description":"og:title","title":"Title","type":"string","x-stream-index":"001.008"},"title_link":{"description":"og:url","title":"Title Link","type":"string","x-stream-index":"001.009"},"type":{"description":"Attachment type, could be empty, image, audio or video","title":"Type","type":"string","x-stream-index":"001.001"}},"required":["custom","duration"],"title":"Get OG Attachment","type":"object","x-stream-docs-page-id":"og"},"GetOrCreateCallRequest":{"nullable":true,"properties":{"data":{"$ref":"#/components/schemas/CallRequest","title":"ReadOnlyData","x-stream-index":"003"},"members_limit":{"format":"int32","maximum":100,"type":"integer","x-stream-index":"007"},"notify":{"description":"if provided it sends a notification event to the members for this call","title":"Notify","type":"boolean","x-stream-index":"005"},"ring":{"description":"if provided it sends a ring event to the members for this call","title":"Ring","type":"boolean","x-stream-index":"004"},"video":{"type":"boolean","x-stream-index":"006"}},"title":"GetOrCreateCallRequest","type":"object"},"GetOrCreateCallResponse":{"nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001.001"},"created":{"type":"boolean","x-stream-index":"002"},"duration":{"type":"string","x-stream-index":"003.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001.002"},"membership":{"$ref":"#/components/schemas/MemberResponse","x-stream-index":"001.003"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"001.004"}},"required":["call","members","own_capabilities","blocked_users","created","duration"],"title":"GetOrCreateCallResponse","type":"object"},"GetOrCreateFeedRequest":{"description":"Client request","nullable":true,"properties":{"activity_selector_options":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"data":{"$ref":"#/components/schemas/FeedInput","x-stream-index":"003"},"external_ranking":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"filter":{"additionalProperties":{},"type":"object","x-stream-index":"009"},"followers_pagination":{"$ref":"#/components/schemas/PagerRequest","x-stream-index":"011"},"following_pagination":{"$ref":"#/components/schemas/PagerRequest","x-stream-index":"012"},"interest_weights":{"additionalProperties":{"format":"float","type":"number"},"type":"object","x-stream-index":"008"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"013.001"},"member_pagination":{"$ref":"#/components/schemas/PagerRequest","x-stream-index":"010"},"next":{"type":"string","x-stream-index":"013.002"},"prev":{"type":"string","x-stream-index":"013.003"},"view":{"type":"string","x-stream-index":"005"},"watch":{"type":"boolean","x-stream-index":"004"}},"title":"ClientRequest","type":"object"},"GetOrCreateFeedResponse":{"description":"Basic response information","nullable":true,"properties":{"activities":{"items":{"$ref":"#/components/schemas/ActivityResponse"},"type":"array","x-stream-index":"002"},"aggregated_activities":{"items":{"$ref":"#/components/schemas/AggregatedActivityResponse"},"type":"array","x-stream-index":"003"},"created":{"type":"boolean","x-stream-index":"015"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"017.001"},"feed":{"$ref":"#/components/schemas/FeedResponse","x-stream-index":"001"},"followers":{"items":{"$ref":"#/components/schemas/FollowResponse"},"type":"array","x-stream-index":"005"},"followers_pagination":{"$ref":"#/components/schemas/PagerResponse","x-stream-index":"012"},"following":{"items":{"$ref":"#/components/schemas/FollowResponse"},"type":"array","x-stream-index":"006"},"following_pagination":{"$ref":"#/components/schemas/PagerResponse","x-stream-index":"013"},"member_pagination":{"$ref":"#/components/schemas/PagerResponse","x-stream-index":"011"},"members":{"items":{"$ref":"#/components/schemas/FeedMemberResponse"},"type":"array","x-stream-index":"004"},"next":{"type":"string","x-stream-index":"016.001"},"notification_status":{"$ref":"#/components/schemas/NotificationStatusResponse","x-stream-index":"014"},"own_capabilities":{"items":{"$ref":"#/components/schemas/FeedOwnCapability"},"type":"array","x-stream-index":"008"},"own_follows":{"items":{"$ref":"#/components/schemas/FollowResponse"},"type":"array","x-stream-index":"009"},"own_membership":{"$ref":"#/components/schemas/FeedMemberResponse","x-stream-index":"010"},"pinned_activities":{"items":{"$ref":"#/components/schemas/ActivityPinResponse"},"type":"array","x-stream-index":"007"},"prev":{"type":"string","x-stream-index":"016.002"}},"required":["feed","activities","aggregated_activities","members","followers","following","pinned_activities","own_capabilities","created","duration"],"title":"Response","type":"object"},"GetReactionsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"reactions":{"description":"List of reactions","items":{"$ref":"#/components/schemas/Reaction"},"title":"Reactions","type":"array","x-stream-index":"001"}},"required":["reactions","duration"],"type":"object"},"GetRepliesResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"messages":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","x-stream-index":"001"}},"required":["messages","duration"],"title":"Response","type":"object"},"GetThreadResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"thread":{"$ref":"#/components/schemas/ThreadStateResponse","description":"Enriched thread state","title":"Thread","x-stream-index":"001"}},"required":["thread","duration"],"type":"object"},"GoLiveRequest":{"nullable":true,"properties":{"recording_storage_name":{"type":"string","x-stream-index":"005"},"start_closed_caption":{"type":"boolean","x-stream-index":"008"},"start_hls":{"type":"boolean","x-stream-index":"003"},"start_recording":{"type":"boolean","x-stream-index":"004"},"start_transcription":{"type":"boolean","x-stream-index":"007"},"transcription_storage_name":{"type":"string","x-stream-index":"006"}},"title":"GoLiveRequest","type":"object"},"GoLiveResponse":{"description":"Basic response information","nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["call","duration"],"title":"Response","type":"object"},"GoogleVisionConfig":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"GroupedStatsResponse":{"nullable":true,"properties":{"name":{"type":"string","x-stream-index":"001"},"unique":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["name","unique"],"type":"object"},"HLSEgressConfig":{"properties":{"composite_app_settings":{"$ref":"#/components/schemas/CompositeAppSettings","x-stream-index":"005"},"playlist_url":{"type":"string","x-stream-index":"007"},"qualities":{"items":{"$ref":"#/components/schemas/Quality"},"type":"array","x-stream-index":"004"},"start_unix_nano":{"format":"int64","type":"integer","x-stream-index":"006"}},"type":"object"},"HLSSettings":{"properties":{"auto_on":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"004"},"quality_tracks":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"required":["auto_on","enabled","quality_tracks"],"type":"object"},"HLSSettingsRequest":{"properties":{"auto_on":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"quality_tracks":{"items":{"type":"string"},"maximum":3,"minimum":1,"type":"array","x-stream-index":"003"}},"required":["quality_tracks"],"title":"HLSSettingsRequest","type":"object"},"HLSSettingsResponse":{"description":"HLSSettings is the payload for HLS settings","properties":{"auto_on":{"title":"Auto On","type":"boolean","x-stream-index":"001"},"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"002"},"quality_tracks":{"items":{"type":"string"},"title":"Quality Tracks","type":"array","x-stream-index":"003"}},"required":["auto_on","enabled","quality_tracks","layout"],"title":"HLSSettingsResponse","type":"object"},"HarmConfig":{"properties":{"action_sequences":{"items":{"$ref":"#/components/schemas/ActionSequence"},"type":"array","x-stream-index":"001"},"severity":{"type":"integer","x-stream-index":"002"}},"required":["action_sequences","severity"],"type":"object"},"HealthCheckEvent":{"nullable":true,"properties":{"cid":{"type":"string","x-stream-index":"003"},"connection_id":{"type":"string","x-stream-index":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004.007"},"me":{"$ref":"#/components/schemas/OwnUserResponse","x-stream-index":"002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"004.004"},"type":{"default":"health.check","type":"string","x-stream-index":"004.002"}},"required":["connection_id","type","created_at","custom"],"title":"HealthCheckEvent","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"},"HideChannelRequest":{"nullable":true,"properties":{"clear_history":{"description":"Whether to clear message history of the channel or not","title":"Clear history","type":"boolean","x-stream-index":"001"}},"type":"object"},"HideChannelResponse":{"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"},"ICEServer":{"properties":{"password":{"type":"string","x-stream-index":"003"},"urls":{"items":{"type":"string"},"type":"array","x-stream-index":"001"},"username":{"type":"string","x-stream-index":"002"}},"required":["urls","username","password"],"type":"object"},"ImageContentParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"type":"object"},"ImageData":{"properties":{"frames":{"type":"string","x-stream-index":"005"},"height":{"type":"string","x-stream-index":"003"},"size":{"type":"string","x-stream-index":"004"},"url":{"type":"string","x-stream-index":"001"},"width":{"type":"string","x-stream-index":"002"}},"required":["url","width","height","size","frames"],"type":"object"},"ImageRuleParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"type":"object"},"ImageSize":{"properties":{"crop":{"description":"Crop mode","enum":["top","bottom","left","right","center"],"title":"Crop","type":"string","x-stream-index":"001"},"height":{"description":"Target image height","format":"int32","title":"Height","type":"integer","x-stream-index":"003"},"resize":{"description":"Resize method","enum":["clip","crop","scale","fill"],"title":"Resize","type":"string","x-stream-index":"002"},"width":{"description":"Target image width","format":"int32","title":"Width","type":"integer","x-stream-index":"004"}},"title":"Image size configuration","type":"object"},"ImageUploadRequest":{"nullable":true,"properties":{"file":{"type":"string","x-stream-index":"001.001"},"upload_sizes":{"description":"field with JSON-encoded array of image size configurations","items":{"$ref":"#/components/schemas/ImageSize"},"title":"Upload sizes","type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/OnlyUserID","x-stream-index":"001.002"}},"type":"object"},"ImageUploadResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.003.001"},"file":{"type":"string","x-stream-index":"001.001"},"thumb_url":{"type":"string","x-stream-index":"001.002"},"upload_sizes":{"description":"Array of image size configurations","items":{"$ref":"#/components/schemas/ImageSize"},"title":"Upload sizes","type":"array","x-stream-index":"002"}},"required":["duration"],"type":"object"},"Images":{"properties":{"fixed_height":{"$ref":"#/components/schemas/ImageData","x-stream-index":"002"},"fixed_height_downsampled":{"$ref":"#/components/schemas/ImageData","x-stream-index":"004"},"fixed_height_still":{"$ref":"#/components/schemas/ImageData","x-stream-index":"003"},"fixed_width":{"$ref":"#/components/schemas/ImageData","x-stream-index":"005"},"fixed_width_downsampled":{"$ref":"#/components/schemas/ImageData","x-stream-index":"007"},"fixed_width_still":{"$ref":"#/components/schemas/ImageData","x-stream-index":"006"},"original":{"$ref":"#/components/schemas/ImageData","x-stream-index":"001"}},"required":["original","fixed_height","fixed_height_still","fixed_height_downsampled","fixed_width","fixed_width_still","fixed_width_downsampled"],"type":"object"},"IngressAudioEncodingOptions":{"properties":{"bitrate":{"maximum":128000,"minimum":16000,"type":"integer","x-stream-index":"003"},"channels":{"enum":["1","2"],"format":"int32","type":"integer","x-stream-index":"001"},"enable_dtx":{"type":"boolean","x-stream-index":"002"}},"required":["channels","enable_dtx","bitrate"],"type":"object"},"IngressAudioEncodingOptionsRequest":{"properties":{"bitrate":{"maximum":128000,"minimum":16000,"type":"integer","x-stream-index":"003"},"channels":{"enum":["1","2"],"format":"int32","type":"integer","x-stream-index":"001"},"enable_dtx":{"type":"boolean","x-stream-index":"002"}},"required":["channels","bitrate"],"type":"object"},"IngressAudioEncodingResponse":{"properties":{"bitrate":{"format":"int32","type":"integer","x-stream-index":"003"},"channels":{"format":"int32","type":"integer","x-stream-index":"001"},"enable_dtx":{"type":"boolean","x-stream-index":"002"}},"required":["channels","enable_dtx","bitrate"],"type":"object"},"IngressSettings":{"properties":{"audio_encoding_options":{"$ref":"#/components/schemas/IngressAudioEncodingOptions","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"video_encoding_options":{"additionalProperties":{"$ref":"#/components/schemas/IngressVideoEncodingOptions"},"type":"object","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"IngressSettingsRequest":{"properties":{"audio_encoding_options":{"$ref":"#/components/schemas/IngressAudioEncodingOptionsRequest","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"video_encoding_options":{"additionalProperties":{"$ref":"#/components/schemas/IngressVideoEncodingOptionsRequest"},"type":"object","x-stream-index":"003"}},"type":"object"},"IngressSettingsResponse":{"properties":{"audio_encoding_options":{"$ref":"#/components/schemas/IngressAudioEncodingResponse","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"video_encoding_options":{"additionalProperties":{"$ref":"#/components/schemas/IngressVideoEncodingResponse"},"type":"object","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"IngressVideoEncodingOptions":{"properties":{"layers":{"items":{"$ref":"#/components/schemas/IngressVideoLayer"},"minimum":1,"type":"array","x-stream-index":"001"}},"required":["layers"],"type":"object"},"IngressVideoEncodingOptionsRequest":{"properties":{"layers":{"items":{"$ref":"#/components/schemas/IngressVideoLayerRequest"},"minimum":1,"type":"array","x-stream-index":"001"}},"required":["layers"],"type":"object"},"IngressVideoEncodingResponse":{"properties":{"layers":{"items":{"$ref":"#/components/schemas/IngressVideoLayerResponse"},"type":"array","x-stream-index":"001"}},"required":["layers"],"type":"object"},"IngressVideoLayer":{"nullable":true,"properties":{"bitrate":{"minimum":1000,"type":"integer","x-stream-index":"002"},"codec":{"enum":["h264","vp8"],"type":"string","x-stream-index":"001"},"frame_rate":{"maximum":60,"minimum":1,"type":"integer","x-stream-index":"003"},"max_dimension":{"minimum":240,"type":"integer","x-stream-index":"005"},"min_dimension":{"minimum":240,"type":"integer","x-stream-index":"004"}},"required":["codec","bitrate","frame_rate","min_dimension","max_dimension"],"type":"object"},"IngressVideoLayerRequest":{"nullable":true,"properties":{"bitrate":{"format":"int32","minimum":1000,"type":"integer","x-stream-index":"002"},"codec":{"enum":["h264","vp8"],"type":"string","x-stream-index":"001"},"frame_rate_limit":{"maximum":60,"minimum":1,"type":"integer","x-stream-index":"005"},"max_dimension":{"minimum":240,"type":"integer","x-stream-index":"004"},"min_dimension":{"minimum":240,"type":"integer","x-stream-index":"003"}},"required":["codec","bitrate","min_dimension","max_dimension","frame_rate_limit"],"type":"object"},"IngressVideoLayerResponse":{"nullable":true,"properties":{"bitrate":{"type":"integer","x-stream-index":"002"},"codec":{"type":"string","x-stream-index":"001"},"frame_rate_limit":{"type":"integer","x-stream-index":"005"},"max_dimension":{"type":"integer","x-stream-index":"004"},"min_dimension":{"type":"integer","x-stream-index":"003"}},"required":["codec","bitrate","min_dimension","max_dimension","frame_rate_limit"],"type":"object"},"JoinCallRequest":{"nullable":true,"properties":{"create":{"description":"if true the call will be created if it doesn't exist","title":"Create","type":"boolean","x-stream-index":"002"},"data":{"$ref":"#/components/schemas/CallRequest","x-stream-index":"003"},"location":{"title":"Location","type":"string","x-stream-index":"009"},"members_limit":{"format":"int32","maximum":100,"title":"The amount of members that should be returned","type":"integer","x-stream-index":"007"},"migrating_from":{"description":"If the participant is migrating from another SFU, then this is the ID of the previous SFU","title":"MigratingFrom","type":"string","x-stream-index":"010"},"notify":{"type":"boolean","x-stream-index":"005"},"ring":{"description":"if true and the call is created, the notification will include ring=true","title":"Ring","type":"boolean","x-stream-index":"004"},"video":{"type":"boolean","x-stream-index":"006"}},"required":["location"],"title":"JoinCallRequest","type":"object"},"JoinCallResponse":{"nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001.001"},"created":{"title":"Created","type":"boolean","x-stream-index":"002"},"credentials":{"$ref":"#/components/schemas/Credentials","title":"Credentials","x-stream-index":"003"},"duration":{"type":"string","x-stream-index":"005.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001.002"},"membership":{"$ref":"#/components/schemas/MemberResponse","x-stream-index":"001.003"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"001.004"},"stats_options":{"$ref":"#/components/schemas/StatsOptions","x-stream-index":"004"}},"required":["call","members","own_capabilities","blocked_users","created","credentials","stats_options","duration"],"title":"JoinCallResponse","type":"object"},"KickUserRequest":{"description":"KickUserRequest is the payload for kicking a user from a call. Optionally block the user as well.","nullable":true,"properties":{"block":{"description":"If true, also block the user from rejoining the call","title":"Block","type":"boolean","x-stream-index":"004"},"user_id":{"description":"The user to kick","title":"UserID","type":"string","x-stream-index":"003"}},"required":["user_id"],"title":"KickUserRequest","type":"object"},"KickUserResponse":{"description":"KickUserResponse is the payload for kicking a user from a call.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"KickUserResponse","type":"object"},"KickedUserEvent":{"description":"This event is sent to call participants to notify when a user is kicked from a call. Clients should make the kicked user leave the call UI.","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"kicked_by_user":{"$ref":"#/components/schemas/UserResponse","description":"The user that kicked the participant, null if server-side","title":"Kicked by","x-stream-index":"004"},"type":{"default":"call.kicked_user","description":"The type of event: \"call.kicked_user\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user that was kicked","title":"User","x-stream-index":"003"}},"required":["type","created_at","call_cid","user"],"title":"KickedUserEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"LLMConfig":{"properties":{"app_context":{"type":"string","x-stream-index":"005"},"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/LLMRule"},"type":"array","x-stream-index":"003"},"severity_descriptions":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"004"}},"required":["enabled","rules"],"type":"object"},"LLMRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove","keep"],"type":"string","x-stream-index":"003"},"description":{"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"},"severity_rules":{"items":{"$ref":"#/components/schemas/BodyguardSeverityRule"},"type":"array","x-stream-index":"004"}},"required":["label","description","action","severity_rules"],"type":"object"},"Label":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"phrase_list_ids":{"items":{"format":"int32","type":"integer"},"type":"array","x-stream-index":"002"}},"required":["name"],"type":"object"},"LabelThresholds":{"properties":{"block":{"description":"Threshold for automatic message block","format":"float","maximum":1,"minimum":0,"title":"Block","type":"number","x-stream-index":"002"},"flag":{"description":"Threshold for automatic message flag","format":"float","maximum":1,"minimum":0,"title":"Flag","type":"number","x-stream-index":"001"}},"type":"object"},"LayoutSettings":{"properties":{"detect_orientation":{"type":"boolean","x-stream-index":"005"},"external_app_url":{"type":"string","x-stream-index":"003"},"external_css_url":{"type":"string","x-stream-index":"004"},"name":{"enum":["spotlight","grid","single-participant","mobile","custom"],"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"required":["name","external_app_url","external_css_url"],"type":"object"},"LayoutSettingsRequest":{"properties":{"detect_orientation":{"type":"boolean","x-stream-index":"005"},"external_app_url":{"type":"string","x-stream-index":"003"},"external_css_url":{"type":"string","x-stream-index":"004"},"name":{"enum":["spotlight","grid","single-participant","mobile","custom"],"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"required":["name"],"type":"object"},"LimitsSettings":{"properties":{"max_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"004"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"},"max_participants_exclude_owner":{"type":"boolean","x-stream-index":"003"},"max_participants_exclude_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"002"}},"required":["max_participants_exclude_roles"],"type":"object"},"LimitsSettingsRequest":{"properties":{"max_duration_seconds":{"format":"int32","minimum":0,"type":"integer","x-stream-index":"004"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"},"max_participants_exclude_owner":{"type":"boolean","x-stream-index":"003"},"max_participants_exclude_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"002"}},"type":"object"},"LimitsSettingsResponse":{"properties":{"max_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"004"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"},"max_participants_exclude_owner":{"type":"boolean","x-stream-index":"003"},"max_participants_exclude_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"002"}},"required":["max_participants_exclude_roles"],"type":"object"},"ListBlockListResponse":{"description":"Basic response information","nullable":true,"properties":{"blocklists":{"items":{"$ref":"#/components/schemas/BlockListResponse"},"type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["blocklists","duration"],"title":"Response","type":"object"},"ListDevicesResponse":{"description":"List devices response","nullable":true,"properties":{"devices":{"description":"List of devices","items":{"$ref":"#/components/schemas/DeviceResponse"},"title":"Devices","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["devices","duration"],"title":"ListDevicesResponse","type":"object"},"ListRecordingsResponse":{"description":"Response for listing recordings","nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"},"recordings":{"items":{"$ref":"#/components/schemas/CallRecording"},"title":"The list of recordings.","type":"array","x-stream-index":"002"}},"required":["duration","recordings"],"title":"ListRecordingsResponse","type":"object"},"ListTranscriptionsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"},"transcriptions":{"description":"List of transcriptions for the call","items":{"$ref":"#/components/schemas/CallTranscription"},"title":"Transcriptions","type":"array","x-stream-index":"002"}},"required":["duration","transcriptions"],"title":"ListTranscriptionsResponse","type":"object"},"MarkActivityRequest":{"nullable":true,"properties":{"mark_all_read":{"description":"Whether to mark all activities as read","title":"Mark All Read","type":"boolean","x-stream-index":"005"},"mark_all_seen":{"description":"Whether to mark all activities as seen","title":"Mark All Seen","type":"boolean","x-stream-index":"003"},"mark_read":{"description":"List of activity IDs to mark as read","items":{"type":"string"},"title":"Mark Read","type":"array","x-stream-index":"004"},"mark_seen":{"description":"List of activity IDs to mark as seen","items":{"type":"string"},"title":"Mark Seen","type":"array","x-stream-index":"006"},"mark_watched":{"description":"List of activity IDs to mark as watched (for stories)","items":{"type":"string"},"title":"Mark Watched","type":"array","x-stream-index":"007"}},"title":"Mark Activity Request","type":"object"},"MarkChannelsReadRequest":{"nullable":true,"properties":{"read_by_channel":{"additionalProperties":{"type":"string"},"description":"Map of channel ID to last read message ID","maximum":30,"title":"Read by channel","type":"object","x-stream-index":"001"}},"type":"object"},"MarkReadRequest":{"nullable":true,"properties":{"message_id":{"description":"ID of the message that is considered last read by client","title":"Message ID","type":"string","x-stream-index":"001"},"thread_id":{"description":"Optional Thread ID to specifically mark a given thread as read","title":"Thread ID","type":"string","x-stream-index":"002"}},"type":"object"},"MarkReadResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"event":{"$ref":"#/components/schemas/MessageReadEvent","description":"Mark read event","title":"Event","x-stream-index":"001"}},"required":["duration"],"type":"object"},"MarkReviewedRequest":{"properties":{"content_to_mark_as_reviewed_limit":{"format":"int32","maximum":2500,"type":"integer","x-stream-index":"002"},"disable_marking_content_as_reviewed":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"MarkUnreadRequest":{"nullable":true,"properties":{"message_id":{"description":"ID of the message from where the channel is marked unread","title":"Message ID","type":"string","x-stream-index":"001"},"thread_id":{"description":"Mark a thread unread, specify both the thread and message id","title":"Thread ID","type":"string","x-stream-index":"003"}},"type":"object"},"MemberAddedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"002.001"},"type":{"default":"member.added","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MemberAddedEvent","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"},"MemberLookup":{"properties":{"Limit":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"001"}},"required":["Limit"],"type":"object"},"MemberRemovedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"001.001"},"type":{"default":"member.removed","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MemberRemovedEvent","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"},"MemberRequest":{"description":"MemberRequest is the payload for adding a member to a call.","properties":{"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"003"},"role":{"title":"Role","type":"string","x-stream-index":"002"},"user_id":{"minLength":1,"title":"User ID","type":"string","x-stream-index":"001"}},"required":["user_id"],"title":"MemberRequest","type":"object"},"MemberResponse":{"description":"MemberResponse is the payload for a member of a call.","properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"005"},"custom":{"additionalProperties":{},"description":"Custom member response data","title":"Custom","type":"object","x-stream-index":"004"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"007"},"role":{"title":"Role","type":"string","x-stream-index":"003"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"006"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"},"user_id":{"type":"string","x-stream-index":"002"}},"required":["user","user_id","custom","created_at","updated_at"],"title":"MemberResponse","type":"object"},"MemberUpdatedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"005.002"},"channel_type":{"type":"string","x-stream-index":"005.003"},"cid":{"type":"string","x-stream-index":"005.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"002.001"},"type":{"default":"member.updated","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MemberUpdatedEvent","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"},"MembersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"members":{"description":"List of found members","items":{"$ref":"#/components/schemas/ChannelMember"},"title":"Members","type":"array","x-stream-index":"001"}},"required":["members","duration"],"type":"object"},"MembershipLevelResponse":{"properties":{"created_at":{"description":"When the membership level was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"007"},"custom":{"additionalProperties":{},"description":"Custom data for the membership level","title":"Custom Data","type":"object","x-stream-index":"006"},"description":{"description":"Description of the membership level","title":"Description","type":"string","x-stream-index":"003"},"id":{"description":"Unique identifier for the membership level","title":"ID","type":"string","x-stream-index":"001"},"name":{"description":"Display name for the membership level","title":"Name","type":"string","x-stream-index":"002"},"priority":{"description":"Priority level","format":"int32","title":"Priority","type":"integer","x-stream-index":"004"},"tags":{"description":"Activity tags this membership level gives access to","items":{"type":"string"},"title":"Tags","type":"array","x-stream-index":"005"},"updated_at":{"description":"When the membership level was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"008"}},"required":["id","name","priority","tags","created_at","updated_at"],"title":"Membership Level Response","type":"object"},"Message":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"012"},"before_message_send_failed":{"type":"boolean","x-stream-index":"046"},"cid":{"type":"string","x-stream-index":"028"},"command":{"type":"string","x-stream-index":"006"},"created_at":{"format":"date-time","type":"number","x-stream-index":"030"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"034"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"033"},"deleted_for_me":{"type":"boolean","x-stream-index":"059"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"023"},"html":{"type":"string","x-stream-index":"007"},"i18n":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"044"},"id":{"type":"string","x-stream-index":"002"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"040"},"latest_reactions":{"items":{"$ref":"#/components/schemas/Reaction"},"type":"array","x-stream-index":"013"},"mentioned_users":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"043"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"052"},"mml":{"type":"string","x-stream-index":"005"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"056"},"own_reactions":{"items":{"$ref":"#/components/schemas/Reaction"},"type":"array","x-stream-index":"014"},"parent_id":{"type":"string","x-stream-index":"019"},"pin_expires":{"format":"date-time","type":"number","x-stream-index":"051"},"pinned":{"type":"boolean","x-stream-index":"047"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"048"},"pinned_by":{"$ref":"#/components/schemas/User","x-stream-index":"050"},"poll":{"$ref":"#/components/schemas/Poll","x-stream-index":"054"},"poll_id":{"type":"string","x-stream-index":"053"},"quoted_message":{"$ref":"#/components/schemas/Message","x-stream-index":"025"},"quoted_message_id":{"type":"string","x-stream-index":"024"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"015"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"017"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"016"},"reminder":{"$ref":"#/components/schemas/MessageReminder","x-stream-index":"058"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"022"},"restricted_visibility":{"items":{"type":"string"},"type":"array","x-stream-index":"011"},"shadowed":{"type":"boolean","x-stream-index":"036"},"shared_location":{"$ref":"#/components/schemas/SharedLocation","x-stream-index":"055"},"show_in_channel":{"type":"boolean","x-stream-index":"021"},"silent":{"type":"boolean","x-stream-index":"045"},"text":{"type":"string","x-stream-index":"004"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"027"},"type":{"type":"string","x-stream-index":"008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"031"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"010"}},"required":["id","text","html","type","restricted_visibility","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reaction_groups","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned"],"type":"object"},"MessageActionRequest":{"nullable":true,"properties":{"form_data":{"additionalProperties":{"type":"string"},"description":"ReadOnlyData to execute command with","title":"Form data","type":"object","x-stream-index":"002"}},"required":["form_data"],"type":"object"},"MessageChangeSet":{"properties":{"attachments":{"type":"boolean","x-stream-index":"005"},"custom":{"type":"boolean","x-stream-index":"001"},"html":{"type":"boolean","x-stream-index":"004"},"mentioned_user_ids":{"type":"boolean","x-stream-index":"006"},"mml":{"type":"boolean","x-stream-index":"003"},"pin":{"type":"boolean","x-stream-index":"009"},"quoted_message_id":{"type":"boolean","x-stream-index":"007"},"silent":{"type":"boolean","x-stream-index":"008"},"text":{"type":"boolean","x-stream-index":"002"}},"required":["custom","text","mml","html","attachments","mentioned_user_ids","quoted_message_id","silent","pin"],"type":"object"},"MessageDeletedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"007.002"},"deleted_for_me":{"type":"boolean","x-stream-index":"003"},"hard_delete":{"type":"boolean","x-stream-index":"002.001"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"006.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"message.deleted","type":"string","x-stream-index":"007.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005.001"}},"required":["hard_delete","cid","channel_id","channel_type","type","created_at"],"title":"MessageDeletedEvent","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":{"approved_at":{"format":"date-time","type":"number","x-stream-index":"013"},"created_at":{"format":"date-time","type":"number","x-stream-index":"009"},"created_by_automod":{"type":"boolean","x-stream-index":"001"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"008"},"details":{"$ref":"#/components/schemas/FlagDetails","x-stream-index":"006"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"005"},"moderation_feedback":{"$ref":"#/components/schemas/FlagFeedback","x-stream-index":"003"},"moderation_result":{"$ref":"#/components/schemas/MessageModerationResult","x-stream-index":"002"},"reason":{"type":"string","x-stream-index":"007"},"rejected_at":{"format":"date-time","type":"number","x-stream-index":"014"},"reviewed_at":{"format":"date-time","type":"number","x-stream-index":"011"},"reviewed_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"012"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"004"}},"required":["created_by_automod","created_at","updated_at"],"type":"object"},"MessageModerationResult":{"description":"Result of the message moderation","properties":{"action":{"description":"Action taken by automod","title":"Action","type":"string","x-stream-index":"002"},"ai_moderation_response":{"$ref":"#/components/schemas/ModerationResponse","description":"Response from AI moderation","title":"ModerationResponse","x-stream-index":"007"},"blocked_word":{"description":"Word that was blocked","title":"Blocked word","type":"string","x-stream-index":"004"},"blocklist_name":{"description":"Name of the blocklist","title":"Blocklist name","type":"string","x-stream-index":"005"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"010"},"message_id":{"description":"ID of the message","title":"Message ID","type":"string","x-stream-index":"001"},"moderated_by":{"description":"User who moderated the message","title":"Moderated by","type":"string","x-stream-index":"003"},"moderation_thresholds":{"$ref":"#/components/schemas/Thresholds","description":"Thresholds for AI moderation","title":"Thresholds","x-stream-index":"006"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"011"},"user_bad_karma":{"description":"Whether user has bad karma","title":"User bad karma","type":"boolean","x-stream-index":"009"},"user_karma":{"description":"Karma of the user","format":"float","title":"User karma","type":"number","x-stream-index":"008"}},"required":["message_id","action","user_karma","user_bad_karma","created_at","updated_at"],"title":"Message moderation result","type":"object"},"MessageNewEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"005.002"},"channel_type":{"type":"string","x-stream-index":"005.003"},"cid":{"type":"string","x-stream-index":"005.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"006.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"message.new","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"},"watcher_count":{"format":"int32","type":"integer","x-stream-index":"002.001"}},"required":["watcher_count","type","created_at","cid","channel_id","channel_type"],"title":"MessageNewEvent","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"},"MessageOptions":{"properties":{"include_thread_participants":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"MessagePaginationParams":{"type":"object"},"MessageReadEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"003"},"channel_last_message_at":{"format":"date-time","type":"number","x-stream-index":"005"},"channel_type":{"type":"string","x-stream-index":"004"},"cid":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"009"},"last_read_message_id":{"type":"string","x-stream-index":"010"},"team":{"type":"string","x-stream-index":"006"},"thread":{"$ref":"#/components/schemas/ThreadResponse","x-stream-index":"008"},"type":{"default":"message.read","type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","x-stream-index":"007"}},"required":["type","cid","channel_id","channel_type","created_at"],"type":"object"},"MessageReminder":{"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"004"},"channel_cid":{"type":"string","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"011"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"006"},"message_id":{"type":"string","x-stream-index":"005"},"remind_at":{"format":"date-time","type":"number","x-stream-index":"009"},"task_id":{"type":"string","x-stream-index":"010"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"012"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"user_id":{"type":"string","x-stream-index":"007"}},"required":["channel_cid","message_id","user_id","task_id","created_at","updated_at"],"type":"object"},"MessageRequest":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"maximum":30,"type":"array","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"mentioned_users":{"items":{"type":"string"},"maximum":100,"type":"array","x-stream-index":"008"},"mml":{"type":"string","x-stream-index":"003"},"parent_id":{"type":"string","x-stream-index":"005"},"pin_expires":{"format":"date-time","type":"number","x-stream-index":"015"},"pinned":{"type":"boolean","x-stream-index":"013"},"pinned_at":{"format":"date-time","nullable":true,"type":"string","x-stream-index":"014"},"poll_id":{"type":"string","x-stream-index":"039"},"quoted_message_id":{"type":"string","x-stream-index":"009"},"restricted_visibility":{"items":{"type":"string"},"maximum":10,"type":"array","x-stream-index":"016"},"shared_location":{"$ref":"#/components/schemas/SharedLocation","x-stream-index":"040"},"show_in_channel":{"type":"boolean","x-stream-index":"006"},"silent":{"type":"boolean","x-stream-index":"012"},"text":{"type":"string","x-stream-index":"002"},"type":{"enum":["''","regular","system"],"type":"string","x-stream-index":"011"}},"type":"object"},"MessageResponse":{"description":"Represents any chat message","properties":{"attachments":{"description":"Array of message attachments","items":{"$ref":"#/components/schemas/Attachment"},"title":"Message attachments","type":"array","x-stream-docs-page-id":"message_format#attachment-format","x-stream-index":"008"},"cid":{"description":"Channel unique identifier in \u003ctype\u003e:\u003cid\u003e format","title":"Channel CID","type":"string","x-stream-index":"022"},"command":{"description":"Contains provided slash command","title":"Command","type":"string","x-stream-docs-page-id":"custom_commands_webhook","x-stream-index":"004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"023"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"026"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"025"},"deleted_for_me":{"type":"boolean","x-stream-index":"044"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"018"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"041"},"html":{"description":"Contains HTML markup of the message. Can only be set when using server-side API","title":"HTML content","type":"string","x-stream-index":"005"},"i18n":{"additionalProperties":{"type":"string"},"description":"Object with translations. Key `language` contains the original language key. Other keys contain translations","title":"Internationalization info","type":"object","x-stream-docs-page-id":"translation","x-stream-index":"030"},"id":{"description":"Message ID is unique string identifier of the message","title":"ID","type":"string","x-stream-index":"001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"Contains image moderation information","title":"Image moderation labels","type":"object","x-stream-index":"028"},"latest_reactions":{"description":"List of 10 latest reactions to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Latest reactions","type":"array","x-stream-index":"009"},"mentioned_users":{"description":"List of mentioned users","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Mentioned Users","type":"array","x-stream-index":"029"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"036"},"mml":{"description":"Should be empty if `text` is provided. Can only be set when using server-side API","title":"Messaging Markup Language","type":"string","x-stream-docs-page-id":"mml_overview","x-stream-index":"003"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"039"},"own_reactions":{"description":"List of 10 latest reactions of authenticated user to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Own reactions","type":"array","x-stream-index":"010"},"parent_id":{"description":"ID of parent message (thread)","title":"Parent message ID","type":"string","x-stream-docs-page-id":"threads","x-stream-index":"015"},"pin_expires":{"description":"Date when pinned message expires","format":"date-time","title":"Pin expiration date","type":"number","x-stream-docs-page-id":"pinned_messages","x-stream-index":"035"},"pinned":{"description":"Whether message is pinned or not","title":"Pinned","type":"boolean","x-stream-docs-page-id":"pinned_messages","x-stream-index":"032"},"pinned_at":{"description":"Date when message got pinned","format":"date-time","title":"Pinned at","type":"number","x-stream-docs-page-id":"pinned_messages","x-stream-index":"033"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","description":"Contains user who pinned the message","title":"Pinned by","x-stream-docs-page-id":"pinned_messages","x-stream-index":"034"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"038"},"poll_id":{"description":"Identifier of the poll to include in the message","title":"Poll ID","type":"string","x-stream-index":"037"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","description":"Contains quoted message","title":"Quoted message","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"020"},"quoted_message_id":{"title":"ID of quoted message","type":"string","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"019"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing number of reactions of each type. Key: reaction type (string), value: number of reactions (int)","title":"Reaction counts","type":"object","x-stream-index":"011"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"014"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing scores of reactions of each type. Key: reaction type (string), value: total score of reactions (int)","title":"Reaction scores","type":"object","x-stream-index":"012"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"042"},"reply_count":{"description":"Number of replies to this message","format":"int32","title":"Reply count","type":"integer","x-stream-index":"017"},"restricted_visibility":{"description":"A list of user ids that have restricted visibility to the message, if the list is not empty, the message is only visible to the users in the list","items":{"type":"string"},"title":"Restricted visibility","type":"array","x-stream-index":"040"},"shadowed":{"description":"Whether the message was shadowed or not","title":"Shadowed","type":"boolean","x-stream-docs-page-id":"moderation#shadow-ban","x-stream-index":"027"},"shared_location":{"$ref":"#/components/schemas/SharedLocationResponseData","description":"Contains shared location data","title":"Shared Location","x-stream-index":"043"},"show_in_channel":{"description":"Whether thread reply should be shown in the channel as well","title":"Show in channel","type":"boolean","x-stream-docs-page-id":"threads","x-stream-index":"016"},"silent":{"description":"Whether message is silent or not","title":"Silent","type":"boolean","x-stream-index":"031"},"text":{"description":"Text of the message. Should be empty if `mml` is provided","title":"Text","type":"string","x-stream-index":"002"},"thread_participants":{"description":"List of users who participate in thread","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Thread participants","type":"array","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"021"},"type":{"description":"Contains type of the message","enum":["regular","ephemeral","error","reply","system","deleted"],"title":"Message Type","type":"string","x-stream-docs-page-id":"message_format#message-types","x-stream-index":"006"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"024"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Sender of the message. Required when using server-side API","title":"User object","x-stream-index":"007"}},"required":["id","text","html","type","user","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned","restricted_visibility"],"title":"Message","type":"object","x-stream-docs-page-id":"send_message"},"MessageStatsResponse":{"properties":{"count_over_time":{"items":{"$ref":"#/components/schemas/CountByMinuteResponse"},"type":"array","x-stream-index":"001"}},"type":"object"},"MessageUndeletedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"005.002"},"channel_type":{"type":"string","x-stream-index":"005.003"},"cid":{"type":"string","x-stream-index":"005.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"002.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"message.undeleted","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MessageUndeletedEvent","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"},"MessageUpdate":{"properties":{"change_set":{"$ref":"#/components/schemas/MessageChangeSet","x-stream-index":"002"},"old_text":{"type":"string","x-stream-index":"001"}},"type":"object"},"MessageUpdatedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"005.002"},"channel_type":{"type":"string","x-stream-index":"005.003"},"cid":{"type":"string","x-stream-index":"005.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"002.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"message.updated","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MessageUpdatedEvent","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"},"MessageWithChannelResponse":{"description":"Represents any chat message","properties":{"attachments":{"description":"Array of message attachments","items":{"$ref":"#/components/schemas/Attachment"},"title":"Message attachments","type":"array","x-stream-docs-page-id":"message_format#attachment-format","x-stream-index":"001.008"},"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel object","title":"Channel","x-stream-index":"002"},"cid":{"description":"Channel unique identifier in \u003ctype\u003e:\u003cid\u003e format","title":"Channel CID","type":"string","x-stream-index":"001.022"},"command":{"description":"Contains provided slash command","title":"Command","type":"string","x-stream-docs-page-id":"custom_commands_webhook","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.023"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.026"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"001.025"},"deleted_for_me":{"type":"boolean","x-stream-index":"001.044"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"001.018"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001.041"},"html":{"description":"Contains HTML markup of the message. Can only be set when using server-side API","title":"HTML content","type":"string","x-stream-index":"001.005"},"i18n":{"additionalProperties":{"type":"string"},"description":"Object with translations. Key `language` contains the original language key. Other keys contain translations","title":"Internationalization info","type":"object","x-stream-docs-page-id":"translation","x-stream-index":"001.030"},"id":{"description":"Message ID is unique string identifier of the message","title":"ID","type":"string","x-stream-index":"001.001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"Contains image moderation information","title":"Image moderation labels","type":"object","x-stream-index":"001.028"},"latest_reactions":{"description":"List of 10 latest reactions to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Latest reactions","type":"array","x-stream-index":"001.009"},"mentioned_users":{"description":"List of mentioned users","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Mentioned Users","type":"array","x-stream-index":"001.029"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"001.036"},"mml":{"description":"Should be empty if `text` is provided. Can only be set when using server-side API","title":"Messaging Markup Language","type":"string","x-stream-docs-page-id":"mml_overview","x-stream-index":"001.003"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"001.039"},"own_reactions":{"description":"List of 10 latest reactions of authenticated user to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Own reactions","type":"array","x-stream-index":"001.010"},"parent_id":{"description":"ID of parent message (thread)","title":"Parent message ID","type":"string","x-stream-docs-page-id":"threads","x-stream-index":"001.015"},"pin_expires":{"description":"Date when pinned message expires","format":"date-time","title":"Pin expiration date","type":"number","x-stream-docs-page-id":"pinned_messages","x-stream-index":"001.035"},"pinned":{"description":"Whether message is pinned or not","title":"Pinned","type":"boolean","x-stream-docs-page-id":"pinned_messages","x-stream-index":"001.032"},"pinned_at":{"description":"Date when message got pinned","format":"date-time","title":"Pinned at","type":"number","x-stream-docs-page-id":"pinned_messages","x-stream-index":"001.033"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","description":"Contains user who pinned the message","title":"Pinned by","x-stream-docs-page-id":"pinned_messages","x-stream-index":"001.034"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001.038"},"poll_id":{"description":"Identifier of the poll to include in the message","title":"Poll ID","type":"string","x-stream-index":"001.037"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","description":"Contains quoted message","title":"Quoted message","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"001.020"},"quoted_message_id":{"title":"ID of quoted message","type":"string","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"001.019"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing number of reactions of each type. Key: reaction type (string), value: number of reactions (int)","title":"Reaction counts","type":"object","x-stream-index":"001.011"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"001.014"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing scores of reactions of each type. Key: reaction type (string), value: total score of reactions (int)","title":"Reaction scores","type":"object","x-stream-index":"001.012"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"001.042"},"reply_count":{"description":"Number of replies to this message","format":"int32","title":"Reply count","type":"integer","x-stream-index":"001.017"},"restricted_visibility":{"description":"A list of user ids that have restricted visibility to the message, if the list is not empty, the message is only visible to the users in the list","items":{"type":"string"},"title":"Restricted visibility","type":"array","x-stream-index":"001.040"},"shadowed":{"description":"Whether the message was shadowed or not","title":"Shadowed","type":"boolean","x-stream-docs-page-id":"moderation#shadow-ban","x-stream-index":"001.027"},"shared_location":{"$ref":"#/components/schemas/SharedLocationResponseData","description":"Contains shared location data","title":"Shared Location","x-stream-index":"001.043"},"show_in_channel":{"description":"Whether thread reply should be shown in the channel as well","title":"Show in channel","type":"boolean","x-stream-docs-page-id":"threads","x-stream-index":"001.016"},"silent":{"description":"Whether message is silent or not","title":"Silent","type":"boolean","x-stream-index":"001.031"},"text":{"description":"Text of the message. Should be empty if `mml` is provided","title":"Text","type":"string","x-stream-index":"001.002"},"thread_participants":{"description":"List of users who participate in thread","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Thread participants","type":"array","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"001.021"},"type":{"description":"Contains type of the message","enum":["regular","ephemeral","error","reply","system","deleted"],"title":"Message Type","type":"string","x-stream-docs-page-id":"message_format#message-types","x-stream-index":"001.006"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.024"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Sender of the message. Required when using server-side API","title":"User object","x-stream-index":"001.007"}},"required":["id","text","html","type","user","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned","restricted_visibility","channel"],"title":"Message","type":"object","x-stream-docs-page-id":"send_message"},"ModerationActionConfig":{"nullable":true,"properties":{"action":{"type":"string","x-stream-index":"006"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"009"},"description":{"type":"string","x-stream-index":"008"},"entity_type":{"type":"string","x-stream-index":"004"},"icon":{"type":"string","x-stream-index":"007"},"order":{"format":"int32","type":"integer","x-stream-index":"005"}},"required":["entity_type","order","action","icon","description","custom"],"type":"object"},"ModerationCustomActionEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"001"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"002"},"type":{"default":"moderation.custom_action","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationCustomActionEvent","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"},"ModerationFlagResponse":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"015"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"entity_creator_id":{"type":"string","x-stream-index":"007"},"entity_id":{"type":"string","x-stream-index":"006"},"entity_type":{"type":"string","x-stream-index":"005"},"labels":{"items":{"type":"string"},"type":"array","x-stream-index":"011"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"008"},"reason":{"type":"string","x-stream-index":"009"},"result":{"items":{"additionalProperties":{},"type":"object"},"type":"array","x-stream-index":"012"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","x-stream-index":"014"},"review_queue_item_id":{"type":"string","x-stream-index":"013"},"type":{"type":"string","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"016"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"004"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["type","user_id","entity_type","entity_id","result","created_at","updated_at"],"type":"object"},"ModerationFlaggedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"item":{"type":"string","x-stream-index":"001"},"object_id":{"type":"string","x-stream-index":"002"},"type":{"default":"moderation.flagged","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationFlaggedEvent","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"},"ModerationMarkReviewedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"001"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"002"},"type":{"default":"moderation.mark_reviewed","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationMarkReviewedEvent","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"},"ModerationPayload":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"images":{"items":{"type":"string"},"maximum":30,"type":"array","x-stream-index":"002"},"texts":{"items":{"type":"string"},"type":"array","x-stream-index":"001"},"videos":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"type":"object"},"ModerationResponse":{"properties":{"action":{"type":"string","x-stream-index":"004"},"explicit":{"format":"float","type":"number","x-stream-index":"002"},"spam":{"format":"float","type":"number","x-stream-index":"003"},"toxic":{"format":"float","type":"number","x-stream-index":"001"}},"required":["toxic","explicit","spam","action","automod_response"],"type":"object"},"ModerationV2Response":{"properties":{"action":{"type":"string","x-stream-index":"001"},"blocklist_matched":{"type":"string","x-stream-index":"005"},"image_harms":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"original_text":{"type":"string","x-stream-index":"002"},"platform_circumvented":{"type":"boolean","x-stream-index":"007"},"semantic_filter_matched":{"type":"string","x-stream-index":"006"},"text_harms":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"required":["action","original_text"],"type":"object"},"MuteChannelRequest":{"nullable":true,"properties":{"channel_cids":{"description":"Channel CIDs to mute (if multiple channels)","items":{"type":"string"},"maximum":25,"title":"Channel CIDs","type":"array","x-stream-index":"002"},"expiration":{"description":"Duration of mute in milliseconds","title":"Expiration","type":"integer","x-stream-index":"003"}},"type":"object"},"MuteChannelResponse":{"nullable":true,"properties":{"channel_mute":{"$ref":"#/components/schemas/ChannelMute","description":"Object with channel mute (if one channel was muted)","title":"Channel mute","x-stream-index":"001"},"channel_mutes":{"description":"Object with mutes (if multiple channels were muted)","items":{"$ref":"#/components/schemas/ChannelMute"},"title":"Channel mutes","type":"array","x-stream-index":"002"},"duration":{"type":"string","x-stream-index":"004.001"},"own_user":{"$ref":"#/components/schemas/OwnUser","description":"Authorized user object with fresh mutes information","title":"Own user","x-stream-index":"003"}},"required":["duration"],"type":"object"},"MuteRequest":{"nullable":true,"properties":{"target_ids":{"description":"User IDs to mute (if multiple users)","items":{"type":"string"},"title":"Target IDs","type":"array","x-stream-index":"001"},"timeout":{"description":"Duration of mute in minutes","minimum":0,"title":"Timeout","type":"integer","x-stream-index":"002"}},"required":["target_ids"],"title":"MuteRequest","type":"object"},"MuteResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"004.001"},"mutes":{"description":"Object with mutes (if multiple users were muted)","items":{"$ref":"#/components/schemas/UserMute"},"title":"Mutes","type":"array","x-stream-index":"001"},"non_existing_users":{"description":"A list of users that can't be found. Common cause for this is deleted users","items":{"type":"string"},"title":"Non Existing Users","type":"array","x-stream-index":"003"},"own_user":{"$ref":"#/components/schemas/OwnUser","description":"Authorized user object with fresh mutes information","title":"Own User","x-stream-index":"002"}},"required":["duration"],"title":"MuteResponse","type":"object"},"MuteUsersRequest":{"nullable":true,"properties":{"audio":{"title":"Audio","type":"boolean","x-stream-index":"005"},"mute_all_users":{"type":"boolean","x-stream-index":"003"},"screenshare":{"title":"Screenshare","type":"boolean","x-stream-index":"007"},"screenshare_audio":{"title":"ScreenshareAudio","type":"boolean","x-stream-index":"008"},"user_ids":{"items":{"type":"string"},"title":"UserIDs","type":"array","x-stream-index":"004"},"video":{"title":"Video","type":"boolean","x-stream-index":"006"}},"title":"MuteUsersRequest","type":"object"},"MuteUsersResponse":{"description":"MuteUsersResponse is the response payload for the mute users endpoint.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"MuteUsersResponse","type":"object"},"NetworkMetricsReportResponse":{"properties":{"average_connection_time":{"format":"float","type":"number","x-stream-index":"003"},"average_jitter":{"format":"float","type":"number","x-stream-index":"002"},"average_latency":{"format":"float","type":"number","x-stream-index":"001"},"average_time_to_reconnect":{"format":"float","type":"number","x-stream-index":"004"}},"type":"object"},"NoiseCancellationSettings":{"properties":{"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode"],"type":"object"},"NotificationAddedToChannelEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003.004"},"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"003.005"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"001.001"},"type":{"default":"notification.added_to_channel","type":"string","x-stream-index":"002.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"NotificationAddedToChannelEvent","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"},"NotificationChannelDeletedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003.004"},"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"003.005"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"team":{"type":"string","x-stream-index":"001.001"},"type":{"default":"notification.channel_deleted","type":"string","x-stream-index":"002.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"NotificationChannelDeletedEvent","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"},"NotificationChannelMutesUpdatedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"me":{"$ref":"#/components/schemas/OwnUser","x-stream-index":"001"},"type":{"default":"notification.channel_mutes_updated","type":"string","x-stream-index":"002.001"}},"required":["me","type","created_at"],"title":"NotificationChannelMutesUpdatedEvent","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"},"NotificationChannelTruncatedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002.004"},"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"002.005"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"notification.channel_truncated","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"NotificationChannelTruncatedEvent","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"},"NotificationConfig":{"properties":{"track_read":{"type":"boolean","x-stream-index":"002"},"track_seen":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"NotificationFeedUpdatedEvent":{"description":"Emitted when notification feed is updated.","nullable":true,"properties":{"aggregated_activities":{"description":"Aggregated activities for notification feeds","items":{"$ref":"#/components/schemas/AggregatedActivityResponse"},"title":"Aggregated Activities","type":"array","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"003.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.001.007"},"feed_visibility":{"type":"string","x-stream-index":"003.003"},"fid":{"description":"The ID of the feed","title":"Feed ID","type":"string","x-stream-index":"003.002"},"notification_status":{"$ref":"#/components/schemas/NotificationStatusResponse","description":"Notification status including unread/unseen counts","title":"Notification Status","x-stream-index":"002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.001.004"},"type":{"default":"feeds.notification_feed.updated","description":"The type of event: \"feeds.notification_feed.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"003.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who triggered the notification","title":"User","x-stream-index":"004.001"}},"required":["type","created_at","custom","fid"],"title":"NotificationFeedUpdatedEvent","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"},"NotificationInviteAcceptedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002.004"},"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"002.005"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"004.001"},"type":{"default":"notification.invite_accepted","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"NotificationInviteAcceptedEvent","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"},"NotificationInviteRejectedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002.004"},"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"002.005"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"004.001"},"type":{"default":"notification.invite_rejected","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"NotificationInviteRejectedEvent","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"},"NotificationInvitedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002.004"},"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"002.005"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"004.001"},"type":{"default":"notification.invited","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"NotificationInvitedEvent","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"},"NotificationMarkReadEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003.004"},"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"003.005"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"team":{"type":"string","x-stream-index":"002.001"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"006"},"type":{"default":"notification.mark_read","type":"string","x-stream-index":"001.001"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"007"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"005"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"008"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count","unread_count","total_unread_count","unread_channels","unread_threads"],"title":"NotificationMarkReadEvent","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"},"NotificationMarkUnreadEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003.004"},"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"003.005"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"first_unread_message_id":{"type":"string","x-stream-index":"005"},"last_read_at":{"format":"date-time","type":"number","x-stream-index":"006"},"last_read_message_id":{"type":"string","x-stream-index":"012"},"team":{"type":"string","x-stream-index":"002.001"},"thread_id":{"type":"string","x-stream-index":"013"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"009"},"type":{"default":"notification.mark_unread","type":"string","x-stream-index":"001.001"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"010"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"008"},"unread_messages":{"format":"int32","type":"integer","x-stream-index":"007"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"011"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count","first_unread_message_id","last_read_at","unread_messages","unread_count","total_unread_count","unread_channels","unread_threads"],"title":"NotificationMarkUnreadEvent","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"},"NotificationMutesUpdatedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"me":{"$ref":"#/components/schemas/OwnUser","x-stream-index":"001"},"type":{"default":"notification.mutes_updated","type":"string","x-stream-index":"002.001"}},"required":["me","type","created_at"],"title":"NotificationMutesUpdatedEvent","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"},"NotificationNewMessageEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"004.004"},"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"004.005"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"002.001"},"type":{"default":"notification.message_new","type":"string","x-stream-index":"003.001"}},"required":["message","type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"NotificationNewMessageEvent","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"},"NotificationRemovedFromChannelEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002.004"},"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"002.005"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"004.001"},"type":{"default":"notification.removed_from_channel","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"NotificationRemovedFromChannelEvent","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"},"NotificationSettings":{"properties":{"call_live_started":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"002"},"call_missed":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"006"},"call_notification":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"004"},"call_ring":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"session_started":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"003"}},"required":["enabled","call_live_started","session_started","call_notification","call_ring","call_missed"],"type":"object"},"NotificationStatusResponse":{"properties":{"last_read_at":{"format":"date-time","type":"number","x-stream-index":"006"},"last_seen_at":{"description":"When notifications were last seen","format":"date-time","title":"Last Seen At","type":"number","x-stream-index":"005"},"read_activities":{"description":"IDs of activities that have been read","items":{"type":"string"},"title":"Read Activities","type":"array","x-stream-index":"003"},"seen_activities":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"unread":{"description":"Number of unread notifications","format":"int32","title":"Unread","type":"integer","x-stream-index":"001"},"unseen":{"description":"Number of unseen notifications","format":"int32","title":"Unseen","type":"integer","x-stream-index":"002"}},"required":["unread","unseen"],"title":"Notification Status","type":"object"},"NullTime":{"type":"object"},"OCRRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"}},"required":["label","action"],"type":"object"},"OnlyUserID":{"properties":{"id":{"type":"string","x-stream-index":"001"}},"required":["id"],"type":"object"},"OwnCapability":{"description":"All possibility of string to use","enum":["block-users","change-max-duration","create-call","create-reaction","enable-noise-cancellation","end-call","join-backstage","join-call","join-ended-call","kick-user","mute-users","pin-for-everyone","read-call","remove-call-member","screenshare","send-audio","send-video","start-broadcast-call","start-closed-captions-call","start-frame-record-call","start-record-call","start-transcription-call","stop-broadcast-call","stop-closed-captions-call","stop-frame-record-call","stop-record-call","stop-transcription-call","update-call","update-call-member","update-call-permissions","update-call-settings"],"title":"OwnCapability","type":"string"},"OwnUser":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"046"},"banned":{"type":"boolean","x-stream-index":"016"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"045"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"029"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"014"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"013"},"devices":{"items":{"$ref":"#/components/schemas/Device"},"type":"array","x-stream-index":"027"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"023"},"language":{"type":"string","x-stream-index":"035"},"last_active":{"format":"date-time","type":"number","x-stream-index":"011"},"last_engaged_at":{"format":"date-time","type":"number","x-stream-index":"012"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"037"},"mutes":{"items":{"$ref":"#/components/schemas/UserMute"},"type":"array","x-stream-index":"028"},"online":{"type":"boolean","x-stream-index":"022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"026"},"push_preferences":{"$ref":"#/components/schemas/PushPreferences","x-stream-index":"025"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"005"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"031"},"total_unread_count_by_team":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"032"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"033"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"030"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"034"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"}},"required":["id","role","custom","created_at","updated_at","banned","online","devices","mutes","channel_mutes","unread_count","total_unread_count","total_unread_count_by_team","unread_channels","unread_threads","language"],"type":"object"},"OwnUserResponse":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"banned":{"type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"015"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.011"},"devices":{"items":{"$ref":"#/components/schemas/DeviceResponse"},"title":"Devices","type":"array","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001.001"},"image":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"005"},"language":{"type":"string","x-stream-index":"001.005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"001.014"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"013"},"mutes":{"items":{"$ref":"#/components/schemas/UserMuteResponse"},"type":"array","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"001.002"},"online":{"type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"003"},"push_preferences":{"$ref":"#/components/schemas/PushPreferences","x-stream-index":"002"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.015"},"role":{"type":"string","x-stream-index":"001.006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"009"},"total_unread_count_by_team":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"010"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"011"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"008"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"012"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","devices","invisible","mutes","channel_mutes","unread_count","total_unread_count","unread_channels","unread_threads"],"type":"object"},"PagerRequest":{"properties":{"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"002"},"prev":{"type":"string","x-stream-index":"003"}},"type":"object"},"PagerResponse":{"properties":{"next":{"type":"string","x-stream-index":"001"},"prev":{"type":"string","x-stream-index":"002"}},"type":"object"},"PaginationParams":{"properties":{"limit":{"format":"int32","minimum":0,"type":"integer","x-stream-index":"001"},"offset":{"format":"int32","type":"integer","x-stream-index":"002"}},"type":"object"},"ParticipantCountByMinuteResponse":{"nullable":true,"properties":{"first":{"format":"int32","type":"integer","x-stream-index":"002"},"last":{"format":"int32","type":"integer","x-stream-index":"003"},"max":{"format":"int32","type":"integer","x-stream-index":"004"},"min":{"format":"int32","type":"integer","x-stream-index":"005"},"start_ts":{"format":"date-time","type":"number","x-stream-index":"001"}},"required":["start_ts","first","last","max","min"],"type":"object"},"ParticipantCountOverTimeResponse":{"properties":{"by_minute":{"items":{"$ref":"#/components/schemas/ParticipantCountByMinuteResponse"},"type":"array","x-stream-index":"001"}},"type":"object"},"ParticipantReportResponse":{"properties":{"by_browser":{"items":{"$ref":"#/components/schemas/GroupedStatsResponse"},"type":"array","x-stream-index":"008"},"by_country":{"items":{"$ref":"#/components/schemas/GroupedStatsResponse"},"type":"array","x-stream-index":"005"},"by_device":{"items":{"$ref":"#/components/schemas/GroupedStatsResponse"},"type":"array","x-stream-index":"006"},"by_operating_system":{"items":{"$ref":"#/components/schemas/GroupedStatsResponse"},"type":"array","x-stream-index":"007"},"count_over_time":{"$ref":"#/components/schemas/ParticipantCountOverTimeResponse","x-stream-index":"004"},"max_concurrent":{"format":"int32","type":"integer","x-stream-index":"003"},"publishers":{"$ref":"#/components/schemas/PublisherStatsResponse","x-stream-index":"009"},"subscribers":{"$ref":"#/components/schemas/SubscriberStatsResponse","x-stream-index":"010"},"sum":{"format":"int32","type":"integer","x-stream-index":"001"},"unique":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["sum","unique"],"type":"object"},"PendingMessageEvent":{"description":"Pending message event for async moderation","nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"002.007"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"message":{"$ref":"#/components/schemas/Message","description":"The pending message","title":"Message","x-stream-index":"002.009"},"metadata":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"002.010"},"method":{"description":"The method used for the pending message","title":"Method","type":"string","x-stream-index":"003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"type":{"default":"message.pending","description":"The type of event: \"message.pending\" in this case","title":"Event Type","type":"string","x-stream-index":"001.002"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.002"}},"required":["type","custom","method","created_at"],"title":"PendingMessageEvent","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"},"PendingMessageResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"003"},"metadata":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"}},"type":"object"},"PerSDKUsageReport":{"nullable":true,"properties":{"by_version":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"002"},"total":{"format":"int32","type":"integer","x-stream-index":"001"}},"required":["total","by_version"],"type":"object"},"PermissionRequestEvent":{"description":"This event is sent when a user requests access to a feature on a call,\nclients receiving this event should display a permission request to the user","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"permissions":{"description":"The list of permissions requested by the user","items":{"type":"string"},"title":"Permissions","type":"array","x-stream-index":"004"},"type":{"default":"call.permission_request","description":"The type of event: \"call.permission_request\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who sent the permission request","title":"User","x-stream-index":"003"}},"required":["type","created_at","call_cid","user","permissions"],"title":"PermissionRequestEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"PinActivityRequest":{"nullable":true,"title":"Pin Activity Request","type":"object"},"PinActivityResponse":{"nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","description":"The pinned activity","title":"Activity","x-stream-index":"001"},"created_at":{"description":"When the activity was pinned","format":"date-time","title":"Created At","type":"number","x-stream-index":"004"},"duration":{"type":"string","x-stream-index":"005.001"},"feed":{"description":"Fully qualified ID of the feed the activity was pinned to","title":"Feed ID","type":"string","x-stream-index":"002"},"user_id":{"description":"ID of the user who pinned the activity","title":"User ID","type":"string","x-stream-index":"003"}},"required":["activity","feed","user_id","created_at","duration"],"title":"Pin Activity Response","type":"object"},"PinRequest":{"description":"PinRequest is the payload for pinning a message.","nullable":true,"properties":{"session_id":{"description":"the session ID of the user who pinned the message","title":"SessionID","type":"string","x-stream-index":"003"},"user_id":{"description":"the user ID of the user who pinned the message","title":"UserID","type":"string","x-stream-index":"002"}},"required":["user_id","session_id"],"title":"PinRequest","type":"object"},"PinResponse":{"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"},"Poll":{"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"023"},"allow_answers":{"type":"boolean","x-stream-index":"010"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"009"},"answers_count":{"format":"int32","type":"integer","x-stream-index":"015"},"created_at":{"format":"date-time","type":"number","x-stream-index":"021"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"020"},"created_by_id":{"type":"string","x-stream-index":"019"},"description":{"type":"string","x-stream-index":"005"},"enforce_unique_vote":{"type":"boolean","x-stream-index":"007"},"id":{"type":"string","x-stream-index":"003"},"is_closed":{"type":"boolean","x-stream-index":"011"},"latest_answers":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array","x-stream-index":"017"},"latest_votes_by_option":{"additionalProperties":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array"},"type":"object","x-stream-index":"016"},"max_votes_allowed":{"format":"int32","type":"integer","x-stream-index":"008"},"name":{"type":"string","x-stream-index":"004"},"options":{"items":{"$ref":"#/components/schemas/PollOption"},"type":"array","x-stream-index":"013"},"own_votes":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array","x-stream-index":"018"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"022"},"vote_count":{"format":"int32","type":"integer","x-stream-index":"012"},"vote_counts_by_option":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"014"},"voting_visibility":{"type":"string","x-stream-index":"006"}},"required":["id","name","description","enforce_unique_vote","allow_user_suggested_options","allow_answers","vote_count","options","vote_counts_by_option","answers_count","latest_votes_by_option","latest_answers","own_votes","created_by_id","created_at","updated_at","Custom"],"type":"object"},"PollClosedEvent":{"description":"Emitted when a poll is closed.","nullable":true,"properties":{"activity_id":{"type":"string","x-stream-index":"001.003"},"cid":{"description":"The CID of the channel containing the poll","title":"Channel CID","type":"string","x-stream-index":"001.001.002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.001.007"},"message_id":{"description":"The ID of the message containing the poll","title":"Message ID","type":"string","x-stream-index":"001.002"},"poll":{"$ref":"#/components/schemas/PollResponseData","description":"The poll object which was closed","title":"Poll","x-stream-index":"001.004"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.001.004"},"type":{"default":"poll.closed","description":"The type of event: \"poll.closed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.001.002"}},"required":["type","created_at","custom","poll"],"title":"PollClosedEvent","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"},"PollClosedFeedEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"001.002.003"},"fid":{"type":"string","x-stream-index":"001.002.002"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001.001"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.002.001.004"},"type":{"default":"feeds.poll.closed","type":"string","x-stream-index":"001.002.001.002"}},"required":["poll","type","created_at","custom","fid"],"title":"PollClosedFeedEvent","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"},"PollDeletedEvent":{"description":"Emitted when a poll is deleted.","nullable":true,"properties":{"activity_id":{"type":"string","x-stream-index":"001.003"},"cid":{"description":"The CID of the channel containing the poll","title":"Channel CID","type":"string","x-stream-index":"001.001.002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.001.007"},"message_id":{"description":"The ID of the message containing the poll","title":"Message ID","type":"string","x-stream-index":"001.002"},"poll":{"$ref":"#/components/schemas/PollResponseData","description":"The poll object which was deleted","title":"Poll","x-stream-index":"001.004"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.001.004"},"type":{"default":"poll.deleted","description":"The type of event: \"poll.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.001.002"}},"required":["type","created_at","custom","poll"],"title":"PollDeletedEvent","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"},"PollDeletedFeedEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"001.002.003"},"fid":{"type":"string","x-stream-index":"001.002.002"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001.001"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.002.001.004"},"type":{"default":"feeds.poll.deleted","type":"string","x-stream-index":"001.002.001.002"}},"required":["poll","type","created_at","custom","fid"],"title":"PollDeletedFeedEvent","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"},"PollOption":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id","text","custom"],"type":"object"},"PollOptionInput":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"text":{"type":"string","x-stream-index":"002"}},"type":"object"},"PollOptionRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id"],"type":"object"},"PollOptionResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"poll_option":{"$ref":"#/components/schemas/PollOptionResponseData","description":"Poll option","title":"PollOptionResponseData","x-stream-index":"001"}},"required":["poll_option","duration"],"type":"object"},"PollOptionResponseData":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id","text","custom"],"type":"object"},"PollResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"poll":{"$ref":"#/components/schemas/PollResponseData","description":"Poll","title":"PollResponseData","x-stream-index":"001"}},"required":["poll","duration"],"type":"object"},"PollResponseData":{"properties":{"allow_answers":{"type":"boolean","x-stream-index":"008"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"007"},"answers_count":{"format":"int32","type":"integer","x-stream-index":"012"},"created_at":{"format":"date-time","type":"number","x-stream-index":"019"},"created_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"018"},"created_by_id":{"type":"string","x-stream-index":"017"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"021"},"description":{"type":"string","x-stream-index":"003"},"enforce_unique_vote":{"type":"boolean","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"is_closed":{"type":"boolean","x-stream-index":"009"},"latest_answers":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array","x-stream-index":"015"},"latest_votes_by_option":{"additionalProperties":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array"},"type":"object","x-stream-index":"014"},"max_votes_allowed":{"format":"int32","type":"integer","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"002"},"options":{"items":{"$ref":"#/components/schemas/PollOptionResponseData"},"type":"array","x-stream-index":"011"},"own_votes":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array","x-stream-index":"016"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"020"},"vote_count":{"format":"int32","type":"integer","x-stream-index":"010"},"vote_counts_by_option":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"013"},"voting_visibility":{"type":"string","x-stream-index":"004"}},"required":["id","name","description","voting_visibility","enforce_unique_vote","allow_user_suggested_options","allow_answers","vote_count","options","answers_count","vote_counts_by_option","latest_votes_by_option","latest_answers","own_votes","created_by_id","created_at","updated_at","custom"],"type":"object"},"PollUpdatedEvent":{"description":"Emitted when a poll is updated.","nullable":true,"properties":{"activity_id":{"type":"string","x-stream-index":"001.003"},"cid":{"description":"The CID of the channel containing the poll","title":"Channel CID","type":"string","x-stream-index":"001.001.002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.001.007"},"message_id":{"description":"The ID of the message containing the poll","title":"Message ID","type":"string","x-stream-index":"001.002"},"poll":{"$ref":"#/components/schemas/PollResponseData","description":"The poll object which was updated","title":"Poll","x-stream-index":"001.004"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.001.004"},"type":{"default":"poll.updated","description":"The type of event: \"poll.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.001.002"}},"required":["type","created_at","custom","poll"],"title":"PollUpdatedEvent","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"},"PollUpdatedFeedEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"001.002.003"},"fid":{"type":"string","x-stream-index":"001.002.002"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001.001"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.002.001.004"},"type":{"default":"feeds.poll.updated","type":"string","x-stream-index":"001.002.001.002"}},"required":["poll","type","created_at","custom","fid"],"title":"PollUpdatedFeedEvent","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"},"PollVote":{"nullable":true,"properties":{"answer_text":{"type":"string","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"004"},"is_answer":{"type":"boolean","x-stream-index":"006"},"option_id":{"type":"string","x-stream-index":"005"},"poll_id":{"type":"string","x-stream-index":"003"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"011"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"009"},"user_id":{"type":"string","x-stream-index":"008"}},"required":["poll_id","id","option_id","created_at","updated_at"],"type":"object"},"PollVoteCastedEvent":{"description":"Emitted when a vote is cast on a poll.","nullable":true,"properties":{"activity_id":{"type":"string","x-stream-index":"001.001.003"},"cid":{"description":"The CID of the channel containing the poll","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":"number","x-stream-index":"001.001.001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.001.001.007"},"message_id":{"description":"The ID of the message containing the poll","title":"Message ID","type":"string","x-stream-index":"001.001.002"},"poll":{"$ref":"#/components/schemas/PollResponseData","description":"The poll object","title":"Poll","x-stream-index":"001.001.004"},"poll_vote":{"$ref":"#/components/schemas/PollVoteResponseData","description":"The vote that was cast","title":"Poll Vote","x-stream-index":"001.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.001.001.004"},"type":{"default":"poll.vote_casted","description":"The type of event: \"poll.vote_casted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.001.001.002"}},"required":["type","created_at","custom","poll","poll_vote"],"title":"PollVoteCastedEvent","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"},"PollVoteCastedFeedEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.001.002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"001.001.002.003"},"fid":{"type":"string","x-stream-index":"001.001.002.002"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001.001.001"},"poll_vote":{"$ref":"#/components/schemas/PollVoteResponseData","x-stream-index":"001.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.002.001.004"},"type":{"default":"feeds.poll.vote_casted","type":"string","x-stream-index":"001.001.002.001.002"}},"required":["poll","type","created_at","custom","fid","poll_vote"],"title":"PollVoteCastedFeedEvent","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"},"PollVoteChangedEvent":{"description":"Emitted when a vote on a poll is changed.","nullable":true,"properties":{"activity_id":{"type":"string","x-stream-index":"001.001.003"},"cid":{"description":"The CID of the channel containing the poll","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":"number","x-stream-index":"001.001.001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.001.001.007"},"message_id":{"description":"The ID of the message containing the poll","title":"Message ID","type":"string","x-stream-index":"001.001.002"},"poll":{"$ref":"#/components/schemas/PollResponseData","description":"The poll object","title":"Poll","x-stream-index":"001.001.004"},"poll_vote":{"$ref":"#/components/schemas/PollVoteResponseData","description":"The updated vote","title":"Poll Vote","x-stream-index":"001.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.001.001.004"},"type":{"default":"poll.vote_changed","description":"The type of event: \"poll.vote_changed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.001.001.002"}},"required":["type","created_at","custom","poll","poll_vote"],"title":"PollVoteChangedEvent","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"},"PollVoteChangedFeedEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.001.002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"001.001.002.003"},"fid":{"type":"string","x-stream-index":"001.001.002.002"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001.001.001"},"poll_vote":{"$ref":"#/components/schemas/PollVoteResponseData","x-stream-index":"001.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.002.001.004"},"type":{"default":"feeds.poll.vote_changed","type":"string","x-stream-index":"001.001.002.001.002"}},"required":["poll","type","created_at","custom","fid","poll_vote"],"title":"PollVoteChangedFeedEvent","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"},"PollVoteRemovedEvent":{"description":"Emitted when a vote is removed from a poll.","nullable":true,"properties":{"activity_id":{"type":"string","x-stream-index":"001.001.003"},"cid":{"description":"The CID of the channel containing the poll","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":"number","x-stream-index":"001.001.001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.001.001.007"},"message_id":{"description":"The ID of the message containing the poll","title":"Message ID","type":"string","x-stream-index":"001.001.002"},"poll":{"$ref":"#/components/schemas/PollResponseData","description":"The poll object","title":"Poll","x-stream-index":"001.001.004"},"poll_vote":{"$ref":"#/components/schemas/PollVoteResponseData","description":"The vote that was removed","title":"Poll Vote","x-stream-index":"001.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.001.001.004"},"type":{"default":"poll.vote_removed","description":"The type of event: \"poll.vote_removed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.001.001.002"}},"required":["type","created_at","custom","poll","poll_vote"],"title":"PollVoteRemovedEvent","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"},"PollVoteRemovedFeedEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.001.002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"001.001.002.003"},"fid":{"type":"string","x-stream-index":"001.001.002.002"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001.001.001"},"poll_vote":{"$ref":"#/components/schemas/PollVoteResponseData","x-stream-index":"001.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.002.001.004"},"type":{"default":"feeds.poll.vote_removed","type":"string","x-stream-index":"001.001.002.001.002"}},"required":["poll","type","created_at","custom","fid","poll_vote"],"title":"PollVoteRemovedFeedEvent","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"},"PollVoteResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"vote":{"$ref":"#/components/schemas/PollVoteResponseData","description":"Poll vote","title":"PollVoteResponseData","x-stream-index":"001"}},"required":["duration"],"type":"object"},"PollVoteResponseData":{"nullable":true,"properties":{"answer_text":{"type":"string","x-stream-index":"005"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"id":{"type":"string","x-stream-index":"002"},"is_answer":{"type":"boolean","x-stream-index":"004"},"option_id":{"type":"string","x-stream-index":"003"},"poll_id":{"type":"string","x-stream-index":"001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"007"},"user_id":{"type":"string","x-stream-index":"006"}},"required":["poll_id","id","option_id","created_at","updated_at"],"type":"object"},"PollVotesResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"votes":{"description":"Poll votes","items":{"$ref":"#/components/schemas/PollVoteResponseData"},"title":"PollVoteResponseList","type":"array","x-stream-index":"001"}},"required":["votes","duration"],"type":"object"},"PrivacySettings":{"properties":{"read_receipts":{"$ref":"#/components/schemas/ReadReceipts","x-stream-index":"002"},"typing_indicators":{"$ref":"#/components/schemas/TypingIndicators","x-stream-index":"001"}},"type":"object"},"PrivacySettingsResponse":{"properties":{"read_receipts":{"$ref":"#/components/schemas/ReadReceiptsResponse","x-stream-index":"002"},"typing_indicators":{"$ref":"#/components/schemas/TypingIndicatorsResponse","x-stream-index":"001"}},"type":"object"},"PublisherStatsResponse":{"properties":{"by_track":{"items":{"$ref":"#/components/schemas/TrackStatsResponse"},"type":"array","x-stream-index":"003"},"total":{"format":"int32","type":"integer","x-stream-index":"001"},"unique":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["total","unique"],"type":"object"},"PushNotificationConfig":{"properties":{"activity_types":{"items":{"type":"string"},"type":"array","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"PushPreferenceInput":{"nullable":true,"properties":{"call_level":{"description":"Set the level of call push notifications for the user. One of all, none, default","enum":["all","none","default"],"type":"string","x-stream-index":"004"},"channel_cid":{"description":"Set the push preferences for a specific channel. If empty it sets the default for the user","type":"string","x-stream-index":"002"},"chat_level":{"description":"Set the level of chat push notifications for the user. One of all, mentions, none, default","enum":["all","mentions","none","default"],"type":"string","x-stream-index":"003"},"disabled_until":{"description":"Disable push notifications till a certain time","format":"date-time","type":"number","x-stream-index":"007"},"feeds_events":{"$ref":"#/components/schemas/FeedsEventPreferencesInput","description":"Set granular feeds event preferences for reactions, comments, new followers, and mentions","x-stream-index":"006"},"feeds_level":{"description":"Set the level of feeds push notifications for the user. One of all, none, default","enum":["all","none","default"],"type":"string","x-stream-index":"005"},"remove_disable":{"description":"Remove the disabled until time. (IE stop snoozing notifications)","type":"boolean","x-stream-index":"008"},"user_id":{"description":"The user id for which to set the push preferences. Required when using server side auths, defaults to current user with client side auth.","type":"string","x-stream-index":"001"}},"type":"object"},"PushPreferences":{"properties":{"call_level":{"type":"string","x-stream-index":"002"},"chat_level":{"type":"string","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"number","x-stream-index":"005"},"feeds_events":{"$ref":"#/components/schemas/FeedsEventPreferences","x-stream-index":"004"},"feeds_level":{"type":"string","x-stream-index":"003"}},"type":"object"},"Quality":{"properties":{"bitdepth":{"format":"int32","type":"integer","x-stream-index":"007"},"framerate":{"format":"int32","type":"integer","x-stream-index":"008"},"height":{"format":"int32","type":"integer","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"004"},"video_bitrate":{"format":"int32","type":"integer","x-stream-index":"009"},"width":{"format":"int32","type":"integer","x-stream-index":"005"}},"type":"object"},"QualityScoreReport":{"properties":{"histogram":{"items":{"$ref":"#/components/schemas/ReportByHistogramBucket"},"type":"array","x-stream-index":"001"}},"required":["histogram"],"type":"object"},"QualityScoreReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateQualityScoreReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"QueryActivitiesRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filters to apply to the query. Supports location-based queries with 'near' and 'within_bounds' operators.","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"Sorting parameters for the query","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"002"}},"title":"Query Activities Request","type":"object"},"QueryActivitiesResponse":{"nullable":true,"properties":{"activities":{"description":"List of activities matching the query","items":{"$ref":"#/components/schemas/ActivityResponse"},"title":"Activities","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"next":{"description":"Cursor for next page","title":"Next","type":"string","x-stream-index":"002.001"},"prev":{"description":"Cursor for previous page","title":"Previous","type":"string","x-stream-index":"002.002"}},"required":["activities","duration"],"title":"Query Activities Response","type":"object"},"QueryActivityReactionsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"type":"object","x-stream-index":"002"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"004.001"},"next":{"type":"string","x-stream-index":"004.002"},"prev":{"type":"string","x-stream-index":"004.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"type":"array","x-stream-index":"003"}},"type":"object"},"QueryActivityReactionsResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"reactions":{"items":{"$ref":"#/components/schemas/FeedsReactionResponse"},"type":"array","x-stream-index":"001"}},"required":["reactions","duration"],"title":"Response","type":"object"},"QueryAggregateCallStatsRequest":{"nullable":true,"properties":{"from":{"type":"string","x-stream-index":"002"},"report_types":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"to":{"type":"string","x-stream-index":"003"}},"type":"object"},"QueryAggregateCallStatsResponse":{"description":"Basic response information","nullable":true,"properties":{"call_duration_report":{"$ref":"#/components/schemas/CallDurationReportResponse","x-stream-index":"002"},"call_participant_count_report":{"$ref":"#/components/schemas/CallParticipantCountReportResponse","x-stream-index":"004"},"calls_per_day_report":{"$ref":"#/components/schemas/CallsPerDayReportResponse","x-stream-index":"003"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"network_metrics_report":{"$ref":"#/components/schemas/NetworkMetricsReportResponse","x-stream-index":"008"},"quality_score_report":{"$ref":"#/components/schemas/QualityScoreReportResponse","x-stream-index":"005"},"sdk_usage_report":{"$ref":"#/components/schemas/SDKUsageReportResponse","x-stream-index":"006"},"user_feedback_report":{"$ref":"#/components/schemas/UserFeedbackReportResponse","x-stream-index":"007"}},"required":["duration"],"title":"Response","type":"object"},"QueryBannedUsersPayload":{"properties":{"exclude_expired_bans":{"description":"Whether to exclude expired bans or not","title":"Exclude expired bans","type":"boolean","x-stream-index":"004"},"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"description":"Number of records to return","format":"int32","maximum":300,"minimum":0,"title":"Limit","type":"integer","x-stream-index":"003.003"},"offset":{"description":"Number of records to offset","format":"int32","maximum":10000,"title":"Offset","type":"integer","x-stream-index":"003.004"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":1,"title":"Sort","type":"array","x-stream-index":"002"}},"required":["filter_conditions"],"type":"object"},"QueryBannedUsersResponse":{"nullable":true,"properties":{"bans":{"description":"List of found bans","items":{"$ref":"#/components/schemas/BanResponse"},"title":"BanResponse","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["bans","duration"],"type":"object"},"QueryBookmarkFoldersRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filters to apply to the query","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"Sorting parameters for the query","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"002"}},"title":"Query Bookmark Folders Request","type":"object"},"QueryBookmarkFoldersResponse":{"nullable":true,"properties":{"bookmark_folders":{"description":"List of bookmark folders matching the query","items":{"$ref":"#/components/schemas/BookmarkFolderResponse"},"title":"Bookmark Folders","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"next":{"description":"Cursor for next page","title":"Next","type":"string","x-stream-index":"002.001"},"prev":{"description":"Cursor for previous page","title":"Previous","type":"string","x-stream-index":"002.002"}},"required":["bookmark_folders","duration"],"title":"Query Bookmark Folders Response","type":"object"},"QueryBookmarksRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filters to apply to the query","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"Sorting parameters for the query","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"002"}},"title":"Query Bookmarks Request","type":"object"},"QueryBookmarksResponse":{"nullable":true,"properties":{"bookmarks":{"description":"List of bookmarks matching the query","items":{"$ref":"#/components/schemas/BookmarkResponse"},"title":"Bookmarks","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"next":{"description":"Cursor for next page","title":"Next","type":"string","x-stream-index":"002.001"},"prev":{"description":"Cursor for previous page","title":"Previous","type":"string","x-stream-index":"002.002"}},"required":["bookmarks","duration"],"title":"Query Bookmarks Response","type":"object"},"QueryCallMembersRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"002"},"id":{"maxLength":64,"type":"string","x-stream-index":"001.002"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"004.001"},"next":{"type":"string","x-stream-index":"004.002"},"prev":{"type":"string","x-stream-index":"004.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":1,"type":"array","x-stream-index":"003"},"type":{"maxLength":64,"type":"string","x-stream-index":"001.001"}},"required":["type","id"],"type":"object"},"QueryCallMembersResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["members","duration"],"title":"Response","type":"object"},"QueryCallParticipantsRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"003"}},"type":"object"},"QueryCallParticipantsResponse":{"nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001.001"},"duration":{"type":"string","x-stream-index":"004.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001.002"},"membership":{"$ref":"#/components/schemas/MemberResponse","x-stream-index":"001.003"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"001.004"},"participants":{"description":"List of call participants","items":{"$ref":"#/components/schemas/CallParticipantResponse"},"title":"[]CallParticipantResponse","type":"array","x-stream-index":"002"},"total_participants":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["call","members","own_capabilities","blocked_users","participants","total_participants","duration"],"type":"object"},"QueryCallStatsRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"004.001"},"next":{"type":"string","x-stream-index":"004.002"},"prev":{"type":"string","x-stream-index":"004.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":2,"type":"array","x-stream-index":"002"}},"type":"object"},"QueryCallStatsResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"next":{"type":"string","x-stream-index":"003.001"},"prev":{"type":"string","x-stream-index":"003.002"},"reports":{"items":{"$ref":"#/components/schemas/CallStatsReportSummaryResponse"},"type":"array","x-stream-index":"001"}},"required":["reports","duration"],"title":"Response","type":"object"},"QueryCallsRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"title":"Filters","type":"object","x-stream-index":"003"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"006.001"},"next":{"type":"string","x-stream-index":"006.002"},"prev":{"type":"string","x-stream-index":"006.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":2,"title":"Sort","type":"array","x-stream-index":"004"},"watch":{"title":"Watch","type":"boolean","x-stream-index":"001"}},"title":"QueryCallsRequest","type":"object"},"QueryCallsResponse":{"nullable":true,"properties":{"calls":{"items":{"$ref":"#/components/schemas/CallStateResponseFields"},"title":"Calls","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["calls","duration"],"title":"QueryCallsResponse","type":"object"},"QueryChannelsRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"description":"Number of channels to limit","format":"int32","title":"Limit","type":"integer","x-stream-index":"008"},"member_limit":{"description":"Number of members to limit","format":"int32","maximum":100,"minimum":0,"title":"Member limit","type":"integer","x-stream-index":"007"},"message_limit":{"description":"Number of messages to limit","format":"int32","minimum":0,"title":"Message limit","type":"integer","x-stream-index":"006"},"offset":{"description":"Channel pagination offset","format":"int32","title":"Offset","type":"integer","x-stream-index":"009"},"presence":{"title":"Presence","type":"boolean","x-stream-index":"005"},"sort":{"description":"List of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"002"},"state":{"description":"Whether to update channel state or not","title":"State","type":"boolean","x-stream-index":"004"},"watch":{"description":"Whether to start watching found channels or not","title":"Watch","type":"boolean","x-stream-index":"003"}},"title":"Query Channels Request","type":"object","x-stream-docs-page-id":"query_channels"},"QueryChannelsResponse":{"nullable":true,"properties":{"channels":{"description":"List of channels","items":{"$ref":"#/components/schemas/ChannelStateResponseFields"},"title":"Channels","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["channels","duration"],"title":"Channels list","type":"object"},"QueryCommentReactionsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"type":"object","x-stream-index":"002"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"004.001"},"next":{"type":"string","x-stream-index":"004.002"},"prev":{"type":"string","x-stream-index":"004.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"type":"array","x-stream-index":"003"}},"type":"object"},"QueryCommentReactionsResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"reactions":{"items":{"$ref":"#/components/schemas/FeedsReactionResponse"},"type":"array","x-stream-index":"001"}},"required":["reactions","duration"],"title":"Response","type":"object"},"QueryCommentsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"MongoDB-style filter for querying comments","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"description":"Maximum number of comments to return","format":"int32","maximum":100,"minimum":0,"title":"Limit","type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"first (oldest), last (newest) or top","enum":["first","last","top","best","controversial"],"title":"Sort Order","type":"string","x-stream-index":"002"}},"required":["filter"],"title":"Query Comments Request","type":"object"},"QueryCommentsResponse":{"nullable":true,"properties":{"comments":{"description":"List of comments matching the query","items":{"$ref":"#/components/schemas/CommentResponse"},"title":"Comments","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"next":{"description":"Cursor for next page","title":"Next","type":"string","x-stream-index":"002.001"},"prev":{"description":"Cursor for previous page","title":"Previous","type":"string","x-stream-index":"002.002"}},"required":["comments","duration"],"title":"Query Comments Response","type":"object"},"QueryDraftsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","maximum":3,"title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"002"}},"type":"object"},"QueryDraftsResponse":{"nullable":true,"properties":{"drafts":{"description":"Drafts","items":{"$ref":"#/components/schemas/DraftResponse"},"title":"DraftsResponseList","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["drafts","duration"],"type":"object"},"QueryFeedMembersRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter parameters for the query","title":"object","type":"object","x-stream-index":"003"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Sort parameters for the query","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"array","type":"array","x-stream-index":"004"}},"type":"object"},"QueryFeedMembersResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"003.001"},"members":{"description":"List of feed members","items":{"$ref":"#/components/schemas/FeedMemberResponse"},"title":"array","type":"array","x-stream-index":"001"},"next":{"description":"Cursor for next page","title":"Next","type":"string","x-stream-index":"002.001"},"prev":{"description":"Cursor for previous page","title":"Previous","type":"string","x-stream-index":"002.002"}},"required":["members","duration"],"type":"object"},"QueryFeedsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filters to apply to the query","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"004.001"},"next":{"type":"string","x-stream-index":"004.002"},"prev":{"type":"string","x-stream-index":"004.003"},"sort":{"description":"Sorting parameters for the query","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"003"},"watch":{"description":"Whether to subscribe to realtime updates","title":"Watch","type":"boolean","x-stream-index":"002"}},"title":"Query Feeds Request","type":"object"},"QueryFeedsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"003.001"},"feeds":{"description":"List of feeds matching the query","items":{"$ref":"#/components/schemas/FeedResponse"},"title":"Feeds","type":"array","x-stream-index":"001"},"next":{"description":"Cursor for next page","title":"Next","type":"string","x-stream-index":"002.001"},"prev":{"description":"Cursor for previous page","title":"Previous","type":"string","x-stream-index":"002.002"}},"required":["feeds","duration"],"title":"Query Feeds Response","type":"object"},"QueryFollowsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filters to apply to the query","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"Sorting parameters for the query","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"002"}},"title":"Query Follows Request","type":"object"},"QueryFollowsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"003.001"},"follows":{"description":"List of follow relationships matching the query","items":{"$ref":"#/components/schemas/FollowResponse"},"title":"Follows","type":"array","x-stream-index":"001"},"next":{"description":"Cursor for next page","title":"Next","type":"string","x-stream-index":"002.001"},"prev":{"description":"Cursor for previous page","title":"Previous","type":"string","x-stream-index":"002.002"}},"required":["follows","duration"],"title":"Query Follows Response","type":"object"},"QueryMembersPayload":{"description":"Client request","properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"002"},"limit":{"format":"int32","maximum":300,"minimum":0,"type":"integer","x-stream-index":"006.003"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"type":"array","x-stream-index":"003"},"offset":{"format":"int32","maximum":10000,"type":"integer","x-stream-index":"006.004"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":1,"type":"array","x-stream-index":"005"},"type":{"maxLength":64,"type":"string","x-stream-index":"001"}},"required":["type","filter_conditions"],"title":"ClientRequest","type":"object"},"QueryMessageFlagsPayload":{"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":300,"minimum":0,"type":"integer","x-stream-index":"003.003"},"offset":{"format":"int32","maximum":10000,"type":"integer","x-stream-index":"003.004"},"show_deleted_messages":{"description":"Whether to include deleted messages in the results","title":"ShowDeletedMessages","type":"boolean","x-stream-index":"002"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"type":"array","x-stream-index":"003.005"}},"type":"object"},"QueryMessageFlagsResponse":{"description":"Query message flags response","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"flags":{"description":"The flags that match the query","items":{"$ref":"#/components/schemas/MessageFlagResponse"},"title":"MessageFlagResponseList","type":"array","x-stream-index":"001"}},"required":["flags","duration"],"title":"QueryMessageFlagsResponse","type":"object"},"QueryModerationConfigsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter conditions for moderation configs","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"Sorting parameters for the results","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"002"}},"type":"object"},"QueryModerationConfigsResponse":{"nullable":true,"properties":{"configs":{"description":"List of moderation configurations","items":{"$ref":"#/components/schemas/ConfigResponse"},"title":"Configs","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["configs","duration"],"type":"object"},"QueryPollVotesRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","title":"Filter","type":"object","x-stream-index":"003"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"004"}},"type":"object"},"QueryPollsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","title":"Filter","type":"object","x-stream-index":"002"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"003"}},"type":"object"},"QueryPollsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"polls":{"description":"Polls data returned by the query","items":{"$ref":"#/components/schemas/PollResponseData"},"title":"PollsResponseData","type":"array","x-stream-index":"001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["polls","duration"],"type":"object"},"QueryReactionsRequest":{"properties":{"filter":{"additionalProperties":{},"type":"object","x-stream-index":"002"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"006.001"},"next":{"type":"string","x-stream-index":"006.002"},"prev":{"type":"string","x-stream-index":"006.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":2,"type":"array","x-stream-index":"003"}},"type":"object"},"QueryReactionsResponse":{"description":"Basic response information","properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"next":{"type":"string","x-stream-index":"003.001"},"prev":{"type":"string","x-stream-index":"003.002"},"reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"001"}},"required":["reactions","duration"],"title":"Response","type":"object"},"QueryRemindersRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"002"}},"type":"object"},"QueryRemindersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"reminders":{"description":"MessageReminders data returned by the query","items":{"$ref":"#/components/schemas/ReminderResponseData"},"title":"RemindersResponseData","type":"array","x-stream-index":"001"}},"required":["reminders","duration"],"type":"object"},"QueryReviewQueueRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter conditions for review queue items","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"007.001"},"lock_count":{"description":"Number of items to lock (1-25)","format":"int32","maximum":25,"minimum":1,"title":"Lock Count","type":"integer","x-stream-index":"005"},"lock_duration":{"description":"Duration for which items should be locked","title":"Lock Duration","type":"integer","x-stream-index":"004"},"lock_items":{"description":"Whether to lock items for review (true), unlock items (false), or just fetch (nil)","title":"Lock Items","type":"boolean","x-stream-index":"003"},"next":{"type":"string","x-stream-index":"007.002"},"prev":{"type":"string","x-stream-index":"007.003"},"sort":{"description":"Sorting parameters for the results","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"002"},"stats_only":{"description":"Whether to return only statistics","title":"Stats Only","type":"boolean","x-stream-index":"006"}},"type":"object"},"QueryReviewQueueResponse":{"nullable":true,"properties":{"action_config":{"additionalProperties":{"items":{"$ref":"#/components/schemas/ModerationActionConfig"},"type":"array"},"description":"Configuration for moderation actions","title":"Action Config","type":"object","x-stream-index":"002"},"duration":{"type":"string","x-stream-index":"005.001"},"items":{"description":"List of review queue items","items":{"$ref":"#/components/schemas/ReviewQueueItemResponse"},"title":"Items","type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"004.001"},"prev":{"type":"string","x-stream-index":"004.002"},"stats":{"additionalProperties":{},"description":"Statistics about the review queue","title":"Stats","type":"object","x-stream-index":"003"}},"required":["items","action_config","stats","duration"],"type":"object"},"QueryThreadsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter conditions to apply to threads","title":"Filter","type":"object","x-stream-index":"006"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"008.001"},"member_limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005"},"next":{"type":"string","x-stream-index":"008.002"},"participant_limit":{"description":"Limit the number of participants returned per each thread","format":"int32","maximum":100,"minimum":0,"title":"Participant limit","type":"integer","x-stream-index":"004"},"prev":{"type":"string","x-stream-index":"008.003"},"reply_limit":{"description":"Limit the number of replies returned per each thread","format":"int32","maximum":10,"minimum":0,"title":"Reply limit","type":"integer","x-stream-index":"003"},"sort":{"description":"Sort conditions to apply to threads","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"007"},"watch":{"description":"Start watching the channel this thread belongs to","title":"Watch","type":"boolean","x-stream-index":"001"}},"type":"object"},"QueryThreadsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"threads":{"description":"List of enriched thread states","items":{"$ref":"#/components/schemas/ThreadStateResponse"},"title":"Threads","type":"array","x-stream-index":"001"}},"required":["threads","duration"],"type":"object"},"QueryUsersPayload":{"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"include_deactivated_users":{"type":"boolean","x-stream-index":"004"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.003"},"offset":{"format":"int32","maximum":1000,"type":"integer","x-stream-index":"005.004"},"presence":{"type":"boolean","x-stream-index":"003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"type":"array","x-stream-index":"002"}},"required":["filter_conditions"],"type":"object"},"QueryUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"users":{"description":"Array of users as result of filters applied.","items":{"$ref":"#/components/schemas/FullUserResponse"},"title":"Users","type":"array","x-stream-index":"001"}},"required":["users","duration"],"type":"object"},"RTMPBroadcastRequest":{"description":"RTMPBroadcastRequest is the payload for starting an RTMP broadcast.","properties":{"layout":{"$ref":"#/components/schemas/LayoutSettingsRequest","description":"If provided, will override the call's RTMP settings layout","title":"Layout","x-stream-index":"005"},"name":{"description":"Name identifier for RTMP broadcast, must be unique in call","maxLength":255,"title":"Name","type":"string","x-stream-index":"001"},"quality":{"description":"If provided, will override the call's RTMP settings quality","enum":["360p","480p","720p","1080p","1440p","portrait-360x640","portrait-480x854","portrait-720x1280","portrait-1080x1920","portrait-1440x2560"],"title":"Quality","type":"string","x-stream-index":"004"},"stream_key":{"description":"If provided, will be appended at the end of stream_url","title":"Stream Key","type":"string","x-stream-index":"003"},"stream_url":{"description":"URL for the RTMP server to send the call to","maxLength":255,"title":"Stream URL","type":"string","x-stream-index":"002"}},"required":["name","stream_url"],"title":"RTMPBroadcastRequest","type":"object"},"RTMPEgressConfig":{"properties":{"composite_app_settings":{"$ref":"#/components/schemas/CompositeAppSettings","x-stream-index":"005"},"quality":{"$ref":"#/components/schemas/Quality","x-stream-index":"004"},"rtmp_location":{"type":"string","x-stream-index":"006"}},"type":"object"},"RTMPIngress":{"description":"RTMP input settings","properties":{"address":{"title":"Address","type":"string","x-stream-index":"001"}},"required":["address"],"title":"RTMPIngress","type":"object"},"RTMPLocation":{"properties":{"name":{"type":"string","x-stream-index":"001"},"stream_key":{"type":"string","x-stream-index":"003"},"stream_url":{"type":"string","x-stream-index":"002"}},"required":["name","stream_url","stream_key"],"type":"object"},"RTMPSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"003"},"location":{"$ref":"#/components/schemas/RTMPLocation","x-stream-index":"004"},"quality_name":{"type":"string","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"RTMPSettingsRequest":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"quality":{"description":"Resolution to set for the RTMP stream","enum":["360p","480p","720p","1080p","1440p","portrait-360x640","portrait-480x854","portrait-720x1280","portrait-1080x1920","portrait-1440x2560"],"title":"Quality","type":"string","x-stream-index":"002"}},"title":"RTMPSettingsRequest","type":"object"},"RTMPSettingsResponse":{"description":"RTMPSettingsResponse is the payload for RTMP settings","properties":{"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"001"},"quality":{"title":"Quality","type":"string","x-stream-index":"002"}},"required":["enabled","quality","layout"],"title":"RTMPSettingsResponse","type":"object"},"RankingConfig":{"properties":{"defaults":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"functions":{"additionalProperties":{"$ref":"#/components/schemas/DecayFunctionConfig"},"type":"object","x-stream-index":"004"},"score":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"001"}},"type":"object"},"Reaction":{"nullable":true,"properties":{"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"message_id":{"type":"string","x-stream-index":"003"},"score":{"format":"int32","type":"integer","x-stream-index":"007"},"type":{"maxLength":30,"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["message_id","type","score","created_at","updated_at","custom"],"type":"object"},"ReactionDeletedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"006.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"002"},"team":{"type":"string","x-stream-index":"005.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"reaction.deleted","type":"string","x-stream-index":"006.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"ReactionDeletedEvent","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"},"ReactionGroupResponse":{"description":"ReactionGroupResponse contains all information about a reaction of the same type.","nullable":true,"properties":{"count":{"description":"Count is the number of reactions of this type.","format":"int32","title":"Count","type":"integer","x-stream-index":"001"},"first_reaction_at":{"description":"FirstReactionAt is the time of the first reaction of this type. This is the same also if all reaction of this type are deleted, because if someone will react again with the same type, will be preserved the sorting.","format":"date-time","title":"FirstReactionAt","type":"number","x-stream-index":"003"},"last_reaction_at":{"description":"LastReactionAt is the time of the last reaction of this type.","format":"date-time","title":"LastReactionAt","type":"number","x-stream-index":"004"},"sum_scores":{"description":"SumScores is the sum of all scores of reactions of this type. Medium allows you to clap articles more than once and shows the sum of all claps from all users. For example, you can send `clap` x5 using `score: 5`.","format":"int32","title":"SumScores","type":"integer","x-stream-index":"002"}},"required":["count","sum_scores","first_reaction_at","last_reaction_at"],"title":"ReactionGroupResponse","type":"object"},"ReactionNewEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"006.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"002"},"team":{"type":"string","x-stream-index":"005.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"reaction.new","type":"string","x-stream-index":"006.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"ReactionNewEvent","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"},"ReactionRequest":{"description":"Represents user reaction to a message","properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"score":{"description":"Reaction score. If not specified reaction has score of 1","format":"int32","title":"Score","type":"integer","x-stream-index":"002"},"type":{"description":"The type of reaction (e.g. 'like', 'laugh', 'wow')","maxLength":30,"title":"Type","type":"string","x-stream-index":"001"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"004"}},"required":["type"],"title":"Reaction","type":"object","x-stream-docs-page-id":"send_reaction"},"ReactionResponse":{"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"006"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"008"},"message_id":{"description":"Message ID","title":"Message ID","type":"string","x-stream-index":"001"},"score":{"description":"Score of the reaction","format":"int32","title":"Score","type":"integer","x-stream-index":"005"},"type":{"description":"Type of reaction","title":"Type","type":"string","x-stream-index":"004"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"007"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User","title":"UserResponse","x-stream-index":"003"},"user_id":{"description":"User ID","title":"User ID","type":"string","x-stream-index":"002"}},"required":["message_id","user_id","user","type","score","created_at","updated_at","custom"],"type":"object"},"ReactionUpdatedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"006.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"002"},"team":{"type":"string","x-stream-index":"005.001"},"type":{"default":"reaction.updated","type":"string","x-stream-index":"006.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["message","reaction","cid","channel_id","channel_type","type","created_at"],"title":"ReactionUpdatedEvent","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"},"ReadReceipts":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"ReadReceiptsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"ReadStateResponse":{"properties":{"last_read":{"format":"date-time","type":"number","x-stream-index":"002"},"last_read_message_id":{"type":"string","x-stream-index":"004"},"unread_messages":{"format":"int32","type":"integer","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"}},"required":["user","last_read","unread_messages"],"type":"object"},"RecordSettings":{"properties":{"audio_only":{"type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"004"},"mode":{"type":"string","x-stream-index":"002"},"quality":{"type":"string","x-stream-index":"003"}},"required":["mode"],"type":"object"},"RecordSettingsRequest":{"properties":{"audio_only":{"type":"boolean","x-stream-index":"001"},"mode":{"enum":["available","disabled","auto-on"],"title":"Mode","type":"string","x-stream-index":"002"},"quality":{"enum":["360p","480p","720p","1080p","1440p","portrait-360x640","portrait-480x854","portrait-720x1280","portrait-1080x1920","portrait-1440x2560"],"type":"string","x-stream-index":"003"}},"required":["mode"],"title":"RecordSettingsRequest","type":"object"},"RecordSettingsResponse":{"description":"RecordSettings is the payload for recording settings","properties":{"audio_only":{"title":"Audio Only","type":"boolean","x-stream-index":"001"},"mode":{"title":"Mode","type":"string","x-stream-index":"002"},"quality":{"title":"Quality","type":"string","x-stream-index":"003"}},"required":["audio_only","mode","quality","layout"],"title":"RecordSettingsResponse","type":"object"},"RecordingEgressConfig":{"properties":{"audio_only":{"type":"boolean","x-stream-index":"006"},"composite_app_settings":{"$ref":"#/components/schemas/CompositeAppSettings","x-stream-index":"005"},"external_storage":{"$ref":"#/components/schemas/ExternalStorage","x-stream-index":"008"},"quality":{"$ref":"#/components/schemas/Quality","x-stream-index":"004"},"storage_name":{"type":"string","x-stream-index":"007"},"video_orientation_hint":{"$ref":"#/components/schemas/VideoOrientation","x-stream-index":"009"}},"type":"object"},"RejectCallRequest":{"nullable":true,"properties":{"reason":{"description":"Reason for rejecting the call","title":"Reason","type":"string","x-stream-index":"003"}},"title":"RejectCallRequest","type":"object"},"RejectCallResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"RejectCallResponse","type":"object"},"RejectFeedMemberInviteRequest":{"nullable":true,"title":"Reject Feed Member Request","type":"object"},"RejectFeedMemberInviteResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"member":{"$ref":"#/components/schemas/FeedMemberResponse","description":"The feed member after rejecting the invite","title":"Feed Member","x-stream-index":"001"}},"required":["member","duration"],"title":"Reject Feed Member Response","type":"object"},"RejectFollowRequest":{"nullable":true,"properties":{"source":{"description":"Fully qualified ID of the source feed","maxLength":255,"title":"Source Feed ID","type":"string","x-stream-index":"001"},"target":{"description":"Fully qualified ID of the target feed","maxLength":255,"title":"Target Feed ID","type":"string","x-stream-index":"002"}},"required":["source","target"],"title":"Reject Follow Request","type":"object"},"RejectFollowResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"follow":{"$ref":"#/components/schemas/FollowResponse","description":"The rejected follow relationship","title":"Follow","x-stream-index":"001"}},"required":["follow","duration"],"title":"Reject Follow Response","type":"object"},"ReminderCreatedEvent":{"description":"Emitted when a reminder is created.","nullable":true,"properties":{"cid":{"description":"The CID of the Channel for which the reminder was created","title":"Channel CID","type":"string","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.007"},"message_id":{"description":"The ID of the message for which the reminder was created","title":"Message ID","type":"string","x-stream-index":"001.002"},"parent_id":{"description":"The ID of the parent message, if the reminder is for a thread message","title":"Parent ID","type":"string","x-stream-index":"001.005"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","description":"The reminder object which was created","title":"MessageReminder","x-stream-index":"001.006"},"type":{"default":"reminder.created","description":"The type of event: \"reminder.created\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.002"},"user_id":{"description":"The ID of the user for whom the reminder was created","title":"User ID","type":"string","x-stream-index":"001.003"}},"required":["type","created_at","custom","message_id","user_id","cid"],"title":"ReminderCreatedEvent","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"},"ReminderDeletedEvent":{"description":"Emitted when a reminder is deleted.","nullable":true,"properties":{"cid":{"description":"The CID of the Channel for which the reminder was created","title":"Channel CID","type":"string","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.007"},"message_id":{"description":"The ID of the message for which the reminder was created","title":"Message ID","type":"string","x-stream-index":"001.002"},"parent_id":{"description":"The ID of the parent message, if the reminder is for a thread message","title":"Parent ID","type":"string","x-stream-index":"001.005"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","description":"The reminder object which was created","title":"MessageReminder","x-stream-index":"001.006"},"type":{"default":"reminder.deleted","description":"The type of event: \"reminder.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.002"},"user_id":{"description":"The ID of the user for whom the reminder was created","title":"User ID","type":"string","x-stream-index":"001.003"}},"required":["type","created_at","custom","message_id","user_id","cid"],"title":"ReminderDeletedEvent","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"},"ReminderNotificationEvent":{"description":"Emitted when a reminder becomes due, triggering a notification for the user.","nullable":true,"properties":{"cid":{"description":"The CID of the Channel for which the reminder was created","title":"Channel CID","type":"string","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.007"},"message_id":{"description":"The ID of the message for which the reminder was created","title":"Message ID","type":"string","x-stream-index":"001.002"},"parent_id":{"type":"string","x-stream-index":"001.005"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","description":"The reminder object which was created","title":"MessageReminder","x-stream-index":"001.006"},"type":{"default":"notification.reminder_due","description":"The type of event: \"notification.reminder_due\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.002"},"user_id":{"description":"The ID of the user for whom the reminder was created","title":"User ID","type":"string","x-stream-index":"001.003"}},"required":["type","created_at","custom","message_id","user_id","cid"],"title":"ReminderNotificationEvent","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"},"ReminderResponseData":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003"},"channel_cid":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"005"},"message_id":{"type":"string","x-stream-index":"004"},"remind_at":{"format":"date-time","type":"number","x-stream-index":"001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007"},"user_id":{"type":"string","x-stream-index":"006"}},"required":["channel_cid","message_id","user_id","created_at","updated_at"],"type":"object"},"ReminderUpdatedEvent":{"description":"Emitted when a reminder is updated.","nullable":true,"properties":{"cid":{"description":"The CID of the Channel for which the reminder was created","title":"Channel CID","type":"string","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.007"},"message_id":{"description":"The ID of the message for which the reminder was created","title":"Message ID","type":"string","x-stream-index":"001.002"},"parent_id":{"description":"The ID of the parent message, if the reminder is for a thread message","title":"Parent ID","type":"string","x-stream-index":"001.005"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","description":"The reminder object which was created","title":"MessageReminder","x-stream-index":"001.006"},"type":{"default":"reminder.updated","description":"The type of event: \"reminder.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.002"},"user_id":{"description":"The ID of the user for whom the reminder was created","title":"User ID","type":"string","x-stream-index":"001.003"}},"required":["type","created_at","custom","message_id","user_id","cid"],"title":"ReminderUpdatedEvent","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"},"RepliesMeta":{"description":"Cursor \u0026 depth information for a comment's direct replies. Mirrors Reddit's 'load more replies' semantics.","properties":{"depth_truncated":{"description":"True if the subtree was cut because the requested depth was reached.","title":"Depth Truncated","type":"boolean","x-stream-index":"004"},"has_more":{"description":"True if more siblings exist in the database.","title":"Has More","type":"boolean","x-stream-index":"001"},"next_cursor":{"description":"Opaque cursor to request the next page of siblings.","title":"Next Cursor","type":"string","x-stream-index":"002"},"remaining":{"description":"Number of unread siblings that match current filters.","format":"int32","title":"Remaining","type":"integer","x-stream-index":"003"}},"required":["has_more","remaining","depth_truncated"],"title":"Replies Meta","type":"object"},"ReportByHistogramBucket":{"properties":{"category":{"type":"string","x-stream-index":"001"},"count":{"format":"int32","type":"integer","x-stream-index":"005"},"lower_bound":{"$ref":"#/components/schemas/Bound","x-stream-index":"002"},"sum":{"format":"float","type":"number","x-stream-index":"004"},"upper_bound":{"$ref":"#/components/schemas/Bound","x-stream-index":"003"}},"required":["category","sum","count"],"type":"object"},"ReportResponse":{"properties":{"call":{"$ref":"#/components/schemas/CallReportResponse","x-stream-index":"003"},"participants":{"$ref":"#/components/schemas/ParticipantReportResponse","x-stream-index":"001"},"user_ratings":{"$ref":"#/components/schemas/UserRatingReportResponse","x-stream-index":"002"}},"required":["participants","user_ratings","call"],"type":"object"},"RequestPermissionRequest":{"nullable":true,"properties":{"permissions":{"items":{"type":"string"},"title":"Permissions","type":"array","x-stream-index":"003"}},"required":["permissions"],"title":"RequestPermissionRequest","type":"object"},"RequestPermissionResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"RequestPermissionResponse","type":"object"},"Response":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001"}},"required":["duration"],"title":"Response","type":"object"},"RestoreActionRequest":{"type":"object"},"ReviewQueueItem":{"properties":{"actions":{"items":{"$ref":"#/components/schemas/ActionLog"},"type":"array","x-stream-index":"035"},"activity":{"$ref":"#/components/schemas/EnrichedActivity","x-stream-index":"028"},"ai_text_severity":{"type":"string","x-stream-index":"021"},"archived_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"043"},"assigned_to":{"$ref":"#/components/schemas/User","x-stream-index":"032"},"bans":{"items":{"$ref":"#/components/schemas/Ban"},"type":"array","x-stream-index":"033"},"bounce_count":{"format":"int32","type":"integer","x-stream-index":"025"},"call":{"$ref":"#/components/schemas/Call","x-stream-index":"031"},"completed_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"018"},"config_key":{"type":"string","x-stream-index":"009"},"content_changed":{"type":"boolean","x-stream-index":"036"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"entity_creator":{"$ref":"#/components/schemas/EntityCreator","x-stream-index":"030"},"entity_id":{"type":"string","x-stream-index":"007"},"entity_type":{"type":"string","x-stream-index":"006"},"feeds_v2_activity":{"$ref":"#/components/schemas/EnrichedActivity","x-stream-index":"041"},"feeds_v2_reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"042"},"flag_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"045"},"flag_types":{"items":{"type":"string"},"type":"array","x-stream-index":"044"},"flags":{"items":{"$ref":"#/components/schemas/Flag"},"type":"array","x-stream-index":"034"},"flags_count":{"format":"int32","type":"integer","x-stream-index":"026"},"has_image":{"type":"boolean","x-stream-index":"012"},"has_text":{"type":"boolean","x-stream-index":"014"},"has_video":{"type":"boolean","x-stream-index":"013"},"id":{"type":"string","x-stream-index":"003"},"languages":{"items":{"type":"string"},"type":"array","x-stream-index":"019"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"027"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"010"},"moderation_payload_hash":{"type":"string","x-stream-index":"011"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"029"},"recommended_action":{"type":"string","x-stream-index":"017"},"reporter_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"046"},"reviewed_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"022"},"reviewed_by":{"type":"string","x-stream-index":"023"},"severity":{"format":"int32","type":"integer","x-stream-index":"020"},"status":{"type":"string","x-stream-index":"016"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"015"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"005"}},"required":["id","created_at","updated_at","entity_type","entity_id","config_key","moderation_payload_hash","has_image","has_video","has_text","teams","status","recommended_action","completed_at","languages","severity","ai_text_severity","reviewed_at","reviewed_by","bounce_count","flags_count","bans","flags","actions","content_changed","archived_at","flag_types","flag_labels","reporter_ids"],"type":"object"},"ReviewQueueItemResponse":{"nullable":true,"properties":{"actions":{"description":"Moderation actions taken","items":{"$ref":"#/components/schemas/ActionLogResponse"},"title":"Actions","type":"array","x-stream-index":"024"},"activity":{"$ref":"#/components/schemas/EnrichedActivity","x-stream-index":"016"},"ai_text_severity":{"description":"AI-determined text severity","title":"AI Text Severity","type":"string","x-stream-index":"014"},"assigned_to":{"$ref":"#/components/schemas/UserResponse","description":"Moderator assigned to review this item","title":"Assigned To","x-stream-index":"021"},"bans":{"description":"Associated ban records","items":{"$ref":"#/components/schemas/Ban"},"title":"Bans","type":"array","x-stream-index":"022"},"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"018"},"completed_at":{"description":"When the review was completed","format":"date-time","title":"Completed At","type":"number","x-stream-index":"009"},"config_key":{"type":"string","x-stream-index":"028"},"created_at":{"description":"When the item was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"002"},"entity_creator":{"$ref":"#/components/schemas/EntityCreatorResponse","description":"Details about who created the entity","title":"Entity Creator","x-stream-index":"019"},"entity_creator_id":{"description":"ID of who created the entity","title":"Entity Creator ID","type":"string","x-stream-index":"020"},"entity_id":{"description":"ID of the entity being reviewed","title":"Entity ID","type":"string","x-stream-index":"005"},"entity_type":{"description":"Type of entity being reviewed","title":"Entity Type","type":"string","x-stream-index":"004"},"feeds_v2_activity":{"$ref":"#/components/schemas/EnrichedActivity","description":"Associated feed activity","title":"Feeds V2 Activity","x-stream-index":"025"},"feeds_v2_reaction":{"$ref":"#/components/schemas/Reaction","description":"Associated feed reaction","title":"Feeds V2 Reaction","x-stream-index":"026"},"flags":{"description":"Associated flag records","items":{"$ref":"#/components/schemas/ModerationFlagResponse"},"title":"Flags","type":"array","x-stream-index":"023"},"flags_count":{"format":"int32","type":"integer","x-stream-index":"029"},"id":{"description":"Unique identifier of the review queue item","title":"ID","type":"string","x-stream-index":"001"},"languages":{"description":"Detected languages in the content","items":{"type":"string"},"title":"Languages","type":"array","x-stream-index":"012"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Associated message details","title":"Message","x-stream-index":"015"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content being moderated","title":"Moderation Payload","x-stream-index":"006"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"017"},"recommended_action":{"description":"Suggested moderation action","title":"Recommended Action","type":"string","x-stream-index":"008"},"reviewed_at":{"description":"When the item was reviewed","format":"date-time","title":"Reviewed At","type":"number","x-stream-index":"010"},"reviewed_by":{"description":"ID of the moderator who reviewed the item","title":"Reviewed By","type":"string","x-stream-index":"011"},"severity":{"description":"Severity level of the content","format":"int32","title":"Severity","type":"integer","x-stream-index":"013"},"status":{"description":"Current status of the review","title":"Status","type":"string","x-stream-index":"007"},"teams":{"description":"Teams associated with this item","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"027"},"updated_at":{"description":"When the item was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"003"}},"required":["id","created_at","updated_at","entity_type","entity_id","status","recommended_action","reviewed_by","languages","severity","ai_text_severity","bans","flags","actions","flags_count"],"type":"object"},"RingSettings":{"properties":{"auto_cancel_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_timeout_ms","missed_call_timeout_ms"],"type":"object"},"RingSettingsRequest":{"properties":{"auto_cancel_timeout_ms":{"description":"When none of the callees accept a ring call in this time a rejection will be sent by the caller with reason 'timeout' by the SDKs","format":"int32","maximum":180000,"minimum":5000,"title":"AutoCancelTimeoutMs","type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"description":"When a callee is online but doesn't answer a ring call in this time a rejection will be sent with reason 'timeout' by the SDKs","format":"int32","maximum":180000,"minimum":5000,"title":"IncomingCallTimeoutMs","type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"description":"When a callee doesn't accept or reject a ring call in this time a missed call event will be sent","format":"int32","maximum":180000,"minimum":5000,"title":"MissedCallTimeoutMs","type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_timeout_ms"],"title":"RingSettingsRequest","type":"object"},"RingSettingsResponse":{"properties":{"auto_cancel_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_timeout_ms","missed_call_timeout_ms"],"type":"object"},"RuleBuilderAction":{"properties":{"ban_options":{"$ref":"#/components/schemas/BanOptions","x-stream-index":"002"},"flag_content_options":{"$ref":"#/components/schemas/FlagContentOptions","x-stream-index":"004"},"flag_user_options":{"$ref":"#/components/schemas/FlagUserOptions","x-stream-index":"003"},"remove_content_options":{"$ref":"#/components/schemas/BlockContentOptions","x-stream-index":"005"},"type":{"type":"string","x-stream-index":"001"}},"type":"object"},"RuleBuilderCondition":{"properties":{"confidence":{"format":"float","type":"number","x-stream-index":"002"},"content_count_rule_params":{"$ref":"#/components/schemas/ContentCountRuleParameters","x-stream-index":"007"},"image_content_params":{"$ref":"#/components/schemas/ImageContentParameters","x-stream-index":"009"},"image_rule_params":{"$ref":"#/components/schemas/ImageRuleParameters","x-stream-index":"004"},"text_content_params":{"$ref":"#/components/schemas/TextContentParameters","x-stream-index":"008"},"text_rule_params":{"$ref":"#/components/schemas/TextRuleParameters","x-stream-index":"003"},"type":{"type":"string","x-stream-index":"001"},"user_created_within_params":{"$ref":"#/components/schemas/UserCreatedWithinParameters","x-stream-index":"011"},"user_custom_property_params":{"$ref":"#/components/schemas/UserCustomPropertyParameters","x-stream-index":"012"},"user_rule_params":{"$ref":"#/components/schemas/UserRuleParameters","x-stream-index":"006"},"video_content_params":{"$ref":"#/components/schemas/VideoContentParameters","x-stream-index":"010"},"video_rule_params":{"$ref":"#/components/schemas/VideoRuleParameters","x-stream-index":"005"}},"type":"object"},"RuleBuilderConditionGroup":{"properties":{"conditions":{"items":{"$ref":"#/components/schemas/RuleBuilderCondition"},"type":"array","x-stream-index":"002"},"logic":{"type":"string","x-stream-index":"001"}},"type":"object"},"RuleBuilderConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"rules":{"items":{"$ref":"#/components/schemas/RuleBuilderRule"},"type":"array","x-stream-index":"002"}},"type":"object"},"RuleBuilderRule":{"properties":{"action":{"$ref":"#/components/schemas/RuleBuilderAction","x-stream-index":"006"},"conditions":{"items":{"$ref":"#/components/schemas/RuleBuilderCondition"},"type":"array","x-stream-index":"003"},"cooldown_period":{"type":"string","x-stream-index":"007"},"groups":{"items":{"$ref":"#/components/schemas/RuleBuilderConditionGroup"},"type":"array","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"logic":{"type":"string","x-stream-index":"004"},"rule_type":{"type":"string","x-stream-index":"002"}},"required":["rule_type","action"],"type":"object"},"SDKUsageReport":{"properties":{"per_sdk_usage":{"additionalProperties":{"$ref":"#/components/schemas/PerSDKUsageReport"},"type":"object","x-stream-index":"001"}},"required":["per_sdk_usage"],"type":"object"},"SDKUsageReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateSDKUsageReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"SFUIDLastSeen":{"properties":{"id":{"type":"string","x-stream-index":"001.001"},"last_seen":{"format":"date-time","type":"number","x-stream-index":"002"},"process_start_time":{"format":"int64","type":"integer","x-stream-index":"001.002"}},"required":["id","process_start_time","last_seen"],"type":"object"},"SFUResponse":{"properties":{"edge_name":{"type":"string","x-stream-index":"001"},"url":{"type":"string","x-stream-index":"002"},"ws_endpoint":{"type":"string","x-stream-index":"003"}},"required":["edge_name","url","ws_endpoint"],"type":"object"},"STTEgressConfig":{"properties":{"closed_captions_enabled":{"type":"boolean","x-stream-index":"005"},"external_storage":{"$ref":"#/components/schemas/ExternalStorage","x-stream-index":"011"},"language":{"type":"string","x-stream-index":"008"},"storage_name":{"type":"string","x-stream-index":"010"},"translation_languages":{"items":{"type":"string"},"type":"array","x-stream-index":"009"},"translations_enabled":{"type":"boolean","x-stream-index":"006"},"upload_transcriptions":{"type":"boolean","x-stream-index":"004"},"whisper_server_base_url":{"type":"string","x-stream-index":"007"}},"type":"object"},"ScreensharingSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled"],"type":"object"},"ScreensharingSettingsRequest":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"type":"object"},"ScreensharingSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled"],"type":"object"},"SearchPayload":{"properties":{"filter_conditions":{"additionalProperties":{},"description":"Channel filter conditions","maximum":100,"minimum":1,"title":"Channel filter","type":"object","x-stream-docs-page-id":"query_channels","x-stream-index":"002"},"limit":{"description":"Number of messages to return","format":"int32","title":"Limit","type":"integer","x-stream-index":"005"},"message_filter_conditions":{"additionalProperties":{},"description":"Message filter conditions","title":"Message filter","type":"object","x-stream-index":"003"},"message_options":{"$ref":"#/components/schemas/MessageOptions","x-stream-index":"004"},"next":{"description":"Pagination parameter. Cannot be used with non-zero offset.","title":"Next","type":"string","x-stream-index":"008"},"offset":{"description":"Pagination offset. Cannot be used with sort or next.","format":"int32","title":"Offset","type":"integer","x-stream-index":"006"},"query":{"description":"Search phrase","title":"Query","type":"string","x-stream-index":"001"},"sort":{"description":"Sort parameters. Cannot be used with non-zero offset","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"007"}},"required":["filter_conditions"],"type":"object"},"SearchResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"005.001"},"next":{"description":"Value to pass to the next search query in order to paginate","title":"Next","type":"string","x-stream-index":"003"},"previous":{"description":"Value that points to the previous page. Pass as the next value in a search query to paginate backwards","title":"Previous","type":"string","x-stream-index":"004"},"results":{"description":"Search results","items":{"$ref":"#/components/schemas/SearchResult"},"title":"Results","type":"array","x-stream-index":"001"},"results_warning":{"$ref":"#/components/schemas/SearchWarning","description":"Warning about the search results","title":"Results Warning","x-stream-index":"002"}},"required":["results","duration"],"type":"object"},"SearchResult":{"properties":{"message":{"$ref":"#/components/schemas/SearchResultMessage","description":"Found message","title":"Message","x-stream-index":"001"}},"type":"object"},"SearchResultMessage":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"001.008"},"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel object","title":"Channel","x-stream-index":"002"},"cid":{"type":"string","x-stream-index":"001.022"},"command":{"type":"string","x-stream-index":"001.004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.023"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.026"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.025"},"deleted_for_me":{"type":"boolean","x-stream-index":"001.044"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"001.018"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001.041"},"html":{"type":"string","x-stream-index":"001.005"},"i18n":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.030"},"id":{"type":"string","x-stream-index":"001.001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"001.028"},"latest_reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"001.009"},"mentioned_users":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"001.029"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"001.036"},"mml":{"type":"string","x-stream-index":"001.003"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"001.039"},"own_reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"001.010"},"parent_id":{"type":"string","x-stream-index":"001.015"},"pin_expires":{"format":"date-time","type":"number","x-stream-index":"001.035"},"pinned":{"type":"boolean","x-stream-index":"001.032"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"001.033"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001.034"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001.038"},"poll_id":{"type":"string","x-stream-index":"001.037"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001.020"},"quoted_message_id":{"type":"string","x-stream-index":"001.019"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001.011"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"001.014"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001.012"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"001.042"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"001.017"},"restricted_visibility":{"items":{"type":"string"},"type":"array","x-stream-index":"001.040"},"shadowed":{"type":"boolean","x-stream-index":"001.027"},"shared_location":{"$ref":"#/components/schemas/SharedLocationResponseData","x-stream-index":"001.043"},"show_in_channel":{"type":"boolean","x-stream-index":"001.016"},"silent":{"type":"boolean","x-stream-index":"001.031"},"text":{"type":"string","x-stream-index":"001.002"},"thread_participants":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"001.021"},"type":{"type":"string","x-stream-index":"001.006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.024"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001.007"}},"required":["id","text","html","type","user","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned","restricted_visibility"],"type":"object"},"SearchWarning":{"properties":{"channel_search_cids":{"description":"Channel CIDs for the searched channels","items":{"type":"string"},"title":"Channel Search CIDs","type":"array","x-stream-index":"004"},"channel_search_count":{"description":"Number of channels searched","format":"int32","title":"Channel Search Count","type":"integer","x-stream-index":"003"},"warning_code":{"description":"Code corresponding to the warning","format":"int32","title":"Warning Code","type":"integer","x-stream-index":"002"},"warning_description":{"description":"Description of the warning","title":"Warning Description","type":"string","x-stream-index":"001"}},"required":["warning_description","warning_code"],"type":"object"},"SendCallEventRequest":{"description":"Send a call event to the other user","nullable":true,"properties":{"custom":{"additionalProperties":{},"title":"Custom","type":"object","x-stream-index":"004"}},"title":"SendCallEventRequest","type":"object"},"SendCallEventResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"SendCallEventResponse","type":"object"},"SendEventRequest":{"nullable":true,"properties":{"event":{"$ref":"#/components/schemas/EventRequest","x-stream-index":"001"}},"required":["event"],"type":"object"},"SendMessageRequest":{"nullable":true,"properties":{"keep_channel_hidden":{"type":"boolean","x-stream-index":"008"},"message":{"$ref":"#/components/schemas/MessageRequest","x-stream-index":"001"},"skip_enrich_url":{"type":"boolean","x-stream-index":"003"},"skip_push":{"type":"boolean","x-stream-index":"002"}},"required":["message"],"type":"object"},"SendMessageResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Message response","title":"Message","x-stream-index":"001"},"pending_message_metadata":{"additionalProperties":{"type":"string"},"description":"Pending message metadata","title":"Pending message metadata","type":"object","x-stream-index":"002"}},"required":["message","duration"],"type":"object"},"SendReactionRequest":{"nullable":true,"properties":{"enforce_unique":{"description":"Whether to replace all existing user reactions","title":"Enforce unique","type":"boolean","x-stream-index":"003"},"reaction":{"$ref":"#/components/schemas/ReactionRequest","x-stream-index":"002"},"skip_push":{"description":"Skips any mobile push notifications","title":"Skip push","type":"boolean","x-stream-index":"004"}},"required":["reaction"],"type":"object"},"SendReactionResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001"},"reaction":{"$ref":"#/components/schemas/ReactionResponse","x-stream-index":"002"}},"required":["message","reaction","duration"],"title":"Response","type":"object"},"SessionSettings":{"properties":{"inactivity_timeout_seconds":{"format":"int32","maximum":900,"minimum":5,"type":"integer","x-stream-index":"001"}},"required":["inactivity_timeout_seconds"],"type":"object"},"SessionSettingsRequest":{"properties":{"inactivity_timeout_seconds":{"format":"int32","maximum":900,"minimum":5,"type":"integer","x-stream-index":"001"}},"required":["inactivity_timeout_seconds"],"type":"object"},"SessionSettingsResponse":{"properties":{"inactivity_timeout_seconds":{"format":"int32","maximum":900,"minimum":5,"type":"integer","x-stream-index":"001"}},"required":["inactivity_timeout_seconds"],"type":"object"},"ShadowBlockActionRequest":{"type":"object"},"SharedLocation":{"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"013"},"channel_cid":{"type":"string","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"010"},"created_by_device_id":{"type":"string","x-stream-index":"008"},"end_at":{"format":"date-time","type":"number","x-stream-index":"009"},"latitude":{"format":"float","maximum":90,"minimum":18446744073709552000,"type":"number","x-stream-index":"006"},"longitude":{"format":"float","maximum":180,"minimum":18446744073709552000,"type":"number","x-stream-index":"007"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"012"},"message_id":{"type":"string","x-stream-index":"004"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"011"},"user_id":{"type":"string","x-stream-index":"005"}},"required":["channel_cid","message_id","user_id","created_by_device_id","created_at","updated_at"],"type":"object"},"SharedLocationResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001.011"},"channel_cid":{"description":"Channel CID","title":"string","type":"string","x-stream-index":"001.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.008"},"created_by_device_id":{"description":"Device ID that created the live location","title":"string","type":"string","x-stream-index":"001.006"},"duration":{"type":"string","x-stream-index":"002.001"},"end_at":{"description":"Time when the live location expires","format":"date-time","title":"string","type":"number","x-stream-index":"001.007"},"latitude":{"description":"Latitude coordinate","format":"float","title":"number","type":"number","x-stream-index":"001.004"},"longitude":{"description":"Longitude coordinate","format":"float","title":"number","type":"number","x-stream-index":"001.005"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001.010"},"message_id":{"description":"Message ID","title":"string","type":"string","x-stream-index":"001.002"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.009"},"user_id":{"description":"User ID","title":"string","type":"string","x-stream-index":"001.003"}},"required":["channel_cid","message_id","user_id","latitude","longitude","created_by_device_id","created_at","updated_at","duration"],"type":"object"},"SharedLocationResponseData":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"011"},"channel_cid":{"type":"string","x-stream-index":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"created_by_device_id":{"type":"string","x-stream-index":"006"},"end_at":{"format":"date-time","type":"number","x-stream-index":"007"},"latitude":{"format":"float","type":"number","x-stream-index":"004"},"longitude":{"format":"float","type":"number","x-stream-index":"005"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"010"},"message_id":{"type":"string","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["channel_cid","message_id","user_id","latitude","longitude","created_by_device_id","created_at","updated_at"],"type":"object"},"SharedLocationsResponse":{"nullable":true,"properties":{"active_live_locations":{"items":{"$ref":"#/components/schemas/SharedLocationResponseData"},"type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["active_live_locations","duration"],"type":"object"},"ShowChannelRequest":{"nullable":true,"type":"object"},"ShowChannelResponse":{"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"},"SingleFollowResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"follow":{"$ref":"#/components/schemas/FollowResponse","description":"The created follow relationship","title":"Follow","x-stream-index":"001"}},"required":["follow","duration"],"title":"Follow Response","type":"object"},"SortParam":{"nullable":true,"properties":{"direction":{"format":"int32","type":"integer","x-stream-index":"002"},"field":{"type":"string","x-stream-index":"001"}},"required":["field","direction"],"type":"object"},"SortParamRequest":{"nullable":true,"properties":{"direction":{"description":"Direction of sorting, 1 for Ascending, -1 for Descending, default is 1","format":"int32","title":"Direction","type":"integer","x-stream-index":"002"},"field":{"description":"Name of field to sort by","title":"Field","type":"string","x-stream-index":"001"}},"type":"object"},"StartClosedCaptionsRequest":{"nullable":true,"properties":{"enable_transcription":{"description":"Enable transcriptions along with closed captions","title":"Enable Transcription","type":"boolean","x-stream-index":"002"},"external_storage":{"description":"Which external storage to use for transcriptions (only applicable if enable_transcription is true)","title":"External Storage","type":"string","x-stream-index":"003"},"language":{"description":"The spoken language in the call, if not provided the language defined in the transcription settings will be used","enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"title":"Language","type":"string","x-stream-index":"004"}},"type":"object"},"StartClosedCaptionsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"StartFrameRecordingRequest":{"nullable":true,"properties":{"recording_external_storage":{"type":"string","x-stream-index":"002"}},"title":"StartFrameRecordingRequest","type":"object"},"StartFrameRecordingResponse":{"description":"StartFrameRecordingResponse is the response payload for the start frame recording endpoint.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StartFrameRecordingResponse","type":"object"},"StartHLSBroadcastingRequest":{"description":"StartHLSBroadcastingRequest is the payload for starting an HLS broadcasting.","nullable":true,"title":"StartHLSBroadcastingRequest","type":"object"},"StartHLSBroadcastingResponse":{"description":"StartHLSBroadcastingResponse is the payload for starting an HLS broadcasting.","nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"},"playlist_url":{"description":"the URL of the HLS playlist","title":"PlaylistURL","type":"string","x-stream-index":"002"}},"required":["duration","playlist_url"],"title":"StartHLSBroadcastingResponse","type":"object"},"StartRTMPBroadcastsRequest":{"description":"StartRTMPBroadcastsRequest is the payload for starting RTMP broadcasts.","nullable":true,"properties":{"broadcasts":{"description":"List of broadcasts to start","items":{"$ref":"#/components/schemas/RTMPBroadcastRequest"},"maximum":1,"minimum":1,"title":"Broadcasts","type":"array","x-stream-index":"002"}},"required":["broadcasts"],"title":"StartRTMPBroadcastsRequest","type":"object"},"StartRTMPBroadcastsResponse":{"description":"StartRTMPBroadcastsResponse is the payload for starting an RTMP broadcast.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StartRTMPBroadcastsResponse","type":"object"},"StartRecordingRequest":{"nullable":true,"properties":{"recording_external_storage":{"type":"string","x-stream-index":"002"}},"title":"StartRecordingRequest","type":"object"},"StartRecordingResponse":{"description":"StartRecordingResponse is the response payload for the start recording endpoint.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StartRecordingResponse","type":"object"},"StartTranscriptionRequest":{"nullable":true,"properties":{"enable_closed_captions":{"description":"Enable closed captions along with transcriptions","title":"Enable Closed Captions","type":"boolean","x-stream-index":"003"},"language":{"description":"The spoken language in the call, if not provided the language defined in the transcription settings will be used","enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"title":"Language","type":"string","x-stream-index":"004"},"transcription_external_storage":{"description":"Store transcriptions in this external storage","title":"External Storage","type":"string","x-stream-index":"002"}},"type":"object"},"StartTranscriptionResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StartTranscriptionResponse","type":"object"},"StatsOptions":{"properties":{"enable_rtc_stats":{"type":"boolean","x-stream-index":"002"},"reporting_interval_ms":{"format":"int32","type":"integer","x-stream-index":"001"}},"required":["reporting_interval_ms","enable_rtc_stats"],"type":"object"},"StopAllRTMPBroadcastsRequest":{"nullable":true,"title":"StopAllRTMPBroadcastsRequest","type":"object"},"StopAllRTMPBroadcastsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StopAllRTMPBroadcastsResponse","type":"object"},"StopClosedCaptionsRequest":{"nullable":true,"properties":{"stop_transcription":{"type":"boolean","x-stream-index":"003"}},"type":"object"},"StopClosedCaptionsResponse":{"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"},"StopFrameRecordingRequest":{"nullable":true,"type":"object"},"StopFrameRecordingResponse":{"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"},"StopHLSBroadcastingRequest":{"nullable":true,"type":"object"},"StopHLSBroadcastingResponse":{"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"},"StopLiveRequest":{"nullable":true,"properties":{"continue_closed_caption":{"type":"boolean","x-stream-index":"006"},"continue_hls":{"type":"boolean","x-stream-index":"003"},"continue_recording":{"type":"boolean","x-stream-index":"004"},"continue_rtmp_broadcasts":{"type":"boolean","x-stream-index":"007"},"continue_transcription":{"type":"boolean","x-stream-index":"005"}},"title":"StopLiveRequest","type":"object"},"StopLiveResponse":{"nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"The call that was stopped","title":"Call","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["call","duration"],"title":"StopLiveResponse","type":"object"},"StopRTMPBroadcastsRequest":{"description":"Request for stopping RTMP broadcasts","nullable":true,"title":"StopRTMPBroadcastsRequest","type":"object"},"StopRTMPBroadcastsResponse":{"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"},"StopRecordingRequest":{"nullable":true,"type":"object"},"StopRecordingResponse":{"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"},"StopTranscriptionRequest":{"nullable":true,"properties":{"stop_closed_captions":{"type":"boolean","x-stream-index":"003"}},"type":"object"},"StopTranscriptionResponse":{"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"},"StoriesConfig":{"properties":{"expiration_behaviour":{"enum":["hide_for_everyone","visible_for_author"],"type":"string","x-stream-index":"001"},"skip_watched":{"type":"boolean","x-stream-index":"002"}},"type":"object"},"SubmitActionRequest":{"nullable":true,"properties":{"action_type":{"description":"Type of moderation action to perform (mark_reviewed, delete_message, etc.)","enum":["mark_reviewed","delete_message","delete_activity","delete_reaction","ban","custom","unban","restore","delete_user","unblock","shadow_block","unmask","kick_user","end_call"],"title":"Action Type","type":"string","x-stream-index":"002"},"ban":{"$ref":"#/components/schemas/BanActionRequest","description":"Configuration for ban action","title":"Ban","x-stream-index":"008"},"custom":{"$ref":"#/components/schemas/CustomActionRequest","description":"Configuration for custom action","title":"Custom","x-stream-index":"009"},"delete_activity":{"$ref":"#/components/schemas/DeleteActivityRequest","description":"Configuration for activity deletion action","title":"Delete Activity","x-stream-index":"004"},"delete_message":{"$ref":"#/components/schemas/DeleteMessageRequest","description":"Configuration for message deletion action","title":"Delete Message","x-stream-index":"003"},"delete_reaction":{"$ref":"#/components/schemas/DeleteReactionRequest","description":"Configuration for reaction deletion action","title":"Delete Reaction","x-stream-index":"005"},"delete_user":{"$ref":"#/components/schemas/DeleteUserRequest","description":"Configuration for user deletion action","title":"Delete User","x-stream-index":"006"},"item_id":{"description":"UUID of the review queue item to act on","title":"Item ID","type":"string","x-stream-index":"001"},"mark_reviewed":{"$ref":"#/components/schemas/MarkReviewedRequest","description":"Configuration for marking item as reviewed","title":"Mark Reviewed","x-stream-index":"007"},"unban":{"$ref":"#/components/schemas/UnbanActionRequest","description":"Configuration for unban action","title":"Unban","x-stream-index":"010"}},"required":["item_id","action_type"],"type":"object"},"SubmitActionResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"Updated review queue item after action was performed","title":"Item","x-stream-index":"001"}},"required":["duration"],"type":"object"},"SubscriberStatsResponse":{"properties":{"total":{"format":"int32","type":"integer","x-stream-index":"001"},"total_subscribed_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"003"},"unique":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["total","unique","total_subscribed_duration_seconds"],"type":"object"},"SyncRequest":{"description":"Sync request","nullable":true,"properties":{"channel_cids":{"description":"List of channel CIDs to sync","items":{"type":"string"},"maximum":255,"minimum":1,"title":"Channel CIDs","type":"array","x-stream-index":"001"},"last_sync_at":{"description":"Date from which synchronization should happen","format":"date-time","title":"Last sync at","type":"number","x-stream-index":"002"}},"required":["channel_cids","last_sync_at"],"title":"SyncRequest","type":"object"},"SyncResponse":{"description":"Sync response","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"events":{"description":"List of events","items":{"$ref":"#/components/schemas/WSEvent"},"title":"Events","type":"array","x-stream-index":"001"},"inaccessible_cids":{"description":"List of CIDs that user can't access","items":{"type":"string"},"title":"Inaccessible CIDs","type":"array","x-stream-index":"002"}},"required":["events","duration"],"title":"SyncResponse","type":"object"},"TargetResolution":{"properties":{"bitrate":{"format":"int32","maximum":6000000,"type":"integer","x-stream-index":"003"},"height":{"format":"int32","maximum":3840,"minimum":240,"type":"integer","x-stream-index":"002"},"width":{"format":"int32","maximum":3840,"minimum":240,"type":"integer","x-stream-index":"001"}},"required":["width","height"],"type":"object"},"TextContentParameters":{"properties":{"blocklist_match":{"items":{"type":"string"},"type":"array","x-stream-index":"005"},"contains_url":{"type":"boolean","x-stream-index":"003"},"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001"},"llm_harm_labels":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"002"},"severity":{"type":"string","x-stream-index":"004"}},"type":"object"},"TextRuleParameters":{"properties":{"blocklist_match":{"items":{"type":"string"},"type":"array","x-stream-index":"007"},"contains_url":{"type":"boolean","x-stream-index":"005"},"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"llm_harm_labels":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"004"},"severity":{"type":"string","x-stream-index":"006"},"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"type":"object"},"ThreadParticipant":{"description":"Represents a user that is participating in a thread.","nullable":true,"properties":{"app_pk":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"001"},"channel_cid":{"type":"string","x-stream-index":"002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"007"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"last_read_at":{"format":"date-time","type":"number","x-stream-index":"009"},"last_thread_message_at":{"format":"date-time","type":"number","x-stream-index":"003"},"left_thread_at":{"description":"Left Thread At is the time when the user left the thread","format":"date-time","title":"Left Thread At","type":"number","x-stream-index":"008"},"thread_id":{"description":"Thead ID is unique string identifier of the thread","title":"ID","type":"string","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User is the user object","title":"User","x-stream-index":"006"},"user_id":{"description":"User ID is unique string identifier of the user","title":"User ID","type":"string","x-stream-index":"005"}},"required":["app_pk","channel_cid","created_at","last_read_at","custom"],"title":"ThreadParticipant","type":"object"},"ThreadResponse":{"properties":{"active_participant_count":{"description":"Active Participant Count","format":"int32","title":"Active Participant Count","type":"integer","x-stream-index":"009"},"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel","title":"ChannelResponse","x-stream-index":"002"},"channel_cid":{"description":"Channel CID","title":"Channel CID","type":"string","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"012"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"Created By User","title":"User","x-stream-index":"006"},"created_by_user_id":{"description":"Created By User ID","title":"Created By User ID","type":"string","x-stream-index":"005"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"016"},"deleted_at":{"description":"Deleted At","format":"date-time","title":"Deleted At","type":"number","x-stream-index":"014"},"last_message_at":{"description":"Last Message At","format":"date-time","title":"Last Message At","type":"number","x-stream-index":"011"},"parent_message":{"$ref":"#/components/schemas/MessageResponse","description":"Parent Message","title":"Message","x-stream-index":"004"},"parent_message_id":{"description":"Parent Message ID","title":"Parent Message ID","type":"string","x-stream-index":"003"},"participant_count":{"description":"Participant Count","format":"int32","title":"Participant Count","type":"integer","x-stream-index":"008"},"reply_count":{"description":"Reply Count","format":"int32","title":"Reply Count","type":"integer","x-stream-index":"007"},"thread_participants":{"description":"Thread Participants","items":{"$ref":"#/components/schemas/ThreadParticipant"},"title":"ThreadParticipants","type":"array","x-stream-index":"010"},"title":{"description":"Title","title":"Title","type":"string","x-stream-index":"015"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"013"}},"required":["channel_cid","parent_message_id","created_by_user_id","created_at","updated_at","title","custom"],"type":"object"},"ThreadStateResponse":{"nullable":true,"properties":{"active_participant_count":{"description":"Active Participant Count","format":"int32","title":"Active Participant Count","type":"integer","x-stream-index":"001.009"},"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel","title":"ChannelResponse","x-stream-index":"001.002"},"channel_cid":{"description":"Channel CID","title":"Channel CID","type":"string","x-stream-index":"001.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.012"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"Created By User","title":"User","x-stream-index":"001.006"},"created_by_user_id":{"description":"Created By User ID","title":"Created By User ID","type":"string","x-stream-index":"001.005"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"001.016"},"deleted_at":{"description":"Deleted At","format":"date-time","title":"Deleted At","type":"number","x-stream-index":"001.014"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"004"},"last_message_at":{"description":"Last Message At","format":"date-time","title":"Last Message At","type":"number","x-stream-index":"001.011"},"latest_replies":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","x-stream-index":"002"},"parent_message":{"$ref":"#/components/schemas/MessageResponse","description":"Parent Message","title":"Message","x-stream-index":"001.004"},"parent_message_id":{"description":"Parent Message ID","title":"Parent Message ID","type":"string","x-stream-index":"001.003"},"participant_count":{"description":"Participant Count","format":"int32","title":"Participant Count","type":"integer","x-stream-index":"001.008"},"read":{"items":{"$ref":"#/components/schemas/ReadStateResponse"},"type":"array","x-stream-index":"003"},"reply_count":{"description":"Reply Count","format":"int32","title":"Reply Count","type":"integer","x-stream-index":"001.007"},"thread_participants":{"description":"Thread Participants","items":{"$ref":"#/components/schemas/ThreadParticipant"},"title":"ThreadParticipants","type":"array","x-stream-index":"001.010"},"title":{"description":"Title","title":"Title","type":"string","x-stream-index":"001.015"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.013"}},"required":["channel_cid","parent_message_id","created_by_user_id","created_at","updated_at","title","custom","latest_replies"],"type":"object"},"ThreadUpdatedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"001.002"},"channel_type":{"type":"string","x-stream-index":"001.003"},"cid":{"type":"string","x-stream-index":"001.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"thread":{"$ref":"#/components/schemas/ThreadResponse","x-stream-index":"003.001"},"type":{"default":"thread.updated","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"ThreadUpdatedEvent","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"},"ThreadedCommentResponse":{"description":"A comment with an optional, depth‑limited slice of nested replies.","properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"001.011"},"confidence_score":{"format":"float","type":"number","x-stream-index":"001.022"},"controversy_score":{"format":"float","type":"number","x-stream-index":"001.023"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.014"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.006"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.016"},"downvote_count":{"format":"int32","type":"integer","x-stream-index":"001.020"},"id":{"type":"string","x-stream-index":"001.001"},"latest_reactions":{"items":{"$ref":"#/components/schemas/FeedsReactionResponse"},"type":"array","x-stream-index":"001.009"},"mentioned_users":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"001.012"},"meta":{"$ref":"#/components/schemas/RepliesMeta","description":"Pagination \u0026 depth info for this node's direct replies.","title":"Replies Meta","x-stream-index":"002"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"001.017"},"object_id":{"type":"string","x-stream-index":"001.002"},"object_type":{"type":"string","x-stream-index":"001.003"},"own_reactions":{"items":{"$ref":"#/components/schemas/FeedsReactionResponse"},"type":"array","x-stream-index":"001.024"},"parent_id":{"type":"string","x-stream-index":"001.007"},"reaction_count":{"format":"int32","type":"integer","x-stream-index":"001.008"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"001.010"},"replies":{"description":"Slice of nested comments (may be empty).","items":{"$ref":"#/components/schemas/ThreadedCommentResponse"},"title":"Replies","type":"array","x-stream-index":"003"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"001.018"},"score":{"format":"int32","type":"integer","x-stream-index":"001.021"},"status":{"type":"string","x-stream-index":"001.013"},"text":{"type":"string","x-stream-index":"001.005"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.015"},"upvote_count":{"format":"int32","type":"integer","x-stream-index":"001.019"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001.004"}},"required":["id","object_id","object_type","user","reaction_count","mentioned_users","status","created_at","updated_at","reply_count","upvote_count","downvote_count","score","confidence_score","own_reactions"],"title":"Threaded Comment","type":"object"},"Thresholds":{"description":"Sets thresholds for AI moderation","properties":{"explicit":{"$ref":"#/components/schemas/LabelThresholds","description":"Thresholds for explicit messages","title":"LabelThresholds","x-stream-index":"001"},"spam":{"$ref":"#/components/schemas/LabelThresholds","description":"Thresholds for spam","title":"LabelThresholds","x-stream-index":"002"},"toxic":{"$ref":"#/components/schemas/LabelThresholds","description":"Thresholds for toxic messages","title":"LabelThresholds","x-stream-index":"003"}},"title":"Auto moderation thresholds","type":"object"},"ThumbnailResponse":{"properties":{"image_url":{"type":"string","x-stream-index":"001"}},"required":["image_url"],"type":"object"},"ThumbnailsSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"ThumbnailsSettingsRequest":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"ThumbnailsSettingsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"Time":{"type":"object"},"TrackStatsResponse":{"nullable":true,"properties":{"duration_seconds":{"format":"int32","type":"integer","x-stream-index":"002"},"track_type":{"type":"string","x-stream-index":"001"}},"required":["track_type","duration_seconds"],"type":"object"},"TranscriptionSettings":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"title":"Mode","type":"string","x-stream-index":"002"},"language":{"description":"The language used in this call as a two letter code","enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"title":"Language","type":"string","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"title":"Mode","type":"string","x-stream-index":"001"}},"required":["mode","closed_caption_mode","languages","language"],"type":"object"},"TranscriptionSettingsRequest":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"002"},"language":{"enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"type":"string","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode"],"type":"object"},"TranscriptionSettingsResponse":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"002"},"language":{"enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"type":"string","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode","closed_caption_mode","languages","language"],"type":"object"},"TranslateMessageRequest":{"nullable":true,"properties":{"language":{"description":"Language to translate message to","enum":["af","sq","am","ar","az","bn","bs","bg","zh","zh-TW","hr","cs","da","fa-AF","nl","en","et","fi","fr","fr-CA","ka","de","el","ha","he","hi","hu","id","it","ja","ko","lv","ms","no","fa","ps","pl","pt","ro","ru","sr","sk","sl","so","es","es-MX","sw","sv","tl","ta","th","tr","uk","ur","vi","lt","ht"],"title":"Language","type":"string","x-stream-index":"001"}},"required":["language"],"type":"object"},"TruncateChannelRequest":{"nullable":true,"properties":{"hard_delete":{"description":"Permanently delete channel data (messages, reactions, etc.)","title":"Hard delete","type":"boolean","x-stream-index":"002"},"member_ids":{"description":"List of member IDs to hide message history for. If empty, truncates the channel for all members","items":{"type":"string"},"maximum":100,"title":"Member IDs","type":"array","x-stream-index":"007"},"message":{"$ref":"#/components/schemas/MessageRequest","x-stream-index":"004"},"skip_push":{"description":"When `message` is set disables all push notifications for it","title":"Skip push","type":"boolean","x-stream-index":"005"},"truncated_at":{"description":"Truncate channel data up to `truncated_at`. The system message (if provided) creation time is always greater than `truncated_at`","format":"date-time","title":"Truncated at","type":"number","x-stream-index":"006"}},"type":"object"},"TruncateChannelResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Truncated channel object","title":"Channel","x-stream-index":"002"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Truncated message object","title":"Message","x-stream-index":"003"}},"required":["duration"],"type":"object"},"TypingIndicators":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"TypingIndicatorsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"TypingStartEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"parent_id":{"type":"string","x-stream-index":"001"},"type":{"default":"typing.start","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"TypingStartEvent","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"},"TypingStopEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"parent_id":{"type":"string","x-stream-index":"001"},"type":{"default":"typing.stop","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"TypingStopEvent","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"},"UnbanActionRequest":{"type":"object"},"UnblockActionRequest":{"type":"object"},"UnblockUserRequest":{"description":"UnblockUserRequest is the payload for unblocking a user.","nullable":true,"properties":{"user_id":{"description":"the user to unblock","title":"UserID","type":"string","x-stream-index":"003"}},"required":["user_id"],"title":"UnblockUserRequest","type":"object"},"UnblockUserResponse":{"description":"UnblockUserResponse is the payload for unblocking a user.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"UnblockUserResponse","type":"object"},"UnblockUsersRequest":{"nullable":true,"properties":{"blocked_user_id":{"type":"string","x-stream-index":"001"}},"required":["blocked_user_id"],"type":"object"},"UnblockUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"UnblockedUserEvent":{"description":"This event is sent when a user is unblocked on a call,\nthis can be useful to notify the user that they can now join the call again","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.unblocked_user","description":"The type of event: \"call.unblocked_user\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user that was unblocked","title":"User","x-stream-index":"003"}},"required":["type","created_at","call_cid","user"],"title":"UnblockedUserEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"UnfollowResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"follow":{"$ref":"#/components/schemas/FollowResponse","description":"The deleted follow relationship","title":"Follow","x-stream-index":"001"}},"required":["follow","duration"],"title":"Unfollow Response","type":"object"},"UnmuteChannelRequest":{"nullable":true,"properties":{"channel_cids":{"description":"Channel CIDs to mute (if multiple channels)","items":{"type":"string"},"maximum":25,"title":"Channel CIDs","type":"array","x-stream-index":"001.002"},"expiration":{"description":"Duration of mute in milliseconds","title":"Expiration","type":"integer","x-stream-index":"001.003"}},"type":"object"},"UnmuteResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"non_existing_users":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"required":["duration"],"title":"Response","type":"object"},"UnpinActivityResponse":{"nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","description":"The unpinned activity","title":"Activity","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"004.001"},"feed":{"description":"Fully qualified ID of the feed the activity was unpinned from","title":"Feed ID","type":"string","x-stream-index":"002"},"user_id":{"description":"ID of the user who unpinned the activity","title":"User ID","type":"string","x-stream-index":"003"}},"required":["activity","feed","user_id","duration"],"title":"Unpin Activity Response","type":"object"},"UnpinRequest":{"description":"UnpinRequest is the payload for unpinning a message.","nullable":true,"properties":{"session_id":{"description":"the session ID of the user who pinned the message","title":"SessionID","type":"string","x-stream-index":"003"},"user_id":{"description":"the user ID of the user who pinned the message","title":"UserID","type":"string","x-stream-index":"002"}},"required":["user_id","session_id"],"title":"UnpinRequest","type":"object"},"UnpinResponse":{"description":"UnpinResponse is the payload for unpinning a message.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"UnpinResponse","type":"object"},"UnreadCountsChannel":{"properties":{"channel_id":{"type":"string","x-stream-index":"001"},"last_read":{"format":"date-time","type":"number","x-stream-index":"003"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["channel_id","unread_count","last_read"],"type":"object"},"UnreadCountsChannelType":{"properties":{"channel_count":{"format":"int32","type":"integer","x-stream-index":"002"},"channel_type":{"type":"string","x-stream-index":"001"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["channel_type","channel_count","unread_count"],"type":"object"},"UnreadCountsThread":{"properties":{"last_read":{"format":"date-time","type":"number","x-stream-index":"002"},"last_read_message_id":{"type":"string","x-stream-index":"003"},"parent_message_id":{"type":"string","x-stream-index":"004"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"001"}},"required":["unread_count","last_read","last_read_message_id","parent_message_id"],"type":"object"},"UpdateActivityPartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"description":"Map of dot-notation field paths to new values","title":"object","type":"object","x-stream-index":"002"},"unset":{"description":"List of dot-notation paths to remove","items":{"type":"string"},"title":"[]string","type":"array","x-stream-index":"003"}},"type":"object"},"UpdateActivityPartialResponse":{"nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","description":"The updated activity","title":"ActivityResponse","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["activity","duration"],"type":"object"},"UpdateActivityRequest":{"nullable":true,"properties":{"attachments":{"description":"List of attachments for the activity","items":{"$ref":"#/components/schemas/Attachment"},"title":"[]ActivityAttachment","type":"array","x-stream-index":"003"},"custom":{"additionalProperties":{},"description":"Custom data for the activity","title":"object","type":"object","x-stream-index":"004"},"expires_at":{"description":"Time when the activity will expire","format":"date-time","title":"string","type":"number","x-stream-index":"007"},"filter_tags":{"description":"Tags used for filtering the activity","items":{"type":"string"},"title":"[]string","type":"array","x-stream-index":"008"},"interest_tags":{"description":"Tags indicating interest categories","items":{"type":"string"},"title":"[]string","type":"array","x-stream-index":"009"},"location":{"$ref":"#/components/schemas/ActivityLocation","description":"Geographic location for the activity","title":"ActivityLocation","x-stream-index":"006"},"poll_id":{"description":"Poll ID","title":"string","type":"string","x-stream-index":"010"},"text":{"description":"The text content of the activity","title":"string","type":"string","x-stream-index":"002"},"visibility":{"description":"Visibility setting for the activity","title":"string","type":"string","x-stream-index":"005"}},"type":"object"},"UpdateActivityResponse":{"nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","description":"The updated activity","title":"ActivityResponse","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["activity","duration"],"type":"object"},"UpdateBlockListRequest":{"nullable":true,"properties":{"team":{"type":"string","x-stream-index":"002"},"words":{"description":"List of words to block","items":{"type":"string"},"minimum":1,"title":"Words","type":"array","x-stream-index":"003"}},"title":"Update block list","type":"object","x-stream-docs-page-id":"update_block_list"},"UpdateBlockListResponse":{"description":"Basic response information","nullable":true,"properties":{"blocklist":{"$ref":"#/components/schemas/BlockListResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["duration"],"title":"Response","type":"object"},"UpdateBookmarkFolderRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"description":"Custom data for the folder","title":"Custom Data","type":"object","x-stream-index":"003"},"name":{"description":"Name of the folder","maxLength":255,"title":"Name","type":"string","x-stream-index":"002"}},"title":"Update Bookmark Folder Request","type":"object"},"UpdateBookmarkFolderResponse":{"nullable":true,"properties":{"bookmark_folder":{"$ref":"#/components/schemas/BookmarkFolderResponse","description":"The updated bookmark folder","title":"Bookmark Folder","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["bookmark_folder","duration"],"title":"Update Bookmark Folder Response","type":"object"},"UpdateBookmarkRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"description":"Custom data for the bookmark","title":"Custom Data","type":"object","x-stream-index":"005"},"folder_id":{"description":"ID of the folder to move the bookmark to","maxLength":255,"title":"Folder ID","type":"string","x-stream-index":"002"},"new_folder":{"$ref":"#/components/schemas/AddFolderRequest","x-stream-index":"004"},"new_folder_id":{"maxLength":255,"type":"string","x-stream-index":"003"}},"title":"Update Bookmark Request","type":"object"},"UpdateBookmarkResponse":{"nullable":true,"properties":{"bookmark":{"$ref":"#/components/schemas/BookmarkResponse","description":"The updated bookmark","title":"Bookmark","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["bookmark","duration"],"title":"Update Bookmark Response","type":"object"},"UpdateCallMembersRequest":{"description":"Update call members","nullable":true,"properties":{"remove_members":{"description":"List of userID to remove","items":{"type":"string"},"maximum":100,"title":"Remove Members","type":"array","x-stream-index":"003"},"update_members":{"description":"List of members to update or insert","items":{"$ref":"#/components/schemas/MemberRequest"},"maximum":100,"title":"Update Members","type":"array","x-stream-index":"004"}},"title":"UpdateCallMembersRequest","type":"object"},"UpdateCallMembersResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"002"}},"required":["duration","members"],"title":"Response","type":"object"},"UpdateCallRequest":{"description":"Request for updating a call","nullable":true,"properties":{"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"003"},"settings_override":{"$ref":"#/components/schemas/CallSettingsRequest","description":"the settings to change for this call","title":"Settings Override","x-stream-index":"004"},"starts_at":{"description":"the time the call is scheduled to start","format":"date-time","title":"Starts At","type":"number","x-stream-index":"005"}},"title":"UpdateCallRequest","type":"object"},"UpdateCallResponse":{"description":"Response for updating a call","nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001.001"},"duration":{"type":"string","x-stream-index":"002.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001.002"},"membership":{"$ref":"#/components/schemas/MemberResponse","x-stream-index":"001.003"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"001.004"}},"required":["call","members","own_capabilities","blocked_users","duration"],"title":"UpdateCallResponse","type":"object"},"UpdateChannelPartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"type":"object","x-stream-index":"002.001"},"unset":{"items":{"type":"string"},"type":"array","x-stream-index":"002.002"}},"title":"UpdateChannelPartialRequest","type":"object"},"UpdateChannelPartialResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Updated channel object","title":"Channel","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"members":{"description":"List of updated members","items":{"$ref":"#/components/schemas/ChannelMemberResponse"},"title":"ChannelMemberResponse","type":"array","x-stream-index":"002"}},"required":["members","duration"],"type":"object"},"UpdateChannelRequest":{"nullable":true,"properties":{"accept_invite":{"description":"Set to `true` to accept the invite","title":"Accept invite","type":"boolean","x-stream-index":"008"},"add_members":{"description":"List of user IDs to add to the channel","items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"title":"Add members","type":"array","x-stream-index":"001"},"add_moderators":{"description":"List of user IDs to make channel moderators","items":{"type":"string"},"maximum":100,"title":"Add moderators","type":"array","x-stream-index":"003"},"assign_roles":{"description":"List of channel member role assignments. If any specified user is not part of the channel, the request will fail","items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"title":"Assign roles","type":"array","x-stream-index":"006"},"cooldown":{"description":"Sets cool down period for the channel in seconds","format":"int32","maximum":120,"minimum":0,"title":"Cool down","type":"integer","x-stream-index":"007"},"data":{"$ref":"#/components/schemas/ChannelInput","x-stream-index":"013.001"},"demote_moderators":{"description":"List of user IDs to take away moderators status from","items":{"type":"string"},"maximum":100,"title":"Demote moderators","type":"array","x-stream-index":"004"},"hide_history":{"description":"Set to `true` to hide channel's history when adding new members","title":"Hide history","type":"boolean","x-stream-index":"012"},"invites":{"description":"List of user IDs to invite to the channel","items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"title":"Invites","type":"array","x-stream-index":"005"},"message":{"$ref":"#/components/schemas/MessageRequest","description":"Message to send to the chat when channel is successfully updated","title":"Message","x-stream-index":"010"},"reject_invite":{"description":"Set to `true` to reject the invite","title":"Reject invite","type":"boolean","x-stream-index":"009"},"remove_members":{"description":"List of user IDs to remove from the channel","items":{"type":"string"},"maximum":100,"title":"Remove members","type":"array","x-stream-index":"002"},"skip_push":{"description":"When `message` is set disables all push notifications for it","title":"Skip push","type":"boolean","x-stream-index":"011"}},"title":"Channel update request","type":"object","x-stream-docs-page-id":"channel_update"},"UpdateChannelResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Updated channel","title":"Channel","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"004.001"},"members":{"description":"List of channel members","items":{"$ref":"#/components/schemas/ChannelMember"},"title":"Members","type":"array","x-stream-index":"003"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Message sent to the chat","title":"Message","x-stream-index":"002"}},"required":["members","duration"],"type":"object"},"UpdateCommentRequest":{"nullable":true,"properties":{"comment":{"description":"Updated text content of the comment","title":"Comment","type":"string","x-stream-index":"002"},"custom":{"additionalProperties":{},"description":"Updated custom data for the comment","title":"Custom Data","type":"object","x-stream-index":"003"},"skip_push":{"type":"boolean","x-stream-index":"004"}},"title":"Update Comment Request","type":"object"},"UpdateCommentResponse":{"nullable":true,"properties":{"comment":{"$ref":"#/components/schemas/CommentResponse","description":"The updated comment","title":"Comment","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["comment","duration"],"title":"Update Comment Response","type":"object"},"UpdateFeedMembersRequest":{"nullable":true,"properties":{"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"006.001"},"members":{"description":"List of members to upsert, remove, or set","items":{"$ref":"#/components/schemas/FeedMemberRequest"},"title":"Members","type":"array","x-stream-index":"004"},"next":{"type":"string","x-stream-index":"006.002"},"operation":{"description":"Type of update operation to perform","enum":["upsert","remove","set"],"title":"Operation","type":"string","x-stream-index":"003"},"prev":{"type":"string","x-stream-index":"006.003"}},"required":["operation"],"title":"Update Feed Members Request","type":"object"},"UpdateFeedMembersResponse":{"description":"Basic response information","nullable":true,"properties":{"added":{"items":{"$ref":"#/components/schemas/FeedMemberResponse"},"type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"004.001"},"removed_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"updated":{"items":{"$ref":"#/components/schemas/FeedMemberResponse"},"type":"array","x-stream-index":"002"}},"required":["added","updated","removed_ids","duration"],"title":"Response","type":"object"},"UpdateFeedRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"description":"Custom data for the feed","title":"Custom Data","type":"object","x-stream-index":"004"}},"title":"Update Feed Request","type":"object"},"UpdateFeedResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"feed":{"$ref":"#/components/schemas/FeedResponse","description":"The updated feed","title":"Feed","x-stream-index":"001"}},"required":["feed","duration"],"title":"Update Feed Response","type":"object"},"UpdateFollowRequest":{"nullable":true,"properties":{"create_notification_activity":{"description":"Whether to create a notification activity for this follow","title":"Create Notification Activity","type":"boolean","x-stream-index":"001.004"},"custom":{"additionalProperties":{},"description":"Custom data for the follow relationship","title":"Custom Data","type":"object","x-stream-index":"001.002"},"follower_role":{"type":"string","x-stream-index":"002"},"push_preference":{"description":"Push preference for the follow relationship","enum":["all","none"],"title":"Push Preference","type":"string","x-stream-index":"001.003"},"skip_push":{"type":"boolean","x-stream-index":"001.005"},"source":{"description":"Fully qualified ID of the source feed","maxLength":255,"title":"Source Feed","type":"string","x-stream-index":"001.001.001"},"target":{"description":"Fully qualified ID of the target feed","maxLength":255,"title":"Target Feed","type":"string","x-stream-index":"001.001.002"}},"required":["source","target"],"title":"Update Follow Request","type":"object"},"UpdateFollowResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"follow":{"$ref":"#/components/schemas/FollowResponse","description":"Details of the updated follow relationship","title":"Follow","x-stream-index":"001"}},"required":["follow","duration"],"title":"Update Follow Response","type":"object"},"UpdateLiveLocationRequest":{"nullable":true,"properties":{"end_at":{"description":"Time when the live location expires","format":"date-time","title":"string","type":"number","x-stream-index":"004"},"latitude":{"description":"Latitude coordinate","format":"float","maximum":90,"minimum":18446744073709552000,"title":"number","type":"number","x-stream-index":"002"},"longitude":{"description":"Longitude coordinate","format":"float","maximum":180,"minimum":18446744073709552000,"title":"number","type":"number","x-stream-index":"003"},"message_id":{"description":"Live location ID","title":"string","type":"string","x-stream-index":"001"}},"required":["message_id"],"type":"object"},"UpdateMemberPartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"type":"object","x-stream-index":"002.001"},"unset":{"items":{"type":"string"},"type":"array","x-stream-index":"002.002"}},"type":"object"},"UpdateMemberPartialResponse":{"nullable":true,"properties":{"channel_member":{"$ref":"#/components/schemas/ChannelMemberResponse","description":"Updated channel member","title":"Channel member","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["duration"],"type":"object"},"UpdateMessagePartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"description":"Sets new field values","title":"Set","type":"object","x-stream-index":"002.001","x-stream-map":{"key":"field","title":"Value","description":"New value to set"}},"skip_enrich_url":{"description":"Skip enriching the URL in the message","title":"SkipEnrichURL","type":"boolean","x-stream-index":"001"},"unset":{"description":"Array of field names to unset","items":{"type":"string"},"title":"Unset","type":"array","x-stream-index":"002.002"}},"type":"object"},"UpdateMessagePartialResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Updated message","title":"Message","x-stream-index":"001"},"pending_message_metadata":{"additionalProperties":{"type":"string"},"description":"Pending message metadata","title":"PendingMessageMetadata","type":"object","x-stream-index":"002"}},"required":["duration"],"type":"object"},"UpdateMessageRequest":{"nullable":true,"properties":{"message":{"$ref":"#/components/schemas/MessageRequest","description":"Message","title":"MessageRequest","x-stream-index":"001"},"skip_enrich_url":{"description":"Skip enrich URL","title":"boolean","type":"boolean","x-stream-index":"003"},"skip_push":{"type":"boolean","x-stream-index":"002"}},"required":["message"],"type":"object"},"UpdateMessageResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001"},"pending_message_metadata":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"002"}},"required":["message","duration"],"title":"Response","type":"object"},"UpdatePollOptionRequest":{"nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"004"},"id":{"description":"Option ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"},"text":{"description":"Option text","title":"string","type":"string","x-stream-index":"003"}},"required":["id","text"],"type":"object"},"UpdatePollPartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"description":"Sets new field values","title":"Set","type":"object","x-stream-index":"002.001","x-stream-map":{"key":"field","title":"Value","description":"New value to set"}},"unset":{"description":"Array of field names to unset","items":{"type":"string"},"title":"Unset","type":"array","x-stream-index":"002.002"}},"type":"object"},"UpdatePollRequest":{"nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"011"},"allow_answers":{"description":"Allow answers","title":"boolean","type":"boolean","x-stream-index":"009"},"allow_user_suggested_options":{"description":"Allow user suggested options","title":"boolean","type":"boolean","x-stream-index":"008"},"description":{"description":"Poll description","title":"string","type":"string","x-stream-index":"003"},"enforce_unique_vote":{"description":"Enforce unique vote","title":"boolean","type":"boolean","x-stream-index":"005"},"id":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"},"is_closed":{"description":"Is closed","title":"boolean","type":"boolean","x-stream-index":"010"},"max_votes_allowed":{"description":"Max votes allowed","format":"int32","maximum":10,"title":"integer","type":"integer","x-stream-index":"007"},"name":{"description":"Poll name","title":"string","type":"string","x-stream-index":"002"},"options":{"description":"Poll options","items":{"$ref":"#/components/schemas/PollOptionRequest"},"maximum":100,"title":"PollOptions","type":"array","x-stream-index":"004"},"voting_visibility":{"description":"Voting visibility","enum":["anonymous","public"],"title":"string","type":"string","x-stream-index":"006"}},"required":["id","name"],"type":"object"},"UpdateReminderRequest":{"nullable":true,"properties":{"remind_at":{"format":"date-time","type":"number","x-stream-index":"001"}},"type":"object"},"UpdateReminderResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"001"}},"required":["reminder","duration"],"title":"Response","type":"object"},"UpdateThreadPartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"description":"Sets new field values","title":"Set","type":"object","x-stream-index":"004.001","x-stream-map":{"key":"field","title":"Value","description":"New value to set"}},"unset":{"description":"Array of field names to unset","items":{"type":"string"},"title":"Unset","type":"array","x-stream-index":"004.002"}},"type":"object"},"UpdateThreadPartialResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"thread":{"$ref":"#/components/schemas/ThreadResponse","description":"Updated thread (not enriched)","title":"Thread","x-stream-index":"001"}},"required":["thread","duration"],"type":"object"},"UpdateUserPartialRequest":{"properties":{"id":{"description":"User ID to update","title":"ID","type":"string","x-stream-index":"001"},"set":{"additionalProperties":{},"type":"object","x-stream-index":"002.001"},"unset":{"items":{"type":"string"},"type":"array","x-stream-index":"002.002"}},"required":["id"],"type":"object"},"UpdateUserPermissionsRequest":{"nullable":true,"properties":{"grant_permissions":{"items":{"type":"string"},"type":"array","x-stream-index":"002"},"revoke_permissions":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"user_id":{"type":"string","x-stream-index":"001"}},"required":["user_id"],"type":"object"},"UpdateUserPermissionsResponse":{"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"},"UpdateUsersPartialRequest":{"nullable":true,"properties":{"users":{"items":{"$ref":"#/components/schemas/UpdateUserPartialRequest"},"maximum":100,"type":"array","x-stream-index":"001"}},"required":["users"],"type":"object"},"UpdateUsersRequest":{"nullable":true,"properties":{"users":{"additionalProperties":{"$ref":"#/components/schemas/UserRequest"},"description":"Object containing users","title":"Users","type":"object","x-stream-index":"001","x-stream-map":{"key":"user_id"}}},"required":["users"],"type":"object"},"UpdateUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"membership_deletion_task_id":{"type":"string","x-stream-index":"002"},"users":{"additionalProperties":{"$ref":"#/components/schemas/FullUserResponse"},"description":"Object containing users","title":"Users","type":"object","x-stream-index":"001","x-stream-map":{"key":"user_id"}}},"required":["users","membership_deletion_task_id","duration"],"type":"object"},"UpdatedCallPermissionsEvent":{"description":"This event is sent to notify about permission changes for a user, clients receiving this event should update their UI accordingly","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"own_capabilities":{"description":"The capabilities of the current user","items":{"$ref":"#/components/schemas/OwnCapability"},"title":"Own capabilities","type":"array","x-stream-index":"004"},"type":{"default":"call.permissions_updated","description":"The type of event: \"call.permissions_updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who received the new permissions","title":"User","x-stream-index":"003"}},"required":["type","created_at","call_cid","user","own_capabilities"],"title":"UpdatedCallPermissionsEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"UpsertActivitiesRequest":{"nullable":true,"properties":{"activities":{"description":"List of activities to create or update","items":{"$ref":"#/components/schemas/ActivityRequest"},"maximum":100,"minimum":1,"title":"Activities","type":"array","x-stream-index":"001"}},"required":["activities"],"title":"Upsert Activities Request","type":"object"},"UpsertActivitiesResponse":{"nullable":true,"properties":{"activities":{"description":"List of created or updated activities","items":{"$ref":"#/components/schemas/ActivityResponse"},"title":"Activities","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["activities","duration"],"title":"Upsert Activities Response","type":"object"},"UpsertConfigRequest":{"nullable":true,"properties":{"ai_image_config":{"$ref":"#/components/schemas/AIImageConfig","description":"Configuration for AI image analysis","title":"AI Image Config","x-stream-index":"011"},"ai_text_config":{"$ref":"#/components/schemas/AITextConfig","description":"Configuration for AI text analysis","title":"AI Text Config","x-stream-index":"008"},"ai_video_config":{"$ref":"#/components/schemas/AIVideoConfig","description":"Configuration for AI video analysis","title":"AI Video Config","x-stream-index":"012"},"async":{"description":"Whether moderation should be performed asynchronously","title":"Async","type":"boolean","x-stream-index":"003"},"automod_platform_circumvention_config":{"$ref":"#/components/schemas/AutomodPlatformCircumventionConfig","description":"Configuration for platform circumvention detection","title":"Automod Platform Circumvention Config","x-stream-index":"005"},"automod_semantic_filters_config":{"$ref":"#/components/schemas/AutomodSemanticFiltersConfig","description":"Configuration for semantic filtering","title":"Automod Semantic Filters Config","x-stream-index":"006"},"automod_toxicity_config":{"$ref":"#/components/schemas/AutomodToxicityConfig","description":"Configuration for toxicity detection","title":"Automod Toxicity Config","x-stream-index":"004"},"aws_rekognition_config":{"$ref":"#/components/schemas/AIImageConfig","x-stream-index":"016"},"block_list_config":{"$ref":"#/components/schemas/BlockListConfig","description":"Configuration for block list filtering","title":"Block List Config","x-stream-index":"007"},"bodyguard_config":{"$ref":"#/components/schemas/AITextConfig","x-stream-index":"015"},"google_vision_config":{"$ref":"#/components/schemas/GoogleVisionConfig","description":"Configuration for Google Vision integration","title":"Google Vision Config","x-stream-index":"010"},"key":{"description":"Unique identifier for the moderation configuration","title":"Key","type":"string","x-stream-index":"001"},"llm_config":{"$ref":"#/components/schemas/LLMConfig","description":"Configuration for customer-configured LLM moderation","title":"LLM Config","x-stream-index":"009"},"rule_builder_config":{"$ref":"#/components/schemas/RuleBuilderConfig","description":"Configuration for custom rule builder (max 3 rules, max 5 conditions per rule)","title":"Rule Builder Config","x-stream-index":"014"},"team":{"description":"Team associated with the configuration","maxLength":128,"minLength":1,"title":"Team","type":"string","x-stream-index":"002"},"velocity_filter_config":{"$ref":"#/components/schemas/VelocityFilterConfig","description":"Configuration for velocity-based filtering","title":"Velocity Filter Config","x-stream-index":"013"},"video_call_rule_config":{"$ref":"#/components/schemas/VideoCallRuleConfig","x-stream-index":"017"}},"required":["key"],"type":"object"},"UpsertConfigResponse":{"nullable":true,"properties":{"config":{"$ref":"#/components/schemas/ConfigResponse","description":"The created or updated moderation configuration","title":"Config","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["duration"],"type":"object"},"UpsertPushPreferencesRequest":{"nullable":true,"properties":{"preferences":{"description":"A list of push preferences for channels, calls, or the user.","items":{"$ref":"#/components/schemas/PushPreferenceInput"},"type":"array","x-stream-index":"001"}},"required":["preferences"],"type":"object"},"UpsertPushPreferencesResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"user_channel_preferences":{"additionalProperties":{"additionalProperties":{"$ref":"#/components/schemas/ChannelPushPreferences"},"type":"object"},"description":"The channel specific push notification preferences, only returned for channels you've edited.","title":"User Channel Notification Preferences","type":"object","x-stream-index":"002"},"user_preferences":{"additionalProperties":{"$ref":"#/components/schemas/PushPreferences"},"description":"The user preferences, always returned regardless if you edited it","title":"User Preferences","type":"object","x-stream-index":"001"}},"required":["user_preferences","user_channel_preferences","duration"],"type":"object"},"User":{"properties":{"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"046"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"017"},"banned":{"type":"boolean","x-stream-index":"016"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"013"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"023"},"language":{"type":"string","x-stream-index":"035"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"026"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"042"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"005"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"009"}},"required":["id","role","teams_role","custom","banned","online"],"type":"object"},"UserBannedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"006.002"},"channel_type":{"type":"string","x-stream-index":"006.003"},"cid":{"type":"string","x-stream-index":"006.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008.002"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"001"},"expiration":{"format":"date-time","type":"number","x-stream-index":"003"},"reason":{"type":"string","x-stream-index":"004"},"shadow":{"type":"boolean","x-stream-index":"002"},"team":{"type":"string","x-stream-index":"005.001"},"type":{"default":"user.banned","type":"string","x-stream-index":"008.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007.001"}},"required":["created_by","shadow","cid","channel_id","channel_type","type","created_at"],"title":"UserBannedEvent","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"},"UserCreatedWithinParameters":{"properties":{"max_age":{"type":"string","x-stream-index":"001"}},"type":"object"},"UserCustomPropertyParameters":{"properties":{"operator":{"type":"string","x-stream-index":"002"},"property_key":{"type":"string","x-stream-index":"001"}},"type":"object"},"UserDeactivatedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"001"},"type":{"default":"user.deactivated","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["created_by","type","created_at"],"title":"UserDeactivatedEvent","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"},"UserDeletedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"delete_conversation_channels":{"type":"boolean","x-stream-index":"005"},"hard_delete":{"type":"boolean","x-stream-index":"003.001"},"mark_messages_deleted":{"type":"boolean","x-stream-index":"004"},"type":{"default":"user.deleted","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"001.001"}},"required":["type","created_at","hard_delete","mark_messages_deleted","delete_conversation_channels"],"title":"UserDeletedEvent","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"},"UserFeedbackReport":{"properties":{"count_by_rating":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001"},"unreported_count":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["count_by_rating","unreported_count"],"type":"object"},"UserFeedbackReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateUserFeedbackReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"UserMessagesDeletedEvent":{"description":"This event is sent when a user's message get deleted. The event contains information about the user whose messages got deleted.","nullable":true,"properties":{"channel_custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.005"},"channel_id":{"description":"The ID of the channel where the target user's messages were deleted","title":"Channel ID","type":"string","x-stream-index":"001.002.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"001.001.004"},"channel_type":{"description":"The type of the channel where the target user's messages were deleted","title":"Channel Type","type":"string","x-stream-index":"001.002.001"},"cid":{"description":"The CID of the channel where the target user's messages were deleted","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":"number","x-stream-index":"001.001.001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.001.001.007"},"hard_delete":{"description":"Whether Messages were hard deleted","title":"Hard Delete","type":"boolean","x-stream-index":"003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.001.001.004"},"team":{"description":"The team of the channel where the target user's messages were deleted","title":"Team","type":"string","x-stream-index":"001.001.003"},"type":{"default":"user.messages.deleted","description":"The type of event: \"user.messages.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.001.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The target user whose messages got deleted","title":"User","x-stream-index":"002.001"}},"required":["type","created_at","custom","user"],"title":"UserMessagesDeletedEvent","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"},"UserMute":{"nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"expires":{"description":"Date/time of mute expiration","format":"date-time","title":"Expires","type":"number","x-stream-index":"008"},"target":{"$ref":"#/components/schemas/User","description":"User who's muted","title":"Target","x-stream-index":"007"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/User","description":"Owner of channel mute","title":"User","x-stream-index":"005"}},"required":["created_at","updated_at"],"type":"object"},"UserMuteResponse":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"expires":{"format":"date-time","type":"number","x-stream-index":"003"},"target":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"}},"required":["created_at","updated_at"],"type":"object"},"UserMutedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"target_user":{"type":"string","x-stream-index":"001"},"target_users":{"items":{"type":"string"},"type":"array","x-stream-index":"002"},"type":{"default":"user.muted","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"UserMutedEvent","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"},"UserPresenceChangedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"type":{"default":"user.presence.changed","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"001.001"}},"required":["type","created_at"],"title":"UserPresenceChangedEvent","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"},"UserRatingReportResponse":{"properties":{"average":{"format":"float","type":"number","x-stream-index":"002"},"count":{"format":"int32","type":"integer","x-stream-index":"001"}},"required":["count","average"],"type":"object"},"UserReactivatedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"type":{"default":"user.reactivated","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"001"}},"required":["type","created_at"],"title":"UserReactivatedEvent","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"},"UserRequest":{"description":"User request object","properties":{"custom":{"additionalProperties":{},"description":"Custom user data","title":"Custom","type":"object","x-stream-index":"004"},"id":{"description":"User ID","title":"ID","type":"string","x-stream-index":"001"},"image":{"description":"User's profile image URL","title":"Image","type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"006"},"language":{"type":"string","x-stream-index":"005"},"name":{"description":"Optional name of user","title":"Name","type":"string","x-stream-index":"002"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"007"}},"required":["id"],"title":"UserRequest","type":"object"},"UserResponse":{"description":"User response object","properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"banned":{"description":"Whether a user is banned or not","title":"Banned","type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.017"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"001.004"},"deactivated_at":{"description":"Date of deactivation","format":"date-time","title":"Deactivated at","type":"number","x-stream-index":"001.016"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"001.011"},"id":{"description":"Unique user identifier","title":"ID","type":"string","x-stream-index":"001.001"},"image":{"title":"Image","type":"string","x-stream-index":"001.003"},"language":{"description":"Preferred language of a user","title":"Language","type":"string","x-stream-index":"001.005"},"last_active":{"description":"Date of last activity","format":"date-time","title":"Last active","type":"number","x-stream-index":"001.014"},"name":{"description":"Optional name of user","title":"Name","type":"string","x-stream-index":"001.002"},"online":{"description":"Whether a user online or not","title":"Online","type":"boolean","x-stream-index":"001.013"},"revoke_tokens_issued_before":{"description":"Revocation date for tokens","format":"date-time","title":"Revoke tokens issued before","type":"number","x-stream-index":"001.015"},"role":{"description":"Determines the set of user permissions","title":"Role","type":"string","x-stream-index":"001.006"},"teams":{"description":"List of teams user is a part of","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids","shadow_banned","invisible"],"title":"UserResponse","type":"object"},"UserResponseCommonFields":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"018"},"banned":{"type":"boolean","x-stream-index":"012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"017"},"created_at":{"format":"date-time","type":"number","x-stream-index":"009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"id":{"type":"string","x-stream-index":"001"},"image":{"type":"string","x-stream-index":"003"},"language":{"type":"string","x-stream-index":"005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"014"},"name":{"type":"string","x-stream-index":"002"},"online":{"type":"boolean","x-stream-index":"013"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"015"},"role":{"type":"string","x-stream-index":"006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids"],"type":"object"},"UserResponsePrivacyFields":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"banned":{"type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.017"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.011"},"id":{"type":"string","x-stream-index":"001.001"},"image":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"003"},"language":{"type":"string","x-stream-index":"001.005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"001.014"},"name":{"type":"string","x-stream-index":"001.002"},"online":{"type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"002"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.015"},"role":{"type":"string","x-stream-index":"001.006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids"],"type":"object"},"UserRuleParameters":{"properties":{"max_age":{"type":"string","x-stream-index":"001"}},"type":"object"},"UserUnbannedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"005.002"},"shadow":{"type":"boolean","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"004.001"},"type":{"default":"user.unbanned","type":"string","x-stream-index":"005.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["shadow","cid","channel_id","channel_type","type","created_at"],"title":"UserUnbannedEvent","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"},"UserUpdatedEvent":{"description":"This event is sent when a user gets updated. The event contains information about the updated user.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"type":{"default":"user.updated","description":"The type of event: \"user.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.002"},"user":{"$ref":"#/components/schemas/UserResponsePrivacyFields","description":"The updated user","title":"User","x-stream-index":"002.001"}},"required":["type","created_at","custom","user"],"title":"UserUpdatedEvent","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"},"UserWatchingStartEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"team":{"type":"string","x-stream-index":"002.001"},"type":{"default":"user.watching.start","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005.001"},"watcher_count":{"format":"int32","type":"integer","x-stream-index":"001.001"}},"required":["watcher_count","type","created_at","cid","channel_id","channel_type"],"title":"UserWatchingStartEvent","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"},"UserWatchingStopEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"type":{"default":"user.watching.stop","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"},"watcher_count":{"format":"int32","type":"integer","x-stream-index":"001.001"}},"required":["watcher_count","type","created_at","cid","channel_id","channel_type"],"title":"UserWatchingStopEvent","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"},"VelocityFilterConfig":{"properties":{"advanced_filters":{"type":"boolean","x-stream-index":"007"},"async":{"type":"boolean","x-stream-index":"001"},"cascading_actions":{"type":"boolean","x-stream-index":"004"},"cids_per_user":{"format":"int32","type":"integer","x-stream-index":"006"},"enabled":{"type":"boolean","x-stream-index":"002"},"first_message_only":{"type":"boolean","x-stream-index":"005"},"rules":{"items":{"$ref":"#/components/schemas/VelocityFilterConfigRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules","cascading_actions","first_message_only","cids_per_user","advanced_filters"],"type":"object"},"VelocityFilterConfigRule":{"properties":{"action":{"enum":["flag","shadow","remove","ban"],"type":"string","x-stream-index":"001"},"ban_duration":{"format":"int32","type":"integer","x-stream-index":"002"},"cascading_action":{"enum":["flag","shadow","remove","ban"],"type":"string","x-stream-index":"006"},"cascading_threshold":{"format":"int64","type":"integer","x-stream-index":"005"},"check_message_context":{"type":"boolean","x-stream-index":"009"},"fast_spam_threshold":{"format":"int32","type":"integer","x-stream-index":"007"},"fast_spam_ttl":{"format":"int32","type":"integer","x-stream-index":"010"},"ip_ban":{"type":"boolean","x-stream-index":"004"},"probation_period":{"format":"int32","type":"integer","x-stream-index":"014"},"shadow_ban":{"type":"boolean","x-stream-index":"003"},"slow_spam_ban_duration":{"format":"int32","type":"integer","x-stream-index":"012"},"slow_spam_threshold":{"format":"int32","type":"integer","x-stream-index":"008"},"slow_spam_ttl":{"format":"int32","type":"integer","x-stream-index":"011"},"url_only":{"type":"boolean","x-stream-index":"013"}},"required":["action","ban_duration","shadow_ban","ip_ban","cascading_threshold","cascading_action","fast_spam_threshold","slow_spam_threshold","check_message_context","fast_spam_ttl","slow_spam_ttl","url_only","probation_period"],"type":"object"},"VideoCallRuleConfig":{"properties":{"rules":{"additionalProperties":{"$ref":"#/components/schemas/HarmConfig"},"type":"object","x-stream-index":"001"}},"required":["rules"],"type":"object"},"VideoContentParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"type":"object"},"VideoEndCallRequest":{"type":"object"},"VideoKickUserRequest":{"type":"object"},"VideoOrientation":{"properties":{"orientation":{"type":"integer","x-stream-index":"004"}},"type":"object"},"VideoReactionOverTimeResponse":{"properties":{"by_minute":{"items":{"$ref":"#/components/schemas/CountByMinuteResponse"},"type":"array","x-stream-index":"001"}},"type":"object"},"VideoReactionsResponse":{"nullable":true,"properties":{"count_over_time":{"$ref":"#/components/schemas/VideoReactionOverTimeResponse","x-stream-index":"002"},"reaction":{"type":"string","x-stream-index":"001"}},"required":["reaction"],"type":"object"},"VideoRuleParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"type":"object"},"VideoSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"camera_default_on":{"type":"boolean","x-stream-index":"004"},"camera_facing":{"enum":["front","back","external"],"type":"string","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled","target_resolution","camera_default_on","camera_facing"],"type":"object"},"VideoSettingsRequest":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"camera_default_on":{"type":"boolean","x-stream-index":"004"},"camera_facing":{"enum":["front","back","external"],"type":"string","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"type":"object"},"VideoSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"camera_default_on":{"type":"boolean","x-stream-index":"004"},"camera_facing":{"enum":["front","back","external"],"type":"string","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled","target_resolution","camera_default_on","camera_facing"],"type":"object"},"VoteData":{"properties":{"answer_text":{"type":"string","x-stream-index":"002"},"option_id":{"maxLength":255,"type":"string","x-stream-index":"001"}},"type":"object"},"WSAuthMessage":{"description":"Websocket auth message","nullable":true,"properties":{"products":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"token":{"title":"Token","type":"string","x-stream-index":"002"},"user_details":{"$ref":"#/components/schemas/ConnectUserDetailsRequest","x-stream-index":"001"}},"required":["user_details","token"],"title":"WSAuthMessage","type":"object"},"WSClientEvent":{"description":"The discriminator object for all websocket client events, it maps events' payload to the final type","discriminator":{"mapping":{"app.updated":"#/components/schemas/AppUpdatedEvent","draft.deleted":"#/components/schemas/DraftDeletedEvent","draft.updated":"#/components/schemas/DraftUpdatedEvent","feeds.activity.added":"#/components/schemas/ActivityAddedEvent","feeds.activity.deleted":"#/components/schemas/ActivityDeletedEvent","feeds.activity.marked":"#/components/schemas/ActivityMarkEvent","feeds.activity.pinned":"#/components/schemas/ActivityPinnedEvent","feeds.activity.reaction.added":"#/components/schemas/ActivityReactionAddedEvent","feeds.activity.reaction.deleted":"#/components/schemas/ActivityReactionDeletedEvent","feeds.activity.reaction.updated":"#/components/schemas/ActivityReactionUpdatedEvent","feeds.activity.removed_from_feed":"#/components/schemas/ActivityRemovedFromFeedEvent","feeds.activity.unpinned":"#/components/schemas/ActivityUnpinnedEvent","feeds.activity.updated":"#/components/schemas/ActivityUpdatedEvent","feeds.bookmark.added":"#/components/schemas/BookmarkAddedEvent","feeds.bookmark.deleted":"#/components/schemas/BookmarkDeletedEvent","feeds.bookmark.updated":"#/components/schemas/BookmarkUpdatedEvent","feeds.bookmark_folder.deleted":"#/components/schemas/BookmarkFolderDeletedEvent","feeds.bookmark_folder.updated":"#/components/schemas/BookmarkFolderUpdatedEvent","feeds.comment.added":"#/components/schemas/CommentAddedEvent","feeds.comment.deleted":"#/components/schemas/CommentDeletedEvent","feeds.comment.reaction.added":"#/components/schemas/CommentReactionAddedEvent","feeds.comment.reaction.deleted":"#/components/schemas/CommentReactionDeletedEvent","feeds.comment.reaction.updated":"#/components/schemas/CommentReactionUpdatedEvent","feeds.comment.updated":"#/components/schemas/CommentUpdatedEvent","feeds.feed.created":"#/components/schemas/FeedCreatedEvent","feeds.feed.deleted":"#/components/schemas/FeedDeletedEvent","feeds.feed.updated":"#/components/schemas/FeedUpdatedEvent","feeds.feed_group.changed":"#/components/schemas/FeedGroupChangedEvent","feeds.feed_group.deleted":"#/components/schemas/FeedGroupDeletedEvent","feeds.feed_member.added":"#/components/schemas/FeedMemberAddedEvent","feeds.feed_member.removed":"#/components/schemas/FeedMemberRemovedEvent","feeds.feed_member.updated":"#/components/schemas/FeedMemberUpdatedEvent","feeds.follow.created":"#/components/schemas/FollowCreatedEvent","feeds.follow.deleted":"#/components/schemas/FollowDeletedEvent","feeds.follow.updated":"#/components/schemas/FollowUpdatedEvent","feeds.notification_feed.updated":"#/components/schemas/NotificationFeedUpdatedEvent","feeds.poll.closed":"#/components/schemas/PollClosedFeedEvent","feeds.poll.deleted":"#/components/schemas/PollDeletedFeedEvent","feeds.poll.updated":"#/components/schemas/PollUpdatedFeedEvent","feeds.poll.vote_casted":"#/components/schemas/PollVoteCastedFeedEvent","feeds.poll.vote_changed":"#/components/schemas/PollVoteChangedFeedEvent","feeds.poll.vote_removed":"#/components/schemas/PollVoteRemovedFeedEvent","health.check":"#/components/schemas/HealthCheckEvent","message.pending":"#/components/schemas/PendingMessageEvent","notification.reminder_due":"#/components/schemas/ReminderNotificationEvent","poll.closed":"#/components/schemas/PollClosedEvent","poll.deleted":"#/components/schemas/PollDeletedEvent","poll.updated":"#/components/schemas/PollUpdatedEvent","poll.vote_casted":"#/components/schemas/PollVoteCastedEvent","poll.vote_changed":"#/components/schemas/PollVoteChangedEvent","poll.vote_removed":"#/components/schemas/PollVoteRemovedEvent","reminder.created":"#/components/schemas/ReminderCreatedEvent","reminder.deleted":"#/components/schemas/ReminderDeletedEvent","reminder.updated":"#/components/schemas/ReminderUpdatedEvent","user.messages.deleted":"#/components/schemas/UserMessagesDeletedEvent","user.updated":"#/components/schemas/UserUpdatedEvent"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/ActivityAddedEvent"},{"$ref":"#/components/schemas/ActivityDeletedEvent"},{"$ref":"#/components/schemas/ActivityMarkEvent"},{"$ref":"#/components/schemas/ActivityPinnedEvent"},{"$ref":"#/components/schemas/ActivityReactionAddedEvent"},{"$ref":"#/components/schemas/ActivityReactionDeletedEvent"},{"$ref":"#/components/schemas/ActivityReactionUpdatedEvent"},{"$ref":"#/components/schemas/ActivityRemovedFromFeedEvent"},{"$ref":"#/components/schemas/ActivityUnpinnedEvent"},{"$ref":"#/components/schemas/ActivityUpdatedEvent"},{"$ref":"#/components/schemas/AppUpdatedEvent"},{"$ref":"#/components/schemas/BookmarkAddedEvent"},{"$ref":"#/components/schemas/BookmarkDeletedEvent"},{"$ref":"#/components/schemas/BookmarkFolderDeletedEvent"},{"$ref":"#/components/schemas/BookmarkFolderUpdatedEvent"},{"$ref":"#/components/schemas/BookmarkUpdatedEvent"},{"$ref":"#/components/schemas/CommentAddedEvent"},{"$ref":"#/components/schemas/CommentDeletedEvent"},{"$ref":"#/components/schemas/CommentReactionAddedEvent"},{"$ref":"#/components/schemas/CommentReactionDeletedEvent"},{"$ref":"#/components/schemas/CommentReactionUpdatedEvent"},{"$ref":"#/components/schemas/CommentUpdatedEvent"},{"$ref":"#/components/schemas/DraftDeletedEvent"},{"$ref":"#/components/schemas/DraftUpdatedEvent"},{"$ref":"#/components/schemas/FeedCreatedEvent"},{"$ref":"#/components/schemas/FeedDeletedEvent"},{"$ref":"#/components/schemas/FeedGroupChangedEvent"},{"$ref":"#/components/schemas/FeedGroupDeletedEvent"},{"$ref":"#/components/schemas/FeedMemberAddedEvent"},{"$ref":"#/components/schemas/FeedMemberRemovedEvent"},{"$ref":"#/components/schemas/FeedMemberUpdatedEvent"},{"$ref":"#/components/schemas/FeedUpdatedEvent"},{"$ref":"#/components/schemas/FollowCreatedEvent"},{"$ref":"#/components/schemas/FollowDeletedEvent"},{"$ref":"#/components/schemas/FollowUpdatedEvent"},{"$ref":"#/components/schemas/HealthCheckEvent"},{"$ref":"#/components/schemas/NotificationFeedUpdatedEvent"},{"$ref":"#/components/schemas/PendingMessageEvent"},{"$ref":"#/components/schemas/PollClosedEvent"},{"$ref":"#/components/schemas/PollClosedFeedEvent"},{"$ref":"#/components/schemas/PollDeletedEvent"},{"$ref":"#/components/schemas/PollDeletedFeedEvent"},{"$ref":"#/components/schemas/PollUpdatedEvent"},{"$ref":"#/components/schemas/PollUpdatedFeedEvent"},{"$ref":"#/components/schemas/PollVoteCastedEvent"},{"$ref":"#/components/schemas/PollVoteCastedFeedEvent"},{"$ref":"#/components/schemas/PollVoteChangedEvent"},{"$ref":"#/components/schemas/PollVoteChangedFeedEvent"},{"$ref":"#/components/schemas/PollVoteRemovedEvent"},{"$ref":"#/components/schemas/PollVoteRemovedFeedEvent"},{"$ref":"#/components/schemas/ReminderCreatedEvent"},{"$ref":"#/components/schemas/ReminderDeletedEvent"},{"$ref":"#/components/schemas/ReminderNotificationEvent"},{"$ref":"#/components/schemas/ReminderUpdatedEvent"},{"$ref":"#/components/schemas/UserMessagesDeletedEvent"},{"$ref":"#/components/schemas/UserUpdatedEvent"}]},"WSEvent":{"description":"The discriminator object for all websocket events, it maps events' payload to the final type","discriminator":{"mapping":{"*":"#/components/schemas/AnyEvent","activity.marked":"#/components/schemas/ActivityMarkedEvent","ai_indicator.clear":"#/components/schemas/AIIndicatorClearEvent","ai_indicator.stop":"#/components/schemas/AIIndicatorStopEvent","ai_indicator.update":"#/components/schemas/AIIndicatorUpdateEvent","app.updated":"#/components/schemas/AppUpdatedEvent","call.accepted":"#/components/schemas/CallAcceptedEvent","call.blocked_user":"#/components/schemas/BlockedUserEvent","call.closed_caption":"#/components/schemas/ClosedCaptionEvent","call.closed_captions_failed":"#/components/schemas/CallClosedCaptionsFailedEvent","call.closed_captions_started":"#/components/schemas/CallClosedCaptionsStartedEvent","call.closed_captions_stopped":"#/components/schemas/CallClosedCaptionsStoppedEvent","call.created":"#/components/schemas/CallCreatedEvent","call.deleted":"#/components/schemas/CallDeletedEvent","call.ended":"#/components/schemas/CallEndedEvent","call.frame_recording_failed":"#/components/schemas/CallFrameRecordingFailedEvent","call.frame_recording_ready":"#/components/schemas/CallFrameRecordingFrameReadyEvent","call.frame_recording_started":"#/components/schemas/CallFrameRecordingStartedEvent","call.frame_recording_stopped":"#/components/schemas/CallFrameRecordingStoppedEvent","call.hls_broadcasting_failed":"#/components/schemas/CallHLSBroadcastingFailedEvent","call.hls_broadcasting_started":"#/components/schemas/CallHLSBroadcastingStartedEvent","call.hls_broadcasting_stopped":"#/components/schemas/CallHLSBroadcastingStoppedEvent","call.kicked_user":"#/components/schemas/KickedUserEvent","call.live_started":"#/components/schemas/CallLiveStartedEvent","call.member_added":"#/components/schemas/CallMemberAddedEvent","call.member_removed":"#/components/schemas/CallMemberRemovedEvent","call.member_updated":"#/components/schemas/CallMemberUpdatedEvent","call.member_updated_permission":"#/components/schemas/CallMemberUpdatedPermissionEvent","call.missed":"#/components/schemas/CallMissedEvent","call.moderation_blur":"#/components/schemas/CallModerationBlurEvent","call.moderation_warning":"#/components/schemas/CallModerationWarningEvent","call.notification":"#/components/schemas/CallNotificationEvent","call.permission_request":"#/components/schemas/PermissionRequestEvent","call.permissions_updated":"#/components/schemas/UpdatedCallPermissionsEvent","call.reaction_new":"#/components/schemas/CallReactionEvent","call.recording_failed":"#/components/schemas/CallRecordingFailedEvent","call.recording_ready":"#/components/schemas/CallRecordingReadyEvent","call.recording_started":"#/components/schemas/CallRecordingStartedEvent","call.recording_stopped":"#/components/schemas/CallRecordingStoppedEvent","call.rejected":"#/components/schemas/CallRejectedEvent","call.ring":"#/components/schemas/CallRingEvent","call.rtmp_broadcast_failed":"#/components/schemas/CallRtmpBroadcastFailedEvent","call.rtmp_broadcast_started":"#/components/schemas/CallRtmpBroadcastStartedEvent","call.rtmp_broadcast_stopped":"#/components/schemas/CallRtmpBroadcastStoppedEvent","call.session_ended":"#/components/schemas/CallSessionEndedEvent","call.session_participant_count_updated":"#/components/schemas/CallSessionParticipantCountsUpdatedEvent","call.session_participant_joined":"#/components/schemas/CallSessionParticipantJoinedEvent","call.session_participant_left":"#/components/schemas/CallSessionParticipantLeftEvent","call.session_started":"#/components/schemas/CallSessionStartedEvent","call.stats_report_ready":"#/components/schemas/CallStatsReportReadyEvent","call.transcription_failed":"#/components/schemas/CallTranscriptionFailedEvent","call.transcription_ready":"#/components/schemas/CallTranscriptionReadyEvent","call.transcription_started":"#/components/schemas/CallTranscriptionStartedEvent","call.transcription_stopped":"#/components/schemas/CallTranscriptionStoppedEvent","call.unblocked_user":"#/components/schemas/UnblockedUserEvent","call.updated":"#/components/schemas/CallUpdatedEvent","call.user_feedback_submitted":"#/components/schemas/CallUserFeedbackSubmittedEvent","call.user_muted":"#/components/schemas/CallUserMutedEvent","channel.created":"#/components/schemas/ChannelCreatedEvent","channel.deleted":"#/components/schemas/ChannelDeletedEvent","channel.frozen":"#/components/schemas/ChannelFrozenEvent","channel.hidden":"#/components/schemas/ChannelHiddenEvent","channel.kicked":"#/components/schemas/ChannelKickedEvent","channel.truncated":"#/components/schemas/ChannelTruncatedEvent","channel.unfrozen":"#/components/schemas/ChannelUnFrozenEvent","channel.updated":"#/components/schemas/ChannelUpdatedEvent","channel.visible":"#/components/schemas/ChannelVisibleEvent","connection.error":"#/components/schemas/ConnectionErrorEvent","connection.ok":"#/components/schemas/ConnectedEvent","custom":"#/components/schemas/CustomVideoEvent","draft.deleted":"#/components/schemas/DraftDeletedEvent","draft.updated":"#/components/schemas/DraftUpdatedEvent","feeds.activity.added":"#/components/schemas/ActivityAddedEvent","feeds.activity.deleted":"#/components/schemas/ActivityDeletedEvent","feeds.activity.marked":"#/components/schemas/ActivityMarkEvent","feeds.activity.pinned":"#/components/schemas/ActivityPinnedEvent","feeds.activity.reaction.added":"#/components/schemas/ActivityReactionAddedEvent","feeds.activity.reaction.deleted":"#/components/schemas/ActivityReactionDeletedEvent","feeds.activity.reaction.updated":"#/components/schemas/ActivityReactionUpdatedEvent","feeds.activity.removed_from_feed":"#/components/schemas/ActivityRemovedFromFeedEvent","feeds.activity.unpinned":"#/components/schemas/ActivityUnpinnedEvent","feeds.activity.updated":"#/components/schemas/ActivityUpdatedEvent","feeds.bookmark.added":"#/components/schemas/BookmarkAddedEvent","feeds.bookmark.deleted":"#/components/schemas/BookmarkDeletedEvent","feeds.bookmark.updated":"#/components/schemas/BookmarkUpdatedEvent","feeds.bookmark_folder.deleted":"#/components/schemas/BookmarkFolderDeletedEvent","feeds.bookmark_folder.updated":"#/components/schemas/BookmarkFolderUpdatedEvent","feeds.comment.added":"#/components/schemas/CommentAddedEvent","feeds.comment.deleted":"#/components/schemas/CommentDeletedEvent","feeds.comment.reaction.added":"#/components/schemas/CommentReactionAddedEvent","feeds.comment.reaction.deleted":"#/components/schemas/CommentReactionDeletedEvent","feeds.comment.reaction.updated":"#/components/schemas/CommentReactionUpdatedEvent","feeds.comment.updated":"#/components/schemas/CommentUpdatedEvent","feeds.feed.created":"#/components/schemas/FeedCreatedEvent","feeds.feed.deleted":"#/components/schemas/FeedDeletedEvent","feeds.feed.updated":"#/components/schemas/FeedUpdatedEvent","feeds.feed_group.changed":"#/components/schemas/FeedGroupChangedEvent","feeds.feed_group.deleted":"#/components/schemas/FeedGroupDeletedEvent","feeds.feed_member.added":"#/components/schemas/FeedMemberAddedEvent","feeds.feed_member.removed":"#/components/schemas/FeedMemberRemovedEvent","feeds.feed_member.updated":"#/components/schemas/FeedMemberUpdatedEvent","feeds.follow.created":"#/components/schemas/FollowCreatedEvent","feeds.follow.deleted":"#/components/schemas/FollowDeletedEvent","feeds.follow.updated":"#/components/schemas/FollowUpdatedEvent","feeds.notification_feed.updated":"#/components/schemas/NotificationFeedUpdatedEvent","feeds.poll.closed":"#/components/schemas/PollClosedFeedEvent","feeds.poll.deleted":"#/components/schemas/PollDeletedFeedEvent","feeds.poll.updated":"#/components/schemas/PollUpdatedFeedEvent","feeds.poll.vote_casted":"#/components/schemas/PollVoteCastedFeedEvent","feeds.poll.vote_changed":"#/components/schemas/PollVoteChangedFeedEvent","feeds.poll.vote_removed":"#/components/schemas/PollVoteRemovedFeedEvent","health.check":"#/components/schemas/HealthCheckEvent","member.added":"#/components/schemas/MemberAddedEvent","member.removed":"#/components/schemas/MemberRemovedEvent","member.updated":"#/components/schemas/MemberUpdatedEvent","message.deleted":"#/components/schemas/MessageDeletedEvent","message.new":"#/components/schemas/MessageNewEvent","message.pending":"#/components/schemas/PendingMessageEvent","message.read":"#/components/schemas/MessageReadEvent","message.undeleted":"#/components/schemas/MessageUndeletedEvent","message.updated":"#/components/schemas/MessageUpdatedEvent","moderation.custom_action":"#/components/schemas/ModerationCustomActionEvent","moderation.flagged":"#/components/schemas/ModerationFlaggedEvent","moderation.mark_reviewed":"#/components/schemas/ModerationMarkReviewedEvent","notification.added_to_channel":"#/components/schemas/NotificationAddedToChannelEvent","notification.channel_deleted":"#/components/schemas/NotificationChannelDeletedEvent","notification.channel_mutes_updated":"#/components/schemas/NotificationChannelMutesUpdatedEvent","notification.channel_truncated":"#/components/schemas/NotificationChannelTruncatedEvent","notification.invite_accepted":"#/components/schemas/NotificationInviteAcceptedEvent","notification.invite_rejected":"#/components/schemas/NotificationInviteRejectedEvent","notification.invited":"#/components/schemas/NotificationInvitedEvent","notification.mark_read":"#/components/schemas/NotificationMarkReadEvent","notification.mark_unread":"#/components/schemas/NotificationMarkUnreadEvent","notification.message_new":"#/components/schemas/NotificationNewMessageEvent","notification.mutes_updated":"#/components/schemas/NotificationMutesUpdatedEvent","notification.reminder_due":"#/components/schemas/ReminderNotificationEvent","notification.removed_from_channel":"#/components/schemas/NotificationRemovedFromChannelEvent","notification.thread_message_new":"#/components/schemas/MessageNewEvent","poll.closed":"#/components/schemas/PollClosedEvent","poll.deleted":"#/components/schemas/PollDeletedEvent","poll.updated":"#/components/schemas/PollUpdatedEvent","poll.vote_casted":"#/components/schemas/PollVoteCastedEvent","poll.vote_changed":"#/components/schemas/PollVoteChangedEvent","poll.vote_removed":"#/components/schemas/PollVoteRemovedEvent","reaction.deleted":"#/components/schemas/ReactionDeletedEvent","reaction.new":"#/components/schemas/ReactionNewEvent","reaction.updated":"#/components/schemas/ReactionUpdatedEvent","reminder.created":"#/components/schemas/ReminderCreatedEvent","reminder.deleted":"#/components/schemas/ReminderDeletedEvent","reminder.updated":"#/components/schemas/ReminderUpdatedEvent","thread.updated":"#/components/schemas/ThreadUpdatedEvent","typing.start":"#/components/schemas/TypingStartEvent","typing.stop":"#/components/schemas/TypingStopEvent","user.banned":"#/components/schemas/UserBannedEvent","user.deactivated":"#/components/schemas/UserDeactivatedEvent","user.deleted":"#/components/schemas/UserDeletedEvent","user.messages.deleted":"#/components/schemas/UserMessagesDeletedEvent","user.muted":"#/components/schemas/UserMutedEvent","user.presence.changed":"#/components/schemas/UserPresenceChangedEvent","user.reactivated":"#/components/schemas/UserReactivatedEvent","user.unbanned":"#/components/schemas/UserUnbannedEvent","user.updated":"#/components/schemas/UserUpdatedEvent","user.watching.start":"#/components/schemas/UserWatchingStartEvent","user.watching.stop":"#/components/schemas/UserWatchingStopEvent"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/AIIndicatorClearEvent"},{"$ref":"#/components/schemas/AIIndicatorStopEvent"},{"$ref":"#/components/schemas/AIIndicatorUpdateEvent"},{"$ref":"#/components/schemas/ActivityAddedEvent"},{"$ref":"#/components/schemas/ActivityDeletedEvent"},{"$ref":"#/components/schemas/ActivityMarkEvent"},{"$ref":"#/components/schemas/ActivityMarkedEvent"},{"$ref":"#/components/schemas/ActivityPinnedEvent"},{"$ref":"#/components/schemas/ActivityReactionAddedEvent"},{"$ref":"#/components/schemas/ActivityReactionDeletedEvent"},{"$ref":"#/components/schemas/ActivityReactionUpdatedEvent"},{"$ref":"#/components/schemas/ActivityRemovedFromFeedEvent"},{"$ref":"#/components/schemas/ActivityUnpinnedEvent"},{"$ref":"#/components/schemas/ActivityUpdatedEvent"},{"$ref":"#/components/schemas/AnyEvent"},{"$ref":"#/components/schemas/AppUpdatedEvent"},{"$ref":"#/components/schemas/BlockedUserEvent"},{"$ref":"#/components/schemas/BookmarkAddedEvent"},{"$ref":"#/components/schemas/BookmarkDeletedEvent"},{"$ref":"#/components/schemas/BookmarkFolderDeletedEvent"},{"$ref":"#/components/schemas/BookmarkFolderUpdatedEvent"},{"$ref":"#/components/schemas/BookmarkUpdatedEvent"},{"$ref":"#/components/schemas/CallAcceptedEvent"},{"$ref":"#/components/schemas/CallClosedCaptionsFailedEvent"},{"$ref":"#/components/schemas/CallClosedCaptionsStartedEvent"},{"$ref":"#/components/schemas/CallClosedCaptionsStoppedEvent"},{"$ref":"#/components/schemas/CallCreatedEvent"},{"$ref":"#/components/schemas/CallDeletedEvent"},{"$ref":"#/components/schemas/CallEndedEvent"},{"$ref":"#/components/schemas/CallFrameRecordingFailedEvent"},{"$ref":"#/components/schemas/CallFrameRecordingFrameReadyEvent"},{"$ref":"#/components/schemas/CallFrameRecordingStartedEvent"},{"$ref":"#/components/schemas/CallFrameRecordingStoppedEvent"},{"$ref":"#/components/schemas/CallHLSBroadcastingFailedEvent"},{"$ref":"#/components/schemas/CallHLSBroadcastingStartedEvent"},{"$ref":"#/components/schemas/CallHLSBroadcastingStoppedEvent"},{"$ref":"#/components/schemas/CallLiveStartedEvent"},{"$ref":"#/components/schemas/CallMemberAddedEvent"},{"$ref":"#/components/schemas/CallMemberRemovedEvent"},{"$ref":"#/components/schemas/CallMemberUpdatedEvent"},{"$ref":"#/components/schemas/CallMemberUpdatedPermissionEvent"},{"$ref":"#/components/schemas/CallMissedEvent"},{"$ref":"#/components/schemas/CallModerationBlurEvent"},{"$ref":"#/components/schemas/CallModerationWarningEvent"},{"$ref":"#/components/schemas/CallNotificationEvent"},{"$ref":"#/components/schemas/CallReactionEvent"},{"$ref":"#/components/schemas/CallRecordingFailedEvent"},{"$ref":"#/components/schemas/CallRecordingReadyEvent"},{"$ref":"#/components/schemas/CallRecordingStartedEvent"},{"$ref":"#/components/schemas/CallRecordingStoppedEvent"},{"$ref":"#/components/schemas/CallRejectedEvent"},{"$ref":"#/components/schemas/CallRingEvent"},{"$ref":"#/components/schemas/CallRtmpBroadcastFailedEvent"},{"$ref":"#/components/schemas/CallRtmpBroadcastStartedEvent"},{"$ref":"#/components/schemas/CallRtmpBroadcastStoppedEvent"},{"$ref":"#/components/schemas/CallSessionEndedEvent"},{"$ref":"#/components/schemas/CallSessionParticipantCountsUpdatedEvent"},{"$ref":"#/components/schemas/CallSessionParticipantJoinedEvent"},{"$ref":"#/components/schemas/CallSessionParticipantLeftEvent"},{"$ref":"#/components/schemas/CallSessionStartedEvent"},{"$ref":"#/components/schemas/CallStatsReportReadyEvent"},{"$ref":"#/components/schemas/CallTranscriptionFailedEvent"},{"$ref":"#/components/schemas/CallTranscriptionReadyEvent"},{"$ref":"#/components/schemas/CallTranscriptionStartedEvent"},{"$ref":"#/components/schemas/CallTranscriptionStoppedEvent"},{"$ref":"#/components/schemas/CallUpdatedEvent"},{"$ref":"#/components/schemas/CallUserFeedbackSubmittedEvent"},{"$ref":"#/components/schemas/CallUserMutedEvent"},{"$ref":"#/components/schemas/ChannelCreatedEvent"},{"$ref":"#/components/schemas/ChannelDeletedEvent"},{"$ref":"#/components/schemas/ChannelFrozenEvent"},{"$ref":"#/components/schemas/ChannelHiddenEvent"},{"$ref":"#/components/schemas/ChannelKickedEvent"},{"$ref":"#/components/schemas/ChannelTruncatedEvent"},{"$ref":"#/components/schemas/ChannelUnFrozenEvent"},{"$ref":"#/components/schemas/ChannelUpdatedEvent"},{"$ref":"#/components/schemas/ChannelVisibleEvent"},{"$ref":"#/components/schemas/ClosedCaptionEvent"},{"$ref":"#/components/schemas/CommentAddedEvent"},{"$ref":"#/components/schemas/CommentDeletedEvent"},{"$ref":"#/components/schemas/CommentReactionAddedEvent"},{"$ref":"#/components/schemas/CommentReactionDeletedEvent"},{"$ref":"#/components/schemas/CommentReactionUpdatedEvent"},{"$ref":"#/components/schemas/CommentUpdatedEvent"},{"$ref":"#/components/schemas/ConnectedEvent"},{"$ref":"#/components/schemas/ConnectionErrorEvent"},{"$ref":"#/components/schemas/CustomVideoEvent"},{"$ref":"#/components/schemas/DraftDeletedEvent"},{"$ref":"#/components/schemas/DraftUpdatedEvent"},{"$ref":"#/components/schemas/FeedCreatedEvent"},{"$ref":"#/components/schemas/FeedDeletedEvent"},{"$ref":"#/components/schemas/FeedGroupChangedEvent"},{"$ref":"#/components/schemas/FeedGroupDeletedEvent"},{"$ref":"#/components/schemas/FeedMemberAddedEvent"},{"$ref":"#/components/schemas/FeedMemberRemovedEvent"},{"$ref":"#/components/schemas/FeedMemberUpdatedEvent"},{"$ref":"#/components/schemas/FeedUpdatedEvent"},{"$ref":"#/components/schemas/FollowCreatedEvent"},{"$ref":"#/components/schemas/FollowDeletedEvent"},{"$ref":"#/components/schemas/FollowUpdatedEvent"},{"$ref":"#/components/schemas/HealthCheckEvent"},{"$ref":"#/components/schemas/KickedUserEvent"},{"$ref":"#/components/schemas/MemberAddedEvent"},{"$ref":"#/components/schemas/MemberRemovedEvent"},{"$ref":"#/components/schemas/MemberUpdatedEvent"},{"$ref":"#/components/schemas/MessageDeletedEvent"},{"$ref":"#/components/schemas/MessageNewEvent"},{"$ref":"#/components/schemas/MessageNewEvent"},{"$ref":"#/components/schemas/MessageReadEvent"},{"$ref":"#/components/schemas/MessageUndeletedEvent"},{"$ref":"#/components/schemas/MessageUpdatedEvent"},{"$ref":"#/components/schemas/ModerationCustomActionEvent"},{"$ref":"#/components/schemas/ModerationFlaggedEvent"},{"$ref":"#/components/schemas/ModerationMarkReviewedEvent"},{"$ref":"#/components/schemas/NotificationAddedToChannelEvent"},{"$ref":"#/components/schemas/NotificationChannelDeletedEvent"},{"$ref":"#/components/schemas/NotificationChannelMutesUpdatedEvent"},{"$ref":"#/components/schemas/NotificationChannelTruncatedEvent"},{"$ref":"#/components/schemas/NotificationFeedUpdatedEvent"},{"$ref":"#/components/schemas/NotificationInviteAcceptedEvent"},{"$ref":"#/components/schemas/NotificationInviteRejectedEvent"},{"$ref":"#/components/schemas/NotificationInvitedEvent"},{"$ref":"#/components/schemas/NotificationMarkReadEvent"},{"$ref":"#/components/schemas/NotificationMarkUnreadEvent"},{"$ref":"#/components/schemas/NotificationMutesUpdatedEvent"},{"$ref":"#/components/schemas/NotificationNewMessageEvent"},{"$ref":"#/components/schemas/NotificationRemovedFromChannelEvent"},{"$ref":"#/components/schemas/PendingMessageEvent"},{"$ref":"#/components/schemas/PermissionRequestEvent"},{"$ref":"#/components/schemas/PollClosedEvent"},{"$ref":"#/components/schemas/PollClosedFeedEvent"},{"$ref":"#/components/schemas/PollDeletedEvent"},{"$ref":"#/components/schemas/PollDeletedFeedEvent"},{"$ref":"#/components/schemas/PollUpdatedEvent"},{"$ref":"#/components/schemas/PollUpdatedFeedEvent"},{"$ref":"#/components/schemas/PollVoteCastedEvent"},{"$ref":"#/components/schemas/PollVoteCastedFeedEvent"},{"$ref":"#/components/schemas/PollVoteChangedEvent"},{"$ref":"#/components/schemas/PollVoteChangedFeedEvent"},{"$ref":"#/components/schemas/PollVoteRemovedEvent"},{"$ref":"#/components/schemas/PollVoteRemovedFeedEvent"},{"$ref":"#/components/schemas/ReactionDeletedEvent"},{"$ref":"#/components/schemas/ReactionNewEvent"},{"$ref":"#/components/schemas/ReactionUpdatedEvent"},{"$ref":"#/components/schemas/ReminderCreatedEvent"},{"$ref":"#/components/schemas/ReminderDeletedEvent"},{"$ref":"#/components/schemas/ReminderNotificationEvent"},{"$ref":"#/components/schemas/ReminderUpdatedEvent"},{"$ref":"#/components/schemas/ThreadUpdatedEvent"},{"$ref":"#/components/schemas/TypingStartEvent"},{"$ref":"#/components/schemas/TypingStopEvent"},{"$ref":"#/components/schemas/UnblockedUserEvent"},{"$ref":"#/components/schemas/UpdatedCallPermissionsEvent"},{"$ref":"#/components/schemas/UserBannedEvent"},{"$ref":"#/components/schemas/UserDeactivatedEvent"},{"$ref":"#/components/schemas/UserDeletedEvent"},{"$ref":"#/components/schemas/UserMessagesDeletedEvent"},{"$ref":"#/components/schemas/UserMutedEvent"},{"$ref":"#/components/schemas/UserPresenceChangedEvent"},{"$ref":"#/components/schemas/UserReactivatedEvent"},{"$ref":"#/components/schemas/UserUnbannedEvent"},{"$ref":"#/components/schemas/UserUpdatedEvent"},{"$ref":"#/components/schemas/UserWatchingStartEvent"},{"$ref":"#/components/schemas/UserWatchingStopEvent"}]},"WrappedUnreadCountsResponse":{"description":"Basic response information","nullable":true,"properties":{"channel_type":{"items":{"$ref":"#/components/schemas/UnreadCountsChannelType"},"type":"array","x-stream-index":"001.005"},"channels":{"items":{"$ref":"#/components/schemas/UnreadCountsChannel"},"type":"array","x-stream-index":"001.004"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"threads":{"items":{"$ref":"#/components/schemas/UnreadCountsThread"},"type":"array","x-stream-index":"001.006"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"001.001"},"total_unread_count_by_team":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001.003"},"total_unread_threads_count":{"format":"int32","type":"integer","x-stream-index":"001.002"}},"required":["total_unread_count","total_unread_threads_count","channels","channel_type","threads","duration"],"title":"Response","type":"object"}},"securitySchemes":{"JWT":{"description":"JWT should be always provided when stream-auth-type=jwt.\n\nUsing JWT auth request could be authenticated as user or as server-side.\n\nWhen using user authentication permission checking is going to be applied to requests based on the user that is\nperforming a request.\n\nThe `authorization` header should be a JWT string signed using the secret attached to the API key used to perform\nrequests.\n\n**WARNING** all client-side official SDK do not ship with token generation; this is to make sure that the API secret is not\nshared with an untrusted party such as a browser or a iOS/Android application. Tokens **must** be generated server-side.\nIf you wish, you can configure your application to ignore authentication (see `disable_auth_check`)\nThe JWT string must include only the user_id claim and can include any built-in JWT claim such as iat, exp as well.\n","in":"header","name":"Authorization","type":"apiKey"},"api_key":{"description":"Application API key should be always set in order to authenticate the request.","in":"query","name":"api_key","type":"apiKey"},"stream-auth-type":{"description":"Stream-Auth-Type should be always set in order to authenticate the request. Possible\nvalues: `jwt` or `anonymous`.\n\n`jwt` allows you to authenticate as a user. With this auth type you should also provide valid JWT in Authorization\nheader.\n\n`anonymous` allows you to authenticate as anonymous user. Please note that most advanced features are not available\nto anonymous users.","in":"header","name":"Stream-Auth-Type","type":"apiKey"}}},"info":{"title":"Stream API","version":"v191.1.0"},"openapi":"3.0.3","paths":{"/api/v2/app":{"get":{"description":"This Method returns the application settings\n","operationId":"GetApp","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetApplicationResponse"}}},"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":"Get App Settings","tags":["product:common"]}},"/api/v2/blocklists":{"get":{"description":"Returns all available block lists\n","operationId":"ListBlockLists","parameters":[{"in":"query","name":"team","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListBlockListResponse"}}},"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":"List block lists","tags":["product:common"]},"post":{"description":"Creates a new application blocklist, once created the blocklist can be used by any channel type\n","operationId":"CreateBlockList","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBlockListRequest"}}},"description":"Block list","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBlockListResponse"}}},"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":"Create block list","tags":["product:common"]}},"/api/v2/blocklists/{name}":{"delete":{"description":"Deletes previously created application blocklist\n","operationId":"DeleteBlockList","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"team","schema":{"type":"string","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete block list","tags":["product:common"]},"put":{"description":"Updates contents of the block list\n","operationId":"UpdateBlockList","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Block list name","title":"Name","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBlockListRequest"}}},"description":"Update block list","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBlockListResponse"}}},"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":"Update block list","tags":["product:common"]}},"/api/v2/chat/channels":{"post":{"description":"Query channels with filter query\n","operationId":"QueryChannels","parameters":[{"in":"query","name":"connection_id","schema":{"description":"Websocket connection ID to interact with. You can pass it as Body or URL parameter","title":"Connection ID","type":"string","x-stream-index":"011.003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryChannelsRequest"}}},"description":"Query Channels Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryChannelsResponse"}}},"description":"Channels list"},"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":"Query channels","tags":["product:chat"]}},"/api/v2/chat/channels/delete":{"post":{"description":"Allows to delete several channels at once asynchronously\n\nSends events:\n- channel.deleted\n- channel.deleted\n","operationId":"DeleteChannels","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteChannelsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteChannelsResponse"}}},"description":"Successful 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":"Deletes channels asynchronously","tags":["product:chat"]}},"/api/v2/chat/channels/read":{"post":{"description":"Marks channels as read up to the specific message. If no channels is given, mark all channel as read\n\nSends events:\n- message.read\n- message.read\n","operationId":"MarkChannelsRead","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkChannelsReadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkReadResponse"}}},"description":"Successful 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 channels as read","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/query":{"post":{"description":"This Method creates a channel or returns an existing one with matching attributes\n\nSends events:\n- channel.created\n- member.added\n- member.removed\n- member.updated\n- user.watching.start\n","operationId":"GetOrCreateDistinctChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"connection_id","schema":{"description":"Websocket connection ID to interact with. You can pass it as Body or URL parameter","title":"Connection ID","type":"string","x-stream-index":"012.003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelGetOrCreateRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelStateResponse"}}},"description":"Successful 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":"Get or create channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}":{"delete":{"description":"Deletes channel\n\nSends events:\n- channel.deleted\n- channel.deleted\n","operationId":"DeleteChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"query","name":"hard_delete","schema":{"type":"boolean","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteChannelResponse"}}},"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":"Delete channel","tags":["product:chat"]},"patch":{"description":"Updates certain fields of the channel\n\nSends events:\n- channel.updated\n- channel.updated\n","operationId":"UpdateChannelPartial","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelPartialRequest"}}},"description":"UpdateChannelPartialRequest","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelPartialResponse"}}},"description":"Successful 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":"Partially update channel","tags":["product:chat"]},"post":{"description":"Change channel data\n\nSends events:\n- channel.updated\n- member.added\n- member.removed\n- member.updated\n- message.new\n- channel.updated\n- member.added\n- member.removed\n- member.updated\n- message.new\n","operationId":"UpdateChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"013.002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"013.002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelRequest"}}},"description":"Channel update request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelResponse"}}},"description":"Successful 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":"Update channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/draft":{"delete":{"description":"Deletes a draft\n\nSends events:\n- draft.deleted\n","operationId":"DeleteDraft","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"parent_id","schema":{"description":"Parent message ID","title":"string","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete draft","tags":["product:chat"]},"get":{"description":"Get a draft\n","operationId":"GetDraft","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"parent_id","schema":{"description":"Parent message ID","title":"string","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetDraftResponse"}}},"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":"Get draft","tags":["product:chat"]},"post":{"description":"Creates a draft\n\nSends events:\n- draft.updated\n","operationId":"CreateDraft","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDraftRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDraftResponse"}}},"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":"Create a draft","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/event":{"post":{"description":"Sends event to the channel\n","operationId":"SendEvent","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendEventRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventResponse"}}},"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":"Send event","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/file":{"delete":{"description":"Deletes previously uploaded file\n","operationId":"DeleteFile","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of file","title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"File ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"url","schema":{"description":"File URL to delete","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete file","tags":["product:chat"]},"post":{"description":"Uploads file\n","operationId":"UploadFile","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/FileUploadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileUploadResponse"}}},"description":"Successful 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":"Upload file","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/hide":{"post":{"description":"Marks channel as hidden for current user\n\nSends events:\n- channel.hidden\n- channel.hidden\n","operationId":"HideChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HideChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HideChannelResponse"}}},"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":"Hide channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/image":{"delete":{"description":"Deletes previously uploaded image\n","operationId":"DeleteImage","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of file","title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"File ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"url","schema":{"description":"File URL to delete","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete image","tags":["product:chat"]},"post":{"description":"Uploads image\n","operationId":"UploadImage","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.001.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.001.002"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/ImageUploadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageUploadResponse"}}},"description":"Successful 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":"Upload image","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/member":{"patch":{"description":"\n","operationId":"UpdateMemberPartial","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMemberPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMemberPartialResponse"}}},"description":"Successful 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":"Partially channel member update","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/message":{"post":{"description":"Sends new message to the specified channel\n\nSends events:\n- message.new\n- message.updated\n- message.new\n- message.updated\n","operationId":"SendMessage","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"009.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"009.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendMessageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendMessageResponse"}}},"description":"Successful 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":"Send new message","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/messages":{"get":{"description":"Returns list messages found by IDs\n","operationId":"GetManyMessages","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"ids","required":true,"schema":{"description":"List of comma-separated IDs","items":{"type":"string"},"maximum":50,"minimum":1,"title":"IDs","type":"array","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetManyMessagesResponse"}}},"description":"Successful 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":"Get many messages","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/query":{"post":{"description":"This Method creates a channel or returns an existing one with matching attributes\n\nSends events:\n- channel.created\n- member.added\n- member.removed\n- member.updated\n- user.watching.start\n","operationId":"GetOrCreateChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID (maximum length of 64 characters)","title":"ID","type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"connection_id","schema":{"description":"Websocket connection ID to interact with. You can pass it as Body or URL parameter","title":"Connection ID","type":"string","x-stream-index":"012.003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelGetOrCreateRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelStateResponse"}}},"description":"Successful 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":"Get or create channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/read":{"post":{"description":"Marks channel as read up to the specific message\n\nSends events:\n- message.read\n- message.read\n","operationId":"MarkRead","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkReadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkReadResponse"}}},"description":"Successful 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 read","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/show":{"post":{"description":"Shows previously hidden channel\n\nSends events:\n- channel.visible\n- channel.visible\n","operationId":"ShowChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShowChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShowChannelResponse"}}},"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":"Show channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/stop-watching":{"post":{"description":"Call this Method to stop receiving channel events\n\nSends events:\n- user.watching.stop\n- user.watching.stop\n","operationId":"StopWatchingChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"connection_id","schema":{"type":"string","x-stream-index":"001.003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelStopWatchingRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Stop watching channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/truncate":{"post":{"description":"Truncates messages from a channel. Can be applied to the entire channel or scoped to specific members.\n\nSends events:\n- channel.truncated\n- channel.truncated\n","operationId":"TruncateChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TruncateChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TruncateChannelResponse"}}},"description":"Successful 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":"Truncate channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/unread":{"post":{"description":"Marks channel as unread from a specific message\n","operationId":"MarkUnread","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkUnreadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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 unread","tags":["product:chat"]}},"/api/v2/chat/drafts/query":{"post":{"description":"Queries draft messages for a user\n","operationId":"QueryDrafts","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryDraftsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryDraftsResponse"}}},"description":"Successful 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":"Query draft messages","tags":["product:chat"]}},"/api/v2/chat/members":{"get":{"description":"Find and filter channel members\n","operationId":"QueryMembers","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryMembersPayload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MembersResponse"}}},"description":"Successful 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":"Query members","tags":["product:chat"]}},"/api/v2/chat/messages/{id}":{"delete":{"description":"Deletes message\n\nSends events:\n- message.deleted\n- message.deleted\n","operationId":"DeleteMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID to delete","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"hard","schema":{"description":"Delete all message reactions and replies as well","title":"Hard","type":"boolean","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"deleted_by","schema":{"type":"string","writeOnly":true,"x-stream-index":"003"}},{"in":"query","name":"delete_for_me","schema":{"description":"Delete the message only for the user making the request","title":"Delete for me","type":"boolean","writeOnly":true,"x-stream-index":"004"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteMessageResponse"}}},"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":"Delete message","tags":["product:chat"]},"get":{"description":"Returns message by ID\n","operationId":"GetMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"ID of the message","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetMessageResponse"}}},"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":"Get message","tags":["product:chat"]},"post":{"description":"Updates message with new data\n\nSends events:\n- message.updated\n- message.updated\n","operationId":"UpdateMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"004.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessageResponse"}}},"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":"Update message","tags":["product:chat"]},"put":{"description":"Updates certain fields of the message\n\nSends events:\n- message.updated\n- message.updated\n","operationId":"UpdateMessagePartial","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessagePartialRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessagePartialResponse"}}},"description":"Successful 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":"Partially message update","tags":["product:chat"]}},"/api/v2/chat/messages/{id}/action":{"post":{"description":"Executes message command action with given parameters\n\nSends events:\n- message.new\n- message.new\n","operationId":"RunMessageAction","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageActionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}},"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":"Run message command action","tags":["product:chat"]}},"/api/v2/chat/messages/{id}/reaction":{"post":{"description":"Sends reaction to specified message\n\nSends events:\n- reaction.new\n- reaction.updated\n","operationId":"SendReaction","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID to send reaction for","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendReactionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendReactionResponse"}}},"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":"Send reaction","tags":["product:chat"]}},"/api/v2/chat/messages/{id}/reaction/{type}":{"delete":{"description":"Removes user reaction from the message\n\nSends events:\n- reaction.deleted\n","operationId":"DeleteReaction","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID to remove reaction from","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"type","required":true,"schema":{"description":"Reaction type to remove","title":"Type","type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"description":"**Server-side only**. User ID which server acts upon","title":"User ID","type":"string","writeOnly":true,"x-stream-index":"003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteReactionResponse"}}},"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":"Delete reaction","tags":["product:chat"]}},"/api/v2/chat/messages/{id}/reactions":{"get":{"description":"Returns list of reactions of specific message\n","operationId":"GetReactions","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"limit","schema":{"description":"Number of records to return","format":"int32","title":"Limit","type":"integer","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"offset","schema":{"description":"Number of records to offset","format":"int32","title":"Offset","type":"integer","writeOnly":true,"x-stream-index":"003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetReactionsResponse"}}},"description":"Successful 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":"Get reactions","tags":["product:chat"]},"post":{"description":"Get reactions on a message\n","operationId":"QueryReactions","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryReactionsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryReactionsResponse"}}},"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"}},"tags":["product:chat"]}},"/api/v2/chat/messages/{id}/translate":{"post":{"description":"Translates message to a given language using automated translation software\n\nSends events:\n- message.updated\n- message.updated\n","operationId":"TranslateMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TranslateMessageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}},"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":"Translate message","tags":["product:chat"]}},"/api/v2/chat/messages/{message_id}/polls/{poll_id}/vote":{"post":{"description":"Cast a vote on a poll\n\nSends events:\n- feeds.poll.vote_casted\n- feeds.poll.vote_changed\n- feeds.poll.vote_removed\n- poll.vote_casted\n- poll.vote_changed\n- poll.vote_removed\n","operationId":"CastPollVote","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CastPollVoteRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollVoteResponse"}}},"description":"Successful 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":"Cast vote","tags":["product:chat"]}},"/api/v2/chat/messages/{message_id}/polls/{poll_id}/vote/{vote_id}":{"delete":{"description":"Delete a vote from a poll\n\nSends events:\n- feeds.poll.vote_removed\n- poll.vote_removed\n","operationId":"DeletePollVote","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"004"}},{"in":"path","name":"vote_id","required":true,"schema":{"description":"Vote ID","maxLength":255,"title":"string","type":"string","x-stream-index":"005"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollVoteResponse"}}},"description":"Successful 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":"Delete vote","tags":["product:chat"]}},"/api/v2/chat/messages/{message_id}/reminders":{"delete":{"description":"Deletes a user's created reminder\n\nSends events:\n- reminder.deleted\n","operationId":"DeleteReminder","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteReminderResponse"}}},"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":"Delete reminder","tags":["product:chat"]},"patch":{"description":"Updates an existing reminder\n\nSends events:\n- reminder.updated\n","operationId":"UpdateReminder","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateReminderRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateReminderResponse"}}},"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":"Updates Reminder","tags":["product:chat"]},"post":{"description":"Creates a new reminder\n\nSends events:\n- reminder.created\n","operationId":"CreateReminder","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateReminderRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReminderResponseData"}}},"description":"Successful 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":"Create reminder","tags":["product:chat"]}},"/api/v2/chat/messages/{parent_id}/replies":{"get":{"description":"Returns replies (thread) of the message\n","operationId":"GetReplies","parameters":[{"in":"path","name":"parent_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"sort","schema":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":1,"type":"array","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"limit","schema":{"description":"The maximum number of messages to return (max limit ","format":"int32","minimum":0,"title":"Limit","type":"integer","x-stream-index":"003.001"}},{"in":"query","name":"offset","schema":{"description":"The offset to start from","format":"int32","title":"Offset","type":"integer","x-stream-index":"003.002"}},{"in":"query","name":"id_gte","schema":{"description":"The ID of the message to get messages with a timestamp greater than or equal to","title":"IDGTE","type":"string","x-stream-index":"003.003"}},{"in":"query","name":"id_gt","schema":{"description":"The ID of the message to get messages with a timestamp greater than","title":"IDGT","type":"string","x-stream-index":"003.004"}},{"in":"query","name":"id_lte","schema":{"description":"The ID of the message to get messages with a timestamp smaller than or equal to","title":"IDLTE","type":"string","x-stream-index":"003.005"}},{"in":"query","name":"id_lt","schema":{"description":"The ID of the message to get messages with a timestamp smaller than","title":"IDLT","type":"string","x-stream-index":"003.006"}},{"in":"query","name":"created_at_after_or_equal","schema":{"description":"The timestamp to get messages with a created_at timestamp greater than or equal to","format":"date-time","title":"Created_at after or equal","type":"number","x-stream-index":"003.007"}},{"in":"query","name":"created_at_after","schema":{"description":"The timestamp to get messages with a created_at timestamp greater than","format":"date-time","title":"Created_at after","type":"number","x-stream-index":"003.008"}},{"in":"query","name":"created_at_before_or_equal","schema":{"description":"The timestamp to get messages with a created_at timestamp smaller than or equal to","format":"date-time","title":"Created_at after before or equal","type":"number","x-stream-index":"003.009"}},{"in":"query","name":"created_at_before","schema":{"description":"The timestamp to get messages with a created_at timestamp smaller than","format":"date-time","title":"Created_at after before","type":"number","x-stream-index":"003.010"}},{"in":"query","name":"id_around","schema":{"description":"The result will be a set of messages, that are both older and newer than the message with the provided ID, and the message with the ID provided will be in the middle of the set","title":"Id around","type":"string","x-stream-index":"003.011"}},{"in":"query","name":"created_at_around","schema":{"description":"The result will be a set of messages, that are both older and newer than the created_at timestamp provided, distributed evenly around the timestamp","format":"date-time","title":"Created_at around","type":"number","x-stream-index":"003.012"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRepliesResponse"}}},"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":"Get replies","tags":["product:chat"]}},"/api/v2/chat/moderation/flags/message":{"get":{"description":"Find and filter message flags\n","operationId":"QueryMessageFlags","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryMessageFlagsPayload","description":"JSON object with query message flags payload","title":"Payload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryMessageFlagsResponse"}}},"description":"QueryMessageFlagsResponse"},"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":"Query Message Flags","tags":["product:chat"]}},"/api/v2/chat/moderation/mute/channel":{"post":{"description":"Mutes channel for user\n\nSends events:\n- channel.muted\n- channel.muted\n","operationId":"MuteChannel","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteChannelResponse"}}},"description":"Successful 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":"Mute channel","tags":["product:chat"]}},"/api/v2/chat/moderation/unmute/channel":{"post":{"description":"Unmutes channel for user\n\nSends events:\n- channel.unmuted\n- channel.unmuted\n","operationId":"UnmuteChannel","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnmuteChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnmuteResponse"}}},"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":"Unmute channel","tags":["product:chat"]}},"/api/v2/chat/push_preferences":{"post":{"description":"Update the push preferences for a user and or channel member. Set to all, mentions or none\n","operationId":"UpdatePushNotificationPreferences","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertPushPreferencesRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertPushPreferencesResponse"}}},"description":"Successful 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":"Push notification preferences","tags":["product:chat"]}},"/api/v2/chat/query_banned_users":{"get":{"description":"Find and filter channel scoped or global user bans\n","operationId":"QueryBannedUsers","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryBannedUsersPayload","description":"JSON object with query user bans payload","title":"Payload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryBannedUsersResponse"}}},"description":"Successful 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":"Query Banned Users","tags":["product:chat"]}},"/api/v2/chat/reminders/query":{"post":{"description":"Queries reminders\n","operationId":"QueryReminders","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryRemindersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryRemindersResponse"}}},"description":"Successful 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":"Query reminders","tags":["product:chat"]}},"/api/v2/chat/search":{"get":{"description":"Search messages across channels\n","operationId":"Search","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchPayload","description":"JSON object with search payload","title":"Payload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchResponse"}}},"description":"Successful 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":"Search messages","tags":["product:chat"]}},"/api/v2/chat/sync":{"post":{"description":"Returns all events happened since client disconnect in specified channels\n","operationId":"Sync","parameters":[{"in":"query","name":"with_inaccessible_cids","schema":{"description":"If set to true this will add 'inaccessible_cids' to response type","title":"With inaccessible CIDs","type":"boolean","x-stream-index":"003"}},{"in":"query","name":"watch","schema":{"description":"If set to true this will start watching requested and newly added channels that user has access to. If error occurred with this option enabled and it is not an input error - channels will still be watched.","title":"Watch synced channels","type":"boolean","x-stream-index":"004"}},{"in":"query","name":"connection_id","schema":{"type":"string","x-stream-index":"006.003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncRequest"}}},"description":"SyncRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncResponse"}}},"description":"SyncResponse"},"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":"Sync","tags":["product:chat"]}},"/api/v2/chat/threads":{"post":{"description":"Returns the list of threads for specific user\n","operationId":"QueryThreads","parameters":[{"in":"query","name":"connection_id","schema":{"type":"string","x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryThreadsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryThreadsResponse"}}},"description":"Successful 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":"Query Threads","tags":["product:chat"]}},"/api/v2/chat/threads/{message_id}":{"get":{"description":"Return a specific thread\n","operationId":"GetThread","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"watch","schema":{"description":"Start watching the channel this thread belongs to","title":"Watch","type":"boolean","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"connection_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"003"}},{"in":"query","name":"reply_limit","schema":{"description":"Limit the number of replies returned","format":"int32","minimum":0,"title":"Reply limit","type":"integer","writeOnly":true,"x-stream-index":"004"}},{"in":"query","name":"participant_limit","schema":{"description":"Limit the number of participants returned","format":"int32","maximum":100,"minimum":0,"title":"Participant limit","type":"integer","writeOnly":true,"x-stream-index":"005"}},{"in":"query","name":"member_limit","schema":{"description":"Limit the number of members returned per thread channel","format":"int32","maximum":100,"minimum":0,"title":"Member limit","type":"integer","writeOnly":true,"x-stream-index":"006"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetThreadResponse"}}},"description":"Successful 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":"Get Thread","tags":["product:chat"]},"patch":{"description":"Updates certain fields of the thread\n\nSends events:\n- thread.updated\n- thread.updated\n","operationId":"UpdateThreadPartial","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateThreadPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateThreadPartialResponse"}}},"description":"Successful 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":"Partially update thread","tags":["product:chat"]}},"/api/v2/chat/unread":{"get":{"description":"Fetch unread counts for a single user\n","operationId":"UnreadCounts","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WrappedUnreadCountsResponse"}}},"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":"Unread counts","tags":["product:chat"]}},"/api/v2/devices":{"delete":{"description":"Deletes one device\n","operationId":"DeleteDevice","parameters":[{"in":"query","name":"id","required":true,"schema":{"description":"Device ID to delete","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete device","tags":["product:common"]},"get":{"description":"Returns all available devices\n","operationId":"ListDevices","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDevicesResponse"}}},"description":"ListDevicesResponse"},"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":"List devices","tags":["product:common"]},"post":{"description":"Adds a new device to a user, if the same device already exists the call will have no effect\n","operationId":"CreateDevice","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDeviceRequest"}}},"description":"CreateDeviceRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Create device","tags":["product:common"]}},"/api/v2/feeds/activities":{"post":{"description":"Create a new activity or update an existing one\n","operationId":"AddActivity","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddActivityRequest"}}},"description":"Activity Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddActivityResponse"}}},"description":"Add Activity 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":"Add a single activity","tags":["product:feeds"]}},"/api/v2/feeds/activities/batch":{"post":{"description":"Create new activities or update existing ones in a batch operation\n","operationId":"UpsertActivities","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertActivitiesRequest"}}},"description":"Upsert Activities Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertActivitiesResponse"}}},"description":"Upsert Activities 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":"Upsert multiple activities","tags":["product:feeds"]}},"/api/v2/feeds/activities/delete":{"post":{"description":"Delete one or more activities by their IDs\n","operationId":"DeleteActivities","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteActivitiesRequest"}}},"description":"Delete Activities Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteActivitiesResponse"}}},"description":"Delete Activities 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":"Remove multiple activities","tags":["product:feeds"]}},"/api/v2/feeds/activities/query":{"post":{"description":"Query activities based on filters with pagination and sorting options\n","operationId":"QueryActivities","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryActivitiesRequest"}}},"description":"Query Activities Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryActivitiesResponse"}}},"description":"Query Activities 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":"Query activities","tags":["product:feeds"]}},"/api/v2/feeds/activities/{activity_id}/bookmarks":{"delete":{"description":"Deletes a bookmark from an activity\n","operationId":"DeleteBookmark","parameters":[{"in":"path","name":"activity_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"folder_id","schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteBookmarkResponse"}}},"description":"Delete Bookmark 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":"Delete a bookmark","tags":["product:feeds"]},"patch":{"description":"Updates a bookmark for an activity\n","operationId":"UpdateBookmark","parameters":[{"in":"path","name":"activity_id","required":true,"schema":{"description":"ID of the activity","maxLength":255,"title":"Activity ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBookmarkRequest"}}},"description":"Update Bookmark Request","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBookmarkResponse"}}},"description":"Update Bookmark 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":"Update bookmark","tags":["product:feeds"]},"post":{"description":"Adds a bookmark to an activity\n","operationId":"AddBookmark","parameters":[{"in":"path","name":"activity_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddBookmarkRequest"}}},"description":"Add Bookmark Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddBookmarkResponse"}}},"description":"Add Bookmark 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":"Add bookmark","tags":["product:feeds"]}},"/api/v2/feeds/activities/{activity_id}/feedback":{"post":{"description":"Submit feedback for an activity including options to show less, hide, report, or mute the user\n","operationId":"ActivityFeedback","parameters":[{"in":"path","name":"activity_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivityFeedbackRequest"}}},"description":"Activity Feedback Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivityFeedbackResponse"}}},"description":"Activity Feedback 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":"Provide feedback on an activity","tags":["product:feeds"]}},"/api/v2/feeds/activities/{activity_id}/polls/{poll_id}/vote":{"post":{"description":"Cast a vote on a poll\n\nSends events:\n- feeds.poll.vote_casted\n- feeds.poll.vote_changed\n- feeds.poll.vote_removed\n- poll.vote_casted\n- poll.vote_changed\n- poll.vote_removed\n","operationId":"CastPollVote","parameters":[{"in":"path","name":"activity_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CastPollVoteRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollVoteResponse"}}},"description":"Successful 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":"Cast vote","tags":["product:feeds"]}},"/api/v2/feeds/activities/{activity_id}/polls/{poll_id}/vote/{vote_id}":{"delete":{"description":"Delete a vote from a poll\n\nSends events:\n- feeds.poll.vote_removed\n- poll.vote_removed\n","operationId":"DeletePollVote","parameters":[{"in":"path","name":"activity_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003"}},{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"004"}},{"in":"path","name":"vote_id","required":true,"schema":{"description":"Vote ID","maxLength":255,"title":"string","type":"string","x-stream-index":"005"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollVoteResponse"}}},"description":"Successful 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":"Delete vote","tags":["product:feeds"]}},"/api/v2/feeds/activities/{activity_id}/reactions":{"post":{"description":"Adds a reaction to an activity\n","operationId":"AddReaction","parameters":[{"in":"path","name":"activity_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddReactionRequest"}}},"description":"Add Reaction Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddReactionResponse"}}},"description":"Add Reaction 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":"Add reaction","tags":["product:feeds"]}},"/api/v2/feeds/activities/{activity_id}/reactions/query":{"post":{"description":"Query activity reactions\n","operationId":"QueryActivityReactions","parameters":[{"in":"path","name":"activity_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryActivityReactionsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryActivityReactionsResponse"}}},"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":"Query activity reactions","tags":["product:feeds"]}},"/api/v2/feeds/activities/{activity_id}/reactions/{type}":{"delete":{"description":"Removes a reaction from an activity\n","operationId":"DeleteActivityReaction","parameters":[{"in":"path","name":"activity_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"type","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteActivityReactionResponse"}}},"description":"Delete Activity Reaction 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":"Remove reaction","tags":["product:feeds"]}},"/api/v2/feeds/activities/{id}":{"delete":{"description":"Delete a single activity by its ID\n","operationId":"DeleteActivity","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"hard_delete","schema":{"description":"Whether to permanently delete the activity instead of soft delete","title":"boolean","type":"boolean","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteActivityResponse"}}},"description":"Delete Activity 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":"Delete a single activity","tags":["product:feeds"]},"get":{"description":"Returns activity by ID\n","operationId":"GetActivity","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetActivityResponse"}}},"description":"Get Activity 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":"Get activity","tags":["product:feeds"]},"patch":{"description":"Updates certain fields of the activity\n\nSends events:\n- feeds.activity.updated\n","operationId":"UpdateActivityPartial","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateActivityPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateActivityPartialResponse"}}},"description":"Successful 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":"Partially activity update","tags":["product:feeds"]},"put":{"description":"Replaces an activity with the provided data\n\nSends events:\n- feeds.activity.updated\n","operationId":"UpdateActivity","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateActivityRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateActivityResponse"}}},"description":"Successful 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":"Full activity update","tags":["product:feeds"]}},"/api/v2/feeds/bookmark_folders/query":{"post":{"description":"Query bookmark folders with filter query\n","operationId":"QueryBookmarkFolders","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryBookmarkFoldersRequest"}}},"description":"Query Bookmark Folders Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryBookmarkFoldersResponse"}}},"description":"Query Bookmark Folders 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":"Query bookmark folders","tags":["product:feeds"]}},"/api/v2/feeds/bookmark_folders/{folder_id}":{"delete":{"description":"Delete a bookmark folder by its ID\n","operationId":"DeleteBookmarkFolder","parameters":[{"in":"path","name":"folder_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteBookmarkFolderResponse"}}},"description":"Delete Bookmark Folder 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":"Delete a bookmark folder","tags":["product:feeds"]},"patch":{"description":"Update a bookmark folder by its ID\n","operationId":"UpdateBookmarkFolder","parameters":[{"in":"path","name":"folder_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBookmarkFolderRequest"}}},"description":"Update Bookmark Folder Request","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBookmarkFolderResponse"}}},"description":"Update Bookmark Folder 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":"Update a bookmark folder","tags":["product:feeds"]}},"/api/v2/feeds/bookmarks/query":{"post":{"description":"Query bookmarks with filter query\n","operationId":"QueryBookmarks","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryBookmarksRequest"}}},"description":"Query Bookmarks Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryBookmarksResponse"}}},"description":"Query Bookmarks 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":"Query bookmarks","tags":["product:feeds"]}},"/api/v2/feeds/comments":{"get":{"description":"Retrieve a threaded list of comments for a specific object (e.g., activity), with configurable depth, sorting, and pagination\n","operationId":"GetComments","parameters":[{"in":"query","name":"object_id","required":true,"schema":{"description":"ID of the object to get comments for","title":"Object ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"object_type","required":true,"schema":{"description":"Type of the object to get comments for","title":"Object Type","type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"depth","schema":{"description":"Maximum nested depth to return (0 = only first level)","format":"int32","maximum":5,"minimum":0,"title":"Max Depth","type":"integer","writeOnly":true,"x-stream-index":"003"}},{"in":"query","name":"sort","schema":{"description":"Sort order for the comments","enum":["first","last","top","best","controversial"],"title":"Sort Order","type":"string","writeOnly":true,"x-stream-index":"004"}},{"in":"query","name":"replies_limit","schema":{"format":"int32","maximum":20,"minimum":0,"type":"integer","writeOnly":true,"x-stream-index":"005"}},{"in":"query","name":"limit","schema":{"description":"Max number of top‑level comments to return","format":"int32","maximum":100,"minimum":0,"title":"Root Limit","type":"integer","writeOnly":true,"x-stream-index":"006.001"}},{"in":"query","name":"prev","schema":{"type":"string","writeOnly":true,"x-stream-index":"006.002"}},{"in":"query","name":"next","schema":{"type":"string","writeOnly":true,"x-stream-index":"006.003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCommentsResponse"}}},"description":"Get Comments 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":"Get comments for an object","tags":["product:feeds"]},"post":{"description":"Adds a comment to an object (e.g., activity) or a reply to an existing comment, and broadcasts appropriate events\n","operationId":"AddComment","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddCommentRequest"}}},"description":"Add Comment Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddCommentResponse"}}},"description":"Add Comment 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":"Add a comment or reply","tags":["product:feeds"]}},"/api/v2/feeds/comments/batch":{"post":{"description":"Adds multiple comments in a single request. Each comment must specify the object type and ID.\n","operationId":"AddCommentsBatch","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddCommentsBatchRequest"}}},"description":"Add Comments Batch Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddCommentsBatchResponse"}}},"description":"Add Comments Batch 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":"Add multiple comments in a batch","tags":["product:feeds"]}},"/api/v2/feeds/comments/query":{"post":{"description":"Query comments using MongoDB-style filters with pagination and sorting options\n","operationId":"QueryComments","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCommentsRequest"}}},"description":"Query Comments Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCommentsResponse"}}},"description":"Query Comments 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":"Query comments","tags":["product:feeds"]}},"/api/v2/feeds/comments/{id}":{"delete":{"description":"Deletes a comment from an object (e.g., activity) and broadcasts appropriate events\n","operationId":"DeleteComment","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"hard_delete","schema":{"description":"Whether to permanently delete the comment instead of soft delete","title":"Hard Delete","type":"boolean","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCommentResponse"}}},"description":"Delete Comment 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":"Delete a comment","tags":["product:feeds"]},"get":{"description":"Get a comment by ID\n","operationId":"GetComment","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCommentResponse"}}},"description":"Get Comment 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":"Get comment","tags":["product:feeds"]},"patch":{"description":"Updates a comment on an object (e.g., activity) and broadcasts appropriate events\n","operationId":"UpdateComment","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCommentRequest"}}},"description":"Update Comment Request","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCommentResponse"}}},"description":"Update Comment 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":"Update a comment","tags":["product:feeds"]}},"/api/v2/feeds/comments/{id}/reactions":{"post":{"description":"Adds a reaction to a comment\n","operationId":"AddCommentReaction","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddCommentReactionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddCommentReactionResponse"}}},"description":"Successful 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":"Add comment reaction","tags":["product:feeds"]}},"/api/v2/feeds/comments/{id}/reactions/query":{"post":{"description":"Query comment reactions\n","operationId":"QueryCommentReactions","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCommentReactionsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCommentReactionsResponse"}}},"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":"Query comment reactions","tags":["product:feeds"]}},"/api/v2/feeds/comments/{id}/reactions/{type}":{"delete":{"description":"Deletes a reaction from a comment\n","operationId":"DeleteCommentReaction","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"type","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCommentReactionResponse"}}},"description":"Delete Comment Reaction 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":"Delete comment reaction","tags":["product:feeds"]}},"/api/v2/feeds/comments/{id}/replies":{"get":{"description":"Retrieve a threaded list of replies for a single comment, with configurable depth, sorting, and pagination\n","operationId":"GetCommentReplies","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"depth","schema":{"description":"Maximum nested depth to return (0 = unlimited)","format":"int32","maximum":5,"minimum":0,"title":"Max Depth","type":"integer","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"sort","schema":{"description":"first (oldest), last (newest) or top","enum":["first","last","top","best","controversial"],"title":"Sort Order","type":"string","writeOnly":true,"x-stream-index":"003"}},{"in":"query","name":"replies_limit","schema":{"description":"Max number of replies to return","format":"int32","minimum":0,"title":"Replies Limit","type":"integer","writeOnly":true,"x-stream-index":"004"}},{"in":"query","name":"limit","schema":{"description":"Max number of direct replies to return","format":"int32","maximum":100,"minimum":0,"title":"Reply Limit","type":"integer","writeOnly":true,"x-stream-index":"005.001"}},{"in":"query","name":"prev","schema":{"type":"string","writeOnly":true,"x-stream-index":"005.002"}},{"in":"query","name":"next","schema":{"type":"string","writeOnly":true,"x-stream-index":"005.003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCommentRepliesResponse"}}},"description":"Get Comment Replies 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":"Get replies for a comment","tags":["product:feeds"]}},"/api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}":{"delete":{"description":"Delete a single feed by its ID\n","operationId":"DeleteFeed","parameters":[{"in":"path","name":"feed_group_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"feed_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"hard_delete","schema":{"description":"Whether to permanently delete the feed instead of soft delete","title":"boolean","type":"boolean","writeOnly":true,"x-stream-index":"003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteFeedResponse"}}},"description":"Delete Feed 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":"Delete a single feed","tags":["product:feeds"]},"post":{"description":"Create a single feed for a given feed group\n","operationId":"GetOrCreateFeed","parameters":[{"in":"path","name":"feed_group_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"feed_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"connection_id","schema":{"description":"Websocket connection ID to interact with. You can pass it as Body or URL parameter","title":"Connection ID","type":"string","x-stream-index":"015.003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrCreateFeedRequest"}}},"description":"ClientRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrCreateFeedResponse"}}},"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":"Create a new feed","tags":["product:feeds"]},"put":{"description":"Update an existing feed\n","operationId":"UpdateFeed","parameters":[{"in":"path","name":"feed_group_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"feed_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFeedRequest"}}},"description":"Update Feed Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFeedResponse"}}},"description":"Update Feed 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":"Update a feed","tags":["product:feeds"]}},"/api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/activities/mark/batch":{"post":{"description":"Mark activities as read/seen/watched. Can mark by timestamp (seen), activity IDs (read), or all as read.\n","operationId":"MarkActivity","parameters":[{"in":"path","name":"feed_group_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"feed_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkActivityRequest"}}},"description":"Mark Activity Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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 activities as read/seen/watched","tags":["product:feeds"]}},"/api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/activities/{activity_id}/pin":{"delete":{"description":"Unpin an activity from a feed. This removes the pin, so the activity will no longer be displayed at the top of the feed.\n","operationId":"UnpinActivity","parameters":[{"in":"path","name":"feed_group_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"feed_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"path","name":"activity_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnpinActivityResponse"}}},"description":"Unpin Activity 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":"Unpin an activity from a feed","tags":["product:feeds"]},"post":{"description":"Pin an activity to a feed. Pinned activities are typically displayed at the top of a feed.\n","operationId":"PinActivity","parameters":[{"in":"path","name":"feed_group_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"feed_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"path","name":"activity_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PinActivityRequest"}}},"description":"Pin Activity Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PinActivityResponse"}}},"description":"Pin Activity 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":"Pin an activity to a feed","tags":["product:feeds"]}},"/api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/members":{"patch":{"description":"Add, remove, or set members for a feed\n","operationId":"UpdateFeedMembers","parameters":[{"in":"path","name":"feed_group_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"feed_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFeedMembersRequest"}}},"description":"Update Feed Members Request","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFeedMembersResponse"}}},"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":"Update feed members","tags":["product:feeds"]}},"/api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/members/accept":{"post":{"description":"Accepts a pending feed member request\n","operationId":"AcceptFeedMemberInvite","parameters":[{"in":"path","name":"feed_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"feed_group_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcceptFeedMemberInviteRequest"}}},"description":"Accept Feed Member Invite Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcceptFeedMemberInviteResponse"}}},"description":"Accept Feed Member Invite 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":"Accept a feed member request","tags":["product:feeds"]}},"/api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/members/query":{"post":{"description":"Query feed members based on filters with pagination and sorting options\n","operationId":"QueryFeedMembers","parameters":[{"in":"path","name":"feed_group_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"feed_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryFeedMembersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryFeedMembersResponse"}}},"description":"Successful 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":"Query feed members","tags":["product:feeds"]}},"/api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/members/reject":{"post":{"description":"Rejects a pending feed member request\n","operationId":"RejectFeedMemberInvite","parameters":[{"in":"path","name":"feed_group_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"feed_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RejectFeedMemberInviteRequest"}}},"description":"Reject Feed Member Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RejectFeedMemberInviteResponse"}}},"description":"Reject Feed Member 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":"Reject an invite to become a feed member","tags":["product:feeds"]}},"/api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/watch":{"delete":{"description":"Call this Method to stop receiving feed events\n","operationId":"StopWatchingFeed","parameters":[{"in":"path","name":"feed_group_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"path","name":"feed_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"003"}},{"in":"query","name":"connection_id","schema":{"type":"string","x-stream-index":"001.003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Stop watching feed","tags":["product:feeds"]}},"/api/v2/feeds/feed_groups/{feed_group_id}/follow_suggestions":{"get":{"description":"Get follow suggestions for a feed group\n","operationId":"GetFollowSuggestions","parameters":[{"in":"path","name":"feed_group_id","required":true,"schema":{"description":"The ID of the feed group to get suggestions for","maxLength":255,"title":"Feed Group ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"limit","schema":{"description":"Maximum number of suggestions to return","format":"int32","maximum":100,"minimum":1,"title":"Limit","type":"integer","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetFollowSuggestionsResponse"}}},"description":"Follow Suggestions 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":"Get follow suggestions","tags":["product:feeds"]}},"/api/v2/feeds/feeds/batch":{"post":{"description":"Create multiple feeds at once for a given feed group\n","operationId":"CreateFeedsBatch","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFeedsBatchRequest"}}},"description":"Create Feeds Batch Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFeedsBatchResponse"}}},"description":"Create Feeds Batch 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":"Create multiple feeds at once","tags":["product:feeds"]}},"/api/v2/feeds/feeds/query":{"post":{"description":"Query feeds with filter query\n","operationId":"QueryFeeds","parameters":[{"in":"query","name":"connection_id","schema":{"type":"string","x-stream-index":"005.003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryFeedsRequest"}}},"description":"Query Feeds Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryFeedsResponse"}}},"description":"Query Feeds 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":"Query feeds","tags":["product:feeds"]}},"/api/v2/feeds/follows":{"patch":{"description":"Updates a follow's custom data, push preference, and follower role. Source owner can update custom data and push preference. Target owner can update follower role.\n","operationId":"UpdateFollow","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFollowRequest"}}},"description":"Update Follow Request","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFollowResponse"}}},"description":"Update Follow 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":"Update a follow","tags":["product:feeds"]},"post":{"description":"Creates a follow and broadcasts FollowAddedEvent\n","operationId":"Follow","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FollowRequest"}}},"description":"Follow Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SingleFollowResponse"}}},"description":"Follow 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":"Create a follow","tags":["product:feeds"]}},"/api/v2/feeds/follows/accept":{"post":{"description":"Accepts a pending follow request\n","operationId":"AcceptFollow","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcceptFollowRequest"}}},"description":"Accept Follow Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcceptFollowResponse"}}},"description":"Accept Follow 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":"Accept a follow request","tags":["product:feeds"]}},"/api/v2/feeds/follows/batch":{"post":{"description":"Creates multiple follows at once and broadcasts FollowAddedEvent for each follow\n","operationId":"FollowBatch","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FollowBatchRequest"}}},"description":"Follow Batch Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FollowBatchResponse"}}},"description":"Follow Batch 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":"Create multiple follows at once","tags":["product:feeds"]}},"/api/v2/feeds/follows/query":{"post":{"description":"Query follows based on filters with pagination and sorting options\n","operationId":"QueryFollows","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryFollowsRequest"}}},"description":"Query Follows Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryFollowsResponse"}}},"description":"Query Follows 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":"Query follows","tags":["product:feeds"]}},"/api/v2/feeds/follows/reject":{"post":{"description":"Rejects a pending follow request\n","operationId":"RejectFollow","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RejectFollowRequest"}}},"description":"Reject Follow Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RejectFollowResponse"}}},"description":"Reject Follow 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":"Reject a follow request","tags":["product:feeds"]}},"/api/v2/feeds/follows/{source}/{target}":{"delete":{"description":"Removes a follow and broadcasts FollowRemovedEvent\n","operationId":"Unfollow","parameters":[{"in":"path","name":"source","required":true,"schema":{"description":"Fully qualified ID of the source feed","maxLength":255,"title":"Source Feed","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"target","required":true,"schema":{"description":"Fully qualified ID of the target feed","maxLength":255,"title":"Target Feed","type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnfollowResponse"}}},"description":"Unfollow 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":"Unfollow a feed","tags":["product:feeds"]}},"/api/v2/guest":{"post":{"description":"\n","operationId":"CreateGuest","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGuestRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGuestResponse"}}},"description":"Successful 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":"Create Guest","tags":["product:common"]}},"/api/v2/longpoll":{"get":{"description":"WebSocket fallback transport endpoint\n\nSends events:\n- user.updated\n","operationId":"LongPoll","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WSAuthMessage","x-stream-index":"001"}}},"in":"query","name":"json"},{"in":"query","name":"connection_id","schema":{"maxLength":36,"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"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":"Long Poll (Transport)","tags":["product:common"]}},"/api/v2/moderation/ban":{"post":{"description":"Ban a user from a channel or the entire app\n","operationId":"ban","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BanRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BanResponse"}}},"description":"Successful 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":"Ban","tags":["product:moderation"]}},"/api/v2/moderation/config":{"post":{"description":"Create a new moderation configuration or update an existing one. Configure settings for content filtering, AI analysis, toxicity detection, and other moderation features.\n","operationId":"upsert_config","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertConfigRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertConfigResponse"}}},"description":"Successful 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":"Create or update moderation configuration","tags":["product:moderation"]}},"/api/v2/moderation/config/{key}":{"delete":{"description":"Delete a specific moderation policy by its name\n","operationId":"delete_config","parameters":[{"in":"path","name":"key","required":true,"schema":{"description":"Key of the moderation configuration to delete","title":"Key","type":"string","x-stream-index":"001"}},{"in":"query","name":"team","schema":{"description":"Team associated with the configuration","title":"Team","type":"string","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteModerationConfigResponse"}}},"description":"Successful 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":"Delete a moderation policy","tags":["product:moderation"]},"get":{"description":"Retrieve a specific moderation configuration by its key and team. This configuration contains settings for various moderation features like toxicity detection, AI analysis, and filtering rules.\n","operationId":"get_config","parameters":[{"in":"path","name":"key","required":true,"schema":{"description":"Key of the moderation configuration to retrieve","title":"Key","type":"string","x-stream-index":"001"}},{"in":"query","name":"team","schema":{"description":"Team associated with the configuration","title":"Team","type":"string","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetConfigResponse"}}},"description":"Successful 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":"Get moderation configuration","tags":["product:moderation"]}},"/api/v2/moderation/configs":{"post":{"description":"Search and filter moderation configurations across your application. This endpoint is designed for building moderation dashboards and managing multiple configuration sets.\n","operationId":"query_moderation_configs","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationConfigsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationConfigsResponse"}}},"description":"Successful 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":"Query moderation configurations","tags":["product:moderation"]}},"/api/v2/moderation/flag":{"post":{"description":"Flag any type of content (messages, users, channels, activities) for moderation review. Supports custom content types and additional metadata for flagged content.\n","operationId":"flag","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlagRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlagResponse"}}},"description":"Successful 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":"Flag content for moderation","tags":["product:moderation"]}},"/api/v2/moderation/mute":{"post":{"description":"Mute a user. Mutes are generally not visible to the user you mute, while block is something you notice.\n","operationId":"mute","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteRequest"}}},"description":"MuteRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteResponse"}}},"description":"MuteResponse"},"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":"Mute","tags":["product:moderation"]}},"/api/v2/moderation/review_queue":{"post":{"description":"Query review queue items allows you to filter the review queue items. This is used for building a moderation dashboard.\n","operationId":"query_review_queue","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryReviewQueueRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryReviewQueueResponse"}}},"description":"Successful 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":"Query review queue items","tags":["product:moderation"]}},"/api/v2/moderation/submit_action":{"post":{"description":"Take action on flagged content, such as marking content as safe, deleting content, banning users, or executing custom moderation actions. Supports various action types with configurable parameters.\n","operationId":"submit_action","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitActionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitActionResponse"}}},"description":"Successful 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":"Submit moderation action","tags":["product:moderation"]}},"/api/v2/og":{"get":{"description":"Get an OpenGraph attachment for a link\n","operationId":"GetOG","parameters":[{"in":"query","name":"url","required":true,"schema":{"description":"URL to be scraped","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOGResponse"}}},"description":"Get OG Attachment"},"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":"Get OG","tags":["product:common"]}},"/api/v2/polls":{"post":{"description":"Creates a new poll\n","operationId":"CreatePoll","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePollRequest"}}},"description":"Create Poll Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Create poll","tags":["product:common"]},"put":{"description":"Updates a poll\n\nSends events:\n- feeds.poll.closed\n- feeds.poll.updated\n- poll.closed\n- poll.updated\n","operationId":"UpdatePoll","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePollRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Update poll","tags":["product:common"]}},"/api/v2/polls/query":{"post":{"description":"Queries polls\n","operationId":"QueryPolls","parameters":[{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryPollsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryPollsResponse"}}},"description":"Successful 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":"Query polls","tags":["product:common"]}},"/api/v2/polls/{poll_id}":{"delete":{"description":"Deletes a poll\n\nSends events:\n- feeds.poll.deleted\n- poll.deleted\n","operationId":"DeletePoll","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete poll","tags":["product:common"]},"get":{"description":"Retrieves a poll\n","operationId":"GetPoll","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Get poll","tags":["product:common"]},"patch":{"description":"Updates a poll partially\n\nSends events:\n- feeds.poll.closed\n- feeds.poll.updated\n- poll.closed\n- poll.updated\n","operationId":"UpdatePollPartial","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePollPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Partial update poll","tags":["product:common"]}},"/api/v2/polls/{poll_id}/options":{"post":{"description":"Creates a poll option\n\nSends events:\n- feeds.poll.updated\n- poll.updated\n","operationId":"CreatePollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePollOptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollOptionResponse"}}},"description":"Successful 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":"Create poll option","tags":["product:common"]},"put":{"description":"Updates a poll option\n\nSends events:\n- feeds.poll.updated\n- poll.updated\n","operationId":"UpdatePollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePollOptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollOptionResponse"}}},"description":"Successful 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":"Update poll option","tags":["product:common"]}},"/api/v2/polls/{poll_id}/options/{option_id}":{"delete":{"description":"Deletes a poll option\n\nSends events:\n- feeds.poll.updated\n- poll.updated\n","operationId":"DeletePollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"path","name":"option_id","required":true,"schema":{"description":"Option ID","maxLength":255,"title":"string","type":"string","x-stream-index":"003"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete poll option","tags":["product:common"]},"get":{"description":"Retrieves a poll option\n","operationId":"GetPollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"path","name":"option_id","required":true,"schema":{"description":"Option ID","maxLength":255,"title":"string","type":"string","x-stream-index":"003"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollOptionResponse"}}},"description":"Successful 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":"Get poll option","tags":["product:common"]}},"/api/v2/polls/{poll_id}/votes":{"post":{"description":"Queries votes\n","operationId":"QueryPollVotes","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryPollVotesRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollVotesResponse"}}},"description":"Successful 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":"Query votes","tags":["product:common"]}},"/api/v2/uploads/file":{"delete":{"description":"Deletes previously uploaded file\n","operationId":"DeleteFileGlobal","parameters":[{"in":"query","name":"url","schema":{"description":"File URL to delete","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete file","tags":["product:common"],"x-stream-sdk-name":"DeleteFile"},"post":{"description":"Uploads file\n","operationId":"UploadFileGlobal","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/FileUploadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileUploadResponse"}}},"description":"Successful 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":"Upload file","tags":["product:common"],"x-stream-sdk-name":"UploadFile"}},"/api/v2/uploads/image":{"delete":{"description":"Deletes previously uploaded image\n","operationId":"DeleteImageGlobal","parameters":[{"in":"query","name":"url","schema":{"description":"File URL to delete","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete image","tags":["product:common"],"x-stream-sdk-name":"DeleteImage"},"post":{"description":"Uploads image\n","operationId":"UploadImageGlobal","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/ImageUploadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageUploadResponse"}}},"description":"Successful 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":"Upload image","tags":["product:common"],"x-stream-sdk-name":"UploadImage"}},"/api/v2/users":{"get":{"description":"Find and filter users\n","operationId":"QueryUsers","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryUsersPayload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryUsersResponse"}}},"description":"Successful 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":"Query users","tags":["product:common"]},"patch":{"description":"Updates certain fields of the user\n\nSends events:\n- user.presence.changed\n- user.updated\n- user.presence.changed\n","operationId":"UpdateUsersPartial","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersResponse"}}},"description":"Successful 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":"Partially update user","tags":["product:common"]},"post":{"description":"Update or create users in bulk\n\nSends events:\n- user.updated\n","operationId":"UpdateUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersResponse"}}},"description":"Successful 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":"Upsert users","tags":["product:common"]}},"/api/v2/users/block":{"get":{"description":"Get list of blocked Users\n","operationId":"GetBlockedUsers","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBlockedUsersResponse"}}},"description":"Successful 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":"Get list of blocked Users","tags":["product:common"]},"post":{"description":"Block users\n","operationId":"BlockUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUsersResponse"}}},"description":"Successful 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":"Block user","tags":["product:common"]}},"/api/v2/users/live_locations":{"get":{"description":"Retrieves all active live locations for a user\n","operationId":"GetUserLiveLocations","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SharedLocationsResponse"}}},"description":"Successful 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":"Get user live locations","tags":["product:common"]},"put":{"description":"Updates an existing live location with new coordinates or expiration time\n","operationId":"UpdateLiveLocation","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateLiveLocationRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SharedLocationResponse"}}},"description":"Successful 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":"Update live location","tags":["product:common"]}},"/api/v2/users/unblock":{"post":{"description":"Unblock users\n","operationId":"UnblockUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUsersResponse"}}},"description":"Successful 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":"Unblock user","tags":["product:common"]}},"/api/v2/video/call/members":{"post":{"description":"Query call members with filter query\n","operationId":"QueryCallMembers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallMembersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallMembersResponse"}}},"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":"Query call members","tags":["product:video"]}},"/api/v2/video/call/stats":{"post":{"description":"\n","operationId":"QueryCallStats","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallStatsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallStatsResponse"}}},"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":"Query Call Stats","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}":{"get":{"description":"\n","operationId":"GetCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"query","name":"connection_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"003"}},{"in":"query","name":"members_limit","schema":{"format":"int32","maximum":100,"minimum":0,"type":"integer","writeOnly":true,"x-stream-index":"004"}},{"in":"query","name":"ring","schema":{"type":"boolean","writeOnly":true,"x-stream-index":"005"}},{"in":"query","name":"notify","schema":{"type":"boolean","writeOnly":true,"x-stream-index":"006"}},{"in":"query","name":"video","schema":{"type":"boolean","writeOnly":true,"x-stream-index":"007"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCallResponse"}}},"description":"GetCallResponse"},"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":"Get Call","tags":["product:video"]},"patch":{"description":"\n\nSends events:\n- call.updated\n","operationId":"UpdateCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallRequest"}}},"description":"UpdateCallRequest","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallResponse"}}},"description":"UpdateCallResponse"},"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":"Update Call","tags":["product:video"]},"post":{"description":"Gets or creates a new call\n\nSends events:\n- call.created\n- call.notification\n- call.ring\n","operationId":"GetOrCreateCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"connection_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"008"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrCreateCallRequest"}}},"description":"GetOrCreateCallRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrCreateCallResponse"}}},"description":"GetOrCreateCallResponse"},"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":"Get or create a call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/accept":{"post":{"description":"\n\nSends events:\n- call.accepted\n","operationId":"AcceptCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcceptCallResponse"}}},"description":"AcceptCallResponse"},"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":"Accept Call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/block":{"post":{"description":"Block a user, preventing them from joining the call until they are unblocked.\n\nSends events:\n- call.blocked_user\n","operationId":"BlockUser","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUserRequest"}}},"description":"BlockUserRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUserResponse"}}},"description":"BlockUserResponse"},"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":"Block user on a call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/delete":{"post":{"description":"\n\nSends events:\n- call.deleted\n","operationId":"DeleteCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCallRequest"}}},"description":"DeleteCallRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCallResponse"}}},"description":"DeleteCallResponse"},"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":"Delete Call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/event":{"post":{"description":"Sends custom event to the call\n\nSends events:\n- custom\n","operationId":"SendCallEvent","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendCallEventRequest"}}},"description":"SendCallEventRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendCallEventResponse"}}},"description":"SendCallEventResponse"},"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":"Send custom event","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/feedback":{"post":{"description":"\n\nSends events:\n- call.user_feedback_submitted\n","operationId":"CollectUserFeedback","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectUserFeedbackRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectUserFeedbackResponse"}}},"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":"Collect user feedback","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/go_live":{"post":{"description":"\n\nSends events:\n- call.live_started\n","operationId":"GoLive","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoLiveRequest"}}},"description":"GoLiveRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoLiveResponse"}}},"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":"Set call as live","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/join":{"post":{"description":"Request to join a call\n","operationId":"JoinCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"query","name":"connection_id","schema":{"title":"ConnectionID","type":"string","writeOnly":true,"x-stream-index":"008"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JoinCallRequest"}}},"description":"JoinCallRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JoinCallResponse"}}},"description":"JoinCallResponse"},"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":"Join call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/kick":{"post":{"description":"Kicks a user from the call. Optionally block the user from rejoining by setting block=true.\n\nSends events:\n- call.blocked_user\n- call.kicked_user\n","operationId":"KickUser","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KickUserRequest"}}},"description":"KickUserRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KickUserResponse"}}},"description":"KickUserResponse"},"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":"Kick user from a call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/mark_ended":{"post":{"description":"\n\nSends events:\n- call.ended\n","operationId":"EndCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EndCallResponse"}}},"description":"EndCallResponse"},"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":"End call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/members":{"post":{"description":"\n\nSends events:\n- call.member_added\n- call.member_removed\n- call.member_updated\n","operationId":"UpdateCallMembers","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallMembersRequest"}}},"description":"UpdateCallMembersRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallMembersResponse"}}},"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":"Update Call Member","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/mute_users":{"post":{"description":"Mutes users in a call\n","operationId":"MuteUsers","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteUsersRequest"}}},"description":"MuteUsersRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteUsersResponse"}}},"description":"MuteUsersResponse"},"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":"Mute users","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/participants":{"post":{"description":"Returns a list of participants connected to the call\n","operationId":"QueryCallParticipants","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"type","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"limit","schema":{"format":"int32","maximum":100,"type":"integer","x-stream-index":"004"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallParticipantsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallParticipantsResponse"}}},"description":"Successful 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":"Query call participants","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/pin":{"post":{"description":"Pins a track for all users in the call.\n","operationId":"VideoPin","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PinRequest"}}},"description":"PinRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PinResponse"}}},"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":"Pin","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/reaction":{"post":{"description":"Sends reaction to the call\n\nSends events:\n- call.reaction_new\n","operationId":"SendVideoReaction","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendReactionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendReactionResponse"}}},"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":"Send reaction to the call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/recordings":{"get":{"description":"Lists recordings\n","operationId":"ListRecordings","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListRecordingsResponse"}}},"description":"ListRecordingsResponse"},"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":"List recordings","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/reject":{"post":{"description":"\n\nSends events:\n- call.rejected\n","operationId":"RejectCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RejectCallRequest"}}},"description":"RejectCallRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RejectCallResponse"}}},"description":"RejectCallResponse"},"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":"Reject Call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/report":{"get":{"description":"\n","operationId":"GetCallReport","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"query","name":"session_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCallReportResponse"}}},"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":"Get call report","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/request_permission":{"post":{"description":"Request permission to perform an action\n\nSends events:\n- call.permission_request\n","operationId":"RequestPermission","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestPermissionRequest"}}},"description":"RequestPermissionRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestPermissionResponse"}}},"description":"RequestPermissionResponse"},"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":"Request permission","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/rtmp_broadcasts":{"post":{"description":"Starts RTMP broadcasts for the provided RTMP destinations\n","operationId":"StartRTMPBroadcasts","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRTMPBroadcastsRequest"}}},"description":"StartRTMPBroadcastsRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRTMPBroadcastsResponse"}}},"description":"StartRTMPBroadcastsResponse"},"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":"Start RTMP broadcasts","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/rtmp_broadcasts/stop":{"post":{"description":"Stop all RTMP broadcasts for the provided call\n","operationId":"StopAllRTMPBroadcasts","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopAllRTMPBroadcastsResponse"}}},"description":"StopAllRTMPBroadcastsResponse"},"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":"Stop all RTMP broadcasts for a call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/rtmp_broadcasts/{name}/stop":{"post":{"description":"Stop RTMP broadcasts for the provided RTMP destinations\n","operationId":"StopRTMPBroadcast","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopRTMPBroadcastsRequest"}}},"description":"StopRTMPBroadcastsRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopRTMPBroadcastsResponse"}}},"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":"Stop RTMP broadcasts","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/start_broadcasting":{"post":{"description":"Starts HLS broadcasting\n","operationId":"StartHLSBroadcasting","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartHLSBroadcastingResponse"}}},"description":"StartHLSBroadcastingResponse"},"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":"Start HLS broadcasting","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/start_closed_captions":{"post":{"description":"Starts closed captions\n","operationId":"StartClosedCaptions","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartClosedCaptionsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartClosedCaptionsResponse"}}},"description":"Successful 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":"Start closed captions","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/start_frame_recording":{"post":{"description":"Starts frame by frame recording\n\nSends events:\n- call.frame_recording_started\n","operationId":"StartFrameRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartFrameRecordingRequest"}}},"description":"StartFrameRecordingRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartFrameRecordingResponse"}}},"description":"StartFrameRecordingResponse"},"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":"Start frame recording","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/start_recording":{"post":{"description":"Starts recording\n\nSends events:\n- call.recording_started\n","operationId":"StartRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRecordingRequest"}}},"description":"StartRecordingRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRecordingResponse"}}},"description":"StartRecordingResponse"},"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":"Start recording","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/start_transcription":{"post":{"description":"Starts transcription\n","operationId":"StartTranscription","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartTranscriptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartTranscriptionResponse"}}},"description":"StartTranscriptionResponse"},"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":"Start transcription","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_broadcasting":{"post":{"description":"Stops HLS broadcasting\n","operationId":"StopHLSBroadcasting","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopHLSBroadcastingResponse"}}},"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":"Stop HLS broadcasting","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_closed_captions":{"post":{"description":"Stops closed captions\n\nSends events:\n- call.transcription_stopped\n","operationId":"StopClosedCaptions","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopClosedCaptionsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopClosedCaptionsResponse"}}},"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":"Stop closed captions","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_frame_recording":{"post":{"description":"Stops frame recording\n\nSends events:\n- call.frame_recording_stopped\n","operationId":"StopFrameRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopFrameRecordingResponse"}}},"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":"Stop frame recording","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_live":{"post":{"description":"\n\nSends events:\n- call.updated\n","operationId":"StopLive","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopLiveRequest"}}},"description":"StopLiveRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopLiveResponse"}}},"description":"StopLiveResponse"},"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":"Set call as not live","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_recording":{"post":{"description":"Stops recording\n\nSends events:\n- call.recording_stopped\n","operationId":"StopRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopRecordingResponse"}}},"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":"Stop recording","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_transcription":{"post":{"description":"Stops transcription\n\nSends events:\n- call.transcription_stopped\n","operationId":"StopTranscription","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopTranscriptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopTranscriptionResponse"}}},"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":"Stop transcription","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/transcriptions":{"get":{"description":"Lists transcriptions\n","operationId":"ListTranscriptions","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTranscriptionsResponse"}}},"description":"ListTranscriptionsResponse"},"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":"List transcriptions","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/unblock":{"post":{"description":"Removes the block for a user on a call. The user will be able to join the call again.\n\nSends events:\n- call.unblocked_user\n","operationId":"UnblockUser","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUserRequest"}}},"description":"UnblockUserRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUserResponse"}}},"description":"UnblockUserResponse"},"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":"Unblocks user on a call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/unpin":{"post":{"description":"Unpins a track for all users in the call.\n","operationId":"VideoUnpin","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnpinRequest"}}},"description":"UnpinRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnpinResponse"}}},"description":"UnpinResponse"},"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":"Unpin","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/user_permissions":{"post":{"description":"Updates user permissions\n\nSends events:\n- call.permissions_updated\n","operationId":"UpdateUserPermissions","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"005.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"005.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUserPermissionsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUserPermissionsResponse"}}},"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":"Update user permissions","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/{session}/recordings/{filename}":{"delete":{"description":"Deletes recording\n","operationId":"DeleteRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"path","name":"session","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"003"}},{"in":"path","name":"filename","required":true,"schema":{"maxLength":256,"type":"string","writeOnly":true,"x-stream-index":"004"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteRecordingResponse"}}},"description":"DeleteRecordingResponse"},"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":"Delete recording","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/{session}/transcriptions/{filename}":{"delete":{"description":"Deletes transcription\n","operationId":"DeleteTranscription","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"path","name":"session","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"003"}},{"in":"path","name":"filename","required":true,"schema":{"maxLength":256,"type":"string","writeOnly":true,"x-stream-index":"004"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteTranscriptionResponse"}}},"description":"DeleteTranscriptionResponse"},"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":"Delete transcription","tags":["product:video"]}},"/api/v2/video/calls":{"post":{"description":"Query calls with filter query\n","operationId":"QueryCalls","parameters":[{"in":"query","name":"connection_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallsRequest"}}},"description":"QueryCallsRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallsResponse"}}},"description":"QueryCallsResponse"},"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":"Query call","tags":["product:video"]}},"/api/v2/video/edges":{"get":{"description":"Returns the list of all edges available for video calls.\n","operationId":"GetEdges","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetEdgesResponse"}}},"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":"Get Edges","tags":["product:video"]}},"/api/v2/video/stats":{"post":{"description":"\n","operationId":"QueryAggregateCallStats","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryAggregateCallStatsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryAggregateCallStatsResponse"}}},"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":"Query Aggregate call Stats","tags":["product:video"]}}},"security":[{"JWT":[],"api_key":[],"stream-auth-type":[]},{"api_key":[],"stream-auth-type":[]}],"servers":[{"description":"Stream API","url":"https://chat.stream-io-api.com"}]} \ No newline at end of file diff --git a/openapi/clientside-api.yaml b/openapi/clientside-api.yaml index 21f27af4e..f47c68c9e 100644 --- a/openapi/clientside-api.yaml +++ b/openapi/clientside-api.yaml @@ -301,6 +301,67 @@ components: - duration title: AcceptCallResponse type: object + AcceptFeedMemberInviteRequest: + nullable: true + title: Accept Feed Member Invite Request + type: object + AcceptFeedMemberInviteResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + member: + $ref: '#/components/schemas/FeedMemberResponse' + description: The feed member after accepting the invite + title: Feed Member + x-stream-index: "001" + required: + - member + - duration + title: Accept Feed Member Invite Response + type: object + AcceptFollowRequest: + nullable: true + properties: + follower_role: + description: Optional role for the follower in the follow relationship + title: Follower Role + type: string + x-stream-index: "003" + source: + description: Fully qualified ID of the source feed + maxLength: 255 + title: Source Feed ID + type: string + x-stream-index: "001" + target: + description: Fully qualified ID of the target feed + maxLength: 255 + title: Target Feed ID + type: string + x-stream-index: "002" + required: + - source + - target + title: Accept Follow Request + type: object + AcceptFollowResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + follow: + $ref: '#/components/schemas/FollowResponse' + description: The accepted follow relationship + title: Follow + x-stream-index: "001" + required: + - follow + - duration + title: Accept Follow Response + type: object Action: nullable: true properties: @@ -471,6 +532,253 @@ components: - warning - warning_text type: object + ActivityAddedEvent: + description: Emitted when an activity is added to a feed. + nullable: true + properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + description: The activity that was added + title: Activity + x-stream-index: "001" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + feed_visibility: + type: string + x-stream-index: "002.003" + fid: + type: string + x-stream-index: "002.002" + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 + type: + default: feeds.activity.added + description: 'The type of event: "feeds.activity.added" in this case' + title: Event Type + type: string + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who added the activity + title: User + x-stream-index: "003.001" + required: + - activity + - type + - created_at + - custom + - fid + title: ActivityAddedEvent + 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 + ActivityDeletedEvent: + description: Emitted when an activity is deleted. + nullable: true + properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + description: The activity that was updated + title: Activity + x-stream-index: "001" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + feed_visibility: + type: string + x-stream-index: "002.003" + fid: + type: string + x-stream-index: "002.002" + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 + type: + default: feeds.activity.deleted + description: 'The type of event: "feeds.activity.deleted" in this case' + title: Event Type + type: string + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + x-stream-index: "003.001" + required: + - activity + - type + - created_at + - custom + - fid + title: ActivityDeletedEvent + 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 + ActivityFeedbackRequest: + description: Request to provide feedback on an activity + nullable: true + properties: + hide: + description: Whether to hide this activity + title: bool + type: boolean + x-stream-index: "003" + mute_user: + description: Whether to mute the user who created this activity + title: bool + type: boolean + x-stream-index: "005" + reason: + description: Reason for the feedback (optional) + maxLength: 1000 + title: string + type: string + x-stream-index: "006" + report: + description: Whether to report this activity + title: bool + type: boolean + x-stream-index: "004" + show_less: + description: Whether to show less content like this + title: bool + type: boolean + x-stream-index: "002" + title: Activity Feedback Request + type: object + ActivityFeedbackResponse: + description: Response for activity feedback submission + nullable: true + properties: + activity_id: + description: The ID of the activity that received feedback + title: string + type: string + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - activity_id + - duration + title: Activity Feedback Response + type: object + ActivityLocation: + properties: + lat: + description: Latitude coordinate + format: float + title: Latitude + type: number + x-stream-index: "001" + lng: + description: Longitude coordinate + format: float + title: Longitude + type: number + x-stream-index: "002" + required: + - lat + - lng + title: Activity Location + type: object + ActivityMarkEvent: + description: Emitted when activities are marked as read, seen, or watched. + nullable: true + properties: + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 006.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 006.001.007 + feed_visibility: + type: string + x-stream-index: "006.003" + fid: + type: string + x-stream-index: "006.002" + mark_all_read: + description: Whether all activities were marked as read + title: Mark All Read + type: boolean + x-stream-index: "004" + mark_all_seen: + description: Whether all activities were marked as seen + title: Mark All Seen + type: boolean + x-stream-index: "005" + mark_read: + description: The IDs of activities marked as read + items: + type: string + title: Mark Read + type: array + x-stream-index: "001" + mark_seen: + description: The IDs of activities marked as seen + items: + type: string + title: Mark Seen + type: array + x-stream-index: "002" + mark_watched: + description: The IDs of activities marked as watched + items: + type: string + title: Mark Watched + type: array + x-stream-index: "003" + received_at: + format: date-time + type: number + x-stream-index: 006.001.004 + type: + default: feeds.activity.marked + description: 'The type of event: "feeds.activity.marked" in this case' + title: Event Type + type: string + x-stream-index: 006.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who marked the activities + title: User + x-stream-index: "007.001" + required: + - type + - created_at + - custom + - fid + title: ActivityMarkEvent + 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 ActivityMarkedEvent: properties: all_read: @@ -516,1376 +824,2107 @@ components: x-stream-event-doc-group: other x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - AnyEvent: + ActivityPinResponse: properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + description: The pinned activity + title: Activity + x-stream-index: "002" created_at: + description: When the pin was created format: date-time + title: Created At type: number - x-stream-index: "001.002" + x-stream-index: "004" + feed: + description: ID of the feed where activity is pinned + title: Feed ID + type: string + x-stream-index: "003" + updated_at: + description: When the pin was last updated + format: date-time + title: Updated At + type: number + x-stream-index: "005" + user: + $ref: '#/components/schemas/UserResponse' + description: User who pinned the activity + title: User + x-stream-index: "001" + required: + - user + - activity + - feed + - created_at + - updated_at + title: Activity Pin + type: object + ActivityPinnedEvent: + description: Emitted when an activity is pinned. + nullable: true + properties: + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + feed_visibility: + type: string + x-stream-index: "002.003" + fid: + description: The ID of the feed + title: Feed ID + type: string + x-stream-index: "002.002" + pinned_activity: + $ref: '#/components/schemas/PinActivityResponse' + x-stream-index: "001" + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 type: - default: '*' + default: feeds.activity.pinned + description: 'The type of event: "feeds.activity.pinned" in this case' + title: Event Type type: string - x-stream-index: "001.001" + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who pinned the activity + title: User + x-stream-index: "003.001" required: + - pinned_activity - type - created_at - title: AnyEvent + - custom + - fid + title: ActivityPinnedEvent 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 - AppEventResponse: + ActivityProcessorConfig: + nullable: true properties: - async_url_enrich_enabled: - description: boolean - title: Async URL Enrichment Enabled - type: boolean - x-stream-index: "002" - auto_translation_enabled: - description: boolean - title: Auto Translation Enabled - type: boolean + config: + additionalProperties: {} + type: object + x-stream-index: "002" + openai_key: + type: string x-stream-index: "003" - file_upload_config: - $ref: '#/components/schemas/FileUploadConfig' - description: file upload config - title: File Upload Config - x-stream-index: "004" - image_upload_config: - $ref: '#/components/schemas/FileUploadConfig' - description: file upload config - title: Image Upload Config - x-stream-index: "005" - name: - description: string - title: App name + type: type: string x-stream-index: "001" required: - - name - - auto_translation_enabled + - type type: object - AppResponseFields: + ActivityReactionAddedEvent: + description: Emitted when a reaction is added to an activity. + nullable: true properties: - async_url_enrich_enabled: - type: boolean - x-stream-index: "017" - auto_translation_enabled: - type: boolean - x-stream-index: "020" - file_upload_config: - $ref: '#/components/schemas/FileUploadConfig' - x-stream-index: "030" - image_upload_config: - $ref: '#/components/schemas/FileUploadConfig' - x-stream-index: "031" - name: - type: string + activity: + $ref: '#/components/schemas/ActivityResponse' x-stream-index: "001" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 003.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 003.001.007 + feed_visibility: + type: string + x-stream-index: "003.003" + fid: + type: string + x-stream-index: "003.002" + reaction: + $ref: '#/components/schemas/FeedsReactionResponse' + description: The reaction that was added + title: Reaction + x-stream-index: "002" + received_at: + format: date-time + type: number + x-stream-index: 003.001.004 + type: + default: feeds.activity.reaction.added + description: 'The type of event: "feeds.activity.reaction.added" in this + case' + title: Event Type + type: string + x-stream-index: 003.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who added the reaction + title: User + x-stream-index: "004.001" required: - - name - - organization - - push_notifications - - webhook_url - - moderation_webhook_url - - channel_configs - - call_types - - policies - - suspended - - suspended_explanation - - disable_auth_checks - - disable_permissions_checks - - permission_version - - user_search_disallowed_roles - - multi_tenant_enabled - - image_moderation_enabled - - async_url_enrich_enabled - - auto_translation_enabled - - custom_action_handler_url - - enforce_unique_usernames - - sqs_url - - sqs_key - - sqs_secret - - sns_topic_arn - - sns_key - - sns_secret - - file_upload_config - - image_upload_config - - grants - - campaign_enabled - - webhook_events - - reminders_interval - - cdn_expiration_seconds - - video_provider - - moderation_enabled - - moderation_multitenant_blocklist_enabled - - guest_user_creation_disabled - - event_hooks - - use_hook_v2 - - user_response_time_enabled - - moderation_bulk_submit_action_enabled + - activity + - reaction + - type + - created_at + - custom + - fid + title: ActivityReactionAddedEvent type: object - AppUpdatedEvent: - description: Emitted when app settings are updated + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + ActivityReactionDeletedEvent: + description: Emitted when a reaction is deleted from an activity. nullable: true properties: - app: - $ref: '#/components/schemas/AppEventResponse' - description: application configuration - title: App settings + activity: + $ref: '#/components/schemas/ActivityResponse' + x-stream-index: "001" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 003.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 003.001.007 + feed_visibility: + type: string + x-stream-index: "003.003" + fid: + type: string + x-stream-index: "003.002" + reaction: + $ref: '#/components/schemas/FeedsReactionResponse' x-stream-index: "002" + received_at: + format: date-time + type: number + x-stream-index: 003.001.004 + type: + default: feeds.activity.reaction.deleted + description: The type of the reaction that was removed + title: Type + type: string + x-stream-index: 003.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who removed the reaction + title: User + x-stream-index: "004.001" + required: + - activity + - reaction + - type + - created_at + - custom + - fid + title: ActivityReactionDeletedEvent + 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 + ActivityReactionUpdatedEvent: + description: Emitted when a reaction is updated on an activity. + nullable: true + properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + x-stream-index: "001" created_at: description: Date/time of creation format: date-time title: Created at type: number - x-stream-index: "001.003" + x-stream-index: 003.001.003 custom: additionalProperties: {} type: object - x-stream-index: "001.007" + x-stream-index: 003.001.007 + feed_visibility: + type: string + x-stream-index: "003.003" + fid: + type: string + x-stream-index: "003.002" + reaction: + $ref: '#/components/schemas/FeedsReactionResponse' + description: The reaction that was updated + title: Reaction + x-stream-index: "002" received_at: format: date-time type: number - x-stream-index: "001.004" + x-stream-index: 003.001.004 type: - default: app.updated - description: 'The type of event: "app.updated" in this case' + default: feeds.activity.reaction.updated + description: 'The type of event: "feeds.activity.reaction.updated" in this + case' title: Event Type type: string - x-stream-index: "001.002" + x-stream-index: 003.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who updated the reaction + title: User + x-stream-index: "004.001" required: + - activity + - reaction - type - created_at - custom - - app - title: AppUpdatedEvent + - fid + title: ActivityReactionUpdatedEvent 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 - Attachment: - description: An attachment is a message object that represents a file uploaded - by a user. + ActivityRemovedFromFeedEvent: + description: Emitted when an activity is removed from a feed. nullable: true properties: - actions: - items: - $ref: '#/components/schemas/Action' - type: array - x-stream-index: "015" - asset_url: + activity: + $ref: '#/components/schemas/ActivityResponse' + x-stream-index: "001" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + feed_visibility: type: string - x-stream-index: "017" - author_icon: + x-stream-index: "002.003" + fid: type: string - x-stream-index: "007" - author_link: + x-stream-index: "002.002" + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 + type: + default: feeds.activity.removed_from_feed + description: 'The type of event: "feeds.activity.removed_from_feed" in this + case' + title: Event Type type: string + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who removed the activity + title: User + x-stream-index: "003.001" + required: + - activity + - type + - created_at + - custom + - fid + title: ActivityRemovedFromFeedEvent + 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 + ActivityRequest: + properties: + attachments: + description: List of attachments for the activity + items: + $ref: '#/components/schemas/Attachment' + title: Attachments + type: array x-stream-index: "006" - author_name: - type: string - x-stream-index: "005" - color: - type: string - x-stream-index: "003" custom: additionalProperties: {} + description: Custom data for the activity + title: Custom Data type: object - x-stream-index: "018" - fallback: + x-stream-index: "017" + expires_at: + description: Expiration time for the activity + title: Expires At type: string - x-stream-index: "002" - fields: + x-stream-index: "010" + feeds: + description: List of feed IDs to add the activity to items: - $ref: '#/components/schemas/Field' + type: string + maximum: 255 + minimum: 1 + title: Feed IDs + type: array + x-stream-index: "004" + filter_tags: + description: Tags for filtering activities + items: + type: string + maximum: 255 + title: Filter Tags type: array - x-stream-index: "016" - footer: - type: string x-stream-index: "013" - footer_icon: + id: + description: Optional ID for the activity + maxLength: 255 + title: Activity ID type: string + x-stream-index: "001" + interest_tags: + description: Tags for indicating user interests + items: + type: string + maximum: 255 + title: Interest Tags + type: array x-stream-index: "014" - giphy: - $ref: '#/components/schemas/Images' - x-stream-index: "019" - image_url: - type: string + location: + $ref: '#/components/schemas/ActivityLocation' + description: Geographic location related to the activity + title: Location + x-stream-index: "009" + mentioned_user_ids: + description: List of users mentioned in the activity + items: + type: string + maximum: 255 + title: Mentioned User IDs + type: array x-stream-index: "011" - og_scrape_url: + parent_id: + description: ID of parent activity for replies/comments + maxLength: 255 + title: Parent ID type: string - x-stream-index: "020" - original_height: + x-stream-index: "015" + poll_id: + description: ID of a poll to attach to activity + title: Poll ID + type: string + x-stream-index: "016" + search_data: + additionalProperties: {} + description: Additional data for search indexing + title: Search Data + type: object + x-stream-index: "012" + text: + description: Text content of the activity + title: Text + type: string + x-stream-index: "005" + type: + description: Type of activity + maxLength: 255 + title: Activity Type + type: string + x-stream-index: "002" + visibility: + description: Visibility setting for the activity + enum: + - public + - private + - tag + title: Visibility + type: string + x-stream-index: "007" + visibility_tag: + description: If visibility is 'tag', this is the tag name and is required + maxLength: 32 + title: Visibility Tag + type: string + x-stream-index: "008" + required: + - type + - feeds + title: Activity Request + type: object + ActivityResponse: + properties: + attachments: + description: Media attachments for the activity + items: + $ref: '#/components/schemas/Attachment' + title: Attachments + type: array + x-stream-index: "009" + bookmark_count: + description: Number of bookmarks on the activity format: int32 + title: Bookmark Count type: integer - x-stream-index: "022" - original_width: + x-stream-index: "028" + comment_count: + description: Number of comments on the activity format: int32 + title: Comment Count type: integer + x-stream-index: "027" + comments: + description: Comments on this activity + items: + $ref: '#/components/schemas/CommentResponse' + title: Comments + type: array + x-stream-index: "015" + created_at: + description: When the activity was created + format: date-time + title: Created At + type: number + x-stream-index: "007" + current_feed: + $ref: '#/components/schemas/FeedResponse' + description: Feed context for this activity view. If an activity is added + only to one feed, it's always set. If an activity is added to multiple + feeds, it's only set when calling the GetOrCreateFeed endpoint. + title: Current Feed + x-stream-index: "035" + custom: + additionalProperties: {} + description: Custom data for the activity + title: Custom Data + type: object + x-stream-index: "011" + deleted_at: + description: When the activity was deleted + format: date-time + title: Deleted At + type: number x-stream-index: "021" - pretext: - type: string + edited_at: + description: When the activity was last edited + format: date-time + title: Edited At + type: number + x-stream-index: "020" + expires_at: + description: When the activity will expire + format: date-time + title: Expires At + type: number + x-stream-index: "022" + feeds: + description: List of feed IDs containing this activity + items: + type: string + title: Feeds + type: array x-stream-index: "004" - text: + filter_tags: + description: Tags for filtering + items: + type: string + title: Filter Tags + type: array + x-stream-index: "024" + hidden: + description: If this activity is hidden for this user. For premium content + where you want to show a preview + title: Hidden + type: boolean + x-stream-index: "036" + id: + description: Unique identifier for the activity + title: ID type: string + x-stream-index: "001" + interest_tags: + description: Tags for user interests + items: + type: string + title: Interest Tags + type: array + x-stream-index: "025" + latest_reactions: + description: Recent reactions to the activity + items: + $ref: '#/components/schemas/FeedsReactionResponse' + title: Latest Reactions + type: array + x-stream-index: "031" + location: + $ref: '#/components/schemas/ActivityLocation' + description: Geographic location related to the activity + title: Location + x-stream-index: "017" + mentioned_users: + description: Users mentioned in the activity + items: + $ref: '#/components/schemas/UserResponse' + title: Mentioned Users + type: array x-stream-index: "010" - thumb_url: - type: string + moderation: + $ref: '#/components/schemas/ModerationV2Response' + description: Moderation information + title: Moderation + x-stream-index: "026" + notification_context: + additionalProperties: {} + description: Notification context data for the activity (if this is a reaction, + comment, follow, etc.) + title: Notification Context + type: object x-stream-index: "012" - title: - type: string - x-stream-index: "008" - title_link: + own_bookmarks: + description: Current user's bookmarks for this activity + items: + $ref: '#/components/schemas/BookmarkResponse' + title: Own Bookmarks + type: array + x-stream-index: "034" + own_reactions: + description: Current user's reactions to this activity + items: + $ref: '#/components/schemas/FeedsReactionResponse' + title: Own Reactions + type: array + x-stream-index: "033" + parent: + $ref: '#/components/schemas/ActivityResponse' + description: Parent activity (if this is a reply/comment) + title: Parent + x-stream-index: "018" + poll: + $ref: '#/components/schemas/PollResponseData' + description: Poll attached to this activity + title: Poll + x-stream-index: "019" + popularity: + description: Popularity score of the activity + format: int32 + title: Popularity + type: integer + x-stream-index: "013" + reaction_count: + description: Number of reactions to the activity + format: int32 + title: Reaction Count + type: integer + x-stream-index: "030" + reaction_groups: + additionalProperties: + $ref: '#/components/schemas/ReactionGroupResponse' + description: Grouped reactions by type + title: Reaction Groups + type: object + x-stream-index: "032" + score: + description: Ranking score for this activity + format: float + title: Score + type: number + x-stream-index: "014" + search_data: + additionalProperties: {} + description: Data for search indexing + title: Search Data + type: object + x-stream-index: "023" + share_count: + description: Number of times the activity was shared + format: int32 + title: Share Count + type: integer + x-stream-index: "029" + text: + description: Text content of the activity + title: Text type: string - x-stream-index: "009" + x-stream-index: "016" type: - description: Attachment type (e.g. image, video, url) + description: Type of activity title: Type type: string - x-stream-index: "001" + x-stream-index: "002" + updated_at: + description: When the activity was last updated + format: date-time + title: Updated At + type: number + x-stream-index: "008" + user: + $ref: '#/components/schemas/UserResponse' + description: User who created the activity + title: User + x-stream-index: "003" + visibility: + description: Visibility setting for the activity + enum: + - public + - private + - tag + title: Visibility + type: string + x-stream-index: "005" + visibility_tag: + description: If visibility is 'tag', this is the tag name + title: Visibility Tag + type: string + x-stream-index: "006" required: + - id + - type + - user + - feeds + - visibility + - created_at + - updated_at + - attachments + - mentioned_users - custom - title: Attachment + - popularity + - score + - comments + - search_data + - filter_tags + - interest_tags + - comment_count + - bookmark_count + - share_count + - reaction_count + - latest_reactions + - reaction_groups + - own_reactions + - own_bookmarks + title: Base Activity type: object - x-stream-docs-page-id: file_uploads - AudioSettings: + ActivitySelectorConfig: + nullable: true properties: - access_request_enabled: - type: boolean - x-stream-index: "001" - default_device: - enum: - - speaker - - earpiece - type: string - x-stream-index: "006" - mic_default_on: - type: boolean + cutoff_time: + format: date-time + type: number x-stream-index: "004" - noise_cancellation: - $ref: '#/components/schemas/NoiseCancellationSettings' - x-stream-index: "007" - opus_dtx_enabled: - type: boolean + filter: + additionalProperties: {} + type: object x-stream-index: "002" - redundant_coding_enabled: - type: boolean - x-stream-index: "003" - speaker_default_on: - type: boolean + min_popularity: + format: int32 + type: integer x-stream-index: "005" + sort: + items: + $ref: '#/components/schemas/SortParam' + type: array + x-stream-index: "003" + type: + type: string + x-stream-index: "001" required: - - access_request_enabled - - opus_dtx_enabled - - redundant_coding_enabled - - mic_default_on - - speaker_default_on - - default_device + - cutoff_time type: object - AudioSettingsRequest: + ActivityUnpinnedEvent: + description: Emitted when an activity is unpinned. + nullable: true properties: - access_request_enabled: - type: boolean - x-stream-index: "001" - default_device: - enum: - - speaker - - earpiece - type: string - x-stream-index: "006" - mic_default_on: - type: boolean - x-stream-index: "004" - noise_cancellation: - $ref: '#/components/schemas/NoiseCancellationSettings' - x-stream-index: "007" - opus_dtx_enabled: - type: boolean - x-stream-index: "002" - redundant_coding_enabled: - type: boolean - x-stream-index: "003" - speaker_default_on: - type: boolean - x-stream-index: "005" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + feed_visibility: + type: string + x-stream-index: "002.003" + fid: + description: The ID of the feed + title: Feed ID + type: string + x-stream-index: "002.002" + pinned_activity: + $ref: '#/components/schemas/PinActivityResponse' + x-stream-index: "001" + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 + type: + default: feeds.activity.unpinned + description: 'The type of event: "feeds.activity.unpinned" in this case' + title: Event Type + type: string + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who unpinned the activity + title: User + x-stream-index: "003.001" required: - - default_device + - pinned_activity + - type + - created_at + - custom + - fid + title: ActivityUnpinnedEvent type: object - AudioSettingsResponse: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + ActivityUpdatedEvent: + description: Emitted when an activity is updated. + nullable: true properties: - access_request_enabled: - type: boolean + activity: + $ref: '#/components/schemas/ActivityResponse' + description: The activity that was updated + title: Activity x-stream-index: "001" - default_device: - enum: - - speaker - - earpiece + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + feed_visibility: type: string - x-stream-index: "006" - mic_default_on: - type: boolean - x-stream-index: "004" - noise_cancellation: - $ref: '#/components/schemas/NoiseCancellationSettings' - x-stream-index: "007" - opus_dtx_enabled: - type: boolean - x-stream-index: "002" - redundant_coding_enabled: - type: boolean - x-stream-index: "003" - speaker_default_on: - type: boolean - x-stream-index: "005" + x-stream-index: "002.003" + fid: + type: string + x-stream-index: "002.002" + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 + type: + default: feeds.activity.updated + description: The type of the event + title: Event Type + type: string + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who updated the activity + title: User + x-stream-index: "003.001" required: - - access_request_enabled - - opus_dtx_enabled - - redundant_coding_enabled - - mic_default_on - - speaker_default_on - - default_device + - activity + - type + - created_at + - custom + - fid + title: ActivityUpdatedEvent type: object - AutomodDetails: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + AddActivityRequest: + nullable: true properties: - action: + attachments: + description: List of attachments for the activity + items: + $ref: '#/components/schemas/Attachment' + title: Attachments + type: array + x-stream-index: "001.006" + custom: + additionalProperties: {} + description: Custom data for the activity + title: Custom Data + type: object + x-stream-index: "001.017" + expires_at: + description: Expiration time for the activity + title: Expires At type: string - x-stream-index: "001" - image_labels: + x-stream-index: "001.010" + feeds: + description: List of feed IDs to add the activity to items: type: string + maximum: 255 + minimum: 1 + title: Feed IDs type: array - x-stream-index: "005" - message_details: - $ref: '#/components/schemas/FlagMessageDetails' + x-stream-index: "001.004" + filter_tags: + description: Tags for filtering activities + items: + type: string + maximum: 255 + title: Filter Tags + type: array + x-stream-index: "001.013" + id: + description: Optional ID for the activity + maxLength: 255 + title: Activity ID + type: string + x-stream-index: "001.001" + interest_tags: + description: Tags for indicating user interests + items: + type: string + maximum: 255 + title: Interest Tags + type: array + x-stream-index: "001.014" + location: + $ref: '#/components/schemas/ActivityLocation' + description: Geographic location related to the activity + title: Location + x-stream-index: "001.009" + mentioned_user_ids: + description: List of users mentioned in the activity + items: + type: string + maximum: 255 + title: Mentioned User IDs + type: array + x-stream-index: "001.011" + parent_id: + description: ID of parent activity for replies/comments + maxLength: 255 + title: Parent ID + type: string + x-stream-index: "001.015" + poll_id: + description: ID of a poll to attach to activity + title: Poll ID + type: string + x-stream-index: "001.016" + search_data: + additionalProperties: {} + description: Additional data for search indexing + title: Search Data + type: object + x-stream-index: "001.012" + text: + description: Text content of the activity + title: Text + type: string + x-stream-index: "001.005" + type: + description: Type of activity + maxLength: 255 + title: Activity Type + type: string + x-stream-index: "001.002" + visibility: + description: Visibility setting for the activity + enum: + - public + - private + - tag + title: Visibility + type: string + x-stream-index: "001.007" + visibility_tag: + description: If visibility is 'tag', this is the tag name and is required + maxLength: 32 + title: Visibility Tag + type: string + x-stream-index: "001.008" + required: + - type + - feeds + title: Activity Request + type: object + AddActivityResponse: + nullable: true + properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + description: The created activity + title: Activity + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - activity + - duration + title: Add Activity Response + type: object + AddBookmarkRequest: + nullable: true + properties: + custom: + additionalProperties: {} + description: Custom data for the bookmark + title: Custom Data + type: object x-stream-index: "004" - original_message_type: + folder_id: + description: ID of the folder to add the bookmark to + maxLength: 255 + title: Folder ID type: string x-stream-index: "002" - result: - $ref: '#/components/schemas/MessageModerationResult' + new_folder: + $ref: '#/components/schemas/AddFolderRequest' + description: Create a new folder for this bookmark + title: New Folder x-stream-index: "003" + title: Add Bookmark Request type: object - AutomodPlatformCircumventionConfig: + AddBookmarkResponse: + nullable: true properties: - async: - type: boolean + bookmark: + $ref: '#/components/schemas/BookmarkResponse' + description: The created bookmark + title: Bookmark x-stream-index: "001" - enabled: - type: boolean - x-stream-index: "002" - rules: - items: - $ref: '#/components/schemas/AutomodRule' - type: array - x-stream-index: "003" + duration: + type: string + x-stream-index: "002.001" required: - - enabled - - rules + - bookmark + - duration + title: Add Bookmark Response type: object - AutomodRule: + AddCommentReactionRequest: + nullable: true properties: - action: - enum: - - flag - - shadow - - remove - - bounce - - bounce_flag - - bounce_remove - type: string + create_notification_activity: + description: Whether to create a notification activity for this reaction + title: boolean + type: boolean + x-stream-index: "004" + custom: + additionalProperties: {} + description: Optional custom data to add to the reaction + title: object + type: object x-stream-index: "003" - label: + skip_push: + type: boolean + x-stream-index: "005" + type: + description: The type of reaction, eg upvote, like, ... + maxLength: 255 + title: string type: string - x-stream-index: "001" - threshold: - format: float - maximum: 1 - minimum: 0 - type: number x-stream-index: "002" required: - - label - - threshold - - action + - type type: object - AutomodSemanticFiltersConfig: + AddCommentReactionResponse: + nullable: true properties: - async: - type: boolean + comment: + $ref: '#/components/schemas/CommentResponse' + description: The comment the reaction was added to + title: object x-stream-index: "001" - enabled: - type: boolean + duration: + description: Duration of the request + title: string + type: string + x-stream-index: "003.001" + reaction: + $ref: '#/components/schemas/FeedsReactionResponse' + description: The created or updated reaction + title: object x-stream-index: "002" - rules: + required: + - comment + - reaction + - duration + type: object + AddCommentRequest: + nullable: true + properties: + attachments: + description: Media attachments for the reply items: - $ref: '#/components/schemas/AutomodSemanticFiltersRule' + $ref: '#/components/schemas/Attachment' + title: Attachments type: array + x-stream-index: "004" + comment: + description: Text content of the comment + title: Comment + type: string x-stream-index: "003" + create_notification_activity: + description: Whether to create a notification activity for this comment + title: Create Notification Activity + type: boolean + x-stream-index: "008" + custom: + additionalProperties: {} + description: Custom data for the comment + title: Custom Data + type: object + x-stream-index: "007" + mentioned_user_ids: + description: List of users mentioned in the reply + items: + type: string + maximum: 255 + title: Mentioned User IDs + type: array + x-stream-index: "005" + object_id: + description: ID of the object to comment on + title: Object ID + type: string + x-stream-index: "001" + object_type: + description: Type of the object to comment on + title: Object Type + type: string + x-stream-index: "002" + parent_id: + description: ID of parent comment for replies + title: Parent ID + type: string + x-stream-index: "006" + skip_push: + type: boolean + x-stream-index: "009" required: - - enabled - - rules + - object_id + - object_type + - comment + title: Add Comment Request type: object - AutomodSemanticFiltersRule: + AddCommentResponse: + nullable: true properties: - action: - enum: - - flag - - shadow - - remove + comment: + $ref: '#/components/schemas/CommentResponse' + description: The created comment + title: Comment + x-stream-index: "001" + duration: type: string - x-stream-index: "003" + x-stream-index: "002.001" + required: + - comment + - duration + title: Add Comment Response + type: object + AddCommentsBatchRequest: + nullable: true + properties: + comments: + description: List of comments to add + items: + $ref: '#/components/schemas/AddCommentRequest' + title: Comments + type: array + x-stream-index: "001" + required: + - comments + title: Add Comments Batch Request + type: object + AddCommentsBatchResponse: + nullable: true + properties: + comments: + description: List of comments added + items: + $ref: '#/components/schemas/CommentResponse' + title: Comments + type: array + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - comments + - duration + title: Add Comments Batch Response + type: object + AddFolderRequest: + properties: + custom: + additionalProperties: {} + description: Custom data for the folder + title: Custom Data + type: object + x-stream-index: "002" name: + description: Name of the folder + maxLength: 255 + title: Name type: string x-stream-index: "001" - threshold: - format: float - maximum: 1 - minimum: 0 - type: number - x-stream-index: "002" required: - name - - threshold - - action + title: Add Folder Request type: object - AutomodToxicityConfig: + AddReactionRequest: + nullable: true properties: - async: + create_notification_activity: + description: Whether to create a notification activity for this reaction + title: Create Notification Activity type: boolean - x-stream-index: "001" - enabled: + x-stream-index: "004" + custom: + additionalProperties: {} + description: Custom data for the reaction + title: Custom Data + type: object + x-stream-index: "003" + skip_push: type: boolean + x-stream-index: "005" + type: + description: Type of reaction + maxLength: 255 + title: Reaction Type + type: string x-stream-index: "002" - rules: - items: - $ref: '#/components/schemas/AutomodRule' - type: array - x-stream-index: "003" required: - - enabled - - rules + - type + title: Add Reaction Request type: object - BackstageSettings: + AddReactionResponse: + nullable: true properties: - enabled: - type: boolean + activity: + $ref: '#/components/schemas/ActivityResponse' x-stream-index: "001" - join_ahead_time_seconds: - format: int32 - type: integer + duration: + type: string + x-stream-index: "003.001" + reaction: + $ref: '#/components/schemas/FeedsReactionResponse' + description: The created reaction + title: Reaction x-stream-index: "002" required: - - enabled + - activity + - reaction + - duration + title: Add Reaction Response type: object - BackstageSettingsRequest: + AggregatedActivityResponse: properties: - enabled: - type: boolean + activities: + description: List of activities in this aggregation + items: + $ref: '#/components/schemas/ActivityResponse' + title: Activities + type: array x-stream-index: "001" - join_ahead_time_seconds: + activity_count: + description: Number of activities in this aggregation format: int32 + title: Activity Count type: integer x-stream-index: "002" + created_at: + description: When the aggregation was created + format: date-time + title: Created At + type: number + x-stream-index: "006" + group: + description: Grouping identifier + title: Group + type: string + x-stream-index: "004" + score: + description: Ranking score for this aggregation + format: float + title: Score + type: number + x-stream-index: "005" + updated_at: + description: When the aggregation was last updated + format: date-time + title: Updated At + type: number + x-stream-index: "007" + user_count: + description: Number of unique users in this aggregation + format: int32 + title: User Count + type: integer + x-stream-index: "003" + required: + - activities + - activity_count + - user_count + - group + - score + - created_at + - updated_at + title: Aggregated Activity type: object - BackstageSettingsResponse: + AggregationConfig: properties: - enabled: - type: boolean + format: + type: string x-stream-index: "001" - join_ahead_time_seconds: + group_size: format: int32 type: integer x-stream-index: "002" - required: - - enabled type: object - Ban: - nullable: true + AnyEvent: properties: - channel: - $ref: '#/components/schemas/Channel' - x-stream-index: "004" created_at: format: date-time type: number - x-stream-index: "012" - created_by: - $ref: '#/components/schemas/User' - x-stream-index: "011" - expires: - format: date-time - type: number - x-stream-index: "007" - reason: + x-stream-index: "001.002" + type: + default: '*' type: string - x-stream-index: "008" - shadow: - type: boolean - x-stream-index: "009" - target: - $ref: '#/components/schemas/User' - x-stream-index: "006" + x-stream-index: "001.001" required: - - shadow + - type - created_at + title: AnyEvent type: object - BanActionRequest: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + AppEventResponse: properties: - channel_ban_only: + async_url_enrich_enabled: + description: boolean + title: Async URL Enrichment Enabled type: boolean - x-stream-index: "003" - delete_messages: - enum: - - soft - - pruning - - hard - type: string - x-stream-index: "005" - ip_ban: + x-stream-index: "002" + auto_translation_enabled: + description: boolean + title: Auto Translation Enabled type: boolean + x-stream-index: "003" + file_upload_config: + $ref: '#/components/schemas/FileUploadConfig' + description: file upload config + title: File Upload Config x-stream-index: "004" - reason: + image_upload_config: + $ref: '#/components/schemas/FileUploadConfig' + description: file upload config + title: Image Upload Config + x-stream-index: "005" + name: + description: string + title: App name type: string - x-stream-index: "002" - shadow: - type: boolean x-stream-index: "001" - timeout: - format: int32 - type: integer - x-stream-index: "006" + required: + - name + - auto_translation_enabled type: object - BanOptions: + AppResponseFields: properties: - duration: - format: int32 - type: integer - x-stream-index: "001" - ip_ban: - type: boolean - x-stream-index: "004" - reason: - type: string - x-stream-index: "002" - shadow_ban: + async_url_enrich_enabled: type: boolean - x-stream-index: "003" - required: - - duration - - reason - - shadow_ban - - ip_ban - type: object - BanRequest: - nullable: true - properties: - banned_by: - $ref: '#/components/schemas/UserRequest' - description: Details about the user performing the ban - title: Banned By - x-stream-index: "008" - banned_by_id: - description: ID of the user performing the ban - title: Banned By ID - type: string - x-stream-index: "007" - channel_cid: - description: Channel where the ban applies - title: Channel CID - type: string - x-stream-index: "004" - delete_messages: - enum: - - soft - - pruning - - hard - type: string - x-stream-index: "009" - ip_ban: - description: Whether to ban the user's IP address - title: IP Ban - type: boolean - x-stream-index: "006" - reason: - description: Optional explanation for the ban - title: Reason - type: string - x-stream-index: "003" - shadow: - description: Whether this is a shadow ban - title: Shadow + x-stream-index: "017" + auto_translation_enabled: type: boolean - x-stream-index: "005" - target_user_id: - description: ID of the user to ban - title: Target User ID + x-stream-index: "020" + file_upload_config: + $ref: '#/components/schemas/FileUploadConfig' + x-stream-index: "030" + image_upload_config: + $ref: '#/components/schemas/FileUploadConfig' + x-stream-index: "031" + name: type: string x-stream-index: "001" - timeout: - description: Duration of the ban in minutes - minimum: 0 - title: Timeout - type: integer - x-stream-index: "002" required: - - target_user_id + - name + - organization + - push_notifications + - webhook_url + - moderation_webhook_url + - channel_configs + - call_types + - policies + - suspended + - suspended_explanation + - disable_auth_checks + - disable_permissions_checks + - permission_version + - user_search_disallowed_roles + - multi_tenant_enabled + - image_moderation_enabled + - async_url_enrich_enabled + - auto_translation_enabled + - custom_action_handler_url + - enforce_unique_usernames + - sqs_url + - sqs_key + - sqs_secret + - sns_topic_arn + - sns_key + - sns_secret + - file_upload_config + - image_upload_config + - grants + - campaign_enabled + - webhook_events + - reminders_interval + - cdn_expiration_seconds + - video_provider + - moderation_enabled + - moderation_multitenant_blocklist_enabled + - guest_user_creation_disabled + - event_hooks + - use_hook_v2 + - user_response_time_enabled + - moderation_bulk_submit_action_enabled + - moderation_llm_configurability_enabled type: object - BanResponse: + AppUpdatedEvent: + description: Emitted when app settings are updated nullable: true properties: - banned_by: - $ref: '#/components/schemas/UserResponse' - x-stream-index: "006" - channel: - $ref: '#/components/schemas/ChannelResponse' - x-stream-index: "001" + app: + $ref: '#/components/schemas/AppEventResponse' + description: application configuration + title: App settings + x-stream-index: "002" created_at: + description: Date/time of creation format: date-time + title: Created at type: number - x-stream-index: "007" - expires: + x-stream-index: "001.003" + custom: + additionalProperties: {} + type: object + x-stream-index: "001.007" + received_at: format: date-time type: number - x-stream-index: "003" - reason: + x-stream-index: "001.004" + type: + default: app.updated + description: 'The type of event: "app.updated" in this case' + title: Event Type type: string - x-stream-index: "004" - shadow: - type: boolean - x-stream-index: "005" - user: - $ref: '#/components/schemas/UserResponse' - x-stream-index: "002" + x-stream-index: "001.002" required: + - type - created_at + - custom + - app + title: AppUpdatedEvent type: object - BlockContentOptions: - properties: - reason: - type: string - x-stream-index: "001" - required: - - reason - type: object - BlockListConfig: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + Attachment: + description: An attachment is a message object that represents a file uploaded + by a user. + nullable: true properties: - async: - type: boolean - x-stream-index: "001" - enabled: - type: boolean - x-stream-index: "002" - rules: + actions: items: - $ref: '#/components/schemas/BlockListRule' - maximum: 10 + $ref: '#/components/schemas/Action' type: array - x-stream-index: "003" - required: - - enabled - - rules - type: object - BlockListOptions: - properties: - behavior: - description: Blocklist behavior - enum: - - flag - - block - - shadow_block - title: Behavior + x-stream-index: "015" + asset_url: type: string - x-stream-index: "002" - blocklist: - description: Blocklist name - title: Blocklist + x-stream-index: "017" + author_icon: type: string - x-stream-index: "001" - required: - - blocklist - - behavior - type: object - BlockListResponse: - description: Block list contains restricted words - properties: - created_at: - description: Date/time of creation - format: date-time - title: Created at - type: number - x-stream-index: "001" - id: + x-stream-index: "007" + author_link: type: string - x-stream-index: "003" - name: - description: Block list name - title: Name + x-stream-index: "006" + author_name: type: string - x-stream-index: "004" - team: + x-stream-index: "005" + color: type: string - x-stream-index: "007" - type: - description: Block list type. - title: Type + x-stream-index: "003" + custom: + additionalProperties: {} + type: object + x-stream-index: "018" + fallback: type: string - x-stream-index: "005" - updated_at: - description: Date/time of the last update - format: date-time - title: Updated at - type: number x-stream-index: "002" - words: - description: List of words to block + fields: items: - type: string - title: Words + $ref: '#/components/schemas/Field' type: array - x-stream-index: "006" - required: - - name - - type - - words - title: Block list - type: object - x-stream-docs-page-id: block_lists - BlockListRule: - properties: - action: - enum: - - flag - - mask_flag - - shadow - - remove - - bounce - - bounce_flag - - bounce_remove + x-stream-index: "016" + footer: type: string - x-stream-index: "003" - name: + x-stream-index: "013" + footer_icon: + type: string + x-stream-index: "014" + giphy: + $ref: '#/components/schemas/Images' + x-stream-index: "019" + image_url: + type: string + x-stream-index: "011" + og_scrape_url: + type: string + x-stream-index: "020" + original_height: + format: int32 + type: integer + x-stream-index: "022" + original_width: + format: int32 + type: integer + x-stream-index: "021" + pretext: + type: string + x-stream-index: "004" + text: + type: string + x-stream-index: "010" + thumb_url: + type: string + x-stream-index: "012" + title: + type: string + x-stream-index: "008" + title_link: + type: string + x-stream-index: "009" + type: + description: Attachment type (e.g. image, video, url) + title: Type type: string x-stream-index: "001" - team: + required: + - custom + title: Attachment + type: object + x-stream-docs-page-id: file_uploads + AudioSettings: + properties: + access_request_enabled: + type: boolean + x-stream-index: "001" + default_device: + enum: + - speaker + - earpiece type: string + x-stream-index: "006" + mic_default_on: + type: boolean + x-stream-index: "004" + noise_cancellation: + $ref: '#/components/schemas/NoiseCancellationSettings' + x-stream-index: "007" + opus_dtx_enabled: + type: boolean x-stream-index: "002" + redundant_coding_enabled: + type: boolean + x-stream-index: "003" + speaker_default_on: + type: boolean + x-stream-index: "005" required: - - name - - team - - action + - access_request_enabled + - opus_dtx_enabled + - redundant_coding_enabled + - mic_default_on + - speaker_default_on + - default_device type: object - BlockUserRequest: - description: BlockUserRequest is the payload for blocking a user. - nullable: true + AudioSettingsRequest: properties: - user_id: - description: the user to block - title: UserID + access_request_enabled: + type: boolean + x-stream-index: "001" + default_device: + enum: + - speaker + - earpiece type: string + x-stream-index: "006" + mic_default_on: + type: boolean + x-stream-index: "004" + noise_cancellation: + $ref: '#/components/schemas/NoiseCancellationSettings' + x-stream-index: "007" + opus_dtx_enabled: + type: boolean + x-stream-index: "002" + redundant_coding_enabled: + type: boolean x-stream-index: "003" + speaker_default_on: + type: boolean + x-stream-index: "005" required: - - user_id - title: BlockUserRequest + - default_device type: object - BlockUserResponse: - description: BlockUserResponse is the payload for blocking a user. - nullable: true + AudioSettingsResponse: properties: - duration: - description: Duration of the request in milliseconds - title: Duration + access_request_enabled: + type: boolean + x-stream-index: "001" + default_device: + enum: + - speaker + - earpiece type: string - x-stream-index: "001.001" + x-stream-index: "006" + mic_default_on: + type: boolean + x-stream-index: "004" + noise_cancellation: + $ref: '#/components/schemas/NoiseCancellationSettings' + x-stream-index: "007" + opus_dtx_enabled: + type: boolean + x-stream-index: "002" + redundant_coding_enabled: + type: boolean + x-stream-index: "003" + speaker_default_on: + type: boolean + x-stream-index: "005" required: - - duration - title: BlockUserResponse + - access_request_enabled + - opus_dtx_enabled + - redundant_coding_enabled + - mic_default_on + - speaker_default_on + - default_device type: object - BlockUsersRequest: - nullable: true + AutomodDetails: properties: - blocked_user_id: - description: User id to block - title: BlockedUserID + action: type: string x-stream-index: "001" - required: - - blocked_user_id + image_labels: + items: + type: string + type: array + x-stream-index: "005" + message_details: + $ref: '#/components/schemas/FlagMessageDetails' + x-stream-index: "004" + original_message_type: + type: string + x-stream-index: "002" + result: + $ref: '#/components/schemas/MessageModerationResult' + x-stream-index: "003" type: object - BlockUsersResponse: - nullable: true + AutomodPlatformCircumventionConfig: properties: - blocked_by_user_id: - description: User id who blocked another user - title: BlockedByUserID - type: string + async: + type: boolean + x-stream-index: "001" + enabled: + type: boolean x-stream-index: "002" - blocked_user_id: - description: User id who got blocked - title: BlockedUserID - type: string + rules: + items: + $ref: '#/components/schemas/AutomodRule' + type: array x-stream-index: "003" - created_at: - description: Timestamp when the user was blocked - format: date-time - title: CreatedAt - type: number - x-stream-index: "004" - duration: - description: Duration of the request in milliseconds - title: Duration - type: string - x-stream-index: "001.001" required: - - duration - - blocked_by_user_id - - blocked_user_id - - created_at + - enabled + - rules type: object - BlockedUserEvent: - description: |- - This event is sent to call participants to notify when a user is blocked on a call, clients can use this event to show a notification. - If the user is the current user, the client should leave the call screen as well + AutomodRule: properties: - blocked_by_user: - $ref: '#/components/schemas/UserResponse' - description: The user that blocked the user, null if the user was blocked - by server-side - title: Blocked by - x-stream-index: "004" - call_cid: + action: + enum: + - flag + - shadow + - remove + - bounce + - bounce_flag + - bounce_remove type: string - x-stream-index: "002.001" - created_at: - format: date-time - type: number - x-stream-index: "001.002" - type: - default: call.blocked_user - description: 'The type of event: "call.blocked_user" in this case' - title: Event Type + x-stream-index: "003" + label: type: string - x-stream-index: "001.001" - user: - $ref: '#/components/schemas/UserResponse' - description: The user that was blocked - title: User - x-stream-index: "003" - required: - - type - - created_at - - call_cid - - user - title: BlockedUserEvent - type: object - x-stream-event-call-type: true - x-stream-event-doc-group: call - x-stream-is-event: true - x-stream-ws-base-event-name: VideoEvent - BlockedUserResponse: - nullable: true - properties: - blocked_user: - $ref: '#/components/schemas/UserResponse' - description: User who got blocked - title: User - x-stream-index: "003" - blocked_user_id: - description: ID of the user who got blocked - title: UserID - type: string - x-stream-index: "004" - created_at: - format: date-time - type: number - x-stream-index: "005" - user: - $ref: '#/components/schemas/UserResponse' - description: User who blocked another user - title: User x-stream-index: "001" - user_id: - description: ID of the user who blocked another user - title: UserID - type: string + threshold: + format: float + maximum: 1 + minimum: 0 + type: number x-stream-index: "002" required: - - user - - user_id - - blocked_user - - blocked_user_id - - created_at + - label + - threshold + - action type: object - BodyguardRule: + AutomodSemanticFiltersConfig: properties: - action: - enum: - - flag - - shadow - - remove - - bounce - - bounce_flag - - bounce_remove - type: string - x-stream-index: "002" - label: - type: string + async: + type: boolean x-stream-index: "001" - severity_rules: + enabled: + type: boolean + x-stream-index: "002" + rules: items: - $ref: '#/components/schemas/BodyguardSeverityRule' + $ref: '#/components/schemas/AutomodSemanticFiltersRule' type: array x-stream-index: "003" required: - - label - - action - - severity_rules + - enabled + - rules type: object - BodyguardSeverityRule: + AutomodSemanticFiltersRule: properties: action: enum: - flag - shadow - remove - - bounce - - bounce_flag - - bounce_remove type: string - x-stream-index: "002" - severity: - enum: - - low - - medium - - high - - critical + x-stream-index: "003" + name: type: string x-stream-index: "001" + threshold: + format: float + maximum: 1 + minimum: 0 + type: number + x-stream-index: "002" required: - - severity + - name + - threshold - action type: object - Bound: + AutomodToxicityConfig: properties: - inclusive: + async: type: boolean - x-stream-index: "002" - value: - format: float - type: number x-stream-index: "001" + enabled: + type: boolean + x-stream-index: "002" + rules: + items: + $ref: '#/components/schemas/AutomodRule' + type: array + x-stream-index: "003" required: - - value - - inclusive + - enabled + - rules type: object - BroadcastSettings: + BackstageSettings: properties: enabled: type: boolean x-stream-index: "001" - hls: - $ref: '#/components/schemas/HLSSettings' + join_ahead_time_seconds: + format: int32 + type: integer x-stream-index: "002" - rtmp: - $ref: '#/components/schemas/RTMPSettings' - x-stream-index: "003" required: - enabled type: object - BroadcastSettingsRequest: + BackstageSettingsRequest: properties: enabled: type: boolean x-stream-index: "001" - hls: - $ref: '#/components/schemas/HLSSettingsRequest' + join_ahead_time_seconds: + format: int32 + type: integer x-stream-index: "002" - rtmp: - $ref: '#/components/schemas/RTMPSettingsRequest' - x-stream-index: "003" type: object - BroadcastSettingsResponse: - description: BroadcastSettingsResponse is the payload for broadcasting settings + BackstageSettingsResponse: properties: enabled: - title: Enabled type: boolean x-stream-index: "001" - hls: - $ref: '#/components/schemas/HLSSettingsResponse' - title: HLS + join_ahead_time_seconds: + format: int32 + type: integer x-stream-index: "002" - rtmp: - $ref: '#/components/schemas/RTMPSettingsResponse' - title: RTMP - x-stream-index: "003" required: - enabled - - hls - - rtmp - title: BroadcastSettingsResponse type: object - Call: + Ban: + nullable: true properties: - AppPK: - format: int32 - type: integer - writeOnly: true - x-stream-index: "002" - Backstage: - type: boolean - writeOnly: true - x-stream-index: "023" - BlockedUserIDs: - items: - type: string - type: array - writeOnly: true - x-stream-index: "018" - BlockedUsers: - items: - $ref: '#/components/schemas/User' - type: array - writeOnly: true - x-stream-index: "019" - CID: - type: string - writeOnly: true - x-stream-index: "005" - CallType: - $ref: '#/components/schemas/CallType' - x-stream-index: "020" - ChannelCID: - type: string - writeOnly: true - x-stream-index: "032" - CreatedAt: + channel: + $ref: '#/components/schemas/Channel' + x-stream-index: "004" + created_at: format: date-time type: number - writeOnly: true - x-stream-index: "013" - CreatedBy: - $ref: '#/components/schemas/User' - x-stream-index: "008" - CreatedByUserID: - type: string - writeOnly: true - x-stream-index: "007" - CurrentSessionID: - type: string - writeOnly: true - x-stream-index: "024" - Custom: - additionalProperties: {} - type: object - writeOnly: true x-stream-index: "012" - DeletedAt: - format: date-time - type: number - writeOnly: true - x-stream-index: "028" - EgressUpdatedAt: - format: date-time - type: number - writeOnly: true - x-stream-index: "027" - Egresses: - items: - $ref: '#/components/schemas/CallEgress' - type: array - writeOnly: true - x-stream-index: "015" - EndedAt: + created_by: + $ref: '#/components/schemas/User' + x-stream-index: "011" + expires: format: date-time type: number - writeOnly: true - x-stream-index: "017" - ID: + x-stream-index: "007" + reason: type: string - writeOnly: true - x-stream-index: "004" - JoinAheadTimeSeconds: - format: int32 - type: integer - writeOnly: true - x-stream-index: "031" - LastHeartbeatAt: - format: date-time - type: number - writeOnly: true - x-stream-index: "030" - LastSessionID: - type: string - writeOnly: true - x-stream-index: "025" - MemberCount: - format: int32 - type: integer - writeOnly: true - x-stream-index: "010" - MemberLookup: - $ref: '#/components/schemas/MemberLookup' - x-stream-index: "011" - Members: - items: - $ref: '#/components/schemas/CallMember' - type: array - writeOnly: true + x-stream-index: "008" + shadow: + type: boolean x-stream-index: "009" - Session: - $ref: '#/components/schemas/CallSession' - x-stream-index: "026" - Settings: - $ref: '#/components/schemas/CallSettings' - x-stream-index: "022" - SettingsOverrides: - $ref: '#/components/schemas/CallSettings' - x-stream-index: "021" - StartsAt: - format: date-time - type: number - writeOnly: true - x-stream-index: "016" - Team: - type: string - writeOnly: true + target: + $ref: '#/components/schemas/User' x-stream-index: "006" - ThumbnailURL: - type: string - writeOnly: true - x-stream-index: "029" - Type: - type: string - writeOnly: true - x-stream-index: "003" - UpdatedAt: - format: date-time - type: number - writeOnly: true - x-stream-index: "014" required: - - AppPK - - Type - - ID - - CID - - Team - - CreatedByUserID - - Members - - Custom - - CreatedAt - - UpdatedAt - - Egresses - - BlockedUserIDs - - BlockedUsers - - Backstage - - CurrentSessionID - - LastSessionID - - ThumbnailURL - - ChannelCID + - shadow + - created_at type: object - CallAcceptedEvent: - description: This event is sent when a user accepts a notification to join a - call. + BanActionRequest: properties: - call: - $ref: '#/components/schemas/CallResponse' + channel_ban_only: + type: boolean x-stream-index: "003" - call_cid: - type: string - x-stream-index: "002.001" - created_at: - format: date-time - type: number - x-stream-index: "001.002" - type: - default: call.accepted - description: 'The type of event: "call.accepted" in this case' - title: Event Type + delete_messages: + enum: + - soft + - pruning + - hard type: string - x-stream-index: "001.001" - user: - $ref: '#/components/schemas/UserResponse' - description: The user who accepted the call - title: User + x-stream-index: "005" + ip_ban: + type: boolean x-stream-index: "004" - required: - - type - - created_at - - call_cid - - call - - user - title: CallAcceptedEvent + reason: + type: string + x-stream-index: "002" + shadow: + type: boolean + x-stream-index: "001" + timeout: + format: int32 + type: integer + x-stream-index: "006" type: object - x-stream-event-call-type: true - x-stream-event-doc-group: ring - x-stream-is-event: true - x-stream-ws-base-event-name: VideoEvent - CallClosedCaption: - description: CallClosedCaption represents a closed caption of a call. + BanOptions: properties: - end_time: - format: date-time - title: The end time of the closed caption. - type: number + duration: + format: int32 + type: integer + x-stream-index: "001" + ip_ban: + type: boolean + x-stream-index: "004" + reason: + type: string + x-stream-index: "002" + shadow_ban: + type: boolean x-stream-index: "003" - speaker_id: - title: The speaker ID of the closed caption. + type: object + BanRequest: + nullable: true + properties: + banned_by: + $ref: '#/components/schemas/UserRequest' + description: Details about the user performing the ban + title: Banned By + x-stream-index: "008" + banned_by_id: + description: ID of the user performing the ban + title: Banned By ID + type: string + x-stream-index: "007" + channel_cid: + description: Channel where the ban applies + title: Channel CID type: string x-stream-index: "004" - start_time: - format: date-time - title: The start time of the closed caption. - type: number - x-stream-index: "002" - text: - title: The text of the closed caption. + delete_messages: + enum: + - soft + - pruning + - hard type: string - x-stream-index: "001" - user: - $ref: '#/components/schemas/UserResponse' - title: The full user for the closed caption. + x-stream-index: "009" + ip_ban: + description: Whether to ban the user's IP address + title: IP Ban + type: boolean + x-stream-index: "006" + reason: + description: Optional explanation for the ban + title: Reason + type: string + x-stream-index: "003" + shadow: + description: Whether this is a shadow ban + title: Shadow + type: boolean x-stream-index: "005" + target_user_id: + description: ID of the user to ban + title: Target User ID + type: string + x-stream-index: "001" + timeout: + description: Duration of the ban in minutes + minimum: 0 + title: Timeout + type: integer + x-stream-index: "002" required: - - text - - start_time - - end_time - - speaker_id - - user - title: CallClosedCaption + - target_user_id type: object - CallClosedCaptionsFailedEvent: - description: This event is sent when call closed captions has failed + BanResponse: + nullable: true properties: - call_cid: - type: string - x-stream-index: "002.001" + banned_by: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "006" + channel: + $ref: '#/components/schemas/ChannelResponse' + x-stream-index: "001" created_at: format: date-time type: number - x-stream-index: "001.002" - type: - default: call.closed_captions_failed - description: 'The type of event: "call.closed_captions_failed" in this case' - title: Event Type + x-stream-index: "007" + expires: + format: date-time + type: number + x-stream-index: "003" + reason: type: string - x-stream-index: "001.001" + x-stream-index: "004" + shadow: + type: boolean + x-stream-index: "005" + user: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "002" required: - - type - created_at - - call_cid - title: CallClosedCaptionsFailedEvent type: object - x-stream-event-call-type: true - x-stream-event-doc-group: transcription - x-stream-is-event: true - x-stream-ws-base-event-name: VideoEvent - CallClosedCaptionsStartedEvent: - description: This event is sent when call closed caption has started + BlockContentOptions: properties: - call_cid: + reason: type: string - x-stream-index: "002.001" + x-stream-index: "001" + type: object + BlockListConfig: + properties: + async: + type: boolean + x-stream-index: "001" + enabled: + type: boolean + x-stream-index: "002" + rules: + items: + $ref: '#/components/schemas/BlockListRule' + maximum: 10 + type: array + x-stream-index: "003" + required: + - enabled + - rules + type: object + BlockListOptions: + properties: + behavior: + description: Blocklist behavior + enum: + - flag + - block + - shadow_block + title: Behavior + type: string + x-stream-index: "002" + blocklist: + description: Blocklist name + title: Blocklist + type: string + x-stream-index: "001" + required: + - blocklist + - behavior + type: object + BlockListResponse: + description: Block list contains restricted words + properties: created_at: + description: Date/time of creation format: date-time + title: Created at type: number - x-stream-index: "001.002" + x-stream-index: "001" + id: + type: string + x-stream-index: "003" + name: + description: Block list name + title: Name + type: string + x-stream-index: "004" + team: + type: string + x-stream-index: "007" type: - default: call.closed_captions_started - description: 'The type of event: "call.closed_captions_started" in this - case' - title: Event Type + description: Block list type. + title: Type type: string - x-stream-index: "001.001" + x-stream-index: "005" + updated_at: + description: Date/time of the last update + format: date-time + title: Updated at + type: number + x-stream-index: "002" + words: + description: List of words to block + items: + type: string + title: Words + type: array + x-stream-index: "006" required: + - name - type - - created_at - - call_cid - title: CallClosedCaptionsStartedEvent + - words + title: Block list type: object - x-stream-event-call-type: true - x-stream-event-doc-group: transcription - x-stream-is-event: true - x-stream-ws-base-event-name: VideoEvent - CallClosedCaptionsStoppedEvent: - description: This event is sent when call closed captions has stopped + x-stream-docs-page-id: block_lists + BlockListRule: properties: - call_cid: + action: + enum: + - flag + - mask_flag + - shadow + - remove + - bounce + - bounce_flag + - bounce_remove type: string - x-stream-index: "002.001" - created_at: - format: date-time - type: number - x-stream-index: "001.002" - type: - default: call.closed_captions_stopped - description: 'The type of event: "call.transcription_stopped" in this case' - title: Event Type + x-stream-index: "003" + name: type: string - x-stream-index: "001.001" + x-stream-index: "001" + team: + type: string + x-stream-index: "002" required: - - type - - created_at - - call_cid - title: CallClosedCaptionsStoppedEvent + - name + - team + - action type: object - x-stream-event-call-type: true - x-stream-event-doc-group: transcription - x-stream-is-event: true - x-stream-ws-base-event-name: VideoEvent - CallCreatedEvent: - description: |- - This event is sent when a call is created. Clients receiving this event should check if the ringing - field is set to true and if so, show the call screen + BlockUserRequest: + description: BlockUserRequest is the payload for blocking a user. + nullable: true properties: - call: - $ref: '#/components/schemas/CallResponse' - description: Call object - title: Call + user_id: + description: the user to block + title: UserID + type: string x-stream-index: "003" - call_cid: + required: + - user_id + title: BlockUserRequest + type: object + BlockUserResponse: + description: BlockUserResponse is the payload for blocking a user. + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration type: string - x-stream-index: "002.001" + x-stream-index: "001.001" + required: + - duration + title: BlockUserResponse + type: object + BlockUsersRequest: + nullable: true + properties: + blocked_user_id: + description: User id to block + title: BlockedUserID + type: string + x-stream-index: "001" + required: + - blocked_user_id + type: object + BlockUsersResponse: + nullable: true + properties: + blocked_by_user_id: + description: User id who blocked another user + title: BlockedByUserID + type: string + x-stream-index: "002" + blocked_user_id: + description: User id who got blocked + title: BlockedUserID + type: string + x-stream-index: "003" created_at: + description: Timestamp when the user was blocked format: date-time + title: CreatedAt type: number - x-stream-index: "001.002" - members: - description: the members added to this call - items: - $ref: '#/components/schemas/MemberResponse' - title: Members - type: array x-stream-index: "004" - type: - default: call.created - description: 'The type of event: "call.created" in this case' - title: Event Type + duration: + description: Duration of the request in milliseconds + title: Duration type: string x-stream-index: "001.001" required: - - type + - duration + - blocked_by_user_id + - blocked_user_id - created_at - - call_cid - - call - - members - title: CallCreatedEvent type: object - x-stream-event-call-type: true - x-stream-event-doc-group: call - x-stream-is-event: true - x-stream-ws-base-event-name: VideoEvent - CallDeletedEvent: - description: This event is sent when a call is deleted. Clients receiving this - event should leave the call screen + BlockedUserEvent: + description: |- + This event is sent to call participants to notify when a user is blocked on a call, clients can use this event to show a notification. + If the user is the current user, the client should leave the call screen as well properties: - call: - $ref: '#/components/schemas/CallResponse' - description: Call object - title: Call - x-stream-index: "003" + blocked_by_user: + $ref: '#/components/schemas/UserResponse' + description: The user that blocked the user, null if the user was blocked + by server-side + title: Blocked by + x-stream-index: "004" call_cid: type: string x-stream-index: "002.001" @@ -1894,477 +2933,637 @@ components: type: number x-stream-index: "001.002" type: - default: call.deleted - description: 'The type of event: "call.deleted" in this case' + default: call.blocked_user + description: 'The type of event: "call.blocked_user" in this case' title: Event Type type: string x-stream-index: "001.001" + user: + $ref: '#/components/schemas/UserResponse' + description: The user that was blocked + title: User + x-stream-index: "003" required: - type - created_at - call_cid - - call - title: CallDeletedEvent + - user + title: BlockedUserEvent type: object x-stream-event-call-type: true x-stream-event-doc-group: call x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallDurationReport: + BlockedUserResponse: + nullable: true properties: - histogram: - items: - $ref: '#/components/schemas/ReportByHistogramBucket' - type: array + blocked_user: + $ref: '#/components/schemas/UserResponse' + description: User who got blocked + title: User + x-stream-index: "003" + blocked_user_id: + description: ID of the user who got blocked + title: UserID + type: string + x-stream-index: "004" + created_at: + format: date-time + type: number + x-stream-index: "005" + user: + $ref: '#/components/schemas/UserResponse' + description: User who blocked another user + title: User x-stream-index: "001" + user_id: + description: ID of the user who blocked another user + title: UserID + type: string + x-stream-index: "002" required: - - histogram + - user + - user_id + - blocked_user + - blocked_user_id + - created_at type: object - CallDurationReportResponse: + BodyguardRule: properties: - daily: + action: + enum: + - flag + - shadow + - remove + - bounce + - bounce_flag + - bounce_remove + type: string + x-stream-index: "002" + label: + type: string + x-stream-index: "001" + severity_rules: items: - $ref: '#/components/schemas/DailyAggregateCallDurationReportResponse' + $ref: '#/components/schemas/BodyguardSeverityRule' type: array - x-stream-index: "001" + x-stream-index: "003" required: - - daily + - label + - action + - severity_rules type: object - CallEgress: - nullable: true + BodyguardSeverityRule: properties: - app_pk: - format: int32 - type: integer - x-stream-index: "002" - call_id: - type: string - x-stream-index: "004" - call_type: - type: string - x-stream-index: "003" - config: - $ref: '#/components/schemas/EgressTaskConfig' - x-stream-index: "007" - egress_id: - type: string - x-stream-index: "005" - egress_type: - type: string - x-stream-index: "006" - instance_ip: + action: + enum: + - flag + - shadow + - remove + - bounce + - bounce_flag + - bounce_remove type: string - x-stream-index: "008" - started_at: - format: date-time - type: number - x-stream-index: "010" - state: + x-stream-index: "002" + severity: + enum: + - low + - medium + - high + - critical type: string - x-stream-index: "009" - stopped_at: + x-stream-index: "001" + required: + - severity + - action + type: object + BookmarkAddedEvent: + description: Emitted when a user bookmarks an activity. + nullable: true + properties: + bookmark: + $ref: '#/components/schemas/BookmarkResponse' + x-stream-index: "001" + created_at: + description: Date/time of creation format: date-time + title: Created at type: number - x-stream-index: "011" - updated_at: + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + received_at: format: date-time type: number - x-stream-index: "012" + x-stream-index: 002.001.004 + type: + default: feeds.bookmark.added + description: 'The type of event: "feeds.bookmark.added" in this case' + title: Event Type + type: string + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who added the bookmark + title: User + x-stream-index: "003.001" required: - - app_pk - - call_type - - call_id - - egress_id - - egress_type - - instance_ip - - state - - started_at - - updated_at + - bookmark + - type + - created_at + - custom + title: BookmarkAddedEvent type: object - CallEndedEvent: - description: This event is sent when a call is mark as ended for all its participants. - Clients receiving this event should leave the call screen + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + BookmarkDeletedEvent: + description: Emitted when a user deletes a bookmark from an activity. + nullable: true properties: - call: - $ref: '#/components/schemas/CallResponse' - x-stream-index: "003" - call_cid: - type: string - x-stream-index: "002.001" + bookmark: + $ref: '#/components/schemas/BookmarkResponse' + x-stream-index: "001" created_at: + description: Date/time of creation format: date-time + title: Created at type: number - x-stream-index: "001.002" - reason: - description: The reason why the call ended, if available - title: CallEndedReason - type: string - x-stream-index: "005" + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 type: - default: call.ended - description: 'The type of event: "call.ended" in this case' + default: feeds.bookmark.deleted + description: 'The type of event: "feeds.bookmark.deleted" in this case' title: Event Type type: string - x-stream-index: "001.001" + x-stream-index: 002.001.002 user: - $ref: '#/components/schemas/UserResponse' - description: The user who ended the call, null if the call was ended by - the server + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who removed the bookmark title: User - x-stream-index: "004" + x-stream-index: "003.001" required: + - bookmark - type - created_at - - call_cid - - call - title: CallEndedEvent + - custom + title: BookmarkDeletedEvent type: object - x-stream-event-call-type: true - x-stream-event-doc-group: call + x-stream-event-client-type: true + x-stream-event-doc-group: other x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallFrameRecordingFailedEvent: - description: This event is sent when frame recording has failed + BookmarkFolderDeletedEvent: + description: Emitted when a bookmark folder is deleted. + nullable: true properties: - call: - $ref: '#/components/schemas/CallResponse' - x-stream-index: "003" - call_cid: - type: string - x-stream-index: "002.001" + bookmark_folder: + $ref: '#/components/schemas/BookmarkFolderResponse' + description: The bookmark folder that was deleted + title: Bookmark Folder + x-stream-index: "001" created_at: + description: Date/time of creation format: date-time + title: Created at type: number - x-stream-index: "001.002" - egress_id: - type: string - x-stream-index: "004" + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 type: - default: call.frame_recording_failed - description: 'The type of event: "call.frame_recording_failed" in this case' + default: feeds.bookmark_folder.deleted + description: 'The type of event: "feeds.bookmark_folder.deleted" in this + case' title: Event Type type: string - x-stream-index: "001.001" + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who deleted the bookmark folder + title: User + x-stream-index: "003.001" required: + - bookmark_folder - type - created_at - - call_cid - - call - - egress_id - title: CallFrameRecordingFailedEvent + - custom + title: BookmarkFolderDeletedEvent type: object - x-stream-event-call-type: true - x-stream-event-doc-group: recording + x-stream-event-client-type: true + x-stream-event-doc-group: other x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallFrameRecordingFrameReadyEvent: - description: This event is sent when a frame is captured from a call + BookmarkFolderResponse: properties: - call_cid: - type: string - x-stream-index: "002.001" - captured_at: - description: The time the frame was captured - format: date-time - title: CapturedAt - type: number - x-stream-index: "006" created_at: + description: When the folder was created format: date-time + title: Created At type: number - x-stream-index: "001.002" - egress_id: + x-stream-index: "004" + custom: + additionalProperties: {} + description: Custom data for the folder + title: Custom Data + type: object + x-stream-index: "003" + id: + description: Unique identifier for the folder + title: ID type: string - x-stream-index: "008" - session_id: - description: Call session ID - title: Session ID - type: string - x-stream-index: "003.001" - track_type: - description: The type of the track frame was captured from (TRACK_TYPE_VIDEO|TRACK_TYPE_SCREEN_SHARE) - title: TrackType - type: string - x-stream-index: "004" - type: - default: call.frame_recording_ready - description: 'The type of event: "call.frame_recording_ready" in this case' - title: Event Type - type: string - x-stream-index: "001.001" - url: - description: The URL of the frame - title: URL + x-stream-index: "001" + name: + description: Name of the folder + title: Name type: string + x-stream-index: "002" + updated_at: + description: When the folder was last updated + format: date-time + title: Updated At + type: number x-stream-index: "005" - users: - additionalProperties: - $ref: '#/components/schemas/UserResponse' - description: The users in the frame - title: Users - type: object - x-stream-index: "007" required: - - type + - id + - name - created_at - - call_cid - - session_id - - track_type - - url - - captured_at - - users - - egress_id - title: CallFrameRecordingFrameReadyEvent + - updated_at + title: Bookmark Folder type: object - x-stream-event-call-type: true - x-stream-event-doc-group: recording - x-stream-is-event: true - x-stream-ws-base-event-name: VideoEvent - CallFrameRecordingStartedEvent: - description: This event is sent when frame recording has started + BookmarkFolderUpdatedEvent: + description: Emitted when a bookmark folder is updated. + nullable: true properties: - call: - $ref: '#/components/schemas/CallResponse' - x-stream-index: "003" - call_cid: - type: string - x-stream-index: "002.001" + bookmark_folder: + $ref: '#/components/schemas/BookmarkFolderResponse' + description: The bookmark folder that was updated + title: Bookmark Folder + x-stream-index: "001" created_at: + description: Date/time of creation format: date-time + title: Created at type: number - x-stream-index: "001.002" - egress_id: - type: string - x-stream-index: "004" + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 type: - default: call.frame_recording_started - description: 'The type of event: "call.frame_recording_started" in this + default: feeds.bookmark_folder.updated + description: 'The type of event: "feeds.bookmark_folder.updated" in this case' title: Event Type type: string - x-stream-index: "001.001" + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who updated the bookmark folder + title: User + x-stream-index: "003.001" required: + - bookmark_folder - type - created_at - - call_cid - - call - - egress_id - title: CallFrameRecordingStartedEvent + - custom + title: BookmarkFolderUpdatedEvent type: object - x-stream-event-call-type: true - x-stream-event-doc-group: recording + x-stream-event-client-type: true + x-stream-event-doc-group: other x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallFrameRecordingStoppedEvent: - description: This event is sent when frame recording has stopped + BookmarkResponse: properties: - call: - $ref: '#/components/schemas/CallResponse' - x-stream-index: "003" - call_cid: - type: string - x-stream-index: "002.001" + activity: + $ref: '#/components/schemas/ActivityResponse' + description: The bookmarked activity + title: Activity + x-stream-index: "002" created_at: + description: When the bookmark was created format: date-time + title: Created At type: number - x-stream-index: "001.002" - egress_id: - type: string + x-stream-index: "005" + custom: + additionalProperties: {} + description: Custom data for the bookmark + title: Custom Data + type: object x-stream-index: "004" - type: - default: call.frame_recording_stopped - description: 'The type of event: "call.frame_recording_stopped" in this - case' - title: Event Type - type: string - x-stream-index: "001.001" - required: - - type - - created_at - - call_cid - - call - - egress_id - title: CallFrameRecordingStoppedEvent - type: object - x-stream-event-call-type: true - x-stream-event-doc-group: recording - x-stream-is-event: true - x-stream-ws-base-event-name: VideoEvent - CallHLSBroadcastingFailedEvent: - description: This event is sent when HLS broadcasting has failed - properties: - call_cid: - type: string - x-stream-index: "002.001" - created_at: + folder: + $ref: '#/components/schemas/BookmarkFolderResponse' + description: Folder containing this bookmark + title: Folder + x-stream-index: "003" + updated_at: + description: When the bookmark was last updated format: date-time + title: Updated At type: number - x-stream-index: "001.002" - type: - default: call.hls_broadcasting_failed - description: 'The type of event: "call.hls_broadcasting_failed" in this - case' - title: Event Type - type: string - x-stream-index: "001.001" + x-stream-index: "006" + user: + $ref: '#/components/schemas/UserResponse' + description: User who created the bookmark + title: User + x-stream-index: "001" required: - - type + - user + - activity - created_at - - call_cid - title: CallHLSBroadcastingFailedEvent + - updated_at + title: Bookmark type: object - x-stream-event-call-type: true - x-stream-event-doc-group: streaming - x-stream-is-event: true - x-stream-ws-base-event-name: VideoEvent - CallHLSBroadcastingStartedEvent: - description: This event is sent when HLS broadcasting has started + BookmarkUpdatedEvent: + description: Emitted when a user updates a bookmark. + nullable: true properties: - call: - $ref: '#/components/schemas/CallResponse' - x-stream-index: "003" - call_cid: - type: string - x-stream-index: "002.001" + bookmark: + $ref: '#/components/schemas/BookmarkResponse' + description: The updated bookmark + title: Bookmark + x-stream-index: "001" created_at: + description: Date/time of creation format: date-time + title: Created at type: number - x-stream-index: "001.002" - hls_playlist_url: - type: string - x-stream-index: "004" + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 type: - default: call.hls_broadcasting_started - description: 'The type of event: "call.hls_broadcasting_started" in this - case' + default: feeds.bookmark.updated + description: 'The type of event: "feeds.bookmark.updated" in this case' title: Event Type type: string - x-stream-index: "001.001" + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who updated the bookmark + title: User + x-stream-index: "003.001" required: + - bookmark - type - created_at - - call_cid - - call - - hls_playlist_url - title: CallHLSBroadcastingStartedEvent + - custom + title: BookmarkUpdatedEvent type: object - x-stream-event-call-type: true - x-stream-event-doc-group: streaming + x-stream-event-client-type: true + x-stream-event-doc-group: other x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallHLSBroadcastingStoppedEvent: - description: This event is sent when HLS broadcasting has stopped + Bound: properties: - call_cid: - type: string - x-stream-index: "002.001" - created_at: - format: date-time + inclusive: + type: boolean + x-stream-index: "002" + value: + format: float type: number - x-stream-index: "001.002" - type: - default: call.hls_broadcasting_stopped - description: 'The type of event: "call.hls_broadcasting_stopped" in this - case' - title: Event Type - type: string - x-stream-index: "001.001" + x-stream-index: "001" required: - - type - - created_at - - call_cid - title: CallHLSBroadcastingStoppedEvent + - value + - inclusive type: object - x-stream-event-call-type: true - x-stream-event-doc-group: streaming - x-stream-is-event: true - x-stream-ws-base-event-name: VideoEvent - CallIngressResponse: - description: CallIngressResponse is the payload for ingress settings + BroadcastSettings: properties: - rtmp: - $ref: '#/components/schemas/RTMPIngress' - title: RTMP + enabled: + type: boolean x-stream-index: "001" + hls: + $ref: '#/components/schemas/HLSSettings' + x-stream-index: "002" + rtmp: + $ref: '#/components/schemas/RTMPSettings' + x-stream-index: "003" required: - - rtmp - title: CallIngressResponse + - enabled type: object - CallLiveStartedEvent: - description: This event is sent when a call is started. Clients receiving this - event should start the call. + BroadcastSettingsRequest: properties: - call: - $ref: '#/components/schemas/CallResponse' - description: Call object - title: Call - x-stream-index: "003" - call_cid: - type: string - x-stream-index: "002.001" - created_at: - format: date-time - type: number - x-stream-index: "001.002" - type: - default: call.live_started - description: 'The type of event: "call.live_started" in this case' - title: Event Type - type: string - x-stream-index: "001.001" + enabled: + type: boolean + x-stream-index: "001" + hls: + $ref: '#/components/schemas/HLSSettingsRequest' + x-stream-index: "002" + rtmp: + $ref: '#/components/schemas/RTMPSettingsRequest' + x-stream-index: "003" + type: object + BroadcastSettingsResponse: + description: BroadcastSettingsResponse is the payload for broadcasting settings + properties: + enabled: + title: Enabled + type: boolean + x-stream-index: "001" + hls: + $ref: '#/components/schemas/HLSSettingsResponse' + title: HLS + x-stream-index: "002" + rtmp: + $ref: '#/components/schemas/RTMPSettingsResponse' + title: RTMP + x-stream-index: "003" required: - - type - - created_at - - call_cid - - call - title: CallLiveStartedEvent + - enabled + - hls + - rtmp + title: BroadcastSettingsResponse type: object - x-stream-event-call-type: true - x-stream-event-doc-group: streaming - x-stream-is-event: true - x-stream-ws-base-event-name: VideoEvent - CallMember: - nullable: true + Call: properties: - created_at: + AppPK: + format: int32 + type: integer + writeOnly: true + x-stream-index: "002" + Backstage: + type: boolean + writeOnly: true + x-stream-index: "023" + BlockedUserIDs: + items: + type: string + type: array + writeOnly: true + x-stream-index: "018" + BlockedUsers: + items: + $ref: '#/components/schemas/User' + type: array + writeOnly: true + x-stream-index: "019" + CID: + type: string + writeOnly: true + x-stream-index: "005" + CallType: + $ref: '#/components/schemas/CallType' + x-stream-index: "020" + ChannelCID: + type: string + writeOnly: true + x-stream-index: "032" + CreatedAt: format: date-time type: number + writeOnly: true + x-stream-index: "013" + CreatedBy: + $ref: '#/components/schemas/User' x-stream-index: "008" - custom: + CreatedByUserID: + type: string + writeOnly: true + x-stream-index: "007" + CurrentSessionID: + type: string + writeOnly: true + x-stream-index: "024" + Custom: additionalProperties: {} type: object - x-stream-index: "007" - deleted_at: + writeOnly: true + x-stream-index: "012" + DeletedAt: format: date-time type: number - x-stream-index: "010" - role: + writeOnly: true + x-stream-index: "028" + EgressUpdatedAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "027" + Egresses: + items: + $ref: '#/components/schemas/CallEgress' + type: array + writeOnly: true + x-stream-index: "015" + EndedAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "017" + ID: type: string - x-stream-index: "006" - updated_at: + writeOnly: true + x-stream-index: "004" + JoinAheadTimeSeconds: + format: int32 + type: integer + writeOnly: true + x-stream-index: "031" + LastHeartbeatAt: format: date-time type: number + writeOnly: true + x-stream-index: "030" + LastSessionID: + type: string + writeOnly: true + x-stream-index: "025" + MemberCount: + format: int32 + type: integer + writeOnly: true + x-stream-index: "010" + MemberLookup: + $ref: '#/components/schemas/MemberLookup' + x-stream-index: "011" + Members: + items: + $ref: '#/components/schemas/CallMember' + type: array + writeOnly: true x-stream-index: "009" - user: - $ref: '#/components/schemas/User' - x-stream-index: "005" - user_id: + Session: + $ref: '#/components/schemas/CallSession' + x-stream-index: "026" + Settings: + $ref: '#/components/schemas/CallSettings' + x-stream-index: "022" + SettingsOverrides: + $ref: '#/components/schemas/CallSettings' + x-stream-index: "021" + StartsAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "016" + Team: type: string - x-stream-index: "004" + writeOnly: true + x-stream-index: "006" + ThumbnailURL: + type: string + writeOnly: true + x-stream-index: "029" + Type: + type: string + writeOnly: true + x-stream-index: "003" + UpdatedAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "014" required: - - user_id - - role - - custom - - created_at - - updated_at + - AppPK + - Type + - ID + - CID + - Team + - CreatedByUserID + - Members + - Custom + - CreatedAt + - UpdatedAt + - Egresses + - BlockedUserIDs + - BlockedUsers + - Backstage + - CurrentSessionID + - LastSessionID + - ThumbnailURL + - ChannelCID type: object - CallMemberAddedEvent: - description: This event is sent when one or more members are added to a call + CallAcceptedEvent: + description: This event is sent when a user accepts a notification to join a + call. properties: call: $ref: '#/components/schemas/CallResponse' - description: Call object - title: Call x-stream-index: "003" call_cid: type: string @@ -2373,146 +3572,75 @@ components: format: date-time type: number x-stream-index: "001.002" - members: - description: the members added to this call - items: - $ref: '#/components/schemas/MemberResponse' - title: Members - type: array - x-stream-index: "004" type: - default: call.member_added - description: 'The type of event: "call.member_added" in this case' + default: call.accepted + description: 'The type of event: "call.accepted" in this case' title: Event Type type: string x-stream-index: "001.001" + user: + $ref: '#/components/schemas/UserResponse' + description: The user who accepted the call + title: User + x-stream-index: "004" required: - type - created_at - call_cid - call - - members - title: CallMemberAddedEvent + - user + title: CallAcceptedEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: call + x-stream-event-doc-group: ring x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallMemberRemovedEvent: - description: This event is sent when one or more members are removed from a - call + CallClosedCaption: + description: CallClosedCaption represents a closed caption of a call. properties: - call: - $ref: '#/components/schemas/CallResponse' - description: Call object - title: Call - x-stream-index: "003" - call_cid: - type: string - x-stream-index: "002.001" - created_at: + end_time: format: date-time + title: The end time of the closed caption. type: number - x-stream-index: "001.002" - members: - description: the list of member IDs removed from the call - items: - type: string - title: Members - type: array - x-stream-index: "004" - type: - default: call.member_removed - description: 'The type of event: "call.member_removed" in this case' - title: Event Type - type: string - x-stream-index: "001.001" - required: - - type - - created_at - - call_cid - - call - - members - title: CallMemberRemovedEvent - type: object - x-stream-event-call-type: true - x-stream-event-doc-group: call - x-stream-is-event: true - x-stream-ws-base-event-name: VideoEvent - CallMemberUpdatedEvent: - description: This event is sent when one or more members are updated - properties: - call: - $ref: '#/components/schemas/CallResponse' - description: Call object - title: Call x-stream-index: "003" - call_cid: + speaker_id: + title: The speaker ID of the closed caption. type: string - x-stream-index: "002.001" - created_at: + x-stream-index: "004" + start_time: format: date-time + title: The start time of the closed caption. type: number - x-stream-index: "001.002" - members: - description: The list of members that were updated - items: - $ref: '#/components/schemas/MemberResponse' - title: Members - type: array - x-stream-index: "004" - type: - default: call.member_updated - description: 'The type of event: "call.member_updated" in this case' - title: Event Type + x-stream-index: "002" + text: + title: The text of the closed caption. type: string - x-stream-index: "001.001" + x-stream-index: "001" + user: + $ref: '#/components/schemas/UserResponse' + title: The full user for the closed caption. + x-stream-index: "005" required: - - type - - created_at - - call_cid - - call - - members - title: CallMemberUpdatedEvent + - text + - start_time + - end_time + - speaker_id + - user + title: CallClosedCaption type: object - x-stream-event-call-type: true - x-stream-event-doc-group: call - x-stream-is-event: true - x-stream-ws-base-event-name: VideoEvent - CallMemberUpdatedPermissionEvent: - description: This event is sent when one or more members get its role updated + CallClosedCaptionsFailedEvent: + description: This event is sent when call closed captions has failed properties: - call: - $ref: '#/components/schemas/CallResponse' - description: Call object - title: Call - x-stream-index: "003" call_cid: type: string x-stream-index: "002.001" - capabilities_by_role: - additionalProperties: - items: - type: string - type: array - description: The capabilities by role for this call - title: CapabilitiesByRole - type: object - x-stream-index: "004" created_at: format: date-time type: number x-stream-index: "001.002" - members: - description: The list of members that were updated - items: - $ref: '#/components/schemas/MemberResponse' - title: Members - type: array - x-stream-index: "005" type: - default: call.member_updated_permission - description: 'The type of event: "call.member_added" in this case' + default: call.closed_captions_failed + description: 'The type of event: "call.closed_captions_failed" in this case' title: Event Type type: string x-stream-index: "001.001" @@ -2520,24 +3648,15 @@ components: - type - created_at - call_cid - - call - - capabilities_by_role - - members - title: CallMemberUpdatedPermissionEvent + title: CallClosedCaptionsFailedEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: call + x-stream-event-doc-group: transcription x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallMissedEvent: - description: This event is sent to call members who did not accept/reject/join - the call to notify they missed the call + CallClosedCaptionsStartedEvent: + description: This event is sent when call closed caption has started properties: - call: - $ref: '#/components/schemas/CallResponse' - description: Call object - title: Call - x-stream-index: "004" call_cid: type: string x-stream-index: "002.001" @@ -2545,48 +3664,25 @@ components: format: date-time type: number x-stream-index: "001.002" - members: - description: List of members who missed the call - items: - $ref: '#/components/schemas/MemberResponse' - title: Members - type: array - x-stream-index: "005" - notify_user: - type: boolean - x-stream-index: "007" - session_id: - description: Call session ID - title: Session ID - type: string - x-stream-index: "003.001" type: - default: call.missed - description: 'The type of event: "call.notification" in this case' + default: call.closed_captions_started + description: 'The type of event: "call.closed_captions_started" in this + case' title: Event Type type: string x-stream-index: "001.001" - user: - $ref: '#/components/schemas/UserResponse' - description: The caller from whom the call was missed - title: User - x-stream-index: "006" required: - type - created_at - call_cid - - session_id - - call - - members - - user - - notify_user - title: CallMissedEvent + title: CallClosedCaptionsStartedEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: ring + x-stream-event-doc-group: transcription x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallModerationBlurEvent: + CallClosedCaptionsStoppedEvent: + description: This event is sent when call closed captions has stopped properties: call_cid: type: string @@ -2595,31 +3691,32 @@ components: format: date-time type: number x-stream-index: "001.002" - custom: - additionalProperties: {} - type: object - x-stream-index: "004" type: - default: call.moderation_blur + default: call.closed_captions_stopped + description: 'The type of event: "call.transcription_stopped" in this case' + title: Event Type type: string x-stream-index: "001.001" - user_id: - type: string - x-stream-index: "003" required: - type - created_at - call_cid - - user_id - - custom - title: CallModerationBlurEvent + title: CallClosedCaptionsStoppedEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: other + x-stream-event-doc-group: transcription x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallModerationWarningEvent: + CallCreatedEvent: + description: |- + This event is sent when a call is created. Clients receiving this event should check if the ringing + field is set to true and if so, show the call screen properties: + call: + $ref: '#/components/schemas/CallResponse' + description: Call object + title: Call + x-stream-index: "003" call_cid: type: string x-stream-index: "002.001" @@ -2627,42 +3724,40 @@ components: format: date-time type: number x-stream-index: "001.002" - custom: - additionalProperties: {} - type: object - x-stream-index: "005" - message: - type: string + members: + description: the members added to this call + items: + $ref: '#/components/schemas/MemberResponse' + title: Members + type: array x-stream-index: "004" type: - default: call.moderation_warning + default: call.created + description: 'The type of event: "call.created" in this case' + title: Event Type type: string x-stream-index: "001.001" - user_id: - type: string - x-stream-index: "003" required: - type - created_at - call_cid - - user_id - - message - - custom - title: CallModerationWarningEvent + - call + - members + title: CallCreatedEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: other + x-stream-event-doc-group: call x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallNotificationEvent: - description: This event is sent to all call members to notify they are getting - called + CallDeletedEvent: + description: This event is sent when a call is deleted. Clients receiving this + event should leave the call screen properties: call: $ref: '#/components/schemas/CallResponse' description: Call object title: Call - x-stream-index: "004" + x-stream-index: "003" call_cid: type: string x-stream-index: "002.001" @@ -2670,150 +3765,24 @@ components: format: date-time type: number x-stream-index: "001.002" - members: - description: Call members - items: - $ref: '#/components/schemas/MemberResponse' - title: Members - type: array - x-stream-index: "005" - session_id: - description: Call session ID - title: Session ID - type: string - x-stream-index: "003.001" type: - default: call.notification - description: 'The type of event: "call.notification" in this case' + default: call.deleted + description: 'The type of event: "call.deleted" in this case' title: Event Type type: string x-stream-index: "001.001" - user: - $ref: '#/components/schemas/UserResponse' - description: The user that sent the call notification - title: User - x-stream-index: "006" required: - type - created_at - call_cid - - session_id - call - - members - - user - title: CallNotificationEvent + title: CallDeletedEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: ring + x-stream-event-doc-group: call x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallParticipant: - nullable: true - properties: - JoinedAt: - format: date-time - type: number - writeOnly: true - x-stream-index: "004" - Role: - type: string - writeOnly: true - x-stream-index: "002" - UserSessionID: - type: string - writeOnly: true - x-stream-index: "003" - avg_response_time: - format: int32 - readOnly: true - type: integer - x-stream-index: "001.046" - ban_expires: - format: date-time - type: number - x-stream-index: "001.017" - banned: - type: boolean - x-stream-index: "001.016" - created_at: - format: date-time - readOnly: true - type: number - x-stream-index: "001.008" - custom: - additionalProperties: {} - type: object - x-stream-index: "001.006" - deactivated_at: - format: date-time - readOnly: true - type: number - x-stream-index: "001.014" - deleted_at: - format: date-time - readOnly: true - type: number - x-stream-index: "001.013" - id: - type: string - x-stream-index: "001.003" - invisible: - type: boolean - x-stream-index: "001.023" - language: - type: string - x-stream-index: "001.035" - last_active: - format: date-time - readOnly: true - type: number - x-stream-index: "001.011" - last_engaged_at: - format: date-time - readOnly: true - type: number - x-stream-index: "001.012" - online: - readOnly: true - type: boolean - x-stream-index: "001.022" - privacy_settings: - $ref: '#/components/schemas/PrivacySettings' - x-stream-index: "001.026" - revoke_tokens_issued_before: - format: date-time - type: number - x-stream-index: "001.042" - role: - type: string - x-stream-index: "001.004" - teams: - items: - type: string - type: array - x-stream-index: "001.036" - teams_role: - additionalProperties: - type: string - type: object - x-stream-index: "001.005" - updated_at: - format: date-time - readOnly: true - type: number - x-stream-index: "001.009" - required: - - id - - role - - teams_role - - custom - - banned - - online - - Role - - UserSessionID - - JoinedAt - type: object - CallParticipantCountReport: + CallDurationReport: properties: histogram: items: @@ -2823,41 +3792,74 @@ components: required: - histogram type: object - CallParticipantCountReportResponse: + CallDurationReportResponse: properties: daily: items: - $ref: '#/components/schemas/DailyAggregateCallParticipantCountReportResponse' + $ref: '#/components/schemas/DailyAggregateCallDurationReportResponse' type: array x-stream-index: "001" required: - daily type: object - CallParticipantResponse: + CallEgress: + nullable: true properties: - joined_at: - format: date-time - type: number + app_pk: + format: int32 + type: integer + x-stream-index: "002" + call_id: + type: string x-stream-index: "004" - role: + call_type: type: string x-stream-index: "003" - user: - $ref: '#/components/schemas/UserResponse' - x-stream-index: "001" - user_session_id: + config: + $ref: '#/components/schemas/EgressTaskConfig' + x-stream-index: "007" + egress_id: type: string - x-stream-index: "002" + x-stream-index: "005" + egress_type: + type: string + x-stream-index: "006" + instance_ip: + type: string + x-stream-index: "008" + started_at: + format: date-time + type: number + x-stream-index: "010" + state: + type: string + x-stream-index: "009" + stopped_at: + format: date-time + type: number + x-stream-index: "011" + updated_at: + format: date-time + type: number + x-stream-index: "012" required: - - user - - user_session_id - - role - - joined_at + - app_pk + - call_type + - call_id + - egress_id + - egress_type + - instance_ip + - state + - started_at + - updated_at type: object - CallReactionEvent: - description: This event is sent when a reaction is sent in a call, clients should - use this to show the reaction in the call screen + CallEndedEvent: + description: This event is sent when a call is mark as ended for all its participants. + Clients receiving this event should leave the call screen properties: + call: + $ref: '#/components/schemas/CallResponse' + x-stream-index: "003" call_cid: type: string x-stream-index: "002.001" @@ -2865,64 +3867,40 @@ components: format: date-time type: number x-stream-index: "001.002" - reaction: - $ref: '#/components/schemas/ReactionResponse' - description: the reaction object sent by the user on the call - title: reaction - x-stream-index: "003" + reason: + description: The reason why the call ended, if available + title: CallEndedReason + type: string + x-stream-index: "005" type: - default: call.reaction_new - description: 'The type of event: "call.reaction_new" in this case' + default: call.ended + description: 'The type of event: "call.ended" in this case' title: Event Type type: string x-stream-index: "001.001" + user: + $ref: '#/components/schemas/UserResponse' + description: The user who ended the call, null if the call was ended by + the server + title: User + x-stream-index: "004" required: - type - created_at - call_cid - - reaction - title: CallReactionEvent + - call + title: CallEndedEvent type: object x-stream-event-call-type: true x-stream-event-doc-group: call x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallRecording: - description: CallRecording represents a recording of a call. + CallFrameRecordingFailedEvent: + description: This event is sent when frame recording has failed properties: - end_time: - format: date-time - title: The end time of the recording. - type: number - x-stream-index: "004" - filename: - title: The filename of the recording. - type: string - x-stream-index: "001" - session_id: - title: The session ID of the recording. - type: string - x-stream-index: "005" - start_time: - format: date-time - title: The start time of the recording. - type: number + call: + $ref: '#/components/schemas/CallResponse' x-stream-index: "003" - url: - title: The URL of the recording. - type: string - x-stream-index: "002" - required: - - filename - - url - - start_time - - end_time - - session_id - title: CallRecording - type: object - CallRecordingFailedEvent: - description: This event is sent when call recording has failed - properties: call_cid: type: string x-stream-index: "002.001" @@ -2932,10 +3910,10 @@ components: x-stream-index: "001.002" egress_id: type: string - x-stream-index: "003" + x-stream-index: "004" type: - default: call.recording_failed - description: 'The type of event: "call.recording_failed" in this case' + default: call.frame_recording_failed + description: 'The type of event: "call.frame_recording_failed" in this case' title: Event Type type: string x-stream-index: "001.001" @@ -2943,112 +3921,176 @@ components: - type - created_at - call_cid + - call - egress_id - title: CallRecordingFailedEvent + title: CallFrameRecordingFailedEvent type: object x-stream-event-call-type: true x-stream-event-doc-group: recording x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallRecordingReadyEvent: - description: This event is sent when call recording is ready + CallFrameRecordingFrameReadyEvent: + description: This event is sent when a frame is captured from a call properties: call_cid: type: string x-stream-index: "002.001" - call_recording: - $ref: '#/components/schemas/CallRecording' - description: The call recording object - title: CallRecording - x-stream-index: "003" - created_at: + captured_at: + description: The time the frame was captured + format: date-time + title: CapturedAt + type: number + x-stream-index: "006" + created_at: format: date-time type: number x-stream-index: "001.002" egress_id: + type: string + x-stream-index: "008" + session_id: + description: Call session ID + title: Session ID + type: string + x-stream-index: "003.001" + track_type: + description: The type of the track frame was captured from (TRACK_TYPE_VIDEO|TRACK_TYPE_SCREEN_SHARE) + title: TrackType type: string x-stream-index: "004" type: - default: call.recording_ready - description: 'The type of event: "call.recording_ready" in this case' + default: call.frame_recording_ready + description: 'The type of event: "call.frame_recording_ready" in this case' title: Event Type type: string x-stream-index: "001.001" + url: + description: The URL of the frame + title: URL + type: string + x-stream-index: "005" + users: + additionalProperties: + $ref: '#/components/schemas/UserResponse' + description: The users in the frame + title: Users + type: object + x-stream-index: "007" required: - type - created_at - call_cid - - call_recording + - session_id + - track_type + - url + - captured_at + - users - egress_id - title: CallRecordingReadyEvent + title: CallFrameRecordingFrameReadyEvent type: object x-stream-event-call-type: true x-stream-event-doc-group: recording x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallRecordingStartedEvent: - description: This event is sent when call recording has started + CallFrameRecordingStartedEvent: + description: This event is sent when frame recording has started properties: + call: + $ref: '#/components/schemas/CallResponse' + x-stream-index: "003" call_cid: type: string - x-stream-index: "003.001" + x-stream-index: "002.001" created_at: format: date-time type: number - x-stream-index: "002.002" + x-stream-index: "001.002" egress_id: type: string - x-stream-index: "001" + x-stream-index: "004" type: - default: call.recording_started - description: 'The type of event: "call.recording_started" in this case' + default: call.frame_recording_started + description: 'The type of event: "call.frame_recording_started" in this + case' title: Event Type type: string - x-stream-index: "002.001" + x-stream-index: "001.001" required: - - egress_id - type - created_at - call_cid - title: CallRecordingStartedEvent + - call + - egress_id + title: CallFrameRecordingStartedEvent type: object x-stream-event-call-type: true x-stream-event-doc-group: recording x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallRecordingStoppedEvent: - description: This event is sent when call recording has stopped + CallFrameRecordingStoppedEvent: + description: This event is sent when frame recording has stopped properties: + call: + $ref: '#/components/schemas/CallResponse' + x-stream-index: "003" call_cid: type: string - x-stream-index: "003.001" + x-stream-index: "002.001" created_at: format: date-time type: number - x-stream-index: "002.002" + x-stream-index: "001.002" egress_id: type: string - x-stream-index: "001" + x-stream-index: "004" type: - default: call.recording_stopped - description: 'The type of event: "call.recording_stopped" in this case' + default: call.frame_recording_stopped + description: 'The type of event: "call.frame_recording_stopped" in this + case' title: Event Type type: string - x-stream-index: "002.001" + x-stream-index: "001.001" required: - - egress_id - type - created_at - call_cid - title: CallRecordingStoppedEvent + - call + - egress_id + title: CallFrameRecordingStoppedEvent type: object x-stream-event-call-type: true x-stream-event-doc-group: recording x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallRejectedEvent: - description: This event is sent when a user rejects a notification to join a - call. + CallHLSBroadcastingFailedEvent: + description: This event is sent when HLS broadcasting has failed + properties: + call_cid: + type: string + x-stream-index: "002.001" + created_at: + format: date-time + type: number + x-stream-index: "001.002" + type: + default: call.hls_broadcasting_failed + description: 'The type of event: "call.hls_broadcasting_failed" in this + case' + title: Event Type + type: string + x-stream-index: "001.001" + required: + - type + - created_at + - call_cid + title: CallHLSBroadcastingFailedEvent + type: object + x-stream-event-call-type: true + x-stream-event-doc-group: streaming + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + CallHLSBroadcastingStartedEvent: + description: This event is sent when HLS broadcasting has started properties: call: $ref: '#/components/schemas/CallResponse' @@ -3060,210 +4102,142 @@ components: format: date-time type: number x-stream-index: "001.002" - reason: - description: 'Provides information about why the call was rejected. You - can provide any value, but the Stream API and SDKs use these default values: - rejected, cancel, timeout and busy' - title: Reason + hls_playlist_url: type: string - x-stream-index: "005" + x-stream-index: "004" type: - default: call.rejected - description: 'The type of event: "call.rejected" in this case' + default: call.hls_broadcasting_started + description: 'The type of event: "call.hls_broadcasting_started" in this + case' title: Event Type type: string x-stream-index: "001.001" - user: - $ref: '#/components/schemas/UserResponse' - description: The user who rejected the call - title: User - x-stream-index: "004" required: - type - created_at - call_cid - call - - user - title: CallRejectedEvent + - hls_playlist_url + title: CallHLSBroadcastingStartedEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: ring + x-stream-event-doc-group: streaming x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallReportResponse: + CallHLSBroadcastingStoppedEvent: + description: This event is sent when HLS broadcasting has stopped properties: - ended_at: + call_cid: + type: string + x-stream-index: "002.001" + created_at: format: date-time type: number - x-stream-index: "003" - score: - format: float - type: number + x-stream-index: "001.002" + type: + default: call.hls_broadcasting_stopped + description: 'The type of event: "call.hls_broadcasting_stopped" in this + case' + title: Event Type + type: string + x-stream-index: "001.001" + required: + - type + - created_at + - call_cid + title: CallHLSBroadcastingStoppedEvent + type: object + x-stream-event-call-type: true + x-stream-event-doc-group: streaming + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + CallIngressResponse: + description: CallIngressResponse is the payload for ingress settings + properties: + rtmp: + $ref: '#/components/schemas/RTMPIngress' + title: RTMP x-stream-index: "001" - started_at: + required: + - rtmp + title: CallIngressResponse + type: object + CallLiveStartedEvent: + description: This event is sent when a call is started. Clients receiving this + event should start the call. + properties: + call: + $ref: '#/components/schemas/CallResponse' + description: Call object + title: Call + x-stream-index: "003" + call_cid: + type: string + x-stream-index: "002.001" + created_at: format: date-time type: number - x-stream-index: "002" + x-stream-index: "001.002" + type: + default: call.live_started + description: 'The type of event: "call.live_started" in this case' + title: Event Type + type: string + x-stream-index: "001.001" required: - - score + - type + - created_at + - call_cid + - call + title: CallLiveStartedEvent type: object - CallRequest: - description: CallRequest is the payload for creating a call. + x-stream-event-call-type: true + x-stream-event-doc-group: streaming + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + CallMember: + nullable: true properties: - channel_cid: - type: string - x-stream-index: "009" + created_at: + format: date-time + type: number + x-stream-index: "008" custom: additionalProperties: {} type: object - x-stream-index: "004" - members: - items: - $ref: '#/components/schemas/MemberRequest' - maximum: 100 - type: array - x-stream-index: "005" - settings_override: - $ref: '#/components/schemas/CallSettingsRequest' + x-stream-index: "007" + deleted_at: + format: date-time + type: number + x-stream-index: "010" + role: + type: string x-stream-index: "006" - starts_at: + updated_at: format: date-time type: number - x-stream-index: "007" - team: - type: string - x-stream-index: "001" - video: - type: boolean - x-stream-index: "008" - title: CallRequest - type: object - CallResponse: - description: Represents a call - properties: - backstage: - type: boolean - x-stream-index: "016" - blocked_user_ids: - items: - type: string - type: array - x-stream-index: "018" - captioning: - type: boolean - x-stream-index: "013" - channel_cid: - type: string - x-stream-index: "024" - cid: - description: The unique identifier for a call (:) - title: CID + x-stream-index: "009" + user: + $ref: '#/components/schemas/User' + x-stream-index: "005" + user_id: type: string x-stream-index: "004" - created_at: - description: Date/time of creation - format: date-time - title: Created at - type: number - x-stream-index: "009" - created_by: - $ref: '#/components/schemas/UserResponse' - description: The user that created the call - title: Created By - x-stream-index: "007" - current_session_id: - type: string - x-stream-index: "005" - custom: - additionalProperties: {} - description: Custom data for this object - title: Custom data - type: object - x-stream-index: "008" - egress: - $ref: '#/components/schemas/EgressResponse' - x-stream-index: "021" - ended_at: - description: Date/time when the call ended - format: date-time - title: Ended At - type: number - x-stream-index: "014" - id: - description: Call ID - title: ID - type: string - x-stream-index: "003" - ingress: - $ref: '#/components/schemas/CallIngressResponse' - x-stream-index: "019" - join_ahead_time_seconds: - format: int32 - type: integer - x-stream-index: "023" - recording: - type: boolean - x-stream-index: "011" - session: - $ref: '#/components/schemas/CallSessionResponse' - x-stream-index: "020" - settings: - $ref: '#/components/schemas/CallSettingsResponse' - x-stream-index: "017" - starts_at: - description: Date/time when the call will start - format: date-time - title: Starts At - type: number - x-stream-index: "015" - team: - type: string - x-stream-index: "006" - thumbnails: - $ref: '#/components/schemas/ThumbnailResponse' - x-stream-index: "022" - transcribing: - type: boolean - x-stream-index: "012" - type: - description: The type of call - title: Type - type: string - x-stream-index: "002" - updated_at: - description: Date/time of the last update - format: date-time - title: Updated at - type: number - x-stream-index: "010" required: - - type - - id - - cid - - current_session_id - - created_by + - user_id + - role - custom - created_at - updated_at - - recording - - transcribing - - captioning - - backstage - - settings - - blocked_user_ids - - ingress - - egress - title: CallResponse type: object - CallRingEvent: - description: This event is sent to all call members to notify they are getting - called + CallMemberAddedEvent: + description: This event is sent when one or more members are added to a call properties: call: $ref: '#/components/schemas/CallResponse' description: Call object title: Call - x-stream-index: "005" + x-stream-index: "003" call_cid: type: string x-stream-index: "002.001" @@ -3272,68 +4246,56 @@ components: type: number x-stream-index: "001.002" members: - description: Call members + description: the members added to this call items: $ref: '#/components/schemas/MemberResponse' title: Members type: array - x-stream-index: "006" - session_id: - description: Call session ID - title: Session ID - type: string - x-stream-index: "003.001" + x-stream-index: "004" type: - default: call.ring - description: 'The type of event: "call.notification" in this case' + default: call.member_added + description: 'The type of event: "call.member_added" in this case' title: Event Type type: string x-stream-index: "001.001" - user: - $ref: '#/components/schemas/UserResponse' - description: The user that sent the call notification - title: User - x-stream-index: "007" - video: - type: boolean - x-stream-index: "008" required: - type - created_at - call_cid - - session_id - call - members - - user - - video - title: CallRingEvent + title: CallMemberAddedEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: ring + x-stream-event-doc-group: call x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallRtmpBroadcastFailedEvent: - description: This event is sent when a call RTMP broadcast has failed + CallMemberRemovedEvent: + description: This event is sent when one or more members are removed from a + call properties: + call: + $ref: '#/components/schemas/CallResponse' + description: Call object + title: Call + x-stream-index: "003" call_cid: - description: The unique identifier for a call (:) - title: CID type: string x-stream-index: "002.001" created_at: - description: Date/time of creation format: date-time - title: Created at type: number x-stream-index: "001.002" - name: - description: Name of the given RTMP broadcast - title: Name - type: string - x-stream-index: "003" + members: + description: the list of member IDs removed from the call + items: + type: string + title: Members + type: array + x-stream-index: "004" type: - default: call.rtmp_broadcast_failed - description: 'The type of event: "call.rtmp_broadcast_failed" in this case' + default: call.member_removed + description: 'The type of event: "call.member_removed" in this case' title: Event Type type: string x-stream-index: "001.001" @@ -3341,35 +4303,39 @@ components: - type - created_at - call_cid - - name - title: CallRtmpBroadcastFailedEvent + - call + - members + title: CallMemberRemovedEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: streaming + x-stream-event-doc-group: call x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallRtmpBroadcastStartedEvent: - description: This event is sent when RTMP broadcast has started + CallMemberUpdatedEvent: + description: This event is sent when one or more members are updated properties: + call: + $ref: '#/components/schemas/CallResponse' + description: Call object + title: Call + x-stream-index: "003" call_cid: - description: The unique identifier for a call (:) - title: CID type: string x-stream-index: "002.001" created_at: - description: Date/time of creation format: date-time - title: Created at type: number x-stream-index: "001.002" - name: - description: Name of the given RTMP broadcast - title: Name - type: string - x-stream-index: "003" + members: + description: The list of members that were updated + items: + $ref: '#/components/schemas/MemberResponse' + title: Members + type: array + x-stream-index: "004" type: - default: call.rtmp_broadcast_started - description: 'The type of event: "call.rtmp_broadcast_started" in this case' + default: call.member_updated + description: 'The type of event: "call.member_updated" in this case' title: Event Type type: string x-stream-index: "001.001" @@ -3377,35 +4343,48 @@ components: - type - created_at - call_cid - - name - title: CallRtmpBroadcastStartedEvent + - call + - members + title: CallMemberUpdatedEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: streaming + x-stream-event-doc-group: call x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallRtmpBroadcastStoppedEvent: - description: This event is sent when RTMP broadcast has stopped + CallMemberUpdatedPermissionEvent: + description: This event is sent when one or more members get its role updated properties: + call: + $ref: '#/components/schemas/CallResponse' + description: Call object + title: Call + x-stream-index: "003" call_cid: - description: The unique identifier for a call (:) - title: CID type: string x-stream-index: "002.001" + capabilities_by_role: + additionalProperties: + items: + type: string + type: array + description: The capabilities by role for this call + title: CapabilitiesByRole + type: object + x-stream-index: "004" created_at: - description: Date/time of creation format: date-time - title: Created at type: number x-stream-index: "001.002" - name: - description: Name of the given RTMP broadcast - title: Name - type: string - x-stream-index: "003" - type: - default: call.rtmp_broadcast_stopped - description: 'The type of event: "call.rtmp_broadcast_stopped" in this case' + members: + description: The list of members that were updated + items: + $ref: '#/components/schemas/MemberResponse' + title: Members + type: array + x-stream-index: "005" + type: + default: call.member_updated_permission + description: 'The type of event: "call.member_added" in this case' title: Event Type type: string x-stream-index: "001.001" @@ -3413,149 +4392,18 @@ components: - type - created_at - call_cid - - name - title: CallRtmpBroadcastStoppedEvent + - call + - capabilities_by_role + - members + title: CallMemberUpdatedPermissionEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: streaming + x-stream-event-doc-group: call x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallSession: - properties: - AcceptedBy: - additionalProperties: - format: date-time - type: number - type: object - writeOnly: true - x-stream-index: "008" - ActiveSFUs: - items: - $ref: '#/components/schemas/SFUIDLastSeen' - type: array - writeOnly: true - x-stream-index: "016" - AnonymousParticipantCount: - format: int32 - type: integer - writeOnly: true - x-stream-index: "019" - AppPK: - format: int32 - type: integer - writeOnly: true - x-stream-index: "002.001" - CallID: - type: string - writeOnly: true - x-stream-index: "002.003" - CallType: - type: string - writeOnly: true - x-stream-index: "002.002" - CreatedAt: - format: date-time - type: number - writeOnly: true - x-stream-index: "003" - DeletedAt: - format: date-time - type: number - writeOnly: true - x-stream-index: "004" - EndedAt: - format: date-time - type: number - writeOnly: true - x-stream-index: "006" - LiveEndedAt: - format: date-time - type: number - writeOnly: true - x-stream-index: "013" - LiveStartedAt: - format: date-time - type: number - writeOnly: true - x-stream-index: "012" - MissedBy: - additionalProperties: - format: date-time - type: number - type: object - writeOnly: true - x-stream-index: "010" - Participants: - items: - $ref: '#/components/schemas/CallParticipant' - type: array - writeOnly: true - x-stream-index: "011" - ParticipantsCountByRole: - additionalProperties: - format: int32 - type: integer - type: object - writeOnly: true - x-stream-index: "018" - RejectedBy: - additionalProperties: - format: date-time - type: number - type: object - writeOnly: true - x-stream-index: "009" - RingAt: - format: date-time - type: number - writeOnly: true - x-stream-index: "007" - SFUIDs: - items: - type: string - type: array - writeOnly: true - x-stream-index: "015" - SessionID: - type: string - writeOnly: true - x-stream-index: "002.004" - StartedAt: - format: date-time - type: number - writeOnly: true - x-stream-index: "005" - TimerEndsAt: - format: date-time - type: number - writeOnly: true - x-stream-index: "014" - UserPermissionOverrides: - additionalProperties: - additionalProperties: - type: boolean - type: object - type: object - writeOnly: true - x-stream-index: "017" - required: - - AppPK - - CallType - - CallID - - SessionID - - CreatedAt - - AcceptedBy - - RejectedBy - - MissedBy - - Participants - - SFUIDs - - ActiveSFUs - - UserPermissionOverrides - - ParticipantsCountByRole - - AnonymousParticipantCount - type: object - CallSessionEndedEvent: - description: This event is sent when a call session ends + CallMissedEvent: + description: This event is sent to call members who did not accept/reject/join + the call to notify they missed the call properties: call: $ref: '#/components/schemas/CallResponse' @@ -3569,37 +4417,49 @@ components: format: date-time type: number x-stream-index: "001.002" + members: + description: List of members who missed the call + items: + $ref: '#/components/schemas/MemberResponse' + title: Members + type: array + x-stream-index: "005" + notify_user: + type: boolean + x-stream-index: "007" session_id: description: Call session ID title: Session ID type: string x-stream-index: "003.001" type: - default: call.session_ended - description: 'The type of event: "call.session_ended" in this case' + default: call.missed + description: 'The type of event: "call.notification" in this case' title: Event Type type: string x-stream-index: "001.001" + user: + $ref: '#/components/schemas/UserResponse' + description: The caller from whom the call was missed + title: User + x-stream-index: "006" required: - type - created_at - call_cid - session_id - call - title: CallSessionEndedEvent + - members + - user + - notify_user + title: CallMissedEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: session + x-stream-event-doc-group: ring x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallSessionParticipantCountsUpdatedEvent: - description: This event is sent when the participant counts in a call session - are updated + CallModerationBlurEvent: properties: - anonymous_participant_count: - format: int32 - type: integer - x-stream-index: "005" call_cid: type: string x-stream-index: "002.001" @@ -3607,39 +4467,30 @@ components: format: date-time type: number x-stream-index: "001.002" - participants_count_by_role: - additionalProperties: - format: int32 - type: integer + custom: + additionalProperties: {} type: object x-stream-index: "004" - session_id: - description: Call session ID - title: Session ID - type: string - x-stream-index: "003.001" type: - default: call.session_participant_count_updated - description: 'The type of event: "call.session_participant_count_updated" - in this case' - title: Event Type + default: call.moderation_blur type: string x-stream-index: "001.001" + user_id: + type: string + x-stream-index: "003" required: - type - created_at - call_cid - - session_id - - participants_count_by_role - - anonymous_participant_count - title: CallSessionParticipantCountsUpdatedEvent + - user_id + - custom + title: CallModerationBlurEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: session + x-stream-event-doc-group: other x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallSessionParticipantJoinedEvent: - description: This event is sent when a participant joins a call session + CallModerationWarningEvent: properties: call_cid: type: string @@ -3648,38 +4499,42 @@ components: format: date-time type: number x-stream-index: "001.002" - participant: - $ref: '#/components/schemas/CallParticipantResponse' - description: The participant that joined the session - title: Participant - x-stream-index: "004" - session_id: - description: Call session ID - title: Session ID + custom: + additionalProperties: {} + type: object + x-stream-index: "005" + message: type: string - x-stream-index: "003.001" + x-stream-index: "004" type: - default: call.session_participant_joined - description: 'The type of event: "call.session_participant_joined" in this - case' - title: Event Type + default: call.moderation_warning type: string x-stream-index: "001.001" + user_id: + type: string + x-stream-index: "003" required: - type - created_at - call_cid - - session_id - - participant - title: CallSessionParticipantJoinedEvent + - user_id + - message + - custom + title: CallModerationWarningEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: session + x-stream-event-doc-group: other x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallSessionParticipantLeftEvent: - description: This event is sent when a participant leaves a call session + CallNotificationEvent: + description: This event is sent to all call members to notify they are getting + called properties: + call: + $ref: '#/components/schemas/CallResponse' + description: Call object + title: Call + x-stream-index: "004" call_cid: type: string x-stream-index: "002.001" @@ -3687,117 +4542,194 @@ components: format: date-time type: number x-stream-index: "001.002" - duration_seconds: - description: The duration participant was in the session in seconds - format: int32 - title: Duration - type: integer + members: + description: Call members + items: + $ref: '#/components/schemas/MemberResponse' + title: Members + type: array x-stream-index: "005" - participant: - $ref: '#/components/schemas/CallParticipantResponse' - description: The participant that left the session - title: Participant - x-stream-index: "004" session_id: description: Call session ID title: Session ID type: string x-stream-index: "003.001" type: - default: call.session_participant_left - description: 'The type of event: "call.session_participant_left" in this - case' + default: call.notification + description: 'The type of event: "call.notification" in this case' title: Event Type type: string x-stream-index: "001.001" + user: + $ref: '#/components/schemas/UserResponse' + description: The user that sent the call notification + title: User + x-stream-index: "006" required: - type - created_at - call_cid - session_id - - participant - - duration_seconds - title: CallSessionParticipantLeftEvent + - call + - members + - user + title: CallNotificationEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: session + x-stream-event-doc-group: ring x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallSessionResponse: + CallParticipant: + nullable: true properties: - accepted_by: - additionalProperties: - format: date-time - type: number - type: object - x-stream-index: "008" - anonymous_participant_count: + JoinedAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "004" + Role: + type: string + writeOnly: true + x-stream-index: "002" + UserSessionID: + type: string + writeOnly: true + x-stream-index: "003" + avg_response_time: format: int32 + readOnly: true type: integer - x-stream-index: "006" - ended_at: + x-stream-index: "001.046" + ban_expires: format: date-time type: number - x-stream-index: "003" + x-stream-index: "001.017" + banned: + type: boolean + x-stream-index: "001.016" + created_at: + format: date-time + readOnly: true + type: number + x-stream-index: "001.008" + custom: + additionalProperties: {} + type: object + x-stream-index: "001.006" + deactivated_at: + format: date-time + readOnly: true + type: number + x-stream-index: "001.014" + deleted_at: + format: date-time + readOnly: true + type: number + x-stream-index: "001.013" id: type: string - x-stream-index: "001" - live_ended_at: + x-stream-index: "001.003" + invisible: + type: boolean + x-stream-index: "001.023" + language: + type: string + x-stream-index: "001.035" + last_active: format: date-time + readOnly: true type: number - x-stream-index: "011" - live_started_at: + x-stream-index: "001.011" + last_engaged_at: format: date-time + readOnly: true type: number - x-stream-index: "010" - missed_by: - additionalProperties: - format: date-time - type: number - type: object - x-stream-index: "009" - participants: + x-stream-index: "001.012" + online: + readOnly: true + type: boolean + x-stream-index: "001.022" + privacy_settings: + $ref: '#/components/schemas/PrivacySettings' + x-stream-index: "001.026" + revoke_tokens_issued_before: + format: date-time + type: number + x-stream-index: "001.042" + role: + type: string + x-stream-index: "001.004" + teams: items: - $ref: '#/components/schemas/CallParticipantResponse' + type: string type: array - x-stream-index: "004" - participants_count_by_role: - additionalProperties: - format: int32 - type: integer - type: object - x-stream-index: "005" - rejected_by: + x-stream-index: "001.036" + teams_role: additionalProperties: - format: date-time - type: number + type: string type: object - x-stream-index: "007" - started_at: - format: date-time - type: number - x-stream-index: "002" - timer_ends_at: + x-stream-index: "001.005" + updated_at: format: date-time + readOnly: true type: number - x-stream-index: "012" + x-stream-index: "001.009" required: - id - - participants - - participants_count_by_role - - anonymous_participant_count - - rejected_by - - accepted_by - - missed_by + - role + - teams_role + - custom + - banned + - online + - Role + - UserSessionID + - JoinedAt type: object - CallSessionStartedEvent: - description: This event is sent when a call session starts + CallParticipantCountReport: properties: - call: - $ref: '#/components/schemas/CallResponse' - description: Call object - title: Call + histogram: + items: + $ref: '#/components/schemas/ReportByHistogramBucket' + type: array + x-stream-index: "001" + required: + - histogram + type: object + CallParticipantCountReportResponse: + properties: + daily: + items: + $ref: '#/components/schemas/DailyAggregateCallParticipantCountReportResponse' + type: array + x-stream-index: "001" + required: + - daily + type: object + CallParticipantResponse: + properties: + joined_at: + format: date-time + type: number x-stream-index: "004" + role: + type: string + x-stream-index: "003" + user: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "001" + user_session_id: + type: string + x-stream-index: "002" + required: + - user + - user_session_id + - role + - joined_at + type: object + CallReactionEvent: + description: This event is sent when a reaction is sent in a call, clients should + use this to show the reaction in the call screen + properties: call_cid: type: string x-stream-index: "002.001" @@ -3805,14 +4737,14 @@ components: format: date-time type: number x-stream-index: "001.002" - session_id: - description: Call session ID - title: Session ID - type: string - x-stream-index: "003.001" + reaction: + $ref: '#/components/schemas/ReactionResponse' + description: the reaction object sent by the user on the call + title: reaction + x-stream-index: "003" type: - default: call.session_started - description: 'The type of event: "call.session_started" in this case' + default: call.reaction_new + description: 'The type of event: "call.reaction_new" in this case' title: Event Type type: string x-stream-index: "001.001" @@ -3820,211 +4752,97 @@ components: - type - created_at - call_cid - - session_id - - call - title: CallSessionStartedEvent + - reaction + title: CallReactionEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: session + x-stream-event-doc-group: call x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallSettings: + CallRecording: + description: CallRecording represents a recording of a call. properties: - audio: - $ref: '#/components/schemas/AudioSettings' - x-stream-index: "001" - backstage: - $ref: '#/components/schemas/BackstageSettings' - x-stream-index: "002" - broadcasting: - $ref: '#/components/schemas/BroadcastSettings' - x-stream-index: "007" - frame_recording: - $ref: '#/components/schemas/FrameRecordSettings' - x-stream-index: "006" - geofencing: - $ref: '#/components/schemas/GeofenceSettings' - x-stream-index: "008" - ingress: - $ref: '#/components/schemas/IngressSettings' - x-stream-index: "014" - limits: - $ref: '#/components/schemas/LimitsSettings' - x-stream-index: "012" - recording: - $ref: '#/components/schemas/RecordSettings' - x-stream-index: "005" - ring: - $ref: '#/components/schemas/RingSettings' - x-stream-index: "010" - screensharing: - $ref: '#/components/schemas/ScreensharingSettings' + end_time: + format: date-time + title: The end time of the recording. + type: number x-stream-index: "004" - session: - $ref: '#/components/schemas/SessionSettings' - x-stream-index: "013" - thumbnails: - $ref: '#/components/schemas/ThumbnailsSettings' - x-stream-index: "011" - transcription: - $ref: '#/components/schemas/TranscriptionSettings' - x-stream-index: "009" - video: - $ref: '#/components/schemas/VideoSettings' - x-stream-index: "003" - type: object - CallSettingsRequest: - properties: - audio: - $ref: '#/components/schemas/AudioSettingsRequest' + filename: + title: The filename of the recording. + type: string x-stream-index: "001" - backstage: - $ref: '#/components/schemas/BackstageSettingsRequest' - x-stream-index: "002" - broadcasting: - $ref: '#/components/schemas/BroadcastSettingsRequest' - x-stream-index: "010" - frame_recording: - $ref: '#/components/schemas/FrameRecordingSettingsRequest' - x-stream-index: "006" - geofencing: - $ref: '#/components/schemas/GeofenceSettingsRequest' - x-stream-index: "003" - ingress: - $ref: '#/components/schemas/IngressSettingsRequest' - x-stream-index: "014" - limits: - $ref: '#/components/schemas/LimitsSettingsRequest' - x-stream-index: "012" - recording: - $ref: '#/components/schemas/RecordSettingsRequest' + session_id: + title: The session ID of the recording. + type: string x-stream-index: "005" - ring: - $ref: '#/components/schemas/RingSettingsRequest' - x-stream-index: "007" - screensharing: - $ref: '#/components/schemas/ScreensharingSettingsRequest' - x-stream-index: "008" - session: - $ref: '#/components/schemas/SessionSettingsRequest' - x-stream-index: "013" - thumbnails: - $ref: '#/components/schemas/ThumbnailsSettingsRequest' - x-stream-index: "011" - transcription: - $ref: '#/components/schemas/TranscriptionSettingsRequest' - x-stream-index: "009" - video: - $ref: '#/components/schemas/VideoSettingsRequest' - x-stream-index: "004" - type: object - CallSettingsResponse: - properties: - audio: - $ref: '#/components/schemas/AudioSettingsResponse' - x-stream-index: "001" - backstage: - $ref: '#/components/schemas/BackstageSettingsResponse' - x-stream-index: "002" - broadcasting: - $ref: '#/components/schemas/BroadcastSettingsResponse' + start_time: + format: date-time + title: The start time of the recording. + type: number x-stream-index: "003" - frame_recording: - $ref: '#/components/schemas/FrameRecordingSettingsResponse' - x-stream-index: "006" - geofencing: - $ref: '#/components/schemas/GeofenceSettingsResponse' - x-stream-index: "004" - ingress: - $ref: '#/components/schemas/IngressSettingsResponse' - x-stream-index: "014" - limits: - $ref: '#/components/schemas/LimitsSettingsResponse' - x-stream-index: "012" - recording: - $ref: '#/components/schemas/RecordSettingsResponse' - x-stream-index: "005" - ring: - $ref: '#/components/schemas/RingSettingsResponse' - x-stream-index: "007" - screensharing: - $ref: '#/components/schemas/ScreensharingSettingsResponse' - x-stream-index: "008" - session: - $ref: '#/components/schemas/SessionSettingsResponse' - x-stream-index: "013" - thumbnails: - $ref: '#/components/schemas/ThumbnailsSettingsResponse' - x-stream-index: "011" - transcription: - $ref: '#/components/schemas/TranscriptionSettingsResponse' - x-stream-index: "009" - video: - $ref: '#/components/schemas/VideoSettingsResponse' - x-stream-index: "010" + url: + title: The URL of the recording. + type: string + x-stream-index: "002" required: - - audio - - backstage - - broadcasting - - geofencing - - recording - - frame_recording - - ring - - screensharing - - transcription - - video - - thumbnails - - limits - - session + - filename + - url + - start_time + - end_time + - session_id + title: CallRecording type: object - CallStateResponseFields: - description: CallStateResponseFields is the payload for call state response + CallRecordingFailedEvent: + description: This event is sent when call recording has failed properties: - call: - $ref: '#/components/schemas/CallResponse' - x-stream-index: "001" - members: - description: List of call members - items: - $ref: '#/components/schemas/MemberResponse' - title: Members - type: array - x-stream-index: "002" - membership: - $ref: '#/components/schemas/MemberResponse' - description: Current user membership object - title: Membership + call_cid: + type: string + x-stream-index: "002.001" + created_at: + format: date-time + type: number + x-stream-index: "001.002" + egress_id: + type: string x-stream-index: "003" - own_capabilities: - items: - $ref: '#/components/schemas/OwnCapability' - type: array - x-stream-index: "004" + type: + default: call.recording_failed + description: 'The type of event: "call.recording_failed" in this case' + title: Event Type + type: string + x-stream-index: "001.001" required: - - call - - members - - own_capabilities - - blocked_users - title: CallStateResponseFields + - type + - created_at + - call_cid + - egress_id + title: CallRecordingFailedEvent type: object - CallStatsReportReadyEvent: - description: This event is sent when the insights report is ready + x-stream-event-call-type: true + x-stream-event-doc-group: recording + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + CallRecordingReadyEvent: + description: This event is sent when call recording is ready properties: call_cid: type: string x-stream-index: "002.001" + call_recording: + $ref: '#/components/schemas/CallRecording' + description: The call recording object + title: CallRecording + x-stream-index: "003" created_at: format: date-time type: number x-stream-index: "001.002" - session_id: - description: Call session ID - title: Session ID + egress_id: type: string - x-stream-index: "003.001" + x-stream-index: "004" type: - default: call.stats_report_ready - description: The type of event, "call.report_ready" in this case + default: call.recording_ready + description: 'The type of event: "call.recording_ready" in this case' title: Event Type type: string x-stream-index: "001.001" @@ -4032,157 +4850,46 @@ components: - type - created_at - call_cid - - session_id - title: CallStatsReportReadyEvent + - call_recording + - egress_id + title: CallRecordingReadyEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: other + x-stream-event-doc-group: recording x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallStatsReportSummaryResponse: + CallRecordingStartedEvent: + description: This event is sent when call recording has started properties: call_cid: type: string - x-stream-index: "001" - call_duration_seconds: - format: int32 - type: integer - x-stream-index: "008" - call_session_id: - type: string - x-stream-index: "002" - call_status: - type: string - x-stream-index: "004" + x-stream-index: "003.001" created_at: format: date-time type: number - x-stream-index: "007" - first_stats_time: - format: date-time - type: number - x-stream-index: "003" - min_user_rating: - format: int32 - type: integer - x-stream-index: "006" - quality_score: - format: int32 - type: integer - x-stream-index: "005" - required: - - call_cid - - call_session_id - - first_stats_time - - call_status - - call_duration_seconds - type: object - CallTranscription: - description: CallTranscription represents a transcription of a call. - properties: - end_time: - format: date-time - title: The end time of the transcription. - type: number - x-stream-index: "004" - filename: - title: The filename of the transcription. - type: string - x-stream-index: "001" - session_id: - title: The session ID of the transcription. - type: string - x-stream-index: "005" - start_time: - format: date-time - title: The start time of the transcription. - type: number - x-stream-index: "003" - url: - title: The URL of the transcription. - type: string - x-stream-index: "002" - required: - - filename - - url - - start_time - - end_time - - session_id - title: CallTranscription - type: object - CallTranscriptionFailedEvent: - description: This event is sent when call transcription has failed - properties: - call_cid: - type: string - x-stream-index: "002.001" - created_at: - format: date-time - type: number - x-stream-index: "001.002" + x-stream-index: "002.002" egress_id: type: string - x-stream-index: "003" - error: - description: The error message detailing why transcription failed. - title: string - type: string - x-stream-index: "004" + x-stream-index: "001" type: - default: call.transcription_failed - description: 'The type of event: "call.transcription_failed" in this case' + default: call.recording_started + description: 'The type of event: "call.recording_started" in this case' title: Event Type - type: string - x-stream-index: "001.001" - required: - - type - - created_at - - call_cid - - egress_id - title: CallTranscriptionFailedEvent - type: object - x-stream-event-call-type: true - x-stream-event-doc-group: transcription - x-stream-is-event: true - x-stream-ws-base-event-name: VideoEvent - CallTranscriptionReadyEvent: - description: This event is sent when call transcription is ready - properties: - call_cid: type: string x-stream-index: "002.001" - call_transcription: - $ref: '#/components/schemas/CallTranscription' - description: The call transcription object - title: CallTranscription - x-stream-index: "003" - created_at: - format: date-time - type: number - x-stream-index: "001.002" - egress_id: - type: string - x-stream-index: "004" - type: - default: call.transcription_ready - description: 'The type of event: "call.transcription_ready" in this case' - title: Event Type - type: string - x-stream-index: "001.001" required: + - egress_id - type - created_at - call_cid - - call_transcription - - egress_id - title: CallTranscriptionReadyEvent + title: CallRecordingStartedEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: transcription + x-stream-event-doc-group: recording x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallTranscriptionStartedEvent: - description: This event is sent when call transcription has started + CallRecordingStoppedEvent: + description: This event is sent when call recording has stopped properties: call_cid: type: string @@ -4195,8 +4902,8 @@ components: type: string x-stream-index: "001" type: - default: call.transcription_started - description: 'The type of event: "call.transcription_started" in this case' + default: call.recording_stopped + description: 'The type of event: "call.recording_stopped" in this case' title: Event Type type: string x-stream-index: "002.001" @@ -4205,15 +4912,19 @@ components: - type - created_at - call_cid - title: CallTranscriptionStartedEvent + title: CallRecordingStoppedEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: transcription + x-stream-event-doc-group: recording x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallTranscriptionStoppedEvent: - description: This event is sent when call transcription has stopped + CallRejectedEvent: + description: This event is sent when a user rejects a notification to join a + call. properties: + call: + $ref: '#/components/schemas/CallResponse' + x-stream-index: "003" call_cid: type: string x-stream-index: "002.001" @@ -4221,197 +4932,280 @@ components: format: date-time type: number x-stream-index: "001.002" - egress_id: + reason: + description: 'Provides information about why the call was rejected. You + can provide any value, but the Stream API and SDKs use these default values: + rejected, cancel, timeout and busy' + title: Reason type: string - x-stream-index: "003" + x-stream-index: "005" type: - default: call.transcription_stopped - description: 'The type of event: "call.transcription_stopped" in this case' + default: call.rejected + description: 'The type of event: "call.rejected" in this case' title: Event Type type: string x-stream-index: "001.001" + user: + $ref: '#/components/schemas/UserResponse' + description: The user who rejected the call + title: User + x-stream-index: "004" required: - type - created_at - call_cid - - egress_id - title: CallTranscriptionStoppedEvent + - call + - user + title: CallRejectedEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: transcription + x-stream-event-doc-group: ring x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallType: + CallReportResponse: properties: - AppPK: - format: int32 - type: integer - writeOnly: true - x-stream-index: "003" - CreatedAt: + ended_at: format: date-time type: number - writeOnly: true - x-stream-index: "005" - ExternalStorage: - type: string - writeOnly: true - x-stream-index: "009" - Name: - type: string - writeOnly: true - x-stream-index: "004" - NotificationSettings: - $ref: '#/components/schemas/NotificationSettings' - x-stream-index: "008" - PK: - format: int32 - type: integer - writeOnly: true - x-stream-index: "002" - Settings: - $ref: '#/components/schemas/CallSettings' - x-stream-index: "007" - UpdatedAt: + x-stream-index: "003" + score: + format: float + type: number + x-stream-index: "001" + started_at: format: date-time type: number - writeOnly: true - x-stream-index: "006" + x-stream-index: "002" required: - - PK - - AppPK - - Name - - CreatedAt - - UpdatedAt - - ExternalStorage + - score type: object - CallUpdatedEvent: - description: |- - This event is sent when a call is updated, clients should use this update the local state of the call. - This event also contains the capabilities by role for the call, clients should update the own_capability for the current. + CallRequest: + description: CallRequest is the payload for creating a call. properties: - call: - $ref: '#/components/schemas/CallResponse' - description: Call object - title: Call - x-stream-index: "003" - call_cid: + channel_cid: type: string - x-stream-index: "002.001" - capabilities_by_role: - additionalProperties: - items: - type: string - type: array - description: The capabilities by role for this call - title: CapabilitiesByRole + x-stream-index: "009" + custom: + additionalProperties: {} type: object x-stream-index: "004" - created_at: + members: + items: + $ref: '#/components/schemas/MemberRequest' + maximum: 100 + type: array + x-stream-index: "005" + settings_override: + $ref: '#/components/schemas/CallSettingsRequest' + x-stream-index: "006" + starts_at: format: date-time type: number - x-stream-index: "001.002" - type: - default: call.updated - description: 'The type of event: "call.ended" in this case' - title: Event Type + x-stream-index: "007" + team: type: string - x-stream-index: "001.001" - required: - - type - - created_at - - call_cid - - call - - capabilities_by_role - title: CallUpdatedEvent - type: object - x-stream-event-call-type: true - x-stream-event-doc-group: call - x-stream-is-event: true - x-stream-ws-base-event-name: VideoEvent - CallUserFeedbackSubmittedEvent: - description: This event is sent when a user submits feedback for a call. + x-stream-index: "001" + video: + type: boolean + x-stream-index: "008" + title: CallRequest + type: object + CallResponse: + description: Represents a call properties: - call_cid: + backstage: + type: boolean + x-stream-index: "016" + blocked_user_ids: + items: + type: string + type: array + x-stream-index: "018" + captioning: + type: boolean + x-stream-index: "013" + channel_cid: type: string - x-stream-index: "002.001" + x-stream-index: "024" + cid: + description: The unique identifier for a call (:) + title: CID + type: string + x-stream-index: "004" created_at: + description: Date/time of creation format: date-time + title: Created at type: number - x-stream-index: "001.002" + x-stream-index: "009" + created_by: + $ref: '#/components/schemas/UserResponse' + description: The user that created the call + title: Created By + x-stream-index: "007" + current_session_id: + type: string + x-stream-index: "005" custom: additionalProperties: {} - description: Custom data provided by the user - title: Custom + description: Custom data for this object + title: Custom data type: object - x-stream-index: "007" - rating: - description: The rating given by the user (1-5) + x-stream-index: "008" + egress: + $ref: '#/components/schemas/EgressResponse' + x-stream-index: "021" + ended_at: + description: Date/time when the call ended + format: date-time + title: Ended At + type: number + x-stream-index: "014" + id: + description: Call ID + title: ID + type: string + x-stream-index: "003" + ingress: + $ref: '#/components/schemas/CallIngressResponse' + x-stream-index: "019" + join_ahead_time_seconds: format: int32 - title: Rating type: integer - x-stream-index: "005" - reason: - description: The reason provided by the user for the rating - title: Reason + x-stream-index: "023" + recording: + type: boolean + x-stream-index: "011" + session: + $ref: '#/components/schemas/CallSessionResponse' + x-stream-index: "020" + settings: + $ref: '#/components/schemas/CallSettingsResponse' + x-stream-index: "017" + starts_at: + description: Date/time when the call will start + format: date-time + title: Starts At + type: number + x-stream-index: "015" + team: type: string x-stream-index: "006" - sdk: + thumbnails: + $ref: '#/components/schemas/ThumbnailResponse' + x-stream-index: "022" + transcribing: + type: boolean + x-stream-index: "012" + type: + description: The type of call + title: Type type: string - x-stream-index: "008" - sdk_version: + x-stream-index: "002" + updated_at: + description: Date/time of the last update + format: date-time + title: Updated at + type: number + x-stream-index: "010" + required: + - type + - id + - cid + - current_session_id + - created_by + - custom + - created_at + - updated_at + - recording + - transcribing + - captioning + - backstage + - settings + - blocked_user_ids + - ingress + - egress + title: CallResponse + type: object + CallRingEvent: + description: This event is sent to all call members to notify they are getting + called + properties: + call: + $ref: '#/components/schemas/CallResponse' + description: Call object + title: Call + x-stream-index: "005" + call_cid: type: string - x-stream-index: "009" + x-stream-index: "002.001" + created_at: + format: date-time + type: number + x-stream-index: "001.002" + members: + description: Call members + items: + $ref: '#/components/schemas/MemberResponse' + title: Members + type: array + x-stream-index: "006" session_id: description: Call session ID title: Session ID type: string x-stream-index: "003.001" type: - default: call.user_feedback_submitted - description: The type of event, "call.user_feedback" in this case + default: call.ring + description: 'The type of event: "call.notification" in this case' title: Event Type type: string x-stream-index: "001.001" user: $ref: '#/components/schemas/UserResponse' - description: The user who submitted the feedback + description: The user that sent the call notification title: User - x-stream-index: "004" + x-stream-index: "007" + video: + type: boolean + x-stream-index: "008" required: - type - created_at - call_cid - session_id + - call + - members - user - - rating - title: CallUserFeedbackSubmittedEvent + - video + title: CallRingEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: other + x-stream-event-doc-group: ring x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallUserMutedEvent: - description: This event is sent when a call member is muted + CallRtmpBroadcastFailedEvent: + description: This event is sent when a call RTMP broadcast has failed properties: call_cid: + description: The unique identifier for a call (:) + title: CID type: string x-stream-index: "002.001" created_at: + description: Date/time of creation format: date-time + title: Created at type: number x-stream-index: "001.002" - from_user_id: + name: + description: Name of the given RTMP broadcast + title: Name type: string x-stream-index: "003" - muted_user_ids: - items: - type: string - type: array - x-stream-index: "004" type: - default: call.user_muted - description: 'The type of event: "call.user_muted" in this case' + default: call.rtmp_broadcast_failed + description: 'The type of event: "call.rtmp_broadcast_failed" in this case' title: Event Type type: string x-stream-index: "001.001" @@ -4419,1386 +5213,1601 @@ components: - type - created_at - call_cid - - from_user_id - - muted_user_ids - title: CallUserMutedEvent + - name + title: CallRtmpBroadcastFailedEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: call + x-stream-event-doc-group: streaming x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallsPerDayReport: - properties: - count: - format: int64 - type: integer - x-stream-index: "001" - required: - - count - type: object - CallsPerDayReportResponse: - properties: - daily: - items: - $ref: '#/components/schemas/DailyAggregateCallsPerDayReportResponse' - type: array - x-stream-index: "001" - required: - - daily - type: object - CastPollVoteRequest: - nullable: true - properties: - vote: - $ref: '#/components/schemas/VoteData' - description: Vote data - title: VoteData - x-stream-index: "004" - type: object - Channel: + CallRtmpBroadcastStartedEvent: + description: This event is sent when RTMP broadcast has started properties: - active_live_locations: - items: - $ref: '#/components/schemas/SharedLocation' - type: array - x-stream-index: "034" - auto_translation_enabled: - type: boolean - x-stream-index: "029" - auto_translation_language: + call_cid: + description: The unique identifier for a call (:) + title: CID type: string - x-stream-index: "030" - cid: + x-stream-index: "002.001" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: "001.002" + name: + description: Name of the given RTMP broadcast + title: Name type: string x-stream-index: "003" - config: - $ref: '#/components/schemas/ChannelConfig' - x-stream-index: "026" - config_overrides: - $ref: '#/components/schemas/ConfigOverrides' - x-stream-index: "027" - cooldown: - format: int32 - type: integer - x-stream-index: "031" + type: + default: call.rtmp_broadcast_started + description: 'The type of event: "call.rtmp_broadcast_started" in this case' + title: Event Type + type: string + x-stream-index: "001.001" + required: + - type + - created_at + - call_cid + - name + title: CallRtmpBroadcastStartedEvent + type: object + x-stream-event-call-type: true + x-stream-event-doc-group: streaming + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + CallRtmpBroadcastStoppedEvent: + description: This event is sent when RTMP broadcast has stopped + properties: + call_cid: + description: The unique identifier for a call (:) + title: CID + type: string + x-stream-index: "002.001" created_at: + description: Date/time of creation format: date-time + title: Created at type: number - x-stream-index: "009" - created_by: - $ref: '#/components/schemas/User' - x-stream-index: "008" - custom: - additionalProperties: {} + x-stream-index: "001.002" + name: + description: Name of the given RTMP broadcast + title: Name + type: string + x-stream-index: "003" + type: + default: call.rtmp_broadcast_stopped + description: 'The type of event: "call.rtmp_broadcast_stopped" in this case' + title: Event Type + type: string + x-stream-index: "001.001" + required: + - type + - created_at + - call_cid + - name + title: CallRtmpBroadcastStoppedEvent + type: object + x-stream-event-call-type: true + x-stream-event-doc-group: streaming + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + CallSession: + properties: + AcceptedBy: + additionalProperties: + format: date-time + type: number type: object + writeOnly: true + x-stream-index: "008" + ActiveSFUs: + items: + $ref: '#/components/schemas/SFUIDLastSeen' + type: array + writeOnly: true + x-stream-index: "016" + AnonymousParticipantCount: + format: int32 + type: integer + writeOnly: true x-stream-index: "019" - deleted_at: + AppPK: + format: int32 + type: integer + writeOnly: true + x-stream-index: "002.001" + CallID: + type: string + writeOnly: true + x-stream-index: "002.003" + CallType: + type: string + writeOnly: true + x-stream-index: "002.002" + CreatedAt: format: date-time type: number - x-stream-index: "011" - disabled: - type: boolean - x-stream-index: "017" - frozen: - type: boolean - x-stream-index: "016" - id: - type: string + writeOnly: true + x-stream-index: "003" + DeletedAt: + format: date-time + type: number + writeOnly: true x-stream-index: "004" - invites: + EndedAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "006" + LiveEndedAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "013" + LiveStartedAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "012" + MissedBy: + additionalProperties: + format: date-time + type: number + type: object + writeOnly: true + x-stream-index: "010" + Participants: items: - $ref: '#/components/schemas/ChannelMember' + $ref: '#/components/schemas/CallParticipant' type: array - x-stream-index: "022" - last_campaigns: - type: string - x-stream-index: "032" - last_message_at: + writeOnly: true + x-stream-index: "011" + ParticipantsCountByRole: + additionalProperties: + format: int32 + type: integer + type: object + writeOnly: true + x-stream-index: "018" + RejectedBy: + additionalProperties: + format: date-time + type: number + type: object + writeOnly: true + x-stream-index: "009" + RingAt: format: date-time type: number - x-stream-index: "006" - member_count: - format: int32 - type: integer - x-stream-index: "021" - members: + writeOnly: true + x-stream-index: "007" + SFUIDs: items: - $ref: '#/components/schemas/ChannelMember' + type: string type: array - x-stream-index: "020" - team: - type: string - x-stream-index: "028" - truncated_by: - $ref: '#/components/schemas/User' + writeOnly: true x-stream-index: "015" - type: + SessionID: type: string + writeOnly: true + x-stream-index: "002.004" + StartedAt: + format: date-time + type: number + writeOnly: true x-stream-index: "005" - updated_at: + TimerEndsAt: format: date-time type: number - x-stream-index: "010" + writeOnly: true + x-stream-index: "014" + UserPermissionOverrides: + additionalProperties: + additionalProperties: + type: boolean + type: object + type: object + writeOnly: true + x-stream-index: "017" required: - - cid - - id - - type - - created_at - - updated_at - - frozen - - disabled - - custom - - auto_translation_language + - AppPK + - CallType + - CallID + - SessionID + - CreatedAt + - AcceptedBy + - RejectedBy + - MissedBy + - Participants + - SFUIDs + - ActiveSFUs + - UserPermissionOverrides + - ParticipantsCountByRole + - AnonymousParticipantCount type: object - ChannelConfig: + CallSessionEndedEvent: + description: This event is sent when a call session ends properties: - allowed_flag_reasons: - items: - type: string - type: array - x-stream-index: "001.026" - automod: - enum: - - disabled - - simple - - AI + call: + $ref: '#/components/schemas/CallResponse' + description: Call object + title: Call + x-stream-index: "004" + call_cid: type: string - x-stream-index: "001.021" - automod_behavior: - enum: - - flag - - block - - shadow_block + x-stream-index: "002.001" + created_at: + format: date-time + type: number + x-stream-index: "001.002" + session_id: + description: Call session ID + title: Session ID type: string - x-stream-index: "001.022" - automod_thresholds: - $ref: '#/components/schemas/Thresholds' - x-stream-index: "001.027" - blocklist: + x-stream-index: "003.001" + type: + default: call.session_ended + description: 'The type of event: "call.session_ended" in this case' + title: Event Type type: string - x-stream-index: "001.023" - blocklist_behavior: - enum: - - flag - - block - - shadow_block + x-stream-index: "001.001" + required: + - type + - created_at + - call_cid + - session_id + - call + title: CallSessionEndedEvent + type: object + x-stream-event-call-type: true + x-stream-event-doc-group: session + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + CallSessionParticipantCountsUpdatedEvent: + description: This event is sent when the participant counts in a call session + are updated + properties: + anonymous_participant_count: + format: int32 + type: integer + x-stream-index: "005" + call_cid: type: string - x-stream-index: "001.024" - blocklists: - items: - $ref: '#/components/schemas/BlockListOptions' - type: array - x-stream-index: "001.025" - commands: - items: - type: string - type: array - x-stream-index: "003" - connect_events: - type: boolean - x-stream-index: "001.004" + x-stream-index: "002.001" created_at: format: date-time type: number - x-stream-index: "002.003" - custom_events: - type: boolean - x-stream-index: "001.012" - mark_messages_pending: - type: boolean - x-stream-index: "001.015" - max_message_length: - format: int32 - maximum: 20000 - type: integer - x-stream-index: "001.020" - mutes: - type: boolean - x-stream-index: "001.009" - name: + x-stream-index: "001.002" + participants_count_by_role: + additionalProperties: + format: int32 + type: integer + type: object + x-stream-index: "004" + session_id: + description: Call session ID + title: Session ID + type: string + x-stream-index: "003.001" + type: + default: call.session_participant_count_updated + description: 'The type of event: "call.session_participant_count_updated" + in this case' + title: Event Type type: string x-stream-index: "001.001" - partition_size: - format: int32 - type: integer - x-stream-index: "001.028" - partition_ttl: - type: integer - x-stream-index: "001.029" - polls: - type: boolean - x-stream-index: "001.016" - push_notifications: - type: boolean - x-stream-index: "001.013" - quotes: - type: boolean - x-stream-index: "001.008" - reactions: - type: boolean - x-stream-index: "001.006" - read_events: - type: boolean - x-stream-index: "001.003" - reminders: - type: boolean - x-stream-index: "001.014" - replies: - type: boolean - x-stream-index: "001.007" - search: - type: boolean - x-stream-index: "001.005" - shared_locations: - type: boolean - x-stream-index: "001.018" - skip_last_msg_update_for_system_msgs: - type: boolean - x-stream-index: "001.030" - typing_events: - type: boolean - x-stream-index: "001.002" - updated_at: - format: date-time - type: number - x-stream-index: "002.004" - uploads: - type: boolean - x-stream-index: "001.010" - url_enrichment: - type: boolean - x-stream-index: "001.011" - user_message_reminders: - type: boolean - x-stream-index: "001.017" required: - - name - - typing_events - - read_events - - connect_events - - search - - reactions - - replies - - quotes - - mutes - - uploads - - url_enrichment - - custom_events - - push_notifications - - reminders - - mark_messages_pending - - polls - - user_message_reminders - - shared_locations - - message_retention - - max_message_length - - automod - - automod_behavior - - skip_last_msg_update_for_system_msgs + - type - created_at - - updated_at - - commands + - call_cid + - session_id + - participants_count_by_role + - anonymous_participant_count + title: CallSessionParticipantCountsUpdatedEvent type: object - ChannelConfigWithInfo: + x-stream-event-call-type: true + x-stream-event-doc-group: session + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + CallSessionParticipantJoinedEvent: + description: This event is sent when a participant joins a call session properties: - allowed_flag_reasons: - items: - type: string - type: array - x-stream-index: 001.002.026 - automod: - enum: - - disabled - - simple - - AI + call_cid: type: string - x-stream-index: 001.002.021 - automod_behavior: - enum: - - flag - - block - - shadow_block + x-stream-index: "002.001" + created_at: + format: date-time + type: number + x-stream-index: "001.002" + participant: + $ref: '#/components/schemas/CallParticipantResponse' + description: The participant that joined the session + title: Participant + x-stream-index: "004" + session_id: + description: Call session ID + title: Session ID type: string - x-stream-index: 001.002.022 - automod_thresholds: - $ref: '#/components/schemas/Thresholds' - x-stream-index: 001.002.027 - blocklist: + x-stream-index: "003.001" + type: + default: call.session_participant_joined + description: 'The type of event: "call.session_participant_joined" in this + case' + title: Event Type type: string - x-stream-index: 001.002.023 - blocklist_behavior: - enum: - - flag - - block - - shadow_block + x-stream-index: "001.001" + required: + - type + - created_at + - call_cid + - session_id + - participant + title: CallSessionParticipantJoinedEvent + type: object + x-stream-event-call-type: true + x-stream-event-doc-group: session + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + CallSessionParticipantLeftEvent: + description: This event is sent when a participant leaves a call session + properties: + call_cid: type: string - x-stream-index: 001.002.024 - blocklists: - items: - $ref: '#/components/schemas/BlockListOptions' - type: array - x-stream-index: 001.002.025 - commands: - items: - $ref: '#/components/schemas/Command' - type: array - x-stream-index: "001.003" - connect_events: - type: boolean - x-stream-index: 001.002.004 + x-stream-index: "002.001" created_at: format: date-time type: number - x-stream-index: 001.001.003 - custom_events: - type: boolean - x-stream-index: 001.002.012 - grants: - additionalProperties: - items: - type: string - type: array - type: object - x-stream-index: "002" - mark_messages_pending: - type: boolean - x-stream-index: 001.002.015 - max_message_length: - format: int32 - maximum: 20000 - type: integer - x-stream-index: 001.002.020 - mutes: - type: boolean - x-stream-index: 001.002.009 - name: - type: string - x-stream-index: 001.002.001 - partition_size: + x-stream-index: "001.002" + duration_seconds: + description: The duration participant was in the session in seconds format: int32 + title: Duration type: integer - x-stream-index: 001.002.028 - partition_ttl: - example: 24h - format: duration - nullable: true + x-stream-index: "005" + participant: + $ref: '#/components/schemas/CallParticipantResponse' + description: The participant that left the session + title: Participant + x-stream-index: "004" + session_id: + description: Call session ID + title: Session ID type: string - x-stream-index: 001.002.029 - polls: - type: boolean - x-stream-index: 001.002.016 - push_notifications: - type: boolean - x-stream-index: 001.002.013 - quotes: - type: boolean - x-stream-index: 001.002.008 - reactions: - type: boolean - x-stream-index: 001.002.006 - read_events: - type: boolean - x-stream-index: 001.002.003 - reminders: - type: boolean - x-stream-index: 001.002.014 - replies: - type: boolean - x-stream-index: 001.002.007 - search: - type: boolean - x-stream-index: 001.002.005 - shared_locations: - type: boolean - x-stream-index: 001.002.018 - skip_last_msg_update_for_system_msgs: - type: boolean - x-stream-index: 001.002.030 - typing_events: - type: boolean - x-stream-index: 001.002.002 - updated_at: - format: date-time - type: number - x-stream-index: 001.001.004 - uploads: - type: boolean - x-stream-index: 001.002.010 - url_enrichment: - type: boolean - x-stream-index: 001.002.011 - user_message_reminders: - type: boolean - x-stream-index: 001.002.017 - required: - - created_at - - updated_at - - name - - typing_events - - read_events - - connect_events - - search - - reactions - - replies - - quotes - - mutes - - uploads - - url_enrichment - - custom_events - - push_notifications - - reminders - - mark_messages_pending - - polls - - user_message_reminders - - shared_locations - - message_retention - - max_message_length - - automod - - automod_behavior - - skip_last_msg_update_for_system_msgs - - commands - type: object - ChannelCreatedEvent: - properties: - created_at: - format: date-time - type: number - x-stream-index: "001.002" + x-stream-index: "003.001" type: - default: channel.created + default: call.session_participant_left + description: 'The type of event: "call.session_participant_left" in this + case' + title: Event Type type: string x-stream-index: "001.001" required: - type - created_at - title: ChannelCreatedEvent + - call_cid + - session_id + - participant + - duration_seconds + title: CallSessionParticipantLeftEvent type: object - x-stream-event-client-type: true - x-stream-event-doc-group: other + x-stream-event-call-type: true + x-stream-event-doc-group: session x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - ChannelDeletedEvent: + CallSessionResponse: properties: - channel: - $ref: '#/components/schemas/ChannelResponse' - x-stream-index: "003.004" - channel_id: - type: string - x-stream-index: "003.002" - channel_member_count: + accepted_by: + additionalProperties: + format: date-time + type: number + type: object + x-stream-index: "008" + anonymous_participant_count: format: int32 type: integer - x-stream-index: "003.005" - channel_type: + x-stream-index: "006" + ended_at: + format: date-time + type: number + x-stream-index: "003" + id: type: string - x-stream-index: "003.003" - cid: + x-stream-index: "001" + live_ended_at: + format: date-time + type: number + x-stream-index: "011" + live_started_at: + format: date-time + type: number + x-stream-index: "010" + missed_by: + additionalProperties: + format: date-time + type: number + type: object + x-stream-index: "009" + participants: + items: + $ref: '#/components/schemas/CallParticipantResponse' + type: array + x-stream-index: "004" + participants_count_by_role: + additionalProperties: + format: int32 + type: integer + type: object + x-stream-index: "005" + rejected_by: + additionalProperties: + format: date-time + type: number + type: object + x-stream-index: "007" + started_at: + format: date-time + type: number + x-stream-index: "002" + timer_ends_at: + format: date-time + type: number + x-stream-index: "012" + required: + - id + - participants + - participants_count_by_role + - anonymous_participant_count + - rejected_by + - accepted_by + - missed_by + type: object + CallSessionStartedEvent: + description: This event is sent when a call session starts + properties: + call: + $ref: '#/components/schemas/CallResponse' + description: Call object + title: Call + x-stream-index: "004" + call_cid: type: string - x-stream-index: "003.001" + x-stream-index: "002.001" created_at: format: date-time type: number - x-stream-index: "002.002" - team: + x-stream-index: "001.002" + session_id: + description: Call session ID + title: Session ID type: string - x-stream-index: "001.001" + x-stream-index: "003.001" type: - default: channel.deleted + default: call.session_started + description: 'The type of event: "call.session_started" in this case' + title: Event Type type: string - x-stream-index: "002.001" + x-stream-index: "001.001" required: - type - created_at - - cid - - channel_id - - channel_type - - channel_member_count - title: ChannelDeletedEvent + - call_cid + - session_id + - call + title: CallSessionStartedEvent type: object - x-stream-event-client-type: true - x-stream-event-doc-group: other + x-stream-event-call-type: true + x-stream-event-doc-group: session x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - ChannelFrozenEvent: + CallSettings: properties: - channel_id: - type: string - x-stream-index: "002.002" - channel_type: - type: string - x-stream-index: "002.003" - cid: + audio: + $ref: '#/components/schemas/AudioSettings' + x-stream-index: "001" + backstage: + $ref: '#/components/schemas/BackstageSettings' + x-stream-index: "002" + broadcasting: + $ref: '#/components/schemas/BroadcastSettings' + x-stream-index: "007" + frame_recording: + $ref: '#/components/schemas/FrameRecordSettings' + x-stream-index: "006" + geofencing: + $ref: '#/components/schemas/GeofenceSettings' + x-stream-index: "008" + ingress: + $ref: '#/components/schemas/IngressSettings' + x-stream-index: "014" + limits: + $ref: '#/components/schemas/LimitsSettings' + x-stream-index: "012" + recording: + $ref: '#/components/schemas/RecordSettings' + x-stream-index: "005" + ring: + $ref: '#/components/schemas/RingSettings' + x-stream-index: "010" + screensharing: + $ref: '#/components/schemas/ScreensharingSettings' + x-stream-index: "004" + session: + $ref: '#/components/schemas/SessionSettings' + x-stream-index: "013" + thumbnails: + $ref: '#/components/schemas/ThumbnailsSettings' + x-stream-index: "011" + transcription: + $ref: '#/components/schemas/TranscriptionSettings' + x-stream-index: "009" + video: + $ref: '#/components/schemas/VideoSettings' + x-stream-index: "003" + type: object + CallSettingsRequest: + properties: + audio: + $ref: '#/components/schemas/AudioSettingsRequest' + x-stream-index: "001" + backstage: + $ref: '#/components/schemas/BackstageSettingsRequest' + x-stream-index: "002" + broadcasting: + $ref: '#/components/schemas/BroadcastSettingsRequest' + x-stream-index: "010" + frame_recording: + $ref: '#/components/schemas/FrameRecordingSettingsRequest' + x-stream-index: "006" + geofencing: + $ref: '#/components/schemas/GeofenceSettingsRequest' + x-stream-index: "003" + ingress: + $ref: '#/components/schemas/IngressSettingsRequest' + x-stream-index: "014" + limits: + $ref: '#/components/schemas/LimitsSettingsRequest' + x-stream-index: "012" + recording: + $ref: '#/components/schemas/RecordSettingsRequest' + x-stream-index: "005" + ring: + $ref: '#/components/schemas/RingSettingsRequest' + x-stream-index: "007" + screensharing: + $ref: '#/components/schemas/ScreensharingSettingsRequest' + x-stream-index: "008" + session: + $ref: '#/components/schemas/SessionSettingsRequest' + x-stream-index: "013" + thumbnails: + $ref: '#/components/schemas/ThumbnailsSettingsRequest' + x-stream-index: "011" + transcription: + $ref: '#/components/schemas/TranscriptionSettingsRequest' + x-stream-index: "009" + video: + $ref: '#/components/schemas/VideoSettingsRequest' + x-stream-index: "004" + type: object + CallSettingsResponse: + properties: + audio: + $ref: '#/components/schemas/AudioSettingsResponse' + x-stream-index: "001" + backstage: + $ref: '#/components/schemas/BackstageSettingsResponse' + x-stream-index: "002" + broadcasting: + $ref: '#/components/schemas/BroadcastSettingsResponse' + x-stream-index: "003" + frame_recording: + $ref: '#/components/schemas/FrameRecordingSettingsResponse' + x-stream-index: "006" + geofencing: + $ref: '#/components/schemas/GeofenceSettingsResponse' + x-stream-index: "004" + ingress: + $ref: '#/components/schemas/IngressSettingsResponse' + x-stream-index: "014" + limits: + $ref: '#/components/schemas/LimitsSettingsResponse' + x-stream-index: "012" + recording: + $ref: '#/components/schemas/RecordSettingsResponse' + x-stream-index: "005" + ring: + $ref: '#/components/schemas/RingSettingsResponse' + x-stream-index: "007" + screensharing: + $ref: '#/components/schemas/ScreensharingSettingsResponse' + x-stream-index: "008" + session: + $ref: '#/components/schemas/SessionSettingsResponse' + x-stream-index: "013" + thumbnails: + $ref: '#/components/schemas/ThumbnailsSettingsResponse' + x-stream-index: "011" + transcription: + $ref: '#/components/schemas/TranscriptionSettingsResponse' + x-stream-index: "009" + video: + $ref: '#/components/schemas/VideoSettingsResponse' + x-stream-index: "010" + required: + - audio + - backstage + - broadcasting + - geofencing + - recording + - frame_recording + - ring + - screensharing + - transcription + - video + - thumbnails + - limits + - session + type: object + CallStateResponseFields: + description: CallStateResponseFields is the payload for call state response + properties: + call: + $ref: '#/components/schemas/CallResponse' + x-stream-index: "001" + members: + description: List of call members + items: + $ref: '#/components/schemas/MemberResponse' + title: Members + type: array + x-stream-index: "002" + membership: + $ref: '#/components/schemas/MemberResponse' + description: Current user membership object + title: Membership + x-stream-index: "003" + own_capabilities: + items: + $ref: '#/components/schemas/OwnCapability' + type: array + x-stream-index: "004" + required: + - call + - members + - own_capabilities + - blocked_users + title: CallStateResponseFields + type: object + CallStatsReportReadyEvent: + description: This event is sent when the insights report is ready + properties: + call_cid: type: string x-stream-index: "002.001" created_at: format: date-time type: number x-stream-index: "001.002" + session_id: + description: Call session ID + title: Session ID + type: string + x-stream-index: "003.001" type: - default: channel.frozen + default: call.stats_report_ready + description: The type of event, "call.report_ready" in this case + title: Event Type type: string x-stream-index: "001.001" required: - type - created_at - - cid - - channel_id - - channel_type - title: ChannelFrozenEvent + - call_cid + - session_id + title: CallStatsReportReadyEvent type: object - x-stream-event-client-type: true + x-stream-event-call-type: true x-stream-event-doc-group: other x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - ChannelGetOrCreateRequest: - nullable: true - properties: - data: - $ref: '#/components/schemas/ChannelInput' - x-stream-index: "003" - hide_for_creator: - description: Whether this channel will be hidden for the user who created - the channel or not - title: Hide for creator - type: boolean - x-stream-index: "007" - members: - $ref: '#/components/schemas/PaginationParams' - x-stream-index: "010" - messages: - $ref: '#/components/schemas/MessagePaginationParams' - x-stream-index: "009" - presence: - description: Fetch user presence info - title: Presence - type: boolean - x-stream-index: "006" - state: - description: Refresh channel state - title: State - type: boolean - x-stream-index: "005" - thread_unread_counts: - type: boolean - x-stream-index: "008" - watch: - description: Start watching the channel - title: Watch - type: boolean - x-stream-index: "004" - watchers: - $ref: '#/components/schemas/PaginationParams' - x-stream-index: "011" - type: object - ChannelHiddenEvent: + CallStatsReportSummaryResponse: properties: - channel: - $ref: '#/components/schemas/ChannelResponse' - x-stream-index: "003.004" - channel_id: + call_cid: type: string - x-stream-index: "003.002" - channel_member_count: + x-stream-index: "001" + call_duration_seconds: format: int32 type: integer - x-stream-index: "003.005" - channel_type: + x-stream-index: "008" + call_session_id: type: string - x-stream-index: "003.003" - cid: + x-stream-index: "002" + call_status: + type: string + x-stream-index: "004" + created_at: + format: date-time + type: number + x-stream-index: "007" + first_stats_time: + format: date-time + type: number + x-stream-index: "003" + min_user_rating: + format: int32 + type: integer + x-stream-index: "006" + quality_score: + format: int32 + type: integer + x-stream-index: "005" + required: + - call_cid + - call_session_id + - first_stats_time + - call_status + - call_duration_seconds + type: object + CallTranscription: + description: CallTranscription represents a transcription of a call. + properties: + end_time: + format: date-time + title: The end time of the transcription. + type: number + x-stream-index: "004" + filename: + title: The filename of the transcription. type: string - x-stream-index: "003.001" - clear_history: - type: boolean x-stream-index: "001" + session_id: + title: The session ID of the transcription. + type: string + x-stream-index: "005" + start_time: + format: date-time + title: The start time of the transcription. + type: number + x-stream-index: "003" + url: + title: The URL of the transcription. + type: string + x-stream-index: "002" + required: + - filename + - url + - start_time + - end_time + - session_id + title: CallTranscription + type: object + CallTranscriptionFailedEvent: + description: This event is sent when call transcription has failed + properties: + call_cid: + type: string + x-stream-index: "002.001" created_at: format: date-time type: number - x-stream-index: "004.002" + x-stream-index: "001.002" + egress_id: + type: string + x-stream-index: "003" + error: + description: The error message detailing why transcription failed. + title: string + type: string + x-stream-index: "004" type: - default: channel.hidden + default: call.transcription_failed + description: 'The type of event: "call.transcription_failed" in this case' + title: Event Type type: string - x-stream-index: "004.001" - user: - $ref: '#/components/schemas/User' - x-stream-index: "002.001" + x-stream-index: "001.001" required: - - clear_history - - cid - - channel_id - - channel_type - - channel_member_count - type - created_at - title: ChannelHiddenEvent + - call_cid + - egress_id + title: CallTranscriptionFailedEvent type: object - x-stream-event-client-type: true - x-stream-event-doc-group: other + x-stream-event-call-type: true + x-stream-event-doc-group: transcription x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - ChannelInput: + CallTranscriptionReadyEvent: + description: This event is sent when call transcription is ready properties: - auto_translation_enabled: - description: Enable or disable auto translation - title: Auto translation - type: boolean - x-stream-index: "005" - auto_translation_language: - description: Switch auto translation language - title: Auto translation language - type: string - x-stream-index: "006" - config_overrides: - $ref: '#/components/schemas/ChannelConfig' - x-stream-index: "024" - created_by: - $ref: '#/components/schemas/UserRequest' - x-stream-index: "009" - created_by_id: + call_cid: type: string - x-stream-index: "008" - custom: - additionalProperties: {} - type: object - x-stream-index: "015" - disabled: - type: boolean - x-stream-index: "014" - frozen: - description: Freeze or unfreeze the channel - title: Frozen - type: boolean - x-stream-index: "013" - invites: - items: - $ref: '#/components/schemas/ChannelMember' - maximum: 100 - type: array - x-stream-index: "016" - members: - items: - $ref: '#/components/schemas/ChannelMember' - maximum: 100 - type: array - x-stream-index: "018" - team: - description: Team the channel belongs to (if multi-tenant mode is enabled) - title: Team + x-stream-index: "002.001" + call_transcription: + $ref: '#/components/schemas/CallTranscription' + description: The call transcription object + title: CallTranscription + x-stream-index: "003" + created_at: + format: date-time + type: number + x-stream-index: "001.002" + egress_id: type: string x-stream-index: "004" - truncated_by_id: + type: + default: call.transcription_ready + description: 'The type of event: "call.transcription_ready" in this case' + title: Event Type type: string - x-stream-index: "010" + x-stream-index: "001.001" + required: + - type + - created_at + - call_cid + - call_transcription + - egress_id + title: CallTranscriptionReadyEvent type: object - ChannelKickedEvent: + x-stream-event-call-type: true + x-stream-event-doc-group: transcription + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + CallTranscriptionStartedEvent: + description: This event is sent when call transcription has started properties: - channel: - $ref: '#/components/schemas/ChannelResponse' - x-stream-index: "002.004" - channel_id: + call_cid: type: string + x-stream-index: "003.001" + created_at: + format: date-time + type: number x-stream-index: "002.002" - channel_member_count: - format: int32 - type: integer - x-stream-index: "002.005" - channel_type: + egress_id: type: string - x-stream-index: "002.003" - cid: + x-stream-index: "001" + type: + default: call.transcription_started + description: 'The type of event: "call.transcription_started" in this case' + title: Event Type + type: string + x-stream-index: "002.001" + required: + - egress_id + - type + - created_at + - call_cid + title: CallTranscriptionStartedEvent + type: object + x-stream-event-call-type: true + x-stream-event-doc-group: transcription + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + CallTranscriptionStoppedEvent: + description: This event is sent when call transcription has stopped + properties: + call_cid: type: string x-stream-index: "002.001" created_at: format: date-time type: number x-stream-index: "001.002" + egress_id: + type: string + x-stream-index: "003" type: - default: channel.kicked + default: call.transcription_stopped + description: 'The type of event: "call.transcription_stopped" in this case' + title: Event Type type: string x-stream-index: "001.001" required: - type - created_at - - cid - - channel_id - - channel_type - - channel_member_count - title: ChannelKickedEvent + - call_cid + - egress_id + title: CallTranscriptionStoppedEvent type: object - x-stream-event-client-type: true - x-stream-event-doc-group: other + x-stream-event-call-type: true + x-stream-event-doc-group: transcription x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - ChannelMember: - nullable: true + CallType: properties: - archived_at: + AppPK: + format: int32 + type: integer + writeOnly: true + x-stream-index: "003" + CreatedAt: format: date-time type: number - x-stream-index: "015" - ban_expires: - description: Expiration date of the ban - format: date-time - title: Ban expires - type: number - x-stream-index: "013" - banned: - description: Whether member is banned this channel or not - title: Banned - type: boolean - x-stream-index: "012" - channel_role: - description: Role of the member in the channel - title: Channel Role + writeOnly: true + x-stream-index: "005" + ExternalStorage: type: string - x-stream-index: "018" - created_at: - description: Date/time of creation - format: date-time - title: Created at - type: number + writeOnly: true x-stream-index: "009" - custom: - additionalProperties: {} - type: object + Name: + type: string + writeOnly: true x-stream-index: "004" - deleted_at: - format: date-time - type: number - x-stream-index: "011" - invite_accepted_at: - description: Date when invite was accepted + NotificationSettings: + $ref: '#/components/schemas/NotificationSettings' + x-stream-index: "008" + PK: + format: int32 + type: integer + writeOnly: true + x-stream-index: "002" + Settings: + $ref: '#/components/schemas/CallSettings' + x-stream-index: "007" + UpdatedAt: format: date-time - title: Invited accepted at type: number + writeOnly: true x-stream-index: "006" - invite_rejected_at: - description: Date when invite was rejected - format: date-time - title: Invited rejected at - type: number - x-stream-index: "007" - invited: - description: Whether member was invited or not - title: Invited - type: boolean - x-stream-index: "005" - is_moderator: - description: Whether member is channel moderator or not - title: Is moderator - type: boolean + required: + - PK + - AppPK + - Name + - CreatedAt + - UpdatedAt + - ExternalStorage + type: object + CallUpdatedEvent: + description: |- + This event is sent when a call is updated, clients should use this update the local state of the call. + This event also contains the capabilities by role for the call, clients should update the own_capability for the current. + properties: + call: + $ref: '#/components/schemas/CallResponse' + description: Call object + title: Call x-stream-index: "003" - notifications_muted: - type: boolean - x-stream-index: "019" - pinned_at: - format: date-time - type: number - x-stream-index: "016" - role: - description: 'Permission level of the member in the channel (DEPRECATED: - use channel_role instead)' - enum: - - member - - moderator - - admin - - owner - title: Role - type: string - x-stream-index: "017" - shadow_banned: - description: Whether member is shadow banned in this channel or not - title: Shadow banned - type: boolean - x-stream-index: "014" - status: + call_cid: type: string - x-stream-index: "008" - updated_at: - description: Date/time of the last update + x-stream-index: "002.001" + capabilities_by_role: + additionalProperties: + items: + type: string + type: array + description: The capabilities by role for this call + title: CapabilitiesByRole + type: object + x-stream-index: "004" + created_at: format: date-time - title: Updated at type: number - x-stream-index: "010" - user: - $ref: '#/components/schemas/UserResponse' - x-stream-index: "002" - user_id: - title: User ID + x-stream-index: "001.002" + type: + default: call.updated + description: 'The type of event: "call.updated" in this case' + title: Event Type type: string - x-stream-index: "001" + x-stream-index: "001.001" required: - - custom + - type - created_at - - updated_at - - banned - - shadow_banned - - channel_role - - notifications_muted - title: Channel member + - call_cid + - call + - capabilities_by_role + title: CallUpdatedEvent type: object - ChannelMemberResponse: - nullable: true + x-stream-event-call-type: true + x-stream-event-doc-group: call + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + CallUserFeedbackSubmittedEvent: + description: This event is sent when a user submits feedback for a call. properties: - archived_at: - format: date-time - type: number - x-stream-index: "016" - ban_expires: - description: Expiration date of the ban - format: date-time - title: Ban expires - type: number - x-stream-index: "013" - banned: - description: Whether member is banned this channel or not - title: Banned - type: boolean - x-stream-index: "012" - channel_role: - description: Role of the member in the channel - title: Channel Role + call_cid: type: string - x-stream-index: "018" + x-stream-index: "002.001" created_at: - description: Date/time of creation format: date-time - title: Created at type: number - x-stream-index: "009" + x-stream-index: "001.002" custom: additionalProperties: {} + description: Custom data provided by the user + title: Custom type: object - x-stream-index: "004" - deleted_at: - format: date-time - type: number - x-stream-index: "011" - invite_accepted_at: - description: Date when invite was accepted - format: date-time - title: Invited accepted at - type: number - x-stream-index: "006" - invite_rejected_at: - description: Date when invite was rejected - format: date-time - title: Invited rejected at - type: number x-stream-index: "007" - invited: - description: Whether member was invited or not - title: Invited - type: boolean + rating: + description: The rating given by the user (1-5) + format: int32 + title: Rating + type: integer x-stream-index: "005" - is_moderator: - description: Whether member is channel moderator or not - title: Is moderator - type: boolean - x-stream-index: "003" - notifications_muted: - type: boolean - x-stream-index: "019" - pinned_at: - format: date-time - type: number - x-stream-index: "015" - role: - description: 'Permission level of the member in the channel (DEPRECATED: - use channel_role instead)' - enum: - - member - - moderator - - admin - - owner - title: Role + reason: + description: The reason provided by the user for the rating + title: Reason type: string - x-stream-index: "017" - shadow_banned: - description: Whether member is shadow banned in this channel or not - title: Shadow banned - type: boolean - x-stream-index: "014" - status: + x-stream-index: "006" + sdk: type: string x-stream-index: "008" - updated_at: - description: Date/time of the last update - format: date-time - title: Updated at - type: number - x-stream-index: "010" - user: - $ref: '#/components/schemas/UserResponse' - x-stream-index: "002" - user_id: - title: User ID + sdk_version: type: string - x-stream-index: "001" - required: - - custom - - created_at - - updated_at - - banned - - shadow_banned - - channel_role - - notifications_muted - title: Channel member + x-stream-index: "009" + session_id: + description: Call session ID + title: Session ID + type: string + x-stream-index: "003.001" + type: + default: call.user_feedback_submitted + description: The type of event, "call.user_feedback" in this case + title: Event Type + type: string + x-stream-index: "001.001" + user: + $ref: '#/components/schemas/UserResponse' + description: The user who submitted the feedback + title: User + x-stream-index: "004" + required: + - type + - created_at + - call_cid + - session_id + - user + - rating + title: CallUserFeedbackSubmittedEvent type: object - ChannelMute: - nullable: true + x-stream-event-call-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + CallUserMutedEvent: + description: This event is sent when a call member is muted properties: - channel: - $ref: '#/components/schemas/ChannelResponse' - description: Channel that is muted - title: Channel - x-stream-index: "002" + call_cid: + type: string + x-stream-index: "002.001" created_at: - description: Date/time of creation - format: date-time - title: Created at - type: number - x-stream-index: "004" - expires: - description: Date/time of mute expiration format: date-time - title: Expires type: number + x-stream-index: "001.002" + from_user_id: + type: string x-stream-index: "003" - updated_at: - description: Date/time of the last update - format: date-time - title: Updated at - type: number - x-stream-index: "005" - user: - $ref: '#/components/schemas/UserResponse' - description: Owner of channel mute - title: User - x-stream-index: "001" + muted_user_ids: + items: + type: string + type: array + x-stream-index: "004" + type: + default: call.user_muted + description: 'The type of event: "call.user_muted" in this case' + title: Event Type + type: string + x-stream-index: "001.001" required: + - type - created_at - - updated_at + - call_cid + - from_user_id + - muted_user_ids + title: CallUserMutedEvent type: object - ChannelOwnCapability: - description: All possibility of string to use - enum: - - ban-channel-members - - cast-poll-vote - - connect-events - - create-attachment - - delete-any-message - - delete-channel - - delete-own-message - - flag-message - - freeze-channel - - join-channel - - leave-channel - - mute-channel - - pin-message - - query-poll-votes - - quote-message - - read-events - - search-messages - - send-custom-events - - send-links - - send-message - - send-poll - - send-reaction - - send-reply - - send-restricted-visibility-message - - send-typing-events - - set-channel-cooldown - - share-location - - skip-slow-mode - - slow-mode - - typing-events - - update-any-message - - update-channel - - update-channel-members - - update-own-message - - update-thread - - upload-file - title: ChannelOwnCapability - type: string - ChannelPushPreferences: + x-stream-event-call-type: true + x-stream-event-doc-group: call + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + CallsPerDayReport: properties: - chat_level: - type: string + count: + format: int64 + type: integer x-stream-index: "001" - disabled_until: - format: date-time - type: number - x-stream-index: "002" + required: + - count type: object - ChannelResponse: - description: Represents channel in chat + CallsPerDayReportResponse: + properties: + daily: + items: + $ref: '#/components/schemas/DailyAggregateCallsPerDayReportResponse' + type: array + x-stream-index: "001" + required: + - daily + type: object + CastPollVoteRequest: + nullable: true + properties: + vote: + $ref: '#/components/schemas/VoteData' + description: Vote data + title: VoteData + x-stream-index: "004" + type: object + Channel: properties: + active_live_locations: + items: + $ref: '#/components/schemas/SharedLocation' + type: array + x-stream-index: "034" auto_translation_enabled: - description: Whether auto translation is enabled or not - title: Auto translation type: boolean - x-stream-index: "017" + x-stream-index: "029" auto_translation_language: - description: Language to translate to when auto translation is active - title: Auto translation language type: string - x-stream-index: "018" - blocked: - description: Whether this channel is blocked by current user or not - title: Blocked - type: boolean - x-stream-index: "023" + x-stream-index: "030" cid: - description: Channel CID (:) - title: CID type: string x-stream-index: "003" config: - $ref: '#/components/schemas/ChannelConfigWithInfo' - description: Channel configuration - title: ChannelConfigWithInfo - x-stream-index: "013" + $ref: '#/components/schemas/ChannelConfig' + x-stream-index: "026" + config_overrides: + $ref: '#/components/schemas/ConfigOverrides' + x-stream-index: "027" cooldown: - description: Cooldown period after sending each message format: int32 - title: Cooldown type: integer - x-stream-index: "020" + x-stream-index: "031" created_at: - description: Date/time of creation format: date-time - title: Created at type: number - x-stream-index: "005" + x-stream-index: "009" created_by: - $ref: '#/components/schemas/UserResponse' - description: Creator of the channel - title: UserResponse + $ref: '#/components/schemas/User' x-stream-index: "008" custom: additionalProperties: {} - description: Custom data for this object - title: Custom data type: object - x-stream-index: "026" + x-stream-index: "019" deleted_at: - description: Date/time of deletion format: date-time - title: Deleted at type: number - x-stream-index: "007" + x-stream-index: "011" disabled: type: boolean - x-stream-index: "010" + x-stream-index: "017" frozen: - description: Whether channel is frozen or not - title: Frozen - type: boolean - x-stream-index: "009" - hidden: - description: Whether this channel is hidden by current user or not - title: Hidden type: boolean - x-stream-index: "022" - hide_messages_before: - description: Date since when the message history is accessible - format: date-time - title: Hide messages before - type: number - x-stream-index: "019" + x-stream-index: "016" id: - description: Channel unique ID - title: ID type: string - x-stream-index: "001" + x-stream-index: "004" + invites: + items: + $ref: '#/components/schemas/ChannelMember' + type: array + x-stream-index: "022" + last_campaigns: + type: string + x-stream-index: "032" last_message_at: - description: Date of the last message sent format: date-time - title: Last message at type: number - x-stream-index: "004" + x-stream-index: "006" member_count: - description: Number of members in the channel format: int32 - title: Member count type: integer - x-stream-index: "012" + x-stream-index: "021" members: - description: List of channel members (max 100) items: $ref: '#/components/schemas/ChannelMember' - title: ChannelMembers type: array - x-stream-index: "011" - mute_expires_at: - description: Date of mute expiration - format: date-time - title: Mute expires at + x-stream-index: "020" + message_count: + format: int64 + type: integer + x-stream-index: "035" + message_count_updated_at: + format: date-time type: number - x-stream-index: "015" - muted: - description: Whether this channel is muted or not - title: Muted - type: boolean - x-stream-index: "014" - own_capabilities: - description: List of channel capabilities of authenticated user - items: - $ref: '#/components/schemas/ChannelOwnCapability' - title: ChannelOwnCapability - type: array - x-stream-index: "021" + x-stream-index: "036" team: - description: Team the channel belongs to (multi-tenant only) - title: Team type: string - x-stream-index: "016" - truncated_at: - description: Date of the latest truncation of the channel - format: date-time - title: UserResponse - type: number - x-stream-index: "024" + x-stream-index: "028" truncated_by: - $ref: '#/components/schemas/UserResponse' - x-stream-index: "025" + $ref: '#/components/schemas/User' + x-stream-index: "015" type: - description: Type of the channel - title: Type type: string - x-stream-docs-page-id: channel_features - x-stream-index: "002" + x-stream-index: "005" updated_at: - description: Date/time of the last update format: date-time - title: Updated at type: number - x-stream-index: "006" + x-stream-index: "010" required: + - cid - id - type - - cid - created_at - updated_at - frozen - disabled - custom - title: Channel + - auto_translation_language type: object - ChannelStateResponse: - nullable: true + ChannelConfig: properties: - active_live_locations: + allowed_flag_reasons: items: - $ref: '#/components/schemas/SharedLocationResponseData' + type: string type: array - x-stream-index: "001.015" - channel: - $ref: '#/components/schemas/ChannelResponse' - x-stream-index: "001.001" - draft: - $ref: '#/components/schemas/DraftResponse' - x-stream-index: "001.014" - duration: + x-stream-index: "001.027" + automod: + enum: + - disabled + - simple + - AI type: string - x-stream-index: "002.001" - hidden: - type: boolean - x-stream-index: "001.011" - hide_messages_before: - format: date-time - type: number - x-stream-index: "001.012" - members: - items: - $ref: '#/components/schemas/ChannelMember' - type: array - x-stream-index: "001.007" - membership: - $ref: '#/components/schemas/ChannelMember' - x-stream-index: "001.008" - messages: - items: - $ref: '#/components/schemas/MessageResponse' - type: array - x-stream-index: "001.002" - pending_messages: + x-stream-index: "001.022" + automod_behavior: + enum: + - flag + - block + - shadow_block + type: string + x-stream-index: "001.023" + automod_thresholds: + $ref: '#/components/schemas/Thresholds' + x-stream-index: "001.028" + blocklist: + type: string + x-stream-index: "001.024" + blocklist_behavior: + enum: + - flag + - block + - shadow_block + type: string + x-stream-index: "001.025" + blocklists: items: - $ref: '#/components/schemas/PendingMessageResponse' + $ref: '#/components/schemas/BlockListOptions' type: array - x-stream-index: "001.013" - pinned_messages: + x-stream-index: "001.026" + commands: items: - $ref: '#/components/schemas/MessageResponse' + type: string type: array - x-stream-index: "001.003" - push_preferences: - $ref: '#/components/schemas/ChannelPushPreferences' + x-stream-index: "003" + connect_events: + type: boolean + x-stream-index: "001.004" + count_messages: + type: boolean + x-stream-index: "001.019" + created_at: + format: date-time + type: number + x-stream-index: "002.003" + custom_events: + type: boolean + x-stream-index: "001.012" + mark_messages_pending: + type: boolean + x-stream-index: "001.015" + max_message_length: + format: int32 + maximum: 20000 + type: integer + x-stream-index: "001.021" + mutes: + type: boolean x-stream-index: "001.009" - read: - items: - $ref: '#/components/schemas/ReadStateResponse' - type: array - x-stream-index: "001.006" - threads: - items: - $ref: '#/components/schemas/ThreadStateResponse' - type: array - x-stream-index: "001.010" - watcher_count: + name: + type: string + x-stream-index: "001.001" + partition_size: format: int32 type: integer - x-stream-index: "001.004" - watchers: - items: - $ref: '#/components/schemas/UserResponse' - type: array + x-stream-index: "001.029" + partition_ttl: + type: integer + x-stream-index: "001.030" + polls: + type: boolean + x-stream-index: "001.016" + push_notifications: + type: boolean + x-stream-index: "001.013" + quotes: + type: boolean + x-stream-index: "001.008" + reactions: + type: boolean + x-stream-index: "001.006" + read_events: + type: boolean + x-stream-index: "001.003" + reminders: + type: boolean + x-stream-index: "001.014" + replies: + type: boolean + x-stream-index: "001.007" + search: + type: boolean x-stream-index: "001.005" + shared_locations: + type: boolean + x-stream-index: "001.018" + skip_last_msg_update_for_system_msgs: + type: boolean + x-stream-index: "001.031" + typing_events: + type: boolean + x-stream-index: "001.002" + updated_at: + format: date-time + type: number + x-stream-index: "002.004" + uploads: + type: boolean + x-stream-index: "001.010" + url_enrichment: + type: boolean + x-stream-index: "001.011" + user_message_reminders: + type: boolean + x-stream-index: "001.017" required: - - messages - - pinned_messages - - members - - threads - - duration + - name + - typing_events + - read_events + - connect_events + - search + - reactions + - replies + - quotes + - mutes + - uploads + - url_enrichment + - custom_events + - push_notifications + - reminders + - mark_messages_pending + - polls + - user_message_reminders + - shared_locations + - count_messages + - message_retention + - max_message_length + - automod + - automod_behavior + - skip_last_msg_update_for_system_msgs + - created_at + - updated_at + - commands type: object - ChannelStateResponseFields: + ChannelConfigWithInfo: properties: - active_live_locations: - description: Active live locations in the channel + allowed_flag_reasons: items: - $ref: '#/components/schemas/SharedLocationResponseData' - title: Active Live Locations + type: string type: array - x-stream-index: "015" - channel: - $ref: '#/components/schemas/ChannelResponse' - x-stream-index: "001" - draft: - $ref: '#/components/schemas/DraftResponse' - x-stream-index: "014" - hidden: - description: Whether this channel is hidden or not - title: Hidden - type: boolean - x-stream-index: "011" - hide_messages_before: - description: Messages before this date are hidden from the user - format: date-time - title: Hide messages before - type: number - x-stream-index: "012" - members: - description: List of channel members + x-stream-index: 001.002.027 + automod: + enum: + - disabled + - simple + - AI + type: string + x-stream-index: 001.002.022 + automod_behavior: + enum: + - flag + - block + - shadow_block + type: string + x-stream-index: 001.002.023 + automod_thresholds: + $ref: '#/components/schemas/Thresholds' + x-stream-index: 001.002.028 + blocklist: + type: string + x-stream-index: 001.002.024 + blocklist_behavior: + enum: + - flag + - block + - shadow_block + type: string + x-stream-index: 001.002.025 + blocklists: items: - $ref: '#/components/schemas/ChannelMember' - title: Members + $ref: '#/components/schemas/BlockListOptions' type: array - x-stream-index: "007" - membership: - $ref: '#/components/schemas/ChannelMember' - description: Current user membership object - title: Membership - x-stream-index: "008" - messages: - description: List of channel messages + x-stream-index: 001.002.026 + commands: items: - $ref: '#/components/schemas/MessageResponse' - title: Message + $ref: '#/components/schemas/Command' type: array + x-stream-index: "001.003" + connect_events: + type: boolean + x-stream-index: 001.002.004 + count_messages: + type: boolean + x-stream-index: 001.002.019 + created_at: + format: date-time + type: number + x-stream-index: 001.001.003 + custom_events: + type: boolean + x-stream-index: 001.002.012 + grants: + additionalProperties: + items: + type: string + type: array + type: object x-stream-index: "002" - pending_messages: - description: Pending messages that this user has sent - items: - $ref: '#/components/schemas/PendingMessageResponse' - title: Pending messages - type: array - x-stream-index: "013" - pinned_messages: - description: List of pinned messages in the channel - items: - $ref: '#/components/schemas/MessageResponse' - title: Pinned messages - type: array - x-stream-docs-page-id: pinned_messages - x-stream-index: "003" - push_preferences: - $ref: '#/components/schemas/ChannelPushPreferences' - x-stream-index: "009" - read: - description: List of read states - items: - $ref: '#/components/schemas/ReadStateResponse' - title: Read - type: array - x-stream-index: "006" - threads: - items: - $ref: '#/components/schemas/ThreadStateResponse' - type: array - x-stream-index: "010" - watcher_count: - description: Number of channel watchers + mark_messages_pending: + type: boolean + x-stream-index: 001.002.015 + max_message_length: format: int32 - title: Watcher count + maximum: 20000 type: integer - x-stream-index: "004" - watchers: - description: List of user who is watching the channel - items: - $ref: '#/components/schemas/UserResponse' - title: Watchers - type: array - x-stream-index: "005" + x-stream-index: 001.002.021 + mutes: + type: boolean + x-stream-index: 001.002.009 + name: + type: string + x-stream-index: 001.002.001 + partition_size: + format: int32 + type: integer + x-stream-index: 001.002.029 + partition_ttl: + example: 24h + format: duration + nullable: true + type: string + x-stream-index: 001.002.030 + polls: + type: boolean + x-stream-index: 001.002.016 + push_notifications: + type: boolean + x-stream-index: 001.002.013 + quotes: + type: boolean + x-stream-index: 001.002.008 + reactions: + type: boolean + x-stream-index: 001.002.006 + read_events: + type: boolean + x-stream-index: 001.002.003 + reminders: + type: boolean + x-stream-index: 001.002.014 + replies: + type: boolean + x-stream-index: 001.002.007 + search: + type: boolean + x-stream-index: 001.002.005 + shared_locations: + type: boolean + x-stream-index: 001.002.018 + skip_last_msg_update_for_system_msgs: + type: boolean + x-stream-index: 001.002.031 + typing_events: + type: boolean + x-stream-index: 001.002.002 + updated_at: + format: date-time + type: number + x-stream-index: 001.001.004 + uploads: + type: boolean + x-stream-index: 001.002.010 + url_enrichment: + type: boolean + x-stream-index: 001.002.011 + user_message_reminders: + type: boolean + x-stream-index: 001.002.017 required: - - messages - - pinned_messages - - members - - threads + - created_at + - updated_at + - name + - typing_events + - read_events + - connect_events + - search + - reactions + - replies + - quotes + - mutes + - uploads + - url_enrichment + - custom_events + - push_notifications + - reminders + - mark_messages_pending + - polls + - user_message_reminders + - shared_locations + - count_messages + - message_retention + - max_message_length + - automod + - automod_behavior + - skip_last_msg_update_for_system_msgs + - commands type: object - ChannelStopWatchingRequest: - nullable: true + ChannelCreatedEvent: + properties: + created_at: + format: date-time + type: number + x-stream-index: "001.002" + type: + default: channel.created + type: string + x-stream-index: "001.001" + required: + - type + - created_at + title: ChannelCreatedEvent type: object - ChannelTruncatedEvent: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + ChannelDeletedEvent: properties: channel: $ref: '#/components/schemas/ChannelResponse' - x-stream-index: "001.004" + x-stream-index: "003.004" channel_id: type: string - x-stream-index: "001.002" + x-stream-index: "003.002" channel_member_count: format: int32 type: integer - x-stream-index: "001.005" + x-stream-index: "003.005" channel_type: type: string - x-stream-index: "001.003" + x-stream-index: "003.003" cid: type: string - x-stream-index: "001.001" + x-stream-index: "003.001" created_at: format: date-time type: number x-stream-index: "002.002" + team: + type: string + x-stream-index: "001.001" type: - default: channel.truncated + default: channel.deleted type: string x-stream-index: "002.001" required: + - type + - created_at - cid - channel_id - channel_type - channel_member_count - - type - - created_at - title: ChannelTruncatedEvent + title: ChannelDeletedEvent 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 - ChannelUnFrozenEvent: + ChannelFrozenEvent: properties: channel_id: type: string @@ -5814,7 +6823,7 @@ components: type: number x-stream-index: "001.002" type: - default: channel.unfrozen + default: channel.frozen type: string x-stream-index: "001.001" required: @@ -5823,2618 +6832,2569 @@ components: - cid - channel_id - channel_type - title: ChannelUnFrozenEvent + title: ChannelFrozenEvent 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 - ChannelUpdatedEvent: + ChannelGetOrCreateRequest: + nullable: true + properties: + data: + $ref: '#/components/schemas/ChannelInput' + x-stream-index: "003" + hide_for_creator: + description: Whether this channel will be hidden for the user who created + the channel or not + title: Hide for creator + type: boolean + x-stream-index: "007" + members: + $ref: '#/components/schemas/PaginationParams' + x-stream-index: "010" + messages: + $ref: '#/components/schemas/MessagePaginationParams' + x-stream-index: "009" + presence: + description: Fetch user presence info + title: Presence + type: boolean + x-stream-index: "006" + state: + description: Refresh channel state + title: State + type: boolean + x-stream-index: "005" + thread_unread_counts: + type: boolean + x-stream-index: "008" + watch: + description: Start watching the channel + title: Watch + type: boolean + x-stream-index: "004" + watchers: + $ref: '#/components/schemas/PaginationParams' + x-stream-index: "011" + type: object + ChannelHiddenEvent: properties: channel: $ref: '#/components/schemas/ChannelResponse' - x-stream-index: "004.004" + x-stream-index: "003.004" channel_id: type: string - x-stream-index: "004.002" + x-stream-index: "003.002" channel_member_count: format: int32 type: integer - x-stream-index: "004.005" + x-stream-index: "003.005" channel_type: type: string - x-stream-index: "004.003" + x-stream-index: "003.003" cid: type: string - x-stream-index: "004.001" + x-stream-index: "003.001" + clear_history: + type: boolean + x-stream-index: "001" created_at: format: date-time type: number - x-stream-index: "003.002" - message: - $ref: '#/components/schemas/Message' - x-stream-index: "001" - team: - type: string - x-stream-index: "002.001" + x-stream-index: "004.002" type: - default: channel.updated + default: channel.hidden type: string - x-stream-index: "003.001" + x-stream-index: "004.001" user: $ref: '#/components/schemas/User' - x-stream-index: "005.001" + x-stream-index: "002.001" required: - - type - - created_at + - clear_history - cid - channel_id - channel_type - channel_member_count - title: ChannelUpdatedEvent + - type + - created_at + title: ChannelHiddenEvent 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 - ChannelVisibleEvent: + ChannelInput: + properties: + auto_translation_enabled: + description: Enable or disable auto translation + title: Auto translation + type: boolean + x-stream-index: "005" + auto_translation_language: + description: Switch auto translation language + title: Auto translation language + type: string + x-stream-index: "006" + config_overrides: + $ref: '#/components/schemas/ChannelConfig' + x-stream-index: "024" + created_by: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "009" + created_by_id: + type: string + x-stream-index: "008" + custom: + additionalProperties: {} + type: object + x-stream-index: "015" + disabled: + type: boolean + x-stream-index: "014" + frozen: + description: Freeze or unfreeze the channel + title: Frozen + type: boolean + x-stream-index: "013" + invites: + items: + $ref: '#/components/schemas/ChannelMember' + maximum: 100 + type: array + x-stream-index: "016" + members: + items: + $ref: '#/components/schemas/ChannelMember' + maximum: 100 + type: array + x-stream-index: "018" + team: + description: Team the channel belongs to (if multi-tenant mode is enabled) + title: Team + type: string + x-stream-index: "004" + truncated_by_id: + type: string + x-stream-index: "010" + type: object + ChannelKickedEvent: properties: + channel: + $ref: '#/components/schemas/ChannelResponse' + x-stream-index: "002.004" channel_id: type: string - x-stream-index: "001.002" + x-stream-index: "002.002" + channel_member_count: + format: int32 + type: integer + x-stream-index: "002.005" channel_type: type: string - x-stream-index: "001.003" + x-stream-index: "002.003" cid: type: string - x-stream-index: "001.001" + x-stream-index: "002.001" created_at: format: date-time type: number - x-stream-index: "003.002" + x-stream-index: "001.002" type: - default: channel.visible + default: channel.kicked type: string - x-stream-index: "003.001" - user: - $ref: '#/components/schemas/User' - x-stream-index: "002.001" + x-stream-index: "001.001" required: + - type + - created_at - cid - channel_id - channel_type - - type - - created_at - title: ChannelVisibleEvent + - channel_member_count + title: ChannelKickedEvent 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 - ChatActivityStatsResponse: - properties: - Messages: - $ref: '#/components/schemas/MessageStatsResponse' - x-stream-index: "001" - type: object - ClosedCaptionEvent: - description: This event is sent when closed captions are being sent in a call, - clients should use this to show the closed captions in the call screen + ChannelMember: + nullable: true properties: - call_cid: + archived_at: + format: date-time + type: number + x-stream-index: "015" + ban_expires: + description: Expiration date of the ban + format: date-time + title: Ban expires + type: number + x-stream-index: "013" + banned: + description: Whether member is banned this channel or not + title: Banned + type: boolean + x-stream-index: "012" + channel_role: + description: Role of the member in the channel + title: Channel Role type: string - x-stream-index: "002.001" - closed_caption: - $ref: '#/components/schemas/CallClosedCaption' - description: The closed caption object - title: CallClosedCaption - x-stream-index: "003" + x-stream-index: "018" created_at: + description: Date/time of creation format: date-time + title: Created at type: number - x-stream-index: "001.002" - type: - default: call.closed_caption - description: 'The type of event: "call.closed_caption" in this case' - title: Event Type - type: string - x-stream-index: "001.001" - required: - - type - - created_at - - call_cid - - closed_caption - title: ClosedCaptionEvent - type: object - x-stream-event-call-type: true - x-stream-event-doc-group: transcription - x-stream-is-event: true - x-stream-ws-base-event-name: VideoEvent - CollectUserFeedbackRequest: - nullable: true - properties: + x-stream-index: "009" custom: additionalProperties: {} type: object - x-stream-index: "009" - rating: - format: int32 - maximum: 5 - minimum: 1 - type: integer - x-stream-index: "007" - reason: - maxLength: 1000 - type: string - x-stream-index: "008" - sdk: - maxLength: 50 - type: string - x-stream-index: "005" - sdk_version: - maxLength: 50 - type: string - x-stream-index: "006" - user_session_id: - maxLength: 50 - type: string x-stream-index: "004" - required: - - sdk - - sdk_version - - rating - type: object - CollectUserFeedbackResponse: - 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 - Command: - description: Represents custom chat command - nullable: true - properties: - args: - description: Arguments help text, shown in commands auto-completion - title: Arguments - type: string + deleted_at: + format: date-time + type: number + x-stream-index: "011" + deleted_messages: + items: + type: string + type: array + x-stream-index: "020" + invite_accepted_at: + description: Date when invite was accepted + format: date-time + title: Invited accepted at + type: number x-stream-index: "006" - created_at: - description: Date/time of creation + invite_rejected_at: + description: Date when invite was rejected format: date-time - readOnly: true - title: Created at + title: Invited rejected at type: number - x-stream-index: "001" - description: - description: Description, shown in commands auto-completion - title: Description - type: string + x-stream-index: "007" + invited: + description: Whether member was invited or not + title: Invited + type: boolean x-stream-index: "005" - name: - description: Unique command name - title: Name + is_moderator: + description: Whether member is channel moderator or not + title: Is moderator + type: boolean + x-stream-index: "003" + notifications_muted: + type: boolean + x-stream-index: "019" + pinned_at: + format: date-time + type: number + x-stream-index: "016" + role: + description: 'Permission level of the member in the channel (DEPRECATED: + use channel_role instead)' + enum: + - member + - moderator + - admin + - owner + title: Role type: string - x-stream-index: "004" - set: - description: Set name used for grouping commands - title: Set + x-stream-index: "017" + shadow_banned: + description: Whether member is shadow banned in this channel or not + title: Shadow banned + type: boolean + x-stream-index: "014" + status: type: string - x-stream-index: "007" + x-stream-index: "008" updated_at: description: Date/time of the last update format: date-time - readOnly: true title: Updated at type: number + x-stream-index: "010" + user: + $ref: '#/components/schemas/UserResponse' x-stream-index: "002" - required: - - name - - description - - args - - set - title: Command - type: object - CompositeAppSettings: - properties: - json_encoded_settings: - type: string - x-stream-index: "005" - url: + user_id: + title: User ID type: string - x-stream-index: "004" + x-stream-index: "001" + required: + - custom + - created_at + - updated_at + - banned + - shadow_banned + - channel_role + - notifications_muted + title: Channel member type: object - ConfigOverrides: + ChannelMemberResponse: + nullable: true properties: - blocklist: - type: string - x-stream-index: "008" - blocklist_behavior: - enum: - - flag - - block + archived_at: + format: date-time + type: number + x-stream-index: "016" + ban_expires: + description: Expiration date of the ban + format: date-time + title: Ban expires + type: number + x-stream-index: "013" + banned: + description: Whether member is banned this channel or not + title: Banned + type: boolean + x-stream-index: "012" + channel_role: + description: Role of the member in the channel + title: Channel Role type: string + x-stream-index: "018" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number x-stream-index: "009" - commands: - items: - type: string - type: array - x-stream-index: "011" - grants: - additionalProperties: - items: - type: string - type: array + custom: + additionalProperties: {} type: object - x-stream-index: "010" - max_message_length: - format: int32 - maximum: 20000 - type: integer - x-stream-index: "007" - quotes: - type: boolean x-stream-index: "004" - reactions: + deleted_at: + format: date-time + type: number + x-stream-index: "011" + invite_accepted_at: + description: Date when invite was accepted + format: date-time + title: Invited accepted at + type: number + x-stream-index: "006" + invite_rejected_at: + description: Date when invite was rejected + format: date-time + title: Invited rejected at + type: number + x-stream-index: "007" + invited: + description: Whether member was invited or not + title: Invited type: boolean - x-stream-index: "002" - replies: + x-stream-index: "005" + is_moderator: + description: Whether member is channel moderator or not + title: Is moderator type: boolean x-stream-index: "003" - shared_locations: + notifications_muted: type: boolean - x-stream-index: "013" - typing_events: + x-stream-index: "019" + pinned_at: + format: date-time + type: number + x-stream-index: "015" + role: + description: 'Permission level of the member in the channel (DEPRECATED: + use channel_role instead)' + enum: + - member + - moderator + - admin + - owner + title: Role + type: string + x-stream-index: "017" + shadow_banned: + description: Whether member is shadow banned in this channel or not + title: Shadow banned type: boolean + x-stream-index: "014" + status: + type: string + x-stream-index: "008" + updated_at: + description: Date/time of the last update + format: date-time + title: Updated at + type: number + x-stream-index: "010" + user: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "002" + user_id: + title: User ID + type: string x-stream-index: "001" - uploads: - type: boolean - x-stream-index: "005" - url_enrichment: - type: boolean - x-stream-index: "006" - user_message_reminders: - type: boolean - x-stream-index: "012" required: - - grants - - commands - type: object - ConfigResponse: - properties: - ai_image_config: - $ref: '#/components/schemas/AIImageConfig' - description: Configuration for AI image analysis - title: AI Image Config - x-stream-index: "009" - ai_text_config: - $ref: '#/components/schemas/AITextConfig' - description: Configuration for AI text analysis - title: AI Text Config - x-stream-index: "008" - ai_video_config: - $ref: '#/components/schemas/AIVideoConfig' - description: Configuration for AI video analysis - title: AI Video Config - x-stream-index: "010" - async: - description: Whether moderation should be performed asynchronously - title: Async - type: boolean - x-stream-index: "003" - automod_platform_circumvention_config: - $ref: '#/components/schemas/AutomodPlatformCircumventionConfig' - description: Configuration for platform circumvention detection - title: Automod Platform Circumvention Config - x-stream-index: "005" - automod_semantic_filters_config: - $ref: '#/components/schemas/AutomodSemanticFiltersConfig' - description: Configuration for semantic filtering - title: Automod Semantic Filters Config - x-stream-index: "006" - automod_toxicity_config: - $ref: '#/components/schemas/AutomodToxicityConfig' - description: Configuration for toxicity detection - title: Automod Toxicity Config - x-stream-index: "004" - block_list_config: - $ref: '#/components/schemas/BlockListConfig' - description: Configuration for block list filtering - title: Block List Config - x-stream-index: "007" + - custom + - created_at + - updated_at + - banned + - shadow_banned + - channel_role + - notifications_muted + title: Channel member + type: object + ChannelMute: + nullable: true + properties: + channel: + $ref: '#/components/schemas/ChannelResponse' + description: Channel that is muted + title: Channel + x-stream-index: "002" created_at: - description: When the configuration was created + description: Date/time of creation format: date-time - title: Created At + title: Created at type: number - x-stream-index: "012" - key: - description: Unique identifier for the moderation configuration - title: Key - type: string - x-stream-index: "001" - rule_builder_config: - $ref: '#/components/schemas/RuleBuilderConfig' - x-stream-index: "015" - team: - description: Team associated with the configuration - title: Team - type: string - x-stream-index: "002" + x-stream-index: "004" + expires: + description: Date/time of mute expiration + format: date-time + title: Expires + type: number + x-stream-index: "003" updated_at: - description: When the configuration was last updated + description: Date/time of the last update format: date-time - title: Updated At + title: Updated at type: number - x-stream-index: "013" - velocity_filter_config: - $ref: '#/components/schemas/VelocityFilterConfig' - description: Configuration for velocity-based filtering - title: Velocity Filter Config - x-stream-index: "011" - video_call_rule_config: - $ref: '#/components/schemas/VideoCallRuleConfig' - x-stream-index: "014" + x-stream-index: "005" + user: + $ref: '#/components/schemas/UserResponse' + description: Owner of channel mute + title: User + x-stream-index: "001" required: - - key - - team - - async - created_at - updated_at type: object - ConnectUserDetailsRequest: + ChannelOwnCapability: + description: All possibility of string to use + enum: + - ban-channel-members + - cast-poll-vote + - connect-events + - create-attachment + - delete-any-message + - delete-channel + - delete-own-message + - flag-message + - freeze-channel + - join-channel + - leave-channel + - mute-channel + - pin-message + - query-poll-votes + - quote-message + - read-events + - search-messages + - send-custom-events + - send-links + - send-message + - send-poll + - send-reaction + - send-reply + - send-restricted-visibility-message + - send-typing-events + - set-channel-cooldown + - share-location + - skip-slow-mode + - slow-mode + - typing-events + - update-any-message + - update-channel + - update-channel-members + - update-own-message + - update-thread + - upload-file + title: ChannelOwnCapability + type: string + ChannelPushPreferences: properties: - custom: - additionalProperties: {} - type: object - x-stream-index: "004" - id: + chat_level: type: string x-stream-index: "001" - image: - type: string - x-stream-index: "003" - invisible: - type: boolean - x-stream-index: "006" - language: - type: string - x-stream-index: "005" - name: - type: string - x-stream-index: "002" - privacy_settings: - $ref: '#/components/schemas/PrivacySettingsResponse' - x-stream-index: "007" - required: - - id - type: object - ConnectedEvent: - description: This event is sent when the WS connection is established and authenticated, - this event contains the full user object as it is stored on the server - properties: - connection_id: - description: The connection_id for this client - title: Connection ID - type: string - x-stream-index: "002" - created_at: + disabled_until: format: date-time type: number - x-stream-index: "001.002" - me: - $ref: '#/components/schemas/OwnUserResponse' - description: The full user object as it is stored on the server - title: OwnUserResponse - x-stream-index: "003" - type: - default: connection.ok - description: 'The type of event: "connection.ok" in this case' - title: Event Type - type: string - x-stream-index: "001.001" - required: - - type - - created_at - - connection_id - - me - title: ConnectedEvent + x-stream-index: "002" 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 - ConnectionErrorEvent: - description: This event is sent when the WS connection fails + ChannelResponse: + description: Represents channel in chat properties: - connection_id: + auto_translation_enabled: + description: Whether auto translation is enabled or not + title: Auto translation + type: boolean + x-stream-index: "017" + auto_translation_language: + description: Language to translate to when auto translation is active + title: Auto translation language type: string - x-stream-index: "002" + x-stream-index: "018" + blocked: + description: Whether this channel is blocked by current user or not + title: Blocked + type: boolean + x-stream-index: "023" + cid: + description: Channel CID (:) + title: CID + type: string + x-stream-index: "003" + config: + $ref: '#/components/schemas/ChannelConfigWithInfo' + description: Channel configuration + title: ChannelConfigWithInfo + x-stream-index: "013" + cooldown: + description: Cooldown period after sending each message + format: int32 + title: Cooldown + type: integer + x-stream-index: "020" created_at: + description: Date/time of creation format: date-time + title: Created at type: number - x-stream-index: "001.002" - error: - $ref: '#/components/schemas/APIError' - description: The error that caused the connection to fail - title: Error - x-stream-index: "003" - type: - default: connection.error - description: 'The type of event: "connection.ok" in this case' - title: Event Type - type: string - x-stream-index: "001.001" - required: - - type - - created_at - - connection_id - - error - title: ConnectionErrorEvent - 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 - ContentCountRuleParameters: - properties: - threshold: - format: int32 - type: integer - x-stream-index: "001" - time_window: + x-stream-index: "005" + created_by: + $ref: '#/components/schemas/UserResponse' + description: Creator of the channel + title: UserResponse + x-stream-index: "008" + custom: + additionalProperties: {} + description: Custom data for this object + title: Custom data + type: object + x-stream-index: "026" + deleted_at: + description: Date/time of deletion + format: date-time + title: Deleted at + type: number + x-stream-index: "007" + disabled: + type: boolean + x-stream-index: "010" + frozen: + description: Whether channel is frozen or not + title: Frozen + type: boolean + x-stream-index: "009" + hidden: + description: Whether this channel is hidden by current user or not + title: Hidden + type: boolean + x-stream-index: "022" + hide_messages_before: + description: Date since when the message history is accessible + format: date-time + title: Hide messages before + type: number + x-stream-index: "019" + id: + description: Channel unique ID + title: ID type: string - x-stream-index: "002" - required: - - threshold - - time_window - type: object - CountByMinuteResponse: - nullable: true - properties: - count: + x-stream-index: "001" + last_message_at: + description: Date of the last message sent + format: date-time + title: Last message at + type: number + x-stream-index: "004" + member_count: + description: Number of members in the channel format: int32 + title: Member count type: integer - x-stream-index: "002" - start_ts: + x-stream-index: "012" + members: + description: List of channel members (max 100) + items: + $ref: '#/components/schemas/ChannelMember' + title: ChannelMembers + type: array + x-stream-index: "011" + message_count: + description: Number of messages in the channel + format: int64 + title: Message count + type: integer + x-stream-index: "027" + mute_expires_at: + description: Date of mute expiration format: date-time + title: Mute expires at type: number - x-stream-index: "001" - required: - - start_ts - - count - type: object - CreateBlockListRequest: - description: Block list contains restricted words - nullable: true - properties: - name: - description: Block list name - maxLength: 255 - title: Name - type: string - x-stream-index: "001" + x-stream-index: "015" + muted: + description: Whether this channel is muted or not + title: Muted + type: boolean + x-stream-index: "014" + own_capabilities: + description: List of channel capabilities of authenticated user + items: + $ref: '#/components/schemas/ChannelOwnCapability' + title: ChannelOwnCapability + type: array + x-stream-index: "021" team: + description: Team the channel belongs to (multi-tenant only) + title: Team type: string - x-stream-index: "004" + x-stream-index: "016" + truncated_at: + description: Date of the latest truncation of the channel + format: date-time + title: UserResponse + type: number + x-stream-index: "024" + truncated_by: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "025" type: - description: Block list type. - enum: - - regex - - domain - - domain_allowlist - - email - - word + description: Type of the channel title: Type type: string - x-stream-index: "003" - words: - description: List of words to block - items: - type: string - minimum: 1 - title: Words - type: array + x-stream-docs-page-id: channel_features x-stream-index: "002" + updated_at: + description: Date/time of the last update + format: date-time + title: Updated at + type: number + x-stream-index: "006" required: - - name - - words - title: Block list + - id + - type + - cid + - created_at + - updated_at + - frozen + - disabled + - custom + title: Channel type: object - x-stream-docs-page-id: block_lists - CreateBlockListResponse: - description: Basic response information + ChannelStateResponse: nullable: true properties: - blocklist: - $ref: '#/components/schemas/BlockListResponse' - x-stream-index: "001" + active_live_locations: + items: + $ref: '#/components/schemas/SharedLocationResponseData' + type: array + x-stream-index: "001.015" + channel: + $ref: '#/components/schemas/ChannelResponse' + x-stream-index: "001.001" + deleted_messages: + items: + type: string + type: array + x-stream-index: "001.016" + draft: + $ref: '#/components/schemas/DraftResponse' + x-stream-index: "001.014" duration: - description: Duration of the request in milliseconds - title: Duration type: string x-stream-index: "002.001" + hidden: + type: boolean + x-stream-index: "001.011" + hide_messages_before: + format: date-time + type: number + x-stream-index: "001.012" + members: + items: + $ref: '#/components/schemas/ChannelMember' + type: array + x-stream-index: "001.007" + membership: + $ref: '#/components/schemas/ChannelMember' + x-stream-index: "001.008" + messages: + items: + $ref: '#/components/schemas/MessageResponse' + type: array + x-stream-index: "001.002" + pending_messages: + items: + $ref: '#/components/schemas/PendingMessageResponse' + type: array + x-stream-index: "001.013" + pinned_messages: + items: + $ref: '#/components/schemas/MessageResponse' + type: array + x-stream-index: "001.003" + push_preferences: + $ref: '#/components/schemas/ChannelPushPreferences' + x-stream-index: "001.009" + read: + items: + $ref: '#/components/schemas/ReadStateResponse' + type: array + x-stream-index: "001.006" + threads: + items: + $ref: '#/components/schemas/ThreadStateResponse' + type: array + x-stream-index: "001.010" + watcher_count: + format: int32 + type: integer + x-stream-index: "001.004" + watchers: + items: + $ref: '#/components/schemas/UserResponse' + type: array + x-stream-index: "001.005" required: + - messages + - pinned_messages + - members + - threads - duration - title: Response type: object - CreateDeviceRequest: - description: Create device request - nullable: true + ChannelStateResponseFields: properties: - id: - description: Device ID - maxLength: 255 - minLength: 1 - title: ID - type: string + active_live_locations: + description: Active live locations in the channel + items: + $ref: '#/components/schemas/SharedLocationResponseData' + title: Active Live Locations + type: array + x-stream-index: "015" + channel: + $ref: '#/components/schemas/ChannelResponse' x-stream-index: "001" - push_provider: - description: Push provider - enum: - - firebase - - apn - - huawei - - xiaomi - title: PushProvider - type: string + deleted_messages: + items: + type: string + type: array + x-stream-index: "016" + draft: + $ref: '#/components/schemas/DraftResponse' + x-stream-index: "014" + hidden: + description: Whether this channel is hidden or not + title: Hidden + type: boolean + x-stream-index: "011" + hide_messages_before: + description: Messages before this date are hidden from the user + format: date-time + title: Hide messages before + type: number + x-stream-index: "012" + members: + description: List of channel members + items: + $ref: '#/components/schemas/ChannelMember' + title: Members + type: array + x-stream-index: "007" + membership: + $ref: '#/components/schemas/ChannelMember' + description: Current user membership object + title: Membership + x-stream-index: "008" + messages: + description: List of channel messages + items: + $ref: '#/components/schemas/MessageResponse' + title: Message + type: array x-stream-index: "002" - push_provider_name: - description: Push provider name - title: PushProviderName - type: string + pending_messages: + description: Pending messages that this user has sent + items: + $ref: '#/components/schemas/PendingMessageResponse' + title: Pending messages + type: array + x-stream-index: "013" + pinned_messages: + description: List of pinned messages in the channel + items: + $ref: '#/components/schemas/MessageResponse' + title: Pinned messages + type: array + x-stream-docs-page-id: pinned_messages x-stream-index: "003" - voip_token: - description: When true the token is for Apple VoIP push notifications - title: VoipToken - type: boolean + push_preferences: + $ref: '#/components/schemas/ChannelPushPreferences' + x-stream-index: "009" + read: + description: List of read states + items: + $ref: '#/components/schemas/ReadStateResponse' + title: Read + type: array + x-stream-index: "006" + threads: + items: + $ref: '#/components/schemas/ThreadStateResponse' + type: array + x-stream-index: "010" + watcher_count: + description: Number of channel watchers + format: int32 + title: Watcher count + type: integer x-stream-index: "004" + watchers: + description: List of user who is watching the channel + items: + $ref: '#/components/schemas/UserResponse' + title: Watchers + type: array + x-stream-index: "005" required: - - id - - push_provider - title: CreateDeviceRequest + - messages + - pinned_messages + - members + - threads type: object - CreateDraftRequest: + ChannelStopWatchingRequest: nullable: true - properties: - message: - $ref: '#/components/schemas/MessageRequest' - x-stream-index: "001" - required: - - message type: object - CreateDraftResponse: - description: Basic response information - nullable: true + ChannelTruncatedEvent: properties: - draft: - $ref: '#/components/schemas/DraftResponse' - x-stream-index: "001" - duration: - description: Duration of the request in milliseconds - title: Duration + channel: + $ref: '#/components/schemas/ChannelResponse' + x-stream-index: "001.004" + channel_id: + type: string + x-stream-index: "001.002" + channel_member_count: + format: int32 + type: integer + x-stream-index: "001.005" + channel_type: + type: string + x-stream-index: "001.003" + cid: + type: string + x-stream-index: "001.001" + created_at: + format: date-time + type: number + x-stream-index: "002.002" + type: + default: channel.truncated type: string x-stream-index: "002.001" required: - - draft - - duration - title: Response + - cid + - channel_id + - channel_type + - channel_member_count + - type + - created_at + title: ChannelTruncatedEvent type: object - CreateGuestRequest: - nullable: true + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + ChannelUnFrozenEvent: properties: - user: - $ref: '#/components/schemas/UserRequest' - description: User object which server acts upon - title: User - x-stream-index: "001" + channel_id: + type: string + x-stream-index: "002.002" + channel_type: + type: string + x-stream-index: "002.003" + cid: + type: string + x-stream-index: "002.001" + created_at: + format: date-time + type: number + x-stream-index: "001.002" + type: + default: channel.unfrozen + type: string + x-stream-index: "001.001" required: - - user + - type + - created_at + - cid + - channel_id + - channel_type + title: ChannelUnFrozenEvent type: object - CreateGuestResponse: - nullable: true + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + ChannelUpdatedEvent: properties: - access_token: - description: the access token to authenticate the user - title: Access token + channel: + $ref: '#/components/schemas/ChannelResponse' + x-stream-index: "004.004" + channel_id: type: string - x-stream-index: "002" - duration: - description: Duration of the request in milliseconds - title: Duration + x-stream-index: "004.002" + channel_member_count: + format: int32 + type: integer + x-stream-index: "004.005" + channel_type: + type: string + x-stream-index: "004.003" + cid: + type: string + x-stream-index: "004.001" + created_at: + format: date-time + type: number + x-stream-index: "003.002" + message: + $ref: '#/components/schemas/Message' + x-stream-index: "001" + team: + type: string + x-stream-index: "002.001" + type: + default: channel.updated type: string x-stream-index: "003.001" user: - $ref: '#/components/schemas/UserResponse' - description: User object which server acts upon - title: User - x-stream-index: "001" + $ref: '#/components/schemas/User' + x-stream-index: "005.001" required: - - user - - access_token - - duration + - type + - created_at + - cid + - channel_id + - channel_type + - channel_member_count + title: ChannelUpdatedEvent type: object - CreatePollOptionRequest: - nullable: true - properties: - Custom: - additionalProperties: {} - type: object - writeOnly: true - x-stream-index: "003" - text: - description: Option text - title: string - type: string - x-stream-index: "002" - required: - - text - type: object - CreatePollRequest: - description: Contains all information needed to create a new poll - nullable: true + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + ChannelVisibleEvent: properties: - Custom: - additionalProperties: {} - type: object - writeOnly: true - x-stream-index: "011" - allow_answers: - description: Indicates whether users can suggest user defined answers - title: Allow answers - type: boolean - x-stream-index: "009" - allow_user_suggested_options: - type: boolean - x-stream-index: "008" - description: - description: A description of the poll - title: Description - type: string - x-stream-index: "003" - enforce_unique_vote: - description: Indicates whether users can cast multiple votes - title: Multiple choice - type: boolean - x-stream-index: "006" - id: - maxLength: 255 + channel_id: type: string - x-stream-index: "001" - is_closed: - description: Indicates whether the poll is open for voting - title: Is closed - type: boolean - x-stream-index: "010" - max_votes_allowed: - description: Indicates the maximum amount of votes a user can cast - format: int32 - maximum: 10 - title: Maximum votes allowed - type: integer - x-stream-index: "007" - name: - description: The name of the poll - title: Name + x-stream-index: "001.002" + channel_type: type: string - x-stream-index: "002" - options: - items: - $ref: '#/components/schemas/PollOptionInput' - maximum: 100 - type: array - x-stream-index: "004" - voting_visibility: - enum: - - anonymous - - public + x-stream-index: "001.003" + cid: type: string - x-stream-index: "005" - required: - - name - title: Create Poll Request - type: object - CreateReminderRequest: - nullable: true - properties: - remind_at: + x-stream-index: "001.001" + created_at: format: date-time type: number - x-stream-index: "001" - type: object - Credentials: - properties: - ice_servers: - items: - $ref: '#/components/schemas/ICEServer' - type: array - x-stream-index: "003" - server: - $ref: '#/components/schemas/SFUResponse' - x-stream-index: "001" - token: + x-stream-index: "003.002" + type: + default: channel.visible type: string - x-stream-index: "002" + x-stream-index: "003.001" + user: + $ref: '#/components/schemas/User' + x-stream-index: "002.001" required: - - server - - token - - ice_servers + - cid + - channel_id + - channel_type + - type + - created_at + title: ChannelVisibleEvent type: object - CustomActionRequest: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + ChatActivityStatsResponse: properties: - id: - type: string + Messages: + $ref: '#/components/schemas/MessageStatsResponse' x-stream-index: "001" - options: - additionalProperties: {} - type: object - x-stream-index: "002" type: object - CustomVideoEvent: - description: A custom event, this event is used to send custom events to other - participants in the call. + ClosedCaptionEvent: + description: This event is sent when closed captions are being sent in a call, + clients should use this to show the closed captions in the call screen properties: call_cid: type: string x-stream-index: "002.001" + closed_caption: + $ref: '#/components/schemas/CallClosedCaption' + description: The closed caption object + title: CallClosedCaption + x-stream-index: "003" created_at: format: date-time type: number x-stream-index: "001.002" - custom: - additionalProperties: {} - description: Custom data for this object - title: Custom data - type: object - x-stream-index: "003" type: - default: custom - description: The type of event, "custom" in this case + default: call.closed_caption + description: 'The type of event: "call.closed_caption" in this case' title: Event Type type: string x-stream-index: "001.001" - user: - $ref: '#/components/schemas/UserResponse' - x-stream-index: "004" required: - type - created_at - call_cid - - custom - - user - title: CustomVideoEvent + - closed_caption + title: ClosedCaptionEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: other + x-stream-event-doc-group: transcription x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - DailyAggregateCallDurationReportResponse: + CollectUserFeedbackRequest: + nullable: true properties: - date: + custom: + additionalProperties: {} + type: object + x-stream-index: "009" + rating: + format: int32 + maximum: 5 + minimum: 1 + type: integer + x-stream-index: "007" + reason: + maxLength: 1000 type: string - x-stream-index: "001" - report: - $ref: '#/components/schemas/CallDurationReport' - x-stream-index: "002" - required: - - date - - report - type: object - DailyAggregateCallParticipantCountReportResponse: - properties: - date: + x-stream-index: "008" + sdk: + maxLength: 50 type: string - x-stream-index: "001" - report: - $ref: '#/components/schemas/CallParticipantCountReport' - x-stream-index: "002" - required: - - date - - report - type: object - DailyAggregateCallsPerDayReportResponse: - properties: - date: + x-stream-index: "005" + sdk_version: + maxLength: 50 type: string - x-stream-index: "001" - report: - $ref: '#/components/schemas/CallsPerDayReport' - x-stream-index: "002" - required: - - date - - report - type: object - DailyAggregateQualityScoreReportResponse: - properties: - date: + x-stream-index: "006" + user_session_id: + maxLength: 50 type: string - x-stream-index: "001" - report: - $ref: '#/components/schemas/QualityScoreReport' - x-stream-index: "002" + x-stream-index: "004" required: - - date - - report + - sdk + - sdk_version + - rating type: object - DailyAggregateSDKUsageReportResponse: + CollectUserFeedbackResponse: + description: Basic response information + nullable: true properties: - date: + duration: + description: Duration of the request in milliseconds + title: Duration type: string - x-stream-index: "001" - report: - $ref: '#/components/schemas/SDKUsageReport' - x-stream-index: "002" + x-stream-index: "001.001" required: - - date - - report + - duration + title: Response type: object - DailyAggregateUserFeedbackReportResponse: + Command: + description: Represents custom chat command + nullable: true properties: - date: + args: + description: Arguments help text, shown in commands auto-completion + title: Arguments type: string + x-stream-index: "006" + created_at: + description: Date/time of creation + format: date-time + readOnly: true + title: Created at + type: number x-stream-index: "001" - report: - $ref: '#/components/schemas/UserFeedbackReport' - x-stream-index: "002" - required: - - date - - report - type: object - Data: - properties: - id: + description: + description: Description, shown in commands auto-completion + title: Description type: string - x-stream-index: "001" - required: - - id - type: object - DeleteActivityRequest: - properties: - hard_delete: - type: boolean - x-stream-index: "001" - type: object - DeleteCallRequest: - description: DeleteCallRequest is the payload for deleting a call. - nullable: true - properties: - hard: - description: if true the call will be hard deleted along with all related - data - title: Hard - type: boolean - x-stream-index: "001" - title: DeleteCallRequest - type: object - DeleteCallResponse: - description: DeleteCallResponse is the payload for deleting a call. - nullable: true - properties: - call: - $ref: '#/components/schemas/CallResponse' - title: Call - x-stream-index: "001" - duration: + x-stream-index: "005" + name: + description: Unique command name + title: Name type: string - x-stream-index: "003.001" - task_id: - title: TaskID + x-stream-index: "004" + set: + description: Set name used for grouping commands + title: Set type: string + x-stream-index: "007" + updated_at: + description: Date/time of the last update + format: date-time + readOnly: true + title: Updated at + type: number x-stream-index: "002" required: - - call - - duration - title: DeleteCallResponse + - name + - description + - args + - set + title: Command type: object - DeleteChannelResponse: - description: Basic response information + CommentAddedEvent: + description: Emitted when a comment is added to an activity. nullable: true properties: - channel: - $ref: '#/components/schemas/ChannelResponse' + activity: + $ref: '#/components/schemas/ActivityResponse' x-stream-index: "002" - duration: - description: Duration of the request in milliseconds - title: Duration + comment: + $ref: '#/components/schemas/CommentResponse' + description: The comment that was added + title: Text + x-stream-index: "001" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 003.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 003.001.007 + feed_visibility: type: string - x-stream-index: "001.001" + x-stream-index: "003.003" + fid: + type: string + x-stream-index: "003.002" + received_at: + format: date-time + type: number + x-stream-index: 003.001.004 + type: + default: feeds.comment.added + description: 'The type of event: "feeds.comment.added" in this case' + title: Event Type + type: string + x-stream-index: 003.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who added the comment + title: User + x-stream-index: "004.001" required: - - duration - title: Response + - comment + - activity + - type + - created_at + - custom + - fid + title: CommentAddedEvent type: object - DeleteChannelsRequest: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + CommentDeletedEvent: + description: Emitted when a comment is deleted. nullable: true properties: - cids: - description: All channels that should be deleted - items: - type: string - maximum: 100 - minimum: 1 - title: Channels CID - type: array + comment: + $ref: '#/components/schemas/CommentResponse' x-stream-index: "001" - hard_delete: - description: Specify if channels and all ressources should be hard deleted - title: Hard delete - type: boolean - x-stream-index: "002" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + feed_visibility: + type: string + x-stream-index: "002.003" + fid: + type: string + x-stream-index: "002.002" + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 + type: + default: feeds.comment.deleted + description: 'The type of event: "feeds.comment.deleted" in this case' + title: Event Type + type: string + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who deleted the comment + title: User + x-stream-index: "003.001" required: - - cids + - comment + - type + - created_at + - custom + - fid + title: CommentDeletedEvent type: object - DeleteChannelsResponse: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + CommentReactionAddedEvent: + description: Emitted when a reaction is added to a comment. nullable: true properties: - duration: - description: Duration of the request in milliseconds - title: Duration - type: string - x-stream-index: "003.001" - result: - additionalProperties: - $ref: '#/components/schemas/DeleteChannelsResultResponse' - description: Map of channel IDs and their deletion results - title: Result - type: object + activity: + $ref: '#/components/schemas/ActivityResponse' + x-stream-index: "003" + comment: + $ref: '#/components/schemas/CommentResponse' x-stream-index: "001" - task_id: + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 004.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 004.001.007 + feed_visibility: + type: string + x-stream-index: "004.003" + fid: type: string + x-stream-index: "004.002" + reaction: + $ref: '#/components/schemas/FeedsReactionResponse' + description: The reaction that was added + title: Reaction x-stream-index: "002" + received_at: + format: date-time + type: number + x-stream-index: 004.001.004 + type: + default: feeds.comment.reaction.added + description: 'The type of event: "feeds.comment.reaction.added" in this + case' + title: Event Type + type: string + x-stream-index: 004.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who added the reaction + title: User + x-stream-index: "005.001" required: - - duration + - comment + - reaction + - activity + - type + - created_at + - custom + - fid + title: CommentReactionAddedEvent type: object - DeleteChannelsResultResponse: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + CommentReactionDeletedEvent: + description: Emitted when a reaction is deleted from a comment. nullable: true properties: - error: + comment: + $ref: '#/components/schemas/CommentResponse' + x-stream-index: "001" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 003.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 003.001.007 + feed_visibility: + type: string + x-stream-index: "003.003" + fid: type: string + x-stream-index: "003.002" + reaction: + $ref: '#/components/schemas/FeedsReactionResponse' x-stream-index: "002" - status: + received_at: + format: date-time + type: number + x-stream-index: 003.001.004 + type: + default: feeds.comment.reaction.deleted + description: The type of reaction that was removed + title: Type type: string - x-stream-index: "001" + x-stream-index: 003.001.002 required: - - status - type: object - DeleteMessageRequest: - properties: - hard_delete: - type: boolean - x-stream-index: "001" + - comment + - reaction + - type + - created_at + - custom + - fid + title: CommentReactionDeletedEvent type: object - DeleteMessageResponse: - description: Basic response information + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + CommentReactionUpdatedEvent: + description: Emitted when a reaction is updated on a comment. nullable: true properties: - duration: - description: Duration of the request in milliseconds - title: Duration - type: string - x-stream-index: "002.001" - message: - $ref: '#/components/schemas/MessageResponse' - x-stream-index: "001" - required: - - message - - duration - title: Response - type: object - DeleteModerationConfigResponse: - nullable: true - properties: - duration: - type: string - x-stream-index: "001.001" - required: - - duration - type: object - DeleteReactionRequest: - properties: - hard_delete: - type: boolean - x-stream-index: "001" - type: object - DeleteReactionResponse: - description: Basic response information - nullable: true - properties: - duration: - description: Duration of the request in milliseconds - title: Duration - type: string - x-stream-index: "003.001" - message: - $ref: '#/components/schemas/MessageResponse' - x-stream-index: "001" - reaction: - $ref: '#/components/schemas/ReactionResponse' - x-stream-index: "002" - required: - - message - - reaction - - duration - title: Response - type: object - DeleteRecordingResponse: - description: Response for DeleteRecording - nullable: true - properties: - duration: - description: Duration of the request in milliseconds - title: Duration - type: string - x-stream-index: "001.001" - required: - - duration - title: DeleteRecordingResponse - type: object - DeleteReminderResponse: - 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 - DeleteTranscriptionResponse: - description: DeleteTranscriptionResponse is the payload for deleting a transcription. - nullable: true - properties: - duration: - description: Duration of the request in milliseconds - title: Duration - type: string - x-stream-index: "001.001" - required: - - duration - title: DeleteTranscriptionResponse - type: object - DeleteUserRequest: - properties: - delete_conversation_channels: - type: boolean - x-stream-index: "003" - delete_feeds_content: - type: boolean - x-stream-index: "004" - hard_delete: - type: boolean - x-stream-index: "001" - mark_messages_deleted: - type: boolean - x-stream-index: "002" - type: object - Device: - nullable: true - properties: - created_at: - format: date-time - type: number - x-stream-index: "002.002" - disabled: - type: boolean - x-stream-index: "002.003" - disabled_reason: - type: string - x-stream-index: "002.004" - id: - type: string - x-stream-index: 002.001.004 - push_provider: - enum: - - firebase - - apn - - huawei - - xiaomi - type: string - x-stream-index: 002.001.001 - push_provider_name: - type: string - x-stream-index: 002.001.003 - user_id: - type: string - x-stream-index: "004" - voip: - type: boolean - x-stream-index: 002.001.005 - required: - - push_provider - - id - - created_at - - user_id - type: object - DeviceResponse: - description: Response for Device - nullable: true - properties: - created_at: - description: Date/time of creation - format: date-time - title: Created at - type: number - x-stream-index: "004" - disabled: - description: Whether device is disabled or not - title: Disabled - type: boolean - x-stream-index: "005" - disabled_reason: - description: Reason explaining why device had been disabled - title: Reason - type: string - x-stream-index: "006" - id: - description: Device ID - title: ID - type: string + activity: + $ref: '#/components/schemas/ActivityResponse' x-stream-index: "003" - push_provider: - description: Push provider - title: PushProvider - type: string + comment: + $ref: '#/components/schemas/CommentResponse' x-stream-index: "001" - push_provider_name: - description: Push provider name - title: PushProviderName - type: string - x-stream-index: "002" - user_id: - description: User ID - title: UserID - type: string - x-stream-index: "008" - voip: - description: When true the token is for Apple VoIP push notifications - title: Voip - type: boolean - x-stream-index: "007" - required: - - push_provider - - id - - created_at - - user_id - title: DeviceResponse - type: object - DraftDeletedEvent: - description: Emitted when a Draft is deleted. - nullable: true - properties: - cid: - description: The CID of the channel where the draft was created - title: Channel CID - type: string - x-stream-index: 001.001.002 created_at: description: Date/time of creation format: date-time title: Created at type: number - x-stream-index: 001.001.001.003 + x-stream-index: 004.001.003 custom: additionalProperties: {} type: object - x-stream-index: 001.001.001.007 - draft: - $ref: '#/components/schemas/DraftResponse' - x-stream-index: "001.003" - parent_id: - description: The ID of the parent message - title: Message ID + x-stream-index: 004.001.007 + feed_visibility: type: string - x-stream-index: "001.002" + x-stream-index: "004.003" + fid: + type: string + x-stream-index: "004.002" + reaction: + $ref: '#/components/schemas/FeedsReactionResponse' + description: The reaction that was updated + title: Reaction + x-stream-index: "002" received_at: format: date-time type: number - x-stream-index: 001.001.001.004 + x-stream-index: 004.001.004 type: - default: draft.deleted - description: 'The type of event: "draft.deleted" in this case' + default: feeds.comment.reaction.updated + description: 'The type of event: "feeds.comment.reaction.updated" in this + case' title: Event Type type: string - x-stream-index: 001.001.001.002 + x-stream-index: 004.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who updated the reaction + title: User + x-stream-index: "005.001" required: + - comment + - reaction + - activity - type - created_at - custom - title: DraftDeletedEvent + - fid + title: CommentReactionUpdatedEvent 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 - DraftPayloadResponse: + CommentResponse: properties: attachments: items: $ref: '#/components/schemas/Attachment' type: array - x-stream-index: "004" + x-stream-index: "011" + confidence_score: + description: Confidence score of the comment + format: float + title: Confidence Score + type: number + x-stream-index: "022" + controversy_score: + description: Controversy score of the comment + format: float + title: Controversy Score + type: number + x-stream-index: "023" + created_at: + description: When the comment was created + format: date-time + title: Created At + type: number + x-stream-index: "014" custom: additionalProperties: {} + description: Custom data for the comment + title: Custom Data type: object - x-stream-index: "007" - html: - type: string - x-stream-index: "010" + x-stream-index: "006" + deleted_at: + description: When the comment was deleted + format: date-time + title: Deleted At + type: number + x-stream-index: "016" + downvote_count: + description: Number of downvotes for this comment + format: int32 + title: Downvote Count + type: integer + x-stream-index: "020" id: + description: Unique identifier for the comment + title: ID type: string x-stream-index: "001" - mentioned_users: + latest_reactions: + description: Recent reactions to the comment items: - $ref: '#/components/schemas/UserResponse' + $ref: '#/components/schemas/FeedsReactionResponse' + title: Latest Reactions type: array - x-stream-index: "008" - mml: + x-stream-index: "009" + mentioned_users: + description: Users mentioned in the comment + items: + $ref: '#/components/schemas/UserResponse' + title: Mention Users + type: array + x-stream-index: "012" + moderation: + $ref: '#/components/schemas/ModerationV2Response' + x-stream-index: "017" + object_id: + description: ID of the object this comment is associated with + title: Object ID + type: string + x-stream-index: "002" + object_type: + description: Type of the object this comment is associated with + title: Object Type type: string x-stream-index: "003" + own_reactions: + description: Current user's reactions to this activity + items: + $ref: '#/components/schemas/FeedsReactionResponse' + title: Own Reactions + type: array + x-stream-index: "024" parent_id: + description: ID of parent comment for nested replies + title: Parent ID type: string - x-stream-index: "005" - poll_id: + x-stream-index: "007" + reaction_count: + description: Number of reactions to this comment + format: int32 + title: Reaction Count + type: integer + x-stream-index: "008" + reaction_groups: + additionalProperties: + $ref: '#/components/schemas/ReactionGroupResponse' + description: Grouped reactions by type + title: Reaction Groups + type: object + x-stream-index: "010" + reply_count: + description: Number of replies to this comment + format: int32 + title: Reply Count + type: integer + x-stream-index: "018" + score: + description: Score of the comment based on reactions + format: int32 + title: Score + type: integer + x-stream-index: "021" + status: + description: Status of the comment (e.g., active, deleted) + title: Status type: string x-stream-index: "013" - quoted_message_id: - type: string - x-stream-index: "009" - show_in_channel: - type: boolean - x-stream-index: "006" - silent: - type: boolean - x-stream-index: "012" text: + description: Text content of the comment + title: Text type: string - x-stream-index: "002" - type: - type: string - x-stream-index: "011" - required: - - id - - text - - custom - type: object - DraftResponse: - properties: - channel: - $ref: '#/components/schemas/ChannelResponse' - x-stream-index: "003" - channel_cid: - type: string - x-stream-index: "002" - created_at: + x-stream-index: "005" + updated_at: + description: When the comment was last updated format: date-time + title: Updated At type: number - x-stream-index: "007" - message: - $ref: '#/components/schemas/DraftPayloadResponse' - x-stream-index: "001" - parent_id: - type: string + x-stream-index: "015" + upvote_count: + description: Number of upvotes for this comment + format: int32 + title: Upvote Count + type: integer + x-stream-index: "019" + user: + $ref: '#/components/schemas/UserResponse' + description: User who created the comment + title: User x-stream-index: "004" - parent_message: - $ref: '#/components/schemas/MessageResponse' - x-stream-index: "005" - quoted_message: - $ref: '#/components/schemas/MessageResponse' - x-stream-index: "006" required: - - message - - channel_cid + - id + - object_id + - object_type + - user + - reaction_count + - mentioned_users + - status - created_at + - updated_at + - reply_count + - upvote_count + - downvote_count + - score + - confidence_score + - own_reactions + title: Comment type: object - DraftUpdatedEvent: - description: Emitted when a Draft is created or updated. + CommentUpdatedEvent: + description: Emitted when a comment is updated. nullable: true properties: - cid: - description: The CID of the channel where the draft was created/updated - title: Channel CID - type: string - x-stream-index: 001.001.002 + comment: + $ref: '#/components/schemas/CommentResponse' + description: The comment that was updated + title: Text + x-stream-index: "001" created_at: description: Date/time of creation format: date-time title: Created at type: number - x-stream-index: 001.001.001.003 + x-stream-index: 002.001.003 custom: additionalProperties: {} type: object - x-stream-index: 001.001.001.007 - draft: - $ref: '#/components/schemas/DraftResponse' - description: The draft object which was created/updated - title: Draft - x-stream-index: "001.003" - parent_id: - description: The ID of the parent message - title: Parent ID + x-stream-index: 002.001.007 + feed_visibility: type: string - x-stream-index: "001.002" + x-stream-index: "002.003" + fid: + type: string + x-stream-index: "002.002" received_at: format: date-time type: number - x-stream-index: 001.001.001.004 + x-stream-index: 002.001.004 type: - default: draft.updated - description: 'The type of event: "draft.updated" in this case' + default: feeds.comment.updated + description: 'The type of event: "feeds.comment.updated" in this case' title: Event Type type: string - x-stream-index: 001.001.001.002 + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who updated the comment + title: User + x-stream-index: "003.001" required: + - comment - type - created_at - custom - title: DraftUpdatedEvent + - fid + title: CommentUpdatedEvent 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 - EdgeResponse: + CompositeAppSettings: properties: - continent_code: - type: string - x-stream-index: "007.003" - country_iso_code: - type: string - x-stream-index: "007.002" - green: - format: int32 - type: integer - x-stream-index: "003" - id: - type: string - x-stream-index: "001" - latency_test_url: + json_encoded_settings: type: string - x-stream-index: "002" - latitude: - format: float - type: number - x-stream-index: "006.001" - longitude: - format: float - type: number - x-stream-index: "006.002" - red: - format: int32 - type: integer x-stream-index: "005" - subdivision_iso_code: + url: type: string - x-stream-index: "007.001" - yellow: - format: int32 - type: integer x-stream-index: "004" - required: - - id - - latency_test_url - - green - - yellow - - red - - latitude - - longitude - - subdivision_iso_code - - country_iso_code - - continent_code - type: object - EgressHLSResponse: - properties: - playlist_url: - type: string - x-stream-index: "001" - status: - type: string - x-stream-index: "002" - required: - - playlist_url - - status type: object - EgressRTMPResponse: + ConfigOverrides: properties: - name: - type: string - x-stream-index: "001" - started_at: - format: date-time - type: number - x-stream-index: "004" - stream_key: + blocklist: type: string - x-stream-index: "003" - stream_url: + x-stream-index: "008" + blocklist_behavior: + enum: + - flag + - block type: string - x-stream-index: "002" - required: - - name - - started_at - type: object - EgressResponse: - properties: - broadcasting: + x-stream-index: "009" + commands: + items: + type: string + type: array + x-stream-index: "011" + count_messages: + type: boolean + x-stream-index: "014" + grants: + additionalProperties: + items: + type: string + type: array + type: object + x-stream-index: "010" + max_message_length: + format: int32 + maximum: 20000 + type: integer + x-stream-index: "007" + quotes: type: boolean - x-stream-index: "001" - frame_recording: - $ref: '#/components/schemas/FrameRecordingResponse' x-stream-index: "004" - hls: - $ref: '#/components/schemas/EgressHLSResponse' + reactions: + type: boolean x-stream-index: "002" - rtmps: - items: - $ref: '#/components/schemas/EgressRTMPResponse' - type: array + replies: + type: boolean x-stream-index: "003" - required: - - broadcasting - - rtmps + shared_locations: + type: boolean + x-stream-index: "013" + typing_events: + type: boolean + x-stream-index: "001" + uploads: + type: boolean + x-stream-index: "005" + url_enrichment: + type: boolean + x-stream-index: "006" + user_message_reminders: + type: boolean + x-stream-index: "012" + required: + - grants + - commands type: object - EgressTaskConfig: + ConfigResponse: properties: - egress_user: - $ref: '#/components/schemas/EgressUser' + ai_image_config: + $ref: '#/components/schemas/AIImageConfig' + description: Configuration for AI image analysis + title: AI Image Config + x-stream-index: "010" + ai_text_config: + $ref: '#/components/schemas/AITextConfig' + description: Configuration for AI text analysis + title: AI Text Config x-stream-index: "008" - frame_recording_egress_config: - $ref: '#/components/schemas/FrameRecordingEgressConfig' - x-stream-index: "009" - hls_egress_config: - $ref: '#/components/schemas/HLSEgressConfig' - x-stream-index: "007" - recording_egress_config: - $ref: '#/components/schemas/RecordingEgressConfig' + ai_video_config: + $ref: '#/components/schemas/AIVideoConfig' + description: Configuration for AI video analysis + title: AI Video Config + x-stream-index: "011" + async: + description: Whether moderation should be performed asynchronously + title: Async + type: boolean + x-stream-index: "003" + automod_platform_circumvention_config: + $ref: '#/components/schemas/AutomodPlatformCircumventionConfig' + description: Configuration for platform circumvention detection + title: Automod Platform Circumvention Config + x-stream-index: "005" + automod_semantic_filters_config: + $ref: '#/components/schemas/AutomodSemanticFiltersConfig' + description: Configuration for semantic filtering + title: Automod Semantic Filters Config x-stream-index: "006" - rtmp_egress_config: - $ref: '#/components/schemas/RTMPEgressConfig' + automod_toxicity_config: + $ref: '#/components/schemas/AutomodToxicityConfig' + description: Configuration for toxicity detection + title: Automod Toxicity Config x-stream-index: "004" - stt_egress_config: - $ref: '#/components/schemas/STTEgressConfig' - x-stream-index: "005" - type: object - EgressUser: - properties: - token: + block_list_config: + $ref: '#/components/schemas/BlockListConfig' + description: Configuration for block list filtering + title: Block List Config + x-stream-index: "007" + created_at: + description: When the configuration was created + format: date-time + title: Created At + type: number + x-stream-index: "013" + key: + description: Unique identifier for the moderation configuration + title: Key type: string - x-stream-index: "004" - type: object - EndCallRequest: - description: Request for ending a call - nullable: true - title: EndCallRequest - type: object - EndCallResponse: - description: Response for ending a call - nullable: true - properties: - duration: - description: Duration of the request in milliseconds - title: Duration + x-stream-index: "001" + llm_config: + $ref: '#/components/schemas/LLMConfig' + description: Configuration for customer-configured LLM moderation + title: LLM Config + x-stream-index: "009" + team: + description: Team associated with the configuration + title: Team type: string - x-stream-index: "001.001" + x-stream-index: "002" + updated_at: + description: When the configuration was last updated + format: date-time + title: Updated At + type: number + x-stream-index: "014" + velocity_filter_config: + $ref: '#/components/schemas/VelocityFilterConfig' + description: Configuration for velocity-based filtering + title: Velocity Filter Config + x-stream-index: "012" + video_call_rule_config: + $ref: '#/components/schemas/VideoCallRuleConfig' + x-stream-index: "015" required: - - duration - title: EndCallResponse + - key + - team + - async + - created_at + - updated_at type: object - EnrichedActivity: + ConnectUserDetailsRequest: properties: - actor: - $ref: '#/components/schemas/Data' - x-stream-index: "002" - foreign_id: - type: string - x-stream-index: "005" + custom: + additionalProperties: {} + type: object + x-stream-index: "004" id: type: string x-stream-index: "001" - latest_reactions: - additionalProperties: - items: - $ref: '#/components/schemas/EnrichedReaction' - type: array - type: object - x-stream-index: "013" - object: - $ref: '#/components/schemas/Data' - x-stream-index: "004" - origin: - $ref: '#/components/schemas/Data' - x-stream-index: "008" - own_reactions: - additionalProperties: - items: - $ref: '#/components/schemas/EnrichedReaction' - type: array - type: object - x-stream-index: "012" - reaction_counts: - additionalProperties: - format: int32 - type: integer - type: object - x-stream-index: "011" - score: - format: float - type: number - x-stream-index: "010" - target: - $ref: '#/components/schemas/Data' - x-stream-index: "006" - to: - items: - type: string - type: array - x-stream-index: "009" - verb: + image: type: string x-stream-index: "003" - type: object - EnrichedReaction: - nullable: true - properties: - activity_id: + invisible: + type: boolean + x-stream-index: "006" + language: type: string - x-stream-index: "003" - children_counts: - additionalProperties: - format: int32 - type: integer - type: object - x-stream-index: "010" - created_at: - $ref: '#/components/schemas/Time' - x-stream-index: "012" - data: - additionalProperties: {} - type: object x-stream-index: "005" - id: - type: string - x-stream-index: "001" - kind: + name: type: string x-stream-index: "002" - latest_children: - additionalProperties: - items: - $ref: '#/components/schemas/EnrichedReaction' - type: array - type: object - x-stream-index: "008" - own_children: - additionalProperties: - items: - $ref: '#/components/schemas/EnrichedReaction' - type: array - type: object - x-stream-index: "009" - parent: - type: string + privacy_settings: + $ref: '#/components/schemas/PrivacySettingsResponse' x-stream-index: "007" - target_feeds: - items: - type: string - type: array - x-stream-index: "006" - updated_at: - $ref: '#/components/schemas/Time' - x-stream-index: "013" - user: - $ref: '#/components/schemas/Data' - x-stream-index: "011" - user_id: - type: string - x-stream-index: "004" required: - - kind - - activity_id - - user_id + - id type: object - EntityCreator: + ConnectedEvent: + description: This event is sent when the WS connection is established and authenticated, + this event contains the full user object as it is stored on the server properties: - avg_response_time: - format: int32 - readOnly: true - type: integer - x-stream-index: "001.046" - ban_count: - format: int32 - type: integer - x-stream-index: "002" - ban_expires: - format: date-time - type: number - x-stream-index: "001.017" - banned: - type: boolean - x-stream-index: "001.016" + connection_id: + description: The connection_id for this client + title: Connection ID + type: string + x-stream-index: "002" created_at: format: date-time - readOnly: true - type: number - x-stream-index: "001.008" - custom: - additionalProperties: {} - type: object - x-stream-index: "001.006" - deactivated_at: - format: date-time - readOnly: true - type: number - x-stream-index: "001.014" - deleted_at: - format: date-time - readOnly: true type: number - x-stream-index: "001.013" - deleted_content_count: - format: int32 - type: integer + x-stream-index: "001.002" + me: + $ref: '#/components/schemas/OwnUserResponse' + description: The full user object as it is stored on the server + title: OwnUserResponse x-stream-index: "003" - id: + type: + default: connection.ok + description: 'The type of event: "connection.ok" in this case' + title: Event Type type: string - x-stream-index: "001.003" - invisible: - type: boolean - x-stream-index: "001.023" - language: + x-stream-index: "001.001" + required: + - type + - created_at + - connection_id + - me + title: ConnectedEvent + 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 + ConnectionErrorEvent: + description: This event is sent when the WS connection fails + properties: + connection_id: type: string - x-stream-index: "001.035" - last_active: - format: date-time - readOnly: true - type: number - x-stream-index: "001.011" - last_engaged_at: - format: date-time - readOnly: true - type: number - x-stream-index: "001.012" - online: - readOnly: true - type: boolean - x-stream-index: "001.022" - privacy_settings: - $ref: '#/components/schemas/PrivacySettings' - x-stream-index: "001.026" - revoke_tokens_issued_before: + x-stream-index: "002" + created_at: format: date-time type: number - x-stream-index: "001.042" - role: + x-stream-index: "001.002" + error: + $ref: '#/components/schemas/APIError' + description: The error that caused the connection to fail + title: Error + x-stream-index: "003" + type: + default: connection.error + description: 'The type of event: "connection.ok" in this case' + title: Event Type type: string - x-stream-index: "001.004" - teams: - items: - type: string - type: array - x-stream-index: "001.036" - teams_role: - additionalProperties: - type: string - type: object - x-stream-index: "001.005" - updated_at: - format: date-time - readOnly: true - type: number - x-stream-index: "001.009" + x-stream-index: "001.001" required: - - id - - role - - teams_role - - custom - - banned - - online - - ban_count - - deleted_content_count + - type + - created_at + - connection_id + - error + title: ConnectionErrorEvent type: object - EntityCreatorResponse: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + ContentCountRuleParameters: properties: - avg_response_time: - format: int32 - type: integer - x-stream-index: 001.001.018 - ban_count: - description: Number of minor actions performed on the user + threshold: format: int32 - title: Ban Count type: integer + x-stream-index: "001" + time_window: + type: string x-stream-index: "002" - banned: - type: boolean - x-stream-index: 001.001.012 - blocked_user_ids: - items: - type: string - type: array - x-stream-index: 001.001.017 - created_at: - format: date-time - type: number - x-stream-index: 001.001.009 - custom: - additionalProperties: {} - type: object - x-stream-index: 001.001.004 - deactivated_at: - format: date-time - type: number - x-stream-index: 001.001.016 - deleted_at: - format: date-time - type: number - x-stream-index: 001.001.011 - deleted_content_count: - description: Number of major actions performed on the user - format: int32 - title: Deleted Content Count - type: integer - x-stream-index: "003" - flagged_count: - description: Number of flag actions performed on the user + type: object + CountByMinuteResponse: + nullable: true + properties: + count: format: int32 - title: Flagged Count type: integer - x-stream-index: "004" - id: - type: string - x-stream-index: 001.001.001 - image: - type: string - x-stream-index: 001.001.003 - language: - type: string - x-stream-index: 001.001.005 - last_active: + x-stream-index: "002" + start_ts: format: date-time type: number - x-stream-index: 001.001.014 + x-stream-index: "001" + required: + - start_ts + - count + type: object + CreateBlockListRequest: + description: Block list contains restricted words + nullable: true + properties: name: + description: Block list name + maxLength: 255 + title: Name type: string - x-stream-index: 001.001.002 - online: - type: boolean - x-stream-index: 001.001.013 - revoke_tokens_issued_before: - format: date-time - type: number - x-stream-index: 001.001.015 - role: + x-stream-index: "001" + team: type: string - x-stream-index: 001.001.006 - teams: + x-stream-index: "004" + type: + description: Block list type. + enum: + - regex + - domain + - domain_allowlist + - email + - word + title: Type + type: string + x-stream-index: "003" + words: + description: List of words to block items: type: string + minimum: 1 + title: Words type: array - x-stream-index: 001.001.007 - teams_role: - additionalProperties: - type: string - type: object - x-stream-index: 001.001.008 - updated_at: - format: date-time - type: number - x-stream-index: 001.001.010 + x-stream-index: "002" required: - - id - - custom - - language - - role - - teams - - created_at - - updated_at - - banned - - online - - blocked_user_ids - - shadow_banned - - invisible - - ban_count - - deleted_content_count - - flagged_count - type: object - EventNotificationSettings: - properties: - apns: - $ref: '#/components/schemas/APNS' - x-stream-index: "002" - enabled: - type: boolean - x-stream-index: "001" - fcm: - $ref: '#/components/schemas/FCM' - x-stream-index: "003" - required: - - enabled - - apns - - fcm - type: object - EventRequest: - properties: - custom: - additionalProperties: {} - type: object - x-stream-index: "003" - parent_id: - type: string - x-stream-index: "002" - type: - type: string - x-stream-index: "001" - required: - - type + - name + - words + title: Block list type: object - EventResponse: + x-stream-docs-page-id: block_lists + CreateBlockListResponse: description: Basic response information nullable: true properties: + blocklist: + $ref: '#/components/schemas/BlockListResponse' + x-stream-index: "001" duration: description: Duration of the request in milliseconds title: Duration type: string x-stream-index: "002.001" - event: - $ref: '#/components/schemas/WSEvent' - x-stream-index: "001" required: - - event - duration title: Response type: object - ExternalStorage: + CreateDeviceRequest: + description: Create device request + nullable: true properties: - abs_account_name: - type: string - x-stream-index: "011" - abs_client_id: - type: string - x-stream-index: "013" - abs_client_secret: - type: string - x-stream-index: "014" - abs_tenant_id: - type: string - x-stream-index: "012" - bucket: - type: string - x-stream-index: "005" - gcs_credentials: - type: string - x-stream-index: "010" - path: - type: string - x-stream-index: "006" - s3_api_key: - type: string - x-stream-index: "007" - s3_custom_endpoint: - type: string - x-stream-index: "016" - s3_region: + id: + description: Device ID + maxLength: 255 + minLength: 1 + title: ID type: string - x-stream-index: "009" - s3_secret_key: + x-stream-index: "001" + push_provider: + description: Push provider + enum: + - firebase + - apn + - huawei + - xiaomi + title: PushProvider type: string - x-stream-index: "008" - storage_name: + x-stream-index: "002" + push_provider_name: + description: Push provider name + title: PushProviderName type: string - x-stream-index: "015" - storage_type: - type: integer + x-stream-index: "003" + voip_token: + description: When true the token is for Apple VoIP push notifications + title: VoipToken + type: boolean x-stream-index: "004" + required: + - id + - push_provider + title: CreateDeviceRequest type: object - FCM: + CreateDraftRequest: + nullable: true properties: - data: - additionalProperties: {} - type: object + message: + $ref: '#/components/schemas/MessageRequest' x-stream-index: "001" + required: + - message type: object - Field: + CreateDraftResponse: + description: Basic response information nullable: true properties: - short: - type: boolean - x-stream-index: "003" - title: - type: string + draft: + $ref: '#/components/schemas/DraftResponse' x-stream-index: "001" - value: + duration: + description: Duration of the request in milliseconds + title: Duration type: string - x-stream-index: "002" + x-stream-index: "002.001" required: - - title - - value - - short + - draft + - duration + title: Response type: object - FileUploadConfig: + CreateFeedsBatchRequest: + nullable: true properties: - allowed_file_extensions: + feeds: + description: List of feeds to create items: - type: string + $ref: '#/components/schemas/FeedRequest' + maximum: 1000 + minimum: 1 + title: Feeds type: array x-stream-index: "001" - allowed_mime_types: - items: - type: string - type: array - x-stream-index: "003" - blocked_file_extensions: - items: - type: string - type: array - x-stream-index: "002" - blocked_mime_types: - items: - type: string - type: array - x-stream-index: "004" - size_limit: - format: int32 - maximum: 104857600 - minimum: 0 - type: integer - x-stream-index: "005" required: - - allowed_file_extensions - - blocked_file_extensions - - allowed_mime_types - - blocked_mime_types - - size_limit + - feeds + title: Create Feeds Batch Request type: object - FileUploadRequest: + CreateFeedsBatchResponse: nullable: true properties: - file: - description: file field - title: File + duration: type: string + x-stream-index: "002.001" + feeds: + description: List of created feeds + items: + $ref: '#/components/schemas/FeedResponse' + title: Feeds + type: array x-stream-index: "001" + required: + - feeds + - duration + title: Create Feeds Batch Response + type: object + CreateGuestRequest: + nullable: true + properties: user: - $ref: '#/components/schemas/OnlyUserID' - description: user for the request **server side only** + $ref: '#/components/schemas/UserRequest' + description: User object which server acts upon title: User - x-stream-index: "002" + x-stream-index: "001" + required: + - user type: object - FileUploadResponse: + CreateGuestResponse: nullable: true properties: + access_token: + description: the access token to authenticate the user + title: Access token + type: string + x-stream-index: "002" duration: description: Duration of the request in milliseconds title: Duration type: string x-stream-index: "003.001" - file: - description: URL to the uploaded asset. Should be used to put to `asset_url` - attachment field - title: File - type: string + user: + $ref: '#/components/schemas/UserResponse' + description: User object which server acts upon + title: User x-stream-index: "001" - thumb_url: - description: URL of the file thumbnail for supported file formats. Should - be put to `thumb_url` attachment field - title: Thumbnail URL - type: string - x-stream-index: "002" required: + - user + - access_token - duration type: object - Flag: - description: Contains information about flagged user or message + CreatePollOptionRequest: nullable: true properties: - created_at: - description: Date/time of creation - format: date-time - title: Created at - type: number - x-stream-index: "019" - custom: + Custom: additionalProperties: {} - description: Additional metadata about the flag - title: Custom type: object - x-stream-index: "014" - entity_creator_id: - description: ID of the user who created the flagged entity - title: Entity Creator ID - type: string - x-stream-index: "009" - entity_id: - description: Unique identifier of the entity being flagged - title: Entity ID + writeOnly: true + x-stream-index: "003" + text: + description: Option text + title: string type: string - x-stream-index: "008" - entity_type: - description: Type of entity being flagged (e.g., message, user) - title: Entity Type + x-stream-index: "002" + required: + - text + type: object + CreatePollRequest: + description: Contains all information needed to create a new poll + nullable: true + properties: + Custom: + additionalProperties: {} + type: object + writeOnly: true + x-stream-index: "011" + allow_answers: + description: Indicates whether users can suggest user defined answers + title: Allow answers + type: boolean + x-stream-index: "009" + allow_user_suggested_options: + type: boolean + x-stream-index: "008" + description: + description: A description of the poll + title: Description type: string - x-stream-index: "007" - is_streamed_content: + x-stream-index: "003" + enforce_unique_vote: + description: Indicates whether users can cast multiple votes + title: Multiple choice type: boolean - x-stream-index: "012" - labels: - description: Labels from bodyguard, API calls, our own AI etc - items: - type: string - title: Labels - type: array - x-stream-index: "015" - moderation_payload: - $ref: '#/components/schemas/ModerationPayload' - description: Content being flagged - title: Moderation Payload - x-stream-index: "010" - moderation_payload_hash: + x-stream-index: "006" + id: + maxLength: 255 type: string - x-stream-index: "011" - reason: - description: Optional explanation for why the content is being flagged - title: Reason + x-stream-index: "001" + is_closed: + description: Indicates whether the poll is open for voting + title: Is closed + type: boolean + x-stream-index: "010" + max_votes_allowed: + description: Indicates the maximum amount of votes a user can cast + format: int32 + maximum: 10 + title: Maximum votes allowed + type: integer + x-stream-index: "007" + name: + description: The name of the poll + title: Name type: string - x-stream-index: "013" - result: - description: Result of bodyguard, API calls, our own AI etc + x-stream-index: "002" + options: items: - additionalProperties: {} - type: object - title: Result + $ref: '#/components/schemas/PollOptionInput' + maximum: 100 type: array - x-stream-index: "016" - review_queue_item: - $ref: '#/components/schemas/ReviewQueueItem' - x-stream-index: "018" - review_queue_item_id: - description: ID of the review queue item - title: Review Queue Item ID - type: string - x-stream-index: "017" - type: - type: string x-stream-index: "004" - updated_at: - description: Date/time of the last update + voting_visibility: + enum: + - anonymous + - public + type: string + x-stream-index: "005" + required: + - name + title: Create Poll Request + type: object + CreateReminderRequest: + nullable: true + properties: + remind_at: format: date-time - title: Updated at type: number - x-stream-index: "020" - user: - $ref: '#/components/schemas/User' - description: User who flagged a message or a user - title: User - x-stream-index: "006" - required: - - entity_type - - entity_id - - result - - created_at - - updated_at - title: Flag + x-stream-index: "001" type: object - FlagContentOptions: + Credentials: properties: - reason: - type: string + ice_servers: + items: + $ref: '#/components/schemas/ICEServer' + type: array + x-stream-index: "003" + server: + $ref: '#/components/schemas/SFUResponse' x-stream-index: "001" + token: + type: string + x-stream-index: "002" required: - - reason + - server + - token + - ice_servers type: object - FlagDetails: + CustomActionRequest: properties: - Extra: + id: + type: string + x-stream-index: "001" + options: additionalProperties: {} type: object - writeOnly: true x-stream-index: "002" - automod: - $ref: '#/components/schemas/AutomodDetails' - x-stream-index: "001" - original_text: - type: string - x-stream-index: "003" - required: - - Extra - - original_text type: object - FlagFeedback: + CustomVideoEvent: + description: A custom event, this event is used to send custom events to other + participants in the call. properties: + call_cid: + type: string + x-stream-index: "002.001" created_at: format: date-time type: number - x-stream-index: "005" - labels: - items: - $ref: '#/components/schemas/Label' - type: array - x-stream-index: "006" - message_id: + x-stream-index: "001.002" + custom: + additionalProperties: {} + description: Custom data for this object + title: Custom data + type: object + x-stream-index: "003" + type: + default: custom + description: The type of event, "custom" in this case + title: Event Type type: string + x-stream-index: "001.001" + user: + $ref: '#/components/schemas/UserResponse' x-stream-index: "004" required: - - message_id + - type - created_at - - labels + - call_cid + - custom + - user + title: CustomVideoEvent type: object - FlagMessageDetails: + x-stream-event-call-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + DailyAggregateCallDurationReportResponse: properties: - pin_changed: - type: boolean - x-stream-index: "002" - should_enrich: - type: boolean - x-stream-index: "003" - skip_push: - type: boolean - x-stream-index: "004" - updated_by_id: + date: type: string x-stream-index: "001" + report: + $ref: '#/components/schemas/CallDurationReport' + x-stream-index: "002" + required: + - date + - report type: object - FlagRequest: - nullable: true + DailyAggregateCallParticipantCountReportResponse: properties: - custom: - additionalProperties: {} - description: Additional metadata about the flag - title: Custom - type: object - x-stream-index: "006" - entity_creator_id: - description: ID of the user who created the flagged entity - title: Entity Creator ID - type: string - x-stream-index: "003" - entity_id: - description: Unique identifier of the entity being flagged - title: Entity ID - type: string - x-stream-index: "002" - entity_type: - description: Type of entity being flagged (e.g., message, user) - title: Entity Type + date: type: string x-stream-index: "001" - moderation_payload: - $ref: '#/components/schemas/ModerationPayload' - description: Content being flagged - title: Moderation Payload - x-stream-index: "005" - reason: - description: Optional explanation for why the content is being flagged - maxLength: 255 - title: Reason - type: string - x-stream-index: "004" + report: + $ref: '#/components/schemas/CallParticipantCountReport' + x-stream-index: "002" required: - - entity_type - - entity_id + - date + - report type: object - FlagResponse: - nullable: true + DailyAggregateCallsPerDayReportResponse: properties: - duration: - type: string - x-stream-index: "002.001" - item_id: - description: Unique identifier of the created moderation item - title: Item ID + date: type: string x-stream-index: "001" + report: + $ref: '#/components/schemas/CallsPerDayReport' + x-stream-index: "002" required: - - item_id - - duration + - date + - report type: object - FlagUserOptions: + DailyAggregateQualityScoreReportResponse: properties: - reason: + date: type: string x-stream-index: "001" + report: + $ref: '#/components/schemas/QualityScoreReport' + x-stream-index: "002" required: - - reason + - date + - report type: object - FrameRecordSettings: + DailyAggregateSDKUsageReportResponse: properties: - capture_interval_in_seconds: - format: int32 - maximum: 60 - minimum: 2 - type: integer - x-stream-index: "003" - mode: - enum: - - available - - disabled - - auto-on + date: type: string x-stream-index: "001" - quality: - type: string + report: + $ref: '#/components/schemas/SDKUsageReport' x-stream-index: "002" required: - - mode - - capture_interval_in_seconds - type: object - FrameRecordingEgressConfig: - properties: - capture_interval_in_seconds: - format: int32 - type: integer - x-stream-index: "007" - external_storage: - $ref: '#/components/schemas/ExternalStorage' - x-stream-index: "006" - quality: - $ref: '#/components/schemas/Quality' - x-stream-index: "004" - storage_name: - type: string - x-stream-index: "005" + - date + - report type: object - FrameRecordingResponse: + DailyAggregateUserFeedbackReportResponse: properties: - status: + date: type: string x-stream-index: "001" + report: + $ref: '#/components/schemas/UserFeedbackReport' + x-stream-index: "002" required: - - status + - date + - report type: object - FrameRecordingSettingsRequest: + Data: properties: - capture_interval_in_seconds: - format: int32 - maximum: 60 - minimum: 2 - type: integer - x-stream-index: "003" - mode: - enum: - - available - - disabled - - auto-on + id: type: string x-stream-index: "001" - quality: - enum: - - 360p - - 480p - - 720p - - 1080p - - 1440p - type: string - x-stream-index: "002" required: - - mode - - capture_interval_in_seconds + - id type: object - FrameRecordingSettingsResponse: + DecayFunctionConfig: properties: - capture_interval_in_seconds: - format: int32 - maximum: 60 - minimum: 2 - type: integer - x-stream-index: "003" - mode: - enum: - - available - - disabled - - auto-on + base: type: string x-stream-index: "001" - quality: + decay: + type: string + x-stream-index: "005" + direction: + type: string + x-stream-index: "006" + offset: + type: string + x-stream-index: "004" + origin: type: string x-stream-index: "002" - required: - - mode - - capture_interval_in_seconds + scale: + type: string + x-stream-index: "003" type: object - FullUserResponse: + DeleteActivitiesRequest: + nullable: true properties: - avg_response_time: - format: int32 - type: integer - x-stream-index: "001.018" - ban_expires: - format: date-time - type: number - x-stream-index: "015" - banned: + hard_delete: + description: Whether to permanently delete the activities + title: Hard Delete type: boolean - x-stream-index: "001.012" - blocked_user_ids: + x-stream-index: "002" + ids: + description: List of activity IDs to delete items: type: string + minimum: 1 + title: Activity IDs type: array - x-stream-index: "014" - channel_mutes: - items: - $ref: '#/components/schemas/ChannelMute' - type: array - x-stream-index: "007" - created_at: - format: date-time - type: number - x-stream-index: "001.009" - custom: - additionalProperties: {} - type: object - x-stream-index: "001.004" - deactivated_at: - format: date-time - type: number - x-stream-index: "001.016" - deleted_at: - format: date-time - type: number - x-stream-index: "001.011" - devices: + x-stream-index: "001" + required: + - ids + title: Delete Activities Request + type: object + DeleteActivitiesResponse: + nullable: true + properties: + deleted_ids: + description: List of activity IDs that were successfully deleted items: - $ref: '#/components/schemas/DeviceResponse' + type: string + title: Deleted Activity IDs type: array - x-stream-index: "004" - id: + x-stream-index: "001" + duration: type: string - x-stream-index: "001.001" - image: + x-stream-index: "002.001" + required: + - deleted_ids + - duration + title: Delete Activities Response + type: object + DeleteActivityReactionResponse: + nullable: true + properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + x-stream-index: "001" + duration: type: string - x-stream-index: "001.003" - invisible: + x-stream-index: "003.001" + reaction: + $ref: '#/components/schemas/FeedsReactionResponse' + x-stream-index: "002" + required: + - activity + - reaction + - duration + title: Delete Activity Reaction Response + type: object + DeleteActivityRequest: + properties: + hard_delete: type: boolean - x-stream-index: "005" - language: + x-stream-index: "001" + type: object + DeleteActivityResponse: + nullable: true + properties: + duration: type: string - x-stream-index: "001.005" - last_active: - format: date-time - type: number - x-stream-index: "001.014" - latest_hidden_channels: - items: - type: string - type: array - x-stream-index: "012" - mutes: - items: - $ref: '#/components/schemas/UserMuteResponse' - type: array - x-stream-index: "006" - name: + x-stream-index: "001.001" + required: + - duration + title: Delete Activity Response + type: object + DeleteBookmarkFolderResponse: + nullable: true + properties: + duration: type: string - x-stream-index: "001.002" - online: - type: boolean - x-stream-index: "001.013" - privacy_settings: - $ref: '#/components/schemas/PrivacySettingsResponse' - x-stream-index: "003" - revoke_tokens_issued_before: - format: date-time - type: number - x-stream-index: "001.015" - role: + x-stream-index: "001.001" + required: + - duration + title: Delete Bookmark Folder Response + type: object + DeleteBookmarkResponse: + nullable: true + properties: + bookmark: + $ref: '#/components/schemas/BookmarkResponse' + description: The deleted bookmark + title: Bookmark + x-stream-index: "001" + duration: type: string - x-stream-index: "001.006" - shadow_banned: - type: boolean - x-stream-index: "013" - teams: - items: - type: string - type: array - x-stream-index: "001.007" - teams_role: - additionalProperties: - type: string - type: object - x-stream-index: "001.008" - total_unread_count: - format: int32 - type: integer - x-stream-index: "009" - unread_channels: - format: int32 - type: integer - x-stream-index: "010" - unread_count: - format: int32 - type: integer - x-stream-index: "008" - unread_threads: - format: int32 - type: integer - x-stream-index: "011" - updated_at: - format: date-time - type: number - x-stream-index: "001.010" - required: - - id - - custom - - language - - role - - teams - - created_at - - updated_at - - banned - - online - - devices - - invisible - - mutes - - channel_mutes - - unread_count - - total_unread_count - - unread_channels - - unread_threads - - shadow_banned - - blocked_user_ids - type: object - GeofenceSettings: - properties: - names: - items: - type: string - type: array - x-stream-index: "001" + x-stream-index: "002.001" required: - - names + - bookmark + - duration + title: Delete Bookmark Response type: object - GeofenceSettingsRequest: + DeleteCallRequest: + description: DeleteCallRequest is the payload for deleting a call. + nullable: true properties: - names: - items: - type: string - type: array + hard: + description: if true the call will be hard deleted along with all related + data + title: Hard + type: boolean x-stream-index: "001" + title: DeleteCallRequest type: object - GeofenceSettingsResponse: + DeleteCallResponse: + description: DeleteCallResponse is the payload for deleting a call. + nullable: true properties: - names: - items: - type: string - type: array + call: + $ref: '#/components/schemas/CallResponse' + title: Call x-stream-index: "001" + duration: + type: string + x-stream-index: "003.001" + task_id: + title: TaskID + type: string + x-stream-index: "002" required: - - names + - call + - duration + title: DeleteCallResponse type: object - GetApplicationResponse: + DeleteChannelResponse: description: Basic response information nullable: true properties: - app: - $ref: '#/components/schemas/AppResponseFields' - x-stream-index: "001" + channel: + $ref: '#/components/schemas/ChannelResponse' + x-stream-index: "002" duration: description: Duration of the request in milliseconds title: Duration type: string - x-stream-index: "002.001" + x-stream-index: "001.001" required: - - app - duration title: Response type: object - GetBlockedUsersResponse: + DeleteChannelsRequest: nullable: true properties: - blocks: - description: Array of blocked user object + cids: + description: All channels that should be deleted items: - $ref: '#/components/schemas/BlockedUserResponse' - title: Blocks + type: string + maximum: 100 + minimum: 1 + title: Channels CID type: array x-stream-index: "001" - duration: - description: Duration of the request in milliseconds - title: Duration - type: string - x-stream-index: "002.001" + hard_delete: + description: Specify if channels and all ressources should be hard deleted + title: Hard delete + type: boolean + x-stream-index: "002" required: - - blocks - - duration + - cids type: object - GetCallReportResponse: - description: Basic response information + DeleteChannelsResponse: nullable: true properties: - chat_activity: - $ref: '#/components/schemas/ChatActivityStatsResponse' - x-stream-index: "004" duration: description: Duration of the request in milliseconds title: Duration type: string - x-stream-index: "001.001" - report: - $ref: '#/components/schemas/ReportResponse' - x-stream-index: "003" - session_id: + x-stream-index: "003.001" + result: + additionalProperties: + $ref: '#/components/schemas/DeleteChannelsResultResponse' + description: Map of channel IDs and their deletion results + title: Result + type: object + x-stream-index: "001" + task_id: type: string x-stream-index: "002" - video_reactions: - items: - $ref: '#/components/schemas/VideoReactionsResponse' - type: array - x-stream-index: "005" required: - duration - - session_id - - report - title: Response type: object - GetCallResponse: + DeleteChannelsResultResponse: nullable: true properties: - call: - $ref: '#/components/schemas/CallResponse' - x-stream-index: "001.001" + error: + type: string + x-stream-index: "002" + status: + type: string + x-stream-index: "001" + required: + - status + type: object + DeleteCommentReactionResponse: + nullable: true + properties: + comment: + $ref: '#/components/schemas/CommentResponse' + description: The comment after reaction removal + title: Comment + x-stream-index: "001" duration: type: string - x-stream-index: "002.001" - members: - items: - $ref: '#/components/schemas/MemberResponse' - type: array - x-stream-index: "001.002" - membership: - $ref: '#/components/schemas/MemberResponse' - x-stream-index: "001.003" - own_capabilities: - items: - $ref: '#/components/schemas/OwnCapability' - type: array - x-stream-index: "001.004" + x-stream-index: "003.001" + reaction: + $ref: '#/components/schemas/FeedsReactionResponse' + description: The removed reaction + title: Reaction + x-stream-index: "002" required: - - call - - members - - own_capabilities - - blocked_users + - comment + - reaction - duration - title: GetCallResponse + title: Delete Comment Reaction Response type: object - GetConfigResponse: + DeleteCommentResponse: nullable: true properties: - config: - $ref: '#/components/schemas/ConfigResponse' - description: The retrieved moderation configuration - title: Config - x-stream-index: "001" duration: type: string - x-stream-index: "002.001" + x-stream-index: "001.001" required: - duration + title: Delete Comment Response type: object - GetDraftResponse: - description: Basic response information + DeleteFeedResponse: nullable: true properties: - draft: - $ref: '#/components/schemas/DraftResponse' - x-stream-index: "001" duration: - description: Duration of the request in milliseconds - title: Duration type: string - x-stream-index: "002.001" + x-stream-index: "001.001" required: - - draft - duration - title: Response + title: Delete Feed Response type: object - GetEdgesResponse: + DeleteMessageRequest: + properties: + hard_delete: + type: boolean + x-stream-index: "001" + type: object + DeleteMessageResponse: description: Basic response information nullable: true properties: @@ -8443,34 +9403,30 @@ components: title: Duration type: string x-stream-index: "002.001" - edges: - items: - $ref: '#/components/schemas/EdgeResponse' - type: array + message: + $ref: '#/components/schemas/MessageResponse' x-stream-index: "001" required: - - edges + - message - duration title: Response type: object - GetManyMessagesResponse: + DeleteModerationConfigResponse: nullable: true properties: duration: type: string - x-stream-index: 001.002.001 - messages: - description: List of messages - items: - $ref: '#/components/schemas/MessageResponse' - title: Messages - type: array x-stream-index: "001.001" required: - - messages - duration type: object - GetMessageResponse: + DeleteReactionRequest: + properties: + hard_delete: + type: boolean + x-stream-index: "001" + type: object + DeleteReactionResponse: description: Basic response information nullable: true properties: @@ -8480,203 +9436,31 @@ components: type: string x-stream-index: "003.001" message: - $ref: '#/components/schemas/MessageWithChannelResponse' + $ref: '#/components/schemas/MessageResponse' x-stream-index: "001" - pending_message_metadata: - additionalProperties: - type: string - type: object + reaction: + $ref: '#/components/schemas/ReactionResponse' x-stream-index: "002" required: - message + - reaction - duration title: Response type: object - GetOGResponse: + DeleteRecordingResponse: + description: Response for DeleteRecording nullable: true properties: - actions: - items: - $ref: '#/components/schemas/Action' - type: array - x-stream-index: "001.015" - asset_url: - description: URL of detected video or audio - title: Image URL - type: string - x-stream-index: "001.017" - author_icon: - type: string - x-stream-index: "001.007" - author_link: - description: og:site - title: Author Link - type: string - x-stream-index: "001.006" - author_name: - description: og:site_name - title: Author Name - type: string - x-stream-index: "001.005" - color: - type: string - x-stream-index: "001.003" - custom: - additionalProperties: {} - type: object - x-stream-index: "001.018" duration: + description: Duration of the request in milliseconds + title: Duration type: string - x-stream-index: "002.001" - fallback: - type: string - x-stream-index: "001.002" - fields: - items: - $ref: '#/components/schemas/Field' - type: array - x-stream-index: "001.016" - footer: - type: string - x-stream-index: "001.013" - footer_icon: - type: string - x-stream-index: "001.014" - giphy: - $ref: '#/components/schemas/Images' - x-stream-index: "001.019" - image_url: - description: URL of detected image - title: Image URL - type: string - x-stream-index: "001.011" - og_scrape_url: - description: extracted url from the text - title: OG Scrape URL - type: string - x-stream-index: "001.020" - original_height: - format: int32 - type: integer - x-stream-index: "001.022" - original_width: - format: int32 - type: integer - x-stream-index: "001.021" - pretext: - type: string - x-stream-index: "001.004" - text: - description: og:description - title: Text - type: string - x-stream-index: "001.010" - thumb_url: - description: URL of detected thumb image - title: Image URL - type: string - x-stream-index: "001.012" - title: - description: og:title - title: Title - type: string - x-stream-index: "001.008" - title_link: - description: og:url - title: Title Link - type: string - x-stream-index: "001.009" - type: - description: Attachment type, could be empty, image, audio or video - title: Type - type: string - x-stream-index: "001.001" - required: - - custom - - duration - title: Get OG Attachment - type: object - x-stream-docs-page-id: og - GetOrCreateCallRequest: - nullable: true - properties: - data: - $ref: '#/components/schemas/CallRequest' - title: ReadOnlyData - x-stream-index: "003" - members_limit: - format: int32 - maximum: 100 - type: integer - x-stream-index: "007" - notify: - description: if provided it sends a notification event to the members for - this call - title: Notify - type: boolean - x-stream-index: "005" - ring: - description: if provided it sends a ring event to the members for this call - title: Ring - type: boolean - x-stream-index: "004" - video: - type: boolean - x-stream-index: "006" - title: GetOrCreateCallRequest - type: object - GetOrCreateCallResponse: - nullable: true - properties: - call: - $ref: '#/components/schemas/CallResponse' x-stream-index: "001.001" - created: - type: boolean - x-stream-index: "002" - duration: - type: string - x-stream-index: "003.001" - members: - items: - $ref: '#/components/schemas/MemberResponse' - type: array - x-stream-index: "001.002" - membership: - $ref: '#/components/schemas/MemberResponse' - x-stream-index: "001.003" - own_capabilities: - items: - $ref: '#/components/schemas/OwnCapability' - type: array - x-stream-index: "001.004" required: - - call - - members - - own_capabilities - - blocked_users - - created - - duration - title: GetOrCreateCallResponse - type: object - GetReactionsResponse: - nullable: true - properties: - duration: - type: string - x-stream-index: "002.001" - reactions: - description: List of reactions - items: - $ref: '#/components/schemas/Reaction' - title: Reactions - type: array - x-stream-index: "001" - required: - - reactions - duration + title: DeleteRecordingResponse type: object - GetRepliesResponse: + DeleteReminderResponse: description: Basic response information nullable: true properties: @@ -8684,4030 +9468,4031 @@ components: description: Duration of the request in milliseconds title: Duration type: string - x-stream-index: "002.001" - messages: - items: - $ref: '#/components/schemas/MessageResponse' - type: array - x-stream-index: "001" + x-stream-index: "001.001" required: - - messages - duration title: Response type: object - GetThreadResponse: + DeleteTranscriptionResponse: + description: DeleteTranscriptionResponse is the payload for deleting a transcription. nullable: true properties: duration: + description: Duration of the request in milliseconds + title: Duration type: string - x-stream-index: "002.001" - thread: - $ref: '#/components/schemas/ThreadStateResponse' - description: Enriched thread state - title: Thread - x-stream-index: "001" + x-stream-index: "001.001" required: - - thread - duration + title: DeleteTranscriptionResponse type: object - GoLiveRequest: - nullable: true + DeleteUserRequest: properties: - recording_storage_name: - type: string - x-stream-index: "005" - start_closed_caption: - type: boolean - x-stream-index: "008" - start_hls: + delete_conversation_channels: type: boolean x-stream-index: "003" - start_recording: + delete_feeds_content: type: boolean x-stream-index: "004" - start_transcription: + hard_delete: type: boolean - x-stream-index: "007" - transcription_storage_name: - type: string - x-stream-index: "006" - title: GoLiveRequest - type: object - GoLiveResponse: - description: Basic response information - nullable: true - properties: - call: - $ref: '#/components/schemas/CallResponse' x-stream-index: "001" - duration: - description: Duration of the request in milliseconds - title: Duration - type: string - x-stream-index: "002.001" - required: - - call - - duration - title: Response - type: object - GoogleVisionConfig: - properties: - enabled: + mark_messages_deleted: type: boolean - x-stream-index: "001" + x-stream-index: "002" type: object - GroupedStatsResponse: + Device: nullable: true properties: - name: - type: string - x-stream-index: "001" - unique: - format: int32 - type: integer - x-stream-index: "002" - required: - - name - - unique - type: object - HLSEgressConfig: - properties: - composite_app_settings: - $ref: '#/components/schemas/CompositeAppSettings' - x-stream-index: "005" - playlist_url: - type: string - x-stream-index: "007" - qualities: - items: - $ref: '#/components/schemas/Quality' - type: array - x-stream-index: "004" - start_unix_nano: - format: int64 - type: integer - x-stream-index: "006" - type: object - HLSSettings: - properties: - auto_on: - type: boolean - x-stream-index: "001" - enabled: + created_at: + format: date-time + type: number + x-stream-index: "002.002" + disabled: type: boolean - x-stream-index: "002" - layout: - $ref: '#/components/schemas/LayoutSettings' + x-stream-index: "002.003" + disabled_reason: + type: string + x-stream-index: "002.004" + id: + type: string + x-stream-index: 002.001.004 + push_provider: + enum: + - firebase + - apn + - huawei + - xiaomi + type: string + x-stream-index: 002.001.001 + push_provider_name: + type: string + x-stream-index: 002.001.003 + user_id: + type: string x-stream-index: "004" - quality_tracks: - items: - type: string - type: array - x-stream-index: "003" - required: - - auto_on - - enabled - - quality_tracks - type: object - HLSSettingsRequest: - properties: - auto_on: - type: boolean - x-stream-index: "001" - enabled: + voip: type: boolean - x-stream-index: "002" - quality_tracks: - items: - type: string - maximum: 3 - minimum: 1 - type: array - x-stream-index: "003" + x-stream-index: 002.001.005 required: - - quality_tracks - title: HLSSettingsRequest + - push_provider + - id + - created_at + - user_id type: object - HLSSettingsResponse: - description: HLSSettings is the payload for HLS settings + DeviceResponse: + description: Response for Device + nullable: true properties: - auto_on: - title: Auto On - type: boolean - x-stream-index: "001" - enabled: - title: Enabled + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: "004" + disabled: + description: Whether device is disabled or not + title: Disabled type: boolean - x-stream-index: "002" - quality_tracks: - items: - type: string - title: Quality Tracks - type: array + x-stream-index: "005" + disabled_reason: + description: Reason explaining why device had been disabled + title: Reason + type: string + x-stream-index: "006" + id: + description: Device ID + title: ID + type: string x-stream-index: "003" - required: - - auto_on - - enabled - - quality_tracks - - layout - title: HLSSettingsResponse - type: object - HarmConfig: - properties: - action_sequences: - items: - $ref: '#/components/schemas/ActionSequence' - type: array + push_provider: + description: Push provider + title: PushProvider + type: string x-stream-index: "001" - severity: - type: integer + push_provider_name: + description: Push provider name + title: PushProviderName + type: string x-stream-index: "002" + user_id: + description: User ID + title: UserID + type: string + x-stream-index: "008" + voip: + description: When true the token is for Apple VoIP push notifications + title: Voip + type: boolean + x-stream-index: "007" required: - - action_sequences - - severity + - push_provider + - id + - created_at + - user_id + title: DeviceResponse type: object - HealthCheckEvent: + DraftDeletedEvent: + description: Emitted when a Draft is deleted. nullable: true properties: cid: + description: The CID of the channel where the draft was created + title: Channel CID type: string - x-stream-index: "003" - connection_id: - type: string - x-stream-index: "001" + x-stream-index: 001.001.002 created_at: + description: Date/time of creation format: date-time + title: Created at type: number - x-stream-index: "004.003" + x-stream-index: 001.001.001.003 custom: additionalProperties: {} type: object - x-stream-index: "004.007" - me: - $ref: '#/components/schemas/OwnUserResponse' - x-stream-index: "002" + x-stream-index: 001.001.001.007 + draft: + $ref: '#/components/schemas/DraftResponse' + x-stream-index: "001.003" + parent_id: + description: The ID of the parent message + title: Message ID + type: string + x-stream-index: "001.002" received_at: format: date-time type: number - x-stream-index: "004.004" + x-stream-index: 001.001.001.004 type: - default: health.check + default: draft.deleted + description: 'The type of event: "draft.deleted" in this case' + title: Event Type type: string - x-stream-index: "004.002" + x-stream-index: 001.001.001.002 required: - - connection_id - type - created_at - custom - title: HealthCheckEvent + title: DraftDeletedEvent 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 - HideChannelRequest: - nullable: true - properties: - clear_history: - description: Whether to clear message history of the channel or not - title: Clear history - type: boolean - x-stream-index: "001" - type: object - HideChannelResponse: - description: Basic response information - nullable: true + DraftPayloadResponse: properties: - duration: - description: Duration of the request in milliseconds - title: Duration + attachments: + items: + $ref: '#/components/schemas/Attachment' + type: array + x-stream-index: "004" + custom: + additionalProperties: {} + type: object + x-stream-index: "007" + html: type: string - x-stream-index: "001.001" - required: - - duration - title: Response - type: object - ICEServer: - properties: - password: + x-stream-index: "010" + id: type: string - x-stream-index: "003" - urls: + x-stream-index: "001" + mentioned_users: items: - type: string + $ref: '#/components/schemas/UserResponse' type: array - x-stream-index: "001" - username: + x-stream-index: "008" + mml: type: string - x-stream-index: "002" - required: - - urls - - username - - password - type: object - ImageContentParameters: - properties: - harm_labels: - items: - type: string - type: array - x-stream-index: "001" - type: object - ImageData: - properties: - frames: + x-stream-index: "003" + parent_id: type: string x-stream-index: "005" - height: - type: string - x-stream-index: "003" - size: + poll_id: type: string - x-stream-index: "004" - url: + x-stream-index: "013" + quoted_message_id: type: string - x-stream-index: "001" - width: + x-stream-index: "009" + show_in_channel: + type: boolean + x-stream-index: "006" + silent: + type: boolean + x-stream-index: "012" + text: type: string x-stream-index: "002" + type: + type: string + x-stream-index: "011" required: - - url - - width - - height - - size - - frames + - id + - text + - custom type: object - ImageRuleParameters: + DraftResponse: properties: - harm_labels: - items: - type: string - type: array + channel: + $ref: '#/components/schemas/ChannelResponse' x-stream-index: "003" - threshold: - format: int32 - type: integer - x-stream-index: "001" - time_window: + channel_cid: type: string x-stream-index: "002" + created_at: + format: date-time + type: number + x-stream-index: "007" + message: + $ref: '#/components/schemas/DraftPayloadResponse' + x-stream-index: "001" + parent_id: + type: string + x-stream-index: "004" + parent_message: + $ref: '#/components/schemas/MessageResponse' + x-stream-index: "005" + quoted_message: + $ref: '#/components/schemas/MessageResponse' + x-stream-index: "006" required: - - threshold - - time_window + - message + - channel_cid + - created_at type: object - ImageSize: + DraftUpdatedEvent: + description: Emitted when a Draft is created or updated. + nullable: true properties: - crop: - description: Crop mode - enum: - - top - - bottom - - left - - right - - center - title: Crop + cid: + description: The CID of the channel where the draft was created/updated + title: Channel CID type: string - x-stream-index: "001" - height: - description: Target image height + x-stream-index: 001.001.002 + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 001.001.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 001.001.001.007 + draft: + $ref: '#/components/schemas/DraftResponse' + description: The draft object which was created/updated + title: Draft + x-stream-index: "001.003" + parent_id: + description: The ID of the parent message + title: Parent ID + type: string + x-stream-index: "001.002" + received_at: + format: date-time + type: number + x-stream-index: 001.001.001.004 + type: + default: draft.updated + description: 'The type of event: "draft.updated" in this case' + title: Event Type + type: string + x-stream-index: 001.001.001.002 + required: + - type + - created_at + - custom + title: DraftUpdatedEvent + 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 + EdgeResponse: + properties: + continent_code: + type: string + x-stream-index: "007.003" + country_iso_code: + type: string + x-stream-index: "007.002" + green: format: int32 - title: Height type: integer x-stream-index: "003" - resize: - description: Resize method - enum: - - clip - - crop - - scale - - fill - title: Resize + id: + type: string + x-stream-index: "001" + latency_test_url: type: string x-stream-index: "002" - width: - description: Target image width + latitude: + format: float + type: number + x-stream-index: "006.001" + longitude: + format: float + type: number + x-stream-index: "006.002" + red: + format: int32 + type: integer + x-stream-index: "005" + subdivision_iso_code: + type: string + x-stream-index: "007.001" + yellow: format: int32 - title: Width type: integer x-stream-index: "004" - title: Image size configuration + required: + - id + - latency_test_url + - green + - yellow + - red + - latitude + - longitude + - subdivision_iso_code + - country_iso_code + - continent_code type: object - ImageUploadRequest: - nullable: true + EgressHLSResponse: properties: - file: + playlist_url: + type: string + x-stream-index: "001" + status: type: string - x-stream-index: "001.001" - upload_sizes: - description: field with JSON-encoded array of image size configurations - items: - $ref: '#/components/schemas/ImageSize' - title: Upload sizes - type: array x-stream-index: "002" - user: - $ref: '#/components/schemas/OnlyUserID' - x-stream-index: "001.002" + required: + - playlist_url + - status type: object - ImageUploadResponse: - nullable: true + EgressRTMPResponse: properties: - duration: - description: Duration of the request in milliseconds - title: Duration + name: type: string - x-stream-index: 001.003.001 - file: + x-stream-index: "001" + started_at: + format: date-time + type: number + x-stream-index: "004" + stream_key: type: string - x-stream-index: "001.001" - thumb_url: + x-stream-index: "003" + stream_url: type: string - x-stream-index: "001.002" - upload_sizes: - description: Array of image size configurations - items: - $ref: '#/components/schemas/ImageSize' - title: Upload sizes - type: array x-stream-index: "002" required: - - duration + - name + - started_at type: object - Images: + EgressResponse: properties: - fixed_height: - $ref: '#/components/schemas/ImageData' - x-stream-index: "002" - fixed_height_downsampled: - $ref: '#/components/schemas/ImageData' + broadcasting: + type: boolean + x-stream-index: "001" + frame_recording: + $ref: '#/components/schemas/FrameRecordingResponse' x-stream-index: "004" - fixed_height_still: - $ref: '#/components/schemas/ImageData' + hls: + $ref: '#/components/schemas/EgressHLSResponse' + x-stream-index: "002" + rtmps: + items: + $ref: '#/components/schemas/EgressRTMPResponse' + type: array x-stream-index: "003" - fixed_width: - $ref: '#/components/schemas/ImageData' - x-stream-index: "005" - fixed_width_downsampled: - $ref: '#/components/schemas/ImageData' - x-stream-index: "007" - fixed_width_still: - $ref: '#/components/schemas/ImageData' - x-stream-index: "006" - original: - $ref: '#/components/schemas/ImageData' - x-stream-index: "001" required: - - original - - fixed_height - - fixed_height_still - - fixed_height_downsampled - - fixed_width - - fixed_width_still - - fixed_width_downsampled + - broadcasting + - rtmps type: object - IngressAudioEncodingOptions: + EgressTaskConfig: properties: - bitrate: - maximum: 128000 - minimum: 16000 - type: integer - x-stream-index: "003" - channels: - enum: - - "1" - - "2" - format: int32 - type: integer - x-stream-index: "001" - enable_dtx: - type: boolean - x-stream-index: "002" - required: - - channels - - enable_dtx - - bitrate + egress_user: + $ref: '#/components/schemas/EgressUser' + x-stream-index: "008" + frame_recording_egress_config: + $ref: '#/components/schemas/FrameRecordingEgressConfig' + x-stream-index: "009" + hls_egress_config: + $ref: '#/components/schemas/HLSEgressConfig' + x-stream-index: "007" + recording_egress_config: + $ref: '#/components/schemas/RecordingEgressConfig' + x-stream-index: "006" + rtmp_egress_config: + $ref: '#/components/schemas/RTMPEgressConfig' + x-stream-index: "004" + stt_egress_config: + $ref: '#/components/schemas/STTEgressConfig' + x-stream-index: "005" type: object - IngressAudioEncodingOptionsRequest: + EgressUser: properties: - bitrate: - maximum: 128000 - minimum: 16000 - type: integer - x-stream-index: "003" - channels: - enum: - - "1" - - "2" - format: int32 - type: integer - x-stream-index: "001" - enable_dtx: - type: boolean - x-stream-index: "002" - required: - - channels - - bitrate + token: + type: string + x-stream-index: "004" type: object - IngressAudioEncodingResponse: + EndCallRequest: + description: Request for ending a call + nullable: true + title: EndCallRequest + type: object + EndCallResponse: + description: Response for ending a call + nullable: true properties: - bitrate: - format: int32 - type: integer - x-stream-index: "003" - channels: - format: int32 - type: integer - x-stream-index: "001" - enable_dtx: - type: boolean - x-stream-index: "002" + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "001.001" required: - - channels - - enable_dtx - - bitrate + - duration + title: EndCallResponse type: object - IngressSettings: + EnrichedActivity: properties: - audio_encoding_options: - $ref: '#/components/schemas/IngressAudioEncodingOptions' + actor: + $ref: '#/components/schemas/Data' x-stream-index: "002" - enabled: - type: boolean + foreign_id: + type: string + x-stream-index: "005" + id: + type: string x-stream-index: "001" - video_encoding_options: + latest_reactions: additionalProperties: - $ref: '#/components/schemas/IngressVideoEncodingOptions' + items: + $ref: '#/components/schemas/EnrichedReaction' + type: array type: object - x-stream-index: "003" - required: - - enabled - type: object - IngressSettingsRequest: - properties: - audio_encoding_options: - $ref: '#/components/schemas/IngressAudioEncodingOptionsRequest' - x-stream-index: "002" - enabled: - type: boolean - x-stream-index: "001" - video_encoding_options: + x-stream-index: "013" + object: + $ref: '#/components/schemas/Data' + x-stream-index: "004" + origin: + $ref: '#/components/schemas/Data' + x-stream-index: "008" + own_reactions: additionalProperties: - $ref: '#/components/schemas/IngressVideoEncodingOptionsRequest' + items: + $ref: '#/components/schemas/EnrichedReaction' + type: array type: object - x-stream-index: "003" - type: object - IngressSettingsResponse: - properties: - audio_encoding_options: - $ref: '#/components/schemas/IngressAudioEncodingResponse' - x-stream-index: "002" - enabled: - type: boolean - x-stream-index: "001" - video_encoding_options: + x-stream-index: "012" + reaction_counts: additionalProperties: - $ref: '#/components/schemas/IngressVideoEncodingResponse' + format: int32 + type: integer type: object - x-stream-index: "003" - required: - - enabled - type: object - IngressVideoEncodingOptions: - properties: - layers: - items: - $ref: '#/components/schemas/IngressVideoLayer' - minimum: 1 - type: array - x-stream-index: "001" - required: - - layers - type: object - IngressVideoEncodingOptionsRequest: - properties: - layers: - items: - $ref: '#/components/schemas/IngressVideoLayerRequest' - minimum: 1 - type: array - x-stream-index: "001" - required: - - layers - type: object - IngressVideoEncodingResponse: - properties: - layers: + x-stream-index: "011" + score: + format: float + type: number + x-stream-index: "010" + target: + $ref: '#/components/schemas/Data' + x-stream-index: "006" + to: items: - $ref: '#/components/schemas/IngressVideoLayerResponse' + type: string type: array - x-stream-index: "001" - required: - - layers + x-stream-index: "009" + verb: + type: string + x-stream-index: "003" type: object - IngressVideoLayer: + EnrichedReaction: nullable: true properties: - bitrate: - minimum: 1000 - type: integer - x-stream-index: "002" - codec: - enum: - - h264 - - vp8 + activity_id: type: string - x-stream-index: "001" - frame_rate: - maximum: 60 - minimum: 1 - type: integer x-stream-index: "003" - max_dimension: - minimum: 240 - type: integer - x-stream-index: "005" - min_dimension: - minimum: 240 - type: integer - x-stream-index: "004" - required: - - codec - - bitrate - - frame_rate - - min_dimension - - max_dimension - type: object - IngressVideoLayerRequest: - nullable: true - properties: - bitrate: - format: int32 - minimum: 1000 - type: integer - x-stream-index: "002" - codec: - enum: - - h264 - - vp8 - type: string - x-stream-index: "001" - frame_rate_limit: - maximum: 60 - minimum: 1 - type: integer + children_counts: + additionalProperties: + format: int32 + type: integer + type: object + x-stream-index: "010" + created_at: + $ref: '#/components/schemas/Time' + x-stream-index: "012" + data: + additionalProperties: {} + type: object x-stream-index: "005" - max_dimension: - minimum: 240 - type: integer - x-stream-index: "004" - min_dimension: - minimum: 240 - type: integer - x-stream-index: "003" - required: - - codec - - bitrate - - min_dimension - - max_dimension - - frame_rate_limit - type: object - IngressVideoLayerResponse: - nullable: true - properties: - bitrate: - type: integer - x-stream-index: "002" - codec: + id: type: string x-stream-index: "001" - frame_rate_limit: - type: integer - x-stream-index: "005" - max_dimension: - type: integer - x-stream-index: "004" - min_dimension: - type: integer - x-stream-index: "003" - required: - - codec - - bitrate - - min_dimension - - max_dimension - - frame_rate_limit - type: object - JoinCallRequest: - nullable: true - properties: - create: - description: if true the call will be created if it doesn't exist - title: Create - type: boolean - x-stream-index: "002" - data: - $ref: '#/components/schemas/CallRequest' - x-stream-index: "003" - location: - title: Location + kind: type: string + x-stream-index: "002" + latest_children: + additionalProperties: + items: + $ref: '#/components/schemas/EnrichedReaction' + type: array + type: object + x-stream-index: "008" + own_children: + additionalProperties: + items: + $ref: '#/components/schemas/EnrichedReaction' + type: array + type: object x-stream-index: "009" - members_limit: - format: int32 - maximum: 100 - title: The amount of members that should be returned - type: integer + parent: + type: string x-stream-index: "007" - migrating_from: - description: If the participant is migrating from another SFU, then this - is the ID of the previous SFU - title: MigratingFrom + target_feeds: + items: + type: string + type: array + x-stream-index: "006" + updated_at: + $ref: '#/components/schemas/Time' + x-stream-index: "013" + user: + $ref: '#/components/schemas/Data' + x-stream-index: "011" + user_id: type: string - x-stream-index: "010" - notify: - type: boolean - x-stream-index: "005" - ring: - description: if true and the call is created, the notification will include - ring=true - title: Ring - type: boolean x-stream-index: "004" - video: - type: boolean - x-stream-index: "006" required: - - location - title: JoinCallRequest + - kind + - activity_id + - user_id type: object - JoinCallResponse: - nullable: true + EntityCreator: properties: - call: - $ref: '#/components/schemas/CallResponse' - x-stream-index: "001.001" - created: - title: Created - type: boolean + avg_response_time: + format: int32 + readOnly: true + type: integer + x-stream-index: "001.046" + ban_count: + format: int32 + type: integer x-stream-index: "002" - credentials: - $ref: '#/components/schemas/Credentials' - title: Credentials + ban_expires: + format: date-time + type: number + x-stream-index: "001.017" + banned: + type: boolean + x-stream-index: "001.016" + created_at: + format: date-time + readOnly: true + type: number + x-stream-index: "001.008" + custom: + additionalProperties: {} + type: object + x-stream-index: "001.006" + deactivated_at: + format: date-time + readOnly: true + type: number + x-stream-index: "001.014" + deleted_at: + format: date-time + readOnly: true + type: number + x-stream-index: "001.013" + deleted_content_count: + format: int32 + type: integer x-stream-index: "003" - duration: + id: type: string - x-stream-index: "005.001" - members: - items: - $ref: '#/components/schemas/MemberResponse' - type: array - x-stream-index: "001.002" - membership: - $ref: '#/components/schemas/MemberResponse' x-stream-index: "001.003" - own_capabilities: - items: - $ref: '#/components/schemas/OwnCapability' - type: array + invisible: + type: boolean + x-stream-index: "001.023" + language: + type: string + x-stream-index: "001.035" + last_active: + format: date-time + readOnly: true + type: number + x-stream-index: "001.011" + last_engaged_at: + format: date-time + readOnly: true + type: number + x-stream-index: "001.012" + online: + readOnly: true + type: boolean + x-stream-index: "001.022" + privacy_settings: + $ref: '#/components/schemas/PrivacySettings' + x-stream-index: "001.026" + revoke_tokens_issued_before: + format: date-time + type: number + x-stream-index: "001.042" + role: + type: string x-stream-index: "001.004" - stats_options: - $ref: '#/components/schemas/StatsOptions' - x-stream-index: "004" - required: - - call - - members - - own_capabilities - - blocked_users - - created - - credentials - - stats_options - - duration - title: JoinCallResponse - type: object - Label: - properties: - harm_labels: + teams: items: type: string type: array - x-stream-index: "003" - name: - type: string - x-stream-index: "001" - phrase_list_ids: - items: - format: int32 - type: integer - type: array - x-stream-index: "002" - required: - - name - type: object - LabelThresholds: - properties: - block: - description: Threshold for automatic message block - format: float - maximum: 1 - minimum: 0 - title: Block - type: number - x-stream-index: "002" - flag: - description: Threshold for automatic message flag - format: float - maximum: 1 - minimum: 0 - title: Flag - type: number - x-stream-index: "001" - type: object - LayoutSettings: - properties: - detect_orientation: - type: boolean - x-stream-index: "005" - external_app_url: - type: string - x-stream-index: "003" - external_css_url: - type: string - x-stream-index: "004" - name: - enum: - - spotlight - - grid - - single-participant - - mobile - - custom - type: string - x-stream-index: "001" - options: - additionalProperties: {} - type: object - x-stream-index: "002" - required: - - name - - external_app_url - - external_css_url - type: object - LayoutSettingsRequest: - properties: - detect_orientation: - type: boolean - x-stream-index: "005" - external_app_url: - type: string - x-stream-index: "003" - external_css_url: - type: string - x-stream-index: "004" - name: - enum: - - spotlight - - grid - - single-participant - - mobile - - custom - type: string - x-stream-index: "001" - options: - additionalProperties: {} + x-stream-index: "001.036" + teams_role: + additionalProperties: + type: string type: object - x-stream-index: "002" + x-stream-index: "001.005" + updated_at: + format: date-time + readOnly: true + type: number + x-stream-index: "001.009" required: - - name + - id + - role + - teams_role + - custom + - banned + - online + - ban_count + - deleted_content_count type: object - LimitsSettings: + EntityCreatorResponse: properties: - max_duration_seconds: + avg_response_time: format: int32 type: integer - x-stream-index: "004" - max_participants: + x-stream-index: 001.001.018 + ban_count: + description: Number of minor actions performed on the user format: int32 + title: Ban Count type: integer - x-stream-index: "001" - max_participants_exclude_owner: + x-stream-index: "002" + banned: type: boolean - x-stream-index: "003" - max_participants_exclude_roles: + x-stream-index: 001.001.012 + blocked_user_ids: items: type: string type: array - x-stream-index: "002" - required: - - max_participants_exclude_roles - type: object - LimitsSettingsRequest: - properties: - max_duration_seconds: + x-stream-index: 001.001.017 + created_at: + format: date-time + type: number + x-stream-index: 001.001.009 + custom: + additionalProperties: {} + type: object + x-stream-index: 001.001.004 + deactivated_at: + format: date-time + type: number + x-stream-index: 001.001.016 + deleted_at: + format: date-time + type: number + x-stream-index: 001.001.011 + deleted_content_count: + description: Number of major actions performed on the user format: int32 - minimum: 0 + title: Deleted Content Count type: integer - x-stream-index: "004" - max_participants: + x-stream-index: "003" + flagged_count: + description: Number of flag actions performed on the user format: int32 + title: Flagged Count type: integer - x-stream-index: "001" - max_participants_exclude_owner: + x-stream-index: "004" + id: + type: string + x-stream-index: 001.001.001 + image: + type: string + x-stream-index: 001.001.003 + language: + type: string + x-stream-index: 001.001.005 + last_active: + format: date-time + type: number + x-stream-index: 001.001.014 + name: + type: string + x-stream-index: 001.001.002 + online: type: boolean - x-stream-index: "003" - max_participants_exclude_roles: + x-stream-index: 001.001.013 + revoke_tokens_issued_before: + format: date-time + type: number + x-stream-index: 001.001.015 + role: + type: string + x-stream-index: 001.001.006 + teams: items: type: string type: array - x-stream-index: "002" + x-stream-index: 001.001.007 + teams_role: + additionalProperties: + type: string + type: object + x-stream-index: 001.001.008 + updated_at: + format: date-time + type: number + x-stream-index: 001.001.010 + required: + - id + - custom + - language + - role + - teams + - created_at + - updated_at + - banned + - online + - blocked_user_ids + - shadow_banned + - invisible + - ban_count + - deleted_content_count + - flagged_count type: object - LimitsSettingsResponse: + EventNotificationSettings: properties: - max_duration_seconds: - format: int32 - type: integer - x-stream-index: "004" - max_participants: - format: int32 - type: integer - x-stream-index: "001" - max_participants_exclude_owner: + apns: + $ref: '#/components/schemas/APNS' + x-stream-index: "002" + enabled: type: boolean + x-stream-index: "001" + fcm: + $ref: '#/components/schemas/FCM' x-stream-index: "003" - max_participants_exclude_roles: - items: - type: string - type: array + required: + - enabled + - apns + - fcm + type: object + EventRequest: + properties: + custom: + additionalProperties: {} + type: object + x-stream-index: "003" + parent_id: + type: string x-stream-index: "002" + type: + type: string + x-stream-index: "001" required: - - max_participants_exclude_roles + - type type: object - ListBlockListResponse: + EventResponse: description: Basic response information nullable: true properties: - blocklists: - items: - $ref: '#/components/schemas/BlockListResponse' - type: array - x-stream-index: "001" duration: description: Duration of the request in milliseconds title: Duration type: string x-stream-index: "002.001" - required: - - blocklists - - duration - title: Response - type: object - ListDevicesResponse: - description: List devices response - nullable: true - properties: - devices: - description: List of devices - items: - $ref: '#/components/schemas/DeviceResponse' - title: Devices - type: array + event: + $ref: '#/components/schemas/WSEvent' x-stream-index: "001" - duration: - type: string - x-stream-index: "002.001" required: - - devices + - event - duration - title: ListDevicesResponse + title: Response type: object - ListRecordingsResponse: - description: Response for listing recordings - nullable: true + ExternalStorage: properties: - duration: + abs_account_name: type: string - x-stream-index: "001.001" - recordings: - items: - $ref: '#/components/schemas/CallRecording' - title: The list of recordings. - type: array - x-stream-index: "002" - required: - - duration - - recordings - title: ListRecordingsResponse - type: object - ListTranscriptionsResponse: - nullable: true - properties: - duration: + x-stream-index: "011" + abs_client_id: type: string - x-stream-index: "001.001" - transcriptions: - description: List of transcriptions for the call - items: - $ref: '#/components/schemas/CallTranscription' - title: Transcriptions - type: array - x-stream-index: "002" - required: - - duration - - transcriptions - title: ListTranscriptionsResponse - type: object - MarkChannelsReadRequest: - nullable: true - properties: - read_by_channel: - additionalProperties: - type: string - description: Map of channel ID to last read message ID - maximum: 30 - title: Read by channel - type: object - x-stream-index: "001" - type: object - MarkReadRequest: - nullable: true - properties: - message_id: - description: ID of the message that is considered last read by client - title: Message ID + x-stream-index: "013" + abs_client_secret: type: string - x-stream-index: "001" - thread_id: - description: Optional Thread ID to specifically mark a given thread as read - title: Thread ID + x-stream-index: "014" + abs_tenant_id: type: string - x-stream-index: "002" - type: object - MarkReadResponse: - nullable: true - properties: - duration: - description: Duration of the request in milliseconds - title: Duration + x-stream-index: "012" + bucket: type: string - x-stream-index: "002.001" - event: - $ref: '#/components/schemas/MessageReadEvent' - description: Mark read event - title: Event - x-stream-index: "001" - required: - - duration + x-stream-index: "005" + gcs_credentials: + type: string + x-stream-index: "010" + path: + type: string + x-stream-index: "006" + s3_api_key: + type: string + x-stream-index: "007" + s3_custom_endpoint: + type: string + x-stream-index: "016" + s3_region: + type: string + x-stream-index: "009" + s3_secret_key: + type: string + x-stream-index: "008" + storage_name: + type: string + x-stream-index: "015" + storage_type: + type: integer + x-stream-index: "004" type: object - MarkReviewedRequest: + FCM: properties: - content_to_mark_as_reviewed_limit: - format: int32 - maximum: 2500 - type: integer - x-stream-index: "002" - disable_marking_content_as_reviewed: - type: boolean + data: + additionalProperties: {} + type: object x-stream-index: "001" type: object - MarkUnreadRequest: + FeedCreatedEvent: + description: Emitted when a feed is created. nullable: true properties: - message_id: - description: ID of the message from where the channel is marked unread - title: Message ID - type: string + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 003.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 003.001.007 + feed: + $ref: '#/components/schemas/FeedResponse' + description: The feed that was created + title: Feed x-stream-index: "001" - thread_id: - description: Mark a thread unread, specify both the thread and message id - title: Thread ID - type: string - x-stream-index: "003" - type: object - MemberAddedEvent: - properties: - channel_id: - type: string - x-stream-index: "004.002" - channel_type: + feed_visibility: type: string - x-stream-index: "004.003" - cid: + x-stream-index: "003.003" + fid: type: string - x-stream-index: "004.001" - created_at: + x-stream-index: "003.002" + members: + items: + $ref: '#/components/schemas/FeedMemberResponse' + type: array + x-stream-index: "002" + received_at: format: date-time type: number - x-stream-index: "003.002" - member: - $ref: '#/components/schemas/ChannelMember' - x-stream-index: "001.001" - team: - type: string - x-stream-index: "002.001" + x-stream-index: 003.001.004 type: - default: member.added + default: feeds.feed.created + description: 'The type of event: "feeds.feed.created" in this case' + title: Event Type type: string - x-stream-index: "003.001" + x-stream-index: 003.001.002 user: - $ref: '#/components/schemas/User' - x-stream-index: "005.001" + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who created the feed + title: User + x-stream-index: "004.001" required: + - feed + - members - type - created_at - - cid - - channel_id - - channel_type - title: MemberAddedEvent + - custom + - fid + - user + title: FeedCreatedEvent 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 - MemberLookup: - properties: - Limit: - format: int32 - type: integer - writeOnly: true - x-stream-index: "001" - required: - - Limit - type: object - MemberRemovedEvent: + FeedDeletedEvent: + description: Emitted when a feed is deleted. + nullable: true properties: - channel_id: - type: string - x-stream-index: "003.002" - channel_type: + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 001.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 001.001.007 + feed_visibility: type: string - x-stream-index: "003.003" - cid: + x-stream-index: "001.003" + fid: type: string - x-stream-index: "003.001" - created_at: + x-stream-index: "001.002" + received_at: format: date-time type: number - x-stream-index: "002.002" - member: - $ref: '#/components/schemas/ChannelMember' - x-stream-index: "001.001" + x-stream-index: 001.001.004 type: - default: member.removed + default: feeds.feed.deleted + description: 'The type of event: "feeds.feed.deleted" in this case' + title: Event Type type: string - x-stream-index: "002.001" + x-stream-index: 001.001.002 user: - $ref: '#/components/schemas/User' - x-stream-index: "004.001" + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who deleted the feed + title: User + x-stream-index: "002.001" required: - type - created_at - - cid - - channel_id - - channel_type - title: MemberRemovedEvent + - custom + - fid + title: FeedDeletedEvent 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 - MemberRequest: - description: MemberRequest is the payload for adding a member to a call. + FeedGroup: properties: - custom: - additionalProperties: {} - description: Custom data for this object - title: Custom data + ActivityProcessors: + items: + $ref: '#/components/schemas/ActivityProcessorConfig' + type: array + writeOnly: true + x-stream-index: "012" + ActivitySelectors: + items: + $ref: '#/components/schemas/ActivitySelectorConfig' + type: array + writeOnly: true + x-stream-index: "013" + Aggregation: + $ref: '#/components/schemas/AggregationConfig' + x-stream-index: "015" + AggregationVersion: + format: int32 + type: integer + writeOnly: true + x-stream-index: "016" + AppPK: + format: int32 + type: integer + writeOnly: true + x-stream-index: "002" + Custom: + additionalProperties: {} type: object - x-stream-index: "003" - role: - title: Role + writeOnly: true + x-stream-index: "007" + DefaultVisibility: type: string - x-stream-index: "002" - user_id: - minLength: 1 - title: User ID + writeOnly: true + x-stream-index: "006" + DeletedAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "010" + ID: type: string - x-stream-index: "001" + writeOnly: true + x-stream-index: "003" + LastFeedGetAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "017" + Notification: + $ref: '#/components/schemas/NotificationConfig' + x-stream-index: "004" + PushNotification: + $ref: '#/components/schemas/PushNotificationConfig' + x-stream-index: "005" + Ranking: + $ref: '#/components/schemas/RankingConfig' + x-stream-index: "014" + Stories: + $ref: '#/components/schemas/StoriesConfig' + x-stream-index: "011" + created_at: + format: date-time + type: number + x-stream-index: "008" + updated_at: + format: date-time + type: number + x-stream-index: "009" required: - - user_id - title: MemberRequest + - AppPK + - ID + - DefaultVisibility + - Custom + - created_at + - updated_at + - ActivityProcessors + - ActivitySelectors + - AggregationVersion type: object - MemberResponse: - description: MemberResponse is the payload for a member of a call. + FeedGroupChangedEvent: + description: Emitted when a feed group is changed. + nullable: true properties: created_at: description: Date/time of creation format: date-time title: Created at type: number - x-stream-index: "005" + x-stream-index: 001.001.003 custom: additionalProperties: {} - description: Custom member response data - title: Custom type: object - x-stream-index: "004" - deleted_at: - description: Date/time of deletion - format: date-time - title: Deleted at - type: number - x-stream-index: "007" - role: - title: Role - type: string + x-stream-index: 001.001.007 + feed_group: + $ref: '#/components/schemas/FeedGroup' + description: The feed group that was changed + title: Feed Type x-stream-index: "003" - updated_at: - description: Date/time of the last update + feed_visibility: + type: string + x-stream-index: "001.003" + fid: + type: string + x-stream-index: "001.002" + received_at: format: date-time - title: Updated at type: number - x-stream-index: "006" - user: - $ref: '#/components/schemas/UserResponse' - x-stream-index: "001" - user_id: + x-stream-index: 001.001.004 + type: + default: feeds.feed_group.changed + description: 'The type of event: "feeds.feed_group.changed" in this case' + title: Event Type type: string - x-stream-index: "002" + x-stream-index: 001.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who changed the feed group + title: User + x-stream-index: "002.001" required: - - user - - user_id - - custom + - type - created_at - - updated_at - title: MemberResponse + - custom + - fid + title: FeedGroupChangedEvent type: object - MemberUpdatedEvent: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + FeedGroupDeletedEvent: + description: Emitted when a feed group is deleted. + nullable: true properties: - channel_id: + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + feed_visibility: type: string - x-stream-index: "005.002" - channel_type: + x-stream-index: "002.003" + fid: type: string - x-stream-index: "005.003" - cid: + x-stream-index: "002.002" + group_id: + description: The ID of the feed group that was deleted + title: Group ID type: string - x-stream-index: "005.001" - created_at: + x-stream-index: "001" + received_at: format: date-time type: number - x-stream-index: "003.002" - member: - $ref: '#/components/schemas/ChannelMember' - x-stream-index: "001.001" - team: - type: string - x-stream-index: "002.001" + x-stream-index: 002.001.004 type: - default: member.updated + default: feeds.feed_group.deleted + description: 'The type of event: "feeds.feed_group.deleted" in this case' + title: Event Type type: string - x-stream-index: "003.001" - user: - $ref: '#/components/schemas/User' - x-stream-index: "004.001" + x-stream-index: 002.001.002 required: + - group_id - type - created_at - - cid - - channel_id - - channel_type - title: MemberUpdatedEvent + - custom + - fid + title: FeedGroupDeletedEvent 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 - MembersResponse: - nullable: true + FeedInput: properties: - duration: - description: Duration of the request in milliseconds - title: Duration + custom: + additionalProperties: {} + type: object + x-stream-index: "004" + description: + maxLength: 1000 type: string - x-stream-index: "002.001" - members: - description: List of found members + x-stream-index: "002" + filter_tags: items: - $ref: '#/components/schemas/ChannelMember' - title: Members + type: string + maximum: 255 type: array - x-stream-index: "001" - required: - - members - - duration - type: object - Message: - properties: - attachments: + x-stream-index: "005" + members: items: - $ref: '#/components/schemas/Attachment' + $ref: '#/components/schemas/FeedMemberRequest' type: array - x-stream-index: "012" - before_message_send_failed: - type: boolean - x-stream-index: "046" - cid: + x-stream-index: "006" + name: + maxLength: 255 type: string - x-stream-index: "028" - command: + x-stream-index: "001" + visibility: + enum: + - public + - visible + - followers + - members + - private type: string - x-stream-index: "006" + x-stream-index: "003" + type: object + FeedMemberAddedEvent: + description: Emitted when a feed member is added. + nullable: true + properties: created_at: + description: Date/time of creation format: date-time + title: Created at type: number - x-stream-index: "030" + x-stream-index: 003.001.003 custom: additionalProperties: {} type: object - x-stream-index: "034" - deleted_at: - format: date-time - type: number - x-stream-index: "033" - deleted_reply_count: - format: int32 - type: integer - x-stream-index: "023" - html: + x-stream-index: 003.001.007 + feed_visibility: type: string - x-stream-index: "007" - i18n: - additionalProperties: - type: string - type: object - x-stream-index: "044" - id: + x-stream-index: "003.003" + fid: type: string - x-stream-index: "002" - image_labels: - additionalProperties: - items: - type: string - type: array - type: object - x-stream-index: "040" - latest_reactions: - items: - $ref: '#/components/schemas/Reaction' - type: array - x-stream-index: "013" - mentioned_users: - items: - $ref: '#/components/schemas/User' - type: array - x-stream-index: "043" - message_text_updated_at: + x-stream-index: "003.002" + member: + $ref: '#/components/schemas/FeedMemberResponse' + description: The member that was added + title: Member + x-stream-index: "001" + received_at: format: date-time type: number - x-stream-index: "052" - mml: + x-stream-index: 003.001.004 + type: + default: feeds.feed_member.added + description: 'The type of event: "feeds.feed_member.added" in this case' + title: Event Type type: string - x-stream-index: "005" - moderation: - $ref: '#/components/schemas/ModerationV2Response' - x-stream-index: "056" - own_reactions: - items: - $ref: '#/components/schemas/Reaction' - type: array - x-stream-index: "014" - parent_id: - type: string - x-stream-index: "019" - pin_expires: - format: date-time - type: number - x-stream-index: "051" - pinned: - type: boolean - x-stream-index: "047" - pinned_at: - format: date-time - type: number - x-stream-index: "048" - pinned_by: - $ref: '#/components/schemas/User' - x-stream-index: "050" - poll: - $ref: '#/components/schemas/Poll' - x-stream-index: "054" - poll_id: - type: string - x-stream-index: "053" - quoted_message: - $ref: '#/components/schemas/Message' - x-stream-index: "025" - quoted_message_id: - type: string - x-stream-index: "024" - reaction_counts: - additionalProperties: - format: int32 - type: integer - type: object - x-stream-index: "015" - reaction_groups: - additionalProperties: - $ref: '#/components/schemas/ReactionGroupResponse' - type: object - x-stream-index: "017" - reaction_scores: - additionalProperties: - format: int32 - type: integer - type: object - x-stream-index: "016" - reminder: - $ref: '#/components/schemas/MessageReminder' - x-stream-index: "058" - reply_count: - format: int32 - type: integer - x-stream-index: "022" - restricted_visibility: - items: - type: string - type: array - x-stream-index: "011" - shadowed: - type: boolean - x-stream-index: "036" - shared_location: - $ref: '#/components/schemas/SharedLocation' - x-stream-index: "055" - show_in_channel: - type: boolean - x-stream-index: "021" - silent: - type: boolean - x-stream-index: "045" - text: - type: string - x-stream-index: "004" - thread_participants: - items: - $ref: '#/components/schemas/User' - type: array - x-stream-index: "027" - type: - type: string - x-stream-index: "008" - updated_at: - format: date-time - type: number - x-stream-index: "031" + x-stream-index: 003.001.002 user: - $ref: '#/components/schemas/User' - x-stream-index: "010" + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who added the member + title: User + x-stream-index: "002.001" required: - - id - - text - - html + - member - type - - restricted_visibility - - attachments - - latest_reactions - - own_reactions - - reaction_counts - - reaction_scores - - reaction_groups - - reply_count - - deleted_reply_count - - cid - created_at - - updated_at - custom - - shadowed - - mentioned_users - - silent - - pinned + - fid + title: FeedMemberAddedEvent type: object - MessageActionRequest: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + FeedMemberRemovedEvent: + description: Emitted when a feed member is removed. nullable: true properties: - form_data: - additionalProperties: - type: string - description: ReadOnlyData to execute command with - title: Form data - type: object - x-stream-index: "002" - required: - - form_data - type: object - MessageChangeSet: - properties: - attachments: - type: boolean - x-stream-index: "005" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 003.001.003 custom: - type: boolean - x-stream-index: "001" - html: - type: boolean - x-stream-index: "004" - mentioned_user_ids: - type: boolean - x-stream-index: "006" - mml: - type: boolean - x-stream-index: "003" - pin: - type: boolean - x-stream-index: "009" - quoted_message_id: - type: boolean - x-stream-index: "007" - silent: - type: boolean - x-stream-index: "008" - text: - type: boolean - x-stream-index: "002" - required: - - custom - - text - - mml - - html - - attachments - - mentioned_user_ids - - quoted_message_id - - silent - - pin - type: object - MessageDeletedEvent: - properties: - channel_id: - type: string - x-stream-index: "003.002" - channel_type: + additionalProperties: {} + type: object + x-stream-index: 003.001.007 + feed_visibility: type: string x-stream-index: "003.003" - cid: + fid: type: string - x-stream-index: "003.001" - created_at: + x-stream-index: "003.002" + member_id: + type: string + x-stream-index: "001" + received_at: format: date-time type: number - x-stream-index: "006.002" - hard_delete: - type: boolean - x-stream-index: "002.001" - message: - $ref: '#/components/schemas/Message' - x-stream-index: "001.001" - team: - type: string - x-stream-index: "005.001" - thread_participants: - items: - $ref: '#/components/schemas/User' - type: array - x-stream-index: "001.002" + x-stream-index: 003.001.004 type: - default: message.deleted + default: feeds.feed_member.removed + description: 'The type of event: "feeds.feed_member.removed" in this case' + title: Event Type type: string - x-stream-index: "006.001" + x-stream-index: 003.001.002 user: - $ref: '#/components/schemas/User' - x-stream-index: "004.001" + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who removed the member + title: User + x-stream-index: "002.001" required: - - hard_delete - - cid - - channel_id - - channel_type + - member_id - type - created_at - title: MessageDeletedEvent + - custom + - fid + title: FeedMemberRemovedEvent 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 + FeedMemberRequest: properties: - approved_at: - format: date-time - type: number - x-stream-index: "013" - created_at: - format: date-time - type: number - x-stream-index: "009" - created_by_automod: - type: boolean - x-stream-index: "001" custom: additionalProperties: {} + description: Custom data for the member + title: Custom Data type: object - x-stream-index: "008" - details: - $ref: '#/components/schemas/FlagDetails' - x-stream-index: "006" - message: - $ref: '#/components/schemas/Message' + x-stream-index: "004" + invite: + description: Whether this is an invite to become a member + title: Invite + type: boolean x-stream-index: "005" - moderation_feedback: - $ref: '#/components/schemas/FlagFeedback' + membership_level: + description: ID of the membership level to assign to the member + maxLength: 255 + title: Membership Level + type: string x-stream-index: "003" - moderation_result: - $ref: '#/components/schemas/MessageModerationResult' + role: + description: Role of the member in the feed + maxLength: 255 + title: Role + type: string x-stream-index: "002" - reason: + user_id: + description: ID of the user to add as a member + maxLength: 255 + title: User ID type: string - x-stream-index: "007" - rejected_at: - format: date-time - type: number - x-stream-index: "014" - reviewed_at: - format: date-time - type: number - x-stream-index: "011" - reviewed_by: - $ref: '#/components/schemas/UserResponse' - x-stream-index: "012" - updated_at: - format: date-time - type: number - x-stream-index: "010" - user: - $ref: '#/components/schemas/UserResponse' - x-stream-index: "004" + x-stream-index: "001" required: - - created_by_automod - - created_at - - updated_at + - user_id + title: Feed Member Payload type: object - MessageModerationResult: - description: Result of the message moderation + FeedMemberResponse: properties: - action: - description: Action taken by automod - title: Action - type: string - x-stream-index: "002" - ai_moderation_response: - $ref: '#/components/schemas/ModerationResponse' - description: Response from AI moderation - title: ModerationResponse + created_at: + description: When the membership was created + format: date-time + title: Created At + type: number + x-stream-index: "008" + custom: + additionalProperties: {} + description: Custom data for the membership + title: Custom Data + type: object x-stream-index: "007" - blocked_word: - description: Word that was blocked - title: Blocked word - type: string - x-stream-index: "004" - blocklist_name: - description: Name of the blocklist - title: Blocklist name - type: string + invite_accepted_at: + description: When the invite was accepted + format: date-time + title: Invite Accepted At + type: number x-stream-index: "005" - created_at: - description: Date/time of creation + invite_rejected_at: + description: When the invite was rejected format: date-time - title: Created at + title: Invite Rejected At type: number - x-stream-index: "010" - message_id: - description: ID of the message - title: Message ID + x-stream-index: "006" + membership_level: + $ref: '#/components/schemas/MembershipLevelResponse' + description: Membership level assigned to the member + title: Membership Level + x-stream-index: "004" + role: + description: Role of the member in the feed + title: Role type: string - x-stream-index: "001" - moderated_by: - description: User who moderated the message - title: Moderated by + x-stream-index: "002" + status: + description: Status of the membership + enum: + - member + - pending + - rejected + title: Status type: string x-stream-index: "003" - moderation_thresholds: - $ref: '#/components/schemas/Thresholds' - description: Thresholds for AI moderation - title: Thresholds - x-stream-index: "006" updated_at: - description: Date/time of the last update + description: When the membership was last updated format: date-time - title: Updated at + title: Updated At type: number - x-stream-index: "011" - user_bad_karma: - description: Whether user has bad karma - title: User bad karma - type: boolean x-stream-index: "009" - user_karma: - description: Karma of the user - format: float - title: User karma - type: number - x-stream-index: "008" + user: + $ref: '#/components/schemas/UserResponse' + description: User who is a member + title: User + x-stream-index: "001" required: - - message_id - - action - - user_karma - - user_bad_karma + - user + - role + - status - created_at - updated_at - title: Message moderation result + title: Feed Member type: object - MessageNewEvent: + FeedMemberUpdatedEvent: + description: Emitted when a feed member is updated. + nullable: true properties: - channel_id: - type: string - x-stream-index: "005.002" - channel_type: - type: string - x-stream-index: "005.003" - cid: - type: string - x-stream-index: "005.001" created_at: + description: Date/time of creation format: date-time + title: Created at type: number - x-stream-index: "004.002" - message: - $ref: '#/components/schemas/Message' - x-stream-index: "001.001" - team: + x-stream-index: 003.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 003.001.007 + feed_visibility: type: string - x-stream-index: "006.001" - thread_participants: - items: - $ref: '#/components/schemas/User' - type: array - x-stream-index: "001.002" + x-stream-index: "003.003" + fid: + type: string + x-stream-index: "003.002" + member: + $ref: '#/components/schemas/FeedMemberResponse' + description: The member that was updated + title: Member + x-stream-index: "001" + received_at: + format: date-time + type: number + x-stream-index: 003.001.004 type: - default: notification.thread_message_new + default: feeds.feed_member.updated + description: 'The type of event: "feeds.feed_member.updated" in this case' + title: Event Type type: string - x-stream-index: "004.001" + x-stream-index: 003.001.002 user: - $ref: '#/components/schemas/User' - x-stream-index: "003.001" - watcher_count: - format: int32 - type: integer + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who updated the member + title: User x-stream-index: "002.001" required: - - watcher_count + - member - type - created_at - - cid - - channel_id - - channel_type - title: MessageNewEvent + - custom + - fid + title: FeedMemberUpdatedEvent 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 - MessageOptions: - properties: - include_thread_participants: - type: boolean - x-stream-index: "001" - type: object - MessagePaginationParams: - type: object - MessageReadEvent: + FeedOwnCapability: + description: All possibility of string to use + enum: + - add-activity + - add-activity-reaction + - add-comment + - add-comment-reaction + - bookmark-activity + - create-feed + - delete-bookmark + - delete-comment + - delete-feed + - edit-bookmark + - follow + - invite-feed + - join-feed + - leave-feed + - manage-feed-group + - mark-activity + - pin-activity + - query-feed-members + - query-follows + - read-activities + - read-feed + - remove-activity + - remove-activity-reaction + - remove-comment-reaction + - unfollow + - update-activity + - update-comment + - update-feed + - update-feed-followers + - update-feed-members + title: FeedOwnCapability + type: string + FeedRequest: properties: - channel_id: + created_by_id: + description: ID of the feed creator + title: Created By ID type: string x-stream-index: "003" - channel_last_message_at: - format: date-time - type: number - x-stream-index: "005" - channel_type: + custom: + additionalProperties: {} + description: Custom data for the feed + title: Custom Data + type: object + x-stream-index: "004.004" + description: + description: Description of the feed + maxLength: 1000 + title: Description type: string - x-stream-index: "004" - cid: + x-stream-index: "004.002" + feed_group_id: + description: ID of the feed group + maxLength: 255 + title: Feed Group ID type: string - x-stream-index: "002" - created_at: - format: date-time - type: number - x-stream-index: "009" - last_read_message_id: + x-stream-index: "001" + feed_id: + description: ID of the feed + maxLength: 255 + title: Feed ID type: string - x-stream-index: "010" - team: + x-stream-index: "002" + filter_tags: + description: Tags used for filtering feeds + items: + type: string + maximum: 255 + title: Filter Tags + type: array + x-stream-index: "004.005" + members: + description: Initial members for the feed + items: + $ref: '#/components/schemas/FeedMemberRequest' + title: Members + type: array + x-stream-index: "004.006" + name: + description: Name of the feed + maxLength: 255 + title: Name type: string - x-stream-index: "006" - thread: - $ref: '#/components/schemas/ThreadResponse' - x-stream-index: "008" - type: - default: message.read + x-stream-index: "004.001" + visibility: + description: Visibility setting for the feed + enum: + - public + - visible + - followers + - members + - private + title: Visibility type: string - x-stream-index: "001" - user: - $ref: '#/components/schemas/UserResponseCommonFields' - x-stream-index: "007" + x-stream-index: "004.003" required: - - type - - cid - - channel_id - - channel_type - - created_at + - feed_group_id + - feed_id + title: Feed Payload type: object - MessageReminder: + FeedResponse: properties: - channel: - $ref: '#/components/schemas/Channel' - x-stream-index: "004" - channel_cid: - type: string - x-stream-index: "003" created_at: + description: When the feed was created format: date-time + title: Created At type: number - x-stream-index: "011" - message: - $ref: '#/components/schemas/Message' + x-stream-index: "015" + created_by: + $ref: '#/components/schemas/UserResponse' + description: User who created the feed + title: Created By + x-stream-index: "009" + custom: + additionalProperties: {} + description: Custom data for the feed + title: Custom Data + type: object x-stream-index: "006" - message_id: - type: string - x-stream-index: "005" - remind_at: + deleted_at: + description: When the feed was deleted format: date-time + title: Deleted At type: number - x-stream-index: "009" - task_id: + x-stream-index: "017" + description: + description: Description of the feed + title: Description type: string - x-stream-index: "010" + x-stream-index: "005" + feed: + description: Fully qualified feed ID (group_id:id) + title: FID + type: string + x-stream-index: "003" + filter_tags: + description: Tags used for filtering feeds + items: + type: string + title: Filter Tags + type: array + x-stream-index: "007" + follower_count: + description: Number of followers of this feed + format: int32 + title: Follower Count + type: integer + x-stream-index: "011" + following_count: + description: Number of feeds this feed follows + format: int32 + title: Following Count + type: integer + x-stream-index: "012" + group_id: + description: Group this feed belongs to + title: Group ID + type: string + x-stream-index: "001" + id: + description: Unique identifier for the feed + title: ID + type: string + x-stream-index: "002" + member_count: + description: Number of members in this feed + format: int32 + title: Member Count + type: integer + x-stream-index: "010" + name: + description: Name of the feed + title: Name + type: string + x-stream-index: "004" + own_follows: + description: Follow relationships where the current user's feeds are following + this feed + items: + $ref: '#/components/schemas/FollowResponse' + title: Own Follows + type: array + x-stream-index: "014" + pin_count: + description: Number of pinned activities in this feed + format: int32 + title: Pin Count + type: integer + x-stream-index: "013" updated_at: + description: When the feed was last updated format: date-time + title: Updated At type: number - x-stream-index: "012" - user: - $ref: '#/components/schemas/User' - x-stream-index: "008" - user_id: + x-stream-index: "016" + visibility: + description: Visibility setting for the feed + title: Visibility type: string - x-stream-index: "007" + x-stream-index: "008" required: - - channel_cid - - message_id - - user_id - - task_id + - group_id + - id + - feed + - name + - description + - created_by + - member_count + - follower_count + - following_count + - pin_count - created_at - updated_at + title: Feed type: object - MessageRequest: + FeedUpdatedEvent: + description: Emitted when a feed is created. + nullable: true properties: - attachments: - items: - $ref: '#/components/schemas/Attachment' - maximum: 30 - type: array - x-stream-index: "004" + created_at: + format: date-time + type: number + x-stream-index: 002.001.003 custom: additionalProperties: {} type: object - x-stream-index: "007" - id: - maxLength: 255 - type: string + x-stream-index: 002.001.007 + feed: + $ref: '#/components/schemas/FeedResponse' + description: The feed that was created + title: Feed x-stream-index: "001" - mentioned_users: - items: - type: string - maximum: 100 - type: array - x-stream-index: "008" - mml: + feed_visibility: type: string - x-stream-index: "003" - parent_id: + x-stream-index: "002.003" + fid: type: string - x-stream-index: "005" - pin_expires: + x-stream-index: "002.002" + received_at: format: date-time type: number - x-stream-index: "015" - pinned: - type: boolean - x-stream-index: "013" - pinned_at: - format: date-time - nullable: true + x-stream-index: 002.001.004 + type: + default: feeds.feed.updated + description: 'The type of event: "feeds.feed.updated" in this case' + title: Event Type type: string - x-stream-index: "014" - poll_id: + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who created the feed + title: User + x-stream-index: "003.001" + required: + - feed + - type + - created_at + - custom + - fid + title: FeedUpdatedEvent + 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 + FeedsEventPreferences: + properties: + comments: type: string - x-stream-index: "039" - quoted_message_id: + x-stream-index: "002" + mentions: type: string - x-stream-index: "009" - restricted_visibility: - items: - type: string - maximum: 10 - type: array - x-stream-index: "016" - shared_location: - $ref: '#/components/schemas/SharedLocation' - x-stream-index: "040" - show_in_channel: - type: boolean - x-stream-index: "006" - silent: - type: boolean - x-stream-index: "012" - text: + x-stream-index: "004" + new_followers: + type: string + x-stream-index: "003" + reactions: + type: string + x-stream-index: "001" + type: object + FeedsEventPreferencesInput: + properties: + comments: + enum: + - all + - none type: string x-stream-index: "002" - type: + mentions: enum: - - '''''' - - regular - - system + - all + - none type: string - x-stream-index: "011" + x-stream-index: "004" + new_followers: + enum: + - all + - none + type: string + x-stream-index: "003" + reactions: + enum: + - all + - none + type: string + x-stream-index: "001" type: object - MessageResponse: - description: Represents any chat message + FeedsReactionResponse: properties: - attachments: - description: Array of message attachments - items: - $ref: '#/components/schemas/Attachment' - title: Message attachments - type: array - x-stream-docs-page-id: message_format#attachment-format - x-stream-index: "008" - cid: - description: Channel unique identifier in : format - title: Channel CID + activity_id: + description: ID of the activity that was reacted to + title: Activity ID type: string - x-stream-index: "022" - command: - description: Contains provided slash command - title: Command + x-stream-index: "002" + comment_id: + description: ID of the comment that was reacted to + title: Comment ID type: string - x-stream-docs-page-id: custom_commands_webhook - x-stream-index: "004" + x-stream-index: "003" created_at: - description: Date/time of creation + description: When the reaction was created format: date-time - title: Created at + title: Created At type: number - x-stream-index: "023" + x-stream-index: "006" custom: additionalProperties: {} + description: Custom data for the reaction + title: Custom Data type: object - x-stream-index: "026" - deleted_at: - description: Date/time of deletion + x-stream-index: "005" + type: + description: Type of reaction + title: Type + type: string + x-stream-index: "004" + updated_at: + description: When the reaction was last updated format: date-time - title: Deleted at + title: Updated At type: number - x-stream-index: "025" - deleted_reply_count: - format: int32 - type: integer - x-stream-index: "018" - draft: - $ref: '#/components/schemas/DraftResponse' - x-stream-index: "041" - html: - description: Contains HTML markup of the message. Can only be set when using - server-side API - title: HTML content + x-stream-index: "007" + user: + $ref: '#/components/schemas/UserResponse' + description: User who created the reaction + title: User + x-stream-index: "001" + required: + - user + - activity_id + - type + - created_at + - updated_at + title: Activity Reaction + type: object + Field: + nullable: true + properties: + short: + type: boolean + x-stream-index: "003" + title: type: string - x-stream-index: "005" - i18n: - additionalProperties: - type: string - description: Object with translations. Key `language` contains the original - language key. Other keys contain translations - title: Internationalization info - type: object - x-stream-docs-page-id: translation - x-stream-index: "030" - id: - description: Message ID is unique string identifier of the message - title: ID + x-stream-index: "001" + value: type: string + x-stream-index: "002" + required: + - title + - value + - short + type: object + FileUploadConfig: + properties: + allowed_file_extensions: + items: + type: string + type: array x-stream-index: "001" - image_labels: - additionalProperties: - items: - type: string - type: array - description: Contains image moderation information - title: Image moderation labels - type: object - x-stream-index: "028" - latest_reactions: - description: List of 10 latest reactions to this message + allowed_mime_types: items: - $ref: '#/components/schemas/ReactionResponse' - title: Latest reactions + type: string type: array - x-stream-index: "009" - mentioned_users: - description: List of mentioned users + x-stream-index: "003" + blocked_file_extensions: items: - $ref: '#/components/schemas/UserResponse' - title: Mentioned Users + type: string type: array - x-stream-index: "029" - message_text_updated_at: - format: date-time - type: number - x-stream-index: "036" - mml: - description: Should be empty if `text` is provided. Can only be set when - using server-side API - title: Messaging Markup Language - type: string - x-stream-docs-page-id: mml_overview - x-stream-index: "003" - moderation: - $ref: '#/components/schemas/ModerationV2Response' - x-stream-index: "039" - own_reactions: - description: List of 10 latest reactions of authenticated user to this message + x-stream-index: "002" + blocked_mime_types: items: - $ref: '#/components/schemas/ReactionResponse' - title: Own reactions + type: string type: array - x-stream-index: "010" - parent_id: - description: ID of parent message (thread) - title: Parent message ID + x-stream-index: "004" + size_limit: + format: int32 + maximum: 104857600 + minimum: 0 + type: integer + x-stream-index: "005" + required: + - allowed_file_extensions + - blocked_file_extensions + - allowed_mime_types + - blocked_mime_types + - size_limit + type: object + FileUploadRequest: + nullable: true + properties: + file: + description: file field + title: File type: string - x-stream-docs-page-id: threads - x-stream-index: "015" - pin_expires: - description: Date when pinned message expires - format: date-time - title: Pin expiration date - type: number - x-stream-docs-page-id: pinned_messages - x-stream-index: "035" - pinned: - description: Whether message is pinned or not - title: Pinned - type: boolean - x-stream-docs-page-id: pinned_messages - x-stream-index: "032" - pinned_at: - description: Date when message got pinned - format: date-time - title: Pinned at - type: number - x-stream-docs-page-id: pinned_messages - x-stream-index: "033" - pinned_by: - $ref: '#/components/schemas/UserResponse' - description: Contains user who pinned the message - title: Pinned by - x-stream-docs-page-id: pinned_messages - x-stream-index: "034" - poll: - $ref: '#/components/schemas/PollResponseData' - x-stream-index: "038" - poll_id: - description: Identifier of the poll to include in the message - title: Poll ID + x-stream-index: "001" + user: + $ref: '#/components/schemas/OnlyUserID' + description: user for the request **server side only** + title: User + x-stream-index: "002" + type: object + FileUploadResponse: + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration type: string - x-stream-index: "037" - quoted_message: - $ref: '#/components/schemas/MessageResponse' - description: Contains quoted message - title: Quoted message - x-stream-docs-page-id: threads#quote-message - x-stream-index: "020" - quoted_message_id: - title: ID of quoted message + x-stream-index: "003.001" + file: + description: URL to the uploaded asset. Should be used to put to `asset_url` + attachment field + title: File type: string - x-stream-docs-page-id: threads#quote-message + x-stream-index: "001" + thumb_url: + description: URL of the file thumbnail for supported file formats. Should + be put to `thumb_url` attachment field + title: Thumbnail URL + type: string + x-stream-index: "002" + required: + - duration + type: object + Flag: + description: Contains information about flagged user or message + nullable: true + properties: + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number x-stream-index: "019" - reaction_counts: - additionalProperties: - format: int32 - type: integer - description: 'An object containing number of reactions of each type. Key: - reaction type (string), value: number of reactions (int)' - title: Reaction counts - type: object - x-stream-index: "011" - reaction_groups: - additionalProperties: - $ref: '#/components/schemas/ReactionGroupResponse' + custom: + additionalProperties: {} + description: Additional metadata about the flag + title: Custom type: object x-stream-index: "014" - reaction_scores: - additionalProperties: - format: int32 - type: integer - description: 'An object containing scores of reactions of each type. Key: - reaction type (string), value: total score of reactions (int)' - title: Reaction scores - type: object + entity_creator_id: + description: ID of the user who created the flagged entity + title: Entity Creator ID + type: string + x-stream-index: "009" + entity_id: + description: Unique identifier of the entity being flagged + title: Entity ID + type: string + x-stream-index: "008" + entity_type: + description: Type of entity being flagged (e.g., message, user) + title: Entity Type + type: string + x-stream-index: "007" + is_streamed_content: + type: boolean x-stream-index: "012" - reminder: - $ref: '#/components/schemas/ReminderResponseData' - x-stream-index: "042" - reply_count: - description: Number of replies to this message - format: int32 - title: Reply count - type: integer - x-stream-index: "017" - restricted_visibility: - description: A list of user ids that have restricted visibility to the message, - if the list is not empty, the message is only visible to the users in - the list + labels: + description: Labels from bodyguard, API calls, our own AI etc items: type: string - title: Restricted visibility + title: Labels type: array - x-stream-index: "040" - shadowed: - description: Whether the message was shadowed or not - title: Shadowed - type: boolean - x-stream-docs-page-id: moderation#shadow-ban - x-stream-index: "027" - shared_location: - $ref: '#/components/schemas/SharedLocationResponseData' - description: Contains shared location data - title: Shared Location - x-stream-index: "043" - show_in_channel: - description: Whether thread reply should be shown in the channel as well - title: Show in channel - type: boolean - x-stream-docs-page-id: threads - x-stream-index: "016" - silent: - description: Whether message is silent or not - title: Silent - type: boolean - x-stream-index: "031" - text: - description: Text of the message. Should be empty if `mml` is provided - title: Text + x-stream-index: "015" + moderation_payload: + $ref: '#/components/schemas/ModerationPayload' + description: Content being flagged + title: Moderation Payload + x-stream-index: "010" + moderation_payload_hash: type: string - x-stream-index: "002" - thread_participants: - description: List of users who participate in thread + x-stream-index: "011" + reason: + description: Optional explanation for why the content is being flagged + title: Reason + type: string + x-stream-index: "013" + result: + description: Result of bodyguard, API calls, our own AI etc items: - $ref: '#/components/schemas/UserResponse' - title: Thread participants + additionalProperties: {} + type: object + title: Result type: array - x-stream-docs-page-id: threads#quote-message - x-stream-index: "021" + x-stream-index: "016" + review_queue_item: + $ref: '#/components/schemas/ReviewQueueItem' + x-stream-index: "018" + review_queue_item_id: + description: ID of the review queue item + title: Review Queue Item ID + type: string + x-stream-index: "017" type: - description: Contains type of the message - enum: - - regular - - ephemeral - - error - - reply - - system - - deleted - title: Message Type type: string - x-stream-docs-page-id: message_format#message-types - x-stream-index: "006" + x-stream-index: "004" updated_at: description: Date/time of the last update format: date-time title: Updated at type: number - x-stream-index: "024" + x-stream-index: "020" user: - $ref: '#/components/schemas/UserResponse' - description: Sender of the message. Required when using server-side API - title: User object - x-stream-index: "007" + $ref: '#/components/schemas/User' + description: User who flagged a message or a user + title: User + x-stream-index: "006" required: - - id - - text - - html - - type - - user - - attachments - - latest_reactions - - own_reactions - - reaction_counts - - reaction_scores - - reply_count - - deleted_reply_count - - cid + - entity_type + - entity_id + - result - created_at - updated_at - - custom - - shadowed - - mentioned_users - - silent - - pinned - - restricted_visibility - title: Message + title: Flag type: object - x-stream-docs-page-id: send_message - MessageStatsResponse: + FlagContentOptions: properties: - count_over_time: - items: - $ref: '#/components/schemas/CountByMinuteResponse' - type: array + reason: + type: string x-stream-index: "001" type: object - MessageUndeletedEvent: + FlagDetails: properties: - channel_id: - type: string - x-stream-index: "005.002" - channel_type: - type: string - x-stream-index: "005.003" - cid: + Extra: + additionalProperties: {} + type: object + writeOnly: true + x-stream-index: "002" + automod: + $ref: '#/components/schemas/AutomodDetails' + x-stream-index: "001" + original_text: type: string - x-stream-index: "005.001" + x-stream-index: "003" + required: + - Extra + - original_text + type: object + FlagFeedback: + properties: created_at: format: date-time type: number - x-stream-index: "004.002" - message: - $ref: '#/components/schemas/Message' - x-stream-index: "001.001" - team: - type: string - x-stream-index: "002.001" - thread_participants: + x-stream-index: "005" + labels: items: - $ref: '#/components/schemas/User' + $ref: '#/components/schemas/Label' type: array - x-stream-index: "001.002" - type: - default: message.undeleted + x-stream-index: "006" + message_id: type: string - x-stream-index: "004.001" - user: - $ref: '#/components/schemas/User' - x-stream-index: "003.001" + x-stream-index: "004" required: - - type + - message_id - created_at - - cid - - channel_id - - channel_type - title: MessageUndeletedEvent + - labels 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 - MessageUpdate: + FlagMessageDetails: properties: - change_set: - $ref: '#/components/schemas/MessageChangeSet' + pin_changed: + type: boolean x-stream-index: "002" - old_text: + should_enrich: + type: boolean + x-stream-index: "003" + skip_push: + type: boolean + x-stream-index: "004" + updated_by_id: type: string x-stream-index: "001" type: object - MessageUpdatedEvent: + FlagRequest: + nullable: true properties: - channel_id: + custom: + additionalProperties: {} + description: Additional metadata about the flag + title: Custom + type: object + x-stream-index: "006" + entity_creator_id: + description: ID of the user who created the flagged entity + title: Entity Creator ID type: string - x-stream-index: "005.002" - channel_type: + x-stream-index: "003" + entity_id: + description: Unique identifier of the entity being flagged + title: Entity ID type: string - x-stream-index: "005.003" - cid: + x-stream-index: "002" + entity_type: + description: Type of entity being flagged (e.g., message, user) + title: Entity Type type: string - x-stream-index: "005.001" - created_at: - format: date-time - type: number - x-stream-index: "004.002" - message: - $ref: '#/components/schemas/Message' - x-stream-index: "001.001" - team: + x-stream-index: "001" + moderation_payload: + $ref: '#/components/schemas/ModerationPayload' + description: Content being flagged + title: Moderation Payload + x-stream-index: "005" + reason: + description: Optional explanation for why the content is being flagged + maxLength: 255 + title: Reason + type: string + x-stream-index: "004" + required: + - entity_type + - entity_id + type: object + FlagResponse: + nullable: true + properties: + duration: type: string x-stream-index: "002.001" - thread_participants: - items: - $ref: '#/components/schemas/User' - type: array - x-stream-index: "001.002" - type: - default: message.updated + item_id: + description: Unique identifier of the created moderation item + title: Item ID type: string - x-stream-index: "004.001" - user: - $ref: '#/components/schemas/User' - x-stream-index: "003.001" + x-stream-index: "001" required: - - type - - created_at - - cid - - channel_id - - channel_type - title: MessageUpdatedEvent + - item_id + - duration 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 - MessageWithChannelResponse: - description: Represents any chat message + FlagUserOptions: properties: - attachments: - description: Array of message attachments + reason: + type: string + x-stream-index: "001" + type: object + FollowBatchRequest: + nullable: true + properties: + follows: + description: List of follow relationships to create items: - $ref: '#/components/schemas/Attachment' - title: Message attachments + $ref: '#/components/schemas/FollowRequest' + maximum: 1000 + minimum: 1 + title: Follows type: array - x-stream-docs-page-id: message_format#attachment-format - x-stream-index: "001.008" - channel: - $ref: '#/components/schemas/ChannelResponse' - description: Channel object - title: Channel - x-stream-index: "002" - cid: - description: Channel unique identifier in : format - title: Channel CID - type: string - x-stream-index: "001.022" - command: - description: Contains provided slash command - title: Command + x-stream-index: "001" + required: + - follows + title: Follow Batch Request + type: object + FollowBatchResponse: + nullable: true + properties: + duration: type: string - x-stream-docs-page-id: custom_commands_webhook - x-stream-index: "001.004" + x-stream-index: "002.001" + follows: + description: List of created follow relationships + items: + $ref: '#/components/schemas/FollowResponse' + title: Follows + type: array + x-stream-index: "001" + required: + - follows + - duration + title: Follow Batch Response + type: object + FollowCreatedEvent: + description: Emitted when a feed follows another feed. + nullable: true + properties: created_at: description: Date/time of creation format: date-time title: Created at type: number - x-stream-index: "001.023" + x-stream-index: 002.001.003 custom: additionalProperties: {} type: object - x-stream-index: "001.026" - deleted_at: - description: Date/time of deletion + x-stream-index: 002.001.007 + feed_visibility: + type: string + x-stream-index: "002.003" + fid: + type: string + x-stream-index: "002.002" + follow: + $ref: '#/components/schemas/FollowResponse' + x-stream-index: "001" + received_at: format: date-time - title: Deleted at type: number - x-stream-index: "001.025" - deleted_reply_count: - format: int32 - type: integer - x-stream-index: "001.018" - draft: - $ref: '#/components/schemas/DraftResponse' - x-stream-index: "001.041" - html: - description: Contains HTML markup of the message. Can only be set when using - server-side API - title: HTML content + x-stream-index: 002.001.004 + type: + default: feeds.follow.created + description: 'The type of event: "feeds.follow.created" in this case' + title: Event Type type: string - x-stream-index: "001.005" - i18n: - additionalProperties: - type: string - description: Object with translations. Key `language` contains the original - language key. Other keys contain translations - title: Internationalization info + x-stream-index: 002.001.002 + required: + - follow + - type + - created_at + - custom + - fid + title: FollowCreatedEvent + 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 + FollowDeletedEvent: + description: Emitted when a feed unfollows another feed. + nullable: true + properties: + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 002.001.003 + custom: + additionalProperties: {} type: object - x-stream-docs-page-id: translation - x-stream-index: "001.030" - id: - description: Message ID is unique string identifier of the message - title: ID + x-stream-index: 002.001.007 + feed_visibility: type: string - x-stream-index: "001.001" - image_labels: - additionalProperties: - items: - type: string - type: array - description: Contains image moderation information - title: Image moderation labels + x-stream-index: "002.003" + fid: + type: string + x-stream-index: "002.002" + follow: + $ref: '#/components/schemas/FollowResponse' + x-stream-index: "001" + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 + type: + default: feeds.follow.deleted + description: 'The type of event: "feeds.follow.deleted" in this case' + title: Event Type + type: string + x-stream-index: 002.001.002 + required: + - follow + - type + - created_at + - custom + - fid + title: FollowDeletedEvent + 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 + FollowRequest: + nullable: true + properties: + create_notification_activity: + description: Whether to create a notification activity for this follow + title: Create Notification Activity + type: boolean + x-stream-index: "004" + custom: + additionalProperties: {} + description: Custom data for the follow relationship + title: Custom Data type: object - x-stream-index: "001.028" - latest_reactions: - description: List of 10 latest reactions to this message - items: - $ref: '#/components/schemas/ReactionResponse' - title: Latest reactions - type: array - x-stream-index: "001.009" - mentioned_users: - description: List of mentioned users - items: - $ref: '#/components/schemas/UserResponse' - title: Mentioned Users - type: array - x-stream-index: "001.029" - message_text_updated_at: + x-stream-index: "002" + push_preference: + description: Push preference for the follow relationship + enum: + - all + - none + title: Push Preference + type: string + x-stream-index: "003" + skip_push: + type: boolean + x-stream-index: "005" + source: + description: Fully qualified ID of the source feed + maxLength: 255 + title: Source Feed + type: string + x-stream-index: "001.001" + target: + description: Fully qualified ID of the target feed + maxLength: 255 + title: Target Feed + type: string + x-stream-index: "001.002" + required: + - source + - target + title: Follow Request + type: object + FollowResponse: + properties: + created_at: + description: When the follow relationship was created format: date-time + title: Created At type: number - x-stream-index: "001.036" - mml: - description: Should be empty if `text` is provided. Can only be set when - using server-side API - title: Messaging Markup Language + x-stream-index: "009" + custom: + additionalProperties: {} + description: Custom data for the follow relationship + title: Custom Data + type: object + x-stream-index: "004" + follower_role: + description: Role of the follower (source user) in the follow relationship + title: Follower Role type: string - x-stream-docs-page-id: mml_overview - x-stream-index: "001.003" - moderation: - $ref: '#/components/schemas/ModerationV2Response' - x-stream-index: "001.039" - own_reactions: - description: List of 10 latest reactions of authenticated user to this message - items: - $ref: '#/components/schemas/ReactionResponse' - title: Own reactions - type: array - x-stream-index: "001.010" - parent_id: - description: ID of parent message (thread) - title: Parent message ID + x-stream-index: "008" + push_preference: + description: Push preference for notifications + enum: + - all + - none + title: Push Preference type: string - x-stream-docs-page-id: threads - x-stream-index: "001.015" - pin_expires: - description: Date when pinned message expires + x-stream-index: "003" + request_accepted_at: + description: When the follow request was accepted format: date-time - title: Pin expiration date + title: Request Accepted At type: number - x-stream-docs-page-id: pinned_messages - x-stream-index: "001.035" - pinned: - description: Whether message is pinned or not - title: Pinned - type: boolean - x-stream-docs-page-id: pinned_messages - x-stream-index: "001.032" - pinned_at: - description: Date when message got pinned + x-stream-index: "005" + request_rejected_at: + description: When the follow request was rejected format: date-time - title: Pinned at + title: Request Rejected At type: number - x-stream-docs-page-id: pinned_messages - x-stream-index: "001.033" - pinned_by: - $ref: '#/components/schemas/UserResponse' - description: Contains user who pinned the message - title: Pinned by - x-stream-docs-page-id: pinned_messages - x-stream-index: "001.034" - poll: - $ref: '#/components/schemas/PollResponseData' - x-stream-index: "001.038" - poll_id: - description: Identifier of the poll to include in the message - title: Poll ID - type: string - x-stream-index: "001.037" - quoted_message: - $ref: '#/components/schemas/MessageResponse' - description: Contains quoted message - title: Quoted message - x-stream-docs-page-id: threads#quote-message - x-stream-index: "001.020" - quoted_message_id: - title: ID of quoted message + x-stream-index: "006" + source_feed: + $ref: '#/components/schemas/FeedResponse' + description: Source feed object + title: Source Feed + x-stream-index: "001" + status: + description: Status of the follow relationship + enum: + - accepted + - pending + - rejected + title: Status type: string - x-stream-docs-page-id: threads#quote-message - x-stream-index: "001.019" - reaction_counts: - additionalProperties: - format: int32 - type: integer - description: 'An object containing number of reactions of each type. Key: - reaction type (string), value: number of reactions (int)' - title: Reaction counts - type: object - x-stream-index: "001.011" - reaction_groups: - additionalProperties: - $ref: '#/components/schemas/ReactionGroupResponse' + x-stream-index: "007" + target_feed: + $ref: '#/components/schemas/FeedResponse' + description: Target feed object + title: Target Feed + x-stream-index: "002" + updated_at: + description: When the follow relationship was last updated + format: date-time + title: Updated At + type: number + x-stream-index: "010" + required: + - source_feed + - target_feed + - push_preference + - status + - follower_role + - created_at + - updated_at + title: Follow + type: object + FollowUpdatedEvent: + description: Emitted when a follow relationship is updated. + nullable: true + properties: + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 002.001.003 + custom: + additionalProperties: {} type: object - x-stream-index: "001.014" - reaction_scores: - additionalProperties: - format: int32 - type: integer - description: 'An object containing scores of reactions of each type. Key: - reaction type (string), value: total score of reactions (int)' - title: Reaction scores - type: object - x-stream-index: "001.012" - reminder: - $ref: '#/components/schemas/ReminderResponseData' - x-stream-index: "001.042" - reply_count: - description: Number of replies to this message - format: int32 - title: Reply count - type: integer - x-stream-index: "001.017" - restricted_visibility: - description: A list of user ids that have restricted visibility to the message, - if the list is not empty, the message is only visible to the users in - the list - items: - type: string - title: Restricted visibility - type: array - x-stream-index: "001.040" - shadowed: - description: Whether the message was shadowed or not - title: Shadowed - type: boolean - x-stream-docs-page-id: moderation#shadow-ban - x-stream-index: "001.027" - shared_location: - $ref: '#/components/schemas/SharedLocationResponseData' - description: Contains shared location data - title: Shared Location - x-stream-index: "001.043" - show_in_channel: - description: Whether thread reply should be shown in the channel as well - title: Show in channel - type: boolean - x-stream-docs-page-id: threads - x-stream-index: "001.016" - silent: - description: Whether message is silent or not - title: Silent - type: boolean - x-stream-index: "001.031" - text: - description: Text of the message. Should be empty if `mml` is provided - title: Text + x-stream-index: 002.001.007 + feed_visibility: type: string - x-stream-index: "001.002" - thread_participants: - description: List of users who participate in thread - items: - $ref: '#/components/schemas/UserResponse' - title: Thread participants - type: array - x-stream-docs-page-id: threads#quote-message - x-stream-index: "001.021" - type: - description: Contains type of the message - enum: - - regular - - ephemeral - - error - - reply - - system - - deleted - title: Message Type + x-stream-index: "002.003" + fid: type: string - x-stream-docs-page-id: message_format#message-types - x-stream-index: "001.006" - updated_at: - description: Date/time of the last update + x-stream-index: "002.002" + follow: + $ref: '#/components/schemas/FollowResponse' + x-stream-index: "001" + received_at: format: date-time - title: Updated at type: number - x-stream-index: "001.024" - user: - $ref: '#/components/schemas/UserResponse' - description: Sender of the message. Required when using server-side API - title: User object - x-stream-index: "001.007" + x-stream-index: 002.001.004 + type: + default: feeds.follow.updated + description: 'The type of event: "feeds.follow.updated" in this case' + title: Event Type + type: string + x-stream-index: 002.001.002 required: - - id - - text - - html + - follow - type - - user - - attachments - - latest_reactions - - own_reactions - - reaction_counts - - reaction_scores - - reply_count - - deleted_reply_count - - cid - created_at - - updated_at - custom - - shadowed - - mentioned_users - - silent - - pinned - - restricted_visibility - - channel - title: Message + - fid + title: FollowUpdatedEvent type: object - x-stream-docs-page-id: send_message - ModerationActionConfig: - nullable: true + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + FrameRecordSettings: properties: - action: - type: string - x-stream-index: "006" - custom: - additionalProperties: {} - type: object - x-stream-index: "009" - description: - type: string - x-stream-index: "008" - entity_type: + capture_interval_in_seconds: + format: int32 + maximum: 60 + minimum: 2 + type: integer + x-stream-index: "003" + mode: + enum: + - available + - disabled + - auto-on type: string - x-stream-index: "004" - icon: + x-stream-index: "001" + quality: type: string - x-stream-index: "007" - order: + x-stream-index: "002" + required: + - mode + - capture_interval_in_seconds + type: object + FrameRecordingEgressConfig: + properties: + capture_interval_in_seconds: format: int32 type: integer + x-stream-index: "007" + external_storage: + $ref: '#/components/schemas/ExternalStorage' + x-stream-index: "006" + quality: + $ref: '#/components/schemas/Quality' + x-stream-index: "004" + storage_name: + type: string x-stream-index: "005" + type: object + FrameRecordingResponse: + properties: + status: + type: string + x-stream-index: "001" required: - - entity_type - - order - - action - - icon - - description - - custom + - status type: object - ModerationCustomActionEvent: + FrameRecordingSettingsRequest: properties: - created_at: - format: date-time - type: number - x-stream-index: "004.002" - item: - $ref: '#/components/schemas/ReviewQueueItem' + capture_interval_in_seconds: + format: int32 + maximum: 60 + minimum: 2 + type: integer + x-stream-index: "003" + mode: + enum: + - available + - disabled + - auto-on + type: string x-stream-index: "001" - message: - $ref: '#/components/schemas/Message' - x-stream-index: "002" - type: - default: moderation.custom_action + quality: + enum: + - 360p + - 480p + - 720p + - 1080p + - 1440p type: string - x-stream-index: "004.001" - user: - $ref: '#/components/schemas/User' - x-stream-index: "003.001" + x-stream-index: "002" required: - - type - - created_at - title: ModerationCustomActionEvent + - mode + - capture_interval_in_seconds 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 - ModerationFlaggedEvent: + FrameRecordingSettingsResponse: properties: - created_at: - format: date-time - type: number - x-stream-index: "004.002" - item: + capture_interval_in_seconds: + format: int32 + maximum: 60 + minimum: 2 + type: integer + x-stream-index: "003" + mode: + enum: + - available + - disabled + - auto-on type: string x-stream-index: "001" - object_id: + quality: type: string x-stream-index: "002" - type: - default: moderation.flagged - type: string - x-stream-index: "004.001" - user: - $ref: '#/components/schemas/User' - x-stream-index: "003.001" required: - - type - - created_at - title: ModerationFlaggedEvent + - mode + - capture_interval_in_seconds 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 - ModerationMarkReviewedEvent: + FullUserResponse: properties: - created_at: + avg_response_time: + format: int32 + type: integer + x-stream-index: "001.018" + ban_expires: format: date-time type: number - x-stream-index: "004.002" - item: - $ref: '#/components/schemas/ReviewQueueItem' - x-stream-index: "001" - message: - $ref: '#/components/schemas/Message' - x-stream-index: "002" - type: - default: moderation.mark_reviewed - type: string - x-stream-index: "004.001" - user: - $ref: '#/components/schemas/User' - x-stream-index: "003.001" - required: - - type - - created_at - title: ModerationMarkReviewedEvent - 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 - ModerationPayload: - properties: - custom: - additionalProperties: {} - type: object - x-stream-index: "004" - images: - items: - type: string - maximum: 30 - type: array - x-stream-index: "002" - texts: + x-stream-index: "015" + banned: + type: boolean + x-stream-index: "001.012" + blocked_user_ids: items: type: string type: array - x-stream-index: "001" - videos: + x-stream-index: "014" + channel_mutes: items: - type: string + $ref: '#/components/schemas/ChannelMute' type: array - x-stream-index: "003" - type: object - ModerationResponse: - properties: - action: - type: string - x-stream-index: "004" - explicit: - format: float + x-stream-index: "007" + created_at: + format: date-time type: number - x-stream-index: "002" - spam: - format: float + x-stream-index: "001.009" + custom: + additionalProperties: {} + type: object + x-stream-index: "001.004" + deactivated_at: + format: date-time type: number - x-stream-index: "003" - toxic: - format: float + x-stream-index: "001.016" + deleted_at: + format: date-time type: number - x-stream-index: "001" - required: - - toxic - - explicit - - spam - - action - - automod_response - type: object - ModerationV2Response: - properties: - action: + x-stream-index: "001.011" + devices: + items: + $ref: '#/components/schemas/DeviceResponse' + type: array + x-stream-index: "004" + id: type: string - x-stream-index: "001" - blocklist_matched: + x-stream-index: "001.001" + image: type: string + x-stream-index: "001.003" + invisible: + type: boolean x-stream-index: "005" - image_harms: + language: + type: string + x-stream-index: "001.005" + last_active: + format: date-time + type: number + x-stream-index: "001.014" + latest_hidden_channels: items: type: string type: array - x-stream-index: "004" - original_text: + x-stream-index: "012" + mutes: + items: + $ref: '#/components/schemas/UserMuteResponse' + type: array + x-stream-index: "006" + name: type: string - x-stream-index: "002" - platform_circumvented: + x-stream-index: "001.002" + online: type: boolean - x-stream-index: "007" - semantic_filter_matched: + x-stream-index: "001.013" + privacy_settings: + $ref: '#/components/schemas/PrivacySettingsResponse' + x-stream-index: "003" + revoke_tokens_issued_before: + format: date-time + type: number + x-stream-index: "001.015" + role: type: string - x-stream-index: "006" - text_harms: + x-stream-index: "001.006" + shadow_banned: + type: boolean + x-stream-index: "013" + teams: items: type: string type: array - x-stream-index: "003" + x-stream-index: "001.007" + teams_role: + additionalProperties: + type: string + type: object + x-stream-index: "001.008" + total_unread_count: + format: int32 + type: integer + x-stream-index: "009" + unread_channels: + format: int32 + type: integer + x-stream-index: "010" + unread_count: + format: int32 + type: integer + x-stream-index: "008" + unread_threads: + format: int32 + type: integer + x-stream-index: "011" + updated_at: + format: date-time + type: number + x-stream-index: "001.010" required: - - action - - original_text + - id + - custom + - language + - role + - teams + - created_at + - updated_at + - banned + - online + - devices + - invisible + - mutes + - channel_mutes + - unread_count + - total_unread_count + - unread_channels + - unread_threads + - shadow_banned + - blocked_user_ids type: object - MuteChannelRequest: - nullable: true + GeofenceSettings: properties: - channel_cids: - description: Channel CIDs to mute (if multiple channels) + names: items: type: string - maximum: 25 - title: Channel CIDs type: array - x-stream-index: "002" - expiration: - description: Duration of mute in milliseconds - title: Expiration - type: integer - x-stream-index: "003" + x-stream-index: "001" + required: + - names type: object - MuteChannelResponse: - nullable: true + GeofenceSettingsRequest: properties: - channel_mute: - $ref: '#/components/schemas/ChannelMute' - description: Object with channel mute (if one channel was muted) - title: Channel mute - x-stream-index: "001" - channel_mutes: - description: Object with mutes (if multiple channels were muted) + names: items: - $ref: '#/components/schemas/ChannelMute' - title: Channel mutes + type: string type: array - x-stream-index: "002" - duration: - type: string - x-stream-index: "004.001" - own_user: - $ref: '#/components/schemas/OwnUser' - description: Authorized user object with fresh mutes information - title: Own user - x-stream-index: "003" - required: - - duration + x-stream-index: "001" type: object - MuteRequest: - nullable: true + GeofenceSettingsResponse: properties: - target_ids: - description: User IDs to mute (if multiple users) + names: items: type: string - title: Target IDs type: array x-stream-index: "001" - timeout: - description: Duration of mute in minutes - minimum: 0 - title: Timeout - type: integer - x-stream-index: "002" required: - - target_ids - title: MuteRequest + - names type: object - MuteResponse: + GetActivityResponse: nullable: true properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + description: The requested activity + title: Activity + x-stream-index: "001" duration: type: string - x-stream-index: "004.001" - mutes: - description: Object with mutes (if multiple users were muted) - items: - $ref: '#/components/schemas/UserMute' - title: Mutes - type: array - x-stream-index: "001" - non_existing_users: - description: A list of users that can't be found. Common cause for this - is deleted users - items: - type: string - title: Non Existing Users - type: array - x-stream-index: "003" - own_user: - $ref: '#/components/schemas/OwnUser' - description: Authorized user object with fresh mutes information - title: Own User - x-stream-index: "002" + x-stream-index: "002.001" required: + - activity - duration - title: MuteResponse + title: Get Activity Response type: object - MuteUsersRequest: + GetApplicationResponse: + description: Basic response information nullable: true properties: - audio: - title: Audio - type: boolean - x-stream-index: "005" - mute_all_users: - type: boolean - x-stream-index: "003" - screenshare: - title: Screenshare - type: boolean - x-stream-index: "007" - screenshare_audio: - title: ScreenshareAudio - type: boolean - x-stream-index: "008" - user_ids: - items: - type: string - title: UserIDs - type: array - x-stream-index: "004" - video: - title: Video - type: boolean - x-stream-index: "006" - title: MuteUsersRequest + app: + $ref: '#/components/schemas/AppResponseFields' + x-stream-index: "001" + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "002.001" + required: + - app + - duration + title: Response type: object - MuteUsersResponse: - description: MuteUsersResponse is the response payload for the mute users endpoint. + GetBlockedUsersResponse: nullable: true properties: + blocks: + description: Array of blocked user object + items: + $ref: '#/components/schemas/BlockedUserResponse' + title: Blocks + type: array + x-stream-index: "001" duration: description: Duration of the request in milliseconds title: Duration type: string - x-stream-index: "001.001" + x-stream-index: "002.001" required: + - blocks - duration - title: MuteUsersResponse type: object - NetworkMetricsReportResponse: + GetCallReportResponse: + description: Basic response information + nullable: true properties: - average_connection_time: - format: float - type: number + chat_activity: + $ref: '#/components/schemas/ChatActivityStatsResponse' + x-stream-index: "004" + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "001.001" + report: + $ref: '#/components/schemas/ReportResponse' x-stream-index: "003" - average_jitter: - format: float - type: number + session_id: + type: string x-stream-index: "002" - average_latency: - format: float - type: number - x-stream-index: "001" - average_time_to_reconnect: - format: float - type: number - x-stream-index: "004" + video_reactions: + items: + $ref: '#/components/schemas/VideoReactionsResponse' + type: array + x-stream-index: "005" + required: + - duration + - session_id + - report + title: Response type: object - NoiseCancellationSettings: + GetCallResponse: + nullable: true properties: - mode: - enum: - - available - - disabled - - auto-on + call: + $ref: '#/components/schemas/CallResponse' + x-stream-index: "001.001" + duration: type: string - x-stream-index: "001" + x-stream-index: "002.001" + members: + items: + $ref: '#/components/schemas/MemberResponse' + type: array + x-stream-index: "001.002" + membership: + $ref: '#/components/schemas/MemberResponse' + x-stream-index: "001.003" + own_capabilities: + items: + $ref: '#/components/schemas/OwnCapability' + type: array + x-stream-index: "001.004" required: - - mode + - call + - members + - own_capabilities + - blocked_users + - duration + title: GetCallResponse type: object - NotificationAddedToChannelEvent: + GetCommentRepliesResponse: + nullable: true properties: - channel: - $ref: '#/components/schemas/ChannelResponse' - x-stream-index: "003.004" - channel_id: + comments: + description: Threaded listing of replies to the comment + items: + $ref: '#/components/schemas/ThreadedCommentResponse' + title: Comments + type: array + x-stream-index: "001" + duration: type: string - x-stream-index: "003.002" - channel_member_count: - format: int32 - type: integer - x-stream-index: "003.005" - channel_type: + x-stream-index: "003.001" + next: type: string - x-stream-index: "003.003" - cid: + x-stream-index: "002.001" + prev: type: string - x-stream-index: "003.001" - created_at: - format: date-time - type: number x-stream-index: "002.002" - member: - $ref: '#/components/schemas/ChannelMember' - x-stream-index: "001.001" - type: - default: notification.added_to_channel + required: + - comments + - duration + title: Get Comment Replies Response + type: object + GetCommentResponse: + nullable: true + properties: + comment: + $ref: '#/components/schemas/CommentResponse' + description: Comment + title: Comment + x-stream-index: "001" + duration: type: string x-stream-index: "002.001" required: - - type - - created_at - - cid - - channel_id - - channel_type - - channel_member_count - title: NotificationAddedToChannelEvent + - comment + - duration + title: Get Comment Response 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 - NotificationChannelDeletedEvent: + GetCommentsResponse: + nullable: true properties: - channel: - $ref: '#/components/schemas/ChannelResponse' - x-stream-index: "003.004" - channel_id: + comments: + description: Threaded listing for the activity + items: + $ref: '#/components/schemas/ThreadedCommentResponse' + title: Comments + type: array + x-stream-index: "001" + duration: type: string - x-stream-index: "003.002" - channel_member_count: - format: int32 - type: integer - x-stream-index: "003.005" - channel_type: + x-stream-index: "003.001" + next: type: string - x-stream-index: "003.003" - cid: + x-stream-index: "002.001" + prev: type: string - x-stream-index: "003.001" - created_at: - format: date-time - type: number x-stream-index: "002.002" - team: - type: string - x-stream-index: "001.001" - type: - default: notification.channel_deleted + required: + - comments + - duration + title: Get Comments Response + type: object + GetConfigResponse: + nullable: true + properties: + config: + $ref: '#/components/schemas/ConfigResponse' + description: The retrieved moderation configuration + title: Config + x-stream-index: "001" + duration: type: string x-stream-index: "002.001" required: - - type - - created_at - - cid - - channel_id - - channel_type - - channel_member_count - title: NotificationChannelDeletedEvent + - duration 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 - NotificationChannelMutesUpdatedEvent: + GetDraftResponse: + description: Basic response information + nullable: true properties: - created_at: - format: date-time - type: number - x-stream-index: "002.002" - me: - $ref: '#/components/schemas/OwnUser' + draft: + $ref: '#/components/schemas/DraftResponse' x-stream-index: "001" - type: - default: notification.channel_mutes_updated + duration: + description: Duration of the request in milliseconds + title: Duration type: string x-stream-index: "002.001" required: - - me - - type - - created_at - title: NotificationChannelMutesUpdatedEvent + - draft + - duration + title: Response 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 - NotificationChannelTruncatedEvent: + GetEdgesResponse: + description: Basic response information + nullable: true properties: - channel: - $ref: '#/components/schemas/ChannelResponse' - x-stream-index: "002.004" - channel_id: - type: string - x-stream-index: "002.002" - channel_member_count: - format: int32 - type: integer - x-stream-index: "002.005" - channel_type: - type: string - x-stream-index: "002.003" - cid: + duration: + description: Duration of the request in milliseconds + title: Duration type: string x-stream-index: "002.001" - created_at: - format: date-time - type: number - x-stream-index: "001.002" - type: - default: notification.channel_truncated - type: string - x-stream-index: "001.001" + edges: + items: + $ref: '#/components/schemas/EdgeResponse' + type: array + x-stream-index: "001" required: - - type - - created_at - - cid - - channel_id - - channel_type - - channel_member_count - title: NotificationChannelTruncatedEvent + - edges + - duration + title: Response 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 - NotificationInviteAcceptedEvent: + GetFollowSuggestionsResponse: + nullable: true properties: - channel: - $ref: '#/components/schemas/ChannelResponse' - x-stream-index: "002.004" - channel_id: - type: string - x-stream-index: "002.002" - channel_member_count: - format: int32 - type: integer - x-stream-index: "002.005" - channel_type: - type: string - x-stream-index: "002.003" - cid: + duration: type: string x-stream-index: "002.001" - created_at: - format: date-time - type: number - x-stream-index: "001.002" - member: - $ref: '#/components/schemas/ChannelMember' - x-stream-index: "004.001" - type: - default: notification.invite_accepted + suggestions: + description: List of suggested feeds to follow + items: + $ref: '#/components/schemas/FeedResponse' + title: Suggestions + type: array + x-stream-index: "001" + required: + - suggestions + - duration + title: Follow Suggestions Response + type: object + GetManyMessagesResponse: + nullable: true + properties: + duration: type: string + x-stream-index: 001.002.001 + messages: + description: List of messages + items: + $ref: '#/components/schemas/MessageResponse' + title: Messages + type: array x-stream-index: "001.001" - user: - $ref: '#/components/schemas/User' - x-stream-index: "003.001" required: - - type - - created_at - - cid - - channel_id - - channel_type - - channel_member_count - title: NotificationInviteAcceptedEvent + - messages + - duration 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 - NotificationInviteRejectedEvent: + GetMessageResponse: + description: Basic response information + nullable: true properties: - channel: - $ref: '#/components/schemas/ChannelResponse' - x-stream-index: "002.004" - channel_id: - type: string - x-stream-index: "002.002" - channel_member_count: - format: int32 - type: integer - x-stream-index: "002.005" - channel_type: - type: string - x-stream-index: "002.003" - cid: - type: string - x-stream-index: "002.001" - created_at: - format: date-time - type: number - x-stream-index: "001.002" - member: - $ref: '#/components/schemas/ChannelMember' - x-stream-index: "004.001" - type: - default: notification.invite_rejected + duration: + description: Duration of the request in milliseconds + title: Duration type: string - x-stream-index: "001.001" - user: - $ref: '#/components/schemas/User' x-stream-index: "003.001" + message: + $ref: '#/components/schemas/MessageWithChannelResponse' + x-stream-index: "001" + pending_message_metadata: + additionalProperties: + type: string + type: object + x-stream-index: "002" required: - - type - - created_at - - cid - - channel_id - - channel_type - - channel_member_count - title: NotificationInviteRejectedEvent + - message + - duration + title: Response 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 - NotificationInvitedEvent: + GetOGResponse: + nullable: true properties: - channel: - $ref: '#/components/schemas/ChannelResponse' - x-stream-index: "002.004" - channel_id: + actions: + items: + $ref: '#/components/schemas/Action' + type: array + x-stream-index: "001.015" + asset_url: + description: URL of detected video or audio + title: Image URL type: string - x-stream-index: "002.002" - channel_member_count: - format: int32 - type: integer - x-stream-index: "002.005" - channel_type: + x-stream-index: "001.017" + author_icon: type: string - x-stream-index: "002.003" - cid: + x-stream-index: "001.007" + author_link: + description: og:site + title: Author Link + type: string + x-stream-index: "001.006" + author_name: + description: og:site_name + title: Author Name + type: string + x-stream-index: "001.005" + color: + type: string + x-stream-index: "001.003" + custom: + additionalProperties: {} + type: object + x-stream-index: "001.018" + duration: type: string x-stream-index: "002.001" - created_at: - format: date-time - type: number + fallback: + type: string x-stream-index: "001.002" - member: - $ref: '#/components/schemas/ChannelMember' - x-stream-index: "004.001" - type: - default: notification.invited + fields: + items: + $ref: '#/components/schemas/Field' + type: array + x-stream-index: "001.016" + footer: type: string - x-stream-index: "001.001" - user: - $ref: '#/components/schemas/User' - x-stream-index: "003.001" - required: - - type - - created_at - - cid - - channel_id - - channel_type - - channel_member_count - title: NotificationInvitedEvent - 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 - NotificationMarkReadEvent: - properties: - channel: - $ref: '#/components/schemas/ChannelResponse' - x-stream-index: "003.004" - channel_id: + x-stream-index: "001.013" + footer_icon: type: string - x-stream-index: "003.002" - channel_member_count: + x-stream-index: "001.014" + giphy: + $ref: '#/components/schemas/Images' + x-stream-index: "001.019" + image_url: + description: URL of detected image + title: Image URL + type: string + x-stream-index: "001.011" + og_scrape_url: + description: extracted url from the text + title: OG Scrape URL + type: string + x-stream-index: "001.020" + original_height: format: int32 type: integer - x-stream-index: "003.005" - channel_type: + x-stream-index: "001.022" + original_width: + format: int32 + type: integer + x-stream-index: "001.021" + pretext: type: string - x-stream-index: "003.003" - cid: + x-stream-index: "001.004" + text: + description: og:description + title: Text type: string - x-stream-index: "003.001" - created_at: - format: date-time - type: number - x-stream-index: "001.002" - team: + x-stream-index: "001.010" + thumb_url: + description: URL of detected thumb image + title: Image URL type: string - x-stream-index: "002.001" - total_unread_count: - format: int32 - type: integer - x-stream-index: "006" + x-stream-index: "001.012" + title: + description: og:title + title: Title + type: string + x-stream-index: "001.008" + title_link: + description: og:url + title: Title Link + type: string + x-stream-index: "001.009" type: - default: notification.mark_read + description: Attachment type, could be empty, image, audio or video + title: Type type: string x-stream-index: "001.001" - unread_channels: + required: + - custom + - duration + title: Get OG Attachment + type: object + x-stream-docs-page-id: og + GetOrCreateCallRequest: + nullable: true + properties: + data: + $ref: '#/components/schemas/CallRequest' + title: ReadOnlyData + x-stream-index: "003" + members_limit: format: int32 + maximum: 100 type: integer x-stream-index: "007" - unread_count: - format: int32 - type: integer + notify: + description: if provided it sends a notification event to the members for + this call + title: Notify + type: boolean x-stream-index: "005" - unread_threads: - format: int32 - type: integer - x-stream-index: "008" - user: - $ref: '#/components/schemas/User' - x-stream-index: "004.001" - required: - - type - - created_at - - cid - - channel_id - - channel_type - - channel_member_count - - unread_count - - total_unread_count - - unread_channels - - unread_threads - title: NotificationMarkReadEvent + ring: + description: if provided it sends a ring event to the members for this call + title: Ring + type: boolean + x-stream-index: "004" + video: + type: boolean + x-stream-index: "006" + title: GetOrCreateCallRequest 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 - NotificationMarkUnreadEvent: + GetOrCreateCallResponse: + nullable: true properties: - channel: - $ref: '#/components/schemas/ChannelResponse' - x-stream-index: "003.004" - channel_id: + call: + $ref: '#/components/schemas/CallResponse' + x-stream-index: "001.001" + created: + type: boolean + x-stream-index: "002" + duration: type: string - x-stream-index: "003.002" - channel_member_count: + x-stream-index: "003.001" + members: + items: + $ref: '#/components/schemas/MemberResponse' + type: array + x-stream-index: "001.002" + membership: + $ref: '#/components/schemas/MemberResponse' + x-stream-index: "001.003" + own_capabilities: + items: + $ref: '#/components/schemas/OwnCapability' + type: array + x-stream-index: "001.004" + required: + - call + - members + - own_capabilities + - blocked_users + - created + - duration + title: GetOrCreateCallResponse + type: object + GetOrCreateFeedRequest: + description: Client request + nullable: true + properties: + activity_selector_options: + additionalProperties: {} + type: object + x-stream-index: "006" + data: + $ref: '#/components/schemas/FeedInput' + x-stream-index: "003" + external_ranking: + additionalProperties: {} + type: object + x-stream-index: "007" + filter: + additionalProperties: {} + type: object + x-stream-index: "009" + followers_pagination: + $ref: '#/components/schemas/PagerRequest' + x-stream-index: "011" + following_pagination: + $ref: '#/components/schemas/PagerRequest' + x-stream-index: "012" + interest_weights: + additionalProperties: + format: float + type: number + type: object + x-stream-index: "008" + limit: format: int32 + maximum: 100 + minimum: 0 type: integer - x-stream-index: "003.005" - channel_type: + x-stream-index: "013.001" + member_pagination: + $ref: '#/components/schemas/PagerRequest' + x-stream-index: "010" + next: type: string - x-stream-index: "003.003" - cid: + x-stream-index: "013.002" + prev: type: string - x-stream-index: "003.001" - created_at: - format: date-time - type: number - x-stream-index: "001.002" - first_unread_message_id: + x-stream-index: "013.003" + view: type: string x-stream-index: "005" - last_read_at: - format: date-time - type: number - x-stream-index: "006" - last_read_message_id: + watch: + type: boolean + x-stream-index: "004" + title: ClientRequest + type: object + GetOrCreateFeedResponse: + description: Basic response information + nullable: true + properties: + activities: + items: + $ref: '#/components/schemas/ActivityResponse' + type: array + x-stream-index: "002" + aggregated_activities: + items: + $ref: '#/components/schemas/AggregatedActivityResponse' + type: array + x-stream-index: "003" + created: + type: boolean + x-stream-index: "015" + duration: + description: Duration of the request in milliseconds + title: Duration type: string + x-stream-index: "017.001" + feed: + $ref: '#/components/schemas/FeedResponse' + x-stream-index: "001" + followers: + items: + $ref: '#/components/schemas/FollowResponse' + type: array + x-stream-index: "005" + followers_pagination: + $ref: '#/components/schemas/PagerResponse' x-stream-index: "012" - team: - type: string - x-stream-index: "002.001" - thread_id: - type: string + following: + items: + $ref: '#/components/schemas/FollowResponse' + type: array + x-stream-index: "006" + following_pagination: + $ref: '#/components/schemas/PagerResponse' x-stream-index: "013" - total_unread_count: - format: int32 - type: integer - x-stream-index: "009" - type: - default: notification.mark_unread + member_pagination: + $ref: '#/components/schemas/PagerResponse' + x-stream-index: "011" + members: + items: + $ref: '#/components/schemas/FeedMemberResponse' + type: array + x-stream-index: "004" + next: type: string - x-stream-index: "001.001" - unread_channels: - format: int32 - type: integer - x-stream-index: "010" - unread_count: - format: int32 - type: integer + x-stream-index: "016.001" + notification_status: + $ref: '#/components/schemas/NotificationStatusResponse' + x-stream-index: "014" + own_capabilities: + items: + $ref: '#/components/schemas/FeedOwnCapability' + type: array x-stream-index: "008" - unread_messages: - format: int32 - type: integer + own_follows: + items: + $ref: '#/components/schemas/FollowResponse' + type: array + x-stream-index: "009" + own_membership: + $ref: '#/components/schemas/FeedMemberResponse' + x-stream-index: "010" + pinned_activities: + items: + $ref: '#/components/schemas/ActivityPinResponse' + type: array x-stream-index: "007" - unread_threads: - format: int32 - type: integer - x-stream-index: "011" - user: - $ref: '#/components/schemas/User' - x-stream-index: "004.001" + prev: + type: string + x-stream-index: "016.002" required: - - type - - created_at - - cid - - channel_id - - channel_type - - channel_member_count - - first_unread_message_id - - last_read_at - - unread_messages - - unread_count - - total_unread_count - - unread_channels - - unread_threads - title: NotificationMarkUnreadEvent + - feed + - activities + - aggregated_activities + - members + - followers + - following + - pinned_activities + - own_capabilities + - created + - duration + title: Response 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 - NotificationMutesUpdatedEvent: + GetReactionsResponse: + nullable: true properties: - created_at: - format: date-time - type: number - x-stream-index: "002.002" - me: - $ref: '#/components/schemas/OwnUser' - x-stream-index: "001" - type: - default: notification.mutes_updated + duration: type: string x-stream-index: "002.001" + reactions: + description: List of reactions + items: + $ref: '#/components/schemas/Reaction' + title: Reactions + type: array + x-stream-index: "001" required: - - me - - type - - created_at - title: NotificationMutesUpdatedEvent + - reactions + - duration 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 - NotificationNewMessageEvent: + GetRepliesResponse: + description: Basic response information + nullable: true properties: - channel: - $ref: '#/components/schemas/ChannelResponse' - x-stream-index: "004.004" - channel_id: - type: string - x-stream-index: "004.002" - channel_member_count: - format: int32 - type: integer - x-stream-index: "004.005" - channel_type: - type: string - x-stream-index: "004.003" - cid: + duration: + description: Duration of the request in milliseconds + title: Duration type: string - x-stream-index: "004.001" - created_at: - format: date-time - type: number - x-stream-index: "003.002" - message: - $ref: '#/components/schemas/Message' + x-stream-index: "002.001" + messages: + items: + $ref: '#/components/schemas/MessageResponse' + type: array x-stream-index: "001" - team: + required: + - messages + - duration + title: Response + type: object + GetThreadResponse: + nullable: true + properties: + duration: type: string x-stream-index: "002.001" - type: - default: notification.message_new - type: string - x-stream-index: "003.001" + thread: + $ref: '#/components/schemas/ThreadStateResponse' + description: Enriched thread state + title: Thread + x-stream-index: "001" required: - - message - - type - - created_at - - cid - - channel_id - - channel_type - - channel_member_count - title: NotificationNewMessageEvent + - thread + - duration 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 - NotificationRemovedFromChannelEvent: + GoLiveRequest: + nullable: true properties: - channel: - $ref: '#/components/schemas/ChannelResponse' - x-stream-index: "002.004" - channel_id: + recording_storage_name: type: string - x-stream-index: "002.002" - channel_member_count: - format: int32 - type: integer - x-stream-index: "002.005" - channel_type: + x-stream-index: "005" + start_closed_caption: + type: boolean + x-stream-index: "008" + start_hls: + type: boolean + x-stream-index: "003" + start_recording: + type: boolean + x-stream-index: "004" + start_transcription: + type: boolean + x-stream-index: "007" + transcription_storage_name: type: string - x-stream-index: "002.003" - cid: + x-stream-index: "006" + title: GoLiveRequest + type: object + GoLiveResponse: + description: Basic response information + nullable: true + properties: + call: + $ref: '#/components/schemas/CallResponse' + x-stream-index: "001" + duration: + description: Duration of the request in milliseconds + title: Duration type: string x-stream-index: "002.001" - created_at: - format: date-time - type: number - x-stream-index: "001.002" - member: - $ref: '#/components/schemas/ChannelMember' - x-stream-index: "004.001" - type: - default: notification.removed_from_channel - type: string - x-stream-index: "001.001" - user: - $ref: '#/components/schemas/User' - x-stream-index: "003.001" required: - - type - - created_at - - cid - - channel_id - - channel_type - - channel_member_count - title: NotificationRemovedFromChannelEvent + - call + - duration + title: Response 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 - NotificationSettings: + GoogleVisionConfig: properties: - call_live_started: - $ref: '#/components/schemas/EventNotificationSettings' - x-stream-index: "002" - call_missed: - $ref: '#/components/schemas/EventNotificationSettings' - x-stream-index: "006" - call_notification: - $ref: '#/components/schemas/EventNotificationSettings' - x-stream-index: "004" - call_ring: - $ref: '#/components/schemas/EventNotificationSettings' - x-stream-index: "005" enabled: type: boolean x-stream-index: "001" - session_started: - $ref: '#/components/schemas/EventNotificationSettings' - x-stream-index: "003" - required: - - enabled - - call_live_started - - session_started - - call_notification - - call_ring - - call_missed - type: object - NullTime: type: object - OCRRule: + GroupedStatsResponse: + nullable: true properties: - action: - enum: - - flag - - shadow - - remove - - bounce - - bounce_flag - - bounce_remove + name: type: string + x-stream-index: "001" + unique: + format: int32 + type: integer x-stream-index: "002" - label: + required: + - name + - unique + type: object + HLSEgressConfig: + properties: + composite_app_settings: + $ref: '#/components/schemas/CompositeAppSettings' + x-stream-index: "005" + playlist_url: type: string + x-stream-index: "007" + qualities: + items: + $ref: '#/components/schemas/Quality' + type: array + x-stream-index: "004" + start_unix_nano: + format: int64 + type: integer + x-stream-index: "006" + type: object + HLSSettings: + properties: + auto_on: + type: boolean x-stream-index: "001" + enabled: + type: boolean + x-stream-index: "002" + layout: + $ref: '#/components/schemas/LayoutSettings' + x-stream-index: "004" + quality_tracks: + items: + type: string + type: array + x-stream-index: "003" required: - - label - - action + - auto_on + - enabled + - quality_tracks type: object - OnlyUserID: + HLSSettingsRequest: properties: - id: - type: string + auto_on: + type: boolean x-stream-index: "001" + enabled: + type: boolean + x-stream-index: "002" + quality_tracks: + items: + type: string + maximum: 3 + minimum: 1 + type: array + x-stream-index: "003" required: - - id + - quality_tracks + title: HLSSettingsRequest type: object - OwnCapability: - description: All possibility of string to use - enum: - - block-users - - change-max-duration - - create-call - - create-reaction - - enable-noise-cancellation - - end-call - - join-backstage - - join-call - - join-ended-call - - mute-users - - pin-for-everyone - - read-call - - remove-call-member - - screenshare - - send-audio - - send-video - - start-broadcast-call - - start-closed-captions-call - - start-frame-record-call - - start-record-call - - start-transcription-call - - stop-broadcast-call - - stop-closed-captions-call - - stop-frame-record-call - - stop-record-call - - stop-transcription-call - - update-call - - update-call-member - - update-call-permissions - - update-call-settings - title: OwnCapability - type: string - OwnUser: + HLSSettingsResponse: + description: HLSSettings is the payload for HLS settings properties: - avg_response_time: - format: int32 - type: integer - x-stream-index: "046" - banned: + auto_on: + title: Auto On type: boolean - x-stream-index: "016" - blocked_user_ids: + x-stream-index: "001" + enabled: + title: Enabled + type: boolean + x-stream-index: "002" + quality_tracks: items: type: string + title: Quality Tracks type: array - x-stream-index: "045" - channel_mutes: + x-stream-index: "003" + required: + - auto_on + - enabled + - quality_tracks + - layout + title: HLSSettingsResponse + type: object + HarmConfig: + properties: + action_sequences: items: - $ref: '#/components/schemas/ChannelMute' + $ref: '#/components/schemas/ActionSequence' type: array - x-stream-index: "029" + x-stream-index: "001" + severity: + type: integer + x-stream-index: "002" + required: + - action_sequences + - severity + type: object + HealthCheckEvent: + nullable: true + properties: + cid: + type: string + x-stream-index: "003" + connection_id: + type: string + x-stream-index: "001" created_at: format: date-time type: number - x-stream-index: "008" + x-stream-index: "004.003" custom: additionalProperties: {} type: object - x-stream-index: "006" - deactivated_at: - format: date-time - type: number - x-stream-index: "014" - deleted_at: + x-stream-index: "004.007" + me: + $ref: '#/components/schemas/OwnUserResponse' + x-stream-index: "002" + received_at: format: date-time type: number - x-stream-index: "013" - devices: - items: - $ref: '#/components/schemas/Device' - type: array - x-stream-index: "027" - id: + x-stream-index: "004.004" + type: + default: health.check type: string - x-stream-index: "003" - invisible: + x-stream-index: "004.002" + required: + - connection_id + - type + - created_at + - custom + title: HealthCheckEvent + 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 + HideChannelRequest: + nullable: true + properties: + clear_history: + description: Whether to clear message history of the channel or not + title: Clear history type: boolean - x-stream-index: "023" - language: + x-stream-index: "001" + type: object + HideChannelResponse: + description: Basic response information + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration type: string - x-stream-index: "035" - last_active: - format: date-time - type: number - x-stream-index: "011" - last_engaged_at: - format: date-time - type: number - x-stream-index: "012" - latest_hidden_channels: + x-stream-index: "001.001" + required: + - duration + title: Response + type: object + ICEServer: + properties: + password: + type: string + x-stream-index: "003" + urls: items: type: string type: array - x-stream-index: "037" - mutes: + x-stream-index: "001" + username: + type: string + x-stream-index: "002" + required: + - urls + - username + - password + type: object + ImageContentParameters: + properties: + harm_labels: items: - $ref: '#/components/schemas/UserMute' + type: string type: array - x-stream-index: "028" - online: - type: boolean - x-stream-index: "022" - privacy_settings: - $ref: '#/components/schemas/PrivacySettings' - x-stream-index: "026" - push_preferences: - $ref: '#/components/schemas/PushPreferences' - x-stream-index: "025" - role: + x-stream-index: "001" + type: object + ImageData: + properties: + frames: + type: string + x-stream-index: "005" + height: + type: string + x-stream-index: "003" + size: type: string x-stream-index: "004" - teams: + url: + type: string + x-stream-index: "001" + width: + type: string + x-stream-index: "002" + required: + - url + - width + - height + - size + - frames + type: object + ImageRuleParameters: + properties: + harm_labels: items: type: string type: array - x-stream-index: "036" - teams_role: - additionalProperties: - type: string - type: object - x-stream-index: "005" - total_unread_count: - format: int32 - type: integer - x-stream-index: "031" - total_unread_count_by_team: - additionalProperties: - format: int32 - type: integer - type: object - x-stream-index: "032" - unread_channels: + x-stream-index: "003" + threshold: format: int32 type: integer - x-stream-index: "033" - unread_count: + x-stream-index: "001" + time_window: + type: string + x-stream-index: "002" + type: object + ImageSize: + properties: + crop: + description: Crop mode + enum: + - top + - bottom + - left + - right + - center + title: Crop + type: string + x-stream-index: "001" + height: + description: Target image height format: int32 + title: Height type: integer - x-stream-index: "030" - unread_threads: + x-stream-index: "003" + resize: + description: Resize method + enum: + - clip + - crop + - scale + - fill + title: Resize + type: string + x-stream-index: "002" + width: + description: Target image width format: int32 + title: Width type: integer - x-stream-index: "034" - updated_at: - format: date-time - type: number - x-stream-index: "009" - required: - - id - - role - - custom - - created_at - - updated_at - - banned - - online - - devices - - mutes - - channel_mutes - - unread_count - - total_unread_count - - total_unread_count_by_team - - unread_channels - - unread_threads - - language + x-stream-index: "004" + title: Image size configuration type: object - OwnUserResponse: + ImageUploadRequest: + nullable: true properties: - avg_response_time: - format: int32 - type: integer - x-stream-index: "001.018" - banned: - type: boolean - x-stream-index: "001.012" - blocked_user_ids: - items: - type: string - type: array - x-stream-index: "015" - channel_mutes: - items: - $ref: '#/components/schemas/ChannelMute' - type: array - x-stream-index: "007" - created_at: - format: date-time - type: number - x-stream-index: "001.009" - custom: - additionalProperties: {} - type: object - x-stream-index: "001.004" - deactivated_at: - format: date-time - type: number - x-stream-index: "001.016" - deleted_at: - format: date-time - type: number - x-stream-index: "001.011" - devices: + file: + type: string + x-stream-index: "001.001" + upload_sizes: + description: field with JSON-encoded array of image size configurations items: - $ref: '#/components/schemas/DeviceResponse' - title: Devices + $ref: '#/components/schemas/ImageSize' + title: Upload sizes type: array - x-stream-index: "004" - id: + x-stream-index: "002" + user: + $ref: '#/components/schemas/OnlyUserID' + x-stream-index: "001.002" + type: object + ImageUploadResponse: + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration type: string - x-stream-index: "001.001" - image: + x-stream-index: 001.003.001 + file: type: string - x-stream-index: "001.003" - invisible: - type: boolean - x-stream-index: "005" - language: + x-stream-index: "001.001" + thumb_url: type: string - x-stream-index: "001.005" - last_active: - format: date-time - type: number - x-stream-index: "001.014" - latest_hidden_channels: - items: - type: string - type: array - x-stream-index: "013" - mutes: + x-stream-index: "001.002" + upload_sizes: + description: Array of image size configurations items: - $ref: '#/components/schemas/UserMuteResponse' + $ref: '#/components/schemas/ImageSize' + title: Upload sizes type: array + x-stream-index: "002" + required: + - duration + type: object + Images: + properties: + fixed_height: + $ref: '#/components/schemas/ImageData' + x-stream-index: "002" + fixed_height_downsampled: + $ref: '#/components/schemas/ImageData' + x-stream-index: "004" + fixed_height_still: + $ref: '#/components/schemas/ImageData' + x-stream-index: "003" + fixed_width: + $ref: '#/components/schemas/ImageData' + x-stream-index: "005" + fixed_width_downsampled: + $ref: '#/components/schemas/ImageData' + x-stream-index: "007" + fixed_width_still: + $ref: '#/components/schemas/ImageData' x-stream-index: "006" - name: - type: string - x-stream-index: "001.002" - online: - type: boolean - x-stream-index: "001.013" - privacy_settings: - $ref: '#/components/schemas/PrivacySettingsResponse' + original: + $ref: '#/components/schemas/ImageData' + x-stream-index: "001" + required: + - original + - fixed_height + - fixed_height_still + - fixed_height_downsampled + - fixed_width + - fixed_width_still + - fixed_width_downsampled + type: object + IngressAudioEncodingOptions: + properties: + bitrate: + maximum: 128000 + minimum: 16000 + type: integer x-stream-index: "003" - push_preferences: - $ref: '#/components/schemas/PushPreferences' - x-stream-index: "002" - revoke_tokens_issued_before: - format: date-time - type: number - x-stream-index: "001.015" - role: - type: string - x-stream-index: "001.006" - teams: - items: - type: string - type: array - x-stream-index: "001.007" - teams_role: - additionalProperties: - type: string - type: object - x-stream-index: "001.008" - total_unread_count: - format: int32 - type: integer - x-stream-index: "009" - total_unread_count_by_team: - additionalProperties: - format: int32 - type: integer - type: object - x-stream-index: "010" - unread_channels: + channels: + enum: + - "1" + - "2" format: int32 type: integer - x-stream-index: "011" - unread_count: - format: int32 + x-stream-index: "001" + enable_dtx: + type: boolean + x-stream-index: "002" + required: + - channels + - enable_dtx + - bitrate + type: object + IngressAudioEncodingOptionsRequest: + properties: + bitrate: + maximum: 128000 + minimum: 16000 type: integer - x-stream-index: "008" - unread_threads: + x-stream-index: "003" + channels: + enum: + - "1" + - "2" format: int32 type: integer - x-stream-index: "012" - updated_at: - format: date-time - type: number - x-stream-index: "001.010" + x-stream-index: "001" + enable_dtx: + type: boolean + x-stream-index: "002" required: - - id - - custom - - language - - role - - teams - - created_at - - updated_at - - banned - - online - - devices - - invisible - - mutes - - channel_mutes - - unread_count - - total_unread_count - - unread_channels - - unread_threads + - channels + - bitrate type: object - PaginationParams: + IngressAudioEncodingResponse: properties: - limit: + bitrate: format: int32 - minimum: 0 type: integer - x-stream-index: "001" - offset: + x-stream-index: "003" + channels: format: int32 type: integer + x-stream-index: "001" + enable_dtx: + type: boolean x-stream-index: "002" + required: + - channels + - enable_dtx + - bitrate type: object - ParticipantCountByMinuteResponse: - nullable: true + IngressSettings: properties: - first: - format: int32 - type: integer + audio_encoding_options: + $ref: '#/components/schemas/IngressAudioEncodingOptions' x-stream-index: "002" - last: - format: int32 - type: integer + enabled: + type: boolean + x-stream-index: "001" + video_encoding_options: + additionalProperties: + $ref: '#/components/schemas/IngressVideoEncodingOptions' + type: object x-stream-index: "003" - max: - format: int32 - type: integer - x-stream-index: "004" - min: - format: int32 - type: integer - x-stream-index: "005" - start_ts: - format: date-time - type: number + required: + - enabled + type: object + IngressSettingsRequest: + properties: + audio_encoding_options: + $ref: '#/components/schemas/IngressAudioEncodingOptionsRequest' + x-stream-index: "002" + enabled: + type: boolean + x-stream-index: "001" + video_encoding_options: + additionalProperties: + $ref: '#/components/schemas/IngressVideoEncodingOptionsRequest' + type: object + x-stream-index: "003" + type: object + IngressSettingsResponse: + properties: + audio_encoding_options: + $ref: '#/components/schemas/IngressAudioEncodingResponse' + x-stream-index: "002" + enabled: + type: boolean x-stream-index: "001" + video_encoding_options: + additionalProperties: + $ref: '#/components/schemas/IngressVideoEncodingResponse' + type: object + x-stream-index: "003" required: - - start_ts - - first - - last - - max - - min + - enabled type: object - ParticipantCountOverTimeResponse: + IngressVideoEncodingOptions: properties: - by_minute: + layers: items: - $ref: '#/components/schemas/ParticipantCountByMinuteResponse' + $ref: '#/components/schemas/IngressVideoLayer' + minimum: 1 type: array x-stream-index: "001" + required: + - layers type: object - ParticipantReportResponse: + IngressVideoEncodingOptionsRequest: properties: - by_browser: - items: - $ref: '#/components/schemas/GroupedStatsResponse' - type: array - x-stream-index: "008" - by_country: - items: - $ref: '#/components/schemas/GroupedStatsResponse' - type: array - x-stream-index: "005" - by_device: + layers: items: - $ref: '#/components/schemas/GroupedStatsResponse' + $ref: '#/components/schemas/IngressVideoLayerRequest' + minimum: 1 type: array - x-stream-index: "006" - by_operating_system: + x-stream-index: "001" + required: + - layers + type: object + IngressVideoEncodingResponse: + properties: + layers: items: - $ref: '#/components/schemas/GroupedStatsResponse' + $ref: '#/components/schemas/IngressVideoLayerResponse' type: array - x-stream-index: "007" - count_over_time: - $ref: '#/components/schemas/ParticipantCountOverTimeResponse' - x-stream-index: "004" - max_concurrent: - format: int32 + x-stream-index: "001" + required: + - layers + type: object + IngressVideoLayer: + nullable: true + properties: + bitrate: + minimum: 1000 + type: integer + x-stream-index: "002" + codec: + enum: + - h264 + - vp8 + type: string + x-stream-index: "001" + frame_rate: + maximum: 60 + minimum: 1 type: integer x-stream-index: "003" - publishers: - $ref: '#/components/schemas/PublisherStatsResponse' - x-stream-index: "009" - subscribers: - $ref: '#/components/schemas/SubscriberStatsResponse' - x-stream-index: "010" - sum: - format: int32 + max_dimension: + minimum: 240 type: integer - x-stream-index: "001" - unique: - format: int32 + x-stream-index: "005" + min_dimension: + minimum: 240 type: integer - x-stream-index: "002" + x-stream-index: "004" required: - - sum - - unique + - codec + - bitrate + - frame_rate + - min_dimension + - max_dimension type: object - PendingMessageEvent: - description: Pending message event for async moderation + IngressVideoLayerRequest: nullable: true properties: - channel: - $ref: '#/components/schemas/Channel' - x-stream-index: "002.007" - created_at: - description: Date/time of creation - format: date-time - title: Created at - type: number - x-stream-index: "004" - custom: - additionalProperties: {} - type: object - x-stream-index: "001.007" - message: - $ref: '#/components/schemas/Message' - description: The pending message - title: Message - x-stream-index: "002.009" - metadata: - additionalProperties: - type: string - type: object - x-stream-index: "002.010" - method: - description: The method used for the pending message - title: Method + bitrate: + format: int32 + minimum: 1000 + type: integer + x-stream-index: "002" + codec: + enum: + - h264 + - vp8 type: string + x-stream-index: "001" + frame_rate_limit: + maximum: 60 + minimum: 1 + type: integer + x-stream-index: "005" + max_dimension: + minimum: 240 + type: integer + x-stream-index: "004" + min_dimension: + minimum: 240 + type: integer x-stream-index: "003" - received_at: - format: date-time - type: number - x-stream-index: "001.004" - type: - default: message.pending - description: 'The type of event: "message.pending" in this case' - title: Event Type - type: string - x-stream-index: "001.002" - user: - $ref: '#/components/schemas/User' - x-stream-index: "002.002" required: - - type - - custom - - method - - created_at - title: PendingMessageEvent + - codec + - bitrate + - min_dimension + - max_dimension + - frame_rate_limit 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 - PendingMessageResponse: + IngressVideoLayerResponse: nullable: true properties: - channel: - $ref: '#/components/schemas/ChannelResponse' + bitrate: + type: integer x-stream-index: "002" - message: - $ref: '#/components/schemas/MessageResponse' - x-stream-index: "003" - metadata: - additionalProperties: - type: string - type: object - x-stream-index: "004" - user: - $ref: '#/components/schemas/UserResponse' + codec: + type: string x-stream-index: "001" + frame_rate_limit: + type: integer + x-stream-index: "005" + max_dimension: + type: integer + x-stream-index: "004" + min_dimension: + type: integer + x-stream-index: "003" + required: + - codec + - bitrate + - min_dimension + - max_dimension + - frame_rate_limit type: object - PerSDKUsageReport: + JoinCallRequest: nullable: true properties: - by_version: - additionalProperties: - format: int32 - type: integer - type: object + create: + description: if true the call will be created if it doesn't exist + title: Create + type: boolean x-stream-index: "002" - total: + data: + $ref: '#/components/schemas/CallRequest' + x-stream-index: "003" + location: + title: Location + type: string + x-stream-index: "009" + members_limit: format: int32 + maximum: 100 + title: The amount of members that should be returned type: integer - x-stream-index: "001" + x-stream-index: "007" + migrating_from: + description: If the participant is migrating from another SFU, then this + is the ID of the previous SFU + title: MigratingFrom + type: string + x-stream-index: "010" + notify: + type: boolean + x-stream-index: "005" + ring: + description: if true and the call is created, the notification will include + ring=true + title: Ring + type: boolean + x-stream-index: "004" + video: + type: boolean + x-stream-index: "006" required: - - total - - by_version + - location + title: JoinCallRequest type: object - PermissionRequestEvent: - description: |- - This event is sent when a user requests access to a feature on a call, - clients receiving this event should display a permission request to the user + JoinCallResponse: + nullable: true + properties: + call: + $ref: '#/components/schemas/CallResponse' + x-stream-index: "001.001" + created: + title: Created + type: boolean + x-stream-index: "002" + credentials: + $ref: '#/components/schemas/Credentials' + title: Credentials + x-stream-index: "003" + duration: + type: string + x-stream-index: "005.001" + members: + items: + $ref: '#/components/schemas/MemberResponse' + type: array + x-stream-index: "001.002" + membership: + $ref: '#/components/schemas/MemberResponse' + x-stream-index: "001.003" + own_capabilities: + items: + $ref: '#/components/schemas/OwnCapability' + type: array + x-stream-index: "001.004" + stats_options: + $ref: '#/components/schemas/StatsOptions' + x-stream-index: "004" + required: + - call + - members + - own_capabilities + - blocked_users + - created + - credentials + - stats_options + - duration + title: JoinCallResponse + type: object + KickUserRequest: + description: KickUserRequest is the payload for kicking a user from a call. + Optionally block the user as well. + nullable: true + properties: + block: + description: If true, also block the user from rejoining the call + title: Block + type: boolean + x-stream-index: "004" + user_id: + description: The user to kick + title: UserID + type: string + x-stream-index: "003" + required: + - user_id + title: KickUserRequest + type: object + KickUserResponse: + description: KickUserResponse is the payload for kicking a user from a call. + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "001.001" + required: + - duration + title: KickUserResponse + type: object + KickedUserEvent: + description: This event is sent to call participants to notify when a user is + kicked from a call. Clients should make the kicked user leave the call UI. properties: call_cid: type: string @@ -12716,22 +13501,20 @@ components: format: date-time type: number x-stream-index: "001.002" - permissions: - description: The list of permissions requested by the user - items: - type: string - title: Permissions - type: array + kicked_by_user: + $ref: '#/components/schemas/UserResponse' + description: The user that kicked the participant, null if server-side + title: Kicked by x-stream-index: "004" type: - default: call.permission_request - description: 'The type of event: "call.permission_request" in this case' + default: call.kicked_user + description: 'The type of event: "call.kicked_user" in this case' title: Event Type type: string x-stream-index: "001.001" user: $ref: '#/components/schemas/UserResponse' - description: The user who sent the permission request + description: The user that was kicked title: User x-stream-index: "003" required: @@ -12739,728 +13522,595 @@ components: - created_at - call_cid - user - - permissions - title: PermissionRequestEvent + title: KickedUserEvent type: object x-stream-event-call-type: true x-stream-event-doc-group: call x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - PinRequest: - description: PinRequest is the payload for pinning a message. - nullable: true + LLMConfig: properties: - session_id: - description: the session ID of the user who pinned the message - title: SessionID - type: string - x-stream-index: "003" - user_id: - description: the user ID of the user who pinned the message - title: UserID + app_context: type: string + x-stream-index: "005" + async: + type: boolean + x-stream-index: "001" + enabled: + type: boolean x-stream-index: "002" + rules: + items: + $ref: '#/components/schemas/LLMRule' + type: array + x-stream-index: "003" + severity_descriptions: + additionalProperties: + type: string + type: object + x-stream-index: "004" required: - - user_id - - session_id - title: PinRequest - type: object - PinResponse: - 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 + - enabled + - rules type: object - Poll: + LLMRule: properties: - Custom: - additionalProperties: {} - type: object - writeOnly: true - x-stream-index: "023" - allow_answers: - type: boolean - x-stream-index: "010" - allow_user_suggested_options: - type: boolean - x-stream-index: "009" - answers_count: - format: int32 - type: integer - x-stream-index: "015" - created_at: - format: date-time - type: number - x-stream-index: "021" - created_by: - $ref: '#/components/schemas/User' - x-stream-index: "020" - created_by_id: + action: + enum: + - flag + - shadow + - remove + - bounce + - bounce_flag + - bounce_remove + - keep type: string - x-stream-index: "019" + x-stream-index: "003" description: type: string - x-stream-index: "005" - enforce_unique_vote: - type: boolean - x-stream-index: "007" - id: + x-stream-index: "002" + label: type: string - x-stream-index: "003" - is_closed: - type: boolean - x-stream-index: "011" - latest_answers: + x-stream-index: "001" + severity_rules: items: - $ref: '#/components/schemas/PollVote' + $ref: '#/components/schemas/BodyguardSeverityRule' type: array - x-stream-index: "017" - latest_votes_by_option: - additionalProperties: - items: - $ref: '#/components/schemas/PollVote' - type: array - type: object - x-stream-index: "016" - max_votes_allowed: - format: int32 - type: integer - x-stream-index: "008" - name: - type: string x-stream-index: "004" - options: + required: + - label + - description + - action + - severity_rules + type: object + Label: + properties: + harm_labels: items: - $ref: '#/components/schemas/PollOption' + type: string type: array - x-stream-index: "013" - own_votes: + x-stream-index: "003" + name: + type: string + x-stream-index: "001" + phrase_list_ids: items: - $ref: '#/components/schemas/PollVote' - type: array - x-stream-index: "018" - updated_at: - format: date-time - type: number - x-stream-index: "022" - vote_count: - format: int32 - type: integer - x-stream-index: "012" - vote_counts_by_option: - additionalProperties: format: int32 type: integer - type: object - x-stream-index: "014" - voting_visibility: - type: string - x-stream-index: "006" + type: array + x-stream-index: "002" required: - - id - name - - description - - enforce_unique_vote - - allow_user_suggested_options - - allow_answers - - vote_count - - options - - vote_counts_by_option - - answers_count - - latest_votes_by_option - - latest_answers - - own_votes - - created_by_id - - created_at - - updated_at - - Custom type: object - PollClosedEvent: - description: Emitted when a poll is closed. - nullable: true + LabelThresholds: properties: - activity_id: - type: string - x-stream-index: "001.003" - cid: - description: The CID of the channel containing the poll - title: Channel CID - type: string - x-stream-index: 001.001.002 - created_at: - description: Date/time of creation - format: date-time - title: Created at + block: + description: Threshold for automatic message block + format: float + maximum: 1 + minimum: 0 + title: Block type: number - x-stream-index: 001.001.001.003 - custom: - additionalProperties: {} - type: object - x-stream-index: 001.001.001.007 - message_id: - description: The ID of the message containing the poll - title: Message ID - type: string - x-stream-index: "001.002" - poll: - $ref: '#/components/schemas/PollResponseData' - description: The poll object which was closed - title: Poll - x-stream-index: "001.004" - received_at: - format: date-time + x-stream-index: "002" + flag: + description: Threshold for automatic message flag + format: float + maximum: 1 + minimum: 0 + title: Flag type: number - x-stream-index: 001.001.001.004 - type: - default: poll.closed - description: 'The type of event: "poll.closed" in this case' - title: Event Type - type: string - x-stream-index: 001.001.001.002 - required: - - type - - created_at - - custom - - poll - title: PollClosedEvent + x-stream-index: "001" 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 - PollDeletedEvent: - description: Emitted when a poll is deleted. - nullable: true + LayoutSettings: properties: - activity_id: + detect_orientation: + type: boolean + x-stream-index: "005" + external_app_url: type: string - x-stream-index: "001.003" - cid: - description: The CID of the channel containing the poll - title: Channel CID + x-stream-index: "003" + external_css_url: type: string - x-stream-index: 001.001.002 - created_at: - description: Date/time of creation - format: date-time - title: Created at - type: number - x-stream-index: 001.001.001.003 - custom: + x-stream-index: "004" + name: + enum: + - spotlight + - grid + - single-participant + - mobile + - custom + type: string + x-stream-index: "001" + options: additionalProperties: {} type: object - x-stream-index: 001.001.001.007 - message_id: - description: The ID of the message containing the poll - title: Message ID + x-stream-index: "002" + required: + - name + - external_app_url + - external_css_url + type: object + LayoutSettingsRequest: + properties: + detect_orientation: + type: boolean + x-stream-index: "005" + external_app_url: type: string - x-stream-index: "001.002" - poll: - $ref: '#/components/schemas/PollResponseData' - description: The poll object which was deleted - title: Poll - x-stream-index: "001.004" - received_at: - format: date-time - type: number - x-stream-index: 001.001.001.004 - type: - default: poll.deleted - description: 'The type of event: "poll.deleted" in this case' - title: Event Type + x-stream-index: "003" + external_css_url: type: string - x-stream-index: 001.001.001.002 + x-stream-index: "004" + name: + enum: + - spotlight + - grid + - single-participant + - mobile + - custom + type: string + x-stream-index: "001" + options: + additionalProperties: {} + type: object + x-stream-index: "002" required: - - type - - created_at - - custom - - poll - title: PollDeletedEvent + - name 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 - PollOption: - nullable: true + LimitsSettings: properties: - custom: - additionalProperties: {} - type: object - x-stream-index: "003" - id: - maxLength: 255 - type: string + max_duration_seconds: + format: int32 + type: integer + x-stream-index: "004" + max_participants: + format: int32 + type: integer x-stream-index: "001" - text: - type: string + max_participants_exclude_owner: + type: boolean + x-stream-index: "003" + max_participants_exclude_roles: + items: + type: string + type: array x-stream-index: "002" required: - - id - - text - - custom + - max_participants_exclude_roles type: object - PollOptionInput: - nullable: true + LimitsSettingsRequest: properties: - custom: - additionalProperties: {} - type: object + max_duration_seconds: + format: int32 + minimum: 0 + type: integer + x-stream-index: "004" + max_participants: + format: int32 + type: integer + x-stream-index: "001" + max_participants_exclude_owner: + type: boolean x-stream-index: "003" - text: - type: string + max_participants_exclude_roles: + items: + type: string + type: array x-stream-index: "002" type: object - PollOptionRequest: - nullable: true + LimitsSettingsResponse: properties: - custom: - additionalProperties: {} - type: object - x-stream-index: "003" - id: - maxLength: 255 - type: string + max_duration_seconds: + format: int32 + type: integer + x-stream-index: "004" + max_participants: + format: int32 + type: integer x-stream-index: "001" - text: - type: string + max_participants_exclude_owner: + type: boolean + x-stream-index: "003" + max_participants_exclude_roles: + items: + type: string + type: array x-stream-index: "002" required: - - id + - max_participants_exclude_roles type: object - PollOptionResponse: + ListBlockListResponse: + description: Basic response information nullable: true properties: + blocklists: + items: + $ref: '#/components/schemas/BlockListResponse' + type: array + x-stream-index: "001" duration: description: Duration of the request in milliseconds title: Duration type: string x-stream-index: "002.001" - poll_option: - $ref: '#/components/schemas/PollOptionResponseData' - description: Poll option - title: PollOptionResponseData - x-stream-index: "001" required: - - poll_option + - blocklists - duration + title: Response type: object - PollOptionResponseData: + ListDevicesResponse: + description: List devices response nullable: true properties: - custom: - additionalProperties: {} - type: object - x-stream-index: "003" - id: - type: string + devices: + description: List of devices + items: + $ref: '#/components/schemas/DeviceResponse' + title: Devices + type: array x-stream-index: "001" - text: + duration: type: string - x-stream-index: "002" + x-stream-index: "002.001" required: - - id - - text - - custom + - devices + - duration + title: ListDevicesResponse type: object - PollResponse: + ListRecordingsResponse: + description: Response for listing recordings nullable: true properties: duration: - description: Duration of the request in milliseconds - title: Duration type: string - x-stream-index: "002.001" - poll: - $ref: '#/components/schemas/PollResponseData' - description: Poll - title: PollResponseData - x-stream-index: "001" + x-stream-index: "001.001" + recordings: + items: + $ref: '#/components/schemas/CallRecording' + title: The list of recordings. + type: array + x-stream-index: "002" required: - - poll - duration + - recordings + title: ListRecordingsResponse type: object - PollResponseData: + ListTranscriptionsResponse: + nullable: true properties: - allow_answers: - type: boolean - x-stream-index: "008" - allow_user_suggested_options: - type: boolean - x-stream-index: "007" - answers_count: - format: int32 - type: integer - x-stream-index: "012" - created_at: - format: date-time - type: number - x-stream-index: "019" - created_by: - $ref: '#/components/schemas/UserResponse' - x-stream-index: "018" - created_by_id: - type: string - x-stream-index: "017" - custom: - additionalProperties: {} - type: object - x-stream-index: "021" - description: + duration: type: string - x-stream-index: "003" - enforce_unique_vote: + x-stream-index: "001.001" + transcriptions: + description: List of transcriptions for the call + items: + $ref: '#/components/schemas/CallTranscription' + title: Transcriptions + type: array + x-stream-index: "002" + required: + - duration + - transcriptions + title: ListTranscriptionsResponse + type: object + MarkActivityRequest: + nullable: true + properties: + mark_all_read: + description: Whether to mark all activities as read + title: Mark All Read type: boolean x-stream-index: "005" - id: - type: string - x-stream-index: "001" - is_closed: + mark_all_seen: + description: Whether to mark all activities as seen + title: Mark All Seen type: boolean - x-stream-index: "009" - latest_answers: + x-stream-index: "003" + mark_read: + description: List of activity IDs to mark as read items: - $ref: '#/components/schemas/PollVoteResponseData' + type: string + title: Mark Read type: array - x-stream-index: "015" - latest_votes_by_option: - additionalProperties: - items: - $ref: '#/components/schemas/PollVoteResponseData' - type: array - type: object - x-stream-index: "014" - max_votes_allowed: - format: int32 - type: integer - x-stream-index: "006" - name: - type: string - x-stream-index: "002" - options: + x-stream-index: "004" + mark_seen: + description: List of activity IDs to mark as seen items: - $ref: '#/components/schemas/PollOptionResponseData' + type: string + title: Mark Seen type: array - x-stream-index: "011" - own_votes: + x-stream-index: "006" + mark_watched: + description: List of activity IDs to mark as watched (for stories) items: - $ref: '#/components/schemas/PollVoteResponseData' + type: string + title: Mark Watched type: array - x-stream-index: "016" - updated_at: - format: date-time - type: number - x-stream-index: "020" - vote_count: - format: int32 - type: integer - x-stream-index: "010" - vote_counts_by_option: + x-stream-index: "007" + title: Mark Activity Request + type: object + MarkChannelsReadRequest: + nullable: true + properties: + read_by_channel: additionalProperties: - format: int32 - type: integer + type: string + description: Map of channel ID to last read message ID + maximum: 30 + title: Read by channel type: object - x-stream-index: "013" - voting_visibility: + x-stream-index: "001" + type: object + MarkReadRequest: + nullable: true + properties: + message_id: + description: ID of the message that is considered last read by client + title: Message ID type: string - x-stream-index: "004" + x-stream-index: "001" + thread_id: + description: Optional Thread ID to specifically mark a given thread as read + title: Thread ID + type: string + x-stream-index: "002" + type: object + MarkReadResponse: + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "002.001" + event: + $ref: '#/components/schemas/MessageReadEvent' + description: Mark read event + title: Event + x-stream-index: "001" required: - - id - - name - - description - - voting_visibility - - enforce_unique_vote - - allow_user_suggested_options - - allow_answers - - vote_count - - options - - answers_count - - vote_counts_by_option - - latest_votes_by_option - - latest_answers - - own_votes - - created_by_id - - created_at - - updated_at - - custom + - duration type: object - PollUpdatedEvent: - description: Emitted when a poll is updated. + MarkReviewedRequest: + properties: + content_to_mark_as_reviewed_limit: + format: int32 + maximum: 2500 + type: integer + x-stream-index: "002" + disable_marking_content_as_reviewed: + type: boolean + x-stream-index: "001" + type: object + MarkUnreadRequest: nullable: true properties: - activity_id: + message_id: + description: ID of the message from where the channel is marked unread + title: Message ID type: string - x-stream-index: "001.003" + x-stream-index: "001" + thread_id: + description: Mark a thread unread, specify both the thread and message id + title: Thread ID + type: string + x-stream-index: "003" + type: object + MemberAddedEvent: + properties: + channel_id: + type: string + x-stream-index: "004.002" + channel_type: + type: string + x-stream-index: "004.003" cid: - description: The CID of the channel containing the poll - title: Channel CID type: string - x-stream-index: 001.001.002 + x-stream-index: "004.001" created_at: - description: Date/time of creation format: date-time - title: Created at type: number - x-stream-index: 001.001.001.003 - custom: - additionalProperties: {} - type: object - x-stream-index: 001.001.001.007 - message_id: - description: The ID of the message containing the poll - title: Message ID + x-stream-index: "003.002" + member: + $ref: '#/components/schemas/ChannelMember' + x-stream-index: "001.001" + team: type: string - x-stream-index: "001.002" - poll: - $ref: '#/components/schemas/PollResponseData' - description: The poll object which was updated - title: Poll - x-stream-index: "001.004" - received_at: - format: date-time - type: number - x-stream-index: 001.001.001.004 + x-stream-index: "002.001" type: - default: poll.updated - description: 'The type of event: "poll.updated" in this case' - title: Event Type + default: member.added type: string - x-stream-index: 001.001.001.002 + x-stream-index: "003.001" + user: + $ref: '#/components/schemas/User' + x-stream-index: "005.001" required: - type - created_at - - custom - - poll - title: PollUpdatedEvent + - cid + - channel_id + - channel_type + title: MemberAddedEvent 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 - PollVote: - nullable: true + MemberLookup: properties: - answer_text: - type: string - x-stream-index: "007" - created_at: - format: date-time - type: number - x-stream-index: "010" - id: + Limit: + format: int32 + type: integer + writeOnly: true + x-stream-index: "001" + required: + - Limit + type: object + MemberRemovedEvent: + properties: + channel_id: type: string - x-stream-index: "004" - is_answer: - type: boolean - x-stream-index: "006" - option_id: + x-stream-index: "003.002" + channel_type: type: string - x-stream-index: "005" - poll_id: + x-stream-index: "003.003" + cid: type: string - x-stream-index: "003" - updated_at: + x-stream-index: "003.001" + created_at: format: date-time type: number - x-stream-index: "011" + x-stream-index: "002.002" + member: + $ref: '#/components/schemas/ChannelMember' + x-stream-index: "001.001" + type: + default: member.removed + type: string + x-stream-index: "002.001" user: $ref: '#/components/schemas/User' - x-stream-index: "009" - user_id: - type: string - x-stream-index: "008" + x-stream-index: "004.001" required: - - poll_id - - id - - option_id + - type - created_at - - updated_at + - cid + - channel_id + - channel_type + title: MemberRemovedEvent type: object - PollVoteCastedEvent: - description: Emitted when a vote is cast on a poll. - nullable: true + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + MemberRequest: + description: MemberRequest is the payload for adding a member to a call. properties: - activity_id: + custom: + additionalProperties: {} + description: Custom data for this object + title: Custom data + type: object + x-stream-index: "003" + role: + title: Role type: string - x-stream-index: 001.001.003 - cid: - description: The CID of the channel containing the poll - title: Channel CID + x-stream-index: "002" + user_id: + minLength: 1 + title: User ID type: string - x-stream-index: 001.001.001.002 + x-stream-index: "001" + required: + - user_id + title: MemberRequest + type: object + MemberResponse: + description: MemberResponse is the payload for a member of a call. + properties: created_at: description: Date/time of creation format: date-time title: Created at type: number - x-stream-index: 001.001.001.001.003 + x-stream-index: "005" custom: additionalProperties: {} + description: Custom member response data + title: Custom type: object - x-stream-index: 001.001.001.001.007 - message_id: - description: The ID of the message containing the poll - title: Message ID - type: string - x-stream-index: 001.001.002 - poll: - $ref: '#/components/schemas/PollResponseData' - description: The poll object - title: Poll - x-stream-index: 001.001.004 - poll_vote: - $ref: '#/components/schemas/PollVoteResponseData' - description: The vote that was cast - title: Poll Vote - x-stream-index: "001.002" - received_at: - format: date-time - type: number - x-stream-index: 001.001.001.001.004 - type: - default: poll.vote_casted - description: 'The type of event: "poll.vote_casted" in this case' - title: Event Type - type: string - x-stream-index: 001.001.001.001.002 - required: - - type - - created_at - - custom - - poll - - poll_vote - title: PollVoteCastedEvent - 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 - PollVoteChangedEvent: - description: Emitted when a vote on a poll is changed. - nullable: true - properties: - activity_id: - type: string - x-stream-index: 001.001.003 - cid: - description: The CID of the channel containing the poll - title: Channel CID - type: string - x-stream-index: 001.001.001.002 - created_at: - description: Date/time of creation + x-stream-index: "004" + deleted_at: + description: Date/time of deletion format: date-time - title: Created at + title: Deleted at type: number - x-stream-index: 001.001.001.001.003 - custom: - additionalProperties: {} - type: object - x-stream-index: 001.001.001.001.007 - message_id: - description: The ID of the message containing the poll - title: Message ID + x-stream-index: "007" + role: + title: Role type: string - x-stream-index: 001.001.002 - poll: - $ref: '#/components/schemas/PollResponseData' - description: The poll object - title: Poll - x-stream-index: 001.001.004 - poll_vote: - $ref: '#/components/schemas/PollVoteResponseData' - description: The updated vote - title: Poll Vote - x-stream-index: "001.002" - received_at: + x-stream-index: "003" + updated_at: + description: Date/time of the last update format: date-time + title: Updated at type: number - x-stream-index: 001.001.001.001.004 - type: - default: poll.vote_changed - description: 'The type of event: "poll.vote_changed" in this case' - title: Event Type + x-stream-index: "006" + user: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "001" + user_id: type: string - x-stream-index: 001.001.001.001.002 + x-stream-index: "002" required: - - type - - created_at + - user + - user_id - custom - - poll - - poll_vote - title: PollVoteChangedEvent + - created_at + - updated_at + title: MemberResponse 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 - PollVoteRemovedEvent: - description: Emitted when a vote is removed from a poll. - nullable: true + MemberUpdatedEvent: properties: - activity_id: + channel_id: type: string - x-stream-index: 001.001.003 + x-stream-index: "005.002" + channel_type: + type: string + x-stream-index: "005.003" cid: - description: The CID of the channel containing the poll - title: Channel CID type: string - x-stream-index: 001.001.001.002 + x-stream-index: "005.001" created_at: - description: Date/time of creation format: date-time - title: Created at type: number - x-stream-index: 001.001.001.001.003 - custom: - additionalProperties: {} - type: object - x-stream-index: 001.001.001.001.007 - message_id: - description: The ID of the message containing the poll - title: Message ID + x-stream-index: "003.002" + member: + $ref: '#/components/schemas/ChannelMember' + x-stream-index: "001.001" + team: type: string - x-stream-index: 001.001.002 - poll: - $ref: '#/components/schemas/PollResponseData' - description: The poll object - title: Poll - x-stream-index: 001.001.004 - poll_vote: - $ref: '#/components/schemas/PollVoteResponseData' - description: The vote that was removed - title: Poll Vote - x-stream-index: "001.002" - received_at: - format: date-time - type: number - x-stream-index: 001.001.001.001.004 + x-stream-index: "002.001" type: - default: poll.vote_removed - description: 'The type of event: "poll.vote_removed" in this case' - title: Event Type + default: member.updated type: string - x-stream-index: 001.001.001.001.002 + x-stream-index: "003.001" + user: + $ref: '#/components/schemas/User' + x-stream-index: "004.001" required: - type - created_at - - custom - - poll - - poll_vote - title: PollVoteRemovedEvent + - cid + - channel_id + - channel_type + title: MemberUpdatedEvent 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 - PollVoteResponse: + MembersResponse: nullable: true properties: duration: @@ -13468,3288 +14118,3159 @@ components: title: Duration type: string x-stream-index: "002.001" - vote: - $ref: '#/components/schemas/PollVoteResponseData' - description: Poll vote - title: PollVoteResponseData + members: + description: List of found members + items: + $ref: '#/components/schemas/ChannelMember' + title: Members + type: array x-stream-index: "001" required: + - members - duration type: object - PollVoteResponseData: - nullable: true + MembershipLevelResponse: properties: - answer_text: - type: string - x-stream-index: "005" created_at: + description: When the membership level was created format: date-time + title: Created At type: number - x-stream-index: "008" - id: - type: string - x-stream-index: "002" - is_answer: - type: boolean - x-stream-index: "004" - option_id: + x-stream-index: "007" + custom: + additionalProperties: {} + description: Custom data for the membership level + title: Custom Data + type: object + x-stream-index: "006" + description: + description: Description of the membership level + title: Description type: string x-stream-index: "003" - poll_id: + id: + description: Unique identifier for the membership level + title: ID type: string x-stream-index: "001" + name: + description: Display name for the membership level + title: Name + type: string + x-stream-index: "002" + priority: + description: Priority level + format: int32 + title: Priority + type: integer + x-stream-index: "004" + tags: + description: Activity tags this membership level gives access to + items: + type: string + title: Tags + type: array + x-stream-index: "005" updated_at: + description: When the membership level was last updated format: date-time + title: Updated At type: number - x-stream-index: "009" - user: - $ref: '#/components/schemas/UserResponse' - x-stream-index: "007" - user_id: - type: string - x-stream-index: "006" + x-stream-index: "008" required: - - poll_id - id - - option_id + - name + - priority + - tags - created_at - updated_at + title: Membership Level Response type: object - PollVotesResponse: - nullable: true + Message: properties: - duration: - description: Duration of the request in milliseconds - title: Duration - type: string - x-stream-index: "003.001" - next: - type: string - x-stream-index: "002.001" - prev: - type: string - x-stream-index: "002.002" - votes: - description: Poll votes + attachments: items: - $ref: '#/components/schemas/PollVoteResponseData' - title: PollVoteResponseList + $ref: '#/components/schemas/Attachment' type: array - x-stream-index: "001" - required: - - votes - - duration - type: object - PrivacySettings: - properties: - read_receipts: - $ref: '#/components/schemas/ReadReceipts' - x-stream-index: "002" - typing_indicators: - $ref: '#/components/schemas/TypingIndicators' - x-stream-index: "001" - type: object - PrivacySettingsResponse: - properties: - read_receipts: - $ref: '#/components/schemas/ReadReceiptsResponse' - x-stream-index: "002" - typing_indicators: - $ref: '#/components/schemas/TypingIndicatorsResponse' - x-stream-index: "001" - type: object - PublisherStatsResponse: - properties: - by_track: - items: - $ref: '#/components/schemas/TrackStatsResponse' - type: array - x-stream-index: "003" - total: - format: int32 - type: integer - x-stream-index: "001" - unique: - format: int32 - type: integer - x-stream-index: "002" - required: - - total - - unique - type: object - PushPreferenceInput: - nullable: true - properties: - call_level: - description: Set the level of call push notifications for the user. One - of all, none, default - enum: - - all - - none - - default - type: string - x-stream-index: "004" - channel_cid: - description: Set the push preferences for a specific channel. If empty it - sets the default for the user + x-stream-index: "012" + before_message_send_failed: + type: boolean + x-stream-index: "046" + cid: type: string - x-stream-index: "002" - chat_level: - description: Set the level of chat push notifications for the user. One - of all, mentions, none, default - enum: - - all - - mentions - - none - - default + x-stream-index: "028" + command: type: string - x-stream-index: "003" - disabled_until: - description: Disable push notifications till a certain time + x-stream-index: "006" + created_at: format: date-time type: number - x-stream-index: "005" - remove_disable: - description: Remove the disabled until time. (IE stop snoozing notifications) - type: boolean - x-stream-index: "006" - user_id: - description: The user id for which to set the push preferences. Required - when using server side auths, defaults to current user with client side - auth. - type: string - x-stream-index: "001" - type: object - PushPreferences: - properties: - call_level: - type: string - x-stream-index: "002" - chat_level: - type: string - x-stream-index: "001" - disabled_until: + x-stream-index: "030" + custom: + additionalProperties: {} + type: object + x-stream-index: "034" + deleted_at: format: date-time type: number - x-stream-index: "003" - type: object - Quality: - properties: - bitdepth: + x-stream-index: "033" + deleted_for_me: + type: boolean + x-stream-index: "059" + deleted_reply_count: format: int32 type: integer + x-stream-index: "023" + html: + type: string x-stream-index: "007" - framerate: - format: int32 - type: integer - x-stream-index: "008" - height: - format: int32 - type: integer - x-stream-index: "006" - name: + i18n: + additionalProperties: + type: string + type: object + x-stream-index: "044" + id: type: string - x-stream-index: "004" - video_bitrate: - format: int32 - type: integer - x-stream-index: "009" - width: - format: int32 - type: integer - x-stream-index: "005" - type: object - QualityScoreReport: - properties: - histogram: + x-stream-index: "002" + image_labels: + additionalProperties: + items: + type: string + type: array + type: object + x-stream-index: "040" + latest_reactions: items: - $ref: '#/components/schemas/ReportByHistogramBucket' + $ref: '#/components/schemas/Reaction' type: array - x-stream-index: "001" - required: - - histogram - type: object - QualityScoreReportResponse: - properties: - daily: + x-stream-index: "013" + mentioned_users: items: - $ref: '#/components/schemas/DailyAggregateQualityScoreReportResponse' + $ref: '#/components/schemas/User' type: array - x-stream-index: "001" - required: - - daily - type: object - QueryAggregateCallStatsRequest: - nullable: true - properties: - from: + x-stream-index: "043" + message_text_updated_at: + format: date-time + type: number + x-stream-index: "052" + mml: type: string - x-stream-index: "002" - report_types: + x-stream-index: "005" + moderation: + $ref: '#/components/schemas/ModerationV2Response' + x-stream-index: "056" + own_reactions: items: - type: string + $ref: '#/components/schemas/Reaction' type: array - x-stream-index: "004" - to: - type: string - x-stream-index: "003" - type: object - QueryAggregateCallStatsResponse: - description: Basic response information - nullable: true - properties: - call_duration_report: - $ref: '#/components/schemas/CallDurationReportResponse' - x-stream-index: "002" - call_participant_count_report: - $ref: '#/components/schemas/CallParticipantCountReportResponse' - x-stream-index: "004" - calls_per_day_report: - $ref: '#/components/schemas/CallsPerDayReportResponse' - x-stream-index: "003" - duration: - description: Duration of the request in milliseconds - title: Duration + x-stream-index: "014" + parent_id: type: string - x-stream-index: "001.001" - network_metrics_report: - $ref: '#/components/schemas/NetworkMetricsReportResponse' - x-stream-index: "008" - quality_score_report: - $ref: '#/components/schemas/QualityScoreReportResponse' - x-stream-index: "005" - sdk_usage_report: - $ref: '#/components/schemas/SDKUsageReportResponse' - x-stream-index: "006" - user_feedback_report: - $ref: '#/components/schemas/UserFeedbackReportResponse' - x-stream-index: "007" - required: - - duration - title: Response - type: object - QueryBannedUsersPayload: - properties: - exclude_expired_bans: - description: Whether to exclude expired bans or not - title: Exclude expired bans + x-stream-index: "019" + pin_expires: + format: date-time + type: number + x-stream-index: "051" + pinned: type: boolean - x-stream-index: "004" - filter_conditions: - additionalProperties: {} - type: object - x-stream-index: "001" - limit: - description: Number of records to return - format: int32 - maximum: 300 - minimum: 0 - title: Limit - type: integer - x-stream-index: "003.003" - offset: - description: Number of records to offset - format: int32 - maximum: 10000 - title: Offset + x-stream-index: "047" + pinned_at: + format: date-time + type: number + x-stream-index: "048" + pinned_by: + $ref: '#/components/schemas/User' + x-stream-index: "050" + poll: + $ref: '#/components/schemas/Poll' + x-stream-index: "054" + poll_id: + type: string + x-stream-index: "053" + quoted_message: + $ref: '#/components/schemas/Message' + x-stream-index: "025" + quoted_message_id: + type: string + x-stream-index: "024" + reaction_counts: + additionalProperties: + format: int32 + type: integer + type: object + x-stream-index: "015" + reaction_groups: + additionalProperties: + $ref: '#/components/schemas/ReactionGroupResponse' + type: object + x-stream-index: "017" + reaction_scores: + additionalProperties: + format: int32 + type: integer + type: object + x-stream-index: "016" + reminder: + $ref: '#/components/schemas/MessageReminder' + x-stream-index: "058" + reply_count: + format: int32 type: integer - x-stream-index: "003.004" - sort: - description: Array of sort parameters + x-stream-index: "022" + restricted_visibility: items: - $ref: '#/components/schemas/SortParamRequest' - maximum: 1 - title: Sort + type: string type: array - x-stream-index: "002" - required: - - filter_conditions - type: object - QueryBannedUsersResponse: - nullable: true - properties: - bans: - description: List of found bans + x-stream-index: "011" + shadowed: + type: boolean + x-stream-index: "036" + shared_location: + $ref: '#/components/schemas/SharedLocation' + x-stream-index: "055" + show_in_channel: + type: boolean + x-stream-index: "021" + silent: + type: boolean + x-stream-index: "045" + text: + type: string + x-stream-index: "004" + thread_participants: items: - $ref: '#/components/schemas/BanResponse' - title: BanResponse + $ref: '#/components/schemas/User' type: array - x-stream-index: "001" - duration: - description: Duration of the request in milliseconds - title: Duration + x-stream-index: "027" + type: type: string - x-stream-index: "002.001" + x-stream-index: "008" + updated_at: + format: date-time + type: number + x-stream-index: "031" + user: + $ref: '#/components/schemas/User' + x-stream-index: "010" required: - - bans - - duration + - id + - text + - html + - type + - restricted_visibility + - attachments + - latest_reactions + - own_reactions + - reaction_counts + - reaction_scores + - reaction_groups + - reply_count + - deleted_reply_count + - cid + - created_at + - updated_at + - custom + - shadowed + - mentioned_users + - silent + - pinned type: object - QueryCallMembersRequest: + MessageActionRequest: nullable: true properties: - filter_conditions: - additionalProperties: {} + form_data: + additionalProperties: + type: string + description: ReadOnlyData to execute command with + title: Form data type: object x-stream-index: "002" - id: - maxLength: 64 - type: string - x-stream-index: "001.002" - limit: - format: int32 - maximum: 100 - minimum: 0 - type: integer - x-stream-index: "004.001" - next: + required: + - form_data + type: object + MessageChangeSet: + properties: + attachments: + type: boolean + x-stream-index: "005" + custom: + type: boolean + x-stream-index: "001" + html: + type: boolean + x-stream-index: "004" + mentioned_user_ids: + type: boolean + x-stream-index: "006" + mml: + type: boolean + x-stream-index: "003" + pin: + type: boolean + x-stream-index: "009" + quoted_message_id: + type: boolean + x-stream-index: "007" + silent: + type: boolean + x-stream-index: "008" + text: + type: boolean + x-stream-index: "002" + required: + - custom + - text + - mml + - html + - attachments + - mentioned_user_ids + - quoted_message_id + - silent + - pin + type: object + MessageDeletedEvent: + properties: + channel_id: type: string x-stream-index: "004.002" - prev: + channel_type: type: string x-stream-index: "004.003" - sort: - items: - $ref: '#/components/schemas/SortParamRequest' - maximum: 1 - type: array - x-stream-index: "003" - type: - maxLength: 64 + cid: type: string + x-stream-index: "004.001" + created_at: + format: date-time + type: number + x-stream-index: "007.002" + deleted_for_me: + type: boolean + x-stream-index: "003" + hard_delete: + type: boolean + x-stream-index: "002.001" + message: + $ref: '#/components/schemas/Message' x-stream-index: "001.001" - required: - - type - - id - type: object - QueryCallMembersResponse: - description: Basic response information - nullable: true - properties: - duration: - description: Duration of the request in milliseconds - title: Duration + team: type: string - x-stream-index: "003.001" - members: + x-stream-index: "006.001" + thread_participants: items: - $ref: '#/components/schemas/MemberResponse' + $ref: '#/components/schemas/User' type: array - x-stream-index: "001" - next: - type: string - x-stream-index: "002.001" - prev: + x-stream-index: "001.002" + type: + default: message.deleted type: string - x-stream-index: "002.002" + x-stream-index: "007.001" + user: + $ref: '#/components/schemas/User' + x-stream-index: "005.001" required: - - members - - duration - title: Response + - hard_delete + - cid + - channel_id + - channel_type + - type + - created_at + title: MessageDeletedEvent type: object - QueryCallParticipantsRequest: + 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: - filter_conditions: + approved_at: + format: date-time + type: number + x-stream-index: "013" + created_at: + format: date-time + type: number + x-stream-index: "009" + created_by_automod: + type: boolean + x-stream-index: "001" + custom: additionalProperties: {} type: object + x-stream-index: "008" + details: + $ref: '#/components/schemas/FlagDetails' + x-stream-index: "006" + message: + $ref: '#/components/schemas/Message' + x-stream-index: "005" + moderation_feedback: + $ref: '#/components/schemas/FlagFeedback' x-stream-index: "003" - type: object - QueryCallParticipantsResponse: - nullable: true - properties: - call: - $ref: '#/components/schemas/CallResponse' - x-stream-index: "001.001" - duration: - type: string - x-stream-index: "004.001" - members: - items: - $ref: '#/components/schemas/MemberResponse' - type: array - x-stream-index: "001.002" - membership: - $ref: '#/components/schemas/MemberResponse' - x-stream-index: "001.003" - own_capabilities: - items: - $ref: '#/components/schemas/OwnCapability' - type: array - x-stream-index: "001.004" - participants: - description: List of call participants - items: - $ref: '#/components/schemas/CallParticipantResponse' - title: '[]CallParticipantResponse' - type: array + moderation_result: + $ref: '#/components/schemas/MessageModerationResult' x-stream-index: "002" - total_participants: - format: int32 - type: integer - x-stream-index: "003" + reason: + type: string + x-stream-index: "007" + rejected_at: + format: date-time + type: number + x-stream-index: "014" + reviewed_at: + format: date-time + type: number + x-stream-index: "011" + reviewed_by: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "012" + updated_at: + format: date-time + type: number + x-stream-index: "010" + user: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "004" required: - - call - - members - - own_capabilities - - blocked_users - - participants - - total_participants - - duration + - created_by_automod + - created_at + - updated_at type: object - QueryCallStatsRequest: - nullable: true + MessageModerationResult: + description: Result of the message moderation properties: - filter_conditions: - additionalProperties: {} - type: object - x-stream-index: "001" - limit: - format: int32 - maximum: 100 - minimum: 0 - type: integer - x-stream-index: "004.001" - next: - type: string - x-stream-index: "004.002" - prev: + action: + description: Action taken by automod + title: Action type: string - x-stream-index: "004.003" - sort: - items: - $ref: '#/components/schemas/SortParamRequest' - maximum: 2 - type: array x-stream-index: "002" - type: object - QueryCallStatsResponse: - description: Basic response information - nullable: true - properties: - duration: - description: Duration of the request in milliseconds - title: Duration + ai_moderation_response: + $ref: '#/components/schemas/ModerationResponse' + description: Response from AI moderation + title: ModerationResponse + x-stream-index: "007" + blocked_word: + description: Word that was blocked + title: Blocked word type: string - x-stream-index: "002.001" - next: + x-stream-index: "004" + blocklist_name: + description: Name of the blocklist + title: Blocklist name type: string - x-stream-index: "003.001" - prev: + x-stream-index: "005" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: "010" + message_id: + description: ID of the message + title: Message ID type: string - x-stream-index: "003.002" - reports: - items: - $ref: '#/components/schemas/CallStatsReportSummaryResponse' - type: array x-stream-index: "001" + moderated_by: + description: User who moderated the message + title: Moderated by + type: string + x-stream-index: "003" + moderation_thresholds: + $ref: '#/components/schemas/Thresholds' + description: Thresholds for AI moderation + title: Thresholds + x-stream-index: "006" + updated_at: + description: Date/time of the last update + format: date-time + title: Updated at + type: number + x-stream-index: "011" + user_bad_karma: + description: Whether user has bad karma + title: User bad karma + type: boolean + x-stream-index: "009" + user_karma: + description: Karma of the user + format: float + title: User karma + type: number + x-stream-index: "008" required: - - reports - - duration - title: Response + - message_id + - action + - user_karma + - user_bad_karma + - created_at + - updated_at + title: Message moderation result type: object - QueryCallsRequest: - nullable: true + MessageNewEvent: properties: - filter_conditions: - additionalProperties: {} - title: Filters - type: object - x-stream-index: "003" - limit: - format: int32 - maximum: 100 - minimum: 0 - type: integer - x-stream-index: "006.001" - next: + channel_id: type: string - x-stream-index: "006.002" - prev: + x-stream-index: "005.002" + channel_type: type: string - x-stream-index: "006.003" - sort: - description: Array of sort parameters - items: - $ref: '#/components/schemas/SortParamRequest' - maximum: 2 - title: Sort - type: array - x-stream-index: "004" - watch: - title: Watch - type: boolean - x-stream-index: "001" - title: QueryCallsRequest - type: object - QueryCallsResponse: - nullable: true - properties: - calls: + x-stream-index: "005.003" + cid: + type: string + x-stream-index: "005.001" + created_at: + format: date-time + type: number + x-stream-index: "004.002" + message: + $ref: '#/components/schemas/Message' + x-stream-index: "001.001" + team: + type: string + x-stream-index: "006.001" + thread_participants: items: - $ref: '#/components/schemas/CallStateResponseFields' - title: Calls + $ref: '#/components/schemas/User' type: array - x-stream-index: "001" - duration: - description: Duration of the request in milliseconds - title: Duration + x-stream-index: "001.002" + type: + default: message.new type: string + x-stream-index: "004.001" + user: + $ref: '#/components/schemas/User' x-stream-index: "003.001" - next: - type: string + watcher_count: + format: int32 + type: integer x-stream-index: "002.001" - prev: - type: string - x-stream-index: "002.002" required: - - calls - - duration - title: QueryCallsResponse + - watcher_count + - type + - created_at + - cid + - channel_id + - channel_type + title: MessageNewEvent type: object - QueryChannelsRequest: - nullable: true + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + MessageOptions: properties: - filter_conditions: - additionalProperties: {} - type: object - x-stream-index: "001" - limit: - description: Number of channels to limit - format: int32 - title: Limit - type: integer - x-stream-index: "008" - member_limit: - description: Number of members to limit - format: int32 - maximum: 100 - minimum: 0 - title: Member limit - type: integer - x-stream-index: "007" - message_limit: - description: Number of messages to limit - format: int32 - minimum: 0 - title: Message limit - type: integer - x-stream-index: "006" - offset: - description: Channel pagination offset - format: int32 - title: Offset - type: integer - x-stream-index: "009" - presence: - title: Presence - type: boolean - x-stream-index: "005" - sort: - description: List of sort parameters - items: - $ref: '#/components/schemas/SortParamRequest' - maximum: 5 - title: Sort - type: array - x-stream-index: "002" - state: - description: Whether to update channel state or not - title: State - type: boolean - x-stream-index: "004" - watch: - description: Whether to start watching found channels or not - title: Watch + include_thread_participants: type: boolean - x-stream-index: "003" - title: Query Channels Request - type: object - x-stream-docs-page-id: query_channels - QueryChannelsResponse: - nullable: true - properties: - channels: - description: List of channels - items: - $ref: '#/components/schemas/ChannelStateResponseFields' - title: Channels - type: array x-stream-index: "001" - duration: - description: Duration of the request in milliseconds - title: Duration - type: string - x-stream-index: "002.001" - required: - - channels - - duration - title: Channels list type: object - QueryDraftsRequest: - nullable: true + MessagePaginationParams: + type: object + MessageReadEvent: properties: - filter: - additionalProperties: {} - description: Filter to apply to the query - maximum: 3 - title: Filter - type: object - x-stream-index: "001" - limit: - format: int32 - maximum: 100 - minimum: 0 - type: integer - x-stream-index: "005.001" - next: + channel_id: type: string - x-stream-index: "005.002" - prev: + x-stream-index: "003" + channel_last_message_at: + format: date-time + type: number + x-stream-index: "005" + channel_type: + type: string + x-stream-index: "004" + cid: type: string - x-stream-index: "005.003" - sort: - description: Array of sort parameters - items: - $ref: '#/components/schemas/SortParamRequest' - maximum: 5 - title: Sort - type: array x-stream-index: "002" + created_at: + format: date-time + type: number + x-stream-index: "009" + last_read_message_id: + type: string + x-stream-index: "010" + team: + type: string + x-stream-index: "006" + thread: + $ref: '#/components/schemas/ThreadResponse' + x-stream-index: "008" + type: + default: message.read + type: string + x-stream-index: "001" + user: + $ref: '#/components/schemas/UserResponseCommonFields' + x-stream-index: "007" + required: + - type + - cid + - channel_id + - channel_type + - created_at type: object - QueryDraftsResponse: - nullable: true + MessageReminder: properties: - drafts: - description: Drafts - items: - $ref: '#/components/schemas/DraftResponse' - title: DraftsResponseList - type: array - x-stream-index: "001" - duration: - description: Duration of the request in milliseconds - title: Duration + channel: + $ref: '#/components/schemas/Channel' + x-stream-index: "004" + channel_cid: type: string - x-stream-index: "003.001" - next: + x-stream-index: "003" + created_at: + format: date-time + type: number + x-stream-index: "011" + message: + $ref: '#/components/schemas/Message' + x-stream-index: "006" + message_id: type: string - x-stream-index: "002.001" - prev: + x-stream-index: "005" + remind_at: + format: date-time + type: number + x-stream-index: "009" + task_id: type: string - x-stream-index: "002.002" + x-stream-index: "010" + updated_at: + format: date-time + type: number + x-stream-index: "012" + user: + $ref: '#/components/schemas/User' + x-stream-index: "008" + user_id: + type: string + x-stream-index: "007" required: - - drafts - - duration + - channel_cid + - message_id + - user_id + - task_id + - created_at + - updated_at type: object - QueryMembersPayload: - description: Client request + MessageRequest: properties: - filter_conditions: + attachments: + items: + $ref: '#/components/schemas/Attachment' + maximum: 30 + type: array + x-stream-index: "004" + custom: additionalProperties: {} type: object - x-stream-index: "004" + x-stream-index: "007" id: + maxLength: 255 type: string - x-stream-index: "002" - limit: - format: int32 - maximum: 300 - minimum: 0 - type: integer - x-stream-index: "006.003" - members: + x-stream-index: "001" + mentioned_users: items: - $ref: '#/components/schemas/ChannelMember' + type: string maximum: 100 type: array + x-stream-index: "008" + mml: + type: string x-stream-index: "003" - offset: - format: int32 - maximum: 10000 - type: integer - x-stream-index: "006.004" - sort: - items: - $ref: '#/components/schemas/SortParamRequest' - maximum: 1 - type: array - x-stream-index: "005" - type: - maxLength: 64 + parent_id: type: string - x-stream-index: "001" - required: - - type - - filter_conditions - title: ClientRequest - type: object - QueryMessageFlagsPayload: - properties: - filter_conditions: - additionalProperties: {} - type: object - x-stream-index: "001" - limit: - format: int32 - maximum: 300 - minimum: 0 - type: integer - x-stream-index: "003.003" - offset: - format: int32 - maximum: 10000 - type: integer - x-stream-index: "003.004" - show_deleted_messages: - description: Whether to include deleted messages in the results - title: ShowDeletedMessages + x-stream-index: "005" + pin_expires: + format: date-time + type: number + x-stream-index: "015" + pinned: type: boolean - x-stream-index: "002" - sort: - items: - $ref: '#/components/schemas/SortParamRequest' - maximum: 5 - type: array - x-stream-index: "003.005" - type: object - QueryMessageFlagsResponse: - description: Query message flags response - nullable: true - properties: - duration: - description: Duration of the request in milliseconds - title: Duration + x-stream-index: "013" + pinned_at: + format: date-time + nullable: true type: string - x-stream-index: "002.001" - flags: - description: The flags that match the query - items: - $ref: '#/components/schemas/MessageFlagResponse' - title: MessageFlagResponseList - type: array - x-stream-index: "001" - required: - - flags - - duration - title: QueryMessageFlagsResponse - type: object - QueryModerationConfigsRequest: - nullable: true - properties: - filter: - additionalProperties: {} - description: Filter conditions for moderation configs - title: Filter - type: object - x-stream-index: "001" - limit: - format: int32 - maximum: 100 - minimum: 0 - type: integer - x-stream-index: "003.001" - next: + x-stream-index: "014" + poll_id: type: string - x-stream-index: "003.002" - prev: + x-stream-index: "039" + quoted_message_id: type: string - x-stream-index: "003.003" - sort: - description: Sorting parameters for the results + x-stream-index: "009" + restricted_visibility: items: - $ref: '#/components/schemas/SortParamRequest' - title: Sort + type: string + maximum: 10 type: array + x-stream-index: "016" + shared_location: + $ref: '#/components/schemas/SharedLocation' + x-stream-index: "040" + show_in_channel: + type: boolean + x-stream-index: "006" + silent: + type: boolean + x-stream-index: "012" + text: + type: string x-stream-index: "002" + type: + enum: + - '''''' + - regular + - system + type: string + x-stream-index: "011" type: object - QueryModerationConfigsResponse: - nullable: true + MessageResponse: + description: Represents any chat message properties: - configs: - description: List of moderation configurations + attachments: + description: Array of message attachments items: - $ref: '#/components/schemas/ConfigResponse' - title: Configs + $ref: '#/components/schemas/Attachment' + title: Message attachments type: array - x-stream-index: "001" - duration: - type: string - x-stream-index: "003.001" - next: - type: string - x-stream-index: "002.001" - prev: - type: string - x-stream-index: "002.002" - required: - - configs - - duration - type: object - QueryPollVotesRequest: - nullable: true - properties: - filter: - additionalProperties: {} - description: Filter to apply to the query - title: Filter - type: object - x-stream-index: "003" - limit: - format: int32 - maximum: 100 - minimum: 0 - type: integer - x-stream-index: "005.001" - next: + x-stream-docs-page-id: message_format#attachment-format + x-stream-index: "008" + cid: + description: Channel unique identifier in : format + title: Channel CID type: string - x-stream-index: "005.002" - prev: + x-stream-index: "022" + command: + description: Contains provided slash command + title: Command type: string - x-stream-index: "005.003" - sort: - description: Array of sort parameters - items: - $ref: '#/components/schemas/SortParamRequest' - maximum: 5 - title: Sort - type: array + x-stream-docs-page-id: custom_commands_webhook x-stream-index: "004" - type: object - QueryPollsRequest: - nullable: true - properties: - filter: + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: "023" + custom: additionalProperties: {} - description: Filter to apply to the query - title: Filter type: object - x-stream-index: "002" - limit: + x-stream-index: "026" + deleted_at: + description: Date/time of deletion + format: date-time + title: Deleted at + type: number + x-stream-index: "025" + deleted_for_me: + type: boolean + x-stream-index: "044" + deleted_reply_count: format: int32 - maximum: 100 - minimum: 0 type: integer - x-stream-index: "005.001" - next: + x-stream-index: "018" + draft: + $ref: '#/components/schemas/DraftResponse' + x-stream-index: "041" + html: + description: Contains HTML markup of the message. Can only be set when using + server-side API + title: HTML content type: string - x-stream-index: "005.002" - prev: + x-stream-index: "005" + i18n: + additionalProperties: + type: string + description: Object with translations. Key `language` contains the original + language key. Other keys contain translations + title: Internationalization info + type: object + x-stream-docs-page-id: translation + x-stream-index: "030" + id: + description: Message ID is unique string identifier of the message + title: ID type: string - x-stream-index: "005.003" - sort: - description: Array of sort parameters + x-stream-index: "001" + image_labels: + additionalProperties: + items: + type: string + type: array + description: Contains image moderation information + title: Image moderation labels + type: object + x-stream-index: "028" + latest_reactions: + description: List of 10 latest reactions to this message items: - $ref: '#/components/schemas/SortParamRequest' - maximum: 5 - title: Sort + $ref: '#/components/schemas/ReactionResponse' + title: Latest reactions type: array - x-stream-index: "003" - type: object - QueryPollsResponse: - nullable: true - properties: - duration: - description: Duration of the request in milliseconds - title: Duration - type: string - x-stream-index: "003.001" - next: - type: string - x-stream-index: "002.001" - polls: - description: Polls data returned by the query + x-stream-index: "009" + mentioned_users: + description: List of mentioned users items: - $ref: '#/components/schemas/PollResponseData' - title: PollsResponseData + $ref: '#/components/schemas/UserResponse' + title: Mentioned Users type: array - x-stream-index: "001" - prev: - type: string - x-stream-index: "002.002" - required: - - polls - - duration - type: object - QueryReactionsRequest: - properties: - filter: - additionalProperties: {} - type: object - x-stream-index: "002" - limit: - format: int32 - maximum: 100 - minimum: 0 - type: integer - x-stream-index: "006.001" - next: - type: string - x-stream-index: "006.002" - prev: + x-stream-index: "029" + message_text_updated_at: + format: date-time + type: number + x-stream-index: "036" + mml: + description: Should be empty if `text` is provided. Can only be set when + using server-side API + title: Messaging Markup Language type: string - x-stream-index: "006.003" - sort: + x-stream-docs-page-id: mml_overview + x-stream-index: "003" + moderation: + $ref: '#/components/schemas/ModerationV2Response' + x-stream-index: "039" + own_reactions: + description: List of 10 latest reactions of authenticated user to this message items: - $ref: '#/components/schemas/SortParamRequest' - maximum: 2 + $ref: '#/components/schemas/ReactionResponse' + title: Own reactions type: array - x-stream-index: "003" - type: object - QueryReactionsResponse: - description: Basic response information - properties: - duration: - description: Duration of the request in milliseconds - title: Duration + x-stream-index: "010" + parent_id: + description: ID of parent message (thread) + title: Parent message ID type: string - x-stream-index: "002.001" - next: + x-stream-docs-page-id: threads + x-stream-index: "015" + pin_expires: + description: Date when pinned message expires + format: date-time + title: Pin expiration date + type: number + x-stream-docs-page-id: pinned_messages + x-stream-index: "035" + pinned: + description: Whether message is pinned or not + title: Pinned + type: boolean + x-stream-docs-page-id: pinned_messages + x-stream-index: "032" + pinned_at: + description: Date when message got pinned + format: date-time + title: Pinned at + type: number + x-stream-docs-page-id: pinned_messages + x-stream-index: "033" + pinned_by: + $ref: '#/components/schemas/UserResponse' + description: Contains user who pinned the message + title: Pinned by + x-stream-docs-page-id: pinned_messages + x-stream-index: "034" + poll: + $ref: '#/components/schemas/PollResponseData' + x-stream-index: "038" + poll_id: + description: Identifier of the poll to include in the message + title: Poll ID type: string - x-stream-index: "003.001" - prev: + x-stream-index: "037" + quoted_message: + $ref: '#/components/schemas/MessageResponse' + description: Contains quoted message + title: Quoted message + x-stream-docs-page-id: threads#quote-message + x-stream-index: "020" + quoted_message_id: + title: ID of quoted message type: string - x-stream-index: "003.002" - reactions: - items: - $ref: '#/components/schemas/ReactionResponse' - type: array - x-stream-index: "001" - required: - - reactions - - duration - title: Response - type: object - QueryRemindersRequest: - nullable: true - properties: - filter: - additionalProperties: {} - description: Filter to apply to the query - title: Filter + x-stream-docs-page-id: threads#quote-message + x-stream-index: "019" + reaction_counts: + additionalProperties: + format: int32 + type: integer + description: 'An object containing number of reactions of each type. Key: + reaction type (string), value: number of reactions (int)' + title: Reaction counts type: object - x-stream-index: "001" - limit: + x-stream-index: "011" + reaction_groups: + additionalProperties: + $ref: '#/components/schemas/ReactionGroupResponse' + type: object + x-stream-index: "014" + reaction_scores: + additionalProperties: + format: int32 + type: integer + description: 'An object containing scores of reactions of each type. Key: + reaction type (string), value: total score of reactions (int)' + title: Reaction scores + type: object + x-stream-index: "012" + reminder: + $ref: '#/components/schemas/ReminderResponseData' + x-stream-index: "042" + reply_count: + description: Number of replies to this message format: int32 - maximum: 100 - minimum: 0 + title: Reply count type: integer - x-stream-index: "005.001" - next: - type: string - x-stream-index: "005.002" - prev: - type: string - x-stream-index: "005.003" - sort: - description: Array of sort parameters + x-stream-index: "017" + restricted_visibility: + description: A list of user ids that have restricted visibility to the message, + if the list is not empty, the message is only visible to the users in + the list items: - $ref: '#/components/schemas/SortParamRequest' - maximum: 5 - title: Sort + type: string + title: Restricted visibility type: array - x-stream-index: "002" - type: object - QueryRemindersResponse: - nullable: true - properties: - duration: - description: Duration of the request in milliseconds - title: Duration - type: string - x-stream-index: "003.001" - next: - type: string - x-stream-index: "002.001" - prev: + x-stream-index: "040" + shadowed: + description: Whether the message was shadowed or not + title: Shadowed + type: boolean + x-stream-docs-page-id: moderation#shadow-ban + x-stream-index: "027" + shared_location: + $ref: '#/components/schemas/SharedLocationResponseData' + description: Contains shared location data + title: Shared Location + x-stream-index: "043" + show_in_channel: + description: Whether thread reply should be shown in the channel as well + title: Show in channel + type: boolean + x-stream-docs-page-id: threads + x-stream-index: "016" + silent: + description: Whether message is silent or not + title: Silent + type: boolean + x-stream-index: "031" + text: + description: Text of the message. Should be empty if `mml` is provided + title: Text type: string - x-stream-index: "002.002" - reminders: - description: MessageReminders data returned by the query + x-stream-index: "002" + thread_participants: + description: List of users who participate in thread items: - $ref: '#/components/schemas/ReminderResponseData' - title: RemindersResponseData + $ref: '#/components/schemas/UserResponse' + title: Thread participants type: array - x-stream-index: "001" - required: - - reminders - - duration - type: object - QueryReviewQueueRequest: - nullable: true - properties: - filter: - additionalProperties: {} - description: Filter conditions for review queue items - title: Filter - type: object - x-stream-index: "001" - limit: - format: int32 - maximum: 100 - minimum: 0 - type: integer - x-stream-index: "007.001" - lock_count: - description: Number of items to lock (1-25) - format: int32 - maximum: 25 - minimum: 1 - title: Lock Count - type: integer - x-stream-index: "005" - lock_duration: - description: Duration for which items should be locked - title: Lock Duration - type: integer - x-stream-index: "004" - lock_items: - description: Whether to lock items for review (true), unlock items (false), - or just fetch (nil) - title: Lock Items - type: boolean - x-stream-index: "003" - next: - type: string - x-stream-index: "007.002" - prev: + x-stream-docs-page-id: threads#quote-message + x-stream-index: "021" + type: + description: Contains type of the message + enum: + - regular + - ephemeral + - error + - reply + - system + - deleted + title: Message Type type: string - x-stream-index: "007.003" - sort: - description: Sorting parameters for the results + x-stream-docs-page-id: message_format#message-types + x-stream-index: "006" + updated_at: + description: Date/time of the last update + format: date-time + title: Updated at + type: number + x-stream-index: "024" + user: + $ref: '#/components/schemas/UserResponse' + description: Sender of the message. Required when using server-side API + title: User object + x-stream-index: "007" + required: + - id + - text + - html + - type + - user + - attachments + - latest_reactions + - own_reactions + - reaction_counts + - reaction_scores + - reply_count + - deleted_reply_count + - cid + - created_at + - updated_at + - custom + - shadowed + - mentioned_users + - silent + - pinned + - restricted_visibility + title: Message + type: object + x-stream-docs-page-id: send_message + MessageStatsResponse: + properties: + count_over_time: items: - $ref: '#/components/schemas/SortParamRequest' - title: Sort + $ref: '#/components/schemas/CountByMinuteResponse' type: array - x-stream-index: "002" - stats_only: - description: Whether to return only statistics - title: Stats Only - type: boolean - x-stream-index: "006" + x-stream-index: "001" type: object - QueryReviewQueueResponse: - nullable: true + MessageUndeletedEvent: properties: - action_config: - additionalProperties: - items: - $ref: '#/components/schemas/ModerationActionConfig' - type: array - description: Configuration for moderation actions - title: Action Config - type: object - x-stream-index: "002" - duration: + channel_id: + type: string + x-stream-index: "005.002" + channel_type: + type: string + x-stream-index: "005.003" + cid: type: string x-stream-index: "005.001" - items: - description: List of review queue items + created_at: + format: date-time + type: number + x-stream-index: "004.002" + message: + $ref: '#/components/schemas/Message' + x-stream-index: "001.001" + team: + type: string + x-stream-index: "002.001" + thread_participants: items: - $ref: '#/components/schemas/ReviewQueueItemResponse' - title: Items + $ref: '#/components/schemas/User' type: array - x-stream-index: "001" - next: + x-stream-index: "001.002" + type: + default: message.undeleted type: string x-stream-index: "004.001" - prev: - type: string - x-stream-index: "004.002" - stats: - additionalProperties: {} - description: Statistics about the review queue - title: Stats - type: object - x-stream-index: "003" + user: + $ref: '#/components/schemas/User' + x-stream-index: "003.001" required: - - items - - action_config - - stats - - duration + - type + - created_at + - cid + - channel_id + - channel_type + title: MessageUndeletedEvent type: object - QueryThreadsRequest: - nullable: true + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + MessageUpdate: properties: - filter: - additionalProperties: {} - description: Filter conditions to apply to threads - title: Filter - type: object - x-stream-index: "006" - limit: - format: int32 - maximum: 100 - minimum: 0 - type: integer - x-stream-index: "008.001" - member_limit: - format: int32 - maximum: 100 - minimum: 0 - type: integer - x-stream-index: "005" - next: - type: string - x-stream-index: "008.002" - participant_limit: - description: Limit the number of participants returned per each thread - format: int32 - maximum: 100 - minimum: 0 - title: Participant limit - type: integer - x-stream-index: "004" - prev: + change_set: + $ref: '#/components/schemas/MessageChangeSet' + x-stream-index: "002" + old_text: type: string - x-stream-index: "008.003" - reply_limit: - description: Limit the number of replies returned per each thread - format: int32 - maximum: 10 - minimum: 0 - title: Reply limit - type: integer - x-stream-index: "003" - sort: - description: Sort conditions to apply to threads - items: - $ref: '#/components/schemas/SortParamRequest' - maximum: 5 - title: Sort - type: array - x-stream-index: "007" - watch: - description: Start watching the channel this thread belongs to - title: Watch - type: boolean x-stream-index: "001" type: object - QueryThreadsResponse: - nullable: true + MessageUpdatedEvent: properties: - duration: - description: Duration of the request in milliseconds - title: Duration + channel_id: type: string - x-stream-index: "003.001" - next: + x-stream-index: "005.002" + channel_type: type: string - x-stream-index: "002.001" - prev: + x-stream-index: "005.003" + cid: type: string - x-stream-index: "002.002" - threads: - description: List of enriched thread states + x-stream-index: "005.001" + created_at: + format: date-time + type: number + x-stream-index: "004.002" + message: + $ref: '#/components/schemas/Message' + x-stream-index: "001.001" + team: + type: string + x-stream-index: "002.001" + thread_participants: items: - $ref: '#/components/schemas/ThreadStateResponse' - title: Threads - type: array - x-stream-index: "001" - required: - - threads - - duration - type: object - QueryUsersPayload: - properties: - filter_conditions: - additionalProperties: {} - type: object - x-stream-index: "001" - include_deactivated_users: - type: boolean - x-stream-index: "004" - limit: - format: int32 - maximum: 100 - minimum: 0 - type: integer - x-stream-index: "005.003" - offset: - format: int32 - maximum: 1000 - type: integer - x-stream-index: "005.004" - presence: - type: boolean - x-stream-index: "003" - sort: - items: - $ref: '#/components/schemas/SortParamRequest' - maximum: 5 + $ref: '#/components/schemas/User' type: array - x-stream-index: "002" + x-stream-index: "001.002" + type: + default: message.updated + type: string + x-stream-index: "004.001" + user: + $ref: '#/components/schemas/User' + x-stream-index: "003.001" required: - - filter_conditions + - type + - created_at + - cid + - channel_id + - channel_type + title: MessageUpdatedEvent type: object - QueryUsersResponse: - nullable: true + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + MessageWithChannelResponse: + description: Represents any chat message properties: - duration: - description: Duration of the request in milliseconds - title: Duration - type: string - x-stream-index: "002.001" - users: - description: Array of users as result of filters applied. + attachments: + description: Array of message attachments items: - $ref: '#/components/schemas/FullUserResponse' - title: Users + $ref: '#/components/schemas/Attachment' + title: Message attachments type: array - x-stream-index: "001" - required: - - users - - duration - type: object - RTMPBroadcastRequest: - description: RTMPBroadcastRequest is the payload for starting an RTMP broadcast. - properties: - layout: - $ref: '#/components/schemas/LayoutSettingsRequest' - description: If provided, will override the call's RTMP settings layout - title: Layout - x-stream-index: "005" - name: - description: Name identifier for RTMP broadcast, must be unique in call - maxLength: 255 - title: Name - type: string - x-stream-index: "001" - quality: - description: If provided, will override the call's RTMP settings quality - enum: - - 360p - - 480p - - 720p - - 1080p - - 1440p - - portrait-360x640 - - portrait-480x854 - - portrait-720x1280 - - portrait-1080x1920 - - portrait-1440x2560 - title: Quality - type: string - x-stream-index: "004" - stream_key: - description: If provided, will be appended at the end of stream_url - title: Stream Key - type: string - x-stream-index: "003" - stream_url: - description: URL for the RTMP server to send the call to - maxLength: 255 - title: Stream URL - type: string - x-stream-index: "002" - required: - - name - - stream_url - title: RTMPBroadcastRequest - type: object - RTMPEgressConfig: - properties: - composite_app_settings: - $ref: '#/components/schemas/CompositeAppSettings' - x-stream-index: "005" - quality: - $ref: '#/components/schemas/Quality' - x-stream-index: "004" - rtmp_location: - type: string - x-stream-index: "006" - type: object - RTMPIngress: - description: RTMP input settings - properties: - address: - title: Address - type: string - x-stream-index: "001" - required: - - address - title: RTMPIngress - type: object - RTMPLocation: - properties: - name: - type: string - x-stream-index: "001" - stream_key: - type: string - x-stream-index: "003" - stream_url: - type: string - x-stream-index: "002" - required: - - name - - stream_url - - stream_key - type: object - RTMPSettings: - properties: - enabled: - type: boolean - x-stream-index: "001" - layout: - $ref: '#/components/schemas/LayoutSettings' - x-stream-index: "003" - location: - $ref: '#/components/schemas/RTMPLocation' - x-stream-index: "004" - quality_name: - type: string + x-stream-docs-page-id: message_format#attachment-format + x-stream-index: "001.008" + channel: + $ref: '#/components/schemas/ChannelResponse' + description: Channel object + title: Channel x-stream-index: "002" - required: - - enabled - type: object - RTMPSettingsRequest: - properties: - enabled: - type: boolean - x-stream-index: "001" - quality: - description: Resolution to set for the RTMP stream - enum: - - 360p - - 480p - - 720p - - 1080p - - 1440p - - portrait-360x640 - - portrait-480x854 - - portrait-720x1280 - - portrait-1080x1920 - - portrait-1440x2560 - title: Quality + cid: + description: Channel unique identifier in : format + title: Channel CID type: string - x-stream-index: "002" - title: RTMPSettingsRequest - type: object - RTMPSettingsResponse: - description: RTMPSettingsResponse is the payload for RTMP settings - properties: - enabled: - title: Enabled - type: boolean - x-stream-index: "001" - quality: - title: Quality + x-stream-index: "001.022" + command: + description: Contains provided slash command + title: Command type: string - x-stream-index: "002" - required: - - enabled - - quality - - layout - title: RTMPSettingsResponse - type: object - Reaction: - nullable: true - properties: + x-stream-docs-page-id: custom_commands_webhook + x-stream-index: "001.004" created_at: + description: Date/time of creation format: date-time - readOnly: true + title: Created at type: number - x-stream-index: "008" + x-stream-index: "001.023" custom: additionalProperties: {} type: object - x-stream-index: "010" - message_id: - type: string - x-stream-index: "003" - score: + x-stream-index: "001.026" + deleted_at: + description: Date/time of deletion + format: date-time + title: Deleted at + type: number + x-stream-index: "001.025" + deleted_for_me: + type: boolean + x-stream-index: "001.044" + deleted_reply_count: format: int32 type: integer - x-stream-index: "007" - type: - maxLength: 30 + x-stream-index: "001.018" + draft: + $ref: '#/components/schemas/DraftResponse' + x-stream-index: "001.041" + html: + description: Contains HTML markup of the message. Can only be set when using + server-side API + title: HTML content type: string - x-stream-index: "006" - updated_at: + x-stream-index: "001.005" + i18n: + additionalProperties: + type: string + description: Object with translations. Key `language` contains the original + language key. Other keys contain translations + title: Internationalization info + type: object + x-stream-docs-page-id: translation + x-stream-index: "001.030" + id: + description: Message ID is unique string identifier of the message + title: ID + type: string + x-stream-index: "001.001" + image_labels: + additionalProperties: + items: + type: string + type: array + description: Contains image moderation information + title: Image moderation labels + type: object + x-stream-index: "001.028" + latest_reactions: + description: List of 10 latest reactions to this message + items: + $ref: '#/components/schemas/ReactionResponse' + title: Latest reactions + type: array + x-stream-index: "001.009" + mentioned_users: + description: List of mentioned users + items: + $ref: '#/components/schemas/UserResponse' + title: Mentioned Users + type: array + x-stream-index: "001.029" + message_text_updated_at: format: date-time - readOnly: true type: number - x-stream-index: "009" - user: - $ref: '#/components/schemas/User' - x-stream-index: "005" - user_id: - type: string - x-stream-index: "004" - required: - - message_id - - type - - score - - created_at - - updated_at - - custom - type: object - ReactionDeletedEvent: - properties: - channel_id: - type: string - x-stream-index: "003.002" - channel_type: + x-stream-index: "001.036" + mml: + description: Should be empty if `text` is provided. Can only be set when + using server-side API + title: Messaging Markup Language type: string - x-stream-index: "003.003" - cid: + x-stream-docs-page-id: mml_overview + x-stream-index: "001.003" + moderation: + $ref: '#/components/schemas/ModerationV2Response' + x-stream-index: "001.039" + own_reactions: + description: List of 10 latest reactions of authenticated user to this message + items: + $ref: '#/components/schemas/ReactionResponse' + title: Own reactions + type: array + x-stream-index: "001.010" + parent_id: + description: ID of parent message (thread) + title: Parent message ID type: string - x-stream-index: "003.001" - created_at: + x-stream-docs-page-id: threads + x-stream-index: "001.015" + pin_expires: + description: Date when pinned message expires format: date-time + title: Pin expiration date type: number - x-stream-index: "006.002" - message: - $ref: '#/components/schemas/Message' - x-stream-index: "001.001" - reaction: - $ref: '#/components/schemas/Reaction' - x-stream-index: "002" - team: + x-stream-docs-page-id: pinned_messages + x-stream-index: "001.035" + pinned: + description: Whether message is pinned or not + title: Pinned + type: boolean + x-stream-docs-page-id: pinned_messages + x-stream-index: "001.032" + pinned_at: + description: Date when message got pinned + format: date-time + title: Pinned at + type: number + x-stream-docs-page-id: pinned_messages + x-stream-index: "001.033" + pinned_by: + $ref: '#/components/schemas/UserResponse' + description: Contains user who pinned the message + title: Pinned by + x-stream-docs-page-id: pinned_messages + x-stream-index: "001.034" + poll: + $ref: '#/components/schemas/PollResponseData' + x-stream-index: "001.038" + poll_id: + description: Identifier of the poll to include in the message + title: Poll ID type: string - x-stream-index: "005.001" - thread_participants: + x-stream-index: "001.037" + quoted_message: + $ref: '#/components/schemas/MessageResponse' + description: Contains quoted message + title: Quoted message + x-stream-docs-page-id: threads#quote-message + x-stream-index: "001.020" + quoted_message_id: + title: ID of quoted message + type: string + x-stream-docs-page-id: threads#quote-message + x-stream-index: "001.019" + reaction_counts: + additionalProperties: + format: int32 + type: integer + description: 'An object containing number of reactions of each type. Key: + reaction type (string), value: number of reactions (int)' + title: Reaction counts + type: object + x-stream-index: "001.011" + reaction_groups: + additionalProperties: + $ref: '#/components/schemas/ReactionGroupResponse' + type: object + x-stream-index: "001.014" + reaction_scores: + additionalProperties: + format: int32 + type: integer + description: 'An object containing scores of reactions of each type. Key: + reaction type (string), value: total score of reactions (int)' + title: Reaction scores + type: object + x-stream-index: "001.012" + reminder: + $ref: '#/components/schemas/ReminderResponseData' + x-stream-index: "001.042" + reply_count: + description: Number of replies to this message + format: int32 + title: Reply count + type: integer + x-stream-index: "001.017" + restricted_visibility: + description: A list of user ids that have restricted visibility to the message, + if the list is not empty, the message is only visible to the users in + the list items: - $ref: '#/components/schemas/User' + type: string + title: Restricted visibility type: array + x-stream-index: "001.040" + shadowed: + description: Whether the message was shadowed or not + title: Shadowed + type: boolean + x-stream-docs-page-id: moderation#shadow-ban + x-stream-index: "001.027" + shared_location: + $ref: '#/components/schemas/SharedLocationResponseData' + description: Contains shared location data + title: Shared Location + x-stream-index: "001.043" + show_in_channel: + description: Whether thread reply should be shown in the channel as well + title: Show in channel + type: boolean + x-stream-docs-page-id: threads + x-stream-index: "001.016" + silent: + description: Whether message is silent or not + title: Silent + type: boolean + x-stream-index: "001.031" + text: + description: Text of the message. Should be empty if `mml` is provided + title: Text + type: string x-stream-index: "001.002" + thread_participants: + description: List of users who participate in thread + items: + $ref: '#/components/schemas/UserResponse' + title: Thread participants + type: array + x-stream-docs-page-id: threads#quote-message + x-stream-index: "001.021" type: - default: reaction.deleted + description: Contains type of the message + enum: + - regular + - ephemeral + - error + - reply + - system + - deleted + title: Message Type type: string - x-stream-index: "006.001" + x-stream-docs-page-id: message_format#message-types + x-stream-index: "001.006" + updated_at: + description: Date/time of the last update + format: date-time + title: Updated at + type: number + x-stream-index: "001.024" user: - $ref: '#/components/schemas/User' - x-stream-index: "004.001" + $ref: '#/components/schemas/UserResponse' + description: Sender of the message. Required when using server-side API + title: User object + x-stream-index: "001.007" required: - - cid - - channel_id - - channel_type + - id + - text + - html - type - - created_at - title: ReactionDeletedEvent + - user + - attachments + - latest_reactions + - own_reactions + - reaction_counts + - reaction_scores + - reply_count + - deleted_reply_count + - cid + - created_at + - updated_at + - custom + - shadowed + - mentioned_users + - silent + - pinned + - restricted_visibility + - channel + title: Message 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 - ReactionGroupResponse: - description: ReactionGroupResponse contains all information about a reaction - of the same type. + x-stream-docs-page-id: send_message + ModerationActionConfig: nullable: true properties: - count: - description: Count is the number of reactions of this type. - format: int32 - title: Count - type: integer - x-stream-index: "001" - first_reaction_at: - description: FirstReactionAt is the time of the first reaction of this type. - This is the same also if all reaction of this type are deleted, because - if someone will react again with the same type, will be preserved the - sorting. - format: date-time - title: FirstReactionAt - type: number - x-stream-index: "003" - last_reaction_at: - description: LastReactionAt is the time of the last reaction of this type. - format: date-time - title: LastReactionAt - type: number + action: + type: string + x-stream-index: "006" + custom: + additionalProperties: {} + type: object + x-stream-index: "009" + description: + type: string + x-stream-index: "008" + entity_type: + type: string x-stream-index: "004" - sum_scores: - description: 'SumScores is the sum of all scores of reactions of this type. - Medium allows you to clap articles more than once and shows the sum of - all claps from all users. For example, you can send `clap` x5 using `score: - 5`.' + icon: + type: string + x-stream-index: "007" + order: format: int32 - title: SumScores type: integer - x-stream-index: "002" + x-stream-index: "005" required: - - count - - sum_scores - - first_reaction_at - - last_reaction_at - title: ReactionGroupResponse + - entity_type + - order + - action + - icon + - description + - custom type: object - ReactionNewEvent: + ModerationCustomActionEvent: properties: - channel_id: - type: string - x-stream-index: "004.002" - channel_type: - type: string - x-stream-index: "004.003" - cid: - type: string - x-stream-index: "004.001" created_at: format: date-time type: number - x-stream-index: "006.002" + x-stream-index: "004.002" + item: + $ref: '#/components/schemas/ReviewQueueItem' + x-stream-index: "001" message: $ref: '#/components/schemas/Message' - x-stream-index: "001.001" - reaction: - $ref: '#/components/schemas/Reaction' x-stream-index: "002" - team: - type: string - x-stream-index: "005.001" - thread_participants: - items: - $ref: '#/components/schemas/User' - type: array - x-stream-index: "001.002" type: - default: reaction.new + default: moderation.custom_action type: string - x-stream-index: "006.001" + x-stream-index: "004.001" user: $ref: '#/components/schemas/User' x-stream-index: "003.001" required: - - cid - - channel_id - - channel_type - type - created_at - title: ReactionNewEvent + title: ModerationCustomActionEvent 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 - ReactionRequest: - description: Represents user reaction to a message + ModerationFlagResponse: + nullable: true properties: created_at: - description: Date/time of creation format: date-time - title: Created at type: number - x-stream-index: "003" + x-stream-index: "015" custom: additionalProperties: {} type: object - x-stream-index: "005" - score: - description: Reaction score. If not specified reaction has score of 1 - format: int32 - title: Score - type: integer - x-stream-index: "002" - type: - description: The type of reaction (e.g. 'like', 'laugh', 'wow') - maxLength: 30 - title: Type + x-stream-index: "010" + entity_creator_id: + type: string + x-stream-index: "007" + entity_id: type: string - x-stream-index: "001" - updated_at: - description: Date/time of the last update - format: date-time - title: Updated at - type: number - x-stream-index: "004" - required: - - type - title: Reaction - type: object - x-stream-docs-page-id: send_reaction - ReactionResponse: - properties: - created_at: - description: Date/time of creation - format: date-time - title: Created at - type: number x-stream-index: "006" - custom: - additionalProperties: {} - description: Custom data for this object - title: Custom data - type: object - x-stream-index: "008" - message_id: - description: Message ID - title: Message ID + entity_type: type: string - x-stream-index: "001" - score: - description: Score of the reaction - format: int32 - title: Score - type: integer x-stream-index: "005" + labels: + items: + type: string + type: array + x-stream-index: "011" + moderation_payload: + $ref: '#/components/schemas/ModerationPayload' + x-stream-index: "008" + reason: + type: string + x-stream-index: "009" + result: + items: + additionalProperties: {} + type: object + type: array + x-stream-index: "012" + review_queue_item: + $ref: '#/components/schemas/ReviewQueueItemResponse' + x-stream-index: "014" + review_queue_item_id: + type: string + x-stream-index: "013" type: - description: Type of reaction - title: Type type: string - x-stream-index: "004" + x-stream-index: "002" updated_at: - description: Date/time of the last update format: date-time - title: Updated at type: number - x-stream-index: "007" + x-stream-index: "016" user: $ref: '#/components/schemas/UserResponse' - description: User - title: UserResponse - x-stream-index: "003" + x-stream-index: "004" user_id: - description: User ID - title: User ID type: string - x-stream-index: "002" + x-stream-index: "003" required: - - message_id - - user_id - - user - type - - score + - user_id + - entity_type + - entity_id + - result - created_at - updated_at - - custom type: object - ReactionUpdatedEvent: + ModerationFlaggedEvent: properties: - channel_id: - type: string - x-stream-index: "004.002" - channel_type: - type: string - x-stream-index: "004.003" - cid: - type: string - x-stream-index: "004.001" created_at: format: date-time type: number - x-stream-index: "006.002" - message: - $ref: '#/components/schemas/Message' + x-stream-index: "004.002" + item: + type: string x-stream-index: "001" - reaction: - $ref: '#/components/schemas/Reaction' - x-stream-index: "002" - team: + object_id: type: string - x-stream-index: "005.001" + x-stream-index: "002" type: - default: reaction.updated + default: moderation.flagged type: string - x-stream-index: "006.001" + x-stream-index: "004.001" user: $ref: '#/components/schemas/User' x-stream-index: "003.001" required: - - message - - reaction - - cid - - channel_id - - channel_type - type - created_at - title: ReactionUpdatedEvent + title: ModerationFlaggedEvent 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 - ReadReceipts: - properties: - enabled: - type: boolean - x-stream-index: "001" - required: - - enabled - type: object - ReadReceiptsResponse: - properties: - enabled: - type: boolean - x-stream-index: "001" - required: - - enabled - type: object - ReadStateResponse: + ModerationMarkReviewedEvent: properties: - last_read: + created_at: format: date-time type: number + x-stream-index: "004.002" + item: + $ref: '#/components/schemas/ReviewQueueItem' + x-stream-index: "001" + message: + $ref: '#/components/schemas/Message' x-stream-index: "002" - last_read_message_id: + type: + default: moderation.mark_reviewed type: string - x-stream-index: "004" - unread_messages: - format: int32 - type: integer - x-stream-index: "003" + x-stream-index: "004.001" user: - $ref: '#/components/schemas/UserResponse' - x-stream-index: "001" + $ref: '#/components/schemas/User' + x-stream-index: "003.001" required: - - user - - last_read - - unread_messages + - type + - created_at + title: ModerationMarkReviewedEvent type: object - RecordSettings: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + ModerationPayload: properties: - audio_only: - type: boolean - x-stream-index: "001" - layout: - $ref: '#/components/schemas/LayoutSettings' + custom: + additionalProperties: {} + type: object x-stream-index: "004" - mode: - type: string + images: + items: + type: string + maximum: 30 + type: array x-stream-index: "002" - quality: - type: string + texts: + items: + type: string + type: array + x-stream-index: "001" + videos: + items: + type: string + type: array x-stream-index: "003" - required: - - mode type: object - RecordSettingsRequest: + ModerationResponse: properties: - audio_only: - type: boolean - x-stream-index: "001" - mode: - enum: - - available - - disabled - - auto-on - title: Mode + action: type: string + x-stream-index: "004" + explicit: + format: float + type: number x-stream-index: "002" - quality: - enum: - - 360p - - 480p - - 720p - - 1080p - - 1440p - - portrait-360x640 - - portrait-480x854 - - portrait-720x1280 - - portrait-1080x1920 - - portrait-1440x2560 - type: string + spam: + format: float + type: number x-stream-index: "003" + toxic: + format: float + type: number + x-stream-index: "001" required: - - mode - title: RecordSettingsRequest + - toxic + - explicit + - spam + - action + - automod_response type: object - RecordSettingsResponse: - description: RecordSettings is the payload for recording settings + ModerationV2Response: properties: - audio_only: - title: Audio Only - type: boolean - x-stream-index: "001" - mode: - title: Mode + action: type: string - x-stream-index: "002" - quality: - title: Quality + x-stream-index: "001" + blocklist_matched: type: string - x-stream-index: "003" - required: - - audio_only - - mode - - quality - - layout - title: RecordSettingsResponse - type: object - RecordingEgressConfig: - properties: - audio_only: - type: boolean - x-stream-index: "006" - composite_app_settings: - $ref: '#/components/schemas/CompositeAppSettings' x-stream-index: "005" - external_storage: - $ref: '#/components/schemas/ExternalStorage' - x-stream-index: "008" - quality: - $ref: '#/components/schemas/Quality' + image_harms: + items: + type: string + type: array x-stream-index: "004" - storage_name: + original_text: type: string + x-stream-index: "002" + platform_circumvented: + type: boolean x-stream-index: "007" - video_orientation_hint: - $ref: '#/components/schemas/VideoOrientation' - x-stream-index: "009" + semantic_filter_matched: + type: string + x-stream-index: "006" + text_harms: + items: + type: string + type: array + x-stream-index: "003" + required: + - action + - original_text type: object - RejectCallRequest: + MuteChannelRequest: nullable: true properties: - reason: - description: Reason for rejecting the call - title: Reason - type: string + channel_cids: + description: Channel CIDs to mute (if multiple channels) + items: + type: string + maximum: 25 + title: Channel CIDs + type: array + x-stream-index: "002" + expiration: + description: Duration of mute in milliseconds + title: Expiration + type: integer x-stream-index: "003" - title: RejectCallRequest type: object - RejectCallResponse: + MuteChannelResponse: nullable: true properties: + channel_mute: + $ref: '#/components/schemas/ChannelMute' + description: Object with channel mute (if one channel was muted) + title: Channel mute + x-stream-index: "001" + channel_mutes: + description: Object with mutes (if multiple channels were muted) + items: + $ref: '#/components/schemas/ChannelMute' + title: Channel mutes + type: array + x-stream-index: "002" duration: - description: Duration of the request in milliseconds - title: Duration type: string - x-stream-index: "001.001" + x-stream-index: "004.001" + own_user: + $ref: '#/components/schemas/OwnUser' + description: Authorized user object with fresh mutes information + title: Own user + x-stream-index: "003" required: - duration - title: RejectCallResponse type: object - ReminderCreatedEvent: - description: Emitted when a reminder is created. + MuteRequest: nullable: true properties: - cid: - description: The CID of the Channel for which the reminder was created - title: Channel CID + target_ids: + description: User IDs to mute (if multiple users) + items: + type: string + title: Target IDs + type: array + x-stream-index: "001" + timeout: + description: Duration of mute in minutes + minimum: 0 + title: Timeout + type: integer + x-stream-index: "002" + required: + - target_ids + title: MuteRequest + type: object + MuteResponse: + nullable: true + properties: + duration: type: string - x-stream-index: "001.004" - created_at: - description: Date/time of creation - format: date-time - title: Created at + x-stream-index: "004.001" + mutes: + description: Object with mutes (if multiple users were muted) + items: + $ref: '#/components/schemas/UserMute' + title: Mutes + type: array + x-stream-index: "001" + non_existing_users: + description: A list of users that can't be found. Common cause for this + is deleted users + items: + type: string + title: Non Existing Users + type: array + x-stream-index: "003" + own_user: + $ref: '#/components/schemas/OwnUser' + description: Authorized user object with fresh mutes information + title: Own User + x-stream-index: "002" + required: + - duration + title: MuteResponse + type: object + MuteUsersRequest: + nullable: true + properties: + audio: + title: Audio + type: boolean + x-stream-index: "005" + mute_all_users: + type: boolean + x-stream-index: "003" + screenshare: + title: Screenshare + type: boolean + x-stream-index: "007" + screenshare_audio: + title: ScreenshareAudio + type: boolean + x-stream-index: "008" + user_ids: + items: + type: string + title: UserIDs + type: array + x-stream-index: "004" + video: + title: Video + type: boolean + x-stream-index: "006" + title: MuteUsersRequest + type: object + MuteUsersResponse: + description: MuteUsersResponse is the response payload for the mute users endpoint. + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "001.001" + required: + - duration + title: MuteUsersResponse + type: object + NetworkMetricsReportResponse: + properties: + average_connection_time: + format: float type: number - x-stream-index: 001.001.003 - custom: - additionalProperties: {} - type: object - x-stream-index: 001.001.007 - message_id: - description: The ID of the message for which the reminder was created - title: Message ID + x-stream-index: "003" + average_jitter: + format: float + type: number + x-stream-index: "002" + average_latency: + format: float + type: number + x-stream-index: "001" + average_time_to_reconnect: + format: float + type: number + x-stream-index: "004" + type: object + NoiseCancellationSettings: + properties: + mode: + enum: + - available + - disabled + - auto-on type: string - x-stream-index: "001.002" - parent_id: - description: The ID of the parent message, if the reminder is for a thread - message - title: Parent ID + x-stream-index: "001" + required: + - mode + type: object + NotificationAddedToChannelEvent: + properties: + channel: + $ref: '#/components/schemas/ChannelResponse' + x-stream-index: "003.004" + channel_id: type: string - x-stream-index: "001.005" - received_at: + x-stream-index: "003.002" + channel_member_count: + format: int32 + type: integer + x-stream-index: "003.005" + channel_type: + type: string + x-stream-index: "003.003" + cid: + type: string + x-stream-index: "003.001" + created_at: format: date-time type: number - x-stream-index: 001.001.004 - reminder: - $ref: '#/components/schemas/ReminderResponseData' - description: The reminder object which was created - title: MessageReminder - x-stream-index: "001.006" + x-stream-index: "002.002" + member: + $ref: '#/components/schemas/ChannelMember' + x-stream-index: "001.001" type: - default: reminder.created - description: 'The type of event: "reminder.created" in this case' - title: Event Type - type: string - x-stream-index: 001.001.002 - user_id: - description: The ID of the user for whom the reminder was created - title: User ID + default: notification.added_to_channel type: string - x-stream-index: "001.003" + x-stream-index: "002.001" required: - type - created_at - - custom - - message_id - - user_id - cid - title: ReminderCreatedEvent + - channel_id + - channel_type + - channel_member_count + title: NotificationAddedToChannelEvent 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 - ReminderDeletedEvent: - description: Emitted when a reminder is deleted. - nullable: true + NotificationChannelDeletedEvent: properties: + channel: + $ref: '#/components/schemas/ChannelResponse' + x-stream-index: "003.004" + channel_id: + type: string + x-stream-index: "003.002" + channel_member_count: + format: int32 + type: integer + x-stream-index: "003.005" + channel_type: + type: string + x-stream-index: "003.003" cid: - description: The CID of the Channel for which the reminder was created - title: Channel CID type: string - x-stream-index: "001.004" + x-stream-index: "003.001" created_at: - description: Date/time of creation format: date-time - title: Created at type: number - x-stream-index: 001.001.003 - custom: - additionalProperties: {} - type: object - x-stream-index: 001.001.007 - message_id: - description: The ID of the message for which the reminder was created - title: Message ID - type: string - x-stream-index: "001.002" - parent_id: - description: The ID of the parent message, if the reminder is for a thread - message - title: Parent ID + x-stream-index: "002.002" + team: type: string - x-stream-index: "001.005" - received_at: - format: date-time - type: number - x-stream-index: 001.001.004 - reminder: - $ref: '#/components/schemas/ReminderResponseData' - description: The reminder object which was created - title: MessageReminder - x-stream-index: "001.006" + x-stream-index: "001.001" type: - default: reminder.deleted - description: 'The type of event: "reminder.deleted" in this case' - title: Event Type - type: string - x-stream-index: 001.001.002 - user_id: - description: The ID of the user for whom the reminder was created - title: User ID + default: notification.channel_deleted type: string - x-stream-index: "001.003" + x-stream-index: "002.001" required: - type - created_at - - custom - - message_id - - user_id - cid - title: ReminderDeletedEvent + - channel_id + - channel_type + - channel_member_count + title: NotificationChannelDeletedEvent 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 - ReminderNotificationEvent: - description: Emitted when a reminder becomes due, triggering a notification - for the user. - nullable: true + NotificationChannelMutesUpdatedEvent: properties: - cid: - description: The CID of the Channel for which the reminder was created - title: Channel CID - type: string - x-stream-index: "001.004" created_at: - description: Date/time of creation format: date-time - title: Created at type: number - x-stream-index: 001.001.003 - custom: - additionalProperties: {} - type: object - x-stream-index: 001.001.007 - message_id: - description: The ID of the message for which the reminder was created - title: Message ID - type: string - x-stream-index: "001.002" - parent_id: - type: string - x-stream-index: "001.005" - received_at: - format: date-time - type: number - x-stream-index: 001.001.004 - reminder: - $ref: '#/components/schemas/ReminderResponseData' - description: The reminder object which was created - title: MessageReminder - x-stream-index: "001.006" + x-stream-index: "002.002" + me: + $ref: '#/components/schemas/OwnUser' + x-stream-index: "001" type: - default: notification.reminder_due - description: 'The type of event: "notification.reminder_due" in this case' - title: Event Type - type: string - x-stream-index: 001.001.002 - user_id: - description: The ID of the user for whom the reminder was created - title: User ID + default: notification.channel_mutes_updated type: string - x-stream-index: "001.003" + x-stream-index: "002.001" required: + - me - type - created_at - - custom - - message_id - - user_id - - cid - title: ReminderNotificationEvent + title: NotificationChannelMutesUpdatedEvent 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 - ReminderResponseData: + NotificationChannelTruncatedEvent: properties: channel: $ref: '#/components/schemas/ChannelResponse' - x-stream-index: "003" - channel_cid: + x-stream-index: "002.004" + channel_id: type: string - x-stream-index: "002" - created_at: - format: date-time - type: number - x-stream-index: "008" - message: - $ref: '#/components/schemas/Message' - x-stream-index: "005" - message_id: + x-stream-index: "002.002" + channel_member_count: + format: int32 + type: integer + x-stream-index: "002.005" + channel_type: type: string - x-stream-index: "004" - remind_at: - format: date-time - type: number - x-stream-index: "001" - updated_at: + x-stream-index: "002.003" + cid: + type: string + x-stream-index: "002.001" + created_at: format: date-time type: number - x-stream-index: "009" - user: - $ref: '#/components/schemas/User' - x-stream-index: "007" - user_id: + x-stream-index: "001.002" + type: + default: notification.channel_truncated type: string - x-stream-index: "006" + x-stream-index: "001.001" required: - - channel_cid - - message_id - - user_id + - type - created_at - - updated_at + - cid + - channel_id + - channel_type + - channel_member_count + title: NotificationChannelTruncatedEvent type: object - ReminderUpdatedEvent: - description: Emitted when a reminder is updated. + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + NotificationConfig: + properties: + track_read: + type: boolean + x-stream-index: "002" + track_seen: + type: boolean + x-stream-index: "001" + type: object + NotificationFeedUpdatedEvent: + description: Emitted when notification feed is updated. nullable: true properties: - cid: - description: The CID of the Channel for which the reminder was created - title: Channel CID - type: string - x-stream-index: "001.004" + aggregated_activities: + description: Aggregated activities for notification feeds + items: + $ref: '#/components/schemas/AggregatedActivityResponse' + title: Aggregated Activities + type: array + x-stream-index: "001" created_at: description: Date/time of creation format: date-time title: Created at type: number - x-stream-index: 001.001.003 + x-stream-index: 003.001.003 custom: additionalProperties: {} type: object - x-stream-index: 001.001.007 - message_id: - description: The ID of the message for which the reminder was created - title: Message ID + x-stream-index: 003.001.007 + feed_visibility: type: string - x-stream-index: "001.002" - parent_id: - description: The ID of the parent message, if the reminder is for a thread - message - title: Parent ID + x-stream-index: "003.003" + fid: + description: The ID of the feed + title: Feed ID type: string - x-stream-index: "001.005" + x-stream-index: "003.002" + notification_status: + $ref: '#/components/schemas/NotificationStatusResponse' + description: Notification status including unread/unseen counts + title: Notification Status + x-stream-index: "002" received_at: format: date-time type: number - x-stream-index: 001.001.004 - reminder: - $ref: '#/components/schemas/ReminderResponseData' - description: The reminder object which was created - title: MessageReminder - x-stream-index: "001.006" + x-stream-index: 003.001.004 type: - default: reminder.updated - description: 'The type of event: "reminder.updated" in this case' + default: feeds.notification_feed.updated + description: 'The type of event: "feeds.notification_feed.updated" in this + case' title: Event Type type: string - x-stream-index: 001.001.002 - user_id: - description: The ID of the user for whom the reminder was created - title: User ID - type: string - x-stream-index: "001.003" + x-stream-index: 003.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who triggered the notification + title: User + x-stream-index: "004.001" required: - type - created_at - custom - - message_id - - user_id - - cid - title: ReminderUpdatedEvent + - fid + title: NotificationFeedUpdatedEvent 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 - ReportByHistogramBucket: + NotificationInviteAcceptedEvent: properties: - category: + channel: + $ref: '#/components/schemas/ChannelResponse' + x-stream-index: "002.004" + channel_id: type: string - x-stream-index: "001" - count: + x-stream-index: "002.002" + channel_member_count: format: int32 type: integer - x-stream-index: "005" - lower_bound: - $ref: '#/components/schemas/Bound' - x-stream-index: "002" - sum: - format: float + x-stream-index: "002.005" + channel_type: + type: string + x-stream-index: "002.003" + cid: + type: string + x-stream-index: "002.001" + created_at: + format: date-time type: number - x-stream-index: "004" - upper_bound: - $ref: '#/components/schemas/Bound' - x-stream-index: "003" - required: - - category - - sum - - count - type: object - ReportResponse: - properties: - call: - $ref: '#/components/schemas/CallReportResponse' - x-stream-index: "003" - participants: - $ref: '#/components/schemas/ParticipantReportResponse' - x-stream-index: "001" - user_ratings: - $ref: '#/components/schemas/UserRatingReportResponse' - x-stream-index: "002" - required: - - participants - - user_ratings - - call - type: object - RequestPermissionRequest: - nullable: true - properties: - permissions: - items: - type: string - title: Permissions - type: array - x-stream-index: "003" - required: - - permissions - title: RequestPermissionRequest - type: object - RequestPermissionResponse: - nullable: true - properties: - duration: - description: Duration of the request in milliseconds - title: Duration + x-stream-index: "001.002" + member: + $ref: '#/components/schemas/ChannelMember' + x-stream-index: "004.001" + type: + default: notification.invite_accepted type: string x-stream-index: "001.001" + user: + $ref: '#/components/schemas/User' + x-stream-index: "003.001" required: - - duration - title: RequestPermissionResponse + - type + - created_at + - cid + - channel_id + - channel_type + - channel_member_count + title: NotificationInviteAcceptedEvent type: object - Response: - description: Basic response information - nullable: true + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + NotificationInviteRejectedEvent: properties: - duration: - description: Duration of the request in milliseconds - title: Duration + channel: + $ref: '#/components/schemas/ChannelResponse' + x-stream-index: "002.004" + channel_id: type: string - x-stream-index: "001" - required: - - duration - title: Response - type: object - RestoreActionRequest: - type: object - ReviewQueueItem: - properties: - actions: - items: - $ref: '#/components/schemas/ActionLog' - type: array - x-stream-index: "035" - activity: - $ref: '#/components/schemas/EnrichedActivity' - x-stream-index: "028" - ai_text_severity: - type: string - x-stream-index: "021" - archived_at: - $ref: '#/components/schemas/NullTime' - x-stream-index: "043" - assigned_to: - $ref: '#/components/schemas/User' - x-stream-index: "032" - bans: - items: - $ref: '#/components/schemas/Ban' - type: array - x-stream-index: "033" - bounce_count: + x-stream-index: "002.002" + channel_member_count: format: int32 type: integer - x-stream-index: "025" - call: - $ref: '#/components/schemas/Call' - x-stream-index: "031" - completed_at: - $ref: '#/components/schemas/NullTime' - x-stream-index: "018" - config_key: + x-stream-index: "002.005" + channel_type: type: string - x-stream-index: "009" - content_changed: - type: boolean - x-stream-index: "036" + x-stream-index: "002.003" + cid: + type: string + x-stream-index: "002.001" created_at: format: date-time type: number - x-stream-index: "004" - entity_creator: - $ref: '#/components/schemas/EntityCreator' - x-stream-index: "030" - entity_id: + x-stream-index: "001.002" + member: + $ref: '#/components/schemas/ChannelMember' + x-stream-index: "004.001" + type: + default: notification.invite_rejected type: string - x-stream-index: "007" - entity_type: + x-stream-index: "001.001" + user: + $ref: '#/components/schemas/User' + x-stream-index: "003.001" + required: + - type + - created_at + - cid + - channel_id + - channel_type + - channel_member_count + title: NotificationInviteRejectedEvent + 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 + NotificationInvitedEvent: + properties: + channel: + $ref: '#/components/schemas/ChannelResponse' + x-stream-index: "002.004" + channel_id: type: string - x-stream-index: "006" - feeds_v2_activity: - $ref: '#/components/schemas/EnrichedActivity' - x-stream-index: "041" - feeds_v2_reaction: - $ref: '#/components/schemas/Reaction' - x-stream-index: "042" - flag_labels: - items: - type: string - type: array - x-stream-index: "045" - flag_types: - items: - type: string - type: array - x-stream-index: "044" - flags: - items: - $ref: '#/components/schemas/Flag' - type: array - x-stream-index: "034" - flags_count: + x-stream-index: "002.002" + channel_member_count: format: int32 type: integer - x-stream-index: "026" - has_image: - type: boolean - x-stream-index: "012" - has_text: - type: boolean - x-stream-index: "014" - has_video: - type: boolean - x-stream-index: "013" - id: + x-stream-index: "002.005" + channel_type: type: string - x-stream-index: "003" - languages: - items: - type: string - type: array - x-stream-index: "019" - message: - $ref: '#/components/schemas/Message' - x-stream-index: "027" - moderation_payload: - $ref: '#/components/schemas/ModerationPayload' - x-stream-index: "010" - moderation_payload_hash: + x-stream-index: "002.003" + cid: type: string - x-stream-index: "011" - reaction: - $ref: '#/components/schemas/Reaction' - x-stream-index: "029" - recommended_action: + x-stream-index: "002.001" + created_at: + format: date-time + type: number + x-stream-index: "001.002" + member: + $ref: '#/components/schemas/ChannelMember' + x-stream-index: "004.001" + type: + default: notification.invited type: string - x-stream-index: "017" - reporter_ids: - items: - type: string - type: array - x-stream-index: "046" - reviewed_at: - $ref: '#/components/schemas/NullTime' - x-stream-index: "022" - reviewed_by: + x-stream-index: "001.001" + user: + $ref: '#/components/schemas/User' + x-stream-index: "003.001" + required: + - type + - created_at + - cid + - channel_id + - channel_type + - channel_member_count + title: NotificationInvitedEvent + 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 + NotificationMarkReadEvent: + properties: + channel: + $ref: '#/components/schemas/ChannelResponse' + x-stream-index: "003.004" + channel_id: type: string - x-stream-index: "023" - severity: + x-stream-index: "003.002" + channel_member_count: format: int32 type: integer - x-stream-index: "020" - status: + x-stream-index: "003.005" + channel_type: type: string - x-stream-index: "016" - teams: - items: - type: string - type: array - x-stream-index: "015" - updated_at: + x-stream-index: "003.003" + cid: + type: string + x-stream-index: "003.001" + created_at: format: date-time type: number + x-stream-index: "001.002" + team: + type: string + x-stream-index: "002.001" + total_unread_count: + format: int32 + type: integer + x-stream-index: "006" + type: + default: notification.mark_read + type: string + x-stream-index: "001.001" + unread_channels: + format: int32 + type: integer + x-stream-index: "007" + unread_count: + format: int32 + type: integer x-stream-index: "005" + unread_threads: + format: int32 + type: integer + x-stream-index: "008" + user: + $ref: '#/components/schemas/User' + x-stream-index: "004.001" required: - - id + - type - created_at - - updated_at - - entity_type - - entity_id - - config_key - - moderation_payload_hash - - has_image - - has_video - - has_text - - teams - - status - - recommended_action - - completed_at - - languages - - severity - - ai_text_severity - - reviewed_at - - reviewed_by - - bounce_count - - flags_count - - bans - - flags - - actions - - content_changed - - archived_at - - flag_types - - flag_labels - - reporter_ids - type: object - ReviewQueueItemResponse: - nullable: true - properties: - actions: - description: Moderation actions taken - items: - $ref: '#/components/schemas/ActionLogResponse' - title: Actions - type: array - x-stream-index: "024" - activity: - $ref: '#/components/schemas/EnrichedActivity' - x-stream-index: "016" - ai_text_severity: - description: AI-determined text severity - title: AI Text Severity + - cid + - channel_id + - channel_type + - channel_member_count + - unread_count + - total_unread_count + - unread_channels + - unread_threads + title: NotificationMarkReadEvent + 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 + NotificationMarkUnreadEvent: + properties: + channel: + $ref: '#/components/schemas/ChannelResponse' + x-stream-index: "003.004" + channel_id: type: string - x-stream-index: "014" - assigned_to: - $ref: '#/components/schemas/UserResponse' - description: Moderator assigned to review this item - title: Assigned To - x-stream-index: "021" - bans: - description: Associated ban records - items: - $ref: '#/components/schemas/Ban' - title: Bans - type: array - x-stream-index: "022" - call: - $ref: '#/components/schemas/CallResponse' - x-stream-index: "018" - completed_at: - description: When the review was completed - format: date-time - title: Completed At - type: number - x-stream-index: "009" - config_key: + x-stream-index: "003.002" + channel_member_count: + format: int32 + type: integer + x-stream-index: "003.005" + channel_type: type: string - x-stream-index: "028" + x-stream-index: "003.003" + cid: + type: string + x-stream-index: "003.001" created_at: - description: When the item was created format: date-time - title: Created At type: number - x-stream-index: "002" - entity_creator: - $ref: '#/components/schemas/EntityCreatorResponse' - description: Details about who created the entity - title: Entity Creator - x-stream-index: "019" - entity_creator_id: - description: ID of who created the entity - title: Entity Creator ID - type: string - x-stream-index: "020" - entity_id: - description: ID of the entity being reviewed - title: Entity ID + x-stream-index: "001.002" + first_unread_message_id: type: string x-stream-index: "005" - entity_type: - description: Type of entity being reviewed - title: Entity Type - type: string - x-stream-index: "004" - feeds_v2_activity: - $ref: '#/components/schemas/EnrichedActivity' - description: Associated feed activity - title: Feeds V2 Activity - x-stream-index: "025" - feeds_v2_reaction: - $ref: '#/components/schemas/Reaction' - description: Associated feed reaction - title: Feeds V2 Reaction - x-stream-index: "026" - flags: - description: Associated flag records - items: - $ref: '#/components/schemas/FlagResponse' - title: Flags - type: array - x-stream-index: "023" - flags_count: - format: int32 - type: integer - x-stream-index: "029" - id: - description: Unique identifier of the review queue item - title: ID + last_read_at: + format: date-time + type: number + x-stream-index: "006" + last_read_message_id: type: string - x-stream-index: "001" - languages: - description: Detected languages in the content - items: - type: string - title: Languages - type: array x-stream-index: "012" - message: - $ref: '#/components/schemas/MessageResponse' - description: Associated message details - title: Message - x-stream-index: "015" - moderation_payload: - $ref: '#/components/schemas/ModerationPayload' - description: Content being moderated - title: Moderation Payload - x-stream-index: "006" - reaction: - $ref: '#/components/schemas/Reaction' - x-stream-index: "017" - recommended_action: - description: Suggested moderation action - title: Recommended Action + team: type: string - x-stream-index: "008" - reviewed_at: - description: When the item was reviewed - format: date-time - title: Reviewed At - type: number - x-stream-index: "010" - reviewed_by: - description: ID of the moderator who reviewed the item - title: Reviewed By + x-stream-index: "002.001" + thread_id: type: string - x-stream-index: "011" - severity: - description: Severity level of the content - format: int32 - title: Severity - type: integer x-stream-index: "013" - status: - description: Current status of the review - title: Status - type: string - x-stream-index: "007" - teams: - description: Teams associated with this item - items: - type: string - title: Teams - type: array - x-stream-index: "027" - updated_at: - description: When the item was last updated - format: date-time - title: Updated At - type: number - x-stream-index: "003" - required: - - id - - created_at - - updated_at - - entity_type - - entity_id - - status - - recommended_action - - reviewed_by - - languages - - severity - - ai_text_severity - - bans - - flags - - actions - - flags_count - type: object - RingSettings: - properties: - auto_cancel_timeout_ms: - format: int32 - type: integer - x-stream-index: "002" - incoming_call_timeout_ms: + total_unread_count: format: int32 type: integer - x-stream-index: "001" - missed_call_timeout_ms: + x-stream-index: "009" + type: + default: notification.mark_unread + type: string + x-stream-index: "001.001" + unread_channels: format: int32 type: integer - x-stream-index: "003" - required: - - incoming_call_timeout_ms - - auto_cancel_timeout_ms - - missed_call_timeout_ms - type: object - RingSettingsRequest: - properties: - auto_cancel_timeout_ms: - description: When none of the callees accept a ring call in this time a - rejection will be sent by the caller with reason 'timeout' by the SDKs + x-stream-index: "010" + unread_count: format: int32 - maximum: 180000 - minimum: 5000 - title: AutoCancelTimeoutMs type: integer - x-stream-index: "002" - incoming_call_timeout_ms: - description: When a callee is online but doesn't answer a ring call in this - time a rejection will be sent with reason 'timeout' by the SDKs + x-stream-index: "008" + unread_messages: format: int32 - maximum: 180000 - minimum: 5000 - title: IncomingCallTimeoutMs type: integer - x-stream-index: "001" - missed_call_timeout_ms: - description: When a callee doesn't accept or reject a ring call in this - time a missed call event will be sent + x-stream-index: "007" + unread_threads: format: int32 - maximum: 180000 - minimum: 5000 - title: MissedCallTimeoutMs type: integer - x-stream-index: "003" + x-stream-index: "011" + user: + $ref: '#/components/schemas/User' + x-stream-index: "004.001" required: - - incoming_call_timeout_ms - - auto_cancel_timeout_ms - title: RingSettingsRequest - type: object - RingSettingsResponse: - properties: - auto_cancel_timeout_ms: - format: int32 - type: integer - x-stream-index: "002" - incoming_call_timeout_ms: - format: int32 - type: integer - x-stream-index: "001" - missed_call_timeout_ms: - format: int32 - type: integer - x-stream-index: "003" - required: - - incoming_call_timeout_ms - - auto_cancel_timeout_ms - - missed_call_timeout_ms + - type + - created_at + - cid + - channel_id + - channel_type + - channel_member_count + - first_unread_message_id + - last_read_at + - unread_messages + - unread_count + - total_unread_count + - unread_channels + - unread_threads + title: NotificationMarkUnreadEvent type: object - RuleBuilderAction: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + NotificationMutesUpdatedEvent: properties: - ban_options: - $ref: '#/components/schemas/BanOptions' - x-stream-index: "002" - flag_content_options: - $ref: '#/components/schemas/FlagContentOptions' - x-stream-index: "004" - flag_user_options: - $ref: '#/components/schemas/FlagUserOptions' - x-stream-index: "003" - remove_content_options: - $ref: '#/components/schemas/BlockContentOptions' - x-stream-index: "005" + created_at: + format: date-time + type: number + x-stream-index: "002.002" + me: + $ref: '#/components/schemas/OwnUser' + x-stream-index: "001" type: + default: notification.mutes_updated type: string - x-stream-index: "001" + x-stream-index: "002.001" required: + - me - type + - created_at + title: NotificationMutesUpdatedEvent type: object - RuleBuilderCondition: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + NotificationNewMessageEvent: properties: - confidence: - format: float + channel: + $ref: '#/components/schemas/ChannelResponse' + x-stream-index: "004.004" + channel_id: + type: string + x-stream-index: "004.002" + channel_member_count: + format: int32 + type: integer + x-stream-index: "004.005" + channel_type: + type: string + x-stream-index: "004.003" + cid: + type: string + x-stream-index: "004.001" + created_at: + format: date-time type: number - x-stream-index: "002" - content_count_rule_params: - $ref: '#/components/schemas/ContentCountRuleParameters' - x-stream-index: "007" - image_content_params: - $ref: '#/components/schemas/ImageContentParameters' - x-stream-index: "009" - image_rule_params: - $ref: '#/components/schemas/ImageRuleParameters' - x-stream-index: "004" - text_content_params: - $ref: '#/components/schemas/TextContentParameters' - x-stream-index: "008" - text_rule_params: - $ref: '#/components/schemas/TextRuleParameters' - x-stream-index: "003" + x-stream-index: "003.002" + message: + $ref: '#/components/schemas/Message' + x-stream-index: "001" + team: + type: string + x-stream-index: "002.001" type: + default: notification.message_new type: string - x-stream-index: "001" - user_created_within_params: - $ref: '#/components/schemas/UserCreatedWithinParameters' - x-stream-index: "011" - user_rule_params: - $ref: '#/components/schemas/UserRuleParameters' - x-stream-index: "006" - video_content_params: - $ref: '#/components/schemas/VideoContentParameters' - x-stream-index: "010" - video_rule_params: - $ref: '#/components/schemas/VideoRuleParameters' - x-stream-index: "005" + x-stream-index: "003.001" required: + - message - type + - created_at + - cid + - channel_id + - channel_type + - channel_member_count + title: NotificationNewMessageEvent type: object - RuleBuilderConditionGroup: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + NotificationRemovedFromChannelEvent: properties: - conditions: - items: - $ref: '#/components/schemas/RuleBuilderCondition' - type: array - x-stream-index: "002" - logic: + channel: + $ref: '#/components/schemas/ChannelResponse' + x-stream-index: "002.004" + channel_id: type: string - x-stream-index: "001" + x-stream-index: "002.002" + channel_member_count: + format: int32 + type: integer + x-stream-index: "002.005" + channel_type: + type: string + x-stream-index: "002.003" + cid: + type: string + x-stream-index: "002.001" + created_at: + format: date-time + type: number + x-stream-index: "001.002" + member: + $ref: '#/components/schemas/ChannelMember' + x-stream-index: "004.001" + type: + default: notification.removed_from_channel + type: string + x-stream-index: "001.001" + user: + $ref: '#/components/schemas/User' + x-stream-index: "003.001" required: - - logic - - conditions + - type + - created_at + - cid + - channel_id + - channel_type + - channel_member_count + title: NotificationRemovedFromChannelEvent type: object - RuleBuilderConfig: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + NotificationSettings: properties: - async: + call_live_started: + $ref: '#/components/schemas/EventNotificationSettings' + x-stream-index: "002" + call_missed: + $ref: '#/components/schemas/EventNotificationSettings' + x-stream-index: "006" + call_notification: + $ref: '#/components/schemas/EventNotificationSettings' + x-stream-index: "004" + call_ring: + $ref: '#/components/schemas/EventNotificationSettings' + x-stream-index: "005" + enabled: type: boolean x-stream-index: "001" - rules: - items: - $ref: '#/components/schemas/RuleBuilderRule' - type: array - x-stream-index: "002" + session_started: + $ref: '#/components/schemas/EventNotificationSettings' + x-stream-index: "003" required: - - rules + - enabled + - call_live_started + - session_started + - call_notification + - call_ring + - call_missed type: object - RuleBuilderRule: + NotificationStatusResponse: properties: - action: - $ref: '#/components/schemas/RuleBuilderAction' - x-stream-index: "007" - conditions: + last_read_at: + format: date-time + type: number + x-stream-index: "006" + last_seen_at: + description: When notifications were last seen + format: date-time + title: Last Seen At + type: number + x-stream-index: "005" + read_activities: + description: IDs of activities that have been read items: - $ref: '#/components/schemas/RuleBuilderCondition' + type: string + title: Read Activities type: array - x-stream-index: "004" - cooldown_period: - type: string - x-stream-index: "009" - enabled: - type: boolean - x-stream-index: "008" - groups: + x-stream-index: "003" + seen_activities: items: - $ref: '#/components/schemas/RuleBuilderConditionGroup' + type: string type: array - x-stream-index: "006" - id: - type: string + x-stream-index: "004" + unread: + description: Number of unread notifications + format: int32 + title: Unread + type: integer x-stream-index: "001" - logic: - type: string - x-stream-index: "005" - name: - type: string + unseen: + description: Number of unseen notifications + format: int32 + title: Unseen + type: integer x-stream-index: "002" - rule_type: - type: string - x-stream-index: "003" required: - - id - - name - - rule_type - - action - - enabled + - unread + - unseen + title: Notification Status type: object - SDKUsageReport: - properties: - per_sdk_usage: - additionalProperties: - $ref: '#/components/schemas/PerSDKUsageReport' - type: object - x-stream-index: "001" - required: - - per_sdk_usage + NullTime: type: object - SDKUsageReportResponse: + OCRRule: properties: - daily: - items: - $ref: '#/components/schemas/DailyAggregateSDKUsageReportResponse' - type: array + action: + enum: + - flag + - shadow + - remove + - bounce + - bounce_flag + - bounce_remove + type: string + x-stream-index: "002" + label: + type: string x-stream-index: "001" required: - - daily + - label + - action type: object - SFUIDLastSeen: + OnlyUserID: properties: id: type: string - x-stream-index: "001.001" - last_seen: - format: date-time - type: number - x-stream-index: "002" - process_start_time: - format: int64 - type: integer - x-stream-index: "001.002" + x-stream-index: "001" required: - id - - process_start_time - - last_seen type: object - SFUResponse: + OwnCapability: + description: All possibility of string to use + enum: + - block-users + - change-max-duration + - create-call + - create-reaction + - enable-noise-cancellation + - end-call + - join-backstage + - join-call + - join-ended-call + - kick-user + - mute-users + - pin-for-everyone + - read-call + - remove-call-member + - screenshare + - send-audio + - send-video + - start-broadcast-call + - start-closed-captions-call + - start-frame-record-call + - start-record-call + - start-transcription-call + - stop-broadcast-call + - stop-closed-captions-call + - stop-frame-record-call + - stop-record-call + - stop-transcription-call + - update-call + - update-call-member + - update-call-permissions + - update-call-settings + title: OwnCapability + type: string + OwnUser: properties: - edge_name: - type: string - x-stream-index: "001" - url: - type: string - x-stream-index: "002" - ws_endpoint: + avg_response_time: + format: int32 + type: integer + x-stream-index: "046" + banned: + type: boolean + x-stream-index: "016" + blocked_user_ids: + items: + type: string + type: array + x-stream-index: "045" + channel_mutes: + items: + $ref: '#/components/schemas/ChannelMute' + type: array + x-stream-index: "029" + created_at: + format: date-time + type: number + x-stream-index: "008" + custom: + additionalProperties: {} + type: object + x-stream-index: "006" + deactivated_at: + format: date-time + type: number + x-stream-index: "014" + deleted_at: + format: date-time + type: number + x-stream-index: "013" + devices: + items: + $ref: '#/components/schemas/Device' + type: array + x-stream-index: "027" + id: type: string x-stream-index: "003" - required: - - edge_name - - url - - ws_endpoint - type: object - STTEgressConfig: - properties: - closed_captions_enabled: + invisible: type: boolean - x-stream-index: "005" - external_storage: - $ref: '#/components/schemas/ExternalStorage' - x-stream-index: "011" + x-stream-index: "023" language: type: string - x-stream-index: "008" - storage_name: - type: string - x-stream-index: "010" - translation_languages: + x-stream-index: "035" + last_active: + format: date-time + type: number + x-stream-index: "011" + last_engaged_at: + format: date-time + type: number + x-stream-index: "012" + latest_hidden_channels: items: type: string type: array - x-stream-index: "009" - translations_enabled: - type: boolean - x-stream-index: "006" - upload_transcriptions: + x-stream-index: "037" + mutes: + items: + $ref: '#/components/schemas/UserMute' + type: array + x-stream-index: "028" + online: type: boolean - x-stream-index: "004" - whisper_server_base_url: + x-stream-index: "022" + privacy_settings: + $ref: '#/components/schemas/PrivacySettings' + x-stream-index: "026" + push_preferences: + $ref: '#/components/schemas/PushPreferences' + x-stream-index: "025" + role: type: string - x-stream-index: "007" - type: object - ScreensharingSettings: - properties: - access_request_enabled: - type: boolean - x-stream-index: "002" - enabled: - type: boolean - x-stream-index: "001" - target_resolution: - $ref: '#/components/schemas/TargetResolution' - x-stream-index: "003" - required: - - enabled - - access_request_enabled - type: object - ScreensharingSettingsRequest: - properties: - access_request_enabled: - type: boolean - x-stream-index: "002" - enabled: - type: boolean - x-stream-index: "001" - target_resolution: - $ref: '#/components/schemas/TargetResolution' - x-stream-index: "003" - type: object - ScreensharingSettingsResponse: - properties: - access_request_enabled: - type: boolean - x-stream-index: "002" - enabled: - type: boolean - x-stream-index: "001" - target_resolution: - $ref: '#/components/schemas/TargetResolution' - x-stream-index: "003" - required: - - enabled - - access_request_enabled - type: object - SearchPayload: - properties: - filter_conditions: - additionalProperties: {} - description: Channel filter conditions - maximum: 100 - minimum: 1 - title: Channel filter + x-stream-index: "004" + teams: + items: + type: string + type: array + x-stream-index: "036" + teams_role: + additionalProperties: + type: string type: object - x-stream-docs-page-id: query_channels - x-stream-index: "002" - limit: - description: Number of messages to return + x-stream-index: "005" + total_unread_count: format: int32 - title: Limit type: integer - x-stream-index: "005" - message_filter_conditions: - additionalProperties: {} - description: Message filter conditions - title: Message filter + x-stream-index: "031" + total_unread_count_by_team: + additionalProperties: + format: int32 + type: integer type: object - x-stream-index: "003" - message_options: - $ref: '#/components/schemas/MessageOptions' - x-stream-index: "004" - next: - description: Pagination parameter. Cannot be used with non-zero offset. - title: Next - type: string - x-stream-index: "008" - offset: - description: Pagination offset. Cannot be used with sort or next. + x-stream-index: "032" + unread_channels: format: int32 - title: Offset type: integer - x-stream-index: "006" - query: - description: Search phrase - title: Query - type: string - x-stream-index: "001" - sort: - description: Sort parameters. Cannot be used with non-zero offset - items: - $ref: '#/components/schemas/SortParamRequest' - title: Sort - type: array - x-stream-index: "007" + x-stream-index: "033" + unread_count: + format: int32 + type: integer + x-stream-index: "030" + unread_threads: + format: int32 + type: integer + x-stream-index: "034" + updated_at: + format: date-time + type: number + x-stream-index: "009" required: - - filter_conditions + - id + - role + - custom + - created_at + - updated_at + - banned + - online + - devices + - mutes + - channel_mutes + - unread_count + - total_unread_count + - total_unread_count_by_team + - unread_channels + - unread_threads + - language type: object - SearchResponse: - nullable: true + OwnUserResponse: properties: - duration: - description: Duration of the request in milliseconds - title: Duration - type: string - x-stream-index: "005.001" - next: - description: Value to pass to the next search query in order to paginate - title: Next - type: string - x-stream-index: "003" - previous: - description: Value that points to the previous page. Pass as the next value - in a search query to paginate backwards - title: Previous - type: string - x-stream-index: "004" - results: - description: Search results + avg_response_time: + format: int32 + type: integer + x-stream-index: "001.018" + banned: + type: boolean + x-stream-index: "001.012" + blocked_user_ids: items: - $ref: '#/components/schemas/SearchResult' - title: Results + type: string type: array - x-stream-index: "001" - results_warning: - $ref: '#/components/schemas/SearchWarning' - description: Warning about the search results - title: Results Warning - x-stream-index: "002" - required: - - results - - duration - type: object - SearchResult: - properties: - message: - $ref: '#/components/schemas/SearchResultMessage' - description: Found message - title: Message - x-stream-index: "001" - type: object - SearchResultMessage: - properties: - attachments: + x-stream-index: "015" + channel_mutes: items: - $ref: '#/components/schemas/Attachment' + $ref: '#/components/schemas/ChannelMute' type: array - x-stream-index: "001.008" - channel: - $ref: '#/components/schemas/ChannelResponse' - description: Channel object - title: Channel - x-stream-index: "002" - cid: - type: string - x-stream-index: "001.022" - command: - type: string - x-stream-index: "001.004" + x-stream-index: "007" created_at: format: date-time type: number - x-stream-index: "001.023" + x-stream-index: "001.009" custom: additionalProperties: {} type: object - x-stream-index: "001.026" + x-stream-index: "001.004" + deactivated_at: + format: date-time + type: number + x-stream-index: "001.016" deleted_at: format: date-time type: number - x-stream-index: "001.025" - deleted_reply_count: - format: int32 - type: integer - x-stream-index: "001.018" - draft: - $ref: '#/components/schemas/DraftResponse' - x-stream-index: "001.041" - html: - type: string - x-stream-index: "001.005" - i18n: - additionalProperties: - type: string - type: object - x-stream-index: "001.030" + x-stream-index: "001.011" + devices: + items: + $ref: '#/components/schemas/DeviceResponse' + title: Devices + type: array + x-stream-index: "004" id: type: string x-stream-index: "001.001" - image_labels: - additionalProperties: - items: - type: string - type: array - type: object - x-stream-index: "001.028" - latest_reactions: + image: + type: string + x-stream-index: "001.003" + invisible: + type: boolean + x-stream-index: "005" + language: + type: string + x-stream-index: "001.005" + last_active: + format: date-time + type: number + x-stream-index: "001.014" + latest_hidden_channels: items: - $ref: '#/components/schemas/ReactionResponse' + type: string type: array - x-stream-index: "001.009" - mentioned_users: + x-stream-index: "013" + mutes: items: - $ref: '#/components/schemas/UserResponse' + $ref: '#/components/schemas/UserMuteResponse' type: array - x-stream-index: "001.029" - message_text_updated_at: + x-stream-index: "006" + name: + type: string + x-stream-index: "001.002" + online: + type: boolean + x-stream-index: "001.013" + privacy_settings: + $ref: '#/components/schemas/PrivacySettingsResponse' + x-stream-index: "003" + push_preferences: + $ref: '#/components/schemas/PushPreferences' + x-stream-index: "002" + revoke_tokens_issued_before: format: date-time type: number - x-stream-index: "001.036" - mml: + x-stream-index: "001.015" + role: type: string - x-stream-index: "001.003" - moderation: - $ref: '#/components/schemas/ModerationV2Response' - x-stream-index: "001.039" - own_reactions: + x-stream-index: "001.006" + teams: items: - $ref: '#/components/schemas/ReactionResponse' + type: string type: array + x-stream-index: "001.007" + teams_role: + additionalProperties: + type: string + type: object + x-stream-index: "001.008" + total_unread_count: + format: int32 + type: integer + x-stream-index: "009" + total_unread_count_by_team: + additionalProperties: + format: int32 + type: integer + type: object + x-stream-index: "010" + unread_channels: + format: int32 + type: integer + x-stream-index: "011" + unread_count: + format: int32 + type: integer + x-stream-index: "008" + unread_threads: + format: int32 + type: integer + x-stream-index: "012" + updated_at: + format: date-time + type: number x-stream-index: "001.010" - parent_id: + required: + - id + - custom + - language + - role + - teams + - created_at + - updated_at + - banned + - online + - devices + - invisible + - mutes + - channel_mutes + - unread_count + - total_unread_count + - unread_channels + - unread_threads + type: object + PagerRequest: + properties: + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "001" + next: type: string - x-stream-index: "001.015" - pin_expires: - format: date-time - type: number - x-stream-index: "001.035" - pinned: - type: boolean - x-stream-index: "001.032" - pinned_at: - format: date-time - type: number - x-stream-index: "001.033" - pinned_by: - $ref: '#/components/schemas/UserResponse' - x-stream-index: "001.034" - poll: - $ref: '#/components/schemas/PollResponseData' - x-stream-index: "001.038" - poll_id: + x-stream-index: "002" + prev: type: string - x-stream-index: "001.037" - quoted_message: - $ref: '#/components/schemas/MessageResponse' - x-stream-index: "001.020" - quoted_message_id: + x-stream-index: "003" + type: object + PagerResponse: + properties: + next: type: string - x-stream-index: "001.019" - reaction_counts: - additionalProperties: - format: int32 - type: integer - type: object - x-stream-index: "001.011" - reaction_groups: - additionalProperties: - $ref: '#/components/schemas/ReactionGroupResponse' - type: object - x-stream-index: "001.014" - reaction_scores: - additionalProperties: - format: int32 - type: integer - type: object - x-stream-index: "001.012" - reminder: - $ref: '#/components/schemas/ReminderResponseData' - x-stream-index: "001.042" - reply_count: + x-stream-index: "001" + prev: + type: string + x-stream-index: "002" + type: object + PaginationParams: + properties: + limit: format: int32 + minimum: 0 type: integer - x-stream-index: "001.017" - restricted_visibility: - items: - type: string - type: array - x-stream-index: "001.040" - shadowed: - type: boolean - x-stream-index: "001.027" - shared_location: - $ref: '#/components/schemas/SharedLocationResponseData' - x-stream-index: "001.043" - show_in_channel: - type: boolean - x-stream-index: "001.016" - silent: - type: boolean - x-stream-index: "001.031" - text: - type: string - x-stream-index: "001.002" - thread_participants: - items: - $ref: '#/components/schemas/UserResponse' - type: array - x-stream-index: "001.021" - type: - type: string - x-stream-index: "001.006" - updated_at: + x-stream-index: "001" + offset: + format: int32 + type: integer + x-stream-index: "002" + type: object + ParticipantCountByMinuteResponse: + nullable: true + properties: + first: + format: int32 + type: integer + x-stream-index: "002" + last: + format: int32 + type: integer + x-stream-index: "003" + max: + format: int32 + type: integer + x-stream-index: "004" + min: + format: int32 + type: integer + x-stream-index: "005" + start_ts: format: date-time type: number - x-stream-index: "001.024" - user: - $ref: '#/components/schemas/UserResponse' - x-stream-index: "001.007" + x-stream-index: "001" required: - - id - - text - - html - - type - - user - - attachments - - latest_reactions - - own_reactions - - reaction_counts - - reaction_scores - - reply_count - - deleted_reply_count - - cid - - created_at - - updated_at - - custom - - shadowed - - mentioned_users - - silent - - pinned - - restricted_visibility + - start_ts + - first + - last + - max + - min type: object - SearchWarning: + ParticipantCountOverTimeResponse: properties: - channel_search_cids: - description: Channel CIDs for the searched channels + by_minute: items: - type: string - title: Channel Search CIDs + $ref: '#/components/schemas/ParticipantCountByMinuteResponse' + type: array + x-stream-index: "001" + type: object + ParticipantReportResponse: + properties: + by_browser: + items: + $ref: '#/components/schemas/GroupedStatsResponse' + type: array + x-stream-index: "008" + by_country: + items: + $ref: '#/components/schemas/GroupedStatsResponse' + type: array + x-stream-index: "005" + by_device: + items: + $ref: '#/components/schemas/GroupedStatsResponse' + type: array + x-stream-index: "006" + by_operating_system: + items: + $ref: '#/components/schemas/GroupedStatsResponse' type: array + x-stream-index: "007" + count_over_time: + $ref: '#/components/schemas/ParticipantCountOverTimeResponse' x-stream-index: "004" - channel_search_count: - description: Number of channels searched + max_concurrent: format: int32 - title: Channel Search Count type: integer x-stream-index: "003" - warning_code: - description: Code corresponding to the warning + publishers: + $ref: '#/components/schemas/PublisherStatsResponse' + x-stream-index: "009" + subscribers: + $ref: '#/components/schemas/SubscriberStatsResponse' + x-stream-index: "010" + sum: format: int32 - title: Warning Code type: integer - x-stream-index: "002" - warning_description: - description: Description of the warning - title: Warning Description - type: string x-stream-index: "001" + unique: + format: int32 + type: integer + x-stream-index: "002" required: - - warning_description - - warning_code + - sum + - unique type: object - SendCallEventRequest: - description: Send a call event to the other user + PendingMessageEvent: + description: Pending message event for async moderation nullable: true properties: + channel: + $ref: '#/components/schemas/Channel' + x-stream-index: "002.007" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: "004" custom: additionalProperties: {} - title: Custom type: object - x-stream-index: "004" - title: SendCallEventRequest - type: object - SendCallEventResponse: - nullable: true - properties: - duration: - description: Duration of the request in milliseconds - title: Duration + x-stream-index: "001.007" + message: + $ref: '#/components/schemas/Message' + description: The pending message + title: Message + x-stream-index: "002.009" + metadata: + additionalProperties: + type: string + type: object + x-stream-index: "002.010" + method: + description: The method used for the pending message + title: Method type: string - x-stream-index: "001.001" + x-stream-index: "003" + received_at: + format: date-time + type: number + x-stream-index: "001.004" + type: + default: message.pending + description: 'The type of event: "message.pending" in this case' + title: Event Type + type: string + x-stream-index: "001.002" + user: + $ref: '#/components/schemas/User' + x-stream-index: "002.002" required: - - duration - title: SendCallEventResponse + - type + - custom + - method + - created_at + title: PendingMessageEvent type: object - SendEventRequest: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + PendingMessageResponse: nullable: true properties: - event: - $ref: '#/components/schemas/EventRequest' + channel: + $ref: '#/components/schemas/ChannelResponse' + x-stream-index: "002" + message: + $ref: '#/components/schemas/MessageResponse' + x-stream-index: "003" + metadata: + additionalProperties: + type: string + type: object + x-stream-index: "004" + user: + $ref: '#/components/schemas/UserResponse' x-stream-index: "001" - required: - - event type: object - SendMessageRequest: + PerSDKUsageReport: nullable: true properties: - keep_channel_hidden: - type: boolean - x-stream-index: "008" - message: - $ref: '#/components/schemas/MessageRequest' + by_version: + additionalProperties: + format: int32 + type: integer + type: object + x-stream-index: "002" + total: + format: int32 + type: integer x-stream-index: "001" - skip_enrich_url: - type: boolean + required: + - total + - by_version + type: object + PermissionRequestEvent: + description: |- + This event is sent when a user requests access to a feature on a call, + clients receiving this event should display a permission request to the user + properties: + call_cid: + type: string + x-stream-index: "002.001" + created_at: + format: date-time + type: number + x-stream-index: "001.002" + permissions: + description: The list of permissions requested by the user + items: + type: string + title: Permissions + type: array + x-stream-index: "004" + type: + default: call.permission_request + description: 'The type of event: "call.permission_request" in this case' + title: Event Type + type: string + x-stream-index: "001.001" + user: + $ref: '#/components/schemas/UserResponse' + description: The user who sent the permission request + title: User x-stream-index: "003" - skip_push: - type: boolean - x-stream-index: "002" required: - - message + - type + - created_at + - call_cid + - user + - permissions + title: PermissionRequestEvent type: object - SendMessageResponse: + x-stream-event-call-type: true + x-stream-event-doc-group: call + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + PinActivityRequest: + nullable: true + title: Pin Activity Request + type: object + PinActivityResponse: nullable: true properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + description: The pinned activity + title: Activity + x-stream-index: "001" + created_at: + description: When the activity was pinned + format: date-time + title: Created At + type: number + x-stream-index: "004" duration: - description: Duration of the request in milliseconds - title: Duration type: string - x-stream-index: "003.001" - message: - $ref: '#/components/schemas/MessageResponse' - description: Message response - title: Message - x-stream-index: "001" - pending_message_metadata: - additionalProperties: - type: string - description: Pending message metadata - title: Pending message metadata - type: object + x-stream-index: "005.001" + feed: + description: Fully qualified ID of the feed the activity was pinned to + title: Feed ID + type: string x-stream-index: "002" + user_id: + description: ID of the user who pinned the activity + title: User ID + type: string + x-stream-index: "003" required: - - message + - activity + - feed + - user_id + - created_at - duration + title: Pin Activity Response type: object - SendReactionRequest: + PinRequest: + description: PinRequest is the payload for pinning a message. nullable: true properties: - enforce_unique: - description: Whether to replace all existing user reactions - title: Enforce unique - type: boolean + session_id: + description: the session ID of the user who pinned the message + title: SessionID + type: string x-stream-index: "003" - reaction: - $ref: '#/components/schemas/ReactionRequest' + user_id: + description: the user ID of the user who pinned the message + title: UserID + type: string x-stream-index: "002" - skip_push: - description: Skips any mobile push notifications - title: Skip push - type: boolean - x-stream-index: "004" required: - - reaction + - user_id + - session_id + title: PinRequest type: object - SendReactionResponse: + PinResponse: description: Basic response information nullable: true properties: @@ -16757,2280 +17278,2387 @@ components: description: Duration of the request in milliseconds title: Duration type: string - x-stream-index: "003.001" - message: - $ref: '#/components/schemas/MessageResponse' - x-stream-index: "001" - reaction: - $ref: '#/components/schemas/ReactionResponse' - x-stream-index: "002" + x-stream-index: "001.001" required: - - message - - reaction - duration title: Response type: object - SessionSettings: - properties: - inactivity_timeout_seconds: - format: int32 - maximum: 900 - minimum: 5 - type: integer - x-stream-index: "001" - required: - - inactivity_timeout_seconds - type: object - SessionSettingsRequest: - properties: - inactivity_timeout_seconds: - format: int32 - maximum: 900 - minimum: 5 - type: integer - x-stream-index: "001" - required: - - inactivity_timeout_seconds - type: object - SessionSettingsResponse: + Poll: properties: - inactivity_timeout_seconds: + Custom: + additionalProperties: {} + type: object + writeOnly: true + x-stream-index: "023" + allow_answers: + type: boolean + x-stream-index: "010" + allow_user_suggested_options: + type: boolean + x-stream-index: "009" + answers_count: format: int32 - maximum: 900 - minimum: 5 type: integer - x-stream-index: "001" - required: - - inactivity_timeout_seconds - type: object - ShadowBlockActionRequest: - type: object - SharedLocation: - properties: - channel: - $ref: '#/components/schemas/Channel' - x-stream-index: "013" - channel_cid: - type: string - x-stream-index: "003" + x-stream-index: "015" created_at: format: date-time type: number - x-stream-index: "010" - created_by_device_id: - type: string - x-stream-index: "008" - end_at: - format: date-time - type: number - x-stream-index: "009" - latitude: - format: float - maximum: 90 - minimum: 1.8446744073709552e+19 - type: number - x-stream-index: "006" - longitude: - format: float - maximum: 180 - minimum: 1.8446744073709552e+19 - type: number + x-stream-index: "021" + created_by: + $ref: '#/components/schemas/User' + x-stream-index: "020" + created_by_id: + type: string + x-stream-index: "019" + description: + type: string + x-stream-index: "005" + enforce_unique_vote: + type: boolean x-stream-index: "007" - message: - $ref: '#/components/schemas/Message' - x-stream-index: "012" - message_id: + id: + type: string + x-stream-index: "003" + is_closed: + type: boolean + x-stream-index: "011" + latest_answers: + items: + $ref: '#/components/schemas/PollVote' + type: array + x-stream-index: "017" + latest_votes_by_option: + additionalProperties: + items: + $ref: '#/components/schemas/PollVote' + type: array + type: object + x-stream-index: "016" + max_votes_allowed: + format: int32 + type: integer + x-stream-index: "008" + name: type: string x-stream-index: "004" + options: + items: + $ref: '#/components/schemas/PollOption' + type: array + x-stream-index: "013" + own_votes: + items: + $ref: '#/components/schemas/PollVote' + type: array + x-stream-index: "018" updated_at: format: date-time type: number - x-stream-index: "011" - user_id: + x-stream-index: "022" + vote_count: + format: int32 + type: integer + x-stream-index: "012" + vote_counts_by_option: + additionalProperties: + format: int32 + type: integer + type: object + x-stream-index: "014" + voting_visibility: type: string - x-stream-index: "005" + x-stream-index: "006" required: - - channel_cid - - message_id - - user_id - - created_by_device_id + - id + - name + - description + - enforce_unique_vote + - allow_user_suggested_options + - allow_answers + - vote_count + - options + - vote_counts_by_option + - answers_count + - latest_votes_by_option + - latest_answers + - own_votes + - created_by_id - created_at - updated_at + - Custom type: object - SharedLocationResponse: + PollClosedEvent: + description: Emitted when a poll is closed. nullable: true properties: - channel: - $ref: '#/components/schemas/ChannelResponse' - x-stream-index: "001.011" - channel_cid: - description: Channel CID - title: string + activity_id: type: string - x-stream-index: "001.001" + x-stream-index: "001.003" + cid: + description: The CID of the channel containing the poll + title: Channel CID + type: string + x-stream-index: 001.001.002 created_at: description: Date/time of creation format: date-time title: Created at type: number - x-stream-index: "001.008" - created_by_device_id: - description: Device ID that created the live location - title: string - type: string - x-stream-index: "001.006" - duration: - type: string - x-stream-index: "002.001" - end_at: - description: Time when the live location expires - format: date-time - title: string - type: number - x-stream-index: "001.007" - latitude: - description: Latitude coordinate - format: float - title: number - type: number - x-stream-index: "001.004" - longitude: - description: Longitude coordinate - format: float - title: number - type: number - x-stream-index: "001.005" - message: - $ref: '#/components/schemas/MessageResponse' - x-stream-index: "001.010" + x-stream-index: 001.001.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 001.001.001.007 message_id: - description: Message ID - title: string + description: The ID of the message containing the poll + title: Message ID type: string x-stream-index: "001.002" - updated_at: - description: Date/time of the last update + poll: + $ref: '#/components/schemas/PollResponseData' + description: The poll object which was closed + title: Poll + x-stream-index: "001.004" + received_at: format: date-time - title: Updated at type: number - x-stream-index: "001.009" - user_id: - description: User ID - title: string + x-stream-index: 001.001.001.004 + type: + default: poll.closed + description: 'The type of event: "poll.closed" in this case' + title: Event Type type: string - x-stream-index: "001.003" + x-stream-index: 001.001.001.002 required: - - channel_cid - - message_id - - user_id - - latitude - - longitude - - created_by_device_id + - type - created_at - - updated_at - - duration + - custom + - poll + title: PollClosedEvent type: object - SharedLocationResponseData: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + PollClosedFeedEvent: nullable: true properties: - channel: - $ref: '#/components/schemas/ChannelResponse' - x-stream-index: "011" - channel_cid: - type: string - x-stream-index: "001" created_at: format: date-time type: number - x-stream-index: "008" - created_by_device_id: + x-stream-index: 001.002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 001.002.001.007 + feed_visibility: type: string - x-stream-index: "006" - end_at: - format: date-time - type: number - x-stream-index: "007" - latitude: - format: float - type: number - x-stream-index: "004" - longitude: - format: float - type: number - x-stream-index: "005" - message: - $ref: '#/components/schemas/MessageResponse' - x-stream-index: "010" - message_id: + x-stream-index: 001.002.003 + fid: type: string - x-stream-index: "002" - updated_at: + x-stream-index: 001.002.002 + poll: + $ref: '#/components/schemas/PollResponseData' + x-stream-index: "001.001" + received_at: format: date-time type: number - x-stream-index: "009" - user_id: + x-stream-index: 001.002.001.004 + type: + default: feeds.poll.closed type: string - x-stream-index: "003" + x-stream-index: 001.002.001.002 required: - - channel_cid - - message_id - - user_id - - latitude - - longitude - - created_by_device_id + - poll + - type - created_at - - updated_at + - custom + - fid + title: PollClosedFeedEvent type: object - SharedLocationsResponse: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + PollDeletedEvent: + description: Emitted when a poll is deleted. nullable: true properties: - active_live_locations: - items: - $ref: '#/components/schemas/SharedLocationResponseData' - type: array - x-stream-index: "001" - duration: + activity_id: type: string - x-stream-index: "002.001" + x-stream-index: "001.003" + cid: + description: The CID of the channel containing the poll + title: Channel CID + type: string + x-stream-index: 001.001.002 + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 001.001.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 001.001.001.007 + message_id: + description: The ID of the message containing the poll + title: Message ID + type: string + x-stream-index: "001.002" + poll: + $ref: '#/components/schemas/PollResponseData' + description: The poll object which was deleted + title: Poll + x-stream-index: "001.004" + received_at: + format: date-time + type: number + x-stream-index: 001.001.001.004 + type: + default: poll.deleted + description: 'The type of event: "poll.deleted" in this case' + title: Event Type + type: string + x-stream-index: 001.001.001.002 required: - - active_live_locations - - duration - type: object - ShowChannelRequest: - nullable: true + - type + - created_at + - custom + - poll + title: PollDeletedEvent type: object - ShowChannelResponse: - description: Basic response information + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + PollDeletedFeedEvent: nullable: true properties: - duration: - description: Duration of the request in milliseconds - title: Duration + created_at: + format: date-time + type: number + x-stream-index: 001.002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 001.002.001.007 + feed_visibility: + type: string + x-stream-index: 001.002.003 + fid: type: string + x-stream-index: 001.002.002 + poll: + $ref: '#/components/schemas/PollResponseData' x-stream-index: "001.001" + received_at: + format: date-time + type: number + x-stream-index: 001.002.001.004 + type: + default: feeds.poll.deleted + type: string + x-stream-index: 001.002.001.002 required: - - duration - title: Response + - poll + - type + - created_at + - custom + - fid + title: PollDeletedFeedEvent type: object - SortParamRequest: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + PollOption: nullable: true properties: - direction: - description: Direction of sorting, 1 for Ascending, -1 for Descending, default - is 1 - format: int32 - title: Direction - type: integer - x-stream-index: "002" - field: - description: Name of field to sort by - title: Field + custom: + additionalProperties: {} + type: object + x-stream-index: "003" + id: + maxLength: 255 type: string x-stream-index: "001" + text: + type: string + x-stream-index: "002" + required: + - id + - text + - custom type: object - StartClosedCaptionsRequest: + PollOptionInput: nullable: true properties: - enable_transcription: - description: Enable transcriptions along with closed captions - title: Enable Transcription - type: boolean - x-stream-index: "002" - external_storage: - description: Which external storage to use for transcriptions (only applicable - if enable_transcription is true) - title: External Storage - type: string + custom: + additionalProperties: {} + type: object x-stream-index: "003" - language: - description: The spoken language in the call, if not provided the language - defined in the transcription settings will be used - enum: - - auto - - en - - fr - - es - - de - - it - - nl - - pt - - pl - - ca - - cs - - da - - el - - fi - - id - - ja - - ru - - sv - - ta - - th - - tr - - hu - - ro - - zh - - ar - - tl - - he - - hi - - hr - - ko - - ms - - "no" - - uk - - bg - - et - - sl - - sk - title: Language + text: type: string - x-stream-index: "004" + x-stream-index: "002" type: object - StartClosedCaptionsResponse: + PollOptionRequest: nullable: true properties: - duration: + custom: + additionalProperties: {} + type: object + x-stream-index: "003" + id: + maxLength: 255 type: string - x-stream-index: "001.001" - required: - - duration - type: object - StartFrameRecordingRequest: - nullable: true - properties: - recording_external_storage: + x-stream-index: "001" + text: type: string x-stream-index: "002" - title: StartFrameRecordingRequest + required: + - id type: object - StartFrameRecordingResponse: - description: StartFrameRecordingResponse is the response payload for the start - frame recording endpoint. + PollOptionResponse: nullable: true properties: duration: description: Duration of the request in milliseconds title: Duration type: string - x-stream-index: "001.001" + x-stream-index: "002.001" + poll_option: + $ref: '#/components/schemas/PollOptionResponseData' + description: Poll option + title: PollOptionResponseData + x-stream-index: "001" required: + - poll_option - duration - title: StartFrameRecordingResponse - type: object - StartHLSBroadcastingRequest: - description: StartHLSBroadcastingRequest is the payload for starting an HLS - broadcasting. - nullable: true - title: StartHLSBroadcastingRequest type: object - StartHLSBroadcastingResponse: - description: StartHLSBroadcastingResponse is the payload for starting an HLS - broadcasting. + PollOptionResponseData: nullable: true properties: - duration: + custom: + additionalProperties: {} + type: object + x-stream-index: "003" + id: type: string - x-stream-index: "001.001" - playlist_url: - description: the URL of the HLS playlist - title: PlaylistURL + x-stream-index: "001" + text: type: string x-stream-index: "002" required: - - duration - - playlist_url - title: StartHLSBroadcastingResponse - type: object - StartRTMPBroadcastsRequest: - description: StartRTMPBroadcastsRequest is the payload for starting RTMP broadcasts. - nullable: true - properties: - broadcasts: - description: List of broadcasts to start - items: - $ref: '#/components/schemas/RTMPBroadcastRequest' - maximum: 1 - minimum: 1 - title: Broadcasts - type: array - x-stream-index: "002" - required: - - broadcasts - title: StartRTMPBroadcastsRequest + - id + - text + - custom type: object - StartRTMPBroadcastsResponse: - description: StartRTMPBroadcastsResponse is the payload for starting an RTMP - broadcast. + PollResponse: nullable: true properties: duration: description: Duration of the request in milliseconds title: Duration type: string - x-stream-index: "001.001" - required: - - duration - title: StartRTMPBroadcastsResponse - type: object - StartRecordingRequest: - nullable: true - properties: - recording_external_storage: - type: string - x-stream-index: "002" - title: StartRecordingRequest - type: object - StartRecordingResponse: - description: StartRecordingResponse is the response payload for the start recording - endpoint. - nullable: true - properties: - duration: - description: Duration of the request in milliseconds - title: Duration - type: string - x-stream-index: "001.001" + x-stream-index: "002.001" + poll: + $ref: '#/components/schemas/PollResponseData' + description: Poll + title: PollResponseData + x-stream-index: "001" required: + - poll - duration - title: StartRecordingResponse type: object - StartTranscriptionRequest: - nullable: true + PollResponseData: properties: - enable_closed_captions: - description: Enable closed captions along with transcriptions - title: Enable Closed Captions + allow_answers: type: boolean - x-stream-index: "003" - language: - description: The spoken language in the call, if not provided the language - defined in the transcription settings will be used - enum: - - auto - - en - - fr - - es - - de - - it - - nl - - pt - - pl - - ca - - cs - - da - - el - - fi - - id - - ja - - ru - - sv - - ta - - th - - tr - - hu - - ro - - zh - - ar - - tl - - he - - hi - - hr - - ko - - ms - - "no" - - uk - - bg - - et - - sl - - sk - title: Language + x-stream-index: "008" + allow_user_suggested_options: + type: boolean + x-stream-index: "007" + answers_count: + format: int32 + type: integer + x-stream-index: "012" + created_at: + format: date-time + type: number + x-stream-index: "019" + created_by: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "018" + created_by_id: type: string - x-stream-index: "004" - transcription_external_storage: - description: Store transcriptions in this external storage - title: External Storage + x-stream-index: "017" + custom: + additionalProperties: {} + type: object + x-stream-index: "021" + description: type: string - x-stream-index: "002" - type: object - StartTranscriptionResponse: - nullable: true - properties: - duration: - description: Duration of the request in milliseconds - title: Duration + x-stream-index: "003" + enforce_unique_vote: + type: boolean + x-stream-index: "005" + id: type: string - x-stream-index: "001.001" - required: - - duration - title: StartTranscriptionResponse - type: object - StatsOptions: - properties: - enable_rtc_stats: + x-stream-index: "001" + is_closed: type: boolean + x-stream-index: "009" + latest_answers: + items: + $ref: '#/components/schemas/PollVoteResponseData' + type: array + x-stream-index: "015" + latest_votes_by_option: + additionalProperties: + items: + $ref: '#/components/schemas/PollVoteResponseData' + type: array + type: object + x-stream-index: "014" + max_votes_allowed: + format: int32 + type: integer + x-stream-index: "006" + name: + type: string x-stream-index: "002" - reporting_interval_ms: + options: + items: + $ref: '#/components/schemas/PollOptionResponseData' + type: array + x-stream-index: "011" + own_votes: + items: + $ref: '#/components/schemas/PollVoteResponseData' + type: array + x-stream-index: "016" + updated_at: + format: date-time + type: number + x-stream-index: "020" + vote_count: format: int32 type: integer - x-stream-index: "001" + x-stream-index: "010" + vote_counts_by_option: + additionalProperties: + format: int32 + type: integer + type: object + x-stream-index: "013" + voting_visibility: + type: string + x-stream-index: "004" required: - - reporting_interval_ms - - enable_rtc_stats - type: object - StopAllRTMPBroadcastsRequest: - nullable: true - title: StopAllRTMPBroadcastsRequest + - id + - name + - description + - voting_visibility + - enforce_unique_vote + - allow_user_suggested_options + - allow_answers + - vote_count + - options + - answers_count + - vote_counts_by_option + - latest_votes_by_option + - latest_answers + - own_votes + - created_by_id + - created_at + - updated_at + - custom type: object - StopAllRTMPBroadcastsResponse: + PollUpdatedEvent: + description: Emitted when a poll is updated. nullable: true properties: - duration: - description: Duration of the request in milliseconds - title: Duration + activity_id: type: string - x-stream-index: "001.001" + x-stream-index: "001.003" + cid: + description: The CID of the channel containing the poll + title: Channel CID + type: string + x-stream-index: 001.001.002 + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 001.001.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 001.001.001.007 + message_id: + description: The ID of the message containing the poll + title: Message ID + type: string + x-stream-index: "001.002" + poll: + $ref: '#/components/schemas/PollResponseData' + description: The poll object which was updated + title: Poll + x-stream-index: "001.004" + received_at: + format: date-time + type: number + x-stream-index: 001.001.001.004 + type: + default: poll.updated + description: 'The type of event: "poll.updated" in this case' + title: Event Type + type: string + x-stream-index: 001.001.001.002 required: - - duration - title: StopAllRTMPBroadcastsResponse + - type + - created_at + - custom + - poll + title: PollUpdatedEvent type: object - StopClosedCaptionsRequest: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + PollUpdatedFeedEvent: nullable: true properties: - stop_transcription: - type: boolean - x-stream-index: "003" - type: object - StopClosedCaptionsResponse: - description: Basic response information - nullable: true - properties: - duration: - description: Duration of the request in milliseconds - title: Duration + created_at: + format: date-time + type: number + x-stream-index: 001.002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 001.002.001.007 + feed_visibility: type: string - x-stream-index: "001.001" - required: - - duration - title: Response - type: object - StopFrameRecordingRequest: - nullable: true - type: object - StopFrameRecordingResponse: - description: Basic response information - nullable: true - properties: - duration: - description: Duration of the request in milliseconds - title: Duration + x-stream-index: 001.002.003 + fid: type: string + x-stream-index: 001.002.002 + poll: + $ref: '#/components/schemas/PollResponseData' x-stream-index: "001.001" - required: - - duration - title: Response - type: object - StopHLSBroadcastingRequest: - nullable: true - type: object - StopHLSBroadcastingResponse: - description: Basic response information - nullable: true - properties: - duration: - description: Duration of the request in milliseconds - title: Duration + received_at: + format: date-time + type: number + x-stream-index: 001.002.001.004 + type: + default: feeds.poll.updated type: string - x-stream-index: "001.001" + x-stream-index: 001.002.001.002 required: - - duration - title: Response + - poll + - type + - created_at + - custom + - fid + title: PollUpdatedFeedEvent type: object - StopLiveRequest: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + PollVote: nullable: true properties: - continue_closed_caption: - type: boolean - x-stream-index: "006" - continue_hls: - type: boolean - x-stream-index: "003" - continue_recording: - type: boolean - x-stream-index: "004" - continue_rtmp_broadcasts: - type: boolean + answer_text: + type: string x-stream-index: "007" - continue_transcription: + created_at: + format: date-time + type: number + x-stream-index: "010" + id: + type: string + x-stream-index: "004" + is_answer: type: boolean + x-stream-index: "006" + option_id: + type: string x-stream-index: "005" - title: StopLiveRequest - type: object - StopLiveResponse: - nullable: true - properties: - call: - $ref: '#/components/schemas/CallResponse' - description: The call that was stopped - title: Call - x-stream-index: "001" - duration: + poll_id: type: string - x-stream-index: "002.001" - required: - - call - - duration - title: StopLiveResponse - type: object - StopRTMPBroadcastsRequest: - description: Request for stopping RTMP broadcasts - nullable: true - title: StopRTMPBroadcastsRequest - type: object - StopRTMPBroadcastsResponse: - description: Basic response information - nullable: true - properties: - duration: - description: Duration of the request in milliseconds - title: Duration + x-stream-index: "003" + updated_at: + format: date-time + type: number + x-stream-index: "011" + user: + $ref: '#/components/schemas/User' + x-stream-index: "009" + user_id: type: string - x-stream-index: "001.001" + x-stream-index: "008" required: - - duration - title: Response - type: object - StopRecordingRequest: - nullable: true + - poll_id + - id + - option_id + - created_at + - updated_at type: object - StopRecordingResponse: - description: Basic response information + PollVoteCastedEvent: + description: Emitted when a vote is cast on a poll. nullable: true properties: - duration: - description: Duration of the request in milliseconds - title: Duration + activity_id: type: string - x-stream-index: "001.001" + x-stream-index: 001.001.003 + cid: + description: The CID of the channel containing the poll + 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: number + x-stream-index: 001.001.001.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 001.001.001.001.007 + message_id: + description: The ID of the message containing the poll + title: Message ID + type: string + x-stream-index: 001.001.002 + poll: + $ref: '#/components/schemas/PollResponseData' + description: The poll object + title: Poll + x-stream-index: 001.001.004 + poll_vote: + $ref: '#/components/schemas/PollVoteResponseData' + description: The vote that was cast + title: Poll Vote + x-stream-index: "001.002" + received_at: + format: date-time + type: number + x-stream-index: 001.001.001.001.004 + type: + default: poll.vote_casted + description: 'The type of event: "poll.vote_casted" in this case' + title: Event Type + type: string + x-stream-index: 001.001.001.001.002 required: - - duration - title: Response - type: object - StopTranscriptionRequest: - nullable: true - properties: - stop_closed_captions: - type: boolean - x-stream-index: "003" + - type + - created_at + - custom + - poll + - poll_vote + title: PollVoteCastedEvent type: object - StopTranscriptionResponse: - description: Basic response information + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + PollVoteCastedFeedEvent: nullable: true properties: - duration: - description: Duration of the request in milliseconds - title: Duration + created_at: + format: date-time + type: number + x-stream-index: 001.001.002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 001.001.002.001.007 + feed_visibility: type: string - x-stream-index: "001.001" + x-stream-index: 001.001.002.003 + fid: + type: string + x-stream-index: 001.001.002.002 + poll: + $ref: '#/components/schemas/PollResponseData' + x-stream-index: 001.001.001 + poll_vote: + $ref: '#/components/schemas/PollVoteResponseData' + x-stream-index: "001.002" + received_at: + format: date-time + type: number + x-stream-index: 001.001.002.001.004 + type: + default: feeds.poll.vote_casted + type: string + x-stream-index: 001.001.002.001.002 required: - - duration - title: Response + - poll + - type + - created_at + - custom + - fid + - poll_vote + title: PollVoteCastedFeedEvent type: object - SubmitActionRequest: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + PollVoteChangedEvent: + description: Emitted when a vote on a poll is changed. nullable: true properties: - action_type: - description: Type of moderation action to perform (mark_reviewed, delete_message, - etc.) - enum: - - mark_reviewed - - delete_message - - delete_activity - - delete_reaction - - ban - - custom - - unban - - restore - - delete_user - - unblock - - shadow_block - - unmask - - kick_user - - end_call - title: Action Type + activity_id: type: string - x-stream-index: "002" - ban: - $ref: '#/components/schemas/BanActionRequest' - description: Configuration for ban action - title: Ban - x-stream-index: "008" + x-stream-index: 001.001.003 + cid: + description: The CID of the channel containing the poll + 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: number + x-stream-index: 001.001.001.001.003 custom: - $ref: '#/components/schemas/CustomActionRequest' - description: Configuration for custom action - title: Custom - x-stream-index: "009" - delete_activity: - $ref: '#/components/schemas/DeleteActivityRequest' - description: Configuration for activity deletion action - title: Delete Activity - x-stream-index: "004" - delete_message: - $ref: '#/components/schemas/DeleteMessageRequest' - description: Configuration for message deletion action - title: Delete Message - x-stream-index: "003" - delete_reaction: - $ref: '#/components/schemas/DeleteReactionRequest' - description: Configuration for reaction deletion action - title: Delete Reaction - x-stream-index: "005" - delete_user: - $ref: '#/components/schemas/DeleteUserRequest' - description: Configuration for user deletion action - title: Delete User - x-stream-index: "006" - item_id: - description: UUID of the review queue item to act on - title: Item ID + additionalProperties: {} + type: object + x-stream-index: 001.001.001.001.007 + message_id: + description: The ID of the message containing the poll + title: Message ID type: string - x-stream-index: "001" - mark_reviewed: - $ref: '#/components/schemas/MarkReviewedRequest' - description: Configuration for marking item as reviewed - title: Mark Reviewed - x-stream-index: "007" - unban: - $ref: '#/components/schemas/UnbanActionRequest' - description: Configuration for unban action - title: Unban - x-stream-index: "010" + x-stream-index: 001.001.002 + poll: + $ref: '#/components/schemas/PollResponseData' + description: The poll object + title: Poll + x-stream-index: 001.001.004 + poll_vote: + $ref: '#/components/schemas/PollVoteResponseData' + description: The updated vote + title: Poll Vote + x-stream-index: "001.002" + received_at: + format: date-time + type: number + x-stream-index: 001.001.001.001.004 + type: + default: poll.vote_changed + description: 'The type of event: "poll.vote_changed" in this case' + title: Event Type + type: string + x-stream-index: 001.001.001.001.002 required: - - item_id - - action_type + - type + - created_at + - custom + - poll + - poll_vote + title: PollVoteChangedEvent type: object - SubmitActionResponse: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + PollVoteChangedFeedEvent: nullable: true properties: - duration: + created_at: + format: date-time + type: number + x-stream-index: 001.001.002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 001.001.002.001.007 + feed_visibility: type: string - x-stream-index: "002.001" - item: - $ref: '#/components/schemas/ReviewQueueItemResponse' - description: Updated review queue item after action was performed - title: Item - x-stream-index: "001" - required: - - duration - type: object - SubscriberStatsResponse: - properties: - total: - format: int32 - type: integer - x-stream-index: "001" - total_subscribed_duration_seconds: - format: int32 - type: integer - x-stream-index: "003" - unique: - format: int32 - type: integer - x-stream-index: "002" + x-stream-index: 001.001.002.003 + fid: + type: string + x-stream-index: 001.001.002.002 + poll: + $ref: '#/components/schemas/PollResponseData' + x-stream-index: 001.001.001 + poll_vote: + $ref: '#/components/schemas/PollVoteResponseData' + x-stream-index: "001.002" + received_at: + format: date-time + type: number + x-stream-index: 001.001.002.001.004 + type: + default: feeds.poll.vote_changed + type: string + x-stream-index: 001.001.002.001.002 required: - - total - - unique - - total_subscribed_duration_seconds + - poll + - type + - created_at + - custom + - fid + - poll_vote + title: PollVoteChangedFeedEvent type: object - SyncRequest: - description: Sync request + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + PollVoteRemovedEvent: + description: Emitted when a vote is removed from a poll. nullable: true properties: - channel_cids: - description: List of channel CIDs to sync - items: - type: string - maximum: 255 - minimum: 1 - title: Channel CIDs - type: array - x-stream-index: "001" - last_sync_at: - description: Date from which synchronization should happen + activity_id: + type: string + x-stream-index: 001.001.003 + cid: + description: The CID of the channel containing the poll + title: Channel CID + type: string + x-stream-index: 001.001.001.002 + created_at: + description: Date/time of creation format: date-time - title: Last sync at + title: Created at type: number - x-stream-index: "002" + x-stream-index: 001.001.001.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 001.001.001.001.007 + message_id: + description: The ID of the message containing the poll + title: Message ID + type: string + x-stream-index: 001.001.002 + poll: + $ref: '#/components/schemas/PollResponseData' + description: The poll object + title: Poll + x-stream-index: 001.001.004 + poll_vote: + $ref: '#/components/schemas/PollVoteResponseData' + description: The vote that was removed + title: Poll Vote + x-stream-index: "001.002" + received_at: + format: date-time + type: number + x-stream-index: 001.001.001.001.004 + type: + default: poll.vote_removed + description: 'The type of event: "poll.vote_removed" in this case' + title: Event Type + type: string + x-stream-index: 001.001.001.001.002 required: - - channel_cids - - last_sync_at - title: SyncRequest + - type + - created_at + - custom + - poll + - poll_vote + title: PollVoteRemovedEvent type: object - SyncResponse: - description: Sync response + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + PollVoteRemovedFeedEvent: nullable: true properties: - duration: - description: Duration of the request in milliseconds - title: Duration + created_at: + format: date-time + type: number + x-stream-index: 001.001.002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 001.001.002.001.007 + feed_visibility: type: string - x-stream-index: "003.001" - events: - description: List of events - items: - $ref: '#/components/schemas/WSEvent' - title: Events - type: array - x-stream-index: "001" - inaccessible_cids: - description: List of CIDs that user can't access - items: - type: string - title: Inaccessible CIDs - type: array - x-stream-index: "002" + x-stream-index: 001.001.002.003 + fid: + type: string + x-stream-index: 001.001.002.002 + poll: + $ref: '#/components/schemas/PollResponseData' + x-stream-index: 001.001.001 + poll_vote: + $ref: '#/components/schemas/PollVoteResponseData' + x-stream-index: "001.002" + received_at: + format: date-time + type: number + x-stream-index: 001.001.002.001.004 + type: + default: feeds.poll.vote_removed + type: string + x-stream-index: 001.001.002.001.002 + required: + - poll + - type + - created_at + - custom + - fid + - poll_vote + title: PollVoteRemovedFeedEvent + 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 + PollVoteResponse: + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "002.001" + vote: + $ref: '#/components/schemas/PollVoteResponseData' + description: Poll vote + title: PollVoteResponseData + x-stream-index: "001" required: - - events - duration - title: SyncResponse type: object - TargetResolution: + PollVoteResponseData: + nullable: true properties: - bitrate: - format: int32 - maximum: 6000000 - type: integer - x-stream-index: "003" - height: - format: int32 - maximum: 3840 - minimum: 240 - type: integer + answer_text: + type: string + x-stream-index: "005" + created_at: + format: date-time + type: number + x-stream-index: "008" + id: + type: string x-stream-index: "002" - width: - format: int32 - maximum: 3840 - minimum: 240 - type: integer + is_answer: + type: boolean + x-stream-index: "004" + option_id: + type: string + x-stream-index: "003" + poll_id: + type: string x-stream-index: "001" + updated_at: + format: date-time + type: number + x-stream-index: "009" + user: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "007" + user_id: + type: string + x-stream-index: "006" required: - - width - - height + - poll_id + - id + - option_id + - created_at + - updated_at type: object - TextContentParameters: + PollVotesResponse: + nullable: true properties: - blocklist_match: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "003.001" + next: + type: string + x-stream-index: "002.001" + prev: + type: string + x-stream-index: "002.002" + votes: + description: Poll votes items: - type: string + $ref: '#/components/schemas/PollVoteResponseData' + title: PollVoteResponseList type: array - x-stream-index: "004" - contains_url: - type: boolean + x-stream-index: "001" + required: + - votes + - duration + type: object + PrivacySettings: + properties: + read_receipts: + $ref: '#/components/schemas/ReadReceipts' x-stream-index: "002" - harm_labels: - items: - type: string - type: array + typing_indicators: + $ref: '#/components/schemas/TypingIndicators' x-stream-index: "001" - severity: - type: string - x-stream-index: "003" type: object - TextRuleParameters: + PrivacySettingsResponse: properties: - blocklist_match: - items: - type: string - type: array - x-stream-index: "006" - contains_url: - type: boolean - x-stream-index: "004" - harm_labels: + read_receipts: + $ref: '#/components/schemas/ReadReceiptsResponse' + x-stream-index: "002" + typing_indicators: + $ref: '#/components/schemas/TypingIndicatorsResponse' + x-stream-index: "001" + type: object + PublisherStatsResponse: + properties: + by_track: items: - type: string + $ref: '#/components/schemas/TrackStatsResponse' type: array x-stream-index: "003" - severity: - type: string - x-stream-index: "005" - threshold: + total: format: int32 type: integer x-stream-index: "001" - time_window: - type: string + unique: + format: int32 + type: integer x-stream-index: "002" required: - - threshold - - time_window + - total + - unique type: object - ThreadParticipant: - description: Represents a user that is participating in a thread. - nullable: true + PushNotificationConfig: properties: - app_pk: - format: int32 - readOnly: true - type: integer + activity_types: + items: + type: string + type: array + x-stream-index: "002" + enabled: + type: boolean x-stream-index: "001" + type: object + PushPreferenceInput: + nullable: true + properties: + call_level: + description: Set the level of call push notifications for the user. One + of all, none, default + enum: + - all + - none + - default + type: string + x-stream-index: "004" channel_cid: + description: Set the push preferences for a specific channel. If empty it + sets the default for the user type: string x-stream-index: "002" - created_at: - description: Date/time of creation - format: date-time - title: Created at - type: number - x-stream-index: "007" - custom: - additionalProperties: {} - type: object - x-stream-index: "010" - last_read_at: - format: date-time - type: number - x-stream-index: "009" - last_thread_message_at: - format: date-time - type: number + chat_level: + description: Set the level of chat push notifications for the user. One + of all, mentions, none, default + enum: + - all + - mentions + - none + - default + type: string x-stream-index: "003" - left_thread_at: - description: Left Thread At is the time when the user left the thread + disabled_until: + description: Disable push notifications till a certain time format: date-time - title: Left Thread At type: number - x-stream-index: "008" - thread_id: - description: Thead ID is unique string identifier of the thread - title: ID - type: string - x-stream-index: "004" - user: - $ref: '#/components/schemas/UserResponse' - description: User is the user object - title: User + x-stream-index: "007" + feeds_events: + $ref: '#/components/schemas/FeedsEventPreferencesInput' + description: Set granular feeds event preferences for reactions, comments, + new followers, and mentions x-stream-index: "006" - user_id: - description: User ID is unique string identifier of the user - title: User ID + feeds_level: + description: Set the level of feeds push notifications for the user. One + of all, none, default + enum: + - all + - none + - default type: string x-stream-index: "005" - required: - - app_pk - - channel_cid - - created_at - - last_read_at - - custom - title: ThreadParticipant - type: object - ThreadResponse: - properties: - active_participant_count: - description: Active Participant Count - format: int32 - title: Active Participant Count - type: integer - x-stream-index: "009" - channel: - $ref: '#/components/schemas/ChannelResponse' - description: Channel - title: ChannelResponse + remove_disable: + description: Remove the disabled until time. (IE stop snoozing notifications) + type: boolean + x-stream-index: "008" + user_id: + description: The user id for which to set the push preferences. Required + when using server side auths, defaults to current user with client side + auth. + type: string + x-stream-index: "001" + type: object + PushPreferences: + properties: + call_level: + type: string x-stream-index: "002" - channel_cid: - description: Channel CID - title: Channel CID + chat_level: type: string x-stream-index: "001" - created_at: - description: Date/time of creation + disabled_until: format: date-time - title: Created at type: number - x-stream-index: "012" - created_by: - $ref: '#/components/schemas/UserResponse' - description: Created By User - title: User - x-stream-index: "006" - created_by_user_id: - description: Created By User ID - title: Created By User ID - type: string x-stream-index: "005" - custom: - additionalProperties: {} - description: Custom data for this object - title: Custom data - type: object - x-stream-index: "016" - deleted_at: - description: Deleted At - format: date-time - title: Deleted At - type: number - x-stream-index: "014" - last_message_at: - description: Last Message At - format: date-time - title: Last Message At - type: number - x-stream-index: "011" - parent_message: - $ref: '#/components/schemas/MessageResponse' - description: Parent Message - title: Message + feeds_events: + $ref: '#/components/schemas/FeedsEventPreferences' x-stream-index: "004" - parent_message_id: - description: Parent Message ID - title: Parent Message ID + feeds_level: type: string x-stream-index: "003" - participant_count: - description: Participant Count + type: object + Quality: + properties: + bitdepth: + format: int32 + type: integer + x-stream-index: "007" + framerate: format: int32 - title: Participant Count type: integer x-stream-index: "008" - reply_count: - description: Reply Count + height: format: int32 - title: Reply Count type: integer - x-stream-index: "007" - thread_participants: - description: Thread Participants + x-stream-index: "006" + name: + type: string + x-stream-index: "004" + video_bitrate: + format: int32 + type: integer + x-stream-index: "009" + width: + format: int32 + type: integer + x-stream-index: "005" + type: object + QualityScoreReport: + properties: + histogram: items: - $ref: '#/components/schemas/ThreadParticipant' - title: ThreadParticipants + $ref: '#/components/schemas/ReportByHistogramBucket' type: array - x-stream-index: "010" - title: - description: Title - title: Title - type: string - x-stream-index: "015" - updated_at: - description: Date/time of the last update - format: date-time - title: Updated at - type: number - x-stream-index: "013" + x-stream-index: "001" required: - - channel_cid - - parent_message_id - - created_by_user_id - - created_at - - updated_at - - title - - custom + - histogram type: object - ThreadStateResponse: + QualityScoreReportResponse: + properties: + daily: + items: + $ref: '#/components/schemas/DailyAggregateQualityScoreReportResponse' + type: array + x-stream-index: "001" + required: + - daily + type: object + QueryActivitiesRequest: nullable: true properties: - active_participant_count: - description: Active Participant Count + filter: + additionalProperties: {} + description: Filters to apply to the query. Supports location-based queries + with 'near' and 'within_bounds' operators. + title: Filter + type: object + x-stream-index: "001" + limit: format: int32 - title: Active Participant Count + maximum: 100 + minimum: 0 type: integer - x-stream-index: "001.009" - channel: - $ref: '#/components/schemas/ChannelResponse' - description: Channel - title: ChannelResponse - x-stream-index: "001.002" - channel_cid: - description: Channel CID - title: Channel CID + x-stream-index: "003.001" + next: type: string - x-stream-index: "001.001" - created_at: - description: Date/time of creation - format: date-time - title: Created at - type: number - x-stream-index: "001.012" - created_by: - $ref: '#/components/schemas/UserResponse' - description: Created By User - title: User - x-stream-index: "001.006" - created_by_user_id: - description: Created By User ID - title: Created By User ID + x-stream-index: "003.002" + prev: type: string - x-stream-index: "001.005" - custom: - additionalProperties: {} - description: Custom data for this object - title: Custom data - type: object - x-stream-index: "001.016" - deleted_at: - description: Deleted At - format: date-time - title: Deleted At - type: number - x-stream-index: "001.014" - draft: - $ref: '#/components/schemas/DraftResponse' - x-stream-index: "004" - last_message_at: - description: Last Message At - format: date-time - title: Last Message At - type: number - x-stream-index: "001.011" - latest_replies: + x-stream-index: "003.003" + sort: + description: Sorting parameters for the query items: - $ref: '#/components/schemas/MessageResponse' + $ref: '#/components/schemas/SortParamRequest' + maximum: 5 + title: Sort type: array x-stream-index: "002" - parent_message: - $ref: '#/components/schemas/MessageResponse' - description: Parent Message - title: Message - x-stream-index: "001.004" - parent_message_id: - description: Parent Message ID - title: Parent Message ID - type: string - x-stream-index: "001.003" - participant_count: - description: Participant Count - format: int32 - title: Participant Count - type: integer - x-stream-index: "001.008" - read: + title: Query Activities Request + type: object + QueryActivitiesResponse: + nullable: true + properties: + activities: + description: List of activities matching the query items: - $ref: '#/components/schemas/ReadStateResponse' + $ref: '#/components/schemas/ActivityResponse' + title: Activities type: array - x-stream-index: "003" - reply_count: - description: Reply Count + x-stream-index: "001" + duration: + type: string + x-stream-index: "003.001" + next: + description: Cursor for next page + title: Next + type: string + x-stream-index: "002.001" + prev: + description: Cursor for previous page + title: Previous + type: string + x-stream-index: "002.002" + required: + - activities + - duration + title: Query Activities Response + type: object + QueryActivityReactionsRequest: + nullable: true + properties: + filter: + additionalProperties: {} + type: object + x-stream-index: "002" + limit: format: int32 - title: Reply Count + maximum: 100 + minimum: 0 type: integer - x-stream-index: "001.007" - thread_participants: - description: Thread Participants + x-stream-index: "004.001" + next: + type: string + x-stream-index: "004.002" + prev: + type: string + x-stream-index: "004.003" + sort: items: - $ref: '#/components/schemas/ThreadParticipant' - title: ThreadParticipants + $ref: '#/components/schemas/SortParamRequest' + maximum: 5 type: array - x-stream-index: "001.010" - title: - description: Title - title: Title - type: string - x-stream-index: "001.015" - updated_at: - description: Date/time of the last update - format: date-time - title: Updated at - type: number - x-stream-index: "001.013" - required: - - channel_cid - - parent_message_id - - created_by_user_id - - created_at - - updated_at - - title - - custom - - latest_replies + x-stream-index: "003" type: object - ThreadUpdatedEvent: + QueryActivityReactionsResponse: + description: Basic response information + nullable: true properties: - channel_id: - type: string - x-stream-index: "001.002" - channel_type: - type: string - x-stream-index: "001.003" - cid: + duration: + description: Duration of the request in milliseconds + title: Duration type: string - x-stream-index: "001.001" - created_at: - format: date-time - type: number - x-stream-index: "004.002" - thread: - $ref: '#/components/schemas/ThreadResponse' x-stream-index: "003.001" - type: - default: thread.updated + next: type: string - x-stream-index: "004.001" - user: - $ref: '#/components/schemas/User' x-stream-index: "002.001" + prev: + type: string + x-stream-index: "002.002" + reactions: + items: + $ref: '#/components/schemas/FeedsReactionResponse' + type: array + x-stream-index: "001" required: - - cid - - channel_id - - channel_type - - type - - created_at - title: ThreadUpdatedEvent + - reactions + - duration + title: Response 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 - Thresholds: - description: Sets thresholds for AI moderation + QueryAggregateCallStatsRequest: + nullable: true properties: - explicit: - $ref: '#/components/schemas/LabelThresholds' - description: Thresholds for explicit messages - title: LabelThresholds - x-stream-index: "001" - spam: - $ref: '#/components/schemas/LabelThresholds' - description: Thresholds for spam - title: LabelThresholds + from: + type: string x-stream-index: "002" - toxic: - $ref: '#/components/schemas/LabelThresholds' - description: Thresholds for toxic messages - title: LabelThresholds + report_types: + items: + type: string + type: array + x-stream-index: "004" + to: + type: string x-stream-index: "003" - title: Auto moderation thresholds type: object - ThumbnailResponse: + QueryAggregateCallStatsResponse: + description: Basic response information + nullable: true properties: - image_url: + call_duration_report: + $ref: '#/components/schemas/CallDurationReportResponse' + x-stream-index: "002" + call_participant_count_report: + $ref: '#/components/schemas/CallParticipantCountReportResponse' + x-stream-index: "004" + calls_per_day_report: + $ref: '#/components/schemas/CallsPerDayReportResponse' + x-stream-index: "003" + duration: + description: Duration of the request in milliseconds + title: Duration type: string - x-stream-index: "001" + x-stream-index: "001.001" + network_metrics_report: + $ref: '#/components/schemas/NetworkMetricsReportResponse' + x-stream-index: "008" + quality_score_report: + $ref: '#/components/schemas/QualityScoreReportResponse' + x-stream-index: "005" + sdk_usage_report: + $ref: '#/components/schemas/SDKUsageReportResponse' + x-stream-index: "006" + user_feedback_report: + $ref: '#/components/schemas/UserFeedbackReportResponse' + x-stream-index: "007" required: - - image_url + - duration + title: Response type: object - ThumbnailsSettings: + QueryBannedUsersPayload: properties: - enabled: + exclude_expired_bans: + description: Whether to exclude expired bans or not + title: Exclude expired bans type: boolean + x-stream-index: "004" + filter_conditions: + additionalProperties: {} + type: object x-stream-index: "001" + limit: + description: Number of records to return + format: int32 + maximum: 300 + minimum: 0 + title: Limit + type: integer + x-stream-index: "003.003" + offset: + description: Number of records to offset + format: int32 + maximum: 10000 + title: Offset + type: integer + x-stream-index: "003.004" + sort: + description: Array of sort parameters + items: + $ref: '#/components/schemas/SortParamRequest' + maximum: 1 + title: Sort + type: array + x-stream-index: "002" required: - - enabled - type: object - ThumbnailsSettingsRequest: - properties: - enabled: - type: boolean - x-stream-index: "001" + - filter_conditions type: object - ThumbnailsSettingsResponse: + QueryBannedUsersResponse: + nullable: true properties: - enabled: - type: boolean + bans: + description: List of found bans + items: + $ref: '#/components/schemas/BanResponse' + title: BanResponse + type: array x-stream-index: "001" + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "002.001" required: - - enabled - type: object - Time: + - bans + - duration type: object - TrackStatsResponse: + QueryBookmarkFoldersRequest: nullable: true properties: - duration_seconds: + filter: + additionalProperties: {} + description: Filters to apply to the query + title: Filter + type: object + x-stream-index: "001" + limit: format: int32 + maximum: 100 + minimum: 0 type: integer - x-stream-index: "002" - track_type: + x-stream-index: "003.001" + next: + type: string + x-stream-index: "003.002" + prev: type: string + x-stream-index: "003.003" + sort: + description: Sorting parameters for the query + items: + $ref: '#/components/schemas/SortParamRequest' + title: Sort + type: array + x-stream-index: "002" + title: Query Bookmark Folders Request + type: object + QueryBookmarkFoldersResponse: + nullable: true + properties: + bookmark_folders: + description: List of bookmark folders matching the query + items: + $ref: '#/components/schemas/BookmarkFolderResponse' + title: Bookmark Folders + type: array x-stream-index: "001" + duration: + type: string + x-stream-index: "003.001" + next: + description: Cursor for next page + title: Next + type: string + x-stream-index: "002.001" + prev: + description: Cursor for previous page + title: Previous + type: string + x-stream-index: "002.002" required: - - track_type - - duration_seconds + - bookmark_folders + - duration + title: Query Bookmark Folders Response type: object - TranscriptionSettings: + QueryBookmarksRequest: + nullable: true properties: - closed_caption_mode: - enum: - - available - - disabled - - auto-on - title: Mode - type: string - x-stream-index: "002" - language: - description: The language used in this call as a two letter code - enum: - - auto - - en - - fr - - es - - de - - it - - nl - - pt - - pl - - ca - - cs - - da - - el - - fi - - id - - ja - - ru - - sv - - ta - - th - - tr - - hu - - ro - - zh - - ar - - tl - - he - - hi - - hr - - ko - - ms - - "no" - - uk - - bg - - et - - sl - - sk - title: Language + filter: + additionalProperties: {} + description: Filters to apply to the query + title: Filter + type: object + x-stream-index: "001" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "003.001" + next: type: string - x-stream-index: "004" - mode: - enum: - - available - - disabled - - auto-on - title: Mode + x-stream-index: "003.002" + prev: type: string + x-stream-index: "003.003" + sort: + description: Sorting parameters for the query + items: + $ref: '#/components/schemas/SortParamRequest' + maximum: 5 + title: Sort + type: array + x-stream-index: "002" + title: Query Bookmarks Request + type: object + QueryBookmarksResponse: + nullable: true + properties: + bookmarks: + description: List of bookmarks matching the query + items: + $ref: '#/components/schemas/BookmarkResponse' + title: Bookmarks + type: array x-stream-index: "001" + duration: + type: string + x-stream-index: "003.001" + next: + description: Cursor for next page + title: Next + type: string + x-stream-index: "002.001" + prev: + description: Cursor for previous page + title: Previous + type: string + x-stream-index: "002.002" required: - - mode - - closed_caption_mode - - languages - - language + - bookmarks + - duration + title: Query Bookmarks Response type: object - TranscriptionSettingsRequest: + QueryCallMembersRequest: + nullable: true properties: - closed_caption_mode: - enum: - - available - - disabled - - auto-on - type: string + filter_conditions: + additionalProperties: {} + type: object x-stream-index: "002" - language: - enum: - - auto - - en - - fr - - es - - de - - it - - nl - - pt - - pl - - ca - - cs - - da - - el - - fi - - id - - ja - - ru - - sv - - ta - - th - - tr - - hu - - ro - - zh - - ar - - tl - - he - - hi - - hr - - ko - - ms - - "no" - - uk - - bg - - et - - sl - - sk + id: + maxLength: 64 type: string - x-stream-index: "004" - mode: - enum: - - available - - disabled - - auto-on + x-stream-index: "001.002" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "004.001" + next: type: string - x-stream-index: "001" + x-stream-index: "004.002" + prev: + type: string + x-stream-index: "004.003" + sort: + items: + $ref: '#/components/schemas/SortParamRequest' + maximum: 1 + type: array + x-stream-index: "003" + type: + maxLength: 64 + type: string + x-stream-index: "001.001" required: - - mode + - type + - id type: object - TranscriptionSettingsResponse: + QueryCallMembersResponse: + description: Basic response information + nullable: true properties: - closed_caption_mode: - enum: - - available - - disabled - - auto-on + duration: + description: Duration of the request in milliseconds + title: Duration type: string - x-stream-index: "002" - language: - enum: - - auto - - en - - fr - - es - - de - - it - - nl - - pt - - pl - - ca - - cs - - da - - el - - fi - - id - - ja - - ru - - sv - - ta - - th - - tr - - hu - - ro - - zh - - ar - - tl - - he - - hi - - hr - - ko - - ms - - "no" - - uk - - bg - - et - - sl - - sk + x-stream-index: "003.001" + members: + items: + $ref: '#/components/schemas/MemberResponse' + type: array + x-stream-index: "001" + next: type: string - x-stream-index: "004" - mode: - enum: - - available - - disabled - - auto-on + x-stream-index: "002.001" + prev: type: string - x-stream-index: "001" + x-stream-index: "002.002" required: - - mode - - closed_caption_mode - - languages - - language + - members + - duration + title: Response type: object - TranslateMessageRequest: + QueryCallParticipantsRequest: nullable: true properties: - language: - description: Language to translate message to - enum: - - af - - sq - - am - - ar - - az - - bn - - bs - - bg - - zh - - zh-TW - - hr - - cs - - da - - fa-AF - - nl - - en - - et - - fi - - fr - - fr-CA - - ka - - de - - el - - ha - - he - - hi - - hu - - id - - it - - ja - - ko - - lv - - ms - - "no" - - fa - - ps - - pl - - pt - - ro - - ru - - sr - - sk - - sl - - so - - es - - es-MX - - sw - - sv - - tl - - ta - - th - - tr - - uk - - ur - - vi - - lt - - ht - title: Language + filter_conditions: + additionalProperties: {} + type: object + x-stream-index: "003" + type: object + QueryCallParticipantsResponse: + nullable: true + properties: + call: + $ref: '#/components/schemas/CallResponse' + x-stream-index: "001.001" + duration: type: string - x-stream-index: "001" + x-stream-index: "004.001" + members: + items: + $ref: '#/components/schemas/MemberResponse' + type: array + x-stream-index: "001.002" + membership: + $ref: '#/components/schemas/MemberResponse' + x-stream-index: "001.003" + own_capabilities: + items: + $ref: '#/components/schemas/OwnCapability' + type: array + x-stream-index: "001.004" + participants: + description: List of call participants + items: + $ref: '#/components/schemas/CallParticipantResponse' + title: '[]CallParticipantResponse' + type: array + x-stream-index: "002" + total_participants: + format: int32 + type: integer + x-stream-index: "003" required: - - language + - call + - members + - own_capabilities + - blocked_users + - participants + - total_participants + - duration type: object - TruncateChannelRequest: + QueryCallStatsRequest: nullable: true properties: - hard_delete: - description: Permanently delete channel data (messages, reactions, etc.) - title: Hard delete - type: boolean - x-stream-index: "002" - member_ids: - description: List of member IDs to hide message history for. If empty, truncates - the channel for all members - items: - type: string + filter_conditions: + additionalProperties: {} + type: object + x-stream-index: "001" + limit: + format: int32 maximum: 100 - title: Member IDs + minimum: 0 + type: integer + x-stream-index: "004.001" + next: + type: string + x-stream-index: "004.002" + prev: + type: string + x-stream-index: "004.003" + sort: + items: + $ref: '#/components/schemas/SortParamRequest' + maximum: 2 type: array - x-stream-index: "007" - message: - $ref: '#/components/schemas/MessageRequest' - x-stream-index: "004" - skip_push: - description: When `message` is set disables all push notifications for it - title: Skip push - type: boolean - x-stream-index: "005" - truncated_at: - description: Truncate channel data up to `truncated_at`. The system message - (if provided) creation time is always greater than `truncated_at` - format: date-time - title: Truncated at - type: number - x-stream-index: "006" + x-stream-index: "002" type: object - TruncateChannelResponse: + QueryCallStatsResponse: + description: Basic response information nullable: true properties: - channel: - $ref: '#/components/schemas/ChannelResponse' - description: Truncated channel object - title: Channel - x-stream-index: "002" duration: description: Duration of the request in milliseconds title: Duration type: string - x-stream-index: "001.001" - message: - $ref: '#/components/schemas/MessageResponse' - description: Truncated message object - title: Message - x-stream-index: "003" + x-stream-index: "002.001" + next: + type: string + x-stream-index: "003.001" + prev: + type: string + x-stream-index: "003.002" + reports: + items: + $ref: '#/components/schemas/CallStatsReportSummaryResponse' + type: array + x-stream-index: "001" required: + - reports - duration + title: Response type: object - TypingIndicators: + QueryCallsRequest: + nullable: true properties: - enabled: + filter_conditions: + additionalProperties: {} + title: Filters + type: object + x-stream-index: "003" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "006.001" + next: + type: string + x-stream-index: "006.002" + prev: + type: string + x-stream-index: "006.003" + sort: + description: Array of sort parameters + items: + $ref: '#/components/schemas/SortParamRequest' + maximum: 2 + title: Sort + type: array + x-stream-index: "004" + watch: + title: Watch type: boolean x-stream-index: "001" - required: - - enabled + title: QueryCallsRequest type: object - TypingIndicatorsResponse: + QueryCallsResponse: + nullable: true properties: - enabled: - type: boolean + calls: + items: + $ref: '#/components/schemas/CallStateResponseFields' + title: Calls + type: array x-stream-index: "001" - required: - - enabled - type: object - TypingStartEvent: - properties: - channel_id: - type: string - x-stream-index: "003.002" - channel_type: - type: string - x-stream-index: "003.003" - cid: + duration: + description: Duration of the request in milliseconds + title: Duration type: string x-stream-index: "003.001" - created_at: - format: date-time - type: number - x-stream-index: "004.002" - parent_id: - type: string - x-stream-index: "001" - type: - default: typing.start + next: type: string - x-stream-index: "004.001" - user: - $ref: '#/components/schemas/User' x-stream-index: "002.001" - required: - - cid - - channel_id - - channel_type - - type - - created_at - title: TypingStartEvent - 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 - TypingStopEvent: - properties: - channel_id: + prev: type: string x-stream-index: "002.002" - channel_type: - type: string - x-stream-index: "002.003" - cid: - type: string - x-stream-index: "002.001" - created_at: - format: date-time - type: number - x-stream-index: "004.002" - parent_id: - type: string - x-stream-index: "001" - type: - default: typing.stop - type: string - x-stream-index: "004.001" - user: - $ref: '#/components/schemas/User' - x-stream-index: "003.001" - required: - - cid - - channel_id - - channel_type - - type - - created_at - title: TypingStopEvent - 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 - UnbanActionRequest: - type: object - UnblockActionRequest: - type: object - UnblockUserRequest: - description: UnblockUserRequest is the payload for unblocking a user. - nullable: true - properties: - user_id: - description: the user to unblock - title: UserID - type: string - x-stream-index: "003" - required: - - user_id - title: UnblockUserRequest - type: object - UnblockUserResponse: - description: UnblockUserResponse is the payload for unblocking a user. - nullable: true - properties: - duration: - description: Duration of the request in milliseconds - title: Duration - type: string - x-stream-index: "001.001" required: + - calls - duration - title: UnblockUserResponse + title: QueryCallsResponse type: object - UnblockUsersRequest: + QueryChannelsRequest: nullable: true properties: - blocked_user_id: - type: string + filter_conditions: + additionalProperties: {} + type: object x-stream-index: "001" - required: - - blocked_user_id + limit: + description: Number of channels to limit + format: int32 + title: Limit + type: integer + x-stream-index: "008" + member_limit: + description: Number of members to limit + format: int32 + maximum: 100 + minimum: 0 + title: Member limit + type: integer + x-stream-index: "007" + message_limit: + description: Number of messages to limit + format: int32 + minimum: 0 + title: Message limit + type: integer + x-stream-index: "006" + offset: + description: Channel pagination offset + format: int32 + title: Offset + type: integer + x-stream-index: "009" + presence: + title: Presence + type: boolean + x-stream-index: "005" + sort: + description: List of sort parameters + items: + $ref: '#/components/schemas/SortParamRequest' + maximum: 5 + title: Sort + type: array + x-stream-index: "002" + state: + description: Whether to update channel state or not + title: State + type: boolean + x-stream-index: "004" + watch: + description: Whether to start watching found channels or not + title: Watch + type: boolean + x-stream-index: "003" + title: Query Channels Request type: object - UnblockUsersResponse: + x-stream-docs-page-id: query_channels + QueryChannelsResponse: nullable: true properties: + channels: + description: List of channels + items: + $ref: '#/components/schemas/ChannelStateResponseFields' + title: Channels + type: array + x-stream-index: "001" duration: description: Duration of the request in milliseconds title: Duration type: string - x-stream-index: "001.001" + x-stream-index: "002.001" required: + - channels - duration + title: Channels list type: object - UnblockedUserEvent: - description: |- - This event is sent when a user is unblocked on a call, - this can be useful to notify the user that they can now join the call again + QueryCommentReactionsRequest: + nullable: true properties: - call_cid: + filter: + additionalProperties: {} + type: object + x-stream-index: "002" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "004.001" + next: type: string - x-stream-index: "002.001" - created_at: - format: date-time - type: number - x-stream-index: "001.002" - type: - default: call.unblocked_user - description: 'The type of event: "call.unblocked_user" in this case' - title: Event Type + x-stream-index: "004.002" + prev: type: string - x-stream-index: "001.001" - user: - $ref: '#/components/schemas/UserResponse' - description: The user that was unblocked - title: User - x-stream-index: "003" - required: - - type - - created_at - - call_cid - - user - title: UnblockedUserEvent - type: object - x-stream-event-call-type: true - x-stream-event-doc-group: call - x-stream-is-event: true - x-stream-ws-base-event-name: VideoEvent - UnmuteChannelRequest: - nullable: true - properties: - channel_cids: - description: Channel CIDs to mute (if multiple channels) + x-stream-index: "004.003" + sort: items: - type: string - maximum: 25 - title: Channel CIDs + $ref: '#/components/schemas/SortParamRequest' + maximum: 5 type: array - x-stream-index: "001.002" - expiration: - description: Duration of mute in milliseconds - title: Expiration - type: integer - x-stream-index: "001.003" + x-stream-index: "003" type: object - UnmuteResponse: + QueryCommentReactionsResponse: description: Basic response information nullable: true properties: duration: description: Duration of the request in milliseconds title: Duration + type: string + x-stream-index: "003.001" + next: type: string x-stream-index: "002.001" - non_existing_users: + prev: + type: string + x-stream-index: "002.002" + reactions: items: - type: string + $ref: '#/components/schemas/FeedsReactionResponse' type: array x-stream-index: "001" required: + - reactions - duration title: Response type: object - UnpinRequest: - description: UnpinRequest is the payload for unpinning a message. + QueryCommentsRequest: nullable: true properties: - session_id: - description: the session ID of the user who pinned the message - title: SessionID + filter: + additionalProperties: {} + description: MongoDB-style filter for querying comments + title: Filter + type: object + x-stream-index: "001" + limit: + description: Maximum number of comments to return + format: int32 + maximum: 100 + minimum: 0 + title: Limit + type: integer + x-stream-index: "003.001" + next: type: string - x-stream-index: "003" - user_id: - description: the user ID of the user who pinned the message - title: UserID + x-stream-index: "003.002" + prev: + type: string + x-stream-index: "003.003" + sort: + description: first (oldest), last (newest) or top + enum: + - first + - last + - top + - best + - controversial + title: Sort Order type: string x-stream-index: "002" required: - - user_id - - session_id - title: UnpinRequest + - filter + title: Query Comments Request type: object - UnpinResponse: - description: UnpinResponse is the payload for unpinning a message. + QueryCommentsResponse: nullable: true properties: + comments: + description: List of comments matching the query + items: + $ref: '#/components/schemas/CommentResponse' + title: Comments + type: array + x-stream-index: "001" duration: - description: Duration of the request in milliseconds - title: Duration type: string - x-stream-index: "001.001" - required: - - duration - title: UnpinResponse - type: object - UnreadCountsChannel: - properties: - channel_id: + x-stream-index: "003.001" + next: + description: Cursor for next page + title: Next type: string - x-stream-index: "001" - last_read: - format: date-time - type: number - x-stream-index: "003" - unread_count: - format: int32 - type: integer - x-stream-index: "002" + x-stream-index: "002.001" + prev: + description: Cursor for previous page + title: Previous + type: string + x-stream-index: "002.002" required: - - channel_id - - unread_count - - last_read + - comments + - duration + title: Query Comments Response type: object - UnreadCountsChannelType: + QueryDraftsRequest: + nullable: true properties: - channel_count: - format: int32 - type: integer - x-stream-index: "002" - channel_type: - type: string + filter: + additionalProperties: {} + description: Filter to apply to the query + maximum: 3 + title: Filter + type: object x-stream-index: "001" - unread_count: + limit: format: int32 + maximum: 100 + minimum: 0 type: integer - x-stream-index: "003" - required: - - channel_type - - channel_count - - unread_count - type: object - UnreadCountsThread: - properties: - last_read: - format: date-time - type: number - x-stream-index: "002" - last_read_message_id: - type: string - x-stream-index: "003" - parent_message_id: + x-stream-index: "005.001" + next: type: string - x-stream-index: "004" - unread_count: - format: int32 - type: integer - x-stream-index: "001" - required: - - unread_count - - last_read - - last_read_message_id - - parent_message_id - type: object - UpdateBlockListRequest: - nullable: true - properties: - team: + x-stream-index: "005.002" + prev: type: string - x-stream-index: "002" - words: - description: List of words to block + x-stream-index: "005.003" + sort: + description: Array of sort parameters items: - type: string - minimum: 1 - title: Words + $ref: '#/components/schemas/SortParamRequest' + maximum: 5 + title: Sort type: array - x-stream-index: "003" - title: Update block list + x-stream-index: "002" type: object - x-stream-docs-page-id: update_block_list - UpdateBlockListResponse: - description: Basic response information + QueryDraftsResponse: nullable: true properties: - blocklist: - $ref: '#/components/schemas/BlockListResponse' + drafts: + description: Drafts + items: + $ref: '#/components/schemas/DraftResponse' + title: DraftsResponseList + type: array x-stream-index: "001" duration: description: Duration of the request in milliseconds title: Duration + type: string + x-stream-index: "003.001" + next: type: string x-stream-index: "002.001" + prev: + type: string + x-stream-index: "002.002" required: + - drafts - duration - title: Response type: object - UpdateCallMembersRequest: - description: Update call members + QueryFeedMembersRequest: nullable: true properties: - remove_members: - description: List of userID to remove - items: - type: string - maximum: 100 - title: Remove Members - type: array + filter: + additionalProperties: {} + description: Filter parameters for the query + title: object + type: object x-stream-index: "003" - update_members: - description: List of members to update or insert - items: - $ref: '#/components/schemas/MemberRequest' + limit: + format: int32 maximum: 100 - title: Update Members + minimum: 0 + type: integer + x-stream-index: "005.001" + next: + type: string + x-stream-index: "005.002" + prev: + type: string + x-stream-index: "005.003" + sort: + description: Sort parameters for the query + items: + $ref: '#/components/schemas/SortParamRequest' + maximum: 5 + title: array type: array x-stream-index: "004" - title: UpdateCallMembersRequest type: object - UpdateCallMembersResponse: - description: Basic response information + QueryFeedMembersResponse: nullable: true properties: duration: - description: Duration of the request in milliseconds - title: Duration type: string - x-stream-index: "001.001" + x-stream-index: "003.001" members: + description: List of feed members items: - $ref: '#/components/schemas/MemberResponse' + $ref: '#/components/schemas/FeedMemberResponse' + title: array type: array - x-stream-index: "002" + x-stream-index: "001" + next: + description: Cursor for next page + title: Next + type: string + x-stream-index: "002.001" + prev: + description: Cursor for previous page + title: Previous + type: string + x-stream-index: "002.002" required: - - duration - members - title: Response + - duration type: object - UpdateCallRequest: - description: Request for updating a call + QueryFeedsRequest: nullable: true properties: - custom: + filter: additionalProperties: {} - description: Custom data for this object - title: Custom data + description: Filters to apply to the query + title: Filter type: object + x-stream-index: "001" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "004.001" + next: + type: string + x-stream-index: "004.002" + prev: + type: string + x-stream-index: "004.003" + sort: + description: Sorting parameters for the query + items: + $ref: '#/components/schemas/SortParamRequest' + maximum: 5 + title: Sort + type: array x-stream-index: "003" - settings_override: - $ref: '#/components/schemas/CallSettingsRequest' - description: the settings to change for this call - title: Settings Override - x-stream-index: "004" - starts_at: - description: the time the call is scheduled to start - format: date-time - title: Starts At - type: number - x-stream-index: "005" - title: UpdateCallRequest + watch: + description: Whether to subscribe to realtime updates + title: Watch + type: boolean + x-stream-index: "002" + title: Query Feeds Request type: object - UpdateCallResponse: - description: Response for updating a call + QueryFeedsResponse: nullable: true properties: - call: - $ref: '#/components/schemas/CallResponse' - x-stream-index: "001.001" duration: type: string - x-stream-index: "002.001" - members: - items: - $ref: '#/components/schemas/MemberResponse' - type: array - x-stream-index: "001.002" - membership: - $ref: '#/components/schemas/MemberResponse' - x-stream-index: "001.003" - own_capabilities: + x-stream-index: "003.001" + feeds: + description: List of feeds matching the query items: - $ref: '#/components/schemas/OwnCapability' + $ref: '#/components/schemas/FeedResponse' + title: Feeds type: array - x-stream-index: "001.004" + x-stream-index: "001" + next: + description: Cursor for next page + title: Next + type: string + x-stream-index: "002.001" + prev: + description: Cursor for previous page + title: Previous + type: string + x-stream-index: "002.002" required: - - call - - members - - own_capabilities - - blocked_users + - feeds - duration - title: UpdateCallResponse + title: Query Feeds Response type: object - UpdateChannelPartialRequest: + QueryFollowsRequest: nullable: true properties: - set: + filter: additionalProperties: {} + description: Filters to apply to the query + title: Filter type: object - x-stream-index: "002.001" - unset: + x-stream-index: "001" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "003.001" + next: + type: string + x-stream-index: "003.002" + prev: + type: string + x-stream-index: "003.003" + sort: + description: Sorting parameters for the query items: - type: string + $ref: '#/components/schemas/SortParamRequest' + maximum: 5 + title: Sort type: array - x-stream-index: "002.002" - title: UpdateChannelPartialRequest + x-stream-index: "002" + title: Query Follows Request type: object - UpdateChannelPartialResponse: + QueryFollowsResponse: nullable: true properties: - channel: - $ref: '#/components/schemas/ChannelResponse' - description: Updated channel object - title: Channel - x-stream-index: "001" duration: - description: Duration of the request in milliseconds - title: Duration type: string x-stream-index: "003.001" - members: - description: List of updated members + follows: + description: List of follow relationships matching the query items: - $ref: '#/components/schemas/ChannelMemberResponse' - title: ChannelMemberResponse + $ref: '#/components/schemas/FollowResponse' + title: Follows type: array - x-stream-index: "002" + x-stream-index: "001" + next: + description: Cursor for next page + title: Next + type: string + x-stream-index: "002.001" + prev: + description: Cursor for previous page + title: Previous + type: string + x-stream-index: "002.002" required: - - members + - follows - duration + title: Query Follows Response type: object - UpdateChannelRequest: - nullable: true + QueryMembersPayload: + description: Client request properties: - accept_invite: - description: Set to `true` to accept the invite - title: Accept invite - type: boolean - x-stream-index: "008" - add_members: - description: List of user IDs to add to the channel + filter_conditions: + additionalProperties: {} + type: object + x-stream-index: "004" + id: + type: string + x-stream-index: "002" + limit: + format: int32 + maximum: 300 + minimum: 0 + type: integer + x-stream-index: "006.003" + members: items: $ref: '#/components/schemas/ChannelMember' maximum: 100 - title: Add members - type: array - x-stream-index: "001" - add_moderators: - description: List of user IDs to make channel moderators - items: - type: string - maximum: 100 - title: Add moderators type: array x-stream-index: "003" - assign_roles: - description: List of channel member role assignments. If any specified user - is not part of the channel, the request will fail - items: - $ref: '#/components/schemas/ChannelMember' - maximum: 100 - title: Assign roles - type: array - x-stream-index: "006" - cooldown: - description: Sets cool down period for the channel in seconds + offset: format: int32 - maximum: 120 - minimum: 0 - title: Cool down + maximum: 10000 type: integer - x-stream-index: "007" - data: - $ref: '#/components/schemas/ChannelInput' - x-stream-index: "013.001" - demote_moderators: - description: List of user IDs to take away moderators status from - items: - type: string - maximum: 100 - title: Demote moderators - type: array - x-stream-index: "004" - hide_history: - description: Set to `true` to hide channel's history when adding new members - title: Hide history - type: boolean - x-stream-index: "012" - invites: - description: List of user IDs to invite to the channel + x-stream-index: "006.004" + sort: items: - $ref: '#/components/schemas/ChannelMember' - maximum: 100 - title: Invites + $ref: '#/components/schemas/SortParamRequest' + maximum: 1 type: array x-stream-index: "005" - message: - $ref: '#/components/schemas/MessageRequest' - description: Message to send to the chat when channel is successfully updated - title: Message - x-stream-index: "010" - reject_invite: - description: Set to `true` to reject the invite - title: Reject invite + type: + maxLength: 64 + type: string + x-stream-index: "001" + required: + - type + - filter_conditions + title: ClientRequest + type: object + QueryMessageFlagsPayload: + properties: + filter_conditions: + additionalProperties: {} + type: object + x-stream-index: "001" + limit: + format: int32 + maximum: 300 + minimum: 0 + type: integer + x-stream-index: "003.003" + offset: + format: int32 + maximum: 10000 + type: integer + x-stream-index: "003.004" + show_deleted_messages: + description: Whether to include deleted messages in the results + title: ShowDeletedMessages type: boolean - x-stream-index: "009" - remove_members: - description: List of user IDs to remove from the channel + x-stream-index: "002" + sort: items: - type: string - maximum: 100 - title: Remove members + $ref: '#/components/schemas/SortParamRequest' + maximum: 5 type: array - x-stream-index: "002" - skip_push: - description: When `message` is set disables all push notifications for it - title: Skip push - type: boolean - x-stream-index: "011" - title: Channel update request + x-stream-index: "003.005" type: object - x-stream-docs-page-id: channel_update - UpdateChannelResponse: + QueryMessageFlagsResponse: + description: Query message flags response nullable: true properties: - channel: - $ref: '#/components/schemas/ChannelResponse' - description: Updated channel - title: Channel - x-stream-index: "001" duration: description: Duration of the request in milliseconds title: Duration type: string - x-stream-index: "004.001" - members: - description: List of channel members + x-stream-index: "002.001" + flags: + description: The flags that match the query items: - $ref: '#/components/schemas/ChannelMember' - title: Members + $ref: '#/components/schemas/MessageFlagResponse' + title: MessageFlagResponseList type: array - x-stream-index: "003" - message: - $ref: '#/components/schemas/MessageResponse' - description: Message sent to the chat - title: Message - x-stream-index: "002" - required: - - members - - duration - type: object - UpdateLiveLocationRequest: - nullable: true - properties: - end_at: - description: Time when the live location expires - format: date-time - title: string - type: number - x-stream-index: "004" - latitude: - description: Latitude coordinate - format: float - maximum: 90 - minimum: 1.8446744073709552e+19 - title: number - type: number - x-stream-index: "002" - longitude: - description: Longitude coordinate - format: float - maximum: 180 - minimum: 1.8446744073709552e+19 - title: number - type: number - x-stream-index: "003" - message_id: - description: Live location ID - title: string - type: string x-stream-index: "001" required: - - message_id + - flags + - duration + title: QueryMessageFlagsResponse type: object - UpdateMemberPartialRequest: + QueryModerationConfigsRequest: nullable: true properties: - set: + filter: additionalProperties: {} + description: Filter conditions for moderation configs + title: Filter type: object - x-stream-index: "002.001" - unset: - items: - type: string - type: array - x-stream-index: "002.002" - type: object - UpdateMemberPartialResponse: - nullable: true - properties: - channel_member: - $ref: '#/components/schemas/ChannelMemberResponse' - description: Updated channel member - title: Channel member + x-stream-index: "001" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "003.001" + next: + type: string + x-stream-index: "003.002" + prev: + type: string + x-stream-index: "003.003" + sort: + description: Sorting parameters for the results + items: + $ref: '#/components/schemas/SortParamRequest' + title: Sort + type: array + x-stream-index: "002" + type: object + QueryModerationConfigsResponse: + nullable: true + properties: + configs: + description: List of moderation configurations + items: + $ref: '#/components/schemas/ConfigResponse' + title: Configs + type: array x-stream-index: "001" duration: - description: Duration of the request in milliseconds - title: Duration + type: string + x-stream-index: "003.001" + next: type: string x-stream-index: "002.001" + prev: + type: string + x-stream-index: "002.002" required: + - configs - duration type: object - UpdateMessagePartialRequest: + QueryPollVotesRequest: nullable: true properties: - set: + filter: additionalProperties: {} - description: Sets new field values - title: Set + description: Filter to apply to the query + title: Filter type: object - x-stream-index: "002.001" - x-stream-map: - description: New value to set - key: field - title: Value - skip_enrich_url: - description: Skip enriching the URL in the message - title: SkipEnrichURL - type: boolean - x-stream-index: "001" - unset: - description: Array of field names to unset + x-stream-index: "003" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "005.001" + next: + type: string + x-stream-index: "005.002" + prev: + type: string + x-stream-index: "005.003" + sort: + description: Array of sort parameters items: - type: string - title: Unset + $ref: '#/components/schemas/SortParamRequest' + maximum: 5 + title: Sort type: array - x-stream-index: "002.002" + x-stream-index: "004" type: object - UpdateMessagePartialResponse: + QueryPollsRequest: + nullable: true + properties: + filter: + additionalProperties: {} + description: Filter to apply to the query + title: Filter + type: object + x-stream-index: "002" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "005.001" + next: + type: string + x-stream-index: "005.002" + prev: + type: string + x-stream-index: "005.003" + sort: + description: Array of sort parameters + items: + $ref: '#/components/schemas/SortParamRequest' + maximum: 5 + title: Sort + type: array + x-stream-index: "003" + type: object + QueryPollsResponse: nullable: true properties: duration: @@ -19038,538 +19666,516 @@ components: title: Duration type: string x-stream-index: "003.001" - message: - $ref: '#/components/schemas/MessageResponse' - description: Updated message - title: Message + next: + type: string + x-stream-index: "002.001" + polls: + description: Polls data returned by the query + items: + $ref: '#/components/schemas/PollResponseData' + title: PollsResponseData + type: array x-stream-index: "001" - pending_message_metadata: - additionalProperties: - type: string - description: Pending message metadata - title: PendingMessageMetadata - type: object - x-stream-index: "002" + prev: + type: string + x-stream-index: "002.002" required: + - polls - duration type: object - UpdateMessageRequest: - nullable: true + QueryReactionsRequest: properties: - message: - $ref: '#/components/schemas/MessageRequest' - description: Message - title: MessageRequest - x-stream-index: "001" - skip_enrich_url: - description: Skip enrich URL - title: boolean - type: boolean - x-stream-index: "003" - skip_push: - type: boolean + filter: + additionalProperties: {} + type: object x-stream-index: "002" - required: - - message + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "006.001" + next: + type: string + x-stream-index: "006.002" + prev: + type: string + x-stream-index: "006.003" + sort: + items: + $ref: '#/components/schemas/SortParamRequest' + maximum: 2 + type: array + x-stream-index: "003" type: object - UpdateMessageResponse: + QueryReactionsResponse: description: Basic response information - nullable: true properties: duration: description: Duration of the request in milliseconds title: Duration + type: string + x-stream-index: "002.001" + next: type: string x-stream-index: "003.001" - message: - $ref: '#/components/schemas/MessageResponse' + prev: + type: string + x-stream-index: "003.002" + reactions: + items: + $ref: '#/components/schemas/ReactionResponse' + type: array x-stream-index: "001" - pending_message_metadata: - additionalProperties: - type: string - type: object - x-stream-index: "002" required: - - message + - reactions - duration title: Response type: object - UpdatePollOptionRequest: + QueryRemindersRequest: nullable: true properties: - Custom: + filter: additionalProperties: {} + description: Filter to apply to the query + title: Filter type: object - writeOnly: true - x-stream-index: "004" - id: - description: Option ID - maxLength: 255 - title: string + x-stream-index: "001" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "005.001" + next: type: string - x-stream-index: "002" - text: - description: Option text - title: string + x-stream-index: "005.002" + prev: type: string - x-stream-index: "003" - required: - - id - - text + x-stream-index: "005.003" + sort: + description: Array of sort parameters + items: + $ref: '#/components/schemas/SortParamRequest' + maximum: 5 + title: Sort + type: array + x-stream-index: "002" type: object - UpdatePollPartialRequest: + QueryRemindersResponse: nullable: true properties: - set: - additionalProperties: {} - description: Sets new field values - title: Set - type: object + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "003.001" + next: + type: string x-stream-index: "002.001" - x-stream-map: - description: New value to set - key: field - title: Value - unset: - description: Array of field names to unset + prev: + type: string + x-stream-index: "002.002" + reminders: + description: MessageReminders data returned by the query items: - type: string - title: Unset + $ref: '#/components/schemas/ReminderResponseData' + title: RemindersResponseData type: array - x-stream-index: "002.002" + x-stream-index: "001" + required: + - reminders + - duration type: object - UpdatePollRequest: + QueryReviewQueueRequest: nullable: true properties: - Custom: + filter: additionalProperties: {} + description: Filter conditions for review queue items + title: Filter type: object - writeOnly: true - x-stream-index: "011" - allow_answers: - description: Allow answers - title: boolean - type: boolean - x-stream-index: "009" - allow_user_suggested_options: - description: Allow user suggested options - title: boolean - type: boolean - x-stream-index: "008" - description: - description: Poll description - title: string - type: string - x-stream-index: "003" - enforce_unique_vote: - description: Enforce unique vote - title: boolean - type: boolean - x-stream-index: "005" - id: - description: Poll ID - maxLength: 255 - title: string - type: string x-stream-index: "001" - is_closed: - description: Is closed - title: boolean - type: boolean - x-stream-index: "010" - max_votes_allowed: - description: Max votes allowed + limit: format: int32 - maximum: 10 - title: integer + maximum: 100 + minimum: 0 type: integer - x-stream-index: "007" - name: - description: Poll name - title: string + x-stream-index: "007.001" + lock_count: + description: Number of items to lock (1-25) + format: int32 + maximum: 25 + minimum: 1 + title: Lock Count + type: integer + x-stream-index: "005" + lock_duration: + description: Duration for which items should be locked + title: Lock Duration + type: integer + x-stream-index: "004" + lock_items: + description: Whether to lock items for review (true), unlock items (false), + or just fetch (nil) + title: Lock Items + type: boolean + x-stream-index: "003" + next: type: string - x-stream-index: "002" - options: - description: Poll options + x-stream-index: "007.002" + prev: + type: string + x-stream-index: "007.003" + sort: + description: Sorting parameters for the results items: - $ref: '#/components/schemas/PollOptionRequest' - maximum: 100 - title: PollOptions + $ref: '#/components/schemas/SortParamRequest' + title: Sort type: array - x-stream-index: "004" - voting_visibility: - description: Voting visibility - enum: - - anonymous - - public - title: string - type: string + x-stream-index: "002" + stats_only: + description: Whether to return only statistics + title: Stats Only + type: boolean x-stream-index: "006" - required: - - id - - name - type: object - UpdateReminderRequest: - nullable: true - properties: - remind_at: - format: date-time - type: number - x-stream-index: "001" type: object - UpdateReminderResponse: - description: Basic response information + QueryReviewQueueResponse: nullable: true properties: + action_config: + additionalProperties: + items: + $ref: '#/components/schemas/ModerationActionConfig' + type: array + description: Configuration for moderation actions + title: Action Config + type: object + x-stream-index: "002" duration: - description: Duration of the request in milliseconds - title: Duration type: string - x-stream-index: "002.001" - reminder: - $ref: '#/components/schemas/ReminderResponseData' + x-stream-index: "005.001" + items: + description: List of review queue items + items: + $ref: '#/components/schemas/ReviewQueueItemResponse' + title: Items + type: array x-stream-index: "001" + next: + type: string + x-stream-index: "004.001" + prev: + type: string + x-stream-index: "004.002" + stats: + additionalProperties: {} + description: Statistics about the review queue + title: Stats + type: object + x-stream-index: "003" required: - - reminder + - items + - action_config + - stats - duration - title: Response type: object - UpdateThreadPartialRequest: + QueryThreadsRequest: nullable: true properties: - set: + filter: additionalProperties: {} - description: Sets new field values - title: Set + description: Filter conditions to apply to threads + title: Filter type: object - x-stream-index: "004.001" - x-stream-map: - description: New value to set - key: field - title: Value - unset: - description: Array of field names to unset + x-stream-index: "006" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "008.001" + member_limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "005" + next: + type: string + x-stream-index: "008.002" + participant_limit: + description: Limit the number of participants returned per each thread + format: int32 + maximum: 100 + minimum: 0 + title: Participant limit + type: integer + x-stream-index: "004" + prev: + type: string + x-stream-index: "008.003" + reply_limit: + description: Limit the number of replies returned per each thread + format: int32 + maximum: 10 + minimum: 0 + title: Reply limit + type: integer + x-stream-index: "003" + sort: + description: Sort conditions to apply to threads items: - type: string - title: Unset + $ref: '#/components/schemas/SortParamRequest' + maximum: 5 + title: Sort type: array - x-stream-index: "004.002" + x-stream-index: "007" + watch: + description: Start watching the channel this thread belongs to + title: Watch + type: boolean + x-stream-index: "001" type: object - UpdateThreadPartialResponse: + QueryThreadsResponse: nullable: true properties: duration: description: Duration of the request in milliseconds title: Duration + type: string + x-stream-index: "003.001" + next: type: string x-stream-index: "002.001" - thread: - $ref: '#/components/schemas/ThreadResponse' - description: Updated thread (not enriched) - title: Thread + prev: + type: string + x-stream-index: "002.002" + threads: + description: List of enriched thread states + items: + $ref: '#/components/schemas/ThreadStateResponse' + title: Threads + type: array x-stream-index: "001" required: - - thread + - threads - duration type: object - UpdateUserPartialRequest: + QueryUsersPayload: properties: - id: - description: User ID to update - title: ID - type: string - x-stream-index: "001" - set: + filter_conditions: additionalProperties: {} type: object - x-stream-index: "002.001" - unset: - items: - type: string - type: array - x-stream-index: "002.002" - required: - - id - type: object - UpdateUserPermissionsRequest: - nullable: true - properties: - grant_permissions: + x-stream-index: "001" + include_deactivated_users: + type: boolean + x-stream-index: "004" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "005.003" + offset: + format: int32 + maximum: 1000 + type: integer + x-stream-index: "005.004" + presence: + type: boolean + x-stream-index: "003" + sort: items: - type: string + $ref: '#/components/schemas/SortParamRequest' + maximum: 5 type: array x-stream-index: "002" - revoke_permissions: - items: - type: string - type: array - x-stream-index: "003" - user_id: - type: string - x-stream-index: "001" required: - - user_id + - filter_conditions type: object - UpdateUserPermissionsResponse: - description: Basic response information + QueryUsersResponse: 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 - UpdateUsersPartialRequest: - nullable: true - properties: + x-stream-index: "002.001" users: + description: Array of users as result of filters applied. items: - $ref: '#/components/schemas/UpdateUserPartialRequest' - maximum: 100 + $ref: '#/components/schemas/FullUserResponse' + title: Users type: array x-stream-index: "001" required: - users + - duration type: object - UpdateUsersRequest: - nullable: true + RTMPBroadcastRequest: + description: RTMPBroadcastRequest is the payload for starting an RTMP broadcast. properties: - users: - additionalProperties: - $ref: '#/components/schemas/UserRequest' - description: Object containing users - title: Users - type: object + layout: + $ref: '#/components/schemas/LayoutSettingsRequest' + description: If provided, will override the call's RTMP settings layout + title: Layout + x-stream-index: "005" + name: + description: Name identifier for RTMP broadcast, must be unique in call + maxLength: 255 + title: Name + type: string x-stream-index: "001" - x-stream-map: - key: user_id + quality: + description: If provided, will override the call's RTMP settings quality + enum: + - 360p + - 480p + - 720p + - 1080p + - 1440p + - portrait-360x640 + - portrait-480x854 + - portrait-720x1280 + - portrait-1080x1920 + - portrait-1440x2560 + title: Quality + type: string + x-stream-index: "004" + stream_key: + description: If provided, will be appended at the end of stream_url + title: Stream Key + type: string + x-stream-index: "003" + stream_url: + description: URL for the RTMP server to send the call to + maxLength: 255 + title: Stream URL + type: string + x-stream-index: "002" required: - - users + - name + - stream_url + title: RTMPBroadcastRequest type: object - UpdateUsersResponse: - nullable: true + RTMPEgressConfig: properties: - duration: - description: Duration of the request in milliseconds - title: Duration + composite_app_settings: + $ref: '#/components/schemas/CompositeAppSettings' + x-stream-index: "005" + quality: + $ref: '#/components/schemas/Quality' + x-stream-index: "004" + rtmp_location: type: string - x-stream-index: "003.001" - membership_deletion_task_id: + x-stream-index: "006" + type: object + RTMPIngress: + description: RTMP input settings + properties: + address: + title: Address type: string - x-stream-index: "002" - users: - additionalProperties: - $ref: '#/components/schemas/FullUserResponse' - description: Object containing users - title: Users - type: object x-stream-index: "001" - x-stream-map: - key: user_id required: - - users - - membership_deletion_task_id - - duration + - address + title: RTMPIngress type: object - UpdatedCallPermissionsEvent: - description: This event is sent to notify about permission changes for a user, - clients receiving this event should update their UI accordingly + RTMPLocation: properties: - call_cid: + name: type: string - x-stream-index: "002.001" - created_at: - format: date-time - type: number - x-stream-index: "001.002" - own_capabilities: - description: The capabilities of the current user - items: - $ref: '#/components/schemas/OwnCapability' - title: Own capabilities - type: array - x-stream-index: "004" - type: - default: call.permissions_updated - description: 'The type of event: "call.permissions_updated" in this case' - title: Event Type + x-stream-index: "001" + stream_key: type: string - x-stream-index: "001.001" - user: - $ref: '#/components/schemas/UserResponse' - description: The user who received the new permissions - title: User x-stream-index: "003" + stream_url: + type: string + x-stream-index: "002" required: - - type - - created_at - - call_cid - - user - - own_capabilities - title: UpdatedCallPermissionsEvent + - name + - stream_url + - stream_key type: object - x-stream-event-call-type: true - x-stream-event-doc-group: call - x-stream-is-event: true - x-stream-ws-base-event-name: VideoEvent - UpsertConfigRequest: - nullable: true + RTMPSettings: properties: - ai_image_config: - $ref: '#/components/schemas/AIImageConfig' - description: Configuration for AI image analysis - title: AI Image Config - x-stream-index: "010" - ai_text_config: - $ref: '#/components/schemas/AITextConfig' - description: Configuration for AI text analysis - title: AI Text Config - x-stream-index: "008" - ai_video_config: - $ref: '#/components/schemas/AIVideoConfig' - description: Configuration for AI video analysis - title: AI Video Config - x-stream-index: "011" - async: - description: Whether moderation should be performed asynchronously - title: Async + enabled: type: boolean + x-stream-index: "001" + layout: + $ref: '#/components/schemas/LayoutSettings' x-stream-index: "003" - automod_platform_circumvention_config: - $ref: '#/components/schemas/AutomodPlatformCircumventionConfig' - description: Configuration for platform circumvention detection - title: Automod Platform Circumvention Config - x-stream-index: "005" - automod_semantic_filters_config: - $ref: '#/components/schemas/AutomodSemanticFiltersConfig' - description: Configuration for semantic filtering - title: Automod Semantic Filters Config - x-stream-index: "006" - automod_toxicity_config: - $ref: '#/components/schemas/AutomodToxicityConfig' - description: Configuration for toxicity detection - title: Automod Toxicity Config + location: + $ref: '#/components/schemas/RTMPLocation' x-stream-index: "004" - aws_rekognition_config: - $ref: '#/components/schemas/AIImageConfig' - x-stream-index: "015" - block_list_config: - $ref: '#/components/schemas/BlockListConfig' - description: Configuration for block list filtering - title: Block List Config - x-stream-index: "007" - bodyguard_config: - $ref: '#/components/schemas/AITextConfig' - x-stream-index: "014" - google_vision_config: - $ref: '#/components/schemas/GoogleVisionConfig' - description: Configuration for Google Vision integration - title: Google Vision Config - x-stream-index: "009" - key: - description: Unique identifier for the moderation configuration - title: Key - type: string - x-stream-index: "001" - rule_builder_config: - $ref: '#/components/schemas/RuleBuilderConfig' - description: Configuration for custom rule builder (max 3 rules, max 5 conditions - per rule) - title: Rule Builder Config - x-stream-index: "013" - team: - description: Team associated with the configuration - maxLength: 128 - minLength: 1 - title: Team + quality_name: type: string x-stream-index: "002" - velocity_filter_config: - $ref: '#/components/schemas/VelocityFilterConfig' - description: Configuration for velocity-based filtering - title: Velocity Filter Config - x-stream-index: "012" - video_call_rule_config: - $ref: '#/components/schemas/VideoCallRuleConfig' - x-stream-index: "016" required: - - key + - enabled type: object - UpsertConfigResponse: - nullable: true + RTMPSettingsRequest: properties: - config: - $ref: '#/components/schemas/ConfigResponse' - description: The created or updated moderation configuration - title: Config + enabled: + type: boolean x-stream-index: "001" - duration: + quality: + description: Resolution to set for the RTMP stream + enum: + - 360p + - 480p + - 720p + - 1080p + - 1440p + - portrait-360x640 + - portrait-480x854 + - portrait-720x1280 + - portrait-1080x1920 + - portrait-1440x2560 + title: Quality type: string - x-stream-index: "002.001" - required: - - duration + x-stream-index: "002" + title: RTMPSettingsRequest type: object - UpsertPushPreferencesRequest: - nullable: true + RTMPSettingsResponse: + description: RTMPSettingsResponse is the payload for RTMP settings properties: - preferences: - description: A list of push preferences for channels, calls, or the user. - items: - $ref: '#/components/schemas/PushPreferenceInput' - type: array + enabled: + title: Enabled + type: boolean x-stream-index: "001" + quality: + title: Quality + type: string + x-stream-index: "002" required: - - preferences + - enabled + - quality + - layout + title: RTMPSettingsResponse type: object - UpsertPushPreferencesResponse: - nullable: true + RankingConfig: properties: - duration: - description: Duration of the request in milliseconds - title: Duration - type: string - x-stream-index: "003.001" - user_channel_preferences: - additionalProperties: - additionalProperties: - $ref: '#/components/schemas/ChannelPushPreferences' - type: object - description: The channel specific push notification preferences, only returned - for channels you've edited. - title: User Channel Notification Preferences + defaults: + additionalProperties: {} type: object - x-stream-index: "002" - user_preferences: + x-stream-index: "003" + functions: additionalProperties: - $ref: '#/components/schemas/PushPreferences' - description: The user preferences, always returned regardless if you edited - it - title: User Preferences + $ref: '#/components/schemas/DecayFunctionConfig' type: object + x-stream-index: "004" + score: + type: string + x-stream-index: "002" + type: + type: string x-stream-index: "001" - required: - - user_preferences - - user_channel_preferences - - duration type: object - User: + Reaction: + nullable: true properties: - avg_response_time: - format: int32 - readOnly: true - type: integer - x-stream-index: "046" - ban_expires: - format: date-time - type: number - x-stream-index: "017" - banned: - type: boolean - x-stream-index: "016" created_at: format: date-time readOnly: true @@ -19578,1150 +20184,6698 @@ components: custom: additionalProperties: {} type: object - x-stream-index: "006" - deactivated_at: - format: date-time - readOnly: true - type: number - x-stream-index: "014" - deleted_at: - format: date-time - readOnly: true - type: number - x-stream-index: "013" - id: + x-stream-index: "010" + message_id: type: string x-stream-index: "003" - invisible: - type: boolean - x-stream-index: "023" - language: - type: string - x-stream-index: "035" - last_active: - format: date-time - readOnly: true - type: number - x-stream-index: "011" - last_engaged_at: - format: date-time - readOnly: true - type: number - x-stream-index: "012" - online: - readOnly: true - type: boolean - x-stream-index: "022" - privacy_settings: - $ref: '#/components/schemas/PrivacySettings' - x-stream-index: "026" - revoke_tokens_issued_before: - format: date-time - type: number - x-stream-index: "042" - role: + score: + format: int32 + type: integer + x-stream-index: "007" + type: + maxLength: 30 type: string - x-stream-index: "004" - teams: - items: - type: string - type: array - x-stream-index: "036" - teams_role: - additionalProperties: - type: string - type: object - x-stream-index: "005" + x-stream-index: "006" updated_at: format: date-time readOnly: true type: number x-stream-index: "009" + user: + $ref: '#/components/schemas/User' + x-stream-index: "005" + user_id: + type: string + x-stream-index: "004" required: - - id - - role - - teams_role + - message_id + - type + - score + - created_at + - updated_at - custom - - banned - - online type: object - UserBannedEvent: + ReactionDeletedEvent: properties: channel_id: type: string - x-stream-index: "006.002" + x-stream-index: "003.002" channel_type: type: string - x-stream-index: "006.003" + x-stream-index: "003.003" cid: type: string - x-stream-index: "006.001" + x-stream-index: "003.001" created_at: format: date-time type: number - x-stream-index: "008.002" - created_by: - $ref: '#/components/schemas/User' - x-stream-index: "001" - expiration: - format: date-time - type: number - x-stream-index: "003" - reason: - type: string - x-stream-index: "004" - shadow: - type: boolean + x-stream-index: "006.002" + message: + $ref: '#/components/schemas/Message' + x-stream-index: "001.001" + reaction: + $ref: '#/components/schemas/Reaction' x-stream-index: "002" team: type: string x-stream-index: "005.001" + thread_participants: + items: + $ref: '#/components/schemas/User' + type: array + x-stream-index: "001.002" type: - default: user.banned + default: reaction.deleted type: string - x-stream-index: "008.001" + x-stream-index: "006.001" user: $ref: '#/components/schemas/User' - x-stream-index: "007.001" + x-stream-index: "004.001" required: - - created_by - - shadow - cid - channel_id - channel_type - type - created_at - title: UserBannedEvent + title: ReactionDeletedEvent 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 - UserCreatedWithinParameters: + ReactionGroupResponse: + description: ReactionGroupResponse contains all information about a reaction + of the same type. + nullable: true properties: - max_age: - type: string + count: + description: Count is the number of reactions of this type. + format: int32 + title: Count + type: integer x-stream-index: "001" - type: object - UserDeactivatedEvent: - properties: - created_at: + first_reaction_at: + description: FirstReactionAt is the time of the first reaction of this type. + This is the same also if all reaction of this type are deleted, because + if someone will react again with the same type, will be preserved the + sorting. format: date-time + title: FirstReactionAt type: number - x-stream-index: "003.002" - created_by: - $ref: '#/components/schemas/User' - x-stream-index: "001" - type: - default: user.deactivated - type: string - x-stream-index: "003.001" - user: - $ref: '#/components/schemas/User' - x-stream-index: "002.001" + x-stream-index: "003" + last_reaction_at: + description: LastReactionAt is the time of the last reaction of this type. + format: date-time + title: LastReactionAt + type: number + x-stream-index: "004" + sum_scores: + description: 'SumScores is the sum of all scores of reactions of this type. + Medium allows you to clap articles more than once and shows the sum of + all claps from all users. For example, you can send `clap` x5 using `score: + 5`.' + format: int32 + title: SumScores + type: integer + x-stream-index: "002" required: - - created_by - - type - - created_at - title: UserDeactivatedEvent + - count + - sum_scores + - first_reaction_at + - last_reaction_at + title: ReactionGroupResponse 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 - UserDeletedEvent: + ReactionNewEvent: properties: + channel_id: + type: string + x-stream-index: "004.002" + channel_type: + type: string + x-stream-index: "004.003" + cid: + type: string + x-stream-index: "004.001" created_at: format: date-time type: number - x-stream-index: "002.002" - delete_conversation_channels: - type: boolean - x-stream-index: "005" - hard_delete: - type: boolean - x-stream-index: "003.001" - mark_messages_deleted: - type: boolean - x-stream-index: "004" + x-stream-index: "006.002" + message: + $ref: '#/components/schemas/Message' + x-stream-index: "001.001" + reaction: + $ref: '#/components/schemas/Reaction' + x-stream-index: "002" + team: + type: string + x-stream-index: "005.001" + thread_participants: + items: + $ref: '#/components/schemas/User' + type: array + x-stream-index: "001.002" type: - default: user.deleted + default: reaction.new type: string - x-stream-index: "002.001" + x-stream-index: "006.001" user: $ref: '#/components/schemas/User' - x-stream-index: "001.001" + x-stream-index: "003.001" required: + - cid + - channel_id + - channel_type - type - created_at - - hard_delete - - mark_messages_deleted - - delete_conversation_channels - title: UserDeletedEvent + title: ReactionNewEvent 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 - UserFeedbackReport: - properties: - count_by_rating: - additionalProperties: - format: int32 - type: integer - type: object - x-stream-index: "001" - unreported_count: - format: int32 - type: integer - x-stream-index: "002" - required: - - count_by_rating - - unreported_count - type: object - UserFeedbackReportResponse: - properties: - daily: - items: - $ref: '#/components/schemas/DailyAggregateUserFeedbackReportResponse' - type: array - x-stream-index: "001" - required: - - daily - type: object - UserMute: - nullable: true + ReactionRequest: + description: Represents user reaction to a message properties: created_at: description: Date/time of creation format: date-time title: Created at type: number - x-stream-index: "009" - expires: - description: Date/time of mute expiration - format: date-time - title: Expires - type: number - x-stream-index: "008" - target: - $ref: '#/components/schemas/User' - description: User who's muted - title: Target - x-stream-index: "007" + x-stream-index: "003" + custom: + additionalProperties: {} + type: object + x-stream-index: "005" + score: + description: Reaction score. If not specified reaction has score of 1 + format: int32 + title: Score + type: integer + x-stream-index: "002" + type: + description: The type of reaction (e.g. 'like', 'laugh', 'wow') + maxLength: 30 + title: Type + type: string + x-stream-index: "001" updated_at: description: Date/time of the last update format: date-time title: Updated at type: number - x-stream-index: "010" - user: - $ref: '#/components/schemas/User' - description: Owner of channel mute - title: User - x-stream-index: "005" + x-stream-index: "004" required: - - created_at - - updated_at + - type + title: Reaction type: object - UserMuteResponse: - nullable: true + x-stream-docs-page-id: send_reaction + ReactionResponse: properties: created_at: + description: Date/time of creation format: date-time + title: Created at type: number + x-stream-index: "006" + custom: + additionalProperties: {} + description: Custom data for this object + title: Custom data + type: object + x-stream-index: "008" + message_id: + description: Message ID + title: Message ID + type: string + x-stream-index: "001" + score: + description: Score of the reaction + format: int32 + title: Score + type: integer + x-stream-index: "005" + type: + description: Type of reaction + title: Type + type: string x-stream-index: "004" - expires: - format: date-time - type: number - x-stream-index: "003" - target: - $ref: '#/components/schemas/UserResponse' - x-stream-index: "002" updated_at: + description: Date/time of the last update format: date-time + title: Updated at type: number - x-stream-index: "005" + x-stream-index: "007" user: $ref: '#/components/schemas/UserResponse' - x-stream-index: "001" + description: User + title: UserResponse + x-stream-index: "003" + user_id: + description: User ID + title: User ID + type: string + x-stream-index: "002" required: + - message_id + - user_id + - user + - type + - score - created_at - updated_at + - custom type: object - UserMutedEvent: + ReactionUpdatedEvent: properties: + channel_id: + type: string + x-stream-index: "004.002" + channel_type: + type: string + x-stream-index: "004.003" + cid: + type: string + x-stream-index: "004.001" created_at: format: date-time type: number - x-stream-index: "004.002" - target_user: - type: string + x-stream-index: "006.002" + message: + $ref: '#/components/schemas/Message' x-stream-index: "001" - target_users: - items: - type: string - type: array + reaction: + $ref: '#/components/schemas/Reaction' x-stream-index: "002" + team: + type: string + x-stream-index: "005.001" type: - default: user.muted + default: reaction.updated type: string - x-stream-index: "004.001" + x-stream-index: "006.001" user: $ref: '#/components/schemas/User' x-stream-index: "003.001" required: - - type - - created_at - title: UserMutedEvent + - message + - reaction + - cid + - channel_id + - channel_type + - type + - created_at + title: ReactionUpdatedEvent 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 - UserPresenceChangedEvent: + ReadReceipts: properties: - created_at: - format: date-time - type: number - x-stream-index: "002.002" - type: - default: user.presence.changed - type: string - x-stream-index: "002.001" - user: - $ref: '#/components/schemas/User' - x-stream-index: "001.001" + enabled: + type: boolean + x-stream-index: "001" required: - - type - - created_at - title: UserPresenceChangedEvent + - enabled 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 - UserRatingReportResponse: + ReadReceiptsResponse: properties: - average: - format: float - type: number - x-stream-index: "002" - count: - format: int32 - type: integer + enabled: + type: boolean x-stream-index: "001" required: - - count - - average + - enabled type: object - UserReactivatedEvent: + ReadStateResponse: properties: - created_at: + last_read: format: date-time type: number - x-stream-index: "002.002" - type: - default: user.reactivated + x-stream-index: "002" + last_read_message_id: type: string - x-stream-index: "002.001" + x-stream-index: "004" + unread_messages: + format: int32 + type: integer + x-stream-index: "003" user: - $ref: '#/components/schemas/User' + $ref: '#/components/schemas/UserResponse' x-stream-index: "001" required: - - type - - created_at - title: UserReactivatedEvent + - user + - last_read + - unread_messages 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 - UserRequest: - description: User request object + RecordSettings: properties: - custom: - additionalProperties: {} - description: Custom user data - title: Custom - type: object + audio_only: + type: boolean + x-stream-index: "001" + layout: + $ref: '#/components/schemas/LayoutSettings' x-stream-index: "004" - id: - description: User ID - title: ID + mode: + type: string + x-stream-index: "002" + quality: type: string + x-stream-index: "003" + required: + - mode + type: object + RecordSettingsRequest: + properties: + audio_only: + type: boolean x-stream-index: "001" - image: - description: User's profile image URL - title: Image + mode: + enum: + - available + - disabled + - auto-on + title: Mode + type: string + x-stream-index: "002" + quality: + enum: + - 360p + - 480p + - 720p + - 1080p + - 1440p + - portrait-360x640 + - portrait-480x854 + - portrait-720x1280 + - portrait-1080x1920 + - portrait-1440x2560 type: string x-stream-index: "003" - invisible: + required: + - mode + title: RecordSettingsRequest + type: object + RecordSettingsResponse: + description: RecordSettings is the payload for recording settings + properties: + audio_only: + title: Audio Only type: boolean - x-stream-index: "006" - language: + x-stream-index: "001" + mode: + title: Mode + type: string + x-stream-index: "002" + quality: + title: Quality type: string + x-stream-index: "003" + required: + - audio_only + - mode + - quality + - layout + title: RecordSettingsResponse + type: object + RecordingEgressConfig: + properties: + audio_only: + type: boolean + x-stream-index: "006" + composite_app_settings: + $ref: '#/components/schemas/CompositeAppSettings' x-stream-index: "005" - name: - description: Optional name of user - title: Name + external_storage: + $ref: '#/components/schemas/ExternalStorage' + x-stream-index: "008" + quality: + $ref: '#/components/schemas/Quality' + x-stream-index: "004" + storage_name: type: string - x-stream-index: "002" - privacy_settings: - $ref: '#/components/schemas/PrivacySettingsResponse' x-stream-index: "007" + video_orientation_hint: + $ref: '#/components/schemas/VideoOrientation' + x-stream-index: "009" + type: object + RejectCallRequest: + nullable: true + properties: + reason: + description: Reason for rejecting the call + title: Reason + type: string + x-stream-index: "003" + title: RejectCallRequest + type: object + RejectCallResponse: + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "001.001" required: - - id - title: UserRequest + - duration + title: RejectCallResponse type: object - UserResponse: - description: User response object + RejectFeedMemberInviteRequest: + nullable: true + title: Reject Feed Member Request + type: object + RejectFeedMemberInviteResponse: + nullable: true properties: - avg_response_time: - format: int32 - type: integer - x-stream-index: "001.018" - banned: - description: Whether a user is banned or not - title: Banned - type: boolean - x-stream-index: "001.012" - blocked_user_ids: - items: - type: string - type: array - x-stream-index: "001.017" + duration: + type: string + x-stream-index: "002.001" + member: + $ref: '#/components/schemas/FeedMemberResponse' + description: The feed member after rejecting the invite + title: Feed Member + x-stream-index: "001" + required: + - member + - duration + title: Reject Feed Member Response + type: object + RejectFollowRequest: + nullable: true + properties: + source: + description: Fully qualified ID of the source feed + maxLength: 255 + title: Source Feed ID + type: string + x-stream-index: "001" + target: + description: Fully qualified ID of the target feed + maxLength: 255 + title: Target Feed ID + type: string + x-stream-index: "002" + required: + - source + - target + title: Reject Follow Request + type: object + RejectFollowResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + follow: + $ref: '#/components/schemas/FollowResponse' + description: The rejected follow relationship + title: Follow + x-stream-index: "001" + required: + - follow + - duration + title: Reject Follow Response + type: object + ReminderCreatedEvent: + description: Emitted when a reminder is created. + nullable: true + properties: + cid: + description: The CID of the Channel for which the reminder was created + title: Channel CID + type: string + x-stream-index: "001.004" created_at: description: Date/time of creation format: date-time title: Created at type: number - x-stream-index: "001.009" + x-stream-index: 001.001.003 custom: additionalProperties: {} - description: Custom data for this object - title: Custom data type: object - x-stream-index: "001.004" - deactivated_at: - description: Date of deactivation - format: date-time - title: Deactivated at - type: number - x-stream-index: "001.016" - deleted_at: - description: Date/time of deletion - format: date-time - title: Deleted at - type: number - x-stream-index: "001.011" - id: - description: Unique user identifier - title: ID - type: string - x-stream-index: "001.001" - image: - title: Image + x-stream-index: 001.001.007 + message_id: + description: The ID of the message for which the reminder was created + title: Message ID type: string - x-stream-index: "001.003" - language: - description: Preferred language of a user - title: Language + x-stream-index: "001.002" + parent_id: + description: The ID of the parent message, if the reminder is for a thread + message + title: Parent ID type: string x-stream-index: "001.005" - last_active: - description: Date of last activity + received_at: format: date-time - title: Last active type: number - x-stream-index: "001.014" - name: - description: Optional name of user - title: Name + x-stream-index: 001.001.004 + reminder: + $ref: '#/components/schemas/ReminderResponseData' + description: The reminder object which was created + title: MessageReminder + x-stream-index: "001.006" + type: + default: reminder.created + description: 'The type of event: "reminder.created" in this case' + title: Event Type type: string - x-stream-index: "001.002" - online: - description: Whether a user online or not - title: Online - type: boolean - x-stream-index: "001.013" - revoke_tokens_issued_before: - description: Revocation date for tokens - format: date-time - title: Revoke tokens issued before - type: number - x-stream-index: "001.015" - role: - description: Determines the set of user permissions - title: Role + x-stream-index: 001.001.002 + user_id: + description: The ID of the user for whom the reminder was created + title: User ID type: string - x-stream-index: "001.006" - teams: - description: List of teams user is a part of - items: - type: string - title: Teams - type: array - x-stream-index: "001.007" - teams_role: - additionalProperties: - type: string - type: object - x-stream-index: "001.008" - updated_at: - description: Date/time of the last update - format: date-time - title: Updated at - type: number - x-stream-index: "001.010" + x-stream-index: "001.003" required: - - id - - custom - - language - - role - - teams + - type - created_at - - updated_at - - banned - - online - - blocked_user_ids - - shadow_banned - - invisible - title: UserResponse + - custom + - message_id + - user_id + - cid + title: ReminderCreatedEvent type: object - UserResponseCommonFields: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + ReminderDeletedEvent: + description: Emitted when a reminder is deleted. + nullable: true properties: - avg_response_time: - format: int32 - type: integer - x-stream-index: "018" - banned: - type: boolean - x-stream-index: "012" - blocked_user_ids: - items: - type: string - type: array - x-stream-index: "017" + cid: + description: The CID of the Channel for which the reminder was created + title: Channel CID + type: string + x-stream-index: "001.004" created_at: + description: Date/time of creation format: date-time + title: Created at type: number - x-stream-index: "009" + x-stream-index: 001.001.003 custom: additionalProperties: {} type: object - x-stream-index: "004" - deactivated_at: - format: date-time - type: number - x-stream-index: "016" - deleted_at: - format: date-time - type: number - x-stream-index: "011" - id: - type: string - x-stream-index: "001" - image: + x-stream-index: 001.001.007 + message_id: + description: The ID of the message for which the reminder was created + title: Message ID type: string - x-stream-index: "003" - language: + x-stream-index: "001.002" + parent_id: + description: The ID of the parent message, if the reminder is for a thread + message + title: Parent ID type: string - x-stream-index: "005" - last_active: + x-stream-index: "001.005" + received_at: format: date-time type: number - x-stream-index: "014" - name: + x-stream-index: 001.001.004 + reminder: + $ref: '#/components/schemas/ReminderResponseData' + description: The reminder object which was created + title: MessageReminder + x-stream-index: "001.006" + type: + default: reminder.deleted + description: 'The type of event: "reminder.deleted" in this case' + title: Event Type type: string - x-stream-index: "002" - online: - type: boolean - x-stream-index: "013" - revoke_tokens_issued_before: - format: date-time - type: number - x-stream-index: "015" - role: + x-stream-index: 001.001.002 + user_id: + description: The ID of the user for whom the reminder was created + title: User ID type: string - x-stream-index: "006" - teams: - items: - type: string - type: array - x-stream-index: "007" - teams_role: - additionalProperties: - type: string - type: object - x-stream-index: "008" - updated_at: - format: date-time - type: number - x-stream-index: "010" + x-stream-index: "001.003" required: - - id - - custom - - language - - role - - teams + - type - created_at - - updated_at - - banned - - online - - blocked_user_ids + - custom + - message_id + - user_id + - cid + title: ReminderDeletedEvent type: object - UserResponsePrivacyFields: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + ReminderNotificationEvent: + description: Emitted when a reminder becomes due, triggering a notification + for the user. + nullable: true properties: - avg_response_time: - format: int32 - type: integer - x-stream-index: "001.018" - banned: - type: boolean - x-stream-index: "001.012" - blocked_user_ids: - items: - type: string - type: array - x-stream-index: "001.017" + cid: + description: The CID of the Channel for which the reminder was created + title: Channel CID + type: string + x-stream-index: "001.004" created_at: + description: Date/time of creation format: date-time + title: Created at type: number - x-stream-index: "001.009" + x-stream-index: 001.001.003 custom: additionalProperties: {} type: object - x-stream-index: "001.004" - deactivated_at: - format: date-time - type: number - x-stream-index: "001.016" - deleted_at: - format: date-time - type: number - x-stream-index: "001.011" - id: - type: string - x-stream-index: "001.001" - image: + x-stream-index: 001.001.007 + message_id: + description: The ID of the message for which the reminder was created + title: Message ID type: string - x-stream-index: "001.003" - invisible: - type: boolean - x-stream-index: "003" - language: + x-stream-index: "001.002" + parent_id: type: string x-stream-index: "001.005" - last_active: + received_at: format: date-time type: number - x-stream-index: "001.014" - name: + x-stream-index: 001.001.004 + reminder: + $ref: '#/components/schemas/ReminderResponseData' + description: The reminder object which was created + title: MessageReminder + x-stream-index: "001.006" + type: + default: notification.reminder_due + description: 'The type of event: "notification.reminder_due" in this case' + title: Event Type type: string - x-stream-index: "001.002" - online: - type: boolean - x-stream-index: "001.013" - privacy_settings: - $ref: '#/components/schemas/PrivacySettingsResponse' - x-stream-index: "002" - revoke_tokens_issued_before: - format: date-time - type: number - x-stream-index: "001.015" - role: + x-stream-index: 001.001.002 + user_id: + description: The ID of the user for whom the reminder was created + title: User ID type: string - x-stream-index: "001.006" - teams: - items: - type: string - type: array - x-stream-index: "001.007" - teams_role: - additionalProperties: - type: string - type: object - x-stream-index: "001.008" - updated_at: - format: date-time - type: number - x-stream-index: "001.010" + x-stream-index: "001.003" required: - - id - - custom - - language - - role - - teams + - type - created_at - - updated_at - - banned - - online - - blocked_user_ids - type: object - UserRuleParameters: - properties: - max_age: - type: string - x-stream-index: "001" + - custom + - message_id + - user_id + - cid + title: ReminderNotificationEvent type: object - UserUnbannedEvent: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + ReminderResponseData: properties: - channel_id: - type: string - x-stream-index: "002.002" - channel_type: - type: string - x-stream-index: "002.003" - cid: + channel: + $ref: '#/components/schemas/ChannelResponse' + x-stream-index: "003" + channel_cid: type: string - x-stream-index: "002.001" + x-stream-index: "002" created_at: format: date-time type: number - x-stream-index: "005.002" - shadow: - type: boolean - x-stream-index: "001" - team: - type: string - x-stream-index: "004.001" - type: - default: user.unbanned + x-stream-index: "008" + message: + $ref: '#/components/schemas/Message' + x-stream-index: "005" + message_id: type: string - x-stream-index: "005.001" + x-stream-index: "004" + remind_at: + format: date-time + type: number + x-stream-index: "001" + updated_at: + format: date-time + type: number + x-stream-index: "009" user: $ref: '#/components/schemas/User' - x-stream-index: "003.001" + x-stream-index: "007" + user_id: + type: string + x-stream-index: "006" required: - - shadow - - cid - - channel_id - - channel_type - - type + - channel_cid + - message_id + - user_id - created_at - title: UserUnbannedEvent + - updated_at 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 - UserUpdatedEvent: - description: This event is sent when a user gets updated. The event contains - information about the updated user. + ReminderUpdatedEvent: + description: Emitted when a reminder is updated. nullable: true properties: + cid: + description: The CID of the Channel for which the reminder was created + title: Channel CID + type: string + x-stream-index: "001.004" created_at: description: Date/time of creation format: date-time title: Created at type: number - x-stream-index: "001.003" + x-stream-index: 001.001.003 custom: additionalProperties: {} type: object - x-stream-index: "001.007" + x-stream-index: 001.001.007 + message_id: + description: The ID of the message for which the reminder was created + title: Message ID + type: string + x-stream-index: "001.002" + parent_id: + description: The ID of the parent message, if the reminder is for a thread + message + title: Parent ID + type: string + x-stream-index: "001.005" received_at: format: date-time type: number - x-stream-index: "001.004" + x-stream-index: 001.001.004 + reminder: + $ref: '#/components/schemas/ReminderResponseData' + description: The reminder object which was created + title: MessageReminder + x-stream-index: "001.006" type: - default: user.updated - description: 'The type of event: "user.updated" in this case' + default: reminder.updated + description: 'The type of event: "reminder.updated" in this case' title: Event Type type: string - x-stream-index: "001.002" - user: - $ref: '#/components/schemas/UserResponsePrivacyFields' - description: The updated user - title: User - x-stream-index: "002.001" + x-stream-index: 001.001.002 + user_id: + description: The ID of the user for whom the reminder was created + title: User ID + type: string + x-stream-index: "001.003" required: - type - created_at - custom - - user - title: UserUpdatedEvent + - message_id + - user_id + - cid + title: ReminderUpdatedEvent 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 - UserWatchingStartEvent: + RepliesMeta: + description: Cursor & depth information for a comment's direct replies. Mirrors + Reddit's 'load more replies' semantics. properties: - channel_id: - type: string - x-stream-index: "004.002" - channel_type: - type: string - x-stream-index: "004.003" - cid: - type: string - x-stream-index: "004.001" - created_at: - format: date-time - type: number - x-stream-index: "003.002" - team: - type: string - x-stream-index: "002.001" - type: - default: user.watching.start + depth_truncated: + description: True if the subtree was cut because the requested depth was + reached. + title: Depth Truncated + type: boolean + x-stream-index: "004" + has_more: + description: True if more siblings exist in the database. + title: Has More + type: boolean + x-stream-index: "001" + next_cursor: + description: Opaque cursor to request the next page of siblings. + title: Next Cursor type: string - x-stream-index: "003.001" - user: - $ref: '#/components/schemas/User' - x-stream-index: "005.001" - watcher_count: + x-stream-index: "002" + remaining: + description: Number of unread siblings that match current filters. format: int32 + title: Remaining type: integer - x-stream-index: "001.001" + x-stream-index: "003" required: - - watcher_count - - type - - created_at - - cid - - channel_id - - channel_type - title: UserWatchingStartEvent + - has_more + - remaining + - depth_truncated + title: Replies Meta 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 - UserWatchingStopEvent: + ReportByHistogramBucket: properties: - channel_id: - type: string - x-stream-index: "004.002" - channel_type: - type: string - x-stream-index: "004.003" - cid: + category: type: string - x-stream-index: "004.001" - created_at: - format: date-time - type: number - x-stream-index: "002.002" - type: - default: user.watching.stop - type: string - x-stream-index: "002.001" - user: - $ref: '#/components/schemas/User' - x-stream-index: "003.001" - watcher_count: - format: int32 - type: integer - x-stream-index: "001.001" - required: - - watcher_count - - type - - created_at - - cid - - channel_id - - channel_type - title: UserWatchingStopEvent - 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 - VelocityFilterConfig: - properties: - advanced_filters: - type: boolean - x-stream-index: "007" - async: - type: boolean x-stream-index: "001" - cascading_actions: - type: boolean - x-stream-index: "004" - cids_per_user: + count: format: int32 type: integer - x-stream-index: "006" - enabled: - type: boolean - x-stream-index: "002" - first_message_only: - type: boolean x-stream-index: "005" - rules: - items: - $ref: '#/components/schemas/VelocityFilterConfigRule' - type: array - x-stream-index: "003" - required: - - enabled - - rules - - cascading_actions - - first_message_only - - cids_per_user - - advanced_filters - type: object - VelocityFilterConfigRule: - properties: - action: - enum: - - flag - - shadow - - remove - - ban - type: string - x-stream-index: "001" - ban_duration: - format: int32 - type: integer + lower_bound: + $ref: '#/components/schemas/Bound' x-stream-index: "002" - cascading_action: - enum: - - flag - - shadow - - remove - - ban - type: string - x-stream-index: "006" - cascading_threshold: - format: int64 - type: integer - x-stream-index: "005" - check_message_context: - type: boolean - x-stream-index: "009" - fast_spam_threshold: - format: int32 - type: integer - x-stream-index: "007" - fast_spam_ttl: - format: int32 - type: integer - x-stream-index: "010" - ip_ban: - type: boolean + sum: + format: float + type: number x-stream-index: "004" - probation_period: - format: int32 - type: integer - x-stream-index: "014" - shadow_ban: - type: boolean + upper_bound: + $ref: '#/components/schemas/Bound' x-stream-index: "003" - slow_spam_ban_duration: - format: int32 - type: integer - x-stream-index: "012" - slow_spam_threshold: - format: int32 - type: integer - x-stream-index: "008" - slow_spam_ttl: - format: int32 - type: integer - x-stream-index: "011" - url_only: - type: boolean - x-stream-index: "013" required: - - action - - ban_duration - - shadow_ban - - ip_ban - - cascading_threshold - - cascading_action - - fast_spam_threshold - - slow_spam_threshold - - check_message_context - - fast_spam_ttl - - slow_spam_ttl - - url_only - - probation_period + - category + - sum + - count type: object - VideoCallRuleConfig: + ReportResponse: properties: - rules: - additionalProperties: - $ref: '#/components/schemas/HarmConfig' - type: object + call: + $ref: '#/components/schemas/CallReportResponse' + x-stream-index: "003" + participants: + $ref: '#/components/schemas/ParticipantReportResponse' x-stream-index: "001" + user_ratings: + $ref: '#/components/schemas/UserRatingReportResponse' + x-stream-index: "002" required: - - rules + - participants + - user_ratings + - call type: object - VideoContentParameters: + RequestPermissionRequest: + nullable: true properties: - harm_labels: + permissions: items: type: string + title: Permissions type: array - x-stream-index: "001" - type: object - VideoEndCallRequest: - type: object - VideoKickUserRequest: - type: object - VideoOrientation: - properties: - orientation: - type: integer - x-stream-index: "004" + x-stream-index: "003" + required: + - permissions + title: RequestPermissionRequest type: object - VideoReactionOverTimeResponse: + RequestPermissionResponse: + nullable: true properties: - by_minute: - items: - $ref: '#/components/schemas/CountByMinuteResponse' - type: array - x-stream-index: "001" + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "001.001" + required: + - duration + title: RequestPermissionResponse type: object - VideoReactionsResponse: + Response: + description: Basic response information nullable: true properties: - count_over_time: - $ref: '#/components/schemas/VideoReactionOverTimeResponse' - x-stream-index: "002" - reaction: + duration: + description: Duration of the request in milliseconds + title: Duration type: string x-stream-index: "001" required: - - reaction + - duration + title: Response type: object - VideoRuleParameters: + RestoreActionRequest: + type: object + ReviewQueueItem: properties: - harm_labels: + actions: items: - type: string + $ref: '#/components/schemas/ActionLog' type: array - x-stream-index: "003" - threshold: + x-stream-index: "035" + activity: + $ref: '#/components/schemas/EnrichedActivity' + x-stream-index: "028" + ai_text_severity: + type: string + x-stream-index: "021" + archived_at: + $ref: '#/components/schemas/NullTime' + x-stream-index: "043" + assigned_to: + $ref: '#/components/schemas/User' + x-stream-index: "032" + bans: + items: + $ref: '#/components/schemas/Ban' + type: array + x-stream-index: "033" + bounce_count: format: int32 type: integer - x-stream-index: "001" - time_window: + x-stream-index: "025" + call: + $ref: '#/components/schemas/Call' + x-stream-index: "031" + completed_at: + $ref: '#/components/schemas/NullTime' + x-stream-index: "018" + config_key: type: string - x-stream-index: "002" - required: - - threshold - - time_window - type: object - VideoSettings: - properties: - access_request_enabled: - type: boolean - x-stream-index: "002" - camera_default_on: + x-stream-index: "009" + content_changed: type: boolean + x-stream-index: "036" + created_at: + format: date-time + type: number x-stream-index: "004" - camera_facing: - enum: - - front - - back - - external + entity_creator: + $ref: '#/components/schemas/EntityCreator' + x-stream-index: "030" + entity_id: type: string - x-stream-index: "005" - enabled: - type: boolean - x-stream-index: "001" - target_resolution: - $ref: '#/components/schemas/TargetResolution' - x-stream-index: "003" - required: - - enabled - - access_request_enabled - - target_resolution - - camera_default_on - - camera_facing - type: object - VideoSettingsRequest: - properties: - access_request_enabled: - type: boolean - x-stream-index: "002" - camera_default_on: - type: boolean - x-stream-index: "004" - camera_facing: - enum: - - front - - back - - external + x-stream-index: "007" + entity_type: type: string - x-stream-index: "005" - enabled: + x-stream-index: "006" + feeds_v2_activity: + $ref: '#/components/schemas/EnrichedActivity' + x-stream-index: "041" + feeds_v2_reaction: + $ref: '#/components/schemas/Reaction' + x-stream-index: "042" + flag_labels: + items: + type: string + type: array + x-stream-index: "045" + flag_types: + items: + type: string + type: array + x-stream-index: "044" + flags: + items: + $ref: '#/components/schemas/Flag' + type: array + x-stream-index: "034" + flags_count: + format: int32 + type: integer + x-stream-index: "026" + has_image: type: boolean - x-stream-index: "001" - target_resolution: - $ref: '#/components/schemas/TargetResolution' - x-stream-index: "003" - type: object - VideoSettingsResponse: - properties: - access_request_enabled: + x-stream-index: "012" + has_text: type: boolean - x-stream-index: "002" - camera_default_on: + x-stream-index: "014" + has_video: type: boolean - x-stream-index: "004" - camera_facing: - enum: - - front - - back - - external + x-stream-index: "013" + id: type: string - x-stream-index: "005" - enabled: - type: boolean - x-stream-index: "001" - target_resolution: - $ref: '#/components/schemas/TargetResolution' x-stream-index: "003" - required: - - enabled - - access_request_enabled - - target_resolution - - camera_default_on - - camera_facing - type: object - VoteData: - properties: - answer_text: + languages: + items: + type: string + type: array + x-stream-index: "019" + message: + $ref: '#/components/schemas/Message' + x-stream-index: "027" + moderation_payload: + $ref: '#/components/schemas/ModerationPayload' + x-stream-index: "010" + moderation_payload_hash: type: string - x-stream-index: "002" - option_id: - maxLength: 255 + x-stream-index: "011" + reaction: + $ref: '#/components/schemas/Reaction' + x-stream-index: "029" + recommended_action: type: string - x-stream-index: "001" + x-stream-index: "017" + reporter_ids: + items: + type: string + type: array + x-stream-index: "046" + reviewed_at: + $ref: '#/components/schemas/NullTime' + x-stream-index: "022" + reviewed_by: + type: string + x-stream-index: "023" + severity: + format: int32 + type: integer + x-stream-index: "020" + status: + type: string + x-stream-index: "016" + teams: + items: + type: string + type: array + x-stream-index: "015" + updated_at: + format: date-time + type: number + x-stream-index: "005" + required: + - id + - created_at + - updated_at + - entity_type + - entity_id + - config_key + - moderation_payload_hash + - has_image + - has_video + - has_text + - teams + - status + - recommended_action + - completed_at + - languages + - severity + - ai_text_severity + - reviewed_at + - reviewed_by + - bounce_count + - flags_count + - bans + - flags + - actions + - content_changed + - archived_at + - flag_types + - flag_labels + - reporter_ids type: object - WSAuthMessage: - description: Websocket auth message + ReviewQueueItemResponse: nullable: true properties: - products: + actions: + description: Moderation actions taken items: - type: string + $ref: '#/components/schemas/ActionLogResponse' + title: Actions type: array - x-stream-index: "003" - token: - title: Token + x-stream-index: "024" + activity: + $ref: '#/components/schemas/EnrichedActivity' + x-stream-index: "016" + ai_text_severity: + description: AI-determined text severity + title: AI Text Severity + type: string + x-stream-index: "014" + assigned_to: + $ref: '#/components/schemas/UserResponse' + description: Moderator assigned to review this item + title: Assigned To + x-stream-index: "021" + bans: + description: Associated ban records + items: + $ref: '#/components/schemas/Ban' + title: Bans + type: array + x-stream-index: "022" + call: + $ref: '#/components/schemas/CallResponse' + x-stream-index: "018" + completed_at: + description: When the review was completed + format: date-time + title: Completed At + type: number + x-stream-index: "009" + config_key: type: string + x-stream-index: "028" + created_at: + description: When the item was created + format: date-time + title: Created At + type: number x-stream-index: "002" - user_details: - $ref: '#/components/schemas/ConnectUserDetailsRequest' - x-stream-index: "001" - required: - - user_details - - token - title: WSAuthMessage - type: object - WSClientEvent: - description: The discriminator object for all websocket client events, it maps - events' payload to the final type - discriminator: - mapping: + entity_creator: + $ref: '#/components/schemas/EntityCreatorResponse' + description: Details about who created the entity + title: Entity Creator + x-stream-index: "019" + entity_creator_id: + description: ID of who created the entity + title: Entity Creator ID + type: string + x-stream-index: "020" + entity_id: + description: ID of the entity being reviewed + title: Entity ID + type: string + x-stream-index: "005" + entity_type: + description: Type of entity being reviewed + title: Entity Type + type: string + x-stream-index: "004" + feeds_v2_activity: + $ref: '#/components/schemas/EnrichedActivity' + description: Associated feed activity + title: Feeds V2 Activity + x-stream-index: "025" + feeds_v2_reaction: + $ref: '#/components/schemas/Reaction' + description: Associated feed reaction + title: Feeds V2 Reaction + x-stream-index: "026" + flags: + description: Associated flag records + items: + $ref: '#/components/schemas/ModerationFlagResponse' + title: Flags + type: array + x-stream-index: "023" + flags_count: + format: int32 + type: integer + x-stream-index: "029" + id: + description: Unique identifier of the review queue item + title: ID + type: string + x-stream-index: "001" + languages: + description: Detected languages in the content + items: + type: string + title: Languages + type: array + x-stream-index: "012" + message: + $ref: '#/components/schemas/MessageResponse' + description: Associated message details + title: Message + x-stream-index: "015" + moderation_payload: + $ref: '#/components/schemas/ModerationPayload' + description: Content being moderated + title: Moderation Payload + x-stream-index: "006" + reaction: + $ref: '#/components/schemas/Reaction' + x-stream-index: "017" + recommended_action: + description: Suggested moderation action + title: Recommended Action + type: string + x-stream-index: "008" + reviewed_at: + description: When the item was reviewed + format: date-time + title: Reviewed At + type: number + x-stream-index: "010" + reviewed_by: + description: ID of the moderator who reviewed the item + title: Reviewed By + type: string + x-stream-index: "011" + severity: + description: Severity level of the content + format: int32 + title: Severity + type: integer + x-stream-index: "013" + status: + description: Current status of the review + title: Status + type: string + x-stream-index: "007" + teams: + description: Teams associated with this item + items: + type: string + title: Teams + type: array + x-stream-index: "027" + updated_at: + description: When the item was last updated + format: date-time + title: Updated At + type: number + x-stream-index: "003" + required: + - id + - created_at + - updated_at + - entity_type + - entity_id + - status + - recommended_action + - reviewed_by + - languages + - severity + - ai_text_severity + - bans + - flags + - actions + - flags_count + type: object + RingSettings: + properties: + auto_cancel_timeout_ms: + format: int32 + type: integer + x-stream-index: "002" + incoming_call_timeout_ms: + format: int32 + type: integer + x-stream-index: "001" + missed_call_timeout_ms: + format: int32 + type: integer + x-stream-index: "003" + required: + - incoming_call_timeout_ms + - auto_cancel_timeout_ms + - missed_call_timeout_ms + type: object + RingSettingsRequest: + properties: + auto_cancel_timeout_ms: + description: When none of the callees accept a ring call in this time a + rejection will be sent by the caller with reason 'timeout' by the SDKs + format: int32 + maximum: 180000 + minimum: 5000 + title: AutoCancelTimeoutMs + type: integer + x-stream-index: "002" + incoming_call_timeout_ms: + description: When a callee is online but doesn't answer a ring call in this + time a rejection will be sent with reason 'timeout' by the SDKs + format: int32 + maximum: 180000 + minimum: 5000 + title: IncomingCallTimeoutMs + type: integer + x-stream-index: "001" + missed_call_timeout_ms: + description: When a callee doesn't accept or reject a ring call in this + time a missed call event will be sent + format: int32 + maximum: 180000 + minimum: 5000 + title: MissedCallTimeoutMs + type: integer + x-stream-index: "003" + required: + - incoming_call_timeout_ms + - auto_cancel_timeout_ms + title: RingSettingsRequest + type: object + RingSettingsResponse: + properties: + auto_cancel_timeout_ms: + format: int32 + type: integer + x-stream-index: "002" + incoming_call_timeout_ms: + format: int32 + type: integer + x-stream-index: "001" + missed_call_timeout_ms: + format: int32 + type: integer + x-stream-index: "003" + required: + - incoming_call_timeout_ms + - auto_cancel_timeout_ms + - missed_call_timeout_ms + type: object + RuleBuilderAction: + properties: + ban_options: + $ref: '#/components/schemas/BanOptions' + x-stream-index: "002" + flag_content_options: + $ref: '#/components/schemas/FlagContentOptions' + x-stream-index: "004" + flag_user_options: + $ref: '#/components/schemas/FlagUserOptions' + x-stream-index: "003" + remove_content_options: + $ref: '#/components/schemas/BlockContentOptions' + x-stream-index: "005" + type: + type: string + x-stream-index: "001" + type: object + RuleBuilderCondition: + properties: + confidence: + format: float + type: number + x-stream-index: "002" + content_count_rule_params: + $ref: '#/components/schemas/ContentCountRuleParameters' + x-stream-index: "007" + image_content_params: + $ref: '#/components/schemas/ImageContentParameters' + x-stream-index: "009" + image_rule_params: + $ref: '#/components/schemas/ImageRuleParameters' + x-stream-index: "004" + text_content_params: + $ref: '#/components/schemas/TextContentParameters' + x-stream-index: "008" + text_rule_params: + $ref: '#/components/schemas/TextRuleParameters' + x-stream-index: "003" + type: + type: string + x-stream-index: "001" + user_created_within_params: + $ref: '#/components/schemas/UserCreatedWithinParameters' + x-stream-index: "011" + user_custom_property_params: + $ref: '#/components/schemas/UserCustomPropertyParameters' + x-stream-index: "012" + user_rule_params: + $ref: '#/components/schemas/UserRuleParameters' + x-stream-index: "006" + video_content_params: + $ref: '#/components/schemas/VideoContentParameters' + x-stream-index: "010" + video_rule_params: + $ref: '#/components/schemas/VideoRuleParameters' + x-stream-index: "005" + type: object + RuleBuilderConditionGroup: + properties: + conditions: + items: + $ref: '#/components/schemas/RuleBuilderCondition' + type: array + x-stream-index: "002" + logic: + type: string + x-stream-index: "001" + type: object + RuleBuilderConfig: + properties: + async: + type: boolean + x-stream-index: "001" + rules: + items: + $ref: '#/components/schemas/RuleBuilderRule' + type: array + x-stream-index: "002" + type: object + RuleBuilderRule: + properties: + action: + $ref: '#/components/schemas/RuleBuilderAction' + x-stream-index: "006" + conditions: + items: + $ref: '#/components/schemas/RuleBuilderCondition' + type: array + x-stream-index: "003" + cooldown_period: + type: string + x-stream-index: "007" + groups: + items: + $ref: '#/components/schemas/RuleBuilderConditionGroup' + type: array + x-stream-index: "005" + id: + type: string + x-stream-index: "001" + logic: + type: string + x-stream-index: "004" + rule_type: + type: string + x-stream-index: "002" + required: + - rule_type + - action + type: object + SDKUsageReport: + properties: + per_sdk_usage: + additionalProperties: + $ref: '#/components/schemas/PerSDKUsageReport' + type: object + x-stream-index: "001" + required: + - per_sdk_usage + type: object + SDKUsageReportResponse: + properties: + daily: + items: + $ref: '#/components/schemas/DailyAggregateSDKUsageReportResponse' + type: array + x-stream-index: "001" + required: + - daily + type: object + SFUIDLastSeen: + properties: + id: + type: string + x-stream-index: "001.001" + last_seen: + format: date-time + type: number + x-stream-index: "002" + process_start_time: + format: int64 + type: integer + x-stream-index: "001.002" + required: + - id + - process_start_time + - last_seen + type: object + SFUResponse: + properties: + edge_name: + type: string + x-stream-index: "001" + url: + type: string + x-stream-index: "002" + ws_endpoint: + type: string + x-stream-index: "003" + required: + - edge_name + - url + - ws_endpoint + type: object + STTEgressConfig: + properties: + closed_captions_enabled: + type: boolean + x-stream-index: "005" + external_storage: + $ref: '#/components/schemas/ExternalStorage' + x-stream-index: "011" + language: + type: string + x-stream-index: "008" + storage_name: + type: string + x-stream-index: "010" + translation_languages: + items: + type: string + type: array + x-stream-index: "009" + translations_enabled: + type: boolean + x-stream-index: "006" + upload_transcriptions: + type: boolean + x-stream-index: "004" + whisper_server_base_url: + type: string + x-stream-index: "007" + type: object + ScreensharingSettings: + properties: + access_request_enabled: + type: boolean + x-stream-index: "002" + enabled: + type: boolean + x-stream-index: "001" + target_resolution: + $ref: '#/components/schemas/TargetResolution' + x-stream-index: "003" + required: + - enabled + - access_request_enabled + type: object + ScreensharingSettingsRequest: + properties: + access_request_enabled: + type: boolean + x-stream-index: "002" + enabled: + type: boolean + x-stream-index: "001" + target_resolution: + $ref: '#/components/schemas/TargetResolution' + x-stream-index: "003" + type: object + ScreensharingSettingsResponse: + properties: + access_request_enabled: + type: boolean + x-stream-index: "002" + enabled: + type: boolean + x-stream-index: "001" + target_resolution: + $ref: '#/components/schemas/TargetResolution' + x-stream-index: "003" + required: + - enabled + - access_request_enabled + type: object + SearchPayload: + properties: + filter_conditions: + additionalProperties: {} + description: Channel filter conditions + maximum: 100 + minimum: 1 + title: Channel filter + type: object + x-stream-docs-page-id: query_channels + x-stream-index: "002" + limit: + description: Number of messages to return + format: int32 + title: Limit + type: integer + x-stream-index: "005" + message_filter_conditions: + additionalProperties: {} + description: Message filter conditions + title: Message filter + type: object + x-stream-index: "003" + message_options: + $ref: '#/components/schemas/MessageOptions' + x-stream-index: "004" + next: + description: Pagination parameter. Cannot be used with non-zero offset. + title: Next + type: string + x-stream-index: "008" + offset: + description: Pagination offset. Cannot be used with sort or next. + format: int32 + title: Offset + type: integer + x-stream-index: "006" + query: + description: Search phrase + title: Query + type: string + x-stream-index: "001" + sort: + description: Sort parameters. Cannot be used with non-zero offset + items: + $ref: '#/components/schemas/SortParamRequest' + title: Sort + type: array + x-stream-index: "007" + required: + - filter_conditions + type: object + SearchResponse: + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "005.001" + next: + description: Value to pass to the next search query in order to paginate + title: Next + type: string + x-stream-index: "003" + previous: + description: Value that points to the previous page. Pass as the next value + in a search query to paginate backwards + title: Previous + type: string + x-stream-index: "004" + results: + description: Search results + items: + $ref: '#/components/schemas/SearchResult' + title: Results + type: array + x-stream-index: "001" + results_warning: + $ref: '#/components/schemas/SearchWarning' + description: Warning about the search results + title: Results Warning + x-stream-index: "002" + required: + - results + - duration + type: object + SearchResult: + properties: + message: + $ref: '#/components/schemas/SearchResultMessage' + description: Found message + title: Message + x-stream-index: "001" + type: object + SearchResultMessage: + properties: + attachments: + items: + $ref: '#/components/schemas/Attachment' + type: array + x-stream-index: "001.008" + channel: + $ref: '#/components/schemas/ChannelResponse' + description: Channel object + title: Channel + x-stream-index: "002" + cid: + type: string + x-stream-index: "001.022" + command: + type: string + x-stream-index: "001.004" + created_at: + format: date-time + type: number + x-stream-index: "001.023" + custom: + additionalProperties: {} + type: object + x-stream-index: "001.026" + deleted_at: + format: date-time + type: number + x-stream-index: "001.025" + deleted_for_me: + type: boolean + x-stream-index: "001.044" + deleted_reply_count: + format: int32 + type: integer + x-stream-index: "001.018" + draft: + $ref: '#/components/schemas/DraftResponse' + x-stream-index: "001.041" + html: + type: string + x-stream-index: "001.005" + i18n: + additionalProperties: + type: string + type: object + x-stream-index: "001.030" + id: + type: string + x-stream-index: "001.001" + image_labels: + additionalProperties: + items: + type: string + type: array + type: object + x-stream-index: "001.028" + latest_reactions: + items: + $ref: '#/components/schemas/ReactionResponse' + type: array + x-stream-index: "001.009" + mentioned_users: + items: + $ref: '#/components/schemas/UserResponse' + type: array + x-stream-index: "001.029" + message_text_updated_at: + format: date-time + type: number + x-stream-index: "001.036" + mml: + type: string + x-stream-index: "001.003" + moderation: + $ref: '#/components/schemas/ModerationV2Response' + x-stream-index: "001.039" + own_reactions: + items: + $ref: '#/components/schemas/ReactionResponse' + type: array + x-stream-index: "001.010" + parent_id: + type: string + x-stream-index: "001.015" + pin_expires: + format: date-time + type: number + x-stream-index: "001.035" + pinned: + type: boolean + x-stream-index: "001.032" + pinned_at: + format: date-time + type: number + x-stream-index: "001.033" + pinned_by: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "001.034" + poll: + $ref: '#/components/schemas/PollResponseData' + x-stream-index: "001.038" + poll_id: + type: string + x-stream-index: "001.037" + quoted_message: + $ref: '#/components/schemas/MessageResponse' + x-stream-index: "001.020" + quoted_message_id: + type: string + x-stream-index: "001.019" + reaction_counts: + additionalProperties: + format: int32 + type: integer + type: object + x-stream-index: "001.011" + reaction_groups: + additionalProperties: + $ref: '#/components/schemas/ReactionGroupResponse' + type: object + x-stream-index: "001.014" + reaction_scores: + additionalProperties: + format: int32 + type: integer + type: object + x-stream-index: "001.012" + reminder: + $ref: '#/components/schemas/ReminderResponseData' + x-stream-index: "001.042" + reply_count: + format: int32 + type: integer + x-stream-index: "001.017" + restricted_visibility: + items: + type: string + type: array + x-stream-index: "001.040" + shadowed: + type: boolean + x-stream-index: "001.027" + shared_location: + $ref: '#/components/schemas/SharedLocationResponseData' + x-stream-index: "001.043" + show_in_channel: + type: boolean + x-stream-index: "001.016" + silent: + type: boolean + x-stream-index: "001.031" + text: + type: string + x-stream-index: "001.002" + thread_participants: + items: + $ref: '#/components/schemas/UserResponse' + type: array + x-stream-index: "001.021" + type: + type: string + x-stream-index: "001.006" + updated_at: + format: date-time + type: number + x-stream-index: "001.024" + user: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "001.007" + required: + - id + - text + - html + - type + - user + - attachments + - latest_reactions + - own_reactions + - reaction_counts + - reaction_scores + - reply_count + - deleted_reply_count + - cid + - created_at + - updated_at + - custom + - shadowed + - mentioned_users + - silent + - pinned + - restricted_visibility + type: object + SearchWarning: + properties: + channel_search_cids: + description: Channel CIDs for the searched channels + items: + type: string + title: Channel Search CIDs + type: array + x-stream-index: "004" + channel_search_count: + description: Number of channels searched + format: int32 + title: Channel Search Count + type: integer + x-stream-index: "003" + warning_code: + description: Code corresponding to the warning + format: int32 + title: Warning Code + type: integer + x-stream-index: "002" + warning_description: + description: Description of the warning + title: Warning Description + type: string + x-stream-index: "001" + required: + - warning_description + - warning_code + type: object + SendCallEventRequest: + description: Send a call event to the other user + nullable: true + properties: + custom: + additionalProperties: {} + title: Custom + type: object + x-stream-index: "004" + title: SendCallEventRequest + type: object + SendCallEventResponse: + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "001.001" + required: + - duration + title: SendCallEventResponse + type: object + SendEventRequest: + nullable: true + properties: + event: + $ref: '#/components/schemas/EventRequest' + x-stream-index: "001" + required: + - event + type: object + SendMessageRequest: + nullable: true + properties: + keep_channel_hidden: + type: boolean + x-stream-index: "008" + message: + $ref: '#/components/schemas/MessageRequest' + x-stream-index: "001" + skip_enrich_url: + type: boolean + x-stream-index: "003" + skip_push: + type: boolean + x-stream-index: "002" + required: + - message + type: object + SendMessageResponse: + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "003.001" + message: + $ref: '#/components/schemas/MessageResponse' + description: Message response + title: Message + x-stream-index: "001" + pending_message_metadata: + additionalProperties: + type: string + description: Pending message metadata + title: Pending message metadata + type: object + x-stream-index: "002" + required: + - message + - duration + type: object + SendReactionRequest: + nullable: true + properties: + enforce_unique: + description: Whether to replace all existing user reactions + title: Enforce unique + type: boolean + x-stream-index: "003" + reaction: + $ref: '#/components/schemas/ReactionRequest' + x-stream-index: "002" + skip_push: + description: Skips any mobile push notifications + title: Skip push + type: boolean + x-stream-index: "004" + required: + - reaction + type: object + SendReactionResponse: + description: Basic response information + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "003.001" + message: + $ref: '#/components/schemas/MessageResponse' + x-stream-index: "001" + reaction: + $ref: '#/components/schemas/ReactionResponse' + x-stream-index: "002" + required: + - message + - reaction + - duration + title: Response + type: object + SessionSettings: + properties: + inactivity_timeout_seconds: + format: int32 + maximum: 900 + minimum: 5 + type: integer + x-stream-index: "001" + required: + - inactivity_timeout_seconds + type: object + SessionSettingsRequest: + properties: + inactivity_timeout_seconds: + format: int32 + maximum: 900 + minimum: 5 + type: integer + x-stream-index: "001" + required: + - inactivity_timeout_seconds + type: object + SessionSettingsResponse: + properties: + inactivity_timeout_seconds: + format: int32 + maximum: 900 + minimum: 5 + type: integer + x-stream-index: "001" + required: + - inactivity_timeout_seconds + type: object + ShadowBlockActionRequest: + type: object + SharedLocation: + properties: + channel: + $ref: '#/components/schemas/Channel' + x-stream-index: "013" + channel_cid: + type: string + x-stream-index: "003" + created_at: + format: date-time + type: number + x-stream-index: "010" + created_by_device_id: + type: string + x-stream-index: "008" + end_at: + format: date-time + type: number + x-stream-index: "009" + latitude: + format: float + maximum: 90 + minimum: 1.8446744073709552e+19 + type: number + x-stream-index: "006" + longitude: + format: float + maximum: 180 + minimum: 1.8446744073709552e+19 + type: number + x-stream-index: "007" + message: + $ref: '#/components/schemas/Message' + x-stream-index: "012" + message_id: + type: string + x-stream-index: "004" + updated_at: + format: date-time + type: number + x-stream-index: "011" + user_id: + type: string + x-stream-index: "005" + required: + - channel_cid + - message_id + - user_id + - created_by_device_id + - created_at + - updated_at + type: object + SharedLocationResponse: + nullable: true + properties: + channel: + $ref: '#/components/schemas/ChannelResponse' + x-stream-index: "001.011" + channel_cid: + description: Channel CID + title: string + type: string + x-stream-index: "001.001" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: "001.008" + created_by_device_id: + description: Device ID that created the live location + title: string + type: string + x-stream-index: "001.006" + duration: + type: string + x-stream-index: "002.001" + end_at: + description: Time when the live location expires + format: date-time + title: string + type: number + x-stream-index: "001.007" + latitude: + description: Latitude coordinate + format: float + title: number + type: number + x-stream-index: "001.004" + longitude: + description: Longitude coordinate + format: float + title: number + type: number + x-stream-index: "001.005" + message: + $ref: '#/components/schemas/MessageResponse' + x-stream-index: "001.010" + message_id: + description: Message ID + title: string + type: string + x-stream-index: "001.002" + updated_at: + description: Date/time of the last update + format: date-time + title: Updated at + type: number + x-stream-index: "001.009" + user_id: + description: User ID + title: string + type: string + x-stream-index: "001.003" + required: + - channel_cid + - message_id + - user_id + - latitude + - longitude + - created_by_device_id + - created_at + - updated_at + - duration + type: object + SharedLocationResponseData: + nullable: true + properties: + channel: + $ref: '#/components/schemas/ChannelResponse' + x-stream-index: "011" + channel_cid: + type: string + x-stream-index: "001" + created_at: + format: date-time + type: number + x-stream-index: "008" + created_by_device_id: + type: string + x-stream-index: "006" + end_at: + format: date-time + type: number + x-stream-index: "007" + latitude: + format: float + type: number + x-stream-index: "004" + longitude: + format: float + type: number + x-stream-index: "005" + message: + $ref: '#/components/schemas/MessageResponse' + x-stream-index: "010" + message_id: + type: string + x-stream-index: "002" + updated_at: + format: date-time + type: number + x-stream-index: "009" + user_id: + type: string + x-stream-index: "003" + required: + - channel_cid + - message_id + - user_id + - latitude + - longitude + - created_by_device_id + - created_at + - updated_at + type: object + SharedLocationsResponse: + nullable: true + properties: + active_live_locations: + items: + $ref: '#/components/schemas/SharedLocationResponseData' + type: array + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - active_live_locations + - duration + type: object + ShowChannelRequest: + nullable: true + type: object + ShowChannelResponse: + 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 + SingleFollowResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + follow: + $ref: '#/components/schemas/FollowResponse' + description: The created follow relationship + title: Follow + x-stream-index: "001" + required: + - follow + - duration + title: Follow Response + type: object + SortParam: + nullable: true + properties: + direction: + format: int32 + type: integer + x-stream-index: "002" + field: + type: string + x-stream-index: "001" + required: + - field + - direction + type: object + SortParamRequest: + nullable: true + properties: + direction: + description: Direction of sorting, 1 for Ascending, -1 for Descending, default + is 1 + format: int32 + title: Direction + type: integer + x-stream-index: "002" + field: + description: Name of field to sort by + title: Field + type: string + x-stream-index: "001" + type: object + StartClosedCaptionsRequest: + nullable: true + properties: + enable_transcription: + description: Enable transcriptions along with closed captions + title: Enable Transcription + type: boolean + x-stream-index: "002" + external_storage: + description: Which external storage to use for transcriptions (only applicable + if enable_transcription is true) + title: External Storage + type: string + x-stream-index: "003" + language: + description: The spoken language in the call, if not provided the language + defined in the transcription settings will be used + enum: + - auto + - en + - fr + - es + - de + - it + - nl + - pt + - pl + - ca + - cs + - da + - el + - fi + - id + - ja + - ru + - sv + - ta + - th + - tr + - hu + - ro + - zh + - ar + - tl + - he + - hi + - hr + - ko + - ms + - "no" + - uk + - bg + - et + - sl + - sk + title: Language + type: string + x-stream-index: "004" + type: object + StartClosedCaptionsResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "001.001" + required: + - duration + type: object + StartFrameRecordingRequest: + nullable: true + properties: + recording_external_storage: + type: string + x-stream-index: "002" + title: StartFrameRecordingRequest + type: object + StartFrameRecordingResponse: + description: StartFrameRecordingResponse is the response payload for the start + frame recording endpoint. + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "001.001" + required: + - duration + title: StartFrameRecordingResponse + type: object + StartHLSBroadcastingRequest: + description: StartHLSBroadcastingRequest is the payload for starting an HLS + broadcasting. + nullable: true + title: StartHLSBroadcastingRequest + type: object + StartHLSBroadcastingResponse: + description: StartHLSBroadcastingResponse is the payload for starting an HLS + broadcasting. + nullable: true + properties: + duration: + type: string + x-stream-index: "001.001" + playlist_url: + description: the URL of the HLS playlist + title: PlaylistURL + type: string + x-stream-index: "002" + required: + - duration + - playlist_url + title: StartHLSBroadcastingResponse + type: object + StartRTMPBroadcastsRequest: + description: StartRTMPBroadcastsRequest is the payload for starting RTMP broadcasts. + nullable: true + properties: + broadcasts: + description: List of broadcasts to start + items: + $ref: '#/components/schemas/RTMPBroadcastRequest' + maximum: 1 + minimum: 1 + title: Broadcasts + type: array + x-stream-index: "002" + required: + - broadcasts + title: StartRTMPBroadcastsRequest + type: object + StartRTMPBroadcastsResponse: + description: StartRTMPBroadcastsResponse is the payload for starting an RTMP + broadcast. + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "001.001" + required: + - duration + title: StartRTMPBroadcastsResponse + type: object + StartRecordingRequest: + nullable: true + properties: + recording_external_storage: + type: string + x-stream-index: "002" + title: StartRecordingRequest + type: object + StartRecordingResponse: + description: StartRecordingResponse is the response payload for the start recording + endpoint. + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "001.001" + required: + - duration + title: StartRecordingResponse + type: object + StartTranscriptionRequest: + nullable: true + properties: + enable_closed_captions: + description: Enable closed captions along with transcriptions + title: Enable Closed Captions + type: boolean + x-stream-index: "003" + language: + description: The spoken language in the call, if not provided the language + defined in the transcription settings will be used + enum: + - auto + - en + - fr + - es + - de + - it + - nl + - pt + - pl + - ca + - cs + - da + - el + - fi + - id + - ja + - ru + - sv + - ta + - th + - tr + - hu + - ro + - zh + - ar + - tl + - he + - hi + - hr + - ko + - ms + - "no" + - uk + - bg + - et + - sl + - sk + title: Language + type: string + x-stream-index: "004" + transcription_external_storage: + description: Store transcriptions in this external storage + title: External Storage + type: string + x-stream-index: "002" + type: object + StartTranscriptionResponse: + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "001.001" + required: + - duration + title: StartTranscriptionResponse + type: object + StatsOptions: + properties: + enable_rtc_stats: + type: boolean + x-stream-index: "002" + reporting_interval_ms: + format: int32 + type: integer + x-stream-index: "001" + required: + - reporting_interval_ms + - enable_rtc_stats + type: object + StopAllRTMPBroadcastsRequest: + nullable: true + title: StopAllRTMPBroadcastsRequest + type: object + StopAllRTMPBroadcastsResponse: + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "001.001" + required: + - duration + title: StopAllRTMPBroadcastsResponse + type: object + StopClosedCaptionsRequest: + nullable: true + properties: + stop_transcription: + type: boolean + x-stream-index: "003" + type: object + StopClosedCaptionsResponse: + 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 + StopFrameRecordingRequest: + nullable: true + type: object + StopFrameRecordingResponse: + 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 + StopHLSBroadcastingRequest: + nullable: true + type: object + StopHLSBroadcastingResponse: + 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 + StopLiveRequest: + nullable: true + properties: + continue_closed_caption: + type: boolean + x-stream-index: "006" + continue_hls: + type: boolean + x-stream-index: "003" + continue_recording: + type: boolean + x-stream-index: "004" + continue_rtmp_broadcasts: + type: boolean + x-stream-index: "007" + continue_transcription: + type: boolean + x-stream-index: "005" + title: StopLiveRequest + type: object + StopLiveResponse: + nullable: true + properties: + call: + $ref: '#/components/schemas/CallResponse' + description: The call that was stopped + title: Call + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - call + - duration + title: StopLiveResponse + type: object + StopRTMPBroadcastsRequest: + description: Request for stopping RTMP broadcasts + nullable: true + title: StopRTMPBroadcastsRequest + type: object + StopRTMPBroadcastsResponse: + 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 + StopRecordingRequest: + nullable: true + type: object + StopRecordingResponse: + 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 + StopTranscriptionRequest: + nullable: true + properties: + stop_closed_captions: + type: boolean + x-stream-index: "003" + type: object + StopTranscriptionResponse: + 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 + StoriesConfig: + properties: + expiration_behaviour: + enum: + - hide_for_everyone + - visible_for_author + type: string + x-stream-index: "001" + skip_watched: + type: boolean + x-stream-index: "002" + type: object + SubmitActionRequest: + nullable: true + properties: + action_type: + description: Type of moderation action to perform (mark_reviewed, delete_message, + etc.) + enum: + - mark_reviewed + - delete_message + - delete_activity + - delete_reaction + - ban + - custom + - unban + - restore + - delete_user + - unblock + - shadow_block + - unmask + - kick_user + - end_call + title: Action Type + type: string + x-stream-index: "002" + ban: + $ref: '#/components/schemas/BanActionRequest' + description: Configuration for ban action + title: Ban + x-stream-index: "008" + custom: + $ref: '#/components/schemas/CustomActionRequest' + description: Configuration for custom action + title: Custom + x-stream-index: "009" + delete_activity: + $ref: '#/components/schemas/DeleteActivityRequest' + description: Configuration for activity deletion action + title: Delete Activity + x-stream-index: "004" + delete_message: + $ref: '#/components/schemas/DeleteMessageRequest' + description: Configuration for message deletion action + title: Delete Message + x-stream-index: "003" + delete_reaction: + $ref: '#/components/schemas/DeleteReactionRequest' + description: Configuration for reaction deletion action + title: Delete Reaction + x-stream-index: "005" + delete_user: + $ref: '#/components/schemas/DeleteUserRequest' + description: Configuration for user deletion action + title: Delete User + x-stream-index: "006" + item_id: + description: UUID of the review queue item to act on + title: Item ID + type: string + x-stream-index: "001" + mark_reviewed: + $ref: '#/components/schemas/MarkReviewedRequest' + description: Configuration for marking item as reviewed + title: Mark Reviewed + x-stream-index: "007" + unban: + $ref: '#/components/schemas/UnbanActionRequest' + description: Configuration for unban action + title: Unban + x-stream-index: "010" + required: + - item_id + - action_type + type: object + SubmitActionResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + item: + $ref: '#/components/schemas/ReviewQueueItemResponse' + description: Updated review queue item after action was performed + title: Item + x-stream-index: "001" + required: + - duration + type: object + SubscriberStatsResponse: + properties: + total: + format: int32 + type: integer + x-stream-index: "001" + total_subscribed_duration_seconds: + format: int32 + type: integer + x-stream-index: "003" + unique: + format: int32 + type: integer + x-stream-index: "002" + required: + - total + - unique + - total_subscribed_duration_seconds + type: object + SyncRequest: + description: Sync request + nullable: true + properties: + channel_cids: + description: List of channel CIDs to sync + items: + type: string + maximum: 255 + minimum: 1 + title: Channel CIDs + type: array + x-stream-index: "001" + last_sync_at: + description: Date from which synchronization should happen + format: date-time + title: Last sync at + type: number + x-stream-index: "002" + required: + - channel_cids + - last_sync_at + title: SyncRequest + type: object + SyncResponse: + description: Sync response + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "003.001" + events: + description: List of events + items: + $ref: '#/components/schemas/WSEvent' + title: Events + type: array + x-stream-index: "001" + inaccessible_cids: + description: List of CIDs that user can't access + items: + type: string + title: Inaccessible CIDs + type: array + x-stream-index: "002" + required: + - events + - duration + title: SyncResponse + type: object + TargetResolution: + properties: + bitrate: + format: int32 + maximum: 6000000 + type: integer + x-stream-index: "003" + height: + format: int32 + maximum: 3840 + minimum: 240 + type: integer + x-stream-index: "002" + width: + format: int32 + maximum: 3840 + minimum: 240 + type: integer + x-stream-index: "001" + required: + - width + - height + type: object + TextContentParameters: + properties: + blocklist_match: + items: + type: string + type: array + x-stream-index: "005" + contains_url: + type: boolean + x-stream-index: "003" + harm_labels: + items: + type: string + type: array + x-stream-index: "001" + llm_harm_labels: + additionalProperties: + type: string + type: object + x-stream-index: "002" + severity: + type: string + x-stream-index: "004" + type: object + TextRuleParameters: + properties: + blocklist_match: + items: + type: string + type: array + x-stream-index: "007" + contains_url: + type: boolean + x-stream-index: "005" + harm_labels: + items: + type: string + type: array + x-stream-index: "003" + llm_harm_labels: + additionalProperties: + type: string + type: object + x-stream-index: "004" + severity: + type: string + x-stream-index: "006" + threshold: + format: int32 + type: integer + x-stream-index: "001" + time_window: + type: string + x-stream-index: "002" + type: object + ThreadParticipant: + description: Represents a user that is participating in a thread. + nullable: true + properties: + app_pk: + format: int32 + readOnly: true + type: integer + x-stream-index: "001" + channel_cid: + type: string + x-stream-index: "002" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: "007" + custom: + additionalProperties: {} + type: object + x-stream-index: "010" + last_read_at: + format: date-time + type: number + x-stream-index: "009" + last_thread_message_at: + format: date-time + type: number + x-stream-index: "003" + left_thread_at: + description: Left Thread At is the time when the user left the thread + format: date-time + title: Left Thread At + type: number + x-stream-index: "008" + thread_id: + description: Thead ID is unique string identifier of the thread + title: ID + type: string + x-stream-index: "004" + user: + $ref: '#/components/schemas/UserResponse' + description: User is the user object + title: User + x-stream-index: "006" + user_id: + description: User ID is unique string identifier of the user + title: User ID + type: string + x-stream-index: "005" + required: + - app_pk + - channel_cid + - created_at + - last_read_at + - custom + title: ThreadParticipant + type: object + ThreadResponse: + properties: + active_participant_count: + description: Active Participant Count + format: int32 + title: Active Participant Count + type: integer + x-stream-index: "009" + channel: + $ref: '#/components/schemas/ChannelResponse' + description: Channel + title: ChannelResponse + x-stream-index: "002" + channel_cid: + description: Channel CID + title: Channel CID + type: string + x-stream-index: "001" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: "012" + created_by: + $ref: '#/components/schemas/UserResponse' + description: Created By User + title: User + x-stream-index: "006" + created_by_user_id: + description: Created By User ID + title: Created By User ID + type: string + x-stream-index: "005" + custom: + additionalProperties: {} + description: Custom data for this object + title: Custom data + type: object + x-stream-index: "016" + deleted_at: + description: Deleted At + format: date-time + title: Deleted At + type: number + x-stream-index: "014" + last_message_at: + description: Last Message At + format: date-time + title: Last Message At + type: number + x-stream-index: "011" + parent_message: + $ref: '#/components/schemas/MessageResponse' + description: Parent Message + title: Message + x-stream-index: "004" + parent_message_id: + description: Parent Message ID + title: Parent Message ID + type: string + x-stream-index: "003" + participant_count: + description: Participant Count + format: int32 + title: Participant Count + type: integer + x-stream-index: "008" + reply_count: + description: Reply Count + format: int32 + title: Reply Count + type: integer + x-stream-index: "007" + thread_participants: + description: Thread Participants + items: + $ref: '#/components/schemas/ThreadParticipant' + title: ThreadParticipants + type: array + x-stream-index: "010" + title: + description: Title + title: Title + type: string + x-stream-index: "015" + updated_at: + description: Date/time of the last update + format: date-time + title: Updated at + type: number + x-stream-index: "013" + required: + - channel_cid + - parent_message_id + - created_by_user_id + - created_at + - updated_at + - title + - custom + type: object + ThreadStateResponse: + nullable: true + properties: + active_participant_count: + description: Active Participant Count + format: int32 + title: Active Participant Count + type: integer + x-stream-index: "001.009" + channel: + $ref: '#/components/schemas/ChannelResponse' + description: Channel + title: ChannelResponse + x-stream-index: "001.002" + channel_cid: + description: Channel CID + title: Channel CID + type: string + x-stream-index: "001.001" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: "001.012" + created_by: + $ref: '#/components/schemas/UserResponse' + description: Created By User + title: User + x-stream-index: "001.006" + created_by_user_id: + description: Created By User ID + title: Created By User ID + type: string + x-stream-index: "001.005" + custom: + additionalProperties: {} + description: Custom data for this object + title: Custom data + type: object + x-stream-index: "001.016" + deleted_at: + description: Deleted At + format: date-time + title: Deleted At + type: number + x-stream-index: "001.014" + draft: + $ref: '#/components/schemas/DraftResponse' + x-stream-index: "004" + last_message_at: + description: Last Message At + format: date-time + title: Last Message At + type: number + x-stream-index: "001.011" + latest_replies: + items: + $ref: '#/components/schemas/MessageResponse' + type: array + x-stream-index: "002" + parent_message: + $ref: '#/components/schemas/MessageResponse' + description: Parent Message + title: Message + x-stream-index: "001.004" + parent_message_id: + description: Parent Message ID + title: Parent Message ID + type: string + x-stream-index: "001.003" + participant_count: + description: Participant Count + format: int32 + title: Participant Count + type: integer + x-stream-index: "001.008" + read: + items: + $ref: '#/components/schemas/ReadStateResponse' + type: array + x-stream-index: "003" + reply_count: + description: Reply Count + format: int32 + title: Reply Count + type: integer + x-stream-index: "001.007" + thread_participants: + description: Thread Participants + items: + $ref: '#/components/schemas/ThreadParticipant' + title: ThreadParticipants + type: array + x-stream-index: "001.010" + title: + description: Title + title: Title + type: string + x-stream-index: "001.015" + updated_at: + description: Date/time of the last update + format: date-time + title: Updated at + type: number + x-stream-index: "001.013" + required: + - channel_cid + - parent_message_id + - created_by_user_id + - created_at + - updated_at + - title + - custom + - latest_replies + type: object + ThreadUpdatedEvent: + properties: + channel_id: + type: string + x-stream-index: "001.002" + channel_type: + type: string + x-stream-index: "001.003" + cid: + type: string + x-stream-index: "001.001" + created_at: + format: date-time + type: number + x-stream-index: "004.002" + thread: + $ref: '#/components/schemas/ThreadResponse' + x-stream-index: "003.001" + type: + default: thread.updated + type: string + x-stream-index: "004.001" + user: + $ref: '#/components/schemas/User' + x-stream-index: "002.001" + required: + - cid + - channel_id + - channel_type + - type + - created_at + title: ThreadUpdatedEvent + 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 + ThreadedCommentResponse: + description: A comment with an optional, depth‑limited slice of nested replies. + properties: + attachments: + items: + $ref: '#/components/schemas/Attachment' + type: array + x-stream-index: "001.011" + confidence_score: + format: float + type: number + x-stream-index: "001.022" + controversy_score: + format: float + type: number + x-stream-index: "001.023" + created_at: + format: date-time + type: number + x-stream-index: "001.014" + custom: + additionalProperties: {} + type: object + x-stream-index: "001.006" + deleted_at: + format: date-time + type: number + x-stream-index: "001.016" + downvote_count: + format: int32 + type: integer + x-stream-index: "001.020" + id: + type: string + x-stream-index: "001.001" + latest_reactions: + items: + $ref: '#/components/schemas/FeedsReactionResponse' + type: array + x-stream-index: "001.009" + mentioned_users: + items: + $ref: '#/components/schemas/UserResponse' + type: array + x-stream-index: "001.012" + meta: + $ref: '#/components/schemas/RepliesMeta' + description: Pagination & depth info for this node's direct replies. + title: Replies Meta + x-stream-index: "002" + moderation: + $ref: '#/components/schemas/ModerationV2Response' + x-stream-index: "001.017" + object_id: + type: string + x-stream-index: "001.002" + object_type: + type: string + x-stream-index: "001.003" + own_reactions: + items: + $ref: '#/components/schemas/FeedsReactionResponse' + type: array + x-stream-index: "001.024" + parent_id: + type: string + x-stream-index: "001.007" + reaction_count: + format: int32 + type: integer + x-stream-index: "001.008" + reaction_groups: + additionalProperties: + $ref: '#/components/schemas/ReactionGroupResponse' + type: object + x-stream-index: "001.010" + replies: + description: Slice of nested comments (may be empty). + items: + $ref: '#/components/schemas/ThreadedCommentResponse' + title: Replies + type: array + x-stream-index: "003" + reply_count: + format: int32 + type: integer + x-stream-index: "001.018" + score: + format: int32 + type: integer + x-stream-index: "001.021" + status: + type: string + x-stream-index: "001.013" + text: + type: string + x-stream-index: "001.005" + updated_at: + format: date-time + type: number + x-stream-index: "001.015" + upvote_count: + format: int32 + type: integer + x-stream-index: "001.019" + user: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "001.004" + required: + - id + - object_id + - object_type + - user + - reaction_count + - mentioned_users + - status + - created_at + - updated_at + - reply_count + - upvote_count + - downvote_count + - score + - confidence_score + - own_reactions + title: Threaded Comment + type: object + Thresholds: + description: Sets thresholds for AI moderation + properties: + explicit: + $ref: '#/components/schemas/LabelThresholds' + description: Thresholds for explicit messages + title: LabelThresholds + x-stream-index: "001" + spam: + $ref: '#/components/schemas/LabelThresholds' + description: Thresholds for spam + title: LabelThresholds + x-stream-index: "002" + toxic: + $ref: '#/components/schemas/LabelThresholds' + description: Thresholds for toxic messages + title: LabelThresholds + x-stream-index: "003" + title: Auto moderation thresholds + type: object + ThumbnailResponse: + properties: + image_url: + type: string + x-stream-index: "001" + required: + - image_url + type: object + ThumbnailsSettings: + properties: + enabled: + type: boolean + x-stream-index: "001" + required: + - enabled + type: object + ThumbnailsSettingsRequest: + properties: + enabled: + type: boolean + x-stream-index: "001" + type: object + ThumbnailsSettingsResponse: + properties: + enabled: + type: boolean + x-stream-index: "001" + required: + - enabled + type: object + Time: + type: object + TrackStatsResponse: + nullable: true + properties: + duration_seconds: + format: int32 + type: integer + x-stream-index: "002" + track_type: + type: string + x-stream-index: "001" + required: + - track_type + - duration_seconds + type: object + TranscriptionSettings: + properties: + closed_caption_mode: + enum: + - available + - disabled + - auto-on + title: Mode + type: string + x-stream-index: "002" + language: + description: The language used in this call as a two letter code + enum: + - auto + - en + - fr + - es + - de + - it + - nl + - pt + - pl + - ca + - cs + - da + - el + - fi + - id + - ja + - ru + - sv + - ta + - th + - tr + - hu + - ro + - zh + - ar + - tl + - he + - hi + - hr + - ko + - ms + - "no" + - uk + - bg + - et + - sl + - sk + title: Language + type: string + x-stream-index: "004" + mode: + enum: + - available + - disabled + - auto-on + title: Mode + type: string + x-stream-index: "001" + required: + - mode + - closed_caption_mode + - languages + - language + type: object + TranscriptionSettingsRequest: + properties: + closed_caption_mode: + enum: + - available + - disabled + - auto-on + type: string + x-stream-index: "002" + language: + enum: + - auto + - en + - fr + - es + - de + - it + - nl + - pt + - pl + - ca + - cs + - da + - el + - fi + - id + - ja + - ru + - sv + - ta + - th + - tr + - hu + - ro + - zh + - ar + - tl + - he + - hi + - hr + - ko + - ms + - "no" + - uk + - bg + - et + - sl + - sk + type: string + x-stream-index: "004" + mode: + enum: + - available + - disabled + - auto-on + type: string + x-stream-index: "001" + required: + - mode + type: object + TranscriptionSettingsResponse: + properties: + closed_caption_mode: + enum: + - available + - disabled + - auto-on + type: string + x-stream-index: "002" + language: + enum: + - auto + - en + - fr + - es + - de + - it + - nl + - pt + - pl + - ca + - cs + - da + - el + - fi + - id + - ja + - ru + - sv + - ta + - th + - tr + - hu + - ro + - zh + - ar + - tl + - he + - hi + - hr + - ko + - ms + - "no" + - uk + - bg + - et + - sl + - sk + type: string + x-stream-index: "004" + mode: + enum: + - available + - disabled + - auto-on + type: string + x-stream-index: "001" + required: + - mode + - closed_caption_mode + - languages + - language + type: object + TranslateMessageRequest: + nullable: true + properties: + language: + description: Language to translate message to + enum: + - af + - sq + - am + - ar + - az + - bn + - bs + - bg + - zh + - zh-TW + - hr + - cs + - da + - fa-AF + - nl + - en + - et + - fi + - fr + - fr-CA + - ka + - de + - el + - ha + - he + - hi + - hu + - id + - it + - ja + - ko + - lv + - ms + - "no" + - fa + - ps + - pl + - pt + - ro + - ru + - sr + - sk + - sl + - so + - es + - es-MX + - sw + - sv + - tl + - ta + - th + - tr + - uk + - ur + - vi + - lt + - ht + title: Language + type: string + x-stream-index: "001" + required: + - language + type: object + TruncateChannelRequest: + nullable: true + properties: + hard_delete: + description: Permanently delete channel data (messages, reactions, etc.) + title: Hard delete + type: boolean + x-stream-index: "002" + member_ids: + description: List of member IDs to hide message history for. If empty, truncates + the channel for all members + items: + type: string + maximum: 100 + title: Member IDs + type: array + x-stream-index: "007" + message: + $ref: '#/components/schemas/MessageRequest' + x-stream-index: "004" + skip_push: + description: When `message` is set disables all push notifications for it + title: Skip push + type: boolean + x-stream-index: "005" + truncated_at: + description: Truncate channel data up to `truncated_at`. The system message + (if provided) creation time is always greater than `truncated_at` + format: date-time + title: Truncated at + type: number + x-stream-index: "006" + type: object + TruncateChannelResponse: + nullable: true + properties: + channel: + $ref: '#/components/schemas/ChannelResponse' + description: Truncated channel object + title: Channel + x-stream-index: "002" + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "001.001" + message: + $ref: '#/components/schemas/MessageResponse' + description: Truncated message object + title: Message + x-stream-index: "003" + required: + - duration + type: object + TypingIndicators: + properties: + enabled: + type: boolean + x-stream-index: "001" + required: + - enabled + type: object + TypingIndicatorsResponse: + properties: + enabled: + type: boolean + x-stream-index: "001" + required: + - enabled + type: object + TypingStartEvent: + properties: + channel_id: + type: string + x-stream-index: "003.002" + channel_type: + type: string + x-stream-index: "003.003" + cid: + type: string + x-stream-index: "003.001" + created_at: + format: date-time + type: number + x-stream-index: "004.002" + parent_id: + type: string + x-stream-index: "001" + type: + default: typing.start + type: string + x-stream-index: "004.001" + user: + $ref: '#/components/schemas/User' + x-stream-index: "002.001" + required: + - cid + - channel_id + - channel_type + - type + - created_at + title: TypingStartEvent + 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 + TypingStopEvent: + properties: + channel_id: + type: string + x-stream-index: "002.002" + channel_type: + type: string + x-stream-index: "002.003" + cid: + type: string + x-stream-index: "002.001" + created_at: + format: date-time + type: number + x-stream-index: "004.002" + parent_id: + type: string + x-stream-index: "001" + type: + default: typing.stop + type: string + x-stream-index: "004.001" + user: + $ref: '#/components/schemas/User' + x-stream-index: "003.001" + required: + - cid + - channel_id + - channel_type + - type + - created_at + title: TypingStopEvent + 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 + UnbanActionRequest: + type: object + UnblockActionRequest: + type: object + UnblockUserRequest: + description: UnblockUserRequest is the payload for unblocking a user. + nullable: true + properties: + user_id: + description: the user to unblock + title: UserID + type: string + x-stream-index: "003" + required: + - user_id + title: UnblockUserRequest + type: object + UnblockUserResponse: + description: UnblockUserResponse is the payload for unblocking a user. + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "001.001" + required: + - duration + title: UnblockUserResponse + type: object + UnblockUsersRequest: + nullable: true + properties: + blocked_user_id: + type: string + x-stream-index: "001" + required: + - blocked_user_id + type: object + UnblockUsersResponse: + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "001.001" + required: + - duration + type: object + UnblockedUserEvent: + description: |- + This event is sent when a user is unblocked on a call, + this can be useful to notify the user that they can now join the call again + properties: + call_cid: + type: string + x-stream-index: "002.001" + created_at: + format: date-time + type: number + x-stream-index: "001.002" + type: + default: call.unblocked_user + description: 'The type of event: "call.unblocked_user" in this case' + title: Event Type + type: string + x-stream-index: "001.001" + user: + $ref: '#/components/schemas/UserResponse' + description: The user that was unblocked + title: User + x-stream-index: "003" + required: + - type + - created_at + - call_cid + - user + title: UnblockedUserEvent + type: object + x-stream-event-call-type: true + x-stream-event-doc-group: call + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + UnfollowResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + follow: + $ref: '#/components/schemas/FollowResponse' + description: The deleted follow relationship + title: Follow + x-stream-index: "001" + required: + - follow + - duration + title: Unfollow Response + type: object + UnmuteChannelRequest: + nullable: true + properties: + channel_cids: + description: Channel CIDs to mute (if multiple channels) + items: + type: string + maximum: 25 + title: Channel CIDs + type: array + x-stream-index: "001.002" + expiration: + description: Duration of mute in milliseconds + title: Expiration + type: integer + x-stream-index: "001.003" + type: object + UnmuteResponse: + description: Basic response information + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "002.001" + non_existing_users: + items: + type: string + type: array + x-stream-index: "001" + required: + - duration + title: Response + type: object + UnpinActivityResponse: + nullable: true + properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + description: The unpinned activity + title: Activity + x-stream-index: "001" + duration: + type: string + x-stream-index: "004.001" + feed: + description: Fully qualified ID of the feed the activity was unpinned from + title: Feed ID + type: string + x-stream-index: "002" + user_id: + description: ID of the user who unpinned the activity + title: User ID + type: string + x-stream-index: "003" + required: + - activity + - feed + - user_id + - duration + title: Unpin Activity Response + type: object + UnpinRequest: + description: UnpinRequest is the payload for unpinning a message. + nullable: true + properties: + session_id: + description: the session ID of the user who pinned the message + title: SessionID + type: string + x-stream-index: "003" + user_id: + description: the user ID of the user who pinned the message + title: UserID + type: string + x-stream-index: "002" + required: + - user_id + - session_id + title: UnpinRequest + type: object + UnpinResponse: + description: UnpinResponse is the payload for unpinning a message. + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "001.001" + required: + - duration + title: UnpinResponse + type: object + UnreadCountsChannel: + properties: + channel_id: + type: string + x-stream-index: "001" + last_read: + format: date-time + type: number + x-stream-index: "003" + unread_count: + format: int32 + type: integer + x-stream-index: "002" + required: + - channel_id + - unread_count + - last_read + type: object + UnreadCountsChannelType: + properties: + channel_count: + format: int32 + type: integer + x-stream-index: "002" + channel_type: + type: string + x-stream-index: "001" + unread_count: + format: int32 + type: integer + x-stream-index: "003" + required: + - channel_type + - channel_count + - unread_count + type: object + UnreadCountsThread: + properties: + last_read: + format: date-time + type: number + x-stream-index: "002" + last_read_message_id: + type: string + x-stream-index: "003" + parent_message_id: + type: string + x-stream-index: "004" + unread_count: + format: int32 + type: integer + x-stream-index: "001" + required: + - unread_count + - last_read + - last_read_message_id + - parent_message_id + type: object + UpdateActivityPartialRequest: + nullable: true + properties: + set: + additionalProperties: {} + description: Map of dot-notation field paths to new values + title: object + type: object + x-stream-index: "002" + unset: + description: List of dot-notation paths to remove + items: + type: string + title: '[]string' + type: array + x-stream-index: "003" + type: object + UpdateActivityPartialResponse: + nullable: true + properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + description: The updated activity + title: ActivityResponse + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - activity + - duration + type: object + UpdateActivityRequest: + nullable: true + properties: + attachments: + description: List of attachments for the activity + items: + $ref: '#/components/schemas/Attachment' + title: '[]ActivityAttachment' + type: array + x-stream-index: "003" + custom: + additionalProperties: {} + description: Custom data for the activity + title: object + type: object + x-stream-index: "004" + expires_at: + description: Time when the activity will expire + format: date-time + title: string + type: number + x-stream-index: "007" + filter_tags: + description: Tags used for filtering the activity + items: + type: string + title: '[]string' + type: array + x-stream-index: "008" + interest_tags: + description: Tags indicating interest categories + items: + type: string + title: '[]string' + type: array + x-stream-index: "009" + location: + $ref: '#/components/schemas/ActivityLocation' + description: Geographic location for the activity + title: ActivityLocation + x-stream-index: "006" + poll_id: + description: Poll ID + title: string + type: string + x-stream-index: "010" + text: + description: The text content of the activity + title: string + type: string + x-stream-index: "002" + visibility: + description: Visibility setting for the activity + title: string + type: string + x-stream-index: "005" + type: object + UpdateActivityResponse: + nullable: true + properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + description: The updated activity + title: ActivityResponse + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - activity + - duration + type: object + UpdateBlockListRequest: + nullable: true + properties: + team: + type: string + x-stream-index: "002" + words: + description: List of words to block + items: + type: string + minimum: 1 + title: Words + type: array + x-stream-index: "003" + title: Update block list + type: object + x-stream-docs-page-id: update_block_list + UpdateBlockListResponse: + description: Basic response information + nullable: true + properties: + blocklist: + $ref: '#/components/schemas/BlockListResponse' + x-stream-index: "001" + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "002.001" + required: + - duration + title: Response + type: object + UpdateBookmarkFolderRequest: + nullable: true + properties: + custom: + additionalProperties: {} + description: Custom data for the folder + title: Custom Data + type: object + x-stream-index: "003" + name: + description: Name of the folder + maxLength: 255 + title: Name + type: string + x-stream-index: "002" + title: Update Bookmark Folder Request + type: object + UpdateBookmarkFolderResponse: + nullable: true + properties: + bookmark_folder: + $ref: '#/components/schemas/BookmarkFolderResponse' + description: The updated bookmark folder + title: Bookmark Folder + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - bookmark_folder + - duration + title: Update Bookmark Folder Response + type: object + UpdateBookmarkRequest: + nullable: true + properties: + custom: + additionalProperties: {} + description: Custom data for the bookmark + title: Custom Data + type: object + x-stream-index: "005" + folder_id: + description: ID of the folder to move the bookmark to + maxLength: 255 + title: Folder ID + type: string + x-stream-index: "002" + new_folder: + $ref: '#/components/schemas/AddFolderRequest' + x-stream-index: "004" + new_folder_id: + maxLength: 255 + type: string + x-stream-index: "003" + title: Update Bookmark Request + type: object + UpdateBookmarkResponse: + nullable: true + properties: + bookmark: + $ref: '#/components/schemas/BookmarkResponse' + description: The updated bookmark + title: Bookmark + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - bookmark + - duration + title: Update Bookmark Response + type: object + UpdateCallMembersRequest: + description: Update call members + nullable: true + properties: + remove_members: + description: List of userID to remove + items: + type: string + maximum: 100 + title: Remove Members + type: array + x-stream-index: "003" + update_members: + description: List of members to update or insert + items: + $ref: '#/components/schemas/MemberRequest' + maximum: 100 + title: Update Members + type: array + x-stream-index: "004" + title: UpdateCallMembersRequest + type: object + UpdateCallMembersResponse: + description: Basic response information + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "001.001" + members: + items: + $ref: '#/components/schemas/MemberResponse' + type: array + x-stream-index: "002" + required: + - duration + - members + title: Response + type: object + UpdateCallRequest: + description: Request for updating a call + nullable: true + properties: + custom: + additionalProperties: {} + description: Custom data for this object + title: Custom data + type: object + x-stream-index: "003" + settings_override: + $ref: '#/components/schemas/CallSettingsRequest' + description: the settings to change for this call + title: Settings Override + x-stream-index: "004" + starts_at: + description: the time the call is scheduled to start + format: date-time + title: Starts At + type: number + x-stream-index: "005" + title: UpdateCallRequest + type: object + UpdateCallResponse: + description: Response for updating a call + nullable: true + properties: + call: + $ref: '#/components/schemas/CallResponse' + x-stream-index: "001.001" + duration: + type: string + x-stream-index: "002.001" + members: + items: + $ref: '#/components/schemas/MemberResponse' + type: array + x-stream-index: "001.002" + membership: + $ref: '#/components/schemas/MemberResponse' + x-stream-index: "001.003" + own_capabilities: + items: + $ref: '#/components/schemas/OwnCapability' + type: array + x-stream-index: "001.004" + required: + - call + - members + - own_capabilities + - blocked_users + - duration + title: UpdateCallResponse + type: object + UpdateChannelPartialRequest: + nullable: true + properties: + set: + additionalProperties: {} + type: object + x-stream-index: "002.001" + unset: + items: + type: string + type: array + x-stream-index: "002.002" + title: UpdateChannelPartialRequest + type: object + UpdateChannelPartialResponse: + nullable: true + properties: + channel: + $ref: '#/components/schemas/ChannelResponse' + description: Updated channel object + title: Channel + x-stream-index: "001" + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "003.001" + members: + description: List of updated members + items: + $ref: '#/components/schemas/ChannelMemberResponse' + title: ChannelMemberResponse + type: array + x-stream-index: "002" + required: + - members + - duration + type: object + UpdateChannelRequest: + nullable: true + properties: + accept_invite: + description: Set to `true` to accept the invite + title: Accept invite + type: boolean + x-stream-index: "008" + add_members: + description: List of user IDs to add to the channel + items: + $ref: '#/components/schemas/ChannelMember' + maximum: 100 + title: Add members + type: array + x-stream-index: "001" + add_moderators: + description: List of user IDs to make channel moderators + items: + type: string + maximum: 100 + title: Add moderators + type: array + x-stream-index: "003" + assign_roles: + description: List of channel member role assignments. If any specified user + is not part of the channel, the request will fail + items: + $ref: '#/components/schemas/ChannelMember' + maximum: 100 + title: Assign roles + type: array + x-stream-index: "006" + cooldown: + description: Sets cool down period for the channel in seconds + format: int32 + maximum: 120 + minimum: 0 + title: Cool down + type: integer + x-stream-index: "007" + data: + $ref: '#/components/schemas/ChannelInput' + x-stream-index: "013.001" + demote_moderators: + description: List of user IDs to take away moderators status from + items: + type: string + maximum: 100 + title: Demote moderators + type: array + x-stream-index: "004" + hide_history: + description: Set to `true` to hide channel's history when adding new members + title: Hide history + type: boolean + x-stream-index: "012" + invites: + description: List of user IDs to invite to the channel + items: + $ref: '#/components/schemas/ChannelMember' + maximum: 100 + title: Invites + type: array + x-stream-index: "005" + message: + $ref: '#/components/schemas/MessageRequest' + description: Message to send to the chat when channel is successfully updated + title: Message + x-stream-index: "010" + reject_invite: + description: Set to `true` to reject the invite + title: Reject invite + type: boolean + x-stream-index: "009" + remove_members: + description: List of user IDs to remove from the channel + items: + type: string + maximum: 100 + title: Remove members + type: array + x-stream-index: "002" + skip_push: + description: When `message` is set disables all push notifications for it + title: Skip push + type: boolean + x-stream-index: "011" + title: Channel update request + type: object + x-stream-docs-page-id: channel_update + UpdateChannelResponse: + nullable: true + properties: + channel: + $ref: '#/components/schemas/ChannelResponse' + description: Updated channel + title: Channel + x-stream-index: "001" + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "004.001" + members: + description: List of channel members + items: + $ref: '#/components/schemas/ChannelMember' + title: Members + type: array + x-stream-index: "003" + message: + $ref: '#/components/schemas/MessageResponse' + description: Message sent to the chat + title: Message + x-stream-index: "002" + required: + - members + - duration + type: object + UpdateCommentRequest: + nullable: true + properties: + comment: + description: Updated text content of the comment + title: Comment + type: string + x-stream-index: "002" + custom: + additionalProperties: {} + description: Updated custom data for the comment + title: Custom Data + type: object + x-stream-index: "003" + skip_push: + type: boolean + x-stream-index: "004" + title: Update Comment Request + type: object + UpdateCommentResponse: + nullable: true + properties: + comment: + $ref: '#/components/schemas/CommentResponse' + description: The updated comment + title: Comment + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - comment + - duration + title: Update Comment Response + type: object + UpdateFeedMembersRequest: + nullable: true + properties: + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "006.001" + members: + description: List of members to upsert, remove, or set + items: + $ref: '#/components/schemas/FeedMemberRequest' + title: Members + type: array + x-stream-index: "004" + next: + type: string + x-stream-index: "006.002" + operation: + description: Type of update operation to perform + enum: + - upsert + - remove + - set + title: Operation + type: string + x-stream-index: "003" + prev: + type: string + x-stream-index: "006.003" + required: + - operation + title: Update Feed Members Request + type: object + UpdateFeedMembersResponse: + description: Basic response information + nullable: true + properties: + added: + items: + $ref: '#/components/schemas/FeedMemberResponse' + type: array + x-stream-index: "001" + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "004.001" + removed_ids: + items: + type: string + type: array + x-stream-index: "003" + updated: + items: + $ref: '#/components/schemas/FeedMemberResponse' + type: array + x-stream-index: "002" + required: + - added + - updated + - removed_ids + - duration + title: Response + type: object + UpdateFeedRequest: + nullable: true + properties: + custom: + additionalProperties: {} + description: Custom data for the feed + title: Custom Data + type: object + x-stream-index: "004" + title: Update Feed Request + type: object + UpdateFeedResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + feed: + $ref: '#/components/schemas/FeedResponse' + description: The updated feed + title: Feed + x-stream-index: "001" + required: + - feed + - duration + title: Update Feed Response + type: object + UpdateFollowRequest: + nullable: true + properties: + create_notification_activity: + description: Whether to create a notification activity for this follow + title: Create Notification Activity + type: boolean + x-stream-index: "001.004" + custom: + additionalProperties: {} + description: Custom data for the follow relationship + title: Custom Data + type: object + x-stream-index: "001.002" + follower_role: + type: string + x-stream-index: "002" + push_preference: + description: Push preference for the follow relationship + enum: + - all + - none + title: Push Preference + type: string + x-stream-index: "001.003" + skip_push: + type: boolean + x-stream-index: "001.005" + source: + description: Fully qualified ID of the source feed + maxLength: 255 + title: Source Feed + type: string + x-stream-index: 001.001.001 + target: + description: Fully qualified ID of the target feed + maxLength: 255 + title: Target Feed + type: string + x-stream-index: 001.001.002 + required: + - source + - target + title: Update Follow Request + type: object + UpdateFollowResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + follow: + $ref: '#/components/schemas/FollowResponse' + description: Details of the updated follow relationship + title: Follow + x-stream-index: "001" + required: + - follow + - duration + title: Update Follow Response + type: object + UpdateLiveLocationRequest: + nullable: true + properties: + end_at: + description: Time when the live location expires + format: date-time + title: string + type: number + x-stream-index: "004" + latitude: + description: Latitude coordinate + format: float + maximum: 90 + minimum: 1.8446744073709552e+19 + title: number + type: number + x-stream-index: "002" + longitude: + description: Longitude coordinate + format: float + maximum: 180 + minimum: 1.8446744073709552e+19 + title: number + type: number + x-stream-index: "003" + message_id: + description: Live location ID + title: string + type: string + x-stream-index: "001" + required: + - message_id + type: object + UpdateMemberPartialRequest: + nullable: true + properties: + set: + additionalProperties: {} + type: object + x-stream-index: "002.001" + unset: + items: + type: string + type: array + x-stream-index: "002.002" + type: object + UpdateMemberPartialResponse: + nullable: true + properties: + channel_member: + $ref: '#/components/schemas/ChannelMemberResponse' + description: Updated channel member + title: Channel member + x-stream-index: "001" + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "002.001" + required: + - duration + type: object + UpdateMessagePartialRequest: + nullable: true + properties: + set: + additionalProperties: {} + description: Sets new field values + title: Set + type: object + x-stream-index: "002.001" + x-stream-map: + description: New value to set + key: field + title: Value + skip_enrich_url: + description: Skip enriching the URL in the message + title: SkipEnrichURL + type: boolean + x-stream-index: "001" + unset: + description: Array of field names to unset + items: + type: string + title: Unset + type: array + x-stream-index: "002.002" + type: object + UpdateMessagePartialResponse: + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "003.001" + message: + $ref: '#/components/schemas/MessageResponse' + description: Updated message + title: Message + x-stream-index: "001" + pending_message_metadata: + additionalProperties: + type: string + description: Pending message metadata + title: PendingMessageMetadata + type: object + x-stream-index: "002" + required: + - duration + type: object + UpdateMessageRequest: + nullable: true + properties: + message: + $ref: '#/components/schemas/MessageRequest' + description: Message + title: MessageRequest + x-stream-index: "001" + skip_enrich_url: + description: Skip enrich URL + title: boolean + type: boolean + x-stream-index: "003" + skip_push: + type: boolean + x-stream-index: "002" + required: + - message + type: object + UpdateMessageResponse: + description: Basic response information + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "003.001" + message: + $ref: '#/components/schemas/MessageResponse' + x-stream-index: "001" + pending_message_metadata: + additionalProperties: + type: string + type: object + x-stream-index: "002" + required: + - message + - duration + title: Response + type: object + UpdatePollOptionRequest: + nullable: true + properties: + Custom: + additionalProperties: {} + type: object + writeOnly: true + x-stream-index: "004" + id: + description: Option ID + maxLength: 255 + title: string + type: string + x-stream-index: "002" + text: + description: Option text + title: string + type: string + x-stream-index: "003" + required: + - id + - text + type: object + UpdatePollPartialRequest: + nullable: true + properties: + set: + additionalProperties: {} + description: Sets new field values + title: Set + type: object + x-stream-index: "002.001" + x-stream-map: + description: New value to set + key: field + title: Value + unset: + description: Array of field names to unset + items: + type: string + title: Unset + type: array + x-stream-index: "002.002" + type: object + UpdatePollRequest: + nullable: true + properties: + Custom: + additionalProperties: {} + type: object + writeOnly: true + x-stream-index: "011" + allow_answers: + description: Allow answers + title: boolean + type: boolean + x-stream-index: "009" + allow_user_suggested_options: + description: Allow user suggested options + title: boolean + type: boolean + x-stream-index: "008" + description: + description: Poll description + title: string + type: string + x-stream-index: "003" + enforce_unique_vote: + description: Enforce unique vote + title: boolean + type: boolean + x-stream-index: "005" + id: + description: Poll ID + maxLength: 255 + title: string + type: string + x-stream-index: "001" + is_closed: + description: Is closed + title: boolean + type: boolean + x-stream-index: "010" + max_votes_allowed: + description: Max votes allowed + format: int32 + maximum: 10 + title: integer + type: integer + x-stream-index: "007" + name: + description: Poll name + title: string + type: string + x-stream-index: "002" + options: + description: Poll options + items: + $ref: '#/components/schemas/PollOptionRequest' + maximum: 100 + title: PollOptions + type: array + x-stream-index: "004" + voting_visibility: + description: Voting visibility + enum: + - anonymous + - public + title: string + type: string + x-stream-index: "006" + required: + - id + - name + type: object + UpdateReminderRequest: + nullable: true + properties: + remind_at: + format: date-time + type: number + x-stream-index: "001" + type: object + UpdateReminderResponse: + description: Basic response information + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "002.001" + reminder: + $ref: '#/components/schemas/ReminderResponseData' + x-stream-index: "001" + required: + - reminder + - duration + title: Response + type: object + UpdateThreadPartialRequest: + nullable: true + properties: + set: + additionalProperties: {} + description: Sets new field values + title: Set + type: object + x-stream-index: "004.001" + x-stream-map: + description: New value to set + key: field + title: Value + unset: + description: Array of field names to unset + items: + type: string + title: Unset + type: array + x-stream-index: "004.002" + type: object + UpdateThreadPartialResponse: + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "002.001" + thread: + $ref: '#/components/schemas/ThreadResponse' + description: Updated thread (not enriched) + title: Thread + x-stream-index: "001" + required: + - thread + - duration + type: object + UpdateUserPartialRequest: + properties: + id: + description: User ID to update + title: ID + type: string + x-stream-index: "001" + set: + additionalProperties: {} + type: object + x-stream-index: "002.001" + unset: + items: + type: string + type: array + x-stream-index: "002.002" + required: + - id + type: object + UpdateUserPermissionsRequest: + nullable: true + properties: + grant_permissions: + items: + type: string + type: array + x-stream-index: "002" + revoke_permissions: + items: + type: string + type: array + x-stream-index: "003" + user_id: + type: string + x-stream-index: "001" + required: + - user_id + type: object + UpdateUserPermissionsResponse: + 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 + UpdateUsersPartialRequest: + nullable: true + properties: + users: + items: + $ref: '#/components/schemas/UpdateUserPartialRequest' + maximum: 100 + type: array + x-stream-index: "001" + required: + - users + type: object + UpdateUsersRequest: + nullable: true + properties: + users: + additionalProperties: + $ref: '#/components/schemas/UserRequest' + description: Object containing users + title: Users + type: object + x-stream-index: "001" + x-stream-map: + key: user_id + required: + - users + type: object + UpdateUsersResponse: + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "003.001" + membership_deletion_task_id: + type: string + x-stream-index: "002" + users: + additionalProperties: + $ref: '#/components/schemas/FullUserResponse' + description: Object containing users + title: Users + type: object + x-stream-index: "001" + x-stream-map: + key: user_id + required: + - users + - membership_deletion_task_id + - duration + type: object + UpdatedCallPermissionsEvent: + description: This event is sent to notify about permission changes for a user, + clients receiving this event should update their UI accordingly + properties: + call_cid: + type: string + x-stream-index: "002.001" + created_at: + format: date-time + type: number + x-stream-index: "001.002" + own_capabilities: + description: The capabilities of the current user + items: + $ref: '#/components/schemas/OwnCapability' + title: Own capabilities + type: array + x-stream-index: "004" + type: + default: call.permissions_updated + description: 'The type of event: "call.permissions_updated" in this case' + title: Event Type + type: string + x-stream-index: "001.001" + user: + $ref: '#/components/schemas/UserResponse' + description: The user who received the new permissions + title: User + x-stream-index: "003" + required: + - type + - created_at + - call_cid + - user + - own_capabilities + title: UpdatedCallPermissionsEvent + type: object + x-stream-event-call-type: true + x-stream-event-doc-group: call + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + UpsertActivitiesRequest: + nullable: true + properties: + activities: + description: List of activities to create or update + items: + $ref: '#/components/schemas/ActivityRequest' + maximum: 100 + minimum: 1 + title: Activities + type: array + x-stream-index: "001" + required: + - activities + title: Upsert Activities Request + type: object + UpsertActivitiesResponse: + nullable: true + properties: + activities: + description: List of created or updated activities + items: + $ref: '#/components/schemas/ActivityResponse' + title: Activities + type: array + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - activities + - duration + title: Upsert Activities Response + type: object + UpsertConfigRequest: + nullable: true + properties: + ai_image_config: + $ref: '#/components/schemas/AIImageConfig' + description: Configuration for AI image analysis + title: AI Image Config + x-stream-index: "011" + ai_text_config: + $ref: '#/components/schemas/AITextConfig' + description: Configuration for AI text analysis + title: AI Text Config + x-stream-index: "008" + ai_video_config: + $ref: '#/components/schemas/AIVideoConfig' + description: Configuration for AI video analysis + title: AI Video Config + x-stream-index: "012" + async: + description: Whether moderation should be performed asynchronously + title: Async + type: boolean + x-stream-index: "003" + automod_platform_circumvention_config: + $ref: '#/components/schemas/AutomodPlatformCircumventionConfig' + description: Configuration for platform circumvention detection + title: Automod Platform Circumvention Config + x-stream-index: "005" + automod_semantic_filters_config: + $ref: '#/components/schemas/AutomodSemanticFiltersConfig' + description: Configuration for semantic filtering + title: Automod Semantic Filters Config + x-stream-index: "006" + automod_toxicity_config: + $ref: '#/components/schemas/AutomodToxicityConfig' + description: Configuration for toxicity detection + title: Automod Toxicity Config + x-stream-index: "004" + aws_rekognition_config: + $ref: '#/components/schemas/AIImageConfig' + x-stream-index: "016" + block_list_config: + $ref: '#/components/schemas/BlockListConfig' + description: Configuration for block list filtering + title: Block List Config + x-stream-index: "007" + bodyguard_config: + $ref: '#/components/schemas/AITextConfig' + x-stream-index: "015" + google_vision_config: + $ref: '#/components/schemas/GoogleVisionConfig' + description: Configuration for Google Vision integration + title: Google Vision Config + x-stream-index: "010" + key: + description: Unique identifier for the moderation configuration + title: Key + type: string + x-stream-index: "001" + llm_config: + $ref: '#/components/schemas/LLMConfig' + description: Configuration for customer-configured LLM moderation + title: LLM Config + x-stream-index: "009" + rule_builder_config: + $ref: '#/components/schemas/RuleBuilderConfig' + description: Configuration for custom rule builder (max 3 rules, max 5 conditions + per rule) + title: Rule Builder Config + x-stream-index: "014" + team: + description: Team associated with the configuration + maxLength: 128 + minLength: 1 + title: Team + type: string + x-stream-index: "002" + velocity_filter_config: + $ref: '#/components/schemas/VelocityFilterConfig' + description: Configuration for velocity-based filtering + title: Velocity Filter Config + x-stream-index: "013" + video_call_rule_config: + $ref: '#/components/schemas/VideoCallRuleConfig' + x-stream-index: "017" + required: + - key + type: object + UpsertConfigResponse: + nullable: true + properties: + config: + $ref: '#/components/schemas/ConfigResponse' + description: The created or updated moderation configuration + title: Config + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - duration + type: object + UpsertPushPreferencesRequest: + nullable: true + properties: + preferences: + description: A list of push preferences for channels, calls, or the user. + items: + $ref: '#/components/schemas/PushPreferenceInput' + type: array + x-stream-index: "001" + required: + - preferences + type: object + UpsertPushPreferencesResponse: + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "003.001" + user_channel_preferences: + additionalProperties: + additionalProperties: + $ref: '#/components/schemas/ChannelPushPreferences' + type: object + description: The channel specific push notification preferences, only returned + for channels you've edited. + title: User Channel Notification Preferences + type: object + x-stream-index: "002" + user_preferences: + additionalProperties: + $ref: '#/components/schemas/PushPreferences' + description: The user preferences, always returned regardless if you edited + it + title: User Preferences + type: object + x-stream-index: "001" + required: + - user_preferences + - user_channel_preferences + - duration + type: object + User: + properties: + avg_response_time: + format: int32 + readOnly: true + type: integer + x-stream-index: "046" + ban_expires: + format: date-time + type: number + x-stream-index: "017" + banned: + type: boolean + x-stream-index: "016" + created_at: + format: date-time + readOnly: true + type: number + x-stream-index: "008" + custom: + additionalProperties: {} + type: object + x-stream-index: "006" + deactivated_at: + format: date-time + readOnly: true + type: number + x-stream-index: "014" + deleted_at: + format: date-time + readOnly: true + type: number + x-stream-index: "013" + id: + type: string + x-stream-index: "003" + invisible: + type: boolean + x-stream-index: "023" + language: + type: string + x-stream-index: "035" + last_active: + format: date-time + readOnly: true + type: number + x-stream-index: "011" + last_engaged_at: + format: date-time + readOnly: true + type: number + x-stream-index: "012" + online: + readOnly: true + type: boolean + x-stream-index: "022" + privacy_settings: + $ref: '#/components/schemas/PrivacySettings' + x-stream-index: "026" + revoke_tokens_issued_before: + format: date-time + type: number + x-stream-index: "042" + role: + type: string + x-stream-index: "004" + teams: + items: + type: string + type: array + x-stream-index: "036" + teams_role: + additionalProperties: + type: string + type: object + x-stream-index: "005" + updated_at: + format: date-time + readOnly: true + type: number + x-stream-index: "009" + required: + - id + - role + - teams_role + - custom + - banned + - online + type: object + UserBannedEvent: + properties: + channel_id: + type: string + x-stream-index: "006.002" + channel_type: + type: string + x-stream-index: "006.003" + cid: + type: string + x-stream-index: "006.001" + created_at: + format: date-time + type: number + x-stream-index: "008.002" + created_by: + $ref: '#/components/schemas/User' + x-stream-index: "001" + expiration: + format: date-time + type: number + x-stream-index: "003" + reason: + type: string + x-stream-index: "004" + shadow: + type: boolean + x-stream-index: "002" + team: + type: string + x-stream-index: "005.001" + type: + default: user.banned + type: string + x-stream-index: "008.001" + user: + $ref: '#/components/schemas/User' + x-stream-index: "007.001" + required: + - created_by + - shadow + - cid + - channel_id + - channel_type + - type + - created_at + title: UserBannedEvent + 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 + UserCreatedWithinParameters: + properties: + max_age: + type: string + x-stream-index: "001" + type: object + UserCustomPropertyParameters: + properties: + operator: + type: string + x-stream-index: "002" + property_key: + type: string + x-stream-index: "001" + type: object + UserDeactivatedEvent: + properties: + created_at: + format: date-time + type: number + x-stream-index: "003.002" + created_by: + $ref: '#/components/schemas/User' + x-stream-index: "001" + type: + default: user.deactivated + type: string + x-stream-index: "003.001" + user: + $ref: '#/components/schemas/User' + x-stream-index: "002.001" + required: + - created_by + - type + - created_at + title: UserDeactivatedEvent + 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 + UserDeletedEvent: + properties: + created_at: + format: date-time + type: number + x-stream-index: "002.002" + delete_conversation_channels: + type: boolean + x-stream-index: "005" + hard_delete: + type: boolean + x-stream-index: "003.001" + mark_messages_deleted: + type: boolean + x-stream-index: "004" + type: + default: user.deleted + type: string + x-stream-index: "002.001" + user: + $ref: '#/components/schemas/User' + x-stream-index: "001.001" + required: + - type + - created_at + - hard_delete + - mark_messages_deleted + - delete_conversation_channels + title: UserDeletedEvent + 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 + UserFeedbackReport: + properties: + count_by_rating: + additionalProperties: + format: int32 + type: integer + type: object + x-stream-index: "001" + unreported_count: + format: int32 + type: integer + x-stream-index: "002" + required: + - count_by_rating + - unreported_count + type: object + UserFeedbackReportResponse: + properties: + daily: + items: + $ref: '#/components/schemas/DailyAggregateUserFeedbackReportResponse' + type: array + x-stream-index: "001" + required: + - daily + type: object + UserMessagesDeletedEvent: + description: This event is sent when a user's message get deleted. The event + contains information about the user whose messages got deleted. + nullable: true + properties: + channel_custom: + additionalProperties: {} + type: object + x-stream-index: 001.001.005 + channel_id: + description: The ID of the channel where the target user's messages were + deleted + title: Channel ID + type: string + x-stream-index: 001.002.002 + channel_member_count: + format: int32 + type: integer + x-stream-index: 001.001.004 + channel_type: + description: The type of the channel where the target user's messages were + deleted + title: Channel Type + type: string + x-stream-index: 001.002.001 + cid: + description: The CID of the channel where the target user's messages were + deleted + 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: number + x-stream-index: 001.001.001.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 001.001.001.001.007 + hard_delete: + description: Whether Messages were hard deleted + title: Hard Delete + type: boolean + x-stream-index: "003" + received_at: + format: date-time + type: number + x-stream-index: 001.001.001.001.004 + team: + description: The team of the channel where the target user's messages were + deleted + title: Team + type: string + x-stream-index: 001.001.003 + type: + default: user.messages.deleted + description: 'The type of event: "user.messages.deleted" in this case' + title: Event Type + type: string + x-stream-index: 001.001.001.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The target user whose messages got deleted + title: User + x-stream-index: "002.001" + required: + - type + - created_at + - custom + - user + title: UserMessagesDeletedEvent + 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 + UserMute: + nullable: true + properties: + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: "009" + expires: + description: Date/time of mute expiration + format: date-time + title: Expires + type: number + x-stream-index: "008" + target: + $ref: '#/components/schemas/User' + description: User who's muted + title: Target + x-stream-index: "007" + updated_at: + description: Date/time of the last update + format: date-time + title: Updated at + type: number + x-stream-index: "010" + user: + $ref: '#/components/schemas/User' + description: Owner of channel mute + title: User + x-stream-index: "005" + required: + - created_at + - updated_at + type: object + UserMuteResponse: + nullable: true + properties: + created_at: + format: date-time + type: number + x-stream-index: "004" + expires: + format: date-time + type: number + x-stream-index: "003" + target: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "002" + updated_at: + format: date-time + type: number + x-stream-index: "005" + user: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "001" + required: + - created_at + - updated_at + type: object + UserMutedEvent: + properties: + created_at: + format: date-time + type: number + x-stream-index: "004.002" + target_user: + type: string + x-stream-index: "001" + target_users: + items: + type: string + type: array + x-stream-index: "002" + type: + default: user.muted + type: string + x-stream-index: "004.001" + user: + $ref: '#/components/schemas/User' + x-stream-index: "003.001" + required: + - type + - created_at + title: UserMutedEvent + 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 + UserPresenceChangedEvent: + properties: + created_at: + format: date-time + type: number + x-stream-index: "002.002" + type: + default: user.presence.changed + type: string + x-stream-index: "002.001" + user: + $ref: '#/components/schemas/User' + x-stream-index: "001.001" + required: + - type + - created_at + title: UserPresenceChangedEvent + 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 + UserRatingReportResponse: + properties: + average: + format: float + type: number + x-stream-index: "002" + count: + format: int32 + type: integer + x-stream-index: "001" + required: + - count + - average + type: object + UserReactivatedEvent: + properties: + created_at: + format: date-time + type: number + x-stream-index: "002.002" + type: + default: user.reactivated + type: string + x-stream-index: "002.001" + user: + $ref: '#/components/schemas/User' + x-stream-index: "001" + required: + - type + - created_at + title: UserReactivatedEvent + 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 + UserRequest: + description: User request object + properties: + custom: + additionalProperties: {} + description: Custom user data + title: Custom + type: object + x-stream-index: "004" + id: + description: User ID + title: ID + type: string + x-stream-index: "001" + image: + description: User's profile image URL + title: Image + type: string + x-stream-index: "003" + invisible: + type: boolean + x-stream-index: "006" + language: + type: string + x-stream-index: "005" + name: + description: Optional name of user + title: Name + type: string + x-stream-index: "002" + privacy_settings: + $ref: '#/components/schemas/PrivacySettingsResponse' + x-stream-index: "007" + required: + - id + title: UserRequest + type: object + UserResponse: + description: User response object + properties: + avg_response_time: + format: int32 + type: integer + x-stream-index: "001.018" + banned: + description: Whether a user is banned or not + title: Banned + type: boolean + x-stream-index: "001.012" + blocked_user_ids: + items: + type: string + type: array + x-stream-index: "001.017" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: "001.009" + custom: + additionalProperties: {} + description: Custom data for this object + title: Custom data + type: object + x-stream-index: "001.004" + deactivated_at: + description: Date of deactivation + format: date-time + title: Deactivated at + type: number + x-stream-index: "001.016" + deleted_at: + description: Date/time of deletion + format: date-time + title: Deleted at + type: number + x-stream-index: "001.011" + id: + description: Unique user identifier + title: ID + type: string + x-stream-index: "001.001" + image: + title: Image + type: string + x-stream-index: "001.003" + language: + description: Preferred language of a user + title: Language + type: string + x-stream-index: "001.005" + last_active: + description: Date of last activity + format: date-time + title: Last active + type: number + x-stream-index: "001.014" + name: + description: Optional name of user + title: Name + type: string + x-stream-index: "001.002" + online: + description: Whether a user online or not + title: Online + type: boolean + x-stream-index: "001.013" + revoke_tokens_issued_before: + description: Revocation date for tokens + format: date-time + title: Revoke tokens issued before + type: number + x-stream-index: "001.015" + role: + description: Determines the set of user permissions + title: Role + type: string + x-stream-index: "001.006" + teams: + description: List of teams user is a part of + items: + type: string + title: Teams + type: array + x-stream-index: "001.007" + teams_role: + additionalProperties: + type: string + type: object + x-stream-index: "001.008" + updated_at: + description: Date/time of the last update + format: date-time + title: Updated at + type: number + x-stream-index: "001.010" + required: + - id + - custom + - language + - role + - teams + - created_at + - updated_at + - banned + - online + - blocked_user_ids + - shadow_banned + - invisible + title: UserResponse + type: object + UserResponseCommonFields: + properties: + avg_response_time: + format: int32 + type: integer + x-stream-index: "018" + banned: + type: boolean + x-stream-index: "012" + blocked_user_ids: + items: + type: string + type: array + x-stream-index: "017" + created_at: + format: date-time + type: number + x-stream-index: "009" + custom: + additionalProperties: {} + type: object + x-stream-index: "004" + deactivated_at: + format: date-time + type: number + x-stream-index: "016" + deleted_at: + format: date-time + type: number + x-stream-index: "011" + id: + type: string + x-stream-index: "001" + image: + type: string + x-stream-index: "003" + language: + type: string + x-stream-index: "005" + last_active: + format: date-time + type: number + x-stream-index: "014" + name: + type: string + x-stream-index: "002" + online: + type: boolean + x-stream-index: "013" + revoke_tokens_issued_before: + format: date-time + type: number + x-stream-index: "015" + role: + type: string + x-stream-index: "006" + teams: + items: + type: string + type: array + x-stream-index: "007" + teams_role: + additionalProperties: + type: string + type: object + x-stream-index: "008" + updated_at: + format: date-time + type: number + x-stream-index: "010" + required: + - id + - custom + - language + - role + - teams + - created_at + - updated_at + - banned + - online + - blocked_user_ids + type: object + UserResponsePrivacyFields: + properties: + avg_response_time: + format: int32 + type: integer + x-stream-index: "001.018" + banned: + type: boolean + x-stream-index: "001.012" + blocked_user_ids: + items: + type: string + type: array + x-stream-index: "001.017" + created_at: + format: date-time + type: number + x-stream-index: "001.009" + custom: + additionalProperties: {} + type: object + x-stream-index: "001.004" + deactivated_at: + format: date-time + type: number + x-stream-index: "001.016" + deleted_at: + format: date-time + type: number + x-stream-index: "001.011" + id: + type: string + x-stream-index: "001.001" + image: + type: string + x-stream-index: "001.003" + invisible: + type: boolean + x-stream-index: "003" + language: + type: string + x-stream-index: "001.005" + last_active: + format: date-time + type: number + x-stream-index: "001.014" + name: + type: string + x-stream-index: "001.002" + online: + type: boolean + x-stream-index: "001.013" + privacy_settings: + $ref: '#/components/schemas/PrivacySettingsResponse' + x-stream-index: "002" + revoke_tokens_issued_before: + format: date-time + type: number + x-stream-index: "001.015" + role: + type: string + x-stream-index: "001.006" + teams: + items: + type: string + type: array + x-stream-index: "001.007" + teams_role: + additionalProperties: + type: string + type: object + x-stream-index: "001.008" + updated_at: + format: date-time + type: number + x-stream-index: "001.010" + required: + - id + - custom + - language + - role + - teams + - created_at + - updated_at + - banned + - online + - blocked_user_ids + type: object + UserRuleParameters: + properties: + max_age: + type: string + x-stream-index: "001" + type: object + UserUnbannedEvent: + properties: + channel_id: + type: string + x-stream-index: "002.002" + channel_type: + type: string + x-stream-index: "002.003" + cid: + type: string + x-stream-index: "002.001" + created_at: + format: date-time + type: number + x-stream-index: "005.002" + shadow: + type: boolean + x-stream-index: "001" + team: + type: string + x-stream-index: "004.001" + type: + default: user.unbanned + type: string + x-stream-index: "005.001" + user: + $ref: '#/components/schemas/User' + x-stream-index: "003.001" + required: + - shadow + - cid + - channel_id + - channel_type + - type + - created_at + title: UserUnbannedEvent + 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 + UserUpdatedEvent: + description: This event is sent when a user gets updated. The event contains + information about the updated user. + nullable: true + properties: + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: "001.003" + custom: + additionalProperties: {} + type: object + x-stream-index: "001.007" + received_at: + format: date-time + type: number + x-stream-index: "001.004" + type: + default: user.updated + description: 'The type of event: "user.updated" in this case' + title: Event Type + type: string + x-stream-index: "001.002" + user: + $ref: '#/components/schemas/UserResponsePrivacyFields' + description: The updated user + title: User + x-stream-index: "002.001" + required: + - type + - created_at + - custom + - user + title: UserUpdatedEvent + 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 + UserWatchingStartEvent: + properties: + channel_id: + type: string + x-stream-index: "004.002" + channel_type: + type: string + x-stream-index: "004.003" + cid: + type: string + x-stream-index: "004.001" + created_at: + format: date-time + type: number + x-stream-index: "003.002" + team: + type: string + x-stream-index: "002.001" + type: + default: user.watching.start + type: string + x-stream-index: "003.001" + user: + $ref: '#/components/schemas/User' + x-stream-index: "005.001" + watcher_count: + format: int32 + type: integer + x-stream-index: "001.001" + required: + - watcher_count + - type + - created_at + - cid + - channel_id + - channel_type + title: UserWatchingStartEvent + 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 + UserWatchingStopEvent: + properties: + channel_id: + type: string + x-stream-index: "004.002" + channel_type: + type: string + x-stream-index: "004.003" + cid: + type: string + x-stream-index: "004.001" + created_at: + format: date-time + type: number + x-stream-index: "002.002" + type: + default: user.watching.stop + type: string + x-stream-index: "002.001" + user: + $ref: '#/components/schemas/User' + x-stream-index: "003.001" + watcher_count: + format: int32 + type: integer + x-stream-index: "001.001" + required: + - watcher_count + - type + - created_at + - cid + - channel_id + - channel_type + title: UserWatchingStopEvent + 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 + VelocityFilterConfig: + properties: + advanced_filters: + type: boolean + x-stream-index: "007" + async: + type: boolean + x-stream-index: "001" + cascading_actions: + type: boolean + x-stream-index: "004" + cids_per_user: + format: int32 + type: integer + x-stream-index: "006" + enabled: + type: boolean + x-stream-index: "002" + first_message_only: + type: boolean + x-stream-index: "005" + rules: + items: + $ref: '#/components/schemas/VelocityFilterConfigRule' + type: array + x-stream-index: "003" + required: + - enabled + - rules + - cascading_actions + - first_message_only + - cids_per_user + - advanced_filters + type: object + VelocityFilterConfigRule: + properties: + action: + enum: + - flag + - shadow + - remove + - ban + type: string + x-stream-index: "001" + ban_duration: + format: int32 + type: integer + x-stream-index: "002" + cascading_action: + enum: + - flag + - shadow + - remove + - ban + type: string + x-stream-index: "006" + cascading_threshold: + format: int64 + type: integer + x-stream-index: "005" + check_message_context: + type: boolean + x-stream-index: "009" + fast_spam_threshold: + format: int32 + type: integer + x-stream-index: "007" + fast_spam_ttl: + format: int32 + type: integer + x-stream-index: "010" + ip_ban: + type: boolean + x-stream-index: "004" + probation_period: + format: int32 + type: integer + x-stream-index: "014" + shadow_ban: + type: boolean + x-stream-index: "003" + slow_spam_ban_duration: + format: int32 + type: integer + x-stream-index: "012" + slow_spam_threshold: + format: int32 + type: integer + x-stream-index: "008" + slow_spam_ttl: + format: int32 + type: integer + x-stream-index: "011" + url_only: + type: boolean + x-stream-index: "013" + required: + - action + - ban_duration + - shadow_ban + - ip_ban + - cascading_threshold + - cascading_action + - fast_spam_threshold + - slow_spam_threshold + - check_message_context + - fast_spam_ttl + - slow_spam_ttl + - url_only + - probation_period + type: object + VideoCallRuleConfig: + properties: + rules: + additionalProperties: + $ref: '#/components/schemas/HarmConfig' + type: object + x-stream-index: "001" + required: + - rules + type: object + VideoContentParameters: + properties: + harm_labels: + items: + type: string + type: array + x-stream-index: "001" + type: object + VideoEndCallRequest: + type: object + VideoKickUserRequest: + type: object + VideoOrientation: + properties: + orientation: + type: integer + x-stream-index: "004" + type: object + VideoReactionOverTimeResponse: + properties: + by_minute: + items: + $ref: '#/components/schemas/CountByMinuteResponse' + type: array + x-stream-index: "001" + type: object + VideoReactionsResponse: + nullable: true + properties: + count_over_time: + $ref: '#/components/schemas/VideoReactionOverTimeResponse' + x-stream-index: "002" + reaction: + type: string + x-stream-index: "001" + required: + - reaction + type: object + VideoRuleParameters: + properties: + harm_labels: + items: + type: string + type: array + x-stream-index: "003" + threshold: + format: int32 + type: integer + x-stream-index: "001" + time_window: + type: string + x-stream-index: "002" + type: object + VideoSettings: + properties: + access_request_enabled: + type: boolean + x-stream-index: "002" + camera_default_on: + type: boolean + x-stream-index: "004" + camera_facing: + enum: + - front + - back + - external + type: string + x-stream-index: "005" + enabled: + type: boolean + x-stream-index: "001" + target_resolution: + $ref: '#/components/schemas/TargetResolution' + x-stream-index: "003" + required: + - enabled + - access_request_enabled + - target_resolution + - camera_default_on + - camera_facing + type: object + VideoSettingsRequest: + properties: + access_request_enabled: + type: boolean + x-stream-index: "002" + camera_default_on: + type: boolean + x-stream-index: "004" + camera_facing: + enum: + - front + - back + - external + type: string + x-stream-index: "005" + enabled: + type: boolean + x-stream-index: "001" + target_resolution: + $ref: '#/components/schemas/TargetResolution' + x-stream-index: "003" + type: object + VideoSettingsResponse: + properties: + access_request_enabled: + type: boolean + x-stream-index: "002" + camera_default_on: + type: boolean + x-stream-index: "004" + camera_facing: + enum: + - front + - back + - external + type: string + x-stream-index: "005" + enabled: + type: boolean + x-stream-index: "001" + target_resolution: + $ref: '#/components/schemas/TargetResolution' + x-stream-index: "003" + required: + - enabled + - access_request_enabled + - target_resolution + - camera_default_on + - camera_facing + type: object + VoteData: + properties: + answer_text: + type: string + x-stream-index: "002" + option_id: + maxLength: 255 + type: string + x-stream-index: "001" + type: object + WSAuthMessage: + description: Websocket auth message + nullable: true + properties: + products: + items: + type: string + type: array + x-stream-index: "003" + token: + title: Token + type: string + x-stream-index: "002" + user_details: + $ref: '#/components/schemas/ConnectUserDetailsRequest' + x-stream-index: "001" + required: + - user_details + - token + title: WSAuthMessage + type: object + WSClientEvent: + description: The discriminator object for all websocket client events, it maps + events' payload to the final type + discriminator: + mapping: app.updated: '#/components/schemas/AppUpdatedEvent' draft.deleted: '#/components/schemas/DraftDeletedEvent' draft.updated: '#/components/schemas/DraftUpdatedEvent' + feeds.activity.added: '#/components/schemas/ActivityAddedEvent' + feeds.activity.deleted: '#/components/schemas/ActivityDeletedEvent' + feeds.activity.marked: '#/components/schemas/ActivityMarkEvent' + feeds.activity.pinned: '#/components/schemas/ActivityPinnedEvent' + feeds.activity.reaction.added: '#/components/schemas/ActivityReactionAddedEvent' + feeds.activity.reaction.deleted: '#/components/schemas/ActivityReactionDeletedEvent' + feeds.activity.reaction.updated: '#/components/schemas/ActivityReactionUpdatedEvent' + feeds.activity.removed_from_feed: '#/components/schemas/ActivityRemovedFromFeedEvent' + feeds.activity.unpinned: '#/components/schemas/ActivityUnpinnedEvent' + feeds.activity.updated: '#/components/schemas/ActivityUpdatedEvent' + feeds.bookmark.added: '#/components/schemas/BookmarkAddedEvent' + feeds.bookmark.deleted: '#/components/schemas/BookmarkDeletedEvent' + feeds.bookmark.updated: '#/components/schemas/BookmarkUpdatedEvent' + feeds.bookmark_folder.deleted: '#/components/schemas/BookmarkFolderDeletedEvent' + feeds.bookmark_folder.updated: '#/components/schemas/BookmarkFolderUpdatedEvent' + feeds.comment.added: '#/components/schemas/CommentAddedEvent' + feeds.comment.deleted: '#/components/schemas/CommentDeletedEvent' + feeds.comment.reaction.added: '#/components/schemas/CommentReactionAddedEvent' + feeds.comment.reaction.deleted: '#/components/schemas/CommentReactionDeletedEvent' + feeds.comment.reaction.updated: '#/components/schemas/CommentReactionUpdatedEvent' + feeds.comment.updated: '#/components/schemas/CommentUpdatedEvent' + feeds.feed.created: '#/components/schemas/FeedCreatedEvent' + feeds.feed.deleted: '#/components/schemas/FeedDeletedEvent' + feeds.feed.updated: '#/components/schemas/FeedUpdatedEvent' + feeds.feed_group.changed: '#/components/schemas/FeedGroupChangedEvent' + feeds.feed_group.deleted: '#/components/schemas/FeedGroupDeletedEvent' + feeds.feed_member.added: '#/components/schemas/FeedMemberAddedEvent' + feeds.feed_member.removed: '#/components/schemas/FeedMemberRemovedEvent' + feeds.feed_member.updated: '#/components/schemas/FeedMemberUpdatedEvent' + feeds.follow.created: '#/components/schemas/FollowCreatedEvent' + feeds.follow.deleted: '#/components/schemas/FollowDeletedEvent' + feeds.follow.updated: '#/components/schemas/FollowUpdatedEvent' + feeds.notification_feed.updated: '#/components/schemas/NotificationFeedUpdatedEvent' + feeds.poll.closed: '#/components/schemas/PollClosedFeedEvent' + feeds.poll.deleted: '#/components/schemas/PollDeletedFeedEvent' + feeds.poll.updated: '#/components/schemas/PollUpdatedFeedEvent' + feeds.poll.vote_casted: '#/components/schemas/PollVoteCastedFeedEvent' + feeds.poll.vote_changed: '#/components/schemas/PollVoteChangedFeedEvent' + feeds.poll.vote_removed: '#/components/schemas/PollVoteRemovedFeedEvent' health.check: '#/components/schemas/HealthCheckEvent' message.pending: '#/components/schemas/PendingMessageEvent' notification.reminder_due: '#/components/schemas/ReminderNotificationEvent' @@ -20734,24 +26888,65 @@ components: reminder.created: '#/components/schemas/ReminderCreatedEvent' reminder.deleted: '#/components/schemas/ReminderDeletedEvent' reminder.updated: '#/components/schemas/ReminderUpdatedEvent' + user.messages.deleted: '#/components/schemas/UserMessagesDeletedEvent' user.updated: '#/components/schemas/UserUpdatedEvent' propertyName: type oneOf: + - $ref: '#/components/schemas/ActivityAddedEvent' + - $ref: '#/components/schemas/ActivityDeletedEvent' + - $ref: '#/components/schemas/ActivityMarkEvent' + - $ref: '#/components/schemas/ActivityPinnedEvent' + - $ref: '#/components/schemas/ActivityReactionAddedEvent' + - $ref: '#/components/schemas/ActivityReactionDeletedEvent' + - $ref: '#/components/schemas/ActivityReactionUpdatedEvent' + - $ref: '#/components/schemas/ActivityRemovedFromFeedEvent' + - $ref: '#/components/schemas/ActivityUnpinnedEvent' + - $ref: '#/components/schemas/ActivityUpdatedEvent' - $ref: '#/components/schemas/AppUpdatedEvent' + - $ref: '#/components/schemas/BookmarkAddedEvent' + - $ref: '#/components/schemas/BookmarkDeletedEvent' + - $ref: '#/components/schemas/BookmarkFolderDeletedEvent' + - $ref: '#/components/schemas/BookmarkFolderUpdatedEvent' + - $ref: '#/components/schemas/BookmarkUpdatedEvent' + - $ref: '#/components/schemas/CommentAddedEvent' + - $ref: '#/components/schemas/CommentDeletedEvent' + - $ref: '#/components/schemas/CommentReactionAddedEvent' + - $ref: '#/components/schemas/CommentReactionDeletedEvent' + - $ref: '#/components/schemas/CommentReactionUpdatedEvent' + - $ref: '#/components/schemas/CommentUpdatedEvent' - $ref: '#/components/schemas/DraftDeletedEvent' - $ref: '#/components/schemas/DraftUpdatedEvent' + - $ref: '#/components/schemas/FeedCreatedEvent' + - $ref: '#/components/schemas/FeedDeletedEvent' + - $ref: '#/components/schemas/FeedGroupChangedEvent' + - $ref: '#/components/schemas/FeedGroupDeletedEvent' + - $ref: '#/components/schemas/FeedMemberAddedEvent' + - $ref: '#/components/schemas/FeedMemberRemovedEvent' + - $ref: '#/components/schemas/FeedMemberUpdatedEvent' + - $ref: '#/components/schemas/FeedUpdatedEvent' + - $ref: '#/components/schemas/FollowCreatedEvent' + - $ref: '#/components/schemas/FollowDeletedEvent' + - $ref: '#/components/schemas/FollowUpdatedEvent' - $ref: '#/components/schemas/HealthCheckEvent' + - $ref: '#/components/schemas/NotificationFeedUpdatedEvent' - $ref: '#/components/schemas/PendingMessageEvent' - $ref: '#/components/schemas/PollClosedEvent' + - $ref: '#/components/schemas/PollClosedFeedEvent' - $ref: '#/components/schemas/PollDeletedEvent' + - $ref: '#/components/schemas/PollDeletedFeedEvent' - $ref: '#/components/schemas/PollUpdatedEvent' + - $ref: '#/components/schemas/PollUpdatedFeedEvent' - $ref: '#/components/schemas/PollVoteCastedEvent' + - $ref: '#/components/schemas/PollVoteCastedFeedEvent' - $ref: '#/components/schemas/PollVoteChangedEvent' + - $ref: '#/components/schemas/PollVoteChangedFeedEvent' - $ref: '#/components/schemas/PollVoteRemovedEvent' + - $ref: '#/components/schemas/PollVoteRemovedFeedEvent' - $ref: '#/components/schemas/ReminderCreatedEvent' - $ref: '#/components/schemas/ReminderDeletedEvent' - $ref: '#/components/schemas/ReminderNotificationEvent' - $ref: '#/components/schemas/ReminderUpdatedEvent' + - $ref: '#/components/schemas/UserMessagesDeletedEvent' - $ref: '#/components/schemas/UserUpdatedEvent' WSEvent: description: The discriminator object for all websocket events, it maps events' @@ -20780,6 +26975,7 @@ components: call.hls_broadcasting_failed: '#/components/schemas/CallHLSBroadcastingFailedEvent' call.hls_broadcasting_started: '#/components/schemas/CallHLSBroadcastingStartedEvent' call.hls_broadcasting_stopped: '#/components/schemas/CallHLSBroadcastingStoppedEvent' + call.kicked_user: '#/components/schemas/KickedUserEvent' call.live_started: '#/components/schemas/CallLiveStartedEvent' call.member_added: '#/components/schemas/CallMemberAddedEvent' call.member_removed: '#/components/schemas/CallMemberRemovedEvent' @@ -20829,6 +27025,45 @@ components: custom: '#/components/schemas/CustomVideoEvent' draft.deleted: '#/components/schemas/DraftDeletedEvent' draft.updated: '#/components/schemas/DraftUpdatedEvent' + feeds.activity.added: '#/components/schemas/ActivityAddedEvent' + feeds.activity.deleted: '#/components/schemas/ActivityDeletedEvent' + feeds.activity.marked: '#/components/schemas/ActivityMarkEvent' + feeds.activity.pinned: '#/components/schemas/ActivityPinnedEvent' + feeds.activity.reaction.added: '#/components/schemas/ActivityReactionAddedEvent' + feeds.activity.reaction.deleted: '#/components/schemas/ActivityReactionDeletedEvent' + feeds.activity.reaction.updated: '#/components/schemas/ActivityReactionUpdatedEvent' + feeds.activity.removed_from_feed: '#/components/schemas/ActivityRemovedFromFeedEvent' + feeds.activity.unpinned: '#/components/schemas/ActivityUnpinnedEvent' + feeds.activity.updated: '#/components/schemas/ActivityUpdatedEvent' + feeds.bookmark.added: '#/components/schemas/BookmarkAddedEvent' + feeds.bookmark.deleted: '#/components/schemas/BookmarkDeletedEvent' + feeds.bookmark.updated: '#/components/schemas/BookmarkUpdatedEvent' + feeds.bookmark_folder.deleted: '#/components/schemas/BookmarkFolderDeletedEvent' + feeds.bookmark_folder.updated: '#/components/schemas/BookmarkFolderUpdatedEvent' + feeds.comment.added: '#/components/schemas/CommentAddedEvent' + feeds.comment.deleted: '#/components/schemas/CommentDeletedEvent' + feeds.comment.reaction.added: '#/components/schemas/CommentReactionAddedEvent' + feeds.comment.reaction.deleted: '#/components/schemas/CommentReactionDeletedEvent' + feeds.comment.reaction.updated: '#/components/schemas/CommentReactionUpdatedEvent' + feeds.comment.updated: '#/components/schemas/CommentUpdatedEvent' + feeds.feed.created: '#/components/schemas/FeedCreatedEvent' + feeds.feed.deleted: '#/components/schemas/FeedDeletedEvent' + feeds.feed.updated: '#/components/schemas/FeedUpdatedEvent' + feeds.feed_group.changed: '#/components/schemas/FeedGroupChangedEvent' + feeds.feed_group.deleted: '#/components/schemas/FeedGroupDeletedEvent' + feeds.feed_member.added: '#/components/schemas/FeedMemberAddedEvent' + feeds.feed_member.removed: '#/components/schemas/FeedMemberRemovedEvent' + feeds.feed_member.updated: '#/components/schemas/FeedMemberUpdatedEvent' + feeds.follow.created: '#/components/schemas/FollowCreatedEvent' + feeds.follow.deleted: '#/components/schemas/FollowDeletedEvent' + feeds.follow.updated: '#/components/schemas/FollowUpdatedEvent' + feeds.notification_feed.updated: '#/components/schemas/NotificationFeedUpdatedEvent' + feeds.poll.closed: '#/components/schemas/PollClosedFeedEvent' + feeds.poll.deleted: '#/components/schemas/PollDeletedFeedEvent' + feeds.poll.updated: '#/components/schemas/PollUpdatedFeedEvent' + feeds.poll.vote_casted: '#/components/schemas/PollVoteCastedFeedEvent' + feeds.poll.vote_changed: '#/components/schemas/PollVoteChangedFeedEvent' + feeds.poll.vote_removed: '#/components/schemas/PollVoteRemovedFeedEvent' health.check: '#/components/schemas/HealthCheckEvent' member.added: '#/components/schemas/MemberAddedEvent' member.removed: '#/components/schemas/MemberRemovedEvent' @@ -20874,6 +27109,7 @@ components: user.banned: '#/components/schemas/UserBannedEvent' user.deactivated: '#/components/schemas/UserDeactivatedEvent' user.deleted: '#/components/schemas/UserDeletedEvent' + user.messages.deleted: '#/components/schemas/UserMessagesDeletedEvent' user.muted: '#/components/schemas/UserMutedEvent' user.presence.changed: '#/components/schemas/UserPresenceChangedEvent' user.reactivated: '#/components/schemas/UserReactivatedEvent' @@ -20886,10 +27122,25 @@ components: - $ref: '#/components/schemas/AIIndicatorClearEvent' - $ref: '#/components/schemas/AIIndicatorStopEvent' - $ref: '#/components/schemas/AIIndicatorUpdateEvent' + - $ref: '#/components/schemas/ActivityAddedEvent' + - $ref: '#/components/schemas/ActivityDeletedEvent' + - $ref: '#/components/schemas/ActivityMarkEvent' - $ref: '#/components/schemas/ActivityMarkedEvent' + - $ref: '#/components/schemas/ActivityPinnedEvent' + - $ref: '#/components/schemas/ActivityReactionAddedEvent' + - $ref: '#/components/schemas/ActivityReactionDeletedEvent' + - $ref: '#/components/schemas/ActivityReactionUpdatedEvent' + - $ref: '#/components/schemas/ActivityRemovedFromFeedEvent' + - $ref: '#/components/schemas/ActivityUnpinnedEvent' + - $ref: '#/components/schemas/ActivityUpdatedEvent' - $ref: '#/components/schemas/AnyEvent' - $ref: '#/components/schemas/AppUpdatedEvent' - $ref: '#/components/schemas/BlockedUserEvent' + - $ref: '#/components/schemas/BookmarkAddedEvent' + - $ref: '#/components/schemas/BookmarkDeletedEvent' + - $ref: '#/components/schemas/BookmarkFolderDeletedEvent' + - $ref: '#/components/schemas/BookmarkFolderUpdatedEvent' + - $ref: '#/components/schemas/BookmarkUpdatedEvent' - $ref: '#/components/schemas/CallAcceptedEvent' - $ref: '#/components/schemas/CallClosedCaptionsFailedEvent' - $ref: '#/components/schemas/CallClosedCaptionsStartedEvent' @@ -20946,12 +27197,30 @@ components: - $ref: '#/components/schemas/ChannelUpdatedEvent' - $ref: '#/components/schemas/ChannelVisibleEvent' - $ref: '#/components/schemas/ClosedCaptionEvent' + - $ref: '#/components/schemas/CommentAddedEvent' + - $ref: '#/components/schemas/CommentDeletedEvent' + - $ref: '#/components/schemas/CommentReactionAddedEvent' + - $ref: '#/components/schemas/CommentReactionDeletedEvent' + - $ref: '#/components/schemas/CommentReactionUpdatedEvent' + - $ref: '#/components/schemas/CommentUpdatedEvent' - $ref: '#/components/schemas/ConnectedEvent' - $ref: '#/components/schemas/ConnectionErrorEvent' - $ref: '#/components/schemas/CustomVideoEvent' - $ref: '#/components/schemas/DraftDeletedEvent' - $ref: '#/components/schemas/DraftUpdatedEvent' + - $ref: '#/components/schemas/FeedCreatedEvent' + - $ref: '#/components/schemas/FeedDeletedEvent' + - $ref: '#/components/schemas/FeedGroupChangedEvent' + - $ref: '#/components/schemas/FeedGroupDeletedEvent' + - $ref: '#/components/schemas/FeedMemberAddedEvent' + - $ref: '#/components/schemas/FeedMemberRemovedEvent' + - $ref: '#/components/schemas/FeedMemberUpdatedEvent' + - $ref: '#/components/schemas/FeedUpdatedEvent' + - $ref: '#/components/schemas/FollowCreatedEvent' + - $ref: '#/components/schemas/FollowDeletedEvent' + - $ref: '#/components/schemas/FollowUpdatedEvent' - $ref: '#/components/schemas/HealthCheckEvent' + - $ref: '#/components/schemas/KickedUserEvent' - $ref: '#/components/schemas/MemberAddedEvent' - $ref: '#/components/schemas/MemberRemovedEvent' - $ref: '#/components/schemas/MemberUpdatedEvent' @@ -20968,6 +27237,7 @@ components: - $ref: '#/components/schemas/NotificationChannelDeletedEvent' - $ref: '#/components/schemas/NotificationChannelMutesUpdatedEvent' - $ref: '#/components/schemas/NotificationChannelTruncatedEvent' + - $ref: '#/components/schemas/NotificationFeedUpdatedEvent' - $ref: '#/components/schemas/NotificationInviteAcceptedEvent' - $ref: '#/components/schemas/NotificationInviteRejectedEvent' - $ref: '#/components/schemas/NotificationInvitedEvent' @@ -20979,11 +27249,17 @@ components: - $ref: '#/components/schemas/PendingMessageEvent' - $ref: '#/components/schemas/PermissionRequestEvent' - $ref: '#/components/schemas/PollClosedEvent' + - $ref: '#/components/schemas/PollClosedFeedEvent' - $ref: '#/components/schemas/PollDeletedEvent' + - $ref: '#/components/schemas/PollDeletedFeedEvent' - $ref: '#/components/schemas/PollUpdatedEvent' + - $ref: '#/components/schemas/PollUpdatedFeedEvent' - $ref: '#/components/schemas/PollVoteCastedEvent' + - $ref: '#/components/schemas/PollVoteCastedFeedEvent' - $ref: '#/components/schemas/PollVoteChangedEvent' + - $ref: '#/components/schemas/PollVoteChangedFeedEvent' - $ref: '#/components/schemas/PollVoteRemovedEvent' + - $ref: '#/components/schemas/PollVoteRemovedFeedEvent' - $ref: '#/components/schemas/ReactionDeletedEvent' - $ref: '#/components/schemas/ReactionNewEvent' - $ref: '#/components/schemas/ReactionUpdatedEvent' @@ -20999,6 +27275,7 @@ components: - $ref: '#/components/schemas/UserBannedEvent' - $ref: '#/components/schemas/UserDeactivatedEvent' - $ref: '#/components/schemas/UserDeletedEvent' + - $ref: '#/components/schemas/UserMessagesDeletedEvent' - $ref: '#/components/schemas/UserMutedEvent' - $ref: '#/components/schemas/UserPresenceChangedEvent' - $ref: '#/components/schemas/UserReactivatedEvent' @@ -21017,97 +27294,2492 @@ components: x-stream-index: "001.005" channels: items: - $ref: '#/components/schemas/UnreadCountsChannel' + $ref: '#/components/schemas/UnreadCountsChannel' + type: array + x-stream-index: "001.004" + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "002.001" + threads: + items: + $ref: '#/components/schemas/UnreadCountsThread' + type: array + x-stream-index: "001.006" + total_unread_count: + format: int32 + type: integer + x-stream-index: "001.001" + total_unread_count_by_team: + additionalProperties: + format: int32 + type: integer + type: object + x-stream-index: "001.003" + total_unread_threads_count: + format: int32 + type: integer + x-stream-index: "001.002" + required: + - total_unread_count + - total_unread_threads_count + - channels + - channel_type + - threads + - duration + title: Response + type: object + securitySchemes: + JWT: + description: | + JWT should be always provided when stream-auth-type=jwt. + + Using JWT auth request could be authenticated as user or as server-side. + + When using user authentication permission checking is going to be applied to requests based on the user that is + performing a request. + + The `authorization` header should be a JWT string signed using the secret attached to the API key used to perform + requests. + + **WARNING** all client-side official SDK do not ship with token generation; this is to make sure that the API secret is not + shared with an untrusted party such as a browser or a iOS/Android application. Tokens **must** be generated server-side. + If you wish, you can configure your application to ignore authentication (see `disable_auth_check`) + The JWT string must include only the user_id claim and can include any built-in JWT claim such as iat, exp as well. + in: header + name: Authorization + type: apiKey + api_key: + description: Application API key should be always set in order to authenticate + the request. + in: query + name: api_key + type: apiKey + stream-auth-type: + description: |- + Stream-Auth-Type should be always set in order to authenticate the request. Possible + values: `jwt` or `anonymous`. + + `jwt` allows you to authenticate as a user. With this auth type you should also provide valid JWT in Authorization + header. + + `anonymous` allows you to authenticate as anonymous user. Please note that most advanced features are not available + to anonymous users. + in: header + name: Stream-Auth-Type + type: apiKey +info: + title: Stream API + version: v191.1.0 +openapi: 3.0.3 +paths: + /api/v2/app: + get: + description: | + This Method returns the application settings + operationId: GetApp + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/GetApplicationResponse' + 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: Get App Settings + tags: + - product:common + /api/v2/blocklists: + get: + description: | + Returns all available block lists + operationId: ListBlockLists + parameters: + - in: query + name: team + schema: + type: string + writeOnly: true + x-stream-index: "001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/ListBlockListResponse' + 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: List block lists + tags: + - product:common + post: + description: | + Creates a new application blocklist, once created the blocklist can be used by any channel type + operationId: CreateBlockList + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateBlockListRequest' + description: Block list + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/CreateBlockListResponse' + 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: Create block list + tags: + - product:common + /api/v2/blocklists/{name}: + delete: + description: | + Deletes previously created application blocklist + operationId: DeleteBlockList + parameters: + - in: path + name: name + required: true + schema: + type: string + writeOnly: true + x-stream-index: "001" + - in: query + name: team + schema: + type: string + x-stream-index: "002" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/Response' + 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: Delete block list + tags: + - product:common + put: + description: | + Updates contents of the block list + operationId: UpdateBlockList + parameters: + - in: path + name: name + required: true + schema: + description: Block list name + title: Name + type: string + writeOnly: true + x-stream-index: "001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateBlockListRequest' + description: Update block list + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateBlockListResponse' + 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: Update block list + tags: + - product:common + /api/v2/chat/channels: + post: + description: | + Query channels with filter query + operationId: QueryChannels + parameters: + - in: query + name: connection_id + schema: + description: Websocket connection ID to interact with. You can pass it as + Body or URL parameter + title: Connection ID + type: string + x-stream-index: "011.003" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueryChannelsRequest' + description: Query Channels Request + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/QueryChannelsResponse' + description: Channels list + "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: Query channels + tags: + - product:chat + /api/v2/chat/channels/{type}/{id}: + delete: + description: | + Deletes channel + + Sends events: + - channel.deleted + - channel.deleted + operationId: DeleteChannel + parameters: + - in: path + name: type + required: true + schema: + description: Channel type to interact with + title: Channel type + type: string + writeOnly: true + x-stream-index: "001.001" + - in: path + name: id + required: true + schema: + description: Channel ID to interact with + title: Channel ID + type: string + writeOnly: true + x-stream-index: "001.002" + - in: query + name: hard_delete + schema: + type: boolean + x-stream-index: "002" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteChannelResponse' + 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: Delete channel + tags: + - product:chat + patch: + description: | + Updates certain fields of the channel + + Sends events: + - channel.updated + - channel.updated + operationId: UpdateChannelPartial + parameters: + - in: path + name: type + required: true + schema: + description: Channel type to interact with + title: Channel type + type: string + writeOnly: true + x-stream-index: "001.001" + - in: path + name: id + required: true + schema: + description: Channel ID to interact with + title: Channel ID + type: string + writeOnly: true + x-stream-index: "001.002" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateChannelPartialRequest' + description: UpdateChannelPartialRequest + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateChannelPartialResponse' + description: Successful 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: Partially update channel + tags: + - product:chat + post: + description: | + Change channel data + + Sends events: + - channel.updated + - member.added + - member.removed + - member.updated + - message.new + - channel.updated + - member.added + - member.removed + - member.updated + - message.new + operationId: UpdateChannel + parameters: + - in: path + name: type + required: true + schema: + type: string + writeOnly: true + x-stream-index: 013.002.001 + - in: path + name: id + required: true + schema: + type: string + writeOnly: true + x-stream-index: 013.002.002 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateChannelRequest' + description: Channel update request + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateChannelResponse' + description: Successful 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: Update channel + tags: + - product:chat + /api/v2/chat/channels/{type}/{id}/draft: + delete: + description: | + Deletes a draft + + Sends events: + - draft.deleted + operationId: DeleteDraft + parameters: + - in: path + name: type + required: true + schema: + type: string + writeOnly: true + x-stream-index: "002.001" + - in: path + name: id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "002.002" + - in: query + name: parent_id + schema: + description: Parent message ID + title: string + type: string + writeOnly: true + x-stream-index: "001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/Response' + 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: Delete draft + tags: + - product:chat + get: + description: | + Get a draft + operationId: GetDraft + parameters: + - in: path + name: type + required: true + schema: + type: string + writeOnly: true + x-stream-index: "002.001" + - in: path + name: id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "002.002" + - in: query + name: parent_id + schema: + description: Parent message ID + title: string + type: string + writeOnly: true + x-stream-index: "001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/GetDraftResponse' + 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: Get draft + tags: + - product:chat + post: + description: | + Creates a draft + + Sends events: + - draft.updated + operationId: CreateDraft + parameters: + - in: path + name: type + required: true + schema: + description: Channel type to interact with + title: Channel type + type: string + writeOnly: true + x-stream-index: "002.001" + - in: path + name: id + required: true + schema: + description: Channel ID to interact with + title: Channel ID + type: string + writeOnly: true + x-stream-index: "002.002" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateDraftRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/CreateDraftResponse' + 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: Create a draft + tags: + - product:chat + /api/v2/chat/channels/{type}/{id}/event: + post: + description: | + Sends event to the channel + operationId: SendEvent + parameters: + - in: path + name: type + required: true + schema: + description: Channel type to interact with + title: Channel type + type: string + writeOnly: true + x-stream-index: "002.001" + - in: path + name: id + required: true + schema: + description: Channel ID to interact with + title: Channel ID + type: string + writeOnly: true + x-stream-index: "002.002" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SendEventRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/EventResponse' + 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: Send event + tags: + - product:chat + /api/v2/chat/channels/{type}/{id}/file: + delete: + description: | + Deletes previously uploaded file + operationId: DeleteFile + parameters: + - in: path + name: type + required: true + schema: + description: The type of file + title: Type + type: string + writeOnly: true + x-stream-index: "002.001" + - in: path + name: id + required: true + schema: + description: File ID + title: ID + type: string + writeOnly: true + x-stream-index: "002.002" + - in: query + name: url + schema: + description: File URL to delete + title: URL + type: string + writeOnly: true + x-stream-index: "001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/Response' + 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: Delete file + tags: + - product:chat + post: + description: | + Uploads file + operationId: UploadFile + parameters: + - in: path + name: type + required: true + schema: + type: string + writeOnly: true + x-stream-index: "001.001" + - in: path + name: id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "001.002" + requestBody: + content: + multipart/form-data: + schema: + $ref: '#/components/schemas/FileUploadRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/FileUploadResponse' + description: Successful 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: Upload file + tags: + - product:chat + /api/v2/chat/channels/{type}/{id}/hide: + post: + description: | + Marks channel as hidden for current user + + Sends events: + - channel.hidden + - channel.hidden + operationId: HideChannel + parameters: + - in: path + name: type + required: true + schema: + type: string + writeOnly: true + x-stream-index: "002.001" + - in: path + name: id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "002.002" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/HideChannelRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/HideChannelResponse' + 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: Hide channel + tags: + - product:chat + /api/v2/chat/channels/{type}/{id}/image: + delete: + description: | + Deletes previously uploaded image + operationId: DeleteImage + parameters: + - in: path + name: type + required: true + schema: + description: The type of file + title: Type + type: string + writeOnly: true + x-stream-index: "002.001" + - in: path + name: id + required: true + schema: + description: File ID + title: ID + type: string + writeOnly: true + x-stream-index: "002.002" + - in: query + name: url + schema: + description: File URL to delete + title: URL + type: string + writeOnly: true + x-stream-index: "001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/Response' + 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: Delete image + tags: + - product:chat + post: + description: | + Uploads image + operationId: UploadImage + parameters: + - in: path + name: type + required: true + schema: + type: string + writeOnly: true + x-stream-index: 001.001.001 + - in: path + name: id + required: true + schema: + type: string + writeOnly: true + x-stream-index: 001.001.002 + requestBody: + content: + multipart/form-data: + schema: + $ref: '#/components/schemas/ImageUploadRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/ImageUploadResponse' + description: Successful 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: Upload image + tags: + - product:chat + /api/v2/chat/channels/{type}/{id}/member: + patch: + description: |2+ + + operationId: UpdateMemberPartial + parameters: + - in: path + name: type + required: true + schema: + type: string + writeOnly: true + x-stream-index: "003.001" + - in: path + name: id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "003.002" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateMemberPartialRequest' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateMemberPartialResponse' + description: Successful 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: Partially channel member update + tags: + - product:chat + /api/v2/chat/channels/{type}/{id}/message: + post: + description: | + Sends new message to the specified channel + + Sends events: + - message.new + - message.updated + - message.new + - message.updated + operationId: SendMessage + parameters: + - in: path + name: type + required: true + schema: + description: Channel type to interact with + title: Channel type + type: string + writeOnly: true + x-stream-index: "009.001" + - in: path + name: id + required: true + schema: + description: Channel ID to interact with + title: Channel ID + type: string + writeOnly: true + x-stream-index: "009.002" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SendMessageRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/SendMessageResponse' + description: Successful 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: Send new message + tags: + - product:chat + /api/v2/chat/channels/{type}/{id}/messages: + get: + description: | + Returns list messages found by IDs + operationId: GetManyMessages + parameters: + - in: path + name: type + required: true + schema: + type: string + writeOnly: true + x-stream-index: "002.001" + - in: path + name: id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "002.002" + - in: query + name: ids + required: true + schema: + description: List of comma-separated IDs + items: + type: string + maximum: 50 + minimum: 1 + title: IDs type: array - x-stream-index: "001.004" - duration: - description: Duration of the request in milliseconds - title: Duration + writeOnly: true + x-stream-index: "001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/GetManyMessagesResponse' + description: Successful 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: Get many messages + tags: + - product:chat + /api/v2/chat/channels/{type}/{id}/query: + post: + description: | + This Method creates a channel or returns an existing one with matching attributes + + Sends events: + - channel.created + - member.added + - member.removed + - member.updated + - user.watching.start + operationId: GetOrCreateChannel + parameters: + - in: path + name: type + required: true + schema: + description: Channel type + maxLength: 64 + title: Type + type: string + writeOnly: true + x-stream-index: "001" + - in: path + name: id + required: true + schema: + description: Channel ID (maximum length of 64 characters) + title: ID + type: string + writeOnly: true + x-stream-index: "002" + - in: query + name: connection_id + schema: + description: Websocket connection ID to interact with. You can pass it as + Body or URL parameter + title: Connection ID + type: string + x-stream-index: "012.003" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChannelGetOrCreateRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/ChannelStateResponse' + description: Successful 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: Get or create channel + tags: + - product:chat + /api/v2/chat/channels/{type}/{id}/read: + post: + description: | + Marks channel as read up to the specific message + + Sends events: + - message.read + - message.read + operationId: MarkRead + parameters: + - in: path + name: type + required: true + schema: + type: string + writeOnly: true + x-stream-index: "003.001" + - in: path + name: id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "003.002" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MarkReadRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/MarkReadResponse' + description: Successful 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 read + tags: + - product:chat + /api/v2/chat/channels/{type}/{id}/show: + post: + description: | + Shows previously hidden channel + + Sends events: + - channel.visible + - channel.visible + operationId: ShowChannel + parameters: + - in: path + name: type + required: true + schema: + description: Channel type to interact with + title: Channel type + type: string + writeOnly: true + x-stream-index: "001.001" + - in: path + name: id + required: true + schema: + description: Channel ID to interact with + title: Channel ID + type: string + writeOnly: true + x-stream-index: "001.002" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ShowChannelRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/ShowChannelResponse' + 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: Show channel + tags: + - product:chat + /api/v2/chat/channels/{type}/{id}/stop-watching: + post: + description: | + Call this Method to stop receiving channel events + + Sends events: + - user.watching.stop + - user.watching.stop + operationId: StopWatchingChannel + parameters: + - in: path + name: type + required: true + schema: + type: string + writeOnly: true + x-stream-index: "002.001" + - in: path + name: id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "002.002" + - in: query + name: connection_id + schema: + type: string + x-stream-index: "001.003" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChannelStopWatchingRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/Response' + 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: Stop watching channel + tags: + - product:chat + /api/v2/chat/channels/{type}/{id}/truncate: + post: + description: | + Truncates messages from a channel. Can be applied to the entire channel or scoped to specific members. + + Sends events: + - channel.truncated + - channel.truncated + operationId: TruncateChannel + parameters: + - in: path + name: type + required: true + schema: + type: string + writeOnly: true + x-stream-index: "001.001" + - in: path + name: id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "001.002" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TruncateChannelRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/TruncateChannelResponse' + description: Successful 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: Truncate channel + tags: + - product:chat + /api/v2/chat/channels/{type}/{id}/unread: + post: + description: | + Marks channel as unread from a specific message + operationId: MarkUnread + parameters: + - in: path + name: type + required: true + schema: + type: string + writeOnly: true + x-stream-index: "002.001" + - in: path + name: id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "002.002" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MarkUnreadRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/Response' + 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 unread + tags: + - product:chat + /api/v2/chat/channels/{type}/query: + post: + description: | + This Method creates a channel or returns an existing one with matching attributes + + Sends events: + - channel.created + - member.added + - member.removed + - member.updated + - user.watching.start + operationId: GetOrCreateDistinctChannel + parameters: + - in: path + name: type + required: true + schema: + description: Channel type + maxLength: 64 + title: Type + type: string + writeOnly: true + x-stream-index: "001" + - in: query + name: connection_id + schema: + description: Websocket connection ID to interact with. You can pass it as + Body or URL parameter + title: Connection ID + type: string + x-stream-index: "012.003" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChannelGetOrCreateRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/ChannelStateResponse' + description: Successful 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: Get or create channel + tags: + - product:chat + /api/v2/chat/channels/delete: + post: + description: | + Allows to delete several channels at once asynchronously + + Sends events: + - channel.deleted + - channel.deleted + operationId: DeleteChannels + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteChannelsRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteChannelsResponse' + description: Successful 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: Deletes channels asynchronously + tags: + - product:chat + /api/v2/chat/channels/read: + post: + description: | + Marks channels as read up to the specific message. If no channels is given, mark all channel as read + + Sends events: + - message.read + - message.read + operationId: MarkChannelsRead + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MarkChannelsReadRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/MarkReadResponse' + description: Successful 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 channels as read + tags: + - product:chat + /api/v2/chat/drafts/query: + post: + description: | + Queries draft messages for a user + operationId: QueryDrafts + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueryDraftsRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/QueryDraftsResponse' + description: Successful 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: Query draft messages + tags: + - product:chat + /api/v2/chat/members: + get: + description: | + Find and filter channel members + operationId: QueryMembers + parameters: + - content: + application/json: + schema: + $ref: '#/components/schemas/QueryMembersPayload' + x-stream-index: "001" + in: query + name: payload + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/MembersResponse' + description: Successful 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: Query members + tags: + - product:chat + /api/v2/chat/messages/{id}: + delete: + description: | + Deletes message + + Sends events: + - message.deleted + - message.deleted + operationId: DeleteMessage + parameters: + - in: path + name: id + required: true + schema: + description: Message ID to delete + title: ID + type: string + writeOnly: true + x-stream-index: "001" + - in: query + name: hard + schema: + description: Delete all message reactions and replies as well + title: Hard + type: boolean + writeOnly: true + x-stream-index: "002" + - in: query + name: deleted_by + schema: + type: string + writeOnly: true + x-stream-index: "003" + - in: query + name: delete_for_me + schema: + description: Delete the message only for the user making the request + title: Delete for me + type: boolean + writeOnly: true + x-stream-index: "004" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteMessageResponse' + 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: Delete message + tags: + - product:chat + get: + description: | + Returns message by ID + operationId: GetMessage + parameters: + - in: path + name: id + required: true + schema: + description: ID of the message + title: ID + type: string + writeOnly: true + x-stream-index: "001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/GetMessageResponse' + 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: Get message + tags: + - product:chat + post: + description: | + Updates message with new data + + Sends events: + - message.updated + - message.updated + operationId: UpdateMessage + parameters: + - in: path + name: id + required: true + schema: + description: Message ID + title: ID + type: string + writeOnly: true + x-stream-index: "004.001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateMessageRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateMessageResponse' + 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: Update message + tags: + - product:chat + put: + description: | + Updates certain fields of the message + + Sends events: + - message.updated + - message.updated + operationId: UpdateMessagePartial + parameters: + - in: path + name: id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "003.001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateMessagePartialRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateMessagePartialResponse' + description: Successful 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: Partially message update + tags: + - product:chat + /api/v2/chat/messages/{id}/action: + post: + description: | + Executes message command action with given parameters + + Sends events: + - message.new + - message.new + operationId: RunMessageAction + parameters: + - in: path + name: id + required: true + schema: + description: Message ID + title: ID + type: string + writeOnly: true + x-stream-index: "001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MessageActionRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/MessageResponse' + 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: Run message command action + tags: + - product:chat + /api/v2/chat/messages/{id}/reaction: + post: + description: | + Sends reaction to specified message + + Sends events: + - reaction.new + - reaction.updated + operationId: SendReaction + parameters: + - in: path + name: id + required: true + schema: + description: Message ID to send reaction for + title: ID + type: string + writeOnly: true + x-stream-index: "001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SendReactionRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/SendReactionResponse' + 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: Send reaction + tags: + - product:chat + /api/v2/chat/messages/{id}/reaction/{type}: + delete: + description: | + Removes user reaction from the message + + Sends events: + - reaction.deleted + operationId: DeleteReaction + parameters: + - in: path + name: id + required: true + schema: + description: Message ID to remove reaction from + title: ID + type: string + writeOnly: true + x-stream-index: "001" + - in: path + name: type + required: true + schema: + description: Reaction type to remove + title: Type + type: string + writeOnly: true + x-stream-index: "002" + - in: query + name: user_id + schema: + description: '**Server-side only**. User ID which server acts upon' + title: User ID + type: string + writeOnly: true + x-stream-index: "003" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteReactionResponse' + 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: Delete reaction + tags: + - product:chat + /api/v2/chat/messages/{id}/reactions: + get: + description: | + Returns list of reactions of specific message + operationId: GetReactions + parameters: + - in: path + name: id + required: true + schema: + description: Message ID + title: ID + type: string + writeOnly: true + x-stream-index: "001" + - in: query + name: limit + schema: + description: Number of records to return + format: int32 + title: Limit + type: integer + writeOnly: true + x-stream-index: "002" + - in: query + name: offset + schema: + description: Number of records to offset + format: int32 + title: Offset + type: integer + writeOnly: true + x-stream-index: "003" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/GetReactionsResponse' + description: Successful 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: Get reactions + tags: + - product:chat + post: + description: | + Get reactions on a message + operationId: QueryReactions + parameters: + - in: path + name: id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueryReactionsRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/QueryReactionsResponse' + 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 + tags: + - product:chat + /api/v2/chat/messages/{id}/translate: + post: + description: | + Translates message to a given language using automated translation software + + Sends events: + - message.updated + - message.updated + operationId: TranslateMessage + parameters: + - in: path + name: id + required: true + schema: + description: Message ID + title: ID + type: string + writeOnly: true + x-stream-index: "002.001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TranslateMessageRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/MessageResponse' + 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: Translate message + tags: + - product:chat + /api/v2/chat/messages/{message_id}/polls/{poll_id}/vote: + post: + description: | + Cast a vote on a poll + + Sends events: + - feeds.poll.vote_casted + - feeds.poll.vote_changed + - feeds.poll.vote_removed + - poll.vote_casted + - poll.vote_changed + - poll.vote_removed + operationId: CastPollVote + parameters: + - in: path + name: message_id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "001" + - in: path + name: poll_id + required: true + schema: + description: Poll ID + maxLength: 255 + title: string + type: string + x-stream-index: "003" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CastPollVoteRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/PollVoteResponse' + description: Successful 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: Cast vote + tags: + - product:chat + /api/v2/chat/messages/{message_id}/polls/{poll_id}/vote/{vote_id}: + delete: + description: | + Delete a vote from a poll + + Sends events: + - feeds.poll.vote_removed + - poll.vote_removed + operationId: DeletePollVote + parameters: + - in: path + name: message_id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "002" + - in: path + name: poll_id + required: true + schema: + description: Poll ID + maxLength: 255 + title: string + type: string + x-stream-index: "004" + - in: path + name: vote_id + required: true + schema: + description: Vote ID + maxLength: 255 + title: string + type: string + x-stream-index: "005" + - in: query + name: user_id + schema: + type: string + writeOnly: true + x-stream-index: "001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/PollVoteResponse' + description: Successful 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: Delete vote + tags: + - product:chat + /api/v2/chat/messages/{message_id}/reminders: + delete: + description: | + Deletes a user's created reminder + + Sends events: + - reminder.deleted + operationId: DeleteReminder + parameters: + - in: path + name: message_id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "002" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteReminderResponse' + 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: Delete reminder + tags: + - product:chat + patch: + description: | + Updates an existing reminder + + Sends events: + - reminder.updated + operationId: UpdateReminder + parameters: + - in: path + name: message_id + required: true + schema: type: string - x-stream-index: "002.001" - threads: + writeOnly: true + x-stream-index: "002" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateReminderRequest' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateReminderResponse' + 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: Updates Reminder + tags: + - product:chat + post: + description: | + Creates a new reminder + + Sends events: + - reminder.created + operationId: CreateReminder + parameters: + - in: path + name: message_id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "002" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateReminderRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/ReminderResponseData' + description: Successful 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: Create reminder + tags: + - product:chat + /api/v2/chat/messages/{parent_id}/replies: + get: + description: | + Returns replies (thread) of the message + operationId: GetReplies + parameters: + - in: path + name: parent_id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "001" + - in: query + name: sort + schema: items: - $ref: '#/components/schemas/UnreadCountsThread' + $ref: '#/components/schemas/SortParamRequest' + maximum: 1 type: array - x-stream-index: "001.006" - total_unread_count: + writeOnly: true + x-stream-index: "002" + - in: query + name: limit + schema: + description: 'The maximum number of messages to return (max limit ' format: int32 + minimum: 0 + title: Limit type: integer - x-stream-index: "001.001" - total_unread_count_by_team: - additionalProperties: - format: int32 - type: integer - type: object - x-stream-index: "001.003" - total_unread_threads_count: + x-stream-index: "003.001" + - in: query + name: offset + schema: + description: The offset to start from format: int32 + title: Offset type: integer - x-stream-index: "001.002" - required: - - total_unread_count - - total_unread_threads_count - - channels - - channel_type - - threads - - duration - title: Response - type: object - securitySchemes: - JWT: - description: | - JWT should be always provided when stream-auth-type=jwt. - - Using JWT auth request could be authenticated as user or as server-side. - - When using user authentication permission checking is going to be applied to requests based on the user that is - performing a request. - - The `authorization` header should be a JWT string signed using the secret attached to the API key used to perform - requests. - - **WARNING** all client-side official SDK do not ship with token generation; this is to make sure that the API secret is not - shared with an untrusted party such as a browser or a iOS/Android application. Tokens **must** be generated server-side. - If you wish, you can configure your application to ignore authentication (see `disable_auth_check`) - The JWT string must include only the user_id claim and can include any built-in JWT claim such as iat, exp as well. - in: header - name: Authorization - type: apiKey - api_key: - description: Application API key should be always set in order to authenticate - the request. - in: query - name: api_key - type: apiKey - stream-auth-type: - description: |- - Stream-Auth-Type should be always set in order to authenticate the request. Possible - values: `jwt` or `anonymous`. - - `jwt` allows you to authenticate as a user. With this auth type you should also provide valid JWT in Authorization - header. - - `anonymous` allows you to authenticate as anonymous user. Please note that most advanced features are not available - to anonymous users. - in: header - name: Stream-Auth-Type - type: apiKey -info: - title: Stream API - version: v187.13.0 -openapi: 3.0.3 -paths: - /api/v2/app: - get: - description: | - This Method returns the application settings - operationId: GetApp + x-stream-index: "003.002" + - in: query + name: id_gte + schema: + description: The ID of the message to get messages with a timestamp greater + than or equal to + title: IDGTE + type: string + x-stream-index: "003.003" + - in: query + name: id_gt + schema: + description: The ID of the message to get messages with a timestamp greater + than + title: IDGT + type: string + x-stream-index: "003.004" + - in: query + name: id_lte + schema: + description: The ID of the message to get messages with a timestamp smaller + than or equal to + title: IDLTE + type: string + x-stream-index: "003.005" + - in: query + name: id_lt + schema: + description: The ID of the message to get messages with a timestamp smaller + than + title: IDLT + type: string + x-stream-index: "003.006" + - in: query + name: created_at_after_or_equal + schema: + description: The timestamp to get messages with a created_at timestamp greater + than or equal to + format: date-time + title: Created_at after or equal + type: number + x-stream-index: "003.007" + - in: query + name: created_at_after + schema: + description: The timestamp to get messages with a created_at timestamp greater + than + format: date-time + title: Created_at after + type: number + x-stream-index: "003.008" + - in: query + name: created_at_before_or_equal + schema: + description: The timestamp to get messages with a created_at timestamp smaller + than or equal to + format: date-time + title: Created_at after before or equal + type: number + x-stream-index: "003.009" + - in: query + name: created_at_before + schema: + description: The timestamp to get messages with a created_at timestamp smaller + than + format: date-time + title: Created_at after before + type: number + x-stream-index: "003.010" + - in: query + name: id_around + schema: + description: The result will be a set of messages, that are both older and + newer than the message with the provided ID, and the message with the + ID provided will be in the middle of the set + title: Id around + type: string + x-stream-index: "003.011" + - in: query + name: created_at_around + schema: + description: The result will be a set of messages, that are both older and + newer than the created_at timestamp provided, distributed evenly around + the timestamp + format: date-time + title: Created_at around + type: number + x-stream-index: "003.012" responses: "200": content: application/json: schema: - $ref: '#/components/schemas/GetApplicationResponse' + $ref: '#/components/schemas/GetRepliesResponse' description: Response "400": content: @@ -21121,28 +29793,31 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Get App Settings + summary: Get replies tags: - - product:common - /api/v2/blocklists: + - product:chat + /api/v2/chat/moderation/flags/message: get: description: | - Returns all available block lists - operationId: ListBlockLists + Find and filter message flags + operationId: QueryMessageFlags parameters: - - in: query - name: team - schema: - type: string - writeOnly: true - x-stream-index: "001" + - content: + application/json: + schema: + $ref: '#/components/schemas/QueryMessageFlagsPayload' + description: JSON object with query message flags payload + title: Payload + x-stream-index: "001" + in: query + name: payload responses: "200": content: application/json: schema: - $ref: '#/components/schemas/ListBlockListResponse' - description: Response + $ref: '#/components/schemas/QueryMessageFlagsResponse' + description: QueryMessageFlagsResponse "400": content: application/json: @@ -21155,27 +29830,31 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: List block lists + summary: Query Message Flags tags: - - product:common + - product:chat + /api/v2/chat/moderation/mute/channel: post: description: | - Creates a new application blocklist, once created the blocklist can be used by any channel type - operationId: CreateBlockList + Mutes channel for user + + Sends events: + - channel.muted + - channel.muted + operationId: MuteChannel requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateBlockListRequest' - description: Block list + $ref: '#/components/schemas/MuteChannelRequest' required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/CreateBlockListResponse' - description: Response + $ref: '#/components/schemas/MuteChannelResponse' + description: Successful response "400": content: application/json: @@ -21188,33 +29867,30 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Create block list + summary: Mute channel tags: - - product:common - /api/v2/blocklists/{name}: - delete: + - product:chat + /api/v2/chat/moderation/unmute/channel: + post: description: | - Deletes previously created application blocklist - operationId: DeleteBlockList - parameters: - - in: path - name: name + Unmutes channel for user + + Sends events: + - channel.unmuted + - channel.unmuted + operationId: UnmuteChannel + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UnmuteChannelRequest' required: true - schema: - type: string - writeOnly: true - x-stream-index: "001" - - in: query - name: team - schema: - type: string - x-stream-index: "002" responses: - "200": + "201": content: application/json: schema: - $ref: '#/components/schemas/Response' + $ref: '#/components/schemas/UnmuteResponse' description: Response "400": content: @@ -21228,37 +29904,27 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Delete block list + summary: Unmute channel tags: - - product:common - put: + - product:chat + /api/v2/chat/push_preferences: + post: description: | - Updates contents of the block list - operationId: UpdateBlockList - parameters: - - in: path - name: name - required: true - schema: - description: Block list name - title: Name - type: string - writeOnly: true - x-stream-index: "001" + Update the push preferences for a user and or channel member. Set to all, mentions or none + operationId: UpdatePushNotificationPreferences requestBody: content: application/json: schema: - $ref: '#/components/schemas/UpdateBlockListRequest' - description: Update block list + $ref: '#/components/schemas/UpsertPushPreferencesRequest' required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/UpdateBlockListResponse' - description: Response + $ref: '#/components/schemas/UpsertPushPreferencesResponse' + description: Successful response "400": content: application/json: @@ -21271,37 +29937,64 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Update block list + summary: Push notification preferences tags: - - product:common - /api/v2/chat/channels: - post: + - product:chat + /api/v2/chat/query_banned_users: + get: description: | - Query channels with filter query - operationId: QueryChannels + Find and filter channel scoped or global user bans + operationId: QueryBannedUsers parameters: - - in: query - name: connection_id - schema: - description: Websocket connection ID to interact with. You can pass it as - Body or URL parameter - title: Connection ID - type: string - x-stream-index: "011.003" + - content: + application/json: + schema: + $ref: '#/components/schemas/QueryBannedUsersPayload' + description: JSON object with query user bans payload + title: Payload + x-stream-index: "001" + in: query + name: payload + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/QueryBannedUsersResponse' + description: Successful 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: Query Banned Users + tags: + - product:chat + /api/v2/chat/reminders/query: + post: + description: | + Queries reminders + operationId: QueryReminders requestBody: content: application/json: schema: - $ref: '#/components/schemas/QueryChannelsRequest' - description: Query Channels Request + $ref: '#/components/schemas/QueryRemindersRequest' required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/QueryChannelsResponse' - description: Channels list + $ref: '#/components/schemas/QueryRemindersResponse' + description: Successful response "400": content: application/json: @@ -21314,49 +30007,31 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Query channels + summary: Query reminders tags: - product:chat - /api/v2/chat/channels/{type}/{id}: - delete: + /api/v2/chat/search: + get: description: | - Deletes channel - - Sends events: - - channel.deleted - - channel.deleted - operationId: DeleteChannel - parameters: - - in: path - name: type - required: true - schema: - description: Channel type to interact with - title: Channel type - type: string - writeOnly: true - x-stream-index: "001.001" - - in: path - name: id - required: true - schema: - description: Channel ID to interact with - title: Channel ID - type: string - writeOnly: true - x-stream-index: "001.002" - - in: query - name: hard_delete - schema: - type: boolean - x-stream-index: "002" + Search messages across channels + operationId: Search + parameters: + - content: + application/json: + schema: + $ref: '#/components/schemas/SearchPayload' + description: JSON object with search payload + title: Payload + x-stream-index: "001" + in: query + name: payload responses: "200": content: application/json: schema: - $ref: '#/components/schemas/DeleteChannelResponse' - description: Response + $ref: '#/components/schemas/SearchResponse' + description: Successful response "400": content: application/json: @@ -21369,50 +30044,51 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Delete channel + summary: Search messages tags: - product:chat - patch: + /api/v2/chat/sync: + post: description: | - Updates certain fields of the channel - - Sends events: - - channel.updated - - channel.updated - operationId: UpdateChannelPartial + Returns all events happened since client disconnect in specified channels + operationId: Sync parameters: - - in: path - name: type - required: true + - in: query + name: with_inaccessible_cids schema: - description: Channel type to interact with - title: Channel type - type: string - writeOnly: true - x-stream-index: "001.001" - - in: path - name: id - required: true + description: If set to true this will add 'inaccessible_cids' to response + type + title: With inaccessible CIDs + type: boolean + x-stream-index: "003" + - in: query + name: watch + schema: + description: If set to true this will start watching requested and newly + added channels that user has access to. If error occurred with this option + enabled and it is not an input error - channels will still be watched. + title: Watch synced channels + type: boolean + x-stream-index: "004" + - in: query + name: connection_id schema: - description: Channel ID to interact with - title: Channel ID type: string - writeOnly: true - x-stream-index: "001.002" + x-stream-index: "006.003" requestBody: content: application/json: schema: - $ref: '#/components/schemas/UpdateChannelPartialRequest' - description: UpdateChannelPartialRequest + $ref: '#/components/schemas/SyncRequest' + description: SyncRequest required: true responses: - "200": + "201": content: application/json: schema: - $ref: '#/components/schemas/UpdateChannelPartialResponse' - description: Successful response + $ref: '#/components/schemas/SyncResponse' + description: SyncResponse "400": content: application/json: @@ -21425,53 +30101,32 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Partially update channel + summary: Sync tags: - product:chat + /api/v2/chat/threads: post: description: | - Change channel data - - Sends events: - - channel.updated - - member.added - - member.removed - - member.updated - - message.new - - channel.updated - - member.added - - member.removed - - member.updated - - message.new - operationId: UpdateChannel + Returns the list of threads for specific user + operationId: QueryThreads parameters: - - in: path - name: type - required: true - schema: - type: string - writeOnly: true - x-stream-index: 013.002.001 - - in: path - name: id - required: true + - in: query + name: connection_id schema: type: string - writeOnly: true - x-stream-index: 013.002.002 + x-stream-index: "002" requestBody: content: application/json: schema: - $ref: '#/components/schemas/UpdateChannelRequest' - description: Channel update request + $ref: '#/components/schemas/QueryThreadsRequest' required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/UpdateChannelResponse' + $ref: '#/components/schemas/QueryThreadsResponse' description: Successful response "400": content: @@ -21485,47 +30140,75 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Update channel + summary: Query Threads tags: - product:chat - /api/v2/chat/channels/{type}/{id}/draft: - delete: + /api/v2/chat/threads/{message_id}: + get: description: | - Deletes a draft - - Sends events: - - draft.deleted - operationId: DeleteDraft + Return a specific thread + operationId: GetThread parameters: - in: path - name: type + name: message_id required: true schema: type: string writeOnly: true - x-stream-index: "002.001" - - in: path - name: id - required: true + x-stream-index: "001" + - in: query + name: watch schema: - type: string + description: Start watching the channel this thread belongs to + title: Watch + type: boolean writeOnly: true - x-stream-index: "002.002" + x-stream-index: "002" - in: query - name: parent_id + name: connection_id schema: - description: Parent message ID - title: string type: string writeOnly: true - x-stream-index: "001" + x-stream-index: "003" + - in: query + name: reply_limit + schema: + description: Limit the number of replies returned + format: int32 + minimum: 0 + title: Reply limit + type: integer + writeOnly: true + x-stream-index: "004" + - in: query + name: participant_limit + schema: + description: Limit the number of participants returned + format: int32 + maximum: 100 + minimum: 0 + title: Participant limit + type: integer + writeOnly: true + x-stream-index: "005" + - in: query + name: member_limit + schema: + description: Limit the number of members returned per thread channel + format: int32 + maximum: 100 + minimum: 0 + title: Member limit + type: integer + writeOnly: true + x-stream-index: "006" responses: "200": content: application/json: schema: - $ref: '#/components/schemas/Response' - description: Response + $ref: '#/components/schemas/GetThreadResponse' + description: Successful response "400": content: application/json: @@ -21538,43 +30221,38 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Delete draft + summary: Get Thread tags: - product:chat - get: + patch: description: | - Get a draft - operationId: GetDraft + Updates certain fields of the thread + + Sends events: + - thread.updated + - thread.updated + operationId: UpdateThreadPartial parameters: - in: path - name: type - required: true - schema: - type: string - writeOnly: true - x-stream-index: "002.001" - - in: path - name: id + name: message_id required: true schema: - type: string - writeOnly: true - x-stream-index: "002.002" - - in: query - name: parent_id - schema: - description: Parent message ID - title: string type: string writeOnly: true x-stream-index: "001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateThreadPartialRequest' + required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/GetDraftResponse' - description: Response + $ref: '#/components/schemas/UpdateThreadPartialResponse' + description: Successful response "400": content: application/json: @@ -21587,47 +30265,20 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Get draft + summary: Partially update thread tags: - product:chat - post: + /api/v2/chat/unread: + get: description: | - Creates a draft - - Sends events: - - draft.updated - operationId: CreateDraft - parameters: - - in: path - name: type - required: true - schema: - description: Channel type to interact with - title: Channel type - type: string - writeOnly: true - x-stream-index: "002.001" - - in: path - name: id - required: true - schema: - description: Channel ID to interact with - title: Channel ID - type: string - writeOnly: true - x-stream-index: "002.002" - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CreateDraftRequest' - required: true + Fetch unread counts for a single user + operationId: UnreadCounts responses: - "201": + "200": content: application/json: schema: - $ref: '#/components/schemas/CreateDraftResponse' + $ref: '#/components/schemas/WrappedUnreadCountsResponse' description: Response "400": content: @@ -21641,45 +30292,30 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Create a draft + summary: Unread counts tags: - product:chat - /api/v2/chat/channels/{type}/{id}/event: - post: + /api/v2/devices: + delete: description: | - Sends event to the channel - operationId: SendEvent + Deletes one device + operationId: DeleteDevice parameters: - - in: path - name: type - required: true - schema: - description: Channel type to interact with - title: Channel type - type: string - writeOnly: true - x-stream-index: "002.001" - - in: path + - in: query name: id required: true schema: - description: Channel ID to interact with - title: Channel ID + description: Device ID to delete + title: ID type: string writeOnly: true - x-stream-index: "002.002" - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SendEventRequest' - required: true + x-stream-index: "001" responses: - "201": + "200": content: application/json: schema: - $ref: '#/components/schemas/EventResponse' + $ref: '#/components/schemas/Response' description: Response "400": content: @@ -21693,48 +30329,20 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Send event + summary: Delete device tags: - - product:chat - /api/v2/chat/channels/{type}/{id}/file: - delete: + - product:common + get: description: | - Deletes previously uploaded file - operationId: DeleteFile - parameters: - - in: path - name: type - required: true - schema: - description: The type of file - title: Type - type: string - writeOnly: true - x-stream-index: "002.001" - - in: path - name: id - required: true - schema: - description: File ID - title: ID - type: string - writeOnly: true - x-stream-index: "002.002" - - in: query - name: url - schema: - description: File URL to delete - title: URL - type: string - writeOnly: true - x-stream-index: "001" + Returns all available devices + operationId: ListDevices responses: "200": content: application/json: schema: - $ref: '#/components/schemas/Response' - description: Response + $ref: '#/components/schemas/ListDevicesResponse' + description: ListDevicesResponse "400": content: application/json: @@ -21747,41 +30355,27 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Delete file + summary: List devices tags: - - product:chat + - product:common post: description: | - Uploads file - operationId: UploadFile - parameters: - - in: path - name: type - required: true - schema: - type: string - writeOnly: true - x-stream-index: "001.001" - - in: path - name: id - required: true - schema: - type: string - writeOnly: true - x-stream-index: "001.002" + Adds a new device to a user, if the same device already exists the call will have no effect + operationId: CreateDevice requestBody: content: - multipart/form-data: + application/json: schema: - $ref: '#/components/schemas/FileUploadRequest' + $ref: '#/components/schemas/CreateDeviceRequest' + description: CreateDeviceRequest required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/FileUploadResponse' - description: Successful response + $ref: '#/components/schemas/Response' + description: Response "400": content: application/json: @@ -21794,46 +30388,28 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Upload file + summary: Create device tags: - - product:chat - /api/v2/chat/channels/{type}/{id}/hide: + - product:common + /api/v2/feeds/activities: post: description: | - Marks channel as hidden for current user - - Sends events: - - channel.hidden - - channel.hidden - operationId: HideChannel - parameters: - - in: path - name: type - required: true - schema: - type: string - writeOnly: true - x-stream-index: "002.001" - - in: path - name: id - required: true - schema: - type: string - writeOnly: true - x-stream-index: "002.002" + Create a new activity or update an existing one + operationId: AddActivity requestBody: content: application/json: schema: - $ref: '#/components/schemas/HideChannelRequest' + $ref: '#/components/schemas/AddActivityRequest' + description: Activity Request required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/HideChannelResponse' - description: Response + $ref: '#/components/schemas/AddActivityResponse' + description: Add Activity Response "400": content: application/json: @@ -21846,48 +30422,37 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Hide channel + summary: Add a single activity tags: - - product:chat - /api/v2/chat/channels/{type}/{id}/image: + - product:feeds + /api/v2/feeds/activities/{activity_id}/bookmarks: delete: description: | - Deletes previously uploaded image - operationId: DeleteImage + Deletes a bookmark from an activity + operationId: DeleteBookmark parameters: - in: path - name: type - required: true - schema: - description: The type of file - title: Type - type: string - writeOnly: true - x-stream-index: "002.001" - - in: path - name: id + name: activity_id required: true schema: - description: File ID - title: ID + maxLength: 255 type: string writeOnly: true - x-stream-index: "002.002" + x-stream-index: "001" - in: query - name: url + name: folder_id schema: - description: File URL to delete - title: URL + maxLength: 255 type: string writeOnly: true - x-stream-index: "001" + x-stream-index: "002" responses: "200": content: application/json: schema: - $ref: '#/components/schemas/Response' - description: Response + $ref: '#/components/schemas/DeleteBookmarkResponse' + description: Delete Bookmark Response "400": content: application/json: @@ -21900,41 +30465,80 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Delete image + summary: Delete a bookmark tags: - - product:chat - post: + - product:feeds + patch: description: | - Uploads image - operationId: UploadImage + Updates a bookmark for an activity + operationId: UpdateBookmark parameters: - in: path - name: type + name: activity_id required: true schema: + description: ID of the activity + maxLength: 255 + title: Activity ID type: string writeOnly: true - x-stream-index: 001.001.001 + x-stream-index: "001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateBookmarkRequest' + description: Update Bookmark Request + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateBookmarkResponse' + description: Update Bookmark 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: Update bookmark + tags: + - product:feeds + post: + description: | + Adds a bookmark to an activity + operationId: AddBookmark + parameters: - in: path - name: id + name: activity_id required: true schema: + maxLength: 255 type: string writeOnly: true - x-stream-index: 001.001.002 + x-stream-index: "001" requestBody: content: - multipart/form-data: + application/json: schema: - $ref: '#/components/schemas/ImageUploadRequest' + $ref: '#/components/schemas/AddBookmarkRequest' + description: Add Bookmark Request required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/ImageUploadResponse' - description: Successful response + $ref: '#/components/schemas/AddBookmarkResponse' + description: Add Bookmark Response "400": content: application/json: @@ -21947,42 +30551,37 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Upload image + summary: Add bookmark tags: - - product:chat - /api/v2/chat/channels/{type}/{id}/member: - patch: - description: |2+ - - operationId: UpdateMemberPartial + - product:feeds + /api/v2/feeds/activities/{activity_id}/feedback: + post: + description: | + Submit feedback for an activity including options to show less, hide, report, or mute the user + operationId: ActivityFeedback parameters: - in: path - name: type - required: true - schema: - type: string - writeOnly: true - x-stream-index: "003.001" - - in: path - name: id + name: activity_id required: true schema: + maxLength: 255 type: string writeOnly: true - x-stream-index: "003.002" + x-stream-index: "001" requestBody: content: application/json: schema: - $ref: '#/components/schemas/UpdateMemberPartialRequest' + $ref: '#/components/schemas/ActivityFeedbackRequest' + description: Activity Feedback Request required: true responses: - "200": + "201": content: application/json: schema: - $ref: '#/components/schemas/UpdateMemberPartialResponse' - description: Successful response + $ref: '#/components/schemas/ActivityFeedbackResponse' + description: Activity Feedback Response "400": content: application/json: @@ -21995,51 +30594,51 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Partially channel member update + summary: Provide feedback on an activity tags: - - product:chat - /api/v2/chat/channels/{type}/{id}/message: + - product:feeds + /api/v2/feeds/activities/{activity_id}/polls/{poll_id}/vote: post: - description: | - Sends new message to the specified channel - - Sends events: - - message.new - - message.updated - - message.new - - message.updated - operationId: SendMessage + description: | + Cast a vote on a poll + + Sends events: + - feeds.poll.vote_casted + - feeds.poll.vote_changed + - feeds.poll.vote_removed + - poll.vote_casted + - poll.vote_changed + - poll.vote_removed + operationId: CastPollVote parameters: - in: path - name: type + name: activity_id required: true schema: - description: Channel type to interact with - title: Channel type type: string writeOnly: true - x-stream-index: "009.001" + x-stream-index: "002" - in: path - name: id + name: poll_id required: true schema: - description: Channel ID to interact with - title: Channel ID + description: Poll ID + maxLength: 255 + title: string type: string - writeOnly: true - x-stream-index: "009.002" + x-stream-index: "003" requestBody: content: application/json: schema: - $ref: '#/components/schemas/SendMessageRequest' + $ref: '#/components/schemas/CastPollVoteRequest' required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/SendMessageResponse' + $ref: '#/components/schemas/PollVoteResponse' description: Successful response "400": content: @@ -22053,40 +30652,48 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Send new message + summary: Cast vote tags: - - product:chat - /api/v2/chat/channels/{type}/{id}/messages: - get: + - product:feeds + /api/v2/feeds/activities/{activity_id}/polls/{poll_id}/vote/{vote_id}: + delete: description: | - Returns list messages found by IDs - operationId: GetManyMessages + Delete a vote from a poll + + Sends events: + - feeds.poll.vote_removed + - poll.vote_removed + operationId: DeletePollVote parameters: - in: path - name: type + name: activity_id required: true schema: type: string writeOnly: true - x-stream-index: "002.001" + x-stream-index: "003" - in: path - name: id + name: poll_id required: true schema: + description: Poll ID + maxLength: 255 + title: string type: string - writeOnly: true - x-stream-index: "002.002" - - in: query - name: ids + x-stream-index: "004" + - in: path + name: vote_id required: true schema: - description: List of comma-separated IDs - items: - type: string - maximum: 50 - minimum: 1 - title: IDs - type: array + description: Vote ID + maxLength: 255 + title: string + type: string + x-stream-index: "005" + - in: query + name: user_id + schema: + type: string writeOnly: true x-stream-index: "001" responses: @@ -22094,7 +30701,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GetManyMessagesResponse' + $ref: '#/components/schemas/PollVoteResponse' description: Successful response "400": content: @@ -22108,62 +30715,37 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Get many messages + summary: Delete vote tags: - - product:chat - /api/v2/chat/channels/{type}/{id}/query: + - product:feeds + /api/v2/feeds/activities/{activity_id}/reactions: post: description: | - This Method creates a channel or returns an existing one with matching attributes - - Sends events: - - channel.created - - member.added - - member.removed - - member.updated - - user.watching.start - operationId: GetOrCreateChannel + Adds a reaction to an activity + operationId: AddReaction parameters: - in: path - name: type + name: activity_id required: true schema: - description: Channel type - maxLength: 64 - title: Type + maxLength: 255 type: string writeOnly: true x-stream-index: "001" - - in: path - name: id - required: true - schema: - description: Channel ID (maximum length of 64 characters) - title: ID - type: string - writeOnly: true - x-stream-index: "002" - - in: query - name: connection_id - schema: - description: Websocket connection ID to interact with. You can pass it as - Body or URL parameter - title: Connection ID - type: string - x-stream-index: "012.003" requestBody: content: application/json: schema: - $ref: '#/components/schemas/ChannelGetOrCreateRequest' + $ref: '#/components/schemas/AddReactionRequest' + description: Add Reaction Request required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/ChannelStateResponse' - description: Successful response + $ref: '#/components/schemas/AddReactionResponse' + description: Add Reaction Response "400": content: application/json: @@ -22176,46 +30758,38 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Get or create channel + summary: Add reaction tags: - - product:chat - /api/v2/chat/channels/{type}/{id}/read: - post: + - product:feeds + /api/v2/feeds/activities/{activity_id}/reactions/{type}: + delete: description: | - Marks channel as read up to the specific message - - Sends events: - - message.read - - message.read - operationId: MarkRead + Removes a reaction from an activity + operationId: DeleteActivityReaction parameters: - in: path - name: type + name: activity_id required: true schema: + maxLength: 255 type: string writeOnly: true - x-stream-index: "003.001" + x-stream-index: "001" - in: path - name: id + name: type required: true schema: + maxLength: 255 type: string writeOnly: true - x-stream-index: "003.002" - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MarkReadRequest' - required: true + x-stream-index: "002" responses: - "201": + "200": content: application/json: schema: - $ref: '#/components/schemas/MarkReadResponse' - description: Successful response + $ref: '#/components/schemas/DeleteActivityReactionResponse' + description: Delete Activity Reaction Response "400": content: application/json: @@ -22228,49 +30802,34 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Mark read + summary: Remove reaction tags: - - product:chat - /api/v2/chat/channels/{type}/{id}/show: + - product:feeds + /api/v2/feeds/activities/{activity_id}/reactions/query: post: description: | - Shows previously hidden channel - - Sends events: - - channel.visible - - channel.visible - operationId: ShowChannel + Query activity reactions + operationId: QueryActivityReactions parameters: - in: path - name: type - required: true - schema: - description: Channel type to interact with - title: Channel type - type: string - writeOnly: true - x-stream-index: "001.001" - - in: path - name: id + name: activity_id required: true schema: - description: Channel ID to interact with - title: Channel ID type: string writeOnly: true - x-stream-index: "001.002" + x-stream-index: "001" requestBody: content: application/json: schema: - $ref: '#/components/schemas/ShowChannelRequest' + $ref: '#/components/schemas/QueryActivityReactionsRequest' required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/ShowChannelResponse' + $ref: '#/components/schemas/QueryActivityReactionsResponse' description: Response "400": content: @@ -22284,51 +30843,39 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Show channel + summary: Query activity reactions tags: - - product:chat - /api/v2/chat/channels/{type}/{id}/stop-watching: - post: + - product:feeds + /api/v2/feeds/activities/{id}: + delete: description: | - Call this Method to stop receiving channel events - - Sends events: - - user.watching.stop - - user.watching.stop - operationId: StopWatchingChannel + Delete a single activity by its ID + operationId: DeleteActivity parameters: - - in: path - name: type - required: true - schema: - type: string - writeOnly: true - x-stream-index: "002.001" - in: path name: id required: true schema: + maxLength: 255 type: string writeOnly: true - x-stream-index: "002.002" + x-stream-index: "001" - in: query - name: connection_id + name: hard_delete schema: - type: string - x-stream-index: "001.003" - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ChannelStopWatchingRequest' - required: true + description: Whether to permanently delete the activity instead of soft + delete + title: boolean + type: boolean + writeOnly: true + x-stream-index: "002" responses: - "201": + "200": content: application/json: schema: - $ref: '#/components/schemas/Response' - description: Response + $ref: '#/components/schemas/DeleteActivityResponse' + description: Delete Activity Response "400": content: application/json: @@ -22341,46 +30888,28 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Stop watching channel + summary: Delete a single activity tags: - - product:chat - /api/v2/chat/channels/{type}/{id}/truncate: - post: + - product:feeds + get: description: | - Truncates messages from a channel. Can be applied to the entire channel or scoped to specific members. - - Sends events: - - channel.truncated - - channel.truncated - operationId: TruncateChannel + Returns activity by ID + operationId: GetActivity parameters: - - in: path - name: type - required: true - schema: - type: string - writeOnly: true - x-stream-index: "001.001" - in: path name: id required: true schema: type: string writeOnly: true - x-stream-index: "001.002" - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/TruncateChannelRequest' - required: true + x-stream-index: "001" responses: - "201": + "200": content: application/json: schema: - $ref: '#/components/schemas/TruncateChannelResponse' - description: Successful response + $ref: '#/components/schemas/GetActivityResponse' + description: Get Activity Response "400": content: application/json: @@ -22393,42 +30922,38 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Truncate channel + summary: Get activity tags: - - product:chat - /api/v2/chat/channels/{type}/{id}/unread: - post: + - product:feeds + patch: description: | - Marks channel as unread from a specific message - operationId: MarkUnread - parameters: - - in: path - name: type - required: true - schema: - type: string - writeOnly: true - x-stream-index: "002.001" + Updates certain fields of the activity + + Sends events: + - feeds.activity.updated + operationId: UpdateActivityPartial + parameters: - in: path name: id required: true schema: + maxLength: 255 type: string writeOnly: true - x-stream-index: "002.002" + x-stream-index: "001" requestBody: content: application/json: schema: - $ref: '#/components/schemas/MarkUnreadRequest' + $ref: '#/components/schemas/UpdateActivityPartialRequest' required: true responses: - "201": + "200": content: application/json: schema: - $ref: '#/components/schemas/Response' - description: Response + $ref: '#/components/schemas/UpdateActivityPartialResponse' + description: Successful response "400": content: application/json: @@ -22441,52 +30966,37 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Mark unread + summary: Partially activity update tags: - - product:chat - /api/v2/chat/channels/{type}/query: - post: + - product:feeds + put: description: | - This Method creates a channel or returns an existing one with matching attributes + Replaces an activity with the provided data Sends events: - - channel.created - - member.added - - member.removed - - member.updated - - user.watching.start - operationId: GetOrCreateDistinctChannel + - feeds.activity.updated + operationId: UpdateActivity parameters: - in: path - name: type + name: id required: true schema: - description: Channel type - maxLength: 64 - title: Type + maxLength: 255 type: string writeOnly: true x-stream-index: "001" - - in: query - name: connection_id - schema: - description: Websocket connection ID to interact with. You can pass it as - Body or URL parameter - title: Connection ID - type: string - x-stream-index: "012.003" requestBody: content: application/json: schema: - $ref: '#/components/schemas/ChannelGetOrCreateRequest' + $ref: '#/components/schemas/UpdateActivityRequest' required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/ChannelStateResponse' + $ref: '#/components/schemas/UpdateActivityResponse' description: Successful response "400": content: @@ -22500,31 +31010,28 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Get or create channel + summary: Full activity update tags: - - product:chat - /api/v2/chat/channels/delete: + - product:feeds + /api/v2/feeds/activities/batch: post: description: | - Allows to delete several channels at once asynchronously - - Sends events: - - channel.deleted - - channel.deleted - operationId: DeleteChannels + Create new activities or update existing ones in a batch operation + operationId: UpsertActivities requestBody: content: application/json: schema: - $ref: '#/components/schemas/DeleteChannelsRequest' + $ref: '#/components/schemas/UpsertActivitiesRequest' + description: Upsert Activities Request required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/DeleteChannelsResponse' - description: Successful response + $ref: '#/components/schemas/UpsertActivitiesResponse' + description: Upsert Activities Response "400": content: application/json: @@ -22537,31 +31044,28 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Deletes channels asynchronously + summary: Upsert multiple activities tags: - - product:chat - /api/v2/chat/channels/read: + - product:feeds + /api/v2/feeds/activities/delete: post: description: | - Marks channels as read up to the specific message. If no channels is given, mark all channel as read - - Sends events: - - message.read - - message.read - operationId: MarkChannelsRead + Delete one or more activities by their IDs + operationId: DeleteActivities requestBody: content: application/json: schema: - $ref: '#/components/schemas/MarkChannelsReadRequest' + $ref: '#/components/schemas/DeleteActivitiesRequest' + description: Delete Activities Request required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/MarkReadResponse' - description: Successful response + $ref: '#/components/schemas/DeleteActivitiesResponse' + description: Delete Activities Response "400": content: application/json: @@ -22574,27 +31078,28 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Mark channels as read + summary: Remove multiple activities tags: - - product:chat - /api/v2/chat/drafts/query: + - product:feeds + /api/v2/feeds/activities/query: post: description: | - Queries draft messages for a user - operationId: QueryDrafts + Query activities based on filters with pagination and sorting options + operationId: QueryActivities requestBody: content: application/json: schema: - $ref: '#/components/schemas/QueryDraftsRequest' + $ref: '#/components/schemas/QueryActivitiesRequest' + description: Query Activities Request required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/QueryDraftsResponse' - description: Successful response + $ref: '#/components/schemas/QueryActivitiesResponse' + description: Query Activities Response "400": content: application/json: @@ -22607,29 +31112,30 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Query draft messages + summary: Query activities tags: - - product:chat - /api/v2/chat/members: - get: + - product:feeds + /api/v2/feeds/bookmark_folders/{folder_id}: + delete: description: | - Find and filter channel members - operationId: QueryMembers + Delete a bookmark folder by its ID + operationId: DeleteBookmarkFolder parameters: - - content: - application/json: - schema: - $ref: '#/components/schemas/QueryMembersPayload' - x-stream-index: "001" - in: query - name: payload + - in: path + name: folder_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" responses: "200": content: application/json: schema: - $ref: '#/components/schemas/MembersResponse' - description: Successful response + $ref: '#/components/schemas/DeleteBookmarkFolderResponse' + description: Delete Bookmark Folder Response "400": content: application/json: @@ -22642,49 +31148,36 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Query members + summary: Delete a bookmark folder tags: - - product:chat - /api/v2/chat/messages/{id}: - delete: + - product:feeds + patch: description: | - Deletes message - - Sends events: - - message.deleted - - message.deleted - operationId: DeleteMessage + Update a bookmark folder by its ID + operationId: UpdateBookmarkFolder parameters: - in: path - name: id + name: folder_id required: true schema: - description: Message ID to delete - title: ID + maxLength: 255 type: string writeOnly: true x-stream-index: "001" - - in: query - name: hard - schema: - description: Delete all message reactions and replies as well - title: Hard - type: boolean - writeOnly: true - x-stream-index: "002" - - in: query - name: deleted_by - schema: - type: string - writeOnly: true - x-stream-index: "003" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateBookmarkFolderRequest' + description: Update Bookmark Folder Request + required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/DeleteMessageResponse' - description: Response + $ref: '#/components/schemas/UpdateBookmarkFolderResponse' + description: Update Bookmark Folder Response "400": content: application/json: @@ -22697,30 +31190,165 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Delete message + summary: Update a bookmark folder tags: - - product:chat + - product:feeds + /api/v2/feeds/bookmark_folders/query: + post: + description: | + Query bookmark folders with filter query + operationId: QueryBookmarkFolders + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueryBookmarkFoldersRequest' + description: Query Bookmark Folders Request + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/QueryBookmarkFoldersResponse' + description: Query Bookmark Folders 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: Query bookmark folders + tags: + - product:feeds + /api/v2/feeds/bookmarks/query: + post: + description: | + Query bookmarks with filter query + operationId: QueryBookmarks + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueryBookmarksRequest' + description: Query Bookmarks Request + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/QueryBookmarksResponse' + description: Query Bookmarks 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: Query bookmarks + tags: + - product:feeds + /api/v2/feeds/comments: get: description: | - Returns message by ID - operationId: GetMessage + Retrieve a threaded list of comments for a specific object (e.g., activity), with configurable depth, sorting, and pagination + operationId: GetComments parameters: - - in: path - name: id + - in: query + name: object_id required: true schema: - description: ID of the message - title: ID + description: ID of the object to get comments for + title: Object ID type: string writeOnly: true x-stream-index: "001" + - in: query + name: object_type + required: true + schema: + description: Type of the object to get comments for + title: Object Type + type: string + writeOnly: true + x-stream-index: "002" + - in: query + name: depth + schema: + description: Maximum nested depth to return (0 = only first level) + format: int32 + maximum: 5 + minimum: 0 + title: Max Depth + type: integer + writeOnly: true + x-stream-index: "003" + - in: query + name: sort + schema: + description: Sort order for the comments + enum: + - first + - last + - top + - best + - controversial + title: Sort Order + type: string + writeOnly: true + x-stream-index: "004" + - in: query + name: replies_limit + schema: + format: int32 + maximum: 20 + minimum: 0 + type: integer + writeOnly: true + x-stream-index: "005" + - in: query + name: limit + schema: + description: Max number of top‑level comments to return + format: int32 + maximum: 100 + minimum: 0 + title: Root Limit + type: integer + writeOnly: true + x-stream-index: "006.001" + - in: query + name: prev + schema: + type: string + writeOnly: true + x-stream-index: "006.002" + - in: query + name: next + schema: + type: string + writeOnly: true + x-stream-index: "006.003" responses: "200": content: application/json: schema: - $ref: '#/components/schemas/GetMessageResponse' - description: Response + $ref: '#/components/schemas/GetCommentsResponse' + description: Get Comments Response "400": content: application/json: @@ -22733,40 +31361,27 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Get message + summary: Get comments for an object tags: - - product:chat + - product:feeds post: description: | - Updates message with new data - - Sends events: - - message.updated - - message.updated - operationId: UpdateMessage - parameters: - - in: path - name: id - required: true - schema: - description: Message ID - title: ID - type: string - writeOnly: true - x-stream-index: "004.001" + Adds a comment to an object (e.g., activity) or a reply to an existing comment, and broadcasts appropriate events + operationId: AddComment requestBody: content: application/json: schema: - $ref: '#/components/schemas/UpdateMessageRequest' + $ref: '#/components/schemas/AddCommentRequest' + description: Add Comment Request required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/UpdateMessageResponse' - description: Response + $ref: '#/components/schemas/AddCommentResponse' + description: Add Comment Response "400": content: application/json: @@ -22779,17 +31394,14 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Update message + summary: Add a comment or reply tags: - - product:chat - put: + - product:feeds + /api/v2/feeds/comments/{id}: + delete: description: | - Updates certain fields of the message - - Sends events: - - message.updated - - message.updated - operationId: UpdateMessagePartial + Deletes a comment from an object (e.g., activity) and broadcasts appropriate events + operationId: DeleteComment parameters: - in: path name: id @@ -22797,20 +31409,22 @@ paths: schema: type: string writeOnly: true - x-stream-index: "003.001" - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/UpdateMessagePartialRequest' - required: true + x-stream-index: "001" + - in: query + name: hard_delete + schema: + description: Whether to permanently delete the comment instead of soft delete + title: Hard Delete + type: boolean + writeOnly: true + x-stream-index: "002" responses: - "201": + "200": content: application/json: schema: - $ref: '#/components/schemas/UpdateMessagePartialResponse' - description: Successful response + $ref: '#/components/schemas/DeleteCommentResponse' + description: Delete Comment Response "400": content: application/json: @@ -22823,41 +31437,28 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Partially message update + summary: Delete a comment tags: - - product:chat - /api/v2/chat/messages/{id}/action: - post: + - product:feeds + get: description: | - Executes message command action with given parameters - - Sends events: - - message.new - - message.new - operationId: RunMessageAction + Get a comment by ID + operationId: GetComment parameters: - in: path name: id required: true schema: - description: Message ID - title: ID type: string writeOnly: true x-stream-index: "001" - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MessageActionRequest' - required: true responses: - "201": + "200": content: application/json: schema: - $ref: '#/components/schemas/MessageResponse' - description: Response + $ref: '#/components/schemas/GetCommentResponse' + description: Get Comment Response "400": content: application/json: @@ -22870,25 +31471,18 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Run message command action + summary: Get comment tags: - - product:chat - /api/v2/chat/messages/{id}/reaction: - post: + - product:feeds + patch: description: | - Sends reaction to specified message - - Sends events: - - reaction.new - - reaction.updated - operationId: SendReaction + Updates a comment on an object (e.g., activity) and broadcasts appropriate events + operationId: UpdateComment parameters: - in: path name: id required: true schema: - description: Message ID to send reaction for - title: ID type: string writeOnly: true x-stream-index: "001" @@ -22896,15 +31490,16 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SendReactionRequest' + $ref: '#/components/schemas/UpdateCommentRequest' + description: Update Comment Request required: true responses: - "201": + "200": content: application/json: schema: - $ref: '#/components/schemas/SendReactionResponse' - description: Response + $ref: '#/components/schemas/UpdateCommentResponse' + description: Update Comment Response "400": content: application/json: @@ -22917,51 +31512,36 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Send reaction + summary: Update a comment tags: - - product:chat - /api/v2/chat/messages/{id}/reaction/{type}: - delete: + - product:feeds + /api/v2/feeds/comments/{id}/reactions: + post: description: | - Removes user reaction from the message - - Sends events: - - reaction.deleted - operationId: DeleteReaction + Adds a reaction to a comment + operationId: AddCommentReaction parameters: - in: path name: id required: true schema: - description: Message ID to remove reaction from - title: ID + maxLength: 255 type: string writeOnly: true x-stream-index: "001" - - in: path - name: type + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AddCommentReactionRequest' required: true - schema: - description: Reaction type to remove - title: Type - type: string - writeOnly: true - x-stream-index: "002" - - in: query - name: user_id - schema: - description: '**Server-side only**. User ID which server acts upon' - title: User ID - type: string - writeOnly: true - x-stream-index: "003" responses: - "200": + "201": content: application/json: schema: - $ref: '#/components/schemas/DeleteReactionResponse' - description: Response + $ref: '#/components/schemas/AddCommentReactionResponse' + description: Successful response "400": content: application/json: @@ -22974,49 +31554,38 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Delete reaction + summary: Add comment reaction tags: - - product:chat - /api/v2/chat/messages/{id}/reactions: - get: + - product:feeds + /api/v2/feeds/comments/{id}/reactions/{type}: + delete: description: | - Returns list of reactions of specific message - operationId: GetReactions + Deletes a reaction from a comment + operationId: DeleteCommentReaction parameters: - in: path name: id required: true schema: - description: Message ID - title: ID + maxLength: 255 type: string writeOnly: true x-stream-index: "001" - - in: query - name: limit + - in: path + name: type + required: true schema: - description: Number of records to return - format: int32 - title: Limit - type: integer + maxLength: 255 + type: string writeOnly: true x-stream-index: "002" - - in: query - name: offset - schema: - description: Number of records to offset - format: int32 - title: Offset - type: integer - writeOnly: true - x-stream-index: "003" responses: "200": content: application/json: schema: - $ref: '#/components/schemas/GetReactionsResponse' - description: Successful response + $ref: '#/components/schemas/DeleteCommentReactionResponse' + description: Delete Comment Reaction Response "400": content: application/json: @@ -23029,13 +31598,14 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Get reactions + summary: Delete comment reaction tags: - - product:chat + - product:feeds + /api/v2/feeds/comments/{id}/reactions/query: post: description: | - Get reactions on a message - operationId: QueryReactions + Query comment reactions + operationId: QueryCommentReactions parameters: - in: path name: id @@ -23048,14 +31618,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/QueryReactionsRequest' + $ref: '#/components/schemas/QueryCommentReactionsRequest' required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/QueryReactionsResponse' + $ref: '#/components/schemas/QueryCommentReactionsResponse' description: Response "400": content: @@ -23069,40 +31639,87 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests + summary: Query comment reactions tags: - - product:chat - /api/v2/chat/messages/{id}/translate: - post: + - product:feeds + /api/v2/feeds/comments/{id}/replies: + get: description: | - Translates message to a given language using automated translation software - - Sends events: - - message.updated - - message.updated - operationId: TranslateMessage + Retrieve a threaded list of replies for a single comment, with configurable depth, sorting, and pagination + operationId: GetCommentReplies parameters: - in: path name: id required: true schema: - description: Message ID - title: ID type: string writeOnly: true - x-stream-index: "002.001" - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/TranslateMessageRequest' - required: true + x-stream-index: "001" + - in: query + name: depth + schema: + description: Maximum nested depth to return (0 = unlimited) + format: int32 + maximum: 5 + minimum: 0 + title: Max Depth + type: integer + writeOnly: true + x-stream-index: "002" + - in: query + name: sort + schema: + description: first (oldest), last (newest) or top + enum: + - first + - last + - top + - best + - controversial + title: Sort Order + type: string + writeOnly: true + x-stream-index: "003" + - in: query + name: replies_limit + schema: + description: Max number of replies to return + format: int32 + minimum: 0 + title: Replies Limit + type: integer + writeOnly: true + x-stream-index: "004" + - in: query + name: limit + schema: + description: Max number of direct replies to return + format: int32 + maximum: 100 + minimum: 0 + title: Reply Limit + type: integer + writeOnly: true + x-stream-index: "005.001" + - in: query + name: prev + schema: + type: string + writeOnly: true + x-stream-index: "005.002" + - in: query + name: next + schema: + type: string + writeOnly: true + x-stream-index: "005.003" responses: - "201": + "200": content: application/json: schema: - $ref: '#/components/schemas/MessageResponse' - description: Response + $ref: '#/components/schemas/GetCommentRepliesResponse' + description: Get Comment Replies Response "400": content: application/json: @@ -23115,52 +31732,62 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Translate message + summary: Get replies for a comment tags: - - product:chat - /api/v2/chat/messages/{message_id}/polls/{poll_id}/vote: + - product:feeds + /api/v2/feeds/comments/batch: post: description: | - Cast a vote on a poll - - Sends events: - - feeds.poll.vote_casted - - feeds.poll.vote_changed - - feeds.poll.vote_removed - - poll.vote_casted - - poll.vote_changed - - poll.vote_removed - operationId: CastPollVote - parameters: - - in: path - name: message_id - required: true - schema: - type: string - writeOnly: true - x-stream-index: "001" - - in: path - name: poll_id + Adds multiple comments in a single request. Each comment must specify the object type and ID. + operationId: AddCommentsBatch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AddCommentsBatchRequest' + description: Add Comments Batch Request required: true - schema: - description: Poll ID - maxLength: 255 - title: string - type: string - x-stream-index: "003" + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/AddCommentsBatchResponse' + description: Add Comments Batch 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: Add multiple comments in a batch + tags: + - product:feeds + /api/v2/feeds/comments/query: + post: + description: | + Query comments using MongoDB-style filters with pagination and sorting options + operationId: QueryComments requestBody: content: application/json: schema: - $ref: '#/components/schemas/CastPollVoteRequest' + $ref: '#/components/schemas/QueryCommentsRequest' + description: Query Comments Request required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/PollVoteResponse' - description: Successful response + $ref: '#/components/schemas/QueryCommentsResponse' + description: Query Comments Response "400": content: application/json: @@ -23173,57 +31800,46 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Cast vote + summary: Query comments tags: - - product:chat - /api/v2/chat/messages/{message_id}/polls/{poll_id}/vote/{vote_id}: + - product:feeds + /api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}: delete: description: | - Delete a vote from a poll - - Sends events: - - feeds.poll.vote_removed - - poll.vote_removed - operationId: DeletePollVote + Delete a single feed by its ID + operationId: DeleteFeed parameters: - in: path - name: message_id - required: true - schema: - type: string - writeOnly: true - x-stream-index: "002" - - in: path - name: poll_id + name: feed_group_id required: true schema: - description: Poll ID maxLength: 255 - title: string type: string - x-stream-index: "004" + writeOnly: true + x-stream-index: "001" - in: path - name: vote_id + name: feed_id required: true schema: - description: Vote ID maxLength: 255 - title: string type: string - x-stream-index: "005" + writeOnly: true + x-stream-index: "002" - in: query - name: user_id + name: hard_delete schema: - type: string + description: Whether to permanently delete the feed instead of soft delete + title: boolean + type: boolean writeOnly: true - x-stream-index: "001" + x-stream-index: "003" responses: "200": content: application/json: schema: - $ref: '#/components/schemas/PollVoteResponse' - description: Successful response + $ref: '#/components/schemas/DeleteFeedResponse' + description: Delete Feed Response "400": content: application/json: @@ -23236,31 +31852,51 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Delete vote + summary: Delete a single feed tags: - - product:chat - /api/v2/chat/messages/{message_id}/reminders: - delete: + - product:feeds + post: description: | - Deletes a user's created reminder - - Sends events: - - reminder.deleted - operationId: DeleteReminder + Create a single feed for a given feed group + operationId: GetOrCreateFeed parameters: - in: path - name: message_id + name: feed_group_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + - in: path + name: feed_id required: true schema: + maxLength: 255 type: string writeOnly: true x-stream-index: "002" + - in: query + name: connection_id + schema: + description: Websocket connection ID to interact with. You can pass it as + Body or URL parameter + title: Connection ID + type: string + x-stream-index: "015.003" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GetOrCreateFeedRequest' + description: ClientRequest + required: true responses: - "200": + "201": content: application/json: schema: - $ref: '#/components/schemas/DeleteReminderResponse' + $ref: '#/components/schemas/GetOrCreateFeedResponse' description: Response "400": content: @@ -23274,21 +31910,27 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Delete reminder + summary: Create a new feed tags: - - product:chat - patch: + - product:feeds + put: description: | - Updates an existing reminder - - Sends events: - - reminder.updated - operationId: UpdateReminder + Update an existing feed + operationId: UpdateFeed parameters: - in: path - name: message_id + name: feed_group_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + - in: path + name: feed_id required: true schema: + maxLength: 255 type: string writeOnly: true x-stream-index: "002" @@ -23296,15 +31938,16 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/UpdateReminderRequest' + $ref: '#/components/schemas/UpdateFeedRequest' + description: Update Feed Request required: true responses: - "200": + "201": content: application/json: schema: - $ref: '#/components/schemas/UpdateReminderResponse' - description: Response + $ref: '#/components/schemas/UpdateFeedResponse' + description: Update Feed Response "400": content: application/json: @@ -23317,37 +31960,45 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Updates Reminder + summary: Update a feed tags: - - product:chat - post: + - product:feeds + /api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/activities/{activity_id}/pin: + delete: description: | - Creates a new reminder - - Sends events: - - reminder.created - operationId: CreateReminder + Unpin an activity from a feed. This removes the pin, so the activity will no longer be displayed at the top of the feed. + operationId: UnpinActivity parameters: - in: path - name: message_id + name: feed_group_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + - in: path + name: feed_id required: true schema: + maxLength: 255 type: string writeOnly: true x-stream-index: "002" - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CreateReminderRequest' + - in: path + name: activity_id required: true + schema: + type: string + writeOnly: true + x-stream-index: "003" responses: - "201": + "200": content: application/json: schema: - $ref: '#/components/schemas/ReminderResponseData' - description: Successful response + $ref: '#/components/schemas/UnpinActivityResponse' + description: Unpin Activity Response "400": content: application/json: @@ -23360,141 +32011,101 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Create reminder + summary: Unpin an activity from a feed tags: - - product:chat - /api/v2/chat/messages/{parent_id}/replies: - get: + - product:feeds + post: description: | - Returns replies (thread) of the message - operationId: GetReplies + Pin an activity to a feed. Pinned activities are typically displayed at the top of a feed. + operationId: PinActivity parameters: - in: path - name: parent_id + name: feed_group_id required: true schema: + maxLength: 255 type: string writeOnly: true x-stream-index: "001" - - in: query - name: sort + - in: path + name: feed_id + required: true schema: - items: - $ref: '#/components/schemas/SortParamRequest' - maximum: 1 - type: array + maxLength: 255 + type: string writeOnly: true x-stream-index: "002" - - in: query - name: limit - schema: - description: 'The maximum number of messages to return (max limit ' - format: int32 - minimum: 0 - title: Limit - type: integer - x-stream-index: "003.001" - - in: query - name: offset - schema: - description: The offset to start from - format: int32 - title: Offset - type: integer - x-stream-index: "003.002" - - in: query - name: id_gte - schema: - description: The ID of the message to get messages with a timestamp greater - than or equal to - title: IDGTE - type: string - x-stream-index: "003.003" - - in: query - name: id_gt - schema: - description: The ID of the message to get messages with a timestamp greater - than - title: IDGT - type: string - x-stream-index: "003.004" - - in: query - name: id_lte - schema: - description: The ID of the message to get messages with a timestamp smaller - than or equal to - title: IDLTE - type: string - x-stream-index: "003.005" - - in: query - name: id_lt + - in: path + name: activity_id + required: true schema: - description: The ID of the message to get messages with a timestamp smaller - than - title: IDLT type: string - x-stream-index: "003.006" - - in: query - name: created_at_after_or_equal - schema: - description: The timestamp to get messages with a created_at timestamp greater - than or equal to - format: date-time - title: Created_at after or equal - type: number - x-stream-index: "003.007" - - in: query - name: created_at_after - schema: - description: The timestamp to get messages with a created_at timestamp greater - than - format: date-time - title: Created_at after - type: number - x-stream-index: "003.008" - - in: query - name: created_at_before_or_equal - schema: - description: The timestamp to get messages with a created_at timestamp smaller - than or equal to - format: date-time - title: Created_at after before or equal - type: number - x-stream-index: "003.009" - - in: query - name: created_at_before - schema: - description: The timestamp to get messages with a created_at timestamp smaller - than - format: date-time - title: Created_at after before - type: number - x-stream-index: "003.010" - - in: query - name: id_around + writeOnly: true + x-stream-index: "003" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PinActivityRequest' + description: Pin Activity Request + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/PinActivityResponse' + description: Pin Activity 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: Pin an activity to a feed + tags: + - product:feeds + /api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/activities/mark/batch: + post: + description: | + Mark activities as read/seen/watched. Can mark by timestamp (seen), activity IDs (read), or all as read. + operationId: MarkActivity + parameters: + - in: path + name: feed_group_id + required: true schema: - description: The result will be a set of messages, that are both older and - newer than the message with the provided ID, and the message with the - ID provided will be in the middle of the set - title: Id around + maxLength: 255 type: string - x-stream-index: "003.011" - - in: query - name: created_at_around + writeOnly: true + x-stream-index: "001" + - in: path + name: feed_id + required: true schema: - description: The result will be a set of messages, that are both older and - newer than the created_at timestamp provided, distributed evenly around - the timestamp - format: date-time - title: Created_at around - type: number - x-stream-index: "003.012" + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "002" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MarkActivityRequest' + description: Mark Activity Request + required: true responses: - "200": + "201": content: application/json: schema: - $ref: '#/components/schemas/GetRepliesResponse' + $ref: '#/components/schemas/Response' description: Response "400": content: @@ -23508,31 +32119,45 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Get replies + summary: Mark activities as read/seen/watched tags: - - product:chat - /api/v2/chat/moderation/flags/message: - get: + - product:feeds + /api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/members: + patch: description: | - Find and filter message flags - operationId: QueryMessageFlags + Add, remove, or set members for a feed + operationId: UpdateFeedMembers parameters: - - content: + - in: path + name: feed_group_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + - in: path + name: feed_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "002" + requestBody: + content: application/json: schema: - $ref: '#/components/schemas/QueryMessageFlagsPayload' - description: JSON object with query message flags payload - title: Payload - x-stream-index: "001" - in: query - name: payload + $ref: '#/components/schemas/UpdateFeedMembersRequest' + description: Update Feed Members Request + required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/QueryMessageFlagsResponse' - description: QueryMessageFlagsResponse + $ref: '#/components/schemas/UpdateFeedMembersResponse' + description: Response "400": content: application/json: @@ -23545,31 +32170,45 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Query Message Flags + summary: Update feed members tags: - - product:chat - /api/v2/chat/moderation/mute/channel: + - product:feeds + /api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/members/accept: post: description: | - Mutes channel for user - - Sends events: - - channel.muted - - channel.muted - operationId: MuteChannel + Accepts a pending feed member request + operationId: AcceptFeedMemberInvite + parameters: + - in: path + name: feed_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + - in: path + name: feed_group_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "002" requestBody: content: application/json: schema: - $ref: '#/components/schemas/MuteChannelRequest' + $ref: '#/components/schemas/AcceptFeedMemberInviteRequest' + description: Accept Feed Member Invite Request required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/MuteChannelResponse' - description: Successful response + $ref: '#/components/schemas/AcceptFeedMemberInviteResponse' + description: Accept Feed Member Invite Response "400": content: application/json: @@ -23582,31 +32221,44 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Mute channel + summary: Accept a feed member request tags: - - product:chat - /api/v2/chat/moderation/unmute/channel: + - product:feeds + /api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/members/query: post: description: | - Unmutes channel for user - - Sends events: - - channel.unmuted - - channel.unmuted - operationId: UnmuteChannel + Query feed members based on filters with pagination and sorting options + operationId: QueryFeedMembers + parameters: + - in: path + name: feed_group_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + - in: path + name: feed_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "002" requestBody: content: application/json: schema: - $ref: '#/components/schemas/UnmuteChannelRequest' + $ref: '#/components/schemas/QueryFeedMembersRequest' required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/UnmuteResponse' - description: Response + $ref: '#/components/schemas/QueryFeedMembersResponse' + description: Successful response "400": content: application/json: @@ -23619,27 +32271,45 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Unmute channel + summary: Query feed members tags: - - product:chat - /api/v2/chat/push_preferences: + - product:feeds + /api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/members/reject: post: description: | - Update the push preferences for a user and or channel member. Set to all, mentions or none - operationId: UpdatePushNotificationPreferences + Rejects a pending feed member request + operationId: RejectFeedMemberInvite + parameters: + - in: path + name: feed_group_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + - in: path + name: feed_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "002" requestBody: content: application/json: schema: - $ref: '#/components/schemas/UpsertPushPreferencesRequest' + $ref: '#/components/schemas/RejectFeedMemberInviteRequest' + description: Reject Feed Member Request required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/UpsertPushPreferencesResponse' - description: Successful response + $ref: '#/components/schemas/RejectFeedMemberInviteResponse' + description: Reject Feed Member Response "400": content: application/json: @@ -23652,31 +32322,43 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Push notification preferences + summary: Reject an invite to become a feed member tags: - - product:chat - /api/v2/chat/query_banned_users: - get: + - product:feeds + /api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/watch: + delete: description: | - Find and filter channel scoped or global user bans - operationId: QueryBannedUsers + Call this Method to stop receiving feed events + operationId: StopWatchingFeed parameters: - - content: - application/json: - schema: - $ref: '#/components/schemas/QueryBannedUsersPayload' - description: JSON object with query user bans payload - title: Payload - x-stream-index: "001" - in: query - name: payload + - in: path + name: feed_group_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "002" + - in: path + name: feed_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "003" + - in: query + name: connection_id + schema: + type: string + x-stream-index: "001.003" responses: "200": content: application/json: schema: - $ref: '#/components/schemas/QueryBannedUsersResponse' - description: Successful response + $ref: '#/components/schemas/Response' + description: Response "400": content: application/json: @@ -23689,27 +32371,43 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Query Banned Users + summary: Stop watching feed tags: - - product:chat - /api/v2/chat/reminders/query: - post: + - product:feeds + /api/v2/feeds/feed_groups/{feed_group_id}/follow_suggestions: + get: description: | - Queries reminders - operationId: QueryReminders - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/QueryRemindersRequest' + Get follow suggestions for a feed group + operationId: GetFollowSuggestions + parameters: + - in: path + name: feed_group_id required: true + schema: + description: The ID of the feed group to get suggestions for + maxLength: 255 + title: Feed Group ID + type: string + writeOnly: true + x-stream-index: "001" + - in: query + name: limit + schema: + description: Maximum number of suggestions to return + format: int32 + maximum: 100 + minimum: 1 + title: Limit + type: integer + writeOnly: true + x-stream-index: "002" responses: - "201": + "200": content: application/json: schema: - $ref: '#/components/schemas/QueryRemindersResponse' - description: Successful response + $ref: '#/components/schemas/GetFollowSuggestionsResponse' + description: Follow Suggestions Response "400": content: application/json: @@ -23722,31 +32420,28 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Query reminders + summary: Get follow suggestions tags: - - product:chat - /api/v2/chat/search: - get: + - product:feeds + /api/v2/feeds/feeds/batch: + post: description: | - Search messages across channels - operationId: Search - parameters: - - content: + Create multiple feeds at once for a given feed group + operationId: CreateFeedsBatch + requestBody: + content: application/json: schema: - $ref: '#/components/schemas/SearchPayload' - description: JSON object with search payload - title: Payload - x-stream-index: "001" - in: query - name: payload + $ref: '#/components/schemas/CreateFeedsBatchRequest' + description: Create Feeds Batch Request + required: true responses: - "200": + "201": content: application/json: schema: - $ref: '#/components/schemas/SearchResponse' - description: Successful response + $ref: '#/components/schemas/CreateFeedsBatchResponse' + description: Create Feeds Batch Response "400": content: application/json: @@ -23759,51 +32454,34 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Search messages + summary: Create multiple feeds at once tags: - - product:chat - /api/v2/chat/sync: + - product:feeds + /api/v2/feeds/feeds/query: post: description: | - Returns all events happened since client disconnect in specified channels - operationId: Sync + Query feeds with filter query + operationId: QueryFeeds parameters: - - in: query - name: with_inaccessible_cids - schema: - description: If set to true this will add 'inaccessible_cids' to response - type - title: With inaccessible CIDs - type: boolean - x-stream-index: "003" - - in: query - name: watch - schema: - description: If set to true this will start watching requested and newly - added channels that user has access to. If error occurred with this option - enabled and it is not an input error - channels will still be watched. - title: Watch synced channels - type: boolean - x-stream-index: "004" - in: query name: connection_id schema: type: string - x-stream-index: "006.003" + x-stream-index: "005.003" requestBody: content: application/json: schema: - $ref: '#/components/schemas/SyncRequest' - description: SyncRequest + $ref: '#/components/schemas/QueryFeedsRequest' + description: Query Feeds Request required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/SyncResponse' - description: SyncResponse + $ref: '#/components/schemas/QueryFeedsResponse' + description: Query Feeds Response "400": content: application/json: @@ -23816,33 +32494,28 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Sync + summary: Query feeds tags: - - product:chat - /api/v2/chat/threads: - post: + - product:feeds + /api/v2/feeds/follows: + patch: description: | - Returns the list of threads for specific user - operationId: QueryThreads - parameters: - - in: query - name: connection_id - schema: - type: string - x-stream-index: "002" + Updates a follow's custom data, push preference, and follower role. Source owner can update custom data and push preference. Target owner can update follower role. + operationId: UpdateFollow requestBody: content: application/json: schema: - $ref: '#/components/schemas/QueryThreadsRequest' + $ref: '#/components/schemas/UpdateFollowRequest' + description: Update Follow Request required: true responses: - "201": + "200": content: application/json: schema: - $ref: '#/components/schemas/QueryThreadsResponse' - description: Successful response + $ref: '#/components/schemas/UpdateFollowResponse' + description: Update Follow Response "400": content: application/json: @@ -23855,75 +32528,27 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Query Threads + summary: Update a follow tags: - - product:chat - /api/v2/chat/threads/{message_id}: - get: + - product:feeds + post: description: | - Return a specific thread - operationId: GetThread - parameters: - - in: path - name: message_id + Creates a follow and broadcasts FollowAddedEvent + operationId: Follow + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/FollowRequest' + description: Follow Request required: true - schema: - type: string - writeOnly: true - x-stream-index: "001" - - in: query - name: watch - schema: - description: Start watching the channel this thread belongs to - title: Watch - type: boolean - writeOnly: true - x-stream-index: "002" - - in: query - name: connection_id - schema: - type: string - writeOnly: true - x-stream-index: "003" - - in: query - name: reply_limit - schema: - description: Limit the number of replies returned - format: int32 - minimum: 0 - title: Reply limit - type: integer - writeOnly: true - x-stream-index: "004" - - in: query - name: participant_limit - schema: - description: Limit the number of participants returned - format: int32 - maximum: 100 - minimum: 0 - title: Participant limit - type: integer - writeOnly: true - x-stream-index: "005" - - in: query - name: member_limit - schema: - description: Limit the number of members returned per thread channel - format: int32 - maximum: 100 - minimum: 0 - title: Member limit - type: integer - writeOnly: true - x-stream-index: "006" responses: - "200": + "201": content: application/json: schema: - $ref: '#/components/schemas/GetThreadResponse' - description: Successful response + $ref: '#/components/schemas/SingleFollowResponse' + description: Follow Response "400": content: application/json: @@ -23936,38 +32561,42 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Get Thread + summary: Create a follow tags: - - product:chat - patch: + - product:feeds + /api/v2/feeds/follows/{source}/{target}: + delete: description: | - Updates certain fields of the thread - - Sends events: - - thread.updated - - thread.updated - operationId: UpdateThreadPartial + Removes a follow and broadcasts FollowRemovedEvent + operationId: Unfollow parameters: - in: path - name: message_id + name: source required: true schema: + description: Fully qualified ID of the source feed + maxLength: 255 + title: Source Feed type: string writeOnly: true x-stream-index: "001" - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/UpdateThreadPartialRequest' + - in: path + name: target required: true + schema: + description: Fully qualified ID of the target feed + maxLength: 255 + title: Target Feed + type: string + writeOnly: true + x-stream-index: "002" responses: "200": content: application/json: schema: - $ref: '#/components/schemas/UpdateThreadPartialResponse' - description: Successful response + $ref: '#/components/schemas/UnfollowResponse' + description: Unfollow Response "400": content: application/json: @@ -23980,21 +32609,28 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Partially update thread + summary: Unfollow a feed tags: - - product:chat - /api/v2/chat/unread: - get: + - product:feeds + /api/v2/feeds/follows/accept: + post: description: | - Fetch unread counts for a single user - operationId: UnreadCounts + Accepts a pending follow request + operationId: AcceptFollow + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AcceptFollowRequest' + description: Accept Follow Request + required: true responses: - "200": + "201": content: application/json: schema: - $ref: '#/components/schemas/WrappedUnreadCountsResponse' - description: Response + $ref: '#/components/schemas/AcceptFollowResponse' + description: Accept Follow Response "400": content: application/json: @@ -24007,31 +32643,28 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Unread counts + summary: Accept a follow request tags: - - product:chat - /api/v2/devices: - delete: + - product:feeds + /api/v2/feeds/follows/batch: + post: description: | - Deletes one device - operationId: DeleteDevice - parameters: - - in: query - name: id + Creates multiple follows at once and broadcasts FollowAddedEvent for each follow + operationId: FollowBatch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/FollowBatchRequest' + description: Follow Batch Request required: true - schema: - description: Device ID to delete - title: ID - type: string - writeOnly: true - x-stream-index: "001" responses: - "200": + "201": content: application/json: schema: - $ref: '#/components/schemas/Response' - description: Response + $ref: '#/components/schemas/FollowBatchResponse' + description: Follow Batch Response "400": content: application/json: @@ -24044,20 +32677,28 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Delete device + summary: Create multiple follows at once tags: - - product:common - get: + - product:feeds + /api/v2/feeds/follows/query: + post: description: | - Returns all available devices - operationId: ListDevices + Query follows based on filters with pagination and sorting options + operationId: QueryFollows + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueryFollowsRequest' + description: Query Follows Request + required: true responses: - "200": + "201": content: application/json: schema: - $ref: '#/components/schemas/ListDevicesResponse' - description: ListDevicesResponse + $ref: '#/components/schemas/QueryFollowsResponse' + description: Query Follows Response "400": content: application/json: @@ -24070,27 +32711,28 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: List devices + summary: Query follows tags: - - product:common + - product:feeds + /api/v2/feeds/follows/reject: post: description: | - Adds a new device to a user, if the same device already exists the call will have no effect - operationId: CreateDevice + Rejects a pending follow request + operationId: RejectFollow requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateDeviceRequest' - description: CreateDeviceRequest + $ref: '#/components/schemas/RejectFollowRequest' + description: Reject Follow Request required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/Response' - description: Response + $ref: '#/components/schemas/RejectFollowResponse' + description: Reject Follow Response "400": content: application/json: @@ -24103,9 +32745,9 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Create device + summary: Reject a follow request tags: - - product:common + - product:feeds /api/v2/guest: post: description: |2+ @@ -26155,6 +34797,65 @@ paths: summary: Join call tags: - product:video + /api/v2/video/call/{type}/{id}/kick: + post: + description: | + Kicks a user from the call. Optionally block the user from rejoining by setting block=true. + + Sends events: + - call.blocked_user + - call.kicked_user + operationId: KickUser + parameters: + - in: path + name: type + required: true + schema: + description: The type of call + maxLength: 64 + title: Type + type: string + writeOnly: true + x-stream-index: "002.001" + - in: path + name: id + required: true + schema: + description: Call ID + maxLength: 64 + title: ID + type: string + writeOnly: true + x-stream-index: "002.002" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/KickUserRequest' + description: KickUserRequest + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/KickUserResponse' + description: KickUserResponse + "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: Kick user from a call + tags: + - product:video /api/v2/video/call/{type}/{id}/mark_ended: post: description: |2 diff --git a/openapi/moderation-clientside-api.json b/openapi/moderation-clientside-api.json index 3b8a9eab5..4859b368e 100644 --- a/openapi/moderation-clientside-api.json +++ b/openapi/moderation-clientside-api.json @@ -1 +1 @@ -{"components":{"schemas":{"AIImageConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"ocr_rules":{"items":{"$ref":"#/components/schemas/OCRRule"},"type":"array","x-stream-index":"004"},"rules":{"items":{"$ref":"#/components/schemas/AWSRekognitionRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules","ocr_rules"],"type":"object"},"AITextConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"profile":{"type":"string","x-stream-index":"003"},"rules":{"items":{"$ref":"#/components/schemas/BodyguardRule"},"type":"array","x-stream-index":"004"},"severity_rules":{"items":{"$ref":"#/components/schemas/BodyguardSeverityRule"},"type":"array","x-stream-index":"005"}},"required":["enabled","profile","rules","severity_rules"],"type":"object"},"AIVideoConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AWSRekognitionRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"APIError":{"nullable":true,"properties":{"StatusCode":{"description":"Response HTTP status code","format":"int32","title":"Status code","type":"integer","x-stream-index":"004"},"code":{"description":"API error code","format":"int32","title":"Code","type":"integer","x-stream-index":"001"},"details":{"description":"Additional error-specific information","items":{"type":"integer"},"title":"Details","type":"array","x-stream-index":"007"},"duration":{"description":"Request duration","title":"Duration","type":"string","x-stream-index":"005"},"exception_fields":{"additionalProperties":{"type":"string"},"description":"Additional error info","title":"Exception fields","type":"object","x-stream-index":"003"},"message":{"description":"Message describing an error","title":"Message","type":"string","x-stream-index":"002"},"more_info":{"description":"URL with additional information","title":"More info","type":"string","x-stream-index":"006"},"unrecoverable":{"description":"Flag that indicates if the error is unrecoverable, requests that return unrecoverable errors should not be retried, this error only applies to the request that caused it","title":"Unrecoverable","type":"boolean","x-stream-index":"008"}},"required":["code","message","StatusCode","duration","more_info","details"],"title":"Error response","type":"object"},"APNS":{"properties":{"body":{"type":"string","x-stream-index":"002"},"content-available":{"format":"int32","type":"integer","x-stream-index":"004"},"data":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"mutable-content":{"format":"int32","type":"integer","x-stream-index":"005"},"sound":{"type":"string","x-stream-index":"003"},"title":{"type":"string","x-stream-index":"001"}},"required":["title","body"],"type":"object"},"AWSRekognitionRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"},"min_confidence":{"format":"float","maximum":100,"minimum":0,"type":"number","x-stream-index":"003"}},"required":["label","action","min_confidence"],"type":"object"},"Action":{"nullable":true,"properties":{"name":{"type":"string","x-stream-index":"001"},"style":{"type":"string","x-stream-index":"003"},"text":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"004"},"value":{"type":"string","x-stream-index":"005"}},"required":["name","text","type"],"type":"object"},"ActionLog":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"002"},"reason":{"type":"string","x-stream-index":"008"},"reporter_type":{"type":"string","x-stream-index":"009"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"014"},"review_queue_item_id":{"type":"string","x-stream-index":"012"},"target_user":{"$ref":"#/components/schemas/User","x-stream-index":"013"},"target_user_id":{"type":"string","x-stream-index":"011"},"type":{"type":"string","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007"}},"required":["id","created_at","type","reason","reporter_type","custom","target_user_id","review_queue_item_id"],"type":"object"},"ActionLogResponse":{"nullable":true,"properties":{"created_at":{"description":"Timestamp when the action was taken","format":"date-time","title":"Created At","type":"number","x-stream-index":"002"},"custom":{"additionalProperties":{},"description":"Additional metadata about the action","title":"Custom","type":"object","x-stream-index":"007"},"id":{"description":"Unique identifier of the action log","title":"ID","type":"string","x-stream-index":"001"},"reason":{"description":"Reason for the moderation action","title":"Reason","type":"string","x-stream-index":"006"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"Associated review queue item","title":"Review Queue Item","x-stream-index":"008"},"target_user":{"$ref":"#/components/schemas/UserResponse","description":"User who was the target of the action","title":"Target User","x-stream-index":"009"},"target_user_id":{"description":"ID of the user who was the target of the action","title":"Target User ID","type":"string","x-stream-index":"010"},"type":{"description":"Type of moderation action","title":"Type","type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who performed the action","title":"User","x-stream-index":"004"},"user_id":{"description":"ID of the user who performed the action","title":"User ID","type":"string","x-stream-index":"005"}},"required":["id","created_at","type","user_id","reason","custom","target_user_id"],"type":"object"},"ActionSequence":{"properties":{"action":{"type":"string","x-stream-index":"001"},"blur":{"type":"boolean","x-stream-index":"005"},"cooldown_period":{"format":"int32","type":"integer","x-stream-index":"004"},"threshold":{"format":"int32","type":"integer","x-stream-index":"002"},"time_window":{"format":"int32","type":"integer","x-stream-index":"003"},"warning":{"type":"boolean","x-stream-index":"006"},"warning_text":{"type":"string","x-stream-index":"007"}},"required":["action","threshold","time_window","cooldown_period","blur","warning","warning_text"],"type":"object"},"Attachment":{"description":"An attachment is a message object that represents a file uploaded by a user.","nullable":true,"properties":{"actions":{"items":{"$ref":"#/components/schemas/Action"},"type":"array","x-stream-index":"015"},"asset_url":{"type":"string","x-stream-index":"017"},"author_icon":{"type":"string","x-stream-index":"007"},"author_link":{"type":"string","x-stream-index":"006"},"author_name":{"type":"string","x-stream-index":"005"},"color":{"type":"string","x-stream-index":"003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"018"},"fallback":{"type":"string","x-stream-index":"002"},"fields":{"items":{"$ref":"#/components/schemas/Field"},"type":"array","x-stream-index":"016"},"footer":{"type":"string","x-stream-index":"013"},"footer_icon":{"type":"string","x-stream-index":"014"},"giphy":{"$ref":"#/components/schemas/Images","x-stream-index":"019"},"image_url":{"type":"string","x-stream-index":"011"},"og_scrape_url":{"type":"string","x-stream-index":"020"},"original_height":{"format":"int32","type":"integer","x-stream-index":"022"},"original_width":{"format":"int32","type":"integer","x-stream-index":"021"},"pretext":{"type":"string","x-stream-index":"004"},"text":{"type":"string","x-stream-index":"010"},"thumb_url":{"type":"string","x-stream-index":"012"},"title":{"type":"string","x-stream-index":"008"},"title_link":{"type":"string","x-stream-index":"009"},"type":{"description":"Attachment type (e.g. image, video, url)","title":"Type","type":"string","x-stream-index":"001"}},"required":["custom"],"title":"Attachment","type":"object","x-stream-docs-page-id":"file_uploads"},"AudioSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"001"},"default_device":{"enum":["speaker","earpiece"],"type":"string","x-stream-index":"006"},"mic_default_on":{"type":"boolean","x-stream-index":"004"},"noise_cancellation":{"$ref":"#/components/schemas/NoiseCancellationSettings","x-stream-index":"007"},"opus_dtx_enabled":{"type":"boolean","x-stream-index":"002"},"redundant_coding_enabled":{"type":"boolean","x-stream-index":"003"},"speaker_default_on":{"type":"boolean","x-stream-index":"005"}},"required":["access_request_enabled","opus_dtx_enabled","redundant_coding_enabled","mic_default_on","speaker_default_on","default_device"],"type":"object"},"AudioSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"001"},"default_device":{"enum":["speaker","earpiece"],"type":"string","x-stream-index":"006"},"mic_default_on":{"type":"boolean","x-stream-index":"004"},"noise_cancellation":{"$ref":"#/components/schemas/NoiseCancellationSettings","x-stream-index":"007"},"opus_dtx_enabled":{"type":"boolean","x-stream-index":"002"},"redundant_coding_enabled":{"type":"boolean","x-stream-index":"003"},"speaker_default_on":{"type":"boolean","x-stream-index":"005"}},"required":["access_request_enabled","opus_dtx_enabled","redundant_coding_enabled","mic_default_on","speaker_default_on","default_device"],"type":"object"},"AutomodPlatformCircumventionConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AutomodRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"AutomodRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"003"},"label":{"type":"string","x-stream-index":"001"},"threshold":{"format":"float","maximum":1,"minimum":0,"type":"number","x-stream-index":"002"}},"required":["label","threshold","action"],"type":"object"},"AutomodSemanticFiltersConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AutomodSemanticFiltersRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"AutomodSemanticFiltersRule":{"properties":{"action":{"enum":["flag","shadow","remove"],"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"threshold":{"format":"float","maximum":1,"minimum":0,"type":"number","x-stream-index":"002"}},"required":["name","threshold","action"],"type":"object"},"AutomodToxicityConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AutomodRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"BackstageSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"BackstageSettingsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"Ban":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"012"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"011"},"expires":{"format":"date-time","type":"number","x-stream-index":"007"},"reason":{"type":"string","x-stream-index":"008"},"shadow":{"type":"boolean","x-stream-index":"009"},"target":{"$ref":"#/components/schemas/User","x-stream-index":"006"}},"required":["shadow","created_at"],"type":"object"},"BanActionRequest":{"properties":{"channel_ban_only":{"type":"boolean","x-stream-index":"003"},"delete_messages":{"enum":["soft","pruning","hard"],"type":"string","x-stream-index":"005"},"ip_ban":{"type":"boolean","x-stream-index":"004"},"reason":{"type":"string","x-stream-index":"002"},"shadow":{"type":"boolean","x-stream-index":"001"},"timeout":{"format":"int32","type":"integer","x-stream-index":"006"}},"type":"object"},"BanOptions":{"properties":{"duration":{"format":"int32","type":"integer","x-stream-index":"001"},"ip_ban":{"type":"boolean","x-stream-index":"004"},"reason":{"type":"string","x-stream-index":"002"},"shadow_ban":{"type":"boolean","x-stream-index":"003"}},"required":["duration","reason","shadow_ban","ip_ban"],"type":"object"},"BanRequest":{"nullable":true,"properties":{"banned_by":{"$ref":"#/components/schemas/UserRequest","description":"Details about the user performing the ban","title":"Banned By","x-stream-index":"008"},"banned_by_id":{"description":"ID of the user performing the ban","title":"Banned By ID","type":"string","x-stream-index":"007"},"channel_cid":{"description":"Channel where the ban applies","title":"Channel CID","type":"string","x-stream-index":"004"},"delete_messages":{"enum":["soft","pruning","hard"],"type":"string","x-stream-index":"009"},"ip_ban":{"description":"Whether to ban the user's IP address","title":"IP Ban","type":"boolean","x-stream-index":"006"},"reason":{"description":"Optional explanation for the ban","title":"Reason","type":"string","x-stream-index":"003"},"shadow":{"description":"Whether this is a shadow ban","title":"Shadow","type":"boolean","x-stream-index":"005"},"target_user_id":{"description":"ID of the user to ban","title":"Target User ID","type":"string","x-stream-index":"001"},"timeout":{"description":"Duration of the ban in minutes","minimum":0,"title":"Timeout","type":"integer","x-stream-index":"002"}},"required":["target_user_id"],"type":"object"},"BanResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"BlockContentOptions":{"properties":{"reason":{"type":"string","x-stream-index":"001"}},"required":["reason"],"type":"object"},"BlockListConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/BlockListRule"},"maximum":10,"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"BlockListOptions":{"properties":{"behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"002"},"blocklist":{"type":"string","x-stream-index":"001"}},"required":["blocklist","behavior"],"type":"object"},"BlockListRule":{"properties":{"action":{"enum":["flag","mask_flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"002"}},"required":["name","team","action"],"type":"object"},"BodyguardRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"},"severity_rules":{"items":{"$ref":"#/components/schemas/BodyguardSeverityRule"},"type":"array","x-stream-index":"003"}},"required":["label","action","severity_rules"],"type":"object"},"BodyguardSeverityRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"severity":{"enum":["low","medium","high","critical"],"type":"string","x-stream-index":"001"}},"required":["severity","action"],"type":"object"},"BroadcastSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettings","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettings","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"BroadcastSettingsResponse":{"description":"BroadcastSettingsResponse is the payload for broadcasting settings","properties":{"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettingsResponse","title":"HLS","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettingsResponse","title":"RTMP","x-stream-index":"003"}},"required":["enabled","hls","rtmp"],"title":"BroadcastSettingsResponse","type":"object"},"Call":{"properties":{"AppPK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"002"},"Backstage":{"type":"boolean","writeOnly":true,"x-stream-index":"023"},"BlockedUserIDs":{"items":{"type":"string"},"type":"array","writeOnly":true,"x-stream-index":"018"},"BlockedUsers":{"items":{"$ref":"#/components/schemas/User"},"type":"array","writeOnly":true,"x-stream-index":"019"},"CID":{"type":"string","writeOnly":true,"x-stream-index":"005"},"CallType":{"$ref":"#/components/schemas/CallType","x-stream-index":"020"},"ChannelCID":{"type":"string","writeOnly":true,"x-stream-index":"032"},"CreatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"013"},"CreatedBy":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"CreatedByUserID":{"type":"string","writeOnly":true,"x-stream-index":"007"},"CurrentSessionID":{"type":"string","writeOnly":true,"x-stream-index":"024"},"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"012"},"DeletedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"028"},"EgressUpdatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"027"},"Egresses":{"items":{"$ref":"#/components/schemas/CallEgress"},"type":"array","writeOnly":true,"x-stream-index":"015"},"EndedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"017"},"ID":{"type":"string","writeOnly":true,"x-stream-index":"004"},"JoinAheadTimeSeconds":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"031"},"LastHeartbeatAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"030"},"LastSessionID":{"type":"string","writeOnly":true,"x-stream-index":"025"},"MemberCount":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"010"},"MemberLookup":{"$ref":"#/components/schemas/MemberLookup","x-stream-index":"011"},"Members":{"items":{"$ref":"#/components/schemas/CallMember"},"type":"array","writeOnly":true,"x-stream-index":"009"},"Session":{"$ref":"#/components/schemas/CallSession","x-stream-index":"026"},"Settings":{"$ref":"#/components/schemas/CallSettings","x-stream-index":"022"},"SettingsOverrides":{"$ref":"#/components/schemas/CallSettings","x-stream-index":"021"},"StartsAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"016"},"Team":{"type":"string","writeOnly":true,"x-stream-index":"006"},"ThumbnailURL":{"type":"string","writeOnly":true,"x-stream-index":"029"},"Type":{"type":"string","writeOnly":true,"x-stream-index":"003"},"UpdatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"014"}},"required":["AppPK","Type","ID","CID","Team","CreatedByUserID","Members","Custom","CreatedAt","UpdatedAt","Egresses","BlockedUserIDs","BlockedUsers","Backstage","CurrentSessionID","LastSessionID","ThumbnailURL","ChannelCID"],"type":"object"},"CallEgress":{"nullable":true,"properties":{"app_pk":{"format":"int32","type":"integer","x-stream-index":"002"},"call_id":{"type":"string","x-stream-index":"004"},"call_type":{"type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/EgressTaskConfig","x-stream-index":"007"},"egress_id":{"type":"string","x-stream-index":"005"},"egress_type":{"type":"string","x-stream-index":"006"},"instance_ip":{"type":"string","x-stream-index":"008"},"started_at":{"format":"date-time","type":"number","x-stream-index":"010"},"state":{"type":"string","x-stream-index":"009"},"stopped_at":{"format":"date-time","type":"number","x-stream-index":"011"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"012"}},"required":["app_pk","call_type","call_id","egress_id","egress_type","instance_ip","state","started_at","updated_at"],"type":"object"},"CallIngressResponse":{"description":"CallIngressResponse is the payload for ingress settings","properties":{"rtmp":{"$ref":"#/components/schemas/RTMPIngress","title":"RTMP","x-stream-index":"001"}},"required":["rtmp"],"title":"CallIngressResponse","type":"object"},"CallMember":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"010"},"role":{"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["user_id","role","custom","created_at","updated_at"],"type":"object"},"CallParticipant":{"nullable":true,"properties":{"JoinedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"004"},"Role":{"type":"string","writeOnly":true,"x-stream-index":"002"},"UserSessionID":{"type":"string","writeOnly":true,"x-stream-index":"003"},"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"001.046"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"001.017"},"banned":{"type":"boolean","x-stream-index":"001.016"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.013"},"id":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"001.023"},"language":{"type":"string","x-stream-index":"001.035"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"001.022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"001.026"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.042"},"role":{"type":"string","x-stream-index":"001.004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.005"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.009"}},"required":["id","role","teams_role","custom","banned","online","Role","UserSessionID","JoinedAt"],"type":"object"},"CallParticipantResponse":{"properties":{"joined_at":{"format":"date-time","type":"number","x-stream-index":"004"},"role":{"type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"},"user_session_id":{"type":"string","x-stream-index":"002"}},"required":["user","user_session_id","role","joined_at"],"type":"object"},"CallResponse":{"description":"Represents a call","properties":{"backstage":{"type":"boolean","x-stream-index":"016"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"018"},"captioning":{"type":"boolean","x-stream-index":"013"},"channel_cid":{"type":"string","x-stream-index":"024"},"cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"The user that created the call","title":"Created By","x-stream-index":"007"},"current_session_id":{"type":"string","x-stream-index":"005"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"008"},"egress":{"$ref":"#/components/schemas/EgressResponse","x-stream-index":"021"},"ended_at":{"description":"Date/time when the call ended","format":"date-time","title":"Ended At","type":"number","x-stream-index":"014"},"id":{"description":"Call ID","title":"ID","type":"string","x-stream-index":"003"},"ingress":{"$ref":"#/components/schemas/CallIngressResponse","x-stream-index":"019"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"023"},"recording":{"type":"boolean","x-stream-index":"011"},"session":{"$ref":"#/components/schemas/CallSessionResponse","x-stream-index":"020"},"settings":{"$ref":"#/components/schemas/CallSettingsResponse","x-stream-index":"017"},"starts_at":{"description":"Date/time when the call will start","format":"date-time","title":"Starts At","type":"number","x-stream-index":"015"},"team":{"type":"string","x-stream-index":"006"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailResponse","x-stream-index":"022"},"transcribing":{"type":"boolean","x-stream-index":"012"},"type":{"description":"The type of call","title":"Type","type":"string","x-stream-index":"002"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"}},"required":["type","id","cid","current_session_id","created_by","custom","created_at","updated_at","recording","transcribing","captioning","backstage","settings","blocked_user_ids","ingress","egress"],"title":"CallResponse","type":"object"},"CallSession":{"properties":{"AcceptedBy":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","writeOnly":true,"x-stream-index":"008"},"ActiveSFUs":{"items":{"$ref":"#/components/schemas/SFUIDLastSeen"},"type":"array","writeOnly":true,"x-stream-index":"016"},"AnonymousParticipantCount":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"019"},"AppPK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"002.001"},"CallID":{"type":"string","writeOnly":true,"x-stream-index":"002.003"},"CallType":{"type":"string","writeOnly":true,"x-stream-index":"002.002"},"CreatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"003"},"DeletedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"004"},"EndedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"006"},"LiveEndedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"013"},"LiveStartedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"012"},"MissedBy":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","writeOnly":true,"x-stream-index":"010"},"Participants":{"items":{"$ref":"#/components/schemas/CallParticipant"},"type":"array","writeOnly":true,"x-stream-index":"011"},"ParticipantsCountByRole":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","writeOnly":true,"x-stream-index":"018"},"RejectedBy":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","writeOnly":true,"x-stream-index":"009"},"RingAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"007"},"SFUIDs":{"items":{"type":"string"},"type":"array","writeOnly":true,"x-stream-index":"015"},"SessionID":{"type":"string","writeOnly":true,"x-stream-index":"002.004"},"StartedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"005"},"TimerEndsAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"014"},"UserPermissionOverrides":{"additionalProperties":{"additionalProperties":{"type":"boolean"},"type":"object"},"type":"object","writeOnly":true,"x-stream-index":"017"}},"required":["AppPK","CallType","CallID","SessionID","CreatedAt","AcceptedBy","RejectedBy","MissedBy","Participants","SFUIDs","ActiveSFUs","UserPermissionOverrides","ParticipantsCountByRole","AnonymousParticipantCount"],"type":"object"},"CallSessionResponse":{"properties":{"accepted_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"008"},"anonymous_participant_count":{"format":"int32","type":"integer","x-stream-index":"006"},"ended_at":{"format":"date-time","type":"number","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"live_ended_at":{"format":"date-time","type":"number","x-stream-index":"011"},"live_started_at":{"format":"date-time","type":"number","x-stream-index":"010"},"missed_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"009"},"participants":{"items":{"$ref":"#/components/schemas/CallParticipantResponse"},"type":"array","x-stream-index":"004"},"participants_count_by_role":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"005"},"rejected_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"007"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002"},"timer_ends_at":{"format":"date-time","type":"number","x-stream-index":"012"}},"required":["id","participants","participants_count_by_role","anonymous_participant_count","rejected_by","accepted_by","missed_by"],"type":"object"},"CallSettings":{"properties":{"audio":{"$ref":"#/components/schemas/AudioSettings","x-stream-index":"001"},"backstage":{"$ref":"#/components/schemas/BackstageSettings","x-stream-index":"002"},"broadcasting":{"$ref":"#/components/schemas/BroadcastSettings","x-stream-index":"007"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordSettings","x-stream-index":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettings","x-stream-index":"008"},"ingress":{"$ref":"#/components/schemas/IngressSettings","x-stream-index":"014"},"limits":{"$ref":"#/components/schemas/LimitsSettings","x-stream-index":"012"},"recording":{"$ref":"#/components/schemas/RecordSettings","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettings","x-stream-index":"010"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettings","x-stream-index":"004"},"session":{"$ref":"#/components/schemas/SessionSettings","x-stream-index":"013"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettings","x-stream-index":"011"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettings","x-stream-index":"009"},"video":{"$ref":"#/components/schemas/VideoSettings","x-stream-index":"003"}},"type":"object"},"CallSettingsResponse":{"properties":{"audio":{"$ref":"#/components/schemas/AudioSettingsResponse","x-stream-index":"001"},"backstage":{"$ref":"#/components/schemas/BackstageSettingsResponse","x-stream-index":"002"},"broadcasting":{"$ref":"#/components/schemas/BroadcastSettingsResponse","x-stream-index":"003"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordingSettingsResponse","x-stream-index":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettingsResponse","x-stream-index":"004"},"ingress":{"$ref":"#/components/schemas/IngressSettingsResponse","x-stream-index":"014"},"limits":{"$ref":"#/components/schemas/LimitsSettingsResponse","x-stream-index":"012"},"recording":{"$ref":"#/components/schemas/RecordSettingsResponse","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettingsResponse","x-stream-index":"007"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettingsResponse","x-stream-index":"008"},"session":{"$ref":"#/components/schemas/SessionSettingsResponse","x-stream-index":"013"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettingsResponse","x-stream-index":"011"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettingsResponse","x-stream-index":"009"},"video":{"$ref":"#/components/schemas/VideoSettingsResponse","x-stream-index":"010"}},"required":["audio","backstage","broadcasting","geofencing","recording","frame_recording","ring","screensharing","transcription","video","thumbnails","limits","session"],"type":"object"},"CallType":{"properties":{"AppPK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"003"},"CreatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"005"},"ExternalStorage":{"type":"string","writeOnly":true,"x-stream-index":"009"},"Name":{"type":"string","writeOnly":true,"x-stream-index":"004"},"NotificationSettings":{"$ref":"#/components/schemas/NotificationSettings","x-stream-index":"008"},"PK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"002"},"Settings":{"$ref":"#/components/schemas/CallSettings","x-stream-index":"007"},"UpdatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"006"}},"required":["PK","AppPK","Name","CreatedAt","UpdatedAt","ExternalStorage"],"type":"object"},"Channel":{"properties":{"active_live_locations":{"items":{"$ref":"#/components/schemas/SharedLocation"},"type":"array","x-stream-index":"034"},"auto_translation_enabled":{"type":"boolean","x-stream-index":"029"},"auto_translation_language":{"type":"string","x-stream-index":"030"},"cid":{"type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/ChannelConfig","x-stream-index":"026"},"config_overrides":{"$ref":"#/components/schemas/ConfigOverrides","x-stream-index":"027"},"cooldown":{"format":"int32","type":"integer","x-stream-index":"031"},"created_at":{"format":"date-time","type":"number","x-stream-index":"009"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"019"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"disabled":{"type":"boolean","x-stream-index":"017"},"frozen":{"type":"boolean","x-stream-index":"016"},"id":{"type":"string","x-stream-index":"004"},"invites":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"022"},"last_campaigns":{"type":"string","x-stream-index":"032"},"last_message_at":{"format":"date-time","type":"number","x-stream-index":"006"},"member_count":{"format":"int32","type":"integer","x-stream-index":"021"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"020"},"team":{"type":"string","x-stream-index":"028"},"truncated_by":{"$ref":"#/components/schemas/User","x-stream-index":"015"},"type":{"type":"string","x-stream-index":"005"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"010"}},"required":["cid","id","type","created_at","updated_at","frozen","disabled","custom","auto_translation_language"],"type":"object"},"ChannelConfig":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.026"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.021"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.022"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.027"},"blocklist":{"type":"string","x-stream-index":"001.023"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.024"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.025"},"commands":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"connect_events":{"type":"boolean","x-stream-index":"001.004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"custom_events":{"type":"boolean","x-stream-index":"001.012"},"mark_messages_pending":{"type":"boolean","x-stream-index":"001.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"001.020"},"mutes":{"type":"boolean","x-stream-index":"001.009"},"name":{"type":"string","x-stream-index":"001.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"001.028"},"partition_ttl":{"type":"integer","x-stream-index":"001.029"},"polls":{"type":"boolean","x-stream-index":"001.016"},"push_notifications":{"type":"boolean","x-stream-index":"001.013"},"quotes":{"type":"boolean","x-stream-index":"001.008"},"reactions":{"type":"boolean","x-stream-index":"001.006"},"read_events":{"type":"boolean","x-stream-index":"001.003"},"reminders":{"type":"boolean","x-stream-index":"001.014"},"replies":{"type":"boolean","x-stream-index":"001.007"},"search":{"type":"boolean","x-stream-index":"001.005"},"shared_locations":{"type":"boolean","x-stream-index":"001.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.030"},"typing_events":{"type":"boolean","x-stream-index":"001.002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"002.004"},"uploads":{"type":"boolean","x-stream-index":"001.010"},"url_enrichment":{"type":"boolean","x-stream-index":"001.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"001.017"}},"required":["name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","created_at","updated_at","commands"],"type":"object"},"ChannelConfigWithInfo":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.002.026"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.002.021"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.022"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.002.027"},"blocklist":{"type":"string","x-stream-index":"001.002.023"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.024"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.002.025"},"commands":{"items":{"$ref":"#/components/schemas/Command"},"type":"array","x-stream-index":"001.003"},"connect_events":{"type":"boolean","x-stream-index":"001.002.004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.001.003"},"custom_events":{"type":"boolean","x-stream-index":"001.002.012"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"002"},"mark_messages_pending":{"type":"boolean","x-stream-index":"001.002.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"001.002.020"},"mutes":{"type":"boolean","x-stream-index":"001.002.009"},"name":{"type":"string","x-stream-index":"001.002.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"001.002.028"},"partition_ttl":{"type":"integer","x-stream-index":"001.002.029"},"polls":{"type":"boolean","x-stream-index":"001.002.016"},"push_notifications":{"type":"boolean","x-stream-index":"001.002.013"},"quotes":{"type":"boolean","x-stream-index":"001.002.008"},"reactions":{"type":"boolean","x-stream-index":"001.002.006"},"read_events":{"type":"boolean","x-stream-index":"001.002.003"},"reminders":{"type":"boolean","x-stream-index":"001.002.014"},"replies":{"type":"boolean","x-stream-index":"001.002.007"},"search":{"type":"boolean","x-stream-index":"001.002.005"},"shared_locations":{"type":"boolean","x-stream-index":"001.002.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.002.030"},"typing_events":{"type":"boolean","x-stream-index":"001.002.002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"uploads":{"type":"boolean","x-stream-index":"001.002.010"},"url_enrichment":{"type":"boolean","x-stream-index":"001.002.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"001.002.017"}},"required":["created_at","updated_at","name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","commands"],"type":"object"},"ChannelMember":{"nullable":true,"properties":{"archived_at":{"format":"date-time","type":"number","x-stream-index":"021"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"017"},"banned":{"type":"boolean","x-stream-index":"016"},"channel_role":{"type":"string","x-stream-index":"024"},"created_at":{"format":"date-time","type":"number","x-stream-index":"012"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"014"},"invite_accepted_at":{"format":"date-time","type":"number","x-stream-index":"009"},"invite_rejected_at":{"format":"date-time","type":"number","x-stream-index":"010"},"invited":{"type":"boolean","x-stream-index":"008"},"is_global_banned":{"type":"boolean","x-stream-index":"020"},"is_moderator":{"type":"boolean","x-stream-index":"007"},"notifications_muted":{"type":"boolean","x-stream-index":"026"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"022"},"shadow_banned":{"type":"boolean","x-stream-index":"019"},"status":{"type":"string","x-stream-index":"011"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"013"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["custom","created_at","updated_at","banned","shadow_banned","is_global_banned","channel_role","notifications_muted"],"type":"object"},"ChannelMute":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"007"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"expires":{"description":"Date/time of mute expiration","format":"date-time","title":"Expires","type":"number","x-stream-index":"008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/User","description":"Owner of channel mute","title":"User","x-stream-index":"005"}},"required":["created_at","updated_at"],"type":"object"},"ChannelResponse":{"properties":{"auto_translation_enabled":{"type":"boolean","x-stream-index":"021"},"auto_translation_language":{"type":"string","x-stream-index":"022"},"blocked":{"type":"boolean","x-stream-index":"027"},"cid":{"type":"string","x-stream-index":"005"},"config":{"$ref":"#/components/schemas/ChannelConfigWithInfo","x-stream-index":"017"},"cooldown":{"format":"int32","type":"integer","x-stream-index":"024"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"011"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"030"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"010"},"disabled":{"type":"boolean","x-stream-index":"013"},"frozen":{"type":"boolean","x-stream-index":"012"},"hidden":{"type":"boolean","x-stream-index":"026"},"hide_messages_before":{"format":"date-time","type":"number","x-stream-index":"023"},"id":{"type":"string","x-stream-index":"003"},"last_message_at":{"format":"date-time","type":"number","x-stream-index":"006"},"member_count":{"format":"int32","type":"integer","x-stream-index":"015"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"014"},"mute_expires_at":{"format":"date-time","type":"number","x-stream-index":"019"},"muted":{"type":"boolean","x-stream-index":"018"},"own_capabilities":{"items":{"type":"string"},"type":"array","x-stream-index":"025"},"team":{"type":"string","x-stream-index":"020"},"truncated_at":{"format":"date-time","type":"number","x-stream-index":"028"},"truncated_by":{"$ref":"#/components/schemas/User","x-stream-index":"029"},"type":{"type":"string","x-stream-index":"004"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"}},"required":["id","type","cid","created_at","updated_at","frozen","disabled","custom"],"type":"object"},"Command":{"description":"Represents custom chat command","nullable":true,"properties":{"args":{"description":"Arguments help text, shown in commands auto-completion","title":"Arguments","type":"string","x-stream-index":"006"},"created_at":{"description":"Date/time of creation","format":"date-time","readOnly":true,"title":"Created at","type":"number","x-stream-index":"001"},"description":{"description":"Description, shown in commands auto-completion","title":"Description","type":"string","x-stream-index":"005"},"name":{"description":"Unique command name","title":"Name","type":"string","x-stream-index":"004"},"set":{"description":"Set name used for grouping commands","title":"Set","type":"string","x-stream-index":"007"},"updated_at":{"description":"Date/time of the last update","format":"date-time","readOnly":true,"title":"Updated at","type":"number","x-stream-index":"002"}},"required":["name","description","args","set"],"title":"Command","type":"object"},"CompositeAppSettings":{"properties":{"json_encoded_settings":{"type":"string","x-stream-index":"005"},"url":{"type":"string","x-stream-index":"004"}},"type":"object"},"ConfigOverrides":{"properties":{"blocklist":{"type":"string","x-stream-index":"008"},"blocklist_behavior":{"enum":["flag","block"],"type":"string","x-stream-index":"009"},"commands":{"items":{"type":"string"},"type":"array","x-stream-index":"011"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"010"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"007"},"quotes":{"type":"boolean","x-stream-index":"004"},"reactions":{"type":"boolean","x-stream-index":"002"},"replies":{"type":"boolean","x-stream-index":"003"},"shared_locations":{"type":"boolean","x-stream-index":"013"},"typing_events":{"type":"boolean","x-stream-index":"001"},"uploads":{"type":"boolean","x-stream-index":"005"},"url_enrichment":{"type":"boolean","x-stream-index":"006"},"user_message_reminders":{"type":"boolean","x-stream-index":"012"}},"required":["grants","commands"],"type":"object"},"ConfigResponse":{"properties":{"ai_image_config":{"$ref":"#/components/schemas/AIImageConfig","description":"Configuration for AI image analysis","title":"AI Image Config","x-stream-index":"009"},"ai_text_config":{"$ref":"#/components/schemas/AITextConfig","description":"Configuration for AI text analysis","title":"AI Text Config","x-stream-index":"008"},"ai_video_config":{"$ref":"#/components/schemas/AIVideoConfig","description":"Configuration for AI video analysis","title":"AI Video Config","x-stream-index":"010"},"async":{"description":"Whether moderation should be performed asynchronously","title":"Async","type":"boolean","x-stream-index":"003"},"automod_platform_circumvention_config":{"$ref":"#/components/schemas/AutomodPlatformCircumventionConfig","description":"Configuration for platform circumvention detection","title":"Automod Platform Circumvention Config","x-stream-index":"005"},"automod_semantic_filters_config":{"$ref":"#/components/schemas/AutomodSemanticFiltersConfig","description":"Configuration for semantic filtering","title":"Automod Semantic Filters Config","x-stream-index":"006"},"automod_toxicity_config":{"$ref":"#/components/schemas/AutomodToxicityConfig","description":"Configuration for toxicity detection","title":"Automod Toxicity Config","x-stream-index":"004"},"block_list_config":{"$ref":"#/components/schemas/BlockListConfig","description":"Configuration for block list filtering","title":"Block List Config","x-stream-index":"007"},"created_at":{"description":"When the configuration was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"012"},"key":{"description":"Unique identifier for the moderation configuration","title":"Key","type":"string","x-stream-index":"001"},"rule_builder_config":{"$ref":"#/components/schemas/RuleBuilderConfig","x-stream-index":"015"},"team":{"description":"Team associated with the configuration","title":"Team","type":"string","x-stream-index":"002"},"updated_at":{"description":"When the configuration was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"013"},"velocity_filter_config":{"$ref":"#/components/schemas/VelocityFilterConfig","description":"Configuration for velocity-based filtering","title":"Velocity Filter Config","x-stream-index":"011"},"video_call_rule_config":{"$ref":"#/components/schemas/VideoCallRuleConfig","x-stream-index":"014"}},"required":["key","team","async","created_at","updated_at"],"type":"object"},"ContentCountRuleParameters":{"properties":{"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"required":["threshold","time_window"],"type":"object"},"CustomActionRequest":{"properties":{"id":{"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"type":"object"},"Data":{"properties":{"id":{"type":"string","x-stream-index":"001"}},"required":["id"],"type":"object"},"DeleteActivityRequest":{"properties":{"hard_delete":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"DeleteMessageRequest":{"properties":{"hard_delete":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"DeleteModerationConfigResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"DeleteReactionRequest":{"properties":{"hard_delete":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"DeleteUserRequest":{"properties":{"delete_conversation_channels":{"type":"boolean","x-stream-index":"003"},"delete_feeds_content":{"type":"boolean","x-stream-index":"004"},"hard_delete":{"type":"boolean","x-stream-index":"001"},"mark_messages_deleted":{"type":"boolean","x-stream-index":"002"}},"type":"object"},"Device":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"disabled":{"type":"boolean","x-stream-index":"002.003"},"disabled_reason":{"type":"string","x-stream-index":"002.004"},"id":{"type":"string","x-stream-index":"002.001.004"},"push_provider":{"enum":["firebase","apn","huawei","xiaomi"],"type":"string","x-stream-index":"002.001.001"},"push_provider_name":{"type":"string","x-stream-index":"002.001.003"},"user_id":{"type":"string","x-stream-index":"004"},"voip":{"type":"boolean","x-stream-index":"002.001.005"}},"required":["push_provider","id","created_at","user_id"],"type":"object"},"DraftPayloadResponse":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"html":{"type":"string","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"001"},"mentioned_users":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"008"},"mml":{"type":"string","x-stream-index":"003"},"parent_id":{"type":"string","x-stream-index":"005"},"poll_id":{"type":"string","x-stream-index":"013"},"quoted_message_id":{"type":"string","x-stream-index":"009"},"show_in_channel":{"type":"boolean","x-stream-index":"006"},"silent":{"type":"boolean","x-stream-index":"012"},"text":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"011"}},"required":["id","text","custom"],"type":"object"},"DraftResponse":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003"},"channel_cid":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"message":{"$ref":"#/components/schemas/DraftPayloadResponse","x-stream-index":"001"},"parent_id":{"type":"string","x-stream-index":"004"},"parent_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"005"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"006"}},"required":["message","channel_cid","created_at"],"type":"object"},"EgressHLSResponse":{"properties":{"playlist_url":{"type":"string","x-stream-index":"001"},"status":{"type":"string","x-stream-index":"002"}},"required":["playlist_url","status"],"type":"object"},"EgressRTMPResponse":{"properties":{"name":{"type":"string","x-stream-index":"001"},"started_at":{"format":"date-time","type":"number","x-stream-index":"004"},"stream_key":{"type":"string","x-stream-index":"003"},"stream_url":{"type":"string","x-stream-index":"002"}},"required":["name","started_at"],"type":"object"},"EgressResponse":{"properties":{"broadcasting":{"type":"boolean","x-stream-index":"001"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordingResponse","x-stream-index":"004"},"hls":{"$ref":"#/components/schemas/EgressHLSResponse","x-stream-index":"002"},"rtmps":{"items":{"$ref":"#/components/schemas/EgressRTMPResponse"},"type":"array","x-stream-index":"003"}},"required":["broadcasting","rtmps"],"type":"object"},"EgressTaskConfig":{"properties":{"egress_user":{"$ref":"#/components/schemas/EgressUser","x-stream-index":"008"},"frame_recording_egress_config":{"$ref":"#/components/schemas/FrameRecordingEgressConfig","x-stream-index":"009"},"hls_egress_config":{"$ref":"#/components/schemas/HLSEgressConfig","x-stream-index":"007"},"recording_egress_config":{"$ref":"#/components/schemas/RecordingEgressConfig","x-stream-index":"006"},"rtmp_egress_config":{"$ref":"#/components/schemas/RTMPEgressConfig","x-stream-index":"004"},"stt_egress_config":{"$ref":"#/components/schemas/STTEgressConfig","x-stream-index":"005"}},"type":"object"},"EgressUser":{"properties":{"token":{"type":"string","x-stream-index":"004"}},"type":"object"},"EnrichedActivity":{"properties":{"actor":{"$ref":"#/components/schemas/Data","x-stream-index":"002"},"foreign_id":{"type":"string","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"latest_reactions":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"013"},"object":{"$ref":"#/components/schemas/Data","x-stream-index":"004"},"origin":{"$ref":"#/components/schemas/Data","x-stream-index":"008"},"own_reactions":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"012"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"011"},"score":{"format":"float","type":"number","x-stream-index":"010"},"target":{"$ref":"#/components/schemas/Data","x-stream-index":"006"},"to":{"items":{"type":"string"},"type":"array","x-stream-index":"009"},"verb":{"type":"string","x-stream-index":"003"}},"type":"object"},"EnrichedReaction":{"nullable":true,"properties":{"activity_id":{"type":"string","x-stream-index":"003"},"children_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"010"},"created_at":{"$ref":"#/components/schemas/Time","x-stream-index":"012"},"data":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"kind":{"type":"string","x-stream-index":"002"},"latest_children":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"008"},"own_children":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"009"},"parent":{"type":"string","x-stream-index":"007"},"target_feeds":{"items":{"type":"string"},"type":"array","x-stream-index":"006"},"updated_at":{"$ref":"#/components/schemas/Time","x-stream-index":"013"},"user":{"$ref":"#/components/schemas/Data","x-stream-index":"011"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["kind","activity_id","user_id"],"type":"object"},"EntityCreator":{"properties":{"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"001.046"},"ban_count":{"format":"int32","type":"integer","x-stream-index":"002"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"001.017"},"banned":{"type":"boolean","x-stream-index":"001.016"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.013"},"deleted_content_count":{"format":"int32","type":"integer","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"001.023"},"language":{"type":"string","x-stream-index":"001.035"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"001.022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"001.026"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.042"},"role":{"type":"string","x-stream-index":"001.004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.005"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.009"}},"required":["id","role","teams_role","custom","banned","online","ban_count","deleted_content_count"],"type":"object"},"EntityCreatorResponse":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.001.018"},"ban_count":{"description":"Number of minor actions performed on the user","format":"int32","title":"Ban Count","type":"integer","x-stream-index":"002"},"banned":{"type":"boolean","x-stream-index":"001.001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.001.017"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.001.016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.001.011"},"deleted_content_count":{"description":"Number of major actions performed on the user","format":"int32","title":"Deleted Content Count","type":"integer","x-stream-index":"003"},"flagged_count":{"description":"Number of flag actions performed on the user","format":"int32","title":"Flagged Count","type":"integer","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001.001.001"},"image":{"type":"string","x-stream-index":"001.001.003"},"language":{"type":"string","x-stream-index":"001.001.005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"001.001.014"},"name":{"type":"string","x-stream-index":"001.001.002"},"online":{"type":"boolean","x-stream-index":"001.001.013"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.001.015"},"role":{"type":"string","x-stream-index":"001.001.006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.001.008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids","shadow_banned","invisible","ban_count","deleted_content_count","flagged_count"],"type":"object"},"EventNotificationSettings":{"properties":{"apns":{"$ref":"#/components/schemas/APNS","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"fcm":{"$ref":"#/components/schemas/FCM","x-stream-index":"003"}},"required":["enabled","apns","fcm"],"type":"object"},"ExternalStorage":{"properties":{"abs_account_name":{"type":"string","x-stream-index":"011"},"abs_client_id":{"type":"string","x-stream-index":"013"},"abs_client_secret":{"type":"string","x-stream-index":"014"},"abs_tenant_id":{"type":"string","x-stream-index":"012"},"bucket":{"type":"string","x-stream-index":"005"},"gcs_credentials":{"type":"string","x-stream-index":"010"},"path":{"type":"string","x-stream-index":"006"},"s3_api_key":{"type":"string","x-stream-index":"007"},"s3_custom_endpoint":{"type":"string","x-stream-index":"016"},"s3_region":{"type":"string","x-stream-index":"009"},"s3_secret_key":{"type":"string","x-stream-index":"008"},"storage_name":{"type":"string","x-stream-index":"015"},"storage_type":{"type":"integer","x-stream-index":"004"}},"type":"object"},"FCM":{"properties":{"data":{"additionalProperties":{},"type":"object","x-stream-index":"001"}},"type":"object"},"Field":{"nullable":true,"properties":{"short":{"type":"boolean","x-stream-index":"003"},"title":{"type":"string","x-stream-index":"001"},"value":{"type":"string","x-stream-index":"002"}},"required":["title","value","short"],"type":"object"},"Flag":{"description":"Contains information about flagged user or message","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"019"},"custom":{"additionalProperties":{},"description":"Additional metadata about the flag","title":"Custom","type":"object","x-stream-index":"014"},"entity_creator_id":{"description":"ID of the user who created the flagged entity","title":"Entity Creator ID","type":"string","x-stream-index":"009"},"entity_id":{"description":"Unique identifier of the entity being flagged","title":"Entity ID","type":"string","x-stream-index":"008"},"entity_type":{"description":"Type of entity being flagged (e.g., message, user)","title":"Entity Type","type":"string","x-stream-index":"007"},"is_streamed_content":{"type":"boolean","x-stream-index":"012"},"labels":{"description":"Labels from bodyguard, API calls, our own AI etc","items":{"type":"string"},"title":"Labels","type":"array","x-stream-index":"015"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content being flagged","title":"Moderation Payload","x-stream-index":"010"},"moderation_payload_hash":{"type":"string","x-stream-index":"011"},"reason":{"description":"Optional explanation for why the content is being flagged","title":"Reason","type":"string","x-stream-index":"013"},"result":{"description":"Result of bodyguard, API calls, our own AI etc","items":{"additionalProperties":{},"type":"object"},"title":"Result","type":"array","x-stream-index":"016"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"018"},"review_queue_item_id":{"description":"ID of the review queue item","title":"Review Queue Item ID","type":"string","x-stream-index":"017"},"type":{"type":"string","x-stream-index":"004"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"020"},"user":{"$ref":"#/components/schemas/User","description":"User who flagged a message or a user","title":"User","x-stream-index":"006"}},"required":["entity_type","entity_id","result","created_at","updated_at"],"title":"Flag","type":"object"},"FlagContentOptions":{"properties":{"reason":{"type":"string","x-stream-index":"001"}},"required":["reason"],"type":"object"},"FlagRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"description":"Additional metadata about the flag","title":"Custom","type":"object","x-stream-index":"006"},"entity_creator_id":{"description":"ID of the user who created the flagged entity","title":"Entity Creator ID","type":"string","x-stream-index":"003"},"entity_id":{"description":"Unique identifier of the entity being flagged","title":"Entity ID","type":"string","x-stream-index":"002"},"entity_type":{"description":"Type of entity being flagged (e.g., message, user)","title":"Entity Type","type":"string","x-stream-index":"001"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content being flagged","title":"Moderation Payload","x-stream-index":"005"},"reason":{"description":"Optional explanation for why the content is being flagged","maxLength":255,"title":"Reason","type":"string","x-stream-index":"004"}},"required":["entity_type","entity_id"],"type":"object"},"FlagResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"item_id":{"description":"Unique identifier of the created moderation item","title":"Item ID","type":"string","x-stream-index":"001"}},"required":["item_id","duration"],"type":"object"},"FlagUserOptions":{"properties":{"reason":{"type":"string","x-stream-index":"001"}},"required":["reason"],"type":"object"},"FrameRecordSettings":{"properties":{"capture_interval_in_seconds":{"format":"int32","maximum":60,"minimum":2,"type":"integer","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"},"quality":{"type":"string","x-stream-index":"002"}},"required":["mode","capture_interval_in_seconds"],"type":"object"},"FrameRecordingEgressConfig":{"properties":{"capture_interval_in_seconds":{"format":"int32","type":"integer","x-stream-index":"007"},"external_storage":{"$ref":"#/components/schemas/ExternalStorage","x-stream-index":"006"},"quality":{"$ref":"#/components/schemas/Quality","x-stream-index":"004"},"storage_name":{"type":"string","x-stream-index":"005"}},"type":"object"},"FrameRecordingResponse":{"properties":{"status":{"type":"string","x-stream-index":"001"}},"required":["status"],"type":"object"},"FrameRecordingSettingsResponse":{"properties":{"capture_interval_in_seconds":{"format":"int32","maximum":60,"minimum":2,"type":"integer","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"},"quality":{"type":"string","x-stream-index":"002"}},"required":["mode","capture_interval_in_seconds"],"type":"object"},"GeofenceSettings":{"properties":{"names":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"required":["names"],"type":"object"},"GeofenceSettingsResponse":{"properties":{"names":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"required":["names"],"type":"object"},"GetConfigResponse":{"nullable":true,"properties":{"config":{"$ref":"#/components/schemas/ConfigResponse","description":"The retrieved moderation configuration","title":"Config","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["duration"],"type":"object"},"GoogleVisionConfig":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"HLSEgressConfig":{"properties":{"composite_app_settings":{"$ref":"#/components/schemas/CompositeAppSettings","x-stream-index":"005"},"playlist_url":{"type":"string","x-stream-index":"007"},"qualities":{"items":{"$ref":"#/components/schemas/Quality"},"type":"array","x-stream-index":"004"},"start_unix_nano":{"format":"int64","type":"integer","x-stream-index":"006"}},"type":"object"},"HLSSettings":{"properties":{"auto_on":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"004"},"quality_tracks":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"required":["auto_on","enabled","quality_tracks"],"type":"object"},"HLSSettingsResponse":{"description":"HLSSettings is the payload for HLS settings","properties":{"auto_on":{"title":"Auto On","type":"boolean","x-stream-index":"001"},"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"002"},"quality_tracks":{"items":{"type":"string"},"title":"Quality Tracks","type":"array","x-stream-index":"003"}},"required":["auto_on","enabled","quality_tracks","layout"],"title":"HLSSettingsResponse","type":"object"},"HarmConfig":{"properties":{"action_sequences":{"items":{"$ref":"#/components/schemas/ActionSequence"},"type":"array","x-stream-index":"001"},"severity":{"type":"integer","x-stream-index":"002"}},"required":["action_sequences","severity"],"type":"object"},"ImageContentParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"type":"object"},"ImageData":{"properties":{"frames":{"type":"string","x-stream-index":"005"},"height":{"type":"string","x-stream-index":"003"},"size":{"type":"string","x-stream-index":"004"},"url":{"type":"string","x-stream-index":"001"},"width":{"type":"string","x-stream-index":"002"}},"required":["url","width","height","size","frames"],"type":"object"},"ImageRuleParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"required":["threshold","time_window"],"type":"object"},"Images":{"properties":{"fixed_height":{"$ref":"#/components/schemas/ImageData","x-stream-index":"002"},"fixed_height_downsampled":{"$ref":"#/components/schemas/ImageData","x-stream-index":"004"},"fixed_height_still":{"$ref":"#/components/schemas/ImageData","x-stream-index":"003"},"fixed_width":{"$ref":"#/components/schemas/ImageData","x-stream-index":"005"},"fixed_width_downsampled":{"$ref":"#/components/schemas/ImageData","x-stream-index":"007"},"fixed_width_still":{"$ref":"#/components/schemas/ImageData","x-stream-index":"006"},"original":{"$ref":"#/components/schemas/ImageData","x-stream-index":"001"}},"required":["original","fixed_height","fixed_height_still","fixed_height_downsampled","fixed_width","fixed_width_still","fixed_width_downsampled"],"type":"object"},"IngressAudioEncodingOptions":{"properties":{"bitrate":{"maximum":128000,"minimum":16000,"type":"integer","x-stream-index":"003"},"channels":{"enum":["1","2"],"format":"int32","type":"integer","x-stream-index":"001"},"enable_dtx":{"type":"boolean","x-stream-index":"002"}},"required":["channels","enable_dtx","bitrate"],"type":"object"},"IngressAudioEncodingResponse":{"properties":{"bitrate":{"format":"int32","type":"integer","x-stream-index":"003"},"channels":{"format":"int32","type":"integer","x-stream-index":"001"},"enable_dtx":{"type":"boolean","x-stream-index":"002"}},"required":["channels","enable_dtx","bitrate"],"type":"object"},"IngressSettings":{"properties":{"audio_encoding_options":{"$ref":"#/components/schemas/IngressAudioEncodingOptions","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"video_encoding_options":{"additionalProperties":{"$ref":"#/components/schemas/IngressVideoEncodingOptions"},"type":"object","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"IngressSettingsResponse":{"properties":{"audio_encoding_options":{"$ref":"#/components/schemas/IngressAudioEncodingResponse","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"video_encoding_options":{"additionalProperties":{"$ref":"#/components/schemas/IngressVideoEncodingResponse"},"type":"object","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"IngressVideoEncodingOptions":{"properties":{"layers":{"items":{"$ref":"#/components/schemas/IngressVideoLayer"},"minimum":1,"type":"array","x-stream-index":"001"}},"required":["layers"],"type":"object"},"IngressVideoEncodingResponse":{"properties":{"layers":{"items":{"$ref":"#/components/schemas/IngressVideoLayerResponse"},"type":"array","x-stream-index":"001"}},"required":["layers"],"type":"object"},"IngressVideoLayer":{"nullable":true,"properties":{"bitrate":{"minimum":1000,"type":"integer","x-stream-index":"002"},"codec":{"enum":["h264","vp8"],"type":"string","x-stream-index":"001"},"frame_rate":{"maximum":60,"minimum":1,"type":"integer","x-stream-index":"003"},"max_dimension":{"minimum":240,"type":"integer","x-stream-index":"005"},"min_dimension":{"minimum":240,"type":"integer","x-stream-index":"004"}},"required":["codec","bitrate","frame_rate","min_dimension","max_dimension"],"type":"object"},"IngressVideoLayerResponse":{"nullable":true,"properties":{"bitrate":{"type":"integer","x-stream-index":"002"},"codec":{"type":"string","x-stream-index":"001"},"frame_rate_limit":{"type":"integer","x-stream-index":"005"},"max_dimension":{"type":"integer","x-stream-index":"004"},"min_dimension":{"type":"integer","x-stream-index":"003"}},"required":["codec","bitrate","min_dimension","max_dimension","frame_rate_limit"],"type":"object"},"LabelThresholds":{"properties":{"block":{"format":"float","maximum":1,"minimum":0,"type":"number","x-stream-index":"002"},"flag":{"format":"float","maximum":1,"minimum":0,"type":"number","x-stream-index":"001"}},"type":"object"},"LayoutSettings":{"properties":{"detect_orientation":{"type":"boolean","x-stream-index":"005"},"external_app_url":{"type":"string","x-stream-index":"003"},"external_css_url":{"type":"string","x-stream-index":"004"},"name":{"enum":["spotlight","grid","single-participant","mobile","custom"],"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"required":["name","external_app_url","external_css_url"],"type":"object"},"LimitsSettings":{"properties":{"max_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"004"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"},"max_participants_exclude_owner":{"type":"boolean","x-stream-index":"003"},"max_participants_exclude_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"002"}},"required":["max_participants_exclude_roles"],"type":"object"},"LimitsSettingsResponse":{"properties":{"max_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"004"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"},"max_participants_exclude_owner":{"type":"boolean","x-stream-index":"003"},"max_participants_exclude_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"002"}},"required":["max_participants_exclude_roles"],"type":"object"},"MarkReviewedRequest":{"properties":{"content_to_mark_as_reviewed_limit":{"format":"int32","maximum":2500,"type":"integer","x-stream-index":"002"},"disable_marking_content_as_reviewed":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"MemberLookup":{"properties":{"Limit":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"001"}},"required":["Limit"],"type":"object"},"Message":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"012"},"before_message_send_failed":{"type":"boolean","x-stream-index":"046"},"cid":{"type":"string","x-stream-index":"028"},"command":{"type":"string","x-stream-index":"006"},"created_at":{"format":"date-time","type":"number","x-stream-index":"030"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"034"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"033"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"023"},"html":{"type":"string","x-stream-index":"007"},"i18n":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"044"},"id":{"type":"string","x-stream-index":"002"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"040"},"latest_reactions":{"items":{"$ref":"#/components/schemas/Reaction"},"type":"array","x-stream-index":"013"},"mentioned_users":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"043"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"052"},"mml":{"type":"string","x-stream-index":"005"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"056"},"own_reactions":{"items":{"$ref":"#/components/schemas/Reaction"},"type":"array","x-stream-index":"014"},"parent_id":{"type":"string","x-stream-index":"019"},"pin_expires":{"format":"date-time","type":"number","x-stream-index":"051"},"pinned":{"type":"boolean","x-stream-index":"047"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"048"},"pinned_by":{"$ref":"#/components/schemas/User","x-stream-index":"050"},"poll":{"$ref":"#/components/schemas/Poll","x-stream-index":"054"},"poll_id":{"type":"string","x-stream-index":"053"},"quoted_message":{"$ref":"#/components/schemas/Message","x-stream-index":"025"},"quoted_message_id":{"type":"string","x-stream-index":"024"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"015"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"017"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"016"},"reminder":{"$ref":"#/components/schemas/MessageReminder","x-stream-index":"058"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"022"},"restricted_visibility":{"items":{"type":"string"},"type":"array","x-stream-index":"011"},"shadowed":{"type":"boolean","x-stream-index":"036"},"shared_location":{"$ref":"#/components/schemas/SharedLocation","x-stream-index":"055"},"show_in_channel":{"type":"boolean","x-stream-index":"021"},"silent":{"type":"boolean","x-stream-index":"045"},"text":{"type":"string","x-stream-index":"004"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"027"},"type":{"type":"string","x-stream-index":"008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"031"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"010"}},"required":["id","text","html","type","restricted_visibility","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reaction_groups","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned"],"type":"object"},"MessageReminder":{"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"004"},"channel_cid":{"type":"string","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"011"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"006"},"message_id":{"type":"string","x-stream-index":"005"},"remind_at":{"format":"date-time","type":"number","x-stream-index":"009"},"task_id":{"type":"string","x-stream-index":"010"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"012"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"user_id":{"type":"string","x-stream-index":"007"}},"required":["channel_cid","message_id","user_id","task_id","created_at","updated_at"],"type":"object"},"MessageResponse":{"description":"Represents any chat message","properties":{"attachments":{"description":"Array of message attachments","items":{"$ref":"#/components/schemas/Attachment"},"title":"Message attachments","type":"array","x-stream-docs-page-id":"message_format#attachment-format","x-stream-index":"008"},"cid":{"description":"Channel unique identifier in \u003ctype\u003e:\u003cid\u003e format","title":"Channel CID","type":"string","x-stream-index":"022"},"command":{"description":"Contains provided slash command","title":"Command","type":"string","x-stream-docs-page-id":"custom_commands_webhook","x-stream-index":"004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"023"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"026"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"025"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"018"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"041"},"html":{"description":"Contains HTML markup of the message. Can only be set when using server-side API","title":"HTML content","type":"string","x-stream-index":"005"},"i18n":{"additionalProperties":{"type":"string"},"description":"Object with translations. Key `language` contains the original language key. Other keys contain translations","title":"Internationalization info","type":"object","x-stream-docs-page-id":"translation","x-stream-index":"030"},"id":{"description":"Message ID is unique string identifier of the message","title":"ID","type":"string","x-stream-index":"001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"Contains image moderation information","title":"Image moderation labels","type":"object","x-stream-index":"028"},"latest_reactions":{"description":"List of 10 latest reactions to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Latest reactions","type":"array","x-stream-index":"009"},"mentioned_users":{"description":"List of mentioned users","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Mentioned Users","type":"array","x-stream-index":"029"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"036"},"mml":{"description":"Should be empty if `text` is provided. Can only be set when using server-side API","title":"Messaging Markup Language","type":"string","x-stream-docs-page-id":"mml_overview","x-stream-index":"003"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"039"},"own_reactions":{"description":"List of 10 latest reactions of authenticated user to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Own reactions","type":"array","x-stream-index":"010"},"parent_id":{"description":"ID of parent message (thread)","title":"Parent message ID","type":"string","x-stream-docs-page-id":"threads","x-stream-index":"015"},"pin_expires":{"description":"Date when pinned message expires","format":"date-time","title":"Pin expiration date","type":"number","x-stream-docs-page-id":"pinned_messages","x-stream-index":"035"},"pinned":{"description":"Whether message is pinned or not","title":"Pinned","type":"boolean","x-stream-docs-page-id":"pinned_messages","x-stream-index":"032"},"pinned_at":{"description":"Date when message got pinned","format":"date-time","title":"Pinned at","type":"number","x-stream-docs-page-id":"pinned_messages","x-stream-index":"033"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","description":"Contains user who pinned the message","title":"Pinned by","x-stream-docs-page-id":"pinned_messages","x-stream-index":"034"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"038"},"poll_id":{"description":"Identifier of the poll to include in the message","title":"Poll ID","type":"string","x-stream-index":"037"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","description":"Contains quoted message","title":"Quoted message","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"020"},"quoted_message_id":{"title":"ID of quoted message","type":"string","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"019"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing number of reactions of each type. Key: reaction type (string), value: number of reactions (int)","title":"Reaction counts","type":"object","x-stream-index":"011"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"014"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing scores of reactions of each type. Key: reaction type (string), value: total score of reactions (int)","title":"Reaction scores","type":"object","x-stream-index":"012"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"042"},"reply_count":{"description":"Number of replies to this message","format":"int32","title":"Reply count","type":"integer","x-stream-index":"017"},"restricted_visibility":{"description":"A list of user ids that have restricted visibility to the message, if the list is not empty, the message is only visible to the users in the list","items":{"type":"string"},"title":"Restricted visibility","type":"array","x-stream-index":"040"},"shadowed":{"description":"Whether the message was shadowed or not","title":"Shadowed","type":"boolean","x-stream-docs-page-id":"moderation#shadow-ban","x-stream-index":"027"},"shared_location":{"$ref":"#/components/schemas/SharedLocationResponseData","description":"Contains shared location data","title":"Shared Location","x-stream-index":"043"},"show_in_channel":{"description":"Whether thread reply should be shown in the channel as well","title":"Show in channel","type":"boolean","x-stream-docs-page-id":"threads","x-stream-index":"016"},"silent":{"description":"Whether message is silent or not","title":"Silent","type":"boolean","x-stream-index":"031"},"text":{"description":"Text of the message. Should be empty if `mml` is provided","title":"Text","type":"string","x-stream-index":"002"},"thread_participants":{"description":"List of users who participate in thread","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Thread participants","type":"array","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"021"},"type":{"description":"Contains type of the message","enum":["regular","ephemeral","error","reply","system","deleted"],"title":"Message Type","type":"string","x-stream-docs-page-id":"message_format#message-types","x-stream-index":"006"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"024"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Sender of the message. Required when using server-side API","title":"User object","x-stream-index":"007"}},"required":["id","text","html","type","user","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned","restricted_visibility"],"title":"Message","type":"object","x-stream-docs-page-id":"send_message"},"ModerationActionConfig":{"nullable":true,"properties":{"action":{"type":"string","x-stream-index":"006"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"009"},"description":{"type":"string","x-stream-index":"008"},"entity_type":{"type":"string","x-stream-index":"004"},"icon":{"type":"string","x-stream-index":"007"},"order":{"format":"int32","type":"integer","x-stream-index":"005"}},"required":["entity_type","order","action","icon","description","custom"],"type":"object"},"ModerationCustomActionEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"001"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"002"},"type":{"default":"moderation.custom_action","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationCustomActionEvent","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"},"ModerationFlaggedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"item":{"type":"string","x-stream-index":"001"},"object_id":{"type":"string","x-stream-index":"002"},"type":{"default":"moderation.flagged","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationFlaggedEvent","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"},"ModerationMarkReviewedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"001"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"002"},"type":{"default":"moderation.mark_reviewed","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationMarkReviewedEvent","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"},"ModerationPayload":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"images":{"items":{"type":"string"},"maximum":30,"type":"array","x-stream-index":"002"},"texts":{"items":{"type":"string"},"type":"array","x-stream-index":"001"},"videos":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"type":"object"},"ModerationV2Response":{"properties":{"action":{"type":"string","x-stream-index":"001"},"blocklist_matched":{"type":"string","x-stream-index":"005"},"image_harms":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"original_text":{"type":"string","x-stream-index":"002"},"platform_circumvented":{"type":"boolean","x-stream-index":"007"},"semantic_filter_matched":{"type":"string","x-stream-index":"006"},"text_harms":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"required":["action","original_text"],"type":"object"},"MuteRequest":{"nullable":true,"properties":{"target_ids":{"description":"User IDs to mute (if multiple users)","items":{"type":"string"},"title":"Target IDs","type":"array","x-stream-index":"001"},"timeout":{"description":"Duration of mute in minutes","minimum":0,"title":"Timeout","type":"integer","x-stream-index":"002"}},"required":["target_ids"],"title":"MuteRequest","type":"object"},"MuteResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"004.001"},"mutes":{"description":"Object with mutes (if multiple users were muted)","items":{"$ref":"#/components/schemas/UserMute"},"title":"Mutes","type":"array","x-stream-index":"001"},"non_existing_users":{"description":"A list of users that can't be found. Common cause for this is deleted users","items":{"type":"string"},"title":"Non Existing Users","type":"array","x-stream-index":"003"},"own_user":{"$ref":"#/components/schemas/OwnUser","description":"Authorized user object with fresh mutes information","title":"Own User","x-stream-index":"002"}},"required":["duration"],"title":"MuteResponse","type":"object"},"NoiseCancellationSettings":{"properties":{"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode"],"type":"object"},"NotificationSettings":{"properties":{"call_live_started":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"002"},"call_missed":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"006"},"call_notification":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"004"},"call_ring":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"session_started":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"003"}},"required":["enabled","call_live_started","session_started","call_notification","call_ring","call_missed"],"type":"object"},"NullTime":{"type":"object"},"OCRRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"}},"required":["label","action"],"type":"object"},"OwnUser":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"046"},"banned":{"type":"boolean","x-stream-index":"016"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"045"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"029"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"014"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"013"},"devices":{"items":{"$ref":"#/components/schemas/Device"},"type":"array","x-stream-index":"027"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"023"},"language":{"type":"string","x-stream-index":"035"},"last_active":{"format":"date-time","type":"number","x-stream-index":"011"},"last_engaged_at":{"format":"date-time","type":"number","x-stream-index":"012"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"037"},"mutes":{"items":{"$ref":"#/components/schemas/UserMute"},"type":"array","x-stream-index":"028"},"online":{"type":"boolean","x-stream-index":"022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"026"},"push_preferences":{"$ref":"#/components/schemas/PushPreferences","x-stream-index":"025"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"005"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"031"},"total_unread_count_by_team":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"032"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"033"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"030"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"034"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"}},"required":["id","role","custom","created_at","updated_at","banned","online","devices","mutes","channel_mutes","unread_count","total_unread_count","total_unread_count_by_team","unread_channels","unread_threads","language"],"type":"object"},"Poll":{"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"023"},"allow_answers":{"type":"boolean","x-stream-index":"010"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"009"},"answers_count":{"format":"int32","type":"integer","x-stream-index":"015"},"created_at":{"format":"date-time","type":"number","x-stream-index":"021"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"020"},"created_by_id":{"type":"string","x-stream-index":"019"},"description":{"type":"string","x-stream-index":"005"},"enforce_unique_vote":{"type":"boolean","x-stream-index":"007"},"id":{"type":"string","x-stream-index":"003"},"is_closed":{"type":"boolean","x-stream-index":"011"},"latest_answers":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array","x-stream-index":"017"},"latest_votes_by_option":{"additionalProperties":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array"},"type":"object","x-stream-index":"016"},"max_votes_allowed":{"format":"int32","type":"integer","x-stream-index":"008"},"name":{"type":"string","x-stream-index":"004"},"options":{"items":{"$ref":"#/components/schemas/PollOption"},"type":"array","x-stream-index":"013"},"own_votes":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array","x-stream-index":"018"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"022"},"vote_count":{"format":"int32","type":"integer","x-stream-index":"012"},"vote_counts_by_option":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"014"},"voting_visibility":{"type":"string","x-stream-index":"006"}},"required":["id","name","description","enforce_unique_vote","allow_user_suggested_options","allow_answers","vote_count","options","vote_counts_by_option","answers_count","latest_votes_by_option","latest_answers","own_votes","created_by_id","created_at","updated_at","Custom"],"type":"object"},"PollOption":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id","text","custom"],"type":"object"},"PollOptionResponseData":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id","text","custom"],"type":"object"},"PollResponseData":{"properties":{"allow_answers":{"type":"boolean","x-stream-index":"008"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"007"},"answers_count":{"format":"int32","type":"integer","x-stream-index":"012"},"created_at":{"format":"date-time","type":"number","x-stream-index":"019"},"created_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"018"},"created_by_id":{"type":"string","x-stream-index":"017"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"021"},"description":{"type":"string","x-stream-index":"003"},"enforce_unique_vote":{"type":"boolean","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"is_closed":{"type":"boolean","x-stream-index":"009"},"latest_answers":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array","x-stream-index":"015"},"latest_votes_by_option":{"additionalProperties":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array"},"type":"object","x-stream-index":"014"},"max_votes_allowed":{"format":"int32","type":"integer","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"002"},"options":{"items":{"$ref":"#/components/schemas/PollOptionResponseData"},"type":"array","x-stream-index":"011"},"own_votes":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array","x-stream-index":"016"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"020"},"vote_count":{"format":"int32","type":"integer","x-stream-index":"010"},"vote_counts_by_option":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"013"},"voting_visibility":{"type":"string","x-stream-index":"004"}},"required":["id","name","description","voting_visibility","enforce_unique_vote","allow_user_suggested_options","allow_answers","vote_count","options","answers_count","vote_counts_by_option","latest_votes_by_option","latest_answers","own_votes","created_by_id","created_at","updated_at","custom"],"type":"object"},"PollVote":{"nullable":true,"properties":{"answer_text":{"type":"string","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"004"},"is_answer":{"type":"boolean","x-stream-index":"006"},"option_id":{"type":"string","x-stream-index":"005"},"poll_id":{"type":"string","x-stream-index":"003"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"011"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"009"},"user_id":{"type":"string","x-stream-index":"008"}},"required":["poll_id","id","option_id","created_at","updated_at"],"type":"object"},"PollVoteResponseData":{"nullable":true,"properties":{"answer_text":{"type":"string","x-stream-index":"005"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"id":{"type":"string","x-stream-index":"002"},"is_answer":{"type":"boolean","x-stream-index":"004"},"option_id":{"type":"string","x-stream-index":"003"},"poll_id":{"type":"string","x-stream-index":"001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"007"},"user_id":{"type":"string","x-stream-index":"006"}},"required":["poll_id","id","option_id","created_at","updated_at"],"type":"object"},"PrivacySettings":{"properties":{"read_receipts":{"$ref":"#/components/schemas/ReadReceipts","x-stream-index":"002"},"typing_indicators":{"$ref":"#/components/schemas/TypingIndicators","x-stream-index":"001"}},"type":"object"},"PrivacySettingsResponse":{"properties":{"read_receipts":{"$ref":"#/components/schemas/ReadReceiptsResponse","x-stream-index":"002"},"typing_indicators":{"$ref":"#/components/schemas/TypingIndicatorsResponse","x-stream-index":"001"}},"type":"object"},"PushPreferences":{"properties":{"call_level":{"type":"string","x-stream-index":"002"},"chat_level":{"type":"string","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"number","x-stream-index":"003"}},"type":"object"},"Quality":{"properties":{"bitdepth":{"format":"int32","type":"integer","x-stream-index":"007"},"framerate":{"format":"int32","type":"integer","x-stream-index":"008"},"height":{"format":"int32","type":"integer","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"004"},"video_bitrate":{"format":"int32","type":"integer","x-stream-index":"009"},"width":{"format":"int32","type":"integer","x-stream-index":"005"}},"type":"object"},"QueryModerationConfigsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter conditions for moderation configs","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"Sorting parameters for the results","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"002"}},"type":"object"},"QueryModerationConfigsResponse":{"nullable":true,"properties":{"configs":{"description":"List of moderation configurations","items":{"$ref":"#/components/schemas/ConfigResponse"},"title":"Configs","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["configs","duration"],"type":"object"},"QueryReviewQueueRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter conditions for review queue items","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"007.001"},"lock_count":{"description":"Number of items to lock (1-25)","format":"int32","maximum":25,"minimum":1,"title":"Lock Count","type":"integer","x-stream-index":"005"},"lock_duration":{"description":"Duration for which items should be locked","title":"Lock Duration","type":"integer","x-stream-index":"004"},"lock_items":{"description":"Whether to lock items for review (true), unlock items (false), or just fetch (nil)","title":"Lock Items","type":"boolean","x-stream-index":"003"},"next":{"type":"string","x-stream-index":"007.002"},"prev":{"type":"string","x-stream-index":"007.003"},"sort":{"description":"Sorting parameters for the results","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"002"},"stats_only":{"description":"Whether to return only statistics","title":"Stats Only","type":"boolean","x-stream-index":"006"}},"type":"object"},"QueryReviewQueueResponse":{"nullable":true,"properties":{"action_config":{"additionalProperties":{"items":{"$ref":"#/components/schemas/ModerationActionConfig"},"type":"array"},"description":"Configuration for moderation actions","title":"Action Config","type":"object","x-stream-index":"002"},"duration":{"type":"string","x-stream-index":"005.001"},"items":{"description":"List of review queue items","items":{"$ref":"#/components/schemas/ReviewQueueItemResponse"},"title":"Items","type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"004.001"},"prev":{"type":"string","x-stream-index":"004.002"},"stats":{"additionalProperties":{},"description":"Statistics about the review queue","title":"Stats","type":"object","x-stream-index":"003"}},"required":["items","action_config","stats","duration"],"type":"object"},"RTMPEgressConfig":{"properties":{"composite_app_settings":{"$ref":"#/components/schemas/CompositeAppSettings","x-stream-index":"005"},"quality":{"$ref":"#/components/schemas/Quality","x-stream-index":"004"},"rtmp_location":{"type":"string","x-stream-index":"006"}},"type":"object"},"RTMPIngress":{"description":"RTMP input settings","properties":{"address":{"title":"Address","type":"string","x-stream-index":"001"}},"required":["address"],"title":"RTMPIngress","type":"object"},"RTMPLocation":{"properties":{"name":{"type":"string","x-stream-index":"001"},"stream_key":{"type":"string","x-stream-index":"003"},"stream_url":{"type":"string","x-stream-index":"002"}},"required":["name","stream_url","stream_key"],"type":"object"},"RTMPSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"003"},"location":{"$ref":"#/components/schemas/RTMPLocation","x-stream-index":"004"},"quality_name":{"type":"string","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"RTMPSettingsResponse":{"description":"RTMPSettingsResponse is the payload for RTMP settings","properties":{"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"001"},"quality":{"title":"Quality","type":"string","x-stream-index":"002"}},"required":["enabled","quality","layout"],"title":"RTMPSettingsResponse","type":"object"},"Reaction":{"nullable":true,"properties":{"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"message_id":{"type":"string","x-stream-index":"003"},"score":{"format":"int32","type":"integer","x-stream-index":"007"},"type":{"maxLength":30,"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["message_id","type","score","created_at","updated_at","custom"],"type":"object"},"ReactionGroupResponse":{"description":"ReactionGroupResponse contains all information about a reaction of the same type.","nullable":true,"properties":{"count":{"description":"Count is the number of reactions of this type.","format":"int32","title":"Count","type":"integer","x-stream-index":"001"},"first_reaction_at":{"description":"FirstReactionAt is the time of the first reaction of this type. This is the same also if all reaction of this type are deleted, because if someone will react again with the same type, will be preserved the sorting.","format":"date-time","title":"FirstReactionAt","type":"number","x-stream-index":"003"},"last_reaction_at":{"description":"LastReactionAt is the time of the last reaction of this type.","format":"date-time","title":"LastReactionAt","type":"number","x-stream-index":"004"},"sum_scores":{"description":"SumScores is the sum of all scores of reactions of this type. Medium allows you to clap articles more than once and shows the sum of all claps from all users. For example, you can send `clap` x5 using `score: 5`.","format":"int32","title":"SumScores","type":"integer","x-stream-index":"002"}},"required":["count","sum_scores","first_reaction_at","last_reaction_at"],"title":"ReactionGroupResponse","type":"object"},"ReactionResponse":{"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"006"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"008"},"message_id":{"description":"Message ID","title":"Message ID","type":"string","x-stream-index":"001"},"score":{"description":"Score of the reaction","format":"int32","title":"Score","type":"integer","x-stream-index":"005"},"type":{"description":"Type of reaction","title":"Type","type":"string","x-stream-index":"004"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"007"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User","title":"UserResponse","x-stream-index":"003"},"user_id":{"description":"User ID","title":"User ID","type":"string","x-stream-index":"002"}},"required":["message_id","user_id","user","type","score","created_at","updated_at","custom"],"type":"object"},"ReadReceipts":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"ReadReceiptsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"RecordSettings":{"properties":{"audio_only":{"type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"004"},"mode":{"type":"string","x-stream-index":"002"},"quality":{"type":"string","x-stream-index":"003"}},"required":["mode"],"type":"object"},"RecordSettingsResponse":{"description":"RecordSettings is the payload for recording settings","properties":{"audio_only":{"title":"Audio Only","type":"boolean","x-stream-index":"001"},"mode":{"title":"Mode","type":"string","x-stream-index":"002"},"quality":{"title":"Quality","type":"string","x-stream-index":"003"}},"required":["audio_only","mode","quality","layout"],"title":"RecordSettingsResponse","type":"object"},"RecordingEgressConfig":{"properties":{"audio_only":{"type":"boolean","x-stream-index":"006"},"composite_app_settings":{"$ref":"#/components/schemas/CompositeAppSettings","x-stream-index":"005"},"external_storage":{"$ref":"#/components/schemas/ExternalStorage","x-stream-index":"008"},"quality":{"$ref":"#/components/schemas/Quality","x-stream-index":"004"},"storage_name":{"type":"string","x-stream-index":"007"},"video_orientation_hint":{"$ref":"#/components/schemas/VideoOrientation","x-stream-index":"009"}},"type":"object"},"ReminderResponseData":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003"},"channel_cid":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"005"},"message_id":{"type":"string","x-stream-index":"004"},"remind_at":{"format":"date-time","type":"number","x-stream-index":"001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007"},"user_id":{"type":"string","x-stream-index":"006"}},"required":["channel_cid","message_id","user_id","created_at","updated_at"],"type":"object"},"RestoreActionRequest":{"type":"object"},"ReviewQueueItem":{"properties":{"actions":{"items":{"$ref":"#/components/schemas/ActionLog"},"type":"array","x-stream-index":"035"},"activity":{"$ref":"#/components/schemas/EnrichedActivity","x-stream-index":"028"},"ai_text_severity":{"type":"string","x-stream-index":"021"},"archived_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"043"},"assigned_to":{"$ref":"#/components/schemas/User","x-stream-index":"032"},"bans":{"items":{"$ref":"#/components/schemas/Ban"},"type":"array","x-stream-index":"033"},"bounce_count":{"format":"int32","type":"integer","x-stream-index":"025"},"call":{"$ref":"#/components/schemas/Call","x-stream-index":"031"},"completed_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"018"},"config_key":{"type":"string","x-stream-index":"009"},"content_changed":{"type":"boolean","x-stream-index":"036"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"entity_creator":{"$ref":"#/components/schemas/EntityCreator","x-stream-index":"030"},"entity_id":{"type":"string","x-stream-index":"007"},"entity_type":{"type":"string","x-stream-index":"006"},"feeds_v2_activity":{"$ref":"#/components/schemas/EnrichedActivity","x-stream-index":"041"},"feeds_v2_reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"042"},"flag_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"045"},"flag_types":{"items":{"type":"string"},"type":"array","x-stream-index":"044"},"flags":{"items":{"$ref":"#/components/schemas/Flag"},"type":"array","x-stream-index":"034"},"flags_count":{"format":"int32","type":"integer","x-stream-index":"026"},"has_image":{"type":"boolean","x-stream-index":"012"},"has_text":{"type":"boolean","x-stream-index":"014"},"has_video":{"type":"boolean","x-stream-index":"013"},"id":{"type":"string","x-stream-index":"003"},"languages":{"items":{"type":"string"},"type":"array","x-stream-index":"019"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"027"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"010"},"moderation_payload_hash":{"type":"string","x-stream-index":"011"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"029"},"recommended_action":{"type":"string","x-stream-index":"017"},"reporter_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"046"},"reviewed_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"022"},"reviewed_by":{"type":"string","x-stream-index":"023"},"severity":{"format":"int32","type":"integer","x-stream-index":"020"},"status":{"type":"string","x-stream-index":"016"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"015"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"005"}},"required":["id","created_at","updated_at","entity_type","entity_id","config_key","moderation_payload_hash","has_image","has_video","has_text","teams","status","recommended_action","completed_at","languages","severity","ai_text_severity","reviewed_at","reviewed_by","bounce_count","flags_count","bans","flags","actions","content_changed","archived_at","flag_types","flag_labels","reporter_ids"],"type":"object"},"ReviewQueueItemResponse":{"nullable":true,"properties":{"actions":{"description":"Moderation actions taken","items":{"$ref":"#/components/schemas/ActionLogResponse"},"title":"Actions","type":"array","x-stream-index":"024"},"activity":{"$ref":"#/components/schemas/EnrichedActivity","x-stream-index":"016"},"ai_text_severity":{"description":"AI-determined text severity","title":"AI Text Severity","type":"string","x-stream-index":"014"},"assigned_to":{"$ref":"#/components/schemas/UserResponse","description":"Moderator assigned to review this item","title":"Assigned To","x-stream-index":"021"},"bans":{"description":"Associated ban records","items":{"$ref":"#/components/schemas/Ban"},"title":"Bans","type":"array","x-stream-index":"022"},"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"018"},"completed_at":{"description":"When the review was completed","format":"date-time","title":"Completed At","type":"number","x-stream-index":"009"},"config_key":{"type":"string","x-stream-index":"028"},"created_at":{"description":"When the item was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"002"},"entity_creator":{"$ref":"#/components/schemas/EntityCreatorResponse","description":"Details about who created the entity","title":"Entity Creator","x-stream-index":"019"},"entity_creator_id":{"description":"ID of who created the entity","title":"Entity Creator ID","type":"string","x-stream-index":"020"},"entity_id":{"description":"ID of the entity being reviewed","title":"Entity ID","type":"string","x-stream-index":"005"},"entity_type":{"description":"Type of entity being reviewed","title":"Entity Type","type":"string","x-stream-index":"004"},"feeds_v2_activity":{"$ref":"#/components/schemas/EnrichedActivity","description":"Associated feed activity","title":"Feeds V2 Activity","x-stream-index":"025"},"feeds_v2_reaction":{"$ref":"#/components/schemas/Reaction","description":"Associated feed reaction","title":"Feeds V2 Reaction","x-stream-index":"026"},"flags":{"description":"Associated flag records","items":{"$ref":"#/components/schemas/FlagResponse"},"title":"Flags","type":"array","x-stream-index":"023"},"flags_count":{"format":"int32","type":"integer","x-stream-index":"029"},"id":{"description":"Unique identifier of the review queue item","title":"ID","type":"string","x-stream-index":"001"},"languages":{"description":"Detected languages in the content","items":{"type":"string"},"title":"Languages","type":"array","x-stream-index":"012"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Associated message details","title":"Message","x-stream-index":"015"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content being moderated","title":"Moderation Payload","x-stream-index":"006"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"017"},"recommended_action":{"description":"Suggested moderation action","title":"Recommended Action","type":"string","x-stream-index":"008"},"reviewed_at":{"description":"When the item was reviewed","format":"date-time","title":"Reviewed At","type":"number","x-stream-index":"010"},"reviewed_by":{"description":"ID of the moderator who reviewed the item","title":"Reviewed By","type":"string","x-stream-index":"011"},"severity":{"description":"Severity level of the content","format":"int32","title":"Severity","type":"integer","x-stream-index":"013"},"status":{"description":"Current status of the review","title":"Status","type":"string","x-stream-index":"007"},"teams":{"description":"Teams associated with this item","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"027"},"updated_at":{"description":"When the item was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"003"}},"required":["id","created_at","updated_at","entity_type","entity_id","status","recommended_action","reviewed_by","languages","severity","ai_text_severity","bans","flags","actions","flags_count"],"type":"object"},"RingSettings":{"properties":{"auto_cancel_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_timeout_ms","missed_call_timeout_ms"],"type":"object"},"RingSettingsResponse":{"properties":{"auto_cancel_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_timeout_ms","missed_call_timeout_ms"],"type":"object"},"RuleBuilderAction":{"properties":{"ban_options":{"$ref":"#/components/schemas/BanOptions","x-stream-index":"002"},"flag_content_options":{"$ref":"#/components/schemas/FlagContentOptions","x-stream-index":"004"},"flag_user_options":{"$ref":"#/components/schemas/FlagUserOptions","x-stream-index":"003"},"remove_content_options":{"$ref":"#/components/schemas/BlockContentOptions","x-stream-index":"005"},"type":{"type":"string","x-stream-index":"001"}},"required":["type"],"type":"object"},"RuleBuilderCondition":{"properties":{"confidence":{"format":"float","type":"number","x-stream-index":"002"},"content_count_rule_params":{"$ref":"#/components/schemas/ContentCountRuleParameters","x-stream-index":"007"},"image_content_params":{"$ref":"#/components/schemas/ImageContentParameters","x-stream-index":"009"},"image_rule_params":{"$ref":"#/components/schemas/ImageRuleParameters","x-stream-index":"004"},"text_content_params":{"$ref":"#/components/schemas/TextContentParameters","x-stream-index":"008"},"text_rule_params":{"$ref":"#/components/schemas/TextRuleParameters","x-stream-index":"003"},"type":{"type":"string","x-stream-index":"001"},"user_created_within_params":{"$ref":"#/components/schemas/UserCreatedWithinParameters","x-stream-index":"011"},"user_rule_params":{"$ref":"#/components/schemas/UserRuleParameters","x-stream-index":"006"},"video_content_params":{"$ref":"#/components/schemas/VideoContentParameters","x-stream-index":"010"},"video_rule_params":{"$ref":"#/components/schemas/VideoRuleParameters","x-stream-index":"005"}},"required":["type"],"type":"object"},"RuleBuilderConditionGroup":{"properties":{"conditions":{"items":{"$ref":"#/components/schemas/RuleBuilderCondition"},"type":"array","x-stream-index":"002"},"logic":{"type":"string","x-stream-index":"001"}},"required":["logic","conditions"],"type":"object"},"RuleBuilderConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"rules":{"items":{"$ref":"#/components/schemas/RuleBuilderRule"},"type":"array","x-stream-index":"002"}},"required":["rules"],"type":"object"},"RuleBuilderRule":{"properties":{"action":{"$ref":"#/components/schemas/RuleBuilderAction","x-stream-index":"007"},"conditions":{"items":{"$ref":"#/components/schemas/RuleBuilderCondition"},"type":"array","x-stream-index":"004"},"cooldown_period":{"type":"string","x-stream-index":"009"},"enabled":{"type":"boolean","x-stream-index":"008"},"groups":{"items":{"$ref":"#/components/schemas/RuleBuilderConditionGroup"},"type":"array","x-stream-index":"006"},"id":{"type":"string","x-stream-index":"001"},"logic":{"type":"string","x-stream-index":"005"},"name":{"type":"string","x-stream-index":"002"},"rule_type":{"type":"string","x-stream-index":"003"}},"required":["id","name","rule_type","action","enabled"],"type":"object"},"SFUIDLastSeen":{"properties":{"id":{"type":"string","x-stream-index":"001.001"},"last_seen":{"format":"date-time","type":"number","x-stream-index":"002"},"process_start_time":{"format":"int64","type":"integer","x-stream-index":"001.002"}},"required":["id","process_start_time","last_seen"],"type":"object"},"STTEgressConfig":{"properties":{"closed_captions_enabled":{"type":"boolean","x-stream-index":"005"},"external_storage":{"$ref":"#/components/schemas/ExternalStorage","x-stream-index":"011"},"language":{"type":"string","x-stream-index":"008"},"storage_name":{"type":"string","x-stream-index":"010"},"translation_languages":{"items":{"type":"string"},"type":"array","x-stream-index":"009"},"translations_enabled":{"type":"boolean","x-stream-index":"006"},"upload_transcriptions":{"type":"boolean","x-stream-index":"004"},"whisper_server_base_url":{"type":"string","x-stream-index":"007"}},"type":"object"},"ScreensharingSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled"],"type":"object"},"ScreensharingSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled"],"type":"object"},"SessionSettings":{"properties":{"inactivity_timeout_seconds":{"format":"int32","maximum":900,"minimum":5,"type":"integer","x-stream-index":"001"}},"required":["inactivity_timeout_seconds"],"type":"object"},"SessionSettingsResponse":{"properties":{"inactivity_timeout_seconds":{"format":"int32","maximum":900,"minimum":5,"type":"integer","x-stream-index":"001"}},"required":["inactivity_timeout_seconds"],"type":"object"},"ShadowBlockActionRequest":{"type":"object"},"SharedLocation":{"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"013"},"channel_cid":{"type":"string","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"010"},"created_by_device_id":{"type":"string","x-stream-index":"008"},"end_at":{"format":"date-time","type":"number","x-stream-index":"009"},"latitude":{"format":"float","maximum":90,"minimum":18446744073709552000,"type":"number","x-stream-index":"006"},"longitude":{"format":"float","maximum":180,"minimum":18446744073709552000,"type":"number","x-stream-index":"007"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"012"},"message_id":{"type":"string","x-stream-index":"004"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"011"},"user_id":{"type":"string","x-stream-index":"005"}},"required":["channel_cid","message_id","user_id","created_by_device_id","created_at","updated_at"],"type":"object"},"SharedLocationResponseData":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"011"},"channel_cid":{"type":"string","x-stream-index":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"created_by_device_id":{"type":"string","x-stream-index":"006"},"end_at":{"format":"date-time","type":"number","x-stream-index":"007"},"latitude":{"format":"float","type":"number","x-stream-index":"004"},"longitude":{"format":"float","type":"number","x-stream-index":"005"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"010"},"message_id":{"type":"string","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["channel_cid","message_id","user_id","latitude","longitude","created_by_device_id","created_at","updated_at"],"type":"object"},"SortParamRequest":{"nullable":true,"properties":{"direction":{"description":"Direction of sorting, 1 for Ascending, -1 for Descending, default is 1","format":"int32","title":"Direction","type":"integer","x-stream-index":"002"},"field":{"description":"Name of field to sort by","title":"Field","type":"string","x-stream-index":"001"}},"type":"object"},"SubmitActionRequest":{"nullable":true,"properties":{"action_type":{"description":"Type of moderation action to perform (mark_reviewed, delete_message, etc.)","enum":["mark_reviewed","delete_message","delete_activity","delete_reaction","ban","custom","unban","restore","delete_user","unblock","shadow_block","unmask","kick_user","end_call"],"title":"Action Type","type":"string","x-stream-index":"002"},"ban":{"$ref":"#/components/schemas/BanActionRequest","description":"Configuration for ban action","title":"Ban","x-stream-index":"008"},"custom":{"$ref":"#/components/schemas/CustomActionRequest","description":"Configuration for custom action","title":"Custom","x-stream-index":"009"},"delete_activity":{"$ref":"#/components/schemas/DeleteActivityRequest","description":"Configuration for activity deletion action","title":"Delete Activity","x-stream-index":"004"},"delete_message":{"$ref":"#/components/schemas/DeleteMessageRequest","description":"Configuration for message deletion action","title":"Delete Message","x-stream-index":"003"},"delete_reaction":{"$ref":"#/components/schemas/DeleteReactionRequest","description":"Configuration for reaction deletion action","title":"Delete Reaction","x-stream-index":"005"},"delete_user":{"$ref":"#/components/schemas/DeleteUserRequest","description":"Configuration for user deletion action","title":"Delete User","x-stream-index":"006"},"item_id":{"description":"UUID of the review queue item to act on","title":"Item ID","type":"string","x-stream-index":"001"},"mark_reviewed":{"$ref":"#/components/schemas/MarkReviewedRequest","description":"Configuration for marking item as reviewed","title":"Mark Reviewed","x-stream-index":"007"},"unban":{"$ref":"#/components/schemas/UnbanActionRequest","description":"Configuration for unban action","title":"Unban","x-stream-index":"010"}},"required":["item_id","action_type"],"type":"object"},"SubmitActionResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"Updated review queue item after action was performed","title":"Item","x-stream-index":"001"}},"required":["duration"],"type":"object"},"TargetResolution":{"properties":{"bitrate":{"format":"int32","maximum":6000000,"type":"integer","x-stream-index":"003"},"height":{"format":"int32","maximum":3840,"minimum":240,"type":"integer","x-stream-index":"002"},"width":{"format":"int32","maximum":3840,"minimum":240,"type":"integer","x-stream-index":"001"}},"required":["width","height","bitrate"],"type":"object"},"TextContentParameters":{"properties":{"blocklist_match":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"contains_url":{"type":"boolean","x-stream-index":"002"},"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001"},"severity":{"type":"string","x-stream-index":"003"}},"type":"object"},"TextRuleParameters":{"properties":{"blocklist_match":{"items":{"type":"string"},"type":"array","x-stream-index":"006"},"contains_url":{"type":"boolean","x-stream-index":"004"},"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"severity":{"type":"string","x-stream-index":"005"},"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"required":["threshold","time_window"],"type":"object"},"Thresholds":{"properties":{"explicit":{"$ref":"#/components/schemas/LabelThresholds","x-stream-index":"001"},"spam":{"$ref":"#/components/schemas/LabelThresholds","x-stream-index":"002"},"toxic":{"$ref":"#/components/schemas/LabelThresholds","x-stream-index":"003"}},"type":"object"},"ThumbnailResponse":{"properties":{"image_url":{"type":"string","x-stream-index":"001"}},"required":["image_url"],"type":"object"},"ThumbnailsSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"ThumbnailsSettingsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"Time":{"type":"object"},"TranscriptionSettings":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"title":"Mode","type":"string","x-stream-index":"002"},"language":{"description":"The language used in this call as a two letter code","enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"title":"Language","type":"string","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"title":"Mode","type":"string","x-stream-index":"001"}},"required":["mode","closed_caption_mode","languages","language"],"type":"object"},"TranscriptionSettingsResponse":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"002"},"language":{"enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"type":"string","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode","closed_caption_mode","languages","language"],"type":"object"},"TypingIndicators":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"TypingIndicatorsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"UnbanActionRequest":{"type":"object"},"UnblockActionRequest":{"type":"object"},"UpsertConfigRequest":{"nullable":true,"properties":{"ai_image_config":{"$ref":"#/components/schemas/AIImageConfig","description":"Configuration for AI image analysis","title":"AI Image Config","x-stream-index":"010"},"ai_text_config":{"$ref":"#/components/schemas/AITextConfig","description":"Configuration for AI text analysis","title":"AI Text Config","x-stream-index":"008"},"ai_video_config":{"$ref":"#/components/schemas/AIVideoConfig","description":"Configuration for AI video analysis","title":"AI Video Config","x-stream-index":"011"},"async":{"description":"Whether moderation should be performed asynchronously","title":"Async","type":"boolean","x-stream-index":"003"},"automod_platform_circumvention_config":{"$ref":"#/components/schemas/AutomodPlatformCircumventionConfig","description":"Configuration for platform circumvention detection","title":"Automod Platform Circumvention Config","x-stream-index":"005"},"automod_semantic_filters_config":{"$ref":"#/components/schemas/AutomodSemanticFiltersConfig","description":"Configuration for semantic filtering","title":"Automod Semantic Filters Config","x-stream-index":"006"},"automod_toxicity_config":{"$ref":"#/components/schemas/AutomodToxicityConfig","description":"Configuration for toxicity detection","title":"Automod Toxicity Config","x-stream-index":"004"},"aws_rekognition_config":{"$ref":"#/components/schemas/AIImageConfig","x-stream-index":"015"},"block_list_config":{"$ref":"#/components/schemas/BlockListConfig","description":"Configuration for block list filtering","title":"Block List Config","x-stream-index":"007"},"bodyguard_config":{"$ref":"#/components/schemas/AITextConfig","x-stream-index":"014"},"google_vision_config":{"$ref":"#/components/schemas/GoogleVisionConfig","description":"Configuration for Google Vision integration","title":"Google Vision Config","x-stream-index":"009"},"key":{"description":"Unique identifier for the moderation configuration","title":"Key","type":"string","x-stream-index":"001"},"rule_builder_config":{"$ref":"#/components/schemas/RuleBuilderConfig","description":"Configuration for custom rule builder (max 3 rules, max 5 conditions per rule)","title":"Rule Builder Config","x-stream-index":"013"},"team":{"description":"Team associated with the configuration","maxLength":128,"minLength":1,"title":"Team","type":"string","x-stream-index":"002"},"velocity_filter_config":{"$ref":"#/components/schemas/VelocityFilterConfig","description":"Configuration for velocity-based filtering","title":"Velocity Filter Config","x-stream-index":"012"},"video_call_rule_config":{"$ref":"#/components/schemas/VideoCallRuleConfig","x-stream-index":"016"}},"required":["key"],"type":"object"},"UpsertConfigResponse":{"nullable":true,"properties":{"config":{"$ref":"#/components/schemas/ConfigResponse","description":"The created or updated moderation configuration","title":"Config","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["duration"],"type":"object"},"User":{"properties":{"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"046"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"017"},"banned":{"type":"boolean","x-stream-index":"016"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"013"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"023"},"language":{"type":"string","x-stream-index":"035"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"026"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"042"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"005"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"009"}},"required":["id","role","teams_role","custom","banned","online"],"type":"object"},"UserCreatedWithinParameters":{"properties":{"max_age":{"type":"string","x-stream-index":"001"}},"type":"object"},"UserMute":{"nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"expires":{"description":"Date/time of mute expiration","format":"date-time","title":"Expires","type":"number","x-stream-index":"008"},"target":{"$ref":"#/components/schemas/User","description":"User who's muted","title":"Target","x-stream-index":"007"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/User","description":"Owner of channel mute","title":"User","x-stream-index":"005"}},"required":["created_at","updated_at"],"type":"object"},"UserRequest":{"description":"User request object","properties":{"custom":{"additionalProperties":{},"description":"Custom user data","title":"Custom","type":"object","x-stream-index":"004"},"id":{"description":"User ID","title":"ID","type":"string","x-stream-index":"001"},"image":{"description":"User's profile image URL","title":"Image","type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"006"},"language":{"type":"string","x-stream-index":"005"},"name":{"description":"Optional name of user","title":"Name","type":"string","x-stream-index":"002"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"007"}},"required":["id"],"title":"UserRequest","type":"object"},"UserResponse":{"description":"User response object","properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"banned":{"description":"Whether a user is banned or not","title":"Banned","type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.017"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"001.004"},"deactivated_at":{"description":"Date of deactivation","format":"date-time","title":"Deactivated at","type":"number","x-stream-index":"001.016"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"001.011"},"id":{"description":"Unique user identifier","title":"ID","type":"string","x-stream-index":"001.001"},"image":{"title":"Image","type":"string","x-stream-index":"001.003"},"language":{"description":"Preferred language of a user","title":"Language","type":"string","x-stream-index":"001.005"},"last_active":{"description":"Date of last activity","format":"date-time","title":"Last active","type":"number","x-stream-index":"001.014"},"name":{"description":"Optional name of user","title":"Name","type":"string","x-stream-index":"001.002"},"online":{"description":"Whether a user online or not","title":"Online","type":"boolean","x-stream-index":"001.013"},"revoke_tokens_issued_before":{"description":"Revocation date for tokens","format":"date-time","title":"Revoke tokens issued before","type":"number","x-stream-index":"001.015"},"role":{"description":"Determines the set of user permissions","title":"Role","type":"string","x-stream-index":"001.006"},"teams":{"description":"List of teams user is a part of","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids","shadow_banned","invisible"],"title":"UserResponse","type":"object"},"UserRuleParameters":{"properties":{"max_age":{"type":"string","x-stream-index":"001"}},"type":"object"},"VelocityFilterConfig":{"properties":{"advanced_filters":{"type":"boolean","x-stream-index":"007"},"async":{"type":"boolean","x-stream-index":"001"},"cascading_actions":{"type":"boolean","x-stream-index":"004"},"cids_per_user":{"format":"int32","type":"integer","x-stream-index":"006"},"enabled":{"type":"boolean","x-stream-index":"002"},"first_message_only":{"type":"boolean","x-stream-index":"005"},"rules":{"items":{"$ref":"#/components/schemas/VelocityFilterConfigRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules","cascading_actions","first_message_only","cids_per_user","advanced_filters"],"type":"object"},"VelocityFilterConfigRule":{"properties":{"action":{"enum":["flag","shadow","remove","ban"],"type":"string","x-stream-index":"001"},"ban_duration":{"format":"int32","type":"integer","x-stream-index":"002"},"cascading_action":{"enum":["flag","shadow","remove","ban"],"type":"string","x-stream-index":"006"},"cascading_threshold":{"format":"int64","type":"integer","x-stream-index":"005"},"check_message_context":{"type":"boolean","x-stream-index":"009"},"fast_spam_threshold":{"format":"int32","type":"integer","x-stream-index":"007"},"fast_spam_ttl":{"format":"int32","type":"integer","x-stream-index":"010"},"ip_ban":{"type":"boolean","x-stream-index":"004"},"probation_period":{"format":"int32","type":"integer","x-stream-index":"014"},"shadow_ban":{"type":"boolean","x-stream-index":"003"},"slow_spam_ban_duration":{"format":"int32","type":"integer","x-stream-index":"012"},"slow_spam_threshold":{"format":"int32","type":"integer","x-stream-index":"008"},"slow_spam_ttl":{"format":"int32","type":"integer","x-stream-index":"011"},"url_only":{"type":"boolean","x-stream-index":"013"}},"required":["action","ban_duration","shadow_ban","ip_ban","cascading_threshold","cascading_action","fast_spam_threshold","slow_spam_threshold","check_message_context","fast_spam_ttl","slow_spam_ttl","url_only","probation_period"],"type":"object"},"VideoCallRuleConfig":{"properties":{"rules":{"additionalProperties":{"$ref":"#/components/schemas/HarmConfig"},"type":"object","x-stream-index":"001"}},"required":["rules"],"type":"object"},"VideoContentParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"type":"object"},"VideoEndCallRequest":{"type":"object"},"VideoKickUserRequest":{"type":"object"},"VideoOrientation":{"properties":{"orientation":{"type":"integer","x-stream-index":"004"}},"type":"object"},"VideoRuleParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"required":["threshold","time_window"],"type":"object"},"VideoSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"camera_default_on":{"type":"boolean","x-stream-index":"004"},"camera_facing":{"enum":["front","back","external"],"type":"string","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled","target_resolution","camera_default_on","camera_facing"],"type":"object"},"VideoSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"camera_default_on":{"type":"boolean","x-stream-index":"004"},"camera_facing":{"enum":["front","back","external"],"type":"string","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled","target_resolution","camera_default_on","camera_facing"],"type":"object"},"WSEvent":{"description":"The discriminator object for all websocket events, it maps events' payload to the final type","discriminator":{"mapping":{"moderation.custom_action":"#/components/schemas/ModerationCustomActionEvent","moderation.flagged":"#/components/schemas/ModerationFlaggedEvent","moderation.mark_reviewed":"#/components/schemas/ModerationMarkReviewedEvent"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/ModerationCustomActionEvent"},{"$ref":"#/components/schemas/ModerationFlaggedEvent"},{"$ref":"#/components/schemas/ModerationMarkReviewedEvent"}]}},"securitySchemes":{"JWT":{"description":"JWT should be always provided when stream-auth-type=jwt.\n\nUsing JWT auth request could be authenticated as user or as server-side.\n\nWhen using user authentication permission checking is going to be applied to requests based on the user that is\nperforming a request.\n\nThe `authorization` header should be a JWT string signed using the secret attached to the API key used to perform\nrequests.\n\n**WARNING** all client-side official SDK do not ship with token generation; this is to make sure that the API secret is not\nshared with an untrusted party such as a browser or a iOS/Android application. Tokens **must** be generated server-side.\nIf you wish, you can configure your application to ignore authentication (see `disable_auth_check`)\nThe JWT string must include only the user_id claim and can include any built-in JWT claim such as iat, exp as well.\n","in":"header","name":"Authorization","type":"apiKey"},"api_key":{"description":"Application API key should be always set in order to authenticate the request.","in":"query","name":"api_key","type":"apiKey"},"stream-auth-type":{"description":"Stream-Auth-Type should be always set in order to authenticate the request. Possible\nvalues: `jwt` or `anonymous`.\n\n`jwt` allows you to authenticate as a user. With this auth type you should also provide valid JWT in Authorization\nheader.\n\n`anonymous` allows you to authenticate as anonymous user. Please note that most advanced features are not available\nto anonymous users.","in":"header","name":"Stream-Auth-Type","type":"apiKey"}}},"info":{"title":"Stream API","version":"v187.13.0"},"openapi":"3.0.3","paths":{"/api/v2/moderation/ban":{"post":{"description":"Ban a user from a channel or the entire app\n","operationId":"ban","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BanRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BanResponse"}}},"description":"Successful 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":"Ban","tags":["product:moderation"]}},"/api/v2/moderation/config":{"post":{"description":"Create a new moderation configuration or update an existing one. Configure settings for content filtering, AI analysis, toxicity detection, and other moderation features.\n","operationId":"upsert_config","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertConfigRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertConfigResponse"}}},"description":"Successful 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":"Create or update moderation configuration","tags":["product:moderation"]}},"/api/v2/moderation/config/{key}":{"delete":{"description":"Delete a specific moderation policy by its name\n","operationId":"delete_config","parameters":[{"in":"path","name":"key","required":true,"schema":{"description":"Key of the moderation configuration to delete","title":"Key","type":"string","x-stream-index":"001"}},{"in":"query","name":"team","schema":{"description":"Team associated with the configuration","title":"Team","type":"string","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteModerationConfigResponse"}}},"description":"Successful 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":"Delete a moderation policy","tags":["product:moderation"]},"get":{"description":"Retrieve a specific moderation configuration by its key and team. This configuration contains settings for various moderation features like toxicity detection, AI analysis, and filtering rules.\n","operationId":"get_config","parameters":[{"in":"path","name":"key","required":true,"schema":{"description":"Key of the moderation configuration to retrieve","title":"Key","type":"string","x-stream-index":"001"}},{"in":"query","name":"team","schema":{"description":"Team associated with the configuration","title":"Team","type":"string","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetConfigResponse"}}},"description":"Successful 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":"Get moderation configuration","tags":["product:moderation"]}},"/api/v2/moderation/configs":{"post":{"description":"Search and filter moderation configurations across your application. This endpoint is designed for building moderation dashboards and managing multiple configuration sets.\n","operationId":"query_moderation_configs","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationConfigsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationConfigsResponse"}}},"description":"Successful 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":"Query moderation configurations","tags":["product:moderation"]}},"/api/v2/moderation/flag":{"post":{"description":"Flag any type of content (messages, users, channels, activities) for moderation review. Supports custom content types and additional metadata for flagged content.\n","operationId":"flag","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlagRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlagResponse"}}},"description":"Successful 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":"Flag content for moderation","tags":["product:moderation"]}},"/api/v2/moderation/mute":{"post":{"description":"Mute a user. Mutes are generally not visible to the user you mute, while block is something you notice.\n","operationId":"mute","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteRequest"}}},"description":"MuteRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteResponse"}}},"description":"MuteResponse"},"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":"Mute","tags":["product:moderation"]}},"/api/v2/moderation/review_queue":{"post":{"description":"Query review queue items allows you to filter the review queue items. This is used for building a moderation dashboard.\n","operationId":"query_review_queue","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryReviewQueueRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryReviewQueueResponse"}}},"description":"Successful 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":"Query review queue items","tags":["product:moderation"]}},"/api/v2/moderation/submit_action":{"post":{"description":"Take action on flagged content, such as marking content as safe, deleting content, banning users, or executing custom moderation actions. Supports various action types with configurable parameters.\n","operationId":"submit_action","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitActionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitActionResponse"}}},"description":"Successful 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":"Submit moderation action","tags":["product:moderation"]}}},"security":[{"JWT":[],"api_key":[],"stream-auth-type":[]},{"api_key":[],"stream-auth-type":[]}],"servers":[{"description":"Stream API","url":"https://chat.stream-io-api.com"}]} \ No newline at end of file +{"components":{"schemas":{"AIImageConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"ocr_rules":{"items":{"$ref":"#/components/schemas/OCRRule"},"type":"array","x-stream-index":"004"},"rules":{"items":{"$ref":"#/components/schemas/AWSRekognitionRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules","ocr_rules"],"type":"object"},"AITextConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"profile":{"type":"string","x-stream-index":"003"},"rules":{"items":{"$ref":"#/components/schemas/BodyguardRule"},"type":"array","x-stream-index":"004"},"severity_rules":{"items":{"$ref":"#/components/schemas/BodyguardSeverityRule"},"type":"array","x-stream-index":"005"}},"required":["enabled","profile","rules","severity_rules"],"type":"object"},"AIVideoConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AWSRekognitionRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"APIError":{"nullable":true,"properties":{"StatusCode":{"description":"Response HTTP status code","format":"int32","title":"Status code","type":"integer","x-stream-index":"004"},"code":{"description":"API error code","format":"int32","title":"Code","type":"integer","x-stream-index":"001"},"details":{"description":"Additional error-specific information","items":{"type":"integer"},"title":"Details","type":"array","x-stream-index":"007"},"duration":{"description":"Request duration","title":"Duration","type":"string","x-stream-index":"005"},"exception_fields":{"additionalProperties":{"type":"string"},"description":"Additional error info","title":"Exception fields","type":"object","x-stream-index":"003"},"message":{"description":"Message describing an error","title":"Message","type":"string","x-stream-index":"002"},"more_info":{"description":"URL with additional information","title":"More info","type":"string","x-stream-index":"006"},"unrecoverable":{"description":"Flag that indicates if the error is unrecoverable, requests that return unrecoverable errors should not be retried, this error only applies to the request that caused it","title":"Unrecoverable","type":"boolean","x-stream-index":"008"}},"required":["code","message","StatusCode","duration","more_info","details"],"title":"Error response","type":"object"},"APNS":{"properties":{"body":{"type":"string","x-stream-index":"002"},"content-available":{"format":"int32","type":"integer","x-stream-index":"004"},"data":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"mutable-content":{"format":"int32","type":"integer","x-stream-index":"005"},"sound":{"type":"string","x-stream-index":"003"},"title":{"type":"string","x-stream-index":"001"}},"required":["title","body"],"type":"object"},"AWSRekognitionRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"},"min_confidence":{"format":"float","maximum":100,"minimum":0,"type":"number","x-stream-index":"003"}},"required":["label","action","min_confidence"],"type":"object"},"Action":{"nullable":true,"properties":{"name":{"type":"string","x-stream-index":"001"},"style":{"type":"string","x-stream-index":"003"},"text":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"004"},"value":{"type":"string","x-stream-index":"005"}},"required":["name","text","type"],"type":"object"},"ActionLog":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"002"},"reason":{"type":"string","x-stream-index":"008"},"reporter_type":{"type":"string","x-stream-index":"009"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"014"},"review_queue_item_id":{"type":"string","x-stream-index":"012"},"target_user":{"$ref":"#/components/schemas/User","x-stream-index":"013"},"target_user_id":{"type":"string","x-stream-index":"011"},"type":{"type":"string","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007"}},"required":["id","created_at","type","reason","reporter_type","custom","target_user_id","review_queue_item_id"],"type":"object"},"ActionLogResponse":{"nullable":true,"properties":{"created_at":{"description":"Timestamp when the action was taken","format":"date-time","title":"Created At","type":"number","x-stream-index":"002"},"custom":{"additionalProperties":{},"description":"Additional metadata about the action","title":"Custom","type":"object","x-stream-index":"007"},"id":{"description":"Unique identifier of the action log","title":"ID","type":"string","x-stream-index":"001"},"reason":{"description":"Reason for the moderation action","title":"Reason","type":"string","x-stream-index":"006"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"Associated review queue item","title":"Review Queue Item","x-stream-index":"008"},"target_user":{"$ref":"#/components/schemas/UserResponse","description":"User who was the target of the action","title":"Target User","x-stream-index":"009"},"target_user_id":{"description":"ID of the user who was the target of the action","title":"Target User ID","type":"string","x-stream-index":"010"},"type":{"description":"Type of moderation action","title":"Type","type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who performed the action","title":"User","x-stream-index":"004"},"user_id":{"description":"ID of the user who performed the action","title":"User ID","type":"string","x-stream-index":"005"}},"required":["id","created_at","type","user_id","reason","custom","target_user_id"],"type":"object"},"ActionSequence":{"properties":{"action":{"type":"string","x-stream-index":"001"},"blur":{"type":"boolean","x-stream-index":"005"},"cooldown_period":{"format":"int32","type":"integer","x-stream-index":"004"},"threshold":{"format":"int32","type":"integer","x-stream-index":"002"},"time_window":{"format":"int32","type":"integer","x-stream-index":"003"},"warning":{"type":"boolean","x-stream-index":"006"},"warning_text":{"type":"string","x-stream-index":"007"}},"required":["action","threshold","time_window","cooldown_period","blur","warning","warning_text"],"type":"object"},"Attachment":{"description":"An attachment is a message object that represents a file uploaded by a user.","nullable":true,"properties":{"actions":{"items":{"$ref":"#/components/schemas/Action"},"type":"array","x-stream-index":"015"},"asset_url":{"type":"string","x-stream-index":"017"},"author_icon":{"type":"string","x-stream-index":"007"},"author_link":{"type":"string","x-stream-index":"006"},"author_name":{"type":"string","x-stream-index":"005"},"color":{"type":"string","x-stream-index":"003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"018"},"fallback":{"type":"string","x-stream-index":"002"},"fields":{"items":{"$ref":"#/components/schemas/Field"},"type":"array","x-stream-index":"016"},"footer":{"type":"string","x-stream-index":"013"},"footer_icon":{"type":"string","x-stream-index":"014"},"giphy":{"$ref":"#/components/schemas/Images","x-stream-index":"019"},"image_url":{"type":"string","x-stream-index":"011"},"og_scrape_url":{"type":"string","x-stream-index":"020"},"original_height":{"format":"int32","type":"integer","x-stream-index":"022"},"original_width":{"format":"int32","type":"integer","x-stream-index":"021"},"pretext":{"type":"string","x-stream-index":"004"},"text":{"type":"string","x-stream-index":"010"},"thumb_url":{"type":"string","x-stream-index":"012"},"title":{"type":"string","x-stream-index":"008"},"title_link":{"type":"string","x-stream-index":"009"},"type":{"description":"Attachment type (e.g. image, video, url)","title":"Type","type":"string","x-stream-index":"001"}},"required":["custom"],"title":"Attachment","type":"object","x-stream-docs-page-id":"file_uploads"},"AudioSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"001"},"default_device":{"enum":["speaker","earpiece"],"type":"string","x-stream-index":"006"},"mic_default_on":{"type":"boolean","x-stream-index":"004"},"noise_cancellation":{"$ref":"#/components/schemas/NoiseCancellationSettings","x-stream-index":"007"},"opus_dtx_enabled":{"type":"boolean","x-stream-index":"002"},"redundant_coding_enabled":{"type":"boolean","x-stream-index":"003"},"speaker_default_on":{"type":"boolean","x-stream-index":"005"}},"required":["access_request_enabled","opus_dtx_enabled","redundant_coding_enabled","mic_default_on","speaker_default_on","default_device"],"type":"object"},"AudioSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"001"},"default_device":{"enum":["speaker","earpiece"],"type":"string","x-stream-index":"006"},"mic_default_on":{"type":"boolean","x-stream-index":"004"},"noise_cancellation":{"$ref":"#/components/schemas/NoiseCancellationSettings","x-stream-index":"007"},"opus_dtx_enabled":{"type":"boolean","x-stream-index":"002"},"redundant_coding_enabled":{"type":"boolean","x-stream-index":"003"},"speaker_default_on":{"type":"boolean","x-stream-index":"005"}},"required":["access_request_enabled","opus_dtx_enabled","redundant_coding_enabled","mic_default_on","speaker_default_on","default_device"],"type":"object"},"AutomodPlatformCircumventionConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AutomodRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"AutomodRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"003"},"label":{"type":"string","x-stream-index":"001"},"threshold":{"format":"float","maximum":1,"minimum":0,"type":"number","x-stream-index":"002"}},"required":["label","threshold","action"],"type":"object"},"AutomodSemanticFiltersConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AutomodSemanticFiltersRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"AutomodSemanticFiltersRule":{"properties":{"action":{"enum":["flag","shadow","remove"],"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"threshold":{"format":"float","maximum":1,"minimum":0,"type":"number","x-stream-index":"002"}},"required":["name","threshold","action"],"type":"object"},"AutomodToxicityConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AutomodRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"BackstageSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"BackstageSettingsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"Ban":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"012"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"011"},"expires":{"format":"date-time","type":"number","x-stream-index":"007"},"reason":{"type":"string","x-stream-index":"008"},"shadow":{"type":"boolean","x-stream-index":"009"},"target":{"$ref":"#/components/schemas/User","x-stream-index":"006"}},"required":["shadow","created_at"],"type":"object"},"BanActionRequest":{"properties":{"channel_ban_only":{"type":"boolean","x-stream-index":"003"},"delete_messages":{"enum":["soft","pruning","hard"],"type":"string","x-stream-index":"005"},"ip_ban":{"type":"boolean","x-stream-index":"004"},"reason":{"type":"string","x-stream-index":"002"},"shadow":{"type":"boolean","x-stream-index":"001"},"timeout":{"format":"int32","type":"integer","x-stream-index":"006"}},"type":"object"},"BanOptions":{"properties":{"duration":{"format":"int32","type":"integer","x-stream-index":"001"},"ip_ban":{"type":"boolean","x-stream-index":"004"},"reason":{"type":"string","x-stream-index":"002"},"shadow_ban":{"type":"boolean","x-stream-index":"003"}},"type":"object"},"BanRequest":{"nullable":true,"properties":{"banned_by":{"$ref":"#/components/schemas/UserRequest","description":"Details about the user performing the ban","title":"Banned By","x-stream-index":"008"},"banned_by_id":{"description":"ID of the user performing the ban","title":"Banned By ID","type":"string","x-stream-index":"007"},"channel_cid":{"description":"Channel where the ban applies","title":"Channel CID","type":"string","x-stream-index":"004"},"delete_messages":{"enum":["soft","pruning","hard"],"type":"string","x-stream-index":"009"},"ip_ban":{"description":"Whether to ban the user's IP address","title":"IP Ban","type":"boolean","x-stream-index":"006"},"reason":{"description":"Optional explanation for the ban","title":"Reason","type":"string","x-stream-index":"003"},"shadow":{"description":"Whether this is a shadow ban","title":"Shadow","type":"boolean","x-stream-index":"005"},"target_user_id":{"description":"ID of the user to ban","title":"Target User ID","type":"string","x-stream-index":"001"},"timeout":{"description":"Duration of the ban in minutes","minimum":0,"title":"Timeout","type":"integer","x-stream-index":"002"}},"required":["target_user_id"],"type":"object"},"BanResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"BlockContentOptions":{"properties":{"reason":{"type":"string","x-stream-index":"001"}},"type":"object"},"BlockListConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/BlockListRule"},"maximum":10,"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"BlockListOptions":{"properties":{"behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"002"},"blocklist":{"type":"string","x-stream-index":"001"}},"required":["blocklist","behavior"],"type":"object"},"BlockListRule":{"properties":{"action":{"enum":["flag","mask_flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"002"}},"required":["name","team","action"],"type":"object"},"BodyguardRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"},"severity_rules":{"items":{"$ref":"#/components/schemas/BodyguardSeverityRule"},"type":"array","x-stream-index":"003"}},"required":["label","action","severity_rules"],"type":"object"},"BodyguardSeverityRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"severity":{"enum":["low","medium","high","critical"],"type":"string","x-stream-index":"001"}},"required":["severity","action"],"type":"object"},"BroadcastSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettings","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettings","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"BroadcastSettingsResponse":{"description":"BroadcastSettingsResponse is the payload for broadcasting settings","properties":{"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettingsResponse","title":"HLS","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettingsResponse","title":"RTMP","x-stream-index":"003"}},"required":["enabled","hls","rtmp"],"title":"BroadcastSettingsResponse","type":"object"},"Call":{"properties":{"AppPK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"002"},"Backstage":{"type":"boolean","writeOnly":true,"x-stream-index":"023"},"BlockedUserIDs":{"items":{"type":"string"},"type":"array","writeOnly":true,"x-stream-index":"018"},"BlockedUsers":{"items":{"$ref":"#/components/schemas/User"},"type":"array","writeOnly":true,"x-stream-index":"019"},"CID":{"type":"string","writeOnly":true,"x-stream-index":"005"},"CallType":{"$ref":"#/components/schemas/CallType","x-stream-index":"020"},"ChannelCID":{"type":"string","writeOnly":true,"x-stream-index":"032"},"CreatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"013"},"CreatedBy":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"CreatedByUserID":{"type":"string","writeOnly":true,"x-stream-index":"007"},"CurrentSessionID":{"type":"string","writeOnly":true,"x-stream-index":"024"},"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"012"},"DeletedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"028"},"EgressUpdatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"027"},"Egresses":{"items":{"$ref":"#/components/schemas/CallEgress"},"type":"array","writeOnly":true,"x-stream-index":"015"},"EndedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"017"},"ID":{"type":"string","writeOnly":true,"x-stream-index":"004"},"JoinAheadTimeSeconds":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"031"},"LastHeartbeatAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"030"},"LastSessionID":{"type":"string","writeOnly":true,"x-stream-index":"025"},"MemberCount":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"010"},"MemberLookup":{"$ref":"#/components/schemas/MemberLookup","x-stream-index":"011"},"Members":{"items":{"$ref":"#/components/schemas/CallMember"},"type":"array","writeOnly":true,"x-stream-index":"009"},"Session":{"$ref":"#/components/schemas/CallSession","x-stream-index":"026"},"Settings":{"$ref":"#/components/schemas/CallSettings","x-stream-index":"022"},"SettingsOverrides":{"$ref":"#/components/schemas/CallSettings","x-stream-index":"021"},"StartsAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"016"},"Team":{"type":"string","writeOnly":true,"x-stream-index":"006"},"ThumbnailURL":{"type":"string","writeOnly":true,"x-stream-index":"029"},"Type":{"type":"string","writeOnly":true,"x-stream-index":"003"},"UpdatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"014"}},"required":["AppPK","Type","ID","CID","Team","CreatedByUserID","Members","Custom","CreatedAt","UpdatedAt","Egresses","BlockedUserIDs","BlockedUsers","Backstage","CurrentSessionID","LastSessionID","ThumbnailURL","ChannelCID"],"type":"object"},"CallEgress":{"nullable":true,"properties":{"app_pk":{"format":"int32","type":"integer","x-stream-index":"002"},"call_id":{"type":"string","x-stream-index":"004"},"call_type":{"type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/EgressTaskConfig","x-stream-index":"007"},"egress_id":{"type":"string","x-stream-index":"005"},"egress_type":{"type":"string","x-stream-index":"006"},"instance_ip":{"type":"string","x-stream-index":"008"},"started_at":{"format":"date-time","type":"number","x-stream-index":"010"},"state":{"type":"string","x-stream-index":"009"},"stopped_at":{"format":"date-time","type":"number","x-stream-index":"011"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"012"}},"required":["app_pk","call_type","call_id","egress_id","egress_type","instance_ip","state","started_at","updated_at"],"type":"object"},"CallIngressResponse":{"description":"CallIngressResponse is the payload for ingress settings","properties":{"rtmp":{"$ref":"#/components/schemas/RTMPIngress","title":"RTMP","x-stream-index":"001"}},"required":["rtmp"],"title":"CallIngressResponse","type":"object"},"CallMember":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"010"},"role":{"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["user_id","role","custom","created_at","updated_at"],"type":"object"},"CallParticipant":{"nullable":true,"properties":{"JoinedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"004"},"Role":{"type":"string","writeOnly":true,"x-stream-index":"002"},"UserSessionID":{"type":"string","writeOnly":true,"x-stream-index":"003"},"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"001.046"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"001.017"},"banned":{"type":"boolean","x-stream-index":"001.016"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.013"},"id":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"001.023"},"language":{"type":"string","x-stream-index":"001.035"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"001.022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"001.026"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.042"},"role":{"type":"string","x-stream-index":"001.004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.005"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.009"}},"required":["id","role","teams_role","custom","banned","online","Role","UserSessionID","JoinedAt"],"type":"object"},"CallParticipantResponse":{"properties":{"joined_at":{"format":"date-time","type":"number","x-stream-index":"004"},"role":{"type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"},"user_session_id":{"type":"string","x-stream-index":"002"}},"required":["user","user_session_id","role","joined_at"],"type":"object"},"CallResponse":{"description":"Represents a call","properties":{"backstage":{"type":"boolean","x-stream-index":"016"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"018"},"captioning":{"type":"boolean","x-stream-index":"013"},"channel_cid":{"type":"string","x-stream-index":"024"},"cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"The user that created the call","title":"Created By","x-stream-index":"007"},"current_session_id":{"type":"string","x-stream-index":"005"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"008"},"egress":{"$ref":"#/components/schemas/EgressResponse","x-stream-index":"021"},"ended_at":{"description":"Date/time when the call ended","format":"date-time","title":"Ended At","type":"number","x-stream-index":"014"},"id":{"description":"Call ID","title":"ID","type":"string","x-stream-index":"003"},"ingress":{"$ref":"#/components/schemas/CallIngressResponse","x-stream-index":"019"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"023"},"recording":{"type":"boolean","x-stream-index":"011"},"session":{"$ref":"#/components/schemas/CallSessionResponse","x-stream-index":"020"},"settings":{"$ref":"#/components/schemas/CallSettingsResponse","x-stream-index":"017"},"starts_at":{"description":"Date/time when the call will start","format":"date-time","title":"Starts At","type":"number","x-stream-index":"015"},"team":{"type":"string","x-stream-index":"006"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailResponse","x-stream-index":"022"},"transcribing":{"type":"boolean","x-stream-index":"012"},"type":{"description":"The type of call","title":"Type","type":"string","x-stream-index":"002"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"}},"required":["type","id","cid","current_session_id","created_by","custom","created_at","updated_at","recording","transcribing","captioning","backstage","settings","blocked_user_ids","ingress","egress"],"title":"CallResponse","type":"object"},"CallSession":{"properties":{"AcceptedBy":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","writeOnly":true,"x-stream-index":"008"},"ActiveSFUs":{"items":{"$ref":"#/components/schemas/SFUIDLastSeen"},"type":"array","writeOnly":true,"x-stream-index":"016"},"AnonymousParticipantCount":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"019"},"AppPK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"002.001"},"CallID":{"type":"string","writeOnly":true,"x-stream-index":"002.003"},"CallType":{"type":"string","writeOnly":true,"x-stream-index":"002.002"},"CreatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"003"},"DeletedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"004"},"EndedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"006"},"LiveEndedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"013"},"LiveStartedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"012"},"MissedBy":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","writeOnly":true,"x-stream-index":"010"},"Participants":{"items":{"$ref":"#/components/schemas/CallParticipant"},"type":"array","writeOnly":true,"x-stream-index":"011"},"ParticipantsCountByRole":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","writeOnly":true,"x-stream-index":"018"},"RejectedBy":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","writeOnly":true,"x-stream-index":"009"},"RingAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"007"},"SFUIDs":{"items":{"type":"string"},"type":"array","writeOnly":true,"x-stream-index":"015"},"SessionID":{"type":"string","writeOnly":true,"x-stream-index":"002.004"},"StartedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"005"},"TimerEndsAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"014"},"UserPermissionOverrides":{"additionalProperties":{"additionalProperties":{"type":"boolean"},"type":"object"},"type":"object","writeOnly":true,"x-stream-index":"017"}},"required":["AppPK","CallType","CallID","SessionID","CreatedAt","AcceptedBy","RejectedBy","MissedBy","Participants","SFUIDs","ActiveSFUs","UserPermissionOverrides","ParticipantsCountByRole","AnonymousParticipantCount"],"type":"object"},"CallSessionResponse":{"properties":{"accepted_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"008"},"anonymous_participant_count":{"format":"int32","type":"integer","x-stream-index":"006"},"ended_at":{"format":"date-time","type":"number","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"live_ended_at":{"format":"date-time","type":"number","x-stream-index":"011"},"live_started_at":{"format":"date-time","type":"number","x-stream-index":"010"},"missed_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"009"},"participants":{"items":{"$ref":"#/components/schemas/CallParticipantResponse"},"type":"array","x-stream-index":"004"},"participants_count_by_role":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"005"},"rejected_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"007"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002"},"timer_ends_at":{"format":"date-time","type":"number","x-stream-index":"012"}},"required":["id","participants","participants_count_by_role","anonymous_participant_count","rejected_by","accepted_by","missed_by"],"type":"object"},"CallSettings":{"properties":{"audio":{"$ref":"#/components/schemas/AudioSettings","x-stream-index":"001"},"backstage":{"$ref":"#/components/schemas/BackstageSettings","x-stream-index":"002"},"broadcasting":{"$ref":"#/components/schemas/BroadcastSettings","x-stream-index":"007"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordSettings","x-stream-index":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettings","x-stream-index":"008"},"ingress":{"$ref":"#/components/schemas/IngressSettings","x-stream-index":"014"},"limits":{"$ref":"#/components/schemas/LimitsSettings","x-stream-index":"012"},"recording":{"$ref":"#/components/schemas/RecordSettings","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettings","x-stream-index":"010"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettings","x-stream-index":"004"},"session":{"$ref":"#/components/schemas/SessionSettings","x-stream-index":"013"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettings","x-stream-index":"011"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettings","x-stream-index":"009"},"video":{"$ref":"#/components/schemas/VideoSettings","x-stream-index":"003"}},"type":"object"},"CallSettingsResponse":{"properties":{"audio":{"$ref":"#/components/schemas/AudioSettingsResponse","x-stream-index":"001"},"backstage":{"$ref":"#/components/schemas/BackstageSettingsResponse","x-stream-index":"002"},"broadcasting":{"$ref":"#/components/schemas/BroadcastSettingsResponse","x-stream-index":"003"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordingSettingsResponse","x-stream-index":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettingsResponse","x-stream-index":"004"},"ingress":{"$ref":"#/components/schemas/IngressSettingsResponse","x-stream-index":"014"},"limits":{"$ref":"#/components/schemas/LimitsSettingsResponse","x-stream-index":"012"},"recording":{"$ref":"#/components/schemas/RecordSettingsResponse","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettingsResponse","x-stream-index":"007"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettingsResponse","x-stream-index":"008"},"session":{"$ref":"#/components/schemas/SessionSettingsResponse","x-stream-index":"013"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettingsResponse","x-stream-index":"011"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettingsResponse","x-stream-index":"009"},"video":{"$ref":"#/components/schemas/VideoSettingsResponse","x-stream-index":"010"}},"required":["audio","backstage","broadcasting","geofencing","recording","frame_recording","ring","screensharing","transcription","video","thumbnails","limits","session"],"type":"object"},"CallType":{"properties":{"AppPK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"003"},"CreatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"005"},"ExternalStorage":{"type":"string","writeOnly":true,"x-stream-index":"009"},"Name":{"type":"string","writeOnly":true,"x-stream-index":"004"},"NotificationSettings":{"$ref":"#/components/schemas/NotificationSettings","x-stream-index":"008"},"PK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"002"},"Settings":{"$ref":"#/components/schemas/CallSettings","x-stream-index":"007"},"UpdatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"006"}},"required":["PK","AppPK","Name","CreatedAt","UpdatedAt","ExternalStorage"],"type":"object"},"Channel":{"properties":{"active_live_locations":{"items":{"$ref":"#/components/schemas/SharedLocation"},"type":"array","x-stream-index":"034"},"auto_translation_enabled":{"type":"boolean","x-stream-index":"029"},"auto_translation_language":{"type":"string","x-stream-index":"030"},"cid":{"type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/ChannelConfig","x-stream-index":"026"},"config_overrides":{"$ref":"#/components/schemas/ConfigOverrides","x-stream-index":"027"},"cooldown":{"format":"int32","type":"integer","x-stream-index":"031"},"created_at":{"format":"date-time","type":"number","x-stream-index":"009"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"019"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"disabled":{"type":"boolean","x-stream-index":"017"},"frozen":{"type":"boolean","x-stream-index":"016"},"id":{"type":"string","x-stream-index":"004"},"invites":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"022"},"last_campaigns":{"type":"string","x-stream-index":"032"},"last_message_at":{"format":"date-time","type":"number","x-stream-index":"006"},"member_count":{"format":"int32","type":"integer","x-stream-index":"021"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"020"},"message_count":{"format":"int64","type":"integer","x-stream-index":"035"},"message_count_updated_at":{"format":"date-time","type":"number","x-stream-index":"036"},"team":{"type":"string","x-stream-index":"028"},"truncated_by":{"$ref":"#/components/schemas/User","x-stream-index":"015"},"type":{"type":"string","x-stream-index":"005"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"010"}},"required":["cid","id","type","created_at","updated_at","frozen","disabled","custom","auto_translation_language"],"type":"object"},"ChannelConfig":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.027"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.022"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.023"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.028"},"blocklist":{"type":"string","x-stream-index":"001.024"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.025"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.026"},"commands":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"connect_events":{"type":"boolean","x-stream-index":"001.004"},"count_messages":{"type":"boolean","x-stream-index":"001.019"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"custom_events":{"type":"boolean","x-stream-index":"001.012"},"mark_messages_pending":{"type":"boolean","x-stream-index":"001.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"001.021"},"mutes":{"type":"boolean","x-stream-index":"001.009"},"name":{"type":"string","x-stream-index":"001.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"001.029"},"partition_ttl":{"type":"integer","x-stream-index":"001.030"},"polls":{"type":"boolean","x-stream-index":"001.016"},"push_notifications":{"type":"boolean","x-stream-index":"001.013"},"quotes":{"type":"boolean","x-stream-index":"001.008"},"reactions":{"type":"boolean","x-stream-index":"001.006"},"read_events":{"type":"boolean","x-stream-index":"001.003"},"reminders":{"type":"boolean","x-stream-index":"001.014"},"replies":{"type":"boolean","x-stream-index":"001.007"},"search":{"type":"boolean","x-stream-index":"001.005"},"shared_locations":{"type":"boolean","x-stream-index":"001.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.031"},"typing_events":{"type":"boolean","x-stream-index":"001.002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"002.004"},"uploads":{"type":"boolean","x-stream-index":"001.010"},"url_enrichment":{"type":"boolean","x-stream-index":"001.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"001.017"}},"required":["name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","count_messages","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","created_at","updated_at","commands"],"type":"object"},"ChannelConfigWithInfo":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.002.027"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.002.022"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.023"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.002.028"},"blocklist":{"type":"string","x-stream-index":"001.002.024"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.025"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.002.026"},"commands":{"items":{"$ref":"#/components/schemas/Command"},"type":"array","x-stream-index":"001.003"},"connect_events":{"type":"boolean","x-stream-index":"001.002.004"},"count_messages":{"type":"boolean","x-stream-index":"001.002.019"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.001.003"},"custom_events":{"type":"boolean","x-stream-index":"001.002.012"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"002"},"mark_messages_pending":{"type":"boolean","x-stream-index":"001.002.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"001.002.021"},"mutes":{"type":"boolean","x-stream-index":"001.002.009"},"name":{"type":"string","x-stream-index":"001.002.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"001.002.029"},"partition_ttl":{"type":"integer","x-stream-index":"001.002.030"},"polls":{"type":"boolean","x-stream-index":"001.002.016"},"push_notifications":{"type":"boolean","x-stream-index":"001.002.013"},"quotes":{"type":"boolean","x-stream-index":"001.002.008"},"reactions":{"type":"boolean","x-stream-index":"001.002.006"},"read_events":{"type":"boolean","x-stream-index":"001.002.003"},"reminders":{"type":"boolean","x-stream-index":"001.002.014"},"replies":{"type":"boolean","x-stream-index":"001.002.007"},"search":{"type":"boolean","x-stream-index":"001.002.005"},"shared_locations":{"type":"boolean","x-stream-index":"001.002.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.002.031"},"typing_events":{"type":"boolean","x-stream-index":"001.002.002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"uploads":{"type":"boolean","x-stream-index":"001.002.010"},"url_enrichment":{"type":"boolean","x-stream-index":"001.002.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"001.002.017"}},"required":["created_at","updated_at","name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","count_messages","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","commands"],"type":"object"},"ChannelMember":{"nullable":true,"properties":{"archived_at":{"format":"date-time","type":"number","x-stream-index":"021"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"017"},"banned":{"type":"boolean","x-stream-index":"016"},"channel_role":{"type":"string","x-stream-index":"024"},"created_at":{"format":"date-time","type":"number","x-stream-index":"012"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"014"},"deleted_messages":{"items":{"type":"string"},"type":"array","x-stream-index":"027"},"invite_accepted_at":{"format":"date-time","type":"number","x-stream-index":"009"},"invite_rejected_at":{"format":"date-time","type":"number","x-stream-index":"010"},"invited":{"type":"boolean","x-stream-index":"008"},"is_global_banned":{"type":"boolean","x-stream-index":"020"},"is_moderator":{"type":"boolean","x-stream-index":"007"},"notifications_muted":{"type":"boolean","x-stream-index":"026"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"022"},"shadow_banned":{"type":"boolean","x-stream-index":"019"},"status":{"type":"string","x-stream-index":"011"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"013"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["custom","created_at","updated_at","banned","shadow_banned","is_global_banned","channel_role","notifications_muted"],"type":"object"},"ChannelMute":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"007"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"expires":{"description":"Date/time of mute expiration","format":"date-time","title":"Expires","type":"number","x-stream-index":"008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/User","description":"Owner of channel mute","title":"User","x-stream-index":"005"}},"required":["created_at","updated_at"],"type":"object"},"ChannelResponse":{"properties":{"auto_translation_enabled":{"type":"boolean","x-stream-index":"021"},"auto_translation_language":{"type":"string","x-stream-index":"022"},"blocked":{"type":"boolean","x-stream-index":"027"},"cid":{"type":"string","x-stream-index":"005"},"config":{"$ref":"#/components/schemas/ChannelConfigWithInfo","x-stream-index":"017"},"cooldown":{"format":"int32","type":"integer","x-stream-index":"024"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"011"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"030"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"010"},"disabled":{"type":"boolean","x-stream-index":"013"},"frozen":{"type":"boolean","x-stream-index":"012"},"hidden":{"type":"boolean","x-stream-index":"026"},"hide_messages_before":{"format":"date-time","type":"number","x-stream-index":"023"},"id":{"type":"string","x-stream-index":"003"},"last_message_at":{"format":"date-time","type":"number","x-stream-index":"006"},"member_count":{"format":"int32","type":"integer","x-stream-index":"015"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"014"},"message_count":{"format":"int64","type":"integer","x-stream-index":"031"},"mute_expires_at":{"format":"date-time","type":"number","x-stream-index":"019"},"muted":{"type":"boolean","x-stream-index":"018"},"own_capabilities":{"items":{"type":"string"},"type":"array","x-stream-index":"025"},"team":{"type":"string","x-stream-index":"020"},"truncated_at":{"format":"date-time","type":"number","x-stream-index":"028"},"truncated_by":{"$ref":"#/components/schemas/User","x-stream-index":"029"},"type":{"type":"string","x-stream-index":"004"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"}},"required":["id","type","cid","created_at","updated_at","frozen","disabled","custom"],"type":"object"},"Command":{"description":"Represents custom chat command","nullable":true,"properties":{"args":{"description":"Arguments help text, shown in commands auto-completion","title":"Arguments","type":"string","x-stream-index":"006"},"created_at":{"description":"Date/time of creation","format":"date-time","readOnly":true,"title":"Created at","type":"number","x-stream-index":"001"},"description":{"description":"Description, shown in commands auto-completion","title":"Description","type":"string","x-stream-index":"005"},"name":{"description":"Unique command name","title":"Name","type":"string","x-stream-index":"004"},"set":{"description":"Set name used for grouping commands","title":"Set","type":"string","x-stream-index":"007"},"updated_at":{"description":"Date/time of the last update","format":"date-time","readOnly":true,"title":"Updated at","type":"number","x-stream-index":"002"}},"required":["name","description","args","set"],"title":"Command","type":"object"},"CompositeAppSettings":{"properties":{"json_encoded_settings":{"type":"string","x-stream-index":"005"},"url":{"type":"string","x-stream-index":"004"}},"type":"object"},"ConfigOverrides":{"properties":{"blocklist":{"type":"string","x-stream-index":"008"},"blocklist_behavior":{"enum":["flag","block"],"type":"string","x-stream-index":"009"},"commands":{"items":{"type":"string"},"type":"array","x-stream-index":"011"},"count_messages":{"type":"boolean","x-stream-index":"014"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"010"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"007"},"quotes":{"type":"boolean","x-stream-index":"004"},"reactions":{"type":"boolean","x-stream-index":"002"},"replies":{"type":"boolean","x-stream-index":"003"},"shared_locations":{"type":"boolean","x-stream-index":"013"},"typing_events":{"type":"boolean","x-stream-index":"001"},"uploads":{"type":"boolean","x-stream-index":"005"},"url_enrichment":{"type":"boolean","x-stream-index":"006"},"user_message_reminders":{"type":"boolean","x-stream-index":"012"}},"required":["grants","commands"],"type":"object"},"ConfigResponse":{"properties":{"ai_image_config":{"$ref":"#/components/schemas/AIImageConfig","description":"Configuration for AI image analysis","title":"AI Image Config","x-stream-index":"010"},"ai_text_config":{"$ref":"#/components/schemas/AITextConfig","description":"Configuration for AI text analysis","title":"AI Text Config","x-stream-index":"008"},"ai_video_config":{"$ref":"#/components/schemas/AIVideoConfig","description":"Configuration for AI video analysis","title":"AI Video Config","x-stream-index":"011"},"async":{"description":"Whether moderation should be performed asynchronously","title":"Async","type":"boolean","x-stream-index":"003"},"automod_platform_circumvention_config":{"$ref":"#/components/schemas/AutomodPlatformCircumventionConfig","description":"Configuration for platform circumvention detection","title":"Automod Platform Circumvention Config","x-stream-index":"005"},"automod_semantic_filters_config":{"$ref":"#/components/schemas/AutomodSemanticFiltersConfig","description":"Configuration for semantic filtering","title":"Automod Semantic Filters Config","x-stream-index":"006"},"automod_toxicity_config":{"$ref":"#/components/schemas/AutomodToxicityConfig","description":"Configuration for toxicity detection","title":"Automod Toxicity Config","x-stream-index":"004"},"block_list_config":{"$ref":"#/components/schemas/BlockListConfig","description":"Configuration for block list filtering","title":"Block List Config","x-stream-index":"007"},"created_at":{"description":"When the configuration was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"013"},"key":{"description":"Unique identifier for the moderation configuration","title":"Key","type":"string","x-stream-index":"001"},"llm_config":{"$ref":"#/components/schemas/LLMConfig","description":"Configuration for customer-configured LLM moderation","title":"LLM Config","x-stream-index":"009"},"team":{"description":"Team associated with the configuration","title":"Team","type":"string","x-stream-index":"002"},"updated_at":{"description":"When the configuration was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"014"},"velocity_filter_config":{"$ref":"#/components/schemas/VelocityFilterConfig","description":"Configuration for velocity-based filtering","title":"Velocity Filter Config","x-stream-index":"012"},"video_call_rule_config":{"$ref":"#/components/schemas/VideoCallRuleConfig","x-stream-index":"015"}},"required":["key","team","async","created_at","updated_at"],"type":"object"},"ContentCountRuleParameters":{"properties":{"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"type":"object"},"CustomActionRequest":{"properties":{"id":{"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"type":"object"},"Data":{"properties":{"id":{"type":"string","x-stream-index":"001"}},"required":["id"],"type":"object"},"DeleteActivityRequest":{"properties":{"hard_delete":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"DeleteMessageRequest":{"properties":{"hard_delete":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"DeleteModerationConfigResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"DeleteReactionRequest":{"properties":{"hard_delete":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"DeleteUserRequest":{"properties":{"delete_conversation_channels":{"type":"boolean","x-stream-index":"003"},"delete_feeds_content":{"type":"boolean","x-stream-index":"004"},"hard_delete":{"type":"boolean","x-stream-index":"001"},"mark_messages_deleted":{"type":"boolean","x-stream-index":"002"}},"type":"object"},"Device":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"disabled":{"type":"boolean","x-stream-index":"002.003"},"disabled_reason":{"type":"string","x-stream-index":"002.004"},"id":{"type":"string","x-stream-index":"002.001.004"},"push_provider":{"enum":["firebase","apn","huawei","xiaomi"],"type":"string","x-stream-index":"002.001.001"},"push_provider_name":{"type":"string","x-stream-index":"002.001.003"},"user_id":{"type":"string","x-stream-index":"004"},"voip":{"type":"boolean","x-stream-index":"002.001.005"}},"required":["push_provider","id","created_at","user_id"],"type":"object"},"DraftPayloadResponse":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"html":{"type":"string","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"001"},"mentioned_users":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"008"},"mml":{"type":"string","x-stream-index":"003"},"parent_id":{"type":"string","x-stream-index":"005"},"poll_id":{"type":"string","x-stream-index":"013"},"quoted_message_id":{"type":"string","x-stream-index":"009"},"show_in_channel":{"type":"boolean","x-stream-index":"006"},"silent":{"type":"boolean","x-stream-index":"012"},"text":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"011"}},"required":["id","text","custom"],"type":"object"},"DraftResponse":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003"},"channel_cid":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"message":{"$ref":"#/components/schemas/DraftPayloadResponse","x-stream-index":"001"},"parent_id":{"type":"string","x-stream-index":"004"},"parent_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"005"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"006"}},"required":["message","channel_cid","created_at"],"type":"object"},"EgressHLSResponse":{"properties":{"playlist_url":{"type":"string","x-stream-index":"001"},"status":{"type":"string","x-stream-index":"002"}},"required":["playlist_url","status"],"type":"object"},"EgressRTMPResponse":{"properties":{"name":{"type":"string","x-stream-index":"001"},"started_at":{"format":"date-time","type":"number","x-stream-index":"004"},"stream_key":{"type":"string","x-stream-index":"003"},"stream_url":{"type":"string","x-stream-index":"002"}},"required":["name","started_at"],"type":"object"},"EgressResponse":{"properties":{"broadcasting":{"type":"boolean","x-stream-index":"001"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordingResponse","x-stream-index":"004"},"hls":{"$ref":"#/components/schemas/EgressHLSResponse","x-stream-index":"002"},"rtmps":{"items":{"$ref":"#/components/schemas/EgressRTMPResponse"},"type":"array","x-stream-index":"003"}},"required":["broadcasting","rtmps"],"type":"object"},"EgressTaskConfig":{"properties":{"egress_user":{"$ref":"#/components/schemas/EgressUser","x-stream-index":"008"},"frame_recording_egress_config":{"$ref":"#/components/schemas/FrameRecordingEgressConfig","x-stream-index":"009"},"hls_egress_config":{"$ref":"#/components/schemas/HLSEgressConfig","x-stream-index":"007"},"recording_egress_config":{"$ref":"#/components/schemas/RecordingEgressConfig","x-stream-index":"006"},"rtmp_egress_config":{"$ref":"#/components/schemas/RTMPEgressConfig","x-stream-index":"004"},"stt_egress_config":{"$ref":"#/components/schemas/STTEgressConfig","x-stream-index":"005"}},"type":"object"},"EgressUser":{"properties":{"token":{"type":"string","x-stream-index":"004"}},"type":"object"},"EnrichedActivity":{"properties":{"actor":{"$ref":"#/components/schemas/Data","x-stream-index":"002"},"foreign_id":{"type":"string","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"latest_reactions":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"013"},"object":{"$ref":"#/components/schemas/Data","x-stream-index":"004"},"origin":{"$ref":"#/components/schemas/Data","x-stream-index":"008"},"own_reactions":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"012"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"011"},"score":{"format":"float","type":"number","x-stream-index":"010"},"target":{"$ref":"#/components/schemas/Data","x-stream-index":"006"},"to":{"items":{"type":"string"},"type":"array","x-stream-index":"009"},"verb":{"type":"string","x-stream-index":"003"}},"type":"object"},"EnrichedReaction":{"nullable":true,"properties":{"activity_id":{"type":"string","x-stream-index":"003"},"children_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"010"},"created_at":{"$ref":"#/components/schemas/Time","x-stream-index":"012"},"data":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"kind":{"type":"string","x-stream-index":"002"},"latest_children":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"008"},"own_children":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"009"},"parent":{"type":"string","x-stream-index":"007"},"target_feeds":{"items":{"type":"string"},"type":"array","x-stream-index":"006"},"updated_at":{"$ref":"#/components/schemas/Time","x-stream-index":"013"},"user":{"$ref":"#/components/schemas/Data","x-stream-index":"011"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["kind","activity_id","user_id"],"type":"object"},"EntityCreator":{"properties":{"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"001.046"},"ban_count":{"format":"int32","type":"integer","x-stream-index":"002"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"001.017"},"banned":{"type":"boolean","x-stream-index":"001.016"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.013"},"deleted_content_count":{"format":"int32","type":"integer","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"001.023"},"language":{"type":"string","x-stream-index":"001.035"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"001.022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"001.026"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.042"},"role":{"type":"string","x-stream-index":"001.004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.005"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.009"}},"required":["id","role","teams_role","custom","banned","online","ban_count","deleted_content_count"],"type":"object"},"EntityCreatorResponse":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.001.018"},"ban_count":{"description":"Number of minor actions performed on the user","format":"int32","title":"Ban Count","type":"integer","x-stream-index":"002"},"banned":{"type":"boolean","x-stream-index":"001.001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.001.017"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.001.016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.001.011"},"deleted_content_count":{"description":"Number of major actions performed on the user","format":"int32","title":"Deleted Content Count","type":"integer","x-stream-index":"003"},"flagged_count":{"description":"Number of flag actions performed on the user","format":"int32","title":"Flagged Count","type":"integer","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001.001.001"},"image":{"type":"string","x-stream-index":"001.001.003"},"language":{"type":"string","x-stream-index":"001.001.005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"001.001.014"},"name":{"type":"string","x-stream-index":"001.001.002"},"online":{"type":"boolean","x-stream-index":"001.001.013"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.001.015"},"role":{"type":"string","x-stream-index":"001.001.006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.001.008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids","shadow_banned","invisible","ban_count","deleted_content_count","flagged_count"],"type":"object"},"EventNotificationSettings":{"properties":{"apns":{"$ref":"#/components/schemas/APNS","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"fcm":{"$ref":"#/components/schemas/FCM","x-stream-index":"003"}},"required":["enabled","apns","fcm"],"type":"object"},"ExternalStorage":{"properties":{"abs_account_name":{"type":"string","x-stream-index":"011"},"abs_client_id":{"type":"string","x-stream-index":"013"},"abs_client_secret":{"type":"string","x-stream-index":"014"},"abs_tenant_id":{"type":"string","x-stream-index":"012"},"bucket":{"type":"string","x-stream-index":"005"},"gcs_credentials":{"type":"string","x-stream-index":"010"},"path":{"type":"string","x-stream-index":"006"},"s3_api_key":{"type":"string","x-stream-index":"007"},"s3_custom_endpoint":{"type":"string","x-stream-index":"016"},"s3_region":{"type":"string","x-stream-index":"009"},"s3_secret_key":{"type":"string","x-stream-index":"008"},"storage_name":{"type":"string","x-stream-index":"015"},"storage_type":{"type":"integer","x-stream-index":"004"}},"type":"object"},"FCM":{"properties":{"data":{"additionalProperties":{},"type":"object","x-stream-index":"001"}},"type":"object"},"FeedsEventPreferences":{"properties":{"comments":{"type":"string","x-stream-index":"002"},"mentions":{"type":"string","x-stream-index":"004"},"new_followers":{"type":"string","x-stream-index":"003"},"reactions":{"type":"string","x-stream-index":"001"}},"type":"object"},"Field":{"nullable":true,"properties":{"short":{"type":"boolean","x-stream-index":"003"},"title":{"type":"string","x-stream-index":"001"},"value":{"type":"string","x-stream-index":"002"}},"required":["title","value","short"],"type":"object"},"Flag":{"description":"Contains information about flagged user or message","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"019"},"custom":{"additionalProperties":{},"description":"Additional metadata about the flag","title":"Custom","type":"object","x-stream-index":"014"},"entity_creator_id":{"description":"ID of the user who created the flagged entity","title":"Entity Creator ID","type":"string","x-stream-index":"009"},"entity_id":{"description":"Unique identifier of the entity being flagged","title":"Entity ID","type":"string","x-stream-index":"008"},"entity_type":{"description":"Type of entity being flagged (e.g., message, user)","title":"Entity Type","type":"string","x-stream-index":"007"},"is_streamed_content":{"type":"boolean","x-stream-index":"012"},"labels":{"description":"Labels from bodyguard, API calls, our own AI etc","items":{"type":"string"},"title":"Labels","type":"array","x-stream-index":"015"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content being flagged","title":"Moderation Payload","x-stream-index":"010"},"moderation_payload_hash":{"type":"string","x-stream-index":"011"},"reason":{"description":"Optional explanation for why the content is being flagged","title":"Reason","type":"string","x-stream-index":"013"},"result":{"description":"Result of bodyguard, API calls, our own AI etc","items":{"additionalProperties":{},"type":"object"},"title":"Result","type":"array","x-stream-index":"016"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"018"},"review_queue_item_id":{"description":"ID of the review queue item","title":"Review Queue Item ID","type":"string","x-stream-index":"017"},"type":{"type":"string","x-stream-index":"004"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"020"},"user":{"$ref":"#/components/schemas/User","description":"User who flagged a message or a user","title":"User","x-stream-index":"006"}},"required":["entity_type","entity_id","result","created_at","updated_at"],"title":"Flag","type":"object"},"FlagContentOptions":{"properties":{"reason":{"type":"string","x-stream-index":"001"}},"type":"object"},"FlagRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"description":"Additional metadata about the flag","title":"Custom","type":"object","x-stream-index":"006"},"entity_creator_id":{"description":"ID of the user who created the flagged entity","title":"Entity Creator ID","type":"string","x-stream-index":"003"},"entity_id":{"description":"Unique identifier of the entity being flagged","title":"Entity ID","type":"string","x-stream-index":"002"},"entity_type":{"description":"Type of entity being flagged (e.g., message, user)","title":"Entity Type","type":"string","x-stream-index":"001"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content being flagged","title":"Moderation Payload","x-stream-index":"005"},"reason":{"description":"Optional explanation for why the content is being flagged","maxLength":255,"title":"Reason","type":"string","x-stream-index":"004"}},"required":["entity_type","entity_id"],"type":"object"},"FlagResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"item_id":{"description":"Unique identifier of the created moderation item","title":"Item ID","type":"string","x-stream-index":"001"}},"required":["item_id","duration"],"type":"object"},"FlagUserOptions":{"properties":{"reason":{"type":"string","x-stream-index":"001"}},"type":"object"},"FrameRecordSettings":{"properties":{"capture_interval_in_seconds":{"format":"int32","maximum":60,"minimum":2,"type":"integer","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"},"quality":{"type":"string","x-stream-index":"002"}},"required":["mode","capture_interval_in_seconds"],"type":"object"},"FrameRecordingEgressConfig":{"properties":{"capture_interval_in_seconds":{"format":"int32","type":"integer","x-stream-index":"007"},"external_storage":{"$ref":"#/components/schemas/ExternalStorage","x-stream-index":"006"},"quality":{"$ref":"#/components/schemas/Quality","x-stream-index":"004"},"storage_name":{"type":"string","x-stream-index":"005"}},"type":"object"},"FrameRecordingResponse":{"properties":{"status":{"type":"string","x-stream-index":"001"}},"required":["status"],"type":"object"},"FrameRecordingSettingsResponse":{"properties":{"capture_interval_in_seconds":{"format":"int32","maximum":60,"minimum":2,"type":"integer","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"},"quality":{"type":"string","x-stream-index":"002"}},"required":["mode","capture_interval_in_seconds"],"type":"object"},"GeofenceSettings":{"properties":{"names":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"required":["names"],"type":"object"},"GeofenceSettingsResponse":{"properties":{"names":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"required":["names"],"type":"object"},"GetConfigResponse":{"nullable":true,"properties":{"config":{"$ref":"#/components/schemas/ConfigResponse","description":"The retrieved moderation configuration","title":"Config","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["duration"],"type":"object"},"GoogleVisionConfig":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"HLSEgressConfig":{"properties":{"composite_app_settings":{"$ref":"#/components/schemas/CompositeAppSettings","x-stream-index":"005"},"playlist_url":{"type":"string","x-stream-index":"007"},"qualities":{"items":{"$ref":"#/components/schemas/Quality"},"type":"array","x-stream-index":"004"},"start_unix_nano":{"format":"int64","type":"integer","x-stream-index":"006"}},"type":"object"},"HLSSettings":{"properties":{"auto_on":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"004"},"quality_tracks":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"required":["auto_on","enabled","quality_tracks"],"type":"object"},"HLSSettingsResponse":{"description":"HLSSettings is the payload for HLS settings","properties":{"auto_on":{"title":"Auto On","type":"boolean","x-stream-index":"001"},"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"002"},"quality_tracks":{"items":{"type":"string"},"title":"Quality Tracks","type":"array","x-stream-index":"003"}},"required":["auto_on","enabled","quality_tracks","layout"],"title":"HLSSettingsResponse","type":"object"},"HarmConfig":{"properties":{"action_sequences":{"items":{"$ref":"#/components/schemas/ActionSequence"},"type":"array","x-stream-index":"001"},"severity":{"type":"integer","x-stream-index":"002"}},"required":["action_sequences","severity"],"type":"object"},"ImageContentParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"type":"object"},"ImageData":{"properties":{"frames":{"type":"string","x-stream-index":"005"},"height":{"type":"string","x-stream-index":"003"},"size":{"type":"string","x-stream-index":"004"},"url":{"type":"string","x-stream-index":"001"},"width":{"type":"string","x-stream-index":"002"}},"required":["url","width","height","size","frames"],"type":"object"},"ImageRuleParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"type":"object"},"Images":{"properties":{"fixed_height":{"$ref":"#/components/schemas/ImageData","x-stream-index":"002"},"fixed_height_downsampled":{"$ref":"#/components/schemas/ImageData","x-stream-index":"004"},"fixed_height_still":{"$ref":"#/components/schemas/ImageData","x-stream-index":"003"},"fixed_width":{"$ref":"#/components/schemas/ImageData","x-stream-index":"005"},"fixed_width_downsampled":{"$ref":"#/components/schemas/ImageData","x-stream-index":"007"},"fixed_width_still":{"$ref":"#/components/schemas/ImageData","x-stream-index":"006"},"original":{"$ref":"#/components/schemas/ImageData","x-stream-index":"001"}},"required":["original","fixed_height","fixed_height_still","fixed_height_downsampled","fixed_width","fixed_width_still","fixed_width_downsampled"],"type":"object"},"IngressAudioEncodingOptions":{"properties":{"bitrate":{"maximum":128000,"minimum":16000,"type":"integer","x-stream-index":"003"},"channels":{"enum":["1","2"],"format":"int32","type":"integer","x-stream-index":"001"},"enable_dtx":{"type":"boolean","x-stream-index":"002"}},"required":["channels","enable_dtx","bitrate"],"type":"object"},"IngressAudioEncodingResponse":{"properties":{"bitrate":{"format":"int32","type":"integer","x-stream-index":"003"},"channels":{"format":"int32","type":"integer","x-stream-index":"001"},"enable_dtx":{"type":"boolean","x-stream-index":"002"}},"required":["channels","enable_dtx","bitrate"],"type":"object"},"IngressSettings":{"properties":{"audio_encoding_options":{"$ref":"#/components/schemas/IngressAudioEncodingOptions","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"video_encoding_options":{"additionalProperties":{"$ref":"#/components/schemas/IngressVideoEncodingOptions"},"type":"object","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"IngressSettingsResponse":{"properties":{"audio_encoding_options":{"$ref":"#/components/schemas/IngressAudioEncodingResponse","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"video_encoding_options":{"additionalProperties":{"$ref":"#/components/schemas/IngressVideoEncodingResponse"},"type":"object","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"IngressVideoEncodingOptions":{"properties":{"layers":{"items":{"$ref":"#/components/schemas/IngressVideoLayer"},"minimum":1,"type":"array","x-stream-index":"001"}},"required":["layers"],"type":"object"},"IngressVideoEncodingResponse":{"properties":{"layers":{"items":{"$ref":"#/components/schemas/IngressVideoLayerResponse"},"type":"array","x-stream-index":"001"}},"required":["layers"],"type":"object"},"IngressVideoLayer":{"nullable":true,"properties":{"bitrate":{"minimum":1000,"type":"integer","x-stream-index":"002"},"codec":{"enum":["h264","vp8"],"type":"string","x-stream-index":"001"},"frame_rate":{"maximum":60,"minimum":1,"type":"integer","x-stream-index":"003"},"max_dimension":{"minimum":240,"type":"integer","x-stream-index":"005"},"min_dimension":{"minimum":240,"type":"integer","x-stream-index":"004"}},"required":["codec","bitrate","frame_rate","min_dimension","max_dimension"],"type":"object"},"IngressVideoLayerResponse":{"nullable":true,"properties":{"bitrate":{"type":"integer","x-stream-index":"002"},"codec":{"type":"string","x-stream-index":"001"},"frame_rate_limit":{"type":"integer","x-stream-index":"005"},"max_dimension":{"type":"integer","x-stream-index":"004"},"min_dimension":{"type":"integer","x-stream-index":"003"}},"required":["codec","bitrate","min_dimension","max_dimension","frame_rate_limit"],"type":"object"},"LLMConfig":{"properties":{"app_context":{"type":"string","x-stream-index":"005"},"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/LLMRule"},"type":"array","x-stream-index":"003"},"severity_descriptions":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"004"}},"required":["enabled","rules"],"type":"object"},"LLMRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove","keep"],"type":"string","x-stream-index":"003"},"description":{"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"},"severity_rules":{"items":{"$ref":"#/components/schemas/BodyguardSeverityRule"},"type":"array","x-stream-index":"004"}},"required":["label","description","action","severity_rules"],"type":"object"},"LabelThresholds":{"properties":{"block":{"format":"float","maximum":1,"minimum":0,"type":"number","x-stream-index":"002"},"flag":{"format":"float","maximum":1,"minimum":0,"type":"number","x-stream-index":"001"}},"type":"object"},"LayoutSettings":{"properties":{"detect_orientation":{"type":"boolean","x-stream-index":"005"},"external_app_url":{"type":"string","x-stream-index":"003"},"external_css_url":{"type":"string","x-stream-index":"004"},"name":{"enum":["spotlight","grid","single-participant","mobile","custom"],"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"required":["name","external_app_url","external_css_url"],"type":"object"},"LimitsSettings":{"properties":{"max_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"004"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"},"max_participants_exclude_owner":{"type":"boolean","x-stream-index":"003"},"max_participants_exclude_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"002"}},"required":["max_participants_exclude_roles"],"type":"object"},"LimitsSettingsResponse":{"properties":{"max_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"004"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"},"max_participants_exclude_owner":{"type":"boolean","x-stream-index":"003"},"max_participants_exclude_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"002"}},"required":["max_participants_exclude_roles"],"type":"object"},"MarkReviewedRequest":{"properties":{"content_to_mark_as_reviewed_limit":{"format":"int32","maximum":2500,"type":"integer","x-stream-index":"002"},"disable_marking_content_as_reviewed":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"MemberLookup":{"properties":{"Limit":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"001"}},"required":["Limit"],"type":"object"},"Message":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"012"},"before_message_send_failed":{"type":"boolean","x-stream-index":"046"},"cid":{"type":"string","x-stream-index":"028"},"command":{"type":"string","x-stream-index":"006"},"created_at":{"format":"date-time","type":"number","x-stream-index":"030"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"034"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"033"},"deleted_for_me":{"type":"boolean","x-stream-index":"059"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"023"},"html":{"type":"string","x-stream-index":"007"},"i18n":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"044"},"id":{"type":"string","x-stream-index":"002"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"040"},"latest_reactions":{"items":{"$ref":"#/components/schemas/Reaction"},"type":"array","x-stream-index":"013"},"mentioned_users":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"043"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"052"},"mml":{"type":"string","x-stream-index":"005"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"056"},"own_reactions":{"items":{"$ref":"#/components/schemas/Reaction"},"type":"array","x-stream-index":"014"},"parent_id":{"type":"string","x-stream-index":"019"},"pin_expires":{"format":"date-time","type":"number","x-stream-index":"051"},"pinned":{"type":"boolean","x-stream-index":"047"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"048"},"pinned_by":{"$ref":"#/components/schemas/User","x-stream-index":"050"},"poll":{"$ref":"#/components/schemas/Poll","x-stream-index":"054"},"poll_id":{"type":"string","x-stream-index":"053"},"quoted_message":{"$ref":"#/components/schemas/Message","x-stream-index":"025"},"quoted_message_id":{"type":"string","x-stream-index":"024"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"015"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"017"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"016"},"reminder":{"$ref":"#/components/schemas/MessageReminder","x-stream-index":"058"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"022"},"restricted_visibility":{"items":{"type":"string"},"type":"array","x-stream-index":"011"},"shadowed":{"type":"boolean","x-stream-index":"036"},"shared_location":{"$ref":"#/components/schemas/SharedLocation","x-stream-index":"055"},"show_in_channel":{"type":"boolean","x-stream-index":"021"},"silent":{"type":"boolean","x-stream-index":"045"},"text":{"type":"string","x-stream-index":"004"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"027"},"type":{"type":"string","x-stream-index":"008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"031"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"010"}},"required":["id","text","html","type","restricted_visibility","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reaction_groups","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned"],"type":"object"},"MessageReminder":{"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"004"},"channel_cid":{"type":"string","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"011"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"006"},"message_id":{"type":"string","x-stream-index":"005"},"remind_at":{"format":"date-time","type":"number","x-stream-index":"009"},"task_id":{"type":"string","x-stream-index":"010"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"012"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"user_id":{"type":"string","x-stream-index":"007"}},"required":["channel_cid","message_id","user_id","task_id","created_at","updated_at"],"type":"object"},"MessageResponse":{"description":"Represents any chat message","properties":{"attachments":{"description":"Array of message attachments","items":{"$ref":"#/components/schemas/Attachment"},"title":"Message attachments","type":"array","x-stream-docs-page-id":"message_format#attachment-format","x-stream-index":"008"},"cid":{"description":"Channel unique identifier in \u003ctype\u003e:\u003cid\u003e format","title":"Channel CID","type":"string","x-stream-index":"022"},"command":{"description":"Contains provided slash command","title":"Command","type":"string","x-stream-docs-page-id":"custom_commands_webhook","x-stream-index":"004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"023"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"026"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"025"},"deleted_for_me":{"type":"boolean","x-stream-index":"044"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"018"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"041"},"html":{"description":"Contains HTML markup of the message. Can only be set when using server-side API","title":"HTML content","type":"string","x-stream-index":"005"},"i18n":{"additionalProperties":{"type":"string"},"description":"Object with translations. Key `language` contains the original language key. Other keys contain translations","title":"Internationalization info","type":"object","x-stream-docs-page-id":"translation","x-stream-index":"030"},"id":{"description":"Message ID is unique string identifier of the message","title":"ID","type":"string","x-stream-index":"001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"Contains image moderation information","title":"Image moderation labels","type":"object","x-stream-index":"028"},"latest_reactions":{"description":"List of 10 latest reactions to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Latest reactions","type":"array","x-stream-index":"009"},"mentioned_users":{"description":"List of mentioned users","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Mentioned Users","type":"array","x-stream-index":"029"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"036"},"mml":{"description":"Should be empty if `text` is provided. Can only be set when using server-side API","title":"Messaging Markup Language","type":"string","x-stream-docs-page-id":"mml_overview","x-stream-index":"003"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"039"},"own_reactions":{"description":"List of 10 latest reactions of authenticated user to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Own reactions","type":"array","x-stream-index":"010"},"parent_id":{"description":"ID of parent message (thread)","title":"Parent message ID","type":"string","x-stream-docs-page-id":"threads","x-stream-index":"015"},"pin_expires":{"description":"Date when pinned message expires","format":"date-time","title":"Pin expiration date","type":"number","x-stream-docs-page-id":"pinned_messages","x-stream-index":"035"},"pinned":{"description":"Whether message is pinned or not","title":"Pinned","type":"boolean","x-stream-docs-page-id":"pinned_messages","x-stream-index":"032"},"pinned_at":{"description":"Date when message got pinned","format":"date-time","title":"Pinned at","type":"number","x-stream-docs-page-id":"pinned_messages","x-stream-index":"033"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","description":"Contains user who pinned the message","title":"Pinned by","x-stream-docs-page-id":"pinned_messages","x-stream-index":"034"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"038"},"poll_id":{"description":"Identifier of the poll to include in the message","title":"Poll ID","type":"string","x-stream-index":"037"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","description":"Contains quoted message","title":"Quoted message","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"020"},"quoted_message_id":{"title":"ID of quoted message","type":"string","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"019"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing number of reactions of each type. Key: reaction type (string), value: number of reactions (int)","title":"Reaction counts","type":"object","x-stream-index":"011"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"014"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing scores of reactions of each type. Key: reaction type (string), value: total score of reactions (int)","title":"Reaction scores","type":"object","x-stream-index":"012"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"042"},"reply_count":{"description":"Number of replies to this message","format":"int32","title":"Reply count","type":"integer","x-stream-index":"017"},"restricted_visibility":{"description":"A list of user ids that have restricted visibility to the message, if the list is not empty, the message is only visible to the users in the list","items":{"type":"string"},"title":"Restricted visibility","type":"array","x-stream-index":"040"},"shadowed":{"description":"Whether the message was shadowed or not","title":"Shadowed","type":"boolean","x-stream-docs-page-id":"moderation#shadow-ban","x-stream-index":"027"},"shared_location":{"$ref":"#/components/schemas/SharedLocationResponseData","description":"Contains shared location data","title":"Shared Location","x-stream-index":"043"},"show_in_channel":{"description":"Whether thread reply should be shown in the channel as well","title":"Show in channel","type":"boolean","x-stream-docs-page-id":"threads","x-stream-index":"016"},"silent":{"description":"Whether message is silent or not","title":"Silent","type":"boolean","x-stream-index":"031"},"text":{"description":"Text of the message. Should be empty if `mml` is provided","title":"Text","type":"string","x-stream-index":"002"},"thread_participants":{"description":"List of users who participate in thread","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Thread participants","type":"array","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"021"},"type":{"description":"Contains type of the message","enum":["regular","ephemeral","error","reply","system","deleted"],"title":"Message Type","type":"string","x-stream-docs-page-id":"message_format#message-types","x-stream-index":"006"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"024"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Sender of the message. Required when using server-side API","title":"User object","x-stream-index":"007"}},"required":["id","text","html","type","user","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned","restricted_visibility"],"title":"Message","type":"object","x-stream-docs-page-id":"send_message"},"ModerationActionConfig":{"nullable":true,"properties":{"action":{"type":"string","x-stream-index":"006"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"009"},"description":{"type":"string","x-stream-index":"008"},"entity_type":{"type":"string","x-stream-index":"004"},"icon":{"type":"string","x-stream-index":"007"},"order":{"format":"int32","type":"integer","x-stream-index":"005"}},"required":["entity_type","order","action","icon","description","custom"],"type":"object"},"ModerationCustomActionEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"001"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"002"},"type":{"default":"moderation.custom_action","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationCustomActionEvent","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"},"ModerationFlagResponse":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"015"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"entity_creator_id":{"type":"string","x-stream-index":"007"},"entity_id":{"type":"string","x-stream-index":"006"},"entity_type":{"type":"string","x-stream-index":"005"},"labels":{"items":{"type":"string"},"type":"array","x-stream-index":"011"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"008"},"reason":{"type":"string","x-stream-index":"009"},"result":{"items":{"additionalProperties":{},"type":"object"},"type":"array","x-stream-index":"012"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","x-stream-index":"014"},"review_queue_item_id":{"type":"string","x-stream-index":"013"},"type":{"type":"string","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"016"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"004"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["type","user_id","entity_type","entity_id","result","created_at","updated_at"],"type":"object"},"ModerationFlaggedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"item":{"type":"string","x-stream-index":"001"},"object_id":{"type":"string","x-stream-index":"002"},"type":{"default":"moderation.flagged","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationFlaggedEvent","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"},"ModerationMarkReviewedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"001"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"002"},"type":{"default":"moderation.mark_reviewed","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationMarkReviewedEvent","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"},"ModerationPayload":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"images":{"items":{"type":"string"},"maximum":30,"type":"array","x-stream-index":"002"},"texts":{"items":{"type":"string"},"type":"array","x-stream-index":"001"},"videos":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"type":"object"},"ModerationV2Response":{"properties":{"action":{"type":"string","x-stream-index":"001"},"blocklist_matched":{"type":"string","x-stream-index":"005"},"image_harms":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"original_text":{"type":"string","x-stream-index":"002"},"platform_circumvented":{"type":"boolean","x-stream-index":"007"},"semantic_filter_matched":{"type":"string","x-stream-index":"006"},"text_harms":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"required":["action","original_text"],"type":"object"},"MuteRequest":{"nullable":true,"properties":{"target_ids":{"description":"User IDs to mute (if multiple users)","items":{"type":"string"},"title":"Target IDs","type":"array","x-stream-index":"001"},"timeout":{"description":"Duration of mute in minutes","minimum":0,"title":"Timeout","type":"integer","x-stream-index":"002"}},"required":["target_ids"],"title":"MuteRequest","type":"object"},"MuteResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"004.001"},"mutes":{"description":"Object with mutes (if multiple users were muted)","items":{"$ref":"#/components/schemas/UserMute"},"title":"Mutes","type":"array","x-stream-index":"001"},"non_existing_users":{"description":"A list of users that can't be found. Common cause for this is deleted users","items":{"type":"string"},"title":"Non Existing Users","type":"array","x-stream-index":"003"},"own_user":{"$ref":"#/components/schemas/OwnUser","description":"Authorized user object with fresh mutes information","title":"Own User","x-stream-index":"002"}},"required":["duration"],"title":"MuteResponse","type":"object"},"NoiseCancellationSettings":{"properties":{"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode"],"type":"object"},"NotificationSettings":{"properties":{"call_live_started":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"002"},"call_missed":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"006"},"call_notification":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"004"},"call_ring":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"session_started":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"003"}},"required":["enabled","call_live_started","session_started","call_notification","call_ring","call_missed"],"type":"object"},"NullTime":{"type":"object"},"OCRRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"}},"required":["label","action"],"type":"object"},"OwnUser":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"046"},"banned":{"type":"boolean","x-stream-index":"016"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"045"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"029"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"014"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"013"},"devices":{"items":{"$ref":"#/components/schemas/Device"},"type":"array","x-stream-index":"027"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"023"},"language":{"type":"string","x-stream-index":"035"},"last_active":{"format":"date-time","type":"number","x-stream-index":"011"},"last_engaged_at":{"format":"date-time","type":"number","x-stream-index":"012"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"037"},"mutes":{"items":{"$ref":"#/components/schemas/UserMute"},"type":"array","x-stream-index":"028"},"online":{"type":"boolean","x-stream-index":"022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"026"},"push_preferences":{"$ref":"#/components/schemas/PushPreferences","x-stream-index":"025"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"005"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"031"},"total_unread_count_by_team":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"032"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"033"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"030"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"034"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"}},"required":["id","role","custom","created_at","updated_at","banned","online","devices","mutes","channel_mutes","unread_count","total_unread_count","total_unread_count_by_team","unread_channels","unread_threads","language"],"type":"object"},"Poll":{"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"023"},"allow_answers":{"type":"boolean","x-stream-index":"010"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"009"},"answers_count":{"format":"int32","type":"integer","x-stream-index":"015"},"created_at":{"format":"date-time","type":"number","x-stream-index":"021"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"020"},"created_by_id":{"type":"string","x-stream-index":"019"},"description":{"type":"string","x-stream-index":"005"},"enforce_unique_vote":{"type":"boolean","x-stream-index":"007"},"id":{"type":"string","x-stream-index":"003"},"is_closed":{"type":"boolean","x-stream-index":"011"},"latest_answers":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array","x-stream-index":"017"},"latest_votes_by_option":{"additionalProperties":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array"},"type":"object","x-stream-index":"016"},"max_votes_allowed":{"format":"int32","type":"integer","x-stream-index":"008"},"name":{"type":"string","x-stream-index":"004"},"options":{"items":{"$ref":"#/components/schemas/PollOption"},"type":"array","x-stream-index":"013"},"own_votes":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array","x-stream-index":"018"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"022"},"vote_count":{"format":"int32","type":"integer","x-stream-index":"012"},"vote_counts_by_option":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"014"},"voting_visibility":{"type":"string","x-stream-index":"006"}},"required":["id","name","description","enforce_unique_vote","allow_user_suggested_options","allow_answers","vote_count","options","vote_counts_by_option","answers_count","latest_votes_by_option","latest_answers","own_votes","created_by_id","created_at","updated_at","Custom"],"type":"object"},"PollOption":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id","text","custom"],"type":"object"},"PollOptionResponseData":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id","text","custom"],"type":"object"},"PollResponseData":{"properties":{"allow_answers":{"type":"boolean","x-stream-index":"008"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"007"},"answers_count":{"format":"int32","type":"integer","x-stream-index":"012"},"created_at":{"format":"date-time","type":"number","x-stream-index":"019"},"created_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"018"},"created_by_id":{"type":"string","x-stream-index":"017"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"021"},"description":{"type":"string","x-stream-index":"003"},"enforce_unique_vote":{"type":"boolean","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"is_closed":{"type":"boolean","x-stream-index":"009"},"latest_answers":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array","x-stream-index":"015"},"latest_votes_by_option":{"additionalProperties":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array"},"type":"object","x-stream-index":"014"},"max_votes_allowed":{"format":"int32","type":"integer","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"002"},"options":{"items":{"$ref":"#/components/schemas/PollOptionResponseData"},"type":"array","x-stream-index":"011"},"own_votes":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array","x-stream-index":"016"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"020"},"vote_count":{"format":"int32","type":"integer","x-stream-index":"010"},"vote_counts_by_option":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"013"},"voting_visibility":{"type":"string","x-stream-index":"004"}},"required":["id","name","description","voting_visibility","enforce_unique_vote","allow_user_suggested_options","allow_answers","vote_count","options","answers_count","vote_counts_by_option","latest_votes_by_option","latest_answers","own_votes","created_by_id","created_at","updated_at","custom"],"type":"object"},"PollVote":{"nullable":true,"properties":{"answer_text":{"type":"string","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"004"},"is_answer":{"type":"boolean","x-stream-index":"006"},"option_id":{"type":"string","x-stream-index":"005"},"poll_id":{"type":"string","x-stream-index":"003"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"011"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"009"},"user_id":{"type":"string","x-stream-index":"008"}},"required":["poll_id","id","option_id","created_at","updated_at"],"type":"object"},"PollVoteResponseData":{"nullable":true,"properties":{"answer_text":{"type":"string","x-stream-index":"005"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"id":{"type":"string","x-stream-index":"002"},"is_answer":{"type":"boolean","x-stream-index":"004"},"option_id":{"type":"string","x-stream-index":"003"},"poll_id":{"type":"string","x-stream-index":"001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"007"},"user_id":{"type":"string","x-stream-index":"006"}},"required":["poll_id","id","option_id","created_at","updated_at"],"type":"object"},"PrivacySettings":{"properties":{"read_receipts":{"$ref":"#/components/schemas/ReadReceipts","x-stream-index":"002"},"typing_indicators":{"$ref":"#/components/schemas/TypingIndicators","x-stream-index":"001"}},"type":"object"},"PrivacySettingsResponse":{"properties":{"read_receipts":{"$ref":"#/components/schemas/ReadReceiptsResponse","x-stream-index":"002"},"typing_indicators":{"$ref":"#/components/schemas/TypingIndicatorsResponse","x-stream-index":"001"}},"type":"object"},"PushPreferences":{"properties":{"call_level":{"type":"string","x-stream-index":"002"},"chat_level":{"type":"string","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"number","x-stream-index":"005"},"feeds_events":{"$ref":"#/components/schemas/FeedsEventPreferences","x-stream-index":"004"},"feeds_level":{"type":"string","x-stream-index":"003"}},"type":"object"},"Quality":{"properties":{"bitdepth":{"format":"int32","type":"integer","x-stream-index":"007"},"framerate":{"format":"int32","type":"integer","x-stream-index":"008"},"height":{"format":"int32","type":"integer","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"004"},"video_bitrate":{"format":"int32","type":"integer","x-stream-index":"009"},"width":{"format":"int32","type":"integer","x-stream-index":"005"}},"type":"object"},"QueryModerationConfigsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter conditions for moderation configs","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"Sorting parameters for the results","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"002"}},"type":"object"},"QueryModerationConfigsResponse":{"nullable":true,"properties":{"configs":{"description":"List of moderation configurations","items":{"$ref":"#/components/schemas/ConfigResponse"},"title":"Configs","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["configs","duration"],"type":"object"},"QueryReviewQueueRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter conditions for review queue items","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"007.001"},"lock_count":{"description":"Number of items to lock (1-25)","format":"int32","maximum":25,"minimum":1,"title":"Lock Count","type":"integer","x-stream-index":"005"},"lock_duration":{"description":"Duration for which items should be locked","title":"Lock Duration","type":"integer","x-stream-index":"004"},"lock_items":{"description":"Whether to lock items for review (true), unlock items (false), or just fetch (nil)","title":"Lock Items","type":"boolean","x-stream-index":"003"},"next":{"type":"string","x-stream-index":"007.002"},"prev":{"type":"string","x-stream-index":"007.003"},"sort":{"description":"Sorting parameters for the results","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"002"},"stats_only":{"description":"Whether to return only statistics","title":"Stats Only","type":"boolean","x-stream-index":"006"}},"type":"object"},"QueryReviewQueueResponse":{"nullable":true,"properties":{"action_config":{"additionalProperties":{"items":{"$ref":"#/components/schemas/ModerationActionConfig"},"type":"array"},"description":"Configuration for moderation actions","title":"Action Config","type":"object","x-stream-index":"002"},"duration":{"type":"string","x-stream-index":"005.001"},"items":{"description":"List of review queue items","items":{"$ref":"#/components/schemas/ReviewQueueItemResponse"},"title":"Items","type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"004.001"},"prev":{"type":"string","x-stream-index":"004.002"},"stats":{"additionalProperties":{},"description":"Statistics about the review queue","title":"Stats","type":"object","x-stream-index":"003"}},"required":["items","action_config","stats","duration"],"type":"object"},"RTMPEgressConfig":{"properties":{"composite_app_settings":{"$ref":"#/components/schemas/CompositeAppSettings","x-stream-index":"005"},"quality":{"$ref":"#/components/schemas/Quality","x-stream-index":"004"},"rtmp_location":{"type":"string","x-stream-index":"006"}},"type":"object"},"RTMPIngress":{"description":"RTMP input settings","properties":{"address":{"title":"Address","type":"string","x-stream-index":"001"}},"required":["address"],"title":"RTMPIngress","type":"object"},"RTMPLocation":{"properties":{"name":{"type":"string","x-stream-index":"001"},"stream_key":{"type":"string","x-stream-index":"003"},"stream_url":{"type":"string","x-stream-index":"002"}},"required":["name","stream_url","stream_key"],"type":"object"},"RTMPSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"003"},"location":{"$ref":"#/components/schemas/RTMPLocation","x-stream-index":"004"},"quality_name":{"type":"string","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"RTMPSettingsResponse":{"description":"RTMPSettingsResponse is the payload for RTMP settings","properties":{"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"001"},"quality":{"title":"Quality","type":"string","x-stream-index":"002"}},"required":["enabled","quality","layout"],"title":"RTMPSettingsResponse","type":"object"},"Reaction":{"nullable":true,"properties":{"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"message_id":{"type":"string","x-stream-index":"003"},"score":{"format":"int32","type":"integer","x-stream-index":"007"},"type":{"maxLength":30,"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["message_id","type","score","created_at","updated_at","custom"],"type":"object"},"ReactionGroupResponse":{"description":"ReactionGroupResponse contains all information about a reaction of the same type.","nullable":true,"properties":{"count":{"description":"Count is the number of reactions of this type.","format":"int32","title":"Count","type":"integer","x-stream-index":"001"},"first_reaction_at":{"description":"FirstReactionAt is the time of the first reaction of this type. This is the same also if all reaction of this type are deleted, because if someone will react again with the same type, will be preserved the sorting.","format":"date-time","title":"FirstReactionAt","type":"number","x-stream-index":"003"},"last_reaction_at":{"description":"LastReactionAt is the time of the last reaction of this type.","format":"date-time","title":"LastReactionAt","type":"number","x-stream-index":"004"},"sum_scores":{"description":"SumScores is the sum of all scores of reactions of this type. Medium allows you to clap articles more than once and shows the sum of all claps from all users. For example, you can send `clap` x5 using `score: 5`.","format":"int32","title":"SumScores","type":"integer","x-stream-index":"002"}},"required":["count","sum_scores","first_reaction_at","last_reaction_at"],"title":"ReactionGroupResponse","type":"object"},"ReactionResponse":{"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"006"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"008"},"message_id":{"description":"Message ID","title":"Message ID","type":"string","x-stream-index":"001"},"score":{"description":"Score of the reaction","format":"int32","title":"Score","type":"integer","x-stream-index":"005"},"type":{"description":"Type of reaction","title":"Type","type":"string","x-stream-index":"004"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"007"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User","title":"UserResponse","x-stream-index":"003"},"user_id":{"description":"User ID","title":"User ID","type":"string","x-stream-index":"002"}},"required":["message_id","user_id","user","type","score","created_at","updated_at","custom"],"type":"object"},"ReadReceipts":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"ReadReceiptsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"RecordSettings":{"properties":{"audio_only":{"type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"004"},"mode":{"type":"string","x-stream-index":"002"},"quality":{"type":"string","x-stream-index":"003"}},"required":["mode"],"type":"object"},"RecordSettingsResponse":{"description":"RecordSettings is the payload for recording settings","properties":{"audio_only":{"title":"Audio Only","type":"boolean","x-stream-index":"001"},"mode":{"title":"Mode","type":"string","x-stream-index":"002"},"quality":{"title":"Quality","type":"string","x-stream-index":"003"}},"required":["audio_only","mode","quality","layout"],"title":"RecordSettingsResponse","type":"object"},"RecordingEgressConfig":{"properties":{"audio_only":{"type":"boolean","x-stream-index":"006"},"composite_app_settings":{"$ref":"#/components/schemas/CompositeAppSettings","x-stream-index":"005"},"external_storage":{"$ref":"#/components/schemas/ExternalStorage","x-stream-index":"008"},"quality":{"$ref":"#/components/schemas/Quality","x-stream-index":"004"},"storage_name":{"type":"string","x-stream-index":"007"},"video_orientation_hint":{"$ref":"#/components/schemas/VideoOrientation","x-stream-index":"009"}},"type":"object"},"ReminderResponseData":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003"},"channel_cid":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"005"},"message_id":{"type":"string","x-stream-index":"004"},"remind_at":{"format":"date-time","type":"number","x-stream-index":"001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007"},"user_id":{"type":"string","x-stream-index":"006"}},"required":["channel_cid","message_id","user_id","created_at","updated_at"],"type":"object"},"RestoreActionRequest":{"type":"object"},"ReviewQueueItem":{"properties":{"actions":{"items":{"$ref":"#/components/schemas/ActionLog"},"type":"array","x-stream-index":"035"},"activity":{"$ref":"#/components/schemas/EnrichedActivity","x-stream-index":"028"},"ai_text_severity":{"type":"string","x-stream-index":"021"},"archived_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"043"},"assigned_to":{"$ref":"#/components/schemas/User","x-stream-index":"032"},"bans":{"items":{"$ref":"#/components/schemas/Ban"},"type":"array","x-stream-index":"033"},"bounce_count":{"format":"int32","type":"integer","x-stream-index":"025"},"call":{"$ref":"#/components/schemas/Call","x-stream-index":"031"},"completed_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"018"},"config_key":{"type":"string","x-stream-index":"009"},"content_changed":{"type":"boolean","x-stream-index":"036"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"entity_creator":{"$ref":"#/components/schemas/EntityCreator","x-stream-index":"030"},"entity_id":{"type":"string","x-stream-index":"007"},"entity_type":{"type":"string","x-stream-index":"006"},"feeds_v2_activity":{"$ref":"#/components/schemas/EnrichedActivity","x-stream-index":"041"},"feeds_v2_reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"042"},"flag_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"045"},"flag_types":{"items":{"type":"string"},"type":"array","x-stream-index":"044"},"flags":{"items":{"$ref":"#/components/schemas/Flag"},"type":"array","x-stream-index":"034"},"flags_count":{"format":"int32","type":"integer","x-stream-index":"026"},"has_image":{"type":"boolean","x-stream-index":"012"},"has_text":{"type":"boolean","x-stream-index":"014"},"has_video":{"type":"boolean","x-stream-index":"013"},"id":{"type":"string","x-stream-index":"003"},"languages":{"items":{"type":"string"},"type":"array","x-stream-index":"019"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"027"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"010"},"moderation_payload_hash":{"type":"string","x-stream-index":"011"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"029"},"recommended_action":{"type":"string","x-stream-index":"017"},"reporter_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"046"},"reviewed_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"022"},"reviewed_by":{"type":"string","x-stream-index":"023"},"severity":{"format":"int32","type":"integer","x-stream-index":"020"},"status":{"type":"string","x-stream-index":"016"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"015"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"005"}},"required":["id","created_at","updated_at","entity_type","entity_id","config_key","moderation_payload_hash","has_image","has_video","has_text","teams","status","recommended_action","completed_at","languages","severity","ai_text_severity","reviewed_at","reviewed_by","bounce_count","flags_count","bans","flags","actions","content_changed","archived_at","flag_types","flag_labels","reporter_ids"],"type":"object"},"ReviewQueueItemResponse":{"nullable":true,"properties":{"actions":{"description":"Moderation actions taken","items":{"$ref":"#/components/schemas/ActionLogResponse"},"title":"Actions","type":"array","x-stream-index":"024"},"activity":{"$ref":"#/components/schemas/EnrichedActivity","x-stream-index":"016"},"ai_text_severity":{"description":"AI-determined text severity","title":"AI Text Severity","type":"string","x-stream-index":"014"},"assigned_to":{"$ref":"#/components/schemas/UserResponse","description":"Moderator assigned to review this item","title":"Assigned To","x-stream-index":"021"},"bans":{"description":"Associated ban records","items":{"$ref":"#/components/schemas/Ban"},"title":"Bans","type":"array","x-stream-index":"022"},"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"018"},"completed_at":{"description":"When the review was completed","format":"date-time","title":"Completed At","type":"number","x-stream-index":"009"},"config_key":{"type":"string","x-stream-index":"028"},"created_at":{"description":"When the item was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"002"},"entity_creator":{"$ref":"#/components/schemas/EntityCreatorResponse","description":"Details about who created the entity","title":"Entity Creator","x-stream-index":"019"},"entity_creator_id":{"description":"ID of who created the entity","title":"Entity Creator ID","type":"string","x-stream-index":"020"},"entity_id":{"description":"ID of the entity being reviewed","title":"Entity ID","type":"string","x-stream-index":"005"},"entity_type":{"description":"Type of entity being reviewed","title":"Entity Type","type":"string","x-stream-index":"004"},"feeds_v2_activity":{"$ref":"#/components/schemas/EnrichedActivity","description":"Associated feed activity","title":"Feeds V2 Activity","x-stream-index":"025"},"feeds_v2_reaction":{"$ref":"#/components/schemas/Reaction","description":"Associated feed reaction","title":"Feeds V2 Reaction","x-stream-index":"026"},"flags":{"description":"Associated flag records","items":{"$ref":"#/components/schemas/ModerationFlagResponse"},"title":"Flags","type":"array","x-stream-index":"023"},"flags_count":{"format":"int32","type":"integer","x-stream-index":"029"},"id":{"description":"Unique identifier of the review queue item","title":"ID","type":"string","x-stream-index":"001"},"languages":{"description":"Detected languages in the content","items":{"type":"string"},"title":"Languages","type":"array","x-stream-index":"012"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Associated message details","title":"Message","x-stream-index":"015"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content being moderated","title":"Moderation Payload","x-stream-index":"006"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"017"},"recommended_action":{"description":"Suggested moderation action","title":"Recommended Action","type":"string","x-stream-index":"008"},"reviewed_at":{"description":"When the item was reviewed","format":"date-time","title":"Reviewed At","type":"number","x-stream-index":"010"},"reviewed_by":{"description":"ID of the moderator who reviewed the item","title":"Reviewed By","type":"string","x-stream-index":"011"},"severity":{"description":"Severity level of the content","format":"int32","title":"Severity","type":"integer","x-stream-index":"013"},"status":{"description":"Current status of the review","title":"Status","type":"string","x-stream-index":"007"},"teams":{"description":"Teams associated with this item","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"027"},"updated_at":{"description":"When the item was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"003"}},"required":["id","created_at","updated_at","entity_type","entity_id","status","recommended_action","reviewed_by","languages","severity","ai_text_severity","bans","flags","actions","flags_count"],"type":"object"},"RingSettings":{"properties":{"auto_cancel_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_timeout_ms","missed_call_timeout_ms"],"type":"object"},"RingSettingsResponse":{"properties":{"auto_cancel_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_timeout_ms","missed_call_timeout_ms"],"type":"object"},"RuleBuilderAction":{"properties":{"ban_options":{"$ref":"#/components/schemas/BanOptions","x-stream-index":"002"},"flag_content_options":{"$ref":"#/components/schemas/FlagContentOptions","x-stream-index":"004"},"flag_user_options":{"$ref":"#/components/schemas/FlagUserOptions","x-stream-index":"003"},"remove_content_options":{"$ref":"#/components/schemas/BlockContentOptions","x-stream-index":"005"},"type":{"type":"string","x-stream-index":"001"}},"type":"object"},"RuleBuilderCondition":{"properties":{"confidence":{"format":"float","type":"number","x-stream-index":"002"},"content_count_rule_params":{"$ref":"#/components/schemas/ContentCountRuleParameters","x-stream-index":"007"},"image_content_params":{"$ref":"#/components/schemas/ImageContentParameters","x-stream-index":"009"},"image_rule_params":{"$ref":"#/components/schemas/ImageRuleParameters","x-stream-index":"004"},"text_content_params":{"$ref":"#/components/schemas/TextContentParameters","x-stream-index":"008"},"text_rule_params":{"$ref":"#/components/schemas/TextRuleParameters","x-stream-index":"003"},"type":{"type":"string","x-stream-index":"001"},"user_created_within_params":{"$ref":"#/components/schemas/UserCreatedWithinParameters","x-stream-index":"011"},"user_custom_property_params":{"$ref":"#/components/schemas/UserCustomPropertyParameters","x-stream-index":"012"},"user_rule_params":{"$ref":"#/components/schemas/UserRuleParameters","x-stream-index":"006"},"video_content_params":{"$ref":"#/components/schemas/VideoContentParameters","x-stream-index":"010"},"video_rule_params":{"$ref":"#/components/schemas/VideoRuleParameters","x-stream-index":"005"}},"type":"object"},"RuleBuilderConditionGroup":{"properties":{"conditions":{"items":{"$ref":"#/components/schemas/RuleBuilderCondition"},"type":"array","x-stream-index":"002"},"logic":{"type":"string","x-stream-index":"001"}},"type":"object"},"RuleBuilderConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"rules":{"items":{"$ref":"#/components/schemas/RuleBuilderRule"},"type":"array","x-stream-index":"002"}},"type":"object"},"RuleBuilderRule":{"properties":{"action":{"$ref":"#/components/schemas/RuleBuilderAction","x-stream-index":"006"},"conditions":{"items":{"$ref":"#/components/schemas/RuleBuilderCondition"},"type":"array","x-stream-index":"003"},"cooldown_period":{"type":"string","x-stream-index":"007"},"groups":{"items":{"$ref":"#/components/schemas/RuleBuilderConditionGroup"},"type":"array","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"logic":{"type":"string","x-stream-index":"004"},"rule_type":{"type":"string","x-stream-index":"002"}},"required":["rule_type","action"],"type":"object"},"SFUIDLastSeen":{"properties":{"id":{"type":"string","x-stream-index":"001.001"},"last_seen":{"format":"date-time","type":"number","x-stream-index":"002"},"process_start_time":{"format":"int64","type":"integer","x-stream-index":"001.002"}},"required":["id","process_start_time","last_seen"],"type":"object"},"STTEgressConfig":{"properties":{"closed_captions_enabled":{"type":"boolean","x-stream-index":"005"},"external_storage":{"$ref":"#/components/schemas/ExternalStorage","x-stream-index":"011"},"language":{"type":"string","x-stream-index":"008"},"storage_name":{"type":"string","x-stream-index":"010"},"translation_languages":{"items":{"type":"string"},"type":"array","x-stream-index":"009"},"translations_enabled":{"type":"boolean","x-stream-index":"006"},"upload_transcriptions":{"type":"boolean","x-stream-index":"004"},"whisper_server_base_url":{"type":"string","x-stream-index":"007"}},"type":"object"},"ScreensharingSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled"],"type":"object"},"ScreensharingSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled"],"type":"object"},"SessionSettings":{"properties":{"inactivity_timeout_seconds":{"format":"int32","maximum":900,"minimum":5,"type":"integer","x-stream-index":"001"}},"required":["inactivity_timeout_seconds"],"type":"object"},"SessionSettingsResponse":{"properties":{"inactivity_timeout_seconds":{"format":"int32","maximum":900,"minimum":5,"type":"integer","x-stream-index":"001"}},"required":["inactivity_timeout_seconds"],"type":"object"},"ShadowBlockActionRequest":{"type":"object"},"SharedLocation":{"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"013"},"channel_cid":{"type":"string","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"010"},"created_by_device_id":{"type":"string","x-stream-index":"008"},"end_at":{"format":"date-time","type":"number","x-stream-index":"009"},"latitude":{"format":"float","maximum":90,"minimum":18446744073709552000,"type":"number","x-stream-index":"006"},"longitude":{"format":"float","maximum":180,"minimum":18446744073709552000,"type":"number","x-stream-index":"007"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"012"},"message_id":{"type":"string","x-stream-index":"004"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"011"},"user_id":{"type":"string","x-stream-index":"005"}},"required":["channel_cid","message_id","user_id","created_by_device_id","created_at","updated_at"],"type":"object"},"SharedLocationResponseData":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"011"},"channel_cid":{"type":"string","x-stream-index":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"created_by_device_id":{"type":"string","x-stream-index":"006"},"end_at":{"format":"date-time","type":"number","x-stream-index":"007"},"latitude":{"format":"float","type":"number","x-stream-index":"004"},"longitude":{"format":"float","type":"number","x-stream-index":"005"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"010"},"message_id":{"type":"string","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["channel_cid","message_id","user_id","latitude","longitude","created_by_device_id","created_at","updated_at"],"type":"object"},"SortParamRequest":{"nullable":true,"properties":{"direction":{"description":"Direction of sorting, 1 for Ascending, -1 for Descending, default is 1","format":"int32","title":"Direction","type":"integer","x-stream-index":"002"},"field":{"description":"Name of field to sort by","title":"Field","type":"string","x-stream-index":"001"}},"type":"object"},"SubmitActionRequest":{"nullable":true,"properties":{"action_type":{"description":"Type of moderation action to perform (mark_reviewed, delete_message, etc.)","enum":["mark_reviewed","delete_message","delete_activity","delete_reaction","ban","custom","unban","restore","delete_user","unblock","shadow_block","unmask","kick_user","end_call"],"title":"Action Type","type":"string","x-stream-index":"002"},"ban":{"$ref":"#/components/schemas/BanActionRequest","description":"Configuration for ban action","title":"Ban","x-stream-index":"008"},"custom":{"$ref":"#/components/schemas/CustomActionRequest","description":"Configuration for custom action","title":"Custom","x-stream-index":"009"},"delete_activity":{"$ref":"#/components/schemas/DeleteActivityRequest","description":"Configuration for activity deletion action","title":"Delete Activity","x-stream-index":"004"},"delete_message":{"$ref":"#/components/schemas/DeleteMessageRequest","description":"Configuration for message deletion action","title":"Delete Message","x-stream-index":"003"},"delete_reaction":{"$ref":"#/components/schemas/DeleteReactionRequest","description":"Configuration for reaction deletion action","title":"Delete Reaction","x-stream-index":"005"},"delete_user":{"$ref":"#/components/schemas/DeleteUserRequest","description":"Configuration for user deletion action","title":"Delete User","x-stream-index":"006"},"item_id":{"description":"UUID of the review queue item to act on","title":"Item ID","type":"string","x-stream-index":"001"},"mark_reviewed":{"$ref":"#/components/schemas/MarkReviewedRequest","description":"Configuration for marking item as reviewed","title":"Mark Reviewed","x-stream-index":"007"},"unban":{"$ref":"#/components/schemas/UnbanActionRequest","description":"Configuration for unban action","title":"Unban","x-stream-index":"010"}},"required":["item_id","action_type"],"type":"object"},"SubmitActionResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"Updated review queue item after action was performed","title":"Item","x-stream-index":"001"}},"required":["duration"],"type":"object"},"TargetResolution":{"properties":{"bitrate":{"format":"int32","maximum":6000000,"type":"integer","x-stream-index":"003"},"height":{"format":"int32","maximum":3840,"minimum":240,"type":"integer","x-stream-index":"002"},"width":{"format":"int32","maximum":3840,"minimum":240,"type":"integer","x-stream-index":"001"}},"required":["width","height","bitrate"],"type":"object"},"TextContentParameters":{"properties":{"blocklist_match":{"items":{"type":"string"},"type":"array","x-stream-index":"005"},"contains_url":{"type":"boolean","x-stream-index":"003"},"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001"},"llm_harm_labels":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"002"},"severity":{"type":"string","x-stream-index":"004"}},"type":"object"},"TextRuleParameters":{"properties":{"blocklist_match":{"items":{"type":"string"},"type":"array","x-stream-index":"007"},"contains_url":{"type":"boolean","x-stream-index":"005"},"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"llm_harm_labels":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"004"},"severity":{"type":"string","x-stream-index":"006"},"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"type":"object"},"Thresholds":{"properties":{"explicit":{"$ref":"#/components/schemas/LabelThresholds","x-stream-index":"001"},"spam":{"$ref":"#/components/schemas/LabelThresholds","x-stream-index":"002"},"toxic":{"$ref":"#/components/schemas/LabelThresholds","x-stream-index":"003"}},"type":"object"},"ThumbnailResponse":{"properties":{"image_url":{"type":"string","x-stream-index":"001"}},"required":["image_url"],"type":"object"},"ThumbnailsSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"ThumbnailsSettingsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"Time":{"type":"object"},"TranscriptionSettings":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"title":"Mode","type":"string","x-stream-index":"002"},"language":{"description":"The language used in this call as a two letter code","enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"title":"Language","type":"string","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"title":"Mode","type":"string","x-stream-index":"001"}},"required":["mode","closed_caption_mode","languages","language"],"type":"object"},"TranscriptionSettingsResponse":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"002"},"language":{"enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"type":"string","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode","closed_caption_mode","languages","language"],"type":"object"},"TypingIndicators":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"TypingIndicatorsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"UnbanActionRequest":{"type":"object"},"UnblockActionRequest":{"type":"object"},"UpsertConfigRequest":{"nullable":true,"properties":{"ai_image_config":{"$ref":"#/components/schemas/AIImageConfig","description":"Configuration for AI image analysis","title":"AI Image Config","x-stream-index":"011"},"ai_text_config":{"$ref":"#/components/schemas/AITextConfig","description":"Configuration for AI text analysis","title":"AI Text Config","x-stream-index":"008"},"ai_video_config":{"$ref":"#/components/schemas/AIVideoConfig","description":"Configuration for AI video analysis","title":"AI Video Config","x-stream-index":"012"},"async":{"description":"Whether moderation should be performed asynchronously","title":"Async","type":"boolean","x-stream-index":"003"},"automod_platform_circumvention_config":{"$ref":"#/components/schemas/AutomodPlatformCircumventionConfig","description":"Configuration for platform circumvention detection","title":"Automod Platform Circumvention Config","x-stream-index":"005"},"automod_semantic_filters_config":{"$ref":"#/components/schemas/AutomodSemanticFiltersConfig","description":"Configuration for semantic filtering","title":"Automod Semantic Filters Config","x-stream-index":"006"},"automod_toxicity_config":{"$ref":"#/components/schemas/AutomodToxicityConfig","description":"Configuration for toxicity detection","title":"Automod Toxicity Config","x-stream-index":"004"},"aws_rekognition_config":{"$ref":"#/components/schemas/AIImageConfig","x-stream-index":"016"},"block_list_config":{"$ref":"#/components/schemas/BlockListConfig","description":"Configuration for block list filtering","title":"Block List Config","x-stream-index":"007"},"bodyguard_config":{"$ref":"#/components/schemas/AITextConfig","x-stream-index":"015"},"google_vision_config":{"$ref":"#/components/schemas/GoogleVisionConfig","description":"Configuration for Google Vision integration","title":"Google Vision Config","x-stream-index":"010"},"key":{"description":"Unique identifier for the moderation configuration","title":"Key","type":"string","x-stream-index":"001"},"llm_config":{"$ref":"#/components/schemas/LLMConfig","description":"Configuration for customer-configured LLM moderation","title":"LLM Config","x-stream-index":"009"},"rule_builder_config":{"$ref":"#/components/schemas/RuleBuilderConfig","description":"Configuration for custom rule builder (max 3 rules, max 5 conditions per rule)","title":"Rule Builder Config","x-stream-index":"014"},"team":{"description":"Team associated with the configuration","maxLength":128,"minLength":1,"title":"Team","type":"string","x-stream-index":"002"},"velocity_filter_config":{"$ref":"#/components/schemas/VelocityFilterConfig","description":"Configuration for velocity-based filtering","title":"Velocity Filter Config","x-stream-index":"013"},"video_call_rule_config":{"$ref":"#/components/schemas/VideoCallRuleConfig","x-stream-index":"017"}},"required":["key"],"type":"object"},"UpsertConfigResponse":{"nullable":true,"properties":{"config":{"$ref":"#/components/schemas/ConfigResponse","description":"The created or updated moderation configuration","title":"Config","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["duration"],"type":"object"},"User":{"properties":{"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"046"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"017"},"banned":{"type":"boolean","x-stream-index":"016"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"013"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"023"},"language":{"type":"string","x-stream-index":"035"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"026"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"042"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"005"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"009"}},"required":["id","role","teams_role","custom","banned","online"],"type":"object"},"UserCreatedWithinParameters":{"properties":{"max_age":{"type":"string","x-stream-index":"001"}},"type":"object"},"UserCustomPropertyParameters":{"properties":{"operator":{"type":"string","x-stream-index":"002"},"property_key":{"type":"string","x-stream-index":"001"}},"type":"object"},"UserMute":{"nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"expires":{"description":"Date/time of mute expiration","format":"date-time","title":"Expires","type":"number","x-stream-index":"008"},"target":{"$ref":"#/components/schemas/User","description":"User who's muted","title":"Target","x-stream-index":"007"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/User","description":"Owner of channel mute","title":"User","x-stream-index":"005"}},"required":["created_at","updated_at"],"type":"object"},"UserRequest":{"description":"User request object","properties":{"custom":{"additionalProperties":{},"description":"Custom user data","title":"Custom","type":"object","x-stream-index":"004"},"id":{"description":"User ID","title":"ID","type":"string","x-stream-index":"001"},"image":{"description":"User's profile image URL","title":"Image","type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"006"},"language":{"type":"string","x-stream-index":"005"},"name":{"description":"Optional name of user","title":"Name","type":"string","x-stream-index":"002"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"007"}},"required":["id"],"title":"UserRequest","type":"object"},"UserResponse":{"description":"User response object","properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"banned":{"description":"Whether a user is banned or not","title":"Banned","type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.017"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"001.004"},"deactivated_at":{"description":"Date of deactivation","format":"date-time","title":"Deactivated at","type":"number","x-stream-index":"001.016"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"001.011"},"id":{"description":"Unique user identifier","title":"ID","type":"string","x-stream-index":"001.001"},"image":{"title":"Image","type":"string","x-stream-index":"001.003"},"language":{"description":"Preferred language of a user","title":"Language","type":"string","x-stream-index":"001.005"},"last_active":{"description":"Date of last activity","format":"date-time","title":"Last active","type":"number","x-stream-index":"001.014"},"name":{"description":"Optional name of user","title":"Name","type":"string","x-stream-index":"001.002"},"online":{"description":"Whether a user online or not","title":"Online","type":"boolean","x-stream-index":"001.013"},"revoke_tokens_issued_before":{"description":"Revocation date for tokens","format":"date-time","title":"Revoke tokens issued before","type":"number","x-stream-index":"001.015"},"role":{"description":"Determines the set of user permissions","title":"Role","type":"string","x-stream-index":"001.006"},"teams":{"description":"List of teams user is a part of","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids","shadow_banned","invisible"],"title":"UserResponse","type":"object"},"UserRuleParameters":{"properties":{"max_age":{"type":"string","x-stream-index":"001"}},"type":"object"},"VelocityFilterConfig":{"properties":{"advanced_filters":{"type":"boolean","x-stream-index":"007"},"async":{"type":"boolean","x-stream-index":"001"},"cascading_actions":{"type":"boolean","x-stream-index":"004"},"cids_per_user":{"format":"int32","type":"integer","x-stream-index":"006"},"enabled":{"type":"boolean","x-stream-index":"002"},"first_message_only":{"type":"boolean","x-stream-index":"005"},"rules":{"items":{"$ref":"#/components/schemas/VelocityFilterConfigRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules","cascading_actions","first_message_only","cids_per_user","advanced_filters"],"type":"object"},"VelocityFilterConfigRule":{"properties":{"action":{"enum":["flag","shadow","remove","ban"],"type":"string","x-stream-index":"001"},"ban_duration":{"format":"int32","type":"integer","x-stream-index":"002"},"cascading_action":{"enum":["flag","shadow","remove","ban"],"type":"string","x-stream-index":"006"},"cascading_threshold":{"format":"int64","type":"integer","x-stream-index":"005"},"check_message_context":{"type":"boolean","x-stream-index":"009"},"fast_spam_threshold":{"format":"int32","type":"integer","x-stream-index":"007"},"fast_spam_ttl":{"format":"int32","type":"integer","x-stream-index":"010"},"ip_ban":{"type":"boolean","x-stream-index":"004"},"probation_period":{"format":"int32","type":"integer","x-stream-index":"014"},"shadow_ban":{"type":"boolean","x-stream-index":"003"},"slow_spam_ban_duration":{"format":"int32","type":"integer","x-stream-index":"012"},"slow_spam_threshold":{"format":"int32","type":"integer","x-stream-index":"008"},"slow_spam_ttl":{"format":"int32","type":"integer","x-stream-index":"011"},"url_only":{"type":"boolean","x-stream-index":"013"}},"required":["action","ban_duration","shadow_ban","ip_ban","cascading_threshold","cascading_action","fast_spam_threshold","slow_spam_threshold","check_message_context","fast_spam_ttl","slow_spam_ttl","url_only","probation_period"],"type":"object"},"VideoCallRuleConfig":{"properties":{"rules":{"additionalProperties":{"$ref":"#/components/schemas/HarmConfig"},"type":"object","x-stream-index":"001"}},"required":["rules"],"type":"object"},"VideoContentParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"type":"object"},"VideoEndCallRequest":{"type":"object"},"VideoKickUserRequest":{"type":"object"},"VideoOrientation":{"properties":{"orientation":{"type":"integer","x-stream-index":"004"}},"type":"object"},"VideoRuleParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"type":"object"},"VideoSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"camera_default_on":{"type":"boolean","x-stream-index":"004"},"camera_facing":{"enum":["front","back","external"],"type":"string","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled","target_resolution","camera_default_on","camera_facing"],"type":"object"},"VideoSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"camera_default_on":{"type":"boolean","x-stream-index":"004"},"camera_facing":{"enum":["front","back","external"],"type":"string","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled","target_resolution","camera_default_on","camera_facing"],"type":"object"},"WSEvent":{"description":"The discriminator object for all websocket events, it maps events' payload to the final type","discriminator":{"mapping":{"moderation.custom_action":"#/components/schemas/ModerationCustomActionEvent","moderation.flagged":"#/components/schemas/ModerationFlaggedEvent","moderation.mark_reviewed":"#/components/schemas/ModerationMarkReviewedEvent"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/ModerationCustomActionEvent"},{"$ref":"#/components/schemas/ModerationFlaggedEvent"},{"$ref":"#/components/schemas/ModerationMarkReviewedEvent"}]}},"securitySchemes":{"JWT":{"description":"JWT should be always provided when stream-auth-type=jwt.\n\nUsing JWT auth request could be authenticated as user or as server-side.\n\nWhen using user authentication permission checking is going to be applied to requests based on the user that is\nperforming a request.\n\nThe `authorization` header should be a JWT string signed using the secret attached to the API key used to perform\nrequests.\n\n**WARNING** all client-side official SDK do not ship with token generation; this is to make sure that the API secret is not\nshared with an untrusted party such as a browser or a iOS/Android application. Tokens **must** be generated server-side.\nIf you wish, you can configure your application to ignore authentication (see `disable_auth_check`)\nThe JWT string must include only the user_id claim and can include any built-in JWT claim such as iat, exp as well.\n","in":"header","name":"Authorization","type":"apiKey"},"api_key":{"description":"Application API key should be always set in order to authenticate the request.","in":"query","name":"api_key","type":"apiKey"},"stream-auth-type":{"description":"Stream-Auth-Type should be always set in order to authenticate the request. Possible\nvalues: `jwt` or `anonymous`.\n\n`jwt` allows you to authenticate as a user. With this auth type you should also provide valid JWT in Authorization\nheader.\n\n`anonymous` allows you to authenticate as anonymous user. Please note that most advanced features are not available\nto anonymous users.","in":"header","name":"Stream-Auth-Type","type":"apiKey"}}},"info":{"title":"Stream API","version":"v191.1.0"},"openapi":"3.0.3","paths":{"/api/v2/moderation/ban":{"post":{"description":"Ban a user from a channel or the entire app\n","operationId":"ban","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BanRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BanResponse"}}},"description":"Successful 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":"Ban","tags":["product:moderation"]}},"/api/v2/moderation/config":{"post":{"description":"Create a new moderation configuration or update an existing one. Configure settings for content filtering, AI analysis, toxicity detection, and other moderation features.\n","operationId":"upsert_config","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertConfigRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertConfigResponse"}}},"description":"Successful 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":"Create or update moderation configuration","tags":["product:moderation"]}},"/api/v2/moderation/config/{key}":{"delete":{"description":"Delete a specific moderation policy by its name\n","operationId":"delete_config","parameters":[{"in":"path","name":"key","required":true,"schema":{"description":"Key of the moderation configuration to delete","title":"Key","type":"string","x-stream-index":"001"}},{"in":"query","name":"team","schema":{"description":"Team associated with the configuration","title":"Team","type":"string","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteModerationConfigResponse"}}},"description":"Successful 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":"Delete a moderation policy","tags":["product:moderation"]},"get":{"description":"Retrieve a specific moderation configuration by its key and team. This configuration contains settings for various moderation features like toxicity detection, AI analysis, and filtering rules.\n","operationId":"get_config","parameters":[{"in":"path","name":"key","required":true,"schema":{"description":"Key of the moderation configuration to retrieve","title":"Key","type":"string","x-stream-index":"001"}},{"in":"query","name":"team","schema":{"description":"Team associated with the configuration","title":"Team","type":"string","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetConfigResponse"}}},"description":"Successful 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":"Get moderation configuration","tags":["product:moderation"]}},"/api/v2/moderation/configs":{"post":{"description":"Search and filter moderation configurations across your application. This endpoint is designed for building moderation dashboards and managing multiple configuration sets.\n","operationId":"query_moderation_configs","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationConfigsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationConfigsResponse"}}},"description":"Successful 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":"Query moderation configurations","tags":["product:moderation"]}},"/api/v2/moderation/flag":{"post":{"description":"Flag any type of content (messages, users, channels, activities) for moderation review. Supports custom content types and additional metadata for flagged content.\n","operationId":"flag","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlagRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlagResponse"}}},"description":"Successful 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":"Flag content for moderation","tags":["product:moderation"]}},"/api/v2/moderation/mute":{"post":{"description":"Mute a user. Mutes are generally not visible to the user you mute, while block is something you notice.\n","operationId":"mute","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteRequest"}}},"description":"MuteRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteResponse"}}},"description":"MuteResponse"},"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":"Mute","tags":["product:moderation"]}},"/api/v2/moderation/review_queue":{"post":{"description":"Query review queue items allows you to filter the review queue items. This is used for building a moderation dashboard.\n","operationId":"query_review_queue","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryReviewQueueRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryReviewQueueResponse"}}},"description":"Successful 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":"Query review queue items","tags":["product:moderation"]}},"/api/v2/moderation/submit_action":{"post":{"description":"Take action on flagged content, such as marking content as safe, deleting content, banning users, or executing custom moderation actions. Supports various action types with configurable parameters.\n","operationId":"submit_action","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitActionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitActionResponse"}}},"description":"Successful 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":"Submit moderation action","tags":["product:moderation"]}}},"security":[{"JWT":[],"api_key":[],"stream-auth-type":[]},{"api_key":[],"stream-auth-type":[]}],"servers":[{"description":"Stream API","url":"https://chat.stream-io-api.com"}]} \ No newline at end of file diff --git a/openapi/moderation-clientside-api.yaml b/openapi/moderation-clientside-api.yaml index 3a49ddd72..545e40ecc 100644 --- a/openapi/moderation-clientside-api.yaml +++ b/openapi/moderation-clientside-api.yaml @@ -698,11 +698,6 @@ components: shadow_ban: type: boolean x-stream-index: "003" - required: - - duration - - reason - - shadow_ban - - ip_ban type: object BanRequest: nullable: true @@ -772,8 +767,6 @@ components: reason: type: string x-stream-index: "001" - required: - - reason type: object BlockListConfig: properties: @@ -1837,6 +1830,14 @@ components: $ref: '#/components/schemas/ChannelMember' type: array x-stream-index: "020" + message_count: + format: int64 + type: integer + x-stream-index: "035" + message_count_updated_at: + format: date-time + type: number + x-stream-index: "036" team: type: string x-stream-index: "028" @@ -1867,39 +1868,39 @@ components: items: type: string type: array - x-stream-index: "001.026" + x-stream-index: "001.027" automod: enum: - disabled - simple - AI type: string - x-stream-index: "001.021" + x-stream-index: "001.022" automod_behavior: enum: - flag - block - shadow_block type: string - x-stream-index: "001.022" + x-stream-index: "001.023" automod_thresholds: $ref: '#/components/schemas/Thresholds' - x-stream-index: "001.027" + x-stream-index: "001.028" blocklist: type: string - x-stream-index: "001.023" + x-stream-index: "001.024" blocklist_behavior: enum: - flag - block - shadow_block type: string - x-stream-index: "001.024" + x-stream-index: "001.025" blocklists: items: $ref: '#/components/schemas/BlockListOptions' type: array - x-stream-index: "001.025" + x-stream-index: "001.026" commands: items: type: string @@ -1908,6 +1909,9 @@ components: connect_events: type: boolean x-stream-index: "001.004" + count_messages: + type: boolean + x-stream-index: "001.019" created_at: format: date-time type: number @@ -1922,7 +1926,7 @@ components: format: int32 maximum: 20000 type: integer - x-stream-index: "001.020" + x-stream-index: "001.021" mutes: type: boolean x-stream-index: "001.009" @@ -1932,10 +1936,10 @@ components: partition_size: format: int32 type: integer - x-stream-index: "001.028" + x-stream-index: "001.029" partition_ttl: type: integer - x-stream-index: "001.029" + x-stream-index: "001.030" polls: type: boolean x-stream-index: "001.016" @@ -1965,7 +1969,7 @@ components: x-stream-index: "001.018" skip_last_msg_update_for_system_msgs: type: boolean - x-stream-index: "001.030" + x-stream-index: "001.031" typing_events: type: boolean x-stream-index: "001.002" @@ -2001,6 +2005,7 @@ components: - polls - user_message_reminders - shared_locations + - count_messages - message_retention - max_message_length - automod @@ -2016,39 +2021,39 @@ components: items: type: string type: array - x-stream-index: 001.002.026 + x-stream-index: 001.002.027 automod: enum: - disabled - simple - AI type: string - x-stream-index: 001.002.021 + x-stream-index: 001.002.022 automod_behavior: enum: - flag - block - shadow_block type: string - x-stream-index: 001.002.022 + x-stream-index: 001.002.023 automod_thresholds: $ref: '#/components/schemas/Thresholds' - x-stream-index: 001.002.027 + x-stream-index: 001.002.028 blocklist: type: string - x-stream-index: 001.002.023 + x-stream-index: 001.002.024 blocklist_behavior: enum: - flag - block - shadow_block type: string - x-stream-index: 001.002.024 + x-stream-index: 001.002.025 blocklists: items: $ref: '#/components/schemas/BlockListOptions' type: array - x-stream-index: 001.002.025 + x-stream-index: 001.002.026 commands: items: $ref: '#/components/schemas/Command' @@ -2057,6 +2062,9 @@ components: connect_events: type: boolean x-stream-index: 001.002.004 + count_messages: + type: boolean + x-stream-index: 001.002.019 created_at: format: date-time type: number @@ -2078,7 +2086,7 @@ components: format: int32 maximum: 20000 type: integer - x-stream-index: 001.002.020 + x-stream-index: 001.002.021 mutes: type: boolean x-stream-index: 001.002.009 @@ -2088,10 +2096,10 @@ components: partition_size: format: int32 type: integer - x-stream-index: 001.002.028 + x-stream-index: 001.002.029 partition_ttl: type: integer - x-stream-index: 001.002.029 + x-stream-index: 001.002.030 polls: type: boolean x-stream-index: 001.002.016 @@ -2121,7 +2129,7 @@ components: x-stream-index: 001.002.018 skip_last_msg_update_for_system_msgs: type: boolean - x-stream-index: 001.002.030 + x-stream-index: 001.002.031 typing_events: type: boolean x-stream-index: 001.002.002 @@ -2159,6 +2167,7 @@ components: - polls - user_message_reminders - shared_locations + - count_messages - message_retention - max_message_length - automod @@ -2195,6 +2204,11 @@ components: format: date-time type: number x-stream-index: "014" + deleted_messages: + items: + type: string + type: array + x-stream-index: "027" invite_accepted_at: format: date-time type: number @@ -2343,6 +2357,10 @@ components: $ref: '#/components/schemas/ChannelMember' type: array x-stream-index: "014" + message_count: + format: int64 + type: integer + x-stream-index: "031" mute_expires_at: format: date-time type: number @@ -2452,6 +2470,9 @@ components: type: string type: array x-stream-index: "011" + count_messages: + type: boolean + x-stream-index: "014" grants: additionalProperties: items: @@ -2498,7 +2519,7 @@ components: $ref: '#/components/schemas/AIImageConfig' description: Configuration for AI image analysis title: AI Image Config - x-stream-index: "009" + x-stream-index: "010" ai_text_config: $ref: '#/components/schemas/AITextConfig' description: Configuration for AI text analysis @@ -2508,7 +2529,7 @@ components: $ref: '#/components/schemas/AIVideoConfig' description: Configuration for AI video analysis title: AI Video Config - x-stream-index: "010" + x-stream-index: "011" async: description: Whether moderation should be performed asynchronously title: Async @@ -2539,15 +2560,17 @@ components: format: date-time title: Created At type: number - x-stream-index: "012" + x-stream-index: "013" key: description: Unique identifier for the moderation configuration title: Key type: string x-stream-index: "001" - rule_builder_config: - $ref: '#/components/schemas/RuleBuilderConfig' - x-stream-index: "015" + llm_config: + $ref: '#/components/schemas/LLMConfig' + description: Configuration for customer-configured LLM moderation + title: LLM Config + x-stream-index: "009" team: description: Team associated with the configuration title: Team @@ -2558,15 +2581,15 @@ components: format: date-time title: Updated At type: number - x-stream-index: "013" + x-stream-index: "014" velocity_filter_config: $ref: '#/components/schemas/VelocityFilterConfig' description: Configuration for velocity-based filtering title: Velocity Filter Config - x-stream-index: "011" + x-stream-index: "012" video_call_rule_config: $ref: '#/components/schemas/VideoCallRuleConfig' - x-stream-index: "014" + x-stream-index: "015" required: - key - team @@ -2583,9 +2606,6 @@ components: time_window: type: string x-stream-index: "002" - required: - - threshold - - time_window type: object CustomActionRequest: properties: @@ -3227,6 +3247,21 @@ components: type: object x-stream-index: "001" type: object + FeedsEventPreferences: + properties: + comments: + type: string + x-stream-index: "002" + mentions: + type: string + x-stream-index: "004" + new_followers: + type: string + x-stream-index: "003" + reactions: + type: string + x-stream-index: "001" + type: object Field: nullable: true properties: @@ -3341,8 +3376,6 @@ components: reason: type: string x-stream-index: "001" - required: - - reason type: object FlagRequest: nullable: true @@ -3403,8 +3436,6 @@ components: reason: type: string x-stream-index: "001" - required: - - reason type: object FrameRecordSettings: properties: @@ -3637,9 +3668,6 @@ components: time_window: type: string x-stream-index: "002" - required: - - threshold - - time_window type: object Images: properties: @@ -3824,6 +3852,61 @@ components: - max_dimension - frame_rate_limit type: object + LLMConfig: + properties: + app_context: + type: string + x-stream-index: "005" + async: + type: boolean + x-stream-index: "001" + enabled: + type: boolean + x-stream-index: "002" + rules: + items: + $ref: '#/components/schemas/LLMRule' + type: array + x-stream-index: "003" + severity_descriptions: + additionalProperties: + type: string + type: object + x-stream-index: "004" + required: + - enabled + - rules + type: object + LLMRule: + properties: + action: + enum: + - flag + - shadow + - remove + - bounce + - bounce_flag + - bounce_remove + - keep + type: string + x-stream-index: "003" + description: + type: string + x-stream-index: "002" + label: + type: string + x-stream-index: "001" + severity_rules: + items: + $ref: '#/components/schemas/BodyguardSeverityRule' + type: array + x-stream-index: "004" + required: + - label + - description + - action + - severity_rules + type: object LabelThresholds: properties: block: @@ -3959,6 +4042,9 @@ components: format: date-time type: number x-stream-index: "033" + deleted_for_me: + type: boolean + x-stream-index: "059" deleted_reply_count: format: int32 type: integer @@ -4198,6 +4284,9 @@ components: title: Deleted at type: number x-stream-index: "025" + deleted_for_me: + type: boolean + x-stream-index: "044" deleted_reply_count: format: int32 type: integer @@ -4504,6 +4593,71 @@ components: x-stream-event-doc-group: other x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent + ModerationFlagResponse: + nullable: true + properties: + created_at: + format: date-time + type: number + x-stream-index: "015" + custom: + additionalProperties: {} + type: object + x-stream-index: "010" + entity_creator_id: + type: string + x-stream-index: "007" + entity_id: + type: string + x-stream-index: "006" + entity_type: + type: string + x-stream-index: "005" + labels: + items: + type: string + type: array + x-stream-index: "011" + moderation_payload: + $ref: '#/components/schemas/ModerationPayload' + x-stream-index: "008" + reason: + type: string + x-stream-index: "009" + result: + items: + additionalProperties: {} + type: object + type: array + x-stream-index: "012" + review_queue_item: + $ref: '#/components/schemas/ReviewQueueItemResponse' + x-stream-index: "014" + review_queue_item_id: + type: string + x-stream-index: "013" + type: + type: string + x-stream-index: "002" + updated_at: + format: date-time + type: number + x-stream-index: "016" + user: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "004" + user_id: + type: string + x-stream-index: "003" + required: + - type + - user_id + - entity_type + - entity_id + - result + - created_at + - updated_at + type: object ModerationFlaggedEvent: properties: created_at: @@ -5210,6 +5364,12 @@ components: disabled_until: format: date-time type: number + x-stream-index: "005" + feeds_events: + $ref: '#/components/schemas/FeedsEventPreferences' + x-stream-index: "004" + feeds_level: + type: string x-stream-index: "003" type: object Quality: @@ -5960,7 +6120,7 @@ components: flags: description: Associated flag records items: - $ref: '#/components/schemas/FlagResponse' + $ref: '#/components/schemas/ModerationFlagResponse' title: Flags type: array x-stream-index: "023" @@ -6105,8 +6265,6 @@ components: type: type: string x-stream-index: "001" - required: - - type type: object RuleBuilderCondition: properties: @@ -6135,6 +6293,9 @@ components: user_created_within_params: $ref: '#/components/schemas/UserCreatedWithinParameters' x-stream-index: "011" + user_custom_property_params: + $ref: '#/components/schemas/UserCustomPropertyParameters' + x-stream-index: "012" user_rule_params: $ref: '#/components/schemas/UserRuleParameters' x-stream-index: "006" @@ -6144,8 +6305,6 @@ components: video_rule_params: $ref: '#/components/schemas/VideoRuleParameters' x-stream-index: "005" - required: - - type type: object RuleBuilderConditionGroup: properties: @@ -6157,9 +6316,6 @@ components: logic: type: string x-stream-index: "001" - required: - - logic - - conditions type: object RuleBuilderConfig: properties: @@ -6171,48 +6327,37 @@ components: $ref: '#/components/schemas/RuleBuilderRule' type: array x-stream-index: "002" - required: - - rules type: object RuleBuilderRule: properties: action: $ref: '#/components/schemas/RuleBuilderAction' - x-stream-index: "007" + x-stream-index: "006" conditions: items: $ref: '#/components/schemas/RuleBuilderCondition' type: array - x-stream-index: "004" + x-stream-index: "003" cooldown_period: type: string - x-stream-index: "009" - enabled: - type: boolean - x-stream-index: "008" + x-stream-index: "007" groups: items: $ref: '#/components/schemas/RuleBuilderConditionGroup' type: array - x-stream-index: "006" + x-stream-index: "005" id: type: string x-stream-index: "001" logic: type: string - x-stream-index: "005" - name: - type: string - x-stream-index: "002" + x-stream-index: "004" rule_type: type: string - x-stream-index: "003" + x-stream-index: "002" required: - - id - - name - rule_type - action - - enabled type: object SFUIDLastSeen: properties: @@ -6550,18 +6695,23 @@ components: items: type: string type: array - x-stream-index: "004" + x-stream-index: "005" contains_url: type: boolean - x-stream-index: "002" + x-stream-index: "003" harm_labels: items: type: string type: array x-stream-index: "001" + llm_harm_labels: + additionalProperties: + type: string + type: object + x-stream-index: "002" severity: type: string - x-stream-index: "003" + x-stream-index: "004" type: object TextRuleParameters: properties: @@ -6569,18 +6719,23 @@ components: items: type: string type: array - x-stream-index: "006" + x-stream-index: "007" contains_url: type: boolean - x-stream-index: "004" + x-stream-index: "005" harm_labels: items: type: string type: array x-stream-index: "003" + llm_harm_labels: + additionalProperties: + type: string + type: object + x-stream-index: "004" severity: type: string - x-stream-index: "005" + x-stream-index: "006" threshold: format: int32 type: integer @@ -6588,9 +6743,6 @@ components: time_window: type: string x-stream-index: "002" - required: - - threshold - - time_window type: object Thresholds: properties: @@ -6785,7 +6937,7 @@ components: $ref: '#/components/schemas/AIImageConfig' description: Configuration for AI image analysis title: AI Image Config - x-stream-index: "010" + x-stream-index: "011" ai_text_config: $ref: '#/components/schemas/AITextConfig' description: Configuration for AI text analysis @@ -6795,7 +6947,7 @@ components: $ref: '#/components/schemas/AIVideoConfig' description: Configuration for AI video analysis title: AI Video Config - x-stream-index: "011" + x-stream-index: "012" async: description: Whether moderation should be performed asynchronously title: Async @@ -6818,7 +6970,7 @@ components: x-stream-index: "004" aws_rekognition_config: $ref: '#/components/schemas/AIImageConfig' - x-stream-index: "015" + x-stream-index: "016" block_list_config: $ref: '#/components/schemas/BlockListConfig' description: Configuration for block list filtering @@ -6826,23 +6978,28 @@ components: x-stream-index: "007" bodyguard_config: $ref: '#/components/schemas/AITextConfig' - x-stream-index: "014" + x-stream-index: "015" google_vision_config: $ref: '#/components/schemas/GoogleVisionConfig' description: Configuration for Google Vision integration title: Google Vision Config - x-stream-index: "009" + x-stream-index: "010" key: description: Unique identifier for the moderation configuration title: Key type: string x-stream-index: "001" + llm_config: + $ref: '#/components/schemas/LLMConfig' + description: Configuration for customer-configured LLM moderation + title: LLM Config + x-stream-index: "009" rule_builder_config: $ref: '#/components/schemas/RuleBuilderConfig' description: Configuration for custom rule builder (max 3 rules, max 5 conditions per rule) title: Rule Builder Config - x-stream-index: "013" + x-stream-index: "014" team: description: Team associated with the configuration maxLength: 128 @@ -6854,10 +7011,10 @@ components: $ref: '#/components/schemas/VelocityFilterConfig' description: Configuration for velocity-based filtering title: Velocity Filter Config - x-stream-index: "012" + x-stream-index: "013" video_call_rule_config: $ref: '#/components/schemas/VideoCallRuleConfig' - x-stream-index: "016" + x-stream-index: "017" required: - key type: object @@ -6970,6 +7127,15 @@ components: type: string x-stream-index: "001" type: object + UserCustomPropertyParameters: + properties: + operator: + type: string + x-stream-index: "002" + property_key: + type: string + x-stream-index: "001" + type: object UserMute: nullable: true properties: @@ -7316,9 +7482,6 @@ components: time_window: type: string x-stream-index: "002" - required: - - threshold - - time_window type: object VideoSettings: properties: @@ -7430,7 +7593,7 @@ components: type: apiKey info: title: Stream API - version: v187.13.0 + version: v191.1.0 openapi: 3.0.3 paths: /api/v2/moderation/ban: diff --git a/openapi/moderation-serverside-api.json b/openapi/moderation-serverside-api.json index 20e6787f4..c5fbcd47b 100644 --- a/openapi/moderation-serverside-api.json +++ b/openapi/moderation-serverside-api.json @@ -1 +1 @@ -{"components":{"schemas":{"AIImageConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"ocr_rules":{"items":{"$ref":"#/components/schemas/OCRRule"},"type":"array","x-stream-index":"004"},"rules":{"items":{"$ref":"#/components/schemas/AWSRekognitionRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules","ocr_rules"],"type":"object"},"AITextConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"profile":{"type":"string","x-stream-index":"003"},"rules":{"items":{"$ref":"#/components/schemas/BodyguardRule"},"type":"array","x-stream-index":"004"},"severity_rules":{"items":{"$ref":"#/components/schemas/BodyguardSeverityRule"},"type":"array","x-stream-index":"005"}},"required":["enabled","profile","rules","severity_rules"],"type":"object"},"AIVideoConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AWSRekognitionRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"APIError":{"nullable":true,"properties":{"StatusCode":{"description":"Response HTTP status code","format":"int32","title":"Status code","type":"integer","x-stream-index":"004"},"code":{"description":"API error code","format":"int32","title":"Code","type":"integer","x-stream-index":"001"},"details":{"description":"Additional error-specific information","items":{"type":"integer"},"title":"Details","type":"array","x-stream-index":"007"},"duration":{"description":"Request duration","title":"Duration","type":"string","x-stream-index":"005"},"exception_fields":{"additionalProperties":{"type":"string"},"description":"Additional error info","title":"Exception fields","type":"object","x-stream-index":"003"},"message":{"description":"Message describing an error","title":"Message","type":"string","x-stream-index":"002"},"more_info":{"description":"URL with additional information","title":"More info","type":"string","x-stream-index":"006"},"unrecoverable":{"description":"Flag that indicates if the error is unrecoverable, requests that return unrecoverable errors should not be retried, this error only applies to the request that caused it","title":"Unrecoverable","type":"boolean","x-stream-index":"008"}},"required":["code","message","StatusCode","duration","more_info","details"],"title":"Error response","type":"object"},"APNS":{"properties":{"body":{"type":"string","x-stream-index":"002"},"content-available":{"format":"int32","type":"integer","x-stream-index":"004"},"data":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"mutable-content":{"format":"int32","type":"integer","x-stream-index":"005"},"sound":{"type":"string","x-stream-index":"003"},"title":{"type":"string","x-stream-index":"001"}},"required":["title","body"],"type":"object"},"AWSRekognitionRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"},"min_confidence":{"format":"float","maximum":100,"minimum":0,"type":"number","x-stream-index":"003"}},"required":["label","action","min_confidence"],"type":"object"},"Action":{"nullable":true,"properties":{"name":{"type":"string","x-stream-index":"001"},"style":{"type":"string","x-stream-index":"003"},"text":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"004"},"value":{"type":"string","x-stream-index":"005"}},"required":["name","text","type"],"type":"object"},"ActionLog":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"002"},"reason":{"type":"string","x-stream-index":"008"},"reporter_type":{"type":"string","x-stream-index":"009"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"014"},"review_queue_item_id":{"type":"string","x-stream-index":"012"},"target_user":{"$ref":"#/components/schemas/User","x-stream-index":"013"},"target_user_id":{"type":"string","x-stream-index":"011"},"type":{"type":"string","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007"}},"required":["id","created_at","type","reason","reporter_type","custom","target_user_id","review_queue_item_id"],"type":"object"},"ActionLogResponse":{"nullable":true,"properties":{"created_at":{"description":"Timestamp when the action was taken","format":"date-time","title":"Created At","type":"number","x-stream-index":"002"},"custom":{"additionalProperties":{},"description":"Additional metadata about the action","title":"Custom","type":"object","x-stream-index":"007"},"id":{"description":"Unique identifier of the action log","title":"ID","type":"string","x-stream-index":"001"},"reason":{"description":"Reason for the moderation action","title":"Reason","type":"string","x-stream-index":"006"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"Associated review queue item","title":"Review Queue Item","x-stream-index":"008"},"target_user":{"$ref":"#/components/schemas/UserResponse","description":"User who was the target of the action","title":"Target User","x-stream-index":"009"},"target_user_id":{"description":"ID of the user who was the target of the action","title":"Target User ID","type":"string","x-stream-index":"010"},"type":{"description":"Type of moderation action","title":"Type","type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who performed the action","title":"User","x-stream-index":"004"},"user_id":{"description":"ID of the user who performed the action","title":"User ID","type":"string","x-stream-index":"005"}},"required":["id","created_at","type","user_id","reason","custom","target_user_id"],"type":"object"},"ActionSequence":{"properties":{"action":{"type":"string","x-stream-index":"001"},"blur":{"type":"boolean","x-stream-index":"005"},"cooldown_period":{"format":"int32","type":"integer","x-stream-index":"004"},"threshold":{"format":"int32","type":"integer","x-stream-index":"002"},"time_window":{"format":"int32","type":"integer","x-stream-index":"003"},"warning":{"type":"boolean","x-stream-index":"006"},"warning_text":{"type":"string","x-stream-index":"007"}},"required":["action","threshold","time_window","cooldown_period","blur","warning","warning_text"],"type":"object"},"AsyncBulkImageModerationEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"003.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.007"},"finished_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.004"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"task_id":{"type":"string","x-stream-index":"002.001"},"type":{"default":"export.bulk_image_moderation.success","type":"string","x-stream-index":"003.002"},"url":{"type":"string","x-stream-index":"001"}},"required":["url","task_id","started_at","finished_at","type","created_at","custom"],"title":"AsyncBulkImageModerationEvent","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"},"AsyncExportErrorEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"003.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.007"},"error":{"type":"string","x-stream-index":"001"},"finished_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.004"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"task_id":{"type":"string","x-stream-index":"002.001"},"type":{"default":"export.moderation_logs.error","type":"string","x-stream-index":"003.002"}},"required":["error","task_id","started_at","finished_at","type","created_at","custom"],"title":"AsyncExportErrorEvent","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"},"AsyncExportModerationLogsEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"003.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.007"},"finished_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.004"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"task_id":{"type":"string","x-stream-index":"002.001"},"type":{"default":"export.moderation_logs.success","type":"string","x-stream-index":"003.002"},"url":{"type":"string","x-stream-index":"001"}},"required":["url","task_id","started_at","finished_at","type","created_at","custom"],"title":"AsyncExportModerationLogsEvent","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"},"Attachment":{"description":"An attachment is a message object that represents a file uploaded by a user.","nullable":true,"properties":{"actions":{"items":{"$ref":"#/components/schemas/Action"},"type":"array","x-stream-index":"015"},"asset_url":{"type":"string","x-stream-index":"017"},"author_icon":{"type":"string","x-stream-index":"007"},"author_link":{"type":"string","x-stream-index":"006"},"author_name":{"type":"string","x-stream-index":"005"},"color":{"type":"string","x-stream-index":"003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"018"},"fallback":{"type":"string","x-stream-index":"002"},"fields":{"items":{"$ref":"#/components/schemas/Field"},"type":"array","x-stream-index":"016"},"footer":{"type":"string","x-stream-index":"013"},"footer_icon":{"type":"string","x-stream-index":"014"},"giphy":{"$ref":"#/components/schemas/Images","x-stream-index":"019"},"image_url":{"type":"string","x-stream-index":"011"},"og_scrape_url":{"type":"string","x-stream-index":"020"},"original_height":{"format":"int32","type":"integer","x-stream-index":"022"},"original_width":{"format":"int32","type":"integer","x-stream-index":"021"},"pretext":{"type":"string","x-stream-index":"004"},"text":{"type":"string","x-stream-index":"010"},"thumb_url":{"type":"string","x-stream-index":"012"},"title":{"type":"string","x-stream-index":"008"},"title_link":{"type":"string","x-stream-index":"009"},"type":{"description":"Attachment type (e.g. image, video, url)","title":"Type","type":"string","x-stream-index":"001"}},"required":["custom"],"title":"Attachment","type":"object","x-stream-docs-page-id":"file_uploads"},"AudioSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"001"},"default_device":{"enum":["speaker","earpiece"],"type":"string","x-stream-index":"006"},"mic_default_on":{"type":"boolean","x-stream-index":"004"},"noise_cancellation":{"$ref":"#/components/schemas/NoiseCancellationSettings","x-stream-index":"007"},"opus_dtx_enabled":{"type":"boolean","x-stream-index":"002"},"redundant_coding_enabled":{"type":"boolean","x-stream-index":"003"},"speaker_default_on":{"type":"boolean","x-stream-index":"005"}},"required":["access_request_enabled","opus_dtx_enabled","redundant_coding_enabled","mic_default_on","speaker_default_on","default_device"],"type":"object"},"AudioSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"001"},"default_device":{"enum":["speaker","earpiece"],"type":"string","x-stream-index":"006"},"mic_default_on":{"type":"boolean","x-stream-index":"004"},"noise_cancellation":{"$ref":"#/components/schemas/NoiseCancellationSettings","x-stream-index":"007"},"opus_dtx_enabled":{"type":"boolean","x-stream-index":"002"},"redundant_coding_enabled":{"type":"boolean","x-stream-index":"003"},"speaker_default_on":{"type":"boolean","x-stream-index":"005"}},"required":["access_request_enabled","opus_dtx_enabled","redundant_coding_enabled","mic_default_on","speaker_default_on","default_device"],"type":"object"},"AutomodPlatformCircumventionConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AutomodRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"AutomodRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"003"},"label":{"type":"string","x-stream-index":"001"},"threshold":{"format":"float","maximum":1,"minimum":0,"type":"number","x-stream-index":"002"}},"required":["label","threshold","action"],"type":"object"},"AutomodSemanticFiltersConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AutomodSemanticFiltersRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"AutomodSemanticFiltersRule":{"properties":{"action":{"enum":["flag","shadow","remove"],"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"threshold":{"format":"float","maximum":1,"minimum":0,"type":"number","x-stream-index":"002"}},"required":["name","threshold","action"],"type":"object"},"AutomodToxicityConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AutomodRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"BackstageSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"BackstageSettingsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"Ban":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"012"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"011"},"expires":{"format":"date-time","type":"number","x-stream-index":"007"},"reason":{"type":"string","x-stream-index":"008"},"shadow":{"type":"boolean","x-stream-index":"009"},"target":{"$ref":"#/components/schemas/User","x-stream-index":"006"}},"required":["shadow","created_at"],"type":"object"},"BanActionRequest":{"properties":{"channel_ban_only":{"type":"boolean","x-stream-index":"003"},"delete_messages":{"enum":["soft","pruning","hard"],"type":"string","x-stream-index":"005"},"ip_ban":{"type":"boolean","x-stream-index":"004"},"reason":{"type":"string","x-stream-index":"002"},"shadow":{"type":"boolean","x-stream-index":"001"},"timeout":{"format":"int32","type":"integer","x-stream-index":"006"}},"type":"object"},"BanOptions":{"properties":{"duration":{"format":"int32","type":"integer","x-stream-index":"001"},"ip_ban":{"type":"boolean","x-stream-index":"004"},"reason":{"type":"string","x-stream-index":"002"},"shadow_ban":{"type":"boolean","x-stream-index":"003"}},"required":["duration","reason","shadow_ban","ip_ban"],"type":"object"},"BanRequest":{"nullable":true,"properties":{"banned_by":{"$ref":"#/components/schemas/UserRequest","description":"Details about the user performing the ban","title":"Banned By","x-stream-index":"008"},"banned_by_id":{"description":"ID of the user performing the ban","title":"Banned By ID","type":"string","x-stream-index":"007"},"channel_cid":{"description":"Channel where the ban applies","title":"Channel CID","type":"string","x-stream-index":"004"},"delete_messages":{"enum":["soft","pruning","hard"],"type":"string","x-stream-index":"009"},"ip_ban":{"description":"Whether to ban the user's IP address","title":"IP Ban","type":"boolean","x-stream-index":"006"},"reason":{"description":"Optional explanation for the ban","title":"Reason","type":"string","x-stream-index":"003"},"shadow":{"description":"Whether this is a shadow ban","title":"Shadow","type":"boolean","x-stream-index":"005"},"target_user_id":{"description":"ID of the user to ban","title":"Target User ID","type":"string","x-stream-index":"001"},"timeout":{"description":"Duration of the ban in minutes","minimum":0,"title":"Timeout","type":"integer","x-stream-index":"002"}},"required":["target_user_id"],"type":"object"},"BanResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"BlockContentOptions":{"properties":{"reason":{"type":"string","x-stream-index":"001"}},"required":["reason"],"type":"object"},"BlockListConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/BlockListRule"},"maximum":10,"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"BlockListOptions":{"properties":{"behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"002"},"blocklist":{"type":"string","x-stream-index":"001"}},"required":["blocklist","behavior"],"type":"object"},"BlockListRule":{"properties":{"action":{"enum":["flag","mask_flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"002"}},"required":["name","team","action"],"type":"object"},"BodyguardRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"},"severity_rules":{"items":{"$ref":"#/components/schemas/BodyguardSeverityRule"},"type":"array","x-stream-index":"003"}},"required":["label","action","severity_rules"],"type":"object"},"BodyguardSeverityRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"severity":{"enum":["low","medium","high","critical"],"type":"string","x-stream-index":"001"}},"required":["severity","action"],"type":"object"},"BroadcastSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettings","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettings","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"BroadcastSettingsResponse":{"description":"BroadcastSettingsResponse is the payload for broadcasting settings","properties":{"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettingsResponse","title":"HLS","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettingsResponse","title":"RTMP","x-stream-index":"003"}},"required":["enabled","hls","rtmp"],"title":"BroadcastSettingsResponse","type":"object"},"BulkImageModerationRequest":{"nullable":true,"properties":{"csv_file":{"description":"URL to CSV file containing image URLs to moderate","title":"string","type":"string","x-stream-index":"001"}},"required":["csv_file"],"type":"object"},"BulkImageModerationResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"task_id":{"description":"ID of the task for processing the bulk image moderation","title":"string","type":"string","x-stream-index":"001"}},"required":["task_id","duration"],"type":"object"},"Call":{"properties":{"AppPK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"002"},"Backstage":{"type":"boolean","writeOnly":true,"x-stream-index":"023"},"BlockedUserIDs":{"items":{"type":"string"},"type":"array","writeOnly":true,"x-stream-index":"018"},"BlockedUsers":{"items":{"$ref":"#/components/schemas/User"},"type":"array","writeOnly":true,"x-stream-index":"019"},"CID":{"type":"string","writeOnly":true,"x-stream-index":"005"},"CallType":{"$ref":"#/components/schemas/CallType","x-stream-index":"020"},"ChannelCID":{"type":"string","writeOnly":true,"x-stream-index":"032"},"CreatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"013"},"CreatedBy":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"CreatedByUserID":{"type":"string","writeOnly":true,"x-stream-index":"007"},"CurrentSessionID":{"type":"string","writeOnly":true,"x-stream-index":"024"},"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"012"},"DeletedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"028"},"EgressUpdatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"027"},"Egresses":{"items":{"$ref":"#/components/schemas/CallEgress"},"type":"array","writeOnly":true,"x-stream-index":"015"},"EndedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"017"},"ID":{"type":"string","writeOnly":true,"x-stream-index":"004"},"JoinAheadTimeSeconds":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"031"},"LastHeartbeatAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"030"},"LastSessionID":{"type":"string","writeOnly":true,"x-stream-index":"025"},"MemberCount":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"010"},"MemberLookup":{"$ref":"#/components/schemas/MemberLookup","x-stream-index":"011"},"Members":{"items":{"$ref":"#/components/schemas/CallMember"},"type":"array","writeOnly":true,"x-stream-index":"009"},"Session":{"$ref":"#/components/schemas/CallSession","x-stream-index":"026"},"Settings":{"$ref":"#/components/schemas/CallSettings","x-stream-index":"022"},"SettingsOverrides":{"$ref":"#/components/schemas/CallSettings","x-stream-index":"021"},"StartsAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"016"},"Team":{"type":"string","writeOnly":true,"x-stream-index":"006"},"ThumbnailURL":{"type":"string","writeOnly":true,"x-stream-index":"029"},"Type":{"type":"string","writeOnly":true,"x-stream-index":"003"},"UpdatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"014"}},"required":["AppPK","Type","ID","CID","Team","CreatedByUserID","Members","Custom","CreatedAt","UpdatedAt","Egresses","BlockedUserIDs","BlockedUsers","Backstage","CurrentSessionID","LastSessionID","ThumbnailURL","ChannelCID"],"type":"object"},"CallEgress":{"nullable":true,"properties":{"app_pk":{"format":"int32","type":"integer","x-stream-index":"002"},"call_id":{"type":"string","x-stream-index":"004"},"call_type":{"type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/EgressTaskConfig","x-stream-index":"007"},"egress_id":{"type":"string","x-stream-index":"005"},"egress_type":{"type":"string","x-stream-index":"006"},"instance_ip":{"type":"string","x-stream-index":"008"},"started_at":{"format":"date-time","type":"number","x-stream-index":"010"},"state":{"type":"string","x-stream-index":"009"},"stopped_at":{"format":"date-time","type":"number","x-stream-index":"011"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"012"}},"required":["app_pk","call_type","call_id","egress_id","egress_type","instance_ip","state","started_at","updated_at"],"type":"object"},"CallIngressResponse":{"description":"CallIngressResponse is the payload for ingress settings","properties":{"rtmp":{"$ref":"#/components/schemas/RTMPIngress","title":"RTMP","x-stream-index":"001"}},"required":["rtmp"],"title":"CallIngressResponse","type":"object"},"CallMember":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"010"},"role":{"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["user_id","role","custom","created_at","updated_at"],"type":"object"},"CallParticipant":{"nullable":true,"properties":{"JoinedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"004"},"Role":{"type":"string","writeOnly":true,"x-stream-index":"002"},"UserSessionID":{"type":"string","writeOnly":true,"x-stream-index":"003"},"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"001.046"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"001.017"},"banned":{"type":"boolean","x-stream-index":"001.016"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.013"},"id":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"001.023"},"language":{"type":"string","x-stream-index":"001.035"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"001.022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"001.026"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.042"},"role":{"type":"string","x-stream-index":"001.004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.005"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.009"}},"required":["id","role","teams_role","custom","banned","online","Role","UserSessionID","JoinedAt"],"type":"object"},"CallParticipantResponse":{"properties":{"joined_at":{"format":"date-time","type":"number","x-stream-index":"004"},"role":{"type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"},"user_session_id":{"type":"string","x-stream-index":"002"}},"required":["user","user_session_id","role","joined_at"],"type":"object"},"CallResponse":{"description":"Represents a call","properties":{"backstage":{"type":"boolean","x-stream-index":"016"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"018"},"captioning":{"type":"boolean","x-stream-index":"013"},"channel_cid":{"type":"string","x-stream-index":"024"},"cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"The user that created the call","title":"Created By","x-stream-index":"007"},"current_session_id":{"type":"string","x-stream-index":"005"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"008"},"egress":{"$ref":"#/components/schemas/EgressResponse","x-stream-index":"021"},"ended_at":{"description":"Date/time when the call ended","format":"date-time","title":"Ended At","type":"number","x-stream-index":"014"},"id":{"description":"Call ID","title":"ID","type":"string","x-stream-index":"003"},"ingress":{"$ref":"#/components/schemas/CallIngressResponse","x-stream-index":"019"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"023"},"recording":{"type":"boolean","x-stream-index":"011"},"session":{"$ref":"#/components/schemas/CallSessionResponse","x-stream-index":"020"},"settings":{"$ref":"#/components/schemas/CallSettingsResponse","x-stream-index":"017"},"starts_at":{"description":"Date/time when the call will start","format":"date-time","title":"Starts At","type":"number","x-stream-index":"015"},"team":{"type":"string","x-stream-index":"006"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailResponse","x-stream-index":"022"},"transcribing":{"type":"boolean","x-stream-index":"012"},"type":{"description":"The type of call","title":"Type","type":"string","x-stream-index":"002"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"}},"required":["type","id","cid","current_session_id","created_by","custom","created_at","updated_at","recording","transcribing","captioning","backstage","settings","blocked_user_ids","ingress","egress"],"title":"CallResponse","type":"object"},"CallSession":{"properties":{"AcceptedBy":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","writeOnly":true,"x-stream-index":"008"},"ActiveSFUs":{"items":{"$ref":"#/components/schemas/SFUIDLastSeen"},"type":"array","writeOnly":true,"x-stream-index":"016"},"AnonymousParticipantCount":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"019"},"AppPK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"002.001"},"CallID":{"type":"string","writeOnly":true,"x-stream-index":"002.003"},"CallType":{"type":"string","writeOnly":true,"x-stream-index":"002.002"},"CreatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"003"},"DeletedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"004"},"EndedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"006"},"LiveEndedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"013"},"LiveStartedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"012"},"MissedBy":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","writeOnly":true,"x-stream-index":"010"},"Participants":{"items":{"$ref":"#/components/schemas/CallParticipant"},"type":"array","writeOnly":true,"x-stream-index":"011"},"ParticipantsCountByRole":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","writeOnly":true,"x-stream-index":"018"},"RejectedBy":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","writeOnly":true,"x-stream-index":"009"},"RingAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"007"},"SFUIDs":{"items":{"type":"string"},"type":"array","writeOnly":true,"x-stream-index":"015"},"SessionID":{"type":"string","writeOnly":true,"x-stream-index":"002.004"},"StartedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"005"},"TimerEndsAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"014"},"UserPermissionOverrides":{"additionalProperties":{"additionalProperties":{"type":"boolean"},"type":"object"},"type":"object","writeOnly":true,"x-stream-index":"017"}},"required":["AppPK","CallType","CallID","SessionID","CreatedAt","AcceptedBy","RejectedBy","MissedBy","Participants","SFUIDs","ActiveSFUs","UserPermissionOverrides","ParticipantsCountByRole","AnonymousParticipantCount"],"type":"object"},"CallSessionResponse":{"properties":{"accepted_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"008"},"anonymous_participant_count":{"format":"int32","type":"integer","x-stream-index":"006"},"ended_at":{"format":"date-time","type":"number","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"live_ended_at":{"format":"date-time","type":"number","x-stream-index":"011"},"live_started_at":{"format":"date-time","type":"number","x-stream-index":"010"},"missed_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"009"},"participants":{"items":{"$ref":"#/components/schemas/CallParticipantResponse"},"type":"array","x-stream-index":"004"},"participants_count_by_role":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"005"},"rejected_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"007"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002"},"timer_ends_at":{"format":"date-time","type":"number","x-stream-index":"012"}},"required":["id","participants","participants_count_by_role","anonymous_participant_count","rejected_by","accepted_by","missed_by"],"type":"object"},"CallSettings":{"properties":{"audio":{"$ref":"#/components/schemas/AudioSettings","x-stream-index":"001"},"backstage":{"$ref":"#/components/schemas/BackstageSettings","x-stream-index":"002"},"broadcasting":{"$ref":"#/components/schemas/BroadcastSettings","x-stream-index":"007"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordSettings","x-stream-index":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettings","x-stream-index":"008"},"ingress":{"$ref":"#/components/schemas/IngressSettings","x-stream-index":"014"},"limits":{"$ref":"#/components/schemas/LimitsSettings","x-stream-index":"012"},"recording":{"$ref":"#/components/schemas/RecordSettings","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettings","x-stream-index":"010"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettings","x-stream-index":"004"},"session":{"$ref":"#/components/schemas/SessionSettings","x-stream-index":"013"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettings","x-stream-index":"011"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettings","x-stream-index":"009"},"video":{"$ref":"#/components/schemas/VideoSettings","x-stream-index":"003"}},"type":"object"},"CallSettingsResponse":{"properties":{"audio":{"$ref":"#/components/schemas/AudioSettingsResponse","x-stream-index":"001"},"backstage":{"$ref":"#/components/schemas/BackstageSettingsResponse","x-stream-index":"002"},"broadcasting":{"$ref":"#/components/schemas/BroadcastSettingsResponse","x-stream-index":"003"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordingSettingsResponse","x-stream-index":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettingsResponse","x-stream-index":"004"},"ingress":{"$ref":"#/components/schemas/IngressSettingsResponse","x-stream-index":"014"},"limits":{"$ref":"#/components/schemas/LimitsSettingsResponse","x-stream-index":"012"},"recording":{"$ref":"#/components/schemas/RecordSettingsResponse","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettingsResponse","x-stream-index":"007"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettingsResponse","x-stream-index":"008"},"session":{"$ref":"#/components/schemas/SessionSettingsResponse","x-stream-index":"013"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettingsResponse","x-stream-index":"011"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettingsResponse","x-stream-index":"009"},"video":{"$ref":"#/components/schemas/VideoSettingsResponse","x-stream-index":"010"}},"required":["audio","backstage","broadcasting","geofencing","recording","frame_recording","ring","screensharing","transcription","video","thumbnails","limits","session"],"type":"object"},"CallType":{"properties":{"AppPK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"003"},"CreatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"005"},"ExternalStorage":{"type":"string","writeOnly":true,"x-stream-index":"009"},"Name":{"type":"string","writeOnly":true,"x-stream-index":"004"},"NotificationSettings":{"$ref":"#/components/schemas/NotificationSettings","x-stream-index":"008"},"PK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"002"},"Settings":{"$ref":"#/components/schemas/CallSettings","x-stream-index":"007"},"UpdatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"006"}},"required":["PK","AppPK","Name","CreatedAt","UpdatedAt","ExternalStorage"],"type":"object"},"Channel":{"properties":{"active_live_locations":{"items":{"$ref":"#/components/schemas/SharedLocation"},"type":"array","x-stream-index":"034"},"auto_translation_enabled":{"type":"boolean","x-stream-index":"029"},"auto_translation_language":{"type":"string","x-stream-index":"030"},"cid":{"type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/ChannelConfig","x-stream-index":"026"},"config_overrides":{"$ref":"#/components/schemas/ConfigOverrides","x-stream-index":"027"},"cooldown":{"format":"int32","type":"integer","x-stream-index":"031"},"created_at":{"format":"date-time","type":"number","x-stream-index":"009"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"019"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"disabled":{"type":"boolean","x-stream-index":"017"},"frozen":{"type":"boolean","x-stream-index":"016"},"id":{"type":"string","x-stream-index":"004"},"invites":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"022"},"last_campaigns":{"type":"string","x-stream-index":"032"},"last_message_at":{"format":"date-time","type":"number","x-stream-index":"006"},"member_count":{"format":"int32","type":"integer","x-stream-index":"021"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"020"},"team":{"type":"string","x-stream-index":"028"},"truncated_by":{"$ref":"#/components/schemas/User","x-stream-index":"015"},"type":{"type":"string","x-stream-index":"005"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"010"}},"required":["cid","id","type","created_at","updated_at","frozen","disabled","custom","auto_translation_language"],"type":"object"},"ChannelConfig":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.026"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.021"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.022"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.027"},"blocklist":{"type":"string","x-stream-index":"001.023"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.024"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.025"},"commands":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"connect_events":{"type":"boolean","x-stream-index":"001.004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"custom_events":{"type":"boolean","x-stream-index":"001.012"},"mark_messages_pending":{"type":"boolean","x-stream-index":"001.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"001.020"},"mutes":{"type":"boolean","x-stream-index":"001.009"},"name":{"type":"string","x-stream-index":"001.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"001.028"},"partition_ttl":{"type":"integer","x-stream-index":"001.029"},"polls":{"type":"boolean","x-stream-index":"001.016"},"push_notifications":{"type":"boolean","x-stream-index":"001.013"},"quotes":{"type":"boolean","x-stream-index":"001.008"},"reactions":{"type":"boolean","x-stream-index":"001.006"},"read_events":{"type":"boolean","x-stream-index":"001.003"},"reminders":{"type":"boolean","x-stream-index":"001.014"},"replies":{"type":"boolean","x-stream-index":"001.007"},"search":{"type":"boolean","x-stream-index":"001.005"},"shared_locations":{"type":"boolean","x-stream-index":"001.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.030"},"typing_events":{"type":"boolean","x-stream-index":"001.002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"002.004"},"uploads":{"type":"boolean","x-stream-index":"001.010"},"url_enrichment":{"type":"boolean","x-stream-index":"001.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"001.017"}},"required":["name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","created_at","updated_at","commands"],"type":"object"},"ChannelConfigWithInfo":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.002.026"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.002.021"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.022"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.002.027"},"blocklist":{"type":"string","x-stream-index":"001.002.023"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.024"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.002.025"},"commands":{"items":{"$ref":"#/components/schemas/Command"},"type":"array","x-stream-index":"001.003"},"connect_events":{"type":"boolean","x-stream-index":"001.002.004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.001.003"},"custom_events":{"type":"boolean","x-stream-index":"001.002.012"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"002"},"mark_messages_pending":{"type":"boolean","x-stream-index":"001.002.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"001.002.020"},"mutes":{"type":"boolean","x-stream-index":"001.002.009"},"name":{"type":"string","x-stream-index":"001.002.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"001.002.028"},"partition_ttl":{"type":"integer","x-stream-index":"001.002.029"},"polls":{"type":"boolean","x-stream-index":"001.002.016"},"push_notifications":{"type":"boolean","x-stream-index":"001.002.013"},"quotes":{"type":"boolean","x-stream-index":"001.002.008"},"reactions":{"type":"boolean","x-stream-index":"001.002.006"},"read_events":{"type":"boolean","x-stream-index":"001.002.003"},"reminders":{"type":"boolean","x-stream-index":"001.002.014"},"replies":{"type":"boolean","x-stream-index":"001.002.007"},"search":{"type":"boolean","x-stream-index":"001.002.005"},"shared_locations":{"type":"boolean","x-stream-index":"001.002.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.002.030"},"typing_events":{"type":"boolean","x-stream-index":"001.002.002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"uploads":{"type":"boolean","x-stream-index":"001.002.010"},"url_enrichment":{"type":"boolean","x-stream-index":"001.002.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"001.002.017"}},"required":["created_at","updated_at","name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","commands"],"type":"object"},"ChannelMember":{"nullable":true,"properties":{"archived_at":{"format":"date-time","type":"number","x-stream-index":"021"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"017"},"banned":{"type":"boolean","x-stream-index":"016"},"channel_role":{"type":"string","x-stream-index":"024"},"created_at":{"format":"date-time","type":"number","x-stream-index":"012"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"014"},"invite_accepted_at":{"format":"date-time","type":"number","x-stream-index":"009"},"invite_rejected_at":{"format":"date-time","type":"number","x-stream-index":"010"},"invited":{"type":"boolean","x-stream-index":"008"},"is_global_banned":{"type":"boolean","x-stream-index":"020"},"is_moderator":{"type":"boolean","x-stream-index":"007"},"notifications_muted":{"type":"boolean","x-stream-index":"026"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"022"},"shadow_banned":{"type":"boolean","x-stream-index":"019"},"status":{"type":"string","x-stream-index":"011"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"013"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["custom","created_at","updated_at","banned","shadow_banned","is_global_banned","channel_role","notifications_muted"],"type":"object"},"ChannelMute":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"007"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"expires":{"description":"Date/time of mute expiration","format":"date-time","title":"Expires","type":"number","x-stream-index":"008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/User","description":"Owner of channel mute","title":"User","x-stream-index":"005"}},"required":["created_at","updated_at"],"type":"object"},"ChannelResponse":{"properties":{"auto_translation_enabled":{"type":"boolean","x-stream-index":"021"},"auto_translation_language":{"type":"string","x-stream-index":"022"},"blocked":{"type":"boolean","x-stream-index":"027"},"cid":{"type":"string","x-stream-index":"005"},"config":{"$ref":"#/components/schemas/ChannelConfigWithInfo","x-stream-index":"017"},"cooldown":{"format":"int32","type":"integer","x-stream-index":"024"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"011"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"030"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"010"},"disabled":{"type":"boolean","x-stream-index":"013"},"frozen":{"type":"boolean","x-stream-index":"012"},"hidden":{"type":"boolean","x-stream-index":"026"},"hide_messages_before":{"format":"date-time","type":"number","x-stream-index":"023"},"id":{"type":"string","x-stream-index":"003"},"last_message_at":{"format":"date-time","type":"number","x-stream-index":"006"},"member_count":{"format":"int32","type":"integer","x-stream-index":"015"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"014"},"mute_expires_at":{"format":"date-time","type":"number","x-stream-index":"019"},"muted":{"type":"boolean","x-stream-index":"018"},"own_capabilities":{"items":{"type":"string"},"type":"array","x-stream-index":"025"},"team":{"type":"string","x-stream-index":"020"},"truncated_at":{"format":"date-time","type":"number","x-stream-index":"028"},"truncated_by":{"$ref":"#/components/schemas/User","x-stream-index":"029"},"type":{"type":"string","x-stream-index":"004"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"}},"required":["id","type","cid","created_at","updated_at","frozen","disabled","custom"],"type":"object"},"CheckRequest":{"nullable":true,"properties":{"config_key":{"description":"Key of the moderation configuration to use","title":"Config Key","type":"string","x-stream-index":"005"},"config_team":{"description":"Team associated with the configuration","title":"Config Team","type":"string","x-stream-index":"006"},"entity_creator_id":{"description":"ID of the user who created the entity","title":"Entity Creator ID","type":"string","x-stream-index":"003"},"entity_id":{"description":"Unique identifier of the entity to moderate","title":"Entity ID","type":"string","x-stream-index":"002"},"entity_type":{"description":"Type of entity to moderate","title":"Entity Type","type":"string","x-stream-index":"001"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content to be moderated","title":"Moderation Payload","x-stream-index":"004"},"options":{"additionalProperties":{},"description":"Additional moderation configuration options","title":"Options","type":"object","x-stream-index":"007"},"test_mode":{"description":"Whether to run moderation in test mode","title":"Test Mode","type":"boolean","x-stream-index":"008"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"009.002"},"user_id":{"type":"string","x-stream-index":"009.001"}},"required":["entity_type","entity_id","entity_creator_id","config_key"],"type":"object"},"CheckResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"005.001"},"item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"Review queue item (present if action != keep)","title":"Item","x-stream-index":"004"},"recommended_action":{"description":"Suggested action based on moderation results","title":"Recommended Action","type":"string","x-stream-index":"003"},"status":{"description":"Status of the moderation check (completed or pending)","title":"Status","type":"string","x-stream-index":"001"},"task_id":{"description":"ID of the running moderation task","title":"Task ID","type":"string","x-stream-index":"002"}},"required":["status","recommended_action","duration"],"type":"object"},"Command":{"description":"Represents custom chat command","nullable":true,"properties":{"args":{"description":"Arguments help text, shown in commands auto-completion","title":"Arguments","type":"string","x-stream-index":"006"},"created_at":{"description":"Date/time of creation","format":"date-time","readOnly":true,"title":"Created at","type":"number","x-stream-index":"001"},"description":{"description":"Description, shown in commands auto-completion","title":"Description","type":"string","x-stream-index":"005"},"name":{"description":"Unique command name","title":"Name","type":"string","x-stream-index":"004"},"set":{"description":"Set name used for grouping commands","title":"Set","type":"string","x-stream-index":"007"},"updated_at":{"description":"Date/time of the last update","format":"date-time","readOnly":true,"title":"Updated at","type":"number","x-stream-index":"002"}},"required":["name","description","args","set"],"title":"Command","type":"object"},"CompositeAppSettings":{"properties":{"json_encoded_settings":{"type":"string","x-stream-index":"005"},"url":{"type":"string","x-stream-index":"004"}},"type":"object"},"ConfigOverrides":{"properties":{"blocklist":{"type":"string","x-stream-index":"008"},"blocklist_behavior":{"enum":["flag","block"],"type":"string","x-stream-index":"009"},"commands":{"items":{"type":"string"},"type":"array","x-stream-index":"011"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"010"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"007"},"quotes":{"type":"boolean","x-stream-index":"004"},"reactions":{"type":"boolean","x-stream-index":"002"},"replies":{"type":"boolean","x-stream-index":"003"},"shared_locations":{"type":"boolean","x-stream-index":"013"},"typing_events":{"type":"boolean","x-stream-index":"001"},"uploads":{"type":"boolean","x-stream-index":"005"},"url_enrichment":{"type":"boolean","x-stream-index":"006"},"user_message_reminders":{"type":"boolean","x-stream-index":"012"}},"required":["grants","commands"],"type":"object"},"ConfigResponse":{"properties":{"ai_image_config":{"$ref":"#/components/schemas/AIImageConfig","description":"Configuration for AI image analysis","title":"AI Image Config","x-stream-index":"009"},"ai_text_config":{"$ref":"#/components/schemas/AITextConfig","description":"Configuration for AI text analysis","title":"AI Text Config","x-stream-index":"008"},"ai_video_config":{"$ref":"#/components/schemas/AIVideoConfig","description":"Configuration for AI video analysis","title":"AI Video Config","x-stream-index":"010"},"async":{"description":"Whether moderation should be performed asynchronously","title":"Async","type":"boolean","x-stream-index":"003"},"automod_platform_circumvention_config":{"$ref":"#/components/schemas/AutomodPlatformCircumventionConfig","description":"Configuration for platform circumvention detection","title":"Automod Platform Circumvention Config","x-stream-index":"005"},"automod_semantic_filters_config":{"$ref":"#/components/schemas/AutomodSemanticFiltersConfig","description":"Configuration for semantic filtering","title":"Automod Semantic Filters Config","x-stream-index":"006"},"automod_toxicity_config":{"$ref":"#/components/schemas/AutomodToxicityConfig","description":"Configuration for toxicity detection","title":"Automod Toxicity Config","x-stream-index":"004"},"block_list_config":{"$ref":"#/components/schemas/BlockListConfig","description":"Configuration for block list filtering","title":"Block List Config","x-stream-index":"007"},"created_at":{"description":"When the configuration was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"012"},"key":{"description":"Unique identifier for the moderation configuration","title":"Key","type":"string","x-stream-index":"001"},"rule_builder_config":{"$ref":"#/components/schemas/RuleBuilderConfig","x-stream-index":"015"},"team":{"description":"Team associated with the configuration","title":"Team","type":"string","x-stream-index":"002"},"updated_at":{"description":"When the configuration was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"013"},"velocity_filter_config":{"$ref":"#/components/schemas/VelocityFilterConfig","description":"Configuration for velocity-based filtering","title":"Velocity Filter Config","x-stream-index":"011"},"video_call_rule_config":{"$ref":"#/components/schemas/VideoCallRuleConfig","x-stream-index":"014"}},"required":["key","team","async","created_at","updated_at"],"type":"object"},"ContentCountRuleParameters":{"properties":{"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"required":["threshold","time_window"],"type":"object"},"CustomActionRequest":{"properties":{"id":{"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"type":"object"},"CustomCheckFlag":{"properties":{"custom":{"additionalProperties":{},"description":"Additional metadata for the flag","title":"Custom","type":"object","x-stream-index":"003"},"labels":{"description":"Labels from various moderation sources","items":{"type":"string"},"title":"Labels","type":"array","x-stream-index":"004"},"reason":{"description":"Optional explanation for the flag","title":"Reason","type":"string","x-stream-index":"002"},"type":{"description":"Type of check (custom_check_text, custom_check_image, custom_check_video)","maxLength":255,"title":"Type","type":"string","x-stream-index":"001"}},"required":["type"],"type":"object"},"CustomCheckRequest":{"nullable":true,"properties":{"entity_creator_id":{"description":"ID of the user who created the entity (required for non-message entities)","title":"Entity Creator ID","type":"string","x-stream-index":"003"},"entity_id":{"description":"Unique identifier of the entity","title":"Entity ID","type":"string","x-stream-index":"002"},"entity_type":{"description":"Type of entity to perform custom check on","title":"Entity Type","type":"string","x-stream-index":"001"},"flags":{"description":"List of custom check flags (1-10 flags required)","items":{"$ref":"#/components/schemas/CustomCheckFlag"},"maximum":10,"minimum":1,"title":"Flags","type":"array","x-stream-index":"005"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content to be checked (required for non-message entities)","title":"Moderation Payload","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"006.002"},"user_id":{"type":"string","x-stream-index":"006.001"}},"required":["entity_type","entity_id","flags"],"type":"object"},"CustomCheckResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"004.001"},"id":{"description":"Unique identifier of the custom check","title":"ID","type":"string","x-stream-index":"001"},"item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"Review queue item details","title":"Item","x-stream-index":"002"},"status":{"description":"Status of the custom check","title":"Status","type":"string","x-stream-index":"003"}},"required":["id","status","duration"],"type":"object"},"Data":{"properties":{"id":{"type":"string","x-stream-index":"001"}},"required":["id"],"type":"object"},"DeleteActivityRequest":{"properties":{"hard_delete":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"DeleteMessageRequest":{"properties":{"hard_delete":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"DeleteModerationConfigResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"DeleteModerationTemplateResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"DeleteReactionRequest":{"properties":{"hard_delete":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"DeleteUserRequest":{"properties":{"delete_conversation_channels":{"type":"boolean","x-stream-index":"003"},"delete_feeds_content":{"type":"boolean","x-stream-index":"004"},"hard_delete":{"type":"boolean","x-stream-index":"001"},"mark_messages_deleted":{"type":"boolean","x-stream-index":"002"}},"type":"object"},"Device":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"disabled":{"type":"boolean","x-stream-index":"002.003"},"disabled_reason":{"type":"string","x-stream-index":"002.004"},"id":{"type":"string","x-stream-index":"002.001.004"},"push_provider":{"enum":["firebase","apn","huawei","xiaomi"],"type":"string","x-stream-index":"002.001.001"},"push_provider_name":{"type":"string","x-stream-index":"002.001.003"},"user_id":{"type":"string","x-stream-index":"004"},"voip":{"type":"boolean","x-stream-index":"002.001.005"}},"required":["push_provider","id","created_at","user_id"],"type":"object"},"DeviceResponse":{"description":"Response for Device","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"004"},"disabled":{"description":"Whether device is disabled or not","title":"Disabled","type":"boolean","x-stream-index":"005"},"disabled_reason":{"description":"Reason explaining why device had been disabled","title":"Reason","type":"string","x-stream-index":"006"},"id":{"description":"Device ID","title":"ID","type":"string","x-stream-index":"003"},"push_provider":{"description":"Push provider","title":"PushProvider","type":"string","x-stream-index":"001"},"push_provider_name":{"description":"Push provider name","title":"PushProviderName","type":"string","x-stream-index":"002"},"user_id":{"description":"User ID","title":"UserID","type":"string","x-stream-index":"008"},"voip":{"description":"When true the token is for Apple VoIP push notifications","title":"Voip","type":"boolean","x-stream-index":"007"}},"required":["push_provider","id","created_at","user_id"],"title":"DeviceResponse","type":"object"},"DraftPayloadResponse":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"html":{"type":"string","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"001"},"mentioned_users":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"008"},"mml":{"type":"string","x-stream-index":"003"},"parent_id":{"type":"string","x-stream-index":"005"},"poll_id":{"type":"string","x-stream-index":"013"},"quoted_message_id":{"type":"string","x-stream-index":"009"},"show_in_channel":{"type":"boolean","x-stream-index":"006"},"silent":{"type":"boolean","x-stream-index":"012"},"text":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"011"}},"required":["id","text","custom"],"type":"object"},"DraftResponse":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003"},"channel_cid":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"message":{"$ref":"#/components/schemas/DraftPayloadResponse","x-stream-index":"001"},"parent_id":{"type":"string","x-stream-index":"004"},"parent_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"005"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"006"}},"required":["message","channel_cid","created_at"],"type":"object"},"EgressHLSResponse":{"properties":{"playlist_url":{"type":"string","x-stream-index":"001"},"status":{"type":"string","x-stream-index":"002"}},"required":["playlist_url","status"],"type":"object"},"EgressRTMPResponse":{"properties":{"name":{"type":"string","x-stream-index":"001"},"started_at":{"format":"date-time","type":"number","x-stream-index":"004"},"stream_key":{"type":"string","x-stream-index":"003"},"stream_url":{"type":"string","x-stream-index":"002"}},"required":["name","started_at"],"type":"object"},"EgressResponse":{"properties":{"broadcasting":{"type":"boolean","x-stream-index":"001"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordingResponse","x-stream-index":"004"},"hls":{"$ref":"#/components/schemas/EgressHLSResponse","x-stream-index":"002"},"rtmps":{"items":{"$ref":"#/components/schemas/EgressRTMPResponse"},"type":"array","x-stream-index":"003"}},"required":["broadcasting","rtmps"],"type":"object"},"EgressTaskConfig":{"properties":{"egress_user":{"$ref":"#/components/schemas/EgressUser","x-stream-index":"008"},"frame_recording_egress_config":{"$ref":"#/components/schemas/FrameRecordingEgressConfig","x-stream-index":"009"},"hls_egress_config":{"$ref":"#/components/schemas/HLSEgressConfig","x-stream-index":"007"},"recording_egress_config":{"$ref":"#/components/schemas/RecordingEgressConfig","x-stream-index":"006"},"rtmp_egress_config":{"$ref":"#/components/schemas/RTMPEgressConfig","x-stream-index":"004"},"stt_egress_config":{"$ref":"#/components/schemas/STTEgressConfig","x-stream-index":"005"}},"type":"object"},"EgressUser":{"properties":{"token":{"type":"string","x-stream-index":"004"}},"type":"object"},"EnrichedActivity":{"properties":{"actor":{"$ref":"#/components/schemas/Data","x-stream-index":"002"},"foreign_id":{"type":"string","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"latest_reactions":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"013"},"object":{"$ref":"#/components/schemas/Data","x-stream-index":"004"},"origin":{"$ref":"#/components/schemas/Data","x-stream-index":"008"},"own_reactions":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"012"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"011"},"score":{"format":"float","type":"number","x-stream-index":"010"},"target":{"$ref":"#/components/schemas/Data","x-stream-index":"006"},"to":{"items":{"type":"string"},"type":"array","x-stream-index":"009"},"verb":{"type":"string","x-stream-index":"003"}},"type":"object"},"EnrichedReaction":{"nullable":true,"properties":{"activity_id":{"type":"string","x-stream-index":"003"},"children_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"010"},"created_at":{"$ref":"#/components/schemas/Time","x-stream-index":"012"},"data":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"kind":{"type":"string","x-stream-index":"002"},"latest_children":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"008"},"own_children":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"009"},"parent":{"type":"string","x-stream-index":"007"},"target_feeds":{"items":{"type":"string"},"type":"array","x-stream-index":"006"},"updated_at":{"$ref":"#/components/schemas/Time","x-stream-index":"013"},"user":{"$ref":"#/components/schemas/Data","x-stream-index":"011"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["kind","activity_id","user_id"],"type":"object"},"EntityCreator":{"properties":{"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"001.046"},"ban_count":{"format":"int32","type":"integer","x-stream-index":"002"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"001.017"},"banned":{"type":"boolean","x-stream-index":"001.016"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.013"},"deleted_content_count":{"format":"int32","type":"integer","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"001.023"},"language":{"type":"string","x-stream-index":"001.035"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"001.022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"001.026"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.042"},"role":{"type":"string","x-stream-index":"001.004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.005"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.009"}},"required":["id","role","teams_role","custom","banned","online","ban_count","deleted_content_count"],"type":"object"},"EntityCreatorResponse":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.001.018"},"ban_count":{"description":"Number of minor actions performed on the user","format":"int32","title":"Ban Count","type":"integer","x-stream-index":"002"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"001.003"},"banned":{"type":"boolean","x-stream-index":"001.001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.001.017"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.001.016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.001.011"},"deleted_content_count":{"description":"Number of major actions performed on the user","format":"int32","title":"Deleted Content Count","type":"integer","x-stream-index":"003"},"devices":{"items":{"$ref":"#/components/schemas/DeviceResponse"},"type":"array","x-stream-index":"001.006"},"flagged_count":{"description":"Number of flag actions performed on the user","format":"int32","title":"Flagged Count","type":"integer","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001.001.001"},"image":{"type":"string","x-stream-index":"001.001.003"},"invisible":{"type":"boolean","x-stream-index":"001.007"},"language":{"type":"string","x-stream-index":"001.001.005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"001.001.014"},"name":{"type":"string","x-stream-index":"001.001.002"},"online":{"type":"boolean","x-stream-index":"001.001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"001.005"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettingsResponse","x-stream-index":"001.004"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.001.015"},"role":{"type":"string","x-stream-index":"001.001.006"},"shadow_banned":{"type":"boolean","x-stream-index":"001.002"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.001.008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids","shadow_banned","invisible","ban_count","deleted_content_count","flagged_count"],"type":"object"},"EventNotificationSettings":{"properties":{"apns":{"$ref":"#/components/schemas/APNS","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"fcm":{"$ref":"#/components/schemas/FCM","x-stream-index":"003"}},"required":["enabled","apns","fcm"],"type":"object"},"ExternalStorage":{"properties":{"abs_account_name":{"type":"string","x-stream-index":"011"},"abs_client_id":{"type":"string","x-stream-index":"013"},"abs_client_secret":{"type":"string","x-stream-index":"014"},"abs_tenant_id":{"type":"string","x-stream-index":"012"},"bucket":{"type":"string","x-stream-index":"005"},"gcs_credentials":{"type":"string","x-stream-index":"010"},"path":{"type":"string","x-stream-index":"006"},"s3_api_key":{"type":"string","x-stream-index":"007"},"s3_custom_endpoint":{"type":"string","x-stream-index":"016"},"s3_region":{"type":"string","x-stream-index":"009"},"s3_secret_key":{"type":"string","x-stream-index":"008"},"storage_name":{"type":"string","x-stream-index":"015"},"storage_type":{"type":"integer","x-stream-index":"004"}},"type":"object"},"FCM":{"properties":{"data":{"additionalProperties":{},"type":"object","x-stream-index":"001"}},"type":"object"},"FeedsModerationTemplateConfig":{"properties":{"config_key":{"type":"string","x-stream-index":"002"},"data_types":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001"}},"required":["data_types","config_key"],"type":"object"},"Field":{"nullable":true,"properties":{"short":{"type":"boolean","x-stream-index":"003"},"title":{"type":"string","x-stream-index":"001"},"value":{"type":"string","x-stream-index":"002"}},"required":["title","value","short"],"type":"object"},"Flag":{"description":"Contains information about flagged user or message","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"019"},"custom":{"additionalProperties":{},"description":"Additional metadata about the flag","title":"Custom","type":"object","x-stream-index":"014"},"entity_creator_id":{"description":"ID of the user who created the flagged entity","title":"Entity Creator ID","type":"string","x-stream-index":"009"},"entity_id":{"description":"Unique identifier of the entity being flagged","title":"Entity ID","type":"string","x-stream-index":"008"},"entity_type":{"description":"Type of entity being flagged (e.g., message, user)","title":"Entity Type","type":"string","x-stream-index":"007"},"is_streamed_content":{"type":"boolean","x-stream-index":"012"},"labels":{"description":"Labels from bodyguard, API calls, our own AI etc","items":{"type":"string"},"title":"Labels","type":"array","x-stream-index":"015"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content being flagged","title":"Moderation Payload","x-stream-index":"010"},"moderation_payload_hash":{"type":"string","x-stream-index":"011"},"reason":{"description":"Optional explanation for why the content is being flagged","title":"Reason","type":"string","x-stream-index":"013"},"result":{"description":"Result of bodyguard, API calls, our own AI etc","items":{"additionalProperties":{},"type":"object"},"title":"Result","type":"array","x-stream-index":"016"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"018"},"review_queue_item_id":{"description":"ID of the review queue item","title":"Review Queue Item ID","type":"string","x-stream-index":"017"},"type":{"type":"string","x-stream-index":"004"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"020"},"user":{"$ref":"#/components/schemas/User","description":"User who flagged a message or a user","title":"User","x-stream-index":"006"}},"required":["entity_type","entity_id","result","created_at","updated_at"],"title":"Flag","type":"object"},"FlagContentOptions":{"properties":{"reason":{"type":"string","x-stream-index":"001"}},"required":["reason"],"type":"object"},"FlagRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"description":"Additional metadata about the flag","title":"Custom","type":"object","x-stream-index":"006"},"entity_creator_id":{"description":"ID of the user who created the flagged entity","title":"Entity Creator ID","type":"string","x-stream-index":"003"},"entity_id":{"description":"Unique identifier of the entity being flagged","title":"Entity ID","type":"string","x-stream-index":"002"},"entity_type":{"description":"Type of entity being flagged (e.g., message, user)","title":"Entity Type","type":"string","x-stream-index":"001"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content being flagged","title":"Moderation Payload","x-stream-index":"005"},"reason":{"description":"Optional explanation for why the content is being flagged","maxLength":255,"title":"Reason","type":"string","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"007.002"},"user_id":{"type":"string","x-stream-index":"007.001"}},"required":["entity_type","entity_id"],"type":"object"},"FlagResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"item_id":{"description":"Unique identifier of the created moderation item","title":"Item ID","type":"string","x-stream-index":"001"}},"required":["item_id","duration"],"type":"object"},"FlagUserOptions":{"properties":{"reason":{"type":"string","x-stream-index":"001"}},"required":["reason"],"type":"object"},"FrameRecordSettings":{"properties":{"capture_interval_in_seconds":{"format":"int32","maximum":60,"minimum":2,"type":"integer","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"},"quality":{"type":"string","x-stream-index":"002"}},"required":["mode","capture_interval_in_seconds"],"type":"object"},"FrameRecordingEgressConfig":{"properties":{"capture_interval_in_seconds":{"format":"int32","type":"integer","x-stream-index":"007"},"external_storage":{"$ref":"#/components/schemas/ExternalStorage","x-stream-index":"006"},"quality":{"$ref":"#/components/schemas/Quality","x-stream-index":"004"},"storage_name":{"type":"string","x-stream-index":"005"}},"type":"object"},"FrameRecordingResponse":{"properties":{"status":{"type":"string","x-stream-index":"001"}},"required":["status"],"type":"object"},"FrameRecordingSettingsResponse":{"properties":{"capture_interval_in_seconds":{"format":"int32","maximum":60,"minimum":2,"type":"integer","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"},"quality":{"type":"string","x-stream-index":"002"}},"required":["mode","capture_interval_in_seconds"],"type":"object"},"GeofenceSettings":{"properties":{"names":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"required":["names"],"type":"object"},"GeofenceSettingsResponse":{"properties":{"names":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"required":["names"],"type":"object"},"GetConfigResponse":{"nullable":true,"properties":{"config":{"$ref":"#/components/schemas/ConfigResponse","description":"The retrieved moderation configuration","title":"Config","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["duration"],"type":"object"},"GetReviewQueueItemResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"Current state of the review queue item","title":"Item","x-stream-index":"001"}},"required":["duration"],"type":"object"},"GoogleVisionConfig":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"HLSEgressConfig":{"properties":{"composite_app_settings":{"$ref":"#/components/schemas/CompositeAppSettings","x-stream-index":"005"},"playlist_url":{"type":"string","x-stream-index":"007"},"qualities":{"items":{"$ref":"#/components/schemas/Quality"},"type":"array","x-stream-index":"004"},"start_unix_nano":{"format":"int64","type":"integer","x-stream-index":"006"}},"type":"object"},"HLSSettings":{"properties":{"auto_on":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"004"},"quality_tracks":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"required":["auto_on","enabled","quality_tracks"],"type":"object"},"HLSSettingsResponse":{"description":"HLSSettings is the payload for HLS settings","properties":{"auto_on":{"title":"Auto On","type":"boolean","x-stream-index":"001"},"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"002"},"layout":{"$ref":"#/components/schemas/LayoutSettingsResponse","title":"Layout","x-stream-index":"004"},"quality_tracks":{"items":{"type":"string"},"title":"Quality Tracks","type":"array","x-stream-index":"003"}},"required":["auto_on","enabled","quality_tracks","layout"],"title":"HLSSettingsResponse","type":"object"},"HarmConfig":{"properties":{"action_sequences":{"items":{"$ref":"#/components/schemas/ActionSequence"},"type":"array","x-stream-index":"001"},"severity":{"type":"integer","x-stream-index":"002"}},"required":["action_sequences","severity"],"type":"object"},"ImageContentParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"type":"object"},"ImageData":{"properties":{"frames":{"type":"string","x-stream-index":"005"},"height":{"type":"string","x-stream-index":"003"},"size":{"type":"string","x-stream-index":"004"},"url":{"type":"string","x-stream-index":"001"},"width":{"type":"string","x-stream-index":"002"}},"required":["url","width","height","size","frames"],"type":"object"},"ImageRuleParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"required":["threshold","time_window"],"type":"object"},"Images":{"properties":{"fixed_height":{"$ref":"#/components/schemas/ImageData","x-stream-index":"002"},"fixed_height_downsampled":{"$ref":"#/components/schemas/ImageData","x-stream-index":"004"},"fixed_height_still":{"$ref":"#/components/schemas/ImageData","x-stream-index":"003"},"fixed_width":{"$ref":"#/components/schemas/ImageData","x-stream-index":"005"},"fixed_width_downsampled":{"$ref":"#/components/schemas/ImageData","x-stream-index":"007"},"fixed_width_still":{"$ref":"#/components/schemas/ImageData","x-stream-index":"006"},"original":{"$ref":"#/components/schemas/ImageData","x-stream-index":"001"}},"required":["original","fixed_height","fixed_height_still","fixed_height_downsampled","fixed_width","fixed_width_still","fixed_width_downsampled"],"type":"object"},"IngressAudioEncodingOptions":{"properties":{"bitrate":{"maximum":128000,"minimum":16000,"type":"integer","x-stream-index":"003"},"channels":{"enum":["1","2"],"format":"int32","type":"integer","x-stream-index":"001"},"enable_dtx":{"type":"boolean","x-stream-index":"002"}},"required":["channels","enable_dtx","bitrate"],"type":"object"},"IngressAudioEncodingResponse":{"properties":{"bitrate":{"format":"int32","type":"integer","x-stream-index":"003"},"channels":{"format":"int32","type":"integer","x-stream-index":"001"},"enable_dtx":{"type":"boolean","x-stream-index":"002"}},"required":["channels","enable_dtx","bitrate"],"type":"object"},"IngressSettings":{"properties":{"audio_encoding_options":{"$ref":"#/components/schemas/IngressAudioEncodingOptions","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"video_encoding_options":{"additionalProperties":{"$ref":"#/components/schemas/IngressVideoEncodingOptions"},"type":"object","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"IngressSettingsResponse":{"properties":{"audio_encoding_options":{"$ref":"#/components/schemas/IngressAudioEncodingResponse","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"video_encoding_options":{"additionalProperties":{"$ref":"#/components/schemas/IngressVideoEncodingResponse"},"type":"object","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"IngressVideoEncodingOptions":{"properties":{"layers":{"items":{"$ref":"#/components/schemas/IngressVideoLayer"},"minimum":1,"type":"array","x-stream-index":"001"}},"required":["layers"],"type":"object"},"IngressVideoEncodingResponse":{"properties":{"layers":{"items":{"$ref":"#/components/schemas/IngressVideoLayerResponse"},"type":"array","x-stream-index":"001"}},"required":["layers"],"type":"object"},"IngressVideoLayer":{"nullable":true,"properties":{"bitrate":{"minimum":1000,"type":"integer","x-stream-index":"002"},"codec":{"enum":["h264","vp8"],"type":"string","x-stream-index":"001"},"frame_rate":{"maximum":60,"minimum":1,"type":"integer","x-stream-index":"003"},"max_dimension":{"minimum":240,"type":"integer","x-stream-index":"005"},"min_dimension":{"minimum":240,"type":"integer","x-stream-index":"004"}},"required":["codec","bitrate","frame_rate","min_dimension","max_dimension"],"type":"object"},"IngressVideoLayerResponse":{"nullable":true,"properties":{"bitrate":{"type":"integer","x-stream-index":"002"},"codec":{"type":"string","x-stream-index":"001"},"frame_rate_limit":{"type":"integer","x-stream-index":"005"},"max_dimension":{"type":"integer","x-stream-index":"004"},"min_dimension":{"type":"integer","x-stream-index":"003"}},"required":["codec","bitrate","min_dimension","max_dimension","frame_rate_limit"],"type":"object"},"LabelThresholds":{"properties":{"block":{"format":"float","maximum":1,"minimum":0,"type":"number","x-stream-index":"002"},"flag":{"format":"float","maximum":1,"minimum":0,"type":"number","x-stream-index":"001"}},"type":"object"},"LayoutSettings":{"properties":{"detect_orientation":{"type":"boolean","x-stream-index":"005"},"external_app_url":{"type":"string","x-stream-index":"003"},"external_css_url":{"type":"string","x-stream-index":"004"},"name":{"enum":["spotlight","grid","single-participant","mobile","custom"],"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"required":["name","external_app_url","external_css_url"],"type":"object"},"LayoutSettingsResponse":{"properties":{"detect_orientation":{"type":"boolean","x-stream-index":"005"},"external_app_url":{"type":"string","x-stream-index":"003"},"external_css_url":{"type":"string","x-stream-index":"004"},"name":{"enum":["spotlight","grid","single-participant","mobile","custom"],"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"required":["name","external_app_url","external_css_url"],"type":"object"},"LimitsSettings":{"properties":{"max_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"004"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"},"max_participants_exclude_owner":{"type":"boolean","x-stream-index":"003"},"max_participants_exclude_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"002"}},"required":["max_participants_exclude_roles"],"type":"object"},"LimitsSettingsResponse":{"properties":{"max_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"004"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"},"max_participants_exclude_owner":{"type":"boolean","x-stream-index":"003"},"max_participants_exclude_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"002"}},"required":["max_participants_exclude_roles"],"type":"object"},"MarkReviewedRequest":{"properties":{"content_to_mark_as_reviewed_limit":{"format":"int32","maximum":2500,"type":"integer","x-stream-index":"002"},"disable_marking_content_as_reviewed":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"MemberLookup":{"properties":{"Limit":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"001"}},"required":["Limit"],"type":"object"},"Message":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"012"},"before_message_send_failed":{"type":"boolean","x-stream-index":"046"},"cid":{"type":"string","x-stream-index":"028"},"command":{"type":"string","x-stream-index":"006"},"created_at":{"format":"date-time","type":"number","x-stream-index":"030"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"034"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"033"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"023"},"html":{"type":"string","x-stream-index":"007"},"i18n":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"044"},"id":{"type":"string","x-stream-index":"002"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"040"},"latest_reactions":{"items":{"$ref":"#/components/schemas/Reaction"},"type":"array","x-stream-index":"013"},"mentioned_users":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"043"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"052"},"mml":{"type":"string","x-stream-index":"005"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"056"},"own_reactions":{"items":{"$ref":"#/components/schemas/Reaction"},"type":"array","x-stream-index":"014"},"parent_id":{"type":"string","x-stream-index":"019"},"pin_expires":{"format":"date-time","type":"number","x-stream-index":"051"},"pinned":{"type":"boolean","x-stream-index":"047"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"048"},"pinned_by":{"$ref":"#/components/schemas/User","x-stream-index":"050"},"poll":{"$ref":"#/components/schemas/Poll","x-stream-index":"054"},"poll_id":{"type":"string","x-stream-index":"053"},"quoted_message":{"$ref":"#/components/schemas/Message","x-stream-index":"025"},"quoted_message_id":{"type":"string","x-stream-index":"024"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"015"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"017"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"016"},"reminder":{"$ref":"#/components/schemas/MessageReminder","x-stream-index":"058"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"022"},"restricted_visibility":{"items":{"type":"string"},"type":"array","x-stream-index":"011"},"shadowed":{"type":"boolean","x-stream-index":"036"},"shared_location":{"$ref":"#/components/schemas/SharedLocation","x-stream-index":"055"},"show_in_channel":{"type":"boolean","x-stream-index":"021"},"silent":{"type":"boolean","x-stream-index":"045"},"text":{"type":"string","x-stream-index":"004"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"027"},"type":{"type":"string","x-stream-index":"008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"031"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"010"}},"required":["id","text","html","type","restricted_visibility","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reaction_groups","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned"],"type":"object"},"MessageReminder":{"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"004"},"channel_cid":{"type":"string","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"011"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"006"},"message_id":{"type":"string","x-stream-index":"005"},"remind_at":{"format":"date-time","type":"number","x-stream-index":"009"},"task_id":{"type":"string","x-stream-index":"010"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"012"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"user_id":{"type":"string","x-stream-index":"007"}},"required":["channel_cid","message_id","user_id","task_id","created_at","updated_at"],"type":"object"},"MessageResponse":{"description":"Represents any chat message","properties":{"attachments":{"description":"Array of message attachments","items":{"$ref":"#/components/schemas/Attachment"},"title":"Message attachments","type":"array","x-stream-docs-page-id":"message_format#attachment-format","x-stream-index":"008"},"cid":{"description":"Channel unique identifier in \u003ctype\u003e:\u003cid\u003e format","title":"Channel CID","type":"string","x-stream-index":"022"},"command":{"description":"Contains provided slash command","title":"Command","type":"string","x-stream-docs-page-id":"custom_commands_webhook","x-stream-index":"004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"023"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"026"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"025"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"018"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"041"},"html":{"description":"Contains HTML markup of the message. Can only be set when using server-side API","title":"HTML content","type":"string","x-stream-index":"005"},"i18n":{"additionalProperties":{"type":"string"},"description":"Object with translations. Key `language` contains the original language key. Other keys contain translations","title":"Internationalization info","type":"object","x-stream-docs-page-id":"translation","x-stream-index":"030"},"id":{"description":"Message ID is unique string identifier of the message","title":"ID","type":"string","x-stream-index":"001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"Contains image moderation information","title":"Image moderation labels","type":"object","x-stream-index":"028"},"latest_reactions":{"description":"List of 10 latest reactions to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Latest reactions","type":"array","x-stream-index":"009"},"mentioned_users":{"description":"List of mentioned users","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Mentioned Users","type":"array","x-stream-index":"029"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"036"},"mml":{"description":"Should be empty if `text` is provided. Can only be set when using server-side API","title":"Messaging Markup Language","type":"string","x-stream-docs-page-id":"mml_overview","x-stream-index":"003"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"039"},"own_reactions":{"description":"List of 10 latest reactions of authenticated user to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Own reactions","type":"array","x-stream-index":"010"},"parent_id":{"description":"ID of parent message (thread)","title":"Parent message ID","type":"string","x-stream-docs-page-id":"threads","x-stream-index":"015"},"pin_expires":{"description":"Date when pinned message expires","format":"date-time","title":"Pin expiration date","type":"number","x-stream-docs-page-id":"pinned_messages","x-stream-index":"035"},"pinned":{"description":"Whether message is pinned or not","title":"Pinned","type":"boolean","x-stream-docs-page-id":"pinned_messages","x-stream-index":"032"},"pinned_at":{"description":"Date when message got pinned","format":"date-time","title":"Pinned at","type":"number","x-stream-docs-page-id":"pinned_messages","x-stream-index":"033"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","description":"Contains user who pinned the message","title":"Pinned by","x-stream-docs-page-id":"pinned_messages","x-stream-index":"034"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"038"},"poll_id":{"description":"Identifier of the poll to include in the message","title":"Poll ID","type":"string","x-stream-index":"037"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","description":"Contains quoted message","title":"Quoted message","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"020"},"quoted_message_id":{"title":"ID of quoted message","type":"string","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"019"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing number of reactions of each type. Key: reaction type (string), value: number of reactions (int)","title":"Reaction counts","type":"object","x-stream-index":"011"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"014"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing scores of reactions of each type. Key: reaction type (string), value: total score of reactions (int)","title":"Reaction scores","type":"object","x-stream-index":"012"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"042"},"reply_count":{"description":"Number of replies to this message","format":"int32","title":"Reply count","type":"integer","x-stream-index":"017"},"restricted_visibility":{"description":"A list of user ids that have restricted visibility to the message, if the list is not empty, the message is only visible to the users in the list","items":{"type":"string"},"title":"Restricted visibility","type":"array","x-stream-index":"040"},"shadowed":{"description":"Whether the message was shadowed or not","title":"Shadowed","type":"boolean","x-stream-docs-page-id":"moderation#shadow-ban","x-stream-index":"027"},"shared_location":{"$ref":"#/components/schemas/SharedLocationResponseData","description":"Contains shared location data","title":"Shared Location","x-stream-index":"043"},"show_in_channel":{"description":"Whether thread reply should be shown in the channel as well","title":"Show in channel","type":"boolean","x-stream-docs-page-id":"threads","x-stream-index":"016"},"silent":{"description":"Whether message is silent or not","title":"Silent","type":"boolean","x-stream-index":"031"},"text":{"description":"Text of the message. Should be empty if `mml` is provided","title":"Text","type":"string","x-stream-index":"002"},"thread_participants":{"description":"List of users who participate in thread","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Thread participants","type":"array","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"021"},"type":{"description":"Contains type of the message","enum":["regular","ephemeral","error","reply","system","deleted"],"title":"Message Type","type":"string","x-stream-docs-page-id":"message_format#message-types","x-stream-index":"006"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"024"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Sender of the message. Required when using server-side API","title":"User object","x-stream-index":"007"}},"required":["id","text","html","type","user","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned","restricted_visibility"],"title":"Message","type":"object","x-stream-docs-page-id":"send_message"},"ModerationActionConfig":{"nullable":true,"properties":{"action":{"type":"string","x-stream-index":"006"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"009"},"description":{"type":"string","x-stream-index":"008"},"entity_type":{"type":"string","x-stream-index":"004"},"icon":{"type":"string","x-stream-index":"007"},"order":{"format":"int32","type":"integer","x-stream-index":"005"}},"required":["entity_type","order","action","icon","description","custom"],"type":"object"},"ModerationCheckCompletedEvent":{"description":"This event is sent when a moderation check is completed","nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"entity_id":{"description":"The ID of entity which was moderated","title":"EntityID","type":"string","x-stream-index":"002"},"entity_type":{"description":"The type of the entity which was moderated","title":"EntityType","type":"string","x-stream-index":"003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"recommended_action":{"description":"The recommended action","title":"RecommendedAction","type":"string","x-stream-index":"004"},"review_queue_item_id":{"description":"The review queue item ID","title":"ReviewQueueItemID","type":"string","x-stream-index":"005"},"type":{"default":"moderation_check.completed","type":"string","x-stream-index":"001.002"}},"required":["type","created_at","custom","entity_id","entity_type","recommended_action","review_queue_item_id"],"title":"ModerationCheckCompletedEvent","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"},"ModerationCustomActionEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"001"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"002"},"type":{"default":"moderation.custom_action","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationCustomActionEvent","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"},"ModerationFlagResponse":{"nullable":true,"properties":{"created_at":{"type":"string","x-stream-index":"014"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"009"},"entity_creator_id":{"type":"string","x-stream-index":"006"},"entity_id":{"type":"string","x-stream-index":"005"},"entity_type":{"type":"string","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001"},"labels":{"items":{"type":"string"},"type":"array","x-stream-index":"010"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"007"},"reason":{"type":"string","x-stream-index":"008"},"result":{"items":{"additionalProperties":{},"type":"object"},"type":"array","x-stream-index":"011"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","x-stream-index":"013"},"review_queue_item_id":{"type":"string","x-stream-index":"012"},"type":{"type":"string","x-stream-index":"002"},"updated_at":{"type":"string","x-stream-index":"015"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"003"}},"required":["id","type","entity_type","entity_id","created_at","updated_at"],"type":"object"},"ModerationFlaggedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"item":{"type":"string","x-stream-index":"001"},"object_id":{"type":"string","x-stream-index":"002"},"type":{"default":"moderation.flagged","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationFlaggedEvent","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"},"ModerationMarkReviewedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"001"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"002"},"type":{"default":"moderation.mark_reviewed","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationMarkReviewedEvent","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"},"ModerationPayload":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"images":{"items":{"type":"string"},"maximum":30,"type":"array","x-stream-index":"002"},"texts":{"items":{"type":"string"},"type":"array","x-stream-index":"001"},"videos":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"type":"object"},"ModerationV2Response":{"properties":{"action":{"type":"string","x-stream-index":"001"},"blocklist_matched":{"type":"string","x-stream-index":"005"},"image_harms":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"original_text":{"type":"string","x-stream-index":"002"},"platform_circumvented":{"type":"boolean","x-stream-index":"007"},"semantic_filter_matched":{"type":"string","x-stream-index":"006"},"text_harms":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"required":["action","original_text"],"type":"object"},"MuteRequest":{"nullable":true,"properties":{"target_ids":{"description":"User IDs to mute (if multiple users)","items":{"type":"string"},"title":"Target IDs","type":"array","x-stream-index":"001"},"timeout":{"description":"Duration of mute in minutes","minimum":0,"title":"Timeout","type":"integer","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"required":["target_ids"],"title":"MuteRequest","type":"object"},"MuteResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"004.001"},"mutes":{"description":"Object with mutes (if multiple users were muted)","items":{"$ref":"#/components/schemas/UserMute"},"title":"Mutes","type":"array","x-stream-index":"001"},"non_existing_users":{"description":"A list of users that can't be found. Common cause for this is deleted users","items":{"type":"string"},"title":"Non Existing Users","type":"array","x-stream-index":"003"},"own_user":{"$ref":"#/components/schemas/OwnUser","description":"Authorized user object with fresh mutes information","title":"Own User","x-stream-index":"002"}},"required":["duration"],"title":"MuteResponse","type":"object"},"NoiseCancellationSettings":{"properties":{"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode"],"type":"object"},"NotificationSettings":{"properties":{"call_live_started":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"002"},"call_missed":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"006"},"call_notification":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"004"},"call_ring":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"session_started":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"003"}},"required":["enabled","call_live_started","session_started","call_notification","call_ring","call_missed"],"type":"object"},"NullTime":{"type":"object"},"OCRRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"}},"required":["label","action"],"type":"object"},"OwnUser":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"046"},"banned":{"type":"boolean","x-stream-index":"016"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"045"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"029"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"014"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"013"},"devices":{"items":{"$ref":"#/components/schemas/Device"},"type":"array","x-stream-index":"027"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"023"},"language":{"type":"string","x-stream-index":"035"},"last_active":{"format":"date-time","type":"number","x-stream-index":"011"},"last_engaged_at":{"format":"date-time","type":"number","x-stream-index":"012"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"037"},"mutes":{"items":{"$ref":"#/components/schemas/UserMute"},"type":"array","x-stream-index":"028"},"online":{"type":"boolean","x-stream-index":"022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"026"},"push_preferences":{"$ref":"#/components/schemas/PushPreferences","x-stream-index":"025"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"005"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"031"},"total_unread_count_by_team":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"032"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"033"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"030"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"034"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"}},"required":["id","role","custom","created_at","updated_at","banned","online","devices","mutes","channel_mutes","unread_count","total_unread_count","total_unread_count_by_team","unread_channels","unread_threads","language"],"type":"object"},"Poll":{"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"023"},"allow_answers":{"type":"boolean","x-stream-index":"010"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"009"},"answers_count":{"format":"int32","type":"integer","x-stream-index":"015"},"created_at":{"format":"date-time","type":"number","x-stream-index":"021"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"020"},"created_by_id":{"type":"string","x-stream-index":"019"},"description":{"type":"string","x-stream-index":"005"},"enforce_unique_vote":{"type":"boolean","x-stream-index":"007"},"id":{"type":"string","x-stream-index":"003"},"is_closed":{"type":"boolean","x-stream-index":"011"},"latest_answers":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array","x-stream-index":"017"},"latest_votes_by_option":{"additionalProperties":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array"},"type":"object","x-stream-index":"016"},"max_votes_allowed":{"format":"int32","type":"integer","x-stream-index":"008"},"name":{"type":"string","x-stream-index":"004"},"options":{"items":{"$ref":"#/components/schemas/PollOption"},"type":"array","x-stream-index":"013"},"own_votes":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array","x-stream-index":"018"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"022"},"vote_count":{"format":"int32","type":"integer","x-stream-index":"012"},"vote_counts_by_option":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"014"},"voting_visibility":{"type":"string","x-stream-index":"006"}},"required":["id","name","description","enforce_unique_vote","allow_user_suggested_options","allow_answers","vote_count","options","vote_counts_by_option","answers_count","latest_votes_by_option","latest_answers","own_votes","created_by_id","created_at","updated_at","Custom"],"type":"object"},"PollOption":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id","text","custom"],"type":"object"},"PollOptionResponseData":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id","text","custom"],"type":"object"},"PollResponseData":{"properties":{"allow_answers":{"type":"boolean","x-stream-index":"008"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"007"},"answers_count":{"format":"int32","type":"integer","x-stream-index":"012"},"created_at":{"format":"date-time","type":"number","x-stream-index":"019"},"created_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"018"},"created_by_id":{"type":"string","x-stream-index":"017"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"021"},"description":{"type":"string","x-stream-index":"003"},"enforce_unique_vote":{"type":"boolean","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"is_closed":{"type":"boolean","x-stream-index":"009"},"latest_answers":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array","x-stream-index":"015"},"latest_votes_by_option":{"additionalProperties":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array"},"type":"object","x-stream-index":"014"},"max_votes_allowed":{"format":"int32","type":"integer","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"002"},"options":{"items":{"$ref":"#/components/schemas/PollOptionResponseData"},"type":"array","x-stream-index":"011"},"own_votes":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array","x-stream-index":"016"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"020"},"vote_count":{"format":"int32","type":"integer","x-stream-index":"010"},"vote_counts_by_option":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"013"},"voting_visibility":{"type":"string","x-stream-index":"004"}},"required":["id","name","description","voting_visibility","enforce_unique_vote","allow_user_suggested_options","allow_answers","vote_count","options","answers_count","vote_counts_by_option","latest_votes_by_option","latest_answers","own_votes","created_by_id","created_at","updated_at","custom"],"type":"object"},"PollVote":{"nullable":true,"properties":{"answer_text":{"type":"string","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"004"},"is_answer":{"type":"boolean","x-stream-index":"006"},"option_id":{"type":"string","x-stream-index":"005"},"poll_id":{"type":"string","x-stream-index":"003"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"011"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"009"},"user_id":{"type":"string","x-stream-index":"008"}},"required":["poll_id","id","option_id","created_at","updated_at"],"type":"object"},"PollVoteResponseData":{"nullable":true,"properties":{"answer_text":{"type":"string","x-stream-index":"005"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"id":{"type":"string","x-stream-index":"002"},"is_answer":{"type":"boolean","x-stream-index":"004"},"option_id":{"type":"string","x-stream-index":"003"},"poll_id":{"type":"string","x-stream-index":"001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"007"},"user_id":{"type":"string","x-stream-index":"006"}},"required":["poll_id","id","option_id","created_at","updated_at"],"type":"object"},"PrivacySettings":{"properties":{"read_receipts":{"$ref":"#/components/schemas/ReadReceipts","x-stream-index":"002"},"typing_indicators":{"$ref":"#/components/schemas/TypingIndicators","x-stream-index":"001"}},"type":"object"},"PrivacySettingsResponse":{"properties":{"read_receipts":{"$ref":"#/components/schemas/ReadReceiptsResponse","x-stream-index":"002"},"typing_indicators":{"$ref":"#/components/schemas/TypingIndicatorsResponse","x-stream-index":"001"}},"type":"object"},"PushNotificationSettingsResponse":{"properties":{"disabled":{"type":"boolean","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"number","x-stream-index":"002"}},"type":"object"},"PushPreferences":{"properties":{"call_level":{"type":"string","x-stream-index":"002"},"chat_level":{"type":"string","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"number","x-stream-index":"003"}},"type":"object"},"Quality":{"properties":{"bitdepth":{"format":"int32","type":"integer","x-stream-index":"007"},"framerate":{"format":"int32","type":"integer","x-stream-index":"008"},"height":{"format":"int32","type":"integer","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"004"},"video_bitrate":{"format":"int32","type":"integer","x-stream-index":"009"},"width":{"format":"int32","type":"integer","x-stream-index":"005"}},"type":"object"},"QueryFeedModerationTemplate":{"properties":{"config":{"$ref":"#/components/schemas/FeedsModerationTemplateConfig","description":"Configuration for the moderation template","title":"Config","x-stream-index":"002"},"created_at":{"description":"When the template was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"003"},"name":{"description":"Name of the moderation template","title":"Name","type":"string","x-stream-index":"001"},"updated_at":{"description":"When the template was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"004"}},"required":["name","created_at","updated_at"],"type":"object"},"QueryFeedModerationTemplatesResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"templates":{"description":"List of moderation templates","items":{"$ref":"#/components/schemas/QueryFeedModerationTemplate"},"title":"Templates","type":"array","x-stream-index":"001"}},"required":["templates","duration"],"type":"object"},"QueryModerationConfigsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter conditions for moderation configs","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"Sorting parameters for the results","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"type":"object"},"QueryModerationConfigsResponse":{"nullable":true,"properties":{"configs":{"description":"List of moderation configurations","items":{"$ref":"#/components/schemas/ConfigResponse"},"title":"Configs","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["configs","duration"],"type":"object"},"QueryModerationFlagsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParam"},"type":"array","x-stream-index":"002"}},"type":"object"},"QueryModerationFlagsResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"flags":{"items":{"$ref":"#/components/schemas/ModerationFlagResponse"},"type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["flags","duration"],"title":"Response","type":"object"},"QueryModerationLogsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter conditions for moderation logs","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"Sorting parameters for the results","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"type":"object"},"QueryModerationLogsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"003.001"},"logs":{"description":"List of moderation action logs","items":{"$ref":"#/components/schemas/ActionLogResponse"},"title":"Logs","type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["logs","duration"],"type":"object"},"QueryReviewQueueRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter conditions for review queue items","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"007.001"},"lock_count":{"description":"Number of items to lock (1-25)","format":"int32","maximum":25,"minimum":1,"title":"Lock Count","type":"integer","x-stream-index":"005"},"lock_duration":{"description":"Duration for which items should be locked","title":"Lock Duration","type":"integer","x-stream-index":"004"},"lock_items":{"description":"Whether to lock items for review (true), unlock items (false), or just fetch (nil)","title":"Lock Items","type":"boolean","x-stream-index":"003"},"next":{"type":"string","x-stream-index":"007.002"},"prev":{"type":"string","x-stream-index":"007.003"},"sort":{"description":"Sorting parameters for the results","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"002"},"stats_only":{"description":"Whether to return only statistics","title":"Stats Only","type":"boolean","x-stream-index":"006"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"008.002"},"user_id":{"type":"string","x-stream-index":"008.001"}},"type":"object"},"QueryReviewQueueResponse":{"nullable":true,"properties":{"action_config":{"additionalProperties":{"items":{"$ref":"#/components/schemas/ModerationActionConfig"},"type":"array"},"description":"Configuration for moderation actions","title":"Action Config","type":"object","x-stream-index":"002"},"duration":{"type":"string","x-stream-index":"005.001"},"items":{"description":"List of review queue items","items":{"$ref":"#/components/schemas/ReviewQueueItemResponse"},"title":"Items","type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"004.001"},"prev":{"type":"string","x-stream-index":"004.002"},"stats":{"additionalProperties":{},"description":"Statistics about the review queue","title":"Stats","type":"object","x-stream-index":"003"}},"required":["items","action_config","stats","duration"],"type":"object"},"RTMPEgressConfig":{"properties":{"composite_app_settings":{"$ref":"#/components/schemas/CompositeAppSettings","x-stream-index":"005"},"quality":{"$ref":"#/components/schemas/Quality","x-stream-index":"004"},"rtmp_location":{"type":"string","x-stream-index":"006"}},"type":"object"},"RTMPIngress":{"description":"RTMP input settings","properties":{"address":{"title":"Address","type":"string","x-stream-index":"001"}},"required":["address"],"title":"RTMPIngress","type":"object"},"RTMPLocation":{"properties":{"name":{"type":"string","x-stream-index":"001"},"stream_key":{"type":"string","x-stream-index":"003"},"stream_url":{"type":"string","x-stream-index":"002"}},"required":["name","stream_url","stream_key"],"type":"object"},"RTMPSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"003"},"location":{"$ref":"#/components/schemas/RTMPLocation","x-stream-index":"004"},"quality_name":{"type":"string","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"RTMPSettingsResponse":{"description":"RTMPSettingsResponse is the payload for RTMP settings","properties":{"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettingsResponse","title":"Layout","x-stream-index":"003"},"quality":{"title":"Quality","type":"string","x-stream-index":"002"}},"required":["enabled","quality","layout"],"title":"RTMPSettingsResponse","type":"object"},"Reaction":{"nullable":true,"properties":{"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"message_id":{"type":"string","x-stream-index":"003"},"score":{"format":"int32","type":"integer","x-stream-index":"007"},"type":{"maxLength":30,"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["message_id","type","score","created_at","updated_at","custom"],"type":"object"},"ReactionGroupResponse":{"description":"ReactionGroupResponse contains all information about a reaction of the same type.","nullable":true,"properties":{"count":{"description":"Count is the number of reactions of this type.","format":"int32","title":"Count","type":"integer","x-stream-index":"001"},"first_reaction_at":{"description":"FirstReactionAt is the time of the first reaction of this type. This is the same also if all reaction of this type are deleted, because if someone will react again with the same type, will be preserved the sorting.","format":"date-time","title":"FirstReactionAt","type":"number","x-stream-index":"003"},"last_reaction_at":{"description":"LastReactionAt is the time of the last reaction of this type.","format":"date-time","title":"LastReactionAt","type":"number","x-stream-index":"004"},"sum_scores":{"description":"SumScores is the sum of all scores of reactions of this type. Medium allows you to clap articles more than once and shows the sum of all claps from all users. For example, you can send `clap` x5 using `score: 5`.","format":"int32","title":"SumScores","type":"integer","x-stream-index":"002"}},"required":["count","sum_scores","first_reaction_at","last_reaction_at"],"title":"ReactionGroupResponse","type":"object"},"ReactionResponse":{"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"006"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"008"},"message_id":{"description":"Message ID","title":"Message ID","type":"string","x-stream-index":"001"},"score":{"description":"Score of the reaction","format":"int32","title":"Score","type":"integer","x-stream-index":"005"},"type":{"description":"Type of reaction","title":"Type","type":"string","x-stream-index":"004"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"007"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User","title":"UserResponse","x-stream-index":"003"},"user_id":{"description":"User ID","title":"User ID","type":"string","x-stream-index":"002"}},"required":["message_id","user_id","user","type","score","created_at","updated_at","custom"],"type":"object"},"ReadReceipts":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"ReadReceiptsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"RecordSettings":{"properties":{"audio_only":{"type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"004"},"mode":{"type":"string","x-stream-index":"002"},"quality":{"type":"string","x-stream-index":"003"}},"required":["mode"],"type":"object"},"RecordSettingsResponse":{"description":"RecordSettings is the payload for recording settings","properties":{"audio_only":{"title":"Audio Only","type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettingsResponse","title":"Layout","x-stream-index":"004"},"mode":{"title":"Mode","type":"string","x-stream-index":"002"},"quality":{"title":"Quality","type":"string","x-stream-index":"003"}},"required":["audio_only","mode","quality","layout"],"title":"RecordSettingsResponse","type":"object"},"RecordingEgressConfig":{"properties":{"audio_only":{"type":"boolean","x-stream-index":"006"},"composite_app_settings":{"$ref":"#/components/schemas/CompositeAppSettings","x-stream-index":"005"},"external_storage":{"$ref":"#/components/schemas/ExternalStorage","x-stream-index":"008"},"quality":{"$ref":"#/components/schemas/Quality","x-stream-index":"004"},"storage_name":{"type":"string","x-stream-index":"007"},"video_orientation_hint":{"$ref":"#/components/schemas/VideoOrientation","x-stream-index":"009"}},"type":"object"},"ReminderResponseData":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003"},"channel_cid":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"005"},"message_id":{"type":"string","x-stream-index":"004"},"remind_at":{"format":"date-time","type":"number","x-stream-index":"001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007"},"user_id":{"type":"string","x-stream-index":"006"}},"required":["channel_cid","message_id","user_id","created_at","updated_at"],"type":"object"},"RestoreActionRequest":{"type":"object"},"ReviewQueueItem":{"properties":{"actions":{"items":{"$ref":"#/components/schemas/ActionLog"},"type":"array","x-stream-index":"035"},"activity":{"$ref":"#/components/schemas/EnrichedActivity","x-stream-index":"028"},"ai_text_severity":{"type":"string","x-stream-index":"021"},"archived_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"043"},"assigned_to":{"$ref":"#/components/schemas/User","x-stream-index":"032"},"bans":{"items":{"$ref":"#/components/schemas/Ban"},"type":"array","x-stream-index":"033"},"bounce_count":{"format":"int32","type":"integer","x-stream-index":"025"},"call":{"$ref":"#/components/schemas/Call","x-stream-index":"031"},"completed_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"018"},"config_key":{"type":"string","x-stream-index":"009"},"content_changed":{"type":"boolean","x-stream-index":"036"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"entity_creator":{"$ref":"#/components/schemas/EntityCreator","x-stream-index":"030"},"entity_id":{"type":"string","x-stream-index":"007"},"entity_type":{"type":"string","x-stream-index":"006"},"feeds_v2_activity":{"$ref":"#/components/schemas/EnrichedActivity","x-stream-index":"041"},"feeds_v2_reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"042"},"flag_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"045"},"flag_types":{"items":{"type":"string"},"type":"array","x-stream-index":"044"},"flags":{"items":{"$ref":"#/components/schemas/Flag"},"type":"array","x-stream-index":"034"},"flags_count":{"format":"int32","type":"integer","x-stream-index":"026"},"has_image":{"type":"boolean","x-stream-index":"012"},"has_text":{"type":"boolean","x-stream-index":"014"},"has_video":{"type":"boolean","x-stream-index":"013"},"id":{"type":"string","x-stream-index":"003"},"languages":{"items":{"type":"string"},"type":"array","x-stream-index":"019"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"027"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"010"},"moderation_payload_hash":{"type":"string","x-stream-index":"011"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"029"},"recommended_action":{"type":"string","x-stream-index":"017"},"reporter_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"046"},"reviewed_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"022"},"reviewed_by":{"type":"string","x-stream-index":"023"},"severity":{"format":"int32","type":"integer","x-stream-index":"020"},"status":{"type":"string","x-stream-index":"016"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"015"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"005"}},"required":["id","created_at","updated_at","entity_type","entity_id","config_key","moderation_payload_hash","has_image","has_video","has_text","teams","status","recommended_action","completed_at","languages","severity","ai_text_severity","reviewed_at","reviewed_by","bounce_count","flags_count","bans","flags","actions","content_changed","archived_at","flag_types","flag_labels","reporter_ids"],"type":"object"},"ReviewQueueItemNewEvent":{"description":"This event is sent when a new moderation review queue item is created","nullable":true,"properties":{"action":{"$ref":"#/components/schemas/ActionLogResponse","description":"The action log if any action was taken","title":"Action","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"flags":{"description":"The flags associated with this review queue item","items":{"$ref":"#/components/schemas/FlagResponse"},"title":"Flags","type":"array","x-stream-index":"003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"The review queue item that was created","title":"ReviewQueueItem","x-stream-index":"002"},"type":{"default":"review_queue_item.new","type":"string","x-stream-index":"001.002"}},"required":["type","created_at","custom"],"title":"ReviewQueueItemNewEvent","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"},"ReviewQueueItemResponse":{"properties":{"actions":{"description":"Moderation actions taken","items":{"$ref":"#/components/schemas/ActionLogResponse"},"title":"Actions","type":"array","x-stream-index":"024"},"activity":{"$ref":"#/components/schemas/EnrichedActivity","x-stream-index":"016"},"ai_text_severity":{"description":"AI-determined text severity","title":"AI Text Severity","type":"string","x-stream-index":"014"},"assigned_to":{"$ref":"#/components/schemas/UserResponse","description":"Moderator assigned to review this item","title":"Assigned To","x-stream-index":"021"},"bans":{"description":"Associated ban records","items":{"$ref":"#/components/schemas/Ban"},"title":"Bans","type":"array","x-stream-index":"022"},"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"018"},"completed_at":{"description":"When the review was completed","format":"date-time","title":"Completed At","type":"number","x-stream-index":"009"},"config_key":{"type":"string","x-stream-index":"028"},"created_at":{"description":"When the item was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"002"},"entity_creator":{"$ref":"#/components/schemas/EntityCreatorResponse","description":"Details about who created the entity","title":"Entity Creator","x-stream-index":"019"},"entity_creator_id":{"description":"ID of who created the entity","title":"Entity Creator ID","type":"string","x-stream-index":"020"},"entity_id":{"description":"ID of the entity being reviewed","title":"Entity ID","type":"string","x-stream-index":"005"},"entity_type":{"description":"Type of entity being reviewed","title":"Entity Type","type":"string","x-stream-index":"004"},"feeds_v2_activity":{"$ref":"#/components/schemas/EnrichedActivity","description":"Associated feed activity","title":"Feeds V2 Activity","x-stream-index":"025"},"feeds_v2_reaction":{"$ref":"#/components/schemas/Reaction","description":"Associated feed reaction","title":"Feeds V2 Reaction","x-stream-index":"026"},"flags":{"description":"Associated flag records","items":{"$ref":"#/components/schemas/FlagResponse"},"title":"Flags","type":"array","x-stream-index":"023"},"flags_count":{"format":"int32","type":"integer","x-stream-index":"029"},"id":{"description":"Unique identifier of the review queue item","title":"ID","type":"string","x-stream-index":"001"},"languages":{"description":"Detected languages in the content","items":{"type":"string"},"title":"Languages","type":"array","x-stream-index":"012"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Associated message details","title":"Message","x-stream-index":"015"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content being moderated","title":"Moderation Payload","x-stream-index":"006"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"017"},"recommended_action":{"description":"Suggested moderation action","title":"Recommended Action","type":"string","x-stream-index":"008"},"reviewed_at":{"description":"When the item was reviewed","format":"date-time","title":"Reviewed At","type":"number","x-stream-index":"010"},"reviewed_by":{"description":"ID of the moderator who reviewed the item","title":"Reviewed By","type":"string","x-stream-index":"011"},"severity":{"description":"Severity level of the content","format":"int32","title":"Severity","type":"integer","x-stream-index":"013"},"status":{"description":"Current status of the review","title":"Status","type":"string","x-stream-index":"007"},"teams":{"description":"Teams associated with this item","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"027"},"updated_at":{"description":"When the item was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"003"}},"required":["id","created_at","updated_at","entity_type","entity_id","status","recommended_action","reviewed_by","languages","severity","ai_text_severity","bans","flags","actions","flags_count"],"type":"object"},"ReviewQueueItemUpdatedEvent":{"description":"This event is sent when a moderation review queue item is updated","nullable":true,"properties":{"action":{"$ref":"#/components/schemas/ActionLogResponse","description":"The action log if any action was taken","title":"Action","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"flags":{"description":"The flags associated with this review queue item","items":{"$ref":"#/components/schemas/FlagResponse"},"title":"Flags","type":"array","x-stream-index":"003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"The review queue item that was updated","title":"ReviewQueueItem","x-stream-index":"002"},"type":{"default":"review_queue_item.updated","type":"string","x-stream-index":"001.002"}},"required":["type","created_at","custom"],"title":"ReviewQueueItemUpdatedEvent","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"},"RingSettings":{"properties":{"auto_cancel_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_timeout_ms","missed_call_timeout_ms"],"type":"object"},"RingSettingsResponse":{"properties":{"auto_cancel_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_timeout_ms","missed_call_timeout_ms"],"type":"object"},"RuleBuilderAction":{"properties":{"ban_options":{"$ref":"#/components/schemas/BanOptions","x-stream-index":"002"},"flag_content_options":{"$ref":"#/components/schemas/FlagContentOptions","x-stream-index":"004"},"flag_user_options":{"$ref":"#/components/schemas/FlagUserOptions","x-stream-index":"003"},"remove_content_options":{"$ref":"#/components/schemas/BlockContentOptions","x-stream-index":"005"},"type":{"type":"string","x-stream-index":"001"}},"required":["type"],"type":"object"},"RuleBuilderCondition":{"properties":{"confidence":{"format":"float","type":"number","x-stream-index":"002"},"content_count_rule_params":{"$ref":"#/components/schemas/ContentCountRuleParameters","x-stream-index":"007"},"image_content_params":{"$ref":"#/components/schemas/ImageContentParameters","x-stream-index":"009"},"image_rule_params":{"$ref":"#/components/schemas/ImageRuleParameters","x-stream-index":"004"},"text_content_params":{"$ref":"#/components/schemas/TextContentParameters","x-stream-index":"008"},"text_rule_params":{"$ref":"#/components/schemas/TextRuleParameters","x-stream-index":"003"},"type":{"type":"string","x-stream-index":"001"},"user_created_within_params":{"$ref":"#/components/schemas/UserCreatedWithinParameters","x-stream-index":"011"},"user_rule_params":{"$ref":"#/components/schemas/UserRuleParameters","x-stream-index":"006"},"video_content_params":{"$ref":"#/components/schemas/VideoContentParameters","x-stream-index":"010"},"video_rule_params":{"$ref":"#/components/schemas/VideoRuleParameters","x-stream-index":"005"}},"required":["type"],"type":"object"},"RuleBuilderConditionGroup":{"properties":{"conditions":{"items":{"$ref":"#/components/schemas/RuleBuilderCondition"},"type":"array","x-stream-index":"002"},"logic":{"type":"string","x-stream-index":"001"}},"required":["logic","conditions"],"type":"object"},"RuleBuilderConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"rules":{"items":{"$ref":"#/components/schemas/RuleBuilderRule"},"type":"array","x-stream-index":"002"}},"required":["rules"],"type":"object"},"RuleBuilderRule":{"properties":{"action":{"$ref":"#/components/schemas/RuleBuilderAction","x-stream-index":"007"},"conditions":{"items":{"$ref":"#/components/schemas/RuleBuilderCondition"},"type":"array","x-stream-index":"004"},"cooldown_period":{"type":"string","x-stream-index":"009"},"enabled":{"type":"boolean","x-stream-index":"008"},"groups":{"items":{"$ref":"#/components/schemas/RuleBuilderConditionGroup"},"type":"array","x-stream-index":"006"},"id":{"type":"string","x-stream-index":"001"},"logic":{"type":"string","x-stream-index":"005"},"name":{"type":"string","x-stream-index":"002"},"rule_type":{"type":"string","x-stream-index":"003"}},"required":["id","name","rule_type","action","enabled"],"type":"object"},"SFUIDLastSeen":{"properties":{"id":{"type":"string","x-stream-index":"001.001"},"last_seen":{"format":"date-time","type":"number","x-stream-index":"002"},"process_start_time":{"format":"int64","type":"integer","x-stream-index":"001.002"}},"required":["id","process_start_time","last_seen"],"type":"object"},"STTEgressConfig":{"properties":{"closed_captions_enabled":{"type":"boolean","x-stream-index":"005"},"external_storage":{"$ref":"#/components/schemas/ExternalStorage","x-stream-index":"011"},"language":{"type":"string","x-stream-index":"008"},"storage_name":{"type":"string","x-stream-index":"010"},"translation_languages":{"items":{"type":"string"},"type":"array","x-stream-index":"009"},"translations_enabled":{"type":"boolean","x-stream-index":"006"},"upload_transcriptions":{"type":"boolean","x-stream-index":"004"},"whisper_server_base_url":{"type":"string","x-stream-index":"007"}},"type":"object"},"ScreensharingSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled"],"type":"object"},"ScreensharingSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled"],"type":"object"},"SessionSettings":{"properties":{"inactivity_timeout_seconds":{"format":"int32","maximum":900,"minimum":5,"type":"integer","x-stream-index":"001"}},"required":["inactivity_timeout_seconds"],"type":"object"},"SessionSettingsResponse":{"properties":{"inactivity_timeout_seconds":{"format":"int32","maximum":900,"minimum":5,"type":"integer","x-stream-index":"001"}},"required":["inactivity_timeout_seconds"],"type":"object"},"ShadowBlockActionRequest":{"type":"object"},"SharedLocation":{"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"013"},"channel_cid":{"type":"string","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"010"},"created_by_device_id":{"type":"string","x-stream-index":"008"},"end_at":{"format":"date-time","type":"number","x-stream-index":"009"},"latitude":{"format":"float","maximum":90,"minimum":18446744073709552000,"type":"number","x-stream-index":"006"},"longitude":{"format":"float","maximum":180,"minimum":18446744073709552000,"type":"number","x-stream-index":"007"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"012"},"message_id":{"type":"string","x-stream-index":"004"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"011"},"user_id":{"type":"string","x-stream-index":"005"}},"required":["channel_cid","message_id","user_id","created_by_device_id","created_at","updated_at"],"type":"object"},"SharedLocationResponseData":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"011"},"channel_cid":{"type":"string","x-stream-index":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"created_by_device_id":{"type":"string","x-stream-index":"006"},"end_at":{"format":"date-time","type":"number","x-stream-index":"007"},"latitude":{"format":"float","type":"number","x-stream-index":"004"},"longitude":{"format":"float","type":"number","x-stream-index":"005"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"010"},"message_id":{"type":"string","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["channel_cid","message_id","user_id","latitude","longitude","created_by_device_id","created_at","updated_at"],"type":"object"},"SortParam":{"nullable":true,"properties":{"direction":{"format":"int32","type":"integer","x-stream-index":"002"},"field":{"type":"string","x-stream-index":"001"}},"type":"object"},"SortParamRequest":{"nullable":true,"properties":{"direction":{"description":"Direction of sorting, 1 for Ascending, -1 for Descending, default is 1","format":"int32","title":"Direction","type":"integer","x-stream-index":"002"},"field":{"description":"Name of field to sort by","title":"Field","type":"string","x-stream-index":"001"}},"type":"object"},"SubmitActionRequest":{"nullable":true,"properties":{"action_type":{"description":"Type of moderation action to perform (mark_reviewed, delete_message, etc.)","enum":["mark_reviewed","delete_message","delete_activity","delete_reaction","ban","custom","unban","restore","delete_user","unblock","shadow_block","unmask","kick_user","end_call"],"title":"Action Type","type":"string","x-stream-index":"002"},"ban":{"$ref":"#/components/schemas/BanActionRequest","description":"Configuration for ban action","title":"Ban","x-stream-index":"008"},"custom":{"$ref":"#/components/schemas/CustomActionRequest","description":"Configuration for custom action","title":"Custom","x-stream-index":"009"},"delete_activity":{"$ref":"#/components/schemas/DeleteActivityRequest","description":"Configuration for activity deletion action","title":"Delete Activity","x-stream-index":"004"},"delete_message":{"$ref":"#/components/schemas/DeleteMessageRequest","description":"Configuration for message deletion action","title":"Delete Message","x-stream-index":"003"},"delete_reaction":{"$ref":"#/components/schemas/DeleteReactionRequest","description":"Configuration for reaction deletion action","title":"Delete Reaction","x-stream-index":"005"},"delete_user":{"$ref":"#/components/schemas/DeleteUserRequest","description":"Configuration for user deletion action","title":"Delete User","x-stream-index":"006"},"item_id":{"description":"UUID of the review queue item to act on","title":"Item ID","type":"string","x-stream-index":"001"},"mark_reviewed":{"$ref":"#/components/schemas/MarkReviewedRequest","description":"Configuration for marking item as reviewed","title":"Mark Reviewed","x-stream-index":"007"},"unban":{"$ref":"#/components/schemas/UnbanActionRequest","description":"Configuration for unban action","title":"Unban","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"016.002"},"user_id":{"type":"string","x-stream-index":"016.001"}},"required":["item_id","action_type"],"type":"object"},"SubmitActionResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"Updated review queue item after action was performed","title":"Item","x-stream-index":"001"}},"required":["duration"],"type":"object"},"TargetResolution":{"properties":{"bitrate":{"format":"int32","maximum":6000000,"type":"integer","x-stream-index":"003"},"height":{"format":"int32","maximum":3840,"minimum":240,"type":"integer","x-stream-index":"002"},"width":{"format":"int32","maximum":3840,"minimum":240,"type":"integer","x-stream-index":"001"}},"required":["width","height","bitrate"],"type":"object"},"TextContentParameters":{"properties":{"blocklist_match":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"contains_url":{"type":"boolean","x-stream-index":"002"},"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001"},"severity":{"type":"string","x-stream-index":"003"}},"type":"object"},"TextRuleParameters":{"properties":{"blocklist_match":{"items":{"type":"string"},"type":"array","x-stream-index":"006"},"contains_url":{"type":"boolean","x-stream-index":"004"},"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"severity":{"type":"string","x-stream-index":"005"},"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"required":["threshold","time_window"],"type":"object"},"Thresholds":{"properties":{"explicit":{"$ref":"#/components/schemas/LabelThresholds","x-stream-index":"001"},"spam":{"$ref":"#/components/schemas/LabelThresholds","x-stream-index":"002"},"toxic":{"$ref":"#/components/schemas/LabelThresholds","x-stream-index":"003"}},"type":"object"},"ThumbnailResponse":{"properties":{"image_url":{"type":"string","x-stream-index":"001"}},"required":["image_url"],"type":"object"},"ThumbnailsSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"ThumbnailsSettingsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"Time":{"type":"object"},"TranscriptionSettings":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"title":"Mode","type":"string","x-stream-index":"002"},"language":{"description":"The language used in this call as a two letter code","enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"title":"Language","type":"string","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"title":"Mode","type":"string","x-stream-index":"001"}},"required":["mode","closed_caption_mode","languages","language"],"type":"object"},"TranscriptionSettingsResponse":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"002"},"language":{"enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"type":"string","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode","closed_caption_mode","languages","language"],"type":"object"},"TypingIndicators":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"TypingIndicatorsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"UnbanActionRequest":{"type":"object"},"UnbanRequest":{"nullable":true,"properties":{"unbanned_by":{"$ref":"#/components/schemas/UserRequest","description":"Details about the user performing the unban","title":"Unbanned By","x-stream-index":"005"},"unbanned_by_id":{"description":"ID of the user performing the unban","title":"Unbanned By ID","type":"string","x-stream-index":"004"}},"type":"object"},"UnbanResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"UnblockActionRequest":{"type":"object"},"UnmuteRequest":{"nullable":true,"properties":{"target_ids":{"description":"User IDs to unmute","items":{"type":"string"},"title":"Target IDs","type":"array","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"002.002"},"user_id":{"type":"string","x-stream-index":"002.001"}},"required":["target_ids"],"title":"UnmuteRequest","type":"object"},"UnmuteResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"non_existing_users":{"description":"A list of users that can't be found. Common cause for this is deleted users","items":{"type":"string"},"title":"Non Existing Users","type":"array","x-stream-index":"001"}},"required":["duration"],"title":"UnmuteResponse","type":"object"},"UpsertConfigRequest":{"nullable":true,"properties":{"ai_image_config":{"$ref":"#/components/schemas/AIImageConfig","description":"Configuration for AI image analysis","title":"AI Image Config","x-stream-index":"010"},"ai_text_config":{"$ref":"#/components/schemas/AITextConfig","description":"Configuration for AI text analysis","title":"AI Text Config","x-stream-index":"008"},"ai_video_config":{"$ref":"#/components/schemas/AIVideoConfig","description":"Configuration for AI video analysis","title":"AI Video Config","x-stream-index":"011"},"async":{"description":"Whether moderation should be performed asynchronously","title":"Async","type":"boolean","x-stream-index":"003"},"automod_platform_circumvention_config":{"$ref":"#/components/schemas/AutomodPlatformCircumventionConfig","description":"Configuration for platform circumvention detection","title":"Automod Platform Circumvention Config","x-stream-index":"005"},"automod_semantic_filters_config":{"$ref":"#/components/schemas/AutomodSemanticFiltersConfig","description":"Configuration for semantic filtering","title":"Automod Semantic Filters Config","x-stream-index":"006"},"automod_toxicity_config":{"$ref":"#/components/schemas/AutomodToxicityConfig","description":"Configuration for toxicity detection","title":"Automod Toxicity Config","x-stream-index":"004"},"aws_rekognition_config":{"$ref":"#/components/schemas/AIImageConfig","x-stream-index":"015"},"block_list_config":{"$ref":"#/components/schemas/BlockListConfig","description":"Configuration for block list filtering","title":"Block List Config","x-stream-index":"007"},"bodyguard_config":{"$ref":"#/components/schemas/AITextConfig","x-stream-index":"014"},"google_vision_config":{"$ref":"#/components/schemas/GoogleVisionConfig","description":"Configuration for Google Vision integration","title":"Google Vision Config","x-stream-index":"009"},"key":{"description":"Unique identifier for the moderation configuration","title":"Key","type":"string","x-stream-index":"001"},"rule_builder_config":{"$ref":"#/components/schemas/RuleBuilderConfig","description":"Configuration for custom rule builder (max 3 rules, max 5 conditions per rule)","title":"Rule Builder Config","x-stream-index":"013"},"team":{"description":"Team associated with the configuration","maxLength":128,"minLength":1,"title":"Team","type":"string","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"017.002"},"user_id":{"type":"string","x-stream-index":"017.001"},"velocity_filter_config":{"$ref":"#/components/schemas/VelocityFilterConfig","description":"Configuration for velocity-based filtering","title":"Velocity Filter Config","x-stream-index":"012"},"video_call_rule_config":{"$ref":"#/components/schemas/VideoCallRuleConfig","x-stream-index":"016"}},"required":["key"],"type":"object"},"UpsertConfigResponse":{"nullable":true,"properties":{"config":{"$ref":"#/components/schemas/ConfigResponse","description":"The created or updated moderation configuration","title":"Config","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["duration"],"type":"object"},"UpsertModerationTemplateRequest":{"nullable":true,"properties":{"config":{"$ref":"#/components/schemas/FeedsModerationTemplateConfig","description":"Configuration for the moderation template","title":"Config","x-stream-index":"002"},"name":{"description":"Name of the moderation template","title":"Name","type":"string","x-stream-index":"001"}},"required":["name","config"],"type":"object"},"UpsertModerationTemplateResponse":{"nullable":true,"properties":{"config":{"$ref":"#/components/schemas/FeedsModerationTemplateConfig","description":"Configuration for the moderation template","title":"Config","x-stream-index":"002"},"created_at":{"description":"When the template was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"003"},"duration":{"type":"string","x-stream-index":"005.001"},"name":{"description":"Name of the moderation template","title":"Name","type":"string","x-stream-index":"001"},"updated_at":{"description":"When the template was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"004"}},"required":["name","created_at","updated_at","duration"],"type":"object"},"User":{"properties":{"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"046"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"017"},"banned":{"type":"boolean","x-stream-index":"016"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"013"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"023"},"language":{"type":"string","x-stream-index":"035"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"026"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"042"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"005"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"009"}},"required":["id","role","teams_role","custom","banned","online"],"type":"object"},"UserCreatedWithinParameters":{"properties":{"max_age":{"type":"string","x-stream-index":"001"}},"type":"object"},"UserMute":{"nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"expires":{"description":"Date/time of mute expiration","format":"date-time","title":"Expires","type":"number","x-stream-index":"008"},"target":{"$ref":"#/components/schemas/User","description":"User who's muted","title":"Target","x-stream-index":"007"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/User","description":"Owner of channel mute","title":"User","x-stream-index":"005"}},"required":["created_at","updated_at"],"type":"object"},"UserRequest":{"description":"User request object","properties":{"custom":{"additionalProperties":{},"description":"Custom user data","title":"Custom","type":"object","x-stream-index":"004"},"id":{"description":"User ID","title":"ID","type":"string","x-stream-index":"001"},"image":{"description":"User's profile image URL","title":"Image","type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"006"},"language":{"type":"string","x-stream-index":"005"},"name":{"description":"Optional name of user","title":"Name","type":"string","x-stream-index":"002"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"007"},"role":{"description":"User's global role","title":"Role","type":"string","x-stream-index":"008"},"teams":{"description":"List of teams the user belongs to","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"010"},"teams_role":{"additionalProperties":{"type":"string"},"description":"Map of team-specific roles for the user","title":"TeamsRole","type":"object","x-stream-index":"009"}},"required":["id"],"title":"UserRequest","type":"object"},"UserResponse":{"description":"User response object","properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"ban_expires":{"description":"Date when ban expires","format":"date-time","title":"Ban expires","type":"number","x-stream-index":"003"},"banned":{"description":"Whether a user is banned or not","title":"Banned","type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.017"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"001.004"},"deactivated_at":{"description":"Date of deactivation","format":"date-time","title":"Deactivated at","type":"number","x-stream-index":"001.016"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"001.011"},"devices":{"description":"List of devices user is using","items":{"$ref":"#/components/schemas/DeviceResponse"},"title":"Devices","type":"array","x-stream-index":"006"},"id":{"description":"Unique user identifier","title":"ID","type":"string","x-stream-index":"001.001"},"image":{"title":"Image","type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"007"},"language":{"description":"Preferred language of a user","title":"Language","type":"string","x-stream-index":"001.005"},"last_active":{"description":"Date of last activity","format":"date-time","title":"Last active","type":"number","x-stream-index":"001.014"},"name":{"description":"Optional name of user","title":"Name","type":"string","x-stream-index":"001.002"},"online":{"description":"Whether a user online or not","title":"Online","type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","description":"User privacy settings","title":"Privacy settings","x-stream-index":"005"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettingsResponse","description":"User push notification settings","title":"Push notifications","x-stream-index":"004"},"revoke_tokens_issued_before":{"description":"Revocation date for tokens","format":"date-time","title":"Revoke tokens issued before","type":"number","x-stream-index":"001.015"},"role":{"description":"Determines the set of user permissions","title":"Role","type":"string","x-stream-index":"001.006"},"shadow_banned":{"description":"Whether a user is shadow banned","title":"Shadow banned","type":"boolean","x-stream-index":"002"},"teams":{"description":"List of teams user is a part of","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids","shadow_banned","invisible"],"title":"UserResponse","type":"object"},"UserRuleParameters":{"properties":{"max_age":{"type":"string","x-stream-index":"001"}},"type":"object"},"VelocityFilterConfig":{"properties":{"advanced_filters":{"type":"boolean","x-stream-index":"007"},"async":{"type":"boolean","x-stream-index":"001"},"cascading_actions":{"type":"boolean","x-stream-index":"004"},"cids_per_user":{"format":"int32","type":"integer","x-stream-index":"006"},"enabled":{"type":"boolean","x-stream-index":"002"},"first_message_only":{"type":"boolean","x-stream-index":"005"},"rules":{"items":{"$ref":"#/components/schemas/VelocityFilterConfigRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules","cascading_actions","first_message_only","cids_per_user","advanced_filters"],"type":"object"},"VelocityFilterConfigRule":{"properties":{"action":{"enum":["flag","shadow","remove","ban"],"type":"string","x-stream-index":"001"},"ban_duration":{"format":"int32","type":"integer","x-stream-index":"002"},"cascading_action":{"enum":["flag","shadow","remove","ban"],"type":"string","x-stream-index":"006"},"cascading_threshold":{"format":"int64","type":"integer","x-stream-index":"005"},"check_message_context":{"type":"boolean","x-stream-index":"009"},"fast_spam_threshold":{"format":"int32","type":"integer","x-stream-index":"007"},"fast_spam_ttl":{"format":"int32","type":"integer","x-stream-index":"010"},"ip_ban":{"type":"boolean","x-stream-index":"004"},"probation_period":{"format":"int32","type":"integer","x-stream-index":"014"},"shadow_ban":{"type":"boolean","x-stream-index":"003"},"slow_spam_ban_duration":{"format":"int32","type":"integer","x-stream-index":"012"},"slow_spam_threshold":{"format":"int32","type":"integer","x-stream-index":"008"},"slow_spam_ttl":{"format":"int32","type":"integer","x-stream-index":"011"},"url_only":{"type":"boolean","x-stream-index":"013"}},"required":["action","ban_duration","shadow_ban","ip_ban","cascading_threshold","cascading_action","fast_spam_threshold","slow_spam_threshold","check_message_context","fast_spam_ttl","slow_spam_ttl","url_only","probation_period"],"type":"object"},"VideoCallRuleConfig":{"properties":{"rules":{"additionalProperties":{"$ref":"#/components/schemas/HarmConfig"},"type":"object","x-stream-index":"001"}},"required":["rules"],"type":"object"},"VideoContentParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"type":"object"},"VideoEndCallRequest":{"type":"object"},"VideoKickUserRequest":{"type":"object"},"VideoOrientation":{"properties":{"orientation":{"type":"integer","x-stream-index":"004"}},"type":"object"},"VideoRuleParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"required":["threshold","time_window"],"type":"object"},"VideoSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"camera_default_on":{"type":"boolean","x-stream-index":"004"},"camera_facing":{"enum":["front","back","external"],"type":"string","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled","target_resolution","camera_default_on","camera_facing"],"type":"object"},"VideoSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"camera_default_on":{"type":"boolean","x-stream-index":"004"},"camera_facing":{"enum":["front","back","external"],"type":"string","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled","target_resolution","camera_default_on","camera_facing"],"type":"object"},"WebhookEvent":{"description":"The discriminator object for all webhook events, it maps events' payload to the final type","discriminator":{"mapping":{"export.bulk_image_moderation.error":"#/components/schemas/AsyncExportErrorEvent","export.bulk_image_moderation.success":"#/components/schemas/AsyncBulkImageModerationEvent","export.moderation_logs.error":"#/components/schemas/AsyncExportErrorEvent","export.moderation_logs.success":"#/components/schemas/AsyncExportModerationLogsEvent","moderation.custom_action":"#/components/schemas/ModerationCustomActionEvent","moderation.flagged":"#/components/schemas/ModerationFlaggedEvent","moderation.mark_reviewed":"#/components/schemas/ModerationMarkReviewedEvent","moderation_check.completed":"#/components/schemas/ModerationCheckCompletedEvent","review_queue_item.new":"#/components/schemas/ReviewQueueItemNewEvent","review_queue_item.updated":"#/components/schemas/ReviewQueueItemUpdatedEvent"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/AsyncBulkImageModerationEvent"},{"$ref":"#/components/schemas/AsyncExportErrorEvent"},{"$ref":"#/components/schemas/AsyncExportErrorEvent"},{"$ref":"#/components/schemas/AsyncExportModerationLogsEvent"},{"$ref":"#/components/schemas/ModerationCheckCompletedEvent"},{"$ref":"#/components/schemas/ModerationCustomActionEvent"},{"$ref":"#/components/schemas/ModerationFlaggedEvent"},{"$ref":"#/components/schemas/ModerationMarkReviewedEvent"},{"$ref":"#/components/schemas/ReviewQueueItemNewEvent"},{"$ref":"#/components/schemas/ReviewQueueItemUpdatedEvent"}]}},"securitySchemes":{"JWT":{"description":"JWT should be always provided when stream-auth-type=jwt.\n\nUsing JWT auth request could be authenticated as user or as server-side.\n\nWhen using user authentication permission checking is going to be applied to requests based on the user that is\nperforming a request.\n\nThe `authorization` header should be a JWT string signed using the secret attached to the API key used to perform\nrequests.\n\n**WARNING** all client-side official SDK do not ship with token generation; this is to make sure that the API secret is not\nshared with an untrusted party such as a browser or a iOS/Android application. Tokens **must** be generated server-side.\nIf you wish, you can configure your application to ignore authentication (see `disable_auth_check`)\nThe JWT string must include only the user_id claim and can include any built-in JWT claim such as iat, exp as well.\n","in":"header","name":"Authorization","type":"apiKey"},"api_key":{"description":"Application API key should be always set in order to authenticate the request.","in":"query","name":"api_key","type":"apiKey"},"stream-auth-type":{"description":"Stream-Auth-Type should be always set in order to authenticate the request. Possible\nvalues: `jwt` or `anonymous`.\n\n`jwt` allows you to authenticate as a user. With this auth type you should also provide valid JWT in Authorization\nheader.\n\n`anonymous` allows you to authenticate as anonymous user. Please note that most advanced features are not available\nto anonymous users.","in":"header","name":"Stream-Auth-Type","type":"apiKey"}}},"info":{"title":"Stream API","version":"v187.13.0"},"openapi":"3.0.3","paths":{"/api/v2/moderation/ban":{"post":{"description":"Ban a user from a channel or the entire app\n","operationId":"ban","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BanRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BanResponse"}}},"description":"Successful 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":"Ban","tags":["product:moderation"]}},"/api/v2/moderation/bulk_image_moderation":{"post":{"description":"Moderate multiple images in bulk using a CSV file\n","operationId":"bulk_image_moderation","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkImageModerationRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkImageModerationResponse"}}},"description":"Successful 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":"Bulk image moderation","tags":["product:moderation"]}},"/api/v2/moderation/check":{"post":{"description":"Run moderation checks on the provided content\n","operationId":"check","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckResponse"}}},"description":"Successful 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":"Check","tags":["product:moderation"]}},"/api/v2/moderation/config":{"post":{"description":"Create a new moderation configuration or update an existing one. Configure settings for content filtering, AI analysis, toxicity detection, and other moderation features.\n","operationId":"upsert_config","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertConfigRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertConfigResponse"}}},"description":"Successful 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":"Create or update moderation configuration","tags":["product:moderation"]}},"/api/v2/moderation/config/{key}":{"delete":{"description":"Delete a specific moderation policy by its name\n","operationId":"delete_config","parameters":[{"in":"path","name":"key","required":true,"schema":{"description":"Key of the moderation configuration to delete","title":"Key","type":"string","x-stream-index":"001"}},{"in":"query","name":"team","schema":{"description":"Team associated with the configuration","title":"Team","type":"string","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteModerationConfigResponse"}}},"description":"Successful 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":"Delete a moderation policy","tags":["product:moderation"]},"get":{"description":"Retrieve a specific moderation configuration by its key and team. This configuration contains settings for various moderation features like toxicity detection, AI analysis, and filtering rules.\n","operationId":"get_config","parameters":[{"in":"path","name":"key","required":true,"schema":{"description":"Key of the moderation configuration to retrieve","title":"Key","type":"string","x-stream-index":"001"}},{"in":"query","name":"team","schema":{"description":"Team associated with the configuration","title":"Team","type":"string","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetConfigResponse"}}},"description":"Successful 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":"Get moderation configuration","tags":["product:moderation"]}},"/api/v2/moderation/configs":{"post":{"description":"Search and filter moderation configurations across your application. This endpoint is designed for building moderation dashboards and managing multiple configuration sets.\n","operationId":"query_moderation_configs","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationConfigsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationConfigsResponse"}}},"description":"Successful 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":"Query moderation configurations","tags":["product:moderation"]}},"/api/v2/moderation/custom_check":{"post":{"description":"Custom check, add your own AI model reports to the review queue\n","operationId":"custom_check","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomCheckRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomCheckResponse"}}},"description":"Successful 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":"Custom check endpoint","tags":["product:moderation"]}},"/api/v2/moderation/feeds_moderation_template":{"delete":{"description":"Delete a specific moderation template by its name\n","operationId":"V2DeleteTemplate","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteModerationTemplateResponse"}}},"description":"Successful 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":"Delete a moderation template","tags":["product:moderation"]},"get":{"description":"Retrieve a list of feed moderation templates that define preset moderation rules and configurations. Limited to 100 templates per request.\n","operationId":"V2QueryTemplates","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryFeedModerationTemplatesResponse"}}},"description":"Successful 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":"Query feed moderation templates","tags":["product:moderation"]},"post":{"description":"Upsert feeds template for moderation\n","operationId":"V2UpsertTemplate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertModerationTemplateRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertModerationTemplateResponse"}}},"description":"Successful 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":"Upsert feeds template","tags":["product:moderation"]}},"/api/v2/moderation/flag":{"post":{"description":"Flag any type of content (messages, users, channels, activities) for moderation review. Supports custom content types and additional metadata for flagged content.\n","operationId":"flag","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlagRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlagResponse"}}},"description":"Successful 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":"Flag content for moderation","tags":["product:moderation"]}},"/api/v2/moderation/flags":{"post":{"description":"Query flags associated with moderation items. This is used for building a moderation dashboard.\n","operationId":"query_moderation_flags","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationFlagsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationFlagsResponse"}}},"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":"Query moderation flags","tags":["product:moderation"]}},"/api/v2/moderation/logs":{"post":{"description":"Search and filter moderation action logs with support for pagination. View the history of moderation actions taken, including who performed them and when.\n","operationId":"query_moderation_logs","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationLogsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationLogsResponse"}}},"description":"Successful 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":"Query moderation action logs","tags":["product:moderation"]}},"/api/v2/moderation/mute":{"post":{"description":"Mute a user. Mutes are generally not visible to the user you mute, while block is something you notice.\n","operationId":"mute","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteRequest"}}},"description":"MuteRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteResponse"}}},"description":"MuteResponse"},"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":"Mute","tags":["product:moderation"]}},"/api/v2/moderation/review_queue":{"post":{"description":"Query review queue items allows you to filter the review queue items. This is used for building a moderation dashboard.\n","operationId":"query_review_queue","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryReviewQueueRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryReviewQueueResponse"}}},"description":"Successful 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":"Query review queue items","tags":["product:moderation"]}},"/api/v2/moderation/review_queue/{id}":{"get":{"description":"Retrieve a specific review queue item by its ID\n","operationId":"get_review_queue_item","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Unique identifier of the review queue item to retrieve","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetReviewQueueItemResponse"}}},"description":"Successful 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":"Get review queue item","tags":["product:moderation"]}},"/api/v2/moderation/submit_action":{"post":{"description":"Take action on flagged content, such as marking content as safe, deleting content, banning users, or executing custom moderation actions. Supports various action types with configurable parameters.\n","operationId":"submit_action","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitActionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitActionResponse"}}},"description":"Successful 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":"Submit moderation action","tags":["product:moderation"]}},"/api/v2/moderation/unban":{"post":{"description":"Unban a user from a channel or globally.\n","operationId":"unban","parameters":[{"in":"query","name":"target_user_id","required":true,"schema":{"description":"ID of the user to unban","title":"Target User ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"channel_cid","schema":{"description":"Channel where the unban applies","title":"Channel CID","type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"created_by","schema":{"description":"ID of the user who created the ban","title":"Created By","type":"string","writeOnly":true,"x-stream-index":"003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnbanRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnbanResponse"}}},"description":"Successful 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":"Unban","tags":["product:moderation"]}},"/api/v2/moderation/unmute":{"post":{"description":"Unmute a user\n","operationId":"unmute","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnmuteRequest"}}},"description":"UnmuteRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnmuteResponse"}}},"description":"UnmuteResponse"},"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":"Unmute a user","tags":["product:moderation"]}}},"security":[{"JWT":[],"api_key":[],"stream-auth-type":[]},{"api_key":[],"stream-auth-type":[]}],"servers":[{"description":"Stream API","url":"https://chat.stream-io-api.com"}]} \ No newline at end of file +{"components":{"schemas":{"AIImageConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"ocr_rules":{"items":{"$ref":"#/components/schemas/OCRRule"},"type":"array","x-stream-index":"004"},"rules":{"items":{"$ref":"#/components/schemas/AWSRekognitionRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules","ocr_rules"],"type":"object"},"AITextConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"profile":{"type":"string","x-stream-index":"003"},"rules":{"items":{"$ref":"#/components/schemas/BodyguardRule"},"type":"array","x-stream-index":"004"},"severity_rules":{"items":{"$ref":"#/components/schemas/BodyguardSeverityRule"},"type":"array","x-stream-index":"005"}},"required":["enabled","profile","rules","severity_rules"],"type":"object"},"AIVideoConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AWSRekognitionRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"APIError":{"nullable":true,"properties":{"StatusCode":{"description":"Response HTTP status code","format":"int32","title":"Status code","type":"integer","x-stream-index":"004"},"code":{"description":"API error code","format":"int32","title":"Code","type":"integer","x-stream-index":"001"},"details":{"description":"Additional error-specific information","items":{"type":"integer"},"title":"Details","type":"array","x-stream-index":"007"},"duration":{"description":"Request duration","title":"Duration","type":"string","x-stream-index":"005"},"exception_fields":{"additionalProperties":{"type":"string"},"description":"Additional error info","title":"Exception fields","type":"object","x-stream-index":"003"},"message":{"description":"Message describing an error","title":"Message","type":"string","x-stream-index":"002"},"more_info":{"description":"URL with additional information","title":"More info","type":"string","x-stream-index":"006"},"unrecoverable":{"description":"Flag that indicates if the error is unrecoverable, requests that return unrecoverable errors should not be retried, this error only applies to the request that caused it","title":"Unrecoverable","type":"boolean","x-stream-index":"008"}},"required":["code","message","StatusCode","duration","more_info","details"],"title":"Error response","type":"object"},"APNS":{"properties":{"body":{"type":"string","x-stream-index":"002"},"content-available":{"format":"int32","type":"integer","x-stream-index":"004"},"data":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"mutable-content":{"format":"int32","type":"integer","x-stream-index":"005"},"sound":{"type":"string","x-stream-index":"003"},"title":{"type":"string","x-stream-index":"001"}},"required":["title","body"],"type":"object"},"AWSRekognitionRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"},"min_confidence":{"format":"float","maximum":100,"minimum":0,"type":"number","x-stream-index":"003"}},"required":["label","action","min_confidence"],"type":"object"},"Action":{"nullable":true,"properties":{"name":{"type":"string","x-stream-index":"001"},"style":{"type":"string","x-stream-index":"003"},"text":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"004"},"value":{"type":"string","x-stream-index":"005"}},"required":["name","text","type"],"type":"object"},"ActionLog":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"002"},"reason":{"type":"string","x-stream-index":"008"},"reporter_type":{"type":"string","x-stream-index":"009"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"014"},"review_queue_item_id":{"type":"string","x-stream-index":"012"},"target_user":{"$ref":"#/components/schemas/User","x-stream-index":"013"},"target_user_id":{"type":"string","x-stream-index":"011"},"type":{"type":"string","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007"}},"required":["id","created_at","type","reason","reporter_type","custom","target_user_id","review_queue_item_id"],"type":"object"},"ActionLogResponse":{"nullable":true,"properties":{"created_at":{"description":"Timestamp when the action was taken","format":"date-time","title":"Created At","type":"number","x-stream-index":"002"},"custom":{"additionalProperties":{},"description":"Additional metadata about the action","title":"Custom","type":"object","x-stream-index":"007"},"id":{"description":"Unique identifier of the action log","title":"ID","type":"string","x-stream-index":"001"},"reason":{"description":"Reason for the moderation action","title":"Reason","type":"string","x-stream-index":"006"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"Associated review queue item","title":"Review Queue Item","x-stream-index":"008"},"target_user":{"$ref":"#/components/schemas/UserResponse","description":"User who was the target of the action","title":"Target User","x-stream-index":"009"},"target_user_id":{"description":"ID of the user who was the target of the action","title":"Target User ID","type":"string","x-stream-index":"010"},"type":{"description":"Type of moderation action","title":"Type","type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who performed the action","title":"User","x-stream-index":"004"},"user_id":{"description":"ID of the user who performed the action","title":"User ID","type":"string","x-stream-index":"005"}},"required":["id","created_at","type","user_id","reason","custom","target_user_id"],"type":"object"},"ActionSequence":{"properties":{"action":{"type":"string","x-stream-index":"001"},"blur":{"type":"boolean","x-stream-index":"005"},"cooldown_period":{"format":"int32","type":"integer","x-stream-index":"004"},"threshold":{"format":"int32","type":"integer","x-stream-index":"002"},"time_window":{"format":"int32","type":"integer","x-stream-index":"003"},"warning":{"type":"boolean","x-stream-index":"006"},"warning_text":{"type":"string","x-stream-index":"007"}},"required":["action","threshold","time_window","cooldown_period","blur","warning","warning_text"],"type":"object"},"AsyncBulkImageModerationEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"003.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.007"},"finished_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.004"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"task_id":{"type":"string","x-stream-index":"002.001"},"type":{"default":"export.bulk_image_moderation.success","type":"string","x-stream-index":"003.002"},"url":{"type":"string","x-stream-index":"001"}},"required":["url","task_id","started_at","finished_at","type","created_at","custom"],"title":"AsyncBulkImageModerationEvent","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"},"AsyncExportErrorEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"003.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.007"},"error":{"type":"string","x-stream-index":"001"},"finished_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.004"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"task_id":{"type":"string","x-stream-index":"002.001"},"type":{"default":"export.moderation_logs.error","type":"string","x-stream-index":"003.002"}},"required":["error","task_id","started_at","finished_at","type","created_at","custom"],"title":"AsyncExportErrorEvent","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"},"AsyncExportModerationLogsEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"003.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.007"},"finished_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.004"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"task_id":{"type":"string","x-stream-index":"002.001"},"type":{"default":"export.moderation_logs.success","type":"string","x-stream-index":"003.002"},"url":{"type":"string","x-stream-index":"001"}},"required":["url","task_id","started_at","finished_at","type","created_at","custom"],"title":"AsyncExportModerationLogsEvent","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"},"Attachment":{"description":"An attachment is a message object that represents a file uploaded by a user.","nullable":true,"properties":{"actions":{"items":{"$ref":"#/components/schemas/Action"},"type":"array","x-stream-index":"015"},"asset_url":{"type":"string","x-stream-index":"017"},"author_icon":{"type":"string","x-stream-index":"007"},"author_link":{"type":"string","x-stream-index":"006"},"author_name":{"type":"string","x-stream-index":"005"},"color":{"type":"string","x-stream-index":"003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"018"},"fallback":{"type":"string","x-stream-index":"002"},"fields":{"items":{"$ref":"#/components/schemas/Field"},"type":"array","x-stream-index":"016"},"footer":{"type":"string","x-stream-index":"013"},"footer_icon":{"type":"string","x-stream-index":"014"},"giphy":{"$ref":"#/components/schemas/Images","x-stream-index":"019"},"image_url":{"type":"string","x-stream-index":"011"},"og_scrape_url":{"type":"string","x-stream-index":"020"},"original_height":{"format":"int32","type":"integer","x-stream-index":"022"},"original_width":{"format":"int32","type":"integer","x-stream-index":"021"},"pretext":{"type":"string","x-stream-index":"004"},"text":{"type":"string","x-stream-index":"010"},"thumb_url":{"type":"string","x-stream-index":"012"},"title":{"type":"string","x-stream-index":"008"},"title_link":{"type":"string","x-stream-index":"009"},"type":{"description":"Attachment type (e.g. image, video, url)","title":"Type","type":"string","x-stream-index":"001"}},"required":["custom"],"title":"Attachment","type":"object","x-stream-docs-page-id":"file_uploads"},"AudioSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"001"},"default_device":{"enum":["speaker","earpiece"],"type":"string","x-stream-index":"006"},"mic_default_on":{"type":"boolean","x-stream-index":"004"},"noise_cancellation":{"$ref":"#/components/schemas/NoiseCancellationSettings","x-stream-index":"007"},"opus_dtx_enabled":{"type":"boolean","x-stream-index":"002"},"redundant_coding_enabled":{"type":"boolean","x-stream-index":"003"},"speaker_default_on":{"type":"boolean","x-stream-index":"005"}},"required":["access_request_enabled","opus_dtx_enabled","redundant_coding_enabled","mic_default_on","speaker_default_on","default_device"],"type":"object"},"AudioSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"001"},"default_device":{"enum":["speaker","earpiece"],"type":"string","x-stream-index":"006"},"mic_default_on":{"type":"boolean","x-stream-index":"004"},"noise_cancellation":{"$ref":"#/components/schemas/NoiseCancellationSettings","x-stream-index":"007"},"opus_dtx_enabled":{"type":"boolean","x-stream-index":"002"},"redundant_coding_enabled":{"type":"boolean","x-stream-index":"003"},"speaker_default_on":{"type":"boolean","x-stream-index":"005"}},"required":["access_request_enabled","opus_dtx_enabled","redundant_coding_enabled","mic_default_on","speaker_default_on","default_device"],"type":"object"},"AutomodPlatformCircumventionConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AutomodRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"AutomodRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"003"},"label":{"type":"string","x-stream-index":"001"},"threshold":{"format":"float","maximum":1,"minimum":0,"type":"number","x-stream-index":"002"}},"required":["label","threshold","action"],"type":"object"},"AutomodSemanticFiltersConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AutomodSemanticFiltersRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"AutomodSemanticFiltersRule":{"properties":{"action":{"enum":["flag","shadow","remove"],"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"threshold":{"format":"float","maximum":1,"minimum":0,"type":"number","x-stream-index":"002"}},"required":["name","threshold","action"],"type":"object"},"AutomodToxicityConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AutomodRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"BackstageSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"BackstageSettingsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"Ban":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"012"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"011"},"expires":{"format":"date-time","type":"number","x-stream-index":"007"},"reason":{"type":"string","x-stream-index":"008"},"shadow":{"type":"boolean","x-stream-index":"009"},"target":{"$ref":"#/components/schemas/User","x-stream-index":"006"}},"required":["shadow","created_at"],"type":"object"},"BanActionRequest":{"properties":{"channel_ban_only":{"type":"boolean","x-stream-index":"003"},"delete_messages":{"enum":["soft","pruning","hard"],"type":"string","x-stream-index":"005"},"ip_ban":{"type":"boolean","x-stream-index":"004"},"reason":{"type":"string","x-stream-index":"002"},"shadow":{"type":"boolean","x-stream-index":"001"},"timeout":{"format":"int32","type":"integer","x-stream-index":"006"}},"type":"object"},"BanOptions":{"properties":{"duration":{"format":"int32","type":"integer","x-stream-index":"001"},"ip_ban":{"type":"boolean","x-stream-index":"004"},"reason":{"type":"string","x-stream-index":"002"},"shadow_ban":{"type":"boolean","x-stream-index":"003"}},"type":"object"},"BanRequest":{"nullable":true,"properties":{"banned_by":{"$ref":"#/components/schemas/UserRequest","description":"Details about the user performing the ban","title":"Banned By","x-stream-index":"008"},"banned_by_id":{"description":"ID of the user performing the ban","title":"Banned By ID","type":"string","x-stream-index":"007"},"channel_cid":{"description":"Channel where the ban applies","title":"Channel CID","type":"string","x-stream-index":"004"},"delete_messages":{"enum":["soft","pruning","hard"],"type":"string","x-stream-index":"009"},"ip_ban":{"description":"Whether to ban the user's IP address","title":"IP Ban","type":"boolean","x-stream-index":"006"},"reason":{"description":"Optional explanation for the ban","title":"Reason","type":"string","x-stream-index":"003"},"shadow":{"description":"Whether this is a shadow ban","title":"Shadow","type":"boolean","x-stream-index":"005"},"target_user_id":{"description":"ID of the user to ban","title":"Target User ID","type":"string","x-stream-index":"001"},"timeout":{"description":"Duration of the ban in minutes","minimum":0,"title":"Timeout","type":"integer","x-stream-index":"002"}},"required":["target_user_id"],"type":"object"},"BanResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"BlockContentOptions":{"properties":{"reason":{"type":"string","x-stream-index":"001"}},"type":"object"},"BlockListConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/BlockListRule"},"maximum":10,"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"BlockListOptions":{"properties":{"behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"002"},"blocklist":{"type":"string","x-stream-index":"001"}},"required":["blocklist","behavior"],"type":"object"},"BlockListRule":{"properties":{"action":{"enum":["flag","mask_flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"002"}},"required":["name","team","action"],"type":"object"},"BodyguardRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"},"severity_rules":{"items":{"$ref":"#/components/schemas/BodyguardSeverityRule"},"type":"array","x-stream-index":"003"}},"required":["label","action","severity_rules"],"type":"object"},"BodyguardSeverityRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"severity":{"enum":["low","medium","high","critical"],"type":"string","x-stream-index":"001"}},"required":["severity","action"],"type":"object"},"BroadcastSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettings","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettings","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"BroadcastSettingsResponse":{"description":"BroadcastSettingsResponse is the payload for broadcasting settings","properties":{"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettingsResponse","title":"HLS","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettingsResponse","title":"RTMP","x-stream-index":"003"}},"required":["enabled","hls","rtmp"],"title":"BroadcastSettingsResponse","type":"object"},"BulkImageModerationRequest":{"nullable":true,"properties":{"csv_file":{"description":"URL to CSV file containing image URLs to moderate","title":"string","type":"string","x-stream-index":"001"}},"required":["csv_file"],"type":"object"},"BulkImageModerationResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"task_id":{"description":"ID of the task for processing the bulk image moderation","title":"string","type":"string","x-stream-index":"001"}},"required":["task_id","duration"],"type":"object"},"Call":{"properties":{"AppPK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"002"},"Backstage":{"type":"boolean","writeOnly":true,"x-stream-index":"023"},"BlockedUserIDs":{"items":{"type":"string"},"type":"array","writeOnly":true,"x-stream-index":"018"},"BlockedUsers":{"items":{"$ref":"#/components/schemas/User"},"type":"array","writeOnly":true,"x-stream-index":"019"},"CID":{"type":"string","writeOnly":true,"x-stream-index":"005"},"CallType":{"$ref":"#/components/schemas/CallType","x-stream-index":"020"},"ChannelCID":{"type":"string","writeOnly":true,"x-stream-index":"032"},"CreatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"013"},"CreatedBy":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"CreatedByUserID":{"type":"string","writeOnly":true,"x-stream-index":"007"},"CurrentSessionID":{"type":"string","writeOnly":true,"x-stream-index":"024"},"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"012"},"DeletedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"028"},"EgressUpdatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"027"},"Egresses":{"items":{"$ref":"#/components/schemas/CallEgress"},"type":"array","writeOnly":true,"x-stream-index":"015"},"EndedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"017"},"ID":{"type":"string","writeOnly":true,"x-stream-index":"004"},"JoinAheadTimeSeconds":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"031"},"LastHeartbeatAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"030"},"LastSessionID":{"type":"string","writeOnly":true,"x-stream-index":"025"},"MemberCount":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"010"},"MemberLookup":{"$ref":"#/components/schemas/MemberLookup","x-stream-index":"011"},"Members":{"items":{"$ref":"#/components/schemas/CallMember"},"type":"array","writeOnly":true,"x-stream-index":"009"},"Session":{"$ref":"#/components/schemas/CallSession","x-stream-index":"026"},"Settings":{"$ref":"#/components/schemas/CallSettings","x-stream-index":"022"},"SettingsOverrides":{"$ref":"#/components/schemas/CallSettings","x-stream-index":"021"},"StartsAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"016"},"Team":{"type":"string","writeOnly":true,"x-stream-index":"006"},"ThumbnailURL":{"type":"string","writeOnly":true,"x-stream-index":"029"},"Type":{"type":"string","writeOnly":true,"x-stream-index":"003"},"UpdatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"014"}},"required":["AppPK","Type","ID","CID","Team","CreatedByUserID","Members","Custom","CreatedAt","UpdatedAt","Egresses","BlockedUserIDs","BlockedUsers","Backstage","CurrentSessionID","LastSessionID","ThumbnailURL","ChannelCID"],"type":"object"},"CallEgress":{"nullable":true,"properties":{"app_pk":{"format":"int32","type":"integer","x-stream-index":"002"},"call_id":{"type":"string","x-stream-index":"004"},"call_type":{"type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/EgressTaskConfig","x-stream-index":"007"},"egress_id":{"type":"string","x-stream-index":"005"},"egress_type":{"type":"string","x-stream-index":"006"},"instance_ip":{"type":"string","x-stream-index":"008"},"started_at":{"format":"date-time","type":"number","x-stream-index":"010"},"state":{"type":"string","x-stream-index":"009"},"stopped_at":{"format":"date-time","type":"number","x-stream-index":"011"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"012"}},"required":["app_pk","call_type","call_id","egress_id","egress_type","instance_ip","state","started_at","updated_at"],"type":"object"},"CallIngressResponse":{"description":"CallIngressResponse is the payload for ingress settings","properties":{"rtmp":{"$ref":"#/components/schemas/RTMPIngress","title":"RTMP","x-stream-index":"001"}},"required":["rtmp"],"title":"CallIngressResponse","type":"object"},"CallMember":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"010"},"role":{"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["user_id","role","custom","created_at","updated_at"],"type":"object"},"CallParticipant":{"nullable":true,"properties":{"JoinedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"004"},"Role":{"type":"string","writeOnly":true,"x-stream-index":"002"},"UserSessionID":{"type":"string","writeOnly":true,"x-stream-index":"003"},"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"001.046"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"001.017"},"banned":{"type":"boolean","x-stream-index":"001.016"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.013"},"id":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"001.023"},"language":{"type":"string","x-stream-index":"001.035"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"001.022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"001.026"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.042"},"role":{"type":"string","x-stream-index":"001.004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.005"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.009"}},"required":["id","role","teams_role","custom","banned","online","Role","UserSessionID","JoinedAt"],"type":"object"},"CallParticipantResponse":{"properties":{"joined_at":{"format":"date-time","type":"number","x-stream-index":"004"},"role":{"type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"},"user_session_id":{"type":"string","x-stream-index":"002"}},"required":["user","user_session_id","role","joined_at"],"type":"object"},"CallResponse":{"description":"Represents a call","properties":{"backstage":{"type":"boolean","x-stream-index":"016"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"018"},"captioning":{"type":"boolean","x-stream-index":"013"},"channel_cid":{"type":"string","x-stream-index":"024"},"cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"The user that created the call","title":"Created By","x-stream-index":"007"},"current_session_id":{"type":"string","x-stream-index":"005"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"008"},"egress":{"$ref":"#/components/schemas/EgressResponse","x-stream-index":"021"},"ended_at":{"description":"Date/time when the call ended","format":"date-time","title":"Ended At","type":"number","x-stream-index":"014"},"id":{"description":"Call ID","title":"ID","type":"string","x-stream-index":"003"},"ingress":{"$ref":"#/components/schemas/CallIngressResponse","x-stream-index":"019"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"023"},"recording":{"type":"boolean","x-stream-index":"011"},"session":{"$ref":"#/components/schemas/CallSessionResponse","x-stream-index":"020"},"settings":{"$ref":"#/components/schemas/CallSettingsResponse","x-stream-index":"017"},"starts_at":{"description":"Date/time when the call will start","format":"date-time","title":"Starts At","type":"number","x-stream-index":"015"},"team":{"type":"string","x-stream-index":"006"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailResponse","x-stream-index":"022"},"transcribing":{"type":"boolean","x-stream-index":"012"},"type":{"description":"The type of call","title":"Type","type":"string","x-stream-index":"002"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"}},"required":["type","id","cid","current_session_id","created_by","custom","created_at","updated_at","recording","transcribing","captioning","backstage","settings","blocked_user_ids","ingress","egress"],"title":"CallResponse","type":"object"},"CallSession":{"properties":{"AcceptedBy":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","writeOnly":true,"x-stream-index":"008"},"ActiveSFUs":{"items":{"$ref":"#/components/schemas/SFUIDLastSeen"},"type":"array","writeOnly":true,"x-stream-index":"016"},"AnonymousParticipantCount":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"019"},"AppPK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"002.001"},"CallID":{"type":"string","writeOnly":true,"x-stream-index":"002.003"},"CallType":{"type":"string","writeOnly":true,"x-stream-index":"002.002"},"CreatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"003"},"DeletedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"004"},"EndedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"006"},"LiveEndedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"013"},"LiveStartedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"012"},"MissedBy":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","writeOnly":true,"x-stream-index":"010"},"Participants":{"items":{"$ref":"#/components/schemas/CallParticipant"},"type":"array","writeOnly":true,"x-stream-index":"011"},"ParticipantsCountByRole":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","writeOnly":true,"x-stream-index":"018"},"RejectedBy":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","writeOnly":true,"x-stream-index":"009"},"RingAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"007"},"SFUIDs":{"items":{"type":"string"},"type":"array","writeOnly":true,"x-stream-index":"015"},"SessionID":{"type":"string","writeOnly":true,"x-stream-index":"002.004"},"StartedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"005"},"TimerEndsAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"014"},"UserPermissionOverrides":{"additionalProperties":{"additionalProperties":{"type":"boolean"},"type":"object"},"type":"object","writeOnly":true,"x-stream-index":"017"}},"required":["AppPK","CallType","CallID","SessionID","CreatedAt","AcceptedBy","RejectedBy","MissedBy","Participants","SFUIDs","ActiveSFUs","UserPermissionOverrides","ParticipantsCountByRole","AnonymousParticipantCount"],"type":"object"},"CallSessionResponse":{"properties":{"accepted_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"008"},"anonymous_participant_count":{"format":"int32","type":"integer","x-stream-index":"006"},"ended_at":{"format":"date-time","type":"number","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"live_ended_at":{"format":"date-time","type":"number","x-stream-index":"011"},"live_started_at":{"format":"date-time","type":"number","x-stream-index":"010"},"missed_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"009"},"participants":{"items":{"$ref":"#/components/schemas/CallParticipantResponse"},"type":"array","x-stream-index":"004"},"participants_count_by_role":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"005"},"rejected_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"007"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002"},"timer_ends_at":{"format":"date-time","type":"number","x-stream-index":"012"}},"required":["id","participants","participants_count_by_role","anonymous_participant_count","rejected_by","accepted_by","missed_by"],"type":"object"},"CallSettings":{"properties":{"audio":{"$ref":"#/components/schemas/AudioSettings","x-stream-index":"001"},"backstage":{"$ref":"#/components/schemas/BackstageSettings","x-stream-index":"002"},"broadcasting":{"$ref":"#/components/schemas/BroadcastSettings","x-stream-index":"007"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordSettings","x-stream-index":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettings","x-stream-index":"008"},"ingress":{"$ref":"#/components/schemas/IngressSettings","x-stream-index":"014"},"limits":{"$ref":"#/components/schemas/LimitsSettings","x-stream-index":"012"},"recording":{"$ref":"#/components/schemas/RecordSettings","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettings","x-stream-index":"010"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettings","x-stream-index":"004"},"session":{"$ref":"#/components/schemas/SessionSettings","x-stream-index":"013"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettings","x-stream-index":"011"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettings","x-stream-index":"009"},"video":{"$ref":"#/components/schemas/VideoSettings","x-stream-index":"003"}},"type":"object"},"CallSettingsResponse":{"properties":{"audio":{"$ref":"#/components/schemas/AudioSettingsResponse","x-stream-index":"001"},"backstage":{"$ref":"#/components/schemas/BackstageSettingsResponse","x-stream-index":"002"},"broadcasting":{"$ref":"#/components/schemas/BroadcastSettingsResponse","x-stream-index":"003"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordingSettingsResponse","x-stream-index":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettingsResponse","x-stream-index":"004"},"ingress":{"$ref":"#/components/schemas/IngressSettingsResponse","x-stream-index":"014"},"limits":{"$ref":"#/components/schemas/LimitsSettingsResponse","x-stream-index":"012"},"recording":{"$ref":"#/components/schemas/RecordSettingsResponse","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettingsResponse","x-stream-index":"007"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettingsResponse","x-stream-index":"008"},"session":{"$ref":"#/components/schemas/SessionSettingsResponse","x-stream-index":"013"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettingsResponse","x-stream-index":"011"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettingsResponse","x-stream-index":"009"},"video":{"$ref":"#/components/schemas/VideoSettingsResponse","x-stream-index":"010"}},"required":["audio","backstage","broadcasting","geofencing","recording","frame_recording","ring","screensharing","transcription","video","thumbnails","limits","session"],"type":"object"},"CallType":{"properties":{"AppPK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"003"},"CreatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"005"},"ExternalStorage":{"type":"string","writeOnly":true,"x-stream-index":"009"},"Name":{"type":"string","writeOnly":true,"x-stream-index":"004"},"NotificationSettings":{"$ref":"#/components/schemas/NotificationSettings","x-stream-index":"008"},"PK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"002"},"Settings":{"$ref":"#/components/schemas/CallSettings","x-stream-index":"007"},"UpdatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"006"}},"required":["PK","AppPK","Name","CreatedAt","UpdatedAt","ExternalStorage"],"type":"object"},"Channel":{"properties":{"active_live_locations":{"items":{"$ref":"#/components/schemas/SharedLocation"},"type":"array","x-stream-index":"034"},"auto_translation_enabled":{"type":"boolean","x-stream-index":"029"},"auto_translation_language":{"type":"string","x-stream-index":"030"},"cid":{"type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/ChannelConfig","x-stream-index":"026"},"config_overrides":{"$ref":"#/components/schemas/ConfigOverrides","x-stream-index":"027"},"cooldown":{"format":"int32","type":"integer","x-stream-index":"031"},"created_at":{"format":"date-time","type":"number","x-stream-index":"009"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"019"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"disabled":{"type":"boolean","x-stream-index":"017"},"frozen":{"type":"boolean","x-stream-index":"016"},"id":{"type":"string","x-stream-index":"004"},"invites":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"022"},"last_campaigns":{"type":"string","x-stream-index":"032"},"last_message_at":{"format":"date-time","type":"number","x-stream-index":"006"},"member_count":{"format":"int32","type":"integer","x-stream-index":"021"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"020"},"message_count":{"format":"int64","type":"integer","x-stream-index":"035"},"message_count_updated_at":{"format":"date-time","type":"number","x-stream-index":"036"},"team":{"type":"string","x-stream-index":"028"},"truncated_by":{"$ref":"#/components/schemas/User","x-stream-index":"015"},"type":{"type":"string","x-stream-index":"005"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"010"}},"required":["cid","id","type","created_at","updated_at","frozen","disabled","custom","auto_translation_language"],"type":"object"},"ChannelConfig":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.027"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.022"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.023"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.028"},"blocklist":{"type":"string","x-stream-index":"001.024"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.025"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.026"},"commands":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"connect_events":{"type":"boolean","x-stream-index":"001.004"},"count_messages":{"type":"boolean","x-stream-index":"001.019"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"custom_events":{"type":"boolean","x-stream-index":"001.012"},"mark_messages_pending":{"type":"boolean","x-stream-index":"001.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"001.021"},"mutes":{"type":"boolean","x-stream-index":"001.009"},"name":{"type":"string","x-stream-index":"001.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"001.029"},"partition_ttl":{"type":"integer","x-stream-index":"001.030"},"polls":{"type":"boolean","x-stream-index":"001.016"},"push_notifications":{"type":"boolean","x-stream-index":"001.013"},"quotes":{"type":"boolean","x-stream-index":"001.008"},"reactions":{"type":"boolean","x-stream-index":"001.006"},"read_events":{"type":"boolean","x-stream-index":"001.003"},"reminders":{"type":"boolean","x-stream-index":"001.014"},"replies":{"type":"boolean","x-stream-index":"001.007"},"search":{"type":"boolean","x-stream-index":"001.005"},"shared_locations":{"type":"boolean","x-stream-index":"001.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.031"},"typing_events":{"type":"boolean","x-stream-index":"001.002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"002.004"},"uploads":{"type":"boolean","x-stream-index":"001.010"},"url_enrichment":{"type":"boolean","x-stream-index":"001.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"001.017"}},"required":["name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","count_messages","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","created_at","updated_at","commands"],"type":"object"},"ChannelConfigWithInfo":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.002.027"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.002.022"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.023"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.002.028"},"blocklist":{"type":"string","x-stream-index":"001.002.024"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.025"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.002.026"},"commands":{"items":{"$ref":"#/components/schemas/Command"},"type":"array","x-stream-index":"001.003"},"connect_events":{"type":"boolean","x-stream-index":"001.002.004"},"count_messages":{"type":"boolean","x-stream-index":"001.002.019"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.001.003"},"custom_events":{"type":"boolean","x-stream-index":"001.002.012"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"002"},"mark_messages_pending":{"type":"boolean","x-stream-index":"001.002.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"001.002.021"},"mutes":{"type":"boolean","x-stream-index":"001.002.009"},"name":{"type":"string","x-stream-index":"001.002.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"001.002.029"},"partition_ttl":{"type":"integer","x-stream-index":"001.002.030"},"polls":{"type":"boolean","x-stream-index":"001.002.016"},"push_notifications":{"type":"boolean","x-stream-index":"001.002.013"},"quotes":{"type":"boolean","x-stream-index":"001.002.008"},"reactions":{"type":"boolean","x-stream-index":"001.002.006"},"read_events":{"type":"boolean","x-stream-index":"001.002.003"},"reminders":{"type":"boolean","x-stream-index":"001.002.014"},"replies":{"type":"boolean","x-stream-index":"001.002.007"},"search":{"type":"boolean","x-stream-index":"001.002.005"},"shared_locations":{"type":"boolean","x-stream-index":"001.002.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.002.031"},"typing_events":{"type":"boolean","x-stream-index":"001.002.002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"uploads":{"type":"boolean","x-stream-index":"001.002.010"},"url_enrichment":{"type":"boolean","x-stream-index":"001.002.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"001.002.017"}},"required":["created_at","updated_at","name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","count_messages","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","commands"],"type":"object"},"ChannelMember":{"nullable":true,"properties":{"archived_at":{"format":"date-time","type":"number","x-stream-index":"021"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"017"},"banned":{"type":"boolean","x-stream-index":"016"},"channel_role":{"type":"string","x-stream-index":"024"},"created_at":{"format":"date-time","type":"number","x-stream-index":"012"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"014"},"deleted_messages":{"items":{"type":"string"},"type":"array","x-stream-index":"027"},"invite_accepted_at":{"format":"date-time","type":"number","x-stream-index":"009"},"invite_rejected_at":{"format":"date-time","type":"number","x-stream-index":"010"},"invited":{"type":"boolean","x-stream-index":"008"},"is_global_banned":{"type":"boolean","x-stream-index":"020"},"is_moderator":{"type":"boolean","x-stream-index":"007"},"notifications_muted":{"type":"boolean","x-stream-index":"026"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"022"},"shadow_banned":{"type":"boolean","x-stream-index":"019"},"status":{"type":"string","x-stream-index":"011"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"013"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["custom","created_at","updated_at","banned","shadow_banned","is_global_banned","channel_role","notifications_muted"],"type":"object"},"ChannelMute":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"007"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"expires":{"description":"Date/time of mute expiration","format":"date-time","title":"Expires","type":"number","x-stream-index":"008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/User","description":"Owner of channel mute","title":"User","x-stream-index":"005"}},"required":["created_at","updated_at"],"type":"object"},"ChannelResponse":{"properties":{"auto_translation_enabled":{"type":"boolean","x-stream-index":"021"},"auto_translation_language":{"type":"string","x-stream-index":"022"},"blocked":{"type":"boolean","x-stream-index":"027"},"cid":{"type":"string","x-stream-index":"005"},"config":{"$ref":"#/components/schemas/ChannelConfigWithInfo","x-stream-index":"017"},"cooldown":{"format":"int32","type":"integer","x-stream-index":"024"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"011"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"030"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"010"},"disabled":{"type":"boolean","x-stream-index":"013"},"frozen":{"type":"boolean","x-stream-index":"012"},"hidden":{"type":"boolean","x-stream-index":"026"},"hide_messages_before":{"format":"date-time","type":"number","x-stream-index":"023"},"id":{"type":"string","x-stream-index":"003"},"last_message_at":{"format":"date-time","type":"number","x-stream-index":"006"},"member_count":{"format":"int32","type":"integer","x-stream-index":"015"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"014"},"message_count":{"format":"int64","type":"integer","x-stream-index":"031"},"mute_expires_at":{"format":"date-time","type":"number","x-stream-index":"019"},"muted":{"type":"boolean","x-stream-index":"018"},"own_capabilities":{"items":{"type":"string"},"type":"array","x-stream-index":"025"},"team":{"type":"string","x-stream-index":"020"},"truncated_at":{"format":"date-time","type":"number","x-stream-index":"028"},"truncated_by":{"$ref":"#/components/schemas/User","x-stream-index":"029"},"type":{"type":"string","x-stream-index":"004"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"}},"required":["id","type","cid","created_at","updated_at","frozen","disabled","custom"],"type":"object"},"CheckRequest":{"nullable":true,"properties":{"config_key":{"description":"Key of the moderation configuration to use","title":"Config Key","type":"string","x-stream-index":"005"},"config_team":{"description":"Team associated with the configuration","title":"Config Team","type":"string","x-stream-index":"006"},"entity_creator_id":{"description":"ID of the user who created the entity","title":"Entity Creator ID","type":"string","x-stream-index":"003"},"entity_id":{"description":"Unique identifier of the entity to moderate","title":"Entity ID","type":"string","x-stream-index":"002"},"entity_type":{"description":"Type of entity to moderate","title":"Entity Type","type":"string","x-stream-index":"001"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content to be moderated","title":"Moderation Payload","x-stream-index":"004"},"options":{"additionalProperties":{},"description":"Additional moderation configuration options","title":"Options","type":"object","x-stream-index":"007"},"test_mode":{"description":"Whether to run moderation in test mode","title":"Test Mode","type":"boolean","x-stream-index":"008"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"009.002"},"user_id":{"type":"string","x-stream-index":"009.001"}},"required":["entity_type","entity_id","entity_creator_id"],"type":"object"},"CheckResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"005.001"},"item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"Review queue item (present if action != keep)","title":"Item","x-stream-index":"004"},"recommended_action":{"description":"Suggested action based on moderation results","title":"Recommended Action","type":"string","x-stream-index":"003"},"status":{"description":"Status of the moderation check (completed or pending)","title":"Status","type":"string","x-stream-index":"001"},"task_id":{"description":"ID of the running moderation task","title":"Task ID","type":"string","x-stream-index":"002"}},"required":["status","recommended_action","duration"],"type":"object"},"Command":{"description":"Represents custom chat command","nullable":true,"properties":{"args":{"description":"Arguments help text, shown in commands auto-completion","title":"Arguments","type":"string","x-stream-index":"006"},"created_at":{"description":"Date/time of creation","format":"date-time","readOnly":true,"title":"Created at","type":"number","x-stream-index":"001"},"description":{"description":"Description, shown in commands auto-completion","title":"Description","type":"string","x-stream-index":"005"},"name":{"description":"Unique command name","title":"Name","type":"string","x-stream-index":"004"},"set":{"description":"Set name used for grouping commands","title":"Set","type":"string","x-stream-index":"007"},"updated_at":{"description":"Date/time of the last update","format":"date-time","readOnly":true,"title":"Updated at","type":"number","x-stream-index":"002"}},"required":["name","description","args","set"],"title":"Command","type":"object"},"CompositeAppSettings":{"properties":{"json_encoded_settings":{"type":"string","x-stream-index":"005"},"url":{"type":"string","x-stream-index":"004"}},"type":"object"},"ConfigOverrides":{"properties":{"blocklist":{"type":"string","x-stream-index":"008"},"blocklist_behavior":{"enum":["flag","block"],"type":"string","x-stream-index":"009"},"commands":{"items":{"type":"string"},"type":"array","x-stream-index":"011"},"count_messages":{"type":"boolean","x-stream-index":"014"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"010"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"007"},"quotes":{"type":"boolean","x-stream-index":"004"},"reactions":{"type":"boolean","x-stream-index":"002"},"replies":{"type":"boolean","x-stream-index":"003"},"shared_locations":{"type":"boolean","x-stream-index":"013"},"typing_events":{"type":"boolean","x-stream-index":"001"},"uploads":{"type":"boolean","x-stream-index":"005"},"url_enrichment":{"type":"boolean","x-stream-index":"006"},"user_message_reminders":{"type":"boolean","x-stream-index":"012"}},"required":["grants","commands"],"type":"object"},"ConfigResponse":{"properties":{"ai_image_config":{"$ref":"#/components/schemas/AIImageConfig","description":"Configuration for AI image analysis","title":"AI Image Config","x-stream-index":"010"},"ai_text_config":{"$ref":"#/components/schemas/AITextConfig","description":"Configuration for AI text analysis","title":"AI Text Config","x-stream-index":"008"},"ai_video_config":{"$ref":"#/components/schemas/AIVideoConfig","description":"Configuration for AI video analysis","title":"AI Video Config","x-stream-index":"011"},"async":{"description":"Whether moderation should be performed asynchronously","title":"Async","type":"boolean","x-stream-index":"003"},"automod_platform_circumvention_config":{"$ref":"#/components/schemas/AutomodPlatformCircumventionConfig","description":"Configuration for platform circumvention detection","title":"Automod Platform Circumvention Config","x-stream-index":"005"},"automod_semantic_filters_config":{"$ref":"#/components/schemas/AutomodSemanticFiltersConfig","description":"Configuration for semantic filtering","title":"Automod Semantic Filters Config","x-stream-index":"006"},"automod_toxicity_config":{"$ref":"#/components/schemas/AutomodToxicityConfig","description":"Configuration for toxicity detection","title":"Automod Toxicity Config","x-stream-index":"004"},"block_list_config":{"$ref":"#/components/schemas/BlockListConfig","description":"Configuration for block list filtering","title":"Block List Config","x-stream-index":"007"},"created_at":{"description":"When the configuration was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"013"},"key":{"description":"Unique identifier for the moderation configuration","title":"Key","type":"string","x-stream-index":"001"},"llm_config":{"$ref":"#/components/schemas/LLMConfig","description":"Configuration for customer-configured LLM moderation","title":"LLM Config","x-stream-index":"009"},"team":{"description":"Team associated with the configuration","title":"Team","type":"string","x-stream-index":"002"},"updated_at":{"description":"When the configuration was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"014"},"velocity_filter_config":{"$ref":"#/components/schemas/VelocityFilterConfig","description":"Configuration for velocity-based filtering","title":"Velocity Filter Config","x-stream-index":"012"},"video_call_rule_config":{"$ref":"#/components/schemas/VideoCallRuleConfig","x-stream-index":"015"}},"required":["key","team","async","created_at","updated_at"],"type":"object"},"ContentCountRuleParameters":{"properties":{"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"type":"object"},"CustomActionRequest":{"properties":{"id":{"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"type":"object"},"CustomCheckFlag":{"properties":{"custom":{"additionalProperties":{},"description":"Additional metadata for the flag","title":"Custom","type":"object","x-stream-index":"003"},"labels":{"description":"Labels from various moderation sources","items":{"type":"string"},"title":"Labels","type":"array","x-stream-index":"004"},"reason":{"description":"Optional explanation for the flag","title":"Reason","type":"string","x-stream-index":"002"},"type":{"description":"Type of check (custom_check_text, custom_check_image, custom_check_video)","maxLength":255,"title":"Type","type":"string","x-stream-index":"001"}},"required":["type"],"type":"object"},"CustomCheckRequest":{"nullable":true,"properties":{"entity_creator_id":{"description":"ID of the user who created the entity (required for non-message entities)","title":"Entity Creator ID","type":"string","x-stream-index":"003"},"entity_id":{"description":"Unique identifier of the entity","title":"Entity ID","type":"string","x-stream-index":"002"},"entity_type":{"description":"Type of entity to perform custom check on","title":"Entity Type","type":"string","x-stream-index":"001"},"flags":{"description":"List of custom check flags (1-10 flags required)","items":{"$ref":"#/components/schemas/CustomCheckFlag"},"maximum":10,"minimum":1,"title":"Flags","type":"array","x-stream-index":"005"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content to be checked (required for non-message entities)","title":"Moderation Payload","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"006.002"},"user_id":{"type":"string","x-stream-index":"006.001"}},"required":["entity_type","entity_id","flags"],"type":"object"},"CustomCheckResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"004.001"},"id":{"description":"Unique identifier of the custom check","title":"ID","type":"string","x-stream-index":"001"},"item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"Review queue item details","title":"Item","x-stream-index":"002"},"status":{"description":"Status of the custom check","title":"Status","type":"string","x-stream-index":"003"}},"required":["id","status","duration"],"type":"object"},"Data":{"properties":{"id":{"type":"string","x-stream-index":"001"}},"required":["id"],"type":"object"},"DeleteActivityRequest":{"properties":{"hard_delete":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"DeleteMessageRequest":{"properties":{"hard_delete":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"DeleteModerationConfigResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"DeleteModerationRuleResponse":{"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"},"DeleteModerationTemplateResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"DeleteReactionRequest":{"properties":{"hard_delete":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"DeleteUserRequest":{"properties":{"delete_conversation_channels":{"type":"boolean","x-stream-index":"003"},"delete_feeds_content":{"type":"boolean","x-stream-index":"004"},"hard_delete":{"type":"boolean","x-stream-index":"001"},"mark_messages_deleted":{"type":"boolean","x-stream-index":"002"}},"type":"object"},"Device":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"disabled":{"type":"boolean","x-stream-index":"002.003"},"disabled_reason":{"type":"string","x-stream-index":"002.004"},"id":{"type":"string","x-stream-index":"002.001.004"},"push_provider":{"enum":["firebase","apn","huawei","xiaomi"],"type":"string","x-stream-index":"002.001.001"},"push_provider_name":{"type":"string","x-stream-index":"002.001.003"},"user_id":{"type":"string","x-stream-index":"004"},"voip":{"type":"boolean","x-stream-index":"002.001.005"}},"required":["push_provider","id","created_at","user_id"],"type":"object"},"DeviceResponse":{"description":"Response for Device","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"004"},"disabled":{"description":"Whether device is disabled or not","title":"Disabled","type":"boolean","x-stream-index":"005"},"disabled_reason":{"description":"Reason explaining why device had been disabled","title":"Reason","type":"string","x-stream-index":"006"},"id":{"description":"Device ID","title":"ID","type":"string","x-stream-index":"003"},"push_provider":{"description":"Push provider","title":"PushProvider","type":"string","x-stream-index":"001"},"push_provider_name":{"description":"Push provider name","title":"PushProviderName","type":"string","x-stream-index":"002"},"user_id":{"description":"User ID","title":"UserID","type":"string","x-stream-index":"008"},"voip":{"description":"When true the token is for Apple VoIP push notifications","title":"Voip","type":"boolean","x-stream-index":"007"}},"required":["push_provider","id","created_at","user_id"],"title":"DeviceResponse","type":"object"},"DraftPayloadResponse":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"html":{"type":"string","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"001"},"mentioned_users":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"008"},"mml":{"type":"string","x-stream-index":"003"},"parent_id":{"type":"string","x-stream-index":"005"},"poll_id":{"type":"string","x-stream-index":"013"},"quoted_message_id":{"type":"string","x-stream-index":"009"},"show_in_channel":{"type":"boolean","x-stream-index":"006"},"silent":{"type":"boolean","x-stream-index":"012"},"text":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"011"}},"required":["id","text","custom"],"type":"object"},"DraftResponse":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003"},"channel_cid":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"message":{"$ref":"#/components/schemas/DraftPayloadResponse","x-stream-index":"001"},"parent_id":{"type":"string","x-stream-index":"004"},"parent_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"005"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"006"}},"required":["message","channel_cid","created_at"],"type":"object"},"EgressHLSResponse":{"properties":{"playlist_url":{"type":"string","x-stream-index":"001"},"status":{"type":"string","x-stream-index":"002"}},"required":["playlist_url","status"],"type":"object"},"EgressRTMPResponse":{"properties":{"name":{"type":"string","x-stream-index":"001"},"started_at":{"format":"date-time","type":"number","x-stream-index":"004"},"stream_key":{"type":"string","x-stream-index":"003"},"stream_url":{"type":"string","x-stream-index":"002"}},"required":["name","started_at"],"type":"object"},"EgressResponse":{"properties":{"broadcasting":{"type":"boolean","x-stream-index":"001"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordingResponse","x-stream-index":"004"},"hls":{"$ref":"#/components/schemas/EgressHLSResponse","x-stream-index":"002"},"rtmps":{"items":{"$ref":"#/components/schemas/EgressRTMPResponse"},"type":"array","x-stream-index":"003"}},"required":["broadcasting","rtmps"],"type":"object"},"EgressTaskConfig":{"properties":{"egress_user":{"$ref":"#/components/schemas/EgressUser","x-stream-index":"008"},"frame_recording_egress_config":{"$ref":"#/components/schemas/FrameRecordingEgressConfig","x-stream-index":"009"},"hls_egress_config":{"$ref":"#/components/schemas/HLSEgressConfig","x-stream-index":"007"},"recording_egress_config":{"$ref":"#/components/schemas/RecordingEgressConfig","x-stream-index":"006"},"rtmp_egress_config":{"$ref":"#/components/schemas/RTMPEgressConfig","x-stream-index":"004"},"stt_egress_config":{"$ref":"#/components/schemas/STTEgressConfig","x-stream-index":"005"}},"type":"object"},"EgressUser":{"properties":{"token":{"type":"string","x-stream-index":"004"}},"type":"object"},"EnrichedActivity":{"properties":{"actor":{"$ref":"#/components/schemas/Data","x-stream-index":"002"},"foreign_id":{"type":"string","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"latest_reactions":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"013"},"object":{"$ref":"#/components/schemas/Data","x-stream-index":"004"},"origin":{"$ref":"#/components/schemas/Data","x-stream-index":"008"},"own_reactions":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"012"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"011"},"score":{"format":"float","type":"number","x-stream-index":"010"},"target":{"$ref":"#/components/schemas/Data","x-stream-index":"006"},"to":{"items":{"type":"string"},"type":"array","x-stream-index":"009"},"verb":{"type":"string","x-stream-index":"003"}},"type":"object"},"EnrichedReaction":{"nullable":true,"properties":{"activity_id":{"type":"string","x-stream-index":"003"},"children_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"010"},"created_at":{"$ref":"#/components/schemas/Time","x-stream-index":"012"},"data":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"kind":{"type":"string","x-stream-index":"002"},"latest_children":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"008"},"own_children":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"009"},"parent":{"type":"string","x-stream-index":"007"},"target_feeds":{"items":{"type":"string"},"type":"array","x-stream-index":"006"},"updated_at":{"$ref":"#/components/schemas/Time","x-stream-index":"013"},"user":{"$ref":"#/components/schemas/Data","x-stream-index":"011"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["kind","activity_id","user_id"],"type":"object"},"EntityCreator":{"properties":{"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"001.046"},"ban_count":{"format":"int32","type":"integer","x-stream-index":"002"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"001.017"},"banned":{"type":"boolean","x-stream-index":"001.016"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.013"},"deleted_content_count":{"format":"int32","type":"integer","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"001.023"},"language":{"type":"string","x-stream-index":"001.035"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"001.022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"001.026"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.042"},"role":{"type":"string","x-stream-index":"001.004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.005"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.009"}},"required":["id","role","teams_role","custom","banned","online","ban_count","deleted_content_count"],"type":"object"},"EntityCreatorResponse":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.001.018"},"ban_count":{"description":"Number of minor actions performed on the user","format":"int32","title":"Ban Count","type":"integer","x-stream-index":"002"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"001.003"},"banned":{"type":"boolean","x-stream-index":"001.001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.001.017"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.001.016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.001.011"},"deleted_content_count":{"description":"Number of major actions performed on the user","format":"int32","title":"Deleted Content Count","type":"integer","x-stream-index":"003"},"devices":{"items":{"$ref":"#/components/schemas/DeviceResponse"},"type":"array","x-stream-index":"001.006"},"flagged_count":{"description":"Number of flag actions performed on the user","format":"int32","title":"Flagged Count","type":"integer","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001.001.001"},"image":{"type":"string","x-stream-index":"001.001.003"},"invisible":{"type":"boolean","x-stream-index":"001.007"},"language":{"type":"string","x-stream-index":"001.001.005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"001.001.014"},"name":{"type":"string","x-stream-index":"001.001.002"},"online":{"type":"boolean","x-stream-index":"001.001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"001.005"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettingsResponse","x-stream-index":"001.004"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.001.015"},"role":{"type":"string","x-stream-index":"001.001.006"},"shadow_banned":{"type":"boolean","x-stream-index":"001.002"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.001.008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids","shadow_banned","invisible","ban_count","deleted_content_count","flagged_count"],"type":"object"},"EventNotificationSettings":{"properties":{"apns":{"$ref":"#/components/schemas/APNS","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"fcm":{"$ref":"#/components/schemas/FCM","x-stream-index":"003"}},"required":["enabled","apns","fcm"],"type":"object"},"ExternalStorage":{"properties":{"abs_account_name":{"type":"string","x-stream-index":"011"},"abs_client_id":{"type":"string","x-stream-index":"013"},"abs_client_secret":{"type":"string","x-stream-index":"014"},"abs_tenant_id":{"type":"string","x-stream-index":"012"},"bucket":{"type":"string","x-stream-index":"005"},"gcs_credentials":{"type":"string","x-stream-index":"010"},"path":{"type":"string","x-stream-index":"006"},"s3_api_key":{"type":"string","x-stream-index":"007"},"s3_custom_endpoint":{"type":"string","x-stream-index":"016"},"s3_region":{"type":"string","x-stream-index":"009"},"s3_secret_key":{"type":"string","x-stream-index":"008"},"storage_name":{"type":"string","x-stream-index":"015"},"storage_type":{"type":"integer","x-stream-index":"004"}},"type":"object"},"FCM":{"properties":{"data":{"additionalProperties":{},"type":"object","x-stream-index":"001"}},"type":"object"},"FeedsEventPreferences":{"properties":{"comments":{"type":"string","x-stream-index":"002"},"mentions":{"type":"string","x-stream-index":"004"},"new_followers":{"type":"string","x-stream-index":"003"},"reactions":{"type":"string","x-stream-index":"001"}},"type":"object"},"FeedsModerationTemplateConfig":{"properties":{"config_key":{"type":"string","x-stream-index":"002"},"data_types":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001"}},"required":["data_types","config_key"],"type":"object"},"Field":{"nullable":true,"properties":{"short":{"type":"boolean","x-stream-index":"003"},"title":{"type":"string","x-stream-index":"001"},"value":{"type":"string","x-stream-index":"002"}},"required":["title","value","short"],"type":"object"},"Flag":{"description":"Contains information about flagged user or message","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"019"},"custom":{"additionalProperties":{},"description":"Additional metadata about the flag","title":"Custom","type":"object","x-stream-index":"014"},"entity_creator_id":{"description":"ID of the user who created the flagged entity","title":"Entity Creator ID","type":"string","x-stream-index":"009"},"entity_id":{"description":"Unique identifier of the entity being flagged","title":"Entity ID","type":"string","x-stream-index":"008"},"entity_type":{"description":"Type of entity being flagged (e.g., message, user)","title":"Entity Type","type":"string","x-stream-index":"007"},"is_streamed_content":{"type":"boolean","x-stream-index":"012"},"labels":{"description":"Labels from bodyguard, API calls, our own AI etc","items":{"type":"string"},"title":"Labels","type":"array","x-stream-index":"015"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content being flagged","title":"Moderation Payload","x-stream-index":"010"},"moderation_payload_hash":{"type":"string","x-stream-index":"011"},"reason":{"description":"Optional explanation for why the content is being flagged","title":"Reason","type":"string","x-stream-index":"013"},"result":{"description":"Result of bodyguard, API calls, our own AI etc","items":{"additionalProperties":{},"type":"object"},"title":"Result","type":"array","x-stream-index":"016"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"018"},"review_queue_item_id":{"description":"ID of the review queue item","title":"Review Queue Item ID","type":"string","x-stream-index":"017"},"type":{"type":"string","x-stream-index":"004"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"020"},"user":{"$ref":"#/components/schemas/User","description":"User who flagged a message or a user","title":"User","x-stream-index":"006"}},"required":["entity_type","entity_id","result","created_at","updated_at"],"title":"Flag","type":"object"},"FlagContentOptions":{"properties":{"reason":{"type":"string","x-stream-index":"001"}},"type":"object"},"FlagRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"description":"Additional metadata about the flag","title":"Custom","type":"object","x-stream-index":"006"},"entity_creator_id":{"description":"ID of the user who created the flagged entity","title":"Entity Creator ID","type":"string","x-stream-index":"003"},"entity_id":{"description":"Unique identifier of the entity being flagged","title":"Entity ID","type":"string","x-stream-index":"002"},"entity_type":{"description":"Type of entity being flagged (e.g., message, user)","title":"Entity Type","type":"string","x-stream-index":"001"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content being flagged","title":"Moderation Payload","x-stream-index":"005"},"reason":{"description":"Optional explanation for why the content is being flagged","maxLength":255,"title":"Reason","type":"string","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"007.002"},"user_id":{"type":"string","x-stream-index":"007.001"}},"required":["entity_type","entity_id"],"type":"object"},"FlagResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"item_id":{"description":"Unique identifier of the created moderation item","title":"Item ID","type":"string","x-stream-index":"001"}},"required":["item_id","duration"],"type":"object"},"FlagUserOptions":{"properties":{"reason":{"type":"string","x-stream-index":"001"}},"type":"object"},"FrameRecordSettings":{"properties":{"capture_interval_in_seconds":{"format":"int32","maximum":60,"minimum":2,"type":"integer","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"},"quality":{"type":"string","x-stream-index":"002"}},"required":["mode","capture_interval_in_seconds"],"type":"object"},"FrameRecordingEgressConfig":{"properties":{"capture_interval_in_seconds":{"format":"int32","type":"integer","x-stream-index":"007"},"external_storage":{"$ref":"#/components/schemas/ExternalStorage","x-stream-index":"006"},"quality":{"$ref":"#/components/schemas/Quality","x-stream-index":"004"},"storage_name":{"type":"string","x-stream-index":"005"}},"type":"object"},"FrameRecordingResponse":{"properties":{"status":{"type":"string","x-stream-index":"001"}},"required":["status"],"type":"object"},"FrameRecordingSettingsResponse":{"properties":{"capture_interval_in_seconds":{"format":"int32","maximum":60,"minimum":2,"type":"integer","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"},"quality":{"type":"string","x-stream-index":"002"}},"required":["mode","capture_interval_in_seconds"],"type":"object"},"GeofenceSettings":{"properties":{"names":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"required":["names"],"type":"object"},"GeofenceSettingsResponse":{"properties":{"names":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"required":["names"],"type":"object"},"GetConfigResponse":{"nullable":true,"properties":{"config":{"$ref":"#/components/schemas/ConfigResponse","description":"The retrieved moderation configuration","title":"Config","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["duration"],"type":"object"},"GetModerationRuleResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"rule":{"$ref":"#/components/schemas/ModerationRuleV2Response","x-stream-index":"002"}},"required":["duration"],"title":"Response","type":"object"},"GetReviewQueueItemResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"Current state of the review queue item","title":"Item","x-stream-index":"001"}},"required":["duration"],"type":"object"},"GoogleVisionConfig":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"HLSEgressConfig":{"properties":{"composite_app_settings":{"$ref":"#/components/schemas/CompositeAppSettings","x-stream-index":"005"},"playlist_url":{"type":"string","x-stream-index":"007"},"qualities":{"items":{"$ref":"#/components/schemas/Quality"},"type":"array","x-stream-index":"004"},"start_unix_nano":{"format":"int64","type":"integer","x-stream-index":"006"}},"type":"object"},"HLSSettings":{"properties":{"auto_on":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"004"},"quality_tracks":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"required":["auto_on","enabled","quality_tracks"],"type":"object"},"HLSSettingsResponse":{"description":"HLSSettings is the payload for HLS settings","properties":{"auto_on":{"title":"Auto On","type":"boolean","x-stream-index":"001"},"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"002"},"layout":{"$ref":"#/components/schemas/LayoutSettingsResponse","title":"Layout","x-stream-index":"004"},"quality_tracks":{"items":{"type":"string"},"title":"Quality Tracks","type":"array","x-stream-index":"003"}},"required":["auto_on","enabled","quality_tracks","layout"],"title":"HLSSettingsResponse","type":"object"},"HarmConfig":{"properties":{"action_sequences":{"items":{"$ref":"#/components/schemas/ActionSequence"},"type":"array","x-stream-index":"001"},"severity":{"type":"integer","x-stream-index":"002"}},"required":["action_sequences","severity"],"type":"object"},"ImageContentParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"type":"object"},"ImageData":{"properties":{"frames":{"type":"string","x-stream-index":"005"},"height":{"type":"string","x-stream-index":"003"},"size":{"type":"string","x-stream-index":"004"},"url":{"type":"string","x-stream-index":"001"},"width":{"type":"string","x-stream-index":"002"}},"required":["url","width","height","size","frames"],"type":"object"},"ImageRuleParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"type":"object"},"Images":{"properties":{"fixed_height":{"$ref":"#/components/schemas/ImageData","x-stream-index":"002"},"fixed_height_downsampled":{"$ref":"#/components/schemas/ImageData","x-stream-index":"004"},"fixed_height_still":{"$ref":"#/components/schemas/ImageData","x-stream-index":"003"},"fixed_width":{"$ref":"#/components/schemas/ImageData","x-stream-index":"005"},"fixed_width_downsampled":{"$ref":"#/components/schemas/ImageData","x-stream-index":"007"},"fixed_width_still":{"$ref":"#/components/schemas/ImageData","x-stream-index":"006"},"original":{"$ref":"#/components/schemas/ImageData","x-stream-index":"001"}},"required":["original","fixed_height","fixed_height_still","fixed_height_downsampled","fixed_width","fixed_width_still","fixed_width_downsampled"],"type":"object"},"IngressAudioEncodingOptions":{"properties":{"bitrate":{"maximum":128000,"minimum":16000,"type":"integer","x-stream-index":"003"},"channels":{"enum":["1","2"],"format":"int32","type":"integer","x-stream-index":"001"},"enable_dtx":{"type":"boolean","x-stream-index":"002"}},"required":["channels","enable_dtx","bitrate"],"type":"object"},"IngressAudioEncodingResponse":{"properties":{"bitrate":{"format":"int32","type":"integer","x-stream-index":"003"},"channels":{"format":"int32","type":"integer","x-stream-index":"001"},"enable_dtx":{"type":"boolean","x-stream-index":"002"}},"required":["channels","enable_dtx","bitrate"],"type":"object"},"IngressSettings":{"properties":{"audio_encoding_options":{"$ref":"#/components/schemas/IngressAudioEncodingOptions","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"video_encoding_options":{"additionalProperties":{"$ref":"#/components/schemas/IngressVideoEncodingOptions"},"type":"object","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"IngressSettingsResponse":{"properties":{"audio_encoding_options":{"$ref":"#/components/schemas/IngressAudioEncodingResponse","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"video_encoding_options":{"additionalProperties":{"$ref":"#/components/schemas/IngressVideoEncodingResponse"},"type":"object","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"IngressVideoEncodingOptions":{"properties":{"layers":{"items":{"$ref":"#/components/schemas/IngressVideoLayer"},"minimum":1,"type":"array","x-stream-index":"001"}},"required":["layers"],"type":"object"},"IngressVideoEncodingResponse":{"properties":{"layers":{"items":{"$ref":"#/components/schemas/IngressVideoLayerResponse"},"type":"array","x-stream-index":"001"}},"required":["layers"],"type":"object"},"IngressVideoLayer":{"nullable":true,"properties":{"bitrate":{"minimum":1000,"type":"integer","x-stream-index":"002"},"codec":{"enum":["h264","vp8"],"type":"string","x-stream-index":"001"},"frame_rate":{"maximum":60,"minimum":1,"type":"integer","x-stream-index":"003"},"max_dimension":{"minimum":240,"type":"integer","x-stream-index":"005"},"min_dimension":{"minimum":240,"type":"integer","x-stream-index":"004"}},"required":["codec","bitrate","frame_rate","min_dimension","max_dimension"],"type":"object"},"IngressVideoLayerResponse":{"nullable":true,"properties":{"bitrate":{"type":"integer","x-stream-index":"002"},"codec":{"type":"string","x-stream-index":"001"},"frame_rate_limit":{"type":"integer","x-stream-index":"005"},"max_dimension":{"type":"integer","x-stream-index":"004"},"min_dimension":{"type":"integer","x-stream-index":"003"}},"required":["codec","bitrate","min_dimension","max_dimension","frame_rate_limit"],"type":"object"},"LLMConfig":{"properties":{"app_context":{"type":"string","x-stream-index":"005"},"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/LLMRule"},"type":"array","x-stream-index":"003"},"severity_descriptions":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"004"}},"required":["enabled","rules"],"type":"object"},"LLMRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove","keep"],"type":"string","x-stream-index":"003"},"description":{"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"},"severity_rules":{"items":{"$ref":"#/components/schemas/BodyguardSeverityRule"},"type":"array","x-stream-index":"004"}},"required":["label","description","action","severity_rules"],"type":"object"},"LabelThresholds":{"properties":{"block":{"format":"float","maximum":1,"minimum":0,"type":"number","x-stream-index":"002"},"flag":{"format":"float","maximum":1,"minimum":0,"type":"number","x-stream-index":"001"}},"type":"object"},"LayoutSettings":{"properties":{"detect_orientation":{"type":"boolean","x-stream-index":"005"},"external_app_url":{"type":"string","x-stream-index":"003"},"external_css_url":{"type":"string","x-stream-index":"004"},"name":{"enum":["spotlight","grid","single-participant","mobile","custom"],"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"required":["name","external_app_url","external_css_url"],"type":"object"},"LayoutSettingsResponse":{"properties":{"detect_orientation":{"type":"boolean","x-stream-index":"005"},"external_app_url":{"type":"string","x-stream-index":"003"},"external_css_url":{"type":"string","x-stream-index":"004"},"name":{"enum":["spotlight","grid","single-participant","mobile","custom"],"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"required":["name","external_app_url","external_css_url"],"type":"object"},"LimitsSettings":{"properties":{"max_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"004"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"},"max_participants_exclude_owner":{"type":"boolean","x-stream-index":"003"},"max_participants_exclude_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"002"}},"required":["max_participants_exclude_roles"],"type":"object"},"LimitsSettingsResponse":{"properties":{"max_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"004"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"},"max_participants_exclude_owner":{"type":"boolean","x-stream-index":"003"},"max_participants_exclude_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"002"}},"required":["max_participants_exclude_roles"],"type":"object"},"MarkReviewedRequest":{"properties":{"content_to_mark_as_reviewed_limit":{"format":"int32","maximum":2500,"type":"integer","x-stream-index":"002"},"disable_marking_content_as_reviewed":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"MemberLookup":{"properties":{"Limit":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"001"}},"required":["Limit"],"type":"object"},"Message":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"012"},"before_message_send_failed":{"type":"boolean","x-stream-index":"046"},"cid":{"type":"string","x-stream-index":"028"},"command":{"type":"string","x-stream-index":"006"},"created_at":{"format":"date-time","type":"number","x-stream-index":"030"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"034"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"033"},"deleted_for_me":{"type":"boolean","x-stream-index":"059"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"023"},"html":{"type":"string","x-stream-index":"007"},"i18n":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"044"},"id":{"type":"string","x-stream-index":"002"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"040"},"latest_reactions":{"items":{"$ref":"#/components/schemas/Reaction"},"type":"array","x-stream-index":"013"},"mentioned_users":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"043"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"052"},"mml":{"type":"string","x-stream-index":"005"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"056"},"own_reactions":{"items":{"$ref":"#/components/schemas/Reaction"},"type":"array","x-stream-index":"014"},"parent_id":{"type":"string","x-stream-index":"019"},"pin_expires":{"format":"date-time","type":"number","x-stream-index":"051"},"pinned":{"type":"boolean","x-stream-index":"047"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"048"},"pinned_by":{"$ref":"#/components/schemas/User","x-stream-index":"050"},"poll":{"$ref":"#/components/schemas/Poll","x-stream-index":"054"},"poll_id":{"type":"string","x-stream-index":"053"},"quoted_message":{"$ref":"#/components/schemas/Message","x-stream-index":"025"},"quoted_message_id":{"type":"string","x-stream-index":"024"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"015"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"017"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"016"},"reminder":{"$ref":"#/components/schemas/MessageReminder","x-stream-index":"058"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"022"},"restricted_visibility":{"items":{"type":"string"},"type":"array","x-stream-index":"011"},"shadowed":{"type":"boolean","x-stream-index":"036"},"shared_location":{"$ref":"#/components/schemas/SharedLocation","x-stream-index":"055"},"show_in_channel":{"type":"boolean","x-stream-index":"021"},"silent":{"type":"boolean","x-stream-index":"045"},"text":{"type":"string","x-stream-index":"004"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"027"},"type":{"type":"string","x-stream-index":"008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"031"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"010"}},"required":["id","text","html","type","restricted_visibility","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reaction_groups","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned"],"type":"object"},"MessageReminder":{"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"004"},"channel_cid":{"type":"string","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"011"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"006"},"message_id":{"type":"string","x-stream-index":"005"},"remind_at":{"format":"date-time","type":"number","x-stream-index":"009"},"task_id":{"type":"string","x-stream-index":"010"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"012"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"user_id":{"type":"string","x-stream-index":"007"}},"required":["channel_cid","message_id","user_id","task_id","created_at","updated_at"],"type":"object"},"MessageResponse":{"description":"Represents any chat message","properties":{"attachments":{"description":"Array of message attachments","items":{"$ref":"#/components/schemas/Attachment"},"title":"Message attachments","type":"array","x-stream-docs-page-id":"message_format#attachment-format","x-stream-index":"008"},"cid":{"description":"Channel unique identifier in \u003ctype\u003e:\u003cid\u003e format","title":"Channel CID","type":"string","x-stream-index":"022"},"command":{"description":"Contains provided slash command","title":"Command","type":"string","x-stream-docs-page-id":"custom_commands_webhook","x-stream-index":"004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"023"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"026"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"025"},"deleted_for_me":{"type":"boolean","x-stream-index":"044"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"018"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"041"},"html":{"description":"Contains HTML markup of the message. Can only be set when using server-side API","title":"HTML content","type":"string","x-stream-index":"005"},"i18n":{"additionalProperties":{"type":"string"},"description":"Object with translations. Key `language` contains the original language key. Other keys contain translations","title":"Internationalization info","type":"object","x-stream-docs-page-id":"translation","x-stream-index":"030"},"id":{"description":"Message ID is unique string identifier of the message","title":"ID","type":"string","x-stream-index":"001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"Contains image moderation information","title":"Image moderation labels","type":"object","x-stream-index":"028"},"latest_reactions":{"description":"List of 10 latest reactions to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Latest reactions","type":"array","x-stream-index":"009"},"mentioned_users":{"description":"List of mentioned users","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Mentioned Users","type":"array","x-stream-index":"029"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"036"},"mml":{"description":"Should be empty if `text` is provided. Can only be set when using server-side API","title":"Messaging Markup Language","type":"string","x-stream-docs-page-id":"mml_overview","x-stream-index":"003"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"039"},"own_reactions":{"description":"List of 10 latest reactions of authenticated user to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Own reactions","type":"array","x-stream-index":"010"},"parent_id":{"description":"ID of parent message (thread)","title":"Parent message ID","type":"string","x-stream-docs-page-id":"threads","x-stream-index":"015"},"pin_expires":{"description":"Date when pinned message expires","format":"date-time","title":"Pin expiration date","type":"number","x-stream-docs-page-id":"pinned_messages","x-stream-index":"035"},"pinned":{"description":"Whether message is pinned or not","title":"Pinned","type":"boolean","x-stream-docs-page-id":"pinned_messages","x-stream-index":"032"},"pinned_at":{"description":"Date when message got pinned","format":"date-time","title":"Pinned at","type":"number","x-stream-docs-page-id":"pinned_messages","x-stream-index":"033"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","description":"Contains user who pinned the message","title":"Pinned by","x-stream-docs-page-id":"pinned_messages","x-stream-index":"034"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"038"},"poll_id":{"description":"Identifier of the poll to include in the message","title":"Poll ID","type":"string","x-stream-index":"037"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","description":"Contains quoted message","title":"Quoted message","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"020"},"quoted_message_id":{"title":"ID of quoted message","type":"string","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"019"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing number of reactions of each type. Key: reaction type (string), value: number of reactions (int)","title":"Reaction counts","type":"object","x-stream-index":"011"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"014"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing scores of reactions of each type. Key: reaction type (string), value: total score of reactions (int)","title":"Reaction scores","type":"object","x-stream-index":"012"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"042"},"reply_count":{"description":"Number of replies to this message","format":"int32","title":"Reply count","type":"integer","x-stream-index":"017"},"restricted_visibility":{"description":"A list of user ids that have restricted visibility to the message, if the list is not empty, the message is only visible to the users in the list","items":{"type":"string"},"title":"Restricted visibility","type":"array","x-stream-index":"040"},"shadowed":{"description":"Whether the message was shadowed or not","title":"Shadowed","type":"boolean","x-stream-docs-page-id":"moderation#shadow-ban","x-stream-index":"027"},"shared_location":{"$ref":"#/components/schemas/SharedLocationResponseData","description":"Contains shared location data","title":"Shared Location","x-stream-index":"043"},"show_in_channel":{"description":"Whether thread reply should be shown in the channel as well","title":"Show in channel","type":"boolean","x-stream-docs-page-id":"threads","x-stream-index":"016"},"silent":{"description":"Whether message is silent or not","title":"Silent","type":"boolean","x-stream-index":"031"},"text":{"description":"Text of the message. Should be empty if `mml` is provided","title":"Text","type":"string","x-stream-index":"002"},"thread_participants":{"description":"List of users who participate in thread","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Thread participants","type":"array","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"021"},"type":{"description":"Contains type of the message","enum":["regular","ephemeral","error","reply","system","deleted"],"title":"Message Type","type":"string","x-stream-docs-page-id":"message_format#message-types","x-stream-index":"006"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"024"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Sender of the message. Required when using server-side API","title":"User object","x-stream-index":"007"}},"required":["id","text","html","type","user","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned","restricted_visibility"],"title":"Message","type":"object","x-stream-docs-page-id":"send_message"},"ModerationActionConfig":{"nullable":true,"properties":{"action":{"type":"string","x-stream-index":"006"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"009"},"description":{"type":"string","x-stream-index":"008"},"entity_type":{"type":"string","x-stream-index":"004"},"icon":{"type":"string","x-stream-index":"007"},"order":{"format":"int32","type":"integer","x-stream-index":"005"}},"required":["entity_type","order","action","icon","description","custom"],"type":"object"},"ModerationCheckCompletedEvent":{"description":"This event is sent when a moderation check is completed","nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"entity_id":{"description":"The ID of entity which was moderated","title":"EntityID","type":"string","x-stream-index":"002"},"entity_type":{"description":"The type of the entity which was moderated","title":"EntityType","type":"string","x-stream-index":"003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"recommended_action":{"description":"The recommended action","title":"RecommendedAction","type":"string","x-stream-index":"004"},"review_queue_item_id":{"description":"The review queue item ID","title":"ReviewQueueItemID","type":"string","x-stream-index":"005"},"type":{"default":"moderation_check.completed","type":"string","x-stream-index":"001.002"}},"required":["type","created_at","custom","entity_id","entity_type","recommended_action","review_queue_item_id"],"title":"ModerationCheckCompletedEvent","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"},"ModerationCustomActionEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"001"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"002"},"type":{"default":"moderation.custom_action","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationCustomActionEvent","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"},"ModerationFlagResponse":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"015"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"entity_creator_id":{"type":"string","x-stream-index":"007"},"entity_id":{"type":"string","x-stream-index":"006"},"entity_type":{"type":"string","x-stream-index":"005"},"labels":{"items":{"type":"string"},"type":"array","x-stream-index":"011"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"008"},"reason":{"type":"string","x-stream-index":"009"},"result":{"items":{"additionalProperties":{},"type":"object"},"type":"array","x-stream-index":"012"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","x-stream-index":"014"},"review_queue_item_id":{"type":"string","x-stream-index":"013"},"type":{"type":"string","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"016"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"004"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["type","user_id","entity_type","entity_id","result","created_at","updated_at"],"type":"object"},"ModerationFlaggedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"item":{"type":"string","x-stream-index":"001"},"object_id":{"type":"string","x-stream-index":"002"},"type":{"default":"moderation.flagged","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationFlaggedEvent","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"},"ModerationMarkReviewedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"001"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"002"},"type":{"default":"moderation.mark_reviewed","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationMarkReviewedEvent","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"},"ModerationPayload":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"images":{"items":{"type":"string"},"maximum":30,"type":"array","x-stream-index":"002"},"texts":{"items":{"type":"string"},"type":"array","x-stream-index":"001"},"videos":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"type":"object"},"ModerationRuleV2Response":{"properties":{"action":{"$ref":"#/components/schemas/RuleBuilderAction","x-stream-index":"010"},"conditions":{"items":{"$ref":"#/components/schemas/RuleBuilderCondition"},"type":"array","x-stream-index":"007"},"config_keys":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"cooldown_period":{"type":"string","x-stream-index":"011"},"created_at":{"format":"date-time","type":"number","x-stream-index":"013"},"description":{"type":"string","x-stream-index":"003"},"enabled":{"type":"boolean","x-stream-index":"012"},"groups":{"items":{"$ref":"#/components/schemas/RuleBuilderConditionGroup"},"type":"array","x-stream-index":"009"},"id":{"type":"string","x-stream-index":"001"},"logic":{"type":"string","x-stream-index":"008"},"name":{"type":"string","x-stream-index":"002"},"rule_type":{"type":"string","x-stream-index":"006"},"team":{"type":"string","x-stream-index":"005"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"014"}},"required":["id","name","description","config_keys","team","rule_type","action","enabled","created_at","updated_at"],"type":"object"},"ModerationV2Response":{"properties":{"action":{"type":"string","x-stream-index":"001"},"blocklist_matched":{"type":"string","x-stream-index":"005"},"image_harms":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"original_text":{"type":"string","x-stream-index":"002"},"platform_circumvented":{"type":"boolean","x-stream-index":"007"},"semantic_filter_matched":{"type":"string","x-stream-index":"006"},"text_harms":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"required":["action","original_text"],"type":"object"},"MuteRequest":{"nullable":true,"properties":{"target_ids":{"description":"User IDs to mute (if multiple users)","items":{"type":"string"},"title":"Target IDs","type":"array","x-stream-index":"001"},"timeout":{"description":"Duration of mute in minutes","minimum":0,"title":"Timeout","type":"integer","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"required":["target_ids"],"title":"MuteRequest","type":"object"},"MuteResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"004.001"},"mutes":{"description":"Object with mutes (if multiple users were muted)","items":{"$ref":"#/components/schemas/UserMute"},"title":"Mutes","type":"array","x-stream-index":"001"},"non_existing_users":{"description":"A list of users that can't be found. Common cause for this is deleted users","items":{"type":"string"},"title":"Non Existing Users","type":"array","x-stream-index":"003"},"own_user":{"$ref":"#/components/schemas/OwnUser","description":"Authorized user object with fresh mutes information","title":"Own User","x-stream-index":"002"}},"required":["duration"],"title":"MuteResponse","type":"object"},"NoiseCancellationSettings":{"properties":{"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode"],"type":"object"},"NotificationSettings":{"properties":{"call_live_started":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"002"},"call_missed":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"006"},"call_notification":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"004"},"call_ring":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"session_started":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"003"}},"required":["enabled","call_live_started","session_started","call_notification","call_ring","call_missed"],"type":"object"},"NullTime":{"type":"object"},"OCRRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"}},"required":["label","action"],"type":"object"},"OwnUser":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"046"},"banned":{"type":"boolean","x-stream-index":"016"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"045"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"029"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"014"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"013"},"devices":{"items":{"$ref":"#/components/schemas/Device"},"type":"array","x-stream-index":"027"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"023"},"language":{"type":"string","x-stream-index":"035"},"last_active":{"format":"date-time","type":"number","x-stream-index":"011"},"last_engaged_at":{"format":"date-time","type":"number","x-stream-index":"012"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"037"},"mutes":{"items":{"$ref":"#/components/schemas/UserMute"},"type":"array","x-stream-index":"028"},"online":{"type":"boolean","x-stream-index":"022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"026"},"push_preferences":{"$ref":"#/components/schemas/PushPreferences","x-stream-index":"025"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"005"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"031"},"total_unread_count_by_team":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"032"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"033"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"030"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"034"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"}},"required":["id","role","custom","created_at","updated_at","banned","online","devices","mutes","channel_mutes","unread_count","total_unread_count","total_unread_count_by_team","unread_channels","unread_threads","language"],"type":"object"},"Poll":{"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"023"},"allow_answers":{"type":"boolean","x-stream-index":"010"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"009"},"answers_count":{"format":"int32","type":"integer","x-stream-index":"015"},"created_at":{"format":"date-time","type":"number","x-stream-index":"021"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"020"},"created_by_id":{"type":"string","x-stream-index":"019"},"description":{"type":"string","x-stream-index":"005"},"enforce_unique_vote":{"type":"boolean","x-stream-index":"007"},"id":{"type":"string","x-stream-index":"003"},"is_closed":{"type":"boolean","x-stream-index":"011"},"latest_answers":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array","x-stream-index":"017"},"latest_votes_by_option":{"additionalProperties":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array"},"type":"object","x-stream-index":"016"},"max_votes_allowed":{"format":"int32","type":"integer","x-stream-index":"008"},"name":{"type":"string","x-stream-index":"004"},"options":{"items":{"$ref":"#/components/schemas/PollOption"},"type":"array","x-stream-index":"013"},"own_votes":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array","x-stream-index":"018"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"022"},"vote_count":{"format":"int32","type":"integer","x-stream-index":"012"},"vote_counts_by_option":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"014"},"voting_visibility":{"type":"string","x-stream-index":"006"}},"required":["id","name","description","enforce_unique_vote","allow_user_suggested_options","allow_answers","vote_count","options","vote_counts_by_option","answers_count","latest_votes_by_option","latest_answers","own_votes","created_by_id","created_at","updated_at","Custom"],"type":"object"},"PollOption":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id","text","custom"],"type":"object"},"PollOptionResponseData":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id","text","custom"],"type":"object"},"PollResponseData":{"properties":{"allow_answers":{"type":"boolean","x-stream-index":"008"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"007"},"answers_count":{"format":"int32","type":"integer","x-stream-index":"012"},"created_at":{"format":"date-time","type":"number","x-stream-index":"019"},"created_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"018"},"created_by_id":{"type":"string","x-stream-index":"017"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"021"},"description":{"type":"string","x-stream-index":"003"},"enforce_unique_vote":{"type":"boolean","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"is_closed":{"type":"boolean","x-stream-index":"009"},"latest_answers":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array","x-stream-index":"015"},"latest_votes_by_option":{"additionalProperties":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array"},"type":"object","x-stream-index":"014"},"max_votes_allowed":{"format":"int32","type":"integer","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"002"},"options":{"items":{"$ref":"#/components/schemas/PollOptionResponseData"},"type":"array","x-stream-index":"011"},"own_votes":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array","x-stream-index":"016"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"020"},"vote_count":{"format":"int32","type":"integer","x-stream-index":"010"},"vote_counts_by_option":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"013"},"voting_visibility":{"type":"string","x-stream-index":"004"}},"required":["id","name","description","voting_visibility","enforce_unique_vote","allow_user_suggested_options","allow_answers","vote_count","options","answers_count","vote_counts_by_option","latest_votes_by_option","latest_answers","own_votes","created_by_id","created_at","updated_at","custom"],"type":"object"},"PollVote":{"nullable":true,"properties":{"answer_text":{"type":"string","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"004"},"is_answer":{"type":"boolean","x-stream-index":"006"},"option_id":{"type":"string","x-stream-index":"005"},"poll_id":{"type":"string","x-stream-index":"003"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"011"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"009"},"user_id":{"type":"string","x-stream-index":"008"}},"required":["poll_id","id","option_id","created_at","updated_at"],"type":"object"},"PollVoteResponseData":{"nullable":true,"properties":{"answer_text":{"type":"string","x-stream-index":"005"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"id":{"type":"string","x-stream-index":"002"},"is_answer":{"type":"boolean","x-stream-index":"004"},"option_id":{"type":"string","x-stream-index":"003"},"poll_id":{"type":"string","x-stream-index":"001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"007"},"user_id":{"type":"string","x-stream-index":"006"}},"required":["poll_id","id","option_id","created_at","updated_at"],"type":"object"},"PrivacySettings":{"properties":{"read_receipts":{"$ref":"#/components/schemas/ReadReceipts","x-stream-index":"002"},"typing_indicators":{"$ref":"#/components/schemas/TypingIndicators","x-stream-index":"001"}},"type":"object"},"PrivacySettingsResponse":{"properties":{"read_receipts":{"$ref":"#/components/schemas/ReadReceiptsResponse","x-stream-index":"002"},"typing_indicators":{"$ref":"#/components/schemas/TypingIndicatorsResponse","x-stream-index":"001"}},"type":"object"},"PushNotificationSettingsResponse":{"properties":{"disabled":{"type":"boolean","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"number","x-stream-index":"002"}},"type":"object"},"PushPreferences":{"properties":{"call_level":{"type":"string","x-stream-index":"002"},"chat_level":{"type":"string","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"number","x-stream-index":"005"},"feeds_events":{"$ref":"#/components/schemas/FeedsEventPreferences","x-stream-index":"004"},"feeds_level":{"type":"string","x-stream-index":"003"}},"type":"object"},"Quality":{"properties":{"bitdepth":{"format":"int32","type":"integer","x-stream-index":"007"},"framerate":{"format":"int32","type":"integer","x-stream-index":"008"},"height":{"format":"int32","type":"integer","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"004"},"video_bitrate":{"format":"int32","type":"integer","x-stream-index":"009"},"width":{"format":"int32","type":"integer","x-stream-index":"005"}},"type":"object"},"QueryFeedModerationTemplate":{"properties":{"config":{"$ref":"#/components/schemas/FeedsModerationTemplateConfig","description":"Configuration for the moderation template","title":"Config","x-stream-index":"002"},"created_at":{"description":"When the template was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"003"},"name":{"description":"Name of the moderation template","title":"Name","type":"string","x-stream-index":"001"},"updated_at":{"description":"When the template was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"004"}},"required":["name","created_at","updated_at"],"type":"object"},"QueryFeedModerationTemplatesResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"templates":{"description":"List of moderation templates","items":{"$ref":"#/components/schemas/QueryFeedModerationTemplate"},"title":"Templates","type":"array","x-stream-index":"001"}},"required":["templates","duration"],"type":"object"},"QueryModerationConfigsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter conditions for moderation configs","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"Sorting parameters for the results","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"type":"object"},"QueryModerationConfigsResponse":{"nullable":true,"properties":{"configs":{"description":"List of moderation configurations","items":{"$ref":"#/components/schemas/ConfigResponse"},"title":"Configs","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["configs","duration"],"type":"object"},"QueryModerationFlagsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParam"},"type":"array","x-stream-index":"002"}},"type":"object"},"QueryModerationFlagsResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"flags":{"items":{"$ref":"#/components/schemas/ModerationFlagResponse"},"type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["flags","duration"],"title":"Response","type":"object"},"QueryModerationLogsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter conditions for moderation logs","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"Sorting parameters for the results","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"type":"object"},"QueryModerationLogsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"003.001"},"logs":{"description":"List of moderation action logs","items":{"$ref":"#/components/schemas/ActionLogResponse"},"title":"Logs","type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["logs","duration"],"type":"object"},"QueryModerationRulesRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter conditions for moderation rules","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"Sorting parameters for the results","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"type":"object"},"QueryModerationRulesResponse":{"nullable":true,"properties":{"default_llm_labels":{"additionalProperties":{"type":"string"},"description":"Default LLM label descriptions","title":"DefaultLLMLabels","type":"object","x-stream-index":"002"},"duration":{"type":"string","x-stream-index":"004.001"},"next":{"type":"string","x-stream-index":"003.001"},"prev":{"type":"string","x-stream-index":"003.002"},"rules":{"description":"List of moderation rules","items":{"$ref":"#/components/schemas/ModerationRuleV2Response"},"title":"Rules","type":"array","x-stream-index":"001"}},"required":["rules","default_llm_labels","duration"],"type":"object"},"QueryReviewQueueRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter conditions for review queue items","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"007.001"},"lock_count":{"description":"Number of items to lock (1-25)","format":"int32","maximum":25,"minimum":1,"title":"Lock Count","type":"integer","x-stream-index":"005"},"lock_duration":{"description":"Duration for which items should be locked","title":"Lock Duration","type":"integer","x-stream-index":"004"},"lock_items":{"description":"Whether to lock items for review (true), unlock items (false), or just fetch (nil)","title":"Lock Items","type":"boolean","x-stream-index":"003"},"next":{"type":"string","x-stream-index":"007.002"},"prev":{"type":"string","x-stream-index":"007.003"},"sort":{"description":"Sorting parameters for the results","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"002"},"stats_only":{"description":"Whether to return only statistics","title":"Stats Only","type":"boolean","x-stream-index":"006"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"008.002"},"user_id":{"type":"string","x-stream-index":"008.001"}},"type":"object"},"QueryReviewQueueResponse":{"nullable":true,"properties":{"action_config":{"additionalProperties":{"items":{"$ref":"#/components/schemas/ModerationActionConfig"},"type":"array"},"description":"Configuration for moderation actions","title":"Action Config","type":"object","x-stream-index":"002"},"duration":{"type":"string","x-stream-index":"005.001"},"items":{"description":"List of review queue items","items":{"$ref":"#/components/schemas/ReviewQueueItemResponse"},"title":"Items","type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"004.001"},"prev":{"type":"string","x-stream-index":"004.002"},"stats":{"additionalProperties":{},"description":"Statistics about the review queue","title":"Stats","type":"object","x-stream-index":"003"}},"required":["items","action_config","stats","duration"],"type":"object"},"RTMPEgressConfig":{"properties":{"composite_app_settings":{"$ref":"#/components/schemas/CompositeAppSettings","x-stream-index":"005"},"quality":{"$ref":"#/components/schemas/Quality","x-stream-index":"004"},"rtmp_location":{"type":"string","x-stream-index":"006"}},"type":"object"},"RTMPIngress":{"description":"RTMP input settings","properties":{"address":{"title":"Address","type":"string","x-stream-index":"001"}},"required":["address"],"title":"RTMPIngress","type":"object"},"RTMPLocation":{"properties":{"name":{"type":"string","x-stream-index":"001"},"stream_key":{"type":"string","x-stream-index":"003"},"stream_url":{"type":"string","x-stream-index":"002"}},"required":["name","stream_url","stream_key"],"type":"object"},"RTMPSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"003"},"location":{"$ref":"#/components/schemas/RTMPLocation","x-stream-index":"004"},"quality_name":{"type":"string","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"RTMPSettingsResponse":{"description":"RTMPSettingsResponse is the payload for RTMP settings","properties":{"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettingsResponse","title":"Layout","x-stream-index":"003"},"quality":{"title":"Quality","type":"string","x-stream-index":"002"}},"required":["enabled","quality","layout"],"title":"RTMPSettingsResponse","type":"object"},"Reaction":{"nullable":true,"properties":{"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"message_id":{"type":"string","x-stream-index":"003"},"score":{"format":"int32","type":"integer","x-stream-index":"007"},"type":{"maxLength":30,"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["message_id","type","score","created_at","updated_at","custom"],"type":"object"},"ReactionGroupResponse":{"description":"ReactionGroupResponse contains all information about a reaction of the same type.","nullable":true,"properties":{"count":{"description":"Count is the number of reactions of this type.","format":"int32","title":"Count","type":"integer","x-stream-index":"001"},"first_reaction_at":{"description":"FirstReactionAt is the time of the first reaction of this type. This is the same also if all reaction of this type are deleted, because if someone will react again with the same type, will be preserved the sorting.","format":"date-time","title":"FirstReactionAt","type":"number","x-stream-index":"003"},"last_reaction_at":{"description":"LastReactionAt is the time of the last reaction of this type.","format":"date-time","title":"LastReactionAt","type":"number","x-stream-index":"004"},"sum_scores":{"description":"SumScores is the sum of all scores of reactions of this type. Medium allows you to clap articles more than once and shows the sum of all claps from all users. For example, you can send `clap` x5 using `score: 5`.","format":"int32","title":"SumScores","type":"integer","x-stream-index":"002"}},"required":["count","sum_scores","first_reaction_at","last_reaction_at"],"title":"ReactionGroupResponse","type":"object"},"ReactionResponse":{"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"006"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"008"},"message_id":{"description":"Message ID","title":"Message ID","type":"string","x-stream-index":"001"},"score":{"description":"Score of the reaction","format":"int32","title":"Score","type":"integer","x-stream-index":"005"},"type":{"description":"Type of reaction","title":"Type","type":"string","x-stream-index":"004"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"007"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User","title":"UserResponse","x-stream-index":"003"},"user_id":{"description":"User ID","title":"User ID","type":"string","x-stream-index":"002"}},"required":["message_id","user_id","user","type","score","created_at","updated_at","custom"],"type":"object"},"ReadReceipts":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"ReadReceiptsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"RecordSettings":{"properties":{"audio_only":{"type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"004"},"mode":{"type":"string","x-stream-index":"002"},"quality":{"type":"string","x-stream-index":"003"}},"required":["mode"],"type":"object"},"RecordSettingsResponse":{"description":"RecordSettings is the payload for recording settings","properties":{"audio_only":{"title":"Audio Only","type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettingsResponse","title":"Layout","x-stream-index":"004"},"mode":{"title":"Mode","type":"string","x-stream-index":"002"},"quality":{"title":"Quality","type":"string","x-stream-index":"003"}},"required":["audio_only","mode","quality","layout"],"title":"RecordSettingsResponse","type":"object"},"RecordingEgressConfig":{"properties":{"audio_only":{"type":"boolean","x-stream-index":"006"},"composite_app_settings":{"$ref":"#/components/schemas/CompositeAppSettings","x-stream-index":"005"},"external_storage":{"$ref":"#/components/schemas/ExternalStorage","x-stream-index":"008"},"quality":{"$ref":"#/components/schemas/Quality","x-stream-index":"004"},"storage_name":{"type":"string","x-stream-index":"007"},"video_orientation_hint":{"$ref":"#/components/schemas/VideoOrientation","x-stream-index":"009"}},"type":"object"},"ReminderResponseData":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003"},"channel_cid":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"005"},"message_id":{"type":"string","x-stream-index":"004"},"remind_at":{"format":"date-time","type":"number","x-stream-index":"001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007"},"user_id":{"type":"string","x-stream-index":"006"}},"required":["channel_cid","message_id","user_id","created_at","updated_at"],"type":"object"},"RestoreActionRequest":{"type":"object"},"ReviewQueueItem":{"properties":{"actions":{"items":{"$ref":"#/components/schemas/ActionLog"},"type":"array","x-stream-index":"035"},"activity":{"$ref":"#/components/schemas/EnrichedActivity","x-stream-index":"028"},"ai_text_severity":{"type":"string","x-stream-index":"021"},"archived_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"043"},"assigned_to":{"$ref":"#/components/schemas/User","x-stream-index":"032"},"bans":{"items":{"$ref":"#/components/schemas/Ban"},"type":"array","x-stream-index":"033"},"bounce_count":{"format":"int32","type":"integer","x-stream-index":"025"},"call":{"$ref":"#/components/schemas/Call","x-stream-index":"031"},"completed_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"018"},"config_key":{"type":"string","x-stream-index":"009"},"content_changed":{"type":"boolean","x-stream-index":"036"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"entity_creator":{"$ref":"#/components/schemas/EntityCreator","x-stream-index":"030"},"entity_id":{"type":"string","x-stream-index":"007"},"entity_type":{"type":"string","x-stream-index":"006"},"feeds_v2_activity":{"$ref":"#/components/schemas/EnrichedActivity","x-stream-index":"041"},"feeds_v2_reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"042"},"flag_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"045"},"flag_types":{"items":{"type":"string"},"type":"array","x-stream-index":"044"},"flags":{"items":{"$ref":"#/components/schemas/Flag"},"type":"array","x-stream-index":"034"},"flags_count":{"format":"int32","type":"integer","x-stream-index":"026"},"has_image":{"type":"boolean","x-stream-index":"012"},"has_text":{"type":"boolean","x-stream-index":"014"},"has_video":{"type":"boolean","x-stream-index":"013"},"id":{"type":"string","x-stream-index":"003"},"languages":{"items":{"type":"string"},"type":"array","x-stream-index":"019"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"027"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"010"},"moderation_payload_hash":{"type":"string","x-stream-index":"011"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"029"},"recommended_action":{"type":"string","x-stream-index":"017"},"reporter_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"046"},"reviewed_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"022"},"reviewed_by":{"type":"string","x-stream-index":"023"},"severity":{"format":"int32","type":"integer","x-stream-index":"020"},"status":{"type":"string","x-stream-index":"016"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"015"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"005"}},"required":["id","created_at","updated_at","entity_type","entity_id","config_key","moderation_payload_hash","has_image","has_video","has_text","teams","status","recommended_action","completed_at","languages","severity","ai_text_severity","reviewed_at","reviewed_by","bounce_count","flags_count","bans","flags","actions","content_changed","archived_at","flag_types","flag_labels","reporter_ids"],"type":"object"},"ReviewQueueItemNewEvent":{"description":"This event is sent when a new moderation review queue item is created","nullable":true,"properties":{"action":{"$ref":"#/components/schemas/ActionLogResponse","description":"The action log if any action was taken","title":"Action","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"flags":{"description":"The flags associated with this review queue item","items":{"$ref":"#/components/schemas/ModerationFlagResponse"},"title":"Flags","type":"array","x-stream-index":"003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"The review queue item that was created","title":"ReviewQueueItem","x-stream-index":"002"},"type":{"default":"review_queue_item.new","type":"string","x-stream-index":"001.002"}},"required":["type","created_at","custom"],"title":"ReviewQueueItemNewEvent","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"},"ReviewQueueItemResponse":{"properties":{"actions":{"description":"Moderation actions taken","items":{"$ref":"#/components/schemas/ActionLogResponse"},"title":"Actions","type":"array","x-stream-index":"024"},"activity":{"$ref":"#/components/schemas/EnrichedActivity","x-stream-index":"016"},"ai_text_severity":{"description":"AI-determined text severity","title":"AI Text Severity","type":"string","x-stream-index":"014"},"assigned_to":{"$ref":"#/components/schemas/UserResponse","description":"Moderator assigned to review this item","title":"Assigned To","x-stream-index":"021"},"bans":{"description":"Associated ban records","items":{"$ref":"#/components/schemas/Ban"},"title":"Bans","type":"array","x-stream-index":"022"},"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"018"},"completed_at":{"description":"When the review was completed","format":"date-time","title":"Completed At","type":"number","x-stream-index":"009"},"config_key":{"type":"string","x-stream-index":"028"},"created_at":{"description":"When the item was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"002"},"entity_creator":{"$ref":"#/components/schemas/EntityCreatorResponse","description":"Details about who created the entity","title":"Entity Creator","x-stream-index":"019"},"entity_creator_id":{"description":"ID of who created the entity","title":"Entity Creator ID","type":"string","x-stream-index":"020"},"entity_id":{"description":"ID of the entity being reviewed","title":"Entity ID","type":"string","x-stream-index":"005"},"entity_type":{"description":"Type of entity being reviewed","title":"Entity Type","type":"string","x-stream-index":"004"},"feeds_v2_activity":{"$ref":"#/components/schemas/EnrichedActivity","description":"Associated feed activity","title":"Feeds V2 Activity","x-stream-index":"025"},"feeds_v2_reaction":{"$ref":"#/components/schemas/Reaction","description":"Associated feed reaction","title":"Feeds V2 Reaction","x-stream-index":"026"},"flags":{"description":"Associated flag records","items":{"$ref":"#/components/schemas/ModerationFlagResponse"},"title":"Flags","type":"array","x-stream-index":"023"},"flags_count":{"format":"int32","type":"integer","x-stream-index":"029"},"id":{"description":"Unique identifier of the review queue item","title":"ID","type":"string","x-stream-index":"001"},"languages":{"description":"Detected languages in the content","items":{"type":"string"},"title":"Languages","type":"array","x-stream-index":"012"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Associated message details","title":"Message","x-stream-index":"015"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content being moderated","title":"Moderation Payload","x-stream-index":"006"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"017"},"recommended_action":{"description":"Suggested moderation action","title":"Recommended Action","type":"string","x-stream-index":"008"},"reviewed_at":{"description":"When the item was reviewed","format":"date-time","title":"Reviewed At","type":"number","x-stream-index":"010"},"reviewed_by":{"description":"ID of the moderator who reviewed the item","title":"Reviewed By","type":"string","x-stream-index":"011"},"severity":{"description":"Severity level of the content","format":"int32","title":"Severity","type":"integer","x-stream-index":"013"},"status":{"description":"Current status of the review","title":"Status","type":"string","x-stream-index":"007"},"teams":{"description":"Teams associated with this item","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"027"},"updated_at":{"description":"When the item was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"003"}},"required":["id","created_at","updated_at","entity_type","entity_id","status","recommended_action","reviewed_by","languages","severity","ai_text_severity","bans","flags","actions","flags_count"],"type":"object"},"ReviewQueueItemUpdatedEvent":{"description":"This event is sent when a moderation review queue item is updated","nullable":true,"properties":{"action":{"$ref":"#/components/schemas/ActionLogResponse","description":"The action log if any action was taken","title":"Action","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"flags":{"description":"The flags associated with this review queue item","items":{"$ref":"#/components/schemas/ModerationFlagResponse"},"title":"Flags","type":"array","x-stream-index":"003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"The review queue item that was updated","title":"ReviewQueueItem","x-stream-index":"002"},"type":{"default":"review_queue_item.updated","type":"string","x-stream-index":"001.002"}},"required":["type","created_at","custom"],"title":"ReviewQueueItemUpdatedEvent","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"},"RingSettings":{"properties":{"auto_cancel_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_timeout_ms","missed_call_timeout_ms"],"type":"object"},"RingSettingsResponse":{"properties":{"auto_cancel_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_timeout_ms","missed_call_timeout_ms"],"type":"object"},"RuleBuilderAction":{"properties":{"ban_options":{"$ref":"#/components/schemas/BanOptions","x-stream-index":"002"},"flag_content_options":{"$ref":"#/components/schemas/FlagContentOptions","x-stream-index":"004"},"flag_user_options":{"$ref":"#/components/schemas/FlagUserOptions","x-stream-index":"003"},"remove_content_options":{"$ref":"#/components/schemas/BlockContentOptions","x-stream-index":"005"},"type":{"type":"string","x-stream-index":"001"}},"type":"object"},"RuleBuilderCondition":{"properties":{"confidence":{"format":"float","type":"number","x-stream-index":"002"},"content_count_rule_params":{"$ref":"#/components/schemas/ContentCountRuleParameters","x-stream-index":"007"},"image_content_params":{"$ref":"#/components/schemas/ImageContentParameters","x-stream-index":"009"},"image_rule_params":{"$ref":"#/components/schemas/ImageRuleParameters","x-stream-index":"004"},"text_content_params":{"$ref":"#/components/schemas/TextContentParameters","x-stream-index":"008"},"text_rule_params":{"$ref":"#/components/schemas/TextRuleParameters","x-stream-index":"003"},"type":{"type":"string","x-stream-index":"001"},"user_created_within_params":{"$ref":"#/components/schemas/UserCreatedWithinParameters","x-stream-index":"011"},"user_custom_property_params":{"$ref":"#/components/schemas/UserCustomPropertyParameters","x-stream-index":"012"},"user_rule_params":{"$ref":"#/components/schemas/UserRuleParameters","x-stream-index":"006"},"video_content_params":{"$ref":"#/components/schemas/VideoContentParameters","x-stream-index":"010"},"video_rule_params":{"$ref":"#/components/schemas/VideoRuleParameters","x-stream-index":"005"}},"type":"object"},"RuleBuilderConditionGroup":{"properties":{"conditions":{"items":{"$ref":"#/components/schemas/RuleBuilderCondition"},"type":"array","x-stream-index":"002"},"logic":{"type":"string","x-stream-index":"001"}},"type":"object"},"RuleBuilderConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"rules":{"items":{"$ref":"#/components/schemas/RuleBuilderRule"},"type":"array","x-stream-index":"002"}},"type":"object"},"RuleBuilderRule":{"properties":{"action":{"$ref":"#/components/schemas/RuleBuilderAction","x-stream-index":"006"},"conditions":{"items":{"$ref":"#/components/schemas/RuleBuilderCondition"},"type":"array","x-stream-index":"003"},"cooldown_period":{"type":"string","x-stream-index":"007"},"groups":{"items":{"$ref":"#/components/schemas/RuleBuilderConditionGroup"},"type":"array","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"logic":{"type":"string","x-stream-index":"004"},"rule_type":{"type":"string","x-stream-index":"002"}},"required":["rule_type","action"],"type":"object"},"SFUIDLastSeen":{"properties":{"id":{"type":"string","x-stream-index":"001.001"},"last_seen":{"format":"date-time","type":"number","x-stream-index":"002"},"process_start_time":{"format":"int64","type":"integer","x-stream-index":"001.002"}},"required":["id","process_start_time","last_seen"],"type":"object"},"STTEgressConfig":{"properties":{"closed_captions_enabled":{"type":"boolean","x-stream-index":"005"},"external_storage":{"$ref":"#/components/schemas/ExternalStorage","x-stream-index":"011"},"language":{"type":"string","x-stream-index":"008"},"storage_name":{"type":"string","x-stream-index":"010"},"translation_languages":{"items":{"type":"string"},"type":"array","x-stream-index":"009"},"translations_enabled":{"type":"boolean","x-stream-index":"006"},"upload_transcriptions":{"type":"boolean","x-stream-index":"004"},"whisper_server_base_url":{"type":"string","x-stream-index":"007"}},"type":"object"},"ScreensharingSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled"],"type":"object"},"ScreensharingSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled"],"type":"object"},"SessionSettings":{"properties":{"inactivity_timeout_seconds":{"format":"int32","maximum":900,"minimum":5,"type":"integer","x-stream-index":"001"}},"required":["inactivity_timeout_seconds"],"type":"object"},"SessionSettingsResponse":{"properties":{"inactivity_timeout_seconds":{"format":"int32","maximum":900,"minimum":5,"type":"integer","x-stream-index":"001"}},"required":["inactivity_timeout_seconds"],"type":"object"},"ShadowBlockActionRequest":{"type":"object"},"SharedLocation":{"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"013"},"channel_cid":{"type":"string","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"010"},"created_by_device_id":{"type":"string","x-stream-index":"008"},"end_at":{"format":"date-time","type":"number","x-stream-index":"009"},"latitude":{"format":"float","maximum":90,"minimum":18446744073709552000,"type":"number","x-stream-index":"006"},"longitude":{"format":"float","maximum":180,"minimum":18446744073709552000,"type":"number","x-stream-index":"007"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"012"},"message_id":{"type":"string","x-stream-index":"004"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"011"},"user_id":{"type":"string","x-stream-index":"005"}},"required":["channel_cid","message_id","user_id","created_by_device_id","created_at","updated_at"],"type":"object"},"SharedLocationResponseData":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"011"},"channel_cid":{"type":"string","x-stream-index":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"created_by_device_id":{"type":"string","x-stream-index":"006"},"end_at":{"format":"date-time","type":"number","x-stream-index":"007"},"latitude":{"format":"float","type":"number","x-stream-index":"004"},"longitude":{"format":"float","type":"number","x-stream-index":"005"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"010"},"message_id":{"type":"string","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["channel_cid","message_id","user_id","latitude","longitude","created_by_device_id","created_at","updated_at"],"type":"object"},"SortParam":{"nullable":true,"properties":{"direction":{"format":"int32","type":"integer","x-stream-index":"002"},"field":{"type":"string","x-stream-index":"001"}},"type":"object"},"SortParamRequest":{"nullable":true,"properties":{"direction":{"description":"Direction of sorting, 1 for Ascending, -1 for Descending, default is 1","format":"int32","title":"Direction","type":"integer","x-stream-index":"002"},"field":{"description":"Name of field to sort by","title":"Field","type":"string","x-stream-index":"001"}},"type":"object"},"SubmitActionRequest":{"nullable":true,"properties":{"action_type":{"description":"Type of moderation action to perform (mark_reviewed, delete_message, etc.)","enum":["mark_reviewed","delete_message","delete_activity","delete_reaction","ban","custom","unban","restore","delete_user","unblock","shadow_block","unmask","kick_user","end_call"],"title":"Action Type","type":"string","x-stream-index":"002"},"ban":{"$ref":"#/components/schemas/BanActionRequest","description":"Configuration for ban action","title":"Ban","x-stream-index":"008"},"custom":{"$ref":"#/components/schemas/CustomActionRequest","description":"Configuration for custom action","title":"Custom","x-stream-index":"009"},"delete_activity":{"$ref":"#/components/schemas/DeleteActivityRequest","description":"Configuration for activity deletion action","title":"Delete Activity","x-stream-index":"004"},"delete_message":{"$ref":"#/components/schemas/DeleteMessageRequest","description":"Configuration for message deletion action","title":"Delete Message","x-stream-index":"003"},"delete_reaction":{"$ref":"#/components/schemas/DeleteReactionRequest","description":"Configuration for reaction deletion action","title":"Delete Reaction","x-stream-index":"005"},"delete_user":{"$ref":"#/components/schemas/DeleteUserRequest","description":"Configuration for user deletion action","title":"Delete User","x-stream-index":"006"},"item_id":{"description":"UUID of the review queue item to act on","title":"Item ID","type":"string","x-stream-index":"001"},"mark_reviewed":{"$ref":"#/components/schemas/MarkReviewedRequest","description":"Configuration for marking item as reviewed","title":"Mark Reviewed","x-stream-index":"007"},"unban":{"$ref":"#/components/schemas/UnbanActionRequest","description":"Configuration for unban action","title":"Unban","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"016.002"},"user_id":{"type":"string","x-stream-index":"016.001"}},"required":["item_id","action_type"],"type":"object"},"SubmitActionResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"Updated review queue item after action was performed","title":"Item","x-stream-index":"001"}},"required":["duration"],"type":"object"},"TargetResolution":{"properties":{"bitrate":{"format":"int32","maximum":6000000,"type":"integer","x-stream-index":"003"},"height":{"format":"int32","maximum":3840,"minimum":240,"type":"integer","x-stream-index":"002"},"width":{"format":"int32","maximum":3840,"minimum":240,"type":"integer","x-stream-index":"001"}},"required":["width","height","bitrate"],"type":"object"},"TextContentParameters":{"properties":{"blocklist_match":{"items":{"type":"string"},"type":"array","x-stream-index":"005"},"contains_url":{"type":"boolean","x-stream-index":"003"},"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001"},"llm_harm_labels":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"002"},"severity":{"type":"string","x-stream-index":"004"}},"type":"object"},"TextRuleParameters":{"properties":{"blocklist_match":{"items":{"type":"string"},"type":"array","x-stream-index":"007"},"contains_url":{"type":"boolean","x-stream-index":"005"},"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"llm_harm_labels":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"004"},"severity":{"type":"string","x-stream-index":"006"},"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"type":"object"},"Thresholds":{"properties":{"explicit":{"$ref":"#/components/schemas/LabelThresholds","x-stream-index":"001"},"spam":{"$ref":"#/components/schemas/LabelThresholds","x-stream-index":"002"},"toxic":{"$ref":"#/components/schemas/LabelThresholds","x-stream-index":"003"}},"type":"object"},"ThumbnailResponse":{"properties":{"image_url":{"type":"string","x-stream-index":"001"}},"required":["image_url"],"type":"object"},"ThumbnailsSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"ThumbnailsSettingsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"Time":{"type":"object"},"TranscriptionSettings":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"title":"Mode","type":"string","x-stream-index":"002"},"language":{"description":"The language used in this call as a two letter code","enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"title":"Language","type":"string","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"title":"Mode","type":"string","x-stream-index":"001"}},"required":["mode","closed_caption_mode","languages","language"],"type":"object"},"TranscriptionSettingsResponse":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"002"},"language":{"enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"type":"string","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode","closed_caption_mode","languages","language"],"type":"object"},"TypingIndicators":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"TypingIndicatorsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"UnbanActionRequest":{"type":"object"},"UnbanRequest":{"nullable":true,"properties":{"unbanned_by":{"$ref":"#/components/schemas/UserRequest","description":"Details about the user performing the unban","title":"Unbanned By","x-stream-index":"005"},"unbanned_by_id":{"description":"ID of the user performing the unban","title":"Unbanned By ID","type":"string","x-stream-index":"004"}},"type":"object"},"UnbanResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"UnblockActionRequest":{"type":"object"},"UnmuteRequest":{"nullable":true,"properties":{"target_ids":{"description":"User IDs to unmute","items":{"type":"string"},"title":"Target IDs","type":"array","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"002.002"},"user_id":{"type":"string","x-stream-index":"002.001"}},"required":["target_ids"],"title":"UnmuteRequest","type":"object"},"UnmuteResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"non_existing_users":{"description":"A list of users that can't be found. Common cause for this is deleted users","items":{"type":"string"},"title":"Non Existing Users","type":"array","x-stream-index":"001"}},"required":["duration"],"title":"UnmuteResponse","type":"object"},"UpsertConfigRequest":{"nullable":true,"properties":{"ai_image_config":{"$ref":"#/components/schemas/AIImageConfig","description":"Configuration for AI image analysis","title":"AI Image Config","x-stream-index":"011"},"ai_text_config":{"$ref":"#/components/schemas/AITextConfig","description":"Configuration for AI text analysis","title":"AI Text Config","x-stream-index":"008"},"ai_video_config":{"$ref":"#/components/schemas/AIVideoConfig","description":"Configuration for AI video analysis","title":"AI Video Config","x-stream-index":"012"},"async":{"description":"Whether moderation should be performed asynchronously","title":"Async","type":"boolean","x-stream-index":"003"},"automod_platform_circumvention_config":{"$ref":"#/components/schemas/AutomodPlatformCircumventionConfig","description":"Configuration for platform circumvention detection","title":"Automod Platform Circumvention Config","x-stream-index":"005"},"automod_semantic_filters_config":{"$ref":"#/components/schemas/AutomodSemanticFiltersConfig","description":"Configuration for semantic filtering","title":"Automod Semantic Filters Config","x-stream-index":"006"},"automod_toxicity_config":{"$ref":"#/components/schemas/AutomodToxicityConfig","description":"Configuration for toxicity detection","title":"Automod Toxicity Config","x-stream-index":"004"},"aws_rekognition_config":{"$ref":"#/components/schemas/AIImageConfig","x-stream-index":"016"},"block_list_config":{"$ref":"#/components/schemas/BlockListConfig","description":"Configuration for block list filtering","title":"Block List Config","x-stream-index":"007"},"bodyguard_config":{"$ref":"#/components/schemas/AITextConfig","x-stream-index":"015"},"google_vision_config":{"$ref":"#/components/schemas/GoogleVisionConfig","description":"Configuration for Google Vision integration","title":"Google Vision Config","x-stream-index":"010"},"key":{"description":"Unique identifier for the moderation configuration","title":"Key","type":"string","x-stream-index":"001"},"llm_config":{"$ref":"#/components/schemas/LLMConfig","description":"Configuration for customer-configured LLM moderation","title":"LLM Config","x-stream-index":"009"},"rule_builder_config":{"$ref":"#/components/schemas/RuleBuilderConfig","description":"Configuration for custom rule builder (max 3 rules, max 5 conditions per rule)","title":"Rule Builder Config","x-stream-index":"014"},"team":{"description":"Team associated with the configuration","maxLength":128,"minLength":1,"title":"Team","type":"string","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"018.002"},"user_id":{"type":"string","x-stream-index":"018.001"},"velocity_filter_config":{"$ref":"#/components/schemas/VelocityFilterConfig","description":"Configuration for velocity-based filtering","title":"Velocity Filter Config","x-stream-index":"013"},"video_call_rule_config":{"$ref":"#/components/schemas/VideoCallRuleConfig","x-stream-index":"017"}},"required":["key"],"type":"object"},"UpsertConfigResponse":{"nullable":true,"properties":{"config":{"$ref":"#/components/schemas/ConfigResponse","description":"The created or updated moderation configuration","title":"Config","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["duration"],"type":"object"},"UpsertModerationRuleRequest":{"nullable":true,"properties":{"action":{"$ref":"#/components/schemas/RuleBuilderAction","x-stream-index":"009"},"conditions":{"items":{"$ref":"#/components/schemas/RuleBuilderCondition"},"type":"array","x-stream-index":"006"},"config_keys":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"cooldown_period":{"type":"string","x-stream-index":"010"},"description":{"type":"string","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"011"},"groups":{"items":{"$ref":"#/components/schemas/RuleBuilderConditionGroup"},"type":"array","x-stream-index":"008"},"logic":{"type":"string","x-stream-index":"007"},"name":{"type":"string","x-stream-index":"001"},"rule_type":{"type":"string","x-stream-index":"005"},"team":{"type":"string","x-stream-index":"004"}},"required":["name","rule_type","action"],"type":"object"},"UpsertModerationRuleResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"rule":{"$ref":"#/components/schemas/ModerationRuleV2Response","x-stream-index":"002"}},"required":["duration"],"title":"Response","type":"object"},"UpsertModerationTemplateRequest":{"nullable":true,"properties":{"config":{"$ref":"#/components/schemas/FeedsModerationTemplateConfig","description":"Configuration for the moderation template","title":"Config","x-stream-index":"002"},"name":{"description":"Name of the moderation template","title":"Name","type":"string","x-stream-index":"001"}},"required":["name","config"],"type":"object"},"UpsertModerationTemplateResponse":{"nullable":true,"properties":{"config":{"$ref":"#/components/schemas/FeedsModerationTemplateConfig","description":"Configuration for the moderation template","title":"Config","x-stream-index":"002"},"created_at":{"description":"When the template was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"003"},"duration":{"type":"string","x-stream-index":"005.001"},"name":{"description":"Name of the moderation template","title":"Name","type":"string","x-stream-index":"001"},"updated_at":{"description":"When the template was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"004"}},"required":["name","created_at","updated_at","duration"],"type":"object"},"User":{"properties":{"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"046"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"017"},"banned":{"type":"boolean","x-stream-index":"016"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"013"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"023"},"language":{"type":"string","x-stream-index":"035"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"026"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"042"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"005"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"009"}},"required":["id","role","teams_role","custom","banned","online"],"type":"object"},"UserCreatedWithinParameters":{"properties":{"max_age":{"type":"string","x-stream-index":"001"}},"type":"object"},"UserCustomPropertyParameters":{"properties":{"operator":{"type":"string","x-stream-index":"002"},"property_key":{"type":"string","x-stream-index":"001"}},"type":"object"},"UserMute":{"nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"expires":{"description":"Date/time of mute expiration","format":"date-time","title":"Expires","type":"number","x-stream-index":"008"},"target":{"$ref":"#/components/schemas/User","description":"User who's muted","title":"Target","x-stream-index":"007"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/User","description":"Owner of channel mute","title":"User","x-stream-index":"005"}},"required":["created_at","updated_at"],"type":"object"},"UserRequest":{"description":"User request object","properties":{"custom":{"additionalProperties":{},"description":"Custom user data","title":"Custom","type":"object","x-stream-index":"004"},"id":{"description":"User ID","title":"ID","type":"string","x-stream-index":"001"},"image":{"description":"User's profile image URL","title":"Image","type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"006"},"language":{"type":"string","x-stream-index":"005"},"name":{"description":"Optional name of user","title":"Name","type":"string","x-stream-index":"002"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"007"},"role":{"description":"User's global role","title":"Role","type":"string","x-stream-index":"008"},"teams":{"description":"List of teams the user belongs to","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"010"},"teams_role":{"additionalProperties":{"type":"string"},"description":"Map of team-specific roles for the user","title":"TeamsRole","type":"object","x-stream-index":"009"}},"required":["id"],"title":"UserRequest","type":"object"},"UserResponse":{"description":"User response object","properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"ban_expires":{"description":"Date when ban expires","format":"date-time","title":"Ban expires","type":"number","x-stream-index":"003"},"banned":{"description":"Whether a user is banned or not","title":"Banned","type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.017"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"001.004"},"deactivated_at":{"description":"Date of deactivation","format":"date-time","title":"Deactivated at","type":"number","x-stream-index":"001.016"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"001.011"},"devices":{"description":"List of devices user is using","items":{"$ref":"#/components/schemas/DeviceResponse"},"title":"Devices","type":"array","x-stream-index":"006"},"id":{"description":"Unique user identifier","title":"ID","type":"string","x-stream-index":"001.001"},"image":{"title":"Image","type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"007"},"language":{"description":"Preferred language of a user","title":"Language","type":"string","x-stream-index":"001.005"},"last_active":{"description":"Date of last activity","format":"date-time","title":"Last active","type":"number","x-stream-index":"001.014"},"name":{"description":"Optional name of user","title":"Name","type":"string","x-stream-index":"001.002"},"online":{"description":"Whether a user online or not","title":"Online","type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","description":"User privacy settings","title":"Privacy settings","x-stream-index":"005"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettingsResponse","description":"User push notification settings","title":"Push notifications","x-stream-index":"004"},"revoke_tokens_issued_before":{"description":"Revocation date for tokens","format":"date-time","title":"Revoke tokens issued before","type":"number","x-stream-index":"001.015"},"role":{"description":"Determines the set of user permissions","title":"Role","type":"string","x-stream-index":"001.006"},"shadow_banned":{"description":"Whether a user is shadow banned","title":"Shadow banned","type":"boolean","x-stream-index":"002"},"teams":{"description":"List of teams user is a part of","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids","shadow_banned","invisible"],"title":"UserResponse","type":"object"},"UserRuleParameters":{"properties":{"max_age":{"type":"string","x-stream-index":"001"}},"type":"object"},"VelocityFilterConfig":{"properties":{"advanced_filters":{"type":"boolean","x-stream-index":"007"},"async":{"type":"boolean","x-stream-index":"001"},"cascading_actions":{"type":"boolean","x-stream-index":"004"},"cids_per_user":{"format":"int32","type":"integer","x-stream-index":"006"},"enabled":{"type":"boolean","x-stream-index":"002"},"first_message_only":{"type":"boolean","x-stream-index":"005"},"rules":{"items":{"$ref":"#/components/schemas/VelocityFilterConfigRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules","cascading_actions","first_message_only","cids_per_user","advanced_filters"],"type":"object"},"VelocityFilterConfigRule":{"properties":{"action":{"enum":["flag","shadow","remove","ban"],"type":"string","x-stream-index":"001"},"ban_duration":{"format":"int32","type":"integer","x-stream-index":"002"},"cascading_action":{"enum":["flag","shadow","remove","ban"],"type":"string","x-stream-index":"006"},"cascading_threshold":{"format":"int64","type":"integer","x-stream-index":"005"},"check_message_context":{"type":"boolean","x-stream-index":"009"},"fast_spam_threshold":{"format":"int32","type":"integer","x-stream-index":"007"},"fast_spam_ttl":{"format":"int32","type":"integer","x-stream-index":"010"},"ip_ban":{"type":"boolean","x-stream-index":"004"},"probation_period":{"format":"int32","type":"integer","x-stream-index":"014"},"shadow_ban":{"type":"boolean","x-stream-index":"003"},"slow_spam_ban_duration":{"format":"int32","type":"integer","x-stream-index":"012"},"slow_spam_threshold":{"format":"int32","type":"integer","x-stream-index":"008"},"slow_spam_ttl":{"format":"int32","type":"integer","x-stream-index":"011"},"url_only":{"type":"boolean","x-stream-index":"013"}},"required":["action","ban_duration","shadow_ban","ip_ban","cascading_threshold","cascading_action","fast_spam_threshold","slow_spam_threshold","check_message_context","fast_spam_ttl","slow_spam_ttl","url_only","probation_period"],"type":"object"},"VideoCallRuleConfig":{"properties":{"rules":{"additionalProperties":{"$ref":"#/components/schemas/HarmConfig"},"type":"object","x-stream-index":"001"}},"required":["rules"],"type":"object"},"VideoContentParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"type":"object"},"VideoEndCallRequest":{"type":"object"},"VideoKickUserRequest":{"type":"object"},"VideoOrientation":{"properties":{"orientation":{"type":"integer","x-stream-index":"004"}},"type":"object"},"VideoRuleParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"type":"object"},"VideoSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"camera_default_on":{"type":"boolean","x-stream-index":"004"},"camera_facing":{"enum":["front","back","external"],"type":"string","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled","target_resolution","camera_default_on","camera_facing"],"type":"object"},"VideoSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"camera_default_on":{"type":"boolean","x-stream-index":"004"},"camera_facing":{"enum":["front","back","external"],"type":"string","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled","target_resolution","camera_default_on","camera_facing"],"type":"object"},"WebhookEvent":{"description":"The discriminator object for all webhook events, it maps events' payload to the final type","discriminator":{"mapping":{"export.bulk_image_moderation.error":"#/components/schemas/AsyncExportErrorEvent","export.bulk_image_moderation.success":"#/components/schemas/AsyncBulkImageModerationEvent","export.moderation_logs.error":"#/components/schemas/AsyncExportErrorEvent","export.moderation_logs.success":"#/components/schemas/AsyncExportModerationLogsEvent","moderation.custom_action":"#/components/schemas/ModerationCustomActionEvent","moderation.flagged":"#/components/schemas/ModerationFlaggedEvent","moderation.mark_reviewed":"#/components/schemas/ModerationMarkReviewedEvent","moderation_check.completed":"#/components/schemas/ModerationCheckCompletedEvent","review_queue_item.new":"#/components/schemas/ReviewQueueItemNewEvent","review_queue_item.updated":"#/components/schemas/ReviewQueueItemUpdatedEvent"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/AsyncBulkImageModerationEvent"},{"$ref":"#/components/schemas/AsyncExportErrorEvent"},{"$ref":"#/components/schemas/AsyncExportErrorEvent"},{"$ref":"#/components/schemas/AsyncExportModerationLogsEvent"},{"$ref":"#/components/schemas/ModerationCheckCompletedEvent"},{"$ref":"#/components/schemas/ModerationCustomActionEvent"},{"$ref":"#/components/schemas/ModerationFlaggedEvent"},{"$ref":"#/components/schemas/ModerationMarkReviewedEvent"},{"$ref":"#/components/schemas/ReviewQueueItemNewEvent"},{"$ref":"#/components/schemas/ReviewQueueItemUpdatedEvent"}]}},"securitySchemes":{"JWT":{"description":"JWT should be always provided when stream-auth-type=jwt.\n\nUsing JWT auth request could be authenticated as user or as server-side.\n\nWhen using user authentication permission checking is going to be applied to requests based on the user that is\nperforming a request.\n\nThe `authorization` header should be a JWT string signed using the secret attached to the API key used to perform\nrequests.\n\n**WARNING** all client-side official SDK do not ship with token generation; this is to make sure that the API secret is not\nshared with an untrusted party such as a browser or a iOS/Android application. Tokens **must** be generated server-side.\nIf you wish, you can configure your application to ignore authentication (see `disable_auth_check`)\nThe JWT string must include only the user_id claim and can include any built-in JWT claim such as iat, exp as well.\n","in":"header","name":"Authorization","type":"apiKey"},"api_key":{"description":"Application API key should be always set in order to authenticate the request.","in":"query","name":"api_key","type":"apiKey"},"stream-auth-type":{"description":"Stream-Auth-Type should be always set in order to authenticate the request. Possible\nvalues: `jwt` or `anonymous`.\n\n`jwt` allows you to authenticate as a user. With this auth type you should also provide valid JWT in Authorization\nheader.\n\n`anonymous` allows you to authenticate as anonymous user. Please note that most advanced features are not available\nto anonymous users.","in":"header","name":"Stream-Auth-Type","type":"apiKey"}}},"info":{"title":"Stream API","version":"v191.1.0"},"openapi":"3.0.3","paths":{"/api/v2/moderation/ban":{"post":{"description":"Ban a user from a channel or the entire app\n","operationId":"ban","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BanRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BanResponse"}}},"description":"Successful 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":"Ban","tags":["product:moderation"]}},"/api/v2/moderation/bulk_image_moderation":{"post":{"description":"Moderate multiple images in bulk using a CSV file\n","operationId":"bulk_image_moderation","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkImageModerationRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkImageModerationResponse"}}},"description":"Successful 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":"Bulk image moderation","tags":["product:moderation"]}},"/api/v2/moderation/check":{"post":{"description":"Run moderation checks on the provided content\n","operationId":"check","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckResponse"}}},"description":"Successful 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":"Check","tags":["product:moderation"]}},"/api/v2/moderation/config":{"post":{"description":"Create a new moderation configuration or update an existing one. Configure settings for content filtering, AI analysis, toxicity detection, and other moderation features.\n","operationId":"upsert_config","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertConfigRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertConfigResponse"}}},"description":"Successful 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":"Create or update moderation configuration","tags":["product:moderation"]}},"/api/v2/moderation/config/{key}":{"delete":{"description":"Delete a specific moderation policy by its name\n","operationId":"delete_config","parameters":[{"in":"path","name":"key","required":true,"schema":{"description":"Key of the moderation configuration to delete","title":"Key","type":"string","x-stream-index":"001"}},{"in":"query","name":"team","schema":{"description":"Team associated with the configuration","title":"Team","type":"string","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteModerationConfigResponse"}}},"description":"Successful 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":"Delete a moderation policy","tags":["product:moderation"]},"get":{"description":"Retrieve a specific moderation configuration by its key and team. This configuration contains settings for various moderation features like toxicity detection, AI analysis, and filtering rules.\n","operationId":"get_config","parameters":[{"in":"path","name":"key","required":true,"schema":{"description":"Key of the moderation configuration to retrieve","title":"Key","type":"string","x-stream-index":"001"}},{"in":"query","name":"team","schema":{"description":"Team associated with the configuration","title":"Team","type":"string","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetConfigResponse"}}},"description":"Successful 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":"Get moderation configuration","tags":["product:moderation"]}},"/api/v2/moderation/configs":{"post":{"description":"Search and filter moderation configurations across your application. This endpoint is designed for building moderation dashboards and managing multiple configuration sets.\n","operationId":"query_moderation_configs","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationConfigsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationConfigsResponse"}}},"description":"Successful 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":"Query moderation configurations","tags":["product:moderation"]}},"/api/v2/moderation/custom_check":{"post":{"description":"Custom check, add your own AI model reports to the review queue\n","operationId":"custom_check","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomCheckRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomCheckResponse"}}},"description":"Successful 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":"Custom check endpoint","tags":["product:moderation"]}},"/api/v2/moderation/feeds_moderation_template":{"delete":{"description":"Delete a specific moderation template by its name\n","operationId":"V2DeleteTemplate","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteModerationTemplateResponse"}}},"description":"Successful 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":"Delete a moderation template","tags":["product:moderation"]},"get":{"description":"Retrieve a list of feed moderation templates that define preset moderation rules and configurations. Limited to 100 templates per request.\n","operationId":"V2QueryTemplates","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryFeedModerationTemplatesResponse"}}},"description":"Successful 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":"Query feed moderation templates","tags":["product:moderation"]},"post":{"description":"Upsert feeds template for moderation\n","operationId":"V2UpsertTemplate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertModerationTemplateRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertModerationTemplateResponse"}}},"description":"Successful 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":"Upsert feeds template","tags":["product:moderation"]}},"/api/v2/moderation/flag":{"post":{"description":"Flag any type of content (messages, users, channels, activities) for moderation review. Supports custom content types and additional metadata for flagged content.\n","operationId":"flag","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlagRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlagResponse"}}},"description":"Successful 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":"Flag content for moderation","tags":["product:moderation"]}},"/api/v2/moderation/flags":{"post":{"description":"Query flags associated with moderation items. This is used for building a moderation dashboard.\n","operationId":"query_moderation_flags","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationFlagsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationFlagsResponse"}}},"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":"Query moderation flags","tags":["product:moderation"]}},"/api/v2/moderation/logs":{"post":{"description":"Search and filter moderation action logs with support for pagination. View the history of moderation actions taken, including who performed them and when.\n","operationId":"query_moderation_logs","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationLogsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationLogsResponse"}}},"description":"Successful 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":"Query moderation action logs","tags":["product:moderation"]}},"/api/v2/moderation/moderation_rule":{"post":{"description":"Create or update a moderation rule that can apply app-wide or to specific moderation configs\n","operationId":"upsert_moderation_rule","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertModerationRuleRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertModerationRuleResponse"}}},"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":"Upsert moderation rule","tags":["product:moderation"]}},"/api/v2/moderation/moderation_rule/{id}":{"delete":{"description":"Delete an existing moderation rule\n","operationId":"delete_moderation_rule","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteModerationRuleResponse"}}},"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":"Delete moderation rule","tags":["product:moderation"]},"get":{"description":"Get a specific moderation rule by ID\n","operationId":"get_moderation_rule","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetModerationRuleResponse"}}},"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":"Get moderation rule","tags":["product:moderation"]}},"/api/v2/moderation/moderation_rules":{"post":{"description":"Search and filter moderation rules across your application. This endpoint is designed for building moderation dashboards and managing multiple rule sets.\n","operationId":"query_moderation_rules","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationRulesRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationRulesResponse"}}},"description":"Successful 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":"Query moderation rules","tags":["product:moderation"]}},"/api/v2/moderation/mute":{"post":{"description":"Mute a user. Mutes are generally not visible to the user you mute, while block is something you notice.\n","operationId":"mute","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteRequest"}}},"description":"MuteRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteResponse"}}},"description":"MuteResponse"},"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":"Mute","tags":["product:moderation"]}},"/api/v2/moderation/review_queue":{"post":{"description":"Query review queue items allows you to filter the review queue items. This is used for building a moderation dashboard.\n","operationId":"query_review_queue","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryReviewQueueRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryReviewQueueResponse"}}},"description":"Successful 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":"Query review queue items","tags":["product:moderation"]}},"/api/v2/moderation/review_queue/{id}":{"get":{"description":"Retrieve a specific review queue item by its ID\n","operationId":"get_review_queue_item","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Unique identifier of the review queue item to retrieve","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetReviewQueueItemResponse"}}},"description":"Successful 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":"Get review queue item","tags":["product:moderation"]}},"/api/v2/moderation/submit_action":{"post":{"description":"Take action on flagged content, such as marking content as safe, deleting content, banning users, or executing custom moderation actions. Supports various action types with configurable parameters.\n","operationId":"submit_action","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitActionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitActionResponse"}}},"description":"Successful 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":"Submit moderation action","tags":["product:moderation"]}},"/api/v2/moderation/unban":{"post":{"description":"Unban a user from a channel or globally.\n","operationId":"unban","parameters":[{"in":"query","name":"target_user_id","required":true,"schema":{"description":"ID of the user to unban","title":"Target User ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"channel_cid","schema":{"description":"Channel where the unban applies","title":"Channel CID","type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"created_by","schema":{"description":"ID of the user who created the ban","title":"Created By","type":"string","writeOnly":true,"x-stream-index":"003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnbanRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnbanResponse"}}},"description":"Successful 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":"Unban","tags":["product:moderation"]}},"/api/v2/moderation/unmute":{"post":{"description":"Unmute a user\n","operationId":"unmute","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnmuteRequest"}}},"description":"UnmuteRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnmuteResponse"}}},"description":"UnmuteResponse"},"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":"Unmute a user","tags":["product:moderation"]}}},"security":[{"JWT":[],"api_key":[],"stream-auth-type":[]},{"api_key":[],"stream-auth-type":[]}],"servers":[{"description":"Stream API","url":"https://chat.stream-io-api.com"}]} \ No newline at end of file diff --git a/openapi/moderation-serverside-api.yaml b/openapi/moderation-serverside-api.yaml index 06ccd6563..13b4896c5 100644 --- a/openapi/moderation-serverside-api.yaml +++ b/openapi/moderation-serverside-api.yaml @@ -839,11 +839,6 @@ components: shadow_ban: type: boolean x-stream-index: "003" - required: - - duration - - reason - - shadow_ban - - ip_ban type: object BanRequest: nullable: true @@ -913,8 +908,6 @@ components: reason: type: string x-stream-index: "001" - required: - - reason type: object BlockListConfig: properties: @@ -2004,6 +1997,14 @@ components: $ref: '#/components/schemas/ChannelMember' type: array x-stream-index: "020" + message_count: + format: int64 + type: integer + x-stream-index: "035" + message_count_updated_at: + format: date-time + type: number + x-stream-index: "036" team: type: string x-stream-index: "028" @@ -2034,39 +2035,39 @@ components: items: type: string type: array - x-stream-index: "001.026" + x-stream-index: "001.027" automod: enum: - disabled - simple - AI type: string - x-stream-index: "001.021" + x-stream-index: "001.022" automod_behavior: enum: - flag - block - shadow_block type: string - x-stream-index: "001.022" + x-stream-index: "001.023" automod_thresholds: $ref: '#/components/schemas/Thresholds' - x-stream-index: "001.027" + x-stream-index: "001.028" blocklist: type: string - x-stream-index: "001.023" + x-stream-index: "001.024" blocklist_behavior: enum: - flag - block - shadow_block type: string - x-stream-index: "001.024" + x-stream-index: "001.025" blocklists: items: $ref: '#/components/schemas/BlockListOptions' type: array - x-stream-index: "001.025" + x-stream-index: "001.026" commands: items: type: string @@ -2075,6 +2076,9 @@ components: connect_events: type: boolean x-stream-index: "001.004" + count_messages: + type: boolean + x-stream-index: "001.019" created_at: format: date-time type: number @@ -2089,7 +2093,7 @@ components: format: int32 maximum: 20000 type: integer - x-stream-index: "001.020" + x-stream-index: "001.021" mutes: type: boolean x-stream-index: "001.009" @@ -2099,10 +2103,10 @@ components: partition_size: format: int32 type: integer - x-stream-index: "001.028" + x-stream-index: "001.029" partition_ttl: type: integer - x-stream-index: "001.029" + x-stream-index: "001.030" polls: type: boolean x-stream-index: "001.016" @@ -2132,7 +2136,7 @@ components: x-stream-index: "001.018" skip_last_msg_update_for_system_msgs: type: boolean - x-stream-index: "001.030" + x-stream-index: "001.031" typing_events: type: boolean x-stream-index: "001.002" @@ -2168,6 +2172,7 @@ components: - polls - user_message_reminders - shared_locations + - count_messages - message_retention - max_message_length - automod @@ -2183,39 +2188,39 @@ components: items: type: string type: array - x-stream-index: 001.002.026 + x-stream-index: 001.002.027 automod: enum: - disabled - simple - AI type: string - x-stream-index: 001.002.021 + x-stream-index: 001.002.022 automod_behavior: enum: - flag - block - shadow_block type: string - x-stream-index: 001.002.022 + x-stream-index: 001.002.023 automod_thresholds: $ref: '#/components/schemas/Thresholds' - x-stream-index: 001.002.027 + x-stream-index: 001.002.028 blocklist: type: string - x-stream-index: 001.002.023 + x-stream-index: 001.002.024 blocklist_behavior: enum: - flag - block - shadow_block type: string - x-stream-index: 001.002.024 + x-stream-index: 001.002.025 blocklists: items: $ref: '#/components/schemas/BlockListOptions' type: array - x-stream-index: 001.002.025 + x-stream-index: 001.002.026 commands: items: $ref: '#/components/schemas/Command' @@ -2224,6 +2229,9 @@ components: connect_events: type: boolean x-stream-index: 001.002.004 + count_messages: + type: boolean + x-stream-index: 001.002.019 created_at: format: date-time type: number @@ -2245,7 +2253,7 @@ components: format: int32 maximum: 20000 type: integer - x-stream-index: 001.002.020 + x-stream-index: 001.002.021 mutes: type: boolean x-stream-index: 001.002.009 @@ -2255,10 +2263,10 @@ components: partition_size: format: int32 type: integer - x-stream-index: 001.002.028 + x-stream-index: 001.002.029 partition_ttl: type: integer - x-stream-index: 001.002.029 + x-stream-index: 001.002.030 polls: type: boolean x-stream-index: 001.002.016 @@ -2288,7 +2296,7 @@ components: x-stream-index: 001.002.018 skip_last_msg_update_for_system_msgs: type: boolean - x-stream-index: 001.002.030 + x-stream-index: 001.002.031 typing_events: type: boolean x-stream-index: 001.002.002 @@ -2326,6 +2334,7 @@ components: - polls - user_message_reminders - shared_locations + - count_messages - message_retention - max_message_length - automod @@ -2362,6 +2371,11 @@ components: format: date-time type: number x-stream-index: "014" + deleted_messages: + items: + type: string + type: array + x-stream-index: "027" invite_accepted_at: format: date-time type: number @@ -2510,6 +2524,10 @@ components: $ref: '#/components/schemas/ChannelMember' type: array x-stream-index: "014" + message_count: + format: int64 + type: integer + x-stream-index: "031" mute_expires_at: format: date-time type: number @@ -2603,7 +2621,6 @@ components: - entity_type - entity_id - entity_creator_id - - config_key type: object CheckResponse: nullable: true @@ -2706,6 +2723,9 @@ components: type: string type: array x-stream-index: "011" + count_messages: + type: boolean + x-stream-index: "014" grants: additionalProperties: items: @@ -2752,7 +2772,7 @@ components: $ref: '#/components/schemas/AIImageConfig' description: Configuration for AI image analysis title: AI Image Config - x-stream-index: "009" + x-stream-index: "010" ai_text_config: $ref: '#/components/schemas/AITextConfig' description: Configuration for AI text analysis @@ -2762,7 +2782,7 @@ components: $ref: '#/components/schemas/AIVideoConfig' description: Configuration for AI video analysis title: AI Video Config - x-stream-index: "010" + x-stream-index: "011" async: description: Whether moderation should be performed asynchronously title: Async @@ -2793,15 +2813,17 @@ components: format: date-time title: Created At type: number - x-stream-index: "012" + x-stream-index: "013" key: description: Unique identifier for the moderation configuration title: Key type: string x-stream-index: "001" - rule_builder_config: - $ref: '#/components/schemas/RuleBuilderConfig' - x-stream-index: "015" + llm_config: + $ref: '#/components/schemas/LLMConfig' + description: Configuration for customer-configured LLM moderation + title: LLM Config + x-stream-index: "009" team: description: Team associated with the configuration title: Team @@ -2812,15 +2834,15 @@ components: format: date-time title: Updated At type: number - x-stream-index: "013" + x-stream-index: "014" velocity_filter_config: $ref: '#/components/schemas/VelocityFilterConfig' description: Configuration for velocity-based filtering title: Velocity Filter Config - x-stream-index: "011" + x-stream-index: "012" video_call_rule_config: $ref: '#/components/schemas/VideoCallRuleConfig' - x-stream-index: "014" + x-stream-index: "015" required: - key - team @@ -2837,9 +2859,6 @@ components: time_window: type: string x-stream-index: "002" - required: - - threshold - - time_window type: object CustomActionRequest: properties: @@ -2979,6 +2998,19 @@ components: required: - duration type: object + DeleteModerationRuleResponse: + 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 DeleteModerationTemplateResponse: nullable: true properties: @@ -3662,6 +3694,21 @@ components: type: object x-stream-index: "001" type: object + FeedsEventPreferences: + properties: + comments: + type: string + x-stream-index: "002" + mentions: + type: string + x-stream-index: "004" + new_followers: + type: string + x-stream-index: "003" + reactions: + type: string + x-stream-index: "001" + type: object FeedsModerationTemplateConfig: properties: config_key: @@ -3790,8 +3837,6 @@ components: reason: type: string x-stream-index: "001" - required: - - reason type: object FlagRequest: nullable: true @@ -3858,8 +3903,6 @@ components: reason: type: string x-stream-index: "001" - required: - - reason type: object FrameRecordSettings: properties: @@ -3963,6 +4006,22 @@ components: required: - duration type: object + GetModerationRuleResponse: + description: Basic response information + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "001.001" + rule: + $ref: '#/components/schemas/ModerationRuleV2Response' + x-stream-index: "002" + required: + - duration + title: Response + type: object GetReviewQueueItemResponse: nullable: true properties: @@ -4110,9 +4169,6 @@ components: time_window: type: string x-stream-index: "002" - required: - - threshold - - time_window type: object Images: properties: @@ -4297,6 +4353,61 @@ components: - max_dimension - frame_rate_limit type: object + LLMConfig: + properties: + app_context: + type: string + x-stream-index: "005" + async: + type: boolean + x-stream-index: "001" + enabled: + type: boolean + x-stream-index: "002" + rules: + items: + $ref: '#/components/schemas/LLMRule' + type: array + x-stream-index: "003" + severity_descriptions: + additionalProperties: + type: string + type: object + x-stream-index: "004" + required: + - enabled + - rules + type: object + LLMRule: + properties: + action: + enum: + - flag + - shadow + - remove + - bounce + - bounce_flag + - bounce_remove + - keep + type: string + x-stream-index: "003" + description: + type: string + x-stream-index: "002" + label: + type: string + x-stream-index: "001" + severity_rules: + items: + $ref: '#/components/schemas/BodyguardSeverityRule' + type: array + x-stream-index: "004" + required: + - label + - description + - action + - severity_rules + type: object LabelThresholds: properties: block: @@ -4461,6 +4572,9 @@ components: format: date-time type: number x-stream-index: "033" + deleted_for_me: + type: boolean + x-stream-index: "059" deleted_reply_count: format: int32 type: integer @@ -4700,6 +4814,9 @@ components: title: Deleted at type: number x-stream-index: "025" + deleted_for_me: + type: boolean + x-stream-index: "044" deleted_reply_count: format: int32 type: integer @@ -5064,61 +5181,64 @@ components: nullable: true properties: created_at: - type: string - x-stream-index: "014" + format: date-time + type: number + x-stream-index: "015" custom: additionalProperties: {} type: object - x-stream-index: "009" + x-stream-index: "010" entity_creator_id: type: string - x-stream-index: "006" + x-stream-index: "007" entity_id: type: string - x-stream-index: "005" + x-stream-index: "006" entity_type: type: string - x-stream-index: "004" - id: - type: string - x-stream-index: "001" + x-stream-index: "005" labels: items: type: string type: array - x-stream-index: "010" + x-stream-index: "011" moderation_payload: $ref: '#/components/schemas/ModerationPayload' - x-stream-index: "007" + x-stream-index: "008" reason: type: string - x-stream-index: "008" + x-stream-index: "009" result: items: additionalProperties: {} type: object type: array - x-stream-index: "011" + x-stream-index: "012" review_queue_item: $ref: '#/components/schemas/ReviewQueueItemResponse' - x-stream-index: "013" + x-stream-index: "014" review_queue_item_id: type: string - x-stream-index: "012" + x-stream-index: "013" type: type: string x-stream-index: "002" updated_at: - type: string - x-stream-index: "015" + format: date-time + type: number + x-stream-index: "016" user: $ref: '#/components/schemas/UserResponse' + x-stream-index: "004" + user_id: + type: string x-stream-index: "003" required: - - id - type + - user_id - entity_type - entity_id + - result - created_at - updated_at type: object @@ -5201,34 +5321,98 @@ components: type: array x-stream-index: "003" type: object - ModerationV2Response: + ModerationRuleV2Response: properties: action: - type: string - x-stream-index: "001" - blocklist_matched: - type: string - x-stream-index: "005" - image_harms: + $ref: '#/components/schemas/RuleBuilderAction' + x-stream-index: "010" + conditions: + items: + $ref: '#/components/schemas/RuleBuilderCondition' + type: array + x-stream-index: "007" + config_keys: items: type: string type: array x-stream-index: "004" - original_text: + cooldown_period: type: string - x-stream-index: "002" - platform_circumvented: - type: boolean - x-stream-index: "007" - semantic_filter_matched: + x-stream-index: "011" + created_at: + format: date-time + type: number + x-stream-index: "013" + description: type: string - x-stream-index: "006" - text_harms: + x-stream-index: "003" + enabled: + type: boolean + x-stream-index: "012" + groups: items: - type: string + $ref: '#/components/schemas/RuleBuilderConditionGroup' type: array - x-stream-index: "003" - required: + x-stream-index: "009" + id: + type: string + x-stream-index: "001" + logic: + type: string + x-stream-index: "008" + name: + type: string + x-stream-index: "002" + rule_type: + type: string + x-stream-index: "006" + team: + type: string + x-stream-index: "005" + updated_at: + format: date-time + type: number + x-stream-index: "014" + required: + - id + - name + - description + - config_keys + - team + - rule_type + - action + - enabled + - created_at + - updated_at + type: object + ModerationV2Response: + properties: + action: + type: string + x-stream-index: "001" + blocklist_matched: + type: string + x-stream-index: "005" + image_harms: + items: + type: string + type: array + x-stream-index: "004" + original_text: + type: string + x-stream-index: "002" + platform_circumvented: + type: boolean + x-stream-index: "007" + semantic_filter_matched: + type: string + x-stream-index: "006" + text_harms: + items: + type: string + type: array + x-stream-index: "003" + required: - action - original_text type: object @@ -5844,6 +6028,12 @@ components: disabled_until: format: date-time type: number + x-stream-index: "005" + feeds_events: + $ref: '#/components/schemas/FeedsEventPreferences' + x-stream-index: "004" + feeds_level: + type: string x-stream-index: "003" type: object Quality: @@ -6084,6 +6274,72 @@ components: - logs - duration type: object + QueryModerationRulesRequest: + nullable: true + properties: + filter: + additionalProperties: {} + description: Filter conditions for moderation rules + title: Filter + type: object + x-stream-index: "001" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "003.001" + next: + type: string + x-stream-index: "003.002" + prev: + type: string + x-stream-index: "003.003" + sort: + description: Sorting parameters for the results + items: + $ref: '#/components/schemas/SortParamRequest' + title: Sort + type: array + x-stream-index: "002" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "004.002" + user_id: + type: string + x-stream-index: "004.001" + type: object + QueryModerationRulesResponse: + nullable: true + properties: + default_llm_labels: + additionalProperties: + type: string + description: Default LLM label descriptions + title: DefaultLLMLabels + type: object + x-stream-index: "002" + duration: + type: string + x-stream-index: "004.001" + next: + type: string + x-stream-index: "003.001" + prev: + type: string + x-stream-index: "003.002" + rules: + description: List of moderation rules + items: + $ref: '#/components/schemas/ModerationRuleV2Response' + title: Rules + type: array + x-stream-index: "001" + required: + - rules + - default_llm_labels + - duration + type: object QueryReviewQueueRequest: nullable: true properties: @@ -6707,7 +6963,7 @@ components: flags: description: The flags associated with this review queue item items: - $ref: '#/components/schemas/FlagResponse' + $ref: '#/components/schemas/ModerationFlagResponse' title: Flags type: array x-stream-index: "003" @@ -6814,7 +7070,7 @@ components: flags: description: Associated flag records items: - $ref: '#/components/schemas/FlagResponse' + $ref: '#/components/schemas/ModerationFlagResponse' title: Flags type: array x-stream-index: "023" @@ -6924,7 +7180,7 @@ components: flags: description: The flags associated with this review queue item items: - $ref: '#/components/schemas/FlagResponse' + $ref: '#/components/schemas/ModerationFlagResponse' title: Flags type: array x-stream-index: "003" @@ -7006,8 +7262,6 @@ components: type: type: string x-stream-index: "001" - required: - - type type: object RuleBuilderCondition: properties: @@ -7036,6 +7290,9 @@ components: user_created_within_params: $ref: '#/components/schemas/UserCreatedWithinParameters' x-stream-index: "011" + user_custom_property_params: + $ref: '#/components/schemas/UserCustomPropertyParameters' + x-stream-index: "012" user_rule_params: $ref: '#/components/schemas/UserRuleParameters' x-stream-index: "006" @@ -7045,8 +7302,6 @@ components: video_rule_params: $ref: '#/components/schemas/VideoRuleParameters' x-stream-index: "005" - required: - - type type: object RuleBuilderConditionGroup: properties: @@ -7058,9 +7313,6 @@ components: logic: type: string x-stream-index: "001" - required: - - logic - - conditions type: object RuleBuilderConfig: properties: @@ -7072,48 +7324,37 @@ components: $ref: '#/components/schemas/RuleBuilderRule' type: array x-stream-index: "002" - required: - - rules type: object RuleBuilderRule: properties: action: $ref: '#/components/schemas/RuleBuilderAction' - x-stream-index: "007" + x-stream-index: "006" conditions: items: $ref: '#/components/schemas/RuleBuilderCondition' type: array - x-stream-index: "004" + x-stream-index: "003" cooldown_period: type: string - x-stream-index: "009" - enabled: - type: boolean - x-stream-index: "008" + x-stream-index: "007" groups: items: $ref: '#/components/schemas/RuleBuilderConditionGroup' type: array - x-stream-index: "006" + x-stream-index: "005" id: type: string x-stream-index: "001" logic: type: string - x-stream-index: "005" - name: - type: string - x-stream-index: "002" + x-stream-index: "004" rule_type: type: string - x-stream-index: "003" + x-stream-index: "002" required: - - id - - name - rule_type - action - - enabled type: object SFUIDLastSeen: properties: @@ -7468,18 +7709,23 @@ components: items: type: string type: array - x-stream-index: "004" + x-stream-index: "005" contains_url: type: boolean - x-stream-index: "002" + x-stream-index: "003" harm_labels: items: type: string type: array x-stream-index: "001" + llm_harm_labels: + additionalProperties: + type: string + type: object + x-stream-index: "002" severity: type: string - x-stream-index: "003" + x-stream-index: "004" type: object TextRuleParameters: properties: @@ -7487,18 +7733,23 @@ components: items: type: string type: array - x-stream-index: "006" + x-stream-index: "007" contains_url: type: boolean - x-stream-index: "004" + x-stream-index: "005" harm_labels: items: type: string type: array x-stream-index: "003" + llm_harm_labels: + additionalProperties: + type: string + type: object + x-stream-index: "004" severity: type: string - x-stream-index: "005" + x-stream-index: "006" threshold: format: int32 type: integer @@ -7506,9 +7757,6 @@ components: time_window: type: string x-stream-index: "002" - required: - - threshold - - time_window type: object Thresholds: properties: @@ -7764,7 +8012,7 @@ components: $ref: '#/components/schemas/AIImageConfig' description: Configuration for AI image analysis title: AI Image Config - x-stream-index: "010" + x-stream-index: "011" ai_text_config: $ref: '#/components/schemas/AITextConfig' description: Configuration for AI text analysis @@ -7774,7 +8022,7 @@ components: $ref: '#/components/schemas/AIVideoConfig' description: Configuration for AI video analysis title: AI Video Config - x-stream-index: "011" + x-stream-index: "012" async: description: Whether moderation should be performed asynchronously title: Async @@ -7797,7 +8045,7 @@ components: x-stream-index: "004" aws_rekognition_config: $ref: '#/components/schemas/AIImageConfig' - x-stream-index: "015" + x-stream-index: "016" block_list_config: $ref: '#/components/schemas/BlockListConfig' description: Configuration for block list filtering @@ -7805,23 +8053,28 @@ components: x-stream-index: "007" bodyguard_config: $ref: '#/components/schemas/AITextConfig' - x-stream-index: "014" + x-stream-index: "015" google_vision_config: $ref: '#/components/schemas/GoogleVisionConfig' description: Configuration for Google Vision integration title: Google Vision Config - x-stream-index: "009" + x-stream-index: "010" key: description: Unique identifier for the moderation configuration title: Key type: string x-stream-index: "001" + llm_config: + $ref: '#/components/schemas/LLMConfig' + description: Configuration for customer-configured LLM moderation + title: LLM Config + x-stream-index: "009" rule_builder_config: $ref: '#/components/schemas/RuleBuilderConfig' description: Configuration for custom rule builder (max 3 rules, max 5 conditions per rule) title: Rule Builder Config - x-stream-index: "013" + x-stream-index: "014" team: description: Team associated with the configuration maxLength: 128 @@ -7831,18 +8084,18 @@ components: x-stream-index: "002" user: $ref: '#/components/schemas/UserRequest' - x-stream-index: "017.002" + x-stream-index: "018.002" user_id: type: string - x-stream-index: "017.001" + x-stream-index: "018.001" velocity_filter_config: $ref: '#/components/schemas/VelocityFilterConfig' description: Configuration for velocity-based filtering title: Velocity Filter Config - x-stream-index: "012" + x-stream-index: "013" video_call_rule_config: $ref: '#/components/schemas/VideoCallRuleConfig' - x-stream-index: "016" + x-stream-index: "017" required: - key type: object @@ -7860,6 +8113,69 @@ components: required: - duration type: object + UpsertModerationRuleRequest: + nullable: true + properties: + action: + $ref: '#/components/schemas/RuleBuilderAction' + x-stream-index: "009" + conditions: + items: + $ref: '#/components/schemas/RuleBuilderCondition' + type: array + x-stream-index: "006" + config_keys: + items: + type: string + type: array + x-stream-index: "003" + cooldown_period: + type: string + x-stream-index: "010" + description: + type: string + x-stream-index: "002" + enabled: + type: boolean + x-stream-index: "011" + groups: + items: + $ref: '#/components/schemas/RuleBuilderConditionGroup' + type: array + x-stream-index: "008" + logic: + type: string + x-stream-index: "007" + name: + type: string + x-stream-index: "001" + rule_type: + type: string + x-stream-index: "005" + team: + type: string + x-stream-index: "004" + required: + - name + - rule_type + - action + type: object + UpsertModerationRuleResponse: + description: Basic response information + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "001.001" + rule: + $ref: '#/components/schemas/ModerationRuleV2Response' + x-stream-index: "002" + required: + - duration + title: Response + type: object UpsertModerationTemplateRequest: nullable: true properties: @@ -8006,6 +8322,15 @@ components: type: string x-stream-index: "001" type: object + UserCustomPropertyParameters: + properties: + operator: + type: string + x-stream-index: "002" + property_key: + type: string + x-stream-index: "001" + type: object UserMute: nullable: true properties: @@ -8402,9 +8727,6 @@ components: time_window: type: string x-stream-index: "002" - required: - - threshold - - time_window type: object VideoSettings: properties: @@ -8530,7 +8852,7 @@ components: type: apiKey info: title: Stream API - version: v187.13.0 + version: v191.1.0 openapi: 3.0.3 paths: /api/v2/moderation/ban: @@ -9000,6 +9322,125 @@ paths: summary: Query moderation action logs tags: - product:moderation + /api/v2/moderation/moderation_rule: + post: + description: | + Create or update a moderation rule that can apply app-wide or to specific moderation configs + operationId: upsert_moderation_rule + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpsertModerationRuleRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/UpsertModerationRuleResponse' + 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: Upsert moderation rule + tags: + - product:moderation + /api/v2/moderation/moderation_rule/{id}: + delete: + description: | + Delete an existing moderation rule + operationId: delete_moderation_rule + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteModerationRuleResponse' + 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: Delete moderation rule + tags: + - product:moderation + get: + description: | + Get a specific moderation rule by ID + operationId: get_moderation_rule + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/GetModerationRuleResponse' + 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: Get moderation rule + tags: + - product:moderation + /api/v2/moderation/moderation_rules: + post: + description: | + Search and filter moderation rules across your application. This endpoint is designed for building moderation dashboards and managing multiple rule sets. + operationId: query_moderation_rules + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueryModerationRulesRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/QueryModerationRulesResponse' + description: Successful 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: Query moderation rules + tags: + - product:moderation /api/v2/moderation/mute: post: description: | diff --git a/openapi/serverside-api.json b/openapi/serverside-api.json index f1237f610..abc380bc4 100644 --- a/openapi/serverside-api.json +++ b/openapi/serverside-api.json @@ -1 +1 @@ -{"components":{"schemas":{"AIImageConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"ocr_rules":{"items":{"$ref":"#/components/schemas/OCRRule"},"type":"array","x-stream-index":"004"},"rules":{"items":{"$ref":"#/components/schemas/AWSRekognitionRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules","ocr_rules"],"type":"object"},"AITextConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"profile":{"type":"string","x-stream-index":"003"},"rules":{"items":{"$ref":"#/components/schemas/BodyguardRule"},"type":"array","x-stream-index":"004"},"severity_rules":{"items":{"$ref":"#/components/schemas/BodyguardSeverityRule"},"type":"array","x-stream-index":"005"}},"required":["enabled","profile","rules","severity_rules"],"type":"object"},"AIVideoConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AWSRekognitionRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"APIError":{"nullable":true,"properties":{"StatusCode":{"description":"Response HTTP status code","format":"int32","title":"Status code","type":"integer","x-stream-index":"004"},"code":{"description":"API error code","format":"int32","title":"Code","type":"integer","x-stream-index":"001"},"details":{"description":"Additional error-specific information","items":{"type":"integer"},"title":"Details","type":"array","x-stream-index":"007"},"duration":{"description":"Request duration","title":"Duration","type":"string","x-stream-index":"005"},"exception_fields":{"additionalProperties":{"type":"string"},"description":"Additional error info","title":"Exception fields","type":"object","x-stream-index":"003"},"message":{"description":"Message describing an error","title":"Message","type":"string","x-stream-index":"002"},"more_info":{"description":"URL with additional information","title":"More info","type":"string","x-stream-index":"006"},"unrecoverable":{"description":"Flag that indicates if the error is unrecoverable, requests that return unrecoverable errors should not be retried, this error only applies to the request that caused it","title":"Unrecoverable","type":"boolean","x-stream-index":"008"}},"required":["code","message","StatusCode","duration","more_info","details"],"title":"Error response","type":"object"},"APNConfig":{"properties":{"Disabled":{"type":"boolean","writeOnly":true,"x-stream-index":"005"},"auth_key":{"type":"string","x-stream-index":"006.001"},"auth_type":{"enum":["certificate","token"],"type":"string","x-stream-index":"001"},"bundle_id":{"type":"string","x-stream-index":"004"},"development":{"type":"boolean","x-stream-index":"002"},"host":{"type":"string","x-stream-index":"003"},"key_id":{"type":"string","x-stream-index":"006.002"},"notification_template":{"type":"string","x-stream-index":"008"},"p12_cert":{"type":"string","x-stream-index":"007.001"},"team_id":{"type":"string","x-stream-index":"006.003"}},"type":"object"},"APNConfigFields":{"properties":{"auth_key":{"type":"string","x-stream-index":"009"},"auth_type":{"type":"string","x-stream-index":"003"},"bundle_id":{"type":"string","x-stream-index":"006"},"development":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"host":{"type":"string","x-stream-index":"005"},"key_id":{"type":"string","x-stream-index":"008"},"notification_template":{"type":"string","x-stream-index":"004"},"p12_cert":{"type":"string","x-stream-index":"010"},"team_id":{"type":"string","x-stream-index":"007"}},"required":["enabled","development"],"type":"object"},"APNS":{"properties":{"body":{"type":"string","x-stream-index":"002"},"content-available":{"format":"int32","type":"integer","x-stream-index":"004"},"data":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"mutable-content":{"format":"int32","type":"integer","x-stream-index":"005"},"sound":{"type":"string","x-stream-index":"003"},"title":{"type":"string","x-stream-index":"001"}},"required":["title","body"],"type":"object"},"AWSRekognitionRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"},"min_confidence":{"format":"float","maximum":100,"minimum":0,"type":"number","x-stream-index":"003"}},"required":["label","action","min_confidence"],"type":"object"},"Action":{"nullable":true,"properties":{"name":{"type":"string","x-stream-index":"001"},"style":{"type":"string","x-stream-index":"003"},"text":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"004"},"value":{"type":"string","x-stream-index":"005"}},"required":["name","text","type"],"type":"object"},"ActionLog":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"002"},"reason":{"type":"string","x-stream-index":"008"},"reporter_type":{"type":"string","x-stream-index":"009"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"014"},"review_queue_item_id":{"type":"string","x-stream-index":"012"},"target_user":{"$ref":"#/components/schemas/User","x-stream-index":"013"},"target_user_id":{"type":"string","x-stream-index":"011"},"type":{"type":"string","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007"}},"required":["id","created_at","type","reason","reporter_type","custom","target_user_id","review_queue_item_id"],"type":"object"},"ActionLogResponse":{"nullable":true,"properties":{"created_at":{"description":"Timestamp when the action was taken","format":"date-time","title":"Created At","type":"number","x-stream-index":"002"},"custom":{"additionalProperties":{},"description":"Additional metadata about the action","title":"Custom","type":"object","x-stream-index":"007"},"id":{"description":"Unique identifier of the action log","title":"ID","type":"string","x-stream-index":"001"},"reason":{"description":"Reason for the moderation action","title":"Reason","type":"string","x-stream-index":"006"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"Associated review queue item","title":"Review Queue Item","x-stream-index":"008"},"target_user":{"$ref":"#/components/schemas/UserResponse","description":"User who was the target of the action","title":"Target User","x-stream-index":"009"},"target_user_id":{"description":"ID of the user who was the target of the action","title":"Target User ID","type":"string","x-stream-index":"010"},"type":{"description":"Type of moderation action","title":"Type","type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who performed the action","title":"User","x-stream-index":"004"},"user_id":{"description":"ID of the user who performed the action","title":"User ID","type":"string","x-stream-index":"005"}},"required":["id","created_at","type","user_id","reason","custom","target_user_id"],"type":"object"},"ActionSequence":{"properties":{"action":{"type":"string","x-stream-index":"001"},"blur":{"type":"boolean","x-stream-index":"005"},"cooldown_period":{"format":"int32","type":"integer","x-stream-index":"004"},"threshold":{"format":"int32","type":"integer","x-stream-index":"002"},"time_window":{"format":"int32","type":"integer","x-stream-index":"003"},"warning":{"type":"boolean","x-stream-index":"006"},"warning_text":{"type":"string","x-stream-index":"007"}},"required":["action","threshold","time_window","cooldown_period","blur","warning","warning_text"],"type":"object"},"ActiveCallsFPSStats":{"properties":{"p05":{"format":"float","type":"number","x-stream-index":"001"},"p10":{"format":"float","type":"number","x-stream-index":"002"},"p50":{"format":"float","type":"number","x-stream-index":"003"},"p90":{"format":"float","type":"number","x-stream-index":"004"}},"required":["p05","p10","p50","p90"],"type":"object"},"ActiveCallsLatencyStats":{"properties":{"p50":{"format":"float","type":"number","x-stream-index":"001"},"p90":{"format":"float","type":"number","x-stream-index":"002"}},"required":["p50","p90"],"type":"object"},"ActiveCallsMetrics":{"properties":{"join_call_api":{"$ref":"#/components/schemas/JoinCallAPIMetrics","x-stream-index":"001"},"publishers":{"$ref":"#/components/schemas/PublishersMetrics","x-stream-index":"002"},"subscribers":{"$ref":"#/components/schemas/SubscribersMetrics","x-stream-index":"003"}},"type":"object"},"ActiveCallsSummary":{"properties":{"active_calls":{"format":"int32","type":"integer","x-stream-index":"001"},"active_publishers":{"format":"int32","type":"integer","x-stream-index":"002"},"active_subscribers":{"format":"int32","type":"integer","x-stream-index":"003"},"participants":{"format":"int32","type":"integer","x-stream-index":"004"}},"required":["active_calls","active_publishers","active_subscribers","participants"],"type":"object"},"ActivityMarkedEvent":{"properties":{"all_read":{"type":"boolean","x-stream-index":"006"},"all_seen":{"type":"boolean","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"feed_id":{"type":"string","x-stream-index":"003"},"marked_read":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"marked_watched":{"items":{"type":"string"},"type":"array","x-stream-index":"005"},"type":{"default":"activity.marked","type":"string","x-stream-index":"001.001"},"user_id":{"type":"string","x-stream-index":"002"}},"required":["type","created_at","user_id","feed_id","all_read","all_seen"],"title":"ActivityMarkedEvent","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"},"AnyEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"*","type":"string","x-stream-index":"001.001"}},"required":["type","created_at"],"title":"AnyEvent","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"},"AppResponseFields":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"019"},"async_url_enrich_enabled":{"type":"boolean","x-stream-index":"017"},"auto_translation_enabled":{"type":"boolean","x-stream-index":"020"},"before_message_send_hook_url":{"type":"string","x-stream-index":"021"},"call_types":{"additionalProperties":{"$ref":"#/components/schemas/CallType"},"type":"object","x-stream-index":"007"},"campaign_enabled":{"type":"boolean","x-stream-index":"034"},"cdn_expiration_seconds":{"format":"int32","type":"integer","x-stream-index":"037"},"channel_configs":{"additionalProperties":{"$ref":"#/components/schemas/ChannelConfig"},"type":"object","x-stream-index":"006"},"custom_action_handler_url":{"type":"string","x-stream-index":"022"},"datadog_info":{"$ref":"#/components/schemas/DataDogInfo","x-stream-index":"040"},"disable_auth_checks":{"type":"boolean","x-stream-index":"011"},"disable_permissions_checks":{"type":"boolean","x-stream-index":"012"},"enforce_unique_usernames":{"type":"string","x-stream-index":"023"},"event_hooks":{"items":{"$ref":"#/components/schemas/EventHook"},"type":"array","x-stream-index":"045"},"file_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","x-stream-index":"030"},"geofences":{"items":{"$ref":"#/components/schemas/GeofenceResponse"},"type":"array","x-stream-index":"039"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"033"},"guest_user_creation_disabled":{"type":"boolean","x-stream-index":"043"},"image_moderation_enabled":{"type":"boolean","x-stream-index":"016"},"image_moderation_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"018"},"image_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","x-stream-index":"031"},"moderation_bulk_submit_action_enabled":{"type":"boolean","x-stream-index":"048"},"moderation_dashboard_preferences":{"$ref":"#/components/schemas/ModerationDashboardPreferences","x-stream-index":"044"},"moderation_enabled":{"type":"boolean","x-stream-index":"041"},"moderation_multitenant_blocklist_enabled":{"type":"boolean","x-stream-index":"042"},"moderation_webhook_url":{"type":"string","x-stream-index":"005"},"multi_tenant_enabled":{"type":"boolean","x-stream-index":"015"},"name":{"type":"string","x-stream-index":"001"},"organization":{"type":"string","x-stream-index":"002"},"permission_version":{"type":"string","x-stream-index":"013"},"policies":{"additionalProperties":{"items":{"$ref":"#/components/schemas/Policy"},"type":"array"},"type":"object","x-stream-index":"008"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationFields","x-stream-index":"003"},"reminders_interval":{"format":"int32","type":"integer","x-stream-index":"036"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"032"},"sns_key":{"type":"string","x-stream-index":"028"},"sns_secret":{"type":"string","x-stream-index":"029"},"sns_topic_arn":{"type":"string","x-stream-index":"027"},"sqs_key":{"type":"string","x-stream-index":"025"},"sqs_secret":{"type":"string","x-stream-index":"026"},"sqs_url":{"type":"string","x-stream-index":"024"},"suspended":{"type":"boolean","x-stream-index":"009"},"suspended_explanation":{"type":"string","x-stream-index":"010"},"use_hook_v2":{"type":"boolean","x-stream-index":"046"},"user_response_time_enabled":{"type":"boolean","x-stream-index":"047"},"user_search_disallowed_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"014"},"webhook_events":{"items":{"type":"string"},"type":"array","x-stream-index":"035"},"webhook_url":{"type":"string","x-stream-index":"004"}},"required":["name","organization","push_notifications","webhook_url","moderation_webhook_url","channel_configs","call_types","policies","suspended","suspended_explanation","disable_auth_checks","disable_permissions_checks","permission_version","user_search_disallowed_roles","multi_tenant_enabled","image_moderation_enabled","async_url_enrich_enabled","auto_translation_enabled","custom_action_handler_url","enforce_unique_usernames","sqs_url","sqs_key","sqs_secret","sns_topic_arn","sns_key","sns_secret","file_upload_config","image_upload_config","grants","campaign_enabled","webhook_events","reminders_interval","cdn_expiration_seconds","video_provider","moderation_enabled","moderation_multitenant_blocklist_enabled","guest_user_creation_disabled","event_hooks","use_hook_v2","user_response_time_enabled","moderation_bulk_submit_action_enabled"],"type":"object"},"AsyncBulkImageModerationEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"003.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.007"},"finished_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.004"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"task_id":{"type":"string","x-stream-index":"002.001"},"type":{"default":"export.bulk_image_moderation.success","type":"string","x-stream-index":"003.002"},"url":{"type":"string","x-stream-index":"001"}},"required":["url","task_id","started_at","finished_at","type","created_at","custom"],"title":"AsyncBulkImageModerationEvent","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"},"AsyncExportChannelsEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"003.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.007"},"finished_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.004"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"task_id":{"type":"string","x-stream-index":"002.001"},"type":{"default":"export.channels.success","type":"string","x-stream-index":"003.002"},"url":{"type":"string","x-stream-index":"001"}},"required":["url","task_id","started_at","finished_at","type","created_at","custom"],"title":"AsyncExportChannelsEvent","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"},"AsyncExportErrorEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"003.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.007"},"error":{"type":"string","x-stream-index":"001"},"finished_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.004"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"task_id":{"type":"string","x-stream-index":"002.001"},"type":{"default":"export.users.error","type":"string","x-stream-index":"003.002"}},"required":["error","task_id","started_at","finished_at","type","created_at","custom"],"title":"AsyncExportErrorEvent","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"},"AsyncExportModerationLogsEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"003.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.007"},"finished_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.004"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"task_id":{"type":"string","x-stream-index":"002.001"},"type":{"default":"export.moderation_logs.success","type":"string","x-stream-index":"003.002"},"url":{"type":"string","x-stream-index":"001"}},"required":["url","task_id","started_at","finished_at","type","created_at","custom"],"title":"AsyncExportModerationLogsEvent","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"},"AsyncExportUsersEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"003.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.007"},"finished_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.004"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"task_id":{"type":"string","x-stream-index":"002.001"},"type":{"default":"export.users.success","type":"string","x-stream-index":"003.002"},"url":{"type":"string","x-stream-index":"001"}},"required":["url","task_id","started_at","finished_at","type","created_at","custom"],"title":"AsyncExportUsersEvent","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"},"AsyncModerationCallbackConfig":{"properties":{"mode":{"enum":["CALLBACK_MODE_NONE","CALLBACK_MODE_REST","CALLBACK_MODE_TWIRP"],"type":"string","x-stream-index":"002"},"server_url":{"type":"string","x-stream-index":"001"}},"type":"object"},"AsyncModerationConfiguration":{"properties":{"callback":{"$ref":"#/components/schemas/AsyncModerationCallbackConfig","x-stream-index":"002"},"timeout_ms":{"format":"int32","type":"integer","x-stream-index":"001"}},"type":"object"},"Attachment":{"description":"An attachment is a message object that represents a file uploaded by a user.","nullable":true,"properties":{"actions":{"items":{"$ref":"#/components/schemas/Action"},"type":"array","x-stream-index":"015"},"asset_url":{"type":"string","x-stream-index":"017"},"author_icon":{"type":"string","x-stream-index":"007"},"author_link":{"type":"string","x-stream-index":"006"},"author_name":{"type":"string","x-stream-index":"005"},"color":{"type":"string","x-stream-index":"003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"018"},"fallback":{"type":"string","x-stream-index":"002"},"fields":{"items":{"$ref":"#/components/schemas/Field"},"type":"array","x-stream-index":"016"},"footer":{"type":"string","x-stream-index":"013"},"footer_icon":{"type":"string","x-stream-index":"014"},"giphy":{"$ref":"#/components/schemas/Images","x-stream-index":"019"},"image_url":{"type":"string","x-stream-index":"011"},"og_scrape_url":{"type":"string","x-stream-index":"020"},"original_height":{"format":"int32","type":"integer","x-stream-index":"022"},"original_width":{"format":"int32","type":"integer","x-stream-index":"021"},"pretext":{"type":"string","x-stream-index":"004"},"text":{"type":"string","x-stream-index":"010"},"thumb_url":{"type":"string","x-stream-index":"012"},"title":{"type":"string","x-stream-index":"008"},"title_link":{"type":"string","x-stream-index":"009"},"type":{"description":"Attachment type (e.g. image, video, url)","title":"Type","type":"string","x-stream-index":"001"}},"required":["custom"],"title":"Attachment","type":"object","x-stream-docs-page-id":"file_uploads"},"AudioSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"001"},"default_device":{"enum":["speaker","earpiece"],"type":"string","x-stream-index":"006"},"mic_default_on":{"type":"boolean","x-stream-index":"004"},"noise_cancellation":{"$ref":"#/components/schemas/NoiseCancellationSettings","x-stream-index":"007"},"opus_dtx_enabled":{"type":"boolean","x-stream-index":"002"},"redundant_coding_enabled":{"type":"boolean","x-stream-index":"003"},"speaker_default_on":{"type":"boolean","x-stream-index":"005"}},"required":["access_request_enabled","opus_dtx_enabled","redundant_coding_enabled","mic_default_on","speaker_default_on","default_device"],"type":"object"},"AudioSettingsRequest":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"001"},"default_device":{"enum":["speaker","earpiece"],"type":"string","x-stream-index":"006"},"mic_default_on":{"type":"boolean","x-stream-index":"004"},"noise_cancellation":{"$ref":"#/components/schemas/NoiseCancellationSettings","x-stream-index":"007"},"opus_dtx_enabled":{"type":"boolean","x-stream-index":"002"},"redundant_coding_enabled":{"type":"boolean","x-stream-index":"003"},"speaker_default_on":{"type":"boolean","x-stream-index":"005"}},"required":["default_device"],"type":"object"},"AudioSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"001"},"default_device":{"enum":["speaker","earpiece"],"type":"string","x-stream-index":"006"},"mic_default_on":{"type":"boolean","x-stream-index":"004"},"noise_cancellation":{"$ref":"#/components/schemas/NoiseCancellationSettings","x-stream-index":"007"},"opus_dtx_enabled":{"type":"boolean","x-stream-index":"002"},"redundant_coding_enabled":{"type":"boolean","x-stream-index":"003"},"speaker_default_on":{"type":"boolean","x-stream-index":"005"}},"required":["access_request_enabled","opus_dtx_enabled","redundant_coding_enabled","mic_default_on","speaker_default_on","default_device"],"type":"object"},"AutomodDetails":{"properties":{"action":{"type":"string","x-stream-index":"001"},"image_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"005"},"message_details":{"$ref":"#/components/schemas/FlagMessageDetails","x-stream-index":"004"},"original_message_type":{"type":"string","x-stream-index":"002"},"result":{"$ref":"#/components/schemas/MessageModerationResult","x-stream-index":"003"}},"type":"object"},"AutomodPlatformCircumventionConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AutomodRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"AutomodRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"003"},"label":{"type":"string","x-stream-index":"001"},"threshold":{"format":"float","maximum":1,"minimum":0,"type":"number","x-stream-index":"002"}},"required":["label","threshold","action"],"type":"object"},"AutomodSemanticFiltersConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AutomodSemanticFiltersRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"AutomodSemanticFiltersRule":{"properties":{"action":{"enum":["flag","shadow","remove"],"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"threshold":{"format":"float","maximum":1,"minimum":0,"type":"number","x-stream-index":"002"}},"required":["name","threshold","action"],"type":"object"},"AutomodToxicityConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AutomodRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"AzureRequest":{"description":"Config for creating Azure Blob Storage storage","properties":{"abs_account_name":{"description":"The account name","title":"AccountName","type":"string","x-stream-index":"001"},"abs_client_id":{"description":"The client id","title":"ClientID","type":"string","x-stream-index":"003"},"abs_client_secret":{"description":"The client secret","title":"ClientSecret","type":"string","x-stream-index":"004"},"abs_tenant_id":{"description":"The tenant id","title":"TenantID","type":"string","x-stream-index":"002"}},"required":["abs_account_name","abs_tenant_id","abs_client_id","abs_client_secret"],"title":"AzureRequest","type":"object"},"BackstageSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"BackstageSettingsRequest":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"002"}},"type":"object"},"BackstageSettingsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"Ban":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"012"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"011"},"expires":{"format":"date-time","type":"number","x-stream-index":"007"},"reason":{"type":"string","x-stream-index":"008"},"shadow":{"type":"boolean","x-stream-index":"009"},"target":{"$ref":"#/components/schemas/User","x-stream-index":"006"}},"required":["shadow","created_at"],"type":"object"},"BanActionRequest":{"properties":{"channel_ban_only":{"type":"boolean","x-stream-index":"003"},"delete_messages":{"enum":["soft","pruning","hard"],"type":"string","x-stream-index":"005"},"ip_ban":{"type":"boolean","x-stream-index":"004"},"reason":{"type":"string","x-stream-index":"002"},"shadow":{"type":"boolean","x-stream-index":"001"},"timeout":{"format":"int32","type":"integer","x-stream-index":"006"}},"type":"object"},"BanOptions":{"properties":{"duration":{"format":"int32","type":"integer","x-stream-index":"001"},"ip_ban":{"type":"boolean","x-stream-index":"004"},"reason":{"type":"string","x-stream-index":"002"},"shadow_ban":{"type":"boolean","x-stream-index":"003"}},"required":["duration","reason","shadow_ban","ip_ban"],"type":"object"},"BanRequest":{"nullable":true,"properties":{"banned_by":{"$ref":"#/components/schemas/UserRequest","description":"Details about the user performing the ban","title":"Banned By","x-stream-index":"008"},"banned_by_id":{"description":"ID of the user performing the ban","title":"Banned By ID","type":"string","x-stream-index":"007"},"channel_cid":{"description":"Channel where the ban applies","title":"Channel CID","type":"string","x-stream-index":"004"},"delete_messages":{"enum":["soft","pruning","hard"],"type":"string","x-stream-index":"009"},"ip_ban":{"description":"Whether to ban the user's IP address","title":"IP Ban","type":"boolean","x-stream-index":"006"},"reason":{"description":"Optional explanation for the ban","title":"Reason","type":"string","x-stream-index":"003"},"shadow":{"description":"Whether this is a shadow ban","title":"Shadow","type":"boolean","x-stream-index":"005"},"target_user_id":{"description":"ID of the user to ban","title":"Target User ID","type":"string","x-stream-index":"001"},"timeout":{"description":"Duration of the ban in minutes","minimum":0,"title":"Timeout","type":"integer","x-stream-index":"002"}},"required":["target_user_id"],"type":"object"},"BanResponse":{"nullable":true,"properties":{"banned_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"006"},"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"expires":{"format":"date-time","type":"number","x-stream-index":"003"},"reason":{"type":"string","x-stream-index":"004"},"shadow":{"type":"boolean","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"}},"required":["created_at"],"type":"object"},"BlockContentOptions":{"properties":{"reason":{"type":"string","x-stream-index":"001"}},"required":["reason"],"type":"object"},"BlockListConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/BlockListRule"},"maximum":10,"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"BlockListOptions":{"properties":{"behavior":{"description":"Blocklist behavior","enum":["flag","block","shadow_block"],"title":"Behavior","type":"string","x-stream-index":"002"},"blocklist":{"description":"Blocklist name","title":"Blocklist","type":"string","x-stream-index":"001"}},"required":["blocklist","behavior"],"type":"object"},"BlockListResponse":{"description":"Block list contains restricted words","properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001"},"id":{"type":"string","x-stream-index":"003"},"name":{"description":"Block list name","title":"Name","type":"string","x-stream-index":"004"},"team":{"type":"string","x-stream-index":"007"},"type":{"description":"Block list type.","title":"Type","type":"string","x-stream-index":"005"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"002"},"words":{"description":"List of words to block","items":{"type":"string"},"title":"Words","type":"array","x-stream-index":"006"}},"required":["name","type","words"],"title":"Block list","type":"object","x-stream-docs-page-id":"block_lists"},"BlockListRule":{"properties":{"action":{"enum":["flag","mask_flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"002"}},"required":["name","team","action"],"type":"object"},"BlockUserRequest":{"description":"BlockUserRequest is the payload for blocking a user.","nullable":true,"properties":{"user_id":{"description":"the user to block","title":"UserID","type":"string","x-stream-index":"003"}},"required":["user_id"],"title":"BlockUserRequest","type":"object"},"BlockUserResponse":{"description":"BlockUserResponse is the payload for blocking a user.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"BlockUserResponse","type":"object"},"BlockUsersRequest":{"nullable":true,"properties":{"blocked_user_id":{"description":"User id to block","title":"BlockedUserID","type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"required":["blocked_user_id"],"type":"object"},"BlockUsersResponse":{"nullable":true,"properties":{"blocked_by_user_id":{"description":"User id who blocked another user","title":"BlockedByUserID","type":"string","x-stream-index":"002"},"blocked_user_id":{"description":"User id who got blocked","title":"BlockedUserID","type":"string","x-stream-index":"003"},"created_at":{"description":"Timestamp when the user was blocked","format":"date-time","title":"CreatedAt","type":"number","x-stream-index":"004"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration","blocked_by_user_id","blocked_user_id","created_at"],"type":"object"},"BlockedUserEvent":{"description":"This event is sent to call participants to notify when a user is blocked on a call, clients can use this event to show a notification.\nIf the user is the current user, the client should leave the call screen as well","properties":{"blocked_by_user":{"$ref":"#/components/schemas/UserResponse","description":"The user that blocked the user, null if the user was blocked by server-side","title":"Blocked by","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.blocked_user","description":"The type of event: \"call.blocked_user\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user that was blocked","title":"User","x-stream-index":"003"}},"required":["type","created_at","call_cid","user"],"title":"BlockedUserEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"BlockedUserResponse":{"nullable":true,"properties":{"blocked_user":{"$ref":"#/components/schemas/UserResponse","description":"User who got blocked","title":"User","x-stream-index":"003"},"blocked_user_id":{"description":"ID of the user who got blocked","title":"UserID","type":"string","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who blocked another user","title":"User","x-stream-index":"001"},"user_id":{"description":"ID of the user who blocked another user","title":"UserID","type":"string","x-stream-index":"002"}},"required":["user","user_id","blocked_user","blocked_user_id","created_at"],"type":"object"},"BodyguardRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"},"severity_rules":{"items":{"$ref":"#/components/schemas/BodyguardSeverityRule"},"type":"array","x-stream-index":"003"}},"required":["label","action","severity_rules"],"type":"object"},"BodyguardSeverityRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"severity":{"enum":["low","medium","high","critical"],"type":"string","x-stream-index":"001"}},"required":["severity","action"],"type":"object"},"Bound":{"properties":{"inclusive":{"type":"boolean","x-stream-index":"002"},"value":{"format":"float","type":"number","x-stream-index":"001"}},"required":["value","inclusive"],"type":"object"},"BroadcastSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettings","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettings","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"BroadcastSettingsRequest":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettingsRequest","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettingsRequest","x-stream-index":"003"}},"type":"object"},"BroadcastSettingsResponse":{"description":"BroadcastSettingsResponse is the payload for broadcasting settings","properties":{"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettingsResponse","title":"HLS","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettingsResponse","title":"RTMP","x-stream-index":"003"}},"required":["enabled","hls","rtmp"],"title":"BroadcastSettingsResponse","type":"object"},"BrowserDataResponse":{"properties":{"name":{"type":"string","x-stream-index":"001"},"version":{"type":"string","x-stream-index":"002"}},"type":"object"},"BulkImageModerationRequest":{"nullable":true,"properties":{"csv_file":{"description":"URL to CSV file containing image URLs to moderate","title":"string","type":"string","x-stream-index":"001"}},"required":["csv_file"],"type":"object"},"BulkImageModerationResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"task_id":{"description":"ID of the task for processing the bulk image moderation","title":"string","type":"string","x-stream-index":"001"}},"required":["task_id","duration"],"type":"object"},"Call":{"properties":{"AppPK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"002"},"Backstage":{"type":"boolean","writeOnly":true,"x-stream-index":"023"},"BlockedUserIDs":{"items":{"type":"string"},"type":"array","writeOnly":true,"x-stream-index":"018"},"BlockedUsers":{"items":{"$ref":"#/components/schemas/User"},"type":"array","writeOnly":true,"x-stream-index":"019"},"CID":{"type":"string","writeOnly":true,"x-stream-index":"005"},"CallType":{"$ref":"#/components/schemas/CallType","x-stream-index":"020"},"ChannelCID":{"type":"string","writeOnly":true,"x-stream-index":"032"},"CreatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"013"},"CreatedBy":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"CreatedByUserID":{"type":"string","writeOnly":true,"x-stream-index":"007"},"CurrentSessionID":{"type":"string","writeOnly":true,"x-stream-index":"024"},"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"012"},"DeletedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"028"},"EgressUpdatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"027"},"Egresses":{"items":{"$ref":"#/components/schemas/CallEgress"},"type":"array","writeOnly":true,"x-stream-index":"015"},"EndedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"017"},"ID":{"type":"string","writeOnly":true,"x-stream-index":"004"},"JoinAheadTimeSeconds":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"031"},"LastHeartbeatAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"030"},"LastSessionID":{"type":"string","writeOnly":true,"x-stream-index":"025"},"MemberCount":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"010"},"MemberLookup":{"$ref":"#/components/schemas/MemberLookup","x-stream-index":"011"},"Members":{"items":{"$ref":"#/components/schemas/CallMember"},"type":"array","writeOnly":true,"x-stream-index":"009"},"Session":{"$ref":"#/components/schemas/CallSession","x-stream-index":"026"},"Settings":{"$ref":"#/components/schemas/CallSettings","x-stream-index":"022"},"SettingsOverrides":{"$ref":"#/components/schemas/CallSettings","x-stream-index":"021"},"StartsAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"016"},"Team":{"type":"string","writeOnly":true,"x-stream-index":"006"},"ThumbnailURL":{"type":"string","writeOnly":true,"x-stream-index":"029"},"Type":{"type":"string","writeOnly":true,"x-stream-index":"003"},"UpdatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"014"}},"required":["AppPK","Type","ID","CID","Team","CreatedByUserID","Members","Custom","CreatedAt","UpdatedAt","Egresses","BlockedUserIDs","BlockedUsers","Backstage","CurrentSessionID","LastSessionID","ThumbnailURL","ChannelCID"],"type":"object"},"CallAcceptedEvent":{"description":"This event is sent when a user accepts a notification to join a call.","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.accepted","description":"The type of event: \"call.accepted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who accepted the call","title":"User","x-stream-index":"004"}},"required":["type","created_at","call_cid","call","user"],"title":"CallAcceptedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallClosedCaption":{"description":"CallClosedCaption represents a closed caption of a call.","properties":{"end_time":{"format":"date-time","title":"The end time of the closed caption.","type":"number","x-stream-index":"003"},"speaker_id":{"title":"The speaker ID of the closed caption.","type":"string","x-stream-index":"004"},"start_time":{"format":"date-time","title":"The start time of the closed caption.","type":"number","x-stream-index":"002"},"text":{"title":"The text of the closed caption.","type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserResponse","title":"The full user for the closed caption.","x-stream-index":"005"}},"required":["text","start_time","end_time","speaker_id","user"],"title":"CallClosedCaption","type":"object"},"CallClosedCaptionsFailedEvent":{"description":"This event is sent when call closed captions has failed","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.closed_captions_failed","description":"The type of event: \"call.closed_captions_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallClosedCaptionsFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallClosedCaptionsStartedEvent":{"description":"This event is sent when call closed caption has started","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.closed_captions_started","description":"The type of event: \"call.closed_captions_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallClosedCaptionsStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallClosedCaptionsStoppedEvent":{"description":"This event is sent when call closed captions has stopped","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.closed_captions_stopped","description":"The type of event: \"call.transcription_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallClosedCaptionsStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallCreatedEvent":{"description":"This event is sent when a call is created. Clients receiving this event should check if the ringing\nfield is set to true and if so, show the call screen","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"the members added to this call","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"004"},"type":{"default":"call.created","description":"The type of event: \"call.created\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","members"],"title":"CallCreatedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallDeletedEvent":{"description":"This event is sent when a call is deleted. Clients receiving this event should leave the call screen","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.deleted","description":"The type of event: \"call.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call"],"title":"CallDeletedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallDurationReport":{"properties":{"histogram":{"items":{"$ref":"#/components/schemas/ReportByHistogramBucket"},"type":"array","x-stream-index":"001"}},"required":["histogram"],"type":"object"},"CallDurationReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateCallDurationReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"CallEgress":{"nullable":true,"properties":{"app_pk":{"format":"int32","type":"integer","x-stream-index":"002"},"call_id":{"type":"string","x-stream-index":"004"},"call_type":{"type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/EgressTaskConfig","x-stream-index":"007"},"egress_id":{"type":"string","x-stream-index":"005"},"egress_type":{"type":"string","x-stream-index":"006"},"instance_ip":{"type":"string","x-stream-index":"008"},"started_at":{"format":"date-time","type":"number","x-stream-index":"010"},"state":{"type":"string","x-stream-index":"009"},"stopped_at":{"format":"date-time","type":"number","x-stream-index":"011"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"012"}},"required":["app_pk","call_type","call_id","egress_id","egress_type","instance_ip","state","started_at","updated_at"],"type":"object"},"CallEndedEvent":{"description":"This event is sent when a call is mark as ended for all its participants. Clients receiving this event should leave the call screen","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"reason":{"description":"The reason why the call ended, if available","title":"CallEndedReason","type":"string","x-stream-index":"005"},"type":{"default":"call.ended","description":"The type of event: \"call.ended\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who ended the call, null if the call was ended by the server","title":"User","x-stream-index":"004"}},"required":["type","created_at","call_cid","call"],"title":"CallEndedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallFrameRecordingFailedEvent":{"description":"This event is sent when frame recording has failed","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.frame_recording_failed","description":"The type of event: \"call.frame_recording_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","egress_id"],"title":"CallFrameRecordingFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallFrameRecordingFrameReadyEvent":{"description":"This event is sent when a frame is captured from a call","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"captured_at":{"description":"The time the frame was captured","format":"date-time","title":"CapturedAt","type":"number","x-stream-index":"006"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"008"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"track_type":{"description":"The type of the track frame was captured from (TRACK_TYPE_VIDEO|TRACK_TYPE_SCREEN_SHARE)","title":"TrackType","type":"string","x-stream-index":"004"},"type":{"default":"call.frame_recording_ready","description":"The type of event: \"call.frame_recording_ready\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"url":{"description":"The URL of the frame","title":"URL","type":"string","x-stream-index":"005"},"users":{"additionalProperties":{"$ref":"#/components/schemas/UserResponse"},"description":"The users in the frame","title":"Users","type":"object","x-stream-index":"007"}},"required":["type","created_at","call_cid","session_id","track_type","url","captured_at","users","egress_id"],"title":"CallFrameRecordingFrameReadyEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallFrameRecordingStartedEvent":{"description":"This event is sent when frame recording has started","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.frame_recording_started","description":"The type of event: \"call.frame_recording_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","egress_id"],"title":"CallFrameRecordingStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallFrameRecordingStoppedEvent":{"description":"This event is sent when frame recording has stopped","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.frame_recording_stopped","description":"The type of event: \"call.frame_recording_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","egress_id"],"title":"CallFrameRecordingStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallHLSBroadcastingFailedEvent":{"description":"This event is sent when HLS broadcasting has failed","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.hls_broadcasting_failed","description":"The type of event: \"call.hls_broadcasting_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallHLSBroadcastingFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallHLSBroadcastingStartedEvent":{"description":"This event is sent when HLS broadcasting has started","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"hls_playlist_url":{"type":"string","x-stream-index":"004"},"type":{"default":"call.hls_broadcasting_started","description":"The type of event: \"call.hls_broadcasting_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","hls_playlist_url"],"title":"CallHLSBroadcastingStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallHLSBroadcastingStoppedEvent":{"description":"This event is sent when HLS broadcasting has stopped","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.hls_broadcasting_stopped","description":"The type of event: \"call.hls_broadcasting_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallHLSBroadcastingStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallIngressResponse":{"description":"CallIngressResponse is the payload for ingress settings","properties":{"rtmp":{"$ref":"#/components/schemas/RTMPIngress","title":"RTMP","x-stream-index":"001"}},"required":["rtmp"],"title":"CallIngressResponse","type":"object"},"CallLiveStartedEvent":{"description":"This event is sent when a call is started. Clients receiving this event should start the call.","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.live_started","description":"The type of event: \"call.live_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call"],"title":"CallLiveStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMember":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"010"},"role":{"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["user_id","role","custom","created_at","updated_at"],"type":"object"},"CallMemberAddedEvent":{"description":"This event is sent when one or more members are added to a call","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"the members added to this call","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"004"},"type":{"default":"call.member_added","description":"The type of event: \"call.member_added\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","members"],"title":"CallMemberAddedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMemberRemovedEvent":{"description":"This event is sent when one or more members are removed from a call","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"the list of member IDs removed from the call","items":{"type":"string"},"title":"Members","type":"array","x-stream-index":"004"},"type":{"default":"call.member_removed","description":"The type of event: \"call.member_removed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","members"],"title":"CallMemberRemovedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMemberUpdatedEvent":{"description":"This event is sent when one or more members are updated","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"The list of members that were updated","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"004"},"type":{"default":"call.member_updated","description":"The type of event: \"call.member_updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","members"],"title":"CallMemberUpdatedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMemberUpdatedPermissionEvent":{"description":"This event is sent when one or more members get its role updated","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"capabilities_by_role":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"The capabilities by role for this call","title":"CapabilitiesByRole","type":"object","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"The list of members that were updated","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"005"},"type":{"default":"call.member_updated_permission","description":"The type of event: \"call.member_added\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","capabilities_by_role","members"],"title":"CallMemberUpdatedPermissionEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMissedEvent":{"description":"This event is sent to call members who did not accept/reject/join the call to notify they missed the call","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"List of members who missed the call","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"005"},"notify_user":{"type":"boolean","x-stream-index":"007"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.missed","description":"The type of event: \"call.notification\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The caller from whom the call was missed","title":"User","x-stream-index":"006"}},"required":["type","created_at","call_cid","session_id","call","members","user","notify_user"],"title":"CallMissedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallModerationBlurEvent":{"properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"type":{"default":"call.moderation_blur","type":"string","x-stream-index":"001.001"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["type","created_at","call_cid","user_id","custom"],"title":"CallModerationBlurEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallModerationWarningEvent":{"properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"message":{"type":"string","x-stream-index":"004"},"type":{"default":"call.moderation_warning","type":"string","x-stream-index":"001.001"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["type","created_at","call_cid","user_id","message","custom"],"title":"CallModerationWarningEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallNotificationEvent":{"description":"This event is sent to all call members to notify they are getting called","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"Call members","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"005"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.notification","description":"The type of event: \"call.notification\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user that sent the call notification","title":"User","x-stream-index":"006"}},"required":["type","created_at","call_cid","session_id","call","members","user"],"title":"CallNotificationEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallParticipant":{"nullable":true,"properties":{"JoinedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"004"},"Role":{"type":"string","writeOnly":true,"x-stream-index":"002"},"UserSessionID":{"type":"string","writeOnly":true,"x-stream-index":"003"},"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"001.046"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"001.017"},"banned":{"type":"boolean","x-stream-index":"001.016"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.013"},"id":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"001.023"},"language":{"type":"string","x-stream-index":"001.035"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"001.022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"001.026"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.042"},"role":{"type":"string","x-stream-index":"001.004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.005"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.009"}},"required":["id","role","teams_role","custom","banned","online","Role","UserSessionID","JoinedAt"],"type":"object"},"CallParticipantCountReport":{"properties":{"histogram":{"items":{"$ref":"#/components/schemas/ReportByHistogramBucket"},"type":"array","x-stream-index":"001"}},"required":["histogram"],"type":"object"},"CallParticipantCountReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateCallParticipantCountReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"CallParticipantResponse":{"properties":{"joined_at":{"format":"date-time","type":"number","x-stream-index":"004"},"role":{"type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"},"user_session_id":{"type":"string","x-stream-index":"002"}},"required":["user","user_session_id","role","joined_at"],"type":"object"},"CallReactionEvent":{"description":"This event is sent when a reaction is sent in a call, clients should use this to show the reaction in the call screen","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"reaction":{"$ref":"#/components/schemas/ReactionResponse","description":"the reaction object sent by the user on the call","title":"reaction","x-stream-index":"003"},"type":{"default":"call.reaction_new","description":"The type of event: \"call.reaction_new\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","reaction"],"title":"CallReactionEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRecording":{"description":"CallRecording represents a recording of a call.","properties":{"end_time":{"format":"date-time","title":"The end time of the recording.","type":"number","x-stream-index":"004"},"filename":{"title":"The filename of the recording.","type":"string","x-stream-index":"001"},"session_id":{"title":"The session ID of the recording.","type":"string","x-stream-index":"005"},"start_time":{"format":"date-time","title":"The start time of the recording.","type":"number","x-stream-index":"003"},"url":{"title":"The URL of the recording.","type":"string","x-stream-index":"002"}},"required":["filename","url","start_time","end_time","session_id"],"title":"CallRecording","type":"object"},"CallRecordingFailedEvent":{"description":"This event is sent when call recording has failed","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"003"},"type":{"default":"call.recording_failed","description":"The type of event: \"call.recording_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","egress_id"],"title":"CallRecordingFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRecordingReadyEvent":{"description":"This event is sent when call recording is ready","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"call_recording":{"$ref":"#/components/schemas/CallRecording","description":"The call recording object","title":"CallRecording","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.recording_ready","description":"The type of event: \"call.recording_ready\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call_recording","egress_id"],"title":"CallRecordingReadyEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRecordingStartedEvent":{"description":"This event is sent when call recording has started","properties":{"call_cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"egress_id":{"type":"string","x-stream-index":"001"},"type":{"default":"call.recording_started","description":"The type of event: \"call.recording_started\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001"}},"required":["egress_id","type","created_at","call_cid"],"title":"CallRecordingStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRecordingStoppedEvent":{"description":"This event is sent when call recording has stopped","properties":{"call_cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"egress_id":{"type":"string","x-stream-index":"001"},"type":{"default":"call.recording_stopped","description":"The type of event: \"call.recording_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001"}},"required":["egress_id","type","created_at","call_cid"],"title":"CallRecordingStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRejectedEvent":{"description":"This event is sent when a user rejects a notification to join a call.","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"reason":{"description":"Provides information about why the call was rejected. You can provide any value, but the Stream API and SDKs use these default values: rejected, cancel, timeout and busy","title":"Reason","type":"string","x-stream-index":"005"},"type":{"default":"call.rejected","description":"The type of event: \"call.rejected\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who rejected the call","title":"User","x-stream-index":"004"}},"required":["type","created_at","call_cid","call","user"],"title":"CallRejectedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallReportResponse":{"properties":{"ended_at":{"format":"date-time","type":"number","x-stream-index":"003"},"score":{"format":"float","type":"number","x-stream-index":"001"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002"}},"required":["score"],"type":"object"},"CallRequest":{"description":"CallRequest is the payload for creating a call.","properties":{"channel_cid":{"type":"string","x-stream-index":"009"},"created_by":{"$ref":"#/components/schemas/UserRequest","title":"The user that create this call","x-stream-index":"002"},"created_by_id":{"title":"The id of the user that create this call","type":"string","x-stream-index":"003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"members":{"items":{"$ref":"#/components/schemas/MemberRequest"},"maximum":100,"type":"array","x-stream-index":"005"},"settings_override":{"$ref":"#/components/schemas/CallSettingsRequest","x-stream-index":"006"},"starts_at":{"format":"date-time","type":"number","x-stream-index":"007"},"team":{"type":"string","x-stream-index":"001"},"video":{"type":"boolean","x-stream-index":"008"}},"title":"CallRequest","type":"object"},"CallResponse":{"description":"Represents a call","properties":{"backstage":{"type":"boolean","x-stream-index":"016"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"018"},"captioning":{"type":"boolean","x-stream-index":"013"},"channel_cid":{"type":"string","x-stream-index":"024"},"cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"The user that created the call","title":"Created By","x-stream-index":"007"},"current_session_id":{"type":"string","x-stream-index":"005"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"008"},"egress":{"$ref":"#/components/schemas/EgressResponse","x-stream-index":"021"},"ended_at":{"description":"Date/time when the call ended","format":"date-time","title":"Ended At","type":"number","x-stream-index":"014"},"id":{"description":"Call ID","title":"ID","type":"string","x-stream-index":"003"},"ingress":{"$ref":"#/components/schemas/CallIngressResponse","x-stream-index":"019"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"023"},"recording":{"type":"boolean","x-stream-index":"011"},"session":{"$ref":"#/components/schemas/CallSessionResponse","x-stream-index":"020"},"settings":{"$ref":"#/components/schemas/CallSettingsResponse","x-stream-index":"017"},"starts_at":{"description":"Date/time when the call will start","format":"date-time","title":"Starts At","type":"number","x-stream-index":"015"},"team":{"type":"string","x-stream-index":"006"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailResponse","x-stream-index":"022"},"transcribing":{"type":"boolean","x-stream-index":"012"},"type":{"description":"The type of call","title":"Type","type":"string","x-stream-index":"002"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"}},"required":["type","id","cid","current_session_id","created_by","custom","created_at","updated_at","recording","transcribing","captioning","backstage","settings","blocked_user_ids","ingress","egress"],"title":"CallResponse","type":"object"},"CallRingEvent":{"description":"This event is sent to all call members to notify they are getting called","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"005"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"Call members","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"006"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.ring","description":"The type of event: \"call.notification\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user that sent the call notification","title":"User","x-stream-index":"007"},"video":{"type":"boolean","x-stream-index":"008"}},"required":["type","created_at","call_cid","session_id","call","members","user","video"],"title":"CallRingEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRtmpBroadcastFailedEvent":{"description":"This event is sent when a call RTMP broadcast has failed","properties":{"call_cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"002.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.002"},"name":{"description":"Name of the given RTMP broadcast","title":"Name","type":"string","x-stream-index":"003"},"type":{"default":"call.rtmp_broadcast_failed","description":"The type of event: \"call.rtmp_broadcast_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","name"],"title":"CallRtmpBroadcastFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRtmpBroadcastStartedEvent":{"description":"This event is sent when RTMP broadcast has started","properties":{"call_cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"002.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.002"},"name":{"description":"Name of the given RTMP broadcast","title":"Name","type":"string","x-stream-index":"003"},"type":{"default":"call.rtmp_broadcast_started","description":"The type of event: \"call.rtmp_broadcast_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","name"],"title":"CallRtmpBroadcastStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRtmpBroadcastStoppedEvent":{"description":"This event is sent when RTMP broadcast has stopped","properties":{"call_cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"002.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.002"},"name":{"description":"Name of the given RTMP broadcast","title":"Name","type":"string","x-stream-index":"003"},"type":{"default":"call.rtmp_broadcast_stopped","description":"The type of event: \"call.rtmp_broadcast_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","name"],"title":"CallRtmpBroadcastStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSession":{"properties":{"AcceptedBy":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","writeOnly":true,"x-stream-index":"008"},"ActiveSFUs":{"items":{"$ref":"#/components/schemas/SFUIDLastSeen"},"type":"array","writeOnly":true,"x-stream-index":"016"},"AnonymousParticipantCount":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"019"},"AppPK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"002.001"},"CallID":{"type":"string","writeOnly":true,"x-stream-index":"002.003"},"CallType":{"type":"string","writeOnly":true,"x-stream-index":"002.002"},"CreatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"003"},"DeletedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"004"},"EndedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"006"},"LiveEndedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"013"},"LiveStartedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"012"},"MissedBy":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","writeOnly":true,"x-stream-index":"010"},"Participants":{"items":{"$ref":"#/components/schemas/CallParticipant"},"type":"array","writeOnly":true,"x-stream-index":"011"},"ParticipantsCountByRole":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","writeOnly":true,"x-stream-index":"018"},"RejectedBy":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","writeOnly":true,"x-stream-index":"009"},"RingAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"007"},"SFUIDs":{"items":{"type":"string"},"type":"array","writeOnly":true,"x-stream-index":"015"},"SessionID":{"type":"string","writeOnly":true,"x-stream-index":"002.004"},"StartedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"005"},"TimerEndsAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"014"},"UserPermissionOverrides":{"additionalProperties":{"additionalProperties":{"type":"boolean"},"type":"object"},"type":"object","writeOnly":true,"x-stream-index":"017"}},"required":["AppPK","CallType","CallID","SessionID","CreatedAt","AcceptedBy","RejectedBy","MissedBy","Participants","SFUIDs","ActiveSFUs","UserPermissionOverrides","ParticipantsCountByRole","AnonymousParticipantCount"],"type":"object"},"CallSessionEndedEvent":{"description":"This event is sent when a call session ends","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_ended","description":"The type of event: \"call.session_ended\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","call"],"title":"CallSessionEndedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSessionParticipantCountsUpdatedEvent":{"description":"This event is sent when the participant counts in a call session are updated","properties":{"anonymous_participant_count":{"format":"int32","type":"integer","x-stream-index":"005"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"participants_count_by_role":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"004"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_participant_count_updated","description":"The type of event: \"call.session_participant_count_updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","participants_count_by_role","anonymous_participant_count"],"title":"CallSessionParticipantCountsUpdatedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSessionParticipantJoinedEvent":{"description":"This event is sent when a participant joins a call session","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"participant":{"$ref":"#/components/schemas/CallParticipantResponse","description":"The participant that joined the session","title":"Participant","x-stream-index":"004"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_participant_joined","description":"The type of event: \"call.session_participant_joined\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","participant"],"title":"CallSessionParticipantJoinedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSessionParticipantLeftEvent":{"description":"This event is sent when a participant leaves a call session","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"duration_seconds":{"description":"The duration participant was in the session in seconds","format":"int32","title":"Duration","type":"integer","x-stream-index":"005"},"participant":{"$ref":"#/components/schemas/CallParticipantResponse","description":"The participant that left the session","title":"Participant","x-stream-index":"004"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_participant_left","description":"The type of event: \"call.session_participant_left\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","participant","duration_seconds"],"title":"CallSessionParticipantLeftEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSessionResponse":{"properties":{"accepted_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"008"},"anonymous_participant_count":{"format":"int32","type":"integer","x-stream-index":"006"},"ended_at":{"format":"date-time","type":"number","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"live_ended_at":{"format":"date-time","type":"number","x-stream-index":"011"},"live_started_at":{"format":"date-time","type":"number","x-stream-index":"010"},"missed_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"009"},"participants":{"items":{"$ref":"#/components/schemas/CallParticipantResponse"},"type":"array","x-stream-index":"004"},"participants_count_by_role":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"005"},"rejected_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"007"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002"},"timer_ends_at":{"format":"date-time","type":"number","x-stream-index":"012"}},"required":["id","participants","participants_count_by_role","anonymous_participant_count","rejected_by","accepted_by","missed_by"],"type":"object"},"CallSessionStartedEvent":{"description":"This event is sent when a call session starts","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_started","description":"The type of event: \"call.session_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","call"],"title":"CallSessionStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSettings":{"properties":{"audio":{"$ref":"#/components/schemas/AudioSettings","x-stream-index":"001"},"backstage":{"$ref":"#/components/schemas/BackstageSettings","x-stream-index":"002"},"broadcasting":{"$ref":"#/components/schemas/BroadcastSettings","x-stream-index":"007"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordSettings","x-stream-index":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettings","x-stream-index":"008"},"ingress":{"$ref":"#/components/schemas/IngressSettings","x-stream-index":"014"},"limits":{"$ref":"#/components/schemas/LimitsSettings","x-stream-index":"012"},"recording":{"$ref":"#/components/schemas/RecordSettings","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettings","x-stream-index":"010"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettings","x-stream-index":"004"},"session":{"$ref":"#/components/schemas/SessionSettings","x-stream-index":"013"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettings","x-stream-index":"011"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettings","x-stream-index":"009"},"video":{"$ref":"#/components/schemas/VideoSettings","x-stream-index":"003"}},"type":"object"},"CallSettingsRequest":{"properties":{"audio":{"$ref":"#/components/schemas/AudioSettingsRequest","x-stream-index":"001"},"backstage":{"$ref":"#/components/schemas/BackstageSettingsRequest","x-stream-index":"002"},"broadcasting":{"$ref":"#/components/schemas/BroadcastSettingsRequest","x-stream-index":"010"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordingSettingsRequest","x-stream-index":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettingsRequest","x-stream-index":"003"},"ingress":{"$ref":"#/components/schemas/IngressSettingsRequest","x-stream-index":"014"},"limits":{"$ref":"#/components/schemas/LimitsSettingsRequest","x-stream-index":"012"},"recording":{"$ref":"#/components/schemas/RecordSettingsRequest","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettingsRequest","x-stream-index":"007"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettingsRequest","x-stream-index":"008"},"session":{"$ref":"#/components/schemas/SessionSettingsRequest","x-stream-index":"013"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettingsRequest","x-stream-index":"011"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettingsRequest","x-stream-index":"009"},"video":{"$ref":"#/components/schemas/VideoSettingsRequest","x-stream-index":"004"}},"type":"object"},"CallSettingsResponse":{"properties":{"audio":{"$ref":"#/components/schemas/AudioSettingsResponse","x-stream-index":"001"},"backstage":{"$ref":"#/components/schemas/BackstageSettingsResponse","x-stream-index":"002"},"broadcasting":{"$ref":"#/components/schemas/BroadcastSettingsResponse","x-stream-index":"003"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordingSettingsResponse","x-stream-index":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettingsResponse","x-stream-index":"004"},"ingress":{"$ref":"#/components/schemas/IngressSettingsResponse","x-stream-index":"014"},"limits":{"$ref":"#/components/schemas/LimitsSettingsResponse","x-stream-index":"012"},"recording":{"$ref":"#/components/schemas/RecordSettingsResponse","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettingsResponse","x-stream-index":"007"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettingsResponse","x-stream-index":"008"},"session":{"$ref":"#/components/schemas/SessionSettingsResponse","x-stream-index":"013"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettingsResponse","x-stream-index":"011"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettingsResponse","x-stream-index":"009"},"video":{"$ref":"#/components/schemas/VideoSettingsResponse","x-stream-index":"010"}},"required":["audio","backstage","broadcasting","geofencing","recording","frame_recording","ring","screensharing","transcription","video","thumbnails","limits","session"],"type":"object"},"CallStateResponseFields":{"description":"CallStateResponseFields is the payload for call state response","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001"},"members":{"description":"List of call members","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"002"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"004"}},"required":["call","members","own_capabilities","blocked_users"],"title":"CallStateResponseFields","type":"object"},"CallStatsReportReadyEvent":{"description":"This event is sent when the insights report is ready","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.stats_report_ready","description":"The type of event, \"call.report_ready\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id"],"title":"CallStatsReportReadyEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallStatsReportSummaryResponse":{"properties":{"call_cid":{"type":"string","x-stream-index":"001"},"call_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"008"},"call_session_id":{"type":"string","x-stream-index":"002"},"call_status":{"type":"string","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"first_stats_time":{"format":"date-time","type":"number","x-stream-index":"003"},"min_user_rating":{"format":"int32","type":"integer","x-stream-index":"006"},"quality_score":{"format":"int32","type":"integer","x-stream-index":"005"}},"required":["call_cid","call_session_id","first_stats_time","call_status","call_duration_seconds"],"type":"object"},"CallTranscription":{"description":"CallTranscription represents a transcription of a call.","properties":{"end_time":{"format":"date-time","title":"The end time of the transcription.","type":"number","x-stream-index":"004"},"filename":{"title":"The filename of the transcription.","type":"string","x-stream-index":"001"},"session_id":{"title":"The session ID of the transcription.","type":"string","x-stream-index":"005"},"start_time":{"format":"date-time","title":"The start time of the transcription.","type":"number","x-stream-index":"003"},"url":{"title":"The URL of the transcription.","type":"string","x-stream-index":"002"}},"required":["filename","url","start_time","end_time","session_id"],"title":"CallTranscription","type":"object"},"CallTranscriptionFailedEvent":{"description":"This event is sent when call transcription has failed","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"003"},"error":{"description":"The error message detailing why transcription failed.","title":"string","type":"string","x-stream-index":"004"},"type":{"default":"call.transcription_failed","description":"The type of event: \"call.transcription_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","egress_id"],"title":"CallTranscriptionFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallTranscriptionReadyEvent":{"description":"This event is sent when call transcription is ready","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"call_transcription":{"$ref":"#/components/schemas/CallTranscription","description":"The call transcription object","title":"CallTranscription","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.transcription_ready","description":"The type of event: \"call.transcription_ready\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call_transcription","egress_id"],"title":"CallTranscriptionReadyEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallTranscriptionStartedEvent":{"description":"This event is sent when call transcription has started","properties":{"call_cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"egress_id":{"type":"string","x-stream-index":"001"},"type":{"default":"call.transcription_started","description":"The type of event: \"call.transcription_started\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001"}},"required":["egress_id","type","created_at","call_cid"],"title":"CallTranscriptionStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallTranscriptionStoppedEvent":{"description":"This event is sent when call transcription has stopped","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"003"},"type":{"default":"call.transcription_stopped","description":"The type of event: \"call.transcription_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","egress_id"],"title":"CallTranscriptionStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallType":{"nullable":true,"properties":{"AppPK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"003"},"CreatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"005"},"ExternalStorage":{"type":"string","writeOnly":true,"x-stream-index":"009"},"Name":{"type":"string","writeOnly":true,"x-stream-index":"004"},"NotificationSettings":{"$ref":"#/components/schemas/NotificationSettings","x-stream-index":"008"},"PK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"002"},"Settings":{"$ref":"#/components/schemas/CallSettings","x-stream-index":"007"},"UpdatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"006"}},"required":["PK","AppPK","Name","CreatedAt","UpdatedAt","ExternalStorage"],"type":"object"},"CallTypeResponse":{"description":"CallTypeResponse is the payload for a call type.","properties":{"created_at":{"description":"the time the call type was created","format":"date-time","title":"CreatedAt","type":"number","x-stream-index":"005"},"external_storage":{"description":"the external storage for the call type","title":"ExternalStorage","type":"string","x-stream-index":"007"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"the permissions granted to each role","title":"Grants","type":"object","x-stream-index":"002"},"name":{"description":"the name of the call type","title":"Name","type":"string","x-stream-index":"001"},"notification_settings":{"$ref":"#/components/schemas/NotificationSettings","description":"the notification settings for the call type","title":"NotificationSettings","x-stream-index":"004"},"settings":{"$ref":"#/components/schemas/CallSettingsResponse","description":"the settings for the call type","title":"Settings","x-stream-index":"003"},"updated_at":{"description":"the time the call type was last updated","format":"date-time","title":"UpdatedAt","type":"number","x-stream-index":"006"}},"required":["name","grants","settings","notification_settings","created_at","updated_at"],"title":"CallTypeResponse","type":"object"},"CallUpdatedEvent":{"description":"This event is sent when a call is updated, clients should use this update the local state of the call.\nThis event also contains the capabilities by role for the call, clients should update the own_capability for the current.","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"capabilities_by_role":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"The capabilities by role for this call","title":"CapabilitiesByRole","type":"object","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.updated","description":"The type of event: \"call.ended\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","capabilities_by_role"],"title":"CallUpdatedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallUserFeedbackSubmittedEvent":{"description":"This event is sent when a user submits feedback for a call.","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"custom":{"additionalProperties":{},"description":"Custom data provided by the user","title":"Custom","type":"object","x-stream-index":"007"},"rating":{"description":"The rating given by the user (1-5)","format":"int32","title":"Rating","type":"integer","x-stream-index":"005"},"reason":{"description":"The reason provided by the user for the rating","title":"Reason","type":"string","x-stream-index":"006"},"sdk":{"type":"string","x-stream-index":"008"},"sdk_version":{"type":"string","x-stream-index":"009"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.user_feedback_submitted","description":"The type of event, \"call.user_feedback\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who submitted the feedback","title":"User","x-stream-index":"004"}},"required":["type","created_at","call_cid","session_id","user","rating"],"title":"CallUserFeedbackSubmittedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallUserMutedEvent":{"description":"This event is sent when a call member is muted","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"from_user_id":{"type":"string","x-stream-index":"003"},"muted_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"type":{"default":"call.user_muted","description":"The type of event: \"call.user_muted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","from_user_id","muted_user_ids"],"title":"CallUserMutedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallsPerDayReport":{"properties":{"count":{"format":"int64","type":"integer","x-stream-index":"001"}},"required":["count"],"type":"object"},"CallsPerDayReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateCallsPerDayReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"CampaignChannelTemplate":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"002"},"members":{"items":{"type":"string"},"maximum":1000,"type":"array","x-stream-index":"003"},"team":{"maxLength":1000,"type":"string","x-stream-index":"004"},"type":{"maxLength":64,"type":"string","x-stream-index":"001"}},"required":["type","custom"],"type":"object"},"CampaignCompletedEvent":{"nullable":true,"properties":{"campaign":{"$ref":"#/components/schemas/CampaignResponse","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"type":{"default":"campaign.completed","type":"string","x-stream-index":"001.002"}},"required":["type","created_at","custom"],"title":"CampaignCompletedEvent","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"},"CampaignMessageTemplate":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"maximum":30,"type":"array","x-stream-index":"002"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"poll_id":{"type":"string","x-stream-index":"003"},"text":{"type":"string","x-stream-index":"001"}},"required":["text","attachments","poll_id","custom"],"type":"object"},"CampaignResponse":{"properties":{"channel_template":{"$ref":"#/components/schemas/CampaignChannelTemplate","x-stream-index":"016"},"create_channels":{"type":"boolean","x-stream-index":"008"},"created_at":{"format":"date-time","type":"number","x-stream-index":"020"},"description":{"type":"string","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"001"},"message_template":{"$ref":"#/components/schemas/CampaignMessageTemplate","x-stream-index":"015"},"name":{"type":"string","x-stream-index":"007"},"scheduled_for":{"format":"date-time","type":"number","x-stream-index":"013"},"segment_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"002"},"segments":{"items":{"$ref":"#/components/schemas/Segment"},"type":"array","x-stream-index":"003"},"sender":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"005"},"sender_id":{"type":"string","x-stream-index":"004"},"sender_mode":{"type":"string","x-stream-index":"006"},"show_channels":{"type":"boolean","x-stream-index":"009"},"skip_push":{"type":"boolean","x-stream-index":"011"},"skip_webhook":{"type":"boolean","x-stream-index":"012"},"stats":{"$ref":"#/components/schemas/CampaignStatsResponse","x-stream-index":"022"},"status":{"type":"string","x-stream-index":"019"},"stop_at":{"format":"date-time","type":"number","x-stream-index":"014"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"021"},"user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"017"},"users":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"018"}},"required":["id","segment_ids","segments","sender_id","sender_mode","name","create_channels","show_channels","description","skip_push","skip_webhook","user_ids","users","status","created_at","updated_at","stats"],"type":"object"},"CampaignStartedEvent":{"nullable":true,"properties":{"campaign":{"$ref":"#/components/schemas/CampaignResponse","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"type":{"default":"campaign.started","type":"string","x-stream-index":"001.002"}},"required":["type","created_at","custom"],"title":"CampaignStartedEvent","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"},"CampaignStatsResponse":{"properties":{"progress":{"format":"float","type":"number","x-stream-index":"005"},"stats_channels_created":{"format":"int32","type":"integer","x-stream-index":"004"},"stats_completed_at":{"format":"date-time","type":"number","x-stream-index":"002"},"stats_messages_sent":{"format":"int32","type":"integer","x-stream-index":"003"},"stats_started_at":{"format":"date-time","type":"number","x-stream-index":"001"},"stats_users_read":{"format":"int32","type":"integer","x-stream-index":"007"},"stats_users_sent":{"format":"int32","type":"integer","x-stream-index":"006"}},"required":["stats_started_at","stats_completed_at","stats_messages_sent","stats_channels_created","progress","stats_users_sent","stats_users_read"],"type":"object"},"CastPollVoteRequest":{"nullable":true,"properties":{"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"005.002"},"user_id":{"type":"string","x-stream-index":"005.001"},"vote":{"$ref":"#/components/schemas/VoteData","description":"Vote data","title":"VoteData","x-stream-index":"004"}},"type":"object"},"Channel":{"properties":{"active_live_locations":{"items":{"$ref":"#/components/schemas/SharedLocation"},"type":"array","x-stream-index":"034"},"auto_translation_enabled":{"type":"boolean","x-stream-index":"029"},"auto_translation_language":{"type":"string","x-stream-index":"030"},"cid":{"type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/ChannelConfig","x-stream-index":"026"},"config_overrides":{"$ref":"#/components/schemas/ConfigOverrides","x-stream-index":"027"},"cooldown":{"format":"int32","type":"integer","x-stream-index":"031"},"created_at":{"format":"date-time","type":"number","x-stream-index":"009"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"019"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"disabled":{"type":"boolean","x-stream-index":"017"},"frozen":{"type":"boolean","x-stream-index":"016"},"id":{"type":"string","x-stream-index":"004"},"invites":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"022"},"last_campaigns":{"type":"string","x-stream-index":"032"},"last_message_at":{"format":"date-time","type":"number","x-stream-index":"006"},"member_count":{"format":"int32","type":"integer","x-stream-index":"021"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"020"},"team":{"type":"string","x-stream-index":"028"},"truncated_by":{"$ref":"#/components/schemas/User","x-stream-index":"015"},"type":{"type":"string","x-stream-index":"005"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"010"}},"required":["cid","id","type","created_at","updated_at","frozen","disabled","custom","auto_translation_language"],"type":"object"},"ChannelConfig":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.026"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.021"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.022"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.027"},"blocklist":{"type":"string","x-stream-index":"001.023"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.024"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.025"},"commands":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"connect_events":{"type":"boolean","x-stream-index":"001.004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"custom_events":{"type":"boolean","x-stream-index":"001.012"},"mark_messages_pending":{"type":"boolean","x-stream-index":"001.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"001.020"},"mutes":{"type":"boolean","x-stream-index":"001.009"},"name":{"type":"string","x-stream-index":"001.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"001.028"},"partition_ttl":{"type":"integer","x-stream-index":"001.029"},"polls":{"type":"boolean","x-stream-index":"001.016"},"push_notifications":{"type":"boolean","x-stream-index":"001.013"},"quotes":{"type":"boolean","x-stream-index":"001.008"},"reactions":{"type":"boolean","x-stream-index":"001.006"},"read_events":{"type":"boolean","x-stream-index":"001.003"},"reminders":{"type":"boolean","x-stream-index":"001.014"},"replies":{"type":"boolean","x-stream-index":"001.007"},"search":{"type":"boolean","x-stream-index":"001.005"},"shared_locations":{"type":"boolean","x-stream-index":"001.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.030"},"typing_events":{"type":"boolean","x-stream-index":"001.002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"002.004"},"uploads":{"type":"boolean","x-stream-index":"001.010"},"url_enrichment":{"type":"boolean","x-stream-index":"001.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"001.017"}},"required":["name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","created_at","updated_at","commands"],"type":"object"},"ChannelConfigWithInfo":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.002.026"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.002.021"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.022"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.002.027"},"blocklist":{"type":"string","x-stream-index":"001.002.023"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.024"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.002.025"},"commands":{"items":{"$ref":"#/components/schemas/Command"},"type":"array","x-stream-index":"001.003"},"connect_events":{"type":"boolean","x-stream-index":"001.002.004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.001.003"},"custom_events":{"type":"boolean","x-stream-index":"001.002.012"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"002"},"mark_messages_pending":{"type":"boolean","x-stream-index":"001.002.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"001.002.020"},"mutes":{"type":"boolean","x-stream-index":"001.002.009"},"name":{"type":"string","x-stream-index":"001.002.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"001.002.028"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"001.002.029"},"polls":{"type":"boolean","x-stream-index":"001.002.016"},"push_notifications":{"type":"boolean","x-stream-index":"001.002.013"},"quotes":{"type":"boolean","x-stream-index":"001.002.008"},"reactions":{"type":"boolean","x-stream-index":"001.002.006"},"read_events":{"type":"boolean","x-stream-index":"001.002.003"},"reminders":{"type":"boolean","x-stream-index":"001.002.014"},"replies":{"type":"boolean","x-stream-index":"001.002.007"},"search":{"type":"boolean","x-stream-index":"001.002.005"},"shared_locations":{"type":"boolean","x-stream-index":"001.002.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.002.030"},"typing_events":{"type":"boolean","x-stream-index":"001.002.002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"uploads":{"type":"boolean","x-stream-index":"001.002.010"},"url_enrichment":{"type":"boolean","x-stream-index":"001.002.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"001.002.017"}},"required":["created_at","updated_at","name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","commands"],"type":"object"},"ChannelCreatedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"channel.created","type":"string","x-stream-index":"001.001"}},"required":["type","created_at"],"title":"ChannelCreatedEvent","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"},"ChannelDeletedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003.004"},"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"003.005"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"team":{"type":"string","x-stream-index":"001.001"},"type":{"default":"channel.deleted","type":"string","x-stream-index":"002.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"ChannelDeletedEvent","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"},"ChannelExport":{"properties":{"cid":{"type":"string","x-stream-index":"003"},"id":{"description":"Channel ID","title":"ID","type":"string","x-stream-index":"002"},"messages_since":{"description":"Date to export messages since","format":"date-time","title":"Messages since","type":"number","x-stream-index":"004"},"messages_until":{"description":"Date to export messages until","format":"date-time","title":"Messages until","type":"number","x-stream-index":"005"},"type":{"description":"Channel type","title":"Type","type":"string","x-stream-index":"001"}},"title":"Channel Export","type":"object"},"ChannelFrozenEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"channel.frozen","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"ChannelFrozenEvent","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"},"ChannelGetOrCreateRequest":{"nullable":true,"properties":{"data":{"$ref":"#/components/schemas/ChannelInput","x-stream-index":"003"},"hide_for_creator":{"description":"Whether this channel will be hidden for the user who created the channel or not","title":"Hide for creator","type":"boolean","x-stream-index":"007"},"members":{"$ref":"#/components/schemas/PaginationParams","x-stream-index":"010"},"messages":{"$ref":"#/components/schemas/MessagePaginationParams","x-stream-index":"009"},"state":{"description":"Refresh channel state","title":"State","type":"boolean","x-stream-index":"005"},"thread_unread_counts":{"type":"boolean","x-stream-index":"008"},"watchers":{"$ref":"#/components/schemas/PaginationParams","x-stream-index":"011"}},"type":"object"},"ChannelHiddenEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003.004"},"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"003.005"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"clear_history":{"type":"boolean","x-stream-index":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"type":{"default":"channel.hidden","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["clear_history","cid","channel_id","channel_type","channel_member_count","type","created_at"],"title":"ChannelHiddenEvent","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"},"ChannelInput":{"properties":{"auto_translation_enabled":{"description":"Enable or disable auto translation","title":"Auto translation","type":"boolean","x-stream-index":"005"},"auto_translation_language":{"description":"Switch auto translation language","title":"Auto translation language","type":"string","x-stream-index":"006"},"config_overrides":{"$ref":"#/components/schemas/ChannelConfig","x-stream-index":"024"},"created_by":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"009"},"created_by_id":{"type":"string","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"015"},"disabled":{"type":"boolean","x-stream-index":"014"},"frozen":{"description":"Freeze or unfreeze the channel","title":"Frozen","type":"boolean","x-stream-index":"013"},"invites":{"items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"type":"array","x-stream-index":"016"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"type":"array","x-stream-index":"018"},"team":{"description":"Team the channel belongs to (if multi-tenant mode is enabled)","title":"Team","type":"string","x-stream-index":"004"},"truncated_by_id":{"type":"string","x-stream-index":"010"}},"type":"object"},"ChannelMember":{"nullable":true,"properties":{"archived_at":{"format":"date-time","type":"number","x-stream-index":"015"},"ban_expires":{"description":"Expiration date of the ban","format":"date-time","title":"Ban expires","type":"number","x-stream-index":"013"},"banned":{"description":"Whether member is banned this channel or not","title":"Banned","type":"boolean","x-stream-index":"012"},"channel_role":{"description":"Role of the member in the channel","title":"Channel Role","type":"string","x-stream-index":"018"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"invite_accepted_at":{"description":"Date when invite was accepted","format":"date-time","title":"Invited accepted at","type":"number","x-stream-index":"006"},"invite_rejected_at":{"description":"Date when invite was rejected","format":"date-time","title":"Invited rejected at","type":"number","x-stream-index":"007"},"invited":{"description":"Whether member was invited or not","title":"Invited","type":"boolean","x-stream-index":"005"},"is_moderator":{"description":"Whether member is channel moderator or not","title":"Is moderator","type":"boolean","x-stream-index":"003"},"notifications_muted":{"type":"boolean","x-stream-index":"019"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"016"},"role":{"description":"Permission level of the member in the channel (DEPRECATED: use channel_role instead)","enum":["member","moderator","admin","owner"],"title":"Role","type":"string","x-stream-index":"017"},"shadow_banned":{"description":"Whether member is shadow banned in this channel or not","title":"Shadow banned","type":"boolean","x-stream-index":"014"},"status":{"type":"string","x-stream-index":"008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"},"user_id":{"title":"User ID","type":"string","x-stream-index":"001"}},"required":["custom","created_at","updated_at","banned","shadow_banned","channel_role","notifications_muted"],"title":"Channel member","type":"object"},"ChannelMemberResponse":{"nullable":true,"properties":{"archived_at":{"format":"date-time","type":"number","x-stream-index":"016"},"ban_expires":{"description":"Expiration date of the ban","format":"date-time","title":"Ban expires","type":"number","x-stream-index":"013"},"banned":{"description":"Whether member is banned this channel or not","title":"Banned","type":"boolean","x-stream-index":"012"},"channel_role":{"description":"Role of the member in the channel","title":"Channel Role","type":"string","x-stream-index":"018"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"invite_accepted_at":{"description":"Date when invite was accepted","format":"date-time","title":"Invited accepted at","type":"number","x-stream-index":"006"},"invite_rejected_at":{"description":"Date when invite was rejected","format":"date-time","title":"Invited rejected at","type":"number","x-stream-index":"007"},"invited":{"description":"Whether member was invited or not","title":"Invited","type":"boolean","x-stream-index":"005"},"is_moderator":{"description":"Whether member is channel moderator or not","title":"Is moderator","type":"boolean","x-stream-index":"003"},"notifications_muted":{"type":"boolean","x-stream-index":"019"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"015"},"role":{"description":"Permission level of the member in the channel (DEPRECATED: use channel_role instead)","enum":["member","moderator","admin","owner"],"title":"Role","type":"string","x-stream-index":"017"},"shadow_banned":{"description":"Whether member is shadow banned in this channel or not","title":"Shadow banned","type":"boolean","x-stream-index":"014"},"status":{"type":"string","x-stream-index":"008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"},"user_id":{"title":"User ID","type":"string","x-stream-index":"001"}},"required":["custom","created_at","updated_at","banned","shadow_banned","channel_role","notifications_muted"],"title":"Channel member","type":"object"},"ChannelMessages":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001"},"messages":{"items":{"$ref":"#/components/schemas/Message"},"type":"array","x-stream-index":"002"}},"required":["messages"],"type":"object"},"ChannelMute":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel that is muted","title":"Channel","x-stream-index":"002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"004"},"expires":{"description":"Date/time of mute expiration","format":"date-time","title":"Expires","type":"number","x-stream-index":"003"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Owner of channel mute","title":"User","x-stream-index":"001"}},"required":["created_at","updated_at"],"type":"object"},"ChannelMutedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"channel.muted","type":"string","x-stream-index":"001.001"}},"required":["type","created_at"],"title":"ChannelMutedEvent","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"},"ChannelOwnCapability":{"description":"All possibility of string to use","enum":["ban-channel-members","cast-poll-vote","connect-events","create-attachment","delete-any-message","delete-channel","delete-own-message","flag-message","freeze-channel","join-channel","leave-channel","mute-channel","pin-message","query-poll-votes","quote-message","read-events","search-messages","send-custom-events","send-links","send-message","send-poll","send-reaction","send-reply","send-restricted-visibility-message","send-typing-events","set-channel-cooldown","share-location","skip-slow-mode","slow-mode","typing-events","update-any-message","update-channel","update-channel-members","update-own-message","update-thread","upload-file"],"title":"ChannelOwnCapability","type":"string"},"ChannelPushPreferences":{"properties":{"chat_level":{"type":"string","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"number","x-stream-index":"002"}},"type":"object"},"ChannelResponse":{"description":"Represents channel in chat","properties":{"auto_translation_enabled":{"description":"Whether auto translation is enabled or not","title":"Auto translation","type":"boolean","x-stream-index":"017"},"auto_translation_language":{"description":"Language to translate to when auto translation is active","title":"Auto translation language","type":"string","x-stream-index":"018"},"blocked":{"description":"Whether this channel is blocked by current user or not","title":"Blocked","type":"boolean","x-stream-index":"023"},"cid":{"description":"Channel CID (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/ChannelConfigWithInfo","description":"Channel configuration","title":"ChannelConfigWithInfo","x-stream-index":"013"},"cooldown":{"description":"Cooldown period after sending each message","format":"int32","title":"Cooldown","type":"integer","x-stream-index":"020"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"005"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"Creator of the channel","title":"UserResponse","x-stream-index":"008"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"026"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"007"},"disabled":{"type":"boolean","x-stream-index":"010"},"frozen":{"description":"Whether channel is frozen or not","title":"Frozen","type":"boolean","x-stream-index":"009"},"hidden":{"description":"Whether this channel is hidden by current user or not","title":"Hidden","type":"boolean","x-stream-index":"022"},"hide_messages_before":{"description":"Date since when the message history is accessible","format":"date-time","title":"Hide messages before","type":"number","x-stream-index":"019"},"id":{"description":"Channel unique ID","title":"ID","type":"string","x-stream-index":"001"},"last_message_at":{"description":"Date of the last message sent","format":"date-time","title":"Last message at","type":"number","x-stream-index":"004"},"member_count":{"description":"Number of members in the channel","format":"int32","title":"Member count","type":"integer","x-stream-index":"012"},"members":{"description":"List of channel members (max 100)","items":{"$ref":"#/components/schemas/ChannelMember"},"title":"ChannelMembers","type":"array","x-stream-index":"011"},"mute_expires_at":{"description":"Date of mute expiration","format":"date-time","title":"Mute expires at","type":"number","x-stream-index":"015"},"muted":{"description":"Whether this channel is muted or not","title":"Muted","type":"boolean","x-stream-index":"014"},"own_capabilities":{"description":"List of channel capabilities of authenticated user","items":{"$ref":"#/components/schemas/ChannelOwnCapability"},"title":"ChannelOwnCapability","type":"array","x-stream-index":"021"},"team":{"description":"Team the channel belongs to (multi-tenant only)","title":"Team","type":"string","x-stream-index":"016"},"truncated_at":{"description":"Date of the latest truncation of the channel","format":"date-time","title":"UserResponse","type":"number","x-stream-index":"024"},"truncated_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"025"},"type":{"description":"Type of the channel","title":"Type","type":"string","x-stream-docs-page-id":"channel_features","x-stream-index":"002"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"006"}},"required":["id","type","cid","created_at","updated_at","frozen","disabled","custom"],"title":"Channel","type":"object"},"ChannelStateResponse":{"nullable":true,"properties":{"active_live_locations":{"items":{"$ref":"#/components/schemas/SharedLocationResponseData"},"type":"array","x-stream-index":"001.015"},"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001.001"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001.014"},"duration":{"type":"string","x-stream-index":"002.001"},"hidden":{"type":"boolean","x-stream-index":"001.011"},"hide_messages_before":{"format":"date-time","type":"number","x-stream-index":"001.012"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"001.007"},"membership":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"001.008"},"messages":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","x-stream-index":"001.002"},"pending_messages":{"items":{"$ref":"#/components/schemas/PendingMessageResponse"},"type":"array","x-stream-index":"001.013"},"pinned_messages":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","x-stream-index":"001.003"},"push_preferences":{"$ref":"#/components/schemas/ChannelPushPreferences","x-stream-index":"001.009"},"read":{"items":{"$ref":"#/components/schemas/ReadStateResponse"},"type":"array","x-stream-index":"001.006"},"threads":{"items":{"$ref":"#/components/schemas/ThreadStateResponse"},"type":"array","x-stream-index":"001.010"},"watcher_count":{"format":"int32","type":"integer","x-stream-index":"001.004"},"watchers":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"001.005"}},"required":["messages","pinned_messages","members","threads","duration"],"type":"object"},"ChannelStateResponseFields":{"properties":{"active_live_locations":{"description":"Active live locations in the channel","items":{"$ref":"#/components/schemas/SharedLocationResponseData"},"title":"Active Live Locations","type":"array","x-stream-index":"015"},"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"014"},"hidden":{"description":"Whether this channel is hidden or not","title":"Hidden","type":"boolean","x-stream-index":"011"},"hide_messages_before":{"description":"Messages before this date are hidden from the user","format":"date-time","title":"Hide messages before","type":"number","x-stream-index":"012"},"members":{"description":"List of channel members","items":{"$ref":"#/components/schemas/ChannelMember"},"title":"Members","type":"array","x-stream-index":"007"},"membership":{"$ref":"#/components/schemas/ChannelMember","description":"Current user membership object","title":"Membership","x-stream-index":"008"},"messages":{"description":"List of channel messages","items":{"$ref":"#/components/schemas/MessageResponse"},"title":"Message","type":"array","x-stream-index":"002"},"pending_messages":{"description":"Pending messages that this user has sent","items":{"$ref":"#/components/schemas/PendingMessageResponse"},"title":"Pending messages","type":"array","x-stream-index":"013"},"pinned_messages":{"description":"List of pinned messages in the channel","items":{"$ref":"#/components/schemas/MessageResponse"},"title":"Pinned messages","type":"array","x-stream-docs-page-id":"pinned_messages","x-stream-index":"003"},"push_preferences":{"$ref":"#/components/schemas/ChannelPushPreferences","x-stream-index":"009"},"read":{"description":"List of read states","items":{"$ref":"#/components/schemas/ReadStateResponse"},"title":"Read","type":"array","x-stream-index":"006"},"threads":{"items":{"$ref":"#/components/schemas/ThreadStateResponse"},"type":"array","x-stream-index":"010"},"watcher_count":{"description":"Number of channel watchers","format":"int32","title":"Watcher count","type":"integer","x-stream-index":"004"},"watchers":{"description":"List of user who is watching the channel","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Watchers","type":"array","x-stream-index":"005"}},"required":["messages","pinned_messages","members","threads"],"type":"object"},"ChannelTruncatedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001.004"},"channel_id":{"type":"string","x-stream-index":"001.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"001.005"},"channel_type":{"type":"string","x-stream-index":"001.003"},"cid":{"type":"string","x-stream-index":"001.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"type":{"default":"channel.truncated","type":"string","x-stream-index":"002.001"}},"required":["cid","channel_id","channel_type","channel_member_count","type","created_at"],"title":"ChannelTruncatedEvent","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"},"ChannelTypeConfig":{"nullable":true,"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"003.002.026"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"003.002.021"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.002.022"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"003.002.027"},"blocklist":{"type":"string","x-stream-index":"003.002.023"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.002.024"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"003.002.025"},"commands":{"items":{"$ref":"#/components/schemas/Command"},"type":"array","x-stream-index":"003.003"},"connect_events":{"type":"boolean","x-stream-index":"003.002.004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.001.003"},"custom_events":{"type":"boolean","x-stream-index":"003.002.012"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"002"},"mark_messages_pending":{"type":"boolean","x-stream-index":"003.002.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"003.002.020"},"mutes":{"type":"boolean","x-stream-index":"003.002.009"},"name":{"type":"string","x-stream-index":"003.002.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"003.002.028"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"003.002.029"},"permissions":{"items":{"$ref":"#/components/schemas/PolicyRequest"},"type":"array","x-stream-index":"001"},"polls":{"type":"boolean","x-stream-index":"003.002.016"},"push_notifications":{"type":"boolean","x-stream-index":"003.002.013"},"quotes":{"type":"boolean","x-stream-index":"003.002.008"},"reactions":{"type":"boolean","x-stream-index":"003.002.006"},"read_events":{"type":"boolean","x-stream-index":"003.002.003"},"reminders":{"type":"boolean","x-stream-index":"003.002.014"},"replies":{"type":"boolean","x-stream-index":"003.002.007"},"search":{"type":"boolean","x-stream-index":"003.002.005"},"shared_locations":{"type":"boolean","x-stream-index":"003.002.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"003.002.030"},"typing_events":{"type":"boolean","x-stream-index":"003.002.002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"003.001.004"},"uploads":{"type":"boolean","x-stream-index":"003.002.010"},"url_enrichment":{"type":"boolean","x-stream-index":"003.002.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"003.002.017"}},"required":["permissions","grants","created_at","updated_at","name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","commands"],"type":"object"},"ChannelUnFrozenEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"channel.unfrozen","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"ChannelUnFrozenEvent","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"},"ChannelUnmutedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"channel.unmuted","type":"string","x-stream-index":"001.001"}},"required":["type","created_at"],"title":"ChannelUnmutedEvent","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"},"ChannelUpdatedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"004.004"},"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"004.005"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"002.001"},"type":{"default":"channel.updated","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"ChannelUpdatedEvent","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"},"ChannelVisibleEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"001.002"},"channel_type":{"type":"string","x-stream-index":"001.003"},"cid":{"type":"string","x-stream-index":"001.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"type":{"default":"channel.visible","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"ChannelVisibleEvent","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"},"ChatActivityStatsResponse":{"properties":{"Messages":{"$ref":"#/components/schemas/MessageStatsResponse","x-stream-index":"001"}},"type":"object"},"CheckExternalStorageResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"file_url":{"type":"string","x-stream-index":"002"}},"required":["duration","file_url"],"title":"Response","type":"object"},"CheckPushRequest":{"description":"Check push request","nullable":true,"properties":{"apn_template":{"description":"Push message template for APN","title":"APN template","type":"string","x-stream-docs-page-id":"push_template","x-stream-index":"002"},"event_type":{"description":"Type of event for push templates (default: message.new)","enum":["message.new","message.updated","reaction.new","reaction.updated","notification.reminder_due"],"title":"Event type","type":"string","x-stream-index":"008"},"firebase_data_template":{"description":"Push message data template for Firebase","title":"Firebase data template","type":"string","x-stream-docs-page-id":"push_template","x-stream-index":"004"},"firebase_template":{"description":"Push message template for Firebase","title":"Firebase template","type":"string","x-stream-docs-page-id":"push_template","x-stream-index":"003"},"message_id":{"description":"Message ID to send push notification for","title":"Message ID","type":"string","x-stream-index":"001"},"push_provider_name":{"description":"Name of push provider","title":"Name of push provider","type":"string","x-stream-index":"007"},"push_provider_type":{"description":"Push provider type","enum":["firebase","apn","huawei","xiaomi"],"title":"Type of push provider","type":"string","x-stream-index":"006"},"skip_devices":{"description":"Don't require existing devices to render templates","title":"Skip devices","type":"boolean","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"009.002"},"user_id":{"type":"string","x-stream-index":"009.001"}},"title":"CheckPushRequest","type":"object"},"CheckPushResponse":{"nullable":true,"properties":{"device_errors":{"additionalProperties":{"$ref":"#/components/schemas/DeviceErrorInfo"},"description":"Object with device errors","title":"Device errors","type":"object","x-stream-index":"001","x-stream-map":{"key":"device_id"}},"duration":{"type":"string","x-stream-index":"008.001"},"event_type":{"description":"The event type that was tested","title":"Event type","type":"string","x-stream-index":"004"},"general_errors":{"description":"List of general errors","items":{"type":"string"},"title":"General errors","type":"array","x-stream-index":"002"},"rendered_apn_template":{"title":"Rendered APN template","type":"string","x-stream-index":"005"},"rendered_firebase_template":{"title":"Rendered Firebase template","type":"string","x-stream-index":"006"},"rendered_message":{"additionalProperties":{"type":"string"},"title":"Rendered message","type":"object","x-stream-index":"007"},"skip_devices":{"description":"Don't require existing devices to render templates","title":"Skip devices","type":"boolean","x-stream-index":"003"}},"required":["duration"],"type":"object"},"CheckRequest":{"nullable":true,"properties":{"config_key":{"description":"Key of the moderation configuration to use","title":"Config Key","type":"string","x-stream-index":"005"},"config_team":{"description":"Team associated with the configuration","title":"Config Team","type":"string","x-stream-index":"006"},"entity_creator_id":{"description":"ID of the user who created the entity","title":"Entity Creator ID","type":"string","x-stream-index":"003"},"entity_id":{"description":"Unique identifier of the entity to moderate","title":"Entity ID","type":"string","x-stream-index":"002"},"entity_type":{"description":"Type of entity to moderate","title":"Entity Type","type":"string","x-stream-index":"001"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content to be moderated","title":"Moderation Payload","x-stream-index":"004"},"options":{"additionalProperties":{},"description":"Additional moderation configuration options","title":"Options","type":"object","x-stream-index":"007"},"test_mode":{"description":"Whether to run moderation in test mode","title":"Test Mode","type":"boolean","x-stream-index":"008"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"009.002"},"user_id":{"type":"string","x-stream-index":"009.001"}},"required":["entity_type","entity_id","entity_creator_id","config_key"],"type":"object"},"CheckResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"005.001"},"item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"Review queue item (present if action != keep)","title":"Item","x-stream-index":"004"},"recommended_action":{"description":"Suggested action based on moderation results","title":"Recommended Action","type":"string","x-stream-index":"003"},"status":{"description":"Status of the moderation check (completed or pending)","title":"Status","type":"string","x-stream-index":"001"},"task_id":{"description":"ID of the running moderation task","title":"Task ID","type":"string","x-stream-index":"002"}},"required":["status","recommended_action","duration"],"type":"object"},"CheckSNSRequest":{"nullable":true,"properties":{"sns_key":{"description":"AWS SNS access key","title":"SNS key","type":"string","x-stream-index":"002"},"sns_secret":{"description":"AWS SNS key secret","title":"SNS secret","type":"string","x-stream-index":"003"},"sns_topic_arn":{"description":"AWS SNS topic ARN","title":"SNS Topic ARN","type":"string","x-stream-index":"001"}},"type":"object"},"CheckSNSResponse":{"nullable":true,"properties":{"data":{"additionalProperties":{},"description":"Error data","title":"ReadOnlyData","type":"object","x-stream-index":"003"},"duration":{"type":"string","x-stream-index":"004.001"},"error":{"description":"Error text","title":"Error","type":"string","x-stream-index":"002"},"status":{"description":"Validation result","enum":["ok","error"],"title":"Status","type":"string","x-stream-index":"001"}},"required":["status","duration"],"type":"object"},"CheckSQSRequest":{"nullable":true,"properties":{"sqs_key":{"description":"AWS SQS access key","title":"SQS key","type":"string","x-stream-index":"002"},"sqs_secret":{"description":"AWS SQS key secret","title":"SQS secret","type":"string","x-stream-index":"003"},"sqs_url":{"description":"AWS SQS endpoint URL","title":"SQS URL","type":"string","x-stream-index":"001"}},"type":"object"},"CheckSQSResponse":{"nullable":true,"properties":{"data":{"additionalProperties":{},"description":"Error data","title":"ReadOnlyData","type":"object","x-stream-index":"003"},"duration":{"type":"string","x-stream-index":"004.001"},"error":{"description":"Error text","title":"Error","type":"string","x-stream-index":"002"},"status":{"description":"Validation result","enum":["ok","error"],"title":"Status","type":"string","x-stream-index":"001"}},"required":["status","duration"],"type":"object"},"ClientOSDataResponse":{"properties":{"architecture":{"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"version":{"type":"string","x-stream-index":"002"}},"type":"object"},"ClosedCaptionEvent":{"description":"This event is sent when closed captions are being sent in a call, clients should use this to show the closed captions in the call screen","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"closed_caption":{"$ref":"#/components/schemas/CallClosedCaption","description":"The closed caption object","title":"CallClosedCaption","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.closed_caption","description":"The type of event: \"call.closed_caption\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","closed_caption"],"title":"ClosedCaptionEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CollectUserFeedbackRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"009"},"rating":{"format":"int32","maximum":5,"minimum":1,"type":"integer","x-stream-index":"007"},"reason":{"maxLength":1000,"type":"string","x-stream-index":"008"},"sdk":{"maxLength":50,"type":"string","x-stream-index":"005"},"sdk_version":{"maxLength":50,"type":"string","x-stream-index":"006"},"user_session_id":{"maxLength":50,"type":"string","x-stream-index":"004"}},"required":["sdk","sdk_version","rating"],"type":"object"},"CollectUserFeedbackResponse":{"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"},"Command":{"description":"Represents custom chat command","nullable":true,"properties":{"args":{"description":"Arguments help text, shown in commands auto-completion","title":"Arguments","type":"string","x-stream-index":"006"},"created_at":{"description":"Date/time of creation","format":"date-time","readOnly":true,"title":"Created at","type":"number","x-stream-index":"001"},"description":{"description":"Description, shown in commands auto-completion","title":"Description","type":"string","x-stream-index":"005"},"name":{"description":"Unique command name","title":"Name","type":"string","x-stream-index":"004"},"set":{"description":"Set name used for grouping commands","title":"Set","type":"string","x-stream-index":"007"},"updated_at":{"description":"Date/time of the last update","format":"date-time","readOnly":true,"title":"Updated at","type":"number","x-stream-index":"002"}},"required":["name","description","args","set"],"title":"Command","type":"object"},"CommitMessageRequest":{"nullable":true,"type":"object"},"CompositeAppSettings":{"properties":{"json_encoded_settings":{"type":"string","x-stream-index":"005"},"url":{"type":"string","x-stream-index":"004"}},"type":"object"},"ConfigOverrides":{"properties":{"blocklist":{"type":"string","x-stream-index":"008"},"blocklist_behavior":{"enum":["flag","block"],"type":"string","x-stream-index":"009"},"commands":{"items":{"type":"string"},"type":"array","x-stream-index":"011"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"010"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"007"},"quotes":{"type":"boolean","x-stream-index":"004"},"reactions":{"type":"boolean","x-stream-index":"002"},"replies":{"type":"boolean","x-stream-index":"003"},"shared_locations":{"type":"boolean","x-stream-index":"013"},"typing_events":{"type":"boolean","x-stream-index":"001"},"uploads":{"type":"boolean","x-stream-index":"005"},"url_enrichment":{"type":"boolean","x-stream-index":"006"},"user_message_reminders":{"type":"boolean","x-stream-index":"012"}},"required":["grants","commands"],"type":"object"},"ConfigResponse":{"properties":{"ai_image_config":{"$ref":"#/components/schemas/AIImageConfig","description":"Configuration for AI image analysis","title":"AI Image Config","x-stream-index":"009"},"ai_text_config":{"$ref":"#/components/schemas/AITextConfig","description":"Configuration for AI text analysis","title":"AI Text Config","x-stream-index":"008"},"ai_video_config":{"$ref":"#/components/schemas/AIVideoConfig","description":"Configuration for AI video analysis","title":"AI Video Config","x-stream-index":"010"},"async":{"description":"Whether moderation should be performed asynchronously","title":"Async","type":"boolean","x-stream-index":"003"},"automod_platform_circumvention_config":{"$ref":"#/components/schemas/AutomodPlatformCircumventionConfig","description":"Configuration for platform circumvention detection","title":"Automod Platform Circumvention Config","x-stream-index":"005"},"automod_semantic_filters_config":{"$ref":"#/components/schemas/AutomodSemanticFiltersConfig","description":"Configuration for semantic filtering","title":"Automod Semantic Filters Config","x-stream-index":"006"},"automod_toxicity_config":{"$ref":"#/components/schemas/AutomodToxicityConfig","description":"Configuration for toxicity detection","title":"Automod Toxicity Config","x-stream-index":"004"},"block_list_config":{"$ref":"#/components/schemas/BlockListConfig","description":"Configuration for block list filtering","title":"Block List Config","x-stream-index":"007"},"created_at":{"description":"When the configuration was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"012"},"key":{"description":"Unique identifier for the moderation configuration","title":"Key","type":"string","x-stream-index":"001"},"rule_builder_config":{"$ref":"#/components/schemas/RuleBuilderConfig","x-stream-index":"015"},"team":{"description":"Team associated with the configuration","title":"Team","type":"string","x-stream-index":"002"},"updated_at":{"description":"When the configuration was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"013"},"velocity_filter_config":{"$ref":"#/components/schemas/VelocityFilterConfig","description":"Configuration for velocity-based filtering","title":"Velocity Filter Config","x-stream-index":"011"},"video_call_rule_config":{"$ref":"#/components/schemas/VideoCallRuleConfig","x-stream-index":"014"}},"required":["key","team","async","created_at","updated_at"],"type":"object"},"ContentCountRuleParameters":{"properties":{"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"required":["threshold","time_window"],"type":"object"},"CountByMinuteResponse":{"nullable":true,"properties":{"count":{"format":"int32","type":"integer","x-stream-index":"002"},"start_ts":{"format":"date-time","type":"number","x-stream-index":"001"}},"required":["start_ts","count"],"type":"object"},"CreateBlockListRequest":{"description":"Block list contains restricted words","nullable":true,"properties":{"name":{"description":"Block list name","maxLength":255,"title":"Name","type":"string","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"004"},"type":{"description":"Block list type.","enum":["regex","domain","domain_allowlist","email","word"],"title":"Type","type":"string","x-stream-index":"003"},"words":{"description":"List of words to block","items":{"type":"string"},"minimum":1,"title":"Words","type":"array","x-stream-index":"002"}},"required":["name","words"],"title":"Block list","type":"object","x-stream-docs-page-id":"block_lists"},"CreateBlockListResponse":{"description":"Basic response information","nullable":true,"properties":{"blocklist":{"$ref":"#/components/schemas/BlockListResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["duration"],"title":"Response","type":"object"},"CreateCallTypeRequest":{"description":"Request for creating a call type","nullable":true,"properties":{"external_storage":{"description":"the external storage for the call type","title":"ExternalStorage","type":"string","x-stream-index":"002.004"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"the permissions granted to each role","title":"Grants","type":"object","x-stream-index":"002.001"},"name":{"type":"string","x-stream-index":"001"},"notification_settings":{"$ref":"#/components/schemas/NotificationSettings","description":"the notification settings for the call type","title":"NotificationSettings","x-stream-index":"002.002"},"settings":{"$ref":"#/components/schemas/CallSettingsRequest","description":"the settings for the call type","title":"Settings","x-stream-index":"002.003"}},"required":["name"],"title":"CreateCallTypeRequest","type":"object"},"CreateCallTypeResponse":{"description":"Response for creating a call type","nullable":true,"properties":{"created_at":{"description":"the time the call type was created","format":"date-time","title":"CreatedAt","type":"number","x-stream-index":"001.005"},"duration":{"type":"string","x-stream-index":"002.001"},"external_storage":{"description":"the external storage for the call type","title":"ExternalStorage","type":"string","x-stream-index":"001.007"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"the permissions granted to each role","title":"Grants","type":"object","x-stream-index":"001.002"},"name":{"description":"the name of the call type","title":"Name","type":"string","x-stream-index":"001.001"},"notification_settings":{"$ref":"#/components/schemas/NotificationSettings","description":"the notification settings for the call type","title":"NotificationSettings","x-stream-index":"001.004"},"settings":{"$ref":"#/components/schemas/CallSettingsResponse","description":"the settings for the call type","title":"Settings","x-stream-index":"001.003"},"updated_at":{"description":"the time the call type was last updated","format":"date-time","title":"UpdatedAt","type":"number","x-stream-index":"001.006"}},"required":["name","grants","settings","notification_settings","created_at","updated_at","duration"],"title":"CreateCallTypeResponse","type":"object"},"CreateChannelTypeRequest":{"nullable":true,"properties":{"automod":{"description":"Automod","enum":["disabled","simple","AI"],"title":"Automod","type":"string","x-stream-index":"019"},"automod_behavior":{"description":"Automod behavior","enum":["flag","block"],"title":"Automod behavior","type":"string","x-stream-index":"020"},"blocklist":{"description":"Blocklist","title":"Blocklist","type":"string","x-stream-index":"024"},"blocklist_behavior":{"description":"Blocklist behavior","enum":["flag","block","shadow_block"],"title":"Blocklist behavior","type":"string","x-stream-index":"025"},"blocklists":{"description":"Blocklists","items":{"$ref":"#/components/schemas/BlockListOptions"},"title":"Blocklists","type":"array","x-stream-index":"026"},"commands":{"description":"List of commands that channel supports","items":{"type":"string"},"title":"Commands","type":"array","x-stream-index":"021"},"connect_events":{"description":"Connect events","title":"Connect events","type":"boolean","x-stream-index":"004"},"custom_events":{"description":"Custom events","title":"Custom events","type":"boolean","x-stream-index":"011"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"List of grants for the channel type","title":"Grants","type":"object","x-stream-index":"023"},"mark_messages_pending":{"description":"Mark messages pending","title":"Mark messages pending","type":"boolean","x-stream-index":"013"},"max_message_length":{"description":"Max message length","format":"int32","title":"Max message length","type":"integer","x-stream-index":"018"},"message_retention":{"description":"Message retention","enum":["infinite","numeric"],"title":"Message retention","type":"string","x-stream-index":"017"},"mutes":{"description":"Mutes","title":"Mutes","type":"boolean","x-stream-index":"008"},"name":{"description":"Channel type name","title":"Name","type":"string","x-stream-index":"001"},"partition_size":{"description":"Partition size","format":"int32","minimum":10,"title":"Partition size","type":"integer","x-stream-index":"027"},"partition_ttl":{"description":"Partition TTL","example":"24h","format":"duration","nullable":true,"title":"Partition TTL","type":"string","x-stream-index":"028"},"permissions":{"description":"List of permissions for the channel type","items":{"$ref":"#/components/schemas/PolicyRequest"},"title":"Permissions","type":"array","x-stream-index":"022"},"polls":{"description":"Polls","title":"Polls","type":"boolean","x-stream-index":"014"},"push_notifications":{"description":"Push notifications","title":"Push notifications","type":"boolean","x-stream-index":"012"},"reactions":{"description":"Reactions","title":"Reactions","type":"boolean","x-stream-index":"005"},"read_events":{"description":"Read events","title":"Read events","type":"boolean","x-stream-index":"003"},"replies":{"description":"Replies","title":"Replies","type":"boolean","x-stream-index":"006"},"search":{"description":"Search","title":"Search","type":"boolean","x-stream-index":"007"},"shared_locations":{"description":"Enables shared location messages","title":"Shared locations","type":"boolean","x-stream-index":"016"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"029"},"typing_events":{"description":"Typing events","title":"Typing events","type":"boolean","x-stream-index":"002"},"uploads":{"description":"Uploads","title":"Uploads","type":"boolean","x-stream-index":"009"},"url_enrichment":{"description":"URL enrichment","title":"URL enrichment","type":"boolean","x-stream-index":"010"},"user_message_reminders":{"type":"boolean","x-stream-index":"015"}},"required":["name","max_message_length","automod","automod_behavior"],"title":"CreateChannelTypeRequest","type":"object"},"CreateChannelTypeResponse":{"nullable":true,"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.001.026"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.001.021"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.001.022"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.001.027"},"blocklist":{"type":"string","x-stream-index":"001.001.023"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.001.024"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.001.025"},"commands":{"items":{"type":"string"},"type":"array","x-stream-index":"001.003"},"connect_events":{"type":"boolean","x-stream-index":"001.001.004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002.003"},"custom_events":{"type":"boolean","x-stream-index":"001.001.012"},"duration":{"type":"string","x-stream-index":"004.001"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"003"},"mark_messages_pending":{"type":"boolean","x-stream-index":"001.001.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"001.001.020"},"mutes":{"type":"boolean","x-stream-index":"001.001.009"},"name":{"type":"string","x-stream-index":"001.001.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"001.001.028"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"001.001.029"},"permissions":{"items":{"$ref":"#/components/schemas/PolicyRequest"},"type":"array","x-stream-index":"002"},"polls":{"type":"boolean","x-stream-index":"001.001.016"},"push_notifications":{"type":"boolean","x-stream-index":"001.001.013"},"quotes":{"type":"boolean","x-stream-index":"001.001.008"},"reactions":{"type":"boolean","x-stream-index":"001.001.006"},"read_events":{"type":"boolean","x-stream-index":"001.001.003"},"reminders":{"type":"boolean","x-stream-index":"001.001.014"},"replies":{"type":"boolean","x-stream-index":"001.001.007"},"search":{"type":"boolean","x-stream-index":"001.001.005"},"shared_locations":{"type":"boolean","x-stream-index":"001.001.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.001.030"},"typing_events":{"type":"boolean","x-stream-index":"001.001.002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.002.004"},"uploads":{"type":"boolean","x-stream-index":"001.001.010"},"url_enrichment":{"type":"boolean","x-stream-index":"001.001.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"001.001.017"}},"required":["name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","created_at","updated_at","commands","permissions","grants","duration"],"type":"object"},"CreateCommandRequest":{"description":"Create a new command","nullable":true,"properties":{"args":{"description":"Arguments help text, shown in commands auto-completion","maxLength":255,"title":"Arguments","type":"string","x-stream-index":"003"},"description":{"description":"Description, shown in commands auto-completion","maxLength":255,"title":"Description","type":"string","x-stream-index":"002"},"name":{"description":"Unique command name","maxLength":255,"minLength":1,"title":"Name","type":"string","x-stream-index":"001"},"set":{"description":"Set name used for grouping commands","maxLength":255,"title":"Set","type":"string","x-stream-index":"004"}},"required":["name","description"],"title":"CreateCommandRequest","type":"object"},"CreateCommandResponse":{"nullable":true,"properties":{"command":{"$ref":"#/components/schemas/Command","description":"Command object","title":"Command","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["duration"],"title":"CreateCommandResponse","type":"object"},"CreateDeviceRequest":{"description":"Create device request","nullable":true,"properties":{"id":{"description":"Device ID","maxLength":255,"minLength":1,"title":"ID","type":"string","x-stream-index":"001"},"push_provider":{"description":"Push provider","enum":["firebase","apn","huawei","xiaomi"],"title":"PushProvider","type":"string","x-stream-index":"002"},"push_provider_name":{"description":"Push provider name","title":"PushProviderName","type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"005.002"},"user_id":{"description":"**Server-side only**. User ID which server acts upon","title":"User ID","type":"string","x-stream-index":"005.001"},"voip_token":{"description":"When true the token is for Apple VoIP push notifications","title":"VoipToken","type":"boolean","x-stream-index":"004"}},"required":["id","push_provider"],"title":"CreateDeviceRequest","type":"object"},"CreateExternalStorageRequest":{"description":"Create external storage","nullable":true,"properties":{"aws_s3":{"$ref":"#/components/schemas/S3Request","description":"Only required if you want to create an Amazon S3 storage","title":"AwsS3","x-stream-index":"003.004"},"azure_blob":{"$ref":"#/components/schemas/AzureRequest","description":"Only required if you want to create an Azure Blob Storage","title":"AzureBlob","x-stream-index":"003.006"},"bucket":{"description":"The name of the bucket on the service provider","title":"Bucket","type":"string","x-stream-index":"003.002"},"gcs_credentials":{"type":"string","x-stream-index":"003.005"},"name":{"description":"The name of the provider, this must be unique","title":"Name","type":"string","x-stream-index":"001"},"path":{"description":"The path prefix to use for storing files","title":"Path","type":"string","x-stream-index":"003.003"},"storage_type":{"description":"The type of storage to use","enum":["s3","gcs","abs"],"title":"StorageType","type":"string","x-stream-index":"003.001"}},"required":["name","storage_type","bucket"],"title":"CreateExternalStorageRequest","type":"object"},"CreateExternalStorageResponse":{"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"},"CreateGuestRequest":{"nullable":true,"properties":{"user":{"$ref":"#/components/schemas/UserRequest","description":"User object which server acts upon","title":"User","x-stream-index":"001"}},"required":["user"],"type":"object"},"CreateGuestResponse":{"nullable":true,"properties":{"access_token":{"description":"the access token to authenticate the user","title":"Access token","type":"string","x-stream-index":"002"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User object which server acts upon","title":"User","x-stream-index":"001"}},"required":["user","access_token","duration"],"type":"object"},"CreateImportRequest":{"nullable":true,"properties":{"mode":{"enum":["insert","upsert"],"type":"string","x-stream-index":"002"},"path":{"type":"string","x-stream-index":"001"}},"required":["path","mode"],"type":"object"},"CreateImportResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"import_task":{"$ref":"#/components/schemas/ImportTask","x-stream-index":"001"}},"required":["duration"],"title":"Response","type":"object"},"CreateImportURLRequest":{"nullable":true,"properties":{"filename":{"type":"string","x-stream-index":"001"}},"type":"object"},"CreateImportURLResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"path":{"type":"string","x-stream-index":"001"},"upload_url":{"type":"string","x-stream-index":"002"}},"required":["path","upload_url","duration"],"title":"Response","type":"object"},"CreatePollOptionRequest":{"nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"003"},"text":{"description":"Option text","title":"string","type":"string","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"required":["text"],"type":"object"},"CreatePollRequest":{"description":"Contains all information needed to create a new poll","nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"011"},"allow_answers":{"description":"Indicates whether users can suggest user defined answers","title":"Allow answers","type":"boolean","x-stream-index":"009"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"008"},"description":{"description":"A description of the poll","title":"Description","type":"string","x-stream-index":"003"},"enforce_unique_vote":{"description":"Indicates whether users can cast multiple votes","title":"Multiple choice","type":"boolean","x-stream-index":"006"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"is_closed":{"description":"Indicates whether the poll is open for voting","title":"Is closed","type":"boolean","x-stream-index":"010"},"max_votes_allowed":{"description":"Indicates the maximum amount of votes a user can cast","format":"int32","maximum":10,"title":"Maximum votes allowed","type":"integer","x-stream-index":"007"},"name":{"description":"The name of the poll","title":"Name","type":"string","x-stream-index":"002"},"options":{"items":{"$ref":"#/components/schemas/PollOptionInput"},"maximum":100,"type":"array","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"012.002"},"user_id":{"type":"string","x-stream-index":"012.001"},"voting_visibility":{"enum":["anonymous","public"],"type":"string","x-stream-index":"005"}},"required":["name"],"title":"Create Poll Request","type":"object"},"CreateReminderRequest":{"nullable":true,"properties":{"remind_at":{"format":"date-time","type":"number","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"type":"object"},"CreateRoleRequest":{"nullable":true,"properties":{"name":{"description":"Role name","maxLength":64,"title":"Name","type":"string","x-stream-index":"001"}},"required":["name"],"type":"object"},"CreateRoleResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"role":{"$ref":"#/components/schemas/Role","x-stream-index":"002"}},"required":["duration","role"],"title":"Response","type":"object"},"CustomActionRequest":{"properties":{"id":{"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"type":"object"},"CustomCheckFlag":{"properties":{"custom":{"additionalProperties":{},"description":"Additional metadata for the flag","title":"Custom","type":"object","x-stream-index":"003"},"labels":{"description":"Labels from various moderation sources","items":{"type":"string"},"title":"Labels","type":"array","x-stream-index":"004"},"reason":{"description":"Optional explanation for the flag","title":"Reason","type":"string","x-stream-index":"002"},"type":{"description":"Type of check (custom_check_text, custom_check_image, custom_check_video)","maxLength":255,"title":"Type","type":"string","x-stream-index":"001"}},"required":["type"],"type":"object"},"CustomCheckRequest":{"nullable":true,"properties":{"entity_creator_id":{"description":"ID of the user who created the entity (required for non-message entities)","title":"Entity Creator ID","type":"string","x-stream-index":"003"},"entity_id":{"description":"Unique identifier of the entity","title":"Entity ID","type":"string","x-stream-index":"002"},"entity_type":{"description":"Type of entity to perform custom check on","title":"Entity Type","type":"string","x-stream-index":"001"},"flags":{"description":"List of custom check flags (1-10 flags required)","items":{"$ref":"#/components/schemas/CustomCheckFlag"},"maximum":10,"minimum":1,"title":"Flags","type":"array","x-stream-index":"005"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content to be checked (required for non-message entities)","title":"Moderation Payload","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"006.002"},"user_id":{"type":"string","x-stream-index":"006.001"}},"required":["entity_type","entity_id","flags"],"type":"object"},"CustomCheckResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"004.001"},"id":{"description":"Unique identifier of the custom check","title":"ID","type":"string","x-stream-index":"001"},"item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"Review queue item details","title":"Item","x-stream-index":"002"},"status":{"description":"Status of the custom check","title":"Status","type":"string","x-stream-index":"003"}},"required":["id","status","duration"],"type":"object"},"CustomVideoEvent":{"description":"A custom event, this event is used to send custom events to other participants in the call.","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"003"},"type":{"default":"custom","description":"The type of event, \"custom\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"004"}},"required":["type","created_at","call_cid","custom","user"],"title":"CustomVideoEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"DailyAggregateCallDurationReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/CallDurationReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateCallParticipantCountReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/CallParticipantCountReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateCallsPerDayReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/CallsPerDayReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateQualityScoreReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/QualityScoreReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateSDKUsageReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/SDKUsageReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateUserFeedbackReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/UserFeedbackReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"Data":{"properties":{"id":{"type":"string","x-stream-index":"001"}},"required":["id"],"type":"object"},"DataDogInfo":{"properties":{"api_key":{"type":"string","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"003"},"site":{"type":"string","x-stream-index":"002"}},"type":"object"},"DeactivateUserRequest":{"nullable":true,"properties":{"created_by_id":{"description":"ID of the user who deactivated the user","title":"Created by ID","type":"string","x-stream-index":"003"},"mark_messages_deleted":{"description":"Makes messages appear to be deleted","title":"Mark messages deleted","type":"boolean","x-stream-index":"002"}},"type":"object"},"DeactivateUserResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Deactivated user object","title":"User","x-stream-index":"001"}},"required":["duration"],"type":"object"},"DeactivateUsersRequest":{"description":"Deactivate users request","nullable":true,"properties":{"created_by_id":{"description":"ID of the user who deactivated the users","title":"Created by ID","type":"string","x-stream-index":"003"},"mark_channels_deleted":{"type":"boolean","x-stream-index":"004"},"mark_messages_deleted":{"description":"Makes messages appear to be deleted","title":"Mark messages deleted","type":"boolean","x-stream-index":"002"},"user_ids":{"description":"User IDs to deactivate","items":{"type":"string"},"maximum":100,"minimum":1,"title":"User IDs","type":"array","x-stream-index":"001"}},"required":["user_ids"],"title":"DeactivateUsersRequest","type":"object"},"DeactivateUsersResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"task_id":{"type":"string","x-stream-index":"001"}},"required":["task_id","duration"],"title":"Response","type":"object"},"DeleteActivityRequest":{"properties":{"hard_delete":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"DeleteCallRequest":{"description":"DeleteCallRequest is the payload for deleting a call.","nullable":true,"properties":{"hard":{"description":"if true the call will be hard deleted along with all related data","title":"Hard","type":"boolean","x-stream-index":"001"}},"title":"DeleteCallRequest","type":"object"},"DeleteCallResponse":{"description":"DeleteCallResponse is the payload for deleting a call.","nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","title":"Call","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"task_id":{"title":"TaskID","type":"string","x-stream-index":"002"}},"required":["call","duration"],"title":"DeleteCallResponse","type":"object"},"DeleteChannelResponse":{"description":"Basic response information","nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"Response","type":"object"},"DeleteChannelsRequest":{"nullable":true,"properties":{"cids":{"description":"All channels that should be deleted","items":{"type":"string"},"maximum":100,"minimum":1,"title":"Channels CID","type":"array","x-stream-index":"001"},"hard_delete":{"description":"Specify if channels and all ressources should be hard deleted","title":"Hard delete","type":"boolean","x-stream-index":"002"}},"required":["cids"],"type":"object"},"DeleteChannelsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"result":{"additionalProperties":{"$ref":"#/components/schemas/DeleteChannelsResultResponse"},"description":"Map of channel IDs and their deletion results","title":"Result","type":"object","x-stream-index":"001"},"task_id":{"type":"string","x-stream-index":"002"}},"required":["duration"],"type":"object"},"DeleteChannelsResultResponse":{"nullable":true,"properties":{"error":{"type":"string","x-stream-index":"002"},"status":{"type":"string","x-stream-index":"001"}},"required":["status"],"type":"object"},"DeleteCommandResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"name":{"description":"Command name","title":"Name","type":"string","x-stream-index":"001"}},"required":["name","duration"],"title":"DeleteCommandResponse","type":"object"},"DeleteExternalStorageResponse":{"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"},"DeleteMessageRequest":{"properties":{"hard_delete":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"DeleteMessageResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001"}},"required":["message","duration"],"title":"Response","type":"object"},"DeleteModerationConfigResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"DeleteModerationTemplateResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"DeleteReactionRequest":{"properties":{"hard_delete":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"DeleteReactionResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001"},"reaction":{"$ref":"#/components/schemas/ReactionResponse","x-stream-index":"002"}},"required":["message","reaction","duration"],"title":"Response","type":"object"},"DeleteRecordingResponse":{"description":"Response for DeleteRecording","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"DeleteRecordingResponse","type":"object"},"DeleteReminderResponse":{"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"},"DeleteSegmentTargetsRequest":{"nullable":true,"properties":{"target_ids":{"description":"Target IDs","items":{"type":"string"},"maximum":100,"minimum":1,"title":"[]string","type":"array","x-stream-index":"002"}},"required":["target_ids"],"type":"object"},"DeleteTranscriptionResponse":{"description":"DeleteTranscriptionResponse is the payload for deleting a transcription.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"DeleteTranscriptionResponse","type":"object"},"DeleteUserRequest":{"properties":{"delete_conversation_channels":{"type":"boolean","x-stream-index":"003"},"delete_feeds_content":{"type":"boolean","x-stream-index":"004"},"hard_delete":{"type":"boolean","x-stream-index":"001"},"mark_messages_deleted":{"type":"boolean","x-stream-index":"002"}},"type":"object"},"DeleteUsersRequest":{"nullable":true,"properties":{"calls":{"description":"Calls delete mode.\nAffected calls are those that include exactly two members, one of whom is the user being deleted.\n\n* null or empty string - doesn't delete any calls\n* soft - marks user's calls and their related data as deleted (soft-delete)\n* hard - deletes user's calls and their data completely (hard-delete)\n","enum":["soft","hard"],"title":"Delete User's calls","type":"string","x-stream-index":"001.002.004"},"conversations":{"description":"Conversation channels delete mode.\nConversation channel is any channel which only has two members one of which is the user being deleted.\n\n* null or empty string - doesn't delete any conversation channels\n* soft - marks all conversation channels as deleted (same effect as Delete Channels with 'hard' option disabled)\n* hard - deletes channel and all its data completely including messages (same effect as Delete Channels with 'hard' option enabled)\n","enum":["soft","hard"],"title":"Delete Conversations","type":"string","x-stream-index":"001.002.003"},"files":{"description":"Delete user files.\n* false or empty string - doesn't delete any files\n* true - deletes all files uploaded by the user, including images and attachments.\n","title":"Delete User's files","type":"boolean","x-stream-index":"001.002.005"},"messages":{"description":"Message delete mode.\n\n* null or empty string - doesn't delete user messages\n* soft - marks all user messages as deleted without removing any related message data\n* pruning - marks all user messages as deleted, nullifies message information and removes some message data such as reactions and flags\n* hard - deletes messages completely with all related information\n","enum":["soft","pruning","hard"],"title":"Delete Messages","type":"string","x-stream-index":"001.002.002"},"new_call_owner_id":{"type":"string","x-stream-index":"001.002.007"},"new_channel_owner_id":{"type":"string","x-stream-index":"001.002.006"},"user":{"description":"User delete mode.\n\n* soft - marks user as deleted and retains all user data\n* pruning - marks user as deleted and nullifies user information\n* hard - deletes user completely. Requires 'hard' option for messages and conversations as well\n","enum":["soft","pruning","hard"],"title":"Delete User","type":"string","x-stream-index":"001.002.001"},"user_ids":{"description":"IDs of users to delete","items":{"type":"string"},"maximum":100,"minimum":1,"title":"User IDs","type":"array","x-stream-index":"001.001"}},"required":["user_ids"],"type":"object"},"DeleteUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"task_id":{"description":"ID of the task to delete users","title":"Task ID","type":"string","x-stream-index":"001"}},"required":["task_id","duration"],"type":"object"},"Device":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"disabled":{"type":"boolean","x-stream-index":"002.003"},"disabled_reason":{"type":"string","x-stream-index":"002.004"},"id":{"type":"string","x-stream-index":"002.001.004"},"push_provider":{"enum":["firebase","apn","huawei","xiaomi"],"type":"string","x-stream-index":"002.001.001"},"push_provider_name":{"type":"string","x-stream-index":"002.001.003"},"user_id":{"type":"string","x-stream-index":"004"},"voip":{"type":"boolean","x-stream-index":"002.001.005"}},"required":["push_provider","id","created_at","user_id"],"type":"object"},"DeviceDataResponse":{"properties":{"name":{"type":"string","x-stream-index":"001"},"version":{"type":"string","x-stream-index":"002"}},"type":"object"},"DeviceErrorInfo":{"properties":{"error_message":{"type":"string","x-stream-index":"003"},"provider":{"type":"string","x-stream-index":"001"},"provider_name":{"type":"string","x-stream-index":"002"}},"required":["provider","provider_name","error_message"],"type":"object"},"DeviceResponse":{"description":"Response for Device","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"004"},"disabled":{"description":"Whether device is disabled or not","title":"Disabled","type":"boolean","x-stream-index":"005"},"disabled_reason":{"description":"Reason explaining why device had been disabled","title":"Reason","type":"string","x-stream-index":"006"},"id":{"description":"Device ID","title":"ID","type":"string","x-stream-index":"003"},"push_provider":{"description":"Push provider","title":"PushProvider","type":"string","x-stream-index":"001"},"push_provider_name":{"description":"Push provider name","title":"PushProviderName","type":"string","x-stream-index":"002"},"user_id":{"description":"User ID","title":"UserID","type":"string","x-stream-index":"008"},"voip":{"description":"When true the token is for Apple VoIP push notifications","title":"Voip","type":"boolean","x-stream-index":"007"}},"required":["push_provider","id","created_at","user_id"],"title":"DeviceResponse","type":"object"},"DraftPayloadResponse":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"html":{"type":"string","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"001"},"mentioned_users":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"008"},"mml":{"type":"string","x-stream-index":"003"},"parent_id":{"type":"string","x-stream-index":"005"},"poll_id":{"type":"string","x-stream-index":"013"},"quoted_message_id":{"type":"string","x-stream-index":"009"},"show_in_channel":{"type":"boolean","x-stream-index":"006"},"silent":{"type":"boolean","x-stream-index":"012"},"text":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"011"}},"required":["id","text","custom"],"type":"object"},"DraftResponse":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003"},"channel_cid":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"message":{"$ref":"#/components/schemas/DraftPayloadResponse","x-stream-index":"001"},"parent_id":{"type":"string","x-stream-index":"004"},"parent_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"005"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"006"}},"required":["message","channel_cid","created_at"],"type":"object"},"EdgeResponse":{"properties":{"continent_code":{"type":"string","x-stream-index":"007.003"},"country_iso_code":{"type":"string","x-stream-index":"007.002"},"green":{"format":"int32","type":"integer","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"latency_test_url":{"type":"string","x-stream-index":"002"},"latitude":{"format":"float","type":"number","x-stream-index":"006.001"},"longitude":{"format":"float","type":"number","x-stream-index":"006.002"},"red":{"format":"int32","type":"integer","x-stream-index":"005"},"subdivision_iso_code":{"type":"string","x-stream-index":"007.001"},"yellow":{"format":"int32","type":"integer","x-stream-index":"004"}},"required":["id","latency_test_url","green","yellow","red","latitude","longitude","subdivision_iso_code","country_iso_code","continent_code"],"type":"object"},"EgressHLSResponse":{"properties":{"playlist_url":{"type":"string","x-stream-index":"001"},"status":{"type":"string","x-stream-index":"002"}},"required":["playlist_url","status"],"type":"object"},"EgressRTMPResponse":{"properties":{"name":{"type":"string","x-stream-index":"001"},"started_at":{"format":"date-time","type":"number","x-stream-index":"004"},"stream_key":{"type":"string","x-stream-index":"003"},"stream_url":{"type":"string","x-stream-index":"002"}},"required":["name","started_at"],"type":"object"},"EgressResponse":{"properties":{"broadcasting":{"type":"boolean","x-stream-index":"001"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordingResponse","x-stream-index":"004"},"hls":{"$ref":"#/components/schemas/EgressHLSResponse","x-stream-index":"002"},"rtmps":{"items":{"$ref":"#/components/schemas/EgressRTMPResponse"},"type":"array","x-stream-index":"003"}},"required":["broadcasting","rtmps"],"type":"object"},"EgressTaskConfig":{"properties":{"egress_user":{"$ref":"#/components/schemas/EgressUser","x-stream-index":"008"},"frame_recording_egress_config":{"$ref":"#/components/schemas/FrameRecordingEgressConfig","x-stream-index":"009"},"hls_egress_config":{"$ref":"#/components/schemas/HLSEgressConfig","x-stream-index":"007"},"recording_egress_config":{"$ref":"#/components/schemas/RecordingEgressConfig","x-stream-index":"006"},"rtmp_egress_config":{"$ref":"#/components/schemas/RTMPEgressConfig","x-stream-index":"004"},"stt_egress_config":{"$ref":"#/components/schemas/STTEgressConfig","x-stream-index":"005"}},"type":"object"},"EgressUser":{"properties":{"token":{"type":"string","x-stream-index":"004"}},"type":"object"},"EndCallRequest":{"description":"Request for ending a call","nullable":true,"title":"EndCallRequest","type":"object"},"EndCallResponse":{"description":"Response for ending a call","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"EndCallResponse","type":"object"},"EnrichedActivity":{"properties":{"actor":{"$ref":"#/components/schemas/Data","x-stream-index":"002"},"foreign_id":{"type":"string","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"latest_reactions":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"013"},"object":{"$ref":"#/components/schemas/Data","x-stream-index":"004"},"origin":{"$ref":"#/components/schemas/Data","x-stream-index":"008"},"own_reactions":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"012"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"011"},"score":{"format":"float","type":"number","x-stream-index":"010"},"target":{"$ref":"#/components/schemas/Data","x-stream-index":"006"},"to":{"items":{"type":"string"},"type":"array","x-stream-index":"009"},"verb":{"type":"string","x-stream-index":"003"}},"type":"object"},"EnrichedReaction":{"nullable":true,"properties":{"activity_id":{"type":"string","x-stream-index":"003"},"children_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"010"},"created_at":{"$ref":"#/components/schemas/Time","x-stream-index":"012"},"data":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"kind":{"type":"string","x-stream-index":"002"},"latest_children":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"008"},"own_children":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"009"},"parent":{"type":"string","x-stream-index":"007"},"target_feeds":{"items":{"type":"string"},"type":"array","x-stream-index":"006"},"updated_at":{"$ref":"#/components/schemas/Time","x-stream-index":"013"},"user":{"$ref":"#/components/schemas/Data","x-stream-index":"011"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["kind","activity_id","user_id"],"type":"object"},"EntityCreator":{"properties":{"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"001.046"},"ban_count":{"format":"int32","type":"integer","x-stream-index":"002"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"001.017"},"banned":{"type":"boolean","x-stream-index":"001.016"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.013"},"deleted_content_count":{"format":"int32","type":"integer","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"001.023"},"language":{"type":"string","x-stream-index":"001.035"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"001.022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"001.026"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.042"},"role":{"type":"string","x-stream-index":"001.004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.005"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.009"}},"required":["id","role","teams_role","custom","banned","online","ban_count","deleted_content_count"],"type":"object"},"EntityCreatorResponse":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.001.018"},"ban_count":{"description":"Number of minor actions performed on the user","format":"int32","title":"Ban Count","type":"integer","x-stream-index":"002"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"001.003"},"banned":{"type":"boolean","x-stream-index":"001.001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.001.017"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.001.016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.001.011"},"deleted_content_count":{"description":"Number of major actions performed on the user","format":"int32","title":"Deleted Content Count","type":"integer","x-stream-index":"003"},"devices":{"items":{"$ref":"#/components/schemas/DeviceResponse"},"type":"array","x-stream-index":"001.006"},"flagged_count":{"description":"Number of flag actions performed on the user","format":"int32","title":"Flagged Count","type":"integer","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001.001.001"},"image":{"type":"string","x-stream-index":"001.001.003"},"invisible":{"type":"boolean","x-stream-index":"001.007"},"language":{"type":"string","x-stream-index":"001.001.005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"001.001.014"},"name":{"type":"string","x-stream-index":"001.001.002"},"online":{"type":"boolean","x-stream-index":"001.001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"001.005"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettingsResponse","x-stream-index":"001.004"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.001.015"},"role":{"type":"string","x-stream-index":"001.001.006"},"shadow_banned":{"type":"boolean","x-stream-index":"001.002"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.001.008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids","shadow_banned","invisible","ban_count","deleted_content_count","flagged_count"],"type":"object"},"ErrorResult":{"properties":{"stacktrace":{"type":"string","x-stream-index":"003"},"type":{"type":"string","x-stream-index":"001"},"version":{"type":"string","x-stream-index":"004"}},"required":["type","description"],"type":"object"},"EventHook":{"nullable":true,"properties":{"callback":{"$ref":"#/components/schemas/AsyncModerationCallbackConfig","x-stream-index":"018.001.002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"019"},"enabled":{"type":"boolean","x-stream-index":"003"},"event_types":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"hook_type":{"type":"string","x-stream-index":"002"},"id":{"type":"string","x-stream-index":"001"},"sns_auth_type":{"type":"string","x-stream-index":"014"},"sns_key":{"type":"string","x-stream-index":"015"},"sns_region":{"type":"string","x-stream-index":"013"},"sns_role_arn":{"type":"string","x-stream-index":"017"},"sns_secret":{"type":"string","x-stream-index":"016"},"sns_topic_arn":{"type":"string","x-stream-index":"012"},"sqs_auth_type":{"type":"string","x-stream-index":"008"},"sqs_key":{"type":"string","x-stream-index":"009"},"sqs_queue_url":{"type":"string","x-stream-index":"006"},"sqs_region":{"type":"string","x-stream-index":"007"},"sqs_role_arn":{"type":"string","x-stream-index":"011"},"sqs_secret":{"type":"string","x-stream-index":"010"},"timeout_ms":{"format":"int32","type":"integer","x-stream-index":"018.001.001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"020"},"webhook_url":{"type":"string","x-stream-index":"005"}},"type":"object"},"EventNotificationSettings":{"properties":{"apns":{"$ref":"#/components/schemas/APNS","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"fcm":{"$ref":"#/components/schemas/FCM","x-stream-index":"003"}},"required":["enabled","apns","fcm"],"type":"object"},"EventRequest":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"parent_id":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"required":["type"],"type":"object"},"EventResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"event":{"$ref":"#/components/schemas/WSEvent","x-stream-index":"001"}},"required":["event","duration"],"title":"Response","type":"object"},"ExportChannelsRequest":{"nullable":true,"properties":{"channels":{"description":"Export options for channels","items":{"$ref":"#/components/schemas/ChannelExport"},"maximum":100,"minimum":1,"title":"Channels","type":"array","x-stream-index":"002.001"},"clear_deleted_message_text":{"description":"Set if deleted message text should be cleared","title":"Clear deleted message text","type":"boolean","x-stream-index":"002.002"},"export_users":{"type":"boolean","x-stream-index":"002.005"},"include_soft_deleted_channels":{"description":"Set if you want to include deleted channels","title":"Include soft deleted channels","type":"boolean","x-stream-index":"002.004"},"include_truncated_messages":{"description":"Set if you want to include truncated messages","title":"Include truncated messages","type":"boolean","x-stream-index":"002.003"},"version":{"description":"Export version","title":"Version","type":"string","x-stream-index":"001"}},"required":["channels"],"type":"object"},"ExportChannelsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"task_id":{"description":"ID of the task to export channels","title":"Task ID","type":"string","x-stream-index":"001"}},"required":["task_id","duration"],"type":"object"},"ExportUserResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"004.001"},"messages":{"description":"List of exported messages","items":{"$ref":"#/components/schemas/MessageResponse"},"title":"Messages","type":"array","x-stream-index":"002"},"reactions":{"description":"List of exported reactions","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Reactions","type":"array","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Exported user object","title":"User","x-stream-index":"001"}},"required":["duration"],"type":"object"},"ExportUsersRequest":{"nullable":true,"properties":{"user_ids":{"items":{"type":"string"},"maximum":25,"minimum":1,"type":"array","x-stream-index":"001"}},"required":["user_ids"],"type":"object"},"ExportUsersResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"task_id":{"type":"string","x-stream-index":"001"}},"required":["task_id","duration"],"title":"Response","type":"object"},"ExternalStorage":{"properties":{"abs_account_name":{"type":"string","x-stream-index":"011"},"abs_client_id":{"type":"string","x-stream-index":"013"},"abs_client_secret":{"type":"string","x-stream-index":"014"},"abs_tenant_id":{"type":"string","x-stream-index":"012"},"bucket":{"type":"string","x-stream-index":"005"},"gcs_credentials":{"type":"string","x-stream-index":"010"},"path":{"type":"string","x-stream-index":"006"},"s3_api_key":{"type":"string","x-stream-index":"007"},"s3_custom_endpoint":{"type":"string","x-stream-index":"016"},"s3_region":{"type":"string","x-stream-index":"009"},"s3_secret_key":{"type":"string","x-stream-index":"008"},"storage_name":{"type":"string","x-stream-index":"015"},"storage_type":{"type":"integer","x-stream-index":"004"}},"type":"object"},"ExternalStorageResponse":{"properties":{"bucket":{"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"path":{"type":"string","x-stream-index":"004"},"type":{"enum":["s3","gcs","abs"],"type":"string","x-stream-index":"002"}},"required":["name","type","bucket","path"],"type":"object"},"FCM":{"properties":{"data":{"additionalProperties":{},"type":"object","x-stream-index":"001"}},"type":"object"},"FeedsModerationTemplateConfig":{"properties":{"config_key":{"type":"string","x-stream-index":"002"},"data_types":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001"}},"required":["data_types","config_key"],"type":"object"},"Field":{"nullable":true,"properties":{"short":{"type":"boolean","x-stream-index":"003"},"title":{"type":"string","x-stream-index":"001"},"value":{"type":"string","x-stream-index":"002"}},"required":["title","value","short"],"type":"object"},"FileUploadConfig":{"properties":{"allowed_file_extensions":{"items":{"type":"string"},"type":"array","x-stream-index":"001"},"allowed_mime_types":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"blocked_file_extensions":{"items":{"type":"string"},"type":"array","x-stream-index":"002"},"blocked_mime_types":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"size_limit":{"format":"int32","maximum":104857600,"minimum":0,"type":"integer","x-stream-index":"005"}},"required":["size_limit"],"type":"object"},"FileUploadRequest":{"nullable":true,"properties":{"file":{"description":"file field","title":"File","type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/OnlyUserID","description":"user for the request **server side only**","title":"User","x-stream-index":"002"}},"type":"object"},"FileUploadResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"file":{"description":"URL to the uploaded asset. Should be used to put to `asset_url` attachment field","title":"File","type":"string","x-stream-index":"001"},"thumb_url":{"description":"URL of the file thumbnail for supported file formats. Should be put to `thumb_url` attachment field","title":"Thumbnail URL","type":"string","x-stream-index":"002"}},"required":["duration"],"type":"object"},"FirebaseConfig":{"properties":{"Disabled":{"type":"boolean","writeOnly":true,"x-stream-index":"001"},"apn_template":{"type":"string","x-stream-index":"005"},"credentials_json":{"type":"string","x-stream-index":"006"},"data_template":{"type":"string","x-stream-index":"004"},"notification_template":{"type":"string","x-stream-index":"003"},"server_key":{"type":"string","x-stream-index":"002"}},"type":"object"},"FirebaseConfigFields":{"properties":{"apn_template":{"type":"string","x-stream-index":"004"},"credentials_json":{"type":"string","x-stream-index":"006"},"data_template":{"type":"string","x-stream-index":"003"},"enabled":{"type":"boolean","x-stream-index":"001"},"notification_template":{"type":"string","x-stream-index":"002"},"server_key":{"type":"string","x-stream-index":"005"}},"required":["enabled"],"type":"object"},"Flag":{"description":"Contains information about flagged user or message","properties":{"approved_at":{"description":"Date of the approval","format":"date-time","title":"Approved at","type":"number","x-stream-index":"015"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"011"},"created_by_automod":{"type":"boolean","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"022"},"details":{"$ref":"#/components/schemas/FlagDetails","x-stream-index":"021"},"reason":{"type":"string","x-stream-index":"020"},"rejected_at":{"description":"Date of the rejection","format":"date-time","title":"Rejected at","type":"number","x-stream-index":"016"},"reviewed_at":{"description":"Date of the review","format":"date-time","title":"Reviewed at","type":"number","x-stream-index":"013"},"reviewed_by":{"type":"string","x-stream-index":"014"},"target_message":{"$ref":"#/components/schemas/Message","x-stream-index":"008"},"target_message_id":{"description":"ID of flagged message","title":"Target Message ID","type":"string","x-stream-index":"007"},"target_user":{"$ref":"#/components/schemas/User","description":"Flagged user","title":"User","x-stream-index":"010"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"012"},"user":{"$ref":"#/components/schemas/User","description":"User who flagged a message or a user","title":"User","x-stream-index":"006"}},"required":["created_by_automod","created_at","updated_at"],"title":"Flag","type":"object"},"FlagContentOptions":{"properties":{"reason":{"type":"string","x-stream-index":"001"}},"required":["reason"],"type":"object"},"FlagDetails":{"properties":{"Extra":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"002"},"automod":{"$ref":"#/components/schemas/AutomodDetails","x-stream-index":"001"},"original_text":{"type":"string","x-stream-index":"003"}},"required":["Extra","original_text"],"type":"object"},"FlagFeedback":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"005"},"labels":{"items":{"$ref":"#/components/schemas/Label"},"type":"array","x-stream-index":"006"},"message_id":{"type":"string","x-stream-index":"004"}},"required":["message_id","created_at","labels"],"type":"object"},"FlagMessageDetails":{"properties":{"pin_changed":{"type":"boolean","x-stream-index":"002"},"should_enrich":{"type":"boolean","x-stream-index":"003"},"skip_push":{"type":"boolean","x-stream-index":"004"},"updated_by_id":{"type":"string","x-stream-index":"001"}},"type":"object"},"FlagRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"description":"Additional metadata about the flag","title":"Custom","type":"object","x-stream-index":"006"},"entity_creator_id":{"description":"ID of the user who created the flagged entity","title":"Entity Creator ID","type":"string","x-stream-index":"003"},"entity_id":{"description":"Unique identifier of the entity being flagged","title":"Entity ID","type":"string","x-stream-index":"002"},"entity_type":{"description":"Type of entity being flagged (e.g., message, user)","title":"Entity Type","type":"string","x-stream-index":"001"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content being flagged","title":"Moderation Payload","x-stream-index":"005"},"reason":{"description":"Optional explanation for why the content is being flagged","maxLength":255,"title":"Reason","type":"string","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"007.002"},"user_id":{"type":"string","x-stream-index":"007.001"}},"required":["entity_type","entity_id"],"type":"object"},"FlagResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"item_id":{"description":"Unique identifier of the created moderation item","title":"Item ID","type":"string","x-stream-index":"001"}},"required":["item_id","duration"],"type":"object"},"FlagUpdatedEvent":{"nullable":true,"properties":{"CreatedBy":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"004"},"Message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"002"},"User":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"type":{"default":"flag.updated","type":"string","x-stream-index":"001.002"}},"required":["type","created_at","custom"],"title":"FlagUpdatedEvent","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"},"FlagUserOptions":{"properties":{"reason":{"type":"string","x-stream-index":"001"}},"required":["reason"],"type":"object"},"FrameRecordSettings":{"properties":{"capture_interval_in_seconds":{"format":"int32","maximum":60,"minimum":2,"type":"integer","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"},"quality":{"type":"string","x-stream-index":"002"}},"required":["mode","capture_interval_in_seconds"],"type":"object"},"FrameRecordingEgressConfig":{"properties":{"capture_interval_in_seconds":{"format":"int32","type":"integer","x-stream-index":"007"},"external_storage":{"$ref":"#/components/schemas/ExternalStorage","x-stream-index":"006"},"quality":{"$ref":"#/components/schemas/Quality","x-stream-index":"004"},"storage_name":{"type":"string","x-stream-index":"005"}},"type":"object"},"FrameRecordingResponse":{"properties":{"status":{"type":"string","x-stream-index":"001"}},"required":["status"],"type":"object"},"FrameRecordingSettingsRequest":{"properties":{"capture_interval_in_seconds":{"format":"int32","maximum":60,"minimum":2,"type":"integer","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"},"quality":{"enum":["360p","480p","720p","1080p","1440p"],"type":"string","x-stream-index":"002"}},"required":["mode","capture_interval_in_seconds"],"type":"object"},"FrameRecordingSettingsResponse":{"properties":{"capture_interval_in_seconds":{"format":"int32","maximum":60,"minimum":2,"type":"integer","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"},"quality":{"type":"string","x-stream-index":"002"}},"required":["mode","capture_interval_in_seconds"],"type":"object"},"FullUserResponse":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"015"},"banned":{"type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"014"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.011"},"devices":{"items":{"$ref":"#/components/schemas/DeviceResponse"},"type":"array","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001.001"},"image":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"005"},"language":{"type":"string","x-stream-index":"001.005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"001.014"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"012"},"mutes":{"items":{"$ref":"#/components/schemas/UserMuteResponse"},"type":"array","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"001.002"},"online":{"type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"003"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.015"},"role":{"type":"string","x-stream-index":"001.006"},"shadow_banned":{"type":"boolean","x-stream-index":"013"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"009"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"010"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"008"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"011"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","devices","invisible","mutes","channel_mutes","unread_count","total_unread_count","unread_channels","unread_threads","shadow_banned","blocked_user_ids"],"type":"object"},"GeofenceResponse":{"nullable":true,"properties":{"country_codes":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"description":{"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"type":{"type":"string","x-stream-index":"002"}},"required":["name"],"type":"object"},"GeofenceSettings":{"properties":{"names":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"required":["names"],"type":"object"},"GeofenceSettingsRequest":{"properties":{"names":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"type":"object"},"GeofenceSettingsResponse":{"properties":{"names":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"required":["names"],"type":"object"},"GetActiveCallsStatusResponse":{"description":"Response containing active calls status information","nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"},"end_time":{"description":"End time of the status period","format":"date-time","title":"time.Time","type":"number","x-stream-index":"003"},"metrics":{"$ref":"#/components/schemas/ActiveCallsMetrics","description":"Detailed metrics","title":"*ActiveCallsMetrics","x-stream-index":"005"},"start_time":{"description":"Start time of the status period","format":"date-time","title":"time.Time","type":"number","x-stream-index":"002"},"summary":{"$ref":"#/components/schemas/ActiveCallsSummary","description":"Summary of active calls","title":"*ActiveCallsSummary","x-stream-index":"004"}},"required":["duration","start_time","end_time"],"title":"GetActiveCallsStatusResponse","type":"object"},"GetApplicationResponse":{"description":"Basic response information","nullable":true,"properties":{"app":{"$ref":"#/components/schemas/AppResponseFields","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["app","duration"],"title":"Response","type":"object"},"GetBlockListResponse":{"description":"Response for get block list","nullable":true,"properties":{"blocklist":{"$ref":"#/components/schemas/BlockListResponse","description":"Block list object","title":"BlockListResponse","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["duration"],"title":"GetBlockListResponse","type":"object","x-stream-docs-page-id":"get_block_list"},"GetBlockedUsersResponse":{"nullable":true,"properties":{"blocks":{"description":"Array of blocked user object","items":{"$ref":"#/components/schemas/BlockedUserResponse"},"title":"Blocks","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["blocks","duration"],"type":"object"},"GetCallReportResponse":{"description":"Basic response information","nullable":true,"properties":{"chat_activity":{"$ref":"#/components/schemas/ChatActivityStatsResponse","x-stream-index":"004"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"report":{"$ref":"#/components/schemas/ReportResponse","x-stream-index":"003"},"session_id":{"type":"string","x-stream-index":"002"},"video_reactions":{"items":{"$ref":"#/components/schemas/VideoReactionsResponse"},"type":"array","x-stream-index":"005"}},"required":["duration","session_id","report"],"title":"Response","type":"object"},"GetCallResponse":{"nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001.001"},"duration":{"type":"string","x-stream-index":"002.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001.002"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"001.004"}},"required":["call","members","own_capabilities","blocked_users","duration"],"title":"GetCallResponse","type":"object"},"GetCallTypeResponse":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.005"},"duration":{"type":"string","x-stream-index":"002.001"},"external_storage":{"type":"string","x-stream-index":"001.007"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"001.002"},"name":{"type":"string","x-stream-index":"001.001"},"notification_settings":{"$ref":"#/components/schemas/NotificationSettings","x-stream-index":"001.004"},"settings":{"$ref":"#/components/schemas/CallSettingsResponse","x-stream-index":"001.003"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.006"}},"required":["name","grants","settings","notification_settings","created_at","updated_at","duration"],"title":"GetCallTypeResponse","type":"object"},"GetCampaignResponse":{"description":"Basic response information","nullable":true,"properties":{"campaign":{"$ref":"#/components/schemas/CampaignResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"users":{"$ref":"#/components/schemas/PagerResponse","x-stream-index":"002"}},"required":["duration"],"title":"Response","type":"object"},"GetChannelTypeResponse":{"description":"Basic response information","nullable":true,"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"003.002.026"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"003.002.021"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.002.022"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"003.002.027"},"blocklist":{"type":"string","x-stream-index":"003.002.023"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.002.024"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"003.002.025"},"commands":{"items":{"$ref":"#/components/schemas/Command"},"type":"array","x-stream-index":"003.003"},"connect_events":{"type":"boolean","x-stream-index":"003.002.004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.001.003"},"custom_events":{"type":"boolean","x-stream-index":"003.002.012"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"004.001"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"002"},"mark_messages_pending":{"type":"boolean","x-stream-index":"003.002.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"003.002.020"},"mutes":{"type":"boolean","x-stream-index":"003.002.009"},"name":{"type":"string","x-stream-index":"003.002.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"003.002.028"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"003.002.029"},"permissions":{"items":{"$ref":"#/components/schemas/PolicyRequest"},"type":"array","x-stream-index":"001"},"polls":{"type":"boolean","x-stream-index":"003.002.016"},"push_notifications":{"type":"boolean","x-stream-index":"003.002.013"},"quotes":{"type":"boolean","x-stream-index":"003.002.008"},"reactions":{"type":"boolean","x-stream-index":"003.002.006"},"read_events":{"type":"boolean","x-stream-index":"003.002.003"},"reminders":{"type":"boolean","x-stream-index":"003.002.014"},"replies":{"type":"boolean","x-stream-index":"003.002.007"},"search":{"type":"boolean","x-stream-index":"003.002.005"},"shared_locations":{"type":"boolean","x-stream-index":"003.002.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"003.002.030"},"typing_events":{"type":"boolean","x-stream-index":"003.002.002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"003.001.004"},"uploads":{"type":"boolean","x-stream-index":"003.002.010"},"url_enrichment":{"type":"boolean","x-stream-index":"003.002.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"003.002.017"}},"required":["permissions","grants","created_at","updated_at","name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","commands","duration"],"title":"Response","type":"object"},"GetCommandResponse":{"nullable":true,"properties":{"args":{"type":"string","x-stream-index":"001.006"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.001"},"description":{"type":"string","x-stream-index":"001.005"},"duration":{"type":"string","x-stream-index":"002.001"},"name":{"type":"string","x-stream-index":"001.004"},"set":{"type":"string","x-stream-index":"001.007"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.002"}},"required":["name","description","args","set","duration"],"title":"GetCommandResponse","type":"object"},"GetConfigResponse":{"nullable":true,"properties":{"config":{"$ref":"#/components/schemas/ConfigResponse","description":"The retrieved moderation configuration","title":"Config","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["duration"],"type":"object"},"GetCustomPermissionResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"permission":{"$ref":"#/components/schemas/Permission","x-stream-index":"001"}},"required":["permission","duration"],"title":"Response","type":"object"},"GetDraftResponse":{"description":"Basic response information","nullable":true,"properties":{"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["draft","duration"],"title":"Response","type":"object"},"GetEdgesResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"edges":{"items":{"$ref":"#/components/schemas/EdgeResponse"},"type":"array","x-stream-index":"001"}},"required":["edges","duration"],"title":"Response","type":"object"},"GetImportResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"import_task":{"$ref":"#/components/schemas/ImportTask","x-stream-index":"001"}},"required":["duration"],"title":"Response","type":"object"},"GetManyMessagesResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.002.001"},"messages":{"description":"List of messages","items":{"$ref":"#/components/schemas/MessageResponse"},"title":"Messages","type":"array","x-stream-index":"001.001"}},"required":["messages","duration"],"type":"object"},"GetMessageResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageWithChannelResponse","x-stream-index":"001"},"pending_message_metadata":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"002"}},"required":["message","duration"],"title":"Response","type":"object"},"GetOGResponse":{"nullable":true,"properties":{"actions":{"items":{"$ref":"#/components/schemas/Action"},"type":"array","x-stream-index":"001.015"},"asset_url":{"description":"URL of detected video or audio","title":"Image URL","type":"string","x-stream-index":"001.017"},"author_icon":{"type":"string","x-stream-index":"001.007"},"author_link":{"description":"og:site","title":"Author Link","type":"string","x-stream-index":"001.006"},"author_name":{"description":"og:site_name","title":"Author Name","type":"string","x-stream-index":"001.005"},"color":{"type":"string","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.018"},"duration":{"type":"string","x-stream-index":"002.001"},"fallback":{"type":"string","x-stream-index":"001.002"},"fields":{"items":{"$ref":"#/components/schemas/Field"},"type":"array","x-stream-index":"001.016"},"footer":{"type":"string","x-stream-index":"001.013"},"footer_icon":{"type":"string","x-stream-index":"001.014"},"giphy":{"$ref":"#/components/schemas/Images","x-stream-index":"001.019"},"image_url":{"description":"URL of detected image","title":"Image URL","type":"string","x-stream-index":"001.011"},"og_scrape_url":{"description":"extracted url from the text","title":"OG Scrape URL","type":"string","x-stream-index":"001.020"},"original_height":{"format":"int32","type":"integer","x-stream-index":"001.022"},"original_width":{"format":"int32","type":"integer","x-stream-index":"001.021"},"pretext":{"type":"string","x-stream-index":"001.004"},"text":{"description":"og:description","title":"Text","type":"string","x-stream-index":"001.010"},"thumb_url":{"description":"URL of detected thumb image","title":"Image URL","type":"string","x-stream-index":"001.012"},"title":{"description":"og:title","title":"Title","type":"string","x-stream-index":"001.008"},"title_link":{"description":"og:url","title":"Title Link","type":"string","x-stream-index":"001.009"},"type":{"description":"Attachment type, could be empty, image, audio or video","title":"Type","type":"string","x-stream-index":"001.001"}},"required":["custom","duration"],"title":"Get OG Attachment","type":"object","x-stream-docs-page-id":"og"},"GetOrCreateCallRequest":{"nullable":true,"properties":{"data":{"$ref":"#/components/schemas/CallRequest","title":"ReadOnlyData","x-stream-index":"003"},"members_limit":{"format":"int32","maximum":100,"type":"integer","x-stream-index":"007"},"notify":{"description":"if provided it sends a notification event to the members for this call","title":"Notify","type":"boolean","x-stream-index":"005"},"ring":{"description":"if provided it sends a ring event to the members for this call","title":"Ring","type":"boolean","x-stream-index":"004"},"video":{"type":"boolean","x-stream-index":"006"}},"title":"GetOrCreateCallRequest","type":"object"},"GetOrCreateCallResponse":{"nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001.001"},"created":{"type":"boolean","x-stream-index":"002"},"duration":{"type":"string","x-stream-index":"003.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001.002"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"001.004"}},"required":["call","members","own_capabilities","blocked_users","created","duration"],"title":"GetOrCreateCallResponse","type":"object"},"GetPushTemplatesResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"templates":{"items":{"$ref":"#/components/schemas/PushTemplate"},"type":"array","x-stream-index":"002"}},"required":["duration","templates"],"title":"Response","type":"object"},"GetRateLimitsResponse":{"nullable":true,"properties":{"android":{"additionalProperties":{"$ref":"#/components/schemas/LimitInfo"},"description":"Map of endpoint rate limits for the Android platform","title":"Android","type":"object","x-stream-index":"002","x-stream-map":{"key":"endpoint","title":"Endpoint name","description":"The name of the endpoint for which the limits apply"}},"duration":{"type":"string","x-stream-index":"005.001"},"ios":{"additionalProperties":{"$ref":"#/components/schemas/LimitInfo"},"description":"Map of endpoint rate limits for the iOS platform","title":"iOS","type":"object","x-stream-index":"003","x-stream-map":{"key":"endpoint","title":"Endpoint name","description":"The name of the endpoint for which the limits apply"}},"server_side":{"additionalProperties":{"$ref":"#/components/schemas/LimitInfo"},"description":"Map of endpoint rate limits for the server-side platform","title":"Server-side","type":"object","x-stream-index":"001","x-stream-map":{"key":"endpoint","title":"Endpoint name","description":"The name of the endpoint for which the limits apply"}},"web":{"additionalProperties":{"$ref":"#/components/schemas/LimitInfo"},"description":"Map of endpoint rate limits for the web platform","title":"Web","type":"object","x-stream-index":"004","x-stream-map":{"key":"endpoint","title":"Endpoint name","description":"The name of the endpoint for which the limits apply"}}},"required":["duration"],"title":"Get Rate Limits Response","type":"object","x-stream-docs-page-id":"rate_limits"},"GetReactionsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"reactions":{"description":"List of reactions","items":{"$ref":"#/components/schemas/Reaction"},"title":"Reactions","type":"array","x-stream-index":"001"}},"required":["reactions","duration"],"type":"object"},"GetRepliesResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"messages":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","x-stream-index":"001"}},"required":["messages","duration"],"title":"Response","type":"object"},"GetReviewQueueItemResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"Current state of the review queue item","title":"Item","x-stream-index":"001"}},"required":["duration"],"type":"object"},"GetSegmentResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"segment":{"$ref":"#/components/schemas/SegmentResponse","description":"Segment","title":"SegmentResponse","x-stream-index":"001"}},"required":["duration"],"type":"object"},"GetTaskResponse":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.003"},"duration":{"type":"string","x-stream-index":"004.001"},"error":{"$ref":"#/components/schemas/ErrorResult","description":"Error produced by task","title":"Error","x-stream-index":"003"},"result":{"additionalProperties":{},"description":"Result produced by task after completion","title":"Result","type":"object","x-stream-index":"002"},"status":{"description":"Current status of task","title":"Status","type":"string","x-stream-index":"001.002"},"task_id":{"description":"ID of task","title":"Task ID","type":"string","x-stream-index":"001.001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.004"}},"required":["task_id","status","created_at","updated_at","duration"],"title":"Get Task Response","type":"object","x-stream-docs-page-id":"tasks"},"GetThreadResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"thread":{"$ref":"#/components/schemas/ThreadStateResponse","description":"Enriched thread state","title":"Thread","x-stream-index":"001"}},"required":["thread","duration"],"type":"object"},"GoLiveRequest":{"nullable":true,"properties":{"recording_storage_name":{"type":"string","x-stream-index":"005"},"start_closed_caption":{"type":"boolean","x-stream-index":"008"},"start_hls":{"type":"boolean","x-stream-index":"003"},"start_recording":{"type":"boolean","x-stream-index":"004"},"start_transcription":{"type":"boolean","x-stream-index":"007"},"transcription_storage_name":{"type":"string","x-stream-index":"006"}},"title":"GoLiveRequest","type":"object"},"GoLiveResponse":{"description":"Basic response information","nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["call","duration"],"title":"Response","type":"object"},"GoogleVisionConfig":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"GroupedStatsResponse":{"nullable":true,"properties":{"name":{"type":"string","x-stream-index":"001"},"unique":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["name","unique"],"type":"object"},"HLSEgressConfig":{"properties":{"composite_app_settings":{"$ref":"#/components/schemas/CompositeAppSettings","x-stream-index":"005"},"playlist_url":{"type":"string","x-stream-index":"007"},"qualities":{"items":{"$ref":"#/components/schemas/Quality"},"type":"array","x-stream-index":"004"},"start_unix_nano":{"format":"int64","type":"integer","x-stream-index":"006"}},"type":"object"},"HLSSettings":{"properties":{"auto_on":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"004"},"quality_tracks":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"required":["auto_on","enabled","quality_tracks"],"type":"object"},"HLSSettingsRequest":{"properties":{"auto_on":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"layout":{"$ref":"#/components/schemas/LayoutSettingsRequest","title":"LayoutSettings","x-stream-index":"004"},"quality_tracks":{"items":{"type":"string"},"maximum":3,"minimum":1,"type":"array","x-stream-index":"003"}},"required":["quality_tracks"],"title":"HLSSettingsRequest","type":"object"},"HLSSettingsResponse":{"description":"HLSSettings is the payload for HLS settings","properties":{"auto_on":{"title":"Auto On","type":"boolean","x-stream-index":"001"},"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"002"},"layout":{"$ref":"#/components/schemas/LayoutSettingsResponse","title":"Layout","x-stream-index":"004"},"quality_tracks":{"items":{"type":"string"},"title":"Quality Tracks","type":"array","x-stream-index":"003"}},"required":["auto_on","enabled","quality_tracks","layout"],"title":"HLSSettingsResponse","type":"object"},"HarmConfig":{"properties":{"action_sequences":{"items":{"$ref":"#/components/schemas/ActionSequence"},"type":"array","x-stream-index":"001"},"severity":{"type":"integer","x-stream-index":"002"}},"required":["action_sequences","severity"],"type":"object"},"HideChannelRequest":{"nullable":true,"properties":{"clear_history":{"description":"Whether to clear message history of the channel or not","title":"Clear history","type":"boolean","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"type":"object"},"HideChannelResponse":{"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"},"HuaweiConfig":{"properties":{"Disabled":{"type":"boolean","writeOnly":true,"x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"secret":{"type":"string","x-stream-index":"002"}},"type":"object"},"HuaweiConfigFields":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"id":{"type":"string","x-stream-index":"002"},"secret":{"type":"string","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"ImageContentParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"type":"object"},"ImageData":{"properties":{"frames":{"type":"string","x-stream-index":"005"},"height":{"type":"string","x-stream-index":"003"},"size":{"type":"string","x-stream-index":"004"},"url":{"type":"string","x-stream-index":"001"},"width":{"type":"string","x-stream-index":"002"}},"required":["url","width","height","size","frames"],"type":"object"},"ImageRuleParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"required":["threshold","time_window"],"type":"object"},"ImageSize":{"properties":{"crop":{"description":"Crop mode","enum":["top","bottom","left","right","center"],"title":"Crop","type":"string","x-stream-index":"001"},"height":{"description":"Target image height","format":"int32","title":"Height","type":"integer","x-stream-index":"003"},"resize":{"description":"Resize method","enum":["clip","crop","scale","fill"],"title":"Resize","type":"string","x-stream-index":"002"},"width":{"description":"Target image width","format":"int32","title":"Width","type":"integer","x-stream-index":"004"}},"title":"Image size configuration","type":"object"},"ImageUploadRequest":{"nullable":true,"properties":{"file":{"type":"string","x-stream-index":"001.001"},"upload_sizes":{"description":"field with JSON-encoded array of image size configurations","items":{"$ref":"#/components/schemas/ImageSize"},"title":"Upload sizes","type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/OnlyUserID","x-stream-index":"001.002"}},"type":"object"},"ImageUploadResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.003.001"},"file":{"type":"string","x-stream-index":"001.001"},"thumb_url":{"type":"string","x-stream-index":"001.002"},"upload_sizes":{"description":"Array of image size configurations","items":{"$ref":"#/components/schemas/ImageSize"},"title":"Upload sizes","type":"array","x-stream-index":"002"}},"required":["duration"],"type":"object"},"Images":{"properties":{"fixed_height":{"$ref":"#/components/schemas/ImageData","x-stream-index":"002"},"fixed_height_downsampled":{"$ref":"#/components/schemas/ImageData","x-stream-index":"004"},"fixed_height_still":{"$ref":"#/components/schemas/ImageData","x-stream-index":"003"},"fixed_width":{"$ref":"#/components/schemas/ImageData","x-stream-index":"005"},"fixed_width_downsampled":{"$ref":"#/components/schemas/ImageData","x-stream-index":"007"},"fixed_width_still":{"$ref":"#/components/schemas/ImageData","x-stream-index":"006"},"original":{"$ref":"#/components/schemas/ImageData","x-stream-index":"001"}},"required":["original","fixed_height","fixed_height_still","fixed_height_downsampled","fixed_width","fixed_width_still","fixed_width_downsampled"],"type":"object"},"ImportTask":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"011"},"history":{"items":{"$ref":"#/components/schemas/ImportTaskHistory"},"type":"array","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"003"},"mode":{"type":"string","x-stream-index":"006"},"path":{"type":"string","x-stream-index":"005"},"size":{"format":"int64","type":"integer","x-stream-index":"007"},"state":{"type":"string","x-stream-index":"008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"012"}},"required":["id","path","mode","state","history","created_at","updated_at"],"type":"object"},"ImportTaskHistory":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"next_state":{"type":"string","x-stream-index":"006"},"prev_state":{"type":"string","x-stream-index":"005"}},"required":["prev_state","next_state","created_at"],"type":"object"},"IngressAudioEncodingOptions":{"properties":{"bitrate":{"maximum":128000,"minimum":16000,"type":"integer","x-stream-index":"003"},"channels":{"enum":["1","2"],"format":"int32","type":"integer","x-stream-index":"001"},"enable_dtx":{"type":"boolean","x-stream-index":"002"}},"required":["channels","enable_dtx","bitrate"],"type":"object"},"IngressAudioEncodingOptionsRequest":{"properties":{"bitrate":{"maximum":128000,"minimum":16000,"type":"integer","x-stream-index":"003"},"channels":{"enum":["1","2"],"format":"int32","type":"integer","x-stream-index":"001"},"enable_dtx":{"type":"boolean","x-stream-index":"002"}},"required":["channels","bitrate"],"type":"object"},"IngressAudioEncodingResponse":{"properties":{"bitrate":{"format":"int32","type":"integer","x-stream-index":"003"},"channels":{"format":"int32","type":"integer","x-stream-index":"001"},"enable_dtx":{"type":"boolean","x-stream-index":"002"}},"required":["channels","enable_dtx","bitrate"],"type":"object"},"IngressSettings":{"properties":{"audio_encoding_options":{"$ref":"#/components/schemas/IngressAudioEncodingOptions","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"video_encoding_options":{"additionalProperties":{"$ref":"#/components/schemas/IngressVideoEncodingOptions"},"type":"object","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"IngressSettingsRequest":{"properties":{"audio_encoding_options":{"$ref":"#/components/schemas/IngressAudioEncodingOptionsRequest","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"video_encoding_options":{"additionalProperties":{"$ref":"#/components/schemas/IngressVideoEncodingOptionsRequest"},"type":"object","x-stream-index":"003"}},"type":"object"},"IngressSettingsResponse":{"properties":{"audio_encoding_options":{"$ref":"#/components/schemas/IngressAudioEncodingResponse","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"video_encoding_options":{"additionalProperties":{"$ref":"#/components/schemas/IngressVideoEncodingResponse"},"type":"object","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"IngressVideoEncodingOptions":{"properties":{"layers":{"items":{"$ref":"#/components/schemas/IngressVideoLayer"},"minimum":1,"type":"array","x-stream-index":"001"}},"required":["layers"],"type":"object"},"IngressVideoEncodingOptionsRequest":{"properties":{"layers":{"items":{"$ref":"#/components/schemas/IngressVideoLayerRequest"},"minimum":1,"type":"array","x-stream-index":"001"}},"required":["layers"],"type":"object"},"IngressVideoEncodingResponse":{"properties":{"layers":{"items":{"$ref":"#/components/schemas/IngressVideoLayerResponse"},"type":"array","x-stream-index":"001"}},"required":["layers"],"type":"object"},"IngressVideoLayer":{"nullable":true,"properties":{"bitrate":{"minimum":1000,"type":"integer","x-stream-index":"002"},"codec":{"enum":["h264","vp8"],"type":"string","x-stream-index":"001"},"frame_rate":{"maximum":60,"minimum":1,"type":"integer","x-stream-index":"003"},"max_dimension":{"minimum":240,"type":"integer","x-stream-index":"005"},"min_dimension":{"minimum":240,"type":"integer","x-stream-index":"004"}},"required":["codec","bitrate","frame_rate","min_dimension","max_dimension"],"type":"object"},"IngressVideoLayerRequest":{"nullable":true,"properties":{"bitrate":{"format":"int32","minimum":1000,"type":"integer","x-stream-index":"002"},"codec":{"enum":["h264","vp8"],"type":"string","x-stream-index":"001"},"frame_rate_limit":{"maximum":60,"minimum":1,"type":"integer","x-stream-index":"005"},"max_dimension":{"minimum":240,"type":"integer","x-stream-index":"004"},"min_dimension":{"minimum":240,"type":"integer","x-stream-index":"003"}},"required":["codec","bitrate","min_dimension","max_dimension","frame_rate_limit"],"type":"object"},"IngressVideoLayerResponse":{"nullable":true,"properties":{"bitrate":{"type":"integer","x-stream-index":"002"},"codec":{"type":"string","x-stream-index":"001"},"frame_rate_limit":{"type":"integer","x-stream-index":"005"},"max_dimension":{"type":"integer","x-stream-index":"004"},"min_dimension":{"type":"integer","x-stream-index":"003"}},"required":["codec","bitrate","min_dimension","max_dimension","frame_rate_limit"],"type":"object"},"JoinCallAPIMetrics":{"properties":{"failures":{"format":"float","type":"number","x-stream-index":"002"},"latency":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"003"},"total":{"format":"float","type":"number","x-stream-index":"001"}},"required":["total","failures"],"type":"object"},"Label":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"phrase_list_ids":{"items":{"format":"int32","type":"integer"},"type":"array","x-stream-index":"002"}},"required":["name"],"type":"object"},"LabelThresholds":{"properties":{"block":{"description":"Threshold for automatic message block","format":"float","maximum":1,"minimum":0,"title":"Block","type":"number","x-stream-index":"002"},"flag":{"description":"Threshold for automatic message flag","format":"float","maximum":1,"minimum":0,"title":"Flag","type":"number","x-stream-index":"001"}},"type":"object"},"LayoutSettings":{"properties":{"detect_orientation":{"type":"boolean","x-stream-index":"005"},"external_app_url":{"type":"string","x-stream-index":"003"},"external_css_url":{"type":"string","x-stream-index":"004"},"name":{"enum":["spotlight","grid","single-participant","mobile","custom"],"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"required":["name","external_app_url","external_css_url"],"type":"object"},"LayoutSettingsRequest":{"properties":{"detect_orientation":{"type":"boolean","x-stream-index":"005"},"external_app_url":{"type":"string","x-stream-index":"003"},"external_css_url":{"type":"string","x-stream-index":"004"},"name":{"enum":["spotlight","grid","single-participant","mobile","custom"],"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"required":["name"],"type":"object"},"LayoutSettingsResponse":{"properties":{"detect_orientation":{"type":"boolean","x-stream-index":"005"},"external_app_url":{"type":"string","x-stream-index":"003"},"external_css_url":{"type":"string","x-stream-index":"004"},"name":{"enum":["spotlight","grid","single-participant","mobile","custom"],"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"required":["name","external_app_url","external_css_url"],"type":"object"},"LimitInfo":{"properties":{"limit":{"description":"The maximum number of calls allowed for the time window","format":"int32","title":"Limit","type":"integer","x-stream-index":"001"},"remaining":{"description":"The number of remaining calls in the current window","format":"int64","title":"Remaining","type":"integer","x-stream-index":"002"},"reset":{"description":"The Unix timestamp of the next window","format":"int64","title":"Reset","type":"integer","x-stream-index":"003"}},"required":["limit","remaining","reset"],"title":"Rate Limit info","type":"object","x-stream-docs-page-id":"rate_limits"},"LimitsSettings":{"properties":{"max_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"004"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"},"max_participants_exclude_owner":{"type":"boolean","x-stream-index":"003"},"max_participants_exclude_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"002"}},"required":["max_participants_exclude_roles"],"type":"object"},"LimitsSettingsRequest":{"properties":{"max_duration_seconds":{"format":"int32","minimum":0,"type":"integer","x-stream-index":"004"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"},"max_participants_exclude_owner":{"type":"boolean","x-stream-index":"003"},"max_participants_exclude_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"002"}},"type":"object"},"LimitsSettingsResponse":{"properties":{"max_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"004"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"},"max_participants_exclude_owner":{"type":"boolean","x-stream-index":"003"},"max_participants_exclude_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"002"}},"required":["max_participants_exclude_roles"],"type":"object"},"ListBlockListResponse":{"description":"Basic response information","nullable":true,"properties":{"blocklists":{"items":{"$ref":"#/components/schemas/BlockListResponse"},"type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["blocklists","duration"],"title":"Response","type":"object"},"ListCallTypeResponse":{"description":"Response for ListCallType","nullable":true,"properties":{"call_types":{"additionalProperties":{"$ref":"#/components/schemas/CallTypeResponse"},"type":"object","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["call_types","duration"],"title":"ListCallTypeResponse","type":"object"},"ListChannelTypesResponse":{"nullable":true,"properties":{"channel_types":{"additionalProperties":{"$ref":"#/components/schemas/ChannelTypeConfig"},"description":"Object with all channel types","title":"Channel types","type":"object","x-stream-index":"001","x-stream-map":{"key":"channel_type","title":"Channel type","description":"Channel type config object"}},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["channel_types","duration"],"title":"ListChannelTypesResponse","type":"object"},"ListCommandsResponse":{"nullable":true,"properties":{"commands":{"description":"List of commands","items":{"$ref":"#/components/schemas/Command"},"title":"Commands","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["commands","duration"],"title":"ListCommandsResponse","type":"object"},"ListDevicesResponse":{"description":"List devices response","nullable":true,"properties":{"devices":{"description":"List of devices","items":{"$ref":"#/components/schemas/DeviceResponse"},"title":"Devices","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["devices","duration"],"title":"ListDevicesResponse","type":"object"},"ListExternalStorageResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"external_storages":{"additionalProperties":{"$ref":"#/components/schemas/ExternalStorageResponse"},"type":"object","x-stream-index":"002"}},"required":["duration","external_storages"],"title":"Response","type":"object"},"ListImportsResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"import_tasks":{"items":{"$ref":"#/components/schemas/ImportTask"},"type":"array","x-stream-index":"001"}},"required":["import_tasks","duration"],"title":"Response","type":"object"},"ListPermissionsResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"permissions":{"items":{"$ref":"#/components/schemas/Permission"},"type":"array","x-stream-index":"001"}},"required":["permissions","duration"],"title":"Response","type":"object"},"ListPushProvidersResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"push_providers":{"items":{"$ref":"#/components/schemas/PushProviderResponse"},"type":"array","x-stream-index":"001"}},"required":["push_providers","duration"],"title":"Response","type":"object"},"ListRecordingsResponse":{"description":"Response for listing recordings","nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"},"recordings":{"items":{"$ref":"#/components/schemas/CallRecording"},"title":"The list of recordings.","type":"array","x-stream-index":"002"}},"required":["duration","recordings"],"title":"ListRecordingsResponse","type":"object"},"ListRolesResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"roles":{"items":{"$ref":"#/components/schemas/Role"},"type":"array","x-stream-index":"001"}},"required":["roles","duration"],"title":"Response","type":"object"},"ListTranscriptionsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"},"transcriptions":{"description":"List of transcriptions for the call","items":{"$ref":"#/components/schemas/CallTranscription"},"title":"Transcriptions","type":"array","x-stream-index":"002"}},"required":["duration","transcriptions"],"title":"ListTranscriptionsResponse","type":"object"},"MarkChannelsReadRequest":{"nullable":true,"properties":{"read_by_channel":{"additionalProperties":{"type":"string"},"description":"Map of channel ID to last read message ID","maximum":30,"title":"Read by channel","type":"object","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"002.002"},"user_id":{"type":"string","x-stream-index":"002.001"}},"type":"object"},"MarkReadRequest":{"nullable":true,"properties":{"message_id":{"description":"ID of the message that is considered last read by client","title":"Message ID","type":"string","x-stream-index":"001"},"thread_id":{"description":"Optional Thread ID to specifically mark a given thread as read","title":"Thread ID","type":"string","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"type":"object"},"MarkReadResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"event":{"$ref":"#/components/schemas/MessageReadEvent","description":"Mark read event","title":"Event","x-stream-index":"001"}},"required":["duration"],"type":"object"},"MarkReviewedRequest":{"properties":{"content_to_mark_as_reviewed_limit":{"format":"int32","maximum":2500,"type":"integer","x-stream-index":"002"},"disable_marking_content_as_reviewed":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"MarkUnreadRequest":{"nullable":true,"properties":{"message_id":{"description":"ID of the message from where the channel is marked unread","title":"Message ID","type":"string","x-stream-index":"001"},"thread_id":{"description":"Mark a thread unread, specify both the thread and message id","title":"Thread ID","type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"type":"object"},"MemberAddedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"002.001"},"type":{"default":"member.added","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MemberAddedEvent","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"},"MemberLookup":{"properties":{"Limit":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"001"}},"required":["Limit"],"type":"object"},"MemberRemovedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"001.001"},"type":{"default":"member.removed","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MemberRemovedEvent","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"},"MemberRequest":{"description":"MemberRequest is the payload for adding a member to a call.","properties":{"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"003"},"role":{"title":"Role","type":"string","x-stream-index":"002"},"user_id":{"minLength":1,"title":"User ID","type":"string","x-stream-index":"001"}},"required":["user_id"],"title":"MemberRequest","type":"object"},"MemberResponse":{"description":"MemberResponse is the payload for a member of a call.","properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"005"},"custom":{"additionalProperties":{},"description":"Custom member response data","title":"Custom","type":"object","x-stream-index":"004"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"007"},"role":{"title":"Role","type":"string","x-stream-index":"003"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"006"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"},"user_id":{"type":"string","x-stream-index":"002"}},"required":["user","user_id","custom","created_at","updated_at"],"title":"MemberResponse","type":"object"},"MemberUpdatedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"005.002"},"channel_type":{"type":"string","x-stream-index":"005.003"},"cid":{"type":"string","x-stream-index":"005.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"002.001"},"type":{"default":"member.updated","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MemberUpdatedEvent","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"},"MembersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"members":{"description":"List of found members","items":{"$ref":"#/components/schemas/ChannelMember"},"title":"Members","type":"array","x-stream-index":"001"}},"required":["members","duration"],"type":"object"},"Message":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"012"},"before_message_send_failed":{"type":"boolean","x-stream-index":"046"},"cid":{"type":"string","x-stream-index":"028"},"command":{"type":"string","x-stream-index":"006"},"created_at":{"format":"date-time","type":"number","x-stream-index":"030"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"034"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"033"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"023"},"html":{"type":"string","x-stream-index":"007"},"i18n":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"044"},"id":{"type":"string","x-stream-index":"002"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"040"},"latest_reactions":{"items":{"$ref":"#/components/schemas/Reaction"},"type":"array","x-stream-index":"013"},"mentioned_users":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"043"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"052"},"mml":{"type":"string","x-stream-index":"005"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"056"},"own_reactions":{"items":{"$ref":"#/components/schemas/Reaction"},"type":"array","x-stream-index":"014"},"parent_id":{"type":"string","x-stream-index":"019"},"pin_expires":{"format":"date-time","type":"number","x-stream-index":"051"},"pinned":{"type":"boolean","x-stream-index":"047"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"048"},"pinned_by":{"$ref":"#/components/schemas/User","x-stream-index":"050"},"poll":{"$ref":"#/components/schemas/Poll","x-stream-index":"054"},"poll_id":{"type":"string","x-stream-index":"053"},"quoted_message":{"$ref":"#/components/schemas/Message","x-stream-index":"025"},"quoted_message_id":{"type":"string","x-stream-index":"024"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"015"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"017"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"016"},"reminder":{"$ref":"#/components/schemas/MessageReminder","x-stream-index":"058"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"022"},"restricted_visibility":{"items":{"type":"string"},"type":"array","x-stream-index":"011"},"shadowed":{"type":"boolean","x-stream-index":"036"},"shared_location":{"$ref":"#/components/schemas/SharedLocation","x-stream-index":"055"},"show_in_channel":{"type":"boolean","x-stream-index":"021"},"silent":{"type":"boolean","x-stream-index":"045"},"text":{"type":"string","x-stream-index":"004"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"027"},"type":{"type":"string","x-stream-index":"008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"031"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"010"}},"required":["id","text","html","type","restricted_visibility","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reaction_groups","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned"],"type":"object"},"MessageActionRequest":{"nullable":true,"properties":{"form_data":{"additionalProperties":{"type":"string"},"description":"ReadOnlyData to execute command with","title":"Form data","type":"object","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"required":["form_data"],"type":"object"},"MessageChangeSet":{"properties":{"attachments":{"type":"boolean","x-stream-index":"005"},"custom":{"type":"boolean","x-stream-index":"001"},"html":{"type":"boolean","x-stream-index":"004"},"mentioned_user_ids":{"type":"boolean","x-stream-index":"006"},"mml":{"type":"boolean","x-stream-index":"003"},"pin":{"type":"boolean","x-stream-index":"009"},"quoted_message_id":{"type":"boolean","x-stream-index":"007"},"silent":{"type":"boolean","x-stream-index":"008"},"text":{"type":"boolean","x-stream-index":"002"}},"required":["custom","text","mml","html","attachments","mentioned_user_ids","quoted_message_id","silent","pin"],"type":"object"},"MessageDeletedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"006.002"},"hard_delete":{"type":"boolean","x-stream-index":"002.001"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"005.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"message.deleted","type":"string","x-stream-index":"006.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["hard_delete","cid","channel_id","channel_type","type","created_at"],"title":"MessageDeletedEvent","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":{"approved_at":{"format":"date-time","type":"number","x-stream-index":"013"},"created_at":{"format":"date-time","type":"number","x-stream-index":"009"},"created_by_automod":{"type":"boolean","x-stream-index":"001"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"008"},"details":{"$ref":"#/components/schemas/FlagDetails","x-stream-index":"006"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"005"},"moderation_feedback":{"$ref":"#/components/schemas/FlagFeedback","x-stream-index":"003"},"moderation_result":{"$ref":"#/components/schemas/MessageModerationResult","x-stream-index":"002"},"reason":{"type":"string","x-stream-index":"007"},"rejected_at":{"format":"date-time","type":"number","x-stream-index":"014"},"reviewed_at":{"format":"date-time","type":"number","x-stream-index":"011"},"reviewed_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"012"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"004"}},"required":["created_by_automod","created_at","updated_at"],"type":"object"},"MessageFlaggedEvent":{"properties":{"cid":{"type":"string","x-stream-index":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"005.002"},"flag":{"$ref":"#/components/schemas/Flag","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"002.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"002.002"},"type":{"default":"message.flagged","type":"string","x-stream-index":"005.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004"}},"required":["cid","type","created_at"],"title":"MessageFlaggedEvent","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"},"MessageHistoryEntryResponse":{"nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"007"},"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"006"},"is_deleted":{"type":"boolean","x-stream-index":"004"},"message_id":{"type":"string","x-stream-index":"001"},"message_updated_at":{"format":"date-time","type":"number","x-stream-index":"003"},"message_updated_by_id":{"type":"string","x-stream-index":"002"},"text":{"type":"string","x-stream-index":"005"}},"required":["message_id","message_updated_by_id","message_updated_at","is_deleted","text","attachments","Custom"],"type":"object"},"MessageModerationResult":{"description":"Result of the message moderation","properties":{"action":{"description":"Action taken by automod","title":"Action","type":"string","x-stream-index":"002"},"ai_moderation_response":{"$ref":"#/components/schemas/ModerationResponse","description":"Response from AI moderation","title":"ModerationResponse","x-stream-index":"007"},"blocked_word":{"description":"Word that was blocked","title":"Blocked word","type":"string","x-stream-index":"004"},"blocklist_name":{"description":"Name of the blocklist","title":"Blocklist name","type":"string","x-stream-index":"005"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"010"},"message_id":{"description":"ID of the message","title":"Message ID","type":"string","x-stream-index":"001"},"moderated_by":{"description":"User who moderated the message","title":"Moderated by","type":"string","x-stream-index":"003"},"moderation_thresholds":{"$ref":"#/components/schemas/Thresholds","description":"Thresholds for AI moderation","title":"Thresholds","x-stream-index":"006"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"011"},"user_bad_karma":{"description":"Whether user has bad karma","title":"User bad karma","type":"boolean","x-stream-index":"009"},"user_karma":{"description":"Karma of the user","format":"float","title":"User karma","type":"number","x-stream-index":"008"}},"required":["message_id","action","user_karma","user_bad_karma","created_at","updated_at"],"title":"Message moderation result","type":"object"},"MessageNewEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"005.002"},"channel_type":{"type":"string","x-stream-index":"005.003"},"cid":{"type":"string","x-stream-index":"005.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"006.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"notification.thread_message_new","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"},"watcher_count":{"format":"int32","type":"integer","x-stream-index":"002.001"}},"required":["watcher_count","type","created_at","cid","channel_id","channel_type"],"title":"MessageNewEvent","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"},"MessageOptions":{"properties":{"include_thread_participants":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"MessagePaginationParams":{"type":"object"},"MessageReadEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"003"},"channel_last_message_at":{"format":"date-time","type":"number","x-stream-index":"005"},"channel_type":{"type":"string","x-stream-index":"004"},"cid":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"009"},"last_read_message_id":{"type":"string","x-stream-index":"010"},"team":{"type":"string","x-stream-index":"006"},"thread":{"$ref":"#/components/schemas/ThreadResponse","x-stream-index":"008"},"type":{"default":"message.read","type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","x-stream-index":"007"}},"required":["type","cid","channel_id","channel_type","created_at"],"type":"object"},"MessageReminder":{"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"004"},"channel_cid":{"type":"string","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"011"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"006"},"message_id":{"type":"string","x-stream-index":"005"},"remind_at":{"format":"date-time","type":"number","x-stream-index":"009"},"task_id":{"type":"string","x-stream-index":"010"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"012"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"user_id":{"type":"string","x-stream-index":"007"}},"required":["channel_cid","message_id","user_id","task_id","created_at","updated_at"],"type":"object"},"MessageRequest":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"maximum":30,"type":"array","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"html":{"type":"string","x-stream-index":"010"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"mentioned_users":{"items":{"type":"string"},"maximum":100,"type":"array","x-stream-index":"008"},"mml":{"type":"string","x-stream-index":"003"},"parent_id":{"type":"string","x-stream-index":"005"},"pin_expires":{"format":"date-time","type":"number","x-stream-index":"015"},"pinned":{"type":"boolean","x-stream-index":"013"},"pinned_at":{"format":"date-time","nullable":true,"type":"string","x-stream-index":"014"},"poll_id":{"type":"string","x-stream-index":"039"},"quoted_message_id":{"type":"string","x-stream-index":"009"},"restricted_visibility":{"items":{"type":"string"},"maximum":10,"type":"array","x-stream-index":"016"},"shared_location":{"$ref":"#/components/schemas/SharedLocation","x-stream-index":"040"},"show_in_channel":{"type":"boolean","x-stream-index":"006"},"silent":{"type":"boolean","x-stream-index":"012"},"text":{"type":"string","x-stream-index":"002"},"type":{"enum":["''","regular","system"],"type":"string","x-stream-index":"011"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"021.002"},"user_id":{"type":"string","x-stream-index":"021.001"}},"type":"object"},"MessageResponse":{"description":"Represents any chat message","properties":{"attachments":{"description":"Array of message attachments","items":{"$ref":"#/components/schemas/Attachment"},"title":"Message attachments","type":"array","x-stream-docs-page-id":"message_format#attachment-format","x-stream-index":"008"},"cid":{"description":"Channel unique identifier in \u003ctype\u003e:\u003cid\u003e format","title":"Channel CID","type":"string","x-stream-index":"022"},"command":{"description":"Contains provided slash command","title":"Command","type":"string","x-stream-docs-page-id":"custom_commands_webhook","x-stream-index":"004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"023"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"026"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"025"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"018"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"041"},"html":{"description":"Contains HTML markup of the message. Can only be set when using server-side API","title":"HTML content","type":"string","x-stream-index":"005"},"i18n":{"additionalProperties":{"type":"string"},"description":"Object with translations. Key `language` contains the original language key. Other keys contain translations","title":"Internationalization info","type":"object","x-stream-docs-page-id":"translation","x-stream-index":"030"},"id":{"description":"Message ID is unique string identifier of the message","title":"ID","type":"string","x-stream-index":"001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"Contains image moderation information","title":"Image moderation labels","type":"object","x-stream-index":"028"},"latest_reactions":{"description":"List of 10 latest reactions to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Latest reactions","type":"array","x-stream-index":"009"},"mentioned_users":{"description":"List of mentioned users","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Mentioned Users","type":"array","x-stream-index":"029"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"036"},"mml":{"description":"Should be empty if `text` is provided. Can only be set when using server-side API","title":"Messaging Markup Language","type":"string","x-stream-docs-page-id":"mml_overview","x-stream-index":"003"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"039"},"own_reactions":{"description":"List of 10 latest reactions of authenticated user to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Own reactions","type":"array","x-stream-index":"010"},"parent_id":{"description":"ID of parent message (thread)","title":"Parent message ID","type":"string","x-stream-docs-page-id":"threads","x-stream-index":"015"},"pin_expires":{"description":"Date when pinned message expires","format":"date-time","title":"Pin expiration date","type":"number","x-stream-docs-page-id":"pinned_messages","x-stream-index":"035"},"pinned":{"description":"Whether message is pinned or not","title":"Pinned","type":"boolean","x-stream-docs-page-id":"pinned_messages","x-stream-index":"032"},"pinned_at":{"description":"Date when message got pinned","format":"date-time","title":"Pinned at","type":"number","x-stream-docs-page-id":"pinned_messages","x-stream-index":"033"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","description":"Contains user who pinned the message","title":"Pinned by","x-stream-docs-page-id":"pinned_messages","x-stream-index":"034"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"038"},"poll_id":{"description":"Identifier of the poll to include in the message","title":"Poll ID","type":"string","x-stream-index":"037"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","description":"Contains quoted message","title":"Quoted message","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"020"},"quoted_message_id":{"title":"ID of quoted message","type":"string","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"019"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing number of reactions of each type. Key: reaction type (string), value: number of reactions (int)","title":"Reaction counts","type":"object","x-stream-index":"011"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"014"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing scores of reactions of each type. Key: reaction type (string), value: total score of reactions (int)","title":"Reaction scores","type":"object","x-stream-index":"012"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"042"},"reply_count":{"description":"Number of replies to this message","format":"int32","title":"Reply count","type":"integer","x-stream-index":"017"},"restricted_visibility":{"description":"A list of user ids that have restricted visibility to the message, if the list is not empty, the message is only visible to the users in the list","items":{"type":"string"},"title":"Restricted visibility","type":"array","x-stream-index":"040"},"shadowed":{"description":"Whether the message was shadowed or not","title":"Shadowed","type":"boolean","x-stream-docs-page-id":"moderation#shadow-ban","x-stream-index":"027"},"shared_location":{"$ref":"#/components/schemas/SharedLocationResponseData","description":"Contains shared location data","title":"Shared Location","x-stream-index":"043"},"show_in_channel":{"description":"Whether thread reply should be shown in the channel as well","title":"Show in channel","type":"boolean","x-stream-docs-page-id":"threads","x-stream-index":"016"},"silent":{"description":"Whether message is silent or not","title":"Silent","type":"boolean","x-stream-index":"031"},"text":{"description":"Text of the message. Should be empty if `mml` is provided","title":"Text","type":"string","x-stream-index":"002"},"thread_participants":{"description":"List of users who participate in thread","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Thread participants","type":"array","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"021"},"type":{"description":"Contains type of the message","enum":["regular","ephemeral","error","reply","system","deleted"],"title":"Message Type","type":"string","x-stream-docs-page-id":"message_format#message-types","x-stream-index":"006"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"024"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Sender of the message. Required when using server-side API","title":"User object","x-stream-index":"007"}},"required":["id","text","html","type","user","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned","restricted_visibility"],"title":"Message","type":"object","x-stream-docs-page-id":"send_message"},"MessageStatsResponse":{"properties":{"count_over_time":{"items":{"$ref":"#/components/schemas/CountByMinuteResponse"},"type":"array","x-stream-index":"001"}},"type":"object"},"MessageUnblockedEvent":{"properties":{"cid":{"type":"string","x-stream-index":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"002.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"002.002"},"type":{"default":"message.unblocked","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["cid","type","created_at"],"title":"MessageUnblockedEvent","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"},"MessageUndeletedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"005.002"},"channel_type":{"type":"string","x-stream-index":"005.003"},"cid":{"type":"string","x-stream-index":"005.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"002.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"message.undeleted","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MessageUndeletedEvent","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"},"MessageUpdate":{"properties":{"change_set":{"$ref":"#/components/schemas/MessageChangeSet","x-stream-index":"002"},"old_text":{"type":"string","x-stream-index":"001"}},"type":"object"},"MessageUpdatedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"005.002"},"channel_type":{"type":"string","x-stream-index":"005.003"},"cid":{"type":"string","x-stream-index":"005.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"002.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"message.updated","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MessageUpdatedEvent","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"},"MessageWithChannelResponse":{"description":"Represents any chat message","properties":{"attachments":{"description":"Array of message attachments","items":{"$ref":"#/components/schemas/Attachment"},"title":"Message attachments","type":"array","x-stream-docs-page-id":"message_format#attachment-format","x-stream-index":"001.008"},"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel object","title":"Channel","x-stream-index":"002"},"cid":{"description":"Channel unique identifier in \u003ctype\u003e:\u003cid\u003e format","title":"Channel CID","type":"string","x-stream-index":"001.022"},"command":{"description":"Contains provided slash command","title":"Command","type":"string","x-stream-docs-page-id":"custom_commands_webhook","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.023"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.026"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"001.025"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"001.018"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001.041"},"html":{"description":"Contains HTML markup of the message. Can only be set when using server-side API","title":"HTML content","type":"string","x-stream-index":"001.005"},"i18n":{"additionalProperties":{"type":"string"},"description":"Object with translations. Key `language` contains the original language key. Other keys contain translations","title":"Internationalization info","type":"object","x-stream-docs-page-id":"translation","x-stream-index":"001.030"},"id":{"description":"Message ID is unique string identifier of the message","title":"ID","type":"string","x-stream-index":"001.001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"Contains image moderation information","title":"Image moderation labels","type":"object","x-stream-index":"001.028"},"latest_reactions":{"description":"List of 10 latest reactions to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Latest reactions","type":"array","x-stream-index":"001.009"},"mentioned_users":{"description":"List of mentioned users","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Mentioned Users","type":"array","x-stream-index":"001.029"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"001.036"},"mml":{"description":"Should be empty if `text` is provided. Can only be set when using server-side API","title":"Messaging Markup Language","type":"string","x-stream-docs-page-id":"mml_overview","x-stream-index":"001.003"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"001.039"},"own_reactions":{"description":"List of 10 latest reactions of authenticated user to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Own reactions","type":"array","x-stream-index":"001.010"},"parent_id":{"description":"ID of parent message (thread)","title":"Parent message ID","type":"string","x-stream-docs-page-id":"threads","x-stream-index":"001.015"},"pin_expires":{"description":"Date when pinned message expires","format":"date-time","title":"Pin expiration date","type":"number","x-stream-docs-page-id":"pinned_messages","x-stream-index":"001.035"},"pinned":{"description":"Whether message is pinned or not","title":"Pinned","type":"boolean","x-stream-docs-page-id":"pinned_messages","x-stream-index":"001.032"},"pinned_at":{"description":"Date when message got pinned","format":"date-time","title":"Pinned at","type":"number","x-stream-docs-page-id":"pinned_messages","x-stream-index":"001.033"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","description":"Contains user who pinned the message","title":"Pinned by","x-stream-docs-page-id":"pinned_messages","x-stream-index":"001.034"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001.038"},"poll_id":{"description":"Identifier of the poll to include in the message","title":"Poll ID","type":"string","x-stream-index":"001.037"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","description":"Contains quoted message","title":"Quoted message","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"001.020"},"quoted_message_id":{"title":"ID of quoted message","type":"string","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"001.019"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing number of reactions of each type. Key: reaction type (string), value: number of reactions (int)","title":"Reaction counts","type":"object","x-stream-index":"001.011"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"001.014"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing scores of reactions of each type. Key: reaction type (string), value: total score of reactions (int)","title":"Reaction scores","type":"object","x-stream-index":"001.012"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"001.042"},"reply_count":{"description":"Number of replies to this message","format":"int32","title":"Reply count","type":"integer","x-stream-index":"001.017"},"restricted_visibility":{"description":"A list of user ids that have restricted visibility to the message, if the list is not empty, the message is only visible to the users in the list","items":{"type":"string"},"title":"Restricted visibility","type":"array","x-stream-index":"001.040"},"shadowed":{"description":"Whether the message was shadowed or not","title":"Shadowed","type":"boolean","x-stream-docs-page-id":"moderation#shadow-ban","x-stream-index":"001.027"},"shared_location":{"$ref":"#/components/schemas/SharedLocationResponseData","description":"Contains shared location data","title":"Shared Location","x-stream-index":"001.043"},"show_in_channel":{"description":"Whether thread reply should be shown in the channel as well","title":"Show in channel","type":"boolean","x-stream-docs-page-id":"threads","x-stream-index":"001.016"},"silent":{"description":"Whether message is silent or not","title":"Silent","type":"boolean","x-stream-index":"001.031"},"text":{"description":"Text of the message. Should be empty if `mml` is provided","title":"Text","type":"string","x-stream-index":"001.002"},"thread_participants":{"description":"List of users who participate in thread","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Thread participants","type":"array","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"001.021"},"type":{"description":"Contains type of the message","enum":["regular","ephemeral","error","reply","system","deleted"],"title":"Message Type","type":"string","x-stream-docs-page-id":"message_format#message-types","x-stream-index":"001.006"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.024"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Sender of the message. Required when using server-side API","title":"User object","x-stream-index":"001.007"}},"required":["id","text","html","type","user","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned","restricted_visibility","channel"],"title":"Message","type":"object","x-stream-docs-page-id":"send_message"},"ModerationActionConfig":{"nullable":true,"properties":{"action":{"type":"string","x-stream-index":"006"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"009"},"description":{"type":"string","x-stream-index":"008"},"entity_type":{"type":"string","x-stream-index":"004"},"icon":{"type":"string","x-stream-index":"007"},"order":{"format":"int32","type":"integer","x-stream-index":"005"}},"required":["entity_type","order","action","icon","description","custom"],"type":"object"},"ModerationCheckCompletedEvent":{"description":"This event is sent when a moderation check is completed","nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"entity_id":{"description":"The ID of entity which was moderated","title":"EntityID","type":"string","x-stream-index":"002"},"entity_type":{"description":"The type of the entity which was moderated","title":"EntityType","type":"string","x-stream-index":"003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"recommended_action":{"description":"The recommended action","title":"RecommendedAction","type":"string","x-stream-index":"004"},"review_queue_item_id":{"description":"The review queue item ID","title":"ReviewQueueItemID","type":"string","x-stream-index":"005"},"type":{"default":"moderation_check.completed","type":"string","x-stream-index":"001.002"}},"required":["type","created_at","custom","entity_id","entity_type","recommended_action","review_queue_item_id"],"title":"ModerationCheckCompletedEvent","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"},"ModerationCustomActionEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"001"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"002"},"type":{"default":"moderation.custom_action","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationCustomActionEvent","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"},"ModerationDashboardPreferences":{"properties":{"flag_user_on_flagged_content":{"type":"boolean","x-stream-index":"002"},"media_queue_blur_enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"ModerationFlagResponse":{"nullable":true,"properties":{"created_at":{"type":"string","x-stream-index":"014"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"009"},"entity_creator_id":{"type":"string","x-stream-index":"006"},"entity_id":{"type":"string","x-stream-index":"005"},"entity_type":{"type":"string","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001"},"labels":{"items":{"type":"string"},"type":"array","x-stream-index":"010"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"007"},"reason":{"type":"string","x-stream-index":"008"},"result":{"items":{"additionalProperties":{},"type":"object"},"type":"array","x-stream-index":"011"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","x-stream-index":"013"},"review_queue_item_id":{"type":"string","x-stream-index":"012"},"type":{"type":"string","x-stream-index":"002"},"updated_at":{"type":"string","x-stream-index":"015"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"003"}},"required":["id","type","entity_type","entity_id","created_at","updated_at"],"type":"object"},"ModerationFlaggedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"item":{"type":"string","x-stream-index":"001"},"object_id":{"type":"string","x-stream-index":"002"},"type":{"default":"moderation.flagged","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationFlaggedEvent","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"},"ModerationMarkReviewedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"001"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"002"},"type":{"default":"moderation.mark_reviewed","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationMarkReviewedEvent","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"},"ModerationPayload":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"images":{"items":{"type":"string"},"maximum":30,"type":"array","x-stream-index":"002"},"texts":{"items":{"type":"string"},"type":"array","x-stream-index":"001"},"videos":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"type":"object"},"ModerationResponse":{"properties":{"action":{"type":"string","x-stream-index":"004"},"explicit":{"format":"float","type":"number","x-stream-index":"002"},"spam":{"format":"float","type":"number","x-stream-index":"003"},"toxic":{"format":"float","type":"number","x-stream-index":"001"}},"required":["toxic","explicit","spam","action","automod_response"],"type":"object"},"ModerationV2Response":{"properties":{"action":{"type":"string","x-stream-index":"001"},"blocklist_matched":{"type":"string","x-stream-index":"005"},"image_harms":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"original_text":{"type":"string","x-stream-index":"002"},"platform_circumvented":{"type":"boolean","x-stream-index":"007"},"semantic_filter_matched":{"type":"string","x-stream-index":"006"},"text_harms":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"required":["action","original_text"],"type":"object"},"MuteChannelRequest":{"nullable":true,"properties":{"channel_cids":{"description":"Channel CIDs to mute (if multiple channels)","items":{"type":"string"},"maximum":25,"title":"Channel CIDs","type":"array","x-stream-index":"002"},"expiration":{"description":"Duration of mute in milliseconds","title":"Expiration","type":"integer","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"type":"object"},"MuteChannelResponse":{"nullable":true,"properties":{"channel_mute":{"$ref":"#/components/schemas/ChannelMute","description":"Object with channel mute (if one channel was muted)","title":"Channel mute","x-stream-index":"001"},"channel_mutes":{"description":"Object with mutes (if multiple channels were muted)","items":{"$ref":"#/components/schemas/ChannelMute"},"title":"Channel mutes","type":"array","x-stream-index":"002"},"duration":{"type":"string","x-stream-index":"004.001"},"own_user":{"$ref":"#/components/schemas/OwnUser","description":"Authorized user object with fresh mutes information","title":"Own user","x-stream-index":"003"}},"required":["duration"],"type":"object"},"MuteRequest":{"nullable":true,"properties":{"target_ids":{"description":"User IDs to mute (if multiple users)","items":{"type":"string"},"title":"Target IDs","type":"array","x-stream-index":"001"},"timeout":{"description":"Duration of mute in minutes","minimum":0,"title":"Timeout","type":"integer","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"required":["target_ids"],"title":"MuteRequest","type":"object"},"MuteResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"004.001"},"mutes":{"description":"Object with mutes (if multiple users were muted)","items":{"$ref":"#/components/schemas/UserMute"},"title":"Mutes","type":"array","x-stream-index":"001"},"non_existing_users":{"description":"A list of users that can't be found. Common cause for this is deleted users","items":{"type":"string"},"title":"Non Existing Users","type":"array","x-stream-index":"003"},"own_user":{"$ref":"#/components/schemas/OwnUser","description":"Authorized user object with fresh mutes information","title":"Own User","x-stream-index":"002"}},"required":["duration"],"title":"MuteResponse","type":"object"},"MuteUsersRequest":{"nullable":true,"properties":{"audio":{"title":"Audio","type":"boolean","x-stream-index":"005"},"mute_all_users":{"type":"boolean","x-stream-index":"003"},"muted_by":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"010"},"muted_by_id":{"type":"string","x-stream-index":"009"},"screenshare":{"title":"Screenshare","type":"boolean","x-stream-index":"007"},"screenshare_audio":{"title":"ScreenshareAudio","type":"boolean","x-stream-index":"008"},"user_ids":{"items":{"type":"string"},"title":"UserIDs","type":"array","x-stream-index":"004"},"video":{"title":"Video","type":"boolean","x-stream-index":"006"}},"title":"MuteUsersRequest","type":"object"},"MuteUsersResponse":{"description":"MuteUsersResponse is the response payload for the mute users endpoint.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"MuteUsersResponse","type":"object"},"NetworkMetricsReportResponse":{"properties":{"average_connection_time":{"format":"float","type":"number","x-stream-index":"003"},"average_jitter":{"format":"float","type":"number","x-stream-index":"002"},"average_latency":{"format":"float","type":"number","x-stream-index":"001"},"average_time_to_reconnect":{"format":"float","type":"number","x-stream-index":"004"}},"type":"object"},"NoiseCancellationSettings":{"properties":{"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode"],"type":"object"},"NotificationMarkUnreadEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003.004"},"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"003.005"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"first_unread_message_id":{"type":"string","x-stream-index":"005"},"last_read_at":{"format":"date-time","type":"number","x-stream-index":"006"},"last_read_message_id":{"type":"string","x-stream-index":"012"},"team":{"type":"string","x-stream-index":"002.001"},"thread_id":{"type":"string","x-stream-index":"013"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"009"},"type":{"default":"notification.mark_unread","type":"string","x-stream-index":"001.001"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"010"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"008"},"unread_messages":{"format":"int32","type":"integer","x-stream-index":"007"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"011"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count","first_unread_message_id","last_read_at","unread_messages","unread_count","total_unread_count","unread_channels","unread_threads"],"title":"NotificationMarkUnreadEvent","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"},"NotificationSettings":{"properties":{"call_live_started":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"002"},"call_missed":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"006"},"call_notification":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"004"},"call_ring":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"session_started":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"003"}},"required":["enabled","call_live_started","session_started","call_notification","call_ring","call_missed"],"type":"object"},"NullTime":{"type":"object"},"OCRRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"}},"required":["label","action"],"type":"object"},"OnlyUserID":{"properties":{"id":{"type":"string","x-stream-index":"001"}},"required":["id"],"type":"object"},"OwnCapability":{"description":"All possibility of string to use","enum":["block-users","change-max-duration","create-call","create-reaction","enable-noise-cancellation","end-call","join-backstage","join-call","join-ended-call","mute-users","pin-for-everyone","read-call","remove-call-member","screenshare","send-audio","send-video","start-broadcast-call","start-closed-captions-call","start-frame-record-call","start-record-call","start-transcription-call","stop-broadcast-call","stop-closed-captions-call","stop-frame-record-call","stop-record-call","stop-transcription-call","update-call","update-call-member","update-call-permissions","update-call-settings"],"title":"OwnCapability","type":"string"},"OwnUser":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"046"},"banned":{"type":"boolean","x-stream-index":"016"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"045"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"029"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"014"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"013"},"devices":{"items":{"$ref":"#/components/schemas/Device"},"type":"array","x-stream-index":"027"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"023"},"language":{"type":"string","x-stream-index":"035"},"last_active":{"format":"date-time","type":"number","x-stream-index":"011"},"last_engaged_at":{"format":"date-time","type":"number","x-stream-index":"012"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"037"},"mutes":{"items":{"$ref":"#/components/schemas/UserMute"},"type":"array","x-stream-index":"028"},"online":{"type":"boolean","x-stream-index":"022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"026"},"push_preferences":{"$ref":"#/components/schemas/PushPreferences","x-stream-index":"025"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"005"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"031"},"total_unread_count_by_team":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"032"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"033"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"030"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"034"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"}},"required":["id","role","custom","created_at","updated_at","banned","online","devices","mutes","channel_mutes","unread_count","total_unread_count","total_unread_count_by_team","unread_channels","unread_threads","language"],"type":"object"},"OwnUserResponse":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"banned":{"type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"015"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.011"},"devices":{"items":{"$ref":"#/components/schemas/DeviceResponse"},"title":"Devices","type":"array","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001.001"},"image":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"005"},"language":{"type":"string","x-stream-index":"001.005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"001.014"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"013"},"mutes":{"items":{"$ref":"#/components/schemas/UserMuteResponse"},"type":"array","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"001.002"},"online":{"type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"003"},"push_preferences":{"$ref":"#/components/schemas/PushPreferences","x-stream-index":"002"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.015"},"role":{"type":"string","x-stream-index":"001.006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"009"},"total_unread_count_by_team":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"010"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"011"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"008"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"012"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","devices","invisible","mutes","channel_mutes","unread_count","total_unread_count","unread_channels","unread_threads"],"type":"object"},"PagerResponse":{"properties":{"next":{"type":"string","x-stream-index":"001"},"prev":{"type":"string","x-stream-index":"002"}},"type":"object"},"PaginationParams":{"properties":{"limit":{"format":"int32","minimum":0,"type":"integer","x-stream-index":"001"},"offset":{"format":"int32","type":"integer","x-stream-index":"002"}},"type":"object"},"ParticipantCountByMinuteResponse":{"nullable":true,"properties":{"first":{"format":"int32","type":"integer","x-stream-index":"002"},"last":{"format":"int32","type":"integer","x-stream-index":"003"},"max":{"format":"int32","type":"integer","x-stream-index":"004"},"min":{"format":"int32","type":"integer","x-stream-index":"005"},"start_ts":{"format":"date-time","type":"number","x-stream-index":"001"}},"required":["start_ts","first","last","max","min"],"type":"object"},"ParticipantCountOverTimeResponse":{"properties":{"by_minute":{"items":{"$ref":"#/components/schemas/ParticipantCountByMinuteResponse"},"type":"array","x-stream-index":"001"}},"type":"object"},"ParticipantReportResponse":{"properties":{"by_browser":{"items":{"$ref":"#/components/schemas/GroupedStatsResponse"},"type":"array","x-stream-index":"008"},"by_country":{"items":{"$ref":"#/components/schemas/GroupedStatsResponse"},"type":"array","x-stream-index":"005"},"by_device":{"items":{"$ref":"#/components/schemas/GroupedStatsResponse"},"type":"array","x-stream-index":"006"},"by_operating_system":{"items":{"$ref":"#/components/schemas/GroupedStatsResponse"},"type":"array","x-stream-index":"007"},"count_over_time":{"$ref":"#/components/schemas/ParticipantCountOverTimeResponse","x-stream-index":"004"},"max_concurrent":{"format":"int32","type":"integer","x-stream-index":"003"},"publishers":{"$ref":"#/components/schemas/PublisherStatsResponse","x-stream-index":"009"},"subscribers":{"$ref":"#/components/schemas/SubscriberStatsResponse","x-stream-index":"010"},"sum":{"format":"int32","type":"integer","x-stream-index":"001"},"unique":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["sum","unique"],"type":"object"},"PendingMessageEvent":{"description":"Pending message event for async moderation","nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"002.007"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"message":{"$ref":"#/components/schemas/Message","description":"The pending message","title":"Message","x-stream-index":"002.009"},"metadata":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"002.010"},"method":{"description":"The method used for the pending message","title":"Method","type":"string","x-stream-index":"003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"type":{"default":"message.pending","description":"The type of event: \"message.pending\" in this case","title":"Event Type","type":"string","x-stream-index":"001.002"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.002"}},"required":["type","custom","method","created_at"],"title":"PendingMessageEvent","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"},"PendingMessageResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"003"},"metadata":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"}},"type":"object"},"PerSDKUsageReport":{"nullable":true,"properties":{"by_version":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"002"},"total":{"format":"int32","type":"integer","x-stream-index":"001"}},"required":["total","by_version"],"type":"object"},"Permission":{"properties":{"action":{"description":"Action name this permission is for (e.g. SendMessage)","title":"Action","type":"string","x-stream-index":"004"},"condition":{"additionalProperties":{},"description":"MongoDB style condition which decides whether or not the permission is granted","title":"Condition","type":"object","x-stream-index":"007"},"custom":{"description":"Whether this is a custom permission or built-in","title":"Custom","type":"boolean","x-stream-index":"009"},"description":{"description":"Description of the permission","title":"Description","type":"string","x-stream-index":"003"},"id":{"description":"Unique permission ID","title":"ID","type":"string","x-stream-index":"001"},"level":{"description":"Level at which permission could be applied (app or channel)","enum":["app","channel"],"title":"Level","type":"string","x-stream-index":"010"},"name":{"description":"Name of the permission","title":"Name","type":"string","x-stream-index":"002"},"owner":{"description":"Whether this permission applies to resource owner or not","title":"Owner","type":"boolean","x-stream-index":"005"},"same_team":{"description":"Whether this permission applies to teammates (multi-tenancy mode only)","title":"Same team","type":"boolean","x-stream-index":"006"},"tags":{"description":"List of tags of the permission","items":{"type":"string"},"title":"Tags","type":"array","x-stream-index":"011"}},"required":["id","name","description","action","owner","same_team","custom","level","tags"],"type":"object"},"PermissionRequestEvent":{"description":"This event is sent when a user requests access to a feature on a call,\nclients receiving this event should display a permission request to the user","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"permissions":{"description":"The list of permissions requested by the user","items":{"type":"string"},"title":"Permissions","type":"array","x-stream-index":"004"},"type":{"default":"call.permission_request","description":"The type of event: \"call.permission_request\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who sent the permission request","title":"User","x-stream-index":"003"}},"required":["type","created_at","call_cid","user","permissions"],"title":"PermissionRequestEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"PinRequest":{"description":"PinRequest is the payload for pinning a message.","nullable":true,"properties":{"session_id":{"description":"the session ID of the user who pinned the message","title":"SessionID","type":"string","x-stream-index":"003"},"user_id":{"description":"the user ID of the user who pinned the message","title":"UserID","type":"string","x-stream-index":"002"}},"required":["user_id","session_id"],"title":"PinRequest","type":"object"},"PinResponse":{"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"},"PlatformDataResponse":{"properties":{"browser":{"$ref":"#/components/schemas/BrowserDataResponse","x-stream-index":"003"},"device":{"$ref":"#/components/schemas/DeviceDataResponse","x-stream-index":"002"},"os":{"$ref":"#/components/schemas/ClientOSDataResponse","x-stream-index":"001"}},"required":["os","device","browser"],"type":"object"},"Policy":{"properties":{"action":{"type":"integer","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"010"},"name":{"type":"string","x-stream-index":"004"},"owner":{"type":"boolean","x-stream-index":"008"},"priority":{"format":"int32","type":"integer","x-stream-index":"009"},"resources":{"items":{"type":"string"},"type":"array","x-stream-index":"005"},"roles":{"items":{"type":"string"},"type":"array","x-stream-index":"006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"011"}},"required":["name","resources","roles","action","owner","priority","created_at","updated_at"],"type":"object"},"PolicyRequest":{"description":"Policy request","properties":{"action":{"enum":["Deny","Allow"],"title":"Action","type":"string","x-stream-index":"001"},"name":{"description":"User-friendly policy name","title":"Name","type":"string","x-stream-index":"002"},"owner":{"description":"Whether policy applies to resource owner or not","title":"Owner","type":"boolean","x-stream-index":"005"},"priority":{"description":"Policy priority","format":"int32","maximum":999,"minimum":1,"title":"Priority","type":"integer","x-stream-index":"006"},"resources":{"description":"List of resources to apply policy to","items":{"type":"string"},"minimum":1,"title":"Resources","type":"array","x-stream-index":"003"},"roles":{"description":"List of roles to apply policy to","items":{"type":"string"},"title":"Roles","type":"array","x-stream-index":"004"}},"required":["action","name","resources","roles","owner","priority"],"title":"PolicyRequest","type":"object"},"Poll":{"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"023"},"allow_answers":{"type":"boolean","x-stream-index":"010"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"009"},"answers_count":{"format":"int32","type":"integer","x-stream-index":"015"},"created_at":{"format":"date-time","type":"number","x-stream-index":"021"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"020"},"created_by_id":{"type":"string","x-stream-index":"019"},"description":{"type":"string","x-stream-index":"005"},"enforce_unique_vote":{"type":"boolean","x-stream-index":"007"},"id":{"type":"string","x-stream-index":"003"},"is_closed":{"type":"boolean","x-stream-index":"011"},"latest_answers":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array","x-stream-index":"017"},"latest_votes_by_option":{"additionalProperties":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array"},"type":"object","x-stream-index":"016"},"max_votes_allowed":{"format":"int32","type":"integer","x-stream-index":"008"},"name":{"type":"string","x-stream-index":"004"},"options":{"items":{"$ref":"#/components/schemas/PollOption"},"type":"array","x-stream-index":"013"},"own_votes":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array","x-stream-index":"018"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"022"},"vote_count":{"format":"int32","type":"integer","x-stream-index":"012"},"vote_counts_by_option":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"014"},"voting_visibility":{"type":"string","x-stream-index":"006"}},"required":["id","name","description","enforce_unique_vote","allow_user_suggested_options","allow_answers","vote_count","options","vote_counts_by_option","answers_count","latest_votes_by_option","latest_answers","own_votes","created_by_id","created_at","updated_at","Custom"],"type":"object"},"PollOption":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id","text","custom"],"type":"object"},"PollOptionInput":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"text":{"type":"string","x-stream-index":"002"}},"type":"object"},"PollOptionRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id"],"type":"object"},"PollOptionResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"poll_option":{"$ref":"#/components/schemas/PollOptionResponseData","description":"Poll option","title":"PollOptionResponseData","x-stream-index":"001"}},"required":["poll_option","duration"],"type":"object"},"PollOptionResponseData":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id","text","custom"],"type":"object"},"PollResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"poll":{"$ref":"#/components/schemas/PollResponseData","description":"Poll","title":"PollResponseData","x-stream-index":"001"}},"required":["poll","duration"],"type":"object"},"PollResponseData":{"properties":{"allow_answers":{"type":"boolean","x-stream-index":"008"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"007"},"answers_count":{"format":"int32","type":"integer","x-stream-index":"012"},"created_at":{"format":"date-time","type":"number","x-stream-index":"019"},"created_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"018"},"created_by_id":{"type":"string","x-stream-index":"017"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"021"},"description":{"type":"string","x-stream-index":"003"},"enforce_unique_vote":{"type":"boolean","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"is_closed":{"type":"boolean","x-stream-index":"009"},"latest_answers":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array","x-stream-index":"015"},"latest_votes_by_option":{"additionalProperties":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array"},"type":"object","x-stream-index":"014"},"max_votes_allowed":{"format":"int32","type":"integer","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"002"},"options":{"items":{"$ref":"#/components/schemas/PollOptionResponseData"},"type":"array","x-stream-index":"011"},"own_votes":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array","x-stream-index":"016"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"020"},"vote_count":{"format":"int32","type":"integer","x-stream-index":"010"},"vote_counts_by_option":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"013"},"voting_visibility":{"type":"string","x-stream-index":"004"}},"required":["id","name","description","voting_visibility","enforce_unique_vote","allow_user_suggested_options","allow_answers","vote_count","options","answers_count","vote_counts_by_option","latest_votes_by_option","latest_answers","own_votes","created_by_id","created_at","updated_at","custom"],"type":"object"},"PollVote":{"nullable":true,"properties":{"answer_text":{"type":"string","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"004"},"is_answer":{"type":"boolean","x-stream-index":"006"},"option_id":{"type":"string","x-stream-index":"005"},"poll_id":{"type":"string","x-stream-index":"003"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"011"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"009"},"user_id":{"type":"string","x-stream-index":"008"}},"required":["poll_id","id","option_id","created_at","updated_at"],"type":"object"},"PollVoteResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"vote":{"$ref":"#/components/schemas/PollVoteResponseData","description":"Poll vote","title":"PollVoteResponseData","x-stream-index":"001"}},"required":["duration"],"type":"object"},"PollVoteResponseData":{"nullable":true,"properties":{"answer_text":{"type":"string","x-stream-index":"005"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"id":{"type":"string","x-stream-index":"002"},"is_answer":{"type":"boolean","x-stream-index":"004"},"option_id":{"type":"string","x-stream-index":"003"},"poll_id":{"type":"string","x-stream-index":"001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"007"},"user_id":{"type":"string","x-stream-index":"006"}},"required":["poll_id","id","option_id","created_at","updated_at"],"type":"object"},"PollVotesResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"votes":{"description":"Poll votes","items":{"$ref":"#/components/schemas/PollVoteResponseData"},"title":"PollVoteResponseList","type":"array","x-stream-index":"001"}},"required":["votes","duration"],"type":"object"},"PrivacySettings":{"properties":{"read_receipts":{"$ref":"#/components/schemas/ReadReceipts","x-stream-index":"002"},"typing_indicators":{"$ref":"#/components/schemas/TypingIndicators","x-stream-index":"001"}},"type":"object"},"PrivacySettingsResponse":{"properties":{"read_receipts":{"$ref":"#/components/schemas/ReadReceiptsResponse","x-stream-index":"002"},"typing_indicators":{"$ref":"#/components/schemas/TypingIndicatorsResponse","x-stream-index":"001"}},"type":"object"},"PublisherAllMetrics":{"properties":{"audio":{"$ref":"#/components/schemas/PublisherAudioMetrics","x-stream-index":"001"},"rtt_ms":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"003"},"video":{"$ref":"#/components/schemas/PublisherVideoMetrics","x-stream-index":"002"}},"type":"object"},"PublisherAudioMetrics":{"properties":{"jitter_ms":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"001"}},"type":"object"},"PublisherStatsResponse":{"properties":{"by_track":{"items":{"$ref":"#/components/schemas/TrackStatsResponse"},"type":"array","x-stream-index":"003"},"total":{"format":"int32","type":"integer","x-stream-index":"001"},"unique":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["total","unique"],"type":"object"},"PublisherVideoMetrics":{"properties":{"fps_30":{"$ref":"#/components/schemas/ActiveCallsFPSStats","x-stream-index":"002"},"frame_encoding_time_ms":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"003"},"jitter_ms":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"001"}},"type":"object"},"PublishersMetrics":{"properties":{"all":{"$ref":"#/components/schemas/PublisherAllMetrics","x-stream-index":"001"}},"type":"object"},"PushConfig":{"properties":{"offline_only":{"type":"boolean","x-stream-index":"002"},"version":{"enum":["v1","v2","v3"],"type":"string","x-stream-index":"001"}},"required":["version"],"type":"object"},"PushNotificationFields":{"properties":{"apn":{"$ref":"#/components/schemas/APNConfigFields","x-stream-index":"002"},"firebase":{"$ref":"#/components/schemas/FirebaseConfigFields","x-stream-index":"003"},"huawei":{"$ref":"#/components/schemas/HuaweiConfigFields","x-stream-index":"004"},"offline_only":{"type":"boolean","x-stream-index":"001.002"},"providers":{"items":{"$ref":"#/components/schemas/PushProvider"},"type":"array","x-stream-index":"006"},"version":{"type":"string","x-stream-index":"001.001"},"xiaomi":{"$ref":"#/components/schemas/XiaomiConfigFields","x-stream-index":"005"}},"required":["version","offline_only","apn","firebase","huawei","xiaomi"],"type":"object"},"PushNotificationSettingsResponse":{"properties":{"disabled":{"type":"boolean","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"number","x-stream-index":"002"}},"type":"object"},"PushPreferenceInput":{"nullable":true,"properties":{"call_level":{"description":"Set the level of call push notifications for the user. One of all, none, default","enum":["all","none","default"],"type":"string","x-stream-index":"004"},"channel_cid":{"description":"Set the push preferences for a specific channel. If empty it sets the default for the user","type":"string","x-stream-index":"002"},"chat_level":{"description":"Set the level of chat push notifications for the user. One of all, mentions, none, default","enum":["all","mentions","none","default"],"type":"string","x-stream-index":"003"},"disabled_until":{"description":"Disable push notifications till a certain time","format":"date-time","type":"number","x-stream-index":"005"},"remove_disable":{"description":"Remove the disabled until time. (IE stop snoozing notifications)","type":"boolean","x-stream-index":"006"},"user_id":{"description":"The user id for which to set the push preferences. Required when using server side auths, defaults to current user with client side auth.","type":"string","x-stream-index":"001"}},"type":"object"},"PushPreferences":{"properties":{"call_level":{"type":"string","x-stream-index":"002"},"chat_level":{"type":"string","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"number","x-stream-index":"003"}},"type":"object"},"PushProvider":{"nullable":true,"properties":{"apn_auth_key":{"type":"string","x-stream-index":"012"},"apn_auth_type":{"type":"string","x-stream-index":"017"},"apn_development":{"type":"boolean","x-stream-index":"018"},"apn_host":{"type":"string","x-stream-index":"019"},"apn_key_id":{"type":"string","x-stream-index":"013"},"apn_notification_template":{"type":"string","x-stream-index":"020"},"apn_p12_cert":{"type":"string","x-stream-index":"014"},"apn_team_id":{"type":"string","x-stream-index":"015"},"apn_topic":{"type":"string","x-stream-index":"016"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"description":{"maxLength":128,"type":"string","x-stream-index":"007"},"disabled_at":{"format":"date-time","type":"number","x-stream-index":"010"},"disabled_reason":{"maxLength":255,"type":"string","x-stream-index":"011"},"firebase_apn_template":{"type":"string","x-stream-index":"025"},"firebase_credentials":{"type":"string","x-stream-index":"022"},"firebase_data_template":{"type":"string","x-stream-index":"023"},"firebase_host":{"type":"string","x-stream-index":"026"},"firebase_notification_template":{"type":"string","x-stream-index":"024"},"firebase_server_key":{"type":"string","x-stream-index":"021"},"huawei_app_id":{"type":"string","x-stream-index":"027"},"huawei_app_secret":{"type":"string","x-stream-index":"028"},"name":{"maxLength":36,"minLength":1,"type":"string","x-stream-index":"005"},"push_templates":{"items":{"$ref":"#/components/schemas/PushTemplate"},"type":"array","x-stream-index":"031"},"type":{"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"xiaomi_app_secret":{"type":"string","x-stream-index":"030"},"xiaomi_package_name":{"type":"string","x-stream-index":"029"}},"required":["name","type","created_at","updated_at"],"type":"object"},"PushProviderResponse":{"properties":{"apn_auth_key":{"type":"string","x-stream-index":"008"},"apn_auth_type":{"type":"string","x-stream-index":"013"},"apn_development":{"type":"boolean","x-stream-index":"014"},"apn_host":{"type":"string","x-stream-index":"015"},"apn_key_id":{"type":"string","x-stream-index":"009"},"apn_p12_cert":{"type":"string","x-stream-index":"010"},"apn_sandbox_certificate":{"type":"boolean","x-stream-index":"016"},"apn_supports_remote_notifications":{"type":"boolean","x-stream-index":"018"},"apn_supports_voip_notifications":{"type":"boolean","x-stream-index":"017"},"apn_team_id":{"type":"string","x-stream-index":"011"},"apn_topic":{"type":"string","x-stream-index":"012"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"description":{"type":"string","x-stream-index":"003"},"disabled_at":{"format":"date-time","type":"number","x-stream-index":"006"},"disabled_reason":{"type":"string","x-stream-index":"007"},"firebase_apn_template":{"type":"string","x-stream-index":"023"},"firebase_credentials":{"type":"string","x-stream-index":"020"},"firebase_data_template":{"type":"string","x-stream-index":"021"},"firebase_host":{"type":"string","x-stream-index":"024"},"firebase_notification_template":{"type":"string","x-stream-index":"022"},"firebase_server_key":{"type":"string","x-stream-index":"019"},"huawei_app_id":{"type":"string","x-stream-index":"025"},"huawei_app_secret":{"type":"string","x-stream-index":"026"},"name":{"type":"string","x-stream-index":"001"},"type":{"type":"string","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"005"},"xiaomi_app_secret":{"type":"string","x-stream-index":"028"},"xiaomi_package_name":{"type":"string","x-stream-index":"027"}},"required":["name","type","created_at","updated_at"],"type":"object"},"PushTemplate":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"enable_push":{"type":"boolean","x-stream-index":"003"},"event_type":{"enum":["message.new","message.updated","reaction.new","notification.reminder_due"],"type":"string","x-stream-index":"005"},"template":{"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"008"}},"required":["enable_push","event_type","created_at","updated_at"],"type":"object"},"Quality":{"properties":{"bitdepth":{"format":"int32","type":"integer","x-stream-index":"007"},"framerate":{"format":"int32","type":"integer","x-stream-index":"008"},"height":{"format":"int32","type":"integer","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"004"},"video_bitrate":{"format":"int32","type":"integer","x-stream-index":"009"},"width":{"format":"int32","type":"integer","x-stream-index":"005"}},"type":"object"},"QualityScoreReport":{"properties":{"histogram":{"items":{"$ref":"#/components/schemas/ReportByHistogramBucket"},"type":"array","x-stream-index":"001"}},"required":["histogram"],"type":"object"},"QualityScoreReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateQualityScoreReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"QueryAggregateCallStatsRequest":{"nullable":true,"properties":{"from":{"type":"string","x-stream-index":"002"},"report_types":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"to":{"type":"string","x-stream-index":"003"}},"type":"object"},"QueryAggregateCallStatsResponse":{"description":"Basic response information","nullable":true,"properties":{"call_duration_report":{"$ref":"#/components/schemas/CallDurationReportResponse","x-stream-index":"002"},"call_participant_count_report":{"$ref":"#/components/schemas/CallParticipantCountReportResponse","x-stream-index":"004"},"calls_per_day_report":{"$ref":"#/components/schemas/CallsPerDayReportResponse","x-stream-index":"003"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"network_metrics_report":{"$ref":"#/components/schemas/NetworkMetricsReportResponse","x-stream-index":"008"},"quality_score_report":{"$ref":"#/components/schemas/QualityScoreReportResponse","x-stream-index":"005"},"sdk_usage_report":{"$ref":"#/components/schemas/SDKUsageReportResponse","x-stream-index":"006"},"user_feedback_report":{"$ref":"#/components/schemas/UserFeedbackReportResponse","x-stream-index":"007"}},"required":["duration"],"title":"Response","type":"object"},"QueryBannedUsersPayload":{"properties":{"exclude_expired_bans":{"description":"Whether to exclude expired bans or not","title":"Exclude expired bans","type":"boolean","x-stream-index":"004"},"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"description":"Number of records to return","format":"int32","maximum":300,"minimum":0,"title":"Limit","type":"integer","x-stream-index":"003.003"},"offset":{"description":"Number of records to offset","format":"int32","maximum":10000,"title":"Offset","type":"integer","x-stream-index":"003.004"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":1,"title":"Sort","type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"005.002"},"user_id":{"type":"string","x-stream-index":"005.001"}},"required":["filter_conditions"],"type":"object"},"QueryBannedUsersResponse":{"nullable":true,"properties":{"bans":{"description":"List of found bans","items":{"$ref":"#/components/schemas/BanResponse"},"title":"BanResponse","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["bans","duration"],"type":"object"},"QueryCallMembersRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"002"},"id":{"maxLength":64,"type":"string","x-stream-index":"001.002"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"004.001"},"next":{"type":"string","x-stream-index":"004.002"},"prev":{"type":"string","x-stream-index":"004.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":1,"type":"array","x-stream-index":"003"},"type":{"maxLength":64,"type":"string","x-stream-index":"001.001"}},"required":["type","id"],"type":"object"},"QueryCallMembersResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["members","duration"],"title":"Response","type":"object"},"QueryCallParticipantsRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"003"}},"type":"object"},"QueryCallParticipantsResponse":{"nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001.001"},"duration":{"type":"string","x-stream-index":"004.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001.002"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"001.004"},"participants":{"description":"List of call participants","items":{"$ref":"#/components/schemas/CallParticipantResponse"},"title":"[]CallParticipantResponse","type":"array","x-stream-index":"002"},"total_participants":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["call","members","own_capabilities","blocked_users","participants","total_participants","duration"],"type":"object"},"QueryCallStatsRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"004.001"},"next":{"type":"string","x-stream-index":"004.002"},"prev":{"type":"string","x-stream-index":"004.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":2,"type":"array","x-stream-index":"002"}},"type":"object"},"QueryCallStatsResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"next":{"type":"string","x-stream-index":"003.001"},"prev":{"type":"string","x-stream-index":"003.002"},"reports":{"items":{"$ref":"#/components/schemas/CallStatsReportSummaryResponse"},"type":"array","x-stream-index":"001"}},"required":["reports","duration"],"title":"Response","type":"object"},"QueryCallsRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"title":"Filters","type":"object","x-stream-index":"003"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"006.001"},"next":{"type":"string","x-stream-index":"006.002"},"prev":{"type":"string","x-stream-index":"006.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":2,"title":"Sort","type":"array","x-stream-index":"004"}},"title":"QueryCallsRequest","type":"object"},"QueryCallsResponse":{"nullable":true,"properties":{"calls":{"items":{"$ref":"#/components/schemas/CallStateResponseFields"},"title":"Calls","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["calls","duration"],"title":"QueryCallsResponse","type":"object"},"QueryCampaignsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"004.001"},"next":{"type":"string","x-stream-index":"004.002"},"prev":{"type":"string","x-stream-index":"004.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"type":"array","x-stream-index":"002"},"user_limit":{"format":"int32","maximum":1000,"minimum":0,"type":"integer","x-stream-index":"003"}},"type":"object"},"QueryCampaignsResponse":{"description":"Basic response information","nullable":true,"properties":{"campaigns":{"items":{"$ref":"#/components/schemas/CampaignResponse"},"type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["campaigns","duration"],"title":"Response","type":"object"},"QueryChannelsRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"description":"Number of channels to limit","format":"int32","title":"Limit","type":"integer","x-stream-index":"008"},"member_limit":{"description":"Number of members to limit","format":"int32","maximum":100,"minimum":0,"title":"Member limit","type":"integer","x-stream-index":"007"},"message_limit":{"description":"Number of messages to limit","format":"int32","minimum":0,"title":"Message limit","type":"integer","x-stream-index":"006"},"offset":{"description":"Channel pagination offset","format":"int32","title":"Offset","type":"integer","x-stream-index":"009"},"sort":{"description":"List of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"002"},"state":{"description":"Whether to update channel state or not","title":"State","type":"boolean","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"010.002"},"user_id":{"type":"string","x-stream-index":"010.001"}},"title":"Query Channels Request","type":"object","x-stream-docs-page-id":"query_channels"},"QueryChannelsResponse":{"nullable":true,"properties":{"channels":{"description":"List of channels","items":{"$ref":"#/components/schemas/ChannelStateResponseFields"},"title":"Channels","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["channels","duration"],"title":"Channels list","type":"object"},"QueryDraftsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","maximum":3,"title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"type":"object"},"QueryDraftsResponse":{"nullable":true,"properties":{"drafts":{"description":"Drafts","items":{"$ref":"#/components/schemas/DraftResponse"},"title":"DraftsResponseList","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["drafts","duration"],"type":"object"},"QueryFeedModerationTemplate":{"properties":{"config":{"$ref":"#/components/schemas/FeedsModerationTemplateConfig","description":"Configuration for the moderation template","title":"Config","x-stream-index":"002"},"created_at":{"description":"When the template was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"003"},"name":{"description":"Name of the moderation template","title":"Name","type":"string","x-stream-index":"001"},"updated_at":{"description":"When the template was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"004"}},"required":["name","created_at","updated_at"],"type":"object"},"QueryFeedModerationTemplatesResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"templates":{"description":"List of moderation templates","items":{"$ref":"#/components/schemas/QueryFeedModerationTemplate"},"title":"Templates","type":"array","x-stream-index":"001"}},"required":["templates","duration"],"type":"object"},"QueryMembersPayload":{"description":"Client request","properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"002"},"limit":{"format":"int32","maximum":300,"minimum":0,"type":"integer","x-stream-index":"006.003"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"type":"array","x-stream-index":"003"},"offset":{"format":"int32","maximum":10000,"type":"integer","x-stream-index":"006.004"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":1,"type":"array","x-stream-index":"005"},"type":{"maxLength":64,"type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"007.002"},"user_id":{"type":"string","x-stream-index":"007.001"}},"required":["type","filter_conditions"],"title":"ClientRequest","type":"object"},"QueryMessageFlagsPayload":{"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":300,"minimum":0,"type":"integer","x-stream-index":"003.003"},"offset":{"format":"int32","maximum":10000,"type":"integer","x-stream-index":"003.004"},"show_deleted_messages":{"description":"Whether to include deleted messages in the results","title":"ShowDeletedMessages","type":"boolean","x-stream-index":"002"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"type":"array","x-stream-index":"003.005"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"type":"object"},"QueryMessageFlagsResponse":{"description":"Query message flags response","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"flags":{"description":"The flags that match the query","items":{"$ref":"#/components/schemas/MessageFlagResponse"},"title":"MessageFlagResponseList","type":"array","x-stream-index":"001"}},"required":["flags","duration"],"title":"QueryMessageFlagsResponse","type":"object"},"QueryMessageHistoryRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","maximum":3,"minimum":1,"title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"004.001"},"next":{"type":"string","x-stream-index":"004.002"},"prev":{"type":"string","x-stream-index":"004.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"002"}},"required":["filter"],"type":"object"},"QueryMessageHistoryResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message_history":{"description":"Message history entries","items":{"$ref":"#/components/schemas/MessageHistoryEntryResponse"},"title":"MessageHistoryEntryResponseList","type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["message_history","duration"],"type":"object"},"QueryModerationConfigsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter conditions for moderation configs","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"Sorting parameters for the results","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"type":"object"},"QueryModerationConfigsResponse":{"nullable":true,"properties":{"configs":{"description":"List of moderation configurations","items":{"$ref":"#/components/schemas/ConfigResponse"},"title":"Configs","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["configs","duration"],"type":"object"},"QueryModerationFlagsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParam"},"type":"array","x-stream-index":"002"}},"type":"object"},"QueryModerationFlagsResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"flags":{"items":{"$ref":"#/components/schemas/ModerationFlagResponse"},"type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["flags","duration"],"title":"Response","type":"object"},"QueryModerationLogsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter conditions for moderation logs","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"Sorting parameters for the results","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"type":"object"},"QueryModerationLogsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"003.001"},"logs":{"description":"List of moderation action logs","items":{"$ref":"#/components/schemas/ActionLogResponse"},"title":"Logs","type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["logs","duration"],"type":"object"},"QueryPollVotesRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","title":"Filter","type":"object","x-stream-index":"003"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"004"}},"type":"object"},"QueryPollsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","title":"Filter","type":"object","x-stream-index":"002"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"003"}},"type":"object"},"QueryPollsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"polls":{"description":"Polls data returned by the query","items":{"$ref":"#/components/schemas/PollResponseData"},"title":"PollsResponseData","type":"array","x-stream-index":"001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["polls","duration"],"type":"object"},"QueryReactionsRequest":{"properties":{"filter":{"additionalProperties":{},"type":"object","x-stream-index":"002"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"006.001"},"next":{"type":"string","x-stream-index":"006.002"},"prev":{"type":"string","x-stream-index":"006.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":2,"type":"array","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"type":"object"},"QueryReactionsResponse":{"description":"Basic response information","properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"next":{"type":"string","x-stream-index":"003.001"},"prev":{"type":"string","x-stream-index":"003.002"},"reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"001"}},"required":["reactions","duration"],"title":"Response","type":"object"},"QueryRemindersRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"type":"object"},"QueryRemindersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"reminders":{"description":"MessageReminders data returned by the query","items":{"$ref":"#/components/schemas/ReminderResponseData"},"title":"RemindersResponseData","type":"array","x-stream-index":"001"}},"required":["reminders","duration"],"type":"object"},"QueryReviewQueueRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter conditions for review queue items","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"007.001"},"lock_count":{"description":"Number of items to lock (1-25)","format":"int32","maximum":25,"minimum":1,"title":"Lock Count","type":"integer","x-stream-index":"005"},"lock_duration":{"description":"Duration for which items should be locked","title":"Lock Duration","type":"integer","x-stream-index":"004"},"lock_items":{"description":"Whether to lock items for review (true), unlock items (false), or just fetch (nil)","title":"Lock Items","type":"boolean","x-stream-index":"003"},"next":{"type":"string","x-stream-index":"007.002"},"prev":{"type":"string","x-stream-index":"007.003"},"sort":{"description":"Sorting parameters for the results","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"002"},"stats_only":{"description":"Whether to return only statistics","title":"Stats Only","type":"boolean","x-stream-index":"006"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"008.002"},"user_id":{"type":"string","x-stream-index":"008.001"}},"type":"object"},"QueryReviewQueueResponse":{"nullable":true,"properties":{"action_config":{"additionalProperties":{"items":{"$ref":"#/components/schemas/ModerationActionConfig"},"type":"array"},"description":"Configuration for moderation actions","title":"Action Config","type":"object","x-stream-index":"002"},"duration":{"type":"string","x-stream-index":"005.001"},"items":{"description":"List of review queue items","items":{"$ref":"#/components/schemas/ReviewQueueItemResponse"},"title":"Items","type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"004.001"},"prev":{"type":"string","x-stream-index":"004.002"},"stats":{"additionalProperties":{},"description":"Statistics about the review queue","title":"Stats","type":"object","x-stream-index":"003"}},"required":["items","action_config","stats","duration"],"type":"object"},"QuerySegmentTargetsRequest":{"nullable":true,"properties":{"Filter":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"005"},"Sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"type":"array","writeOnly":true,"x-stream-index":"006"},"limit":{"description":"Limit","format":"int32","maximum":10000,"minimum":0,"title":"int","type":"integer","x-stream-index":"002"},"next":{"description":"Next","title":"string","type":"string","x-stream-index":"003"},"prev":{"description":"Prev","title":"string","type":"string","x-stream-index":"004"}},"type":"object"},"QuerySegmentTargetsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"targets":{"description":"Targets","items":{"$ref":"#/components/schemas/SegmentTargetResponse"},"title":"SegmentTargetResponseList","type":"array","x-stream-index":"001"}},"required":["targets","duration"],"type":"object"},"QuerySegmentsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"002"}},"required":["filter"],"type":"object"},"QuerySegmentsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"segments":{"description":"Segments","items":{"$ref":"#/components/schemas/SegmentResponse"},"title":"SegmentResponses","type":"array","x-stream-index":"001"}},"required":["segments","duration"],"type":"object"},"QueryThreadsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter conditions to apply to threads","title":"Filter","type":"object","x-stream-index":"006"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"008.001"},"member_limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005"},"next":{"type":"string","x-stream-index":"008.002"},"participant_limit":{"description":"Limit the number of participants returned per each thread","format":"int32","maximum":100,"minimum":0,"title":"Participant limit","type":"integer","x-stream-index":"004"},"prev":{"type":"string","x-stream-index":"008.003"},"reply_limit":{"description":"Limit the number of replies returned per each thread","format":"int32","maximum":10,"minimum":0,"title":"Reply limit","type":"integer","x-stream-index":"003"},"sort":{"description":"Sort conditions to apply to threads","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"007"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"010.002"},"user_id":{"type":"string","x-stream-index":"010.001"}},"type":"object"},"QueryThreadsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"threads":{"description":"List of enriched thread states","items":{"$ref":"#/components/schemas/ThreadStateResponse"},"title":"Threads","type":"array","x-stream-index":"001"}},"required":["threads","duration"],"type":"object"},"QueryUserFeedbackRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":2,"type":"array","x-stream-index":"002"}},"type":"object"},"QueryUserFeedbackResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"next":{"type":"string","x-stream-index":"003.001"},"prev":{"type":"string","x-stream-index":"003.002"},"user_feedback":{"items":{"$ref":"#/components/schemas/UserFeedbackResponse"},"type":"array","x-stream-index":"001"}},"required":["user_feedback","duration"],"title":"Response","type":"object"},"QueryUsersPayload":{"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"include_deactivated_users":{"type":"boolean","x-stream-index":"004"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.003"},"offset":{"format":"int32","maximum":1000,"type":"integer","x-stream-index":"005.004"},"presence":{"type":"boolean","x-stream-index":"003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"006.002"},"user_id":{"type":"string","x-stream-index":"006.001"}},"required":["filter_conditions"],"type":"object"},"QueryUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"users":{"description":"Array of users as result of filters applied.","items":{"$ref":"#/components/schemas/FullUserResponse"},"title":"Users","type":"array","x-stream-index":"001"}},"required":["users","duration"],"type":"object"},"RTMPBroadcastRequest":{"description":"RTMPBroadcastRequest is the payload for starting an RTMP broadcast.","properties":{"layout":{"$ref":"#/components/schemas/LayoutSettingsRequest","description":"If provided, will override the call's RTMP settings layout","title":"Layout","x-stream-index":"005"},"name":{"description":"Name identifier for RTMP broadcast, must be unique in call","maxLength":255,"title":"Name","type":"string","x-stream-index":"001"},"quality":{"description":"If provided, will override the call's RTMP settings quality","enum":["360p","480p","720p","1080p","1440p","portrait-360x640","portrait-480x854","portrait-720x1280","portrait-1080x1920","portrait-1440x2560"],"title":"Quality","type":"string","x-stream-index":"004"},"stream_key":{"description":"If provided, will be appended at the end of stream_url","title":"Stream Key","type":"string","x-stream-index":"003"},"stream_url":{"description":"URL for the RTMP server to send the call to","maxLength":255,"title":"Stream URL","type":"string","x-stream-index":"002"}},"required":["name","stream_url"],"title":"RTMPBroadcastRequest","type":"object"},"RTMPEgressConfig":{"properties":{"composite_app_settings":{"$ref":"#/components/schemas/CompositeAppSettings","x-stream-index":"005"},"quality":{"$ref":"#/components/schemas/Quality","x-stream-index":"004"},"rtmp_location":{"type":"string","x-stream-index":"006"}},"type":"object"},"RTMPIngress":{"description":"RTMP input settings","properties":{"address":{"title":"Address","type":"string","x-stream-index":"001"}},"required":["address"],"title":"RTMPIngress","type":"object"},"RTMPLocation":{"properties":{"name":{"type":"string","x-stream-index":"001"},"stream_key":{"type":"string","x-stream-index":"003"},"stream_url":{"type":"string","x-stream-index":"002"}},"required":["name","stream_url","stream_key"],"type":"object"},"RTMPSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"003"},"location":{"$ref":"#/components/schemas/RTMPLocation","x-stream-index":"004"},"quality_name":{"type":"string","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"RTMPSettingsRequest":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettingsRequest","description":"Layout for the composed RTMP stream","title":"LayoutSettings","x-stream-index":"003"},"quality":{"description":"Resolution to set for the RTMP stream","enum":["360p","480p","720p","1080p","1440p","portrait-360x640","portrait-480x854","portrait-720x1280","portrait-1080x1920","portrait-1440x2560"],"title":"Quality","type":"string","x-stream-index":"002"}},"title":"RTMPSettingsRequest","type":"object"},"RTMPSettingsResponse":{"description":"RTMPSettingsResponse is the payload for RTMP settings","properties":{"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettingsResponse","title":"Layout","x-stream-index":"003"},"quality":{"title":"Quality","type":"string","x-stream-index":"002"}},"required":["enabled","quality","layout"],"title":"RTMPSettingsResponse","type":"object"},"Reaction":{"nullable":true,"properties":{"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"message_id":{"type":"string","x-stream-index":"003"},"score":{"format":"int32","type":"integer","x-stream-index":"007"},"type":{"maxLength":30,"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["message_id","type","score","created_at","updated_at","custom"],"type":"object"},"ReactionDeletedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"006.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"002"},"team":{"type":"string","x-stream-index":"005.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"reaction.deleted","type":"string","x-stream-index":"006.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"ReactionDeletedEvent","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"},"ReactionGroupResponse":{"description":"ReactionGroupResponse contains all information about a reaction of the same type.","nullable":true,"properties":{"count":{"description":"Count is the number of reactions of this type.","format":"int32","title":"Count","type":"integer","x-stream-index":"001"},"first_reaction_at":{"description":"FirstReactionAt is the time of the first reaction of this type. This is the same also if all reaction of this type are deleted, because if someone will react again with the same type, will be preserved the sorting.","format":"date-time","title":"FirstReactionAt","type":"number","x-stream-index":"003"},"last_reaction_at":{"description":"LastReactionAt is the time of the last reaction of this type.","format":"date-time","title":"LastReactionAt","type":"number","x-stream-index":"004"},"sum_scores":{"description":"SumScores is the sum of all scores of reactions of this type. Medium allows you to clap articles more than once and shows the sum of all claps from all users. For example, you can send `clap` x5 using `score: 5`.","format":"int32","title":"SumScores","type":"integer","x-stream-index":"002"}},"required":["count","sum_scores","first_reaction_at","last_reaction_at"],"title":"ReactionGroupResponse","type":"object"},"ReactionNewEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"006.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"002"},"team":{"type":"string","x-stream-index":"005.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"reaction.new","type":"string","x-stream-index":"006.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"ReactionNewEvent","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"},"ReactionRequest":{"description":"Represents user reaction to a message","properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"score":{"description":"Reaction score. If not specified reaction has score of 1","format":"int32","title":"Score","type":"integer","x-stream-index":"002"},"type":{"description":"The type of reaction (e.g. 'like', 'laugh', 'wow')","maxLength":30,"title":"Type","type":"string","x-stream-index":"001"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"006.002"},"user_id":{"type":"string","x-stream-index":"006.001"}},"required":["type"],"title":"Reaction","type":"object","x-stream-docs-page-id":"send_reaction"},"ReactionResponse":{"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"006"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"008"},"message_id":{"description":"Message ID","title":"Message ID","type":"string","x-stream-index":"001"},"score":{"description":"Score of the reaction","format":"int32","title":"Score","type":"integer","x-stream-index":"005"},"type":{"description":"Type of reaction","title":"Type","type":"string","x-stream-index":"004"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"007"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User","title":"UserResponse","x-stream-index":"003"},"user_id":{"description":"User ID","title":"User ID","type":"string","x-stream-index":"002"}},"required":["message_id","user_id","user","type","score","created_at","updated_at","custom"],"type":"object"},"ReactionUpdatedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"006.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"002"},"team":{"type":"string","x-stream-index":"005.001"},"type":{"default":"reaction.updated","type":"string","x-stream-index":"006.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["message","reaction","cid","channel_id","channel_type","type","created_at"],"title":"ReactionUpdatedEvent","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"},"ReactivateUserRequest":{"nullable":true,"properties":{"created_by_id":{"description":"ID of the user who's reactivating the user","title":"Created by ID","type":"string","x-stream-index":"004"},"name":{"description":"Set this field to put new name for the user","title":"Name","type":"string","x-stream-index":"003"},"restore_messages":{"description":"Restore previously deleted messages","title":"Restore messages","type":"boolean","x-stream-index":"002"}},"type":"object"},"ReactivateUserResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.002.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Deactivated user object","title":"User","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"ReactivateUsersRequest":{"description":"Reactivate users in batches","nullable":true,"properties":{"created_by_id":{"description":"ID of the user who's reactivating the users","title":"Created by ID","type":"string","x-stream-index":"003"},"restore_channels":{"type":"boolean","x-stream-index":"004"},"restore_messages":{"description":"Restore previously deleted messages","title":"Restore messages","type":"boolean","x-stream-index":"002"},"user_ids":{"description":"User IDs to reactivate","items":{"type":"string"},"maximum":100,"minimum":1,"title":"User IDs","type":"array","x-stream-index":"001"}},"required":["user_ids"],"title":"ReactivateUsersRequest","type":"object"},"ReactivateUsersResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.002.001"},"task_id":{"type":"string","x-stream-index":"001.001"}},"required":["task_id","duration"],"title":"Response","type":"object"},"ReadReceipts":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"ReadReceiptsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"ReadStateResponse":{"properties":{"last_read":{"format":"date-time","type":"number","x-stream-index":"002"},"last_read_message_id":{"type":"string","x-stream-index":"004"},"unread_messages":{"format":"int32","type":"integer","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"}},"required":["user","last_read","unread_messages"],"type":"object"},"RecordSettings":{"properties":{"audio_only":{"type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"004"},"mode":{"type":"string","x-stream-index":"002"},"quality":{"type":"string","x-stream-index":"003"}},"required":["mode"],"type":"object"},"RecordSettingsRequest":{"properties":{"audio_only":{"type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettingsRequest","title":"LayoutSettings","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"title":"Mode","type":"string","x-stream-index":"002"},"quality":{"enum":["360p","480p","720p","1080p","1440p","portrait-360x640","portrait-480x854","portrait-720x1280","portrait-1080x1920","portrait-1440x2560"],"type":"string","x-stream-index":"003"}},"required":["mode"],"title":"RecordSettingsRequest","type":"object"},"RecordSettingsResponse":{"description":"RecordSettings is the payload for recording settings","properties":{"audio_only":{"title":"Audio Only","type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettingsResponse","title":"Layout","x-stream-index":"004"},"mode":{"title":"Mode","type":"string","x-stream-index":"002"},"quality":{"title":"Quality","type":"string","x-stream-index":"003"}},"required":["audio_only","mode","quality","layout"],"title":"RecordSettingsResponse","type":"object"},"RecordingEgressConfig":{"properties":{"audio_only":{"type":"boolean","x-stream-index":"006"},"composite_app_settings":{"$ref":"#/components/schemas/CompositeAppSettings","x-stream-index":"005"},"external_storage":{"$ref":"#/components/schemas/ExternalStorage","x-stream-index":"008"},"quality":{"$ref":"#/components/schemas/Quality","x-stream-index":"004"},"storage_name":{"type":"string","x-stream-index":"007"},"video_orientation_hint":{"$ref":"#/components/schemas/VideoOrientation","x-stream-index":"009"}},"type":"object"},"ReminderCreatedEvent":{"description":"Emitted when a reminder is created.","nullable":true,"properties":{"cid":{"description":"The CID of the Channel for which the reminder was created","title":"Channel CID","type":"string","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.007"},"message_id":{"description":"The ID of the message for which the reminder was created","title":"Message ID","type":"string","x-stream-index":"001.002"},"parent_id":{"description":"The ID of the parent message, if the reminder is for a thread message","title":"Parent ID","type":"string","x-stream-index":"001.005"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","description":"The reminder object which was created","title":"MessageReminder","x-stream-index":"001.006"},"type":{"default":"reminder.created","description":"The type of event: \"reminder.created\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.002"},"user_id":{"description":"The ID of the user for whom the reminder was created","title":"User ID","type":"string","x-stream-index":"001.003"}},"required":["type","created_at","custom","message_id","user_id","cid"],"title":"ReminderCreatedEvent","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"},"ReminderDeletedEvent":{"description":"Emitted when a reminder is deleted.","nullable":true,"properties":{"cid":{"description":"The CID of the Channel for which the reminder was created","title":"Channel CID","type":"string","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.007"},"message_id":{"description":"The ID of the message for which the reminder was created","title":"Message ID","type":"string","x-stream-index":"001.002"},"parent_id":{"description":"The ID of the parent message, if the reminder is for a thread message","title":"Parent ID","type":"string","x-stream-index":"001.005"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","description":"The reminder object which was created","title":"MessageReminder","x-stream-index":"001.006"},"type":{"default":"reminder.deleted","description":"The type of event: \"reminder.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.002"},"user_id":{"description":"The ID of the user for whom the reminder was created","title":"User ID","type":"string","x-stream-index":"001.003"}},"required":["type","created_at","custom","message_id","user_id","cid"],"title":"ReminderDeletedEvent","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"},"ReminderNotificationEvent":{"description":"Emitted when a reminder becomes due, triggering a notification for the user.","nullable":true,"properties":{"cid":{"description":"The CID of the Channel for which the reminder was created","title":"Channel CID","type":"string","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.007"},"message_id":{"description":"The ID of the message for which the reminder was created","title":"Message ID","type":"string","x-stream-index":"001.002"},"parent_id":{"type":"string","x-stream-index":"001.005"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","description":"The reminder object which was created","title":"MessageReminder","x-stream-index":"001.006"},"type":{"default":"notification.reminder_due","description":"The type of event: \"notification.reminder_due\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.002"},"user_id":{"description":"The ID of the user for whom the reminder was created","title":"User ID","type":"string","x-stream-index":"001.003"}},"required":["type","created_at","custom","message_id","user_id","cid"],"title":"ReminderNotificationEvent","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"},"ReminderResponseData":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003"},"channel_cid":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"005"},"message_id":{"type":"string","x-stream-index":"004"},"remind_at":{"format":"date-time","type":"number","x-stream-index":"001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007"},"user_id":{"type":"string","x-stream-index":"006"}},"required":["channel_cid","message_id","user_id","created_at","updated_at"],"type":"object"},"ReminderUpdatedEvent":{"description":"Emitted when a reminder is updated.","nullable":true,"properties":{"cid":{"description":"The CID of the Channel for which the reminder was created","title":"Channel CID","type":"string","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.007"},"message_id":{"description":"The ID of the message for which the reminder was created","title":"Message ID","type":"string","x-stream-index":"001.002"},"parent_id":{"description":"The ID of the parent message, if the reminder is for a thread message","title":"Parent ID","type":"string","x-stream-index":"001.005"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","description":"The reminder object which was created","title":"MessageReminder","x-stream-index":"001.006"},"type":{"default":"reminder.updated","description":"The type of event: \"reminder.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.002"},"user_id":{"description":"The ID of the user for whom the reminder was created","title":"User ID","type":"string","x-stream-index":"001.003"}},"required":["type","created_at","custom","message_id","user_id","cid"],"title":"ReminderUpdatedEvent","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"},"ReportByHistogramBucket":{"properties":{"category":{"type":"string","x-stream-index":"001"},"count":{"format":"int32","type":"integer","x-stream-index":"005"},"lower_bound":{"$ref":"#/components/schemas/Bound","x-stream-index":"002"},"sum":{"format":"float","type":"number","x-stream-index":"004"},"upper_bound":{"$ref":"#/components/schemas/Bound","x-stream-index":"003"}},"required":["category","sum","count"],"type":"object"},"ReportResponse":{"properties":{"call":{"$ref":"#/components/schemas/CallReportResponse","x-stream-index":"003"},"participants":{"$ref":"#/components/schemas/ParticipantReportResponse","x-stream-index":"001"},"user_ratings":{"$ref":"#/components/schemas/UserRatingReportResponse","x-stream-index":"002"}},"required":["participants","user_ratings","call"],"type":"object"},"Response":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001"}},"required":["duration"],"title":"Response","type":"object"},"RestoreActionRequest":{"type":"object"},"RestoreUsersRequest":{"nullable":true,"properties":{"user_ids":{"items":{"type":"string"},"maximum":100,"minimum":1,"type":"array","x-stream-index":"001"}},"required":["user_ids"],"type":"object"},"ReviewQueueItem":{"properties":{"actions":{"items":{"$ref":"#/components/schemas/ActionLog"},"type":"array","x-stream-index":"035"},"activity":{"$ref":"#/components/schemas/EnrichedActivity","x-stream-index":"028"},"ai_text_severity":{"type":"string","x-stream-index":"021"},"archived_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"043"},"assigned_to":{"$ref":"#/components/schemas/User","x-stream-index":"032"},"bans":{"items":{"$ref":"#/components/schemas/Ban"},"type":"array","x-stream-index":"033"},"bounce_count":{"format":"int32","type":"integer","x-stream-index":"025"},"call":{"$ref":"#/components/schemas/Call","x-stream-index":"031"},"completed_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"018"},"config_key":{"type":"string","x-stream-index":"009"},"content_changed":{"type":"boolean","x-stream-index":"036"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"entity_creator":{"$ref":"#/components/schemas/EntityCreator","x-stream-index":"030"},"entity_id":{"type":"string","x-stream-index":"007"},"entity_type":{"type":"string","x-stream-index":"006"},"feeds_v2_activity":{"$ref":"#/components/schemas/EnrichedActivity","x-stream-index":"041"},"feeds_v2_reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"042"},"flag_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"045"},"flag_types":{"items":{"type":"string"},"type":"array","x-stream-index":"044"},"flags":{"items":{"$ref":"#/components/schemas/Flag"},"type":"array","x-stream-index":"034"},"flags_count":{"format":"int32","type":"integer","x-stream-index":"026"},"has_image":{"type":"boolean","x-stream-index":"012"},"has_text":{"type":"boolean","x-stream-index":"014"},"has_video":{"type":"boolean","x-stream-index":"013"},"id":{"type":"string","x-stream-index":"003"},"languages":{"items":{"type":"string"},"type":"array","x-stream-index":"019"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"027"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"010"},"moderation_payload_hash":{"type":"string","x-stream-index":"011"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"029"},"recommended_action":{"type":"string","x-stream-index":"017"},"reporter_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"046"},"reviewed_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"022"},"reviewed_by":{"type":"string","x-stream-index":"023"},"severity":{"format":"int32","type":"integer","x-stream-index":"020"},"status":{"type":"string","x-stream-index":"016"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"015"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"005"}},"required":["id","created_at","updated_at","entity_type","entity_id","config_key","moderation_payload_hash","has_image","has_video","has_text","teams","status","recommended_action","completed_at","languages","severity","ai_text_severity","reviewed_at","reviewed_by","bounce_count","flags_count","bans","flags","actions","content_changed","archived_at","flag_types","flag_labels","reporter_ids"],"type":"object"},"ReviewQueueItemNewEvent":{"description":"This event is sent when a new moderation review queue item is created","nullable":true,"properties":{"action":{"$ref":"#/components/schemas/ActionLogResponse","description":"The action log if any action was taken","title":"Action","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"flags":{"description":"The flags associated with this review queue item","items":{"$ref":"#/components/schemas/FlagResponse"},"title":"Flags","type":"array","x-stream-index":"003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"The review queue item that was created","title":"ReviewQueueItem","x-stream-index":"002"},"type":{"default":"review_queue_item.new","type":"string","x-stream-index":"001.002"}},"required":["type","created_at","custom"],"title":"ReviewQueueItemNewEvent","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"},"ReviewQueueItemResponse":{"properties":{"actions":{"description":"Moderation actions taken","items":{"$ref":"#/components/schemas/ActionLogResponse"},"title":"Actions","type":"array","x-stream-index":"024"},"activity":{"$ref":"#/components/schemas/EnrichedActivity","x-stream-index":"016"},"ai_text_severity":{"description":"AI-determined text severity","title":"AI Text Severity","type":"string","x-stream-index":"014"},"assigned_to":{"$ref":"#/components/schemas/UserResponse","description":"Moderator assigned to review this item","title":"Assigned To","x-stream-index":"021"},"bans":{"description":"Associated ban records","items":{"$ref":"#/components/schemas/Ban"},"title":"Bans","type":"array","x-stream-index":"022"},"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"018"},"completed_at":{"description":"When the review was completed","format":"date-time","title":"Completed At","type":"number","x-stream-index":"009"},"config_key":{"type":"string","x-stream-index":"028"},"created_at":{"description":"When the item was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"002"},"entity_creator":{"$ref":"#/components/schemas/EntityCreatorResponse","description":"Details about who created the entity","title":"Entity Creator","x-stream-index":"019"},"entity_creator_id":{"description":"ID of who created the entity","title":"Entity Creator ID","type":"string","x-stream-index":"020"},"entity_id":{"description":"ID of the entity being reviewed","title":"Entity ID","type":"string","x-stream-index":"005"},"entity_type":{"description":"Type of entity being reviewed","title":"Entity Type","type":"string","x-stream-index":"004"},"feeds_v2_activity":{"$ref":"#/components/schemas/EnrichedActivity","description":"Associated feed activity","title":"Feeds V2 Activity","x-stream-index":"025"},"feeds_v2_reaction":{"$ref":"#/components/schemas/Reaction","description":"Associated feed reaction","title":"Feeds V2 Reaction","x-stream-index":"026"},"flags":{"description":"Associated flag records","items":{"$ref":"#/components/schemas/FlagResponse"},"title":"Flags","type":"array","x-stream-index":"023"},"flags_count":{"format":"int32","type":"integer","x-stream-index":"029"},"id":{"description":"Unique identifier of the review queue item","title":"ID","type":"string","x-stream-index":"001"},"languages":{"description":"Detected languages in the content","items":{"type":"string"},"title":"Languages","type":"array","x-stream-index":"012"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Associated message details","title":"Message","x-stream-index":"015"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content being moderated","title":"Moderation Payload","x-stream-index":"006"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"017"},"recommended_action":{"description":"Suggested moderation action","title":"Recommended Action","type":"string","x-stream-index":"008"},"reviewed_at":{"description":"When the item was reviewed","format":"date-time","title":"Reviewed At","type":"number","x-stream-index":"010"},"reviewed_by":{"description":"ID of the moderator who reviewed the item","title":"Reviewed By","type":"string","x-stream-index":"011"},"severity":{"description":"Severity level of the content","format":"int32","title":"Severity","type":"integer","x-stream-index":"013"},"status":{"description":"Current status of the review","title":"Status","type":"string","x-stream-index":"007"},"teams":{"description":"Teams associated with this item","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"027"},"updated_at":{"description":"When the item was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"003"}},"required":["id","created_at","updated_at","entity_type","entity_id","status","recommended_action","reviewed_by","languages","severity","ai_text_severity","bans","flags","actions","flags_count"],"type":"object"},"ReviewQueueItemUpdatedEvent":{"description":"This event is sent when a moderation review queue item is updated","nullable":true,"properties":{"action":{"$ref":"#/components/schemas/ActionLogResponse","description":"The action log if any action was taken","title":"Action","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"flags":{"description":"The flags associated with this review queue item","items":{"$ref":"#/components/schemas/FlagResponse"},"title":"Flags","type":"array","x-stream-index":"003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"The review queue item that was updated","title":"ReviewQueueItem","x-stream-index":"002"},"type":{"default":"review_queue_item.updated","type":"string","x-stream-index":"001.002"}},"required":["type","created_at","custom"],"title":"ReviewQueueItemUpdatedEvent","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"},"RingSettings":{"properties":{"auto_cancel_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_timeout_ms","missed_call_timeout_ms"],"type":"object"},"RingSettingsRequest":{"properties":{"auto_cancel_timeout_ms":{"description":"When none of the callees accept a ring call in this time a rejection will be sent by the caller with reason 'timeout' by the SDKs","format":"int32","maximum":180000,"minimum":5000,"title":"AutoCancelTimeoutMs","type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"description":"When a callee is online but doesn't answer a ring call in this time a rejection will be sent with reason 'timeout' by the SDKs","format":"int32","maximum":180000,"minimum":5000,"title":"IncomingCallTimeoutMs","type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"description":"When a callee doesn't accept or reject a ring call in this time a missed call event will be sent","format":"int32","maximum":180000,"minimum":5000,"title":"MissedCallTimeoutMs","type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_timeout_ms"],"title":"RingSettingsRequest","type":"object"},"RingSettingsResponse":{"properties":{"auto_cancel_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_timeout_ms","missed_call_timeout_ms"],"type":"object"},"Role":{"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"004"},"custom":{"description":"Whether this is a custom role or built-in","title":"Custom","type":"boolean","x-stream-index":"002"},"name":{"description":"Unique role name","title":"Name","type":"string","x-stream-index":"001"},"scopes":{"description":"List of scopes where this role is currently present. `.app` means that role is present in app-level grants","items":{"type":"string"},"title":"Scopes","type":"array","x-stream-index":"003"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"005"}},"required":["name","custom","scopes","created_at","updated_at"],"type":"object"},"RuleBuilderAction":{"properties":{"ban_options":{"$ref":"#/components/schemas/BanOptions","x-stream-index":"002"},"flag_content_options":{"$ref":"#/components/schemas/FlagContentOptions","x-stream-index":"004"},"flag_user_options":{"$ref":"#/components/schemas/FlagUserOptions","x-stream-index":"003"},"remove_content_options":{"$ref":"#/components/schemas/BlockContentOptions","x-stream-index":"005"},"type":{"type":"string","x-stream-index":"001"}},"required":["type"],"type":"object"},"RuleBuilderCondition":{"properties":{"confidence":{"format":"float","type":"number","x-stream-index":"002"},"content_count_rule_params":{"$ref":"#/components/schemas/ContentCountRuleParameters","x-stream-index":"007"},"image_content_params":{"$ref":"#/components/schemas/ImageContentParameters","x-stream-index":"009"},"image_rule_params":{"$ref":"#/components/schemas/ImageRuleParameters","x-stream-index":"004"},"text_content_params":{"$ref":"#/components/schemas/TextContentParameters","x-stream-index":"008"},"text_rule_params":{"$ref":"#/components/schemas/TextRuleParameters","x-stream-index":"003"},"type":{"type":"string","x-stream-index":"001"},"user_created_within_params":{"$ref":"#/components/schemas/UserCreatedWithinParameters","x-stream-index":"011"},"user_rule_params":{"$ref":"#/components/schemas/UserRuleParameters","x-stream-index":"006"},"video_content_params":{"$ref":"#/components/schemas/VideoContentParameters","x-stream-index":"010"},"video_rule_params":{"$ref":"#/components/schemas/VideoRuleParameters","x-stream-index":"005"}},"required":["type"],"type":"object"},"RuleBuilderConditionGroup":{"properties":{"conditions":{"items":{"$ref":"#/components/schemas/RuleBuilderCondition"},"type":"array","x-stream-index":"002"},"logic":{"type":"string","x-stream-index":"001"}},"required":["logic","conditions"],"type":"object"},"RuleBuilderConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"rules":{"items":{"$ref":"#/components/schemas/RuleBuilderRule"},"type":"array","x-stream-index":"002"}},"required":["rules"],"type":"object"},"RuleBuilderRule":{"properties":{"action":{"$ref":"#/components/schemas/RuleBuilderAction","x-stream-index":"007"},"conditions":{"items":{"$ref":"#/components/schemas/RuleBuilderCondition"},"type":"array","x-stream-index":"004"},"cooldown_period":{"type":"string","x-stream-index":"009"},"enabled":{"type":"boolean","x-stream-index":"008"},"groups":{"items":{"$ref":"#/components/schemas/RuleBuilderConditionGroup"},"type":"array","x-stream-index":"006"},"id":{"type":"string","x-stream-index":"001"},"logic":{"type":"string","x-stream-index":"005"},"name":{"type":"string","x-stream-index":"002"},"rule_type":{"type":"string","x-stream-index":"003"}},"required":["id","name","rule_type","action","enabled"],"type":"object"},"S3Request":{"description":"Config for creating Amazon S3 storage.","properties":{"s3_api_key":{"description":"The AWS API key. To use Amazon S3 as your storage provider, you have two authentication options: IAM role or API key. If you do not specify the `s3_api_key` parameter, Stream will use IAM role authentication. In that case make sure to have the correct IAM role configured for your application.","title":"S3ApiKey","type":"string","x-stream-index":"002"},"s3_custom_endpoint_url":{"description":"The custom endpoint for S3. If you want to use a custom endpoint, you must also provide the `s3_api_key` and `s3_secret` parameters.","title":"S3CustomEndpointURL","type":"string","x-stream-index":"004"},"s3_region":{"description":"The AWS region where the bucket is hosted","title":"S3Region","type":"string","x-stream-index":"001"},"s3_secret":{"description":"The AWS API Secret","title":"S3Secret","type":"string","x-stream-index":"003"}},"required":["s3_region"],"title":"S3Request","type":"object"},"SDKUsageReport":{"properties":{"per_sdk_usage":{"additionalProperties":{"$ref":"#/components/schemas/PerSDKUsageReport"},"type":"object","x-stream-index":"001"}},"required":["per_sdk_usage"],"type":"object"},"SDKUsageReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateSDKUsageReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"SFUIDLastSeen":{"properties":{"id":{"type":"string","x-stream-index":"001.001"},"last_seen":{"format":"date-time","type":"number","x-stream-index":"002"},"process_start_time":{"format":"int64","type":"integer","x-stream-index":"001.002"}},"required":["id","process_start_time","last_seen"],"type":"object"},"STTEgressConfig":{"properties":{"closed_captions_enabled":{"type":"boolean","x-stream-index":"005"},"external_storage":{"$ref":"#/components/schemas/ExternalStorage","x-stream-index":"011"},"language":{"type":"string","x-stream-index":"008"},"storage_name":{"type":"string","x-stream-index":"010"},"translation_languages":{"items":{"type":"string"},"type":"array","x-stream-index":"009"},"translations_enabled":{"type":"boolean","x-stream-index":"006"},"upload_transcriptions":{"type":"boolean","x-stream-index":"004"},"whisper_server_base_url":{"type":"string","x-stream-index":"007"}},"type":"object"},"ScreensharingSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled"],"type":"object"},"ScreensharingSettingsRequest":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"type":"object"},"ScreensharingSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled"],"type":"object"},"SearchPayload":{"properties":{"filter_conditions":{"additionalProperties":{},"description":"Channel filter conditions","maximum":100,"minimum":1,"title":"Channel filter","type":"object","x-stream-docs-page-id":"query_channels","x-stream-index":"002"},"limit":{"description":"Number of messages to return","format":"int32","title":"Limit","type":"integer","x-stream-index":"005"},"message_filter_conditions":{"additionalProperties":{},"description":"Message filter conditions","title":"Message filter","type":"object","x-stream-index":"003"},"message_options":{"$ref":"#/components/schemas/MessageOptions","x-stream-index":"004"},"next":{"description":"Pagination parameter. Cannot be used with non-zero offset.","title":"Next","type":"string","x-stream-index":"008"},"offset":{"description":"Pagination offset. Cannot be used with sort or next.","format":"int32","title":"Offset","type":"integer","x-stream-index":"006"},"query":{"description":"Search phrase","title":"Query","type":"string","x-stream-index":"001"},"sort":{"description":"Sort parameters. Cannot be used with non-zero offset","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"007"}},"required":["filter_conditions"],"type":"object"},"SearchResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"005.001"},"next":{"description":"Value to pass to the next search query in order to paginate","title":"Next","type":"string","x-stream-index":"003"},"previous":{"description":"Value that points to the previous page. Pass as the next value in a search query to paginate backwards","title":"Previous","type":"string","x-stream-index":"004"},"results":{"description":"Search results","items":{"$ref":"#/components/schemas/SearchResult"},"title":"Results","type":"array","x-stream-index":"001"},"results_warning":{"$ref":"#/components/schemas/SearchWarning","description":"Warning about the search results","title":"Results Warning","x-stream-index":"002"}},"required":["results","duration"],"type":"object"},"SearchResult":{"properties":{"message":{"$ref":"#/components/schemas/SearchResultMessage","description":"Found message","title":"Message","x-stream-index":"001"}},"type":"object"},"SearchResultMessage":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"001.008"},"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel object","title":"Channel","x-stream-index":"002"},"cid":{"type":"string","x-stream-index":"001.022"},"command":{"type":"string","x-stream-index":"001.004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.023"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.026"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.025"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"001.018"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001.041"},"html":{"type":"string","x-stream-index":"001.005"},"i18n":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.030"},"id":{"type":"string","x-stream-index":"001.001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"001.028"},"latest_reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"001.009"},"mentioned_users":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"001.029"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"001.036"},"mml":{"type":"string","x-stream-index":"001.003"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"001.039"},"own_reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"001.010"},"parent_id":{"type":"string","x-stream-index":"001.015"},"pin_expires":{"format":"date-time","type":"number","x-stream-index":"001.035"},"pinned":{"type":"boolean","x-stream-index":"001.032"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"001.033"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001.034"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001.038"},"poll_id":{"type":"string","x-stream-index":"001.037"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001.020"},"quoted_message_id":{"type":"string","x-stream-index":"001.019"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001.011"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"001.014"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001.012"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"001.042"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"001.017"},"restricted_visibility":{"items":{"type":"string"},"type":"array","x-stream-index":"001.040"},"shadowed":{"type":"boolean","x-stream-index":"001.027"},"shared_location":{"$ref":"#/components/schemas/SharedLocationResponseData","x-stream-index":"001.043"},"show_in_channel":{"type":"boolean","x-stream-index":"001.016"},"silent":{"type":"boolean","x-stream-index":"001.031"},"text":{"type":"string","x-stream-index":"001.002"},"thread_participants":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"001.021"},"type":{"type":"string","x-stream-index":"001.006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.024"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001.007"}},"required":["id","text","html","type","user","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned","restricted_visibility"],"type":"object"},"SearchWarning":{"properties":{"channel_search_cids":{"description":"Channel CIDs for the searched channels","items":{"type":"string"},"title":"Channel Search CIDs","type":"array","x-stream-index":"004"},"channel_search_count":{"description":"Number of channels searched","format":"int32","title":"Channel Search Count","type":"integer","x-stream-index":"003"},"warning_code":{"description":"Code corresponding to the warning","format":"int32","title":"Warning Code","type":"integer","x-stream-index":"002"},"warning_description":{"description":"Description of the warning","title":"Warning Description","type":"string","x-stream-index":"001"}},"required":["warning_description","warning_code"],"type":"object"},"Segment":{"nullable":true,"properties":{"all_sender_channels":{"type":"boolean","x-stream-index":"007"},"all_users":{"type":"boolean","x-stream-index":"006"},"created_at":{"format":"date-time","type":"number","x-stream-index":"010"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"012"},"description":{"type":"string","x-stream-index":"004"},"filter":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"name":{"type":"string","x-stream-index":"003"},"size":{"format":"int32","type":"integer","x-stream-index":"009"},"task_id":{"type":"string","x-stream-index":"008"},"type":{"type":"string","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"011"}},"required":["id","type","name","all_users","all_sender_channels","size","created_at","updated_at"],"type":"object"},"SegmentResponse":{"properties":{"all_sender_channels":{"type":"boolean","x-stream-index":"007"},"all_users":{"type":"boolean","x-stream-index":"006"},"created_at":{"format":"date-time","type":"number","x-stream-index":"009"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"description":{"type":"string","x-stream-index":"004"},"filter":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"name":{"type":"string","x-stream-index":"003"},"size":{"format":"int32","type":"integer","x-stream-index":"008"},"type":{"type":"string","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"010"}},"required":["id","type","name","description","filter","all_users","all_sender_channels","size","created_at","updated_at","deleted_at"],"type":"object"},"SegmentTargetResponse":{"nullable":true,"properties":{"app_pk":{"format":"int32","type":"integer","x-stream-index":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"segment_id":{"type":"string","x-stream-index":"002"},"target_id":{"type":"string","x-stream-index":"003"}},"required":["app_pk","segment_id","target_id","created_at"],"type":"object"},"SendCallEventRequest":{"description":"Send a call event to the other user","nullable":true,"properties":{"custom":{"additionalProperties":{},"title":"Custom","type":"object","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"title":"SendCallEventRequest","type":"object"},"SendCallEventResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"SendCallEventResponse","type":"object"},"SendEventRequest":{"nullable":true,"properties":{"event":{"$ref":"#/components/schemas/EventRequest","x-stream-index":"001"}},"required":["event"],"type":"object"},"SendMessageRequest":{"nullable":true,"properties":{"force_moderation":{"type":"boolean","x-stream-index":"007"},"keep_channel_hidden":{"type":"boolean","x-stream-index":"008"},"message":{"$ref":"#/components/schemas/MessageRequest","x-stream-index":"001"},"pending":{"type":"boolean","x-stream-index":"006"},"pending_message_metadata":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"005"},"skip_enrich_url":{"type":"boolean","x-stream-index":"003"},"skip_push":{"type":"boolean","x-stream-index":"002"}},"required":["message"],"type":"object"},"SendMessageResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Message response","title":"Message","x-stream-index":"001"},"pending_message_metadata":{"additionalProperties":{"type":"string"},"description":"Pending message metadata","title":"Pending message metadata","type":"object","x-stream-index":"002"}},"required":["message","duration"],"type":"object"},"SendReactionRequest":{"nullable":true,"properties":{"enforce_unique":{"description":"Whether to replace all existing user reactions","title":"Enforce unique","type":"boolean","x-stream-index":"003"},"reaction":{"$ref":"#/components/schemas/ReactionRequest","x-stream-index":"002"},"skip_push":{"description":"Skips any mobile push notifications","title":"Skip push","type":"boolean","x-stream-index":"004"}},"required":["reaction"],"type":"object"},"SendReactionResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001"},"reaction":{"$ref":"#/components/schemas/ReactionResponse","x-stream-index":"002"}},"required":["message","reaction","duration"],"title":"Response","type":"object"},"SendUserCustomEventRequest":{"nullable":true,"properties":{"event":{"$ref":"#/components/schemas/UserCustomEventRequest","x-stream-index":"001"}},"required":["event"],"type":"object"},"SessionSettings":{"properties":{"inactivity_timeout_seconds":{"format":"int32","maximum":900,"minimum":5,"type":"integer","x-stream-index":"001"}},"required":["inactivity_timeout_seconds"],"type":"object"},"SessionSettingsRequest":{"properties":{"inactivity_timeout_seconds":{"format":"int32","maximum":900,"minimum":5,"type":"integer","x-stream-index":"001"}},"required":["inactivity_timeout_seconds"],"type":"object"},"SessionSettingsResponse":{"properties":{"inactivity_timeout_seconds":{"format":"int32","maximum":900,"minimum":5,"type":"integer","x-stream-index":"001"}},"required":["inactivity_timeout_seconds"],"type":"object"},"ShadowBlockActionRequest":{"type":"object"},"SharedLocation":{"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"013"},"channel_cid":{"type":"string","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"010"},"created_by_device_id":{"type":"string","x-stream-index":"008"},"end_at":{"format":"date-time","type":"number","x-stream-index":"009"},"latitude":{"format":"float","maximum":90,"minimum":18446744073709552000,"type":"number","x-stream-index":"006"},"longitude":{"format":"float","maximum":180,"minimum":18446744073709552000,"type":"number","x-stream-index":"007"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"012"},"message_id":{"type":"string","x-stream-index":"004"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"011"},"user_id":{"type":"string","x-stream-index":"005"}},"required":["channel_cid","message_id","user_id","created_by_device_id","created_at","updated_at"],"type":"object"},"SharedLocationResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001.011"},"channel_cid":{"description":"Channel CID","title":"string","type":"string","x-stream-index":"001.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.008"},"created_by_device_id":{"description":"Device ID that created the live location","title":"string","type":"string","x-stream-index":"001.006"},"duration":{"type":"string","x-stream-index":"002.001"},"end_at":{"description":"Time when the live location expires","format":"date-time","title":"string","type":"number","x-stream-index":"001.007"},"latitude":{"description":"Latitude coordinate","format":"float","title":"number","type":"number","x-stream-index":"001.004"},"longitude":{"description":"Longitude coordinate","format":"float","title":"number","type":"number","x-stream-index":"001.005"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001.010"},"message_id":{"description":"Message ID","title":"string","type":"string","x-stream-index":"001.002"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.009"},"user_id":{"description":"User ID","title":"string","type":"string","x-stream-index":"001.003"}},"required":["channel_cid","message_id","user_id","latitude","longitude","created_by_device_id","created_at","updated_at","duration"],"type":"object"},"SharedLocationResponseData":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"011"},"channel_cid":{"type":"string","x-stream-index":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"created_by_device_id":{"type":"string","x-stream-index":"006"},"end_at":{"format":"date-time","type":"number","x-stream-index":"007"},"latitude":{"format":"float","type":"number","x-stream-index":"004"},"longitude":{"format":"float","type":"number","x-stream-index":"005"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"010"},"message_id":{"type":"string","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["channel_cid","message_id","user_id","latitude","longitude","created_by_device_id","created_at","updated_at"],"type":"object"},"SharedLocationsResponse":{"nullable":true,"properties":{"active_live_locations":{"items":{"$ref":"#/components/schemas/SharedLocationResponseData"},"type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["active_live_locations","duration"],"type":"object"},"ShowChannelRequest":{"nullable":true,"properties":{"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"002.002"},"user_id":{"type":"string","x-stream-index":"002.001"}},"type":"object"},"ShowChannelResponse":{"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"},"SortParam":{"nullable":true,"properties":{"direction":{"format":"int32","type":"integer","x-stream-index":"002"},"field":{"type":"string","x-stream-index":"001"}},"type":"object"},"SortParamRequest":{"nullable":true,"properties":{"direction":{"description":"Direction of sorting, 1 for Ascending, -1 for Descending, default is 1","format":"int32","title":"Direction","type":"integer","x-stream-index":"002"},"field":{"description":"Name of field to sort by","title":"Field","type":"string","x-stream-index":"001"}},"type":"object"},"StartCampaignRequest":{"nullable":true,"properties":{"scheduled_for":{"format":"date-time","type":"number","x-stream-index":"002"},"stop_at":{"format":"date-time","type":"number","x-stream-index":"003"}},"type":"object"},"StartCampaignResponse":{"description":"Basic response information","nullable":true,"properties":{"campaign":{"$ref":"#/components/schemas/CampaignResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"users":{"$ref":"#/components/schemas/PagerResponse","x-stream-index":"002"}},"required":["duration"],"title":"Response","type":"object"},"StartClosedCaptionsRequest":{"nullable":true,"properties":{"enable_transcription":{"description":"Enable transcriptions along with closed captions","title":"Enable Transcription","type":"boolean","x-stream-index":"002"},"external_storage":{"description":"Which external storage to use for transcriptions (only applicable if enable_transcription is true)","title":"External Storage","type":"string","x-stream-index":"003"},"language":{"description":"The spoken language in the call, if not provided the language defined in the transcription settings will be used","enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"title":"Language","type":"string","x-stream-index":"004"}},"type":"object"},"StartClosedCaptionsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"StartFrameRecordingRequest":{"nullable":true,"properties":{"recording_external_storage":{"type":"string","x-stream-index":"002"}},"title":"StartFrameRecordingRequest","type":"object"},"StartFrameRecordingResponse":{"description":"StartFrameRecordingResponse is the response payload for the start frame recording endpoint.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StartFrameRecordingResponse","type":"object"},"StartHLSBroadcastingRequest":{"description":"StartHLSBroadcastingRequest is the payload for starting an HLS broadcasting.","nullable":true,"title":"StartHLSBroadcastingRequest","type":"object"},"StartHLSBroadcastingResponse":{"description":"StartHLSBroadcastingResponse is the payload for starting an HLS broadcasting.","nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"},"playlist_url":{"description":"the URL of the HLS playlist","title":"PlaylistURL","type":"string","x-stream-index":"002"}},"required":["duration","playlist_url"],"title":"StartHLSBroadcastingResponse","type":"object"},"StartRTMPBroadcastsRequest":{"description":"StartRTMPBroadcastsRequest is the payload for starting RTMP broadcasts.","nullable":true,"properties":{"broadcasts":{"description":"List of broadcasts to start","items":{"$ref":"#/components/schemas/RTMPBroadcastRequest"},"maximum":1,"minimum":1,"title":"Broadcasts","type":"array","x-stream-index":"002"}},"required":["broadcasts"],"title":"StartRTMPBroadcastsRequest","type":"object"},"StartRTMPBroadcastsResponse":{"description":"StartRTMPBroadcastsResponse is the payload for starting an RTMP broadcast.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StartRTMPBroadcastsResponse","type":"object"},"StartRecordingRequest":{"nullable":true,"properties":{"recording_external_storage":{"type":"string","x-stream-index":"002"}},"title":"StartRecordingRequest","type":"object"},"StartRecordingResponse":{"description":"StartRecordingResponse is the response payload for the start recording endpoint.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StartRecordingResponse","type":"object"},"StartTranscriptionRequest":{"nullable":true,"properties":{"enable_closed_captions":{"description":"Enable closed captions along with transcriptions","title":"Enable Closed Captions","type":"boolean","x-stream-index":"003"},"language":{"description":"The spoken language in the call, if not provided the language defined in the transcription settings will be used","enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"title":"Language","type":"string","x-stream-index":"004"},"transcription_external_storage":{"description":"Store transcriptions in this external storage","title":"External Storage","type":"string","x-stream-index":"002"}},"type":"object"},"StartTranscriptionResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StartTranscriptionResponse","type":"object"},"StopAllRTMPBroadcastsRequest":{"nullable":true,"title":"StopAllRTMPBroadcastsRequest","type":"object"},"StopAllRTMPBroadcastsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StopAllRTMPBroadcastsResponse","type":"object"},"StopCampaignRequest":{"nullable":true,"type":"object"},"StopClosedCaptionsRequest":{"nullable":true,"properties":{"stop_transcription":{"type":"boolean","x-stream-index":"003"}},"type":"object"},"StopClosedCaptionsResponse":{"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"},"StopFrameRecordingRequest":{"nullable":true,"type":"object"},"StopFrameRecordingResponse":{"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"},"StopHLSBroadcastingRequest":{"nullable":true,"type":"object"},"StopHLSBroadcastingResponse":{"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"},"StopLiveRequest":{"nullable":true,"properties":{"continue_closed_caption":{"type":"boolean","x-stream-index":"006"},"continue_hls":{"type":"boolean","x-stream-index":"003"},"continue_recording":{"type":"boolean","x-stream-index":"004"},"continue_rtmp_broadcasts":{"type":"boolean","x-stream-index":"007"},"continue_transcription":{"type":"boolean","x-stream-index":"005"}},"title":"StopLiveRequest","type":"object"},"StopLiveResponse":{"nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"The call that was stopped","title":"Call","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["call","duration"],"title":"StopLiveResponse","type":"object"},"StopRTMPBroadcastsRequest":{"description":"Request for stopping RTMP broadcasts","nullable":true,"title":"StopRTMPBroadcastsRequest","type":"object"},"StopRTMPBroadcastsResponse":{"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"},"StopRecordingRequest":{"nullable":true,"type":"object"},"StopRecordingResponse":{"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"},"StopTranscriptionRequest":{"nullable":true,"properties":{"stop_closed_captions":{"type":"boolean","x-stream-index":"003"}},"type":"object"},"StopTranscriptionResponse":{"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"},"SubmitActionRequest":{"nullable":true,"properties":{"action_type":{"description":"Type of moderation action to perform (mark_reviewed, delete_message, etc.)","enum":["mark_reviewed","delete_message","delete_activity","delete_reaction","ban","custom","unban","restore","delete_user","unblock","shadow_block","unmask","kick_user","end_call"],"title":"Action Type","type":"string","x-stream-index":"002"},"ban":{"$ref":"#/components/schemas/BanActionRequest","description":"Configuration for ban action","title":"Ban","x-stream-index":"008"},"custom":{"$ref":"#/components/schemas/CustomActionRequest","description":"Configuration for custom action","title":"Custom","x-stream-index":"009"},"delete_activity":{"$ref":"#/components/schemas/DeleteActivityRequest","description":"Configuration for activity deletion action","title":"Delete Activity","x-stream-index":"004"},"delete_message":{"$ref":"#/components/schemas/DeleteMessageRequest","description":"Configuration for message deletion action","title":"Delete Message","x-stream-index":"003"},"delete_reaction":{"$ref":"#/components/schemas/DeleteReactionRequest","description":"Configuration for reaction deletion action","title":"Delete Reaction","x-stream-index":"005"},"delete_user":{"$ref":"#/components/schemas/DeleteUserRequest","description":"Configuration for user deletion action","title":"Delete User","x-stream-index":"006"},"item_id":{"description":"UUID of the review queue item to act on","title":"Item ID","type":"string","x-stream-index":"001"},"mark_reviewed":{"$ref":"#/components/schemas/MarkReviewedRequest","description":"Configuration for marking item as reviewed","title":"Mark Reviewed","x-stream-index":"007"},"unban":{"$ref":"#/components/schemas/UnbanActionRequest","description":"Configuration for unban action","title":"Unban","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"016.002"},"user_id":{"type":"string","x-stream-index":"016.001"}},"required":["item_id","action_type"],"type":"object"},"SubmitActionResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"Updated review queue item after action was performed","title":"Item","x-stream-index":"001"}},"required":["duration"],"type":"object"},"SubscriberAllMetrics":{"properties":{"audio":{"$ref":"#/components/schemas/SubscriberAudioMetrics","x-stream-index":"001"},"rtt_ms":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"003"},"video":{"$ref":"#/components/schemas/SubscriberVideoMetrics","x-stream-index":"002"}},"type":"object"},"SubscriberAudioMetrics":{"properties":{"concealment_pct":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"003"},"jitter_ms":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"001"},"packets_lost_pct":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"002"}},"type":"object"},"SubscriberStatsResponse":{"properties":{"total":{"format":"int32","type":"integer","x-stream-index":"001"},"total_subscribed_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"003"},"unique":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["total","unique","total_subscribed_duration_seconds"],"type":"object"},"SubscriberVideoMetrics":{"properties":{"fps_30":{"$ref":"#/components/schemas/ActiveCallsFPSStats","x-stream-index":"002"},"jitter_ms":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"001"},"packets_lost_pct":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"003"}},"type":"object"},"SubscribersMetrics":{"properties":{"all":{"$ref":"#/components/schemas/SubscriberAllMetrics","x-stream-index":"001"}},"type":"object"},"TargetResolution":{"properties":{"bitrate":{"format":"int32","maximum":6000000,"type":"integer","x-stream-index":"003"},"height":{"format":"int32","maximum":3840,"minimum":240,"type":"integer","x-stream-index":"002"},"width":{"format":"int32","maximum":3840,"minimum":240,"type":"integer","x-stream-index":"001"}},"required":["width","height","bitrate"],"type":"object"},"TextContentParameters":{"properties":{"blocklist_match":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"contains_url":{"type":"boolean","x-stream-index":"002"},"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001"},"severity":{"type":"string","x-stream-index":"003"}},"type":"object"},"TextRuleParameters":{"properties":{"blocklist_match":{"items":{"type":"string"},"type":"array","x-stream-index":"006"},"contains_url":{"type":"boolean","x-stream-index":"004"},"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"severity":{"type":"string","x-stream-index":"005"},"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"required":["threshold","time_window"],"type":"object"},"ThreadParticipant":{"description":"Represents a user that is participating in a thread.","nullable":true,"properties":{"app_pk":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"001"},"channel_cid":{"type":"string","x-stream-index":"002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"007"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"last_read_at":{"format":"date-time","type":"number","x-stream-index":"009"},"last_thread_message_at":{"format":"date-time","type":"number","x-stream-index":"003"},"left_thread_at":{"description":"Left Thread At is the time when the user left the thread","format":"date-time","title":"Left Thread At","type":"number","x-stream-index":"008"},"thread_id":{"description":"Thead ID is unique string identifier of the thread","title":"ID","type":"string","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User is the user object","title":"User","x-stream-index":"006"},"user_id":{"description":"User ID is unique string identifier of the user","title":"User ID","type":"string","x-stream-index":"005"}},"required":["app_pk","channel_cid","created_at","last_read_at","custom"],"title":"ThreadParticipant","type":"object"},"ThreadResponse":{"properties":{"active_participant_count":{"description":"Active Participant Count","format":"int32","title":"Active Participant Count","type":"integer","x-stream-index":"009"},"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel","title":"ChannelResponse","x-stream-index":"002"},"channel_cid":{"description":"Channel CID","title":"Channel CID","type":"string","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"012"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"Created By User","title":"User","x-stream-index":"006"},"created_by_user_id":{"description":"Created By User ID","title":"Created By User ID","type":"string","x-stream-index":"005"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"016"},"deleted_at":{"description":"Deleted At","format":"date-time","title":"Deleted At","type":"number","x-stream-index":"014"},"last_message_at":{"description":"Last Message At","format":"date-time","title":"Last Message At","type":"number","x-stream-index":"011"},"parent_message":{"$ref":"#/components/schemas/MessageResponse","description":"Parent Message","title":"Message","x-stream-index":"004"},"parent_message_id":{"description":"Parent Message ID","title":"Parent Message ID","type":"string","x-stream-index":"003"},"participant_count":{"description":"Participant Count","format":"int32","title":"Participant Count","type":"integer","x-stream-index":"008"},"reply_count":{"description":"Reply Count","format":"int32","title":"Reply Count","type":"integer","x-stream-index":"007"},"thread_participants":{"description":"Thread Participants","items":{"$ref":"#/components/schemas/ThreadParticipant"},"title":"ThreadParticipants","type":"array","x-stream-index":"010"},"title":{"description":"Title","title":"Title","type":"string","x-stream-index":"015"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"013"}},"required":["channel_cid","parent_message_id","created_by_user_id","created_at","updated_at","title","custom"],"type":"object"},"ThreadStateResponse":{"nullable":true,"properties":{"active_participant_count":{"description":"Active Participant Count","format":"int32","title":"Active Participant Count","type":"integer","x-stream-index":"001.009"},"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel","title":"ChannelResponse","x-stream-index":"001.002"},"channel_cid":{"description":"Channel CID","title":"Channel CID","type":"string","x-stream-index":"001.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.012"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"Created By User","title":"User","x-stream-index":"001.006"},"created_by_user_id":{"description":"Created By User ID","title":"Created By User ID","type":"string","x-stream-index":"001.005"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"001.016"},"deleted_at":{"description":"Deleted At","format":"date-time","title":"Deleted At","type":"number","x-stream-index":"001.014"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"004"},"last_message_at":{"description":"Last Message At","format":"date-time","title":"Last Message At","type":"number","x-stream-index":"001.011"},"latest_replies":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","x-stream-index":"002"},"parent_message":{"$ref":"#/components/schemas/MessageResponse","description":"Parent Message","title":"Message","x-stream-index":"001.004"},"parent_message_id":{"description":"Parent Message ID","title":"Parent Message ID","type":"string","x-stream-index":"001.003"},"participant_count":{"description":"Participant Count","format":"int32","title":"Participant Count","type":"integer","x-stream-index":"001.008"},"read":{"items":{"$ref":"#/components/schemas/ReadStateResponse"},"type":"array","x-stream-index":"003"},"reply_count":{"description":"Reply Count","format":"int32","title":"Reply Count","type":"integer","x-stream-index":"001.007"},"thread_participants":{"description":"Thread Participants","items":{"$ref":"#/components/schemas/ThreadParticipant"},"title":"ThreadParticipants","type":"array","x-stream-index":"001.010"},"title":{"description":"Title","title":"Title","type":"string","x-stream-index":"001.015"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.013"}},"required":["channel_cid","parent_message_id","created_by_user_id","created_at","updated_at","title","custom","latest_replies"],"type":"object"},"ThreadUpdatedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"001.002"},"channel_type":{"type":"string","x-stream-index":"001.003"},"cid":{"type":"string","x-stream-index":"001.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"thread":{"$ref":"#/components/schemas/ThreadResponse","x-stream-index":"003.001"},"type":{"default":"thread.updated","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"ThreadUpdatedEvent","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"},"Thresholds":{"description":"Sets thresholds for AI moderation","properties":{"explicit":{"$ref":"#/components/schemas/LabelThresholds","description":"Thresholds for explicit messages","title":"LabelThresholds","x-stream-index":"001"},"spam":{"$ref":"#/components/schemas/LabelThresholds","description":"Thresholds for spam","title":"LabelThresholds","x-stream-index":"002"},"toxic":{"$ref":"#/components/schemas/LabelThresholds","description":"Thresholds for toxic messages","title":"LabelThresholds","x-stream-index":"003"}},"title":"Auto moderation thresholds","type":"object"},"ThumbnailResponse":{"properties":{"image_url":{"type":"string","x-stream-index":"001"}},"required":["image_url"],"type":"object"},"ThumbnailsSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"ThumbnailsSettingsRequest":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"ThumbnailsSettingsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"Time":{"type":"object"},"TrackStatsResponse":{"nullable":true,"properties":{"duration_seconds":{"format":"int32","type":"integer","x-stream-index":"002"},"track_type":{"type":"string","x-stream-index":"001"}},"required":["track_type","duration_seconds"],"type":"object"},"TranscriptionSettings":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"title":"Mode","type":"string","x-stream-index":"002"},"language":{"description":"The language used in this call as a two letter code","enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"title":"Language","type":"string","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"title":"Mode","type":"string","x-stream-index":"001"}},"required":["mode","closed_caption_mode","languages","language"],"type":"object"},"TranscriptionSettingsRequest":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"002"},"language":{"enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"type":"string","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode"],"type":"object"},"TranscriptionSettingsResponse":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"002"},"language":{"enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"type":"string","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode","closed_caption_mode","languages","language"],"type":"object"},"TranslateMessageRequest":{"nullable":true,"properties":{"language":{"description":"Language to translate message to","enum":["af","sq","am","ar","az","bn","bs","bg","zh","zh-TW","hr","cs","da","fa-AF","nl","en","et","fi","fr","fr-CA","ka","de","el","ha","he","hi","hu","id","it","ja","ko","lv","ms","no","fa","ps","pl","pt","ro","ru","sr","sk","sl","so","es","es-MX","sw","sv","tl","ta","th","tr","uk","ur","vi","lt","ht"],"title":"Language","type":"string","x-stream-index":"001"}},"required":["language"],"type":"object"},"TruncateChannelRequest":{"nullable":true,"properties":{"hard_delete":{"description":"Permanently delete channel data (messages, reactions, etc.)","title":"Hard delete","type":"boolean","x-stream-index":"002"},"member_ids":{"description":"List of member IDs to hide message history for. If empty, truncates the channel for all members","items":{"type":"string"},"maximum":100,"title":"Member IDs","type":"array","x-stream-index":"007"},"message":{"$ref":"#/components/schemas/MessageRequest","x-stream-index":"004"},"skip_push":{"description":"When `message` is set disables all push notifications for it","title":"Skip push","type":"boolean","x-stream-index":"005"},"truncated_at":{"description":"Truncate channel data up to `truncated_at`. The system message (if provided) creation time is always greater than `truncated_at`","format":"date-time","title":"Truncated at","type":"number","x-stream-index":"006"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"008.002"},"user_id":{"type":"string","x-stream-index":"008.001"}},"type":"object"},"TruncateChannelResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Truncated channel object","title":"Channel","x-stream-index":"002"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Truncated message object","title":"Message","x-stream-index":"003"}},"required":["duration"],"type":"object"},"TypingIndicators":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"TypingIndicatorsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"UnbanActionRequest":{"type":"object"},"UnbanRequest":{"nullable":true,"properties":{"unbanned_by":{"$ref":"#/components/schemas/UserRequest","description":"Details about the user performing the unban","title":"Unbanned By","x-stream-index":"005"},"unbanned_by_id":{"description":"ID of the user performing the unban","title":"Unbanned By ID","type":"string","x-stream-index":"004"}},"type":"object"},"UnbanResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"UnblockActionRequest":{"type":"object"},"UnblockUserRequest":{"description":"UnblockUserRequest is the payload for unblocking a user.","nullable":true,"properties":{"user_id":{"description":"the user to unblock","title":"UserID","type":"string","x-stream-index":"003"}},"required":["user_id"],"title":"UnblockUserRequest","type":"object"},"UnblockUserResponse":{"description":"UnblockUserResponse is the payload for unblocking a user.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"UnblockUserResponse","type":"object"},"UnblockUsersRequest":{"nullable":true,"properties":{"blocked_user_id":{"type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"required":["blocked_user_id"],"type":"object"},"UnblockUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"UnblockedUserEvent":{"description":"This event is sent when a user is unblocked on a call,\nthis can be useful to notify the user that they can now join the call again","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.unblocked_user","description":"The type of event: \"call.unblocked_user\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user that was unblocked","title":"User","x-stream-index":"003"}},"required":["type","created_at","call_cid","user"],"title":"UnblockedUserEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"UnmuteChannelRequest":{"nullable":true,"properties":{"channel_cids":{"description":"Channel CIDs to mute (if multiple channels)","items":{"type":"string"},"maximum":25,"title":"Channel CIDs","type":"array","x-stream-index":"001.002"},"expiration":{"description":"Duration of mute in milliseconds","title":"Expiration","type":"integer","x-stream-index":"001.003"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"002.002"},"user_id":{"type":"string","x-stream-index":"002.001"}},"type":"object"},"UnmuteRequest":{"nullable":true,"properties":{"target_ids":{"description":"User IDs to unmute","items":{"type":"string"},"title":"Target IDs","type":"array","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"002.002"},"user_id":{"type":"string","x-stream-index":"002.001"}},"required":["target_ids"],"title":"UnmuteRequest","type":"object"},"UnmuteResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"non_existing_users":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"required":["duration"],"title":"Response","type":"object"},"UnpinRequest":{"description":"UnpinRequest is the payload for unpinning a message.","nullable":true,"properties":{"session_id":{"description":"the session ID of the user who pinned the message","title":"SessionID","type":"string","x-stream-index":"003"},"user_id":{"description":"the user ID of the user who pinned the message","title":"UserID","type":"string","x-stream-index":"002"}},"required":["user_id","session_id"],"title":"UnpinRequest","type":"object"},"UnpinResponse":{"description":"UnpinResponse is the payload for unpinning a message.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"UnpinResponse","type":"object"},"UnreadCountsBatchRequest":{"nullable":true,"properties":{"user_ids":{"items":{"type":"string"},"maximum":100,"type":"array","x-stream-index":"001"}},"required":["user_ids"],"type":"object"},"UnreadCountsBatchResponse":{"description":"Basic response information","nullable":true,"properties":{"counts_by_user":{"additionalProperties":{"$ref":"#/components/schemas/UnreadCountsResponse"},"type":"object","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["counts_by_user","duration"],"title":"Response","type":"object"},"UnreadCountsChannel":{"properties":{"channel_id":{"type":"string","x-stream-index":"001"},"last_read":{"format":"date-time","type":"number","x-stream-index":"003"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["channel_id","unread_count","last_read"],"type":"object"},"UnreadCountsChannelType":{"properties":{"channel_count":{"format":"int32","type":"integer","x-stream-index":"002"},"channel_type":{"type":"string","x-stream-index":"001"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["channel_type","channel_count","unread_count"],"type":"object"},"UnreadCountsResponse":{"nullable":true,"properties":{"channel_type":{"items":{"$ref":"#/components/schemas/UnreadCountsChannelType"},"type":"array","x-stream-index":"005"},"channels":{"items":{"$ref":"#/components/schemas/UnreadCountsChannel"},"type":"array","x-stream-index":"004"},"threads":{"items":{"$ref":"#/components/schemas/UnreadCountsThread"},"type":"array","x-stream-index":"006"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"001"},"total_unread_count_by_team":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"003"},"total_unread_threads_count":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["total_unread_count","total_unread_threads_count","channels","channel_type","threads"],"type":"object"},"UnreadCountsThread":{"properties":{"last_read":{"format":"date-time","type":"number","x-stream-index":"002"},"last_read_message_id":{"type":"string","x-stream-index":"003"},"parent_message_id":{"type":"string","x-stream-index":"004"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"001"}},"required":["unread_count","last_read","last_read_message_id","parent_message_id"],"type":"object"},"UpdateAppRequest":{"nullable":true,"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.017"},"apn_config":{"$ref":"#/components/schemas/APNConfig","x-stream-index":"001.003"},"async_moderation_config":{"$ref":"#/components/schemas/AsyncModerationConfiguration","x-stream-index":"001.039"},"async_url_enrich_enabled":{"type":"boolean","x-stream-index":"001.019"},"auto_translation_enabled":{"type":"boolean","x-stream-index":"001.018"},"before_message_send_hook_url":{"type":"string","x-stream-index":"001.020"},"cdn_expiration_seconds":{"format":"int32","maximum":1209600,"minimum":14400,"type":"integer","x-stream-index":"001.038"},"channel_hide_members_only":{"type":"boolean","x-stream-index":"001.033"},"custom_action_handler_url":{"type":"string","x-stream-index":"001.021"},"datadog_info":{"$ref":"#/components/schemas/DataDogInfo","x-stream-index":"001.040"},"disable_auth_checks":{"type":"boolean","x-stream-index":"001.001"},"disable_permissions_checks":{"type":"boolean","x-stream-index":"001.002"},"enforce_unique_usernames":{"enum":["no","app","team"],"type":"string","x-stream-index":"001.022"},"event_hooks":{"items":{"$ref":"#/components/schemas/EventHook"},"type":"array","x-stream-index":"001.046"},"feeds_moderation_enabled":{"type":"boolean","x-stream-index":"001.042"},"feeds_v2_region":{"type":"string","x-stream-index":"001.041"},"file_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","x-stream-index":"001.030"},"firebase_config":{"$ref":"#/components/schemas/FirebaseConfig","x-stream-index":"001.004"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"001.034"},"guest_user_creation_disabled":{"type":"boolean","x-stream-index":"001.043"},"huawei_config":{"$ref":"#/components/schemas/HuaweiConfig","x-stream-index":"001.005"},"image_moderation_block_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001.015"},"image_moderation_enabled":{"type":"boolean","x-stream-index":"001.016"},"image_moderation_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001.014"},"image_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","x-stream-index":"001.029"},"migrate_permissions_to_v2":{"type":"boolean","x-stream-index":"001.035"},"moderation_dashboard_preferences":{"$ref":"#/components/schemas/ModerationDashboardPreferences","x-stream-index":"001.044"},"moderation_enabled":{"type":"boolean","x-stream-index":"001.009"},"moderation_webhook_url":{"type":"string","x-stream-index":"001.010"},"multi_tenant_enabled":{"type":"boolean","x-stream-index":"001.013"},"permission_version":{"enum":["v1","v2"],"type":"string","x-stream-index":"001.011"},"push_config":{"$ref":"#/components/schemas/PushConfig","x-stream-index":"001.007"},"reminders_interval":{"format":"int32","maximum":86400,"minimum":60,"type":"integer","x-stream-index":"001.036"},"reminders_max_members":{"format":"int32","minimum":2,"type":"integer","x-stream-index":"001.037"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.031"},"sns_key":{"type":"string","x-stream-index":"001.027"},"sns_secret":{"type":"string","x-stream-index":"001.028"},"sns_topic_arn":{"type":"string","x-stream-index":"001.026"},"sqs_key":{"type":"string","x-stream-index":"001.024"},"sqs_secret":{"type":"string","x-stream-index":"001.025"},"sqs_url":{"type":"string","x-stream-index":"001.023"},"user_response_time_enabled":{"type":"boolean","x-stream-index":"001.048"},"user_search_disallowed_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"001.012"},"webhook_events":{"items":{"type":"string"},"type":"array","x-stream-index":"001.032"},"webhook_url":{"type":"string","x-stream-index":"001.008"},"xiaomi_config":{"$ref":"#/components/schemas/XiaomiConfig","x-stream-index":"001.006"}},"type":"object"},"UpdateBlockListRequest":{"nullable":true,"properties":{"team":{"type":"string","x-stream-index":"002"},"words":{"description":"List of words to block","items":{"type":"string"},"minimum":1,"title":"Words","type":"array","x-stream-index":"003"}},"title":"Update block list","type":"object","x-stream-docs-page-id":"update_block_list"},"UpdateBlockListResponse":{"description":"Basic response information","nullable":true,"properties":{"blocklist":{"$ref":"#/components/schemas/BlockListResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["duration"],"title":"Response","type":"object"},"UpdateCallMembersRequest":{"description":"Update call members","nullable":true,"properties":{"remove_members":{"description":"List of userID to remove","items":{"type":"string"},"maximum":100,"title":"Remove Members","type":"array","x-stream-index":"003"},"update_members":{"description":"List of members to update or insert","items":{"$ref":"#/components/schemas/MemberRequest"},"maximum":100,"title":"Update Members","type":"array","x-stream-index":"004"}},"title":"UpdateCallMembersRequest","type":"object"},"UpdateCallMembersResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"002"}},"required":["duration","members"],"title":"Response","type":"object"},"UpdateCallRequest":{"description":"Request for updating a call","nullable":true,"properties":{"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"003"},"settings_override":{"$ref":"#/components/schemas/CallSettingsRequest","description":"the settings to change for this call","title":"Settings Override","x-stream-index":"004"},"starts_at":{"description":"the time the call is scheduled to start","format":"date-time","title":"Starts At","type":"number","x-stream-index":"005"}},"title":"UpdateCallRequest","type":"object"},"UpdateCallResponse":{"description":"Response for updating a call","nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001.001"},"duration":{"type":"string","x-stream-index":"002.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001.002"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"001.004"}},"required":["call","members","own_capabilities","blocked_users","duration"],"title":"UpdateCallResponse","type":"object"},"UpdateCallTypeRequest":{"description":"UpdateCallTypeRequest is the payload for updating a call type.","nullable":true,"properties":{"external_storage":{"type":"string","x-stream-index":"002.004"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"002.001"},"notification_settings":{"$ref":"#/components/schemas/NotificationSettings","x-stream-index":"002.002"},"settings":{"$ref":"#/components/schemas/CallSettingsRequest","x-stream-index":"002.003"}},"title":"UpdateCallTypeRequest","type":"object"},"UpdateCallTypeResponse":{"description":"UpdateCallTypeResponse is the payload for updating a call type.","nullable":true,"properties":{"created_at":{"description":"the time the call type was created","format":"date-time","title":"CreatedAt","type":"number","x-stream-index":"001.005"},"duration":{"type":"string","x-stream-index":"002.001"},"external_storage":{"description":"the external storage for the call type","title":"ExternalStorage","type":"string","x-stream-index":"001.007"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"the permissions granted to each role","title":"Grants","type":"object","x-stream-index":"001.002"},"name":{"description":"the name of the call type","title":"Name","type":"string","x-stream-index":"001.001"},"notification_settings":{"$ref":"#/components/schemas/NotificationSettings","description":"the notification settings for the call type","title":"NotificationSettings","x-stream-index":"001.004"},"settings":{"$ref":"#/components/schemas/CallSettingsResponse","description":"the settings for the call type","title":"Settings","x-stream-index":"001.003"},"updated_at":{"description":"the time the call type was last updated","format":"date-time","title":"UpdatedAt","type":"number","x-stream-index":"001.006"}},"required":["name","grants","settings","notification_settings","created_at","updated_at","duration"],"title":"UpdateCallTypeResponse","type":"object"},"UpdateChannelPartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"type":"object","x-stream-index":"002.001"},"unset":{"items":{"type":"string"},"type":"array","x-stream-index":"002.002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"title":"UpdateChannelPartialRequest","type":"object"},"UpdateChannelPartialResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Updated channel object","title":"Channel","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"members":{"description":"List of updated members","items":{"$ref":"#/components/schemas/ChannelMemberResponse"},"title":"ChannelMemberResponse","type":"array","x-stream-index":"002"}},"required":["members","duration"],"type":"object"},"UpdateChannelRequest":{"nullable":true,"properties":{"accept_invite":{"description":"Set to `true` to accept the invite","title":"Accept invite","type":"boolean","x-stream-index":"008"},"add_members":{"description":"List of user IDs to add to the channel","items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"title":"Add members","type":"array","x-stream-index":"001"},"add_moderators":{"description":"List of user IDs to make channel moderators","items":{"type":"string"},"maximum":100,"title":"Add moderators","type":"array","x-stream-index":"003"},"assign_roles":{"description":"List of channel member role assignments. If any specified user is not part of the channel, the request will fail","items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"title":"Assign roles","type":"array","x-stream-index":"006"},"cooldown":{"description":"Sets cool down period for the channel in seconds","format":"int32","maximum":120,"minimum":0,"title":"Cool down","type":"integer","x-stream-index":"007"},"data":{"$ref":"#/components/schemas/ChannelInput","x-stream-index":"013.001"},"demote_moderators":{"description":"List of user IDs to take away moderators status from","items":{"type":"string"},"maximum":100,"title":"Demote moderators","type":"array","x-stream-index":"004"},"hide_history":{"description":"Set to `true` to hide channel's history when adding new members","title":"Hide history","type":"boolean","x-stream-index":"012"},"invites":{"description":"List of user IDs to invite to the channel","items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"title":"Invites","type":"array","x-stream-index":"005"},"message":{"$ref":"#/components/schemas/MessageRequest","description":"Message to send to the chat when channel is successfully updated","title":"Message","x-stream-index":"010"},"reject_invite":{"description":"Set to `true` to reject the invite","title":"Reject invite","type":"boolean","x-stream-index":"009"},"remove_members":{"description":"List of user IDs to remove from the channel","items":{"type":"string"},"maximum":100,"title":"Remove members","type":"array","x-stream-index":"002"},"skip_push":{"description":"When `message` is set disables all push notifications for it","title":"Skip push","type":"boolean","x-stream-index":"011"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"014.002"},"user_id":{"type":"string","x-stream-index":"014.001"}},"title":"Channel update request","type":"object","x-stream-docs-page-id":"channel_update"},"UpdateChannelResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Updated channel","title":"Channel","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"004.001"},"members":{"description":"List of channel members","items":{"$ref":"#/components/schemas/ChannelMember"},"title":"Members","type":"array","x-stream-index":"003"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Message sent to the chat","title":"Message","x-stream-index":"002"}},"required":["members","duration"],"type":"object"},"UpdateChannelTypeRequest":{"nullable":true,"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"009.001.026"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"009.001.021"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"009.001.022"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"009.001.027"},"blocklist":{"type":"string","x-stream-index":"009.001.023"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"009.001.024"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"009.001.025"},"commands":{"description":"List of commands that channel supports","items":{"type":"string"},"title":"Commands","type":"array","x-stream-index":"009.003"},"connect_events":{"type":"boolean","x-stream-index":"009.001.004"},"custom_events":{"type":"boolean","x-stream-index":"009.001.012"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"004"},"mark_messages_pending":{"type":"boolean","x-stream-index":"009.001.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"009.001.020"},"mutes":{"type":"boolean","x-stream-index":"009.001.009"},"partition_size":{"format":"int32","minimum":0,"type":"integer","x-stream-index":"007"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"008"},"permissions":{"items":{"$ref":"#/components/schemas/PolicyRequest"},"type":"array","x-stream-index":"003"},"polls":{"type":"boolean","x-stream-index":"009.001.016"},"push_notifications":{"type":"boolean","x-stream-index":"009.001.013"},"quotes":{"type":"boolean","x-stream-index":"009.001.008"},"reactions":{"type":"boolean","x-stream-index":"009.001.006"},"read_events":{"type":"boolean","x-stream-index":"009.001.003"},"reminders":{"type":"boolean","x-stream-index":"009.001.014"},"replies":{"type":"boolean","x-stream-index":"009.001.007"},"search":{"type":"boolean","x-stream-index":"009.001.005"},"shared_locations":{"type":"boolean","x-stream-index":"009.001.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"009.001.030"},"typing_events":{"type":"boolean","x-stream-index":"009.001.002"},"uploads":{"type":"boolean","x-stream-index":"009.001.010"},"url_enrichment":{"type":"boolean","x-stream-index":"009.001.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"009.001.017"}},"required":["max_message_length","automod","automod_behavior"],"type":"object"},"UpdateChannelTypeResponse":{"nullable":true,"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"003.001.026"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"003.001.021"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.001.022"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"003.001.027"},"blocklist":{"type":"string","x-stream-index":"003.001.023"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.001.024"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"003.001.025"},"commands":{"items":{"type":"string"},"type":"array","x-stream-index":"003.003"},"connect_events":{"type":"boolean","x-stream-index":"003.001.004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002.003"},"custom_events":{"type":"boolean","x-stream-index":"003.001.012"},"duration":{"type":"string","x-stream-index":"004.001"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"002"},"mark_messages_pending":{"type":"boolean","x-stream-index":"003.001.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"003.001.020"},"mutes":{"type":"boolean","x-stream-index":"003.001.009"},"name":{"type":"string","x-stream-index":"003.001.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"003.001.028"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"003.001.029"},"permissions":{"items":{"$ref":"#/components/schemas/PolicyRequest"},"type":"array","x-stream-index":"001"},"polls":{"type":"boolean","x-stream-index":"003.001.016"},"push_notifications":{"type":"boolean","x-stream-index":"003.001.013"},"quotes":{"type":"boolean","x-stream-index":"003.001.008"},"reactions":{"type":"boolean","x-stream-index":"003.001.006"},"read_events":{"type":"boolean","x-stream-index":"003.001.003"},"reminders":{"type":"boolean","x-stream-index":"003.001.014"},"replies":{"type":"boolean","x-stream-index":"003.001.007"},"search":{"type":"boolean","x-stream-index":"003.001.005"},"shared_locations":{"type":"boolean","x-stream-index":"003.001.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"003.001.030"},"typing_events":{"type":"boolean","x-stream-index":"003.001.002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"003.002.004"},"uploads":{"type":"boolean","x-stream-index":"003.001.010"},"url_enrichment":{"type":"boolean","x-stream-index":"003.001.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"003.001.017"}},"required":["permissions","grants","name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","created_at","updated_at","commands","duration"],"type":"object"},"UpdateCommandRequest":{"nullable":true,"properties":{"args":{"description":"Arguments help text, shown in commands auto-completion","maxLength":255,"title":"Arguments","type":"string","x-stream-index":"003"},"description":{"description":"Description, shown in commands auto-completion","maxLength":255,"title":"Description","type":"string","x-stream-index":"002"},"set":{"description":"Set name used for grouping commands","maxLength":255,"title":"Set","type":"string","x-stream-index":"004"}},"required":["description"],"title":"UpdateCommandRequest","type":"object"},"UpdateCommandResponse":{"nullable":true,"properties":{"command":{"$ref":"#/components/schemas/Command","description":"Command object","title":"Command","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["duration"],"title":"UpdateCommandResponse","type":"object"},"UpdateExternalStorageRequest":{"description":"External storage","nullable":true,"properties":{"aws_s3":{"$ref":"#/components/schemas/S3Request","description":"Only required if you want to create an Amazon S3 storage","title":"AwsS3","x-stream-index":"003.004"},"azure_blob":{"$ref":"#/components/schemas/AzureRequest","description":"Only required if you want to create an Azure Blob Storage","title":"AzureBlob","x-stream-index":"003.006"},"bucket":{"description":"The name of the bucket on the service provider","title":"Bucket","type":"string","x-stream-index":"003.002"},"gcs_credentials":{"type":"string","x-stream-index":"003.005"},"path":{"description":"The path prefix to use for storing files","title":"Path","type":"string","x-stream-index":"003.003"},"storage_type":{"description":"The type of storage to use","enum":["s3","gcs","abs"],"title":"StorageType","type":"string","x-stream-index":"003.001"}},"required":["storage_type","bucket"],"title":"ExternalStorageRequest","type":"object"},"UpdateExternalStorageResponse":{"description":"Basic response information","nullable":true,"properties":{"bucket":{"type":"string","x-stream-index":"001.003"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"name":{"type":"string","x-stream-index":"001.001"},"path":{"type":"string","x-stream-index":"001.004"},"type":{"enum":["s3","gcs","abs"],"type":"string","x-stream-index":"001.002"}},"required":["name","type","bucket","path","duration"],"title":"Response","type":"object"},"UpdateLiveLocationRequest":{"nullable":true,"properties":{"end_at":{"description":"Time when the live location expires","format":"date-time","title":"string","type":"number","x-stream-index":"004"},"latitude":{"description":"Latitude coordinate","format":"float","maximum":90,"minimum":18446744073709552000,"title":"number","type":"number","x-stream-index":"002"},"longitude":{"description":"Longitude coordinate","format":"float","maximum":180,"minimum":18446744073709552000,"title":"number","type":"number","x-stream-index":"003"},"message_id":{"description":"Live location ID","title":"string","type":"string","x-stream-index":"001"}},"required":["message_id"],"type":"object"},"UpdateMemberPartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"type":"object","x-stream-index":"002.001"},"unset":{"items":{"type":"string"},"type":"array","x-stream-index":"002.002"}},"type":"object"},"UpdateMemberPartialResponse":{"nullable":true,"properties":{"channel_member":{"$ref":"#/components/schemas/ChannelMemberResponse","description":"Updated channel member","title":"Channel member","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["duration"],"type":"object"},"UpdateMessagePartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"description":"Sets new field values","title":"Set","type":"object","x-stream-index":"002.001","x-stream-map":{"key":"field","title":"Value","description":"New value to set"}},"skip_enrich_url":{"description":"Skip enriching the URL in the message","title":"SkipEnrichURL","type":"boolean","x-stream-index":"001"},"unset":{"description":"Array of field names to unset","items":{"type":"string"},"title":"Unset","type":"array","x-stream-index":"002.002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"type":"object"},"UpdateMessagePartialResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Updated message","title":"Message","x-stream-index":"001"},"pending_message_metadata":{"additionalProperties":{"type":"string"},"description":"Pending message metadata","title":"PendingMessageMetadata","type":"object","x-stream-index":"002"}},"required":["duration"],"type":"object"},"UpdateMessageRequest":{"nullable":true,"properties":{"message":{"$ref":"#/components/schemas/MessageRequest","description":"Message","title":"MessageRequest","x-stream-index":"001"},"skip_enrich_url":{"description":"Skip enrich URL","title":"boolean","type":"boolean","x-stream-index":"003"},"skip_push":{"type":"boolean","x-stream-index":"002"}},"required":["message"],"type":"object"},"UpdateMessageResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001"},"pending_message_metadata":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"002"}},"required":["message","duration"],"title":"Response","type":"object"},"UpdatePollOptionRequest":{"nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"004"},"id":{"description":"Option ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"},"text":{"description":"Option text","title":"string","type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"005.002"},"user_id":{"type":"string","x-stream-index":"005.001"}},"required":["id","text"],"type":"object"},"UpdatePollPartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"description":"Sets new field values","title":"Set","type":"object","x-stream-index":"002.001","x-stream-map":{"key":"field","title":"Value","description":"New value to set"}},"unset":{"description":"Array of field names to unset","items":{"type":"string"},"title":"Unset","type":"array","x-stream-index":"002.002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"type":"object"},"UpdatePollRequest":{"nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"011"},"allow_answers":{"description":"Allow answers","title":"boolean","type":"boolean","x-stream-index":"009"},"allow_user_suggested_options":{"description":"Allow user suggested options","title":"boolean","type":"boolean","x-stream-index":"008"},"description":{"description":"Poll description","title":"string","type":"string","x-stream-index":"003"},"enforce_unique_vote":{"description":"Enforce unique vote","title":"boolean","type":"boolean","x-stream-index":"005"},"id":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"},"is_closed":{"description":"Is closed","title":"boolean","type":"boolean","x-stream-index":"010"},"max_votes_allowed":{"description":"Max votes allowed","format":"int32","maximum":10,"title":"integer","type":"integer","x-stream-index":"007"},"name":{"description":"Poll name","title":"string","type":"string","x-stream-index":"002"},"options":{"description":"Poll options","items":{"$ref":"#/components/schemas/PollOptionRequest"},"maximum":100,"title":"PollOptions","type":"array","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"012.002"},"user_id":{"type":"string","x-stream-index":"012.001"},"voting_visibility":{"description":"Voting visibility","enum":["anonymous","public"],"title":"string","type":"string","x-stream-index":"006"}},"required":["id","name"],"type":"object"},"UpdateReminderRequest":{"nullable":true,"properties":{"remind_at":{"format":"date-time","type":"number","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"type":"object"},"UpdateReminderResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"001"}},"required":["reminder","duration"],"title":"Response","type":"object"},"UpdateThreadPartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"description":"Sets new field values","title":"Set","type":"object","x-stream-index":"004.001","x-stream-map":{"key":"field","title":"Value","description":"New value to set"}},"unset":{"description":"Array of field names to unset","items":{"type":"string"},"title":"Unset","type":"array","x-stream-index":"004.002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"type":"object"},"UpdateThreadPartialResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"thread":{"$ref":"#/components/schemas/ThreadResponse","description":"Updated thread (not enriched)","title":"Thread","x-stream-index":"001"}},"required":["thread","duration"],"type":"object"},"UpdateUserPartialRequest":{"properties":{"id":{"description":"User ID to update","title":"ID","type":"string","x-stream-index":"001"},"set":{"additionalProperties":{},"type":"object","x-stream-index":"002.001"},"unset":{"items":{"type":"string"},"type":"array","x-stream-index":"002.002"}},"required":["id"],"type":"object"},"UpdateUserPermissionsRequest":{"nullable":true,"properties":{"grant_permissions":{"items":{"type":"string"},"type":"array","x-stream-index":"002"},"revoke_permissions":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"user_id":{"type":"string","x-stream-index":"001"}},"required":["user_id"],"type":"object"},"UpdateUserPermissionsResponse":{"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"},"UpdateUsersPartialRequest":{"nullable":true,"properties":{"users":{"items":{"$ref":"#/components/schemas/UpdateUserPartialRequest"},"maximum":100,"type":"array","x-stream-index":"001"}},"required":["users"],"type":"object"},"UpdateUsersRequest":{"nullable":true,"properties":{"users":{"additionalProperties":{"$ref":"#/components/schemas/UserRequest"},"description":"Object containing users","title":"Users","type":"object","x-stream-index":"001","x-stream-map":{"key":"user_id"}}},"required":["users"],"type":"object"},"UpdateUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"membership_deletion_task_id":{"type":"string","x-stream-index":"002"},"users":{"additionalProperties":{"$ref":"#/components/schemas/FullUserResponse"},"description":"Object containing users","title":"Users","type":"object","x-stream-index":"001","x-stream-map":{"key":"user_id"}}},"required":["users","membership_deletion_task_id","duration"],"type":"object"},"UpdatedCallPermissionsEvent":{"description":"This event is sent to notify about permission changes for a user, clients receiving this event should update their UI accordingly","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"own_capabilities":{"description":"The capabilities of the current user","items":{"$ref":"#/components/schemas/OwnCapability"},"title":"Own capabilities","type":"array","x-stream-index":"004"},"type":{"default":"call.permissions_updated","description":"The type of event: \"call.permissions_updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who received the new permissions","title":"User","x-stream-index":"003"}},"required":["type","created_at","call_cid","user","own_capabilities"],"title":"UpdatedCallPermissionsEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"UpsertConfigRequest":{"nullable":true,"properties":{"ai_image_config":{"$ref":"#/components/schemas/AIImageConfig","description":"Configuration for AI image analysis","title":"AI Image Config","x-stream-index":"010"},"ai_text_config":{"$ref":"#/components/schemas/AITextConfig","description":"Configuration for AI text analysis","title":"AI Text Config","x-stream-index":"008"},"ai_video_config":{"$ref":"#/components/schemas/AIVideoConfig","description":"Configuration for AI video analysis","title":"AI Video Config","x-stream-index":"011"},"async":{"description":"Whether moderation should be performed asynchronously","title":"Async","type":"boolean","x-stream-index":"003"},"automod_platform_circumvention_config":{"$ref":"#/components/schemas/AutomodPlatformCircumventionConfig","description":"Configuration for platform circumvention detection","title":"Automod Platform Circumvention Config","x-stream-index":"005"},"automod_semantic_filters_config":{"$ref":"#/components/schemas/AutomodSemanticFiltersConfig","description":"Configuration for semantic filtering","title":"Automod Semantic Filters Config","x-stream-index":"006"},"automod_toxicity_config":{"$ref":"#/components/schemas/AutomodToxicityConfig","description":"Configuration for toxicity detection","title":"Automod Toxicity Config","x-stream-index":"004"},"aws_rekognition_config":{"$ref":"#/components/schemas/AIImageConfig","x-stream-index":"015"},"block_list_config":{"$ref":"#/components/schemas/BlockListConfig","description":"Configuration for block list filtering","title":"Block List Config","x-stream-index":"007"},"bodyguard_config":{"$ref":"#/components/schemas/AITextConfig","x-stream-index":"014"},"google_vision_config":{"$ref":"#/components/schemas/GoogleVisionConfig","description":"Configuration for Google Vision integration","title":"Google Vision Config","x-stream-index":"009"},"key":{"description":"Unique identifier for the moderation configuration","title":"Key","type":"string","x-stream-index":"001"},"rule_builder_config":{"$ref":"#/components/schemas/RuleBuilderConfig","description":"Configuration for custom rule builder (max 3 rules, max 5 conditions per rule)","title":"Rule Builder Config","x-stream-index":"013"},"team":{"description":"Team associated with the configuration","maxLength":128,"minLength":1,"title":"Team","type":"string","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"017.002"},"user_id":{"type":"string","x-stream-index":"017.001"},"velocity_filter_config":{"$ref":"#/components/schemas/VelocityFilterConfig","description":"Configuration for velocity-based filtering","title":"Velocity Filter Config","x-stream-index":"012"},"video_call_rule_config":{"$ref":"#/components/schemas/VideoCallRuleConfig","x-stream-index":"016"}},"required":["key"],"type":"object"},"UpsertConfigResponse":{"nullable":true,"properties":{"config":{"$ref":"#/components/schemas/ConfigResponse","description":"The created or updated moderation configuration","title":"Config","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["duration"],"type":"object"},"UpsertModerationTemplateRequest":{"nullable":true,"properties":{"config":{"$ref":"#/components/schemas/FeedsModerationTemplateConfig","description":"Configuration for the moderation template","title":"Config","x-stream-index":"002"},"name":{"description":"Name of the moderation template","title":"Name","type":"string","x-stream-index":"001"}},"required":["name","config"],"type":"object"},"UpsertModerationTemplateResponse":{"nullable":true,"properties":{"config":{"$ref":"#/components/schemas/FeedsModerationTemplateConfig","description":"Configuration for the moderation template","title":"Config","x-stream-index":"002"},"created_at":{"description":"When the template was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"003"},"duration":{"type":"string","x-stream-index":"005.001"},"name":{"description":"Name of the moderation template","title":"Name","type":"string","x-stream-index":"001"},"updated_at":{"description":"When the template was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"004"}},"required":["name","created_at","updated_at","duration"],"type":"object"},"UpsertPushPreferencesRequest":{"nullable":true,"properties":{"preferences":{"description":"A list of push preferences for channels, calls, or the user.","items":{"$ref":"#/components/schemas/PushPreferenceInput"},"type":"array","x-stream-index":"001"}},"required":["preferences"],"type":"object"},"UpsertPushPreferencesResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"user_channel_preferences":{"additionalProperties":{"additionalProperties":{"$ref":"#/components/schemas/ChannelPushPreferences"},"type":"object"},"description":"The channel specific push notification preferences, only returned for channels you've edited.","title":"User Channel Notification Preferences","type":"object","x-stream-index":"002"},"user_preferences":{"additionalProperties":{"$ref":"#/components/schemas/PushPreferences"},"description":"The user preferences, always returned regardless if you edited it","title":"User Preferences","type":"object","x-stream-index":"001"}},"required":["user_preferences","user_channel_preferences","duration"],"type":"object"},"UpsertPushProviderRequest":{"nullable":true,"properties":{"push_provider":{"$ref":"#/components/schemas/PushProvider","x-stream-index":"001"}},"type":"object"},"UpsertPushProviderResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"push_provider":{"$ref":"#/components/schemas/PushProviderResponse","x-stream-index":"001"}},"required":["push_provider","duration"],"title":"Response","type":"object"},"UpsertPushTemplateRequest":{"nullable":true,"properties":{"enable_push":{"description":"Whether to send push notification for this event","title":"boolean","type":"boolean","x-stream-index":"002"},"event_type":{"description":"Event type (message.new, message.updated, reaction.new)","enum":["message.new","message.updated","reaction.new","notification.reminder_due"],"title":"string","type":"string","x-stream-index":"003"},"push_provider_name":{"description":"Push provider name","title":"string","type":"string","x-stream-index":"004"},"push_provider_type":{"description":"Push provider type (firebase, apn)","enum":["firebase","apn"],"title":"string","type":"string","x-stream-index":"005"},"template":{"description":"Push template","title":"string","type":"string","x-stream-index":"006"}},"required":["event_type","push_provider_type"],"type":"object"},"UpsertPushTemplateResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"template":{"$ref":"#/components/schemas/PushTemplate","x-stream-index":"002"}},"required":["duration"],"title":"Response","type":"object"},"User":{"properties":{"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"046"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"017"},"banned":{"type":"boolean","x-stream-index":"016"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"013"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"023"},"language":{"type":"string","x-stream-index":"035"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"026"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"042"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"005"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"009"}},"required":["id","role","teams_role","custom","banned","online"],"type":"object"},"UserBannedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"006.002"},"channel_type":{"type":"string","x-stream-index":"006.003"},"cid":{"type":"string","x-stream-index":"006.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008.002"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"001"},"expiration":{"format":"date-time","type":"number","x-stream-index":"003"},"reason":{"type":"string","x-stream-index":"004"},"shadow":{"type":"boolean","x-stream-index":"002"},"team":{"type":"string","x-stream-index":"005.001"},"type":{"default":"user.banned","type":"string","x-stream-index":"008.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007.001"}},"required":["created_by","shadow","cid","channel_id","channel_type","type","created_at"],"title":"UserBannedEvent","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"},"UserCreatedWithinParameters":{"properties":{"max_age":{"type":"string","x-stream-index":"001"}},"type":"object"},"UserCustomEventRequest":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"001"}},"required":["type"],"type":"object"},"UserDeactivatedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"001"},"type":{"default":"user.deactivated","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["created_by","type","created_at"],"title":"UserDeactivatedEvent","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"},"UserDeletedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"delete_conversation_channels":{"type":"boolean","x-stream-index":"005"},"hard_delete":{"type":"boolean","x-stream-index":"003.001"},"mark_messages_deleted":{"type":"boolean","x-stream-index":"004"},"type":{"default":"user.deleted","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"001.001"}},"required":["type","created_at","hard_delete","mark_messages_deleted","delete_conversation_channels"],"title":"UserDeletedEvent","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"},"UserFeedbackReport":{"properties":{"count_by_rating":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001"},"unreported_count":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["count_by_rating","unreported_count"],"type":"object"},"UserFeedbackReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateUserFeedbackReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"UserFeedbackResponse":{"properties":{"cid":{"type":"string","x-stream-index":"001"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"009"},"platform":{"$ref":"#/components/schemas/PlatformDataResponse","x-stream-index":"008"},"rating":{"format":"int32","type":"integer","x-stream-index":"004"},"reason":{"type":"string","x-stream-index":"005"},"sdk":{"type":"string","x-stream-index":"006"},"sdk_version":{"type":"string","x-stream-index":"007"},"session_id":{"type":"string","x-stream-index":"002"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["cid","session_id","user_id","rating","reason","sdk","sdk_version","platform"],"type":"object"},"UserFlaggedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"target_user":{"type":"string","x-stream-index":"002"},"target_users":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"type":{"default":"user.flagged","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"001"}},"required":["type","created_at"],"title":"UserFlaggedEvent","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"},"UserMute":{"nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"expires":{"description":"Date/time of mute expiration","format":"date-time","title":"Expires","type":"number","x-stream-index":"008"},"target":{"$ref":"#/components/schemas/User","description":"User who's muted","title":"Target","x-stream-index":"007"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/User","description":"Owner of channel mute","title":"User","x-stream-index":"005"}},"required":["created_at","updated_at"],"type":"object"},"UserMuteResponse":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"expires":{"format":"date-time","type":"number","x-stream-index":"003"},"target":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"}},"required":["created_at","updated_at"],"type":"object"},"UserMutedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"target_user":{"type":"string","x-stream-index":"001"},"target_users":{"items":{"type":"string"},"type":"array","x-stream-index":"002"},"type":{"default":"user.muted","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"UserMutedEvent","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"},"UserRatingReportResponse":{"properties":{"average":{"format":"float","type":"number","x-stream-index":"002"},"count":{"format":"int32","type":"integer","x-stream-index":"001"}},"required":["count","average"],"type":"object"},"UserReactivatedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"type":{"default":"user.reactivated","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"001"}},"required":["type","created_at"],"title":"UserReactivatedEvent","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"},"UserRequest":{"description":"User request object","properties":{"custom":{"additionalProperties":{},"description":"Custom user data","title":"Custom","type":"object","x-stream-index":"004"},"id":{"description":"User ID","title":"ID","type":"string","x-stream-index":"001"},"image":{"description":"User's profile image URL","title":"Image","type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"006"},"language":{"type":"string","x-stream-index":"005"},"name":{"description":"Optional name of user","title":"Name","type":"string","x-stream-index":"002"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"007"},"role":{"description":"User's global role","title":"Role","type":"string","x-stream-index":"008"},"teams":{"description":"List of teams the user belongs to","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"010"},"teams_role":{"additionalProperties":{"type":"string"},"description":"Map of team-specific roles for the user","title":"TeamsRole","type":"object","x-stream-index":"009"}},"required":["id"],"title":"UserRequest","type":"object"},"UserResponse":{"description":"User response object","properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"ban_expires":{"description":"Date when ban expires","format":"date-time","title":"Ban expires","type":"number","x-stream-index":"003"},"banned":{"description":"Whether a user is banned or not","title":"Banned","type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.017"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"001.004"},"deactivated_at":{"description":"Date of deactivation","format":"date-time","title":"Deactivated at","type":"number","x-stream-index":"001.016"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"001.011"},"devices":{"description":"List of devices user is using","items":{"$ref":"#/components/schemas/DeviceResponse"},"title":"Devices","type":"array","x-stream-index":"006"},"id":{"description":"Unique user identifier","title":"ID","type":"string","x-stream-index":"001.001"},"image":{"title":"Image","type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"007"},"language":{"description":"Preferred language of a user","title":"Language","type":"string","x-stream-index":"001.005"},"last_active":{"description":"Date of last activity","format":"date-time","title":"Last active","type":"number","x-stream-index":"001.014"},"name":{"description":"Optional name of user","title":"Name","type":"string","x-stream-index":"001.002"},"online":{"description":"Whether a user online or not","title":"Online","type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","description":"User privacy settings","title":"Privacy settings","x-stream-index":"005"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettingsResponse","description":"User push notification settings","title":"Push notifications","x-stream-index":"004"},"revoke_tokens_issued_before":{"description":"Revocation date for tokens","format":"date-time","title":"Revoke tokens issued before","type":"number","x-stream-index":"001.015"},"role":{"description":"Determines the set of user permissions","title":"Role","type":"string","x-stream-index":"001.006"},"shadow_banned":{"description":"Whether a user is shadow banned","title":"Shadow banned","type":"boolean","x-stream-index":"002"},"teams":{"description":"List of teams user is a part of","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids","shadow_banned","invisible"],"title":"UserResponse","type":"object"},"UserResponseCommonFields":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"018"},"banned":{"type":"boolean","x-stream-index":"012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"017"},"created_at":{"format":"date-time","type":"number","x-stream-index":"009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"id":{"type":"string","x-stream-index":"001"},"image":{"type":"string","x-stream-index":"003"},"language":{"type":"string","x-stream-index":"005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"014"},"name":{"type":"string","x-stream-index":"002"},"online":{"type":"boolean","x-stream-index":"013"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"015"},"role":{"type":"string","x-stream-index":"006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids"],"type":"object"},"UserResponsePrivacyFields":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"banned":{"type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.017"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.011"},"id":{"type":"string","x-stream-index":"001.001"},"image":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"003"},"language":{"type":"string","x-stream-index":"001.005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"001.014"},"name":{"type":"string","x-stream-index":"001.002"},"online":{"type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"002"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.015"},"role":{"type":"string","x-stream-index":"001.006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids"],"type":"object"},"UserRuleParameters":{"properties":{"max_age":{"type":"string","x-stream-index":"001"}},"type":"object"},"UserUnbannedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"005.002"},"shadow":{"type":"boolean","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"004.001"},"type":{"default":"user.unbanned","type":"string","x-stream-index":"005.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["shadow","cid","channel_id","channel_type","type","created_at"],"title":"UserUnbannedEvent","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"},"UserUnmutedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"target_user":{"type":"string","x-stream-index":"002"},"target_users":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"type":{"default":"user.unmuted","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"001"}},"required":["type","created_at"],"title":"UserUnmutedEvent","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"},"UserUnreadReminderEvent":{"properties":{"channels":{"additionalProperties":{"$ref":"#/components/schemas/ChannelMessages"},"type":"object","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"user.unread_message_reminder","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002"}},"required":["type","created_at","channels"],"title":"UserUnreadReminderEvent","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"},"UserUpdatedEvent":{"description":"This event is sent when a user gets updated. The event contains information about the updated user.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"type":{"default":"user.updated","description":"The type of event: \"user.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.002"},"user":{"$ref":"#/components/schemas/UserResponsePrivacyFields","description":"The updated user","title":"User","x-stream-index":"002.001"}},"required":["type","created_at","custom","user"],"title":"UserUpdatedEvent","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"},"VelocityFilterConfig":{"properties":{"advanced_filters":{"type":"boolean","x-stream-index":"007"},"async":{"type":"boolean","x-stream-index":"001"},"cascading_actions":{"type":"boolean","x-stream-index":"004"},"cids_per_user":{"format":"int32","type":"integer","x-stream-index":"006"},"enabled":{"type":"boolean","x-stream-index":"002"},"first_message_only":{"type":"boolean","x-stream-index":"005"},"rules":{"items":{"$ref":"#/components/schemas/VelocityFilterConfigRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules","cascading_actions","first_message_only","cids_per_user","advanced_filters"],"type":"object"},"VelocityFilterConfigRule":{"properties":{"action":{"enum":["flag","shadow","remove","ban"],"type":"string","x-stream-index":"001"},"ban_duration":{"format":"int32","type":"integer","x-stream-index":"002"},"cascading_action":{"enum":["flag","shadow","remove","ban"],"type":"string","x-stream-index":"006"},"cascading_threshold":{"format":"int64","type":"integer","x-stream-index":"005"},"check_message_context":{"type":"boolean","x-stream-index":"009"},"fast_spam_threshold":{"format":"int32","type":"integer","x-stream-index":"007"},"fast_spam_ttl":{"format":"int32","type":"integer","x-stream-index":"010"},"ip_ban":{"type":"boolean","x-stream-index":"004"},"probation_period":{"format":"int32","type":"integer","x-stream-index":"014"},"shadow_ban":{"type":"boolean","x-stream-index":"003"},"slow_spam_ban_duration":{"format":"int32","type":"integer","x-stream-index":"012"},"slow_spam_threshold":{"format":"int32","type":"integer","x-stream-index":"008"},"slow_spam_ttl":{"format":"int32","type":"integer","x-stream-index":"011"},"url_only":{"type":"boolean","x-stream-index":"013"}},"required":["action","ban_duration","shadow_ban","ip_ban","cascading_threshold","cascading_action","fast_spam_threshold","slow_spam_threshold","check_message_context","fast_spam_ttl","slow_spam_ttl","url_only","probation_period"],"type":"object"},"VideoCallRuleConfig":{"properties":{"rules":{"additionalProperties":{"$ref":"#/components/schemas/HarmConfig"},"type":"object","x-stream-index":"001"}},"required":["rules"],"type":"object"},"VideoContentParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"type":"object"},"VideoEndCallRequest":{"type":"object"},"VideoKickUserRequest":{"type":"object"},"VideoOrientation":{"properties":{"orientation":{"type":"integer","x-stream-index":"004"}},"type":"object"},"VideoReactionOverTimeResponse":{"properties":{"by_minute":{"items":{"$ref":"#/components/schemas/CountByMinuteResponse"},"type":"array","x-stream-index":"001"}},"type":"object"},"VideoReactionsResponse":{"nullable":true,"properties":{"count_over_time":{"$ref":"#/components/schemas/VideoReactionOverTimeResponse","x-stream-index":"002"},"reaction":{"type":"string","x-stream-index":"001"}},"required":["reaction"],"type":"object"},"VideoRuleParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"required":["threshold","time_window"],"type":"object"},"VideoSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"camera_default_on":{"type":"boolean","x-stream-index":"004"},"camera_facing":{"enum":["front","back","external"],"type":"string","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled","target_resolution","camera_default_on","camera_facing"],"type":"object"},"VideoSettingsRequest":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"camera_default_on":{"type":"boolean","x-stream-index":"004"},"camera_facing":{"enum":["front","back","external"],"type":"string","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"type":"object"},"VideoSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"camera_default_on":{"type":"boolean","x-stream-index":"004"},"camera_facing":{"enum":["front","back","external"],"type":"string","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled","target_resolution","camera_default_on","camera_facing"],"type":"object"},"VoteData":{"properties":{"answer_text":{"type":"string","x-stream-index":"002"},"option_id":{"maxLength":255,"type":"string","x-stream-index":"001"}},"type":"object"},"WSEvent":{"description":"Represents an BaseEvent that happened in Stream Chat","properties":{"automoderation":{"type":"boolean","x-stream-index":"023"},"automoderation_scores":{"$ref":"#/components/schemas/ModerationResponse","x-stream-index":"024"},"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"011"},"channel_id":{"type":"string","x-stream-index":"004"},"channel_last_message_at":{"format":"date-time","type":"number","x-stream-index":"007"},"channel_type":{"type":"string","x-stream-index":"005"},"cid":{"type":"string","x-stream-index":"003"},"connection_id":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"028"},"created_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"022"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"027"},"me":{"$ref":"#/components/schemas/OwnUserResponse","x-stream-index":"019"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"014"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"008"},"message_update":{"$ref":"#/components/schemas/MessageUpdate","x-stream-index":"009"},"parent_id":{"type":"string","x-stream-index":"025"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"015"},"poll_vote":{"$ref":"#/components/schemas/PollVoteResponseData","x-stream-index":"016"},"reaction":{"$ref":"#/components/schemas/ReactionResponse","x-stream-index":"010"},"reason":{"type":"string","x-stream-index":"021"},"team":{"type":"string","x-stream-index":"026"},"thread":{"$ref":"#/components/schemas/ThreadResponse","x-stream-index":"013"},"thread_id":{"type":"string","x-stream-index":"012"},"type":{"type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"017"},"user_id":{"type":"string","x-stream-index":"018"},"watcher_count":{"format":"int32","type":"integer","x-stream-index":"020"}},"required":["type","custom","created_at"],"title":"Event","type":"object","x-stream-docs-page-id":"event_object"},"WebhookEvent":{"description":"The discriminator object for all webhook events, it maps events' payload to the final type","discriminator":{"mapping":{"*":"#/components/schemas/AnyEvent","activity.marked":"#/components/schemas/ActivityMarkedEvent","call.accepted":"#/components/schemas/CallAcceptedEvent","call.blocked_user":"#/components/schemas/BlockedUserEvent","call.closed_caption":"#/components/schemas/ClosedCaptionEvent","call.closed_captions_failed":"#/components/schemas/CallClosedCaptionsFailedEvent","call.closed_captions_started":"#/components/schemas/CallClosedCaptionsStartedEvent","call.closed_captions_stopped":"#/components/schemas/CallClosedCaptionsStoppedEvent","call.created":"#/components/schemas/CallCreatedEvent","call.deleted":"#/components/schemas/CallDeletedEvent","call.ended":"#/components/schemas/CallEndedEvent","call.frame_recording_failed":"#/components/schemas/CallFrameRecordingFailedEvent","call.frame_recording_ready":"#/components/schemas/CallFrameRecordingFrameReadyEvent","call.frame_recording_started":"#/components/schemas/CallFrameRecordingStartedEvent","call.frame_recording_stopped":"#/components/schemas/CallFrameRecordingStoppedEvent","call.hls_broadcasting_failed":"#/components/schemas/CallHLSBroadcastingFailedEvent","call.hls_broadcasting_started":"#/components/schemas/CallHLSBroadcastingStartedEvent","call.hls_broadcasting_stopped":"#/components/schemas/CallHLSBroadcastingStoppedEvent","call.live_started":"#/components/schemas/CallLiveStartedEvent","call.member_added":"#/components/schemas/CallMemberAddedEvent","call.member_removed":"#/components/schemas/CallMemberRemovedEvent","call.member_updated":"#/components/schemas/CallMemberUpdatedEvent","call.member_updated_permission":"#/components/schemas/CallMemberUpdatedPermissionEvent","call.missed":"#/components/schemas/CallMissedEvent","call.moderation_blur":"#/components/schemas/CallModerationBlurEvent","call.moderation_warning":"#/components/schemas/CallModerationWarningEvent","call.notification":"#/components/schemas/CallNotificationEvent","call.permission_request":"#/components/schemas/PermissionRequestEvent","call.permissions_updated":"#/components/schemas/UpdatedCallPermissionsEvent","call.reaction_new":"#/components/schemas/CallReactionEvent","call.recording_failed":"#/components/schemas/CallRecordingFailedEvent","call.recording_ready":"#/components/schemas/CallRecordingReadyEvent","call.recording_started":"#/components/schemas/CallRecordingStartedEvent","call.recording_stopped":"#/components/schemas/CallRecordingStoppedEvent","call.rejected":"#/components/schemas/CallRejectedEvent","call.ring":"#/components/schemas/CallRingEvent","call.rtmp_broadcast_failed":"#/components/schemas/CallRtmpBroadcastFailedEvent","call.rtmp_broadcast_started":"#/components/schemas/CallRtmpBroadcastStartedEvent","call.rtmp_broadcast_stopped":"#/components/schemas/CallRtmpBroadcastStoppedEvent","call.session_ended":"#/components/schemas/CallSessionEndedEvent","call.session_participant_count_updated":"#/components/schemas/CallSessionParticipantCountsUpdatedEvent","call.session_participant_joined":"#/components/schemas/CallSessionParticipantJoinedEvent","call.session_participant_left":"#/components/schemas/CallSessionParticipantLeftEvent","call.session_started":"#/components/schemas/CallSessionStartedEvent","call.stats_report_ready":"#/components/schemas/CallStatsReportReadyEvent","call.transcription_failed":"#/components/schemas/CallTranscriptionFailedEvent","call.transcription_ready":"#/components/schemas/CallTranscriptionReadyEvent","call.transcription_started":"#/components/schemas/CallTranscriptionStartedEvent","call.transcription_stopped":"#/components/schemas/CallTranscriptionStoppedEvent","call.unblocked_user":"#/components/schemas/UnblockedUserEvent","call.updated":"#/components/schemas/CallUpdatedEvent","call.user_feedback_submitted":"#/components/schemas/CallUserFeedbackSubmittedEvent","call.user_muted":"#/components/schemas/CallUserMutedEvent","campaign.completed":"#/components/schemas/CampaignCompletedEvent","campaign.started":"#/components/schemas/CampaignStartedEvent","channel.created":"#/components/schemas/ChannelCreatedEvent","channel.deleted":"#/components/schemas/ChannelDeletedEvent","channel.frozen":"#/components/schemas/ChannelFrozenEvent","channel.hidden":"#/components/schemas/ChannelHiddenEvent","channel.muted":"#/components/schemas/ChannelMutedEvent","channel.truncated":"#/components/schemas/ChannelTruncatedEvent","channel.unfrozen":"#/components/schemas/ChannelUnFrozenEvent","channel.unmuted":"#/components/schemas/ChannelUnmutedEvent","channel.updated":"#/components/schemas/ChannelUpdatedEvent","channel.visible":"#/components/schemas/ChannelVisibleEvent","custom":"#/components/schemas/CustomVideoEvent","export.bulk_image_moderation.error":"#/components/schemas/AsyncExportErrorEvent","export.bulk_image_moderation.success":"#/components/schemas/AsyncBulkImageModerationEvent","export.channels.error":"#/components/schemas/AsyncExportErrorEvent","export.channels.success":"#/components/schemas/AsyncExportChannelsEvent","export.moderation_logs.error":"#/components/schemas/AsyncExportErrorEvent","export.moderation_logs.success":"#/components/schemas/AsyncExportModerationLogsEvent","export.users.error":"#/components/schemas/AsyncExportErrorEvent","export.users.success":"#/components/schemas/AsyncExportUsersEvent","flag.updated":"#/components/schemas/FlagUpdatedEvent","member.added":"#/components/schemas/MemberAddedEvent","member.removed":"#/components/schemas/MemberRemovedEvent","member.updated":"#/components/schemas/MemberUpdatedEvent","message.deleted":"#/components/schemas/MessageDeletedEvent","message.flagged":"#/components/schemas/MessageFlaggedEvent","message.new":"#/components/schemas/MessageNewEvent","message.pending":"#/components/schemas/PendingMessageEvent","message.read":"#/components/schemas/MessageReadEvent","message.unblocked":"#/components/schemas/MessageUnblockedEvent","message.undeleted":"#/components/schemas/MessageUndeletedEvent","message.updated":"#/components/schemas/MessageUpdatedEvent","moderation.custom_action":"#/components/schemas/ModerationCustomActionEvent","moderation.flagged":"#/components/schemas/ModerationFlaggedEvent","moderation.mark_reviewed":"#/components/schemas/ModerationMarkReviewedEvent","moderation_check.completed":"#/components/schemas/ModerationCheckCompletedEvent","notification.mark_unread":"#/components/schemas/NotificationMarkUnreadEvent","notification.reminder_due":"#/components/schemas/ReminderNotificationEvent","notification.thread_message_new":"#/components/schemas/MessageNewEvent","reaction.deleted":"#/components/schemas/ReactionDeletedEvent","reaction.new":"#/components/schemas/ReactionNewEvent","reaction.updated":"#/components/schemas/ReactionUpdatedEvent","reminder.created":"#/components/schemas/ReminderCreatedEvent","reminder.deleted":"#/components/schemas/ReminderDeletedEvent","reminder.updated":"#/components/schemas/ReminderUpdatedEvent","review_queue_item.new":"#/components/schemas/ReviewQueueItemNewEvent","review_queue_item.updated":"#/components/schemas/ReviewQueueItemUpdatedEvent","thread.updated":"#/components/schemas/ThreadUpdatedEvent","user.banned":"#/components/schemas/UserBannedEvent","user.deactivated":"#/components/schemas/UserDeactivatedEvent","user.deleted":"#/components/schemas/UserDeletedEvent","user.flagged":"#/components/schemas/UserFlaggedEvent","user.muted":"#/components/schemas/UserMutedEvent","user.reactivated":"#/components/schemas/UserReactivatedEvent","user.unbanned":"#/components/schemas/UserUnbannedEvent","user.unmuted":"#/components/schemas/UserUnmutedEvent","user.unread_message_reminder":"#/components/schemas/UserUnreadReminderEvent","user.updated":"#/components/schemas/UserUpdatedEvent"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/ActivityMarkedEvent"},{"$ref":"#/components/schemas/AnyEvent"},{"$ref":"#/components/schemas/AsyncBulkImageModerationEvent"},{"$ref":"#/components/schemas/AsyncExportChannelsEvent"},{"$ref":"#/components/schemas/AsyncExportErrorEvent"},{"$ref":"#/components/schemas/AsyncExportErrorEvent"},{"$ref":"#/components/schemas/AsyncExportErrorEvent"},{"$ref":"#/components/schemas/AsyncExportErrorEvent"},{"$ref":"#/components/schemas/AsyncExportModerationLogsEvent"},{"$ref":"#/components/schemas/AsyncExportUsersEvent"},{"$ref":"#/components/schemas/BlockedUserEvent"},{"$ref":"#/components/schemas/CallAcceptedEvent"},{"$ref":"#/components/schemas/CallClosedCaptionsFailedEvent"},{"$ref":"#/components/schemas/CallClosedCaptionsStartedEvent"},{"$ref":"#/components/schemas/CallClosedCaptionsStoppedEvent"},{"$ref":"#/components/schemas/CallCreatedEvent"},{"$ref":"#/components/schemas/CallDeletedEvent"},{"$ref":"#/components/schemas/CallEndedEvent"},{"$ref":"#/components/schemas/CallFrameRecordingFailedEvent"},{"$ref":"#/components/schemas/CallFrameRecordingFrameReadyEvent"},{"$ref":"#/components/schemas/CallFrameRecordingStartedEvent"},{"$ref":"#/components/schemas/CallFrameRecordingStoppedEvent"},{"$ref":"#/components/schemas/CallHLSBroadcastingFailedEvent"},{"$ref":"#/components/schemas/CallHLSBroadcastingStartedEvent"},{"$ref":"#/components/schemas/CallHLSBroadcastingStoppedEvent"},{"$ref":"#/components/schemas/CallLiveStartedEvent"},{"$ref":"#/components/schemas/CallMemberAddedEvent"},{"$ref":"#/components/schemas/CallMemberRemovedEvent"},{"$ref":"#/components/schemas/CallMemberUpdatedEvent"},{"$ref":"#/components/schemas/CallMemberUpdatedPermissionEvent"},{"$ref":"#/components/schemas/CallMissedEvent"},{"$ref":"#/components/schemas/CallModerationBlurEvent"},{"$ref":"#/components/schemas/CallModerationWarningEvent"},{"$ref":"#/components/schemas/CallNotificationEvent"},{"$ref":"#/components/schemas/CallReactionEvent"},{"$ref":"#/components/schemas/CallRecordingFailedEvent"},{"$ref":"#/components/schemas/CallRecordingReadyEvent"},{"$ref":"#/components/schemas/CallRecordingStartedEvent"},{"$ref":"#/components/schemas/CallRecordingStoppedEvent"},{"$ref":"#/components/schemas/CallRejectedEvent"},{"$ref":"#/components/schemas/CallRingEvent"},{"$ref":"#/components/schemas/CallRtmpBroadcastFailedEvent"},{"$ref":"#/components/schemas/CallRtmpBroadcastStartedEvent"},{"$ref":"#/components/schemas/CallRtmpBroadcastStoppedEvent"},{"$ref":"#/components/schemas/CallSessionEndedEvent"},{"$ref":"#/components/schemas/CallSessionParticipantCountsUpdatedEvent"},{"$ref":"#/components/schemas/CallSessionParticipantJoinedEvent"},{"$ref":"#/components/schemas/CallSessionParticipantLeftEvent"},{"$ref":"#/components/schemas/CallSessionStartedEvent"},{"$ref":"#/components/schemas/CallStatsReportReadyEvent"},{"$ref":"#/components/schemas/CallTranscriptionFailedEvent"},{"$ref":"#/components/schemas/CallTranscriptionReadyEvent"},{"$ref":"#/components/schemas/CallTranscriptionStartedEvent"},{"$ref":"#/components/schemas/CallTranscriptionStoppedEvent"},{"$ref":"#/components/schemas/CallUpdatedEvent"},{"$ref":"#/components/schemas/CallUserFeedbackSubmittedEvent"},{"$ref":"#/components/schemas/CallUserMutedEvent"},{"$ref":"#/components/schemas/CampaignCompletedEvent"},{"$ref":"#/components/schemas/CampaignStartedEvent"},{"$ref":"#/components/schemas/ChannelCreatedEvent"},{"$ref":"#/components/schemas/ChannelDeletedEvent"},{"$ref":"#/components/schemas/ChannelFrozenEvent"},{"$ref":"#/components/schemas/ChannelHiddenEvent"},{"$ref":"#/components/schemas/ChannelMutedEvent"},{"$ref":"#/components/schemas/ChannelTruncatedEvent"},{"$ref":"#/components/schemas/ChannelUnFrozenEvent"},{"$ref":"#/components/schemas/ChannelUnmutedEvent"},{"$ref":"#/components/schemas/ChannelUpdatedEvent"},{"$ref":"#/components/schemas/ChannelVisibleEvent"},{"$ref":"#/components/schemas/ClosedCaptionEvent"},{"$ref":"#/components/schemas/CustomVideoEvent"},{"$ref":"#/components/schemas/FlagUpdatedEvent"},{"$ref":"#/components/schemas/MemberAddedEvent"},{"$ref":"#/components/schemas/MemberRemovedEvent"},{"$ref":"#/components/schemas/MemberUpdatedEvent"},{"$ref":"#/components/schemas/MessageDeletedEvent"},{"$ref":"#/components/schemas/MessageFlaggedEvent"},{"$ref":"#/components/schemas/MessageNewEvent"},{"$ref":"#/components/schemas/MessageNewEvent"},{"$ref":"#/components/schemas/MessageReadEvent"},{"$ref":"#/components/schemas/MessageUnblockedEvent"},{"$ref":"#/components/schemas/MessageUndeletedEvent"},{"$ref":"#/components/schemas/MessageUpdatedEvent"},{"$ref":"#/components/schemas/ModerationCheckCompletedEvent"},{"$ref":"#/components/schemas/ModerationCustomActionEvent"},{"$ref":"#/components/schemas/ModerationFlaggedEvent"},{"$ref":"#/components/schemas/ModerationMarkReviewedEvent"},{"$ref":"#/components/schemas/NotificationMarkUnreadEvent"},{"$ref":"#/components/schemas/PendingMessageEvent"},{"$ref":"#/components/schemas/PermissionRequestEvent"},{"$ref":"#/components/schemas/ReactionDeletedEvent"},{"$ref":"#/components/schemas/ReactionNewEvent"},{"$ref":"#/components/schemas/ReactionUpdatedEvent"},{"$ref":"#/components/schemas/ReminderCreatedEvent"},{"$ref":"#/components/schemas/ReminderDeletedEvent"},{"$ref":"#/components/schemas/ReminderNotificationEvent"},{"$ref":"#/components/schemas/ReminderUpdatedEvent"},{"$ref":"#/components/schemas/ReviewQueueItemNewEvent"},{"$ref":"#/components/schemas/ReviewQueueItemUpdatedEvent"},{"$ref":"#/components/schemas/ThreadUpdatedEvent"},{"$ref":"#/components/schemas/UnblockedUserEvent"},{"$ref":"#/components/schemas/UpdatedCallPermissionsEvent"},{"$ref":"#/components/schemas/UserBannedEvent"},{"$ref":"#/components/schemas/UserDeactivatedEvent"},{"$ref":"#/components/schemas/UserDeletedEvent"},{"$ref":"#/components/schemas/UserFlaggedEvent"},{"$ref":"#/components/schemas/UserMutedEvent"},{"$ref":"#/components/schemas/UserReactivatedEvent"},{"$ref":"#/components/schemas/UserUnbannedEvent"},{"$ref":"#/components/schemas/UserUnmutedEvent"},{"$ref":"#/components/schemas/UserUnreadReminderEvent"},{"$ref":"#/components/schemas/UserUpdatedEvent"}]},"WrappedUnreadCountsResponse":{"description":"Basic response information","nullable":true,"properties":{"channel_type":{"items":{"$ref":"#/components/schemas/UnreadCountsChannelType"},"type":"array","x-stream-index":"001.005"},"channels":{"items":{"$ref":"#/components/schemas/UnreadCountsChannel"},"type":"array","x-stream-index":"001.004"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"threads":{"items":{"$ref":"#/components/schemas/UnreadCountsThread"},"type":"array","x-stream-index":"001.006"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"001.001"},"total_unread_count_by_team":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001.003"},"total_unread_threads_count":{"format":"int32","type":"integer","x-stream-index":"001.002"}},"required":["total_unread_count","total_unread_threads_count","channels","channel_type","threads","duration"],"title":"Response","type":"object"},"XiaomiConfig":{"properties":{"Disabled":{"type":"boolean","writeOnly":true,"x-stream-index":"003"},"package_name":{"type":"string","x-stream-index":"001"},"secret":{"type":"string","x-stream-index":"002"}},"type":"object"},"XiaomiConfigFields":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"package_name":{"type":"string","x-stream-index":"002"},"secret":{"type":"string","x-stream-index":"003"}},"required":["enabled"],"type":"object"}},"securitySchemes":{"JWT":{"description":"JWT should be always provided when stream-auth-type=jwt.\n\nUsing JWT auth request could be authenticated as user or as server-side.\n\nWhen using user authentication permission checking is going to be applied to requests based on the user that is\nperforming a request.\n\nThe `authorization` header should be a JWT string signed using the secret attached to the API key used to perform\nrequests.\n\n**WARNING** all client-side official SDK do not ship with token generation; this is to make sure that the API secret is not\nshared with an untrusted party such as a browser or a iOS/Android application. Tokens **must** be generated server-side.\nIf you wish, you can configure your application to ignore authentication (see `disable_auth_check`)\nThe JWT string must include only the user_id claim and can include any built-in JWT claim such as iat, exp as well.\n","in":"header","name":"Authorization","type":"apiKey"},"api_key":{"description":"Application API key should be always set in order to authenticate the request.","in":"query","name":"api_key","type":"apiKey"},"stream-auth-type":{"description":"Stream-Auth-Type should be always set in order to authenticate the request. Possible\nvalues: `jwt` or `anonymous`.\n\n`jwt` allows you to authenticate as a user. With this auth type you should also provide valid JWT in Authorization\nheader.\n\n`anonymous` allows you to authenticate as anonymous user. Please note that most advanced features are not available\nto anonymous users.","in":"header","name":"Stream-Auth-Type","type":"apiKey"}}},"info":{"title":"Stream API","version":"v187.13.0"},"openapi":"3.0.3","paths":{"/api/v2/app":{"get":{"description":"This Method returns the application settings\n","operationId":"GetApp","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetApplicationResponse"}}},"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":"Get App Settings","tags":["product:common"]},"patch":{"description":"This Method updates one or more application settings\n","operationId":"UpdateApp","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAppRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Update App Settings","tags":["product:common"]}},"/api/v2/blocklists":{"get":{"description":"Returns all available block lists\n","operationId":"ListBlockLists","parameters":[{"in":"query","name":"team","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListBlockListResponse"}}},"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":"List block lists","tags":["product:common"]},"post":{"description":"Creates a new application blocklist, once created the blocklist can be used by any channel type\n","operationId":"CreateBlockList","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBlockListRequest"}}},"description":"Block list","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBlockListResponse"}}},"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":"Create block list","tags":["product:common"]}},"/api/v2/blocklists/{name}":{"delete":{"description":"Deletes previously created application blocklist\n","operationId":"DeleteBlockList","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"team","schema":{"type":"string","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete block list","tags":["product:common"]},"get":{"description":"Returns block list by given name\n","operationId":"GetBlockList","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Block list name","title":"Name","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"team","schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBlockListResponse"}}},"description":"GetBlockListResponse"},"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":"Get block list","tags":["product:common"]},"put":{"description":"Updates contents of the block list\n","operationId":"UpdateBlockList","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Block list name","title":"Name","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBlockListRequest"}}},"description":"Update block list","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBlockListResponse"}}},"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":"Update block list","tags":["product:common"]}},"/api/v2/chat/campaigns/query":{"post":{"description":"Query campaigns with filter query\n","operationId":"QueryCampaigns","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCampaignsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCampaignsResponse"}}},"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":"Query campaigns","tags":["product:chat"]}},"/api/v2/chat/campaigns/{id}":{"get":{"description":"Get campaign by ID.\n","operationId":"GetCampaign","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"The ID of the campaign (uuid)","maxLength":255,"title":"Campaign ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"prev","schema":{"description":"Token for the previous page of campaign users","title":"Previous Users Page","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"query","name":"next","schema":{"description":"Token for the next page of campaign users","title":"Next Users Page","type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"limit","schema":{"description":"Maximum number of campaign users to return in a single request (max: 1000)","format":"int32","maximum":1000,"minimum":0,"title":"Users Limit","type":"integer","writeOnly":true,"x-stream-index":"002.003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCampaignResponse"}}},"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":"Get campaign","tags":["product:chat"]}},"/api/v2/chat/campaigns/{id}/start":{"post":{"description":"Starts or schedules a campaign\n","operationId":"StartCampaign","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartCampaignRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartCampaignResponse"}}},"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":"Start/schedule campaign","tags":["product:chat"]}},"/api/v2/chat/campaigns/{id}/stop":{"post":{"description":"Stops a campaign\n","operationId":"ScheduleCampaign","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopCampaignRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignResponse"}}},"description":"Successful 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":"Stop campaign","tags":["product:chat"]}},"/api/v2/chat/channels":{"post":{"description":"Query channels with filter query\n","operationId":"QueryChannels","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryChannelsRequest"}}},"description":"Query Channels Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryChannelsResponse"}}},"description":"Channels list"},"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":"Query channels","tags":["product:chat"]}},"/api/v2/chat/channels/delete":{"post":{"description":"Allows to delete several channels at once asynchronously\n\nSends events:\n- channel.deleted\n- channel.deleted\n","operationId":"DeleteChannels","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteChannelsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteChannelsResponse"}}},"description":"Successful 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":"Deletes channels asynchronously","tags":["product:chat"]}},"/api/v2/chat/channels/read":{"post":{"description":"Marks channels as read up to the specific message. If no channels is given, mark all channel as read\n\nSends events:\n- message.read\n- message.read\n","operationId":"MarkChannelsRead","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkChannelsReadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkReadResponse"}}},"description":"Successful 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 channels as read","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/query":{"post":{"description":"This Method creates a channel or returns an existing one with matching attributes\n\nSends events:\n- channel.created\n- member.added\n- member.removed\n- member.updated\n- user.watching.start\n","operationId":"GetOrCreateDistinctChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelGetOrCreateRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelStateResponse"}}},"description":"Successful 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":"Get or create channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}":{"delete":{"description":"Deletes channel\n\nSends events:\n- channel.deleted\n- channel.deleted\n","operationId":"DeleteChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"query","name":"hard_delete","schema":{"type":"boolean","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteChannelResponse"}}},"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":"Delete channel","tags":["product:chat"]},"patch":{"description":"Updates certain fields of the channel\n\nSends events:\n- channel.updated\n- channel.updated\n","operationId":"UpdateChannelPartial","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelPartialRequest"}}},"description":"UpdateChannelPartialRequest","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelPartialResponse"}}},"description":"Successful 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":"Partially update channel","tags":["product:chat"]},"post":{"description":"Change channel data\n\nSends events:\n- channel.updated\n- member.added\n- member.removed\n- member.updated\n- message.new\n- channel.updated\n- member.added\n- member.removed\n- member.updated\n- message.new\n","operationId":"UpdateChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"013.002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"013.002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelRequest"}}},"description":"Channel update request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelResponse"}}},"description":"Successful 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":"Update channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/draft":{"delete":{"description":"Deletes a draft\n\nSends events:\n- draft.deleted\n","operationId":"DeleteDraft","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"parent_id","schema":{"description":"Parent message ID","title":"string","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"003.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete draft","tags":["product:chat"]},"get":{"description":"Get a draft\n","operationId":"GetDraft","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"parent_id","schema":{"description":"Parent message ID","title":"string","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"003.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetDraftResponse"}}},"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":"Get draft","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/event":{"post":{"description":"Sends event to the channel\n","operationId":"SendEvent","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendEventRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventResponse"}}},"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":"Send event","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/file":{"delete":{"description":"Deletes previously uploaded file\n","operationId":"DeleteFile","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of file","title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"File ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"url","schema":{"description":"File URL to delete","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete file","tags":["product:chat"]},"post":{"description":"Uploads file\n","operationId":"UploadFile","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/FileUploadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileUploadResponse"}}},"description":"Successful 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":"Upload file","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/hide":{"post":{"description":"Marks channel as hidden for current user\n\nSends events:\n- channel.hidden\n- channel.hidden\n","operationId":"HideChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HideChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HideChannelResponse"}}},"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":"Hide channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/image":{"delete":{"description":"Deletes previously uploaded image\n","operationId":"DeleteImage","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of file","title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"File ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"url","schema":{"description":"File URL to delete","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete image","tags":["product:chat"]},"post":{"description":"Uploads image\n","operationId":"UploadImage","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.001.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.001.002"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/ImageUploadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageUploadResponse"}}},"description":"Successful 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":"Upload image","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/member":{"patch":{"description":"\n","operationId":"UpdateMemberPartial","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"005.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMemberPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMemberPartialResponse"}}},"description":"Successful 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":"Partially channel member update","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/message":{"post":{"description":"Sends new message to the specified channel\n\nSends events:\n- message.new\n- message.updated\n- message.new\n- message.updated\n","operationId":"SendMessage","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"009.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"009.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendMessageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendMessageResponse"}}},"description":"Successful 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":"Send new message","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/messages":{"get":{"description":"Returns list messages found by IDs\n","operationId":"GetManyMessages","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"ids","required":true,"schema":{"description":"List of comma-separated IDs","items":{"type":"string"},"maximum":50,"minimum":1,"title":"IDs","type":"array","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetManyMessagesResponse"}}},"description":"Successful 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":"Get many messages","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/query":{"post":{"description":"This Method creates a channel or returns an existing one with matching attributes\n\nSends events:\n- channel.created\n- member.added\n- member.removed\n- member.updated\n- user.watching.start\n","operationId":"GetOrCreateChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID (maximum length of 64 characters)","title":"ID","type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelGetOrCreateRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelStateResponse"}}},"description":"Successful 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":"Get or create channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/read":{"post":{"description":"Marks channel as read up to the specific message\n\nSends events:\n- message.read\n- message.read\n","operationId":"MarkRead","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkReadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkReadResponse"}}},"description":"Successful 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 read","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/show":{"post":{"description":"Shows previously hidden channel\n\nSends events:\n- channel.visible\n- channel.visible\n","operationId":"ShowChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShowChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShowChannelResponse"}}},"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":"Show channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/truncate":{"post":{"description":"Truncates messages from a channel. Can be applied to the entire channel or scoped to specific members.\n\nSends events:\n- channel.truncated\n- channel.truncated\n","operationId":"TruncateChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TruncateChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TruncateChannelResponse"}}},"description":"Successful 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":"Truncate channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/unread":{"post":{"description":"Marks channel as unread from a specific message\n","operationId":"MarkUnread","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkUnreadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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 unread","tags":["product:chat"]}},"/api/v2/chat/channeltypes":{"get":{"description":"Lists all available channel types\n","operationId":"ListChannelTypes","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListChannelTypesResponse"}}},"description":"ListChannelTypesResponse"},"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":"List channel types","tags":["product:chat"]},"post":{"description":"Creates new channel type\n","operationId":"CreateChannelType","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateChannelTypeRequest"}}},"description":"CreateChannelTypeRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateChannelTypeResponse"}}},"description":"Successful 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":"Create channel type","tags":["product:chat"]}},"/api/v2/chat/channeltypes/{name}":{"delete":{"description":"Deletes channel type\n","operationId":"DeleteChannelType","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Channel type name","title":"Name","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete channel type","tags":["product:chat"]},"get":{"description":"Gets channel type\n","operationId":"GetChannelType","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Channel type name","title":"Name","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetChannelTypeResponse"}}},"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":"Get channel type","tags":["product:chat"]},"put":{"description":"Updates channel type\n","operationId":"UpdateChannelType","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelTypeRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelTypeResponse"}}},"description":"Successful 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":"Update channel type","tags":["product:chat"]}},"/api/v2/chat/commands":{"get":{"description":"Returns all custom commands\n","operationId":"ListCommands","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListCommandsResponse"}}},"description":"ListCommandsResponse"},"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":"List commands","tags":["product:chat"]},"post":{"description":"Creates custom chat command\n","operationId":"CreateCommand","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCommandRequest"}}},"description":"CreateCommandRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCommandResponse"}}},"description":"CreateCommandResponse"},"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":"Create command","tags":["product:chat"]}},"/api/v2/chat/commands/{name}":{"delete":{"description":"Deletes custom chat command\n","operationId":"DeleteCommand","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Command name","title":"Name","type":"string","x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCommandResponse"}}},"description":"DeleteCommandResponse"},"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":"Delete command","tags":["product:chat"]},"get":{"description":"Returns custom command by its name\n","operationId":"GetCommand","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Command name","title":"Name","type":"string","x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCommandResponse"}}},"description":"GetCommandResponse"},"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":"Get command","tags":["product:chat"]},"put":{"description":"Updates custom chat command\n","operationId":"UpdateCommand","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Unique command name","title":"Name","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCommandRequest"}}},"description":"UpdateCommandRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCommandResponse"}}},"description":"UpdateCommandResponse"},"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":"Update command","tags":["product:chat"]}},"/api/v2/chat/drafts/query":{"post":{"description":"Queries draft messages for a user\n","operationId":"QueryDrafts","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryDraftsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryDraftsResponse"}}},"description":"Successful 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":"Query draft messages","tags":["product:chat"]}},"/api/v2/chat/export_channels":{"post":{"description":"Exports channel data to JSON file\n","operationId":"ExportChannels","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportChannelsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportChannelsResponse"}}},"description":"Successful 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":"Export channels","tags":["product:chat"]}},"/api/v2/chat/members":{"get":{"description":"Find and filter channel members\n","operationId":"QueryMembers","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryMembersPayload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MembersResponse"}}},"description":"Successful 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":"Query members","tags":["product:chat"]}},"/api/v2/chat/messages/history":{"post":{"description":"Queries history for one message\n","operationId":"QueryMessageHistory","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryMessageHistoryRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryMessageHistoryResponse"}}},"description":"Successful 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":"Query message history","tags":["product:chat"]}},"/api/v2/chat/messages/{id}":{"delete":{"description":"Deletes message\n\nSends events:\n- message.deleted\n- message.deleted\n","operationId":"DeleteMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID to delete","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"hard","schema":{"description":"Delete all message reactions and replies as well","title":"Hard","type":"boolean","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"deleted_by","schema":{"type":"string","writeOnly":true,"x-stream-index":"003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteMessageResponse"}}},"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":"Delete message","tags":["product:chat"]},"get":{"description":"Returns message by ID\n","operationId":"GetMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"ID of the message","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"show_deleted_message","schema":{"description":"Whether to show deleted message","title":"Show deleted message","type":"boolean","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetMessageResponse"}}},"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":"Get message","tags":["product:chat"]},"post":{"description":"Updates message with new data\n\nSends events:\n- message.updated\n- message.updated\n","operationId":"UpdateMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"004.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessageResponse"}}},"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":"Update message","tags":["product:chat"]},"put":{"description":"Updates certain fields of the message\n\nSends events:\n- message.updated\n- message.updated\n","operationId":"UpdateMessagePartial","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessagePartialRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessagePartialResponse"}}},"description":"Successful 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":"Partially message update","tags":["product:chat"]}},"/api/v2/chat/messages/{id}/action":{"post":{"description":"Executes message command action with given parameters\n\nSends events:\n- message.new\n- message.new\n","operationId":"RunMessageAction","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageActionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}},"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":"Run message command action","tags":["product:chat"]}},"/api/v2/chat/messages/{id}/commit":{"post":{"description":"Commits a pending message, which will make it visible in the channel\n\nSends events:\n- message.new\n- message.updated\n- message.new\n- message.updated\n","operationId":"CommitMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommitMessageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}},"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":"Commit message","tags":["product:chat"]}},"/api/v2/chat/messages/{id}/reaction":{"post":{"description":"Sends reaction to specified message\n\nSends events:\n- reaction.new\n- reaction.updated\n","operationId":"SendReaction","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID to send reaction for","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendReactionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendReactionResponse"}}},"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":"Send reaction","tags":["product:chat"]}},"/api/v2/chat/messages/{id}/reaction/{type}":{"delete":{"description":"Removes user reaction from the message\n\nSends events:\n- reaction.deleted\n","operationId":"DeleteReaction","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID to remove reaction from","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"type","required":true,"schema":{"description":"Reaction type to remove","title":"Type","type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"description":"**Server-side only**. User ID which server acts upon","title":"User ID","type":"string","writeOnly":true,"x-stream-index":"003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteReactionResponse"}}},"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":"Delete reaction","tags":["product:chat"]}},"/api/v2/chat/messages/{id}/reactions":{"get":{"description":"Returns list of reactions of specific message\n","operationId":"GetReactions","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"limit","schema":{"description":"Number of records to return","format":"int32","title":"Limit","type":"integer","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"offset","schema":{"description":"Number of records to offset","format":"int32","title":"Offset","type":"integer","writeOnly":true,"x-stream-index":"003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetReactionsResponse"}}},"description":"Successful 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":"Get reactions","tags":["product:chat"]},"post":{"description":"Get reactions on a message\n","operationId":"QueryReactions","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryReactionsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryReactionsResponse"}}},"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"}},"tags":["product:chat"]}},"/api/v2/chat/messages/{id}/translate":{"post":{"description":"Translates message to a given language using automated translation software\n\nSends events:\n- message.updated\n- message.updated\n","operationId":"TranslateMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TranslateMessageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}},"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":"Translate message","tags":["product:chat"]}},"/api/v2/chat/messages/{id}/undelete":{"post":{"description":"Undelete a message that was previously soft-deleted\n\nSends events:\n- message.undeleted\n- message.undeleted\n","operationId":"UndeleteMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"004.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessageResponse"}}},"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":"Undelete message","tags":["product:chat"]}},"/api/v2/chat/messages/{message_id}/polls/{poll_id}/vote":{"post":{"description":"Cast a vote on a poll\n\nSends events:\n- feeds.poll.vote_casted\n- feeds.poll.vote_changed\n- feeds.poll.vote_removed\n- poll.vote_casted\n- poll.vote_changed\n- poll.vote_removed\n","operationId":"CastPollVote","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CastPollVoteRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollVoteResponse"}}},"description":"Successful 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":"Cast vote","tags":["product:chat"]}},"/api/v2/chat/messages/{message_id}/polls/{poll_id}/vote/{vote_id}":{"delete":{"description":"Delete a vote from a poll\n\nSends events:\n- feeds.poll.vote_removed\n- poll.vote_removed\n","operationId":"DeletePollVote","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"004"}},{"in":"path","name":"vote_id","required":true,"schema":{"description":"Vote ID","maxLength":255,"title":"string","type":"string","x-stream-index":"005"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollVoteResponse"}}},"description":"Successful 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":"Delete vote","tags":["product:chat"]}},"/api/v2/chat/messages/{message_id}/reminders":{"delete":{"description":"Deletes a user's created reminder\n\nSends events:\n- reminder.deleted\n","operationId":"DeleteReminder","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteReminderResponse"}}},"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":"Delete reminder","tags":["product:chat"]},"patch":{"description":"Updates an existing reminder\n\nSends events:\n- reminder.updated\n","operationId":"UpdateReminder","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateReminderRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateReminderResponse"}}},"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":"Updates Reminder","tags":["product:chat"]},"post":{"description":"Creates a new reminder\n\nSends events:\n- reminder.created\n","operationId":"CreateReminder","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateReminderRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReminderResponseData"}}},"description":"Successful 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":"Create reminder","tags":["product:chat"]}},"/api/v2/chat/messages/{parent_id}/replies":{"get":{"description":"Returns replies (thread) of the message\n","operationId":"GetReplies","parameters":[{"in":"path","name":"parent_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"sort","schema":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":1,"type":"array","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"limit","schema":{"description":"The maximum number of messages to return (max limit ","format":"int32","minimum":0,"title":"Limit","type":"integer","x-stream-index":"003.001"}},{"in":"query","name":"offset","schema":{"description":"The offset to start from","format":"int32","title":"Offset","type":"integer","x-stream-index":"003.002"}},{"in":"query","name":"id_gte","schema":{"description":"The ID of the message to get messages with a timestamp greater than or equal to","title":"IDGTE","type":"string","x-stream-index":"003.003"}},{"in":"query","name":"id_gt","schema":{"description":"The ID of the message to get messages with a timestamp greater than","title":"IDGT","type":"string","x-stream-index":"003.004"}},{"in":"query","name":"id_lte","schema":{"description":"The ID of the message to get messages with a timestamp smaller than or equal to","title":"IDLTE","type":"string","x-stream-index":"003.005"}},{"in":"query","name":"id_lt","schema":{"description":"The ID of the message to get messages with a timestamp smaller than","title":"IDLT","type":"string","x-stream-index":"003.006"}},{"in":"query","name":"created_at_after_or_equal","schema":{"description":"The timestamp to get messages with a created_at timestamp greater than or equal to","format":"date-time","title":"Created_at after or equal","type":"number","x-stream-index":"003.007"}},{"in":"query","name":"created_at_after","schema":{"description":"The timestamp to get messages with a created_at timestamp greater than","format":"date-time","title":"Created_at after","type":"number","x-stream-index":"003.008"}},{"in":"query","name":"created_at_before_or_equal","schema":{"description":"The timestamp to get messages with a created_at timestamp smaller than or equal to","format":"date-time","title":"Created_at after before or equal","type":"number","x-stream-index":"003.009"}},{"in":"query","name":"created_at_before","schema":{"description":"The timestamp to get messages with a created_at timestamp smaller than","format":"date-time","title":"Created_at after before","type":"number","x-stream-index":"003.010"}},{"in":"query","name":"id_around","schema":{"description":"The result will be a set of messages, that are both older and newer than the message with the provided ID, and the message with the ID provided will be in the middle of the set","title":"Id around","type":"string","x-stream-index":"003.011"}},{"in":"query","name":"created_at_around","schema":{"description":"The result will be a set of messages, that are both older and newer than the created_at timestamp provided, distributed evenly around the timestamp","format":"date-time","title":"Created_at around","type":"number","x-stream-index":"003.012"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRepliesResponse"}}},"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":"Get replies","tags":["product:chat"]}},"/api/v2/chat/moderation/flags/message":{"get":{"description":"Find and filter message flags\n","operationId":"QueryMessageFlags","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryMessageFlagsPayload","description":"JSON object with query message flags payload","title":"Payload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryMessageFlagsResponse"}}},"description":"QueryMessageFlagsResponse"},"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":"Query Message Flags","tags":["product:chat"]}},"/api/v2/chat/moderation/mute/channel":{"post":{"description":"Mutes channel for user\n\nSends events:\n- channel.muted\n- channel.muted\n","operationId":"MuteChannel","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteChannelResponse"}}},"description":"Successful 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":"Mute channel","tags":["product:chat"]}},"/api/v2/chat/moderation/unmute/channel":{"post":{"description":"Unmutes channel for user\n\nSends events:\n- channel.unmuted\n- channel.unmuted\n","operationId":"UnmuteChannel","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnmuteChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnmuteResponse"}}},"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":"Unmute channel","tags":["product:chat"]}},"/api/v2/chat/push_preferences":{"post":{"description":"Update the push preferences for a user and or channel member. Set to all, mentions or none\n","operationId":"UpdatePushNotificationPreferences","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertPushPreferencesRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertPushPreferencesResponse"}}},"description":"Successful 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":"Push notification preferences","tags":["product:chat"]}},"/api/v2/chat/push_templates":{"get":{"description":"Retrieve push notification templates for Chat.\n","operationId":"GetPushTemplates","parameters":[{"in":"query","name":"push_provider_name","schema":{"description":"Push provider name to filter templates","title":"string","type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"push_provider_type","required":true,"schema":{"description":"Push provider type (firebase, apn) to filter templates","enum":["firebase","apn"],"title":"string","type":"string","writeOnly":true,"x-stream-index":"003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPushTemplatesResponse"}}},"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":"Get push notification templates","tags":["product:chat"]},"post":{"description":"Create or update a push notification template for a specific event type and push provider\n","operationId":"UpsertPushTemplate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertPushTemplateRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertPushTemplateResponse"}}},"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":"Upsert a push notification template","tags":["product:chat"]}},"/api/v2/chat/query_banned_users":{"get":{"description":"Find and filter channel scoped or global user bans\n","operationId":"QueryBannedUsers","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryBannedUsersPayload","description":"JSON object with query user bans payload","title":"Payload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryBannedUsersResponse"}}},"description":"Successful 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":"Query Banned Users","tags":["product:chat"]}},"/api/v2/chat/reminders/query":{"post":{"description":"Queries reminders\n","operationId":"QueryReminders","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryRemindersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryRemindersResponse"}}},"description":"Successful 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":"Query reminders","tags":["product:chat"]}},"/api/v2/chat/search":{"get":{"description":"Search messages across channels\n","operationId":"Search","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchPayload","description":"JSON object with search payload","title":"Payload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchResponse"}}},"description":"Successful 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":"Search messages","tags":["product:chat"]}},"/api/v2/chat/segments/query":{"post":{"description":"Query segments\n","operationId":"QuerySegments","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuerySegmentsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuerySegmentsResponse"}}},"description":"Successful 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":"Query segments","tags":["product:chat"]}},"/api/v2/chat/segments/{id}":{"delete":{"description":"Delete a segment\n","operationId":"DeleteSegment","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete segment","tags":["product:chat"]},"get":{"description":"Get segment\n","operationId":"GetSegment","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetSegmentResponse"}}},"description":"Successful 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":"Get segment","tags":["product:chat"]}},"/api/v2/chat/segments/{id}/deletetargets":{"post":{"description":"Delete targets from a segment\n","operationId":"DeleteSegmentTargets","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteSegmentTargetsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete targets from a segment","tags":["product:chat"]}},"/api/v2/chat/segments/{id}/target/{target_id}":{"get":{"description":"Check whether a target exists in a segment. Returns 200 if the target exists, 404 otherwise\n","operationId":"SegmentTargetExists","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"target_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Check whether a target exists in a segment","tags":["product:chat"]}},"/api/v2/chat/segments/{id}/targets/query":{"post":{"description":"Query segment targets\n","operationId":"QuerySegmentTargets","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuerySegmentTargetsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuerySegmentTargetsResponse"}}},"description":"Successful 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":"Query segment targets","tags":["product:chat"]}},"/api/v2/chat/threads":{"post":{"description":"Returns the list of threads for specific user\n","operationId":"QueryThreads","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryThreadsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryThreadsResponse"}}},"description":"Successful 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":"Query Threads","tags":["product:chat"]}},"/api/v2/chat/threads/{message_id}":{"get":{"description":"Return a specific thread\n","operationId":"GetThread","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"reply_limit","schema":{"description":"Limit the number of replies returned","format":"int32","minimum":0,"title":"Reply limit","type":"integer","writeOnly":true,"x-stream-index":"004"}},{"in":"query","name":"participant_limit","schema":{"description":"Limit the number of participants returned","format":"int32","maximum":100,"minimum":0,"title":"Participant limit","type":"integer","writeOnly":true,"x-stream-index":"005"}},{"in":"query","name":"member_limit","schema":{"description":"Limit the number of members returned per thread channel","format":"int32","maximum":100,"minimum":0,"title":"Member limit","type":"integer","writeOnly":true,"x-stream-index":"006"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetThreadResponse"}}},"description":"Successful 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":"Get Thread","tags":["product:chat"]},"patch":{"description":"Updates certain fields of the thread\n\nSends events:\n- thread.updated\n- thread.updated\n","operationId":"UpdateThreadPartial","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateThreadPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateThreadPartialResponse"}}},"description":"Successful 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":"Partially update thread","tags":["product:chat"]}},"/api/v2/chat/unread":{"get":{"description":"Fetch unread counts for a single user\n","operationId":"UnreadCounts","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WrappedUnreadCountsResponse"}}},"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":"Unread counts","tags":["product:chat"]}},"/api/v2/chat/unread_batch":{"post":{"description":"Fetch unread counts in batch for multiple users in one call\n","operationId":"UnreadCountsBatch","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnreadCountsBatchRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnreadCountsBatchResponse"}}},"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":"Batch unread counts","tags":["product:chat"]}},"/api/v2/chat/users/{user_id}/event":{"post":{"description":"Sends a custom event to a user\n\nSends events:\n- *\n","operationId":"SendUserCustomEvent","parameters":[{"in":"path","name":"user_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendUserCustomEventRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Send user event","tags":["product:chat"]}},"/api/v2/check_push":{"post":{"description":"Sends a test message via push, this is a test endpoint to verify your push settings\n","operationId":"CheckPush","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckPushRequest"}}},"description":"CheckPushRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckPushResponse"}}},"description":"Successful 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":"Check push","tags":["product:common"]}},"/api/v2/check_sns":{"post":{"description":"Validates Amazon SNS configuration\n","operationId":"CheckSNS","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSNSRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSNSResponse"}}},"description":"Successful 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":"Check SNS","tags":["product:common"]}},"/api/v2/check_sqs":{"post":{"description":"Validates Amazon SQS credentials\n","operationId":"CheckSQS","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSQSRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSQSResponse"}}},"description":"Successful 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":"Check SQS","tags":["product:common"]}},"/api/v2/devices":{"delete":{"description":"Deletes one device\n","operationId":"DeleteDevice","parameters":[{"in":"query","name":"id","required":true,"schema":{"description":"Device ID to delete","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"user_id","schema":{"description":"**Server-side only**. User ID which server acts upon","title":"User ID","type":"string","writeOnly":true,"x-stream-index":"002.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete device","tags":["product:common"]},"get":{"description":"Returns all available devices\n","operationId":"ListDevices","parameters":[{"in":"query","name":"user_id","schema":{"description":"**Server-side only**. User ID which server acts upon","title":"User ID","type":"string","writeOnly":true,"x-stream-index":"001.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDevicesResponse"}}},"description":"ListDevicesResponse"},"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":"List devices","tags":["product:common"]},"post":{"description":"Adds a new device to a user, if the same device already exists the call will have no effect\n","operationId":"CreateDevice","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDeviceRequest"}}},"description":"CreateDeviceRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Create device","tags":["product:common"]}},"/api/v2/export/users":{"post":{"description":"Exports user profile, reactions and messages for list of given users\n","operationId":"ExportUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportUsersResponse"}}},"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":"Export users","tags":["product:common"]}},"/api/v2/external_storage":{"get":{"description":"Lists external storage\n","operationId":"ListExternalStorage","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListExternalStorageResponse"}}},"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":"List external storage","tags":["product:common"]},"post":{"description":"Creates new external storage\n","operationId":"CreateExternalStorage","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateExternalStorageRequest"}}},"description":"CreateExternalStorageRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateExternalStorageResponse"}}},"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":"Create external storage","tags":["product:common"]}},"/api/v2/external_storage/{name}":{"delete":{"description":"Deletes external storage\n","operationId":"DeleteExternalStorage","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteExternalStorageResponse"}}},"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":"Delete external storage","tags":["product:common"]},"put":{"description":"\n","operationId":"UpdateExternalStorage","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateExternalStorageRequest"}}},"description":"ExternalStorageRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateExternalStorageResponse"}}},"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":"Update External Storage","tags":["product:common"]}},"/api/v2/external_storage/{name}/check":{"get":{"description":"\n","operationId":"CheckExternalStorage","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckExternalStorageResponse"}}},"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":"Check External Storage","tags":["product:common"]}},"/api/v2/guest":{"post":{"description":"\n","operationId":"CreateGuest","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGuestRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGuestResponse"}}},"description":"Successful 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":"Create Guest","tags":["product:common"]}},"/api/v2/import_urls":{"post":{"description":"Creates a new import URL\n","operationId":"CreateImportURL","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateImportURLRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateImportURLResponse"}}},"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":"Create import URL","tags":["product:common"]}},"/api/v2/imports":{"get":{"description":"Gets an import\n","operationId":"ListImports","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListImportsResponse"}}},"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":"Get import","tags":["product:common"]},"post":{"description":"Creates a new import\n","operationId":"CreateImport","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateImportRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateImportResponse"}}},"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":"Create import","tags":["product:common"]}},"/api/v2/imports/{id}":{"get":{"description":"Gets an import\n","operationId":"GetImport","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetImportResponse"}}},"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":"Get import","tags":["product:common"]}},"/api/v2/moderation/ban":{"post":{"description":"Ban a user from a channel or the entire app\n","operationId":"ban","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BanRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BanResponse"}}},"description":"Successful 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":"Ban","tags":["product:moderation"]}},"/api/v2/moderation/bulk_image_moderation":{"post":{"description":"Moderate multiple images in bulk using a CSV file\n","operationId":"bulk_image_moderation","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkImageModerationRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkImageModerationResponse"}}},"description":"Successful 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":"Bulk image moderation","tags":["product:moderation"]}},"/api/v2/moderation/check":{"post":{"description":"Run moderation checks on the provided content\n","operationId":"check","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckResponse"}}},"description":"Successful 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":"Check","tags":["product:moderation"]}},"/api/v2/moderation/config":{"post":{"description":"Create a new moderation configuration or update an existing one. Configure settings for content filtering, AI analysis, toxicity detection, and other moderation features.\n","operationId":"upsert_config","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertConfigRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertConfigResponse"}}},"description":"Successful 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":"Create or update moderation configuration","tags":["product:moderation"]}},"/api/v2/moderation/config/{key}":{"delete":{"description":"Delete a specific moderation policy by its name\n","operationId":"delete_config","parameters":[{"in":"path","name":"key","required":true,"schema":{"description":"Key of the moderation configuration to delete","title":"Key","type":"string","x-stream-index":"001"}},{"in":"query","name":"team","schema":{"description":"Team associated with the configuration","title":"Team","type":"string","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteModerationConfigResponse"}}},"description":"Successful 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":"Delete a moderation policy","tags":["product:moderation"]},"get":{"description":"Retrieve a specific moderation configuration by its key and team. This configuration contains settings for various moderation features like toxicity detection, AI analysis, and filtering rules.\n","operationId":"get_config","parameters":[{"in":"path","name":"key","required":true,"schema":{"description":"Key of the moderation configuration to retrieve","title":"Key","type":"string","x-stream-index":"001"}},{"in":"query","name":"team","schema":{"description":"Team associated with the configuration","title":"Team","type":"string","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetConfigResponse"}}},"description":"Successful 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":"Get moderation configuration","tags":["product:moderation"]}},"/api/v2/moderation/configs":{"post":{"description":"Search and filter moderation configurations across your application. This endpoint is designed for building moderation dashboards and managing multiple configuration sets.\n","operationId":"query_moderation_configs","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationConfigsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationConfigsResponse"}}},"description":"Successful 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":"Query moderation configurations","tags":["product:moderation"]}},"/api/v2/moderation/custom_check":{"post":{"description":"Custom check, add your own AI model reports to the review queue\n","operationId":"custom_check","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomCheckRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomCheckResponse"}}},"description":"Successful 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":"Custom check endpoint","tags":["product:moderation"]}},"/api/v2/moderation/feeds_moderation_template":{"delete":{"description":"Delete a specific moderation template by its name\n","operationId":"V2DeleteTemplate","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteModerationTemplateResponse"}}},"description":"Successful 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":"Delete a moderation template","tags":["product:moderation"]},"get":{"description":"Retrieve a list of feed moderation templates that define preset moderation rules and configurations. Limited to 100 templates per request.\n","operationId":"V2QueryTemplates","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryFeedModerationTemplatesResponse"}}},"description":"Successful 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":"Query feed moderation templates","tags":["product:moderation"]},"post":{"description":"Upsert feeds template for moderation\n","operationId":"V2UpsertTemplate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertModerationTemplateRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertModerationTemplateResponse"}}},"description":"Successful 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":"Upsert feeds template","tags":["product:moderation"]}},"/api/v2/moderation/flag":{"post":{"description":"Flag any type of content (messages, users, channels, activities) for moderation review. Supports custom content types and additional metadata for flagged content.\n","operationId":"flag","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlagRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlagResponse"}}},"description":"Successful 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":"Flag content for moderation","tags":["product:moderation"]}},"/api/v2/moderation/flags":{"post":{"description":"Query flags associated with moderation items. This is used for building a moderation dashboard.\n","operationId":"query_moderation_flags","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationFlagsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationFlagsResponse"}}},"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":"Query moderation flags","tags":["product:moderation"]}},"/api/v2/moderation/logs":{"post":{"description":"Search and filter moderation action logs with support for pagination. View the history of moderation actions taken, including who performed them and when.\n","operationId":"query_moderation_logs","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationLogsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationLogsResponse"}}},"description":"Successful 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":"Query moderation action logs","tags":["product:moderation"]}},"/api/v2/moderation/mute":{"post":{"description":"Mute a user. Mutes are generally not visible to the user you mute, while block is something you notice.\n","operationId":"mute","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteRequest"}}},"description":"MuteRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteResponse"}}},"description":"MuteResponse"},"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":"Mute","tags":["product:moderation"]}},"/api/v2/moderation/review_queue":{"post":{"description":"Query review queue items allows you to filter the review queue items. This is used for building a moderation dashboard.\n","operationId":"query_review_queue","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryReviewQueueRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryReviewQueueResponse"}}},"description":"Successful 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":"Query review queue items","tags":["product:moderation"]}},"/api/v2/moderation/review_queue/{id}":{"get":{"description":"Retrieve a specific review queue item by its ID\n","operationId":"get_review_queue_item","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Unique identifier of the review queue item to retrieve","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetReviewQueueItemResponse"}}},"description":"Successful 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":"Get review queue item","tags":["product:moderation"]}},"/api/v2/moderation/submit_action":{"post":{"description":"Take action on flagged content, such as marking content as safe, deleting content, banning users, or executing custom moderation actions. Supports various action types with configurable parameters.\n","operationId":"submit_action","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitActionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitActionResponse"}}},"description":"Successful 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":"Submit moderation action","tags":["product:moderation"]}},"/api/v2/moderation/unban":{"post":{"description":"Unban a user from a channel or globally.\n","operationId":"unban","parameters":[{"in":"query","name":"target_user_id","required":true,"schema":{"description":"ID of the user to unban","title":"Target User ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"channel_cid","schema":{"description":"Channel where the unban applies","title":"Channel CID","type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"created_by","schema":{"description":"ID of the user who created the ban","title":"Created By","type":"string","writeOnly":true,"x-stream-index":"003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnbanRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnbanResponse"}}},"description":"Successful 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":"Unban","tags":["product:moderation"]}},"/api/v2/moderation/unmute":{"post":{"description":"Unmute a user\n","operationId":"unmute","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnmuteRequest"}}},"description":"UnmuteRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnmuteResponse"}}},"description":"UnmuteResponse"},"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":"Unmute a user","tags":["product:moderation"]}},"/api/v2/og":{"get":{"description":"Get an OpenGraph attachment for a link\n","operationId":"GetOG","parameters":[{"in":"query","name":"url","required":true,"schema":{"description":"URL to be scraped","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOGResponse"}}},"description":"Get OG Attachment"},"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":"Get OG","tags":["product:common"]}},"/api/v2/permissions":{"get":{"description":"Lists all available permissions\n","operationId":"ListPermissions","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPermissionsResponse"}}},"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":"List permissions","tags":["product:common"]}},"/api/v2/permissions/{id}":{"get":{"description":"Gets custom permission\n","operationId":"GetPermission","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Permission ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCustomPermissionResponse"}}},"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":"Get permission","tags":["product:common"]}},"/api/v2/polls":{"post":{"description":"Creates a new poll\n","operationId":"CreatePoll","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePollRequest"}}},"description":"Create Poll Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Create poll","tags":["product:common"]},"put":{"description":"Updates a poll\n\nSends events:\n- feeds.poll.closed\n- feeds.poll.updated\n- poll.closed\n- poll.updated\n","operationId":"UpdatePoll","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePollRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Update poll","tags":["product:common"]}},"/api/v2/polls/query":{"post":{"description":"Queries polls\n","operationId":"QueryPolls","parameters":[{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryPollsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryPollsResponse"}}},"description":"Successful 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":"Query polls","tags":["product:common"]}},"/api/v2/polls/{poll_id}":{"delete":{"description":"Deletes a poll\n\nSends events:\n- feeds.poll.deleted\n- poll.deleted\n","operationId":"DeletePoll","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete poll","tags":["product:common"]},"get":{"description":"Retrieves a poll\n","operationId":"GetPoll","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Get poll","tags":["product:common"]},"patch":{"description":"Updates a poll partially\n\nSends events:\n- feeds.poll.closed\n- feeds.poll.updated\n- poll.closed\n- poll.updated\n","operationId":"UpdatePollPartial","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePollPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Partial update poll","tags":["product:common"]}},"/api/v2/polls/{poll_id}/options":{"post":{"description":"Creates a poll option\n\nSends events:\n- feeds.poll.updated\n- poll.updated\n","operationId":"CreatePollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePollOptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollOptionResponse"}}},"description":"Successful 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":"Create poll option","tags":["product:common"]},"put":{"description":"Updates a poll option\n\nSends events:\n- feeds.poll.updated\n- poll.updated\n","operationId":"UpdatePollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePollOptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollOptionResponse"}}},"description":"Successful 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":"Update poll option","tags":["product:common"]}},"/api/v2/polls/{poll_id}/options/{option_id}":{"delete":{"description":"Deletes a poll option\n\nSends events:\n- feeds.poll.updated\n- poll.updated\n","operationId":"DeletePollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"path","name":"option_id","required":true,"schema":{"description":"Option ID","maxLength":255,"title":"string","type":"string","x-stream-index":"003"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete poll option","tags":["product:common"]},"get":{"description":"Retrieves a poll option\n","operationId":"GetPollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"path","name":"option_id","required":true,"schema":{"description":"Option ID","maxLength":255,"title":"string","type":"string","x-stream-index":"003"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollOptionResponse"}}},"description":"Successful 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":"Get poll option","tags":["product:common"]}},"/api/v2/polls/{poll_id}/votes":{"post":{"description":"Queries votes\n","operationId":"QueryPollVotes","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryPollVotesRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollVotesResponse"}}},"description":"Successful 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":"Query votes","tags":["product:common"]}},"/api/v2/push_providers":{"get":{"description":"List details of all push providers.\n","operationId":"ListPushProviders","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPushProvidersResponse"}}},"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":"List push providers","tags":["product:common"]},"post":{"description":"Upsert a push provider for v2 with multi bundle/package support\n","operationId":"UpsertPushProvider","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertPushProviderRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertPushProviderResponse"}}},"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":"Upsert a push provider","tags":["product:common"]}},"/api/v2/push_providers/{type}/{name}":{"delete":{"description":"Delete a push provider from v2 with multi bundle/package support. v1 isn't supported in this endpoint\n","operationId":"DeletePushProvider","parameters":[{"in":"path","name":"type","required":true,"schema":{"enum":["apn","firebase","huawei","xiaomi"],"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"name","required":true,"schema":{"maxLength":36,"minLength":1,"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete a push provider","tags":["product:common"]}},"/api/v2/rate_limits":{"get":{"description":"Get rate limits usage and quotas\n","operationId":"GetRateLimits","parameters":[{"in":"query","name":"server_side","schema":{"description":"Whether to include server-side platform limits or not","title":"Server-side","type":"boolean","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"android","schema":{"description":"Whether to include Android platform limits or not","title":"Android","type":"boolean","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"ios","schema":{"description":"Whether to include iOS platform limits or not","title":"iOS","type":"boolean","writeOnly":true,"x-stream-index":"003"}},{"in":"query","name":"web","schema":{"description":"Whether to include web platform limits or not","title":"Web","type":"boolean","writeOnly":true,"x-stream-index":"004"}},{"in":"query","name":"endpoints","schema":{"description":"Specific endpoints to show limits for, as a comma-separated list of values","title":"Endpoints","type":"string","writeOnly":true,"x-stream-index":"005"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRateLimitsResponse"}}},"description":"Get Rate Limits 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":"Get rate limits","tags":["product:common"]}},"/api/v2/roles":{"get":{"description":"Lists all available roles\n","operationId":"ListRoles","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListRolesResponse"}}},"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":"List roles","tags":["product:common"]},"post":{"description":"Creates custom role\n","operationId":"CreateRole","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRoleRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRoleResponse"}}},"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":"Create role","tags":["product:common"]}},"/api/v2/roles/{name}":{"delete":{"description":"Deletes custom role\n","operationId":"DeleteRole","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Role name","title":"Name","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete role","tags":["product:common"]}},"/api/v2/tasks/{id}":{"get":{"description":"Gets status of a task\n","operationId":"GetTask","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Task ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetTaskResponse"}}},"description":"Get Task 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":"Get status of a task","tags":["product:common"]}},"/api/v2/uploads/file":{"delete":{"description":"Deletes previously uploaded file\n","operationId":"DeleteFileGlobal","parameters":[{"in":"query","name":"url","schema":{"description":"File URL to delete","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete file","tags":["product:common"],"x-stream-sdk-name":"DeleteFile"},"post":{"description":"Uploads file\n","operationId":"UploadFileGlobal","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/FileUploadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileUploadResponse"}}},"description":"Successful 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":"Upload file","tags":["product:common"],"x-stream-sdk-name":"UploadFile"}},"/api/v2/uploads/image":{"delete":{"description":"Deletes previously uploaded image\n","operationId":"DeleteImageGlobal","parameters":[{"in":"query","name":"url","schema":{"description":"File URL to delete","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete image","tags":["product:common"],"x-stream-sdk-name":"DeleteImage"},"post":{"description":"Uploads image\n","operationId":"UploadImageGlobal","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/ImageUploadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageUploadResponse"}}},"description":"Successful 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":"Upload image","tags":["product:common"],"x-stream-sdk-name":"UploadImage"}},"/api/v2/users":{"get":{"description":"Find and filter users\n","operationId":"QueryUsers","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryUsersPayload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryUsersResponse"}}},"description":"Successful 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":"Query users","tags":["product:common"]},"patch":{"description":"Updates certain fields of the user\n\nSends events:\n- user.presence.changed\n- user.updated\n- user.presence.changed\n","operationId":"UpdateUsersPartial","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersResponse"}}},"description":"Successful 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":"Partially update user","tags":["product:common"]},"post":{"description":"Update or create users in bulk\n\nSends events:\n- user.updated\n","operationId":"UpdateUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersResponse"}}},"description":"Successful 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":"Upsert users","tags":["product:common"]}},"/api/v2/users/block":{"get":{"description":"Get list of blocked Users\n","operationId":"GetBlockedUsers","parameters":[{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBlockedUsersResponse"}}},"description":"Successful 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":"Get list of blocked Users","tags":["product:common"]},"post":{"description":"Block users\n","operationId":"BlockUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUsersResponse"}}},"description":"Successful 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":"Block user","tags":["product:common"]}},"/api/v2/users/deactivate":{"post":{"description":"Deactivate users in batches\n\nSends events:\n- user.deactivated\n","operationId":"DeactivateUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeactivateUsersRequest"}}},"description":"DeactivateUsersRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeactivateUsersResponse"}}},"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":"Deactivate users","tags":["product:common"]}},"/api/v2/users/delete":{"post":{"description":"Deletes users and optionally all their belongings asynchronously.\n\nSends events:\n- channel.deleted\n- user.deleted\n","operationId":"DeleteUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteUsersResponse"}}},"description":"Successful 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":"Delete Users","tags":["product:common"]}},"/api/v2/users/live_locations":{"get":{"description":"Retrieves all active live locations for a user\n","operationId":"GetUserLiveLocations","parameters":[{"in":"query","name":"user_id","schema":{"description":"User ID to get live locations for. If not provided, returns live locations for the authenticated user.","title":"string","type":"string","writeOnly":true,"x-stream-index":"001.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SharedLocationsResponse"}}},"description":"Successful 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":"Get user live locations","tags":["product:common"]},"put":{"description":"Updates an existing live location with new coordinates or expiration time\n","operationId":"UpdateLiveLocation","parameters":[{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"005.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateLiveLocationRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SharedLocationResponse"}}},"description":"Successful 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":"Update live location","tags":["product:common"]}},"/api/v2/users/reactivate":{"post":{"description":"Reactivate users in batches\n\nSends events:\n- user.reactivated\n- user.reactivated\n","operationId":"ReactivateUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReactivateUsersRequest"}}},"description":"ReactivateUsersRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReactivateUsersResponse"}}},"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":"Reactivate users","tags":["product:common"]}},"/api/v2/users/restore":{"post":{"description":"Restore soft deleted users\n","operationId":"RestoreUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestoreUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Restore users","tags":["product:common"]}},"/api/v2/users/unblock":{"post":{"description":"Unblock users\n","operationId":"UnblockUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUsersResponse"}}},"description":"Successful 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":"Unblock user","tags":["product:common"]}},"/api/v2/users/{user_id}/deactivate":{"post":{"description":"Deactivates user with possibility to activate it back\n\nSends events:\n- user.deactivated\n","operationId":"DeactivateUser","parameters":[{"in":"path","name":"user_id","required":true,"schema":{"title":"User ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeactivateUserRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeactivateUserResponse"}}},"description":"Successful 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":"Deactivate user","tags":["product:common"]}},"/api/v2/users/{user_id}/export":{"get":{"description":"Exports the user's profile, reactions and messages. Raises an error if a user has more than 10k messages or reactions\n","operationId":"ExportUser","parameters":[{"in":"path","name":"user_id","required":true,"schema":{"title":"User ID","type":"string","x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportUserResponse"}}},"description":"Successful 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":"Export user","tags":["product:common"]}},"/api/v2/users/{user_id}/reactivate":{"post":{"description":"Activates user who's been deactivated previously\n\nSends events:\n- user.reactivated\n","operationId":"ReactivateUser","parameters":[{"in":"path","name":"user_id","required":true,"schema":{"title":"User ID","type":"string","x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReactivateUserRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReactivateUserResponse"}}},"description":"Successful 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":"Reactivate user","tags":["product:common"]}},"/api/v2/video/active_calls_status":{"get":{"description":"Get the current status of all active calls including metrics and summary information\n","operationId":"GetActiveCallsStatus","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetActiveCallsStatusResponse"}}},"description":"GetActiveCallsStatusResponse"},"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":"Get active calls status","tags":["product:video"]}},"/api/v2/video/call/feedback":{"post":{"description":"\n","operationId":"QueryUserFeedback","parameters":[{"in":"query","name":"full","schema":{"type":"boolean","writeOnly":true,"x-stream-index":"003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryUserFeedbackRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryUserFeedbackResponse"}}},"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":"Query user reported feedback for the calls","tags":["product:video"]}},"/api/v2/video/call/members":{"post":{"description":"Query call members with filter query\n","operationId":"QueryCallMembers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallMembersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallMembersResponse"}}},"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":"Query call members","tags":["product:video"]}},"/api/v2/video/call/stats":{"post":{"description":"\n","operationId":"QueryCallStats","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallStatsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallStatsResponse"}}},"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":"Query Call Stats","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}":{"get":{"description":"\n","operationId":"GetCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"query","name":"members_limit","schema":{"format":"int32","maximum":100,"minimum":0,"type":"integer","writeOnly":true,"x-stream-index":"004"}},{"in":"query","name":"ring","schema":{"type":"boolean","writeOnly":true,"x-stream-index":"005"}},{"in":"query","name":"notify","schema":{"type":"boolean","writeOnly":true,"x-stream-index":"006"}},{"in":"query","name":"video","schema":{"type":"boolean","writeOnly":true,"x-stream-index":"007"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCallResponse"}}},"description":"GetCallResponse"},"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":"Get Call","tags":["product:video"]},"patch":{"description":"\n\nSends events:\n- call.updated\n","operationId":"UpdateCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallRequest"}}},"description":"UpdateCallRequest","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallResponse"}}},"description":"UpdateCallResponse"},"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":"Update Call","tags":["product:video"]},"post":{"description":"Gets or creates a new call\n\nSends events:\n- call.created\n- call.notification\n- call.ring\n","operationId":"GetOrCreateCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrCreateCallRequest"}}},"description":"GetOrCreateCallRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrCreateCallResponse"}}},"description":"GetOrCreateCallResponse"},"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":"Get or create a call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/block":{"post":{"description":"Block a user, preventing them from joining the call until they are unblocked.\n\nSends events:\n- call.blocked_user\n","operationId":"BlockUser","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUserRequest"}}},"description":"BlockUserRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUserResponse"}}},"description":"BlockUserResponse"},"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":"Block user on a call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/delete":{"post":{"description":"\n\nSends events:\n- call.deleted\n","operationId":"DeleteCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCallRequest"}}},"description":"DeleteCallRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCallResponse"}}},"description":"DeleteCallResponse"},"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":"Delete Call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/event":{"post":{"description":"Sends custom event to the call\n\nSends events:\n- custom\n","operationId":"SendCallEvent","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendCallEventRequest"}}},"description":"SendCallEventRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendCallEventResponse"}}},"description":"SendCallEventResponse"},"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":"Send custom event","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/feedback":{"post":{"description":"\n\nSends events:\n- call.user_feedback_submitted\n","operationId":"CollectUserFeedback","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectUserFeedbackRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectUserFeedbackResponse"}}},"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":"Collect user feedback","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/go_live":{"post":{"description":"\n\nSends events:\n- call.live_started\n","operationId":"GoLive","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoLiveRequest"}}},"description":"GoLiveRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoLiveResponse"}}},"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":"Set call as live","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/mark_ended":{"post":{"description":"\n\nSends events:\n- call.ended\n","operationId":"EndCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EndCallResponse"}}},"description":"EndCallResponse"},"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":"End call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/members":{"post":{"description":"\n\nSends events:\n- call.member_added\n- call.member_removed\n- call.member_updated\n","operationId":"UpdateCallMembers","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallMembersRequest"}}},"description":"UpdateCallMembersRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallMembersResponse"}}},"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":"Update Call Member","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/mute_users":{"post":{"description":"Mutes users in a call\n","operationId":"MuteUsers","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteUsersRequest"}}},"description":"MuteUsersRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteUsersResponse"}}},"description":"MuteUsersResponse"},"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":"Mute users","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/participants":{"post":{"description":"Returns a list of participants connected to the call\n","operationId":"QueryCallParticipants","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"type","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"limit","schema":{"format":"int32","maximum":100,"type":"integer","x-stream-index":"004"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallParticipantsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallParticipantsResponse"}}},"description":"Successful 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":"Query call participants","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/pin":{"post":{"description":"Pins a track for all users in the call.\n","operationId":"VideoPin","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PinRequest"}}},"description":"PinRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PinResponse"}}},"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":"Pin","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/recordings":{"get":{"description":"Lists recordings\n","operationId":"ListRecordings","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListRecordingsResponse"}}},"description":"ListRecordingsResponse"},"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":"List recordings","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/report":{"get":{"description":"\n","operationId":"GetCallReport","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"query","name":"session_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCallReportResponse"}}},"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":"Get call report","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/rtmp_broadcasts":{"post":{"description":"Starts RTMP broadcasts for the provided RTMP destinations\n","operationId":"StartRTMPBroadcasts","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRTMPBroadcastsRequest"}}},"description":"StartRTMPBroadcastsRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRTMPBroadcastsResponse"}}},"description":"StartRTMPBroadcastsResponse"},"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":"Start RTMP broadcasts","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/rtmp_broadcasts/stop":{"post":{"description":"Stop all RTMP broadcasts for the provided call\n","operationId":"StopAllRTMPBroadcasts","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopAllRTMPBroadcastsResponse"}}},"description":"StopAllRTMPBroadcastsResponse"},"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":"Stop all RTMP broadcasts for a call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/rtmp_broadcasts/{name}/stop":{"post":{"description":"Stop RTMP broadcasts for the provided RTMP destinations\n","operationId":"StopRTMPBroadcast","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopRTMPBroadcastsRequest"}}},"description":"StopRTMPBroadcastsRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopRTMPBroadcastsResponse"}}},"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":"Stop RTMP broadcasts","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/start_broadcasting":{"post":{"description":"Starts HLS broadcasting\n","operationId":"StartHLSBroadcasting","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartHLSBroadcastingResponse"}}},"description":"StartHLSBroadcastingResponse"},"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":"Start HLS broadcasting","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/start_closed_captions":{"post":{"description":"Starts closed captions\n","operationId":"StartClosedCaptions","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartClosedCaptionsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartClosedCaptionsResponse"}}},"description":"Successful 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":"Start closed captions","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/start_frame_recording":{"post":{"description":"Starts frame by frame recording\n\nSends events:\n- call.frame_recording_started\n","operationId":"StartFrameRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartFrameRecordingRequest"}}},"description":"StartFrameRecordingRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartFrameRecordingResponse"}}},"description":"StartFrameRecordingResponse"},"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":"Start frame recording","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/start_recording":{"post":{"description":"Starts recording\n\nSends events:\n- call.recording_started\n","operationId":"StartRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRecordingRequest"}}},"description":"StartRecordingRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRecordingResponse"}}},"description":"StartRecordingResponse"},"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":"Start recording","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/start_transcription":{"post":{"description":"Starts transcription\n","operationId":"StartTranscription","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartTranscriptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartTranscriptionResponse"}}},"description":"StartTranscriptionResponse"},"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":"Start transcription","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_broadcasting":{"post":{"description":"Stops HLS broadcasting\n","operationId":"StopHLSBroadcasting","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopHLSBroadcastingResponse"}}},"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":"Stop HLS broadcasting","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_closed_captions":{"post":{"description":"Stops closed captions\n\nSends events:\n- call.transcription_stopped\n","operationId":"StopClosedCaptions","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopClosedCaptionsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopClosedCaptionsResponse"}}},"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":"Stop closed captions","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_frame_recording":{"post":{"description":"Stops frame recording\n\nSends events:\n- call.frame_recording_stopped\n","operationId":"StopFrameRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopFrameRecordingResponse"}}},"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":"Stop frame recording","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_live":{"post":{"description":"\n\nSends events:\n- call.updated\n","operationId":"StopLive","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopLiveRequest"}}},"description":"StopLiveRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopLiveResponse"}}},"description":"StopLiveResponse"},"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":"Set call as not live","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_recording":{"post":{"description":"Stops recording\n\nSends events:\n- call.recording_stopped\n","operationId":"StopRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopRecordingResponse"}}},"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":"Stop recording","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_transcription":{"post":{"description":"Stops transcription\n\nSends events:\n- call.transcription_stopped\n","operationId":"StopTranscription","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopTranscriptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopTranscriptionResponse"}}},"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":"Stop transcription","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/transcriptions":{"get":{"description":"Lists transcriptions\n","operationId":"ListTranscriptions","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTranscriptionsResponse"}}},"description":"ListTranscriptionsResponse"},"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":"List transcriptions","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/unblock":{"post":{"description":"Removes the block for a user on a call. The user will be able to join the call again.\n\nSends events:\n- call.unblocked_user\n","operationId":"UnblockUser","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUserRequest"}}},"description":"UnblockUserRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUserResponse"}}},"description":"UnblockUserResponse"},"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":"Unblocks user on a call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/unpin":{"post":{"description":"Unpins a track for all users in the call.\n","operationId":"VideoUnpin","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnpinRequest"}}},"description":"UnpinRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnpinResponse"}}},"description":"UnpinResponse"},"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":"Unpin","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/user_permissions":{"post":{"description":"Updates user permissions\n\nSends events:\n- call.permissions_updated\n","operationId":"UpdateUserPermissions","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"005.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"005.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUserPermissionsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUserPermissionsResponse"}}},"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":"Update user permissions","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/{session}/recordings/{filename}":{"delete":{"description":"Deletes recording\n","operationId":"DeleteRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"path","name":"session","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"003"}},{"in":"path","name":"filename","required":true,"schema":{"maxLength":256,"type":"string","writeOnly":true,"x-stream-index":"004"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteRecordingResponse"}}},"description":"DeleteRecordingResponse"},"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":"Delete recording","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/{session}/transcriptions/{filename}":{"delete":{"description":"Deletes transcription\n","operationId":"DeleteTranscription","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"path","name":"session","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"003"}},{"in":"path","name":"filename","required":true,"schema":{"maxLength":256,"type":"string","writeOnly":true,"x-stream-index":"004"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteTranscriptionResponse"}}},"description":"DeleteTranscriptionResponse"},"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":"Delete transcription","tags":["product:video"]}},"/api/v2/video/calls":{"post":{"description":"Query calls with filter query\n","operationId":"QueryCalls","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallsRequest"}}},"description":"QueryCallsRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallsResponse"}}},"description":"QueryCallsResponse"},"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":"Query call","tags":["product:video"]}},"/api/v2/video/calltypes":{"get":{"description":"\n","operationId":"ListCallTypes","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListCallTypeResponse"}}},"description":"ListCallTypeResponse"},"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":"List Call Type","tags":["product:video"]},"post":{"description":"\n","operationId":"CreateCallType","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCallTypeRequest"}}},"description":"CreateCallTypeRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCallTypeResponse"}}},"description":"CreateCallTypeResponse"},"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":"Create Call Type","tags":["product:video"]}},"/api/v2/video/calltypes/{name}":{"delete":{"description":"\n","operationId":"DeleteCallType","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete Call Type","tags":["product:video"]},"get":{"description":"\n","operationId":"GetCallType","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCallTypeResponse"}}},"description":"GetCallTypeResponse"},"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":"Get Call Type","tags":["product:video"]},"put":{"description":"\n","operationId":"UpdateCallType","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallTypeRequest"}}},"description":"UpdateCallTypeRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallTypeResponse"}}},"description":"UpdateCallTypeResponse"},"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":"Update Call Type","tags":["product:video"]}},"/api/v2/video/edges":{"get":{"description":"Returns the list of all edges available for video calls.\n","operationId":"GetEdges","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetEdgesResponse"}}},"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":"Get Edges","tags":["product:video"]}},"/api/v2/video/stats":{"post":{"description":"\n","operationId":"QueryAggregateCallStats","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryAggregateCallStatsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryAggregateCallStatsResponse"}}},"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":"Query Aggregate call Stats","tags":["product:video"]}}},"security":[{"JWT":[],"api_key":[],"stream-auth-type":[]},{"api_key":[],"stream-auth-type":[]}],"servers":[{"description":"Stream API","url":"https://chat.stream-io-api.com"}]} \ No newline at end of file +{"components":{"schemas":{"AIImageConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"ocr_rules":{"items":{"$ref":"#/components/schemas/OCRRule"},"type":"array","x-stream-index":"004"},"rules":{"items":{"$ref":"#/components/schemas/AWSRekognitionRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules","ocr_rules"],"type":"object"},"AITextConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"profile":{"type":"string","x-stream-index":"003"},"rules":{"items":{"$ref":"#/components/schemas/BodyguardRule"},"type":"array","x-stream-index":"004"},"severity_rules":{"items":{"$ref":"#/components/schemas/BodyguardSeverityRule"},"type":"array","x-stream-index":"005"}},"required":["enabled","profile","rules","severity_rules"],"type":"object"},"AIVideoConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AWSRekognitionRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"APIError":{"nullable":true,"properties":{"StatusCode":{"description":"Response HTTP status code","format":"int32","title":"Status code","type":"integer","x-stream-index":"004"},"code":{"description":"API error code","format":"int32","title":"Code","type":"integer","x-stream-index":"001"},"details":{"description":"Additional error-specific information","items":{"type":"integer"},"title":"Details","type":"array","x-stream-index":"007"},"duration":{"description":"Request duration","title":"Duration","type":"string","x-stream-index":"005"},"exception_fields":{"additionalProperties":{"type":"string"},"description":"Additional error info","title":"Exception fields","type":"object","x-stream-index":"003"},"message":{"description":"Message describing an error","title":"Message","type":"string","x-stream-index":"002"},"more_info":{"description":"URL with additional information","title":"More info","type":"string","x-stream-index":"006"},"unrecoverable":{"description":"Flag that indicates if the error is unrecoverable, requests that return unrecoverable errors should not be retried, this error only applies to the request that caused it","title":"Unrecoverable","type":"boolean","x-stream-index":"008"}},"required":["code","message","StatusCode","duration","more_info","details"],"title":"Error response","type":"object"},"APNConfig":{"properties":{"Disabled":{"type":"boolean","writeOnly":true,"x-stream-index":"005"},"auth_key":{"type":"string","x-stream-index":"006.001"},"auth_type":{"enum":["certificate","token"],"type":"string","x-stream-index":"001"},"bundle_id":{"type":"string","x-stream-index":"004"},"development":{"type":"boolean","x-stream-index":"002"},"host":{"type":"string","x-stream-index":"003"},"key_id":{"type":"string","x-stream-index":"006.002"},"notification_template":{"type":"string","x-stream-index":"008"},"p12_cert":{"type":"string","x-stream-index":"007.001"},"team_id":{"type":"string","x-stream-index":"006.003"}},"type":"object"},"APNConfigFields":{"properties":{"auth_key":{"type":"string","x-stream-index":"009"},"auth_type":{"type":"string","x-stream-index":"003"},"bundle_id":{"type":"string","x-stream-index":"006"},"development":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"host":{"type":"string","x-stream-index":"005"},"key_id":{"type":"string","x-stream-index":"008"},"notification_template":{"type":"string","x-stream-index":"004"},"p12_cert":{"type":"string","x-stream-index":"010"},"team_id":{"type":"string","x-stream-index":"007"}},"required":["enabled","development"],"type":"object"},"APNS":{"properties":{"body":{"type":"string","x-stream-index":"002"},"content-available":{"format":"int32","type":"integer","x-stream-index":"004"},"data":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"mutable-content":{"format":"int32","type":"integer","x-stream-index":"005"},"sound":{"type":"string","x-stream-index":"003"},"title":{"type":"string","x-stream-index":"001"}},"required":["title","body"],"type":"object"},"AWSRekognitionRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"},"min_confidence":{"format":"float","maximum":100,"minimum":0,"type":"number","x-stream-index":"003"}},"required":["label","action","min_confidence"],"type":"object"},"AcceptFeedMemberInviteRequest":{"nullable":true,"properties":{"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"title":"Accept Feed Member Invite Request","type":"object"},"AcceptFeedMemberInviteResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"member":{"$ref":"#/components/schemas/FeedMemberResponse","description":"The feed member after accepting the invite","title":"Feed Member","x-stream-index":"001"}},"required":["member","duration"],"title":"Accept Feed Member Invite Response","type":"object"},"AcceptFollowRequest":{"nullable":true,"properties":{"follower_role":{"description":"Optional role for the follower in the follow relationship","title":"Follower Role","type":"string","x-stream-index":"003"},"source":{"description":"Fully qualified ID of the source feed","maxLength":255,"title":"Source Feed ID","type":"string","x-stream-index":"001"},"target":{"description":"Fully qualified ID of the target feed","maxLength":255,"title":"Target Feed ID","type":"string","x-stream-index":"002"}},"required":["source","target"],"title":"Accept Follow Request","type":"object"},"AcceptFollowResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"follow":{"$ref":"#/components/schemas/FollowResponse","description":"The accepted follow relationship","title":"Follow","x-stream-index":"001"}},"required":["follow","duration"],"title":"Accept Follow Response","type":"object"},"Action":{"nullable":true,"properties":{"name":{"type":"string","x-stream-index":"001"},"style":{"type":"string","x-stream-index":"003"},"text":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"004"},"value":{"type":"string","x-stream-index":"005"}},"required":["name","text","type"],"type":"object"},"ActionLog":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"002"},"reason":{"type":"string","x-stream-index":"008"},"reporter_type":{"type":"string","x-stream-index":"009"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"014"},"review_queue_item_id":{"type":"string","x-stream-index":"012"},"target_user":{"$ref":"#/components/schemas/User","x-stream-index":"013"},"target_user_id":{"type":"string","x-stream-index":"011"},"type":{"type":"string","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007"}},"required":["id","created_at","type","reason","reporter_type","custom","target_user_id","review_queue_item_id"],"type":"object"},"ActionLogResponse":{"nullable":true,"properties":{"created_at":{"description":"Timestamp when the action was taken","format":"date-time","title":"Created At","type":"number","x-stream-index":"002"},"custom":{"additionalProperties":{},"description":"Additional metadata about the action","title":"Custom","type":"object","x-stream-index":"007"},"id":{"description":"Unique identifier of the action log","title":"ID","type":"string","x-stream-index":"001"},"reason":{"description":"Reason for the moderation action","title":"Reason","type":"string","x-stream-index":"006"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"Associated review queue item","title":"Review Queue Item","x-stream-index":"008"},"target_user":{"$ref":"#/components/schemas/UserResponse","description":"User who was the target of the action","title":"Target User","x-stream-index":"009"},"target_user_id":{"description":"ID of the user who was the target of the action","title":"Target User ID","type":"string","x-stream-index":"010"},"type":{"description":"Type of moderation action","title":"Type","type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who performed the action","title":"User","x-stream-index":"004"},"user_id":{"description":"ID of the user who performed the action","title":"User ID","type":"string","x-stream-index":"005"}},"required":["id","created_at","type","user_id","reason","custom","target_user_id"],"type":"object"},"ActionSequence":{"properties":{"action":{"type":"string","x-stream-index":"001"},"blur":{"type":"boolean","x-stream-index":"005"},"cooldown_period":{"format":"int32","type":"integer","x-stream-index":"004"},"threshold":{"format":"int32","type":"integer","x-stream-index":"002"},"time_window":{"format":"int32","type":"integer","x-stream-index":"003"},"warning":{"type":"boolean","x-stream-index":"006"},"warning_text":{"type":"string","x-stream-index":"007"}},"required":["action","threshold","time_window","cooldown_period","blur","warning","warning_text"],"type":"object"},"ActiveCallsBitrateStats":{"properties":{"p10":{"format":"float","type":"number","x-stream-index":"001"},"p50":{"format":"float","type":"number","x-stream-index":"002"}},"required":["p10","p50"],"type":"object"},"ActiveCallsFPSStats":{"properties":{"p05":{"format":"float","type":"number","x-stream-index":"001"},"p10":{"format":"float","type":"number","x-stream-index":"002"},"p50":{"format":"float","type":"number","x-stream-index":"003"},"p90":{"format":"float","type":"number","x-stream-index":"004"}},"required":["p05","p10","p50","p90"],"type":"object"},"ActiveCallsLatencyStats":{"properties":{"p50":{"format":"float","type":"number","x-stream-index":"001"},"p90":{"format":"float","type":"number","x-stream-index":"002"}},"required":["p50","p90"],"type":"object"},"ActiveCallsMetrics":{"properties":{"join_call_api":{"$ref":"#/components/schemas/JoinCallAPIMetrics","x-stream-index":"001"},"publishers":{"$ref":"#/components/schemas/PublishersMetrics","x-stream-index":"002"},"subscribers":{"$ref":"#/components/schemas/SubscribersMetrics","x-stream-index":"003"}},"type":"object"},"ActiveCallsResolutionStats":{"properties":{"p10":{"format":"float","type":"number","x-stream-index":"001"},"p50":{"format":"float","type":"number","x-stream-index":"002"}},"required":["p10","p50"],"type":"object"},"ActiveCallsSummary":{"properties":{"active_calls":{"format":"int32","type":"integer","x-stream-index":"001"},"active_publishers":{"format":"int32","type":"integer","x-stream-index":"002"},"active_subscribers":{"format":"int32","type":"integer","x-stream-index":"003"},"participants":{"format":"int32","type":"integer","x-stream-index":"004"}},"required":["active_calls","active_publishers","active_subscribers","participants"],"type":"object"},"ActivityAddedEvent":{"description":"Emitted when an activity is added to a feed.","nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","description":"The activity that was added","title":"Activity","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"type":"string","x-stream-index":"002.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.activity.added","description":"The type of event: \"feeds.activity.added\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who added the activity","title":"User","x-stream-index":"003.001"}},"required":["activity","type","created_at","custom","fid"],"title":"ActivityAddedEvent","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"},"ActivityDeletedEvent":{"description":"Emitted when an activity is deleted.","nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","description":"The activity that was updated","title":"Activity","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"type":"string","x-stream-index":"002.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.activity.deleted","description":"The type of event: \"feeds.activity.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","x-stream-index":"003.001"}},"required":["activity","type","created_at","custom","fid"],"title":"ActivityDeletedEvent","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"},"ActivityFeedbackRequest":{"description":"Request to provide feedback on an activity","nullable":true,"properties":{"hide":{"description":"Whether to hide this activity","title":"bool","type":"boolean","x-stream-index":"003"},"mute_user":{"description":"Whether to mute the user who created this activity","title":"bool","type":"boolean","x-stream-index":"005"},"reason":{"description":"Reason for the feedback (optional)","maxLength":1000,"title":"string","type":"string","x-stream-index":"006"},"report":{"description":"Whether to report this activity","title":"bool","type":"boolean","x-stream-index":"004"},"show_less":{"description":"Whether to show less content like this","title":"bool","type":"boolean","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"008.002"},"user_id":{"type":"string","x-stream-index":"008.001"}},"title":"Activity Feedback Request","type":"object"},"ActivityFeedbackResponse":{"description":"Response for activity feedback submission","nullable":true,"properties":{"activity_id":{"description":"The ID of the activity that received feedback","title":"string","type":"string","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["activity_id","duration"],"title":"Activity Feedback Response","type":"object"},"ActivityLocation":{"properties":{"lat":{"description":"Latitude coordinate","format":"float","title":"Latitude","type":"number","x-stream-index":"001"},"lng":{"description":"Longitude coordinate","format":"float","title":"Longitude","type":"number","x-stream-index":"002"}},"required":["lat","lng"],"title":"Activity Location","type":"object"},"ActivityMarkEvent":{"description":"Emitted when activities are marked as read, seen, or watched.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"006.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006.001.007"},"feed_visibility":{"type":"string","x-stream-index":"006.003"},"fid":{"type":"string","x-stream-index":"006.002"},"mark_all_read":{"description":"Whether all activities were marked as read","title":"Mark All Read","type":"boolean","x-stream-index":"004"},"mark_all_seen":{"description":"Whether all activities were marked as seen","title":"Mark All Seen","type":"boolean","x-stream-index":"005"},"mark_read":{"description":"The IDs of activities marked as read","items":{"type":"string"},"title":"Mark Read","type":"array","x-stream-index":"001"},"mark_seen":{"description":"The IDs of activities marked as seen","items":{"type":"string"},"title":"Mark Seen","type":"array","x-stream-index":"002"},"mark_watched":{"description":"The IDs of activities marked as watched","items":{"type":"string"},"title":"Mark Watched","type":"array","x-stream-index":"003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"006.001.004"},"type":{"default":"feeds.activity.marked","description":"The type of event: \"feeds.activity.marked\" in this case","title":"Event Type","type":"string","x-stream-index":"006.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who marked the activities","title":"User","x-stream-index":"007.001"}},"required":["type","created_at","custom","fid"],"title":"ActivityMarkEvent","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"},"ActivityMarkedEvent":{"properties":{"all_read":{"type":"boolean","x-stream-index":"006"},"all_seen":{"type":"boolean","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"feed_id":{"type":"string","x-stream-index":"003"},"marked_read":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"marked_watched":{"items":{"type":"string"},"type":"array","x-stream-index":"005"},"type":{"default":"activity.marked","type":"string","x-stream-index":"001.001"},"user_id":{"type":"string","x-stream-index":"002"}},"required":["type","created_at","user_id","feed_id","all_read","all_seen"],"title":"ActivityMarkedEvent","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"},"ActivityPinResponse":{"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","description":"The pinned activity","title":"Activity","x-stream-index":"002"},"created_at":{"description":"When the pin was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"004"},"feed":{"description":"ID of the feed where activity is pinned","title":"Feed ID","type":"string","x-stream-index":"003"},"updated_at":{"description":"When the pin was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who pinned the activity","title":"User","x-stream-index":"001"}},"required":["user","activity","feed","created_at","updated_at"],"title":"Activity Pin","type":"object"},"ActivityPinnedEvent":{"description":"Emitted when an activity is pinned.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"description":"The ID of the feed","title":"Feed ID","type":"string","x-stream-index":"002.002"},"pinned_activity":{"$ref":"#/components/schemas/PinActivityResponse","x-stream-index":"001"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.activity.pinned","description":"The type of event: \"feeds.activity.pinned\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who pinned the activity","title":"User","x-stream-index":"003.001"}},"required":["pinned_activity","type","created_at","custom","fid"],"title":"ActivityPinnedEvent","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"},"ActivityProcessorConfig":{"properties":{"type":{"description":"Type of activity processor (required)","title":"Type","type":"string","x-stream-index":"001"}},"required":["type"],"title":"Activity Processor Configuration","type":"object"},"ActivityReactionAddedEvent":{"description":"Emitted when a reaction is added to an activity.","nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"003.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.001.007"},"feed_visibility":{"type":"string","x-stream-index":"003.003"},"fid":{"type":"string","x-stream-index":"003.002"},"reaction":{"$ref":"#/components/schemas/FeedsReactionResponse","description":"The reaction that was added","title":"Reaction","x-stream-index":"002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.001.004"},"type":{"default":"feeds.activity.reaction.added","description":"The type of event: \"feeds.activity.reaction.added\" in this case","title":"Event Type","type":"string","x-stream-index":"003.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who added the reaction","title":"User","x-stream-index":"004.001"}},"required":["activity","reaction","type","created_at","custom","fid"],"title":"ActivityReactionAddedEvent","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"},"ActivityReactionDeletedEvent":{"description":"Emitted when a reaction is deleted from an activity.","nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"003.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.001.007"},"feed_visibility":{"type":"string","x-stream-index":"003.003"},"fid":{"type":"string","x-stream-index":"003.002"},"reaction":{"$ref":"#/components/schemas/FeedsReactionResponse","x-stream-index":"002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.001.004"},"type":{"default":"feeds.activity.reaction.deleted","description":"The type of the reaction that was removed","title":"Type","type":"string","x-stream-index":"003.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who removed the reaction","title":"User","x-stream-index":"004.001"}},"required":["activity","reaction","type","created_at","custom","fid"],"title":"ActivityReactionDeletedEvent","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"},"ActivityReactionUpdatedEvent":{"description":"Emitted when a reaction is updated on an activity.","nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"003.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.001.007"},"feed_visibility":{"type":"string","x-stream-index":"003.003"},"fid":{"type":"string","x-stream-index":"003.002"},"reaction":{"$ref":"#/components/schemas/FeedsReactionResponse","description":"The reaction that was updated","title":"Reaction","x-stream-index":"002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.001.004"},"type":{"default":"feeds.activity.reaction.updated","description":"The type of event: \"feeds.activity.reaction.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"003.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who updated the reaction","title":"User","x-stream-index":"004.001"}},"required":["activity","reaction","type","created_at","custom","fid"],"title":"ActivityReactionUpdatedEvent","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"},"ActivityRemovedFromFeedEvent":{"description":"Emitted when an activity is removed from a feed.","nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"type":"string","x-stream-index":"002.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.activity.removed_from_feed","description":"The type of event: \"feeds.activity.removed_from_feed\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who removed the activity","title":"User","x-stream-index":"003.001"}},"required":["activity","type","created_at","custom","fid"],"title":"ActivityRemovedFromFeedEvent","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"},"ActivityRequest":{"properties":{"attachments":{"description":"List of attachments for the activity","items":{"$ref":"#/components/schemas/Attachment"},"title":"Attachments","type":"array","x-stream-index":"006"},"custom":{"additionalProperties":{},"description":"Custom data for the activity","title":"Custom Data","type":"object","x-stream-index":"017"},"expires_at":{"description":"Expiration time for the activity","title":"Expires At","type":"string","x-stream-index":"010"},"feeds":{"description":"List of feed IDs to add the activity to","items":{"type":"string"},"maximum":255,"minimum":1,"title":"Feed IDs","type":"array","x-stream-index":"004"},"filter_tags":{"description":"Tags for filtering activities","items":{"type":"string"},"maximum":255,"title":"Filter Tags","type":"array","x-stream-index":"013"},"id":{"description":"Optional ID for the activity","maxLength":255,"title":"Activity ID","type":"string","x-stream-index":"001"},"interest_tags":{"description":"Tags for indicating user interests","items":{"type":"string"},"maximum":255,"title":"Interest Tags","type":"array","x-stream-index":"014"},"location":{"$ref":"#/components/schemas/ActivityLocation","description":"Geographic location related to the activity","title":"Location","x-stream-index":"009"},"mentioned_user_ids":{"description":"List of users mentioned in the activity","items":{"type":"string"},"maximum":255,"title":"Mentioned User IDs","type":"array","x-stream-index":"011"},"parent_id":{"description":"ID of parent activity for replies/comments","maxLength":255,"title":"Parent ID","type":"string","x-stream-index":"015"},"poll_id":{"description":"ID of a poll to attach to activity","title":"Poll ID","type":"string","x-stream-index":"016"},"search_data":{"additionalProperties":{},"description":"Additional data for search indexing","title":"Search Data","type":"object","x-stream-index":"012"},"text":{"description":"Text content of the activity","title":"Text","type":"string","x-stream-index":"005"},"type":{"description":"Type of activity","maxLength":255,"title":"Activity Type","type":"string","x-stream-index":"002"},"user_id":{"description":"ID of the user creating the activity","maxLength":255,"title":"User ID","type":"string","x-stream-index":"003"},"visibility":{"description":"Visibility setting for the activity","enum":["public","private","tag"],"title":"Visibility","type":"string","x-stream-index":"007"},"visibility_tag":{"description":"If visibility is 'tag', this is the tag name and is required","maxLength":32,"title":"Visibility Tag","type":"string","x-stream-index":"008"}},"required":["type","feeds"],"title":"Activity Request","type":"object"},"ActivityResponse":{"properties":{"attachments":{"description":"Media attachments for the activity","items":{"$ref":"#/components/schemas/Attachment"},"title":"Attachments","type":"array","x-stream-index":"009"},"bookmark_count":{"description":"Number of bookmarks on the activity","format":"int32","title":"Bookmark Count","type":"integer","x-stream-index":"028"},"comment_count":{"description":"Number of comments on the activity","format":"int32","title":"Comment Count","type":"integer","x-stream-index":"027"},"comments":{"description":"Comments on this activity","items":{"$ref":"#/components/schemas/CommentResponse"},"title":"Comments","type":"array","x-stream-index":"015"},"created_at":{"description":"When the activity was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"007"},"current_feed":{"$ref":"#/components/schemas/FeedResponse","description":"Feed context for this activity view. If an activity is added only to one feed, it's always set. If an activity is added to multiple feeds, it's only set when calling the GetOrCreateFeed endpoint.","title":"Current Feed","x-stream-index":"035"},"custom":{"additionalProperties":{},"description":"Custom data for the activity","title":"Custom Data","type":"object","x-stream-index":"011"},"deleted_at":{"description":"When the activity was deleted","format":"date-time","title":"Deleted At","type":"number","x-stream-index":"021"},"edited_at":{"description":"When the activity was last edited","format":"date-time","title":"Edited At","type":"number","x-stream-index":"020"},"expires_at":{"description":"When the activity will expire","format":"date-time","title":"Expires At","type":"number","x-stream-index":"022"},"feeds":{"description":"List of feed IDs containing this activity","items":{"type":"string"},"title":"Feeds","type":"array","x-stream-index":"004"},"filter_tags":{"description":"Tags for filtering","items":{"type":"string"},"title":"Filter Tags","type":"array","x-stream-index":"024"},"hidden":{"description":"If this activity is hidden for this user. For premium content where you want to show a preview","title":"Hidden","type":"boolean","x-stream-index":"036"},"id":{"description":"Unique identifier for the activity","title":"ID","type":"string","x-stream-index":"001"},"interest_tags":{"description":"Tags for user interests","items":{"type":"string"},"title":"Interest Tags","type":"array","x-stream-index":"025"},"latest_reactions":{"description":"Recent reactions to the activity","items":{"$ref":"#/components/schemas/FeedsReactionResponse"},"title":"Latest Reactions","type":"array","x-stream-index":"031"},"location":{"$ref":"#/components/schemas/ActivityLocation","description":"Geographic location related to the activity","title":"Location","x-stream-index":"017"},"mentioned_users":{"description":"Users mentioned in the activity","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Mentioned Users","type":"array","x-stream-index":"010"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","description":"Moderation information","title":"Moderation","x-stream-index":"026"},"notification_context":{"additionalProperties":{},"description":"Notification context data for the activity (if this is a reaction, comment, follow, etc.)","title":"Notification Context","type":"object","x-stream-index":"012"},"own_bookmarks":{"description":"Current user's bookmarks for this activity","items":{"$ref":"#/components/schemas/BookmarkResponse"},"title":"Own Bookmarks","type":"array","x-stream-index":"034"},"own_reactions":{"description":"Current user's reactions to this activity","items":{"$ref":"#/components/schemas/FeedsReactionResponse"},"title":"Own Reactions","type":"array","x-stream-index":"033"},"parent":{"$ref":"#/components/schemas/ActivityResponse","description":"Parent activity (if this is a reply/comment)","title":"Parent","x-stream-index":"018"},"poll":{"$ref":"#/components/schemas/PollResponseData","description":"Poll attached to this activity","title":"Poll","x-stream-index":"019"},"popularity":{"description":"Popularity score of the activity","format":"int32","title":"Popularity","type":"integer","x-stream-index":"013"},"reaction_count":{"description":"Number of reactions to the activity","format":"int32","title":"Reaction Count","type":"integer","x-stream-index":"030"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"description":"Grouped reactions by type","title":"Reaction Groups","type":"object","x-stream-index":"032"},"score":{"description":"Ranking score for this activity","format":"float","title":"Score","type":"number","x-stream-index":"014"},"search_data":{"additionalProperties":{},"description":"Data for search indexing","title":"Search Data","type":"object","x-stream-index":"023"},"share_count":{"description":"Number of times the activity was shared","format":"int32","title":"Share Count","type":"integer","x-stream-index":"029"},"text":{"description":"Text content of the activity","title":"Text","type":"string","x-stream-index":"016"},"type":{"description":"Type of activity","title":"Type","type":"string","x-stream-index":"002"},"updated_at":{"description":"When the activity was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"008"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who created the activity","title":"User","x-stream-index":"003"},"visibility":{"description":"Visibility setting for the activity","enum":["public","private","tag"],"title":"Visibility","type":"string","x-stream-index":"005"},"visibility_tag":{"description":"If visibility is 'tag', this is the tag name","title":"Visibility Tag","type":"string","x-stream-index":"006"}},"required":["id","type","user","feeds","visibility","created_at","updated_at","attachments","mentioned_users","custom","popularity","score","comments","search_data","filter_tags","interest_tags","comment_count","bookmark_count","share_count","reaction_count","latest_reactions","reaction_groups","own_reactions","own_bookmarks"],"title":"Base Activity","type":"object"},"ActivitySelectorConfig":{"properties":{"cutoff_time":{"description":"Time threshold for activity selection","format":"date-time","title":"Cutoff Time","type":"number","x-stream-index":"004"},"filter":{"additionalProperties":{},"description":"Filter for activity selection","title":"Filter","type":"object","x-stream-index":"002"},"min_popularity":{"description":"Minimum popularity threshold","format":"int32","title":"Minimum Popularity","type":"integer","x-stream-index":"005"},"sort":{"description":"Sort parameters for activity selection","items":{"$ref":"#/components/schemas/SortParam"},"title":"Sort","type":"array","x-stream-index":"003"},"type":{"description":"Type of selector","title":"Type","type":"string","x-stream-index":"001"}},"title":"Activity Selector Configuration","type":"object"},"ActivityUnpinnedEvent":{"description":"Emitted when an activity is unpinned.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"description":"The ID of the feed","title":"Feed ID","type":"string","x-stream-index":"002.002"},"pinned_activity":{"$ref":"#/components/schemas/PinActivityResponse","x-stream-index":"001"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.activity.unpinned","description":"The type of event: \"feeds.activity.unpinned\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who unpinned the activity","title":"User","x-stream-index":"003.001"}},"required":["pinned_activity","type","created_at","custom","fid"],"title":"ActivityUnpinnedEvent","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"},"ActivityUpdatedEvent":{"description":"Emitted when an activity is updated.","nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","description":"The activity that was updated","title":"Activity","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"type":"string","x-stream-index":"002.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.activity.updated","description":"The type of the event","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who updated the activity","title":"User","x-stream-index":"003.001"}},"required":["activity","type","created_at","custom","fid"],"title":"ActivityUpdatedEvent","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"},"AddActivityRequest":{"nullable":true,"properties":{"attachments":{"description":"List of attachments for the activity","items":{"$ref":"#/components/schemas/Attachment"},"title":"Attachments","type":"array","x-stream-index":"001.006"},"custom":{"additionalProperties":{},"description":"Custom data for the activity","title":"Custom Data","type":"object","x-stream-index":"001.017"},"expires_at":{"description":"Expiration time for the activity","title":"Expires At","type":"string","x-stream-index":"001.010"},"feeds":{"description":"List of feed IDs to add the activity to","items":{"type":"string"},"maximum":255,"minimum":1,"title":"Feed IDs","type":"array","x-stream-index":"001.004"},"filter_tags":{"description":"Tags for filtering activities","items":{"type":"string"},"maximum":255,"title":"Filter Tags","type":"array","x-stream-index":"001.013"},"id":{"description":"Optional ID for the activity","maxLength":255,"title":"Activity ID","type":"string","x-stream-index":"001.001"},"interest_tags":{"description":"Tags for indicating user interests","items":{"type":"string"},"maximum":255,"title":"Interest Tags","type":"array","x-stream-index":"001.014"},"location":{"$ref":"#/components/schemas/ActivityLocation","description":"Geographic location related to the activity","title":"Location","x-stream-index":"001.009"},"mentioned_user_ids":{"description":"List of users mentioned in the activity","items":{"type":"string"},"maximum":255,"title":"Mentioned User IDs","type":"array","x-stream-index":"001.011"},"parent_id":{"description":"ID of parent activity for replies/comments","maxLength":255,"title":"Parent ID","type":"string","x-stream-index":"001.015"},"poll_id":{"description":"ID of a poll to attach to activity","title":"Poll ID","type":"string","x-stream-index":"001.016"},"search_data":{"additionalProperties":{},"description":"Additional data for search indexing","title":"Search Data","type":"object","x-stream-index":"001.012"},"text":{"description":"Text content of the activity","title":"Text","type":"string","x-stream-index":"001.005"},"type":{"description":"Type of activity","maxLength":255,"title":"Activity Type","type":"string","x-stream-index":"001.002"},"user_id":{"description":"ID of the user creating the activity","maxLength":255,"title":"User ID","type":"string","x-stream-index":"001.003"},"visibility":{"description":"Visibility setting for the activity","enum":["public","private","tag"],"title":"Visibility","type":"string","x-stream-index":"001.007"},"visibility_tag":{"description":"If visibility is 'tag', this is the tag name and is required","maxLength":32,"title":"Visibility Tag","type":"string","x-stream-index":"001.008"}},"required":["type","feeds"],"title":"Activity Request","type":"object"},"AddActivityResponse":{"nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","description":"The created activity","title":"Activity","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["activity","duration"],"title":"Add Activity Response","type":"object"},"AddBookmarkRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"description":"Custom data for the bookmark","title":"Custom Data","type":"object","x-stream-index":"004"},"folder_id":{"description":"ID of the folder to add the bookmark to","maxLength":255,"title":"Folder ID","type":"string","x-stream-index":"002"},"new_folder":{"$ref":"#/components/schemas/AddFolderRequest","description":"Create a new folder for this bookmark","title":"New Folder","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"005.002"},"user_id":{"type":"string","x-stream-index":"005.001"}},"title":"Add Bookmark Request","type":"object"},"AddBookmarkResponse":{"nullable":true,"properties":{"bookmark":{"$ref":"#/components/schemas/BookmarkResponse","description":"The created bookmark","title":"Bookmark","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["bookmark","duration"],"title":"Add Bookmark Response","type":"object"},"AddCommentReactionRequest":{"nullable":true,"properties":{"create_notification_activity":{"description":"Whether to create a notification activity for this reaction","title":"boolean","type":"boolean","x-stream-index":"004"},"custom":{"additionalProperties":{},"description":"Optional custom data to add to the reaction","title":"object","type":"object","x-stream-index":"003"},"skip_push":{"type":"boolean","x-stream-index":"005"},"type":{"description":"The type of reaction, eg upvote, like, ...","maxLength":255,"title":"string","type":"string","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"007.002"},"user_id":{"type":"string","x-stream-index":"007.001"}},"required":["type"],"type":"object"},"AddCommentReactionResponse":{"nullable":true,"properties":{"comment":{"$ref":"#/components/schemas/CommentResponse","description":"The comment the reaction was added to","title":"object","x-stream-index":"001"},"duration":{"description":"Duration of the request","title":"string","type":"string","x-stream-index":"003.001"},"reaction":{"$ref":"#/components/schemas/FeedsReactionResponse","description":"The created or updated reaction","title":"object","x-stream-index":"002"}},"required":["comment","reaction","duration"],"type":"object"},"AddCommentRequest":{"nullable":true,"properties":{"attachments":{"description":"Media attachments for the reply","items":{"$ref":"#/components/schemas/Attachment"},"title":"Attachments","type":"array","x-stream-index":"004"},"comment":{"description":"Text content of the comment","title":"Comment","type":"string","x-stream-index":"003"},"create_notification_activity":{"description":"Whether to create a notification activity for this comment","title":"Create Notification Activity","type":"boolean","x-stream-index":"008"},"custom":{"additionalProperties":{},"description":"Custom data for the comment","title":"Custom Data","type":"object","x-stream-index":"007"},"mentioned_user_ids":{"description":"List of users mentioned in the reply","items":{"type":"string"},"maximum":255,"title":"Mentioned User IDs","type":"array","x-stream-index":"005"},"object_id":{"description":"ID of the object to comment on","title":"Object ID","type":"string","x-stream-index":"001"},"object_type":{"description":"Type of the object to comment on","title":"Object Type","type":"string","x-stream-index":"002"},"parent_id":{"description":"ID of parent comment for replies","title":"Parent ID","type":"string","x-stream-index":"006"},"skip_push":{"type":"boolean","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"010.002"},"user_id":{"type":"string","x-stream-index":"010.001"}},"required":["object_id","object_type","comment"],"title":"Add Comment Request","type":"object"},"AddCommentResponse":{"nullable":true,"properties":{"comment":{"$ref":"#/components/schemas/CommentResponse","description":"The created comment","title":"Comment","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["comment","duration"],"title":"Add Comment Response","type":"object"},"AddCommentsBatchRequest":{"nullable":true,"properties":{"comments":{"description":"List of comments to add","items":{"$ref":"#/components/schemas/AddCommentRequest"},"title":"Comments","type":"array","x-stream-index":"001"}},"required":["comments"],"title":"Add Comments Batch Request","type":"object"},"AddCommentsBatchResponse":{"nullable":true,"properties":{"comments":{"description":"List of comments added","items":{"$ref":"#/components/schemas/CommentResponse"},"title":"Comments","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["comments","duration"],"title":"Add Comments Batch Response","type":"object"},"AddFolderRequest":{"properties":{"custom":{"additionalProperties":{},"description":"Custom data for the folder","title":"Custom Data","type":"object","x-stream-index":"002"},"name":{"description":"Name of the folder","maxLength":255,"title":"Name","type":"string","x-stream-index":"001"}},"required":["name"],"title":"Add Folder Request","type":"object"},"AddReactionRequest":{"nullable":true,"properties":{"create_notification_activity":{"description":"Whether to create a notification activity for this reaction","title":"Create Notification Activity","type":"boolean","x-stream-index":"004"},"custom":{"additionalProperties":{},"description":"Custom data for the reaction","title":"Custom Data","type":"object","x-stream-index":"003"},"skip_push":{"type":"boolean","x-stream-index":"005"},"type":{"description":"Type of reaction","maxLength":255,"title":"Reaction Type","type":"string","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"006.002"},"user_id":{"type":"string","x-stream-index":"006.001"}},"required":["type"],"title":"Add Reaction Request","type":"object"},"AddReactionResponse":{"nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"reaction":{"$ref":"#/components/schemas/FeedsReactionResponse","description":"The created reaction","title":"Reaction","x-stream-index":"002"}},"required":["activity","reaction","duration"],"title":"Add Reaction Response","type":"object"},"AggregatedActivityResponse":{"properties":{"activities":{"description":"List of activities in this aggregation","items":{"$ref":"#/components/schemas/ActivityResponse"},"title":"Activities","type":"array","x-stream-index":"001"},"activity_count":{"description":"Number of activities in this aggregation","format":"int32","title":"Activity Count","type":"integer","x-stream-index":"002"},"created_at":{"description":"When the aggregation was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"006"},"group":{"description":"Grouping identifier","title":"Group","type":"string","x-stream-index":"004"},"score":{"description":"Ranking score for this aggregation","format":"float","title":"Score","type":"number","x-stream-index":"005"},"updated_at":{"description":"When the aggregation was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"007"},"user_count":{"description":"Number of unique users in this aggregation","format":"int32","title":"User Count","type":"integer","x-stream-index":"003"}},"required":["activities","activity_count","user_count","group","score","created_at","updated_at"],"title":"Aggregated Activity","type":"object"},"AggregationConfig":{"properties":{"format":{"description":"Format for activity aggregation","title":"Format","type":"string","x-stream-index":"001"}},"title":"Aggregation Configuration","type":"object"},"AnyEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"*","type":"string","x-stream-index":"001.001"}},"required":["type","created_at"],"title":"AnyEvent","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"},"AppResponseFields":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"019"},"async_url_enrich_enabled":{"type":"boolean","x-stream-index":"017"},"auto_translation_enabled":{"type":"boolean","x-stream-index":"020"},"before_message_send_hook_url":{"type":"string","x-stream-index":"021"},"call_types":{"additionalProperties":{"$ref":"#/components/schemas/CallType"},"type":"object","x-stream-index":"007"},"campaign_enabled":{"type":"boolean","x-stream-index":"034"},"cdn_expiration_seconds":{"format":"int32","type":"integer","x-stream-index":"037"},"channel_configs":{"additionalProperties":{"$ref":"#/components/schemas/ChannelConfig"},"type":"object","x-stream-index":"006"},"custom_action_handler_url":{"type":"string","x-stream-index":"022"},"datadog_info":{"$ref":"#/components/schemas/DataDogInfo","x-stream-index":"040"},"disable_auth_checks":{"type":"boolean","x-stream-index":"011"},"disable_permissions_checks":{"type":"boolean","x-stream-index":"012"},"enforce_unique_usernames":{"type":"string","x-stream-index":"023"},"event_hooks":{"items":{"$ref":"#/components/schemas/EventHook"},"type":"array","x-stream-index":"045"},"file_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","x-stream-index":"030"},"geofences":{"items":{"$ref":"#/components/schemas/GeofenceResponse"},"type":"array","x-stream-index":"039"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"033"},"guest_user_creation_disabled":{"type":"boolean","x-stream-index":"043"},"image_moderation_enabled":{"type":"boolean","x-stream-index":"016"},"image_moderation_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"018"},"image_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","x-stream-index":"031"},"moderation_bulk_submit_action_enabled":{"type":"boolean","x-stream-index":"048"},"moderation_dashboard_preferences":{"$ref":"#/components/schemas/ModerationDashboardPreferences","x-stream-index":"044"},"moderation_enabled":{"type":"boolean","x-stream-index":"041"},"moderation_llm_configurability_enabled":{"type":"boolean","x-stream-index":"049"},"moderation_multitenant_blocklist_enabled":{"type":"boolean","x-stream-index":"042"},"moderation_webhook_url":{"type":"string","x-stream-index":"005"},"multi_tenant_enabled":{"type":"boolean","x-stream-index":"015"},"name":{"type":"string","x-stream-index":"001"},"organization":{"type":"string","x-stream-index":"002"},"permission_version":{"type":"string","x-stream-index":"013"},"policies":{"additionalProperties":{"items":{"$ref":"#/components/schemas/Policy"},"type":"array"},"type":"object","x-stream-index":"008"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationFields","x-stream-index":"003"},"reminders_interval":{"format":"int32","type":"integer","x-stream-index":"036"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"032"},"sns_key":{"type":"string","x-stream-index":"028"},"sns_secret":{"type":"string","x-stream-index":"029"},"sns_topic_arn":{"type":"string","x-stream-index":"027"},"sqs_key":{"type":"string","x-stream-index":"025"},"sqs_secret":{"type":"string","x-stream-index":"026"},"sqs_url":{"type":"string","x-stream-index":"024"},"suspended":{"type":"boolean","x-stream-index":"009"},"suspended_explanation":{"type":"string","x-stream-index":"010"},"use_hook_v2":{"type":"boolean","x-stream-index":"046"},"user_response_time_enabled":{"type":"boolean","x-stream-index":"047"},"user_search_disallowed_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"014"},"webhook_events":{"items":{"type":"string"},"type":"array","x-stream-index":"035"},"webhook_url":{"type":"string","x-stream-index":"004"}},"required":["name","organization","push_notifications","webhook_url","moderation_webhook_url","channel_configs","call_types","policies","suspended","suspended_explanation","disable_auth_checks","disable_permissions_checks","permission_version","user_search_disallowed_roles","multi_tenant_enabled","image_moderation_enabled","async_url_enrich_enabled","auto_translation_enabled","custom_action_handler_url","enforce_unique_usernames","sqs_url","sqs_key","sqs_secret","sns_topic_arn","sns_key","sns_secret","file_upload_config","image_upload_config","grants","campaign_enabled","webhook_events","reminders_interval","cdn_expiration_seconds","video_provider","moderation_enabled","moderation_multitenant_blocklist_enabled","guest_user_creation_disabled","event_hooks","use_hook_v2","user_response_time_enabled","moderation_bulk_submit_action_enabled","moderation_llm_configurability_enabled"],"type":"object"},"AsyncBulkImageModerationEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"003.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.007"},"finished_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.004"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"task_id":{"type":"string","x-stream-index":"002.001"},"type":{"default":"export.bulk_image_moderation.success","type":"string","x-stream-index":"003.002"},"url":{"type":"string","x-stream-index":"001"}},"required":["url","task_id","started_at","finished_at","type","created_at","custom"],"title":"AsyncBulkImageModerationEvent","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"},"AsyncExportChannelsEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"003.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.007"},"finished_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.004"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"task_id":{"type":"string","x-stream-index":"002.001"},"type":{"default":"export.channels.success","type":"string","x-stream-index":"003.002"},"url":{"type":"string","x-stream-index":"001"}},"required":["url","task_id","started_at","finished_at","type","created_at","custom"],"title":"AsyncExportChannelsEvent","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"},"AsyncExportErrorEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"003.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.007"},"error":{"type":"string","x-stream-index":"001"},"finished_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.004"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"task_id":{"type":"string","x-stream-index":"002.001"},"type":{"default":"export.users.error","type":"string","x-stream-index":"003.002"}},"required":["error","task_id","started_at","finished_at","type","created_at","custom"],"title":"AsyncExportErrorEvent","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"},"AsyncExportModerationLogsEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"003.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.007"},"finished_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.004"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"task_id":{"type":"string","x-stream-index":"002.001"},"type":{"default":"export.moderation_logs.success","type":"string","x-stream-index":"003.002"},"url":{"type":"string","x-stream-index":"001"}},"required":["url","task_id","started_at","finished_at","type","created_at","custom"],"title":"AsyncExportModerationLogsEvent","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"},"AsyncExportUsersEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"003.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.007"},"finished_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.004"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"task_id":{"type":"string","x-stream-index":"002.001"},"type":{"default":"export.users.success","type":"string","x-stream-index":"003.002"},"url":{"type":"string","x-stream-index":"001"}},"required":["url","task_id","started_at","finished_at","type","created_at","custom"],"title":"AsyncExportUsersEvent","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"},"AsyncModerationCallbackConfig":{"properties":{"mode":{"enum":["CALLBACK_MODE_NONE","CALLBACK_MODE_REST","CALLBACK_MODE_TWIRP"],"type":"string","x-stream-index":"002"},"server_url":{"type":"string","x-stream-index":"001"}},"type":"object"},"AsyncModerationConfiguration":{"properties":{"callback":{"$ref":"#/components/schemas/AsyncModerationCallbackConfig","x-stream-index":"002"},"timeout_ms":{"format":"int32","type":"integer","x-stream-index":"001"}},"type":"object"},"Attachment":{"description":"An attachment is a message object that represents a file uploaded by a user.","nullable":true,"properties":{"actions":{"items":{"$ref":"#/components/schemas/Action"},"type":"array","x-stream-index":"015"},"asset_url":{"type":"string","x-stream-index":"017"},"author_icon":{"type":"string","x-stream-index":"007"},"author_link":{"type":"string","x-stream-index":"006"},"author_name":{"type":"string","x-stream-index":"005"},"color":{"type":"string","x-stream-index":"003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"018"},"fallback":{"type":"string","x-stream-index":"002"},"fields":{"items":{"$ref":"#/components/schemas/Field"},"type":"array","x-stream-index":"016"},"footer":{"type":"string","x-stream-index":"013"},"footer_icon":{"type":"string","x-stream-index":"014"},"giphy":{"$ref":"#/components/schemas/Images","x-stream-index":"019"},"image_url":{"type":"string","x-stream-index":"011"},"og_scrape_url":{"type":"string","x-stream-index":"020"},"original_height":{"format":"int32","type":"integer","x-stream-index":"022"},"original_width":{"format":"int32","type":"integer","x-stream-index":"021"},"pretext":{"type":"string","x-stream-index":"004"},"text":{"type":"string","x-stream-index":"010"},"thumb_url":{"type":"string","x-stream-index":"012"},"title":{"type":"string","x-stream-index":"008"},"title_link":{"type":"string","x-stream-index":"009"},"type":{"description":"Attachment type (e.g. image, video, url)","title":"Type","type":"string","x-stream-index":"001"}},"required":["custom"],"title":"Attachment","type":"object","x-stream-docs-page-id":"file_uploads"},"AudioSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"001"},"default_device":{"enum":["speaker","earpiece"],"type":"string","x-stream-index":"006"},"mic_default_on":{"type":"boolean","x-stream-index":"004"},"noise_cancellation":{"$ref":"#/components/schemas/NoiseCancellationSettings","x-stream-index":"007"},"opus_dtx_enabled":{"type":"boolean","x-stream-index":"002"},"redundant_coding_enabled":{"type":"boolean","x-stream-index":"003"},"speaker_default_on":{"type":"boolean","x-stream-index":"005"}},"required":["access_request_enabled","opus_dtx_enabled","redundant_coding_enabled","mic_default_on","speaker_default_on","default_device"],"type":"object"},"AudioSettingsRequest":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"001"},"default_device":{"enum":["speaker","earpiece"],"type":"string","x-stream-index":"006"},"mic_default_on":{"type":"boolean","x-stream-index":"004"},"noise_cancellation":{"$ref":"#/components/schemas/NoiseCancellationSettings","x-stream-index":"007"},"opus_dtx_enabled":{"type":"boolean","x-stream-index":"002"},"redundant_coding_enabled":{"type":"boolean","x-stream-index":"003"},"speaker_default_on":{"type":"boolean","x-stream-index":"005"}},"required":["default_device"],"type":"object"},"AudioSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"001"},"default_device":{"enum":["speaker","earpiece"],"type":"string","x-stream-index":"006"},"mic_default_on":{"type":"boolean","x-stream-index":"004"},"noise_cancellation":{"$ref":"#/components/schemas/NoiseCancellationSettings","x-stream-index":"007"},"opus_dtx_enabled":{"type":"boolean","x-stream-index":"002"},"redundant_coding_enabled":{"type":"boolean","x-stream-index":"003"},"speaker_default_on":{"type":"boolean","x-stream-index":"005"}},"required":["access_request_enabled","opus_dtx_enabled","redundant_coding_enabled","mic_default_on","speaker_default_on","default_device"],"type":"object"},"AutomodDetails":{"properties":{"action":{"type":"string","x-stream-index":"001"},"image_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"005"},"message_details":{"$ref":"#/components/schemas/FlagMessageDetails","x-stream-index":"004"},"original_message_type":{"type":"string","x-stream-index":"002"},"result":{"$ref":"#/components/schemas/MessageModerationResult","x-stream-index":"003"}},"type":"object"},"AutomodPlatformCircumventionConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AutomodRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"AutomodRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"003"},"label":{"type":"string","x-stream-index":"001"},"threshold":{"format":"float","maximum":1,"minimum":0,"type":"number","x-stream-index":"002"}},"required":["label","threshold","action"],"type":"object"},"AutomodSemanticFiltersConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AutomodSemanticFiltersRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"AutomodSemanticFiltersRule":{"properties":{"action":{"enum":["flag","shadow","remove"],"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"threshold":{"format":"float","maximum":1,"minimum":0,"type":"number","x-stream-index":"002"}},"required":["name","threshold","action"],"type":"object"},"AutomodToxicityConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AutomodRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"AzureRequest":{"description":"Config for creating Azure Blob Storage storage","properties":{"abs_account_name":{"description":"The account name","title":"AccountName","type":"string","x-stream-index":"001"},"abs_client_id":{"description":"The client id","title":"ClientID","type":"string","x-stream-index":"003"},"abs_client_secret":{"description":"The client secret","title":"ClientSecret","type":"string","x-stream-index":"004"},"abs_tenant_id":{"description":"The tenant id","title":"TenantID","type":"string","x-stream-index":"002"}},"required":["abs_account_name","abs_tenant_id","abs_client_id","abs_client_secret"],"title":"AzureRequest","type":"object"},"BackstageSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"BackstageSettingsRequest":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"002"}},"type":"object"},"BackstageSettingsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"Ban":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"012"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"011"},"expires":{"format":"date-time","type":"number","x-stream-index":"007"},"reason":{"type":"string","x-stream-index":"008"},"shadow":{"type":"boolean","x-stream-index":"009"},"target":{"$ref":"#/components/schemas/User","x-stream-index":"006"}},"required":["shadow","created_at"],"type":"object"},"BanActionRequest":{"properties":{"channel_ban_only":{"type":"boolean","x-stream-index":"003"},"delete_messages":{"enum":["soft","pruning","hard"],"type":"string","x-stream-index":"005"},"ip_ban":{"type":"boolean","x-stream-index":"004"},"reason":{"type":"string","x-stream-index":"002"},"shadow":{"type":"boolean","x-stream-index":"001"},"timeout":{"format":"int32","type":"integer","x-stream-index":"006"}},"type":"object"},"BanOptions":{"properties":{"duration":{"format":"int32","type":"integer","x-stream-index":"001"},"ip_ban":{"type":"boolean","x-stream-index":"004"},"reason":{"type":"string","x-stream-index":"002"},"shadow_ban":{"type":"boolean","x-stream-index":"003"}},"type":"object"},"BanRequest":{"nullable":true,"properties":{"banned_by":{"$ref":"#/components/schemas/UserRequest","description":"Details about the user performing the ban","title":"Banned By","x-stream-index":"008"},"banned_by_id":{"description":"ID of the user performing the ban","title":"Banned By ID","type":"string","x-stream-index":"007"},"channel_cid":{"description":"Channel where the ban applies","title":"Channel CID","type":"string","x-stream-index":"004"},"delete_messages":{"enum":["soft","pruning","hard"],"type":"string","x-stream-index":"009"},"ip_ban":{"description":"Whether to ban the user's IP address","title":"IP Ban","type":"boolean","x-stream-index":"006"},"reason":{"description":"Optional explanation for the ban","title":"Reason","type":"string","x-stream-index":"003"},"shadow":{"description":"Whether this is a shadow ban","title":"Shadow","type":"boolean","x-stream-index":"005"},"target_user_id":{"description":"ID of the user to ban","title":"Target User ID","type":"string","x-stream-index":"001"},"timeout":{"description":"Duration of the ban in minutes","minimum":0,"title":"Timeout","type":"integer","x-stream-index":"002"}},"required":["target_user_id"],"type":"object"},"BanResponse":{"nullable":true,"properties":{"banned_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"006"},"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"expires":{"format":"date-time","type":"number","x-stream-index":"003"},"reason":{"type":"string","x-stream-index":"004"},"shadow":{"type":"boolean","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"}},"required":["created_at"],"type":"object"},"BlockContentOptions":{"properties":{"reason":{"type":"string","x-stream-index":"001"}},"type":"object"},"BlockListConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/BlockListRule"},"maximum":10,"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"BlockListOptions":{"properties":{"behavior":{"description":"Blocklist behavior","enum":["flag","block","shadow_block"],"title":"Behavior","type":"string","x-stream-index":"002"},"blocklist":{"description":"Blocklist name","title":"Blocklist","type":"string","x-stream-index":"001"}},"required":["blocklist","behavior"],"type":"object"},"BlockListResponse":{"description":"Block list contains restricted words","properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001"},"id":{"type":"string","x-stream-index":"003"},"name":{"description":"Block list name","title":"Name","type":"string","x-stream-index":"004"},"team":{"type":"string","x-stream-index":"007"},"type":{"description":"Block list type.","title":"Type","type":"string","x-stream-index":"005"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"002"},"words":{"description":"List of words to block","items":{"type":"string"},"title":"Words","type":"array","x-stream-index":"006"}},"required":["name","type","words"],"title":"Block list","type":"object","x-stream-docs-page-id":"block_lists"},"BlockListRule":{"properties":{"action":{"enum":["flag","mask_flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"002"}},"required":["name","team","action"],"type":"object"},"BlockUserRequest":{"description":"BlockUserRequest is the payload for blocking a user.","nullable":true,"properties":{"user_id":{"description":"the user to block","title":"UserID","type":"string","x-stream-index":"003"}},"required":["user_id"],"title":"BlockUserRequest","type":"object"},"BlockUserResponse":{"description":"BlockUserResponse is the payload for blocking a user.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"BlockUserResponse","type":"object"},"BlockUsersRequest":{"nullable":true,"properties":{"blocked_user_id":{"description":"User id to block","title":"BlockedUserID","type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"required":["blocked_user_id"],"type":"object"},"BlockUsersResponse":{"nullable":true,"properties":{"blocked_by_user_id":{"description":"User id who blocked another user","title":"BlockedByUserID","type":"string","x-stream-index":"002"},"blocked_user_id":{"description":"User id who got blocked","title":"BlockedUserID","type":"string","x-stream-index":"003"},"created_at":{"description":"Timestamp when the user was blocked","format":"date-time","title":"CreatedAt","type":"number","x-stream-index":"004"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration","blocked_by_user_id","blocked_user_id","created_at"],"type":"object"},"BlockedUserEvent":{"description":"This event is sent to call participants to notify when a user is blocked on a call, clients can use this event to show a notification.\nIf the user is the current user, the client should leave the call screen as well","properties":{"blocked_by_user":{"$ref":"#/components/schemas/UserResponse","description":"The user that blocked the user, null if the user was blocked by server-side","title":"Blocked by","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.blocked_user","description":"The type of event: \"call.blocked_user\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user that was blocked","title":"User","x-stream-index":"003"}},"required":["type","created_at","call_cid","user"],"title":"BlockedUserEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"BlockedUserResponse":{"nullable":true,"properties":{"blocked_user":{"$ref":"#/components/schemas/UserResponse","description":"User who got blocked","title":"User","x-stream-index":"003"},"blocked_user_id":{"description":"ID of the user who got blocked","title":"UserID","type":"string","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who blocked another user","title":"User","x-stream-index":"001"},"user_id":{"description":"ID of the user who blocked another user","title":"UserID","type":"string","x-stream-index":"002"}},"required":["user","user_id","blocked_user","blocked_user_id","created_at"],"type":"object"},"BodyguardRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"},"severity_rules":{"items":{"$ref":"#/components/schemas/BodyguardSeverityRule"},"type":"array","x-stream-index":"003"}},"required":["label","action","severity_rules"],"type":"object"},"BodyguardSeverityRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"severity":{"enum":["low","medium","high","critical"],"type":"string","x-stream-index":"001"}},"required":["severity","action"],"type":"object"},"BookmarkAddedEvent":{"description":"Emitted when a user bookmarks an activity.","nullable":true,"properties":{"bookmark":{"$ref":"#/components/schemas/BookmarkResponse","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.bookmark.added","description":"The type of event: \"feeds.bookmark.added\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who added the bookmark","title":"User","x-stream-index":"003.001"}},"required":["bookmark","type","created_at","custom"],"title":"BookmarkAddedEvent","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"},"BookmarkDeletedEvent":{"description":"Emitted when a user deletes a bookmark from an activity.","nullable":true,"properties":{"bookmark":{"$ref":"#/components/schemas/BookmarkResponse","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.bookmark.deleted","description":"The type of event: \"feeds.bookmark.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who removed the bookmark","title":"User","x-stream-index":"003.001"}},"required":["bookmark","type","created_at","custom"],"title":"BookmarkDeletedEvent","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"},"BookmarkFolderDeletedEvent":{"description":"Emitted when a bookmark folder is deleted.","nullable":true,"properties":{"bookmark_folder":{"$ref":"#/components/schemas/BookmarkFolderResponse","description":"The bookmark folder that was deleted","title":"Bookmark Folder","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.bookmark_folder.deleted","description":"The type of event: \"feeds.bookmark_folder.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who deleted the bookmark folder","title":"User","x-stream-index":"003.001"}},"required":["bookmark_folder","type","created_at","custom"],"title":"BookmarkFolderDeletedEvent","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"},"BookmarkFolderResponse":{"properties":{"created_at":{"description":"When the folder was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"004"},"custom":{"additionalProperties":{},"description":"Custom data for the folder","title":"Custom Data","type":"object","x-stream-index":"003"},"id":{"description":"Unique identifier for the folder","title":"ID","type":"string","x-stream-index":"001"},"name":{"description":"Name of the folder","title":"Name","type":"string","x-stream-index":"002"},"updated_at":{"description":"When the folder was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"005"}},"required":["id","name","created_at","updated_at"],"title":"Bookmark Folder","type":"object"},"BookmarkFolderUpdatedEvent":{"description":"Emitted when a bookmark folder is updated.","nullable":true,"properties":{"bookmark_folder":{"$ref":"#/components/schemas/BookmarkFolderResponse","description":"The bookmark folder that was updated","title":"Bookmark Folder","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.bookmark_folder.updated","description":"The type of event: \"feeds.bookmark_folder.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who updated the bookmark folder","title":"User","x-stream-index":"003.001"}},"required":["bookmark_folder","type","created_at","custom"],"title":"BookmarkFolderUpdatedEvent","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"},"BookmarkResponse":{"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","description":"The bookmarked activity","title":"Activity","x-stream-index":"002"},"created_at":{"description":"When the bookmark was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"005"},"custom":{"additionalProperties":{},"description":"Custom data for the bookmark","title":"Custom Data","type":"object","x-stream-index":"004"},"folder":{"$ref":"#/components/schemas/BookmarkFolderResponse","description":"Folder containing this bookmark","title":"Folder","x-stream-index":"003"},"updated_at":{"description":"When the bookmark was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"006"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who created the bookmark","title":"User","x-stream-index":"001"}},"required":["user","activity","created_at","updated_at"],"title":"Bookmark","type":"object"},"BookmarkUpdatedEvent":{"description":"Emitted when a user updates a bookmark.","nullable":true,"properties":{"bookmark":{"$ref":"#/components/schemas/BookmarkResponse","description":"The updated bookmark","title":"Bookmark","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.bookmark.updated","description":"The type of event: \"feeds.bookmark.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who updated the bookmark","title":"User","x-stream-index":"003.001"}},"required":["bookmark","type","created_at","custom"],"title":"BookmarkUpdatedEvent","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"},"Bound":{"properties":{"inclusive":{"type":"boolean","x-stream-index":"002"},"value":{"format":"float","type":"number","x-stream-index":"001"}},"required":["value","inclusive"],"type":"object"},"BroadcastSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettings","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettings","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"BroadcastSettingsRequest":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettingsRequest","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettingsRequest","x-stream-index":"003"}},"type":"object"},"BroadcastSettingsResponse":{"description":"BroadcastSettingsResponse is the payload for broadcasting settings","properties":{"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettingsResponse","title":"HLS","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettingsResponse","title":"RTMP","x-stream-index":"003"}},"required":["enabled","hls","rtmp"],"title":"BroadcastSettingsResponse","type":"object"},"BrowserDataResponse":{"properties":{"name":{"type":"string","x-stream-index":"001"},"version":{"type":"string","x-stream-index":"002"}},"type":"object"},"BulkImageModerationRequest":{"nullable":true,"properties":{"csv_file":{"description":"URL to CSV file containing image URLs to moderate","title":"string","type":"string","x-stream-index":"001"}},"required":["csv_file"],"type":"object"},"BulkImageModerationResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"task_id":{"description":"ID of the task for processing the bulk image moderation","title":"string","type":"string","x-stream-index":"001"}},"required":["task_id","duration"],"type":"object"},"Call":{"properties":{"AppPK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"002"},"Backstage":{"type":"boolean","writeOnly":true,"x-stream-index":"023"},"BlockedUserIDs":{"items":{"type":"string"},"type":"array","writeOnly":true,"x-stream-index":"018"},"BlockedUsers":{"items":{"$ref":"#/components/schemas/User"},"type":"array","writeOnly":true,"x-stream-index":"019"},"CID":{"type":"string","writeOnly":true,"x-stream-index":"005"},"CallType":{"$ref":"#/components/schemas/CallType","x-stream-index":"020"},"ChannelCID":{"type":"string","writeOnly":true,"x-stream-index":"032"},"CreatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"013"},"CreatedBy":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"CreatedByUserID":{"type":"string","writeOnly":true,"x-stream-index":"007"},"CurrentSessionID":{"type":"string","writeOnly":true,"x-stream-index":"024"},"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"012"},"DeletedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"028"},"EgressUpdatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"027"},"Egresses":{"items":{"$ref":"#/components/schemas/CallEgress"},"type":"array","writeOnly":true,"x-stream-index":"015"},"EndedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"017"},"ID":{"type":"string","writeOnly":true,"x-stream-index":"004"},"JoinAheadTimeSeconds":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"031"},"LastHeartbeatAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"030"},"LastSessionID":{"type":"string","writeOnly":true,"x-stream-index":"025"},"MemberCount":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"010"},"MemberLookup":{"$ref":"#/components/schemas/MemberLookup","x-stream-index":"011"},"Members":{"items":{"$ref":"#/components/schemas/CallMember"},"type":"array","writeOnly":true,"x-stream-index":"009"},"Session":{"$ref":"#/components/schemas/CallSession","x-stream-index":"026"},"Settings":{"$ref":"#/components/schemas/CallSettings","x-stream-index":"022"},"SettingsOverrides":{"$ref":"#/components/schemas/CallSettings","x-stream-index":"021"},"StartsAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"016"},"Team":{"type":"string","writeOnly":true,"x-stream-index":"006"},"ThumbnailURL":{"type":"string","writeOnly":true,"x-stream-index":"029"},"Type":{"type":"string","writeOnly":true,"x-stream-index":"003"},"UpdatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"014"}},"required":["AppPK","Type","ID","CID","Team","CreatedByUserID","Members","Custom","CreatedAt","UpdatedAt","Egresses","BlockedUserIDs","BlockedUsers","Backstage","CurrentSessionID","LastSessionID","ThumbnailURL","ChannelCID"],"type":"object"},"CallAcceptedEvent":{"description":"This event is sent when a user accepts a notification to join a call.","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.accepted","description":"The type of event: \"call.accepted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who accepted the call","title":"User","x-stream-index":"004"}},"required":["type","created_at","call_cid","call","user"],"title":"CallAcceptedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallClosedCaption":{"description":"CallClosedCaption represents a closed caption of a call.","properties":{"end_time":{"format":"date-time","title":"The end time of the closed caption.","type":"number","x-stream-index":"003"},"speaker_id":{"title":"The speaker ID of the closed caption.","type":"string","x-stream-index":"004"},"start_time":{"format":"date-time","title":"The start time of the closed caption.","type":"number","x-stream-index":"002"},"text":{"title":"The text of the closed caption.","type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserResponse","title":"The full user for the closed caption.","x-stream-index":"005"}},"required":["text","start_time","end_time","speaker_id","user"],"title":"CallClosedCaption","type":"object"},"CallClosedCaptionsFailedEvent":{"description":"This event is sent when call closed captions has failed","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.closed_captions_failed","description":"The type of event: \"call.closed_captions_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallClosedCaptionsFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallClosedCaptionsStartedEvent":{"description":"This event is sent when call closed caption has started","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.closed_captions_started","description":"The type of event: \"call.closed_captions_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallClosedCaptionsStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallClosedCaptionsStoppedEvent":{"description":"This event is sent when call closed captions has stopped","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.closed_captions_stopped","description":"The type of event: \"call.transcription_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallClosedCaptionsStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallCreatedEvent":{"description":"This event is sent when a call is created. Clients receiving this event should check if the ringing\nfield is set to true and if so, show the call screen","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"the members added to this call","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"004"},"type":{"default":"call.created","description":"The type of event: \"call.created\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","members"],"title":"CallCreatedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallDeletedEvent":{"description":"This event is sent when a call is deleted. Clients receiving this event should leave the call screen","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.deleted","description":"The type of event: \"call.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call"],"title":"CallDeletedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallDurationReport":{"properties":{"histogram":{"items":{"$ref":"#/components/schemas/ReportByHistogramBucket"},"type":"array","x-stream-index":"001"}},"required":["histogram"],"type":"object"},"CallDurationReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateCallDurationReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"CallEgress":{"nullable":true,"properties":{"app_pk":{"format":"int32","type":"integer","x-stream-index":"002"},"call_id":{"type":"string","x-stream-index":"004"},"call_type":{"type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/EgressTaskConfig","x-stream-index":"007"},"egress_id":{"type":"string","x-stream-index":"005"},"egress_type":{"type":"string","x-stream-index":"006"},"instance_ip":{"type":"string","x-stream-index":"008"},"started_at":{"format":"date-time","type":"number","x-stream-index":"010"},"state":{"type":"string","x-stream-index":"009"},"stopped_at":{"format":"date-time","type":"number","x-stream-index":"011"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"012"}},"required":["app_pk","call_type","call_id","egress_id","egress_type","instance_ip","state","started_at","updated_at"],"type":"object"},"CallEndedEvent":{"description":"This event is sent when a call is mark as ended for all its participants. Clients receiving this event should leave the call screen","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"reason":{"description":"The reason why the call ended, if available","title":"CallEndedReason","type":"string","x-stream-index":"005"},"type":{"default":"call.ended","description":"The type of event: \"call.ended\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who ended the call, null if the call was ended by the server","title":"User","x-stream-index":"004"}},"required":["type","created_at","call_cid","call"],"title":"CallEndedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallFrameRecordingFailedEvent":{"description":"This event is sent when frame recording has failed","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.frame_recording_failed","description":"The type of event: \"call.frame_recording_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","egress_id"],"title":"CallFrameRecordingFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallFrameRecordingFrameReadyEvent":{"description":"This event is sent when a frame is captured from a call","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"captured_at":{"description":"The time the frame was captured","format":"date-time","title":"CapturedAt","type":"number","x-stream-index":"006"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"008"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"track_type":{"description":"The type of the track frame was captured from (TRACK_TYPE_VIDEO|TRACK_TYPE_SCREEN_SHARE)","title":"TrackType","type":"string","x-stream-index":"004"},"type":{"default":"call.frame_recording_ready","description":"The type of event: \"call.frame_recording_ready\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"url":{"description":"The URL of the frame","title":"URL","type":"string","x-stream-index":"005"},"users":{"additionalProperties":{"$ref":"#/components/schemas/UserResponse"},"description":"The users in the frame","title":"Users","type":"object","x-stream-index":"007"}},"required":["type","created_at","call_cid","session_id","track_type","url","captured_at","users","egress_id"],"title":"CallFrameRecordingFrameReadyEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallFrameRecordingStartedEvent":{"description":"This event is sent when frame recording has started","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.frame_recording_started","description":"The type of event: \"call.frame_recording_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","egress_id"],"title":"CallFrameRecordingStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallFrameRecordingStoppedEvent":{"description":"This event is sent when frame recording has stopped","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.frame_recording_stopped","description":"The type of event: \"call.frame_recording_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","egress_id"],"title":"CallFrameRecordingStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallHLSBroadcastingFailedEvent":{"description":"This event is sent when HLS broadcasting has failed","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.hls_broadcasting_failed","description":"The type of event: \"call.hls_broadcasting_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallHLSBroadcastingFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallHLSBroadcastingStartedEvent":{"description":"This event is sent when HLS broadcasting has started","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"hls_playlist_url":{"type":"string","x-stream-index":"004"},"type":{"default":"call.hls_broadcasting_started","description":"The type of event: \"call.hls_broadcasting_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","hls_playlist_url"],"title":"CallHLSBroadcastingStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallHLSBroadcastingStoppedEvent":{"description":"This event is sent when HLS broadcasting has stopped","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.hls_broadcasting_stopped","description":"The type of event: \"call.hls_broadcasting_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallHLSBroadcastingStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallIngressResponse":{"description":"CallIngressResponse is the payload for ingress settings","properties":{"rtmp":{"$ref":"#/components/schemas/RTMPIngress","title":"RTMP","x-stream-index":"001"}},"required":["rtmp"],"title":"CallIngressResponse","type":"object"},"CallLiveStartedEvent":{"description":"This event is sent when a call is started. Clients receiving this event should start the call.","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.live_started","description":"The type of event: \"call.live_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call"],"title":"CallLiveStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMember":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"010"},"role":{"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["user_id","role","custom","created_at","updated_at"],"type":"object"},"CallMemberAddedEvent":{"description":"This event is sent when one or more members are added to a call","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"the members added to this call","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"004"},"type":{"default":"call.member_added","description":"The type of event: \"call.member_added\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","members"],"title":"CallMemberAddedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMemberRemovedEvent":{"description":"This event is sent when one or more members are removed from a call","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"the list of member IDs removed from the call","items":{"type":"string"},"title":"Members","type":"array","x-stream-index":"004"},"type":{"default":"call.member_removed","description":"The type of event: \"call.member_removed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","members"],"title":"CallMemberRemovedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMemberUpdatedEvent":{"description":"This event is sent when one or more members are updated","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"The list of members that were updated","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"004"},"type":{"default":"call.member_updated","description":"The type of event: \"call.member_updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","members"],"title":"CallMemberUpdatedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMemberUpdatedPermissionEvent":{"description":"This event is sent when one or more members get its role updated","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"capabilities_by_role":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"The capabilities by role for this call","title":"CapabilitiesByRole","type":"object","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"The list of members that were updated","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"005"},"type":{"default":"call.member_updated_permission","description":"The type of event: \"call.member_added\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","capabilities_by_role","members"],"title":"CallMemberUpdatedPermissionEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMissedEvent":{"description":"This event is sent to call members who did not accept/reject/join the call to notify they missed the call","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"List of members who missed the call","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"005"},"notify_user":{"type":"boolean","x-stream-index":"007"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.missed","description":"The type of event: \"call.notification\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The caller from whom the call was missed","title":"User","x-stream-index":"006"}},"required":["type","created_at","call_cid","session_id","call","members","user","notify_user"],"title":"CallMissedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallModerationBlurEvent":{"properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"type":{"default":"call.moderation_blur","type":"string","x-stream-index":"001.001"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["type","created_at","call_cid","user_id","custom"],"title":"CallModerationBlurEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallModerationWarningEvent":{"properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"message":{"type":"string","x-stream-index":"004"},"type":{"default":"call.moderation_warning","type":"string","x-stream-index":"001.001"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["type","created_at","call_cid","user_id","message","custom"],"title":"CallModerationWarningEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallNotificationEvent":{"description":"This event is sent to all call members to notify they are getting called","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"Call members","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"005"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.notification","description":"The type of event: \"call.notification\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user that sent the call notification","title":"User","x-stream-index":"006"}},"required":["type","created_at","call_cid","session_id","call","members","user"],"title":"CallNotificationEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallParticipant":{"nullable":true,"properties":{"JoinedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"004"},"Role":{"type":"string","writeOnly":true,"x-stream-index":"002"},"UserSessionID":{"type":"string","writeOnly":true,"x-stream-index":"003"},"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"001.046"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"001.017"},"banned":{"type":"boolean","x-stream-index":"001.016"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.013"},"id":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"001.023"},"language":{"type":"string","x-stream-index":"001.035"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"001.022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"001.026"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.042"},"role":{"type":"string","x-stream-index":"001.004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.005"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.009"}},"required":["id","role","teams_role","custom","banned","online","Role","UserSessionID","JoinedAt"],"type":"object"},"CallParticipantCountReport":{"properties":{"histogram":{"items":{"$ref":"#/components/schemas/ReportByHistogramBucket"},"type":"array","x-stream-index":"001"}},"required":["histogram"],"type":"object"},"CallParticipantCountReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateCallParticipantCountReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"CallParticipantResponse":{"properties":{"joined_at":{"format":"date-time","type":"number","x-stream-index":"004"},"role":{"type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"},"user_session_id":{"type":"string","x-stream-index":"002"}},"required":["user","user_session_id","role","joined_at"],"type":"object"},"CallReactionEvent":{"description":"This event is sent when a reaction is sent in a call, clients should use this to show the reaction in the call screen","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"reaction":{"$ref":"#/components/schemas/ReactionResponse","description":"the reaction object sent by the user on the call","title":"reaction","x-stream-index":"003"},"type":{"default":"call.reaction_new","description":"The type of event: \"call.reaction_new\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","reaction"],"title":"CallReactionEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRecording":{"description":"CallRecording represents a recording of a call.","properties":{"end_time":{"format":"date-time","title":"The end time of the recording.","type":"number","x-stream-index":"004"},"filename":{"title":"The filename of the recording.","type":"string","x-stream-index":"001"},"session_id":{"title":"The session ID of the recording.","type":"string","x-stream-index":"005"},"start_time":{"format":"date-time","title":"The start time of the recording.","type":"number","x-stream-index":"003"},"url":{"title":"The URL of the recording.","type":"string","x-stream-index":"002"}},"required":["filename","url","start_time","end_time","session_id"],"title":"CallRecording","type":"object"},"CallRecordingFailedEvent":{"description":"This event is sent when call recording has failed","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"003"},"type":{"default":"call.recording_failed","description":"The type of event: \"call.recording_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","egress_id"],"title":"CallRecordingFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRecordingReadyEvent":{"description":"This event is sent when call recording is ready","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"call_recording":{"$ref":"#/components/schemas/CallRecording","description":"The call recording object","title":"CallRecording","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.recording_ready","description":"The type of event: \"call.recording_ready\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call_recording","egress_id"],"title":"CallRecordingReadyEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRecordingStartedEvent":{"description":"This event is sent when call recording has started","properties":{"call_cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"egress_id":{"type":"string","x-stream-index":"001"},"type":{"default":"call.recording_started","description":"The type of event: \"call.recording_started\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001"}},"required":["egress_id","type","created_at","call_cid"],"title":"CallRecordingStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRecordingStoppedEvent":{"description":"This event is sent when call recording has stopped","properties":{"call_cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"egress_id":{"type":"string","x-stream-index":"001"},"type":{"default":"call.recording_stopped","description":"The type of event: \"call.recording_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001"}},"required":["egress_id","type","created_at","call_cid"],"title":"CallRecordingStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRejectedEvent":{"description":"This event is sent when a user rejects a notification to join a call.","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"reason":{"description":"Provides information about why the call was rejected. You can provide any value, but the Stream API and SDKs use these default values: rejected, cancel, timeout and busy","title":"Reason","type":"string","x-stream-index":"005"},"type":{"default":"call.rejected","description":"The type of event: \"call.rejected\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who rejected the call","title":"User","x-stream-index":"004"}},"required":["type","created_at","call_cid","call","user"],"title":"CallRejectedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallReportResponse":{"properties":{"ended_at":{"format":"date-time","type":"number","x-stream-index":"003"},"score":{"format":"float","type":"number","x-stream-index":"001"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002"}},"required":["score"],"type":"object"},"CallRequest":{"description":"CallRequest is the payload for creating a call.","properties":{"channel_cid":{"type":"string","x-stream-index":"009"},"created_by":{"$ref":"#/components/schemas/UserRequest","title":"The user that create this call","x-stream-index":"002"},"created_by_id":{"title":"The id of the user that create this call","type":"string","x-stream-index":"003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"members":{"items":{"$ref":"#/components/schemas/MemberRequest"},"maximum":100,"type":"array","x-stream-index":"005"},"settings_override":{"$ref":"#/components/schemas/CallSettingsRequest","x-stream-index":"006"},"starts_at":{"format":"date-time","type":"number","x-stream-index":"007"},"team":{"type":"string","x-stream-index":"001"},"video":{"type":"boolean","x-stream-index":"008"}},"title":"CallRequest","type":"object"},"CallResponse":{"description":"Represents a call","properties":{"backstage":{"type":"boolean","x-stream-index":"016"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"018"},"captioning":{"type":"boolean","x-stream-index":"013"},"channel_cid":{"type":"string","x-stream-index":"024"},"cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"The user that created the call","title":"Created By","x-stream-index":"007"},"current_session_id":{"type":"string","x-stream-index":"005"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"008"},"egress":{"$ref":"#/components/schemas/EgressResponse","x-stream-index":"021"},"ended_at":{"description":"Date/time when the call ended","format":"date-time","title":"Ended At","type":"number","x-stream-index":"014"},"id":{"description":"Call ID","title":"ID","type":"string","x-stream-index":"003"},"ingress":{"$ref":"#/components/schemas/CallIngressResponse","x-stream-index":"019"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"023"},"recording":{"type":"boolean","x-stream-index":"011"},"session":{"$ref":"#/components/schemas/CallSessionResponse","x-stream-index":"020"},"settings":{"$ref":"#/components/schemas/CallSettingsResponse","x-stream-index":"017"},"starts_at":{"description":"Date/time when the call will start","format":"date-time","title":"Starts At","type":"number","x-stream-index":"015"},"team":{"type":"string","x-stream-index":"006"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailResponse","x-stream-index":"022"},"transcribing":{"type":"boolean","x-stream-index":"012"},"type":{"description":"The type of call","title":"Type","type":"string","x-stream-index":"002"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"}},"required":["type","id","cid","current_session_id","created_by","custom","created_at","updated_at","recording","transcribing","captioning","backstage","settings","blocked_user_ids","ingress","egress"],"title":"CallResponse","type":"object"},"CallRingEvent":{"description":"This event is sent to all call members to notify they are getting called","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"005"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"Call members","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"006"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.ring","description":"The type of event: \"call.notification\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user that sent the call notification","title":"User","x-stream-index":"007"},"video":{"type":"boolean","x-stream-index":"008"}},"required":["type","created_at","call_cid","session_id","call","members","user","video"],"title":"CallRingEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRtmpBroadcastFailedEvent":{"description":"This event is sent when a call RTMP broadcast has failed","properties":{"call_cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"002.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.002"},"name":{"description":"Name of the given RTMP broadcast","title":"Name","type":"string","x-stream-index":"003"},"type":{"default":"call.rtmp_broadcast_failed","description":"The type of event: \"call.rtmp_broadcast_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","name"],"title":"CallRtmpBroadcastFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRtmpBroadcastStartedEvent":{"description":"This event is sent when RTMP broadcast has started","properties":{"call_cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"002.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.002"},"name":{"description":"Name of the given RTMP broadcast","title":"Name","type":"string","x-stream-index":"003"},"type":{"default":"call.rtmp_broadcast_started","description":"The type of event: \"call.rtmp_broadcast_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","name"],"title":"CallRtmpBroadcastStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRtmpBroadcastStoppedEvent":{"description":"This event is sent when RTMP broadcast has stopped","properties":{"call_cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"002.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.002"},"name":{"description":"Name of the given RTMP broadcast","title":"Name","type":"string","x-stream-index":"003"},"type":{"default":"call.rtmp_broadcast_stopped","description":"The type of event: \"call.rtmp_broadcast_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","name"],"title":"CallRtmpBroadcastStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSession":{"properties":{"AcceptedBy":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","writeOnly":true,"x-stream-index":"008"},"ActiveSFUs":{"items":{"$ref":"#/components/schemas/SFUIDLastSeen"},"type":"array","writeOnly":true,"x-stream-index":"016"},"AnonymousParticipantCount":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"019"},"AppPK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"002.001"},"CallID":{"type":"string","writeOnly":true,"x-stream-index":"002.003"},"CallType":{"type":"string","writeOnly":true,"x-stream-index":"002.002"},"CreatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"003"},"DeletedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"004"},"EndedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"006"},"LiveEndedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"013"},"LiveStartedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"012"},"MissedBy":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","writeOnly":true,"x-stream-index":"010"},"Participants":{"items":{"$ref":"#/components/schemas/CallParticipant"},"type":"array","writeOnly":true,"x-stream-index":"011"},"ParticipantsCountByRole":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","writeOnly":true,"x-stream-index":"018"},"RejectedBy":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","writeOnly":true,"x-stream-index":"009"},"RingAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"007"},"SFUIDs":{"items":{"type":"string"},"type":"array","writeOnly":true,"x-stream-index":"015"},"SessionID":{"type":"string","writeOnly":true,"x-stream-index":"002.004"},"StartedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"005"},"TimerEndsAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"014"},"UserPermissionOverrides":{"additionalProperties":{"additionalProperties":{"type":"boolean"},"type":"object"},"type":"object","writeOnly":true,"x-stream-index":"017"}},"required":["AppPK","CallType","CallID","SessionID","CreatedAt","AcceptedBy","RejectedBy","MissedBy","Participants","SFUIDs","ActiveSFUs","UserPermissionOverrides","ParticipantsCountByRole","AnonymousParticipantCount"],"type":"object"},"CallSessionEndedEvent":{"description":"This event is sent when a call session ends","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_ended","description":"The type of event: \"call.session_ended\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","call"],"title":"CallSessionEndedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSessionParticipantCountsUpdatedEvent":{"description":"This event is sent when the participant counts in a call session are updated","properties":{"anonymous_participant_count":{"format":"int32","type":"integer","x-stream-index":"005"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"participants_count_by_role":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"004"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_participant_count_updated","description":"The type of event: \"call.session_participant_count_updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","participants_count_by_role","anonymous_participant_count"],"title":"CallSessionParticipantCountsUpdatedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSessionParticipantJoinedEvent":{"description":"This event is sent when a participant joins a call session","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"participant":{"$ref":"#/components/schemas/CallParticipantResponse","description":"The participant that joined the session","title":"Participant","x-stream-index":"004"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_participant_joined","description":"The type of event: \"call.session_participant_joined\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","participant"],"title":"CallSessionParticipantJoinedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSessionParticipantLeftEvent":{"description":"This event is sent when a participant leaves a call session","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"duration_seconds":{"description":"The duration participant was in the session in seconds","format":"int32","title":"Duration","type":"integer","x-stream-index":"005"},"participant":{"$ref":"#/components/schemas/CallParticipantResponse","description":"The participant that left the session","title":"Participant","x-stream-index":"004"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_participant_left","description":"The type of event: \"call.session_participant_left\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","participant","duration_seconds"],"title":"CallSessionParticipantLeftEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSessionResponse":{"properties":{"accepted_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"008"},"anonymous_participant_count":{"format":"int32","type":"integer","x-stream-index":"006"},"ended_at":{"format":"date-time","type":"number","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"live_ended_at":{"format":"date-time","type":"number","x-stream-index":"011"},"live_started_at":{"format":"date-time","type":"number","x-stream-index":"010"},"missed_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"009"},"participants":{"items":{"$ref":"#/components/schemas/CallParticipantResponse"},"type":"array","x-stream-index":"004"},"participants_count_by_role":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"005"},"rejected_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"007"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002"},"timer_ends_at":{"format":"date-time","type":"number","x-stream-index":"012"}},"required":["id","participants","participants_count_by_role","anonymous_participant_count","rejected_by","accepted_by","missed_by"],"type":"object"},"CallSessionStartedEvent":{"description":"This event is sent when a call session starts","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_started","description":"The type of event: \"call.session_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","call"],"title":"CallSessionStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSettings":{"properties":{"audio":{"$ref":"#/components/schemas/AudioSettings","x-stream-index":"001"},"backstage":{"$ref":"#/components/schemas/BackstageSettings","x-stream-index":"002"},"broadcasting":{"$ref":"#/components/schemas/BroadcastSettings","x-stream-index":"007"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordSettings","x-stream-index":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettings","x-stream-index":"008"},"ingress":{"$ref":"#/components/schemas/IngressSettings","x-stream-index":"014"},"limits":{"$ref":"#/components/schemas/LimitsSettings","x-stream-index":"012"},"recording":{"$ref":"#/components/schemas/RecordSettings","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettings","x-stream-index":"010"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettings","x-stream-index":"004"},"session":{"$ref":"#/components/schemas/SessionSettings","x-stream-index":"013"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettings","x-stream-index":"011"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettings","x-stream-index":"009"},"video":{"$ref":"#/components/schemas/VideoSettings","x-stream-index":"003"}},"type":"object"},"CallSettingsRequest":{"properties":{"audio":{"$ref":"#/components/schemas/AudioSettingsRequest","x-stream-index":"001"},"backstage":{"$ref":"#/components/schemas/BackstageSettingsRequest","x-stream-index":"002"},"broadcasting":{"$ref":"#/components/schemas/BroadcastSettingsRequest","x-stream-index":"010"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordingSettingsRequest","x-stream-index":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettingsRequest","x-stream-index":"003"},"ingress":{"$ref":"#/components/schemas/IngressSettingsRequest","x-stream-index":"014"},"limits":{"$ref":"#/components/schemas/LimitsSettingsRequest","x-stream-index":"012"},"recording":{"$ref":"#/components/schemas/RecordSettingsRequest","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettingsRequest","x-stream-index":"007"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettingsRequest","x-stream-index":"008"},"session":{"$ref":"#/components/schemas/SessionSettingsRequest","x-stream-index":"013"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettingsRequest","x-stream-index":"011"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettingsRequest","x-stream-index":"009"},"video":{"$ref":"#/components/schemas/VideoSettingsRequest","x-stream-index":"004"}},"type":"object"},"CallSettingsResponse":{"properties":{"audio":{"$ref":"#/components/schemas/AudioSettingsResponse","x-stream-index":"001"},"backstage":{"$ref":"#/components/schemas/BackstageSettingsResponse","x-stream-index":"002"},"broadcasting":{"$ref":"#/components/schemas/BroadcastSettingsResponse","x-stream-index":"003"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordingSettingsResponse","x-stream-index":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettingsResponse","x-stream-index":"004"},"ingress":{"$ref":"#/components/schemas/IngressSettingsResponse","x-stream-index":"014"},"limits":{"$ref":"#/components/schemas/LimitsSettingsResponse","x-stream-index":"012"},"recording":{"$ref":"#/components/schemas/RecordSettingsResponse","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettingsResponse","x-stream-index":"007"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettingsResponse","x-stream-index":"008"},"session":{"$ref":"#/components/schemas/SessionSettingsResponse","x-stream-index":"013"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettingsResponse","x-stream-index":"011"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettingsResponse","x-stream-index":"009"},"video":{"$ref":"#/components/schemas/VideoSettingsResponse","x-stream-index":"010"}},"required":["audio","backstage","broadcasting","geofencing","recording","frame_recording","ring","screensharing","transcription","video","thumbnails","limits","session"],"type":"object"},"CallStateResponseFields":{"description":"CallStateResponseFields is the payload for call state response","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001"},"members":{"description":"List of call members","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"002"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"004"}},"required":["call","members","own_capabilities","blocked_users"],"title":"CallStateResponseFields","type":"object"},"CallStatsReportReadyEvent":{"description":"This event is sent when the insights report is ready","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.stats_report_ready","description":"The type of event, \"call.report_ready\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id"],"title":"CallStatsReportReadyEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallStatsReportSummaryResponse":{"properties":{"call_cid":{"type":"string","x-stream-index":"001"},"call_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"008"},"call_session_id":{"type":"string","x-stream-index":"002"},"call_status":{"type":"string","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"first_stats_time":{"format":"date-time","type":"number","x-stream-index":"003"},"min_user_rating":{"format":"int32","type":"integer","x-stream-index":"006"},"quality_score":{"format":"int32","type":"integer","x-stream-index":"005"}},"required":["call_cid","call_session_id","first_stats_time","call_status","call_duration_seconds"],"type":"object"},"CallTranscription":{"description":"CallTranscription represents a transcription of a call.","properties":{"end_time":{"format":"date-time","title":"The end time of the transcription.","type":"number","x-stream-index":"004"},"filename":{"title":"The filename of the transcription.","type":"string","x-stream-index":"001"},"session_id":{"title":"The session ID of the transcription.","type":"string","x-stream-index":"005"},"start_time":{"format":"date-time","title":"The start time of the transcription.","type":"number","x-stream-index":"003"},"url":{"title":"The URL of the transcription.","type":"string","x-stream-index":"002"}},"required":["filename","url","start_time","end_time","session_id"],"title":"CallTranscription","type":"object"},"CallTranscriptionFailedEvent":{"description":"This event is sent when call transcription has failed","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"003"},"error":{"description":"The error message detailing why transcription failed.","title":"string","type":"string","x-stream-index":"004"},"type":{"default":"call.transcription_failed","description":"The type of event: \"call.transcription_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","egress_id"],"title":"CallTranscriptionFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallTranscriptionReadyEvent":{"description":"This event is sent when call transcription is ready","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"call_transcription":{"$ref":"#/components/schemas/CallTranscription","description":"The call transcription object","title":"CallTranscription","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.transcription_ready","description":"The type of event: \"call.transcription_ready\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call_transcription","egress_id"],"title":"CallTranscriptionReadyEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallTranscriptionStartedEvent":{"description":"This event is sent when call transcription has started","properties":{"call_cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"egress_id":{"type":"string","x-stream-index":"001"},"type":{"default":"call.transcription_started","description":"The type of event: \"call.transcription_started\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001"}},"required":["egress_id","type","created_at","call_cid"],"title":"CallTranscriptionStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallTranscriptionStoppedEvent":{"description":"This event is sent when call transcription has stopped","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"003"},"type":{"default":"call.transcription_stopped","description":"The type of event: \"call.transcription_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","egress_id"],"title":"CallTranscriptionStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallType":{"nullable":true,"properties":{"AppPK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"003"},"CreatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"005"},"ExternalStorage":{"type":"string","writeOnly":true,"x-stream-index":"009"},"Name":{"type":"string","writeOnly":true,"x-stream-index":"004"},"NotificationSettings":{"$ref":"#/components/schemas/NotificationSettings","x-stream-index":"008"},"PK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"002"},"Settings":{"$ref":"#/components/schemas/CallSettings","x-stream-index":"007"},"UpdatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"006"}},"required":["PK","AppPK","Name","CreatedAt","UpdatedAt","ExternalStorage"],"type":"object"},"CallTypeResponse":{"description":"CallTypeResponse is the payload for a call type.","properties":{"created_at":{"description":"the time the call type was created","format":"date-time","title":"CreatedAt","type":"number","x-stream-index":"005"},"external_storage":{"description":"the external storage for the call type","title":"ExternalStorage","type":"string","x-stream-index":"007"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"the permissions granted to each role","title":"Grants","type":"object","x-stream-index":"002"},"name":{"description":"the name of the call type","title":"Name","type":"string","x-stream-index":"001"},"notification_settings":{"$ref":"#/components/schemas/NotificationSettings","description":"the notification settings for the call type","title":"NotificationSettings","x-stream-index":"004"},"settings":{"$ref":"#/components/schemas/CallSettingsResponse","description":"the settings for the call type","title":"Settings","x-stream-index":"003"},"updated_at":{"description":"the time the call type was last updated","format":"date-time","title":"UpdatedAt","type":"number","x-stream-index":"006"}},"required":["name","grants","settings","notification_settings","created_at","updated_at"],"title":"CallTypeResponse","type":"object"},"CallUpdatedEvent":{"description":"This event is sent when a call is updated, clients should use this update the local state of the call.\nThis event also contains the capabilities by role for the call, clients should update the own_capability for the current.","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"capabilities_by_role":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"The capabilities by role for this call","title":"CapabilitiesByRole","type":"object","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.updated","description":"The type of event: \"call.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","capabilities_by_role"],"title":"CallUpdatedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallUserFeedbackSubmittedEvent":{"description":"This event is sent when a user submits feedback for a call.","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"custom":{"additionalProperties":{},"description":"Custom data provided by the user","title":"Custom","type":"object","x-stream-index":"007"},"rating":{"description":"The rating given by the user (1-5)","format":"int32","title":"Rating","type":"integer","x-stream-index":"005"},"reason":{"description":"The reason provided by the user for the rating","title":"Reason","type":"string","x-stream-index":"006"},"sdk":{"type":"string","x-stream-index":"008"},"sdk_version":{"type":"string","x-stream-index":"009"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.user_feedback_submitted","description":"The type of event, \"call.user_feedback\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who submitted the feedback","title":"User","x-stream-index":"004"}},"required":["type","created_at","call_cid","session_id","user","rating"],"title":"CallUserFeedbackSubmittedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallUserMutedEvent":{"description":"This event is sent when a call member is muted","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"from_user_id":{"type":"string","x-stream-index":"003"},"muted_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"type":{"default":"call.user_muted","description":"The type of event: \"call.user_muted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","from_user_id","muted_user_ids"],"title":"CallUserMutedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallsPerDayReport":{"properties":{"count":{"format":"int64","type":"integer","x-stream-index":"001"}},"required":["count"],"type":"object"},"CallsPerDayReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateCallsPerDayReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"CampaignChannelTemplate":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"002"},"members":{"items":{"type":"string"},"maximum":1000,"type":"array","x-stream-index":"003"},"team":{"maxLength":1000,"type":"string","x-stream-index":"004"},"type":{"maxLength":64,"type":"string","x-stream-index":"001"}},"required":["type","custom"],"type":"object"},"CampaignCompletedEvent":{"nullable":true,"properties":{"campaign":{"$ref":"#/components/schemas/CampaignResponse","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"type":{"default":"campaign.completed","type":"string","x-stream-index":"001.002"}},"required":["type","created_at","custom"],"title":"CampaignCompletedEvent","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"},"CampaignMessageTemplate":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"maximum":30,"type":"array","x-stream-index":"002"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"poll_id":{"type":"string","x-stream-index":"003"},"text":{"type":"string","x-stream-index":"001"}},"required":["text","attachments","poll_id","custom"],"type":"object"},"CampaignResponse":{"properties":{"channel_template":{"$ref":"#/components/schemas/CampaignChannelTemplate","x-stream-index":"016"},"create_channels":{"type":"boolean","x-stream-index":"008"},"created_at":{"format":"date-time","type":"number","x-stream-index":"020"},"description":{"type":"string","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"001"},"message_template":{"$ref":"#/components/schemas/CampaignMessageTemplate","x-stream-index":"015"},"name":{"type":"string","x-stream-index":"007"},"scheduled_for":{"format":"date-time","type":"number","x-stream-index":"013"},"segment_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"002"},"segments":{"items":{"$ref":"#/components/schemas/Segment"},"type":"array","x-stream-index":"003"},"sender":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"005"},"sender_id":{"type":"string","x-stream-index":"004"},"sender_mode":{"type":"string","x-stream-index":"006"},"show_channels":{"type":"boolean","x-stream-index":"009"},"skip_push":{"type":"boolean","x-stream-index":"011"},"skip_webhook":{"type":"boolean","x-stream-index":"012"},"stats":{"$ref":"#/components/schemas/CampaignStatsResponse","x-stream-index":"022"},"status":{"type":"string","x-stream-index":"019"},"stop_at":{"format":"date-time","type":"number","x-stream-index":"014"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"021"},"user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"017"},"users":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"018"}},"required":["id","segment_ids","segments","sender_id","sender_mode","name","create_channels","show_channels","description","skip_push","skip_webhook","user_ids","users","status","created_at","updated_at","stats"],"type":"object"},"CampaignStartedEvent":{"nullable":true,"properties":{"campaign":{"$ref":"#/components/schemas/CampaignResponse","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"type":{"default":"campaign.started","type":"string","x-stream-index":"001.002"}},"required":["type","created_at","custom"],"title":"CampaignStartedEvent","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"},"CampaignStatsResponse":{"properties":{"progress":{"format":"float","type":"number","x-stream-index":"005"},"stats_channels_created":{"format":"int32","type":"integer","x-stream-index":"004"},"stats_completed_at":{"format":"date-time","type":"number","x-stream-index":"002"},"stats_messages_sent":{"format":"int32","type":"integer","x-stream-index":"003"},"stats_started_at":{"format":"date-time","type":"number","x-stream-index":"001"},"stats_users_read":{"format":"int32","type":"integer","x-stream-index":"007"},"stats_users_sent":{"format":"int32","type":"integer","x-stream-index":"006"}},"required":["stats_started_at","stats_completed_at","stats_messages_sent","stats_channels_created","progress","stats_users_sent","stats_users_read"],"type":"object"},"CastPollVoteRequest":{"nullable":true,"properties":{"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"005.002"},"user_id":{"type":"string","x-stream-index":"005.001"},"vote":{"$ref":"#/components/schemas/VoteData","description":"Vote data","title":"VoteData","x-stream-index":"004"}},"type":"object"},"Channel":{"properties":{"active_live_locations":{"items":{"$ref":"#/components/schemas/SharedLocation"},"type":"array","x-stream-index":"034"},"auto_translation_enabled":{"type":"boolean","x-stream-index":"029"},"auto_translation_language":{"type":"string","x-stream-index":"030"},"cid":{"type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/ChannelConfig","x-stream-index":"026"},"config_overrides":{"$ref":"#/components/schemas/ConfigOverrides","x-stream-index":"027"},"cooldown":{"format":"int32","type":"integer","x-stream-index":"031"},"created_at":{"format":"date-time","type":"number","x-stream-index":"009"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"019"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"disabled":{"type":"boolean","x-stream-index":"017"},"frozen":{"type":"boolean","x-stream-index":"016"},"id":{"type":"string","x-stream-index":"004"},"invites":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"022"},"last_campaigns":{"type":"string","x-stream-index":"032"},"last_message_at":{"format":"date-time","type":"number","x-stream-index":"006"},"member_count":{"format":"int32","type":"integer","x-stream-index":"021"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"020"},"message_count":{"format":"int64","type":"integer","x-stream-index":"035"},"message_count_updated_at":{"format":"date-time","type":"number","x-stream-index":"036"},"team":{"type":"string","x-stream-index":"028"},"truncated_by":{"$ref":"#/components/schemas/User","x-stream-index":"015"},"type":{"type":"string","x-stream-index":"005"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"010"}},"required":["cid","id","type","created_at","updated_at","frozen","disabled","custom","auto_translation_language"],"type":"object"},"ChannelConfig":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.027"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.022"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.023"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.028"},"blocklist":{"type":"string","x-stream-index":"001.024"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.025"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.026"},"commands":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"connect_events":{"type":"boolean","x-stream-index":"001.004"},"count_messages":{"type":"boolean","x-stream-index":"001.019"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"custom_events":{"type":"boolean","x-stream-index":"001.012"},"mark_messages_pending":{"type":"boolean","x-stream-index":"001.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"001.021"},"mutes":{"type":"boolean","x-stream-index":"001.009"},"name":{"type":"string","x-stream-index":"001.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"001.029"},"partition_ttl":{"type":"integer","x-stream-index":"001.030"},"polls":{"type":"boolean","x-stream-index":"001.016"},"push_notifications":{"type":"boolean","x-stream-index":"001.013"},"quotes":{"type":"boolean","x-stream-index":"001.008"},"reactions":{"type":"boolean","x-stream-index":"001.006"},"read_events":{"type":"boolean","x-stream-index":"001.003"},"reminders":{"type":"boolean","x-stream-index":"001.014"},"replies":{"type":"boolean","x-stream-index":"001.007"},"search":{"type":"boolean","x-stream-index":"001.005"},"shared_locations":{"type":"boolean","x-stream-index":"001.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.031"},"typing_events":{"type":"boolean","x-stream-index":"001.002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"002.004"},"uploads":{"type":"boolean","x-stream-index":"001.010"},"url_enrichment":{"type":"boolean","x-stream-index":"001.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"001.017"}},"required":["name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","count_messages","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","created_at","updated_at","commands"],"type":"object"},"ChannelConfigWithInfo":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.002.027"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.002.022"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.023"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.002.028"},"blocklist":{"type":"string","x-stream-index":"001.002.024"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.025"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.002.026"},"commands":{"items":{"$ref":"#/components/schemas/Command"},"type":"array","x-stream-index":"001.003"},"connect_events":{"type":"boolean","x-stream-index":"001.002.004"},"count_messages":{"type":"boolean","x-stream-index":"001.002.019"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.001.003"},"custom_events":{"type":"boolean","x-stream-index":"001.002.012"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"002"},"mark_messages_pending":{"type":"boolean","x-stream-index":"001.002.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"001.002.021"},"mutes":{"type":"boolean","x-stream-index":"001.002.009"},"name":{"type":"string","x-stream-index":"001.002.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"001.002.029"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"001.002.030"},"polls":{"type":"boolean","x-stream-index":"001.002.016"},"push_notifications":{"type":"boolean","x-stream-index":"001.002.013"},"quotes":{"type":"boolean","x-stream-index":"001.002.008"},"reactions":{"type":"boolean","x-stream-index":"001.002.006"},"read_events":{"type":"boolean","x-stream-index":"001.002.003"},"reminders":{"type":"boolean","x-stream-index":"001.002.014"},"replies":{"type":"boolean","x-stream-index":"001.002.007"},"search":{"type":"boolean","x-stream-index":"001.002.005"},"shared_locations":{"type":"boolean","x-stream-index":"001.002.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.002.031"},"typing_events":{"type":"boolean","x-stream-index":"001.002.002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"uploads":{"type":"boolean","x-stream-index":"001.002.010"},"url_enrichment":{"type":"boolean","x-stream-index":"001.002.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"001.002.017"}},"required":["created_at","updated_at","name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","count_messages","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","commands"],"type":"object"},"ChannelCreatedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"channel.created","type":"string","x-stream-index":"001.001"}},"required":["type","created_at"],"title":"ChannelCreatedEvent","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"},"ChannelDeletedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003.004"},"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"003.005"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"team":{"type":"string","x-stream-index":"001.001"},"type":{"default":"channel.deleted","type":"string","x-stream-index":"002.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"ChannelDeletedEvent","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"},"ChannelExport":{"properties":{"cid":{"type":"string","x-stream-index":"003"},"id":{"description":"Channel ID","title":"ID","type":"string","x-stream-index":"002"},"messages_since":{"description":"Date to export messages since","format":"date-time","title":"Messages since","type":"number","x-stream-index":"004"},"messages_until":{"description":"Date to export messages until","format":"date-time","title":"Messages until","type":"number","x-stream-index":"005"},"type":{"description":"Channel type","title":"Type","type":"string","x-stream-index":"001"}},"title":"Channel Export","type":"object"},"ChannelFrozenEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"channel.frozen","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"ChannelFrozenEvent","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"},"ChannelGetOrCreateRequest":{"nullable":true,"properties":{"data":{"$ref":"#/components/schemas/ChannelInput","x-stream-index":"003"},"hide_for_creator":{"description":"Whether this channel will be hidden for the user who created the channel or not","title":"Hide for creator","type":"boolean","x-stream-index":"007"},"members":{"$ref":"#/components/schemas/PaginationParams","x-stream-index":"010"},"messages":{"$ref":"#/components/schemas/MessagePaginationParams","x-stream-index":"009"},"state":{"description":"Refresh channel state","title":"State","type":"boolean","x-stream-index":"005"},"thread_unread_counts":{"type":"boolean","x-stream-index":"008"},"watchers":{"$ref":"#/components/schemas/PaginationParams","x-stream-index":"011"}},"type":"object"},"ChannelHiddenEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003.004"},"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"003.005"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"clear_history":{"type":"boolean","x-stream-index":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"type":{"default":"channel.hidden","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["clear_history","cid","channel_id","channel_type","channel_member_count","type","created_at"],"title":"ChannelHiddenEvent","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"},"ChannelInput":{"properties":{"auto_translation_enabled":{"description":"Enable or disable auto translation","title":"Auto translation","type":"boolean","x-stream-index":"005"},"auto_translation_language":{"description":"Switch auto translation language","title":"Auto translation language","type":"string","x-stream-index":"006"},"config_overrides":{"$ref":"#/components/schemas/ChannelConfig","x-stream-index":"024"},"created_by":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"009"},"created_by_id":{"type":"string","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"015"},"disabled":{"type":"boolean","x-stream-index":"014"},"frozen":{"description":"Freeze or unfreeze the channel","title":"Frozen","type":"boolean","x-stream-index":"013"},"invites":{"items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"type":"array","x-stream-index":"016"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"type":"array","x-stream-index":"018"},"team":{"description":"Team the channel belongs to (if multi-tenant mode is enabled)","title":"Team","type":"string","x-stream-index":"004"},"truncated_by_id":{"type":"string","x-stream-index":"010"}},"type":"object"},"ChannelMember":{"nullable":true,"properties":{"archived_at":{"format":"date-time","type":"number","x-stream-index":"015"},"ban_expires":{"description":"Expiration date of the ban","format":"date-time","title":"Ban expires","type":"number","x-stream-index":"013"},"banned":{"description":"Whether member is banned this channel or not","title":"Banned","type":"boolean","x-stream-index":"012"},"channel_role":{"description":"Role of the member in the channel","title":"Channel Role","type":"string","x-stream-index":"018"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"deleted_messages":{"items":{"type":"string"},"type":"array","x-stream-index":"020"},"invite_accepted_at":{"description":"Date when invite was accepted","format":"date-time","title":"Invited accepted at","type":"number","x-stream-index":"006"},"invite_rejected_at":{"description":"Date when invite was rejected","format":"date-time","title":"Invited rejected at","type":"number","x-stream-index":"007"},"invited":{"description":"Whether member was invited or not","title":"Invited","type":"boolean","x-stream-index":"005"},"is_moderator":{"description":"Whether member is channel moderator or not","title":"Is moderator","type":"boolean","x-stream-index":"003"},"notifications_muted":{"type":"boolean","x-stream-index":"019"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"016"},"role":{"description":"Permission level of the member in the channel (DEPRECATED: use channel_role instead)","enum":["member","moderator","admin","owner"],"title":"Role","type":"string","x-stream-index":"017"},"shadow_banned":{"description":"Whether member is shadow banned in this channel or not","title":"Shadow banned","type":"boolean","x-stream-index":"014"},"status":{"type":"string","x-stream-index":"008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"},"user_id":{"title":"User ID","type":"string","x-stream-index":"001"}},"required":["custom","created_at","updated_at","banned","shadow_banned","channel_role","notifications_muted"],"title":"Channel member","type":"object"},"ChannelMemberResponse":{"nullable":true,"properties":{"archived_at":{"format":"date-time","type":"number","x-stream-index":"016"},"ban_expires":{"description":"Expiration date of the ban","format":"date-time","title":"Ban expires","type":"number","x-stream-index":"013"},"banned":{"description":"Whether member is banned this channel or not","title":"Banned","type":"boolean","x-stream-index":"012"},"channel_role":{"description":"Role of the member in the channel","title":"Channel Role","type":"string","x-stream-index":"018"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"invite_accepted_at":{"description":"Date when invite was accepted","format":"date-time","title":"Invited accepted at","type":"number","x-stream-index":"006"},"invite_rejected_at":{"description":"Date when invite was rejected","format":"date-time","title":"Invited rejected at","type":"number","x-stream-index":"007"},"invited":{"description":"Whether member was invited or not","title":"Invited","type":"boolean","x-stream-index":"005"},"is_moderator":{"description":"Whether member is channel moderator or not","title":"Is moderator","type":"boolean","x-stream-index":"003"},"notifications_muted":{"type":"boolean","x-stream-index":"019"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"015"},"role":{"description":"Permission level of the member in the channel (DEPRECATED: use channel_role instead)","enum":["member","moderator","admin","owner"],"title":"Role","type":"string","x-stream-index":"017"},"shadow_banned":{"description":"Whether member is shadow banned in this channel or not","title":"Shadow banned","type":"boolean","x-stream-index":"014"},"status":{"type":"string","x-stream-index":"008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"},"user_id":{"title":"User ID","type":"string","x-stream-index":"001"}},"required":["custom","created_at","updated_at","banned","shadow_banned","channel_role","notifications_muted"],"title":"Channel member","type":"object"},"ChannelMessages":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001"},"messages":{"items":{"$ref":"#/components/schemas/Message"},"type":"array","x-stream-index":"002"}},"required":["messages"],"type":"object"},"ChannelMute":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel that is muted","title":"Channel","x-stream-index":"002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"004"},"expires":{"description":"Date/time of mute expiration","format":"date-time","title":"Expires","type":"number","x-stream-index":"003"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Owner of channel mute","title":"User","x-stream-index":"001"}},"required":["created_at","updated_at"],"type":"object"},"ChannelMutedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"channel.muted","type":"string","x-stream-index":"001.001"}},"required":["type","created_at"],"title":"ChannelMutedEvent","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"},"ChannelOwnCapability":{"description":"All possibility of string to use","enum":["ban-channel-members","cast-poll-vote","connect-events","create-attachment","delete-any-message","delete-channel","delete-own-message","flag-message","freeze-channel","join-channel","leave-channel","mute-channel","pin-message","query-poll-votes","quote-message","read-events","search-messages","send-custom-events","send-links","send-message","send-poll","send-reaction","send-reply","send-restricted-visibility-message","send-typing-events","set-channel-cooldown","share-location","skip-slow-mode","slow-mode","typing-events","update-any-message","update-channel","update-channel-members","update-own-message","update-thread","upload-file"],"title":"ChannelOwnCapability","type":"string"},"ChannelPushPreferences":{"properties":{"chat_level":{"type":"string","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"number","x-stream-index":"002"}},"type":"object"},"ChannelResponse":{"description":"Represents channel in chat","properties":{"auto_translation_enabled":{"description":"Whether auto translation is enabled or not","title":"Auto translation","type":"boolean","x-stream-index":"017"},"auto_translation_language":{"description":"Language to translate to when auto translation is active","title":"Auto translation language","type":"string","x-stream-index":"018"},"blocked":{"description":"Whether this channel is blocked by current user or not","title":"Blocked","type":"boolean","x-stream-index":"023"},"cid":{"description":"Channel CID (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/ChannelConfigWithInfo","description":"Channel configuration","title":"ChannelConfigWithInfo","x-stream-index":"013"},"cooldown":{"description":"Cooldown period after sending each message","format":"int32","title":"Cooldown","type":"integer","x-stream-index":"020"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"005"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"Creator of the channel","title":"UserResponse","x-stream-index":"008"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"026"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"007"},"disabled":{"type":"boolean","x-stream-index":"010"},"frozen":{"description":"Whether channel is frozen or not","title":"Frozen","type":"boolean","x-stream-index":"009"},"hidden":{"description":"Whether this channel is hidden by current user or not","title":"Hidden","type":"boolean","x-stream-index":"022"},"hide_messages_before":{"description":"Date since when the message history is accessible","format":"date-time","title":"Hide messages before","type":"number","x-stream-index":"019"},"id":{"description":"Channel unique ID","title":"ID","type":"string","x-stream-index":"001"},"last_message_at":{"description":"Date of the last message sent","format":"date-time","title":"Last message at","type":"number","x-stream-index":"004"},"member_count":{"description":"Number of members in the channel","format":"int32","title":"Member count","type":"integer","x-stream-index":"012"},"members":{"description":"List of channel members (max 100)","items":{"$ref":"#/components/schemas/ChannelMember"},"title":"ChannelMembers","type":"array","x-stream-index":"011"},"message_count":{"description":"Number of messages in the channel","format":"int64","title":"Message count","type":"integer","x-stream-index":"027"},"mute_expires_at":{"description":"Date of mute expiration","format":"date-time","title":"Mute expires at","type":"number","x-stream-index":"015"},"muted":{"description":"Whether this channel is muted or not","title":"Muted","type":"boolean","x-stream-index":"014"},"own_capabilities":{"description":"List of channel capabilities of authenticated user","items":{"$ref":"#/components/schemas/ChannelOwnCapability"},"title":"ChannelOwnCapability","type":"array","x-stream-index":"021"},"team":{"description":"Team the channel belongs to (multi-tenant only)","title":"Team","type":"string","x-stream-index":"016"},"truncated_at":{"description":"Date of the latest truncation of the channel","format":"date-time","title":"UserResponse","type":"number","x-stream-index":"024"},"truncated_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"025"},"type":{"description":"Type of the channel","title":"Type","type":"string","x-stream-docs-page-id":"channel_features","x-stream-index":"002"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"006"}},"required":["id","type","cid","created_at","updated_at","frozen","disabled","custom"],"title":"Channel","type":"object"},"ChannelStateResponse":{"nullable":true,"properties":{"active_live_locations":{"items":{"$ref":"#/components/schemas/SharedLocationResponseData"},"type":"array","x-stream-index":"001.015"},"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001.001"},"deleted_messages":{"items":{"type":"string"},"type":"array","x-stream-index":"001.016"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001.014"},"duration":{"type":"string","x-stream-index":"002.001"},"hidden":{"type":"boolean","x-stream-index":"001.011"},"hide_messages_before":{"format":"date-time","type":"number","x-stream-index":"001.012"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"001.007"},"membership":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"001.008"},"messages":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","x-stream-index":"001.002"},"pending_messages":{"items":{"$ref":"#/components/schemas/PendingMessageResponse"},"type":"array","x-stream-index":"001.013"},"pinned_messages":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","x-stream-index":"001.003"},"push_preferences":{"$ref":"#/components/schemas/ChannelPushPreferences","x-stream-index":"001.009"},"read":{"items":{"$ref":"#/components/schemas/ReadStateResponse"},"type":"array","x-stream-index":"001.006"},"threads":{"items":{"$ref":"#/components/schemas/ThreadStateResponse"},"type":"array","x-stream-index":"001.010"},"watcher_count":{"format":"int32","type":"integer","x-stream-index":"001.004"},"watchers":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"001.005"}},"required":["messages","pinned_messages","members","threads","duration"],"type":"object"},"ChannelStateResponseFields":{"properties":{"active_live_locations":{"description":"Active live locations in the channel","items":{"$ref":"#/components/schemas/SharedLocationResponseData"},"title":"Active Live Locations","type":"array","x-stream-index":"015"},"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001"},"deleted_messages":{"items":{"type":"string"},"type":"array","x-stream-index":"016"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"014"},"hidden":{"description":"Whether this channel is hidden or not","title":"Hidden","type":"boolean","x-stream-index":"011"},"hide_messages_before":{"description":"Messages before this date are hidden from the user","format":"date-time","title":"Hide messages before","type":"number","x-stream-index":"012"},"members":{"description":"List of channel members","items":{"$ref":"#/components/schemas/ChannelMember"},"title":"Members","type":"array","x-stream-index":"007"},"membership":{"$ref":"#/components/schemas/ChannelMember","description":"Current user membership object","title":"Membership","x-stream-index":"008"},"messages":{"description":"List of channel messages","items":{"$ref":"#/components/schemas/MessageResponse"},"title":"Message","type":"array","x-stream-index":"002"},"pending_messages":{"description":"Pending messages that this user has sent","items":{"$ref":"#/components/schemas/PendingMessageResponse"},"title":"Pending messages","type":"array","x-stream-index":"013"},"pinned_messages":{"description":"List of pinned messages in the channel","items":{"$ref":"#/components/schemas/MessageResponse"},"title":"Pinned messages","type":"array","x-stream-docs-page-id":"pinned_messages","x-stream-index":"003"},"push_preferences":{"$ref":"#/components/schemas/ChannelPushPreferences","x-stream-index":"009"},"read":{"description":"List of read states","items":{"$ref":"#/components/schemas/ReadStateResponse"},"title":"Read","type":"array","x-stream-index":"006"},"threads":{"items":{"$ref":"#/components/schemas/ThreadStateResponse"},"type":"array","x-stream-index":"010"},"watcher_count":{"description":"Number of channel watchers","format":"int32","title":"Watcher count","type":"integer","x-stream-index":"004"},"watchers":{"description":"List of user who is watching the channel","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Watchers","type":"array","x-stream-index":"005"}},"required":["messages","pinned_messages","members","threads"],"type":"object"},"ChannelTruncatedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001.004"},"channel_id":{"type":"string","x-stream-index":"001.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"001.005"},"channel_type":{"type":"string","x-stream-index":"001.003"},"cid":{"type":"string","x-stream-index":"001.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"type":{"default":"channel.truncated","type":"string","x-stream-index":"002.001"}},"required":["cid","channel_id","channel_type","channel_member_count","type","created_at"],"title":"ChannelTruncatedEvent","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"},"ChannelTypeConfig":{"nullable":true,"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"003.002.027"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"003.002.022"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.002.023"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"003.002.028"},"blocklist":{"type":"string","x-stream-index":"003.002.024"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.002.025"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"003.002.026"},"commands":{"items":{"$ref":"#/components/schemas/Command"},"type":"array","x-stream-index":"003.003"},"connect_events":{"type":"boolean","x-stream-index":"003.002.004"},"count_messages":{"type":"boolean","x-stream-index":"003.002.019"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.001.003"},"custom_events":{"type":"boolean","x-stream-index":"003.002.012"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"002"},"mark_messages_pending":{"type":"boolean","x-stream-index":"003.002.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"003.002.021"},"mutes":{"type":"boolean","x-stream-index":"003.002.009"},"name":{"type":"string","x-stream-index":"003.002.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"003.002.029"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"003.002.030"},"permissions":{"items":{"$ref":"#/components/schemas/PolicyRequest"},"type":"array","x-stream-index":"001"},"polls":{"type":"boolean","x-stream-index":"003.002.016"},"push_notifications":{"type":"boolean","x-stream-index":"003.002.013"},"quotes":{"type":"boolean","x-stream-index":"003.002.008"},"reactions":{"type":"boolean","x-stream-index":"003.002.006"},"read_events":{"type":"boolean","x-stream-index":"003.002.003"},"reminders":{"type":"boolean","x-stream-index":"003.002.014"},"replies":{"type":"boolean","x-stream-index":"003.002.007"},"search":{"type":"boolean","x-stream-index":"003.002.005"},"shared_locations":{"type":"boolean","x-stream-index":"003.002.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"003.002.031"},"typing_events":{"type":"boolean","x-stream-index":"003.002.002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"003.001.004"},"uploads":{"type":"boolean","x-stream-index":"003.002.010"},"url_enrichment":{"type":"boolean","x-stream-index":"003.002.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"003.002.017"}},"required":["permissions","grants","created_at","updated_at","name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","count_messages","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","commands"],"type":"object"},"ChannelUnFrozenEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"channel.unfrozen","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"ChannelUnFrozenEvent","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"},"ChannelUnmutedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"channel.unmuted","type":"string","x-stream-index":"001.001"}},"required":["type","created_at"],"title":"ChannelUnmutedEvent","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"},"ChannelUpdatedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"004.004"},"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"004.005"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"002.001"},"type":{"default":"channel.updated","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"ChannelUpdatedEvent","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"},"ChannelVisibleEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"001.002"},"channel_type":{"type":"string","x-stream-index":"001.003"},"cid":{"type":"string","x-stream-index":"001.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"type":{"default":"channel.visible","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"ChannelVisibleEvent","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"},"ChatActivityStatsResponse":{"properties":{"Messages":{"$ref":"#/components/schemas/MessageStatsResponse","x-stream-index":"001"}},"type":"object"},"CheckExternalStorageResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"file_url":{"type":"string","x-stream-index":"002"}},"required":["duration","file_url"],"title":"Response","type":"object"},"CheckPushRequest":{"description":"Check push request","nullable":true,"properties":{"apn_template":{"description":"Push message template for APN","title":"APN template","type":"string","x-stream-docs-page-id":"push_template","x-stream-index":"002"},"event_type":{"description":"Type of event for push templates (default: message.new)","enum":["message.new","message.updated","reaction.new","reaction.updated","notification.reminder_due"],"title":"Event type","type":"string","x-stream-index":"008"},"firebase_data_template":{"description":"Push message data template for Firebase","title":"Firebase data template","type":"string","x-stream-docs-page-id":"push_template","x-stream-index":"004"},"firebase_template":{"description":"Push message template for Firebase","title":"Firebase template","type":"string","x-stream-docs-page-id":"push_template","x-stream-index":"003"},"message_id":{"description":"Message ID to send push notification for","title":"Message ID","type":"string","x-stream-index":"001"},"push_provider_name":{"description":"Name of push provider","title":"Name of push provider","type":"string","x-stream-index":"007"},"push_provider_type":{"description":"Push provider type","enum":["firebase","apn","huawei","xiaomi"],"title":"Type of push provider","type":"string","x-stream-index":"006"},"skip_devices":{"description":"Don't require existing devices to render templates","title":"Skip devices","type":"boolean","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"009.002"},"user_id":{"type":"string","x-stream-index":"009.001"}},"title":"CheckPushRequest","type":"object"},"CheckPushResponse":{"nullable":true,"properties":{"device_errors":{"additionalProperties":{"$ref":"#/components/schemas/DeviceErrorInfo"},"description":"Object with device errors","title":"Device errors","type":"object","x-stream-index":"001","x-stream-map":{"key":"device_id"}},"duration":{"type":"string","x-stream-index":"008.001"},"event_type":{"description":"The event type that was tested","title":"Event type","type":"string","x-stream-index":"004"},"general_errors":{"description":"List of general errors","items":{"type":"string"},"title":"General errors","type":"array","x-stream-index":"002"},"rendered_apn_template":{"title":"Rendered APN template","type":"string","x-stream-index":"005"},"rendered_firebase_template":{"title":"Rendered Firebase template","type":"string","x-stream-index":"006"},"rendered_message":{"additionalProperties":{"type":"string"},"title":"Rendered message","type":"object","x-stream-index":"007"},"skip_devices":{"description":"Don't require existing devices to render templates","title":"Skip devices","type":"boolean","x-stream-index":"003"}},"required":["duration"],"type":"object"},"CheckRequest":{"nullable":true,"properties":{"config_key":{"description":"Key of the moderation configuration to use","title":"Config Key","type":"string","x-stream-index":"005"},"config_team":{"description":"Team associated with the configuration","title":"Config Team","type":"string","x-stream-index":"006"},"entity_creator_id":{"description":"ID of the user who created the entity","title":"Entity Creator ID","type":"string","x-stream-index":"003"},"entity_id":{"description":"Unique identifier of the entity to moderate","title":"Entity ID","type":"string","x-stream-index":"002"},"entity_type":{"description":"Type of entity to moderate","title":"Entity Type","type":"string","x-stream-index":"001"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content to be moderated","title":"Moderation Payload","x-stream-index":"004"},"options":{"additionalProperties":{},"description":"Additional moderation configuration options","title":"Options","type":"object","x-stream-index":"007"},"test_mode":{"description":"Whether to run moderation in test mode","title":"Test Mode","type":"boolean","x-stream-index":"008"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"009.002"},"user_id":{"type":"string","x-stream-index":"009.001"}},"required":["entity_type","entity_id","entity_creator_id"],"type":"object"},"CheckResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"005.001"},"item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"Review queue item (present if action != keep)","title":"Item","x-stream-index":"004"},"recommended_action":{"description":"Suggested action based on moderation results","title":"Recommended Action","type":"string","x-stream-index":"003"},"status":{"description":"Status of the moderation check (completed or pending)","title":"Status","type":"string","x-stream-index":"001"},"task_id":{"description":"ID of the running moderation task","title":"Task ID","type":"string","x-stream-index":"002"}},"required":["status","recommended_action","duration"],"type":"object"},"CheckSNSRequest":{"nullable":true,"properties":{"sns_key":{"description":"AWS SNS access key","title":"SNS key","type":"string","x-stream-index":"002"},"sns_secret":{"description":"AWS SNS key secret","title":"SNS secret","type":"string","x-stream-index":"003"},"sns_topic_arn":{"description":"AWS SNS topic ARN","title":"SNS Topic ARN","type":"string","x-stream-index":"001"}},"type":"object"},"CheckSNSResponse":{"nullable":true,"properties":{"data":{"additionalProperties":{},"description":"Error data","title":"ReadOnlyData","type":"object","x-stream-index":"003"},"duration":{"type":"string","x-stream-index":"004.001"},"error":{"description":"Error text","title":"Error","type":"string","x-stream-index":"002"},"status":{"description":"Validation result","enum":["ok","error"],"title":"Status","type":"string","x-stream-index":"001"}},"required":["status","duration"],"type":"object"},"CheckSQSRequest":{"nullable":true,"properties":{"sqs_key":{"description":"AWS SQS access key","title":"SQS key","type":"string","x-stream-index":"002"},"sqs_secret":{"description":"AWS SQS key secret","title":"SQS secret","type":"string","x-stream-index":"003"},"sqs_url":{"description":"AWS SQS endpoint URL","title":"SQS URL","type":"string","x-stream-index":"001"}},"type":"object"},"CheckSQSResponse":{"nullable":true,"properties":{"data":{"additionalProperties":{},"description":"Error data","title":"ReadOnlyData","type":"object","x-stream-index":"003"},"duration":{"type":"string","x-stream-index":"004.001"},"error":{"description":"Error text","title":"Error","type":"string","x-stream-index":"002"},"status":{"description":"Validation result","enum":["ok","error"],"title":"Status","type":"string","x-stream-index":"001"}},"required":["status","duration"],"type":"object"},"ClientOSDataResponse":{"properties":{"architecture":{"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"version":{"type":"string","x-stream-index":"002"}},"type":"object"},"ClosedCaptionEvent":{"description":"This event is sent when closed captions are being sent in a call, clients should use this to show the closed captions in the call screen","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"closed_caption":{"$ref":"#/components/schemas/CallClosedCaption","description":"The closed caption object","title":"CallClosedCaption","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.closed_caption","description":"The type of event: \"call.closed_caption\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","closed_caption"],"title":"ClosedCaptionEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CollectUserFeedbackRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"009"},"rating":{"format":"int32","maximum":5,"minimum":1,"type":"integer","x-stream-index":"007"},"reason":{"maxLength":1000,"type":"string","x-stream-index":"008"},"sdk":{"maxLength":50,"type":"string","x-stream-index":"005"},"sdk_version":{"maxLength":50,"type":"string","x-stream-index":"006"},"user_session_id":{"maxLength":50,"type":"string","x-stream-index":"004"}},"required":["sdk","sdk_version","rating"],"type":"object"},"CollectUserFeedbackResponse":{"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"},"Command":{"description":"Represents custom chat command","nullable":true,"properties":{"args":{"description":"Arguments help text, shown in commands auto-completion","title":"Arguments","type":"string","x-stream-index":"006"},"created_at":{"description":"Date/time of creation","format":"date-time","readOnly":true,"title":"Created at","type":"number","x-stream-index":"001"},"description":{"description":"Description, shown in commands auto-completion","title":"Description","type":"string","x-stream-index":"005"},"name":{"description":"Unique command name","title":"Name","type":"string","x-stream-index":"004"},"set":{"description":"Set name used for grouping commands","title":"Set","type":"string","x-stream-index":"007"},"updated_at":{"description":"Date/time of the last update","format":"date-time","readOnly":true,"title":"Updated at","type":"number","x-stream-index":"002"}},"required":["name","description","args","set"],"title":"Command","type":"object"},"CommentAddedEvent":{"description":"Emitted when a comment is added to an activity.","nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","x-stream-index":"002"},"comment":{"$ref":"#/components/schemas/CommentResponse","description":"The comment that was added","title":"Text","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"003.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.001.007"},"feed_visibility":{"type":"string","x-stream-index":"003.003"},"fid":{"type":"string","x-stream-index":"003.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.001.004"},"type":{"default":"feeds.comment.added","description":"The type of event: \"feeds.comment.added\" in this case","title":"Event Type","type":"string","x-stream-index":"003.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who added the comment","title":"User","x-stream-index":"004.001"}},"required":["comment","activity","type","created_at","custom","fid"],"title":"CommentAddedEvent","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"},"CommentDeletedEvent":{"description":"Emitted when a comment is deleted.","nullable":true,"properties":{"comment":{"$ref":"#/components/schemas/CommentResponse","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"type":"string","x-stream-index":"002.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.comment.deleted","description":"The type of event: \"feeds.comment.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who deleted the comment","title":"User","x-stream-index":"003.001"}},"required":["comment","type","created_at","custom","fid"],"title":"CommentDeletedEvent","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"},"CommentReactionAddedEvent":{"description":"Emitted when a reaction is added to a comment.","nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","x-stream-index":"003"},"comment":{"$ref":"#/components/schemas/CommentResponse","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"004.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004.001.007"},"feed_visibility":{"type":"string","x-stream-index":"004.003"},"fid":{"type":"string","x-stream-index":"004.002"},"reaction":{"$ref":"#/components/schemas/FeedsReactionResponse","description":"The reaction that was added","title":"Reaction","x-stream-index":"002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"004.001.004"},"type":{"default":"feeds.comment.reaction.added","description":"The type of event: \"feeds.comment.reaction.added\" in this case","title":"Event Type","type":"string","x-stream-index":"004.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who added the reaction","title":"User","x-stream-index":"005.001"}},"required":["comment","reaction","activity","type","created_at","custom","fid"],"title":"CommentReactionAddedEvent","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"},"CommentReactionDeletedEvent":{"description":"Emitted when a reaction is deleted from a comment.","nullable":true,"properties":{"comment":{"$ref":"#/components/schemas/CommentResponse","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"003.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.001.007"},"feed_visibility":{"type":"string","x-stream-index":"003.003"},"fid":{"type":"string","x-stream-index":"003.002"},"reaction":{"$ref":"#/components/schemas/FeedsReactionResponse","x-stream-index":"002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.001.004"},"type":{"default":"feeds.comment.reaction.deleted","description":"The type of reaction that was removed","title":"Type","type":"string","x-stream-index":"003.001.002"}},"required":["comment","reaction","type","created_at","custom","fid"],"title":"CommentReactionDeletedEvent","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"},"CommentReactionUpdatedEvent":{"description":"Emitted when a reaction is updated on a comment.","nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","x-stream-index":"003"},"comment":{"$ref":"#/components/schemas/CommentResponse","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"004.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004.001.007"},"feed_visibility":{"type":"string","x-stream-index":"004.003"},"fid":{"type":"string","x-stream-index":"004.002"},"reaction":{"$ref":"#/components/schemas/FeedsReactionResponse","description":"The reaction that was updated","title":"Reaction","x-stream-index":"002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"004.001.004"},"type":{"default":"feeds.comment.reaction.updated","description":"The type of event: \"feeds.comment.reaction.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"004.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who updated the reaction","title":"User","x-stream-index":"005.001"}},"required":["comment","reaction","activity","type","created_at","custom","fid"],"title":"CommentReactionUpdatedEvent","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"},"CommentResponse":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"011"},"confidence_score":{"description":"Confidence score of the comment","format":"float","title":"Confidence Score","type":"number","x-stream-index":"022"},"controversy_score":{"description":"Controversy score of the comment","format":"float","title":"Controversy Score","type":"number","x-stream-index":"023"},"created_at":{"description":"When the comment was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"014"},"custom":{"additionalProperties":{},"description":"Custom data for the comment","title":"Custom Data","type":"object","x-stream-index":"006"},"deleted_at":{"description":"When the comment was deleted","format":"date-time","title":"Deleted At","type":"number","x-stream-index":"016"},"downvote_count":{"description":"Number of downvotes for this comment","format":"int32","title":"Downvote Count","type":"integer","x-stream-index":"020"},"id":{"description":"Unique identifier for the comment","title":"ID","type":"string","x-stream-index":"001"},"latest_reactions":{"description":"Recent reactions to the comment","items":{"$ref":"#/components/schemas/FeedsReactionResponse"},"title":"Latest Reactions","type":"array","x-stream-index":"009"},"mentioned_users":{"description":"Users mentioned in the comment","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Mention Users","type":"array","x-stream-index":"012"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"017"},"object_id":{"description":"ID of the object this comment is associated with","title":"Object ID","type":"string","x-stream-index":"002"},"object_type":{"description":"Type of the object this comment is associated with","title":"Object Type","type":"string","x-stream-index":"003"},"own_reactions":{"description":"Current user's reactions to this activity","items":{"$ref":"#/components/schemas/FeedsReactionResponse"},"title":"Own Reactions","type":"array","x-stream-index":"024"},"parent_id":{"description":"ID of parent comment for nested replies","title":"Parent ID","type":"string","x-stream-index":"007"},"reaction_count":{"description":"Number of reactions to this comment","format":"int32","title":"Reaction Count","type":"integer","x-stream-index":"008"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"description":"Grouped reactions by type","title":"Reaction Groups","type":"object","x-stream-index":"010"},"reply_count":{"description":"Number of replies to this comment","format":"int32","title":"Reply Count","type":"integer","x-stream-index":"018"},"score":{"description":"Score of the comment based on reactions","format":"int32","title":"Score","type":"integer","x-stream-index":"021"},"status":{"description":"Status of the comment (e.g., active, deleted)","title":"Status","type":"string","x-stream-index":"013"},"text":{"description":"Text content of the comment","title":"Text","type":"string","x-stream-index":"005"},"updated_at":{"description":"When the comment was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"015"},"upvote_count":{"description":"Number of upvotes for this comment","format":"int32","title":"Upvote Count","type":"integer","x-stream-index":"019"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who created the comment","title":"User","x-stream-index":"004"}},"required":["id","object_id","object_type","user","reaction_count","mentioned_users","status","created_at","updated_at","reply_count","upvote_count","downvote_count","score","confidence_score","own_reactions"],"title":"Comment","type":"object"},"CommentUpdatedEvent":{"description":"Emitted when a comment is updated.","nullable":true,"properties":{"comment":{"$ref":"#/components/schemas/CommentResponse","description":"The comment that was updated","title":"Text","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"type":"string","x-stream-index":"002.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.comment.updated","description":"The type of event: \"feeds.comment.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who updated the comment","title":"User","x-stream-index":"003.001"}},"required":["comment","type","created_at","custom","fid"],"title":"CommentUpdatedEvent","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"},"CommitMessageRequest":{"nullable":true,"type":"object"},"CompositeAppSettings":{"properties":{"json_encoded_settings":{"type":"string","x-stream-index":"005"},"url":{"type":"string","x-stream-index":"004"}},"type":"object"},"ConfigOverrides":{"properties":{"blocklist":{"type":"string","x-stream-index":"008"},"blocklist_behavior":{"enum":["flag","block"],"type":"string","x-stream-index":"009"},"commands":{"items":{"type":"string"},"type":"array","x-stream-index":"011"},"count_messages":{"type":"boolean","x-stream-index":"014"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"010"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"007"},"quotes":{"type":"boolean","x-stream-index":"004"},"reactions":{"type":"boolean","x-stream-index":"002"},"replies":{"type":"boolean","x-stream-index":"003"},"shared_locations":{"type":"boolean","x-stream-index":"013"},"typing_events":{"type":"boolean","x-stream-index":"001"},"uploads":{"type":"boolean","x-stream-index":"005"},"url_enrichment":{"type":"boolean","x-stream-index":"006"},"user_message_reminders":{"type":"boolean","x-stream-index":"012"}},"required":["grants","commands"],"type":"object"},"ConfigResponse":{"properties":{"ai_image_config":{"$ref":"#/components/schemas/AIImageConfig","description":"Configuration for AI image analysis","title":"AI Image Config","x-stream-index":"010"},"ai_text_config":{"$ref":"#/components/schemas/AITextConfig","description":"Configuration for AI text analysis","title":"AI Text Config","x-stream-index":"008"},"ai_video_config":{"$ref":"#/components/schemas/AIVideoConfig","description":"Configuration for AI video analysis","title":"AI Video Config","x-stream-index":"011"},"async":{"description":"Whether moderation should be performed asynchronously","title":"Async","type":"boolean","x-stream-index":"003"},"automod_platform_circumvention_config":{"$ref":"#/components/schemas/AutomodPlatformCircumventionConfig","description":"Configuration for platform circumvention detection","title":"Automod Platform Circumvention Config","x-stream-index":"005"},"automod_semantic_filters_config":{"$ref":"#/components/schemas/AutomodSemanticFiltersConfig","description":"Configuration for semantic filtering","title":"Automod Semantic Filters Config","x-stream-index":"006"},"automod_toxicity_config":{"$ref":"#/components/schemas/AutomodToxicityConfig","description":"Configuration for toxicity detection","title":"Automod Toxicity Config","x-stream-index":"004"},"block_list_config":{"$ref":"#/components/schemas/BlockListConfig","description":"Configuration for block list filtering","title":"Block List Config","x-stream-index":"007"},"created_at":{"description":"When the configuration was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"013"},"key":{"description":"Unique identifier for the moderation configuration","title":"Key","type":"string","x-stream-index":"001"},"llm_config":{"$ref":"#/components/schemas/LLMConfig","description":"Configuration for customer-configured LLM moderation","title":"LLM Config","x-stream-index":"009"},"team":{"description":"Team associated with the configuration","title":"Team","type":"string","x-stream-index":"002"},"updated_at":{"description":"When the configuration was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"014"},"velocity_filter_config":{"$ref":"#/components/schemas/VelocityFilterConfig","description":"Configuration for velocity-based filtering","title":"Velocity Filter Config","x-stream-index":"012"},"video_call_rule_config":{"$ref":"#/components/schemas/VideoCallRuleConfig","x-stream-index":"015"}},"required":["key","team","async","created_at","updated_at"],"type":"object"},"ContentCountRuleParameters":{"properties":{"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"type":"object"},"CountByMinuteResponse":{"nullable":true,"properties":{"count":{"format":"int32","type":"integer","x-stream-index":"002"},"start_ts":{"format":"date-time","type":"number","x-stream-index":"001"}},"required":["start_ts","count"],"type":"object"},"CreateBlockListRequest":{"description":"Block list contains restricted words","nullable":true,"properties":{"name":{"description":"Block list name","maxLength":255,"title":"Name","type":"string","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"004"},"type":{"description":"Block list type.","enum":["regex","domain","domain_allowlist","email","word"],"title":"Type","type":"string","x-stream-index":"003"},"words":{"description":"List of words to block","items":{"type":"string"},"minimum":1,"title":"Words","type":"array","x-stream-index":"002"}},"required":["name","words"],"title":"Block list","type":"object","x-stream-docs-page-id":"block_lists"},"CreateBlockListResponse":{"description":"Basic response information","nullable":true,"properties":{"blocklist":{"$ref":"#/components/schemas/BlockListResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["duration"],"title":"Response","type":"object"},"CreateCallTypeRequest":{"description":"Request for creating a call type","nullable":true,"properties":{"external_storage":{"description":"the external storage for the call type","title":"ExternalStorage","type":"string","x-stream-index":"002.004"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"the permissions granted to each role","title":"Grants","type":"object","x-stream-index":"002.001"},"name":{"type":"string","x-stream-index":"001"},"notification_settings":{"$ref":"#/components/schemas/NotificationSettings","description":"the notification settings for the call type","title":"NotificationSettings","x-stream-index":"002.002"},"settings":{"$ref":"#/components/schemas/CallSettingsRequest","description":"the settings for the call type","title":"Settings","x-stream-index":"002.003"}},"required":["name"],"title":"CreateCallTypeRequest","type":"object"},"CreateCallTypeResponse":{"description":"Response for creating a call type","nullable":true,"properties":{"created_at":{"description":"the time the call type was created","format":"date-time","title":"CreatedAt","type":"number","x-stream-index":"001.005"},"duration":{"type":"string","x-stream-index":"002.001"},"external_storage":{"description":"the external storage for the call type","title":"ExternalStorage","type":"string","x-stream-index":"001.007"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"the permissions granted to each role","title":"Grants","type":"object","x-stream-index":"001.002"},"name":{"description":"the name of the call type","title":"Name","type":"string","x-stream-index":"001.001"},"notification_settings":{"$ref":"#/components/schemas/NotificationSettings","description":"the notification settings for the call type","title":"NotificationSettings","x-stream-index":"001.004"},"settings":{"$ref":"#/components/schemas/CallSettingsResponse","description":"the settings for the call type","title":"Settings","x-stream-index":"001.003"},"updated_at":{"description":"the time the call type was last updated","format":"date-time","title":"UpdatedAt","type":"number","x-stream-index":"001.006"}},"required":["name","grants","settings","notification_settings","created_at","updated_at","duration"],"title":"CreateCallTypeResponse","type":"object"},"CreateChannelTypeRequest":{"nullable":true,"properties":{"automod":{"description":"Automod","enum":["disabled","simple","AI"],"title":"Automod","type":"string","x-stream-index":"019"},"automod_behavior":{"description":"Automod behavior","enum":["flag","block"],"title":"Automod behavior","type":"string","x-stream-index":"020"},"blocklist":{"description":"Blocklist","title":"Blocklist","type":"string","x-stream-index":"024"},"blocklist_behavior":{"description":"Blocklist behavior","enum":["flag","block","shadow_block"],"title":"Blocklist behavior","type":"string","x-stream-index":"025"},"blocklists":{"description":"Blocklists","items":{"$ref":"#/components/schemas/BlockListOptions"},"title":"Blocklists","type":"array","x-stream-index":"026"},"commands":{"description":"List of commands that channel supports","items":{"type":"string"},"title":"Commands","type":"array","x-stream-index":"021"},"connect_events":{"description":"Connect events","title":"Connect events","type":"boolean","x-stream-index":"004"},"custom_events":{"description":"Custom events","title":"Custom events","type":"boolean","x-stream-index":"011"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"List of grants for the channel type","title":"Grants","type":"object","x-stream-index":"023"},"mark_messages_pending":{"description":"Mark messages pending","title":"Mark messages pending","type":"boolean","x-stream-index":"013"},"max_message_length":{"description":"Max message length","format":"int32","title":"Max message length","type":"integer","x-stream-index":"018"},"message_retention":{"description":"Message retention","enum":["infinite","numeric"],"title":"Message retention","type":"string","x-stream-index":"017"},"mutes":{"description":"Mutes","title":"Mutes","type":"boolean","x-stream-index":"008"},"name":{"description":"Channel type name","title":"Name","type":"string","x-stream-index":"001"},"partition_size":{"description":"Partition size","format":"int32","minimum":10,"title":"Partition size","type":"integer","x-stream-index":"027"},"partition_ttl":{"description":"Partition TTL","example":"24h","format":"duration","nullable":true,"title":"Partition TTL","type":"string","x-stream-index":"028"},"permissions":{"description":"List of permissions for the channel type","items":{"$ref":"#/components/schemas/PolicyRequest"},"title":"Permissions","type":"array","x-stream-index":"022"},"polls":{"description":"Polls","title":"Polls","type":"boolean","x-stream-index":"014"},"push_notifications":{"description":"Push notifications","title":"Push notifications","type":"boolean","x-stream-index":"012"},"reactions":{"description":"Reactions","title":"Reactions","type":"boolean","x-stream-index":"005"},"read_events":{"description":"Read events","title":"Read events","type":"boolean","x-stream-index":"003"},"replies":{"description":"Replies","title":"Replies","type":"boolean","x-stream-index":"006"},"search":{"description":"Search","title":"Search","type":"boolean","x-stream-index":"007"},"shared_locations":{"description":"Enables shared location messages","title":"Shared locations","type":"boolean","x-stream-index":"016"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"029"},"typing_events":{"description":"Typing events","title":"Typing events","type":"boolean","x-stream-index":"002"},"uploads":{"description":"Uploads","title":"Uploads","type":"boolean","x-stream-index":"009"},"url_enrichment":{"description":"URL enrichment","title":"URL enrichment","type":"boolean","x-stream-index":"010"},"user_message_reminders":{"type":"boolean","x-stream-index":"015"}},"required":["name","max_message_length","automod","automod_behavior"],"title":"CreateChannelTypeRequest","type":"object"},"CreateChannelTypeResponse":{"nullable":true,"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.001.027"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.001.022"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.001.023"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.001.028"},"blocklist":{"type":"string","x-stream-index":"001.001.024"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.001.025"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.001.026"},"commands":{"items":{"type":"string"},"type":"array","x-stream-index":"001.003"},"connect_events":{"type":"boolean","x-stream-index":"001.001.004"},"count_messages":{"type":"boolean","x-stream-index":"001.001.019"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002.003"},"custom_events":{"type":"boolean","x-stream-index":"001.001.012"},"duration":{"type":"string","x-stream-index":"004.001"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"003"},"mark_messages_pending":{"type":"boolean","x-stream-index":"001.001.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"001.001.021"},"mutes":{"type":"boolean","x-stream-index":"001.001.009"},"name":{"type":"string","x-stream-index":"001.001.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"001.001.029"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"001.001.030"},"permissions":{"items":{"$ref":"#/components/schemas/PolicyRequest"},"type":"array","x-stream-index":"002"},"polls":{"type":"boolean","x-stream-index":"001.001.016"},"push_notifications":{"type":"boolean","x-stream-index":"001.001.013"},"quotes":{"type":"boolean","x-stream-index":"001.001.008"},"reactions":{"type":"boolean","x-stream-index":"001.001.006"},"read_events":{"type":"boolean","x-stream-index":"001.001.003"},"reminders":{"type":"boolean","x-stream-index":"001.001.014"},"replies":{"type":"boolean","x-stream-index":"001.001.007"},"search":{"type":"boolean","x-stream-index":"001.001.005"},"shared_locations":{"type":"boolean","x-stream-index":"001.001.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.001.031"},"typing_events":{"type":"boolean","x-stream-index":"001.001.002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.002.004"},"uploads":{"type":"boolean","x-stream-index":"001.001.010"},"url_enrichment":{"type":"boolean","x-stream-index":"001.001.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"001.001.017"}},"required":["name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","count_messages","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","created_at","updated_at","commands","permissions","grants","duration"],"type":"object"},"CreateCommandRequest":{"description":"Create a new command","nullable":true,"properties":{"args":{"description":"Arguments help text, shown in commands auto-completion","maxLength":255,"title":"Arguments","type":"string","x-stream-index":"003"},"description":{"description":"Description, shown in commands auto-completion","maxLength":255,"title":"Description","type":"string","x-stream-index":"002"},"name":{"description":"Unique command name","maxLength":255,"minLength":1,"title":"Name","type":"string","x-stream-index":"001"},"set":{"description":"Set name used for grouping commands","maxLength":255,"title":"Set","type":"string","x-stream-index":"004"}},"required":["name","description"],"title":"CreateCommandRequest","type":"object"},"CreateCommandResponse":{"nullable":true,"properties":{"command":{"$ref":"#/components/schemas/Command","description":"Command object","title":"Command","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["duration"],"title":"CreateCommandResponse","type":"object"},"CreateDeviceRequest":{"description":"Create device request","nullable":true,"properties":{"id":{"description":"Device ID","maxLength":255,"minLength":1,"title":"ID","type":"string","x-stream-index":"001"},"push_provider":{"description":"Push provider","enum":["firebase","apn","huawei","xiaomi"],"title":"PushProvider","type":"string","x-stream-index":"002"},"push_provider_name":{"description":"Push provider name","title":"PushProviderName","type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"005.002"},"user_id":{"description":"**Server-side only**. User ID which server acts upon","title":"User ID","type":"string","x-stream-index":"005.001"},"voip_token":{"description":"When true the token is for Apple VoIP push notifications","title":"VoipToken","type":"boolean","x-stream-index":"004"}},"required":["id","push_provider"],"title":"CreateDeviceRequest","type":"object"},"CreateExternalStorageRequest":{"description":"Create external storage","nullable":true,"properties":{"aws_s3":{"$ref":"#/components/schemas/S3Request","description":"Only required if you want to create an Amazon S3 storage","title":"AwsS3","x-stream-index":"003.004"},"azure_blob":{"$ref":"#/components/schemas/AzureRequest","description":"Only required if you want to create an Azure Blob Storage","title":"AzureBlob","x-stream-index":"003.006"},"bucket":{"description":"The name of the bucket on the service provider","title":"Bucket","type":"string","x-stream-index":"003.002"},"gcs_credentials":{"type":"string","x-stream-index":"003.005"},"name":{"description":"The name of the provider, this must be unique","title":"Name","type":"string","x-stream-index":"001"},"path":{"description":"The path prefix to use for storing files","title":"Path","type":"string","x-stream-index":"003.003"},"storage_type":{"description":"The type of storage to use","enum":["s3","gcs","abs"],"title":"StorageType","type":"string","x-stream-index":"003.001"}},"required":["name","storage_type","bucket"],"title":"CreateExternalStorageRequest","type":"object"},"CreateExternalStorageResponse":{"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"},"CreateFeedGroupRequest":{"nullable":true,"properties":{"activity_processors":{"description":"Configuration for activity processors (max 10)","items":{"$ref":"#/components/schemas/ActivityProcessorConfig"},"maximum":10,"title":"Activity Processors","type":"array","x-stream-index":"006"},"activity_selectors":{"description":"Configuration for activity selectors (max 10)","items":{"$ref":"#/components/schemas/ActivitySelectorConfig"},"maximum":10,"title":"Activity Selectors","type":"array","x-stream-index":"007"},"aggregation":{"$ref":"#/components/schemas/AggregationConfig","description":"Configuration for activity aggregation","title":"Aggregation","x-stream-index":"009"},"custom":{"additionalProperties":{},"description":"Custom data for the feed group","title":"Custom Data","type":"object","x-stream-index":"004"},"default_visibility":{"description":"Default visibility for the feed group, can be 'public', 'visible', 'followers', 'members', or 'private'. Defaults to 'visible' if not provided. ","enum":["public","visible","followers","members","private"],"title":"Default Visibility","type":"string","x-stream-index":"005"},"id":{"description":"Unique identifier for the feed group","maxLength":255,"title":"Feed Group ID","type":"string","x-stream-index":"001"},"notification":{"$ref":"#/components/schemas/NotificationConfig","description":"Configuration for notifications","title":"Notification","x-stream-index":"002"},"push_notification":{"$ref":"#/components/schemas/PushNotificationConfig","x-stream-index":"003"},"ranking":{"$ref":"#/components/schemas/RankingConfig","description":"Configuration for activity ranking","title":"Ranking","x-stream-index":"008"}},"required":["id"],"title":"Create Feed Group Request","type":"object"},"CreateFeedGroupResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"feed_group":{"$ref":"#/components/schemas/FeedGroupResponse","description":"The upserted feed group","title":"Feed Group","x-stream-index":"001"}},"required":["feed_group","duration"],"title":"Upsert Feed Group Response","type":"object"},"CreateFeedViewRequest":{"nullable":true,"properties":{"activity_processors":{"description":"Configured activity Processors","items":{"$ref":"#/components/schemas/ActivityProcessorConfig"},"title":"Activity Processors","type":"array","x-stream-index":"002.002"},"activity_selectors":{"description":"Configuration for selecting activities","items":{"$ref":"#/components/schemas/ActivitySelectorConfig"},"title":"Activity Selectors","type":"array","x-stream-index":"002.001"},"aggregation":{"$ref":"#/components/schemas/AggregationConfig","description":"Configuration for aggregating activities","title":"Aggregation","x-stream-index":"002.004"},"id":{"description":"Unique identifier for the feed view","maxLength":255,"title":"View ID","type":"string","x-stream-index":"001"},"ranking":{"$ref":"#/components/schemas/RankingConfig","description":"Configuration for ranking activities","title":"Ranking","x-stream-index":"002.003"}},"required":["id"],"title":"Create Feed View Request","type":"object"},"CreateFeedViewResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"feed_view":{"$ref":"#/components/schemas/FeedViewResponse","description":"The created feed view","title":"Feed View","x-stream-index":"001"}},"required":["feed_view","duration"],"title":"Create Feed View Response","type":"object"},"CreateFeedsBatchRequest":{"nullable":true,"properties":{"feeds":{"description":"List of feeds to create","items":{"$ref":"#/components/schemas/FeedRequest"},"maximum":1000,"minimum":1,"title":"Feeds","type":"array","x-stream-index":"001"}},"required":["feeds"],"title":"Create Feeds Batch Request","type":"object"},"CreateFeedsBatchResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"feeds":{"description":"List of created feeds","items":{"$ref":"#/components/schemas/FeedResponse"},"title":"Feeds","type":"array","x-stream-index":"001"}},"required":["feeds","duration"],"title":"Create Feeds Batch Response","type":"object"},"CreateGuestRequest":{"nullable":true,"properties":{"user":{"$ref":"#/components/schemas/UserRequest","description":"User object which server acts upon","title":"User","x-stream-index":"001"}},"required":["user"],"type":"object"},"CreateGuestResponse":{"nullable":true,"properties":{"access_token":{"description":"the access token to authenticate the user","title":"Access token","type":"string","x-stream-index":"002"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User object which server acts upon","title":"User","x-stream-index":"001"}},"required":["user","access_token","duration"],"type":"object"},"CreateImportRequest":{"nullable":true,"properties":{"mode":{"enum":["insert","upsert"],"type":"string","x-stream-index":"002"},"path":{"type":"string","x-stream-index":"001"}},"required":["path","mode"],"type":"object"},"CreateImportResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"import_task":{"$ref":"#/components/schemas/ImportTask","x-stream-index":"001"}},"required":["duration"],"title":"Response","type":"object"},"CreateImportURLRequest":{"nullable":true,"properties":{"filename":{"type":"string","x-stream-index":"001"}},"type":"object"},"CreateImportURLResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"path":{"type":"string","x-stream-index":"001"},"upload_url":{"type":"string","x-stream-index":"002"}},"required":["path","upload_url","duration"],"title":"Response","type":"object"},"CreateMembershipLevelRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"description":"Custom data for the membership level","title":"Custom Data","type":"object","x-stream-index":"006"},"description":{"description":"Optional description of the membership level","maxLength":1000,"title":"Description","type":"string","x-stream-index":"003"},"id":{"description":"Unique identifier for the membership level","maxLength":255,"title":"ID","type":"string","x-stream-index":"001"},"name":{"description":"Display name for the membership level","maxLength":255,"title":"Name","type":"string","x-stream-index":"002"},"priority":{"description":"Priority level (higher numbers = higher priority)","format":"int32","minimum":0,"title":"Priority","type":"integer","x-stream-index":"004"},"tags":{"description":"Activity tags this membership level gives access to","items":{"type":"string"},"maximum":255,"title":"Tags","type":"array","x-stream-index":"005"}},"required":["id","name"],"title":"Create Membership Level Request","type":"object"},"CreateMembershipLevelResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"membership_level":{"$ref":"#/components/schemas/MembershipLevelResponse","description":"The created membership level","title":"Membership Level","x-stream-index":"001"}},"required":["membership_level","duration"],"title":"Create Membership Level Response","type":"object"},"CreatePollOptionRequest":{"nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"003"},"text":{"description":"Option text","title":"string","type":"string","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"required":["text"],"type":"object"},"CreatePollRequest":{"description":"Contains all information needed to create a new poll","nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"011"},"allow_answers":{"description":"Indicates whether users can suggest user defined answers","title":"Allow answers","type":"boolean","x-stream-index":"009"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"008"},"description":{"description":"A description of the poll","title":"Description","type":"string","x-stream-index":"003"},"enforce_unique_vote":{"description":"Indicates whether users can cast multiple votes","title":"Multiple choice","type":"boolean","x-stream-index":"006"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"is_closed":{"description":"Indicates whether the poll is open for voting","title":"Is closed","type":"boolean","x-stream-index":"010"},"max_votes_allowed":{"description":"Indicates the maximum amount of votes a user can cast","format":"int32","maximum":10,"title":"Maximum votes allowed","type":"integer","x-stream-index":"007"},"name":{"description":"The name of the poll","title":"Name","type":"string","x-stream-index":"002"},"options":{"items":{"$ref":"#/components/schemas/PollOptionInput"},"maximum":100,"type":"array","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"012.002"},"user_id":{"type":"string","x-stream-index":"012.001"},"voting_visibility":{"enum":["anonymous","public"],"type":"string","x-stream-index":"005"}},"required":["name"],"title":"Create Poll Request","type":"object"},"CreateReminderRequest":{"nullable":true,"properties":{"remind_at":{"format":"date-time","type":"number","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"type":"object"},"CreateRoleRequest":{"nullable":true,"properties":{"name":{"description":"Role name","maxLength":64,"title":"Name","type":"string","x-stream-index":"001"}},"required":["name"],"type":"object"},"CreateRoleResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"role":{"$ref":"#/components/schemas/Role","x-stream-index":"002"}},"required":["duration","role"],"title":"Response","type":"object"},"CustomActionRequest":{"properties":{"id":{"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"type":"object"},"CustomCheckFlag":{"properties":{"custom":{"additionalProperties":{},"description":"Additional metadata for the flag","title":"Custom","type":"object","x-stream-index":"003"},"labels":{"description":"Labels from various moderation sources","items":{"type":"string"},"title":"Labels","type":"array","x-stream-index":"004"},"reason":{"description":"Optional explanation for the flag","title":"Reason","type":"string","x-stream-index":"002"},"type":{"description":"Type of check (custom_check_text, custom_check_image, custom_check_video)","maxLength":255,"title":"Type","type":"string","x-stream-index":"001"}},"required":["type"],"type":"object"},"CustomCheckRequest":{"nullable":true,"properties":{"entity_creator_id":{"description":"ID of the user who created the entity (required for non-message entities)","title":"Entity Creator ID","type":"string","x-stream-index":"003"},"entity_id":{"description":"Unique identifier of the entity","title":"Entity ID","type":"string","x-stream-index":"002"},"entity_type":{"description":"Type of entity to perform custom check on","title":"Entity Type","type":"string","x-stream-index":"001"},"flags":{"description":"List of custom check flags (1-10 flags required)","items":{"$ref":"#/components/schemas/CustomCheckFlag"},"maximum":10,"minimum":1,"title":"Flags","type":"array","x-stream-index":"005"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content to be checked (required for non-message entities)","title":"Moderation Payload","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"006.002"},"user_id":{"type":"string","x-stream-index":"006.001"}},"required":["entity_type","entity_id","flags"],"type":"object"},"CustomCheckResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"004.001"},"id":{"description":"Unique identifier of the custom check","title":"ID","type":"string","x-stream-index":"001"},"item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"Review queue item details","title":"Item","x-stream-index":"002"},"status":{"description":"Status of the custom check","title":"Status","type":"string","x-stream-index":"003"}},"required":["id","status","duration"],"type":"object"},"CustomVideoEvent":{"description":"A custom event, this event is used to send custom events to other participants in the call.","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"003"},"type":{"default":"custom","description":"The type of event, \"custom\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"004"}},"required":["type","created_at","call_cid","custom","user"],"title":"CustomVideoEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"DailyAggregateCallDurationReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/CallDurationReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateCallParticipantCountReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/CallParticipantCountReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateCallsPerDayReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/CallsPerDayReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateQualityScoreReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/QualityScoreReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateSDKUsageReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/SDKUsageReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateUserFeedbackReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/UserFeedbackReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"Data":{"properties":{"id":{"type":"string","x-stream-index":"001"}},"required":["id"],"type":"object"},"DataDogInfo":{"properties":{"api_key":{"type":"string","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"003"},"site":{"type":"string","x-stream-index":"002"}},"type":"object"},"DeactivateUserRequest":{"nullable":true,"properties":{"created_by_id":{"description":"ID of the user who deactivated the user","title":"Created by ID","type":"string","x-stream-index":"003"},"mark_messages_deleted":{"description":"Makes messages appear to be deleted","title":"Mark messages deleted","type":"boolean","x-stream-index":"002"}},"type":"object"},"DeactivateUserResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Deactivated user object","title":"User","x-stream-index":"001"}},"required":["duration"],"type":"object"},"DeactivateUsersRequest":{"description":"Deactivate users request","nullable":true,"properties":{"created_by_id":{"description":"ID of the user who deactivated the users","title":"Created by ID","type":"string","x-stream-index":"003"},"mark_channels_deleted":{"type":"boolean","x-stream-index":"004"},"mark_messages_deleted":{"description":"Makes messages appear to be deleted","title":"Mark messages deleted","type":"boolean","x-stream-index":"002"},"user_ids":{"description":"User IDs to deactivate","items":{"type":"string"},"maximum":100,"minimum":1,"title":"User IDs","type":"array","x-stream-index":"001"}},"required":["user_ids"],"title":"DeactivateUsersRequest","type":"object"},"DeactivateUsersResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"task_id":{"type":"string","x-stream-index":"001"}},"required":["task_id","duration"],"title":"Response","type":"object"},"DecayFunctionConfig":{"properties":{"base":{"description":"Base value for decay function","title":"Base","type":"string","x-stream-index":"001"},"decay":{"description":"Decay rate","title":"Decay","type":"string","x-stream-index":"005"},"direction":{"description":"Direction of decay","title":"Direction","type":"string","x-stream-index":"006"},"offset":{"description":"Offset value for decay function","title":"Offset","type":"string","x-stream-index":"004"},"origin":{"description":"Origin value for decay function","title":"Origin","type":"string","x-stream-index":"002"},"scale":{"description":"Scale factor for decay function","title":"Scale","type":"string","x-stream-index":"003"}},"title":"Decay Function Configuration","type":"object"},"DeleteActivitiesRequest":{"nullable":true,"properties":{"hard_delete":{"description":"Whether to permanently delete the activities","title":"Hard Delete","type":"boolean","x-stream-index":"002"},"ids":{"description":"List of activity IDs to delete","items":{"type":"string"},"minimum":1,"title":"Activity IDs","type":"array","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"required":["ids"],"title":"Delete Activities Request","type":"object"},"DeleteActivitiesResponse":{"nullable":true,"properties":{"deleted_ids":{"description":"List of activity IDs that were successfully deleted","items":{"type":"string"},"title":"Deleted Activity IDs","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["deleted_ids","duration"],"title":"Delete Activities Response","type":"object"},"DeleteActivityReactionResponse":{"nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"reaction":{"$ref":"#/components/schemas/FeedsReactionResponse","x-stream-index":"002"}},"required":["activity","reaction","duration"],"title":"Delete Activity Reaction Response","type":"object"},"DeleteActivityRequest":{"properties":{"hard_delete":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"DeleteActivityResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"Delete Activity Response","type":"object"},"DeleteBookmarkFolderResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"Delete Bookmark Folder Response","type":"object"},"DeleteBookmarkResponse":{"nullable":true,"properties":{"bookmark":{"$ref":"#/components/schemas/BookmarkResponse","description":"The deleted bookmark","title":"Bookmark","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["bookmark","duration"],"title":"Delete Bookmark Response","type":"object"},"DeleteCallRequest":{"description":"DeleteCallRequest is the payload for deleting a call.","nullable":true,"properties":{"hard":{"description":"if true the call will be hard deleted along with all related data","title":"Hard","type":"boolean","x-stream-index":"001"}},"title":"DeleteCallRequest","type":"object"},"DeleteCallResponse":{"description":"DeleteCallResponse is the payload for deleting a call.","nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","title":"Call","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"task_id":{"title":"TaskID","type":"string","x-stream-index":"002"}},"required":["call","duration"],"title":"DeleteCallResponse","type":"object"},"DeleteChannelResponse":{"description":"Basic response information","nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"Response","type":"object"},"DeleteChannelsRequest":{"nullable":true,"properties":{"cids":{"description":"All channels that should be deleted","items":{"type":"string"},"maximum":100,"minimum":1,"title":"Channels CID","type":"array","x-stream-index":"001"},"hard_delete":{"description":"Specify if channels and all ressources should be hard deleted","title":"Hard delete","type":"boolean","x-stream-index":"002"}},"required":["cids"],"type":"object"},"DeleteChannelsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"result":{"additionalProperties":{"$ref":"#/components/schemas/DeleteChannelsResultResponse"},"description":"Map of channel IDs and their deletion results","title":"Result","type":"object","x-stream-index":"001"},"task_id":{"type":"string","x-stream-index":"002"}},"required":["duration"],"type":"object"},"DeleteChannelsResultResponse":{"nullable":true,"properties":{"error":{"type":"string","x-stream-index":"002"},"status":{"type":"string","x-stream-index":"001"}},"required":["status"],"type":"object"},"DeleteCommandResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"name":{"description":"Command name","title":"Name","type":"string","x-stream-index":"001"}},"required":["name","duration"],"title":"DeleteCommandResponse","type":"object"},"DeleteCommentReactionResponse":{"nullable":true,"properties":{"comment":{"$ref":"#/components/schemas/CommentResponse","description":"The comment after reaction removal","title":"Comment","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"reaction":{"$ref":"#/components/schemas/FeedsReactionResponse","description":"The removed reaction","title":"Reaction","x-stream-index":"002"}},"required":["comment","reaction","duration"],"title":"Delete Comment Reaction Response","type":"object"},"DeleteCommentResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"Delete Comment Response","type":"object"},"DeleteExternalStorageResponse":{"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"},"DeleteFeedGroupResponse":{"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"},"DeleteFeedResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"Delete Feed Response","type":"object"},"DeleteFeedUserDataResponse":{"description":"Response for deleting feed user data","nullable":true,"properties":{"deleted_activities":{"description":"Number of activities that were deleted","format":"int32","title":"Deleted Activities","type":"integer","x-stream-index":"001"},"deleted_bookmarks":{"description":"Number of bookmarks that were deleted","format":"int32","title":"Deleted Bookmarks","type":"integer","x-stream-index":"004"},"deleted_comments":{"description":"Number of comments that were deleted","format":"int32","title":"Deleted Comments","type":"integer","x-stream-index":"003"},"deleted_reactions":{"description":"Number of reactions that were deleted","format":"int32","title":"Deleted Reactions","type":"integer","x-stream-index":"002"},"duration":{"type":"string","x-stream-index":"005.001"}},"required":["deleted_activities","deleted_reactions","deleted_comments","deleted_bookmarks","duration"],"type":"object"},"DeleteFeedViewResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"Delete Feed View Response","type":"object"},"DeleteMessageRequest":{"properties":{"hard_delete":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"DeleteMessageResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001"}},"required":["message","duration"],"title":"Response","type":"object"},"DeleteModerationConfigResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"DeleteModerationRuleResponse":{"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"},"DeleteModerationTemplateResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"DeleteReactionRequest":{"properties":{"hard_delete":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"DeleteReactionResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001"},"reaction":{"$ref":"#/components/schemas/ReactionResponse","x-stream-index":"002"}},"required":["message","reaction","duration"],"title":"Response","type":"object"},"DeleteRecordingResponse":{"description":"Response for DeleteRecording","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"DeleteRecordingResponse","type":"object"},"DeleteReminderResponse":{"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"},"DeleteSegmentTargetsRequest":{"nullable":true,"properties":{"target_ids":{"description":"Target IDs","items":{"type":"string"},"maximum":100,"minimum":1,"title":"[]string","type":"array","x-stream-index":"002"}},"required":["target_ids"],"type":"object"},"DeleteTranscriptionResponse":{"description":"DeleteTranscriptionResponse is the payload for deleting a transcription.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"DeleteTranscriptionResponse","type":"object"},"DeleteUserRequest":{"properties":{"delete_conversation_channels":{"type":"boolean","x-stream-index":"003"},"delete_feeds_content":{"type":"boolean","x-stream-index":"004"},"hard_delete":{"type":"boolean","x-stream-index":"001"},"mark_messages_deleted":{"type":"boolean","x-stream-index":"002"}},"type":"object"},"DeleteUsersRequest":{"nullable":true,"properties":{"calls":{"description":"Calls delete mode.\nAffected calls are those that include exactly two members, one of whom is the user being deleted.\n\n* null or empty string - doesn't delete any calls\n* soft - marks user's calls and their related data as deleted (soft-delete)\n* hard - deletes user's calls and their data completely (hard-delete)\n","enum":["soft","hard"],"title":"Delete User's calls","type":"string","x-stream-index":"001.002.004"},"conversations":{"description":"Conversation channels delete mode.\nConversation channel is any channel which only has two members one of which is the user being deleted.\n\n* null or empty string - doesn't delete any conversation channels\n* soft - marks all conversation channels as deleted (same effect as Delete Channels with 'hard' option disabled)\n* hard - deletes channel and all its data completely including messages (same effect as Delete Channels with 'hard' option enabled)\n","enum":["soft","hard"],"title":"Delete Conversations","type":"string","x-stream-index":"001.002.003"},"files":{"description":"Delete user files.\n* false or empty string - doesn't delete any files\n* true - deletes all files uploaded by the user, including images and attachments.\n","title":"Delete User's files","type":"boolean","x-stream-index":"001.002.005"},"messages":{"description":"Message delete mode.\n\n* null or empty string - doesn't delete user messages\n* soft - marks all user messages as deleted without removing any related message data\n* pruning - marks all user messages as deleted, nullifies message information and removes some message data such as reactions and flags\n* hard - deletes messages completely with all related information\n","enum":["soft","pruning","hard"],"title":"Delete Messages","type":"string","x-stream-index":"001.002.002"},"new_call_owner_id":{"type":"string","x-stream-index":"001.002.007"},"new_channel_owner_id":{"type":"string","x-stream-index":"001.002.006"},"user":{"description":"User delete mode.\n\n* soft - marks user as deleted and retains all user data\n* pruning - marks user as deleted and nullifies user information\n* hard - deletes user completely. Requires 'hard' option for messages and conversations as well\n","enum":["soft","pruning","hard"],"title":"Delete User","type":"string","x-stream-index":"001.002.001"},"user_ids":{"description":"IDs of users to delete","items":{"type":"string"},"maximum":100,"minimum":1,"title":"User IDs","type":"array","x-stream-index":"001.001"}},"required":["user_ids"],"type":"object"},"DeleteUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"task_id":{"description":"ID of the task to delete users","title":"Task ID","type":"string","x-stream-index":"001"}},"required":["task_id","duration"],"type":"object"},"Device":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"disabled":{"type":"boolean","x-stream-index":"002.003"},"disabled_reason":{"type":"string","x-stream-index":"002.004"},"id":{"type":"string","x-stream-index":"002.001.004"},"push_provider":{"enum":["firebase","apn","huawei","xiaomi"],"type":"string","x-stream-index":"002.001.001"},"push_provider_name":{"type":"string","x-stream-index":"002.001.003"},"user_id":{"type":"string","x-stream-index":"004"},"voip":{"type":"boolean","x-stream-index":"002.001.005"}},"required":["push_provider","id","created_at","user_id"],"type":"object"},"DeviceDataResponse":{"properties":{"name":{"type":"string","x-stream-index":"001"},"version":{"type":"string","x-stream-index":"002"}},"type":"object"},"DeviceErrorInfo":{"properties":{"error_message":{"type":"string","x-stream-index":"003"},"provider":{"type":"string","x-stream-index":"001"},"provider_name":{"type":"string","x-stream-index":"002"}},"required":["provider","provider_name","error_message"],"type":"object"},"DeviceResponse":{"description":"Response for Device","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"004"},"disabled":{"description":"Whether device is disabled or not","title":"Disabled","type":"boolean","x-stream-index":"005"},"disabled_reason":{"description":"Reason explaining why device had been disabled","title":"Reason","type":"string","x-stream-index":"006"},"id":{"description":"Device ID","title":"ID","type":"string","x-stream-index":"003"},"push_provider":{"description":"Push provider","title":"PushProvider","type":"string","x-stream-index":"001"},"push_provider_name":{"description":"Push provider name","title":"PushProviderName","type":"string","x-stream-index":"002"},"user_id":{"description":"User ID","title":"UserID","type":"string","x-stream-index":"008"},"voip":{"description":"When true the token is for Apple VoIP push notifications","title":"Voip","type":"boolean","x-stream-index":"007"}},"required":["push_provider","id","created_at","user_id"],"title":"DeviceResponse","type":"object"},"DraftPayloadResponse":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"html":{"type":"string","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"001"},"mentioned_users":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"008"},"mml":{"type":"string","x-stream-index":"003"},"parent_id":{"type":"string","x-stream-index":"005"},"poll_id":{"type":"string","x-stream-index":"013"},"quoted_message_id":{"type":"string","x-stream-index":"009"},"show_in_channel":{"type":"boolean","x-stream-index":"006"},"silent":{"type":"boolean","x-stream-index":"012"},"text":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"011"}},"required":["id","text","custom"],"type":"object"},"DraftResponse":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003"},"channel_cid":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"message":{"$ref":"#/components/schemas/DraftPayloadResponse","x-stream-index":"001"},"parent_id":{"type":"string","x-stream-index":"004"},"parent_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"005"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"006"}},"required":["message","channel_cid","created_at"],"type":"object"},"EdgeResponse":{"properties":{"continent_code":{"type":"string","x-stream-index":"007.003"},"country_iso_code":{"type":"string","x-stream-index":"007.002"},"green":{"format":"int32","type":"integer","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"latency_test_url":{"type":"string","x-stream-index":"002"},"latitude":{"format":"float","type":"number","x-stream-index":"006.001"},"longitude":{"format":"float","type":"number","x-stream-index":"006.002"},"red":{"format":"int32","type":"integer","x-stream-index":"005"},"subdivision_iso_code":{"type":"string","x-stream-index":"007.001"},"yellow":{"format":"int32","type":"integer","x-stream-index":"004"}},"required":["id","latency_test_url","green","yellow","red","latitude","longitude","subdivision_iso_code","country_iso_code","continent_code"],"type":"object"},"EgressHLSResponse":{"properties":{"playlist_url":{"type":"string","x-stream-index":"001"},"status":{"type":"string","x-stream-index":"002"}},"required":["playlist_url","status"],"type":"object"},"EgressRTMPResponse":{"properties":{"name":{"type":"string","x-stream-index":"001"},"started_at":{"format":"date-time","type":"number","x-stream-index":"004"},"stream_key":{"type":"string","x-stream-index":"003"},"stream_url":{"type":"string","x-stream-index":"002"}},"required":["name","started_at"],"type":"object"},"EgressResponse":{"properties":{"broadcasting":{"type":"boolean","x-stream-index":"001"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordingResponse","x-stream-index":"004"},"hls":{"$ref":"#/components/schemas/EgressHLSResponse","x-stream-index":"002"},"rtmps":{"items":{"$ref":"#/components/schemas/EgressRTMPResponse"},"type":"array","x-stream-index":"003"}},"required":["broadcasting","rtmps"],"type":"object"},"EgressTaskConfig":{"properties":{"egress_user":{"$ref":"#/components/schemas/EgressUser","x-stream-index":"008"},"frame_recording_egress_config":{"$ref":"#/components/schemas/FrameRecordingEgressConfig","x-stream-index":"009"},"hls_egress_config":{"$ref":"#/components/schemas/HLSEgressConfig","x-stream-index":"007"},"recording_egress_config":{"$ref":"#/components/schemas/RecordingEgressConfig","x-stream-index":"006"},"rtmp_egress_config":{"$ref":"#/components/schemas/RTMPEgressConfig","x-stream-index":"004"},"stt_egress_config":{"$ref":"#/components/schemas/STTEgressConfig","x-stream-index":"005"}},"type":"object"},"EgressUser":{"properties":{"token":{"type":"string","x-stream-index":"004"}},"type":"object"},"EndCallRequest":{"description":"Request for ending a call","nullable":true,"title":"EndCallRequest","type":"object"},"EndCallResponse":{"description":"Response for ending a call","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"EndCallResponse","type":"object"},"EnrichedActivity":{"properties":{"actor":{"$ref":"#/components/schemas/Data","x-stream-index":"002"},"foreign_id":{"type":"string","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"latest_reactions":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"013"},"object":{"$ref":"#/components/schemas/Data","x-stream-index":"004"},"origin":{"$ref":"#/components/schemas/Data","x-stream-index":"008"},"own_reactions":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"012"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"011"},"score":{"format":"float","type":"number","x-stream-index":"010"},"target":{"$ref":"#/components/schemas/Data","x-stream-index":"006"},"to":{"items":{"type":"string"},"type":"array","x-stream-index":"009"},"verb":{"type":"string","x-stream-index":"003"}},"type":"object"},"EnrichedReaction":{"nullable":true,"properties":{"activity_id":{"type":"string","x-stream-index":"003"},"children_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"010"},"created_at":{"$ref":"#/components/schemas/Time","x-stream-index":"012"},"data":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"kind":{"type":"string","x-stream-index":"002"},"latest_children":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"008"},"own_children":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"009"},"parent":{"type":"string","x-stream-index":"007"},"target_feeds":{"items":{"type":"string"},"type":"array","x-stream-index":"006"},"updated_at":{"$ref":"#/components/schemas/Time","x-stream-index":"013"},"user":{"$ref":"#/components/schemas/Data","x-stream-index":"011"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["kind","activity_id","user_id"],"type":"object"},"EntityCreator":{"properties":{"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"001.046"},"ban_count":{"format":"int32","type":"integer","x-stream-index":"002"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"001.017"},"banned":{"type":"boolean","x-stream-index":"001.016"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.013"},"deleted_content_count":{"format":"int32","type":"integer","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"001.023"},"language":{"type":"string","x-stream-index":"001.035"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"001.022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"001.026"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.042"},"role":{"type":"string","x-stream-index":"001.004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.005"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.009"}},"required":["id","role","teams_role","custom","banned","online","ban_count","deleted_content_count"],"type":"object"},"EntityCreatorResponse":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.001.018"},"ban_count":{"description":"Number of minor actions performed on the user","format":"int32","title":"Ban Count","type":"integer","x-stream-index":"002"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"001.003"},"banned":{"type":"boolean","x-stream-index":"001.001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.001.017"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.001.016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.001.011"},"deleted_content_count":{"description":"Number of major actions performed on the user","format":"int32","title":"Deleted Content Count","type":"integer","x-stream-index":"003"},"devices":{"items":{"$ref":"#/components/schemas/DeviceResponse"},"type":"array","x-stream-index":"001.006"},"flagged_count":{"description":"Number of flag actions performed on the user","format":"int32","title":"Flagged Count","type":"integer","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001.001.001"},"image":{"type":"string","x-stream-index":"001.001.003"},"invisible":{"type":"boolean","x-stream-index":"001.007"},"language":{"type":"string","x-stream-index":"001.001.005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"001.001.014"},"name":{"type":"string","x-stream-index":"001.001.002"},"online":{"type":"boolean","x-stream-index":"001.001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"001.005"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettingsResponse","x-stream-index":"001.004"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.001.015"},"role":{"type":"string","x-stream-index":"001.001.006"},"shadow_banned":{"type":"boolean","x-stream-index":"001.002"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.001.008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids","shadow_banned","invisible","ban_count","deleted_content_count","flagged_count"],"type":"object"},"ErrorResult":{"properties":{"stacktrace":{"type":"string","x-stream-index":"003"},"type":{"type":"string","x-stream-index":"001"},"version":{"type":"string","x-stream-index":"004"}},"required":["type","description"],"type":"object"},"EventHook":{"nullable":true,"properties":{"callback":{"$ref":"#/components/schemas/AsyncModerationCallbackConfig","x-stream-index":"019.001.002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"020"},"enabled":{"type":"boolean","x-stream-index":"003"},"event_types":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"hook_type":{"type":"string","x-stream-index":"002"},"id":{"type":"string","x-stream-index":"001"},"product":{"type":"string","x-stream-index":"018"},"sns_auth_type":{"type":"string","x-stream-index":"014"},"sns_key":{"type":"string","x-stream-index":"015"},"sns_region":{"type":"string","x-stream-index":"013"},"sns_role_arn":{"type":"string","x-stream-index":"017"},"sns_secret":{"type":"string","x-stream-index":"016"},"sns_topic_arn":{"type":"string","x-stream-index":"012"},"sqs_auth_type":{"type":"string","x-stream-index":"008"},"sqs_key":{"type":"string","x-stream-index":"009"},"sqs_queue_url":{"type":"string","x-stream-index":"006"},"sqs_region":{"type":"string","x-stream-index":"007"},"sqs_role_arn":{"type":"string","x-stream-index":"011"},"sqs_secret":{"type":"string","x-stream-index":"010"},"timeout_ms":{"format":"int32","type":"integer","x-stream-index":"019.001.001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"021"},"webhook_url":{"type":"string","x-stream-index":"005"}},"type":"object"},"EventNotificationSettings":{"properties":{"apns":{"$ref":"#/components/schemas/APNS","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"fcm":{"$ref":"#/components/schemas/FCM","x-stream-index":"003"}},"required":["enabled","apns","fcm"],"type":"object"},"EventRequest":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"parent_id":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"required":["type"],"type":"object"},"EventResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"event":{"$ref":"#/components/schemas/WSEvent","x-stream-index":"001"}},"required":["event","duration"],"title":"Response","type":"object"},"ExportChannelsRequest":{"nullable":true,"properties":{"channels":{"description":"Export options for channels","items":{"$ref":"#/components/schemas/ChannelExport"},"maximum":100,"minimum":1,"title":"Channels","type":"array","x-stream-index":"002.001"},"clear_deleted_message_text":{"description":"Set if deleted message text should be cleared","title":"Clear deleted message text","type":"boolean","x-stream-index":"002.002"},"export_users":{"type":"boolean","x-stream-index":"002.005"},"include_soft_deleted_channels":{"description":"Set if you want to include deleted channels","title":"Include soft deleted channels","type":"boolean","x-stream-index":"002.004"},"include_truncated_messages":{"description":"Set if you want to include truncated messages","title":"Include truncated messages","type":"boolean","x-stream-index":"002.003"},"version":{"description":"Export version","title":"Version","type":"string","x-stream-index":"001"}},"required":["channels"],"type":"object"},"ExportChannelsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"task_id":{"description":"ID of the task to export channels","title":"Task ID","type":"string","x-stream-index":"001"}},"required":["task_id","duration"],"type":"object"},"ExportFeedUserDataRequest":{"description":"Request for exporting feed user data","nullable":true,"type":"object"},"ExportFeedUserDataResponse":{"description":"Response for exporting feed user data","nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"task_id":{"description":"The task ID for the export task","title":"Task ID","type":"string","x-stream-index":"001"}},"required":["task_id","duration"],"type":"object"},"ExportUserResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"004.001"},"messages":{"description":"List of exported messages","items":{"$ref":"#/components/schemas/MessageResponse"},"title":"Messages","type":"array","x-stream-index":"002"},"reactions":{"description":"List of exported reactions","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Reactions","type":"array","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Exported user object","title":"User","x-stream-index":"001"}},"required":["duration"],"type":"object"},"ExportUsersRequest":{"nullable":true,"properties":{"user_ids":{"items":{"type":"string"},"maximum":25,"minimum":1,"type":"array","x-stream-index":"001"}},"required":["user_ids"],"type":"object"},"ExportUsersResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"task_id":{"type":"string","x-stream-index":"001"}},"required":["task_id","duration"],"title":"Response","type":"object"},"ExternalStorage":{"properties":{"abs_account_name":{"type":"string","x-stream-index":"011"},"abs_client_id":{"type":"string","x-stream-index":"013"},"abs_client_secret":{"type":"string","x-stream-index":"014"},"abs_tenant_id":{"type":"string","x-stream-index":"012"},"bucket":{"type":"string","x-stream-index":"005"},"gcs_credentials":{"type":"string","x-stream-index":"010"},"path":{"type":"string","x-stream-index":"006"},"s3_api_key":{"type":"string","x-stream-index":"007"},"s3_custom_endpoint":{"type":"string","x-stream-index":"016"},"s3_region":{"type":"string","x-stream-index":"009"},"s3_secret_key":{"type":"string","x-stream-index":"008"},"storage_name":{"type":"string","x-stream-index":"015"},"storage_type":{"type":"integer","x-stream-index":"004"}},"type":"object"},"ExternalStorageResponse":{"properties":{"bucket":{"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"path":{"type":"string","x-stream-index":"004"},"type":{"enum":["s3","gcs","abs"],"type":"string","x-stream-index":"002"}},"required":["name","type","bucket","path"],"type":"object"},"FCM":{"properties":{"data":{"additionalProperties":{},"type":"object","x-stream-index":"001"}},"type":"object"},"FeedCreatedEvent":{"description":"Emitted when a feed is created.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"003.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.001.007"},"feed":{"$ref":"#/components/schemas/FeedResponse","description":"The feed that was created","title":"Feed","x-stream-index":"001"},"feed_visibility":{"type":"string","x-stream-index":"003.003"},"fid":{"type":"string","x-stream-index":"003.002"},"members":{"items":{"$ref":"#/components/schemas/FeedMemberResponse"},"type":"array","x-stream-index":"002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.001.004"},"type":{"default":"feeds.feed.created","description":"The type of event: \"feeds.feed.created\" in this case","title":"Event Type","type":"string","x-stream-index":"003.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who created the feed","title":"User","x-stream-index":"004.001"}},"required":["feed","members","type","created_at","custom","fid","user"],"title":"FeedCreatedEvent","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"},"FeedDeletedEvent":{"description":"Emitted when a feed is deleted.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.007"},"feed_visibility":{"type":"string","x-stream-index":"001.003"},"fid":{"type":"string","x-stream-index":"001.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"type":{"default":"feeds.feed.deleted","description":"The type of event: \"feeds.feed.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who deleted the feed","title":"User","x-stream-index":"002.001"}},"required":["type","created_at","custom","fid"],"title":"FeedDeletedEvent","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"},"FeedGroup":{"properties":{"ActivityProcessors":{"items":{"$ref":"#/components/schemas/ActivityProcessorConfig"},"type":"array","writeOnly":true,"x-stream-index":"012"},"ActivitySelectors":{"items":{"$ref":"#/components/schemas/ActivitySelectorConfig"},"type":"array","writeOnly":true,"x-stream-index":"013"},"Aggregation":{"$ref":"#/components/schemas/AggregationConfig","x-stream-index":"015"},"AggregationVersion":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"016"},"AppPK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"002"},"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"007"},"DefaultVisibility":{"type":"string","writeOnly":true,"x-stream-index":"006"},"DeletedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"010"},"ID":{"type":"string","writeOnly":true,"x-stream-index":"003"},"LastFeedGetAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"017"},"Notification":{"$ref":"#/components/schemas/NotificationConfig","x-stream-index":"004"},"PushNotification":{"$ref":"#/components/schemas/PushNotificationConfig","x-stream-index":"005"},"Ranking":{"$ref":"#/components/schemas/RankingConfig","x-stream-index":"014"},"Stories":{"$ref":"#/components/schemas/StoriesConfig","x-stream-index":"011"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"}},"required":["AppPK","ID","DefaultVisibility","Custom","created_at","updated_at","ActivityProcessors","ActivitySelectors","AggregationVersion"],"type":"object"},"FeedGroupChangedEvent":{"description":"Emitted when a feed group is changed.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.007"},"feed_group":{"$ref":"#/components/schemas/FeedGroup","description":"The feed group that was changed","title":"Feed Type","x-stream-index":"003"},"feed_visibility":{"type":"string","x-stream-index":"001.003"},"fid":{"type":"string","x-stream-index":"001.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"type":{"default":"feeds.feed_group.changed","description":"The type of event: \"feeds.feed_group.changed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who changed the feed group","title":"User","x-stream-index":"002.001"}},"required":["type","created_at","custom","fid"],"title":"FeedGroupChangedEvent","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"},"FeedGroupDeletedEvent":{"description":"Emitted when a feed group is deleted.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"type":"string","x-stream-index":"002.002"},"group_id":{"description":"The ID of the feed group that was deleted","title":"Group ID","type":"string","x-stream-index":"001"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.feed_group.deleted","description":"The type of event: \"feeds.feed_group.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"}},"required":["group_id","type","created_at","custom","fid"],"title":"FeedGroupDeletedEvent","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"},"FeedGroupResponse":{"properties":{"activity_processors":{"description":"Configuration for activity processors","items":{"$ref":"#/components/schemas/ActivityProcessorConfig"},"title":"Activity Processors","type":"array","x-stream-index":"009"},"activity_selectors":{"description":"Configuration for activity selectors","items":{"$ref":"#/components/schemas/ActivitySelectorConfig"},"title":"Activity Selectors","type":"array","x-stream-index":"010"},"aggregation":{"$ref":"#/components/schemas/AggregationConfig","description":"Configuration for activity aggregation","title":"Aggregation","x-stream-index":"012"},"created_at":{"description":"When the feed group was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"006"},"custom":{"additionalProperties":{},"description":"Custom data for the feed group","title":"Custom Data","type":"object","x-stream-index":"005"},"default_visibility":{"description":"Default visibility for activities","title":"Default Visibility","type":"string","x-stream-index":"004"},"id":{"description":"Identifier within the group","title":"Feed Group ID","type":"string","x-stream-index":"001"},"notification":{"$ref":"#/components/schemas/NotificationConfig","description":"Configuration for notifications","title":"Notification","x-stream-index":"002"},"push_notification":{"$ref":"#/components/schemas/PushNotificationConfig","x-stream-index":"003"},"ranking":{"$ref":"#/components/schemas/RankingConfig","description":"Configuration for activity ranking","title":"Ranking","x-stream-index":"011"},"stories":{"$ref":"#/components/schemas/StoriesConfig","description":"Configuration for stories feature","title":"Stories","x-stream-index":"008"},"updated_at":{"description":"When the feed group was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"007"}},"required":["id","created_at","updated_at"],"title":"Feed Group","type":"object"},"FeedInput":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"description":{"maxLength":1000,"type":"string","x-stream-index":"002"},"filter_tags":{"items":{"type":"string"},"maximum":255,"type":"array","x-stream-index":"005"},"members":{"items":{"$ref":"#/components/schemas/FeedMemberRequest"},"type":"array","x-stream-index":"006"},"name":{"maxLength":255,"type":"string","x-stream-index":"001"},"visibility":{"enum":["public","visible","followers","members","private"],"type":"string","x-stream-index":"003"}},"type":"object"},"FeedMemberAddedEvent":{"description":"Emitted when a feed member is added.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"003.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.001.007"},"feed_visibility":{"type":"string","x-stream-index":"003.003"},"fid":{"type":"string","x-stream-index":"003.002"},"member":{"$ref":"#/components/schemas/FeedMemberResponse","description":"The member that was added","title":"Member","x-stream-index":"001"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.001.004"},"type":{"default":"feeds.feed_member.added","description":"The type of event: \"feeds.feed_member.added\" in this case","title":"Event Type","type":"string","x-stream-index":"003.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who added the member","title":"User","x-stream-index":"002.001"}},"required":["member","type","created_at","custom","fid"],"title":"FeedMemberAddedEvent","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"},"FeedMemberRemovedEvent":{"description":"Emitted when a feed member is removed.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"003.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.001.007"},"feed_visibility":{"type":"string","x-stream-index":"003.003"},"fid":{"type":"string","x-stream-index":"003.002"},"member_id":{"type":"string","x-stream-index":"001"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.001.004"},"type":{"default":"feeds.feed_member.removed","description":"The type of event: \"feeds.feed_member.removed\" in this case","title":"Event Type","type":"string","x-stream-index":"003.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who removed the member","title":"User","x-stream-index":"002.001"}},"required":["member_id","type","created_at","custom","fid"],"title":"FeedMemberRemovedEvent","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"},"FeedMemberRequest":{"properties":{"custom":{"additionalProperties":{},"description":"Custom data for the member","title":"Custom Data","type":"object","x-stream-index":"004"},"invite":{"description":"Whether this is an invite to become a member","title":"Invite","type":"boolean","x-stream-index":"005"},"membership_level":{"description":"ID of the membership level to assign to the member","maxLength":255,"title":"Membership Level","type":"string","x-stream-index":"003"},"role":{"description":"Role of the member in the feed","maxLength":255,"title":"Role","type":"string","x-stream-index":"002"},"user_id":{"description":"ID of the user to add as a member","maxLength":255,"title":"User ID","type":"string","x-stream-index":"001"}},"required":["user_id"],"title":"Feed Member Payload","type":"object"},"FeedMemberResponse":{"properties":{"created_at":{"description":"When the membership was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"description":"Custom data for the membership","title":"Custom Data","type":"object","x-stream-index":"007"},"invite_accepted_at":{"description":"When the invite was accepted","format":"date-time","title":"Invite Accepted At","type":"number","x-stream-index":"005"},"invite_rejected_at":{"description":"When the invite was rejected","format":"date-time","title":"Invite Rejected At","type":"number","x-stream-index":"006"},"membership_level":{"$ref":"#/components/schemas/MembershipLevelResponse","description":"Membership level assigned to the member","title":"Membership Level","x-stream-index":"004"},"role":{"description":"Role of the member in the feed","title":"Role","type":"string","x-stream-index":"002"},"status":{"description":"Status of the membership","enum":["member","pending","rejected"],"title":"Status","type":"string","x-stream-index":"003"},"updated_at":{"description":"When the membership was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who is a member","title":"User","x-stream-index":"001"}},"required":["user","role","status","created_at","updated_at"],"title":"Feed Member","type":"object"},"FeedMemberUpdatedEvent":{"description":"Emitted when a feed member is updated.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"003.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.001.007"},"feed_visibility":{"type":"string","x-stream-index":"003.003"},"fid":{"type":"string","x-stream-index":"003.002"},"member":{"$ref":"#/components/schemas/FeedMemberResponse","description":"The member that was updated","title":"Member","x-stream-index":"001"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.001.004"},"type":{"default":"feeds.feed_member.updated","description":"The type of event: \"feeds.feed_member.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"003.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who updated the member","title":"User","x-stream-index":"002.001"}},"required":["member","type","created_at","custom","fid"],"title":"FeedMemberUpdatedEvent","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"},"FeedOwnCapability":{"description":"All possibility of string to use","enum":["add-activity","add-activity-reaction","add-comment","add-comment-reaction","bookmark-activity","create-feed","delete-bookmark","delete-comment","delete-feed","edit-bookmark","follow","invite-feed","join-feed","leave-feed","manage-feed-group","mark-activity","pin-activity","query-feed-members","query-follows","read-activities","read-feed","remove-activity","remove-activity-reaction","remove-comment-reaction","unfollow","update-activity","update-comment","update-feed","update-feed-followers","update-feed-members"],"title":"FeedOwnCapability","type":"string"},"FeedRequest":{"properties":{"created_by_id":{"description":"ID of the feed creator","title":"Created By ID","type":"string","x-stream-index":"003"},"custom":{"additionalProperties":{},"description":"Custom data for the feed","title":"Custom Data","type":"object","x-stream-index":"004.004"},"description":{"description":"Description of the feed","maxLength":1000,"title":"Description","type":"string","x-stream-index":"004.002"},"feed_group_id":{"description":"ID of the feed group","maxLength":255,"title":"Feed Group ID","type":"string","x-stream-index":"001"},"feed_id":{"description":"ID of the feed","maxLength":255,"title":"Feed ID","type":"string","x-stream-index":"002"},"filter_tags":{"description":"Tags used for filtering feeds","items":{"type":"string"},"maximum":255,"title":"Filter Tags","type":"array","x-stream-index":"004.005"},"members":{"description":"Initial members for the feed","items":{"$ref":"#/components/schemas/FeedMemberRequest"},"title":"Members","type":"array","x-stream-index":"004.006"},"name":{"description":"Name of the feed","maxLength":255,"title":"Name","type":"string","x-stream-index":"004.001"},"visibility":{"description":"Visibility setting for the feed","enum":["public","visible","followers","members","private"],"title":"Visibility","type":"string","x-stream-index":"004.003"}},"required":["feed_group_id","feed_id"],"title":"Feed Payload","type":"object"},"FeedResponse":{"properties":{"created_at":{"description":"When the feed was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"015"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"User who created the feed","title":"Created By","x-stream-index":"009"},"custom":{"additionalProperties":{},"description":"Custom data for the feed","title":"Custom Data","type":"object","x-stream-index":"006"},"deleted_at":{"description":"When the feed was deleted","format":"date-time","title":"Deleted At","type":"number","x-stream-index":"017"},"description":{"description":"Description of the feed","title":"Description","type":"string","x-stream-index":"005"},"feed":{"description":"Fully qualified feed ID (group_id:id)","title":"FID","type":"string","x-stream-index":"003"},"filter_tags":{"description":"Tags used for filtering feeds","items":{"type":"string"},"title":"Filter Tags","type":"array","x-stream-index":"007"},"follower_count":{"description":"Number of followers of this feed","format":"int32","title":"Follower Count","type":"integer","x-stream-index":"011"},"following_count":{"description":"Number of feeds this feed follows","format":"int32","title":"Following Count","type":"integer","x-stream-index":"012"},"group_id":{"description":"Group this feed belongs to","title":"Group ID","type":"string","x-stream-index":"001"},"id":{"description":"Unique identifier for the feed","title":"ID","type":"string","x-stream-index":"002"},"member_count":{"description":"Number of members in this feed","format":"int32","title":"Member Count","type":"integer","x-stream-index":"010"},"name":{"description":"Name of the feed","title":"Name","type":"string","x-stream-index":"004"},"own_follows":{"description":"Follow relationships where the current user's feeds are following this feed","items":{"$ref":"#/components/schemas/FollowResponse"},"title":"Own Follows","type":"array","x-stream-index":"014"},"pin_count":{"description":"Number of pinned activities in this feed","format":"int32","title":"Pin Count","type":"integer","x-stream-index":"013"},"updated_at":{"description":"When the feed was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"016"},"visibility":{"description":"Visibility setting for the feed","title":"Visibility","type":"string","x-stream-index":"008"}},"required":["group_id","id","feed","name","description","created_by","member_count","follower_count","following_count","pin_count","created_at","updated_at"],"title":"Feed","type":"object"},"FeedUpdatedEvent":{"description":"Emitted when a feed is created.","nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed":{"$ref":"#/components/schemas/FeedResponse","description":"The feed that was created","title":"Feed","x-stream-index":"001"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"type":"string","x-stream-index":"002.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.feed.updated","description":"The type of event: \"feeds.feed.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who created the feed","title":"User","x-stream-index":"003.001"}},"required":["feed","type","created_at","custom","fid"],"title":"FeedUpdatedEvent","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"},"FeedViewResponse":{"properties":{"activity_processors":{"description":"Configured activity processors","items":{"$ref":"#/components/schemas/ActivityProcessorConfig"},"title":"Activity Processors","type":"array","x-stream-index":"003"},"activity_selectors":{"description":"Configured activity selectors","items":{"$ref":"#/components/schemas/ActivitySelectorConfig"},"title":"Activity Selectors","type":"array","x-stream-index":"002"},"aggregation":{"$ref":"#/components/schemas/AggregationConfig","description":"Configuration for activity aggregation","title":"Aggregation","x-stream-index":"005"},"id":{"description":"Unique identifier for the custom feed view","title":"View ID","type":"string","x-stream-index":"001"},"last_used_at":{"description":"When the feed view was last used","format":"date-time","title":"Last Used At","type":"number","x-stream-index":"006"},"ranking":{"$ref":"#/components/schemas/RankingConfig","description":"Configuration for activity ranking","title":"Ranking","x-stream-index":"004"}},"required":["id"],"title":"Feed View","type":"object"},"FeedsEventPreferences":{"properties":{"comments":{"type":"string","x-stream-index":"002"},"mentions":{"type":"string","x-stream-index":"004"},"new_followers":{"type":"string","x-stream-index":"003"},"reactions":{"type":"string","x-stream-index":"001"}},"type":"object"},"FeedsEventPreferencesInput":{"properties":{"comments":{"enum":["all","none"],"type":"string","x-stream-index":"002"},"mentions":{"enum":["all","none"],"type":"string","x-stream-index":"004"},"new_followers":{"enum":["all","none"],"type":"string","x-stream-index":"003"},"reactions":{"enum":["all","none"],"type":"string","x-stream-index":"001"}},"type":"object"},"FeedsModerationTemplateConfig":{"properties":{"config_key":{"type":"string","x-stream-index":"002"},"data_types":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001"}},"required":["data_types","config_key"],"type":"object"},"FeedsReactionResponse":{"properties":{"activity_id":{"description":"ID of the activity that was reacted to","title":"Activity ID","type":"string","x-stream-index":"002"},"comment_id":{"description":"ID of the comment that was reacted to","title":"Comment ID","type":"string","x-stream-index":"003"},"created_at":{"description":"When the reaction was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"006"},"custom":{"additionalProperties":{},"description":"Custom data for the reaction","title":"Custom Data","type":"object","x-stream-index":"005"},"type":{"description":"Type of reaction","title":"Type","type":"string","x-stream-index":"004"},"updated_at":{"description":"When the reaction was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"007"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who created the reaction","title":"User","x-stream-index":"001"}},"required":["user","activity_id","type","created_at","updated_at"],"title":"Activity Reaction","type":"object"},"Field":{"nullable":true,"properties":{"short":{"type":"boolean","x-stream-index":"003"},"title":{"type":"string","x-stream-index":"001"},"value":{"type":"string","x-stream-index":"002"}},"required":["title","value","short"],"type":"object"},"FileUploadConfig":{"properties":{"allowed_file_extensions":{"items":{"type":"string"},"type":"array","x-stream-index":"001"},"allowed_mime_types":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"blocked_file_extensions":{"items":{"type":"string"},"type":"array","x-stream-index":"002"},"blocked_mime_types":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"size_limit":{"format":"int32","maximum":104857600,"minimum":0,"type":"integer","x-stream-index":"005"}},"required":["size_limit"],"type":"object"},"FileUploadRequest":{"nullable":true,"properties":{"file":{"description":"file field","title":"File","type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/OnlyUserID","description":"user for the request **server side only**","title":"User","x-stream-index":"002"}},"type":"object"},"FileUploadResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"file":{"description":"URL to the uploaded asset. Should be used to put to `asset_url` attachment field","title":"File","type":"string","x-stream-index":"001"},"thumb_url":{"description":"URL of the file thumbnail for supported file formats. Should be put to `thumb_url` attachment field","title":"Thumbnail URL","type":"string","x-stream-index":"002"}},"required":["duration"],"type":"object"},"FirebaseConfig":{"properties":{"Disabled":{"type":"boolean","writeOnly":true,"x-stream-index":"001"},"apn_template":{"type":"string","x-stream-index":"005"},"credentials_json":{"type":"string","x-stream-index":"006"},"data_template":{"type":"string","x-stream-index":"004"},"notification_template":{"type":"string","x-stream-index":"003"},"server_key":{"type":"string","x-stream-index":"002"}},"type":"object"},"FirebaseConfigFields":{"properties":{"apn_template":{"type":"string","x-stream-index":"004"},"credentials_json":{"type":"string","x-stream-index":"006"},"data_template":{"type":"string","x-stream-index":"003"},"enabled":{"type":"boolean","x-stream-index":"001"},"notification_template":{"type":"string","x-stream-index":"002"},"server_key":{"type":"string","x-stream-index":"005"}},"required":["enabled"],"type":"object"},"Flag":{"description":"Contains information about flagged user or message","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"019"},"custom":{"additionalProperties":{},"description":"Additional metadata about the flag","title":"Custom","type":"object","x-stream-index":"014"},"entity_creator_id":{"description":"ID of the user who created the flagged entity","title":"Entity Creator ID","type":"string","x-stream-index":"009"},"entity_id":{"description":"Unique identifier of the entity being flagged","title":"Entity ID","type":"string","x-stream-index":"008"},"entity_type":{"description":"Type of entity being flagged (e.g., message, user)","title":"Entity Type","type":"string","x-stream-index":"007"},"is_streamed_content":{"type":"boolean","x-stream-index":"012"},"labels":{"description":"Labels from bodyguard, API calls, our own AI etc","items":{"type":"string"},"title":"Labels","type":"array","x-stream-index":"015"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content being flagged","title":"Moderation Payload","x-stream-index":"010"},"moderation_payload_hash":{"type":"string","x-stream-index":"011"},"reason":{"description":"Optional explanation for why the content is being flagged","title":"Reason","type":"string","x-stream-index":"013"},"result":{"description":"Result of bodyguard, API calls, our own AI etc","items":{"additionalProperties":{},"type":"object"},"title":"Result","type":"array","x-stream-index":"016"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"018"},"review_queue_item_id":{"description":"ID of the review queue item","title":"Review Queue Item ID","type":"string","x-stream-index":"017"},"type":{"type":"string","x-stream-index":"004"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"020"},"user":{"$ref":"#/components/schemas/User","description":"User who flagged a message or a user","title":"User","x-stream-index":"006"}},"required":["entity_type","entity_id","result","created_at","updated_at"],"title":"Flag","type":"object"},"FlagContentOptions":{"properties":{"reason":{"type":"string","x-stream-index":"001"}},"type":"object"},"FlagDetails":{"properties":{"Extra":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"002"},"automod":{"$ref":"#/components/schemas/AutomodDetails","x-stream-index":"001"},"original_text":{"type":"string","x-stream-index":"003"}},"required":["Extra","original_text"],"type":"object"},"FlagFeedback":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"005"},"labels":{"items":{"$ref":"#/components/schemas/Label"},"type":"array","x-stream-index":"006"},"message_id":{"type":"string","x-stream-index":"004"}},"required":["message_id","created_at","labels"],"type":"object"},"FlagMessageDetails":{"properties":{"pin_changed":{"type":"boolean","x-stream-index":"002"},"should_enrich":{"type":"boolean","x-stream-index":"003"},"skip_push":{"type":"boolean","x-stream-index":"004"},"updated_by_id":{"type":"string","x-stream-index":"001"}},"type":"object"},"FlagRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"description":"Additional metadata about the flag","title":"Custom","type":"object","x-stream-index":"006"},"entity_creator_id":{"description":"ID of the user who created the flagged entity","title":"Entity Creator ID","type":"string","x-stream-index":"003"},"entity_id":{"description":"Unique identifier of the entity being flagged","title":"Entity ID","type":"string","x-stream-index":"002"},"entity_type":{"description":"Type of entity being flagged (e.g., message, user)","title":"Entity Type","type":"string","x-stream-index":"001"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content being flagged","title":"Moderation Payload","x-stream-index":"005"},"reason":{"description":"Optional explanation for why the content is being flagged","maxLength":255,"title":"Reason","type":"string","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"007.002"},"user_id":{"type":"string","x-stream-index":"007.001"}},"required":["entity_type","entity_id"],"type":"object"},"FlagResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"item_id":{"description":"Unique identifier of the created moderation item","title":"Item ID","type":"string","x-stream-index":"001"}},"required":["item_id","duration"],"type":"object"},"FlagUpdatedEvent":{"nullable":true,"properties":{"CreatedBy":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"004"},"Message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"002"},"User":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"type":{"default":"flag.updated","type":"string","x-stream-index":"001.002"}},"required":["type","created_at","custom"],"title":"FlagUpdatedEvent","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"},"FlagUserOptions":{"properties":{"reason":{"type":"string","x-stream-index":"001"}},"type":"object"},"FollowBatchRequest":{"nullable":true,"properties":{"follows":{"description":"List of follow relationships to create","items":{"$ref":"#/components/schemas/FollowRequest"},"maximum":1000,"minimum":1,"title":"Follows","type":"array","x-stream-index":"001"}},"required":["follows"],"title":"Follow Batch Request","type":"object"},"FollowBatchResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"follows":{"description":"List of created follow relationships","items":{"$ref":"#/components/schemas/FollowResponse"},"title":"Follows","type":"array","x-stream-index":"001"}},"required":["follows","duration"],"title":"Follow Batch Response","type":"object"},"FollowCreatedEvent":{"description":"Emitted when a feed follows another feed.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"type":"string","x-stream-index":"002.002"},"follow":{"$ref":"#/components/schemas/FollowResponse","x-stream-index":"001"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.follow.created","description":"The type of event: \"feeds.follow.created\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"}},"required":["follow","type","created_at","custom","fid"],"title":"FollowCreatedEvent","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"},"FollowDeletedEvent":{"description":"Emitted when a feed unfollows another feed.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"type":"string","x-stream-index":"002.002"},"follow":{"$ref":"#/components/schemas/FollowResponse","x-stream-index":"001"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.follow.deleted","description":"The type of event: \"feeds.follow.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"}},"required":["follow","type","created_at","custom","fid"],"title":"FollowDeletedEvent","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"},"FollowPair":{"properties":{"source":{"description":"Fully qualified ID of the source feed","maxLength":255,"title":"Source Feed","type":"string","x-stream-index":"001"},"target":{"description":"Fully qualified ID of the target feed","maxLength":255,"title":"Target Feed","type":"string","x-stream-index":"002"}},"required":["source","target"],"title":"FollowPair","type":"object"},"FollowRequest":{"nullable":true,"properties":{"create_notification_activity":{"description":"Whether to create a notification activity for this follow","title":"Create Notification Activity","type":"boolean","x-stream-index":"004"},"custom":{"additionalProperties":{},"description":"Custom data for the follow relationship","title":"Custom Data","type":"object","x-stream-index":"002"},"push_preference":{"description":"Push preference for the follow relationship","enum":["all","none"],"title":"Push Preference","type":"string","x-stream-index":"003"},"skip_push":{"type":"boolean","x-stream-index":"005"},"source":{"description":"Fully qualified ID of the source feed","maxLength":255,"title":"Source Feed","type":"string","x-stream-index":"001.001"},"target":{"description":"Fully qualified ID of the target feed","maxLength":255,"title":"Target Feed","type":"string","x-stream-index":"001.002"}},"required":["source","target"],"title":"Follow Request","type":"object"},"FollowResponse":{"properties":{"created_at":{"description":"When the follow relationship was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"009"},"custom":{"additionalProperties":{},"description":"Custom data for the follow relationship","title":"Custom Data","type":"object","x-stream-index":"004"},"follower_role":{"description":"Role of the follower (source user) in the follow relationship","title":"Follower Role","type":"string","x-stream-index":"008"},"push_preference":{"description":"Push preference for notifications","enum":["all","none"],"title":"Push Preference","type":"string","x-stream-index":"003"},"request_accepted_at":{"description":"When the follow request was accepted","format":"date-time","title":"Request Accepted At","type":"number","x-stream-index":"005"},"request_rejected_at":{"description":"When the follow request was rejected","format":"date-time","title":"Request Rejected At","type":"number","x-stream-index":"006"},"source_feed":{"$ref":"#/components/schemas/FeedResponse","description":"Source feed object","title":"Source Feed","x-stream-index":"001"},"status":{"description":"Status of the follow relationship","enum":["accepted","pending","rejected"],"title":"Status","type":"string","x-stream-index":"007"},"target_feed":{"$ref":"#/components/schemas/FeedResponse","description":"Target feed object","title":"Target Feed","x-stream-index":"002"},"updated_at":{"description":"When the follow relationship was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"010"}},"required":["source_feed","target_feed","push_preference","status","follower_role","created_at","updated_at"],"title":"Follow","type":"object"},"FollowUpdatedEvent":{"description":"Emitted when a follow relationship is updated.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"type":"string","x-stream-index":"002.002"},"follow":{"$ref":"#/components/schemas/FollowResponse","x-stream-index":"001"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.follow.updated","description":"The type of event: \"feeds.follow.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"}},"required":["follow","type","created_at","custom","fid"],"title":"FollowUpdatedEvent","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"},"FrameRecordSettings":{"properties":{"capture_interval_in_seconds":{"format":"int32","maximum":60,"minimum":2,"type":"integer","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"},"quality":{"type":"string","x-stream-index":"002"}},"required":["mode","capture_interval_in_seconds"],"type":"object"},"FrameRecordingEgressConfig":{"properties":{"capture_interval_in_seconds":{"format":"int32","type":"integer","x-stream-index":"007"},"external_storage":{"$ref":"#/components/schemas/ExternalStorage","x-stream-index":"006"},"quality":{"$ref":"#/components/schemas/Quality","x-stream-index":"004"},"storage_name":{"type":"string","x-stream-index":"005"}},"type":"object"},"FrameRecordingResponse":{"properties":{"status":{"type":"string","x-stream-index":"001"}},"required":["status"],"type":"object"},"FrameRecordingSettingsRequest":{"properties":{"capture_interval_in_seconds":{"format":"int32","maximum":60,"minimum":2,"type":"integer","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"},"quality":{"enum":["360p","480p","720p","1080p","1440p"],"type":"string","x-stream-index":"002"}},"required":["mode","capture_interval_in_seconds"],"type":"object"},"FrameRecordingSettingsResponse":{"properties":{"capture_interval_in_seconds":{"format":"int32","maximum":60,"minimum":2,"type":"integer","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"},"quality":{"type":"string","x-stream-index":"002"}},"required":["mode","capture_interval_in_seconds"],"type":"object"},"FullUserResponse":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"015"},"banned":{"type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"014"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.011"},"devices":{"items":{"$ref":"#/components/schemas/DeviceResponse"},"type":"array","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001.001"},"image":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"005"},"language":{"type":"string","x-stream-index":"001.005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"001.014"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"012"},"mutes":{"items":{"$ref":"#/components/schemas/UserMuteResponse"},"type":"array","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"001.002"},"online":{"type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"003"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.015"},"role":{"type":"string","x-stream-index":"001.006"},"shadow_banned":{"type":"boolean","x-stream-index":"013"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"009"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"010"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"008"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"011"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","devices","invisible","mutes","channel_mutes","unread_count","total_unread_count","unread_channels","unread_threads","shadow_banned","blocked_user_ids"],"type":"object"},"GeofenceResponse":{"nullable":true,"properties":{"country_codes":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"description":{"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"type":{"type":"string","x-stream-index":"002"}},"required":["name"],"type":"object"},"GeofenceSettings":{"properties":{"names":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"required":["names"],"type":"object"},"GeofenceSettingsRequest":{"properties":{"names":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"type":"object"},"GeofenceSettingsResponse":{"properties":{"names":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"required":["names"],"type":"object"},"GetActiveCallsStatusResponse":{"description":"Response containing active calls status information","nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"},"end_time":{"description":"End time of the status period","format":"date-time","title":"time.Time","type":"number","x-stream-index":"003"},"metrics":{"$ref":"#/components/schemas/ActiveCallsMetrics","description":"Detailed metrics","title":"*ActiveCallsMetrics","x-stream-index":"005"},"start_time":{"description":"Start time of the status period","format":"date-time","title":"time.Time","type":"number","x-stream-index":"002"},"summary":{"$ref":"#/components/schemas/ActiveCallsSummary","description":"Summary of active calls","title":"*ActiveCallsSummary","x-stream-index":"004"}},"required":["duration","start_time","end_time"],"title":"GetActiveCallsStatusResponse","type":"object"},"GetActivityResponse":{"nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","description":"The requested activity","title":"Activity","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["activity","duration"],"title":"Get Activity Response","type":"object"},"GetApplicationResponse":{"description":"Basic response information","nullable":true,"properties":{"app":{"$ref":"#/components/schemas/AppResponseFields","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["app","duration"],"title":"Response","type":"object"},"GetBlockListResponse":{"description":"Response for get block list","nullable":true,"properties":{"blocklist":{"$ref":"#/components/schemas/BlockListResponse","description":"Block list object","title":"BlockListResponse","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["duration"],"title":"GetBlockListResponse","type":"object","x-stream-docs-page-id":"get_block_list"},"GetBlockedUsersResponse":{"nullable":true,"properties":{"blocks":{"description":"Array of blocked user object","items":{"$ref":"#/components/schemas/BlockedUserResponse"},"title":"Blocks","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["blocks","duration"],"type":"object"},"GetCallReportResponse":{"description":"Basic response information","nullable":true,"properties":{"chat_activity":{"$ref":"#/components/schemas/ChatActivityStatsResponse","x-stream-index":"004"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"report":{"$ref":"#/components/schemas/ReportResponse","x-stream-index":"003"},"session_id":{"type":"string","x-stream-index":"002"},"video_reactions":{"items":{"$ref":"#/components/schemas/VideoReactionsResponse"},"type":"array","x-stream-index":"005"}},"required":["duration","session_id","report"],"title":"Response","type":"object"},"GetCallResponse":{"nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001.001"},"duration":{"type":"string","x-stream-index":"002.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001.002"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"001.004"}},"required":["call","members","own_capabilities","blocked_users","duration"],"title":"GetCallResponse","type":"object"},"GetCallTypeResponse":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.005"},"duration":{"type":"string","x-stream-index":"002.001"},"external_storage":{"type":"string","x-stream-index":"001.007"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"001.002"},"name":{"type":"string","x-stream-index":"001.001"},"notification_settings":{"$ref":"#/components/schemas/NotificationSettings","x-stream-index":"001.004"},"settings":{"$ref":"#/components/schemas/CallSettingsResponse","x-stream-index":"001.003"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.006"}},"required":["name","grants","settings","notification_settings","created_at","updated_at","duration"],"title":"GetCallTypeResponse","type":"object"},"GetCampaignResponse":{"description":"Basic response information","nullable":true,"properties":{"campaign":{"$ref":"#/components/schemas/CampaignResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"users":{"$ref":"#/components/schemas/PagerResponse","x-stream-index":"002"}},"required":["duration"],"title":"Response","type":"object"},"GetChannelTypeResponse":{"description":"Basic response information","nullable":true,"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"003.002.027"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"003.002.022"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.002.023"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"003.002.028"},"blocklist":{"type":"string","x-stream-index":"003.002.024"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.002.025"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"003.002.026"},"commands":{"items":{"$ref":"#/components/schemas/Command"},"type":"array","x-stream-index":"003.003"},"connect_events":{"type":"boolean","x-stream-index":"003.002.004"},"count_messages":{"type":"boolean","x-stream-index":"003.002.019"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.001.003"},"custom_events":{"type":"boolean","x-stream-index":"003.002.012"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"004.001"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"002"},"mark_messages_pending":{"type":"boolean","x-stream-index":"003.002.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"003.002.021"},"mutes":{"type":"boolean","x-stream-index":"003.002.009"},"name":{"type":"string","x-stream-index":"003.002.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"003.002.029"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"003.002.030"},"permissions":{"items":{"$ref":"#/components/schemas/PolicyRequest"},"type":"array","x-stream-index":"001"},"polls":{"type":"boolean","x-stream-index":"003.002.016"},"push_notifications":{"type":"boolean","x-stream-index":"003.002.013"},"quotes":{"type":"boolean","x-stream-index":"003.002.008"},"reactions":{"type":"boolean","x-stream-index":"003.002.006"},"read_events":{"type":"boolean","x-stream-index":"003.002.003"},"reminders":{"type":"boolean","x-stream-index":"003.002.014"},"replies":{"type":"boolean","x-stream-index":"003.002.007"},"search":{"type":"boolean","x-stream-index":"003.002.005"},"shared_locations":{"type":"boolean","x-stream-index":"003.002.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"003.002.031"},"typing_events":{"type":"boolean","x-stream-index":"003.002.002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"003.001.004"},"uploads":{"type":"boolean","x-stream-index":"003.002.010"},"url_enrichment":{"type":"boolean","x-stream-index":"003.002.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"003.002.017"}},"required":["permissions","grants","created_at","updated_at","name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","count_messages","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","commands","duration"],"title":"Response","type":"object"},"GetCommandResponse":{"nullable":true,"properties":{"args":{"type":"string","x-stream-index":"001.006"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.001"},"description":{"type":"string","x-stream-index":"001.005"},"duration":{"type":"string","x-stream-index":"002.001"},"name":{"type":"string","x-stream-index":"001.004"},"set":{"type":"string","x-stream-index":"001.007"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.002"}},"required":["name","description","args","set","duration"],"title":"GetCommandResponse","type":"object"},"GetCommentRepliesResponse":{"nullable":true,"properties":{"comments":{"description":"Threaded listing of replies to the comment","items":{"$ref":"#/components/schemas/ThreadedCommentResponse"},"title":"Comments","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["comments","duration"],"title":"Get Comment Replies Response","type":"object"},"GetCommentResponse":{"nullable":true,"properties":{"comment":{"$ref":"#/components/schemas/CommentResponse","description":"Comment","title":"Comment","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["comment","duration"],"title":"Get Comment Response","type":"object"},"GetCommentsResponse":{"nullable":true,"properties":{"comments":{"description":"Threaded listing for the activity","items":{"$ref":"#/components/schemas/ThreadedCommentResponse"},"title":"Comments","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["comments","duration"],"title":"Get Comments Response","type":"object"},"GetConfigResponse":{"nullable":true,"properties":{"config":{"$ref":"#/components/schemas/ConfigResponse","description":"The retrieved moderation configuration","title":"Config","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["duration"],"type":"object"},"GetCustomPermissionResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"permission":{"$ref":"#/components/schemas/Permission","x-stream-index":"001"}},"required":["permission","duration"],"title":"Response","type":"object"},"GetDraftResponse":{"description":"Basic response information","nullable":true,"properties":{"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["draft","duration"],"title":"Response","type":"object"},"GetEdgesResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"edges":{"items":{"$ref":"#/components/schemas/EdgeResponse"},"type":"array","x-stream-index":"001"}},"required":["edges","duration"],"title":"Response","type":"object"},"GetFeedGroupResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"feed_group":{"$ref":"#/components/schemas/FeedGroupResponse","description":"The requested feed group","title":"Feed Group","x-stream-index":"001"}},"required":["feed_group","duration"],"title":"Get Feed Group Response","type":"object"},"GetFeedViewResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"feed_view":{"$ref":"#/components/schemas/FeedViewResponse","description":"The requested feed view","title":"Feed View","x-stream-index":"001"}},"required":["feed_view","duration"],"title":"Get Feed View Response","type":"object"},"GetFollowSuggestionsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"suggestions":{"description":"List of suggested feeds to follow","items":{"$ref":"#/components/schemas/FeedResponse"},"title":"Suggestions","type":"array","x-stream-index":"001"}},"required":["suggestions","duration"],"title":"Follow Suggestions Response","type":"object"},"GetImportResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"import_task":{"$ref":"#/components/schemas/ImportTask","x-stream-index":"001"}},"required":["duration"],"title":"Response","type":"object"},"GetManyMessagesResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.002.001"},"messages":{"description":"List of messages","items":{"$ref":"#/components/schemas/MessageResponse"},"title":"Messages","type":"array","x-stream-index":"001.001"}},"required":["messages","duration"],"type":"object"},"GetMessageResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageWithChannelResponse","x-stream-index":"001"},"pending_message_metadata":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"002"}},"required":["message","duration"],"title":"Response","type":"object"},"GetModerationRuleResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"rule":{"$ref":"#/components/schemas/ModerationRuleV2Response","x-stream-index":"002"}},"required":["duration"],"title":"Response","type":"object"},"GetOGResponse":{"nullable":true,"properties":{"actions":{"items":{"$ref":"#/components/schemas/Action"},"type":"array","x-stream-index":"001.015"},"asset_url":{"description":"URL of detected video or audio","title":"Image URL","type":"string","x-stream-index":"001.017"},"author_icon":{"type":"string","x-stream-index":"001.007"},"author_link":{"description":"og:site","title":"Author Link","type":"string","x-stream-index":"001.006"},"author_name":{"description":"og:site_name","title":"Author Name","type":"string","x-stream-index":"001.005"},"color":{"type":"string","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.018"},"duration":{"type":"string","x-stream-index":"002.001"},"fallback":{"type":"string","x-stream-index":"001.002"},"fields":{"items":{"$ref":"#/components/schemas/Field"},"type":"array","x-stream-index":"001.016"},"footer":{"type":"string","x-stream-index":"001.013"},"footer_icon":{"type":"string","x-stream-index":"001.014"},"giphy":{"$ref":"#/components/schemas/Images","x-stream-index":"001.019"},"image_url":{"description":"URL of detected image","title":"Image URL","type":"string","x-stream-index":"001.011"},"og_scrape_url":{"description":"extracted url from the text","title":"OG Scrape URL","type":"string","x-stream-index":"001.020"},"original_height":{"format":"int32","type":"integer","x-stream-index":"001.022"},"original_width":{"format":"int32","type":"integer","x-stream-index":"001.021"},"pretext":{"type":"string","x-stream-index":"001.004"},"text":{"description":"og:description","title":"Text","type":"string","x-stream-index":"001.010"},"thumb_url":{"description":"URL of detected thumb image","title":"Image URL","type":"string","x-stream-index":"001.012"},"title":{"description":"og:title","title":"Title","type":"string","x-stream-index":"001.008"},"title_link":{"description":"og:url","title":"Title Link","type":"string","x-stream-index":"001.009"},"type":{"description":"Attachment type, could be empty, image, audio or video","title":"Type","type":"string","x-stream-index":"001.001"}},"required":["custom","duration"],"title":"Get OG Attachment","type":"object","x-stream-docs-page-id":"og"},"GetOrCreateCallRequest":{"nullable":true,"properties":{"data":{"$ref":"#/components/schemas/CallRequest","title":"ReadOnlyData","x-stream-index":"003"},"members_limit":{"format":"int32","maximum":100,"type":"integer","x-stream-index":"007"},"notify":{"description":"if provided it sends a notification event to the members for this call","title":"Notify","type":"boolean","x-stream-index":"005"},"ring":{"description":"if provided it sends a ring event to the members for this call","title":"Ring","type":"boolean","x-stream-index":"004"},"video":{"type":"boolean","x-stream-index":"006"}},"title":"GetOrCreateCallRequest","type":"object"},"GetOrCreateCallResponse":{"nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001.001"},"created":{"type":"boolean","x-stream-index":"002"},"duration":{"type":"string","x-stream-index":"003.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001.002"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"001.004"}},"required":["call","members","own_capabilities","blocked_users","created","duration"],"title":"GetOrCreateCallResponse","type":"object"},"GetOrCreateFeedGroupRequest":{"nullable":true,"properties":{"activity_processors":{"description":"Configuration for activity processors (max 10)","items":{"$ref":"#/components/schemas/ActivityProcessorConfig"},"maximum":10,"title":"Activity Processors","type":"array","x-stream-index":"006"},"activity_selectors":{"description":"Configuration for activity selectors (max 10)","items":{"$ref":"#/components/schemas/ActivitySelectorConfig"},"maximum":10,"title":"Activity Selectors","type":"array","x-stream-index":"007"},"aggregation":{"$ref":"#/components/schemas/AggregationConfig","description":"Configuration for activity aggregation","title":"Aggregation","x-stream-index":"009"},"custom":{"additionalProperties":{},"description":"Custom data for the feed group","title":"Custom Data","type":"object","x-stream-index":"004"},"default_visibility":{"description":"Default visibility for the feed group, can be 'public', 'visible', 'followers', 'members', or 'private'. Defaults to 'visible' if not provided. ","enum":["public","visible","followers","members","private"],"title":"Default Visibility","type":"string","x-stream-index":"005"},"notification":{"$ref":"#/components/schemas/NotificationConfig","description":"Configuration for notifications","title":"Notification","x-stream-index":"002"},"push_notification":{"$ref":"#/components/schemas/PushNotificationConfig","x-stream-index":"003"},"ranking":{"$ref":"#/components/schemas/RankingConfig","description":"Configuration for activity ranking","title":"Ranking","x-stream-index":"008"}},"title":"Get Or Create Feed Group Request","type":"object"},"GetOrCreateFeedGroupResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"003.001"},"feed_group":{"$ref":"#/components/schemas/FeedGroupResponse","description":"The feed group that was retrieved or created","title":"Feed Group","x-stream-index":"001"},"was_created":{"description":"Indicates whether the feed group was created (true) or already existed (false)","title":"Was Created","type":"boolean","x-stream-index":"002"}},"required":["feed_group","was_created","duration"],"title":"Get Or Create Feed Group Response","type":"object"},"GetOrCreateFeedRequest":{"description":"Client request","nullable":true,"properties":{"activity_selector_options":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"data":{"$ref":"#/components/schemas/FeedInput","x-stream-index":"003"},"external_ranking":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"filter":{"additionalProperties":{},"type":"object","x-stream-index":"009"},"followers_pagination":{"$ref":"#/components/schemas/PagerRequest","x-stream-index":"011"},"following_pagination":{"$ref":"#/components/schemas/PagerRequest","x-stream-index":"012"},"interest_weights":{"additionalProperties":{"format":"float","type":"number"},"type":"object","x-stream-index":"008"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"013.001"},"member_pagination":{"$ref":"#/components/schemas/PagerRequest","x-stream-index":"010"},"next":{"type":"string","x-stream-index":"013.002"},"prev":{"type":"string","x-stream-index":"013.003"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"014.002"},"user_id":{"type":"string","x-stream-index":"014.001"},"view":{"type":"string","x-stream-index":"005"},"watch":{"type":"boolean","x-stream-index":"004"}},"title":"ClientRequest","type":"object"},"GetOrCreateFeedResponse":{"description":"Basic response information","nullable":true,"properties":{"activities":{"items":{"$ref":"#/components/schemas/ActivityResponse"},"type":"array","x-stream-index":"002"},"aggregated_activities":{"items":{"$ref":"#/components/schemas/AggregatedActivityResponse"},"type":"array","x-stream-index":"003"},"created":{"type":"boolean","x-stream-index":"015"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"017.001"},"feed":{"$ref":"#/components/schemas/FeedResponse","x-stream-index":"001"},"followers":{"items":{"$ref":"#/components/schemas/FollowResponse"},"type":"array","x-stream-index":"005"},"followers_pagination":{"$ref":"#/components/schemas/PagerResponse","x-stream-index":"012"},"following":{"items":{"$ref":"#/components/schemas/FollowResponse"},"type":"array","x-stream-index":"006"},"following_pagination":{"$ref":"#/components/schemas/PagerResponse","x-stream-index":"013"},"member_pagination":{"$ref":"#/components/schemas/PagerResponse","x-stream-index":"011"},"members":{"items":{"$ref":"#/components/schemas/FeedMemberResponse"},"type":"array","x-stream-index":"004"},"next":{"type":"string","x-stream-index":"016.001"},"notification_status":{"$ref":"#/components/schemas/NotificationStatusResponse","x-stream-index":"014"},"own_capabilities":{"items":{"$ref":"#/components/schemas/FeedOwnCapability"},"type":"array","x-stream-index":"008"},"own_follows":{"items":{"$ref":"#/components/schemas/FollowResponse"},"type":"array","x-stream-index":"009"},"own_membership":{"$ref":"#/components/schemas/FeedMemberResponse","x-stream-index":"010"},"pinned_activities":{"items":{"$ref":"#/components/schemas/ActivityPinResponse"},"type":"array","x-stream-index":"007"},"prev":{"type":"string","x-stream-index":"016.002"}},"required":["feed","activities","aggregated_activities","members","followers","following","pinned_activities","own_capabilities","created","duration"],"title":"Response","type":"object"},"GetOrCreateFeedViewRequest":{"nullable":true,"properties":{"activity_processors":{"description":"Configured activity Processors","items":{"$ref":"#/components/schemas/ActivityProcessorConfig"},"title":"Activity Processors","type":"array","x-stream-index":"002.002"},"activity_selectors":{"description":"Configuration for selecting activities","items":{"$ref":"#/components/schemas/ActivitySelectorConfig"},"title":"Activity Selectors","type":"array","x-stream-index":"002.001"},"aggregation":{"$ref":"#/components/schemas/AggregationConfig","description":"Configuration for aggregating activities","title":"Aggregation","x-stream-index":"002.004"},"ranking":{"$ref":"#/components/schemas/RankingConfig","description":"Configuration for ranking activities","title":"Ranking","x-stream-index":"002.003"}},"title":"Get Or Create Feed View Request","type":"object"},"GetOrCreateFeedViewResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"003.001"},"feed_view":{"$ref":"#/components/schemas/FeedViewResponse","description":"The feed view (either existing or newly created)","title":"Feed View","x-stream-index":"001"},"was_created":{"description":"Indicates whether the feed view was newly created (true) or already existed (false)","title":"Was Created","type":"boolean","x-stream-index":"002"}},"required":["feed_view","was_created","duration"],"title":"Get Or Create Feed View Response","type":"object"},"GetPushTemplatesResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"templates":{"items":{"$ref":"#/components/schemas/PushTemplate"},"type":"array","x-stream-index":"002"}},"required":["duration","templates"],"title":"Response","type":"object"},"GetRateLimitsResponse":{"nullable":true,"properties":{"android":{"additionalProperties":{"$ref":"#/components/schemas/LimitInfo"},"description":"Map of endpoint rate limits for the Android platform","title":"Android","type":"object","x-stream-index":"002","x-stream-map":{"key":"endpoint","title":"Endpoint name","description":"The name of the endpoint for which the limits apply"}},"duration":{"type":"string","x-stream-index":"005.001"},"ios":{"additionalProperties":{"$ref":"#/components/schemas/LimitInfo"},"description":"Map of endpoint rate limits for the iOS platform","title":"iOS","type":"object","x-stream-index":"003","x-stream-map":{"key":"endpoint","title":"Endpoint name","description":"The name of the endpoint for which the limits apply"}},"server_side":{"additionalProperties":{"$ref":"#/components/schemas/LimitInfo"},"description":"Map of endpoint rate limits for the server-side platform","title":"Server-side","type":"object","x-stream-index":"001","x-stream-map":{"key":"endpoint","title":"Endpoint name","description":"The name of the endpoint for which the limits apply"}},"web":{"additionalProperties":{"$ref":"#/components/schemas/LimitInfo"},"description":"Map of endpoint rate limits for the web platform","title":"Web","type":"object","x-stream-index":"004","x-stream-map":{"key":"endpoint","title":"Endpoint name","description":"The name of the endpoint for which the limits apply"}}},"required":["duration"],"title":"Get Rate Limits Response","type":"object","x-stream-docs-page-id":"rate_limits"},"GetReactionsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"reactions":{"description":"List of reactions","items":{"$ref":"#/components/schemas/Reaction"},"title":"Reactions","type":"array","x-stream-index":"001"}},"required":["reactions","duration"],"type":"object"},"GetRepliesResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"messages":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","x-stream-index":"001"}},"required":["messages","duration"],"title":"Response","type":"object"},"GetReviewQueueItemResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"Current state of the review queue item","title":"Item","x-stream-index":"001"}},"required":["duration"],"type":"object"},"GetSegmentResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"segment":{"$ref":"#/components/schemas/SegmentResponse","description":"Segment","title":"SegmentResponse","x-stream-index":"001"}},"required":["duration"],"type":"object"},"GetTaskResponse":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.003"},"duration":{"type":"string","x-stream-index":"004.001"},"error":{"$ref":"#/components/schemas/ErrorResult","description":"Error produced by task","title":"Error","x-stream-index":"003"},"result":{"additionalProperties":{},"description":"Result produced by task after completion","title":"Result","type":"object","x-stream-index":"002"},"status":{"description":"Current status of task","title":"Status","type":"string","x-stream-index":"001.002"},"task_id":{"description":"ID of task","title":"Task ID","type":"string","x-stream-index":"001.001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.004"}},"required":["task_id","status","created_at","updated_at","duration"],"title":"Get Task Response","type":"object","x-stream-docs-page-id":"tasks"},"GetThreadResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"thread":{"$ref":"#/components/schemas/ThreadStateResponse","description":"Enriched thread state","title":"Thread","x-stream-index":"001"}},"required":["thread","duration"],"type":"object"},"GoLiveRequest":{"nullable":true,"properties":{"recording_storage_name":{"type":"string","x-stream-index":"005"},"start_closed_caption":{"type":"boolean","x-stream-index":"008"},"start_hls":{"type":"boolean","x-stream-index":"003"},"start_recording":{"type":"boolean","x-stream-index":"004"},"start_transcription":{"type":"boolean","x-stream-index":"007"},"transcription_storage_name":{"type":"string","x-stream-index":"006"}},"title":"GoLiveRequest","type":"object"},"GoLiveResponse":{"description":"Basic response information","nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["call","duration"],"title":"Response","type":"object"},"GoogleVisionConfig":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"GroupedStatsResponse":{"nullable":true,"properties":{"name":{"type":"string","x-stream-index":"001"},"unique":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["name","unique"],"type":"object"},"HLSEgressConfig":{"properties":{"composite_app_settings":{"$ref":"#/components/schemas/CompositeAppSettings","x-stream-index":"005"},"playlist_url":{"type":"string","x-stream-index":"007"},"qualities":{"items":{"$ref":"#/components/schemas/Quality"},"type":"array","x-stream-index":"004"},"start_unix_nano":{"format":"int64","type":"integer","x-stream-index":"006"}},"type":"object"},"HLSSettings":{"properties":{"auto_on":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"004"},"quality_tracks":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"required":["auto_on","enabled","quality_tracks"],"type":"object"},"HLSSettingsRequest":{"properties":{"auto_on":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"layout":{"$ref":"#/components/schemas/LayoutSettingsRequest","title":"LayoutSettings","x-stream-index":"004"},"quality_tracks":{"items":{"type":"string"},"maximum":3,"minimum":1,"type":"array","x-stream-index":"003"}},"required":["quality_tracks"],"title":"HLSSettingsRequest","type":"object"},"HLSSettingsResponse":{"description":"HLSSettings is the payload for HLS settings","properties":{"auto_on":{"title":"Auto On","type":"boolean","x-stream-index":"001"},"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"002"},"layout":{"$ref":"#/components/schemas/LayoutSettingsResponse","title":"Layout","x-stream-index":"004"},"quality_tracks":{"items":{"type":"string"},"title":"Quality Tracks","type":"array","x-stream-index":"003"}},"required":["auto_on","enabled","quality_tracks","layout"],"title":"HLSSettingsResponse","type":"object"},"HarmConfig":{"properties":{"action_sequences":{"items":{"$ref":"#/components/schemas/ActionSequence"},"type":"array","x-stream-index":"001"},"severity":{"type":"integer","x-stream-index":"002"}},"required":["action_sequences","severity"],"type":"object"},"HideChannelRequest":{"nullable":true,"properties":{"clear_history":{"description":"Whether to clear message history of the channel or not","title":"Clear history","type":"boolean","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"type":"object"},"HideChannelResponse":{"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"},"HuaweiConfig":{"properties":{"Disabled":{"type":"boolean","writeOnly":true,"x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"secret":{"type":"string","x-stream-index":"002"}},"type":"object"},"HuaweiConfigFields":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"id":{"type":"string","x-stream-index":"002"},"secret":{"type":"string","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"ImageContentParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"type":"object"},"ImageData":{"properties":{"frames":{"type":"string","x-stream-index":"005"},"height":{"type":"string","x-stream-index":"003"},"size":{"type":"string","x-stream-index":"004"},"url":{"type":"string","x-stream-index":"001"},"width":{"type":"string","x-stream-index":"002"}},"required":["url","width","height","size","frames"],"type":"object"},"ImageRuleParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"type":"object"},"ImageSize":{"properties":{"crop":{"description":"Crop mode","enum":["top","bottom","left","right","center"],"title":"Crop","type":"string","x-stream-index":"001"},"height":{"description":"Target image height","format":"int32","title":"Height","type":"integer","x-stream-index":"003"},"resize":{"description":"Resize method","enum":["clip","crop","scale","fill"],"title":"Resize","type":"string","x-stream-index":"002"},"width":{"description":"Target image width","format":"int32","title":"Width","type":"integer","x-stream-index":"004"}},"title":"Image size configuration","type":"object"},"ImageUploadRequest":{"nullable":true,"properties":{"file":{"type":"string","x-stream-index":"001.001"},"upload_sizes":{"description":"field with JSON-encoded array of image size configurations","items":{"$ref":"#/components/schemas/ImageSize"},"title":"Upload sizes","type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/OnlyUserID","x-stream-index":"001.002"}},"type":"object"},"ImageUploadResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.003.001"},"file":{"type":"string","x-stream-index":"001.001"},"thumb_url":{"type":"string","x-stream-index":"001.002"},"upload_sizes":{"description":"Array of image size configurations","items":{"$ref":"#/components/schemas/ImageSize"},"title":"Upload sizes","type":"array","x-stream-index":"002"}},"required":["duration"],"type":"object"},"Images":{"properties":{"fixed_height":{"$ref":"#/components/schemas/ImageData","x-stream-index":"002"},"fixed_height_downsampled":{"$ref":"#/components/schemas/ImageData","x-stream-index":"004"},"fixed_height_still":{"$ref":"#/components/schemas/ImageData","x-stream-index":"003"},"fixed_width":{"$ref":"#/components/schemas/ImageData","x-stream-index":"005"},"fixed_width_downsampled":{"$ref":"#/components/schemas/ImageData","x-stream-index":"007"},"fixed_width_still":{"$ref":"#/components/schemas/ImageData","x-stream-index":"006"},"original":{"$ref":"#/components/schemas/ImageData","x-stream-index":"001"}},"required":["original","fixed_height","fixed_height_still","fixed_height_downsampled","fixed_width","fixed_width_still","fixed_width_downsampled"],"type":"object"},"ImportTask":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"011"},"history":{"items":{"$ref":"#/components/schemas/ImportTaskHistory"},"type":"array","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"003"},"mode":{"type":"string","x-stream-index":"006"},"path":{"type":"string","x-stream-index":"005"},"size":{"format":"int64","type":"integer","x-stream-index":"007"},"state":{"type":"string","x-stream-index":"008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"012"}},"required":["id","path","mode","state","history","created_at","updated_at"],"type":"object"},"ImportTaskHistory":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"next_state":{"type":"string","x-stream-index":"006"},"prev_state":{"type":"string","x-stream-index":"005"}},"required":["prev_state","next_state","created_at"],"type":"object"},"IngressAudioEncodingOptions":{"properties":{"bitrate":{"maximum":128000,"minimum":16000,"type":"integer","x-stream-index":"003"},"channels":{"enum":["1","2"],"format":"int32","type":"integer","x-stream-index":"001"},"enable_dtx":{"type":"boolean","x-stream-index":"002"}},"required":["channels","enable_dtx","bitrate"],"type":"object"},"IngressAudioEncodingOptionsRequest":{"properties":{"bitrate":{"maximum":128000,"minimum":16000,"type":"integer","x-stream-index":"003"},"channels":{"enum":["1","2"],"format":"int32","type":"integer","x-stream-index":"001"},"enable_dtx":{"type":"boolean","x-stream-index":"002"}},"required":["channels","bitrate"],"type":"object"},"IngressAudioEncodingResponse":{"properties":{"bitrate":{"format":"int32","type":"integer","x-stream-index":"003"},"channels":{"format":"int32","type":"integer","x-stream-index":"001"},"enable_dtx":{"type":"boolean","x-stream-index":"002"}},"required":["channels","enable_dtx","bitrate"],"type":"object"},"IngressSettings":{"properties":{"audio_encoding_options":{"$ref":"#/components/schemas/IngressAudioEncodingOptions","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"video_encoding_options":{"additionalProperties":{"$ref":"#/components/schemas/IngressVideoEncodingOptions"},"type":"object","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"IngressSettingsRequest":{"properties":{"audio_encoding_options":{"$ref":"#/components/schemas/IngressAudioEncodingOptionsRequest","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"video_encoding_options":{"additionalProperties":{"$ref":"#/components/schemas/IngressVideoEncodingOptionsRequest"},"type":"object","x-stream-index":"003"}},"type":"object"},"IngressSettingsResponse":{"properties":{"audio_encoding_options":{"$ref":"#/components/schemas/IngressAudioEncodingResponse","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"video_encoding_options":{"additionalProperties":{"$ref":"#/components/schemas/IngressVideoEncodingResponse"},"type":"object","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"IngressVideoEncodingOptions":{"properties":{"layers":{"items":{"$ref":"#/components/schemas/IngressVideoLayer"},"minimum":1,"type":"array","x-stream-index":"001"}},"required":["layers"],"type":"object"},"IngressVideoEncodingOptionsRequest":{"properties":{"layers":{"items":{"$ref":"#/components/schemas/IngressVideoLayerRequest"},"minimum":1,"type":"array","x-stream-index":"001"}},"required":["layers"],"type":"object"},"IngressVideoEncodingResponse":{"properties":{"layers":{"items":{"$ref":"#/components/schemas/IngressVideoLayerResponse"},"type":"array","x-stream-index":"001"}},"required":["layers"],"type":"object"},"IngressVideoLayer":{"nullable":true,"properties":{"bitrate":{"minimum":1000,"type":"integer","x-stream-index":"002"},"codec":{"enum":["h264","vp8"],"type":"string","x-stream-index":"001"},"frame_rate":{"maximum":60,"minimum":1,"type":"integer","x-stream-index":"003"},"max_dimension":{"minimum":240,"type":"integer","x-stream-index":"005"},"min_dimension":{"minimum":240,"type":"integer","x-stream-index":"004"}},"required":["codec","bitrate","frame_rate","min_dimension","max_dimension"],"type":"object"},"IngressVideoLayerRequest":{"nullable":true,"properties":{"bitrate":{"format":"int32","minimum":1000,"type":"integer","x-stream-index":"002"},"codec":{"enum":["h264","vp8"],"type":"string","x-stream-index":"001"},"frame_rate_limit":{"maximum":60,"minimum":1,"type":"integer","x-stream-index":"005"},"max_dimension":{"minimum":240,"type":"integer","x-stream-index":"004"},"min_dimension":{"minimum":240,"type":"integer","x-stream-index":"003"}},"required":["codec","bitrate","min_dimension","max_dimension","frame_rate_limit"],"type":"object"},"IngressVideoLayerResponse":{"nullable":true,"properties":{"bitrate":{"type":"integer","x-stream-index":"002"},"codec":{"type":"string","x-stream-index":"001"},"frame_rate_limit":{"type":"integer","x-stream-index":"005"},"max_dimension":{"type":"integer","x-stream-index":"004"},"min_dimension":{"type":"integer","x-stream-index":"003"}},"required":["codec","bitrate","min_dimension","max_dimension","frame_rate_limit"],"type":"object"},"JoinCallAPIMetrics":{"properties":{"failures":{"format":"float","type":"number","x-stream-index":"002"},"latency":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"003"},"total":{"format":"float","type":"number","x-stream-index":"001"}},"required":["total","failures"],"type":"object"},"KickUserRequest":{"description":"KickUserRequest is the payload for kicking a user from a call. Optionally block the user as well.","nullable":true,"properties":{"block":{"description":"If true, also block the user from rejoining the call","title":"Block","type":"boolean","x-stream-index":"004"},"kicked_by":{"$ref":"#/components/schemas/UserRequest","description":"Server-side: user performing the action","title":"KickedBy","x-stream-index":"006"},"kicked_by_id":{"description":"Server-side: ID of the user performing the action","title":"KickedByID","type":"string","x-stream-index":"005"},"user_id":{"description":"The user to kick","title":"UserID","type":"string","x-stream-index":"003"}},"required":["user_id"],"title":"KickUserRequest","type":"object"},"KickUserResponse":{"description":"KickUserResponse is the payload for kicking a user from a call.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"KickUserResponse","type":"object"},"KickedUserEvent":{"description":"This event is sent to call participants to notify when a user is kicked from a call. Clients should make the kicked user leave the call UI.","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"kicked_by_user":{"$ref":"#/components/schemas/UserResponse","description":"The user that kicked the participant, null if server-side","title":"Kicked by","x-stream-index":"004"},"type":{"default":"call.kicked_user","description":"The type of event: \"call.kicked_user\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user that was kicked","title":"User","x-stream-index":"003"}},"required":["type","created_at","call_cid","user"],"title":"KickedUserEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"LLMConfig":{"properties":{"app_context":{"type":"string","x-stream-index":"005"},"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/LLMRule"},"type":"array","x-stream-index":"003"},"severity_descriptions":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"004"}},"required":["enabled","rules"],"type":"object"},"LLMRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove","keep"],"type":"string","x-stream-index":"003"},"description":{"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"},"severity_rules":{"items":{"$ref":"#/components/schemas/BodyguardSeverityRule"},"type":"array","x-stream-index":"004"}},"required":["label","description","action","severity_rules"],"type":"object"},"Label":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"phrase_list_ids":{"items":{"format":"int32","type":"integer"},"type":"array","x-stream-index":"002"}},"required":["name"],"type":"object"},"LabelThresholds":{"properties":{"block":{"description":"Threshold for automatic message block","format":"float","maximum":1,"minimum":0,"title":"Block","type":"number","x-stream-index":"002"},"flag":{"description":"Threshold for automatic message flag","format":"float","maximum":1,"minimum":0,"title":"Flag","type":"number","x-stream-index":"001"}},"type":"object"},"LayoutSettings":{"properties":{"detect_orientation":{"type":"boolean","x-stream-index":"005"},"external_app_url":{"type":"string","x-stream-index":"003"},"external_css_url":{"type":"string","x-stream-index":"004"},"name":{"enum":["spotlight","grid","single-participant","mobile","custom"],"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"required":["name","external_app_url","external_css_url"],"type":"object"},"LayoutSettingsRequest":{"properties":{"detect_orientation":{"type":"boolean","x-stream-index":"005"},"external_app_url":{"type":"string","x-stream-index":"003"},"external_css_url":{"type":"string","x-stream-index":"004"},"name":{"enum":["spotlight","grid","single-participant","mobile","custom"],"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"required":["name"],"type":"object"},"LayoutSettingsResponse":{"properties":{"detect_orientation":{"type":"boolean","x-stream-index":"005"},"external_app_url":{"type":"string","x-stream-index":"003"},"external_css_url":{"type":"string","x-stream-index":"004"},"name":{"enum":["spotlight","grid","single-participant","mobile","custom"],"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"required":["name","external_app_url","external_css_url"],"type":"object"},"LimitInfo":{"properties":{"limit":{"description":"The maximum number of calls allowed for the time window","format":"int32","title":"Limit","type":"integer","x-stream-index":"001"},"remaining":{"description":"The number of remaining calls in the current window","format":"int64","title":"Remaining","type":"integer","x-stream-index":"002"},"reset":{"description":"The Unix timestamp of the next window","format":"int64","title":"Reset","type":"integer","x-stream-index":"003"}},"required":["limit","remaining","reset"],"title":"Rate Limit info","type":"object","x-stream-docs-page-id":"rate_limits"},"LimitsSettings":{"properties":{"max_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"004"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"},"max_participants_exclude_owner":{"type":"boolean","x-stream-index":"003"},"max_participants_exclude_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"002"}},"required":["max_participants_exclude_roles"],"type":"object"},"LimitsSettingsRequest":{"properties":{"max_duration_seconds":{"format":"int32","minimum":0,"type":"integer","x-stream-index":"004"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"},"max_participants_exclude_owner":{"type":"boolean","x-stream-index":"003"},"max_participants_exclude_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"002"}},"type":"object"},"LimitsSettingsResponse":{"properties":{"max_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"004"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"},"max_participants_exclude_owner":{"type":"boolean","x-stream-index":"003"},"max_participants_exclude_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"002"}},"required":["max_participants_exclude_roles"],"type":"object"},"ListBlockListResponse":{"description":"Basic response information","nullable":true,"properties":{"blocklists":{"items":{"$ref":"#/components/schemas/BlockListResponse"},"type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["blocklists","duration"],"title":"Response","type":"object"},"ListCallTypeResponse":{"description":"Response for ListCallType","nullable":true,"properties":{"call_types":{"additionalProperties":{"$ref":"#/components/schemas/CallTypeResponse"},"type":"object","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["call_types","duration"],"title":"ListCallTypeResponse","type":"object"},"ListChannelTypesResponse":{"nullable":true,"properties":{"channel_types":{"additionalProperties":{"$ref":"#/components/schemas/ChannelTypeConfig"},"description":"Object with all channel types","title":"Channel types","type":"object","x-stream-index":"001","x-stream-map":{"key":"channel_type","title":"Channel type","description":"Channel type config object"}},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["channel_types","duration"],"title":"ListChannelTypesResponse","type":"object"},"ListCommandsResponse":{"nullable":true,"properties":{"commands":{"description":"List of commands","items":{"$ref":"#/components/schemas/Command"},"title":"Commands","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["commands","duration"],"title":"ListCommandsResponse","type":"object"},"ListDevicesResponse":{"description":"List devices response","nullable":true,"properties":{"devices":{"description":"List of devices","items":{"$ref":"#/components/schemas/DeviceResponse"},"title":"Devices","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["devices","duration"],"title":"ListDevicesResponse","type":"object"},"ListExternalStorageResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"external_storages":{"additionalProperties":{"$ref":"#/components/schemas/ExternalStorageResponse"},"type":"object","x-stream-index":"002"}},"required":["duration","external_storages"],"title":"Response","type":"object"},"ListFeedGroupsResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"groups":{"additionalProperties":{"$ref":"#/components/schemas/FeedGroupResponse"},"type":"object","x-stream-index":"001"}},"required":["groups","duration"],"title":"Response","type":"object"},"ListFeedViewsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"views":{"additionalProperties":{"$ref":"#/components/schemas/FeedViewResponse"},"description":"Map of feed view ID to feed view","title":"Views","type":"object","x-stream-index":"001"}},"required":["views","duration"],"title":"List Feed Views Response","type":"object"},"ListImportsResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"import_tasks":{"items":{"$ref":"#/components/schemas/ImportTask"},"type":"array","x-stream-index":"001"}},"required":["import_tasks","duration"],"title":"Response","type":"object"},"ListPermissionsResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"permissions":{"items":{"$ref":"#/components/schemas/Permission"},"type":"array","x-stream-index":"001"}},"required":["permissions","duration"],"title":"Response","type":"object"},"ListPushProvidersResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"push_providers":{"items":{"$ref":"#/components/schemas/PushProviderResponse"},"type":"array","x-stream-index":"001"}},"required":["push_providers","duration"],"title":"Response","type":"object"},"ListRecordingsResponse":{"description":"Response for listing recordings","nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"},"recordings":{"items":{"$ref":"#/components/schemas/CallRecording"},"title":"The list of recordings.","type":"array","x-stream-index":"002"}},"required":["duration","recordings"],"title":"ListRecordingsResponse","type":"object"},"ListRolesResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"roles":{"items":{"$ref":"#/components/schemas/Role"},"type":"array","x-stream-index":"001"}},"required":["roles","duration"],"title":"Response","type":"object"},"ListTranscriptionsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"},"transcriptions":{"description":"List of transcriptions for the call","items":{"$ref":"#/components/schemas/CallTranscription"},"title":"Transcriptions","type":"array","x-stream-index":"002"}},"required":["duration","transcriptions"],"title":"ListTranscriptionsResponse","type":"object"},"MarkActivityRequest":{"nullable":true,"properties":{"mark_all_read":{"description":"Whether to mark all activities as read","title":"Mark All Read","type":"boolean","x-stream-index":"005"},"mark_all_seen":{"description":"Whether to mark all activities as seen","title":"Mark All Seen","type":"boolean","x-stream-index":"003"},"mark_read":{"description":"List of activity IDs to mark as read","items":{"type":"string"},"title":"Mark Read","type":"array","x-stream-index":"004"},"mark_seen":{"description":"List of activity IDs to mark as seen","items":{"type":"string"},"title":"Mark Seen","type":"array","x-stream-index":"006"},"mark_watched":{"description":"List of activity IDs to mark as watched (for stories)","items":{"type":"string"},"title":"Mark Watched","type":"array","x-stream-index":"007"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"009.002"},"user_id":{"type":"string","x-stream-index":"009.001"}},"title":"Mark Activity Request","type":"object"},"MarkChannelsReadRequest":{"nullable":true,"properties":{"read_by_channel":{"additionalProperties":{"type":"string"},"description":"Map of channel ID to last read message ID","maximum":30,"title":"Read by channel","type":"object","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"002.002"},"user_id":{"type":"string","x-stream-index":"002.001"}},"type":"object"},"MarkReadRequest":{"nullable":true,"properties":{"message_id":{"description":"ID of the message that is considered last read by client","title":"Message ID","type":"string","x-stream-index":"001"},"thread_id":{"description":"Optional Thread ID to specifically mark a given thread as read","title":"Thread ID","type":"string","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"type":"object"},"MarkReadResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"event":{"$ref":"#/components/schemas/MessageReadEvent","description":"Mark read event","title":"Event","x-stream-index":"001"}},"required":["duration"],"type":"object"},"MarkReviewedRequest":{"properties":{"content_to_mark_as_reviewed_limit":{"format":"int32","maximum":2500,"type":"integer","x-stream-index":"002"},"disable_marking_content_as_reviewed":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"MarkUnreadRequest":{"nullable":true,"properties":{"message_id":{"description":"ID of the message from where the channel is marked unread","title":"Message ID","type":"string","x-stream-index":"001"},"thread_id":{"description":"Mark a thread unread, specify both the thread and message id","title":"Thread ID","type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"type":"object"},"MemberAddedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"002.001"},"type":{"default":"member.added","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MemberAddedEvent","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"},"MemberLookup":{"properties":{"Limit":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"001"}},"required":["Limit"],"type":"object"},"MemberRemovedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"001.001"},"type":{"default":"member.removed","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MemberRemovedEvent","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"},"MemberRequest":{"description":"MemberRequest is the payload for adding a member to a call.","properties":{"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"003"},"role":{"title":"Role","type":"string","x-stream-index":"002"},"user_id":{"minLength":1,"title":"User ID","type":"string","x-stream-index":"001"}},"required":["user_id"],"title":"MemberRequest","type":"object"},"MemberResponse":{"description":"MemberResponse is the payload for a member of a call.","properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"005"},"custom":{"additionalProperties":{},"description":"Custom member response data","title":"Custom","type":"object","x-stream-index":"004"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"007"},"role":{"title":"Role","type":"string","x-stream-index":"003"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"006"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"},"user_id":{"type":"string","x-stream-index":"002"}},"required":["user","user_id","custom","created_at","updated_at"],"title":"MemberResponse","type":"object"},"MemberUpdatedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"005.002"},"channel_type":{"type":"string","x-stream-index":"005.003"},"cid":{"type":"string","x-stream-index":"005.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"002.001"},"type":{"default":"member.updated","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MemberUpdatedEvent","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"},"MembersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"members":{"description":"List of found members","items":{"$ref":"#/components/schemas/ChannelMember"},"title":"Members","type":"array","x-stream-index":"001"}},"required":["members","duration"],"type":"object"},"MembershipLevelResponse":{"properties":{"created_at":{"description":"When the membership level was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"007"},"custom":{"additionalProperties":{},"description":"Custom data for the membership level","title":"Custom Data","type":"object","x-stream-index":"006"},"description":{"description":"Description of the membership level","title":"Description","type":"string","x-stream-index":"003"},"id":{"description":"Unique identifier for the membership level","title":"ID","type":"string","x-stream-index":"001"},"name":{"description":"Display name for the membership level","title":"Name","type":"string","x-stream-index":"002"},"priority":{"description":"Priority level","format":"int32","title":"Priority","type":"integer","x-stream-index":"004"},"tags":{"description":"Activity tags this membership level gives access to","items":{"type":"string"},"title":"Tags","type":"array","x-stream-index":"005"},"updated_at":{"description":"When the membership level was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"008"}},"required":["id","name","priority","tags","created_at","updated_at"],"title":"Membership Level Response","type":"object"},"Message":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"012"},"before_message_send_failed":{"type":"boolean","x-stream-index":"046"},"cid":{"type":"string","x-stream-index":"028"},"command":{"type":"string","x-stream-index":"006"},"created_at":{"format":"date-time","type":"number","x-stream-index":"030"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"034"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"033"},"deleted_for_me":{"type":"boolean","x-stream-index":"059"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"023"},"html":{"type":"string","x-stream-index":"007"},"i18n":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"044"},"id":{"type":"string","x-stream-index":"002"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"040"},"latest_reactions":{"items":{"$ref":"#/components/schemas/Reaction"},"type":"array","x-stream-index":"013"},"mentioned_users":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"043"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"052"},"mml":{"type":"string","x-stream-index":"005"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"056"},"own_reactions":{"items":{"$ref":"#/components/schemas/Reaction"},"type":"array","x-stream-index":"014"},"parent_id":{"type":"string","x-stream-index":"019"},"pin_expires":{"format":"date-time","type":"number","x-stream-index":"051"},"pinned":{"type":"boolean","x-stream-index":"047"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"048"},"pinned_by":{"$ref":"#/components/schemas/User","x-stream-index":"050"},"poll":{"$ref":"#/components/schemas/Poll","x-stream-index":"054"},"poll_id":{"type":"string","x-stream-index":"053"},"quoted_message":{"$ref":"#/components/schemas/Message","x-stream-index":"025"},"quoted_message_id":{"type":"string","x-stream-index":"024"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"015"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"017"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"016"},"reminder":{"$ref":"#/components/schemas/MessageReminder","x-stream-index":"058"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"022"},"restricted_visibility":{"items":{"type":"string"},"type":"array","x-stream-index":"011"},"shadowed":{"type":"boolean","x-stream-index":"036"},"shared_location":{"$ref":"#/components/schemas/SharedLocation","x-stream-index":"055"},"show_in_channel":{"type":"boolean","x-stream-index":"021"},"silent":{"type":"boolean","x-stream-index":"045"},"text":{"type":"string","x-stream-index":"004"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"027"},"type":{"type":"string","x-stream-index":"008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"031"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"010"}},"required":["id","text","html","type","restricted_visibility","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reaction_groups","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned"],"type":"object"},"MessageActionRequest":{"nullable":true,"properties":{"form_data":{"additionalProperties":{"type":"string"},"description":"ReadOnlyData to execute command with","title":"Form data","type":"object","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"required":["form_data"],"type":"object"},"MessageChangeSet":{"properties":{"attachments":{"type":"boolean","x-stream-index":"005"},"custom":{"type":"boolean","x-stream-index":"001"},"html":{"type":"boolean","x-stream-index":"004"},"mentioned_user_ids":{"type":"boolean","x-stream-index":"006"},"mml":{"type":"boolean","x-stream-index":"003"},"pin":{"type":"boolean","x-stream-index":"009"},"quoted_message_id":{"type":"boolean","x-stream-index":"007"},"silent":{"type":"boolean","x-stream-index":"008"},"text":{"type":"boolean","x-stream-index":"002"}},"required":["custom","text","mml","html","attachments","mentioned_user_ids","quoted_message_id","silent","pin"],"type":"object"},"MessageDeletedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"007.002"},"deleted_for_me":{"type":"boolean","x-stream-index":"003"},"hard_delete":{"type":"boolean","x-stream-index":"002.001"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"006.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"message.deleted","type":"string","x-stream-index":"007.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005.001"}},"required":["hard_delete","cid","channel_id","channel_type","type","created_at"],"title":"MessageDeletedEvent","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":{"approved_at":{"format":"date-time","type":"number","x-stream-index":"013"},"created_at":{"format":"date-time","type":"number","x-stream-index":"009"},"created_by_automod":{"type":"boolean","x-stream-index":"001"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"008"},"details":{"$ref":"#/components/schemas/FlagDetails","x-stream-index":"006"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"005"},"moderation_feedback":{"$ref":"#/components/schemas/FlagFeedback","x-stream-index":"003"},"moderation_result":{"$ref":"#/components/schemas/MessageModerationResult","x-stream-index":"002"},"reason":{"type":"string","x-stream-index":"007"},"rejected_at":{"format":"date-time","type":"number","x-stream-index":"014"},"reviewed_at":{"format":"date-time","type":"number","x-stream-index":"011"},"reviewed_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"012"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"004"}},"required":["created_by_automod","created_at","updated_at"],"type":"object"},"MessageFlaggedEvent":{"properties":{"cid":{"type":"string","x-stream-index":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"005.002"},"flag":{"$ref":"#/components/schemas/Flag","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"002.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"002.002"},"type":{"default":"message.flagged","type":"string","x-stream-index":"005.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004"}},"required":["cid","type","created_at"],"title":"MessageFlaggedEvent","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"},"MessageHistoryEntryResponse":{"nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"007"},"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"006"},"is_deleted":{"type":"boolean","x-stream-index":"004"},"message_id":{"type":"string","x-stream-index":"001"},"message_updated_at":{"format":"date-time","type":"number","x-stream-index":"003"},"message_updated_by_id":{"type":"string","x-stream-index":"002"},"text":{"type":"string","x-stream-index":"005"}},"required":["message_id","message_updated_by_id","message_updated_at","is_deleted","text","attachments","Custom"],"type":"object"},"MessageModerationResult":{"description":"Result of the message moderation","properties":{"action":{"description":"Action taken by automod","title":"Action","type":"string","x-stream-index":"002"},"ai_moderation_response":{"$ref":"#/components/schemas/ModerationResponse","description":"Response from AI moderation","title":"ModerationResponse","x-stream-index":"007"},"blocked_word":{"description":"Word that was blocked","title":"Blocked word","type":"string","x-stream-index":"004"},"blocklist_name":{"description":"Name of the blocklist","title":"Blocklist name","type":"string","x-stream-index":"005"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"010"},"message_id":{"description":"ID of the message","title":"Message ID","type":"string","x-stream-index":"001"},"moderated_by":{"description":"User who moderated the message","title":"Moderated by","type":"string","x-stream-index":"003"},"moderation_thresholds":{"$ref":"#/components/schemas/Thresholds","description":"Thresholds for AI moderation","title":"Thresholds","x-stream-index":"006"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"011"},"user_bad_karma":{"description":"Whether user has bad karma","title":"User bad karma","type":"boolean","x-stream-index":"009"},"user_karma":{"description":"Karma of the user","format":"float","title":"User karma","type":"number","x-stream-index":"008"}},"required":["message_id","action","user_karma","user_bad_karma","created_at","updated_at"],"title":"Message moderation result","type":"object"},"MessageNewEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"005.002"},"channel_type":{"type":"string","x-stream-index":"005.003"},"cid":{"type":"string","x-stream-index":"005.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"006.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"message.new","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"},"watcher_count":{"format":"int32","type":"integer","x-stream-index":"002.001"}},"required":["watcher_count","type","created_at","cid","channel_id","channel_type"],"title":"MessageNewEvent","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"},"MessageOptions":{"properties":{"include_thread_participants":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"MessagePaginationParams":{"type":"object"},"MessageReadEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"003"},"channel_last_message_at":{"format":"date-time","type":"number","x-stream-index":"005"},"channel_type":{"type":"string","x-stream-index":"004"},"cid":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"009"},"last_read_message_id":{"type":"string","x-stream-index":"010"},"team":{"type":"string","x-stream-index":"006"},"thread":{"$ref":"#/components/schemas/ThreadResponse","x-stream-index":"008"},"type":{"default":"message.read","type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","x-stream-index":"007"}},"required":["type","cid","channel_id","channel_type","created_at"],"type":"object"},"MessageReminder":{"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"004"},"channel_cid":{"type":"string","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"011"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"006"},"message_id":{"type":"string","x-stream-index":"005"},"remind_at":{"format":"date-time","type":"number","x-stream-index":"009"},"task_id":{"type":"string","x-stream-index":"010"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"012"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"user_id":{"type":"string","x-stream-index":"007"}},"required":["channel_cid","message_id","user_id","task_id","created_at","updated_at"],"type":"object"},"MessageRequest":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"maximum":30,"type":"array","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"html":{"type":"string","x-stream-index":"010"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"mentioned_users":{"items":{"type":"string"},"maximum":100,"type":"array","x-stream-index":"008"},"mml":{"type":"string","x-stream-index":"003"},"parent_id":{"type":"string","x-stream-index":"005"},"pin_expires":{"format":"date-time","type":"number","x-stream-index":"015"},"pinned":{"type":"boolean","x-stream-index":"013"},"pinned_at":{"format":"date-time","nullable":true,"type":"string","x-stream-index":"014"},"poll_id":{"type":"string","x-stream-index":"039"},"quoted_message_id":{"type":"string","x-stream-index":"009"},"restricted_visibility":{"items":{"type":"string"},"maximum":10,"type":"array","x-stream-index":"016"},"shared_location":{"$ref":"#/components/schemas/SharedLocation","x-stream-index":"040"},"show_in_channel":{"type":"boolean","x-stream-index":"006"},"silent":{"type":"boolean","x-stream-index":"012"},"text":{"type":"string","x-stream-index":"002"},"type":{"enum":["''","regular","system"],"type":"string","x-stream-index":"011"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"021.002"},"user_id":{"type":"string","x-stream-index":"021.001"}},"type":"object"},"MessageResponse":{"description":"Represents any chat message","properties":{"attachments":{"description":"Array of message attachments","items":{"$ref":"#/components/schemas/Attachment"},"title":"Message attachments","type":"array","x-stream-docs-page-id":"message_format#attachment-format","x-stream-index":"008"},"cid":{"description":"Channel unique identifier in \u003ctype\u003e:\u003cid\u003e format","title":"Channel CID","type":"string","x-stream-index":"022"},"command":{"description":"Contains provided slash command","title":"Command","type":"string","x-stream-docs-page-id":"custom_commands_webhook","x-stream-index":"004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"023"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"026"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"025"},"deleted_for_me":{"type":"boolean","x-stream-index":"044"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"018"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"041"},"html":{"description":"Contains HTML markup of the message. Can only be set when using server-side API","title":"HTML content","type":"string","x-stream-index":"005"},"i18n":{"additionalProperties":{"type":"string"},"description":"Object with translations. Key `language` contains the original language key. Other keys contain translations","title":"Internationalization info","type":"object","x-stream-docs-page-id":"translation","x-stream-index":"030"},"id":{"description":"Message ID is unique string identifier of the message","title":"ID","type":"string","x-stream-index":"001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"Contains image moderation information","title":"Image moderation labels","type":"object","x-stream-index":"028"},"latest_reactions":{"description":"List of 10 latest reactions to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Latest reactions","type":"array","x-stream-index":"009"},"mentioned_users":{"description":"List of mentioned users","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Mentioned Users","type":"array","x-stream-index":"029"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"036"},"mml":{"description":"Should be empty if `text` is provided. Can only be set when using server-side API","title":"Messaging Markup Language","type":"string","x-stream-docs-page-id":"mml_overview","x-stream-index":"003"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"039"},"own_reactions":{"description":"List of 10 latest reactions of authenticated user to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Own reactions","type":"array","x-stream-index":"010"},"parent_id":{"description":"ID of parent message (thread)","title":"Parent message ID","type":"string","x-stream-docs-page-id":"threads","x-stream-index":"015"},"pin_expires":{"description":"Date when pinned message expires","format":"date-time","title":"Pin expiration date","type":"number","x-stream-docs-page-id":"pinned_messages","x-stream-index":"035"},"pinned":{"description":"Whether message is pinned or not","title":"Pinned","type":"boolean","x-stream-docs-page-id":"pinned_messages","x-stream-index":"032"},"pinned_at":{"description":"Date when message got pinned","format":"date-time","title":"Pinned at","type":"number","x-stream-docs-page-id":"pinned_messages","x-stream-index":"033"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","description":"Contains user who pinned the message","title":"Pinned by","x-stream-docs-page-id":"pinned_messages","x-stream-index":"034"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"038"},"poll_id":{"description":"Identifier of the poll to include in the message","title":"Poll ID","type":"string","x-stream-index":"037"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","description":"Contains quoted message","title":"Quoted message","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"020"},"quoted_message_id":{"title":"ID of quoted message","type":"string","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"019"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing number of reactions of each type. Key: reaction type (string), value: number of reactions (int)","title":"Reaction counts","type":"object","x-stream-index":"011"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"014"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing scores of reactions of each type. Key: reaction type (string), value: total score of reactions (int)","title":"Reaction scores","type":"object","x-stream-index":"012"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"042"},"reply_count":{"description":"Number of replies to this message","format":"int32","title":"Reply count","type":"integer","x-stream-index":"017"},"restricted_visibility":{"description":"A list of user ids that have restricted visibility to the message, if the list is not empty, the message is only visible to the users in the list","items":{"type":"string"},"title":"Restricted visibility","type":"array","x-stream-index":"040"},"shadowed":{"description":"Whether the message was shadowed or not","title":"Shadowed","type":"boolean","x-stream-docs-page-id":"moderation#shadow-ban","x-stream-index":"027"},"shared_location":{"$ref":"#/components/schemas/SharedLocationResponseData","description":"Contains shared location data","title":"Shared Location","x-stream-index":"043"},"show_in_channel":{"description":"Whether thread reply should be shown in the channel as well","title":"Show in channel","type":"boolean","x-stream-docs-page-id":"threads","x-stream-index":"016"},"silent":{"description":"Whether message is silent or not","title":"Silent","type":"boolean","x-stream-index":"031"},"text":{"description":"Text of the message. Should be empty if `mml` is provided","title":"Text","type":"string","x-stream-index":"002"},"thread_participants":{"description":"List of users who participate in thread","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Thread participants","type":"array","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"021"},"type":{"description":"Contains type of the message","enum":["regular","ephemeral","error","reply","system","deleted"],"title":"Message Type","type":"string","x-stream-docs-page-id":"message_format#message-types","x-stream-index":"006"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"024"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Sender of the message. Required when using server-side API","title":"User object","x-stream-index":"007"}},"required":["id","text","html","type","user","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned","restricted_visibility"],"title":"Message","type":"object","x-stream-docs-page-id":"send_message"},"MessageStatsResponse":{"properties":{"count_over_time":{"items":{"$ref":"#/components/schemas/CountByMinuteResponse"},"type":"array","x-stream-index":"001"}},"type":"object"},"MessageUnblockedEvent":{"properties":{"cid":{"type":"string","x-stream-index":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"002.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"002.002"},"type":{"default":"message.unblocked","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["cid","type","created_at"],"title":"MessageUnblockedEvent","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"},"MessageUndeletedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"005.002"},"channel_type":{"type":"string","x-stream-index":"005.003"},"cid":{"type":"string","x-stream-index":"005.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"002.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"message.undeleted","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MessageUndeletedEvent","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"},"MessageUpdate":{"properties":{"change_set":{"$ref":"#/components/schemas/MessageChangeSet","x-stream-index":"002"},"old_text":{"type":"string","x-stream-index":"001"}},"type":"object"},"MessageUpdatedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"005.002"},"channel_type":{"type":"string","x-stream-index":"005.003"},"cid":{"type":"string","x-stream-index":"005.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"002.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"message.updated","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MessageUpdatedEvent","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"},"MessageWithChannelResponse":{"description":"Represents any chat message","properties":{"attachments":{"description":"Array of message attachments","items":{"$ref":"#/components/schemas/Attachment"},"title":"Message attachments","type":"array","x-stream-docs-page-id":"message_format#attachment-format","x-stream-index":"001.008"},"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel object","title":"Channel","x-stream-index":"002"},"cid":{"description":"Channel unique identifier in \u003ctype\u003e:\u003cid\u003e format","title":"Channel CID","type":"string","x-stream-index":"001.022"},"command":{"description":"Contains provided slash command","title":"Command","type":"string","x-stream-docs-page-id":"custom_commands_webhook","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.023"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.026"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"001.025"},"deleted_for_me":{"type":"boolean","x-stream-index":"001.044"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"001.018"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001.041"},"html":{"description":"Contains HTML markup of the message. Can only be set when using server-side API","title":"HTML content","type":"string","x-stream-index":"001.005"},"i18n":{"additionalProperties":{"type":"string"},"description":"Object with translations. Key `language` contains the original language key. Other keys contain translations","title":"Internationalization info","type":"object","x-stream-docs-page-id":"translation","x-stream-index":"001.030"},"id":{"description":"Message ID is unique string identifier of the message","title":"ID","type":"string","x-stream-index":"001.001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"Contains image moderation information","title":"Image moderation labels","type":"object","x-stream-index":"001.028"},"latest_reactions":{"description":"List of 10 latest reactions to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Latest reactions","type":"array","x-stream-index":"001.009"},"mentioned_users":{"description":"List of mentioned users","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Mentioned Users","type":"array","x-stream-index":"001.029"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"001.036"},"mml":{"description":"Should be empty if `text` is provided. Can only be set when using server-side API","title":"Messaging Markup Language","type":"string","x-stream-docs-page-id":"mml_overview","x-stream-index":"001.003"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"001.039"},"own_reactions":{"description":"List of 10 latest reactions of authenticated user to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Own reactions","type":"array","x-stream-index":"001.010"},"parent_id":{"description":"ID of parent message (thread)","title":"Parent message ID","type":"string","x-stream-docs-page-id":"threads","x-stream-index":"001.015"},"pin_expires":{"description":"Date when pinned message expires","format":"date-time","title":"Pin expiration date","type":"number","x-stream-docs-page-id":"pinned_messages","x-stream-index":"001.035"},"pinned":{"description":"Whether message is pinned or not","title":"Pinned","type":"boolean","x-stream-docs-page-id":"pinned_messages","x-stream-index":"001.032"},"pinned_at":{"description":"Date when message got pinned","format":"date-time","title":"Pinned at","type":"number","x-stream-docs-page-id":"pinned_messages","x-stream-index":"001.033"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","description":"Contains user who pinned the message","title":"Pinned by","x-stream-docs-page-id":"pinned_messages","x-stream-index":"001.034"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001.038"},"poll_id":{"description":"Identifier of the poll to include in the message","title":"Poll ID","type":"string","x-stream-index":"001.037"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","description":"Contains quoted message","title":"Quoted message","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"001.020"},"quoted_message_id":{"title":"ID of quoted message","type":"string","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"001.019"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing number of reactions of each type. Key: reaction type (string), value: number of reactions (int)","title":"Reaction counts","type":"object","x-stream-index":"001.011"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"001.014"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing scores of reactions of each type. Key: reaction type (string), value: total score of reactions (int)","title":"Reaction scores","type":"object","x-stream-index":"001.012"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"001.042"},"reply_count":{"description":"Number of replies to this message","format":"int32","title":"Reply count","type":"integer","x-stream-index":"001.017"},"restricted_visibility":{"description":"A list of user ids that have restricted visibility to the message, if the list is not empty, the message is only visible to the users in the list","items":{"type":"string"},"title":"Restricted visibility","type":"array","x-stream-index":"001.040"},"shadowed":{"description":"Whether the message was shadowed or not","title":"Shadowed","type":"boolean","x-stream-docs-page-id":"moderation#shadow-ban","x-stream-index":"001.027"},"shared_location":{"$ref":"#/components/schemas/SharedLocationResponseData","description":"Contains shared location data","title":"Shared Location","x-stream-index":"001.043"},"show_in_channel":{"description":"Whether thread reply should be shown in the channel as well","title":"Show in channel","type":"boolean","x-stream-docs-page-id":"threads","x-stream-index":"001.016"},"silent":{"description":"Whether message is silent or not","title":"Silent","type":"boolean","x-stream-index":"001.031"},"text":{"description":"Text of the message. Should be empty if `mml` is provided","title":"Text","type":"string","x-stream-index":"001.002"},"thread_participants":{"description":"List of users who participate in thread","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Thread participants","type":"array","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"001.021"},"type":{"description":"Contains type of the message","enum":["regular","ephemeral","error","reply","system","deleted"],"title":"Message Type","type":"string","x-stream-docs-page-id":"message_format#message-types","x-stream-index":"001.006"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.024"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Sender of the message. Required when using server-side API","title":"User object","x-stream-index":"001.007"}},"required":["id","text","html","type","user","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned","restricted_visibility","channel"],"title":"Message","type":"object","x-stream-docs-page-id":"send_message"},"ModerationActionConfig":{"nullable":true,"properties":{"action":{"type":"string","x-stream-index":"006"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"009"},"description":{"type":"string","x-stream-index":"008"},"entity_type":{"type":"string","x-stream-index":"004"},"icon":{"type":"string","x-stream-index":"007"},"order":{"format":"int32","type":"integer","x-stream-index":"005"}},"required":["entity_type","order","action","icon","description","custom"],"type":"object"},"ModerationCheckCompletedEvent":{"description":"This event is sent when a moderation check is completed","nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"entity_id":{"description":"The ID of entity which was moderated","title":"EntityID","type":"string","x-stream-index":"002"},"entity_type":{"description":"The type of the entity which was moderated","title":"EntityType","type":"string","x-stream-index":"003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"recommended_action":{"description":"The recommended action","title":"RecommendedAction","type":"string","x-stream-index":"004"},"review_queue_item_id":{"description":"The review queue item ID","title":"ReviewQueueItemID","type":"string","x-stream-index":"005"},"type":{"default":"moderation_check.completed","type":"string","x-stream-index":"001.002"}},"required":["type","created_at","custom","entity_id","entity_type","recommended_action","review_queue_item_id"],"title":"ModerationCheckCompletedEvent","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"},"ModerationCustomActionEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"001"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"002"},"type":{"default":"moderation.custom_action","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationCustomActionEvent","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"},"ModerationDashboardPreferences":{"properties":{"flag_user_on_flagged_content":{"type":"boolean","x-stream-index":"002"},"media_queue_blur_enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"ModerationFlagResponse":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"015"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"entity_creator_id":{"type":"string","x-stream-index":"007"},"entity_id":{"type":"string","x-stream-index":"006"},"entity_type":{"type":"string","x-stream-index":"005"},"labels":{"items":{"type":"string"},"type":"array","x-stream-index":"011"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"008"},"reason":{"type":"string","x-stream-index":"009"},"result":{"items":{"additionalProperties":{},"type":"object"},"type":"array","x-stream-index":"012"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","x-stream-index":"014"},"review_queue_item_id":{"type":"string","x-stream-index":"013"},"type":{"type":"string","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"016"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"004"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["type","user_id","entity_type","entity_id","result","created_at","updated_at"],"type":"object"},"ModerationFlaggedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"item":{"type":"string","x-stream-index":"001"},"object_id":{"type":"string","x-stream-index":"002"},"type":{"default":"moderation.flagged","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationFlaggedEvent","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"},"ModerationMarkReviewedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"001"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"002"},"type":{"default":"moderation.mark_reviewed","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationMarkReviewedEvent","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"},"ModerationPayload":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"images":{"items":{"type":"string"},"maximum":30,"type":"array","x-stream-index":"002"},"texts":{"items":{"type":"string"},"type":"array","x-stream-index":"001"},"videos":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"type":"object"},"ModerationResponse":{"properties":{"action":{"type":"string","x-stream-index":"004"},"explicit":{"format":"float","type":"number","x-stream-index":"002"},"spam":{"format":"float","type":"number","x-stream-index":"003"},"toxic":{"format":"float","type":"number","x-stream-index":"001"}},"required":["toxic","explicit","spam","action","automod_response"],"type":"object"},"ModerationRuleV2Response":{"properties":{"action":{"$ref":"#/components/schemas/RuleBuilderAction","x-stream-index":"010"},"conditions":{"items":{"$ref":"#/components/schemas/RuleBuilderCondition"},"type":"array","x-stream-index":"007"},"config_keys":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"cooldown_period":{"type":"string","x-stream-index":"011"},"created_at":{"format":"date-time","type":"number","x-stream-index":"013"},"description":{"type":"string","x-stream-index":"003"},"enabled":{"type":"boolean","x-stream-index":"012"},"groups":{"items":{"$ref":"#/components/schemas/RuleBuilderConditionGroup"},"type":"array","x-stream-index":"009"},"id":{"type":"string","x-stream-index":"001"},"logic":{"type":"string","x-stream-index":"008"},"name":{"type":"string","x-stream-index":"002"},"rule_type":{"type":"string","x-stream-index":"006"},"team":{"type":"string","x-stream-index":"005"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"014"}},"required":["id","name","description","config_keys","team","rule_type","action","enabled","created_at","updated_at"],"type":"object"},"ModerationV2Response":{"properties":{"action":{"type":"string","x-stream-index":"001"},"blocklist_matched":{"type":"string","x-stream-index":"005"},"image_harms":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"original_text":{"type":"string","x-stream-index":"002"},"platform_circumvented":{"type":"boolean","x-stream-index":"007"},"semantic_filter_matched":{"type":"string","x-stream-index":"006"},"text_harms":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"required":["action","original_text"],"type":"object"},"MuteChannelRequest":{"nullable":true,"properties":{"channel_cids":{"description":"Channel CIDs to mute (if multiple channels)","items":{"type":"string"},"maximum":25,"title":"Channel CIDs","type":"array","x-stream-index":"002"},"expiration":{"description":"Duration of mute in milliseconds","title":"Expiration","type":"integer","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"type":"object"},"MuteChannelResponse":{"nullable":true,"properties":{"channel_mute":{"$ref":"#/components/schemas/ChannelMute","description":"Object with channel mute (if one channel was muted)","title":"Channel mute","x-stream-index":"001"},"channel_mutes":{"description":"Object with mutes (if multiple channels were muted)","items":{"$ref":"#/components/schemas/ChannelMute"},"title":"Channel mutes","type":"array","x-stream-index":"002"},"duration":{"type":"string","x-stream-index":"004.001"},"own_user":{"$ref":"#/components/schemas/OwnUser","description":"Authorized user object with fresh mutes information","title":"Own user","x-stream-index":"003"}},"required":["duration"],"type":"object"},"MuteRequest":{"nullable":true,"properties":{"target_ids":{"description":"User IDs to mute (if multiple users)","items":{"type":"string"},"title":"Target IDs","type":"array","x-stream-index":"001"},"timeout":{"description":"Duration of mute in minutes","minimum":0,"title":"Timeout","type":"integer","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"required":["target_ids"],"title":"MuteRequest","type":"object"},"MuteResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"004.001"},"mutes":{"description":"Object with mutes (if multiple users were muted)","items":{"$ref":"#/components/schemas/UserMute"},"title":"Mutes","type":"array","x-stream-index":"001"},"non_existing_users":{"description":"A list of users that can't be found. Common cause for this is deleted users","items":{"type":"string"},"title":"Non Existing Users","type":"array","x-stream-index":"003"},"own_user":{"$ref":"#/components/schemas/OwnUser","description":"Authorized user object with fresh mutes information","title":"Own User","x-stream-index":"002"}},"required":["duration"],"title":"MuteResponse","type":"object"},"MuteUsersRequest":{"nullable":true,"properties":{"audio":{"title":"Audio","type":"boolean","x-stream-index":"005"},"mute_all_users":{"type":"boolean","x-stream-index":"003"},"muted_by":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"010"},"muted_by_id":{"type":"string","x-stream-index":"009"},"screenshare":{"title":"Screenshare","type":"boolean","x-stream-index":"007"},"screenshare_audio":{"title":"ScreenshareAudio","type":"boolean","x-stream-index":"008"},"user_ids":{"items":{"type":"string"},"title":"UserIDs","type":"array","x-stream-index":"004"},"video":{"title":"Video","type":"boolean","x-stream-index":"006"}},"title":"MuteUsersRequest","type":"object"},"MuteUsersResponse":{"description":"MuteUsersResponse is the response payload for the mute users endpoint.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"MuteUsersResponse","type":"object"},"NetworkMetricsReportResponse":{"properties":{"average_connection_time":{"format":"float","type":"number","x-stream-index":"003"},"average_jitter":{"format":"float","type":"number","x-stream-index":"002"},"average_latency":{"format":"float","type":"number","x-stream-index":"001"},"average_time_to_reconnect":{"format":"float","type":"number","x-stream-index":"004"}},"type":"object"},"NoiseCancellationSettings":{"properties":{"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode"],"type":"object"},"NotificationConfig":{"properties":{"track_read":{"description":"Whether to track read status","title":"Track Read","type":"boolean","x-stream-index":"002"},"track_seen":{"description":"Whether to track seen status","title":"Track Seen","type":"boolean","x-stream-index":"001"}},"title":"Notification Configuration","type":"object"},"NotificationFeedUpdatedEvent":{"description":"Emitted when notification feed is updated.","nullable":true,"properties":{"aggregated_activities":{"description":"Aggregated activities for notification feeds","items":{"$ref":"#/components/schemas/AggregatedActivityResponse"},"title":"Aggregated Activities","type":"array","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"003.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.001.007"},"feed_visibility":{"type":"string","x-stream-index":"003.003"},"fid":{"description":"The ID of the feed","title":"Feed ID","type":"string","x-stream-index":"003.002"},"notification_status":{"$ref":"#/components/schemas/NotificationStatusResponse","description":"Notification status including unread/unseen counts","title":"Notification Status","x-stream-index":"002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.001.004"},"type":{"default":"feeds.notification_feed.updated","description":"The type of event: \"feeds.notification_feed.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"003.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who triggered the notification","title":"User","x-stream-index":"004.001"}},"required":["type","created_at","custom","fid"],"title":"NotificationFeedUpdatedEvent","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"},"NotificationMarkUnreadEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003.004"},"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"003.005"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"first_unread_message_id":{"type":"string","x-stream-index":"005"},"last_read_at":{"format":"date-time","type":"number","x-stream-index":"006"},"last_read_message_id":{"type":"string","x-stream-index":"012"},"team":{"type":"string","x-stream-index":"002.001"},"thread_id":{"type":"string","x-stream-index":"013"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"009"},"type":{"default":"notification.mark_unread","type":"string","x-stream-index":"001.001"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"010"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"008"},"unread_messages":{"format":"int32","type":"integer","x-stream-index":"007"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"011"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count","first_unread_message_id","last_read_at","unread_messages","unread_count","total_unread_count","unread_channels","unread_threads"],"title":"NotificationMarkUnreadEvent","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"},"NotificationSettings":{"properties":{"call_live_started":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"002"},"call_missed":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"006"},"call_notification":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"004"},"call_ring":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"session_started":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"003"}},"required":["enabled","call_live_started","session_started","call_notification","call_ring","call_missed"],"type":"object"},"NotificationStatusResponse":{"properties":{"last_read_at":{"format":"date-time","type":"number","x-stream-index":"006"},"last_seen_at":{"description":"When notifications were last seen","format":"date-time","title":"Last Seen At","type":"number","x-stream-index":"005"},"read_activities":{"description":"IDs of activities that have been read","items":{"type":"string"},"title":"Read Activities","type":"array","x-stream-index":"003"},"seen_activities":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"unread":{"description":"Number of unread notifications","format":"int32","title":"Unread","type":"integer","x-stream-index":"001"},"unseen":{"description":"Number of unseen notifications","format":"int32","title":"Unseen","type":"integer","x-stream-index":"002"}},"required":["unread","unseen"],"title":"Notification Status","type":"object"},"NullTime":{"type":"object"},"OCRRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"}},"required":["label","action"],"type":"object"},"OnlyUserID":{"properties":{"id":{"type":"string","x-stream-index":"001"}},"required":["id"],"type":"object"},"OwnCapability":{"description":"All possibility of string to use","enum":["block-users","change-max-duration","create-call","create-reaction","enable-noise-cancellation","end-call","join-backstage","join-call","join-ended-call","kick-user","mute-users","pin-for-everyone","read-call","remove-call-member","screenshare","send-audio","send-video","start-broadcast-call","start-closed-captions-call","start-frame-record-call","start-record-call","start-transcription-call","stop-broadcast-call","stop-closed-captions-call","stop-frame-record-call","stop-record-call","stop-transcription-call","update-call","update-call-member","update-call-permissions","update-call-settings"],"title":"OwnCapability","type":"string"},"OwnUser":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"046"},"banned":{"type":"boolean","x-stream-index":"016"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"045"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"029"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"014"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"013"},"devices":{"items":{"$ref":"#/components/schemas/Device"},"type":"array","x-stream-index":"027"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"023"},"language":{"type":"string","x-stream-index":"035"},"last_active":{"format":"date-time","type":"number","x-stream-index":"011"},"last_engaged_at":{"format":"date-time","type":"number","x-stream-index":"012"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"037"},"mutes":{"items":{"$ref":"#/components/schemas/UserMute"},"type":"array","x-stream-index":"028"},"online":{"type":"boolean","x-stream-index":"022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"026"},"push_preferences":{"$ref":"#/components/schemas/PushPreferences","x-stream-index":"025"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"005"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"031"},"total_unread_count_by_team":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"032"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"033"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"030"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"034"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"}},"required":["id","role","custom","created_at","updated_at","banned","online","devices","mutes","channel_mutes","unread_count","total_unread_count","total_unread_count_by_team","unread_channels","unread_threads","language"],"type":"object"},"OwnUserResponse":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"banned":{"type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"015"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.011"},"devices":{"items":{"$ref":"#/components/schemas/DeviceResponse"},"title":"Devices","type":"array","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001.001"},"image":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"005"},"language":{"type":"string","x-stream-index":"001.005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"001.014"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"013"},"mutes":{"items":{"$ref":"#/components/schemas/UserMuteResponse"},"type":"array","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"001.002"},"online":{"type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"003"},"push_preferences":{"$ref":"#/components/schemas/PushPreferences","x-stream-index":"002"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.015"},"role":{"type":"string","x-stream-index":"001.006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"009"},"total_unread_count_by_team":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"010"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"011"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"008"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"012"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","devices","invisible","mutes","channel_mutes","unread_count","total_unread_count","unread_channels","unread_threads"],"type":"object"},"PagerRequest":{"properties":{"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"002"},"prev":{"type":"string","x-stream-index":"003"}},"type":"object"},"PagerResponse":{"properties":{"next":{"type":"string","x-stream-index":"001"},"prev":{"type":"string","x-stream-index":"002"}},"type":"object"},"PaginationParams":{"properties":{"limit":{"format":"int32","minimum":0,"type":"integer","x-stream-index":"001"},"offset":{"format":"int32","type":"integer","x-stream-index":"002"}},"type":"object"},"ParticipantCountByMinuteResponse":{"nullable":true,"properties":{"first":{"format":"int32","type":"integer","x-stream-index":"002"},"last":{"format":"int32","type":"integer","x-stream-index":"003"},"max":{"format":"int32","type":"integer","x-stream-index":"004"},"min":{"format":"int32","type":"integer","x-stream-index":"005"},"start_ts":{"format":"date-time","type":"number","x-stream-index":"001"}},"required":["start_ts","first","last","max","min"],"type":"object"},"ParticipantCountOverTimeResponse":{"properties":{"by_minute":{"items":{"$ref":"#/components/schemas/ParticipantCountByMinuteResponse"},"type":"array","x-stream-index":"001"}},"type":"object"},"ParticipantReportResponse":{"properties":{"by_browser":{"items":{"$ref":"#/components/schemas/GroupedStatsResponse"},"type":"array","x-stream-index":"008"},"by_country":{"items":{"$ref":"#/components/schemas/GroupedStatsResponse"},"type":"array","x-stream-index":"005"},"by_device":{"items":{"$ref":"#/components/schemas/GroupedStatsResponse"},"type":"array","x-stream-index":"006"},"by_operating_system":{"items":{"$ref":"#/components/schemas/GroupedStatsResponse"},"type":"array","x-stream-index":"007"},"count_over_time":{"$ref":"#/components/schemas/ParticipantCountOverTimeResponse","x-stream-index":"004"},"max_concurrent":{"format":"int32","type":"integer","x-stream-index":"003"},"publishers":{"$ref":"#/components/schemas/PublisherStatsResponse","x-stream-index":"009"},"subscribers":{"$ref":"#/components/schemas/SubscriberStatsResponse","x-stream-index":"010"},"sum":{"format":"int32","type":"integer","x-stream-index":"001"},"unique":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["sum","unique"],"type":"object"},"PendingMessageEvent":{"description":"Pending message event for async moderation","nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"002.007"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"message":{"$ref":"#/components/schemas/Message","description":"The pending message","title":"Message","x-stream-index":"002.009"},"metadata":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"002.010"},"method":{"description":"The method used for the pending message","title":"Method","type":"string","x-stream-index":"003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"type":{"default":"message.pending","description":"The type of event: \"message.pending\" in this case","title":"Event Type","type":"string","x-stream-index":"001.002"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.002"}},"required":["type","custom","method","created_at"],"title":"PendingMessageEvent","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"},"PendingMessageResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"003"},"metadata":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"}},"type":"object"},"PerSDKUsageReport":{"nullable":true,"properties":{"by_version":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"002"},"total":{"format":"int32","type":"integer","x-stream-index":"001"}},"required":["total","by_version"],"type":"object"},"Permission":{"properties":{"action":{"description":"Action name this permission is for (e.g. SendMessage)","title":"Action","type":"string","x-stream-index":"004"},"condition":{"additionalProperties":{},"description":"MongoDB style condition which decides whether or not the permission is granted","title":"Condition","type":"object","x-stream-index":"007"},"custom":{"description":"Whether this is a custom permission or built-in","title":"Custom","type":"boolean","x-stream-index":"009"},"description":{"description":"Description of the permission","title":"Description","type":"string","x-stream-index":"003"},"id":{"description":"Unique permission ID","title":"ID","type":"string","x-stream-index":"001"},"level":{"description":"Level at which permission could be applied (app or channel)","enum":["app","channel"],"title":"Level","type":"string","x-stream-index":"010"},"name":{"description":"Name of the permission","title":"Name","type":"string","x-stream-index":"002"},"owner":{"description":"Whether this permission applies to resource owner or not","title":"Owner","type":"boolean","x-stream-index":"005"},"same_team":{"description":"Whether this permission applies to teammates (multi-tenancy mode only)","title":"Same team","type":"boolean","x-stream-index":"006"},"tags":{"description":"List of tags of the permission","items":{"type":"string"},"title":"Tags","type":"array","x-stream-index":"011"}},"required":["id","name","description","action","owner","same_team","custom","level","tags"],"type":"object"},"PermissionRequestEvent":{"description":"This event is sent when a user requests access to a feature on a call,\nclients receiving this event should display a permission request to the user","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"permissions":{"description":"The list of permissions requested by the user","items":{"type":"string"},"title":"Permissions","type":"array","x-stream-index":"004"},"type":{"default":"call.permission_request","description":"The type of event: \"call.permission_request\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who sent the permission request","title":"User","x-stream-index":"003"}},"required":["type","created_at","call_cid","user","permissions"],"title":"PermissionRequestEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"PinActivityRequest":{"nullable":true,"properties":{"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"005.002"},"user_id":{"type":"string","x-stream-index":"005.001"}},"title":"Pin Activity Request","type":"object"},"PinActivityResponse":{"nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","description":"The pinned activity","title":"Activity","x-stream-index":"001"},"created_at":{"description":"When the activity was pinned","format":"date-time","title":"Created At","type":"number","x-stream-index":"004"},"duration":{"type":"string","x-stream-index":"005.001"},"feed":{"description":"Fully qualified ID of the feed the activity was pinned to","title":"Feed ID","type":"string","x-stream-index":"002"},"user_id":{"description":"ID of the user who pinned the activity","title":"User ID","type":"string","x-stream-index":"003"}},"required":["activity","feed","user_id","created_at","duration"],"title":"Pin Activity Response","type":"object"},"PinRequest":{"description":"PinRequest is the payload for pinning a message.","nullable":true,"properties":{"session_id":{"description":"the session ID of the user who pinned the message","title":"SessionID","type":"string","x-stream-index":"003"},"user_id":{"description":"the user ID of the user who pinned the message","title":"UserID","type":"string","x-stream-index":"002"}},"required":["user_id","session_id"],"title":"PinRequest","type":"object"},"PinResponse":{"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"},"PlatformDataResponse":{"properties":{"browser":{"$ref":"#/components/schemas/BrowserDataResponse","x-stream-index":"003"},"device":{"$ref":"#/components/schemas/DeviceDataResponse","x-stream-index":"002"},"os":{"$ref":"#/components/schemas/ClientOSDataResponse","x-stream-index":"001"}},"required":["os","device","browser"],"type":"object"},"Policy":{"properties":{"action":{"type":"integer","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"010"},"name":{"type":"string","x-stream-index":"004"},"owner":{"type":"boolean","x-stream-index":"008"},"priority":{"format":"int32","type":"integer","x-stream-index":"009"},"resources":{"items":{"type":"string"},"type":"array","x-stream-index":"005"},"roles":{"items":{"type":"string"},"type":"array","x-stream-index":"006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"011"}},"required":["name","resources","roles","action","owner","priority","created_at","updated_at"],"type":"object"},"PolicyRequest":{"description":"Policy request","properties":{"action":{"enum":["Deny","Allow"],"title":"Action","type":"string","x-stream-index":"001"},"name":{"description":"User-friendly policy name","title":"Name","type":"string","x-stream-index":"002"},"owner":{"description":"Whether policy applies to resource owner or not","title":"Owner","type":"boolean","x-stream-index":"005"},"priority":{"description":"Policy priority","format":"int32","maximum":999,"minimum":1,"title":"Priority","type":"integer","x-stream-index":"006"},"resources":{"description":"List of resources to apply policy to","items":{"type":"string"},"minimum":1,"title":"Resources","type":"array","x-stream-index":"003"},"roles":{"description":"List of roles to apply policy to","items":{"type":"string"},"title":"Roles","type":"array","x-stream-index":"004"}},"required":["action","name","resources","roles","owner","priority"],"title":"PolicyRequest","type":"object"},"Poll":{"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"023"},"allow_answers":{"type":"boolean","x-stream-index":"010"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"009"},"answers_count":{"format":"int32","type":"integer","x-stream-index":"015"},"created_at":{"format":"date-time","type":"number","x-stream-index":"021"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"020"},"created_by_id":{"type":"string","x-stream-index":"019"},"description":{"type":"string","x-stream-index":"005"},"enforce_unique_vote":{"type":"boolean","x-stream-index":"007"},"id":{"type":"string","x-stream-index":"003"},"is_closed":{"type":"boolean","x-stream-index":"011"},"latest_answers":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array","x-stream-index":"017"},"latest_votes_by_option":{"additionalProperties":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array"},"type":"object","x-stream-index":"016"},"max_votes_allowed":{"format":"int32","type":"integer","x-stream-index":"008"},"name":{"type":"string","x-stream-index":"004"},"options":{"items":{"$ref":"#/components/schemas/PollOption"},"type":"array","x-stream-index":"013"},"own_votes":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array","x-stream-index":"018"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"022"},"vote_count":{"format":"int32","type":"integer","x-stream-index":"012"},"vote_counts_by_option":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"014"},"voting_visibility":{"type":"string","x-stream-index":"006"}},"required":["id","name","description","enforce_unique_vote","allow_user_suggested_options","allow_answers","vote_count","options","vote_counts_by_option","answers_count","latest_votes_by_option","latest_answers","own_votes","created_by_id","created_at","updated_at","Custom"],"type":"object"},"PollOption":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id","text","custom"],"type":"object"},"PollOptionInput":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"text":{"type":"string","x-stream-index":"002"}},"type":"object"},"PollOptionRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id"],"type":"object"},"PollOptionResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"poll_option":{"$ref":"#/components/schemas/PollOptionResponseData","description":"Poll option","title":"PollOptionResponseData","x-stream-index":"001"}},"required":["poll_option","duration"],"type":"object"},"PollOptionResponseData":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id","text","custom"],"type":"object"},"PollResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"poll":{"$ref":"#/components/schemas/PollResponseData","description":"Poll","title":"PollResponseData","x-stream-index":"001"}},"required":["poll","duration"],"type":"object"},"PollResponseData":{"properties":{"allow_answers":{"type":"boolean","x-stream-index":"008"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"007"},"answers_count":{"format":"int32","type":"integer","x-stream-index":"012"},"created_at":{"format":"date-time","type":"number","x-stream-index":"019"},"created_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"018"},"created_by_id":{"type":"string","x-stream-index":"017"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"021"},"description":{"type":"string","x-stream-index":"003"},"enforce_unique_vote":{"type":"boolean","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"is_closed":{"type":"boolean","x-stream-index":"009"},"latest_answers":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array","x-stream-index":"015"},"latest_votes_by_option":{"additionalProperties":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array"},"type":"object","x-stream-index":"014"},"max_votes_allowed":{"format":"int32","type":"integer","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"002"},"options":{"items":{"$ref":"#/components/schemas/PollOptionResponseData"},"type":"array","x-stream-index":"011"},"own_votes":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array","x-stream-index":"016"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"020"},"vote_count":{"format":"int32","type":"integer","x-stream-index":"010"},"vote_counts_by_option":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"013"},"voting_visibility":{"type":"string","x-stream-index":"004"}},"required":["id","name","description","voting_visibility","enforce_unique_vote","allow_user_suggested_options","allow_answers","vote_count","options","answers_count","vote_counts_by_option","latest_votes_by_option","latest_answers","own_votes","created_by_id","created_at","updated_at","custom"],"type":"object"},"PollVote":{"nullable":true,"properties":{"answer_text":{"type":"string","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"004"},"is_answer":{"type":"boolean","x-stream-index":"006"},"option_id":{"type":"string","x-stream-index":"005"},"poll_id":{"type":"string","x-stream-index":"003"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"011"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"009"},"user_id":{"type":"string","x-stream-index":"008"}},"required":["poll_id","id","option_id","created_at","updated_at"],"type":"object"},"PollVoteResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"vote":{"$ref":"#/components/schemas/PollVoteResponseData","description":"Poll vote","title":"PollVoteResponseData","x-stream-index":"001"}},"required":["duration"],"type":"object"},"PollVoteResponseData":{"nullable":true,"properties":{"answer_text":{"type":"string","x-stream-index":"005"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"id":{"type":"string","x-stream-index":"002"},"is_answer":{"type":"boolean","x-stream-index":"004"},"option_id":{"type":"string","x-stream-index":"003"},"poll_id":{"type":"string","x-stream-index":"001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"007"},"user_id":{"type":"string","x-stream-index":"006"}},"required":["poll_id","id","option_id","created_at","updated_at"],"type":"object"},"PollVotesResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"votes":{"description":"Poll votes","items":{"$ref":"#/components/schemas/PollVoteResponseData"},"title":"PollVoteResponseList","type":"array","x-stream-index":"001"}},"required":["votes","duration"],"type":"object"},"PrivacySettings":{"properties":{"read_receipts":{"$ref":"#/components/schemas/ReadReceipts","x-stream-index":"002"},"typing_indicators":{"$ref":"#/components/schemas/TypingIndicators","x-stream-index":"001"}},"type":"object"},"PrivacySettingsResponse":{"properties":{"read_receipts":{"$ref":"#/components/schemas/ReadReceiptsResponse","x-stream-index":"002"},"typing_indicators":{"$ref":"#/components/schemas/TypingIndicatorsResponse","x-stream-index":"001"}},"type":"object"},"PublisherAllMetrics":{"properties":{"audio":{"$ref":"#/components/schemas/PublisherAudioMetrics","x-stream-index":"001"},"rtt_ms":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"003"},"video":{"$ref":"#/components/schemas/PublisherVideoMetrics","x-stream-index":"002"}},"type":"object"},"PublisherAudioMetrics":{"properties":{"jitter_ms":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"001"}},"type":"object"},"PublisherStatsResponse":{"properties":{"by_track":{"items":{"$ref":"#/components/schemas/TrackStatsResponse"},"type":"array","x-stream-index":"003"},"total":{"format":"int32","type":"integer","x-stream-index":"001"},"unique":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["total","unique"],"type":"object"},"PublisherVideoMetrics":{"properties":{"bitrate":{"$ref":"#/components/schemas/ActiveCallsBitrateStats","x-stream-index":"005"},"fps_30":{"$ref":"#/components/schemas/ActiveCallsFPSStats","x-stream-index":"002"},"frame_encoding_time_ms":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"003"},"jitter_ms":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"001"},"resolution":{"$ref":"#/components/schemas/ActiveCallsResolutionStats","x-stream-index":"004"}},"type":"object"},"PublishersMetrics":{"properties":{"all":{"$ref":"#/components/schemas/PublisherAllMetrics","x-stream-index":"001"}},"type":"object"},"PushConfig":{"properties":{"offline_only":{"type":"boolean","x-stream-index":"002"},"version":{"enum":["v1","v2","v3"],"type":"string","x-stream-index":"001"}},"required":["version"],"type":"object"},"PushNotificationConfig":{"properties":{"activity_types":{"enum":["follow","comment","reaction","comment_reaction"],"items":{"type":"string"},"type":"array","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"PushNotificationFields":{"properties":{"apn":{"$ref":"#/components/schemas/APNConfigFields","x-stream-index":"002"},"firebase":{"$ref":"#/components/schemas/FirebaseConfigFields","x-stream-index":"003"},"huawei":{"$ref":"#/components/schemas/HuaweiConfigFields","x-stream-index":"004"},"offline_only":{"type":"boolean","x-stream-index":"001.002"},"providers":{"items":{"$ref":"#/components/schemas/PushProvider"},"type":"array","x-stream-index":"006"},"version":{"type":"string","x-stream-index":"001.001"},"xiaomi":{"$ref":"#/components/schemas/XiaomiConfigFields","x-stream-index":"005"}},"required":["version","offline_only","apn","firebase","huawei","xiaomi"],"type":"object"},"PushNotificationSettingsResponse":{"properties":{"disabled":{"type":"boolean","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"number","x-stream-index":"002"}},"type":"object"},"PushPreferenceInput":{"nullable":true,"properties":{"call_level":{"description":"Set the level of call push notifications for the user. One of all, none, default","enum":["all","none","default"],"type":"string","x-stream-index":"004"},"channel_cid":{"description":"Set the push preferences for a specific channel. If empty it sets the default for the user","type":"string","x-stream-index":"002"},"chat_level":{"description":"Set the level of chat push notifications for the user. One of all, mentions, none, default","enum":["all","mentions","none","default"],"type":"string","x-stream-index":"003"},"disabled_until":{"description":"Disable push notifications till a certain time","format":"date-time","type":"number","x-stream-index":"007"},"feeds_events":{"$ref":"#/components/schemas/FeedsEventPreferencesInput","description":"Set granular feeds event preferences for reactions, comments, new followers, and mentions","x-stream-index":"006"},"feeds_level":{"description":"Set the level of feeds push notifications for the user. One of all, none, default","enum":["all","none","default"],"type":"string","x-stream-index":"005"},"remove_disable":{"description":"Remove the disabled until time. (IE stop snoozing notifications)","type":"boolean","x-stream-index":"008"},"user_id":{"description":"The user id for which to set the push preferences. Required when using server side auths, defaults to current user with client side auth.","type":"string","x-stream-index":"001"}},"type":"object"},"PushPreferences":{"properties":{"call_level":{"type":"string","x-stream-index":"002"},"chat_level":{"type":"string","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"number","x-stream-index":"005"},"feeds_events":{"$ref":"#/components/schemas/FeedsEventPreferences","x-stream-index":"004"},"feeds_level":{"type":"string","x-stream-index":"003"}},"type":"object"},"PushProvider":{"nullable":true,"properties":{"apn_auth_key":{"type":"string","x-stream-index":"012"},"apn_auth_type":{"type":"string","x-stream-index":"017"},"apn_development":{"type":"boolean","x-stream-index":"018"},"apn_host":{"type":"string","x-stream-index":"019"},"apn_key_id":{"type":"string","x-stream-index":"013"},"apn_notification_template":{"type":"string","x-stream-index":"020"},"apn_p12_cert":{"type":"string","x-stream-index":"014"},"apn_team_id":{"type":"string","x-stream-index":"015"},"apn_topic":{"type":"string","x-stream-index":"016"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"description":{"maxLength":128,"type":"string","x-stream-index":"007"},"disabled_at":{"format":"date-time","type":"number","x-stream-index":"010"},"disabled_reason":{"maxLength":255,"type":"string","x-stream-index":"011"},"firebase_apn_template":{"type":"string","x-stream-index":"025"},"firebase_credentials":{"type":"string","x-stream-index":"022"},"firebase_data_template":{"type":"string","x-stream-index":"023"},"firebase_host":{"type":"string","x-stream-index":"026"},"firebase_notification_template":{"type":"string","x-stream-index":"024"},"firebase_server_key":{"type":"string","x-stream-index":"021"},"huawei_app_id":{"type":"string","x-stream-index":"027"},"huawei_app_secret":{"type":"string","x-stream-index":"028"},"name":{"maxLength":36,"minLength":1,"type":"string","x-stream-index":"005"},"push_templates":{"items":{"$ref":"#/components/schemas/PushTemplate"},"type":"array","x-stream-index":"031"},"type":{"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"xiaomi_app_secret":{"type":"string","x-stream-index":"030"},"xiaomi_package_name":{"type":"string","x-stream-index":"029"}},"required":["name","type","created_at","updated_at"],"type":"object"},"PushProviderResponse":{"properties":{"apn_auth_key":{"type":"string","x-stream-index":"008"},"apn_auth_type":{"type":"string","x-stream-index":"013"},"apn_development":{"type":"boolean","x-stream-index":"014"},"apn_host":{"type":"string","x-stream-index":"015"},"apn_key_id":{"type":"string","x-stream-index":"009"},"apn_p12_cert":{"type":"string","x-stream-index":"010"},"apn_sandbox_certificate":{"type":"boolean","x-stream-index":"016"},"apn_supports_remote_notifications":{"type":"boolean","x-stream-index":"018"},"apn_supports_voip_notifications":{"type":"boolean","x-stream-index":"017"},"apn_team_id":{"type":"string","x-stream-index":"011"},"apn_topic":{"type":"string","x-stream-index":"012"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"description":{"type":"string","x-stream-index":"003"},"disabled_at":{"format":"date-time","type":"number","x-stream-index":"006"},"disabled_reason":{"type":"string","x-stream-index":"007"},"firebase_apn_template":{"type":"string","x-stream-index":"023"},"firebase_credentials":{"type":"string","x-stream-index":"020"},"firebase_data_template":{"type":"string","x-stream-index":"021"},"firebase_host":{"type":"string","x-stream-index":"024"},"firebase_notification_template":{"type":"string","x-stream-index":"022"},"firebase_server_key":{"type":"string","x-stream-index":"019"},"huawei_app_id":{"type":"string","x-stream-index":"025"},"huawei_app_secret":{"type":"string","x-stream-index":"026"},"name":{"type":"string","x-stream-index":"001"},"type":{"type":"string","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"005"},"xiaomi_app_secret":{"type":"string","x-stream-index":"028"},"xiaomi_package_name":{"type":"string","x-stream-index":"027"}},"required":["name","type","created_at","updated_at"],"type":"object"},"PushTemplate":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"enable_push":{"type":"boolean","x-stream-index":"003"},"event_type":{"enum":["message.new","message.updated","reaction.new","notification.reminder_due","feeds.activity.added","feeds.comment.added","feeds.activity.reaction.added","feeds.comment.reaction.added","feeds.follow.created","feeds.notification_feed.updated"],"type":"string","x-stream-index":"005"},"template":{"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"008"}},"required":["enable_push","event_type","created_at","updated_at"],"type":"object"},"Quality":{"properties":{"bitdepth":{"format":"int32","type":"integer","x-stream-index":"007"},"framerate":{"format":"int32","type":"integer","x-stream-index":"008"},"height":{"format":"int32","type":"integer","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"004"},"video_bitrate":{"format":"int32","type":"integer","x-stream-index":"009"},"width":{"format":"int32","type":"integer","x-stream-index":"005"}},"type":"object"},"QualityScoreReport":{"properties":{"histogram":{"items":{"$ref":"#/components/schemas/ReportByHistogramBucket"},"type":"array","x-stream-index":"001"}},"required":["histogram"],"type":"object"},"QualityScoreReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateQualityScoreReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"QueryActivitiesRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filters to apply to the query. Supports location-based queries with 'near' and 'within_bounds' operators.","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"Sorting parameters for the query","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"002"}},"title":"Query Activities Request","type":"object"},"QueryActivitiesResponse":{"nullable":true,"properties":{"activities":{"description":"List of activities matching the query","items":{"$ref":"#/components/schemas/ActivityResponse"},"title":"Activities","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"next":{"description":"Cursor for next page","title":"Next","type":"string","x-stream-index":"002.001"},"prev":{"description":"Cursor for previous page","title":"Previous","type":"string","x-stream-index":"002.002"}},"required":["activities","duration"],"title":"Query Activities Response","type":"object"},"QueryActivityReactionsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"type":"object","x-stream-index":"002"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"004.001"},"next":{"type":"string","x-stream-index":"004.002"},"prev":{"type":"string","x-stream-index":"004.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"type":"array","x-stream-index":"003"}},"type":"object"},"QueryActivityReactionsResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"reactions":{"items":{"$ref":"#/components/schemas/FeedsReactionResponse"},"type":"array","x-stream-index":"001"}},"required":["reactions","duration"],"title":"Response","type":"object"},"QueryAggregateCallStatsRequest":{"nullable":true,"properties":{"from":{"type":"string","x-stream-index":"002"},"report_types":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"to":{"type":"string","x-stream-index":"003"}},"type":"object"},"QueryAggregateCallStatsResponse":{"description":"Basic response information","nullable":true,"properties":{"call_duration_report":{"$ref":"#/components/schemas/CallDurationReportResponse","x-stream-index":"002"},"call_participant_count_report":{"$ref":"#/components/schemas/CallParticipantCountReportResponse","x-stream-index":"004"},"calls_per_day_report":{"$ref":"#/components/schemas/CallsPerDayReportResponse","x-stream-index":"003"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"network_metrics_report":{"$ref":"#/components/schemas/NetworkMetricsReportResponse","x-stream-index":"008"},"quality_score_report":{"$ref":"#/components/schemas/QualityScoreReportResponse","x-stream-index":"005"},"sdk_usage_report":{"$ref":"#/components/schemas/SDKUsageReportResponse","x-stream-index":"006"},"user_feedback_report":{"$ref":"#/components/schemas/UserFeedbackReportResponse","x-stream-index":"007"}},"required":["duration"],"title":"Response","type":"object"},"QueryBannedUsersPayload":{"properties":{"exclude_expired_bans":{"description":"Whether to exclude expired bans or not","title":"Exclude expired bans","type":"boolean","x-stream-index":"004"},"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"description":"Number of records to return","format":"int32","maximum":300,"minimum":0,"title":"Limit","type":"integer","x-stream-index":"003.003"},"offset":{"description":"Number of records to offset","format":"int32","maximum":10000,"title":"Offset","type":"integer","x-stream-index":"003.004"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":1,"title":"Sort","type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"005.002"},"user_id":{"type":"string","x-stream-index":"005.001"}},"required":["filter_conditions"],"type":"object"},"QueryBannedUsersResponse":{"nullable":true,"properties":{"bans":{"description":"List of found bans","items":{"$ref":"#/components/schemas/BanResponse"},"title":"BanResponse","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["bans","duration"],"type":"object"},"QueryBookmarkFoldersRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filters to apply to the query","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"Sorting parameters for the query","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"002"}},"title":"Query Bookmark Folders Request","type":"object"},"QueryBookmarkFoldersResponse":{"nullable":true,"properties":{"bookmark_folders":{"description":"List of bookmark folders matching the query","items":{"$ref":"#/components/schemas/BookmarkFolderResponse"},"title":"Bookmark Folders","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"next":{"description":"Cursor for next page","title":"Next","type":"string","x-stream-index":"002.001"},"prev":{"description":"Cursor for previous page","title":"Previous","type":"string","x-stream-index":"002.002"}},"required":["bookmark_folders","duration"],"title":"Query Bookmark Folders Response","type":"object"},"QueryBookmarksRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filters to apply to the query","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"Sorting parameters for the query","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"002"}},"title":"Query Bookmarks Request","type":"object"},"QueryBookmarksResponse":{"nullable":true,"properties":{"bookmarks":{"description":"List of bookmarks matching the query","items":{"$ref":"#/components/schemas/BookmarkResponse"},"title":"Bookmarks","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"next":{"description":"Cursor for next page","title":"Next","type":"string","x-stream-index":"002.001"},"prev":{"description":"Cursor for previous page","title":"Previous","type":"string","x-stream-index":"002.002"}},"required":["bookmarks","duration"],"title":"Query Bookmarks Response","type":"object"},"QueryCallMembersRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"002"},"id":{"maxLength":64,"type":"string","x-stream-index":"001.002"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"004.001"},"next":{"type":"string","x-stream-index":"004.002"},"prev":{"type":"string","x-stream-index":"004.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":1,"type":"array","x-stream-index":"003"},"type":{"maxLength":64,"type":"string","x-stream-index":"001.001"}},"required":["type","id"],"type":"object"},"QueryCallMembersResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["members","duration"],"title":"Response","type":"object"},"QueryCallParticipantsRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"003"}},"type":"object"},"QueryCallParticipantsResponse":{"nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001.001"},"duration":{"type":"string","x-stream-index":"004.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001.002"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"001.004"},"participants":{"description":"List of call participants","items":{"$ref":"#/components/schemas/CallParticipantResponse"},"title":"[]CallParticipantResponse","type":"array","x-stream-index":"002"},"total_participants":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["call","members","own_capabilities","blocked_users","participants","total_participants","duration"],"type":"object"},"QueryCallStatsRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"004.001"},"next":{"type":"string","x-stream-index":"004.002"},"prev":{"type":"string","x-stream-index":"004.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":2,"type":"array","x-stream-index":"002"}},"type":"object"},"QueryCallStatsResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"next":{"type":"string","x-stream-index":"003.001"},"prev":{"type":"string","x-stream-index":"003.002"},"reports":{"items":{"$ref":"#/components/schemas/CallStatsReportSummaryResponse"},"type":"array","x-stream-index":"001"}},"required":["reports","duration"],"title":"Response","type":"object"},"QueryCallsRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"title":"Filters","type":"object","x-stream-index":"003"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"006.001"},"next":{"type":"string","x-stream-index":"006.002"},"prev":{"type":"string","x-stream-index":"006.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":2,"title":"Sort","type":"array","x-stream-index":"004"}},"title":"QueryCallsRequest","type":"object"},"QueryCallsResponse":{"nullable":true,"properties":{"calls":{"items":{"$ref":"#/components/schemas/CallStateResponseFields"},"title":"Calls","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["calls","duration"],"title":"QueryCallsResponse","type":"object"},"QueryCampaignsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"004.001"},"next":{"type":"string","x-stream-index":"004.002"},"prev":{"type":"string","x-stream-index":"004.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"type":"array","x-stream-index":"002"},"user_limit":{"format":"int32","maximum":1000,"minimum":0,"type":"integer","x-stream-index":"003"}},"type":"object"},"QueryCampaignsResponse":{"description":"Basic response information","nullable":true,"properties":{"campaigns":{"items":{"$ref":"#/components/schemas/CampaignResponse"},"type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["campaigns","duration"],"title":"Response","type":"object"},"QueryChannelsRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"description":"Number of channels to limit","format":"int32","title":"Limit","type":"integer","x-stream-index":"008"},"member_limit":{"description":"Number of members to limit","format":"int32","maximum":100,"minimum":0,"title":"Member limit","type":"integer","x-stream-index":"007"},"message_limit":{"description":"Number of messages to limit","format":"int32","minimum":0,"title":"Message limit","type":"integer","x-stream-index":"006"},"offset":{"description":"Channel pagination offset","format":"int32","title":"Offset","type":"integer","x-stream-index":"009"},"sort":{"description":"List of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"002"},"state":{"description":"Whether to update channel state or not","title":"State","type":"boolean","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"010.002"},"user_id":{"type":"string","x-stream-index":"010.001"}},"title":"Query Channels Request","type":"object","x-stream-docs-page-id":"query_channels"},"QueryChannelsResponse":{"nullable":true,"properties":{"channels":{"description":"List of channels","items":{"$ref":"#/components/schemas/ChannelStateResponseFields"},"title":"Channels","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["channels","duration"],"title":"Channels list","type":"object"},"QueryCommentReactionsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"type":"object","x-stream-index":"002"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"004.001"},"next":{"type":"string","x-stream-index":"004.002"},"prev":{"type":"string","x-stream-index":"004.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"type":"array","x-stream-index":"003"}},"type":"object"},"QueryCommentReactionsResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"reactions":{"items":{"$ref":"#/components/schemas/FeedsReactionResponse"},"type":"array","x-stream-index":"001"}},"required":["reactions","duration"],"title":"Response","type":"object"},"QueryCommentsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"MongoDB-style filter for querying comments","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"description":"Maximum number of comments to return","format":"int32","maximum":100,"minimum":0,"title":"Limit","type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"first (oldest), last (newest) or top","enum":["first","last","top","best","controversial"],"title":"Sort Order","type":"string","x-stream-index":"002"}},"required":["filter"],"title":"Query Comments Request","type":"object"},"QueryCommentsResponse":{"nullable":true,"properties":{"comments":{"description":"List of comments matching the query","items":{"$ref":"#/components/schemas/CommentResponse"},"title":"Comments","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"next":{"description":"Cursor for next page","title":"Next","type":"string","x-stream-index":"002.001"},"prev":{"description":"Cursor for previous page","title":"Previous","type":"string","x-stream-index":"002.002"}},"required":["comments","duration"],"title":"Query Comments Response","type":"object"},"QueryDraftsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","maximum":3,"title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"type":"object"},"QueryDraftsResponse":{"nullable":true,"properties":{"drafts":{"description":"Drafts","items":{"$ref":"#/components/schemas/DraftResponse"},"title":"DraftsResponseList","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["drafts","duration"],"type":"object"},"QueryFeedMembersRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter parameters for the query","title":"object","type":"object","x-stream-index":"003"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Sort parameters for the query","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"array","type":"array","x-stream-index":"004"}},"type":"object"},"QueryFeedMembersResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"003.001"},"members":{"description":"List of feed members","items":{"$ref":"#/components/schemas/FeedMemberResponse"},"title":"array","type":"array","x-stream-index":"001"},"next":{"description":"Cursor for next page","title":"Next","type":"string","x-stream-index":"002.001"},"prev":{"description":"Cursor for previous page","title":"Previous","type":"string","x-stream-index":"002.002"}},"required":["members","duration"],"type":"object"},"QueryFeedModerationTemplate":{"properties":{"config":{"$ref":"#/components/schemas/FeedsModerationTemplateConfig","description":"Configuration for the moderation template","title":"Config","x-stream-index":"002"},"created_at":{"description":"When the template was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"003"},"name":{"description":"Name of the moderation template","title":"Name","type":"string","x-stream-index":"001"},"updated_at":{"description":"When the template was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"004"}},"required":["name","created_at","updated_at"],"type":"object"},"QueryFeedModerationTemplatesResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"templates":{"description":"List of moderation templates","items":{"$ref":"#/components/schemas/QueryFeedModerationTemplate"},"title":"Templates","type":"array","x-stream-index":"001"}},"required":["templates","duration"],"type":"object"},"QueryFeedsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filters to apply to the query","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"004.001"},"next":{"type":"string","x-stream-index":"004.002"},"prev":{"type":"string","x-stream-index":"004.003"},"sort":{"description":"Sorting parameters for the query","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"003"},"watch":{"description":"Whether to subscribe to realtime updates","title":"Watch","type":"boolean","x-stream-index":"002"}},"title":"Query Feeds Request","type":"object"},"QueryFeedsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"003.001"},"feeds":{"description":"List of feeds matching the query","items":{"$ref":"#/components/schemas/FeedResponse"},"title":"Feeds","type":"array","x-stream-index":"001"},"next":{"description":"Cursor for next page","title":"Next","type":"string","x-stream-index":"002.001"},"prev":{"description":"Cursor for previous page","title":"Previous","type":"string","x-stream-index":"002.002"}},"required":["feeds","duration"],"title":"Query Feeds Response","type":"object"},"QueryFollowsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filters to apply to the query","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"Sorting parameters for the query","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"002"}},"title":"Query Follows Request","type":"object"},"QueryFollowsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"003.001"},"follows":{"description":"List of follow relationships matching the query","items":{"$ref":"#/components/schemas/FollowResponse"},"title":"Follows","type":"array","x-stream-index":"001"},"next":{"description":"Cursor for next page","title":"Next","type":"string","x-stream-index":"002.001"},"prev":{"description":"Cursor for previous page","title":"Previous","type":"string","x-stream-index":"002.002"}},"required":["follows","duration"],"title":"Query Follows Response","type":"object"},"QueryMembersPayload":{"description":"Client request","properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"002"},"limit":{"format":"int32","maximum":300,"minimum":0,"type":"integer","x-stream-index":"006.003"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"type":"array","x-stream-index":"003"},"offset":{"format":"int32","maximum":10000,"type":"integer","x-stream-index":"006.004"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":1,"type":"array","x-stream-index":"005"},"type":{"maxLength":64,"type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"007.002"},"user_id":{"type":"string","x-stream-index":"007.001"}},"required":["type","filter_conditions"],"title":"ClientRequest","type":"object"},"QueryMembershipLevelsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filters to apply to the query","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"Sorting parameters for the query","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"002"}},"title":"Query Membership Levels Request","type":"object"},"QueryMembershipLevelsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"003.001"},"membership_levels":{"items":{"$ref":"#/components/schemas/MembershipLevelResponse"},"type":"array","x-stream-index":"001"},"next":{"description":"Cursor for next page","title":"Next","type":"string","x-stream-index":"002.001"},"prev":{"description":"Cursor for previous page","title":"Previous","type":"string","x-stream-index":"002.002"}},"required":["membership_levels","duration"],"title":"Query Membership Levels Response","type":"object"},"QueryMessageFlagsPayload":{"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":300,"minimum":0,"type":"integer","x-stream-index":"003.003"},"offset":{"format":"int32","maximum":10000,"type":"integer","x-stream-index":"003.004"},"show_deleted_messages":{"description":"Whether to include deleted messages in the results","title":"ShowDeletedMessages","type":"boolean","x-stream-index":"002"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"type":"array","x-stream-index":"003.005"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"type":"object"},"QueryMessageFlagsResponse":{"description":"Query message flags response","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"flags":{"description":"The flags that match the query","items":{"$ref":"#/components/schemas/MessageFlagResponse"},"title":"MessageFlagResponseList","type":"array","x-stream-index":"001"}},"required":["flags","duration"],"title":"QueryMessageFlagsResponse","type":"object"},"QueryMessageHistoryRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","maximum":3,"minimum":1,"title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"004.001"},"next":{"type":"string","x-stream-index":"004.002"},"prev":{"type":"string","x-stream-index":"004.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"002"}},"required":["filter"],"type":"object"},"QueryMessageHistoryResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message_history":{"description":"Message history entries","items":{"$ref":"#/components/schemas/MessageHistoryEntryResponse"},"title":"MessageHistoryEntryResponseList","type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["message_history","duration"],"type":"object"},"QueryModerationConfigsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter conditions for moderation configs","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"Sorting parameters for the results","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"type":"object"},"QueryModerationConfigsResponse":{"nullable":true,"properties":{"configs":{"description":"List of moderation configurations","items":{"$ref":"#/components/schemas/ConfigResponse"},"title":"Configs","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["configs","duration"],"type":"object"},"QueryModerationFlagsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParam"},"type":"array","x-stream-index":"002"}},"type":"object"},"QueryModerationFlagsResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"flags":{"items":{"$ref":"#/components/schemas/ModerationFlagResponse"},"type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["flags","duration"],"title":"Response","type":"object"},"QueryModerationLogsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter conditions for moderation logs","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"Sorting parameters for the results","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"type":"object"},"QueryModerationLogsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"003.001"},"logs":{"description":"List of moderation action logs","items":{"$ref":"#/components/schemas/ActionLogResponse"},"title":"Logs","type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["logs","duration"],"type":"object"},"QueryModerationRulesRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter conditions for moderation rules","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"Sorting parameters for the results","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"type":"object"},"QueryModerationRulesResponse":{"nullable":true,"properties":{"default_llm_labels":{"additionalProperties":{"type":"string"},"description":"Default LLM label descriptions","title":"DefaultLLMLabels","type":"object","x-stream-index":"002"},"duration":{"type":"string","x-stream-index":"004.001"},"next":{"type":"string","x-stream-index":"003.001"},"prev":{"type":"string","x-stream-index":"003.002"},"rules":{"description":"List of moderation rules","items":{"$ref":"#/components/schemas/ModerationRuleV2Response"},"title":"Rules","type":"array","x-stream-index":"001"}},"required":["rules","default_llm_labels","duration"],"type":"object"},"QueryPollVotesRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","title":"Filter","type":"object","x-stream-index":"003"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"004"}},"type":"object"},"QueryPollsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","title":"Filter","type":"object","x-stream-index":"002"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"003"}},"type":"object"},"QueryPollsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"polls":{"description":"Polls data returned by the query","items":{"$ref":"#/components/schemas/PollResponseData"},"title":"PollsResponseData","type":"array","x-stream-index":"001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["polls","duration"],"type":"object"},"QueryReactionsRequest":{"properties":{"filter":{"additionalProperties":{},"type":"object","x-stream-index":"002"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"006.001"},"next":{"type":"string","x-stream-index":"006.002"},"prev":{"type":"string","x-stream-index":"006.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":2,"type":"array","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"type":"object"},"QueryReactionsResponse":{"description":"Basic response information","properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"next":{"type":"string","x-stream-index":"003.001"},"prev":{"type":"string","x-stream-index":"003.002"},"reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"001"}},"required":["reactions","duration"],"title":"Response","type":"object"},"QueryRemindersRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"type":"object"},"QueryRemindersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"reminders":{"description":"MessageReminders data returned by the query","items":{"$ref":"#/components/schemas/ReminderResponseData"},"title":"RemindersResponseData","type":"array","x-stream-index":"001"}},"required":["reminders","duration"],"type":"object"},"QueryReviewQueueRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter conditions for review queue items","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"007.001"},"lock_count":{"description":"Number of items to lock (1-25)","format":"int32","maximum":25,"minimum":1,"title":"Lock Count","type":"integer","x-stream-index":"005"},"lock_duration":{"description":"Duration for which items should be locked","title":"Lock Duration","type":"integer","x-stream-index":"004"},"lock_items":{"description":"Whether to lock items for review (true), unlock items (false), or just fetch (nil)","title":"Lock Items","type":"boolean","x-stream-index":"003"},"next":{"type":"string","x-stream-index":"007.002"},"prev":{"type":"string","x-stream-index":"007.003"},"sort":{"description":"Sorting parameters for the results","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"002"},"stats_only":{"description":"Whether to return only statistics","title":"Stats Only","type":"boolean","x-stream-index":"006"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"008.002"},"user_id":{"type":"string","x-stream-index":"008.001"}},"type":"object"},"QueryReviewQueueResponse":{"nullable":true,"properties":{"action_config":{"additionalProperties":{"items":{"$ref":"#/components/schemas/ModerationActionConfig"},"type":"array"},"description":"Configuration for moderation actions","title":"Action Config","type":"object","x-stream-index":"002"},"duration":{"type":"string","x-stream-index":"005.001"},"items":{"description":"List of review queue items","items":{"$ref":"#/components/schemas/ReviewQueueItemResponse"},"title":"Items","type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"004.001"},"prev":{"type":"string","x-stream-index":"004.002"},"stats":{"additionalProperties":{},"description":"Statistics about the review queue","title":"Stats","type":"object","x-stream-index":"003"}},"required":["items","action_config","stats","duration"],"type":"object"},"QuerySegmentTargetsRequest":{"nullable":true,"properties":{"Filter":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"005"},"Sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"type":"array","writeOnly":true,"x-stream-index":"006"},"limit":{"description":"Limit","format":"int32","maximum":10000,"minimum":0,"title":"int","type":"integer","x-stream-index":"002"},"next":{"description":"Next","title":"string","type":"string","x-stream-index":"003"},"prev":{"description":"Prev","title":"string","type":"string","x-stream-index":"004"}},"type":"object"},"QuerySegmentTargetsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"targets":{"description":"Targets","items":{"$ref":"#/components/schemas/SegmentTargetResponse"},"title":"SegmentTargetResponseList","type":"array","x-stream-index":"001"}},"required":["targets","duration"],"type":"object"},"QuerySegmentsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"002"}},"required":["filter"],"type":"object"},"QuerySegmentsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"segments":{"description":"Segments","items":{"$ref":"#/components/schemas/SegmentResponse"},"title":"SegmentResponses","type":"array","x-stream-index":"001"}},"required":["segments","duration"],"type":"object"},"QueryThreadsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter conditions to apply to threads","title":"Filter","type":"object","x-stream-index":"006"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"008.001"},"member_limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005"},"next":{"type":"string","x-stream-index":"008.002"},"participant_limit":{"description":"Limit the number of participants returned per each thread","format":"int32","maximum":100,"minimum":0,"title":"Participant limit","type":"integer","x-stream-index":"004"},"prev":{"type":"string","x-stream-index":"008.003"},"reply_limit":{"description":"Limit the number of replies returned per each thread","format":"int32","maximum":10,"minimum":0,"title":"Reply limit","type":"integer","x-stream-index":"003"},"sort":{"description":"Sort conditions to apply to threads","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"007"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"010.002"},"user_id":{"type":"string","x-stream-index":"010.001"}},"type":"object"},"QueryThreadsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"threads":{"description":"List of enriched thread states","items":{"$ref":"#/components/schemas/ThreadStateResponse"},"title":"Threads","type":"array","x-stream-index":"001"}},"required":["threads","duration"],"type":"object"},"QueryUserFeedbackRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":2,"type":"array","x-stream-index":"002"}},"type":"object"},"QueryUserFeedbackResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"next":{"type":"string","x-stream-index":"003.001"},"prev":{"type":"string","x-stream-index":"003.002"},"user_feedback":{"items":{"$ref":"#/components/schemas/UserFeedbackResponse"},"type":"array","x-stream-index":"001"}},"required":["user_feedback","duration"],"title":"Response","type":"object"},"QueryUsersPayload":{"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"include_deactivated_users":{"type":"boolean","x-stream-index":"004"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.003"},"offset":{"format":"int32","maximum":1000,"type":"integer","x-stream-index":"005.004"},"presence":{"type":"boolean","x-stream-index":"003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"006.002"},"user_id":{"type":"string","x-stream-index":"006.001"}},"required":["filter_conditions"],"type":"object"},"QueryUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"users":{"description":"Array of users as result of filters applied.","items":{"$ref":"#/components/schemas/FullUserResponse"},"title":"Users","type":"array","x-stream-index":"001"}},"required":["users","duration"],"type":"object"},"RTMPBroadcastRequest":{"description":"RTMPBroadcastRequest is the payload for starting an RTMP broadcast.","properties":{"layout":{"$ref":"#/components/schemas/LayoutSettingsRequest","description":"If provided, will override the call's RTMP settings layout","title":"Layout","x-stream-index":"005"},"name":{"description":"Name identifier for RTMP broadcast, must be unique in call","maxLength":255,"title":"Name","type":"string","x-stream-index":"001"},"quality":{"description":"If provided, will override the call's RTMP settings quality","enum":["360p","480p","720p","1080p","1440p","portrait-360x640","portrait-480x854","portrait-720x1280","portrait-1080x1920","portrait-1440x2560"],"title":"Quality","type":"string","x-stream-index":"004"},"stream_key":{"description":"If provided, will be appended at the end of stream_url","title":"Stream Key","type":"string","x-stream-index":"003"},"stream_url":{"description":"URL for the RTMP server to send the call to","maxLength":255,"title":"Stream URL","type":"string","x-stream-index":"002"}},"required":["name","stream_url"],"title":"RTMPBroadcastRequest","type":"object"},"RTMPEgressConfig":{"properties":{"composite_app_settings":{"$ref":"#/components/schemas/CompositeAppSettings","x-stream-index":"005"},"quality":{"$ref":"#/components/schemas/Quality","x-stream-index":"004"},"rtmp_location":{"type":"string","x-stream-index":"006"}},"type":"object"},"RTMPIngress":{"description":"RTMP input settings","properties":{"address":{"title":"Address","type":"string","x-stream-index":"001"}},"required":["address"],"title":"RTMPIngress","type":"object"},"RTMPLocation":{"properties":{"name":{"type":"string","x-stream-index":"001"},"stream_key":{"type":"string","x-stream-index":"003"},"stream_url":{"type":"string","x-stream-index":"002"}},"required":["name","stream_url","stream_key"],"type":"object"},"RTMPSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"003"},"location":{"$ref":"#/components/schemas/RTMPLocation","x-stream-index":"004"},"quality_name":{"type":"string","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"RTMPSettingsRequest":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettingsRequest","description":"Layout for the composed RTMP stream","title":"LayoutSettings","x-stream-index":"003"},"quality":{"description":"Resolution to set for the RTMP stream","enum":["360p","480p","720p","1080p","1440p","portrait-360x640","portrait-480x854","portrait-720x1280","portrait-1080x1920","portrait-1440x2560"],"title":"Quality","type":"string","x-stream-index":"002"}},"title":"RTMPSettingsRequest","type":"object"},"RTMPSettingsResponse":{"description":"RTMPSettingsResponse is the payload for RTMP settings","properties":{"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettingsResponse","title":"Layout","x-stream-index":"003"},"quality":{"title":"Quality","type":"string","x-stream-index":"002"}},"required":["enabled","quality","layout"],"title":"RTMPSettingsResponse","type":"object"},"RankingConfig":{"properties":{"defaults":{"additionalProperties":{},"description":"Default values for ranking","title":"Defaults","type":"object","x-stream-index":"003"},"functions":{"additionalProperties":{"$ref":"#/components/schemas/DecayFunctionConfig"},"description":"Decay functions configuration","title":"Functions","type":"object","x-stream-index":"004"},"score":{"description":"Scoring formula","title":"Score","type":"string","x-stream-index":"002"},"type":{"description":"Type of ranking algorithm","title":"Type","type":"string","x-stream-index":"001"}},"title":"Ranking Configuration","type":"object"},"Reaction":{"nullable":true,"properties":{"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"message_id":{"type":"string","x-stream-index":"003"},"score":{"format":"int32","type":"integer","x-stream-index":"007"},"type":{"maxLength":30,"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["message_id","type","score","created_at","updated_at","custom"],"type":"object"},"ReactionDeletedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"006.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"002"},"team":{"type":"string","x-stream-index":"005.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"reaction.deleted","type":"string","x-stream-index":"006.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"ReactionDeletedEvent","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"},"ReactionGroupResponse":{"description":"ReactionGroupResponse contains all information about a reaction of the same type.","nullable":true,"properties":{"count":{"description":"Count is the number of reactions of this type.","format":"int32","title":"Count","type":"integer","x-stream-index":"001"},"first_reaction_at":{"description":"FirstReactionAt is the time of the first reaction of this type. This is the same also if all reaction of this type are deleted, because if someone will react again with the same type, will be preserved the sorting.","format":"date-time","title":"FirstReactionAt","type":"number","x-stream-index":"003"},"last_reaction_at":{"description":"LastReactionAt is the time of the last reaction of this type.","format":"date-time","title":"LastReactionAt","type":"number","x-stream-index":"004"},"sum_scores":{"description":"SumScores is the sum of all scores of reactions of this type. Medium allows you to clap articles more than once and shows the sum of all claps from all users. For example, you can send `clap` x5 using `score: 5`.","format":"int32","title":"SumScores","type":"integer","x-stream-index":"002"}},"required":["count","sum_scores","first_reaction_at","last_reaction_at"],"title":"ReactionGroupResponse","type":"object"},"ReactionNewEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"006.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"002"},"team":{"type":"string","x-stream-index":"005.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"reaction.new","type":"string","x-stream-index":"006.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"ReactionNewEvent","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"},"ReactionRequest":{"description":"Represents user reaction to a message","properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"score":{"description":"Reaction score. If not specified reaction has score of 1","format":"int32","title":"Score","type":"integer","x-stream-index":"002"},"type":{"description":"The type of reaction (e.g. 'like', 'laugh', 'wow')","maxLength":30,"title":"Type","type":"string","x-stream-index":"001"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"006.002"},"user_id":{"type":"string","x-stream-index":"006.001"}},"required":["type"],"title":"Reaction","type":"object","x-stream-docs-page-id":"send_reaction"},"ReactionResponse":{"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"006"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"008"},"message_id":{"description":"Message ID","title":"Message ID","type":"string","x-stream-index":"001"},"score":{"description":"Score of the reaction","format":"int32","title":"Score","type":"integer","x-stream-index":"005"},"type":{"description":"Type of reaction","title":"Type","type":"string","x-stream-index":"004"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"007"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User","title":"UserResponse","x-stream-index":"003"},"user_id":{"description":"User ID","title":"User ID","type":"string","x-stream-index":"002"}},"required":["message_id","user_id","user","type","score","created_at","updated_at","custom"],"type":"object"},"ReactionUpdatedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"006.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"002"},"team":{"type":"string","x-stream-index":"005.001"},"type":{"default":"reaction.updated","type":"string","x-stream-index":"006.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["message","reaction","cid","channel_id","channel_type","type","created_at"],"title":"ReactionUpdatedEvent","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"},"ReactivateUserRequest":{"nullable":true,"properties":{"created_by_id":{"description":"ID of the user who's reactivating the user","title":"Created by ID","type":"string","x-stream-index":"004"},"name":{"description":"Set this field to put new name for the user","title":"Name","type":"string","x-stream-index":"003"},"restore_messages":{"description":"Restore previously deleted messages","title":"Restore messages","type":"boolean","x-stream-index":"002"}},"type":"object"},"ReactivateUserResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.002.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Deactivated user object","title":"User","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"ReactivateUsersRequest":{"description":"Reactivate users in batches","nullable":true,"properties":{"created_by_id":{"description":"ID of the user who's reactivating the users","title":"Created by ID","type":"string","x-stream-index":"003"},"restore_channels":{"type":"boolean","x-stream-index":"004"},"restore_messages":{"description":"Restore previously deleted messages","title":"Restore messages","type":"boolean","x-stream-index":"002"},"user_ids":{"description":"User IDs to reactivate","items":{"type":"string"},"maximum":100,"minimum":1,"title":"User IDs","type":"array","x-stream-index":"001"}},"required":["user_ids"],"title":"ReactivateUsersRequest","type":"object"},"ReactivateUsersResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.002.001"},"task_id":{"type":"string","x-stream-index":"001.001"}},"required":["task_id","duration"],"title":"Response","type":"object"},"ReadReceipts":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"ReadReceiptsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"ReadStateResponse":{"properties":{"last_read":{"format":"date-time","type":"number","x-stream-index":"002"},"last_read_message_id":{"type":"string","x-stream-index":"004"},"unread_messages":{"format":"int32","type":"integer","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"}},"required":["user","last_read","unread_messages"],"type":"object"},"RecordSettings":{"properties":{"audio_only":{"type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"004"},"mode":{"type":"string","x-stream-index":"002"},"quality":{"type":"string","x-stream-index":"003"}},"required":["mode"],"type":"object"},"RecordSettingsRequest":{"properties":{"audio_only":{"type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettingsRequest","title":"LayoutSettings","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"title":"Mode","type":"string","x-stream-index":"002"},"quality":{"enum":["360p","480p","720p","1080p","1440p","portrait-360x640","portrait-480x854","portrait-720x1280","portrait-1080x1920","portrait-1440x2560"],"type":"string","x-stream-index":"003"}},"required":["mode"],"title":"RecordSettingsRequest","type":"object"},"RecordSettingsResponse":{"description":"RecordSettings is the payload for recording settings","properties":{"audio_only":{"title":"Audio Only","type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettingsResponse","title":"Layout","x-stream-index":"004"},"mode":{"title":"Mode","type":"string","x-stream-index":"002"},"quality":{"title":"Quality","type":"string","x-stream-index":"003"}},"required":["audio_only","mode","quality","layout"],"title":"RecordSettingsResponse","type":"object"},"RecordingEgressConfig":{"properties":{"audio_only":{"type":"boolean","x-stream-index":"006"},"composite_app_settings":{"$ref":"#/components/schemas/CompositeAppSettings","x-stream-index":"005"},"external_storage":{"$ref":"#/components/schemas/ExternalStorage","x-stream-index":"008"},"quality":{"$ref":"#/components/schemas/Quality","x-stream-index":"004"},"storage_name":{"type":"string","x-stream-index":"007"},"video_orientation_hint":{"$ref":"#/components/schemas/VideoOrientation","x-stream-index":"009"}},"type":"object"},"RejectFeedMemberInviteRequest":{"nullable":true,"properties":{"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"title":"Reject Feed Member Request","type":"object"},"RejectFeedMemberInviteResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"member":{"$ref":"#/components/schemas/FeedMemberResponse","description":"The feed member after rejecting the invite","title":"Feed Member","x-stream-index":"001"}},"required":["member","duration"],"title":"Reject Feed Member Response","type":"object"},"RejectFollowRequest":{"nullable":true,"properties":{"source":{"description":"Fully qualified ID of the source feed","maxLength":255,"title":"Source Feed ID","type":"string","x-stream-index":"001"},"target":{"description":"Fully qualified ID of the target feed","maxLength":255,"title":"Target Feed ID","type":"string","x-stream-index":"002"}},"required":["source","target"],"title":"Reject Follow Request","type":"object"},"RejectFollowResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"follow":{"$ref":"#/components/schemas/FollowResponse","description":"The rejected follow relationship","title":"Follow","x-stream-index":"001"}},"required":["follow","duration"],"title":"Reject Follow Response","type":"object"},"ReminderCreatedEvent":{"description":"Emitted when a reminder is created.","nullable":true,"properties":{"cid":{"description":"The CID of the Channel for which the reminder was created","title":"Channel CID","type":"string","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.007"},"message_id":{"description":"The ID of the message for which the reminder was created","title":"Message ID","type":"string","x-stream-index":"001.002"},"parent_id":{"description":"The ID of the parent message, if the reminder is for a thread message","title":"Parent ID","type":"string","x-stream-index":"001.005"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","description":"The reminder object which was created","title":"MessageReminder","x-stream-index":"001.006"},"type":{"default":"reminder.created","description":"The type of event: \"reminder.created\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.002"},"user_id":{"description":"The ID of the user for whom the reminder was created","title":"User ID","type":"string","x-stream-index":"001.003"}},"required":["type","created_at","custom","message_id","user_id","cid"],"title":"ReminderCreatedEvent","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"},"ReminderDeletedEvent":{"description":"Emitted when a reminder is deleted.","nullable":true,"properties":{"cid":{"description":"The CID of the Channel for which the reminder was created","title":"Channel CID","type":"string","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.007"},"message_id":{"description":"The ID of the message for which the reminder was created","title":"Message ID","type":"string","x-stream-index":"001.002"},"parent_id":{"description":"The ID of the parent message, if the reminder is for a thread message","title":"Parent ID","type":"string","x-stream-index":"001.005"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","description":"The reminder object which was created","title":"MessageReminder","x-stream-index":"001.006"},"type":{"default":"reminder.deleted","description":"The type of event: \"reminder.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.002"},"user_id":{"description":"The ID of the user for whom the reminder was created","title":"User ID","type":"string","x-stream-index":"001.003"}},"required":["type","created_at","custom","message_id","user_id","cid"],"title":"ReminderDeletedEvent","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"},"ReminderNotificationEvent":{"description":"Emitted when a reminder becomes due, triggering a notification for the user.","nullable":true,"properties":{"cid":{"description":"The CID of the Channel for which the reminder was created","title":"Channel CID","type":"string","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.007"},"message_id":{"description":"The ID of the message for which the reminder was created","title":"Message ID","type":"string","x-stream-index":"001.002"},"parent_id":{"type":"string","x-stream-index":"001.005"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","description":"The reminder object which was created","title":"MessageReminder","x-stream-index":"001.006"},"type":{"default":"notification.reminder_due","description":"The type of event: \"notification.reminder_due\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.002"},"user_id":{"description":"The ID of the user for whom the reminder was created","title":"User ID","type":"string","x-stream-index":"001.003"}},"required":["type","created_at","custom","message_id","user_id","cid"],"title":"ReminderNotificationEvent","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"},"ReminderResponseData":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003"},"channel_cid":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"005"},"message_id":{"type":"string","x-stream-index":"004"},"remind_at":{"format":"date-time","type":"number","x-stream-index":"001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007"},"user_id":{"type":"string","x-stream-index":"006"}},"required":["channel_cid","message_id","user_id","created_at","updated_at"],"type":"object"},"ReminderUpdatedEvent":{"description":"Emitted when a reminder is updated.","nullable":true,"properties":{"cid":{"description":"The CID of the Channel for which the reminder was created","title":"Channel CID","type":"string","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.007"},"message_id":{"description":"The ID of the message for which the reminder was created","title":"Message ID","type":"string","x-stream-index":"001.002"},"parent_id":{"description":"The ID of the parent message, if the reminder is for a thread message","title":"Parent ID","type":"string","x-stream-index":"001.005"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","description":"The reminder object which was created","title":"MessageReminder","x-stream-index":"001.006"},"type":{"default":"reminder.updated","description":"The type of event: \"reminder.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.002"},"user_id":{"description":"The ID of the user for whom the reminder was created","title":"User ID","type":"string","x-stream-index":"001.003"}},"required":["type","created_at","custom","message_id","user_id","cid"],"title":"ReminderUpdatedEvent","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"},"RepliesMeta":{"description":"Cursor \u0026 depth information for a comment's direct replies. Mirrors Reddit's 'load more replies' semantics.","properties":{"depth_truncated":{"description":"True if the subtree was cut because the requested depth was reached.","title":"Depth Truncated","type":"boolean","x-stream-index":"004"},"has_more":{"description":"True if more siblings exist in the database.","title":"Has More","type":"boolean","x-stream-index":"001"},"next_cursor":{"description":"Opaque cursor to request the next page of siblings.","title":"Next Cursor","type":"string","x-stream-index":"002"},"remaining":{"description":"Number of unread siblings that match current filters.","format":"int32","title":"Remaining","type":"integer","x-stream-index":"003"}},"required":["has_more","remaining","depth_truncated"],"title":"Replies Meta","type":"object"},"ReportByHistogramBucket":{"properties":{"category":{"type":"string","x-stream-index":"001"},"count":{"format":"int32","type":"integer","x-stream-index":"005"},"lower_bound":{"$ref":"#/components/schemas/Bound","x-stream-index":"002"},"sum":{"format":"float","type":"number","x-stream-index":"004"},"upper_bound":{"$ref":"#/components/schemas/Bound","x-stream-index":"003"}},"required":["category","sum","count"],"type":"object"},"ReportResponse":{"properties":{"call":{"$ref":"#/components/schemas/CallReportResponse","x-stream-index":"003"},"participants":{"$ref":"#/components/schemas/ParticipantReportResponse","x-stream-index":"001"},"user_ratings":{"$ref":"#/components/schemas/UserRatingReportResponse","x-stream-index":"002"}},"required":["participants","user_ratings","call"],"type":"object"},"Response":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001"}},"required":["duration"],"title":"Response","type":"object"},"RestoreActionRequest":{"type":"object"},"RestoreUsersRequest":{"nullable":true,"properties":{"user_ids":{"items":{"type":"string"},"maximum":100,"minimum":1,"type":"array","x-stream-index":"001"}},"required":["user_ids"],"type":"object"},"ReviewQueueItem":{"properties":{"actions":{"items":{"$ref":"#/components/schemas/ActionLog"},"type":"array","x-stream-index":"035"},"activity":{"$ref":"#/components/schemas/EnrichedActivity","x-stream-index":"028"},"ai_text_severity":{"type":"string","x-stream-index":"021"},"archived_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"043"},"assigned_to":{"$ref":"#/components/schemas/User","x-stream-index":"032"},"bans":{"items":{"$ref":"#/components/schemas/Ban"},"type":"array","x-stream-index":"033"},"bounce_count":{"format":"int32","type":"integer","x-stream-index":"025"},"call":{"$ref":"#/components/schemas/Call","x-stream-index":"031"},"completed_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"018"},"config_key":{"type":"string","x-stream-index":"009"},"content_changed":{"type":"boolean","x-stream-index":"036"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"entity_creator":{"$ref":"#/components/schemas/EntityCreator","x-stream-index":"030"},"entity_id":{"type":"string","x-stream-index":"007"},"entity_type":{"type":"string","x-stream-index":"006"},"feeds_v2_activity":{"$ref":"#/components/schemas/EnrichedActivity","x-stream-index":"041"},"feeds_v2_reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"042"},"flag_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"045"},"flag_types":{"items":{"type":"string"},"type":"array","x-stream-index":"044"},"flags":{"items":{"$ref":"#/components/schemas/Flag"},"type":"array","x-stream-index":"034"},"flags_count":{"format":"int32","type":"integer","x-stream-index":"026"},"has_image":{"type":"boolean","x-stream-index":"012"},"has_text":{"type":"boolean","x-stream-index":"014"},"has_video":{"type":"boolean","x-stream-index":"013"},"id":{"type":"string","x-stream-index":"003"},"languages":{"items":{"type":"string"},"type":"array","x-stream-index":"019"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"027"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"010"},"moderation_payload_hash":{"type":"string","x-stream-index":"011"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"029"},"recommended_action":{"type":"string","x-stream-index":"017"},"reporter_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"046"},"reviewed_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"022"},"reviewed_by":{"type":"string","x-stream-index":"023"},"severity":{"format":"int32","type":"integer","x-stream-index":"020"},"status":{"type":"string","x-stream-index":"016"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"015"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"005"}},"required":["id","created_at","updated_at","entity_type","entity_id","config_key","moderation_payload_hash","has_image","has_video","has_text","teams","status","recommended_action","completed_at","languages","severity","ai_text_severity","reviewed_at","reviewed_by","bounce_count","flags_count","bans","flags","actions","content_changed","archived_at","flag_types","flag_labels","reporter_ids"],"type":"object"},"ReviewQueueItemNewEvent":{"description":"This event is sent when a new moderation review queue item is created","nullable":true,"properties":{"action":{"$ref":"#/components/schemas/ActionLogResponse","description":"The action log if any action was taken","title":"Action","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"flags":{"description":"The flags associated with this review queue item","items":{"$ref":"#/components/schemas/ModerationFlagResponse"},"title":"Flags","type":"array","x-stream-index":"003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"The review queue item that was created","title":"ReviewQueueItem","x-stream-index":"002"},"type":{"default":"review_queue_item.new","type":"string","x-stream-index":"001.002"}},"required":["type","created_at","custom"],"title":"ReviewQueueItemNewEvent","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"},"ReviewQueueItemResponse":{"properties":{"actions":{"description":"Moderation actions taken","items":{"$ref":"#/components/schemas/ActionLogResponse"},"title":"Actions","type":"array","x-stream-index":"024"},"activity":{"$ref":"#/components/schemas/EnrichedActivity","x-stream-index":"016"},"ai_text_severity":{"description":"AI-determined text severity","title":"AI Text Severity","type":"string","x-stream-index":"014"},"assigned_to":{"$ref":"#/components/schemas/UserResponse","description":"Moderator assigned to review this item","title":"Assigned To","x-stream-index":"021"},"bans":{"description":"Associated ban records","items":{"$ref":"#/components/schemas/Ban"},"title":"Bans","type":"array","x-stream-index":"022"},"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"018"},"completed_at":{"description":"When the review was completed","format":"date-time","title":"Completed At","type":"number","x-stream-index":"009"},"config_key":{"type":"string","x-stream-index":"028"},"created_at":{"description":"When the item was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"002"},"entity_creator":{"$ref":"#/components/schemas/EntityCreatorResponse","description":"Details about who created the entity","title":"Entity Creator","x-stream-index":"019"},"entity_creator_id":{"description":"ID of who created the entity","title":"Entity Creator ID","type":"string","x-stream-index":"020"},"entity_id":{"description":"ID of the entity being reviewed","title":"Entity ID","type":"string","x-stream-index":"005"},"entity_type":{"description":"Type of entity being reviewed","title":"Entity Type","type":"string","x-stream-index":"004"},"feeds_v2_activity":{"$ref":"#/components/schemas/EnrichedActivity","description":"Associated feed activity","title":"Feeds V2 Activity","x-stream-index":"025"},"feeds_v2_reaction":{"$ref":"#/components/schemas/Reaction","description":"Associated feed reaction","title":"Feeds V2 Reaction","x-stream-index":"026"},"flags":{"description":"Associated flag records","items":{"$ref":"#/components/schemas/ModerationFlagResponse"},"title":"Flags","type":"array","x-stream-index":"023"},"flags_count":{"format":"int32","type":"integer","x-stream-index":"029"},"id":{"description":"Unique identifier of the review queue item","title":"ID","type":"string","x-stream-index":"001"},"languages":{"description":"Detected languages in the content","items":{"type":"string"},"title":"Languages","type":"array","x-stream-index":"012"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Associated message details","title":"Message","x-stream-index":"015"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content being moderated","title":"Moderation Payload","x-stream-index":"006"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"017"},"recommended_action":{"description":"Suggested moderation action","title":"Recommended Action","type":"string","x-stream-index":"008"},"reviewed_at":{"description":"When the item was reviewed","format":"date-time","title":"Reviewed At","type":"number","x-stream-index":"010"},"reviewed_by":{"description":"ID of the moderator who reviewed the item","title":"Reviewed By","type":"string","x-stream-index":"011"},"severity":{"description":"Severity level of the content","format":"int32","title":"Severity","type":"integer","x-stream-index":"013"},"status":{"description":"Current status of the review","title":"Status","type":"string","x-stream-index":"007"},"teams":{"description":"Teams associated with this item","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"027"},"updated_at":{"description":"When the item was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"003"}},"required":["id","created_at","updated_at","entity_type","entity_id","status","recommended_action","reviewed_by","languages","severity","ai_text_severity","bans","flags","actions","flags_count"],"type":"object"},"ReviewQueueItemUpdatedEvent":{"description":"This event is sent when a moderation review queue item is updated","nullable":true,"properties":{"action":{"$ref":"#/components/schemas/ActionLogResponse","description":"The action log if any action was taken","title":"Action","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"flags":{"description":"The flags associated with this review queue item","items":{"$ref":"#/components/schemas/ModerationFlagResponse"},"title":"Flags","type":"array","x-stream-index":"003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"The review queue item that was updated","title":"ReviewQueueItem","x-stream-index":"002"},"type":{"default":"review_queue_item.updated","type":"string","x-stream-index":"001.002"}},"required":["type","created_at","custom"],"title":"ReviewQueueItemUpdatedEvent","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"},"RingSettings":{"properties":{"auto_cancel_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_timeout_ms","missed_call_timeout_ms"],"type":"object"},"RingSettingsRequest":{"properties":{"auto_cancel_timeout_ms":{"description":"When none of the callees accept a ring call in this time a rejection will be sent by the caller with reason 'timeout' by the SDKs","format":"int32","maximum":180000,"minimum":5000,"title":"AutoCancelTimeoutMs","type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"description":"When a callee is online but doesn't answer a ring call in this time a rejection will be sent with reason 'timeout' by the SDKs","format":"int32","maximum":180000,"minimum":5000,"title":"IncomingCallTimeoutMs","type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"description":"When a callee doesn't accept or reject a ring call in this time a missed call event will be sent","format":"int32","maximum":180000,"minimum":5000,"title":"MissedCallTimeoutMs","type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_timeout_ms"],"title":"RingSettingsRequest","type":"object"},"RingSettingsResponse":{"properties":{"auto_cancel_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_timeout_ms","missed_call_timeout_ms"],"type":"object"},"Role":{"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"004"},"custom":{"description":"Whether this is a custom role or built-in","title":"Custom","type":"boolean","x-stream-index":"002"},"name":{"description":"Unique role name","title":"Name","type":"string","x-stream-index":"001"},"scopes":{"description":"List of scopes where this role is currently present. `.app` means that role is present in app-level grants","items":{"type":"string"},"title":"Scopes","type":"array","x-stream-index":"003"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"005"}},"required":["name","custom","scopes","created_at","updated_at"],"type":"object"},"RuleBuilderAction":{"properties":{"ban_options":{"$ref":"#/components/schemas/BanOptions","x-stream-index":"002"},"flag_content_options":{"$ref":"#/components/schemas/FlagContentOptions","x-stream-index":"004"},"flag_user_options":{"$ref":"#/components/schemas/FlagUserOptions","x-stream-index":"003"},"remove_content_options":{"$ref":"#/components/schemas/BlockContentOptions","x-stream-index":"005"},"type":{"type":"string","x-stream-index":"001"}},"type":"object"},"RuleBuilderCondition":{"properties":{"confidence":{"format":"float","type":"number","x-stream-index":"002"},"content_count_rule_params":{"$ref":"#/components/schemas/ContentCountRuleParameters","x-stream-index":"007"},"image_content_params":{"$ref":"#/components/schemas/ImageContentParameters","x-stream-index":"009"},"image_rule_params":{"$ref":"#/components/schemas/ImageRuleParameters","x-stream-index":"004"},"text_content_params":{"$ref":"#/components/schemas/TextContentParameters","x-stream-index":"008"},"text_rule_params":{"$ref":"#/components/schemas/TextRuleParameters","x-stream-index":"003"},"type":{"type":"string","x-stream-index":"001"},"user_created_within_params":{"$ref":"#/components/schemas/UserCreatedWithinParameters","x-stream-index":"011"},"user_custom_property_params":{"$ref":"#/components/schemas/UserCustomPropertyParameters","x-stream-index":"012"},"user_rule_params":{"$ref":"#/components/schemas/UserRuleParameters","x-stream-index":"006"},"video_content_params":{"$ref":"#/components/schemas/VideoContentParameters","x-stream-index":"010"},"video_rule_params":{"$ref":"#/components/schemas/VideoRuleParameters","x-stream-index":"005"}},"type":"object"},"RuleBuilderConditionGroup":{"properties":{"conditions":{"items":{"$ref":"#/components/schemas/RuleBuilderCondition"},"type":"array","x-stream-index":"002"},"logic":{"type":"string","x-stream-index":"001"}},"type":"object"},"RuleBuilderConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"rules":{"items":{"$ref":"#/components/schemas/RuleBuilderRule"},"type":"array","x-stream-index":"002"}},"type":"object"},"RuleBuilderRule":{"properties":{"action":{"$ref":"#/components/schemas/RuleBuilderAction","x-stream-index":"006"},"conditions":{"items":{"$ref":"#/components/schemas/RuleBuilderCondition"},"type":"array","x-stream-index":"003"},"cooldown_period":{"type":"string","x-stream-index":"007"},"groups":{"items":{"$ref":"#/components/schemas/RuleBuilderConditionGroup"},"type":"array","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"logic":{"type":"string","x-stream-index":"004"},"rule_type":{"type":"string","x-stream-index":"002"}},"required":["rule_type","action"],"type":"object"},"S3Request":{"description":"Config for creating Amazon S3 storage.","properties":{"s3_api_key":{"description":"The AWS API key. To use Amazon S3 as your storage provider, you have two authentication options: IAM role or API key. If you do not specify the `s3_api_key` parameter, Stream will use IAM role authentication. In that case make sure to have the correct IAM role configured for your application.","title":"S3ApiKey","type":"string","x-stream-index":"002"},"s3_custom_endpoint_url":{"description":"The custom endpoint for S3. If you want to use a custom endpoint, you must also provide the `s3_api_key` and `s3_secret` parameters.","title":"S3CustomEndpointURL","type":"string","x-stream-index":"004"},"s3_region":{"description":"The AWS region where the bucket is hosted","title":"S3Region","type":"string","x-stream-index":"001"},"s3_secret":{"description":"The AWS API Secret","title":"S3Secret","type":"string","x-stream-index":"003"}},"required":["s3_region"],"title":"S3Request","type":"object"},"SDKUsageReport":{"properties":{"per_sdk_usage":{"additionalProperties":{"$ref":"#/components/schemas/PerSDKUsageReport"},"type":"object","x-stream-index":"001"}},"required":["per_sdk_usage"],"type":"object"},"SDKUsageReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateSDKUsageReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"SFUIDLastSeen":{"properties":{"id":{"type":"string","x-stream-index":"001.001"},"last_seen":{"format":"date-time","type":"number","x-stream-index":"002"},"process_start_time":{"format":"int64","type":"integer","x-stream-index":"001.002"}},"required":["id","process_start_time","last_seen"],"type":"object"},"STTEgressConfig":{"properties":{"closed_captions_enabled":{"type":"boolean","x-stream-index":"005"},"external_storage":{"$ref":"#/components/schemas/ExternalStorage","x-stream-index":"011"},"language":{"type":"string","x-stream-index":"008"},"storage_name":{"type":"string","x-stream-index":"010"},"translation_languages":{"items":{"type":"string"},"type":"array","x-stream-index":"009"},"translations_enabled":{"type":"boolean","x-stream-index":"006"},"upload_transcriptions":{"type":"boolean","x-stream-index":"004"},"whisper_server_base_url":{"type":"string","x-stream-index":"007"}},"type":"object"},"ScreensharingSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled"],"type":"object"},"ScreensharingSettingsRequest":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"type":"object"},"ScreensharingSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled"],"type":"object"},"SearchPayload":{"properties":{"filter_conditions":{"additionalProperties":{},"description":"Channel filter conditions","maximum":100,"minimum":1,"title":"Channel filter","type":"object","x-stream-docs-page-id":"query_channels","x-stream-index":"002"},"limit":{"description":"Number of messages to return","format":"int32","title":"Limit","type":"integer","x-stream-index":"005"},"message_filter_conditions":{"additionalProperties":{},"description":"Message filter conditions","title":"Message filter","type":"object","x-stream-index":"003"},"message_options":{"$ref":"#/components/schemas/MessageOptions","x-stream-index":"004"},"next":{"description":"Pagination parameter. Cannot be used with non-zero offset.","title":"Next","type":"string","x-stream-index":"008"},"offset":{"description":"Pagination offset. Cannot be used with sort or next.","format":"int32","title":"Offset","type":"integer","x-stream-index":"006"},"query":{"description":"Search phrase","title":"Query","type":"string","x-stream-index":"001"},"sort":{"description":"Sort parameters. Cannot be used with non-zero offset","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"007"}},"required":["filter_conditions"],"type":"object"},"SearchResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"005.001"},"next":{"description":"Value to pass to the next search query in order to paginate","title":"Next","type":"string","x-stream-index":"003"},"previous":{"description":"Value that points to the previous page. Pass as the next value in a search query to paginate backwards","title":"Previous","type":"string","x-stream-index":"004"},"results":{"description":"Search results","items":{"$ref":"#/components/schemas/SearchResult"},"title":"Results","type":"array","x-stream-index":"001"},"results_warning":{"$ref":"#/components/schemas/SearchWarning","description":"Warning about the search results","title":"Results Warning","x-stream-index":"002"}},"required":["results","duration"],"type":"object"},"SearchResult":{"properties":{"message":{"$ref":"#/components/schemas/SearchResultMessage","description":"Found message","title":"Message","x-stream-index":"001"}},"type":"object"},"SearchResultMessage":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"001.008"},"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel object","title":"Channel","x-stream-index":"002"},"cid":{"type":"string","x-stream-index":"001.022"},"command":{"type":"string","x-stream-index":"001.004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.023"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.026"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.025"},"deleted_for_me":{"type":"boolean","x-stream-index":"001.044"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"001.018"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001.041"},"html":{"type":"string","x-stream-index":"001.005"},"i18n":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.030"},"id":{"type":"string","x-stream-index":"001.001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"001.028"},"latest_reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"001.009"},"mentioned_users":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"001.029"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"001.036"},"mml":{"type":"string","x-stream-index":"001.003"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"001.039"},"own_reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"001.010"},"parent_id":{"type":"string","x-stream-index":"001.015"},"pin_expires":{"format":"date-time","type":"number","x-stream-index":"001.035"},"pinned":{"type":"boolean","x-stream-index":"001.032"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"001.033"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001.034"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001.038"},"poll_id":{"type":"string","x-stream-index":"001.037"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001.020"},"quoted_message_id":{"type":"string","x-stream-index":"001.019"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001.011"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"001.014"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001.012"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"001.042"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"001.017"},"restricted_visibility":{"items":{"type":"string"},"type":"array","x-stream-index":"001.040"},"shadowed":{"type":"boolean","x-stream-index":"001.027"},"shared_location":{"$ref":"#/components/schemas/SharedLocationResponseData","x-stream-index":"001.043"},"show_in_channel":{"type":"boolean","x-stream-index":"001.016"},"silent":{"type":"boolean","x-stream-index":"001.031"},"text":{"type":"string","x-stream-index":"001.002"},"thread_participants":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"001.021"},"type":{"type":"string","x-stream-index":"001.006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.024"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001.007"}},"required":["id","text","html","type","user","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned","restricted_visibility"],"type":"object"},"SearchWarning":{"properties":{"channel_search_cids":{"description":"Channel CIDs for the searched channels","items":{"type":"string"},"title":"Channel Search CIDs","type":"array","x-stream-index":"004"},"channel_search_count":{"description":"Number of channels searched","format":"int32","title":"Channel Search Count","type":"integer","x-stream-index":"003"},"warning_code":{"description":"Code corresponding to the warning","format":"int32","title":"Warning Code","type":"integer","x-stream-index":"002"},"warning_description":{"description":"Description of the warning","title":"Warning Description","type":"string","x-stream-index":"001"}},"required":["warning_description","warning_code"],"type":"object"},"Segment":{"nullable":true,"properties":{"all_sender_channels":{"type":"boolean","x-stream-index":"007"},"all_users":{"type":"boolean","x-stream-index":"006"},"created_at":{"format":"date-time","type":"number","x-stream-index":"010"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"012"},"description":{"type":"string","x-stream-index":"004"},"filter":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"name":{"type":"string","x-stream-index":"003"},"size":{"format":"int32","type":"integer","x-stream-index":"009"},"task_id":{"type":"string","x-stream-index":"008"},"type":{"type":"string","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"011"}},"required":["id","type","name","all_users","all_sender_channels","size","created_at","updated_at"],"type":"object"},"SegmentResponse":{"properties":{"all_sender_channels":{"type":"boolean","x-stream-index":"007"},"all_users":{"type":"boolean","x-stream-index":"006"},"created_at":{"format":"date-time","type":"number","x-stream-index":"009"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"description":{"type":"string","x-stream-index":"004"},"filter":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"name":{"type":"string","x-stream-index":"003"},"size":{"format":"int32","type":"integer","x-stream-index":"008"},"type":{"type":"string","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"010"}},"required":["id","type","name","description","filter","all_users","all_sender_channels","size","created_at","updated_at","deleted_at"],"type":"object"},"SegmentTargetResponse":{"nullable":true,"properties":{"app_pk":{"format":"int32","type":"integer","x-stream-index":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"segment_id":{"type":"string","x-stream-index":"002"},"target_id":{"type":"string","x-stream-index":"003"}},"required":["app_pk","segment_id","target_id","created_at"],"type":"object"},"SendCallEventRequest":{"description":"Send a call event to the other user","nullable":true,"properties":{"custom":{"additionalProperties":{},"title":"Custom","type":"object","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"title":"SendCallEventRequest","type":"object"},"SendCallEventResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"SendCallEventResponse","type":"object"},"SendEventRequest":{"nullable":true,"properties":{"event":{"$ref":"#/components/schemas/EventRequest","x-stream-index":"001"}},"required":["event"],"type":"object"},"SendMessageRequest":{"nullable":true,"properties":{"force_moderation":{"type":"boolean","x-stream-index":"007"},"keep_channel_hidden":{"type":"boolean","x-stream-index":"008"},"message":{"$ref":"#/components/schemas/MessageRequest","x-stream-index":"001"},"pending":{"type":"boolean","x-stream-index":"006"},"pending_message_metadata":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"005"},"skip_enrich_url":{"type":"boolean","x-stream-index":"003"},"skip_push":{"type":"boolean","x-stream-index":"002"}},"required":["message"],"type":"object"},"SendMessageResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Message response","title":"Message","x-stream-index":"001"},"pending_message_metadata":{"additionalProperties":{"type":"string"},"description":"Pending message metadata","title":"Pending message metadata","type":"object","x-stream-index":"002"}},"required":["message","duration"],"type":"object"},"SendReactionRequest":{"nullable":true,"properties":{"enforce_unique":{"description":"Whether to replace all existing user reactions","title":"Enforce unique","type":"boolean","x-stream-index":"003"},"reaction":{"$ref":"#/components/schemas/ReactionRequest","x-stream-index":"002"},"skip_push":{"description":"Skips any mobile push notifications","title":"Skip push","type":"boolean","x-stream-index":"004"}},"required":["reaction"],"type":"object"},"SendReactionResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001"},"reaction":{"$ref":"#/components/schemas/ReactionResponse","x-stream-index":"002"}},"required":["message","reaction","duration"],"title":"Response","type":"object"},"SendUserCustomEventRequest":{"nullable":true,"properties":{"event":{"$ref":"#/components/schemas/UserCustomEventRequest","x-stream-index":"001"}},"required":["event"],"type":"object"},"SessionSettings":{"properties":{"inactivity_timeout_seconds":{"format":"int32","maximum":900,"minimum":5,"type":"integer","x-stream-index":"001"}},"required":["inactivity_timeout_seconds"],"type":"object"},"SessionSettingsRequest":{"properties":{"inactivity_timeout_seconds":{"format":"int32","maximum":900,"minimum":5,"type":"integer","x-stream-index":"001"}},"required":["inactivity_timeout_seconds"],"type":"object"},"SessionSettingsResponse":{"properties":{"inactivity_timeout_seconds":{"format":"int32","maximum":900,"minimum":5,"type":"integer","x-stream-index":"001"}},"required":["inactivity_timeout_seconds"],"type":"object"},"ShadowBlockActionRequest":{"type":"object"},"SharedLocation":{"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"013"},"channel_cid":{"type":"string","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"010"},"created_by_device_id":{"type":"string","x-stream-index":"008"},"end_at":{"format":"date-time","type":"number","x-stream-index":"009"},"latitude":{"format":"float","maximum":90,"minimum":18446744073709552000,"type":"number","x-stream-index":"006"},"longitude":{"format":"float","maximum":180,"minimum":18446744073709552000,"type":"number","x-stream-index":"007"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"012"},"message_id":{"type":"string","x-stream-index":"004"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"011"},"user_id":{"type":"string","x-stream-index":"005"}},"required":["channel_cid","message_id","user_id","created_by_device_id","created_at","updated_at"],"type":"object"},"SharedLocationResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001.011"},"channel_cid":{"description":"Channel CID","title":"string","type":"string","x-stream-index":"001.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.008"},"created_by_device_id":{"description":"Device ID that created the live location","title":"string","type":"string","x-stream-index":"001.006"},"duration":{"type":"string","x-stream-index":"002.001"},"end_at":{"description":"Time when the live location expires","format":"date-time","title":"string","type":"number","x-stream-index":"001.007"},"latitude":{"description":"Latitude coordinate","format":"float","title":"number","type":"number","x-stream-index":"001.004"},"longitude":{"description":"Longitude coordinate","format":"float","title":"number","type":"number","x-stream-index":"001.005"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001.010"},"message_id":{"description":"Message ID","title":"string","type":"string","x-stream-index":"001.002"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.009"},"user_id":{"description":"User ID","title":"string","type":"string","x-stream-index":"001.003"}},"required":["channel_cid","message_id","user_id","latitude","longitude","created_by_device_id","created_at","updated_at","duration"],"type":"object"},"SharedLocationResponseData":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"011"},"channel_cid":{"type":"string","x-stream-index":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"created_by_device_id":{"type":"string","x-stream-index":"006"},"end_at":{"format":"date-time","type":"number","x-stream-index":"007"},"latitude":{"format":"float","type":"number","x-stream-index":"004"},"longitude":{"format":"float","type":"number","x-stream-index":"005"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"010"},"message_id":{"type":"string","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["channel_cid","message_id","user_id","latitude","longitude","created_by_device_id","created_at","updated_at"],"type":"object"},"SharedLocationsResponse":{"nullable":true,"properties":{"active_live_locations":{"items":{"$ref":"#/components/schemas/SharedLocationResponseData"},"type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["active_live_locations","duration"],"type":"object"},"ShowChannelRequest":{"nullable":true,"properties":{"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"002.002"},"user_id":{"type":"string","x-stream-index":"002.001"}},"type":"object"},"ShowChannelResponse":{"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"},"SingleFollowResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"follow":{"$ref":"#/components/schemas/FollowResponse","description":"The created follow relationship","title":"Follow","x-stream-index":"001"}},"required":["follow","duration"],"title":"Follow Response","type":"object"},"SortParam":{"nullable":true,"properties":{"direction":{"format":"int32","type":"integer","x-stream-index":"002"},"field":{"type":"string","x-stream-index":"001"}},"type":"object"},"SortParamRequest":{"nullable":true,"properties":{"direction":{"description":"Direction of sorting, 1 for Ascending, -1 for Descending, default is 1","format":"int32","title":"Direction","type":"integer","x-stream-index":"002"},"field":{"description":"Name of field to sort by","title":"Field","type":"string","x-stream-index":"001"}},"type":"object"},"StartCampaignRequest":{"nullable":true,"properties":{"scheduled_for":{"format":"date-time","type":"number","x-stream-index":"002"},"stop_at":{"format":"date-time","type":"number","x-stream-index":"003"}},"type":"object"},"StartCampaignResponse":{"description":"Basic response information","nullable":true,"properties":{"campaign":{"$ref":"#/components/schemas/CampaignResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"users":{"$ref":"#/components/schemas/PagerResponse","x-stream-index":"002"}},"required":["duration"],"title":"Response","type":"object"},"StartClosedCaptionsRequest":{"nullable":true,"properties":{"enable_transcription":{"description":"Enable transcriptions along with closed captions","title":"Enable Transcription","type":"boolean","x-stream-index":"002"},"external_storage":{"description":"Which external storage to use for transcriptions (only applicable if enable_transcription is true)","title":"External Storage","type":"string","x-stream-index":"003"},"language":{"description":"The spoken language in the call, if not provided the language defined in the transcription settings will be used","enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"title":"Language","type":"string","x-stream-index":"004"}},"type":"object"},"StartClosedCaptionsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"StartFrameRecordingRequest":{"nullable":true,"properties":{"recording_external_storage":{"type":"string","x-stream-index":"002"}},"title":"StartFrameRecordingRequest","type":"object"},"StartFrameRecordingResponse":{"description":"StartFrameRecordingResponse is the response payload for the start frame recording endpoint.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StartFrameRecordingResponse","type":"object"},"StartHLSBroadcastingRequest":{"description":"StartHLSBroadcastingRequest is the payload for starting an HLS broadcasting.","nullable":true,"title":"StartHLSBroadcastingRequest","type":"object"},"StartHLSBroadcastingResponse":{"description":"StartHLSBroadcastingResponse is the payload for starting an HLS broadcasting.","nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"},"playlist_url":{"description":"the URL of the HLS playlist","title":"PlaylistURL","type":"string","x-stream-index":"002"}},"required":["duration","playlist_url"],"title":"StartHLSBroadcastingResponse","type":"object"},"StartRTMPBroadcastsRequest":{"description":"StartRTMPBroadcastsRequest is the payload for starting RTMP broadcasts.","nullable":true,"properties":{"broadcasts":{"description":"List of broadcasts to start","items":{"$ref":"#/components/schemas/RTMPBroadcastRequest"},"maximum":1,"minimum":1,"title":"Broadcasts","type":"array","x-stream-index":"002"}},"required":["broadcasts"],"title":"StartRTMPBroadcastsRequest","type":"object"},"StartRTMPBroadcastsResponse":{"description":"StartRTMPBroadcastsResponse is the payload for starting an RTMP broadcast.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StartRTMPBroadcastsResponse","type":"object"},"StartRecordingRequest":{"nullable":true,"properties":{"recording_external_storage":{"type":"string","x-stream-index":"002"}},"title":"StartRecordingRequest","type":"object"},"StartRecordingResponse":{"description":"StartRecordingResponse is the response payload for the start recording endpoint.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StartRecordingResponse","type":"object"},"StartTranscriptionRequest":{"nullable":true,"properties":{"enable_closed_captions":{"description":"Enable closed captions along with transcriptions","title":"Enable Closed Captions","type":"boolean","x-stream-index":"003"},"language":{"description":"The spoken language in the call, if not provided the language defined in the transcription settings will be used","enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"title":"Language","type":"string","x-stream-index":"004"},"transcription_external_storage":{"description":"Store transcriptions in this external storage","title":"External Storage","type":"string","x-stream-index":"002"}},"type":"object"},"StartTranscriptionResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StartTranscriptionResponse","type":"object"},"StopAllRTMPBroadcastsRequest":{"nullable":true,"title":"StopAllRTMPBroadcastsRequest","type":"object"},"StopAllRTMPBroadcastsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StopAllRTMPBroadcastsResponse","type":"object"},"StopCampaignRequest":{"nullable":true,"type":"object"},"StopClosedCaptionsRequest":{"nullable":true,"properties":{"stop_transcription":{"type":"boolean","x-stream-index":"003"}},"type":"object"},"StopClosedCaptionsResponse":{"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"},"StopFrameRecordingRequest":{"nullable":true,"type":"object"},"StopFrameRecordingResponse":{"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"},"StopHLSBroadcastingRequest":{"nullable":true,"type":"object"},"StopHLSBroadcastingResponse":{"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"},"StopLiveRequest":{"nullable":true,"properties":{"continue_closed_caption":{"type":"boolean","x-stream-index":"006"},"continue_hls":{"type":"boolean","x-stream-index":"003"},"continue_recording":{"type":"boolean","x-stream-index":"004"},"continue_rtmp_broadcasts":{"type":"boolean","x-stream-index":"007"},"continue_transcription":{"type":"boolean","x-stream-index":"005"}},"title":"StopLiveRequest","type":"object"},"StopLiveResponse":{"nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"The call that was stopped","title":"Call","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["call","duration"],"title":"StopLiveResponse","type":"object"},"StopRTMPBroadcastsRequest":{"description":"Request for stopping RTMP broadcasts","nullable":true,"title":"StopRTMPBroadcastsRequest","type":"object"},"StopRTMPBroadcastsResponse":{"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"},"StopRecordingRequest":{"nullable":true,"type":"object"},"StopRecordingResponse":{"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"},"StopTranscriptionRequest":{"nullable":true,"properties":{"stop_closed_captions":{"type":"boolean","x-stream-index":"003"}},"type":"object"},"StopTranscriptionResponse":{"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"},"StoriesConfig":{"properties":{"expiration_behaviour":{"description":"Behavior when stories expire","title":"Expiration Behavior","type":"string","x-stream-index":"001"},"skip_watched":{"description":"Whether to skip already watched stories","title":"Skip Watched","type":"boolean","x-stream-index":"002"}},"title":"Stories Configuration","type":"object"},"SubmitActionRequest":{"nullable":true,"properties":{"action_type":{"description":"Type of moderation action to perform (mark_reviewed, delete_message, etc.)","enum":["mark_reviewed","delete_message","delete_activity","delete_reaction","ban","custom","unban","restore","delete_user","unblock","shadow_block","unmask","kick_user","end_call"],"title":"Action Type","type":"string","x-stream-index":"002"},"ban":{"$ref":"#/components/schemas/BanActionRequest","description":"Configuration for ban action","title":"Ban","x-stream-index":"008"},"custom":{"$ref":"#/components/schemas/CustomActionRequest","description":"Configuration for custom action","title":"Custom","x-stream-index":"009"},"delete_activity":{"$ref":"#/components/schemas/DeleteActivityRequest","description":"Configuration for activity deletion action","title":"Delete Activity","x-stream-index":"004"},"delete_message":{"$ref":"#/components/schemas/DeleteMessageRequest","description":"Configuration for message deletion action","title":"Delete Message","x-stream-index":"003"},"delete_reaction":{"$ref":"#/components/schemas/DeleteReactionRequest","description":"Configuration for reaction deletion action","title":"Delete Reaction","x-stream-index":"005"},"delete_user":{"$ref":"#/components/schemas/DeleteUserRequest","description":"Configuration for user deletion action","title":"Delete User","x-stream-index":"006"},"item_id":{"description":"UUID of the review queue item to act on","title":"Item ID","type":"string","x-stream-index":"001"},"mark_reviewed":{"$ref":"#/components/schemas/MarkReviewedRequest","description":"Configuration for marking item as reviewed","title":"Mark Reviewed","x-stream-index":"007"},"unban":{"$ref":"#/components/schemas/UnbanActionRequest","description":"Configuration for unban action","title":"Unban","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"016.002"},"user_id":{"type":"string","x-stream-index":"016.001"}},"required":["item_id","action_type"],"type":"object"},"SubmitActionResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"Updated review queue item after action was performed","title":"Item","x-stream-index":"001"}},"required":["duration"],"type":"object"},"SubscriberAllMetrics":{"properties":{"audio":{"$ref":"#/components/schemas/SubscriberAudioMetrics","x-stream-index":"001"},"rtt_ms":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"003"},"video":{"$ref":"#/components/schemas/SubscriberVideoMetrics","x-stream-index":"002"}},"type":"object"},"SubscriberAudioMetrics":{"properties":{"concealment_pct":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"003"},"jitter_ms":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"001"},"packets_lost_pct":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"002"}},"type":"object"},"SubscriberStatsResponse":{"properties":{"total":{"format":"int32","type":"integer","x-stream-index":"001"},"total_subscribed_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"003"},"unique":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["total","unique","total_subscribed_duration_seconds"],"type":"object"},"SubscriberVideoMetrics":{"properties":{"fps_30":{"$ref":"#/components/schemas/ActiveCallsFPSStats","x-stream-index":"002"},"jitter_ms":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"001"},"packets_lost_pct":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"003"}},"type":"object"},"SubscribersMetrics":{"properties":{"all":{"$ref":"#/components/schemas/SubscriberAllMetrics","x-stream-index":"001"}},"type":"object"},"TargetResolution":{"properties":{"bitrate":{"format":"int32","maximum":6000000,"type":"integer","x-stream-index":"003"},"height":{"format":"int32","maximum":3840,"minimum":240,"type":"integer","x-stream-index":"002"},"width":{"format":"int32","maximum":3840,"minimum":240,"type":"integer","x-stream-index":"001"}},"required":["width","height","bitrate"],"type":"object"},"TextContentParameters":{"properties":{"blocklist_match":{"items":{"type":"string"},"type":"array","x-stream-index":"005"},"contains_url":{"type":"boolean","x-stream-index":"003"},"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001"},"llm_harm_labels":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"002"},"severity":{"type":"string","x-stream-index":"004"}},"type":"object"},"TextRuleParameters":{"properties":{"blocklist_match":{"items":{"type":"string"},"type":"array","x-stream-index":"007"},"contains_url":{"type":"boolean","x-stream-index":"005"},"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"llm_harm_labels":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"004"},"severity":{"type":"string","x-stream-index":"006"},"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"type":"object"},"ThreadParticipant":{"description":"Represents a user that is participating in a thread.","nullable":true,"properties":{"app_pk":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"001"},"channel_cid":{"type":"string","x-stream-index":"002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"007"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"last_read_at":{"format":"date-time","type":"number","x-stream-index":"009"},"last_thread_message_at":{"format":"date-time","type":"number","x-stream-index":"003"},"left_thread_at":{"description":"Left Thread At is the time when the user left the thread","format":"date-time","title":"Left Thread At","type":"number","x-stream-index":"008"},"thread_id":{"description":"Thead ID is unique string identifier of the thread","title":"ID","type":"string","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User is the user object","title":"User","x-stream-index":"006"},"user_id":{"description":"User ID is unique string identifier of the user","title":"User ID","type":"string","x-stream-index":"005"}},"required":["app_pk","channel_cid","created_at","last_read_at","custom"],"title":"ThreadParticipant","type":"object"},"ThreadResponse":{"properties":{"active_participant_count":{"description":"Active Participant Count","format":"int32","title":"Active Participant Count","type":"integer","x-stream-index":"009"},"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel","title":"ChannelResponse","x-stream-index":"002"},"channel_cid":{"description":"Channel CID","title":"Channel CID","type":"string","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"012"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"Created By User","title":"User","x-stream-index":"006"},"created_by_user_id":{"description":"Created By User ID","title":"Created By User ID","type":"string","x-stream-index":"005"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"016"},"deleted_at":{"description":"Deleted At","format":"date-time","title":"Deleted At","type":"number","x-stream-index":"014"},"last_message_at":{"description":"Last Message At","format":"date-time","title":"Last Message At","type":"number","x-stream-index":"011"},"parent_message":{"$ref":"#/components/schemas/MessageResponse","description":"Parent Message","title":"Message","x-stream-index":"004"},"parent_message_id":{"description":"Parent Message ID","title":"Parent Message ID","type":"string","x-stream-index":"003"},"participant_count":{"description":"Participant Count","format":"int32","title":"Participant Count","type":"integer","x-stream-index":"008"},"reply_count":{"description":"Reply Count","format":"int32","title":"Reply Count","type":"integer","x-stream-index":"007"},"thread_participants":{"description":"Thread Participants","items":{"$ref":"#/components/schemas/ThreadParticipant"},"title":"ThreadParticipants","type":"array","x-stream-index":"010"},"title":{"description":"Title","title":"Title","type":"string","x-stream-index":"015"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"013"}},"required":["channel_cid","parent_message_id","created_by_user_id","created_at","updated_at","title","custom"],"type":"object"},"ThreadStateResponse":{"nullable":true,"properties":{"active_participant_count":{"description":"Active Participant Count","format":"int32","title":"Active Participant Count","type":"integer","x-stream-index":"001.009"},"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel","title":"ChannelResponse","x-stream-index":"001.002"},"channel_cid":{"description":"Channel CID","title":"Channel CID","type":"string","x-stream-index":"001.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.012"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"Created By User","title":"User","x-stream-index":"001.006"},"created_by_user_id":{"description":"Created By User ID","title":"Created By User ID","type":"string","x-stream-index":"001.005"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"001.016"},"deleted_at":{"description":"Deleted At","format":"date-time","title":"Deleted At","type":"number","x-stream-index":"001.014"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"004"},"last_message_at":{"description":"Last Message At","format":"date-time","title":"Last Message At","type":"number","x-stream-index":"001.011"},"latest_replies":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","x-stream-index":"002"},"parent_message":{"$ref":"#/components/schemas/MessageResponse","description":"Parent Message","title":"Message","x-stream-index":"001.004"},"parent_message_id":{"description":"Parent Message ID","title":"Parent Message ID","type":"string","x-stream-index":"001.003"},"participant_count":{"description":"Participant Count","format":"int32","title":"Participant Count","type":"integer","x-stream-index":"001.008"},"read":{"items":{"$ref":"#/components/schemas/ReadStateResponse"},"type":"array","x-stream-index":"003"},"reply_count":{"description":"Reply Count","format":"int32","title":"Reply Count","type":"integer","x-stream-index":"001.007"},"thread_participants":{"description":"Thread Participants","items":{"$ref":"#/components/schemas/ThreadParticipant"},"title":"ThreadParticipants","type":"array","x-stream-index":"001.010"},"title":{"description":"Title","title":"Title","type":"string","x-stream-index":"001.015"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.013"}},"required":["channel_cid","parent_message_id","created_by_user_id","created_at","updated_at","title","custom","latest_replies"],"type":"object"},"ThreadUpdatedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"001.002"},"channel_type":{"type":"string","x-stream-index":"001.003"},"cid":{"type":"string","x-stream-index":"001.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"thread":{"$ref":"#/components/schemas/ThreadResponse","x-stream-index":"003.001"},"type":{"default":"thread.updated","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"ThreadUpdatedEvent","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"},"ThreadedCommentResponse":{"description":"A comment with an optional, depth‑limited slice of nested replies.","properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"001.011"},"confidence_score":{"format":"float","type":"number","x-stream-index":"001.022"},"controversy_score":{"format":"float","type":"number","x-stream-index":"001.023"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.014"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.006"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.016"},"downvote_count":{"format":"int32","type":"integer","x-stream-index":"001.020"},"id":{"type":"string","x-stream-index":"001.001"},"latest_reactions":{"items":{"$ref":"#/components/schemas/FeedsReactionResponse"},"type":"array","x-stream-index":"001.009"},"mentioned_users":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"001.012"},"meta":{"$ref":"#/components/schemas/RepliesMeta","description":"Pagination \u0026 depth info for this node's direct replies.","title":"Replies Meta","x-stream-index":"002"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"001.017"},"object_id":{"type":"string","x-stream-index":"001.002"},"object_type":{"type":"string","x-stream-index":"001.003"},"own_reactions":{"items":{"$ref":"#/components/schemas/FeedsReactionResponse"},"type":"array","x-stream-index":"001.024"},"parent_id":{"type":"string","x-stream-index":"001.007"},"reaction_count":{"format":"int32","type":"integer","x-stream-index":"001.008"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"001.010"},"replies":{"description":"Slice of nested comments (may be empty).","items":{"$ref":"#/components/schemas/ThreadedCommentResponse"},"title":"Replies","type":"array","x-stream-index":"003"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"001.018"},"score":{"format":"int32","type":"integer","x-stream-index":"001.021"},"status":{"type":"string","x-stream-index":"001.013"},"text":{"type":"string","x-stream-index":"001.005"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.015"},"upvote_count":{"format":"int32","type":"integer","x-stream-index":"001.019"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001.004"}},"required":["id","object_id","object_type","user","reaction_count","mentioned_users","status","created_at","updated_at","reply_count","upvote_count","downvote_count","score","confidence_score","own_reactions"],"title":"Threaded Comment","type":"object"},"Thresholds":{"description":"Sets thresholds for AI moderation","properties":{"explicit":{"$ref":"#/components/schemas/LabelThresholds","description":"Thresholds for explicit messages","title":"LabelThresholds","x-stream-index":"001"},"spam":{"$ref":"#/components/schemas/LabelThresholds","description":"Thresholds for spam","title":"LabelThresholds","x-stream-index":"002"},"toxic":{"$ref":"#/components/schemas/LabelThresholds","description":"Thresholds for toxic messages","title":"LabelThresholds","x-stream-index":"003"}},"title":"Auto moderation thresholds","type":"object"},"ThumbnailResponse":{"properties":{"image_url":{"type":"string","x-stream-index":"001"}},"required":["image_url"],"type":"object"},"ThumbnailsSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"ThumbnailsSettingsRequest":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"ThumbnailsSettingsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"Time":{"type":"object"},"TrackStatsResponse":{"nullable":true,"properties":{"duration_seconds":{"format":"int32","type":"integer","x-stream-index":"002"},"track_type":{"type":"string","x-stream-index":"001"}},"required":["track_type","duration_seconds"],"type":"object"},"TranscriptionSettings":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"title":"Mode","type":"string","x-stream-index":"002"},"language":{"description":"The language used in this call as a two letter code","enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"title":"Language","type":"string","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"title":"Mode","type":"string","x-stream-index":"001"}},"required":["mode","closed_caption_mode","languages","language"],"type":"object"},"TranscriptionSettingsRequest":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"002"},"language":{"enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"type":"string","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode"],"type":"object"},"TranscriptionSettingsResponse":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"002"},"language":{"enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"type":"string","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode","closed_caption_mode","languages","language"],"type":"object"},"TranslateMessageRequest":{"nullable":true,"properties":{"language":{"description":"Language to translate message to","enum":["af","sq","am","ar","az","bn","bs","bg","zh","zh-TW","hr","cs","da","fa-AF","nl","en","et","fi","fr","fr-CA","ka","de","el","ha","he","hi","hu","id","it","ja","ko","lv","ms","no","fa","ps","pl","pt","ro","ru","sr","sk","sl","so","es","es-MX","sw","sv","tl","ta","th","tr","uk","ur","vi","lt","ht"],"title":"Language","type":"string","x-stream-index":"001"}},"required":["language"],"type":"object"},"TruncateChannelRequest":{"nullable":true,"properties":{"hard_delete":{"description":"Permanently delete channel data (messages, reactions, etc.)","title":"Hard delete","type":"boolean","x-stream-index":"002"},"member_ids":{"description":"List of member IDs to hide message history for. If empty, truncates the channel for all members","items":{"type":"string"},"maximum":100,"title":"Member IDs","type":"array","x-stream-index":"007"},"message":{"$ref":"#/components/schemas/MessageRequest","x-stream-index":"004"},"skip_push":{"description":"When `message` is set disables all push notifications for it","title":"Skip push","type":"boolean","x-stream-index":"005"},"truncated_at":{"description":"Truncate channel data up to `truncated_at`. The system message (if provided) creation time is always greater than `truncated_at`","format":"date-time","title":"Truncated at","type":"number","x-stream-index":"006"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"008.002"},"user_id":{"type":"string","x-stream-index":"008.001"}},"type":"object"},"TruncateChannelResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Truncated channel object","title":"Channel","x-stream-index":"002"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Truncated message object","title":"Message","x-stream-index":"003"}},"required":["duration"],"type":"object"},"TypingIndicators":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"TypingIndicatorsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"UnbanActionRequest":{"type":"object"},"UnbanRequest":{"nullable":true,"properties":{"unbanned_by":{"$ref":"#/components/schemas/UserRequest","description":"Details about the user performing the unban","title":"Unbanned By","x-stream-index":"005"},"unbanned_by_id":{"description":"ID of the user performing the unban","title":"Unbanned By ID","type":"string","x-stream-index":"004"}},"type":"object"},"UnbanResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"UnblockActionRequest":{"type":"object"},"UnblockUserRequest":{"description":"UnblockUserRequest is the payload for unblocking a user.","nullable":true,"properties":{"user_id":{"description":"the user to unblock","title":"UserID","type":"string","x-stream-index":"003"}},"required":["user_id"],"title":"UnblockUserRequest","type":"object"},"UnblockUserResponse":{"description":"UnblockUserResponse is the payload for unblocking a user.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"UnblockUserResponse","type":"object"},"UnblockUsersRequest":{"nullable":true,"properties":{"blocked_user_id":{"type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"required":["blocked_user_id"],"type":"object"},"UnblockUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"UnblockedUserEvent":{"description":"This event is sent when a user is unblocked on a call,\nthis can be useful to notify the user that they can now join the call again","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.unblocked_user","description":"The type of event: \"call.unblocked_user\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user that was unblocked","title":"User","x-stream-index":"003"}},"required":["type","created_at","call_cid","user"],"title":"UnblockedUserEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"UnfollowBatchRequest":{"nullable":true,"properties":{"follows":{"description":"List of follow relationships to remove","items":{"$ref":"#/components/schemas/FollowPair"},"maximum":100,"minimum":1,"title":"Follows","type":"array","x-stream-index":"001"}},"required":["follows"],"title":"Unfollow Batch Request","type":"object"},"UnfollowBatchResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"follows":{"description":"List of follow relationships that were removed","items":{"$ref":"#/components/schemas/FollowResponse"},"title":"Follows","type":"array","x-stream-index":"001"}},"required":["follows","duration"],"title":"Unfollow Batch Response","type":"object"},"UnfollowResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"follow":{"$ref":"#/components/schemas/FollowResponse","description":"The deleted follow relationship","title":"Follow","x-stream-index":"001"}},"required":["follow","duration"],"title":"Unfollow Response","type":"object"},"UnmuteChannelRequest":{"nullable":true,"properties":{"channel_cids":{"description":"Channel CIDs to mute (if multiple channels)","items":{"type":"string"},"maximum":25,"title":"Channel CIDs","type":"array","x-stream-index":"001.002"},"expiration":{"description":"Duration of mute in milliseconds","title":"Expiration","type":"integer","x-stream-index":"001.003"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"002.002"},"user_id":{"type":"string","x-stream-index":"002.001"}},"type":"object"},"UnmuteRequest":{"nullable":true,"properties":{"target_ids":{"description":"User IDs to unmute","items":{"type":"string"},"title":"Target IDs","type":"array","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"002.002"},"user_id":{"type":"string","x-stream-index":"002.001"}},"required":["target_ids"],"title":"UnmuteRequest","type":"object"},"UnmuteResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"non_existing_users":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"required":["duration"],"title":"Response","type":"object"},"UnpinActivityResponse":{"nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","description":"The unpinned activity","title":"Activity","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"004.001"},"feed":{"description":"Fully qualified ID of the feed the activity was unpinned from","title":"Feed ID","type":"string","x-stream-index":"002"},"user_id":{"description":"ID of the user who unpinned the activity","title":"User ID","type":"string","x-stream-index":"003"}},"required":["activity","feed","user_id","duration"],"title":"Unpin Activity Response","type":"object"},"UnpinRequest":{"description":"UnpinRequest is the payload for unpinning a message.","nullable":true,"properties":{"session_id":{"description":"the session ID of the user who pinned the message","title":"SessionID","type":"string","x-stream-index":"003"},"user_id":{"description":"the user ID of the user who pinned the message","title":"UserID","type":"string","x-stream-index":"002"}},"required":["user_id","session_id"],"title":"UnpinRequest","type":"object"},"UnpinResponse":{"description":"UnpinResponse is the payload for unpinning a message.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"UnpinResponse","type":"object"},"UnreadCountsBatchRequest":{"nullable":true,"properties":{"user_ids":{"items":{"type":"string"},"maximum":100,"type":"array","x-stream-index":"001"}},"required":["user_ids"],"type":"object"},"UnreadCountsBatchResponse":{"description":"Basic response information","nullable":true,"properties":{"counts_by_user":{"additionalProperties":{"$ref":"#/components/schemas/UnreadCountsResponse"},"type":"object","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["counts_by_user","duration"],"title":"Response","type":"object"},"UnreadCountsChannel":{"properties":{"channel_id":{"type":"string","x-stream-index":"001"},"last_read":{"format":"date-time","type":"number","x-stream-index":"003"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["channel_id","unread_count","last_read"],"type":"object"},"UnreadCountsChannelType":{"properties":{"channel_count":{"format":"int32","type":"integer","x-stream-index":"002"},"channel_type":{"type":"string","x-stream-index":"001"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["channel_type","channel_count","unread_count"],"type":"object"},"UnreadCountsResponse":{"nullable":true,"properties":{"channel_type":{"items":{"$ref":"#/components/schemas/UnreadCountsChannelType"},"type":"array","x-stream-index":"005"},"channels":{"items":{"$ref":"#/components/schemas/UnreadCountsChannel"},"type":"array","x-stream-index":"004"},"threads":{"items":{"$ref":"#/components/schemas/UnreadCountsThread"},"type":"array","x-stream-index":"006"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"001"},"total_unread_count_by_team":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"003"},"total_unread_threads_count":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["total_unread_count","total_unread_threads_count","channels","channel_type","threads"],"type":"object"},"UnreadCountsThread":{"properties":{"last_read":{"format":"date-time","type":"number","x-stream-index":"002"},"last_read_message_id":{"type":"string","x-stream-index":"003"},"parent_message_id":{"type":"string","x-stream-index":"004"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"001"}},"required":["unread_count","last_read","last_read_message_id","parent_message_id"],"type":"object"},"UpdateActivityPartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"description":"Map of dot-notation field paths to new values","title":"object","type":"object","x-stream-index":"002"},"unset":{"description":"List of dot-notation paths to remove","items":{"type":"string"},"title":"[]string","type":"array","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"005.002"},"user_id":{"type":"string","x-stream-index":"005.001"}},"type":"object"},"UpdateActivityPartialResponse":{"nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","description":"The updated activity","title":"ActivityResponse","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["activity","duration"],"type":"object"},"UpdateActivityRequest":{"nullable":true,"properties":{"attachments":{"description":"List of attachments for the activity","items":{"$ref":"#/components/schemas/Attachment"},"title":"[]ActivityAttachment","type":"array","x-stream-index":"003"},"custom":{"additionalProperties":{},"description":"Custom data for the activity","title":"object","type":"object","x-stream-index":"004"},"expires_at":{"description":"Time when the activity will expire","format":"date-time","title":"string","type":"number","x-stream-index":"007"},"filter_tags":{"description":"Tags used for filtering the activity","items":{"type":"string"},"title":"[]string","type":"array","x-stream-index":"008"},"interest_tags":{"description":"Tags indicating interest categories","items":{"type":"string"},"title":"[]string","type":"array","x-stream-index":"009"},"location":{"$ref":"#/components/schemas/ActivityLocation","description":"Geographic location for the activity","title":"ActivityLocation","x-stream-index":"006"},"poll_id":{"description":"Poll ID","title":"string","type":"string","x-stream-index":"010"},"text":{"description":"The text content of the activity","title":"string","type":"string","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"012.002"},"user_id":{"type":"string","x-stream-index":"012.001"},"visibility":{"description":"Visibility setting for the activity","title":"string","type":"string","x-stream-index":"005"}},"type":"object"},"UpdateActivityResponse":{"nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","description":"The updated activity","title":"ActivityResponse","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["activity","duration"],"type":"object"},"UpdateAppRequest":{"nullable":true,"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.017"},"apn_config":{"$ref":"#/components/schemas/APNConfig","x-stream-index":"001.003"},"async_moderation_config":{"$ref":"#/components/schemas/AsyncModerationConfiguration","x-stream-index":"001.039"},"async_url_enrich_enabled":{"type":"boolean","x-stream-index":"001.019"},"auto_translation_enabled":{"type":"boolean","x-stream-index":"001.018"},"before_message_send_hook_url":{"type":"string","x-stream-index":"001.020"},"cdn_expiration_seconds":{"format":"int32","maximum":1209600,"minimum":14400,"type":"integer","x-stream-index":"001.038"},"channel_hide_members_only":{"type":"boolean","x-stream-index":"001.033"},"custom_action_handler_url":{"type":"string","x-stream-index":"001.021"},"datadog_info":{"$ref":"#/components/schemas/DataDogInfo","x-stream-index":"001.040"},"disable_auth_checks":{"type":"boolean","x-stream-index":"001.001"},"disable_permissions_checks":{"type":"boolean","x-stream-index":"001.002"},"enforce_unique_usernames":{"enum":["no","app","team"],"type":"string","x-stream-index":"001.022"},"event_hooks":{"items":{"$ref":"#/components/schemas/EventHook"},"type":"array","x-stream-index":"001.046"},"feeds_moderation_enabled":{"type":"boolean","x-stream-index":"001.042"},"feeds_v2_region":{"type":"string","x-stream-index":"001.041"},"file_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","x-stream-index":"001.030"},"firebase_config":{"$ref":"#/components/schemas/FirebaseConfig","x-stream-index":"001.004"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"001.034"},"guest_user_creation_disabled":{"type":"boolean","x-stream-index":"001.043"},"huawei_config":{"$ref":"#/components/schemas/HuaweiConfig","x-stream-index":"001.005"},"image_moderation_block_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001.015"},"image_moderation_enabled":{"type":"boolean","x-stream-index":"001.016"},"image_moderation_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001.014"},"image_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","x-stream-index":"001.029"},"max_aggregated_activities_length":{"format":"int32","type":"integer","x-stream-index":"001.049"},"migrate_permissions_to_v2":{"type":"boolean","x-stream-index":"001.035"},"moderation_dashboard_preferences":{"$ref":"#/components/schemas/ModerationDashboardPreferences","x-stream-index":"001.044"},"moderation_enabled":{"type":"boolean","x-stream-index":"001.009"},"moderation_webhook_url":{"type":"string","x-stream-index":"001.010"},"multi_tenant_enabled":{"type":"boolean","x-stream-index":"001.013"},"permission_version":{"enum":["v1","v2"],"type":"string","x-stream-index":"001.011"},"push_config":{"$ref":"#/components/schemas/PushConfig","x-stream-index":"001.007"},"reminders_interval":{"format":"int32","maximum":86400,"minimum":60,"type":"integer","x-stream-index":"001.036"},"reminders_max_members":{"format":"int32","minimum":2,"type":"integer","x-stream-index":"001.037"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.031"},"sns_key":{"type":"string","x-stream-index":"001.027"},"sns_secret":{"type":"string","x-stream-index":"001.028"},"sns_topic_arn":{"type":"string","x-stream-index":"001.026"},"sqs_key":{"type":"string","x-stream-index":"001.024"},"sqs_secret":{"type":"string","x-stream-index":"001.025"},"sqs_url":{"type":"string","x-stream-index":"001.023"},"user_response_time_enabled":{"type":"boolean","x-stream-index":"001.048"},"user_search_disallowed_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"001.012"},"webhook_events":{"items":{"type":"string"},"type":"array","x-stream-index":"001.032"},"webhook_url":{"type":"string","x-stream-index":"001.008"},"xiaomi_config":{"$ref":"#/components/schemas/XiaomiConfig","x-stream-index":"001.006"}},"type":"object"},"UpdateBlockListRequest":{"nullable":true,"properties":{"team":{"type":"string","x-stream-index":"002"},"words":{"description":"List of words to block","items":{"type":"string"},"minimum":1,"title":"Words","type":"array","x-stream-index":"003"}},"title":"Update block list","type":"object","x-stream-docs-page-id":"update_block_list"},"UpdateBlockListResponse":{"description":"Basic response information","nullable":true,"properties":{"blocklist":{"$ref":"#/components/schemas/BlockListResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["duration"],"title":"Response","type":"object"},"UpdateBookmarkFolderRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"description":"Custom data for the folder","title":"Custom Data","type":"object","x-stream-index":"003"},"name":{"description":"Name of the folder","maxLength":255,"title":"Name","type":"string","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"title":"Update Bookmark Folder Request","type":"object"},"UpdateBookmarkFolderResponse":{"nullable":true,"properties":{"bookmark_folder":{"$ref":"#/components/schemas/BookmarkFolderResponse","description":"The updated bookmark folder","title":"Bookmark Folder","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["bookmark_folder","duration"],"title":"Update Bookmark Folder Response","type":"object"},"UpdateBookmarkRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"description":"Custom data for the bookmark","title":"Custom Data","type":"object","x-stream-index":"005"},"folder_id":{"description":"ID of the folder to move the bookmark to","maxLength":255,"title":"Folder ID","type":"string","x-stream-index":"002"},"new_folder":{"$ref":"#/components/schemas/AddFolderRequest","x-stream-index":"004"},"new_folder_id":{"maxLength":255,"type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"006.002"},"user_id":{"type":"string","x-stream-index":"006.001"}},"title":"Update Bookmark Request","type":"object"},"UpdateBookmarkResponse":{"nullable":true,"properties":{"bookmark":{"$ref":"#/components/schemas/BookmarkResponse","description":"The updated bookmark","title":"Bookmark","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["bookmark","duration"],"title":"Update Bookmark Response","type":"object"},"UpdateCallMembersRequest":{"description":"Update call members","nullable":true,"properties":{"remove_members":{"description":"List of userID to remove","items":{"type":"string"},"maximum":100,"title":"Remove Members","type":"array","x-stream-index":"003"},"update_members":{"description":"List of members to update or insert","items":{"$ref":"#/components/schemas/MemberRequest"},"maximum":100,"title":"Update Members","type":"array","x-stream-index":"004"}},"title":"UpdateCallMembersRequest","type":"object"},"UpdateCallMembersResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"002"}},"required":["duration","members"],"title":"Response","type":"object"},"UpdateCallRequest":{"description":"Request for updating a call","nullable":true,"properties":{"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"003"},"settings_override":{"$ref":"#/components/schemas/CallSettingsRequest","description":"the settings to change for this call","title":"Settings Override","x-stream-index":"004"},"starts_at":{"description":"the time the call is scheduled to start","format":"date-time","title":"Starts At","type":"number","x-stream-index":"005"}},"title":"UpdateCallRequest","type":"object"},"UpdateCallResponse":{"description":"Response for updating a call","nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001.001"},"duration":{"type":"string","x-stream-index":"002.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001.002"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"001.004"}},"required":["call","members","own_capabilities","blocked_users","duration"],"title":"UpdateCallResponse","type":"object"},"UpdateCallTypeRequest":{"description":"UpdateCallTypeRequest is the payload for updating a call type.","nullable":true,"properties":{"external_storage":{"type":"string","x-stream-index":"002.004"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"002.001"},"notification_settings":{"$ref":"#/components/schemas/NotificationSettings","x-stream-index":"002.002"},"settings":{"$ref":"#/components/schemas/CallSettingsRequest","x-stream-index":"002.003"}},"title":"UpdateCallTypeRequest","type":"object"},"UpdateCallTypeResponse":{"description":"UpdateCallTypeResponse is the payload for updating a call type.","nullable":true,"properties":{"created_at":{"description":"the time the call type was created","format":"date-time","title":"CreatedAt","type":"number","x-stream-index":"001.005"},"duration":{"type":"string","x-stream-index":"002.001"},"external_storage":{"description":"the external storage for the call type","title":"ExternalStorage","type":"string","x-stream-index":"001.007"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"the permissions granted to each role","title":"Grants","type":"object","x-stream-index":"001.002"},"name":{"description":"the name of the call type","title":"Name","type":"string","x-stream-index":"001.001"},"notification_settings":{"$ref":"#/components/schemas/NotificationSettings","description":"the notification settings for the call type","title":"NotificationSettings","x-stream-index":"001.004"},"settings":{"$ref":"#/components/schemas/CallSettingsResponse","description":"the settings for the call type","title":"Settings","x-stream-index":"001.003"},"updated_at":{"description":"the time the call type was last updated","format":"date-time","title":"UpdatedAt","type":"number","x-stream-index":"001.006"}},"required":["name","grants","settings","notification_settings","created_at","updated_at","duration"],"title":"UpdateCallTypeResponse","type":"object"},"UpdateChannelPartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"type":"object","x-stream-index":"002.001"},"unset":{"items":{"type":"string"},"type":"array","x-stream-index":"002.002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"title":"UpdateChannelPartialRequest","type":"object"},"UpdateChannelPartialResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Updated channel object","title":"Channel","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"members":{"description":"List of updated members","items":{"$ref":"#/components/schemas/ChannelMemberResponse"},"title":"ChannelMemberResponse","type":"array","x-stream-index":"002"}},"required":["members","duration"],"type":"object"},"UpdateChannelRequest":{"nullable":true,"properties":{"accept_invite":{"description":"Set to `true` to accept the invite","title":"Accept invite","type":"boolean","x-stream-index":"008"},"add_members":{"description":"List of user IDs to add to the channel","items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"title":"Add members","type":"array","x-stream-index":"001"},"add_moderators":{"description":"List of user IDs to make channel moderators","items":{"type":"string"},"maximum":100,"title":"Add moderators","type":"array","x-stream-index":"003"},"assign_roles":{"description":"List of channel member role assignments. If any specified user is not part of the channel, the request will fail","items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"title":"Assign roles","type":"array","x-stream-index":"006"},"cooldown":{"description":"Sets cool down period for the channel in seconds","format":"int32","maximum":120,"minimum":0,"title":"Cool down","type":"integer","x-stream-index":"007"},"data":{"$ref":"#/components/schemas/ChannelInput","x-stream-index":"013.001"},"demote_moderators":{"description":"List of user IDs to take away moderators status from","items":{"type":"string"},"maximum":100,"title":"Demote moderators","type":"array","x-stream-index":"004"},"hide_history":{"description":"Set to `true` to hide channel's history when adding new members","title":"Hide history","type":"boolean","x-stream-index":"012"},"invites":{"description":"List of user IDs to invite to the channel","items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"title":"Invites","type":"array","x-stream-index":"005"},"message":{"$ref":"#/components/schemas/MessageRequest","description":"Message to send to the chat when channel is successfully updated","title":"Message","x-stream-index":"010"},"reject_invite":{"description":"Set to `true` to reject the invite","title":"Reject invite","type":"boolean","x-stream-index":"009"},"remove_members":{"description":"List of user IDs to remove from the channel","items":{"type":"string"},"maximum":100,"title":"Remove members","type":"array","x-stream-index":"002"},"skip_push":{"description":"When `message` is set disables all push notifications for it","title":"Skip push","type":"boolean","x-stream-index":"011"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"014.002"},"user_id":{"type":"string","x-stream-index":"014.001"}},"title":"Channel update request","type":"object","x-stream-docs-page-id":"channel_update"},"UpdateChannelResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Updated channel","title":"Channel","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"004.001"},"members":{"description":"List of channel members","items":{"$ref":"#/components/schemas/ChannelMember"},"title":"Members","type":"array","x-stream-index":"003"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Message sent to the chat","title":"Message","x-stream-index":"002"}},"required":["members","duration"],"type":"object"},"UpdateChannelTypeRequest":{"nullable":true,"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"009.001.027"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"009.001.022"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"009.001.023"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"009.001.028"},"blocklist":{"type":"string","x-stream-index":"009.001.024"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"009.001.025"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"009.001.026"},"commands":{"description":"List of commands that channel supports","items":{"type":"string"},"title":"Commands","type":"array","x-stream-index":"009.003"},"connect_events":{"type":"boolean","x-stream-index":"009.001.004"},"count_messages":{"type":"boolean","x-stream-index":"009.001.019"},"custom_events":{"type":"boolean","x-stream-index":"009.001.012"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"004"},"mark_messages_pending":{"type":"boolean","x-stream-index":"009.001.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"009.001.021"},"mutes":{"type":"boolean","x-stream-index":"009.001.009"},"partition_size":{"format":"int32","minimum":0,"type":"integer","x-stream-index":"007"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"008"},"permissions":{"items":{"$ref":"#/components/schemas/PolicyRequest"},"type":"array","x-stream-index":"003"},"polls":{"type":"boolean","x-stream-index":"009.001.016"},"push_notifications":{"type":"boolean","x-stream-index":"009.001.013"},"quotes":{"type":"boolean","x-stream-index":"009.001.008"},"reactions":{"type":"boolean","x-stream-index":"009.001.006"},"read_events":{"type":"boolean","x-stream-index":"009.001.003"},"reminders":{"type":"boolean","x-stream-index":"009.001.014"},"replies":{"type":"boolean","x-stream-index":"009.001.007"},"search":{"type":"boolean","x-stream-index":"009.001.005"},"shared_locations":{"type":"boolean","x-stream-index":"009.001.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"009.001.031"},"typing_events":{"type":"boolean","x-stream-index":"009.001.002"},"uploads":{"type":"boolean","x-stream-index":"009.001.010"},"url_enrichment":{"type":"boolean","x-stream-index":"009.001.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"009.001.017"}},"required":["max_message_length","automod","automod_behavior"],"type":"object"},"UpdateChannelTypeResponse":{"nullable":true,"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"003.001.027"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"003.001.022"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.001.023"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"003.001.028"},"blocklist":{"type":"string","x-stream-index":"003.001.024"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.001.025"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"003.001.026"},"commands":{"items":{"type":"string"},"type":"array","x-stream-index":"003.003"},"connect_events":{"type":"boolean","x-stream-index":"003.001.004"},"count_messages":{"type":"boolean","x-stream-index":"003.001.019"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002.003"},"custom_events":{"type":"boolean","x-stream-index":"003.001.012"},"duration":{"type":"string","x-stream-index":"004.001"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"002"},"mark_messages_pending":{"type":"boolean","x-stream-index":"003.001.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"003.001.021"},"mutes":{"type":"boolean","x-stream-index":"003.001.009"},"name":{"type":"string","x-stream-index":"003.001.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"003.001.029"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"003.001.030"},"permissions":{"items":{"$ref":"#/components/schemas/PolicyRequest"},"type":"array","x-stream-index":"001"},"polls":{"type":"boolean","x-stream-index":"003.001.016"},"push_notifications":{"type":"boolean","x-stream-index":"003.001.013"},"quotes":{"type":"boolean","x-stream-index":"003.001.008"},"reactions":{"type":"boolean","x-stream-index":"003.001.006"},"read_events":{"type":"boolean","x-stream-index":"003.001.003"},"reminders":{"type":"boolean","x-stream-index":"003.001.014"},"replies":{"type":"boolean","x-stream-index":"003.001.007"},"search":{"type":"boolean","x-stream-index":"003.001.005"},"shared_locations":{"type":"boolean","x-stream-index":"003.001.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"003.001.031"},"typing_events":{"type":"boolean","x-stream-index":"003.001.002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"003.002.004"},"uploads":{"type":"boolean","x-stream-index":"003.001.010"},"url_enrichment":{"type":"boolean","x-stream-index":"003.001.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"003.001.017"}},"required":["permissions","grants","name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","count_messages","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","created_at","updated_at","commands","duration"],"type":"object"},"UpdateCommandRequest":{"nullable":true,"properties":{"args":{"description":"Arguments help text, shown in commands auto-completion","maxLength":255,"title":"Arguments","type":"string","x-stream-index":"003"},"description":{"description":"Description, shown in commands auto-completion","maxLength":255,"title":"Description","type":"string","x-stream-index":"002"},"set":{"description":"Set name used for grouping commands","maxLength":255,"title":"Set","type":"string","x-stream-index":"004"}},"required":["description"],"title":"UpdateCommandRequest","type":"object"},"UpdateCommandResponse":{"nullable":true,"properties":{"command":{"$ref":"#/components/schemas/Command","description":"Command object","title":"Command","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["duration"],"title":"UpdateCommandResponse","type":"object"},"UpdateCommentRequest":{"nullable":true,"properties":{"comment":{"description":"Updated text content of the comment","title":"Comment","type":"string","x-stream-index":"002"},"custom":{"additionalProperties":{},"description":"Updated custom data for the comment","title":"Custom Data","type":"object","x-stream-index":"003"},"skip_push":{"type":"boolean","x-stream-index":"004"}},"title":"Update Comment Request","type":"object"},"UpdateCommentResponse":{"nullable":true,"properties":{"comment":{"$ref":"#/components/schemas/CommentResponse","description":"The updated comment","title":"Comment","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["comment","duration"],"title":"Update Comment Response","type":"object"},"UpdateExternalStorageRequest":{"description":"External storage","nullable":true,"properties":{"aws_s3":{"$ref":"#/components/schemas/S3Request","description":"Only required if you want to create an Amazon S3 storage","title":"AwsS3","x-stream-index":"003.004"},"azure_blob":{"$ref":"#/components/schemas/AzureRequest","description":"Only required if you want to create an Azure Blob Storage","title":"AzureBlob","x-stream-index":"003.006"},"bucket":{"description":"The name of the bucket on the service provider","title":"Bucket","type":"string","x-stream-index":"003.002"},"gcs_credentials":{"type":"string","x-stream-index":"003.005"},"path":{"description":"The path prefix to use for storing files","title":"Path","type":"string","x-stream-index":"003.003"},"storage_type":{"description":"The type of storage to use","enum":["s3","gcs","abs"],"title":"StorageType","type":"string","x-stream-index":"003.001"}},"required":["storage_type","bucket"],"title":"ExternalStorageRequest","type":"object"},"UpdateExternalStorageResponse":{"description":"Basic response information","nullable":true,"properties":{"bucket":{"type":"string","x-stream-index":"001.003"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"name":{"type":"string","x-stream-index":"001.001"},"path":{"type":"string","x-stream-index":"001.004"},"type":{"enum":["s3","gcs","abs"],"type":"string","x-stream-index":"001.002"}},"required":["name","type","bucket","path","duration"],"title":"Response","type":"object"},"UpdateFeedGroupRequest":{"nullable":true,"properties":{"activity_processors":{"description":"Configuration for activity processors (max 10)","items":{"$ref":"#/components/schemas/ActivityProcessorConfig"},"maximum":10,"title":"Activity Processors","type":"array","x-stream-index":"005"},"activity_selectors":{"description":"Configuration for activity selectors (max 10)","items":{"$ref":"#/components/schemas/ActivitySelectorConfig"},"maximum":10,"title":"Activity Selectors","type":"array","x-stream-index":"006"},"aggregation":{"$ref":"#/components/schemas/AggregationConfig","description":"Configuration for activity aggregation","title":"Aggregation","x-stream-index":"008"},"custom":{"additionalProperties":{},"description":"Custom data for the feed group","title":"Custom Data","type":"object","x-stream-index":"004"},"notification":{"$ref":"#/components/schemas/NotificationConfig","description":"Configuration for notifications","title":"Notification","x-stream-index":"002"},"push_notification":{"$ref":"#/components/schemas/PushNotificationConfig","x-stream-index":"003"},"ranking":{"$ref":"#/components/schemas/RankingConfig","description":"Configuration for activity ranking","title":"Ranking","x-stream-index":"007"}},"title":"Update Feed Group Request","type":"object"},"UpdateFeedGroupResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"feed_group":{"$ref":"#/components/schemas/FeedGroupResponse","description":"The updated feed group","title":"Feed Group","x-stream-index":"001"}},"required":["feed_group","duration"],"title":"Update Feed Group Response","type":"object"},"UpdateFeedMembersRequest":{"nullable":true,"properties":{"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"006.001"},"members":{"description":"List of members to upsert, remove, or set","items":{"$ref":"#/components/schemas/FeedMemberRequest"},"title":"Members","type":"array","x-stream-index":"004"},"next":{"type":"string","x-stream-index":"006.002"},"operation":{"description":"Type of update operation to perform","enum":["upsert","remove","set"],"title":"Operation","type":"string","x-stream-index":"003"},"prev":{"type":"string","x-stream-index":"006.003"}},"required":["operation"],"title":"Update Feed Members Request","type":"object"},"UpdateFeedMembersResponse":{"description":"Basic response information","nullable":true,"properties":{"added":{"items":{"$ref":"#/components/schemas/FeedMemberResponse"},"type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"004.001"},"removed_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"updated":{"items":{"$ref":"#/components/schemas/FeedMemberResponse"},"type":"array","x-stream-index":"002"}},"required":["added","updated","removed_ids","duration"],"title":"Response","type":"object"},"UpdateFeedRequest":{"nullable":true,"properties":{"created_by_id":{"description":"ID of the new feed creator (owner)","title":"Created By ID","type":"string","x-stream-index":"003"},"custom":{"additionalProperties":{},"description":"Custom data for the feed","title":"Custom Data","type":"object","x-stream-index":"004"}},"title":"Update Feed Request","type":"object"},"UpdateFeedResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"feed":{"$ref":"#/components/schemas/FeedResponse","description":"The updated feed","title":"Feed","x-stream-index":"001"}},"required":["feed","duration"],"title":"Update Feed Response","type":"object"},"UpdateFeedViewRequest":{"nullable":true,"properties":{"activity_processors":{"description":"Updated activity processors","items":{"$ref":"#/components/schemas/ActivityProcessorConfig"},"title":"Activity Processors","type":"array","x-stream-index":"002.002"},"activity_selectors":{"description":"Updated configuration for selecting activities","items":{"$ref":"#/components/schemas/ActivitySelectorConfig"},"title":"Activity Selectors","type":"array","x-stream-index":"002.001"},"aggregation":{"$ref":"#/components/schemas/AggregationConfig","description":"Updated configuration for aggregating activities","title":"Aggregation","x-stream-index":"002.004"},"ranking":{"$ref":"#/components/schemas/RankingConfig","description":"Updated configuration for ranking activities","title":"Ranking","x-stream-index":"002.003"}},"title":"Update Feed View Request","type":"object"},"UpdateFeedViewResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"feed_view":{"$ref":"#/components/schemas/FeedViewResponse","description":"The updated feed view","title":"Feed View","x-stream-index":"001"}},"required":["feed_view","duration"],"title":"Update Feed View Response","type":"object"},"UpdateFollowRequest":{"nullable":true,"properties":{"create_notification_activity":{"description":"Whether to create a notification activity for this follow","title":"Create Notification Activity","type":"boolean","x-stream-index":"001.004"},"custom":{"additionalProperties":{},"description":"Custom data for the follow relationship","title":"Custom Data","type":"object","x-stream-index":"001.002"},"follower_role":{"type":"string","x-stream-index":"002"},"push_preference":{"description":"Push preference for the follow relationship","enum":["all","none"],"title":"Push Preference","type":"string","x-stream-index":"001.003"},"skip_push":{"type":"boolean","x-stream-index":"001.005"},"source":{"description":"Fully qualified ID of the source feed","maxLength":255,"title":"Source Feed","type":"string","x-stream-index":"001.001.001"},"target":{"description":"Fully qualified ID of the target feed","maxLength":255,"title":"Target Feed","type":"string","x-stream-index":"001.001.002"}},"required":["source","target"],"title":"Update Follow Request","type":"object"},"UpdateFollowResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"follow":{"$ref":"#/components/schemas/FollowResponse","description":"Details of the updated follow relationship","title":"Follow","x-stream-index":"001"}},"required":["follow","duration"],"title":"Update Follow Response","type":"object"},"UpdateLiveLocationRequest":{"nullable":true,"properties":{"end_at":{"description":"Time when the live location expires","format":"date-time","title":"string","type":"number","x-stream-index":"004"},"latitude":{"description":"Latitude coordinate","format":"float","maximum":90,"minimum":18446744073709552000,"title":"number","type":"number","x-stream-index":"002"},"longitude":{"description":"Longitude coordinate","format":"float","maximum":180,"minimum":18446744073709552000,"title":"number","type":"number","x-stream-index":"003"},"message_id":{"description":"Live location ID","title":"string","type":"string","x-stream-index":"001"}},"required":["message_id"],"type":"object"},"UpdateMemberPartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"type":"object","x-stream-index":"002.001"},"unset":{"items":{"type":"string"},"type":"array","x-stream-index":"002.002"}},"type":"object"},"UpdateMemberPartialResponse":{"nullable":true,"properties":{"channel_member":{"$ref":"#/components/schemas/ChannelMemberResponse","description":"Updated channel member","title":"Channel member","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["duration"],"type":"object"},"UpdateMembershipLevelRequest":{"description":"Partial update request for membership level fields. Only specified fields will be updated.","nullable":true,"properties":{"custom":{"additionalProperties":{},"description":"Custom data for the membership level","title":"Custom Data","type":"object","x-stream-index":"006"},"description":{"description":"Optional description of the membership level","maxLength":1000,"title":"Description","type":"string","x-stream-index":"003"},"name":{"description":"Display name for the membership level","maxLength":255,"title":"Name","type":"string","x-stream-index":"002"},"priority":{"description":"Priority level (higher numbers = higher priority)","format":"int32","minimum":0,"title":"Priority","type":"integer","x-stream-index":"004"},"tags":{"description":"Activity tags this membership level gives access to","items":{"type":"string"},"maximum":255,"title":"Tags","type":"array","x-stream-index":"005"}},"title":"Update Membership Level Request","type":"object"},"UpdateMembershipLevelResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"membership_level":{"$ref":"#/components/schemas/MembershipLevelResponse","description":"The updated membership level","title":"Membership Level","x-stream-index":"001"}},"required":["membership_level","duration"],"title":"Update Membership Level Response","type":"object"},"UpdateMessagePartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"description":"Sets new field values","title":"Set","type":"object","x-stream-index":"002.001","x-stream-map":{"key":"field","title":"Value","description":"New value to set"}},"skip_enrich_url":{"description":"Skip enriching the URL in the message","title":"SkipEnrichURL","type":"boolean","x-stream-index":"001"},"unset":{"description":"Array of field names to unset","items":{"type":"string"},"title":"Unset","type":"array","x-stream-index":"002.002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"type":"object"},"UpdateMessagePartialResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Updated message","title":"Message","x-stream-index":"001"},"pending_message_metadata":{"additionalProperties":{"type":"string"},"description":"Pending message metadata","title":"PendingMessageMetadata","type":"object","x-stream-index":"002"}},"required":["duration"],"type":"object"},"UpdateMessageRequest":{"nullable":true,"properties":{"message":{"$ref":"#/components/schemas/MessageRequest","description":"Message","title":"MessageRequest","x-stream-index":"001"},"skip_enrich_url":{"description":"Skip enrich URL","title":"boolean","type":"boolean","x-stream-index":"003"},"skip_push":{"type":"boolean","x-stream-index":"002"}},"required":["message"],"type":"object"},"UpdateMessageResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001"},"pending_message_metadata":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"002"}},"required":["message","duration"],"title":"Response","type":"object"},"UpdatePollOptionRequest":{"nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"004"},"id":{"description":"Option ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"},"text":{"description":"Option text","title":"string","type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"005.002"},"user_id":{"type":"string","x-stream-index":"005.001"}},"required":["id","text"],"type":"object"},"UpdatePollPartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"description":"Sets new field values","title":"Set","type":"object","x-stream-index":"002.001","x-stream-map":{"key":"field","title":"Value","description":"New value to set"}},"unset":{"description":"Array of field names to unset","items":{"type":"string"},"title":"Unset","type":"array","x-stream-index":"002.002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"type":"object"},"UpdatePollRequest":{"nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"011"},"allow_answers":{"description":"Allow answers","title":"boolean","type":"boolean","x-stream-index":"009"},"allow_user_suggested_options":{"description":"Allow user suggested options","title":"boolean","type":"boolean","x-stream-index":"008"},"description":{"description":"Poll description","title":"string","type":"string","x-stream-index":"003"},"enforce_unique_vote":{"description":"Enforce unique vote","title":"boolean","type":"boolean","x-stream-index":"005"},"id":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"},"is_closed":{"description":"Is closed","title":"boolean","type":"boolean","x-stream-index":"010"},"max_votes_allowed":{"description":"Max votes allowed","format":"int32","maximum":10,"title":"integer","type":"integer","x-stream-index":"007"},"name":{"description":"Poll name","title":"string","type":"string","x-stream-index":"002"},"options":{"description":"Poll options","items":{"$ref":"#/components/schemas/PollOptionRequest"},"maximum":100,"title":"PollOptions","type":"array","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"012.002"},"user_id":{"type":"string","x-stream-index":"012.001"},"voting_visibility":{"description":"Voting visibility","enum":["anonymous","public"],"title":"string","type":"string","x-stream-index":"006"}},"required":["id","name"],"type":"object"},"UpdateReminderRequest":{"nullable":true,"properties":{"remind_at":{"format":"date-time","type":"number","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"type":"object"},"UpdateReminderResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"001"}},"required":["reminder","duration"],"title":"Response","type":"object"},"UpdateThreadPartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"description":"Sets new field values","title":"Set","type":"object","x-stream-index":"004.001","x-stream-map":{"key":"field","title":"Value","description":"New value to set"}},"unset":{"description":"Array of field names to unset","items":{"type":"string"},"title":"Unset","type":"array","x-stream-index":"004.002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"type":"object"},"UpdateThreadPartialResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"thread":{"$ref":"#/components/schemas/ThreadResponse","description":"Updated thread (not enriched)","title":"Thread","x-stream-index":"001"}},"required":["thread","duration"],"type":"object"},"UpdateUserPartialRequest":{"properties":{"id":{"description":"User ID to update","title":"ID","type":"string","x-stream-index":"001"},"set":{"additionalProperties":{},"type":"object","x-stream-index":"002.001"},"unset":{"items":{"type":"string"},"type":"array","x-stream-index":"002.002"}},"required":["id"],"type":"object"},"UpdateUserPermissionsRequest":{"nullable":true,"properties":{"grant_permissions":{"items":{"type":"string"},"type":"array","x-stream-index":"002"},"revoke_permissions":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"user_id":{"type":"string","x-stream-index":"001"}},"required":["user_id"],"type":"object"},"UpdateUserPermissionsResponse":{"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"},"UpdateUsersPartialRequest":{"nullable":true,"properties":{"users":{"items":{"$ref":"#/components/schemas/UpdateUserPartialRequest"},"maximum":100,"type":"array","x-stream-index":"001"}},"required":["users"],"type":"object"},"UpdateUsersRequest":{"nullable":true,"properties":{"users":{"additionalProperties":{"$ref":"#/components/schemas/UserRequest"},"description":"Object containing users","title":"Users","type":"object","x-stream-index":"001","x-stream-map":{"key":"user_id"}}},"required":["users"],"type":"object"},"UpdateUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"membership_deletion_task_id":{"type":"string","x-stream-index":"002"},"users":{"additionalProperties":{"$ref":"#/components/schemas/FullUserResponse"},"description":"Object containing users","title":"Users","type":"object","x-stream-index":"001","x-stream-map":{"key":"user_id"}}},"required":["users","membership_deletion_task_id","duration"],"type":"object"},"UpdatedCallPermissionsEvent":{"description":"This event is sent to notify about permission changes for a user, clients receiving this event should update their UI accordingly","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"own_capabilities":{"description":"The capabilities of the current user","items":{"$ref":"#/components/schemas/OwnCapability"},"title":"Own capabilities","type":"array","x-stream-index":"004"},"type":{"default":"call.permissions_updated","description":"The type of event: \"call.permissions_updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who received the new permissions","title":"User","x-stream-index":"003"}},"required":["type","created_at","call_cid","user","own_capabilities"],"title":"UpdatedCallPermissionsEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"UpsertActivitiesRequest":{"nullable":true,"properties":{"activities":{"description":"List of activities to create or update","items":{"$ref":"#/components/schemas/ActivityRequest"},"maximum":100,"minimum":1,"title":"Activities","type":"array","x-stream-index":"001"}},"required":["activities"],"title":"Upsert Activities Request","type":"object"},"UpsertActivitiesResponse":{"nullable":true,"properties":{"activities":{"description":"List of created or updated activities","items":{"$ref":"#/components/schemas/ActivityResponse"},"title":"Activities","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["activities","duration"],"title":"Upsert Activities Response","type":"object"},"UpsertConfigRequest":{"nullable":true,"properties":{"ai_image_config":{"$ref":"#/components/schemas/AIImageConfig","description":"Configuration for AI image analysis","title":"AI Image Config","x-stream-index":"011"},"ai_text_config":{"$ref":"#/components/schemas/AITextConfig","description":"Configuration for AI text analysis","title":"AI Text Config","x-stream-index":"008"},"ai_video_config":{"$ref":"#/components/schemas/AIVideoConfig","description":"Configuration for AI video analysis","title":"AI Video Config","x-stream-index":"012"},"async":{"description":"Whether moderation should be performed asynchronously","title":"Async","type":"boolean","x-stream-index":"003"},"automod_platform_circumvention_config":{"$ref":"#/components/schemas/AutomodPlatformCircumventionConfig","description":"Configuration for platform circumvention detection","title":"Automod Platform Circumvention Config","x-stream-index":"005"},"automod_semantic_filters_config":{"$ref":"#/components/schemas/AutomodSemanticFiltersConfig","description":"Configuration for semantic filtering","title":"Automod Semantic Filters Config","x-stream-index":"006"},"automod_toxicity_config":{"$ref":"#/components/schemas/AutomodToxicityConfig","description":"Configuration for toxicity detection","title":"Automod Toxicity Config","x-stream-index":"004"},"aws_rekognition_config":{"$ref":"#/components/schemas/AIImageConfig","x-stream-index":"016"},"block_list_config":{"$ref":"#/components/schemas/BlockListConfig","description":"Configuration for block list filtering","title":"Block List Config","x-stream-index":"007"},"bodyguard_config":{"$ref":"#/components/schemas/AITextConfig","x-stream-index":"015"},"google_vision_config":{"$ref":"#/components/schemas/GoogleVisionConfig","description":"Configuration for Google Vision integration","title":"Google Vision Config","x-stream-index":"010"},"key":{"description":"Unique identifier for the moderation configuration","title":"Key","type":"string","x-stream-index":"001"},"llm_config":{"$ref":"#/components/schemas/LLMConfig","description":"Configuration for customer-configured LLM moderation","title":"LLM Config","x-stream-index":"009"},"rule_builder_config":{"$ref":"#/components/schemas/RuleBuilderConfig","description":"Configuration for custom rule builder (max 3 rules, max 5 conditions per rule)","title":"Rule Builder Config","x-stream-index":"014"},"team":{"description":"Team associated with the configuration","maxLength":128,"minLength":1,"title":"Team","type":"string","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"018.002"},"user_id":{"type":"string","x-stream-index":"018.001"},"velocity_filter_config":{"$ref":"#/components/schemas/VelocityFilterConfig","description":"Configuration for velocity-based filtering","title":"Velocity Filter Config","x-stream-index":"013"},"video_call_rule_config":{"$ref":"#/components/schemas/VideoCallRuleConfig","x-stream-index":"017"}},"required":["key"],"type":"object"},"UpsertConfigResponse":{"nullable":true,"properties":{"config":{"$ref":"#/components/schemas/ConfigResponse","description":"The created or updated moderation configuration","title":"Config","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["duration"],"type":"object"},"UpsertModerationRuleRequest":{"nullable":true,"properties":{"action":{"$ref":"#/components/schemas/RuleBuilderAction","x-stream-index":"009"},"conditions":{"items":{"$ref":"#/components/schemas/RuleBuilderCondition"},"type":"array","x-stream-index":"006"},"config_keys":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"cooldown_period":{"type":"string","x-stream-index":"010"},"description":{"type":"string","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"011"},"groups":{"items":{"$ref":"#/components/schemas/RuleBuilderConditionGroup"},"type":"array","x-stream-index":"008"},"logic":{"type":"string","x-stream-index":"007"},"name":{"type":"string","x-stream-index":"001"},"rule_type":{"type":"string","x-stream-index":"005"},"team":{"type":"string","x-stream-index":"004"}},"required":["name","rule_type","action"],"type":"object"},"UpsertModerationRuleResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"rule":{"$ref":"#/components/schemas/ModerationRuleV2Response","x-stream-index":"002"}},"required":["duration"],"title":"Response","type":"object"},"UpsertModerationTemplateRequest":{"nullable":true,"properties":{"config":{"$ref":"#/components/schemas/FeedsModerationTemplateConfig","description":"Configuration for the moderation template","title":"Config","x-stream-index":"002"},"name":{"description":"Name of the moderation template","title":"Name","type":"string","x-stream-index":"001"}},"required":["name","config"],"type":"object"},"UpsertModerationTemplateResponse":{"nullable":true,"properties":{"config":{"$ref":"#/components/schemas/FeedsModerationTemplateConfig","description":"Configuration for the moderation template","title":"Config","x-stream-index":"002"},"created_at":{"description":"When the template was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"003"},"duration":{"type":"string","x-stream-index":"005.001"},"name":{"description":"Name of the moderation template","title":"Name","type":"string","x-stream-index":"001"},"updated_at":{"description":"When the template was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"004"}},"required":["name","created_at","updated_at","duration"],"type":"object"},"UpsertPushPreferencesRequest":{"nullable":true,"properties":{"preferences":{"description":"A list of push preferences for channels, calls, or the user.","items":{"$ref":"#/components/schemas/PushPreferenceInput"},"type":"array","x-stream-index":"001"}},"required":["preferences"],"type":"object"},"UpsertPushPreferencesResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"user_channel_preferences":{"additionalProperties":{"additionalProperties":{"$ref":"#/components/schemas/ChannelPushPreferences"},"type":"object"},"description":"The channel specific push notification preferences, only returned for channels you've edited.","title":"User Channel Notification Preferences","type":"object","x-stream-index":"002"},"user_preferences":{"additionalProperties":{"$ref":"#/components/schemas/PushPreferences"},"description":"The user preferences, always returned regardless if you edited it","title":"User Preferences","type":"object","x-stream-index":"001"}},"required":["user_preferences","user_channel_preferences","duration"],"type":"object"},"UpsertPushProviderRequest":{"nullable":true,"properties":{"push_provider":{"$ref":"#/components/schemas/PushProvider","x-stream-index":"001"}},"type":"object"},"UpsertPushProviderResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"push_provider":{"$ref":"#/components/schemas/PushProviderResponse","x-stream-index":"001"}},"required":["push_provider","duration"],"title":"Response","type":"object"},"UpsertPushTemplateRequest":{"nullable":true,"properties":{"enable_push":{"description":"Whether to send push notification for this event","title":"boolean","type":"boolean","x-stream-index":"002"},"event_type":{"description":"Event type (message.new, message.updated, reaction.new)","enum":["message.new","message.updated","reaction.new","notification.reminder_due","feeds.activity.added","feeds.comment.added","feeds.activity.reaction.added","feeds.comment.reaction.added","feeds.follow.created","feeds.notification_feed.updated"],"title":"string","type":"string","x-stream-index":"003"},"push_provider_name":{"description":"Push provider name","title":"string","type":"string","x-stream-index":"004"},"push_provider_type":{"description":"Push provider type (firebase, apn)","enum":["firebase","apn"],"title":"string","type":"string","x-stream-index":"005"},"template":{"description":"Push template","title":"string","type":"string","x-stream-index":"006"}},"required":["event_type","push_provider_type"],"type":"object"},"UpsertPushTemplateResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"template":{"$ref":"#/components/schemas/PushTemplate","x-stream-index":"002"}},"required":["duration"],"title":"Response","type":"object"},"User":{"properties":{"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"046"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"017"},"banned":{"type":"boolean","x-stream-index":"016"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"013"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"023"},"language":{"type":"string","x-stream-index":"035"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"026"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"042"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"005"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"009"}},"required":["id","role","teams_role","custom","banned","online"],"type":"object"},"UserBannedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"006.002"},"channel_type":{"type":"string","x-stream-index":"006.003"},"cid":{"type":"string","x-stream-index":"006.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008.002"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"001"},"expiration":{"format":"date-time","type":"number","x-stream-index":"003"},"reason":{"type":"string","x-stream-index":"004"},"shadow":{"type":"boolean","x-stream-index":"002"},"team":{"type":"string","x-stream-index":"005.001"},"type":{"default":"user.banned","type":"string","x-stream-index":"008.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007.001"}},"required":["created_by","shadow","cid","channel_id","channel_type","type","created_at"],"title":"UserBannedEvent","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"},"UserCreatedWithinParameters":{"properties":{"max_age":{"type":"string","x-stream-index":"001"}},"type":"object"},"UserCustomEventRequest":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"001"}},"required":["type"],"type":"object"},"UserCustomPropertyParameters":{"properties":{"operator":{"type":"string","x-stream-index":"002"},"property_key":{"type":"string","x-stream-index":"001"}},"type":"object"},"UserDeactivatedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"001"},"type":{"default":"user.deactivated","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["created_by","type","created_at"],"title":"UserDeactivatedEvent","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"},"UserDeletedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"delete_conversation_channels":{"type":"boolean","x-stream-index":"005"},"hard_delete":{"type":"boolean","x-stream-index":"003.001"},"mark_messages_deleted":{"type":"boolean","x-stream-index":"004"},"type":{"default":"user.deleted","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"001.001"}},"required":["type","created_at","hard_delete","mark_messages_deleted","delete_conversation_channels"],"title":"UserDeletedEvent","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"},"UserFeedbackReport":{"properties":{"count_by_rating":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001"},"unreported_count":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["count_by_rating","unreported_count"],"type":"object"},"UserFeedbackReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateUserFeedbackReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"UserFeedbackResponse":{"properties":{"cid":{"type":"string","x-stream-index":"001"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"009"},"platform":{"$ref":"#/components/schemas/PlatformDataResponse","x-stream-index":"008"},"rating":{"format":"int32","type":"integer","x-stream-index":"004"},"reason":{"type":"string","x-stream-index":"005"},"sdk":{"type":"string","x-stream-index":"006"},"sdk_version":{"type":"string","x-stream-index":"007"},"session_id":{"type":"string","x-stream-index":"002"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["cid","session_id","user_id","rating","reason","sdk","sdk_version","platform"],"type":"object"},"UserFlaggedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"target_user":{"type":"string","x-stream-index":"002"},"target_users":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"type":{"default":"user.flagged","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"001"}},"required":["type","created_at"],"title":"UserFlaggedEvent","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"},"UserMessagesDeletedEvent":{"description":"This event is sent when a user's message get deleted. The event contains information about the user whose messages got deleted.","nullable":true,"properties":{"channel_custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.005"},"channel_id":{"description":"The ID of the channel where the target user's messages were deleted","title":"Channel ID","type":"string","x-stream-index":"001.002.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"001.001.004"},"channel_type":{"description":"The type of the channel where the target user's messages were deleted","title":"Channel Type","type":"string","x-stream-index":"001.002.001"},"cid":{"description":"The CID of the channel where the target user's messages were deleted","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":"number","x-stream-index":"001.001.001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.001.001.007"},"hard_delete":{"description":"Whether Messages were hard deleted","title":"Hard Delete","type":"boolean","x-stream-index":"003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.001.001.004"},"team":{"description":"The team of the channel where the target user's messages were deleted","title":"Team","type":"string","x-stream-index":"001.001.003"},"type":{"default":"user.messages.deleted","description":"The type of event: \"user.messages.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.001.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The target user whose messages got deleted","title":"User","x-stream-index":"002.001"}},"required":["type","created_at","custom","user"],"title":"UserMessagesDeletedEvent","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"},"UserMute":{"nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"expires":{"description":"Date/time of mute expiration","format":"date-time","title":"Expires","type":"number","x-stream-index":"008"},"target":{"$ref":"#/components/schemas/User","description":"User who's muted","title":"Target","x-stream-index":"007"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/User","description":"Owner of channel mute","title":"User","x-stream-index":"005"}},"required":["created_at","updated_at"],"type":"object"},"UserMuteResponse":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"expires":{"format":"date-time","type":"number","x-stream-index":"003"},"target":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"}},"required":["created_at","updated_at"],"type":"object"},"UserMutedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"target_user":{"type":"string","x-stream-index":"001"},"target_users":{"items":{"type":"string"},"type":"array","x-stream-index":"002"},"type":{"default":"user.muted","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"UserMutedEvent","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"},"UserRatingReportResponse":{"properties":{"average":{"format":"float","type":"number","x-stream-index":"002"},"count":{"format":"int32","type":"integer","x-stream-index":"001"}},"required":["count","average"],"type":"object"},"UserReactivatedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"type":{"default":"user.reactivated","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"001"}},"required":["type","created_at"],"title":"UserReactivatedEvent","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"},"UserRequest":{"description":"User request object","properties":{"custom":{"additionalProperties":{},"description":"Custom user data","title":"Custom","type":"object","x-stream-index":"004"},"id":{"description":"User ID","title":"ID","type":"string","x-stream-index":"001"},"image":{"description":"User's profile image URL","title":"Image","type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"006"},"language":{"type":"string","x-stream-index":"005"},"name":{"description":"Optional name of user","title":"Name","type":"string","x-stream-index":"002"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"007"},"role":{"description":"User's global role","title":"Role","type":"string","x-stream-index":"008"},"teams":{"description":"List of teams the user belongs to","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"010"},"teams_role":{"additionalProperties":{"type":"string"},"description":"Map of team-specific roles for the user","title":"TeamsRole","type":"object","x-stream-index":"009"}},"required":["id"],"title":"UserRequest","type":"object"},"UserResponse":{"description":"User response object","properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"ban_expires":{"description":"Date when ban expires","format":"date-time","title":"Ban expires","type":"number","x-stream-index":"003"},"banned":{"description":"Whether a user is banned or not","title":"Banned","type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.017"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"001.004"},"deactivated_at":{"description":"Date of deactivation","format":"date-time","title":"Deactivated at","type":"number","x-stream-index":"001.016"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"001.011"},"devices":{"description":"List of devices user is using","items":{"$ref":"#/components/schemas/DeviceResponse"},"title":"Devices","type":"array","x-stream-index":"006"},"id":{"description":"Unique user identifier","title":"ID","type":"string","x-stream-index":"001.001"},"image":{"title":"Image","type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"007"},"language":{"description":"Preferred language of a user","title":"Language","type":"string","x-stream-index":"001.005"},"last_active":{"description":"Date of last activity","format":"date-time","title":"Last active","type":"number","x-stream-index":"001.014"},"name":{"description":"Optional name of user","title":"Name","type":"string","x-stream-index":"001.002"},"online":{"description":"Whether a user online or not","title":"Online","type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","description":"User privacy settings","title":"Privacy settings","x-stream-index":"005"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettingsResponse","description":"User push notification settings","title":"Push notifications","x-stream-index":"004"},"revoke_tokens_issued_before":{"description":"Revocation date for tokens","format":"date-time","title":"Revoke tokens issued before","type":"number","x-stream-index":"001.015"},"role":{"description":"Determines the set of user permissions","title":"Role","type":"string","x-stream-index":"001.006"},"shadow_banned":{"description":"Whether a user is shadow banned","title":"Shadow banned","type":"boolean","x-stream-index":"002"},"teams":{"description":"List of teams user is a part of","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids","shadow_banned","invisible"],"title":"UserResponse","type":"object"},"UserResponseCommonFields":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"018"},"banned":{"type":"boolean","x-stream-index":"012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"017"},"created_at":{"format":"date-time","type":"number","x-stream-index":"009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"id":{"type":"string","x-stream-index":"001"},"image":{"type":"string","x-stream-index":"003"},"language":{"type":"string","x-stream-index":"005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"014"},"name":{"type":"string","x-stream-index":"002"},"online":{"type":"boolean","x-stream-index":"013"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"015"},"role":{"type":"string","x-stream-index":"006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids"],"type":"object"},"UserResponsePrivacyFields":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"banned":{"type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.017"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.011"},"id":{"type":"string","x-stream-index":"001.001"},"image":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"003"},"language":{"type":"string","x-stream-index":"001.005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"001.014"},"name":{"type":"string","x-stream-index":"001.002"},"online":{"type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"002"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.015"},"role":{"type":"string","x-stream-index":"001.006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids"],"type":"object"},"UserRuleParameters":{"properties":{"max_age":{"type":"string","x-stream-index":"001"}},"type":"object"},"UserUnbannedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"005.002"},"shadow":{"type":"boolean","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"004.001"},"type":{"default":"user.unbanned","type":"string","x-stream-index":"005.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["shadow","cid","channel_id","channel_type","type","created_at"],"title":"UserUnbannedEvent","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"},"UserUnmutedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"target_user":{"type":"string","x-stream-index":"002"},"target_users":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"type":{"default":"user.unmuted","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"001"}},"required":["type","created_at"],"title":"UserUnmutedEvent","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"},"UserUnreadReminderEvent":{"properties":{"channels":{"additionalProperties":{"$ref":"#/components/schemas/ChannelMessages"},"type":"object","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"user.unread_message_reminder","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002"}},"required":["type","created_at","channels"],"title":"UserUnreadReminderEvent","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"},"UserUpdatedEvent":{"description":"This event is sent when a user gets updated. The event contains information about the updated user.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"type":{"default":"user.updated","description":"The type of event: \"user.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.002"},"user":{"$ref":"#/components/schemas/UserResponsePrivacyFields","description":"The updated user","title":"User","x-stream-index":"002.001"}},"required":["type","created_at","custom","user"],"title":"UserUpdatedEvent","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"},"VelocityFilterConfig":{"properties":{"advanced_filters":{"type":"boolean","x-stream-index":"007"},"async":{"type":"boolean","x-stream-index":"001"},"cascading_actions":{"type":"boolean","x-stream-index":"004"},"cids_per_user":{"format":"int32","type":"integer","x-stream-index":"006"},"enabled":{"type":"boolean","x-stream-index":"002"},"first_message_only":{"type":"boolean","x-stream-index":"005"},"rules":{"items":{"$ref":"#/components/schemas/VelocityFilterConfigRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules","cascading_actions","first_message_only","cids_per_user","advanced_filters"],"type":"object"},"VelocityFilterConfigRule":{"properties":{"action":{"enum":["flag","shadow","remove","ban"],"type":"string","x-stream-index":"001"},"ban_duration":{"format":"int32","type":"integer","x-stream-index":"002"},"cascading_action":{"enum":["flag","shadow","remove","ban"],"type":"string","x-stream-index":"006"},"cascading_threshold":{"format":"int64","type":"integer","x-stream-index":"005"},"check_message_context":{"type":"boolean","x-stream-index":"009"},"fast_spam_threshold":{"format":"int32","type":"integer","x-stream-index":"007"},"fast_spam_ttl":{"format":"int32","type":"integer","x-stream-index":"010"},"ip_ban":{"type":"boolean","x-stream-index":"004"},"probation_period":{"format":"int32","type":"integer","x-stream-index":"014"},"shadow_ban":{"type":"boolean","x-stream-index":"003"},"slow_spam_ban_duration":{"format":"int32","type":"integer","x-stream-index":"012"},"slow_spam_threshold":{"format":"int32","type":"integer","x-stream-index":"008"},"slow_spam_ttl":{"format":"int32","type":"integer","x-stream-index":"011"},"url_only":{"type":"boolean","x-stream-index":"013"}},"required":["action","ban_duration","shadow_ban","ip_ban","cascading_threshold","cascading_action","fast_spam_threshold","slow_spam_threshold","check_message_context","fast_spam_ttl","slow_spam_ttl","url_only","probation_period"],"type":"object"},"VideoCallRuleConfig":{"properties":{"rules":{"additionalProperties":{"$ref":"#/components/schemas/HarmConfig"},"type":"object","x-stream-index":"001"}},"required":["rules"],"type":"object"},"VideoContentParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"type":"object"},"VideoEndCallRequest":{"type":"object"},"VideoKickUserRequest":{"type":"object"},"VideoOrientation":{"properties":{"orientation":{"type":"integer","x-stream-index":"004"}},"type":"object"},"VideoReactionOverTimeResponse":{"properties":{"by_minute":{"items":{"$ref":"#/components/schemas/CountByMinuteResponse"},"type":"array","x-stream-index":"001"}},"type":"object"},"VideoReactionsResponse":{"nullable":true,"properties":{"count_over_time":{"$ref":"#/components/schemas/VideoReactionOverTimeResponse","x-stream-index":"002"},"reaction":{"type":"string","x-stream-index":"001"}},"required":["reaction"],"type":"object"},"VideoRuleParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"type":"object"},"VideoSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"camera_default_on":{"type":"boolean","x-stream-index":"004"},"camera_facing":{"enum":["front","back","external"],"type":"string","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled","target_resolution","camera_default_on","camera_facing"],"type":"object"},"VideoSettingsRequest":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"camera_default_on":{"type":"boolean","x-stream-index":"004"},"camera_facing":{"enum":["front","back","external"],"type":"string","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"type":"object"},"VideoSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"camera_default_on":{"type":"boolean","x-stream-index":"004"},"camera_facing":{"enum":["front","back","external"],"type":"string","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled","target_resolution","camera_default_on","camera_facing"],"type":"object"},"VoteData":{"properties":{"answer_text":{"type":"string","x-stream-index":"002"},"option_id":{"maxLength":255,"type":"string","x-stream-index":"001"}},"type":"object"},"WSEvent":{"description":"Represents an BaseEvent that happened in Stream Chat","properties":{"automoderation":{"type":"boolean","x-stream-index":"023"},"automoderation_scores":{"$ref":"#/components/schemas/ModerationResponse","x-stream-index":"024"},"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"011"},"channel_id":{"type":"string","x-stream-index":"004"},"channel_last_message_at":{"format":"date-time","type":"number","x-stream-index":"007"},"channel_type":{"type":"string","x-stream-index":"005"},"cid":{"type":"string","x-stream-index":"003"},"connection_id":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"028"},"created_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"022"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"027"},"me":{"$ref":"#/components/schemas/OwnUserResponse","x-stream-index":"019"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"014"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"008"},"message_update":{"$ref":"#/components/schemas/MessageUpdate","x-stream-index":"009"},"parent_id":{"type":"string","x-stream-index":"025"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"015"},"poll_vote":{"$ref":"#/components/schemas/PollVoteResponseData","x-stream-index":"016"},"reaction":{"$ref":"#/components/schemas/ReactionResponse","x-stream-index":"010"},"reason":{"type":"string","x-stream-index":"021"},"team":{"type":"string","x-stream-index":"026"},"thread":{"$ref":"#/components/schemas/ThreadResponse","x-stream-index":"013"},"thread_id":{"type":"string","x-stream-index":"012"},"type":{"type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"017"},"user_id":{"type":"string","x-stream-index":"018"},"watcher_count":{"format":"int32","type":"integer","x-stream-index":"020"}},"required":["type","custom","created_at"],"title":"Event","type":"object","x-stream-docs-page-id":"event_object"},"WebhookEvent":{"description":"The discriminator object for all webhook events, it maps events' payload to the final type","discriminator":{"mapping":{"*":"#/components/schemas/AnyEvent","activity.marked":"#/components/schemas/ActivityMarkedEvent","call.accepted":"#/components/schemas/CallAcceptedEvent","call.blocked_user":"#/components/schemas/BlockedUserEvent","call.closed_caption":"#/components/schemas/ClosedCaptionEvent","call.closed_captions_failed":"#/components/schemas/CallClosedCaptionsFailedEvent","call.closed_captions_started":"#/components/schemas/CallClosedCaptionsStartedEvent","call.closed_captions_stopped":"#/components/schemas/CallClosedCaptionsStoppedEvent","call.created":"#/components/schemas/CallCreatedEvent","call.deleted":"#/components/schemas/CallDeletedEvent","call.ended":"#/components/schemas/CallEndedEvent","call.frame_recording_failed":"#/components/schemas/CallFrameRecordingFailedEvent","call.frame_recording_ready":"#/components/schemas/CallFrameRecordingFrameReadyEvent","call.frame_recording_started":"#/components/schemas/CallFrameRecordingStartedEvent","call.frame_recording_stopped":"#/components/schemas/CallFrameRecordingStoppedEvent","call.hls_broadcasting_failed":"#/components/schemas/CallHLSBroadcastingFailedEvent","call.hls_broadcasting_started":"#/components/schemas/CallHLSBroadcastingStartedEvent","call.hls_broadcasting_stopped":"#/components/schemas/CallHLSBroadcastingStoppedEvent","call.kicked_user":"#/components/schemas/KickedUserEvent","call.live_started":"#/components/schemas/CallLiveStartedEvent","call.member_added":"#/components/schemas/CallMemberAddedEvent","call.member_removed":"#/components/schemas/CallMemberRemovedEvent","call.member_updated":"#/components/schemas/CallMemberUpdatedEvent","call.member_updated_permission":"#/components/schemas/CallMemberUpdatedPermissionEvent","call.missed":"#/components/schemas/CallMissedEvent","call.moderation_blur":"#/components/schemas/CallModerationBlurEvent","call.moderation_warning":"#/components/schemas/CallModerationWarningEvent","call.notification":"#/components/schemas/CallNotificationEvent","call.permission_request":"#/components/schemas/PermissionRequestEvent","call.permissions_updated":"#/components/schemas/UpdatedCallPermissionsEvent","call.reaction_new":"#/components/schemas/CallReactionEvent","call.recording_failed":"#/components/schemas/CallRecordingFailedEvent","call.recording_ready":"#/components/schemas/CallRecordingReadyEvent","call.recording_started":"#/components/schemas/CallRecordingStartedEvent","call.recording_stopped":"#/components/schemas/CallRecordingStoppedEvent","call.rejected":"#/components/schemas/CallRejectedEvent","call.ring":"#/components/schemas/CallRingEvent","call.rtmp_broadcast_failed":"#/components/schemas/CallRtmpBroadcastFailedEvent","call.rtmp_broadcast_started":"#/components/schemas/CallRtmpBroadcastStartedEvent","call.rtmp_broadcast_stopped":"#/components/schemas/CallRtmpBroadcastStoppedEvent","call.session_ended":"#/components/schemas/CallSessionEndedEvent","call.session_participant_count_updated":"#/components/schemas/CallSessionParticipantCountsUpdatedEvent","call.session_participant_joined":"#/components/schemas/CallSessionParticipantJoinedEvent","call.session_participant_left":"#/components/schemas/CallSessionParticipantLeftEvent","call.session_started":"#/components/schemas/CallSessionStartedEvent","call.stats_report_ready":"#/components/schemas/CallStatsReportReadyEvent","call.transcription_failed":"#/components/schemas/CallTranscriptionFailedEvent","call.transcription_ready":"#/components/schemas/CallTranscriptionReadyEvent","call.transcription_started":"#/components/schemas/CallTranscriptionStartedEvent","call.transcription_stopped":"#/components/schemas/CallTranscriptionStoppedEvent","call.unblocked_user":"#/components/schemas/UnblockedUserEvent","call.updated":"#/components/schemas/CallUpdatedEvent","call.user_feedback_submitted":"#/components/schemas/CallUserFeedbackSubmittedEvent","call.user_muted":"#/components/schemas/CallUserMutedEvent","campaign.completed":"#/components/schemas/CampaignCompletedEvent","campaign.started":"#/components/schemas/CampaignStartedEvent","channel.created":"#/components/schemas/ChannelCreatedEvent","channel.deleted":"#/components/schemas/ChannelDeletedEvent","channel.frozen":"#/components/schemas/ChannelFrozenEvent","channel.hidden":"#/components/schemas/ChannelHiddenEvent","channel.muted":"#/components/schemas/ChannelMutedEvent","channel.truncated":"#/components/schemas/ChannelTruncatedEvent","channel.unfrozen":"#/components/schemas/ChannelUnFrozenEvent","channel.unmuted":"#/components/schemas/ChannelUnmutedEvent","channel.updated":"#/components/schemas/ChannelUpdatedEvent","channel.visible":"#/components/schemas/ChannelVisibleEvent","custom":"#/components/schemas/CustomVideoEvent","export.bulk_image_moderation.error":"#/components/schemas/AsyncExportErrorEvent","export.bulk_image_moderation.success":"#/components/schemas/AsyncBulkImageModerationEvent","export.channels.error":"#/components/schemas/AsyncExportErrorEvent","export.channels.success":"#/components/schemas/AsyncExportChannelsEvent","export.moderation_logs.error":"#/components/schemas/AsyncExportErrorEvent","export.moderation_logs.success":"#/components/schemas/AsyncExportModerationLogsEvent","export.users.error":"#/components/schemas/AsyncExportErrorEvent","export.users.success":"#/components/schemas/AsyncExportUsersEvent","feeds.activity.added":"#/components/schemas/ActivityAddedEvent","feeds.activity.deleted":"#/components/schemas/ActivityDeletedEvent","feeds.activity.marked":"#/components/schemas/ActivityMarkEvent","feeds.activity.pinned":"#/components/schemas/ActivityPinnedEvent","feeds.activity.reaction.added":"#/components/schemas/ActivityReactionAddedEvent","feeds.activity.reaction.deleted":"#/components/schemas/ActivityReactionDeletedEvent","feeds.activity.reaction.updated":"#/components/schemas/ActivityReactionUpdatedEvent","feeds.activity.removed_from_feed":"#/components/schemas/ActivityRemovedFromFeedEvent","feeds.activity.unpinned":"#/components/schemas/ActivityUnpinnedEvent","feeds.activity.updated":"#/components/schemas/ActivityUpdatedEvent","feeds.bookmark.added":"#/components/schemas/BookmarkAddedEvent","feeds.bookmark.deleted":"#/components/schemas/BookmarkDeletedEvent","feeds.bookmark.updated":"#/components/schemas/BookmarkUpdatedEvent","feeds.bookmark_folder.deleted":"#/components/schemas/BookmarkFolderDeletedEvent","feeds.bookmark_folder.updated":"#/components/schemas/BookmarkFolderUpdatedEvent","feeds.comment.added":"#/components/schemas/CommentAddedEvent","feeds.comment.deleted":"#/components/schemas/CommentDeletedEvent","feeds.comment.reaction.added":"#/components/schemas/CommentReactionAddedEvent","feeds.comment.reaction.deleted":"#/components/schemas/CommentReactionDeletedEvent","feeds.comment.reaction.updated":"#/components/schemas/CommentReactionUpdatedEvent","feeds.comment.updated":"#/components/schemas/CommentUpdatedEvent","feeds.feed.created":"#/components/schemas/FeedCreatedEvent","feeds.feed.deleted":"#/components/schemas/FeedDeletedEvent","feeds.feed.updated":"#/components/schemas/FeedUpdatedEvent","feeds.feed_group.changed":"#/components/schemas/FeedGroupChangedEvent","feeds.feed_group.deleted":"#/components/schemas/FeedGroupDeletedEvent","feeds.feed_member.added":"#/components/schemas/FeedMemberAddedEvent","feeds.feed_member.removed":"#/components/schemas/FeedMemberRemovedEvent","feeds.feed_member.updated":"#/components/schemas/FeedMemberUpdatedEvent","feeds.follow.created":"#/components/schemas/FollowCreatedEvent","feeds.follow.deleted":"#/components/schemas/FollowDeletedEvent","feeds.follow.updated":"#/components/schemas/FollowUpdatedEvent","feeds.notification_feed.updated":"#/components/schemas/NotificationFeedUpdatedEvent","flag.updated":"#/components/schemas/FlagUpdatedEvent","member.added":"#/components/schemas/MemberAddedEvent","member.removed":"#/components/schemas/MemberRemovedEvent","member.updated":"#/components/schemas/MemberUpdatedEvent","message.deleted":"#/components/schemas/MessageDeletedEvent","message.flagged":"#/components/schemas/MessageFlaggedEvent","message.new":"#/components/schemas/MessageNewEvent","message.pending":"#/components/schemas/PendingMessageEvent","message.read":"#/components/schemas/MessageReadEvent","message.unblocked":"#/components/schemas/MessageUnblockedEvent","message.undeleted":"#/components/schemas/MessageUndeletedEvent","message.updated":"#/components/schemas/MessageUpdatedEvent","moderation.custom_action":"#/components/schemas/ModerationCustomActionEvent","moderation.flagged":"#/components/schemas/ModerationFlaggedEvent","moderation.mark_reviewed":"#/components/schemas/ModerationMarkReviewedEvent","moderation_check.completed":"#/components/schemas/ModerationCheckCompletedEvent","notification.mark_unread":"#/components/schemas/NotificationMarkUnreadEvent","notification.reminder_due":"#/components/schemas/ReminderNotificationEvent","notification.thread_message_new":"#/components/schemas/MessageNewEvent","reaction.deleted":"#/components/schemas/ReactionDeletedEvent","reaction.new":"#/components/schemas/ReactionNewEvent","reaction.updated":"#/components/schemas/ReactionUpdatedEvent","reminder.created":"#/components/schemas/ReminderCreatedEvent","reminder.deleted":"#/components/schemas/ReminderDeletedEvent","reminder.updated":"#/components/schemas/ReminderUpdatedEvent","review_queue_item.new":"#/components/schemas/ReviewQueueItemNewEvent","review_queue_item.updated":"#/components/schemas/ReviewQueueItemUpdatedEvent","thread.updated":"#/components/schemas/ThreadUpdatedEvent","user.banned":"#/components/schemas/UserBannedEvent","user.deactivated":"#/components/schemas/UserDeactivatedEvent","user.deleted":"#/components/schemas/UserDeletedEvent","user.flagged":"#/components/schemas/UserFlaggedEvent","user.messages.deleted":"#/components/schemas/UserMessagesDeletedEvent","user.muted":"#/components/schemas/UserMutedEvent","user.reactivated":"#/components/schemas/UserReactivatedEvent","user.unbanned":"#/components/schemas/UserUnbannedEvent","user.unmuted":"#/components/schemas/UserUnmutedEvent","user.unread_message_reminder":"#/components/schemas/UserUnreadReminderEvent","user.updated":"#/components/schemas/UserUpdatedEvent"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/ActivityAddedEvent"},{"$ref":"#/components/schemas/ActivityDeletedEvent"},{"$ref":"#/components/schemas/ActivityMarkEvent"},{"$ref":"#/components/schemas/ActivityMarkedEvent"},{"$ref":"#/components/schemas/ActivityPinnedEvent"},{"$ref":"#/components/schemas/ActivityReactionAddedEvent"},{"$ref":"#/components/schemas/ActivityReactionDeletedEvent"},{"$ref":"#/components/schemas/ActivityReactionUpdatedEvent"},{"$ref":"#/components/schemas/ActivityRemovedFromFeedEvent"},{"$ref":"#/components/schemas/ActivityUnpinnedEvent"},{"$ref":"#/components/schemas/ActivityUpdatedEvent"},{"$ref":"#/components/schemas/AnyEvent"},{"$ref":"#/components/schemas/AsyncBulkImageModerationEvent"},{"$ref":"#/components/schemas/AsyncExportChannelsEvent"},{"$ref":"#/components/schemas/AsyncExportErrorEvent"},{"$ref":"#/components/schemas/AsyncExportErrorEvent"},{"$ref":"#/components/schemas/AsyncExportErrorEvent"},{"$ref":"#/components/schemas/AsyncExportErrorEvent"},{"$ref":"#/components/schemas/AsyncExportModerationLogsEvent"},{"$ref":"#/components/schemas/AsyncExportUsersEvent"},{"$ref":"#/components/schemas/BlockedUserEvent"},{"$ref":"#/components/schemas/BookmarkAddedEvent"},{"$ref":"#/components/schemas/BookmarkDeletedEvent"},{"$ref":"#/components/schemas/BookmarkFolderDeletedEvent"},{"$ref":"#/components/schemas/BookmarkFolderUpdatedEvent"},{"$ref":"#/components/schemas/BookmarkUpdatedEvent"},{"$ref":"#/components/schemas/CallAcceptedEvent"},{"$ref":"#/components/schemas/CallClosedCaptionsFailedEvent"},{"$ref":"#/components/schemas/CallClosedCaptionsStartedEvent"},{"$ref":"#/components/schemas/CallClosedCaptionsStoppedEvent"},{"$ref":"#/components/schemas/CallCreatedEvent"},{"$ref":"#/components/schemas/CallDeletedEvent"},{"$ref":"#/components/schemas/CallEndedEvent"},{"$ref":"#/components/schemas/CallFrameRecordingFailedEvent"},{"$ref":"#/components/schemas/CallFrameRecordingFrameReadyEvent"},{"$ref":"#/components/schemas/CallFrameRecordingStartedEvent"},{"$ref":"#/components/schemas/CallFrameRecordingStoppedEvent"},{"$ref":"#/components/schemas/CallHLSBroadcastingFailedEvent"},{"$ref":"#/components/schemas/CallHLSBroadcastingStartedEvent"},{"$ref":"#/components/schemas/CallHLSBroadcastingStoppedEvent"},{"$ref":"#/components/schemas/CallLiveStartedEvent"},{"$ref":"#/components/schemas/CallMemberAddedEvent"},{"$ref":"#/components/schemas/CallMemberRemovedEvent"},{"$ref":"#/components/schemas/CallMemberUpdatedEvent"},{"$ref":"#/components/schemas/CallMemberUpdatedPermissionEvent"},{"$ref":"#/components/schemas/CallMissedEvent"},{"$ref":"#/components/schemas/CallModerationBlurEvent"},{"$ref":"#/components/schemas/CallModerationWarningEvent"},{"$ref":"#/components/schemas/CallNotificationEvent"},{"$ref":"#/components/schemas/CallReactionEvent"},{"$ref":"#/components/schemas/CallRecordingFailedEvent"},{"$ref":"#/components/schemas/CallRecordingReadyEvent"},{"$ref":"#/components/schemas/CallRecordingStartedEvent"},{"$ref":"#/components/schemas/CallRecordingStoppedEvent"},{"$ref":"#/components/schemas/CallRejectedEvent"},{"$ref":"#/components/schemas/CallRingEvent"},{"$ref":"#/components/schemas/CallRtmpBroadcastFailedEvent"},{"$ref":"#/components/schemas/CallRtmpBroadcastStartedEvent"},{"$ref":"#/components/schemas/CallRtmpBroadcastStoppedEvent"},{"$ref":"#/components/schemas/CallSessionEndedEvent"},{"$ref":"#/components/schemas/CallSessionParticipantCountsUpdatedEvent"},{"$ref":"#/components/schemas/CallSessionParticipantJoinedEvent"},{"$ref":"#/components/schemas/CallSessionParticipantLeftEvent"},{"$ref":"#/components/schemas/CallSessionStartedEvent"},{"$ref":"#/components/schemas/CallStatsReportReadyEvent"},{"$ref":"#/components/schemas/CallTranscriptionFailedEvent"},{"$ref":"#/components/schemas/CallTranscriptionReadyEvent"},{"$ref":"#/components/schemas/CallTranscriptionStartedEvent"},{"$ref":"#/components/schemas/CallTranscriptionStoppedEvent"},{"$ref":"#/components/schemas/CallUpdatedEvent"},{"$ref":"#/components/schemas/CallUserFeedbackSubmittedEvent"},{"$ref":"#/components/schemas/CallUserMutedEvent"},{"$ref":"#/components/schemas/CampaignCompletedEvent"},{"$ref":"#/components/schemas/CampaignStartedEvent"},{"$ref":"#/components/schemas/ChannelCreatedEvent"},{"$ref":"#/components/schemas/ChannelDeletedEvent"},{"$ref":"#/components/schemas/ChannelFrozenEvent"},{"$ref":"#/components/schemas/ChannelHiddenEvent"},{"$ref":"#/components/schemas/ChannelMutedEvent"},{"$ref":"#/components/schemas/ChannelTruncatedEvent"},{"$ref":"#/components/schemas/ChannelUnFrozenEvent"},{"$ref":"#/components/schemas/ChannelUnmutedEvent"},{"$ref":"#/components/schemas/ChannelUpdatedEvent"},{"$ref":"#/components/schemas/ChannelVisibleEvent"},{"$ref":"#/components/schemas/ClosedCaptionEvent"},{"$ref":"#/components/schemas/CommentAddedEvent"},{"$ref":"#/components/schemas/CommentDeletedEvent"},{"$ref":"#/components/schemas/CommentReactionAddedEvent"},{"$ref":"#/components/schemas/CommentReactionDeletedEvent"},{"$ref":"#/components/schemas/CommentReactionUpdatedEvent"},{"$ref":"#/components/schemas/CommentUpdatedEvent"},{"$ref":"#/components/schemas/CustomVideoEvent"},{"$ref":"#/components/schemas/FeedCreatedEvent"},{"$ref":"#/components/schemas/FeedDeletedEvent"},{"$ref":"#/components/schemas/FeedGroupChangedEvent"},{"$ref":"#/components/schemas/FeedGroupDeletedEvent"},{"$ref":"#/components/schemas/FeedMemberAddedEvent"},{"$ref":"#/components/schemas/FeedMemberRemovedEvent"},{"$ref":"#/components/schemas/FeedMemberUpdatedEvent"},{"$ref":"#/components/schemas/FeedUpdatedEvent"},{"$ref":"#/components/schemas/FlagUpdatedEvent"},{"$ref":"#/components/schemas/FollowCreatedEvent"},{"$ref":"#/components/schemas/FollowDeletedEvent"},{"$ref":"#/components/schemas/FollowUpdatedEvent"},{"$ref":"#/components/schemas/KickedUserEvent"},{"$ref":"#/components/schemas/MemberAddedEvent"},{"$ref":"#/components/schemas/MemberRemovedEvent"},{"$ref":"#/components/schemas/MemberUpdatedEvent"},{"$ref":"#/components/schemas/MessageDeletedEvent"},{"$ref":"#/components/schemas/MessageFlaggedEvent"},{"$ref":"#/components/schemas/MessageNewEvent"},{"$ref":"#/components/schemas/MessageNewEvent"},{"$ref":"#/components/schemas/MessageReadEvent"},{"$ref":"#/components/schemas/MessageUnblockedEvent"},{"$ref":"#/components/schemas/MessageUndeletedEvent"},{"$ref":"#/components/schemas/MessageUpdatedEvent"},{"$ref":"#/components/schemas/ModerationCheckCompletedEvent"},{"$ref":"#/components/schemas/ModerationCustomActionEvent"},{"$ref":"#/components/schemas/ModerationFlaggedEvent"},{"$ref":"#/components/schemas/ModerationMarkReviewedEvent"},{"$ref":"#/components/schemas/NotificationFeedUpdatedEvent"},{"$ref":"#/components/schemas/NotificationMarkUnreadEvent"},{"$ref":"#/components/schemas/PendingMessageEvent"},{"$ref":"#/components/schemas/PermissionRequestEvent"},{"$ref":"#/components/schemas/ReactionDeletedEvent"},{"$ref":"#/components/schemas/ReactionNewEvent"},{"$ref":"#/components/schemas/ReactionUpdatedEvent"},{"$ref":"#/components/schemas/ReminderCreatedEvent"},{"$ref":"#/components/schemas/ReminderDeletedEvent"},{"$ref":"#/components/schemas/ReminderNotificationEvent"},{"$ref":"#/components/schemas/ReminderUpdatedEvent"},{"$ref":"#/components/schemas/ReviewQueueItemNewEvent"},{"$ref":"#/components/schemas/ReviewQueueItemUpdatedEvent"},{"$ref":"#/components/schemas/ThreadUpdatedEvent"},{"$ref":"#/components/schemas/UnblockedUserEvent"},{"$ref":"#/components/schemas/UpdatedCallPermissionsEvent"},{"$ref":"#/components/schemas/UserBannedEvent"},{"$ref":"#/components/schemas/UserDeactivatedEvent"},{"$ref":"#/components/schemas/UserDeletedEvent"},{"$ref":"#/components/schemas/UserFlaggedEvent"},{"$ref":"#/components/schemas/UserMessagesDeletedEvent"},{"$ref":"#/components/schemas/UserMutedEvent"},{"$ref":"#/components/schemas/UserReactivatedEvent"},{"$ref":"#/components/schemas/UserUnbannedEvent"},{"$ref":"#/components/schemas/UserUnmutedEvent"},{"$ref":"#/components/schemas/UserUnreadReminderEvent"},{"$ref":"#/components/schemas/UserUpdatedEvent"}]},"WrappedUnreadCountsResponse":{"description":"Basic response information","nullable":true,"properties":{"channel_type":{"items":{"$ref":"#/components/schemas/UnreadCountsChannelType"},"type":"array","x-stream-index":"001.005"},"channels":{"items":{"$ref":"#/components/schemas/UnreadCountsChannel"},"type":"array","x-stream-index":"001.004"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"threads":{"items":{"$ref":"#/components/schemas/UnreadCountsThread"},"type":"array","x-stream-index":"001.006"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"001.001"},"total_unread_count_by_team":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001.003"},"total_unread_threads_count":{"format":"int32","type":"integer","x-stream-index":"001.002"}},"required":["total_unread_count","total_unread_threads_count","channels","channel_type","threads","duration"],"title":"Response","type":"object"},"XiaomiConfig":{"properties":{"Disabled":{"type":"boolean","writeOnly":true,"x-stream-index":"003"},"package_name":{"type":"string","x-stream-index":"001"},"secret":{"type":"string","x-stream-index":"002"}},"type":"object"},"XiaomiConfigFields":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"package_name":{"type":"string","x-stream-index":"002"},"secret":{"type":"string","x-stream-index":"003"}},"required":["enabled"],"type":"object"}},"securitySchemes":{"JWT":{"description":"JWT should be always provided when stream-auth-type=jwt.\n\nUsing JWT auth request could be authenticated as user or as server-side.\n\nWhen using user authentication permission checking is going to be applied to requests based on the user that is\nperforming a request.\n\nThe `authorization` header should be a JWT string signed using the secret attached to the API key used to perform\nrequests.\n\n**WARNING** all client-side official SDK do not ship with token generation; this is to make sure that the API secret is not\nshared with an untrusted party such as a browser or a iOS/Android application. Tokens **must** be generated server-side.\nIf you wish, you can configure your application to ignore authentication (see `disable_auth_check`)\nThe JWT string must include only the user_id claim and can include any built-in JWT claim such as iat, exp as well.\n","in":"header","name":"Authorization","type":"apiKey"},"api_key":{"description":"Application API key should be always set in order to authenticate the request.","in":"query","name":"api_key","type":"apiKey"},"stream-auth-type":{"description":"Stream-Auth-Type should be always set in order to authenticate the request. Possible\nvalues: `jwt` or `anonymous`.\n\n`jwt` allows you to authenticate as a user. With this auth type you should also provide valid JWT in Authorization\nheader.\n\n`anonymous` allows you to authenticate as anonymous user. Please note that most advanced features are not available\nto anonymous users.","in":"header","name":"Stream-Auth-Type","type":"apiKey"}}},"info":{"title":"Stream API","version":"v191.1.0"},"openapi":"3.0.3","paths":{"/api/v2/app":{"get":{"description":"This Method returns the application settings\n","operationId":"GetApp","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetApplicationResponse"}}},"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":"Get App Settings","tags":["product:common"]},"patch":{"description":"This Method updates one or more application settings\n","operationId":"UpdateApp","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAppRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Update App Settings","tags":["product:common"]}},"/api/v2/blocklists":{"get":{"description":"Returns all available block lists\n","operationId":"ListBlockLists","parameters":[{"in":"query","name":"team","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListBlockListResponse"}}},"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":"List block lists","tags":["product:common"]},"post":{"description":"Creates a new application blocklist, once created the blocklist can be used by any channel type\n","operationId":"CreateBlockList","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBlockListRequest"}}},"description":"Block list","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBlockListResponse"}}},"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":"Create block list","tags":["product:common"]}},"/api/v2/blocklists/{name}":{"delete":{"description":"Deletes previously created application blocklist\n","operationId":"DeleteBlockList","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"team","schema":{"type":"string","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete block list","tags":["product:common"]},"get":{"description":"Returns block list by given name\n","operationId":"GetBlockList","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Block list name","title":"Name","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"team","schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBlockListResponse"}}},"description":"GetBlockListResponse"},"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":"Get block list","tags":["product:common"]},"put":{"description":"Updates contents of the block list\n","operationId":"UpdateBlockList","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Block list name","title":"Name","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBlockListRequest"}}},"description":"Update block list","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBlockListResponse"}}},"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":"Update block list","tags":["product:common"]}},"/api/v2/chat/campaigns/query":{"post":{"description":"Query campaigns with filter query\n","operationId":"QueryCampaigns","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCampaignsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCampaignsResponse"}}},"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":"Query campaigns","tags":["product:chat"]}},"/api/v2/chat/campaigns/{id}":{"get":{"description":"Get campaign by ID.\n","operationId":"GetCampaign","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"The ID of the campaign (uuid)","maxLength":255,"title":"Campaign ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"prev","schema":{"description":"Token for the previous page of campaign users","title":"Previous Users Page","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"query","name":"next","schema":{"description":"Token for the next page of campaign users","title":"Next Users Page","type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"limit","schema":{"description":"Maximum number of campaign users to return in a single request (max: 1000)","format":"int32","maximum":1000,"minimum":0,"title":"Users Limit","type":"integer","writeOnly":true,"x-stream-index":"002.003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCampaignResponse"}}},"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":"Get campaign","tags":["product:chat"]}},"/api/v2/chat/campaigns/{id}/start":{"post":{"description":"Starts or schedules a campaign\n","operationId":"StartCampaign","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartCampaignRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartCampaignResponse"}}},"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":"Start/schedule campaign","tags":["product:chat"]}},"/api/v2/chat/campaigns/{id}/stop":{"post":{"description":"Stops a campaign\n","operationId":"ScheduleCampaign","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopCampaignRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignResponse"}}},"description":"Successful 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":"Stop campaign","tags":["product:chat"]}},"/api/v2/chat/channels":{"post":{"description":"Query channels with filter query\n","operationId":"QueryChannels","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryChannelsRequest"}}},"description":"Query Channels Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryChannelsResponse"}}},"description":"Channels list"},"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":"Query channels","tags":["product:chat"]}},"/api/v2/chat/channels/delete":{"post":{"description":"Allows to delete several channels at once asynchronously\n\nSends events:\n- channel.deleted\n- channel.deleted\n","operationId":"DeleteChannels","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteChannelsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteChannelsResponse"}}},"description":"Successful 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":"Deletes channels asynchronously","tags":["product:chat"]}},"/api/v2/chat/channels/read":{"post":{"description":"Marks channels as read up to the specific message. If no channels is given, mark all channel as read\n\nSends events:\n- message.read\n- message.read\n","operationId":"MarkChannelsRead","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkChannelsReadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkReadResponse"}}},"description":"Successful 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 channels as read","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/query":{"post":{"description":"This Method creates a channel or returns an existing one with matching attributes\n\nSends events:\n- channel.created\n- member.added\n- member.removed\n- member.updated\n- user.watching.start\n","operationId":"GetOrCreateDistinctChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelGetOrCreateRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelStateResponse"}}},"description":"Successful 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":"Get or create channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}":{"delete":{"description":"Deletes channel\n\nSends events:\n- channel.deleted\n- channel.deleted\n","operationId":"DeleteChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"query","name":"hard_delete","schema":{"type":"boolean","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteChannelResponse"}}},"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":"Delete channel","tags":["product:chat"]},"patch":{"description":"Updates certain fields of the channel\n\nSends events:\n- channel.updated\n- channel.updated\n","operationId":"UpdateChannelPartial","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelPartialRequest"}}},"description":"UpdateChannelPartialRequest","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelPartialResponse"}}},"description":"Successful 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":"Partially update channel","tags":["product:chat"]},"post":{"description":"Change channel data\n\nSends events:\n- channel.updated\n- member.added\n- member.removed\n- member.updated\n- message.new\n- channel.updated\n- member.added\n- member.removed\n- member.updated\n- message.new\n","operationId":"UpdateChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"013.002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"013.002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelRequest"}}},"description":"Channel update request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelResponse"}}},"description":"Successful 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":"Update channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/draft":{"delete":{"description":"Deletes a draft\n\nSends events:\n- draft.deleted\n","operationId":"DeleteDraft","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"parent_id","schema":{"description":"Parent message ID","title":"string","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"003.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete draft","tags":["product:chat"]},"get":{"description":"Get a draft\n","operationId":"GetDraft","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"parent_id","schema":{"description":"Parent message ID","title":"string","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"003.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetDraftResponse"}}},"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":"Get draft","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/event":{"post":{"description":"Sends event to the channel\n","operationId":"SendEvent","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendEventRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventResponse"}}},"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":"Send event","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/file":{"delete":{"description":"Deletes previously uploaded file\n","operationId":"DeleteFile","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of file","title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"File ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"url","schema":{"description":"File URL to delete","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete file","tags":["product:chat"]},"post":{"description":"Uploads file\n","operationId":"UploadFile","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/FileUploadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileUploadResponse"}}},"description":"Successful 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":"Upload file","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/hide":{"post":{"description":"Marks channel as hidden for current user\n\nSends events:\n- channel.hidden\n- channel.hidden\n","operationId":"HideChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HideChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HideChannelResponse"}}},"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":"Hide channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/image":{"delete":{"description":"Deletes previously uploaded image\n","operationId":"DeleteImage","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of file","title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"File ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"url","schema":{"description":"File URL to delete","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete image","tags":["product:chat"]},"post":{"description":"Uploads image\n","operationId":"UploadImage","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.001.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.001.002"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/ImageUploadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageUploadResponse"}}},"description":"Successful 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":"Upload image","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/member":{"patch":{"description":"\n","operationId":"UpdateMemberPartial","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"005.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMemberPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMemberPartialResponse"}}},"description":"Successful 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":"Partially channel member update","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/message":{"post":{"description":"Sends new message to the specified channel\n\nSends events:\n- message.new\n- message.updated\n- message.new\n- message.updated\n","operationId":"SendMessage","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"009.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"009.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendMessageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendMessageResponse"}}},"description":"Successful 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":"Send new message","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/messages":{"get":{"description":"Returns list messages found by IDs\n","operationId":"GetManyMessages","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"ids","required":true,"schema":{"description":"List of comma-separated IDs","items":{"type":"string"},"maximum":50,"minimum":1,"title":"IDs","type":"array","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetManyMessagesResponse"}}},"description":"Successful 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":"Get many messages","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/query":{"post":{"description":"This Method creates a channel or returns an existing one with matching attributes\n\nSends events:\n- channel.created\n- member.added\n- member.removed\n- member.updated\n- user.watching.start\n","operationId":"GetOrCreateChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID (maximum length of 64 characters)","title":"ID","type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelGetOrCreateRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelStateResponse"}}},"description":"Successful 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":"Get or create channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/read":{"post":{"description":"Marks channel as read up to the specific message\n\nSends events:\n- message.read\n- message.read\n","operationId":"MarkRead","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkReadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkReadResponse"}}},"description":"Successful 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 read","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/show":{"post":{"description":"Shows previously hidden channel\n\nSends events:\n- channel.visible\n- channel.visible\n","operationId":"ShowChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShowChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShowChannelResponse"}}},"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":"Show channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/truncate":{"post":{"description":"Truncates messages from a channel. Can be applied to the entire channel or scoped to specific members.\n\nSends events:\n- channel.truncated\n- channel.truncated\n","operationId":"TruncateChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TruncateChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TruncateChannelResponse"}}},"description":"Successful 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":"Truncate channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/unread":{"post":{"description":"Marks channel as unread from a specific message\n","operationId":"MarkUnread","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkUnreadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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 unread","tags":["product:chat"]}},"/api/v2/chat/channeltypes":{"get":{"description":"Lists all available channel types\n","operationId":"ListChannelTypes","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListChannelTypesResponse"}}},"description":"ListChannelTypesResponse"},"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":"List channel types","tags":["product:chat"]},"post":{"description":"Creates new channel type\n","operationId":"CreateChannelType","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateChannelTypeRequest"}}},"description":"CreateChannelTypeRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateChannelTypeResponse"}}},"description":"Successful 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":"Create channel type","tags":["product:chat"]}},"/api/v2/chat/channeltypes/{name}":{"delete":{"description":"Deletes channel type\n","operationId":"DeleteChannelType","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Channel type name","title":"Name","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete channel type","tags":["product:chat"]},"get":{"description":"Gets channel type\n","operationId":"GetChannelType","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Channel type name","title":"Name","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetChannelTypeResponse"}}},"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":"Get channel type","tags":["product:chat"]},"put":{"description":"Updates channel type\n","operationId":"UpdateChannelType","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelTypeRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelTypeResponse"}}},"description":"Successful 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":"Update channel type","tags":["product:chat"]}},"/api/v2/chat/commands":{"get":{"description":"Returns all custom commands\n","operationId":"ListCommands","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListCommandsResponse"}}},"description":"ListCommandsResponse"},"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":"List commands","tags":["product:chat"]},"post":{"description":"Creates custom chat command\n","operationId":"CreateCommand","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCommandRequest"}}},"description":"CreateCommandRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCommandResponse"}}},"description":"CreateCommandResponse"},"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":"Create command","tags":["product:chat"]}},"/api/v2/chat/commands/{name}":{"delete":{"description":"Deletes custom chat command\n","operationId":"DeleteCommand","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Command name","title":"Name","type":"string","x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCommandResponse"}}},"description":"DeleteCommandResponse"},"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":"Delete command","tags":["product:chat"]},"get":{"description":"Returns custom command by its name\n","operationId":"GetCommand","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Command name","title":"Name","type":"string","x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCommandResponse"}}},"description":"GetCommandResponse"},"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":"Get command","tags":["product:chat"]},"put":{"description":"Updates custom chat command\n","operationId":"UpdateCommand","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Unique command name","title":"Name","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCommandRequest"}}},"description":"UpdateCommandRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCommandResponse"}}},"description":"UpdateCommandResponse"},"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":"Update command","tags":["product:chat"]}},"/api/v2/chat/drafts/query":{"post":{"description":"Queries draft messages for a user\n","operationId":"QueryDrafts","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryDraftsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryDraftsResponse"}}},"description":"Successful 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":"Query draft messages","tags":["product:chat"]}},"/api/v2/chat/export_channels":{"post":{"description":"Exports channel data to JSON file\n","operationId":"ExportChannels","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportChannelsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportChannelsResponse"}}},"description":"Successful 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":"Export channels","tags":["product:chat"]}},"/api/v2/chat/members":{"get":{"description":"Find and filter channel members\n","operationId":"QueryMembers","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryMembersPayload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MembersResponse"}}},"description":"Successful 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":"Query members","tags":["product:chat"]}},"/api/v2/chat/messages/history":{"post":{"description":"Queries history for one message\n","operationId":"QueryMessageHistory","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryMessageHistoryRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryMessageHistoryResponse"}}},"description":"Successful 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":"Query message history","tags":["product:chat"]}},"/api/v2/chat/messages/{id}":{"delete":{"description":"Deletes message\n\nSends events:\n- message.deleted\n- message.deleted\n","operationId":"DeleteMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID to delete","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"hard","schema":{"description":"Delete all message reactions and replies as well","title":"Hard","type":"boolean","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"deleted_by","schema":{"type":"string","writeOnly":true,"x-stream-index":"003"}},{"in":"query","name":"delete_for_me","schema":{"description":"Delete the message only for the user making the request","title":"Delete for me","type":"boolean","writeOnly":true,"x-stream-index":"004"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteMessageResponse"}}},"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":"Delete message","tags":["product:chat"]},"get":{"description":"Returns message by ID\n","operationId":"GetMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"ID of the message","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"show_deleted_message","schema":{"description":"Whether to show deleted message","title":"Show deleted message","type":"boolean","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetMessageResponse"}}},"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":"Get message","tags":["product:chat"]},"post":{"description":"Updates message with new data\n\nSends events:\n- message.updated\n- message.updated\n","operationId":"UpdateMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"004.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessageResponse"}}},"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":"Update message","tags":["product:chat"]},"put":{"description":"Updates certain fields of the message\n\nSends events:\n- message.updated\n- message.updated\n","operationId":"UpdateMessagePartial","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessagePartialRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessagePartialResponse"}}},"description":"Successful 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":"Partially message update","tags":["product:chat"]}},"/api/v2/chat/messages/{id}/action":{"post":{"description":"Executes message command action with given parameters\n\nSends events:\n- message.new\n- message.new\n","operationId":"RunMessageAction","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageActionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}},"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":"Run message command action","tags":["product:chat"]}},"/api/v2/chat/messages/{id}/commit":{"post":{"description":"Commits a pending message, which will make it visible in the channel\n\nSends events:\n- message.new\n- message.updated\n- message.new\n- message.updated\n","operationId":"CommitMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommitMessageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}},"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":"Commit message","tags":["product:chat"]}},"/api/v2/chat/messages/{id}/reaction":{"post":{"description":"Sends reaction to specified message\n\nSends events:\n- reaction.new\n- reaction.updated\n","operationId":"SendReaction","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID to send reaction for","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendReactionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendReactionResponse"}}},"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":"Send reaction","tags":["product:chat"]}},"/api/v2/chat/messages/{id}/reaction/{type}":{"delete":{"description":"Removes user reaction from the message\n\nSends events:\n- reaction.deleted\n","operationId":"DeleteReaction","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID to remove reaction from","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"type","required":true,"schema":{"description":"Reaction type to remove","title":"Type","type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"description":"**Server-side only**. User ID which server acts upon","title":"User ID","type":"string","writeOnly":true,"x-stream-index":"003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteReactionResponse"}}},"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":"Delete reaction","tags":["product:chat"]}},"/api/v2/chat/messages/{id}/reactions":{"get":{"description":"Returns list of reactions of specific message\n","operationId":"GetReactions","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"limit","schema":{"description":"Number of records to return","format":"int32","title":"Limit","type":"integer","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"offset","schema":{"description":"Number of records to offset","format":"int32","title":"Offset","type":"integer","writeOnly":true,"x-stream-index":"003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetReactionsResponse"}}},"description":"Successful 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":"Get reactions","tags":["product:chat"]},"post":{"description":"Get reactions on a message\n","operationId":"QueryReactions","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryReactionsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryReactionsResponse"}}},"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"}},"tags":["product:chat"]}},"/api/v2/chat/messages/{id}/translate":{"post":{"description":"Translates message to a given language using automated translation software\n\nSends events:\n- message.updated\n- message.updated\n","operationId":"TranslateMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TranslateMessageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}},"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":"Translate message","tags":["product:chat"]}},"/api/v2/chat/messages/{id}/undelete":{"post":{"description":"Undelete a message that was previously soft-deleted\n\nSends events:\n- message.undeleted\n- message.undeleted\n","operationId":"UndeleteMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"004.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessageResponse"}}},"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":"Undelete message","tags":["product:chat"]}},"/api/v2/chat/messages/{message_id}/polls/{poll_id}/vote":{"post":{"description":"Cast a vote on a poll\n\nSends events:\n- feeds.poll.vote_casted\n- feeds.poll.vote_changed\n- feeds.poll.vote_removed\n- poll.vote_casted\n- poll.vote_changed\n- poll.vote_removed\n","operationId":"CastPollVote","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CastPollVoteRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollVoteResponse"}}},"description":"Successful 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":"Cast vote","tags":["product:chat"]}},"/api/v2/chat/messages/{message_id}/polls/{poll_id}/vote/{vote_id}":{"delete":{"description":"Delete a vote from a poll\n\nSends events:\n- feeds.poll.vote_removed\n- poll.vote_removed\n","operationId":"DeletePollVote","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"004"}},{"in":"path","name":"vote_id","required":true,"schema":{"description":"Vote ID","maxLength":255,"title":"string","type":"string","x-stream-index":"005"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollVoteResponse"}}},"description":"Successful 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":"Delete vote","tags":["product:chat"]}},"/api/v2/chat/messages/{message_id}/reminders":{"delete":{"description":"Deletes a user's created reminder\n\nSends events:\n- reminder.deleted\n","operationId":"DeleteReminder","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteReminderResponse"}}},"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":"Delete reminder","tags":["product:chat"]},"patch":{"description":"Updates an existing reminder\n\nSends events:\n- reminder.updated\n","operationId":"UpdateReminder","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateReminderRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateReminderResponse"}}},"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":"Updates Reminder","tags":["product:chat"]},"post":{"description":"Creates a new reminder\n\nSends events:\n- reminder.created\n","operationId":"CreateReminder","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateReminderRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReminderResponseData"}}},"description":"Successful 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":"Create reminder","tags":["product:chat"]}},"/api/v2/chat/messages/{parent_id}/replies":{"get":{"description":"Returns replies (thread) of the message\n","operationId":"GetReplies","parameters":[{"in":"path","name":"parent_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"sort","schema":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":1,"type":"array","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"limit","schema":{"description":"The maximum number of messages to return (max limit ","format":"int32","minimum":0,"title":"Limit","type":"integer","x-stream-index":"003.001"}},{"in":"query","name":"offset","schema":{"description":"The offset to start from","format":"int32","title":"Offset","type":"integer","x-stream-index":"003.002"}},{"in":"query","name":"id_gte","schema":{"description":"The ID of the message to get messages with a timestamp greater than or equal to","title":"IDGTE","type":"string","x-stream-index":"003.003"}},{"in":"query","name":"id_gt","schema":{"description":"The ID of the message to get messages with a timestamp greater than","title":"IDGT","type":"string","x-stream-index":"003.004"}},{"in":"query","name":"id_lte","schema":{"description":"The ID of the message to get messages with a timestamp smaller than or equal to","title":"IDLTE","type":"string","x-stream-index":"003.005"}},{"in":"query","name":"id_lt","schema":{"description":"The ID of the message to get messages with a timestamp smaller than","title":"IDLT","type":"string","x-stream-index":"003.006"}},{"in":"query","name":"created_at_after_or_equal","schema":{"description":"The timestamp to get messages with a created_at timestamp greater than or equal to","format":"date-time","title":"Created_at after or equal","type":"number","x-stream-index":"003.007"}},{"in":"query","name":"created_at_after","schema":{"description":"The timestamp to get messages with a created_at timestamp greater than","format":"date-time","title":"Created_at after","type":"number","x-stream-index":"003.008"}},{"in":"query","name":"created_at_before_or_equal","schema":{"description":"The timestamp to get messages with a created_at timestamp smaller than or equal to","format":"date-time","title":"Created_at after before or equal","type":"number","x-stream-index":"003.009"}},{"in":"query","name":"created_at_before","schema":{"description":"The timestamp to get messages with a created_at timestamp smaller than","format":"date-time","title":"Created_at after before","type":"number","x-stream-index":"003.010"}},{"in":"query","name":"id_around","schema":{"description":"The result will be a set of messages, that are both older and newer than the message with the provided ID, and the message with the ID provided will be in the middle of the set","title":"Id around","type":"string","x-stream-index":"003.011"}},{"in":"query","name":"created_at_around","schema":{"description":"The result will be a set of messages, that are both older and newer than the created_at timestamp provided, distributed evenly around the timestamp","format":"date-time","title":"Created_at around","type":"number","x-stream-index":"003.012"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRepliesResponse"}}},"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":"Get replies","tags":["product:chat"]}},"/api/v2/chat/moderation/flags/message":{"get":{"description":"Find and filter message flags\n","operationId":"QueryMessageFlags","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryMessageFlagsPayload","description":"JSON object with query message flags payload","title":"Payload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryMessageFlagsResponse"}}},"description":"QueryMessageFlagsResponse"},"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":"Query Message Flags","tags":["product:chat"]}},"/api/v2/chat/moderation/mute/channel":{"post":{"description":"Mutes channel for user\n\nSends events:\n- channel.muted\n- channel.muted\n","operationId":"MuteChannel","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteChannelResponse"}}},"description":"Successful 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":"Mute channel","tags":["product:chat"]}},"/api/v2/chat/moderation/unmute/channel":{"post":{"description":"Unmutes channel for user\n\nSends events:\n- channel.unmuted\n- channel.unmuted\n","operationId":"UnmuteChannel","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnmuteChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnmuteResponse"}}},"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":"Unmute channel","tags":["product:chat"]}},"/api/v2/chat/push_preferences":{"post":{"description":"Update the push preferences for a user and or channel member. Set to all, mentions or none\n","operationId":"UpdatePushNotificationPreferences","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertPushPreferencesRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertPushPreferencesResponse"}}},"description":"Successful 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":"Push notification preferences","tags":["product:chat"]}},"/api/v2/chat/push_templates":{"get":{"description":"Retrieve push notification templates for Chat.\n","operationId":"GetPushTemplates","parameters":[{"in":"query","name":"push_provider_name","schema":{"description":"Push provider name to filter templates","title":"string","type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"push_provider_type","required":true,"schema":{"description":"Push provider type (firebase, apn) to filter templates","enum":["firebase","apn"],"title":"string","type":"string","writeOnly":true,"x-stream-index":"003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPushTemplatesResponse"}}},"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":"Get push notification templates","tags":["product:chat"]},"post":{"description":"Create or update a push notification template for a specific event type and push provider\n","operationId":"UpsertPushTemplate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertPushTemplateRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertPushTemplateResponse"}}},"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":"Upsert a push notification template","tags":["product:chat"]}},"/api/v2/chat/query_banned_users":{"get":{"description":"Find and filter channel scoped or global user bans\n","operationId":"QueryBannedUsers","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryBannedUsersPayload","description":"JSON object with query user bans payload","title":"Payload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryBannedUsersResponse"}}},"description":"Successful 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":"Query Banned Users","tags":["product:chat"]}},"/api/v2/chat/reminders/query":{"post":{"description":"Queries reminders\n","operationId":"QueryReminders","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryRemindersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryRemindersResponse"}}},"description":"Successful 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":"Query reminders","tags":["product:chat"]}},"/api/v2/chat/search":{"get":{"description":"Search messages across channels\n","operationId":"Search","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchPayload","description":"JSON object with search payload","title":"Payload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchResponse"}}},"description":"Successful 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":"Search messages","tags":["product:chat"]}},"/api/v2/chat/segments/query":{"post":{"description":"Query segments\n","operationId":"QuerySegments","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuerySegmentsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuerySegmentsResponse"}}},"description":"Successful 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":"Query segments","tags":["product:chat"]}},"/api/v2/chat/segments/{id}":{"delete":{"description":"Delete a segment\n","operationId":"DeleteSegment","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete segment","tags":["product:chat"]},"get":{"description":"Get segment\n","operationId":"GetSegment","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetSegmentResponse"}}},"description":"Successful 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":"Get segment","tags":["product:chat"]}},"/api/v2/chat/segments/{id}/deletetargets":{"post":{"description":"Delete targets from a segment\n","operationId":"DeleteSegmentTargets","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteSegmentTargetsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete targets from a segment","tags":["product:chat"]}},"/api/v2/chat/segments/{id}/target/{target_id}":{"get":{"description":"Check whether a target exists in a segment. Returns 200 if the target exists, 404 otherwise\n","operationId":"SegmentTargetExists","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"target_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Check whether a target exists in a segment","tags":["product:chat"]}},"/api/v2/chat/segments/{id}/targets/query":{"post":{"description":"Query segment targets\n","operationId":"QuerySegmentTargets","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuerySegmentTargetsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuerySegmentTargetsResponse"}}},"description":"Successful 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":"Query segment targets","tags":["product:chat"]}},"/api/v2/chat/threads":{"post":{"description":"Returns the list of threads for specific user\n","operationId":"QueryThreads","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryThreadsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryThreadsResponse"}}},"description":"Successful 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":"Query Threads","tags":["product:chat"]}},"/api/v2/chat/threads/{message_id}":{"get":{"description":"Return a specific thread\n","operationId":"GetThread","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"reply_limit","schema":{"description":"Limit the number of replies returned","format":"int32","minimum":0,"title":"Reply limit","type":"integer","writeOnly":true,"x-stream-index":"004"}},{"in":"query","name":"participant_limit","schema":{"description":"Limit the number of participants returned","format":"int32","maximum":100,"minimum":0,"title":"Participant limit","type":"integer","writeOnly":true,"x-stream-index":"005"}},{"in":"query","name":"member_limit","schema":{"description":"Limit the number of members returned per thread channel","format":"int32","maximum":100,"minimum":0,"title":"Member limit","type":"integer","writeOnly":true,"x-stream-index":"006"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetThreadResponse"}}},"description":"Successful 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":"Get Thread","tags":["product:chat"]},"patch":{"description":"Updates certain fields of the thread\n\nSends events:\n- thread.updated\n- thread.updated\n","operationId":"UpdateThreadPartial","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateThreadPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateThreadPartialResponse"}}},"description":"Successful 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":"Partially update thread","tags":["product:chat"]}},"/api/v2/chat/unread":{"get":{"description":"Fetch unread counts for a single user\n","operationId":"UnreadCounts","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WrappedUnreadCountsResponse"}}},"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":"Unread counts","tags":["product:chat"]}},"/api/v2/chat/unread_batch":{"post":{"description":"Fetch unread counts in batch for multiple users in one call\n","operationId":"UnreadCountsBatch","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnreadCountsBatchRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnreadCountsBatchResponse"}}},"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":"Batch unread counts","tags":["product:chat"]}},"/api/v2/chat/users/{user_id}/event":{"post":{"description":"Sends a custom event to a user\n\nSends events:\n- *\n","operationId":"SendUserCustomEvent","parameters":[{"in":"path","name":"user_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendUserCustomEventRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Send user event","tags":["product:chat"]}},"/api/v2/check_push":{"post":{"description":"Sends a test message via push, this is a test endpoint to verify your push settings\n","operationId":"CheckPush","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckPushRequest"}}},"description":"CheckPushRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckPushResponse"}}},"description":"Successful 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":"Check push","tags":["product:common"]}},"/api/v2/check_sns":{"post":{"description":"Validates Amazon SNS configuration\n","operationId":"CheckSNS","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSNSRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSNSResponse"}}},"description":"Successful 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":"Check SNS","tags":["product:common"]}},"/api/v2/check_sqs":{"post":{"description":"Validates Amazon SQS credentials\n","operationId":"CheckSQS","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSQSRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSQSResponse"}}},"description":"Successful 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":"Check SQS","tags":["product:common"]}},"/api/v2/devices":{"delete":{"description":"Deletes one device\n","operationId":"DeleteDevice","parameters":[{"in":"query","name":"id","required":true,"schema":{"description":"Device ID to delete","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"user_id","schema":{"description":"**Server-side only**. User ID which server acts upon","title":"User ID","type":"string","writeOnly":true,"x-stream-index":"002.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete device","tags":["product:common"]},"get":{"description":"Returns all available devices\n","operationId":"ListDevices","parameters":[{"in":"query","name":"user_id","schema":{"description":"**Server-side only**. User ID which server acts upon","title":"User ID","type":"string","writeOnly":true,"x-stream-index":"001.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDevicesResponse"}}},"description":"ListDevicesResponse"},"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":"List devices","tags":["product:common"]},"post":{"description":"Adds a new device to a user, if the same device already exists the call will have no effect\n","operationId":"CreateDevice","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDeviceRequest"}}},"description":"CreateDeviceRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Create device","tags":["product:common"]}},"/api/v2/export/users":{"post":{"description":"Exports user profile, reactions and messages for list of given users\n","operationId":"ExportUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportUsersResponse"}}},"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":"Export users","tags":["product:common"]}},"/api/v2/external_storage":{"get":{"description":"Lists external storage\n","operationId":"ListExternalStorage","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListExternalStorageResponse"}}},"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":"List external storage","tags":["product:common"]},"post":{"description":"Creates new external storage\n","operationId":"CreateExternalStorage","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateExternalStorageRequest"}}},"description":"CreateExternalStorageRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateExternalStorageResponse"}}},"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":"Create external storage","tags":["product:common"]}},"/api/v2/external_storage/{name}":{"delete":{"description":"Deletes external storage\n","operationId":"DeleteExternalStorage","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteExternalStorageResponse"}}},"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":"Delete external storage","tags":["product:common"]},"put":{"description":"\n","operationId":"UpdateExternalStorage","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateExternalStorageRequest"}}},"description":"ExternalStorageRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateExternalStorageResponse"}}},"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":"Update External Storage","tags":["product:common"]}},"/api/v2/external_storage/{name}/check":{"get":{"description":"\n","operationId":"CheckExternalStorage","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckExternalStorageResponse"}}},"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":"Check External Storage","tags":["product:common"]}},"/api/v2/feeds/activities":{"post":{"description":"Create a new activity or update an existing one\n","operationId":"AddActivity","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddActivityRequest"}}},"description":"Activity Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddActivityResponse"}}},"description":"Add Activity 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":"Add a single activity","tags":["product:feeds"]}},"/api/v2/feeds/activities/batch":{"post":{"description":"Create new activities or update existing ones in a batch operation\n","operationId":"UpsertActivities","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertActivitiesRequest"}}},"description":"Upsert Activities Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertActivitiesResponse"}}},"description":"Upsert Activities 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":"Upsert multiple activities","tags":["product:feeds"]}},"/api/v2/feeds/activities/delete":{"post":{"description":"Delete one or more activities by their IDs\n","operationId":"DeleteActivities","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteActivitiesRequest"}}},"description":"Delete Activities Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteActivitiesResponse"}}},"description":"Delete Activities 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":"Remove multiple activities","tags":["product:feeds"]}},"/api/v2/feeds/activities/query":{"post":{"description":"Query activities based on filters with pagination and sorting options\n","operationId":"QueryActivities","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryActivitiesRequest"}}},"description":"Query Activities Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryActivitiesResponse"}}},"description":"Query Activities 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":"Query activities","tags":["product:feeds"]}},"/api/v2/feeds/activities/{activity_id}/bookmarks":{"delete":{"description":"Deletes a bookmark from an activity\n","operationId":"DeleteBookmark","parameters":[{"in":"path","name":"activity_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"folder_id","schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"003.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteBookmarkResponse"}}},"description":"Delete Bookmark 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":"Delete a bookmark","tags":["product:feeds"]},"patch":{"description":"Updates a bookmark for an activity\n","operationId":"UpdateBookmark","parameters":[{"in":"path","name":"activity_id","required":true,"schema":{"description":"ID of the activity","maxLength":255,"title":"Activity ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBookmarkRequest"}}},"description":"Update Bookmark Request","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBookmarkResponse"}}},"description":"Update Bookmark 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":"Update bookmark","tags":["product:feeds"]},"post":{"description":"Adds a bookmark to an activity\n","operationId":"AddBookmark","parameters":[{"in":"path","name":"activity_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddBookmarkRequest"}}},"description":"Add Bookmark Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddBookmarkResponse"}}},"description":"Add Bookmark 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":"Add bookmark","tags":["product:feeds"]}},"/api/v2/feeds/activities/{activity_id}/feedback":{"post":{"description":"Submit feedback for an activity including options to show less, hide, report, or mute the user\n","operationId":"ActivityFeedback","parameters":[{"in":"path","name":"activity_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivityFeedbackRequest"}}},"description":"Activity Feedback Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivityFeedbackResponse"}}},"description":"Activity Feedback 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":"Provide feedback on an activity","tags":["product:feeds"]}},"/api/v2/feeds/activities/{activity_id}/polls/{poll_id}/vote":{"post":{"description":"Cast a vote on a poll\n\nSends events:\n- feeds.poll.vote_casted\n- feeds.poll.vote_changed\n- feeds.poll.vote_removed\n- poll.vote_casted\n- poll.vote_changed\n- poll.vote_removed\n","operationId":"CastPollVote","parameters":[{"in":"path","name":"activity_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CastPollVoteRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollVoteResponse"}}},"description":"Successful 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":"Cast vote","tags":["product:feeds"]}},"/api/v2/feeds/activities/{activity_id}/polls/{poll_id}/vote/{vote_id}":{"delete":{"description":"Delete a vote from a poll\n\nSends events:\n- feeds.poll.vote_removed\n- poll.vote_removed\n","operationId":"DeletePollVote","parameters":[{"in":"path","name":"activity_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003"}},{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"004"}},{"in":"path","name":"vote_id","required":true,"schema":{"description":"Vote ID","maxLength":255,"title":"string","type":"string","x-stream-index":"005"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollVoteResponse"}}},"description":"Successful 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":"Delete vote","tags":["product:feeds"]}},"/api/v2/feeds/activities/{activity_id}/reactions":{"post":{"description":"Adds a reaction to an activity\n","operationId":"AddReaction","parameters":[{"in":"path","name":"activity_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddReactionRequest"}}},"description":"Add Reaction Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddReactionResponse"}}},"description":"Add Reaction 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":"Add reaction","tags":["product:feeds"]}},"/api/v2/feeds/activities/{activity_id}/reactions/query":{"post":{"description":"Query activity reactions\n","operationId":"QueryActivityReactions","parameters":[{"in":"path","name":"activity_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryActivityReactionsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryActivityReactionsResponse"}}},"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":"Query activity reactions","tags":["product:feeds"]}},"/api/v2/feeds/activities/{activity_id}/reactions/{type}":{"delete":{"description":"Removes a reaction from an activity\n","operationId":"DeleteActivityReaction","parameters":[{"in":"path","name":"activity_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"type","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"003.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteActivityReactionResponse"}}},"description":"Delete Activity Reaction 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":"Remove reaction","tags":["product:feeds"]}},"/api/v2/feeds/activities/{id}":{"delete":{"description":"Delete a single activity by its ID\n","operationId":"DeleteActivity","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"hard_delete","schema":{"description":"Whether to permanently delete the activity instead of soft delete","title":"boolean","type":"boolean","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteActivityResponse"}}},"description":"Delete Activity 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":"Delete a single activity","tags":["product:feeds"]},"get":{"description":"Returns activity by ID\n","operationId":"GetActivity","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetActivityResponse"}}},"description":"Get Activity 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":"Get activity","tags":["product:feeds"]},"patch":{"description":"Updates certain fields of the activity\n\nSends events:\n- feeds.activity.updated\n","operationId":"UpdateActivityPartial","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateActivityPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateActivityPartialResponse"}}},"description":"Successful 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":"Partially activity update","tags":["product:feeds"]},"put":{"description":"Replaces an activity with the provided data\n\nSends events:\n- feeds.activity.updated\n","operationId":"UpdateActivity","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateActivityRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateActivityResponse"}}},"description":"Successful 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":"Full activity update","tags":["product:feeds"]}},"/api/v2/feeds/bookmark_folders/query":{"post":{"description":"Query bookmark folders with filter query\n","operationId":"QueryBookmarkFolders","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryBookmarkFoldersRequest"}}},"description":"Query Bookmark Folders Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryBookmarkFoldersResponse"}}},"description":"Query Bookmark Folders 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":"Query bookmark folders","tags":["product:feeds"]}},"/api/v2/feeds/bookmark_folders/{folder_id}":{"delete":{"description":"Delete a bookmark folder by its ID\n","operationId":"DeleteBookmarkFolder","parameters":[{"in":"path","name":"folder_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteBookmarkFolderResponse"}}},"description":"Delete Bookmark Folder 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":"Delete a bookmark folder","tags":["product:feeds"]},"patch":{"description":"Update a bookmark folder by its ID\n","operationId":"UpdateBookmarkFolder","parameters":[{"in":"path","name":"folder_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBookmarkFolderRequest"}}},"description":"Update Bookmark Folder Request","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBookmarkFolderResponse"}}},"description":"Update Bookmark Folder 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":"Update a bookmark folder","tags":["product:feeds"]}},"/api/v2/feeds/bookmarks/query":{"post":{"description":"Query bookmarks with filter query\n","operationId":"QueryBookmarks","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryBookmarksRequest"}}},"description":"Query Bookmarks Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryBookmarksResponse"}}},"description":"Query Bookmarks 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":"Query bookmarks","tags":["product:feeds"]}},"/api/v2/feeds/comments":{"get":{"description":"Retrieve a threaded list of comments for a specific object (e.g., activity), with configurable depth, sorting, and pagination\n","operationId":"GetComments","parameters":[{"in":"query","name":"object_id","required":true,"schema":{"description":"ID of the object to get comments for","title":"Object ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"object_type","required":true,"schema":{"description":"Type of the object to get comments for","title":"Object Type","type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"depth","schema":{"description":"Maximum nested depth to return (0 = only first level)","format":"int32","maximum":5,"minimum":0,"title":"Max Depth","type":"integer","writeOnly":true,"x-stream-index":"003"}},{"in":"query","name":"sort","schema":{"description":"Sort order for the comments","enum":["first","last","top","best","controversial"],"title":"Sort Order","type":"string","writeOnly":true,"x-stream-index":"004"}},{"in":"query","name":"replies_limit","schema":{"format":"int32","maximum":20,"minimum":0,"type":"integer","writeOnly":true,"x-stream-index":"005"}},{"in":"query","name":"limit","schema":{"description":"Max number of top‑level comments to return","format":"int32","maximum":100,"minimum":0,"title":"Root Limit","type":"integer","writeOnly":true,"x-stream-index":"006.001"}},{"in":"query","name":"prev","schema":{"type":"string","writeOnly":true,"x-stream-index":"006.002"}},{"in":"query","name":"next","schema":{"type":"string","writeOnly":true,"x-stream-index":"006.003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCommentsResponse"}}},"description":"Get Comments 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":"Get comments for an object","tags":["product:feeds"]},"post":{"description":"Adds a comment to an object (e.g., activity) or a reply to an existing comment, and broadcasts appropriate events\n","operationId":"AddComment","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddCommentRequest"}}},"description":"Add Comment Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddCommentResponse"}}},"description":"Add Comment 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":"Add a comment or reply","tags":["product:feeds"]}},"/api/v2/feeds/comments/batch":{"post":{"description":"Adds multiple comments in a single request. Each comment must specify the object type and ID.\n","operationId":"AddCommentsBatch","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddCommentsBatchRequest"}}},"description":"Add Comments Batch Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddCommentsBatchResponse"}}},"description":"Add Comments Batch 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":"Add multiple comments in a batch","tags":["product:feeds"]}},"/api/v2/feeds/comments/query":{"post":{"description":"Query comments using MongoDB-style filters with pagination and sorting options\n","operationId":"QueryComments","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCommentsRequest"}}},"description":"Query Comments Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCommentsResponse"}}},"description":"Query Comments 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":"Query comments","tags":["product:feeds"]}},"/api/v2/feeds/comments/{id}":{"delete":{"description":"Deletes a comment from an object (e.g., activity) and broadcasts appropriate events\n","operationId":"DeleteComment","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"hard_delete","schema":{"description":"Whether to permanently delete the comment instead of soft delete","title":"Hard Delete","type":"boolean","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCommentResponse"}}},"description":"Delete Comment 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":"Delete a comment","tags":["product:feeds"]},"get":{"description":"Get a comment by ID\n","operationId":"GetComment","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCommentResponse"}}},"description":"Get Comment 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":"Get comment","tags":["product:feeds"]},"patch":{"description":"Updates a comment on an object (e.g., activity) and broadcasts appropriate events\n","operationId":"UpdateComment","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCommentRequest"}}},"description":"Update Comment Request","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCommentResponse"}}},"description":"Update Comment 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":"Update a comment","tags":["product:feeds"]}},"/api/v2/feeds/comments/{id}/reactions":{"post":{"description":"Adds a reaction to a comment\n","operationId":"AddCommentReaction","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddCommentReactionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddCommentReactionResponse"}}},"description":"Successful 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":"Add comment reaction","tags":["product:feeds"]}},"/api/v2/feeds/comments/{id}/reactions/query":{"post":{"description":"Query comment reactions\n","operationId":"QueryCommentReactions","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCommentReactionsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCommentReactionsResponse"}}},"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":"Query comment reactions","tags":["product:feeds"]}},"/api/v2/feeds/comments/{id}/reactions/{type}":{"delete":{"description":"Deletes a reaction from a comment\n","operationId":"DeleteCommentReaction","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"type","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"003.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCommentReactionResponse"}}},"description":"Delete Comment Reaction 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":"Delete comment reaction","tags":["product:feeds"]}},"/api/v2/feeds/comments/{id}/replies":{"get":{"description":"Retrieve a threaded list of replies for a single comment, with configurable depth, sorting, and pagination\n","operationId":"GetCommentReplies","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"depth","schema":{"description":"Maximum nested depth to return (0 = unlimited)","format":"int32","maximum":5,"minimum":0,"title":"Max Depth","type":"integer","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"sort","schema":{"description":"first (oldest), last (newest) or top","enum":["first","last","top","best","controversial"],"title":"Sort Order","type":"string","writeOnly":true,"x-stream-index":"003"}},{"in":"query","name":"replies_limit","schema":{"description":"Max number of replies to return","format":"int32","minimum":0,"title":"Replies Limit","type":"integer","writeOnly":true,"x-stream-index":"004"}},{"in":"query","name":"limit","schema":{"description":"Max number of direct replies to return","format":"int32","maximum":100,"minimum":0,"title":"Reply Limit","type":"integer","writeOnly":true,"x-stream-index":"005.001"}},{"in":"query","name":"prev","schema":{"type":"string","writeOnly":true,"x-stream-index":"005.002"}},{"in":"query","name":"next","schema":{"type":"string","writeOnly":true,"x-stream-index":"005.003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCommentRepliesResponse"}}},"description":"Get Comment Replies 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":"Get replies for a comment","tags":["product:feeds"]}},"/api/v2/feeds/feed_groups":{"get":{"description":"List all feed groups for the application\n","operationId":"ListFeedGroups","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListFeedGroupsResponse"}}},"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":"List all feed groups","tags":["product:feeds"]},"post":{"description":"Creates a new feed group with the specified configuration\n","operationId":"CreateFeedGroup","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFeedGroupRequest"}}},"description":"Create Feed Group Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFeedGroupResponse"}}},"description":"Upsert Feed Group 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":"Create a new feed group","tags":["product:feeds"]}},"/api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}":{"delete":{"description":"Delete a single feed by its ID\n","operationId":"DeleteFeed","parameters":[{"in":"path","name":"feed_group_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"feed_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"hard_delete","schema":{"description":"Whether to permanently delete the feed instead of soft delete","title":"boolean","type":"boolean","writeOnly":true,"x-stream-index":"003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteFeedResponse"}}},"description":"Delete Feed 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":"Delete a single feed","tags":["product:feeds"]},"post":{"description":"Create a single feed for a given feed group\n","operationId":"GetOrCreateFeed","parameters":[{"in":"path","name":"feed_group_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"feed_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrCreateFeedRequest"}}},"description":"ClientRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrCreateFeedResponse"}}},"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":"Create a new feed","tags":["product:feeds"]},"put":{"description":"Update an existing feed\n","operationId":"UpdateFeed","parameters":[{"in":"path","name":"feed_group_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"feed_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFeedRequest"}}},"description":"Update Feed Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFeedResponse"}}},"description":"Update Feed 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":"Update a feed","tags":["product:feeds"]}},"/api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/activities/mark/batch":{"post":{"description":"Mark activities as read/seen/watched. Can mark by timestamp (seen), activity IDs (read), or all as read.\n","operationId":"MarkActivity","parameters":[{"in":"path","name":"feed_group_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"feed_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkActivityRequest"}}},"description":"Mark Activity Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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 activities as read/seen/watched","tags":["product:feeds"]}},"/api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/activities/{activity_id}/pin":{"delete":{"description":"Unpin an activity from a feed. This removes the pin, so the activity will no longer be displayed at the top of the feed.\n","operationId":"UnpinActivity","parameters":[{"in":"path","name":"feed_group_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"feed_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"path","name":"activity_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"004.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnpinActivityResponse"}}},"description":"Unpin Activity 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":"Unpin an activity from a feed","tags":["product:feeds"]},"post":{"description":"Pin an activity to a feed. Pinned activities are typically displayed at the top of a feed.\n","operationId":"PinActivity","parameters":[{"in":"path","name":"feed_group_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"feed_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"path","name":"activity_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PinActivityRequest"}}},"description":"Pin Activity Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PinActivityResponse"}}},"description":"Pin Activity 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":"Pin an activity to a feed","tags":["product:feeds"]}},"/api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/members":{"patch":{"description":"Add, remove, or set members for a feed\n","operationId":"UpdateFeedMembers","parameters":[{"in":"path","name":"feed_group_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"feed_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFeedMembersRequest"}}},"description":"Update Feed Members Request","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFeedMembersResponse"}}},"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":"Update feed members","tags":["product:feeds"]}},"/api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/members/accept":{"post":{"description":"Accepts a pending feed member request\n","operationId":"AcceptFeedMemberInvite","parameters":[{"in":"path","name":"feed_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"feed_group_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcceptFeedMemberInviteRequest"}}},"description":"Accept Feed Member Invite Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcceptFeedMemberInviteResponse"}}},"description":"Accept Feed Member Invite 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":"Accept a feed member request","tags":["product:feeds"]}},"/api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/members/query":{"post":{"description":"Query feed members based on filters with pagination and sorting options\n","operationId":"QueryFeedMembers","parameters":[{"in":"path","name":"feed_group_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"feed_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryFeedMembersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryFeedMembersResponse"}}},"description":"Successful 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":"Query feed members","tags":["product:feeds"]}},"/api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/members/reject":{"post":{"description":"Rejects a pending feed member request\n","operationId":"RejectFeedMemberInvite","parameters":[{"in":"path","name":"feed_group_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"feed_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RejectFeedMemberInviteRequest"}}},"description":"Reject Feed Member Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RejectFeedMemberInviteResponse"}}},"description":"Reject Feed Member 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":"Reject an invite to become a feed member","tags":["product:feeds"]}},"/api/v2/feeds/feed_groups/{feed_group_id}/follow_suggestions":{"get":{"description":"Get follow suggestions for a feed group\n","operationId":"GetFollowSuggestions","parameters":[{"in":"path","name":"feed_group_id","required":true,"schema":{"description":"The ID of the feed group to get suggestions for","maxLength":255,"title":"Feed Group ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"limit","schema":{"description":"Maximum number of suggestions to return","format":"int32","maximum":100,"minimum":1,"title":"Limit","type":"integer","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"description":"The ID of the user requesting suggestions (optional, defaults to current user)","title":"User ID","type":"string","writeOnly":true,"x-stream-index":"003.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetFollowSuggestionsResponse"}}},"description":"Follow Suggestions 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":"Get follow suggestions","tags":["product:feeds"]}},"/api/v2/feeds/feed_groups/{id}":{"delete":{"description":"Delete a feed group by its ID. Can perform a soft delete (default) or hard delete.\n","operationId":"DeleteFeedGroup","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"hard_delete","schema":{"description":"Whether to perform a hard delete (true) or soft delete (false, default)","title":"boolean","type":"boolean","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteFeedGroupResponse"}}},"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":"Delete a feed group","tags":["product:feeds"]},"get":{"description":"Get a feed group by ID\n","operationId":"GetFeedGroup","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetFeedGroupResponse"}}},"description":"Get Feed Group 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":"Get a feed group","tags":["product:feeds"]},"post":{"description":"Get an existing feed group or create a new one if it doesn't exist\n","operationId":"GetOrCreateFeedGroup","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Unique identifier for the feed group","maxLength":255,"title":"Feed Group ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrCreateFeedGroupRequest"}}},"description":"Get Or Create Feed Group Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrCreateFeedGroupResponse"}}},"description":"Get Or Create Feed Group 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":"Get or create a feed group","tags":["product:feeds"]},"put":{"description":"Update a feed group by ID\n","operationId":"UpdateFeedGroup","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFeedGroupRequest"}}},"description":"Update Feed Group Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFeedGroupResponse"}}},"description":"Update Feed Group 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":"Update a feed group","tags":["product:feeds"]}},"/api/v2/feeds/feed_views":{"get":{"description":"List all feed views for a feed group\n","operationId":"ListFeedViews","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListFeedViewsResponse"}}},"description":"List Feed Views 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":"List all feed views","tags":["product:feeds"]},"post":{"description":"Create a custom view for a feed group with specific selectors, ranking, or aggregation options\n","operationId":"CreateFeedView","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFeedViewRequest"}}},"description":"Create Feed View Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFeedViewResponse"}}},"description":"Create Feed View 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":"Create a new feed view","tags":["product:feeds"]}},"/api/v2/feeds/feed_views/{id}":{"delete":{"description":"Delete an existing custom feed view\n","operationId":"DeleteFeedView","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteFeedViewResponse"}}},"description":"Delete Feed View 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":"Delete a feed view","tags":["product:feeds"]},"get":{"description":"Get a feed view by its ID\n","operationId":"GetFeedView","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetFeedViewResponse"}}},"description":"Get Feed View 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":"Get a feed view","tags":["product:feeds"]},"post":{"description":"Get an existing feed view or create a new one if it doesn't exist\n","operationId":"GetOrCreateFeedView","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrCreateFeedViewRequest"}}},"description":"Get Or Create Feed View Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrCreateFeedViewResponse"}}},"description":"Get Or Create Feed View 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":"Get or create a feed view","tags":["product:feeds"]},"put":{"description":"Update an existing custom feed view with new selectors, ranking, or aggregation options\n","operationId":"UpdateFeedView","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFeedViewRequest"}}},"description":"Update Feed View Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFeedViewResponse"}}},"description":"Update Feed View 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":"Update a feed view","tags":["product:feeds"]}},"/api/v2/feeds/feeds/batch":{"post":{"description":"Create multiple feeds at once for a given feed group\n","operationId":"CreateFeedsBatch","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFeedsBatchRequest"}}},"description":"Create Feeds Batch Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFeedsBatchResponse"}}},"description":"Create Feeds Batch 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":"Create multiple feeds at once","tags":["product:feeds"]}},"/api/v2/feeds/feeds/query":{"post":{"description":"Query feeds with filter query\n","operationId":"QueryFeeds","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryFeedsRequest"}}},"description":"Query Feeds Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryFeedsResponse"}}},"description":"Query Feeds 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":"Query feeds","tags":["product:feeds"]}},"/api/v2/feeds/follows":{"patch":{"description":"Updates a follow's custom data, push preference, and follower role. Source owner can update custom data and push preference. Target owner can update follower role.\n","operationId":"UpdateFollow","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFollowRequest"}}},"description":"Update Follow Request","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFollowResponse"}}},"description":"Update Follow 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":"Update a follow","tags":["product:feeds"]},"post":{"description":"Creates a follow and broadcasts FollowAddedEvent\n","operationId":"Follow","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FollowRequest"}}},"description":"Follow Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SingleFollowResponse"}}},"description":"Follow 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":"Create a follow","tags":["product:feeds"]}},"/api/v2/feeds/follows/accept":{"post":{"description":"Accepts a pending follow request\n","operationId":"AcceptFollow","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcceptFollowRequest"}}},"description":"Accept Follow Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcceptFollowResponse"}}},"description":"Accept Follow 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":"Accept a follow request","tags":["product:feeds"]}},"/api/v2/feeds/follows/batch":{"post":{"description":"Creates multiple follows at once and broadcasts FollowAddedEvent for each follow\n","operationId":"FollowBatch","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FollowBatchRequest"}}},"description":"Follow Batch Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FollowBatchResponse"}}},"description":"Follow Batch 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":"Create multiple follows at once","tags":["product:feeds"]}},"/api/v2/feeds/follows/query":{"post":{"description":"Query follows based on filters with pagination and sorting options\n","operationId":"QueryFollows","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryFollowsRequest"}}},"description":"Query Follows Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryFollowsResponse"}}},"description":"Query Follows 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":"Query follows","tags":["product:feeds"]}},"/api/v2/feeds/follows/reject":{"post":{"description":"Rejects a pending follow request\n","operationId":"RejectFollow","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RejectFollowRequest"}}},"description":"Reject Follow Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RejectFollowResponse"}}},"description":"Reject Follow 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":"Reject a follow request","tags":["product:feeds"]}},"/api/v2/feeds/follows/{source}/{target}":{"delete":{"description":"Removes a follow and broadcasts FollowRemovedEvent\n","operationId":"Unfollow","parameters":[{"in":"path","name":"source","required":true,"schema":{"description":"Fully qualified ID of the source feed","maxLength":255,"title":"Source Feed","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"target","required":true,"schema":{"description":"Fully qualified ID of the target feed","maxLength":255,"title":"Target Feed","type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnfollowResponse"}}},"description":"Unfollow 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":"Unfollow a feed","tags":["product:feeds"]}},"/api/v2/feeds/membership_levels":{"post":{"description":"Create a new membership level with tag-based access controls\n","operationId":"CreateMembershipLevel","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateMembershipLevelRequest"}}},"description":"Create Membership Level Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateMembershipLevelResponse"}}},"description":"Create Membership Level 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":"Create membership level","tags":["product:feeds"]}},"/api/v2/feeds/membership_levels/query":{"post":{"description":"Query membership levels with filter query\n","operationId":"QueryMembershipLevels","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryMembershipLevelsRequest"}}},"description":"Query Membership Levels Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryMembershipLevelsResponse"}}},"description":"Query Membership Levels 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":"Query membership levels","tags":["product:feeds"]}},"/api/v2/feeds/membership_levels/{id}":{"delete":{"description":"Delete a membership level by its UUID. This operation is irreversible.\n","operationId":"DeleteMembershipLevel","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"The UUID of the membership level to delete","maxLength":255,"title":"string","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete membership level","tags":["product:feeds"]},"patch":{"description":"Update a membership level with partial updates. Only specified fields will be updated.\n","operationId":"UpdateMembershipLevel","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMembershipLevelRequest"}}},"description":"Update Membership Level Request","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMembershipLevelResponse"}}},"description":"Update Membership Level 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":"Update membership level","tags":["product:feeds"]}},"/api/v2/feeds/unfollow/batch":{"post":{"description":"Removes multiple follows at once and broadcasts FollowRemovedEvent for each one\n","operationId":"UnfollowBatch","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnfollowBatchRequest"}}},"description":"Unfollow Batch Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnfollowBatchResponse"}}},"description":"Unfollow Batch 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":"Unfollow multiple feeds at once","tags":["product:feeds"]}},"/api/v2/feeds/users/{user_id}/delete":{"delete":{"description":"Delete all activities, reactions, comments, and bookmarks for a user\n","operationId":"DeleteFeedUserData","parameters":[{"in":"path","name":"user_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteFeedUserDataResponse"}}},"description":"Successful 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":"Delete all feed data for a user","tags":["product:feeds"]}},"/api/v2/feeds/users/{user_id}/export":{"post":{"description":"Export all activities, reactions, comments, and bookmarks for a user\n","operationId":"ExportFeedUserData","parameters":[{"in":"path","name":"user_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportFeedUserDataResponse"}}},"description":"Successful 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":"Export all feed data for a user","tags":["product:feeds"]}},"/api/v2/guest":{"post":{"description":"\n","operationId":"CreateGuest","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGuestRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGuestResponse"}}},"description":"Successful 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":"Create Guest","tags":["product:common"]}},"/api/v2/import_urls":{"post":{"description":"Creates a new import URL\n","operationId":"CreateImportURL","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateImportURLRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateImportURLResponse"}}},"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":"Create import URL","tags":["product:common"]}},"/api/v2/imports":{"get":{"description":"Gets an import\n","operationId":"ListImports","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListImportsResponse"}}},"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":"Get import","tags":["product:common"]},"post":{"description":"Creates a new import\n","operationId":"CreateImport","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateImportRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateImportResponse"}}},"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":"Create import","tags":["product:common"]}},"/api/v2/imports/{id}":{"get":{"description":"Gets an import\n","operationId":"GetImport","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetImportResponse"}}},"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":"Get import","tags":["product:common"]}},"/api/v2/moderation/ban":{"post":{"description":"Ban a user from a channel or the entire app\n","operationId":"ban","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BanRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BanResponse"}}},"description":"Successful 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":"Ban","tags":["product:moderation"]}},"/api/v2/moderation/bulk_image_moderation":{"post":{"description":"Moderate multiple images in bulk using a CSV file\n","operationId":"bulk_image_moderation","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkImageModerationRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkImageModerationResponse"}}},"description":"Successful 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":"Bulk image moderation","tags":["product:moderation"]}},"/api/v2/moderation/check":{"post":{"description":"Run moderation checks on the provided content\n","operationId":"check","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckResponse"}}},"description":"Successful 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":"Check","tags":["product:moderation"]}},"/api/v2/moderation/config":{"post":{"description":"Create a new moderation configuration or update an existing one. Configure settings for content filtering, AI analysis, toxicity detection, and other moderation features.\n","operationId":"upsert_config","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertConfigRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertConfigResponse"}}},"description":"Successful 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":"Create or update moderation configuration","tags":["product:moderation"]}},"/api/v2/moderation/config/{key}":{"delete":{"description":"Delete a specific moderation policy by its name\n","operationId":"delete_config","parameters":[{"in":"path","name":"key","required":true,"schema":{"description":"Key of the moderation configuration to delete","title":"Key","type":"string","x-stream-index":"001"}},{"in":"query","name":"team","schema":{"description":"Team associated with the configuration","title":"Team","type":"string","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteModerationConfigResponse"}}},"description":"Successful 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":"Delete a moderation policy","tags":["product:moderation"]},"get":{"description":"Retrieve a specific moderation configuration by its key and team. This configuration contains settings for various moderation features like toxicity detection, AI analysis, and filtering rules.\n","operationId":"get_config","parameters":[{"in":"path","name":"key","required":true,"schema":{"description":"Key of the moderation configuration to retrieve","title":"Key","type":"string","x-stream-index":"001"}},{"in":"query","name":"team","schema":{"description":"Team associated with the configuration","title":"Team","type":"string","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetConfigResponse"}}},"description":"Successful 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":"Get moderation configuration","tags":["product:moderation"]}},"/api/v2/moderation/configs":{"post":{"description":"Search and filter moderation configurations across your application. This endpoint is designed for building moderation dashboards and managing multiple configuration sets.\n","operationId":"query_moderation_configs","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationConfigsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationConfigsResponse"}}},"description":"Successful 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":"Query moderation configurations","tags":["product:moderation"]}},"/api/v2/moderation/custom_check":{"post":{"description":"Custom check, add your own AI model reports to the review queue\n","operationId":"custom_check","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomCheckRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomCheckResponse"}}},"description":"Successful 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":"Custom check endpoint","tags":["product:moderation"]}},"/api/v2/moderation/feeds_moderation_template":{"delete":{"description":"Delete a specific moderation template by its name\n","operationId":"V2DeleteTemplate","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteModerationTemplateResponse"}}},"description":"Successful 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":"Delete a moderation template","tags":["product:moderation"]},"get":{"description":"Retrieve a list of feed moderation templates that define preset moderation rules and configurations. Limited to 100 templates per request.\n","operationId":"V2QueryTemplates","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryFeedModerationTemplatesResponse"}}},"description":"Successful 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":"Query feed moderation templates","tags":["product:moderation"]},"post":{"description":"Upsert feeds template for moderation\n","operationId":"V2UpsertTemplate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertModerationTemplateRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertModerationTemplateResponse"}}},"description":"Successful 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":"Upsert feeds template","tags":["product:moderation"]}},"/api/v2/moderation/flag":{"post":{"description":"Flag any type of content (messages, users, channels, activities) for moderation review. Supports custom content types and additional metadata for flagged content.\n","operationId":"flag","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlagRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlagResponse"}}},"description":"Successful 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":"Flag content for moderation","tags":["product:moderation"]}},"/api/v2/moderation/flags":{"post":{"description":"Query flags associated with moderation items. This is used for building a moderation dashboard.\n","operationId":"query_moderation_flags","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationFlagsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationFlagsResponse"}}},"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":"Query moderation flags","tags":["product:moderation"]}},"/api/v2/moderation/logs":{"post":{"description":"Search and filter moderation action logs with support for pagination. View the history of moderation actions taken, including who performed them and when.\n","operationId":"query_moderation_logs","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationLogsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationLogsResponse"}}},"description":"Successful 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":"Query moderation action logs","tags":["product:moderation"]}},"/api/v2/moderation/moderation_rule":{"post":{"description":"Create or update a moderation rule that can apply app-wide or to specific moderation configs\n","operationId":"upsert_moderation_rule","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertModerationRuleRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertModerationRuleResponse"}}},"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":"Upsert moderation rule","tags":["product:moderation"]}},"/api/v2/moderation/moderation_rule/{id}":{"delete":{"description":"Delete an existing moderation rule\n","operationId":"delete_moderation_rule","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteModerationRuleResponse"}}},"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":"Delete moderation rule","tags":["product:moderation"]},"get":{"description":"Get a specific moderation rule by ID\n","operationId":"get_moderation_rule","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetModerationRuleResponse"}}},"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":"Get moderation rule","tags":["product:moderation"]}},"/api/v2/moderation/moderation_rules":{"post":{"description":"Search and filter moderation rules across your application. This endpoint is designed for building moderation dashboards and managing multiple rule sets.\n","operationId":"query_moderation_rules","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationRulesRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationRulesResponse"}}},"description":"Successful 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":"Query moderation rules","tags":["product:moderation"]}},"/api/v2/moderation/mute":{"post":{"description":"Mute a user. Mutes are generally not visible to the user you mute, while block is something you notice.\n","operationId":"mute","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteRequest"}}},"description":"MuteRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteResponse"}}},"description":"MuteResponse"},"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":"Mute","tags":["product:moderation"]}},"/api/v2/moderation/review_queue":{"post":{"description":"Query review queue items allows you to filter the review queue items. This is used for building a moderation dashboard.\n","operationId":"query_review_queue","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryReviewQueueRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryReviewQueueResponse"}}},"description":"Successful 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":"Query review queue items","tags":["product:moderation"]}},"/api/v2/moderation/review_queue/{id}":{"get":{"description":"Retrieve a specific review queue item by its ID\n","operationId":"get_review_queue_item","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Unique identifier of the review queue item to retrieve","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetReviewQueueItemResponse"}}},"description":"Successful 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":"Get review queue item","tags":["product:moderation"]}},"/api/v2/moderation/submit_action":{"post":{"description":"Take action on flagged content, such as marking content as safe, deleting content, banning users, or executing custom moderation actions. Supports various action types with configurable parameters.\n","operationId":"submit_action","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitActionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitActionResponse"}}},"description":"Successful 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":"Submit moderation action","tags":["product:moderation"]}},"/api/v2/moderation/unban":{"post":{"description":"Unban a user from a channel or globally.\n","operationId":"unban","parameters":[{"in":"query","name":"target_user_id","required":true,"schema":{"description":"ID of the user to unban","title":"Target User ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"channel_cid","schema":{"description":"Channel where the unban applies","title":"Channel CID","type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"created_by","schema":{"description":"ID of the user who created the ban","title":"Created By","type":"string","writeOnly":true,"x-stream-index":"003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnbanRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnbanResponse"}}},"description":"Successful 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":"Unban","tags":["product:moderation"]}},"/api/v2/moderation/unmute":{"post":{"description":"Unmute a user\n","operationId":"unmute","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnmuteRequest"}}},"description":"UnmuteRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnmuteResponse"}}},"description":"UnmuteResponse"},"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":"Unmute a user","tags":["product:moderation"]}},"/api/v2/og":{"get":{"description":"Get an OpenGraph attachment for a link\n","operationId":"GetOG","parameters":[{"in":"query","name":"url","required":true,"schema":{"description":"URL to be scraped","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOGResponse"}}},"description":"Get OG Attachment"},"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":"Get OG","tags":["product:common"]}},"/api/v2/permissions":{"get":{"description":"Lists all available permissions\n","operationId":"ListPermissions","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPermissionsResponse"}}},"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":"List permissions","tags":["product:common"]}},"/api/v2/permissions/{id}":{"get":{"description":"Gets custom permission\n","operationId":"GetPermission","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Permission ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCustomPermissionResponse"}}},"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":"Get permission","tags":["product:common"]}},"/api/v2/polls":{"post":{"description":"Creates a new poll\n","operationId":"CreatePoll","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePollRequest"}}},"description":"Create Poll Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Create poll","tags":["product:common"]},"put":{"description":"Updates a poll\n\nSends events:\n- feeds.poll.closed\n- feeds.poll.updated\n- poll.closed\n- poll.updated\n","operationId":"UpdatePoll","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePollRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Update poll","tags":["product:common"]}},"/api/v2/polls/query":{"post":{"description":"Queries polls\n","operationId":"QueryPolls","parameters":[{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryPollsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryPollsResponse"}}},"description":"Successful 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":"Query polls","tags":["product:common"]}},"/api/v2/polls/{poll_id}":{"delete":{"description":"Deletes a poll\n\nSends events:\n- feeds.poll.deleted\n- poll.deleted\n","operationId":"DeletePoll","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete poll","tags":["product:common"]},"get":{"description":"Retrieves a poll\n","operationId":"GetPoll","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Get poll","tags":["product:common"]},"patch":{"description":"Updates a poll partially\n\nSends events:\n- feeds.poll.closed\n- feeds.poll.updated\n- poll.closed\n- poll.updated\n","operationId":"UpdatePollPartial","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePollPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Partial update poll","tags":["product:common"]}},"/api/v2/polls/{poll_id}/options":{"post":{"description":"Creates a poll option\n\nSends events:\n- feeds.poll.updated\n- poll.updated\n","operationId":"CreatePollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePollOptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollOptionResponse"}}},"description":"Successful 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":"Create poll option","tags":["product:common"]},"put":{"description":"Updates a poll option\n\nSends events:\n- feeds.poll.updated\n- poll.updated\n","operationId":"UpdatePollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePollOptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollOptionResponse"}}},"description":"Successful 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":"Update poll option","tags":["product:common"]}},"/api/v2/polls/{poll_id}/options/{option_id}":{"delete":{"description":"Deletes a poll option\n\nSends events:\n- feeds.poll.updated\n- poll.updated\n","operationId":"DeletePollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"path","name":"option_id","required":true,"schema":{"description":"Option ID","maxLength":255,"title":"string","type":"string","x-stream-index":"003"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete poll option","tags":["product:common"]},"get":{"description":"Retrieves a poll option\n","operationId":"GetPollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"path","name":"option_id","required":true,"schema":{"description":"Option ID","maxLength":255,"title":"string","type":"string","x-stream-index":"003"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollOptionResponse"}}},"description":"Successful 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":"Get poll option","tags":["product:common"]}},"/api/v2/polls/{poll_id}/votes":{"post":{"description":"Queries votes\n","operationId":"QueryPollVotes","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryPollVotesRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollVotesResponse"}}},"description":"Successful 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":"Query votes","tags":["product:common"]}},"/api/v2/push_providers":{"get":{"description":"List details of all push providers.\n","operationId":"ListPushProviders","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPushProvidersResponse"}}},"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":"List push providers","tags":["product:common"]},"post":{"description":"Upsert a push provider for v2 with multi bundle/package support\n","operationId":"UpsertPushProvider","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertPushProviderRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertPushProviderResponse"}}},"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":"Upsert a push provider","tags":["product:common"]}},"/api/v2/push_providers/{type}/{name}":{"delete":{"description":"Delete a push provider from v2 with multi bundle/package support. v1 isn't supported in this endpoint\n","operationId":"DeletePushProvider","parameters":[{"in":"path","name":"type","required":true,"schema":{"enum":["apn","firebase","huawei","xiaomi"],"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"name","required":true,"schema":{"maxLength":36,"minLength":1,"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete a push provider","tags":["product:common"]}},"/api/v2/rate_limits":{"get":{"description":"Get rate limits usage and quotas\n","operationId":"GetRateLimits","parameters":[{"in":"query","name":"server_side","schema":{"description":"Whether to include server-side platform limits or not","title":"Server-side","type":"boolean","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"android","schema":{"description":"Whether to include Android platform limits or not","title":"Android","type":"boolean","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"ios","schema":{"description":"Whether to include iOS platform limits or not","title":"iOS","type":"boolean","writeOnly":true,"x-stream-index":"003"}},{"in":"query","name":"web","schema":{"description":"Whether to include web platform limits or not","title":"Web","type":"boolean","writeOnly":true,"x-stream-index":"004"}},{"in":"query","name":"endpoints","schema":{"description":"Specific endpoints to show limits for, as a comma-separated list of values","title":"Endpoints","type":"string","writeOnly":true,"x-stream-index":"005"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRateLimitsResponse"}}},"description":"Get Rate Limits 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":"Get rate limits","tags":["product:common"]}},"/api/v2/roles":{"get":{"description":"Lists all available roles\n","operationId":"ListRoles","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListRolesResponse"}}},"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":"List roles","tags":["product:common"]},"post":{"description":"Creates custom role\n","operationId":"CreateRole","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRoleRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRoleResponse"}}},"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":"Create role","tags":["product:common"]}},"/api/v2/roles/{name}":{"delete":{"description":"Deletes custom role\n","operationId":"DeleteRole","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Role name","title":"Name","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete role","tags":["product:common"]}},"/api/v2/tasks/{id}":{"get":{"description":"Gets status of a task\n","operationId":"GetTask","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Task ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetTaskResponse"}}},"description":"Get Task 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":"Get status of a task","tags":["product:common"]}},"/api/v2/uploads/file":{"delete":{"description":"Deletes previously uploaded file\n","operationId":"DeleteFileGlobal","parameters":[{"in":"query","name":"url","schema":{"description":"File URL to delete","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete file","tags":["product:common"],"x-stream-sdk-name":"DeleteFile"},"post":{"description":"Uploads file\n","operationId":"UploadFileGlobal","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/FileUploadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileUploadResponse"}}},"description":"Successful 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":"Upload file","tags":["product:common"],"x-stream-sdk-name":"UploadFile"}},"/api/v2/uploads/image":{"delete":{"description":"Deletes previously uploaded image\n","operationId":"DeleteImageGlobal","parameters":[{"in":"query","name":"url","schema":{"description":"File URL to delete","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete image","tags":["product:common"],"x-stream-sdk-name":"DeleteImage"},"post":{"description":"Uploads image\n","operationId":"UploadImageGlobal","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/ImageUploadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageUploadResponse"}}},"description":"Successful 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":"Upload image","tags":["product:common"],"x-stream-sdk-name":"UploadImage"}},"/api/v2/users":{"get":{"description":"Find and filter users\n","operationId":"QueryUsers","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryUsersPayload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryUsersResponse"}}},"description":"Successful 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":"Query users","tags":["product:common"]},"patch":{"description":"Updates certain fields of the user\n\nSends events:\n- user.presence.changed\n- user.updated\n- user.presence.changed\n","operationId":"UpdateUsersPartial","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersResponse"}}},"description":"Successful 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":"Partially update user","tags":["product:common"]},"post":{"description":"Update or create users in bulk\n\nSends events:\n- user.updated\n","operationId":"UpdateUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersResponse"}}},"description":"Successful 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":"Upsert users","tags":["product:common"]}},"/api/v2/users/block":{"get":{"description":"Get list of blocked Users\n","operationId":"GetBlockedUsers","parameters":[{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBlockedUsersResponse"}}},"description":"Successful 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":"Get list of blocked Users","tags":["product:common"]},"post":{"description":"Block users\n","operationId":"BlockUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUsersResponse"}}},"description":"Successful 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":"Block user","tags":["product:common"]}},"/api/v2/users/deactivate":{"post":{"description":"Deactivate users in batches\n\nSends events:\n- user.deactivated\n","operationId":"DeactivateUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeactivateUsersRequest"}}},"description":"DeactivateUsersRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeactivateUsersResponse"}}},"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":"Deactivate users","tags":["product:common"]}},"/api/v2/users/delete":{"post":{"description":"Deletes users and optionally all their belongings asynchronously.\n\nSends events:\n- channel.deleted\n- user.deleted\n","operationId":"DeleteUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteUsersResponse"}}},"description":"Successful 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":"Delete Users","tags":["product:common"]}},"/api/v2/users/live_locations":{"get":{"description":"Retrieves all active live locations for a user\n","operationId":"GetUserLiveLocations","parameters":[{"in":"query","name":"user_id","schema":{"description":"User ID to get live locations for. If not provided, returns live locations for the authenticated user.","title":"string","type":"string","writeOnly":true,"x-stream-index":"001.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SharedLocationsResponse"}}},"description":"Successful 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":"Get user live locations","tags":["product:common"]},"put":{"description":"Updates an existing live location with new coordinates or expiration time\n","operationId":"UpdateLiveLocation","parameters":[{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"005.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateLiveLocationRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SharedLocationResponse"}}},"description":"Successful 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":"Update live location","tags":["product:common"]}},"/api/v2/users/reactivate":{"post":{"description":"Reactivate users in batches\n\nSends events:\n- user.reactivated\n- user.reactivated\n","operationId":"ReactivateUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReactivateUsersRequest"}}},"description":"ReactivateUsersRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReactivateUsersResponse"}}},"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":"Reactivate users","tags":["product:common"]}},"/api/v2/users/restore":{"post":{"description":"Restore soft deleted users\n","operationId":"RestoreUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestoreUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Restore users","tags":["product:common"]}},"/api/v2/users/unblock":{"post":{"description":"Unblock users\n","operationId":"UnblockUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUsersResponse"}}},"description":"Successful 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":"Unblock user","tags":["product:common"]}},"/api/v2/users/{user_id}/deactivate":{"post":{"description":"Deactivates user with possibility to activate it back\n\nSends events:\n- user.deactivated\n","operationId":"DeactivateUser","parameters":[{"in":"path","name":"user_id","required":true,"schema":{"title":"User ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeactivateUserRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeactivateUserResponse"}}},"description":"Successful 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":"Deactivate user","tags":["product:common"]}},"/api/v2/users/{user_id}/export":{"get":{"description":"Exports the user's profile, reactions and messages. Raises an error if a user has more than 10k messages or reactions\n","operationId":"ExportUser","parameters":[{"in":"path","name":"user_id","required":true,"schema":{"title":"User ID","type":"string","x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportUserResponse"}}},"description":"Successful 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":"Export user","tags":["product:common"]}},"/api/v2/users/{user_id}/reactivate":{"post":{"description":"Activates user who's been deactivated previously\n\nSends events:\n- user.reactivated\n","operationId":"ReactivateUser","parameters":[{"in":"path","name":"user_id","required":true,"schema":{"title":"User ID","type":"string","x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReactivateUserRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReactivateUserResponse"}}},"description":"Successful 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":"Reactivate user","tags":["product:common"]}},"/api/v2/video/active_calls_status":{"get":{"description":"Get the current status of all active calls including metrics and summary information\n","operationId":"GetActiveCallsStatus","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetActiveCallsStatusResponse"}}},"description":"GetActiveCallsStatusResponse"},"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":"Get active calls status","tags":["product:video"]}},"/api/v2/video/call/feedback":{"post":{"description":"\n","operationId":"QueryUserFeedback","parameters":[{"in":"query","name":"full","schema":{"type":"boolean","writeOnly":true,"x-stream-index":"003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryUserFeedbackRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryUserFeedbackResponse"}}},"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":"Query user reported feedback for the calls","tags":["product:video"]}},"/api/v2/video/call/members":{"post":{"description":"Query call members with filter query\n","operationId":"QueryCallMembers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallMembersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallMembersResponse"}}},"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":"Query call members","tags":["product:video"]}},"/api/v2/video/call/stats":{"post":{"description":"\n","operationId":"QueryCallStats","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallStatsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallStatsResponse"}}},"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":"Query Call Stats","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}":{"get":{"description":"\n","operationId":"GetCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"query","name":"members_limit","schema":{"format":"int32","maximum":100,"minimum":0,"type":"integer","writeOnly":true,"x-stream-index":"004"}},{"in":"query","name":"ring","schema":{"type":"boolean","writeOnly":true,"x-stream-index":"005"}},{"in":"query","name":"notify","schema":{"type":"boolean","writeOnly":true,"x-stream-index":"006"}},{"in":"query","name":"video","schema":{"type":"boolean","writeOnly":true,"x-stream-index":"007"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCallResponse"}}},"description":"GetCallResponse"},"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":"Get Call","tags":["product:video"]},"patch":{"description":"\n\nSends events:\n- call.updated\n","operationId":"UpdateCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallRequest"}}},"description":"UpdateCallRequest","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallResponse"}}},"description":"UpdateCallResponse"},"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":"Update Call","tags":["product:video"]},"post":{"description":"Gets or creates a new call\n\nSends events:\n- call.created\n- call.notification\n- call.ring\n","operationId":"GetOrCreateCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrCreateCallRequest"}}},"description":"GetOrCreateCallRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrCreateCallResponse"}}},"description":"GetOrCreateCallResponse"},"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":"Get or create a call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/block":{"post":{"description":"Block a user, preventing them from joining the call until they are unblocked.\n\nSends events:\n- call.blocked_user\n","operationId":"BlockUser","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUserRequest"}}},"description":"BlockUserRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUserResponse"}}},"description":"BlockUserResponse"},"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":"Block user on a call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/delete":{"post":{"description":"\n\nSends events:\n- call.deleted\n","operationId":"DeleteCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCallRequest"}}},"description":"DeleteCallRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCallResponse"}}},"description":"DeleteCallResponse"},"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":"Delete Call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/event":{"post":{"description":"Sends custom event to the call\n\nSends events:\n- custom\n","operationId":"SendCallEvent","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendCallEventRequest"}}},"description":"SendCallEventRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendCallEventResponse"}}},"description":"SendCallEventResponse"},"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":"Send custom event","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/feedback":{"post":{"description":"\n\nSends events:\n- call.user_feedback_submitted\n","operationId":"CollectUserFeedback","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectUserFeedbackRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectUserFeedbackResponse"}}},"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":"Collect user feedback","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/go_live":{"post":{"description":"\n\nSends events:\n- call.live_started\n","operationId":"GoLive","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoLiveRequest"}}},"description":"GoLiveRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoLiveResponse"}}},"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":"Set call as live","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/kick":{"post":{"description":"Kicks a user from the call. Optionally block the user from rejoining by setting block=true.\n\nSends events:\n- call.blocked_user\n- call.kicked_user\n","operationId":"KickUser","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KickUserRequest"}}},"description":"KickUserRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KickUserResponse"}}},"description":"KickUserResponse"},"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":"Kick user from a call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/mark_ended":{"post":{"description":"\n\nSends events:\n- call.ended\n","operationId":"EndCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EndCallResponse"}}},"description":"EndCallResponse"},"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":"End call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/members":{"post":{"description":"\n\nSends events:\n- call.member_added\n- call.member_removed\n- call.member_updated\n","operationId":"UpdateCallMembers","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallMembersRequest"}}},"description":"UpdateCallMembersRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallMembersResponse"}}},"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":"Update Call Member","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/mute_users":{"post":{"description":"Mutes users in a call\n","operationId":"MuteUsers","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteUsersRequest"}}},"description":"MuteUsersRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteUsersResponse"}}},"description":"MuteUsersResponse"},"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":"Mute users","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/participants":{"post":{"description":"Returns a list of participants connected to the call\n","operationId":"QueryCallParticipants","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"type","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"limit","schema":{"format":"int32","maximum":100,"type":"integer","x-stream-index":"004"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallParticipantsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallParticipantsResponse"}}},"description":"Successful 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":"Query call participants","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/pin":{"post":{"description":"Pins a track for all users in the call.\n","operationId":"VideoPin","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PinRequest"}}},"description":"PinRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PinResponse"}}},"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":"Pin","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/recordings":{"get":{"description":"Lists recordings\n","operationId":"ListRecordings","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListRecordingsResponse"}}},"description":"ListRecordingsResponse"},"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":"List recordings","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/report":{"get":{"description":"\n","operationId":"GetCallReport","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"query","name":"session_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCallReportResponse"}}},"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":"Get call report","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/rtmp_broadcasts":{"post":{"description":"Starts RTMP broadcasts for the provided RTMP destinations\n","operationId":"StartRTMPBroadcasts","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRTMPBroadcastsRequest"}}},"description":"StartRTMPBroadcastsRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRTMPBroadcastsResponse"}}},"description":"StartRTMPBroadcastsResponse"},"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":"Start RTMP broadcasts","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/rtmp_broadcasts/stop":{"post":{"description":"Stop all RTMP broadcasts for the provided call\n","operationId":"StopAllRTMPBroadcasts","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopAllRTMPBroadcastsResponse"}}},"description":"StopAllRTMPBroadcastsResponse"},"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":"Stop all RTMP broadcasts for a call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/rtmp_broadcasts/{name}/stop":{"post":{"description":"Stop RTMP broadcasts for the provided RTMP destinations\n","operationId":"StopRTMPBroadcast","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopRTMPBroadcastsRequest"}}},"description":"StopRTMPBroadcastsRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopRTMPBroadcastsResponse"}}},"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":"Stop RTMP broadcasts","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/start_broadcasting":{"post":{"description":"Starts HLS broadcasting\n","operationId":"StartHLSBroadcasting","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartHLSBroadcastingResponse"}}},"description":"StartHLSBroadcastingResponse"},"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":"Start HLS broadcasting","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/start_closed_captions":{"post":{"description":"Starts closed captions\n","operationId":"StartClosedCaptions","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartClosedCaptionsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartClosedCaptionsResponse"}}},"description":"Successful 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":"Start closed captions","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/start_frame_recording":{"post":{"description":"Starts frame by frame recording\n\nSends events:\n- call.frame_recording_started\n","operationId":"StartFrameRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartFrameRecordingRequest"}}},"description":"StartFrameRecordingRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartFrameRecordingResponse"}}},"description":"StartFrameRecordingResponse"},"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":"Start frame recording","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/start_recording":{"post":{"description":"Starts recording\n\nSends events:\n- call.recording_started\n","operationId":"StartRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRecordingRequest"}}},"description":"StartRecordingRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRecordingResponse"}}},"description":"StartRecordingResponse"},"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":"Start recording","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/start_transcription":{"post":{"description":"Starts transcription\n","operationId":"StartTranscription","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartTranscriptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartTranscriptionResponse"}}},"description":"StartTranscriptionResponse"},"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":"Start transcription","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_broadcasting":{"post":{"description":"Stops HLS broadcasting\n","operationId":"StopHLSBroadcasting","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopHLSBroadcastingResponse"}}},"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":"Stop HLS broadcasting","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_closed_captions":{"post":{"description":"Stops closed captions\n\nSends events:\n- call.transcription_stopped\n","operationId":"StopClosedCaptions","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopClosedCaptionsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopClosedCaptionsResponse"}}},"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":"Stop closed captions","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_frame_recording":{"post":{"description":"Stops frame recording\n\nSends events:\n- call.frame_recording_stopped\n","operationId":"StopFrameRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopFrameRecordingResponse"}}},"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":"Stop frame recording","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_live":{"post":{"description":"\n\nSends events:\n- call.updated\n","operationId":"StopLive","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopLiveRequest"}}},"description":"StopLiveRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopLiveResponse"}}},"description":"StopLiveResponse"},"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":"Set call as not live","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_recording":{"post":{"description":"Stops recording\n\nSends events:\n- call.recording_stopped\n","operationId":"StopRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopRecordingResponse"}}},"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":"Stop recording","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_transcription":{"post":{"description":"Stops transcription\n\nSends events:\n- call.transcription_stopped\n","operationId":"StopTranscription","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopTranscriptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopTranscriptionResponse"}}},"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":"Stop transcription","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/transcriptions":{"get":{"description":"Lists transcriptions\n","operationId":"ListTranscriptions","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTranscriptionsResponse"}}},"description":"ListTranscriptionsResponse"},"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":"List transcriptions","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/unblock":{"post":{"description":"Removes the block for a user on a call. The user will be able to join the call again.\n\nSends events:\n- call.unblocked_user\n","operationId":"UnblockUser","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUserRequest"}}},"description":"UnblockUserRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUserResponse"}}},"description":"UnblockUserResponse"},"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":"Unblocks user on a call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/unpin":{"post":{"description":"Unpins a track for all users in the call.\n","operationId":"VideoUnpin","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnpinRequest"}}},"description":"UnpinRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnpinResponse"}}},"description":"UnpinResponse"},"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":"Unpin","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/user_permissions":{"post":{"description":"Updates user permissions\n\nSends events:\n- call.permissions_updated\n","operationId":"UpdateUserPermissions","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"005.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"005.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUserPermissionsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUserPermissionsResponse"}}},"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":"Update user permissions","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/{session}/recordings/{filename}":{"delete":{"description":"Deletes recording\n","operationId":"DeleteRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"path","name":"session","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"003"}},{"in":"path","name":"filename","required":true,"schema":{"maxLength":256,"type":"string","writeOnly":true,"x-stream-index":"004"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteRecordingResponse"}}},"description":"DeleteRecordingResponse"},"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":"Delete recording","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/{session}/transcriptions/{filename}":{"delete":{"description":"Deletes transcription\n","operationId":"DeleteTranscription","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"path","name":"session","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"003"}},{"in":"path","name":"filename","required":true,"schema":{"maxLength":256,"type":"string","writeOnly":true,"x-stream-index":"004"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteTranscriptionResponse"}}},"description":"DeleteTranscriptionResponse"},"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":"Delete transcription","tags":["product:video"]}},"/api/v2/video/calls":{"post":{"description":"Query calls with filter query\n","operationId":"QueryCalls","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallsRequest"}}},"description":"QueryCallsRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallsResponse"}}},"description":"QueryCallsResponse"},"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":"Query call","tags":["product:video"]}},"/api/v2/video/calltypes":{"get":{"description":"\n","operationId":"ListCallTypes","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListCallTypeResponse"}}},"description":"ListCallTypeResponse"},"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":"List Call Type","tags":["product:video"]},"post":{"description":"\n","operationId":"CreateCallType","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCallTypeRequest"}}},"description":"CreateCallTypeRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCallTypeResponse"}}},"description":"CreateCallTypeResponse"},"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":"Create Call Type","tags":["product:video"]}},"/api/v2/video/calltypes/{name}":{"delete":{"description":"\n","operationId":"DeleteCallType","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete Call Type","tags":["product:video"]},"get":{"description":"\n","operationId":"GetCallType","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCallTypeResponse"}}},"description":"GetCallTypeResponse"},"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":"Get Call Type","tags":["product:video"]},"put":{"description":"\n","operationId":"UpdateCallType","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallTypeRequest"}}},"description":"UpdateCallTypeRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallTypeResponse"}}},"description":"UpdateCallTypeResponse"},"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":"Update Call Type","tags":["product:video"]}},"/api/v2/video/edges":{"get":{"description":"Returns the list of all edges available for video calls.\n","operationId":"GetEdges","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetEdgesResponse"}}},"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":"Get Edges","tags":["product:video"]}},"/api/v2/video/stats":{"post":{"description":"\n","operationId":"QueryAggregateCallStats","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryAggregateCallStatsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryAggregateCallStatsResponse"}}},"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":"Query Aggregate call Stats","tags":["product:video"]}}},"security":[{"JWT":[],"api_key":[],"stream-auth-type":[]},{"api_key":[],"stream-auth-type":[]}],"servers":[{"description":"Stream API","url":"https://chat.stream-io-api.com"}]} \ No newline at end of file diff --git a/openapi/serverside-api.yaml b/openapi/serverside-api.yaml index 420dd0f99..2ac236428 100644 --- a/openapi/serverside-api.yaml +++ b/openapi/serverside-api.yaml @@ -253,6 +253,74 @@ components: - action - min_confidence type: object + AcceptFeedMemberInviteRequest: + nullable: true + properties: + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "003.002" + user_id: + type: string + x-stream-index: "003.001" + title: Accept Feed Member Invite Request + type: object + AcceptFeedMemberInviteResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + member: + $ref: '#/components/schemas/FeedMemberResponse' + description: The feed member after accepting the invite + title: Feed Member + x-stream-index: "001" + required: + - member + - duration + title: Accept Feed Member Invite Response + type: object + AcceptFollowRequest: + nullable: true + properties: + follower_role: + description: Optional role for the follower in the follow relationship + title: Follower Role + type: string + x-stream-index: "003" + source: + description: Fully qualified ID of the source feed + maxLength: 255 + title: Source Feed ID + type: string + x-stream-index: "001" + target: + description: Fully qualified ID of the target feed + maxLength: 255 + title: Target Feed ID + type: string + x-stream-index: "002" + required: + - source + - target + title: Accept Follow Request + type: object + AcceptFollowResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + follow: + $ref: '#/components/schemas/FollowResponse' + description: The accepted follow relationship + title: Follow + x-stream-index: "001" + required: + - follow + - duration + title: Accept Follow Response + type: object Action: nullable: true properties: @@ -423,6 +491,20 @@ components: - warning - warning_text type: object + ActiveCallsBitrateStats: + properties: + p10: + format: float + type: number + x-stream-index: "001" + p50: + format: float + type: number + x-stream-index: "002" + required: + - p10 + - p50 + type: object ActiveCallsFPSStats: properties: p05: @@ -473,6 +555,20 @@ components: $ref: '#/components/schemas/SubscribersMetrics' x-stream-index: "003" type: object + ActiveCallsResolutionStats: + properties: + p10: + format: float + type: number + x-stream-index: "001" + p50: + format: float + type: number + x-stream-index: "002" + required: + - p10 + - p50 + type: object ActiveCallsSummary: properties: active_calls: @@ -497,1355 +593,2324 @@ components: - active_subscribers - participants type: object - ActivityMarkedEvent: + ActivityAddedEvent: + description: Emitted when an activity is added to a feed. + nullable: true properties: - all_read: - type: boolean - x-stream-index: "006" - all_seen: - type: boolean - x-stream-index: "007" + activity: + $ref: '#/components/schemas/ActivityResponse' + description: The activity that was added + title: Activity + x-stream-index: "001" created_at: + description: Date/time of creation format: date-time + title: Created at type: number - x-stream-index: "001.002" - feed_id: + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + feed_visibility: type: string - x-stream-index: "003" - marked_read: - items: - type: string - type: array - x-stream-index: "004" - marked_watched: - items: - type: string - type: array - x-stream-index: "005" - type: - default: activity.marked + x-stream-index: "002.003" + fid: type: string - x-stream-index: "001.001" - user_id: + x-stream-index: "002.002" + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 + type: + default: feeds.activity.added + description: 'The type of event: "feeds.activity.added" in this case' + title: Event Type type: string - x-stream-index: "002" + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who added the activity + title: User + x-stream-index: "003.001" required: + - activity - type - created_at - - user_id - - feed_id - - all_read - - all_seen - title: ActivityMarkedEvent + - custom + - fid + title: ActivityAddedEvent 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 - AnyEvent: + ActivityDeletedEvent: + description: Emitted when an activity is deleted. + nullable: true properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + description: The activity that was updated + title: Activity + x-stream-index: "001" created_at: + description: Date/time of creation format: date-time + title: Created at type: number - x-stream-index: "001.002" + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + feed_visibility: + type: string + x-stream-index: "002.003" + fid: + type: string + x-stream-index: "002.002" + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 type: - default: '*' + default: feeds.activity.deleted + description: 'The type of event: "feeds.activity.deleted" in this case' + title: Event Type type: string - x-stream-index: "001.001" + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + x-stream-index: "003.001" required: + - activity - type - created_at - title: AnyEvent + - custom + - fid + title: ActivityDeletedEvent 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 - AppResponseFields: + ActivityFeedbackRequest: + description: Request to provide feedback on an activity + nullable: true properties: - allowed_flag_reasons: - items: - type: string - type: array - x-stream-index: "019" - async_url_enrich_enabled: + hide: + description: Whether to hide this activity + title: bool type: boolean - x-stream-index: "017" - auto_translation_enabled: + x-stream-index: "003" + mute_user: + description: Whether to mute the user who created this activity + title: bool type: boolean - x-stream-index: "020" - before_message_send_hook_url: + x-stream-index: "005" + reason: + description: Reason for the feedback (optional) + maxLength: 1000 + title: string type: string - x-stream-index: "021" - call_types: - additionalProperties: - $ref: '#/components/schemas/CallType' - type: object - x-stream-index: "007" - campaign_enabled: - type: boolean - x-stream-index: "034" - cdn_expiration_seconds: - format: int32 - type: integer - x-stream-index: "037" - channel_configs: - additionalProperties: - $ref: '#/components/schemas/ChannelConfig' - type: object x-stream-index: "006" - custom_action_handler_url: - type: string - x-stream-index: "022" - datadog_info: - $ref: '#/components/schemas/DataDogInfo' - x-stream-index: "040" - disable_auth_checks: + report: + description: Whether to report this activity + title: bool type: boolean - x-stream-index: "011" - disable_permissions_checks: + x-stream-index: "004" + show_less: + description: Whether to show less content like this + title: bool type: boolean - x-stream-index: "012" - enforce_unique_usernames: + x-stream-index: "002" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "008.002" + user_id: type: string - x-stream-index: "023" - event_hooks: - items: - $ref: '#/components/schemas/EventHook' - type: array - x-stream-index: "045" - file_upload_config: - $ref: '#/components/schemas/FileUploadConfig' - x-stream-index: "030" - geofences: - items: - $ref: '#/components/schemas/GeofenceResponse' - type: array - x-stream-index: "039" - grants: - additionalProperties: - items: - type: string - type: array + x-stream-index: "008.001" + title: Activity Feedback Request + type: object + ActivityFeedbackResponse: + description: Response for activity feedback submission + nullable: true + properties: + activity_id: + description: The ID of the activity that received feedback + title: string + type: string + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - activity_id + - duration + title: Activity Feedback Response + type: object + ActivityLocation: + properties: + lat: + description: Latitude coordinate + format: float + title: Latitude + type: number + x-stream-index: "001" + lng: + description: Longitude coordinate + format: float + title: Longitude + type: number + x-stream-index: "002" + required: + - lat + - lng + title: Activity Location + type: object + ActivityMarkEvent: + description: Emitted when activities are marked as read, seen, or watched. + nullable: true + properties: + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 006.001.003 + custom: + additionalProperties: {} type: object - x-stream-index: "033" - guest_user_creation_disabled: + x-stream-index: 006.001.007 + feed_visibility: + type: string + x-stream-index: "006.003" + fid: + type: string + x-stream-index: "006.002" + mark_all_read: + description: Whether all activities were marked as read + title: Mark All Read type: boolean - x-stream-index: "043" - image_moderation_enabled: + x-stream-index: "004" + mark_all_seen: + description: Whether all activities were marked as seen + title: Mark All Seen type: boolean - x-stream-index: "016" - image_moderation_labels: + x-stream-index: "005" + mark_read: + description: The IDs of activities marked as read items: type: string + title: Mark Read type: array - x-stream-index: "018" - image_upload_config: - $ref: '#/components/schemas/FileUploadConfig' - x-stream-index: "031" - moderation_bulk_submit_action_enabled: - type: boolean - x-stream-index: "048" - moderation_dashboard_preferences: - $ref: '#/components/schemas/ModerationDashboardPreferences' - x-stream-index: "044" - moderation_enabled: - type: boolean - x-stream-index: "041" - moderation_multitenant_blocklist_enabled: - type: boolean - x-stream-index: "042" - moderation_webhook_url: - type: string - x-stream-index: "005" - multi_tenant_enabled: - type: boolean - x-stream-index: "015" - name: - type: string x-stream-index: "001" - organization: - type: string + mark_seen: + description: The IDs of activities marked as seen + items: + type: string + title: Mark Seen + type: array x-stream-index: "002" - permission_version: - type: string - x-stream-index: "013" - policies: - additionalProperties: - items: - $ref: '#/components/schemas/Policy' - type: array - type: object - x-stream-index: "008" - push_notifications: - $ref: '#/components/schemas/PushNotificationFields' + mark_watched: + description: The IDs of activities marked as watched + items: + type: string + title: Mark Watched + type: array x-stream-index: "003" - reminders_interval: - format: int32 - type: integer - x-stream-index: "036" - revoke_tokens_issued_before: + received_at: format: date-time type: number - x-stream-index: "032" - sns_key: - type: string - x-stream-index: "028" - sns_secret: - type: string - x-stream-index: "029" - sns_topic_arn: - type: string - x-stream-index: "027" - sqs_key: - type: string - x-stream-index: "025" - sqs_secret: - type: string - x-stream-index: "026" - sqs_url: - type: string - x-stream-index: "024" - suspended: - type: boolean - x-stream-index: "009" - suspended_explanation: + x-stream-index: 006.001.004 + type: + default: feeds.activity.marked + description: 'The type of event: "feeds.activity.marked" in this case' + title: Event Type type: string - x-stream-index: "010" - use_hook_v2: + x-stream-index: 006.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who marked the activities + title: User + x-stream-index: "007.001" + required: + - type + - created_at + - custom + - fid + title: ActivityMarkEvent + 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 + ActivityMarkedEvent: + properties: + all_read: type: boolean - x-stream-index: "046" - user_response_time_enabled: + x-stream-index: "006" + all_seen: type: boolean - x-stream-index: "047" - user_search_disallowed_roles: + x-stream-index: "007" + created_at: + format: date-time + type: number + x-stream-index: "001.002" + feed_id: + type: string + x-stream-index: "003" + marked_read: items: type: string type: array - x-stream-index: "014" - webhook_events: + x-stream-index: "004" + marked_watched: items: type: string type: array - x-stream-index: "035" - webhook_url: + x-stream-index: "005" + type: + default: activity.marked + type: string + x-stream-index: "001.001" + user_id: type: string + x-stream-index: "002" + required: + - type + - created_at + - user_id + - feed_id + - all_read + - all_seen + title: ActivityMarkedEvent + 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 + ActivityPinResponse: + properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + description: The pinned activity + title: Activity + x-stream-index: "002" + created_at: + description: When the pin was created + format: date-time + title: Created At + type: number x-stream-index: "004" + feed: + description: ID of the feed where activity is pinned + title: Feed ID + type: string + x-stream-index: "003" + updated_at: + description: When the pin was last updated + format: date-time + title: Updated At + type: number + x-stream-index: "005" + user: + $ref: '#/components/schemas/UserResponse' + description: User who pinned the activity + title: User + x-stream-index: "001" required: - - name - - organization - - push_notifications - - webhook_url - - moderation_webhook_url - - channel_configs - - call_types - - policies - - suspended - - suspended_explanation - - disable_auth_checks - - disable_permissions_checks - - permission_version - - user_search_disallowed_roles - - multi_tenant_enabled - - image_moderation_enabled - - async_url_enrich_enabled - - auto_translation_enabled - - custom_action_handler_url - - enforce_unique_usernames - - sqs_url - - sqs_key - - sqs_secret - - sns_topic_arn - - sns_key - - sns_secret - - file_upload_config - - image_upload_config - - grants - - campaign_enabled - - webhook_events - - reminders_interval - - cdn_expiration_seconds - - video_provider - - moderation_enabled - - moderation_multitenant_blocklist_enabled - - guest_user_creation_disabled - - event_hooks - - use_hook_v2 - - user_response_time_enabled - - moderation_bulk_submit_action_enabled + - user + - activity + - feed + - created_at + - updated_at + title: Activity Pin type: object - AsyncBulkImageModerationEvent: + ActivityPinnedEvent: + description: Emitted when an activity is pinned. nullable: true properties: created_at: + description: Date/time of creation format: date-time + title: Created at type: number - x-stream-index: "003.003" + x-stream-index: 002.001.003 custom: additionalProperties: {} type: object - x-stream-index: "003.007" - finished_at: - format: date-time - type: number + x-stream-index: 002.001.007 + feed_visibility: + type: string x-stream-index: "002.003" + fid: + description: The ID of the feed + title: Feed ID + type: string + x-stream-index: "002.002" + pinned_activity: + $ref: '#/components/schemas/PinActivityResponse' + x-stream-index: "001" received_at: format: date-time type: number - x-stream-index: "003.004" - started_at: - format: date-time - type: number - x-stream-index: "002.002" - task_id: - type: string - x-stream-index: "002.001" + x-stream-index: 002.001.004 type: - default: export.bulk_image_moderation.success - type: string - x-stream-index: "003.002" - url: + default: feeds.activity.pinned + description: 'The type of event: "feeds.activity.pinned" in this case' + title: Event Type type: string - x-stream-index: "001" + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who pinned the activity + title: User + x-stream-index: "003.001" required: - - url - - task_id - - started_at - - finished_at + - pinned_activity - type - created_at - custom - title: AsyncBulkImageModerationEvent + - fid + title: ActivityPinnedEvent 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 - AsyncExportChannelsEvent: + ActivityProcessorConfig: + properties: + type: + description: Type of activity processor (required) + title: Type + type: string + x-stream-index: "001" + required: + - type + title: Activity Processor Configuration + type: object + ActivityReactionAddedEvent: + description: Emitted when a reaction is added to an activity. nullable: true properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + x-stream-index: "001" created_at: + description: Date/time of creation format: date-time + title: Created at type: number - x-stream-index: "003.003" + x-stream-index: 003.001.003 custom: additionalProperties: {} type: object - x-stream-index: "003.007" - finished_at: - format: date-time - type: number - x-stream-index: "002.003" + x-stream-index: 003.001.007 + feed_visibility: + type: string + x-stream-index: "003.003" + fid: + type: string + x-stream-index: "003.002" + reaction: + $ref: '#/components/schemas/FeedsReactionResponse' + description: The reaction that was added + title: Reaction + x-stream-index: "002" received_at: format: date-time type: number - x-stream-index: "003.004" - started_at: - format: date-time - type: number - x-stream-index: "002.002" - task_id: - type: string - x-stream-index: "002.001" + x-stream-index: 003.001.004 type: - default: export.channels.success - type: string - x-stream-index: "003.002" - url: + default: feeds.activity.reaction.added + description: 'The type of event: "feeds.activity.reaction.added" in this + case' + title: Event Type type: string - x-stream-index: "001" + x-stream-index: 003.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who added the reaction + title: User + x-stream-index: "004.001" required: - - url - - task_id - - started_at - - finished_at + - activity + - reaction - type - created_at - custom - title: AsyncExportChannelsEvent + - fid + title: ActivityReactionAddedEvent 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 - AsyncExportErrorEvent: + ActivityReactionDeletedEvent: + description: Emitted when a reaction is deleted from an activity. nullable: true properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + x-stream-index: "001" created_at: + description: Date/time of creation format: date-time + title: Created at type: number - x-stream-index: "003.003" + x-stream-index: 003.001.003 custom: additionalProperties: {} type: object - x-stream-index: "003.007" - error: + x-stream-index: 003.001.007 + feed_visibility: type: string - x-stream-index: "001" - finished_at: - format: date-time - type: number - x-stream-index: "002.003" + x-stream-index: "003.003" + fid: + type: string + x-stream-index: "003.002" + reaction: + $ref: '#/components/schemas/FeedsReactionResponse' + x-stream-index: "002" received_at: format: date-time type: number - x-stream-index: "003.004" - started_at: - format: date-time - type: number - x-stream-index: "002.002" - task_id: - type: string - x-stream-index: "002.001" + x-stream-index: 003.001.004 type: - default: export.users.error + default: feeds.activity.reaction.deleted + description: The type of the reaction that was removed + title: Type type: string - x-stream-index: "003.002" + x-stream-index: 003.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who removed the reaction + title: User + x-stream-index: "004.001" required: - - error - - task_id - - started_at - - finished_at + - activity + - reaction - type - created_at - custom - title: AsyncExportErrorEvent + - fid + title: ActivityReactionDeletedEvent 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 - AsyncExportModerationLogsEvent: + ActivityReactionUpdatedEvent: + description: Emitted when a reaction is updated on an activity. nullable: true properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + x-stream-index: "001" created_at: + description: Date/time of creation format: date-time + title: Created at type: number - x-stream-index: "003.003" + x-stream-index: 003.001.003 custom: additionalProperties: {} type: object - x-stream-index: "003.007" - finished_at: - format: date-time - type: number - x-stream-index: "002.003" + x-stream-index: 003.001.007 + feed_visibility: + type: string + x-stream-index: "003.003" + fid: + type: string + x-stream-index: "003.002" + reaction: + $ref: '#/components/schemas/FeedsReactionResponse' + description: The reaction that was updated + title: Reaction + x-stream-index: "002" received_at: format: date-time type: number - x-stream-index: "003.004" - started_at: - format: date-time - type: number - x-stream-index: "002.002" - task_id: - type: string - x-stream-index: "002.001" + x-stream-index: 003.001.004 type: - default: export.moderation_logs.success - type: string - x-stream-index: "003.002" - url: + default: feeds.activity.reaction.updated + description: 'The type of event: "feeds.activity.reaction.updated" in this + case' + title: Event Type type: string - x-stream-index: "001" + x-stream-index: 003.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who updated the reaction + title: User + x-stream-index: "004.001" required: - - url - - task_id - - started_at - - finished_at + - activity + - reaction - type - created_at - custom - title: AsyncExportModerationLogsEvent + - fid + title: ActivityReactionUpdatedEvent 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 - AsyncExportUsersEvent: + ActivityRemovedFromFeedEvent: + description: Emitted when an activity is removed from a feed. nullable: true properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + x-stream-index: "001" created_at: + description: Date/time of creation format: date-time + title: Created at type: number - x-stream-index: "003.003" + x-stream-index: 002.001.003 custom: additionalProperties: {} type: object - x-stream-index: "003.007" - finished_at: - format: date-time - type: number + x-stream-index: 002.001.007 + feed_visibility: + type: string x-stream-index: "002.003" + fid: + type: string + x-stream-index: "002.002" received_at: format: date-time type: number - x-stream-index: "003.004" - started_at: - format: date-time - type: number - x-stream-index: "002.002" - task_id: - type: string - x-stream-index: "002.001" + x-stream-index: 002.001.004 type: - default: export.users.success - type: string - x-stream-index: "003.002" - url: + default: feeds.activity.removed_from_feed + description: 'The type of event: "feeds.activity.removed_from_feed" in this + case' + title: Event Type type: string - x-stream-index: "001" + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who removed the activity + title: User + x-stream-index: "003.001" required: - - url - - task_id - - started_at - - finished_at + - activity - type - created_at - custom - title: AsyncExportUsersEvent + - fid + title: ActivityRemovedFromFeedEvent 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 - AsyncModerationCallbackConfig: + ActivityRequest: properties: - mode: - enum: - - CALLBACK_MODE_NONE - - CALLBACK_MODE_REST - - CALLBACK_MODE_TWIRP + attachments: + description: List of attachments for the activity + items: + $ref: '#/components/schemas/Attachment' + title: Attachments + type: array + x-stream-index: "006" + custom: + additionalProperties: {} + description: Custom data for the activity + title: Custom Data + type: object + x-stream-index: "017" + expires_at: + description: Expiration time for the activity + title: Expires At type: string - x-stream-index: "002" - server_url: + x-stream-index: "010" + feeds: + description: List of feed IDs to add the activity to + items: + type: string + maximum: 255 + minimum: 1 + title: Feed IDs + type: array + x-stream-index: "004" + filter_tags: + description: Tags for filtering activities + items: + type: string + maximum: 255 + title: Filter Tags + type: array + x-stream-index: "013" + id: + description: Optional ID for the activity + maxLength: 255 + title: Activity ID type: string x-stream-index: "001" - type: object - AsyncModerationConfiguration: - properties: - callback: - $ref: '#/components/schemas/AsyncModerationCallbackConfig' - x-stream-index: "002" - timeout_ms: - format: int32 - type: integer - x-stream-index: "001" - type: object - Attachment: - description: An attachment is a message object that represents a file uploaded - by a user. - nullable: true - properties: - actions: + interest_tags: + description: Tags for indicating user interests items: - $ref: '#/components/schemas/Action' + type: string + maximum: 255 + title: Interest Tags type: array - x-stream-index: "015" - asset_url: - type: string - x-stream-index: "017" - author_icon: + x-stream-index: "014" + location: + $ref: '#/components/schemas/ActivityLocation' + description: Geographic location related to the activity + title: Location + x-stream-index: "009" + mentioned_user_ids: + description: List of users mentioned in the activity + items: + type: string + maximum: 255 + title: Mentioned User IDs + type: array + x-stream-index: "011" + parent_id: + description: ID of parent activity for replies/comments + maxLength: 255 + title: Parent ID type: string - x-stream-index: "007" - author_link: + x-stream-index: "015" + poll_id: + description: ID of a poll to attach to activity + title: Poll ID type: string - x-stream-index: "006" - author_name: + x-stream-index: "016" + search_data: + additionalProperties: {} + description: Additional data for search indexing + title: Search Data + type: object + x-stream-index: "012" + text: + description: Text content of the activity + title: Text type: string x-stream-index: "005" - color: + type: + description: Type of activity + maxLength: 255 + title: Activity Type + type: string + x-stream-index: "002" + user_id: + description: ID of the user creating the activity + maxLength: 255 + title: User ID type: string x-stream-index: "003" + visibility: + description: Visibility setting for the activity + enum: + - public + - private + - tag + title: Visibility + type: string + x-stream-index: "007" + visibility_tag: + description: If visibility is 'tag', this is the tag name and is required + maxLength: 32 + title: Visibility Tag + type: string + x-stream-index: "008" + required: + - type + - feeds + title: Activity Request + type: object + ActivityResponse: + properties: + attachments: + description: Media attachments for the activity + items: + $ref: '#/components/schemas/Attachment' + title: Attachments + type: array + x-stream-index: "009" + bookmark_count: + description: Number of bookmarks on the activity + format: int32 + title: Bookmark Count + type: integer + x-stream-index: "028" + comment_count: + description: Number of comments on the activity + format: int32 + title: Comment Count + type: integer + x-stream-index: "027" + comments: + description: Comments on this activity + items: + $ref: '#/components/schemas/CommentResponse' + title: Comments + type: array + x-stream-index: "015" + created_at: + description: When the activity was created + format: date-time + title: Created At + type: number + x-stream-index: "007" + current_feed: + $ref: '#/components/schemas/FeedResponse' + description: Feed context for this activity view. If an activity is added + only to one feed, it's always set. If an activity is added to multiple + feeds, it's only set when calling the GetOrCreateFeed endpoint. + title: Current Feed + x-stream-index: "035" custom: additionalProperties: {} + description: Custom data for the activity + title: Custom Data type: object - x-stream-index: "018" - fallback: - type: string - x-stream-index: "002" - fields: + x-stream-index: "011" + deleted_at: + description: When the activity was deleted + format: date-time + title: Deleted At + type: number + x-stream-index: "021" + edited_at: + description: When the activity was last edited + format: date-time + title: Edited At + type: number + x-stream-index: "020" + expires_at: + description: When the activity will expire + format: date-time + title: Expires At + type: number + x-stream-index: "022" + feeds: + description: List of feed IDs containing this activity items: - $ref: '#/components/schemas/Field' + type: string + title: Feeds type: array - x-stream-index: "016" - footer: - type: string - x-stream-index: "013" - footer_icon: + x-stream-index: "004" + filter_tags: + description: Tags for filtering + items: + type: string + title: Filter Tags + type: array + x-stream-index: "024" + hidden: + description: If this activity is hidden for this user. For premium content + where you want to show a preview + title: Hidden + type: boolean + x-stream-index: "036" + id: + description: Unique identifier for the activity + title: ID type: string - x-stream-index: "014" - giphy: - $ref: '#/components/schemas/Images' + x-stream-index: "001" + interest_tags: + description: Tags for user interests + items: + type: string + title: Interest Tags + type: array + x-stream-index: "025" + latest_reactions: + description: Recent reactions to the activity + items: + $ref: '#/components/schemas/FeedsReactionResponse' + title: Latest Reactions + type: array + x-stream-index: "031" + location: + $ref: '#/components/schemas/ActivityLocation' + description: Geographic location related to the activity + title: Location + x-stream-index: "017" + mentioned_users: + description: Users mentioned in the activity + items: + $ref: '#/components/schemas/UserResponse' + title: Mentioned Users + type: array + x-stream-index: "010" + moderation: + $ref: '#/components/schemas/ModerationV2Response' + description: Moderation information + title: Moderation + x-stream-index: "026" + notification_context: + additionalProperties: {} + description: Notification context data for the activity (if this is a reaction, + comment, follow, etc.) + title: Notification Context + type: object + x-stream-index: "012" + own_bookmarks: + description: Current user's bookmarks for this activity + items: + $ref: '#/components/schemas/BookmarkResponse' + title: Own Bookmarks + type: array + x-stream-index: "034" + own_reactions: + description: Current user's reactions to this activity + items: + $ref: '#/components/schemas/FeedsReactionResponse' + title: Own Reactions + type: array + x-stream-index: "033" + parent: + $ref: '#/components/schemas/ActivityResponse' + description: Parent activity (if this is a reply/comment) + title: Parent + x-stream-index: "018" + poll: + $ref: '#/components/schemas/PollResponseData' + description: Poll attached to this activity + title: Poll x-stream-index: "019" - image_url: - type: string - x-stream-index: "011" - og_scrape_url: - type: string - x-stream-index: "020" - original_height: + popularity: + description: Popularity score of the activity format: int32 + title: Popularity type: integer - x-stream-index: "022" - original_width: + x-stream-index: "013" + reaction_count: + description: Number of reactions to the activity format: int32 + title: Reaction Count type: integer - x-stream-index: "021" - pretext: - type: string - x-stream-index: "004" + x-stream-index: "030" + reaction_groups: + additionalProperties: + $ref: '#/components/schemas/ReactionGroupResponse' + description: Grouped reactions by type + title: Reaction Groups + type: object + x-stream-index: "032" + score: + description: Ranking score for this activity + format: float + title: Score + type: number + x-stream-index: "014" + search_data: + additionalProperties: {} + description: Data for search indexing + title: Search Data + type: object + x-stream-index: "023" + share_count: + description: Number of times the activity was shared + format: int32 + title: Share Count + type: integer + x-stream-index: "029" text: + description: Text content of the activity + title: Text type: string - x-stream-index: "010" - thumb_url: - type: string - x-stream-index: "012" - title: + x-stream-index: "016" + type: + description: Type of activity + title: Type type: string + x-stream-index: "002" + updated_at: + description: When the activity was last updated + format: date-time + title: Updated At + type: number x-stream-index: "008" - title_link: + user: + $ref: '#/components/schemas/UserResponse' + description: User who created the activity + title: User + x-stream-index: "003" + visibility: + description: Visibility setting for the activity + enum: + - public + - private + - tag + title: Visibility type: string - x-stream-index: "009" - type: - description: Attachment type (e.g. image, video, url) - title: Type + x-stream-index: "005" + visibility_tag: + description: If visibility is 'tag', this is the tag name + title: Visibility Tag type: string - x-stream-index: "001" + x-stream-index: "006" required: + - id + - type + - user + - feeds + - visibility + - created_at + - updated_at + - attachments + - mentioned_users - custom - title: Attachment + - popularity + - score + - comments + - search_data + - filter_tags + - interest_tags + - comment_count + - bookmark_count + - share_count + - reaction_count + - latest_reactions + - reaction_groups + - own_reactions + - own_bookmarks + title: Base Activity type: object - x-stream-docs-page-id: file_uploads - AudioSettings: + ActivitySelectorConfig: properties: - access_request_enabled: - type: boolean - x-stream-index: "001" - default_device: - enum: - - speaker - - earpiece - type: string - x-stream-index: "006" - mic_default_on: - type: boolean + cutoff_time: + description: Time threshold for activity selection + format: date-time + title: Cutoff Time + type: number x-stream-index: "004" - noise_cancellation: - $ref: '#/components/schemas/NoiseCancellationSettings' - x-stream-index: "007" - opus_dtx_enabled: - type: boolean + filter: + additionalProperties: {} + description: Filter for activity selection + title: Filter + type: object x-stream-index: "002" - redundant_coding_enabled: - type: boolean - x-stream-index: "003" - speaker_default_on: - type: boolean + min_popularity: + description: Minimum popularity threshold + format: int32 + title: Minimum Popularity + type: integer x-stream-index: "005" - required: - - access_request_enabled - - opus_dtx_enabled - - redundant_coding_enabled - - mic_default_on - - speaker_default_on - - default_device + sort: + description: Sort parameters for activity selection + items: + $ref: '#/components/schemas/SortParam' + title: Sort + type: array + x-stream-index: "003" + type: + description: Type of selector + title: Type + type: string + x-stream-index: "001" + title: Activity Selector Configuration type: object - AudioSettingsRequest: + ActivityUnpinnedEvent: + description: Emitted when an activity is unpinned. + nullable: true properties: - access_request_enabled: - type: boolean + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + feed_visibility: + type: string + x-stream-index: "002.003" + fid: + description: The ID of the feed + title: Feed ID + type: string + x-stream-index: "002.002" + pinned_activity: + $ref: '#/components/schemas/PinActivityResponse' x-stream-index: "001" - default_device: - enum: - - speaker - - earpiece + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 + type: + default: feeds.activity.unpinned + description: 'The type of event: "feeds.activity.unpinned" in this case' + title: Event Type type: string - x-stream-index: "006" - mic_default_on: - type: boolean - x-stream-index: "004" - noise_cancellation: - $ref: '#/components/schemas/NoiseCancellationSettings' - x-stream-index: "007" - opus_dtx_enabled: - type: boolean - x-stream-index: "002" - redundant_coding_enabled: - type: boolean - x-stream-index: "003" - speaker_default_on: - type: boolean - x-stream-index: "005" + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who unpinned the activity + title: User + x-stream-index: "003.001" required: - - default_device + - pinned_activity + - type + - created_at + - custom + - fid + title: ActivityUnpinnedEvent type: object - AudioSettingsResponse: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + ActivityUpdatedEvent: + description: Emitted when an activity is updated. + nullable: true properties: - access_request_enabled: - type: boolean + activity: + $ref: '#/components/schemas/ActivityResponse' + description: The activity that was updated + title: Activity x-stream-index: "001" - default_device: - enum: - - speaker - - earpiece + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + feed_visibility: type: string - x-stream-index: "006" - mic_default_on: - type: boolean - x-stream-index: "004" - noise_cancellation: - $ref: '#/components/schemas/NoiseCancellationSettings' - x-stream-index: "007" - opus_dtx_enabled: - type: boolean - x-stream-index: "002" - redundant_coding_enabled: - type: boolean - x-stream-index: "003" - speaker_default_on: - type: boolean - x-stream-index: "005" + x-stream-index: "002.003" + fid: + type: string + x-stream-index: "002.002" + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 + type: + default: feeds.activity.updated + description: The type of the event + title: Event Type + type: string + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who updated the activity + title: User + x-stream-index: "003.001" required: - - access_request_enabled - - opus_dtx_enabled - - redundant_coding_enabled - - mic_default_on - - speaker_default_on - - default_device + - activity + - type + - created_at + - custom + - fid + title: ActivityUpdatedEvent type: object - AutomodDetails: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + AddActivityRequest: + nullable: true properties: - action: + attachments: + description: List of attachments for the activity + items: + $ref: '#/components/schemas/Attachment' + title: Attachments + type: array + x-stream-index: "001.006" + custom: + additionalProperties: {} + description: Custom data for the activity + title: Custom Data + type: object + x-stream-index: "001.017" + expires_at: + description: Expiration time for the activity + title: Expires At type: string - x-stream-index: "001" - image_labels: + x-stream-index: "001.010" + feeds: + description: List of feed IDs to add the activity to items: type: string + maximum: 255 + minimum: 1 + title: Feed IDs type: array - x-stream-index: "005" - message_details: - $ref: '#/components/schemas/FlagMessageDetails' + x-stream-index: "001.004" + filter_tags: + description: Tags for filtering activities + items: + type: string + maximum: 255 + title: Filter Tags + type: array + x-stream-index: "001.013" + id: + description: Optional ID for the activity + maxLength: 255 + title: Activity ID + type: string + x-stream-index: "001.001" + interest_tags: + description: Tags for indicating user interests + items: + type: string + maximum: 255 + title: Interest Tags + type: array + x-stream-index: "001.014" + location: + $ref: '#/components/schemas/ActivityLocation' + description: Geographic location related to the activity + title: Location + x-stream-index: "001.009" + mentioned_user_ids: + description: List of users mentioned in the activity + items: + type: string + maximum: 255 + title: Mentioned User IDs + type: array + x-stream-index: "001.011" + parent_id: + description: ID of parent activity for replies/comments + maxLength: 255 + title: Parent ID + type: string + x-stream-index: "001.015" + poll_id: + description: ID of a poll to attach to activity + title: Poll ID + type: string + x-stream-index: "001.016" + search_data: + additionalProperties: {} + description: Additional data for search indexing + title: Search Data + type: object + x-stream-index: "001.012" + text: + description: Text content of the activity + title: Text + type: string + x-stream-index: "001.005" + type: + description: Type of activity + maxLength: 255 + title: Activity Type + type: string + x-stream-index: "001.002" + user_id: + description: ID of the user creating the activity + maxLength: 255 + title: User ID + type: string + x-stream-index: "001.003" + visibility: + description: Visibility setting for the activity + enum: + - public + - private + - tag + title: Visibility + type: string + x-stream-index: "001.007" + visibility_tag: + description: If visibility is 'tag', this is the tag name and is required + maxLength: 32 + title: Visibility Tag + type: string + x-stream-index: "001.008" + required: + - type + - feeds + title: Activity Request + type: object + AddActivityResponse: + nullable: true + properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + description: The created activity + title: Activity + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - activity + - duration + title: Add Activity Response + type: object + AddBookmarkRequest: + nullable: true + properties: + custom: + additionalProperties: {} + description: Custom data for the bookmark + title: Custom Data + type: object x-stream-index: "004" - original_message_type: + folder_id: + description: ID of the folder to add the bookmark to + maxLength: 255 + title: Folder ID type: string x-stream-index: "002" - result: - $ref: '#/components/schemas/MessageModerationResult' + new_folder: + $ref: '#/components/schemas/AddFolderRequest' + description: Create a new folder for this bookmark + title: New Folder x-stream-index: "003" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "005.002" + user_id: + type: string + x-stream-index: "005.001" + title: Add Bookmark Request type: object - AutomodPlatformCircumventionConfig: + AddBookmarkResponse: + nullable: true properties: - async: - type: boolean + bookmark: + $ref: '#/components/schemas/BookmarkResponse' + description: The created bookmark + title: Bookmark x-stream-index: "001" - enabled: - type: boolean - x-stream-index: "002" - rules: - items: - $ref: '#/components/schemas/AutomodRule' - type: array - x-stream-index: "003" + duration: + type: string + x-stream-index: "002.001" required: - - enabled - - rules + - bookmark + - duration + title: Add Bookmark Response type: object - AutomodRule: + AddCommentReactionRequest: + nullable: true properties: - action: - enum: - - flag - - shadow - - remove - - bounce - - bounce_flag - - bounce_remove - type: string + create_notification_activity: + description: Whether to create a notification activity for this reaction + title: boolean + type: boolean + x-stream-index: "004" + custom: + additionalProperties: {} + description: Optional custom data to add to the reaction + title: object + type: object x-stream-index: "003" - label: + skip_push: + type: boolean + x-stream-index: "005" + type: + description: The type of reaction, eg upvote, like, ... + maxLength: 255 + title: string type: string - x-stream-index: "001" - threshold: - format: float - maximum: 1 - minimum: 0 - type: number x-stream-index: "002" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "007.002" + user_id: + type: string + x-stream-index: "007.001" required: - - label - - threshold - - action + - type type: object - AutomodSemanticFiltersConfig: + AddCommentReactionResponse: + nullable: true properties: - async: - type: boolean + comment: + $ref: '#/components/schemas/CommentResponse' + description: The comment the reaction was added to + title: object x-stream-index: "001" - enabled: - type: boolean + duration: + description: Duration of the request + title: string + type: string + x-stream-index: "003.001" + reaction: + $ref: '#/components/schemas/FeedsReactionResponse' + description: The created or updated reaction + title: object x-stream-index: "002" - rules: - items: - $ref: '#/components/schemas/AutomodSemanticFiltersRule' - type: array - x-stream-index: "003" required: - - enabled - - rules + - comment + - reaction + - duration type: object - AutomodSemanticFiltersRule: + AddCommentRequest: + nullable: true properties: - action: - enum: - - flag - - shadow - - remove + attachments: + description: Media attachments for the reply + items: + $ref: '#/components/schemas/Attachment' + title: Attachments + type: array + x-stream-index: "004" + comment: + description: Text content of the comment + title: Comment type: string x-stream-index: "003" - name: + create_notification_activity: + description: Whether to create a notification activity for this comment + title: Create Notification Activity + type: boolean + x-stream-index: "008" + custom: + additionalProperties: {} + description: Custom data for the comment + title: Custom Data + type: object + x-stream-index: "007" + mentioned_user_ids: + description: List of users mentioned in the reply + items: + type: string + maximum: 255 + title: Mentioned User IDs + type: array + x-stream-index: "005" + object_id: + description: ID of the object to comment on + title: Object ID type: string x-stream-index: "001" - threshold: - format: float - maximum: 1 - minimum: 0 - type: number + object_type: + description: Type of the object to comment on + title: Object Type + type: string x-stream-index: "002" + parent_id: + description: ID of parent comment for replies + title: Parent ID + type: string + x-stream-index: "006" + skip_push: + type: boolean + x-stream-index: "009" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "010.002" + user_id: + type: string + x-stream-index: "010.001" required: - - name - - threshold - - action + - object_id + - object_type + - comment + title: Add Comment Request type: object - AutomodToxicityConfig: + AddCommentResponse: + nullable: true properties: - async: - type: boolean + comment: + $ref: '#/components/schemas/CommentResponse' + description: The created comment + title: Comment x-stream-index: "001" - enabled: - type: boolean - x-stream-index: "002" - rules: + duration: + type: string + x-stream-index: "002.001" + required: + - comment + - duration + title: Add Comment Response + type: object + AddCommentsBatchRequest: + nullable: true + properties: + comments: + description: List of comments to add items: - $ref: '#/components/schemas/AutomodRule' + $ref: '#/components/schemas/AddCommentRequest' + title: Comments type: array - x-stream-index: "003" + x-stream-index: "001" required: - - enabled - - rules + - comments + title: Add Comments Batch Request type: object - AzureRequest: - description: Config for creating Azure Blob Storage storage + AddCommentsBatchResponse: + nullable: true properties: - abs_account_name: - description: The account name - title: AccountName - type: string + comments: + description: List of comments added + items: + $ref: '#/components/schemas/CommentResponse' + title: Comments + type: array x-stream-index: "001" - abs_client_id: - description: The client id - title: ClientID + duration: type: string - x-stream-index: "003" - abs_client_secret: - description: The client secret - title: ClientSecret + x-stream-index: "002.001" + required: + - comments + - duration + title: Add Comments Batch Response + type: object + AddFolderRequest: + properties: + custom: + additionalProperties: {} + description: Custom data for the folder + title: Custom Data + type: object + x-stream-index: "002" + name: + description: Name of the folder + maxLength: 255 + title: Name type: string + x-stream-index: "001" + required: + - name + title: Add Folder Request + type: object + AddReactionRequest: + nullable: true + properties: + create_notification_activity: + description: Whether to create a notification activity for this reaction + title: Create Notification Activity + type: boolean x-stream-index: "004" - abs_tenant_id: - description: The tenant id - title: TenantID + custom: + additionalProperties: {} + description: Custom data for the reaction + title: Custom Data + type: object + x-stream-index: "003" + skip_push: + type: boolean + x-stream-index: "005" + type: + description: Type of reaction + maxLength: 255 + title: Reaction Type type: string x-stream-index: "002" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "006.002" + user_id: + type: string + x-stream-index: "006.001" required: - - abs_account_name - - abs_tenant_id - - abs_client_id - - abs_client_secret - title: AzureRequest + - type + title: Add Reaction Request type: object - BackstageSettings: + AddReactionResponse: + nullable: true properties: - enabled: - type: boolean + activity: + $ref: '#/components/schemas/ActivityResponse' x-stream-index: "001" - join_ahead_time_seconds: - format: int32 - type: integer + duration: + type: string + x-stream-index: "003.001" + reaction: + $ref: '#/components/schemas/FeedsReactionResponse' + description: The created reaction + title: Reaction x-stream-index: "002" required: - - enabled + - activity + - reaction + - duration + title: Add Reaction Response type: object - BackstageSettingsRequest: + AggregatedActivityResponse: properties: - enabled: - type: boolean + activities: + description: List of activities in this aggregation + items: + $ref: '#/components/schemas/ActivityResponse' + title: Activities + type: array x-stream-index: "001" - join_ahead_time_seconds: + activity_count: + description: Number of activities in this aggregation format: int32 + title: Activity Count type: integer x-stream-index: "002" - type: object - BackstageSettingsResponse: - properties: - enabled: - type: boolean - x-stream-index: "001" - join_ahead_time_seconds: + created_at: + description: When the aggregation was created + format: date-time + title: Created At + type: number + x-stream-index: "006" + group: + description: Grouping identifier + title: Group + type: string + x-stream-index: "004" + score: + description: Ranking score for this aggregation + format: float + title: Score + type: number + x-stream-index: "005" + updated_at: + description: When the aggregation was last updated + format: date-time + title: Updated At + type: number + x-stream-index: "007" + user_count: + description: Number of unique users in this aggregation format: int32 + title: User Count type: integer - x-stream-index: "002" + x-stream-index: "003" required: - - enabled + - activities + - activity_count + - user_count + - group + - score + - created_at + - updated_at + title: Aggregated Activity type: object - Ban: - nullable: true + AggregationConfig: + properties: + format: + description: Format for activity aggregation + title: Format + type: string + x-stream-index: "001" + title: Aggregation Configuration + type: object + AnyEvent: properties: - channel: - $ref: '#/components/schemas/Channel' - x-stream-index: "004" created_at: format: date-time type: number - x-stream-index: "012" - created_by: - $ref: '#/components/schemas/User' - x-stream-index: "011" - expires: - format: date-time - type: number - x-stream-index: "007" - reason: + x-stream-index: "001.002" + type: + default: '*' type: string - x-stream-index: "008" - shadow: - type: boolean - x-stream-index: "009" - target: - $ref: '#/components/schemas/User' - x-stream-index: "006" + x-stream-index: "001.001" required: - - shadow + - type - created_at + title: AnyEvent type: object - BanActionRequest: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + AppResponseFields: properties: - channel_ban_only: + allowed_flag_reasons: + items: + type: string + type: array + x-stream-index: "019" + async_url_enrich_enabled: type: boolean - x-stream-index: "003" - delete_messages: - enum: - - soft - - pruning - - hard - type: string - x-stream-index: "005" - ip_ban: + x-stream-index: "017" + auto_translation_enabled: type: boolean - x-stream-index: "004" - reason: + x-stream-index: "020" + before_message_send_hook_url: type: string - x-stream-index: "002" - shadow: + x-stream-index: "021" + call_types: + additionalProperties: + $ref: '#/components/schemas/CallType' + type: object + x-stream-index: "007" + campaign_enabled: type: boolean - x-stream-index: "001" - timeout: + x-stream-index: "034" + cdn_expiration_seconds: format: int32 type: integer + x-stream-index: "037" + channel_configs: + additionalProperties: + $ref: '#/components/schemas/ChannelConfig' + type: object x-stream-index: "006" - type: object - BanOptions: - properties: - duration: - format: int32 - type: integer - x-stream-index: "001" - ip_ban: - type: boolean - x-stream-index: "004" - reason: + custom_action_handler_url: type: string - x-stream-index: "002" - shadow_ban: + x-stream-index: "022" + datadog_info: + $ref: '#/components/schemas/DataDogInfo' + x-stream-index: "040" + disable_auth_checks: type: boolean - x-stream-index: "003" - required: - - duration - - reason - - shadow_ban - - ip_ban - type: object - BanRequest: - nullable: true - properties: - banned_by: - $ref: '#/components/schemas/UserRequest' - description: Details about the user performing the ban - title: Banned By - x-stream-index: "008" - banned_by_id: - description: ID of the user performing the ban - title: Banned By ID - type: string - x-stream-index: "007" - channel_cid: - description: Channel where the ban applies - title: Channel CID - type: string - x-stream-index: "004" - delete_messages: - enum: - - soft - - pruning - - hard - type: string - x-stream-index: "009" - ip_ban: - description: Whether to ban the user's IP address - title: IP Ban + x-stream-index: "011" + disable_permissions_checks: type: boolean - x-stream-index: "006" - reason: - description: Optional explanation for the ban - title: Reason + x-stream-index: "012" + enforce_unique_usernames: type: string - x-stream-index: "003" - shadow: - description: Whether this is a shadow ban - title: Shadow + x-stream-index: "023" + event_hooks: + items: + $ref: '#/components/schemas/EventHook' + type: array + x-stream-index: "045" + file_upload_config: + $ref: '#/components/schemas/FileUploadConfig' + x-stream-index: "030" + geofences: + items: + $ref: '#/components/schemas/GeofenceResponse' + type: array + x-stream-index: "039" + grants: + additionalProperties: + items: + type: string + type: array + type: object + x-stream-index: "033" + guest_user_creation_disabled: + type: boolean + x-stream-index: "043" + image_moderation_enabled: + type: boolean + x-stream-index: "016" + image_moderation_labels: + items: + type: string + type: array + x-stream-index: "018" + image_upload_config: + $ref: '#/components/schemas/FileUploadConfig' + x-stream-index: "031" + moderation_bulk_submit_action_enabled: + type: boolean + x-stream-index: "048" + moderation_dashboard_preferences: + $ref: '#/components/schemas/ModerationDashboardPreferences' + x-stream-index: "044" + moderation_enabled: + type: boolean + x-stream-index: "041" + moderation_llm_configurability_enabled: + type: boolean + x-stream-index: "049" + moderation_multitenant_blocklist_enabled: type: boolean + x-stream-index: "042" + moderation_webhook_url: + type: string x-stream-index: "005" - target_user_id: - description: ID of the user to ban - title: Target User ID + multi_tenant_enabled: + type: boolean + x-stream-index: "015" + name: type: string x-stream-index: "001" - timeout: - description: Duration of the ban in minutes - minimum: 0 - title: Timeout - type: integer + organization: + type: string x-stream-index: "002" - required: - - target_user_id - type: object - BanResponse: - nullable: true - properties: - banned_by: - $ref: '#/components/schemas/UserResponse' - x-stream-index: "006" - channel: - $ref: '#/components/schemas/ChannelResponse' - x-stream-index: "001" - created_at: - format: date-time - type: number - x-stream-index: "007" - expires: + permission_version: + type: string + x-stream-index: "013" + policies: + additionalProperties: + items: + $ref: '#/components/schemas/Policy' + type: array + type: object + x-stream-index: "008" + push_notifications: + $ref: '#/components/schemas/PushNotificationFields' + x-stream-index: "003" + reminders_interval: + format: int32 + type: integer + x-stream-index: "036" + revoke_tokens_issued_before: format: date-time type: number - x-stream-index: "003" - reason: + x-stream-index: "032" + sns_key: type: string - x-stream-index: "004" - shadow: + x-stream-index: "028" + sns_secret: + type: string + x-stream-index: "029" + sns_topic_arn: + type: string + x-stream-index: "027" + sqs_key: + type: string + x-stream-index: "025" + sqs_secret: + type: string + x-stream-index: "026" + sqs_url: + type: string + x-stream-index: "024" + suspended: type: boolean - x-stream-index: "005" - user: - $ref: '#/components/schemas/UserResponse' - x-stream-index: "002" - required: - - created_at - type: object - BlockContentOptions: - properties: - reason: + x-stream-index: "009" + suspended_explanation: type: string - x-stream-index: "001" - required: - - reason - type: object - BlockListConfig: - properties: - async: + x-stream-index: "010" + use_hook_v2: type: boolean - x-stream-index: "001" - enabled: + x-stream-index: "046" + user_response_time_enabled: type: boolean - x-stream-index: "002" - rules: + x-stream-index: "047" + user_search_disallowed_roles: items: - $ref: '#/components/schemas/BlockListRule' - maximum: 10 + type: string type: array - x-stream-index: "003" - required: - - enabled - - rules - type: object - BlockListOptions: - properties: - behavior: - description: Blocklist behavior - enum: - - flag - - block - - shadow_block - title: Behavior - type: string - x-stream-index: "002" - blocklist: - description: Blocklist name - title: Blocklist + x-stream-index: "014" + webhook_events: + items: + type: string + type: array + x-stream-index: "035" + webhook_url: type: string - x-stream-index: "001" + x-stream-index: "004" required: - - blocklist - - behavior + - name + - organization + - push_notifications + - webhook_url + - moderation_webhook_url + - channel_configs + - call_types + - policies + - suspended + - suspended_explanation + - disable_auth_checks + - disable_permissions_checks + - permission_version + - user_search_disallowed_roles + - multi_tenant_enabled + - image_moderation_enabled + - async_url_enrich_enabled + - auto_translation_enabled + - custom_action_handler_url + - enforce_unique_usernames + - sqs_url + - sqs_key + - sqs_secret + - sns_topic_arn + - sns_key + - sns_secret + - file_upload_config + - image_upload_config + - grants + - campaign_enabled + - webhook_events + - reminders_interval + - cdn_expiration_seconds + - video_provider + - moderation_enabled + - moderation_multitenant_blocklist_enabled + - guest_user_creation_disabled + - event_hooks + - use_hook_v2 + - user_response_time_enabled + - moderation_bulk_submit_action_enabled + - moderation_llm_configurability_enabled type: object - BlockListResponse: - description: Block list contains restricted words + AsyncBulkImageModerationEvent: + nullable: true properties: created_at: - description: Date/time of creation format: date-time - title: Created at type: number - x-stream-index: "001" - id: - type: string - x-stream-index: "003" - name: - description: Block list name - title: Name - type: string - x-stream-index: "004" - team: - type: string - x-stream-index: "007" - type: - description: Block list type. - title: Type - type: string - x-stream-index: "005" - updated_at: - description: Date/time of the last update + x-stream-index: "003.003" + custom: + additionalProperties: {} + type: object + x-stream-index: "003.007" + finished_at: format: date-time - title: Updated at type: number - x-stream-index: "002" - words: - description: List of words to block - items: - type: string - title: Words - type: array - x-stream-index: "006" - required: - - name - - type - - words - title: Block list - type: object - x-stream-docs-page-id: block_lists - BlockListRule: - properties: - action: - enum: - - flag - - mask_flag - - shadow - - remove - - bounce - - bounce_flag - - bounce_remove + x-stream-index: "002.003" + received_at: + format: date-time + type: number + x-stream-index: "003.004" + started_at: + format: date-time + type: number + x-stream-index: "002.002" + task_id: type: string - x-stream-index: "003" - name: + x-stream-index: "002.001" + type: + default: export.bulk_image_moderation.success type: string - x-stream-index: "001" - team: + x-stream-index: "003.002" + url: type: string - x-stream-index: "002" + x-stream-index: "001" required: - - name - - team - - action + - url + - task_id + - started_at + - finished_at + - type + - created_at + - custom + title: AsyncBulkImageModerationEvent type: object - BlockUserRequest: - description: BlockUserRequest is the payload for blocking a user. + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + AsyncExportChannelsEvent: nullable: true properties: - user_id: - description: the user to block - title: UserID + created_at: + format: date-time + type: number + x-stream-index: "003.003" + custom: + additionalProperties: {} + type: object + x-stream-index: "003.007" + finished_at: + format: date-time + type: number + x-stream-index: "002.003" + received_at: + format: date-time + type: number + x-stream-index: "003.004" + started_at: + format: date-time + type: number + x-stream-index: "002.002" + task_id: type: string - x-stream-index: "003" - required: - - user_id - title: BlockUserRequest - type: object - BlockUserResponse: - description: BlockUserResponse is the payload for blocking a user. - nullable: true - properties: - duration: - description: Duration of the request in milliseconds - title: Duration + x-stream-index: "002.001" + type: + default: export.channels.success type: string - x-stream-index: "001.001" + x-stream-index: "003.002" + url: + type: string + x-stream-index: "001" required: - - duration - title: BlockUserResponse + - url + - task_id + - started_at + - finished_at + - type + - created_at + - custom + title: AsyncExportChannelsEvent type: object - BlockUsersRequest: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + AsyncExportErrorEvent: nullable: true properties: - blocked_user_id: - description: User id to block - title: BlockedUserID + created_at: + format: date-time + type: number + x-stream-index: "003.003" + custom: + additionalProperties: {} + type: object + x-stream-index: "003.007" + error: type: string x-stream-index: "001" - user: - $ref: '#/components/schemas/UserRequest' - x-stream-index: "003.002" - user_id: + finished_at: + format: date-time + type: number + x-stream-index: "002.003" + received_at: + format: date-time + type: number + x-stream-index: "003.004" + started_at: + format: date-time + type: number + x-stream-index: "002.002" + task_id: type: string - x-stream-index: "003.001" + x-stream-index: "002.001" + type: + default: export.users.error + type: string + x-stream-index: "003.002" required: - - blocked_user_id + - error + - task_id + - started_at + - finished_at + - type + - created_at + - custom + title: AsyncExportErrorEvent type: object - BlockUsersResponse: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + AsyncExportModerationLogsEvent: nullable: true properties: - blocked_by_user_id: - description: User id who blocked another user - title: BlockedByUserID - type: string - x-stream-index: "002" - blocked_user_id: - description: User id who got blocked - title: BlockedUserID - type: string - x-stream-index: "003" created_at: - description: Timestamp when the user was blocked format: date-time - title: CreatedAt type: number - x-stream-index: "004" - duration: - description: Duration of the request in milliseconds - title: Duration + x-stream-index: "003.003" + custom: + additionalProperties: {} + type: object + x-stream-index: "003.007" + finished_at: + format: date-time + type: number + x-stream-index: "002.003" + received_at: + format: date-time + type: number + x-stream-index: "003.004" + started_at: + format: date-time + type: number + x-stream-index: "002.002" + task_id: type: string - x-stream-index: "001.001" + x-stream-index: "002.001" + type: + default: export.moderation_logs.success + type: string + x-stream-index: "003.002" + url: + type: string + x-stream-index: "001" required: - - duration - - blocked_by_user_id - - blocked_user_id + - url + - task_id + - started_at + - finished_at + - type - created_at + - custom + title: AsyncExportModerationLogsEvent type: object - BlockedUserEvent: - description: |- - This event is sent to call participants to notify when a user is blocked on a call, clients can use this event to show a notification. - If the user is the current user, the client should leave the call screen as well + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + AsyncExportUsersEvent: + nullable: true properties: - blocked_by_user: - $ref: '#/components/schemas/UserResponse' - description: The user that blocked the user, null if the user was blocked - by server-side - title: Blocked by - x-stream-index: "004" - call_cid: - type: string - x-stream-index: "002.001" created_at: format: date-time type: number - x-stream-index: "001.002" + x-stream-index: "003.003" + custom: + additionalProperties: {} + type: object + x-stream-index: "003.007" + finished_at: + format: date-time + type: number + x-stream-index: "002.003" + received_at: + format: date-time + type: number + x-stream-index: "003.004" + started_at: + format: date-time + type: number + x-stream-index: "002.002" + task_id: + type: string + x-stream-index: "002.001" type: - default: call.blocked_user - description: 'The type of event: "call.blocked_user" in this case' - title: Event Type + default: export.users.success type: string - x-stream-index: "001.001" - user: - $ref: '#/components/schemas/UserResponse' - description: The user that was blocked - title: User - x-stream-index: "003" + x-stream-index: "003.002" + url: + type: string + x-stream-index: "001" required: + - url + - task_id + - started_at + - finished_at - type - created_at - - call_cid - - user - title: BlockedUserEvent + - custom + title: AsyncExportUsersEvent type: object - x-stream-event-call-type: true - x-stream-event-doc-group: call + x-stream-event-client-type: true + x-stream-event-doc-group: other x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - BlockedUserResponse: + AsyncModerationCallbackConfig: + properties: + mode: + enum: + - CALLBACK_MODE_NONE + - CALLBACK_MODE_REST + - CALLBACK_MODE_TWIRP + type: string + x-stream-index: "002" + server_url: + type: string + x-stream-index: "001" + type: object + AsyncModerationConfiguration: + properties: + callback: + $ref: '#/components/schemas/AsyncModerationCallbackConfig' + x-stream-index: "002" + timeout_ms: + format: int32 + type: integer + x-stream-index: "001" + type: object + Attachment: + description: An attachment is a message object that represents a file uploaded + by a user. nullable: true properties: - blocked_user: - $ref: '#/components/schemas/UserResponse' - description: User who got blocked - title: User + actions: + items: + $ref: '#/components/schemas/Action' + type: array + x-stream-index: "015" + asset_url: + type: string + x-stream-index: "017" + author_icon: + type: string + x-stream-index: "007" + author_link: + type: string + x-stream-index: "006" + author_name: + type: string + x-stream-index: "005" + color: + type: string x-stream-index: "003" - blocked_user_id: - description: ID of the user who got blocked - title: UserID + custom: + additionalProperties: {} + type: object + x-stream-index: "018" + fallback: + type: string + x-stream-index: "002" + fields: + items: + $ref: '#/components/schemas/Field' + type: array + x-stream-index: "016" + footer: + type: string + x-stream-index: "013" + footer_icon: + type: string + x-stream-index: "014" + giphy: + $ref: '#/components/schemas/Images' + x-stream-index: "019" + image_url: + type: string + x-stream-index: "011" + og_scrape_url: + type: string + x-stream-index: "020" + original_height: + format: int32 + type: integer + x-stream-index: "022" + original_width: + format: int32 + type: integer + x-stream-index: "021" + pretext: type: string x-stream-index: "004" - created_at: - format: date-time - type: number + text: + type: string + x-stream-index: "010" + thumb_url: + type: string + x-stream-index: "012" + title: + type: string + x-stream-index: "008" + title_link: + type: string + x-stream-index: "009" + type: + description: Attachment type (e.g. image, video, url) + title: Type + type: string + x-stream-index: "001" + required: + - custom + title: Attachment + type: object + x-stream-docs-page-id: file_uploads + AudioSettings: + properties: + access_request_enabled: + type: boolean + x-stream-index: "001" + default_device: + enum: + - speaker + - earpiece + type: string + x-stream-index: "006" + mic_default_on: + type: boolean + x-stream-index: "004" + noise_cancellation: + $ref: '#/components/schemas/NoiseCancellationSettings' + x-stream-index: "007" + opus_dtx_enabled: + type: boolean + x-stream-index: "002" + redundant_coding_enabled: + type: boolean + x-stream-index: "003" + speaker_default_on: + type: boolean x-stream-index: "005" - user: - $ref: '#/components/schemas/UserResponse' - description: User who blocked another user - title: User + required: + - access_request_enabled + - opus_dtx_enabled + - redundant_coding_enabled + - mic_default_on + - speaker_default_on + - default_device + type: object + AudioSettingsRequest: + properties: + access_request_enabled: + type: boolean x-stream-index: "001" - user_id: - description: ID of the user who blocked another user - title: UserID + default_device: + enum: + - speaker + - earpiece type: string + x-stream-index: "006" + mic_default_on: + type: boolean + x-stream-index: "004" + noise_cancellation: + $ref: '#/components/schemas/NoiseCancellationSettings' + x-stream-index: "007" + opus_dtx_enabled: + type: boolean x-stream-index: "002" + redundant_coding_enabled: + type: boolean + x-stream-index: "003" + speaker_default_on: + type: boolean + x-stream-index: "005" required: - - user - - user_id - - blocked_user - - blocked_user_id - - created_at + - default_device type: object - BodyguardRule: + AudioSettingsResponse: properties: - action: + access_request_enabled: + type: boolean + x-stream-index: "001" + default_device: enum: - - flag - - shadow - - remove - - bounce - - bounce_flag - - bounce_remove + - speaker + - earpiece type: string + x-stream-index: "006" + mic_default_on: + type: boolean + x-stream-index: "004" + noise_cancellation: + $ref: '#/components/schemas/NoiseCancellationSettings' + x-stream-index: "007" + opus_dtx_enabled: + type: boolean x-stream-index: "002" - label: + redundant_coding_enabled: + type: boolean + x-stream-index: "003" + speaker_default_on: + type: boolean + x-stream-index: "005" + required: + - access_request_enabled + - opus_dtx_enabled + - redundant_coding_enabled + - mic_default_on + - speaker_default_on + - default_device + type: object + AutomodDetails: + properties: + action: type: string x-stream-index: "001" - severity_rules: + image_labels: items: - $ref: '#/components/schemas/BodyguardSeverityRule' + type: string + type: array + x-stream-index: "005" + message_details: + $ref: '#/components/schemas/FlagMessageDetails' + x-stream-index: "004" + original_message_type: + type: string + x-stream-index: "002" + result: + $ref: '#/components/schemas/MessageModerationResult' + x-stream-index: "003" + type: object + AutomodPlatformCircumventionConfig: + properties: + async: + type: boolean + x-stream-index: "001" + enabled: + type: boolean + x-stream-index: "002" + rules: + items: + $ref: '#/components/schemas/AutomodRule' type: array x-stream-index: "003" required: - - label - - action - - severity_rules + - enabled + - rules type: object - BodyguardSeverityRule: + AutomodRule: properties: action: enum: @@ -1856,280 +2921,494 @@ components: - bounce_flag - bounce_remove type: string - x-stream-index: "002" - severity: - enum: - - low - - medium - - high - - critical + x-stream-index: "003" + label: type: string x-stream-index: "001" + threshold: + format: float + maximum: 1 + minimum: 0 + type: number + x-stream-index: "002" required: - - severity + - label + - threshold - action type: object - Bound: + AutomodSemanticFiltersConfig: properties: - inclusive: + async: type: boolean - x-stream-index: "002" - value: - format: float - type: number x-stream-index: "001" - required: - - value - - inclusive - type: object - BroadcastSettings: - properties: enabled: type: boolean - x-stream-index: "001" - hls: - $ref: '#/components/schemas/HLSSettings' x-stream-index: "002" - rtmp: - $ref: '#/components/schemas/RTMPSettings' + rules: + items: + $ref: '#/components/schemas/AutomodSemanticFiltersRule' + type: array x-stream-index: "003" required: - enabled + - rules type: object - BroadcastSettingsRequest: + AutomodSemanticFiltersRule: properties: - enabled: - type: boolean + action: + enum: + - flag + - shadow + - remove + type: string + x-stream-index: "003" + name: + type: string x-stream-index: "001" - hls: - $ref: '#/components/schemas/HLSSettingsRequest' + threshold: + format: float + maximum: 1 + minimum: 0 + type: number x-stream-index: "002" - rtmp: - $ref: '#/components/schemas/RTMPSettingsRequest' - x-stream-index: "003" + required: + - name + - threshold + - action type: object - BroadcastSettingsResponse: - description: BroadcastSettingsResponse is the payload for broadcasting settings + AutomodToxicityConfig: properties: - enabled: - title: Enabled + async: type: boolean x-stream-index: "001" - hls: - $ref: '#/components/schemas/HLSSettingsResponse' - title: HLS + enabled: + type: boolean x-stream-index: "002" - rtmp: - $ref: '#/components/schemas/RTMPSettingsResponse' - title: RTMP + rules: + items: + $ref: '#/components/schemas/AutomodRule' + type: array x-stream-index: "003" required: - enabled - - hls - - rtmp - title: BroadcastSettingsResponse + - rules type: object - BrowserDataResponse: + AzureRequest: + description: Config for creating Azure Blob Storage storage properties: - name: + abs_account_name: + description: The account name + title: AccountName type: string x-stream-index: "001" - version: - type: string - x-stream-index: "002" - type: object - BulkImageModerationRequest: - nullable: true - properties: - csv_file: - description: URL to CSV file containing image URLs to moderate - title: string + abs_client_id: + description: The client id + title: ClientID type: string - x-stream-index: "001" - required: - - csv_file - type: object - BulkImageModerationResponse: - nullable: true - properties: - duration: + x-stream-index: "003" + abs_client_secret: + description: The client secret + title: ClientSecret type: string - x-stream-index: "002.001" - task_id: - description: ID of the task for processing the bulk image moderation - title: string + x-stream-index: "004" + abs_tenant_id: + description: The tenant id + title: TenantID type: string - x-stream-index: "001" + x-stream-index: "002" required: - - task_id - - duration + - abs_account_name + - abs_tenant_id + - abs_client_id + - abs_client_secret + title: AzureRequest type: object - Call: + BackstageSettings: properties: - AppPK: + enabled: + type: boolean + x-stream-index: "001" + join_ahead_time_seconds: format: int32 type: integer - writeOnly: true x-stream-index: "002" - Backstage: + required: + - enabled + type: object + BackstageSettingsRequest: + properties: + enabled: type: boolean - writeOnly: true - x-stream-index: "023" - BlockedUserIDs: - items: - type: string - type: array - writeOnly: true - x-stream-index: "018" - BlockedUsers: - items: - $ref: '#/components/schemas/User' - type: array - writeOnly: true - x-stream-index: "019" - CID: - type: string - writeOnly: true - x-stream-index: "005" - CallType: - $ref: '#/components/schemas/CallType' - x-stream-index: "020" - ChannelCID: - type: string - writeOnly: true - x-stream-index: "032" - CreatedAt: + x-stream-index: "001" + join_ahead_time_seconds: + format: int32 + type: integer + x-stream-index: "002" + type: object + BackstageSettingsResponse: + properties: + enabled: + type: boolean + x-stream-index: "001" + join_ahead_time_seconds: + format: int32 + type: integer + x-stream-index: "002" + required: + - enabled + type: object + Ban: + nullable: true + properties: + channel: + $ref: '#/components/schemas/Channel' + x-stream-index: "004" + created_at: format: date-time type: number - writeOnly: true - x-stream-index: "013" - CreatedBy: + x-stream-index: "012" + created_by: $ref: '#/components/schemas/User' + x-stream-index: "011" + expires: + format: date-time + type: number + x-stream-index: "007" + reason: + type: string x-stream-index: "008" - CreatedByUserID: + shadow: + type: boolean + x-stream-index: "009" + target: + $ref: '#/components/schemas/User' + x-stream-index: "006" + required: + - shadow + - created_at + type: object + BanActionRequest: + properties: + channel_ban_only: + type: boolean + x-stream-index: "003" + delete_messages: + enum: + - soft + - pruning + - hard + type: string + x-stream-index: "005" + ip_ban: + type: boolean + x-stream-index: "004" + reason: + type: string + x-stream-index: "002" + shadow: + type: boolean + x-stream-index: "001" + timeout: + format: int32 + type: integer + x-stream-index: "006" + type: object + BanOptions: + properties: + duration: + format: int32 + type: integer + x-stream-index: "001" + ip_ban: + type: boolean + x-stream-index: "004" + reason: + type: string + x-stream-index: "002" + shadow_ban: + type: boolean + x-stream-index: "003" + type: object + BanRequest: + nullable: true + properties: + banned_by: + $ref: '#/components/schemas/UserRequest' + description: Details about the user performing the ban + title: Banned By + x-stream-index: "008" + banned_by_id: + description: ID of the user performing the ban + title: Banned By ID type: string - writeOnly: true x-stream-index: "007" - CurrentSessionID: + channel_cid: + description: Channel where the ban applies + title: Channel CID type: string - writeOnly: true - x-stream-index: "024" - Custom: - additionalProperties: {} - type: object - writeOnly: true - x-stream-index: "012" - DeletedAt: + x-stream-index: "004" + delete_messages: + enum: + - soft + - pruning + - hard + type: string + x-stream-index: "009" + ip_ban: + description: Whether to ban the user's IP address + title: IP Ban + type: boolean + x-stream-index: "006" + reason: + description: Optional explanation for the ban + title: Reason + type: string + x-stream-index: "003" + shadow: + description: Whether this is a shadow ban + title: Shadow + type: boolean + x-stream-index: "005" + target_user_id: + description: ID of the user to ban + title: Target User ID + type: string + x-stream-index: "001" + timeout: + description: Duration of the ban in minutes + minimum: 0 + title: Timeout + type: integer + x-stream-index: "002" + required: + - target_user_id + type: object + BanResponse: + nullable: true + properties: + banned_by: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "006" + channel: + $ref: '#/components/schemas/ChannelResponse' + x-stream-index: "001" + created_at: format: date-time type: number - writeOnly: true - x-stream-index: "028" - EgressUpdatedAt: + x-stream-index: "007" + expires: format: date-time type: number - writeOnly: true - x-stream-index: "027" - Egresses: + x-stream-index: "003" + reason: + type: string + x-stream-index: "004" + shadow: + type: boolean + x-stream-index: "005" + user: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "002" + required: + - created_at + type: object + BlockContentOptions: + properties: + reason: + type: string + x-stream-index: "001" + type: object + BlockListConfig: + properties: + async: + type: boolean + x-stream-index: "001" + enabled: + type: boolean + x-stream-index: "002" + rules: items: - $ref: '#/components/schemas/CallEgress' + $ref: '#/components/schemas/BlockListRule' + maximum: 10 type: array - writeOnly: true - x-stream-index: "015" - EndedAt: + x-stream-index: "003" + required: + - enabled + - rules + type: object + BlockListOptions: + properties: + behavior: + description: Blocklist behavior + enum: + - flag + - block + - shadow_block + title: Behavior + type: string + x-stream-index: "002" + blocklist: + description: Blocklist name + title: Blocklist + type: string + x-stream-index: "001" + required: + - blocklist + - behavior + type: object + BlockListResponse: + description: Block list contains restricted words + properties: + created_at: + description: Date/time of creation format: date-time + title: Created at type: number - writeOnly: true - x-stream-index: "017" - ID: + x-stream-index: "001" + id: + type: string + x-stream-index: "003" + name: + description: Block list name + title: Name type: string - writeOnly: true x-stream-index: "004" - JoinAheadTimeSeconds: - format: int32 - type: integer - writeOnly: true - x-stream-index: "031" - LastHeartbeatAt: + team: + type: string + x-stream-index: "007" + type: + description: Block list type. + title: Type + type: string + x-stream-index: "005" + updated_at: + description: Date/time of the last update format: date-time + title: Updated at type: number - writeOnly: true - x-stream-index: "030" - LastSessionID: - type: string - writeOnly: true - x-stream-index: "025" - MemberCount: - format: int32 - type: integer - writeOnly: true - x-stream-index: "010" - MemberLookup: - $ref: '#/components/schemas/MemberLookup' - x-stream-index: "011" - Members: + x-stream-index: "002" + words: + description: List of words to block items: - $ref: '#/components/schemas/CallMember' + type: string + title: Words type: array - writeOnly: true - x-stream-index: "009" - Session: - $ref: '#/components/schemas/CallSession' - x-stream-index: "026" - Settings: - $ref: '#/components/schemas/CallSettings' - x-stream-index: "022" - SettingsOverrides: - $ref: '#/components/schemas/CallSettings' - x-stream-index: "021" - StartsAt: - format: date-time - type: number - writeOnly: true - x-stream-index: "016" - Team: - type: string - writeOnly: true x-stream-index: "006" - ThumbnailURL: + required: + - name + - type + - words + title: Block list + type: object + x-stream-docs-page-id: block_lists + BlockListRule: + properties: + action: + enum: + - flag + - mask_flag + - shadow + - remove + - bounce + - bounce_flag + - bounce_remove type: string - writeOnly: true - x-stream-index: "029" - Type: + x-stream-index: "003" + name: + type: string + x-stream-index: "001" + team: + type: string + x-stream-index: "002" + required: + - name + - team + - action + type: object + BlockUserRequest: + description: BlockUserRequest is the payload for blocking a user. + nullable: true + properties: + user_id: + description: the user to block + title: UserID type: string - writeOnly: true x-stream-index: "003" - UpdatedAt: + required: + - user_id + title: BlockUserRequest + type: object + BlockUserResponse: + description: BlockUserResponse is the payload for blocking a user. + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "001.001" + required: + - duration + title: BlockUserResponse + type: object + BlockUsersRequest: + nullable: true + properties: + blocked_user_id: + description: User id to block + title: BlockedUserID + type: string + x-stream-index: "001" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "003.002" + user_id: + type: string + x-stream-index: "003.001" + required: + - blocked_user_id + type: object + BlockUsersResponse: + nullable: true + properties: + blocked_by_user_id: + description: User id who blocked another user + title: BlockedByUserID + type: string + x-stream-index: "002" + blocked_user_id: + description: User id who got blocked + title: BlockedUserID + type: string + x-stream-index: "003" + created_at: + description: Timestamp when the user was blocked format: date-time + title: CreatedAt type: number - writeOnly: true - x-stream-index: "014" + x-stream-index: "004" + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "001.001" required: - - AppPK - - Type - - ID - - CID - - Team - - CreatedByUserID - - Members - - Custom - - CreatedAt - - UpdatedAt - - Egresses - - BlockedUserIDs - - BlockedUsers - - Backstage - - CurrentSessionID - - LastSessionID - - ThumbnailURL - - ChannelCID + - duration + - blocked_by_user_id + - blocked_user_id + - created_at type: object - CallAcceptedEvent: - description: This event is sent when a user accepts a notification to join a - call. + BlockedUserEvent: + description: |- + This event is sent to call participants to notify when a user is blocked on a call, clients can use this event to show a notification. + If the user is the current user, the client should leave the call screen as well properties: - call: - $ref: '#/components/schemas/CallResponse' - x-stream-index: "003" + blocked_by_user: + $ref: '#/components/schemas/UserResponse' + description: The user that blocked the user, null if the user was blocked + by server-side + title: Blocked by + x-stream-index: "004" call_cid: type: string x-stream-index: "002.001" @@ -2138,524 +3417,669 @@ components: type: number x-stream-index: "001.002" type: - default: call.accepted - description: 'The type of event: "call.accepted" in this case' + default: call.blocked_user + description: 'The type of event: "call.blocked_user" in this case' title: Event Type type: string x-stream-index: "001.001" user: $ref: '#/components/schemas/UserResponse' - description: The user who accepted the call + description: The user that was blocked title: User - x-stream-index: "004" + x-stream-index: "003" required: - type - created_at - call_cid - - call - user - title: CallAcceptedEvent + title: BlockedUserEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: ring + x-stream-event-doc-group: call x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallClosedCaption: - description: CallClosedCaption represents a closed caption of a call. + BlockedUserResponse: + nullable: true properties: - end_time: - format: date-time - title: The end time of the closed caption. - type: number + blocked_user: + $ref: '#/components/schemas/UserResponse' + description: User who got blocked + title: User x-stream-index: "003" - speaker_id: - title: The speaker ID of the closed caption. + blocked_user_id: + description: ID of the user who got blocked + title: UserID type: string x-stream-index: "004" - start_time: + created_at: format: date-time - title: The start time of the closed caption. type: number - x-stream-index: "002" - text: - title: The text of the closed caption. - type: string - x-stream-index: "001" + x-stream-index: "005" user: $ref: '#/components/schemas/UserResponse' - title: The full user for the closed caption. - x-stream-index: "005" + description: User who blocked another user + title: User + x-stream-index: "001" + user_id: + description: ID of the user who blocked another user + title: UserID + type: string + x-stream-index: "002" required: - - text - - start_time - - end_time - - speaker_id - user - title: CallClosedCaption + - user_id + - blocked_user + - blocked_user_id + - created_at type: object - CallClosedCaptionsFailedEvent: - description: This event is sent when call closed captions has failed + BodyguardRule: properties: - call_cid: + action: + enum: + - flag + - shadow + - remove + - bounce + - bounce_flag + - bounce_remove type: string - x-stream-index: "002.001" - created_at: - format: date-time - type: number - x-stream-index: "001.002" - type: - default: call.closed_captions_failed - description: 'The type of event: "call.closed_captions_failed" in this case' - title: Event Type + x-stream-index: "002" + label: type: string - x-stream-index: "001.001" + x-stream-index: "001" + severity_rules: + items: + $ref: '#/components/schemas/BodyguardSeverityRule' + type: array + x-stream-index: "003" required: - - type - - created_at - - call_cid - title: CallClosedCaptionsFailedEvent + - label + - action + - severity_rules type: object - x-stream-event-call-type: true - x-stream-event-doc-group: transcription - x-stream-is-event: true - x-stream-ws-base-event-name: VideoEvent - CallClosedCaptionsStartedEvent: - description: This event is sent when call closed caption has started + BodyguardSeverityRule: properties: - call_cid: + action: + enum: + - flag + - shadow + - remove + - bounce + - bounce_flag + - bounce_remove type: string - x-stream-index: "002.001" - created_at: - format: date-time - type: number - x-stream-index: "001.002" - type: - default: call.closed_captions_started - description: 'The type of event: "call.closed_captions_started" in this - case' - title: Event Type + x-stream-index: "002" + severity: + enum: + - low + - medium + - high + - critical type: string - x-stream-index: "001.001" + x-stream-index: "001" required: - - type - - created_at - - call_cid - title: CallClosedCaptionsStartedEvent + - severity + - action type: object - x-stream-event-call-type: true - x-stream-event-doc-group: transcription - x-stream-is-event: true - x-stream-ws-base-event-name: VideoEvent - CallClosedCaptionsStoppedEvent: - description: This event is sent when call closed captions has stopped + BookmarkAddedEvent: + description: Emitted when a user bookmarks an activity. + nullable: true properties: - call_cid: - type: string - x-stream-index: "002.001" + bookmark: + $ref: '#/components/schemas/BookmarkResponse' + x-stream-index: "001" created_at: + description: Date/time of creation format: date-time + title: Created at type: number - x-stream-index: "001.002" + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 type: - default: call.closed_captions_stopped - description: 'The type of event: "call.transcription_stopped" in this case' + default: feeds.bookmark.added + description: 'The type of event: "feeds.bookmark.added" in this case' title: Event Type type: string - x-stream-index: "001.001" + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who added the bookmark + title: User + x-stream-index: "003.001" required: + - bookmark - type - created_at - - call_cid - title: CallClosedCaptionsStoppedEvent + - custom + title: BookmarkAddedEvent type: object - x-stream-event-call-type: true - x-stream-event-doc-group: transcription + x-stream-event-client-type: true + x-stream-event-doc-group: other x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallCreatedEvent: - description: |- - This event is sent when a call is created. Clients receiving this event should check if the ringing - field is set to true and if so, show the call screen + BookmarkDeletedEvent: + description: Emitted when a user deletes a bookmark from an activity. + nullable: true properties: - call: - $ref: '#/components/schemas/CallResponse' - description: Call object - title: Call - x-stream-index: "003" - call_cid: - type: string - x-stream-index: "002.001" + bookmark: + $ref: '#/components/schemas/BookmarkResponse' + x-stream-index: "001" created_at: + description: Date/time of creation format: date-time + title: Created at type: number - x-stream-index: "001.002" - members: - description: the members added to this call - items: - $ref: '#/components/schemas/MemberResponse' - title: Members - type: array - x-stream-index: "004" + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 type: - default: call.created - description: 'The type of event: "call.created" in this case' + default: feeds.bookmark.deleted + description: 'The type of event: "feeds.bookmark.deleted" in this case' title: Event Type type: string - x-stream-index: "001.001" + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who removed the bookmark + title: User + x-stream-index: "003.001" required: + - bookmark - type - created_at - - call_cid - - call - - members - title: CallCreatedEvent + - custom + title: BookmarkDeletedEvent type: object - x-stream-event-call-type: true - x-stream-event-doc-group: call + x-stream-event-client-type: true + x-stream-event-doc-group: other x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallDeletedEvent: - description: This event is sent when a call is deleted. Clients receiving this - event should leave the call screen + BookmarkFolderDeletedEvent: + description: Emitted when a bookmark folder is deleted. + nullable: true properties: - call: - $ref: '#/components/schemas/CallResponse' - description: Call object - title: Call - x-stream-index: "003" - call_cid: - type: string - x-stream-index: "002.001" + bookmark_folder: + $ref: '#/components/schemas/BookmarkFolderResponse' + description: The bookmark folder that was deleted + title: Bookmark Folder + x-stream-index: "001" created_at: + description: Date/time of creation format: date-time + title: Created at type: number - x-stream-index: "001.002" + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 type: - default: call.deleted - description: 'The type of event: "call.deleted" in this case' + default: feeds.bookmark_folder.deleted + description: 'The type of event: "feeds.bookmark_folder.deleted" in this + case' title: Event Type type: string - x-stream-index: "001.001" + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who deleted the bookmark folder + title: User + x-stream-index: "003.001" required: + - bookmark_folder - type - created_at - - call_cid - - call - title: CallDeletedEvent + - custom + title: BookmarkFolderDeletedEvent type: object - x-stream-event-call-type: true - x-stream-event-doc-group: call + x-stream-event-client-type: true + x-stream-event-doc-group: other x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallDurationReport: - properties: - histogram: - items: - $ref: '#/components/schemas/ReportByHistogramBucket' - type: array - x-stream-index: "001" - required: - - histogram - type: object - CallDurationReportResponse: - properties: - daily: - items: - $ref: '#/components/schemas/DailyAggregateCallDurationReportResponse' - type: array - x-stream-index: "001" - required: - - daily - type: object - CallEgress: - nullable: true + BookmarkFolderResponse: properties: - app_pk: - format: int32 - type: integer - x-stream-index: "002" - call_id: - type: string + created_at: + description: When the folder was created + format: date-time + title: Created At + type: number x-stream-index: "004" - call_type: - type: string + custom: + additionalProperties: {} + description: Custom data for the folder + title: Custom Data + type: object x-stream-index: "003" - config: - $ref: '#/components/schemas/EgressTaskConfig' - x-stream-index: "007" - egress_id: - type: string - x-stream-index: "005" - egress_type: - type: string - x-stream-index: "006" - instance_ip: + id: + description: Unique identifier for the folder + title: ID type: string - x-stream-index: "008" - started_at: - format: date-time - type: number - x-stream-index: "010" - state: + x-stream-index: "001" + name: + description: Name of the folder + title: Name type: string - x-stream-index: "009" - stopped_at: - format: date-time - type: number - x-stream-index: "011" + x-stream-index: "002" updated_at: + description: When the folder was last updated format: date-time + title: Updated At type: number - x-stream-index: "012" + x-stream-index: "005" required: - - app_pk - - call_type - - call_id - - egress_id - - egress_type - - instance_ip - - state - - started_at + - id + - name + - created_at - updated_at + title: Bookmark Folder type: object - CallEndedEvent: - description: This event is sent when a call is mark as ended for all its participants. - Clients receiving this event should leave the call screen + BookmarkFolderUpdatedEvent: + description: Emitted when a bookmark folder is updated. + nullable: true properties: - call: - $ref: '#/components/schemas/CallResponse' - x-stream-index: "003" - call_cid: - type: string - x-stream-index: "002.001" + bookmark_folder: + $ref: '#/components/schemas/BookmarkFolderResponse' + description: The bookmark folder that was updated + title: Bookmark Folder + x-stream-index: "001" created_at: + description: Date/time of creation format: date-time + title: Created at type: number - x-stream-index: "001.002" - reason: - description: The reason why the call ended, if available - title: CallEndedReason - type: string - x-stream-index: "005" + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 type: - default: call.ended - description: 'The type of event: "call.ended" in this case' + default: feeds.bookmark_folder.updated + description: 'The type of event: "feeds.bookmark_folder.updated" in this + case' title: Event Type type: string - x-stream-index: "001.001" + x-stream-index: 002.001.002 user: - $ref: '#/components/schemas/UserResponse' - description: The user who ended the call, null if the call was ended by - the server + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who updated the bookmark folder title: User - x-stream-index: "004" + x-stream-index: "003.001" required: + - bookmark_folder - type - created_at - - call_cid - - call - title: CallEndedEvent + - custom + title: BookmarkFolderUpdatedEvent type: object - x-stream-event-call-type: true - x-stream-event-doc-group: call + x-stream-event-client-type: true + x-stream-event-doc-group: other x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallFrameRecordingFailedEvent: - description: This event is sent when frame recording has failed + BookmarkResponse: properties: - call: - $ref: '#/components/schemas/CallResponse' - x-stream-index: "003" - call_cid: - type: string - x-stream-index: "002.001" + activity: + $ref: '#/components/schemas/ActivityResponse' + description: The bookmarked activity + title: Activity + x-stream-index: "002" created_at: + description: When the bookmark was created format: date-time + title: Created At type: number - x-stream-index: "001.002" - egress_id: - type: string + x-stream-index: "005" + custom: + additionalProperties: {} + description: Custom data for the bookmark + title: Custom Data + type: object x-stream-index: "004" - type: - default: call.frame_recording_failed - description: 'The type of event: "call.frame_recording_failed" in this case' - title: Event Type - type: string - x-stream-index: "001.001" + folder: + $ref: '#/components/schemas/BookmarkFolderResponse' + description: Folder containing this bookmark + title: Folder + x-stream-index: "003" + updated_at: + description: When the bookmark was last updated + format: date-time + title: Updated At + type: number + x-stream-index: "006" + user: + $ref: '#/components/schemas/UserResponse' + description: User who created the bookmark + title: User + x-stream-index: "001" required: - - type + - user + - activity - created_at - - call_cid - - call - - egress_id - title: CallFrameRecordingFailedEvent + - updated_at + title: Bookmark type: object - x-stream-event-call-type: true - x-stream-event-doc-group: recording - x-stream-is-event: true - x-stream-ws-base-event-name: VideoEvent - CallFrameRecordingFrameReadyEvent: - description: This event is sent when a frame is captured from a call + BookmarkUpdatedEvent: + description: Emitted when a user updates a bookmark. + nullable: true properties: - call_cid: - type: string - x-stream-index: "002.001" - captured_at: - description: The time the frame was captured + bookmark: + $ref: '#/components/schemas/BookmarkResponse' + description: The updated bookmark + title: Bookmark + x-stream-index: "001" + created_at: + description: Date/time of creation format: date-time - title: CapturedAt + title: Created at type: number - x-stream-index: "006" - created_at: + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + received_at: format: date-time type: number - x-stream-index: "001.002" - egress_id: - type: string - x-stream-index: "008" - session_id: - description: Call session ID - title: Session ID - type: string - x-stream-index: "003.001" - track_type: - description: The type of the track frame was captured from (TRACK_TYPE_VIDEO|TRACK_TYPE_SCREEN_SHARE) - title: TrackType - type: string - x-stream-index: "004" + x-stream-index: 002.001.004 type: - default: call.frame_recording_ready - description: 'The type of event: "call.frame_recording_ready" in this case' + default: feeds.bookmark.updated + description: 'The type of event: "feeds.bookmark.updated" in this case' title: Event Type type: string - x-stream-index: "001.001" - url: - description: The URL of the frame - title: URL - type: string - x-stream-index: "005" - users: - additionalProperties: - $ref: '#/components/schemas/UserResponse' - description: The users in the frame - title: Users - type: object - x-stream-index: "007" + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who updated the bookmark + title: User + x-stream-index: "003.001" required: + - bookmark - type - created_at - - call_cid - - session_id - - track_type - - url - - captured_at - - users - - egress_id - title: CallFrameRecordingFrameReadyEvent + - custom + title: BookmarkUpdatedEvent type: object - x-stream-event-call-type: true - x-stream-event-doc-group: recording + x-stream-event-client-type: true + x-stream-event-doc-group: other x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallFrameRecordingStartedEvent: - description: This event is sent when frame recording has started + Bound: properties: - call: - $ref: '#/components/schemas/CallResponse' - x-stream-index: "003" - call_cid: - type: string - x-stream-index: "002.001" - created_at: - format: date-time + inclusive: + type: boolean + x-stream-index: "002" + value: + format: float type: number - x-stream-index: "001.002" - egress_id: - type: string - x-stream-index: "004" - type: - default: call.frame_recording_started - description: 'The type of event: "call.frame_recording_started" in this - case' - title: Event Type - type: string - x-stream-index: "001.001" + x-stream-index: "001" required: - - type - - created_at - - call_cid - - call - - egress_id - title: CallFrameRecordingStartedEvent + - value + - inclusive type: object - x-stream-event-call-type: true - x-stream-event-doc-group: recording - x-stream-is-event: true - x-stream-ws-base-event-name: VideoEvent - CallFrameRecordingStoppedEvent: - description: This event is sent when frame recording has stopped + BroadcastSettings: properties: - call: - $ref: '#/components/schemas/CallResponse' + enabled: + type: boolean + x-stream-index: "001" + hls: + $ref: '#/components/schemas/HLSSettings' + x-stream-index: "002" + rtmp: + $ref: '#/components/schemas/RTMPSettings' x-stream-index: "003" - call_cid: - type: string - x-stream-index: "002.001" - created_at: - format: date-time - type: number - x-stream-index: "001.002" - egress_id: + required: + - enabled + type: object + BroadcastSettingsRequest: + properties: + enabled: + type: boolean + x-stream-index: "001" + hls: + $ref: '#/components/schemas/HLSSettingsRequest' + x-stream-index: "002" + rtmp: + $ref: '#/components/schemas/RTMPSettingsRequest' + x-stream-index: "003" + type: object + BroadcastSettingsResponse: + description: BroadcastSettingsResponse is the payload for broadcasting settings + properties: + enabled: + title: Enabled + type: boolean + x-stream-index: "001" + hls: + $ref: '#/components/schemas/HLSSettingsResponse' + title: HLS + x-stream-index: "002" + rtmp: + $ref: '#/components/schemas/RTMPSettingsResponse' + title: RTMP + x-stream-index: "003" + required: + - enabled + - hls + - rtmp + title: BroadcastSettingsResponse + type: object + BrowserDataResponse: + properties: + name: type: string - x-stream-index: "004" - type: - default: call.frame_recording_stopped - description: 'The type of event: "call.frame_recording_stopped" in this - case' - title: Event Type + x-stream-index: "001" + version: type: string - x-stream-index: "001.001" + x-stream-index: "002" + type: object + BulkImageModerationRequest: + nullable: true + properties: + csv_file: + description: URL to CSV file containing image URLs to moderate + title: string + type: string + x-stream-index: "001" required: - - type - - created_at - - call_cid - - call - - egress_id - title: CallFrameRecordingStoppedEvent + - csv_file type: object - x-stream-event-call-type: true - x-stream-event-doc-group: recording - x-stream-is-event: true - x-stream-ws-base-event-name: VideoEvent - CallHLSBroadcastingFailedEvent: - description: This event is sent when HLS broadcasting has failed + BulkImageModerationResponse: + nullable: true properties: - call_cid: + duration: type: string x-stream-index: "002.001" - created_at: + task_id: + description: ID of the task for processing the bulk image moderation + title: string + type: string + x-stream-index: "001" + required: + - task_id + - duration + type: object + Call: + properties: + AppPK: + format: int32 + type: integer + writeOnly: true + x-stream-index: "002" + Backstage: + type: boolean + writeOnly: true + x-stream-index: "023" + BlockedUserIDs: + items: + type: string + type: array + writeOnly: true + x-stream-index: "018" + BlockedUsers: + items: + $ref: '#/components/schemas/User' + type: array + writeOnly: true + x-stream-index: "019" + CID: + type: string + writeOnly: true + x-stream-index: "005" + CallType: + $ref: '#/components/schemas/CallType' + x-stream-index: "020" + ChannelCID: + type: string + writeOnly: true + x-stream-index: "032" + CreatedAt: format: date-time type: number - x-stream-index: "001.002" - type: - default: call.hls_broadcasting_failed - description: 'The type of event: "call.hls_broadcasting_failed" in this - case' - title: Event Type + writeOnly: true + x-stream-index: "013" + CreatedBy: + $ref: '#/components/schemas/User' + x-stream-index: "008" + CreatedByUserID: type: string - x-stream-index: "001.001" + writeOnly: true + x-stream-index: "007" + CurrentSessionID: + type: string + writeOnly: true + x-stream-index: "024" + Custom: + additionalProperties: {} + type: object + writeOnly: true + x-stream-index: "012" + DeletedAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "028" + EgressUpdatedAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "027" + Egresses: + items: + $ref: '#/components/schemas/CallEgress' + type: array + writeOnly: true + x-stream-index: "015" + EndedAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "017" + ID: + type: string + writeOnly: true + x-stream-index: "004" + JoinAheadTimeSeconds: + format: int32 + type: integer + writeOnly: true + x-stream-index: "031" + LastHeartbeatAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "030" + LastSessionID: + type: string + writeOnly: true + x-stream-index: "025" + MemberCount: + format: int32 + type: integer + writeOnly: true + x-stream-index: "010" + MemberLookup: + $ref: '#/components/schemas/MemberLookup' + x-stream-index: "011" + Members: + items: + $ref: '#/components/schemas/CallMember' + type: array + writeOnly: true + x-stream-index: "009" + Session: + $ref: '#/components/schemas/CallSession' + x-stream-index: "026" + Settings: + $ref: '#/components/schemas/CallSettings' + x-stream-index: "022" + SettingsOverrides: + $ref: '#/components/schemas/CallSettings' + x-stream-index: "021" + StartsAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "016" + Team: + type: string + writeOnly: true + x-stream-index: "006" + ThumbnailURL: + type: string + writeOnly: true + x-stream-index: "029" + Type: + type: string + writeOnly: true + x-stream-index: "003" + UpdatedAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "014" required: - - type - - created_at - - call_cid - title: CallHLSBroadcastingFailedEvent + - AppPK + - Type + - ID + - CID + - Team + - CreatedByUserID + - Members + - Custom + - CreatedAt + - UpdatedAt + - Egresses + - BlockedUserIDs + - BlockedUsers + - Backstage + - CurrentSessionID + - LastSessionID + - ThumbnailURL + - ChannelCID type: object - x-stream-event-call-type: true - x-stream-event-doc-group: streaming - x-stream-is-event: true - x-stream-ws-base-event-name: VideoEvent - CallHLSBroadcastingStartedEvent: - description: This event is sent when HLS broadcasting has started + CallAcceptedEvent: + description: This event is sent when a user accepts a notification to join a + call. properties: call: $ref: '#/components/schemas/CallResponse' @@ -2667,75 +4091,65 @@ components: format: date-time type: number x-stream-index: "001.002" - hls_playlist_url: - type: string - x-stream-index: "004" type: - default: call.hls_broadcasting_started - description: 'The type of event: "call.hls_broadcasting_started" in this - case' + default: call.accepted + description: 'The type of event: "call.accepted" in this case' title: Event Type type: string x-stream-index: "001.001" + user: + $ref: '#/components/schemas/UserResponse' + description: The user who accepted the call + title: User + x-stream-index: "004" required: - type - created_at - call_cid - call - - hls_playlist_url - title: CallHLSBroadcastingStartedEvent + - user + title: CallAcceptedEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: streaming + x-stream-event-doc-group: ring x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallHLSBroadcastingStoppedEvent: - description: This event is sent when HLS broadcasting has stopped + CallClosedCaption: + description: CallClosedCaption represents a closed caption of a call. properties: - call_cid: + end_time: + format: date-time + title: The end time of the closed caption. + type: number + x-stream-index: "003" + speaker_id: + title: The speaker ID of the closed caption. type: string - x-stream-index: "002.001" - created_at: + x-stream-index: "004" + start_time: format: date-time + title: The start time of the closed caption. type: number - x-stream-index: "001.002" - type: - default: call.hls_broadcasting_stopped - description: 'The type of event: "call.hls_broadcasting_stopped" in this - case' - title: Event Type + x-stream-index: "002" + text: + title: The text of the closed caption. type: string - x-stream-index: "001.001" - required: - - type - - created_at - - call_cid - title: CallHLSBroadcastingStoppedEvent - type: object - x-stream-event-call-type: true - x-stream-event-doc-group: streaming - x-stream-is-event: true - x-stream-ws-base-event-name: VideoEvent - CallIngressResponse: - description: CallIngressResponse is the payload for ingress settings - properties: - rtmp: - $ref: '#/components/schemas/RTMPIngress' - title: RTMP x-stream-index: "001" + user: + $ref: '#/components/schemas/UserResponse' + title: The full user for the closed caption. + x-stream-index: "005" required: - - rtmp - title: CallIngressResponse + - text + - start_time + - end_time + - speaker_id + - user + title: CallClosedCaption type: object - CallLiveStartedEvent: - description: This event is sent when a call is started. Clients receiving this - event should start the call. + CallClosedCaptionsFailedEvent: + description: This event is sent when call closed captions has failed properties: - call: - $ref: '#/components/schemas/CallResponse' - description: Call object - title: Call - x-stream-index: "003" call_cid: type: string x-stream-index: "002.001" @@ -2744,8 +4158,8 @@ components: type: number x-stream-index: "001.002" type: - default: call.live_started - description: 'The type of event: "call.live_started" in this case' + default: call.closed_captions_failed + description: 'The type of event: "call.closed_captions_failed" in this case' title: Event Type type: string x-stream-index: "001.001" @@ -2753,56 +4167,15 @@ components: - type - created_at - call_cid - - call - title: CallLiveStartedEvent + title: CallClosedCaptionsFailedEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: streaming + x-stream-event-doc-group: transcription x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallMember: - nullable: true - properties: - created_at: - format: date-time - type: number - x-stream-index: "008" - custom: - additionalProperties: {} - type: object - x-stream-index: "007" - deleted_at: - format: date-time - type: number - x-stream-index: "010" - role: - type: string - x-stream-index: "006" - updated_at: - format: date-time - type: number - x-stream-index: "009" - user: - $ref: '#/components/schemas/User' - x-stream-index: "005" - user_id: - type: string - x-stream-index: "004" - required: - - user_id - - role - - custom - - created_at - - updated_at - type: object - CallMemberAddedEvent: - description: This event is sent when one or more members are added to a call + CallClosedCaptionsStartedEvent: + description: This event is sent when call closed caption has started properties: - call: - $ref: '#/components/schemas/CallResponse' - description: Call object - title: Call - x-stream-index: "003" call_cid: type: string x-stream-index: "002.001" @@ -2810,16 +4183,10 @@ components: format: date-time type: number x-stream-index: "001.002" - members: - description: the members added to this call - items: - $ref: '#/components/schemas/MemberResponse' - title: Members - type: array - x-stream-index: "004" type: - default: call.member_added - description: 'The type of event: "call.member_added" in this case' + default: call.closed_captions_started + description: 'The type of event: "call.closed_captions_started" in this + case' title: Event Type type: string x-stream-index: "001.001" @@ -2827,23 +4194,15 @@ components: - type - created_at - call_cid - - call - - members - title: CallMemberAddedEvent + title: CallClosedCaptionsStartedEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: call + x-stream-event-doc-group: transcription x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallMemberRemovedEvent: - description: This event is sent when one or more members are removed from a - call + CallClosedCaptionsStoppedEvent: + description: This event is sent when call closed captions has stopped properties: - call: - $ref: '#/components/schemas/CallResponse' - description: Call object - title: Call - x-stream-index: "003" call_cid: type: string x-stream-index: "002.001" @@ -2851,16 +4210,9 @@ components: format: date-time type: number x-stream-index: "001.002" - members: - description: the list of member IDs removed from the call - items: - type: string - title: Members - type: array - x-stream-index: "004" type: - default: call.member_removed - description: 'The type of event: "call.member_removed" in this case' + default: call.closed_captions_stopped + description: 'The type of event: "call.transcription_stopped" in this case' title: Event Type type: string x-stream-index: "001.001" @@ -2868,16 +4220,16 @@ components: - type - created_at - call_cid - - call - - members - title: CallMemberRemovedEvent + title: CallClosedCaptionsStoppedEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: call + x-stream-event-doc-group: transcription x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallMemberUpdatedEvent: - description: This event is sent when one or more members are updated + CallCreatedEvent: + description: |- + This event is sent when a call is created. Clients receiving this event should check if the ringing + field is set to true and if so, show the call screen properties: call: $ref: '#/components/schemas/CallResponse' @@ -2892,15 +4244,15 @@ components: type: number x-stream-index: "001.002" members: - description: The list of members that were updated + description: the members added to this call items: $ref: '#/components/schemas/MemberResponse' title: Members type: array x-stream-index: "004" type: - default: call.member_updated - description: 'The type of event: "call.member_updated" in this case' + default: call.created + description: 'The type of event: "call.created" in this case' title: Event Type type: string x-stream-index: "001.001" @@ -2910,14 +4262,15 @@ components: - call_cid - call - members - title: CallMemberUpdatedEvent + title: CallCreatedEvent type: object x-stream-event-call-type: true x-stream-event-doc-group: call x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallMemberUpdatedPermissionEvent: - description: This event is sent when one or more members get its role updated + CallDeletedEvent: + description: This event is sent when a call is deleted. Clients receiving this + event should leave the call screen properties: call: $ref: '#/components/schemas/CallResponse' @@ -2927,29 +4280,13 @@ components: call_cid: type: string x-stream-index: "002.001" - capabilities_by_role: - additionalProperties: - items: - type: string - type: array - description: The capabilities by role for this call - title: CapabilitiesByRole - type: object - x-stream-index: "004" created_at: format: date-time type: number x-stream-index: "001.002" - members: - description: The list of members that were updated - items: - $ref: '#/components/schemas/MemberResponse' - title: Members - type: array - x-stream-index: "005" type: - default: call.member_updated_permission - description: 'The type of event: "call.member_added" in this case' + default: call.deleted + description: 'The type of event: "call.deleted" in this case' title: Event Type type: string x-stream-index: "001.001" @@ -2958,73 +4295,90 @@ components: - created_at - call_cid - call - - capabilities_by_role - - members - title: CallMemberUpdatedPermissionEvent + title: CallDeletedEvent type: object x-stream-event-call-type: true x-stream-event-doc-group: call x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallMissedEvent: - description: This event is sent to call members who did not accept/reject/join - the call to notify they missed the call + CallDurationReport: properties: - call: - $ref: '#/components/schemas/CallResponse' - description: Call object - title: Call - x-stream-index: "004" - call_cid: - type: string - x-stream-index: "002.001" - created_at: - format: date-time - type: number - x-stream-index: "001.002" - members: - description: List of members who missed the call + histogram: items: - $ref: '#/components/schemas/MemberResponse' - title: Members + $ref: '#/components/schemas/ReportByHistogramBucket' type: array - x-stream-index: "005" - notify_user: - type: boolean + x-stream-index: "001" + required: + - histogram + type: object + CallDurationReportResponse: + properties: + daily: + items: + $ref: '#/components/schemas/DailyAggregateCallDurationReportResponse' + type: array + x-stream-index: "001" + required: + - daily + type: object + CallEgress: + nullable: true + properties: + app_pk: + format: int32 + type: integer + x-stream-index: "002" + call_id: + type: string + x-stream-index: "004" + call_type: + type: string + x-stream-index: "003" + config: + $ref: '#/components/schemas/EgressTaskConfig' x-stream-index: "007" - session_id: - description: Call session ID - title: Session ID + egress_id: type: string - x-stream-index: "003.001" - type: - default: call.missed - description: 'The type of event: "call.notification" in this case' - title: Event Type + x-stream-index: "005" + egress_type: type: string - x-stream-index: "001.001" - user: - $ref: '#/components/schemas/UserResponse' - description: The caller from whom the call was missed - title: User x-stream-index: "006" + instance_ip: + type: string + x-stream-index: "008" + started_at: + format: date-time + type: number + x-stream-index: "010" + state: + type: string + x-stream-index: "009" + stopped_at: + format: date-time + type: number + x-stream-index: "011" + updated_at: + format: date-time + type: number + x-stream-index: "012" required: - - type - - created_at - - call_cid - - session_id - - call - - members - - user - - notify_user - title: CallMissedEvent + - app_pk + - call_type + - call_id + - egress_id + - egress_type + - instance_ip + - state + - started_at + - updated_at type: object - x-stream-event-call-type: true - x-stream-event-doc-group: ring - x-stream-is-event: true - x-stream-ws-base-event-name: VideoEvent - CallModerationBlurEvent: + CallEndedEvent: + description: This event is sent when a call is mark as ended for all its participants. + Clients receiving this event should leave the call screen properties: + call: + $ref: '#/components/schemas/CallResponse' + x-stream-index: "003" call_cid: type: string x-stream-index: "002.001" @@ -3032,31 +4386,40 @@ components: format: date-time type: number x-stream-index: "001.002" - custom: - additionalProperties: {} - type: object - x-stream-index: "004" + reason: + description: The reason why the call ended, if available + title: CallEndedReason + type: string + x-stream-index: "005" type: - default: call.moderation_blur + default: call.ended + description: 'The type of event: "call.ended" in this case' + title: Event Type type: string x-stream-index: "001.001" - user_id: - type: string - x-stream-index: "003" + user: + $ref: '#/components/schemas/UserResponse' + description: The user who ended the call, null if the call was ended by + the server + title: User + x-stream-index: "004" required: - type - created_at - call_cid - - user_id - - custom - title: CallModerationBlurEvent + - call + title: CallEndedEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: other + x-stream-event-doc-group: call x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallModerationWarningEvent: + CallFrameRecordingFailedEvent: + description: This event is sent when frame recording has failed properties: + call: + $ref: '#/components/schemas/CallResponse' + x-stream-index: "003" call_cid: type: string x-stream-index: "002.001" @@ -3064,237 +4427,96 @@ components: format: date-time type: number x-stream-index: "001.002" - custom: - additionalProperties: {} - type: object - x-stream-index: "005" - message: + egress_id: type: string x-stream-index: "004" type: - default: call.moderation_warning + default: call.frame_recording_failed + description: 'The type of event: "call.frame_recording_failed" in this case' + title: Event Type type: string x-stream-index: "001.001" - user_id: - type: string - x-stream-index: "003" required: - type - created_at - call_cid - - user_id - - message - - custom - title: CallModerationWarningEvent + - call + - egress_id + title: CallFrameRecordingFailedEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: other + x-stream-event-doc-group: recording x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallNotificationEvent: - description: This event is sent to all call members to notify they are getting - called + CallFrameRecordingFrameReadyEvent: + description: This event is sent when a frame is captured from a call properties: - call: - $ref: '#/components/schemas/CallResponse' - description: Call object - title: Call - x-stream-index: "004" call_cid: type: string x-stream-index: "002.001" + captured_at: + description: The time the frame was captured + format: date-time + title: CapturedAt + type: number + x-stream-index: "006" created_at: format: date-time type: number x-stream-index: "001.002" - members: - description: Call members - items: - $ref: '#/components/schemas/MemberResponse' - title: Members - type: array - x-stream-index: "005" + egress_id: + type: string + x-stream-index: "008" session_id: description: Call session ID title: Session ID type: string x-stream-index: "003.001" + track_type: + description: The type of the track frame was captured from (TRACK_TYPE_VIDEO|TRACK_TYPE_SCREEN_SHARE) + title: TrackType + type: string + x-stream-index: "004" type: - default: call.notification - description: 'The type of event: "call.notification" in this case' + default: call.frame_recording_ready + description: 'The type of event: "call.frame_recording_ready" in this case' title: Event Type type: string x-stream-index: "001.001" - user: - $ref: '#/components/schemas/UserResponse' - description: The user that sent the call notification - title: User - x-stream-index: "006" + url: + description: The URL of the frame + title: URL + type: string + x-stream-index: "005" + users: + additionalProperties: + $ref: '#/components/schemas/UserResponse' + description: The users in the frame + title: Users + type: object + x-stream-index: "007" required: - type - created_at - call_cid - session_id - - call - - members - - user - title: CallNotificationEvent + - track_type + - url + - captured_at + - users + - egress_id + title: CallFrameRecordingFrameReadyEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: ring + x-stream-event-doc-group: recording x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallParticipant: - nullable: true - properties: - JoinedAt: - format: date-time - type: number - writeOnly: true - x-stream-index: "004" - Role: - type: string - writeOnly: true - x-stream-index: "002" - UserSessionID: - type: string - writeOnly: true - x-stream-index: "003" - avg_response_time: - format: int32 - readOnly: true - type: integer - x-stream-index: "001.046" - ban_expires: - format: date-time - type: number - x-stream-index: "001.017" - banned: - type: boolean - x-stream-index: "001.016" - created_at: - format: date-time - readOnly: true - type: number - x-stream-index: "001.008" - custom: - additionalProperties: {} - type: object - x-stream-index: "001.006" - deactivated_at: - format: date-time - readOnly: true - type: number - x-stream-index: "001.014" - deleted_at: - format: date-time - readOnly: true - type: number - x-stream-index: "001.013" - id: - type: string - x-stream-index: "001.003" - invisible: - type: boolean - x-stream-index: "001.023" - language: - type: string - x-stream-index: "001.035" - last_active: - format: date-time - readOnly: true - type: number - x-stream-index: "001.011" - last_engaged_at: - format: date-time - readOnly: true - type: number - x-stream-index: "001.012" - online: - readOnly: true - type: boolean - x-stream-index: "001.022" - privacy_settings: - $ref: '#/components/schemas/PrivacySettings' - x-stream-index: "001.026" - revoke_tokens_issued_before: - format: date-time - type: number - x-stream-index: "001.042" - role: - type: string - x-stream-index: "001.004" - teams: - items: - type: string - type: array - x-stream-index: "001.036" - teams_role: - additionalProperties: - type: string - type: object - x-stream-index: "001.005" - updated_at: - format: date-time - readOnly: true - type: number - x-stream-index: "001.009" - required: - - id - - role - - teams_role - - custom - - banned - - online - - Role - - UserSessionID - - JoinedAt - type: object - CallParticipantCountReport: - properties: - histogram: - items: - $ref: '#/components/schemas/ReportByHistogramBucket' - type: array - x-stream-index: "001" - required: - - histogram - type: object - CallParticipantCountReportResponse: - properties: - daily: - items: - $ref: '#/components/schemas/DailyAggregateCallParticipantCountReportResponse' - type: array - x-stream-index: "001" - required: - - daily - type: object - CallParticipantResponse: + CallFrameRecordingStartedEvent: + description: This event is sent when frame recording has started properties: - joined_at: - format: date-time - type: number - x-stream-index: "004" - role: - type: string + call: + $ref: '#/components/schemas/CallResponse' x-stream-index: "003" - user: - $ref: '#/components/schemas/UserResponse' - x-stream-index: "001" - user_session_id: - type: string - x-stream-index: "002" - required: - - user - - user_session_id - - role - - joined_at - type: object - CallReactionEvent: - description: This event is sent when a reaction is sent in a call, clients should - use this to show the reaction in the call screen - properties: call_cid: type: string x-stream-index: "002.001" @@ -3302,14 +4524,13 @@ components: format: date-time type: number x-stream-index: "001.002" - reaction: - $ref: '#/components/schemas/ReactionResponse' - description: the reaction object sent by the user on the call - title: reaction - x-stream-index: "003" + egress_id: + type: string + x-stream-index: "004" type: - default: call.reaction_new - description: 'The type of event: "call.reaction_new" in this case' + default: call.frame_recording_started + description: 'The type of event: "call.frame_recording_started" in this + case' title: Event Type type: string x-stream-index: "001.001" @@ -3317,49 +4538,20 @@ components: - type - created_at - call_cid - - reaction - title: CallReactionEvent + - call + - egress_id + title: CallFrameRecordingStartedEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: call + x-stream-event-doc-group: recording x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallRecording: - description: CallRecording represents a recording of a call. + CallFrameRecordingStoppedEvent: + description: This event is sent when frame recording has stopped properties: - end_time: - format: date-time - title: The end time of the recording. - type: number - x-stream-index: "004" - filename: - title: The filename of the recording. - type: string - x-stream-index: "001" - session_id: - title: The session ID of the recording. - type: string - x-stream-index: "005" - start_time: - format: date-time - title: The start time of the recording. - type: number + call: + $ref: '#/components/schemas/CallResponse' x-stream-index: "003" - url: - title: The URL of the recording. - type: string - x-stream-index: "002" - required: - - filename - - url - - start_time - - end_time - - session_id - title: CallRecording - type: object - CallRecordingFailedEvent: - description: This event is sent when call recording has failed - properties: call_cid: type: string x-stream-index: "002.001" @@ -3369,10 +4561,11 @@ components: x-stream-index: "001.002" egress_id: type: string - x-stream-index: "003" + x-stream-index: "004" type: - default: call.recording_failed - description: 'The type of event: "call.recording_failed" in this case' + default: call.frame_recording_stopped + description: 'The type of event: "call.frame_recording_stopped" in this + case' title: Event Type type: string x-stream-index: "001.001" @@ -3380,34 +4573,28 @@ components: - type - created_at - call_cid + - call - egress_id - title: CallRecordingFailedEvent + title: CallFrameRecordingStoppedEvent type: object x-stream-event-call-type: true x-stream-event-doc-group: recording x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallRecordingReadyEvent: - description: This event is sent when call recording is ready + CallHLSBroadcastingFailedEvent: + description: This event is sent when HLS broadcasting has failed properties: call_cid: type: string x-stream-index: "002.001" - call_recording: - $ref: '#/components/schemas/CallRecording' - description: The call recording object - title: CallRecording - x-stream-index: "003" created_at: format: date-time type: number x-stream-index: "001.002" - egress_id: - type: string - x-stream-index: "004" type: - default: call.recording_ready - description: 'The type of event: "call.recording_ready" in this case' + default: call.hls_broadcasting_failed + description: 'The type of event: "call.hls_broadcasting_failed" in this + case' title: Event Type type: string x-stream-index: "001.001" @@ -3415,80 +4602,93 @@ components: - type - created_at - call_cid - - call_recording - - egress_id - title: CallRecordingReadyEvent + title: CallHLSBroadcastingFailedEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: recording + x-stream-event-doc-group: streaming x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallRecordingStartedEvent: - description: This event is sent when call recording has started + CallHLSBroadcastingStartedEvent: + description: This event is sent when HLS broadcasting has started properties: + call: + $ref: '#/components/schemas/CallResponse' + x-stream-index: "003" call_cid: type: string - x-stream-index: "003.001" + x-stream-index: "002.001" created_at: format: date-time type: number - x-stream-index: "002.002" - egress_id: + x-stream-index: "001.002" + hls_playlist_url: type: string - x-stream-index: "001" + x-stream-index: "004" type: - default: call.recording_started - description: 'The type of event: "call.recording_started" in this case' + default: call.hls_broadcasting_started + description: 'The type of event: "call.hls_broadcasting_started" in this + case' title: Event Type type: string - x-stream-index: "002.001" + x-stream-index: "001.001" required: - - egress_id - type - created_at - call_cid - title: CallRecordingStartedEvent + - call + - hls_playlist_url + title: CallHLSBroadcastingStartedEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: recording + x-stream-event-doc-group: streaming x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallRecordingStoppedEvent: - description: This event is sent when call recording has stopped + CallHLSBroadcastingStoppedEvent: + description: This event is sent when HLS broadcasting has stopped properties: call_cid: type: string - x-stream-index: "003.001" + x-stream-index: "002.001" created_at: format: date-time type: number - x-stream-index: "002.002" - egress_id: - type: string - x-stream-index: "001" + x-stream-index: "001.002" type: - default: call.recording_stopped - description: 'The type of event: "call.recording_stopped" in this case' + default: call.hls_broadcasting_stopped + description: 'The type of event: "call.hls_broadcasting_stopped" in this + case' title: Event Type type: string - x-stream-index: "002.001" + x-stream-index: "001.001" required: - - egress_id - type - created_at - call_cid - title: CallRecordingStoppedEvent + title: CallHLSBroadcastingStoppedEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: recording + x-stream-event-doc-group: streaming x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallRejectedEvent: - description: This event is sent when a user rejects a notification to join a - call. + CallIngressResponse: + description: CallIngressResponse is the payload for ingress settings + properties: + rtmp: + $ref: '#/components/schemas/RTMPIngress' + title: RTMP + x-stream-index: "001" + required: + - rtmp + title: CallIngressResponse + type: object + CallLiveStartedEvent: + description: This event is sent when a call is started. Clients receiving this + event should start the call. properties: call: $ref: '#/components/schemas/CallResponse' + description: Call object + title: Call x-stream-index: "003" call_cid: type: string @@ -3497,218 +4697,238 @@ components: format: date-time type: number x-stream-index: "001.002" - reason: - description: 'Provides information about why the call was rejected. You - can provide any value, but the Stream API and SDKs use these default values: - rejected, cancel, timeout and busy' - title: Reason - type: string - x-stream-index: "005" type: - default: call.rejected - description: 'The type of event: "call.rejected" in this case' + default: call.live_started + description: 'The type of event: "call.live_started" in this case' title: Event Type type: string x-stream-index: "001.001" - user: - $ref: '#/components/schemas/UserResponse' - description: The user who rejected the call - title: User - x-stream-index: "004" required: - type - created_at - call_cid - call - - user - title: CallRejectedEvent + title: CallLiveStartedEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: ring + x-stream-event-doc-group: streaming x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallReportResponse: + CallMember: + nullable: true properties: - ended_at: + created_at: format: date-time type: number - x-stream-index: "003" - score: - format: float + x-stream-index: "008" + custom: + additionalProperties: {} + type: object + x-stream-index: "007" + deleted_at: + format: date-time type: number - x-stream-index: "001" - started_at: + x-stream-index: "010" + role: + type: string + x-stream-index: "006" + updated_at: format: date-time type: number - x-stream-index: "002" + x-stream-index: "009" + user: + $ref: '#/components/schemas/User' + x-stream-index: "005" + user_id: + type: string + x-stream-index: "004" required: - - score + - user_id + - role + - custom + - created_at + - updated_at type: object - CallRequest: - description: CallRequest is the payload for creating a call. + CallMemberAddedEvent: + description: This event is sent when one or more members are added to a call properties: - channel_cid: - type: string - x-stream-index: "009" - created_by: - $ref: '#/components/schemas/UserRequest' - title: The user that create this call - x-stream-index: "002" - created_by_id: - title: The id of the user that create this call - type: string + call: + $ref: '#/components/schemas/CallResponse' + description: Call object + title: Call x-stream-index: "003" - custom: - additionalProperties: {} - type: object - x-stream-index: "004" + call_cid: + type: string + x-stream-index: "002.001" + created_at: + format: date-time + type: number + x-stream-index: "001.002" members: + description: the members added to this call items: - $ref: '#/components/schemas/MemberRequest' - maximum: 100 + $ref: '#/components/schemas/MemberResponse' + title: Members type: array - x-stream-index: "005" - settings_override: - $ref: '#/components/schemas/CallSettingsRequest' - x-stream-index: "006" - starts_at: - format: date-time - type: number - x-stream-index: "007" - team: + x-stream-index: "004" + type: + default: call.member_added + description: 'The type of event: "call.member_added" in this case' + title: Event Type type: string - x-stream-index: "001" - video: - type: boolean - x-stream-index: "008" - title: CallRequest + x-stream-index: "001.001" + required: + - type + - created_at + - call_cid + - call + - members + title: CallMemberAddedEvent type: object - CallResponse: - description: Represents a call + x-stream-event-call-type: true + x-stream-event-doc-group: call + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + CallMemberRemovedEvent: + description: This event is sent when one or more members are removed from a + call properties: - backstage: - type: boolean - x-stream-index: "016" - blocked_user_ids: + call: + $ref: '#/components/schemas/CallResponse' + description: Call object + title: Call + x-stream-index: "003" + call_cid: + type: string + x-stream-index: "002.001" + created_at: + format: date-time + type: number + x-stream-index: "001.002" + members: + description: the list of member IDs removed from the call items: type: string + title: Members type: array - x-stream-index: "018" - captioning: - type: boolean - x-stream-index: "013" - channel_cid: + x-stream-index: "004" + type: + default: call.member_removed + description: 'The type of event: "call.member_removed" in this case' + title: Event Type type: string - x-stream-index: "024" - cid: - description: The unique identifier for a call (:) - title: CID + x-stream-index: "001.001" + required: + - type + - created_at + - call_cid + - call + - members + title: CallMemberRemovedEvent + type: object + x-stream-event-call-type: true + x-stream-event-doc-group: call + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + CallMemberUpdatedEvent: + description: This event is sent when one or more members are updated + properties: + call: + $ref: '#/components/schemas/CallResponse' + description: Call object + title: Call + x-stream-index: "003" + call_cid: type: string - x-stream-index: "004" + x-stream-index: "002.001" created_at: - description: Date/time of creation - format: date-time - title: Created at - type: number - x-stream-index: "009" - created_by: - $ref: '#/components/schemas/UserResponse' - description: The user that created the call - title: Created By - x-stream-index: "007" - current_session_id: - type: string - x-stream-index: "005" - custom: - additionalProperties: {} - description: Custom data for this object - title: Custom data - type: object - x-stream-index: "008" - egress: - $ref: '#/components/schemas/EgressResponse' - x-stream-index: "021" - ended_at: - description: Date/time when the call ended format: date-time - title: Ended At type: number - x-stream-index: "014" - id: - description: Call ID - title: ID + x-stream-index: "001.002" + members: + description: The list of members that were updated + items: + $ref: '#/components/schemas/MemberResponse' + title: Members + type: array + x-stream-index: "004" + type: + default: call.member_updated + description: 'The type of event: "call.member_updated" in this case' + title: Event Type type: string + x-stream-index: "001.001" + required: + - type + - created_at + - call_cid + - call + - members + title: CallMemberUpdatedEvent + type: object + x-stream-event-call-type: true + x-stream-event-doc-group: call + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + CallMemberUpdatedPermissionEvent: + description: This event is sent when one or more members get its role updated + properties: + call: + $ref: '#/components/schemas/CallResponse' + description: Call object + title: Call x-stream-index: "003" - ingress: - $ref: '#/components/schemas/CallIngressResponse' - x-stream-index: "019" - join_ahead_time_seconds: - format: int32 - type: integer - x-stream-index: "023" - recording: - type: boolean - x-stream-index: "011" - session: - $ref: '#/components/schemas/CallSessionResponse' - x-stream-index: "020" - settings: - $ref: '#/components/schemas/CallSettingsResponse' - x-stream-index: "017" - starts_at: - description: Date/time when the call will start + call_cid: + type: string + x-stream-index: "002.001" + capabilities_by_role: + additionalProperties: + items: + type: string + type: array + description: The capabilities by role for this call + title: CapabilitiesByRole + type: object + x-stream-index: "004" + created_at: format: date-time - title: Starts At type: number - x-stream-index: "015" - team: - type: string - x-stream-index: "006" - thumbnails: - $ref: '#/components/schemas/ThumbnailResponse' - x-stream-index: "022" - transcribing: - type: boolean - x-stream-index: "012" + x-stream-index: "001.002" + members: + description: The list of members that were updated + items: + $ref: '#/components/schemas/MemberResponse' + title: Members + type: array + x-stream-index: "005" type: - description: The type of call - title: Type + default: call.member_updated_permission + description: 'The type of event: "call.member_added" in this case' + title: Event Type type: string - x-stream-index: "002" - updated_at: - description: Date/time of the last update - format: date-time - title: Updated at - type: number - x-stream-index: "010" + x-stream-index: "001.001" required: - type - - id - - cid - - current_session_id - - created_by - - custom - created_at - - updated_at - - recording - - transcribing - - captioning - - backstage - - settings - - blocked_user_ids - - ingress - - egress - title: CallResponse + - call_cid + - call + - capabilities_by_role + - members + title: CallMemberUpdatedPermissionEvent type: object - CallRingEvent: - description: This event is sent to all call members to notify they are getting - called + x-stream-event-call-type: true + x-stream-event-doc-group: call + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + CallMissedEvent: + description: This event is sent to call members who did not accept/reject/join + the call to notify they missed the call properties: call: $ref: '#/components/schemas/CallResponse' description: Call object title: Call - x-stream-index: "005" + x-stream-index: "004" call_cid: type: string x-stream-index: "002.001" @@ -3717,31 +4937,31 @@ components: type: number x-stream-index: "001.002" members: - description: Call members + description: List of members who missed the call items: $ref: '#/components/schemas/MemberResponse' title: Members type: array - x-stream-index: "006" + x-stream-index: "005" + notify_user: + type: boolean + x-stream-index: "007" session_id: description: Call session ID title: Session ID type: string x-stream-index: "003.001" type: - default: call.ring + default: call.missed description: 'The type of event: "call.notification" in this case' title: Event Type type: string x-stream-index: "001.001" user: $ref: '#/components/schemas/UserResponse' - description: The user that sent the call notification + description: The caller from whom the call was missed title: User - x-stream-index: "007" - video: - type: boolean - x-stream-index: "008" + x-stream-index: "006" required: - type - created_at @@ -3750,263 +4970,285 @@ components: - call - members - user - - video - title: CallRingEvent + - notify_user + title: CallMissedEvent type: object x-stream-event-call-type: true x-stream-event-doc-group: ring x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallRtmpBroadcastFailedEvent: - description: This event is sent when a call RTMP broadcast has failed + CallModerationBlurEvent: properties: call_cid: - description: The unique identifier for a call (:) - title: CID type: string x-stream-index: "002.001" created_at: - description: Date/time of creation format: date-time - title: Created at type: number x-stream-index: "001.002" - name: - description: Name of the given RTMP broadcast - title: Name - type: string - x-stream-index: "003" + custom: + additionalProperties: {} + type: object + x-stream-index: "004" type: - default: call.rtmp_broadcast_failed - description: 'The type of event: "call.rtmp_broadcast_failed" in this case' - title: Event Type + default: call.moderation_blur type: string x-stream-index: "001.001" + user_id: + type: string + x-stream-index: "003" required: - type - created_at - call_cid - - name - title: CallRtmpBroadcastFailedEvent + - user_id + - custom + title: CallModerationBlurEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: streaming + x-stream-event-doc-group: other x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallRtmpBroadcastStartedEvent: - description: This event is sent when RTMP broadcast has started + CallModerationWarningEvent: properties: call_cid: - description: The unique identifier for a call (:) - title: CID type: string x-stream-index: "002.001" created_at: - description: Date/time of creation format: date-time - title: Created at type: number x-stream-index: "001.002" - name: - description: Name of the given RTMP broadcast - title: Name + custom: + additionalProperties: {} + type: object + x-stream-index: "005" + message: type: string - x-stream-index: "003" + x-stream-index: "004" type: - default: call.rtmp_broadcast_started - description: 'The type of event: "call.rtmp_broadcast_started" in this case' - title: Event Type + default: call.moderation_warning type: string x-stream-index: "001.001" + user_id: + type: string + x-stream-index: "003" required: - type - created_at - call_cid - - name - title: CallRtmpBroadcastStartedEvent + - user_id + - message + - custom + title: CallModerationWarningEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: streaming + x-stream-event-doc-group: other x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallRtmpBroadcastStoppedEvent: - description: This event is sent when RTMP broadcast has stopped + CallNotificationEvent: + description: This event is sent to all call members to notify they are getting + called properties: + call: + $ref: '#/components/schemas/CallResponse' + description: Call object + title: Call + x-stream-index: "004" call_cid: - description: The unique identifier for a call (:) - title: CID type: string x-stream-index: "002.001" created_at: - description: Date/time of creation format: date-time - title: Created at type: number x-stream-index: "001.002" - name: - description: Name of the given RTMP broadcast - title: Name + members: + description: Call members + items: + $ref: '#/components/schemas/MemberResponse' + title: Members + type: array + x-stream-index: "005" + session_id: + description: Call session ID + title: Session ID type: string - x-stream-index: "003" + x-stream-index: "003.001" type: - default: call.rtmp_broadcast_stopped - description: 'The type of event: "call.rtmp_broadcast_stopped" in this case' + default: call.notification + description: 'The type of event: "call.notification" in this case' title: Event Type type: string x-stream-index: "001.001" + user: + $ref: '#/components/schemas/UserResponse' + description: The user that sent the call notification + title: User + x-stream-index: "006" required: - type - created_at - call_cid - - name - title: CallRtmpBroadcastStoppedEvent + - session_id + - call + - members + - user + title: CallNotificationEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: streaming + x-stream-event-doc-group: ring x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallSession: + CallParticipant: + nullable: true properties: - AcceptedBy: - additionalProperties: - format: date-time - type: number - type: object - writeOnly: true - x-stream-index: "008" - ActiveSFUs: - items: - $ref: '#/components/schemas/SFUIDLastSeen' - type: array + JoinedAt: + format: date-time + type: number writeOnly: true - x-stream-index: "016" - AnonymousParticipantCount: - format: int32 - type: integer + x-stream-index: "004" + Role: + type: string writeOnly: true - x-stream-index: "019" - AppPK: - format: int32 - type: integer - writeOnly: true - x-stream-index: "002.001" - CallID: - type: string - writeOnly: true - x-stream-index: "002.003" - CallType: + x-stream-index: "002" + UserSessionID: type: string writeOnly: true - x-stream-index: "002.002" - CreatedAt: + x-stream-index: "003" + avg_response_time: + format: int32 + readOnly: true + type: integer + x-stream-index: "001.046" + ban_expires: format: date-time type: number - writeOnly: true - x-stream-index: "003" - DeletedAt: + x-stream-index: "001.017" + banned: + type: boolean + x-stream-index: "001.016" + created_at: format: date-time + readOnly: true type: number - writeOnly: true - x-stream-index: "004" - EndedAt: + x-stream-index: "001.008" + custom: + additionalProperties: {} + type: object + x-stream-index: "001.006" + deactivated_at: format: date-time + readOnly: true type: number - writeOnly: true - x-stream-index: "006" - LiveEndedAt: + x-stream-index: "001.014" + deleted_at: format: date-time + readOnly: true type: number - writeOnly: true - x-stream-index: "013" - LiveStartedAt: + x-stream-index: "001.013" + id: + type: string + x-stream-index: "001.003" + invisible: + type: boolean + x-stream-index: "001.023" + language: + type: string + x-stream-index: "001.035" + last_active: format: date-time + readOnly: true type: number - writeOnly: true - x-stream-index: "012" - MissedBy: - additionalProperties: - format: date-time - type: number - type: object - writeOnly: true - x-stream-index: "010" - Participants: + x-stream-index: "001.011" + last_engaged_at: + format: date-time + readOnly: true + type: number + x-stream-index: "001.012" + online: + readOnly: true + type: boolean + x-stream-index: "001.022" + privacy_settings: + $ref: '#/components/schemas/PrivacySettings' + x-stream-index: "001.026" + revoke_tokens_issued_before: + format: date-time + type: number + x-stream-index: "001.042" + role: + type: string + x-stream-index: "001.004" + teams: items: - $ref: '#/components/schemas/CallParticipant' + type: string type: array - writeOnly: true - x-stream-index: "011" - ParticipantsCountByRole: - additionalProperties: - format: int32 - type: integer - type: object - writeOnly: true - x-stream-index: "018" - RejectedBy: + x-stream-index: "001.036" + teams_role: additionalProperties: - format: date-time - type: number + type: string type: object - writeOnly: true - x-stream-index: "009" - RingAt: + x-stream-index: "001.005" + updated_at: format: date-time + readOnly: true type: number - writeOnly: true - x-stream-index: "007" - SFUIDs: + x-stream-index: "001.009" + required: + - id + - role + - teams_role + - custom + - banned + - online + - Role + - UserSessionID + - JoinedAt + type: object + CallParticipantCountReport: + properties: + histogram: items: - type: string + $ref: '#/components/schemas/ReportByHistogramBucket' type: array - writeOnly: true - x-stream-index: "015" - SessionID: - type: string - writeOnly: true - x-stream-index: "002.004" - StartedAt: - format: date-time - type: number - writeOnly: true - x-stream-index: "005" - TimerEndsAt: + x-stream-index: "001" + required: + - histogram + type: object + CallParticipantCountReportResponse: + properties: + daily: + items: + $ref: '#/components/schemas/DailyAggregateCallParticipantCountReportResponse' + type: array + x-stream-index: "001" + required: + - daily + type: object + CallParticipantResponse: + properties: + joined_at: format: date-time type: number - writeOnly: true - x-stream-index: "014" - UserPermissionOverrides: - additionalProperties: - additionalProperties: - type: boolean - type: object - type: object - writeOnly: true - x-stream-index: "017" + x-stream-index: "004" + role: + type: string + x-stream-index: "003" + user: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "001" + user_session_id: + type: string + x-stream-index: "002" required: - - AppPK - - CallType - - CallID - - SessionID - - CreatedAt - - AcceptedBy - - RejectedBy - - MissedBy - - Participants - - SFUIDs - - ActiveSFUs - - UserPermissionOverrides - - ParticipantsCountByRole - - AnonymousParticipantCount + - user + - user_session_id + - role + - joined_at type: object - CallSessionEndedEvent: - description: This event is sent when a call session ends + CallReactionEvent: + description: This event is sent when a reaction is sent in a call, clients should + use this to show the reaction in the call screen properties: - call: - $ref: '#/components/schemas/CallResponse' - description: Call object - title: Call - x-stream-index: "004" call_cid: type: string x-stream-index: "002.001" @@ -4014,14 +5256,14 @@ components: format: date-time type: number x-stream-index: "001.002" - session_id: - description: Call session ID - title: Session ID - type: string - x-stream-index: "003.001" + reaction: + $ref: '#/components/schemas/ReactionResponse' + description: the reaction object sent by the user on the call + title: reaction + x-stream-index: "003" type: - default: call.session_ended - description: 'The type of event: "call.session_ended" in this case' + default: call.reaction_new + description: 'The type of event: "call.reaction_new" in this case' title: Event Type type: string x-stream-index: "001.001" @@ -4029,22 +5271,49 @@ components: - type - created_at - call_cid - - session_id - - call - title: CallSessionEndedEvent + - reaction + title: CallReactionEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: session + x-stream-event-doc-group: call x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallSessionParticipantCountsUpdatedEvent: - description: This event is sent when the participant counts in a call session - are updated + CallRecording: + description: CallRecording represents a recording of a call. properties: - anonymous_participant_count: - format: int32 - type: integer + end_time: + format: date-time + title: The end time of the recording. + type: number + x-stream-index: "004" + filename: + title: The filename of the recording. + type: string + x-stream-index: "001" + session_id: + title: The session ID of the recording. + type: string x-stream-index: "005" + start_time: + format: date-time + title: The start time of the recording. + type: number + x-stream-index: "003" + url: + title: The URL of the recording. + type: string + x-stream-index: "002" + required: + - filename + - url + - start_time + - end_time + - session_id + title: CallRecording + type: object + CallRecordingFailedEvent: + description: This event is sent when call recording has failed + properties: call_cid: type: string x-stream-index: "002.001" @@ -4052,21 +5321,12 @@ components: format: date-time type: number x-stream-index: "001.002" - participants_count_by_role: - additionalProperties: - format: int32 - type: integer - type: object - x-stream-index: "004" - session_id: - description: Call session ID - title: Session ID + egress_id: type: string - x-stream-index: "003.001" + x-stream-index: "003" type: - default: call.session_participant_count_updated - description: 'The type of event: "call.session_participant_count_updated" - in this case' + default: call.recording_failed + description: 'The type of event: "call.recording_failed" in this case' title: Event Type type: string x-stream-index: "001.001" @@ -4074,39 +5334,34 @@ components: - type - created_at - call_cid - - session_id - - participants_count_by_role - - anonymous_participant_count - title: CallSessionParticipantCountsUpdatedEvent + - egress_id + title: CallRecordingFailedEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: session + x-stream-event-doc-group: recording x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallSessionParticipantJoinedEvent: - description: This event is sent when a participant joins a call session + CallRecordingReadyEvent: + description: This event is sent when call recording is ready properties: call_cid: type: string x-stream-index: "002.001" + call_recording: + $ref: '#/components/schemas/CallRecording' + description: The call recording object + title: CallRecording + x-stream-index: "003" created_at: format: date-time type: number x-stream-index: "001.002" - participant: - $ref: '#/components/schemas/CallParticipantResponse' - description: The participant that joined the session - title: Participant - x-stream-index: "004" - session_id: - description: Call session ID - title: Session ID + egress_id: type: string - x-stream-index: "003.001" + x-stream-index: "004" type: - default: call.session_participant_joined - description: 'The type of event: "call.session_participant_joined" in this - case' + default: call.recording_ready + description: 'The type of event: "call.recording_ready" in this case' title: Event Type type: string x-stream-index: "001.001" @@ -4114,135 +5369,81 @@ components: - type - created_at - call_cid - - session_id - - participant - title: CallSessionParticipantJoinedEvent + - call_recording + - egress_id + title: CallRecordingReadyEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: session + x-stream-event-doc-group: recording x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallSessionParticipantLeftEvent: - description: This event is sent when a participant leaves a call session + CallRecordingStartedEvent: + description: This event is sent when call recording has started properties: call_cid: type: string - x-stream-index: "002.001" + x-stream-index: "003.001" created_at: format: date-time type: number - x-stream-index: "001.002" - duration_seconds: - description: The duration participant was in the session in seconds - format: int32 - title: Duration - type: integer - x-stream-index: "005" - participant: - $ref: '#/components/schemas/CallParticipantResponse' - description: The participant that left the session - title: Participant - x-stream-index: "004" - session_id: - description: Call session ID - title: Session ID + x-stream-index: "002.002" + egress_id: type: string - x-stream-index: "003.001" + x-stream-index: "001" type: - default: call.session_participant_left - description: 'The type of event: "call.session_participant_left" in this - case' + default: call.recording_started + description: 'The type of event: "call.recording_started" in this case' title: Event Type type: string - x-stream-index: "001.001" + x-stream-index: "002.001" required: + - egress_id - type - created_at - call_cid - - session_id - - participant - - duration_seconds - title: CallSessionParticipantLeftEvent + title: CallRecordingStartedEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: session + x-stream-event-doc-group: recording x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallSessionResponse: + CallRecordingStoppedEvent: + description: This event is sent when call recording has stopped properties: - accepted_by: - additionalProperties: - format: date-time - type: number - type: object - x-stream-index: "008" - anonymous_participant_count: - format: int32 - type: integer - x-stream-index: "006" - ended_at: + call_cid: + type: string + x-stream-index: "003.001" + created_at: format: date-time type: number - x-stream-index: "003" - id: + x-stream-index: "002.002" + egress_id: type: string x-stream-index: "001" - live_ended_at: - format: date-time - type: number - x-stream-index: "011" - live_started_at: - format: date-time - type: number - x-stream-index: "010" - missed_by: - additionalProperties: - format: date-time - type: number - type: object - x-stream-index: "009" - participants: - items: - $ref: '#/components/schemas/CallParticipantResponse' - type: array - x-stream-index: "004" - participants_count_by_role: - additionalProperties: - format: int32 - type: integer - type: object - x-stream-index: "005" - rejected_by: - additionalProperties: - format: date-time - type: number - type: object - x-stream-index: "007" - started_at: - format: date-time - type: number - x-stream-index: "002" - timer_ends_at: - format: date-time - type: number - x-stream-index: "012" + type: + default: call.recording_stopped + description: 'The type of event: "call.recording_stopped" in this case' + title: Event Type + type: string + x-stream-index: "002.001" required: - - id - - participants - - participants_count_by_role - - anonymous_participant_count - - rejected_by - - accepted_by - - missed_by + - egress_id + - type + - created_at + - call_cid + title: CallRecordingStoppedEvent type: object - CallSessionStartedEvent: - description: This event is sent when a call session starts + x-stream-event-call-type: true + x-stream-event-doc-group: recording + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + CallRejectedEvent: + description: This event is sent when a user rejects a notification to join a + call. properties: call: $ref: '#/components/schemas/CallResponse' - description: Call object - title: Call - x-stream-index: "004" + x-stream-index: "003" call_cid: type: string x-stream-index: "002.001" @@ -4250,309 +5451,218 @@ components: format: date-time type: number x-stream-index: "001.002" - session_id: - description: Call session ID - title: Session ID + reason: + description: 'Provides information about why the call was rejected. You + can provide any value, but the Stream API and SDKs use these default values: + rejected, cancel, timeout and busy' + title: Reason type: string - x-stream-index: "003.001" + x-stream-index: "005" type: - default: call.session_started - description: 'The type of event: "call.session_started" in this case' + default: call.rejected + description: 'The type of event: "call.rejected" in this case' title: Event Type type: string x-stream-index: "001.001" + user: + $ref: '#/components/schemas/UserResponse' + description: The user who rejected the call + title: User + x-stream-index: "004" required: - type - created_at - call_cid - - session_id - call - title: CallSessionStartedEvent + - user + title: CallRejectedEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: session + x-stream-event-doc-group: ring x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallSettings: + CallReportResponse: properties: - audio: - $ref: '#/components/schemas/AudioSettings' + ended_at: + format: date-time + type: number + x-stream-index: "003" + score: + format: float + type: number x-stream-index: "001" - backstage: - $ref: '#/components/schemas/BackstageSettings' + started_at: + format: date-time + type: number x-stream-index: "002" - broadcasting: - $ref: '#/components/schemas/BroadcastSettings' - x-stream-index: "007" - frame_recording: - $ref: '#/components/schemas/FrameRecordSettings' - x-stream-index: "006" - geofencing: - $ref: '#/components/schemas/GeofenceSettings' - x-stream-index: "008" - ingress: - $ref: '#/components/schemas/IngressSettings' - x-stream-index: "014" - limits: - $ref: '#/components/schemas/LimitsSettings' - x-stream-index: "012" - recording: - $ref: '#/components/schemas/RecordSettings' - x-stream-index: "005" - ring: - $ref: '#/components/schemas/RingSettings' - x-stream-index: "010" - screensharing: - $ref: '#/components/schemas/ScreensharingSettings' - x-stream-index: "004" - session: - $ref: '#/components/schemas/SessionSettings' - x-stream-index: "013" - thumbnails: - $ref: '#/components/schemas/ThumbnailsSettings' - x-stream-index: "011" - transcription: - $ref: '#/components/schemas/TranscriptionSettings' - x-stream-index: "009" - video: - $ref: '#/components/schemas/VideoSettings' - x-stream-index: "003" + required: + - score type: object - CallSettingsRequest: + CallRequest: + description: CallRequest is the payload for creating a call. properties: - audio: - $ref: '#/components/schemas/AudioSettingsRequest' - x-stream-index: "001" - backstage: - $ref: '#/components/schemas/BackstageSettingsRequest' - x-stream-index: "002" - broadcasting: - $ref: '#/components/schemas/BroadcastSettingsRequest' - x-stream-index: "010" - frame_recording: - $ref: '#/components/schemas/FrameRecordingSettingsRequest' - x-stream-index: "006" - geofencing: - $ref: '#/components/schemas/GeofenceSettingsRequest' - x-stream-index: "003" - ingress: - $ref: '#/components/schemas/IngressSettingsRequest' - x-stream-index: "014" - limits: - $ref: '#/components/schemas/LimitsSettingsRequest' - x-stream-index: "012" - recording: - $ref: '#/components/schemas/RecordSettingsRequest' - x-stream-index: "005" - ring: - $ref: '#/components/schemas/RingSettingsRequest' - x-stream-index: "007" - screensharing: - $ref: '#/components/schemas/ScreensharingSettingsRequest' - x-stream-index: "008" - session: - $ref: '#/components/schemas/SessionSettingsRequest' - x-stream-index: "013" - thumbnails: - $ref: '#/components/schemas/ThumbnailsSettingsRequest' - x-stream-index: "011" - transcription: - $ref: '#/components/schemas/TranscriptionSettingsRequest' + channel_cid: + type: string x-stream-index: "009" - video: - $ref: '#/components/schemas/VideoSettingsRequest' - x-stream-index: "004" - type: object - CallSettingsResponse: - properties: - audio: - $ref: '#/components/schemas/AudioSettingsResponse' - x-stream-index: "001" - backstage: - $ref: '#/components/schemas/BackstageSettingsResponse' + created_by: + $ref: '#/components/schemas/UserRequest' + title: The user that create this call x-stream-index: "002" - broadcasting: - $ref: '#/components/schemas/BroadcastSettingsResponse' + created_by_id: + title: The id of the user that create this call + type: string x-stream-index: "003" - frame_recording: - $ref: '#/components/schemas/FrameRecordingSettingsResponse' - x-stream-index: "006" - geofencing: - $ref: '#/components/schemas/GeofenceSettingsResponse' + custom: + additionalProperties: {} + type: object x-stream-index: "004" - ingress: - $ref: '#/components/schemas/IngressSettingsResponse' - x-stream-index: "014" - limits: - $ref: '#/components/schemas/LimitsSettingsResponse' - x-stream-index: "012" - recording: - $ref: '#/components/schemas/RecordSettingsResponse' - x-stream-index: "005" - ring: - $ref: '#/components/schemas/RingSettingsResponse' - x-stream-index: "007" - screensharing: - $ref: '#/components/schemas/ScreensharingSettingsResponse' - x-stream-index: "008" - session: - $ref: '#/components/schemas/SessionSettingsResponse' - x-stream-index: "013" - thumbnails: - $ref: '#/components/schemas/ThumbnailsSettingsResponse' - x-stream-index: "011" - transcription: - $ref: '#/components/schemas/TranscriptionSettingsResponse' - x-stream-index: "009" - video: - $ref: '#/components/schemas/VideoSettingsResponse' - x-stream-index: "010" - required: - - audio - - backstage - - broadcasting - - geofencing - - recording - - frame_recording - - ring - - screensharing - - transcription - - video - - thumbnails - - limits - - session - type: object - CallStateResponseFields: - description: CallStateResponseFields is the payload for call state response - properties: - call: - $ref: '#/components/schemas/CallResponse' - x-stream-index: "001" members: - description: List of call members - items: - $ref: '#/components/schemas/MemberResponse' - title: Members - type: array - x-stream-index: "002" - own_capabilities: items: - $ref: '#/components/schemas/OwnCapability' + $ref: '#/components/schemas/MemberRequest' + maximum: 100 type: array - x-stream-index: "004" - required: - - call - - members - - own_capabilities - - blocked_users - title: CallStateResponseFields - type: object - CallStatsReportReadyEvent: - description: This event is sent when the insights report is ready - properties: - call_cid: - type: string - x-stream-index: "002.001" - created_at: + x-stream-index: "005" + settings_override: + $ref: '#/components/schemas/CallSettingsRequest' + x-stream-index: "006" + starts_at: format: date-time type: number - x-stream-index: "001.002" - session_id: - description: Call session ID - title: Session ID - type: string - x-stream-index: "003.001" - type: - default: call.stats_report_ready - description: The type of event, "call.report_ready" in this case - title: Event Type - type: string - x-stream-index: "001.001" - required: - - type - - created_at - - call_cid - - session_id - title: CallStatsReportReadyEvent - type: object - x-stream-event-call-type: true - x-stream-event-doc-group: other - x-stream-is-event: true - x-stream-ws-base-event-name: VideoEvent - CallStatsReportSummaryResponse: - properties: - call_cid: + x-stream-index: "007" + team: type: string x-stream-index: "001" - call_duration_seconds: - format: int32 - type: integer + video: + type: boolean x-stream-index: "008" - call_session_id: + title: CallRequest + type: object + CallResponse: + description: Represents a call + properties: + backstage: + type: boolean + x-stream-index: "016" + blocked_user_ids: + items: + type: string + type: array + x-stream-index: "018" + captioning: + type: boolean + x-stream-index: "013" + channel_cid: type: string - x-stream-index: "002" - call_status: + x-stream-index: "024" + cid: + description: The unique identifier for a call (:) + title: CID type: string x-stream-index: "004" created_at: + description: Date/time of creation format: date-time + title: Created at type: number + x-stream-index: "009" + created_by: + $ref: '#/components/schemas/UserResponse' + description: The user that created the call + title: Created By x-stream-index: "007" - first_stats_time: + current_session_id: + type: string + x-stream-index: "005" + custom: + additionalProperties: {} + description: Custom data for this object + title: Custom data + type: object + x-stream-index: "008" + egress: + $ref: '#/components/schemas/EgressResponse' + x-stream-index: "021" + ended_at: + description: Date/time when the call ended format: date-time + title: Ended At type: number + x-stream-index: "014" + id: + description: Call ID + title: ID + type: string x-stream-index: "003" - min_user_rating: - format: int32 - type: integer - x-stream-index: "006" - quality_score: + ingress: + $ref: '#/components/schemas/CallIngressResponse' + x-stream-index: "019" + join_ahead_time_seconds: format: int32 type: integer - x-stream-index: "005" - required: - - call_cid - - call_session_id - - first_stats_time - - call_status - - call_duration_seconds - type: object - CallTranscription: - description: CallTranscription represents a transcription of a call. - properties: - end_time: + x-stream-index: "023" + recording: + type: boolean + x-stream-index: "011" + session: + $ref: '#/components/schemas/CallSessionResponse' + x-stream-index: "020" + settings: + $ref: '#/components/schemas/CallSettingsResponse' + x-stream-index: "017" + starts_at: + description: Date/time when the call will start format: date-time - title: The end time of the transcription. + title: Starts At type: number - x-stream-index: "004" - filename: - title: The filename of the transcription. + x-stream-index: "015" + team: type: string - x-stream-index: "001" - session_id: - title: The session ID of the transcription. + x-stream-index: "006" + thumbnails: + $ref: '#/components/schemas/ThumbnailResponse' + x-stream-index: "022" + transcribing: + type: boolean + x-stream-index: "012" + type: + description: The type of call + title: Type type: string - x-stream-index: "005" - start_time: + x-stream-index: "002" + updated_at: + description: Date/time of the last update format: date-time - title: The start time of the transcription. + title: Updated at type: number - x-stream-index: "003" - url: - title: The URL of the transcription. - type: string - x-stream-index: "002" + x-stream-index: "010" required: - - filename - - url - - start_time - - end_time - - session_id - title: CallTranscription + - type + - id + - cid + - current_session_id + - created_by + - custom + - created_at + - updated_at + - recording + - transcribing + - captioning + - backstage + - settings + - blocked_user_ids + - ingress + - egress + title: CallResponse type: object - CallTranscriptionFailedEvent: - description: This event is sent when call transcription has failed + CallRingEvent: + description: This event is sent to all call members to notify they are getting + called properties: + call: + $ref: '#/components/schemas/CallResponse' + description: Call object + title: Call + x-stream-index: "005" call_cid: type: string x-stream-index: "002.001" @@ -4560,52 +5670,69 @@ components: format: date-time type: number x-stream-index: "001.002" - egress_id: - type: string - x-stream-index: "003" - error: - description: The error message detailing why transcription failed. - title: string + members: + description: Call members + items: + $ref: '#/components/schemas/MemberResponse' + title: Members + type: array + x-stream-index: "006" + session_id: + description: Call session ID + title: Session ID type: string - x-stream-index: "004" + x-stream-index: "003.001" type: - default: call.transcription_failed - description: 'The type of event: "call.transcription_failed" in this case' + default: call.ring + description: 'The type of event: "call.notification" in this case' title: Event Type type: string x-stream-index: "001.001" + user: + $ref: '#/components/schemas/UserResponse' + description: The user that sent the call notification + title: User + x-stream-index: "007" + video: + type: boolean + x-stream-index: "008" required: - type - created_at - call_cid - - egress_id - title: CallTranscriptionFailedEvent + - session_id + - call + - members + - user + - video + title: CallRingEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: transcription + x-stream-event-doc-group: ring x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallTranscriptionReadyEvent: - description: This event is sent when call transcription is ready + CallRtmpBroadcastFailedEvent: + description: This event is sent when a call RTMP broadcast has failed properties: call_cid: + description: The unique identifier for a call (:) + title: CID type: string x-stream-index: "002.001" - call_transcription: - $ref: '#/components/schemas/CallTranscription' - description: The call transcription object - title: CallTranscription - x-stream-index: "003" created_at: + description: Date/time of creation format: date-time + title: Created at type: number x-stream-index: "001.002" - egress_id: + name: + description: Name of the given RTMP broadcast + title: Name type: string - x-stream-index: "004" + x-stream-index: "003" type: - default: call.transcription_ready - description: 'The type of event: "call.transcription_ready" in this case' + default: call.rtmp_broadcast_failed + description: 'The type of event: "call.rtmp_broadcast_failed" in this case' title: Event Type type: string x-stream-index: "001.001" @@ -4613,60 +5740,71 @@ components: - type - created_at - call_cid - - call_transcription - - egress_id - title: CallTranscriptionReadyEvent + - name + title: CallRtmpBroadcastFailedEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: transcription + x-stream-event-doc-group: streaming x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallTranscriptionStartedEvent: - description: This event is sent when call transcription has started + CallRtmpBroadcastStartedEvent: + description: This event is sent when RTMP broadcast has started properties: call_cid: + description: The unique identifier for a call (:) + title: CID type: string - x-stream-index: "003.001" + x-stream-index: "002.001" created_at: + description: Date/time of creation format: date-time + title: Created at type: number - x-stream-index: "002.002" - egress_id: + x-stream-index: "001.002" + name: + description: Name of the given RTMP broadcast + title: Name type: string - x-stream-index: "001" + x-stream-index: "003" type: - default: call.transcription_started - description: 'The type of event: "call.transcription_started" in this case' + default: call.rtmp_broadcast_started + description: 'The type of event: "call.rtmp_broadcast_started" in this case' title: Event Type type: string - x-stream-index: "002.001" + x-stream-index: "001.001" required: - - egress_id - type - created_at - call_cid - title: CallTranscriptionStartedEvent + - name + title: CallRtmpBroadcastStartedEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: transcription + x-stream-event-doc-group: streaming x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallTranscriptionStoppedEvent: - description: This event is sent when call transcription has stopped + CallRtmpBroadcastStoppedEvent: + description: This event is sent when RTMP broadcast has stopped properties: call_cid: + description: The unique identifier for a call (:) + title: CID type: string x-stream-index: "002.001" created_at: + description: Date/time of creation format: date-time + title: Created at type: number x-stream-index: "001.002" - egress_id: + name: + description: Name of the given RTMP broadcast + title: Name type: string x-stream-index: "003" type: - default: call.transcription_stopped - description: 'The type of event: "call.transcription_stopped" in this case' + default: call.rtmp_broadcast_stopped + description: 'The type of event: "call.rtmp_broadcast_stopped" in this case' title: Event Type type: string x-stream-index: "001.001" @@ -4674,140 +5812,170 @@ components: - type - created_at - call_cid - - egress_id - title: CallTranscriptionStoppedEvent + - name + title: CallRtmpBroadcastStoppedEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: transcription + x-stream-event-doc-group: streaming x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallType: - nullable: true + CallSession: properties: - AppPK: + AcceptedBy: + additionalProperties: + format: date-time + type: number + type: object + writeOnly: true + x-stream-index: "008" + ActiveSFUs: + items: + $ref: '#/components/schemas/SFUIDLastSeen' + type: array + writeOnly: true + x-stream-index: "016" + AnonymousParticipantCount: format: int32 type: integer writeOnly: true - x-stream-index: "003" - CreatedAt: - format: date-time - type: number + x-stream-index: "019" + AppPK: + format: int32 + type: integer writeOnly: true - x-stream-index: "005" - ExternalStorage: + x-stream-index: "002.001" + CallID: type: string writeOnly: true - x-stream-index: "009" - Name: + x-stream-index: "002.003" + CallType: type: string writeOnly: true - x-stream-index: "004" - NotificationSettings: - $ref: '#/components/schemas/NotificationSettings' - x-stream-index: "008" - PK: - format: int32 - type: integer + x-stream-index: "002.002" + CreatedAt: + format: date-time + type: number writeOnly: true - x-stream-index: "002" - Settings: - $ref: '#/components/schemas/CallSettings' - x-stream-index: "007" - UpdatedAt: + x-stream-index: "003" + DeletedAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "004" + EndedAt: format: date-time type: number writeOnly: true x-stream-index: "006" - required: - - PK - - AppPK - - Name - - CreatedAt - - UpdatedAt - - ExternalStorage - type: object - CallTypeResponse: - description: CallTypeResponse is the payload for a call type. - properties: - created_at: - description: the time the call type was created + LiveEndedAt: format: date-time - title: CreatedAt type: number - x-stream-index: "005" - external_storage: - description: the external storage for the call type - title: ExternalStorage - type: string - x-stream-index: "007" - grants: + writeOnly: true + x-stream-index: "013" + LiveStartedAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "012" + MissedBy: additionalProperties: - items: - type: string - type: array - description: the permissions granted to each role - title: Grants + format: date-time + type: number type: object - x-stream-index: "002" - name: - description: the name of the call type - title: Name + writeOnly: true + x-stream-index: "010" + Participants: + items: + $ref: '#/components/schemas/CallParticipant' + type: array + writeOnly: true + x-stream-index: "011" + ParticipantsCountByRole: + additionalProperties: + format: int32 + type: integer + type: object + writeOnly: true + x-stream-index: "018" + RejectedBy: + additionalProperties: + format: date-time + type: number + type: object + writeOnly: true + x-stream-index: "009" + RingAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "007" + SFUIDs: + items: + type: string + type: array + writeOnly: true + x-stream-index: "015" + SessionID: type: string - x-stream-index: "001" - notification_settings: - $ref: '#/components/schemas/NotificationSettings' - description: the notification settings for the call type - title: NotificationSettings - x-stream-index: "004" - settings: - $ref: '#/components/schemas/CallSettingsResponse' - description: the settings for the call type - title: Settings - x-stream-index: "003" - updated_at: - description: the time the call type was last updated + writeOnly: true + x-stream-index: "002.004" + StartedAt: format: date-time - title: UpdatedAt type: number - x-stream-index: "006" + writeOnly: true + x-stream-index: "005" + TimerEndsAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "014" + UserPermissionOverrides: + additionalProperties: + additionalProperties: + type: boolean + type: object + type: object + writeOnly: true + x-stream-index: "017" required: - - name - - grants - - settings - - notification_settings - - created_at - - updated_at - title: CallTypeResponse + - AppPK + - CallType + - CallID + - SessionID + - CreatedAt + - AcceptedBy + - RejectedBy + - MissedBy + - Participants + - SFUIDs + - ActiveSFUs + - UserPermissionOverrides + - ParticipantsCountByRole + - AnonymousParticipantCount type: object - CallUpdatedEvent: - description: |- - This event is sent when a call is updated, clients should use this update the local state of the call. - This event also contains the capabilities by role for the call, clients should update the own_capability for the current. + CallSessionEndedEvent: + description: This event is sent when a call session ends properties: call: $ref: '#/components/schemas/CallResponse' description: Call object title: Call - x-stream-index: "003" + x-stream-index: "004" call_cid: type: string x-stream-index: "002.001" - capabilities_by_role: - additionalProperties: - items: - type: string - type: array - description: The capabilities by role for this call - title: CapabilitiesByRole - type: object - x-stream-index: "004" created_at: format: date-time type: number x-stream-index: "001.002" + session_id: + description: Call session ID + title: Session ID + type: string + x-stream-index: "003.001" type: - default: call.updated - description: 'The type of event: "call.ended" in this case' + default: call.session_ended + description: 'The type of event: "call.session_ended" in this case' title: Event Type type: string x-stream-index: "001.001" @@ -4815,17 +5983,22 @@ components: - type - created_at - call_cid + - session_id - call - - capabilities_by_role - title: CallUpdatedEvent + title: CallSessionEndedEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: call + x-stream-event-doc-group: session x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallUserFeedbackSubmittedEvent: - description: This event is sent when a user submits feedback for a call. + CallSessionParticipantCountsUpdatedEvent: + description: This event is sent when the participant counts in a call session + are updated properties: + anonymous_participant_count: + format: int32 + type: integer + x-stream-index: "005" call_cid: type: string x-stream-index: "002.001" @@ -4833,60 +6006,39 @@ components: format: date-time type: number x-stream-index: "001.002" - custom: - additionalProperties: {} - description: Custom data provided by the user - title: Custom + participants_count_by_role: + additionalProperties: + format: int32 + type: integer type: object - x-stream-index: "007" - rating: - description: The rating given by the user (1-5) - format: int32 - title: Rating - type: integer - x-stream-index: "005" - reason: - description: The reason provided by the user for the rating - title: Reason - type: string - x-stream-index: "006" - sdk: - type: string - x-stream-index: "008" - sdk_version: - type: string - x-stream-index: "009" + x-stream-index: "004" session_id: description: Call session ID title: Session ID type: string x-stream-index: "003.001" type: - default: call.user_feedback_submitted - description: The type of event, "call.user_feedback" in this case + default: call.session_participant_count_updated + description: 'The type of event: "call.session_participant_count_updated" + in this case' title: Event Type type: string x-stream-index: "001.001" - user: - $ref: '#/components/schemas/UserResponse' - description: The user who submitted the feedback - title: User - x-stream-index: "004" required: - type - created_at - call_cid - session_id - - user - - rating - title: CallUserFeedbackSubmittedEvent + - participants_count_by_role + - anonymous_participant_count + title: CallSessionParticipantCountsUpdatedEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: other + x-stream-event-doc-group: session x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallUserMutedEvent: - description: This event is sent when a call member is muted + CallSessionParticipantJoinedEvent: + description: This event is sent when a participant joins a call session properties: call_cid: type: string @@ -4895,17 +6047,20 @@ components: format: date-time type: number x-stream-index: "001.002" - from_user_id: - type: string - x-stream-index: "003" - muted_user_ids: - items: - type: string - type: array + participant: + $ref: '#/components/schemas/CallParticipantResponse' + description: The participant that joined the session + title: Participant x-stream-index: "004" + session_id: + description: Call session ID + title: Session ID + type: string + x-stream-index: "003.001" type: - default: call.user_muted - description: 'The type of event: "call.user_muted" in this case' + default: call.session_participant_joined + description: 'The type of event: "call.session_participant_joined" in this + case' title: Event Type type: string x-stream-index: "001.001" @@ -4913,2354 +6068,2800 @@ components: - type - created_at - call_cid - - from_user_id - - muted_user_ids - title: CallUserMutedEvent + - session_id + - participant + title: CallSessionParticipantJoinedEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: call + x-stream-event-doc-group: session x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallsPerDayReport: - properties: - count: - format: int64 - type: integer - x-stream-index: "001" - required: - - count - type: object - CallsPerDayReportResponse: - properties: - daily: - items: - $ref: '#/components/schemas/DailyAggregateCallsPerDayReportResponse' - type: array - x-stream-index: "001" - required: - - daily - type: object - CampaignChannelTemplate: + CallSessionParticipantLeftEvent: + description: This event is sent when a participant leaves a call session properties: - custom: - additionalProperties: {} - type: object - x-stream-index: "005" - id: - type: string - x-stream-index: "002" - members: - items: - type: string - maximum: 1000 - type: array - x-stream-index: "003" - team: - maxLength: 1000 - type: string - x-stream-index: "004" - type: - maxLength: 64 + call_cid: type: string - x-stream-index: "001" - required: - - type - - custom - type: object - CampaignCompletedEvent: - nullable: true - properties: - campaign: - $ref: '#/components/schemas/CampaignResponse' - x-stream-index: "002" + x-stream-index: "002.001" created_at: format: date-time type: number - x-stream-index: "001.003" - custom: - additionalProperties: {} - type: object - x-stream-index: "001.007" - received_at: - format: date-time - type: number - x-stream-index: "001.004" + x-stream-index: "001.002" + duration_seconds: + description: The duration participant was in the session in seconds + format: int32 + title: Duration + type: integer + x-stream-index: "005" + participant: + $ref: '#/components/schemas/CallParticipantResponse' + description: The participant that left the session + title: Participant + x-stream-index: "004" + session_id: + description: Call session ID + title: Session ID + type: string + x-stream-index: "003.001" type: - default: campaign.completed + default: call.session_participant_left + description: 'The type of event: "call.session_participant_left" in this + case' + title: Event Type type: string - x-stream-index: "001.002" + x-stream-index: "001.001" required: - type - created_at - - custom - title: CampaignCompletedEvent + - call_cid + - session_id + - participant + - duration_seconds + title: CallSessionParticipantLeftEvent type: object - x-stream-event-client-type: true - x-stream-event-doc-group: other + x-stream-event-call-type: true + x-stream-event-doc-group: session x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CampaignMessageTemplate: + CallSessionResponse: properties: - attachments: - items: - $ref: '#/components/schemas/Attachment' - maximum: 30 - type: array - x-stream-index: "002" - custom: - additionalProperties: {} + accepted_by: + additionalProperties: + format: date-time + type: number type: object - x-stream-index: "004" - poll_id: - type: string - x-stream-index: "003" - text: - type: string - x-stream-index: "001" - required: - - text - - attachments - - poll_id - - custom - type: object - CampaignResponse: - properties: - channel_template: - $ref: '#/components/schemas/CampaignChannelTemplate' - x-stream-index: "016" - create_channels: - type: boolean x-stream-index: "008" - created_at: + anonymous_participant_count: + format: int32 + type: integer + x-stream-index: "006" + ended_at: format: date-time type: number - x-stream-index: "020" - description: - type: string - x-stream-index: "010" + x-stream-index: "003" id: type: string x-stream-index: "001" - message_template: - $ref: '#/components/schemas/CampaignMessageTemplate' - x-stream-index: "015" - name: - type: string - x-stream-index: "007" - scheduled_for: + live_ended_at: format: date-time type: number - x-stream-index: "013" - segment_ids: - items: - type: string - type: array - x-stream-index: "002" - segments: + x-stream-index: "011" + live_started_at: + format: date-time + type: number + x-stream-index: "010" + missed_by: + additionalProperties: + format: date-time + type: number + type: object + x-stream-index: "009" + participants: items: - $ref: '#/components/schemas/Segment' + $ref: '#/components/schemas/CallParticipantResponse' type: array - x-stream-index: "003" - sender: - $ref: '#/components/schemas/UserResponse' - x-stream-index: "005" - sender_id: - type: string x-stream-index: "004" - sender_mode: - type: string - x-stream-index: "006" - show_channels: - type: boolean - x-stream-index: "009" - skip_push: - type: boolean - x-stream-index: "011" - skip_webhook: - type: boolean - x-stream-index: "012" - stats: - $ref: '#/components/schemas/CampaignStatsResponse' - x-stream-index: "022" - status: - type: string - x-stream-index: "019" - stop_at: + participants_count_by_role: + additionalProperties: + format: int32 + type: integer + type: object + x-stream-index: "005" + rejected_by: + additionalProperties: + format: date-time + type: number + type: object + x-stream-index: "007" + started_at: format: date-time type: number - x-stream-index: "014" - updated_at: + x-stream-index: "002" + timer_ends_at: format: date-time type: number - x-stream-index: "021" - user_ids: - items: - type: string - type: array - x-stream-index: "017" - users: - items: - $ref: '#/components/schemas/UserResponse' - type: array - x-stream-index: "018" + x-stream-index: "012" required: - id - - segment_ids - - segments - - sender_id - - sender_mode - - name - - create_channels - - show_channels - - description - - skip_push - - skip_webhook - - user_ids - - users - - status - - created_at - - updated_at - - stats + - participants + - participants_count_by_role + - anonymous_participant_count + - rejected_by + - accepted_by + - missed_by type: object - CampaignStartedEvent: - nullable: true + CallSessionStartedEvent: + description: This event is sent when a call session starts properties: - campaign: - $ref: '#/components/schemas/CampaignResponse' - x-stream-index: "002" + call: + $ref: '#/components/schemas/CallResponse' + description: Call object + title: Call + x-stream-index: "004" + call_cid: + type: string + x-stream-index: "002.001" created_at: format: date-time type: number - x-stream-index: "001.003" - custom: - additionalProperties: {} - type: object - x-stream-index: "001.007" - received_at: - format: date-time - type: number - x-stream-index: "001.004" + x-stream-index: "001.002" + session_id: + description: Call session ID + title: Session ID + type: string + x-stream-index: "003.001" type: - default: campaign.started + default: call.session_started + description: 'The type of event: "call.session_started" in this case' + title: Event Type type: string - x-stream-index: "001.002" + x-stream-index: "001.001" required: - type - created_at - - custom - title: CampaignStartedEvent + - call_cid + - session_id + - call + title: CallSessionStartedEvent type: object - x-stream-event-client-type: true - x-stream-event-doc-group: other + x-stream-event-call-type: true + x-stream-event-doc-group: session x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CampaignStatsResponse: + CallSettings: properties: - progress: - format: float - type: number + audio: + $ref: '#/components/schemas/AudioSettings' + x-stream-index: "001" + backstage: + $ref: '#/components/schemas/BackstageSettings' + x-stream-index: "002" + broadcasting: + $ref: '#/components/schemas/BroadcastSettings' + x-stream-index: "007" + frame_recording: + $ref: '#/components/schemas/FrameRecordSettings' + x-stream-index: "006" + geofencing: + $ref: '#/components/schemas/GeofenceSettings' + x-stream-index: "008" + ingress: + $ref: '#/components/schemas/IngressSettings' + x-stream-index: "014" + limits: + $ref: '#/components/schemas/LimitsSettings' + x-stream-index: "012" + recording: + $ref: '#/components/schemas/RecordSettings' x-stream-index: "005" - stats_channels_created: - format: int32 - type: integer + ring: + $ref: '#/components/schemas/RingSettings' + x-stream-index: "010" + screensharing: + $ref: '#/components/schemas/ScreensharingSettings' x-stream-index: "004" - stats_completed_at: - format: date-time - type: number - x-stream-index: "002" - stats_messages_sent: - format: int32 - type: integer + session: + $ref: '#/components/schemas/SessionSettings' + x-stream-index: "013" + thumbnails: + $ref: '#/components/schemas/ThumbnailsSettings' + x-stream-index: "011" + transcription: + $ref: '#/components/schemas/TranscriptionSettings' + x-stream-index: "009" + video: + $ref: '#/components/schemas/VideoSettings' x-stream-index: "003" - stats_started_at: - format: date-time - type: number + type: object + CallSettingsRequest: + properties: + audio: + $ref: '#/components/schemas/AudioSettingsRequest' x-stream-index: "001" - stats_users_read: - format: int32 - type: integer - x-stream-index: "007" - stats_users_sent: - format: int32 - type: integer + backstage: + $ref: '#/components/schemas/BackstageSettingsRequest' + x-stream-index: "002" + broadcasting: + $ref: '#/components/schemas/BroadcastSettingsRequest' + x-stream-index: "010" + frame_recording: + $ref: '#/components/schemas/FrameRecordingSettingsRequest' x-stream-index: "006" - required: - - stats_started_at - - stats_completed_at - - stats_messages_sent - - stats_channels_created - - progress - - stats_users_sent - - stats_users_read + geofencing: + $ref: '#/components/schemas/GeofenceSettingsRequest' + x-stream-index: "003" + ingress: + $ref: '#/components/schemas/IngressSettingsRequest' + x-stream-index: "014" + limits: + $ref: '#/components/schemas/LimitsSettingsRequest' + x-stream-index: "012" + recording: + $ref: '#/components/schemas/RecordSettingsRequest' + x-stream-index: "005" + ring: + $ref: '#/components/schemas/RingSettingsRequest' + x-stream-index: "007" + screensharing: + $ref: '#/components/schemas/ScreensharingSettingsRequest' + x-stream-index: "008" + session: + $ref: '#/components/schemas/SessionSettingsRequest' + x-stream-index: "013" + thumbnails: + $ref: '#/components/schemas/ThumbnailsSettingsRequest' + x-stream-index: "011" + transcription: + $ref: '#/components/schemas/TranscriptionSettingsRequest' + x-stream-index: "009" + video: + $ref: '#/components/schemas/VideoSettingsRequest' + x-stream-index: "004" type: object - CastPollVoteRequest: - nullable: true + CallSettingsResponse: properties: - user: - $ref: '#/components/schemas/UserRequest' - x-stream-index: "005.002" - user_id: - type: string - x-stream-index: "005.001" - vote: - $ref: '#/components/schemas/VoteData' - description: Vote data - title: VoteData + audio: + $ref: '#/components/schemas/AudioSettingsResponse' + x-stream-index: "001" + backstage: + $ref: '#/components/schemas/BackstageSettingsResponse' + x-stream-index: "002" + broadcasting: + $ref: '#/components/schemas/BroadcastSettingsResponse' + x-stream-index: "003" + frame_recording: + $ref: '#/components/schemas/FrameRecordingSettingsResponse' + x-stream-index: "006" + geofencing: + $ref: '#/components/schemas/GeofenceSettingsResponse' x-stream-index: "004" + ingress: + $ref: '#/components/schemas/IngressSettingsResponse' + x-stream-index: "014" + limits: + $ref: '#/components/schemas/LimitsSettingsResponse' + x-stream-index: "012" + recording: + $ref: '#/components/schemas/RecordSettingsResponse' + x-stream-index: "005" + ring: + $ref: '#/components/schemas/RingSettingsResponse' + x-stream-index: "007" + screensharing: + $ref: '#/components/schemas/ScreensharingSettingsResponse' + x-stream-index: "008" + session: + $ref: '#/components/schemas/SessionSettingsResponse' + x-stream-index: "013" + thumbnails: + $ref: '#/components/schemas/ThumbnailsSettingsResponse' + x-stream-index: "011" + transcription: + $ref: '#/components/schemas/TranscriptionSettingsResponse' + x-stream-index: "009" + video: + $ref: '#/components/schemas/VideoSettingsResponse' + x-stream-index: "010" + required: + - audio + - backstage + - broadcasting + - geofencing + - recording + - frame_recording + - ring + - screensharing + - transcription + - video + - thumbnails + - limits + - session type: object - Channel: + CallStateResponseFields: + description: CallStateResponseFields is the payload for call state response properties: - active_live_locations: + call: + $ref: '#/components/schemas/CallResponse' + x-stream-index: "001" + members: + description: List of call members items: - $ref: '#/components/schemas/SharedLocation' + $ref: '#/components/schemas/MemberResponse' + title: Members type: array - x-stream-index: "034" - auto_translation_enabled: - type: boolean - x-stream-index: "029" - auto_translation_language: - type: string - x-stream-index: "030" - cid: + x-stream-index: "002" + own_capabilities: + items: + $ref: '#/components/schemas/OwnCapability' + type: array + x-stream-index: "004" + required: + - call + - members + - own_capabilities + - blocked_users + title: CallStateResponseFields + type: object + CallStatsReportReadyEvent: + description: This event is sent when the insights report is ready + properties: + call_cid: type: string - x-stream-index: "003" - config: - $ref: '#/components/schemas/ChannelConfig' - x-stream-index: "026" - config_overrides: - $ref: '#/components/schemas/ConfigOverrides' - x-stream-index: "027" - cooldown: - format: int32 - type: integer - x-stream-index: "031" + x-stream-index: "002.001" created_at: format: date-time type: number - x-stream-index: "009" - created_by: - $ref: '#/components/schemas/User' + x-stream-index: "001.002" + session_id: + description: Call session ID + title: Session ID + type: string + x-stream-index: "003.001" + type: + default: call.stats_report_ready + description: The type of event, "call.report_ready" in this case + title: Event Type + type: string + x-stream-index: "001.001" + required: + - type + - created_at + - call_cid + - session_id + title: CallStatsReportReadyEvent + type: object + x-stream-event-call-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + CallStatsReportSummaryResponse: + properties: + call_cid: + type: string + x-stream-index: "001" + call_duration_seconds: + format: int32 + type: integer x-stream-index: "008" - custom: - additionalProperties: {} - type: object - x-stream-index: "019" - deleted_at: - format: date-time - type: number - x-stream-index: "011" - disabled: - type: boolean - x-stream-index: "017" - frozen: - type: boolean - x-stream-index: "016" - id: + call_session_id: type: string - x-stream-index: "004" - invites: - items: - $ref: '#/components/schemas/ChannelMember' - type: array - x-stream-index: "022" - last_campaigns: + x-stream-index: "002" + call_status: type: string - x-stream-index: "032" - last_message_at: + x-stream-index: "004" + created_at: + format: date-time + type: number + x-stream-index: "007" + first_stats_time: format: date-time type: number + x-stream-index: "003" + min_user_rating: + format: int32 + type: integer x-stream-index: "006" - member_count: + quality_score: format: int32 type: integer - x-stream-index: "021" - members: - items: - $ref: '#/components/schemas/ChannelMember' - type: array - x-stream-index: "020" - team: + x-stream-index: "005" + required: + - call_cid + - call_session_id + - first_stats_time + - call_status + - call_duration_seconds + type: object + CallTranscription: + description: CallTranscription represents a transcription of a call. + properties: + end_time: + format: date-time + title: The end time of the transcription. + type: number + x-stream-index: "004" + filename: + title: The filename of the transcription. type: string - x-stream-index: "028" - truncated_by: - $ref: '#/components/schemas/User' - x-stream-index: "015" - type: + x-stream-index: "001" + session_id: + title: The session ID of the transcription. type: string x-stream-index: "005" - updated_at: + start_time: format: date-time + title: The start time of the transcription. type: number - x-stream-index: "010" + x-stream-index: "003" + url: + title: The URL of the transcription. + type: string + x-stream-index: "002" required: - - cid - - id - - type - - created_at - - updated_at - - frozen - - disabled - - custom - - auto_translation_language + - filename + - url + - start_time + - end_time + - session_id + title: CallTranscription type: object - ChannelConfig: + CallTranscriptionFailedEvent: + description: This event is sent when call transcription has failed properties: - allowed_flag_reasons: - items: - type: string - type: array - x-stream-index: "001.026" - automod: - enum: - - disabled - - simple - - AI + call_cid: type: string - x-stream-index: "001.021" - automod_behavior: - enum: - - flag - - block - - shadow_block + x-stream-index: "002.001" + created_at: + format: date-time + type: number + x-stream-index: "001.002" + egress_id: type: string - x-stream-index: "001.022" - automod_thresholds: - $ref: '#/components/schemas/Thresholds' - x-stream-index: "001.027" - blocklist: + x-stream-index: "003" + error: + description: The error message detailing why transcription failed. + title: string type: string - x-stream-index: "001.023" - blocklist_behavior: - enum: - - flag - - block - - shadow_block + x-stream-index: "004" + type: + default: call.transcription_failed + description: 'The type of event: "call.transcription_failed" in this case' + title: Event Type type: string - x-stream-index: "001.024" - blocklists: - items: - $ref: '#/components/schemas/BlockListOptions' - type: array - x-stream-index: "001.025" - commands: - items: - type: string - type: array + x-stream-index: "001.001" + required: + - type + - created_at + - call_cid + - egress_id + title: CallTranscriptionFailedEvent + type: object + x-stream-event-call-type: true + x-stream-event-doc-group: transcription + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + CallTranscriptionReadyEvent: + description: This event is sent when call transcription is ready + properties: + call_cid: + type: string + x-stream-index: "002.001" + call_transcription: + $ref: '#/components/schemas/CallTranscription' + description: The call transcription object + title: CallTranscription x-stream-index: "003" - connect_events: - type: boolean - x-stream-index: "001.004" created_at: format: date-time type: number - x-stream-index: "002.003" - custom_events: - type: boolean - x-stream-index: "001.012" - mark_messages_pending: - type: boolean - x-stream-index: "001.015" - max_message_length: - format: int32 - maximum: 20000 - type: integer - x-stream-index: "001.020" - mutes: - type: boolean - x-stream-index: "001.009" - name: + x-stream-index: "001.002" + egress_id: + type: string + x-stream-index: "004" + type: + default: call.transcription_ready + description: 'The type of event: "call.transcription_ready" in this case' + title: Event Type type: string x-stream-index: "001.001" - partition_size: - format: int32 - type: integer - x-stream-index: "001.028" - partition_ttl: - type: integer - x-stream-index: "001.029" - polls: - type: boolean - x-stream-index: "001.016" - push_notifications: - type: boolean - x-stream-index: "001.013" - quotes: - type: boolean - x-stream-index: "001.008" - reactions: - type: boolean - x-stream-index: "001.006" - read_events: - type: boolean - x-stream-index: "001.003" - reminders: - type: boolean - x-stream-index: "001.014" - replies: - type: boolean - x-stream-index: "001.007" - search: - type: boolean - x-stream-index: "001.005" - shared_locations: - type: boolean - x-stream-index: "001.018" - skip_last_msg_update_for_system_msgs: - type: boolean - x-stream-index: "001.030" - typing_events: - type: boolean - x-stream-index: "001.002" - updated_at: + required: + - type + - created_at + - call_cid + - call_transcription + - egress_id + title: CallTranscriptionReadyEvent + type: object + x-stream-event-call-type: true + x-stream-event-doc-group: transcription + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + CallTranscriptionStartedEvent: + description: This event is sent when call transcription has started + properties: + call_cid: + type: string + x-stream-index: "003.001" + created_at: format: date-time type: number - x-stream-index: "002.004" - uploads: - type: boolean - x-stream-index: "001.010" - url_enrichment: - type: boolean - x-stream-index: "001.011" - user_message_reminders: - type: boolean - x-stream-index: "001.017" + x-stream-index: "002.002" + egress_id: + type: string + x-stream-index: "001" + type: + default: call.transcription_started + description: 'The type of event: "call.transcription_started" in this case' + title: Event Type + type: string + x-stream-index: "002.001" required: - - name - - typing_events - - read_events - - connect_events - - search - - reactions - - replies - - quotes - - mutes - - uploads - - url_enrichment - - custom_events - - push_notifications - - reminders - - mark_messages_pending - - polls - - user_message_reminders - - shared_locations - - message_retention - - max_message_length - - automod - - automod_behavior - - skip_last_msg_update_for_system_msgs + - egress_id + - type - created_at - - updated_at - - commands + - call_cid + title: CallTranscriptionStartedEvent type: object - ChannelConfigWithInfo: + x-stream-event-call-type: true + x-stream-event-doc-group: transcription + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + CallTranscriptionStoppedEvent: + description: This event is sent when call transcription has stopped properties: - allowed_flag_reasons: - items: - type: string - type: array - x-stream-index: 001.002.026 - automod: - enum: - - disabled - - simple - - AI + call_cid: type: string - x-stream-index: 001.002.021 - automod_behavior: - enum: - - flag - - block - - shadow_block + x-stream-index: "002.001" + created_at: + format: date-time + type: number + x-stream-index: "001.002" + egress_id: type: string - x-stream-index: 001.002.022 - automod_thresholds: - $ref: '#/components/schemas/Thresholds' - x-stream-index: 001.002.027 - blocklist: + x-stream-index: "003" + type: + default: call.transcription_stopped + description: 'The type of event: "call.transcription_stopped" in this case' + title: Event Type type: string - x-stream-index: 001.002.023 - blocklist_behavior: - enum: - - flag - - block - - shadow_block + x-stream-index: "001.001" + required: + - type + - created_at + - call_cid + - egress_id + title: CallTranscriptionStoppedEvent + type: object + x-stream-event-call-type: true + x-stream-event-doc-group: transcription + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + CallType: + nullable: true + properties: + AppPK: + format: int32 + type: integer + writeOnly: true + x-stream-index: "003" + CreatedAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "005" + ExternalStorage: type: string - x-stream-index: 001.002.024 - blocklists: - items: - $ref: '#/components/schemas/BlockListOptions' - type: array - x-stream-index: 001.002.025 - commands: - items: - $ref: '#/components/schemas/Command' - type: array - x-stream-index: "001.003" - connect_events: - type: boolean - x-stream-index: 001.002.004 + writeOnly: true + x-stream-index: "009" + Name: + type: string + writeOnly: true + x-stream-index: "004" + NotificationSettings: + $ref: '#/components/schemas/NotificationSettings' + x-stream-index: "008" + PK: + format: int32 + type: integer + writeOnly: true + x-stream-index: "002" + Settings: + $ref: '#/components/schemas/CallSettings' + x-stream-index: "007" + UpdatedAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "006" + required: + - PK + - AppPK + - Name + - CreatedAt + - UpdatedAt + - ExternalStorage + type: object + CallTypeResponse: + description: CallTypeResponse is the payload for a call type. + properties: created_at: + description: the time the call type was created format: date-time + title: CreatedAt type: number - x-stream-index: 001.001.003 - custom_events: - type: boolean - x-stream-index: 001.002.012 + x-stream-index: "005" + external_storage: + description: the external storage for the call type + title: ExternalStorage + type: string + x-stream-index: "007" grants: additionalProperties: items: type: string type: array + description: the permissions granted to each role + title: Grants type: object x-stream-index: "002" - mark_messages_pending: - type: boolean - x-stream-index: 001.002.015 - max_message_length: - format: int32 - maximum: 20000 - type: integer - x-stream-index: 001.002.020 - mutes: - type: boolean - x-stream-index: 001.002.009 name: + description: the name of the call type + title: Name type: string - x-stream-index: 001.002.001 - partition_size: - format: int32 - type: integer - x-stream-index: 001.002.028 - partition_ttl: - example: 24h - format: duration - nullable: true - type: string - x-stream-index: 001.002.029 - polls: - type: boolean - x-stream-index: 001.002.016 - push_notifications: - type: boolean - x-stream-index: 001.002.013 - quotes: - type: boolean - x-stream-index: 001.002.008 - reactions: - type: boolean - x-stream-index: 001.002.006 - read_events: - type: boolean - x-stream-index: 001.002.003 - reminders: - type: boolean - x-stream-index: 001.002.014 - replies: - type: boolean - x-stream-index: 001.002.007 - search: - type: boolean - x-stream-index: 001.002.005 - shared_locations: - type: boolean - x-stream-index: 001.002.018 - skip_last_msg_update_for_system_msgs: - type: boolean - x-stream-index: 001.002.030 - typing_events: - type: boolean - x-stream-index: 001.002.002 + x-stream-index: "001" + notification_settings: + $ref: '#/components/schemas/NotificationSettings' + description: the notification settings for the call type + title: NotificationSettings + x-stream-index: "004" + settings: + $ref: '#/components/schemas/CallSettingsResponse' + description: the settings for the call type + title: Settings + x-stream-index: "003" updated_at: + description: the time the call type was last updated format: date-time + title: UpdatedAt type: number - x-stream-index: 001.001.004 - uploads: - type: boolean - x-stream-index: 001.002.010 - url_enrichment: - type: boolean - x-stream-index: 001.002.011 - user_message_reminders: - type: boolean - x-stream-index: 001.002.017 + x-stream-index: "006" required: + - name + - grants + - settings + - notification_settings - created_at - updated_at - - name - - typing_events - - read_events - - connect_events - - search - - reactions - - replies - - quotes - - mutes - - uploads - - url_enrichment - - custom_events - - push_notifications - - reminders - - mark_messages_pending - - polls - - user_message_reminders - - shared_locations - - message_retention - - max_message_length - - automod - - automod_behavior - - skip_last_msg_update_for_system_msgs - - commands + title: CallTypeResponse type: object - ChannelCreatedEvent: + CallUpdatedEvent: + description: |- + This event is sent when a call is updated, clients should use this update the local state of the call. + This event also contains the capabilities by role for the call, clients should update the own_capability for the current. properties: + call: + $ref: '#/components/schemas/CallResponse' + description: Call object + title: Call + x-stream-index: "003" + call_cid: + type: string + x-stream-index: "002.001" + capabilities_by_role: + additionalProperties: + items: + type: string + type: array + description: The capabilities by role for this call + title: CapabilitiesByRole + type: object + x-stream-index: "004" created_at: format: date-time type: number x-stream-index: "001.002" type: - default: channel.created + default: call.updated + description: 'The type of event: "call.updated" in this case' + title: Event Type type: string x-stream-index: "001.001" required: - type - created_at - title: ChannelCreatedEvent + - call_cid + - call + - capabilities_by_role + title: CallUpdatedEvent type: object - x-stream-event-client-type: true - x-stream-event-doc-group: other + x-stream-event-call-type: true + x-stream-event-doc-group: call x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - ChannelDeletedEvent: + CallUserFeedbackSubmittedEvent: + description: This event is sent when a user submits feedback for a call. properties: - channel: - $ref: '#/components/schemas/ChannelResponse' - x-stream-index: "003.004" - channel_id: + call_cid: type: string - x-stream-index: "003.002" - channel_member_count: + x-stream-index: "002.001" + created_at: + format: date-time + type: number + x-stream-index: "001.002" + custom: + additionalProperties: {} + description: Custom data provided by the user + title: Custom + type: object + x-stream-index: "007" + rating: + description: The rating given by the user (1-5) format: int32 + title: Rating type: integer - x-stream-index: "003.005" - channel_type: + x-stream-index: "005" + reason: + description: The reason provided by the user for the rating + title: Reason type: string - x-stream-index: "003.003" - cid: + x-stream-index: "006" + sdk: type: string - x-stream-index: "003.001" - created_at: - format: date-time - type: number - x-stream-index: "002.002" - team: + x-stream-index: "008" + sdk_version: type: string - x-stream-index: "001.001" + x-stream-index: "009" + session_id: + description: Call session ID + title: Session ID + type: string + x-stream-index: "003.001" type: - default: channel.deleted + default: call.user_feedback_submitted + description: The type of event, "call.user_feedback" in this case + title: Event Type type: string - x-stream-index: "002.001" + x-stream-index: "001.001" + user: + $ref: '#/components/schemas/UserResponse' + description: The user who submitted the feedback + title: User + x-stream-index: "004" required: - type - created_at - - cid - - channel_id - - channel_type - - channel_member_count - title: ChannelDeletedEvent + - call_cid + - session_id + - user + - rating + title: CallUserFeedbackSubmittedEvent type: object - x-stream-event-client-type: true + x-stream-event-call-type: true x-stream-event-doc-group: other x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - ChannelExport: - properties: - cid: - type: string - x-stream-index: "003" - id: - description: Channel ID - title: ID - type: string - x-stream-index: "002" - messages_since: - description: Date to export messages since - format: date-time - title: Messages since - type: number - x-stream-index: "004" - messages_until: - description: Date to export messages until - format: date-time - title: Messages until - type: number - x-stream-index: "005" - type: - description: Channel type - title: Type - type: string - x-stream-index: "001" - title: Channel Export - type: object - ChannelFrozenEvent: + CallUserMutedEvent: + description: This event is sent when a call member is muted properties: - channel_id: - type: string - x-stream-index: "002.002" - channel_type: - type: string - x-stream-index: "002.003" - cid: + call_cid: type: string x-stream-index: "002.001" created_at: format: date-time type: number x-stream-index: "001.002" + from_user_id: + type: string + x-stream-index: "003" + muted_user_ids: + items: + type: string + type: array + x-stream-index: "004" type: - default: channel.frozen + default: call.user_muted + description: 'The type of event: "call.user_muted" in this case' + title: Event Type type: string x-stream-index: "001.001" required: - type - created_at - - cid - - channel_id - - channel_type - title: ChannelFrozenEvent + - call_cid + - from_user_id + - muted_user_ids + title: CallUserMutedEvent type: object - x-stream-event-client-type: true - x-stream-event-doc-group: other + x-stream-event-call-type: true + x-stream-event-doc-group: call x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - ChannelGetOrCreateRequest: - nullable: true + CallsPerDayReport: properties: - data: - $ref: '#/components/schemas/ChannelInput' - x-stream-index: "003" - hide_for_creator: - description: Whether this channel will be hidden for the user who created - the channel or not - title: Hide for creator - type: boolean - x-stream-index: "007" - members: - $ref: '#/components/schemas/PaginationParams' - x-stream-index: "010" - messages: - $ref: '#/components/schemas/MessagePaginationParams' - x-stream-index: "009" - state: - description: Refresh channel state - title: State - type: boolean - x-stream-index: "005" - thread_unread_counts: - type: boolean - x-stream-index: "008" - watchers: - $ref: '#/components/schemas/PaginationParams' - x-stream-index: "011" + count: + format: int64 + type: integer + x-stream-index: "001" + required: + - count type: object - ChannelHiddenEvent: + CallsPerDayReportResponse: properties: - channel: - $ref: '#/components/schemas/ChannelResponse' - x-stream-index: "003.004" - channel_id: + daily: + items: + $ref: '#/components/schemas/DailyAggregateCallsPerDayReportResponse' + type: array + x-stream-index: "001" + required: + - daily + type: object + CampaignChannelTemplate: + properties: + custom: + additionalProperties: {} + type: object + x-stream-index: "005" + id: type: string - x-stream-index: "003.002" - channel_member_count: - format: int32 - type: integer - x-stream-index: "003.005" - channel_type: + x-stream-index: "002" + members: + items: + type: string + maximum: 1000 + type: array + x-stream-index: "003" + team: + maxLength: 1000 type: string - x-stream-index: "003.003" - cid: + x-stream-index: "004" + type: + maxLength: 64 type: string - x-stream-index: "003.001" - clear_history: - type: boolean x-stream-index: "001" + required: + - type + - custom + type: object + CampaignCompletedEvent: + nullable: true + properties: + campaign: + $ref: '#/components/schemas/CampaignResponse' + x-stream-index: "002" created_at: format: date-time type: number - x-stream-index: "004.002" + x-stream-index: "001.003" + custom: + additionalProperties: {} + type: object + x-stream-index: "001.007" + received_at: + format: date-time + type: number + x-stream-index: "001.004" type: - default: channel.hidden + default: campaign.completed type: string - x-stream-index: "004.001" - user: - $ref: '#/components/schemas/User' - x-stream-index: "002.001" + x-stream-index: "001.002" required: - - clear_history - - cid - - channel_id - - channel_type - - channel_member_count - type - created_at - title: ChannelHiddenEvent + - custom + title: CampaignCompletedEvent 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 - ChannelInput: + CampaignMessageTemplate: properties: - auto_translation_enabled: - description: Enable or disable auto translation - title: Auto translation - type: boolean - x-stream-index: "005" - auto_translation_language: - description: Switch auto translation language - title: Auto translation language - type: string - x-stream-index: "006" - config_overrides: - $ref: '#/components/schemas/ChannelConfig' - x-stream-index: "024" - created_by: - $ref: '#/components/schemas/UserRequest' - x-stream-index: "009" - created_by_id: - type: string - x-stream-index: "008" + attachments: + items: + $ref: '#/components/schemas/Attachment' + maximum: 30 + type: array + x-stream-index: "002" custom: additionalProperties: {} type: object - x-stream-index: "015" - disabled: - type: boolean - x-stream-index: "014" - frozen: - description: Freeze or unfreeze the channel - title: Frozen - type: boolean - x-stream-index: "013" - invites: - items: - $ref: '#/components/schemas/ChannelMember' - maximum: 100 - type: array - x-stream-index: "016" - members: - items: - $ref: '#/components/schemas/ChannelMember' - maximum: 100 - type: array - x-stream-index: "018" - team: - description: Team the channel belongs to (if multi-tenant mode is enabled) - title: Team - type: string x-stream-index: "004" - truncated_by_id: + poll_id: type: string - x-stream-index: "010" + x-stream-index: "003" + text: + type: string + x-stream-index: "001" + required: + - text + - attachments + - poll_id + - custom type: object - ChannelMember: - nullable: true + CampaignResponse: properties: - archived_at: + channel_template: + $ref: '#/components/schemas/CampaignChannelTemplate' + x-stream-index: "016" + create_channels: + type: boolean + x-stream-index: "008" + created_at: format: date-time type: number + x-stream-index: "020" + description: + type: string + x-stream-index: "010" + id: + type: string + x-stream-index: "001" + message_template: + $ref: '#/components/schemas/CampaignMessageTemplate' x-stream-index: "015" - ban_expires: - description: Expiration date of the ban + name: + type: string + x-stream-index: "007" + scheduled_for: format: date-time - title: Ban expires type: number x-stream-index: "013" - banned: - description: Whether member is banned this channel or not - title: Banned - type: boolean - x-stream-index: "012" - channel_role: - description: Role of the member in the channel - title: Channel Role + segment_ids: + items: + type: string + type: array + x-stream-index: "002" + segments: + items: + $ref: '#/components/schemas/Segment' + type: array + x-stream-index: "003" + sender: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "005" + sender_id: type: string - x-stream-index: "018" - created_at: - description: Date/time of creation - format: date-time - title: Created at - type: number - x-stream-index: "009" - custom: - additionalProperties: {} - type: object x-stream-index: "004" - deleted_at: - format: date-time - type: number - x-stream-index: "011" - invite_accepted_at: - description: Date when invite was accepted - format: date-time - title: Invited accepted at - type: number + sender_mode: + type: string x-stream-index: "006" - invite_rejected_at: - description: Date when invite was rejected - format: date-time - title: Invited rejected at - type: number - x-stream-index: "007" - invited: - description: Whether member was invited or not - title: Invited + show_channels: type: boolean - x-stream-index: "005" - is_moderator: - description: Whether member is channel moderator or not - title: Is moderator + x-stream-index: "009" + skip_push: type: boolean - x-stream-index: "003" - notifications_muted: + x-stream-index: "011" + skip_webhook: type: boolean + x-stream-index: "012" + stats: + $ref: '#/components/schemas/CampaignStatsResponse' + x-stream-index: "022" + status: + type: string x-stream-index: "019" - pinned_at: + stop_at: format: date-time type: number - x-stream-index: "016" - role: - description: 'Permission level of the member in the channel (DEPRECATED: - use channel_role instead)' - enum: - - member - - moderator - - admin - - owner - title: Role - type: string - x-stream-index: "017" - shadow_banned: - description: Whether member is shadow banned in this channel or not - title: Shadow banned - type: boolean x-stream-index: "014" - status: - type: string - x-stream-index: "008" updated_at: - description: Date/time of the last update format: date-time - title: Updated at type: number - x-stream-index: "010" - user: - $ref: '#/components/schemas/UserResponse' - x-stream-index: "002" - user_id: - title: User ID - type: string - x-stream-index: "001" + x-stream-index: "021" + user_ids: + items: + type: string + type: array + x-stream-index: "017" + users: + items: + $ref: '#/components/schemas/UserResponse' + type: array + x-stream-index: "018" required: - - custom + - id + - segment_ids + - segments + - sender_id + - sender_mode + - name + - create_channels + - show_channels + - description + - skip_push + - skip_webhook + - user_ids + - users + - status - created_at - updated_at - - banned - - shadow_banned - - channel_role - - notifications_muted - title: Channel member + - stats type: object - ChannelMemberResponse: + CampaignStartedEvent: nullable: true properties: - archived_at: + campaign: + $ref: '#/components/schemas/CampaignResponse' + x-stream-index: "002" + created_at: format: date-time type: number - x-stream-index: "016" - ban_expires: - description: Expiration date of the ban + x-stream-index: "001.003" + custom: + additionalProperties: {} + type: object + x-stream-index: "001.007" + received_at: format: date-time - title: Ban expires type: number - x-stream-index: "013" - banned: - description: Whether member is banned this channel or not - title: Banned + x-stream-index: "001.004" + type: + default: campaign.started + type: string + x-stream-index: "001.002" + required: + - type + - created_at + - custom + title: CampaignStartedEvent + 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 + CampaignStatsResponse: + properties: + progress: + format: float + type: number + x-stream-index: "005" + stats_channels_created: + format: int32 + type: integer + x-stream-index: "004" + stats_completed_at: + format: date-time + type: number + x-stream-index: "002" + stats_messages_sent: + format: int32 + type: integer + x-stream-index: "003" + stats_started_at: + format: date-time + type: number + x-stream-index: "001" + stats_users_read: + format: int32 + type: integer + x-stream-index: "007" + stats_users_sent: + format: int32 + type: integer + x-stream-index: "006" + required: + - stats_started_at + - stats_completed_at + - stats_messages_sent + - stats_channels_created + - progress + - stats_users_sent + - stats_users_read + type: object + CastPollVoteRequest: + nullable: true + properties: + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "005.002" + user_id: + type: string + x-stream-index: "005.001" + vote: + $ref: '#/components/schemas/VoteData' + description: Vote data + title: VoteData + x-stream-index: "004" + type: object + Channel: + properties: + active_live_locations: + items: + $ref: '#/components/schemas/SharedLocation' + type: array + x-stream-index: "034" + auto_translation_enabled: type: boolean - x-stream-index: "012" - channel_role: - description: Role of the member in the channel - title: Channel Role + x-stream-index: "029" + auto_translation_language: type: string - x-stream-index: "018" + x-stream-index: "030" + cid: + type: string + x-stream-index: "003" + config: + $ref: '#/components/schemas/ChannelConfig' + x-stream-index: "026" + config_overrides: + $ref: '#/components/schemas/ConfigOverrides' + x-stream-index: "027" + cooldown: + format: int32 + type: integer + x-stream-index: "031" created_at: - description: Date/time of creation format: date-time - title: Created at type: number x-stream-index: "009" + created_by: + $ref: '#/components/schemas/User' + x-stream-index: "008" custom: additionalProperties: {} type: object - x-stream-index: "004" + x-stream-index: "019" deleted_at: format: date-time type: number x-stream-index: "011" - invite_accepted_at: - description: Date when invite was accepted + disabled: + type: boolean + x-stream-index: "017" + frozen: + type: boolean + x-stream-index: "016" + id: + type: string + x-stream-index: "004" + invites: + items: + $ref: '#/components/schemas/ChannelMember' + type: array + x-stream-index: "022" + last_campaigns: + type: string + x-stream-index: "032" + last_message_at: format: date-time - title: Invited accepted at type: number x-stream-index: "006" - invite_rejected_at: - description: Date when invite was rejected - format: date-time - title: Invited rejected at - type: number - x-stream-index: "007" - invited: - description: Whether member was invited or not - title: Invited - type: boolean - x-stream-index: "005" - is_moderator: - description: Whether member is channel moderator or not - title: Is moderator - type: boolean - x-stream-index: "003" - notifications_muted: - type: boolean - x-stream-index: "019" - pinned_at: + member_count: + format: int32 + type: integer + x-stream-index: "021" + members: + items: + $ref: '#/components/schemas/ChannelMember' + type: array + x-stream-index: "020" + message_count: + format: int64 + type: integer + x-stream-index: "035" + message_count_updated_at: format: date-time type: number - x-stream-index: "015" - role: - description: 'Permission level of the member in the channel (DEPRECATED: - use channel_role instead)' - enum: - - member - - moderator - - admin - - owner - title: Role + x-stream-index: "036" + team: type: string - x-stream-index: "017" - shadow_banned: - description: Whether member is shadow banned in this channel or not - title: Shadow banned - type: boolean - x-stream-index: "014" - status: + x-stream-index: "028" + truncated_by: + $ref: '#/components/schemas/User' + x-stream-index: "015" + type: type: string - x-stream-index: "008" + x-stream-index: "005" updated_at: - description: Date/time of the last update format: date-time - title: Updated at type: number x-stream-index: "010" - user: - $ref: '#/components/schemas/UserResponse' - x-stream-index: "002" - user_id: - title: User ID - type: string - x-stream-index: "001" required: - - custom + - cid + - id + - type - created_at - updated_at - - banned - - shadow_banned - - channel_role - - notifications_muted - title: Channel member + - frozen + - disabled + - custom + - auto_translation_language type: object - ChannelMessages: - nullable: true + ChannelConfig: properties: - channel: - $ref: '#/components/schemas/ChannelResponse' - x-stream-index: "001" - messages: + allowed_flag_reasons: items: - $ref: '#/components/schemas/Message' + type: string type: array - x-stream-index: "002" + x-stream-index: "001.027" + automod: + enum: + - disabled + - simple + - AI + type: string + x-stream-index: "001.022" + automod_behavior: + enum: + - flag + - block + - shadow_block + type: string + x-stream-index: "001.023" + automod_thresholds: + $ref: '#/components/schemas/Thresholds' + x-stream-index: "001.028" + blocklist: + type: string + x-stream-index: "001.024" + blocklist_behavior: + enum: + - flag + - block + - shadow_block + type: string + x-stream-index: "001.025" + blocklists: + items: + $ref: '#/components/schemas/BlockListOptions' + type: array + x-stream-index: "001.026" + commands: + items: + type: string + type: array + x-stream-index: "003" + connect_events: + type: boolean + x-stream-index: "001.004" + count_messages: + type: boolean + x-stream-index: "001.019" + created_at: + format: date-time + type: number + x-stream-index: "002.003" + custom_events: + type: boolean + x-stream-index: "001.012" + mark_messages_pending: + type: boolean + x-stream-index: "001.015" + max_message_length: + format: int32 + maximum: 20000 + type: integer + x-stream-index: "001.021" + mutes: + type: boolean + x-stream-index: "001.009" + name: + type: string + x-stream-index: "001.001" + partition_size: + format: int32 + type: integer + x-stream-index: "001.029" + partition_ttl: + type: integer + x-stream-index: "001.030" + polls: + type: boolean + x-stream-index: "001.016" + push_notifications: + type: boolean + x-stream-index: "001.013" + quotes: + type: boolean + x-stream-index: "001.008" + reactions: + type: boolean + x-stream-index: "001.006" + read_events: + type: boolean + x-stream-index: "001.003" + reminders: + type: boolean + x-stream-index: "001.014" + replies: + type: boolean + x-stream-index: "001.007" + search: + type: boolean + x-stream-index: "001.005" + shared_locations: + type: boolean + x-stream-index: "001.018" + skip_last_msg_update_for_system_msgs: + type: boolean + x-stream-index: "001.031" + typing_events: + type: boolean + x-stream-index: "001.002" + updated_at: + format: date-time + type: number + x-stream-index: "002.004" + uploads: + type: boolean + x-stream-index: "001.010" + url_enrichment: + type: boolean + x-stream-index: "001.011" + user_message_reminders: + type: boolean + x-stream-index: "001.017" required: - - messages + - name + - typing_events + - read_events + - connect_events + - search + - reactions + - replies + - quotes + - mutes + - uploads + - url_enrichment + - custom_events + - push_notifications + - reminders + - mark_messages_pending + - polls + - user_message_reminders + - shared_locations + - count_messages + - message_retention + - max_message_length + - automod + - automod_behavior + - skip_last_msg_update_for_system_msgs + - created_at + - updated_at + - commands type: object - ChannelMute: - nullable: true + ChannelConfigWithInfo: properties: - channel: - $ref: '#/components/schemas/ChannelResponse' - description: Channel that is muted - title: Channel - x-stream-index: "002" + allowed_flag_reasons: + items: + type: string + type: array + x-stream-index: 001.002.027 + automod: + enum: + - disabled + - simple + - AI + type: string + x-stream-index: 001.002.022 + automod_behavior: + enum: + - flag + - block + - shadow_block + type: string + x-stream-index: 001.002.023 + automod_thresholds: + $ref: '#/components/schemas/Thresholds' + x-stream-index: 001.002.028 + blocklist: + type: string + x-stream-index: 001.002.024 + blocklist_behavior: + enum: + - flag + - block + - shadow_block + type: string + x-stream-index: 001.002.025 + blocklists: + items: + $ref: '#/components/schemas/BlockListOptions' + type: array + x-stream-index: 001.002.026 + commands: + items: + $ref: '#/components/schemas/Command' + type: array + x-stream-index: "001.003" + connect_events: + type: boolean + x-stream-index: 001.002.004 + count_messages: + type: boolean + x-stream-index: 001.002.019 created_at: - description: Date/time of creation - format: date-time - title: Created at - type: number - x-stream-index: "004" - expires: - description: Date/time of mute expiration format: date-time - title: Expires type: number - x-stream-index: "003" + x-stream-index: 001.001.003 + custom_events: + type: boolean + x-stream-index: 001.002.012 + grants: + additionalProperties: + items: + type: string + type: array + type: object + x-stream-index: "002" + mark_messages_pending: + type: boolean + x-stream-index: 001.002.015 + max_message_length: + format: int32 + maximum: 20000 + type: integer + x-stream-index: 001.002.021 + mutes: + type: boolean + x-stream-index: 001.002.009 + name: + type: string + x-stream-index: 001.002.001 + partition_size: + format: int32 + type: integer + x-stream-index: 001.002.029 + partition_ttl: + example: 24h + format: duration + nullable: true + type: string + x-stream-index: 001.002.030 + polls: + type: boolean + x-stream-index: 001.002.016 + push_notifications: + type: boolean + x-stream-index: 001.002.013 + quotes: + type: boolean + x-stream-index: 001.002.008 + reactions: + type: boolean + x-stream-index: 001.002.006 + read_events: + type: boolean + x-stream-index: 001.002.003 + reminders: + type: boolean + x-stream-index: 001.002.014 + replies: + type: boolean + x-stream-index: 001.002.007 + search: + type: boolean + x-stream-index: 001.002.005 + shared_locations: + type: boolean + x-stream-index: 001.002.018 + skip_last_msg_update_for_system_msgs: + type: boolean + x-stream-index: 001.002.031 + typing_events: + type: boolean + x-stream-index: 001.002.002 updated_at: - description: Date/time of the last update format: date-time - title: Updated at type: number - x-stream-index: "005" - user: - $ref: '#/components/schemas/UserResponse' - description: Owner of channel mute - title: User - x-stream-index: "001" + x-stream-index: 001.001.004 + uploads: + type: boolean + x-stream-index: 001.002.010 + url_enrichment: + type: boolean + x-stream-index: 001.002.011 + user_message_reminders: + type: boolean + x-stream-index: 001.002.017 required: - created_at - updated_at + - name + - typing_events + - read_events + - connect_events + - search + - reactions + - replies + - quotes + - mutes + - uploads + - url_enrichment + - custom_events + - push_notifications + - reminders + - mark_messages_pending + - polls + - user_message_reminders + - shared_locations + - count_messages + - message_retention + - max_message_length + - automod + - automod_behavior + - skip_last_msg_update_for_system_msgs + - commands type: object - ChannelMutedEvent: + ChannelCreatedEvent: properties: created_at: format: date-time type: number x-stream-index: "001.002" type: - default: channel.muted + default: channel.created type: string x-stream-index: "001.001" required: - type - created_at - title: ChannelMutedEvent + title: ChannelCreatedEvent 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 - ChannelOwnCapability: - description: All possibility of string to use - enum: - - ban-channel-members - - cast-poll-vote - - connect-events - - create-attachment - - delete-any-message - - delete-channel - - delete-own-message - - flag-message - - freeze-channel - - join-channel - - leave-channel - - mute-channel - - pin-message - - query-poll-votes - - quote-message - - read-events - - search-messages - - send-custom-events - - send-links - - send-message - - send-poll - - send-reaction - - send-reply - - send-restricted-visibility-message - - send-typing-events - - set-channel-cooldown - - share-location - - skip-slow-mode - - slow-mode - - typing-events - - update-any-message - - update-channel - - update-channel-members - - update-own-message - - update-thread - - upload-file - title: ChannelOwnCapability - type: string - ChannelPushPreferences: + ChannelDeletedEvent: properties: - chat_level: + channel: + $ref: '#/components/schemas/ChannelResponse' + x-stream-index: "003.004" + channel_id: type: string - x-stream-index: "001" - disabled_until: + x-stream-index: "003.002" + channel_member_count: + format: int32 + type: integer + x-stream-index: "003.005" + channel_type: + type: string + x-stream-index: "003.003" + cid: + type: string + x-stream-index: "003.001" + created_at: format: date-time type: number - x-stream-index: "002" + x-stream-index: "002.002" + team: + type: string + x-stream-index: "001.001" + type: + default: channel.deleted + type: string + x-stream-index: "002.001" + required: + - type + - created_at + - cid + - channel_id + - channel_type + - channel_member_count + title: ChannelDeletedEvent type: object - ChannelResponse: - description: Represents channel in chat + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + ChannelExport: properties: - auto_translation_enabled: - description: Whether auto translation is enabled or not - title: Auto translation - type: boolean - x-stream-index: "017" - auto_translation_language: - description: Language to translate to when auto translation is active - title: Auto translation language - type: string - x-stream-index: "018" - blocked: - description: Whether this channel is blocked by current user or not - title: Blocked - type: boolean - x-stream-index: "023" cid: - description: Channel CID (:) - title: CID type: string x-stream-index: "003" - config: - $ref: '#/components/schemas/ChannelConfigWithInfo' - description: Channel configuration - title: ChannelConfigWithInfo - x-stream-index: "013" - cooldown: - description: Cooldown period after sending each message - format: int32 - title: Cooldown - type: integer - x-stream-index: "020" - created_at: - description: Date/time of creation - format: date-time - title: Created at - type: number - x-stream-index: "005" - created_by: - $ref: '#/components/schemas/UserResponse' - description: Creator of the channel - title: UserResponse - x-stream-index: "008" - custom: - additionalProperties: {} - description: Custom data for this object - title: Custom data - type: object - x-stream-index: "026" - deleted_at: - description: Date/time of deletion - format: date-time - title: Deleted at - type: number - x-stream-index: "007" - disabled: - type: boolean - x-stream-index: "010" - frozen: - description: Whether channel is frozen or not - title: Frozen - type: boolean - x-stream-index: "009" - hidden: - description: Whether this channel is hidden by current user or not - title: Hidden - type: boolean - x-stream-index: "022" - hide_messages_before: - description: Date since when the message history is accessible - format: date-time - title: Hide messages before - type: number - x-stream-index: "019" id: - description: Channel unique ID + description: Channel ID title: ID type: string - x-stream-index: "001" - last_message_at: - description: Date of the last message sent + x-stream-index: "002" + messages_since: + description: Date to export messages since format: date-time - title: Last message at + title: Messages since type: number x-stream-index: "004" - member_count: - description: Number of members in the channel - format: int32 - title: Member count - type: integer - x-stream-index: "012" - members: - description: List of channel members (max 100) - items: - $ref: '#/components/schemas/ChannelMember' - title: ChannelMembers - type: array - x-stream-index: "011" - mute_expires_at: - description: Date of mute expiration - format: date-time - title: Mute expires at - type: number - x-stream-index: "015" - muted: - description: Whether this channel is muted or not - title: Muted - type: boolean - x-stream-index: "014" - own_capabilities: - description: List of channel capabilities of authenticated user - items: - $ref: '#/components/schemas/ChannelOwnCapability' - title: ChannelOwnCapability - type: array - x-stream-index: "021" - team: - description: Team the channel belongs to (multi-tenant only) - title: Team - type: string - x-stream-index: "016" - truncated_at: - description: Date of the latest truncation of the channel + messages_until: + description: Date to export messages until format: date-time - title: UserResponse + title: Messages until type: number - x-stream-index: "024" - truncated_by: - $ref: '#/components/schemas/UserResponse' - x-stream-index: "025" + x-stream-index: "005" type: - description: Type of the channel + description: Channel type title: Type type: string - x-stream-docs-page-id: channel_features - x-stream-index: "002" - updated_at: - description: Date/time of the last update - format: date-time - title: Updated at - type: number - x-stream-index: "006" - required: - - id - - type - - cid - - created_at - - updated_at - - frozen - - disabled - - custom - title: Channel + x-stream-index: "001" + title: Channel Export type: object - ChannelStateResponse: - nullable: true + ChannelFrozenEvent: properties: - active_live_locations: - items: - $ref: '#/components/schemas/SharedLocationResponseData' - type: array - x-stream-index: "001.015" - channel: - $ref: '#/components/schemas/ChannelResponse' - x-stream-index: "001.001" - draft: - $ref: '#/components/schemas/DraftResponse' - x-stream-index: "001.014" - duration: + channel_id: + type: string + x-stream-index: "002.002" + channel_type: + type: string + x-stream-index: "002.003" + cid: type: string x-stream-index: "002.001" - hidden: - type: boolean - x-stream-index: "001.011" - hide_messages_before: + created_at: format: date-time type: number - x-stream-index: "001.012" - members: - items: - $ref: '#/components/schemas/ChannelMember' - type: array - x-stream-index: "001.007" - membership: - $ref: '#/components/schemas/ChannelMember' - x-stream-index: "001.008" - messages: - items: - $ref: '#/components/schemas/MessageResponse' - type: array x-stream-index: "001.002" - pending_messages: - items: - $ref: '#/components/schemas/PendingMessageResponse' - type: array - x-stream-index: "001.013" - pinned_messages: - items: - $ref: '#/components/schemas/MessageResponse' - type: array - x-stream-index: "001.003" - push_preferences: - $ref: '#/components/schemas/ChannelPushPreferences' - x-stream-index: "001.009" - read: - items: - $ref: '#/components/schemas/ReadStateResponse' - type: array - x-stream-index: "001.006" - threads: - items: - $ref: '#/components/schemas/ThreadStateResponse' - type: array - x-stream-index: "001.010" - watcher_count: - format: int32 - type: integer - x-stream-index: "001.004" - watchers: - items: - $ref: '#/components/schemas/UserResponse' - type: array - x-stream-index: "001.005" + type: + default: channel.frozen + type: string + x-stream-index: "001.001" required: - - messages - - pinned_messages - - members - - threads - - duration + - type + - created_at + - cid + - channel_id + - channel_type + title: ChannelFrozenEvent type: object - ChannelStateResponseFields: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + ChannelGetOrCreateRequest: + nullable: true properties: - active_live_locations: - description: Active live locations in the channel - items: - $ref: '#/components/schemas/SharedLocationResponseData' - title: Active Live Locations - type: array - x-stream-index: "015" - channel: - $ref: '#/components/schemas/ChannelResponse' - x-stream-index: "001" - draft: - $ref: '#/components/schemas/DraftResponse' - x-stream-index: "014" - hidden: - description: Whether this channel is hidden or not - title: Hidden + data: + $ref: '#/components/schemas/ChannelInput' + x-stream-index: "003" + hide_for_creator: + description: Whether this channel will be hidden for the user who created + the channel or not + title: Hide for creator type: boolean - x-stream-index: "011" - hide_messages_before: - description: Messages before this date are hidden from the user - format: date-time - title: Hide messages before - type: number - x-stream-index: "012" - members: - description: List of channel members - items: - $ref: '#/components/schemas/ChannelMember' - title: Members - type: array x-stream-index: "007" - membership: - $ref: '#/components/schemas/ChannelMember' - description: Current user membership object - title: Membership - x-stream-index: "008" + members: + $ref: '#/components/schemas/PaginationParams' + x-stream-index: "010" messages: - description: List of channel messages - items: - $ref: '#/components/schemas/MessageResponse' - title: Message - type: array - x-stream-index: "002" - pending_messages: - description: Pending messages that this user has sent - items: - $ref: '#/components/schemas/PendingMessageResponse' - title: Pending messages - type: array - x-stream-index: "013" - pinned_messages: - description: List of pinned messages in the channel - items: - $ref: '#/components/schemas/MessageResponse' - title: Pinned messages - type: array - x-stream-docs-page-id: pinned_messages - x-stream-index: "003" - push_preferences: - $ref: '#/components/schemas/ChannelPushPreferences' + $ref: '#/components/schemas/MessagePaginationParams' x-stream-index: "009" - read: - description: List of read states - items: - $ref: '#/components/schemas/ReadStateResponse' - title: Read - type: array - x-stream-index: "006" - threads: - items: - $ref: '#/components/schemas/ThreadStateResponse' - type: array - x-stream-index: "010" - watcher_count: - description: Number of channel watchers - format: int32 - title: Watcher count - type: integer - x-stream-index: "004" - watchers: - description: List of user who is watching the channel - items: - $ref: '#/components/schemas/UserResponse' - title: Watchers - type: array + state: + description: Refresh channel state + title: State + type: boolean x-stream-index: "005" - required: - - messages - - pinned_messages - - members - - threads + thread_unread_counts: + type: boolean + x-stream-index: "008" + watchers: + $ref: '#/components/schemas/PaginationParams' + x-stream-index: "011" type: object - ChannelTruncatedEvent: + ChannelHiddenEvent: properties: channel: $ref: '#/components/schemas/ChannelResponse' - x-stream-index: "001.004" + x-stream-index: "003.004" channel_id: type: string - x-stream-index: "001.002" + x-stream-index: "003.002" channel_member_count: format: int32 type: integer - x-stream-index: "001.005" + x-stream-index: "003.005" channel_type: type: string - x-stream-index: "001.003" + x-stream-index: "003.003" cid: type: string - x-stream-index: "001.001" + x-stream-index: "003.001" + clear_history: + type: boolean + x-stream-index: "001" created_at: format: date-time type: number - x-stream-index: "002.002" + x-stream-index: "004.002" type: - default: channel.truncated + default: channel.hidden type: string + x-stream-index: "004.001" + user: + $ref: '#/components/schemas/User' x-stream-index: "002.001" required: + - clear_history - cid - channel_id - channel_type - channel_member_count - type - created_at - title: ChannelTruncatedEvent + title: ChannelHiddenEvent 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 - ChannelTypeConfig: - nullable: true + ChannelInput: properties: - allowed_flag_reasons: - items: - type: string - type: array - x-stream-index: 003.002.026 - automod: - enum: - - disabled - - simple - - AI - type: string - x-stream-index: 003.002.021 - automod_behavior: - enum: - - flag - - block - - shadow_block - type: string - x-stream-index: 003.002.022 - automod_thresholds: - $ref: '#/components/schemas/Thresholds' - x-stream-index: 003.002.027 - blocklist: + auto_translation_enabled: + description: Enable or disable auto translation + title: Auto translation + type: boolean + x-stream-index: "005" + auto_translation_language: + description: Switch auto translation language + title: Auto translation language type: string - x-stream-index: 003.002.023 - blocklist_behavior: - enum: - - flag - - block - - shadow_block + x-stream-index: "006" + config_overrides: + $ref: '#/components/schemas/ChannelConfig' + x-stream-index: "024" + created_by: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "009" + created_by_id: type: string - x-stream-index: 003.002.024 - blocklists: + x-stream-index: "008" + custom: + additionalProperties: {} + type: object + x-stream-index: "015" + disabled: + type: boolean + x-stream-index: "014" + frozen: + description: Freeze or unfreeze the channel + title: Frozen + type: boolean + x-stream-index: "013" + invites: items: - $ref: '#/components/schemas/BlockListOptions' + $ref: '#/components/schemas/ChannelMember' + maximum: 100 type: array - x-stream-index: 003.002.025 - commands: + x-stream-index: "016" + members: items: - $ref: '#/components/schemas/Command' + $ref: '#/components/schemas/ChannelMember' + maximum: 100 type: array - x-stream-index: "003.003" - connect_events: + x-stream-index: "018" + team: + description: Team the channel belongs to (if multi-tenant mode is enabled) + title: Team + type: string + x-stream-index: "004" + truncated_by_id: + type: string + x-stream-index: "010" + type: object + ChannelMember: + nullable: true + properties: + archived_at: + format: date-time + type: number + x-stream-index: "015" + ban_expires: + description: Expiration date of the ban + format: date-time + title: Ban expires + type: number + x-stream-index: "013" + banned: + description: Whether member is banned this channel or not + title: Banned type: boolean - x-stream-index: 003.002.004 + x-stream-index: "012" + channel_role: + description: Role of the member in the channel + title: Channel Role + type: string + x-stream-index: "018" created_at: + description: Date/time of creation format: date-time + title: Created at type: number - x-stream-index: 003.001.003 - custom_events: - type: boolean - x-stream-index: 003.002.012 - grants: - additionalProperties: - items: - type: string - type: array + x-stream-index: "009" + custom: + additionalProperties: {} type: object - x-stream-index: "002" - mark_messages_pending: - type: boolean - x-stream-index: 003.002.015 - max_message_length: - format: int32 - maximum: 20000 - type: integer - x-stream-index: 003.002.020 - mutes: - type: boolean - x-stream-index: 003.002.009 - name: - type: string - x-stream-index: 003.002.001 - partition_size: - format: int32 - type: integer - x-stream-index: 003.002.028 - partition_ttl: - example: 24h - format: duration - nullable: true - type: string - x-stream-index: 003.002.029 - permissions: + x-stream-index: "004" + deleted_at: + format: date-time + type: number + x-stream-index: "011" + deleted_messages: items: - $ref: '#/components/schemas/PolicyRequest' + type: string type: array - x-stream-index: "001" - polls: - type: boolean - x-stream-index: 003.002.016 - push_notifications: - type: boolean - x-stream-index: 003.002.013 - quotes: - type: boolean - x-stream-index: 003.002.008 - reactions: - type: boolean - x-stream-index: 003.002.006 - read_events: - type: boolean - x-stream-index: 003.002.003 - reminders: - type: boolean - x-stream-index: 003.002.014 - replies: - type: boolean - x-stream-index: 003.002.007 - search: + x-stream-index: "020" + invite_accepted_at: + description: Date when invite was accepted + format: date-time + title: Invited accepted at + type: number + x-stream-index: "006" + invite_rejected_at: + description: Date when invite was rejected + format: date-time + title: Invited rejected at + type: number + x-stream-index: "007" + invited: + description: Whether member was invited or not + title: Invited type: boolean - x-stream-index: 003.002.005 - shared_locations: + x-stream-index: "005" + is_moderator: + description: Whether member is channel moderator or not + title: Is moderator type: boolean - x-stream-index: 003.002.018 - skip_last_msg_update_for_system_msgs: + x-stream-index: "003" + notifications_muted: type: boolean - x-stream-index: 003.002.030 - typing_events: + x-stream-index: "019" + pinned_at: + format: date-time + type: number + x-stream-index: "016" + role: + description: 'Permission level of the member in the channel (DEPRECATED: + use channel_role instead)' + enum: + - member + - moderator + - admin + - owner + title: Role + type: string + x-stream-index: "017" + shadow_banned: + description: Whether member is shadow banned in this channel or not + title: Shadow banned type: boolean - x-stream-index: 003.002.002 + x-stream-index: "014" + status: + type: string + x-stream-index: "008" updated_at: + description: Date/time of the last update format: date-time + title: Updated at type: number - x-stream-index: 003.001.004 - uploads: - type: boolean - x-stream-index: 003.002.010 - url_enrichment: - type: boolean - x-stream-index: 003.002.011 - user_message_reminders: - type: boolean - x-stream-index: 003.002.017 + x-stream-index: "010" + user: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "002" + user_id: + title: User ID + type: string + x-stream-index: "001" required: - - permissions - - grants + - custom - created_at - updated_at - - name - - typing_events - - read_events - - connect_events - - search - - reactions - - replies - - quotes - - mutes - - uploads - - url_enrichment - - custom_events - - push_notifications - - reminders - - mark_messages_pending - - polls - - user_message_reminders - - shared_locations - - message_retention - - max_message_length - - automod - - automod_behavior - - skip_last_msg_update_for_system_msgs - - commands + - banned + - shadow_banned + - channel_role + - notifications_muted + title: Channel member type: object - ChannelUnFrozenEvent: + ChannelMemberResponse: + nullable: true properties: - channel_id: + archived_at: + format: date-time + type: number + x-stream-index: "016" + ban_expires: + description: Expiration date of the ban + format: date-time + title: Ban expires + type: number + x-stream-index: "013" + banned: + description: Whether member is banned this channel or not + title: Banned + type: boolean + x-stream-index: "012" + channel_role: + description: Role of the member in the channel + title: Channel Role type: string - x-stream-index: "002.002" - channel_type: + x-stream-index: "018" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: "009" + custom: + additionalProperties: {} + type: object + x-stream-index: "004" + deleted_at: + format: date-time + type: number + x-stream-index: "011" + invite_accepted_at: + description: Date when invite was accepted + format: date-time + title: Invited accepted at + type: number + x-stream-index: "006" + invite_rejected_at: + description: Date when invite was rejected + format: date-time + title: Invited rejected at + type: number + x-stream-index: "007" + invited: + description: Whether member was invited or not + title: Invited + type: boolean + x-stream-index: "005" + is_moderator: + description: Whether member is channel moderator or not + title: Is moderator + type: boolean + x-stream-index: "003" + notifications_muted: + type: boolean + x-stream-index: "019" + pinned_at: + format: date-time + type: number + x-stream-index: "015" + role: + description: 'Permission level of the member in the channel (DEPRECATED: + use channel_role instead)' + enum: + - member + - moderator + - admin + - owner + title: Role type: string - x-stream-index: "002.003" - cid: + x-stream-index: "017" + shadow_banned: + description: Whether member is shadow banned in this channel or not + title: Shadow banned + type: boolean + x-stream-index: "014" + status: type: string - x-stream-index: "002.001" - created_at: + x-stream-index: "008" + updated_at: + description: Date/time of the last update format: date-time + title: Updated at type: number - x-stream-index: "001.002" - type: - default: channel.unfrozen + x-stream-index: "010" + user: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "002" + user_id: + title: User ID type: string - x-stream-index: "001.001" + x-stream-index: "001" required: - - type + - custom - created_at - - cid - - channel_id - - channel_type - title: ChannelUnFrozenEvent + - updated_at + - banned + - shadow_banned + - channel_role + - notifications_muted + title: Channel member 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 - ChannelUnmutedEvent: + ChannelMessages: + nullable: true properties: - created_at: - format: date-time - type: number - x-stream-index: "001.002" - type: - default: channel.unmuted - type: string - x-stream-index: "001.001" + channel: + $ref: '#/components/schemas/ChannelResponse' + x-stream-index: "001" + messages: + items: + $ref: '#/components/schemas/Message' + type: array + x-stream-index: "002" required: - - type - - created_at - title: ChannelUnmutedEvent + - messages 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 - ChannelUpdatedEvent: + ChannelMute: + nullable: true properties: channel: $ref: '#/components/schemas/ChannelResponse' - x-stream-index: "004.004" - channel_id: - type: string - x-stream-index: "004.002" - channel_member_count: - format: int32 - type: integer - x-stream-index: "004.005" - channel_type: - type: string - x-stream-index: "004.003" - cid: - type: string - x-stream-index: "004.001" + description: Channel that is muted + title: Channel + x-stream-index: "002" created_at: + description: Date/time of creation format: date-time + title: Created at type: number - x-stream-index: "003.002" - message: - $ref: '#/components/schemas/Message' - x-stream-index: "001" - team: - type: string - x-stream-index: "002.001" - type: - default: channel.updated - type: string - x-stream-index: "003.001" + x-stream-index: "004" + expires: + description: Date/time of mute expiration + format: date-time + title: Expires + type: number + x-stream-index: "003" + updated_at: + description: Date/time of the last update + format: date-time + title: Updated at + type: number + x-stream-index: "005" user: - $ref: '#/components/schemas/User' - x-stream-index: "005.001" + $ref: '#/components/schemas/UserResponse' + description: Owner of channel mute + title: User + x-stream-index: "001" required: - - type - created_at - - cid - - channel_id - - channel_type - - channel_member_count - title: ChannelUpdatedEvent + - updated_at 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 - ChannelVisibleEvent: + ChannelMutedEvent: properties: - channel_id: - type: string - x-stream-index: "001.002" - channel_type: - type: string - x-stream-index: "001.003" - cid: - type: string - x-stream-index: "001.001" created_at: format: date-time type: number - x-stream-index: "003.002" + x-stream-index: "001.002" type: - default: channel.visible + default: channel.muted type: string - x-stream-index: "003.001" - user: - $ref: '#/components/schemas/User' - x-stream-index: "002.001" + x-stream-index: "001.001" required: - - cid - - channel_id - - channel_type - type - created_at - title: ChannelVisibleEvent + title: ChannelMutedEvent 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 - ChatActivityStatsResponse: - properties: - Messages: - $ref: '#/components/schemas/MessageStatsResponse' - x-stream-index: "001" - type: object - CheckExternalStorageResponse: - description: Basic response information - nullable: true + ChannelOwnCapability: + description: All possibility of string to use + enum: + - ban-channel-members + - cast-poll-vote + - connect-events + - create-attachment + - delete-any-message + - delete-channel + - delete-own-message + - flag-message + - freeze-channel + - join-channel + - leave-channel + - mute-channel + - pin-message + - query-poll-votes + - quote-message + - read-events + - search-messages + - send-custom-events + - send-links + - send-message + - send-poll + - send-reaction + - send-reply + - send-restricted-visibility-message + - send-typing-events + - set-channel-cooldown + - share-location + - skip-slow-mode + - slow-mode + - typing-events + - update-any-message + - update-channel + - update-channel-members + - update-own-message + - update-thread + - upload-file + title: ChannelOwnCapability + type: string + ChannelPushPreferences: properties: - duration: - description: Duration of the request in milliseconds - title: Duration - type: string - x-stream-index: "001.001" - file_url: + chat_level: type: string + x-stream-index: "001" + disabled_until: + format: date-time + type: number x-stream-index: "002" - required: - - duration - - file_url - title: Response type: object - CheckPushRequest: - description: Check push request - nullable: true + ChannelResponse: + description: Represents channel in chat properties: - apn_template: - description: Push message template for APN - title: APN template - type: string - x-stream-docs-page-id: push_template - x-stream-index: "002" - event_type: - description: 'Type of event for push templates (default: message.new)' - enum: - - message.new - - message.updated - - reaction.new - - reaction.updated - - notification.reminder_due - title: Event type - type: string - x-stream-index: "008" - firebase_data_template: - description: Push message data template for Firebase - title: Firebase data template - type: string - x-stream-docs-page-id: push_template - x-stream-index: "004" - firebase_template: - description: Push message template for Firebase - title: Firebase template - type: string - x-stream-docs-page-id: push_template - x-stream-index: "003" - message_id: - description: Message ID to send push notification for - title: Message ID - type: string - x-stream-index: "001" - push_provider_name: - description: Name of push provider - title: Name of push provider - type: string - x-stream-index: "007" - push_provider_type: - description: Push provider type - enum: - - firebase - - apn - - huawei - - xiaomi - title: Type of push provider + auto_translation_enabled: + description: Whether auto translation is enabled or not + title: Auto translation + type: boolean + x-stream-index: "017" + auto_translation_language: + description: Language to translate to when auto translation is active + title: Auto translation language type: string - x-stream-index: "006" - skip_devices: - description: Don't require existing devices to render templates - title: Skip devices + x-stream-index: "018" + blocked: + description: Whether this channel is blocked by current user or not + title: Blocked type: boolean - x-stream-index: "005" - user: - $ref: '#/components/schemas/UserRequest' - x-stream-index: "009.002" - user_id: - type: string - x-stream-index: "009.001" - title: CheckPushRequest - type: object - CheckPushResponse: - nullable: true - properties: - device_errors: - additionalProperties: - $ref: '#/components/schemas/DeviceErrorInfo' - description: Object with device errors - title: Device errors - type: object - x-stream-index: "001" - x-stream-map: - key: device_id - duration: - type: string - x-stream-index: "008.001" - event_type: - description: The event type that was tested - title: Event type - type: string - x-stream-index: "004" - general_errors: - description: List of general errors - items: - type: string - title: General errors - type: array - x-stream-index: "002" - rendered_apn_template: - title: Rendered APN template + x-stream-index: "023" + cid: + description: Channel CID (:) + title: CID type: string + x-stream-index: "003" + config: + $ref: '#/components/schemas/ChannelConfigWithInfo' + description: Channel configuration + title: ChannelConfigWithInfo + x-stream-index: "013" + cooldown: + description: Cooldown period after sending each message + format: int32 + title: Cooldown + type: integer + x-stream-index: "020" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number x-stream-index: "005" - rendered_firebase_template: - title: Rendered Firebase template - type: string - x-stream-index: "006" - rendered_message: - additionalProperties: - type: string - title: Rendered message + created_by: + $ref: '#/components/schemas/UserResponse' + description: Creator of the channel + title: UserResponse + x-stream-index: "008" + custom: + additionalProperties: {} + description: Custom data for this object + title: Custom data type: object + x-stream-index: "026" + deleted_at: + description: Date/time of deletion + format: date-time + title: Deleted at + type: number x-stream-index: "007" - skip_devices: - description: Don't require existing devices to render templates - title: Skip devices + disabled: type: boolean - x-stream-index: "003" - required: - - duration - type: object - CheckRequest: - nullable: true - properties: - config_key: - description: Key of the moderation configuration to use - title: Config Key - type: string - x-stream-index: "005" - config_team: - description: Team associated with the configuration - title: Config Team - type: string - x-stream-index: "006" - entity_creator_id: - description: ID of the user who created the entity - title: Entity Creator ID - type: string - x-stream-index: "003" - entity_id: - description: Unique identifier of the entity to moderate - title: Entity ID - type: string - x-stream-index: "002" - entity_type: - description: Type of entity to moderate - title: Entity Type + x-stream-index: "010" + frozen: + description: Whether channel is frozen or not + title: Frozen + type: boolean + x-stream-index: "009" + hidden: + description: Whether this channel is hidden by current user or not + title: Hidden + type: boolean + x-stream-index: "022" + hide_messages_before: + description: Date since when the message history is accessible + format: date-time + title: Hide messages before + type: number + x-stream-index: "019" + id: + description: Channel unique ID + title: ID type: string x-stream-index: "001" - moderation_payload: - $ref: '#/components/schemas/ModerationPayload' - description: Content to be moderated - title: Moderation Payload + last_message_at: + description: Date of the last message sent + format: date-time + title: Last message at + type: number x-stream-index: "004" - options: - additionalProperties: {} - description: Additional moderation configuration options - title: Options - type: object - x-stream-index: "007" - test_mode: - description: Whether to run moderation in test mode - title: Test Mode + member_count: + description: Number of members in the channel + format: int32 + title: Member count + type: integer + x-stream-index: "012" + members: + description: List of channel members (max 100) + items: + $ref: '#/components/schemas/ChannelMember' + title: ChannelMembers + type: array + x-stream-index: "011" + message_count: + description: Number of messages in the channel + format: int64 + title: Message count + type: integer + x-stream-index: "027" + mute_expires_at: + description: Date of mute expiration + format: date-time + title: Mute expires at + type: number + x-stream-index: "015" + muted: + description: Whether this channel is muted or not + title: Muted type: boolean - x-stream-index: "008" - user: - $ref: '#/components/schemas/UserRequest' - x-stream-index: "009.002" - user_id: + x-stream-index: "014" + own_capabilities: + description: List of channel capabilities of authenticated user + items: + $ref: '#/components/schemas/ChannelOwnCapability' + title: ChannelOwnCapability + type: array + x-stream-index: "021" + team: + description: Team the channel belongs to (multi-tenant only) + title: Team type: string - x-stream-index: "009.001" + x-stream-index: "016" + truncated_at: + description: Date of the latest truncation of the channel + format: date-time + title: UserResponse + type: number + x-stream-index: "024" + truncated_by: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "025" + type: + description: Type of the channel + title: Type + type: string + x-stream-docs-page-id: channel_features + x-stream-index: "002" + updated_at: + description: Date/time of the last update + format: date-time + title: Updated at + type: number + x-stream-index: "006" required: - - entity_type - - entity_id - - entity_creator_id - - config_key + - id + - type + - cid + - created_at + - updated_at + - frozen + - disabled + - custom + title: Channel type: object - CheckResponse: + ChannelStateResponse: nullable: true properties: + active_live_locations: + items: + $ref: '#/components/schemas/SharedLocationResponseData' + type: array + x-stream-index: "001.015" + channel: + $ref: '#/components/schemas/ChannelResponse' + x-stream-index: "001.001" + deleted_messages: + items: + type: string + type: array + x-stream-index: "001.016" + draft: + $ref: '#/components/schemas/DraftResponse' + x-stream-index: "001.014" duration: type: string - x-stream-index: "005.001" - item: - $ref: '#/components/schemas/ReviewQueueItemResponse' - description: Review queue item (present if action != keep) - title: Item - x-stream-index: "004" - recommended_action: - description: Suggested action based on moderation results - title: Recommended Action - type: string - x-stream-index: "003" - status: - description: Status of the moderation check (completed or pending) - title: Status - type: string - x-stream-index: "001" - task_id: - description: ID of the running moderation task - title: Task ID - type: string - x-stream-index: "002" + x-stream-index: "002.001" + hidden: + type: boolean + x-stream-index: "001.011" + hide_messages_before: + format: date-time + type: number + x-stream-index: "001.012" + members: + items: + $ref: '#/components/schemas/ChannelMember' + type: array + x-stream-index: "001.007" + membership: + $ref: '#/components/schemas/ChannelMember' + x-stream-index: "001.008" + messages: + items: + $ref: '#/components/schemas/MessageResponse' + type: array + x-stream-index: "001.002" + pending_messages: + items: + $ref: '#/components/schemas/PendingMessageResponse' + type: array + x-stream-index: "001.013" + pinned_messages: + items: + $ref: '#/components/schemas/MessageResponse' + type: array + x-stream-index: "001.003" + push_preferences: + $ref: '#/components/schemas/ChannelPushPreferences' + x-stream-index: "001.009" + read: + items: + $ref: '#/components/schemas/ReadStateResponse' + type: array + x-stream-index: "001.006" + threads: + items: + $ref: '#/components/schemas/ThreadStateResponse' + type: array + x-stream-index: "001.010" + watcher_count: + format: int32 + type: integer + x-stream-index: "001.004" + watchers: + items: + $ref: '#/components/schemas/UserResponse' + type: array + x-stream-index: "001.005" required: - - status - - recommended_action + - messages + - pinned_messages + - members + - threads - duration type: object - CheckSNSRequest: - nullable: true + ChannelStateResponseFields: properties: - sns_key: - description: AWS SNS access key - title: SNS key - type: string + active_live_locations: + description: Active live locations in the channel + items: + $ref: '#/components/schemas/SharedLocationResponseData' + title: Active Live Locations + type: array + x-stream-index: "015" + channel: + $ref: '#/components/schemas/ChannelResponse' + x-stream-index: "001" + deleted_messages: + items: + type: string + type: array + x-stream-index: "016" + draft: + $ref: '#/components/schemas/DraftResponse' + x-stream-index: "014" + hidden: + description: Whether this channel is hidden or not + title: Hidden + type: boolean + x-stream-index: "011" + hide_messages_before: + description: Messages before this date are hidden from the user + format: date-time + title: Hide messages before + type: number + x-stream-index: "012" + members: + description: List of channel members + items: + $ref: '#/components/schemas/ChannelMember' + title: Members + type: array + x-stream-index: "007" + membership: + $ref: '#/components/schemas/ChannelMember' + description: Current user membership object + title: Membership + x-stream-index: "008" + messages: + description: List of channel messages + items: + $ref: '#/components/schemas/MessageResponse' + title: Message + type: array x-stream-index: "002" - sns_secret: - description: AWS SNS key secret - title: SNS secret - type: string + pending_messages: + description: Pending messages that this user has sent + items: + $ref: '#/components/schemas/PendingMessageResponse' + title: Pending messages + type: array + x-stream-index: "013" + pinned_messages: + description: List of pinned messages in the channel + items: + $ref: '#/components/schemas/MessageResponse' + title: Pinned messages + type: array + x-stream-docs-page-id: pinned_messages x-stream-index: "003" - sns_topic_arn: - description: AWS SNS topic ARN - title: SNS Topic ARN - type: string - x-stream-index: "001" + push_preferences: + $ref: '#/components/schemas/ChannelPushPreferences' + x-stream-index: "009" + read: + description: List of read states + items: + $ref: '#/components/schemas/ReadStateResponse' + title: Read + type: array + x-stream-index: "006" + threads: + items: + $ref: '#/components/schemas/ThreadStateResponse' + type: array + x-stream-index: "010" + watcher_count: + description: Number of channel watchers + format: int32 + title: Watcher count + type: integer + x-stream-index: "004" + watchers: + description: List of user who is watching the channel + items: + $ref: '#/components/schemas/UserResponse' + title: Watchers + type: array + x-stream-index: "005" + required: + - messages + - pinned_messages + - members + - threads type: object - CheckSNSResponse: - nullable: true + ChannelTruncatedEvent: properties: - data: - additionalProperties: {} - description: Error data - title: ReadOnlyData - type: object - x-stream-index: "003" - duration: + channel: + $ref: '#/components/schemas/ChannelResponse' + x-stream-index: "001.004" + channel_id: type: string - x-stream-index: "004.001" - error: - description: Error text - title: Error + x-stream-index: "001.002" + channel_member_count: + format: int32 + type: integer + x-stream-index: "001.005" + channel_type: type: string - x-stream-index: "002" - status: - description: Validation result - enum: - - ok - - error - title: Status + x-stream-index: "001.003" + cid: type: string - x-stream-index: "001" + x-stream-index: "001.001" + created_at: + format: date-time + type: number + x-stream-index: "002.002" + type: + default: channel.truncated + type: string + x-stream-index: "002.001" required: - - status - - duration + - cid + - channel_id + - channel_type + - channel_member_count + - type + - created_at + title: ChannelTruncatedEvent type: object - CheckSQSRequest: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + ChannelTypeConfig: nullable: true properties: - sqs_key: - description: AWS SQS access key - title: SQS key + allowed_flag_reasons: + items: + type: string + type: array + x-stream-index: 003.002.027 + automod: + enum: + - disabled + - simple + - AI type: string - x-stream-index: "002" - sqs_secret: - description: AWS SQS key secret - title: SQS secret + x-stream-index: 003.002.022 + automod_behavior: + enum: + - flag + - block + - shadow_block type: string - x-stream-index: "003" - sqs_url: - description: AWS SQS endpoint URL - title: SQS URL + x-stream-index: 003.002.023 + automod_thresholds: + $ref: '#/components/schemas/Thresholds' + x-stream-index: 003.002.028 + blocklist: type: string - x-stream-index: "001" - type: object - CheckSQSResponse: - nullable: true - properties: - data: - additionalProperties: {} - description: Error data - title: ReadOnlyData - type: object - x-stream-index: "003" - duration: - type: string - x-stream-index: "004.001" - error: - description: Error text - title: Error + x-stream-index: 003.002.024 + blocklist_behavior: + enum: + - flag + - block + - shadow_block type: string + x-stream-index: 003.002.025 + blocklists: + items: + $ref: '#/components/schemas/BlockListOptions' + type: array + x-stream-index: 003.002.026 + commands: + items: + $ref: '#/components/schemas/Command' + type: array + x-stream-index: "003.003" + connect_events: + type: boolean + x-stream-index: 003.002.004 + count_messages: + type: boolean + x-stream-index: 003.002.019 + created_at: + format: date-time + type: number + x-stream-index: 003.001.003 + custom_events: + type: boolean + x-stream-index: 003.002.012 + grants: + additionalProperties: + items: + type: string + type: array + type: object x-stream-index: "002" - status: - description: Validation result - enum: - - ok - - error - title: Status + mark_messages_pending: + type: boolean + x-stream-index: 003.002.015 + max_message_length: + format: int32 + maximum: 20000 + type: integer + x-stream-index: 003.002.021 + mutes: + type: boolean + x-stream-index: 003.002.009 + name: + type: string + x-stream-index: 003.002.001 + partition_size: + format: int32 + type: integer + x-stream-index: 003.002.029 + partition_ttl: + example: 24h + format: duration + nullable: true type: string + x-stream-index: 003.002.030 + permissions: + items: + $ref: '#/components/schemas/PolicyRequest' + type: array x-stream-index: "001" + polls: + type: boolean + x-stream-index: 003.002.016 + push_notifications: + type: boolean + x-stream-index: 003.002.013 + quotes: + type: boolean + x-stream-index: 003.002.008 + reactions: + type: boolean + x-stream-index: 003.002.006 + read_events: + type: boolean + x-stream-index: 003.002.003 + reminders: + type: boolean + x-stream-index: 003.002.014 + replies: + type: boolean + x-stream-index: 003.002.007 + search: + type: boolean + x-stream-index: 003.002.005 + shared_locations: + type: boolean + x-stream-index: 003.002.018 + skip_last_msg_update_for_system_msgs: + type: boolean + x-stream-index: 003.002.031 + typing_events: + type: boolean + x-stream-index: 003.002.002 + updated_at: + format: date-time + type: number + x-stream-index: 003.001.004 + uploads: + type: boolean + x-stream-index: 003.002.010 + url_enrichment: + type: boolean + x-stream-index: 003.002.011 + user_message_reminders: + type: boolean + x-stream-index: 003.002.017 required: - - status - - duration + - permissions + - grants + - created_at + - updated_at + - name + - typing_events + - read_events + - connect_events + - search + - reactions + - replies + - quotes + - mutes + - uploads + - url_enrichment + - custom_events + - push_notifications + - reminders + - mark_messages_pending + - polls + - user_message_reminders + - shared_locations + - count_messages + - message_retention + - max_message_length + - automod + - automod_behavior + - skip_last_msg_update_for_system_msgs + - commands type: object - ClientOSDataResponse: + ChannelUnFrozenEvent: properties: - architecture: + channel_id: type: string - x-stream-index: "003" - name: + x-stream-index: "002.002" + channel_type: type: string - x-stream-index: "001" - version: + x-stream-index: "002.003" + cid: type: string - x-stream-index: "002" + x-stream-index: "002.001" + created_at: + format: date-time + type: number + x-stream-index: "001.002" + type: + default: channel.unfrozen + type: string + x-stream-index: "001.001" + required: + - type + - created_at + - cid + - channel_id + - channel_type + title: ChannelUnFrozenEvent type: object - ClosedCaptionEvent: - description: This event is sent when closed captions are being sent in a call, - clients should use this to show the closed captions in the call screen + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + ChannelUnmutedEvent: properties: - call_cid: - type: string - x-stream-index: "002.001" - closed_caption: - $ref: '#/components/schemas/CallClosedCaption' - description: The closed caption object - title: CallClosedCaption - x-stream-index: "003" created_at: format: date-time type: number x-stream-index: "001.002" type: - default: call.closed_caption - description: 'The type of event: "call.closed_caption" in this case' - title: Event Type + default: channel.unmuted type: string x-stream-index: "001.001" required: - type - created_at - - call_cid - - closed_caption - title: ClosedCaptionEvent + title: ChannelUnmutedEvent type: object - x-stream-event-call-type: true - x-stream-event-doc-group: transcription + x-stream-event-client-type: true + x-stream-event-doc-group: other x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CollectUserFeedbackRequest: - nullable: true + ChannelUpdatedEvent: properties: - custom: - additionalProperties: {} - type: object - x-stream-index: "009" - rating: + channel: + $ref: '#/components/schemas/ChannelResponse' + x-stream-index: "004.004" + channel_id: + type: string + x-stream-index: "004.002" + channel_member_count: format: int32 - maximum: 5 - minimum: 1 type: integer - x-stream-index: "007" - reason: - maxLength: 1000 + x-stream-index: "004.005" + channel_type: type: string - x-stream-index: "008" - sdk: - maxLength: 50 + x-stream-index: "004.003" + cid: type: string - x-stream-index: "005" - sdk_version: - maxLength: 50 + x-stream-index: "004.001" + created_at: + format: date-time + type: number + x-stream-index: "003.002" + message: + $ref: '#/components/schemas/Message' + x-stream-index: "001" + team: type: string - x-stream-index: "006" - user_session_id: - maxLength: 50 + x-stream-index: "002.001" + type: + default: channel.updated type: string - x-stream-index: "004" + x-stream-index: "003.001" + user: + $ref: '#/components/schemas/User' + x-stream-index: "005.001" required: - - sdk - - sdk_version - - rating + - type + - created_at + - cid + - channel_id + - channel_type + - channel_member_count + title: ChannelUpdatedEvent type: object - CollectUserFeedbackResponse: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + ChannelVisibleEvent: + properties: + channel_id: + type: string + x-stream-index: "001.002" + channel_type: + type: string + x-stream-index: "001.003" + cid: + type: string + x-stream-index: "001.001" + created_at: + format: date-time + type: number + x-stream-index: "003.002" + type: + default: channel.visible + type: string + x-stream-index: "003.001" + user: + $ref: '#/components/schemas/User' + x-stream-index: "002.001" + required: + - cid + - channel_id + - channel_type + - type + - created_at + title: ChannelVisibleEvent + 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 + ChatActivityStatsResponse: + properties: + Messages: + $ref: '#/components/schemas/MessageStatsResponse' + x-stream-index: "001" + type: object + CheckExternalStorageResponse: description: Basic response information nullable: true properties: @@ -7269,1098 +8870,1758 @@ components: title: Duration type: string x-stream-index: "001.001" + file_url: + type: string + x-stream-index: "002" required: - duration + - file_url title: Response type: object - Command: - description: Represents custom chat command + CheckPushRequest: + description: Check push request nullable: true properties: - args: - description: Arguments help text, shown in commands auto-completion - title: Arguments + apn_template: + description: Push message template for APN + title: APN template type: string - x-stream-index: "006" - created_at: - description: Date/time of creation - format: date-time - readOnly: true - title: Created at - type: number - x-stream-index: "001" - description: - description: Description, shown in commands auto-completion - title: Description + x-stream-docs-page-id: push_template + x-stream-index: "002" + event_type: + description: 'Type of event for push templates (default: message.new)' + enum: + - message.new + - message.updated + - reaction.new + - reaction.updated + - notification.reminder_due + title: Event type type: string - x-stream-index: "005" - name: - description: Unique command name - title: Name + x-stream-index: "008" + firebase_data_template: + description: Push message data template for Firebase + title: Firebase data template type: string + x-stream-docs-page-id: push_template x-stream-index: "004" - set: - description: Set name used for grouping commands - title: Set + firebase_template: + description: Push message template for Firebase + title: Firebase template + type: string + x-stream-docs-page-id: push_template + x-stream-index: "003" + message_id: + description: Message ID to send push notification for + title: Message ID + type: string + x-stream-index: "001" + push_provider_name: + description: Name of push provider + title: Name of push provider type: string x-stream-index: "007" - updated_at: - description: Date/time of the last update - format: date-time - readOnly: true - title: Updated at - type: number - x-stream-index: "002" - required: - - name - - description - - args - - set - title: Command - type: object - CommitMessageRequest: - nullable: true - type: object - CompositeAppSettings: - properties: - json_encoded_settings: + push_provider_type: + description: Push provider type + enum: + - firebase + - apn + - huawei + - xiaomi + title: Type of push provider type: string + x-stream-index: "006" + skip_devices: + description: Don't require existing devices to render templates + title: Skip devices + type: boolean x-stream-index: "005" - url: + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "009.002" + user_id: type: string - x-stream-index: "004" + x-stream-index: "009.001" + title: CheckPushRequest type: object - ConfigOverrides: + CheckPushResponse: + nullable: true properties: - blocklist: + device_errors: + additionalProperties: + $ref: '#/components/schemas/DeviceErrorInfo' + description: Object with device errors + title: Device errors + type: object + x-stream-index: "001" + x-stream-map: + key: device_id + duration: type: string - x-stream-index: "008" - blocklist_behavior: - enum: - - flag - - block + x-stream-index: "008.001" + event_type: + description: The event type that was tested + title: Event type type: string - x-stream-index: "009" - commands: + x-stream-index: "004" + general_errors: + description: List of general errors items: type: string + title: General errors type: array - x-stream-index: "011" - grants: + x-stream-index: "002" + rendered_apn_template: + title: Rendered APN template + type: string + x-stream-index: "005" + rendered_firebase_template: + title: Rendered Firebase template + type: string + x-stream-index: "006" + rendered_message: additionalProperties: - items: - type: string - type: array + type: string + title: Rendered message type: object - x-stream-index: "010" - max_message_length: - format: int32 - maximum: 20000 - type: integer x-stream-index: "007" - quotes: - type: boolean - x-stream-index: "004" - reactions: - type: boolean - x-stream-index: "002" - replies: + skip_devices: + description: Don't require existing devices to render templates + title: Skip devices type: boolean x-stream-index: "003" - shared_locations: - type: boolean - x-stream-index: "013" - typing_events: - type: boolean - x-stream-index: "001" - uploads: - type: boolean - x-stream-index: "005" - url_enrichment: - type: boolean - x-stream-index: "006" - user_message_reminders: - type: boolean - x-stream-index: "012" required: - - grants - - commands + - duration type: object - ConfigResponse: + CheckRequest: + nullable: true properties: - ai_image_config: - $ref: '#/components/schemas/AIImageConfig' - description: Configuration for AI image analysis - title: AI Image Config - x-stream-index: "009" - ai_text_config: - $ref: '#/components/schemas/AITextConfig' - description: Configuration for AI text analysis - title: AI Text Config - x-stream-index: "008" - ai_video_config: - $ref: '#/components/schemas/AIVideoConfig' - description: Configuration for AI video analysis - title: AI Video Config - x-stream-index: "010" - async: - description: Whether moderation should be performed asynchronously - title: Async - type: boolean - x-stream-index: "003" - automod_platform_circumvention_config: - $ref: '#/components/schemas/AutomodPlatformCircumventionConfig' - description: Configuration for platform circumvention detection - title: Automod Platform Circumvention Config + config_key: + description: Key of the moderation configuration to use + title: Config Key + type: string x-stream-index: "005" - automod_semantic_filters_config: - $ref: '#/components/schemas/AutomodSemanticFiltersConfig' - description: Configuration for semantic filtering - title: Automod Semantic Filters Config + config_team: + description: Team associated with the configuration + title: Config Team + type: string x-stream-index: "006" - automod_toxicity_config: - $ref: '#/components/schemas/AutomodToxicityConfig' - description: Configuration for toxicity detection - title: Automod Toxicity Config + entity_creator_id: + description: ID of the user who created the entity + title: Entity Creator ID + type: string + x-stream-index: "003" + entity_id: + description: Unique identifier of the entity to moderate + title: Entity ID + type: string + x-stream-index: "002" + entity_type: + description: Type of entity to moderate + title: Entity Type + type: string + x-stream-index: "001" + moderation_payload: + $ref: '#/components/schemas/ModerationPayload' + description: Content to be moderated + title: Moderation Payload x-stream-index: "004" - block_list_config: - $ref: '#/components/schemas/BlockListConfig' - description: Configuration for block list filtering - title: Block List Config + options: + additionalProperties: {} + description: Additional moderation configuration options + title: Options + type: object x-stream-index: "007" - created_at: - description: When the configuration was created - format: date-time - title: Created At - type: number - x-stream-index: "012" - key: - description: Unique identifier for the moderation configuration - title: Key + test_mode: + description: Whether to run moderation in test mode + title: Test Mode + type: boolean + x-stream-index: "008" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "009.002" + user_id: + type: string + x-stream-index: "009.001" + required: + - entity_type + - entity_id + - entity_creator_id + type: object + CheckResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "005.001" + item: + $ref: '#/components/schemas/ReviewQueueItemResponse' + description: Review queue item (present if action != keep) + title: Item + x-stream-index: "004" + recommended_action: + description: Suggested action based on moderation results + title: Recommended Action + type: string + x-stream-index: "003" + status: + description: Status of the moderation check (completed or pending) + title: Status type: string x-stream-index: "001" - rule_builder_config: - $ref: '#/components/schemas/RuleBuilderConfig' - x-stream-index: "015" - team: - description: Team associated with the configuration - title: Team + task_id: + description: ID of the running moderation task + title: Task ID type: string x-stream-index: "002" - updated_at: - description: When the configuration was last updated - format: date-time - title: Updated At - type: number - x-stream-index: "013" - velocity_filter_config: - $ref: '#/components/schemas/VelocityFilterConfig' - description: Configuration for velocity-based filtering - title: Velocity Filter Config - x-stream-index: "011" - video_call_rule_config: - $ref: '#/components/schemas/VideoCallRuleConfig' - x-stream-index: "014" required: - - key - - team - - async - - created_at - - updated_at + - status + - recommended_action + - duration type: object - ContentCountRuleParameters: + CheckSNSRequest: + nullable: true properties: - threshold: - format: int32 - type: integer + sns_key: + description: AWS SNS access key + title: SNS key + type: string + x-stream-index: "002" + sns_secret: + description: AWS SNS key secret + title: SNS secret + type: string + x-stream-index: "003" + sns_topic_arn: + description: AWS SNS topic ARN + title: SNS Topic ARN + type: string x-stream-index: "001" - time_window: + type: object + CheckSNSResponse: + nullable: true + properties: + data: + additionalProperties: {} + description: Error data + title: ReadOnlyData + type: object + x-stream-index: "003" + duration: + type: string + x-stream-index: "004.001" + error: + description: Error text + title: Error type: string x-stream-index: "002" + status: + description: Validation result + enum: + - ok + - error + title: Status + type: string + x-stream-index: "001" required: - - threshold - - time_window + - status + - duration type: object - CountByMinuteResponse: + CheckSQSRequest: nullable: true properties: - count: - format: int32 - type: integer + sqs_key: + description: AWS SQS access key + title: SQS key + type: string x-stream-index: "002" - start_ts: - format: date-time - type: number + sqs_secret: + description: AWS SQS key secret + title: SQS secret + type: string + x-stream-index: "003" + sqs_url: + description: AWS SQS endpoint URL + title: SQS URL + type: string x-stream-index: "001" - required: - - start_ts - - count type: object - CreateBlockListRequest: - description: Block list contains restricted words + CheckSQSResponse: nullable: true properties: + data: + additionalProperties: {} + description: Error data + title: ReadOnlyData + type: object + x-stream-index: "003" + duration: + type: string + x-stream-index: "004.001" + error: + description: Error text + title: Error + type: string + x-stream-index: "002" + status: + description: Validation result + enum: + - ok + - error + title: Status + type: string + x-stream-index: "001" + required: + - status + - duration + type: object + ClientOSDataResponse: + properties: + architecture: + type: string + x-stream-index: "003" name: - description: Block list name - maxLength: 255 - title: Name type: string x-stream-index: "001" - team: + version: type: string - x-stream-index: "004" - type: - description: Block list type. - enum: - - regex - - domain - - domain_allowlist - - email - - word - title: Type + x-stream-index: "002" + type: object + ClosedCaptionEvent: + description: This event is sent when closed captions are being sent in a call, + clients should use this to show the closed captions in the call screen + properties: + call_cid: type: string + x-stream-index: "002.001" + closed_caption: + $ref: '#/components/schemas/CallClosedCaption' + description: The closed caption object + title: CallClosedCaption x-stream-index: "003" - words: - description: List of words to block - items: - type: string + created_at: + format: date-time + type: number + x-stream-index: "001.002" + type: + default: call.closed_caption + description: 'The type of event: "call.closed_caption" in this case' + title: Event Type + type: string + x-stream-index: "001.001" + required: + - type + - created_at + - call_cid + - closed_caption + title: ClosedCaptionEvent + type: object + x-stream-event-call-type: true + x-stream-event-doc-group: transcription + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + CollectUserFeedbackRequest: + nullable: true + properties: + custom: + additionalProperties: {} + type: object + x-stream-index: "009" + rating: + format: int32 + maximum: 5 minimum: 1 - title: Words - type: array - x-stream-index: "002" + type: integer + x-stream-index: "007" + reason: + maxLength: 1000 + type: string + x-stream-index: "008" + sdk: + maxLength: 50 + type: string + x-stream-index: "005" + sdk_version: + maxLength: 50 + type: string + x-stream-index: "006" + user_session_id: + maxLength: 50 + type: string + x-stream-index: "004" required: - - name - - words - title: Block list + - sdk + - sdk_version + - rating type: object - x-stream-docs-page-id: block_lists - CreateBlockListResponse: + CollectUserFeedbackResponse: description: Basic response information nullable: true properties: - blocklist: - $ref: '#/components/schemas/BlockListResponse' - x-stream-index: "001" duration: description: Duration of the request in milliseconds title: Duration type: string - x-stream-index: "002.001" + x-stream-index: "001.001" required: - duration title: Response type: object - CreateCallTypeRequest: - description: Request for creating a call type + Command: + description: Represents custom chat command nullable: true properties: - external_storage: - description: the external storage for the call type - title: ExternalStorage + args: + description: Arguments help text, shown in commands auto-completion + title: Arguments type: string - x-stream-index: "002.004" - grants: - additionalProperties: - items: - type: string - type: array - description: the permissions granted to each role - title: Grants - type: object - x-stream-index: "002.001" + x-stream-index: "006" + created_at: + description: Date/time of creation + format: date-time + readOnly: true + title: Created at + type: number + x-stream-index: "001" + description: + description: Description, shown in commands auto-completion + title: Description + type: string + x-stream-index: "005" name: + description: Unique command name + title: Name type: string - x-stream-index: "001" - notification_settings: - $ref: '#/components/schemas/NotificationSettings' - description: the notification settings for the call type - title: NotificationSettings - x-stream-index: "002.002" - settings: - $ref: '#/components/schemas/CallSettingsRequest' - description: the settings for the call type - title: Settings - x-stream-index: "002.003" + x-stream-index: "004" + set: + description: Set name used for grouping commands + title: Set + type: string + x-stream-index: "007" + updated_at: + description: Date/time of the last update + format: date-time + readOnly: true + title: Updated at + type: number + x-stream-index: "002" required: - name - title: CreateCallTypeRequest + - description + - args + - set + title: Command type: object - CreateCallTypeResponse: - description: Response for creating a call type + CommentAddedEvent: + description: Emitted when a comment is added to an activity. nullable: true properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + x-stream-index: "002" + comment: + $ref: '#/components/schemas/CommentResponse' + description: The comment that was added + title: Text + x-stream-index: "001" created_at: - description: the time the call type was created + description: Date/time of creation format: date-time - title: CreatedAt + title: Created at type: number - x-stream-index: "001.005" - duration: - type: string - x-stream-index: "002.001" - external_storage: - description: the external storage for the call type - title: ExternalStorage - type: string - x-stream-index: "001.007" - grants: - additionalProperties: - items: - type: string - type: array - description: the permissions granted to each role - title: Grants + x-stream-index: 003.001.003 + custom: + additionalProperties: {} type: object - x-stream-index: "001.002" - name: - description: the name of the call type - title: Name + x-stream-index: 003.001.007 + feed_visibility: type: string - x-stream-index: "001.001" - notification_settings: - $ref: '#/components/schemas/NotificationSettings' - description: the notification settings for the call type - title: NotificationSettings - x-stream-index: "001.004" - settings: - $ref: '#/components/schemas/CallSettingsResponse' - description: the settings for the call type - title: Settings - x-stream-index: "001.003" - updated_at: - description: the time the call type was last updated + x-stream-index: "003.003" + fid: + type: string + x-stream-index: "003.002" + received_at: format: date-time - title: UpdatedAt type: number - x-stream-index: "001.006" + x-stream-index: 003.001.004 + type: + default: feeds.comment.added + description: 'The type of event: "feeds.comment.added" in this case' + title: Event Type + type: string + x-stream-index: 003.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who added the comment + title: User + x-stream-index: "004.001" required: - - name - - grants - - settings - - notification_settings + - comment + - activity + - type - created_at - - updated_at - - duration - title: CreateCallTypeResponse + - custom + - fid + title: CommentAddedEvent type: object - CreateChannelTypeRequest: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + CommentDeletedEvent: + description: Emitted when a comment is deleted. nullable: true properties: - automod: - description: Automod - enum: - - disabled - - simple - - AI - title: Automod - type: string - x-stream-index: "019" - automod_behavior: - description: Automod behavior - enum: - - flag - - block - title: Automod behavior + comment: + $ref: '#/components/schemas/CommentResponse' + x-stream-index: "001" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + feed_visibility: type: string - x-stream-index: "020" - blocklist: - description: Blocklist - title: Blocklist + x-stream-index: "002.003" + fid: type: string - x-stream-index: "024" - blocklist_behavior: - description: Blocklist behavior - enum: - - flag - - block - - shadow_block - title: Blocklist behavior + x-stream-index: "002.002" + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 + type: + default: feeds.comment.deleted + description: 'The type of event: "feeds.comment.deleted" in this case' + title: Event Type type: string - x-stream-index: "025" - blocklists: - description: Blocklists - items: - $ref: '#/components/schemas/BlockListOptions' - title: Blocklists - type: array - x-stream-index: "026" - commands: - description: List of commands that channel supports + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who deleted the comment + title: User + x-stream-index: "003.001" + required: + - comment + - type + - created_at + - custom + - fid + title: CommentDeletedEvent + 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 + CommentReactionAddedEvent: + description: Emitted when a reaction is added to a comment. + nullable: true + properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + x-stream-index: "003" + comment: + $ref: '#/components/schemas/CommentResponse' + x-stream-index: "001" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 004.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 004.001.007 + feed_visibility: + type: string + x-stream-index: "004.003" + fid: + type: string + x-stream-index: "004.002" + reaction: + $ref: '#/components/schemas/FeedsReactionResponse' + description: The reaction that was added + title: Reaction + x-stream-index: "002" + received_at: + format: date-time + type: number + x-stream-index: 004.001.004 + type: + default: feeds.comment.reaction.added + description: 'The type of event: "feeds.comment.reaction.added" in this + case' + title: Event Type + type: string + x-stream-index: 004.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who added the reaction + title: User + x-stream-index: "005.001" + required: + - comment + - reaction + - activity + - type + - created_at + - custom + - fid + title: CommentReactionAddedEvent + 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 + CommentReactionDeletedEvent: + description: Emitted when a reaction is deleted from a comment. + nullable: true + properties: + comment: + $ref: '#/components/schemas/CommentResponse' + x-stream-index: "001" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 003.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 003.001.007 + feed_visibility: + type: string + x-stream-index: "003.003" + fid: + type: string + x-stream-index: "003.002" + reaction: + $ref: '#/components/schemas/FeedsReactionResponse' + x-stream-index: "002" + received_at: + format: date-time + type: number + x-stream-index: 003.001.004 + type: + default: feeds.comment.reaction.deleted + description: The type of reaction that was removed + title: Type + type: string + x-stream-index: 003.001.002 + required: + - comment + - reaction + - type + - created_at + - custom + - fid + title: CommentReactionDeletedEvent + 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 + CommentReactionUpdatedEvent: + description: Emitted when a reaction is updated on a comment. + nullable: true + properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + x-stream-index: "003" + comment: + $ref: '#/components/schemas/CommentResponse' + x-stream-index: "001" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 004.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 004.001.007 + feed_visibility: + type: string + x-stream-index: "004.003" + fid: + type: string + x-stream-index: "004.002" + reaction: + $ref: '#/components/schemas/FeedsReactionResponse' + description: The reaction that was updated + title: Reaction + x-stream-index: "002" + received_at: + format: date-time + type: number + x-stream-index: 004.001.004 + type: + default: feeds.comment.reaction.updated + description: 'The type of event: "feeds.comment.reaction.updated" in this + case' + title: Event Type + type: string + x-stream-index: 004.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who updated the reaction + title: User + x-stream-index: "005.001" + required: + - comment + - reaction + - activity + - type + - created_at + - custom + - fid + title: CommentReactionUpdatedEvent + 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 + CommentResponse: + properties: + attachments: items: - type: string - title: Commands + $ref: '#/components/schemas/Attachment' type: array - x-stream-index: "021" - connect_events: - description: Connect events - title: Connect events - type: boolean - x-stream-index: "004" - custom_events: - description: Custom events - title: Custom events - type: boolean x-stream-index: "011" - grants: - additionalProperties: - items: - type: string - type: array - description: List of grants for the channel type - title: Grants - type: object + confidence_score: + description: Confidence score of the comment + format: float + title: Confidence Score + type: number + x-stream-index: "022" + controversy_score: + description: Controversy score of the comment + format: float + title: Controversy Score + type: number x-stream-index: "023" - mark_messages_pending: - description: Mark messages pending - title: Mark messages pending - type: boolean - x-stream-index: "013" - max_message_length: - description: Max message length + created_at: + description: When the comment was created + format: date-time + title: Created At + type: number + x-stream-index: "014" + custom: + additionalProperties: {} + description: Custom data for the comment + title: Custom Data + type: object + x-stream-index: "006" + deleted_at: + description: When the comment was deleted + format: date-time + title: Deleted At + type: number + x-stream-index: "016" + downvote_count: + description: Number of downvotes for this comment format: int32 - title: Max message length + title: Downvote Count type: integer - x-stream-index: "018" - message_retention: - description: Message retention - enum: - - infinite - - numeric - title: Message retention - type: string - x-stream-index: "017" - mutes: - description: Mutes - title: Mutes - type: boolean - x-stream-index: "008" - name: - description: Channel type name - title: Name + x-stream-index: "020" + id: + description: Unique identifier for the comment + title: ID type: string x-stream-index: "001" - partition_size: - description: Partition size - format: int32 - minimum: 10 - title: Partition size - type: integer - x-stream-index: "027" - partition_ttl: - description: Partition TTL - example: 24h - format: duration - nullable: true - title: Partition TTL - type: string - x-stream-index: "028" - permissions: - description: List of permissions for the channel type + latest_reactions: + description: Recent reactions to the comment items: - $ref: '#/components/schemas/PolicyRequest' - title: Permissions + $ref: '#/components/schemas/FeedsReactionResponse' + title: Latest Reactions + type: array + x-stream-index: "009" + mentioned_users: + description: Users mentioned in the comment + items: + $ref: '#/components/schemas/UserResponse' + title: Mention Users type: array - x-stream-index: "022" - polls: - description: Polls - title: Polls - type: boolean - x-stream-index: "014" - push_notifications: - description: Push notifications - title: Push notifications - type: boolean x-stream-index: "012" - reactions: - description: Reactions - title: Reactions - type: boolean - x-stream-index: "005" - read_events: - description: Read events - title: Read events - type: boolean + moderation: + $ref: '#/components/schemas/ModerationV2Response' + x-stream-index: "017" + object_id: + description: ID of the object this comment is associated with + title: Object ID + type: string + x-stream-index: "002" + object_type: + description: Type of the object this comment is associated with + title: Object Type + type: string x-stream-index: "003" - replies: - description: Replies - title: Replies - type: boolean - x-stream-index: "006" - search: - description: Search - title: Search - type: boolean + own_reactions: + description: Current user's reactions to this activity + items: + $ref: '#/components/schemas/FeedsReactionResponse' + title: Own Reactions + type: array + x-stream-index: "024" + parent_id: + description: ID of parent comment for nested replies + title: Parent ID + type: string x-stream-index: "007" - shared_locations: - description: Enables shared location messages - title: Shared locations - type: boolean - x-stream-index: "016" - skip_last_msg_update_for_system_msgs: - type: boolean - x-stream-index: "029" - typing_events: - description: Typing events - title: Typing events - type: boolean - x-stream-index: "002" - uploads: - description: Uploads - title: Uploads - type: boolean - x-stream-index: "009" - url_enrichment: - description: URL enrichment - title: URL enrichment - type: boolean + reaction_count: + description: Number of reactions to this comment + format: int32 + title: Reaction Count + type: integer + x-stream-index: "008" + reaction_groups: + additionalProperties: + $ref: '#/components/schemas/ReactionGroupResponse' + description: Grouped reactions by type + title: Reaction Groups + type: object x-stream-index: "010" - user_message_reminders: - type: boolean + reply_count: + description: Number of replies to this comment + format: int32 + title: Reply Count + type: integer + x-stream-index: "018" + score: + description: Score of the comment based on reactions + format: int32 + title: Score + type: integer + x-stream-index: "021" + status: + description: Status of the comment (e.g., active, deleted) + title: Status + type: string + x-stream-index: "013" + text: + description: Text content of the comment + title: Text + type: string + x-stream-index: "005" + updated_at: + description: When the comment was last updated + format: date-time + title: Updated At + type: number x-stream-index: "015" + upvote_count: + description: Number of upvotes for this comment + format: int32 + title: Upvote Count + type: integer + x-stream-index: "019" + user: + $ref: '#/components/schemas/UserResponse' + description: User who created the comment + title: User + x-stream-index: "004" required: - - name - - max_message_length - - automod - - automod_behavior - title: CreateChannelTypeRequest + - id + - object_id + - object_type + - user + - reaction_count + - mentioned_users + - status + - created_at + - updated_at + - reply_count + - upvote_count + - downvote_count + - score + - confidence_score + - own_reactions + title: Comment type: object - CreateChannelTypeResponse: + CommentUpdatedEvent: + description: Emitted when a comment is updated. nullable: true properties: - allowed_flag_reasons: - items: - type: string - type: array - x-stream-index: 001.001.026 - automod: - enum: - - disabled - - simple - - AI + comment: + $ref: '#/components/schemas/CommentResponse' + description: The comment that was updated + title: Text + x-stream-index: "001" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + feed_visibility: type: string - x-stream-index: 001.001.021 - automod_behavior: - enum: - - flag - - block - - shadow_block + x-stream-index: "002.003" + fid: type: string - x-stream-index: 001.001.022 - automod_thresholds: - $ref: '#/components/schemas/Thresholds' - x-stream-index: 001.001.027 + x-stream-index: "002.002" + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 + type: + default: feeds.comment.updated + description: 'The type of event: "feeds.comment.updated" in this case' + title: Event Type + type: string + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who updated the comment + title: User + x-stream-index: "003.001" + required: + - comment + - type + - created_at + - custom + - fid + title: CommentUpdatedEvent + 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 + CommitMessageRequest: + nullable: true + type: object + CompositeAppSettings: + properties: + json_encoded_settings: + type: string + x-stream-index: "005" + url: + type: string + x-stream-index: "004" + type: object + ConfigOverrides: + properties: blocklist: type: string - x-stream-index: 001.001.023 + x-stream-index: "008" blocklist_behavior: enum: - flag - block - - shadow_block type: string - x-stream-index: 001.001.024 - blocklists: - items: - $ref: '#/components/schemas/BlockListOptions' - type: array - x-stream-index: 001.001.025 + x-stream-index: "009" commands: items: type: string type: array - x-stream-index: "001.003" - connect_events: - type: boolean - x-stream-index: 001.001.004 - created_at: - format: date-time - type: number - x-stream-index: 001.002.003 - custom_events: + x-stream-index: "011" + count_messages: type: boolean - x-stream-index: 001.001.012 - duration: - type: string - x-stream-index: "004.001" + x-stream-index: "014" grants: additionalProperties: items: type: string type: array type: object - x-stream-index: "003" - mark_messages_pending: - type: boolean - x-stream-index: 001.001.015 + x-stream-index: "010" max_message_length: format: int32 maximum: 20000 type: integer - x-stream-index: 001.001.020 - mutes: - type: boolean - x-stream-index: 001.001.009 - name: - type: string - x-stream-index: 001.001.001 - partition_size: - format: int32 - type: integer - x-stream-index: 001.001.028 - partition_ttl: - example: 24h - format: duration - nullable: true - type: string - x-stream-index: 001.001.029 - permissions: - items: - $ref: '#/components/schemas/PolicyRequest' - type: array - x-stream-index: "002" - polls: - type: boolean - x-stream-index: 001.001.016 - push_notifications: - type: boolean - x-stream-index: 001.001.013 + x-stream-index: "007" quotes: type: boolean - x-stream-index: 001.001.008 + x-stream-index: "004" reactions: type: boolean - x-stream-index: 001.001.006 - read_events: - type: boolean - x-stream-index: 001.001.003 - reminders: - type: boolean - x-stream-index: 001.001.014 + x-stream-index: "002" replies: type: boolean - x-stream-index: 001.001.007 - search: - type: boolean - x-stream-index: 001.001.005 + x-stream-index: "003" shared_locations: type: boolean - x-stream-index: 001.001.018 - skip_last_msg_update_for_system_msgs: - type: boolean - x-stream-index: 001.001.030 + x-stream-index: "013" typing_events: type: boolean - x-stream-index: 001.001.002 - updated_at: - format: date-time - type: number - x-stream-index: 001.002.004 + x-stream-index: "001" uploads: type: boolean - x-stream-index: 001.001.010 + x-stream-index: "005" url_enrichment: type: boolean - x-stream-index: 001.001.011 + x-stream-index: "006" user_message_reminders: type: boolean - x-stream-index: 001.001.017 + x-stream-index: "012" required: - - name - - typing_events - - read_events - - connect_events - - search - - reactions - - replies - - quotes - - mutes - - uploads - - url_enrichment - - custom_events - - push_notifications - - reminders - - mark_messages_pending - - polls - - user_message_reminders - - shared_locations - - message_retention - - max_message_length - - automod - - automod_behavior - - skip_last_msg_update_for_system_msgs - - created_at - - updated_at - - commands - - permissions - grants - - duration + - commands type: object - CreateCommandRequest: - description: Create a new command - nullable: true + ConfigResponse: properties: - args: - description: Arguments help text, shown in commands auto-completion - maxLength: 255 - title: Arguments - type: string + ai_image_config: + $ref: '#/components/schemas/AIImageConfig' + description: Configuration for AI image analysis + title: AI Image Config + x-stream-index: "010" + ai_text_config: + $ref: '#/components/schemas/AITextConfig' + description: Configuration for AI text analysis + title: AI Text Config + x-stream-index: "008" + ai_video_config: + $ref: '#/components/schemas/AIVideoConfig' + description: Configuration for AI video analysis + title: AI Video Config + x-stream-index: "011" + async: + description: Whether moderation should be performed asynchronously + title: Async + type: boolean x-stream-index: "003" - description: - description: Description, shown in commands auto-completion - maxLength: 255 - title: Description - type: string - x-stream-index: "002" - name: - description: Unique command name - maxLength: 255 - minLength: 1 - title: Name + automod_platform_circumvention_config: + $ref: '#/components/schemas/AutomodPlatformCircumventionConfig' + description: Configuration for platform circumvention detection + title: Automod Platform Circumvention Config + x-stream-index: "005" + automod_semantic_filters_config: + $ref: '#/components/schemas/AutomodSemanticFiltersConfig' + description: Configuration for semantic filtering + title: Automod Semantic Filters Config + x-stream-index: "006" + automod_toxicity_config: + $ref: '#/components/schemas/AutomodToxicityConfig' + description: Configuration for toxicity detection + title: Automod Toxicity Config + x-stream-index: "004" + block_list_config: + $ref: '#/components/schemas/BlockListConfig' + description: Configuration for block list filtering + title: Block List Config + x-stream-index: "007" + created_at: + description: When the configuration was created + format: date-time + title: Created At + type: number + x-stream-index: "013" + key: + description: Unique identifier for the moderation configuration + title: Key type: string x-stream-index: "001" - set: - description: Set name used for grouping commands - maxLength: 255 - title: Set + llm_config: + $ref: '#/components/schemas/LLMConfig' + description: Configuration for customer-configured LLM moderation + title: LLM Config + x-stream-index: "009" + team: + description: Team associated with the configuration + title: Team type: string - x-stream-index: "004" + x-stream-index: "002" + updated_at: + description: When the configuration was last updated + format: date-time + title: Updated At + type: number + x-stream-index: "014" + velocity_filter_config: + $ref: '#/components/schemas/VelocityFilterConfig' + description: Configuration for velocity-based filtering + title: Velocity Filter Config + x-stream-index: "012" + video_call_rule_config: + $ref: '#/components/schemas/VideoCallRuleConfig' + x-stream-index: "015" required: - - name - - description - title: CreateCommandRequest + - key + - team + - async + - created_at + - updated_at type: object - CreateCommandResponse: - nullable: true + ContentCountRuleParameters: properties: - command: - $ref: '#/components/schemas/Command' - description: Command object - title: Command + threshold: + format: int32 + type: integer x-stream-index: "001" - duration: + time_window: type: string - x-stream-index: "002.001" - required: - - duration - title: CreateCommandResponse + x-stream-index: "002" type: object - CreateDeviceRequest: - description: Create device request + CountByMinuteResponse: nullable: true properties: - id: - description: Device ID - maxLength: 255 - minLength: 1 - title: ID - type: string - x-stream-index: "001" - push_provider: - description: Push provider - enum: - - firebase - - apn - - huawei - - xiaomi - title: PushProvider - type: string + count: + format: int32 + type: integer x-stream-index: "002" - push_provider_name: - description: Push provider name - title: PushProviderName - type: string - x-stream-index: "003" - user: - $ref: '#/components/schemas/UserRequest' - x-stream-index: "005.002" - user_id: - description: '**Server-side only**. User ID which server acts upon' - title: User ID - type: string - x-stream-index: "005.001" - voip_token: - description: When true the token is for Apple VoIP push notifications - title: VoipToken - type: boolean - x-stream-index: "004" + start_ts: + format: date-time + type: number + x-stream-index: "001" required: - - id - - push_provider - title: CreateDeviceRequest + - start_ts + - count type: object - CreateExternalStorageRequest: - description: Create external storage + CreateBlockListRequest: + description: Block list contains restricted words nullable: true properties: - aws_s3: - $ref: '#/components/schemas/S3Request' - description: Only required if you want to create an Amazon S3 storage - title: AwsS3 - x-stream-index: "003.004" - azure_blob: - $ref: '#/components/schemas/AzureRequest' - description: Only required if you want to create an Azure Blob Storage - title: AzureBlob - x-stream-index: "003.006" - bucket: - description: The name of the bucket on the service provider - title: Bucket - type: string - x-stream-index: "003.002" - gcs_credentials: - type: string - x-stream-index: "003.005" name: - description: The name of the provider, this must be unique + description: Block list name + maxLength: 255 title: Name type: string x-stream-index: "001" - path: - description: The path prefix to use for storing files - title: Path + team: type: string - x-stream-index: "003.003" - storage_type: - description: The type of storage to use + x-stream-index: "004" + type: + description: Block list type. enum: - - s3 - - gcs - - abs - title: StorageType + - regex + - domain + - domain_allowlist + - email + - word + title: Type type: string - x-stream-index: "003.001" + x-stream-index: "003" + words: + description: List of words to block + items: + type: string + minimum: 1 + title: Words + type: array + x-stream-index: "002" required: - name - - storage_type - - bucket - title: CreateExternalStorageRequest + - words + title: Block list type: object - CreateExternalStorageResponse: + x-stream-docs-page-id: block_lists + CreateBlockListResponse: 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 - CreateGuestRequest: - nullable: true - properties: - user: - $ref: '#/components/schemas/UserRequest' - description: User object which server acts upon - title: User + blocklist: + $ref: '#/components/schemas/BlockListResponse' x-stream-index: "001" - required: - - user - type: object - CreateGuestResponse: - nullable: true - properties: - access_token: - description: the access token to authenticate the user - title: Access token - type: string - x-stream-index: "002" duration: description: Duration of the request in milliseconds title: Duration type: string - x-stream-index: "003.001" - user: - $ref: '#/components/schemas/UserResponse' - description: User object which server acts upon - title: User - x-stream-index: "001" + x-stream-index: "002.001" required: - - user - - access_token - duration + title: Response type: object - CreateImportRequest: + CreateCallTypeRequest: + description: Request for creating a call type nullable: true properties: - mode: - enum: - - insert - - upsert + external_storage: + description: the external storage for the call type + title: ExternalStorage type: string - x-stream-index: "002" - path: + x-stream-index: "002.004" + grants: + additionalProperties: + items: + type: string + type: array + description: the permissions granted to each role + title: Grants + type: object + x-stream-index: "002.001" + name: type: string x-stream-index: "001" + notification_settings: + $ref: '#/components/schemas/NotificationSettings' + description: the notification settings for the call type + title: NotificationSettings + x-stream-index: "002.002" + settings: + $ref: '#/components/schemas/CallSettingsRequest' + description: the settings for the call type + title: Settings + x-stream-index: "002.003" required: - - path - - mode + - name + title: CreateCallTypeRequest type: object - CreateImportResponse: - description: Basic response information + CreateCallTypeResponse: + description: Response for creating a call type nullable: true properties: + created_at: + description: the time the call type was created + format: date-time + title: CreatedAt + type: number + x-stream-index: "001.005" duration: - description: Duration of the request in milliseconds - title: Duration type: string x-stream-index: "002.001" - import_task: - $ref: '#/components/schemas/ImportTask' - x-stream-index: "001" - required: - - duration - title: Response - type: object - CreateImportURLRequest: - nullable: true - properties: - filename: - type: string - x-stream-index: "001" - type: object - CreateImportURLResponse: - description: Basic response information - nullable: true - properties: - duration: - description: Duration of the request in milliseconds - title: Duration - type: string - x-stream-index: "003.001" - path: + external_storage: + description: the external storage for the call type + title: ExternalStorage type: string - x-stream-index: "001" - upload_url: + x-stream-index: "001.007" + grants: + additionalProperties: + items: + type: string + type: array + description: the permissions granted to each role + title: Grants + type: object + x-stream-index: "001.002" + name: + description: the name of the call type + title: Name type: string - x-stream-index: "002" + x-stream-index: "001.001" + notification_settings: + $ref: '#/components/schemas/NotificationSettings' + description: the notification settings for the call type + title: NotificationSettings + x-stream-index: "001.004" + settings: + $ref: '#/components/schemas/CallSettingsResponse' + description: the settings for the call type + title: Settings + x-stream-index: "001.003" + updated_at: + description: the time the call type was last updated + format: date-time + title: UpdatedAt + type: number + x-stream-index: "001.006" required: - - path - - upload_url + - name + - grants + - settings + - notification_settings + - created_at + - updated_at - duration - title: Response + title: CreateCallTypeResponse type: object - CreatePollOptionRequest: + CreateChannelTypeRequest: nullable: true properties: - Custom: - additionalProperties: {} - type: object - writeOnly: true - x-stream-index: "003" - text: - description: Option text - title: string + automod: + description: Automod + enum: + - disabled + - simple + - AI + title: Automod type: string - x-stream-index: "002" - user: - $ref: '#/components/schemas/UserRequest' - x-stream-index: "004.002" - user_id: + x-stream-index: "019" + automod_behavior: + description: Automod behavior + enum: + - flag + - block + title: Automod behavior type: string - x-stream-index: "004.001" - required: - - text - type: object - CreatePollRequest: - description: Contains all information needed to create a new poll - nullable: true - properties: - Custom: - additionalProperties: {} - type: object - writeOnly: true - x-stream-index: "011" - allow_answers: - description: Indicates whether users can suggest user defined answers - title: Allow answers - type: boolean - x-stream-index: "009" - allow_user_suggested_options: - type: boolean - x-stream-index: "008" - description: - description: A description of the poll - title: Description + x-stream-index: "020" + blocklist: + description: Blocklist + title: Blocklist type: string - x-stream-index: "003" - enforce_unique_vote: - description: Indicates whether users can cast multiple votes - title: Multiple choice - type: boolean - x-stream-index: "006" - id: - maxLength: 255 + x-stream-index: "024" + blocklist_behavior: + description: Blocklist behavior + enum: + - flag + - block + - shadow_block + title: Blocklist behavior type: string - x-stream-index: "001" - is_closed: - description: Indicates whether the poll is open for voting - title: Is closed - type: boolean - x-stream-index: "010" - max_votes_allowed: - description: Indicates the maximum amount of votes a user can cast - format: int32 - maximum: 10 - title: Maximum votes allowed - type: integer - x-stream-index: "007" + x-stream-index: "025" + blocklists: + description: Blocklists + items: + $ref: '#/components/schemas/BlockListOptions' + title: Blocklists + type: array + x-stream-index: "026" + commands: + description: List of commands that channel supports + items: + type: string + title: Commands + type: array + x-stream-index: "021" + connect_events: + description: Connect events + title: Connect events + type: boolean + x-stream-index: "004" + custom_events: + description: Custom events + title: Custom events + type: boolean + x-stream-index: "011" + grants: + additionalProperties: + items: + type: string + type: array + description: List of grants for the channel type + title: Grants + type: object + x-stream-index: "023" + mark_messages_pending: + description: Mark messages pending + title: Mark messages pending + type: boolean + x-stream-index: "013" + max_message_length: + description: Max message length + format: int32 + title: Max message length + type: integer + x-stream-index: "018" + message_retention: + description: Message retention + enum: + - infinite + - numeric + title: Message retention + type: string + x-stream-index: "017" + mutes: + description: Mutes + title: Mutes + type: boolean + x-stream-index: "008" name: - description: The name of the poll + description: Channel type name title: Name type: string + x-stream-index: "001" + partition_size: + description: Partition size + format: int32 + minimum: 10 + title: Partition size + type: integer + x-stream-index: "027" + partition_ttl: + description: Partition TTL + example: 24h + format: duration + nullable: true + title: Partition TTL + type: string + x-stream-index: "028" + permissions: + description: List of permissions for the channel type + items: + $ref: '#/components/schemas/PolicyRequest' + title: Permissions + type: array + x-stream-index: "022" + polls: + description: Polls + title: Polls + type: boolean + x-stream-index: "014" + push_notifications: + description: Push notifications + title: Push notifications + type: boolean + x-stream-index: "012" + reactions: + description: Reactions + title: Reactions + type: boolean + x-stream-index: "005" + read_events: + description: Read events + title: Read events + type: boolean + x-stream-index: "003" + replies: + description: Replies + title: Replies + type: boolean + x-stream-index: "006" + search: + description: Search + title: Search + type: boolean + x-stream-index: "007" + shared_locations: + description: Enables shared location messages + title: Shared locations + type: boolean + x-stream-index: "016" + skip_last_msg_update_for_system_msgs: + type: boolean + x-stream-index: "029" + typing_events: + description: Typing events + title: Typing events + type: boolean x-stream-index: "002" - options: + uploads: + description: Uploads + title: Uploads + type: boolean + x-stream-index: "009" + url_enrichment: + description: URL enrichment + title: URL enrichment + type: boolean + x-stream-index: "010" + user_message_reminders: + type: boolean + x-stream-index: "015" + required: + - name + - max_message_length + - automod + - automod_behavior + title: CreateChannelTypeRequest + type: object + CreateChannelTypeResponse: + nullable: true + properties: + allowed_flag_reasons: items: - $ref: '#/components/schemas/PollOptionInput' - maximum: 100 + type: string type: array - x-stream-index: "004" - user: - $ref: '#/components/schemas/UserRequest' - x-stream-index: "012.002" - user_id: + x-stream-index: 001.001.027 + automod: + enum: + - disabled + - simple + - AI type: string - x-stream-index: "012.001" - voting_visibility: + x-stream-index: 001.001.022 + automod_behavior: enum: - - anonymous - - public + - flag + - block + - shadow_block type: string - x-stream-index: "005" + x-stream-index: 001.001.023 + automod_thresholds: + $ref: '#/components/schemas/Thresholds' + x-stream-index: 001.001.028 + blocklist: + type: string + x-stream-index: 001.001.024 + blocklist_behavior: + enum: + - flag + - block + - shadow_block + type: string + x-stream-index: 001.001.025 + blocklists: + items: + $ref: '#/components/schemas/BlockListOptions' + type: array + x-stream-index: 001.001.026 + commands: + items: + type: string + type: array + x-stream-index: "001.003" + connect_events: + type: boolean + x-stream-index: 001.001.004 + count_messages: + type: boolean + x-stream-index: 001.001.019 + created_at: + format: date-time + type: number + x-stream-index: 001.002.003 + custom_events: + type: boolean + x-stream-index: 001.001.012 + duration: + type: string + x-stream-index: "004.001" + grants: + additionalProperties: + items: + type: string + type: array + type: object + x-stream-index: "003" + mark_messages_pending: + type: boolean + x-stream-index: 001.001.015 + max_message_length: + format: int32 + maximum: 20000 + type: integer + x-stream-index: 001.001.021 + mutes: + type: boolean + x-stream-index: 001.001.009 + name: + type: string + x-stream-index: 001.001.001 + partition_size: + format: int32 + type: integer + x-stream-index: 001.001.029 + partition_ttl: + example: 24h + format: duration + nullable: true + type: string + x-stream-index: 001.001.030 + permissions: + items: + $ref: '#/components/schemas/PolicyRequest' + type: array + x-stream-index: "002" + polls: + type: boolean + x-stream-index: 001.001.016 + push_notifications: + type: boolean + x-stream-index: 001.001.013 + quotes: + type: boolean + x-stream-index: 001.001.008 + reactions: + type: boolean + x-stream-index: 001.001.006 + read_events: + type: boolean + x-stream-index: 001.001.003 + reminders: + type: boolean + x-stream-index: 001.001.014 + replies: + type: boolean + x-stream-index: 001.001.007 + search: + type: boolean + x-stream-index: 001.001.005 + shared_locations: + type: boolean + x-stream-index: 001.001.018 + skip_last_msg_update_for_system_msgs: + type: boolean + x-stream-index: 001.001.031 + typing_events: + type: boolean + x-stream-index: 001.001.002 + updated_at: + format: date-time + type: number + x-stream-index: 001.002.004 + uploads: + type: boolean + x-stream-index: 001.001.010 + url_enrichment: + type: boolean + x-stream-index: 001.001.011 + user_message_reminders: + type: boolean + x-stream-index: 001.001.017 required: - name - title: Create Poll Request + - typing_events + - read_events + - connect_events + - search + - reactions + - replies + - quotes + - mutes + - uploads + - url_enrichment + - custom_events + - push_notifications + - reminders + - mark_messages_pending + - polls + - user_message_reminders + - shared_locations + - count_messages + - message_retention + - max_message_length + - automod + - automod_behavior + - skip_last_msg_update_for_system_msgs + - created_at + - updated_at + - commands + - permissions + - grants + - duration type: object - CreateReminderRequest: + CreateCommandRequest: + description: Create a new command nullable: true properties: - remind_at: - format: date-time - type: number + args: + description: Arguments help text, shown in commands auto-completion + maxLength: 255 + title: Arguments + type: string + x-stream-index: "003" + description: + description: Description, shown in commands auto-completion + maxLength: 255 + title: Description + type: string + x-stream-index: "002" + name: + description: Unique command name + maxLength: 255 + minLength: 1 + title: Name + type: string + x-stream-index: "001" + set: + description: Set name used for grouping commands + maxLength: 255 + title: Set + type: string + x-stream-index: "004" + required: + - name + - description + title: CreateCommandRequest + type: object + CreateCommandResponse: + nullable: true + properties: + command: + $ref: '#/components/schemas/Command' + description: Command object + title: Command + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - duration + title: CreateCommandResponse + type: object + CreateDeviceRequest: + description: Create device request + nullable: true + properties: + id: + description: Device ID + maxLength: 255 + minLength: 1 + title: ID + type: string x-stream-index: "001" + push_provider: + description: Push provider + enum: + - firebase + - apn + - huawei + - xiaomi + title: PushProvider + type: string + x-stream-index: "002" + push_provider_name: + description: Push provider name + title: PushProviderName + type: string + x-stream-index: "003" user: $ref: '#/components/schemas/UserRequest' - x-stream-index: "003.002" + x-stream-index: "005.002" user_id: + description: '**Server-side only**. User ID which server acts upon' + title: User ID type: string - x-stream-index: "003.001" + x-stream-index: "005.001" + voip_token: + description: When true the token is for Apple VoIP push notifications + title: VoipToken + type: boolean + x-stream-index: "004" + required: + - id + - push_provider + title: CreateDeviceRequest type: object - CreateRoleRequest: + CreateExternalStorageRequest: + description: Create external storage nullable: true properties: + aws_s3: + $ref: '#/components/schemas/S3Request' + description: Only required if you want to create an Amazon S3 storage + title: AwsS3 + x-stream-index: "003.004" + azure_blob: + $ref: '#/components/schemas/AzureRequest' + description: Only required if you want to create an Azure Blob Storage + title: AzureBlob + x-stream-index: "003.006" + bucket: + description: The name of the bucket on the service provider + title: Bucket + type: string + x-stream-index: "003.002" + gcs_credentials: + type: string + x-stream-index: "003.005" name: - description: Role name - maxLength: 64 + description: The name of the provider, this must be unique title: Name type: string x-stream-index: "001" + path: + description: The path prefix to use for storing files + title: Path + type: string + x-stream-index: "003.003" + storage_type: + description: The type of storage to use + enum: + - s3 + - gcs + - abs + title: StorageType + type: string + x-stream-index: "003.001" required: - name + - storage_type + - bucket + title: CreateExternalStorageRequest type: object - CreateRoleResponse: + CreateExternalStorageResponse: description: Basic response information nullable: true properties: @@ -8369,60 +10630,517 @@ components: title: Duration type: string x-stream-index: "001.001" - role: - $ref: '#/components/schemas/Role' - x-stream-index: "002" required: - duration - - role title: Response type: object - CustomActionRequest: - properties: - id: - type: string - x-stream-index: "001" - options: - additionalProperties: {} - type: object - x-stream-index: "002" - type: object - CustomCheckFlag: + CreateFeedGroupRequest: + nullable: true properties: + activity_processors: + description: Configuration for activity processors (max 10) + items: + $ref: '#/components/schemas/ActivityProcessorConfig' + maximum: 10 + title: Activity Processors + type: array + x-stream-index: "006" + activity_selectors: + description: Configuration for activity selectors (max 10) + items: + $ref: '#/components/schemas/ActivitySelectorConfig' + maximum: 10 + title: Activity Selectors + type: array + x-stream-index: "007" + aggregation: + $ref: '#/components/schemas/AggregationConfig' + description: Configuration for activity aggregation + title: Aggregation + x-stream-index: "009" custom: additionalProperties: {} - description: Additional metadata for the flag - title: Custom + description: Custom data for the feed group + title: Custom Data type: object - x-stream-index: "003" - labels: - description: Labels from various moderation sources - items: - type: string - title: Labels - type: array x-stream-index: "004" - reason: - description: Optional explanation for the flag - title: Reason + default_visibility: + description: 'Default visibility for the feed group, can be ''public'', + ''visible'', ''followers'', ''members'', or ''private''. Defaults to ''visible'' + if not provided. ' + enum: + - public + - visible + - followers + - members + - private + title: Default Visibility type: string - x-stream-index: "002" - type: - description: Type of check (custom_check_text, custom_check_image, custom_check_video) + x-stream-index: "005" + id: + description: Unique identifier for the feed group maxLength: 255 - title: Type + title: Feed Group ID type: string x-stream-index: "001" + notification: + $ref: '#/components/schemas/NotificationConfig' + description: Configuration for notifications + title: Notification + x-stream-index: "002" + push_notification: + $ref: '#/components/schemas/PushNotificationConfig' + x-stream-index: "003" + ranking: + $ref: '#/components/schemas/RankingConfig' + description: Configuration for activity ranking + title: Ranking + x-stream-index: "008" required: - - type + - id + title: Create Feed Group Request type: object - CustomCheckRequest: + CreateFeedGroupResponse: nullable: true properties: - entity_creator_id: - description: ID of the user who created the entity (required for non-message - entities) - title: Entity Creator ID + duration: + type: string + x-stream-index: "002.001" + feed_group: + $ref: '#/components/schemas/FeedGroupResponse' + description: The upserted feed group + title: Feed Group + x-stream-index: "001" + required: + - feed_group + - duration + title: Upsert Feed Group Response + type: object + CreateFeedViewRequest: + nullable: true + properties: + activity_processors: + description: Configured activity Processors + items: + $ref: '#/components/schemas/ActivityProcessorConfig' + title: Activity Processors + type: array + x-stream-index: "002.002" + activity_selectors: + description: Configuration for selecting activities + items: + $ref: '#/components/schemas/ActivitySelectorConfig' + title: Activity Selectors + type: array + x-stream-index: "002.001" + aggregation: + $ref: '#/components/schemas/AggregationConfig' + description: Configuration for aggregating activities + title: Aggregation + x-stream-index: "002.004" + id: + description: Unique identifier for the feed view + maxLength: 255 + title: View ID + type: string + x-stream-index: "001" + ranking: + $ref: '#/components/schemas/RankingConfig' + description: Configuration for ranking activities + title: Ranking + x-stream-index: "002.003" + required: + - id + title: Create Feed View Request + type: object + CreateFeedViewResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + feed_view: + $ref: '#/components/schemas/FeedViewResponse' + description: The created feed view + title: Feed View + x-stream-index: "001" + required: + - feed_view + - duration + title: Create Feed View Response + type: object + CreateFeedsBatchRequest: + nullable: true + properties: + feeds: + description: List of feeds to create + items: + $ref: '#/components/schemas/FeedRequest' + maximum: 1000 + minimum: 1 + title: Feeds + type: array + x-stream-index: "001" + required: + - feeds + title: Create Feeds Batch Request + type: object + CreateFeedsBatchResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + feeds: + description: List of created feeds + items: + $ref: '#/components/schemas/FeedResponse' + title: Feeds + type: array + x-stream-index: "001" + required: + - feeds + - duration + title: Create Feeds Batch Response + type: object + CreateGuestRequest: + nullable: true + properties: + user: + $ref: '#/components/schemas/UserRequest' + description: User object which server acts upon + title: User + x-stream-index: "001" + required: + - user + type: object + CreateGuestResponse: + nullable: true + properties: + access_token: + description: the access token to authenticate the user + title: Access token + type: string + x-stream-index: "002" + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "003.001" + user: + $ref: '#/components/schemas/UserResponse' + description: User object which server acts upon + title: User + x-stream-index: "001" + required: + - user + - access_token + - duration + type: object + CreateImportRequest: + nullable: true + properties: + mode: + enum: + - insert + - upsert + type: string + x-stream-index: "002" + path: + type: string + x-stream-index: "001" + required: + - path + - mode + type: object + CreateImportResponse: + description: Basic response information + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "002.001" + import_task: + $ref: '#/components/schemas/ImportTask' + x-stream-index: "001" + required: + - duration + title: Response + type: object + CreateImportURLRequest: + nullable: true + properties: + filename: + type: string + x-stream-index: "001" + type: object + CreateImportURLResponse: + description: Basic response information + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "003.001" + path: + type: string + x-stream-index: "001" + upload_url: + type: string + x-stream-index: "002" + required: + - path + - upload_url + - duration + title: Response + type: object + CreateMembershipLevelRequest: + nullable: true + properties: + custom: + additionalProperties: {} + description: Custom data for the membership level + title: Custom Data + type: object + x-stream-index: "006" + description: + description: Optional description of the membership level + maxLength: 1000 + title: Description + type: string + x-stream-index: "003" + id: + description: Unique identifier for the membership level + maxLength: 255 + title: ID + type: string + x-stream-index: "001" + name: + description: Display name for the membership level + maxLength: 255 + title: Name + type: string + x-stream-index: "002" + priority: + description: Priority level (higher numbers = higher priority) + format: int32 + minimum: 0 + title: Priority + type: integer + x-stream-index: "004" + tags: + description: Activity tags this membership level gives access to + items: + type: string + maximum: 255 + title: Tags + type: array + x-stream-index: "005" + required: + - id + - name + title: Create Membership Level Request + type: object + CreateMembershipLevelResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + membership_level: + $ref: '#/components/schemas/MembershipLevelResponse' + description: The created membership level + title: Membership Level + x-stream-index: "001" + required: + - membership_level + - duration + title: Create Membership Level Response + type: object + CreatePollOptionRequest: + nullable: true + properties: + Custom: + additionalProperties: {} + type: object + writeOnly: true + x-stream-index: "003" + text: + description: Option text + title: string + type: string + x-stream-index: "002" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "004.002" + user_id: + type: string + x-stream-index: "004.001" + required: + - text + type: object + CreatePollRequest: + description: Contains all information needed to create a new poll + nullable: true + properties: + Custom: + additionalProperties: {} + type: object + writeOnly: true + x-stream-index: "011" + allow_answers: + description: Indicates whether users can suggest user defined answers + title: Allow answers + type: boolean + x-stream-index: "009" + allow_user_suggested_options: + type: boolean + x-stream-index: "008" + description: + description: A description of the poll + title: Description + type: string + x-stream-index: "003" + enforce_unique_vote: + description: Indicates whether users can cast multiple votes + title: Multiple choice + type: boolean + x-stream-index: "006" + id: + maxLength: 255 + type: string + x-stream-index: "001" + is_closed: + description: Indicates whether the poll is open for voting + title: Is closed + type: boolean + x-stream-index: "010" + max_votes_allowed: + description: Indicates the maximum amount of votes a user can cast + format: int32 + maximum: 10 + title: Maximum votes allowed + type: integer + x-stream-index: "007" + name: + description: The name of the poll + title: Name + type: string + x-stream-index: "002" + options: + items: + $ref: '#/components/schemas/PollOptionInput' + maximum: 100 + type: array + x-stream-index: "004" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "012.002" + user_id: + type: string + x-stream-index: "012.001" + voting_visibility: + enum: + - anonymous + - public + type: string + x-stream-index: "005" + required: + - name + title: Create Poll Request + type: object + CreateReminderRequest: + nullable: true + properties: + remind_at: + format: date-time + type: number + x-stream-index: "001" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "003.002" + user_id: + type: string + x-stream-index: "003.001" + type: object + CreateRoleRequest: + nullable: true + properties: + name: + description: Role name + maxLength: 64 + title: Name + type: string + x-stream-index: "001" + required: + - name + type: object + CreateRoleResponse: + description: Basic response information + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "001.001" + role: + $ref: '#/components/schemas/Role' + x-stream-index: "002" + required: + - duration + - role + title: Response + type: object + CustomActionRequest: + properties: + id: + type: string + x-stream-index: "001" + options: + additionalProperties: {} + type: object + x-stream-index: "002" + type: object + CustomCheckFlag: + properties: + custom: + additionalProperties: {} + description: Additional metadata for the flag + title: Custom + type: object + x-stream-index: "003" + labels: + description: Labels from various moderation sources + items: + type: string + title: Labels + type: array + x-stream-index: "004" + reason: + description: Optional explanation for the flag + title: Reason + type: string + x-stream-index: "002" + type: + description: Type of check (custom_check_text, custom_check_image, custom_check_video) + maxLength: 255 + title: Type + type: string + x-stream-index: "001" + required: + - type + type: object + CustomCheckRequest: + nullable: true + properties: + entity_creator_id: + description: ID of the user who created the entity (required for non-message + entities) + title: Entity Creator ID type: string x-stream-index: "003" entity_id: @@ -8693,12 +11411,144 @@ components: - duration title: Response type: object + DecayFunctionConfig: + properties: + base: + description: Base value for decay function + title: Base + type: string + x-stream-index: "001" + decay: + description: Decay rate + title: Decay + type: string + x-stream-index: "005" + direction: + description: Direction of decay + title: Direction + type: string + x-stream-index: "006" + offset: + description: Offset value for decay function + title: Offset + type: string + x-stream-index: "004" + origin: + description: Origin value for decay function + title: Origin + type: string + x-stream-index: "002" + scale: + description: Scale factor for decay function + title: Scale + type: string + x-stream-index: "003" + title: Decay Function Configuration + type: object + DeleteActivitiesRequest: + nullable: true + properties: + hard_delete: + description: Whether to permanently delete the activities + title: Hard Delete + type: boolean + x-stream-index: "002" + ids: + description: List of activity IDs to delete + items: + type: string + minimum: 1 + title: Activity IDs + type: array + x-stream-index: "001" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "004.002" + user_id: + type: string + x-stream-index: "004.001" + required: + - ids + title: Delete Activities Request + type: object + DeleteActivitiesResponse: + nullable: true + properties: + deleted_ids: + description: List of activity IDs that were successfully deleted + items: + type: string + title: Deleted Activity IDs + type: array + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - deleted_ids + - duration + title: Delete Activities Response + type: object + DeleteActivityReactionResponse: + nullable: true + properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + x-stream-index: "001" + duration: + type: string + x-stream-index: "003.001" + reaction: + $ref: '#/components/schemas/FeedsReactionResponse' + x-stream-index: "002" + required: + - activity + - reaction + - duration + title: Delete Activity Reaction Response + type: object DeleteActivityRequest: properties: hard_delete: type: boolean x-stream-index: "001" type: object + DeleteActivityResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "001.001" + required: + - duration + title: Delete Activity Response + type: object + DeleteBookmarkFolderResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "001.001" + required: + - duration + title: Delete Bookmark Folder Response + type: object + DeleteBookmarkResponse: + nullable: true + properties: + bookmark: + $ref: '#/components/schemas/BookmarkResponse' + description: The deleted bookmark + title: Bookmark + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - bookmark + - duration + title: Delete Bookmark Response + type: object DeleteCallRequest: description: DeleteCallRequest is the payload for deleting a call. nullable: true @@ -8816,6 +11666,38 @@ components: - duration title: DeleteCommandResponse type: object + DeleteCommentReactionResponse: + nullable: true + properties: + comment: + $ref: '#/components/schemas/CommentResponse' + description: The comment after reaction removal + title: Comment + x-stream-index: "001" + duration: + type: string + x-stream-index: "003.001" + reaction: + $ref: '#/components/schemas/FeedsReactionResponse' + description: The removed reaction + title: Reaction + x-stream-index: "002" + required: + - comment + - reaction + - duration + title: Delete Comment Reaction Response + type: object + DeleteCommentResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "001.001" + required: + - duration + title: Delete Comment Response + type: object DeleteExternalStorageResponse: description: Basic response information nullable: true @@ -8829,13 +11711,7 @@ components: - duration title: Response type: object - DeleteMessageRequest: - properties: - hard_delete: - type: boolean - x-stream-index: "001" - type: object - DeleteMessageResponse: + DeleteFeedGroupResponse: description: Basic response information nullable: true properties: @@ -8843,16 +11719,12 @@ components: description: Duration of the request in milliseconds title: Duration type: string - x-stream-index: "002.001" - message: - $ref: '#/components/schemas/MessageResponse' - x-stream-index: "001" + x-stream-index: "001.001" required: - - message - duration title: Response type: object - DeleteModerationConfigResponse: + DeleteFeedResponse: nullable: true properties: duration: @@ -8860,17 +11732,111 @@ components: x-stream-index: "001.001" required: - duration + title: Delete Feed Response type: object - DeleteModerationTemplateResponse: + DeleteFeedUserDataResponse: + description: Response for deleting feed user data nullable: true properties: + deleted_activities: + description: Number of activities that were deleted + format: int32 + title: Deleted Activities + type: integer + x-stream-index: "001" + deleted_bookmarks: + description: Number of bookmarks that were deleted + format: int32 + title: Deleted Bookmarks + type: integer + x-stream-index: "004" + deleted_comments: + description: Number of comments that were deleted + format: int32 + title: Deleted Comments + type: integer + x-stream-index: "003" + deleted_reactions: + description: Number of reactions that were deleted + format: int32 + title: Deleted Reactions + type: integer + x-stream-index: "002" duration: type: string - x-stream-index: "001.001" + x-stream-index: "005.001" required: + - deleted_activities + - deleted_reactions + - deleted_comments + - deleted_bookmarks - duration type: object - DeleteReactionRequest: + DeleteFeedViewResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "001.001" + required: + - duration + title: Delete Feed View Response + type: object + DeleteMessageRequest: + properties: + hard_delete: + type: boolean + x-stream-index: "001" + type: object + DeleteMessageResponse: + description: Basic response information + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "002.001" + message: + $ref: '#/components/schemas/MessageResponse' + x-stream-index: "001" + required: + - message + - duration + title: Response + type: object + DeleteModerationConfigResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "001.001" + required: + - duration + type: object + DeleteModerationRuleResponse: + 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 + DeleteModerationTemplateResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "001.001" + required: + - duration + type: object + DeleteReactionRequest: properties: hard_delete: type: boolean @@ -9769,11 +12735,11 @@ components: properties: callback: $ref: '#/components/schemas/AsyncModerationCallbackConfig' - x-stream-index: 018.001.002 + x-stream-index: 019.001.002 created_at: format: date-time type: number - x-stream-index: "019" + x-stream-index: "020" enabled: type: boolean x-stream-index: "003" @@ -9788,6 +12754,9 @@ components: id: type: string x-stream-index: "001" + product: + type: string + x-stream-index: "018" sns_auth_type: type: string x-stream-index: "014" @@ -9827,11 +12796,11 @@ components: timeout_ms: format: int32 type: integer - x-stream-index: 018.001.001 + x-stream-index: 019.001.001 updated_at: format: date-time type: number - x-stream-index: "020" + x-stream-index: "021" webhook_url: type: string x-stream-index: "005" @@ -9945,6 +12914,26 @@ components: - task_id - duration type: object + ExportFeedUserDataRequest: + description: Request for exporting feed user data + nullable: true + type: object + ExportFeedUserDataResponse: + description: Response for exporting feed user data + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + task_id: + description: The task ID for the export task + title: Task ID + type: string + x-stream-index: "001" + required: + - task_id + - duration + type: object ExportUserResponse: nullable: true properties: @@ -10078,1754 +13067,2585 @@ components: type: object x-stream-index: "001" type: object - FeedsModerationTemplateConfig: + FeedCreatedEvent: + description: Emitted when a feed is created. + nullable: true properties: - config_key: - type: string - x-stream-index: "002" - data_types: - additionalProperties: - type: string + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 003.001.003 + custom: + additionalProperties: {} type: object + x-stream-index: 003.001.007 + feed: + $ref: '#/components/schemas/FeedResponse' + description: The feed that was created + title: Feed x-stream-index: "001" - required: - - data_types - - config_key - type: object - Field: - nullable: true - properties: - short: - type: boolean - x-stream-index: "003" - title: + feed_visibility: type: string - x-stream-index: "001" - value: + x-stream-index: "003.003" + fid: type: string - x-stream-index: "002" - required: - - title - - value - - short - type: object - FileUploadConfig: - properties: - allowed_file_extensions: - items: - type: string - type: array - x-stream-index: "001" - allowed_mime_types: - items: - type: string - type: array - x-stream-index: "003" - blocked_file_extensions: + x-stream-index: "003.002" + members: items: - type: string + $ref: '#/components/schemas/FeedMemberResponse' type: array x-stream-index: "002" - blocked_mime_types: - items: - type: string - type: array - x-stream-index: "004" - size_limit: - format: int32 - maximum: 104857600 - minimum: 0 - type: integer - x-stream-index: "005" - required: - - size_limit - type: object - FileUploadRequest: - nullable: true - properties: - file: - description: file field - title: File + received_at: + format: date-time + type: number + x-stream-index: 003.001.004 + type: + default: feeds.feed.created + description: 'The type of event: "feeds.feed.created" in this case' + title: Event Type type: string - x-stream-index: "001" + x-stream-index: 003.001.002 user: - $ref: '#/components/schemas/OnlyUserID' - description: user for the request **server side only** + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who created the feed title: User - x-stream-index: "002" - type: object - FileUploadResponse: - nullable: true - properties: - duration: - description: Duration of the request in milliseconds - title: Duration - type: string - x-stream-index: "003.001" - file: - description: URL to the uploaded asset. Should be used to put to `asset_url` - attachment field - title: File - type: string - x-stream-index: "001" - thumb_url: - description: URL of the file thumbnail for supported file formats. Should - be put to `thumb_url` attachment field - title: Thumbnail URL - type: string - x-stream-index: "002" - required: - - duration - type: object - FirebaseConfig: - properties: - Disabled: - type: boolean - writeOnly: true - x-stream-index: "001" - apn_template: - type: string - x-stream-index: "005" - credentials_json: - type: string - x-stream-index: "006" - data_template: - type: string - x-stream-index: "004" - notification_template: - type: string - x-stream-index: "003" - server_key: - type: string - x-stream-index: "002" - type: object - FirebaseConfigFields: - properties: - apn_template: - type: string - x-stream-index: "004" - credentials_json: - type: string - x-stream-index: "006" - data_template: - type: string - x-stream-index: "003" - enabled: - type: boolean - x-stream-index: "001" - notification_template: - type: string - x-stream-index: "002" - server_key: - type: string - x-stream-index: "005" + x-stream-index: "004.001" required: - - enabled + - feed + - members + - type + - created_at + - custom + - fid + - user + title: FeedCreatedEvent type: object - Flag: - description: Contains information about flagged user or message + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + FeedDeletedEvent: + description: Emitted when a feed is deleted. + nullable: true properties: - approved_at: - description: Date of the approval - format: date-time - title: Approved at - type: number - x-stream-index: "015" created_at: description: Date/time of creation format: date-time title: Created at type: number - x-stream-index: "011" - created_by_automod: - type: boolean - x-stream-index: "004" + x-stream-index: 001.001.003 custom: additionalProperties: {} type: object - x-stream-index: "022" - details: - $ref: '#/components/schemas/FlagDetails' - x-stream-index: "021" - reason: - type: string - x-stream-index: "020" - rejected_at: - description: Date of the rejection - format: date-time - title: Rejected at - type: number - x-stream-index: "016" - reviewed_at: - description: Date of the review - format: date-time - title: Reviewed at - type: number - x-stream-index: "013" - reviewed_by: + x-stream-index: 001.001.007 + feed_visibility: type: string - x-stream-index: "014" - target_message: - $ref: '#/components/schemas/Message' - x-stream-index: "008" - target_message_id: - description: ID of flagged message - title: Target Message ID + x-stream-index: "001.003" + fid: type: string - x-stream-index: "007" - target_user: - $ref: '#/components/schemas/User' - description: Flagged user - title: User - x-stream-index: "010" - updated_at: - description: Date/time of the last update + x-stream-index: "001.002" + received_at: format: date-time - title: Updated at type: number - x-stream-index: "012" + x-stream-index: 001.001.004 + type: + default: feeds.feed.deleted + description: 'The type of event: "feeds.feed.deleted" in this case' + title: Event Type + type: string + x-stream-index: 001.001.002 user: - $ref: '#/components/schemas/User' - description: User who flagged a message or a user + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who deleted the feed title: User - x-stream-index: "006" + x-stream-index: "002.001" required: - - created_by_automod + - type - created_at - - updated_at - title: Flag - type: object - FlagContentOptions: - properties: - reason: - type: string - x-stream-index: "001" - required: - - reason + - custom + - fid + title: FeedDeletedEvent type: object - FlagDetails: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + FeedGroup: properties: - Extra: + ActivityProcessors: + items: + $ref: '#/components/schemas/ActivityProcessorConfig' + type: array + writeOnly: true + x-stream-index: "012" + ActivitySelectors: + items: + $ref: '#/components/schemas/ActivitySelectorConfig' + type: array + writeOnly: true + x-stream-index: "013" + Aggregation: + $ref: '#/components/schemas/AggregationConfig' + x-stream-index: "015" + AggregationVersion: + format: int32 + type: integer + writeOnly: true + x-stream-index: "016" + AppPK: + format: int32 + type: integer + writeOnly: true + x-stream-index: "002" + Custom: additionalProperties: {} type: object writeOnly: true - x-stream-index: "002" - automod: - $ref: '#/components/schemas/AutomodDetails' - x-stream-index: "001" - original_text: + x-stream-index: "007" + DefaultVisibility: type: string - x-stream-index: "003" - required: - - Extra - - original_text - type: object - FlagFeedback: - properties: - created_at: + writeOnly: true + x-stream-index: "006" + DeletedAt: format: date-time type: number - x-stream-index: "005" - labels: - items: - $ref: '#/components/schemas/Label' - type: array - x-stream-index: "006" - message_id: + writeOnly: true + x-stream-index: "010" + ID: type: string + writeOnly: true + x-stream-index: "003" + LastFeedGetAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "017" + Notification: + $ref: '#/components/schemas/NotificationConfig' x-stream-index: "004" + PushNotification: + $ref: '#/components/schemas/PushNotificationConfig' + x-stream-index: "005" + Ranking: + $ref: '#/components/schemas/RankingConfig' + x-stream-index: "014" + Stories: + $ref: '#/components/schemas/StoriesConfig' + x-stream-index: "011" + created_at: + format: date-time + type: number + x-stream-index: "008" + updated_at: + format: date-time + type: number + x-stream-index: "009" required: - - message_id + - AppPK + - ID + - DefaultVisibility + - Custom - created_at - - labels - type: object - FlagMessageDetails: - properties: - pin_changed: - type: boolean - x-stream-index: "002" - should_enrich: - type: boolean - x-stream-index: "003" - skip_push: - type: boolean - x-stream-index: "004" - updated_by_id: - type: string - x-stream-index: "001" + - updated_at + - ActivityProcessors + - ActivitySelectors + - AggregationVersion type: object - FlagRequest: + FeedGroupChangedEvent: + description: Emitted when a feed group is changed. nullable: true properties: + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 001.001.003 custom: additionalProperties: {} - description: Additional metadata about the flag - title: Custom type: object - x-stream-index: "006" - entity_creator_id: - description: ID of the user who created the flagged entity - title: Entity Creator ID - type: string + x-stream-index: 001.001.007 + feed_group: + $ref: '#/components/schemas/FeedGroup' + description: The feed group that was changed + title: Feed Type x-stream-index: "003" - entity_id: - description: Unique identifier of the entity being flagged - title: Entity ID + feed_visibility: type: string - x-stream-index: "002" - entity_type: - description: Type of entity being flagged (e.g., message, user) - title: Entity Type + x-stream-index: "001.003" + fid: type: string - x-stream-index: "001" - moderation_payload: - $ref: '#/components/schemas/ModerationPayload' - description: Content being flagged - title: Moderation Payload - x-stream-index: "005" - reason: - description: Optional explanation for why the content is being flagged - maxLength: 255 - title: Reason + x-stream-index: "001.002" + received_at: + format: date-time + type: number + x-stream-index: 001.001.004 + type: + default: feeds.feed_group.changed + description: 'The type of event: "feeds.feed_group.changed" in this case' + title: Event Type type: string - x-stream-index: "004" + x-stream-index: 001.001.002 user: - $ref: '#/components/schemas/UserRequest' - x-stream-index: "007.002" - user_id: - type: string - x-stream-index: "007.001" - required: - - entity_type - - entity_id - type: object - FlagResponse: - nullable: true - properties: - duration: - type: string + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who changed the feed group + title: User x-stream-index: "002.001" - item_id: - description: Unique identifier of the created moderation item - title: Item ID - type: string - x-stream-index: "001" required: - - item_id - - duration + - type + - created_at + - custom + - fid + title: FeedGroupChangedEvent type: object - FlagUpdatedEvent: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + FeedGroupDeletedEvent: + description: Emitted when a feed group is deleted. nullable: true properties: - CreatedBy: - $ref: '#/components/schemas/UserResponse' - x-stream-index: "004" - Message: - $ref: '#/components/schemas/MessageResponse' - x-stream-index: "002" - User: - $ref: '#/components/schemas/UserResponse' - x-stream-index: "003" created_at: + description: Date/time of creation format: date-time + title: Created at type: number - x-stream-index: "001.003" + x-stream-index: 002.001.003 custom: additionalProperties: {} type: object - x-stream-index: "001.007" + x-stream-index: 002.001.007 + feed_visibility: + type: string + x-stream-index: "002.003" + fid: + type: string + x-stream-index: "002.002" + group_id: + description: The ID of the feed group that was deleted + title: Group ID + type: string + x-stream-index: "001" received_at: format: date-time type: number - x-stream-index: "001.004" + x-stream-index: 002.001.004 type: - default: flag.updated + default: feeds.feed_group.deleted + description: 'The type of event: "feeds.feed_group.deleted" in this case' + title: Event Type type: string - x-stream-index: "001.002" + x-stream-index: 002.001.002 required: + - group_id - type - created_at - custom - title: FlagUpdatedEvent + - fid + title: FeedGroupDeletedEvent 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 - FlagUserOptions: - properties: - reason: - type: string - x-stream-index: "001" - required: - - reason - type: object - FrameRecordSettings: + FeedGroupResponse: properties: - capture_interval_in_seconds: - format: int32 - maximum: 60 - minimum: 2 - type: integer - x-stream-index: "003" - mode: - enum: - - available - - disabled - - auto-on + activity_processors: + description: Configuration for activity processors + items: + $ref: '#/components/schemas/ActivityProcessorConfig' + title: Activity Processors + type: array + x-stream-index: "009" + activity_selectors: + description: Configuration for activity selectors + items: + $ref: '#/components/schemas/ActivitySelectorConfig' + title: Activity Selectors + type: array + x-stream-index: "010" + aggregation: + $ref: '#/components/schemas/AggregationConfig' + description: Configuration for activity aggregation + title: Aggregation + x-stream-index: "012" + created_at: + description: When the feed group was created + format: date-time + title: Created At + type: number + x-stream-index: "006" + custom: + additionalProperties: {} + description: Custom data for the feed group + title: Custom Data + type: object + x-stream-index: "005" + default_visibility: + description: Default visibility for activities + title: Default Visibility type: string - x-stream-index: "001" - quality: + x-stream-index: "004" + id: + description: Identifier within the group + title: Feed Group ID type: string + x-stream-index: "001" + notification: + $ref: '#/components/schemas/NotificationConfig' + description: Configuration for notifications + title: Notification x-stream-index: "002" + push_notification: + $ref: '#/components/schemas/PushNotificationConfig' + x-stream-index: "003" + ranking: + $ref: '#/components/schemas/RankingConfig' + description: Configuration for activity ranking + title: Ranking + x-stream-index: "011" + stories: + $ref: '#/components/schemas/StoriesConfig' + description: Configuration for stories feature + title: Stories + x-stream-index: "008" + updated_at: + description: When the feed group was last updated + format: date-time + title: Updated At + type: number + x-stream-index: "007" required: - - mode - - capture_interval_in_seconds + - id + - created_at + - updated_at + title: Feed Group type: object - FrameRecordingEgressConfig: + FeedInput: properties: - capture_interval_in_seconds: - format: int32 - type: integer - x-stream-index: "007" - external_storage: - $ref: '#/components/schemas/ExternalStorage' - x-stream-index: "006" - quality: - $ref: '#/components/schemas/Quality' + custom: + additionalProperties: {} + type: object x-stream-index: "004" - storage_name: + description: + maxLength: 1000 type: string + x-stream-index: "002" + filter_tags: + items: + type: string + maximum: 255 + type: array x-stream-index: "005" + members: + items: + $ref: '#/components/schemas/FeedMemberRequest' + type: array + x-stream-index: "006" + name: + maxLength: 255 + type: string + x-stream-index: "001" + visibility: + enum: + - public + - visible + - followers + - members + - private + type: string + x-stream-index: "003" type: object - FrameRecordingResponse: + FeedMemberAddedEvent: + description: Emitted when a feed member is added. + nullable: true properties: - status: + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 003.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 003.001.007 + feed_visibility: + type: string + x-stream-index: "003.003" + fid: type: string + x-stream-index: "003.002" + member: + $ref: '#/components/schemas/FeedMemberResponse' + description: The member that was added + title: Member x-stream-index: "001" + received_at: + format: date-time + type: number + x-stream-index: 003.001.004 + type: + default: feeds.feed_member.added + description: 'The type of event: "feeds.feed_member.added" in this case' + title: Event Type + type: string + x-stream-index: 003.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who added the member + title: User + x-stream-index: "002.001" required: - - status + - member + - type + - created_at + - custom + - fid + title: FeedMemberAddedEvent type: object - FrameRecordingSettingsRequest: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + FeedMemberRemovedEvent: + description: Emitted when a feed member is removed. + nullable: true properties: - capture_interval_in_seconds: - format: int32 - maximum: 60 - minimum: 2 - type: integer - x-stream-index: "003" - mode: - enum: - - available - - disabled - - auto-on + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 003.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 003.001.007 + feed_visibility: + type: string + x-stream-index: "003.003" + fid: + type: string + x-stream-index: "003.002" + member_id: type: string x-stream-index: "001" - quality: - enum: - - 360p - - 480p - - 720p - - 1080p - - 1440p + received_at: + format: date-time + type: number + x-stream-index: 003.001.004 + type: + default: feeds.feed_member.removed + description: 'The type of event: "feeds.feed_member.removed" in this case' + title: Event Type type: string - x-stream-index: "002" + x-stream-index: 003.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who removed the member + title: User + x-stream-index: "002.001" required: - - mode - - capture_interval_in_seconds + - member_id + - type + - created_at + - custom + - fid + title: FeedMemberRemovedEvent type: object - FrameRecordingSettingsResponse: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + FeedMemberRequest: properties: - capture_interval_in_seconds: - format: int32 - maximum: 60 - minimum: 2 - type: integer - x-stream-index: "003" - mode: - enum: - - available - - disabled - - auto-on + custom: + additionalProperties: {} + description: Custom data for the member + title: Custom Data + type: object + x-stream-index: "004" + invite: + description: Whether this is an invite to become a member + title: Invite + type: boolean + x-stream-index: "005" + membership_level: + description: ID of the membership level to assign to the member + maxLength: 255 + title: Membership Level type: string - x-stream-index: "001" - quality: + x-stream-index: "003" + role: + description: Role of the member in the feed + maxLength: 255 + title: Role type: string x-stream-index: "002" + user_id: + description: ID of the user to add as a member + maxLength: 255 + title: User ID + type: string + x-stream-index: "001" required: - - mode - - capture_interval_in_seconds + - user_id + title: Feed Member Payload type: object - FullUserResponse: + FeedMemberResponse: properties: - avg_response_time: - format: int32 - type: integer - x-stream-index: "001.018" - ban_expires: - format: date-time - type: number - x-stream-index: "015" - banned: - type: boolean - x-stream-index: "001.012" - blocked_user_ids: - items: - type: string - type: array - x-stream-index: "014" - channel_mutes: - items: - $ref: '#/components/schemas/ChannelMute' - type: array - x-stream-index: "007" created_at: + description: When the membership was created format: date-time + title: Created At type: number - x-stream-index: "001.009" + x-stream-index: "008" custom: additionalProperties: {} + description: Custom data for the membership + title: Custom Data type: object - x-stream-index: "001.004" - deactivated_at: + x-stream-index: "007" + invite_accepted_at: + description: When the invite was accepted format: date-time + title: Invite Accepted At type: number - x-stream-index: "001.016" - deleted_at: + x-stream-index: "005" + invite_rejected_at: + description: When the invite was rejected format: date-time + title: Invite Rejected At type: number - x-stream-index: "001.011" - devices: - items: - $ref: '#/components/schemas/DeviceResponse' - type: array + x-stream-index: "006" + membership_level: + $ref: '#/components/schemas/MembershipLevelResponse' + description: Membership level assigned to the member + title: Membership Level x-stream-index: "004" - id: + role: + description: Role of the member in the feed + title: Role type: string - x-stream-index: "001.001" - image: + x-stream-index: "002" + status: + description: Status of the membership + enum: + - member + - pending + - rejected + title: Status type: string - x-stream-index: "001.003" - invisible: - type: boolean - x-stream-index: "005" - language: + x-stream-index: "003" + updated_at: + description: When the membership was last updated + format: date-time + title: Updated At + type: number + x-stream-index: "009" + user: + $ref: '#/components/schemas/UserResponse' + description: User who is a member + title: User + x-stream-index: "001" + required: + - user + - role + - status + - created_at + - updated_at + title: Feed Member + type: object + FeedMemberUpdatedEvent: + description: Emitted when a feed member is updated. + nullable: true + properties: + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 003.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 003.001.007 + feed_visibility: type: string - x-stream-index: "001.005" - last_active: + x-stream-index: "003.003" + fid: + type: string + x-stream-index: "003.002" + member: + $ref: '#/components/schemas/FeedMemberResponse' + description: The member that was updated + title: Member + x-stream-index: "001" + received_at: format: date-time type: number - x-stream-index: "001.014" - latest_hidden_channels: + x-stream-index: 003.001.004 + type: + default: feeds.feed_member.updated + description: 'The type of event: "feeds.feed_member.updated" in this case' + title: Event Type + type: string + x-stream-index: 003.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who updated the member + title: User + x-stream-index: "002.001" + required: + - member + - type + - created_at + - custom + - fid + title: FeedMemberUpdatedEvent + 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 + FeedOwnCapability: + description: All possibility of string to use + enum: + - add-activity + - add-activity-reaction + - add-comment + - add-comment-reaction + - bookmark-activity + - create-feed + - delete-bookmark + - delete-comment + - delete-feed + - edit-bookmark + - follow + - invite-feed + - join-feed + - leave-feed + - manage-feed-group + - mark-activity + - pin-activity + - query-feed-members + - query-follows + - read-activities + - read-feed + - remove-activity + - remove-activity-reaction + - remove-comment-reaction + - unfollow + - update-activity + - update-comment + - update-feed + - update-feed-followers + - update-feed-members + title: FeedOwnCapability + type: string + FeedRequest: + properties: + created_by_id: + description: ID of the feed creator + title: Created By ID + type: string + x-stream-index: "003" + custom: + additionalProperties: {} + description: Custom data for the feed + title: Custom Data + type: object + x-stream-index: "004.004" + description: + description: Description of the feed + maxLength: 1000 + title: Description + type: string + x-stream-index: "004.002" + feed_group_id: + description: ID of the feed group + maxLength: 255 + title: Feed Group ID + type: string + x-stream-index: "001" + feed_id: + description: ID of the feed + maxLength: 255 + title: Feed ID + type: string + x-stream-index: "002" + filter_tags: + description: Tags used for filtering feeds items: type: string + maximum: 255 + title: Filter Tags type: array - x-stream-index: "012" - mutes: + x-stream-index: "004.005" + members: + description: Initial members for the feed items: - $ref: '#/components/schemas/UserMuteResponse' + $ref: '#/components/schemas/FeedMemberRequest' + title: Members type: array - x-stream-index: "006" + x-stream-index: "004.006" name: + description: Name of the feed + maxLength: 255 + title: Name type: string - x-stream-index: "001.002" - online: - type: boolean - x-stream-index: "001.013" - privacy_settings: - $ref: '#/components/schemas/PrivacySettingsResponse' - x-stream-index: "003" - revoke_tokens_issued_before: + x-stream-index: "004.001" + visibility: + description: Visibility setting for the feed + enum: + - public + - visible + - followers + - members + - private + title: Visibility + type: string + x-stream-index: "004.003" + required: + - feed_group_id + - feed_id + title: Feed Payload + type: object + FeedResponse: + properties: + created_at: + description: When the feed was created format: date-time + title: Created At type: number - x-stream-index: "001.015" - role: + x-stream-index: "015" + created_by: + $ref: '#/components/schemas/UserResponse' + description: User who created the feed + title: Created By + x-stream-index: "009" + custom: + additionalProperties: {} + description: Custom data for the feed + title: Custom Data + type: object + x-stream-index: "006" + deleted_at: + description: When the feed was deleted + format: date-time + title: Deleted At + type: number + x-stream-index: "017" + description: + description: Description of the feed + title: Description type: string - x-stream-index: "001.006" - shadow_banned: - type: boolean - x-stream-index: "013" - teams: + x-stream-index: "005" + feed: + description: Fully qualified feed ID (group_id:id) + title: FID + type: string + x-stream-index: "003" + filter_tags: + description: Tags used for filtering feeds items: type: string + title: Filter Tags type: array - x-stream-index: "001.007" - teams_role: - additionalProperties: - type: string - type: object - x-stream-index: "001.008" - total_unread_count: + x-stream-index: "007" + follower_count: + description: Number of followers of this feed format: int32 + title: Follower Count type: integer - x-stream-index: "009" - unread_channels: + x-stream-index: "011" + following_count: + description: Number of feeds this feed follows format: int32 + title: Following Count type: integer - x-stream-index: "010" - unread_count: + x-stream-index: "012" + group_id: + description: Group this feed belongs to + title: Group ID + type: string + x-stream-index: "001" + id: + description: Unique identifier for the feed + title: ID + type: string + x-stream-index: "002" + member_count: + description: Number of members in this feed format: int32 + title: Member Count type: integer - x-stream-index: "008" - unread_threads: + x-stream-index: "010" + name: + description: Name of the feed + title: Name + type: string + x-stream-index: "004" + own_follows: + description: Follow relationships where the current user's feeds are following + this feed + items: + $ref: '#/components/schemas/FollowResponse' + title: Own Follows + type: array + x-stream-index: "014" + pin_count: + description: Number of pinned activities in this feed format: int32 + title: Pin Count type: integer - x-stream-index: "011" + x-stream-index: "013" updated_at: + description: When the feed was last updated format: date-time + title: Updated At type: number - x-stream-index: "001.010" + x-stream-index: "016" + visibility: + description: Visibility setting for the feed + title: Visibility + type: string + x-stream-index: "008" required: + - group_id - id - - custom - - language - - role - - teams + - feed + - name + - description + - created_by + - member_count + - follower_count + - following_count + - pin_count - created_at - updated_at - - banned - - online - - devices - - invisible - - mutes - - channel_mutes - - unread_count - - total_unread_count - - unread_channels - - unread_threads - - shadow_banned - - blocked_user_ids + title: Feed type: object - GeofenceResponse: + FeedUpdatedEvent: + description: Emitted when a feed is created. nullable: true properties: - country_codes: - items: - type: string - type: array - x-stream-index: "004" - description: + created_at: + format: date-time + type: number + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + feed: + $ref: '#/components/schemas/FeedResponse' + description: The feed that was created + title: Feed + x-stream-index: "001" + feed_visibility: type: string - x-stream-index: "003" - name: + x-stream-index: "002.003" + fid: type: string - x-stream-index: "001" + x-stream-index: "002.002" + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 type: + default: feeds.feed.updated + description: 'The type of event: "feeds.feed.updated" in this case' + title: Event Type type: string - x-stream-index: "002" + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who created the feed + title: User + x-stream-index: "003.001" required: - - name + - feed + - type + - created_at + - custom + - fid + title: FeedUpdatedEvent type: object - GeofenceSettings: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + FeedViewResponse: properties: - names: + activity_processors: + description: Configured activity processors items: - type: string + $ref: '#/components/schemas/ActivityProcessorConfig' + title: Activity Processors + type: array + x-stream-index: "003" + activity_selectors: + description: Configured activity selectors + items: + $ref: '#/components/schemas/ActivitySelectorConfig' + title: Activity Selectors type: array + x-stream-index: "002" + aggregation: + $ref: '#/components/schemas/AggregationConfig' + description: Configuration for activity aggregation + title: Aggregation + x-stream-index: "005" + id: + description: Unique identifier for the custom feed view + title: View ID + type: string x-stream-index: "001" + last_used_at: + description: When the feed view was last used + format: date-time + title: Last Used At + type: number + x-stream-index: "006" + ranking: + $ref: '#/components/schemas/RankingConfig' + description: Configuration for activity ranking + title: Ranking + x-stream-index: "004" required: - - names + - id + title: Feed View type: object - GeofenceSettingsRequest: + FeedsEventPreferences: properties: - names: - items: - type: string - type: array + comments: + type: string + x-stream-index: "002" + mentions: + type: string + x-stream-index: "004" + new_followers: + type: string + x-stream-index: "003" + reactions: + type: string x-stream-index: "001" type: object - GeofenceSettingsResponse: + FeedsEventPreferencesInput: properties: - names: - items: + comments: + enum: + - all + - none + type: string + x-stream-index: "002" + mentions: + enum: + - all + - none + type: string + x-stream-index: "004" + new_followers: + enum: + - all + - none + type: string + x-stream-index: "003" + reactions: + enum: + - all + - none + type: string + x-stream-index: "001" + type: object + FeedsModerationTemplateConfig: + properties: + config_key: + type: string + x-stream-index: "002" + data_types: + additionalProperties: type: string - type: array + type: object x-stream-index: "001" required: - - names + - data_types + - config_key type: object - GetActiveCallsStatusResponse: - description: Response containing active calls status information - nullable: true + FeedsReactionResponse: properties: - duration: + activity_id: + description: ID of the activity that was reacted to + title: Activity ID type: string - x-stream-index: "001.001" - end_time: - description: End time of the status period + x-stream-index: "002" + comment_id: + description: ID of the comment that was reacted to + title: Comment ID + type: string + x-stream-index: "003" + created_at: + description: When the reaction was created format: date-time - title: time.Time + title: Created At type: number - x-stream-index: "003" - metrics: - $ref: '#/components/schemas/ActiveCallsMetrics' - description: Detailed metrics - title: '*ActiveCallsMetrics' + x-stream-index: "006" + custom: + additionalProperties: {} + description: Custom data for the reaction + title: Custom Data + type: object x-stream-index: "005" - start_time: - description: Start time of the status period + type: + description: Type of reaction + title: Type + type: string + x-stream-index: "004" + updated_at: + description: When the reaction was last updated format: date-time - title: time.Time + title: Updated At type: number - x-stream-index: "002" - summary: - $ref: '#/components/schemas/ActiveCallsSummary' - description: Summary of active calls - title: '*ActiveCallsSummary' - x-stream-index: "004" + x-stream-index: "007" + user: + $ref: '#/components/schemas/UserResponse' + description: User who created the reaction + title: User + x-stream-index: "001" required: - - duration - - start_time - - end_time - title: GetActiveCallsStatusResponse + - user + - activity_id + - type + - created_at + - updated_at + title: Activity Reaction type: object - GetApplicationResponse: - description: Basic response information + Field: nullable: true properties: - app: - $ref: '#/components/schemas/AppResponseFields' + short: + type: boolean + x-stream-index: "003" + title: + type: string x-stream-index: "001" - duration: - description: Duration of the request in milliseconds - title: Duration + value: type: string - x-stream-index: "002.001" + x-stream-index: "002" required: - - app - - duration - title: Response + - title + - value + - short type: object - GetBlockListResponse: - description: Response for get block list - nullable: true + FileUploadConfig: properties: - blocklist: - $ref: '#/components/schemas/BlockListResponse' - description: Block list object - title: BlockListResponse + allowed_file_extensions: + items: + type: string + type: array x-stream-index: "001" - duration: - type: string - x-stream-index: "002.001" + allowed_mime_types: + items: + type: string + type: array + x-stream-index: "003" + blocked_file_extensions: + items: + type: string + type: array + x-stream-index: "002" + blocked_mime_types: + items: + type: string + type: array + x-stream-index: "004" + size_limit: + format: int32 + maximum: 104857600 + minimum: 0 + type: integer + x-stream-index: "005" required: - - duration - title: GetBlockListResponse + - size_limit type: object - x-stream-docs-page-id: get_block_list - GetBlockedUsersResponse: + FileUploadRequest: nullable: true properties: - blocks: - description: Array of blocked user object - items: - $ref: '#/components/schemas/BlockedUserResponse' - title: Blocks - type: array + file: + description: file field + title: File + type: string x-stream-index: "001" + user: + $ref: '#/components/schemas/OnlyUserID' + description: user for the request **server side only** + title: User + x-stream-index: "002" + type: object + FileUploadResponse: + nullable: true + properties: duration: description: Duration of the request in milliseconds title: Duration type: string - x-stream-index: "002.001" + x-stream-index: "003.001" + file: + description: URL to the uploaded asset. Should be used to put to `asset_url` + attachment field + title: File + type: string + x-stream-index: "001" + thumb_url: + description: URL of the file thumbnail for supported file formats. Should + be put to `thumb_url` attachment field + title: Thumbnail URL + type: string + x-stream-index: "002" required: - - blocks - duration type: object - GetCallReportResponse: - description: Basic response information - nullable: true + FirebaseConfig: properties: - chat_activity: - $ref: '#/components/schemas/ChatActivityStatsResponse' + Disabled: + type: boolean + writeOnly: true + x-stream-index: "001" + apn_template: + type: string + x-stream-index: "005" + credentials_json: + type: string + x-stream-index: "006" + data_template: + type: string x-stream-index: "004" - duration: - description: Duration of the request in milliseconds - title: Duration + notification_template: type: string - x-stream-index: "001.001" - report: - $ref: '#/components/schemas/ReportResponse' x-stream-index: "003" - session_id: + server_key: type: string x-stream-index: "002" - video_reactions: - items: - $ref: '#/components/schemas/VideoReactionsResponse' - type: array - x-stream-index: "005" - required: - - duration - - session_id - - report - title: Response type: object - GetCallResponse: - nullable: true + FirebaseConfigFields: properties: - call: - $ref: '#/components/schemas/CallResponse' - x-stream-index: "001.001" - duration: + apn_template: type: string - x-stream-index: "002.001" - members: - items: - $ref: '#/components/schemas/MemberResponse' - type: array - x-stream-index: "001.002" - own_capabilities: - items: - $ref: '#/components/schemas/OwnCapability' - type: array - x-stream-index: "001.004" + x-stream-index: "004" + credentials_json: + type: string + x-stream-index: "006" + data_template: + type: string + x-stream-index: "003" + enabled: + type: boolean + x-stream-index: "001" + notification_template: + type: string + x-stream-index: "002" + server_key: + type: string + x-stream-index: "005" required: - - call - - members - - own_capabilities - - blocked_users - - duration - title: GetCallResponse + - enabled type: object - GetCallTypeResponse: + Flag: + description: Contains information about flagged user or message nullable: true properties: created_at: + description: Date/time of creation format: date-time + title: Created at type: number - x-stream-index: "001.005" - duration: + x-stream-index: "019" + custom: + additionalProperties: {} + description: Additional metadata about the flag + title: Custom + type: object + x-stream-index: "014" + entity_creator_id: + description: ID of the user who created the flagged entity + title: Entity Creator ID type: string - x-stream-index: "002.001" - external_storage: + x-stream-index: "009" + entity_id: + description: Unique identifier of the entity being flagged + title: Entity ID type: string - x-stream-index: "001.007" - grants: - additionalProperties: - items: - type: string - type: array - type: object - x-stream-index: "001.002" - name: + x-stream-index: "008" + entity_type: + description: Type of entity being flagged (e.g., message, user) + title: Entity Type type: string - x-stream-index: "001.001" - notification_settings: - $ref: '#/components/schemas/NotificationSettings' - x-stream-index: "001.004" - settings: - $ref: '#/components/schemas/CallSettingsResponse' - x-stream-index: "001.003" + x-stream-index: "007" + is_streamed_content: + type: boolean + x-stream-index: "012" + labels: + description: Labels from bodyguard, API calls, our own AI etc + items: + type: string + title: Labels + type: array + x-stream-index: "015" + moderation_payload: + $ref: '#/components/schemas/ModerationPayload' + description: Content being flagged + title: Moderation Payload + x-stream-index: "010" + moderation_payload_hash: + type: string + x-stream-index: "011" + reason: + description: Optional explanation for why the content is being flagged + title: Reason + type: string + x-stream-index: "013" + result: + description: Result of bodyguard, API calls, our own AI etc + items: + additionalProperties: {} + type: object + title: Result + type: array + x-stream-index: "016" + review_queue_item: + $ref: '#/components/schemas/ReviewQueueItem' + x-stream-index: "018" + review_queue_item_id: + description: ID of the review queue item + title: Review Queue Item ID + type: string + x-stream-index: "017" + type: + type: string + x-stream-index: "004" updated_at: + description: Date/time of the last update format: date-time + title: Updated at type: number - x-stream-index: "001.006" + x-stream-index: "020" + user: + $ref: '#/components/schemas/User' + description: User who flagged a message or a user + title: User + x-stream-index: "006" required: - - name - - grants - - settings - - notification_settings + - entity_type + - entity_id + - result - created_at - updated_at - - duration - title: GetCallTypeResponse + title: Flag type: object - GetCampaignResponse: - description: Basic response information - nullable: true + FlagContentOptions: properties: - campaign: - $ref: '#/components/schemas/CampaignResponse' - x-stream-index: "001" - duration: - description: Duration of the request in milliseconds - title: Duration + reason: type: string - x-stream-index: "003.001" - users: - $ref: '#/components/schemas/PagerResponse' - x-stream-index: "002" - required: - - duration - title: Response + x-stream-index: "001" type: object - GetChannelTypeResponse: - description: Basic response information - nullable: true + FlagDetails: properties: - allowed_flag_reasons: - items: - type: string - type: array - x-stream-index: 003.002.026 + Extra: + additionalProperties: {} + type: object + writeOnly: true + x-stream-index: "002" automod: - enum: - - disabled - - simple - - AI - type: string - x-stream-index: 003.002.021 - automod_behavior: - enum: - - flag - - block - - shadow_block - type: string - x-stream-index: 003.002.022 - automod_thresholds: - $ref: '#/components/schemas/Thresholds' - x-stream-index: 003.002.027 - blocklist: - type: string - x-stream-index: 003.002.023 - blocklist_behavior: - enum: - - flag - - block - - shadow_block + $ref: '#/components/schemas/AutomodDetails' + x-stream-index: "001" + original_text: type: string - x-stream-index: 003.002.024 - blocklists: - items: - $ref: '#/components/schemas/BlockListOptions' - type: array - x-stream-index: 003.002.025 - commands: - items: - $ref: '#/components/schemas/Command' - type: array - x-stream-index: "003.003" - connect_events: - type: boolean - x-stream-index: 003.002.004 + x-stream-index: "003" + required: + - Extra + - original_text + type: object + FlagFeedback: + properties: created_at: format: date-time type: number - x-stream-index: 003.001.003 - custom_events: - type: boolean - x-stream-index: 003.002.012 - duration: - description: Duration of the request in milliseconds - title: Duration + x-stream-index: "005" + labels: + items: + $ref: '#/components/schemas/Label' + type: array + x-stream-index: "006" + message_id: type: string - x-stream-index: "004.001" - grants: - additionalProperties: - items: - type: string - type: array - type: object + x-stream-index: "004" + required: + - message_id + - created_at + - labels + type: object + FlagMessageDetails: + properties: + pin_changed: + type: boolean x-stream-index: "002" - mark_messages_pending: + should_enrich: type: boolean - x-stream-index: 003.002.015 - max_message_length: - format: int32 - maximum: 20000 - type: integer - x-stream-index: 003.002.020 - mutes: + x-stream-index: "003" + skip_push: type: boolean - x-stream-index: 003.002.009 - name: - type: string - x-stream-index: 003.002.001 - partition_size: - format: int32 - type: integer - x-stream-index: 003.002.028 - partition_ttl: - example: 24h - format: duration - nullable: true + x-stream-index: "004" + updated_by_id: type: string - x-stream-index: 003.002.029 - permissions: - items: - $ref: '#/components/schemas/PolicyRequest' - type: array x-stream-index: "001" - polls: - type: boolean - x-stream-index: 003.002.016 - push_notifications: - type: boolean - x-stream-index: 003.002.013 - quotes: - type: boolean - x-stream-index: 003.002.008 - reactions: - type: boolean - x-stream-index: 003.002.006 - read_events: - type: boolean - x-stream-index: 003.002.003 - reminders: - type: boolean - x-stream-index: 003.002.014 - replies: - type: boolean - x-stream-index: 003.002.007 - search: - type: boolean - x-stream-index: 003.002.005 - shared_locations: - type: boolean - x-stream-index: 003.002.018 - skip_last_msg_update_for_system_msgs: - type: boolean - x-stream-index: 003.002.030 - typing_events: - type: boolean - x-stream-index: 003.002.002 - updated_at: - format: date-time - type: number - x-stream-index: 003.001.004 - uploads: - type: boolean - x-stream-index: 003.002.010 - url_enrichment: - type: boolean - x-stream-index: 003.002.011 - user_message_reminders: - type: boolean - x-stream-index: 003.002.017 - required: - - permissions - - grants - - created_at - - updated_at - - name - - typing_events - - read_events - - connect_events - - search - - reactions - - replies - - quotes - - mutes - - uploads - - url_enrichment - - custom_events - - push_notifications - - reminders - - mark_messages_pending - - polls - - user_message_reminders - - shared_locations - - message_retention - - max_message_length - - automod - - automod_behavior - - skip_last_msg_update_for_system_msgs - - commands - - duration - title: Response type: object - GetCommandResponse: + FlagRequest: nullable: true properties: - args: + custom: + additionalProperties: {} + description: Additional metadata about the flag + title: Custom + type: object + x-stream-index: "006" + entity_creator_id: + description: ID of the user who created the flagged entity + title: Entity Creator ID type: string - x-stream-index: "001.006" - created_at: - format: date-time - readOnly: true - type: number - x-stream-index: "001.001" - description: + x-stream-index: "003" + entity_id: + description: Unique identifier of the entity being flagged + title: Entity ID type: string - x-stream-index: "001.005" - duration: + x-stream-index: "002" + entity_type: + description: Type of entity being flagged (e.g., message, user) + title: Entity Type type: string - x-stream-index: "002.001" - name: + x-stream-index: "001" + moderation_payload: + $ref: '#/components/schemas/ModerationPayload' + description: Content being flagged + title: Moderation Payload + x-stream-index: "005" + reason: + description: Optional explanation for why the content is being flagged + maxLength: 255 + title: Reason type: string - x-stream-index: "001.004" - set: + x-stream-index: "004" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "007.002" + user_id: type: string - x-stream-index: "001.007" - updated_at: - format: date-time - readOnly: true - type: number - x-stream-index: "001.002" + x-stream-index: "007.001" required: - - name - - description - - args - - set - - duration - title: GetCommandResponse + - entity_type + - entity_id type: object - GetConfigResponse: + FlagResponse: nullable: true properties: - config: - $ref: '#/components/schemas/ConfigResponse' - description: The retrieved moderation configuration - title: Config - x-stream-index: "001" duration: type: string x-stream-index: "002.001" + item_id: + description: Unique identifier of the created moderation item + title: Item ID + type: string + x-stream-index: "001" required: + - item_id - duration type: object - GetCustomPermissionResponse: - description: Basic response information + FlagUpdatedEvent: nullable: true properties: - duration: - description: Duration of the request in milliseconds - title: Duration + CreatedBy: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "004" + Message: + $ref: '#/components/schemas/MessageResponse' + x-stream-index: "002" + User: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "003" + created_at: + format: date-time + type: number + x-stream-index: "001.003" + custom: + additionalProperties: {} + type: object + x-stream-index: "001.007" + received_at: + format: date-time + type: number + x-stream-index: "001.004" + type: + default: flag.updated type: string - x-stream-index: "002.001" - permission: - $ref: '#/components/schemas/Permission' - x-stream-index: "001" + x-stream-index: "001.002" required: - - permission - - duration - title: Response + - type + - created_at + - custom + title: FlagUpdatedEvent type: object - GetDraftResponse: - description: Basic response information + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + FlagUserOptions: + properties: + reason: + type: string + x-stream-index: "001" + type: object + FollowBatchRequest: nullable: true properties: - draft: - $ref: '#/components/schemas/DraftResponse' + follows: + description: List of follow relationships to create + items: + $ref: '#/components/schemas/FollowRequest' + maximum: 1000 + minimum: 1 + title: Follows + type: array x-stream-index: "001" - duration: - description: Duration of the request in milliseconds - title: Duration - type: string - x-stream-index: "002.001" required: - - draft - - duration - title: Response + - follows + title: Follow Batch Request type: object - GetEdgesResponse: - description: Basic response information + FollowBatchResponse: nullable: true properties: duration: - description: Duration of the request in milliseconds - title: Duration type: string x-stream-index: "002.001" - edges: + follows: + description: List of created follow relationships items: - $ref: '#/components/schemas/EdgeResponse' + $ref: '#/components/schemas/FollowResponse' + title: Follows type: array x-stream-index: "001" required: - - edges + - follows - duration - title: Response + title: Follow Batch Response type: object - GetImportResponse: - description: Basic response information + FollowCreatedEvent: + description: Emitted when a feed follows another feed. nullable: true properties: - duration: - description: Duration of the request in milliseconds - title: Duration + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + feed_visibility: type: string - x-stream-index: "002.001" - import_task: - $ref: '#/components/schemas/ImportTask' + x-stream-index: "002.003" + fid: + type: string + x-stream-index: "002.002" + follow: + $ref: '#/components/schemas/FollowResponse' x-stream-index: "001" + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 + type: + default: feeds.follow.created + description: 'The type of event: "feeds.follow.created" in this case' + title: Event Type + type: string + x-stream-index: 002.001.002 required: - - duration - title: Response + - follow + - type + - created_at + - custom + - fid + title: FollowCreatedEvent type: object - GetManyMessagesResponse: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + FollowDeletedEvent: + description: Emitted when a feed unfollows another feed. nullable: true properties: - duration: + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + feed_visibility: type: string - x-stream-index: 001.002.001 - messages: - description: List of messages - items: - $ref: '#/components/schemas/MessageResponse' - title: Messages - type: array - x-stream-index: "001.001" + x-stream-index: "002.003" + fid: + type: string + x-stream-index: "002.002" + follow: + $ref: '#/components/schemas/FollowResponse' + x-stream-index: "001" + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 + type: + default: feeds.follow.deleted + description: 'The type of event: "feeds.follow.deleted" in this case' + title: Event Type + type: string + x-stream-index: 002.001.002 required: - - messages - - duration + - follow + - type + - created_at + - custom + - fid + title: FollowDeletedEvent type: object - GetMessageResponse: - description: Basic response information - nullable: true + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + FollowPair: properties: - duration: - description: Duration of the request in milliseconds - title: Duration + source: + description: Fully qualified ID of the source feed + maxLength: 255 + title: Source Feed type: string - x-stream-index: "003.001" - message: - $ref: '#/components/schemas/MessageWithChannelResponse' x-stream-index: "001" - pending_message_metadata: - additionalProperties: - type: string - type: object + target: + description: Fully qualified ID of the target feed + maxLength: 255 + title: Target Feed + type: string x-stream-index: "002" required: - - message - - duration - title: Response + - source + - target + title: FollowPair type: object - GetOGResponse: + FollowRequest: nullable: true properties: - actions: - items: - $ref: '#/components/schemas/Action' - type: array - x-stream-index: "001.015" - asset_url: - description: URL of detected video or audio - title: Image URL - type: string - x-stream-index: "001.017" - author_icon: - type: string - x-stream-index: "001.007" - author_link: - description: og:site - title: Author Link + create_notification_activity: + description: Whether to create a notification activity for this follow + title: Create Notification Activity + type: boolean + x-stream-index: "004" + custom: + additionalProperties: {} + description: Custom data for the follow relationship + title: Custom Data + type: object + x-stream-index: "002" + push_preference: + description: Push preference for the follow relationship + enum: + - all + - none + title: Push Preference type: string - x-stream-index: "001.006" - author_name: - description: og:site_name - title: Author Name + x-stream-index: "003" + skip_push: + type: boolean + x-stream-index: "005" + source: + description: Fully qualified ID of the source feed + maxLength: 255 + title: Source Feed type: string - x-stream-index: "001.005" - color: + x-stream-index: "001.001" + target: + description: Fully qualified ID of the target feed + maxLength: 255 + title: Target Feed type: string - x-stream-index: "001.003" + x-stream-index: "001.002" + required: + - source + - target + title: Follow Request + type: object + FollowResponse: + properties: + created_at: + description: When the follow relationship was created + format: date-time + title: Created At + type: number + x-stream-index: "009" custom: additionalProperties: {} + description: Custom data for the follow relationship + title: Custom Data type: object - x-stream-index: "001.018" - duration: + x-stream-index: "004" + follower_role: + description: Role of the follower (source user) in the follow relationship + title: Follower Role type: string - x-stream-index: "002.001" - fallback: + x-stream-index: "008" + push_preference: + description: Push preference for notifications + enum: + - all + - none + title: Push Preference type: string - x-stream-index: "001.002" - fields: - items: - $ref: '#/components/schemas/Field' - type: array - x-stream-index: "001.016" - footer: + x-stream-index: "003" + request_accepted_at: + description: When the follow request was accepted + format: date-time + title: Request Accepted At + type: number + x-stream-index: "005" + request_rejected_at: + description: When the follow request was rejected + format: date-time + title: Request Rejected At + type: number + x-stream-index: "006" + source_feed: + $ref: '#/components/schemas/FeedResponse' + description: Source feed object + title: Source Feed + x-stream-index: "001" + status: + description: Status of the follow relationship + enum: + - accepted + - pending + - rejected + title: Status type: string - x-stream-index: "001.013" - footer_icon: + x-stream-index: "007" + target_feed: + $ref: '#/components/schemas/FeedResponse' + description: Target feed object + title: Target Feed + x-stream-index: "002" + updated_at: + description: When the follow relationship was last updated + format: date-time + title: Updated At + type: number + x-stream-index: "010" + required: + - source_feed + - target_feed + - push_preference + - status + - follower_role + - created_at + - updated_at + title: Follow + type: object + FollowUpdatedEvent: + description: Emitted when a follow relationship is updated. + nullable: true + properties: + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + feed_visibility: type: string - x-stream-index: "001.014" - giphy: - $ref: '#/components/schemas/Images' - x-stream-index: "001.019" - image_url: - description: URL of detected image - title: Image URL + x-stream-index: "002.003" + fid: type: string - x-stream-index: "001.011" - og_scrape_url: - description: extracted url from the text - title: OG Scrape URL + x-stream-index: "002.002" + follow: + $ref: '#/components/schemas/FollowResponse' + x-stream-index: "001" + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 + type: + default: feeds.follow.updated + description: 'The type of event: "feeds.follow.updated" in this case' + title: Event Type type: string - x-stream-index: "001.020" - original_height: - format: int32 - type: integer - x-stream-index: "001.022" - original_width: + x-stream-index: 002.001.002 + required: + - follow + - type + - created_at + - custom + - fid + title: FollowUpdatedEvent + 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 + FrameRecordSettings: + properties: + capture_interval_in_seconds: format: int32 + maximum: 60 + minimum: 2 type: integer - x-stream-index: "001.021" - pretext: - type: string - x-stream-index: "001.004" - text: - description: og:description - title: Text - type: string - x-stream-index: "001.010" - thumb_url: - description: URL of detected thumb image - title: Image URL - type: string - x-stream-index: "001.012" - title: - description: og:title - title: Title - type: string - x-stream-index: "001.008" - title_link: - description: og:url - title: Title Link + x-stream-index: "003" + mode: + enum: + - available + - disabled + - auto-on type: string - x-stream-index: "001.009" - type: - description: Attachment type, could be empty, image, audio or video - title: Type + x-stream-index: "001" + quality: type: string - x-stream-index: "001.001" + x-stream-index: "002" required: - - custom - - duration - title: Get OG Attachment + - mode + - capture_interval_in_seconds type: object - x-stream-docs-page-id: og - GetOrCreateCallRequest: - nullable: true + FrameRecordingEgressConfig: properties: - data: - $ref: '#/components/schemas/CallRequest' - title: ReadOnlyData - x-stream-index: "003" - members_limit: + capture_interval_in_seconds: format: int32 - maximum: 100 type: integer x-stream-index: "007" - notify: - description: if provided it sends a notification event to the members for - this call - title: Notify - type: boolean - x-stream-index: "005" - ring: - description: if provided it sends a ring event to the members for this call - title: Ring - type: boolean - x-stream-index: "004" - video: - type: boolean + external_storage: + $ref: '#/components/schemas/ExternalStorage' x-stream-index: "006" - title: GetOrCreateCallRequest + quality: + $ref: '#/components/schemas/Quality' + x-stream-index: "004" + storage_name: + type: string + x-stream-index: "005" type: object - GetOrCreateCallResponse: - nullable: true + FrameRecordingResponse: properties: - call: - $ref: '#/components/schemas/CallResponse' + status: + type: string + x-stream-index: "001" + required: + - status + type: object + FrameRecordingSettingsRequest: + properties: + capture_interval_in_seconds: + format: int32 + maximum: 60 + minimum: 2 + type: integer + x-stream-index: "003" + mode: + enum: + - available + - disabled + - auto-on + type: string + x-stream-index: "001" + quality: + enum: + - 360p + - 480p + - 720p + - 1080p + - 1440p + type: string + x-stream-index: "002" + required: + - mode + - capture_interval_in_seconds + type: object + FrameRecordingSettingsResponse: + properties: + capture_interval_in_seconds: + format: int32 + maximum: 60 + minimum: 2 + type: integer + x-stream-index: "003" + mode: + enum: + - available + - disabled + - auto-on + type: string + x-stream-index: "001" + quality: + type: string + x-stream-index: "002" + required: + - mode + - capture_interval_in_seconds + type: object + FullUserResponse: + properties: + avg_response_time: + format: int32 + type: integer + x-stream-index: "001.018" + ban_expires: + format: date-time + type: number + x-stream-index: "015" + banned: + type: boolean + x-stream-index: "001.012" + blocked_user_ids: + items: + type: string + type: array + x-stream-index: "014" + channel_mutes: + items: + $ref: '#/components/schemas/ChannelMute' + type: array + x-stream-index: "007" + created_at: + format: date-time + type: number + x-stream-index: "001.009" + custom: + additionalProperties: {} + type: object + x-stream-index: "001.004" + deactivated_at: + format: date-time + type: number + x-stream-index: "001.016" + deleted_at: + format: date-time + type: number + x-stream-index: "001.011" + devices: + items: + $ref: '#/components/schemas/DeviceResponse' + type: array + x-stream-index: "004" + id: + type: string x-stream-index: "001.001" - created: + image: + type: string + x-stream-index: "001.003" + invisible: type: boolean - x-stream-index: "002" - duration: + x-stream-index: "005" + language: type: string - x-stream-index: "003.001" - members: + x-stream-index: "001.005" + last_active: + format: date-time + type: number + x-stream-index: "001.014" + latest_hidden_channels: items: - $ref: '#/components/schemas/MemberResponse' + type: string + type: array + x-stream-index: "012" + mutes: + items: + $ref: '#/components/schemas/UserMuteResponse' type: array + x-stream-index: "006" + name: + type: string x-stream-index: "001.002" - own_capabilities: + online: + type: boolean + x-stream-index: "001.013" + privacy_settings: + $ref: '#/components/schemas/PrivacySettingsResponse' + x-stream-index: "003" + revoke_tokens_issued_before: + format: date-time + type: number + x-stream-index: "001.015" + role: + type: string + x-stream-index: "001.006" + shadow_banned: + type: boolean + x-stream-index: "013" + teams: items: - $ref: '#/components/schemas/OwnCapability' + type: string type: array - x-stream-index: "001.004" + x-stream-index: "001.007" + teams_role: + additionalProperties: + type: string + type: object + x-stream-index: "001.008" + total_unread_count: + format: int32 + type: integer + x-stream-index: "009" + unread_channels: + format: int32 + type: integer + x-stream-index: "010" + unread_count: + format: int32 + type: integer + x-stream-index: "008" + unread_threads: + format: int32 + type: integer + x-stream-index: "011" + updated_at: + format: date-time + type: number + x-stream-index: "001.010" required: - - call - - members - - own_capabilities - - blocked_users - - created - - duration - title: GetOrCreateCallResponse + - id + - custom + - language + - role + - teams + - created_at + - updated_at + - banned + - online + - devices + - invisible + - mutes + - channel_mutes + - unread_count + - total_unread_count + - unread_channels + - unread_threads + - shadow_banned + - blocked_user_ids type: object - GetPushTemplatesResponse: - description: Basic response information + GeofenceResponse: nullable: true properties: - duration: - description: Duration of the request in milliseconds - title: Duration - type: string - x-stream-index: "001.001" - templates: + country_codes: items: - $ref: '#/components/schemas/PushTemplate' + type: string type: array + x-stream-index: "004" + description: + type: string + x-stream-index: "003" + name: + type: string + x-stream-index: "001" + type: + type: string x-stream-index: "002" required: - - duration - - templates - title: Response + - name type: object - GetRateLimitsResponse: + GeofenceSettings: + properties: + names: + items: + type: string + type: array + x-stream-index: "001" + required: + - names + type: object + GeofenceSettingsRequest: + properties: + names: + items: + type: string + type: array + x-stream-index: "001" + type: object + GeofenceSettingsResponse: + properties: + names: + items: + type: string + type: array + x-stream-index: "001" + required: + - names + type: object + GetActiveCallsStatusResponse: + description: Response containing active calls status information nullable: true properties: - android: - additionalProperties: - $ref: '#/components/schemas/LimitInfo' - description: Map of endpoint rate limits for the Android platform - title: Android - type: object - x-stream-index: "002" - x-stream-map: - description: The name of the endpoint for which the limits apply - key: endpoint - title: Endpoint name duration: type: string - x-stream-index: "005.001" - ios: - additionalProperties: - $ref: '#/components/schemas/LimitInfo' - description: Map of endpoint rate limits for the iOS platform - title: iOS - type: object + x-stream-index: "001.001" + end_time: + description: End time of the status period + format: date-time + title: time.Time + type: number x-stream-index: "003" - x-stream-map: - description: The name of the endpoint for which the limits apply - key: endpoint - title: Endpoint name - server_side: - additionalProperties: - $ref: '#/components/schemas/LimitInfo' - description: Map of endpoint rate limits for the server-side platform - title: Server-side - type: object - x-stream-index: "001" - x-stream-map: - description: The name of the endpoint for which the limits apply - key: endpoint - title: Endpoint name - web: - additionalProperties: - $ref: '#/components/schemas/LimitInfo' - description: Map of endpoint rate limits for the web platform - title: Web - type: object + metrics: + $ref: '#/components/schemas/ActiveCallsMetrics' + description: Detailed metrics + title: '*ActiveCallsMetrics' + x-stream-index: "005" + start_time: + description: Start time of the status period + format: date-time + title: time.Time + type: number + x-stream-index: "002" + summary: + $ref: '#/components/schemas/ActiveCallsSummary' + description: Summary of active calls + title: '*ActiveCallsSummary' x-stream-index: "004" - x-stream-map: - description: The name of the endpoint for which the limits apply - key: endpoint - title: Endpoint name required: - duration - title: Get Rate Limits Response + - start_time + - end_time + title: GetActiveCallsStatusResponse type: object - x-stream-docs-page-id: rate_limits - GetReactionsResponse: + GetActivityResponse: nullable: true properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + description: The requested activity + title: Activity + x-stream-index: "001" duration: type: string x-stream-index: "002.001" - reactions: - description: List of reactions - items: - $ref: '#/components/schemas/Reaction' - title: Reactions - type: array - x-stream-index: "001" required: - - reactions + - activity - duration + title: Get Activity Response type: object - GetRepliesResponse: + GetApplicationResponse: description: Basic response information nullable: true properties: + app: + $ref: '#/components/schemas/AppResponseFields' + x-stream-index: "001" duration: description: Duration of the request in milliseconds title: Duration type: string x-stream-index: "002.001" - messages: - items: - $ref: '#/components/schemas/MessageResponse' - type: array - x-stream-index: "001" required: - - messages + - app - duration title: Response type: object - GetReviewQueueItemResponse: + GetBlockListResponse: + description: Response for get block list nullable: true properties: + blocklist: + $ref: '#/components/schemas/BlockListResponse' + description: Block list object + title: BlockListResponse + x-stream-index: "001" duration: type: string x-stream-index: "002.001" - item: - $ref: '#/components/schemas/ReviewQueueItemResponse' - description: Current state of the review queue item - title: Item + required: + - duration + title: GetBlockListResponse + type: object + x-stream-docs-page-id: get_block_list + GetBlockedUsersResponse: + nullable: true + properties: + blocks: + description: Array of blocked user object + items: + $ref: '#/components/schemas/BlockedUserResponse' + title: Blocks + type: array x-stream-index: "001" + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "002.001" required: + - blocks - duration type: object - GetSegmentResponse: + GetCallReportResponse: + description: Basic response information nullable: true properties: + chat_activity: + $ref: '#/components/schemas/ChatActivityStatsResponse' + x-stream-index: "004" duration: description: Duration of the request in milliseconds title: Duration + type: string + x-stream-index: "001.001" + report: + $ref: '#/components/schemas/ReportResponse' + x-stream-index: "003" + session_id: + type: string + x-stream-index: "002" + video_reactions: + items: + $ref: '#/components/schemas/VideoReactionsResponse' + type: array + x-stream-index: "005" + required: + - duration + - session_id + - report + title: Response + type: object + GetCallResponse: + nullable: true + properties: + call: + $ref: '#/components/schemas/CallResponse' + x-stream-index: "001.001" + duration: type: string x-stream-index: "002.001" - segment: - $ref: '#/components/schemas/SegmentResponse' - description: Segment - title: SegmentResponse - x-stream-index: "001" + members: + items: + $ref: '#/components/schemas/MemberResponse' + type: array + x-stream-index: "001.002" + own_capabilities: + items: + $ref: '#/components/schemas/OwnCapability' + type: array + x-stream-index: "001.004" required: + - call + - members + - own_capabilities + - blocked_users - duration + title: GetCallResponse type: object - GetTaskResponse: + GetCallTypeResponse: nullable: true properties: created_at: format: date-time type: number - x-stream-index: "001.003" + x-stream-index: "001.005" duration: type: string - x-stream-index: "004.001" - error: - $ref: '#/components/schemas/ErrorResult' - description: Error produced by task - title: Error - x-stream-index: "003" - result: - additionalProperties: {} - description: Result produced by task after completion - title: Result - type: object - x-stream-index: "002" - status: - description: Current status of task - title: Status + x-stream-index: "002.001" + external_storage: type: string + x-stream-index: "001.007" + grants: + additionalProperties: + items: + type: string + type: array + type: object x-stream-index: "001.002" - task_id: - description: ID of task - title: Task ID + name: type: string x-stream-index: "001.001" + notification_settings: + $ref: '#/components/schemas/NotificationSettings' + x-stream-index: "001.004" + settings: + $ref: '#/components/schemas/CallSettingsResponse' + x-stream-index: "001.003" updated_at: format: date-time type: number - x-stream-index: "001.004" + x-stream-index: "001.006" required: - - task_id - - status + - name + - grants + - settings + - notification_settings - created_at - updated_at - duration - title: Get Task Response + title: GetCallTypeResponse type: object - x-stream-docs-page-id: tasks - GetThreadResponse: + GetCampaignResponse: + description: Basic response information nullable: true properties: + campaign: + $ref: '#/components/schemas/CampaignResponse' + x-stream-index: "001" duration: + description: Duration of the request in milliseconds + title: Duration type: string - x-stream-index: "002.001" - thread: - $ref: '#/components/schemas/ThreadStateResponse' - description: Enriched thread state - title: Thread - x-stream-index: "001" + x-stream-index: "003.001" + users: + $ref: '#/components/schemas/PagerResponse' + x-stream-index: "002" required: - - thread - duration + title: Response type: object - GoLiveRequest: + GetChannelTypeResponse: + description: Basic response information nullable: true properties: - recording_storage_name: + allowed_flag_reasons: + items: + type: string + type: array + x-stream-index: 003.002.027 + automod: + enum: + - disabled + - simple + - AI type: string - x-stream-index: "005" - start_closed_caption: - type: boolean - x-stream-index: "008" - start_hls: + x-stream-index: 003.002.022 + automod_behavior: + enum: + - flag + - block + - shadow_block + type: string + x-stream-index: 003.002.023 + automod_thresholds: + $ref: '#/components/schemas/Thresholds' + x-stream-index: 003.002.028 + blocklist: + type: string + x-stream-index: 003.002.024 + blocklist_behavior: + enum: + - flag + - block + - shadow_block + type: string + x-stream-index: 003.002.025 + blocklists: + items: + $ref: '#/components/schemas/BlockListOptions' + type: array + x-stream-index: 003.002.026 + commands: + items: + $ref: '#/components/schemas/Command' + type: array + x-stream-index: "003.003" + connect_events: type: boolean - x-stream-index: "003" - start_recording: + x-stream-index: 003.002.004 + count_messages: type: boolean - x-stream-index: "004" - start_transcription: + x-stream-index: 003.002.019 + created_at: + format: date-time + type: number + x-stream-index: 003.001.003 + custom_events: type: boolean - x-stream-index: "007" - transcription_storage_name: - type: string - x-stream-index: "006" - title: GoLiveRequest - type: object - GoLiveResponse: - description: Basic response information - nullable: true - properties: - call: - $ref: '#/components/schemas/CallResponse' - x-stream-index: "001" + x-stream-index: 003.002.012 duration: description: Duration of the request in milliseconds title: Duration type: string - x-stream-index: "002.001" + x-stream-index: "004.001" + grants: + additionalProperties: + items: + type: string + type: array + type: object + x-stream-index: "002" + mark_messages_pending: + type: boolean + x-stream-index: 003.002.015 + max_message_length: + format: int32 + maximum: 20000 + type: integer + x-stream-index: 003.002.021 + mutes: + type: boolean + x-stream-index: 003.002.009 + name: + type: string + x-stream-index: 003.002.001 + partition_size: + format: int32 + type: integer + x-stream-index: 003.002.029 + partition_ttl: + example: 24h + format: duration + nullable: true + type: string + x-stream-index: 003.002.030 + permissions: + items: + $ref: '#/components/schemas/PolicyRequest' + type: array + x-stream-index: "001" + polls: + type: boolean + x-stream-index: 003.002.016 + push_notifications: + type: boolean + x-stream-index: 003.002.013 + quotes: + type: boolean + x-stream-index: 003.002.008 + reactions: + type: boolean + x-stream-index: 003.002.006 + read_events: + type: boolean + x-stream-index: 003.002.003 + reminders: + type: boolean + x-stream-index: 003.002.014 + replies: + type: boolean + x-stream-index: 003.002.007 + search: + type: boolean + x-stream-index: 003.002.005 + shared_locations: + type: boolean + x-stream-index: 003.002.018 + skip_last_msg_update_for_system_msgs: + type: boolean + x-stream-index: 003.002.031 + typing_events: + type: boolean + x-stream-index: 003.002.002 + updated_at: + format: date-time + type: number + x-stream-index: 003.001.004 + uploads: + type: boolean + x-stream-index: 003.002.010 + url_enrichment: + type: boolean + x-stream-index: 003.002.011 + user_message_reminders: + type: boolean + x-stream-index: 003.002.017 required: - - call + - permissions + - grants + - created_at + - updated_at + - name + - typing_events + - read_events + - connect_events + - search + - reactions + - replies + - quotes + - mutes + - uploads + - url_enrichment + - custom_events + - push_notifications + - reminders + - mark_messages_pending + - polls + - user_message_reminders + - shared_locations + - count_messages + - message_retention + - max_message_length + - automod + - automod_behavior + - skip_last_msg_update_for_system_msgs + - commands - duration title: Response type: object - GoogleVisionConfig: - properties: - enabled: - type: boolean - x-stream-index: "001" - type: object - GroupedStatsResponse: + GetCommandResponse: nullable: true properties: + args: + type: string + x-stream-index: "001.006" + created_at: + format: date-time + readOnly: true + type: number + x-stream-index: "001.001" + description: + type: string + x-stream-index: "001.005" + duration: + type: string + x-stream-index: "002.001" name: type: string - x-stream-index: "001" - unique: - format: int32 - type: integer - x-stream-index: "002" + x-stream-index: "001.004" + set: + type: string + x-stream-index: "001.007" + updated_at: + format: date-time + readOnly: true + type: number + x-stream-index: "001.002" required: - name - - unique + - description + - args + - set + - duration + title: GetCommandResponse type: object - HLSEgressConfig: + GetCommentRepliesResponse: + nullable: true properties: - composite_app_settings: - $ref: '#/components/schemas/CompositeAppSettings' - x-stream-index: "005" - playlist_url: - type: string - x-stream-index: "007" - qualities: + comments: + description: Threaded listing of replies to the comment items: - $ref: '#/components/schemas/Quality' + $ref: '#/components/schemas/ThreadedCommentResponse' + title: Comments type: array - x-stream-index: "004" - start_unix_nano: - format: int64 - type: integer - x-stream-index: "006" + x-stream-index: "001" + duration: + type: string + x-stream-index: "003.001" + next: + type: string + x-stream-index: "002.001" + prev: + type: string + x-stream-index: "002.002" + required: + - comments + - duration + title: Get Comment Replies Response type: object - HLSSettings: + GetCommentResponse: + nullable: true properties: - auto_on: - type: boolean + comment: + $ref: '#/components/schemas/CommentResponse' + description: Comment + title: Comment x-stream-index: "001" - enabled: - type: boolean - x-stream-index: "002" - layout: - $ref: '#/components/schemas/LayoutSettings' - x-stream-index: "004" - quality_tracks: - items: - type: string - type: array - x-stream-index: "003" + duration: + type: string + x-stream-index: "002.001" required: - - auto_on - - enabled - - quality_tracks + - comment + - duration + title: Get Comment Response type: object - HLSSettingsRequest: + GetCommentsResponse: + nullable: true properties: - auto_on: - type: boolean - x-stream-index: "001" - enabled: - type: boolean - x-stream-index: "002" - layout: - $ref: '#/components/schemas/LayoutSettingsRequest' - title: LayoutSettings - x-stream-index: "004" - quality_tracks: + comments: + description: Threaded listing for the activity items: - type: string - maximum: 3 - minimum: 1 + $ref: '#/components/schemas/ThreadedCommentResponse' + title: Comments type: array - x-stream-index: "003" + x-stream-index: "001" + duration: + type: string + x-stream-index: "003.001" + next: + type: string + x-stream-index: "002.001" + prev: + type: string + x-stream-index: "002.002" required: - - quality_tracks - title: HLSSettingsRequest + - comments + - duration + title: Get Comments Response type: object - HLSSettingsResponse: - description: HLSSettings is the payload for HLS settings + GetConfigResponse: + nullable: true properties: - auto_on: - title: Auto On - type: boolean + config: + $ref: '#/components/schemas/ConfigResponse' + description: The retrieved moderation configuration + title: Config x-stream-index: "001" - enabled: - title: Enabled - type: boolean - x-stream-index: "002" - layout: - $ref: '#/components/schemas/LayoutSettingsResponse' - title: Layout - x-stream-index: "004" - quality_tracks: - items: - type: string - title: Quality Tracks - type: array - x-stream-index: "003" + duration: + type: string + x-stream-index: "002.001" required: - - auto_on - - enabled - - quality_tracks - - layout - title: HLSSettingsResponse + - duration type: object - HarmConfig: + GetCustomPermissionResponse: + description: Basic response information + nullable: true properties: - action_sequences: - items: - $ref: '#/components/schemas/ActionSequence' - type: array + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "002.001" + permission: + $ref: '#/components/schemas/Permission' x-stream-index: "001" - severity: - type: integer - x-stream-index: "002" required: - - action_sequences - - severity + - permission + - duration + title: Response type: object - HideChannelRequest: + GetDraftResponse: + description: Basic response information nullable: true properties: - clear_history: - description: Whether to clear message history of the channel or not - title: Clear history - type: boolean + draft: + $ref: '#/components/schemas/DraftResponse' x-stream-index: "001" - user: - $ref: '#/components/schemas/UserRequest' - x-stream-index: "003.002" - user_id: + duration: + description: Duration of the request in milliseconds + title: Duration type: string - x-stream-index: "003.001" + x-stream-index: "002.001" + required: + - draft + - duration + title: Response type: object - HideChannelResponse: + GetEdgesResponse: description: Basic response information nullable: true properties: @@ -11833,2230 +15653,2650 @@ components: description: Duration of the request in milliseconds title: Duration type: string - x-stream-index: "001.001" + x-stream-index: "002.001" + edges: + items: + $ref: '#/components/schemas/EdgeResponse' + type: array + x-stream-index: "001" required: + - edges - duration title: Response type: object - HuaweiConfig: + GetFeedGroupResponse: + nullable: true properties: - Disabled: - type: boolean - writeOnly: true - x-stream-index: "003" - id: + duration: type: string + x-stream-index: "002.001" + feed_group: + $ref: '#/components/schemas/FeedGroupResponse' + description: The requested feed group + title: Feed Group x-stream-index: "001" - secret: - type: string - x-stream-index: "002" + required: + - feed_group + - duration + title: Get Feed Group Response type: object - HuaweiConfigFields: + GetFeedViewResponse: + nullable: true properties: - enabled: - type: boolean - x-stream-index: "001" - id: - type: string - x-stream-index: "002" - secret: + duration: type: string - x-stream-index: "003" + x-stream-index: "002.001" + feed_view: + $ref: '#/components/schemas/FeedViewResponse' + description: The requested feed view + title: Feed View + x-stream-index: "001" required: - - enabled + - feed_view + - duration + title: Get Feed View Response type: object - ImageContentParameters: + GetFollowSuggestionsResponse: + nullable: true properties: - harm_labels: + duration: + type: string + x-stream-index: "002.001" + suggestions: + description: List of suggested feeds to follow items: - type: string + $ref: '#/components/schemas/FeedResponse' + title: Suggestions type: array x-stream-index: "001" + required: + - suggestions + - duration + title: Follow Suggestions Response type: object - ImageData: + GetImportResponse: + description: Basic response information + nullable: true properties: - frames: - type: string - x-stream-index: "005" - height: - type: string - x-stream-index: "003" - size: - type: string - x-stream-index: "004" - url: + duration: + description: Duration of the request in milliseconds + title: Duration type: string + x-stream-index: "002.001" + import_task: + $ref: '#/components/schemas/ImportTask' x-stream-index: "001" - width: - type: string - x-stream-index: "002" required: - - url - - width - - height - - size - - frames + - duration + title: Response type: object - ImageRuleParameters: + GetManyMessagesResponse: + nullable: true properties: - harm_labels: + duration: + type: string + x-stream-index: 001.002.001 + messages: + description: List of messages items: - type: string + $ref: '#/components/schemas/MessageResponse' + title: Messages type: array - x-stream-index: "003" - threshold: - format: int32 - type: integer - x-stream-index: "001" - time_window: - type: string - x-stream-index: "002" + x-stream-index: "001.001" required: - - threshold - - time_window + - messages + - duration type: object - ImageSize: + GetMessageResponse: + description: Basic response information + nullable: true properties: - crop: - description: Crop mode - enum: - - top - - bottom - - left - - right - - center - title: Crop + duration: + description: Duration of the request in milliseconds + title: Duration type: string + x-stream-index: "003.001" + message: + $ref: '#/components/schemas/MessageWithChannelResponse' x-stream-index: "001" - height: - description: Target image height - format: int32 - title: Height - type: integer - x-stream-index: "003" - resize: - description: Resize method - enum: - - clip - - crop - - scale - - fill - title: Resize - type: string + pending_message_metadata: + additionalProperties: + type: string + type: object x-stream-index: "002" - width: - description: Target image width - format: int32 - title: Width - type: integer - x-stream-index: "004" - title: Image size configuration + required: + - message + - duration + title: Response type: object - ImageUploadRequest: + GetModerationRuleResponse: + description: Basic response information nullable: true properties: - file: + duration: + description: Duration of the request in milliseconds + title: Duration type: string x-stream-index: "001.001" - upload_sizes: - description: field with JSON-encoded array of image size configurations - items: - $ref: '#/components/schemas/ImageSize' - title: Upload sizes - type: array + rule: + $ref: '#/components/schemas/ModerationRuleV2Response' x-stream-index: "002" - user: - $ref: '#/components/schemas/OnlyUserID' - x-stream-index: "001.002" + required: + - duration + title: Response type: object - ImageUploadResponse: + GetOGResponse: nullable: true properties: - duration: - description: Duration of the request in milliseconds - title: Duration + actions: + items: + $ref: '#/components/schemas/Action' + type: array + x-stream-index: "001.015" + asset_url: + description: URL of detected video or audio + title: Image URL type: string - x-stream-index: 001.003.001 - file: + x-stream-index: "001.017" + author_icon: type: string - x-stream-index: "001.001" - thumb_url: + x-stream-index: "001.007" + author_link: + description: og:site + title: Author Link + type: string + x-stream-index: "001.006" + author_name: + description: og:site_name + title: Author Name + type: string + x-stream-index: "001.005" + color: + type: string + x-stream-index: "001.003" + custom: + additionalProperties: {} + type: object + x-stream-index: "001.018" + duration: + type: string + x-stream-index: "002.001" + fallback: type: string x-stream-index: "001.002" - upload_sizes: - description: Array of image size configurations + fields: items: - $ref: '#/components/schemas/ImageSize' - title: Upload sizes + $ref: '#/components/schemas/Field' type: array - x-stream-index: "002" + x-stream-index: "001.016" + footer: + type: string + x-stream-index: "001.013" + footer_icon: + type: string + x-stream-index: "001.014" + giphy: + $ref: '#/components/schemas/Images' + x-stream-index: "001.019" + image_url: + description: URL of detected image + title: Image URL + type: string + x-stream-index: "001.011" + og_scrape_url: + description: extracted url from the text + title: OG Scrape URL + type: string + x-stream-index: "001.020" + original_height: + format: int32 + type: integer + x-stream-index: "001.022" + original_width: + format: int32 + type: integer + x-stream-index: "001.021" + pretext: + type: string + x-stream-index: "001.004" + text: + description: og:description + title: Text + type: string + x-stream-index: "001.010" + thumb_url: + description: URL of detected thumb image + title: Image URL + type: string + x-stream-index: "001.012" + title: + description: og:title + title: Title + type: string + x-stream-index: "001.008" + title_link: + description: og:url + title: Title Link + type: string + x-stream-index: "001.009" + type: + description: Attachment type, could be empty, image, audio or video + title: Type + type: string + x-stream-index: "001.001" required: + - custom - duration + title: Get OG Attachment type: object - Images: + x-stream-docs-page-id: og + GetOrCreateCallRequest: + nullable: true properties: - fixed_height: - $ref: '#/components/schemas/ImageData' - x-stream-index: "002" - fixed_height_downsampled: - $ref: '#/components/schemas/ImageData' - x-stream-index: "004" - fixed_height_still: - $ref: '#/components/schemas/ImageData' + data: + $ref: '#/components/schemas/CallRequest' + title: ReadOnlyData x-stream-index: "003" - fixed_width: - $ref: '#/components/schemas/ImageData' - x-stream-index: "005" - fixed_width_downsampled: - $ref: '#/components/schemas/ImageData' + members_limit: + format: int32 + maximum: 100 + type: integer x-stream-index: "007" - fixed_width_still: - $ref: '#/components/schemas/ImageData' + notify: + description: if provided it sends a notification event to the members for + this call + title: Notify + type: boolean + x-stream-index: "005" + ring: + description: if provided it sends a ring event to the members for this call + title: Ring + type: boolean + x-stream-index: "004" + video: + type: boolean x-stream-index: "006" - original: - $ref: '#/components/schemas/ImageData' - x-stream-index: "001" - required: - - original - - fixed_height - - fixed_height_still - - fixed_height_downsampled - - fixed_width - - fixed_width_still - - fixed_width_downsampled + title: GetOrCreateCallRequest type: object - ImportTask: + GetOrCreateCallResponse: + nullable: true properties: - created_at: - format: date-time - type: number - x-stream-index: "011" - history: + call: + $ref: '#/components/schemas/CallResponse' + x-stream-index: "001.001" + created: + type: boolean + x-stream-index: "002" + duration: + type: string + x-stream-index: "003.001" + members: items: - $ref: '#/components/schemas/ImportTaskHistory' + $ref: '#/components/schemas/MemberResponse' type: array - x-stream-index: "010" - id: - type: string - x-stream-index: "003" - mode: - type: string - x-stream-index: "006" - path: - type: string - x-stream-index: "005" - size: - format: int64 - type: integer - x-stream-index: "007" - state: - type: string - x-stream-index: "008" - updated_at: - format: date-time - type: number - x-stream-index: "012" + x-stream-index: "001.002" + own_capabilities: + items: + $ref: '#/components/schemas/OwnCapability' + type: array + x-stream-index: "001.004" required: - - id - - path - - mode - - state - - history - - created_at - - updated_at + - call + - members + - own_capabilities + - blocked_users + - created + - duration + title: GetOrCreateCallResponse type: object - ImportTaskHistory: + GetOrCreateFeedGroupRequest: nullable: true properties: - created_at: - format: date-time - type: number - x-stream-index: "007" - next_state: - type: string + activity_processors: + description: Configuration for activity processors (max 10) + items: + $ref: '#/components/schemas/ActivityProcessorConfig' + maximum: 10 + title: Activity Processors + type: array x-stream-index: "006" - prev_state: + activity_selectors: + description: Configuration for activity selectors (max 10) + items: + $ref: '#/components/schemas/ActivitySelectorConfig' + maximum: 10 + title: Activity Selectors + type: array + x-stream-index: "007" + aggregation: + $ref: '#/components/schemas/AggregationConfig' + description: Configuration for activity aggregation + title: Aggregation + x-stream-index: "009" + custom: + additionalProperties: {} + description: Custom data for the feed group + title: Custom Data + type: object + x-stream-index: "004" + default_visibility: + description: 'Default visibility for the feed group, can be ''public'', + ''visible'', ''followers'', ''members'', or ''private''. Defaults to ''visible'' + if not provided. ' + enum: + - public + - visible + - followers + - members + - private + title: Default Visibility type: string x-stream-index: "005" - required: - - prev_state - - next_state - - created_at + notification: + $ref: '#/components/schemas/NotificationConfig' + description: Configuration for notifications + title: Notification + x-stream-index: "002" + push_notification: + $ref: '#/components/schemas/PushNotificationConfig' + x-stream-index: "003" + ranking: + $ref: '#/components/schemas/RankingConfig' + description: Configuration for activity ranking + title: Ranking + x-stream-index: "008" + title: Get Or Create Feed Group Request type: object - IngressAudioEncodingOptions: + GetOrCreateFeedGroupResponse: + nullable: true properties: - bitrate: - maximum: 128000 - minimum: 16000 - type: integer - x-stream-index: "003" - channels: - enum: - - "1" - - "2" - format: int32 - type: integer + duration: + type: string + x-stream-index: "003.001" + feed_group: + $ref: '#/components/schemas/FeedGroupResponse' + description: The feed group that was retrieved or created + title: Feed Group x-stream-index: "001" - enable_dtx: + was_created: + description: Indicates whether the feed group was created (true) or already + existed (false) + title: Was Created type: boolean x-stream-index: "002" required: - - channels - - enable_dtx - - bitrate + - feed_group + - was_created + - duration + title: Get Or Create Feed Group Response type: object - IngressAudioEncodingOptionsRequest: + GetOrCreateFeedRequest: + description: Client request + nullable: true properties: - bitrate: - maximum: 128000 - minimum: 16000 - type: integer + activity_selector_options: + additionalProperties: {} + type: object + x-stream-index: "006" + data: + $ref: '#/components/schemas/FeedInput' x-stream-index: "003" - channels: - enum: - - "1" - - "2" + external_ranking: + additionalProperties: {} + type: object + x-stream-index: "007" + filter: + additionalProperties: {} + type: object + x-stream-index: "009" + followers_pagination: + $ref: '#/components/schemas/PagerRequest' + x-stream-index: "011" + following_pagination: + $ref: '#/components/schemas/PagerRequest' + x-stream-index: "012" + interest_weights: + additionalProperties: + format: float + type: number + type: object + x-stream-index: "008" + limit: format: int32 + maximum: 100 + minimum: 0 type: integer - x-stream-index: "001" - enable_dtx: + x-stream-index: "013.001" + member_pagination: + $ref: '#/components/schemas/PagerRequest' + x-stream-index: "010" + next: + type: string + x-stream-index: "013.002" + prev: + type: string + x-stream-index: "013.003" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "014.002" + user_id: + type: string + x-stream-index: "014.001" + view: + type: string + x-stream-index: "005" + watch: type: boolean + x-stream-index: "004" + title: ClientRequest + type: object + GetOrCreateFeedResponse: + description: Basic response information + nullable: true + properties: + activities: + items: + $ref: '#/components/schemas/ActivityResponse' + type: array x-stream-index: "002" + aggregated_activities: + items: + $ref: '#/components/schemas/AggregatedActivityResponse' + type: array + x-stream-index: "003" + created: + type: boolean + x-stream-index: "015" + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "017.001" + feed: + $ref: '#/components/schemas/FeedResponse' + x-stream-index: "001" + followers: + items: + $ref: '#/components/schemas/FollowResponse' + type: array + x-stream-index: "005" + followers_pagination: + $ref: '#/components/schemas/PagerResponse' + x-stream-index: "012" + following: + items: + $ref: '#/components/schemas/FollowResponse' + type: array + x-stream-index: "006" + following_pagination: + $ref: '#/components/schemas/PagerResponse' + x-stream-index: "013" + member_pagination: + $ref: '#/components/schemas/PagerResponse' + x-stream-index: "011" + members: + items: + $ref: '#/components/schemas/FeedMemberResponse' + type: array + x-stream-index: "004" + next: + type: string + x-stream-index: "016.001" + notification_status: + $ref: '#/components/schemas/NotificationStatusResponse' + x-stream-index: "014" + own_capabilities: + items: + $ref: '#/components/schemas/FeedOwnCapability' + type: array + x-stream-index: "008" + own_follows: + items: + $ref: '#/components/schemas/FollowResponse' + type: array + x-stream-index: "009" + own_membership: + $ref: '#/components/schemas/FeedMemberResponse' + x-stream-index: "010" + pinned_activities: + items: + $ref: '#/components/schemas/ActivityPinResponse' + type: array + x-stream-index: "007" + prev: + type: string + x-stream-index: "016.002" required: - - channels - - bitrate + - feed + - activities + - aggregated_activities + - members + - followers + - following + - pinned_activities + - own_capabilities + - created + - duration + title: Response type: object - IngressAudioEncodingResponse: + GetOrCreateFeedViewRequest: + nullable: true properties: - bitrate: - format: int32 - type: integer - x-stream-index: "003" - channels: - format: int32 - type: integer + activity_processors: + description: Configured activity Processors + items: + $ref: '#/components/schemas/ActivityProcessorConfig' + title: Activity Processors + type: array + x-stream-index: "002.002" + activity_selectors: + description: Configuration for selecting activities + items: + $ref: '#/components/schemas/ActivitySelectorConfig' + title: Activity Selectors + type: array + x-stream-index: "002.001" + aggregation: + $ref: '#/components/schemas/AggregationConfig' + description: Configuration for aggregating activities + title: Aggregation + x-stream-index: "002.004" + ranking: + $ref: '#/components/schemas/RankingConfig' + description: Configuration for ranking activities + title: Ranking + x-stream-index: "002.003" + title: Get Or Create Feed View Request + type: object + GetOrCreateFeedViewResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "003.001" + feed_view: + $ref: '#/components/schemas/FeedViewResponse' + description: The feed view (either existing or newly created) + title: Feed View x-stream-index: "001" - enable_dtx: + was_created: + description: Indicates whether the feed view was newly created (true) or + already existed (false) + title: Was Created type: boolean x-stream-index: "002" required: - - channels - - enable_dtx - - bitrate + - feed_view + - was_created + - duration + title: Get Or Create Feed View Response type: object - IngressSettings: + GetPushTemplatesResponse: + description: Basic response information + nullable: true properties: - audio_encoding_options: - $ref: '#/components/schemas/IngressAudioEncodingOptions' + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "001.001" + templates: + items: + $ref: '#/components/schemas/PushTemplate' + type: array x-stream-index: "002" - enabled: - type: boolean - x-stream-index: "001" - video_encoding_options: - additionalProperties: - $ref: '#/components/schemas/IngressVideoEncodingOptions' - type: object - x-stream-index: "003" required: - - enabled + - duration + - templates + title: Response type: object - IngressSettingsRequest: + GetRateLimitsResponse: + nullable: true properties: - audio_encoding_options: - $ref: '#/components/schemas/IngressAudioEncodingOptionsRequest' - x-stream-index: "002" - enabled: - type: boolean - x-stream-index: "001" - video_encoding_options: + android: additionalProperties: - $ref: '#/components/schemas/IngressVideoEncodingOptionsRequest' + $ref: '#/components/schemas/LimitInfo' + description: Map of endpoint rate limits for the Android platform + title: Android type: object - x-stream-index: "003" - type: object - IngressSettingsResponse: - properties: - audio_encoding_options: - $ref: '#/components/schemas/IngressAudioEncodingResponse' x-stream-index: "002" - enabled: - type: boolean - x-stream-index: "001" - video_encoding_options: + x-stream-map: + description: The name of the endpoint for which the limits apply + key: endpoint + title: Endpoint name + duration: + type: string + x-stream-index: "005.001" + ios: additionalProperties: - $ref: '#/components/schemas/IngressVideoEncodingResponse' + $ref: '#/components/schemas/LimitInfo' + description: Map of endpoint rate limits for the iOS platform + title: iOS type: object x-stream-index: "003" - required: - - enabled - type: object - IngressVideoEncodingOptions: - properties: - layers: - items: - $ref: '#/components/schemas/IngressVideoLayer' - minimum: 1 - type: array + x-stream-map: + description: The name of the endpoint for which the limits apply + key: endpoint + title: Endpoint name + server_side: + additionalProperties: + $ref: '#/components/schemas/LimitInfo' + description: Map of endpoint rate limits for the server-side platform + title: Server-side + type: object x-stream-index: "001" + x-stream-map: + description: The name of the endpoint for which the limits apply + key: endpoint + title: Endpoint name + web: + additionalProperties: + $ref: '#/components/schemas/LimitInfo' + description: Map of endpoint rate limits for the web platform + title: Web + type: object + x-stream-index: "004" + x-stream-map: + description: The name of the endpoint for which the limits apply + key: endpoint + title: Endpoint name required: - - layers + - duration + title: Get Rate Limits Response type: object - IngressVideoEncodingOptionsRequest: + x-stream-docs-page-id: rate_limits + GetReactionsResponse: + nullable: true properties: - layers: + duration: + type: string + x-stream-index: "002.001" + reactions: + description: List of reactions items: - $ref: '#/components/schemas/IngressVideoLayerRequest' - minimum: 1 + $ref: '#/components/schemas/Reaction' + title: Reactions type: array x-stream-index: "001" required: - - layers + - reactions + - duration type: object - IngressVideoEncodingResponse: + GetRepliesResponse: + description: Basic response information + nullable: true properties: - layers: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "002.001" + messages: items: - $ref: '#/components/schemas/IngressVideoLayerResponse' + $ref: '#/components/schemas/MessageResponse' type: array x-stream-index: "001" required: - - layers + - messages + - duration + title: Response type: object - IngressVideoLayer: + GetReviewQueueItemResponse: nullable: true properties: - bitrate: - minimum: 1000 - type: integer - x-stream-index: "002" - codec: - enum: - - h264 - - vp8 + duration: type: string + x-stream-index: "002.001" + item: + $ref: '#/components/schemas/ReviewQueueItemResponse' + description: Current state of the review queue item + title: Item x-stream-index: "001" - frame_rate: - maximum: 60 - minimum: 1 - type: integer - x-stream-index: "003" - max_dimension: - minimum: 240 - type: integer - x-stream-index: "005" - min_dimension: - minimum: 240 - type: integer - x-stream-index: "004" required: - - codec - - bitrate - - frame_rate - - min_dimension - - max_dimension + - duration type: object - IngressVideoLayerRequest: + GetSegmentResponse: nullable: true properties: - bitrate: - format: int32 - minimum: 1000 - type: integer - x-stream-index: "002" - codec: - enum: - - h264 - - vp8 + duration: + description: Duration of the request in milliseconds + title: Duration type: string + x-stream-index: "002.001" + segment: + $ref: '#/components/schemas/SegmentResponse' + description: Segment + title: SegmentResponse x-stream-index: "001" - frame_rate_limit: - maximum: 60 - minimum: 1 - type: integer - x-stream-index: "005" - max_dimension: - minimum: 240 - type: integer - x-stream-index: "004" - min_dimension: - minimum: 240 - type: integer - x-stream-index: "003" required: - - codec - - bitrate - - min_dimension - - max_dimension - - frame_rate_limit + - duration type: object - IngressVideoLayerResponse: + GetTaskResponse: nullable: true properties: - bitrate: - type: integer - x-stream-index: "002" - codec: + created_at: + format: date-time + type: number + x-stream-index: "001.003" + duration: type: string - x-stream-index: "001" - frame_rate_limit: - type: integer - x-stream-index: "005" - max_dimension: - type: integer - x-stream-index: "004" - min_dimension: - type: integer + x-stream-index: "004.001" + error: + $ref: '#/components/schemas/ErrorResult' + description: Error produced by task + title: Error x-stream-index: "003" - required: - - codec - - bitrate - - min_dimension - - max_dimension - - frame_rate_limit - type: object - JoinCallAPIMetrics: - properties: - failures: - format: float - type: number + result: + additionalProperties: {} + description: Result produced by task after completion + title: Result + type: object x-stream-index: "002" - latency: - $ref: '#/components/schemas/ActiveCallsLatencyStats' - x-stream-index: "003" - total: - format: float + status: + description: Current status of task + title: Status + type: string + x-stream-index: "001.002" + task_id: + description: ID of task + title: Task ID + type: string + x-stream-index: "001.001" + updated_at: + format: date-time type: number - x-stream-index: "001" + x-stream-index: "001.004" required: - - total - - failures + - task_id + - status + - created_at + - updated_at + - duration + title: Get Task Response type: object - Label: + x-stream-docs-page-id: tasks + GetThreadResponse: + nullable: true properties: - harm_labels: - items: - type: string - type: array - x-stream-index: "003" - name: + duration: type: string + x-stream-index: "002.001" + thread: + $ref: '#/components/schemas/ThreadStateResponse' + description: Enriched thread state + title: Thread x-stream-index: "001" - phrase_list_ids: - items: - format: int32 - type: integer - type: array - x-stream-index: "002" required: - - name - type: object - LabelThresholds: - properties: - block: - description: Threshold for automatic message block - format: float - maximum: 1 - minimum: 0 - title: Block - type: number - x-stream-index: "002" - flag: - description: Threshold for automatic message flag - format: float - maximum: 1 - minimum: 0 - title: Flag - type: number - x-stream-index: "001" + - thread + - duration type: object - LayoutSettings: + GoLiveRequest: + nullable: true properties: - detect_orientation: - type: boolean - x-stream-index: "005" - external_app_url: + recording_storage_name: type: string + x-stream-index: "005" + start_closed_caption: + type: boolean + x-stream-index: "008" + start_hls: + type: boolean x-stream-index: "003" - external_css_url: - type: string + start_recording: + type: boolean x-stream-index: "004" - name: - enum: - - spotlight - - grid - - single-participant - - mobile - - custom + start_transcription: + type: boolean + x-stream-index: "007" + transcription_storage_name: type: string + x-stream-index: "006" + title: GoLiveRequest + type: object + GoLiveResponse: + description: Basic response information + nullable: true + properties: + call: + $ref: '#/components/schemas/CallResponse' x-stream-index: "001" - options: - additionalProperties: {} - type: object - x-stream-index: "002" + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "002.001" required: - - name - - external_app_url - - external_css_url + - call + - duration + title: Response type: object - LayoutSettingsRequest: + GoogleVisionConfig: properties: - detect_orientation: + enabled: type: boolean - x-stream-index: "005" - external_app_url: - type: string - x-stream-index: "003" - external_css_url: - type: string - x-stream-index: "004" - name: - enum: - - spotlight - - grid - - single-participant - - mobile - - custom - type: string x-stream-index: "001" - options: - additionalProperties: {} - type: object - x-stream-index: "002" - required: - - name type: object - LayoutSettingsResponse: + GroupedStatsResponse: + nullable: true properties: - detect_orientation: - type: boolean - x-stream-index: "005" - external_app_url: - type: string - x-stream-index: "003" - external_css_url: - type: string - x-stream-index: "004" name: - enum: - - spotlight - - grid - - single-participant - - mobile - - custom type: string x-stream-index: "001" - options: - additionalProperties: {} - type: object + unique: + format: int32 + type: integer x-stream-index: "002" required: - name - - external_app_url - - external_css_url + - unique type: object - LimitInfo: + HLSEgressConfig: properties: - limit: - description: The maximum number of calls allowed for the time window - format: int32 - title: Limit - type: integer - x-stream-index: "001" - remaining: - description: The number of remaining calls in the current window - format: int64 - title: Remaining - type: integer - x-stream-index: "002" - reset: - description: The Unix timestamp of the next window + composite_app_settings: + $ref: '#/components/schemas/CompositeAppSettings' + x-stream-index: "005" + playlist_url: + type: string + x-stream-index: "007" + qualities: + items: + $ref: '#/components/schemas/Quality' + type: array + x-stream-index: "004" + start_unix_nano: format: int64 - title: Reset type: integer - x-stream-index: "003" - required: - - limit - - remaining - - reset - title: Rate Limit info + x-stream-index: "006" type: object - x-stream-docs-page-id: rate_limits - LimitsSettings: + HLSSettings: properties: - max_duration_seconds: - format: int32 - type: integer - x-stream-index: "004" - max_participants: - format: int32 - type: integer + auto_on: + type: boolean x-stream-index: "001" - max_participants_exclude_owner: + enabled: type: boolean - x-stream-index: "003" - max_participants_exclude_roles: + x-stream-index: "002" + layout: + $ref: '#/components/schemas/LayoutSettings' + x-stream-index: "004" + quality_tracks: items: type: string type: array - x-stream-index: "002" + x-stream-index: "003" required: - - max_participants_exclude_roles + - auto_on + - enabled + - quality_tracks type: object - LimitsSettingsRequest: + HLSSettingsRequest: properties: - max_duration_seconds: - format: int32 - minimum: 0 - type: integer - x-stream-index: "004" - max_participants: - format: int32 - type: integer + auto_on: + type: boolean x-stream-index: "001" - max_participants_exclude_owner: + enabled: type: boolean - x-stream-index: "003" - max_participants_exclude_roles: + x-stream-index: "002" + layout: + $ref: '#/components/schemas/LayoutSettingsRequest' + title: LayoutSettings + x-stream-index: "004" + quality_tracks: items: type: string + maximum: 3 + minimum: 1 type: array - x-stream-index: "002" + x-stream-index: "003" + required: + - quality_tracks + title: HLSSettingsRequest type: object - LimitsSettingsResponse: + HLSSettingsResponse: + description: HLSSettings is the payload for HLS settings properties: - max_duration_seconds: - format: int32 - type: integer - x-stream-index: "004" - max_participants: - format: int32 - type: integer + auto_on: + title: Auto On + type: boolean x-stream-index: "001" - max_participants_exclude_owner: + enabled: + title: Enabled type: boolean - x-stream-index: "003" - max_participants_exclude_roles: + x-stream-index: "002" + layout: + $ref: '#/components/schemas/LayoutSettingsResponse' + title: Layout + x-stream-index: "004" + quality_tracks: items: type: string + title: Quality Tracks type: array - x-stream-index: "002" + x-stream-index: "003" required: - - max_participants_exclude_roles + - auto_on + - enabled + - quality_tracks + - layout + title: HLSSettingsResponse type: object - ListBlockListResponse: - description: Basic response information - nullable: true + HarmConfig: properties: - blocklists: + action_sequences: items: - $ref: '#/components/schemas/BlockListResponse' + $ref: '#/components/schemas/ActionSequence' type: array x-stream-index: "001" + severity: + type: integer + x-stream-index: "002" + required: + - action_sequences + - severity + type: object + HideChannelRequest: + nullable: true + properties: + clear_history: + description: Whether to clear message history of the channel or not + title: Clear history + type: boolean + x-stream-index: "001" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "003.002" + user_id: + type: string + x-stream-index: "003.001" + type: object + HideChannelResponse: + description: Basic response information + nullable: true + properties: duration: description: Duration of the request in milliseconds title: Duration type: string - x-stream-index: "002.001" + x-stream-index: "001.001" required: - - blocklists - duration title: Response type: object - ListCallTypeResponse: - description: Response for ListCallType - nullable: true + HuaweiConfig: properties: - call_types: - additionalProperties: - $ref: '#/components/schemas/CallTypeResponse' - type: object + Disabled: + type: boolean + writeOnly: true + x-stream-index: "003" + id: + type: string x-stream-index: "001" - duration: + secret: type: string - x-stream-index: "002.001" - required: - - call_types - - duration - title: ListCallTypeResponse + x-stream-index: "002" type: object - ListChannelTypesResponse: - nullable: true + HuaweiConfigFields: properties: - channel_types: - additionalProperties: - $ref: '#/components/schemas/ChannelTypeConfig' - description: Object with all channel types - title: Channel types - type: object + enabled: + type: boolean x-stream-index: "001" - x-stream-map: - description: Channel type config object - key: channel_type - title: Channel type - duration: + id: type: string - x-stream-index: "002.001" + x-stream-index: "002" + secret: + type: string + x-stream-index: "003" required: - - channel_types - - duration - title: ListChannelTypesResponse + - enabled type: object - ListCommandsResponse: - nullable: true + ImageContentParameters: properties: - commands: - description: List of commands + harm_labels: items: - $ref: '#/components/schemas/Command' - title: Commands + type: string type: array x-stream-index: "001" - duration: + type: object + ImageData: + properties: + frames: type: string - x-stream-index: "002.001" + x-stream-index: "005" + height: + type: string + x-stream-index: "003" + size: + type: string + x-stream-index: "004" + url: + type: string + x-stream-index: "001" + width: + type: string + x-stream-index: "002" required: - - commands - - duration - title: ListCommandsResponse + - url + - width + - height + - size + - frames type: object - ListDevicesResponse: - description: List devices response - nullable: true + ImageRuleParameters: properties: - devices: - description: List of devices + harm_labels: items: - $ref: '#/components/schemas/DeviceResponse' - title: Devices + type: string type: array + x-stream-index: "003" + threshold: + format: int32 + type: integer x-stream-index: "001" - duration: + time_window: type: string - x-stream-index: "002.001" - required: - - devices - - duration - title: ListDevicesResponse + x-stream-index: "002" type: object - ListExternalStorageResponse: - description: Basic response information - nullable: true + ImageSize: properties: - duration: - description: Duration of the request in milliseconds - title: Duration + crop: + description: Crop mode + enum: + - top + - bottom + - left + - right + - center + title: Crop + type: string + x-stream-index: "001" + height: + description: Target image height + format: int32 + title: Height + type: integer + x-stream-index: "003" + resize: + description: Resize method + enum: + - clip + - crop + - scale + - fill + title: Resize type: string - x-stream-index: "001.001" - external_storages: - additionalProperties: - $ref: '#/components/schemas/ExternalStorageResponse' - type: object x-stream-index: "002" - required: - - duration - - external_storages - title: Response + width: + description: Target image width + format: int32 + title: Width + type: integer + x-stream-index: "004" + title: Image size configuration type: object - ListImportsResponse: - description: Basic response information + ImageUploadRequest: nullable: true properties: - duration: - description: Duration of the request in milliseconds - title: Duration + file: type: string - x-stream-index: "002.001" - import_tasks: + x-stream-index: "001.001" + upload_sizes: + description: field with JSON-encoded array of image size configurations items: - $ref: '#/components/schemas/ImportTask' + $ref: '#/components/schemas/ImageSize' + title: Upload sizes type: array - x-stream-index: "001" - required: - - import_tasks - - duration - title: Response + x-stream-index: "002" + user: + $ref: '#/components/schemas/OnlyUserID' + x-stream-index: "001.002" type: object - ListPermissionsResponse: - description: Basic response information + ImageUploadResponse: nullable: true properties: duration: description: Duration of the request in milliseconds title: Duration type: string - x-stream-index: "002.001" - permissions: + x-stream-index: 001.003.001 + file: + type: string + x-stream-index: "001.001" + thumb_url: + type: string + x-stream-index: "001.002" + upload_sizes: + description: Array of image size configurations items: - $ref: '#/components/schemas/Permission' + $ref: '#/components/schemas/ImageSize' + title: Upload sizes type: array - x-stream-index: "001" + x-stream-index: "002" required: - - permissions - duration - title: Response type: object - ListPushProvidersResponse: - description: Basic response information - nullable: true + Images: properties: - duration: - description: Duration of the request in milliseconds - title: Duration - type: string - x-stream-index: "002.001" - push_providers: - items: - $ref: '#/components/schemas/PushProviderResponse' - type: array + fixed_height: + $ref: '#/components/schemas/ImageData' + x-stream-index: "002" + fixed_height_downsampled: + $ref: '#/components/schemas/ImageData' + x-stream-index: "004" + fixed_height_still: + $ref: '#/components/schemas/ImageData' + x-stream-index: "003" + fixed_width: + $ref: '#/components/schemas/ImageData' + x-stream-index: "005" + fixed_width_downsampled: + $ref: '#/components/schemas/ImageData' + x-stream-index: "007" + fixed_width_still: + $ref: '#/components/schemas/ImageData' + x-stream-index: "006" + original: + $ref: '#/components/schemas/ImageData' x-stream-index: "001" required: - - push_providers - - duration - title: Response + - original + - fixed_height + - fixed_height_still + - fixed_height_downsampled + - fixed_width + - fixed_width_still + - fixed_width_downsampled type: object - ListRecordingsResponse: - description: Response for listing recordings - nullable: true + ImportTask: properties: - duration: - type: string - x-stream-index: "001.001" - recordings: + created_at: + format: date-time + type: number + x-stream-index: "011" + history: items: - $ref: '#/components/schemas/CallRecording' - title: The list of recordings. + $ref: '#/components/schemas/ImportTaskHistory' type: array - x-stream-index: "002" + x-stream-index: "010" + id: + type: string + x-stream-index: "003" + mode: + type: string + x-stream-index: "006" + path: + type: string + x-stream-index: "005" + size: + format: int64 + type: integer + x-stream-index: "007" + state: + type: string + x-stream-index: "008" + updated_at: + format: date-time + type: number + x-stream-index: "012" required: - - duration - - recordings - title: ListRecordingsResponse + - id + - path + - mode + - state + - history + - created_at + - updated_at type: object - ListRolesResponse: - description: Basic response information + ImportTaskHistory: nullable: true properties: - duration: - description: Duration of the request in milliseconds - title: Duration + created_at: + format: date-time + type: number + x-stream-index: "007" + next_state: type: string - x-stream-index: "002.001" - roles: - items: - $ref: '#/components/schemas/Role' - type: array - x-stream-index: "001" + x-stream-index: "006" + prev_state: + type: string + x-stream-index: "005" required: - - roles - - duration - title: Response + - prev_state + - next_state + - created_at type: object - ListTranscriptionsResponse: - nullable: true + IngressAudioEncodingOptions: properties: - duration: - type: string - x-stream-index: "001.001" - transcriptions: - description: List of transcriptions for the call - items: - $ref: '#/components/schemas/CallTranscription' - title: Transcriptions - type: array + bitrate: + maximum: 128000 + minimum: 16000 + type: integer + x-stream-index: "003" + channels: + enum: + - "1" + - "2" + format: int32 + type: integer + x-stream-index: "001" + enable_dtx: + type: boolean x-stream-index: "002" required: - - duration - - transcriptions - title: ListTranscriptionsResponse + - channels + - enable_dtx + - bitrate type: object - MarkChannelsReadRequest: - nullable: true + IngressAudioEncodingOptionsRequest: properties: - read_by_channel: - additionalProperties: - type: string - description: Map of channel ID to last read message ID - maximum: 30 - title: Read by channel - type: object + bitrate: + maximum: 128000 + minimum: 16000 + type: integer + x-stream-index: "003" + channels: + enum: + - "1" + - "2" + format: int32 + type: integer x-stream-index: "001" - user: - $ref: '#/components/schemas/UserRequest' - x-stream-index: "002.002" - user_id: - type: string - x-stream-index: "002.001" + enable_dtx: + type: boolean + x-stream-index: "002" + required: + - channels + - bitrate type: object - MarkReadRequest: - nullable: true + IngressAudioEncodingResponse: properties: - message_id: - description: ID of the message that is considered last read by client - title: Message ID - type: string + bitrate: + format: int32 + type: integer + x-stream-index: "003" + channels: + format: int32 + type: integer x-stream-index: "001" - thread_id: - description: Optional Thread ID to specifically mark a given thread as read - title: Thread ID - type: string + enable_dtx: + type: boolean x-stream-index: "002" - user: - $ref: '#/components/schemas/UserRequest' - x-stream-index: "004.002" - user_id: - type: string - x-stream-index: "004.001" + required: + - channels + - enable_dtx + - bitrate type: object - MarkReadResponse: - nullable: true + IngressSettings: properties: - duration: - description: Duration of the request in milliseconds - title: Duration - type: string - x-stream-index: "002.001" - event: - $ref: '#/components/schemas/MessageReadEvent' - description: Mark read event - title: Event + audio_encoding_options: + $ref: '#/components/schemas/IngressAudioEncodingOptions' + x-stream-index: "002" + enabled: + type: boolean x-stream-index: "001" + video_encoding_options: + additionalProperties: + $ref: '#/components/schemas/IngressVideoEncodingOptions' + type: object + x-stream-index: "003" required: - - duration + - enabled type: object - MarkReviewedRequest: + IngressSettingsRequest: properties: - content_to_mark_as_reviewed_limit: - format: int32 - maximum: 2500 - type: integer + audio_encoding_options: + $ref: '#/components/schemas/IngressAudioEncodingOptionsRequest' x-stream-index: "002" - disable_marking_content_as_reviewed: + enabled: type: boolean x-stream-index: "001" + video_encoding_options: + additionalProperties: + $ref: '#/components/schemas/IngressVideoEncodingOptionsRequest' + type: object + x-stream-index: "003" type: object - MarkUnreadRequest: - nullable: true + IngressSettingsResponse: properties: - message_id: - description: ID of the message from where the channel is marked unread - title: Message ID - type: string + audio_encoding_options: + $ref: '#/components/schemas/IngressAudioEncodingResponse' + x-stream-index: "002" + enabled: + type: boolean x-stream-index: "001" - thread_id: - description: Mark a thread unread, specify both the thread and message id - title: Thread ID - type: string + video_encoding_options: + additionalProperties: + $ref: '#/components/schemas/IngressVideoEncodingResponse' + type: object x-stream-index: "003" - user: - $ref: '#/components/schemas/UserRequest' - x-stream-index: "004.002" - user_id: - type: string - x-stream-index: "004.001" + required: + - enabled type: object - MemberAddedEvent: + IngressVideoEncodingOptions: properties: - channel_id: - type: string - x-stream-index: "004.002" - channel_type: - type: string - x-stream-index: "004.003" - cid: - type: string - x-stream-index: "004.001" - created_at: - format: date-time - type: number - x-stream-index: "003.002" - member: - $ref: '#/components/schemas/ChannelMember' - x-stream-index: "001.001" - team: - type: string - x-stream-index: "002.001" - type: - default: member.added - type: string - x-stream-index: "003.001" - user: - $ref: '#/components/schemas/User' - x-stream-index: "005.001" + layers: + items: + $ref: '#/components/schemas/IngressVideoLayer' + minimum: 1 + type: array + x-stream-index: "001" required: - - type - - created_at - - cid - - channel_id - - channel_type - title: MemberAddedEvent + - layers 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 - MemberLookup: + IngressVideoEncodingOptionsRequest: properties: - Limit: - format: int32 - type: integer - writeOnly: true + layers: + items: + $ref: '#/components/schemas/IngressVideoLayerRequest' + minimum: 1 + type: array x-stream-index: "001" required: - - Limit + - layers type: object - MemberRemovedEvent: + IngressVideoEncodingResponse: properties: - channel_id: - type: string - x-stream-index: "003.002" - channel_type: - type: string - x-stream-index: "003.003" - cid: - type: string - x-stream-index: "003.001" - created_at: - format: date-time - type: number - x-stream-index: "002.002" - member: - $ref: '#/components/schemas/ChannelMember' - x-stream-index: "001.001" - type: - default: member.removed - type: string - x-stream-index: "002.001" - user: - $ref: '#/components/schemas/User' - x-stream-index: "004.001" + layers: + items: + $ref: '#/components/schemas/IngressVideoLayerResponse' + type: array + x-stream-index: "001" required: - - type - - created_at - - cid - - channel_id - - channel_type - title: MemberRemovedEvent + - layers 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 - MemberRequest: - description: MemberRequest is the payload for adding a member to a call. + IngressVideoLayer: + nullable: true properties: - custom: - additionalProperties: {} - description: Custom data for this object - title: Custom data - type: object - x-stream-index: "003" - role: - title: Role + bitrate: + minimum: 1000 + type: integer + x-stream-index: "002" + codec: + enum: + - h264 + - vp8 type: string + x-stream-index: "001" + frame_rate: + maximum: 60 + minimum: 1 + type: integer + x-stream-index: "003" + max_dimension: + minimum: 240 + type: integer + x-stream-index: "005" + min_dimension: + minimum: 240 + type: integer + x-stream-index: "004" + required: + - codec + - bitrate + - frame_rate + - min_dimension + - max_dimension + type: object + IngressVideoLayerRequest: + nullable: true + properties: + bitrate: + format: int32 + minimum: 1000 + type: integer x-stream-index: "002" - user_id: - minLength: 1 - title: User ID + codec: + enum: + - h264 + - vp8 type: string x-stream-index: "001" + frame_rate_limit: + maximum: 60 + minimum: 1 + type: integer + x-stream-index: "005" + max_dimension: + minimum: 240 + type: integer + x-stream-index: "004" + min_dimension: + minimum: 240 + type: integer + x-stream-index: "003" required: - - user_id - title: MemberRequest + - codec + - bitrate + - min_dimension + - max_dimension + - frame_rate_limit type: object - MemberResponse: - description: MemberResponse is the payload for a member of a call. + IngressVideoLayerResponse: + nullable: true properties: - created_at: - description: Date/time of creation - format: date-time - title: Created at - type: number + bitrate: + type: integer + x-stream-index: "002" + codec: + type: string + x-stream-index: "001" + frame_rate_limit: + type: integer x-stream-index: "005" - custom: - additionalProperties: {} - description: Custom member response data - title: Custom - type: object + max_dimension: + type: integer x-stream-index: "004" - deleted_at: - description: Date/time of deletion - format: date-time - title: Deleted at + min_dimension: + type: integer + x-stream-index: "003" + required: + - codec + - bitrate + - min_dimension + - max_dimension + - frame_rate_limit + type: object + JoinCallAPIMetrics: + properties: + failures: + format: float type: number - x-stream-index: "007" - role: - title: Role - type: string + x-stream-index: "002" + latency: + $ref: '#/components/schemas/ActiveCallsLatencyStats' x-stream-index: "003" - updated_at: - description: Date/time of the last update - format: date-time - title: Updated at + total: + format: float type: number - x-stream-index: "006" - user: - $ref: '#/components/schemas/UserResponse' x-stream-index: "001" + required: + - total + - failures + type: object + KickUserRequest: + description: KickUserRequest is the payload for kicking a user from a call. + Optionally block the user as well. + nullable: true + properties: + block: + description: If true, also block the user from rejoining the call + title: Block + type: boolean + x-stream-index: "004" + kicked_by: + $ref: '#/components/schemas/UserRequest' + description: 'Server-side: user performing the action' + title: KickedBy + x-stream-index: "006" + kicked_by_id: + description: 'Server-side: ID of the user performing the action' + title: KickedByID + type: string + x-stream-index: "005" user_id: + description: The user to kick + title: UserID type: string - x-stream-index: "002" + x-stream-index: "003" required: - - user - user_id - - custom - - created_at - - updated_at - title: MemberResponse + title: KickUserRequest type: object - MemberUpdatedEvent: + KickUserResponse: + description: KickUserResponse is the payload for kicking a user from a call. + nullable: true properties: - channel_id: - type: string - x-stream-index: "005.002" - channel_type: + duration: + description: Duration of the request in milliseconds + title: Duration type: string - x-stream-index: "005.003" - cid: + x-stream-index: "001.001" + required: + - duration + title: KickUserResponse + type: object + KickedUserEvent: + description: This event is sent to call participants to notify when a user is + kicked from a call. Clients should make the kicked user leave the call UI. + properties: + call_cid: type: string - x-stream-index: "005.001" + x-stream-index: "002.001" created_at: format: date-time type: number - x-stream-index: "003.002" - member: - $ref: '#/components/schemas/ChannelMember' - x-stream-index: "001.001" - team: - type: string - x-stream-index: "002.001" + x-stream-index: "001.002" + kicked_by_user: + $ref: '#/components/schemas/UserResponse' + description: The user that kicked the participant, null if server-side + title: Kicked by + x-stream-index: "004" type: - default: member.updated + default: call.kicked_user + description: 'The type of event: "call.kicked_user" in this case' + title: Event Type type: string - x-stream-index: "003.001" + x-stream-index: "001.001" user: - $ref: '#/components/schemas/User' - x-stream-index: "004.001" + $ref: '#/components/schemas/UserResponse' + description: The user that was kicked + title: User + x-stream-index: "003" required: - type - created_at - - cid - - channel_id - - channel_type - title: MemberUpdatedEvent + - call_cid + - user + title: KickedUserEvent type: object - x-stream-event-client-type: true - x-stream-event-doc-group: other + x-stream-event-call-type: true + x-stream-event-doc-group: call x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - MembersResponse: - nullable: true + LLMConfig: properties: - duration: - description: Duration of the request in milliseconds - title: Duration + app_context: type: string - x-stream-index: "002.001" - members: - description: List of found members - items: - $ref: '#/components/schemas/ChannelMember' - title: Members - type: array + x-stream-index: "005" + async: + type: boolean x-stream-index: "001" - required: - - members - - duration - type: object - Message: - properties: - attachments: + enabled: + type: boolean + x-stream-index: "002" + rules: items: - $ref: '#/components/schemas/Attachment' + $ref: '#/components/schemas/LLMRule' type: array - x-stream-index: "012" - before_message_send_failed: - type: boolean - x-stream-index: "046" - cid: - type: string - x-stream-index: "028" - command: - type: string - x-stream-index: "006" - created_at: - format: date-time - type: number - x-stream-index: "030" - custom: - additionalProperties: {} - type: object - x-stream-index: "034" - deleted_at: - format: date-time - type: number - x-stream-index: "033" - deleted_reply_count: - format: int32 - type: integer - x-stream-index: "023" - html: - type: string - x-stream-index: "007" - i18n: + x-stream-index: "003" + severity_descriptions: additionalProperties: type: string type: object - x-stream-index: "044" - id: + x-stream-index: "004" + required: + - enabled + - rules + type: object + LLMRule: + properties: + action: + enum: + - flag + - shadow + - remove + - bounce + - bounce_flag + - bounce_remove + - keep + type: string + x-stream-index: "003" + description: type: string x-stream-index: "002" - image_labels: - additionalProperties: - items: - type: string - type: array - type: object - x-stream-index: "040" - latest_reactions: + label: + type: string + x-stream-index: "001" + severity_rules: items: - $ref: '#/components/schemas/Reaction' + $ref: '#/components/schemas/BodyguardSeverityRule' type: array - x-stream-index: "013" - mentioned_users: + x-stream-index: "004" + required: + - label + - description + - action + - severity_rules + type: object + Label: + properties: + harm_labels: items: - $ref: '#/components/schemas/User' + type: string type: array - x-stream-index: "043" - message_text_updated_at: - format: date-time - type: number - x-stream-index: "052" - mml: + x-stream-index: "003" + name: type: string - x-stream-index: "005" - moderation: - $ref: '#/components/schemas/ModerationV2Response' - x-stream-index: "056" - own_reactions: + x-stream-index: "001" + phrase_list_ids: items: - $ref: '#/components/schemas/Reaction' + format: int32 + type: integer type: array - x-stream-index: "014" - parent_id: - type: string - x-stream-index: "019" - pin_expires: - format: date-time + x-stream-index: "002" + required: + - name + type: object + LabelThresholds: + properties: + block: + description: Threshold for automatic message block + format: float + maximum: 1 + minimum: 0 + title: Block type: number - x-stream-index: "051" - pinned: - type: boolean - x-stream-index: "047" - pinned_at: - format: date-time + x-stream-index: "002" + flag: + description: Threshold for automatic message flag + format: float + maximum: 1 + minimum: 0 + title: Flag type: number - x-stream-index: "048" - pinned_by: - $ref: '#/components/schemas/User' - x-stream-index: "050" - poll: - $ref: '#/components/schemas/Poll' - x-stream-index: "054" - poll_id: + x-stream-index: "001" + type: object + LayoutSettings: + properties: + detect_orientation: + type: boolean + x-stream-index: "005" + external_app_url: type: string - x-stream-index: "053" - quoted_message: - $ref: '#/components/schemas/Message' - x-stream-index: "025" - quoted_message_id: + x-stream-index: "003" + external_css_url: type: string - x-stream-index: "024" - reaction_counts: - additionalProperties: - format: int32 - type: integer - type: object - x-stream-index: "015" - reaction_groups: - additionalProperties: - $ref: '#/components/schemas/ReactionGroupResponse' - type: object - x-stream-index: "017" - reaction_scores: - additionalProperties: - format: int32 - type: integer + x-stream-index: "004" + name: + enum: + - spotlight + - grid + - single-participant + - mobile + - custom + type: string + x-stream-index: "001" + options: + additionalProperties: {} type: object - x-stream-index: "016" - reminder: - $ref: '#/components/schemas/MessageReminder' - x-stream-index: "058" - reply_count: - format: int32 - type: integer - x-stream-index: "022" - restricted_visibility: - items: - type: string - type: array - x-stream-index: "011" - shadowed: - type: boolean - x-stream-index: "036" - shared_location: - $ref: '#/components/schemas/SharedLocation' - x-stream-index: "055" - show_in_channel: - type: boolean - x-stream-index: "021" - silent: + x-stream-index: "002" + required: + - name + - external_app_url + - external_css_url + type: object + LayoutSettingsRequest: + properties: + detect_orientation: type: boolean - x-stream-index: "045" - text: + x-stream-index: "005" + external_app_url: + type: string + x-stream-index: "003" + external_css_url: type: string x-stream-index: "004" - thread_participants: - items: - $ref: '#/components/schemas/User' - type: array - x-stream-index: "027" - type: + name: + enum: + - spotlight + - grid + - single-participant + - mobile + - custom type: string - x-stream-index: "008" - updated_at: - format: date-time - type: number - x-stream-index: "031" - user: - $ref: '#/components/schemas/User' - x-stream-index: "010" + x-stream-index: "001" + options: + additionalProperties: {} + type: object + x-stream-index: "002" required: - - id - - text - - html - - type - - restricted_visibility - - attachments - - latest_reactions - - own_reactions - - reaction_counts - - reaction_scores - - reaction_groups - - reply_count - - deleted_reply_count - - cid - - created_at - - updated_at - - custom - - shadowed - - mentioned_users - - silent - - pinned + - name type: object - MessageActionRequest: - nullable: true + LayoutSettingsResponse: properties: - form_data: - additionalProperties: - type: string - description: ReadOnlyData to execute command with - title: Form data + detect_orientation: + type: boolean + x-stream-index: "005" + external_app_url: + type: string + x-stream-index: "003" + external_css_url: + type: string + x-stream-index: "004" + name: + enum: + - spotlight + - grid + - single-participant + - mobile + - custom + type: string + x-stream-index: "001" + options: + additionalProperties: {} type: object x-stream-index: "002" - user: - $ref: '#/components/schemas/UserRequest' - x-stream-index: "003.002" - user_id: - type: string - x-stream-index: "003.001" required: - - form_data + - name + - external_app_url + - external_css_url type: object - MessageChangeSet: + LimitInfo: properties: - attachments: - type: boolean - x-stream-index: "005" - custom: - type: boolean + limit: + description: The maximum number of calls allowed for the time window + format: int32 + title: Limit + type: integer x-stream-index: "001" - html: - type: boolean + remaining: + description: The number of remaining calls in the current window + format: int64 + title: Remaining + type: integer + x-stream-index: "002" + reset: + description: The Unix timestamp of the next window + format: int64 + title: Reset + type: integer + x-stream-index: "003" + required: + - limit + - remaining + - reset + title: Rate Limit info + type: object + x-stream-docs-page-id: rate_limits + LimitsSettings: + properties: + max_duration_seconds: + format: int32 + type: integer x-stream-index: "004" - mentioned_user_ids: - type: boolean - x-stream-index: "006" - mml: + max_participants: + format: int32 + type: integer + x-stream-index: "001" + max_participants_exclude_owner: type: boolean x-stream-index: "003" - pin: - type: boolean - x-stream-index: "009" - quoted_message_id: - type: boolean - x-stream-index: "007" - silent: + max_participants_exclude_roles: + items: + type: string + type: array + x-stream-index: "002" + required: + - max_participants_exclude_roles + type: object + LimitsSettingsRequest: + properties: + max_duration_seconds: + format: int32 + minimum: 0 + type: integer + x-stream-index: "004" + max_participants: + format: int32 + type: integer + x-stream-index: "001" + max_participants_exclude_owner: type: boolean - x-stream-index: "008" - text: + x-stream-index: "003" + max_participants_exclude_roles: + items: + type: string + type: array + x-stream-index: "002" + type: object + LimitsSettingsResponse: + properties: + max_duration_seconds: + format: int32 + type: integer + x-stream-index: "004" + max_participants: + format: int32 + type: integer + x-stream-index: "001" + max_participants_exclude_owner: type: boolean + x-stream-index: "003" + max_participants_exclude_roles: + items: + type: string + type: array x-stream-index: "002" required: - - custom - - text - - mml - - html - - attachments - - mentioned_user_ids - - quoted_message_id - - silent - - pin + - max_participants_exclude_roles type: object - MessageDeletedEvent: + ListBlockListResponse: + description: Basic response information + nullable: true properties: - channel_id: - type: string - x-stream-index: "003.002" - channel_type: - type: string - x-stream-index: "003.003" - cid: - type: string - x-stream-index: "003.001" - created_at: - format: date-time - type: number - x-stream-index: "006.002" - hard_delete: - type: boolean - x-stream-index: "002.001" - message: - $ref: '#/components/schemas/Message' - x-stream-index: "001.001" - team: - type: string - x-stream-index: "005.001" - thread_participants: + blocklists: items: - $ref: '#/components/schemas/User' + $ref: '#/components/schemas/BlockListResponse' type: array - x-stream-index: "001.002" - type: - default: message.deleted + x-stream-index: "001" + duration: + description: Duration of the request in milliseconds + title: Duration type: string - x-stream-index: "006.001" - user: - $ref: '#/components/schemas/User' - x-stream-index: "004.001" + x-stream-index: "002.001" required: - - hard_delete - - cid - - channel_id - - channel_type - - type - - created_at - title: MessageDeletedEvent + - blocklists + - duration + title: Response 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: + ListCallTypeResponse: + description: Response for ListCallType nullable: true properties: - approved_at: - format: date-time - type: number - x-stream-index: "013" - created_at: - format: date-time - type: number - x-stream-index: "009" - created_by_automod: - type: boolean - x-stream-index: "001" - custom: - additionalProperties: {} + call_types: + additionalProperties: + $ref: '#/components/schemas/CallTypeResponse' type: object - x-stream-index: "008" - details: - $ref: '#/components/schemas/FlagDetails' - x-stream-index: "006" - message: - $ref: '#/components/schemas/Message' - x-stream-index: "005" - moderation_feedback: - $ref: '#/components/schemas/FlagFeedback' - x-stream-index: "003" - moderation_result: - $ref: '#/components/schemas/MessageModerationResult' - x-stream-index: "002" - reason: + x-stream-index: "001" + duration: type: string - x-stream-index: "007" - rejected_at: - format: date-time - type: number - x-stream-index: "014" - reviewed_at: - format: date-time - type: number - x-stream-index: "011" - reviewed_by: - $ref: '#/components/schemas/UserResponse' - x-stream-index: "012" - updated_at: - format: date-time - type: number - x-stream-index: "010" - user: - $ref: '#/components/schemas/UserResponse' - x-stream-index: "004" + x-stream-index: "002.001" required: - - created_by_automod - - created_at - - updated_at + - call_types + - duration + title: ListCallTypeResponse type: object - MessageFlaggedEvent: + ListChannelTypesResponse: + nullable: true properties: - cid: - type: string + channel_types: + additionalProperties: + $ref: '#/components/schemas/ChannelTypeConfig' + description: Object with all channel types + title: Channel types + type: object x-stream-index: "001" - created_at: - format: date-time - type: number - x-stream-index: "005.002" - flag: - $ref: '#/components/schemas/Flag' - x-stream-index: "003.001" - message: - $ref: '#/components/schemas/Message' + x-stream-map: + description: Channel type config object + key: channel_type + title: Channel type + duration: + type: string x-stream-index: "002.001" - thread_participants: + required: + - channel_types + - duration + title: ListChannelTypesResponse + type: object + ListCommandsResponse: + nullable: true + properties: + commands: + description: List of commands items: - $ref: '#/components/schemas/User' + $ref: '#/components/schemas/Command' + title: Commands type: array - x-stream-index: "002.002" - type: - default: message.flagged + x-stream-index: "001" + duration: type: string - x-stream-index: "005.001" - user: - $ref: '#/components/schemas/User' - x-stream-index: "004" + x-stream-index: "002.001" required: - - cid - - type - - created_at - title: MessageFlaggedEvent + - commands + - duration + title: ListCommandsResponse 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 - MessageHistoryEntryResponse: + ListDevicesResponse: + description: List devices response nullable: true properties: - Custom: - additionalProperties: {} - type: object - writeOnly: true - x-stream-index: "007" - attachments: + devices: + description: List of devices items: - $ref: '#/components/schemas/Attachment' + $ref: '#/components/schemas/DeviceResponse' + title: Devices type: array - x-stream-index: "006" - is_deleted: - type: boolean - x-stream-index: "004" - message_id: - type: string x-stream-index: "001" - message_updated_at: - format: date-time - type: number - x-stream-index: "003" - message_updated_by_id: - type: string - x-stream-index: "002" - text: + duration: type: string - x-stream-index: "005" + x-stream-index: "002.001" required: - - message_id - - message_updated_by_id - - message_updated_at - - is_deleted - - text - - attachments - - Custom + - devices + - duration + title: ListDevicesResponse type: object - MessageModerationResult: - description: Result of the message moderation + ListExternalStorageResponse: + description: Basic response information + nullable: true properties: - action: - description: Action taken by automod - title: Action + duration: + description: Duration of the request in milliseconds + title: Duration type: string + x-stream-index: "001.001" + external_storages: + additionalProperties: + $ref: '#/components/schemas/ExternalStorageResponse' + type: object x-stream-index: "002" - ai_moderation_response: - $ref: '#/components/schemas/ModerationResponse' - description: Response from AI moderation - title: ModerationResponse - x-stream-index: "007" - blocked_word: - description: Word that was blocked - title: Blocked word - type: string - x-stream-index: "004" - blocklist_name: - description: Name of the blocklist - title: Blocklist name - type: string - x-stream-index: "005" - created_at: - description: Date/time of creation - format: date-time - title: Created at - type: number - x-stream-index: "010" - message_id: - description: ID of the message - title: Message ID + required: + - duration + - external_storages + title: Response + type: object + ListFeedGroupsResponse: + description: Basic response information + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration type: string + x-stream-index: "002.001" + groups: + additionalProperties: + $ref: '#/components/schemas/FeedGroupResponse' + type: object x-stream-index: "001" - moderated_by: - description: User who moderated the message - title: Moderated by + required: + - groups + - duration + title: Response + type: object + ListFeedViewsResponse: + nullable: true + properties: + duration: type: string - x-stream-index: "003" - moderation_thresholds: - $ref: '#/components/schemas/Thresholds' - description: Thresholds for AI moderation - title: Thresholds - x-stream-index: "006" - updated_at: - description: Date/time of the last update - format: date-time - title: Updated at - type: number - x-stream-index: "011" - user_bad_karma: - description: Whether user has bad karma - title: User bad karma + x-stream-index: "002.001" + views: + additionalProperties: + $ref: '#/components/schemas/FeedViewResponse' + description: Map of feed view ID to feed view + title: Views + type: object + x-stream-index: "001" + required: + - views + - duration + title: List Feed Views Response + type: object + ListImportsResponse: + description: Basic response information + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "002.001" + import_tasks: + items: + $ref: '#/components/schemas/ImportTask' + type: array + x-stream-index: "001" + required: + - import_tasks + - duration + title: Response + type: object + ListPermissionsResponse: + description: Basic response information + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "002.001" + permissions: + items: + $ref: '#/components/schemas/Permission' + type: array + x-stream-index: "001" + required: + - permissions + - duration + title: Response + type: object + ListPushProvidersResponse: + description: Basic response information + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "002.001" + push_providers: + items: + $ref: '#/components/schemas/PushProviderResponse' + type: array + x-stream-index: "001" + required: + - push_providers + - duration + title: Response + type: object + ListRecordingsResponse: + description: Response for listing recordings + nullable: true + properties: + duration: + type: string + x-stream-index: "001.001" + recordings: + items: + $ref: '#/components/schemas/CallRecording' + title: The list of recordings. + type: array + x-stream-index: "002" + required: + - duration + - recordings + title: ListRecordingsResponse + type: object + ListRolesResponse: + description: Basic response information + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "002.001" + roles: + items: + $ref: '#/components/schemas/Role' + type: array + x-stream-index: "001" + required: + - roles + - duration + title: Response + type: object + ListTranscriptionsResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "001.001" + transcriptions: + description: List of transcriptions for the call + items: + $ref: '#/components/schemas/CallTranscription' + title: Transcriptions + type: array + x-stream-index: "002" + required: + - duration + - transcriptions + title: ListTranscriptionsResponse + type: object + MarkActivityRequest: + nullable: true + properties: + mark_all_read: + description: Whether to mark all activities as read + title: Mark All Read type: boolean - x-stream-index: "009" - user_karma: - description: Karma of the user - format: float - title: User karma - type: number - x-stream-index: "008" + x-stream-index: "005" + mark_all_seen: + description: Whether to mark all activities as seen + title: Mark All Seen + type: boolean + x-stream-index: "003" + mark_read: + description: List of activity IDs to mark as read + items: + type: string + title: Mark Read + type: array + x-stream-index: "004" + mark_seen: + description: List of activity IDs to mark as seen + items: + type: string + title: Mark Seen + type: array + x-stream-index: "006" + mark_watched: + description: List of activity IDs to mark as watched (for stories) + items: + type: string + title: Mark Watched + type: array + x-stream-index: "007" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "009.002" + user_id: + type: string + x-stream-index: "009.001" + title: Mark Activity Request + type: object + MarkChannelsReadRequest: + nullable: true + properties: + read_by_channel: + additionalProperties: + type: string + description: Map of channel ID to last read message ID + maximum: 30 + title: Read by channel + type: object + x-stream-index: "001" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "002.002" + user_id: + type: string + x-stream-index: "002.001" + type: object + MarkReadRequest: + nullable: true + properties: + message_id: + description: ID of the message that is considered last read by client + title: Message ID + type: string + x-stream-index: "001" + thread_id: + description: Optional Thread ID to specifically mark a given thread as read + title: Thread ID + type: string + x-stream-index: "002" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "004.002" + user_id: + type: string + x-stream-index: "004.001" + type: object + MarkReadResponse: + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "002.001" + event: + $ref: '#/components/schemas/MessageReadEvent' + description: Mark read event + title: Event + x-stream-index: "001" required: - - message_id - - action - - user_karma - - user_bad_karma - - created_at - - updated_at - title: Message moderation result + - duration type: object - MessageNewEvent: + MarkReviewedRequest: + properties: + content_to_mark_as_reviewed_limit: + format: int32 + maximum: 2500 + type: integer + x-stream-index: "002" + disable_marking_content_as_reviewed: + type: boolean + x-stream-index: "001" + type: object + MarkUnreadRequest: + nullable: true + properties: + message_id: + description: ID of the message from where the channel is marked unread + title: Message ID + type: string + x-stream-index: "001" + thread_id: + description: Mark a thread unread, specify both the thread and message id + title: Thread ID + type: string + x-stream-index: "003" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "004.002" + user_id: + type: string + x-stream-index: "004.001" + type: object + MemberAddedEvent: properties: channel_id: type: string - x-stream-index: "005.002" + x-stream-index: "004.002" channel_type: type: string - x-stream-index: "005.003" + x-stream-index: "004.003" cid: type: string - x-stream-index: "005.001" + x-stream-index: "004.001" created_at: format: date-time type: number - x-stream-index: "004.002" - message: - $ref: '#/components/schemas/Message' + x-stream-index: "003.002" + member: + $ref: '#/components/schemas/ChannelMember' x-stream-index: "001.001" team: type: string - x-stream-index: "006.001" - thread_participants: - items: - $ref: '#/components/schemas/User' - type: array - x-stream-index: "001.002" + x-stream-index: "002.001" type: - default: notification.thread_message_new + default: member.added type: string - x-stream-index: "004.001" + x-stream-index: "003.001" user: $ref: '#/components/schemas/User' - x-stream-index: "003.001" - watcher_count: - format: int32 - type: integer - x-stream-index: "002.001" + x-stream-index: "005.001" required: - - watcher_count - type - created_at - cid - channel_id - channel_type - title: MessageNewEvent + title: MemberAddedEvent 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 - MessageOptions: + MemberLookup: properties: - include_thread_participants: - type: boolean + Limit: + format: int32 + type: integer + writeOnly: true x-stream-index: "001" + required: + - Limit type: object - MessagePaginationParams: - type: object - MessageReadEvent: + MemberRemovedEvent: properties: channel_id: type: string - x-stream-index: "003" - channel_last_message_at: - format: date-time - type: number - x-stream-index: "005" + x-stream-index: "003.002" channel_type: type: string - x-stream-index: "004" + x-stream-index: "003.003" cid: type: string - x-stream-index: "002" + x-stream-index: "003.001" created_at: format: date-time type: number - x-stream-index: "009" - last_read_message_id: - type: string - x-stream-index: "010" - team: - type: string - x-stream-index: "006" - thread: - $ref: '#/components/schemas/ThreadResponse' - x-stream-index: "008" + x-stream-index: "002.002" + member: + $ref: '#/components/schemas/ChannelMember' + x-stream-index: "001.001" type: - default: message.read + default: member.removed type: string - x-stream-index: "001" + x-stream-index: "002.001" user: - $ref: '#/components/schemas/UserResponseCommonFields' - x-stream-index: "007" + $ref: '#/components/schemas/User' + x-stream-index: "004.001" required: - type + - created_at - cid - channel_id - channel_type - - created_at + title: MemberRemovedEvent type: object - MessageReminder: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + MemberRequest: + description: MemberRequest is the payload for adding a member to a call. properties: - channel: - $ref: '#/components/schemas/Channel' - x-stream-index: "004" - channel_cid: - type: string + custom: + additionalProperties: {} + description: Custom data for this object + title: Custom data + type: object x-stream-index: "003" + role: + title: Role + type: string + x-stream-index: "002" + user_id: + minLength: 1 + title: User ID + type: string + x-stream-index: "001" + required: + - user_id + title: MemberRequest + type: object + MemberResponse: + description: MemberResponse is the payload for a member of a call. + properties: created_at: + description: Date/time of creation format: date-time + title: Created at type: number - x-stream-index: "011" - message: - $ref: '#/components/schemas/Message' - x-stream-index: "006" - message_id: - type: string x-stream-index: "005" - remind_at: + custom: + additionalProperties: {} + description: Custom member response data + title: Custom + type: object + x-stream-index: "004" + deleted_at: + description: Date/time of deletion format: date-time + title: Deleted at type: number - x-stream-index: "009" - task_id: + x-stream-index: "007" + role: + title: Role type: string - x-stream-index: "010" + x-stream-index: "003" updated_at: + description: Date/time of the last update format: date-time + title: Updated at type: number - x-stream-index: "012" + x-stream-index: "006" user: - $ref: '#/components/schemas/User' - x-stream-index: "008" + $ref: '#/components/schemas/UserResponse' + x-stream-index: "001" user_id: type: string - x-stream-index: "007" + x-stream-index: "002" required: - - channel_cid - - message_id + - user - user_id - - task_id + - custom - created_at - updated_at + title: MemberResponse type: object - MessageRequest: + MemberUpdatedEvent: properties: - attachments: + channel_id: + type: string + x-stream-index: "005.002" + channel_type: + type: string + x-stream-index: "005.003" + cid: + type: string + x-stream-index: "005.001" + created_at: + format: date-time + type: number + x-stream-index: "003.002" + member: + $ref: '#/components/schemas/ChannelMember' + x-stream-index: "001.001" + team: + type: string + x-stream-index: "002.001" + type: + default: member.updated + type: string + x-stream-index: "003.001" + user: + $ref: '#/components/schemas/User' + x-stream-index: "004.001" + required: + - type + - created_at + - cid + - channel_id + - channel_type + title: MemberUpdatedEvent + 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 + MembersResponse: + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "002.001" + members: + description: List of found members items: - $ref: '#/components/schemas/Attachment' - maximum: 30 + $ref: '#/components/schemas/ChannelMember' + title: Members type: array - x-stream-index: "004" + x-stream-index: "001" + required: + - members + - duration + type: object + MembershipLevelResponse: + properties: + created_at: + description: When the membership level was created + format: date-time + title: Created At + type: number + x-stream-index: "007" custom: additionalProperties: {} + description: Custom data for the membership level + title: Custom Data type: object - x-stream-index: "007" - html: + x-stream-index: "006" + description: + description: Description of the membership level + title: Description type: string - x-stream-index: "010" + x-stream-index: "003" id: - maxLength: 255 + description: Unique identifier for the membership level + title: ID type: string x-stream-index: "001" - mentioned_users: + name: + description: Display name for the membership level + title: Name + type: string + x-stream-index: "002" + priority: + description: Priority level + format: int32 + title: Priority + type: integer + x-stream-index: "004" + tags: + description: Activity tags this membership level gives access to items: type: string - maximum: 100 + title: Tags type: array - x-stream-index: "008" - mml: - type: string - x-stream-index: "003" - parent_id: - type: string x-stream-index: "005" - pin_expires: + updated_at: + description: When the membership level was last updated format: date-time + title: Updated At type: number - x-stream-index: "015" - pinned: - type: boolean - x-stream-index: "013" - pinned_at: - format: date-time - nullable: true - type: string - x-stream-index: "014" - poll_id: - type: string - x-stream-index: "039" - quoted_message_id: - type: string - x-stream-index: "009" - restricted_visibility: - items: - type: string - maximum: 10 - type: array - x-stream-index: "016" - shared_location: - $ref: '#/components/schemas/SharedLocation' - x-stream-index: "040" - show_in_channel: - type: boolean - x-stream-index: "006" - silent: - type: boolean - x-stream-index: "012" - text: - type: string - x-stream-index: "002" - type: - enum: - - '''''' - - regular - - system - type: string - x-stream-index: "011" - user: - $ref: '#/components/schemas/UserRequest' - x-stream-index: "021.002" - user_id: - type: string - x-stream-index: "021.001" + x-stream-index: "008" + required: + - id + - name + - priority + - tags + - created_at + - updated_at + title: Membership Level Response type: object - MessageResponse: - description: Represents any chat message + Message: properties: attachments: - description: Array of message attachments items: $ref: '#/components/schemas/Attachment' - title: Message attachments type: array - x-stream-docs-page-id: message_format#attachment-format - x-stream-index: "008" + x-stream-index: "012" + before_message_send_failed: + type: boolean + x-stream-index: "046" cid: - description: Channel unique identifier in : format - title: Channel CID type: string - x-stream-index: "022" + x-stream-index: "028" command: - description: Contains provided slash command - title: Command type: string - x-stream-docs-page-id: custom_commands_webhook - x-stream-index: "004" + x-stream-index: "006" created_at: - description: Date/time of creation format: date-time - title: Created at type: number - x-stream-index: "023" + x-stream-index: "030" custom: additionalProperties: {} type: object - x-stream-index: "026" + x-stream-index: "034" deleted_at: - description: Date/time of deletion format: date-time - title: Deleted at type: number - x-stream-index: "025" + x-stream-index: "033" + deleted_for_me: + type: boolean + x-stream-index: "059" deleted_reply_count: format: int32 type: integer - x-stream-index: "018" - draft: - $ref: '#/components/schemas/DraftResponse' - x-stream-index: "041" + x-stream-index: "023" html: - description: Contains HTML markup of the message. Can only be set when using - server-side API - title: HTML content type: string - x-stream-index: "005" + x-stream-index: "007" i18n: additionalProperties: type: string - description: Object with translations. Key `language` contains the original - language key. Other keys contain translations - title: Internationalization info type: object - x-stream-docs-page-id: translation - x-stream-index: "030" + x-stream-index: "044" id: - description: Message ID is unique string identifier of the message - title: ID type: string - x-stream-index: "001" + x-stream-index: "002" image_labels: additionalProperties: items: type: string type: array - description: Contains image moderation information - title: Image moderation labels type: object - x-stream-index: "028" + x-stream-index: "040" latest_reactions: - description: List of 10 latest reactions to this message items: - $ref: '#/components/schemas/ReactionResponse' - title: Latest reactions + $ref: '#/components/schemas/Reaction' type: array - x-stream-index: "009" + x-stream-index: "013" mentioned_users: - description: List of mentioned users items: - $ref: '#/components/schemas/UserResponse' - title: Mentioned Users + $ref: '#/components/schemas/User' type: array - x-stream-index: "029" + x-stream-index: "043" message_text_updated_at: format: date-time type: number - x-stream-index: "036" + x-stream-index: "052" mml: - description: Should be empty if `text` is provided. Can only be set when - using server-side API - title: Messaging Markup Language type: string - x-stream-docs-page-id: mml_overview - x-stream-index: "003" + x-stream-index: "005" moderation: $ref: '#/components/schemas/ModerationV2Response' - x-stream-index: "039" + x-stream-index: "056" own_reactions: - description: List of 10 latest reactions of authenticated user to this message items: - $ref: '#/components/schemas/ReactionResponse' - title: Own reactions + $ref: '#/components/schemas/Reaction' type: array - x-stream-index: "010" + x-stream-index: "014" parent_id: - description: ID of parent message (thread) - title: Parent message ID type: string - x-stream-docs-page-id: threads - x-stream-index: "015" + x-stream-index: "019" pin_expires: - description: Date when pinned message expires format: date-time - title: Pin expiration date type: number - x-stream-docs-page-id: pinned_messages - x-stream-index: "035" + x-stream-index: "051" pinned: - description: Whether message is pinned or not - title: Pinned type: boolean - x-stream-docs-page-id: pinned_messages - x-stream-index: "032" + x-stream-index: "047" pinned_at: - description: Date when message got pinned format: date-time - title: Pinned at type: number - x-stream-docs-page-id: pinned_messages - x-stream-index: "033" + x-stream-index: "048" pinned_by: - $ref: '#/components/schemas/UserResponse' - description: Contains user who pinned the message - title: Pinned by - x-stream-docs-page-id: pinned_messages - x-stream-index: "034" + $ref: '#/components/schemas/User' + x-stream-index: "050" poll: - $ref: '#/components/schemas/PollResponseData' - x-stream-index: "038" + $ref: '#/components/schemas/Poll' + x-stream-index: "054" poll_id: - description: Identifier of the poll to include in the message - title: Poll ID type: string - x-stream-index: "037" + x-stream-index: "053" quoted_message: - $ref: '#/components/schemas/MessageResponse' - description: Contains quoted message - title: Quoted message - x-stream-docs-page-id: threads#quote-message - x-stream-index: "020" + $ref: '#/components/schemas/Message' + x-stream-index: "025" quoted_message_id: - title: ID of quoted message type: string - x-stream-docs-page-id: threads#quote-message - x-stream-index: "019" + x-stream-index: "024" reaction_counts: additionalProperties: format: int32 type: integer - description: 'An object containing number of reactions of each type. Key: - reaction type (string), value: number of reactions (int)' - title: Reaction counts type: object - x-stream-index: "011" + x-stream-index: "015" reaction_groups: additionalProperties: $ref: '#/components/schemas/ReactionGroupResponse' type: object - x-stream-index: "014" + x-stream-index: "017" reaction_scores: additionalProperties: format: int32 type: integer - description: 'An object containing scores of reactions of each type. Key: - reaction type (string), value: total score of reactions (int)' - title: Reaction scores type: object - x-stream-index: "012" + x-stream-index: "016" reminder: - $ref: '#/components/schemas/ReminderResponseData' - x-stream-index: "042" + $ref: '#/components/schemas/MessageReminder' + x-stream-index: "058" reply_count: - description: Number of replies to this message format: int32 - title: Reply count type: integer - x-stream-index: "017" + x-stream-index: "022" restricted_visibility: - description: A list of user ids that have restricted visibility to the message, - if the list is not empty, the message is only visible to the users in - the list items: type: string - title: Restricted visibility type: array - x-stream-index: "040" + x-stream-index: "011" shadowed: - description: Whether the message was shadowed or not - title: Shadowed type: boolean - x-stream-docs-page-id: moderation#shadow-ban - x-stream-index: "027" + x-stream-index: "036" shared_location: - $ref: '#/components/schemas/SharedLocationResponseData' - description: Contains shared location data - title: Shared Location - x-stream-index: "043" + $ref: '#/components/schemas/SharedLocation' + x-stream-index: "055" show_in_channel: - description: Whether thread reply should be shown in the channel as well - title: Show in channel type: boolean - x-stream-docs-page-id: threads - x-stream-index: "016" + x-stream-index: "021" silent: - description: Whether message is silent or not - title: Silent type: boolean - x-stream-index: "031" + x-stream-index: "045" text: - description: Text of the message. Should be empty if `mml` is provided - title: Text type: string - x-stream-index: "002" + x-stream-index: "004" thread_participants: - description: List of users who participate in thread items: - $ref: '#/components/schemas/UserResponse' - title: Thread participants + $ref: '#/components/schemas/User' type: array - x-stream-docs-page-id: threads#quote-message - x-stream-index: "021" + x-stream-index: "027" type: - description: Contains type of the message - enum: - - regular - - ephemeral - - error - - reply - - system - - deleted - title: Message Type type: string - x-stream-docs-page-id: message_format#message-types - x-stream-index: "006" + x-stream-index: "008" updated_at: - description: Date/time of the last update format: date-time - title: Updated at type: number - x-stream-index: "024" + x-stream-index: "031" user: - $ref: '#/components/schemas/UserResponse' - description: Sender of the message. Required when using server-side API - title: User object - x-stream-index: "007" + $ref: '#/components/schemas/User' + x-stream-index: "010" required: - id - text - html - type - - user + - restricted_visibility - attachments - latest_reactions - own_reactions - reaction_counts - reaction_scores + - reaction_groups - reply_count - deleted_reply_count - cid @@ -14067,207 +18307,597 @@ components: - mentioned_users - silent - pinned - - restricted_visibility - title: Message type: object - x-stream-docs-page-id: send_message - MessageStatsResponse: + MessageActionRequest: + nullable: true properties: - count_over_time: - items: - $ref: '#/components/schemas/CountByMinuteResponse' - type: array - x-stream-index: "001" + form_data: + additionalProperties: + type: string + description: ReadOnlyData to execute command with + title: Form data + type: object + x-stream-index: "002" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "003.002" + user_id: + type: string + x-stream-index: "003.001" + required: + - form_data type: object - MessageUnblockedEvent: + MessageChangeSet: properties: - cid: - type: string + attachments: + type: boolean + x-stream-index: "005" + custom: + type: boolean x-stream-index: "001" - created_at: - format: date-time - type: number - x-stream-index: "004.002" - message: - $ref: '#/components/schemas/Message' - x-stream-index: "002.001" - thread_participants: - items: - $ref: '#/components/schemas/User' - type: array - x-stream-index: "002.002" - type: - default: message.unblocked - type: string - x-stream-index: "004.001" - user: - $ref: '#/components/schemas/User' - x-stream-index: "003.001" + html: + type: boolean + x-stream-index: "004" + mentioned_user_ids: + type: boolean + x-stream-index: "006" + mml: + type: boolean + x-stream-index: "003" + pin: + type: boolean + x-stream-index: "009" + quoted_message_id: + type: boolean + x-stream-index: "007" + silent: + type: boolean + x-stream-index: "008" + text: + type: boolean + x-stream-index: "002" required: - - cid - - type - - created_at - title: MessageUnblockedEvent + - custom + - text + - mml + - html + - attachments + - mentioned_user_ids + - quoted_message_id + - silent + - pin 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 - MessageUndeletedEvent: + MessageDeletedEvent: properties: channel_id: type: string - x-stream-index: "005.002" + x-stream-index: "004.002" channel_type: type: string - x-stream-index: "005.003" + x-stream-index: "004.003" cid: type: string - x-stream-index: "005.001" + x-stream-index: "004.001" created_at: format: date-time type: number - x-stream-index: "004.002" + x-stream-index: "007.002" + deleted_for_me: + type: boolean + x-stream-index: "003" + hard_delete: + type: boolean + x-stream-index: "002.001" message: $ref: '#/components/schemas/Message' x-stream-index: "001.001" team: type: string - x-stream-index: "002.001" + x-stream-index: "006.001" thread_participants: items: $ref: '#/components/schemas/User' type: array x-stream-index: "001.002" type: - default: message.undeleted + default: message.deleted type: string - x-stream-index: "004.001" + x-stream-index: "007.001" user: $ref: '#/components/schemas/User' - x-stream-index: "003.001" + x-stream-index: "005.001" required: - - type - - created_at + - hard_delete - cid - channel_id - channel_type - title: MessageUndeletedEvent + - type + - created_at + title: MessageDeletedEvent 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 - MessageUpdate: + MessageFlagResponse: + nullable: true properties: - change_set: - $ref: '#/components/schemas/MessageChangeSet' + approved_at: + format: date-time + type: number + x-stream-index: "013" + created_at: + format: date-time + type: number + x-stream-index: "009" + created_by_automod: + type: boolean + x-stream-index: "001" + custom: + additionalProperties: {} + type: object + x-stream-index: "008" + details: + $ref: '#/components/schemas/FlagDetails' + x-stream-index: "006" + message: + $ref: '#/components/schemas/Message' + x-stream-index: "005" + moderation_feedback: + $ref: '#/components/schemas/FlagFeedback' + x-stream-index: "003" + moderation_result: + $ref: '#/components/schemas/MessageModerationResult' x-stream-index: "002" - old_text: + reason: type: string - x-stream-index: "001" + x-stream-index: "007" + rejected_at: + format: date-time + type: number + x-stream-index: "014" + reviewed_at: + format: date-time + type: number + x-stream-index: "011" + reviewed_by: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "012" + updated_at: + format: date-time + type: number + x-stream-index: "010" + user: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "004" + required: + - created_by_automod + - created_at + - updated_at type: object - MessageUpdatedEvent: + MessageFlaggedEvent: properties: - channel_id: - type: string - x-stream-index: "005.002" - channel_type: - type: string - x-stream-index: "005.003" cid: type: string - x-stream-index: "005.001" + x-stream-index: "001" created_at: format: date-time type: number - x-stream-index: "004.002" + x-stream-index: "005.002" + flag: + $ref: '#/components/schemas/Flag' + x-stream-index: "003.001" message: $ref: '#/components/schemas/Message' - x-stream-index: "001.001" - team: - type: string x-stream-index: "002.001" thread_participants: items: $ref: '#/components/schemas/User' type: array - x-stream-index: "001.002" + x-stream-index: "002.002" type: - default: message.updated + default: message.flagged type: string - x-stream-index: "004.001" + x-stream-index: "005.001" user: $ref: '#/components/schemas/User' - x-stream-index: "003.001" + x-stream-index: "004" required: + - cid - type - created_at - - cid - - channel_id - - channel_type - title: MessageUpdatedEvent + title: MessageFlaggedEvent 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 - MessageWithChannelResponse: - description: Represents any chat message + MessageHistoryEntryResponse: + nullable: true properties: + Custom: + additionalProperties: {} + type: object + writeOnly: true + x-stream-index: "007" attachments: - description: Array of message attachments items: $ref: '#/components/schemas/Attachment' - title: Message attachments type: array - x-stream-docs-page-id: message_format#attachment-format - x-stream-index: "001.008" - channel: - $ref: '#/components/schemas/ChannelResponse' - description: Channel object - title: Channel - x-stream-index: "002" - cid: - description: Channel unique identifier in : format - title: Channel CID - type: string - x-stream-index: "001.022" - command: - description: Contains provided slash command - title: Command + x-stream-index: "006" + is_deleted: + type: boolean + x-stream-index: "004" + message_id: type: string - x-stream-docs-page-id: custom_commands_webhook - x-stream-index: "001.004" - created_at: - description: Date/time of creation + x-stream-index: "001" + message_updated_at: format: date-time - title: Created at type: number - x-stream-index: "001.023" - custom: - additionalProperties: {} - type: object - x-stream-index: "001.026" + x-stream-index: "003" + message_updated_by_id: + type: string + x-stream-index: "002" + text: + type: string + x-stream-index: "005" + required: + - message_id + - message_updated_by_id + - message_updated_at + - is_deleted + - text + - attachments + - Custom + type: object + MessageModerationResult: + description: Result of the message moderation + properties: + action: + description: Action taken by automod + title: Action + type: string + x-stream-index: "002" + ai_moderation_response: + $ref: '#/components/schemas/ModerationResponse' + description: Response from AI moderation + title: ModerationResponse + x-stream-index: "007" + blocked_word: + description: Word that was blocked + title: Blocked word + type: string + x-stream-index: "004" + blocklist_name: + description: Name of the blocklist + title: Blocklist name + type: string + x-stream-index: "005" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: "010" + message_id: + description: ID of the message + title: Message ID + type: string + x-stream-index: "001" + moderated_by: + description: User who moderated the message + title: Moderated by + type: string + x-stream-index: "003" + moderation_thresholds: + $ref: '#/components/schemas/Thresholds' + description: Thresholds for AI moderation + title: Thresholds + x-stream-index: "006" + updated_at: + description: Date/time of the last update + format: date-time + title: Updated at + type: number + x-stream-index: "011" + user_bad_karma: + description: Whether user has bad karma + title: User bad karma + type: boolean + x-stream-index: "009" + user_karma: + description: Karma of the user + format: float + title: User karma + type: number + x-stream-index: "008" + required: + - message_id + - action + - user_karma + - user_bad_karma + - created_at + - updated_at + title: Message moderation result + type: object + MessageNewEvent: + properties: + channel_id: + type: string + x-stream-index: "005.002" + channel_type: + type: string + x-stream-index: "005.003" + cid: + type: string + x-stream-index: "005.001" + created_at: + format: date-time + type: number + x-stream-index: "004.002" + message: + $ref: '#/components/schemas/Message' + x-stream-index: "001.001" + team: + type: string + x-stream-index: "006.001" + thread_participants: + items: + $ref: '#/components/schemas/User' + type: array + x-stream-index: "001.002" + type: + default: message.new + type: string + x-stream-index: "004.001" + user: + $ref: '#/components/schemas/User' + x-stream-index: "003.001" + watcher_count: + format: int32 + type: integer + x-stream-index: "002.001" + required: + - watcher_count + - type + - created_at + - cid + - channel_id + - channel_type + title: MessageNewEvent + 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 + MessageOptions: + properties: + include_thread_participants: + type: boolean + x-stream-index: "001" + type: object + MessagePaginationParams: + type: object + MessageReadEvent: + properties: + channel_id: + type: string + x-stream-index: "003" + channel_last_message_at: + format: date-time + type: number + x-stream-index: "005" + channel_type: + type: string + x-stream-index: "004" + cid: + type: string + x-stream-index: "002" + created_at: + format: date-time + type: number + x-stream-index: "009" + last_read_message_id: + type: string + x-stream-index: "010" + team: + type: string + x-stream-index: "006" + thread: + $ref: '#/components/schemas/ThreadResponse' + x-stream-index: "008" + type: + default: message.read + type: string + x-stream-index: "001" + user: + $ref: '#/components/schemas/UserResponseCommonFields' + x-stream-index: "007" + required: + - type + - cid + - channel_id + - channel_type + - created_at + type: object + MessageReminder: + properties: + channel: + $ref: '#/components/schemas/Channel' + x-stream-index: "004" + channel_cid: + type: string + x-stream-index: "003" + created_at: + format: date-time + type: number + x-stream-index: "011" + message: + $ref: '#/components/schemas/Message' + x-stream-index: "006" + message_id: + type: string + x-stream-index: "005" + remind_at: + format: date-time + type: number + x-stream-index: "009" + task_id: + type: string + x-stream-index: "010" + updated_at: + format: date-time + type: number + x-stream-index: "012" + user: + $ref: '#/components/schemas/User' + x-stream-index: "008" + user_id: + type: string + x-stream-index: "007" + required: + - channel_cid + - message_id + - user_id + - task_id + - created_at + - updated_at + type: object + MessageRequest: + properties: + attachments: + items: + $ref: '#/components/schemas/Attachment' + maximum: 30 + type: array + x-stream-index: "004" + custom: + additionalProperties: {} + type: object + x-stream-index: "007" + html: + type: string + x-stream-index: "010" + id: + maxLength: 255 + type: string + x-stream-index: "001" + mentioned_users: + items: + type: string + maximum: 100 + type: array + x-stream-index: "008" + mml: + type: string + x-stream-index: "003" + parent_id: + type: string + x-stream-index: "005" + pin_expires: + format: date-time + type: number + x-stream-index: "015" + pinned: + type: boolean + x-stream-index: "013" + pinned_at: + format: date-time + nullable: true + type: string + x-stream-index: "014" + poll_id: + type: string + x-stream-index: "039" + quoted_message_id: + type: string + x-stream-index: "009" + restricted_visibility: + items: + type: string + maximum: 10 + type: array + x-stream-index: "016" + shared_location: + $ref: '#/components/schemas/SharedLocation' + x-stream-index: "040" + show_in_channel: + type: boolean + x-stream-index: "006" + silent: + type: boolean + x-stream-index: "012" + text: + type: string + x-stream-index: "002" + type: + enum: + - '''''' + - regular + - system + type: string + x-stream-index: "011" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "021.002" + user_id: + type: string + x-stream-index: "021.001" + type: object + MessageResponse: + description: Represents any chat message + properties: + attachments: + description: Array of message attachments + items: + $ref: '#/components/schemas/Attachment' + title: Message attachments + type: array + x-stream-docs-page-id: message_format#attachment-format + x-stream-index: "008" + cid: + description: Channel unique identifier in : format + title: Channel CID + type: string + x-stream-index: "022" + command: + description: Contains provided slash command + title: Command + type: string + x-stream-docs-page-id: custom_commands_webhook + x-stream-index: "004" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: "023" + custom: + additionalProperties: {} + type: object + x-stream-index: "026" deleted_at: description: Date/time of deletion format: date-time title: Deleted at type: number - x-stream-index: "001.025" + x-stream-index: "025" + deleted_for_me: + type: boolean + x-stream-index: "044" deleted_reply_count: format: int32 type: integer - x-stream-index: "001.018" + x-stream-index: "018" draft: $ref: '#/components/schemas/DraftResponse' - x-stream-index: "001.041" + x-stream-index: "041" html: description: Contains HTML markup of the message. Can only be set when using server-side API title: HTML content type: string - x-stream-index: "001.005" + x-stream-index: "005" i18n: additionalProperties: type: string @@ -14276,12 +18906,12 @@ components: title: Internationalization info type: object x-stream-docs-page-id: translation - x-stream-index: "001.030" + x-stream-index: "030" id: description: Message ID is unique string identifier of the message title: ID type: string - x-stream-index: "001.001" + x-stream-index: "001" image_labels: additionalProperties: items: @@ -14290,93 +18920,93 @@ components: description: Contains image moderation information title: Image moderation labels type: object - x-stream-index: "001.028" + x-stream-index: "028" latest_reactions: description: List of 10 latest reactions to this message items: $ref: '#/components/schemas/ReactionResponse' title: Latest reactions type: array - x-stream-index: "001.009" + x-stream-index: "009" mentioned_users: description: List of mentioned users items: $ref: '#/components/schemas/UserResponse' title: Mentioned Users type: array - x-stream-index: "001.029" + x-stream-index: "029" message_text_updated_at: format: date-time type: number - x-stream-index: "001.036" + x-stream-index: "036" mml: description: Should be empty if `text` is provided. Can only be set when using server-side API title: Messaging Markup Language type: string x-stream-docs-page-id: mml_overview - x-stream-index: "001.003" + x-stream-index: "003" moderation: $ref: '#/components/schemas/ModerationV2Response' - x-stream-index: "001.039" + x-stream-index: "039" own_reactions: description: List of 10 latest reactions of authenticated user to this message items: $ref: '#/components/schemas/ReactionResponse' title: Own reactions type: array - x-stream-index: "001.010" + x-stream-index: "010" parent_id: description: ID of parent message (thread) title: Parent message ID type: string x-stream-docs-page-id: threads - x-stream-index: "001.015" + x-stream-index: "015" pin_expires: description: Date when pinned message expires format: date-time title: Pin expiration date type: number x-stream-docs-page-id: pinned_messages - x-stream-index: "001.035" + x-stream-index: "035" pinned: description: Whether message is pinned or not title: Pinned type: boolean x-stream-docs-page-id: pinned_messages - x-stream-index: "001.032" + x-stream-index: "032" pinned_at: description: Date when message got pinned format: date-time title: Pinned at type: number x-stream-docs-page-id: pinned_messages - x-stream-index: "001.033" + x-stream-index: "033" pinned_by: $ref: '#/components/schemas/UserResponse' description: Contains user who pinned the message title: Pinned by x-stream-docs-page-id: pinned_messages - x-stream-index: "001.034" + x-stream-index: "034" poll: $ref: '#/components/schemas/PollResponseData' - x-stream-index: "001.038" + x-stream-index: "038" poll_id: description: Identifier of the poll to include in the message title: Poll ID type: string - x-stream-index: "001.037" + x-stream-index: "037" quoted_message: $ref: '#/components/schemas/MessageResponse' description: Contains quoted message title: Quoted message x-stream-docs-page-id: threads#quote-message - x-stream-index: "001.020" + x-stream-index: "020" quoted_message_id: title: ID of quoted message type: string x-stream-docs-page-id: threads#quote-message - x-stream-index: "001.019" + x-stream-index: "019" reaction_counts: additionalProperties: format: int32 @@ -14385,12 +19015,12 @@ components: reaction type (string), value: number of reactions (int)' title: Reaction counts type: object - x-stream-index: "001.011" + x-stream-index: "011" reaction_groups: additionalProperties: $ref: '#/components/schemas/ReactionGroupResponse' type: object - x-stream-index: "001.014" + x-stream-index: "014" reaction_scores: additionalProperties: format: int32 @@ -14399,16 +19029,16 @@ components: reaction type (string), value: total score of reactions (int)' title: Reaction scores type: object - x-stream-index: "001.012" + x-stream-index: "012" reminder: $ref: '#/components/schemas/ReminderResponseData' - x-stream-index: "001.042" + x-stream-index: "042" reply_count: description: Number of replies to this message format: int32 title: Reply count type: integer - x-stream-index: "001.017" + x-stream-index: "017" restricted_visibility: description: A list of user ids that have restricted visibility to the message, if the list is not empty, the message is only visible to the users in @@ -14417,34 +19047,34 @@ components: type: string title: Restricted visibility type: array - x-stream-index: "001.040" + x-stream-index: "040" shadowed: description: Whether the message was shadowed or not title: Shadowed type: boolean x-stream-docs-page-id: moderation#shadow-ban - x-stream-index: "001.027" + x-stream-index: "027" shared_location: $ref: '#/components/schemas/SharedLocationResponseData' description: Contains shared location data title: Shared Location - x-stream-index: "001.043" + x-stream-index: "043" show_in_channel: description: Whether thread reply should be shown in the channel as well title: Show in channel type: boolean x-stream-docs-page-id: threads - x-stream-index: "001.016" + x-stream-index: "016" silent: description: Whether message is silent or not title: Silent type: boolean - x-stream-index: "001.031" + x-stream-index: "031" text: description: Text of the message. Should be empty if `mml` is provided title: Text type: string - x-stream-index: "001.002" + x-stream-index: "002" thread_participants: description: List of users who participate in thread items: @@ -14452,7 +19082,7 @@ components: title: Thread participants type: array x-stream-docs-page-id: threads#quote-message - x-stream-index: "001.021" + x-stream-index: "021" type: description: Contains type of the message enum: @@ -14465,18 +19095,18 @@ components: title: Message Type type: string x-stream-docs-page-id: message_format#message-types - x-stream-index: "001.006" + x-stream-index: "006" updated_at: description: Date/time of the last update format: date-time title: Updated at type: number - x-stream-index: "001.024" + x-stream-index: "024" user: $ref: '#/components/schemas/UserResponse' description: Sender of the message. Required when using server-side API title: User object - x-stream-index: "001.007" + x-stream-index: "007" required: - id - text @@ -14499,109 +19129,79 @@ components: - silent - pinned - restricted_visibility - - channel title: Message type: object x-stream-docs-page-id: send_message - ModerationActionConfig: - nullable: true + MessageStatsResponse: properties: - action: - type: string - x-stream-index: "006" - custom: - additionalProperties: {} - type: object - x-stream-index: "009" - description: - type: string - x-stream-index: "008" - entity_type: - type: string - x-stream-index: "004" - icon: - type: string - x-stream-index: "007" - order: - format: int32 - type: integer - x-stream-index: "005" - required: - - entity_type - - order - - action - - icon - - description - - custom + count_over_time: + items: + $ref: '#/components/schemas/CountByMinuteResponse' + type: array + x-stream-index: "001" type: object - ModerationCheckCompletedEvent: - description: This event is sent when a moderation check is completed - nullable: true + MessageUnblockedEvent: properties: - created_at: - format: date-time - type: number - x-stream-index: "001.003" - custom: - additionalProperties: {} - type: object - x-stream-index: "001.007" - entity_id: - description: The ID of entity which was moderated - title: EntityID - type: string - x-stream-index: "002" - entity_type: - description: The type of the entity which was moderated - title: EntityType + cid: type: string - x-stream-index: "003" - received_at: + x-stream-index: "001" + created_at: format: date-time type: number - x-stream-index: "001.004" - recommended_action: - description: The recommended action - title: RecommendedAction - type: string - x-stream-index: "004" - review_queue_item_id: - description: The review queue item ID - title: ReviewQueueItemID - type: string - x-stream-index: "005" + x-stream-index: "004.002" + message: + $ref: '#/components/schemas/Message' + x-stream-index: "002.001" + thread_participants: + items: + $ref: '#/components/schemas/User' + type: array + x-stream-index: "002.002" type: - default: moderation_check.completed + default: message.unblocked type: string - x-stream-index: "001.002" + x-stream-index: "004.001" + user: + $ref: '#/components/schemas/User' + x-stream-index: "003.001" required: + - cid - type - created_at - - custom - - entity_id - - entity_type - - recommended_action - - review_queue_item_id - title: ModerationCheckCompletedEvent + title: MessageUnblockedEvent 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 - ModerationCustomActionEvent: + MessageUndeletedEvent: properties: + channel_id: + type: string + x-stream-index: "005.002" + channel_type: + type: string + x-stream-index: "005.003" + cid: + type: string + x-stream-index: "005.001" created_at: format: date-time type: number x-stream-index: "004.002" - item: - $ref: '#/components/schemas/ReviewQueueItem' - x-stream-index: "001" message: $ref: '#/components/schemas/Message' - x-stream-index: "002" + x-stream-index: "001.001" + team: + type: string + x-stream-index: "002.001" + thread_participants: + items: + $ref: '#/components/schemas/User' + type: array + x-stream-index: "001.002" type: - default: moderation.custom_action + default: message.undeleted type: string x-stream-index: "004.001" user: @@ -14610,112 +19210,449 @@ components: required: - type - created_at - title: ModerationCustomActionEvent + - cid + - channel_id + - channel_type + title: MessageUndeletedEvent 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 - ModerationDashboardPreferences: + MessageUpdate: properties: - flag_user_on_flagged_content: - type: boolean + change_set: + $ref: '#/components/schemas/MessageChangeSet' x-stream-index: "002" - media_queue_blur_enabled: - type: boolean + old_text: + type: string x-stream-index: "001" type: object - ModerationFlagResponse: - nullable: true + MessageUpdatedEvent: properties: + channel_id: + type: string + x-stream-index: "005.002" + channel_type: + type: string + x-stream-index: "005.003" + cid: + type: string + x-stream-index: "005.001" created_at: + format: date-time + type: number + x-stream-index: "004.002" + message: + $ref: '#/components/schemas/Message' + x-stream-index: "001.001" + team: type: string - x-stream-index: "014" + x-stream-index: "002.001" + thread_participants: + items: + $ref: '#/components/schemas/User' + type: array + x-stream-index: "001.002" + type: + default: message.updated + type: string + x-stream-index: "004.001" + user: + $ref: '#/components/schemas/User' + x-stream-index: "003.001" + required: + - type + - created_at + - cid + - channel_id + - channel_type + title: MessageUpdatedEvent + 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 + MessageWithChannelResponse: + description: Represents any chat message + properties: + attachments: + description: Array of message attachments + items: + $ref: '#/components/schemas/Attachment' + title: Message attachments + type: array + x-stream-docs-page-id: message_format#attachment-format + x-stream-index: "001.008" + channel: + $ref: '#/components/schemas/ChannelResponse' + description: Channel object + title: Channel + x-stream-index: "002" + cid: + description: Channel unique identifier in : format + title: Channel CID + type: string + x-stream-index: "001.022" + command: + description: Contains provided slash command + title: Command + type: string + x-stream-docs-page-id: custom_commands_webhook + x-stream-index: "001.004" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: "001.023" custom: additionalProperties: {} type: object - x-stream-index: "009" - entity_creator_id: + x-stream-index: "001.026" + deleted_at: + description: Date/time of deletion + format: date-time + title: Deleted at + type: number + x-stream-index: "001.025" + deleted_for_me: + type: boolean + x-stream-index: "001.044" + deleted_reply_count: + format: int32 + type: integer + x-stream-index: "001.018" + draft: + $ref: '#/components/schemas/DraftResponse' + x-stream-index: "001.041" + html: + description: Contains HTML markup of the message. Can only be set when using + server-side API + title: HTML content type: string - x-stream-index: "006" - entity_id: + x-stream-index: "001.005" + i18n: + additionalProperties: + type: string + description: Object with translations. Key `language` contains the original + language key. Other keys contain translations + title: Internationalization info + type: object + x-stream-docs-page-id: translation + x-stream-index: "001.030" + id: + description: Message ID is unique string identifier of the message + title: ID type: string - x-stream-index: "005" - entity_type: + x-stream-index: "001.001" + image_labels: + additionalProperties: + items: + type: string + type: array + description: Contains image moderation information + title: Image moderation labels + type: object + x-stream-index: "001.028" + latest_reactions: + description: List of 10 latest reactions to this message + items: + $ref: '#/components/schemas/ReactionResponse' + title: Latest reactions + type: array + x-stream-index: "001.009" + mentioned_users: + description: List of mentioned users + items: + $ref: '#/components/schemas/UserResponse' + title: Mentioned Users + type: array + x-stream-index: "001.029" + message_text_updated_at: + format: date-time + type: number + x-stream-index: "001.036" + mml: + description: Should be empty if `text` is provided. Can only be set when + using server-side API + title: Messaging Markup Language type: string - x-stream-index: "004" - id: + x-stream-docs-page-id: mml_overview + x-stream-index: "001.003" + moderation: + $ref: '#/components/schemas/ModerationV2Response' + x-stream-index: "001.039" + own_reactions: + description: List of 10 latest reactions of authenticated user to this message + items: + $ref: '#/components/schemas/ReactionResponse' + title: Own reactions + type: array + x-stream-index: "001.010" + parent_id: + description: ID of parent message (thread) + title: Parent message ID type: string - x-stream-index: "001" - labels: + x-stream-docs-page-id: threads + x-stream-index: "001.015" + pin_expires: + description: Date when pinned message expires + format: date-time + title: Pin expiration date + type: number + x-stream-docs-page-id: pinned_messages + x-stream-index: "001.035" + pinned: + description: Whether message is pinned or not + title: Pinned + type: boolean + x-stream-docs-page-id: pinned_messages + x-stream-index: "001.032" + pinned_at: + description: Date when message got pinned + format: date-time + title: Pinned at + type: number + x-stream-docs-page-id: pinned_messages + x-stream-index: "001.033" + pinned_by: + $ref: '#/components/schemas/UserResponse' + description: Contains user who pinned the message + title: Pinned by + x-stream-docs-page-id: pinned_messages + x-stream-index: "001.034" + poll: + $ref: '#/components/schemas/PollResponseData' + x-stream-index: "001.038" + poll_id: + description: Identifier of the poll to include in the message + title: Poll ID + type: string + x-stream-index: "001.037" + quoted_message: + $ref: '#/components/schemas/MessageResponse' + description: Contains quoted message + title: Quoted message + x-stream-docs-page-id: threads#quote-message + x-stream-index: "001.020" + quoted_message_id: + title: ID of quoted message + type: string + x-stream-docs-page-id: threads#quote-message + x-stream-index: "001.019" + reaction_counts: + additionalProperties: + format: int32 + type: integer + description: 'An object containing number of reactions of each type. Key: + reaction type (string), value: number of reactions (int)' + title: Reaction counts + type: object + x-stream-index: "001.011" + reaction_groups: + additionalProperties: + $ref: '#/components/schemas/ReactionGroupResponse' + type: object + x-stream-index: "001.014" + reaction_scores: + additionalProperties: + format: int32 + type: integer + description: 'An object containing scores of reactions of each type. Key: + reaction type (string), value: total score of reactions (int)' + title: Reaction scores + type: object + x-stream-index: "001.012" + reminder: + $ref: '#/components/schemas/ReminderResponseData' + x-stream-index: "001.042" + reply_count: + description: Number of replies to this message + format: int32 + title: Reply count + type: integer + x-stream-index: "001.017" + restricted_visibility: + description: A list of user ids that have restricted visibility to the message, + if the list is not empty, the message is only visible to the users in + the list items: type: string + title: Restricted visibility type: array - x-stream-index: "010" - moderation_payload: - $ref: '#/components/schemas/ModerationPayload' - x-stream-index: "007" - reason: + x-stream-index: "001.040" + shadowed: + description: Whether the message was shadowed or not + title: Shadowed + type: boolean + x-stream-docs-page-id: moderation#shadow-ban + x-stream-index: "001.027" + shared_location: + $ref: '#/components/schemas/SharedLocationResponseData' + description: Contains shared location data + title: Shared Location + x-stream-index: "001.043" + show_in_channel: + description: Whether thread reply should be shown in the channel as well + title: Show in channel + type: boolean + x-stream-docs-page-id: threads + x-stream-index: "001.016" + silent: + description: Whether message is silent or not + title: Silent + type: boolean + x-stream-index: "001.031" + text: + description: Text of the message. Should be empty if `mml` is provided + title: Text type: string - x-stream-index: "008" - result: + x-stream-index: "001.002" + thread_participants: + description: List of users who participate in thread items: - additionalProperties: {} - type: object + $ref: '#/components/schemas/UserResponse' + title: Thread participants type: array - x-stream-index: "011" - review_queue_item: - $ref: '#/components/schemas/ReviewQueueItemResponse' - x-stream-index: "013" - review_queue_item_id: - type: string - x-stream-index: "012" + x-stream-docs-page-id: threads#quote-message + x-stream-index: "001.021" type: + description: Contains type of the message + enum: + - regular + - ephemeral + - error + - reply + - system + - deleted + title: Message Type type: string - x-stream-index: "002" + x-stream-docs-page-id: message_format#message-types + x-stream-index: "001.006" updated_at: - type: string - x-stream-index: "015" + description: Date/time of the last update + format: date-time + title: Updated at + type: number + x-stream-index: "001.024" user: $ref: '#/components/schemas/UserResponse' - x-stream-index: "003" + description: Sender of the message. Required when using server-side API + title: User object + x-stream-index: "001.007" required: - id + - text + - html - type - - entity_type - - entity_id + - user + - attachments + - latest_reactions + - own_reactions + - reaction_counts + - reaction_scores + - reply_count + - deleted_reply_count + - cid - created_at - updated_at + - custom + - shadowed + - mentioned_users + - silent + - pinned + - restricted_visibility + - channel + title: Message type: object - ModerationFlaggedEvent: + x-stream-docs-page-id: send_message + ModerationActionConfig: + nullable: true + properties: + action: + type: string + x-stream-index: "006" + custom: + additionalProperties: {} + type: object + x-stream-index: "009" + description: + type: string + x-stream-index: "008" + entity_type: + type: string + x-stream-index: "004" + icon: + type: string + x-stream-index: "007" + order: + format: int32 + type: integer + x-stream-index: "005" + required: + - entity_type + - order + - action + - icon + - description + - custom + type: object + ModerationCheckCompletedEvent: + description: This event is sent when a moderation check is completed + nullable: true properties: created_at: format: date-time type: number - x-stream-index: "004.002" - item: - type: string - x-stream-index: "001" - object_id: + x-stream-index: "001.003" + custom: + additionalProperties: {} + type: object + x-stream-index: "001.007" + entity_id: + description: The ID of entity which was moderated + title: EntityID type: string x-stream-index: "002" + entity_type: + description: The type of the entity which was moderated + title: EntityType + type: string + x-stream-index: "003" + received_at: + format: date-time + type: number + x-stream-index: "001.004" + recommended_action: + description: The recommended action + title: RecommendedAction + type: string + x-stream-index: "004" + review_queue_item_id: + description: The review queue item ID + title: ReviewQueueItemID + type: string + x-stream-index: "005" type: - default: moderation.flagged + default: moderation_check.completed type: string - x-stream-index: "004.001" - user: - $ref: '#/components/schemas/User' - x-stream-index: "003.001" + x-stream-index: "001.002" required: - type - created_at - title: ModerationFlaggedEvent + - custom + - entity_id + - entity_type + - recommended_action + - review_queue_item_id + title: ModerationCheckCompletedEvent 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 - ModerationMarkReviewedEvent: + ModerationCustomActionEvent: properties: created_at: format: date-time @@ -14728,7 +19665,7 @@ components: $ref: '#/components/schemas/Message' x-stream-index: "002" type: - default: moderation.mark_reviewed + default: moderation.custom_action type: string x-stream-index: "004.001" user: @@ -14737,29 +19674,159 @@ components: required: - type - created_at - title: ModerationMarkReviewedEvent + title: ModerationCustomActionEvent 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 - ModerationPayload: + ModerationDashboardPreferences: + properties: + flag_user_on_flagged_content: + type: boolean + x-stream-index: "002" + media_queue_blur_enabled: + type: boolean + x-stream-index: "001" + type: object + ModerationFlagResponse: + nullable: true properties: + created_at: + format: date-time + type: number + x-stream-index: "015" custom: additionalProperties: {} type: object - x-stream-index: "004" - images: - items: - type: string - maximum: 30 - type: array - x-stream-index: "002" - texts: + x-stream-index: "010" + entity_creator_id: + type: string + x-stream-index: "007" + entity_id: + type: string + x-stream-index: "006" + entity_type: + type: string + x-stream-index: "005" + labels: items: type: string type: array - x-stream-index: "001" + x-stream-index: "011" + moderation_payload: + $ref: '#/components/schemas/ModerationPayload' + x-stream-index: "008" + reason: + type: string + x-stream-index: "009" + result: + items: + additionalProperties: {} + type: object + type: array + x-stream-index: "012" + review_queue_item: + $ref: '#/components/schemas/ReviewQueueItemResponse' + x-stream-index: "014" + review_queue_item_id: + type: string + x-stream-index: "013" + type: + type: string + x-stream-index: "002" + updated_at: + format: date-time + type: number + x-stream-index: "016" + user: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "004" + user_id: + type: string + x-stream-index: "003" + required: + - type + - user_id + - entity_type + - entity_id + - result + - created_at + - updated_at + type: object + ModerationFlaggedEvent: + properties: + created_at: + format: date-time + type: number + x-stream-index: "004.002" + item: + type: string + x-stream-index: "001" + object_id: + type: string + x-stream-index: "002" + type: + default: moderation.flagged + type: string + x-stream-index: "004.001" + user: + $ref: '#/components/schemas/User' + x-stream-index: "003.001" + required: + - type + - created_at + title: ModerationFlaggedEvent + 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 + ModerationMarkReviewedEvent: + properties: + created_at: + format: date-time + type: number + x-stream-index: "004.002" + item: + $ref: '#/components/schemas/ReviewQueueItem' + x-stream-index: "001" + message: + $ref: '#/components/schemas/Message' + x-stream-index: "002" + type: + default: moderation.mark_reviewed + type: string + x-stream-index: "004.001" + user: + $ref: '#/components/schemas/User' + x-stream-index: "003.001" + required: + - type + - created_at + title: ModerationMarkReviewedEvent + 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 + ModerationPayload: + properties: + custom: + additionalProperties: {} + type: object + x-stream-index: "004" + images: + items: + type: string + maximum: 30 + type: array + x-stream-index: "002" + texts: + items: + type: string + type: array + x-stream-index: "001" videos: items: type: string @@ -14790,6 +19857,70 @@ components: - action - automod_response type: object + ModerationRuleV2Response: + properties: + action: + $ref: '#/components/schemas/RuleBuilderAction' + x-stream-index: "010" + conditions: + items: + $ref: '#/components/schemas/RuleBuilderCondition' + type: array + x-stream-index: "007" + config_keys: + items: + type: string + type: array + x-stream-index: "004" + cooldown_period: + type: string + x-stream-index: "011" + created_at: + format: date-time + type: number + x-stream-index: "013" + description: + type: string + x-stream-index: "003" + enabled: + type: boolean + x-stream-index: "012" + groups: + items: + $ref: '#/components/schemas/RuleBuilderConditionGroup' + type: array + x-stream-index: "009" + id: + type: string + x-stream-index: "001" + logic: + type: string + x-stream-index: "008" + name: + type: string + x-stream-index: "002" + rule_type: + type: string + x-stream-index: "006" + team: + type: string + x-stream-index: "005" + updated_at: + format: date-time + type: number + x-stream-index: "014" + required: + - id + - name + - description + - config_keys + - team + - rule_type + - action + - enabled + - created_at + - updated_at + type: object ModerationV2Response: properties: action: @@ -15006,6 +20137,81 @@ components: required: - mode type: object + NotificationConfig: + properties: + track_read: + description: Whether to track read status + title: Track Read + type: boolean + x-stream-index: "002" + track_seen: + description: Whether to track seen status + title: Track Seen + type: boolean + x-stream-index: "001" + title: Notification Configuration + type: object + NotificationFeedUpdatedEvent: + description: Emitted when notification feed is updated. + nullable: true + properties: + aggregated_activities: + description: Aggregated activities for notification feeds + items: + $ref: '#/components/schemas/AggregatedActivityResponse' + title: Aggregated Activities + type: array + x-stream-index: "001" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 003.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 003.001.007 + feed_visibility: + type: string + x-stream-index: "003.003" + fid: + description: The ID of the feed + title: Feed ID + type: string + x-stream-index: "003.002" + notification_status: + $ref: '#/components/schemas/NotificationStatusResponse' + description: Notification status including unread/unseen counts + title: Notification Status + x-stream-index: "002" + received_at: + format: date-time + type: number + x-stream-index: 003.001.004 + type: + default: feeds.notification_feed.updated + description: 'The type of event: "feeds.notification_feed.updated" in this + case' + title: Event Type + type: string + x-stream-index: 003.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who triggered the notification + title: User + x-stream-index: "004.001" + required: + - type + - created_at + - custom + - fid + title: NotificationFeedUpdatedEvent + 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 NotificationMarkUnreadEvent: properties: channel: @@ -15119,6 +20325,47 @@ components: - call_ring - call_missed type: object + NotificationStatusResponse: + properties: + last_read_at: + format: date-time + type: number + x-stream-index: "006" + last_seen_at: + description: When notifications were last seen + format: date-time + title: Last Seen At + type: number + x-stream-index: "005" + read_activities: + description: IDs of activities that have been read + items: + type: string + title: Read Activities + type: array + x-stream-index: "003" + seen_activities: + items: + type: string + type: array + x-stream-index: "004" + unread: + description: Number of unread notifications + format: int32 + title: Unread + type: integer + x-stream-index: "001" + unseen: + description: Number of unseen notifications + format: int32 + title: Unseen + type: integer + x-stream-index: "002" + required: + - unread + - unseen + title: Notification Status + type: object NullTime: type: object OCRRule: @@ -15160,6 +20407,7 @@ components: - join-backstage - join-call - join-ended-call + - kick-user - mute-users - pin-for-everyone - read-call @@ -15457,6 +20705,21 @@ components: - unread_channels - unread_threads type: object + PagerRequest: + properties: + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "001" + next: + type: string + x-stream-index: "002" + prev: + type: string + x-stream-index: "003" + type: object PagerResponse: properties: next: @@ -15767,6 +21030,52 @@ components: x-stream-event-doc-group: call x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent + PinActivityRequest: + nullable: true + properties: + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "005.002" + user_id: + type: string + x-stream-index: "005.001" + title: Pin Activity Request + type: object + PinActivityResponse: + nullable: true + properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + description: The pinned activity + title: Activity + x-stream-index: "001" + created_at: + description: When the activity was pinned + format: date-time + title: Created At + type: number + x-stream-index: "004" + duration: + type: string + x-stream-index: "005.001" + feed: + description: Fully qualified ID of the feed the activity was pinned to + title: Feed ID + type: string + x-stream-index: "002" + user_id: + description: ID of the user who pinned the activity + title: User ID + type: string + x-stream-index: "003" + required: + - activity + - feed + - user_id + - created_at + - duration + title: Pin Activity Response + type: object PinRequest: description: PinRequest is the payload for pinning a message. nullable: true @@ -16393,6 +21702,9 @@ components: type: object PublisherVideoMetrics: properties: + bitrate: + $ref: '#/components/schemas/ActiveCallsBitrateStats' + x-stream-index: "005" fps_30: $ref: '#/components/schemas/ActiveCallsFPSStats' x-stream-index: "002" @@ -16402,6 +21714,9 @@ components: jitter_ms: $ref: '#/components/schemas/ActiveCallsLatencyStats' x-stream-index: "001" + resolution: + $ref: '#/components/schemas/ActiveCallsResolutionStats' + x-stream-index: "004" type: object PublishersMetrics: properties: @@ -16424,6 +21739,22 @@ components: required: - version type: object + PushNotificationConfig: + properties: + activity_types: + enum: + - follow + - comment + - reaction + - comment_reaction + items: + type: string + type: array + x-stream-index: "002" + enabled: + type: boolean + x-stream-index: "001" + type: object PushNotificationFields: properties: apn: @@ -16498,11 +21829,25 @@ components: description: Disable push notifications till a certain time format: date-time type: number + x-stream-index: "007" + feeds_events: + $ref: '#/components/schemas/FeedsEventPreferencesInput' + description: Set granular feeds event preferences for reactions, comments, + new followers, and mentions + x-stream-index: "006" + feeds_level: + description: Set the level of feeds push notifications for the user. One + of all, none, default + enum: + - all + - none + - default + type: string x-stream-index: "005" remove_disable: description: Remove the disabled until time. (IE stop snoozing notifications) type: boolean - x-stream-index: "006" + x-stream-index: "008" user_id: description: The user id for which to set the push preferences. Required when using server side auths, defaults to current user with client side @@ -16521,6 +21866,12 @@ components: disabled_until: format: date-time type: number + x-stream-index: "005" + feeds_events: + $ref: '#/components/schemas/FeedsEventPreferences' + x-stream-index: "004" + feeds_level: + type: string x-stream-index: "003" type: object PushProvider: @@ -16733,6 +22084,12 @@ components: - message.updated - reaction.new - notification.reminder_due + - feeds.activity.added + - feeds.comment.added + - feeds.activity.reaction.added + - feeds.comment.reaction.added + - feeds.follow.created + - feeds.notification_feed.updated type: string x-stream-index: "005" template: @@ -16794,6 +22151,117 @@ components: required: - daily type: object + QueryActivitiesRequest: + nullable: true + properties: + filter: + additionalProperties: {} + description: Filters to apply to the query. Supports location-based queries + with 'near' and 'within_bounds' operators. + title: Filter + type: object + x-stream-index: "001" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "003.001" + next: + type: string + x-stream-index: "003.002" + prev: + type: string + x-stream-index: "003.003" + sort: + description: Sorting parameters for the query + items: + $ref: '#/components/schemas/SortParamRequest' + maximum: 5 + title: Sort + type: array + x-stream-index: "002" + title: Query Activities Request + type: object + QueryActivitiesResponse: + nullable: true + properties: + activities: + description: List of activities matching the query + items: + $ref: '#/components/schemas/ActivityResponse' + title: Activities + type: array + x-stream-index: "001" + duration: + type: string + x-stream-index: "003.001" + next: + description: Cursor for next page + title: Next + type: string + x-stream-index: "002.001" + prev: + description: Cursor for previous page + title: Previous + type: string + x-stream-index: "002.002" + required: + - activities + - duration + title: Query Activities Response + type: object + QueryActivityReactionsRequest: + nullable: true + properties: + filter: + additionalProperties: {} + type: object + x-stream-index: "002" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "004.001" + next: + type: string + x-stream-index: "004.002" + prev: + type: string + x-stream-index: "004.003" + sort: + items: + $ref: '#/components/schemas/SortParamRequest' + maximum: 5 + type: array + x-stream-index: "003" + type: object + QueryActivityReactionsResponse: + description: Basic response information + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "003.001" + next: + type: string + x-stream-index: "002.001" + prev: + type: string + x-stream-index: "002.002" + reactions: + items: + $ref: '#/components/schemas/FeedsReactionResponse' + type: array + x-stream-index: "001" + required: + - reactions + - duration + title: Response + type: object QueryAggregateCallStatsRequest: nullable: true properties: @@ -16905,6 +22373,123 @@ components: - bans - duration type: object + QueryBookmarkFoldersRequest: + nullable: true + properties: + filter: + additionalProperties: {} + description: Filters to apply to the query + title: Filter + type: object + x-stream-index: "001" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "003.001" + next: + type: string + x-stream-index: "003.002" + prev: + type: string + x-stream-index: "003.003" + sort: + description: Sorting parameters for the query + items: + $ref: '#/components/schemas/SortParamRequest' + title: Sort + type: array + x-stream-index: "002" + title: Query Bookmark Folders Request + type: object + QueryBookmarkFoldersResponse: + nullable: true + properties: + bookmark_folders: + description: List of bookmark folders matching the query + items: + $ref: '#/components/schemas/BookmarkFolderResponse' + title: Bookmark Folders + type: array + x-stream-index: "001" + duration: + type: string + x-stream-index: "003.001" + next: + description: Cursor for next page + title: Next + type: string + x-stream-index: "002.001" + prev: + description: Cursor for previous page + title: Previous + type: string + x-stream-index: "002.002" + required: + - bookmark_folders + - duration + title: Query Bookmark Folders Response + type: object + QueryBookmarksRequest: + nullable: true + properties: + filter: + additionalProperties: {} + description: Filters to apply to the query + title: Filter + type: object + x-stream-index: "001" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "003.001" + next: + type: string + x-stream-index: "003.002" + prev: + type: string + x-stream-index: "003.003" + sort: + description: Sorting parameters for the query + items: + $ref: '#/components/schemas/SortParamRequest' + maximum: 5 + title: Sort + type: array + x-stream-index: "002" + title: Query Bookmarks Request + type: object + QueryBookmarksResponse: + nullable: true + properties: + bookmarks: + description: List of bookmarks matching the query + items: + $ref: '#/components/schemas/BookmarkResponse' + title: Bookmarks + type: array + x-stream-index: "001" + duration: + type: string + x-stream-index: "003.001" + next: + description: Cursor for next page + title: Next + type: string + x-stream-index: "002.001" + prev: + description: Cursor for previous page + title: Previous + type: string + x-stream-index: "002.002" + required: + - bookmarks + - duration + title: Query Bookmarks Response + type: object QueryCallMembersRequest: nullable: true properties: @@ -17252,6 +22837,123 @@ components: - duration title: Channels list type: object + QueryCommentReactionsRequest: + nullable: true + properties: + filter: + additionalProperties: {} + type: object + x-stream-index: "002" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "004.001" + next: + type: string + x-stream-index: "004.002" + prev: + type: string + x-stream-index: "004.003" + sort: + items: + $ref: '#/components/schemas/SortParamRequest' + maximum: 5 + type: array + x-stream-index: "003" + type: object + QueryCommentReactionsResponse: + description: Basic response information + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "003.001" + next: + type: string + x-stream-index: "002.001" + prev: + type: string + x-stream-index: "002.002" + reactions: + items: + $ref: '#/components/schemas/FeedsReactionResponse' + type: array + x-stream-index: "001" + required: + - reactions + - duration + title: Response + type: object + QueryCommentsRequest: + nullable: true + properties: + filter: + additionalProperties: {} + description: MongoDB-style filter for querying comments + title: Filter + type: object + x-stream-index: "001" + limit: + description: Maximum number of comments to return + format: int32 + maximum: 100 + minimum: 0 + title: Limit + type: integer + x-stream-index: "003.001" + next: + type: string + x-stream-index: "003.002" + prev: + type: string + x-stream-index: "003.003" + sort: + description: first (oldest), last (newest) or top + enum: + - first + - last + - top + - best + - controversial + title: Sort Order + type: string + x-stream-index: "002" + required: + - filter + title: Query Comments Request + type: object + QueryCommentsResponse: + nullable: true + properties: + comments: + description: List of comments matching the query + items: + $ref: '#/components/schemas/CommentResponse' + title: Comments + type: array + x-stream-index: "001" + duration: + type: string + x-stream-index: "003.001" + next: + description: Cursor for next page + title: Next + type: string + x-stream-index: "002.001" + prev: + description: Cursor for previous page + title: Previous + type: string + x-stream-index: "002.002" + required: + - comments + - duration + title: Query Comments Response + type: object QueryDraftsRequest: nullable: true properties: @@ -17314,6 +23016,63 @@ components: - drafts - duration type: object + QueryFeedMembersRequest: + nullable: true + properties: + filter: + additionalProperties: {} + description: Filter parameters for the query + title: object + type: object + x-stream-index: "003" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "005.001" + next: + type: string + x-stream-index: "005.002" + prev: + type: string + x-stream-index: "005.003" + sort: + description: Sort parameters for the query + items: + $ref: '#/components/schemas/SortParamRequest' + maximum: 5 + title: array + type: array + x-stream-index: "004" + type: object + QueryFeedMembersResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "003.001" + members: + description: List of feed members + items: + $ref: '#/components/schemas/FeedMemberResponse' + title: array + type: array + x-stream-index: "001" + next: + description: Cursor for next page + title: Next + type: string + x-stream-index: "002.001" + prev: + description: Cursor for previous page + title: Previous + type: string + x-stream-index: "002.002" + required: + - members + - duration + type: object QueryFeedModerationTemplate: properties: config: @@ -17360,6 +23119,129 @@ components: - templates - duration type: object + QueryFeedsRequest: + nullable: true + properties: + filter: + additionalProperties: {} + description: Filters to apply to the query + title: Filter + type: object + x-stream-index: "001" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "004.001" + next: + type: string + x-stream-index: "004.002" + prev: + type: string + x-stream-index: "004.003" + sort: + description: Sorting parameters for the query + items: + $ref: '#/components/schemas/SortParamRequest' + maximum: 5 + title: Sort + type: array + x-stream-index: "003" + watch: + description: Whether to subscribe to realtime updates + title: Watch + type: boolean + x-stream-index: "002" + title: Query Feeds Request + type: object + QueryFeedsResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "003.001" + feeds: + description: List of feeds matching the query + items: + $ref: '#/components/schemas/FeedResponse' + title: Feeds + type: array + x-stream-index: "001" + next: + description: Cursor for next page + title: Next + type: string + x-stream-index: "002.001" + prev: + description: Cursor for previous page + title: Previous + type: string + x-stream-index: "002.002" + required: + - feeds + - duration + title: Query Feeds Response + type: object + QueryFollowsRequest: + nullable: true + properties: + filter: + additionalProperties: {} + description: Filters to apply to the query + title: Filter + type: object + x-stream-index: "001" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "003.001" + next: + type: string + x-stream-index: "003.002" + prev: + type: string + x-stream-index: "003.003" + sort: + description: Sorting parameters for the query + items: + $ref: '#/components/schemas/SortParamRequest' + maximum: 5 + title: Sort + type: array + x-stream-index: "002" + title: Query Follows Request + type: object + QueryFollowsResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "003.001" + follows: + description: List of follow relationships matching the query + items: + $ref: '#/components/schemas/FollowResponse' + title: Follows + type: array + x-stream-index: "001" + next: + description: Cursor for next page + title: Next + type: string + x-stream-index: "002.001" + prev: + description: Cursor for previous page + title: Previous + type: string + x-stream-index: "002.002" + required: + - follows + - duration + title: Query Follows Response + type: object QueryMembersPayload: description: Client request properties: @@ -17408,6 +23290,63 @@ components: - filter_conditions title: ClientRequest type: object + QueryMembershipLevelsRequest: + nullable: true + properties: + filter: + additionalProperties: {} + description: Filters to apply to the query + title: Filter + type: object + x-stream-index: "001" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "003.001" + next: + type: string + x-stream-index: "003.002" + prev: + type: string + x-stream-index: "003.003" + sort: + description: Sorting parameters for the query + items: + $ref: '#/components/schemas/SortParamRequest' + maximum: 5 + title: Sort + type: array + x-stream-index: "002" + title: Query Membership Levels Request + type: object + QueryMembershipLevelsResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "003.001" + membership_levels: + items: + $ref: '#/components/schemas/MembershipLevelResponse' + type: array + x-stream-index: "001" + next: + description: Cursor for next page + title: Next + type: string + x-stream-index: "002.001" + prev: + description: Cursor for previous page + title: Previous + type: string + x-stream-index: "002.002" + required: + - membership_levels + - duration + title: Query Membership Levels Response + type: object QueryMessageFlagsPayload: properties: filter_conditions: @@ -17689,6 +23628,72 @@ components: - logs - duration type: object + QueryModerationRulesRequest: + nullable: true + properties: + filter: + additionalProperties: {} + description: Filter conditions for moderation rules + title: Filter + type: object + x-stream-index: "001" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "003.001" + next: + type: string + x-stream-index: "003.002" + prev: + type: string + x-stream-index: "003.003" + sort: + description: Sorting parameters for the results + items: + $ref: '#/components/schemas/SortParamRequest' + title: Sort + type: array + x-stream-index: "002" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "004.002" + user_id: + type: string + x-stream-index: "004.001" + type: object + QueryModerationRulesResponse: + nullable: true + properties: + default_llm_labels: + additionalProperties: + type: string + description: Default LLM label descriptions + title: DefaultLLMLabels + type: object + x-stream-index: "002" + duration: + type: string + x-stream-index: "004.001" + next: + type: string + x-stream-index: "003.001" + prev: + type: string + x-stream-index: "003.002" + rules: + description: List of moderation rules + items: + $ref: '#/components/schemas/ModerationRuleV2Response' + title: Rules + type: array + x-stream-index: "001" + required: + - rules + - default_llm_labels + - duration + type: object QueryPollVotesRequest: nullable: true properties: @@ -18445,6 +24450,33 @@ components: - layout title: RTMPSettingsResponse type: object + RankingConfig: + properties: + defaults: + additionalProperties: {} + description: Default values for ranking + title: Defaults + type: object + x-stream-index: "003" + functions: + additionalProperties: + $ref: '#/components/schemas/DecayFunctionConfig' + description: Decay functions configuration + title: Functions + type: object + x-stream-index: "004" + score: + description: Scoring formula + title: Score + type: string + x-stream-index: "002" + type: + description: Type of ranking algorithm + title: Type + type: string + x-stream-index: "001" + title: Ranking Configuration + type: object Reaction: nullable: true properties: @@ -18984,6 +25016,69 @@ components: $ref: '#/components/schemas/VideoOrientation' x-stream-index: "009" type: object + RejectFeedMemberInviteRequest: + nullable: true + properties: + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "003.002" + user_id: + type: string + x-stream-index: "003.001" + title: Reject Feed Member Request + type: object + RejectFeedMemberInviteResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + member: + $ref: '#/components/schemas/FeedMemberResponse' + description: The feed member after rejecting the invite + title: Feed Member + x-stream-index: "001" + required: + - member + - duration + title: Reject Feed Member Response + type: object + RejectFollowRequest: + nullable: true + properties: + source: + description: Fully qualified ID of the source feed + maxLength: 255 + title: Source Feed ID + type: string + x-stream-index: "001" + target: + description: Fully qualified ID of the target feed + maxLength: 255 + title: Target Feed ID + type: string + x-stream-index: "002" + required: + - source + - target + title: Reject Follow Request + type: object + RejectFollowResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + follow: + $ref: '#/components/schemas/FollowResponse' + description: The rejected follow relationship + title: Follow + x-stream-index: "001" + required: + - follow + - duration + title: Reject Follow Response + type: object ReminderCreatedEvent: description: Emitted when a reminder is created. nullable: true @@ -19273,6 +25368,38 @@ components: x-stream-event-doc-group: other x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent + RepliesMeta: + description: Cursor & depth information for a comment's direct replies. Mirrors + Reddit's 'load more replies' semantics. + properties: + depth_truncated: + description: True if the subtree was cut because the requested depth was + reached. + title: Depth Truncated + type: boolean + x-stream-index: "004" + has_more: + description: True if more siblings exist in the database. + title: Has More + type: boolean + x-stream-index: "001" + next_cursor: + description: Opaque cursor to request the next page of siblings. + title: Next Cursor + type: string + x-stream-index: "002" + remaining: + description: Number of unread siblings that match current filters. + format: int32 + title: Remaining + type: integer + x-stream-index: "003" + required: + - has_more + - remaining + - depth_truncated + title: Replies Meta + type: object ReportByHistogramBucket: properties: category: @@ -19529,7 +25656,7 @@ components: flags: description: The flags associated with this review queue item items: - $ref: '#/components/schemas/FlagResponse' + $ref: '#/components/schemas/ModerationFlagResponse' title: Flags type: array x-stream-index: "003" @@ -19636,7 +25763,7 @@ components: flags: description: Associated flag records items: - $ref: '#/components/schemas/FlagResponse' + $ref: '#/components/schemas/ModerationFlagResponse' title: Flags type: array x-stream-index: "023" @@ -19746,7 +25873,7 @@ components: flags: description: The flags associated with this review queue item items: - $ref: '#/components/schemas/FlagResponse' + $ref: '#/components/schemas/ModerationFlagResponse' title: Flags type: array x-stream-index: "003" @@ -19901,8 +26028,6 @@ components: type: type: string x-stream-index: "001" - required: - - type type: object RuleBuilderCondition: properties: @@ -19931,6 +26056,9 @@ components: user_created_within_params: $ref: '#/components/schemas/UserCreatedWithinParameters' x-stream-index: "011" + user_custom_property_params: + $ref: '#/components/schemas/UserCustomPropertyParameters' + x-stream-index: "012" user_rule_params: $ref: '#/components/schemas/UserRuleParameters' x-stream-index: "006" @@ -19940,8 +26068,6 @@ components: video_rule_params: $ref: '#/components/schemas/VideoRuleParameters' x-stream-index: "005" - required: - - type type: object RuleBuilderConditionGroup: properties: @@ -19953,9 +26079,6 @@ components: logic: type: string x-stream-index: "001" - required: - - logic - - conditions type: object RuleBuilderConfig: properties: @@ -19967,48 +26090,37 @@ components: $ref: '#/components/schemas/RuleBuilderRule' type: array x-stream-index: "002" - required: - - rules type: object RuleBuilderRule: properties: action: $ref: '#/components/schemas/RuleBuilderAction' - x-stream-index: "007" + x-stream-index: "006" conditions: items: $ref: '#/components/schemas/RuleBuilderCondition' type: array - x-stream-index: "004" + x-stream-index: "003" cooldown_period: type: string - x-stream-index: "009" - enabled: - type: boolean - x-stream-index: "008" + x-stream-index: "007" groups: items: $ref: '#/components/schemas/RuleBuilderConditionGroup' type: array - x-stream-index: "006" + x-stream-index: "005" id: type: string x-stream-index: "001" logic: type: string - x-stream-index: "005" - name: - type: string - x-stream-index: "002" + x-stream-index: "004" rule_type: type: string - x-stream-index: "003" + x-stream-index: "002" required: - - id - - name - rule_type - action - - enabled type: object S3Request: description: Config for creating Amazon S3 storage. @@ -20276,6 +26388,9 @@ components: format: date-time type: number x-stream-index: "001.025" + deleted_for_me: + type: boolean + x-stream-index: "001.044" deleted_reply_count: format: int32 type: integer @@ -20985,6 +27100,22 @@ components: - duration title: Response type: object + SingleFollowResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + follow: + $ref: '#/components/schemas/FollowResponse' + description: The created follow relationship + title: Follow + x-stream-index: "001" + required: + - follow + - duration + title: Follow Response + type: object SortParam: nullable: true properties: @@ -21441,6 +27572,20 @@ components: - duration title: Response type: object + StoriesConfig: + properties: + expiration_behaviour: + description: Behavior when stories expire + title: Expiration Behavior + type: string + x-stream-index: "001" + skip_watched: + description: Whether to skip already watched stories + title: Skip Watched + type: boolean + x-stream-index: "002" + title: Stories Configuration + type: object SubmitActionRequest: nullable: true properties: @@ -21625,18 +27770,23 @@ components: items: type: string type: array - x-stream-index: "004" + x-stream-index: "005" contains_url: type: boolean - x-stream-index: "002" + x-stream-index: "003" harm_labels: items: type: string type: array x-stream-index: "001" + llm_harm_labels: + additionalProperties: + type: string + type: object + x-stream-index: "002" severity: type: string - x-stream-index: "003" + x-stream-index: "004" type: object TextRuleParameters: properties: @@ -21644,18 +27794,23 @@ components: items: type: string type: array - x-stream-index: "006" + x-stream-index: "007" contains_url: type: boolean - x-stream-index: "004" + x-stream-index: "005" harm_labels: items: type: string type: array x-stream-index: "003" + llm_harm_labels: + additionalProperties: + type: string + type: object + x-stream-index: "004" severity: type: string - x-stream-index: "005" + x-stream-index: "006" threshold: format: int32 type: integer @@ -21663,9 +27818,6 @@ components: time_window: type: string x-stream-index: "002" - required: - - threshold - - time_window type: object ThreadParticipant: description: Represents a user that is participating in a thread. @@ -21980,6 +28132,132 @@ components: x-stream-event-doc-group: other x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent + ThreadedCommentResponse: + description: A comment with an optional, depth‑limited slice of nested replies. + properties: + attachments: + items: + $ref: '#/components/schemas/Attachment' + type: array + x-stream-index: "001.011" + confidence_score: + format: float + type: number + x-stream-index: "001.022" + controversy_score: + format: float + type: number + x-stream-index: "001.023" + created_at: + format: date-time + type: number + x-stream-index: "001.014" + custom: + additionalProperties: {} + type: object + x-stream-index: "001.006" + deleted_at: + format: date-time + type: number + x-stream-index: "001.016" + downvote_count: + format: int32 + type: integer + x-stream-index: "001.020" + id: + type: string + x-stream-index: "001.001" + latest_reactions: + items: + $ref: '#/components/schemas/FeedsReactionResponse' + type: array + x-stream-index: "001.009" + mentioned_users: + items: + $ref: '#/components/schemas/UserResponse' + type: array + x-stream-index: "001.012" + meta: + $ref: '#/components/schemas/RepliesMeta' + description: Pagination & depth info for this node's direct replies. + title: Replies Meta + x-stream-index: "002" + moderation: + $ref: '#/components/schemas/ModerationV2Response' + x-stream-index: "001.017" + object_id: + type: string + x-stream-index: "001.002" + object_type: + type: string + x-stream-index: "001.003" + own_reactions: + items: + $ref: '#/components/schemas/FeedsReactionResponse' + type: array + x-stream-index: "001.024" + parent_id: + type: string + x-stream-index: "001.007" + reaction_count: + format: int32 + type: integer + x-stream-index: "001.008" + reaction_groups: + additionalProperties: + $ref: '#/components/schemas/ReactionGroupResponse' + type: object + x-stream-index: "001.010" + replies: + description: Slice of nested comments (may be empty). + items: + $ref: '#/components/schemas/ThreadedCommentResponse' + title: Replies + type: array + x-stream-index: "003" + reply_count: + format: int32 + type: integer + x-stream-index: "001.018" + score: + format: int32 + type: integer + x-stream-index: "001.021" + status: + type: string + x-stream-index: "001.013" + text: + type: string + x-stream-index: "001.005" + updated_at: + format: date-time + type: number + x-stream-index: "001.015" + upvote_count: + format: int32 + type: integer + x-stream-index: "001.019" + user: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "001.004" + required: + - id + - object_id + - object_type + - user + - reaction_count + - mentioned_users + - status + - created_at + - updated_at + - reply_count + - upvote_count + - downvote_count + - score + - confidence_score + - own_reactions + title: Threaded Comment + type: object Thresholds: description: Sets thresholds for AI moderation properties: @@ -22492,6 +28770,56 @@ components: x-stream-event-doc-group: call x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent + UnfollowBatchRequest: + nullable: true + properties: + follows: + description: List of follow relationships to remove + items: + $ref: '#/components/schemas/FollowPair' + maximum: 100 + minimum: 1 + title: Follows + type: array + x-stream-index: "001" + required: + - follows + title: Unfollow Batch Request + type: object + UnfollowBatchResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + follows: + description: List of follow relationships that were removed + items: + $ref: '#/components/schemas/FollowResponse' + title: Follows + type: array + x-stream-index: "001" + required: + - follows + - duration + title: Unfollow Batch Response + type: object + UnfollowResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + follow: + $ref: '#/components/schemas/FollowResponse' + description: The deleted follow relationship + title: Follow + x-stream-index: "001" + required: + - follow + - duration + title: Unfollow Response + type: object UnmuteChannelRequest: nullable: true properties: @@ -22553,6 +28881,34 @@ components: - duration title: Response type: object + UnpinActivityResponse: + nullable: true + properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + description: The unpinned activity + title: Activity + x-stream-index: "001" + duration: + type: string + x-stream-index: "004.001" + feed: + description: Fully qualified ID of the feed the activity was unpinned from + title: Feed ID + type: string + x-stream-index: "002" + user_id: + description: ID of the user who unpinned the activity + title: User ID + type: string + x-stream-index: "003" + required: + - activity + - feed + - user_id + - duration + title: Unpin Activity Response + type: object UnpinRequest: description: UnpinRequest is the payload for unpinning a message. nullable: true @@ -22713,6 +29069,122 @@ components: - last_read_message_id - parent_message_id type: object + UpdateActivityPartialRequest: + nullable: true + properties: + set: + additionalProperties: {} + description: Map of dot-notation field paths to new values + title: object + type: object + x-stream-index: "002" + unset: + description: List of dot-notation paths to remove + items: + type: string + title: '[]string' + type: array + x-stream-index: "003" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "005.002" + user_id: + type: string + x-stream-index: "005.001" + type: object + UpdateActivityPartialResponse: + nullable: true + properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + description: The updated activity + title: ActivityResponse + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - activity + - duration + type: object + UpdateActivityRequest: + nullable: true + properties: + attachments: + description: List of attachments for the activity + items: + $ref: '#/components/schemas/Attachment' + title: '[]ActivityAttachment' + type: array + x-stream-index: "003" + custom: + additionalProperties: {} + description: Custom data for the activity + title: object + type: object + x-stream-index: "004" + expires_at: + description: Time when the activity will expire + format: date-time + title: string + type: number + x-stream-index: "007" + filter_tags: + description: Tags used for filtering the activity + items: + type: string + title: '[]string' + type: array + x-stream-index: "008" + interest_tags: + description: Tags indicating interest categories + items: + type: string + title: '[]string' + type: array + x-stream-index: "009" + location: + $ref: '#/components/schemas/ActivityLocation' + description: Geographic location for the activity + title: ActivityLocation + x-stream-index: "006" + poll_id: + description: Poll ID + title: string + type: string + x-stream-index: "010" + text: + description: The text content of the activity + title: string + type: string + x-stream-index: "002" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "012.002" + user_id: + type: string + x-stream-index: "012.001" + visibility: + description: Visibility setting for the activity + title: string + type: string + x-stream-index: "005" + type: object + UpdateActivityResponse: + nullable: true + properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + description: The updated activity + title: ActivityResponse + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - activity + - duration + type: object UpdateAppRequest: nullable: true properties: @@ -22810,6 +29282,10 @@ components: image_upload_config: $ref: '#/components/schemas/FileUploadConfig' x-stream-index: "001.029" + max_aggregated_activities_length: + format: int32 + type: integer + x-stream-index: "001.049" migrate_permissions_to_v2: type: boolean x-stream-index: "001.035" @@ -22920,6 +29396,91 @@ components: - duration title: Response type: object + UpdateBookmarkFolderRequest: + nullable: true + properties: + custom: + additionalProperties: {} + description: Custom data for the folder + title: Custom Data + type: object + x-stream-index: "003" + name: + description: Name of the folder + maxLength: 255 + title: Name + type: string + x-stream-index: "002" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "004.002" + user_id: + type: string + x-stream-index: "004.001" + title: Update Bookmark Folder Request + type: object + UpdateBookmarkFolderResponse: + nullable: true + properties: + bookmark_folder: + $ref: '#/components/schemas/BookmarkFolderResponse' + description: The updated bookmark folder + title: Bookmark Folder + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - bookmark_folder + - duration + title: Update Bookmark Folder Response + type: object + UpdateBookmarkRequest: + nullable: true + properties: + custom: + additionalProperties: {} + description: Custom data for the bookmark + title: Custom Data + type: object + x-stream-index: "005" + folder_id: + description: ID of the folder to move the bookmark to + maxLength: 255 + title: Folder ID + type: string + x-stream-index: "002" + new_folder: + $ref: '#/components/schemas/AddFolderRequest' + x-stream-index: "004" + new_folder_id: + maxLength: 255 + type: string + x-stream-index: "003" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "006.002" + user_id: + type: string + x-stream-index: "006.001" + title: Update Bookmark Request + type: object + UpdateBookmarkResponse: + nullable: true + properties: + bookmark: + $ref: '#/components/schemas/BookmarkResponse' + description: The updated bookmark + title: Bookmark + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - bookmark + - duration + title: Update Bookmark Response + type: object UpdateCallMembersRequest: description: Update call members nullable: true @@ -23269,39 +29830,39 @@ components: items: type: string type: array - x-stream-index: 009.001.026 + x-stream-index: 009.001.027 automod: enum: - disabled - simple - AI type: string - x-stream-index: 009.001.021 + x-stream-index: 009.001.022 automod_behavior: enum: - flag - block - shadow_block type: string - x-stream-index: 009.001.022 + x-stream-index: 009.001.023 automod_thresholds: $ref: '#/components/schemas/Thresholds' - x-stream-index: 009.001.027 + x-stream-index: 009.001.028 blocklist: type: string - x-stream-index: 009.001.023 + x-stream-index: 009.001.024 blocklist_behavior: enum: - flag - block - shadow_block type: string - x-stream-index: 009.001.024 + x-stream-index: 009.001.025 blocklists: items: $ref: '#/components/schemas/BlockListOptions' type: array - x-stream-index: 009.001.025 + x-stream-index: 009.001.026 commands: description: List of commands that channel supports items: @@ -23312,6 +29873,9 @@ components: connect_events: type: boolean x-stream-index: 009.001.004 + count_messages: + type: boolean + x-stream-index: 009.001.019 custom_events: type: boolean x-stream-index: 009.001.012 @@ -23329,7 +29893,7 @@ components: format: int32 maximum: 20000 type: integer - x-stream-index: 009.001.020 + x-stream-index: 009.001.021 mutes: type: boolean x-stream-index: 009.001.009 @@ -23378,7 +29942,7 @@ components: x-stream-index: 009.001.018 skip_last_msg_update_for_system_msgs: type: boolean - x-stream-index: 009.001.030 + x-stream-index: 009.001.031 typing_events: type: boolean x-stream-index: 009.001.002 @@ -23403,39 +29967,39 @@ components: items: type: string type: array - x-stream-index: 003.001.026 + x-stream-index: 003.001.027 automod: enum: - disabled - simple - AI type: string - x-stream-index: 003.001.021 + x-stream-index: 003.001.022 automod_behavior: enum: - flag - block - shadow_block type: string - x-stream-index: 003.001.022 + x-stream-index: 003.001.023 automod_thresholds: $ref: '#/components/schemas/Thresholds' - x-stream-index: 003.001.027 + x-stream-index: 003.001.028 blocklist: type: string - x-stream-index: 003.001.023 + x-stream-index: 003.001.024 blocklist_behavior: enum: - flag - block - shadow_block type: string - x-stream-index: 003.001.024 + x-stream-index: 003.001.025 blocklists: items: $ref: '#/components/schemas/BlockListOptions' type: array - x-stream-index: 003.001.025 + x-stream-index: 003.001.026 commands: items: type: string @@ -23444,6 +30008,9 @@ components: connect_events: type: boolean x-stream-index: 003.001.004 + count_messages: + type: boolean + x-stream-index: 003.001.019 created_at: format: date-time type: number @@ -23468,7 +30035,7 @@ components: format: int32 maximum: 20000 type: integer - x-stream-index: 003.001.020 + x-stream-index: 003.001.021 mutes: type: boolean x-stream-index: 003.001.009 @@ -23478,13 +30045,13 @@ components: partition_size: format: int32 type: integer - x-stream-index: 003.001.028 + x-stream-index: 003.001.029 partition_ttl: example: 24h format: duration nullable: true type: string - x-stream-index: 003.001.029 + x-stream-index: 003.001.030 permissions: items: $ref: '#/components/schemas/PolicyRequest' @@ -23519,7 +30086,7 @@ components: x-stream-index: 003.001.018 skip_last_msg_update_for_system_msgs: type: boolean - x-stream-index: 003.001.030 + x-stream-index: 003.001.031 typing_events: type: boolean x-stream-index: 003.001.002 @@ -23557,6 +30124,7 @@ components: - polls - user_message_reminders - shared_locations + - count_messages - message_retention - max_message_length - automod @@ -23607,6 +30175,41 @@ components: - duration title: UpdateCommandResponse type: object + UpdateCommentRequest: + nullable: true + properties: + comment: + description: Updated text content of the comment + title: Comment + type: string + x-stream-index: "002" + custom: + additionalProperties: {} + description: Updated custom data for the comment + title: Custom Data + type: object + x-stream-index: "003" + skip_push: + type: boolean + x-stream-index: "004" + title: Update Comment Request + type: object + UpdateCommentResponse: + nullable: true + properties: + comment: + $ref: '#/components/schemas/CommentResponse' + description: The updated comment + title: Comment + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - comment + - duration + title: Update Comment Response + type: object UpdateExternalStorageRequest: description: External storage nullable: true @@ -23681,6 +30284,271 @@ components: - duration title: Response type: object + UpdateFeedGroupRequest: + nullable: true + properties: + activity_processors: + description: Configuration for activity processors (max 10) + items: + $ref: '#/components/schemas/ActivityProcessorConfig' + maximum: 10 + title: Activity Processors + type: array + x-stream-index: "005" + activity_selectors: + description: Configuration for activity selectors (max 10) + items: + $ref: '#/components/schemas/ActivitySelectorConfig' + maximum: 10 + title: Activity Selectors + type: array + x-stream-index: "006" + aggregation: + $ref: '#/components/schemas/AggregationConfig' + description: Configuration for activity aggregation + title: Aggregation + x-stream-index: "008" + custom: + additionalProperties: {} + description: Custom data for the feed group + title: Custom Data + type: object + x-stream-index: "004" + notification: + $ref: '#/components/schemas/NotificationConfig' + description: Configuration for notifications + title: Notification + x-stream-index: "002" + push_notification: + $ref: '#/components/schemas/PushNotificationConfig' + x-stream-index: "003" + ranking: + $ref: '#/components/schemas/RankingConfig' + description: Configuration for activity ranking + title: Ranking + x-stream-index: "007" + title: Update Feed Group Request + type: object + UpdateFeedGroupResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + feed_group: + $ref: '#/components/schemas/FeedGroupResponse' + description: The updated feed group + title: Feed Group + x-stream-index: "001" + required: + - feed_group + - duration + title: Update Feed Group Response + type: object + UpdateFeedMembersRequest: + nullable: true + properties: + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "006.001" + members: + description: List of members to upsert, remove, or set + items: + $ref: '#/components/schemas/FeedMemberRequest' + title: Members + type: array + x-stream-index: "004" + next: + type: string + x-stream-index: "006.002" + operation: + description: Type of update operation to perform + enum: + - upsert + - remove + - set + title: Operation + type: string + x-stream-index: "003" + prev: + type: string + x-stream-index: "006.003" + required: + - operation + title: Update Feed Members Request + type: object + UpdateFeedMembersResponse: + description: Basic response information + nullable: true + properties: + added: + items: + $ref: '#/components/schemas/FeedMemberResponse' + type: array + x-stream-index: "001" + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "004.001" + removed_ids: + items: + type: string + type: array + x-stream-index: "003" + updated: + items: + $ref: '#/components/schemas/FeedMemberResponse' + type: array + x-stream-index: "002" + required: + - added + - updated + - removed_ids + - duration + title: Response + type: object + UpdateFeedRequest: + nullable: true + properties: + created_by_id: + description: ID of the new feed creator (owner) + title: Created By ID + type: string + x-stream-index: "003" + custom: + additionalProperties: {} + description: Custom data for the feed + title: Custom Data + type: object + x-stream-index: "004" + title: Update Feed Request + type: object + UpdateFeedResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + feed: + $ref: '#/components/schemas/FeedResponse' + description: The updated feed + title: Feed + x-stream-index: "001" + required: + - feed + - duration + title: Update Feed Response + type: object + UpdateFeedViewRequest: + nullable: true + properties: + activity_processors: + description: Updated activity processors + items: + $ref: '#/components/schemas/ActivityProcessorConfig' + title: Activity Processors + type: array + x-stream-index: "002.002" + activity_selectors: + description: Updated configuration for selecting activities + items: + $ref: '#/components/schemas/ActivitySelectorConfig' + title: Activity Selectors + type: array + x-stream-index: "002.001" + aggregation: + $ref: '#/components/schemas/AggregationConfig' + description: Updated configuration for aggregating activities + title: Aggregation + x-stream-index: "002.004" + ranking: + $ref: '#/components/schemas/RankingConfig' + description: Updated configuration for ranking activities + title: Ranking + x-stream-index: "002.003" + title: Update Feed View Request + type: object + UpdateFeedViewResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + feed_view: + $ref: '#/components/schemas/FeedViewResponse' + description: The updated feed view + title: Feed View + x-stream-index: "001" + required: + - feed_view + - duration + title: Update Feed View Response + type: object + UpdateFollowRequest: + nullable: true + properties: + create_notification_activity: + description: Whether to create a notification activity for this follow + title: Create Notification Activity + type: boolean + x-stream-index: "001.004" + custom: + additionalProperties: {} + description: Custom data for the follow relationship + title: Custom Data + type: object + x-stream-index: "001.002" + follower_role: + type: string + x-stream-index: "002" + push_preference: + description: Push preference for the follow relationship + enum: + - all + - none + title: Push Preference + type: string + x-stream-index: "001.003" + skip_push: + type: boolean + x-stream-index: "001.005" + source: + description: Fully qualified ID of the source feed + maxLength: 255 + title: Source Feed + type: string + x-stream-index: 001.001.001 + target: + description: Fully qualified ID of the target feed + maxLength: 255 + title: Target Feed + type: string + x-stream-index: 001.001.002 + required: + - source + - target + title: Update Follow Request + type: object + UpdateFollowResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + follow: + $ref: '#/components/schemas/FollowResponse' + description: Details of the updated follow relationship + title: Follow + x-stream-index: "001" + required: + - follow + - duration + title: Update Follow Response + type: object UpdateLiveLocationRequest: nullable: true properties: @@ -23743,6 +30611,62 @@ components: required: - duration type: object + UpdateMembershipLevelRequest: + description: Partial update request for membership level fields. Only specified + fields will be updated. + nullable: true + properties: + custom: + additionalProperties: {} + description: Custom data for the membership level + title: Custom Data + type: object + x-stream-index: "006" + description: + description: Optional description of the membership level + maxLength: 1000 + title: Description + type: string + x-stream-index: "003" + name: + description: Display name for the membership level + maxLength: 255 + title: Name + type: string + x-stream-index: "002" + priority: + description: Priority level (higher numbers = higher priority) + format: int32 + minimum: 0 + title: Priority + type: integer + x-stream-index: "004" + tags: + description: Activity tags this membership level gives access to + items: + type: string + maximum: 255 + title: Tags + type: array + x-stream-index: "005" + title: Update Membership Level Request + type: object + UpdateMembershipLevelResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + membership_level: + $ref: '#/components/schemas/MembershipLevelResponse' + description: The updated membership level + title: Membership Level + x-stream-index: "001" + required: + - membership_level + - duration + title: Update Membership Level Response + type: object UpdateMessagePartialRequest: nullable: true properties: @@ -24191,6 +31115,40 @@ components: x-stream-event-doc-group: call x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent + UpsertActivitiesRequest: + nullable: true + properties: + activities: + description: List of activities to create or update + items: + $ref: '#/components/schemas/ActivityRequest' + maximum: 100 + minimum: 1 + title: Activities + type: array + x-stream-index: "001" + required: + - activities + title: Upsert Activities Request + type: object + UpsertActivitiesResponse: + nullable: true + properties: + activities: + description: List of created or updated activities + items: + $ref: '#/components/schemas/ActivityResponse' + title: Activities + type: array + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - activities + - duration + title: Upsert Activities Response + type: object UpsertConfigRequest: nullable: true properties: @@ -24198,7 +31156,7 @@ components: $ref: '#/components/schemas/AIImageConfig' description: Configuration for AI image analysis title: AI Image Config - x-stream-index: "010" + x-stream-index: "011" ai_text_config: $ref: '#/components/schemas/AITextConfig' description: Configuration for AI text analysis @@ -24208,7 +31166,7 @@ components: $ref: '#/components/schemas/AIVideoConfig' description: Configuration for AI video analysis title: AI Video Config - x-stream-index: "011" + x-stream-index: "012" async: description: Whether moderation should be performed asynchronously title: Async @@ -24231,7 +31189,7 @@ components: x-stream-index: "004" aws_rekognition_config: $ref: '#/components/schemas/AIImageConfig' - x-stream-index: "015" + x-stream-index: "016" block_list_config: $ref: '#/components/schemas/BlockListConfig' description: Configuration for block list filtering @@ -24239,23 +31197,28 @@ components: x-stream-index: "007" bodyguard_config: $ref: '#/components/schemas/AITextConfig' - x-stream-index: "014" + x-stream-index: "015" google_vision_config: $ref: '#/components/schemas/GoogleVisionConfig' description: Configuration for Google Vision integration title: Google Vision Config - x-stream-index: "009" + x-stream-index: "010" key: description: Unique identifier for the moderation configuration title: Key type: string x-stream-index: "001" + llm_config: + $ref: '#/components/schemas/LLMConfig' + description: Configuration for customer-configured LLM moderation + title: LLM Config + x-stream-index: "009" rule_builder_config: $ref: '#/components/schemas/RuleBuilderConfig' description: Configuration for custom rule builder (max 3 rules, max 5 conditions per rule) title: Rule Builder Config - x-stream-index: "013" + x-stream-index: "014" team: description: Team associated with the configuration maxLength: 128 @@ -24265,18 +31228,18 @@ components: x-stream-index: "002" user: $ref: '#/components/schemas/UserRequest' - x-stream-index: "017.002" + x-stream-index: "018.002" user_id: type: string - x-stream-index: "017.001" + x-stream-index: "018.001" velocity_filter_config: $ref: '#/components/schemas/VelocityFilterConfig' description: Configuration for velocity-based filtering title: Velocity Filter Config - x-stream-index: "012" + x-stream-index: "013" video_call_rule_config: $ref: '#/components/schemas/VideoCallRuleConfig' - x-stream-index: "016" + x-stream-index: "017" required: - key type: object @@ -24294,6 +31257,69 @@ components: required: - duration type: object + UpsertModerationRuleRequest: + nullable: true + properties: + action: + $ref: '#/components/schemas/RuleBuilderAction' + x-stream-index: "009" + conditions: + items: + $ref: '#/components/schemas/RuleBuilderCondition' + type: array + x-stream-index: "006" + config_keys: + items: + type: string + type: array + x-stream-index: "003" + cooldown_period: + type: string + x-stream-index: "010" + description: + type: string + x-stream-index: "002" + enabled: + type: boolean + x-stream-index: "011" + groups: + items: + $ref: '#/components/schemas/RuleBuilderConditionGroup' + type: array + x-stream-index: "008" + logic: + type: string + x-stream-index: "007" + name: + type: string + x-stream-index: "001" + rule_type: + type: string + x-stream-index: "005" + team: + type: string + x-stream-index: "004" + required: + - name + - rule_type + - action + type: object + UpsertModerationRuleResponse: + description: Basic response information + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "001.001" + rule: + $ref: '#/components/schemas/ModerationRuleV2Response' + x-stream-index: "002" + required: + - duration + title: Response + type: object UpsertModerationTemplateRequest: nullable: true properties: @@ -24427,6 +31453,12 @@ components: - message.updated - reaction.new - notification.reminder_due + - feeds.activity.added + - feeds.comment.added + - feeds.activity.reaction.added + - feeds.comment.reaction.added + - feeds.follow.created + - feeds.notification_feed.updated title: string type: string x-stream-index: "003" @@ -24627,6 +31659,15 @@ components: required: - type type: object + UserCustomPropertyParameters: + properties: + operator: + type: string + x-stream-index: "002" + property_key: + type: string + x-stream-index: "001" + type: object UserDeactivatedEvent: properties: created_at: @@ -24784,6 +31825,84 @@ components: x-stream-event-doc-group: other x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent + UserMessagesDeletedEvent: + description: This event is sent when a user's message get deleted. The event + contains information about the user whose messages got deleted. + nullable: true + properties: + channel_custom: + additionalProperties: {} + type: object + x-stream-index: 001.001.005 + channel_id: + description: The ID of the channel where the target user's messages were + deleted + title: Channel ID + type: string + x-stream-index: 001.002.002 + channel_member_count: + format: int32 + type: integer + x-stream-index: 001.001.004 + channel_type: + description: The type of the channel where the target user's messages were + deleted + title: Channel Type + type: string + x-stream-index: 001.002.001 + cid: + description: The CID of the channel where the target user's messages were + deleted + 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: number + x-stream-index: 001.001.001.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 001.001.001.001.007 + hard_delete: + description: Whether Messages were hard deleted + title: Hard Delete + type: boolean + x-stream-index: "003" + received_at: + format: date-time + type: number + x-stream-index: 001.001.001.001.004 + team: + description: The team of the channel where the target user's messages were + deleted + title: Team + type: string + x-stream-index: 001.001.003 + type: + default: user.messages.deleted + description: 'The type of event: "user.messages.deleted" in this case' + title: Event Type + type: string + x-stream-index: 001.001.001.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The target user whose messages got deleted + title: User + x-stream-index: "002.001" + required: + - type + - created_at + - custom + - user + title: UserMessagesDeletedEvent + 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 UserMute: nullable: true properties: @@ -25601,9 +32720,6 @@ components: time_window: type: string x-stream-index: "002" - required: - - threshold - - time_window type: object VideoSettings: properties: @@ -25811,6 +32927,7 @@ components: call.hls_broadcasting_failed: '#/components/schemas/CallHLSBroadcastingFailedEvent' call.hls_broadcasting_started: '#/components/schemas/CallHLSBroadcastingStartedEvent' call.hls_broadcasting_stopped: '#/components/schemas/CallHLSBroadcastingStoppedEvent' + call.kicked_user: '#/components/schemas/KickedUserEvent' call.live_started: '#/components/schemas/CallLiveStartedEvent' call.member_added: '#/components/schemas/CallMemberAddedEvent' call.member_removed: '#/components/schemas/CallMemberRemovedEvent' @@ -25867,6 +32984,39 @@ components: export.moderation_logs.success: '#/components/schemas/AsyncExportModerationLogsEvent' export.users.error: '#/components/schemas/AsyncExportErrorEvent' export.users.success: '#/components/schemas/AsyncExportUsersEvent' + feeds.activity.added: '#/components/schemas/ActivityAddedEvent' + feeds.activity.deleted: '#/components/schemas/ActivityDeletedEvent' + feeds.activity.marked: '#/components/schemas/ActivityMarkEvent' + feeds.activity.pinned: '#/components/schemas/ActivityPinnedEvent' + feeds.activity.reaction.added: '#/components/schemas/ActivityReactionAddedEvent' + feeds.activity.reaction.deleted: '#/components/schemas/ActivityReactionDeletedEvent' + feeds.activity.reaction.updated: '#/components/schemas/ActivityReactionUpdatedEvent' + feeds.activity.removed_from_feed: '#/components/schemas/ActivityRemovedFromFeedEvent' + feeds.activity.unpinned: '#/components/schemas/ActivityUnpinnedEvent' + feeds.activity.updated: '#/components/schemas/ActivityUpdatedEvent' + feeds.bookmark.added: '#/components/schemas/BookmarkAddedEvent' + feeds.bookmark.deleted: '#/components/schemas/BookmarkDeletedEvent' + feeds.bookmark.updated: '#/components/schemas/BookmarkUpdatedEvent' + feeds.bookmark_folder.deleted: '#/components/schemas/BookmarkFolderDeletedEvent' + feeds.bookmark_folder.updated: '#/components/schemas/BookmarkFolderUpdatedEvent' + feeds.comment.added: '#/components/schemas/CommentAddedEvent' + feeds.comment.deleted: '#/components/schemas/CommentDeletedEvent' + feeds.comment.reaction.added: '#/components/schemas/CommentReactionAddedEvent' + feeds.comment.reaction.deleted: '#/components/schemas/CommentReactionDeletedEvent' + feeds.comment.reaction.updated: '#/components/schemas/CommentReactionUpdatedEvent' + feeds.comment.updated: '#/components/schemas/CommentUpdatedEvent' + feeds.feed.created: '#/components/schemas/FeedCreatedEvent' + feeds.feed.deleted: '#/components/schemas/FeedDeletedEvent' + feeds.feed.updated: '#/components/schemas/FeedUpdatedEvent' + feeds.feed_group.changed: '#/components/schemas/FeedGroupChangedEvent' + feeds.feed_group.deleted: '#/components/schemas/FeedGroupDeletedEvent' + feeds.feed_member.added: '#/components/schemas/FeedMemberAddedEvent' + feeds.feed_member.removed: '#/components/schemas/FeedMemberRemovedEvent' + feeds.feed_member.updated: '#/components/schemas/FeedMemberUpdatedEvent' + feeds.follow.created: '#/components/schemas/FollowCreatedEvent' + feeds.follow.deleted: '#/components/schemas/FollowDeletedEvent' + feeds.follow.updated: '#/components/schemas/FollowUpdatedEvent' + feeds.notification_feed.updated: '#/components/schemas/NotificationFeedUpdatedEvent' flag.updated: '#/components/schemas/FlagUpdatedEvent' member.added: '#/components/schemas/MemberAddedEvent' member.removed: '#/components/schemas/MemberRemovedEvent' @@ -25899,6 +33049,7 @@ components: user.deactivated: '#/components/schemas/UserDeactivatedEvent' user.deleted: '#/components/schemas/UserDeletedEvent' user.flagged: '#/components/schemas/UserFlaggedEvent' + user.messages.deleted: '#/components/schemas/UserMessagesDeletedEvent' user.muted: '#/components/schemas/UserMutedEvent' user.reactivated: '#/components/schemas/UserReactivatedEvent' user.unbanned: '#/components/schemas/UserUnbannedEvent' @@ -25907,7 +33058,17 @@ components: user.updated: '#/components/schemas/UserUpdatedEvent' propertyName: type oneOf: + - $ref: '#/components/schemas/ActivityAddedEvent' + - $ref: '#/components/schemas/ActivityDeletedEvent' + - $ref: '#/components/schemas/ActivityMarkEvent' - $ref: '#/components/schemas/ActivityMarkedEvent' + - $ref: '#/components/schemas/ActivityPinnedEvent' + - $ref: '#/components/schemas/ActivityReactionAddedEvent' + - $ref: '#/components/schemas/ActivityReactionDeletedEvent' + - $ref: '#/components/schemas/ActivityReactionUpdatedEvent' + - $ref: '#/components/schemas/ActivityRemovedFromFeedEvent' + - $ref: '#/components/schemas/ActivityUnpinnedEvent' + - $ref: '#/components/schemas/ActivityUpdatedEvent' - $ref: '#/components/schemas/AnyEvent' - $ref: '#/components/schemas/AsyncBulkImageModerationEvent' - $ref: '#/components/schemas/AsyncExportChannelsEvent' @@ -25918,6 +33079,11 @@ components: - $ref: '#/components/schemas/AsyncExportModerationLogsEvent' - $ref: '#/components/schemas/AsyncExportUsersEvent' - $ref: '#/components/schemas/BlockedUserEvent' + - $ref: '#/components/schemas/BookmarkAddedEvent' + - $ref: '#/components/schemas/BookmarkDeletedEvent' + - $ref: '#/components/schemas/BookmarkFolderDeletedEvent' + - $ref: '#/components/schemas/BookmarkFolderUpdatedEvent' + - $ref: '#/components/schemas/BookmarkUpdatedEvent' - $ref: '#/components/schemas/CallAcceptedEvent' - $ref: '#/components/schemas/CallClosedCaptionsFailedEvent' - $ref: '#/components/schemas/CallClosedCaptionsStartedEvent' @@ -25977,8 +33143,26 @@ components: - $ref: '#/components/schemas/ChannelUpdatedEvent' - $ref: '#/components/schemas/ChannelVisibleEvent' - $ref: '#/components/schemas/ClosedCaptionEvent' + - $ref: '#/components/schemas/CommentAddedEvent' + - $ref: '#/components/schemas/CommentDeletedEvent' + - $ref: '#/components/schemas/CommentReactionAddedEvent' + - $ref: '#/components/schemas/CommentReactionDeletedEvent' + - $ref: '#/components/schemas/CommentReactionUpdatedEvent' + - $ref: '#/components/schemas/CommentUpdatedEvent' - $ref: '#/components/schemas/CustomVideoEvent' + - $ref: '#/components/schemas/FeedCreatedEvent' + - $ref: '#/components/schemas/FeedDeletedEvent' + - $ref: '#/components/schemas/FeedGroupChangedEvent' + - $ref: '#/components/schemas/FeedGroupDeletedEvent' + - $ref: '#/components/schemas/FeedMemberAddedEvent' + - $ref: '#/components/schemas/FeedMemberRemovedEvent' + - $ref: '#/components/schemas/FeedMemberUpdatedEvent' + - $ref: '#/components/schemas/FeedUpdatedEvent' - $ref: '#/components/schemas/FlagUpdatedEvent' + - $ref: '#/components/schemas/FollowCreatedEvent' + - $ref: '#/components/schemas/FollowDeletedEvent' + - $ref: '#/components/schemas/FollowUpdatedEvent' + - $ref: '#/components/schemas/KickedUserEvent' - $ref: '#/components/schemas/MemberAddedEvent' - $ref: '#/components/schemas/MemberRemovedEvent' - $ref: '#/components/schemas/MemberUpdatedEvent' @@ -25994,6 +33178,7 @@ components: - $ref: '#/components/schemas/ModerationCustomActionEvent' - $ref: '#/components/schemas/ModerationFlaggedEvent' - $ref: '#/components/schemas/ModerationMarkReviewedEvent' + - $ref: '#/components/schemas/NotificationFeedUpdatedEvent' - $ref: '#/components/schemas/NotificationMarkUnreadEvent' - $ref: '#/components/schemas/PendingMessageEvent' - $ref: '#/components/schemas/PermissionRequestEvent' @@ -26013,6 +33198,7 @@ components: - $ref: '#/components/schemas/UserDeactivatedEvent' - $ref: '#/components/schemas/UserDeletedEvent' - $ref: '#/components/schemas/UserFlaggedEvent' + - $ref: '#/components/schemas/UserMessagesDeletedEvent' - $ref: '#/components/schemas/UserMutedEvent' - $ref: '#/components/schemas/UserReactivatedEvent' - $ref: '#/components/schemas/UserUnbannedEvent' @@ -26134,20 +33320,3186 @@ components: type: apiKey info: title: Stream API - version: v187.13.0 + version: v191.1.0 openapi: 3.0.3 paths: /api/v2/app: get: description: | - This Method returns the application settings - operationId: GetApp + This Method returns the application settings + operationId: GetApp + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/GetApplicationResponse' + 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: Get App Settings + tags: + - product:common + patch: + description: | + This Method updates one or more application settings + operationId: UpdateApp + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateAppRequest' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/Response' + 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: Update App Settings + tags: + - product:common + /api/v2/blocklists: + get: + description: | + Returns all available block lists + operationId: ListBlockLists + parameters: + - in: query + name: team + schema: + type: string + writeOnly: true + x-stream-index: "001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/ListBlockListResponse' + 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: List block lists + tags: + - product:common + post: + description: | + Creates a new application blocklist, once created the blocklist can be used by any channel type + operationId: CreateBlockList + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateBlockListRequest' + description: Block list + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/CreateBlockListResponse' + 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: Create block list + tags: + - product:common + /api/v2/blocklists/{name}: + delete: + description: | + Deletes previously created application blocklist + operationId: DeleteBlockList + parameters: + - in: path + name: name + required: true + schema: + type: string + writeOnly: true + x-stream-index: "001" + - in: query + name: team + schema: + type: string + x-stream-index: "002" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/Response' + 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: Delete block list + tags: + - product:common + get: + description: | + Returns block list by given name + operationId: GetBlockList + parameters: + - in: path + name: name + required: true + schema: + description: Block list name + title: Name + type: string + writeOnly: true + x-stream-index: "001" + - in: query + name: team + schema: + type: string + writeOnly: true + x-stream-index: "002" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/GetBlockListResponse' + description: GetBlockListResponse + "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: Get block list + tags: + - product:common + put: + description: | + Updates contents of the block list + operationId: UpdateBlockList + parameters: + - in: path + name: name + required: true + schema: + description: Block list name + title: Name + type: string + writeOnly: true + x-stream-index: "001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateBlockListRequest' + description: Update block list + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateBlockListResponse' + 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: Update block list + tags: + - product:common + /api/v2/chat/campaigns/{id}: + get: + description: | + Get campaign by ID. + operationId: GetCampaign + parameters: + - in: path + name: id + required: true + schema: + description: The ID of the campaign (uuid) + maxLength: 255 + title: Campaign ID + type: string + writeOnly: true + x-stream-index: "001" + - in: query + name: prev + schema: + description: Token for the previous page of campaign users + title: Previous Users Page + type: string + writeOnly: true + x-stream-index: "002.001" + - in: query + name: next + schema: + description: Token for the next page of campaign users + title: Next Users Page + type: string + writeOnly: true + x-stream-index: "002.002" + - in: query + name: limit + schema: + description: 'Maximum number of campaign users to return in a single request + (max: 1000)' + format: int32 + maximum: 1000 + minimum: 0 + title: Users Limit + type: integer + writeOnly: true + x-stream-index: "002.003" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/GetCampaignResponse' + 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: Get campaign + tags: + - product:chat + /api/v2/chat/campaigns/{id}/start: + post: + description: | + Starts or schedules a campaign + operationId: StartCampaign + parameters: + - in: path + name: id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/StartCampaignRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/StartCampaignResponse' + 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: Start/schedule campaign + tags: + - product:chat + /api/v2/chat/campaigns/{id}/stop: + post: + description: | + Stops a campaign + operationId: ScheduleCampaign + parameters: + - in: path + name: id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/StopCampaignRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/CampaignResponse' + description: Successful 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: Stop campaign + tags: + - product:chat + /api/v2/chat/campaigns/query: + post: + description: | + Query campaigns with filter query + operationId: QueryCampaigns + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueryCampaignsRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/QueryCampaignsResponse' + 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: Query campaigns + tags: + - product:chat + /api/v2/chat/channels: + post: + description: | + Query channels with filter query + operationId: QueryChannels + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueryChannelsRequest' + description: Query Channels Request + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/QueryChannelsResponse' + description: Channels list + "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: Query channels + tags: + - product:chat + /api/v2/chat/channels/{type}/{id}: + delete: + description: | + Deletes channel + + Sends events: + - channel.deleted + - channel.deleted + operationId: DeleteChannel + parameters: + - in: path + name: type + required: true + schema: + description: Channel type to interact with + title: Channel type + type: string + writeOnly: true + x-stream-index: "001.001" + - in: path + name: id + required: true + schema: + description: Channel ID to interact with + title: Channel ID + type: string + writeOnly: true + x-stream-index: "001.002" + - in: query + name: hard_delete + schema: + type: boolean + x-stream-index: "002" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteChannelResponse' + 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: Delete channel + tags: + - product:chat + patch: + description: | + Updates certain fields of the channel + + Sends events: + - channel.updated + - channel.updated + operationId: UpdateChannelPartial + parameters: + - in: path + name: type + required: true + schema: + description: Channel type to interact with + title: Channel type + type: string + writeOnly: true + x-stream-index: "001.001" + - in: path + name: id + required: true + schema: + description: Channel ID to interact with + title: Channel ID + type: string + writeOnly: true + x-stream-index: "001.002" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateChannelPartialRequest' + description: UpdateChannelPartialRequest + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateChannelPartialResponse' + description: Successful 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: Partially update channel + tags: + - product:chat + post: + description: | + Change channel data + + Sends events: + - channel.updated + - member.added + - member.removed + - member.updated + - message.new + - channel.updated + - member.added + - member.removed + - member.updated + - message.new + operationId: UpdateChannel + parameters: + - in: path + name: type + required: true + schema: + type: string + writeOnly: true + x-stream-index: 013.002.001 + - in: path + name: id + required: true + schema: + type: string + writeOnly: true + x-stream-index: 013.002.002 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateChannelRequest' + description: Channel update request + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateChannelResponse' + description: Successful 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: Update channel + tags: + - product:chat + /api/v2/chat/channels/{type}/{id}/draft: + delete: + description: | + Deletes a draft + + Sends events: + - draft.deleted + operationId: DeleteDraft + parameters: + - in: path + name: type + required: true + schema: + type: string + writeOnly: true + x-stream-index: "002.001" + - in: path + name: id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "002.002" + - in: query + name: parent_id + schema: + description: Parent message ID + title: string + type: string + writeOnly: true + x-stream-index: "001" + - in: query + name: user_id + schema: + type: string + writeOnly: true + x-stream-index: "003.001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/Response' + 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: Delete draft + tags: + - product:chat + get: + description: | + Get a draft + operationId: GetDraft + parameters: + - in: path + name: type + required: true + schema: + type: string + writeOnly: true + x-stream-index: "002.001" + - in: path + name: id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "002.002" + - in: query + name: parent_id + schema: + description: Parent message ID + title: string + type: string + writeOnly: true + x-stream-index: "001" + - in: query + name: user_id + schema: + type: string + writeOnly: true + x-stream-index: "003.001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/GetDraftResponse' + 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: Get draft + tags: + - product:chat + /api/v2/chat/channels/{type}/{id}/event: + post: + description: | + Sends event to the channel + operationId: SendEvent + parameters: + - in: path + name: type + required: true + schema: + description: Channel type to interact with + title: Channel type + type: string + writeOnly: true + x-stream-index: "002.001" + - in: path + name: id + required: true + schema: + description: Channel ID to interact with + title: Channel ID + type: string + writeOnly: true + x-stream-index: "002.002" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SendEventRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/EventResponse' + 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: Send event + tags: + - product:chat + /api/v2/chat/channels/{type}/{id}/file: + delete: + description: | + Deletes previously uploaded file + operationId: DeleteFile + parameters: + - in: path + name: type + required: true + schema: + description: The type of file + title: Type + type: string + writeOnly: true + x-stream-index: "002.001" + - in: path + name: id + required: true + schema: + description: File ID + title: ID + type: string + writeOnly: true + x-stream-index: "002.002" + - in: query + name: url + schema: + description: File URL to delete + title: URL + type: string + writeOnly: true + x-stream-index: "001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/Response' + 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: Delete file + tags: + - product:chat + post: + description: | + Uploads file + operationId: UploadFile + parameters: + - in: path + name: type + required: true + schema: + type: string + writeOnly: true + x-stream-index: "001.001" + - in: path + name: id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "001.002" + requestBody: + content: + multipart/form-data: + schema: + $ref: '#/components/schemas/FileUploadRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/FileUploadResponse' + description: Successful 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: Upload file + tags: + - product:chat + /api/v2/chat/channels/{type}/{id}/hide: + post: + description: | + Marks channel as hidden for current user + + Sends events: + - channel.hidden + - channel.hidden + operationId: HideChannel + parameters: + - in: path + name: type + required: true + schema: + type: string + writeOnly: true + x-stream-index: "002.001" + - in: path + name: id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "002.002" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/HideChannelRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/HideChannelResponse' + 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: Hide channel + tags: + - product:chat + /api/v2/chat/channels/{type}/{id}/image: + delete: + description: | + Deletes previously uploaded image + operationId: DeleteImage + parameters: + - in: path + name: type + required: true + schema: + description: The type of file + title: Type + type: string + writeOnly: true + x-stream-index: "002.001" + - in: path + name: id + required: true + schema: + description: File ID + title: ID + type: string + writeOnly: true + x-stream-index: "002.002" + - in: query + name: url + schema: + description: File URL to delete + title: URL + type: string + writeOnly: true + x-stream-index: "001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/Response' + 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: Delete image + tags: + - product:chat + post: + description: | + Uploads image + operationId: UploadImage + parameters: + - in: path + name: type + required: true + schema: + type: string + writeOnly: true + x-stream-index: 001.001.001 + - in: path + name: id + required: true + schema: + type: string + writeOnly: true + x-stream-index: 001.001.002 + requestBody: + content: + multipart/form-data: + schema: + $ref: '#/components/schemas/ImageUploadRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/ImageUploadResponse' + description: Successful 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: Upload image + tags: + - product:chat + /api/v2/chat/channels/{type}/{id}/member: + patch: + description: |2+ + + operationId: UpdateMemberPartial + parameters: + - in: path + name: type + required: true + schema: + type: string + writeOnly: true + x-stream-index: "003.001" + - in: path + name: id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "003.002" + - in: query + name: user_id + schema: + type: string + writeOnly: true + x-stream-index: "005.001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateMemberPartialRequest' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateMemberPartialResponse' + description: Successful 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: Partially channel member update + tags: + - product:chat + /api/v2/chat/channels/{type}/{id}/message: + post: + description: | + Sends new message to the specified channel + + Sends events: + - message.new + - message.updated + - message.new + - message.updated + operationId: SendMessage + parameters: + - in: path + name: type + required: true + schema: + description: Channel type to interact with + title: Channel type + type: string + writeOnly: true + x-stream-index: "009.001" + - in: path + name: id + required: true + schema: + description: Channel ID to interact with + title: Channel ID + type: string + writeOnly: true + x-stream-index: "009.002" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SendMessageRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/SendMessageResponse' + description: Successful 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: Send new message + tags: + - product:chat + /api/v2/chat/channels/{type}/{id}/messages: + get: + description: | + Returns list messages found by IDs + operationId: GetManyMessages + parameters: + - in: path + name: type + required: true + schema: + type: string + writeOnly: true + x-stream-index: "002.001" + - in: path + name: id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "002.002" + - in: query + name: ids + required: true + schema: + description: List of comma-separated IDs + items: + type: string + maximum: 50 + minimum: 1 + title: IDs + type: array + writeOnly: true + x-stream-index: "001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/GetManyMessagesResponse' + description: Successful 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: Get many messages + tags: + - product:chat + /api/v2/chat/channels/{type}/{id}/query: + post: + description: | + This Method creates a channel or returns an existing one with matching attributes + + Sends events: + - channel.created + - member.added + - member.removed + - member.updated + - user.watching.start + operationId: GetOrCreateChannel + parameters: + - in: path + name: type + required: true + schema: + description: Channel type + maxLength: 64 + title: Type + type: string + writeOnly: true + x-stream-index: "001" + - in: path + name: id + required: true + schema: + description: Channel ID (maximum length of 64 characters) + title: ID + type: string + writeOnly: true + x-stream-index: "002" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChannelGetOrCreateRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/ChannelStateResponse' + description: Successful 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: Get or create channel + tags: + - product:chat + /api/v2/chat/channels/{type}/{id}/read: + post: + description: | + Marks channel as read up to the specific message + + Sends events: + - message.read + - message.read + operationId: MarkRead + parameters: + - in: path + name: type + required: true + schema: + type: string + writeOnly: true + x-stream-index: "003.001" + - in: path + name: id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "003.002" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MarkReadRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/MarkReadResponse' + description: Successful 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 read + tags: + - product:chat + /api/v2/chat/channels/{type}/{id}/show: + post: + description: | + Shows previously hidden channel + + Sends events: + - channel.visible + - channel.visible + operationId: ShowChannel + parameters: + - in: path + name: type + required: true + schema: + description: Channel type to interact with + title: Channel type + type: string + writeOnly: true + x-stream-index: "001.001" + - in: path + name: id + required: true + schema: + description: Channel ID to interact with + title: Channel ID + type: string + writeOnly: true + x-stream-index: "001.002" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ShowChannelRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/ShowChannelResponse' + 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: Show channel + tags: + - product:chat + /api/v2/chat/channels/{type}/{id}/truncate: + post: + description: | + Truncates messages from a channel. Can be applied to the entire channel or scoped to specific members. + + Sends events: + - channel.truncated + - channel.truncated + operationId: TruncateChannel + parameters: + - in: path + name: type + required: true + schema: + type: string + writeOnly: true + x-stream-index: "001.001" + - in: path + name: id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "001.002" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TruncateChannelRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/TruncateChannelResponse' + description: Successful 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: Truncate channel + tags: + - product:chat + /api/v2/chat/channels/{type}/{id}/unread: + post: + description: | + Marks channel as unread from a specific message + operationId: MarkUnread + parameters: + - in: path + name: type + required: true + schema: + type: string + writeOnly: true + x-stream-index: "002.001" + - in: path + name: id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "002.002" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MarkUnreadRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/Response' + 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 unread + tags: + - product:chat + /api/v2/chat/channels/{type}/query: + post: + description: | + This Method creates a channel or returns an existing one with matching attributes + + Sends events: + - channel.created + - member.added + - member.removed + - member.updated + - user.watching.start + operationId: GetOrCreateDistinctChannel + parameters: + - in: path + name: type + required: true + schema: + description: Channel type + maxLength: 64 + title: Type + type: string + writeOnly: true + x-stream-index: "001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChannelGetOrCreateRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/ChannelStateResponse' + description: Successful 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: Get or create channel + tags: + - product:chat + /api/v2/chat/channels/delete: + post: + description: | + Allows to delete several channels at once asynchronously + + Sends events: + - channel.deleted + - channel.deleted + operationId: DeleteChannels + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteChannelsRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteChannelsResponse' + description: Successful 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: Deletes channels asynchronously + tags: + - product:chat + /api/v2/chat/channels/read: + post: + description: | + Marks channels as read up to the specific message. If no channels is given, mark all channel as read + + Sends events: + - message.read + - message.read + operationId: MarkChannelsRead + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MarkChannelsReadRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/MarkReadResponse' + description: Successful 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 channels as read + tags: + - product:chat + /api/v2/chat/channeltypes: + get: + description: | + Lists all available channel types + operationId: ListChannelTypes + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/ListChannelTypesResponse' + description: ListChannelTypesResponse + "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: List channel types + tags: + - product:chat + post: + description: | + Creates new channel type + operationId: CreateChannelType + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateChannelTypeRequest' + description: CreateChannelTypeRequest + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/CreateChannelTypeResponse' + description: Successful 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: Create channel type + tags: + - product:chat + /api/v2/chat/channeltypes/{name}: + delete: + description: | + Deletes channel type + operationId: DeleteChannelType + parameters: + - in: path + name: name + required: true + schema: + description: Channel type name + title: Name + type: string + writeOnly: true + x-stream-index: "001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/Response' + 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: Delete channel type + tags: + - product:chat + get: + description: | + Gets channel type + operationId: GetChannelType + parameters: + - in: path + name: name + required: true + schema: + description: Channel type name + title: Name + type: string + writeOnly: true + x-stream-index: "001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/GetChannelTypeResponse' + 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: Get channel type + tags: + - product:chat + put: + description: | + Updates channel type + operationId: UpdateChannelType + parameters: + - in: path + name: name + required: true + schema: + type: string + writeOnly: true + x-stream-index: "001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateChannelTypeRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateChannelTypeResponse' + description: Successful 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: Update channel type + tags: + - product:chat + /api/v2/chat/commands: + get: + description: | + Returns all custom commands + operationId: ListCommands + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/ListCommandsResponse' + description: ListCommandsResponse + "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: List commands + tags: + - product:chat + post: + description: | + Creates custom chat command + operationId: CreateCommand + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateCommandRequest' + description: CreateCommandRequest + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/CreateCommandResponse' + description: CreateCommandResponse + "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: Create command + tags: + - product:chat + /api/v2/chat/commands/{name}: + delete: + description: | + Deletes custom chat command + operationId: DeleteCommand + parameters: + - in: path + name: name + required: true + schema: + description: Command name + title: Name + type: string + x-stream-index: "001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteCommandResponse' + description: DeleteCommandResponse + "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: Delete command + tags: + - product:chat + get: + description: | + Returns custom command by its name + operationId: GetCommand + parameters: + - in: path + name: name + required: true + schema: + description: Command name + title: Name + type: string + x-stream-index: "001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/GetCommandResponse' + description: GetCommandResponse + "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: Get command + tags: + - product:chat + put: + description: | + Updates custom chat command + operationId: UpdateCommand + parameters: + - in: path + name: name + required: true + schema: + description: Unique command name + title: Name + type: string + writeOnly: true + x-stream-index: "001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateCommandRequest' + description: UpdateCommandRequest + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateCommandResponse' + description: UpdateCommandResponse + "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: Update command + tags: + - product:chat + /api/v2/chat/drafts/query: + post: + description: | + Queries draft messages for a user + operationId: QueryDrafts + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueryDraftsRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/QueryDraftsResponse' + description: Successful 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: Query draft messages + tags: + - product:chat + /api/v2/chat/export_channels: + post: + description: | + Exports channel data to JSON file + operationId: ExportChannels + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ExportChannelsRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/ExportChannelsResponse' + description: Successful 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: Export channels + tags: + - product:chat + /api/v2/chat/members: + get: + description: | + Find and filter channel members + operationId: QueryMembers + parameters: + - content: + application/json: + schema: + $ref: '#/components/schemas/QueryMembersPayload' + x-stream-index: "001" + in: query + name: payload + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/MembersResponse' + description: Successful 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: Query members + tags: + - product:chat + /api/v2/chat/messages/{id}: + delete: + description: | + Deletes message + + Sends events: + - message.deleted + - message.deleted + operationId: DeleteMessage + parameters: + - in: path + name: id + required: true + schema: + description: Message ID to delete + title: ID + type: string + writeOnly: true + x-stream-index: "001" + - in: query + name: hard + schema: + description: Delete all message reactions and replies as well + title: Hard + type: boolean + writeOnly: true + x-stream-index: "002" + - in: query + name: deleted_by + schema: + type: string + writeOnly: true + x-stream-index: "003" + - in: query + name: delete_for_me + schema: + description: Delete the message only for the user making the request + title: Delete for me + type: boolean + writeOnly: true + x-stream-index: "004" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteMessageResponse' + 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: Delete message + tags: + - product:chat + get: + description: | + Returns message by ID + operationId: GetMessage + parameters: + - in: path + name: id + required: true + schema: + description: ID of the message + title: ID + type: string + writeOnly: true + x-stream-index: "001" + - in: query + name: show_deleted_message + schema: + description: Whether to show deleted message + title: Show deleted message + type: boolean + writeOnly: true + x-stream-index: "002" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/GetMessageResponse' + 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: Get message + tags: + - product:chat + post: + description: | + Updates message with new data + + Sends events: + - message.updated + - message.updated + operationId: UpdateMessage + parameters: + - in: path + name: id + required: true + schema: + description: Message ID + title: ID + type: string + writeOnly: true + x-stream-index: "004.001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateMessageRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateMessageResponse' + 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: Update message + tags: + - product:chat + put: + description: | + Updates certain fields of the message + + Sends events: + - message.updated + - message.updated + operationId: UpdateMessagePartial + parameters: + - in: path + name: id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "003.001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateMessagePartialRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateMessagePartialResponse' + description: Successful 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: Partially message update + tags: + - product:chat + /api/v2/chat/messages/{id}/action: + post: + description: | + Executes message command action with given parameters + + Sends events: + - message.new + - message.new + operationId: RunMessageAction + parameters: + - in: path + name: id + required: true + schema: + description: Message ID + title: ID + type: string + writeOnly: true + x-stream-index: "001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MessageActionRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/MessageResponse' + 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: Run message command action + tags: + - product:chat + /api/v2/chat/messages/{id}/commit: + post: + description: | + Commits a pending message, which will make it visible in the channel + + Sends events: + - message.new + - message.updated + - message.new + - message.updated + operationId: CommitMessage + parameters: + - in: path + name: id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CommitMessageRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/MessageResponse' + 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: Commit message + tags: + - product:chat + /api/v2/chat/messages/{id}/reaction: + post: + description: | + Sends reaction to specified message + + Sends events: + - reaction.new + - reaction.updated + operationId: SendReaction + parameters: + - in: path + name: id + required: true + schema: + description: Message ID to send reaction for + title: ID + type: string + writeOnly: true + x-stream-index: "001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SendReactionRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/SendReactionResponse' + 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: Send reaction + tags: + - product:chat + /api/v2/chat/messages/{id}/reaction/{type}: + delete: + description: | + Removes user reaction from the message + + Sends events: + - reaction.deleted + operationId: DeleteReaction + parameters: + - in: path + name: id + required: true + schema: + description: Message ID to remove reaction from + title: ID + type: string + writeOnly: true + x-stream-index: "001" + - in: path + name: type + required: true + schema: + description: Reaction type to remove + title: Type + type: string + writeOnly: true + x-stream-index: "002" + - in: query + name: user_id + schema: + description: '**Server-side only**. User ID which server acts upon' + title: User ID + type: string + writeOnly: true + x-stream-index: "003" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteReactionResponse' + 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: Delete reaction + tags: + - product:chat + /api/v2/chat/messages/{id}/reactions: + get: + description: | + Returns list of reactions of specific message + operationId: GetReactions + parameters: + - in: path + name: id + required: true + schema: + description: Message ID + title: ID + type: string + writeOnly: true + x-stream-index: "001" + - in: query + name: limit + schema: + description: Number of records to return + format: int32 + title: Limit + type: integer + writeOnly: true + x-stream-index: "002" + - in: query + name: offset + schema: + description: Number of records to offset + format: int32 + title: Offset + type: integer + writeOnly: true + x-stream-index: "003" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/GetReactionsResponse' + description: Successful 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: Get reactions + tags: + - product:chat + post: + description: | + Get reactions on a message + operationId: QueryReactions + parameters: + - in: path + name: id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueryReactionsRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/QueryReactionsResponse' + 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 + tags: + - product:chat + /api/v2/chat/messages/{id}/translate: + post: + description: | + Translates message to a given language using automated translation software + + Sends events: + - message.updated + - message.updated + operationId: TranslateMessage + parameters: + - in: path + name: id + required: true + schema: + description: Message ID + title: ID + type: string + writeOnly: true + x-stream-index: "002.001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TranslateMessageRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/MessageResponse' + 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: Translate message + tags: + - product:chat + /api/v2/chat/messages/{id}/undelete: + post: + description: | + Undelete a message that was previously soft-deleted + + Sends events: + - message.undeleted + - message.undeleted + operationId: UndeleteMessage + parameters: + - in: path + name: id + required: true + schema: + description: Message ID + title: ID + type: string + writeOnly: true + x-stream-index: "004.001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateMessageRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateMessageResponse' + 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: Undelete message + tags: + - product:chat + /api/v2/chat/messages/{message_id}/polls/{poll_id}/vote: + post: + description: | + Cast a vote on a poll + + Sends events: + - feeds.poll.vote_casted + - feeds.poll.vote_changed + - feeds.poll.vote_removed + - poll.vote_casted + - poll.vote_changed + - poll.vote_removed + operationId: CastPollVote + parameters: + - in: path + name: message_id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "001" + - in: path + name: poll_id + required: true + schema: + description: Poll ID + maxLength: 255 + title: string + type: string + x-stream-index: "003" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CastPollVoteRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/PollVoteResponse' + description: Successful 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: Cast vote + tags: + - product:chat + /api/v2/chat/messages/{message_id}/polls/{poll_id}/vote/{vote_id}: + delete: + description: | + Delete a vote from a poll + + Sends events: + - feeds.poll.vote_removed + - poll.vote_removed + operationId: DeletePollVote + parameters: + - in: path + name: message_id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "002" + - in: path + name: poll_id + required: true + schema: + description: Poll ID + maxLength: 255 + title: string + type: string + x-stream-index: "004" + - in: path + name: vote_id + required: true + schema: + description: Vote ID + maxLength: 255 + title: string + type: string + x-stream-index: "005" + - in: query + name: user_id + schema: + type: string + writeOnly: true + x-stream-index: "001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/PollVoteResponse' + description: Successful 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: Delete vote + tags: + - product:chat + /api/v2/chat/messages/{message_id}/reminders: + delete: + description: | + Deletes a user's created reminder + + Sends events: + - reminder.deleted + operationId: DeleteReminder + parameters: + - in: path + name: message_id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "002" + - in: query + name: user_id + schema: + type: string + writeOnly: true + x-stream-index: "001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteReminderResponse' + 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: Delete reminder + tags: + - product:chat + patch: + description: | + Updates an existing reminder + + Sends events: + - reminder.updated + operationId: UpdateReminder + parameters: + - in: path + name: message_id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "002" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateReminderRequest' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateReminderResponse' + 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: Updates Reminder + tags: + - product:chat + post: + description: | + Creates a new reminder + + Sends events: + - reminder.created + operationId: CreateReminder + parameters: + - in: path + name: message_id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "002" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateReminderRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/ReminderResponseData' + description: Successful 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: Create reminder + tags: + - product:chat + /api/v2/chat/messages/{parent_id}/replies: + get: + description: | + Returns replies (thread) of the message + operationId: GetReplies + parameters: + - in: path + name: parent_id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "001" + - in: query + name: sort + schema: + items: + $ref: '#/components/schemas/SortParamRequest' + maximum: 1 + type: array + writeOnly: true + x-stream-index: "002" + - in: query + name: limit + schema: + description: 'The maximum number of messages to return (max limit ' + format: int32 + minimum: 0 + title: Limit + type: integer + x-stream-index: "003.001" + - in: query + name: offset + schema: + description: The offset to start from + format: int32 + title: Offset + type: integer + x-stream-index: "003.002" + - in: query + name: id_gte + schema: + description: The ID of the message to get messages with a timestamp greater + than or equal to + title: IDGTE + type: string + x-stream-index: "003.003" + - in: query + name: id_gt + schema: + description: The ID of the message to get messages with a timestamp greater + than + title: IDGT + type: string + x-stream-index: "003.004" + - in: query + name: id_lte + schema: + description: The ID of the message to get messages with a timestamp smaller + than or equal to + title: IDLTE + type: string + x-stream-index: "003.005" + - in: query + name: id_lt + schema: + description: The ID of the message to get messages with a timestamp smaller + than + title: IDLT + type: string + x-stream-index: "003.006" + - in: query + name: created_at_after_or_equal + schema: + description: The timestamp to get messages with a created_at timestamp greater + than or equal to + format: date-time + title: Created_at after or equal + type: number + x-stream-index: "003.007" + - in: query + name: created_at_after + schema: + description: The timestamp to get messages with a created_at timestamp greater + than + format: date-time + title: Created_at after + type: number + x-stream-index: "003.008" + - in: query + name: created_at_before_or_equal + schema: + description: The timestamp to get messages with a created_at timestamp smaller + than or equal to + format: date-time + title: Created_at after before or equal + type: number + x-stream-index: "003.009" + - in: query + name: created_at_before + schema: + description: The timestamp to get messages with a created_at timestamp smaller + than + format: date-time + title: Created_at after before + type: number + x-stream-index: "003.010" + - in: query + name: id_around + schema: + description: The result will be a set of messages, that are both older and + newer than the message with the provided ID, and the message with the + ID provided will be in the middle of the set + title: Id around + type: string + x-stream-index: "003.011" + - in: query + name: created_at_around + schema: + description: The result will be a set of messages, that are both older and + newer than the created_at timestamp provided, distributed evenly around + the timestamp + format: date-time + title: Created_at around + type: number + x-stream-index: "003.012" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/GetRepliesResponse' + 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: Get replies + tags: + - product:chat + /api/v2/chat/messages/history: + post: + description: | + Queries history for one message + operationId: QueryMessageHistory + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueryMessageHistoryRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/QueryMessageHistoryResponse' + description: Successful 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: Query message history + tags: + - product:chat + /api/v2/chat/moderation/flags/message: + get: + description: | + Find and filter message flags + operationId: QueryMessageFlags + parameters: + - content: + application/json: + schema: + $ref: '#/components/schemas/QueryMessageFlagsPayload' + description: JSON object with query message flags payload + title: Payload + x-stream-index: "001" + in: query + name: payload + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/QueryMessageFlagsResponse' + description: QueryMessageFlagsResponse + "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: Query Message Flags + tags: + - product:chat + /api/v2/chat/moderation/mute/channel: + post: + description: | + Mutes channel for user + + Sends events: + - channel.muted + - channel.muted + operationId: MuteChannel + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MuteChannelRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/MuteChannelResponse' + description: Successful 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: Mute channel + tags: + - product:chat + /api/v2/chat/moderation/unmute/channel: + post: + description: | + Unmutes channel for user + + Sends events: + - channel.unmuted + - channel.unmuted + operationId: UnmuteChannel + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UnmuteChannelRequest' + required: true responses: - "200": + "201": content: application/json: schema: - $ref: '#/components/schemas/GetApplicationResponse' + $ref: '#/components/schemas/UnmuteResponse' description: Response "400": content: @@ -26161,26 +36513,27 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Get App Settings + summary: Unmute channel tags: - - product:common - patch: + - product:chat + /api/v2/chat/push_preferences: + post: description: | - This Method updates one or more application settings - operationId: UpdateApp + Update the push preferences for a user and or channel member. Set to all, mentions or none + operationId: UpdatePushNotificationPreferences requestBody: content: application/json: schema: - $ref: '#/components/schemas/UpdateAppRequest' + $ref: '#/components/schemas/UpsertPushPreferencesRequest' required: true responses: - "200": + "201": content: application/json: schema: - $ref: '#/components/schemas/Response' - description: Response + $ref: '#/components/schemas/UpsertPushPreferencesResponse' + description: Successful response "400": content: application/json: @@ -26193,27 +36546,41 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Update App Settings + summary: Push notification preferences tags: - - product:common - /api/v2/blocklists: + - product:chat + /api/v2/chat/push_templates: get: description: | - Returns all available block lists - operationId: ListBlockLists + Retrieve push notification templates for Chat. + operationId: GetPushTemplates parameters: - in: query - name: team + name: push_provider_name schema: + description: Push provider name to filter templates + title: string type: string writeOnly: true - x-stream-index: "001" + x-stream-index: "002" + - in: query + name: push_provider_type + required: true + schema: + description: Push provider type (firebase, apn) to filter templates + enum: + - firebase + - apn + title: string + type: string + writeOnly: true + x-stream-index: "003" responses: "200": content: application/json: schema: - $ref: '#/components/schemas/ListBlockListResponse' + $ref: '#/components/schemas/GetPushTemplatesResponse' description: Response "400": content: @@ -26227,26 +36594,25 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: List block lists + summary: Get push notification templates tags: - - product:common + - product:chat post: description: | - Creates a new application blocklist, once created the blocklist can be used by any channel type - operationId: CreateBlockList + Create or update a push notification template for a specific event type and push provider + operationId: UpsertPushTemplate requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateBlockListRequest' - description: Block list + $ref: '#/components/schemas/UpsertPushTemplateRequest' required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/CreateBlockListResponse' + $ref: '#/components/schemas/UpsertPushTemplateResponse' description: Response "400": content: @@ -26260,27 +36626,130 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Create block list + summary: Upsert a push notification template tags: - - product:common - /api/v2/blocklists/{name}: + - product:chat + /api/v2/chat/query_banned_users: + get: + description: | + Find and filter channel scoped or global user bans + operationId: QueryBannedUsers + parameters: + - content: + application/json: + schema: + $ref: '#/components/schemas/QueryBannedUsersPayload' + description: JSON object with query user bans payload + title: Payload + x-stream-index: "001" + in: query + name: payload + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/QueryBannedUsersResponse' + description: Successful 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: Query Banned Users + tags: + - product:chat + /api/v2/chat/reminders/query: + post: + description: | + Queries reminders + operationId: QueryReminders + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueryRemindersRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/QueryRemindersResponse' + description: Successful 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: Query reminders + tags: + - product:chat + /api/v2/chat/search: + get: + description: | + Search messages across channels + operationId: Search + parameters: + - content: + application/json: + schema: + $ref: '#/components/schemas/SearchPayload' + description: JSON object with search payload + title: Payload + x-stream-index: "001" + in: query + name: payload + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/SearchResponse' + description: Successful 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: Search messages + tags: + - product:chat + /api/v2/chat/segments/{id}: delete: description: | - Deletes previously created application blocklist - operationId: DeleteBlockList + Delete a segment + operationId: DeleteSegment parameters: - in: path - name: name + name: id required: true schema: + maxLength: 255 type: string writeOnly: true x-stream-index: "001" - - in: query - name: team - schema: - type: string - x-stream-index: "002" responses: "200": content: @@ -26300,36 +36769,29 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Delete block list + summary: Delete segment tags: - - product:common + - product:chat get: description: | - Returns block list by given name - operationId: GetBlockList + Get segment + operationId: GetSegment parameters: - in: path - name: name + name: id required: true schema: - description: Block list name - title: Name + maxLength: 255 type: string writeOnly: true x-stream-index: "001" - - in: query - name: team - schema: - type: string - writeOnly: true - x-stream-index: "002" responses: "200": content: application/json: schema: - $ref: '#/components/schemas/GetBlockListResponse' - description: GetBlockListResponse + $ref: '#/components/schemas/GetSegmentResponse' + description: Successful response "400": content: application/json: @@ -26342,20 +36804,20 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Get block list + summary: Get segment tags: - - product:common - put: + - product:chat + /api/v2/chat/segments/{id}/deletetargets: + post: description: | - Updates contents of the block list - operationId: UpdateBlockList + Delete targets from a segment + operationId: DeleteSegmentTargets parameters: - in: path - name: name + name: id required: true schema: - description: Block list name - title: Name + maxLength: 255 type: string writeOnly: true x-stream-index: "001" @@ -26363,15 +36825,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/UpdateBlockListRequest' - description: Update block list + $ref: '#/components/schemas/DeleteSegmentTargetsRequest' required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/UpdateBlockListResponse' + $ref: '#/components/schemas/Response' description: Response "400": content: @@ -26385,59 +36846,36 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Update block list + summary: Delete targets from a segment tags: - - product:common - /api/v2/chat/campaigns/{id}: + - product:chat + /api/v2/chat/segments/{id}/target/{target_id}: get: description: | - Get campaign by ID. - operationId: GetCampaign + Check whether a target exists in a segment. Returns 200 if the target exists, 404 otherwise + operationId: SegmentTargetExists parameters: - in: path name: id required: true schema: - description: The ID of the campaign (uuid) maxLength: 255 - title: Campaign ID type: string writeOnly: true x-stream-index: "001" - - in: query - name: prev - schema: - description: Token for the previous page of campaign users - title: Previous Users Page - type: string - writeOnly: true - x-stream-index: "002.001" - - in: query - name: next + - in: path + name: target_id + required: true schema: - description: Token for the next page of campaign users - title: Next Users Page type: string writeOnly: true - x-stream-index: "002.002" - - in: query - name: limit - schema: - description: 'Maximum number of campaign users to return in a single request - (max: 1000)' - format: int32 - maximum: 1000 - minimum: 0 - title: Users Limit - type: integer - writeOnly: true - x-stream-index: "002.003" + x-stream-index: "002" responses: "200": content: application/json: schema: - $ref: '#/components/schemas/GetCampaignResponse' + $ref: '#/components/schemas/Response' description: Response "400": content: @@ -26451,14 +36889,14 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Get campaign + summary: Check whether a target exists in a segment tags: - product:chat - /api/v2/chat/campaigns/{id}/start: + /api/v2/chat/segments/{id}/targets/query: post: description: | - Starts or schedules a campaign - operationId: StartCampaign + Query segment targets + operationId: QuerySegmentTargets parameters: - in: path name: id @@ -26472,15 +36910,15 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/StartCampaignRequest' + $ref: '#/components/schemas/QuerySegmentTargetsRequest' required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/StartCampaignResponse' - description: Response + $ref: '#/components/schemas/QuerySegmentTargetsResponse' + description: Successful response "400": content: application/json: @@ -26493,20 +36931,155 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Start/schedule campaign + summary: Query segment targets tags: - product:chat - /api/v2/chat/campaigns/{id}/stop: + /api/v2/chat/segments/query: post: description: | - Stops a campaign - operationId: ScheduleCampaign + Query segments + operationId: QuerySegments + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QuerySegmentsRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/QuerySegmentsResponse' + description: Successful 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: Query segments + tags: + - product:chat + /api/v2/chat/threads: + post: + description: | + Returns the list of threads for specific user + operationId: QueryThreads + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueryThreadsRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/QueryThreadsResponse' + description: Successful 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: Query Threads + tags: + - product:chat + /api/v2/chat/threads/{message_id}: + get: + description: | + Return a specific thread + operationId: GetThread parameters: - in: path - name: id + name: message_id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "001" + - in: query + name: reply_limit + schema: + description: Limit the number of replies returned + format: int32 + minimum: 0 + title: Reply limit + type: integer + writeOnly: true + x-stream-index: "004" + - in: query + name: participant_limit + schema: + description: Limit the number of participants returned + format: int32 + maximum: 100 + minimum: 0 + title: Participant limit + type: integer + writeOnly: true + x-stream-index: "005" + - in: query + name: member_limit + schema: + description: Limit the number of members returned per thread channel + format: int32 + maximum: 100 + minimum: 0 + title: Member limit + type: integer + writeOnly: true + x-stream-index: "006" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/GetThreadResponse' + description: Successful 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: Get Thread + tags: + - product:chat + patch: + description: | + Updates certain fields of the thread + + Sends events: + - thread.updated + - thread.updated + operationId: UpdateThreadPartial + parameters: + - in: path + name: message_id required: true schema: - maxLength: 255 type: string writeOnly: true x-stream-index: "001" @@ -26514,14 +37087,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/StopCampaignRequest' + $ref: '#/components/schemas/UpdateThreadPartialRequest' required: true responses: - "201": + "200": content: application/json: schema: - $ref: '#/components/schemas/CampaignResponse' + $ref: '#/components/schemas/UpdateThreadPartialResponse' description: Successful response "400": content: @@ -26535,26 +37108,53 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Stop campaign + summary: Partially update thread tags: - product:chat - /api/v2/chat/campaigns/query: + /api/v2/chat/unread: + get: + description: | + Fetch unread counts for a single user + operationId: UnreadCounts + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/WrappedUnreadCountsResponse' + 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: Unread counts + tags: + - product:chat + /api/v2/chat/unread_batch: post: description: | - Query campaigns with filter query - operationId: QueryCampaigns + Fetch unread counts in batch for multiple users in one call + operationId: UnreadCountsBatch requestBody: content: application/json: schema: - $ref: '#/components/schemas/QueryCampaignsRequest' + $ref: '#/components/schemas/UnreadCountsBatchRequest' required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/QueryCampaignsResponse' + $ref: '#/components/schemas/UnreadCountsBatchResponse' description: Response "400": content: @@ -26568,28 +37168,38 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Query campaigns + summary: Batch unread counts tags: - product:chat - /api/v2/chat/channels: + /api/v2/chat/users/{user_id}/event: post: description: | - Query channels with filter query - operationId: QueryChannels + Sends a custom event to a user + + Sends events: + - * + operationId: SendUserCustomEvent + parameters: + - in: path + name: user_id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "002" requestBody: content: application/json: schema: - $ref: '#/components/schemas/QueryChannelsRequest' - description: Query Channels Request + $ref: '#/components/schemas/SendUserCustomEventRequest' required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/QueryChannelsResponse' - description: Channels list + $ref: '#/components/schemas/Response' + description: Response "400": content: application/json: @@ -26602,49 +37212,28 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Query channels + summary: Send user event tags: - product:chat - /api/v2/chat/channels/{type}/{id}: - delete: + /api/v2/check_push: + post: description: | - Deletes channel - - Sends events: - - channel.deleted - - channel.deleted - operationId: DeleteChannel - parameters: - - in: path - name: type - required: true - schema: - description: Channel type to interact with - title: Channel type - type: string - writeOnly: true - x-stream-index: "001.001" - - in: path - name: id + Sends a test message via push, this is a test endpoint to verify your push settings + operationId: CheckPush + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CheckPushRequest' + description: CheckPushRequest required: true - schema: - description: Channel ID to interact with - title: Channel ID - type: string - writeOnly: true - x-stream-index: "001.002" - - in: query - name: hard_delete - schema: - type: boolean - x-stream-index: "002" responses: - "200": + "201": content: application/json: schema: - $ref: '#/components/schemas/DeleteChannelResponse' - description: Response + $ref: '#/components/schemas/CheckPushResponse' + description: Successful response "400": content: application/json: @@ -26657,49 +37246,26 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Delete channel + summary: Check push tags: - - product:chat - patch: + - product:common + /api/v2/check_sns: + post: description: | - Updates certain fields of the channel - - Sends events: - - channel.updated - - channel.updated - operationId: UpdateChannelPartial - parameters: - - in: path - name: type - required: true - schema: - description: Channel type to interact with - title: Channel type - type: string - writeOnly: true - x-stream-index: "001.001" - - in: path - name: id - required: true - schema: - description: Channel ID to interact with - title: Channel ID - type: string - writeOnly: true - x-stream-index: "001.002" + Validates Amazon SNS configuration + operationId: CheckSNS requestBody: content: application/json: schema: - $ref: '#/components/schemas/UpdateChannelPartialRequest' - description: UpdateChannelPartialRequest + $ref: '#/components/schemas/CheckSNSRequest' required: true responses: - "200": + "201": content: application/json: schema: - $ref: '#/components/schemas/UpdateChannelPartialResponse' + $ref: '#/components/schemas/CheckSNSResponse' description: Successful response "400": content: @@ -26713,53 +37279,26 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Partially update channel + summary: Check SNS tags: - - product:chat + - product:common + /api/v2/check_sqs: post: description: | - Change channel data - - Sends events: - - channel.updated - - member.added - - member.removed - - member.updated - - message.new - - channel.updated - - member.added - - member.removed - - member.updated - - message.new - operationId: UpdateChannel - parameters: - - in: path - name: type - required: true - schema: - type: string - writeOnly: true - x-stream-index: 013.002.001 - - in: path - name: id - required: true - schema: - type: string - writeOnly: true - x-stream-index: 013.002.002 + Validates Amazon SQS credentials + operationId: CheckSQS requestBody: content: application/json: schema: - $ref: '#/components/schemas/UpdateChannelRequest' - description: Channel update request + $ref: '#/components/schemas/CheckSQSRequest' required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/UpdateChannelResponse' + $ref: '#/components/schemas/CheckSQSResponse' description: Successful response "400": content: @@ -26773,46 +37312,32 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Update channel + summary: Check SQS tags: - - product:chat - /api/v2/chat/channels/{type}/{id}/draft: + - product:common + /api/v2/devices: delete: description: | - Deletes a draft - - Sends events: - - draft.deleted - operationId: DeleteDraft + Deletes one device + operationId: DeleteDevice parameters: - - in: path - name: type - required: true - schema: - type: string - writeOnly: true - x-stream-index: "002.001" - - in: path + - in: query name: id required: true schema: - type: string - writeOnly: true - x-stream-index: "002.002" - - in: query - name: parent_id - schema: - description: Parent message ID - title: string + description: Device ID to delete + title: ID type: string writeOnly: true x-stream-index: "001" - in: query name: user_id schema: + description: '**Server-side only**. User ID which server acts upon' + title: User ID type: string writeOnly: true - x-stream-index: "003.001" + x-stream-index: "002.001" responses: "200": content: @@ -26832,49 +37357,29 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Delete draft + summary: Delete device tags: - - product:chat + - product:common get: description: | - Get a draft - operationId: GetDraft + Returns all available devices + operationId: ListDevices parameters: - - in: path - name: type - required: true - schema: - type: string - writeOnly: true - x-stream-index: "002.001" - - in: path - name: id - required: true - schema: - type: string - writeOnly: true - x-stream-index: "002.002" - - in: query - name: parent_id - schema: - description: Parent message ID - title: string - type: string - writeOnly: true - x-stream-index: "001" - in: query name: user_id schema: + description: '**Server-side only**. User ID which server acts upon' + title: User ID type: string writeOnly: true - x-stream-index: "003.001" + x-stream-index: "001.001" responses: "200": content: application/json: schema: - $ref: '#/components/schemas/GetDraftResponse' - description: Response + $ref: '#/components/schemas/ListDevicesResponse' + description: ListDevicesResponse "400": content: application/json: @@ -26887,45 +37392,26 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Get draft + summary: List devices tags: - - product:chat - /api/v2/chat/channels/{type}/{id}/event: + - product:common post: description: | - Sends event to the channel - operationId: SendEvent - parameters: - - in: path - name: type - required: true - schema: - description: Channel type to interact with - title: Channel type - type: string - writeOnly: true - x-stream-index: "002.001" - - in: path - name: id - required: true - schema: - description: Channel ID to interact with - title: Channel ID - type: string - writeOnly: true - x-stream-index: "002.002" + Adds a new device to a user, if the same device already exists the call will have no effect + operationId: CreateDevice requestBody: content: application/json: schema: - $ref: '#/components/schemas/SendEventRequest' + $ref: '#/components/schemas/CreateDeviceRequest' + description: CreateDeviceRequest required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/EventResponse' + $ref: '#/components/schemas/Response' description: Response "400": content: @@ -26939,47 +37425,26 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Send event + summary: Create device tags: - - product:chat - /api/v2/chat/channels/{type}/{id}/file: - delete: + - product:common + /api/v2/export/users: + post: description: | - Deletes previously uploaded file - operationId: DeleteFile - parameters: - - in: path - name: type - required: true - schema: - description: The type of file - title: Type - type: string - writeOnly: true - x-stream-index: "002.001" - - in: path - name: id + Exports user profile, reactions and messages for list of given users + operationId: ExportUsers + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ExportUsersRequest' required: true - schema: - description: File ID - title: ID - type: string - writeOnly: true - x-stream-index: "002.002" - - in: query - name: url - schema: - description: File URL to delete - title: URL - type: string - writeOnly: true - x-stream-index: "001" responses: - "200": + "201": content: application/json: schema: - $ref: '#/components/schemas/Response' + $ref: '#/components/schemas/ExportUsersResponse' description: Response "400": content: @@ -26993,41 +37458,21 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Delete file + summary: Export users tags: - - product:chat - post: + - product:common + /api/v2/external_storage: + get: description: | - Uploads file - operationId: UploadFile - parameters: - - in: path - name: type - required: true - schema: - type: string - writeOnly: true - x-stream-index: "001.001" - - in: path - name: id - required: true - schema: - type: string - writeOnly: true - x-stream-index: "001.002" - requestBody: - content: - multipart/form-data: - schema: - $ref: '#/components/schemas/FileUploadRequest' - required: true + Lists external storage + operationId: ListExternalStorage responses: - "201": + "200": content: application/json: schema: - $ref: '#/components/schemas/FileUploadResponse' - description: Successful response + $ref: '#/components/schemas/ListExternalStorageResponse' + description: Response "400": content: application/json: @@ -27040,45 +37485,26 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Upload file + summary: List external storage tags: - - product:chat - /api/v2/chat/channels/{type}/{id}/hide: + - product:common post: description: | - Marks channel as hidden for current user - - Sends events: - - channel.hidden - - channel.hidden - operationId: HideChannel - parameters: - - in: path - name: type - required: true - schema: - type: string - writeOnly: true - x-stream-index: "002.001" - - in: path - name: id - required: true - schema: - type: string - writeOnly: true - x-stream-index: "002.002" + Creates new external storage + operationId: CreateExternalStorage requestBody: content: application/json: schema: - $ref: '#/components/schemas/HideChannelRequest' + $ref: '#/components/schemas/CreateExternalStorageRequest' + description: CreateExternalStorageRequest required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/HideChannelResponse' + $ref: '#/components/schemas/CreateExternalStorageResponse' description: Response "400": content: @@ -27092,47 +37518,28 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Hide channel + summary: Create external storage tags: - - product:chat - /api/v2/chat/channels/{type}/{id}/image: + - product:common + /api/v2/external_storage/{name}: delete: description: | - Deletes previously uploaded image - operationId: DeleteImage + Deletes external storage + operationId: DeleteExternalStorage parameters: - in: path - name: type - required: true - schema: - description: The type of file - title: Type - type: string - writeOnly: true - x-stream-index: "002.001" - - in: path - name: id + name: name required: true schema: - description: File ID - title: ID - type: string - writeOnly: true - x-stream-index: "002.002" - - in: query - name: url - schema: - description: File URL to delete - title: URL type: string writeOnly: true - x-stream-index: "001" + x-stream-index: "002" responses: "200": content: application/json: schema: - $ref: '#/components/schemas/Response' + $ref: '#/components/schemas/DeleteExternalStorageResponse' description: Response "400": content: @@ -27146,41 +37553,35 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Delete image + summary: Delete external storage tags: - - product:chat - post: - description: | - Uploads image - operationId: UploadImage + - product:common + put: + description: |2+ + + operationId: UpdateExternalStorage parameters: - in: path - name: type - required: true - schema: - type: string - writeOnly: true - x-stream-index: 001.001.001 - - in: path - name: id + name: name required: true schema: type: string writeOnly: true - x-stream-index: 001.001.002 + x-stream-index: "001" requestBody: content: - multipart/form-data: + application/json: schema: - $ref: '#/components/schemas/ImageUploadRequest' + $ref: '#/components/schemas/UpdateExternalStorageRequest' + description: ExternalStorageRequest required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/ImageUploadResponse' - description: Successful response + $ref: '#/components/schemas/UpdateExternalStorageResponse' + description: Response "400": content: application/json: @@ -27193,48 +37594,29 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Upload image + summary: Update External Storage tags: - - product:chat - /api/v2/chat/channels/{type}/{id}/member: - patch: + - product:common + /api/v2/external_storage/{name}/check: + get: description: |2+ - operationId: UpdateMemberPartial + operationId: CheckExternalStorage parameters: - in: path - name: type - required: true - schema: - type: string - writeOnly: true - x-stream-index: "003.001" - - in: path - name: id + name: name required: true schema: type: string writeOnly: true - x-stream-index: "003.002" - - in: query - name: user_id - schema: - type: string - writeOnly: true - x-stream-index: "005.001" - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/UpdateMemberPartialRequest' - required: true + x-stream-index: "002" responses: "200": content: application/json: schema: - $ref: '#/components/schemas/UpdateMemberPartialResponse' - description: Successful response + $ref: '#/components/schemas/CheckExternalStorageResponse' + description: Response "400": content: application/json: @@ -27247,52 +37629,28 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Partially channel member update + summary: Check External Storage tags: - - product:chat - /api/v2/chat/channels/{type}/{id}/message: + - product:common + /api/v2/feeds/activities: post: - description: | - Sends new message to the specified channel - - Sends events: - - message.new - - message.updated - - message.new - - message.updated - operationId: SendMessage - parameters: - - in: path - name: type - required: true - schema: - description: Channel type to interact with - title: Channel type - type: string - writeOnly: true - x-stream-index: "009.001" - - in: path - name: id - required: true - schema: - description: Channel ID to interact with - title: Channel ID - type: string - writeOnly: true - x-stream-index: "009.002" + description: | + Create a new activity or update an existing one + operationId: AddActivity requestBody: content: application/json: schema: - $ref: '#/components/schemas/SendMessageRequest' + $ref: '#/components/schemas/AddActivityRequest' + description: Activity Request required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/SendMessageResponse' - description: Successful response + $ref: '#/components/schemas/AddActivityResponse' + description: Add Activity Response "400": content: application/json: @@ -27305,49 +37663,43 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Send new message + summary: Add a single activity tags: - - product:chat - /api/v2/chat/channels/{type}/{id}/messages: - get: + - product:feeds + /api/v2/feeds/activities/{activity_id}/bookmarks: + delete: description: | - Returns list messages found by IDs - operationId: GetManyMessages + Deletes a bookmark from an activity + operationId: DeleteBookmark parameters: - in: path - name: type + name: activity_id required: true schema: + maxLength: 255 type: string writeOnly: true - x-stream-index: "002.001" - - in: path - name: id - required: true + x-stream-index: "001" + - in: query + name: folder_id schema: + maxLength: 255 type: string writeOnly: true - x-stream-index: "002.002" + x-stream-index: "002" - in: query - name: ids - required: true + name: user_id schema: - description: List of comma-separated IDs - items: - type: string - maximum: 50 - minimum: 1 - title: IDs - type: array + type: string writeOnly: true - x-stream-index: "001" + x-stream-index: "003.001" responses: "200": content: application/json: schema: - $ref: '#/components/schemas/GetManyMessagesResponse' - description: Successful response + $ref: '#/components/schemas/DeleteBookmarkResponse' + description: Delete Bookmark Response "400": content: application/json: @@ -27360,54 +37712,38 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Get many messages + summary: Delete a bookmark tags: - - product:chat - /api/v2/chat/channels/{type}/{id}/query: - post: + - product:feeds + patch: description: | - This Method creates a channel or returns an existing one with matching attributes - - Sends events: - - channel.created - - member.added - - member.removed - - member.updated - - user.watching.start - operationId: GetOrCreateChannel + Updates a bookmark for an activity + operationId: UpdateBookmark parameters: - in: path - name: type + name: activity_id required: true schema: - description: Channel type - maxLength: 64 - title: Type + description: ID of the activity + maxLength: 255 + title: Activity ID type: string writeOnly: true x-stream-index: "001" - - in: path - name: id - required: true - schema: - description: Channel ID (maximum length of 64 characters) - title: ID - type: string - writeOnly: true - x-stream-index: "002" requestBody: content: application/json: schema: - $ref: '#/components/schemas/ChannelGetOrCreateRequest' + $ref: '#/components/schemas/UpdateBookmarkRequest' + description: Update Bookmark Request required: true responses: - "201": + "200": content: application/json: schema: - $ref: '#/components/schemas/ChannelStateResponse' - description: Successful response + $ref: '#/components/schemas/UpdateBookmarkResponse' + description: Update Bookmark Response "400": content: application/json: @@ -27420,46 +37756,36 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Get or create channel + summary: Update bookmark tags: - - product:chat - /api/v2/chat/channels/{type}/{id}/read: + - product:feeds post: description: | - Marks channel as read up to the specific message - - Sends events: - - message.read - - message.read - operationId: MarkRead + Adds a bookmark to an activity + operationId: AddBookmark parameters: - in: path - name: type - required: true - schema: - type: string - writeOnly: true - x-stream-index: "003.001" - - in: path - name: id + name: activity_id required: true schema: + maxLength: 255 type: string writeOnly: true - x-stream-index: "003.002" + x-stream-index: "001" requestBody: content: application/json: schema: - $ref: '#/components/schemas/MarkReadRequest' + $ref: '#/components/schemas/AddBookmarkRequest' + description: Add Bookmark Request required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/MarkReadResponse' - description: Successful response + $ref: '#/components/schemas/AddBookmarkResponse' + description: Add Bookmark Response "400": content: application/json: @@ -27472,50 +37798,37 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Mark read + summary: Add bookmark tags: - - product:chat - /api/v2/chat/channels/{type}/{id}/show: + - product:feeds + /api/v2/feeds/activities/{activity_id}/feedback: post: description: | - Shows previously hidden channel - - Sends events: - - channel.visible - - channel.visible - operationId: ShowChannel + Submit feedback for an activity including options to show less, hide, report, or mute the user + operationId: ActivityFeedback parameters: - in: path - name: type - required: true - schema: - description: Channel type to interact with - title: Channel type - type: string - writeOnly: true - x-stream-index: "001.001" - - in: path - name: id + name: activity_id required: true schema: - description: Channel ID to interact with - title: Channel ID + maxLength: 255 type: string writeOnly: true - x-stream-index: "001.002" + x-stream-index: "001" requestBody: content: application/json: schema: - $ref: '#/components/schemas/ShowChannelRequest' + $ref: '#/components/schemas/ActivityFeedbackRequest' + description: Activity Feedback Request required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/ShowChannelResponse' - description: Response + $ref: '#/components/schemas/ActivityFeedbackResponse' + description: Activity Feedback Response "400": content: application/json: @@ -27528,45 +37841,51 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Show channel + summary: Provide feedback on an activity tags: - - product:chat - /api/v2/chat/channels/{type}/{id}/truncate: + - product:feeds + /api/v2/feeds/activities/{activity_id}/polls/{poll_id}/vote: post: description: | - Truncates messages from a channel. Can be applied to the entire channel or scoped to specific members. + Cast a vote on a poll Sends events: - - channel.truncated - - channel.truncated - operationId: TruncateChannel + - feeds.poll.vote_casted + - feeds.poll.vote_changed + - feeds.poll.vote_removed + - poll.vote_casted + - poll.vote_changed + - poll.vote_removed + operationId: CastPollVote parameters: - in: path - name: type + name: activity_id required: true schema: type: string writeOnly: true - x-stream-index: "001.001" + x-stream-index: "002" - in: path - name: id + name: poll_id required: true schema: + description: Poll ID + maxLength: 255 + title: string type: string - writeOnly: true - x-stream-index: "001.002" + x-stream-index: "003" requestBody: content: application/json: schema: - $ref: '#/components/schemas/TruncateChannelRequest' + $ref: '#/components/schemas/CastPollVoteRequest' required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/TruncateChannelResponse' + $ref: '#/components/schemas/PollVoteResponse' description: Successful response "400": content: @@ -27580,42 +37899,57 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Truncate channel + summary: Cast vote tags: - - product:chat - /api/v2/chat/channels/{type}/{id}/unread: - post: + - product:feeds + /api/v2/feeds/activities/{activity_id}/polls/{poll_id}/vote/{vote_id}: + delete: description: | - Marks channel as unread from a specific message - operationId: MarkUnread + Delete a vote from a poll + + Sends events: + - feeds.poll.vote_removed + - poll.vote_removed + operationId: DeletePollVote parameters: - in: path - name: type + name: activity_id required: true schema: type: string writeOnly: true - x-stream-index: "002.001" + x-stream-index: "003" - in: path - name: id + name: poll_id required: true schema: + description: Poll ID + maxLength: 255 + title: string type: string - writeOnly: true - x-stream-index: "002.002" - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MarkUnreadRequest' + x-stream-index: "004" + - in: path + name: vote_id required: true + schema: + description: Vote ID + maxLength: 255 + title: string + type: string + x-stream-index: "005" + - in: query + name: user_id + schema: + type: string + writeOnly: true + x-stream-index: "001" responses: - "201": + "200": content: application/json: schema: - $ref: '#/components/schemas/Response' - description: Response + $ref: '#/components/schemas/PollVoteResponse' + description: Successful response "400": content: application/json: @@ -27628,29 +37962,20 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Mark unread + summary: Delete vote tags: - - product:chat - /api/v2/chat/channels/{type}/query: + - product:feeds + /api/v2/feeds/activities/{activity_id}/reactions: post: description: | - This Method creates a channel or returns an existing one with matching attributes - - Sends events: - - channel.created - - member.added - - member.removed - - member.updated - - user.watching.start - operationId: GetOrCreateDistinctChannel + Adds a reaction to an activity + operationId: AddReaction parameters: - in: path - name: type + name: activity_id required: true schema: - description: Channel type - maxLength: 64 - title: Type + maxLength: 255 type: string writeOnly: true x-stream-index: "001" @@ -27658,15 +37983,16 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ChannelGetOrCreateRequest' + $ref: '#/components/schemas/AddReactionRequest' + description: Add Reaction Request required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/ChannelStateResponse' - description: Successful response + $ref: '#/components/schemas/AddReactionResponse' + description: Add Reaction Response "400": content: application/json: @@ -27679,31 +38005,44 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Get or create channel + summary: Add reaction tags: - - product:chat - /api/v2/chat/channels/delete: - post: + - product:feeds + /api/v2/feeds/activities/{activity_id}/reactions/{type}: + delete: description: | - Allows to delete several channels at once asynchronously - - Sends events: - - channel.deleted - - channel.deleted - operationId: DeleteChannels - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/DeleteChannelsRequest' + Removes a reaction from an activity + operationId: DeleteActivityReaction + parameters: + - in: path + name: activity_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + - in: path + name: type required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "002" + - in: query + name: user_id + schema: + type: string + writeOnly: true + x-stream-index: "003.001" responses: - "201": + "200": content: application/json: schema: - $ref: '#/components/schemas/DeleteChannelsResponse' - description: Successful response + $ref: '#/components/schemas/DeleteActivityReactionResponse' + description: Delete Activity Reaction Response "400": content: application/json: @@ -27716,58 +38055,35 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Deletes channels asynchronously + summary: Remove reaction tags: - - product:chat - /api/v2/chat/channels/read: + - product:feeds + /api/v2/feeds/activities/{activity_id}/reactions/query: post: description: | - Marks channels as read up to the specific message. If no channels is given, mark all channel as read - - Sends events: - - message.read - - message.read - operationId: MarkChannelsRead + Query activity reactions + operationId: QueryActivityReactions + parameters: + - in: path + name: activity_id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "001" requestBody: content: application/json: schema: - $ref: '#/components/schemas/MarkChannelsReadRequest' + $ref: '#/components/schemas/QueryActivityReactionsRequest' required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/MarkReadResponse' - description: Successful 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 channels as read - tags: - - product:chat - /api/v2/chat/channeltypes: - get: - description: | - Lists all available channel types - operationId: ListChannelTypes - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/ListChannelTypesResponse' - description: ListChannelTypesResponse + $ref: '#/components/schemas/QueryActivityReactionsResponse' + description: Response "400": content: application/json: @@ -27780,27 +38096,39 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: List channel types + summary: Query activity reactions tags: - - product:chat - post: + - product:feeds + /api/v2/feeds/activities/{id}: + delete: description: | - Creates new channel type - operationId: CreateChannelType - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CreateChannelTypeRequest' - description: CreateChannelTypeRequest + Delete a single activity by its ID + operationId: DeleteActivity + parameters: + - in: path + name: id required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + - in: query + name: hard_delete + schema: + description: Whether to permanently delete the activity instead of soft + delete + title: boolean + type: boolean + writeOnly: true + x-stream-index: "002" responses: - "201": + "200": content: application/json: schema: - $ref: '#/components/schemas/CreateChannelTypeResponse' - description: Successful response + $ref: '#/components/schemas/DeleteActivityResponse' + description: Delete Activity Response "400": content: application/json: @@ -27813,21 +38141,18 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Create channel type + summary: Delete a single activity tags: - - product:chat - /api/v2/chat/channeltypes/{name}: - delete: + - product:feeds + get: description: | - Deletes channel type - operationId: DeleteChannelType + Returns activity by ID + operationId: GetActivity parameters: - in: path - name: name + name: id required: true schema: - description: Channel type name - title: Name type: string writeOnly: true x-stream-index: "001" @@ -27836,8 +38161,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Response' - description: Response + $ref: '#/components/schemas/GetActivityResponse' + description: Get Activity Response "400": content: application/json: @@ -27850,30 +38175,38 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Delete channel type + summary: Get activity tags: - - product:chat - get: + - product:feeds + patch: description: | - Gets channel type - operationId: GetChannelType + Updates certain fields of the activity + + Sends events: + - feeds.activity.updated + operationId: UpdateActivityPartial parameters: - in: path - name: name + name: id required: true schema: - description: Channel type name - title: Name + maxLength: 255 type: string writeOnly: true x-stream-index: "001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateActivityPartialRequest' + required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/GetChannelTypeResponse' - description: Response + $ref: '#/components/schemas/UpdateActivityPartialResponse' + description: Successful response "400": content: application/json: @@ -27886,18 +38219,22 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Get channel type + summary: Partially activity update tags: - - product:chat + - product:feeds put: description: | - Updates channel type - operationId: UpdateChannelType + Replaces an activity with the provided data + + Sends events: + - feeds.activity.updated + operationId: UpdateActivity parameters: - in: path - name: name + name: id required: true schema: + maxLength: 255 type: string writeOnly: true x-stream-index: "001" @@ -27905,14 +38242,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/UpdateChannelTypeRequest' + $ref: '#/components/schemas/UpdateActivityRequest' required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/UpdateChannelTypeResponse' + $ref: '#/components/schemas/UpdateActivityResponse' description: Successful response "400": content: @@ -27926,21 +38263,28 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Update channel type + summary: Full activity update tags: - - product:chat - /api/v2/chat/commands: - get: + - product:feeds + /api/v2/feeds/activities/batch: + post: description: | - Returns all custom commands - operationId: ListCommands + Create new activities or update existing ones in a batch operation + operationId: UpsertActivities + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpsertActivitiesRequest' + description: Upsert Activities Request + required: true responses: - "200": + "201": content: application/json: schema: - $ref: '#/components/schemas/ListCommandsResponse' - description: ListCommandsResponse + $ref: '#/components/schemas/UpsertActivitiesResponse' + description: Upsert Activities Response "400": content: application/json: @@ -27953,27 +38297,28 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: List commands + summary: Upsert multiple activities tags: - - product:chat + - product:feeds + /api/v2/feeds/activities/delete: post: description: | - Creates custom chat command - operationId: CreateCommand + Delete one or more activities by their IDs + operationId: DeleteActivities requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateCommandRequest' - description: CreateCommandRequest + $ref: '#/components/schemas/DeleteActivitiesRequest' + description: Delete Activities Request required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/CreateCommandResponse' - description: CreateCommandResponse + $ref: '#/components/schemas/DeleteActivitiesResponse' + description: Delete Activities Response "400": content: application/json: @@ -27986,30 +38331,28 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Create command + summary: Remove multiple activities tags: - - product:chat - /api/v2/chat/commands/{name}: - delete: + - product:feeds + /api/v2/feeds/activities/query: + post: description: | - Deletes custom chat command - operationId: DeleteCommand - parameters: - - in: path - name: name + Query activities based on filters with pagination and sorting options + operationId: QueryActivities + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueryActivitiesRequest' + description: Query Activities Request required: true - schema: - description: Command name - title: Name - type: string - x-stream-index: "001" responses: - "200": + "201": content: application/json: schema: - $ref: '#/components/schemas/DeleteCommandResponse' - description: DeleteCommandResponse + $ref: '#/components/schemas/QueryActivitiesResponse' + description: Query Activities Response "400": content: application/json: @@ -28022,29 +38365,30 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Delete command + summary: Query activities tags: - - product:chat - get: + - product:feeds + /api/v2/feeds/bookmark_folders/{folder_id}: + delete: description: | - Returns custom command by its name - operationId: GetCommand + Delete a bookmark folder by its ID + operationId: DeleteBookmarkFolder parameters: - in: path - name: name + name: folder_id required: true schema: - description: Command name - title: Name + maxLength: 255 type: string + writeOnly: true x-stream-index: "001" responses: "200": content: application/json: schema: - $ref: '#/components/schemas/GetCommandResponse' - description: GetCommandResponse + $ref: '#/components/schemas/DeleteBookmarkFolderResponse' + description: Delete Bookmark Folder Response "400": content: application/json: @@ -28057,20 +38401,19 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Get command + summary: Delete a bookmark folder tags: - - product:chat - put: + - product:feeds + patch: description: | - Updates custom chat command - operationId: UpdateCommand + Update a bookmark folder by its ID + operationId: UpdateBookmarkFolder parameters: - in: path - name: name + name: folder_id required: true schema: - description: Unique command name - title: Name + maxLength: 255 type: string writeOnly: true x-stream-index: "001" @@ -28078,49 +38421,16 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/UpdateCommandRequest' - description: UpdateCommandRequest - required: true - responses: - "201": - content: - application/json: - schema: - $ref: '#/components/schemas/UpdateCommandResponse' - description: UpdateCommandResponse - "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: Update command - tags: - - product:chat - /api/v2/chat/drafts/query: - post: - description: | - Queries draft messages for a user - operationId: QueryDrafts - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/QueryDraftsRequest' + $ref: '#/components/schemas/UpdateBookmarkFolderRequest' + description: Update Bookmark Folder Request required: true responses: - "201": + "200": content: application/json: schema: - $ref: '#/components/schemas/QueryDraftsResponse' - description: Successful response + $ref: '#/components/schemas/UpdateBookmarkFolderResponse' + description: Update Bookmark Folder Response "400": content: application/json: @@ -28133,27 +38443,28 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Query draft messages + summary: Update a bookmark folder tags: - - product:chat - /api/v2/chat/export_channels: + - product:feeds + /api/v2/feeds/bookmark_folders/query: post: description: | - Exports channel data to JSON file - operationId: ExportChannels + Query bookmark folders with filter query + operationId: QueryBookmarkFolders requestBody: content: application/json: schema: - $ref: '#/components/schemas/ExportChannelsRequest' + $ref: '#/components/schemas/QueryBookmarkFoldersRequest' + description: Query Bookmark Folders Request required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/ExportChannelsResponse' - description: Successful response + $ref: '#/components/schemas/QueryBookmarkFoldersResponse' + description: Query Bookmark Folders Response "400": content: application/json: @@ -28166,29 +38477,28 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Export channels - tags: - - product:chat - /api/v2/chat/members: - get: - description: | - Find and filter channel members - operationId: QueryMembers - parameters: - - content: + summary: Query bookmark folders + tags: + - product:feeds + /api/v2/feeds/bookmarks/query: + post: + description: | + Query bookmarks with filter query + operationId: QueryBookmarks + requestBody: + content: application/json: schema: - $ref: '#/components/schemas/QueryMembersPayload' - x-stream-index: "001" - in: query - name: payload + $ref: '#/components/schemas/QueryBookmarksRequest' + description: Query Bookmarks Request + required: true responses: - "200": + "201": content: application/json: schema: - $ref: '#/components/schemas/MembersResponse' - description: Successful response + $ref: '#/components/schemas/QueryBookmarksResponse' + description: Query Bookmarks Response "400": content: application/json: @@ -28201,49 +38511,97 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Query members + summary: Query bookmarks tags: - - product:chat - /api/v2/chat/messages/{id}: - delete: + - product:feeds + /api/v2/feeds/comments: + get: description: | - Deletes message - - Sends events: - - message.deleted - - message.deleted - operationId: DeleteMessage + Retrieve a threaded list of comments for a specific object (e.g., activity), with configurable depth, sorting, and pagination + operationId: GetComments parameters: - - in: path - name: id + - in: query + name: object_id required: true schema: - description: Message ID to delete - title: ID + description: ID of the object to get comments for + title: Object ID type: string writeOnly: true x-stream-index: "001" - in: query - name: hard + name: object_type + required: true schema: - description: Delete all message reactions and replies as well - title: Hard - type: boolean + description: Type of the object to get comments for + title: Object Type + type: string writeOnly: true x-stream-index: "002" - in: query - name: deleted_by + name: depth schema: - type: string + description: Maximum nested depth to return (0 = only first level) + format: int32 + maximum: 5 + minimum: 0 + title: Max Depth + type: integer writeOnly: true x-stream-index: "003" + - in: query + name: sort + schema: + description: Sort order for the comments + enum: + - first + - last + - top + - best + - controversial + title: Sort Order + type: string + writeOnly: true + x-stream-index: "004" + - in: query + name: replies_limit + schema: + format: int32 + maximum: 20 + minimum: 0 + type: integer + writeOnly: true + x-stream-index: "005" + - in: query + name: limit + schema: + description: Max number of top‑level comments to return + format: int32 + maximum: 100 + minimum: 0 + title: Root Limit + type: integer + writeOnly: true + x-stream-index: "006.001" + - in: query + name: prev + schema: + type: string + writeOnly: true + x-stream-index: "006.002" + - in: query + name: next + schema: + type: string + writeOnly: true + x-stream-index: "006.003" responses: "200": content: application/json: schema: - $ref: '#/components/schemas/DeleteMessageResponse' - description: Response + $ref: '#/components/schemas/GetCommentsResponse' + description: Get Comments Response "400": content: application/json: @@ -28256,28 +38614,60 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Delete message + summary: Get comments for an object tags: - - product:chat - get: + - product:feeds + post: description: | - Returns message by ID - operationId: GetMessage + Adds a comment to an object (e.g., activity) or a reply to an existing comment, and broadcasts appropriate events + operationId: AddComment + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AddCommentRequest' + description: Add Comment Request + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/AddCommentResponse' + description: Add Comment 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: Add a comment or reply + tags: + - product:feeds + /api/v2/feeds/comments/{id}: + delete: + description: | + Deletes a comment from an object (e.g., activity) and broadcasts appropriate events + operationId: DeleteComment parameters: - in: path name: id required: true schema: - description: ID of the message - title: ID type: string writeOnly: true x-stream-index: "001" - in: query - name: show_deleted_message + name: hard_delete schema: - description: Whether to show deleted message - title: Show deleted message + description: Whether to permanently delete the comment instead of soft delete + title: Hard Delete type: boolean writeOnly: true x-stream-index: "002" @@ -28286,8 +38676,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GetMessageResponse' - description: Response + $ref: '#/components/schemas/DeleteCommentResponse' + description: Delete Comment Response "400": content: application/json: @@ -28300,40 +38690,28 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Get message + summary: Delete a comment tags: - - product:chat - post: + - product:feeds + get: description: | - Updates message with new data - - Sends events: - - message.updated - - message.updated - operationId: UpdateMessage + Get a comment by ID + operationId: GetComment parameters: - in: path name: id required: true schema: - description: Message ID - title: ID type: string writeOnly: true - x-stream-index: "004.001" - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/UpdateMessageRequest' - required: true + x-stream-index: "001" responses: - "201": + "200": content: application/json: schema: - $ref: '#/components/schemas/UpdateMessageResponse' - description: Response + $ref: '#/components/schemas/GetCommentResponse' + description: Get Comment Response "400": content: application/json: @@ -28346,17 +38724,13 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Update message + summary: Get comment tags: - - product:chat - put: + - product:feeds + patch: description: | - Updates certain fields of the message - - Sends events: - - message.updated - - message.updated - operationId: UpdateMessagePartial + Updates a comment on an object (e.g., activity) and broadcasts appropriate events + operationId: UpdateComment parameters: - in: path name: id @@ -28364,20 +38738,21 @@ paths: schema: type: string writeOnly: true - x-stream-index: "003.001" + x-stream-index: "001" requestBody: content: application/json: schema: - $ref: '#/components/schemas/UpdateMessagePartialRequest' + $ref: '#/components/schemas/UpdateCommentRequest' + description: Update Comment Request required: true responses: - "201": + "200": content: application/json: schema: - $ref: '#/components/schemas/UpdateMessagePartialResponse' - description: Successful response + $ref: '#/components/schemas/UpdateCommentResponse' + description: Update Comment Response "400": content: application/json: @@ -28390,25 +38765,20 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Partially message update + summary: Update a comment tags: - - product:chat - /api/v2/chat/messages/{id}/action: + - product:feeds + /api/v2/feeds/comments/{id}/reactions: post: description: | - Executes message command action with given parameters - - Sends events: - - message.new - - message.new - operationId: RunMessageAction + Adds a reaction to a comment + operationId: AddCommentReaction parameters: - in: path name: id required: true schema: - description: Message ID - title: ID + maxLength: 255 type: string writeOnly: true x-stream-index: "001" @@ -28416,15 +38786,15 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MessageActionRequest' + $ref: '#/components/schemas/AddCommentReactionRequest' required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/MessageResponse' - description: Response + $ref: '#/components/schemas/AddCommentReactionResponse' + description: Successful response "400": content: application/json: @@ -28437,41 +38807,44 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Run message command action + summary: Add comment reaction tags: - - product:chat - /api/v2/chat/messages/{id}/commit: - post: + - product:feeds + /api/v2/feeds/comments/{id}/reactions/{type}: + delete: description: | - Commits a pending message, which will make it visible in the channel - - Sends events: - - message.new - - message.updated - - message.new - - message.updated - operationId: CommitMessage + Deletes a reaction from a comment + operationId: DeleteCommentReaction parameters: - in: path name: id required: true schema: + maxLength: 255 type: string writeOnly: true x-stream-index: "001" - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CommitMessageRequest' + - in: path + name: type required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "002" + - in: query + name: user_id + schema: + type: string + writeOnly: true + x-stream-index: "003.001" responses: - "201": + "200": content: application/json: schema: - $ref: '#/components/schemas/MessageResponse' - description: Response + $ref: '#/components/schemas/DeleteCommentReactionResponse' + description: Delete Comment Reaction Response "400": content: application/json: @@ -28484,25 +38857,19 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Commit message + summary: Delete comment reaction tags: - - product:chat - /api/v2/chat/messages/{id}/reaction: + - product:feeds + /api/v2/feeds/comments/{id}/reactions/query: post: description: | - Sends reaction to specified message - - Sends events: - - reaction.new - - reaction.updated - operationId: SendReaction + Query comment reactions + operationId: QueryCommentReactions parameters: - in: path name: id required: true schema: - description: Message ID to send reaction for - title: ID type: string writeOnly: true x-stream-index: "001" @@ -28510,14 +38877,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SendReactionRequest' + $ref: '#/components/schemas/QueryCommentReactionsRequest' required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/SendReactionResponse' + $ref: '#/components/schemas/QueryCommentReactionsResponse' description: Response "400": content: @@ -28531,51 +38898,87 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Send reaction + summary: Query comment reactions tags: - - product:chat - /api/v2/chat/messages/{id}/reaction/{type}: - delete: + - product:feeds + /api/v2/feeds/comments/{id}/replies: + get: description: | - Removes user reaction from the message - - Sends events: - - reaction.deleted - operationId: DeleteReaction + Retrieve a threaded list of replies for a single comment, with configurable depth, sorting, and pagination + operationId: GetCommentReplies parameters: - in: path name: id required: true schema: - description: Message ID to remove reaction from - title: ID type: string writeOnly: true x-stream-index: "001" - - in: path - name: type - required: true + - in: query + name: depth schema: - description: Reaction type to remove - title: Type - type: string + description: Maximum nested depth to return (0 = unlimited) + format: int32 + maximum: 5 + minimum: 0 + title: Max Depth + type: integer writeOnly: true x-stream-index: "002" - in: query - name: user_id + name: sort schema: - description: '**Server-side only**. User ID which server acts upon' - title: User ID + description: first (oldest), last (newest) or top + enum: + - first + - last + - top + - best + - controversial + title: Sort Order type: string writeOnly: true x-stream-index: "003" + - in: query + name: replies_limit + schema: + description: Max number of replies to return + format: int32 + minimum: 0 + title: Replies Limit + type: integer + writeOnly: true + x-stream-index: "004" + - in: query + name: limit + schema: + description: Max number of direct replies to return + format: int32 + maximum: 100 + minimum: 0 + title: Reply Limit + type: integer + writeOnly: true + x-stream-index: "005.001" + - in: query + name: prev + schema: + type: string + writeOnly: true + x-stream-index: "005.002" + - in: query + name: next + schema: + type: string + writeOnly: true + x-stream-index: "005.003" responses: "200": content: application/json: schema: - $ref: '#/components/schemas/DeleteReactionResponse' - description: Response + $ref: '#/components/schemas/GetCommentRepliesResponse' + description: Get Comment Replies Response "400": content: application/json: @@ -28588,49 +38991,28 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Delete reaction + summary: Get replies for a comment tags: - - product:chat - /api/v2/chat/messages/{id}/reactions: - get: + - product:feeds + /api/v2/feeds/comments/batch: + post: description: | - Returns list of reactions of specific message - operationId: GetReactions - parameters: - - in: path - name: id + Adds multiple comments in a single request. Each comment must specify the object type and ID. + operationId: AddCommentsBatch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AddCommentsBatchRequest' + description: Add Comments Batch Request required: true - schema: - description: Message ID - title: ID - type: string - writeOnly: true - x-stream-index: "001" - - in: query - name: limit - schema: - description: Number of records to return - format: int32 - title: Limit - type: integer - writeOnly: true - x-stream-index: "002" - - in: query - name: offset - schema: - description: Number of records to offset - format: int32 - title: Offset - type: integer - writeOnly: true - x-stream-index: "003" responses: - "200": + "201": content: application/json: schema: - $ref: '#/components/schemas/GetReactionsResponse' - description: Successful response + $ref: '#/components/schemas/AddCommentsBatchResponse' + description: Add Comments Batch Response "400": content: application/json: @@ -28643,33 +39025,54 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Get reactions + summary: Add multiple comments in a batch tags: - - product:chat + - product:feeds + /api/v2/feeds/comments/query: post: description: | - Get reactions on a message - operationId: QueryReactions - parameters: - - in: path - name: id - required: true - schema: - type: string - writeOnly: true - x-stream-index: "001" + Query comments using MongoDB-style filters with pagination and sorting options + operationId: QueryComments requestBody: content: application/json: schema: - $ref: '#/components/schemas/QueryReactionsRequest' + $ref: '#/components/schemas/QueryCommentsRequest' + description: Query Comments Request required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/QueryReactionsResponse' + $ref: '#/components/schemas/QueryCommentsResponse' + description: Query Comments 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: Query comments + tags: + - product:feeds + /api/v2/feeds/feed_groups: + get: + description: | + List all feed groups for the application + operationId: ListFeedGroups + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/ListFeedGroupsResponse' description: Response "400": content: @@ -28683,40 +39086,27 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests + summary: List all feed groups tags: - - product:chat - /api/v2/chat/messages/{id}/translate: + - product:feeds post: description: | - Translates message to a given language using automated translation software - - Sends events: - - message.updated - - message.updated - operationId: TranslateMessage - parameters: - - in: path - name: id - required: true - schema: - description: Message ID - title: ID - type: string - writeOnly: true - x-stream-index: "002.001" + Creates a new feed group with the specified configuration + operationId: CreateFeedGroup requestBody: content: application/json: schema: - $ref: '#/components/schemas/TranslateMessageRequest' + $ref: '#/components/schemas/CreateFeedGroupRequest' + description: Create Feed Group Request required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/MessageResponse' - description: Response + $ref: '#/components/schemas/CreateFeedGroupResponse' + description: Upsert Feed Group Response "400": content: application/json: @@ -28729,41 +39119,46 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Translate message + summary: Create a new feed group tags: - - product:chat - /api/v2/chat/messages/{id}/undelete: - post: + - product:feeds + /api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}: + delete: description: | - Undelete a message that was previously soft-deleted - - Sends events: - - message.undeleted - - message.undeleted - operationId: UndeleteMessage + Delete a single feed by its ID + operationId: DeleteFeed parameters: - in: path - name: id + name: feed_group_id required: true schema: - description: Message ID - title: ID + maxLength: 255 type: string writeOnly: true - x-stream-index: "004.001" - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/UpdateMessageRequest' + x-stream-index: "001" + - in: path + name: feed_id required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "002" + - in: query + name: hard_delete + schema: + description: Whether to permanently delete the feed instead of soft delete + title: boolean + type: boolean + writeOnly: true + x-stream-index: "003" responses: - "201": + "200": content: application/json: schema: - $ref: '#/components/schemas/UpdateMessageResponse' - description: Response + $ref: '#/components/schemas/DeleteFeedResponse' + description: Delete Feed Response "400": content: application/json: @@ -28776,52 +39171,44 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Undelete message + summary: Delete a single feed tags: - - product:chat - /api/v2/chat/messages/{message_id}/polls/{poll_id}/vote: + - product:feeds post: description: | - Cast a vote on a poll - - Sends events: - - feeds.poll.vote_casted - - feeds.poll.vote_changed - - feeds.poll.vote_removed - - poll.vote_casted - - poll.vote_changed - - poll.vote_removed - operationId: CastPollVote + Create a single feed for a given feed group + operationId: GetOrCreateFeed parameters: - in: path - name: message_id + name: feed_group_id required: true schema: + maxLength: 255 type: string writeOnly: true x-stream-index: "001" - in: path - name: poll_id + name: feed_id required: true schema: - description: Poll ID maxLength: 255 - title: string type: string - x-stream-index: "003" + writeOnly: true + x-stream-index: "002" requestBody: content: application/json: schema: - $ref: '#/components/schemas/CastPollVoteRequest' + $ref: '#/components/schemas/GetOrCreateFeedRequest' + description: ClientRequest required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/PollVoteResponse' - description: Successful response + $ref: '#/components/schemas/GetOrCreateFeedResponse' + description: Response "400": content: application/json: @@ -28834,57 +39221,44 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Cast vote + summary: Create a new feed tags: - - product:chat - /api/v2/chat/messages/{message_id}/polls/{poll_id}/vote/{vote_id}: - delete: + - product:feeds + put: description: | - Delete a vote from a poll - - Sends events: - - feeds.poll.vote_removed - - poll.vote_removed - operationId: DeletePollVote + Update an existing feed + operationId: UpdateFeed parameters: - in: path - name: message_id - required: true - schema: - type: string - writeOnly: true - x-stream-index: "002" - - in: path - name: poll_id + name: feed_group_id required: true schema: - description: Poll ID maxLength: 255 - title: string type: string - x-stream-index: "004" + writeOnly: true + x-stream-index: "001" - in: path - name: vote_id + name: feed_id required: true schema: - description: Vote ID maxLength: 255 - title: string - type: string - x-stream-index: "005" - - in: query - name: user_id - schema: type: string writeOnly: true - x-stream-index: "001" + x-stream-index: "002" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateFeedRequest' + description: Update Feed Request + required: true responses: - "200": + "201": content: application/json: schema: - $ref: '#/components/schemas/PollVoteResponse' - description: Successful response + $ref: '#/components/schemas/UpdateFeedResponse' + description: Update Feed Response "400": content: application/json: @@ -28897,38 +39271,51 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Delete vote + summary: Update a feed tags: - - product:chat - /api/v2/chat/messages/{message_id}/reminders: + - product:feeds + /api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/activities/{activity_id}/pin: delete: description: | - Deletes a user's created reminder - - Sends events: - - reminder.deleted - operationId: DeleteReminder + Unpin an activity from a feed. This removes the pin, so the activity will no longer be displayed at the top of the feed. + operationId: UnpinActivity parameters: - in: path - name: message_id + name: feed_group_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + - in: path + name: feed_id required: true schema: + maxLength: 255 type: string writeOnly: true x-stream-index: "002" + - in: path + name: activity_id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "003" - in: query name: user_id schema: type: string writeOnly: true - x-stream-index: "001" + x-stream-index: "004.001" responses: "200": content: application/json: schema: - $ref: '#/components/schemas/DeleteReminderResponse' - description: Response + $ref: '#/components/schemas/UnpinActivityResponse' + description: Unpin Activity Response "400": content: application/json: @@ -28941,37 +39328,51 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Delete reminder + summary: Unpin an activity from a feed tags: - - product:chat - patch: + - product:feeds + post: description: | - Updates an existing reminder - - Sends events: - - reminder.updated - operationId: UpdateReminder + Pin an activity to a feed. Pinned activities are typically displayed at the top of a feed. + operationId: PinActivity parameters: - in: path - name: message_id + name: feed_group_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + - in: path + name: feed_id required: true schema: + maxLength: 255 type: string writeOnly: true x-stream-index: "002" + - in: path + name: activity_id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "003" requestBody: content: application/json: schema: - $ref: '#/components/schemas/UpdateReminderRequest' + $ref: '#/components/schemas/PinActivityRequest' + description: Pin Activity Request required: true responses: - "200": + "201": content: application/json: schema: - $ref: '#/components/schemas/UpdateReminderResponse' - description: Response + $ref: '#/components/schemas/PinActivityResponse' + description: Pin Activity Response "400": content: application/json: @@ -28984,21 +39385,28 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Updates Reminder + summary: Pin an activity to a feed tags: - - product:chat + - product:feeds + /api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/activities/mark/batch: post: description: | - Creates a new reminder - - Sends events: - - reminder.created - operationId: CreateReminder + Mark activities as read/seen/watched. Can mark by timestamp (seen), activity IDs (read), or all as read. + operationId: MarkActivity parameters: - in: path - name: message_id + name: feed_group_id required: true schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + - in: path + name: feed_id + required: true + schema: + maxLength: 255 type: string writeOnly: true x-stream-index: "002" @@ -29006,15 +39414,16 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/CreateReminderRequest' + $ref: '#/components/schemas/MarkActivityRequest' + description: Mark Activity Request required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/ReminderResponseData' - description: Successful response + $ref: '#/components/schemas/Response' + description: Response "400": content: application/json: @@ -29027,141 +39436,44 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Create reminder + summary: Mark activities as read/seen/watched tags: - - product:chat - /api/v2/chat/messages/{parent_id}/replies: - get: + - product:feeds + /api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/members: + patch: description: | - Returns replies (thread) of the message - operationId: GetReplies + Add, remove, or set members for a feed + operationId: UpdateFeedMembers parameters: - in: path - name: parent_id + name: feed_group_id required: true schema: + maxLength: 255 type: string writeOnly: true x-stream-index: "001" - - in: query - name: sort + - in: path + name: feed_id + required: true schema: - items: - $ref: '#/components/schemas/SortParamRequest' - maximum: 1 - type: array + maxLength: 255 + type: string writeOnly: true x-stream-index: "002" - - in: query - name: limit - schema: - description: 'The maximum number of messages to return (max limit ' - format: int32 - minimum: 0 - title: Limit - type: integer - x-stream-index: "003.001" - - in: query - name: offset - schema: - description: The offset to start from - format: int32 - title: Offset - type: integer - x-stream-index: "003.002" - - in: query - name: id_gte - schema: - description: The ID of the message to get messages with a timestamp greater - than or equal to - title: IDGTE - type: string - x-stream-index: "003.003" - - in: query - name: id_gt - schema: - description: The ID of the message to get messages with a timestamp greater - than - title: IDGT - type: string - x-stream-index: "003.004" - - in: query - name: id_lte - schema: - description: The ID of the message to get messages with a timestamp smaller - than or equal to - title: IDLTE - type: string - x-stream-index: "003.005" - - in: query - name: id_lt - schema: - description: The ID of the message to get messages with a timestamp smaller - than - title: IDLT - type: string - x-stream-index: "003.006" - - in: query - name: created_at_after_or_equal - schema: - description: The timestamp to get messages with a created_at timestamp greater - than or equal to - format: date-time - title: Created_at after or equal - type: number - x-stream-index: "003.007" - - in: query - name: created_at_after - schema: - description: The timestamp to get messages with a created_at timestamp greater - than - format: date-time - title: Created_at after - type: number - x-stream-index: "003.008" - - in: query - name: created_at_before_or_equal - schema: - description: The timestamp to get messages with a created_at timestamp smaller - than or equal to - format: date-time - title: Created_at after before or equal - type: number - x-stream-index: "003.009" - - in: query - name: created_at_before - schema: - description: The timestamp to get messages with a created_at timestamp smaller - than - format: date-time - title: Created_at after before - type: number - x-stream-index: "003.010" - - in: query - name: id_around - schema: - description: The result will be a set of messages, that are both older and - newer than the message with the provided ID, and the message with the - ID provided will be in the middle of the set - title: Id around - type: string - x-stream-index: "003.011" - - in: query - name: created_at_around - schema: - description: The result will be a set of messages, that are both older and - newer than the created_at timestamp provided, distributed evenly around - the timestamp - format: date-time - title: Created_at around - type: number - x-stream-index: "003.012" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateFeedMembersRequest' + description: Update Feed Members Request + required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/GetRepliesResponse' + $ref: '#/components/schemas/UpdateFeedMembersResponse' description: Response "400": content: @@ -29175,64 +39487,45 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Get replies + summary: Update feed members tags: - - product:chat - /api/v2/chat/messages/history: + - product:feeds + /api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/members/accept: post: description: | - Queries history for one message - operationId: QueryMessageHistory + Accepts a pending feed member request + operationId: AcceptFeedMemberInvite + parameters: + - in: path + name: feed_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + - in: path + name: feed_group_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "002" requestBody: content: application/json: schema: - $ref: '#/components/schemas/QueryMessageHistoryRequest' + $ref: '#/components/schemas/AcceptFeedMemberInviteRequest' + description: Accept Feed Member Invite Request required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/QueryMessageHistoryResponse' - description: Successful 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: Query message history - tags: - - product:chat - /api/v2/chat/moderation/flags/message: - get: - description: | - Find and filter message flags - operationId: QueryMessageFlags - parameters: - - content: - application/json: - schema: - $ref: '#/components/schemas/QueryMessageFlagsPayload' - description: JSON object with query message flags payload - title: Payload - x-stream-index: "001" - in: query - name: payload - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/QueryMessageFlagsResponse' - description: QueryMessageFlagsResponse + $ref: '#/components/schemas/AcceptFeedMemberInviteResponse' + description: Accept Feed Member Invite Response "400": content: application/json: @@ -29245,30 +39538,43 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Query Message Flags + summary: Accept a feed member request tags: - - product:chat - /api/v2/chat/moderation/mute/channel: + - product:feeds + /api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/members/query: post: description: | - Mutes channel for user - - Sends events: - - channel.muted - - channel.muted - operationId: MuteChannel + Query feed members based on filters with pagination and sorting options + operationId: QueryFeedMembers + parameters: + - in: path + name: feed_group_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + - in: path + name: feed_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "002" requestBody: content: application/json: schema: - $ref: '#/components/schemas/MuteChannelRequest' + $ref: '#/components/schemas/QueryFeedMembersRequest' required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/MuteChannelResponse' + $ref: '#/components/schemas/QueryFeedMembersResponse' description: Successful response "400": content: @@ -29282,31 +39588,45 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Mute channel + summary: Query feed members tags: - - product:chat - /api/v2/chat/moderation/unmute/channel: + - product:feeds + /api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/members/reject: post: description: | - Unmutes channel for user - - Sends events: - - channel.unmuted - - channel.unmuted - operationId: UnmuteChannel + Rejects a pending feed member request + operationId: RejectFeedMemberInvite + parameters: + - in: path + name: feed_group_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + - in: path + name: feed_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "002" requestBody: content: application/json: schema: - $ref: '#/components/schemas/UnmuteChannelRequest' + $ref: '#/components/schemas/RejectFeedMemberInviteRequest' + description: Reject Feed Member Request required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/UnmuteResponse' - description: Response + $ref: '#/components/schemas/RejectFeedMemberInviteResponse' + description: Reject Feed Member Response "400": content: application/json: @@ -29319,27 +39639,52 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Unmute channel + summary: Reject an invite to become a feed member tags: - - product:chat - /api/v2/chat/push_preferences: - post: + - product:feeds + /api/v2/feeds/feed_groups/{feed_group_id}/follow_suggestions: + get: description: | - Update the push preferences for a user and or channel member. Set to all, mentions or none - operationId: UpdatePushNotificationPreferences - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/UpsertPushPreferencesRequest' + Get follow suggestions for a feed group + operationId: GetFollowSuggestions + parameters: + - in: path + name: feed_group_id required: true + schema: + description: The ID of the feed group to get suggestions for + maxLength: 255 + title: Feed Group ID + type: string + writeOnly: true + x-stream-index: "001" + - in: query + name: limit + schema: + description: Maximum number of suggestions to return + format: int32 + maximum: 100 + minimum: 1 + title: Limit + type: integer + writeOnly: true + x-stream-index: "002" + - in: query + name: user_id + schema: + description: The ID of the user requesting suggestions (optional, defaults + to current user) + title: User ID + type: string + writeOnly: true + x-stream-index: "003.001" responses: - "201": + "200": content: application/json: schema: - $ref: '#/components/schemas/UpsertPushPreferencesResponse' - description: Successful response + $ref: '#/components/schemas/GetFollowSuggestionsResponse' + description: Follow Suggestions Response "400": content: application/json: @@ -29352,41 +39697,38 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Push notification preferences + summary: Get follow suggestions tags: - - product:chat - /api/v2/chat/push_templates: - get: + - product:feeds + /api/v2/feeds/feed_groups/{id}: + delete: description: | - Retrieve push notification templates for Chat. - operationId: GetPushTemplates + Delete a feed group by its ID. Can perform a soft delete (default) or hard delete. + operationId: DeleteFeedGroup parameters: - - in: query - name: push_provider_name + - in: path + name: id + required: true schema: - description: Push provider name to filter templates - title: string + maxLength: 255 type: string writeOnly: true - x-stream-index: "002" + x-stream-index: "001" - in: query - name: push_provider_type - required: true + name: hard_delete schema: - description: Push provider type (firebase, apn) to filter templates - enum: - - firebase - - apn - title: string - type: string + description: Whether to perform a hard delete (true) or soft delete (false, + default) + title: boolean + type: boolean writeOnly: true - x-stream-index: "003" + x-stream-index: "002" responses: "200": content: application/json: schema: - $ref: '#/components/schemas/GetPushTemplatesResponse' + $ref: '#/components/schemas/DeleteFeedGroupResponse' description: Response "400": content: @@ -29400,26 +39742,28 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Get push notification templates + summary: Delete a feed group tags: - - product:chat - post: + - product:feeds + get: description: | - Create or update a push notification template for a specific event type and push provider - operationId: UpsertPushTemplate - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/UpsertPushTemplateRequest' + Get a feed group by ID + operationId: GetFeedGroup + parameters: + - in: path + name: id required: true + schema: + type: string + writeOnly: true + x-stream-index: "001" responses: - "201": + "200": content: application/json: schema: - $ref: '#/components/schemas/UpsertPushTemplateResponse' - description: Response + $ref: '#/components/schemas/GetFeedGroupResponse' + description: Get Feed Group Response "400": content: application/json: @@ -29432,31 +39776,38 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Upsert a push notification template + summary: Get a feed group tags: - - product:chat - /api/v2/chat/query_banned_users: - get: + - product:feeds + post: description: | - Find and filter channel scoped or global user bans - operationId: QueryBannedUsers + Get an existing feed group or create a new one if it doesn't exist + operationId: GetOrCreateFeedGroup parameters: - - content: + - in: path + name: id + required: true + schema: + description: Unique identifier for the feed group + maxLength: 255 + title: Feed Group ID + type: string + writeOnly: true + x-stream-index: "001" + requestBody: + content: application/json: schema: - $ref: '#/components/schemas/QueryBannedUsersPayload' - description: JSON object with query user bans payload - title: Payload - x-stream-index: "001" - in: query - name: payload + $ref: '#/components/schemas/GetOrCreateFeedGroupRequest' + description: Get Or Create Feed Group Request + required: true responses: - "200": + "201": content: application/json: schema: - $ref: '#/components/schemas/QueryBannedUsersResponse' - description: Successful response + $ref: '#/components/schemas/GetOrCreateFeedGroupResponse' + description: Get Or Create Feed Group Response "400": content: application/json: @@ -29469,27 +39820,35 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Query Banned Users + summary: Get or create a feed group tags: - - product:chat - /api/v2/chat/reminders/query: - post: + - product:feeds + put: description: | - Queries reminders - operationId: QueryReminders + Update a feed group by ID + operationId: UpdateFeedGroup + parameters: + - in: path + name: id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "001" requestBody: content: application/json: schema: - $ref: '#/components/schemas/QueryRemindersRequest' + $ref: '#/components/schemas/UpdateFeedGroupRequest' + description: Update Feed Group Request required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/QueryRemindersResponse' - description: Successful response + $ref: '#/components/schemas/UpdateFeedGroupResponse' + description: Update Feed Group Response "400": content: application/json: @@ -29502,31 +39861,21 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Query reminders + summary: Update a feed group tags: - - product:chat - /api/v2/chat/search: + - product:feeds + /api/v2/feeds/feed_views: get: description: | - Search messages across channels - operationId: Search - parameters: - - content: - application/json: - schema: - $ref: '#/components/schemas/SearchPayload' - description: JSON object with search payload - title: Payload - x-stream-index: "001" - in: query - name: payload + List all feed views for a feed group + operationId: ListFeedViews responses: "200": content: application/json: schema: - $ref: '#/components/schemas/SearchResponse' - description: Successful response + $ref: '#/components/schemas/ListFeedViewsResponse' + description: List Feed Views Response "400": content: application/json: @@ -29539,30 +39888,27 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Search messages + summary: List all feed views tags: - - product:chat - /api/v2/chat/segments/{id}: - delete: + - product:feeds + post: description: | - Delete a segment - operationId: DeleteSegment - parameters: - - in: path - name: id + Create a custom view for a feed group with specific selectors, ranking, or aggregation options + operationId: CreateFeedView + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateFeedViewRequest' + description: Create Feed View Request required: true - schema: - maxLength: 255 - type: string - writeOnly: true - x-stream-index: "001" responses: - "200": + "201": content: application/json: schema: - $ref: '#/components/schemas/Response' - description: Response + $ref: '#/components/schemas/CreateFeedViewResponse' + description: Create Feed View Response "400": content: application/json: @@ -29575,13 +39921,14 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Delete segment + summary: Create a new feed view tags: - - product:chat - get: + - product:feeds + /api/v2/feeds/feed_views/{id}: + delete: description: | - Get segment - operationId: GetSegment + Delete an existing custom feed view + operationId: DeleteFeedView parameters: - in: path name: id @@ -29596,8 +39943,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GetSegmentResponse' - description: Successful response + $ref: '#/components/schemas/DeleteFeedViewResponse' + description: Delete Feed View Response "400": content: application/json: @@ -29610,14 +39957,13 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Get segment + summary: Delete a feed view tags: - - product:chat - /api/v2/chat/segments/{id}/deletetargets: - post: + - product:feeds + get: description: | - Delete targets from a segment - operationId: DeleteSegmentTargets + Get a feed view by its ID + operationId: GetFeedView parameters: - in: path name: id @@ -29627,19 +39973,13 @@ paths: type: string writeOnly: true x-stream-index: "001" - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/DeleteSegmentTargetsRequest' - required: true responses: - "201": + "200": content: application/json: schema: - $ref: '#/components/schemas/Response' - description: Response + $ref: '#/components/schemas/GetFeedViewResponse' + description: Get Feed View Response "400": content: application/json: @@ -29652,14 +39992,13 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Delete targets from a segment + summary: Get a feed view tags: - - product:chat - /api/v2/chat/segments/{id}/target/{target_id}: - get: + - product:feeds + post: description: | - Check whether a target exists in a segment. Returns 200 if the target exists, 404 otherwise - operationId: SegmentTargetExists + Get an existing feed view or create a new one if it doesn't exist + operationId: GetOrCreateFeedView parameters: - in: path name: id @@ -29669,20 +40008,20 @@ paths: type: string writeOnly: true x-stream-index: "001" - - in: path - name: target_id + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GetOrCreateFeedViewRequest' + description: Get Or Create Feed View Request required: true - schema: - type: string - writeOnly: true - x-stream-index: "002" responses: - "200": + "201": content: application/json: schema: - $ref: '#/components/schemas/Response' - description: Response + $ref: '#/components/schemas/GetOrCreateFeedViewResponse' + description: Get Or Create Feed View Response "400": content: application/json: @@ -29695,14 +40034,13 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Check whether a target exists in a segment + summary: Get or create a feed view tags: - - product:chat - /api/v2/chat/segments/{id}/targets/query: - post: + - product:feeds + put: description: | - Query segment targets - operationId: QuerySegmentTargets + Update an existing custom feed view with new selectors, ranking, or aggregation options + operationId: UpdateFeedView parameters: - in: path name: id @@ -29716,15 +40054,16 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/QuerySegmentTargetsRequest' + $ref: '#/components/schemas/UpdateFeedViewRequest' + description: Update Feed View Request required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/QuerySegmentTargetsResponse' - description: Successful response + $ref: '#/components/schemas/UpdateFeedViewResponse' + description: Update Feed View Response "400": content: application/json: @@ -29737,27 +40076,28 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Query segment targets + summary: Update a feed view tags: - - product:chat - /api/v2/chat/segments/query: + - product:feeds + /api/v2/feeds/feeds/batch: post: description: | - Query segments - operationId: QuerySegments + Create multiple feeds at once for a given feed group + operationId: CreateFeedsBatch requestBody: content: application/json: schema: - $ref: '#/components/schemas/QuerySegmentsRequest' + $ref: '#/components/schemas/CreateFeedsBatchRequest' + description: Create Feeds Batch Request required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/QuerySegmentsResponse' - description: Successful response + $ref: '#/components/schemas/CreateFeedsBatchResponse' + description: Create Feeds Batch Response "400": content: application/json: @@ -29770,27 +40110,28 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Query segments + summary: Create multiple feeds at once tags: - - product:chat - /api/v2/chat/threads: + - product:feeds + /api/v2/feeds/feeds/query: post: description: | - Returns the list of threads for specific user - operationId: QueryThreads + Query feeds with filter query + operationId: QueryFeeds requestBody: content: application/json: schema: - $ref: '#/components/schemas/QueryThreadsRequest' + $ref: '#/components/schemas/QueryFeedsRequest' + description: Query Feeds Request required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/QueryThreadsResponse' - description: Successful response + $ref: '#/components/schemas/QueryFeedsResponse' + description: Query Feeds Response "400": content: application/json: @@ -29803,61 +40144,28 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Query Threads + summary: Query feeds tags: - - product:chat - /api/v2/chat/threads/{message_id}: - get: + - product:feeds + /api/v2/feeds/follows: + patch: description: | - Return a specific thread - operationId: GetThread - parameters: - - in: path - name: message_id + Updates a follow's custom data, push preference, and follower role. Source owner can update custom data and push preference. Target owner can update follower role. + operationId: UpdateFollow + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateFollowRequest' + description: Update Follow Request required: true - schema: - type: string - writeOnly: true - x-stream-index: "001" - - in: query - name: reply_limit - schema: - description: Limit the number of replies returned - format: int32 - minimum: 0 - title: Reply limit - type: integer - writeOnly: true - x-stream-index: "004" - - in: query - name: participant_limit - schema: - description: Limit the number of participants returned - format: int32 - maximum: 100 - minimum: 0 - title: Participant limit - type: integer - writeOnly: true - x-stream-index: "005" - - in: query - name: member_limit - schema: - description: Limit the number of members returned per thread channel - format: int32 - maximum: 100 - minimum: 0 - title: Member limit - type: integer - writeOnly: true - x-stream-index: "006" responses: "200": content: application/json: schema: - $ref: '#/components/schemas/GetThreadResponse' - description: Successful response + $ref: '#/components/schemas/UpdateFollowResponse' + description: Update Follow Response "400": content: application/json: @@ -29870,38 +40178,27 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Get Thread + summary: Update a follow tags: - - product:chat - patch: + - product:feeds + post: description: | - Updates certain fields of the thread - - Sends events: - - thread.updated - - thread.updated - operationId: UpdateThreadPartial - parameters: - - in: path - name: message_id - required: true - schema: - type: string - writeOnly: true - x-stream-index: "001" + Creates a follow and broadcasts FollowAddedEvent + operationId: Follow requestBody: content: application/json: schema: - $ref: '#/components/schemas/UpdateThreadPartialRequest' + $ref: '#/components/schemas/FollowRequest' + description: Follow Request required: true responses: - "200": + "201": content: application/json: schema: - $ref: '#/components/schemas/UpdateThreadPartialResponse' - description: Successful response + $ref: '#/components/schemas/SingleFollowResponse' + description: Follow Response "400": content: application/json: @@ -29914,21 +40211,42 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Partially update thread + summary: Create a follow tags: - - product:chat - /api/v2/chat/unread: - get: + - product:feeds + /api/v2/feeds/follows/{source}/{target}: + delete: description: | - Fetch unread counts for a single user - operationId: UnreadCounts + Removes a follow and broadcasts FollowRemovedEvent + operationId: Unfollow + parameters: + - in: path + name: source + required: true + schema: + description: Fully qualified ID of the source feed + maxLength: 255 + title: Source Feed + type: string + writeOnly: true + x-stream-index: "001" + - in: path + name: target + required: true + schema: + description: Fully qualified ID of the target feed + maxLength: 255 + title: Target Feed + type: string + writeOnly: true + x-stream-index: "002" responses: "200": content: application/json: schema: - $ref: '#/components/schemas/WrappedUnreadCountsResponse' - description: Response + $ref: '#/components/schemas/UnfollowResponse' + description: Unfollow Response "400": content: application/json: @@ -29941,27 +40259,28 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Unread counts + summary: Unfollow a feed tags: - - product:chat - /api/v2/chat/unread_batch: + - product:feeds + /api/v2/feeds/follows/accept: post: description: | - Fetch unread counts in batch for multiple users in one call - operationId: UnreadCountsBatch + Accepts a pending follow request + operationId: AcceptFollow requestBody: content: application/json: schema: - $ref: '#/components/schemas/UnreadCountsBatchRequest' + $ref: '#/components/schemas/AcceptFollowRequest' + description: Accept Follow Request required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/UnreadCountsBatchResponse' - description: Response + $ref: '#/components/schemas/AcceptFollowResponse' + description: Accept Follow Response "400": content: application/json: @@ -29974,38 +40293,28 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Batch unread counts + summary: Accept a follow request tags: - - product:chat - /api/v2/chat/users/{user_id}/event: + - product:feeds + /api/v2/feeds/follows/batch: post: description: | - Sends a custom event to a user - - Sends events: - - * - operationId: SendUserCustomEvent - parameters: - - in: path - name: user_id - required: true - schema: - type: string - writeOnly: true - x-stream-index: "002" + Creates multiple follows at once and broadcasts FollowAddedEvent for each follow + operationId: FollowBatch requestBody: content: application/json: schema: - $ref: '#/components/schemas/SendUserCustomEventRequest' + $ref: '#/components/schemas/FollowBatchRequest' + description: Follow Batch Request required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/Response' - description: Response + $ref: '#/components/schemas/FollowBatchResponse' + description: Follow Batch Response "400": content: application/json: @@ -30018,28 +40327,28 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Send user event + summary: Create multiple follows at once tags: - - product:chat - /api/v2/check_push: + - product:feeds + /api/v2/feeds/follows/query: post: description: | - Sends a test message via push, this is a test endpoint to verify your push settings - operationId: CheckPush + Query follows based on filters with pagination and sorting options + operationId: QueryFollows requestBody: content: application/json: schema: - $ref: '#/components/schemas/CheckPushRequest' - description: CheckPushRequest + $ref: '#/components/schemas/QueryFollowsRequest' + description: Query Follows Request required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/CheckPushResponse' - description: Successful response + $ref: '#/components/schemas/QueryFollowsResponse' + description: Query Follows Response "400": content: application/json: @@ -30052,27 +40361,28 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Check push + summary: Query follows tags: - - product:common - /api/v2/check_sns: + - product:feeds + /api/v2/feeds/follows/reject: post: description: | - Validates Amazon SNS configuration - operationId: CheckSNS + Rejects a pending follow request + operationId: RejectFollow requestBody: content: application/json: schema: - $ref: '#/components/schemas/CheckSNSRequest' + $ref: '#/components/schemas/RejectFollowRequest' + description: Reject Follow Request required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/CheckSNSResponse' - description: Successful response + $ref: '#/components/schemas/RejectFollowResponse' + description: Reject Follow Response "400": content: application/json: @@ -30085,27 +40395,28 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Check SNS + summary: Reject a follow request tags: - - product:common - /api/v2/check_sqs: + - product:feeds + /api/v2/feeds/membership_levels: post: description: | - Validates Amazon SQS credentials - operationId: CheckSQS + Create a new membership level with tag-based access controls + operationId: CreateMembershipLevel requestBody: content: application/json: schema: - $ref: '#/components/schemas/CheckSQSRequest' + $ref: '#/components/schemas/CreateMembershipLevelRequest' + description: Create Membership Level Request required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/CheckSQSResponse' - description: Successful response + $ref: '#/components/schemas/CreateMembershipLevelResponse' + description: Create Membership Level Response "400": content: application/json: @@ -30118,32 +40429,25 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Check SQS + summary: Create membership level tags: - - product:common - /api/v2/devices: + - product:feeds + /api/v2/feeds/membership_levels/{id}: delete: description: | - Deletes one device - operationId: DeleteDevice + Delete a membership level by its UUID. This operation is irreversible. + operationId: DeleteMembershipLevel parameters: - - in: query + - in: path name: id required: true schema: - description: Device ID to delete - title: ID + description: The UUID of the membership level to delete + maxLength: 255 + title: string type: string writeOnly: true x-stream-index: "001" - - in: query - name: user_id - schema: - description: '**Server-side only**. User ID which server acts upon' - title: User ID - type: string - writeOnly: true - x-stream-index: "002.001" responses: "200": content: @@ -30163,62 +40467,35 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Delete device + summary: Delete membership level tags: - - product:common - get: + - product:feeds + patch: description: | - Returns all available devices - operationId: ListDevices + Update a membership level with partial updates. Only specified fields will be updated. + operationId: UpdateMembershipLevel parameters: - - in: query - name: user_id + - in: path + name: id + required: true schema: - description: '**Server-side only**. User ID which server acts upon' - title: User ID type: string writeOnly: true - x-stream-index: "001.001" - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/ListDevicesResponse' - description: ListDevicesResponse - "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: List devices - tags: - - product:common - post: - description: | - Adds a new device to a user, if the same device already exists the call will have no effect - operationId: CreateDevice + x-stream-index: "001" requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateDeviceRequest' - description: CreateDeviceRequest + $ref: '#/components/schemas/UpdateMembershipLevelRequest' + description: Update Membership Level Request required: true responses: - "201": + "200": content: application/json: schema: - $ref: '#/components/schemas/Response' - description: Response + $ref: '#/components/schemas/UpdateMembershipLevelResponse' + description: Update Membership Level Response "400": content: application/json: @@ -30231,54 +40508,28 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Create device + summary: Update membership level tags: - - product:common - /api/v2/export/users: + - product:feeds + /api/v2/feeds/membership_levels/query: post: description: | - Exports user profile, reactions and messages for list of given users - operationId: ExportUsers + Query membership levels with filter query + operationId: QueryMembershipLevels requestBody: content: application/json: schema: - $ref: '#/components/schemas/ExportUsersRequest' + $ref: '#/components/schemas/QueryMembershipLevelsRequest' + description: Query Membership Levels Request required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/ExportUsersResponse' - 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: Export users - tags: - - product:common - /api/v2/external_storage: - get: - description: | - Lists external storage - operationId: ListExternalStorage - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/ListExternalStorageResponse' - description: Response + $ref: '#/components/schemas/QueryMembershipLevelsResponse' + description: Query Membership Levels Response "400": content: application/json: @@ -30291,27 +40542,28 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: List external storage + summary: Query membership levels tags: - - product:common + - product:feeds + /api/v2/feeds/unfollow/batch: post: description: | - Creates new external storage - operationId: CreateExternalStorage + Removes multiple follows at once and broadcasts FollowRemovedEvent for each one + operationId: UnfollowBatch requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateExternalStorageRequest' - description: CreateExternalStorageRequest + $ref: '#/components/schemas/UnfollowBatchRequest' + description: Unfollow Batch Request required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/CreateExternalStorageResponse' - description: Response + $ref: '#/components/schemas/UnfollowBatchResponse' + description: Unfollow Batch Response "400": content: application/json: @@ -30324,29 +40576,29 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Create external storage + summary: Unfollow multiple feeds at once tags: - - product:common - /api/v2/external_storage/{name}: + - product:feeds + /api/v2/feeds/users/{user_id}/delete: delete: description: | - Deletes external storage - operationId: DeleteExternalStorage + Delete all activities, reactions, comments, and bookmarks for a user + operationId: DeleteFeedUserData parameters: - in: path - name: name + name: user_id required: true schema: type: string writeOnly: true - x-stream-index: "002" + x-stream-index: "001" responses: "200": content: application/json: schema: - $ref: '#/components/schemas/DeleteExternalStorageResponse' - description: Response + $ref: '#/components/schemas/DeleteFeedUserDataResponse' + description: Successful response "400": content: application/json: @@ -30359,70 +40611,29 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Delete external storage + summary: Delete all feed data for a user tags: - - product:common - put: - description: |2+ - - operationId: UpdateExternalStorage + - product:feeds + /api/v2/feeds/users/{user_id}/export: + post: + description: | + Export all activities, reactions, comments, and bookmarks for a user + operationId: ExportFeedUserData parameters: - in: path - name: name + name: user_id required: true schema: type: string writeOnly: true x-stream-index: "001" - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/UpdateExternalStorageRequest' - description: ExternalStorageRequest - required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/UpdateExternalStorageResponse' - 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: Update External Storage - tags: - - product:common - /api/v2/external_storage/{name}/check: - get: - description: |2+ - - operationId: CheckExternalStorage - parameters: - - in: path - name: name - required: true - schema: - type: string - writeOnly: true - x-stream-index: "002" - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/CheckExternalStorageResponse' - description: Response + $ref: '#/components/schemas/ExportFeedUserDataResponse' + description: Successful response "400": content: application/json: @@ -30435,9 +40646,9 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Check External Storage + summary: Export all feed data for a user tags: - - product:common + - product:feeds /api/v2/guest: post: description: |2+ @@ -31065,6 +41276,125 @@ paths: summary: Query moderation action logs tags: - product:moderation + /api/v2/moderation/moderation_rule: + post: + description: | + Create or update a moderation rule that can apply app-wide or to specific moderation configs + operationId: upsert_moderation_rule + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpsertModerationRuleRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/UpsertModerationRuleResponse' + 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: Upsert moderation rule + tags: + - product:moderation + /api/v2/moderation/moderation_rule/{id}: + delete: + description: | + Delete an existing moderation rule + operationId: delete_moderation_rule + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteModerationRuleResponse' + 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: Delete moderation rule + tags: + - product:moderation + get: + description: | + Get a specific moderation rule by ID + operationId: get_moderation_rule + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/GetModerationRuleResponse' + 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: Get moderation rule + tags: + - product:moderation + /api/v2/moderation/moderation_rules: + post: + description: | + Search and filter moderation rules across your application. This endpoint is designed for building moderation dashboards and managing multiple rule sets. + operationId: query_moderation_rules + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueryModerationRulesRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/QueryModerationRulesResponse' + description: Successful 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: Query moderation rules + tags: + - product:moderation /api/v2/moderation/mute: post: description: | @@ -33524,6 +43854,65 @@ paths: summary: Set call as live tags: - product:video + /api/v2/video/call/{type}/{id}/kick: + post: + description: | + Kicks a user from the call. Optionally block the user from rejoining by setting block=true. + + Sends events: + - call.blocked_user + - call.kicked_user + operationId: KickUser + parameters: + - in: path + name: type + required: true + schema: + description: The type of call + maxLength: 64 + title: Type + type: string + writeOnly: true + x-stream-index: "002.001" + - in: path + name: id + required: true + schema: + description: Call ID + maxLength: 64 + title: ID + type: string + writeOnly: true + x-stream-index: "002.002" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/KickUserRequest' + description: KickUserRequest + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/KickUserResponse' + description: KickUserResponse + "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: Kick user from a call + tags: + - product:video /api/v2/video/call/{type}/{id}/mark_ended: post: description: |2 diff --git a/openapi/v2/chat-clientside-api.json b/openapi/v2/chat-clientside-api.json index 4505aa383..c6606c3c9 100644 --- a/openapi/v2/chat-clientside-api.json +++ b/openapi/v2/chat-clientside-api.json @@ -1 +1 @@ -{"components":{"schemas":{"AIImageConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"ocr_rules":{"items":{"$ref":"#/components/schemas/OCRRule"},"type":"array","x-stream-index":"004"},"rules":{"items":{"$ref":"#/components/schemas/AWSRekognitionRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules","ocr_rules"],"type":"object"},"AIIndicatorClearEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"ai_indicator.clear","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"AIIndicatorClearEvent","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"},"AIIndicatorStopEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"ai_indicator.stop","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"AIIndicatorStopEvent","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"},"AIIndicatorUpdateEvent":{"properties":{"ai_message":{"type":"string","x-stream-index":"005"},"ai_state":{"type":"string","x-stream-index":"004"},"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"message_id":{"type":"string","x-stream-index":"003"},"type":{"default":"ai_indicator.update","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","cid","channel_id","channel_type","message_id","ai_state"],"title":"AIIndicatorUpdateEvent","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"},"AITextConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"profile":{"type":"string","x-stream-index":"003"},"rules":{"items":{"$ref":"#/components/schemas/BodyguardRule"},"type":"array","x-stream-index":"004"},"severity_rules":{"items":{"$ref":"#/components/schemas/BodyguardSeverityRule"},"type":"array","x-stream-index":"005"}},"required":["enabled","profile","rules","severity_rules"],"type":"object"},"AIVideoConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AWSRekognitionRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"APIError":{"nullable":true,"properties":{"StatusCode":{"description":"Response HTTP status code","format":"int32","title":"Status code","type":"integer","x-stream-index":"004"},"code":{"description":"API error code","format":"int32","title":"Code","type":"integer","x-stream-index":"001"},"details":{"description":"Additional error-specific information","items":{"type":"integer"},"title":"Details","type":"array","x-stream-index":"007"},"duration":{"description":"Request duration","title":"Duration","type":"string","x-stream-index":"005"},"exception_fields":{"additionalProperties":{"type":"string"},"description":"Additional error info","title":"Exception fields","type":"object","x-stream-index":"003"},"message":{"description":"Message describing an error","title":"Message","type":"string","x-stream-index":"002"},"more_info":{"description":"URL with additional information","title":"More info","type":"string","x-stream-index":"006"},"unrecoverable":{"description":"Flag that indicates if the error is unrecoverable, requests that return unrecoverable errors should not be retried, this error only applies to the request that caused it","title":"Unrecoverable","type":"boolean","x-stream-index":"008"}},"required":["code","message","StatusCode","duration","more_info","details"],"title":"Error response","type":"object"},"APNS":{"properties":{"body":{"type":"string","x-stream-index":"002"},"content-available":{"format":"int32","type":"integer","x-stream-index":"004"},"data":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"mutable-content":{"format":"int32","type":"integer","x-stream-index":"005"},"sound":{"type":"string","x-stream-index":"003"},"title":{"type":"string","x-stream-index":"001"}},"required":["title","body"],"type":"object"},"AWSRekognitionRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"},"min_confidence":{"format":"float","maximum":100,"minimum":0,"type":"number","x-stream-index":"003"}},"required":["label","action","min_confidence"],"type":"object"},"Action":{"nullable":true,"properties":{"name":{"type":"string","x-stream-index":"001"},"style":{"type":"string","x-stream-index":"003"},"text":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"004"},"value":{"type":"string","x-stream-index":"005"}},"required":["name","text","type"],"type":"object"},"ActionLog":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"002"},"reason":{"type":"string","x-stream-index":"008"},"reporter_type":{"type":"string","x-stream-index":"009"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"014"},"review_queue_item_id":{"type":"string","x-stream-index":"012"},"target_user":{"$ref":"#/components/schemas/User","x-stream-index":"013"},"target_user_id":{"type":"string","x-stream-index":"011"},"type":{"type":"string","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007"}},"required":["id","created_at","type","reason","reporter_type","custom","target_user_id","review_queue_item_id"],"type":"object"},"ActionLogResponse":{"nullable":true,"properties":{"created_at":{"description":"Timestamp when the action was taken","format":"date-time","title":"Created At","type":"number","x-stream-index":"002"},"custom":{"additionalProperties":{},"description":"Additional metadata about the action","title":"Custom","type":"object","x-stream-index":"007"},"id":{"description":"Unique identifier of the action log","title":"ID","type":"string","x-stream-index":"001"},"reason":{"description":"Reason for the moderation action","title":"Reason","type":"string","x-stream-index":"006"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"Associated review queue item","title":"Review Queue Item","x-stream-index":"008"},"target_user":{"$ref":"#/components/schemas/UserResponse","description":"User who was the target of the action","title":"Target User","x-stream-index":"009"},"target_user_id":{"description":"ID of the user who was the target of the action","title":"Target User ID","type":"string","x-stream-index":"010"},"type":{"description":"Type of moderation action","title":"Type","type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who performed the action","title":"User","x-stream-index":"004"},"user_id":{"description":"ID of the user who performed the action","title":"User ID","type":"string","x-stream-index":"005"}},"required":["id","created_at","type","user_id","reason","custom","target_user_id"],"type":"object"},"ActionSequence":{"properties":{"action":{"type":"string","x-stream-index":"001"},"blur":{"type":"boolean","x-stream-index":"005"},"cooldown_period":{"format":"int32","type":"integer","x-stream-index":"004"},"threshold":{"format":"int32","type":"integer","x-stream-index":"002"},"time_window":{"format":"int32","type":"integer","x-stream-index":"003"},"warning":{"type":"boolean","x-stream-index":"006"},"warning_text":{"type":"string","x-stream-index":"007"}},"required":["action","threshold","time_window","cooldown_period","blur","warning","warning_text"],"type":"object"},"ActivityMarkedEvent":{"properties":{"all_read":{"type":"boolean","x-stream-index":"006"},"all_seen":{"type":"boolean","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"feed_id":{"type":"string","x-stream-index":"003"},"marked_read":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"marked_watched":{"items":{"type":"string"},"type":"array","x-stream-index":"005"},"type":{"default":"activity.marked","type":"string","x-stream-index":"001.001"},"user_id":{"type":"string","x-stream-index":"002"}},"required":["type","created_at","user_id","feed_id","all_read","all_seen"],"title":"ActivityMarkedEvent","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"},"AnyEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"*","type":"string","x-stream-index":"001.001"}},"required":["type","created_at"],"title":"AnyEvent","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"},"AppEventResponse":{"properties":{"async_url_enrich_enabled":{"description":"boolean","title":"Async URL Enrichment Enabled","type":"boolean","x-stream-index":"002"},"auto_translation_enabled":{"description":"boolean","title":"Auto Translation Enabled","type":"boolean","x-stream-index":"003"},"file_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","description":"file upload config","title":"File Upload Config","x-stream-index":"004"},"image_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","description":"file upload config","title":"Image Upload Config","x-stream-index":"005"},"name":{"description":"string","title":"App name","type":"string","x-stream-index":"001"}},"required":["name","auto_translation_enabled"],"type":"object"},"AppResponseFields":{"properties":{"async_url_enrich_enabled":{"type":"boolean","x-stream-index":"017"},"auto_translation_enabled":{"type":"boolean","x-stream-index":"020"},"file_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","x-stream-index":"030"},"image_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","x-stream-index":"031"},"name":{"type":"string","x-stream-index":"001"}},"required":["name","organization","push_notifications","webhook_url","moderation_webhook_url","channel_configs","call_types","policies","suspended","suspended_explanation","disable_auth_checks","disable_permissions_checks","permission_version","user_search_disallowed_roles","multi_tenant_enabled","image_moderation_enabled","async_url_enrich_enabled","auto_translation_enabled","custom_action_handler_url","enforce_unique_usernames","sqs_url","sqs_key","sqs_secret","sns_topic_arn","sns_key","sns_secret","file_upload_config","image_upload_config","grants","campaign_enabled","webhook_events","reminders_interval","cdn_expiration_seconds","video_provider","moderation_enabled","moderation_multitenant_blocklist_enabled","guest_user_creation_disabled","event_hooks","use_hook_v2","user_response_time_enabled","moderation_bulk_submit_action_enabled"],"type":"object"},"AppUpdatedEvent":{"description":"Emitted when app settings are updated","nullable":true,"properties":{"app":{"$ref":"#/components/schemas/AppEventResponse","description":"application configuration","title":"App settings","x-stream-index":"002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"type":{"default":"app.updated","description":"The type of event: \"app.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.002"}},"required":["type","created_at","custom","app"],"title":"AppUpdatedEvent","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"},"Attachment":{"description":"An attachment is a message object that represents a file uploaded by a user.","nullable":true,"properties":{"actions":{"items":{"$ref":"#/components/schemas/Action"},"type":"array","x-stream-index":"015"},"asset_url":{"type":"string","x-stream-index":"017"},"author_icon":{"type":"string","x-stream-index":"007"},"author_link":{"type":"string","x-stream-index":"006"},"author_name":{"type":"string","x-stream-index":"005"},"color":{"type":"string","x-stream-index":"003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"018"},"fallback":{"type":"string","x-stream-index":"002"},"fields":{"items":{"$ref":"#/components/schemas/Field"},"type":"array","x-stream-index":"016"},"footer":{"type":"string","x-stream-index":"013"},"footer_icon":{"type":"string","x-stream-index":"014"},"giphy":{"$ref":"#/components/schemas/Images","x-stream-index":"019"},"image_url":{"type":"string","x-stream-index":"011"},"og_scrape_url":{"type":"string","x-stream-index":"020"},"original_height":{"format":"int32","type":"integer","x-stream-index":"022"},"original_width":{"format":"int32","type":"integer","x-stream-index":"021"},"pretext":{"type":"string","x-stream-index":"004"},"text":{"type":"string","x-stream-index":"010"},"thumb_url":{"type":"string","x-stream-index":"012"},"title":{"type":"string","x-stream-index":"008"},"title_link":{"type":"string","x-stream-index":"009"},"type":{"description":"Attachment type (e.g. image, video, url)","title":"Type","type":"string","x-stream-index":"001"}},"required":["custom"],"title":"Attachment","type":"object","x-stream-docs-page-id":"file_uploads"},"AudioSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"001"},"default_device":{"enum":["speaker","earpiece"],"type":"string","x-stream-index":"006"},"mic_default_on":{"type":"boolean","x-stream-index":"004"},"noise_cancellation":{"$ref":"#/components/schemas/NoiseCancellationSettings","x-stream-index":"007"},"opus_dtx_enabled":{"type":"boolean","x-stream-index":"002"},"redundant_coding_enabled":{"type":"boolean","x-stream-index":"003"},"speaker_default_on":{"type":"boolean","x-stream-index":"005"}},"required":["access_request_enabled","opus_dtx_enabled","redundant_coding_enabled","mic_default_on","speaker_default_on","default_device"],"type":"object"},"AudioSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"001"},"default_device":{"enum":["speaker","earpiece"],"type":"string","x-stream-index":"006"},"mic_default_on":{"type":"boolean","x-stream-index":"004"},"noise_cancellation":{"$ref":"#/components/schemas/NoiseCancellationSettings","x-stream-index":"007"},"opus_dtx_enabled":{"type":"boolean","x-stream-index":"002"},"redundant_coding_enabled":{"type":"boolean","x-stream-index":"003"},"speaker_default_on":{"type":"boolean","x-stream-index":"005"}},"required":["access_request_enabled","opus_dtx_enabled","redundant_coding_enabled","mic_default_on","speaker_default_on","default_device"],"type":"object"},"AutomodDetails":{"properties":{"action":{"type":"string","x-stream-index":"001"},"image_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"005"},"message_details":{"$ref":"#/components/schemas/FlagMessageDetails","x-stream-index":"004"},"original_message_type":{"type":"string","x-stream-index":"002"},"result":{"$ref":"#/components/schemas/MessageModerationResult","x-stream-index":"003"}},"type":"object"},"AutomodPlatformCircumventionConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AutomodRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"AutomodRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"003"},"label":{"type":"string","x-stream-index":"001"},"threshold":{"format":"float","maximum":1,"minimum":0,"type":"number","x-stream-index":"002"}},"required":["label","threshold","action"],"type":"object"},"AutomodSemanticFiltersConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AutomodSemanticFiltersRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"AutomodSemanticFiltersRule":{"properties":{"action":{"enum":["flag","shadow","remove"],"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"threshold":{"format":"float","maximum":1,"minimum":0,"type":"number","x-stream-index":"002"}},"required":["name","threshold","action"],"type":"object"},"AutomodToxicityConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AutomodRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"BackstageSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"BackstageSettingsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"Ban":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"012"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"011"},"expires":{"format":"date-time","type":"number","x-stream-index":"007"},"reason":{"type":"string","x-stream-index":"008"},"shadow":{"type":"boolean","x-stream-index":"009"},"target":{"$ref":"#/components/schemas/User","x-stream-index":"006"}},"required":["shadow","created_at"],"type":"object"},"BanActionRequest":{"properties":{"channel_ban_only":{"type":"boolean","x-stream-index":"003"},"delete_messages":{"enum":["soft","pruning","hard"],"type":"string","x-stream-index":"005"},"ip_ban":{"type":"boolean","x-stream-index":"004"},"reason":{"type":"string","x-stream-index":"002"},"shadow":{"type":"boolean","x-stream-index":"001"},"timeout":{"format":"int32","type":"integer","x-stream-index":"006"}},"type":"object"},"BanOptions":{"properties":{"duration":{"format":"int32","type":"integer","x-stream-index":"001"},"ip_ban":{"type":"boolean","x-stream-index":"004"},"reason":{"type":"string","x-stream-index":"002"},"shadow_ban":{"type":"boolean","x-stream-index":"003"}},"required":["duration","reason","shadow_ban","ip_ban"],"type":"object"},"BanRequest":{"nullable":true,"properties":{"banned_by":{"$ref":"#/components/schemas/UserRequest","description":"Details about the user performing the ban","title":"Banned By","x-stream-index":"008"},"banned_by_id":{"description":"ID of the user performing the ban","title":"Banned By ID","type":"string","x-stream-index":"007"},"channel_cid":{"description":"Channel where the ban applies","title":"Channel CID","type":"string","x-stream-index":"004"},"delete_messages":{"enum":["soft","pruning","hard"],"type":"string","x-stream-index":"009"},"ip_ban":{"description":"Whether to ban the user's IP address","title":"IP Ban","type":"boolean","x-stream-index":"006"},"reason":{"description":"Optional explanation for the ban","title":"Reason","type":"string","x-stream-index":"003"},"shadow":{"description":"Whether this is a shadow ban","title":"Shadow","type":"boolean","x-stream-index":"005"},"target_user_id":{"description":"ID of the user to ban","title":"Target User ID","type":"string","x-stream-index":"001"},"timeout":{"description":"Duration of the ban in minutes","minimum":0,"title":"Timeout","type":"integer","x-stream-index":"002"}},"required":["target_user_id"],"type":"object"},"BanResponse":{"nullable":true,"properties":{"banned_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"006"},"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"expires":{"format":"date-time","type":"number","x-stream-index":"003"},"reason":{"type":"string","x-stream-index":"004"},"shadow":{"type":"boolean","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"}},"required":["created_at"],"type":"object"},"BlockContentOptions":{"properties":{"reason":{"type":"string","x-stream-index":"001"}},"required":["reason"],"type":"object"},"BlockListConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/BlockListRule"},"maximum":10,"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"BlockListOptions":{"properties":{"behavior":{"description":"Blocklist behavior","enum":["flag","block","shadow_block"],"title":"Behavior","type":"string","x-stream-index":"002"},"blocklist":{"description":"Blocklist name","title":"Blocklist","type":"string","x-stream-index":"001"}},"required":["blocklist","behavior"],"type":"object"},"BlockListResponse":{"description":"Block list contains restricted words","properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001"},"id":{"type":"string","x-stream-index":"003"},"name":{"description":"Block list name","title":"Name","type":"string","x-stream-index":"004"},"team":{"type":"string","x-stream-index":"007"},"type":{"description":"Block list type.","title":"Type","type":"string","x-stream-index":"005"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"002"},"words":{"description":"List of words to block","items":{"type":"string"},"title":"Words","type":"array","x-stream-index":"006"}},"required":["name","type","words"],"title":"Block list","type":"object","x-stream-docs-page-id":"block_lists"},"BlockListRule":{"properties":{"action":{"enum":["flag","mask_flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"002"}},"required":["name","team","action"],"type":"object"},"BlockUsersRequest":{"nullable":true,"properties":{"blocked_user_id":{"description":"User id to block","title":"BlockedUserID","type":"string","x-stream-index":"001"}},"required":["blocked_user_id"],"type":"object"},"BlockUsersResponse":{"nullable":true,"properties":{"blocked_by_user_id":{"description":"User id who blocked another user","title":"BlockedByUserID","type":"string","x-stream-index":"002"},"blocked_user_id":{"description":"User id who got blocked","title":"BlockedUserID","type":"string","x-stream-index":"003"},"created_at":{"description":"Timestamp when the user was blocked","format":"date-time","title":"CreatedAt","type":"number","x-stream-index":"004"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration","blocked_by_user_id","blocked_user_id","created_at"],"type":"object"},"BlockedUserResponse":{"nullable":true,"properties":{"blocked_user":{"$ref":"#/components/schemas/UserResponse","description":"User who got blocked","title":"User","x-stream-index":"003"},"blocked_user_id":{"description":"ID of the user who got blocked","title":"UserID","type":"string","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who blocked another user","title":"User","x-stream-index":"001"},"user_id":{"description":"ID of the user who blocked another user","title":"UserID","type":"string","x-stream-index":"002"}},"required":["user","user_id","blocked_user","blocked_user_id","created_at"],"type":"object"},"BodyguardRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"},"severity_rules":{"items":{"$ref":"#/components/schemas/BodyguardSeverityRule"},"type":"array","x-stream-index":"003"}},"required":["label","action","severity_rules"],"type":"object"},"BodyguardSeverityRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"severity":{"enum":["low","medium","high","critical"],"type":"string","x-stream-index":"001"}},"required":["severity","action"],"type":"object"},"BroadcastSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettings","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettings","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"BroadcastSettingsResponse":{"description":"BroadcastSettingsResponse is the payload for broadcasting settings","properties":{"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettingsResponse","title":"HLS","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettingsResponse","title":"RTMP","x-stream-index":"003"}},"required":["enabled","hls","rtmp"],"title":"BroadcastSettingsResponse","type":"object"},"Call":{"properties":{"AppPK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"002"},"Backstage":{"type":"boolean","writeOnly":true,"x-stream-index":"023"},"BlockedUserIDs":{"items":{"type":"string"},"type":"array","writeOnly":true,"x-stream-index":"018"},"BlockedUsers":{"items":{"$ref":"#/components/schemas/User"},"type":"array","writeOnly":true,"x-stream-index":"019"},"CID":{"type":"string","writeOnly":true,"x-stream-index":"005"},"CallType":{"$ref":"#/components/schemas/CallType","x-stream-index":"020"},"ChannelCID":{"type":"string","writeOnly":true,"x-stream-index":"032"},"CreatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"013"},"CreatedBy":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"CreatedByUserID":{"type":"string","writeOnly":true,"x-stream-index":"007"},"CurrentSessionID":{"type":"string","writeOnly":true,"x-stream-index":"024"},"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"012"},"DeletedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"028"},"EgressUpdatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"027"},"Egresses":{"items":{"$ref":"#/components/schemas/CallEgress"},"type":"array","writeOnly":true,"x-stream-index":"015"},"EndedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"017"},"ID":{"type":"string","writeOnly":true,"x-stream-index":"004"},"JoinAheadTimeSeconds":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"031"},"LastHeartbeatAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"030"},"LastSessionID":{"type":"string","writeOnly":true,"x-stream-index":"025"},"MemberCount":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"010"},"MemberLookup":{"$ref":"#/components/schemas/MemberLookup","x-stream-index":"011"},"Members":{"items":{"$ref":"#/components/schemas/CallMember"},"type":"array","writeOnly":true,"x-stream-index":"009"},"Session":{"$ref":"#/components/schemas/CallSession","x-stream-index":"026"},"Settings":{"$ref":"#/components/schemas/CallSettings","x-stream-index":"022"},"SettingsOverrides":{"$ref":"#/components/schemas/CallSettings","x-stream-index":"021"},"StartsAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"016"},"Team":{"type":"string","writeOnly":true,"x-stream-index":"006"},"ThumbnailURL":{"type":"string","writeOnly":true,"x-stream-index":"029"},"Type":{"type":"string","writeOnly":true,"x-stream-index":"003"},"UpdatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"014"}},"required":["AppPK","Type","ID","CID","Team","CreatedByUserID","Members","Custom","CreatedAt","UpdatedAt","Egresses","BlockedUserIDs","BlockedUsers","Backstage","CurrentSessionID","LastSessionID","ThumbnailURL","ChannelCID"],"type":"object"},"CallEgress":{"nullable":true,"properties":{"app_pk":{"format":"int32","type":"integer","x-stream-index":"002"},"call_id":{"type":"string","x-stream-index":"004"},"call_type":{"type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/EgressTaskConfig","x-stream-index":"007"},"egress_id":{"type":"string","x-stream-index":"005"},"egress_type":{"type":"string","x-stream-index":"006"},"instance_ip":{"type":"string","x-stream-index":"008"},"started_at":{"format":"date-time","type":"number","x-stream-index":"010"},"state":{"type":"string","x-stream-index":"009"},"stopped_at":{"format":"date-time","type":"number","x-stream-index":"011"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"012"}},"required":["app_pk","call_type","call_id","egress_id","egress_type","instance_ip","state","started_at","updated_at"],"type":"object"},"CallIngressResponse":{"description":"CallIngressResponse is the payload for ingress settings","properties":{"rtmp":{"$ref":"#/components/schemas/RTMPIngress","title":"RTMP","x-stream-index":"001"}},"required":["rtmp"],"title":"CallIngressResponse","type":"object"},"CallMember":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"010"},"role":{"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["user_id","role","custom","created_at","updated_at"],"type":"object"},"CallParticipant":{"nullable":true,"properties":{"JoinedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"004"},"Role":{"type":"string","writeOnly":true,"x-stream-index":"002"},"UserSessionID":{"type":"string","writeOnly":true,"x-stream-index":"003"},"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"001.046"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"001.017"},"banned":{"type":"boolean","x-stream-index":"001.016"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.013"},"id":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"001.023"},"language":{"type":"string","x-stream-index":"001.035"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"001.022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"001.026"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.042"},"role":{"type":"string","x-stream-index":"001.004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.005"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.009"}},"required":["id","role","teams_role","custom","banned","online","Role","UserSessionID","JoinedAt"],"type":"object"},"CallParticipantResponse":{"properties":{"joined_at":{"format":"date-time","type":"number","x-stream-index":"004"},"role":{"type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"},"user_session_id":{"type":"string","x-stream-index":"002"}},"required":["user","user_session_id","role","joined_at"],"type":"object"},"CallResponse":{"description":"Represents a call","properties":{"backstage":{"type":"boolean","x-stream-index":"016"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"018"},"captioning":{"type":"boolean","x-stream-index":"013"},"channel_cid":{"type":"string","x-stream-index":"024"},"cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"The user that created the call","title":"Created By","x-stream-index":"007"},"current_session_id":{"type":"string","x-stream-index":"005"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"008"},"egress":{"$ref":"#/components/schemas/EgressResponse","x-stream-index":"021"},"ended_at":{"description":"Date/time when the call ended","format":"date-time","title":"Ended At","type":"number","x-stream-index":"014"},"id":{"description":"Call ID","title":"ID","type":"string","x-stream-index":"003"},"ingress":{"$ref":"#/components/schemas/CallIngressResponse","x-stream-index":"019"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"023"},"recording":{"type":"boolean","x-stream-index":"011"},"session":{"$ref":"#/components/schemas/CallSessionResponse","x-stream-index":"020"},"settings":{"$ref":"#/components/schemas/CallSettingsResponse","x-stream-index":"017"},"starts_at":{"description":"Date/time when the call will start","format":"date-time","title":"Starts At","type":"number","x-stream-index":"015"},"team":{"type":"string","x-stream-index":"006"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailResponse","x-stream-index":"022"},"transcribing":{"type":"boolean","x-stream-index":"012"},"type":{"description":"The type of call","title":"Type","type":"string","x-stream-index":"002"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"}},"required":["type","id","cid","current_session_id","created_by","custom","created_at","updated_at","recording","transcribing","captioning","backstage","settings","blocked_user_ids","ingress","egress"],"title":"CallResponse","type":"object"},"CallSession":{"properties":{"AcceptedBy":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","writeOnly":true,"x-stream-index":"008"},"ActiveSFUs":{"items":{"$ref":"#/components/schemas/SFUIDLastSeen"},"type":"array","writeOnly":true,"x-stream-index":"016"},"AnonymousParticipantCount":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"019"},"AppPK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"002.001"},"CallID":{"type":"string","writeOnly":true,"x-stream-index":"002.003"},"CallType":{"type":"string","writeOnly":true,"x-stream-index":"002.002"},"CreatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"003"},"DeletedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"004"},"EndedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"006"},"LiveEndedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"013"},"LiveStartedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"012"},"MissedBy":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","writeOnly":true,"x-stream-index":"010"},"Participants":{"items":{"$ref":"#/components/schemas/CallParticipant"},"type":"array","writeOnly":true,"x-stream-index":"011"},"ParticipantsCountByRole":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","writeOnly":true,"x-stream-index":"018"},"RejectedBy":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","writeOnly":true,"x-stream-index":"009"},"RingAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"007"},"SFUIDs":{"items":{"type":"string"},"type":"array","writeOnly":true,"x-stream-index":"015"},"SessionID":{"type":"string","writeOnly":true,"x-stream-index":"002.004"},"StartedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"005"},"TimerEndsAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"014"},"UserPermissionOverrides":{"additionalProperties":{"additionalProperties":{"type":"boolean"},"type":"object"},"type":"object","writeOnly":true,"x-stream-index":"017"}},"required":["AppPK","CallType","CallID","SessionID","CreatedAt","AcceptedBy","RejectedBy","MissedBy","Participants","SFUIDs","ActiveSFUs","UserPermissionOverrides","ParticipantsCountByRole","AnonymousParticipantCount"],"type":"object"},"CallSessionResponse":{"properties":{"accepted_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"008"},"anonymous_participant_count":{"format":"int32","type":"integer","x-stream-index":"006"},"ended_at":{"format":"date-time","type":"number","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"live_ended_at":{"format":"date-time","type":"number","x-stream-index":"011"},"live_started_at":{"format":"date-time","type":"number","x-stream-index":"010"},"missed_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"009"},"participants":{"items":{"$ref":"#/components/schemas/CallParticipantResponse"},"type":"array","x-stream-index":"004"},"participants_count_by_role":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"005"},"rejected_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"007"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002"},"timer_ends_at":{"format":"date-time","type":"number","x-stream-index":"012"}},"required":["id","participants","participants_count_by_role","anonymous_participant_count","rejected_by","accepted_by","missed_by"],"type":"object"},"CallSettings":{"properties":{"audio":{"$ref":"#/components/schemas/AudioSettings","x-stream-index":"001"},"backstage":{"$ref":"#/components/schemas/BackstageSettings","x-stream-index":"002"},"broadcasting":{"$ref":"#/components/schemas/BroadcastSettings","x-stream-index":"007"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordSettings","x-stream-index":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettings","x-stream-index":"008"},"ingress":{"$ref":"#/components/schemas/IngressSettings","x-stream-index":"014"},"limits":{"$ref":"#/components/schemas/LimitsSettings","x-stream-index":"012"},"recording":{"$ref":"#/components/schemas/RecordSettings","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettings","x-stream-index":"010"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettings","x-stream-index":"004"},"session":{"$ref":"#/components/schemas/SessionSettings","x-stream-index":"013"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettings","x-stream-index":"011"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettings","x-stream-index":"009"},"video":{"$ref":"#/components/schemas/VideoSettings","x-stream-index":"003"}},"type":"object"},"CallSettingsResponse":{"properties":{"audio":{"$ref":"#/components/schemas/AudioSettingsResponse","x-stream-index":"001"},"backstage":{"$ref":"#/components/schemas/BackstageSettingsResponse","x-stream-index":"002"},"broadcasting":{"$ref":"#/components/schemas/BroadcastSettingsResponse","x-stream-index":"003"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordingSettingsResponse","x-stream-index":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettingsResponse","x-stream-index":"004"},"ingress":{"$ref":"#/components/schemas/IngressSettingsResponse","x-stream-index":"014"},"limits":{"$ref":"#/components/schemas/LimitsSettingsResponse","x-stream-index":"012"},"recording":{"$ref":"#/components/schemas/RecordSettingsResponse","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettingsResponse","x-stream-index":"007"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettingsResponse","x-stream-index":"008"},"session":{"$ref":"#/components/schemas/SessionSettingsResponse","x-stream-index":"013"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettingsResponse","x-stream-index":"011"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettingsResponse","x-stream-index":"009"},"video":{"$ref":"#/components/schemas/VideoSettingsResponse","x-stream-index":"010"}},"required":["audio","backstage","broadcasting","geofencing","recording","frame_recording","ring","screensharing","transcription","video","thumbnails","limits","session"],"type":"object"},"CallType":{"properties":{"AppPK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"003"},"CreatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"005"},"ExternalStorage":{"type":"string","writeOnly":true,"x-stream-index":"009"},"Name":{"type":"string","writeOnly":true,"x-stream-index":"004"},"NotificationSettings":{"$ref":"#/components/schemas/NotificationSettings","x-stream-index":"008"},"PK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"002"},"Settings":{"$ref":"#/components/schemas/CallSettings","x-stream-index":"007"},"UpdatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"006"}},"required":["PK","AppPK","Name","CreatedAt","UpdatedAt","ExternalStorage"],"type":"object"},"CastPollVoteRequest":{"nullable":true,"properties":{"vote":{"$ref":"#/components/schemas/VoteData","description":"Vote data","title":"VoteData","x-stream-index":"004"}},"type":"object"},"Channel":{"properties":{"active_live_locations":{"items":{"$ref":"#/components/schemas/SharedLocation"},"type":"array","x-stream-index":"034"},"auto_translation_enabled":{"type":"boolean","x-stream-index":"029"},"auto_translation_language":{"type":"string","x-stream-index":"030"},"cid":{"type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/ChannelConfig","x-stream-index":"026"},"config_overrides":{"$ref":"#/components/schemas/ConfigOverrides","x-stream-index":"027"},"cooldown":{"format":"int32","type":"integer","x-stream-index":"031"},"created_at":{"format":"date-time","type":"number","x-stream-index":"009"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"019"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"disabled":{"type":"boolean","x-stream-index":"017"},"frozen":{"type":"boolean","x-stream-index":"016"},"id":{"type":"string","x-stream-index":"004"},"invites":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"022"},"last_campaigns":{"type":"string","x-stream-index":"032"},"last_message_at":{"format":"date-time","type":"number","x-stream-index":"006"},"member_count":{"format":"int32","type":"integer","x-stream-index":"021"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"020"},"team":{"type":"string","x-stream-index":"028"},"truncated_by":{"$ref":"#/components/schemas/User","x-stream-index":"015"},"type":{"type":"string","x-stream-index":"005"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"010"}},"required":["cid","id","type","created_at","updated_at","frozen","disabled","custom","auto_translation_language"],"type":"object"},"ChannelConfig":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.026"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.021"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.022"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.027"},"blocklist":{"type":"string","x-stream-index":"001.023"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.024"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.025"},"commands":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"connect_events":{"type":"boolean","x-stream-index":"001.004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"custom_events":{"type":"boolean","x-stream-index":"001.012"},"mark_messages_pending":{"type":"boolean","x-stream-index":"001.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"001.020"},"mutes":{"type":"boolean","x-stream-index":"001.009"},"name":{"type":"string","x-stream-index":"001.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"001.028"},"partition_ttl":{"type":"integer","x-stream-index":"001.029"},"polls":{"type":"boolean","x-stream-index":"001.016"},"push_notifications":{"type":"boolean","x-stream-index":"001.013"},"quotes":{"type":"boolean","x-stream-index":"001.008"},"reactions":{"type":"boolean","x-stream-index":"001.006"},"read_events":{"type":"boolean","x-stream-index":"001.003"},"reminders":{"type":"boolean","x-stream-index":"001.014"},"replies":{"type":"boolean","x-stream-index":"001.007"},"search":{"type":"boolean","x-stream-index":"001.005"},"shared_locations":{"type":"boolean","x-stream-index":"001.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.030"},"typing_events":{"type":"boolean","x-stream-index":"001.002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"002.004"},"uploads":{"type":"boolean","x-stream-index":"001.010"},"url_enrichment":{"type":"boolean","x-stream-index":"001.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"001.017"}},"required":["name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","created_at","updated_at","commands"],"type":"object"},"ChannelConfigWithInfo":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.002.026"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.002.021"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.022"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.002.027"},"blocklist":{"type":"string","x-stream-index":"001.002.023"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.024"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.002.025"},"commands":{"items":{"$ref":"#/components/schemas/Command"},"type":"array","x-stream-index":"001.003"},"connect_events":{"type":"boolean","x-stream-index":"001.002.004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.001.003"},"custom_events":{"type":"boolean","x-stream-index":"001.002.012"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"002"},"mark_messages_pending":{"type":"boolean","x-stream-index":"001.002.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"001.002.020"},"mutes":{"type":"boolean","x-stream-index":"001.002.009"},"name":{"type":"string","x-stream-index":"001.002.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"001.002.028"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"001.002.029"},"polls":{"type":"boolean","x-stream-index":"001.002.016"},"push_notifications":{"type":"boolean","x-stream-index":"001.002.013"},"quotes":{"type":"boolean","x-stream-index":"001.002.008"},"reactions":{"type":"boolean","x-stream-index":"001.002.006"},"read_events":{"type":"boolean","x-stream-index":"001.002.003"},"reminders":{"type":"boolean","x-stream-index":"001.002.014"},"replies":{"type":"boolean","x-stream-index":"001.002.007"},"search":{"type":"boolean","x-stream-index":"001.002.005"},"shared_locations":{"type":"boolean","x-stream-index":"001.002.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.002.030"},"typing_events":{"type":"boolean","x-stream-index":"001.002.002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"uploads":{"type":"boolean","x-stream-index":"001.002.010"},"url_enrichment":{"type":"boolean","x-stream-index":"001.002.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"001.002.017"}},"required":["created_at","updated_at","name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","commands"],"type":"object"},"ChannelCreatedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"channel.created","type":"string","x-stream-index":"001.001"}},"required":["type","created_at"],"title":"ChannelCreatedEvent","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"},"ChannelDeletedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003.004"},"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"003.005"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"team":{"type":"string","x-stream-index":"001.001"},"type":{"default":"channel.deleted","type":"string","x-stream-index":"002.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"ChannelDeletedEvent","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"},"ChannelFrozenEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"channel.frozen","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"ChannelFrozenEvent","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"},"ChannelGetOrCreateRequest":{"nullable":true,"properties":{"data":{"$ref":"#/components/schemas/ChannelInput","x-stream-index":"003"},"hide_for_creator":{"description":"Whether this channel will be hidden for the user who created the channel or not","title":"Hide for creator","type":"boolean","x-stream-index":"007"},"members":{"$ref":"#/components/schemas/PaginationParams","x-stream-index":"010"},"messages":{"$ref":"#/components/schemas/MessagePaginationParams","x-stream-index":"009"},"presence":{"description":"Fetch user presence info","title":"Presence","type":"boolean","x-stream-index":"006"},"state":{"description":"Refresh channel state","title":"State","type":"boolean","x-stream-index":"005"},"thread_unread_counts":{"type":"boolean","x-stream-index":"008"},"watch":{"description":"Start watching the channel","title":"Watch","type":"boolean","x-stream-index":"004"},"watchers":{"$ref":"#/components/schemas/PaginationParams","x-stream-index":"011"}},"type":"object"},"ChannelHiddenEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003.004"},"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"003.005"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"clear_history":{"type":"boolean","x-stream-index":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"type":{"default":"channel.hidden","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["clear_history","cid","channel_id","channel_type","channel_member_count","type","created_at"],"title":"ChannelHiddenEvent","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"},"ChannelInput":{"properties":{"auto_translation_enabled":{"description":"Enable or disable auto translation","title":"Auto translation","type":"boolean","x-stream-index":"005"},"auto_translation_language":{"description":"Switch auto translation language","title":"Auto translation language","type":"string","x-stream-index":"006"},"config_overrides":{"$ref":"#/components/schemas/ChannelConfig","x-stream-index":"024"},"created_by":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"009"},"created_by_id":{"type":"string","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"015"},"disabled":{"type":"boolean","x-stream-index":"014"},"frozen":{"description":"Freeze or unfreeze the channel","title":"Frozen","type":"boolean","x-stream-index":"013"},"invites":{"items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"type":"array","x-stream-index":"016"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"type":"array","x-stream-index":"018"},"team":{"description":"Team the channel belongs to (if multi-tenant mode is enabled)","title":"Team","type":"string","x-stream-index":"004"},"truncated_by_id":{"type":"string","x-stream-index":"010"}},"type":"object"},"ChannelKickedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002.004"},"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"002.005"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"channel.kicked","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"ChannelKickedEvent","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"},"ChannelMember":{"nullable":true,"properties":{"archived_at":{"format":"date-time","type":"number","x-stream-index":"015"},"ban_expires":{"description":"Expiration date of the ban","format":"date-time","title":"Ban expires","type":"number","x-stream-index":"013"},"banned":{"description":"Whether member is banned this channel or not","title":"Banned","type":"boolean","x-stream-index":"012"},"channel_role":{"description":"Role of the member in the channel","title":"Channel Role","type":"string","x-stream-index":"018"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"invite_accepted_at":{"description":"Date when invite was accepted","format":"date-time","title":"Invited accepted at","type":"number","x-stream-index":"006"},"invite_rejected_at":{"description":"Date when invite was rejected","format":"date-time","title":"Invited rejected at","type":"number","x-stream-index":"007"},"invited":{"description":"Whether member was invited or not","title":"Invited","type":"boolean","x-stream-index":"005"},"is_moderator":{"description":"Whether member is channel moderator or not","title":"Is moderator","type":"boolean","x-stream-index":"003"},"notifications_muted":{"type":"boolean","x-stream-index":"019"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"016"},"role":{"description":"Permission level of the member in the channel (DEPRECATED: use channel_role instead)","enum":["member","moderator","admin","owner"],"title":"Role","type":"string","x-stream-index":"017"},"shadow_banned":{"description":"Whether member is shadow banned in this channel or not","title":"Shadow banned","type":"boolean","x-stream-index":"014"},"status":{"type":"string","x-stream-index":"008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"},"user_id":{"title":"User ID","type":"string","x-stream-index":"001"}},"required":["custom","created_at","updated_at","banned","shadow_banned","channel_role","notifications_muted"],"title":"Channel member","type":"object"},"ChannelMemberResponse":{"nullable":true,"properties":{"archived_at":{"format":"date-time","type":"number","x-stream-index":"016"},"ban_expires":{"description":"Expiration date of the ban","format":"date-time","title":"Ban expires","type":"number","x-stream-index":"013"},"banned":{"description":"Whether member is banned this channel or not","title":"Banned","type":"boolean","x-stream-index":"012"},"channel_role":{"description":"Role of the member in the channel","title":"Channel Role","type":"string","x-stream-index":"018"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"invite_accepted_at":{"description":"Date when invite was accepted","format":"date-time","title":"Invited accepted at","type":"number","x-stream-index":"006"},"invite_rejected_at":{"description":"Date when invite was rejected","format":"date-time","title":"Invited rejected at","type":"number","x-stream-index":"007"},"invited":{"description":"Whether member was invited or not","title":"Invited","type":"boolean","x-stream-index":"005"},"is_moderator":{"description":"Whether member is channel moderator or not","title":"Is moderator","type":"boolean","x-stream-index":"003"},"notifications_muted":{"type":"boolean","x-stream-index":"019"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"015"},"role":{"description":"Permission level of the member in the channel (DEPRECATED: use channel_role instead)","enum":["member","moderator","admin","owner"],"title":"Role","type":"string","x-stream-index":"017"},"shadow_banned":{"description":"Whether member is shadow banned in this channel or not","title":"Shadow banned","type":"boolean","x-stream-index":"014"},"status":{"type":"string","x-stream-index":"008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"},"user_id":{"title":"User ID","type":"string","x-stream-index":"001"}},"required":["custom","created_at","updated_at","banned","shadow_banned","channel_role","notifications_muted"],"title":"Channel member","type":"object"},"ChannelMute":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel that is muted","title":"Channel","x-stream-index":"002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"004"},"expires":{"description":"Date/time of mute expiration","format":"date-time","title":"Expires","type":"number","x-stream-index":"003"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Owner of channel mute","title":"User","x-stream-index":"001"}},"required":["created_at","updated_at"],"type":"object"},"ChannelOwnCapability":{"description":"All possibility of string to use","enum":["ban-channel-members","cast-poll-vote","connect-events","create-attachment","delete-any-message","delete-channel","delete-own-message","flag-message","freeze-channel","join-channel","leave-channel","mute-channel","pin-message","query-poll-votes","quote-message","read-events","search-messages","send-custom-events","send-links","send-message","send-poll","send-reaction","send-reply","send-restricted-visibility-message","send-typing-events","set-channel-cooldown","share-location","skip-slow-mode","slow-mode","typing-events","update-any-message","update-channel","update-channel-members","update-own-message","update-thread","upload-file"],"title":"ChannelOwnCapability","type":"string"},"ChannelPushPreferences":{"properties":{"chat_level":{"type":"string","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"number","x-stream-index":"002"}},"type":"object"},"ChannelResponse":{"description":"Represents channel in chat","properties":{"auto_translation_enabled":{"description":"Whether auto translation is enabled or not","title":"Auto translation","type":"boolean","x-stream-index":"017"},"auto_translation_language":{"description":"Language to translate to when auto translation is active","title":"Auto translation language","type":"string","x-stream-index":"018"},"blocked":{"description":"Whether this channel is blocked by current user or not","title":"Blocked","type":"boolean","x-stream-index":"023"},"cid":{"description":"Channel CID (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/ChannelConfigWithInfo","description":"Channel configuration","title":"ChannelConfigWithInfo","x-stream-index":"013"},"cooldown":{"description":"Cooldown period after sending each message","format":"int32","title":"Cooldown","type":"integer","x-stream-index":"020"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"005"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"Creator of the channel","title":"UserResponse","x-stream-index":"008"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"026"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"007"},"disabled":{"type":"boolean","x-stream-index":"010"},"frozen":{"description":"Whether channel is frozen or not","title":"Frozen","type":"boolean","x-stream-index":"009"},"hidden":{"description":"Whether this channel is hidden by current user or not","title":"Hidden","type":"boolean","x-stream-index":"022"},"hide_messages_before":{"description":"Date since when the message history is accessible","format":"date-time","title":"Hide messages before","type":"number","x-stream-index":"019"},"id":{"description":"Channel unique ID","title":"ID","type":"string","x-stream-index":"001"},"last_message_at":{"description":"Date of the last message sent","format":"date-time","title":"Last message at","type":"number","x-stream-index":"004"},"member_count":{"description":"Number of members in the channel","format":"int32","title":"Member count","type":"integer","x-stream-index":"012"},"members":{"description":"List of channel members (max 100)","items":{"$ref":"#/components/schemas/ChannelMember"},"title":"ChannelMembers","type":"array","x-stream-index":"011"},"mute_expires_at":{"description":"Date of mute expiration","format":"date-time","title":"Mute expires at","type":"number","x-stream-index":"015"},"muted":{"description":"Whether this channel is muted or not","title":"Muted","type":"boolean","x-stream-index":"014"},"own_capabilities":{"description":"List of channel capabilities of authenticated user","items":{"$ref":"#/components/schemas/ChannelOwnCapability"},"title":"ChannelOwnCapability","type":"array","x-stream-index":"021"},"team":{"description":"Team the channel belongs to (multi-tenant only)","title":"Team","type":"string","x-stream-index":"016"},"truncated_at":{"description":"Date of the latest truncation of the channel","format":"date-time","title":"UserResponse","type":"number","x-stream-index":"024"},"truncated_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"025"},"type":{"description":"Type of the channel","title":"Type","type":"string","x-stream-docs-page-id":"channel_features","x-stream-index":"002"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"006"}},"required":["id","type","cid","created_at","updated_at","frozen","disabled","custom"],"title":"Channel","type":"object"},"ChannelStateResponse":{"nullable":true,"properties":{"active_live_locations":{"items":{"$ref":"#/components/schemas/SharedLocationResponseData"},"type":"array","x-stream-index":"001.015"},"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001.001"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001.014"},"duration":{"type":"string","x-stream-index":"002.001"},"hidden":{"type":"boolean","x-stream-index":"001.011"},"hide_messages_before":{"format":"date-time","type":"number","x-stream-index":"001.012"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"001.007"},"membership":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"001.008"},"messages":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","x-stream-index":"001.002"},"pending_messages":{"items":{"$ref":"#/components/schemas/PendingMessageResponse"},"type":"array","x-stream-index":"001.013"},"pinned_messages":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","x-stream-index":"001.003"},"push_preferences":{"$ref":"#/components/schemas/ChannelPushPreferences","x-stream-index":"001.009"},"read":{"items":{"$ref":"#/components/schemas/ReadStateResponse"},"type":"array","x-stream-index":"001.006"},"threads":{"items":{"$ref":"#/components/schemas/ThreadStateResponse"},"type":"array","x-stream-index":"001.010"},"watcher_count":{"format":"int32","type":"integer","x-stream-index":"001.004"},"watchers":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"001.005"}},"required":["messages","pinned_messages","members","threads","duration"],"type":"object"},"ChannelStateResponseFields":{"properties":{"active_live_locations":{"description":"Active live locations in the channel","items":{"$ref":"#/components/schemas/SharedLocationResponseData"},"title":"Active Live Locations","type":"array","x-stream-index":"015"},"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"014"},"hidden":{"description":"Whether this channel is hidden or not","title":"Hidden","type":"boolean","x-stream-index":"011"},"hide_messages_before":{"description":"Messages before this date are hidden from the user","format":"date-time","title":"Hide messages before","type":"number","x-stream-index":"012"},"members":{"description":"List of channel members","items":{"$ref":"#/components/schemas/ChannelMember"},"title":"Members","type":"array","x-stream-index":"007"},"membership":{"$ref":"#/components/schemas/ChannelMember","description":"Current user membership object","title":"Membership","x-stream-index":"008"},"messages":{"description":"List of channel messages","items":{"$ref":"#/components/schemas/MessageResponse"},"title":"Message","type":"array","x-stream-index":"002"},"pending_messages":{"description":"Pending messages that this user has sent","items":{"$ref":"#/components/schemas/PendingMessageResponse"},"title":"Pending messages","type":"array","x-stream-index":"013"},"pinned_messages":{"description":"List of pinned messages in the channel","items":{"$ref":"#/components/schemas/MessageResponse"},"title":"Pinned messages","type":"array","x-stream-docs-page-id":"pinned_messages","x-stream-index":"003"},"push_preferences":{"$ref":"#/components/schemas/ChannelPushPreferences","x-stream-index":"009"},"read":{"description":"List of read states","items":{"$ref":"#/components/schemas/ReadStateResponse"},"title":"Read","type":"array","x-stream-index":"006"},"threads":{"items":{"$ref":"#/components/schemas/ThreadStateResponse"},"type":"array","x-stream-index":"010"},"watcher_count":{"description":"Number of channel watchers","format":"int32","title":"Watcher count","type":"integer","x-stream-index":"004"},"watchers":{"description":"List of user who is watching the channel","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Watchers","type":"array","x-stream-index":"005"}},"required":["messages","pinned_messages","members","threads"],"type":"object"},"ChannelStopWatchingRequest":{"nullable":true,"type":"object"},"ChannelTruncatedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001.004"},"channel_id":{"type":"string","x-stream-index":"001.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"001.005"},"channel_type":{"type":"string","x-stream-index":"001.003"},"cid":{"type":"string","x-stream-index":"001.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"type":{"default":"channel.truncated","type":"string","x-stream-index":"002.001"}},"required":["cid","channel_id","channel_type","channel_member_count","type","created_at"],"title":"ChannelTruncatedEvent","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"},"ChannelUnFrozenEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"channel.unfrozen","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"ChannelUnFrozenEvent","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"},"ChannelUpdatedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"004.004"},"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"004.005"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"002.001"},"type":{"default":"channel.updated","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"ChannelUpdatedEvent","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"},"ChannelVisibleEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"001.002"},"channel_type":{"type":"string","x-stream-index":"001.003"},"cid":{"type":"string","x-stream-index":"001.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"type":{"default":"channel.visible","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"ChannelVisibleEvent","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"},"Command":{"description":"Represents custom chat command","nullable":true,"properties":{"args":{"description":"Arguments help text, shown in commands auto-completion","title":"Arguments","type":"string","x-stream-index":"006"},"created_at":{"description":"Date/time of creation","format":"date-time","readOnly":true,"title":"Created at","type":"number","x-stream-index":"001"},"description":{"description":"Description, shown in commands auto-completion","title":"Description","type":"string","x-stream-index":"005"},"name":{"description":"Unique command name","title":"Name","type":"string","x-stream-index":"004"},"set":{"description":"Set name used for grouping commands","title":"Set","type":"string","x-stream-index":"007"},"updated_at":{"description":"Date/time of the last update","format":"date-time","readOnly":true,"title":"Updated at","type":"number","x-stream-index":"002"}},"required":["name","description","args","set"],"title":"Command","type":"object"},"CompositeAppSettings":{"properties":{"json_encoded_settings":{"type":"string","x-stream-index":"005"},"url":{"type":"string","x-stream-index":"004"}},"type":"object"},"ConfigOverrides":{"properties":{"blocklist":{"type":"string","x-stream-index":"008"},"blocklist_behavior":{"enum":["flag","block"],"type":"string","x-stream-index":"009"},"commands":{"items":{"type":"string"},"type":"array","x-stream-index":"011"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"010"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"007"},"quotes":{"type":"boolean","x-stream-index":"004"},"reactions":{"type":"boolean","x-stream-index":"002"},"replies":{"type":"boolean","x-stream-index":"003"},"shared_locations":{"type":"boolean","x-stream-index":"013"},"typing_events":{"type":"boolean","x-stream-index":"001"},"uploads":{"type":"boolean","x-stream-index":"005"},"url_enrichment":{"type":"boolean","x-stream-index":"006"},"user_message_reminders":{"type":"boolean","x-stream-index":"012"}},"required":["grants","commands"],"type":"object"},"ConfigResponse":{"properties":{"ai_image_config":{"$ref":"#/components/schemas/AIImageConfig","description":"Configuration for AI image analysis","title":"AI Image Config","x-stream-index":"009"},"ai_text_config":{"$ref":"#/components/schemas/AITextConfig","description":"Configuration for AI text analysis","title":"AI Text Config","x-stream-index":"008"},"ai_video_config":{"$ref":"#/components/schemas/AIVideoConfig","description":"Configuration for AI video analysis","title":"AI Video Config","x-stream-index":"010"},"async":{"description":"Whether moderation should be performed asynchronously","title":"Async","type":"boolean","x-stream-index":"003"},"automod_platform_circumvention_config":{"$ref":"#/components/schemas/AutomodPlatformCircumventionConfig","description":"Configuration for platform circumvention detection","title":"Automod Platform Circumvention Config","x-stream-index":"005"},"automod_semantic_filters_config":{"$ref":"#/components/schemas/AutomodSemanticFiltersConfig","description":"Configuration for semantic filtering","title":"Automod Semantic Filters Config","x-stream-index":"006"},"automod_toxicity_config":{"$ref":"#/components/schemas/AutomodToxicityConfig","description":"Configuration for toxicity detection","title":"Automod Toxicity Config","x-stream-index":"004"},"block_list_config":{"$ref":"#/components/schemas/BlockListConfig","description":"Configuration for block list filtering","title":"Block List Config","x-stream-index":"007"},"created_at":{"description":"When the configuration was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"012"},"key":{"description":"Unique identifier for the moderation configuration","title":"Key","type":"string","x-stream-index":"001"},"rule_builder_config":{"$ref":"#/components/schemas/RuleBuilderConfig","x-stream-index":"015"},"team":{"description":"Team associated with the configuration","title":"Team","type":"string","x-stream-index":"002"},"updated_at":{"description":"When the configuration was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"013"},"velocity_filter_config":{"$ref":"#/components/schemas/VelocityFilterConfig","description":"Configuration for velocity-based filtering","title":"Velocity Filter Config","x-stream-index":"011"},"video_call_rule_config":{"$ref":"#/components/schemas/VideoCallRuleConfig","x-stream-index":"014"}},"required":["key","team","async","created_at","updated_at"],"type":"object"},"ConnectUserDetailsRequest":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001"},"image":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"006"},"language":{"type":"string","x-stream-index":"005"},"name":{"type":"string","x-stream-index":"002"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"007"}},"required":["id"],"type":"object"},"ContentCountRuleParameters":{"properties":{"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"required":["threshold","time_window"],"type":"object"},"CreateBlockListRequest":{"description":"Block list contains restricted words","nullable":true,"properties":{"name":{"description":"Block list name","maxLength":255,"title":"Name","type":"string","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"004"},"type":{"description":"Block list type.","enum":["regex","domain","domain_allowlist","email","word"],"title":"Type","type":"string","x-stream-index":"003"},"words":{"description":"List of words to block","items":{"type":"string"},"minimum":1,"title":"Words","type":"array","x-stream-index":"002"}},"required":["name","words"],"title":"Block list","type":"object","x-stream-docs-page-id":"block_lists"},"CreateBlockListResponse":{"description":"Basic response information","nullable":true,"properties":{"blocklist":{"$ref":"#/components/schemas/BlockListResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["duration"],"title":"Response","type":"object"},"CreateDeviceRequest":{"description":"Create device request","nullable":true,"properties":{"id":{"description":"Device ID","maxLength":255,"minLength":1,"title":"ID","type":"string","x-stream-index":"001"},"push_provider":{"description":"Push provider","enum":["firebase","apn","huawei","xiaomi"],"title":"PushProvider","type":"string","x-stream-index":"002"},"push_provider_name":{"description":"Push provider name","title":"PushProviderName","type":"string","x-stream-index":"003"},"voip_token":{"description":"When true the token is for Apple VoIP push notifications","title":"VoipToken","type":"boolean","x-stream-index":"004"}},"required":["id","push_provider"],"title":"CreateDeviceRequest","type":"object"},"CreateDraftRequest":{"nullable":true,"properties":{"message":{"$ref":"#/components/schemas/MessageRequest","x-stream-index":"001"}},"required":["message"],"type":"object"},"CreateDraftResponse":{"description":"Basic response information","nullable":true,"properties":{"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["draft","duration"],"title":"Response","type":"object"},"CreateGuestRequest":{"nullable":true,"properties":{"user":{"$ref":"#/components/schemas/UserRequest","description":"User object which server acts upon","title":"User","x-stream-index":"001"}},"required":["user"],"type":"object"},"CreateGuestResponse":{"nullable":true,"properties":{"access_token":{"description":"the access token to authenticate the user","title":"Access token","type":"string","x-stream-index":"002"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User object which server acts upon","title":"User","x-stream-index":"001"}},"required":["user","access_token","duration"],"type":"object"},"CreatePollOptionRequest":{"nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"003"},"text":{"description":"Option text","title":"string","type":"string","x-stream-index":"002"}},"required":["text"],"type":"object"},"CreatePollRequest":{"description":"Contains all information needed to create a new poll","nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"011"},"allow_answers":{"description":"Indicates whether users can suggest user defined answers","title":"Allow answers","type":"boolean","x-stream-index":"009"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"008"},"description":{"description":"A description of the poll","title":"Description","type":"string","x-stream-index":"003"},"enforce_unique_vote":{"description":"Indicates whether users can cast multiple votes","title":"Multiple choice","type":"boolean","x-stream-index":"006"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"is_closed":{"description":"Indicates whether the poll is open for voting","title":"Is closed","type":"boolean","x-stream-index":"010"},"max_votes_allowed":{"description":"Indicates the maximum amount of votes a user can cast","format":"int32","maximum":10,"title":"Maximum votes allowed","type":"integer","x-stream-index":"007"},"name":{"description":"The name of the poll","title":"Name","type":"string","x-stream-index":"002"},"options":{"items":{"$ref":"#/components/schemas/PollOptionInput"},"maximum":100,"type":"array","x-stream-index":"004"},"voting_visibility":{"enum":["anonymous","public"],"type":"string","x-stream-index":"005"}},"required":["name"],"title":"Create Poll Request","type":"object"},"CreateReminderRequest":{"nullable":true,"properties":{"remind_at":{"format":"date-time","type":"number","x-stream-index":"001"}},"type":"object"},"CustomActionRequest":{"properties":{"id":{"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"type":"object"},"Data":{"properties":{"id":{"type":"string","x-stream-index":"001"}},"required":["id"],"type":"object"},"DeleteActivityRequest":{"properties":{"hard_delete":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"DeleteChannelResponse":{"description":"Basic response information","nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"Response","type":"object"},"DeleteChannelsRequest":{"nullable":true,"properties":{"cids":{"description":"All channels that should be deleted","items":{"type":"string"},"maximum":100,"minimum":1,"title":"Channels CID","type":"array","x-stream-index":"001"},"hard_delete":{"description":"Specify if channels and all ressources should be hard deleted","title":"Hard delete","type":"boolean","x-stream-index":"002"}},"required":["cids"],"type":"object"},"DeleteChannelsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"result":{"additionalProperties":{"$ref":"#/components/schemas/DeleteChannelsResultResponse"},"description":"Map of channel IDs and their deletion results","title":"Result","type":"object","x-stream-index":"001"},"task_id":{"type":"string","x-stream-index":"002"}},"required":["duration"],"type":"object"},"DeleteChannelsResultResponse":{"nullable":true,"properties":{"error":{"type":"string","x-stream-index":"002"},"status":{"type":"string","x-stream-index":"001"}},"required":["status"],"type":"object"},"DeleteMessageRequest":{"properties":{"hard_delete":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"DeleteMessageResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001"}},"required":["message","duration"],"title":"Response","type":"object"},"DeleteModerationConfigResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"DeleteReactionRequest":{"properties":{"hard_delete":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"DeleteReactionResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001"},"reaction":{"$ref":"#/components/schemas/ReactionResponse","x-stream-index":"002"}},"required":["message","reaction","duration"],"title":"Response","type":"object"},"DeleteReminderResponse":{"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"},"DeleteUserRequest":{"properties":{"delete_conversation_channels":{"type":"boolean","x-stream-index":"003"},"delete_feeds_content":{"type":"boolean","x-stream-index":"004"},"hard_delete":{"type":"boolean","x-stream-index":"001"},"mark_messages_deleted":{"type":"boolean","x-stream-index":"002"}},"type":"object"},"Device":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"disabled":{"type":"boolean","x-stream-index":"002.003"},"disabled_reason":{"type":"string","x-stream-index":"002.004"},"id":{"type":"string","x-stream-index":"002.001.004"},"push_provider":{"enum":["firebase","apn","huawei","xiaomi"],"type":"string","x-stream-index":"002.001.001"},"push_provider_name":{"type":"string","x-stream-index":"002.001.003"},"user_id":{"type":"string","x-stream-index":"004"},"voip":{"type":"boolean","x-stream-index":"002.001.005"}},"required":["push_provider","id","created_at","user_id"],"type":"object"},"DeviceResponse":{"description":"Response for Device","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"004"},"disabled":{"description":"Whether device is disabled or not","title":"Disabled","type":"boolean","x-stream-index":"005"},"disabled_reason":{"description":"Reason explaining why device had been disabled","title":"Reason","type":"string","x-stream-index":"006"},"id":{"description":"Device ID","title":"ID","type":"string","x-stream-index":"003"},"push_provider":{"description":"Push provider","title":"PushProvider","type":"string","x-stream-index":"001"},"push_provider_name":{"description":"Push provider name","title":"PushProviderName","type":"string","x-stream-index":"002"},"user_id":{"description":"User ID","title":"UserID","type":"string","x-stream-index":"008"},"voip":{"description":"When true the token is for Apple VoIP push notifications","title":"Voip","type":"boolean","x-stream-index":"007"}},"required":["push_provider","id","created_at","user_id"],"title":"DeviceResponse","type":"object"},"DraftDeletedEvent":{"description":"Emitted when a Draft is deleted.","nullable":true,"properties":{"cid":{"description":"The CID of the channel where the draft was created","title":"Channel CID","type":"string","x-stream-index":"001.001.002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.001.007"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001.003"},"parent_id":{"description":"The ID of the parent message","title":"Message ID","type":"string","x-stream-index":"001.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.001.004"},"type":{"default":"draft.deleted","description":"The type of event: \"draft.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.001.002"}},"required":["type","created_at","custom"],"title":"DraftDeletedEvent","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"},"DraftPayloadResponse":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"html":{"type":"string","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"001"},"mentioned_users":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"008"},"mml":{"type":"string","x-stream-index":"003"},"parent_id":{"type":"string","x-stream-index":"005"},"poll_id":{"type":"string","x-stream-index":"013"},"quoted_message_id":{"type":"string","x-stream-index":"009"},"show_in_channel":{"type":"boolean","x-stream-index":"006"},"silent":{"type":"boolean","x-stream-index":"012"},"text":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"011"}},"required":["id","text","custom"],"type":"object"},"DraftResponse":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003"},"channel_cid":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"message":{"$ref":"#/components/schemas/DraftPayloadResponse","x-stream-index":"001"},"parent_id":{"type":"string","x-stream-index":"004"},"parent_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"005"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"006"}},"required":["message","channel_cid","created_at"],"type":"object"},"DraftUpdatedEvent":{"description":"Emitted when a Draft is created or updated.","nullable":true,"properties":{"cid":{"description":"The CID of the channel where the draft was created/updated","title":"Channel CID","type":"string","x-stream-index":"001.001.002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.001.007"},"draft":{"$ref":"#/components/schemas/DraftResponse","description":"The draft object which was created/updated","title":"Draft","x-stream-index":"001.003"},"parent_id":{"description":"The ID of the parent message","title":"Parent ID","type":"string","x-stream-index":"001.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.001.004"},"type":{"default":"draft.updated","description":"The type of event: \"draft.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.001.002"}},"required":["type","created_at","custom"],"title":"DraftUpdatedEvent","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"},"EgressHLSResponse":{"properties":{"playlist_url":{"type":"string","x-stream-index":"001"},"status":{"type":"string","x-stream-index":"002"}},"required":["playlist_url","status"],"type":"object"},"EgressRTMPResponse":{"properties":{"name":{"type":"string","x-stream-index":"001"},"started_at":{"format":"date-time","type":"number","x-stream-index":"004"},"stream_key":{"type":"string","x-stream-index":"003"},"stream_url":{"type":"string","x-stream-index":"002"}},"required":["name","started_at"],"type":"object"},"EgressResponse":{"properties":{"broadcasting":{"type":"boolean","x-stream-index":"001"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordingResponse","x-stream-index":"004"},"hls":{"$ref":"#/components/schemas/EgressHLSResponse","x-stream-index":"002"},"rtmps":{"items":{"$ref":"#/components/schemas/EgressRTMPResponse"},"type":"array","x-stream-index":"003"}},"required":["broadcasting","rtmps"],"type":"object"},"EgressTaskConfig":{"properties":{"egress_user":{"$ref":"#/components/schemas/EgressUser","x-stream-index":"008"},"frame_recording_egress_config":{"$ref":"#/components/schemas/FrameRecordingEgressConfig","x-stream-index":"009"},"hls_egress_config":{"$ref":"#/components/schemas/HLSEgressConfig","x-stream-index":"007"},"recording_egress_config":{"$ref":"#/components/schemas/RecordingEgressConfig","x-stream-index":"006"},"rtmp_egress_config":{"$ref":"#/components/schemas/RTMPEgressConfig","x-stream-index":"004"},"stt_egress_config":{"$ref":"#/components/schemas/STTEgressConfig","x-stream-index":"005"}},"type":"object"},"EgressUser":{"properties":{"token":{"type":"string","x-stream-index":"004"}},"type":"object"},"EnrichedActivity":{"properties":{"actor":{"$ref":"#/components/schemas/Data","x-stream-index":"002"},"foreign_id":{"type":"string","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"latest_reactions":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"013"},"object":{"$ref":"#/components/schemas/Data","x-stream-index":"004"},"origin":{"$ref":"#/components/schemas/Data","x-stream-index":"008"},"own_reactions":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"012"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"011"},"score":{"format":"float","type":"number","x-stream-index":"010"},"target":{"$ref":"#/components/schemas/Data","x-stream-index":"006"},"to":{"items":{"type":"string"},"type":"array","x-stream-index":"009"},"verb":{"type":"string","x-stream-index":"003"}},"type":"object"},"EnrichedReaction":{"nullable":true,"properties":{"activity_id":{"type":"string","x-stream-index":"003"},"children_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"010"},"created_at":{"$ref":"#/components/schemas/Time","x-stream-index":"012"},"data":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"kind":{"type":"string","x-stream-index":"002"},"latest_children":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"008"},"own_children":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"009"},"parent":{"type":"string","x-stream-index":"007"},"target_feeds":{"items":{"type":"string"},"type":"array","x-stream-index":"006"},"updated_at":{"$ref":"#/components/schemas/Time","x-stream-index":"013"},"user":{"$ref":"#/components/schemas/Data","x-stream-index":"011"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["kind","activity_id","user_id"],"type":"object"},"EntityCreator":{"properties":{"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"001.046"},"ban_count":{"format":"int32","type":"integer","x-stream-index":"002"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"001.017"},"banned":{"type":"boolean","x-stream-index":"001.016"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.013"},"deleted_content_count":{"format":"int32","type":"integer","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"001.023"},"language":{"type":"string","x-stream-index":"001.035"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"001.022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"001.026"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.042"},"role":{"type":"string","x-stream-index":"001.004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.005"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.009"}},"required":["id","role","teams_role","custom","banned","online","ban_count","deleted_content_count"],"type":"object"},"EntityCreatorResponse":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.001.018"},"ban_count":{"description":"Number of minor actions performed on the user","format":"int32","title":"Ban Count","type":"integer","x-stream-index":"002"},"banned":{"type":"boolean","x-stream-index":"001.001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.001.017"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.001.016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.001.011"},"deleted_content_count":{"description":"Number of major actions performed on the user","format":"int32","title":"Deleted Content Count","type":"integer","x-stream-index":"003"},"flagged_count":{"description":"Number of flag actions performed on the user","format":"int32","title":"Flagged Count","type":"integer","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001.001.001"},"image":{"type":"string","x-stream-index":"001.001.003"},"language":{"type":"string","x-stream-index":"001.001.005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"001.001.014"},"name":{"type":"string","x-stream-index":"001.001.002"},"online":{"type":"boolean","x-stream-index":"001.001.013"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.001.015"},"role":{"type":"string","x-stream-index":"001.001.006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.001.008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids","shadow_banned","invisible","ban_count","deleted_content_count","flagged_count"],"type":"object"},"EventNotificationSettings":{"properties":{"apns":{"$ref":"#/components/schemas/APNS","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"fcm":{"$ref":"#/components/schemas/FCM","x-stream-index":"003"}},"required":["enabled","apns","fcm"],"type":"object"},"EventRequest":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"parent_id":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"001"}},"required":["type"],"type":"object"},"EventResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"event":{"$ref":"#/components/schemas/WSEvent","x-stream-index":"001"}},"required":["event","duration"],"title":"Response","type":"object"},"ExternalStorage":{"properties":{"abs_account_name":{"type":"string","x-stream-index":"011"},"abs_client_id":{"type":"string","x-stream-index":"013"},"abs_client_secret":{"type":"string","x-stream-index":"014"},"abs_tenant_id":{"type":"string","x-stream-index":"012"},"bucket":{"type":"string","x-stream-index":"005"},"gcs_credentials":{"type":"string","x-stream-index":"010"},"path":{"type":"string","x-stream-index":"006"},"s3_api_key":{"type":"string","x-stream-index":"007"},"s3_custom_endpoint":{"type":"string","x-stream-index":"016"},"s3_region":{"type":"string","x-stream-index":"009"},"s3_secret_key":{"type":"string","x-stream-index":"008"},"storage_name":{"type":"string","x-stream-index":"015"},"storage_type":{"type":"integer","x-stream-index":"004"}},"type":"object"},"FCM":{"properties":{"data":{"additionalProperties":{},"type":"object","x-stream-index":"001"}},"type":"object"},"Field":{"nullable":true,"properties":{"short":{"type":"boolean","x-stream-index":"003"},"title":{"type":"string","x-stream-index":"001"},"value":{"type":"string","x-stream-index":"002"}},"required":["title","value","short"],"type":"object"},"FileUploadConfig":{"properties":{"allowed_file_extensions":{"items":{"type":"string"},"type":"array","x-stream-index":"001"},"allowed_mime_types":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"blocked_file_extensions":{"items":{"type":"string"},"type":"array","x-stream-index":"002"},"blocked_mime_types":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"size_limit":{"format":"int32","maximum":104857600,"minimum":0,"type":"integer","x-stream-index":"005"}},"required":["allowed_file_extensions","blocked_file_extensions","allowed_mime_types","blocked_mime_types","size_limit"],"type":"object"},"FileUploadRequest":{"nullable":true,"properties":{"file":{"description":"file field","title":"File","type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/OnlyUserID","description":"user for the request **server side only**","title":"User","x-stream-index":"002"}},"type":"object"},"FileUploadResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"file":{"description":"URL to the uploaded asset. Should be used to put to `asset_url` attachment field","title":"File","type":"string","x-stream-index":"001"},"thumb_url":{"description":"URL of the file thumbnail for supported file formats. Should be put to `thumb_url` attachment field","title":"Thumbnail URL","type":"string","x-stream-index":"002"}},"required":["duration"],"type":"object"},"Flag":{"description":"Contains information about flagged user or message","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"019"},"custom":{"additionalProperties":{},"description":"Additional metadata about the flag","title":"Custom","type":"object","x-stream-index":"014"},"entity_creator_id":{"description":"ID of the user who created the flagged entity","title":"Entity Creator ID","type":"string","x-stream-index":"009"},"entity_id":{"description":"Unique identifier of the entity being flagged","title":"Entity ID","type":"string","x-stream-index":"008"},"entity_type":{"description":"Type of entity being flagged (e.g., message, user)","title":"Entity Type","type":"string","x-stream-index":"007"},"is_streamed_content":{"type":"boolean","x-stream-index":"012"},"labels":{"description":"Labels from bodyguard, API calls, our own AI etc","items":{"type":"string"},"title":"Labels","type":"array","x-stream-index":"015"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content being flagged","title":"Moderation Payload","x-stream-index":"010"},"moderation_payload_hash":{"type":"string","x-stream-index":"011"},"reason":{"description":"Optional explanation for why the content is being flagged","title":"Reason","type":"string","x-stream-index":"013"},"result":{"description":"Result of bodyguard, API calls, our own AI etc","items":{"additionalProperties":{},"type":"object"},"title":"Result","type":"array","x-stream-index":"016"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"018"},"review_queue_item_id":{"description":"ID of the review queue item","title":"Review Queue Item ID","type":"string","x-stream-index":"017"},"type":{"type":"string","x-stream-index":"004"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"020"},"user":{"$ref":"#/components/schemas/User","description":"User who flagged a message or a user","title":"User","x-stream-index":"006"}},"required":["entity_type","entity_id","result","created_at","updated_at"],"title":"Flag","type":"object"},"FlagContentOptions":{"properties":{"reason":{"type":"string","x-stream-index":"001"}},"required":["reason"],"type":"object"},"FlagDetails":{"properties":{"Extra":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"002"},"automod":{"$ref":"#/components/schemas/AutomodDetails","x-stream-index":"001"},"original_text":{"type":"string","x-stream-index":"003"}},"required":["Extra","original_text"],"type":"object"},"FlagFeedback":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"005"},"labels":{"items":{"$ref":"#/components/schemas/Label"},"type":"array","x-stream-index":"006"},"message_id":{"type":"string","x-stream-index":"004"}},"required":["message_id","created_at","labels"],"type":"object"},"FlagMessageDetails":{"properties":{"pin_changed":{"type":"boolean","x-stream-index":"002"},"should_enrich":{"type":"boolean","x-stream-index":"003"},"skip_push":{"type":"boolean","x-stream-index":"004"},"updated_by_id":{"type":"string","x-stream-index":"001"}},"type":"object"},"FlagRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"description":"Additional metadata about the flag","title":"Custom","type":"object","x-stream-index":"006"},"entity_creator_id":{"description":"ID of the user who created the flagged entity","title":"Entity Creator ID","type":"string","x-stream-index":"003"},"entity_id":{"description":"Unique identifier of the entity being flagged","title":"Entity ID","type":"string","x-stream-index":"002"},"entity_type":{"description":"Type of entity being flagged (e.g., message, user)","title":"Entity Type","type":"string","x-stream-index":"001"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content being flagged","title":"Moderation Payload","x-stream-index":"005"},"reason":{"description":"Optional explanation for why the content is being flagged","maxLength":255,"title":"Reason","type":"string","x-stream-index":"004"}},"required":["entity_type","entity_id"],"type":"object"},"FlagResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"item_id":{"description":"Unique identifier of the created moderation item","title":"Item ID","type":"string","x-stream-index":"001"}},"required":["item_id","duration"],"type":"object"},"FlagUserOptions":{"properties":{"reason":{"type":"string","x-stream-index":"001"}},"required":["reason"],"type":"object"},"FrameRecordSettings":{"properties":{"capture_interval_in_seconds":{"format":"int32","maximum":60,"minimum":2,"type":"integer","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"},"quality":{"type":"string","x-stream-index":"002"}},"required":["mode","capture_interval_in_seconds"],"type":"object"},"FrameRecordingEgressConfig":{"properties":{"capture_interval_in_seconds":{"format":"int32","type":"integer","x-stream-index":"007"},"external_storage":{"$ref":"#/components/schemas/ExternalStorage","x-stream-index":"006"},"quality":{"$ref":"#/components/schemas/Quality","x-stream-index":"004"},"storage_name":{"type":"string","x-stream-index":"005"}},"type":"object"},"FrameRecordingResponse":{"properties":{"status":{"type":"string","x-stream-index":"001"}},"required":["status"],"type":"object"},"FrameRecordingSettingsResponse":{"properties":{"capture_interval_in_seconds":{"format":"int32","maximum":60,"minimum":2,"type":"integer","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"},"quality":{"type":"string","x-stream-index":"002"}},"required":["mode","capture_interval_in_seconds"],"type":"object"},"FullUserResponse":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"015"},"banned":{"type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"014"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.011"},"devices":{"items":{"$ref":"#/components/schemas/DeviceResponse"},"type":"array","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001.001"},"image":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"005"},"language":{"type":"string","x-stream-index":"001.005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"001.014"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"012"},"mutes":{"items":{"$ref":"#/components/schemas/UserMuteResponse"},"type":"array","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"001.002"},"online":{"type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"003"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.015"},"role":{"type":"string","x-stream-index":"001.006"},"shadow_banned":{"type":"boolean","x-stream-index":"013"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"009"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"010"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"008"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"011"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","devices","invisible","mutes","channel_mutes","unread_count","total_unread_count","unread_channels","unread_threads","shadow_banned","blocked_user_ids"],"type":"object"},"GeofenceSettings":{"properties":{"names":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"required":["names"],"type":"object"},"GeofenceSettingsResponse":{"properties":{"names":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"required":["names"],"type":"object"},"GetApplicationResponse":{"description":"Basic response information","nullable":true,"properties":{"app":{"$ref":"#/components/schemas/AppResponseFields","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["app","duration"],"title":"Response","type":"object"},"GetBlockedUsersResponse":{"nullable":true,"properties":{"blocks":{"description":"Array of blocked user object","items":{"$ref":"#/components/schemas/BlockedUserResponse"},"title":"Blocks","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["blocks","duration"],"type":"object"},"GetConfigResponse":{"nullable":true,"properties":{"config":{"$ref":"#/components/schemas/ConfigResponse","description":"The retrieved moderation configuration","title":"Config","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["duration"],"type":"object"},"GetDraftResponse":{"description":"Basic response information","nullable":true,"properties":{"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["draft","duration"],"title":"Response","type":"object"},"GetManyMessagesResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.002.001"},"messages":{"description":"List of messages","items":{"$ref":"#/components/schemas/MessageResponse"},"title":"Messages","type":"array","x-stream-index":"001.001"}},"required":["messages","duration"],"type":"object"},"GetMessageResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageWithChannelResponse","x-stream-index":"001"},"pending_message_metadata":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"002"}},"required":["message","duration"],"title":"Response","type":"object"},"GetOGResponse":{"nullable":true,"properties":{"actions":{"items":{"$ref":"#/components/schemas/Action"},"type":"array","x-stream-index":"001.015"},"asset_url":{"description":"URL of detected video or audio","title":"Image URL","type":"string","x-stream-index":"001.017"},"author_icon":{"type":"string","x-stream-index":"001.007"},"author_link":{"description":"og:site","title":"Author Link","type":"string","x-stream-index":"001.006"},"author_name":{"description":"og:site_name","title":"Author Name","type":"string","x-stream-index":"001.005"},"color":{"type":"string","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.018"},"duration":{"type":"string","x-stream-index":"002.001"},"fallback":{"type":"string","x-stream-index":"001.002"},"fields":{"items":{"$ref":"#/components/schemas/Field"},"type":"array","x-stream-index":"001.016"},"footer":{"type":"string","x-stream-index":"001.013"},"footer_icon":{"type":"string","x-stream-index":"001.014"},"giphy":{"$ref":"#/components/schemas/Images","x-stream-index":"001.019"},"image_url":{"description":"URL of detected image","title":"Image URL","type":"string","x-stream-index":"001.011"},"og_scrape_url":{"description":"extracted url from the text","title":"OG Scrape URL","type":"string","x-stream-index":"001.020"},"original_height":{"format":"int32","type":"integer","x-stream-index":"001.022"},"original_width":{"format":"int32","type":"integer","x-stream-index":"001.021"},"pretext":{"type":"string","x-stream-index":"001.004"},"text":{"description":"og:description","title":"Text","type":"string","x-stream-index":"001.010"},"thumb_url":{"description":"URL of detected thumb image","title":"Image URL","type":"string","x-stream-index":"001.012"},"title":{"description":"og:title","title":"Title","type":"string","x-stream-index":"001.008"},"title_link":{"description":"og:url","title":"Title Link","type":"string","x-stream-index":"001.009"},"type":{"description":"Attachment type, could be empty, image, audio or video","title":"Type","type":"string","x-stream-index":"001.001"}},"required":["custom","duration"],"title":"Get OG Attachment","type":"object","x-stream-docs-page-id":"og"},"GetReactionsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"reactions":{"description":"List of reactions","items":{"$ref":"#/components/schemas/Reaction"},"title":"Reactions","type":"array","x-stream-index":"001"}},"required":["reactions","duration"],"type":"object"},"GetRepliesResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"messages":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","x-stream-index":"001"}},"required":["messages","duration"],"title":"Response","type":"object"},"GetThreadResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"thread":{"$ref":"#/components/schemas/ThreadStateResponse","description":"Enriched thread state","title":"Thread","x-stream-index":"001"}},"required":["thread","duration"],"type":"object"},"GoogleVisionConfig":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"HLSEgressConfig":{"properties":{"composite_app_settings":{"$ref":"#/components/schemas/CompositeAppSettings","x-stream-index":"005"},"playlist_url":{"type":"string","x-stream-index":"007"},"qualities":{"items":{"$ref":"#/components/schemas/Quality"},"type":"array","x-stream-index":"004"},"start_unix_nano":{"format":"int64","type":"integer","x-stream-index":"006"}},"type":"object"},"HLSSettings":{"properties":{"auto_on":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"004"},"quality_tracks":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"required":["auto_on","enabled","quality_tracks"],"type":"object"},"HLSSettingsResponse":{"description":"HLSSettings is the payload for HLS settings","properties":{"auto_on":{"title":"Auto On","type":"boolean","x-stream-index":"001"},"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"002"},"quality_tracks":{"items":{"type":"string"},"title":"Quality Tracks","type":"array","x-stream-index":"003"}},"required":["auto_on","enabled","quality_tracks","layout"],"title":"HLSSettingsResponse","type":"object"},"HarmConfig":{"properties":{"action_sequences":{"items":{"$ref":"#/components/schemas/ActionSequence"},"type":"array","x-stream-index":"001"},"severity":{"type":"integer","x-stream-index":"002"}},"required":["action_sequences","severity"],"type":"object"},"HealthCheckEvent":{"nullable":true,"properties":{"cid":{"type":"string","x-stream-index":"003"},"connection_id":{"type":"string","x-stream-index":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004.007"},"me":{"$ref":"#/components/schemas/OwnUserResponse","x-stream-index":"002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"004.004"},"type":{"default":"health.check","type":"string","x-stream-index":"004.002"}},"required":["connection_id","type","created_at","custom"],"title":"HealthCheckEvent","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"},"HideChannelRequest":{"nullable":true,"properties":{"clear_history":{"description":"Whether to clear message history of the channel or not","title":"Clear history","type":"boolean","x-stream-index":"001"}},"type":"object"},"HideChannelResponse":{"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"},"ImageContentParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"type":"object"},"ImageData":{"properties":{"frames":{"type":"string","x-stream-index":"005"},"height":{"type":"string","x-stream-index":"003"},"size":{"type":"string","x-stream-index":"004"},"url":{"type":"string","x-stream-index":"001"},"width":{"type":"string","x-stream-index":"002"}},"required":["url","width","height","size","frames"],"type":"object"},"ImageRuleParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"required":["threshold","time_window"],"type":"object"},"ImageSize":{"properties":{"crop":{"description":"Crop mode","enum":["top","bottom","left","right","center"],"title":"Crop","type":"string","x-stream-index":"001"},"height":{"description":"Target image height","format":"int32","title":"Height","type":"integer","x-stream-index":"003"},"resize":{"description":"Resize method","enum":["clip","crop","scale","fill"],"title":"Resize","type":"string","x-stream-index":"002"},"width":{"description":"Target image width","format":"int32","title":"Width","type":"integer","x-stream-index":"004"}},"title":"Image size configuration","type":"object"},"ImageUploadRequest":{"nullable":true,"properties":{"file":{"type":"string","x-stream-index":"001.001"},"upload_sizes":{"description":"field with JSON-encoded array of image size configurations","items":{"$ref":"#/components/schemas/ImageSize"},"title":"Upload sizes","type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/OnlyUserID","x-stream-index":"001.002"}},"type":"object"},"ImageUploadResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.003.001"},"file":{"type":"string","x-stream-index":"001.001"},"thumb_url":{"type":"string","x-stream-index":"001.002"},"upload_sizes":{"description":"Array of image size configurations","items":{"$ref":"#/components/schemas/ImageSize"},"title":"Upload sizes","type":"array","x-stream-index":"002"}},"required":["duration"],"type":"object"},"Images":{"properties":{"fixed_height":{"$ref":"#/components/schemas/ImageData","x-stream-index":"002"},"fixed_height_downsampled":{"$ref":"#/components/schemas/ImageData","x-stream-index":"004"},"fixed_height_still":{"$ref":"#/components/schemas/ImageData","x-stream-index":"003"},"fixed_width":{"$ref":"#/components/schemas/ImageData","x-stream-index":"005"},"fixed_width_downsampled":{"$ref":"#/components/schemas/ImageData","x-stream-index":"007"},"fixed_width_still":{"$ref":"#/components/schemas/ImageData","x-stream-index":"006"},"original":{"$ref":"#/components/schemas/ImageData","x-stream-index":"001"}},"required":["original","fixed_height","fixed_height_still","fixed_height_downsampled","fixed_width","fixed_width_still","fixed_width_downsampled"],"type":"object"},"IngressAudioEncodingOptions":{"properties":{"bitrate":{"maximum":128000,"minimum":16000,"type":"integer","x-stream-index":"003"},"channels":{"enum":["1","2"],"format":"int32","type":"integer","x-stream-index":"001"},"enable_dtx":{"type":"boolean","x-stream-index":"002"}},"required":["channels","enable_dtx","bitrate"],"type":"object"},"IngressAudioEncodingResponse":{"properties":{"bitrate":{"format":"int32","type":"integer","x-stream-index":"003"},"channels":{"format":"int32","type":"integer","x-stream-index":"001"},"enable_dtx":{"type":"boolean","x-stream-index":"002"}},"required":["channels","enable_dtx","bitrate"],"type":"object"},"IngressSettings":{"properties":{"audio_encoding_options":{"$ref":"#/components/schemas/IngressAudioEncodingOptions","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"video_encoding_options":{"additionalProperties":{"$ref":"#/components/schemas/IngressVideoEncodingOptions"},"type":"object","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"IngressSettingsResponse":{"properties":{"audio_encoding_options":{"$ref":"#/components/schemas/IngressAudioEncodingResponse","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"video_encoding_options":{"additionalProperties":{"$ref":"#/components/schemas/IngressVideoEncodingResponse"},"type":"object","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"IngressVideoEncodingOptions":{"properties":{"layers":{"items":{"$ref":"#/components/schemas/IngressVideoLayer"},"minimum":1,"type":"array","x-stream-index":"001"}},"required":["layers"],"type":"object"},"IngressVideoEncodingResponse":{"properties":{"layers":{"items":{"$ref":"#/components/schemas/IngressVideoLayerResponse"},"type":"array","x-stream-index":"001"}},"required":["layers"],"type":"object"},"IngressVideoLayer":{"nullable":true,"properties":{"bitrate":{"minimum":1000,"type":"integer","x-stream-index":"002"},"codec":{"enum":["h264","vp8"],"type":"string","x-stream-index":"001"},"frame_rate":{"maximum":60,"minimum":1,"type":"integer","x-stream-index":"003"},"max_dimension":{"minimum":240,"type":"integer","x-stream-index":"005"},"min_dimension":{"minimum":240,"type":"integer","x-stream-index":"004"}},"required":["codec","bitrate","frame_rate","min_dimension","max_dimension"],"type":"object"},"IngressVideoLayerResponse":{"nullable":true,"properties":{"bitrate":{"type":"integer","x-stream-index":"002"},"codec":{"type":"string","x-stream-index":"001"},"frame_rate_limit":{"type":"integer","x-stream-index":"005"},"max_dimension":{"type":"integer","x-stream-index":"004"},"min_dimension":{"type":"integer","x-stream-index":"003"}},"required":["codec","bitrate","min_dimension","max_dimension","frame_rate_limit"],"type":"object"},"Label":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"phrase_list_ids":{"items":{"format":"int32","type":"integer"},"type":"array","x-stream-index":"002"}},"required":["name"],"type":"object"},"LabelThresholds":{"properties":{"block":{"description":"Threshold for automatic message block","format":"float","maximum":1,"minimum":0,"title":"Block","type":"number","x-stream-index":"002"},"flag":{"description":"Threshold for automatic message flag","format":"float","maximum":1,"minimum":0,"title":"Flag","type":"number","x-stream-index":"001"}},"type":"object"},"LayoutSettings":{"properties":{"detect_orientation":{"type":"boolean","x-stream-index":"005"},"external_app_url":{"type":"string","x-stream-index":"003"},"external_css_url":{"type":"string","x-stream-index":"004"},"name":{"enum":["spotlight","grid","single-participant","mobile","custom"],"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"required":["name","external_app_url","external_css_url"],"type":"object"},"LimitsSettings":{"properties":{"max_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"004"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"},"max_participants_exclude_owner":{"type":"boolean","x-stream-index":"003"},"max_participants_exclude_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"002"}},"required":["max_participants_exclude_roles"],"type":"object"},"LimitsSettingsResponse":{"properties":{"max_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"004"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"},"max_participants_exclude_owner":{"type":"boolean","x-stream-index":"003"},"max_participants_exclude_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"002"}},"required":["max_participants_exclude_roles"],"type":"object"},"ListBlockListResponse":{"description":"Basic response information","nullable":true,"properties":{"blocklists":{"items":{"$ref":"#/components/schemas/BlockListResponse"},"type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["blocklists","duration"],"title":"Response","type":"object"},"ListDevicesResponse":{"description":"List devices response","nullable":true,"properties":{"devices":{"description":"List of devices","items":{"$ref":"#/components/schemas/DeviceResponse"},"title":"Devices","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["devices","duration"],"title":"ListDevicesResponse","type":"object"},"MarkChannelsReadRequest":{"nullable":true,"properties":{"read_by_channel":{"additionalProperties":{"type":"string"},"description":"Map of channel ID to last read message ID","maximum":30,"title":"Read by channel","type":"object","x-stream-index":"001"}},"type":"object"},"MarkReadRequest":{"nullable":true,"properties":{"message_id":{"description":"ID of the message that is considered last read by client","title":"Message ID","type":"string","x-stream-index":"001"},"thread_id":{"description":"Optional Thread ID to specifically mark a given thread as read","title":"Thread ID","type":"string","x-stream-index":"002"}},"type":"object"},"MarkReadResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"event":{"$ref":"#/components/schemas/MessageReadEvent","description":"Mark read event","title":"Event","x-stream-index":"001"}},"required":["duration"],"type":"object"},"MarkReviewedRequest":{"properties":{"content_to_mark_as_reviewed_limit":{"format":"int32","maximum":2500,"type":"integer","x-stream-index":"002"},"disable_marking_content_as_reviewed":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"MarkUnreadRequest":{"nullable":true,"properties":{"message_id":{"description":"ID of the message from where the channel is marked unread","title":"Message ID","type":"string","x-stream-index":"001"},"thread_id":{"description":"Mark a thread unread, specify both the thread and message id","title":"Thread ID","type":"string","x-stream-index":"003"}},"type":"object"},"MemberAddedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"002.001"},"type":{"default":"member.added","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MemberAddedEvent","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"},"MemberLookup":{"properties":{"Limit":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"001"}},"required":["Limit"],"type":"object"},"MemberRemovedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"001.001"},"type":{"default":"member.removed","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MemberRemovedEvent","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"},"MemberUpdatedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"005.002"},"channel_type":{"type":"string","x-stream-index":"005.003"},"cid":{"type":"string","x-stream-index":"005.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"002.001"},"type":{"default":"member.updated","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MemberUpdatedEvent","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"},"MembersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"members":{"description":"List of found members","items":{"$ref":"#/components/schemas/ChannelMember"},"title":"Members","type":"array","x-stream-index":"001"}},"required":["members","duration"],"type":"object"},"Message":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"012"},"before_message_send_failed":{"type":"boolean","x-stream-index":"046"},"cid":{"type":"string","x-stream-index":"028"},"command":{"type":"string","x-stream-index":"006"},"created_at":{"format":"date-time","type":"number","x-stream-index":"030"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"034"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"033"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"023"},"html":{"type":"string","x-stream-index":"007"},"i18n":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"044"},"id":{"type":"string","x-stream-index":"002"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"040"},"latest_reactions":{"items":{"$ref":"#/components/schemas/Reaction"},"type":"array","x-stream-index":"013"},"mentioned_users":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"043"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"052"},"mml":{"type":"string","x-stream-index":"005"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"056"},"own_reactions":{"items":{"$ref":"#/components/schemas/Reaction"},"type":"array","x-stream-index":"014"},"parent_id":{"type":"string","x-stream-index":"019"},"pin_expires":{"format":"date-time","type":"number","x-stream-index":"051"},"pinned":{"type":"boolean","x-stream-index":"047"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"048"},"pinned_by":{"$ref":"#/components/schemas/User","x-stream-index":"050"},"poll":{"$ref":"#/components/schemas/Poll","x-stream-index":"054"},"poll_id":{"type":"string","x-stream-index":"053"},"quoted_message":{"$ref":"#/components/schemas/Message","x-stream-index":"025"},"quoted_message_id":{"type":"string","x-stream-index":"024"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"015"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"017"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"016"},"reminder":{"$ref":"#/components/schemas/MessageReminder","x-stream-index":"058"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"022"},"restricted_visibility":{"items":{"type":"string"},"type":"array","x-stream-index":"011"},"shadowed":{"type":"boolean","x-stream-index":"036"},"shared_location":{"$ref":"#/components/schemas/SharedLocation","x-stream-index":"055"},"show_in_channel":{"type":"boolean","x-stream-index":"021"},"silent":{"type":"boolean","x-stream-index":"045"},"text":{"type":"string","x-stream-index":"004"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"027"},"type":{"type":"string","x-stream-index":"008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"031"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"010"}},"required":["id","text","html","type","restricted_visibility","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reaction_groups","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned"],"type":"object"},"MessageActionRequest":{"nullable":true,"properties":{"form_data":{"additionalProperties":{"type":"string"},"description":"ReadOnlyData to execute command with","title":"Form data","type":"object","x-stream-index":"002"}},"required":["form_data"],"type":"object"},"MessageChangeSet":{"properties":{"attachments":{"type":"boolean","x-stream-index":"005"},"custom":{"type":"boolean","x-stream-index":"001"},"html":{"type":"boolean","x-stream-index":"004"},"mentioned_user_ids":{"type":"boolean","x-stream-index":"006"},"mml":{"type":"boolean","x-stream-index":"003"},"pin":{"type":"boolean","x-stream-index":"009"},"quoted_message_id":{"type":"boolean","x-stream-index":"007"},"silent":{"type":"boolean","x-stream-index":"008"},"text":{"type":"boolean","x-stream-index":"002"}},"required":["custom","text","mml","html","attachments","mentioned_user_ids","quoted_message_id","silent","pin"],"type":"object"},"MessageDeletedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"006.002"},"hard_delete":{"type":"boolean","x-stream-index":"002.001"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"005.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"message.deleted","type":"string","x-stream-index":"006.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["hard_delete","cid","channel_id","channel_type","type","created_at"],"title":"MessageDeletedEvent","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":{"approved_at":{"format":"date-time","type":"number","x-stream-index":"013"},"created_at":{"format":"date-time","type":"number","x-stream-index":"009"},"created_by_automod":{"type":"boolean","x-stream-index":"001"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"008"},"details":{"$ref":"#/components/schemas/FlagDetails","x-stream-index":"006"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"005"},"moderation_feedback":{"$ref":"#/components/schemas/FlagFeedback","x-stream-index":"003"},"moderation_result":{"$ref":"#/components/schemas/MessageModerationResult","x-stream-index":"002"},"reason":{"type":"string","x-stream-index":"007"},"rejected_at":{"format":"date-time","type":"number","x-stream-index":"014"},"reviewed_at":{"format":"date-time","type":"number","x-stream-index":"011"},"reviewed_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"012"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"004"}},"required":["created_by_automod","created_at","updated_at"],"type":"object"},"MessageModerationResult":{"description":"Result of the message moderation","properties":{"action":{"description":"Action taken by automod","title":"Action","type":"string","x-stream-index":"002"},"ai_moderation_response":{"$ref":"#/components/schemas/ModerationResponse","description":"Response from AI moderation","title":"ModerationResponse","x-stream-index":"007"},"blocked_word":{"description":"Word that was blocked","title":"Blocked word","type":"string","x-stream-index":"004"},"blocklist_name":{"description":"Name of the blocklist","title":"Blocklist name","type":"string","x-stream-index":"005"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"010"},"message_id":{"description":"ID of the message","title":"Message ID","type":"string","x-stream-index":"001"},"moderated_by":{"description":"User who moderated the message","title":"Moderated by","type":"string","x-stream-index":"003"},"moderation_thresholds":{"$ref":"#/components/schemas/Thresholds","description":"Thresholds for AI moderation","title":"Thresholds","x-stream-index":"006"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"011"},"user_bad_karma":{"description":"Whether user has bad karma","title":"User bad karma","type":"boolean","x-stream-index":"009"},"user_karma":{"description":"Karma of the user","format":"float","title":"User karma","type":"number","x-stream-index":"008"}},"required":["message_id","action","user_karma","user_bad_karma","created_at","updated_at"],"title":"Message moderation result","type":"object"},"MessageNewEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"005.002"},"channel_type":{"type":"string","x-stream-index":"005.003"},"cid":{"type":"string","x-stream-index":"005.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"006.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"notification.thread_message_new","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"},"watcher_count":{"format":"int32","type":"integer","x-stream-index":"002.001"}},"required":["watcher_count","type","created_at","cid","channel_id","channel_type"],"title":"MessageNewEvent","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"},"MessageOptions":{"properties":{"include_thread_participants":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"MessagePaginationParams":{"type":"object"},"MessageReadEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"003"},"channel_last_message_at":{"format":"date-time","type":"number","x-stream-index":"005"},"channel_type":{"type":"string","x-stream-index":"004"},"cid":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"009"},"last_read_message_id":{"type":"string","x-stream-index":"010"},"team":{"type":"string","x-stream-index":"006"},"thread":{"$ref":"#/components/schemas/ThreadResponse","x-stream-index":"008"},"type":{"default":"message.read","type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","x-stream-index":"007"}},"required":["type","cid","channel_id","channel_type","created_at"],"type":"object"},"MessageReminder":{"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"004"},"channel_cid":{"type":"string","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"011"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"006"},"message_id":{"type":"string","x-stream-index":"005"},"remind_at":{"format":"date-time","type":"number","x-stream-index":"009"},"task_id":{"type":"string","x-stream-index":"010"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"012"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"user_id":{"type":"string","x-stream-index":"007"}},"required":["channel_cid","message_id","user_id","task_id","created_at","updated_at"],"type":"object"},"MessageRequest":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"maximum":30,"type":"array","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"mentioned_users":{"items":{"type":"string"},"maximum":100,"type":"array","x-stream-index":"008"},"mml":{"type":"string","x-stream-index":"003"},"parent_id":{"type":"string","x-stream-index":"005"},"pin_expires":{"format":"date-time","type":"number","x-stream-index":"015"},"pinned":{"type":"boolean","x-stream-index":"013"},"pinned_at":{"format":"date-time","nullable":true,"type":"string","x-stream-index":"014"},"poll_id":{"type":"string","x-stream-index":"039"},"quoted_message_id":{"type":"string","x-stream-index":"009"},"restricted_visibility":{"items":{"type":"string"},"maximum":10,"type":"array","x-stream-index":"016"},"shared_location":{"$ref":"#/components/schemas/SharedLocation","x-stream-index":"040"},"show_in_channel":{"type":"boolean","x-stream-index":"006"},"silent":{"type":"boolean","x-stream-index":"012"},"text":{"type":"string","x-stream-index":"002"},"type":{"enum":["''","regular","system"],"type":"string","x-stream-index":"011"}},"type":"object"},"MessageResponse":{"description":"Represents any chat message","properties":{"attachments":{"description":"Array of message attachments","items":{"$ref":"#/components/schemas/Attachment"},"title":"Message attachments","type":"array","x-stream-docs-page-id":"message_format#attachment-format","x-stream-index":"008"},"cid":{"description":"Channel unique identifier in \u003ctype\u003e:\u003cid\u003e format","title":"Channel CID","type":"string","x-stream-index":"022"},"command":{"description":"Contains provided slash command","title":"Command","type":"string","x-stream-docs-page-id":"custom_commands_webhook","x-stream-index":"004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"023"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"026"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"025"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"018"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"041"},"html":{"description":"Contains HTML markup of the message. Can only be set when using server-side API","title":"HTML content","type":"string","x-stream-index":"005"},"i18n":{"additionalProperties":{"type":"string"},"description":"Object with translations. Key `language` contains the original language key. Other keys contain translations","title":"Internationalization info","type":"object","x-stream-docs-page-id":"translation","x-stream-index":"030"},"id":{"description":"Message ID is unique string identifier of the message","title":"ID","type":"string","x-stream-index":"001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"Contains image moderation information","title":"Image moderation labels","type":"object","x-stream-index":"028"},"latest_reactions":{"description":"List of 10 latest reactions to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Latest reactions","type":"array","x-stream-index":"009"},"mentioned_users":{"description":"List of mentioned users","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Mentioned Users","type":"array","x-stream-index":"029"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"036"},"mml":{"description":"Should be empty if `text` is provided. Can only be set when using server-side API","title":"Messaging Markup Language","type":"string","x-stream-docs-page-id":"mml_overview","x-stream-index":"003"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"039"},"own_reactions":{"description":"List of 10 latest reactions of authenticated user to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Own reactions","type":"array","x-stream-index":"010"},"parent_id":{"description":"ID of parent message (thread)","title":"Parent message ID","type":"string","x-stream-docs-page-id":"threads","x-stream-index":"015"},"pin_expires":{"description":"Date when pinned message expires","format":"date-time","title":"Pin expiration date","type":"number","x-stream-docs-page-id":"pinned_messages","x-stream-index":"035"},"pinned":{"description":"Whether message is pinned or not","title":"Pinned","type":"boolean","x-stream-docs-page-id":"pinned_messages","x-stream-index":"032"},"pinned_at":{"description":"Date when message got pinned","format":"date-time","title":"Pinned at","type":"number","x-stream-docs-page-id":"pinned_messages","x-stream-index":"033"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","description":"Contains user who pinned the message","title":"Pinned by","x-stream-docs-page-id":"pinned_messages","x-stream-index":"034"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"038"},"poll_id":{"description":"Identifier of the poll to include in the message","title":"Poll ID","type":"string","x-stream-index":"037"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","description":"Contains quoted message","title":"Quoted message","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"020"},"quoted_message_id":{"title":"ID of quoted message","type":"string","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"019"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing number of reactions of each type. Key: reaction type (string), value: number of reactions (int)","title":"Reaction counts","type":"object","x-stream-index":"011"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"014"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing scores of reactions of each type. Key: reaction type (string), value: total score of reactions (int)","title":"Reaction scores","type":"object","x-stream-index":"012"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"042"},"reply_count":{"description":"Number of replies to this message","format":"int32","title":"Reply count","type":"integer","x-stream-index":"017"},"restricted_visibility":{"description":"A list of user ids that have restricted visibility to the message, if the list is not empty, the message is only visible to the users in the list","items":{"type":"string"},"title":"Restricted visibility","type":"array","x-stream-index":"040"},"shadowed":{"description":"Whether the message was shadowed or not","title":"Shadowed","type":"boolean","x-stream-docs-page-id":"moderation#shadow-ban","x-stream-index":"027"},"shared_location":{"$ref":"#/components/schemas/SharedLocationResponseData","description":"Contains shared location data","title":"Shared Location","x-stream-index":"043"},"show_in_channel":{"description":"Whether thread reply should be shown in the channel as well","title":"Show in channel","type":"boolean","x-stream-docs-page-id":"threads","x-stream-index":"016"},"silent":{"description":"Whether message is silent or not","title":"Silent","type":"boolean","x-stream-index":"031"},"text":{"description":"Text of the message. Should be empty if `mml` is provided","title":"Text","type":"string","x-stream-index":"002"},"thread_participants":{"description":"List of users who participate in thread","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Thread participants","type":"array","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"021"},"type":{"description":"Contains type of the message","enum":["regular","ephemeral","error","reply","system","deleted"],"title":"Message Type","type":"string","x-stream-docs-page-id":"message_format#message-types","x-stream-index":"006"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"024"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Sender of the message. Required when using server-side API","title":"User object","x-stream-index":"007"}},"required":["id","text","html","type","user","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned","restricted_visibility"],"title":"Message","type":"object","x-stream-docs-page-id":"send_message"},"MessageUndeletedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"005.002"},"channel_type":{"type":"string","x-stream-index":"005.003"},"cid":{"type":"string","x-stream-index":"005.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"002.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"message.undeleted","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MessageUndeletedEvent","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"},"MessageUpdate":{"properties":{"change_set":{"$ref":"#/components/schemas/MessageChangeSet","x-stream-index":"002"},"old_text":{"type":"string","x-stream-index":"001"}},"type":"object"},"MessageUpdatedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"005.002"},"channel_type":{"type":"string","x-stream-index":"005.003"},"cid":{"type":"string","x-stream-index":"005.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"002.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"message.updated","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MessageUpdatedEvent","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"},"MessageWithChannelResponse":{"description":"Represents any chat message","properties":{"attachments":{"description":"Array of message attachments","items":{"$ref":"#/components/schemas/Attachment"},"title":"Message attachments","type":"array","x-stream-docs-page-id":"message_format#attachment-format","x-stream-index":"001.008"},"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel object","title":"Channel","x-stream-index":"002"},"cid":{"description":"Channel unique identifier in \u003ctype\u003e:\u003cid\u003e format","title":"Channel CID","type":"string","x-stream-index":"001.022"},"command":{"description":"Contains provided slash command","title":"Command","type":"string","x-stream-docs-page-id":"custom_commands_webhook","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.023"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.026"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"001.025"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"001.018"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001.041"},"html":{"description":"Contains HTML markup of the message. Can only be set when using server-side API","title":"HTML content","type":"string","x-stream-index":"001.005"},"i18n":{"additionalProperties":{"type":"string"},"description":"Object with translations. Key `language` contains the original language key. Other keys contain translations","title":"Internationalization info","type":"object","x-stream-docs-page-id":"translation","x-stream-index":"001.030"},"id":{"description":"Message ID is unique string identifier of the message","title":"ID","type":"string","x-stream-index":"001.001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"Contains image moderation information","title":"Image moderation labels","type":"object","x-stream-index":"001.028"},"latest_reactions":{"description":"List of 10 latest reactions to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Latest reactions","type":"array","x-stream-index":"001.009"},"mentioned_users":{"description":"List of mentioned users","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Mentioned Users","type":"array","x-stream-index":"001.029"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"001.036"},"mml":{"description":"Should be empty if `text` is provided. Can only be set when using server-side API","title":"Messaging Markup Language","type":"string","x-stream-docs-page-id":"mml_overview","x-stream-index":"001.003"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"001.039"},"own_reactions":{"description":"List of 10 latest reactions of authenticated user to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Own reactions","type":"array","x-stream-index":"001.010"},"parent_id":{"description":"ID of parent message (thread)","title":"Parent message ID","type":"string","x-stream-docs-page-id":"threads","x-stream-index":"001.015"},"pin_expires":{"description":"Date when pinned message expires","format":"date-time","title":"Pin expiration date","type":"number","x-stream-docs-page-id":"pinned_messages","x-stream-index":"001.035"},"pinned":{"description":"Whether message is pinned or not","title":"Pinned","type":"boolean","x-stream-docs-page-id":"pinned_messages","x-stream-index":"001.032"},"pinned_at":{"description":"Date when message got pinned","format":"date-time","title":"Pinned at","type":"number","x-stream-docs-page-id":"pinned_messages","x-stream-index":"001.033"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","description":"Contains user who pinned the message","title":"Pinned by","x-stream-docs-page-id":"pinned_messages","x-stream-index":"001.034"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001.038"},"poll_id":{"description":"Identifier of the poll to include in the message","title":"Poll ID","type":"string","x-stream-index":"001.037"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","description":"Contains quoted message","title":"Quoted message","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"001.020"},"quoted_message_id":{"title":"ID of quoted message","type":"string","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"001.019"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing number of reactions of each type. Key: reaction type (string), value: number of reactions (int)","title":"Reaction counts","type":"object","x-stream-index":"001.011"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"001.014"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing scores of reactions of each type. Key: reaction type (string), value: total score of reactions (int)","title":"Reaction scores","type":"object","x-stream-index":"001.012"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"001.042"},"reply_count":{"description":"Number of replies to this message","format":"int32","title":"Reply count","type":"integer","x-stream-index":"001.017"},"restricted_visibility":{"description":"A list of user ids that have restricted visibility to the message, if the list is not empty, the message is only visible to the users in the list","items":{"type":"string"},"title":"Restricted visibility","type":"array","x-stream-index":"001.040"},"shadowed":{"description":"Whether the message was shadowed or not","title":"Shadowed","type":"boolean","x-stream-docs-page-id":"moderation#shadow-ban","x-stream-index":"001.027"},"shared_location":{"$ref":"#/components/schemas/SharedLocationResponseData","description":"Contains shared location data","title":"Shared Location","x-stream-index":"001.043"},"show_in_channel":{"description":"Whether thread reply should be shown in the channel as well","title":"Show in channel","type":"boolean","x-stream-docs-page-id":"threads","x-stream-index":"001.016"},"silent":{"description":"Whether message is silent or not","title":"Silent","type":"boolean","x-stream-index":"001.031"},"text":{"description":"Text of the message. Should be empty if `mml` is provided","title":"Text","type":"string","x-stream-index":"001.002"},"thread_participants":{"description":"List of users who participate in thread","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Thread participants","type":"array","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"001.021"},"type":{"description":"Contains type of the message","enum":["regular","ephemeral","error","reply","system","deleted"],"title":"Message Type","type":"string","x-stream-docs-page-id":"message_format#message-types","x-stream-index":"001.006"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.024"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Sender of the message. Required when using server-side API","title":"User object","x-stream-index":"001.007"}},"required":["id","text","html","type","user","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned","restricted_visibility","channel"],"title":"Message","type":"object","x-stream-docs-page-id":"send_message"},"ModerationActionConfig":{"nullable":true,"properties":{"action":{"type":"string","x-stream-index":"006"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"009"},"description":{"type":"string","x-stream-index":"008"},"entity_type":{"type":"string","x-stream-index":"004"},"icon":{"type":"string","x-stream-index":"007"},"order":{"format":"int32","type":"integer","x-stream-index":"005"}},"required":["entity_type","order","action","icon","description","custom"],"type":"object"},"ModerationCustomActionEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"001"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"002"},"type":{"default":"moderation.custom_action","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationCustomActionEvent","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"},"ModerationFlaggedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"item":{"type":"string","x-stream-index":"001"},"object_id":{"type":"string","x-stream-index":"002"},"type":{"default":"moderation.flagged","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationFlaggedEvent","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"},"ModerationMarkReviewedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"001"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"002"},"type":{"default":"moderation.mark_reviewed","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationMarkReviewedEvent","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"},"ModerationPayload":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"images":{"items":{"type":"string"},"maximum":30,"type":"array","x-stream-index":"002"},"texts":{"items":{"type":"string"},"type":"array","x-stream-index":"001"},"videos":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"type":"object"},"ModerationResponse":{"properties":{"action":{"type":"string","x-stream-index":"004"},"explicit":{"format":"float","type":"number","x-stream-index":"002"},"spam":{"format":"float","type":"number","x-stream-index":"003"},"toxic":{"format":"float","type":"number","x-stream-index":"001"}},"required":["toxic","explicit","spam","action","automod_response"],"type":"object"},"ModerationV2Response":{"properties":{"action":{"type":"string","x-stream-index":"001"},"blocklist_matched":{"type":"string","x-stream-index":"005"},"image_harms":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"original_text":{"type":"string","x-stream-index":"002"},"platform_circumvented":{"type":"boolean","x-stream-index":"007"},"semantic_filter_matched":{"type":"string","x-stream-index":"006"},"text_harms":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"required":["action","original_text"],"type":"object"},"MuteChannelRequest":{"nullable":true,"properties":{"channel_cids":{"description":"Channel CIDs to mute (if multiple channels)","items":{"type":"string"},"maximum":25,"title":"Channel CIDs","type":"array","x-stream-index":"002"},"expiration":{"description":"Duration of mute in milliseconds","title":"Expiration","type":"integer","x-stream-index":"003"}},"type":"object"},"MuteChannelResponse":{"nullable":true,"properties":{"channel_mute":{"$ref":"#/components/schemas/ChannelMute","description":"Object with channel mute (if one channel was muted)","title":"Channel mute","x-stream-index":"001"},"channel_mutes":{"description":"Object with mutes (if multiple channels were muted)","items":{"$ref":"#/components/schemas/ChannelMute"},"title":"Channel mutes","type":"array","x-stream-index":"002"},"duration":{"type":"string","x-stream-index":"004.001"},"own_user":{"$ref":"#/components/schemas/OwnUser","description":"Authorized user object with fresh mutes information","title":"Own user","x-stream-index":"003"}},"required":["duration"],"type":"object"},"MuteRequest":{"nullable":true,"properties":{"target_ids":{"description":"User IDs to mute (if multiple users)","items":{"type":"string"},"title":"Target IDs","type":"array","x-stream-index":"001"},"timeout":{"description":"Duration of mute in minutes","minimum":0,"title":"Timeout","type":"integer","x-stream-index":"002"}},"required":["target_ids"],"title":"MuteRequest","type":"object"},"MuteResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"004.001"},"mutes":{"description":"Object with mutes (if multiple users were muted)","items":{"$ref":"#/components/schemas/UserMute"},"title":"Mutes","type":"array","x-stream-index":"001"},"non_existing_users":{"description":"A list of users that can't be found. Common cause for this is deleted users","items":{"type":"string"},"title":"Non Existing Users","type":"array","x-stream-index":"003"},"own_user":{"$ref":"#/components/schemas/OwnUser","description":"Authorized user object with fresh mutes information","title":"Own User","x-stream-index":"002"}},"required":["duration"],"title":"MuteResponse","type":"object"},"NoiseCancellationSettings":{"properties":{"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode"],"type":"object"},"NotificationAddedToChannelEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003.004"},"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"003.005"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"001.001"},"type":{"default":"notification.added_to_channel","type":"string","x-stream-index":"002.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"NotificationAddedToChannelEvent","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"},"NotificationChannelDeletedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003.004"},"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"003.005"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"team":{"type":"string","x-stream-index":"001.001"},"type":{"default":"notification.channel_deleted","type":"string","x-stream-index":"002.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"NotificationChannelDeletedEvent","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"},"NotificationChannelMutesUpdatedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"me":{"$ref":"#/components/schemas/OwnUser","x-stream-index":"001"},"type":{"default":"notification.channel_mutes_updated","type":"string","x-stream-index":"002.001"}},"required":["me","type","created_at"],"title":"NotificationChannelMutesUpdatedEvent","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"},"NotificationChannelTruncatedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002.004"},"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"002.005"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"notification.channel_truncated","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"NotificationChannelTruncatedEvent","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"},"NotificationInviteAcceptedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002.004"},"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"002.005"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"004.001"},"type":{"default":"notification.invite_accepted","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"NotificationInviteAcceptedEvent","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"},"NotificationInviteRejectedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002.004"},"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"002.005"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"004.001"},"type":{"default":"notification.invite_rejected","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"NotificationInviteRejectedEvent","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"},"NotificationInvitedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002.004"},"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"002.005"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"004.001"},"type":{"default":"notification.invited","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"NotificationInvitedEvent","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"},"NotificationMarkReadEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003.004"},"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"003.005"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"team":{"type":"string","x-stream-index":"002.001"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"006"},"type":{"default":"notification.mark_read","type":"string","x-stream-index":"001.001"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"007"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"005"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"008"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count","unread_count","total_unread_count","unread_channels","unread_threads"],"title":"NotificationMarkReadEvent","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"},"NotificationMarkUnreadEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003.004"},"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"003.005"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"first_unread_message_id":{"type":"string","x-stream-index":"005"},"last_read_at":{"format":"date-time","type":"number","x-stream-index":"006"},"last_read_message_id":{"type":"string","x-stream-index":"012"},"team":{"type":"string","x-stream-index":"002.001"},"thread_id":{"type":"string","x-stream-index":"013"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"009"},"type":{"default":"notification.mark_unread","type":"string","x-stream-index":"001.001"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"010"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"008"},"unread_messages":{"format":"int32","type":"integer","x-stream-index":"007"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"011"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count","first_unread_message_id","last_read_at","unread_messages","unread_count","total_unread_count","unread_channels","unread_threads"],"title":"NotificationMarkUnreadEvent","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"},"NotificationMutesUpdatedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"me":{"$ref":"#/components/schemas/OwnUser","x-stream-index":"001"},"type":{"default":"notification.mutes_updated","type":"string","x-stream-index":"002.001"}},"required":["me","type","created_at"],"title":"NotificationMutesUpdatedEvent","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"},"NotificationNewMessageEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"004.004"},"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"004.005"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"002.001"},"type":{"default":"notification.message_new","type":"string","x-stream-index":"003.001"}},"required":["message","type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"NotificationNewMessageEvent","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"},"NotificationRemovedFromChannelEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002.004"},"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"002.005"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"004.001"},"type":{"default":"notification.removed_from_channel","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"NotificationRemovedFromChannelEvent","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"},"NotificationSettings":{"properties":{"call_live_started":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"002"},"call_missed":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"006"},"call_notification":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"004"},"call_ring":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"session_started":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"003"}},"required":["enabled","call_live_started","session_started","call_notification","call_ring","call_missed"],"type":"object"},"NullTime":{"type":"object"},"OCRRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"}},"required":["label","action"],"type":"object"},"OnlyUserID":{"properties":{"id":{"type":"string","x-stream-index":"001"}},"required":["id"],"type":"object"},"OwnUser":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"046"},"banned":{"type":"boolean","x-stream-index":"016"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"045"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"029"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"014"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"013"},"devices":{"items":{"$ref":"#/components/schemas/Device"},"type":"array","x-stream-index":"027"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"023"},"language":{"type":"string","x-stream-index":"035"},"last_active":{"format":"date-time","type":"number","x-stream-index":"011"},"last_engaged_at":{"format":"date-time","type":"number","x-stream-index":"012"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"037"},"mutes":{"items":{"$ref":"#/components/schemas/UserMute"},"type":"array","x-stream-index":"028"},"online":{"type":"boolean","x-stream-index":"022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"026"},"push_preferences":{"$ref":"#/components/schemas/PushPreferences","x-stream-index":"025"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"005"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"031"},"total_unread_count_by_team":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"032"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"033"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"030"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"034"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"}},"required":["id","role","custom","created_at","updated_at","banned","online","devices","mutes","channel_mutes","unread_count","total_unread_count","total_unread_count_by_team","unread_channels","unread_threads","language"],"type":"object"},"OwnUserResponse":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"banned":{"type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"015"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.011"},"devices":{"items":{"$ref":"#/components/schemas/DeviceResponse"},"title":"Devices","type":"array","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001.001"},"image":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"005"},"language":{"type":"string","x-stream-index":"001.005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"001.014"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"013"},"mutes":{"items":{"$ref":"#/components/schemas/UserMuteResponse"},"type":"array","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"001.002"},"online":{"type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"003"},"push_preferences":{"$ref":"#/components/schemas/PushPreferences","x-stream-index":"002"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.015"},"role":{"type":"string","x-stream-index":"001.006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"009"},"total_unread_count_by_team":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"010"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"011"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"008"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"012"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","devices","invisible","mutes","channel_mutes","unread_count","total_unread_count","unread_channels","unread_threads"],"type":"object"},"PaginationParams":{"properties":{"limit":{"format":"int32","minimum":0,"type":"integer","x-stream-index":"001"},"offset":{"format":"int32","type":"integer","x-stream-index":"002"}},"type":"object"},"PendingMessageEvent":{"description":"Pending message event for async moderation","nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"002.007"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"message":{"$ref":"#/components/schemas/Message","description":"The pending message","title":"Message","x-stream-index":"002.009"},"metadata":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"002.010"},"method":{"description":"The method used for the pending message","title":"Method","type":"string","x-stream-index":"003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"type":{"default":"message.pending","description":"The type of event: \"message.pending\" in this case","title":"Event Type","type":"string","x-stream-index":"001.002"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.002"}},"required":["type","custom","method","created_at"],"title":"PendingMessageEvent","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"},"PendingMessageResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"003"},"metadata":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"}},"type":"object"},"Poll":{"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"023"},"allow_answers":{"type":"boolean","x-stream-index":"010"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"009"},"answers_count":{"format":"int32","type":"integer","x-stream-index":"015"},"created_at":{"format":"date-time","type":"number","x-stream-index":"021"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"020"},"created_by_id":{"type":"string","x-stream-index":"019"},"description":{"type":"string","x-stream-index":"005"},"enforce_unique_vote":{"type":"boolean","x-stream-index":"007"},"id":{"type":"string","x-stream-index":"003"},"is_closed":{"type":"boolean","x-stream-index":"011"},"latest_answers":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array","x-stream-index":"017"},"latest_votes_by_option":{"additionalProperties":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array"},"type":"object","x-stream-index":"016"},"max_votes_allowed":{"format":"int32","type":"integer","x-stream-index":"008"},"name":{"type":"string","x-stream-index":"004"},"options":{"items":{"$ref":"#/components/schemas/PollOption"},"type":"array","x-stream-index":"013"},"own_votes":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array","x-stream-index":"018"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"022"},"vote_count":{"format":"int32","type":"integer","x-stream-index":"012"},"vote_counts_by_option":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"014"},"voting_visibility":{"type":"string","x-stream-index":"006"}},"required":["id","name","description","enforce_unique_vote","allow_user_suggested_options","allow_answers","vote_count","options","vote_counts_by_option","answers_count","latest_votes_by_option","latest_answers","own_votes","created_by_id","created_at","updated_at","Custom"],"type":"object"},"PollClosedEvent":{"description":"Emitted when a poll is closed.","nullable":true,"properties":{"activity_id":{"type":"string","x-stream-index":"001.003"},"cid":{"description":"The CID of the channel containing the poll","title":"Channel CID","type":"string","x-stream-index":"001.001.002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.001.007"},"message_id":{"description":"The ID of the message containing the poll","title":"Message ID","type":"string","x-stream-index":"001.002"},"poll":{"$ref":"#/components/schemas/PollResponseData","description":"The poll object which was closed","title":"Poll","x-stream-index":"001.004"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.001.004"},"type":{"default":"poll.closed","description":"The type of event: \"poll.closed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.001.002"}},"required":["type","created_at","custom","poll"],"title":"PollClosedEvent","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"},"PollDeletedEvent":{"description":"Emitted when a poll is deleted.","nullable":true,"properties":{"activity_id":{"type":"string","x-stream-index":"001.003"},"cid":{"description":"The CID of the channel containing the poll","title":"Channel CID","type":"string","x-stream-index":"001.001.002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.001.007"},"message_id":{"description":"The ID of the message containing the poll","title":"Message ID","type":"string","x-stream-index":"001.002"},"poll":{"$ref":"#/components/schemas/PollResponseData","description":"The poll object which was deleted","title":"Poll","x-stream-index":"001.004"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.001.004"},"type":{"default":"poll.deleted","description":"The type of event: \"poll.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.001.002"}},"required":["type","created_at","custom","poll"],"title":"PollDeletedEvent","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"},"PollOption":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id","text","custom"],"type":"object"},"PollOptionInput":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"text":{"type":"string","x-stream-index":"002"}},"type":"object"},"PollOptionRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id"],"type":"object"},"PollOptionResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"poll_option":{"$ref":"#/components/schemas/PollOptionResponseData","description":"Poll option","title":"PollOptionResponseData","x-stream-index":"001"}},"required":["poll_option","duration"],"type":"object"},"PollOptionResponseData":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id","text","custom"],"type":"object"},"PollResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"poll":{"$ref":"#/components/schemas/PollResponseData","description":"Poll","title":"PollResponseData","x-stream-index":"001"}},"required":["poll","duration"],"type":"object"},"PollResponseData":{"properties":{"allow_answers":{"type":"boolean","x-stream-index":"008"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"007"},"answers_count":{"format":"int32","type":"integer","x-stream-index":"012"},"created_at":{"format":"date-time","type":"number","x-stream-index":"019"},"created_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"018"},"created_by_id":{"type":"string","x-stream-index":"017"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"021"},"description":{"type":"string","x-stream-index":"003"},"enforce_unique_vote":{"type":"boolean","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"is_closed":{"type":"boolean","x-stream-index":"009"},"latest_answers":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array","x-stream-index":"015"},"latest_votes_by_option":{"additionalProperties":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array"},"type":"object","x-stream-index":"014"},"max_votes_allowed":{"format":"int32","type":"integer","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"002"},"options":{"items":{"$ref":"#/components/schemas/PollOptionResponseData"},"type":"array","x-stream-index":"011"},"own_votes":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array","x-stream-index":"016"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"020"},"vote_count":{"format":"int32","type":"integer","x-stream-index":"010"},"vote_counts_by_option":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"013"},"voting_visibility":{"type":"string","x-stream-index":"004"}},"required":["id","name","description","voting_visibility","enforce_unique_vote","allow_user_suggested_options","allow_answers","vote_count","options","answers_count","vote_counts_by_option","latest_votes_by_option","latest_answers","own_votes","created_by_id","created_at","updated_at","custom"],"type":"object"},"PollUpdatedEvent":{"description":"Emitted when a poll is updated.","nullable":true,"properties":{"activity_id":{"type":"string","x-stream-index":"001.003"},"cid":{"description":"The CID of the channel containing the poll","title":"Channel CID","type":"string","x-stream-index":"001.001.002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.001.007"},"message_id":{"description":"The ID of the message containing the poll","title":"Message ID","type":"string","x-stream-index":"001.002"},"poll":{"$ref":"#/components/schemas/PollResponseData","description":"The poll object which was updated","title":"Poll","x-stream-index":"001.004"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.001.004"},"type":{"default":"poll.updated","description":"The type of event: \"poll.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.001.002"}},"required":["type","created_at","custom","poll"],"title":"PollUpdatedEvent","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"},"PollVote":{"nullable":true,"properties":{"answer_text":{"type":"string","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"004"},"is_answer":{"type":"boolean","x-stream-index":"006"},"option_id":{"type":"string","x-stream-index":"005"},"poll_id":{"type":"string","x-stream-index":"003"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"011"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"009"},"user_id":{"type":"string","x-stream-index":"008"}},"required":["poll_id","id","option_id","created_at","updated_at"],"type":"object"},"PollVoteCastedEvent":{"description":"Emitted when a vote is cast on a poll.","nullable":true,"properties":{"activity_id":{"type":"string","x-stream-index":"001.001.003"},"cid":{"description":"The CID of the channel containing the poll","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":"number","x-stream-index":"001.001.001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.001.001.007"},"message_id":{"description":"The ID of the message containing the poll","title":"Message ID","type":"string","x-stream-index":"001.001.002"},"poll":{"$ref":"#/components/schemas/PollResponseData","description":"The poll object","title":"Poll","x-stream-index":"001.001.004"},"poll_vote":{"$ref":"#/components/schemas/PollVoteResponseData","description":"The vote that was cast","title":"Poll Vote","x-stream-index":"001.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.001.001.004"},"type":{"default":"poll.vote_casted","description":"The type of event: \"poll.vote_casted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.001.001.002"}},"required":["type","created_at","custom","poll","poll_vote"],"title":"PollVoteCastedEvent","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"},"PollVoteChangedEvent":{"description":"Emitted when a vote on a poll is changed.","nullable":true,"properties":{"activity_id":{"type":"string","x-stream-index":"001.001.003"},"cid":{"description":"The CID of the channel containing the poll","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":"number","x-stream-index":"001.001.001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.001.001.007"},"message_id":{"description":"The ID of the message containing the poll","title":"Message ID","type":"string","x-stream-index":"001.001.002"},"poll":{"$ref":"#/components/schemas/PollResponseData","description":"The poll object","title":"Poll","x-stream-index":"001.001.004"},"poll_vote":{"$ref":"#/components/schemas/PollVoteResponseData","description":"The updated vote","title":"Poll Vote","x-stream-index":"001.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.001.001.004"},"type":{"default":"poll.vote_changed","description":"The type of event: \"poll.vote_changed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.001.001.002"}},"required":["type","created_at","custom","poll","poll_vote"],"title":"PollVoteChangedEvent","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"},"PollVoteRemovedEvent":{"description":"Emitted when a vote is removed from a poll.","nullable":true,"properties":{"activity_id":{"type":"string","x-stream-index":"001.001.003"},"cid":{"description":"The CID of the channel containing the poll","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":"number","x-stream-index":"001.001.001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.001.001.007"},"message_id":{"description":"The ID of the message containing the poll","title":"Message ID","type":"string","x-stream-index":"001.001.002"},"poll":{"$ref":"#/components/schemas/PollResponseData","description":"The poll object","title":"Poll","x-stream-index":"001.001.004"},"poll_vote":{"$ref":"#/components/schemas/PollVoteResponseData","description":"The vote that was removed","title":"Poll Vote","x-stream-index":"001.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.001.001.004"},"type":{"default":"poll.vote_removed","description":"The type of event: \"poll.vote_removed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.001.001.002"}},"required":["type","created_at","custom","poll","poll_vote"],"title":"PollVoteRemovedEvent","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"},"PollVoteResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"vote":{"$ref":"#/components/schemas/PollVoteResponseData","description":"Poll vote","title":"PollVoteResponseData","x-stream-index":"001"}},"required":["duration"],"type":"object"},"PollVoteResponseData":{"nullable":true,"properties":{"answer_text":{"type":"string","x-stream-index":"005"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"id":{"type":"string","x-stream-index":"002"},"is_answer":{"type":"boolean","x-stream-index":"004"},"option_id":{"type":"string","x-stream-index":"003"},"poll_id":{"type":"string","x-stream-index":"001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"007"},"user_id":{"type":"string","x-stream-index":"006"}},"required":["poll_id","id","option_id","created_at","updated_at"],"type":"object"},"PollVotesResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"votes":{"description":"Poll votes","items":{"$ref":"#/components/schemas/PollVoteResponseData"},"title":"PollVoteResponseList","type":"array","x-stream-index":"001"}},"required":["votes","duration"],"type":"object"},"PrivacySettings":{"properties":{"read_receipts":{"$ref":"#/components/schemas/ReadReceipts","x-stream-index":"002"},"typing_indicators":{"$ref":"#/components/schemas/TypingIndicators","x-stream-index":"001"}},"type":"object"},"PrivacySettingsResponse":{"properties":{"read_receipts":{"$ref":"#/components/schemas/ReadReceiptsResponse","x-stream-index":"002"},"typing_indicators":{"$ref":"#/components/schemas/TypingIndicatorsResponse","x-stream-index":"001"}},"type":"object"},"PushPreferenceInput":{"nullable":true,"properties":{"call_level":{"description":"Set the level of call push notifications for the user. One of all, none, default","enum":["all","none","default"],"type":"string","x-stream-index":"004"},"channel_cid":{"description":"Set the push preferences for a specific channel. If empty it sets the default for the user","type":"string","x-stream-index":"002"},"chat_level":{"description":"Set the level of chat push notifications for the user. One of all, mentions, none, default","enum":["all","mentions","none","default"],"type":"string","x-stream-index":"003"},"disabled_until":{"description":"Disable push notifications till a certain time","format":"date-time","type":"number","x-stream-index":"005"},"remove_disable":{"description":"Remove the disabled until time. (IE stop snoozing notifications)","type":"boolean","x-stream-index":"006"},"user_id":{"description":"The user id for which to set the push preferences. Required when using server side auths, defaults to current user with client side auth.","type":"string","x-stream-index":"001"}},"type":"object"},"PushPreferences":{"properties":{"call_level":{"type":"string","x-stream-index":"002"},"chat_level":{"type":"string","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"number","x-stream-index":"003"}},"type":"object"},"Quality":{"properties":{"bitdepth":{"format":"int32","type":"integer","x-stream-index":"007"},"framerate":{"format":"int32","type":"integer","x-stream-index":"008"},"height":{"format":"int32","type":"integer","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"004"},"video_bitrate":{"format":"int32","type":"integer","x-stream-index":"009"},"width":{"format":"int32","type":"integer","x-stream-index":"005"}},"type":"object"},"QueryBannedUsersPayload":{"properties":{"exclude_expired_bans":{"description":"Whether to exclude expired bans or not","title":"Exclude expired bans","type":"boolean","x-stream-index":"004"},"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"description":"Number of records to return","format":"int32","maximum":300,"minimum":0,"title":"Limit","type":"integer","x-stream-index":"003.003"},"offset":{"description":"Number of records to offset","format":"int32","maximum":10000,"title":"Offset","type":"integer","x-stream-index":"003.004"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":1,"title":"Sort","type":"array","x-stream-index":"002"}},"required":["filter_conditions"],"type":"object"},"QueryBannedUsersResponse":{"nullable":true,"properties":{"bans":{"description":"List of found bans","items":{"$ref":"#/components/schemas/BanResponse"},"title":"BanResponse","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["bans","duration"],"type":"object"},"QueryChannelsRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"description":"Number of channels to limit","format":"int32","title":"Limit","type":"integer","x-stream-index":"008"},"member_limit":{"description":"Number of members to limit","format":"int32","maximum":100,"minimum":0,"title":"Member limit","type":"integer","x-stream-index":"007"},"message_limit":{"description":"Number of messages to limit","format":"int32","minimum":0,"title":"Message limit","type":"integer","x-stream-index":"006"},"offset":{"description":"Channel pagination offset","format":"int32","title":"Offset","type":"integer","x-stream-index":"009"},"presence":{"title":"Presence","type":"boolean","x-stream-index":"005"},"sort":{"description":"List of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"002"},"state":{"description":"Whether to update channel state or not","title":"State","type":"boolean","x-stream-index":"004"},"watch":{"description":"Whether to start watching found channels or not","title":"Watch","type":"boolean","x-stream-index":"003"}},"title":"Query Channels Request","type":"object","x-stream-docs-page-id":"query_channels"},"QueryChannelsResponse":{"nullable":true,"properties":{"channels":{"description":"List of channels","items":{"$ref":"#/components/schemas/ChannelStateResponseFields"},"title":"Channels","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["channels","duration"],"title":"Channels list","type":"object"},"QueryDraftsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","maximum":3,"title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"002"}},"type":"object"},"QueryDraftsResponse":{"nullable":true,"properties":{"drafts":{"description":"Drafts","items":{"$ref":"#/components/schemas/DraftResponse"},"title":"DraftsResponseList","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["drafts","duration"],"type":"object"},"QueryMembersPayload":{"description":"Client request","properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"002"},"limit":{"format":"int32","maximum":300,"minimum":0,"type":"integer","x-stream-index":"006.003"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"type":"array","x-stream-index":"003"},"offset":{"format":"int32","maximum":10000,"type":"integer","x-stream-index":"006.004"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":1,"type":"array","x-stream-index":"005"},"type":{"maxLength":64,"type":"string","x-stream-index":"001"}},"required":["type","filter_conditions"],"title":"ClientRequest","type":"object"},"QueryMessageFlagsPayload":{"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":300,"minimum":0,"type":"integer","x-stream-index":"003.003"},"offset":{"format":"int32","maximum":10000,"type":"integer","x-stream-index":"003.004"},"show_deleted_messages":{"description":"Whether to include deleted messages in the results","title":"ShowDeletedMessages","type":"boolean","x-stream-index":"002"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"type":"array","x-stream-index":"003.005"}},"type":"object"},"QueryMessageFlagsResponse":{"description":"Query message flags response","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"flags":{"description":"The flags that match the query","items":{"$ref":"#/components/schemas/MessageFlagResponse"},"title":"MessageFlagResponseList","type":"array","x-stream-index":"001"}},"required":["flags","duration"],"title":"QueryMessageFlagsResponse","type":"object"},"QueryModerationConfigsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter conditions for moderation configs","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"Sorting parameters for the results","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"002"}},"type":"object"},"QueryModerationConfigsResponse":{"nullable":true,"properties":{"configs":{"description":"List of moderation configurations","items":{"$ref":"#/components/schemas/ConfigResponse"},"title":"Configs","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["configs","duration"],"type":"object"},"QueryPollVotesRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","title":"Filter","type":"object","x-stream-index":"003"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"004"}},"type":"object"},"QueryPollsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","title":"Filter","type":"object","x-stream-index":"002"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"003"}},"type":"object"},"QueryPollsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"polls":{"description":"Polls data returned by the query","items":{"$ref":"#/components/schemas/PollResponseData"},"title":"PollsResponseData","type":"array","x-stream-index":"001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["polls","duration"],"type":"object"},"QueryReactionsRequest":{"properties":{"filter":{"additionalProperties":{},"type":"object","x-stream-index":"002"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"006.001"},"next":{"type":"string","x-stream-index":"006.002"},"prev":{"type":"string","x-stream-index":"006.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":2,"type":"array","x-stream-index":"003"}},"type":"object"},"QueryReactionsResponse":{"description":"Basic response information","properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"next":{"type":"string","x-stream-index":"003.001"},"prev":{"type":"string","x-stream-index":"003.002"},"reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"001"}},"required":["reactions","duration"],"title":"Response","type":"object"},"QueryRemindersRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"002"}},"type":"object"},"QueryRemindersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"reminders":{"description":"MessageReminders data returned by the query","items":{"$ref":"#/components/schemas/ReminderResponseData"},"title":"RemindersResponseData","type":"array","x-stream-index":"001"}},"required":["reminders","duration"],"type":"object"},"QueryReviewQueueRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter conditions for review queue items","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"007.001"},"lock_count":{"description":"Number of items to lock (1-25)","format":"int32","maximum":25,"minimum":1,"title":"Lock Count","type":"integer","x-stream-index":"005"},"lock_duration":{"description":"Duration for which items should be locked","title":"Lock Duration","type":"integer","x-stream-index":"004"},"lock_items":{"description":"Whether to lock items for review (true), unlock items (false), or just fetch (nil)","title":"Lock Items","type":"boolean","x-stream-index":"003"},"next":{"type":"string","x-stream-index":"007.002"},"prev":{"type":"string","x-stream-index":"007.003"},"sort":{"description":"Sorting parameters for the results","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"002"},"stats_only":{"description":"Whether to return only statistics","title":"Stats Only","type":"boolean","x-stream-index":"006"}},"type":"object"},"QueryReviewQueueResponse":{"nullable":true,"properties":{"action_config":{"additionalProperties":{"items":{"$ref":"#/components/schemas/ModerationActionConfig"},"type":"array"},"description":"Configuration for moderation actions","title":"Action Config","type":"object","x-stream-index":"002"},"duration":{"type":"string","x-stream-index":"005.001"},"items":{"description":"List of review queue items","items":{"$ref":"#/components/schemas/ReviewQueueItemResponse"},"title":"Items","type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"004.001"},"prev":{"type":"string","x-stream-index":"004.002"},"stats":{"additionalProperties":{},"description":"Statistics about the review queue","title":"Stats","type":"object","x-stream-index":"003"}},"required":["items","action_config","stats","duration"],"type":"object"},"QueryThreadsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter conditions to apply to threads","title":"Filter","type":"object","x-stream-index":"006"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"008.001"},"member_limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005"},"next":{"type":"string","x-stream-index":"008.002"},"participant_limit":{"description":"Limit the number of participants returned per each thread","format":"int32","maximum":100,"minimum":0,"title":"Participant limit","type":"integer","x-stream-index":"004"},"prev":{"type":"string","x-stream-index":"008.003"},"reply_limit":{"description":"Limit the number of replies returned per each thread","format":"int32","maximum":10,"minimum":0,"title":"Reply limit","type":"integer","x-stream-index":"003"},"sort":{"description":"Sort conditions to apply to threads","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"007"},"watch":{"description":"Start watching the channel this thread belongs to","title":"Watch","type":"boolean","x-stream-index":"001"}},"type":"object"},"QueryThreadsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"threads":{"description":"List of enriched thread states","items":{"$ref":"#/components/schemas/ThreadStateResponse"},"title":"Threads","type":"array","x-stream-index":"001"}},"required":["threads","duration"],"type":"object"},"QueryUsersPayload":{"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"include_deactivated_users":{"type":"boolean","x-stream-index":"004"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.003"},"offset":{"format":"int32","maximum":1000,"type":"integer","x-stream-index":"005.004"},"presence":{"type":"boolean","x-stream-index":"003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"type":"array","x-stream-index":"002"}},"required":["filter_conditions"],"type":"object"},"QueryUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"users":{"description":"Array of users as result of filters applied.","items":{"$ref":"#/components/schemas/FullUserResponse"},"title":"Users","type":"array","x-stream-index":"001"}},"required":["users","duration"],"type":"object"},"RTMPEgressConfig":{"properties":{"composite_app_settings":{"$ref":"#/components/schemas/CompositeAppSettings","x-stream-index":"005"},"quality":{"$ref":"#/components/schemas/Quality","x-stream-index":"004"},"rtmp_location":{"type":"string","x-stream-index":"006"}},"type":"object"},"RTMPIngress":{"description":"RTMP input settings","properties":{"address":{"title":"Address","type":"string","x-stream-index":"001"}},"required":["address"],"title":"RTMPIngress","type":"object"},"RTMPLocation":{"properties":{"name":{"type":"string","x-stream-index":"001"},"stream_key":{"type":"string","x-stream-index":"003"},"stream_url":{"type":"string","x-stream-index":"002"}},"required":["name","stream_url","stream_key"],"type":"object"},"RTMPSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"003"},"location":{"$ref":"#/components/schemas/RTMPLocation","x-stream-index":"004"},"quality_name":{"type":"string","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"RTMPSettingsResponse":{"description":"RTMPSettingsResponse is the payload for RTMP settings","properties":{"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"001"},"quality":{"title":"Quality","type":"string","x-stream-index":"002"}},"required":["enabled","quality","layout"],"title":"RTMPSettingsResponse","type":"object"},"Reaction":{"nullable":true,"properties":{"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"message_id":{"type":"string","x-stream-index":"003"},"score":{"format":"int32","type":"integer","x-stream-index":"007"},"type":{"maxLength":30,"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["message_id","type","score","created_at","updated_at","custom"],"type":"object"},"ReactionDeletedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"006.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"002"},"team":{"type":"string","x-stream-index":"005.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"reaction.deleted","type":"string","x-stream-index":"006.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"ReactionDeletedEvent","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"},"ReactionGroupResponse":{"description":"ReactionGroupResponse contains all information about a reaction of the same type.","nullable":true,"properties":{"count":{"description":"Count is the number of reactions of this type.","format":"int32","title":"Count","type":"integer","x-stream-index":"001"},"first_reaction_at":{"description":"FirstReactionAt is the time of the first reaction of this type. This is the same also if all reaction of this type are deleted, because if someone will react again with the same type, will be preserved the sorting.","format":"date-time","title":"FirstReactionAt","type":"number","x-stream-index":"003"},"last_reaction_at":{"description":"LastReactionAt is the time of the last reaction of this type.","format":"date-time","title":"LastReactionAt","type":"number","x-stream-index":"004"},"sum_scores":{"description":"SumScores is the sum of all scores of reactions of this type. Medium allows you to clap articles more than once and shows the sum of all claps from all users. For example, you can send `clap` x5 using `score: 5`.","format":"int32","title":"SumScores","type":"integer","x-stream-index":"002"}},"required":["count","sum_scores","first_reaction_at","last_reaction_at"],"title":"ReactionGroupResponse","type":"object"},"ReactionNewEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"006.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"002"},"team":{"type":"string","x-stream-index":"005.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"reaction.new","type":"string","x-stream-index":"006.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"ReactionNewEvent","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"},"ReactionRequest":{"description":"Represents user reaction to a message","properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"score":{"description":"Reaction score. If not specified reaction has score of 1","format":"int32","title":"Score","type":"integer","x-stream-index":"002"},"type":{"description":"The type of reaction (e.g. 'like', 'laugh', 'wow')","maxLength":30,"title":"Type","type":"string","x-stream-index":"001"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"004"}},"required":["type"],"title":"Reaction","type":"object","x-stream-docs-page-id":"send_reaction"},"ReactionResponse":{"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"006"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"008"},"message_id":{"description":"Message ID","title":"Message ID","type":"string","x-stream-index":"001"},"score":{"description":"Score of the reaction","format":"int32","title":"Score","type":"integer","x-stream-index":"005"},"type":{"description":"Type of reaction","title":"Type","type":"string","x-stream-index":"004"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"007"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User","title":"UserResponse","x-stream-index":"003"},"user_id":{"description":"User ID","title":"User ID","type":"string","x-stream-index":"002"}},"required":["message_id","user_id","user","type","score","created_at","updated_at","custom"],"type":"object"},"ReactionUpdatedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"006.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"002"},"team":{"type":"string","x-stream-index":"005.001"},"type":{"default":"reaction.updated","type":"string","x-stream-index":"006.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["message","reaction","cid","channel_id","channel_type","type","created_at"],"title":"ReactionUpdatedEvent","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"},"ReadReceipts":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"ReadReceiptsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"ReadStateResponse":{"properties":{"last_read":{"format":"date-time","type":"number","x-stream-index":"002"},"last_read_message_id":{"type":"string","x-stream-index":"004"},"unread_messages":{"format":"int32","type":"integer","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"}},"required":["user","last_read","unread_messages"],"type":"object"},"RecordSettings":{"properties":{"audio_only":{"type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"004"},"mode":{"type":"string","x-stream-index":"002"},"quality":{"type":"string","x-stream-index":"003"}},"required":["mode"],"type":"object"},"RecordSettingsResponse":{"description":"RecordSettings is the payload for recording settings","properties":{"audio_only":{"title":"Audio Only","type":"boolean","x-stream-index":"001"},"mode":{"title":"Mode","type":"string","x-stream-index":"002"},"quality":{"title":"Quality","type":"string","x-stream-index":"003"}},"required":["audio_only","mode","quality","layout"],"title":"RecordSettingsResponse","type":"object"},"RecordingEgressConfig":{"properties":{"audio_only":{"type":"boolean","x-stream-index":"006"},"composite_app_settings":{"$ref":"#/components/schemas/CompositeAppSettings","x-stream-index":"005"},"external_storage":{"$ref":"#/components/schemas/ExternalStorage","x-stream-index":"008"},"quality":{"$ref":"#/components/schemas/Quality","x-stream-index":"004"},"storage_name":{"type":"string","x-stream-index":"007"},"video_orientation_hint":{"$ref":"#/components/schemas/VideoOrientation","x-stream-index":"009"}},"type":"object"},"ReminderCreatedEvent":{"description":"Emitted when a reminder is created.","nullable":true,"properties":{"cid":{"description":"The CID of the Channel for which the reminder was created","title":"Channel CID","type":"string","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.007"},"message_id":{"description":"The ID of the message for which the reminder was created","title":"Message ID","type":"string","x-stream-index":"001.002"},"parent_id":{"description":"The ID of the parent message, if the reminder is for a thread message","title":"Parent ID","type":"string","x-stream-index":"001.005"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","description":"The reminder object which was created","title":"MessageReminder","x-stream-index":"001.006"},"type":{"default":"reminder.created","description":"The type of event: \"reminder.created\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.002"},"user_id":{"description":"The ID of the user for whom the reminder was created","title":"User ID","type":"string","x-stream-index":"001.003"}},"required":["type","created_at","custom","message_id","user_id","cid"],"title":"ReminderCreatedEvent","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"},"ReminderDeletedEvent":{"description":"Emitted when a reminder is deleted.","nullable":true,"properties":{"cid":{"description":"The CID of the Channel for which the reminder was created","title":"Channel CID","type":"string","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.007"},"message_id":{"description":"The ID of the message for which the reminder was created","title":"Message ID","type":"string","x-stream-index":"001.002"},"parent_id":{"description":"The ID of the parent message, if the reminder is for a thread message","title":"Parent ID","type":"string","x-stream-index":"001.005"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","description":"The reminder object which was created","title":"MessageReminder","x-stream-index":"001.006"},"type":{"default":"reminder.deleted","description":"The type of event: \"reminder.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.002"},"user_id":{"description":"The ID of the user for whom the reminder was created","title":"User ID","type":"string","x-stream-index":"001.003"}},"required":["type","created_at","custom","message_id","user_id","cid"],"title":"ReminderDeletedEvent","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"},"ReminderNotificationEvent":{"description":"Emitted when a reminder becomes due, triggering a notification for the user.","nullable":true,"properties":{"cid":{"description":"The CID of the Channel for which the reminder was created","title":"Channel CID","type":"string","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.007"},"message_id":{"description":"The ID of the message for which the reminder was created","title":"Message ID","type":"string","x-stream-index":"001.002"},"parent_id":{"type":"string","x-stream-index":"001.005"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","description":"The reminder object which was created","title":"MessageReminder","x-stream-index":"001.006"},"type":{"default":"notification.reminder_due","description":"The type of event: \"notification.reminder_due\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.002"},"user_id":{"description":"The ID of the user for whom the reminder was created","title":"User ID","type":"string","x-stream-index":"001.003"}},"required":["type","created_at","custom","message_id","user_id","cid"],"title":"ReminderNotificationEvent","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"},"ReminderResponseData":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003"},"channel_cid":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"005"},"message_id":{"type":"string","x-stream-index":"004"},"remind_at":{"format":"date-time","type":"number","x-stream-index":"001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007"},"user_id":{"type":"string","x-stream-index":"006"}},"required":["channel_cid","message_id","user_id","created_at","updated_at"],"type":"object"},"ReminderUpdatedEvent":{"description":"Emitted when a reminder is updated.","nullable":true,"properties":{"cid":{"description":"The CID of the Channel for which the reminder was created","title":"Channel CID","type":"string","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.007"},"message_id":{"description":"The ID of the message for which the reminder was created","title":"Message ID","type":"string","x-stream-index":"001.002"},"parent_id":{"description":"The ID of the parent message, if the reminder is for a thread message","title":"Parent ID","type":"string","x-stream-index":"001.005"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","description":"The reminder object which was created","title":"MessageReminder","x-stream-index":"001.006"},"type":{"default":"reminder.updated","description":"The type of event: \"reminder.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.002"},"user_id":{"description":"The ID of the user for whom the reminder was created","title":"User ID","type":"string","x-stream-index":"001.003"}},"required":["type","created_at","custom","message_id","user_id","cid"],"title":"ReminderUpdatedEvent","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"},"Response":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001"}},"required":["duration"],"title":"Response","type":"object"},"RestoreActionRequest":{"type":"object"},"ReviewQueueItem":{"properties":{"actions":{"items":{"$ref":"#/components/schemas/ActionLog"},"type":"array","x-stream-index":"035"},"activity":{"$ref":"#/components/schemas/EnrichedActivity","x-stream-index":"028"},"ai_text_severity":{"type":"string","x-stream-index":"021"},"archived_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"043"},"assigned_to":{"$ref":"#/components/schemas/User","x-stream-index":"032"},"bans":{"items":{"$ref":"#/components/schemas/Ban"},"type":"array","x-stream-index":"033"},"bounce_count":{"format":"int32","type":"integer","x-stream-index":"025"},"call":{"$ref":"#/components/schemas/Call","x-stream-index":"031"},"completed_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"018"},"config_key":{"type":"string","x-stream-index":"009"},"content_changed":{"type":"boolean","x-stream-index":"036"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"entity_creator":{"$ref":"#/components/schemas/EntityCreator","x-stream-index":"030"},"entity_id":{"type":"string","x-stream-index":"007"},"entity_type":{"type":"string","x-stream-index":"006"},"feeds_v2_activity":{"$ref":"#/components/schemas/EnrichedActivity","x-stream-index":"041"},"feeds_v2_reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"042"},"flag_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"045"},"flag_types":{"items":{"type":"string"},"type":"array","x-stream-index":"044"},"flags":{"items":{"$ref":"#/components/schemas/Flag"},"type":"array","x-stream-index":"034"},"flags_count":{"format":"int32","type":"integer","x-stream-index":"026"},"has_image":{"type":"boolean","x-stream-index":"012"},"has_text":{"type":"boolean","x-stream-index":"014"},"has_video":{"type":"boolean","x-stream-index":"013"},"id":{"type":"string","x-stream-index":"003"},"languages":{"items":{"type":"string"},"type":"array","x-stream-index":"019"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"027"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"010"},"moderation_payload_hash":{"type":"string","x-stream-index":"011"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"029"},"recommended_action":{"type":"string","x-stream-index":"017"},"reporter_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"046"},"reviewed_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"022"},"reviewed_by":{"type":"string","x-stream-index":"023"},"severity":{"format":"int32","type":"integer","x-stream-index":"020"},"status":{"type":"string","x-stream-index":"016"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"015"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"005"}},"required":["id","created_at","updated_at","entity_type","entity_id","config_key","moderation_payload_hash","has_image","has_video","has_text","teams","status","recommended_action","completed_at","languages","severity","ai_text_severity","reviewed_at","reviewed_by","bounce_count","flags_count","bans","flags","actions","content_changed","archived_at","flag_types","flag_labels","reporter_ids"],"type":"object"},"ReviewQueueItemResponse":{"nullable":true,"properties":{"actions":{"description":"Moderation actions taken","items":{"$ref":"#/components/schemas/ActionLogResponse"},"title":"Actions","type":"array","x-stream-index":"024"},"activity":{"$ref":"#/components/schemas/EnrichedActivity","x-stream-index":"016"},"ai_text_severity":{"description":"AI-determined text severity","title":"AI Text Severity","type":"string","x-stream-index":"014"},"assigned_to":{"$ref":"#/components/schemas/UserResponse","description":"Moderator assigned to review this item","title":"Assigned To","x-stream-index":"021"},"bans":{"description":"Associated ban records","items":{"$ref":"#/components/schemas/Ban"},"title":"Bans","type":"array","x-stream-index":"022"},"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"018"},"completed_at":{"description":"When the review was completed","format":"date-time","title":"Completed At","type":"number","x-stream-index":"009"},"config_key":{"type":"string","x-stream-index":"028"},"created_at":{"description":"When the item was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"002"},"entity_creator":{"$ref":"#/components/schemas/EntityCreatorResponse","description":"Details about who created the entity","title":"Entity Creator","x-stream-index":"019"},"entity_creator_id":{"description":"ID of who created the entity","title":"Entity Creator ID","type":"string","x-stream-index":"020"},"entity_id":{"description":"ID of the entity being reviewed","title":"Entity ID","type":"string","x-stream-index":"005"},"entity_type":{"description":"Type of entity being reviewed","title":"Entity Type","type":"string","x-stream-index":"004"},"feeds_v2_activity":{"$ref":"#/components/schemas/EnrichedActivity","description":"Associated feed activity","title":"Feeds V2 Activity","x-stream-index":"025"},"feeds_v2_reaction":{"$ref":"#/components/schemas/Reaction","description":"Associated feed reaction","title":"Feeds V2 Reaction","x-stream-index":"026"},"flags":{"description":"Associated flag records","items":{"$ref":"#/components/schemas/FlagResponse"},"title":"Flags","type":"array","x-stream-index":"023"},"flags_count":{"format":"int32","type":"integer","x-stream-index":"029"},"id":{"description":"Unique identifier of the review queue item","title":"ID","type":"string","x-stream-index":"001"},"languages":{"description":"Detected languages in the content","items":{"type":"string"},"title":"Languages","type":"array","x-stream-index":"012"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Associated message details","title":"Message","x-stream-index":"015"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content being moderated","title":"Moderation Payload","x-stream-index":"006"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"017"},"recommended_action":{"description":"Suggested moderation action","title":"Recommended Action","type":"string","x-stream-index":"008"},"reviewed_at":{"description":"When the item was reviewed","format":"date-time","title":"Reviewed At","type":"number","x-stream-index":"010"},"reviewed_by":{"description":"ID of the moderator who reviewed the item","title":"Reviewed By","type":"string","x-stream-index":"011"},"severity":{"description":"Severity level of the content","format":"int32","title":"Severity","type":"integer","x-stream-index":"013"},"status":{"description":"Current status of the review","title":"Status","type":"string","x-stream-index":"007"},"teams":{"description":"Teams associated with this item","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"027"},"updated_at":{"description":"When the item was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"003"}},"required":["id","created_at","updated_at","entity_type","entity_id","status","recommended_action","reviewed_by","languages","severity","ai_text_severity","bans","flags","actions","flags_count"],"type":"object"},"RingSettings":{"properties":{"auto_cancel_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_timeout_ms","missed_call_timeout_ms"],"type":"object"},"RingSettingsResponse":{"properties":{"auto_cancel_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_timeout_ms","missed_call_timeout_ms"],"type":"object"},"RuleBuilderAction":{"properties":{"ban_options":{"$ref":"#/components/schemas/BanOptions","x-stream-index":"002"},"flag_content_options":{"$ref":"#/components/schemas/FlagContentOptions","x-stream-index":"004"},"flag_user_options":{"$ref":"#/components/schemas/FlagUserOptions","x-stream-index":"003"},"remove_content_options":{"$ref":"#/components/schemas/BlockContentOptions","x-stream-index":"005"},"type":{"type":"string","x-stream-index":"001"}},"required":["type"],"type":"object"},"RuleBuilderCondition":{"properties":{"confidence":{"format":"float","type":"number","x-stream-index":"002"},"content_count_rule_params":{"$ref":"#/components/schemas/ContentCountRuleParameters","x-stream-index":"007"},"image_content_params":{"$ref":"#/components/schemas/ImageContentParameters","x-stream-index":"009"},"image_rule_params":{"$ref":"#/components/schemas/ImageRuleParameters","x-stream-index":"004"},"text_content_params":{"$ref":"#/components/schemas/TextContentParameters","x-stream-index":"008"},"text_rule_params":{"$ref":"#/components/schemas/TextRuleParameters","x-stream-index":"003"},"type":{"type":"string","x-stream-index":"001"},"user_created_within_params":{"$ref":"#/components/schemas/UserCreatedWithinParameters","x-stream-index":"011"},"user_rule_params":{"$ref":"#/components/schemas/UserRuleParameters","x-stream-index":"006"},"video_content_params":{"$ref":"#/components/schemas/VideoContentParameters","x-stream-index":"010"},"video_rule_params":{"$ref":"#/components/schemas/VideoRuleParameters","x-stream-index":"005"}},"required":["type"],"type":"object"},"RuleBuilderConditionGroup":{"properties":{"conditions":{"items":{"$ref":"#/components/schemas/RuleBuilderCondition"},"type":"array","x-stream-index":"002"},"logic":{"type":"string","x-stream-index":"001"}},"required":["logic","conditions"],"type":"object"},"RuleBuilderConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"rules":{"items":{"$ref":"#/components/schemas/RuleBuilderRule"},"type":"array","x-stream-index":"002"}},"required":["rules"],"type":"object"},"RuleBuilderRule":{"properties":{"action":{"$ref":"#/components/schemas/RuleBuilderAction","x-stream-index":"007"},"conditions":{"items":{"$ref":"#/components/schemas/RuleBuilderCondition"},"type":"array","x-stream-index":"004"},"cooldown_period":{"type":"string","x-stream-index":"009"},"enabled":{"type":"boolean","x-stream-index":"008"},"groups":{"items":{"$ref":"#/components/schemas/RuleBuilderConditionGroup"},"type":"array","x-stream-index":"006"},"id":{"type":"string","x-stream-index":"001"},"logic":{"type":"string","x-stream-index":"005"},"name":{"type":"string","x-stream-index":"002"},"rule_type":{"type":"string","x-stream-index":"003"}},"required":["id","name","rule_type","action","enabled"],"type":"object"},"SFUIDLastSeen":{"properties":{"id":{"type":"string","x-stream-index":"001.001"},"last_seen":{"format":"date-time","type":"number","x-stream-index":"002"},"process_start_time":{"format":"int64","type":"integer","x-stream-index":"001.002"}},"required":["id","process_start_time","last_seen"],"type":"object"},"STTEgressConfig":{"properties":{"closed_captions_enabled":{"type":"boolean","x-stream-index":"005"},"external_storage":{"$ref":"#/components/schemas/ExternalStorage","x-stream-index":"011"},"language":{"type":"string","x-stream-index":"008"},"storage_name":{"type":"string","x-stream-index":"010"},"translation_languages":{"items":{"type":"string"},"type":"array","x-stream-index":"009"},"translations_enabled":{"type":"boolean","x-stream-index":"006"},"upload_transcriptions":{"type":"boolean","x-stream-index":"004"},"whisper_server_base_url":{"type":"string","x-stream-index":"007"}},"type":"object"},"ScreensharingSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled"],"type":"object"},"ScreensharingSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled"],"type":"object"},"SearchPayload":{"properties":{"filter_conditions":{"additionalProperties":{},"description":"Channel filter conditions","maximum":100,"minimum":1,"title":"Channel filter","type":"object","x-stream-docs-page-id":"query_channels","x-stream-index":"002"},"limit":{"description":"Number of messages to return","format":"int32","title":"Limit","type":"integer","x-stream-index":"005"},"message_filter_conditions":{"additionalProperties":{},"description":"Message filter conditions","title":"Message filter","type":"object","x-stream-index":"003"},"message_options":{"$ref":"#/components/schemas/MessageOptions","x-stream-index":"004"},"next":{"description":"Pagination parameter. Cannot be used with non-zero offset.","title":"Next","type":"string","x-stream-index":"008"},"offset":{"description":"Pagination offset. Cannot be used with sort or next.","format":"int32","title":"Offset","type":"integer","x-stream-index":"006"},"query":{"description":"Search phrase","title":"Query","type":"string","x-stream-index":"001"},"sort":{"description":"Sort parameters. Cannot be used with non-zero offset","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"007"}},"required":["filter_conditions"],"type":"object"},"SearchResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"005.001"},"next":{"description":"Value to pass to the next search query in order to paginate","title":"Next","type":"string","x-stream-index":"003"},"previous":{"description":"Value that points to the previous page. Pass as the next value in a search query to paginate backwards","title":"Previous","type":"string","x-stream-index":"004"},"results":{"description":"Search results","items":{"$ref":"#/components/schemas/SearchResult"},"title":"Results","type":"array","x-stream-index":"001"},"results_warning":{"$ref":"#/components/schemas/SearchWarning","description":"Warning about the search results","title":"Results Warning","x-stream-index":"002"}},"required":["results","duration"],"type":"object"},"SearchResult":{"properties":{"message":{"$ref":"#/components/schemas/SearchResultMessage","description":"Found message","title":"Message","x-stream-index":"001"}},"type":"object"},"SearchResultMessage":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"001.008"},"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel object","title":"Channel","x-stream-index":"002"},"cid":{"type":"string","x-stream-index":"001.022"},"command":{"type":"string","x-stream-index":"001.004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.023"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.026"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.025"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"001.018"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001.041"},"html":{"type":"string","x-stream-index":"001.005"},"i18n":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.030"},"id":{"type":"string","x-stream-index":"001.001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"001.028"},"latest_reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"001.009"},"mentioned_users":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"001.029"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"001.036"},"mml":{"type":"string","x-stream-index":"001.003"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"001.039"},"own_reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"001.010"},"parent_id":{"type":"string","x-stream-index":"001.015"},"pin_expires":{"format":"date-time","type":"number","x-stream-index":"001.035"},"pinned":{"type":"boolean","x-stream-index":"001.032"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"001.033"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001.034"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001.038"},"poll_id":{"type":"string","x-stream-index":"001.037"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001.020"},"quoted_message_id":{"type":"string","x-stream-index":"001.019"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001.011"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"001.014"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001.012"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"001.042"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"001.017"},"restricted_visibility":{"items":{"type":"string"},"type":"array","x-stream-index":"001.040"},"shadowed":{"type":"boolean","x-stream-index":"001.027"},"shared_location":{"$ref":"#/components/schemas/SharedLocationResponseData","x-stream-index":"001.043"},"show_in_channel":{"type":"boolean","x-stream-index":"001.016"},"silent":{"type":"boolean","x-stream-index":"001.031"},"text":{"type":"string","x-stream-index":"001.002"},"thread_participants":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"001.021"},"type":{"type":"string","x-stream-index":"001.006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.024"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001.007"}},"required":["id","text","html","type","user","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned","restricted_visibility"],"type":"object"},"SearchWarning":{"properties":{"channel_search_cids":{"description":"Channel CIDs for the searched channels","items":{"type":"string"},"title":"Channel Search CIDs","type":"array","x-stream-index":"004"},"channel_search_count":{"description":"Number of channels searched","format":"int32","title":"Channel Search Count","type":"integer","x-stream-index":"003"},"warning_code":{"description":"Code corresponding to the warning","format":"int32","title":"Warning Code","type":"integer","x-stream-index":"002"},"warning_description":{"description":"Description of the warning","title":"Warning Description","type":"string","x-stream-index":"001"}},"required":["warning_description","warning_code"],"type":"object"},"SendEventRequest":{"nullable":true,"properties":{"event":{"$ref":"#/components/schemas/EventRequest","x-stream-index":"001"}},"required":["event"],"type":"object"},"SendMessageRequest":{"nullable":true,"properties":{"keep_channel_hidden":{"type":"boolean","x-stream-index":"008"},"message":{"$ref":"#/components/schemas/MessageRequest","x-stream-index":"001"},"skip_enrich_url":{"type":"boolean","x-stream-index":"003"},"skip_push":{"type":"boolean","x-stream-index":"002"}},"required":["message"],"type":"object"},"SendMessageResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Message response","title":"Message","x-stream-index":"001"},"pending_message_metadata":{"additionalProperties":{"type":"string"},"description":"Pending message metadata","title":"Pending message metadata","type":"object","x-stream-index":"002"}},"required":["message","duration"],"type":"object"},"SendReactionRequest":{"nullable":true,"properties":{"enforce_unique":{"description":"Whether to replace all existing user reactions","title":"Enforce unique","type":"boolean","x-stream-index":"003"},"reaction":{"$ref":"#/components/schemas/ReactionRequest","x-stream-index":"002"},"skip_push":{"description":"Skips any mobile push notifications","title":"Skip push","type":"boolean","x-stream-index":"004"}},"required":["reaction"],"type":"object"},"SendReactionResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001"},"reaction":{"$ref":"#/components/schemas/ReactionResponse","x-stream-index":"002"}},"required":["message","reaction","duration"],"title":"Response","type":"object"},"SessionSettings":{"properties":{"inactivity_timeout_seconds":{"format":"int32","maximum":900,"minimum":5,"type":"integer","x-stream-index":"001"}},"required":["inactivity_timeout_seconds"],"type":"object"},"SessionSettingsResponse":{"properties":{"inactivity_timeout_seconds":{"format":"int32","maximum":900,"minimum":5,"type":"integer","x-stream-index":"001"}},"required":["inactivity_timeout_seconds"],"type":"object"},"ShadowBlockActionRequest":{"type":"object"},"SharedLocation":{"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"013"},"channel_cid":{"type":"string","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"010"},"created_by_device_id":{"type":"string","x-stream-index":"008"},"end_at":{"format":"date-time","type":"number","x-stream-index":"009"},"latitude":{"format":"float","maximum":90,"minimum":18446744073709552000,"type":"number","x-stream-index":"006"},"longitude":{"format":"float","maximum":180,"minimum":18446744073709552000,"type":"number","x-stream-index":"007"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"012"},"message_id":{"type":"string","x-stream-index":"004"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"011"},"user_id":{"type":"string","x-stream-index":"005"}},"required":["channel_cid","message_id","user_id","created_by_device_id","created_at","updated_at"],"type":"object"},"SharedLocationResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001.011"},"channel_cid":{"description":"Channel CID","title":"string","type":"string","x-stream-index":"001.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.008"},"created_by_device_id":{"description":"Device ID that created the live location","title":"string","type":"string","x-stream-index":"001.006"},"duration":{"type":"string","x-stream-index":"002.001"},"end_at":{"description":"Time when the live location expires","format":"date-time","title":"string","type":"number","x-stream-index":"001.007"},"latitude":{"description":"Latitude coordinate","format":"float","title":"number","type":"number","x-stream-index":"001.004"},"longitude":{"description":"Longitude coordinate","format":"float","title":"number","type":"number","x-stream-index":"001.005"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001.010"},"message_id":{"description":"Message ID","title":"string","type":"string","x-stream-index":"001.002"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.009"},"user_id":{"description":"User ID","title":"string","type":"string","x-stream-index":"001.003"}},"required":["channel_cid","message_id","user_id","latitude","longitude","created_by_device_id","created_at","updated_at","duration"],"type":"object"},"SharedLocationResponseData":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"011"},"channel_cid":{"type":"string","x-stream-index":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"created_by_device_id":{"type":"string","x-stream-index":"006"},"end_at":{"format":"date-time","type":"number","x-stream-index":"007"},"latitude":{"format":"float","type":"number","x-stream-index":"004"},"longitude":{"format":"float","type":"number","x-stream-index":"005"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"010"},"message_id":{"type":"string","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["channel_cid","message_id","user_id","latitude","longitude","created_by_device_id","created_at","updated_at"],"type":"object"},"SharedLocationsResponse":{"nullable":true,"properties":{"active_live_locations":{"items":{"$ref":"#/components/schemas/SharedLocationResponseData"},"type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["active_live_locations","duration"],"type":"object"},"ShowChannelRequest":{"nullable":true,"type":"object"},"ShowChannelResponse":{"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"},"SortParamRequest":{"nullable":true,"properties":{"direction":{"description":"Direction of sorting, 1 for Ascending, -1 for Descending, default is 1","format":"int32","title":"Direction","type":"integer","x-stream-index":"002"},"field":{"description":"Name of field to sort by","title":"Field","type":"string","x-stream-index":"001"}},"type":"object"},"SubmitActionRequest":{"nullable":true,"properties":{"action_type":{"description":"Type of moderation action to perform (mark_reviewed, delete_message, etc.)","enum":["mark_reviewed","delete_message","delete_activity","delete_reaction","ban","custom","unban","restore","delete_user","unblock","shadow_block","unmask","kick_user","end_call"],"title":"Action Type","type":"string","x-stream-index":"002"},"ban":{"$ref":"#/components/schemas/BanActionRequest","description":"Configuration for ban action","title":"Ban","x-stream-index":"008"},"custom":{"$ref":"#/components/schemas/CustomActionRequest","description":"Configuration for custom action","title":"Custom","x-stream-index":"009"},"delete_activity":{"$ref":"#/components/schemas/DeleteActivityRequest","description":"Configuration for activity deletion action","title":"Delete Activity","x-stream-index":"004"},"delete_message":{"$ref":"#/components/schemas/DeleteMessageRequest","description":"Configuration for message deletion action","title":"Delete Message","x-stream-index":"003"},"delete_reaction":{"$ref":"#/components/schemas/DeleteReactionRequest","description":"Configuration for reaction deletion action","title":"Delete Reaction","x-stream-index":"005"},"delete_user":{"$ref":"#/components/schemas/DeleteUserRequest","description":"Configuration for user deletion action","title":"Delete User","x-stream-index":"006"},"item_id":{"description":"UUID of the review queue item to act on","title":"Item ID","type":"string","x-stream-index":"001"},"mark_reviewed":{"$ref":"#/components/schemas/MarkReviewedRequest","description":"Configuration for marking item as reviewed","title":"Mark Reviewed","x-stream-index":"007"},"unban":{"$ref":"#/components/schemas/UnbanActionRequest","description":"Configuration for unban action","title":"Unban","x-stream-index":"010"}},"required":["item_id","action_type"],"type":"object"},"SubmitActionResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"Updated review queue item after action was performed","title":"Item","x-stream-index":"001"}},"required":["duration"],"type":"object"},"SyncRequest":{"description":"Sync request","nullable":true,"properties":{"channel_cids":{"description":"List of channel CIDs to sync","items":{"type":"string"},"maximum":255,"minimum":1,"title":"Channel CIDs","type":"array","x-stream-index":"001"},"last_sync_at":{"description":"Date from which synchronization should happen","format":"date-time","title":"Last sync at","type":"number","x-stream-index":"002"}},"required":["channel_cids","last_sync_at"],"title":"SyncRequest","type":"object"},"SyncResponse":{"description":"Sync response","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"events":{"description":"List of events","items":{"$ref":"#/components/schemas/WSEvent"},"title":"Events","type":"array","x-stream-index":"001"},"inaccessible_cids":{"description":"List of CIDs that user can't access","items":{"type":"string"},"title":"Inaccessible CIDs","type":"array","x-stream-index":"002"}},"required":["events","duration"],"title":"SyncResponse","type":"object"},"TargetResolution":{"properties":{"bitrate":{"format":"int32","maximum":6000000,"type":"integer","x-stream-index":"003"},"height":{"format":"int32","maximum":3840,"minimum":240,"type":"integer","x-stream-index":"002"},"width":{"format":"int32","maximum":3840,"minimum":240,"type":"integer","x-stream-index":"001"}},"required":["width","height","bitrate"],"type":"object"},"TextContentParameters":{"properties":{"blocklist_match":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"contains_url":{"type":"boolean","x-stream-index":"002"},"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001"},"severity":{"type":"string","x-stream-index":"003"}},"type":"object"},"TextRuleParameters":{"properties":{"blocklist_match":{"items":{"type":"string"},"type":"array","x-stream-index":"006"},"contains_url":{"type":"boolean","x-stream-index":"004"},"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"severity":{"type":"string","x-stream-index":"005"},"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"required":["threshold","time_window"],"type":"object"},"ThreadParticipant":{"description":"Represents a user that is participating in a thread.","nullable":true,"properties":{"app_pk":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"001"},"channel_cid":{"type":"string","x-stream-index":"002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"007"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"last_read_at":{"format":"date-time","type":"number","x-stream-index":"009"},"last_thread_message_at":{"format":"date-time","type":"number","x-stream-index":"003"},"left_thread_at":{"description":"Left Thread At is the time when the user left the thread","format":"date-time","title":"Left Thread At","type":"number","x-stream-index":"008"},"thread_id":{"description":"Thead ID is unique string identifier of the thread","title":"ID","type":"string","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User is the user object","title":"User","x-stream-index":"006"},"user_id":{"description":"User ID is unique string identifier of the user","title":"User ID","type":"string","x-stream-index":"005"}},"required":["app_pk","channel_cid","created_at","last_read_at","custom"],"title":"ThreadParticipant","type":"object"},"ThreadResponse":{"properties":{"active_participant_count":{"description":"Active Participant Count","format":"int32","title":"Active Participant Count","type":"integer","x-stream-index":"009"},"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel","title":"ChannelResponse","x-stream-index":"002"},"channel_cid":{"description":"Channel CID","title":"Channel CID","type":"string","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"012"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"Created By User","title":"User","x-stream-index":"006"},"created_by_user_id":{"description":"Created By User ID","title":"Created By User ID","type":"string","x-stream-index":"005"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"016"},"deleted_at":{"description":"Deleted At","format":"date-time","title":"Deleted At","type":"number","x-stream-index":"014"},"last_message_at":{"description":"Last Message At","format":"date-time","title":"Last Message At","type":"number","x-stream-index":"011"},"parent_message":{"$ref":"#/components/schemas/MessageResponse","description":"Parent Message","title":"Message","x-stream-index":"004"},"parent_message_id":{"description":"Parent Message ID","title":"Parent Message ID","type":"string","x-stream-index":"003"},"participant_count":{"description":"Participant Count","format":"int32","title":"Participant Count","type":"integer","x-stream-index":"008"},"reply_count":{"description":"Reply Count","format":"int32","title":"Reply Count","type":"integer","x-stream-index":"007"},"thread_participants":{"description":"Thread Participants","items":{"$ref":"#/components/schemas/ThreadParticipant"},"title":"ThreadParticipants","type":"array","x-stream-index":"010"},"title":{"description":"Title","title":"Title","type":"string","x-stream-index":"015"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"013"}},"required":["channel_cid","parent_message_id","created_by_user_id","created_at","updated_at","title","custom"],"type":"object"},"ThreadStateResponse":{"nullable":true,"properties":{"active_participant_count":{"description":"Active Participant Count","format":"int32","title":"Active Participant Count","type":"integer","x-stream-index":"001.009"},"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel","title":"ChannelResponse","x-stream-index":"001.002"},"channel_cid":{"description":"Channel CID","title":"Channel CID","type":"string","x-stream-index":"001.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.012"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"Created By User","title":"User","x-stream-index":"001.006"},"created_by_user_id":{"description":"Created By User ID","title":"Created By User ID","type":"string","x-stream-index":"001.005"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"001.016"},"deleted_at":{"description":"Deleted At","format":"date-time","title":"Deleted At","type":"number","x-stream-index":"001.014"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"004"},"last_message_at":{"description":"Last Message At","format":"date-time","title":"Last Message At","type":"number","x-stream-index":"001.011"},"latest_replies":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","x-stream-index":"002"},"parent_message":{"$ref":"#/components/schemas/MessageResponse","description":"Parent Message","title":"Message","x-stream-index":"001.004"},"parent_message_id":{"description":"Parent Message ID","title":"Parent Message ID","type":"string","x-stream-index":"001.003"},"participant_count":{"description":"Participant Count","format":"int32","title":"Participant Count","type":"integer","x-stream-index":"001.008"},"read":{"items":{"$ref":"#/components/schemas/ReadStateResponse"},"type":"array","x-stream-index":"003"},"reply_count":{"description":"Reply Count","format":"int32","title":"Reply Count","type":"integer","x-stream-index":"001.007"},"thread_participants":{"description":"Thread Participants","items":{"$ref":"#/components/schemas/ThreadParticipant"},"title":"ThreadParticipants","type":"array","x-stream-index":"001.010"},"title":{"description":"Title","title":"Title","type":"string","x-stream-index":"001.015"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.013"}},"required":["channel_cid","parent_message_id","created_by_user_id","created_at","updated_at","title","custom","latest_replies"],"type":"object"},"ThreadUpdatedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"001.002"},"channel_type":{"type":"string","x-stream-index":"001.003"},"cid":{"type":"string","x-stream-index":"001.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"thread":{"$ref":"#/components/schemas/ThreadResponse","x-stream-index":"003.001"},"type":{"default":"thread.updated","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"ThreadUpdatedEvent","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"},"Thresholds":{"description":"Sets thresholds for AI moderation","properties":{"explicit":{"$ref":"#/components/schemas/LabelThresholds","description":"Thresholds for explicit messages","title":"LabelThresholds","x-stream-index":"001"},"spam":{"$ref":"#/components/schemas/LabelThresholds","description":"Thresholds for spam","title":"LabelThresholds","x-stream-index":"002"},"toxic":{"$ref":"#/components/schemas/LabelThresholds","description":"Thresholds for toxic messages","title":"LabelThresholds","x-stream-index":"003"}},"title":"Auto moderation thresholds","type":"object"},"ThumbnailResponse":{"properties":{"image_url":{"type":"string","x-stream-index":"001"}},"required":["image_url"],"type":"object"},"ThumbnailsSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"ThumbnailsSettingsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"Time":{"type":"object"},"TranscriptionSettings":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"title":"Mode","type":"string","x-stream-index":"002"},"language":{"description":"The language used in this call as a two letter code","enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"title":"Language","type":"string","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"title":"Mode","type":"string","x-stream-index":"001"}},"required":["mode","closed_caption_mode","languages","language"],"type":"object"},"TranscriptionSettingsResponse":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"002"},"language":{"enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"type":"string","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode","closed_caption_mode","languages","language"],"type":"object"},"TranslateMessageRequest":{"nullable":true,"properties":{"language":{"description":"Language to translate message to","enum":["af","sq","am","ar","az","bn","bs","bg","zh","zh-TW","hr","cs","da","fa-AF","nl","en","et","fi","fr","fr-CA","ka","de","el","ha","he","hi","hu","id","it","ja","ko","lv","ms","no","fa","ps","pl","pt","ro","ru","sr","sk","sl","so","es","es-MX","sw","sv","tl","ta","th","tr","uk","ur","vi","lt","ht"],"title":"Language","type":"string","x-stream-index":"001"}},"required":["language"],"type":"object"},"TruncateChannelRequest":{"nullable":true,"properties":{"hard_delete":{"description":"Permanently delete channel data (messages, reactions, etc.)","title":"Hard delete","type":"boolean","x-stream-index":"002"},"member_ids":{"description":"List of member IDs to hide message history for. If empty, truncates the channel for all members","items":{"type":"string"},"maximum":100,"title":"Member IDs","type":"array","x-stream-index":"007"},"message":{"$ref":"#/components/schemas/MessageRequest","x-stream-index":"004"},"skip_push":{"description":"When `message` is set disables all push notifications for it","title":"Skip push","type":"boolean","x-stream-index":"005"},"truncated_at":{"description":"Truncate channel data up to `truncated_at`. The system message (if provided) creation time is always greater than `truncated_at`","format":"date-time","title":"Truncated at","type":"number","x-stream-index":"006"}},"type":"object"},"TruncateChannelResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Truncated channel object","title":"Channel","x-stream-index":"002"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Truncated message object","title":"Message","x-stream-index":"003"}},"required":["duration"],"type":"object"},"TypingIndicators":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"TypingIndicatorsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"TypingStartEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"parent_id":{"type":"string","x-stream-index":"001"},"type":{"default":"typing.start","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"TypingStartEvent","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"},"TypingStopEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"parent_id":{"type":"string","x-stream-index":"001"},"type":{"default":"typing.stop","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"TypingStopEvent","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"},"UnbanActionRequest":{"type":"object"},"UnblockActionRequest":{"type":"object"},"UnblockUsersRequest":{"nullable":true,"properties":{"blocked_user_id":{"type":"string","x-stream-index":"001"}},"required":["blocked_user_id"],"type":"object"},"UnblockUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"UnmuteChannelRequest":{"nullable":true,"properties":{"channel_cids":{"description":"Channel CIDs to mute (if multiple channels)","items":{"type":"string"},"maximum":25,"title":"Channel CIDs","type":"array","x-stream-index":"001.002"},"expiration":{"description":"Duration of mute in milliseconds","title":"Expiration","type":"integer","x-stream-index":"001.003"}},"type":"object"},"UnmuteResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"non_existing_users":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"required":["duration"],"title":"Response","type":"object"},"UnreadCountsChannel":{"properties":{"channel_id":{"type":"string","x-stream-index":"001"},"last_read":{"format":"date-time","type":"number","x-stream-index":"003"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["channel_id","unread_count","last_read"],"type":"object"},"UnreadCountsChannelType":{"properties":{"channel_count":{"format":"int32","type":"integer","x-stream-index":"002"},"channel_type":{"type":"string","x-stream-index":"001"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["channel_type","channel_count","unread_count"],"type":"object"},"UnreadCountsThread":{"properties":{"last_read":{"format":"date-time","type":"number","x-stream-index":"002"},"last_read_message_id":{"type":"string","x-stream-index":"003"},"parent_message_id":{"type":"string","x-stream-index":"004"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"001"}},"required":["unread_count","last_read","last_read_message_id","parent_message_id"],"type":"object"},"UpdateBlockListRequest":{"nullable":true,"properties":{"team":{"type":"string","x-stream-index":"002"},"words":{"description":"List of words to block","items":{"type":"string"},"minimum":1,"title":"Words","type":"array","x-stream-index":"003"}},"title":"Update block list","type":"object","x-stream-docs-page-id":"update_block_list"},"UpdateBlockListResponse":{"description":"Basic response information","nullable":true,"properties":{"blocklist":{"$ref":"#/components/schemas/BlockListResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["duration"],"title":"Response","type":"object"},"UpdateChannelPartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"type":"object","x-stream-index":"002.001"},"unset":{"items":{"type":"string"},"type":"array","x-stream-index":"002.002"}},"title":"UpdateChannelPartialRequest","type":"object"},"UpdateChannelPartialResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Updated channel object","title":"Channel","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"members":{"description":"List of updated members","items":{"$ref":"#/components/schemas/ChannelMemberResponse"},"title":"ChannelMemberResponse","type":"array","x-stream-index":"002"}},"required":["members","duration"],"type":"object"},"UpdateChannelRequest":{"nullable":true,"properties":{"accept_invite":{"description":"Set to `true` to accept the invite","title":"Accept invite","type":"boolean","x-stream-index":"008"},"add_members":{"description":"List of user IDs to add to the channel","items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"title":"Add members","type":"array","x-stream-index":"001"},"add_moderators":{"description":"List of user IDs to make channel moderators","items":{"type":"string"},"maximum":100,"title":"Add moderators","type":"array","x-stream-index":"003"},"assign_roles":{"description":"List of channel member role assignments. If any specified user is not part of the channel, the request will fail","items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"title":"Assign roles","type":"array","x-stream-index":"006"},"cooldown":{"description":"Sets cool down period for the channel in seconds","format":"int32","maximum":120,"minimum":0,"title":"Cool down","type":"integer","x-stream-index":"007"},"data":{"$ref":"#/components/schemas/ChannelInput","x-stream-index":"013.001"},"demote_moderators":{"description":"List of user IDs to take away moderators status from","items":{"type":"string"},"maximum":100,"title":"Demote moderators","type":"array","x-stream-index":"004"},"hide_history":{"description":"Set to `true` to hide channel's history when adding new members","title":"Hide history","type":"boolean","x-stream-index":"012"},"invites":{"description":"List of user IDs to invite to the channel","items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"title":"Invites","type":"array","x-stream-index":"005"},"message":{"$ref":"#/components/schemas/MessageRequest","description":"Message to send to the chat when channel is successfully updated","title":"Message","x-stream-index":"010"},"reject_invite":{"description":"Set to `true` to reject the invite","title":"Reject invite","type":"boolean","x-stream-index":"009"},"remove_members":{"description":"List of user IDs to remove from the channel","items":{"type":"string"},"maximum":100,"title":"Remove members","type":"array","x-stream-index":"002"},"skip_push":{"description":"When `message` is set disables all push notifications for it","title":"Skip push","type":"boolean","x-stream-index":"011"}},"title":"Channel update request","type":"object","x-stream-docs-page-id":"channel_update"},"UpdateChannelResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Updated channel","title":"Channel","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"004.001"},"members":{"description":"List of channel members","items":{"$ref":"#/components/schemas/ChannelMember"},"title":"Members","type":"array","x-stream-index":"003"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Message sent to the chat","title":"Message","x-stream-index":"002"}},"required":["members","duration"],"type":"object"},"UpdateLiveLocationRequest":{"nullable":true,"properties":{"end_at":{"description":"Time when the live location expires","format":"date-time","title":"string","type":"number","x-stream-index":"004"},"latitude":{"description":"Latitude coordinate","format":"float","maximum":90,"minimum":18446744073709552000,"title":"number","type":"number","x-stream-index":"002"},"longitude":{"description":"Longitude coordinate","format":"float","maximum":180,"minimum":18446744073709552000,"title":"number","type":"number","x-stream-index":"003"},"message_id":{"description":"Live location ID","title":"string","type":"string","x-stream-index":"001"}},"required":["message_id"],"type":"object"},"UpdateMemberPartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"type":"object","x-stream-index":"002.001"},"unset":{"items":{"type":"string"},"type":"array","x-stream-index":"002.002"}},"type":"object"},"UpdateMemberPartialResponse":{"nullable":true,"properties":{"channel_member":{"$ref":"#/components/schemas/ChannelMemberResponse","description":"Updated channel member","title":"Channel member","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["duration"],"type":"object"},"UpdateMessagePartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"description":"Sets new field values","title":"Set","type":"object","x-stream-index":"002.001","x-stream-map":{"key":"field","title":"Value","description":"New value to set"}},"skip_enrich_url":{"description":"Skip enriching the URL in the message","title":"SkipEnrichURL","type":"boolean","x-stream-index":"001"},"unset":{"description":"Array of field names to unset","items":{"type":"string"},"title":"Unset","type":"array","x-stream-index":"002.002"}},"type":"object"},"UpdateMessagePartialResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Updated message","title":"Message","x-stream-index":"001"},"pending_message_metadata":{"additionalProperties":{"type":"string"},"description":"Pending message metadata","title":"PendingMessageMetadata","type":"object","x-stream-index":"002"}},"required":["duration"],"type":"object"},"UpdateMessageRequest":{"nullable":true,"properties":{"message":{"$ref":"#/components/schemas/MessageRequest","description":"Message","title":"MessageRequest","x-stream-index":"001"},"skip_enrich_url":{"description":"Skip enrich URL","title":"boolean","type":"boolean","x-stream-index":"003"},"skip_push":{"type":"boolean","x-stream-index":"002"}},"required":["message"],"type":"object"},"UpdateMessageResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001"},"pending_message_metadata":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"002"}},"required":["message","duration"],"title":"Response","type":"object"},"UpdatePollOptionRequest":{"nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"004"},"id":{"description":"Option ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"},"text":{"description":"Option text","title":"string","type":"string","x-stream-index":"003"}},"required":["id","text"],"type":"object"},"UpdatePollPartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"description":"Sets new field values","title":"Set","type":"object","x-stream-index":"002.001","x-stream-map":{"key":"field","title":"Value","description":"New value to set"}},"unset":{"description":"Array of field names to unset","items":{"type":"string"},"title":"Unset","type":"array","x-stream-index":"002.002"}},"type":"object"},"UpdatePollRequest":{"nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"011"},"allow_answers":{"description":"Allow answers","title":"boolean","type":"boolean","x-stream-index":"009"},"allow_user_suggested_options":{"description":"Allow user suggested options","title":"boolean","type":"boolean","x-stream-index":"008"},"description":{"description":"Poll description","title":"string","type":"string","x-stream-index":"003"},"enforce_unique_vote":{"description":"Enforce unique vote","title":"boolean","type":"boolean","x-stream-index":"005"},"id":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"},"is_closed":{"description":"Is closed","title":"boolean","type":"boolean","x-stream-index":"010"},"max_votes_allowed":{"description":"Max votes allowed","format":"int32","maximum":10,"title":"integer","type":"integer","x-stream-index":"007"},"name":{"description":"Poll name","title":"string","type":"string","x-stream-index":"002"},"options":{"description":"Poll options","items":{"$ref":"#/components/schemas/PollOptionRequest"},"maximum":100,"title":"PollOptions","type":"array","x-stream-index":"004"},"voting_visibility":{"description":"Voting visibility","enum":["anonymous","public"],"title":"string","type":"string","x-stream-index":"006"}},"required":["id","name"],"type":"object"},"UpdateReminderRequest":{"nullable":true,"properties":{"remind_at":{"format":"date-time","type":"number","x-stream-index":"001"}},"type":"object"},"UpdateReminderResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"001"}},"required":["reminder","duration"],"title":"Response","type":"object"},"UpdateThreadPartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"description":"Sets new field values","title":"Set","type":"object","x-stream-index":"004.001","x-stream-map":{"key":"field","title":"Value","description":"New value to set"}},"unset":{"description":"Array of field names to unset","items":{"type":"string"},"title":"Unset","type":"array","x-stream-index":"004.002"}},"type":"object"},"UpdateThreadPartialResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"thread":{"$ref":"#/components/schemas/ThreadResponse","description":"Updated thread (not enriched)","title":"Thread","x-stream-index":"001"}},"required":["thread","duration"],"type":"object"},"UpdateUserPartialRequest":{"properties":{"id":{"description":"User ID to update","title":"ID","type":"string","x-stream-index":"001"},"set":{"additionalProperties":{},"type":"object","x-stream-index":"002.001"},"unset":{"items":{"type":"string"},"type":"array","x-stream-index":"002.002"}},"required":["id"],"type":"object"},"UpdateUsersPartialRequest":{"nullable":true,"properties":{"users":{"items":{"$ref":"#/components/schemas/UpdateUserPartialRequest"},"maximum":100,"type":"array","x-stream-index":"001"}},"required":["users"],"type":"object"},"UpdateUsersRequest":{"nullable":true,"properties":{"users":{"additionalProperties":{"$ref":"#/components/schemas/UserRequest"},"description":"Object containing users","title":"Users","type":"object","x-stream-index":"001","x-stream-map":{"key":"user_id"}}},"required":["users"],"type":"object"},"UpdateUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"membership_deletion_task_id":{"type":"string","x-stream-index":"002"},"users":{"additionalProperties":{"$ref":"#/components/schemas/FullUserResponse"},"description":"Object containing users","title":"Users","type":"object","x-stream-index":"001","x-stream-map":{"key":"user_id"}}},"required":["users","membership_deletion_task_id","duration"],"type":"object"},"UpsertConfigRequest":{"nullable":true,"properties":{"ai_image_config":{"$ref":"#/components/schemas/AIImageConfig","description":"Configuration for AI image analysis","title":"AI Image Config","x-stream-index":"010"},"ai_text_config":{"$ref":"#/components/schemas/AITextConfig","description":"Configuration for AI text analysis","title":"AI Text Config","x-stream-index":"008"},"ai_video_config":{"$ref":"#/components/schemas/AIVideoConfig","description":"Configuration for AI video analysis","title":"AI Video Config","x-stream-index":"011"},"async":{"description":"Whether moderation should be performed asynchronously","title":"Async","type":"boolean","x-stream-index":"003"},"automod_platform_circumvention_config":{"$ref":"#/components/schemas/AutomodPlatformCircumventionConfig","description":"Configuration for platform circumvention detection","title":"Automod Platform Circumvention Config","x-stream-index":"005"},"automod_semantic_filters_config":{"$ref":"#/components/schemas/AutomodSemanticFiltersConfig","description":"Configuration for semantic filtering","title":"Automod Semantic Filters Config","x-stream-index":"006"},"automod_toxicity_config":{"$ref":"#/components/schemas/AutomodToxicityConfig","description":"Configuration for toxicity detection","title":"Automod Toxicity Config","x-stream-index":"004"},"aws_rekognition_config":{"$ref":"#/components/schemas/AIImageConfig","x-stream-index":"015"},"block_list_config":{"$ref":"#/components/schemas/BlockListConfig","description":"Configuration for block list filtering","title":"Block List Config","x-stream-index":"007"},"bodyguard_config":{"$ref":"#/components/schemas/AITextConfig","x-stream-index":"014"},"google_vision_config":{"$ref":"#/components/schemas/GoogleVisionConfig","description":"Configuration for Google Vision integration","title":"Google Vision Config","x-stream-index":"009"},"key":{"description":"Unique identifier for the moderation configuration","title":"Key","type":"string","x-stream-index":"001"},"rule_builder_config":{"$ref":"#/components/schemas/RuleBuilderConfig","description":"Configuration for custom rule builder (max 3 rules, max 5 conditions per rule)","title":"Rule Builder Config","x-stream-index":"013"},"team":{"description":"Team associated with the configuration","maxLength":128,"minLength":1,"title":"Team","type":"string","x-stream-index":"002"},"velocity_filter_config":{"$ref":"#/components/schemas/VelocityFilterConfig","description":"Configuration for velocity-based filtering","title":"Velocity Filter Config","x-stream-index":"012"},"video_call_rule_config":{"$ref":"#/components/schemas/VideoCallRuleConfig","x-stream-index":"016"}},"required":["key"],"type":"object"},"UpsertConfigResponse":{"nullable":true,"properties":{"config":{"$ref":"#/components/schemas/ConfigResponse","description":"The created or updated moderation configuration","title":"Config","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["duration"],"type":"object"},"UpsertPushPreferencesRequest":{"nullable":true,"properties":{"preferences":{"description":"A list of push preferences for channels, calls, or the user.","items":{"$ref":"#/components/schemas/PushPreferenceInput"},"type":"array","x-stream-index":"001"}},"required":["preferences"],"type":"object"},"UpsertPushPreferencesResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"user_channel_preferences":{"additionalProperties":{"additionalProperties":{"$ref":"#/components/schemas/ChannelPushPreferences"},"type":"object"},"description":"The channel specific push notification preferences, only returned for channels you've edited.","title":"User Channel Notification Preferences","type":"object","x-stream-index":"002"},"user_preferences":{"additionalProperties":{"$ref":"#/components/schemas/PushPreferences"},"description":"The user preferences, always returned regardless if you edited it","title":"User Preferences","type":"object","x-stream-index":"001"}},"required":["user_preferences","user_channel_preferences","duration"],"type":"object"},"User":{"properties":{"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"046"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"017"},"banned":{"type":"boolean","x-stream-index":"016"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"013"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"023"},"language":{"type":"string","x-stream-index":"035"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"026"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"042"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"005"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"009"}},"required":["id","role","teams_role","custom","banned","online"],"type":"object"},"UserBannedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"006.002"},"channel_type":{"type":"string","x-stream-index":"006.003"},"cid":{"type":"string","x-stream-index":"006.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008.002"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"001"},"expiration":{"format":"date-time","type":"number","x-stream-index":"003"},"reason":{"type":"string","x-stream-index":"004"},"shadow":{"type":"boolean","x-stream-index":"002"},"team":{"type":"string","x-stream-index":"005.001"},"type":{"default":"user.banned","type":"string","x-stream-index":"008.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007.001"}},"required":["created_by","shadow","cid","channel_id","channel_type","type","created_at"],"title":"UserBannedEvent","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"},"UserCreatedWithinParameters":{"properties":{"max_age":{"type":"string","x-stream-index":"001"}},"type":"object"},"UserDeactivatedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"001"},"type":{"default":"user.deactivated","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["created_by","type","created_at"],"title":"UserDeactivatedEvent","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"},"UserDeletedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"delete_conversation_channels":{"type":"boolean","x-stream-index":"005"},"hard_delete":{"type":"boolean","x-stream-index":"003.001"},"mark_messages_deleted":{"type":"boolean","x-stream-index":"004"},"type":{"default":"user.deleted","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"001.001"}},"required":["type","created_at","hard_delete","mark_messages_deleted","delete_conversation_channels"],"title":"UserDeletedEvent","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"},"UserMute":{"nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"expires":{"description":"Date/time of mute expiration","format":"date-time","title":"Expires","type":"number","x-stream-index":"008"},"target":{"$ref":"#/components/schemas/User","description":"User who's muted","title":"Target","x-stream-index":"007"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/User","description":"Owner of channel mute","title":"User","x-stream-index":"005"}},"required":["created_at","updated_at"],"type":"object"},"UserMuteResponse":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"expires":{"format":"date-time","type":"number","x-stream-index":"003"},"target":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"}},"required":["created_at","updated_at"],"type":"object"},"UserMutedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"target_user":{"type":"string","x-stream-index":"001"},"target_users":{"items":{"type":"string"},"type":"array","x-stream-index":"002"},"type":{"default":"user.muted","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"UserMutedEvent","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"},"UserPresenceChangedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"type":{"default":"user.presence.changed","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"001.001"}},"required":["type","created_at"],"title":"UserPresenceChangedEvent","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"},"UserReactivatedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"type":{"default":"user.reactivated","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"001"}},"required":["type","created_at"],"title":"UserReactivatedEvent","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"},"UserRequest":{"description":"User request object","properties":{"custom":{"additionalProperties":{},"description":"Custom user data","title":"Custom","type":"object","x-stream-index":"004"},"id":{"description":"User ID","title":"ID","type":"string","x-stream-index":"001"},"image":{"description":"User's profile image URL","title":"Image","type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"006"},"language":{"type":"string","x-stream-index":"005"},"name":{"description":"Optional name of user","title":"Name","type":"string","x-stream-index":"002"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"007"}},"required":["id"],"title":"UserRequest","type":"object"},"UserResponse":{"description":"User response object","properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"banned":{"description":"Whether a user is banned or not","title":"Banned","type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.017"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"001.004"},"deactivated_at":{"description":"Date of deactivation","format":"date-time","title":"Deactivated at","type":"number","x-stream-index":"001.016"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"001.011"},"id":{"description":"Unique user identifier","title":"ID","type":"string","x-stream-index":"001.001"},"image":{"title":"Image","type":"string","x-stream-index":"001.003"},"language":{"description":"Preferred language of a user","title":"Language","type":"string","x-stream-index":"001.005"},"last_active":{"description":"Date of last activity","format":"date-time","title":"Last active","type":"number","x-stream-index":"001.014"},"name":{"description":"Optional name of user","title":"Name","type":"string","x-stream-index":"001.002"},"online":{"description":"Whether a user online or not","title":"Online","type":"boolean","x-stream-index":"001.013"},"revoke_tokens_issued_before":{"description":"Revocation date for tokens","format":"date-time","title":"Revoke tokens issued before","type":"number","x-stream-index":"001.015"},"role":{"description":"Determines the set of user permissions","title":"Role","type":"string","x-stream-index":"001.006"},"teams":{"description":"List of teams user is a part of","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids","shadow_banned","invisible"],"title":"UserResponse","type":"object"},"UserResponseCommonFields":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"018"},"banned":{"type":"boolean","x-stream-index":"012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"017"},"created_at":{"format":"date-time","type":"number","x-stream-index":"009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"id":{"type":"string","x-stream-index":"001"},"image":{"type":"string","x-stream-index":"003"},"language":{"type":"string","x-stream-index":"005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"014"},"name":{"type":"string","x-stream-index":"002"},"online":{"type":"boolean","x-stream-index":"013"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"015"},"role":{"type":"string","x-stream-index":"006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids"],"type":"object"},"UserResponsePrivacyFields":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"banned":{"type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.017"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.011"},"id":{"type":"string","x-stream-index":"001.001"},"image":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"003"},"language":{"type":"string","x-stream-index":"001.005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"001.014"},"name":{"type":"string","x-stream-index":"001.002"},"online":{"type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"002"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.015"},"role":{"type":"string","x-stream-index":"001.006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids"],"type":"object"},"UserRuleParameters":{"properties":{"max_age":{"type":"string","x-stream-index":"001"}},"type":"object"},"UserUnbannedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"005.002"},"shadow":{"type":"boolean","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"004.001"},"type":{"default":"user.unbanned","type":"string","x-stream-index":"005.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["shadow","cid","channel_id","channel_type","type","created_at"],"title":"UserUnbannedEvent","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"},"UserUpdatedEvent":{"description":"This event is sent when a user gets updated. The event contains information about the updated user.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"type":{"default":"user.updated","description":"The type of event: \"user.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.002"},"user":{"$ref":"#/components/schemas/UserResponsePrivacyFields","description":"The updated user","title":"User","x-stream-index":"002.001"}},"required":["type","created_at","custom","user"],"title":"UserUpdatedEvent","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"},"UserWatchingStartEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"team":{"type":"string","x-stream-index":"002.001"},"type":{"default":"user.watching.start","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005.001"},"watcher_count":{"format":"int32","type":"integer","x-stream-index":"001.001"}},"required":["watcher_count","type","created_at","cid","channel_id","channel_type"],"title":"UserWatchingStartEvent","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"},"UserWatchingStopEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"type":{"default":"user.watching.stop","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"},"watcher_count":{"format":"int32","type":"integer","x-stream-index":"001.001"}},"required":["watcher_count","type","created_at","cid","channel_id","channel_type"],"title":"UserWatchingStopEvent","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"},"VelocityFilterConfig":{"properties":{"advanced_filters":{"type":"boolean","x-stream-index":"007"},"async":{"type":"boolean","x-stream-index":"001"},"cascading_actions":{"type":"boolean","x-stream-index":"004"},"cids_per_user":{"format":"int32","type":"integer","x-stream-index":"006"},"enabled":{"type":"boolean","x-stream-index":"002"},"first_message_only":{"type":"boolean","x-stream-index":"005"},"rules":{"items":{"$ref":"#/components/schemas/VelocityFilterConfigRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules","cascading_actions","first_message_only","cids_per_user","advanced_filters"],"type":"object"},"VelocityFilterConfigRule":{"properties":{"action":{"enum":["flag","shadow","remove","ban"],"type":"string","x-stream-index":"001"},"ban_duration":{"format":"int32","type":"integer","x-stream-index":"002"},"cascading_action":{"enum":["flag","shadow","remove","ban"],"type":"string","x-stream-index":"006"},"cascading_threshold":{"format":"int64","type":"integer","x-stream-index":"005"},"check_message_context":{"type":"boolean","x-stream-index":"009"},"fast_spam_threshold":{"format":"int32","type":"integer","x-stream-index":"007"},"fast_spam_ttl":{"format":"int32","type":"integer","x-stream-index":"010"},"ip_ban":{"type":"boolean","x-stream-index":"004"},"probation_period":{"format":"int32","type":"integer","x-stream-index":"014"},"shadow_ban":{"type":"boolean","x-stream-index":"003"},"slow_spam_ban_duration":{"format":"int32","type":"integer","x-stream-index":"012"},"slow_spam_threshold":{"format":"int32","type":"integer","x-stream-index":"008"},"slow_spam_ttl":{"format":"int32","type":"integer","x-stream-index":"011"},"url_only":{"type":"boolean","x-stream-index":"013"}},"required":["action","ban_duration","shadow_ban","ip_ban","cascading_threshold","cascading_action","fast_spam_threshold","slow_spam_threshold","check_message_context","fast_spam_ttl","slow_spam_ttl","url_only","probation_period"],"type":"object"},"VideoCallRuleConfig":{"properties":{"rules":{"additionalProperties":{"$ref":"#/components/schemas/HarmConfig"},"type":"object","x-stream-index":"001"}},"required":["rules"],"type":"object"},"VideoContentParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"type":"object"},"VideoEndCallRequest":{"type":"object"},"VideoKickUserRequest":{"type":"object"},"VideoOrientation":{"properties":{"orientation":{"type":"integer","x-stream-index":"004"}},"type":"object"},"VideoRuleParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"required":["threshold","time_window"],"type":"object"},"VideoSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"camera_default_on":{"type":"boolean","x-stream-index":"004"},"camera_facing":{"enum":["front","back","external"],"type":"string","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled","target_resolution","camera_default_on","camera_facing"],"type":"object"},"VideoSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"camera_default_on":{"type":"boolean","x-stream-index":"004"},"camera_facing":{"enum":["front","back","external"],"type":"string","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled","target_resolution","camera_default_on","camera_facing"],"type":"object"},"VoteData":{"properties":{"answer_text":{"type":"string","x-stream-index":"002"},"option_id":{"maxLength":255,"type":"string","x-stream-index":"001"}},"type":"object"},"WSAuthMessage":{"description":"Websocket auth message","nullable":true,"properties":{"products":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"token":{"title":"Token","type":"string","x-stream-index":"002"},"user_details":{"$ref":"#/components/schemas/ConnectUserDetailsRequest","x-stream-index":"001"}},"required":["user_details","token"],"title":"WSAuthMessage","type":"object"},"WSClientEvent":{"description":"The discriminator object for all websocket client events, it maps events' payload to the final type","discriminator":{"mapping":{"app.updated":"#/components/schemas/AppUpdatedEvent","draft.deleted":"#/components/schemas/DraftDeletedEvent","draft.updated":"#/components/schemas/DraftUpdatedEvent","health.check":"#/components/schemas/HealthCheckEvent","message.pending":"#/components/schemas/PendingMessageEvent","notification.reminder_due":"#/components/schemas/ReminderNotificationEvent","poll.closed":"#/components/schemas/PollClosedEvent","poll.deleted":"#/components/schemas/PollDeletedEvent","poll.updated":"#/components/schemas/PollUpdatedEvent","poll.vote_casted":"#/components/schemas/PollVoteCastedEvent","poll.vote_changed":"#/components/schemas/PollVoteChangedEvent","poll.vote_removed":"#/components/schemas/PollVoteRemovedEvent","reminder.created":"#/components/schemas/ReminderCreatedEvent","reminder.deleted":"#/components/schemas/ReminderDeletedEvent","reminder.updated":"#/components/schemas/ReminderUpdatedEvent","user.updated":"#/components/schemas/UserUpdatedEvent"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/AppUpdatedEvent"},{"$ref":"#/components/schemas/DraftDeletedEvent"},{"$ref":"#/components/schemas/DraftUpdatedEvent"},{"$ref":"#/components/schemas/HealthCheckEvent"},{"$ref":"#/components/schemas/PendingMessageEvent"},{"$ref":"#/components/schemas/PollClosedEvent"},{"$ref":"#/components/schemas/PollDeletedEvent"},{"$ref":"#/components/schemas/PollUpdatedEvent"},{"$ref":"#/components/schemas/PollVoteCastedEvent"},{"$ref":"#/components/schemas/PollVoteChangedEvent"},{"$ref":"#/components/schemas/PollVoteRemovedEvent"},{"$ref":"#/components/schemas/ReminderCreatedEvent"},{"$ref":"#/components/schemas/ReminderDeletedEvent"},{"$ref":"#/components/schemas/ReminderNotificationEvent"},{"$ref":"#/components/schemas/ReminderUpdatedEvent"},{"$ref":"#/components/schemas/UserUpdatedEvent"}]},"WSEvent":{"description":"The discriminator object for all websocket events, it maps events' payload to the final type","discriminator":{"mapping":{"*":"#/components/schemas/AnyEvent","activity.marked":"#/components/schemas/ActivityMarkedEvent","ai_indicator.clear":"#/components/schemas/AIIndicatorClearEvent","ai_indicator.stop":"#/components/schemas/AIIndicatorStopEvent","ai_indicator.update":"#/components/schemas/AIIndicatorUpdateEvent","app.updated":"#/components/schemas/AppUpdatedEvent","channel.created":"#/components/schemas/ChannelCreatedEvent","channel.deleted":"#/components/schemas/ChannelDeletedEvent","channel.frozen":"#/components/schemas/ChannelFrozenEvent","channel.hidden":"#/components/schemas/ChannelHiddenEvent","channel.kicked":"#/components/schemas/ChannelKickedEvent","channel.truncated":"#/components/schemas/ChannelTruncatedEvent","channel.unfrozen":"#/components/schemas/ChannelUnFrozenEvent","channel.updated":"#/components/schemas/ChannelUpdatedEvent","channel.visible":"#/components/schemas/ChannelVisibleEvent","draft.deleted":"#/components/schemas/DraftDeletedEvent","draft.updated":"#/components/schemas/DraftUpdatedEvent","health.check":"#/components/schemas/HealthCheckEvent","member.added":"#/components/schemas/MemberAddedEvent","member.removed":"#/components/schemas/MemberRemovedEvent","member.updated":"#/components/schemas/MemberUpdatedEvent","message.deleted":"#/components/schemas/MessageDeletedEvent","message.new":"#/components/schemas/MessageNewEvent","message.pending":"#/components/schemas/PendingMessageEvent","message.read":"#/components/schemas/MessageReadEvent","message.undeleted":"#/components/schemas/MessageUndeletedEvent","message.updated":"#/components/schemas/MessageUpdatedEvent","moderation.custom_action":"#/components/schemas/ModerationCustomActionEvent","moderation.flagged":"#/components/schemas/ModerationFlaggedEvent","moderation.mark_reviewed":"#/components/schemas/ModerationMarkReviewedEvent","notification.added_to_channel":"#/components/schemas/NotificationAddedToChannelEvent","notification.channel_deleted":"#/components/schemas/NotificationChannelDeletedEvent","notification.channel_mutes_updated":"#/components/schemas/NotificationChannelMutesUpdatedEvent","notification.channel_truncated":"#/components/schemas/NotificationChannelTruncatedEvent","notification.invite_accepted":"#/components/schemas/NotificationInviteAcceptedEvent","notification.invite_rejected":"#/components/schemas/NotificationInviteRejectedEvent","notification.invited":"#/components/schemas/NotificationInvitedEvent","notification.mark_read":"#/components/schemas/NotificationMarkReadEvent","notification.mark_unread":"#/components/schemas/NotificationMarkUnreadEvent","notification.message_new":"#/components/schemas/NotificationNewMessageEvent","notification.mutes_updated":"#/components/schemas/NotificationMutesUpdatedEvent","notification.reminder_due":"#/components/schemas/ReminderNotificationEvent","notification.removed_from_channel":"#/components/schemas/NotificationRemovedFromChannelEvent","notification.thread_message_new":"#/components/schemas/MessageNewEvent","poll.closed":"#/components/schemas/PollClosedEvent","poll.deleted":"#/components/schemas/PollDeletedEvent","poll.updated":"#/components/schemas/PollUpdatedEvent","poll.vote_casted":"#/components/schemas/PollVoteCastedEvent","poll.vote_changed":"#/components/schemas/PollVoteChangedEvent","poll.vote_removed":"#/components/schemas/PollVoteRemovedEvent","reaction.deleted":"#/components/schemas/ReactionDeletedEvent","reaction.new":"#/components/schemas/ReactionNewEvent","reaction.updated":"#/components/schemas/ReactionUpdatedEvent","reminder.created":"#/components/schemas/ReminderCreatedEvent","reminder.deleted":"#/components/schemas/ReminderDeletedEvent","reminder.updated":"#/components/schemas/ReminderUpdatedEvent","thread.updated":"#/components/schemas/ThreadUpdatedEvent","typing.start":"#/components/schemas/TypingStartEvent","typing.stop":"#/components/schemas/TypingStopEvent","user.banned":"#/components/schemas/UserBannedEvent","user.deactivated":"#/components/schemas/UserDeactivatedEvent","user.deleted":"#/components/schemas/UserDeletedEvent","user.muted":"#/components/schemas/UserMutedEvent","user.presence.changed":"#/components/schemas/UserPresenceChangedEvent","user.reactivated":"#/components/schemas/UserReactivatedEvent","user.unbanned":"#/components/schemas/UserUnbannedEvent","user.updated":"#/components/schemas/UserUpdatedEvent","user.watching.start":"#/components/schemas/UserWatchingStartEvent","user.watching.stop":"#/components/schemas/UserWatchingStopEvent"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/AIIndicatorClearEvent"},{"$ref":"#/components/schemas/AIIndicatorStopEvent"},{"$ref":"#/components/schemas/AIIndicatorUpdateEvent"},{"$ref":"#/components/schemas/ActivityMarkedEvent"},{"$ref":"#/components/schemas/AnyEvent"},{"$ref":"#/components/schemas/AppUpdatedEvent"},{"$ref":"#/components/schemas/ChannelCreatedEvent"},{"$ref":"#/components/schemas/ChannelDeletedEvent"},{"$ref":"#/components/schemas/ChannelFrozenEvent"},{"$ref":"#/components/schemas/ChannelHiddenEvent"},{"$ref":"#/components/schemas/ChannelKickedEvent"},{"$ref":"#/components/schemas/ChannelTruncatedEvent"},{"$ref":"#/components/schemas/ChannelUnFrozenEvent"},{"$ref":"#/components/schemas/ChannelUpdatedEvent"},{"$ref":"#/components/schemas/ChannelVisibleEvent"},{"$ref":"#/components/schemas/DraftDeletedEvent"},{"$ref":"#/components/schemas/DraftUpdatedEvent"},{"$ref":"#/components/schemas/HealthCheckEvent"},{"$ref":"#/components/schemas/MemberAddedEvent"},{"$ref":"#/components/schemas/MemberRemovedEvent"},{"$ref":"#/components/schemas/MemberUpdatedEvent"},{"$ref":"#/components/schemas/MessageDeletedEvent"},{"$ref":"#/components/schemas/MessageNewEvent"},{"$ref":"#/components/schemas/MessageNewEvent"},{"$ref":"#/components/schemas/MessageReadEvent"},{"$ref":"#/components/schemas/MessageUndeletedEvent"},{"$ref":"#/components/schemas/MessageUpdatedEvent"},{"$ref":"#/components/schemas/ModerationCustomActionEvent"},{"$ref":"#/components/schemas/ModerationFlaggedEvent"},{"$ref":"#/components/schemas/ModerationMarkReviewedEvent"},{"$ref":"#/components/schemas/NotificationAddedToChannelEvent"},{"$ref":"#/components/schemas/NotificationChannelDeletedEvent"},{"$ref":"#/components/schemas/NotificationChannelMutesUpdatedEvent"},{"$ref":"#/components/schemas/NotificationChannelTruncatedEvent"},{"$ref":"#/components/schemas/NotificationInviteAcceptedEvent"},{"$ref":"#/components/schemas/NotificationInviteRejectedEvent"},{"$ref":"#/components/schemas/NotificationInvitedEvent"},{"$ref":"#/components/schemas/NotificationMarkReadEvent"},{"$ref":"#/components/schemas/NotificationMarkUnreadEvent"},{"$ref":"#/components/schemas/NotificationMutesUpdatedEvent"},{"$ref":"#/components/schemas/NotificationNewMessageEvent"},{"$ref":"#/components/schemas/NotificationRemovedFromChannelEvent"},{"$ref":"#/components/schemas/PendingMessageEvent"},{"$ref":"#/components/schemas/PollClosedEvent"},{"$ref":"#/components/schemas/PollDeletedEvent"},{"$ref":"#/components/schemas/PollUpdatedEvent"},{"$ref":"#/components/schemas/PollVoteCastedEvent"},{"$ref":"#/components/schemas/PollVoteChangedEvent"},{"$ref":"#/components/schemas/PollVoteRemovedEvent"},{"$ref":"#/components/schemas/ReactionDeletedEvent"},{"$ref":"#/components/schemas/ReactionNewEvent"},{"$ref":"#/components/schemas/ReactionUpdatedEvent"},{"$ref":"#/components/schemas/ReminderCreatedEvent"},{"$ref":"#/components/schemas/ReminderDeletedEvent"},{"$ref":"#/components/schemas/ReminderNotificationEvent"},{"$ref":"#/components/schemas/ReminderUpdatedEvent"},{"$ref":"#/components/schemas/ThreadUpdatedEvent"},{"$ref":"#/components/schemas/TypingStartEvent"},{"$ref":"#/components/schemas/TypingStopEvent"},{"$ref":"#/components/schemas/UserBannedEvent"},{"$ref":"#/components/schemas/UserDeactivatedEvent"},{"$ref":"#/components/schemas/UserDeletedEvent"},{"$ref":"#/components/schemas/UserMutedEvent"},{"$ref":"#/components/schemas/UserPresenceChangedEvent"},{"$ref":"#/components/schemas/UserReactivatedEvent"},{"$ref":"#/components/schemas/UserUnbannedEvent"},{"$ref":"#/components/schemas/UserUpdatedEvent"},{"$ref":"#/components/schemas/UserWatchingStartEvent"},{"$ref":"#/components/schemas/UserWatchingStopEvent"}]},"WrappedUnreadCountsResponse":{"description":"Basic response information","nullable":true,"properties":{"channel_type":{"items":{"$ref":"#/components/schemas/UnreadCountsChannelType"},"type":"array","x-stream-index":"001.005"},"channels":{"items":{"$ref":"#/components/schemas/UnreadCountsChannel"},"type":"array","x-stream-index":"001.004"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"threads":{"items":{"$ref":"#/components/schemas/UnreadCountsThread"},"type":"array","x-stream-index":"001.006"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"001.001"},"total_unread_count_by_team":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001.003"},"total_unread_threads_count":{"format":"int32","type":"integer","x-stream-index":"001.002"}},"required":["total_unread_count","total_unread_threads_count","channels","channel_type","threads","duration"],"title":"Response","type":"object"}},"securitySchemes":{"JWT":{"description":"JWT should be always provided when stream-auth-type=jwt.\n\nUsing JWT auth request could be authenticated as user or as server-side.\n\nWhen using user authentication permission checking is going to be applied to requests based on the user that is\nperforming a request.\n\nThe `authorization` header should be a JWT string signed using the secret attached to the API key used to perform\nrequests.\n\n**WARNING** all client-side official SDK do not ship with token generation; this is to make sure that the API secret is not\nshared with an untrusted party such as a browser or a iOS/Android application. Tokens **must** be generated server-side.\nIf you wish, you can configure your application to ignore authentication (see `disable_auth_check`)\nThe JWT string must include only the user_id claim and can include any built-in JWT claim such as iat, exp as well.\n","in":"header","name":"Authorization","type":"apiKey"},"api_key":{"description":"Application API key should be always set in order to authenticate the request.","in":"query","name":"api_key","type":"apiKey"},"stream-auth-type":{"description":"Stream-Auth-Type should be always set in order to authenticate the request. Possible\nvalues: `jwt` or `anonymous`.\n\n`jwt` allows you to authenticate as a user. With this auth type you should also provide valid JWT in Authorization\nheader.\n\n`anonymous` allows you to authenticate as anonymous user. Please note that most advanced features are not available\nto anonymous users.","in":"header","name":"Stream-Auth-Type","type":"apiKey"}}},"info":{"title":"Stream API","version":"v187.13.0"},"openapi":"3.0.3","paths":{"/api/v2/app":{"get":{"description":"This Method returns the application settings\n","operationId":"GetApp","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetApplicationResponse"}}},"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":"Get App Settings","tags":["product:common"]}},"/api/v2/blocklists":{"get":{"description":"Returns all available block lists\n","operationId":"ListBlockLists","parameters":[{"in":"query","name":"team","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListBlockListResponse"}}},"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":"List block lists","tags":["product:common"]},"post":{"description":"Creates a new application blocklist, once created the blocklist can be used by any channel type\n","operationId":"CreateBlockList","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBlockListRequest"}}},"description":"Block list","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBlockListResponse"}}},"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":"Create block list","tags":["product:common"]}},"/api/v2/blocklists/{name}":{"delete":{"description":"Deletes previously created application blocklist\n","operationId":"DeleteBlockList","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"team","schema":{"type":"string","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete block list","tags":["product:common"]},"put":{"description":"Updates contents of the block list\n","operationId":"UpdateBlockList","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Block list name","title":"Name","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBlockListRequest"}}},"description":"Update block list","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBlockListResponse"}}},"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":"Update block list","tags":["product:common"]}},"/api/v2/chat/channels":{"post":{"description":"Query channels with filter query\n","operationId":"QueryChannels","parameters":[{"in":"query","name":"connection_id","schema":{"description":"Websocket connection ID to interact with. You can pass it as Body or URL parameter","title":"Connection ID","type":"string","x-stream-index":"011.003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryChannelsRequest"}}},"description":"Query Channels Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryChannelsResponse"}}},"description":"Channels list"},"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":"Query channels","tags":["product:chat"]}},"/api/v2/chat/channels/delete":{"post":{"description":"Allows to delete several channels at once asynchronously\n\nSends events:\n- channel.deleted\n- channel.deleted\n","operationId":"DeleteChannels","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteChannelsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteChannelsResponse"}}},"description":"Successful 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":"Deletes channels asynchronously","tags":["product:chat"]}},"/api/v2/chat/channels/read":{"post":{"description":"Marks channels as read up to the specific message. If no channels is given, mark all channel as read\n\nSends events:\n- message.read\n- message.read\n","operationId":"MarkChannelsRead","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkChannelsReadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkReadResponse"}}},"description":"Successful 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 channels as read","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/query":{"post":{"description":"This Method creates a channel or returns an existing one with matching attributes\n\nSends events:\n- channel.created\n- member.added\n- member.removed\n- member.updated\n- user.watching.start\n","operationId":"GetOrCreateDistinctChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"connection_id","schema":{"description":"Websocket connection ID to interact with. You can pass it as Body or URL parameter","title":"Connection ID","type":"string","x-stream-index":"012.003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelGetOrCreateRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelStateResponse"}}},"description":"Successful 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":"Get or create channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}":{"delete":{"description":"Deletes channel\n\nSends events:\n- channel.deleted\n- channel.deleted\n","operationId":"DeleteChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"query","name":"hard_delete","schema":{"type":"boolean","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteChannelResponse"}}},"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":"Delete channel","tags":["product:chat"]},"patch":{"description":"Updates certain fields of the channel\n\nSends events:\n- channel.updated\n- channel.updated\n","operationId":"UpdateChannelPartial","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelPartialRequest"}}},"description":"UpdateChannelPartialRequest","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelPartialResponse"}}},"description":"Successful 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":"Partially update channel","tags":["product:chat"]},"post":{"description":"Change channel data\n\nSends events:\n- channel.updated\n- member.added\n- member.removed\n- member.updated\n- message.new\n- channel.updated\n- member.added\n- member.removed\n- member.updated\n- message.new\n","operationId":"UpdateChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"013.002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"013.002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelRequest"}}},"description":"Channel update request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelResponse"}}},"description":"Successful 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":"Update channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/draft":{"delete":{"description":"Deletes a draft\n\nSends events:\n- draft.deleted\n","operationId":"DeleteDraft","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"parent_id","schema":{"description":"Parent message ID","title":"string","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete draft","tags":["product:chat"]},"get":{"description":"Get a draft\n","operationId":"GetDraft","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"parent_id","schema":{"description":"Parent message ID","title":"string","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetDraftResponse"}}},"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":"Get draft","tags":["product:chat"]},"post":{"description":"Creates a draft\n\nSends events:\n- draft.updated\n","operationId":"CreateDraft","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDraftRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDraftResponse"}}},"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":"Create a draft","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/event":{"post":{"description":"Sends event to the channel\n","operationId":"SendEvent","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendEventRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventResponse"}}},"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":"Send event","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/file":{"delete":{"description":"Deletes previously uploaded file\n","operationId":"DeleteFile","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of file","title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"File ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"url","schema":{"description":"File URL to delete","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete file","tags":["product:chat"]},"post":{"description":"Uploads file\n","operationId":"UploadFile","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/FileUploadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileUploadResponse"}}},"description":"Successful 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":"Upload file","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/hide":{"post":{"description":"Marks channel as hidden for current user\n\nSends events:\n- channel.hidden\n- channel.hidden\n","operationId":"HideChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HideChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HideChannelResponse"}}},"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":"Hide channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/image":{"delete":{"description":"Deletes previously uploaded image\n","operationId":"DeleteImage","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of file","title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"File ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"url","schema":{"description":"File URL to delete","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete image","tags":["product:chat"]},"post":{"description":"Uploads image\n","operationId":"UploadImage","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.001.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.001.002"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/ImageUploadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageUploadResponse"}}},"description":"Successful 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":"Upload image","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/member":{"patch":{"description":"\n","operationId":"UpdateMemberPartial","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMemberPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMemberPartialResponse"}}},"description":"Successful 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":"Partially channel member update","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/message":{"post":{"description":"Sends new message to the specified channel\n\nSends events:\n- message.new\n- message.updated\n- message.new\n- message.updated\n","operationId":"SendMessage","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"009.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"009.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendMessageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendMessageResponse"}}},"description":"Successful 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":"Send new message","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/messages":{"get":{"description":"Returns list messages found by IDs\n","operationId":"GetManyMessages","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"ids","required":true,"schema":{"description":"List of comma-separated IDs","items":{"type":"string"},"maximum":50,"minimum":1,"title":"IDs","type":"array","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetManyMessagesResponse"}}},"description":"Successful 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":"Get many messages","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/query":{"post":{"description":"This Method creates a channel or returns an existing one with matching attributes\n\nSends events:\n- channel.created\n- member.added\n- member.removed\n- member.updated\n- user.watching.start\n","operationId":"GetOrCreateChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID (maximum length of 64 characters)","title":"ID","type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"connection_id","schema":{"description":"Websocket connection ID to interact with. You can pass it as Body or URL parameter","title":"Connection ID","type":"string","x-stream-index":"012.003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelGetOrCreateRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelStateResponse"}}},"description":"Successful 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":"Get or create channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/read":{"post":{"description":"Marks channel as read up to the specific message\n\nSends events:\n- message.read\n- message.read\n","operationId":"MarkRead","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkReadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkReadResponse"}}},"description":"Successful 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 read","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/show":{"post":{"description":"Shows previously hidden channel\n\nSends events:\n- channel.visible\n- channel.visible\n","operationId":"ShowChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShowChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShowChannelResponse"}}},"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":"Show channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/stop-watching":{"post":{"description":"Call this Method to stop receiving channel events\n\nSends events:\n- user.watching.stop\n- user.watching.stop\n","operationId":"StopWatchingChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"connection_id","schema":{"type":"string","x-stream-index":"001.003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelStopWatchingRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Stop watching channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/truncate":{"post":{"description":"Truncates messages from a channel. Can be applied to the entire channel or scoped to specific members.\n\nSends events:\n- channel.truncated\n- channel.truncated\n","operationId":"TruncateChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TruncateChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TruncateChannelResponse"}}},"description":"Successful 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":"Truncate channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/unread":{"post":{"description":"Marks channel as unread from a specific message\n","operationId":"MarkUnread","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkUnreadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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 unread","tags":["product:chat"]}},"/api/v2/chat/drafts/query":{"post":{"description":"Queries draft messages for a user\n","operationId":"QueryDrafts","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryDraftsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryDraftsResponse"}}},"description":"Successful 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":"Query draft messages","tags":["product:chat"]}},"/api/v2/chat/members":{"get":{"description":"Find and filter channel members\n","operationId":"QueryMembers","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryMembersPayload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MembersResponse"}}},"description":"Successful 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":"Query members","tags":["product:chat"]}},"/api/v2/chat/messages/{id}":{"delete":{"description":"Deletes message\n\nSends events:\n- message.deleted\n- message.deleted\n","operationId":"DeleteMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID to delete","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"hard","schema":{"description":"Delete all message reactions and replies as well","title":"Hard","type":"boolean","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"deleted_by","schema":{"type":"string","writeOnly":true,"x-stream-index":"003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteMessageResponse"}}},"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":"Delete message","tags":["product:chat"]},"get":{"description":"Returns message by ID\n","operationId":"GetMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"ID of the message","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetMessageResponse"}}},"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":"Get message","tags":["product:chat"]},"post":{"description":"Updates message with new data\n\nSends events:\n- message.updated\n- message.updated\n","operationId":"UpdateMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"004.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessageResponse"}}},"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":"Update message","tags":["product:chat"]},"put":{"description":"Updates certain fields of the message\n\nSends events:\n- message.updated\n- message.updated\n","operationId":"UpdateMessagePartial","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessagePartialRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessagePartialResponse"}}},"description":"Successful 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":"Partially message update","tags":["product:chat"]}},"/api/v2/chat/messages/{id}/action":{"post":{"description":"Executes message command action with given parameters\n\nSends events:\n- message.new\n- message.new\n","operationId":"RunMessageAction","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageActionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}},"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":"Run message command action","tags":["product:chat"]}},"/api/v2/chat/messages/{id}/reaction":{"post":{"description":"Sends reaction to specified message\n\nSends events:\n- reaction.new\n- reaction.updated\n","operationId":"SendReaction","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID to send reaction for","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendReactionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendReactionResponse"}}},"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":"Send reaction","tags":["product:chat"]}},"/api/v2/chat/messages/{id}/reaction/{type}":{"delete":{"description":"Removes user reaction from the message\n\nSends events:\n- reaction.deleted\n","operationId":"DeleteReaction","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID to remove reaction from","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"type","required":true,"schema":{"description":"Reaction type to remove","title":"Type","type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"description":"**Server-side only**. User ID which server acts upon","title":"User ID","type":"string","writeOnly":true,"x-stream-index":"003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteReactionResponse"}}},"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":"Delete reaction","tags":["product:chat"]}},"/api/v2/chat/messages/{id}/reactions":{"get":{"description":"Returns list of reactions of specific message\n","operationId":"GetReactions","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"limit","schema":{"description":"Number of records to return","format":"int32","title":"Limit","type":"integer","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"offset","schema":{"description":"Number of records to offset","format":"int32","title":"Offset","type":"integer","writeOnly":true,"x-stream-index":"003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetReactionsResponse"}}},"description":"Successful 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":"Get reactions","tags":["product:chat"]},"post":{"description":"Get reactions on a message\n","operationId":"QueryReactions","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryReactionsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryReactionsResponse"}}},"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"}},"tags":["product:chat"]}},"/api/v2/chat/messages/{id}/translate":{"post":{"description":"Translates message to a given language using automated translation software\n\nSends events:\n- message.updated\n- message.updated\n","operationId":"TranslateMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TranslateMessageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}},"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":"Translate message","tags":["product:chat"]}},"/api/v2/chat/messages/{message_id}/polls/{poll_id}/vote":{"post":{"description":"Cast a vote on a poll\n\nSends events:\n- feeds.poll.vote_casted\n- feeds.poll.vote_changed\n- feeds.poll.vote_removed\n- poll.vote_casted\n- poll.vote_changed\n- poll.vote_removed\n","operationId":"CastPollVote","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CastPollVoteRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollVoteResponse"}}},"description":"Successful 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":"Cast vote","tags":["product:chat"]}},"/api/v2/chat/messages/{message_id}/polls/{poll_id}/vote/{vote_id}":{"delete":{"description":"Delete a vote from a poll\n\nSends events:\n- feeds.poll.vote_removed\n- poll.vote_removed\n","operationId":"DeletePollVote","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"004"}},{"in":"path","name":"vote_id","required":true,"schema":{"description":"Vote ID","maxLength":255,"title":"string","type":"string","x-stream-index":"005"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollVoteResponse"}}},"description":"Successful 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":"Delete vote","tags":["product:chat"]}},"/api/v2/chat/messages/{message_id}/reminders":{"delete":{"description":"Deletes a user's created reminder\n\nSends events:\n- reminder.deleted\n","operationId":"DeleteReminder","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteReminderResponse"}}},"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":"Delete reminder","tags":["product:chat"]},"patch":{"description":"Updates an existing reminder\n\nSends events:\n- reminder.updated\n","operationId":"UpdateReminder","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateReminderRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateReminderResponse"}}},"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":"Updates Reminder","tags":["product:chat"]},"post":{"description":"Creates a new reminder\n\nSends events:\n- reminder.created\n","operationId":"CreateReminder","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateReminderRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReminderResponseData"}}},"description":"Successful 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":"Create reminder","tags":["product:chat"]}},"/api/v2/chat/messages/{parent_id}/replies":{"get":{"description":"Returns replies (thread) of the message\n","operationId":"GetReplies","parameters":[{"in":"path","name":"parent_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"sort","schema":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":1,"type":"array","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"limit","schema":{"description":"The maximum number of messages to return (max limit ","format":"int32","minimum":0,"title":"Limit","type":"integer","x-stream-index":"003.001"}},{"in":"query","name":"offset","schema":{"description":"The offset to start from","format":"int32","title":"Offset","type":"integer","x-stream-index":"003.002"}},{"in":"query","name":"id_gte","schema":{"description":"The ID of the message to get messages with a timestamp greater than or equal to","title":"IDGTE","type":"string","x-stream-index":"003.003"}},{"in":"query","name":"id_gt","schema":{"description":"The ID of the message to get messages with a timestamp greater than","title":"IDGT","type":"string","x-stream-index":"003.004"}},{"in":"query","name":"id_lte","schema":{"description":"The ID of the message to get messages with a timestamp smaller than or equal to","title":"IDLTE","type":"string","x-stream-index":"003.005"}},{"in":"query","name":"id_lt","schema":{"description":"The ID of the message to get messages with a timestamp smaller than","title":"IDLT","type":"string","x-stream-index":"003.006"}},{"in":"query","name":"created_at_after_or_equal","schema":{"description":"The timestamp to get messages with a created_at timestamp greater than or equal to","format":"date-time","title":"Created_at after or equal","type":"number","x-stream-index":"003.007"}},{"in":"query","name":"created_at_after","schema":{"description":"The timestamp to get messages with a created_at timestamp greater than","format":"date-time","title":"Created_at after","type":"number","x-stream-index":"003.008"}},{"in":"query","name":"created_at_before_or_equal","schema":{"description":"The timestamp to get messages with a created_at timestamp smaller than or equal to","format":"date-time","title":"Created_at after before or equal","type":"number","x-stream-index":"003.009"}},{"in":"query","name":"created_at_before","schema":{"description":"The timestamp to get messages with a created_at timestamp smaller than","format":"date-time","title":"Created_at after before","type":"number","x-stream-index":"003.010"}},{"in":"query","name":"id_around","schema":{"description":"The result will be a set of messages, that are both older and newer than the message with the provided ID, and the message with the ID provided will be in the middle of the set","title":"Id around","type":"string","x-stream-index":"003.011"}},{"in":"query","name":"created_at_around","schema":{"description":"The result will be a set of messages, that are both older and newer than the created_at timestamp provided, distributed evenly around the timestamp","format":"date-time","title":"Created_at around","type":"number","x-stream-index":"003.012"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRepliesResponse"}}},"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":"Get replies","tags":["product:chat"]}},"/api/v2/chat/moderation/flags/message":{"get":{"description":"Find and filter message flags\n","operationId":"QueryMessageFlags","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryMessageFlagsPayload","description":"JSON object with query message flags payload","title":"Payload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryMessageFlagsResponse"}}},"description":"QueryMessageFlagsResponse"},"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":"Query Message Flags","tags":["product:chat"]}},"/api/v2/chat/moderation/mute/channel":{"post":{"description":"Mutes channel for user\n\nSends events:\n- channel.muted\n- channel.muted\n","operationId":"MuteChannel","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteChannelResponse"}}},"description":"Successful 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":"Mute channel","tags":["product:chat"]}},"/api/v2/chat/moderation/unmute/channel":{"post":{"description":"Unmutes channel for user\n\nSends events:\n- channel.unmuted\n- channel.unmuted\n","operationId":"UnmuteChannel","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnmuteChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnmuteResponse"}}},"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":"Unmute channel","tags":["product:chat"]}},"/api/v2/chat/push_preferences":{"post":{"description":"Update the push preferences for a user and or channel member. Set to all, mentions or none\n","operationId":"UpdatePushNotificationPreferences","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertPushPreferencesRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertPushPreferencesResponse"}}},"description":"Successful 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":"Push notification preferences","tags":["product:chat"]}},"/api/v2/chat/query_banned_users":{"get":{"description":"Find and filter channel scoped or global user bans\n","operationId":"QueryBannedUsers","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryBannedUsersPayload","description":"JSON object with query user bans payload","title":"Payload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryBannedUsersResponse"}}},"description":"Successful 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":"Query Banned Users","tags":["product:chat"]}},"/api/v2/chat/reminders/query":{"post":{"description":"Queries reminders\n","operationId":"QueryReminders","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryRemindersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryRemindersResponse"}}},"description":"Successful 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":"Query reminders","tags":["product:chat"]}},"/api/v2/chat/search":{"get":{"description":"Search messages across channels\n","operationId":"Search","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchPayload","description":"JSON object with search payload","title":"Payload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchResponse"}}},"description":"Successful 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":"Search messages","tags":["product:chat"]}},"/api/v2/chat/sync":{"post":{"description":"Returns all events happened since client disconnect in specified channels\n","operationId":"Sync","parameters":[{"in":"query","name":"with_inaccessible_cids","schema":{"description":"If set to true this will add 'inaccessible_cids' to response type","title":"With inaccessible CIDs","type":"boolean","x-stream-index":"003"}},{"in":"query","name":"watch","schema":{"description":"If set to true this will start watching requested and newly added channels that user has access to. If error occurred with this option enabled and it is not an input error - channels will still be watched.","title":"Watch synced channels","type":"boolean","x-stream-index":"004"}},{"in":"query","name":"connection_id","schema":{"type":"string","x-stream-index":"006.003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncRequest"}}},"description":"SyncRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncResponse"}}},"description":"SyncResponse"},"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":"Sync","tags":["product:chat"]}},"/api/v2/chat/threads":{"post":{"description":"Returns the list of threads for specific user\n","operationId":"QueryThreads","parameters":[{"in":"query","name":"connection_id","schema":{"type":"string","x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryThreadsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryThreadsResponse"}}},"description":"Successful 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":"Query Threads","tags":["product:chat"]}},"/api/v2/chat/threads/{message_id}":{"get":{"description":"Return a specific thread\n","operationId":"GetThread","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"watch","schema":{"description":"Start watching the channel this thread belongs to","title":"Watch","type":"boolean","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"connection_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"003"}},{"in":"query","name":"reply_limit","schema":{"description":"Limit the number of replies returned","format":"int32","minimum":0,"title":"Reply limit","type":"integer","writeOnly":true,"x-stream-index":"004"}},{"in":"query","name":"participant_limit","schema":{"description":"Limit the number of participants returned","format":"int32","maximum":100,"minimum":0,"title":"Participant limit","type":"integer","writeOnly":true,"x-stream-index":"005"}},{"in":"query","name":"member_limit","schema":{"description":"Limit the number of members returned per thread channel","format":"int32","maximum":100,"minimum":0,"title":"Member limit","type":"integer","writeOnly":true,"x-stream-index":"006"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetThreadResponse"}}},"description":"Successful 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":"Get Thread","tags":["product:chat"]},"patch":{"description":"Updates certain fields of the thread\n\nSends events:\n- thread.updated\n- thread.updated\n","operationId":"UpdateThreadPartial","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateThreadPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateThreadPartialResponse"}}},"description":"Successful 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":"Partially update thread","tags":["product:chat"]}},"/api/v2/chat/unread":{"get":{"description":"Fetch unread counts for a single user\n","operationId":"UnreadCounts","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WrappedUnreadCountsResponse"}}},"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":"Unread counts","tags":["product:chat"]}},"/api/v2/devices":{"delete":{"description":"Deletes one device\n","operationId":"DeleteDevice","parameters":[{"in":"query","name":"id","required":true,"schema":{"description":"Device ID to delete","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete device","tags":["product:common"]},"get":{"description":"Returns all available devices\n","operationId":"ListDevices","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDevicesResponse"}}},"description":"ListDevicesResponse"},"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":"List devices","tags":["product:common"]},"post":{"description":"Adds a new device to a user, if the same device already exists the call will have no effect\n","operationId":"CreateDevice","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDeviceRequest"}}},"description":"CreateDeviceRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Create device","tags":["product:common"]}},"/api/v2/guest":{"post":{"description":"\n","operationId":"CreateGuest","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGuestRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGuestResponse"}}},"description":"Successful 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":"Create Guest","tags":["product:common"]}},"/api/v2/longpoll":{"get":{"description":"WebSocket fallback transport endpoint\n\nSends events:\n- user.updated\n","operationId":"LongPoll","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WSAuthMessage","x-stream-index":"001"}}},"in":"query","name":"json"},{"in":"query","name":"connection_id","schema":{"maxLength":36,"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"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":"Long Poll (Transport)","tags":["product:common"]}},"/api/v2/moderation/ban":{"post":{"description":"Ban a user from a channel or the entire app\n","operationId":"ban","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BanRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BanResponse"}}},"description":"Successful 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":"Ban","tags":["product:moderation"]}},"/api/v2/moderation/config":{"post":{"description":"Create a new moderation configuration or update an existing one. Configure settings for content filtering, AI analysis, toxicity detection, and other moderation features.\n","operationId":"upsert_config","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertConfigRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertConfigResponse"}}},"description":"Successful 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":"Create or update moderation configuration","tags":["product:moderation"]}},"/api/v2/moderation/config/{key}":{"delete":{"description":"Delete a specific moderation policy by its name\n","operationId":"delete_config","parameters":[{"in":"path","name":"key","required":true,"schema":{"description":"Key of the moderation configuration to delete","title":"Key","type":"string","x-stream-index":"001"}},{"in":"query","name":"team","schema":{"description":"Team associated with the configuration","title":"Team","type":"string","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteModerationConfigResponse"}}},"description":"Successful 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":"Delete a moderation policy","tags":["product:moderation"]},"get":{"description":"Retrieve a specific moderation configuration by its key and team. This configuration contains settings for various moderation features like toxicity detection, AI analysis, and filtering rules.\n","operationId":"get_config","parameters":[{"in":"path","name":"key","required":true,"schema":{"description":"Key of the moderation configuration to retrieve","title":"Key","type":"string","x-stream-index":"001"}},{"in":"query","name":"team","schema":{"description":"Team associated with the configuration","title":"Team","type":"string","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetConfigResponse"}}},"description":"Successful 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":"Get moderation configuration","tags":["product:moderation"]}},"/api/v2/moderation/configs":{"post":{"description":"Search and filter moderation configurations across your application. This endpoint is designed for building moderation dashboards and managing multiple configuration sets.\n","operationId":"query_moderation_configs","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationConfigsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationConfigsResponse"}}},"description":"Successful 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":"Query moderation configurations","tags":["product:moderation"]}},"/api/v2/moderation/flag":{"post":{"description":"Flag any type of content (messages, users, channels, activities) for moderation review. Supports custom content types and additional metadata for flagged content.\n","operationId":"flag","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlagRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlagResponse"}}},"description":"Successful 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":"Flag content for moderation","tags":["product:moderation"]}},"/api/v2/moderation/mute":{"post":{"description":"Mute a user. Mutes are generally not visible to the user you mute, while block is something you notice.\n","operationId":"mute","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteRequest"}}},"description":"MuteRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteResponse"}}},"description":"MuteResponse"},"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":"Mute","tags":["product:moderation"]}},"/api/v2/moderation/review_queue":{"post":{"description":"Query review queue items allows you to filter the review queue items. This is used for building a moderation dashboard.\n","operationId":"query_review_queue","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryReviewQueueRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryReviewQueueResponse"}}},"description":"Successful 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":"Query review queue items","tags":["product:moderation"]}},"/api/v2/moderation/submit_action":{"post":{"description":"Take action on flagged content, such as marking content as safe, deleting content, banning users, or executing custom moderation actions. Supports various action types with configurable parameters.\n","operationId":"submit_action","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitActionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitActionResponse"}}},"description":"Successful 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":"Submit moderation action","tags":["product:moderation"]}},"/api/v2/og":{"get":{"description":"Get an OpenGraph attachment for a link\n","operationId":"GetOG","parameters":[{"in":"query","name":"url","required":true,"schema":{"description":"URL to be scraped","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOGResponse"}}},"description":"Get OG Attachment"},"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":"Get OG","tags":["product:common"]}},"/api/v2/polls":{"post":{"description":"Creates a new poll\n","operationId":"CreatePoll","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePollRequest"}}},"description":"Create Poll Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Create poll","tags":["product:common"]},"put":{"description":"Updates a poll\n\nSends events:\n- feeds.poll.closed\n- feeds.poll.updated\n- poll.closed\n- poll.updated\n","operationId":"UpdatePoll","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePollRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Update poll","tags":["product:common"]}},"/api/v2/polls/query":{"post":{"description":"Queries polls\n","operationId":"QueryPolls","parameters":[{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryPollsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryPollsResponse"}}},"description":"Successful 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":"Query polls","tags":["product:common"]}},"/api/v2/polls/{poll_id}":{"delete":{"description":"Deletes a poll\n\nSends events:\n- feeds.poll.deleted\n- poll.deleted\n","operationId":"DeletePoll","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete poll","tags":["product:common"]},"get":{"description":"Retrieves a poll\n","operationId":"GetPoll","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Get poll","tags":["product:common"]},"patch":{"description":"Updates a poll partially\n\nSends events:\n- feeds.poll.closed\n- feeds.poll.updated\n- poll.closed\n- poll.updated\n","operationId":"UpdatePollPartial","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePollPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Partial update poll","tags":["product:common"]}},"/api/v2/polls/{poll_id}/options":{"post":{"description":"Creates a poll option\n\nSends events:\n- feeds.poll.updated\n- poll.updated\n","operationId":"CreatePollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePollOptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollOptionResponse"}}},"description":"Successful 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":"Create poll option","tags":["product:common"]},"put":{"description":"Updates a poll option\n\nSends events:\n- feeds.poll.updated\n- poll.updated\n","operationId":"UpdatePollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePollOptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollOptionResponse"}}},"description":"Successful 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":"Update poll option","tags":["product:common"]}},"/api/v2/polls/{poll_id}/options/{option_id}":{"delete":{"description":"Deletes a poll option\n\nSends events:\n- feeds.poll.updated\n- poll.updated\n","operationId":"DeletePollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"path","name":"option_id","required":true,"schema":{"description":"Option ID","maxLength":255,"title":"string","type":"string","x-stream-index":"003"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete poll option","tags":["product:common"]},"get":{"description":"Retrieves a poll option\n","operationId":"GetPollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"path","name":"option_id","required":true,"schema":{"description":"Option ID","maxLength":255,"title":"string","type":"string","x-stream-index":"003"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollOptionResponse"}}},"description":"Successful 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":"Get poll option","tags":["product:common"]}},"/api/v2/polls/{poll_id}/votes":{"post":{"description":"Queries votes\n","operationId":"QueryPollVotes","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryPollVotesRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollVotesResponse"}}},"description":"Successful 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":"Query votes","tags":["product:common"]}},"/api/v2/uploads/file":{"delete":{"description":"Deletes previously uploaded file\n","operationId":"DeleteFileGlobal","parameters":[{"in":"query","name":"url","schema":{"description":"File URL to delete","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete file","tags":["product:common"],"x-stream-sdk-name":"DeleteFile"},"post":{"description":"Uploads file\n","operationId":"UploadFileGlobal","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/FileUploadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileUploadResponse"}}},"description":"Successful 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":"Upload file","tags":["product:common"],"x-stream-sdk-name":"UploadFile"}},"/api/v2/uploads/image":{"delete":{"description":"Deletes previously uploaded image\n","operationId":"DeleteImageGlobal","parameters":[{"in":"query","name":"url","schema":{"description":"File URL to delete","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete image","tags":["product:common"],"x-stream-sdk-name":"DeleteImage"},"post":{"description":"Uploads image\n","operationId":"UploadImageGlobal","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/ImageUploadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageUploadResponse"}}},"description":"Successful 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":"Upload image","tags":["product:common"],"x-stream-sdk-name":"UploadImage"}},"/api/v2/users":{"get":{"description":"Find and filter users\n","operationId":"QueryUsers","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryUsersPayload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryUsersResponse"}}},"description":"Successful 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":"Query users","tags":["product:common"]},"patch":{"description":"Updates certain fields of the user\n\nSends events:\n- user.presence.changed\n- user.updated\n- user.presence.changed\n","operationId":"UpdateUsersPartial","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersResponse"}}},"description":"Successful 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":"Partially update user","tags":["product:common"]},"post":{"description":"Update or create users in bulk\n\nSends events:\n- user.updated\n","operationId":"UpdateUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersResponse"}}},"description":"Successful 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":"Upsert users","tags":["product:common"]}},"/api/v2/users/block":{"get":{"description":"Get list of blocked Users\n","operationId":"GetBlockedUsers","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBlockedUsersResponse"}}},"description":"Successful 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":"Get list of blocked Users","tags":["product:common"]},"post":{"description":"Block users\n","operationId":"BlockUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUsersResponse"}}},"description":"Successful 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":"Block user","tags":["product:common"]}},"/api/v2/users/live_locations":{"get":{"description":"Retrieves all active live locations for a user\n","operationId":"GetUserLiveLocations","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SharedLocationsResponse"}}},"description":"Successful 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":"Get user live locations","tags":["product:common"]},"put":{"description":"Updates an existing live location with new coordinates or expiration time\n","operationId":"UpdateLiveLocation","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateLiveLocationRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SharedLocationResponse"}}},"description":"Successful 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":"Update live location","tags":["product:common"]}},"/api/v2/users/unblock":{"post":{"description":"Unblock users\n","operationId":"UnblockUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUsersResponse"}}},"description":"Successful 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":"Unblock user","tags":["product:common"]}}},"security":[{"JWT":[],"api_key":[],"stream-auth-type":[]},{"api_key":[],"stream-auth-type":[]}],"servers":[{"description":"Stream API","url":"https://chat.stream-io-api.com"}]} \ No newline at end of file +{"components":{"schemas":{"AIImageConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"ocr_rules":{"items":{"$ref":"#/components/schemas/OCRRule"},"type":"array","x-stream-index":"004"},"rules":{"items":{"$ref":"#/components/schemas/AWSRekognitionRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules","ocr_rules"],"type":"object"},"AIIndicatorClearEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"ai_indicator.clear","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"AIIndicatorClearEvent","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"},"AIIndicatorStopEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"ai_indicator.stop","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"AIIndicatorStopEvent","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"},"AIIndicatorUpdateEvent":{"properties":{"ai_message":{"type":"string","x-stream-index":"005"},"ai_state":{"type":"string","x-stream-index":"004"},"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"message_id":{"type":"string","x-stream-index":"003"},"type":{"default":"ai_indicator.update","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","cid","channel_id","channel_type","message_id","ai_state"],"title":"AIIndicatorUpdateEvent","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"},"AITextConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"profile":{"type":"string","x-stream-index":"003"},"rules":{"items":{"$ref":"#/components/schemas/BodyguardRule"},"type":"array","x-stream-index":"004"},"severity_rules":{"items":{"$ref":"#/components/schemas/BodyguardSeverityRule"},"type":"array","x-stream-index":"005"}},"required":["enabled","profile","rules","severity_rules"],"type":"object"},"AIVideoConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AWSRekognitionRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"APIError":{"nullable":true,"properties":{"StatusCode":{"description":"Response HTTP status code","format":"int32","title":"Status code","type":"integer","x-stream-index":"004"},"code":{"description":"API error code","format":"int32","title":"Code","type":"integer","x-stream-index":"001"},"details":{"description":"Additional error-specific information","items":{"type":"integer"},"title":"Details","type":"array","x-stream-index":"007"},"duration":{"description":"Request duration","title":"Duration","type":"string","x-stream-index":"005"},"exception_fields":{"additionalProperties":{"type":"string"},"description":"Additional error info","title":"Exception fields","type":"object","x-stream-index":"003"},"message":{"description":"Message describing an error","title":"Message","type":"string","x-stream-index":"002"},"more_info":{"description":"URL with additional information","title":"More info","type":"string","x-stream-index":"006"},"unrecoverable":{"description":"Flag that indicates if the error is unrecoverable, requests that return unrecoverable errors should not be retried, this error only applies to the request that caused it","title":"Unrecoverable","type":"boolean","x-stream-index":"008"}},"required":["code","message","StatusCode","duration","more_info","details"],"title":"Error response","type":"object"},"APNS":{"properties":{"body":{"type":"string","x-stream-index":"002"},"content-available":{"format":"int32","type":"integer","x-stream-index":"004"},"data":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"mutable-content":{"format":"int32","type":"integer","x-stream-index":"005"},"sound":{"type":"string","x-stream-index":"003"},"title":{"type":"string","x-stream-index":"001"}},"required":["title","body"],"type":"object"},"AWSRekognitionRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"},"min_confidence":{"format":"float","maximum":100,"minimum":0,"type":"number","x-stream-index":"003"}},"required":["label","action","min_confidence"],"type":"object"},"Action":{"nullable":true,"properties":{"name":{"type":"string","x-stream-index":"001"},"style":{"type":"string","x-stream-index":"003"},"text":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"004"},"value":{"type":"string","x-stream-index":"005"}},"required":["name","text","type"],"type":"object"},"ActionLog":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"002"},"reason":{"type":"string","x-stream-index":"008"},"reporter_type":{"type":"string","x-stream-index":"009"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"014"},"review_queue_item_id":{"type":"string","x-stream-index":"012"},"target_user":{"$ref":"#/components/schemas/User","x-stream-index":"013"},"target_user_id":{"type":"string","x-stream-index":"011"},"type":{"type":"string","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007"}},"required":["id","created_at","type","reason","reporter_type","custom","target_user_id","review_queue_item_id"],"type":"object"},"ActionLogResponse":{"nullable":true,"properties":{"created_at":{"description":"Timestamp when the action was taken","format":"date-time","title":"Created At","type":"number","x-stream-index":"002"},"custom":{"additionalProperties":{},"description":"Additional metadata about the action","title":"Custom","type":"object","x-stream-index":"007"},"id":{"description":"Unique identifier of the action log","title":"ID","type":"string","x-stream-index":"001"},"reason":{"description":"Reason for the moderation action","title":"Reason","type":"string","x-stream-index":"006"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"Associated review queue item","title":"Review Queue Item","x-stream-index":"008"},"target_user":{"$ref":"#/components/schemas/UserResponse","description":"User who was the target of the action","title":"Target User","x-stream-index":"009"},"target_user_id":{"description":"ID of the user who was the target of the action","title":"Target User ID","type":"string","x-stream-index":"010"},"type":{"description":"Type of moderation action","title":"Type","type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who performed the action","title":"User","x-stream-index":"004"},"user_id":{"description":"ID of the user who performed the action","title":"User ID","type":"string","x-stream-index":"005"}},"required":["id","created_at","type","user_id","reason","custom","target_user_id"],"type":"object"},"ActionSequence":{"properties":{"action":{"type":"string","x-stream-index":"001"},"blur":{"type":"boolean","x-stream-index":"005"},"cooldown_period":{"format":"int32","type":"integer","x-stream-index":"004"},"threshold":{"format":"int32","type":"integer","x-stream-index":"002"},"time_window":{"format":"int32","type":"integer","x-stream-index":"003"},"warning":{"type":"boolean","x-stream-index":"006"},"warning_text":{"type":"string","x-stream-index":"007"}},"required":["action","threshold","time_window","cooldown_period","blur","warning","warning_text"],"type":"object"},"ActivityMarkedEvent":{"properties":{"all_read":{"type":"boolean","x-stream-index":"006"},"all_seen":{"type":"boolean","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"feed_id":{"type":"string","x-stream-index":"003"},"marked_read":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"marked_watched":{"items":{"type":"string"},"type":"array","x-stream-index":"005"},"type":{"default":"activity.marked","type":"string","x-stream-index":"001.001"},"user_id":{"type":"string","x-stream-index":"002"}},"required":["type","created_at","user_id","feed_id","all_read","all_seen"],"title":"ActivityMarkedEvent","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"},"AnyEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"*","type":"string","x-stream-index":"001.001"}},"required":["type","created_at"],"title":"AnyEvent","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"},"AppEventResponse":{"properties":{"async_url_enrich_enabled":{"description":"boolean","title":"Async URL Enrichment Enabled","type":"boolean","x-stream-index":"002"},"auto_translation_enabled":{"description":"boolean","title":"Auto Translation Enabled","type":"boolean","x-stream-index":"003"},"file_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","description":"file upload config","title":"File Upload Config","x-stream-index":"004"},"image_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","description":"file upload config","title":"Image Upload Config","x-stream-index":"005"},"name":{"description":"string","title":"App name","type":"string","x-stream-index":"001"}},"required":["name","auto_translation_enabled"],"type":"object"},"AppResponseFields":{"properties":{"async_url_enrich_enabled":{"type":"boolean","x-stream-index":"017"},"auto_translation_enabled":{"type":"boolean","x-stream-index":"020"},"file_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","x-stream-index":"030"},"image_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","x-stream-index":"031"},"name":{"type":"string","x-stream-index":"001"}},"required":["name","organization","push_notifications","webhook_url","moderation_webhook_url","channel_configs","call_types","policies","suspended","suspended_explanation","disable_auth_checks","disable_permissions_checks","permission_version","user_search_disallowed_roles","multi_tenant_enabled","image_moderation_enabled","async_url_enrich_enabled","auto_translation_enabled","custom_action_handler_url","enforce_unique_usernames","sqs_url","sqs_key","sqs_secret","sns_topic_arn","sns_key","sns_secret","file_upload_config","image_upload_config","grants","campaign_enabled","webhook_events","reminders_interval","cdn_expiration_seconds","video_provider","moderation_enabled","moderation_multitenant_blocklist_enabled","guest_user_creation_disabled","event_hooks","use_hook_v2","user_response_time_enabled","moderation_bulk_submit_action_enabled","moderation_llm_configurability_enabled"],"type":"object"},"AppUpdatedEvent":{"description":"Emitted when app settings are updated","nullable":true,"properties":{"app":{"$ref":"#/components/schemas/AppEventResponse","description":"application configuration","title":"App settings","x-stream-index":"002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"type":{"default":"app.updated","description":"The type of event: \"app.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.002"}},"required":["type","created_at","custom","app"],"title":"AppUpdatedEvent","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"},"Attachment":{"description":"An attachment is a message object that represents a file uploaded by a user.","nullable":true,"properties":{"actions":{"items":{"$ref":"#/components/schemas/Action"},"type":"array","x-stream-index":"015"},"asset_url":{"type":"string","x-stream-index":"017"},"author_icon":{"type":"string","x-stream-index":"007"},"author_link":{"type":"string","x-stream-index":"006"},"author_name":{"type":"string","x-stream-index":"005"},"color":{"type":"string","x-stream-index":"003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"018"},"fallback":{"type":"string","x-stream-index":"002"},"fields":{"items":{"$ref":"#/components/schemas/Field"},"type":"array","x-stream-index":"016"},"footer":{"type":"string","x-stream-index":"013"},"footer_icon":{"type":"string","x-stream-index":"014"},"giphy":{"$ref":"#/components/schemas/Images","x-stream-index":"019"},"image_url":{"type":"string","x-stream-index":"011"},"og_scrape_url":{"type":"string","x-stream-index":"020"},"original_height":{"format":"int32","type":"integer","x-stream-index":"022"},"original_width":{"format":"int32","type":"integer","x-stream-index":"021"},"pretext":{"type":"string","x-stream-index":"004"},"text":{"type":"string","x-stream-index":"010"},"thumb_url":{"type":"string","x-stream-index":"012"},"title":{"type":"string","x-stream-index":"008"},"title_link":{"type":"string","x-stream-index":"009"},"type":{"description":"Attachment type (e.g. image, video, url)","title":"Type","type":"string","x-stream-index":"001"}},"required":["custom"],"title":"Attachment","type":"object","x-stream-docs-page-id":"file_uploads"},"AudioSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"001"},"default_device":{"enum":["speaker","earpiece"],"type":"string","x-stream-index":"006"},"mic_default_on":{"type":"boolean","x-stream-index":"004"},"noise_cancellation":{"$ref":"#/components/schemas/NoiseCancellationSettings","x-stream-index":"007"},"opus_dtx_enabled":{"type":"boolean","x-stream-index":"002"},"redundant_coding_enabled":{"type":"boolean","x-stream-index":"003"},"speaker_default_on":{"type":"boolean","x-stream-index":"005"}},"required":["access_request_enabled","opus_dtx_enabled","redundant_coding_enabled","mic_default_on","speaker_default_on","default_device"],"type":"object"},"AudioSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"001"},"default_device":{"enum":["speaker","earpiece"],"type":"string","x-stream-index":"006"},"mic_default_on":{"type":"boolean","x-stream-index":"004"},"noise_cancellation":{"$ref":"#/components/schemas/NoiseCancellationSettings","x-stream-index":"007"},"opus_dtx_enabled":{"type":"boolean","x-stream-index":"002"},"redundant_coding_enabled":{"type":"boolean","x-stream-index":"003"},"speaker_default_on":{"type":"boolean","x-stream-index":"005"}},"required":["access_request_enabled","opus_dtx_enabled","redundant_coding_enabled","mic_default_on","speaker_default_on","default_device"],"type":"object"},"AutomodDetails":{"properties":{"action":{"type":"string","x-stream-index":"001"},"image_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"005"},"message_details":{"$ref":"#/components/schemas/FlagMessageDetails","x-stream-index":"004"},"original_message_type":{"type":"string","x-stream-index":"002"},"result":{"$ref":"#/components/schemas/MessageModerationResult","x-stream-index":"003"}},"type":"object"},"AutomodPlatformCircumventionConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AutomodRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"AutomodRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"003"},"label":{"type":"string","x-stream-index":"001"},"threshold":{"format":"float","maximum":1,"minimum":0,"type":"number","x-stream-index":"002"}},"required":["label","threshold","action"],"type":"object"},"AutomodSemanticFiltersConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AutomodSemanticFiltersRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"AutomodSemanticFiltersRule":{"properties":{"action":{"enum":["flag","shadow","remove"],"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"threshold":{"format":"float","maximum":1,"minimum":0,"type":"number","x-stream-index":"002"}},"required":["name","threshold","action"],"type":"object"},"AutomodToxicityConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AutomodRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"BackstageSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"BackstageSettingsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"Ban":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"012"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"011"},"expires":{"format":"date-time","type":"number","x-stream-index":"007"},"reason":{"type":"string","x-stream-index":"008"},"shadow":{"type":"boolean","x-stream-index":"009"},"target":{"$ref":"#/components/schemas/User","x-stream-index":"006"}},"required":["shadow","created_at"],"type":"object"},"BanActionRequest":{"properties":{"channel_ban_only":{"type":"boolean","x-stream-index":"003"},"delete_messages":{"enum":["soft","pruning","hard"],"type":"string","x-stream-index":"005"},"ip_ban":{"type":"boolean","x-stream-index":"004"},"reason":{"type":"string","x-stream-index":"002"},"shadow":{"type":"boolean","x-stream-index":"001"},"timeout":{"format":"int32","type":"integer","x-stream-index":"006"}},"type":"object"},"BanOptions":{"properties":{"duration":{"format":"int32","type":"integer","x-stream-index":"001"},"ip_ban":{"type":"boolean","x-stream-index":"004"},"reason":{"type":"string","x-stream-index":"002"},"shadow_ban":{"type":"boolean","x-stream-index":"003"}},"type":"object"},"BanRequest":{"nullable":true,"properties":{"banned_by":{"$ref":"#/components/schemas/UserRequest","description":"Details about the user performing the ban","title":"Banned By","x-stream-index":"008"},"banned_by_id":{"description":"ID of the user performing the ban","title":"Banned By ID","type":"string","x-stream-index":"007"},"channel_cid":{"description":"Channel where the ban applies","title":"Channel CID","type":"string","x-stream-index":"004"},"delete_messages":{"enum":["soft","pruning","hard"],"type":"string","x-stream-index":"009"},"ip_ban":{"description":"Whether to ban the user's IP address","title":"IP Ban","type":"boolean","x-stream-index":"006"},"reason":{"description":"Optional explanation for the ban","title":"Reason","type":"string","x-stream-index":"003"},"shadow":{"description":"Whether this is a shadow ban","title":"Shadow","type":"boolean","x-stream-index":"005"},"target_user_id":{"description":"ID of the user to ban","title":"Target User ID","type":"string","x-stream-index":"001"},"timeout":{"description":"Duration of the ban in minutes","minimum":0,"title":"Timeout","type":"integer","x-stream-index":"002"}},"required":["target_user_id"],"type":"object"},"BanResponse":{"nullable":true,"properties":{"banned_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"006"},"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"expires":{"format":"date-time","type":"number","x-stream-index":"003"},"reason":{"type":"string","x-stream-index":"004"},"shadow":{"type":"boolean","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"}},"required":["created_at"],"type":"object"},"BlockContentOptions":{"properties":{"reason":{"type":"string","x-stream-index":"001"}},"type":"object"},"BlockListConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/BlockListRule"},"maximum":10,"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"BlockListOptions":{"properties":{"behavior":{"description":"Blocklist behavior","enum":["flag","block","shadow_block"],"title":"Behavior","type":"string","x-stream-index":"002"},"blocklist":{"description":"Blocklist name","title":"Blocklist","type":"string","x-stream-index":"001"}},"required":["blocklist","behavior"],"type":"object"},"BlockListResponse":{"description":"Block list contains restricted words","properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001"},"id":{"type":"string","x-stream-index":"003"},"name":{"description":"Block list name","title":"Name","type":"string","x-stream-index":"004"},"team":{"type":"string","x-stream-index":"007"},"type":{"description":"Block list type.","title":"Type","type":"string","x-stream-index":"005"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"002"},"words":{"description":"List of words to block","items":{"type":"string"},"title":"Words","type":"array","x-stream-index":"006"}},"required":["name","type","words"],"title":"Block list","type":"object","x-stream-docs-page-id":"block_lists"},"BlockListRule":{"properties":{"action":{"enum":["flag","mask_flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"002"}},"required":["name","team","action"],"type":"object"},"BlockUsersRequest":{"nullable":true,"properties":{"blocked_user_id":{"description":"User id to block","title":"BlockedUserID","type":"string","x-stream-index":"001"}},"required":["blocked_user_id"],"type":"object"},"BlockUsersResponse":{"nullable":true,"properties":{"blocked_by_user_id":{"description":"User id who blocked another user","title":"BlockedByUserID","type":"string","x-stream-index":"002"},"blocked_user_id":{"description":"User id who got blocked","title":"BlockedUserID","type":"string","x-stream-index":"003"},"created_at":{"description":"Timestamp when the user was blocked","format":"date-time","title":"CreatedAt","type":"number","x-stream-index":"004"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration","blocked_by_user_id","blocked_user_id","created_at"],"type":"object"},"BlockedUserResponse":{"nullable":true,"properties":{"blocked_user":{"$ref":"#/components/schemas/UserResponse","description":"User who got blocked","title":"User","x-stream-index":"003"},"blocked_user_id":{"description":"ID of the user who got blocked","title":"UserID","type":"string","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who blocked another user","title":"User","x-stream-index":"001"},"user_id":{"description":"ID of the user who blocked another user","title":"UserID","type":"string","x-stream-index":"002"}},"required":["user","user_id","blocked_user","blocked_user_id","created_at"],"type":"object"},"BodyguardRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"},"severity_rules":{"items":{"$ref":"#/components/schemas/BodyguardSeverityRule"},"type":"array","x-stream-index":"003"}},"required":["label","action","severity_rules"],"type":"object"},"BodyguardSeverityRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"severity":{"enum":["low","medium","high","critical"],"type":"string","x-stream-index":"001"}},"required":["severity","action"],"type":"object"},"BroadcastSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettings","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettings","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"BroadcastSettingsResponse":{"description":"BroadcastSettingsResponse is the payload for broadcasting settings","properties":{"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettingsResponse","title":"HLS","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettingsResponse","title":"RTMP","x-stream-index":"003"}},"required":["enabled","hls","rtmp"],"title":"BroadcastSettingsResponse","type":"object"},"Call":{"properties":{"AppPK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"002"},"Backstage":{"type":"boolean","writeOnly":true,"x-stream-index":"023"},"BlockedUserIDs":{"items":{"type":"string"},"type":"array","writeOnly":true,"x-stream-index":"018"},"BlockedUsers":{"items":{"$ref":"#/components/schemas/User"},"type":"array","writeOnly":true,"x-stream-index":"019"},"CID":{"type":"string","writeOnly":true,"x-stream-index":"005"},"CallType":{"$ref":"#/components/schemas/CallType","x-stream-index":"020"},"ChannelCID":{"type":"string","writeOnly":true,"x-stream-index":"032"},"CreatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"013"},"CreatedBy":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"CreatedByUserID":{"type":"string","writeOnly":true,"x-stream-index":"007"},"CurrentSessionID":{"type":"string","writeOnly":true,"x-stream-index":"024"},"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"012"},"DeletedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"028"},"EgressUpdatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"027"},"Egresses":{"items":{"$ref":"#/components/schemas/CallEgress"},"type":"array","writeOnly":true,"x-stream-index":"015"},"EndedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"017"},"ID":{"type":"string","writeOnly":true,"x-stream-index":"004"},"JoinAheadTimeSeconds":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"031"},"LastHeartbeatAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"030"},"LastSessionID":{"type":"string","writeOnly":true,"x-stream-index":"025"},"MemberCount":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"010"},"MemberLookup":{"$ref":"#/components/schemas/MemberLookup","x-stream-index":"011"},"Members":{"items":{"$ref":"#/components/schemas/CallMember"},"type":"array","writeOnly":true,"x-stream-index":"009"},"Session":{"$ref":"#/components/schemas/CallSession","x-stream-index":"026"},"Settings":{"$ref":"#/components/schemas/CallSettings","x-stream-index":"022"},"SettingsOverrides":{"$ref":"#/components/schemas/CallSettings","x-stream-index":"021"},"StartsAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"016"},"Team":{"type":"string","writeOnly":true,"x-stream-index":"006"},"ThumbnailURL":{"type":"string","writeOnly":true,"x-stream-index":"029"},"Type":{"type":"string","writeOnly":true,"x-stream-index":"003"},"UpdatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"014"}},"required":["AppPK","Type","ID","CID","Team","CreatedByUserID","Members","Custom","CreatedAt","UpdatedAt","Egresses","BlockedUserIDs","BlockedUsers","Backstage","CurrentSessionID","LastSessionID","ThumbnailURL","ChannelCID"],"type":"object"},"CallEgress":{"nullable":true,"properties":{"app_pk":{"format":"int32","type":"integer","x-stream-index":"002"},"call_id":{"type":"string","x-stream-index":"004"},"call_type":{"type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/EgressTaskConfig","x-stream-index":"007"},"egress_id":{"type":"string","x-stream-index":"005"},"egress_type":{"type":"string","x-stream-index":"006"},"instance_ip":{"type":"string","x-stream-index":"008"},"started_at":{"format":"date-time","type":"number","x-stream-index":"010"},"state":{"type":"string","x-stream-index":"009"},"stopped_at":{"format":"date-time","type":"number","x-stream-index":"011"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"012"}},"required":["app_pk","call_type","call_id","egress_id","egress_type","instance_ip","state","started_at","updated_at"],"type":"object"},"CallIngressResponse":{"description":"CallIngressResponse is the payload for ingress settings","properties":{"rtmp":{"$ref":"#/components/schemas/RTMPIngress","title":"RTMP","x-stream-index":"001"}},"required":["rtmp"],"title":"CallIngressResponse","type":"object"},"CallMember":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"010"},"role":{"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["user_id","role","custom","created_at","updated_at"],"type":"object"},"CallParticipant":{"nullable":true,"properties":{"JoinedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"004"},"Role":{"type":"string","writeOnly":true,"x-stream-index":"002"},"UserSessionID":{"type":"string","writeOnly":true,"x-stream-index":"003"},"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"001.046"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"001.017"},"banned":{"type":"boolean","x-stream-index":"001.016"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.013"},"id":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"001.023"},"language":{"type":"string","x-stream-index":"001.035"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"001.022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"001.026"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.042"},"role":{"type":"string","x-stream-index":"001.004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.005"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.009"}},"required":["id","role","teams_role","custom","banned","online","Role","UserSessionID","JoinedAt"],"type":"object"},"CallParticipantResponse":{"properties":{"joined_at":{"format":"date-time","type":"number","x-stream-index":"004"},"role":{"type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"},"user_session_id":{"type":"string","x-stream-index":"002"}},"required":["user","user_session_id","role","joined_at"],"type":"object"},"CallResponse":{"description":"Represents a call","properties":{"backstage":{"type":"boolean","x-stream-index":"016"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"018"},"captioning":{"type":"boolean","x-stream-index":"013"},"channel_cid":{"type":"string","x-stream-index":"024"},"cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"The user that created the call","title":"Created By","x-stream-index":"007"},"current_session_id":{"type":"string","x-stream-index":"005"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"008"},"egress":{"$ref":"#/components/schemas/EgressResponse","x-stream-index":"021"},"ended_at":{"description":"Date/time when the call ended","format":"date-time","title":"Ended At","type":"number","x-stream-index":"014"},"id":{"description":"Call ID","title":"ID","type":"string","x-stream-index":"003"},"ingress":{"$ref":"#/components/schemas/CallIngressResponse","x-stream-index":"019"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"023"},"recording":{"type":"boolean","x-stream-index":"011"},"session":{"$ref":"#/components/schemas/CallSessionResponse","x-stream-index":"020"},"settings":{"$ref":"#/components/schemas/CallSettingsResponse","x-stream-index":"017"},"starts_at":{"description":"Date/time when the call will start","format":"date-time","title":"Starts At","type":"number","x-stream-index":"015"},"team":{"type":"string","x-stream-index":"006"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailResponse","x-stream-index":"022"},"transcribing":{"type":"boolean","x-stream-index":"012"},"type":{"description":"The type of call","title":"Type","type":"string","x-stream-index":"002"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"}},"required":["type","id","cid","current_session_id","created_by","custom","created_at","updated_at","recording","transcribing","captioning","backstage","settings","blocked_user_ids","ingress","egress"],"title":"CallResponse","type":"object"},"CallSession":{"properties":{"AcceptedBy":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","writeOnly":true,"x-stream-index":"008"},"ActiveSFUs":{"items":{"$ref":"#/components/schemas/SFUIDLastSeen"},"type":"array","writeOnly":true,"x-stream-index":"016"},"AnonymousParticipantCount":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"019"},"AppPK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"002.001"},"CallID":{"type":"string","writeOnly":true,"x-stream-index":"002.003"},"CallType":{"type":"string","writeOnly":true,"x-stream-index":"002.002"},"CreatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"003"},"DeletedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"004"},"EndedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"006"},"LiveEndedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"013"},"LiveStartedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"012"},"MissedBy":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","writeOnly":true,"x-stream-index":"010"},"Participants":{"items":{"$ref":"#/components/schemas/CallParticipant"},"type":"array","writeOnly":true,"x-stream-index":"011"},"ParticipantsCountByRole":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","writeOnly":true,"x-stream-index":"018"},"RejectedBy":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","writeOnly":true,"x-stream-index":"009"},"RingAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"007"},"SFUIDs":{"items":{"type":"string"},"type":"array","writeOnly":true,"x-stream-index":"015"},"SessionID":{"type":"string","writeOnly":true,"x-stream-index":"002.004"},"StartedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"005"},"TimerEndsAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"014"},"UserPermissionOverrides":{"additionalProperties":{"additionalProperties":{"type":"boolean"},"type":"object"},"type":"object","writeOnly":true,"x-stream-index":"017"}},"required":["AppPK","CallType","CallID","SessionID","CreatedAt","AcceptedBy","RejectedBy","MissedBy","Participants","SFUIDs","ActiveSFUs","UserPermissionOverrides","ParticipantsCountByRole","AnonymousParticipantCount"],"type":"object"},"CallSessionResponse":{"properties":{"accepted_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"008"},"anonymous_participant_count":{"format":"int32","type":"integer","x-stream-index":"006"},"ended_at":{"format":"date-time","type":"number","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"live_ended_at":{"format":"date-time","type":"number","x-stream-index":"011"},"live_started_at":{"format":"date-time","type":"number","x-stream-index":"010"},"missed_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"009"},"participants":{"items":{"$ref":"#/components/schemas/CallParticipantResponse"},"type":"array","x-stream-index":"004"},"participants_count_by_role":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"005"},"rejected_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"007"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002"},"timer_ends_at":{"format":"date-time","type":"number","x-stream-index":"012"}},"required":["id","participants","participants_count_by_role","anonymous_participant_count","rejected_by","accepted_by","missed_by"],"type":"object"},"CallSettings":{"properties":{"audio":{"$ref":"#/components/schemas/AudioSettings","x-stream-index":"001"},"backstage":{"$ref":"#/components/schemas/BackstageSettings","x-stream-index":"002"},"broadcasting":{"$ref":"#/components/schemas/BroadcastSettings","x-stream-index":"007"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordSettings","x-stream-index":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettings","x-stream-index":"008"},"ingress":{"$ref":"#/components/schemas/IngressSettings","x-stream-index":"014"},"limits":{"$ref":"#/components/schemas/LimitsSettings","x-stream-index":"012"},"recording":{"$ref":"#/components/schemas/RecordSettings","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettings","x-stream-index":"010"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettings","x-stream-index":"004"},"session":{"$ref":"#/components/schemas/SessionSettings","x-stream-index":"013"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettings","x-stream-index":"011"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettings","x-stream-index":"009"},"video":{"$ref":"#/components/schemas/VideoSettings","x-stream-index":"003"}},"type":"object"},"CallSettingsResponse":{"properties":{"audio":{"$ref":"#/components/schemas/AudioSettingsResponse","x-stream-index":"001"},"backstage":{"$ref":"#/components/schemas/BackstageSettingsResponse","x-stream-index":"002"},"broadcasting":{"$ref":"#/components/schemas/BroadcastSettingsResponse","x-stream-index":"003"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordingSettingsResponse","x-stream-index":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettingsResponse","x-stream-index":"004"},"ingress":{"$ref":"#/components/schemas/IngressSettingsResponse","x-stream-index":"014"},"limits":{"$ref":"#/components/schemas/LimitsSettingsResponse","x-stream-index":"012"},"recording":{"$ref":"#/components/schemas/RecordSettingsResponse","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettingsResponse","x-stream-index":"007"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettingsResponse","x-stream-index":"008"},"session":{"$ref":"#/components/schemas/SessionSettingsResponse","x-stream-index":"013"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettingsResponse","x-stream-index":"011"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettingsResponse","x-stream-index":"009"},"video":{"$ref":"#/components/schemas/VideoSettingsResponse","x-stream-index":"010"}},"required":["audio","backstage","broadcasting","geofencing","recording","frame_recording","ring","screensharing","transcription","video","thumbnails","limits","session"],"type":"object"},"CallType":{"properties":{"AppPK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"003"},"CreatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"005"},"ExternalStorage":{"type":"string","writeOnly":true,"x-stream-index":"009"},"Name":{"type":"string","writeOnly":true,"x-stream-index":"004"},"NotificationSettings":{"$ref":"#/components/schemas/NotificationSettings","x-stream-index":"008"},"PK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"002"},"Settings":{"$ref":"#/components/schemas/CallSettings","x-stream-index":"007"},"UpdatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"006"}},"required":["PK","AppPK","Name","CreatedAt","UpdatedAt","ExternalStorage"],"type":"object"},"CastPollVoteRequest":{"nullable":true,"properties":{"vote":{"$ref":"#/components/schemas/VoteData","description":"Vote data","title":"VoteData","x-stream-index":"004"}},"type":"object"},"Channel":{"properties":{"active_live_locations":{"items":{"$ref":"#/components/schemas/SharedLocation"},"type":"array","x-stream-index":"034"},"auto_translation_enabled":{"type":"boolean","x-stream-index":"029"},"auto_translation_language":{"type":"string","x-stream-index":"030"},"cid":{"type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/ChannelConfig","x-stream-index":"026"},"config_overrides":{"$ref":"#/components/schemas/ConfigOverrides","x-stream-index":"027"},"cooldown":{"format":"int32","type":"integer","x-stream-index":"031"},"created_at":{"format":"date-time","type":"number","x-stream-index":"009"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"019"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"disabled":{"type":"boolean","x-stream-index":"017"},"frozen":{"type":"boolean","x-stream-index":"016"},"id":{"type":"string","x-stream-index":"004"},"invites":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"022"},"last_campaigns":{"type":"string","x-stream-index":"032"},"last_message_at":{"format":"date-time","type":"number","x-stream-index":"006"},"member_count":{"format":"int32","type":"integer","x-stream-index":"021"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"020"},"message_count":{"format":"int64","type":"integer","x-stream-index":"035"},"message_count_updated_at":{"format":"date-time","type":"number","x-stream-index":"036"},"team":{"type":"string","x-stream-index":"028"},"truncated_by":{"$ref":"#/components/schemas/User","x-stream-index":"015"},"type":{"type":"string","x-stream-index":"005"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"010"}},"required":["cid","id","type","created_at","updated_at","frozen","disabled","custom","auto_translation_language"],"type":"object"},"ChannelConfig":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.027"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.022"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.023"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.028"},"blocklist":{"type":"string","x-stream-index":"001.024"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.025"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.026"},"commands":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"connect_events":{"type":"boolean","x-stream-index":"001.004"},"count_messages":{"type":"boolean","x-stream-index":"001.019"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"custom_events":{"type":"boolean","x-stream-index":"001.012"},"mark_messages_pending":{"type":"boolean","x-stream-index":"001.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"001.021"},"mutes":{"type":"boolean","x-stream-index":"001.009"},"name":{"type":"string","x-stream-index":"001.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"001.029"},"partition_ttl":{"type":"integer","x-stream-index":"001.030"},"polls":{"type":"boolean","x-stream-index":"001.016"},"push_notifications":{"type":"boolean","x-stream-index":"001.013"},"quotes":{"type":"boolean","x-stream-index":"001.008"},"reactions":{"type":"boolean","x-stream-index":"001.006"},"read_events":{"type":"boolean","x-stream-index":"001.003"},"reminders":{"type":"boolean","x-stream-index":"001.014"},"replies":{"type":"boolean","x-stream-index":"001.007"},"search":{"type":"boolean","x-stream-index":"001.005"},"shared_locations":{"type":"boolean","x-stream-index":"001.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.031"},"typing_events":{"type":"boolean","x-stream-index":"001.002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"002.004"},"uploads":{"type":"boolean","x-stream-index":"001.010"},"url_enrichment":{"type":"boolean","x-stream-index":"001.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"001.017"}},"required":["name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","count_messages","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","created_at","updated_at","commands"],"type":"object"},"ChannelConfigWithInfo":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.002.027"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.002.022"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.023"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.002.028"},"blocklist":{"type":"string","x-stream-index":"001.002.024"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.025"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.002.026"},"commands":{"items":{"$ref":"#/components/schemas/Command"},"type":"array","x-stream-index":"001.003"},"connect_events":{"type":"boolean","x-stream-index":"001.002.004"},"count_messages":{"type":"boolean","x-stream-index":"001.002.019"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.001.003"},"custom_events":{"type":"boolean","x-stream-index":"001.002.012"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"002"},"mark_messages_pending":{"type":"boolean","x-stream-index":"001.002.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"001.002.021"},"mutes":{"type":"boolean","x-stream-index":"001.002.009"},"name":{"type":"string","x-stream-index":"001.002.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"001.002.029"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"001.002.030"},"polls":{"type":"boolean","x-stream-index":"001.002.016"},"push_notifications":{"type":"boolean","x-stream-index":"001.002.013"},"quotes":{"type":"boolean","x-stream-index":"001.002.008"},"reactions":{"type":"boolean","x-stream-index":"001.002.006"},"read_events":{"type":"boolean","x-stream-index":"001.002.003"},"reminders":{"type":"boolean","x-stream-index":"001.002.014"},"replies":{"type":"boolean","x-stream-index":"001.002.007"},"search":{"type":"boolean","x-stream-index":"001.002.005"},"shared_locations":{"type":"boolean","x-stream-index":"001.002.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.002.031"},"typing_events":{"type":"boolean","x-stream-index":"001.002.002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"uploads":{"type":"boolean","x-stream-index":"001.002.010"},"url_enrichment":{"type":"boolean","x-stream-index":"001.002.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"001.002.017"}},"required":["created_at","updated_at","name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","count_messages","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","commands"],"type":"object"},"ChannelCreatedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"channel.created","type":"string","x-stream-index":"001.001"}},"required":["type","created_at"],"title":"ChannelCreatedEvent","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"},"ChannelDeletedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003.004"},"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"003.005"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"team":{"type":"string","x-stream-index":"001.001"},"type":{"default":"channel.deleted","type":"string","x-stream-index":"002.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"ChannelDeletedEvent","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"},"ChannelFrozenEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"channel.frozen","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"ChannelFrozenEvent","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"},"ChannelGetOrCreateRequest":{"nullable":true,"properties":{"data":{"$ref":"#/components/schemas/ChannelInput","x-stream-index":"003"},"hide_for_creator":{"description":"Whether this channel will be hidden for the user who created the channel or not","title":"Hide for creator","type":"boolean","x-stream-index":"007"},"members":{"$ref":"#/components/schemas/PaginationParams","x-stream-index":"010"},"messages":{"$ref":"#/components/schemas/MessagePaginationParams","x-stream-index":"009"},"presence":{"description":"Fetch user presence info","title":"Presence","type":"boolean","x-stream-index":"006"},"state":{"description":"Refresh channel state","title":"State","type":"boolean","x-stream-index":"005"},"thread_unread_counts":{"type":"boolean","x-stream-index":"008"},"watch":{"description":"Start watching the channel","title":"Watch","type":"boolean","x-stream-index":"004"},"watchers":{"$ref":"#/components/schemas/PaginationParams","x-stream-index":"011"}},"type":"object"},"ChannelHiddenEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003.004"},"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"003.005"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"clear_history":{"type":"boolean","x-stream-index":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"type":{"default":"channel.hidden","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["clear_history","cid","channel_id","channel_type","channel_member_count","type","created_at"],"title":"ChannelHiddenEvent","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"},"ChannelInput":{"properties":{"auto_translation_enabled":{"description":"Enable or disable auto translation","title":"Auto translation","type":"boolean","x-stream-index":"005"},"auto_translation_language":{"description":"Switch auto translation language","title":"Auto translation language","type":"string","x-stream-index":"006"},"config_overrides":{"$ref":"#/components/schemas/ChannelConfig","x-stream-index":"024"},"created_by":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"009"},"created_by_id":{"type":"string","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"015"},"disabled":{"type":"boolean","x-stream-index":"014"},"frozen":{"description":"Freeze or unfreeze the channel","title":"Frozen","type":"boolean","x-stream-index":"013"},"invites":{"items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"type":"array","x-stream-index":"016"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"type":"array","x-stream-index":"018"},"team":{"description":"Team the channel belongs to (if multi-tenant mode is enabled)","title":"Team","type":"string","x-stream-index":"004"},"truncated_by_id":{"type":"string","x-stream-index":"010"}},"type":"object"},"ChannelKickedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002.004"},"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"002.005"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"channel.kicked","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"ChannelKickedEvent","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"},"ChannelMember":{"nullable":true,"properties":{"archived_at":{"format":"date-time","type":"number","x-stream-index":"015"},"ban_expires":{"description":"Expiration date of the ban","format":"date-time","title":"Ban expires","type":"number","x-stream-index":"013"},"banned":{"description":"Whether member is banned this channel or not","title":"Banned","type":"boolean","x-stream-index":"012"},"channel_role":{"description":"Role of the member in the channel","title":"Channel Role","type":"string","x-stream-index":"018"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"deleted_messages":{"items":{"type":"string"},"type":"array","x-stream-index":"020"},"invite_accepted_at":{"description":"Date when invite was accepted","format":"date-time","title":"Invited accepted at","type":"number","x-stream-index":"006"},"invite_rejected_at":{"description":"Date when invite was rejected","format":"date-time","title":"Invited rejected at","type":"number","x-stream-index":"007"},"invited":{"description":"Whether member was invited or not","title":"Invited","type":"boolean","x-stream-index":"005"},"is_moderator":{"description":"Whether member is channel moderator or not","title":"Is moderator","type":"boolean","x-stream-index":"003"},"notifications_muted":{"type":"boolean","x-stream-index":"019"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"016"},"role":{"description":"Permission level of the member in the channel (DEPRECATED: use channel_role instead)","enum":["member","moderator","admin","owner"],"title":"Role","type":"string","x-stream-index":"017"},"shadow_banned":{"description":"Whether member is shadow banned in this channel or not","title":"Shadow banned","type":"boolean","x-stream-index":"014"},"status":{"type":"string","x-stream-index":"008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"},"user_id":{"title":"User ID","type":"string","x-stream-index":"001"}},"required":["custom","created_at","updated_at","banned","shadow_banned","channel_role","notifications_muted"],"title":"Channel member","type":"object"},"ChannelMemberResponse":{"nullable":true,"properties":{"archived_at":{"format":"date-time","type":"number","x-stream-index":"016"},"ban_expires":{"description":"Expiration date of the ban","format":"date-time","title":"Ban expires","type":"number","x-stream-index":"013"},"banned":{"description":"Whether member is banned this channel or not","title":"Banned","type":"boolean","x-stream-index":"012"},"channel_role":{"description":"Role of the member in the channel","title":"Channel Role","type":"string","x-stream-index":"018"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"invite_accepted_at":{"description":"Date when invite was accepted","format":"date-time","title":"Invited accepted at","type":"number","x-stream-index":"006"},"invite_rejected_at":{"description":"Date when invite was rejected","format":"date-time","title":"Invited rejected at","type":"number","x-stream-index":"007"},"invited":{"description":"Whether member was invited or not","title":"Invited","type":"boolean","x-stream-index":"005"},"is_moderator":{"description":"Whether member is channel moderator or not","title":"Is moderator","type":"boolean","x-stream-index":"003"},"notifications_muted":{"type":"boolean","x-stream-index":"019"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"015"},"role":{"description":"Permission level of the member in the channel (DEPRECATED: use channel_role instead)","enum":["member","moderator","admin","owner"],"title":"Role","type":"string","x-stream-index":"017"},"shadow_banned":{"description":"Whether member is shadow banned in this channel or not","title":"Shadow banned","type":"boolean","x-stream-index":"014"},"status":{"type":"string","x-stream-index":"008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"},"user_id":{"title":"User ID","type":"string","x-stream-index":"001"}},"required":["custom","created_at","updated_at","banned","shadow_banned","channel_role","notifications_muted"],"title":"Channel member","type":"object"},"ChannelMute":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel that is muted","title":"Channel","x-stream-index":"002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"004"},"expires":{"description":"Date/time of mute expiration","format":"date-time","title":"Expires","type":"number","x-stream-index":"003"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Owner of channel mute","title":"User","x-stream-index":"001"}},"required":["created_at","updated_at"],"type":"object"},"ChannelOwnCapability":{"description":"All possibility of string to use","enum":["ban-channel-members","cast-poll-vote","connect-events","create-attachment","delete-any-message","delete-channel","delete-own-message","flag-message","freeze-channel","join-channel","leave-channel","mute-channel","pin-message","query-poll-votes","quote-message","read-events","search-messages","send-custom-events","send-links","send-message","send-poll","send-reaction","send-reply","send-restricted-visibility-message","send-typing-events","set-channel-cooldown","share-location","skip-slow-mode","slow-mode","typing-events","update-any-message","update-channel","update-channel-members","update-own-message","update-thread","upload-file"],"title":"ChannelOwnCapability","type":"string"},"ChannelPushPreferences":{"properties":{"chat_level":{"type":"string","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"number","x-stream-index":"002"}},"type":"object"},"ChannelResponse":{"description":"Represents channel in chat","properties":{"auto_translation_enabled":{"description":"Whether auto translation is enabled or not","title":"Auto translation","type":"boolean","x-stream-index":"017"},"auto_translation_language":{"description":"Language to translate to when auto translation is active","title":"Auto translation language","type":"string","x-stream-index":"018"},"blocked":{"description":"Whether this channel is blocked by current user or not","title":"Blocked","type":"boolean","x-stream-index":"023"},"cid":{"description":"Channel CID (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/ChannelConfigWithInfo","description":"Channel configuration","title":"ChannelConfigWithInfo","x-stream-index":"013"},"cooldown":{"description":"Cooldown period after sending each message","format":"int32","title":"Cooldown","type":"integer","x-stream-index":"020"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"005"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"Creator of the channel","title":"UserResponse","x-stream-index":"008"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"026"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"007"},"disabled":{"type":"boolean","x-stream-index":"010"},"frozen":{"description":"Whether channel is frozen or not","title":"Frozen","type":"boolean","x-stream-index":"009"},"hidden":{"description":"Whether this channel is hidden by current user or not","title":"Hidden","type":"boolean","x-stream-index":"022"},"hide_messages_before":{"description":"Date since when the message history is accessible","format":"date-time","title":"Hide messages before","type":"number","x-stream-index":"019"},"id":{"description":"Channel unique ID","title":"ID","type":"string","x-stream-index":"001"},"last_message_at":{"description":"Date of the last message sent","format":"date-time","title":"Last message at","type":"number","x-stream-index":"004"},"member_count":{"description":"Number of members in the channel","format":"int32","title":"Member count","type":"integer","x-stream-index":"012"},"members":{"description":"List of channel members (max 100)","items":{"$ref":"#/components/schemas/ChannelMember"},"title":"ChannelMembers","type":"array","x-stream-index":"011"},"message_count":{"description":"Number of messages in the channel","format":"int64","title":"Message count","type":"integer","x-stream-index":"027"},"mute_expires_at":{"description":"Date of mute expiration","format":"date-time","title":"Mute expires at","type":"number","x-stream-index":"015"},"muted":{"description":"Whether this channel is muted or not","title":"Muted","type":"boolean","x-stream-index":"014"},"own_capabilities":{"description":"List of channel capabilities of authenticated user","items":{"$ref":"#/components/schemas/ChannelOwnCapability"},"title":"ChannelOwnCapability","type":"array","x-stream-index":"021"},"team":{"description":"Team the channel belongs to (multi-tenant only)","title":"Team","type":"string","x-stream-index":"016"},"truncated_at":{"description":"Date of the latest truncation of the channel","format":"date-time","title":"UserResponse","type":"number","x-stream-index":"024"},"truncated_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"025"},"type":{"description":"Type of the channel","title":"Type","type":"string","x-stream-docs-page-id":"channel_features","x-stream-index":"002"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"006"}},"required":["id","type","cid","created_at","updated_at","frozen","disabled","custom"],"title":"Channel","type":"object"},"ChannelStateResponse":{"nullable":true,"properties":{"active_live_locations":{"items":{"$ref":"#/components/schemas/SharedLocationResponseData"},"type":"array","x-stream-index":"001.015"},"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001.001"},"deleted_messages":{"items":{"type":"string"},"type":"array","x-stream-index":"001.016"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001.014"},"duration":{"type":"string","x-stream-index":"002.001"},"hidden":{"type":"boolean","x-stream-index":"001.011"},"hide_messages_before":{"format":"date-time","type":"number","x-stream-index":"001.012"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"001.007"},"membership":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"001.008"},"messages":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","x-stream-index":"001.002"},"pending_messages":{"items":{"$ref":"#/components/schemas/PendingMessageResponse"},"type":"array","x-stream-index":"001.013"},"pinned_messages":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","x-stream-index":"001.003"},"push_preferences":{"$ref":"#/components/schemas/ChannelPushPreferences","x-stream-index":"001.009"},"read":{"items":{"$ref":"#/components/schemas/ReadStateResponse"},"type":"array","x-stream-index":"001.006"},"threads":{"items":{"$ref":"#/components/schemas/ThreadStateResponse"},"type":"array","x-stream-index":"001.010"},"watcher_count":{"format":"int32","type":"integer","x-stream-index":"001.004"},"watchers":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"001.005"}},"required":["messages","pinned_messages","members","threads","duration"],"type":"object"},"ChannelStateResponseFields":{"properties":{"active_live_locations":{"description":"Active live locations in the channel","items":{"$ref":"#/components/schemas/SharedLocationResponseData"},"title":"Active Live Locations","type":"array","x-stream-index":"015"},"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001"},"deleted_messages":{"items":{"type":"string"},"type":"array","x-stream-index":"016"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"014"},"hidden":{"description":"Whether this channel is hidden or not","title":"Hidden","type":"boolean","x-stream-index":"011"},"hide_messages_before":{"description":"Messages before this date are hidden from the user","format":"date-time","title":"Hide messages before","type":"number","x-stream-index":"012"},"members":{"description":"List of channel members","items":{"$ref":"#/components/schemas/ChannelMember"},"title":"Members","type":"array","x-stream-index":"007"},"membership":{"$ref":"#/components/schemas/ChannelMember","description":"Current user membership object","title":"Membership","x-stream-index":"008"},"messages":{"description":"List of channel messages","items":{"$ref":"#/components/schemas/MessageResponse"},"title":"Message","type":"array","x-stream-index":"002"},"pending_messages":{"description":"Pending messages that this user has sent","items":{"$ref":"#/components/schemas/PendingMessageResponse"},"title":"Pending messages","type":"array","x-stream-index":"013"},"pinned_messages":{"description":"List of pinned messages in the channel","items":{"$ref":"#/components/schemas/MessageResponse"},"title":"Pinned messages","type":"array","x-stream-docs-page-id":"pinned_messages","x-stream-index":"003"},"push_preferences":{"$ref":"#/components/schemas/ChannelPushPreferences","x-stream-index":"009"},"read":{"description":"List of read states","items":{"$ref":"#/components/schemas/ReadStateResponse"},"title":"Read","type":"array","x-stream-index":"006"},"threads":{"items":{"$ref":"#/components/schemas/ThreadStateResponse"},"type":"array","x-stream-index":"010"},"watcher_count":{"description":"Number of channel watchers","format":"int32","title":"Watcher count","type":"integer","x-stream-index":"004"},"watchers":{"description":"List of user who is watching the channel","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Watchers","type":"array","x-stream-index":"005"}},"required":["messages","pinned_messages","members","threads"],"type":"object"},"ChannelStopWatchingRequest":{"nullable":true,"type":"object"},"ChannelTruncatedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001.004"},"channel_id":{"type":"string","x-stream-index":"001.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"001.005"},"channel_type":{"type":"string","x-stream-index":"001.003"},"cid":{"type":"string","x-stream-index":"001.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"type":{"default":"channel.truncated","type":"string","x-stream-index":"002.001"}},"required":["cid","channel_id","channel_type","channel_member_count","type","created_at"],"title":"ChannelTruncatedEvent","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"},"ChannelUnFrozenEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"channel.unfrozen","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"ChannelUnFrozenEvent","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"},"ChannelUpdatedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"004.004"},"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"004.005"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"002.001"},"type":{"default":"channel.updated","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"ChannelUpdatedEvent","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"},"ChannelVisibleEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"001.002"},"channel_type":{"type":"string","x-stream-index":"001.003"},"cid":{"type":"string","x-stream-index":"001.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"type":{"default":"channel.visible","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"ChannelVisibleEvent","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"},"Command":{"description":"Represents custom chat command","nullable":true,"properties":{"args":{"description":"Arguments help text, shown in commands auto-completion","title":"Arguments","type":"string","x-stream-index":"006"},"created_at":{"description":"Date/time of creation","format":"date-time","readOnly":true,"title":"Created at","type":"number","x-stream-index":"001"},"description":{"description":"Description, shown in commands auto-completion","title":"Description","type":"string","x-stream-index":"005"},"name":{"description":"Unique command name","title":"Name","type":"string","x-stream-index":"004"},"set":{"description":"Set name used for grouping commands","title":"Set","type":"string","x-stream-index":"007"},"updated_at":{"description":"Date/time of the last update","format":"date-time","readOnly":true,"title":"Updated at","type":"number","x-stream-index":"002"}},"required":["name","description","args","set"],"title":"Command","type":"object"},"CompositeAppSettings":{"properties":{"json_encoded_settings":{"type":"string","x-stream-index":"005"},"url":{"type":"string","x-stream-index":"004"}},"type":"object"},"ConfigOverrides":{"properties":{"blocklist":{"type":"string","x-stream-index":"008"},"blocklist_behavior":{"enum":["flag","block"],"type":"string","x-stream-index":"009"},"commands":{"items":{"type":"string"},"type":"array","x-stream-index":"011"},"count_messages":{"type":"boolean","x-stream-index":"014"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"010"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"007"},"quotes":{"type":"boolean","x-stream-index":"004"},"reactions":{"type":"boolean","x-stream-index":"002"},"replies":{"type":"boolean","x-stream-index":"003"},"shared_locations":{"type":"boolean","x-stream-index":"013"},"typing_events":{"type":"boolean","x-stream-index":"001"},"uploads":{"type":"boolean","x-stream-index":"005"},"url_enrichment":{"type":"boolean","x-stream-index":"006"},"user_message_reminders":{"type":"boolean","x-stream-index":"012"}},"required":["grants","commands"],"type":"object"},"ConfigResponse":{"properties":{"ai_image_config":{"$ref":"#/components/schemas/AIImageConfig","description":"Configuration for AI image analysis","title":"AI Image Config","x-stream-index":"010"},"ai_text_config":{"$ref":"#/components/schemas/AITextConfig","description":"Configuration for AI text analysis","title":"AI Text Config","x-stream-index":"008"},"ai_video_config":{"$ref":"#/components/schemas/AIVideoConfig","description":"Configuration for AI video analysis","title":"AI Video Config","x-stream-index":"011"},"async":{"description":"Whether moderation should be performed asynchronously","title":"Async","type":"boolean","x-stream-index":"003"},"automod_platform_circumvention_config":{"$ref":"#/components/schemas/AutomodPlatformCircumventionConfig","description":"Configuration for platform circumvention detection","title":"Automod Platform Circumvention Config","x-stream-index":"005"},"automod_semantic_filters_config":{"$ref":"#/components/schemas/AutomodSemanticFiltersConfig","description":"Configuration for semantic filtering","title":"Automod Semantic Filters Config","x-stream-index":"006"},"automod_toxicity_config":{"$ref":"#/components/schemas/AutomodToxicityConfig","description":"Configuration for toxicity detection","title":"Automod Toxicity Config","x-stream-index":"004"},"block_list_config":{"$ref":"#/components/schemas/BlockListConfig","description":"Configuration for block list filtering","title":"Block List Config","x-stream-index":"007"},"created_at":{"description":"When the configuration was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"013"},"key":{"description":"Unique identifier for the moderation configuration","title":"Key","type":"string","x-stream-index":"001"},"llm_config":{"$ref":"#/components/schemas/LLMConfig","description":"Configuration for customer-configured LLM moderation","title":"LLM Config","x-stream-index":"009"},"team":{"description":"Team associated with the configuration","title":"Team","type":"string","x-stream-index":"002"},"updated_at":{"description":"When the configuration was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"014"},"velocity_filter_config":{"$ref":"#/components/schemas/VelocityFilterConfig","description":"Configuration for velocity-based filtering","title":"Velocity Filter Config","x-stream-index":"012"},"video_call_rule_config":{"$ref":"#/components/schemas/VideoCallRuleConfig","x-stream-index":"015"}},"required":["key","team","async","created_at","updated_at"],"type":"object"},"ConnectUserDetailsRequest":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001"},"image":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"006"},"language":{"type":"string","x-stream-index":"005"},"name":{"type":"string","x-stream-index":"002"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"007"}},"required":["id"],"type":"object"},"ContentCountRuleParameters":{"properties":{"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"type":"object"},"CreateBlockListRequest":{"description":"Block list contains restricted words","nullable":true,"properties":{"name":{"description":"Block list name","maxLength":255,"title":"Name","type":"string","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"004"},"type":{"description":"Block list type.","enum":["regex","domain","domain_allowlist","email","word"],"title":"Type","type":"string","x-stream-index":"003"},"words":{"description":"List of words to block","items":{"type":"string"},"minimum":1,"title":"Words","type":"array","x-stream-index":"002"}},"required":["name","words"],"title":"Block list","type":"object","x-stream-docs-page-id":"block_lists"},"CreateBlockListResponse":{"description":"Basic response information","nullable":true,"properties":{"blocklist":{"$ref":"#/components/schemas/BlockListResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["duration"],"title":"Response","type":"object"},"CreateDeviceRequest":{"description":"Create device request","nullable":true,"properties":{"id":{"description":"Device ID","maxLength":255,"minLength":1,"title":"ID","type":"string","x-stream-index":"001"},"push_provider":{"description":"Push provider","enum":["firebase","apn","huawei","xiaomi"],"title":"PushProvider","type":"string","x-stream-index":"002"},"push_provider_name":{"description":"Push provider name","title":"PushProviderName","type":"string","x-stream-index":"003"},"voip_token":{"description":"When true the token is for Apple VoIP push notifications","title":"VoipToken","type":"boolean","x-stream-index":"004"}},"required":["id","push_provider"],"title":"CreateDeviceRequest","type":"object"},"CreateDraftRequest":{"nullable":true,"properties":{"message":{"$ref":"#/components/schemas/MessageRequest","x-stream-index":"001"}},"required":["message"],"type":"object"},"CreateDraftResponse":{"description":"Basic response information","nullable":true,"properties":{"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["draft","duration"],"title":"Response","type":"object"},"CreateGuestRequest":{"nullable":true,"properties":{"user":{"$ref":"#/components/schemas/UserRequest","description":"User object which server acts upon","title":"User","x-stream-index":"001"}},"required":["user"],"type":"object"},"CreateGuestResponse":{"nullable":true,"properties":{"access_token":{"description":"the access token to authenticate the user","title":"Access token","type":"string","x-stream-index":"002"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User object which server acts upon","title":"User","x-stream-index":"001"}},"required":["user","access_token","duration"],"type":"object"},"CreatePollOptionRequest":{"nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"003"},"text":{"description":"Option text","title":"string","type":"string","x-stream-index":"002"}},"required":["text"],"type":"object"},"CreatePollRequest":{"description":"Contains all information needed to create a new poll","nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"011"},"allow_answers":{"description":"Indicates whether users can suggest user defined answers","title":"Allow answers","type":"boolean","x-stream-index":"009"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"008"},"description":{"description":"A description of the poll","title":"Description","type":"string","x-stream-index":"003"},"enforce_unique_vote":{"description":"Indicates whether users can cast multiple votes","title":"Multiple choice","type":"boolean","x-stream-index":"006"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"is_closed":{"description":"Indicates whether the poll is open for voting","title":"Is closed","type":"boolean","x-stream-index":"010"},"max_votes_allowed":{"description":"Indicates the maximum amount of votes a user can cast","format":"int32","maximum":10,"title":"Maximum votes allowed","type":"integer","x-stream-index":"007"},"name":{"description":"The name of the poll","title":"Name","type":"string","x-stream-index":"002"},"options":{"items":{"$ref":"#/components/schemas/PollOptionInput"},"maximum":100,"type":"array","x-stream-index":"004"},"voting_visibility":{"enum":["anonymous","public"],"type":"string","x-stream-index":"005"}},"required":["name"],"title":"Create Poll Request","type":"object"},"CreateReminderRequest":{"nullable":true,"properties":{"remind_at":{"format":"date-time","type":"number","x-stream-index":"001"}},"type":"object"},"CustomActionRequest":{"properties":{"id":{"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"type":"object"},"Data":{"properties":{"id":{"type":"string","x-stream-index":"001"}},"required":["id"],"type":"object"},"DeleteActivityRequest":{"properties":{"hard_delete":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"DeleteChannelResponse":{"description":"Basic response information","nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"Response","type":"object"},"DeleteChannelsRequest":{"nullable":true,"properties":{"cids":{"description":"All channels that should be deleted","items":{"type":"string"},"maximum":100,"minimum":1,"title":"Channels CID","type":"array","x-stream-index":"001"},"hard_delete":{"description":"Specify if channels and all ressources should be hard deleted","title":"Hard delete","type":"boolean","x-stream-index":"002"}},"required":["cids"],"type":"object"},"DeleteChannelsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"result":{"additionalProperties":{"$ref":"#/components/schemas/DeleteChannelsResultResponse"},"description":"Map of channel IDs and their deletion results","title":"Result","type":"object","x-stream-index":"001"},"task_id":{"type":"string","x-stream-index":"002"}},"required":["duration"],"type":"object"},"DeleteChannelsResultResponse":{"nullable":true,"properties":{"error":{"type":"string","x-stream-index":"002"},"status":{"type":"string","x-stream-index":"001"}},"required":["status"],"type":"object"},"DeleteMessageRequest":{"properties":{"hard_delete":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"DeleteMessageResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001"}},"required":["message","duration"],"title":"Response","type":"object"},"DeleteModerationConfigResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"DeleteReactionRequest":{"properties":{"hard_delete":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"DeleteReactionResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001"},"reaction":{"$ref":"#/components/schemas/ReactionResponse","x-stream-index":"002"}},"required":["message","reaction","duration"],"title":"Response","type":"object"},"DeleteReminderResponse":{"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"},"DeleteUserRequest":{"properties":{"delete_conversation_channels":{"type":"boolean","x-stream-index":"003"},"delete_feeds_content":{"type":"boolean","x-stream-index":"004"},"hard_delete":{"type":"boolean","x-stream-index":"001"},"mark_messages_deleted":{"type":"boolean","x-stream-index":"002"}},"type":"object"},"Device":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"disabled":{"type":"boolean","x-stream-index":"002.003"},"disabled_reason":{"type":"string","x-stream-index":"002.004"},"id":{"type":"string","x-stream-index":"002.001.004"},"push_provider":{"enum":["firebase","apn","huawei","xiaomi"],"type":"string","x-stream-index":"002.001.001"},"push_provider_name":{"type":"string","x-stream-index":"002.001.003"},"user_id":{"type":"string","x-stream-index":"004"},"voip":{"type":"boolean","x-stream-index":"002.001.005"}},"required":["push_provider","id","created_at","user_id"],"type":"object"},"DeviceResponse":{"description":"Response for Device","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"004"},"disabled":{"description":"Whether device is disabled or not","title":"Disabled","type":"boolean","x-stream-index":"005"},"disabled_reason":{"description":"Reason explaining why device had been disabled","title":"Reason","type":"string","x-stream-index":"006"},"id":{"description":"Device ID","title":"ID","type":"string","x-stream-index":"003"},"push_provider":{"description":"Push provider","title":"PushProvider","type":"string","x-stream-index":"001"},"push_provider_name":{"description":"Push provider name","title":"PushProviderName","type":"string","x-stream-index":"002"},"user_id":{"description":"User ID","title":"UserID","type":"string","x-stream-index":"008"},"voip":{"description":"When true the token is for Apple VoIP push notifications","title":"Voip","type":"boolean","x-stream-index":"007"}},"required":["push_provider","id","created_at","user_id"],"title":"DeviceResponse","type":"object"},"DraftDeletedEvent":{"description":"Emitted when a Draft is deleted.","nullable":true,"properties":{"cid":{"description":"The CID of the channel where the draft was created","title":"Channel CID","type":"string","x-stream-index":"001.001.002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.001.007"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001.003"},"parent_id":{"description":"The ID of the parent message","title":"Message ID","type":"string","x-stream-index":"001.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.001.004"},"type":{"default":"draft.deleted","description":"The type of event: \"draft.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.001.002"}},"required":["type","created_at","custom"],"title":"DraftDeletedEvent","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"},"DraftPayloadResponse":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"html":{"type":"string","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"001"},"mentioned_users":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"008"},"mml":{"type":"string","x-stream-index":"003"},"parent_id":{"type":"string","x-stream-index":"005"},"poll_id":{"type":"string","x-stream-index":"013"},"quoted_message_id":{"type":"string","x-stream-index":"009"},"show_in_channel":{"type":"boolean","x-stream-index":"006"},"silent":{"type":"boolean","x-stream-index":"012"},"text":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"011"}},"required":["id","text","custom"],"type":"object"},"DraftResponse":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003"},"channel_cid":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"message":{"$ref":"#/components/schemas/DraftPayloadResponse","x-stream-index":"001"},"parent_id":{"type":"string","x-stream-index":"004"},"parent_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"005"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"006"}},"required":["message","channel_cid","created_at"],"type":"object"},"DraftUpdatedEvent":{"description":"Emitted when a Draft is created or updated.","nullable":true,"properties":{"cid":{"description":"The CID of the channel where the draft was created/updated","title":"Channel CID","type":"string","x-stream-index":"001.001.002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.001.007"},"draft":{"$ref":"#/components/schemas/DraftResponse","description":"The draft object which was created/updated","title":"Draft","x-stream-index":"001.003"},"parent_id":{"description":"The ID of the parent message","title":"Parent ID","type":"string","x-stream-index":"001.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.001.004"},"type":{"default":"draft.updated","description":"The type of event: \"draft.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.001.002"}},"required":["type","created_at","custom"],"title":"DraftUpdatedEvent","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"},"EgressHLSResponse":{"properties":{"playlist_url":{"type":"string","x-stream-index":"001"},"status":{"type":"string","x-stream-index":"002"}},"required":["playlist_url","status"],"type":"object"},"EgressRTMPResponse":{"properties":{"name":{"type":"string","x-stream-index":"001"},"started_at":{"format":"date-time","type":"number","x-stream-index":"004"},"stream_key":{"type":"string","x-stream-index":"003"},"stream_url":{"type":"string","x-stream-index":"002"}},"required":["name","started_at"],"type":"object"},"EgressResponse":{"properties":{"broadcasting":{"type":"boolean","x-stream-index":"001"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordingResponse","x-stream-index":"004"},"hls":{"$ref":"#/components/schemas/EgressHLSResponse","x-stream-index":"002"},"rtmps":{"items":{"$ref":"#/components/schemas/EgressRTMPResponse"},"type":"array","x-stream-index":"003"}},"required":["broadcasting","rtmps"],"type":"object"},"EgressTaskConfig":{"properties":{"egress_user":{"$ref":"#/components/schemas/EgressUser","x-stream-index":"008"},"frame_recording_egress_config":{"$ref":"#/components/schemas/FrameRecordingEgressConfig","x-stream-index":"009"},"hls_egress_config":{"$ref":"#/components/schemas/HLSEgressConfig","x-stream-index":"007"},"recording_egress_config":{"$ref":"#/components/schemas/RecordingEgressConfig","x-stream-index":"006"},"rtmp_egress_config":{"$ref":"#/components/schemas/RTMPEgressConfig","x-stream-index":"004"},"stt_egress_config":{"$ref":"#/components/schemas/STTEgressConfig","x-stream-index":"005"}},"type":"object"},"EgressUser":{"properties":{"token":{"type":"string","x-stream-index":"004"}},"type":"object"},"EnrichedActivity":{"properties":{"actor":{"$ref":"#/components/schemas/Data","x-stream-index":"002"},"foreign_id":{"type":"string","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"latest_reactions":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"013"},"object":{"$ref":"#/components/schemas/Data","x-stream-index":"004"},"origin":{"$ref":"#/components/schemas/Data","x-stream-index":"008"},"own_reactions":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"012"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"011"},"score":{"format":"float","type":"number","x-stream-index":"010"},"target":{"$ref":"#/components/schemas/Data","x-stream-index":"006"},"to":{"items":{"type":"string"},"type":"array","x-stream-index":"009"},"verb":{"type":"string","x-stream-index":"003"}},"type":"object"},"EnrichedReaction":{"nullable":true,"properties":{"activity_id":{"type":"string","x-stream-index":"003"},"children_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"010"},"created_at":{"$ref":"#/components/schemas/Time","x-stream-index":"012"},"data":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"kind":{"type":"string","x-stream-index":"002"},"latest_children":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"008"},"own_children":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"009"},"parent":{"type":"string","x-stream-index":"007"},"target_feeds":{"items":{"type":"string"},"type":"array","x-stream-index":"006"},"updated_at":{"$ref":"#/components/schemas/Time","x-stream-index":"013"},"user":{"$ref":"#/components/schemas/Data","x-stream-index":"011"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["kind","activity_id","user_id"],"type":"object"},"EntityCreator":{"properties":{"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"001.046"},"ban_count":{"format":"int32","type":"integer","x-stream-index":"002"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"001.017"},"banned":{"type":"boolean","x-stream-index":"001.016"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.013"},"deleted_content_count":{"format":"int32","type":"integer","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"001.023"},"language":{"type":"string","x-stream-index":"001.035"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"001.022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"001.026"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.042"},"role":{"type":"string","x-stream-index":"001.004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.005"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.009"}},"required":["id","role","teams_role","custom","banned","online","ban_count","deleted_content_count"],"type":"object"},"EntityCreatorResponse":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.001.018"},"ban_count":{"description":"Number of minor actions performed on the user","format":"int32","title":"Ban Count","type":"integer","x-stream-index":"002"},"banned":{"type":"boolean","x-stream-index":"001.001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.001.017"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.001.016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.001.011"},"deleted_content_count":{"description":"Number of major actions performed on the user","format":"int32","title":"Deleted Content Count","type":"integer","x-stream-index":"003"},"flagged_count":{"description":"Number of flag actions performed on the user","format":"int32","title":"Flagged Count","type":"integer","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001.001.001"},"image":{"type":"string","x-stream-index":"001.001.003"},"language":{"type":"string","x-stream-index":"001.001.005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"001.001.014"},"name":{"type":"string","x-stream-index":"001.001.002"},"online":{"type":"boolean","x-stream-index":"001.001.013"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.001.015"},"role":{"type":"string","x-stream-index":"001.001.006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.001.008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids","shadow_banned","invisible","ban_count","deleted_content_count","flagged_count"],"type":"object"},"EventNotificationSettings":{"properties":{"apns":{"$ref":"#/components/schemas/APNS","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"fcm":{"$ref":"#/components/schemas/FCM","x-stream-index":"003"}},"required":["enabled","apns","fcm"],"type":"object"},"EventRequest":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"parent_id":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"001"}},"required":["type"],"type":"object"},"EventResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"event":{"$ref":"#/components/schemas/WSEvent","x-stream-index":"001"}},"required":["event","duration"],"title":"Response","type":"object"},"ExternalStorage":{"properties":{"abs_account_name":{"type":"string","x-stream-index":"011"},"abs_client_id":{"type":"string","x-stream-index":"013"},"abs_client_secret":{"type":"string","x-stream-index":"014"},"abs_tenant_id":{"type":"string","x-stream-index":"012"},"bucket":{"type":"string","x-stream-index":"005"},"gcs_credentials":{"type":"string","x-stream-index":"010"},"path":{"type":"string","x-stream-index":"006"},"s3_api_key":{"type":"string","x-stream-index":"007"},"s3_custom_endpoint":{"type":"string","x-stream-index":"016"},"s3_region":{"type":"string","x-stream-index":"009"},"s3_secret_key":{"type":"string","x-stream-index":"008"},"storage_name":{"type":"string","x-stream-index":"015"},"storage_type":{"type":"integer","x-stream-index":"004"}},"type":"object"},"FCM":{"properties":{"data":{"additionalProperties":{},"type":"object","x-stream-index":"001"}},"type":"object"},"FeedsEventPreferences":{"properties":{"comments":{"type":"string","x-stream-index":"002"},"mentions":{"type":"string","x-stream-index":"004"},"new_followers":{"type":"string","x-stream-index":"003"},"reactions":{"type":"string","x-stream-index":"001"}},"type":"object"},"FeedsEventPreferencesInput":{"properties":{"comments":{"enum":["all","none"],"type":"string","x-stream-index":"002"},"mentions":{"enum":["all","none"],"type":"string","x-stream-index":"004"},"new_followers":{"enum":["all","none"],"type":"string","x-stream-index":"003"},"reactions":{"enum":["all","none"],"type":"string","x-stream-index":"001"}},"type":"object"},"Field":{"nullable":true,"properties":{"short":{"type":"boolean","x-stream-index":"003"},"title":{"type":"string","x-stream-index":"001"},"value":{"type":"string","x-stream-index":"002"}},"required":["title","value","short"],"type":"object"},"FileUploadConfig":{"properties":{"allowed_file_extensions":{"items":{"type":"string"},"type":"array","x-stream-index":"001"},"allowed_mime_types":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"blocked_file_extensions":{"items":{"type":"string"},"type":"array","x-stream-index":"002"},"blocked_mime_types":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"size_limit":{"format":"int32","maximum":104857600,"minimum":0,"type":"integer","x-stream-index":"005"}},"required":["allowed_file_extensions","blocked_file_extensions","allowed_mime_types","blocked_mime_types","size_limit"],"type":"object"},"FileUploadRequest":{"nullable":true,"properties":{"file":{"description":"file field","title":"File","type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/OnlyUserID","description":"user for the request **server side only**","title":"User","x-stream-index":"002"}},"type":"object"},"FileUploadResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"file":{"description":"URL to the uploaded asset. Should be used to put to `asset_url` attachment field","title":"File","type":"string","x-stream-index":"001"},"thumb_url":{"description":"URL of the file thumbnail for supported file formats. Should be put to `thumb_url` attachment field","title":"Thumbnail URL","type":"string","x-stream-index":"002"}},"required":["duration"],"type":"object"},"Flag":{"description":"Contains information about flagged user or message","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"019"},"custom":{"additionalProperties":{},"description":"Additional metadata about the flag","title":"Custom","type":"object","x-stream-index":"014"},"entity_creator_id":{"description":"ID of the user who created the flagged entity","title":"Entity Creator ID","type":"string","x-stream-index":"009"},"entity_id":{"description":"Unique identifier of the entity being flagged","title":"Entity ID","type":"string","x-stream-index":"008"},"entity_type":{"description":"Type of entity being flagged (e.g., message, user)","title":"Entity Type","type":"string","x-stream-index":"007"},"is_streamed_content":{"type":"boolean","x-stream-index":"012"},"labels":{"description":"Labels from bodyguard, API calls, our own AI etc","items":{"type":"string"},"title":"Labels","type":"array","x-stream-index":"015"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content being flagged","title":"Moderation Payload","x-stream-index":"010"},"moderation_payload_hash":{"type":"string","x-stream-index":"011"},"reason":{"description":"Optional explanation for why the content is being flagged","title":"Reason","type":"string","x-stream-index":"013"},"result":{"description":"Result of bodyguard, API calls, our own AI etc","items":{"additionalProperties":{},"type":"object"},"title":"Result","type":"array","x-stream-index":"016"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"018"},"review_queue_item_id":{"description":"ID of the review queue item","title":"Review Queue Item ID","type":"string","x-stream-index":"017"},"type":{"type":"string","x-stream-index":"004"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"020"},"user":{"$ref":"#/components/schemas/User","description":"User who flagged a message or a user","title":"User","x-stream-index":"006"}},"required":["entity_type","entity_id","result","created_at","updated_at"],"title":"Flag","type":"object"},"FlagContentOptions":{"properties":{"reason":{"type":"string","x-stream-index":"001"}},"type":"object"},"FlagDetails":{"properties":{"Extra":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"002"},"automod":{"$ref":"#/components/schemas/AutomodDetails","x-stream-index":"001"},"original_text":{"type":"string","x-stream-index":"003"}},"required":["Extra","original_text"],"type":"object"},"FlagFeedback":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"005"},"labels":{"items":{"$ref":"#/components/schemas/Label"},"type":"array","x-stream-index":"006"},"message_id":{"type":"string","x-stream-index":"004"}},"required":["message_id","created_at","labels"],"type":"object"},"FlagMessageDetails":{"properties":{"pin_changed":{"type":"boolean","x-stream-index":"002"},"should_enrich":{"type":"boolean","x-stream-index":"003"},"skip_push":{"type":"boolean","x-stream-index":"004"},"updated_by_id":{"type":"string","x-stream-index":"001"}},"type":"object"},"FlagRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"description":"Additional metadata about the flag","title":"Custom","type":"object","x-stream-index":"006"},"entity_creator_id":{"description":"ID of the user who created the flagged entity","title":"Entity Creator ID","type":"string","x-stream-index":"003"},"entity_id":{"description":"Unique identifier of the entity being flagged","title":"Entity ID","type":"string","x-stream-index":"002"},"entity_type":{"description":"Type of entity being flagged (e.g., message, user)","title":"Entity Type","type":"string","x-stream-index":"001"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content being flagged","title":"Moderation Payload","x-stream-index":"005"},"reason":{"description":"Optional explanation for why the content is being flagged","maxLength":255,"title":"Reason","type":"string","x-stream-index":"004"}},"required":["entity_type","entity_id"],"type":"object"},"FlagResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"item_id":{"description":"Unique identifier of the created moderation item","title":"Item ID","type":"string","x-stream-index":"001"}},"required":["item_id","duration"],"type":"object"},"FlagUserOptions":{"properties":{"reason":{"type":"string","x-stream-index":"001"}},"type":"object"},"FrameRecordSettings":{"properties":{"capture_interval_in_seconds":{"format":"int32","maximum":60,"minimum":2,"type":"integer","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"},"quality":{"type":"string","x-stream-index":"002"}},"required":["mode","capture_interval_in_seconds"],"type":"object"},"FrameRecordingEgressConfig":{"properties":{"capture_interval_in_seconds":{"format":"int32","type":"integer","x-stream-index":"007"},"external_storage":{"$ref":"#/components/schemas/ExternalStorage","x-stream-index":"006"},"quality":{"$ref":"#/components/schemas/Quality","x-stream-index":"004"},"storage_name":{"type":"string","x-stream-index":"005"}},"type":"object"},"FrameRecordingResponse":{"properties":{"status":{"type":"string","x-stream-index":"001"}},"required":["status"],"type":"object"},"FrameRecordingSettingsResponse":{"properties":{"capture_interval_in_seconds":{"format":"int32","maximum":60,"minimum":2,"type":"integer","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"},"quality":{"type":"string","x-stream-index":"002"}},"required":["mode","capture_interval_in_seconds"],"type":"object"},"FullUserResponse":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"015"},"banned":{"type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"014"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.011"},"devices":{"items":{"$ref":"#/components/schemas/DeviceResponse"},"type":"array","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001.001"},"image":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"005"},"language":{"type":"string","x-stream-index":"001.005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"001.014"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"012"},"mutes":{"items":{"$ref":"#/components/schemas/UserMuteResponse"},"type":"array","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"001.002"},"online":{"type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"003"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.015"},"role":{"type":"string","x-stream-index":"001.006"},"shadow_banned":{"type":"boolean","x-stream-index":"013"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"009"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"010"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"008"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"011"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","devices","invisible","mutes","channel_mutes","unread_count","total_unread_count","unread_channels","unread_threads","shadow_banned","blocked_user_ids"],"type":"object"},"GeofenceSettings":{"properties":{"names":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"required":["names"],"type":"object"},"GeofenceSettingsResponse":{"properties":{"names":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"required":["names"],"type":"object"},"GetApplicationResponse":{"description":"Basic response information","nullable":true,"properties":{"app":{"$ref":"#/components/schemas/AppResponseFields","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["app","duration"],"title":"Response","type":"object"},"GetBlockedUsersResponse":{"nullable":true,"properties":{"blocks":{"description":"Array of blocked user object","items":{"$ref":"#/components/schemas/BlockedUserResponse"},"title":"Blocks","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["blocks","duration"],"type":"object"},"GetConfigResponse":{"nullable":true,"properties":{"config":{"$ref":"#/components/schemas/ConfigResponse","description":"The retrieved moderation configuration","title":"Config","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["duration"],"type":"object"},"GetDraftResponse":{"description":"Basic response information","nullable":true,"properties":{"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["draft","duration"],"title":"Response","type":"object"},"GetManyMessagesResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.002.001"},"messages":{"description":"List of messages","items":{"$ref":"#/components/schemas/MessageResponse"},"title":"Messages","type":"array","x-stream-index":"001.001"}},"required":["messages","duration"],"type":"object"},"GetMessageResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageWithChannelResponse","x-stream-index":"001"},"pending_message_metadata":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"002"}},"required":["message","duration"],"title":"Response","type":"object"},"GetOGResponse":{"nullable":true,"properties":{"actions":{"items":{"$ref":"#/components/schemas/Action"},"type":"array","x-stream-index":"001.015"},"asset_url":{"description":"URL of detected video or audio","title":"Image URL","type":"string","x-stream-index":"001.017"},"author_icon":{"type":"string","x-stream-index":"001.007"},"author_link":{"description":"og:site","title":"Author Link","type":"string","x-stream-index":"001.006"},"author_name":{"description":"og:site_name","title":"Author Name","type":"string","x-stream-index":"001.005"},"color":{"type":"string","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.018"},"duration":{"type":"string","x-stream-index":"002.001"},"fallback":{"type":"string","x-stream-index":"001.002"},"fields":{"items":{"$ref":"#/components/schemas/Field"},"type":"array","x-stream-index":"001.016"},"footer":{"type":"string","x-stream-index":"001.013"},"footer_icon":{"type":"string","x-stream-index":"001.014"},"giphy":{"$ref":"#/components/schemas/Images","x-stream-index":"001.019"},"image_url":{"description":"URL of detected image","title":"Image URL","type":"string","x-stream-index":"001.011"},"og_scrape_url":{"description":"extracted url from the text","title":"OG Scrape URL","type":"string","x-stream-index":"001.020"},"original_height":{"format":"int32","type":"integer","x-stream-index":"001.022"},"original_width":{"format":"int32","type":"integer","x-stream-index":"001.021"},"pretext":{"type":"string","x-stream-index":"001.004"},"text":{"description":"og:description","title":"Text","type":"string","x-stream-index":"001.010"},"thumb_url":{"description":"URL of detected thumb image","title":"Image URL","type":"string","x-stream-index":"001.012"},"title":{"description":"og:title","title":"Title","type":"string","x-stream-index":"001.008"},"title_link":{"description":"og:url","title":"Title Link","type":"string","x-stream-index":"001.009"},"type":{"description":"Attachment type, could be empty, image, audio or video","title":"Type","type":"string","x-stream-index":"001.001"}},"required":["custom","duration"],"title":"Get OG Attachment","type":"object","x-stream-docs-page-id":"og"},"GetReactionsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"reactions":{"description":"List of reactions","items":{"$ref":"#/components/schemas/Reaction"},"title":"Reactions","type":"array","x-stream-index":"001"}},"required":["reactions","duration"],"type":"object"},"GetRepliesResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"messages":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","x-stream-index":"001"}},"required":["messages","duration"],"title":"Response","type":"object"},"GetThreadResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"thread":{"$ref":"#/components/schemas/ThreadStateResponse","description":"Enriched thread state","title":"Thread","x-stream-index":"001"}},"required":["thread","duration"],"type":"object"},"GoogleVisionConfig":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"HLSEgressConfig":{"properties":{"composite_app_settings":{"$ref":"#/components/schemas/CompositeAppSettings","x-stream-index":"005"},"playlist_url":{"type":"string","x-stream-index":"007"},"qualities":{"items":{"$ref":"#/components/schemas/Quality"},"type":"array","x-stream-index":"004"},"start_unix_nano":{"format":"int64","type":"integer","x-stream-index":"006"}},"type":"object"},"HLSSettings":{"properties":{"auto_on":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"004"},"quality_tracks":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"required":["auto_on","enabled","quality_tracks"],"type":"object"},"HLSSettingsResponse":{"description":"HLSSettings is the payload for HLS settings","properties":{"auto_on":{"title":"Auto On","type":"boolean","x-stream-index":"001"},"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"002"},"quality_tracks":{"items":{"type":"string"},"title":"Quality Tracks","type":"array","x-stream-index":"003"}},"required":["auto_on","enabled","quality_tracks","layout"],"title":"HLSSettingsResponse","type":"object"},"HarmConfig":{"properties":{"action_sequences":{"items":{"$ref":"#/components/schemas/ActionSequence"},"type":"array","x-stream-index":"001"},"severity":{"type":"integer","x-stream-index":"002"}},"required":["action_sequences","severity"],"type":"object"},"HealthCheckEvent":{"nullable":true,"properties":{"cid":{"type":"string","x-stream-index":"003"},"connection_id":{"type":"string","x-stream-index":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004.007"},"me":{"$ref":"#/components/schemas/OwnUserResponse","x-stream-index":"002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"004.004"},"type":{"default":"health.check","type":"string","x-stream-index":"004.002"}},"required":["connection_id","type","created_at","custom"],"title":"HealthCheckEvent","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"},"HideChannelRequest":{"nullable":true,"properties":{"clear_history":{"description":"Whether to clear message history of the channel or not","title":"Clear history","type":"boolean","x-stream-index":"001"}},"type":"object"},"HideChannelResponse":{"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"},"ImageContentParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"type":"object"},"ImageData":{"properties":{"frames":{"type":"string","x-stream-index":"005"},"height":{"type":"string","x-stream-index":"003"},"size":{"type":"string","x-stream-index":"004"},"url":{"type":"string","x-stream-index":"001"},"width":{"type":"string","x-stream-index":"002"}},"required":["url","width","height","size","frames"],"type":"object"},"ImageRuleParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"type":"object"},"ImageSize":{"properties":{"crop":{"description":"Crop mode","enum":["top","bottom","left","right","center"],"title":"Crop","type":"string","x-stream-index":"001"},"height":{"description":"Target image height","format":"int32","title":"Height","type":"integer","x-stream-index":"003"},"resize":{"description":"Resize method","enum":["clip","crop","scale","fill"],"title":"Resize","type":"string","x-stream-index":"002"},"width":{"description":"Target image width","format":"int32","title":"Width","type":"integer","x-stream-index":"004"}},"title":"Image size configuration","type":"object"},"ImageUploadRequest":{"nullable":true,"properties":{"file":{"type":"string","x-stream-index":"001.001"},"upload_sizes":{"description":"field with JSON-encoded array of image size configurations","items":{"$ref":"#/components/schemas/ImageSize"},"title":"Upload sizes","type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/OnlyUserID","x-stream-index":"001.002"}},"type":"object"},"ImageUploadResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.003.001"},"file":{"type":"string","x-stream-index":"001.001"},"thumb_url":{"type":"string","x-stream-index":"001.002"},"upload_sizes":{"description":"Array of image size configurations","items":{"$ref":"#/components/schemas/ImageSize"},"title":"Upload sizes","type":"array","x-stream-index":"002"}},"required":["duration"],"type":"object"},"Images":{"properties":{"fixed_height":{"$ref":"#/components/schemas/ImageData","x-stream-index":"002"},"fixed_height_downsampled":{"$ref":"#/components/schemas/ImageData","x-stream-index":"004"},"fixed_height_still":{"$ref":"#/components/schemas/ImageData","x-stream-index":"003"},"fixed_width":{"$ref":"#/components/schemas/ImageData","x-stream-index":"005"},"fixed_width_downsampled":{"$ref":"#/components/schemas/ImageData","x-stream-index":"007"},"fixed_width_still":{"$ref":"#/components/schemas/ImageData","x-stream-index":"006"},"original":{"$ref":"#/components/schemas/ImageData","x-stream-index":"001"}},"required":["original","fixed_height","fixed_height_still","fixed_height_downsampled","fixed_width","fixed_width_still","fixed_width_downsampled"],"type":"object"},"IngressAudioEncodingOptions":{"properties":{"bitrate":{"maximum":128000,"minimum":16000,"type":"integer","x-stream-index":"003"},"channels":{"enum":["1","2"],"format":"int32","type":"integer","x-stream-index":"001"},"enable_dtx":{"type":"boolean","x-stream-index":"002"}},"required":["channels","enable_dtx","bitrate"],"type":"object"},"IngressAudioEncodingResponse":{"properties":{"bitrate":{"format":"int32","type":"integer","x-stream-index":"003"},"channels":{"format":"int32","type":"integer","x-stream-index":"001"},"enable_dtx":{"type":"boolean","x-stream-index":"002"}},"required":["channels","enable_dtx","bitrate"],"type":"object"},"IngressSettings":{"properties":{"audio_encoding_options":{"$ref":"#/components/schemas/IngressAudioEncodingOptions","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"video_encoding_options":{"additionalProperties":{"$ref":"#/components/schemas/IngressVideoEncodingOptions"},"type":"object","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"IngressSettingsResponse":{"properties":{"audio_encoding_options":{"$ref":"#/components/schemas/IngressAudioEncodingResponse","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"video_encoding_options":{"additionalProperties":{"$ref":"#/components/schemas/IngressVideoEncodingResponse"},"type":"object","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"IngressVideoEncodingOptions":{"properties":{"layers":{"items":{"$ref":"#/components/schemas/IngressVideoLayer"},"minimum":1,"type":"array","x-stream-index":"001"}},"required":["layers"],"type":"object"},"IngressVideoEncodingResponse":{"properties":{"layers":{"items":{"$ref":"#/components/schemas/IngressVideoLayerResponse"},"type":"array","x-stream-index":"001"}},"required":["layers"],"type":"object"},"IngressVideoLayer":{"nullable":true,"properties":{"bitrate":{"minimum":1000,"type":"integer","x-stream-index":"002"},"codec":{"enum":["h264","vp8"],"type":"string","x-stream-index":"001"},"frame_rate":{"maximum":60,"minimum":1,"type":"integer","x-stream-index":"003"},"max_dimension":{"minimum":240,"type":"integer","x-stream-index":"005"},"min_dimension":{"minimum":240,"type":"integer","x-stream-index":"004"}},"required":["codec","bitrate","frame_rate","min_dimension","max_dimension"],"type":"object"},"IngressVideoLayerResponse":{"nullable":true,"properties":{"bitrate":{"type":"integer","x-stream-index":"002"},"codec":{"type":"string","x-stream-index":"001"},"frame_rate_limit":{"type":"integer","x-stream-index":"005"},"max_dimension":{"type":"integer","x-stream-index":"004"},"min_dimension":{"type":"integer","x-stream-index":"003"}},"required":["codec","bitrate","min_dimension","max_dimension","frame_rate_limit"],"type":"object"},"LLMConfig":{"properties":{"app_context":{"type":"string","x-stream-index":"005"},"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/LLMRule"},"type":"array","x-stream-index":"003"},"severity_descriptions":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"004"}},"required":["enabled","rules"],"type":"object"},"LLMRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove","keep"],"type":"string","x-stream-index":"003"},"description":{"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"},"severity_rules":{"items":{"$ref":"#/components/schemas/BodyguardSeverityRule"},"type":"array","x-stream-index":"004"}},"required":["label","description","action","severity_rules"],"type":"object"},"Label":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"phrase_list_ids":{"items":{"format":"int32","type":"integer"},"type":"array","x-stream-index":"002"}},"required":["name"],"type":"object"},"LabelThresholds":{"properties":{"block":{"description":"Threshold for automatic message block","format":"float","maximum":1,"minimum":0,"title":"Block","type":"number","x-stream-index":"002"},"flag":{"description":"Threshold for automatic message flag","format":"float","maximum":1,"minimum":0,"title":"Flag","type":"number","x-stream-index":"001"}},"type":"object"},"LayoutSettings":{"properties":{"detect_orientation":{"type":"boolean","x-stream-index":"005"},"external_app_url":{"type":"string","x-stream-index":"003"},"external_css_url":{"type":"string","x-stream-index":"004"},"name":{"enum":["spotlight","grid","single-participant","mobile","custom"],"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"required":["name","external_app_url","external_css_url"],"type":"object"},"LimitsSettings":{"properties":{"max_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"004"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"},"max_participants_exclude_owner":{"type":"boolean","x-stream-index":"003"},"max_participants_exclude_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"002"}},"required":["max_participants_exclude_roles"],"type":"object"},"LimitsSettingsResponse":{"properties":{"max_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"004"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"},"max_participants_exclude_owner":{"type":"boolean","x-stream-index":"003"},"max_participants_exclude_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"002"}},"required":["max_participants_exclude_roles"],"type":"object"},"ListBlockListResponse":{"description":"Basic response information","nullable":true,"properties":{"blocklists":{"items":{"$ref":"#/components/schemas/BlockListResponse"},"type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["blocklists","duration"],"title":"Response","type":"object"},"ListDevicesResponse":{"description":"List devices response","nullable":true,"properties":{"devices":{"description":"List of devices","items":{"$ref":"#/components/schemas/DeviceResponse"},"title":"Devices","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["devices","duration"],"title":"ListDevicesResponse","type":"object"},"MarkChannelsReadRequest":{"nullable":true,"properties":{"read_by_channel":{"additionalProperties":{"type":"string"},"description":"Map of channel ID to last read message ID","maximum":30,"title":"Read by channel","type":"object","x-stream-index":"001"}},"type":"object"},"MarkReadRequest":{"nullable":true,"properties":{"message_id":{"description":"ID of the message that is considered last read by client","title":"Message ID","type":"string","x-stream-index":"001"},"thread_id":{"description":"Optional Thread ID to specifically mark a given thread as read","title":"Thread ID","type":"string","x-stream-index":"002"}},"type":"object"},"MarkReadResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"event":{"$ref":"#/components/schemas/MessageReadEvent","description":"Mark read event","title":"Event","x-stream-index":"001"}},"required":["duration"],"type":"object"},"MarkReviewedRequest":{"properties":{"content_to_mark_as_reviewed_limit":{"format":"int32","maximum":2500,"type":"integer","x-stream-index":"002"},"disable_marking_content_as_reviewed":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"MarkUnreadRequest":{"nullable":true,"properties":{"message_id":{"description":"ID of the message from where the channel is marked unread","title":"Message ID","type":"string","x-stream-index":"001"},"thread_id":{"description":"Mark a thread unread, specify both the thread and message id","title":"Thread ID","type":"string","x-stream-index":"003"}},"type":"object"},"MemberAddedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"002.001"},"type":{"default":"member.added","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MemberAddedEvent","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"},"MemberLookup":{"properties":{"Limit":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"001"}},"required":["Limit"],"type":"object"},"MemberRemovedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"001.001"},"type":{"default":"member.removed","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MemberRemovedEvent","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"},"MemberUpdatedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"005.002"},"channel_type":{"type":"string","x-stream-index":"005.003"},"cid":{"type":"string","x-stream-index":"005.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"002.001"},"type":{"default":"member.updated","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MemberUpdatedEvent","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"},"MembersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"members":{"description":"List of found members","items":{"$ref":"#/components/schemas/ChannelMember"},"title":"Members","type":"array","x-stream-index":"001"}},"required":["members","duration"],"type":"object"},"Message":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"012"},"before_message_send_failed":{"type":"boolean","x-stream-index":"046"},"cid":{"type":"string","x-stream-index":"028"},"command":{"type":"string","x-stream-index":"006"},"created_at":{"format":"date-time","type":"number","x-stream-index":"030"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"034"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"033"},"deleted_for_me":{"type":"boolean","x-stream-index":"059"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"023"},"html":{"type":"string","x-stream-index":"007"},"i18n":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"044"},"id":{"type":"string","x-stream-index":"002"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"040"},"latest_reactions":{"items":{"$ref":"#/components/schemas/Reaction"},"type":"array","x-stream-index":"013"},"mentioned_users":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"043"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"052"},"mml":{"type":"string","x-stream-index":"005"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"056"},"own_reactions":{"items":{"$ref":"#/components/schemas/Reaction"},"type":"array","x-stream-index":"014"},"parent_id":{"type":"string","x-stream-index":"019"},"pin_expires":{"format":"date-time","type":"number","x-stream-index":"051"},"pinned":{"type":"boolean","x-stream-index":"047"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"048"},"pinned_by":{"$ref":"#/components/schemas/User","x-stream-index":"050"},"poll":{"$ref":"#/components/schemas/Poll","x-stream-index":"054"},"poll_id":{"type":"string","x-stream-index":"053"},"quoted_message":{"$ref":"#/components/schemas/Message","x-stream-index":"025"},"quoted_message_id":{"type":"string","x-stream-index":"024"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"015"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"017"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"016"},"reminder":{"$ref":"#/components/schemas/MessageReminder","x-stream-index":"058"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"022"},"restricted_visibility":{"items":{"type":"string"},"type":"array","x-stream-index":"011"},"shadowed":{"type":"boolean","x-stream-index":"036"},"shared_location":{"$ref":"#/components/schemas/SharedLocation","x-stream-index":"055"},"show_in_channel":{"type":"boolean","x-stream-index":"021"},"silent":{"type":"boolean","x-stream-index":"045"},"text":{"type":"string","x-stream-index":"004"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"027"},"type":{"type":"string","x-stream-index":"008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"031"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"010"}},"required":["id","text","html","type","restricted_visibility","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reaction_groups","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned"],"type":"object"},"MessageActionRequest":{"nullable":true,"properties":{"form_data":{"additionalProperties":{"type":"string"},"description":"ReadOnlyData to execute command with","title":"Form data","type":"object","x-stream-index":"002"}},"required":["form_data"],"type":"object"},"MessageChangeSet":{"properties":{"attachments":{"type":"boolean","x-stream-index":"005"},"custom":{"type":"boolean","x-stream-index":"001"},"html":{"type":"boolean","x-stream-index":"004"},"mentioned_user_ids":{"type":"boolean","x-stream-index":"006"},"mml":{"type":"boolean","x-stream-index":"003"},"pin":{"type":"boolean","x-stream-index":"009"},"quoted_message_id":{"type":"boolean","x-stream-index":"007"},"silent":{"type":"boolean","x-stream-index":"008"},"text":{"type":"boolean","x-stream-index":"002"}},"required":["custom","text","mml","html","attachments","mentioned_user_ids","quoted_message_id","silent","pin"],"type":"object"},"MessageDeletedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"007.002"},"deleted_for_me":{"type":"boolean","x-stream-index":"003"},"hard_delete":{"type":"boolean","x-stream-index":"002.001"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"006.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"message.deleted","type":"string","x-stream-index":"007.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005.001"}},"required":["hard_delete","cid","channel_id","channel_type","type","created_at"],"title":"MessageDeletedEvent","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":{"approved_at":{"format":"date-time","type":"number","x-stream-index":"013"},"created_at":{"format":"date-time","type":"number","x-stream-index":"009"},"created_by_automod":{"type":"boolean","x-stream-index":"001"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"008"},"details":{"$ref":"#/components/schemas/FlagDetails","x-stream-index":"006"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"005"},"moderation_feedback":{"$ref":"#/components/schemas/FlagFeedback","x-stream-index":"003"},"moderation_result":{"$ref":"#/components/schemas/MessageModerationResult","x-stream-index":"002"},"reason":{"type":"string","x-stream-index":"007"},"rejected_at":{"format":"date-time","type":"number","x-stream-index":"014"},"reviewed_at":{"format":"date-time","type":"number","x-stream-index":"011"},"reviewed_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"012"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"004"}},"required":["created_by_automod","created_at","updated_at"],"type":"object"},"MessageModerationResult":{"description":"Result of the message moderation","properties":{"action":{"description":"Action taken by automod","title":"Action","type":"string","x-stream-index":"002"},"ai_moderation_response":{"$ref":"#/components/schemas/ModerationResponse","description":"Response from AI moderation","title":"ModerationResponse","x-stream-index":"007"},"blocked_word":{"description":"Word that was blocked","title":"Blocked word","type":"string","x-stream-index":"004"},"blocklist_name":{"description":"Name of the blocklist","title":"Blocklist name","type":"string","x-stream-index":"005"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"010"},"message_id":{"description":"ID of the message","title":"Message ID","type":"string","x-stream-index":"001"},"moderated_by":{"description":"User who moderated the message","title":"Moderated by","type":"string","x-stream-index":"003"},"moderation_thresholds":{"$ref":"#/components/schemas/Thresholds","description":"Thresholds for AI moderation","title":"Thresholds","x-stream-index":"006"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"011"},"user_bad_karma":{"description":"Whether user has bad karma","title":"User bad karma","type":"boolean","x-stream-index":"009"},"user_karma":{"description":"Karma of the user","format":"float","title":"User karma","type":"number","x-stream-index":"008"}},"required":["message_id","action","user_karma","user_bad_karma","created_at","updated_at"],"title":"Message moderation result","type":"object"},"MessageNewEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"005.002"},"channel_type":{"type":"string","x-stream-index":"005.003"},"cid":{"type":"string","x-stream-index":"005.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"006.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"message.new","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"},"watcher_count":{"format":"int32","type":"integer","x-stream-index":"002.001"}},"required":["watcher_count","type","created_at","cid","channel_id","channel_type"],"title":"MessageNewEvent","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"},"MessageOptions":{"properties":{"include_thread_participants":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"MessagePaginationParams":{"type":"object"},"MessageReadEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"003"},"channel_last_message_at":{"format":"date-time","type":"number","x-stream-index":"005"},"channel_type":{"type":"string","x-stream-index":"004"},"cid":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"009"},"last_read_message_id":{"type":"string","x-stream-index":"010"},"team":{"type":"string","x-stream-index":"006"},"thread":{"$ref":"#/components/schemas/ThreadResponse","x-stream-index":"008"},"type":{"default":"message.read","type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","x-stream-index":"007"}},"required":["type","cid","channel_id","channel_type","created_at"],"type":"object"},"MessageReminder":{"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"004"},"channel_cid":{"type":"string","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"011"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"006"},"message_id":{"type":"string","x-stream-index":"005"},"remind_at":{"format":"date-time","type":"number","x-stream-index":"009"},"task_id":{"type":"string","x-stream-index":"010"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"012"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"user_id":{"type":"string","x-stream-index":"007"}},"required":["channel_cid","message_id","user_id","task_id","created_at","updated_at"],"type":"object"},"MessageRequest":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"maximum":30,"type":"array","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"mentioned_users":{"items":{"type":"string"},"maximum":100,"type":"array","x-stream-index":"008"},"mml":{"type":"string","x-stream-index":"003"},"parent_id":{"type":"string","x-stream-index":"005"},"pin_expires":{"format":"date-time","type":"number","x-stream-index":"015"},"pinned":{"type":"boolean","x-stream-index":"013"},"pinned_at":{"format":"date-time","nullable":true,"type":"string","x-stream-index":"014"},"poll_id":{"type":"string","x-stream-index":"039"},"quoted_message_id":{"type":"string","x-stream-index":"009"},"restricted_visibility":{"items":{"type":"string"},"maximum":10,"type":"array","x-stream-index":"016"},"shared_location":{"$ref":"#/components/schemas/SharedLocation","x-stream-index":"040"},"show_in_channel":{"type":"boolean","x-stream-index":"006"},"silent":{"type":"boolean","x-stream-index":"012"},"text":{"type":"string","x-stream-index":"002"},"type":{"enum":["''","regular","system"],"type":"string","x-stream-index":"011"}},"type":"object"},"MessageResponse":{"description":"Represents any chat message","properties":{"attachments":{"description":"Array of message attachments","items":{"$ref":"#/components/schemas/Attachment"},"title":"Message attachments","type":"array","x-stream-docs-page-id":"message_format#attachment-format","x-stream-index":"008"},"cid":{"description":"Channel unique identifier in \u003ctype\u003e:\u003cid\u003e format","title":"Channel CID","type":"string","x-stream-index":"022"},"command":{"description":"Contains provided slash command","title":"Command","type":"string","x-stream-docs-page-id":"custom_commands_webhook","x-stream-index":"004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"023"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"026"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"025"},"deleted_for_me":{"type":"boolean","x-stream-index":"044"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"018"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"041"},"html":{"description":"Contains HTML markup of the message. Can only be set when using server-side API","title":"HTML content","type":"string","x-stream-index":"005"},"i18n":{"additionalProperties":{"type":"string"},"description":"Object with translations. Key `language` contains the original language key. Other keys contain translations","title":"Internationalization info","type":"object","x-stream-docs-page-id":"translation","x-stream-index":"030"},"id":{"description":"Message ID is unique string identifier of the message","title":"ID","type":"string","x-stream-index":"001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"Contains image moderation information","title":"Image moderation labels","type":"object","x-stream-index":"028"},"latest_reactions":{"description":"List of 10 latest reactions to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Latest reactions","type":"array","x-stream-index":"009"},"mentioned_users":{"description":"List of mentioned users","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Mentioned Users","type":"array","x-stream-index":"029"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"036"},"mml":{"description":"Should be empty if `text` is provided. Can only be set when using server-side API","title":"Messaging Markup Language","type":"string","x-stream-docs-page-id":"mml_overview","x-stream-index":"003"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"039"},"own_reactions":{"description":"List of 10 latest reactions of authenticated user to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Own reactions","type":"array","x-stream-index":"010"},"parent_id":{"description":"ID of parent message (thread)","title":"Parent message ID","type":"string","x-stream-docs-page-id":"threads","x-stream-index":"015"},"pin_expires":{"description":"Date when pinned message expires","format":"date-time","title":"Pin expiration date","type":"number","x-stream-docs-page-id":"pinned_messages","x-stream-index":"035"},"pinned":{"description":"Whether message is pinned or not","title":"Pinned","type":"boolean","x-stream-docs-page-id":"pinned_messages","x-stream-index":"032"},"pinned_at":{"description":"Date when message got pinned","format":"date-time","title":"Pinned at","type":"number","x-stream-docs-page-id":"pinned_messages","x-stream-index":"033"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","description":"Contains user who pinned the message","title":"Pinned by","x-stream-docs-page-id":"pinned_messages","x-stream-index":"034"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"038"},"poll_id":{"description":"Identifier of the poll to include in the message","title":"Poll ID","type":"string","x-stream-index":"037"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","description":"Contains quoted message","title":"Quoted message","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"020"},"quoted_message_id":{"title":"ID of quoted message","type":"string","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"019"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing number of reactions of each type. Key: reaction type (string), value: number of reactions (int)","title":"Reaction counts","type":"object","x-stream-index":"011"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"014"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing scores of reactions of each type. Key: reaction type (string), value: total score of reactions (int)","title":"Reaction scores","type":"object","x-stream-index":"012"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"042"},"reply_count":{"description":"Number of replies to this message","format":"int32","title":"Reply count","type":"integer","x-stream-index":"017"},"restricted_visibility":{"description":"A list of user ids that have restricted visibility to the message, if the list is not empty, the message is only visible to the users in the list","items":{"type":"string"},"title":"Restricted visibility","type":"array","x-stream-index":"040"},"shadowed":{"description":"Whether the message was shadowed or not","title":"Shadowed","type":"boolean","x-stream-docs-page-id":"moderation#shadow-ban","x-stream-index":"027"},"shared_location":{"$ref":"#/components/schemas/SharedLocationResponseData","description":"Contains shared location data","title":"Shared Location","x-stream-index":"043"},"show_in_channel":{"description":"Whether thread reply should be shown in the channel as well","title":"Show in channel","type":"boolean","x-stream-docs-page-id":"threads","x-stream-index":"016"},"silent":{"description":"Whether message is silent or not","title":"Silent","type":"boolean","x-stream-index":"031"},"text":{"description":"Text of the message. Should be empty if `mml` is provided","title":"Text","type":"string","x-stream-index":"002"},"thread_participants":{"description":"List of users who participate in thread","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Thread participants","type":"array","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"021"},"type":{"description":"Contains type of the message","enum":["regular","ephemeral","error","reply","system","deleted"],"title":"Message Type","type":"string","x-stream-docs-page-id":"message_format#message-types","x-stream-index":"006"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"024"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Sender of the message. Required when using server-side API","title":"User object","x-stream-index":"007"}},"required":["id","text","html","type","user","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned","restricted_visibility"],"title":"Message","type":"object","x-stream-docs-page-id":"send_message"},"MessageUndeletedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"005.002"},"channel_type":{"type":"string","x-stream-index":"005.003"},"cid":{"type":"string","x-stream-index":"005.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"002.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"message.undeleted","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MessageUndeletedEvent","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"},"MessageUpdate":{"properties":{"change_set":{"$ref":"#/components/schemas/MessageChangeSet","x-stream-index":"002"},"old_text":{"type":"string","x-stream-index":"001"}},"type":"object"},"MessageUpdatedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"005.002"},"channel_type":{"type":"string","x-stream-index":"005.003"},"cid":{"type":"string","x-stream-index":"005.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"002.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"message.updated","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MessageUpdatedEvent","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"},"MessageWithChannelResponse":{"description":"Represents any chat message","properties":{"attachments":{"description":"Array of message attachments","items":{"$ref":"#/components/schemas/Attachment"},"title":"Message attachments","type":"array","x-stream-docs-page-id":"message_format#attachment-format","x-stream-index":"001.008"},"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel object","title":"Channel","x-stream-index":"002"},"cid":{"description":"Channel unique identifier in \u003ctype\u003e:\u003cid\u003e format","title":"Channel CID","type":"string","x-stream-index":"001.022"},"command":{"description":"Contains provided slash command","title":"Command","type":"string","x-stream-docs-page-id":"custom_commands_webhook","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.023"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.026"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"001.025"},"deleted_for_me":{"type":"boolean","x-stream-index":"001.044"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"001.018"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001.041"},"html":{"description":"Contains HTML markup of the message. Can only be set when using server-side API","title":"HTML content","type":"string","x-stream-index":"001.005"},"i18n":{"additionalProperties":{"type":"string"},"description":"Object with translations. Key `language` contains the original language key. Other keys contain translations","title":"Internationalization info","type":"object","x-stream-docs-page-id":"translation","x-stream-index":"001.030"},"id":{"description":"Message ID is unique string identifier of the message","title":"ID","type":"string","x-stream-index":"001.001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"Contains image moderation information","title":"Image moderation labels","type":"object","x-stream-index":"001.028"},"latest_reactions":{"description":"List of 10 latest reactions to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Latest reactions","type":"array","x-stream-index":"001.009"},"mentioned_users":{"description":"List of mentioned users","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Mentioned Users","type":"array","x-stream-index":"001.029"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"001.036"},"mml":{"description":"Should be empty if `text` is provided. Can only be set when using server-side API","title":"Messaging Markup Language","type":"string","x-stream-docs-page-id":"mml_overview","x-stream-index":"001.003"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"001.039"},"own_reactions":{"description":"List of 10 latest reactions of authenticated user to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Own reactions","type":"array","x-stream-index":"001.010"},"parent_id":{"description":"ID of parent message (thread)","title":"Parent message ID","type":"string","x-stream-docs-page-id":"threads","x-stream-index":"001.015"},"pin_expires":{"description":"Date when pinned message expires","format":"date-time","title":"Pin expiration date","type":"number","x-stream-docs-page-id":"pinned_messages","x-stream-index":"001.035"},"pinned":{"description":"Whether message is pinned or not","title":"Pinned","type":"boolean","x-stream-docs-page-id":"pinned_messages","x-stream-index":"001.032"},"pinned_at":{"description":"Date when message got pinned","format":"date-time","title":"Pinned at","type":"number","x-stream-docs-page-id":"pinned_messages","x-stream-index":"001.033"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","description":"Contains user who pinned the message","title":"Pinned by","x-stream-docs-page-id":"pinned_messages","x-stream-index":"001.034"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001.038"},"poll_id":{"description":"Identifier of the poll to include in the message","title":"Poll ID","type":"string","x-stream-index":"001.037"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","description":"Contains quoted message","title":"Quoted message","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"001.020"},"quoted_message_id":{"title":"ID of quoted message","type":"string","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"001.019"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing number of reactions of each type. Key: reaction type (string), value: number of reactions (int)","title":"Reaction counts","type":"object","x-stream-index":"001.011"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"001.014"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing scores of reactions of each type. Key: reaction type (string), value: total score of reactions (int)","title":"Reaction scores","type":"object","x-stream-index":"001.012"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"001.042"},"reply_count":{"description":"Number of replies to this message","format":"int32","title":"Reply count","type":"integer","x-stream-index":"001.017"},"restricted_visibility":{"description":"A list of user ids that have restricted visibility to the message, if the list is not empty, the message is only visible to the users in the list","items":{"type":"string"},"title":"Restricted visibility","type":"array","x-stream-index":"001.040"},"shadowed":{"description":"Whether the message was shadowed or not","title":"Shadowed","type":"boolean","x-stream-docs-page-id":"moderation#shadow-ban","x-stream-index":"001.027"},"shared_location":{"$ref":"#/components/schemas/SharedLocationResponseData","description":"Contains shared location data","title":"Shared Location","x-stream-index":"001.043"},"show_in_channel":{"description":"Whether thread reply should be shown in the channel as well","title":"Show in channel","type":"boolean","x-stream-docs-page-id":"threads","x-stream-index":"001.016"},"silent":{"description":"Whether message is silent or not","title":"Silent","type":"boolean","x-stream-index":"001.031"},"text":{"description":"Text of the message. Should be empty if `mml` is provided","title":"Text","type":"string","x-stream-index":"001.002"},"thread_participants":{"description":"List of users who participate in thread","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Thread participants","type":"array","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"001.021"},"type":{"description":"Contains type of the message","enum":["regular","ephemeral","error","reply","system","deleted"],"title":"Message Type","type":"string","x-stream-docs-page-id":"message_format#message-types","x-stream-index":"001.006"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.024"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Sender of the message. Required when using server-side API","title":"User object","x-stream-index":"001.007"}},"required":["id","text","html","type","user","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned","restricted_visibility","channel"],"title":"Message","type":"object","x-stream-docs-page-id":"send_message"},"ModerationActionConfig":{"nullable":true,"properties":{"action":{"type":"string","x-stream-index":"006"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"009"},"description":{"type":"string","x-stream-index":"008"},"entity_type":{"type":"string","x-stream-index":"004"},"icon":{"type":"string","x-stream-index":"007"},"order":{"format":"int32","type":"integer","x-stream-index":"005"}},"required":["entity_type","order","action","icon","description","custom"],"type":"object"},"ModerationCustomActionEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"001"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"002"},"type":{"default":"moderation.custom_action","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationCustomActionEvent","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"},"ModerationFlagResponse":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"015"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"entity_creator_id":{"type":"string","x-stream-index":"007"},"entity_id":{"type":"string","x-stream-index":"006"},"entity_type":{"type":"string","x-stream-index":"005"},"labels":{"items":{"type":"string"},"type":"array","x-stream-index":"011"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"008"},"reason":{"type":"string","x-stream-index":"009"},"result":{"items":{"additionalProperties":{},"type":"object"},"type":"array","x-stream-index":"012"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","x-stream-index":"014"},"review_queue_item_id":{"type":"string","x-stream-index":"013"},"type":{"type":"string","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"016"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"004"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["type","user_id","entity_type","entity_id","result","created_at","updated_at"],"type":"object"},"ModerationFlaggedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"item":{"type":"string","x-stream-index":"001"},"object_id":{"type":"string","x-stream-index":"002"},"type":{"default":"moderation.flagged","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationFlaggedEvent","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"},"ModerationMarkReviewedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"001"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"002"},"type":{"default":"moderation.mark_reviewed","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationMarkReviewedEvent","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"},"ModerationPayload":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"images":{"items":{"type":"string"},"maximum":30,"type":"array","x-stream-index":"002"},"texts":{"items":{"type":"string"},"type":"array","x-stream-index":"001"},"videos":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"type":"object"},"ModerationResponse":{"properties":{"action":{"type":"string","x-stream-index":"004"},"explicit":{"format":"float","type":"number","x-stream-index":"002"},"spam":{"format":"float","type":"number","x-stream-index":"003"},"toxic":{"format":"float","type":"number","x-stream-index":"001"}},"required":["toxic","explicit","spam","action","automod_response"],"type":"object"},"ModerationV2Response":{"properties":{"action":{"type":"string","x-stream-index":"001"},"blocklist_matched":{"type":"string","x-stream-index":"005"},"image_harms":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"original_text":{"type":"string","x-stream-index":"002"},"platform_circumvented":{"type":"boolean","x-stream-index":"007"},"semantic_filter_matched":{"type":"string","x-stream-index":"006"},"text_harms":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"required":["action","original_text"],"type":"object"},"MuteChannelRequest":{"nullable":true,"properties":{"channel_cids":{"description":"Channel CIDs to mute (if multiple channels)","items":{"type":"string"},"maximum":25,"title":"Channel CIDs","type":"array","x-stream-index":"002"},"expiration":{"description":"Duration of mute in milliseconds","title":"Expiration","type":"integer","x-stream-index":"003"}},"type":"object"},"MuteChannelResponse":{"nullable":true,"properties":{"channel_mute":{"$ref":"#/components/schemas/ChannelMute","description":"Object with channel mute (if one channel was muted)","title":"Channel mute","x-stream-index":"001"},"channel_mutes":{"description":"Object with mutes (if multiple channels were muted)","items":{"$ref":"#/components/schemas/ChannelMute"},"title":"Channel mutes","type":"array","x-stream-index":"002"},"duration":{"type":"string","x-stream-index":"004.001"},"own_user":{"$ref":"#/components/schemas/OwnUser","description":"Authorized user object with fresh mutes information","title":"Own user","x-stream-index":"003"}},"required":["duration"],"type":"object"},"MuteRequest":{"nullable":true,"properties":{"target_ids":{"description":"User IDs to mute (if multiple users)","items":{"type":"string"},"title":"Target IDs","type":"array","x-stream-index":"001"},"timeout":{"description":"Duration of mute in minutes","minimum":0,"title":"Timeout","type":"integer","x-stream-index":"002"}},"required":["target_ids"],"title":"MuteRequest","type":"object"},"MuteResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"004.001"},"mutes":{"description":"Object with mutes (if multiple users were muted)","items":{"$ref":"#/components/schemas/UserMute"},"title":"Mutes","type":"array","x-stream-index":"001"},"non_existing_users":{"description":"A list of users that can't be found. Common cause for this is deleted users","items":{"type":"string"},"title":"Non Existing Users","type":"array","x-stream-index":"003"},"own_user":{"$ref":"#/components/schemas/OwnUser","description":"Authorized user object with fresh mutes information","title":"Own User","x-stream-index":"002"}},"required":["duration"],"title":"MuteResponse","type":"object"},"NoiseCancellationSettings":{"properties":{"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode"],"type":"object"},"NotificationAddedToChannelEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003.004"},"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"003.005"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"001.001"},"type":{"default":"notification.added_to_channel","type":"string","x-stream-index":"002.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"NotificationAddedToChannelEvent","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"},"NotificationChannelDeletedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003.004"},"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"003.005"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"team":{"type":"string","x-stream-index":"001.001"},"type":{"default":"notification.channel_deleted","type":"string","x-stream-index":"002.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"NotificationChannelDeletedEvent","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"},"NotificationChannelMutesUpdatedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"me":{"$ref":"#/components/schemas/OwnUser","x-stream-index":"001"},"type":{"default":"notification.channel_mutes_updated","type":"string","x-stream-index":"002.001"}},"required":["me","type","created_at"],"title":"NotificationChannelMutesUpdatedEvent","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"},"NotificationChannelTruncatedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002.004"},"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"002.005"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"notification.channel_truncated","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"NotificationChannelTruncatedEvent","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"},"NotificationInviteAcceptedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002.004"},"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"002.005"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"004.001"},"type":{"default":"notification.invite_accepted","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"NotificationInviteAcceptedEvent","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"},"NotificationInviteRejectedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002.004"},"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"002.005"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"004.001"},"type":{"default":"notification.invite_rejected","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"NotificationInviteRejectedEvent","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"},"NotificationInvitedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002.004"},"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"002.005"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"004.001"},"type":{"default":"notification.invited","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"NotificationInvitedEvent","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"},"NotificationMarkReadEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003.004"},"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"003.005"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"team":{"type":"string","x-stream-index":"002.001"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"006"},"type":{"default":"notification.mark_read","type":"string","x-stream-index":"001.001"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"007"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"005"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"008"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count","unread_count","total_unread_count","unread_channels","unread_threads"],"title":"NotificationMarkReadEvent","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"},"NotificationMarkUnreadEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003.004"},"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"003.005"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"first_unread_message_id":{"type":"string","x-stream-index":"005"},"last_read_at":{"format":"date-time","type":"number","x-stream-index":"006"},"last_read_message_id":{"type":"string","x-stream-index":"012"},"team":{"type":"string","x-stream-index":"002.001"},"thread_id":{"type":"string","x-stream-index":"013"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"009"},"type":{"default":"notification.mark_unread","type":"string","x-stream-index":"001.001"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"010"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"008"},"unread_messages":{"format":"int32","type":"integer","x-stream-index":"007"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"011"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count","first_unread_message_id","last_read_at","unread_messages","unread_count","total_unread_count","unread_channels","unread_threads"],"title":"NotificationMarkUnreadEvent","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"},"NotificationMutesUpdatedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"me":{"$ref":"#/components/schemas/OwnUser","x-stream-index":"001"},"type":{"default":"notification.mutes_updated","type":"string","x-stream-index":"002.001"}},"required":["me","type","created_at"],"title":"NotificationMutesUpdatedEvent","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"},"NotificationNewMessageEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"004.004"},"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"004.005"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"002.001"},"type":{"default":"notification.message_new","type":"string","x-stream-index":"003.001"}},"required":["message","type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"NotificationNewMessageEvent","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"},"NotificationRemovedFromChannelEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002.004"},"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"002.005"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"004.001"},"type":{"default":"notification.removed_from_channel","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"NotificationRemovedFromChannelEvent","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"},"NotificationSettings":{"properties":{"call_live_started":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"002"},"call_missed":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"006"},"call_notification":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"004"},"call_ring":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"session_started":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"003"}},"required":["enabled","call_live_started","session_started","call_notification","call_ring","call_missed"],"type":"object"},"NullTime":{"type":"object"},"OCRRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"}},"required":["label","action"],"type":"object"},"OnlyUserID":{"properties":{"id":{"type":"string","x-stream-index":"001"}},"required":["id"],"type":"object"},"OwnUser":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"046"},"banned":{"type":"boolean","x-stream-index":"016"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"045"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"029"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"014"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"013"},"devices":{"items":{"$ref":"#/components/schemas/Device"},"type":"array","x-stream-index":"027"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"023"},"language":{"type":"string","x-stream-index":"035"},"last_active":{"format":"date-time","type":"number","x-stream-index":"011"},"last_engaged_at":{"format":"date-time","type":"number","x-stream-index":"012"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"037"},"mutes":{"items":{"$ref":"#/components/schemas/UserMute"},"type":"array","x-stream-index":"028"},"online":{"type":"boolean","x-stream-index":"022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"026"},"push_preferences":{"$ref":"#/components/schemas/PushPreferences","x-stream-index":"025"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"005"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"031"},"total_unread_count_by_team":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"032"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"033"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"030"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"034"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"}},"required":["id","role","custom","created_at","updated_at","banned","online","devices","mutes","channel_mutes","unread_count","total_unread_count","total_unread_count_by_team","unread_channels","unread_threads","language"],"type":"object"},"OwnUserResponse":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"banned":{"type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"015"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.011"},"devices":{"items":{"$ref":"#/components/schemas/DeviceResponse"},"title":"Devices","type":"array","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001.001"},"image":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"005"},"language":{"type":"string","x-stream-index":"001.005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"001.014"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"013"},"mutes":{"items":{"$ref":"#/components/schemas/UserMuteResponse"},"type":"array","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"001.002"},"online":{"type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"003"},"push_preferences":{"$ref":"#/components/schemas/PushPreferences","x-stream-index":"002"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.015"},"role":{"type":"string","x-stream-index":"001.006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"009"},"total_unread_count_by_team":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"010"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"011"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"008"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"012"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","devices","invisible","mutes","channel_mutes","unread_count","total_unread_count","unread_channels","unread_threads"],"type":"object"},"PaginationParams":{"properties":{"limit":{"format":"int32","minimum":0,"type":"integer","x-stream-index":"001"},"offset":{"format":"int32","type":"integer","x-stream-index":"002"}},"type":"object"},"PendingMessageEvent":{"description":"Pending message event for async moderation","nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"002.007"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"message":{"$ref":"#/components/schemas/Message","description":"The pending message","title":"Message","x-stream-index":"002.009"},"metadata":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"002.010"},"method":{"description":"The method used for the pending message","title":"Method","type":"string","x-stream-index":"003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"type":{"default":"message.pending","description":"The type of event: \"message.pending\" in this case","title":"Event Type","type":"string","x-stream-index":"001.002"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.002"}},"required":["type","custom","method","created_at"],"title":"PendingMessageEvent","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"},"PendingMessageResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"003"},"metadata":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"}},"type":"object"},"Poll":{"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"023"},"allow_answers":{"type":"boolean","x-stream-index":"010"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"009"},"answers_count":{"format":"int32","type":"integer","x-stream-index":"015"},"created_at":{"format":"date-time","type":"number","x-stream-index":"021"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"020"},"created_by_id":{"type":"string","x-stream-index":"019"},"description":{"type":"string","x-stream-index":"005"},"enforce_unique_vote":{"type":"boolean","x-stream-index":"007"},"id":{"type":"string","x-stream-index":"003"},"is_closed":{"type":"boolean","x-stream-index":"011"},"latest_answers":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array","x-stream-index":"017"},"latest_votes_by_option":{"additionalProperties":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array"},"type":"object","x-stream-index":"016"},"max_votes_allowed":{"format":"int32","type":"integer","x-stream-index":"008"},"name":{"type":"string","x-stream-index":"004"},"options":{"items":{"$ref":"#/components/schemas/PollOption"},"type":"array","x-stream-index":"013"},"own_votes":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array","x-stream-index":"018"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"022"},"vote_count":{"format":"int32","type":"integer","x-stream-index":"012"},"vote_counts_by_option":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"014"},"voting_visibility":{"type":"string","x-stream-index":"006"}},"required":["id","name","description","enforce_unique_vote","allow_user_suggested_options","allow_answers","vote_count","options","vote_counts_by_option","answers_count","latest_votes_by_option","latest_answers","own_votes","created_by_id","created_at","updated_at","Custom"],"type":"object"},"PollClosedEvent":{"description":"Emitted when a poll is closed.","nullable":true,"properties":{"activity_id":{"type":"string","x-stream-index":"001.003"},"cid":{"description":"The CID of the channel containing the poll","title":"Channel CID","type":"string","x-stream-index":"001.001.002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.001.007"},"message_id":{"description":"The ID of the message containing the poll","title":"Message ID","type":"string","x-stream-index":"001.002"},"poll":{"$ref":"#/components/schemas/PollResponseData","description":"The poll object which was closed","title":"Poll","x-stream-index":"001.004"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.001.004"},"type":{"default":"poll.closed","description":"The type of event: \"poll.closed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.001.002"}},"required":["type","created_at","custom","poll"],"title":"PollClosedEvent","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"},"PollDeletedEvent":{"description":"Emitted when a poll is deleted.","nullable":true,"properties":{"activity_id":{"type":"string","x-stream-index":"001.003"},"cid":{"description":"The CID of the channel containing the poll","title":"Channel CID","type":"string","x-stream-index":"001.001.002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.001.007"},"message_id":{"description":"The ID of the message containing the poll","title":"Message ID","type":"string","x-stream-index":"001.002"},"poll":{"$ref":"#/components/schemas/PollResponseData","description":"The poll object which was deleted","title":"Poll","x-stream-index":"001.004"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.001.004"},"type":{"default":"poll.deleted","description":"The type of event: \"poll.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.001.002"}},"required":["type","created_at","custom","poll"],"title":"PollDeletedEvent","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"},"PollOption":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id","text","custom"],"type":"object"},"PollOptionInput":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"text":{"type":"string","x-stream-index":"002"}},"type":"object"},"PollOptionRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id"],"type":"object"},"PollOptionResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"poll_option":{"$ref":"#/components/schemas/PollOptionResponseData","description":"Poll option","title":"PollOptionResponseData","x-stream-index":"001"}},"required":["poll_option","duration"],"type":"object"},"PollOptionResponseData":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id","text","custom"],"type":"object"},"PollResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"poll":{"$ref":"#/components/schemas/PollResponseData","description":"Poll","title":"PollResponseData","x-stream-index":"001"}},"required":["poll","duration"],"type":"object"},"PollResponseData":{"properties":{"allow_answers":{"type":"boolean","x-stream-index":"008"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"007"},"answers_count":{"format":"int32","type":"integer","x-stream-index":"012"},"created_at":{"format":"date-time","type":"number","x-stream-index":"019"},"created_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"018"},"created_by_id":{"type":"string","x-stream-index":"017"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"021"},"description":{"type":"string","x-stream-index":"003"},"enforce_unique_vote":{"type":"boolean","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"is_closed":{"type":"boolean","x-stream-index":"009"},"latest_answers":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array","x-stream-index":"015"},"latest_votes_by_option":{"additionalProperties":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array"},"type":"object","x-stream-index":"014"},"max_votes_allowed":{"format":"int32","type":"integer","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"002"},"options":{"items":{"$ref":"#/components/schemas/PollOptionResponseData"},"type":"array","x-stream-index":"011"},"own_votes":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array","x-stream-index":"016"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"020"},"vote_count":{"format":"int32","type":"integer","x-stream-index":"010"},"vote_counts_by_option":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"013"},"voting_visibility":{"type":"string","x-stream-index":"004"}},"required":["id","name","description","voting_visibility","enforce_unique_vote","allow_user_suggested_options","allow_answers","vote_count","options","answers_count","vote_counts_by_option","latest_votes_by_option","latest_answers","own_votes","created_by_id","created_at","updated_at","custom"],"type":"object"},"PollUpdatedEvent":{"description":"Emitted when a poll is updated.","nullable":true,"properties":{"activity_id":{"type":"string","x-stream-index":"001.003"},"cid":{"description":"The CID of the channel containing the poll","title":"Channel CID","type":"string","x-stream-index":"001.001.002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.001.007"},"message_id":{"description":"The ID of the message containing the poll","title":"Message ID","type":"string","x-stream-index":"001.002"},"poll":{"$ref":"#/components/schemas/PollResponseData","description":"The poll object which was updated","title":"Poll","x-stream-index":"001.004"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.001.004"},"type":{"default":"poll.updated","description":"The type of event: \"poll.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.001.002"}},"required":["type","created_at","custom","poll"],"title":"PollUpdatedEvent","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"},"PollVote":{"nullable":true,"properties":{"answer_text":{"type":"string","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"004"},"is_answer":{"type":"boolean","x-stream-index":"006"},"option_id":{"type":"string","x-stream-index":"005"},"poll_id":{"type":"string","x-stream-index":"003"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"011"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"009"},"user_id":{"type":"string","x-stream-index":"008"}},"required":["poll_id","id","option_id","created_at","updated_at"],"type":"object"},"PollVoteCastedEvent":{"description":"Emitted when a vote is cast on a poll.","nullable":true,"properties":{"activity_id":{"type":"string","x-stream-index":"001.001.003"},"cid":{"description":"The CID of the channel containing the poll","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":"number","x-stream-index":"001.001.001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.001.001.007"},"message_id":{"description":"The ID of the message containing the poll","title":"Message ID","type":"string","x-stream-index":"001.001.002"},"poll":{"$ref":"#/components/schemas/PollResponseData","description":"The poll object","title":"Poll","x-stream-index":"001.001.004"},"poll_vote":{"$ref":"#/components/schemas/PollVoteResponseData","description":"The vote that was cast","title":"Poll Vote","x-stream-index":"001.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.001.001.004"},"type":{"default":"poll.vote_casted","description":"The type of event: \"poll.vote_casted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.001.001.002"}},"required":["type","created_at","custom","poll","poll_vote"],"title":"PollVoteCastedEvent","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"},"PollVoteChangedEvent":{"description":"Emitted when a vote on a poll is changed.","nullable":true,"properties":{"activity_id":{"type":"string","x-stream-index":"001.001.003"},"cid":{"description":"The CID of the channel containing the poll","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":"number","x-stream-index":"001.001.001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.001.001.007"},"message_id":{"description":"The ID of the message containing the poll","title":"Message ID","type":"string","x-stream-index":"001.001.002"},"poll":{"$ref":"#/components/schemas/PollResponseData","description":"The poll object","title":"Poll","x-stream-index":"001.001.004"},"poll_vote":{"$ref":"#/components/schemas/PollVoteResponseData","description":"The updated vote","title":"Poll Vote","x-stream-index":"001.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.001.001.004"},"type":{"default":"poll.vote_changed","description":"The type of event: \"poll.vote_changed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.001.001.002"}},"required":["type","created_at","custom","poll","poll_vote"],"title":"PollVoteChangedEvent","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"},"PollVoteRemovedEvent":{"description":"Emitted when a vote is removed from a poll.","nullable":true,"properties":{"activity_id":{"type":"string","x-stream-index":"001.001.003"},"cid":{"description":"The CID of the channel containing the poll","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":"number","x-stream-index":"001.001.001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.001.001.007"},"message_id":{"description":"The ID of the message containing the poll","title":"Message ID","type":"string","x-stream-index":"001.001.002"},"poll":{"$ref":"#/components/schemas/PollResponseData","description":"The poll object","title":"Poll","x-stream-index":"001.001.004"},"poll_vote":{"$ref":"#/components/schemas/PollVoteResponseData","description":"The vote that was removed","title":"Poll Vote","x-stream-index":"001.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.001.001.004"},"type":{"default":"poll.vote_removed","description":"The type of event: \"poll.vote_removed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.001.001.002"}},"required":["type","created_at","custom","poll","poll_vote"],"title":"PollVoteRemovedEvent","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"},"PollVoteResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"vote":{"$ref":"#/components/schemas/PollVoteResponseData","description":"Poll vote","title":"PollVoteResponseData","x-stream-index":"001"}},"required":["duration"],"type":"object"},"PollVoteResponseData":{"nullable":true,"properties":{"answer_text":{"type":"string","x-stream-index":"005"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"id":{"type":"string","x-stream-index":"002"},"is_answer":{"type":"boolean","x-stream-index":"004"},"option_id":{"type":"string","x-stream-index":"003"},"poll_id":{"type":"string","x-stream-index":"001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"007"},"user_id":{"type":"string","x-stream-index":"006"}},"required":["poll_id","id","option_id","created_at","updated_at"],"type":"object"},"PollVotesResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"votes":{"description":"Poll votes","items":{"$ref":"#/components/schemas/PollVoteResponseData"},"title":"PollVoteResponseList","type":"array","x-stream-index":"001"}},"required":["votes","duration"],"type":"object"},"PrivacySettings":{"properties":{"read_receipts":{"$ref":"#/components/schemas/ReadReceipts","x-stream-index":"002"},"typing_indicators":{"$ref":"#/components/schemas/TypingIndicators","x-stream-index":"001"}},"type":"object"},"PrivacySettingsResponse":{"properties":{"read_receipts":{"$ref":"#/components/schemas/ReadReceiptsResponse","x-stream-index":"002"},"typing_indicators":{"$ref":"#/components/schemas/TypingIndicatorsResponse","x-stream-index":"001"}},"type":"object"},"PushPreferenceInput":{"nullable":true,"properties":{"call_level":{"description":"Set the level of call push notifications for the user. One of all, none, default","enum":["all","none","default"],"type":"string","x-stream-index":"004"},"channel_cid":{"description":"Set the push preferences for a specific channel. If empty it sets the default for the user","type":"string","x-stream-index":"002"},"chat_level":{"description":"Set the level of chat push notifications for the user. One of all, mentions, none, default","enum":["all","mentions","none","default"],"type":"string","x-stream-index":"003"},"disabled_until":{"description":"Disable push notifications till a certain time","format":"date-time","type":"number","x-stream-index":"007"},"feeds_events":{"$ref":"#/components/schemas/FeedsEventPreferencesInput","description":"Set granular feeds event preferences for reactions, comments, new followers, and mentions","x-stream-index":"006"},"feeds_level":{"description":"Set the level of feeds push notifications for the user. One of all, none, default","enum":["all","none","default"],"type":"string","x-stream-index":"005"},"remove_disable":{"description":"Remove the disabled until time. (IE stop snoozing notifications)","type":"boolean","x-stream-index":"008"},"user_id":{"description":"The user id for which to set the push preferences. Required when using server side auths, defaults to current user with client side auth.","type":"string","x-stream-index":"001"}},"type":"object"},"PushPreferences":{"properties":{"call_level":{"type":"string","x-stream-index":"002"},"chat_level":{"type":"string","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"number","x-stream-index":"005"},"feeds_events":{"$ref":"#/components/schemas/FeedsEventPreferences","x-stream-index":"004"},"feeds_level":{"type":"string","x-stream-index":"003"}},"type":"object"},"Quality":{"properties":{"bitdepth":{"format":"int32","type":"integer","x-stream-index":"007"},"framerate":{"format":"int32","type":"integer","x-stream-index":"008"},"height":{"format":"int32","type":"integer","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"004"},"video_bitrate":{"format":"int32","type":"integer","x-stream-index":"009"},"width":{"format":"int32","type":"integer","x-stream-index":"005"}},"type":"object"},"QueryBannedUsersPayload":{"properties":{"exclude_expired_bans":{"description":"Whether to exclude expired bans or not","title":"Exclude expired bans","type":"boolean","x-stream-index":"004"},"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"description":"Number of records to return","format":"int32","maximum":300,"minimum":0,"title":"Limit","type":"integer","x-stream-index":"003.003"},"offset":{"description":"Number of records to offset","format":"int32","maximum":10000,"title":"Offset","type":"integer","x-stream-index":"003.004"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":1,"title":"Sort","type":"array","x-stream-index":"002"}},"required":["filter_conditions"],"type":"object"},"QueryBannedUsersResponse":{"nullable":true,"properties":{"bans":{"description":"List of found bans","items":{"$ref":"#/components/schemas/BanResponse"},"title":"BanResponse","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["bans","duration"],"type":"object"},"QueryChannelsRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"description":"Number of channels to limit","format":"int32","title":"Limit","type":"integer","x-stream-index":"008"},"member_limit":{"description":"Number of members to limit","format":"int32","maximum":100,"minimum":0,"title":"Member limit","type":"integer","x-stream-index":"007"},"message_limit":{"description":"Number of messages to limit","format":"int32","minimum":0,"title":"Message limit","type":"integer","x-stream-index":"006"},"offset":{"description":"Channel pagination offset","format":"int32","title":"Offset","type":"integer","x-stream-index":"009"},"presence":{"title":"Presence","type":"boolean","x-stream-index":"005"},"sort":{"description":"List of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"002"},"state":{"description":"Whether to update channel state or not","title":"State","type":"boolean","x-stream-index":"004"},"watch":{"description":"Whether to start watching found channels or not","title":"Watch","type":"boolean","x-stream-index":"003"}},"title":"Query Channels Request","type":"object","x-stream-docs-page-id":"query_channels"},"QueryChannelsResponse":{"nullable":true,"properties":{"channels":{"description":"List of channels","items":{"$ref":"#/components/schemas/ChannelStateResponseFields"},"title":"Channels","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["channels","duration"],"title":"Channels list","type":"object"},"QueryDraftsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","maximum":3,"title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"002"}},"type":"object"},"QueryDraftsResponse":{"nullable":true,"properties":{"drafts":{"description":"Drafts","items":{"$ref":"#/components/schemas/DraftResponse"},"title":"DraftsResponseList","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["drafts","duration"],"type":"object"},"QueryMembersPayload":{"description":"Client request","properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"002"},"limit":{"format":"int32","maximum":300,"minimum":0,"type":"integer","x-stream-index":"006.003"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"type":"array","x-stream-index":"003"},"offset":{"format":"int32","maximum":10000,"type":"integer","x-stream-index":"006.004"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":1,"type":"array","x-stream-index":"005"},"type":{"maxLength":64,"type":"string","x-stream-index":"001"}},"required":["type","filter_conditions"],"title":"ClientRequest","type":"object"},"QueryMessageFlagsPayload":{"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":300,"minimum":0,"type":"integer","x-stream-index":"003.003"},"offset":{"format":"int32","maximum":10000,"type":"integer","x-stream-index":"003.004"},"show_deleted_messages":{"description":"Whether to include deleted messages in the results","title":"ShowDeletedMessages","type":"boolean","x-stream-index":"002"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"type":"array","x-stream-index":"003.005"}},"type":"object"},"QueryMessageFlagsResponse":{"description":"Query message flags response","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"flags":{"description":"The flags that match the query","items":{"$ref":"#/components/schemas/MessageFlagResponse"},"title":"MessageFlagResponseList","type":"array","x-stream-index":"001"}},"required":["flags","duration"],"title":"QueryMessageFlagsResponse","type":"object"},"QueryModerationConfigsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter conditions for moderation configs","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"Sorting parameters for the results","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"002"}},"type":"object"},"QueryModerationConfigsResponse":{"nullable":true,"properties":{"configs":{"description":"List of moderation configurations","items":{"$ref":"#/components/schemas/ConfigResponse"},"title":"Configs","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["configs","duration"],"type":"object"},"QueryPollVotesRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","title":"Filter","type":"object","x-stream-index":"003"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"004"}},"type":"object"},"QueryPollsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","title":"Filter","type":"object","x-stream-index":"002"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"003"}},"type":"object"},"QueryPollsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"polls":{"description":"Polls data returned by the query","items":{"$ref":"#/components/schemas/PollResponseData"},"title":"PollsResponseData","type":"array","x-stream-index":"001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["polls","duration"],"type":"object"},"QueryReactionsRequest":{"properties":{"filter":{"additionalProperties":{},"type":"object","x-stream-index":"002"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"006.001"},"next":{"type":"string","x-stream-index":"006.002"},"prev":{"type":"string","x-stream-index":"006.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":2,"type":"array","x-stream-index":"003"}},"type":"object"},"QueryReactionsResponse":{"description":"Basic response information","properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"next":{"type":"string","x-stream-index":"003.001"},"prev":{"type":"string","x-stream-index":"003.002"},"reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"001"}},"required":["reactions","duration"],"title":"Response","type":"object"},"QueryRemindersRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"002"}},"type":"object"},"QueryRemindersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"reminders":{"description":"MessageReminders data returned by the query","items":{"$ref":"#/components/schemas/ReminderResponseData"},"title":"RemindersResponseData","type":"array","x-stream-index":"001"}},"required":["reminders","duration"],"type":"object"},"QueryReviewQueueRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter conditions for review queue items","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"007.001"},"lock_count":{"description":"Number of items to lock (1-25)","format":"int32","maximum":25,"minimum":1,"title":"Lock Count","type":"integer","x-stream-index":"005"},"lock_duration":{"description":"Duration for which items should be locked","title":"Lock Duration","type":"integer","x-stream-index":"004"},"lock_items":{"description":"Whether to lock items for review (true), unlock items (false), or just fetch (nil)","title":"Lock Items","type":"boolean","x-stream-index":"003"},"next":{"type":"string","x-stream-index":"007.002"},"prev":{"type":"string","x-stream-index":"007.003"},"sort":{"description":"Sorting parameters for the results","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"002"},"stats_only":{"description":"Whether to return only statistics","title":"Stats Only","type":"boolean","x-stream-index":"006"}},"type":"object"},"QueryReviewQueueResponse":{"nullable":true,"properties":{"action_config":{"additionalProperties":{"items":{"$ref":"#/components/schemas/ModerationActionConfig"},"type":"array"},"description":"Configuration for moderation actions","title":"Action Config","type":"object","x-stream-index":"002"},"duration":{"type":"string","x-stream-index":"005.001"},"items":{"description":"List of review queue items","items":{"$ref":"#/components/schemas/ReviewQueueItemResponse"},"title":"Items","type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"004.001"},"prev":{"type":"string","x-stream-index":"004.002"},"stats":{"additionalProperties":{},"description":"Statistics about the review queue","title":"Stats","type":"object","x-stream-index":"003"}},"required":["items","action_config","stats","duration"],"type":"object"},"QueryThreadsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter conditions to apply to threads","title":"Filter","type":"object","x-stream-index":"006"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"008.001"},"member_limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005"},"next":{"type":"string","x-stream-index":"008.002"},"participant_limit":{"description":"Limit the number of participants returned per each thread","format":"int32","maximum":100,"minimum":0,"title":"Participant limit","type":"integer","x-stream-index":"004"},"prev":{"type":"string","x-stream-index":"008.003"},"reply_limit":{"description":"Limit the number of replies returned per each thread","format":"int32","maximum":10,"minimum":0,"title":"Reply limit","type":"integer","x-stream-index":"003"},"sort":{"description":"Sort conditions to apply to threads","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"007"},"watch":{"description":"Start watching the channel this thread belongs to","title":"Watch","type":"boolean","x-stream-index":"001"}},"type":"object"},"QueryThreadsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"threads":{"description":"List of enriched thread states","items":{"$ref":"#/components/schemas/ThreadStateResponse"},"title":"Threads","type":"array","x-stream-index":"001"}},"required":["threads","duration"],"type":"object"},"QueryUsersPayload":{"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"include_deactivated_users":{"type":"boolean","x-stream-index":"004"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.003"},"offset":{"format":"int32","maximum":1000,"type":"integer","x-stream-index":"005.004"},"presence":{"type":"boolean","x-stream-index":"003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"type":"array","x-stream-index":"002"}},"required":["filter_conditions"],"type":"object"},"QueryUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"users":{"description":"Array of users as result of filters applied.","items":{"$ref":"#/components/schemas/FullUserResponse"},"title":"Users","type":"array","x-stream-index":"001"}},"required":["users","duration"],"type":"object"},"RTMPEgressConfig":{"properties":{"composite_app_settings":{"$ref":"#/components/schemas/CompositeAppSettings","x-stream-index":"005"},"quality":{"$ref":"#/components/schemas/Quality","x-stream-index":"004"},"rtmp_location":{"type":"string","x-stream-index":"006"}},"type":"object"},"RTMPIngress":{"description":"RTMP input settings","properties":{"address":{"title":"Address","type":"string","x-stream-index":"001"}},"required":["address"],"title":"RTMPIngress","type":"object"},"RTMPLocation":{"properties":{"name":{"type":"string","x-stream-index":"001"},"stream_key":{"type":"string","x-stream-index":"003"},"stream_url":{"type":"string","x-stream-index":"002"}},"required":["name","stream_url","stream_key"],"type":"object"},"RTMPSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"003"},"location":{"$ref":"#/components/schemas/RTMPLocation","x-stream-index":"004"},"quality_name":{"type":"string","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"RTMPSettingsResponse":{"description":"RTMPSettingsResponse is the payload for RTMP settings","properties":{"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"001"},"quality":{"title":"Quality","type":"string","x-stream-index":"002"}},"required":["enabled","quality","layout"],"title":"RTMPSettingsResponse","type":"object"},"Reaction":{"nullable":true,"properties":{"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"message_id":{"type":"string","x-stream-index":"003"},"score":{"format":"int32","type":"integer","x-stream-index":"007"},"type":{"maxLength":30,"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["message_id","type","score","created_at","updated_at","custom"],"type":"object"},"ReactionDeletedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"006.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"002"},"team":{"type":"string","x-stream-index":"005.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"reaction.deleted","type":"string","x-stream-index":"006.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"ReactionDeletedEvent","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"},"ReactionGroupResponse":{"description":"ReactionGroupResponse contains all information about a reaction of the same type.","nullable":true,"properties":{"count":{"description":"Count is the number of reactions of this type.","format":"int32","title":"Count","type":"integer","x-stream-index":"001"},"first_reaction_at":{"description":"FirstReactionAt is the time of the first reaction of this type. This is the same also if all reaction of this type are deleted, because if someone will react again with the same type, will be preserved the sorting.","format":"date-time","title":"FirstReactionAt","type":"number","x-stream-index":"003"},"last_reaction_at":{"description":"LastReactionAt is the time of the last reaction of this type.","format":"date-time","title":"LastReactionAt","type":"number","x-stream-index":"004"},"sum_scores":{"description":"SumScores is the sum of all scores of reactions of this type. Medium allows you to clap articles more than once and shows the sum of all claps from all users. For example, you can send `clap` x5 using `score: 5`.","format":"int32","title":"SumScores","type":"integer","x-stream-index":"002"}},"required":["count","sum_scores","first_reaction_at","last_reaction_at"],"title":"ReactionGroupResponse","type":"object"},"ReactionNewEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"006.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"002"},"team":{"type":"string","x-stream-index":"005.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"reaction.new","type":"string","x-stream-index":"006.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"ReactionNewEvent","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"},"ReactionRequest":{"description":"Represents user reaction to a message","properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"score":{"description":"Reaction score. If not specified reaction has score of 1","format":"int32","title":"Score","type":"integer","x-stream-index":"002"},"type":{"description":"The type of reaction (e.g. 'like', 'laugh', 'wow')","maxLength":30,"title":"Type","type":"string","x-stream-index":"001"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"004"}},"required":["type"],"title":"Reaction","type":"object","x-stream-docs-page-id":"send_reaction"},"ReactionResponse":{"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"006"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"008"},"message_id":{"description":"Message ID","title":"Message ID","type":"string","x-stream-index":"001"},"score":{"description":"Score of the reaction","format":"int32","title":"Score","type":"integer","x-stream-index":"005"},"type":{"description":"Type of reaction","title":"Type","type":"string","x-stream-index":"004"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"007"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User","title":"UserResponse","x-stream-index":"003"},"user_id":{"description":"User ID","title":"User ID","type":"string","x-stream-index":"002"}},"required":["message_id","user_id","user","type","score","created_at","updated_at","custom"],"type":"object"},"ReactionUpdatedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"006.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"002"},"team":{"type":"string","x-stream-index":"005.001"},"type":{"default":"reaction.updated","type":"string","x-stream-index":"006.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["message","reaction","cid","channel_id","channel_type","type","created_at"],"title":"ReactionUpdatedEvent","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"},"ReadReceipts":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"ReadReceiptsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"ReadStateResponse":{"properties":{"last_read":{"format":"date-time","type":"number","x-stream-index":"002"},"last_read_message_id":{"type":"string","x-stream-index":"004"},"unread_messages":{"format":"int32","type":"integer","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"}},"required":["user","last_read","unread_messages"],"type":"object"},"RecordSettings":{"properties":{"audio_only":{"type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"004"},"mode":{"type":"string","x-stream-index":"002"},"quality":{"type":"string","x-stream-index":"003"}},"required":["mode"],"type":"object"},"RecordSettingsResponse":{"description":"RecordSettings is the payload for recording settings","properties":{"audio_only":{"title":"Audio Only","type":"boolean","x-stream-index":"001"},"mode":{"title":"Mode","type":"string","x-stream-index":"002"},"quality":{"title":"Quality","type":"string","x-stream-index":"003"}},"required":["audio_only","mode","quality","layout"],"title":"RecordSettingsResponse","type":"object"},"RecordingEgressConfig":{"properties":{"audio_only":{"type":"boolean","x-stream-index":"006"},"composite_app_settings":{"$ref":"#/components/schemas/CompositeAppSettings","x-stream-index":"005"},"external_storage":{"$ref":"#/components/schemas/ExternalStorage","x-stream-index":"008"},"quality":{"$ref":"#/components/schemas/Quality","x-stream-index":"004"},"storage_name":{"type":"string","x-stream-index":"007"},"video_orientation_hint":{"$ref":"#/components/schemas/VideoOrientation","x-stream-index":"009"}},"type":"object"},"ReminderCreatedEvent":{"description":"Emitted when a reminder is created.","nullable":true,"properties":{"cid":{"description":"The CID of the Channel for which the reminder was created","title":"Channel CID","type":"string","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.007"},"message_id":{"description":"The ID of the message for which the reminder was created","title":"Message ID","type":"string","x-stream-index":"001.002"},"parent_id":{"description":"The ID of the parent message, if the reminder is for a thread message","title":"Parent ID","type":"string","x-stream-index":"001.005"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","description":"The reminder object which was created","title":"MessageReminder","x-stream-index":"001.006"},"type":{"default":"reminder.created","description":"The type of event: \"reminder.created\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.002"},"user_id":{"description":"The ID of the user for whom the reminder was created","title":"User ID","type":"string","x-stream-index":"001.003"}},"required":["type","created_at","custom","message_id","user_id","cid"],"title":"ReminderCreatedEvent","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"},"ReminderDeletedEvent":{"description":"Emitted when a reminder is deleted.","nullable":true,"properties":{"cid":{"description":"The CID of the Channel for which the reminder was created","title":"Channel CID","type":"string","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.007"},"message_id":{"description":"The ID of the message for which the reminder was created","title":"Message ID","type":"string","x-stream-index":"001.002"},"parent_id":{"description":"The ID of the parent message, if the reminder is for a thread message","title":"Parent ID","type":"string","x-stream-index":"001.005"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","description":"The reminder object which was created","title":"MessageReminder","x-stream-index":"001.006"},"type":{"default":"reminder.deleted","description":"The type of event: \"reminder.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.002"},"user_id":{"description":"The ID of the user for whom the reminder was created","title":"User ID","type":"string","x-stream-index":"001.003"}},"required":["type","created_at","custom","message_id","user_id","cid"],"title":"ReminderDeletedEvent","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"},"ReminderNotificationEvent":{"description":"Emitted when a reminder becomes due, triggering a notification for the user.","nullable":true,"properties":{"cid":{"description":"The CID of the Channel for which the reminder was created","title":"Channel CID","type":"string","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.007"},"message_id":{"description":"The ID of the message for which the reminder was created","title":"Message ID","type":"string","x-stream-index":"001.002"},"parent_id":{"type":"string","x-stream-index":"001.005"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","description":"The reminder object which was created","title":"MessageReminder","x-stream-index":"001.006"},"type":{"default":"notification.reminder_due","description":"The type of event: \"notification.reminder_due\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.002"},"user_id":{"description":"The ID of the user for whom the reminder was created","title":"User ID","type":"string","x-stream-index":"001.003"}},"required":["type","created_at","custom","message_id","user_id","cid"],"title":"ReminderNotificationEvent","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"},"ReminderResponseData":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003"},"channel_cid":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"005"},"message_id":{"type":"string","x-stream-index":"004"},"remind_at":{"format":"date-time","type":"number","x-stream-index":"001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007"},"user_id":{"type":"string","x-stream-index":"006"}},"required":["channel_cid","message_id","user_id","created_at","updated_at"],"type":"object"},"ReminderUpdatedEvent":{"description":"Emitted when a reminder is updated.","nullable":true,"properties":{"cid":{"description":"The CID of the Channel for which the reminder was created","title":"Channel CID","type":"string","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.007"},"message_id":{"description":"The ID of the message for which the reminder was created","title":"Message ID","type":"string","x-stream-index":"001.002"},"parent_id":{"description":"The ID of the parent message, if the reminder is for a thread message","title":"Parent ID","type":"string","x-stream-index":"001.005"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","description":"The reminder object which was created","title":"MessageReminder","x-stream-index":"001.006"},"type":{"default":"reminder.updated","description":"The type of event: \"reminder.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.002"},"user_id":{"description":"The ID of the user for whom the reminder was created","title":"User ID","type":"string","x-stream-index":"001.003"}},"required":["type","created_at","custom","message_id","user_id","cid"],"title":"ReminderUpdatedEvent","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"},"Response":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001"}},"required":["duration"],"title":"Response","type":"object"},"RestoreActionRequest":{"type":"object"},"ReviewQueueItem":{"properties":{"actions":{"items":{"$ref":"#/components/schemas/ActionLog"},"type":"array","x-stream-index":"035"},"activity":{"$ref":"#/components/schemas/EnrichedActivity","x-stream-index":"028"},"ai_text_severity":{"type":"string","x-stream-index":"021"},"archived_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"043"},"assigned_to":{"$ref":"#/components/schemas/User","x-stream-index":"032"},"bans":{"items":{"$ref":"#/components/schemas/Ban"},"type":"array","x-stream-index":"033"},"bounce_count":{"format":"int32","type":"integer","x-stream-index":"025"},"call":{"$ref":"#/components/schemas/Call","x-stream-index":"031"},"completed_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"018"},"config_key":{"type":"string","x-stream-index":"009"},"content_changed":{"type":"boolean","x-stream-index":"036"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"entity_creator":{"$ref":"#/components/schemas/EntityCreator","x-stream-index":"030"},"entity_id":{"type":"string","x-stream-index":"007"},"entity_type":{"type":"string","x-stream-index":"006"},"feeds_v2_activity":{"$ref":"#/components/schemas/EnrichedActivity","x-stream-index":"041"},"feeds_v2_reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"042"},"flag_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"045"},"flag_types":{"items":{"type":"string"},"type":"array","x-stream-index":"044"},"flags":{"items":{"$ref":"#/components/schemas/Flag"},"type":"array","x-stream-index":"034"},"flags_count":{"format":"int32","type":"integer","x-stream-index":"026"},"has_image":{"type":"boolean","x-stream-index":"012"},"has_text":{"type":"boolean","x-stream-index":"014"},"has_video":{"type":"boolean","x-stream-index":"013"},"id":{"type":"string","x-stream-index":"003"},"languages":{"items":{"type":"string"},"type":"array","x-stream-index":"019"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"027"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"010"},"moderation_payload_hash":{"type":"string","x-stream-index":"011"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"029"},"recommended_action":{"type":"string","x-stream-index":"017"},"reporter_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"046"},"reviewed_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"022"},"reviewed_by":{"type":"string","x-stream-index":"023"},"severity":{"format":"int32","type":"integer","x-stream-index":"020"},"status":{"type":"string","x-stream-index":"016"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"015"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"005"}},"required":["id","created_at","updated_at","entity_type","entity_id","config_key","moderation_payload_hash","has_image","has_video","has_text","teams","status","recommended_action","completed_at","languages","severity","ai_text_severity","reviewed_at","reviewed_by","bounce_count","flags_count","bans","flags","actions","content_changed","archived_at","flag_types","flag_labels","reporter_ids"],"type":"object"},"ReviewQueueItemResponse":{"nullable":true,"properties":{"actions":{"description":"Moderation actions taken","items":{"$ref":"#/components/schemas/ActionLogResponse"},"title":"Actions","type":"array","x-stream-index":"024"},"activity":{"$ref":"#/components/schemas/EnrichedActivity","x-stream-index":"016"},"ai_text_severity":{"description":"AI-determined text severity","title":"AI Text Severity","type":"string","x-stream-index":"014"},"assigned_to":{"$ref":"#/components/schemas/UserResponse","description":"Moderator assigned to review this item","title":"Assigned To","x-stream-index":"021"},"bans":{"description":"Associated ban records","items":{"$ref":"#/components/schemas/Ban"},"title":"Bans","type":"array","x-stream-index":"022"},"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"018"},"completed_at":{"description":"When the review was completed","format":"date-time","title":"Completed At","type":"number","x-stream-index":"009"},"config_key":{"type":"string","x-stream-index":"028"},"created_at":{"description":"When the item was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"002"},"entity_creator":{"$ref":"#/components/schemas/EntityCreatorResponse","description":"Details about who created the entity","title":"Entity Creator","x-stream-index":"019"},"entity_creator_id":{"description":"ID of who created the entity","title":"Entity Creator ID","type":"string","x-stream-index":"020"},"entity_id":{"description":"ID of the entity being reviewed","title":"Entity ID","type":"string","x-stream-index":"005"},"entity_type":{"description":"Type of entity being reviewed","title":"Entity Type","type":"string","x-stream-index":"004"},"feeds_v2_activity":{"$ref":"#/components/schemas/EnrichedActivity","description":"Associated feed activity","title":"Feeds V2 Activity","x-stream-index":"025"},"feeds_v2_reaction":{"$ref":"#/components/schemas/Reaction","description":"Associated feed reaction","title":"Feeds V2 Reaction","x-stream-index":"026"},"flags":{"description":"Associated flag records","items":{"$ref":"#/components/schemas/ModerationFlagResponse"},"title":"Flags","type":"array","x-stream-index":"023"},"flags_count":{"format":"int32","type":"integer","x-stream-index":"029"},"id":{"description":"Unique identifier of the review queue item","title":"ID","type":"string","x-stream-index":"001"},"languages":{"description":"Detected languages in the content","items":{"type":"string"},"title":"Languages","type":"array","x-stream-index":"012"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Associated message details","title":"Message","x-stream-index":"015"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content being moderated","title":"Moderation Payload","x-stream-index":"006"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"017"},"recommended_action":{"description":"Suggested moderation action","title":"Recommended Action","type":"string","x-stream-index":"008"},"reviewed_at":{"description":"When the item was reviewed","format":"date-time","title":"Reviewed At","type":"number","x-stream-index":"010"},"reviewed_by":{"description":"ID of the moderator who reviewed the item","title":"Reviewed By","type":"string","x-stream-index":"011"},"severity":{"description":"Severity level of the content","format":"int32","title":"Severity","type":"integer","x-stream-index":"013"},"status":{"description":"Current status of the review","title":"Status","type":"string","x-stream-index":"007"},"teams":{"description":"Teams associated with this item","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"027"},"updated_at":{"description":"When the item was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"003"}},"required":["id","created_at","updated_at","entity_type","entity_id","status","recommended_action","reviewed_by","languages","severity","ai_text_severity","bans","flags","actions","flags_count"],"type":"object"},"RingSettings":{"properties":{"auto_cancel_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_timeout_ms","missed_call_timeout_ms"],"type":"object"},"RingSettingsResponse":{"properties":{"auto_cancel_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_timeout_ms","missed_call_timeout_ms"],"type":"object"},"RuleBuilderAction":{"properties":{"ban_options":{"$ref":"#/components/schemas/BanOptions","x-stream-index":"002"},"flag_content_options":{"$ref":"#/components/schemas/FlagContentOptions","x-stream-index":"004"},"flag_user_options":{"$ref":"#/components/schemas/FlagUserOptions","x-stream-index":"003"},"remove_content_options":{"$ref":"#/components/schemas/BlockContentOptions","x-stream-index":"005"},"type":{"type":"string","x-stream-index":"001"}},"type":"object"},"RuleBuilderCondition":{"properties":{"confidence":{"format":"float","type":"number","x-stream-index":"002"},"content_count_rule_params":{"$ref":"#/components/schemas/ContentCountRuleParameters","x-stream-index":"007"},"image_content_params":{"$ref":"#/components/schemas/ImageContentParameters","x-stream-index":"009"},"image_rule_params":{"$ref":"#/components/schemas/ImageRuleParameters","x-stream-index":"004"},"text_content_params":{"$ref":"#/components/schemas/TextContentParameters","x-stream-index":"008"},"text_rule_params":{"$ref":"#/components/schemas/TextRuleParameters","x-stream-index":"003"},"type":{"type":"string","x-stream-index":"001"},"user_created_within_params":{"$ref":"#/components/schemas/UserCreatedWithinParameters","x-stream-index":"011"},"user_custom_property_params":{"$ref":"#/components/schemas/UserCustomPropertyParameters","x-stream-index":"012"},"user_rule_params":{"$ref":"#/components/schemas/UserRuleParameters","x-stream-index":"006"},"video_content_params":{"$ref":"#/components/schemas/VideoContentParameters","x-stream-index":"010"},"video_rule_params":{"$ref":"#/components/schemas/VideoRuleParameters","x-stream-index":"005"}},"type":"object"},"RuleBuilderConditionGroup":{"properties":{"conditions":{"items":{"$ref":"#/components/schemas/RuleBuilderCondition"},"type":"array","x-stream-index":"002"},"logic":{"type":"string","x-stream-index":"001"}},"type":"object"},"RuleBuilderConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"rules":{"items":{"$ref":"#/components/schemas/RuleBuilderRule"},"type":"array","x-stream-index":"002"}},"type":"object"},"RuleBuilderRule":{"properties":{"action":{"$ref":"#/components/schemas/RuleBuilderAction","x-stream-index":"006"},"conditions":{"items":{"$ref":"#/components/schemas/RuleBuilderCondition"},"type":"array","x-stream-index":"003"},"cooldown_period":{"type":"string","x-stream-index":"007"},"groups":{"items":{"$ref":"#/components/schemas/RuleBuilderConditionGroup"},"type":"array","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"logic":{"type":"string","x-stream-index":"004"},"rule_type":{"type":"string","x-stream-index":"002"}},"required":["rule_type","action"],"type":"object"},"SFUIDLastSeen":{"properties":{"id":{"type":"string","x-stream-index":"001.001"},"last_seen":{"format":"date-time","type":"number","x-stream-index":"002"},"process_start_time":{"format":"int64","type":"integer","x-stream-index":"001.002"}},"required":["id","process_start_time","last_seen"],"type":"object"},"STTEgressConfig":{"properties":{"closed_captions_enabled":{"type":"boolean","x-stream-index":"005"},"external_storage":{"$ref":"#/components/schemas/ExternalStorage","x-stream-index":"011"},"language":{"type":"string","x-stream-index":"008"},"storage_name":{"type":"string","x-stream-index":"010"},"translation_languages":{"items":{"type":"string"},"type":"array","x-stream-index":"009"},"translations_enabled":{"type":"boolean","x-stream-index":"006"},"upload_transcriptions":{"type":"boolean","x-stream-index":"004"},"whisper_server_base_url":{"type":"string","x-stream-index":"007"}},"type":"object"},"ScreensharingSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled"],"type":"object"},"ScreensharingSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled"],"type":"object"},"SearchPayload":{"properties":{"filter_conditions":{"additionalProperties":{},"description":"Channel filter conditions","maximum":100,"minimum":1,"title":"Channel filter","type":"object","x-stream-docs-page-id":"query_channels","x-stream-index":"002"},"limit":{"description":"Number of messages to return","format":"int32","title":"Limit","type":"integer","x-stream-index":"005"},"message_filter_conditions":{"additionalProperties":{},"description":"Message filter conditions","title":"Message filter","type":"object","x-stream-index":"003"},"message_options":{"$ref":"#/components/schemas/MessageOptions","x-stream-index":"004"},"next":{"description":"Pagination parameter. Cannot be used with non-zero offset.","title":"Next","type":"string","x-stream-index":"008"},"offset":{"description":"Pagination offset. Cannot be used with sort or next.","format":"int32","title":"Offset","type":"integer","x-stream-index":"006"},"query":{"description":"Search phrase","title":"Query","type":"string","x-stream-index":"001"},"sort":{"description":"Sort parameters. Cannot be used with non-zero offset","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"007"}},"required":["filter_conditions"],"type":"object"},"SearchResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"005.001"},"next":{"description":"Value to pass to the next search query in order to paginate","title":"Next","type":"string","x-stream-index":"003"},"previous":{"description":"Value that points to the previous page. Pass as the next value in a search query to paginate backwards","title":"Previous","type":"string","x-stream-index":"004"},"results":{"description":"Search results","items":{"$ref":"#/components/schemas/SearchResult"},"title":"Results","type":"array","x-stream-index":"001"},"results_warning":{"$ref":"#/components/schemas/SearchWarning","description":"Warning about the search results","title":"Results Warning","x-stream-index":"002"}},"required":["results","duration"],"type":"object"},"SearchResult":{"properties":{"message":{"$ref":"#/components/schemas/SearchResultMessage","description":"Found message","title":"Message","x-stream-index":"001"}},"type":"object"},"SearchResultMessage":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"001.008"},"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel object","title":"Channel","x-stream-index":"002"},"cid":{"type":"string","x-stream-index":"001.022"},"command":{"type":"string","x-stream-index":"001.004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.023"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.026"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.025"},"deleted_for_me":{"type":"boolean","x-stream-index":"001.044"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"001.018"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001.041"},"html":{"type":"string","x-stream-index":"001.005"},"i18n":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.030"},"id":{"type":"string","x-stream-index":"001.001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"001.028"},"latest_reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"001.009"},"mentioned_users":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"001.029"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"001.036"},"mml":{"type":"string","x-stream-index":"001.003"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"001.039"},"own_reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"001.010"},"parent_id":{"type":"string","x-stream-index":"001.015"},"pin_expires":{"format":"date-time","type":"number","x-stream-index":"001.035"},"pinned":{"type":"boolean","x-stream-index":"001.032"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"001.033"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001.034"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001.038"},"poll_id":{"type":"string","x-stream-index":"001.037"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001.020"},"quoted_message_id":{"type":"string","x-stream-index":"001.019"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001.011"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"001.014"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001.012"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"001.042"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"001.017"},"restricted_visibility":{"items":{"type":"string"},"type":"array","x-stream-index":"001.040"},"shadowed":{"type":"boolean","x-stream-index":"001.027"},"shared_location":{"$ref":"#/components/schemas/SharedLocationResponseData","x-stream-index":"001.043"},"show_in_channel":{"type":"boolean","x-stream-index":"001.016"},"silent":{"type":"boolean","x-stream-index":"001.031"},"text":{"type":"string","x-stream-index":"001.002"},"thread_participants":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"001.021"},"type":{"type":"string","x-stream-index":"001.006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.024"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001.007"}},"required":["id","text","html","type","user","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned","restricted_visibility"],"type":"object"},"SearchWarning":{"properties":{"channel_search_cids":{"description":"Channel CIDs for the searched channels","items":{"type":"string"},"title":"Channel Search CIDs","type":"array","x-stream-index":"004"},"channel_search_count":{"description":"Number of channels searched","format":"int32","title":"Channel Search Count","type":"integer","x-stream-index":"003"},"warning_code":{"description":"Code corresponding to the warning","format":"int32","title":"Warning Code","type":"integer","x-stream-index":"002"},"warning_description":{"description":"Description of the warning","title":"Warning Description","type":"string","x-stream-index":"001"}},"required":["warning_description","warning_code"],"type":"object"},"SendEventRequest":{"nullable":true,"properties":{"event":{"$ref":"#/components/schemas/EventRequest","x-stream-index":"001"}},"required":["event"],"type":"object"},"SendMessageRequest":{"nullable":true,"properties":{"keep_channel_hidden":{"type":"boolean","x-stream-index":"008"},"message":{"$ref":"#/components/schemas/MessageRequest","x-stream-index":"001"},"skip_enrich_url":{"type":"boolean","x-stream-index":"003"},"skip_push":{"type":"boolean","x-stream-index":"002"}},"required":["message"],"type":"object"},"SendMessageResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Message response","title":"Message","x-stream-index":"001"},"pending_message_metadata":{"additionalProperties":{"type":"string"},"description":"Pending message metadata","title":"Pending message metadata","type":"object","x-stream-index":"002"}},"required":["message","duration"],"type":"object"},"SendReactionRequest":{"nullable":true,"properties":{"enforce_unique":{"description":"Whether to replace all existing user reactions","title":"Enforce unique","type":"boolean","x-stream-index":"003"},"reaction":{"$ref":"#/components/schemas/ReactionRequest","x-stream-index":"002"},"skip_push":{"description":"Skips any mobile push notifications","title":"Skip push","type":"boolean","x-stream-index":"004"}},"required":["reaction"],"type":"object"},"SendReactionResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001"},"reaction":{"$ref":"#/components/schemas/ReactionResponse","x-stream-index":"002"}},"required":["message","reaction","duration"],"title":"Response","type":"object"},"SessionSettings":{"properties":{"inactivity_timeout_seconds":{"format":"int32","maximum":900,"minimum":5,"type":"integer","x-stream-index":"001"}},"required":["inactivity_timeout_seconds"],"type":"object"},"SessionSettingsResponse":{"properties":{"inactivity_timeout_seconds":{"format":"int32","maximum":900,"minimum":5,"type":"integer","x-stream-index":"001"}},"required":["inactivity_timeout_seconds"],"type":"object"},"ShadowBlockActionRequest":{"type":"object"},"SharedLocation":{"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"013"},"channel_cid":{"type":"string","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"010"},"created_by_device_id":{"type":"string","x-stream-index":"008"},"end_at":{"format":"date-time","type":"number","x-stream-index":"009"},"latitude":{"format":"float","maximum":90,"minimum":18446744073709552000,"type":"number","x-stream-index":"006"},"longitude":{"format":"float","maximum":180,"minimum":18446744073709552000,"type":"number","x-stream-index":"007"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"012"},"message_id":{"type":"string","x-stream-index":"004"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"011"},"user_id":{"type":"string","x-stream-index":"005"}},"required":["channel_cid","message_id","user_id","created_by_device_id","created_at","updated_at"],"type":"object"},"SharedLocationResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001.011"},"channel_cid":{"description":"Channel CID","title":"string","type":"string","x-stream-index":"001.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.008"},"created_by_device_id":{"description":"Device ID that created the live location","title":"string","type":"string","x-stream-index":"001.006"},"duration":{"type":"string","x-stream-index":"002.001"},"end_at":{"description":"Time when the live location expires","format":"date-time","title":"string","type":"number","x-stream-index":"001.007"},"latitude":{"description":"Latitude coordinate","format":"float","title":"number","type":"number","x-stream-index":"001.004"},"longitude":{"description":"Longitude coordinate","format":"float","title":"number","type":"number","x-stream-index":"001.005"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001.010"},"message_id":{"description":"Message ID","title":"string","type":"string","x-stream-index":"001.002"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.009"},"user_id":{"description":"User ID","title":"string","type":"string","x-stream-index":"001.003"}},"required":["channel_cid","message_id","user_id","latitude","longitude","created_by_device_id","created_at","updated_at","duration"],"type":"object"},"SharedLocationResponseData":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"011"},"channel_cid":{"type":"string","x-stream-index":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"created_by_device_id":{"type":"string","x-stream-index":"006"},"end_at":{"format":"date-time","type":"number","x-stream-index":"007"},"latitude":{"format":"float","type":"number","x-stream-index":"004"},"longitude":{"format":"float","type":"number","x-stream-index":"005"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"010"},"message_id":{"type":"string","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["channel_cid","message_id","user_id","latitude","longitude","created_by_device_id","created_at","updated_at"],"type":"object"},"SharedLocationsResponse":{"nullable":true,"properties":{"active_live_locations":{"items":{"$ref":"#/components/schemas/SharedLocationResponseData"},"type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["active_live_locations","duration"],"type":"object"},"ShowChannelRequest":{"nullable":true,"type":"object"},"ShowChannelResponse":{"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"},"SortParamRequest":{"nullable":true,"properties":{"direction":{"description":"Direction of sorting, 1 for Ascending, -1 for Descending, default is 1","format":"int32","title":"Direction","type":"integer","x-stream-index":"002"},"field":{"description":"Name of field to sort by","title":"Field","type":"string","x-stream-index":"001"}},"type":"object"},"SubmitActionRequest":{"nullable":true,"properties":{"action_type":{"description":"Type of moderation action to perform (mark_reviewed, delete_message, etc.)","enum":["mark_reviewed","delete_message","delete_activity","delete_reaction","ban","custom","unban","restore","delete_user","unblock","shadow_block","unmask","kick_user","end_call"],"title":"Action Type","type":"string","x-stream-index":"002"},"ban":{"$ref":"#/components/schemas/BanActionRequest","description":"Configuration for ban action","title":"Ban","x-stream-index":"008"},"custom":{"$ref":"#/components/schemas/CustomActionRequest","description":"Configuration for custom action","title":"Custom","x-stream-index":"009"},"delete_activity":{"$ref":"#/components/schemas/DeleteActivityRequest","description":"Configuration for activity deletion action","title":"Delete Activity","x-stream-index":"004"},"delete_message":{"$ref":"#/components/schemas/DeleteMessageRequest","description":"Configuration for message deletion action","title":"Delete Message","x-stream-index":"003"},"delete_reaction":{"$ref":"#/components/schemas/DeleteReactionRequest","description":"Configuration for reaction deletion action","title":"Delete Reaction","x-stream-index":"005"},"delete_user":{"$ref":"#/components/schemas/DeleteUserRequest","description":"Configuration for user deletion action","title":"Delete User","x-stream-index":"006"},"item_id":{"description":"UUID of the review queue item to act on","title":"Item ID","type":"string","x-stream-index":"001"},"mark_reviewed":{"$ref":"#/components/schemas/MarkReviewedRequest","description":"Configuration for marking item as reviewed","title":"Mark Reviewed","x-stream-index":"007"},"unban":{"$ref":"#/components/schemas/UnbanActionRequest","description":"Configuration for unban action","title":"Unban","x-stream-index":"010"}},"required":["item_id","action_type"],"type":"object"},"SubmitActionResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"Updated review queue item after action was performed","title":"Item","x-stream-index":"001"}},"required":["duration"],"type":"object"},"SyncRequest":{"description":"Sync request","nullable":true,"properties":{"channel_cids":{"description":"List of channel CIDs to sync","items":{"type":"string"},"maximum":255,"minimum":1,"title":"Channel CIDs","type":"array","x-stream-index":"001"},"last_sync_at":{"description":"Date from which synchronization should happen","format":"date-time","title":"Last sync at","type":"number","x-stream-index":"002"}},"required":["channel_cids","last_sync_at"],"title":"SyncRequest","type":"object"},"SyncResponse":{"description":"Sync response","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"events":{"description":"List of events","items":{"$ref":"#/components/schemas/WSEvent"},"title":"Events","type":"array","x-stream-index":"001"},"inaccessible_cids":{"description":"List of CIDs that user can't access","items":{"type":"string"},"title":"Inaccessible CIDs","type":"array","x-stream-index":"002"}},"required":["events","duration"],"title":"SyncResponse","type":"object"},"TargetResolution":{"properties":{"bitrate":{"format":"int32","maximum":6000000,"type":"integer","x-stream-index":"003"},"height":{"format":"int32","maximum":3840,"minimum":240,"type":"integer","x-stream-index":"002"},"width":{"format":"int32","maximum":3840,"minimum":240,"type":"integer","x-stream-index":"001"}},"required":["width","height","bitrate"],"type":"object"},"TextContentParameters":{"properties":{"blocklist_match":{"items":{"type":"string"},"type":"array","x-stream-index":"005"},"contains_url":{"type":"boolean","x-stream-index":"003"},"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001"},"llm_harm_labels":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"002"},"severity":{"type":"string","x-stream-index":"004"}},"type":"object"},"TextRuleParameters":{"properties":{"blocklist_match":{"items":{"type":"string"},"type":"array","x-stream-index":"007"},"contains_url":{"type":"boolean","x-stream-index":"005"},"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"llm_harm_labels":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"004"},"severity":{"type":"string","x-stream-index":"006"},"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"type":"object"},"ThreadParticipant":{"description":"Represents a user that is participating in a thread.","nullable":true,"properties":{"app_pk":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"001"},"channel_cid":{"type":"string","x-stream-index":"002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"007"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"last_read_at":{"format":"date-time","type":"number","x-stream-index":"009"},"last_thread_message_at":{"format":"date-time","type":"number","x-stream-index":"003"},"left_thread_at":{"description":"Left Thread At is the time when the user left the thread","format":"date-time","title":"Left Thread At","type":"number","x-stream-index":"008"},"thread_id":{"description":"Thead ID is unique string identifier of the thread","title":"ID","type":"string","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User is the user object","title":"User","x-stream-index":"006"},"user_id":{"description":"User ID is unique string identifier of the user","title":"User ID","type":"string","x-stream-index":"005"}},"required":["app_pk","channel_cid","created_at","last_read_at","custom"],"title":"ThreadParticipant","type":"object"},"ThreadResponse":{"properties":{"active_participant_count":{"description":"Active Participant Count","format":"int32","title":"Active Participant Count","type":"integer","x-stream-index":"009"},"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel","title":"ChannelResponse","x-stream-index":"002"},"channel_cid":{"description":"Channel CID","title":"Channel CID","type":"string","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"012"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"Created By User","title":"User","x-stream-index":"006"},"created_by_user_id":{"description":"Created By User ID","title":"Created By User ID","type":"string","x-stream-index":"005"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"016"},"deleted_at":{"description":"Deleted At","format":"date-time","title":"Deleted At","type":"number","x-stream-index":"014"},"last_message_at":{"description":"Last Message At","format":"date-time","title":"Last Message At","type":"number","x-stream-index":"011"},"parent_message":{"$ref":"#/components/schemas/MessageResponse","description":"Parent Message","title":"Message","x-stream-index":"004"},"parent_message_id":{"description":"Parent Message ID","title":"Parent Message ID","type":"string","x-stream-index":"003"},"participant_count":{"description":"Participant Count","format":"int32","title":"Participant Count","type":"integer","x-stream-index":"008"},"reply_count":{"description":"Reply Count","format":"int32","title":"Reply Count","type":"integer","x-stream-index":"007"},"thread_participants":{"description":"Thread Participants","items":{"$ref":"#/components/schemas/ThreadParticipant"},"title":"ThreadParticipants","type":"array","x-stream-index":"010"},"title":{"description":"Title","title":"Title","type":"string","x-stream-index":"015"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"013"}},"required":["channel_cid","parent_message_id","created_by_user_id","created_at","updated_at","title","custom"],"type":"object"},"ThreadStateResponse":{"nullable":true,"properties":{"active_participant_count":{"description":"Active Participant Count","format":"int32","title":"Active Participant Count","type":"integer","x-stream-index":"001.009"},"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel","title":"ChannelResponse","x-stream-index":"001.002"},"channel_cid":{"description":"Channel CID","title":"Channel CID","type":"string","x-stream-index":"001.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.012"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"Created By User","title":"User","x-stream-index":"001.006"},"created_by_user_id":{"description":"Created By User ID","title":"Created By User ID","type":"string","x-stream-index":"001.005"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"001.016"},"deleted_at":{"description":"Deleted At","format":"date-time","title":"Deleted At","type":"number","x-stream-index":"001.014"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"004"},"last_message_at":{"description":"Last Message At","format":"date-time","title":"Last Message At","type":"number","x-stream-index":"001.011"},"latest_replies":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","x-stream-index":"002"},"parent_message":{"$ref":"#/components/schemas/MessageResponse","description":"Parent Message","title":"Message","x-stream-index":"001.004"},"parent_message_id":{"description":"Parent Message ID","title":"Parent Message ID","type":"string","x-stream-index":"001.003"},"participant_count":{"description":"Participant Count","format":"int32","title":"Participant Count","type":"integer","x-stream-index":"001.008"},"read":{"items":{"$ref":"#/components/schemas/ReadStateResponse"},"type":"array","x-stream-index":"003"},"reply_count":{"description":"Reply Count","format":"int32","title":"Reply Count","type":"integer","x-stream-index":"001.007"},"thread_participants":{"description":"Thread Participants","items":{"$ref":"#/components/schemas/ThreadParticipant"},"title":"ThreadParticipants","type":"array","x-stream-index":"001.010"},"title":{"description":"Title","title":"Title","type":"string","x-stream-index":"001.015"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.013"}},"required":["channel_cid","parent_message_id","created_by_user_id","created_at","updated_at","title","custom","latest_replies"],"type":"object"},"ThreadUpdatedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"001.002"},"channel_type":{"type":"string","x-stream-index":"001.003"},"cid":{"type":"string","x-stream-index":"001.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"thread":{"$ref":"#/components/schemas/ThreadResponse","x-stream-index":"003.001"},"type":{"default":"thread.updated","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"ThreadUpdatedEvent","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"},"Thresholds":{"description":"Sets thresholds for AI moderation","properties":{"explicit":{"$ref":"#/components/schemas/LabelThresholds","description":"Thresholds for explicit messages","title":"LabelThresholds","x-stream-index":"001"},"spam":{"$ref":"#/components/schemas/LabelThresholds","description":"Thresholds for spam","title":"LabelThresholds","x-stream-index":"002"},"toxic":{"$ref":"#/components/schemas/LabelThresholds","description":"Thresholds for toxic messages","title":"LabelThresholds","x-stream-index":"003"}},"title":"Auto moderation thresholds","type":"object"},"ThumbnailResponse":{"properties":{"image_url":{"type":"string","x-stream-index":"001"}},"required":["image_url"],"type":"object"},"ThumbnailsSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"ThumbnailsSettingsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"Time":{"type":"object"},"TranscriptionSettings":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"title":"Mode","type":"string","x-stream-index":"002"},"language":{"description":"The language used in this call as a two letter code","enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"title":"Language","type":"string","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"title":"Mode","type":"string","x-stream-index":"001"}},"required":["mode","closed_caption_mode","languages","language"],"type":"object"},"TranscriptionSettingsResponse":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"002"},"language":{"enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"type":"string","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode","closed_caption_mode","languages","language"],"type":"object"},"TranslateMessageRequest":{"nullable":true,"properties":{"language":{"description":"Language to translate message to","enum":["af","sq","am","ar","az","bn","bs","bg","zh","zh-TW","hr","cs","da","fa-AF","nl","en","et","fi","fr","fr-CA","ka","de","el","ha","he","hi","hu","id","it","ja","ko","lv","ms","no","fa","ps","pl","pt","ro","ru","sr","sk","sl","so","es","es-MX","sw","sv","tl","ta","th","tr","uk","ur","vi","lt","ht"],"title":"Language","type":"string","x-stream-index":"001"}},"required":["language"],"type":"object"},"TruncateChannelRequest":{"nullable":true,"properties":{"hard_delete":{"description":"Permanently delete channel data (messages, reactions, etc.)","title":"Hard delete","type":"boolean","x-stream-index":"002"},"member_ids":{"description":"List of member IDs to hide message history for. If empty, truncates the channel for all members","items":{"type":"string"},"maximum":100,"title":"Member IDs","type":"array","x-stream-index":"007"},"message":{"$ref":"#/components/schemas/MessageRequest","x-stream-index":"004"},"skip_push":{"description":"When `message` is set disables all push notifications for it","title":"Skip push","type":"boolean","x-stream-index":"005"},"truncated_at":{"description":"Truncate channel data up to `truncated_at`. The system message (if provided) creation time is always greater than `truncated_at`","format":"date-time","title":"Truncated at","type":"number","x-stream-index":"006"}},"type":"object"},"TruncateChannelResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Truncated channel object","title":"Channel","x-stream-index":"002"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Truncated message object","title":"Message","x-stream-index":"003"}},"required":["duration"],"type":"object"},"TypingIndicators":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"TypingIndicatorsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"TypingStartEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"parent_id":{"type":"string","x-stream-index":"001"},"type":{"default":"typing.start","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"TypingStartEvent","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"},"TypingStopEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"parent_id":{"type":"string","x-stream-index":"001"},"type":{"default":"typing.stop","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"TypingStopEvent","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"},"UnbanActionRequest":{"type":"object"},"UnblockActionRequest":{"type":"object"},"UnblockUsersRequest":{"nullable":true,"properties":{"blocked_user_id":{"type":"string","x-stream-index":"001"}},"required":["blocked_user_id"],"type":"object"},"UnblockUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"UnmuteChannelRequest":{"nullable":true,"properties":{"channel_cids":{"description":"Channel CIDs to mute (if multiple channels)","items":{"type":"string"},"maximum":25,"title":"Channel CIDs","type":"array","x-stream-index":"001.002"},"expiration":{"description":"Duration of mute in milliseconds","title":"Expiration","type":"integer","x-stream-index":"001.003"}},"type":"object"},"UnmuteResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"non_existing_users":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"required":["duration"],"title":"Response","type":"object"},"UnreadCountsChannel":{"properties":{"channel_id":{"type":"string","x-stream-index":"001"},"last_read":{"format":"date-time","type":"number","x-stream-index":"003"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["channel_id","unread_count","last_read"],"type":"object"},"UnreadCountsChannelType":{"properties":{"channel_count":{"format":"int32","type":"integer","x-stream-index":"002"},"channel_type":{"type":"string","x-stream-index":"001"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["channel_type","channel_count","unread_count"],"type":"object"},"UnreadCountsThread":{"properties":{"last_read":{"format":"date-time","type":"number","x-stream-index":"002"},"last_read_message_id":{"type":"string","x-stream-index":"003"},"parent_message_id":{"type":"string","x-stream-index":"004"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"001"}},"required":["unread_count","last_read","last_read_message_id","parent_message_id"],"type":"object"},"UpdateBlockListRequest":{"nullable":true,"properties":{"team":{"type":"string","x-stream-index":"002"},"words":{"description":"List of words to block","items":{"type":"string"},"minimum":1,"title":"Words","type":"array","x-stream-index":"003"}},"title":"Update block list","type":"object","x-stream-docs-page-id":"update_block_list"},"UpdateBlockListResponse":{"description":"Basic response information","nullable":true,"properties":{"blocklist":{"$ref":"#/components/schemas/BlockListResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["duration"],"title":"Response","type":"object"},"UpdateChannelPartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"type":"object","x-stream-index":"002.001"},"unset":{"items":{"type":"string"},"type":"array","x-stream-index":"002.002"}},"title":"UpdateChannelPartialRequest","type":"object"},"UpdateChannelPartialResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Updated channel object","title":"Channel","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"members":{"description":"List of updated members","items":{"$ref":"#/components/schemas/ChannelMemberResponse"},"title":"ChannelMemberResponse","type":"array","x-stream-index":"002"}},"required":["members","duration"],"type":"object"},"UpdateChannelRequest":{"nullable":true,"properties":{"accept_invite":{"description":"Set to `true` to accept the invite","title":"Accept invite","type":"boolean","x-stream-index":"008"},"add_members":{"description":"List of user IDs to add to the channel","items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"title":"Add members","type":"array","x-stream-index":"001"},"add_moderators":{"description":"List of user IDs to make channel moderators","items":{"type":"string"},"maximum":100,"title":"Add moderators","type":"array","x-stream-index":"003"},"assign_roles":{"description":"List of channel member role assignments. If any specified user is not part of the channel, the request will fail","items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"title":"Assign roles","type":"array","x-stream-index":"006"},"cooldown":{"description":"Sets cool down period for the channel in seconds","format":"int32","maximum":120,"minimum":0,"title":"Cool down","type":"integer","x-stream-index":"007"},"data":{"$ref":"#/components/schemas/ChannelInput","x-stream-index":"013.001"},"demote_moderators":{"description":"List of user IDs to take away moderators status from","items":{"type":"string"},"maximum":100,"title":"Demote moderators","type":"array","x-stream-index":"004"},"hide_history":{"description":"Set to `true` to hide channel's history when adding new members","title":"Hide history","type":"boolean","x-stream-index":"012"},"invites":{"description":"List of user IDs to invite to the channel","items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"title":"Invites","type":"array","x-stream-index":"005"},"message":{"$ref":"#/components/schemas/MessageRequest","description":"Message to send to the chat when channel is successfully updated","title":"Message","x-stream-index":"010"},"reject_invite":{"description":"Set to `true` to reject the invite","title":"Reject invite","type":"boolean","x-stream-index":"009"},"remove_members":{"description":"List of user IDs to remove from the channel","items":{"type":"string"},"maximum":100,"title":"Remove members","type":"array","x-stream-index":"002"},"skip_push":{"description":"When `message` is set disables all push notifications for it","title":"Skip push","type":"boolean","x-stream-index":"011"}},"title":"Channel update request","type":"object","x-stream-docs-page-id":"channel_update"},"UpdateChannelResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Updated channel","title":"Channel","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"004.001"},"members":{"description":"List of channel members","items":{"$ref":"#/components/schemas/ChannelMember"},"title":"Members","type":"array","x-stream-index":"003"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Message sent to the chat","title":"Message","x-stream-index":"002"}},"required":["members","duration"],"type":"object"},"UpdateLiveLocationRequest":{"nullable":true,"properties":{"end_at":{"description":"Time when the live location expires","format":"date-time","title":"string","type":"number","x-stream-index":"004"},"latitude":{"description":"Latitude coordinate","format":"float","maximum":90,"minimum":18446744073709552000,"title":"number","type":"number","x-stream-index":"002"},"longitude":{"description":"Longitude coordinate","format":"float","maximum":180,"minimum":18446744073709552000,"title":"number","type":"number","x-stream-index":"003"},"message_id":{"description":"Live location ID","title":"string","type":"string","x-stream-index":"001"}},"required":["message_id"],"type":"object"},"UpdateMemberPartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"type":"object","x-stream-index":"002.001"},"unset":{"items":{"type":"string"},"type":"array","x-stream-index":"002.002"}},"type":"object"},"UpdateMemberPartialResponse":{"nullable":true,"properties":{"channel_member":{"$ref":"#/components/schemas/ChannelMemberResponse","description":"Updated channel member","title":"Channel member","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["duration"],"type":"object"},"UpdateMessagePartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"description":"Sets new field values","title":"Set","type":"object","x-stream-index":"002.001","x-stream-map":{"key":"field","title":"Value","description":"New value to set"}},"skip_enrich_url":{"description":"Skip enriching the URL in the message","title":"SkipEnrichURL","type":"boolean","x-stream-index":"001"},"unset":{"description":"Array of field names to unset","items":{"type":"string"},"title":"Unset","type":"array","x-stream-index":"002.002"}},"type":"object"},"UpdateMessagePartialResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Updated message","title":"Message","x-stream-index":"001"},"pending_message_metadata":{"additionalProperties":{"type":"string"},"description":"Pending message metadata","title":"PendingMessageMetadata","type":"object","x-stream-index":"002"}},"required":["duration"],"type":"object"},"UpdateMessageRequest":{"nullable":true,"properties":{"message":{"$ref":"#/components/schemas/MessageRequest","description":"Message","title":"MessageRequest","x-stream-index":"001"},"skip_enrich_url":{"description":"Skip enrich URL","title":"boolean","type":"boolean","x-stream-index":"003"},"skip_push":{"type":"boolean","x-stream-index":"002"}},"required":["message"],"type":"object"},"UpdateMessageResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001"},"pending_message_metadata":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"002"}},"required":["message","duration"],"title":"Response","type":"object"},"UpdatePollOptionRequest":{"nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"004"},"id":{"description":"Option ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"},"text":{"description":"Option text","title":"string","type":"string","x-stream-index":"003"}},"required":["id","text"],"type":"object"},"UpdatePollPartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"description":"Sets new field values","title":"Set","type":"object","x-stream-index":"002.001","x-stream-map":{"key":"field","title":"Value","description":"New value to set"}},"unset":{"description":"Array of field names to unset","items":{"type":"string"},"title":"Unset","type":"array","x-stream-index":"002.002"}},"type":"object"},"UpdatePollRequest":{"nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"011"},"allow_answers":{"description":"Allow answers","title":"boolean","type":"boolean","x-stream-index":"009"},"allow_user_suggested_options":{"description":"Allow user suggested options","title":"boolean","type":"boolean","x-stream-index":"008"},"description":{"description":"Poll description","title":"string","type":"string","x-stream-index":"003"},"enforce_unique_vote":{"description":"Enforce unique vote","title":"boolean","type":"boolean","x-stream-index":"005"},"id":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"},"is_closed":{"description":"Is closed","title":"boolean","type":"boolean","x-stream-index":"010"},"max_votes_allowed":{"description":"Max votes allowed","format":"int32","maximum":10,"title":"integer","type":"integer","x-stream-index":"007"},"name":{"description":"Poll name","title":"string","type":"string","x-stream-index":"002"},"options":{"description":"Poll options","items":{"$ref":"#/components/schemas/PollOptionRequest"},"maximum":100,"title":"PollOptions","type":"array","x-stream-index":"004"},"voting_visibility":{"description":"Voting visibility","enum":["anonymous","public"],"title":"string","type":"string","x-stream-index":"006"}},"required":["id","name"],"type":"object"},"UpdateReminderRequest":{"nullable":true,"properties":{"remind_at":{"format":"date-time","type":"number","x-stream-index":"001"}},"type":"object"},"UpdateReminderResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"001"}},"required":["reminder","duration"],"title":"Response","type":"object"},"UpdateThreadPartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"description":"Sets new field values","title":"Set","type":"object","x-stream-index":"004.001","x-stream-map":{"key":"field","title":"Value","description":"New value to set"}},"unset":{"description":"Array of field names to unset","items":{"type":"string"},"title":"Unset","type":"array","x-stream-index":"004.002"}},"type":"object"},"UpdateThreadPartialResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"thread":{"$ref":"#/components/schemas/ThreadResponse","description":"Updated thread (not enriched)","title":"Thread","x-stream-index":"001"}},"required":["thread","duration"],"type":"object"},"UpdateUserPartialRequest":{"properties":{"id":{"description":"User ID to update","title":"ID","type":"string","x-stream-index":"001"},"set":{"additionalProperties":{},"type":"object","x-stream-index":"002.001"},"unset":{"items":{"type":"string"},"type":"array","x-stream-index":"002.002"}},"required":["id"],"type":"object"},"UpdateUsersPartialRequest":{"nullable":true,"properties":{"users":{"items":{"$ref":"#/components/schemas/UpdateUserPartialRequest"},"maximum":100,"type":"array","x-stream-index":"001"}},"required":["users"],"type":"object"},"UpdateUsersRequest":{"nullable":true,"properties":{"users":{"additionalProperties":{"$ref":"#/components/schemas/UserRequest"},"description":"Object containing users","title":"Users","type":"object","x-stream-index":"001","x-stream-map":{"key":"user_id"}}},"required":["users"],"type":"object"},"UpdateUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"membership_deletion_task_id":{"type":"string","x-stream-index":"002"},"users":{"additionalProperties":{"$ref":"#/components/schemas/FullUserResponse"},"description":"Object containing users","title":"Users","type":"object","x-stream-index":"001","x-stream-map":{"key":"user_id"}}},"required":["users","membership_deletion_task_id","duration"],"type":"object"},"UpsertConfigRequest":{"nullable":true,"properties":{"ai_image_config":{"$ref":"#/components/schemas/AIImageConfig","description":"Configuration for AI image analysis","title":"AI Image Config","x-stream-index":"011"},"ai_text_config":{"$ref":"#/components/schemas/AITextConfig","description":"Configuration for AI text analysis","title":"AI Text Config","x-stream-index":"008"},"ai_video_config":{"$ref":"#/components/schemas/AIVideoConfig","description":"Configuration for AI video analysis","title":"AI Video Config","x-stream-index":"012"},"async":{"description":"Whether moderation should be performed asynchronously","title":"Async","type":"boolean","x-stream-index":"003"},"automod_platform_circumvention_config":{"$ref":"#/components/schemas/AutomodPlatformCircumventionConfig","description":"Configuration for platform circumvention detection","title":"Automod Platform Circumvention Config","x-stream-index":"005"},"automod_semantic_filters_config":{"$ref":"#/components/schemas/AutomodSemanticFiltersConfig","description":"Configuration for semantic filtering","title":"Automod Semantic Filters Config","x-stream-index":"006"},"automod_toxicity_config":{"$ref":"#/components/schemas/AutomodToxicityConfig","description":"Configuration for toxicity detection","title":"Automod Toxicity Config","x-stream-index":"004"},"aws_rekognition_config":{"$ref":"#/components/schemas/AIImageConfig","x-stream-index":"016"},"block_list_config":{"$ref":"#/components/schemas/BlockListConfig","description":"Configuration for block list filtering","title":"Block List Config","x-stream-index":"007"},"bodyguard_config":{"$ref":"#/components/schemas/AITextConfig","x-stream-index":"015"},"google_vision_config":{"$ref":"#/components/schemas/GoogleVisionConfig","description":"Configuration for Google Vision integration","title":"Google Vision Config","x-stream-index":"010"},"key":{"description":"Unique identifier for the moderation configuration","title":"Key","type":"string","x-stream-index":"001"},"llm_config":{"$ref":"#/components/schemas/LLMConfig","description":"Configuration for customer-configured LLM moderation","title":"LLM Config","x-stream-index":"009"},"rule_builder_config":{"$ref":"#/components/schemas/RuleBuilderConfig","description":"Configuration for custom rule builder (max 3 rules, max 5 conditions per rule)","title":"Rule Builder Config","x-stream-index":"014"},"team":{"description":"Team associated with the configuration","maxLength":128,"minLength":1,"title":"Team","type":"string","x-stream-index":"002"},"velocity_filter_config":{"$ref":"#/components/schemas/VelocityFilterConfig","description":"Configuration for velocity-based filtering","title":"Velocity Filter Config","x-stream-index":"013"},"video_call_rule_config":{"$ref":"#/components/schemas/VideoCallRuleConfig","x-stream-index":"017"}},"required":["key"],"type":"object"},"UpsertConfigResponse":{"nullable":true,"properties":{"config":{"$ref":"#/components/schemas/ConfigResponse","description":"The created or updated moderation configuration","title":"Config","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["duration"],"type":"object"},"UpsertPushPreferencesRequest":{"nullable":true,"properties":{"preferences":{"description":"A list of push preferences for channels, calls, or the user.","items":{"$ref":"#/components/schemas/PushPreferenceInput"},"type":"array","x-stream-index":"001"}},"required":["preferences"],"type":"object"},"UpsertPushPreferencesResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"user_channel_preferences":{"additionalProperties":{"additionalProperties":{"$ref":"#/components/schemas/ChannelPushPreferences"},"type":"object"},"description":"The channel specific push notification preferences, only returned for channels you've edited.","title":"User Channel Notification Preferences","type":"object","x-stream-index":"002"},"user_preferences":{"additionalProperties":{"$ref":"#/components/schemas/PushPreferences"},"description":"The user preferences, always returned regardless if you edited it","title":"User Preferences","type":"object","x-stream-index":"001"}},"required":["user_preferences","user_channel_preferences","duration"],"type":"object"},"User":{"properties":{"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"046"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"017"},"banned":{"type":"boolean","x-stream-index":"016"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"013"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"023"},"language":{"type":"string","x-stream-index":"035"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"026"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"042"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"005"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"009"}},"required":["id","role","teams_role","custom","banned","online"],"type":"object"},"UserBannedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"006.002"},"channel_type":{"type":"string","x-stream-index":"006.003"},"cid":{"type":"string","x-stream-index":"006.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008.002"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"001"},"expiration":{"format":"date-time","type":"number","x-stream-index":"003"},"reason":{"type":"string","x-stream-index":"004"},"shadow":{"type":"boolean","x-stream-index":"002"},"team":{"type":"string","x-stream-index":"005.001"},"type":{"default":"user.banned","type":"string","x-stream-index":"008.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007.001"}},"required":["created_by","shadow","cid","channel_id","channel_type","type","created_at"],"title":"UserBannedEvent","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"},"UserCreatedWithinParameters":{"properties":{"max_age":{"type":"string","x-stream-index":"001"}},"type":"object"},"UserCustomPropertyParameters":{"properties":{"operator":{"type":"string","x-stream-index":"002"},"property_key":{"type":"string","x-stream-index":"001"}},"type":"object"},"UserDeactivatedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"001"},"type":{"default":"user.deactivated","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["created_by","type","created_at"],"title":"UserDeactivatedEvent","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"},"UserDeletedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"delete_conversation_channels":{"type":"boolean","x-stream-index":"005"},"hard_delete":{"type":"boolean","x-stream-index":"003.001"},"mark_messages_deleted":{"type":"boolean","x-stream-index":"004"},"type":{"default":"user.deleted","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"001.001"}},"required":["type","created_at","hard_delete","mark_messages_deleted","delete_conversation_channels"],"title":"UserDeletedEvent","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"},"UserMessagesDeletedEvent":{"description":"This event is sent when a user's message get deleted. The event contains information about the user whose messages got deleted.","nullable":true,"properties":{"channel_custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.005"},"channel_id":{"description":"The ID of the channel where the target user's messages were deleted","title":"Channel ID","type":"string","x-stream-index":"001.002.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"001.001.004"},"channel_type":{"description":"The type of the channel where the target user's messages were deleted","title":"Channel Type","type":"string","x-stream-index":"001.002.001"},"cid":{"description":"The CID of the channel where the target user's messages were deleted","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":"number","x-stream-index":"001.001.001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.001.001.007"},"hard_delete":{"description":"Whether Messages were hard deleted","title":"Hard Delete","type":"boolean","x-stream-index":"003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.001.001.004"},"team":{"description":"The team of the channel where the target user's messages were deleted","title":"Team","type":"string","x-stream-index":"001.001.003"},"type":{"default":"user.messages.deleted","description":"The type of event: \"user.messages.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.001.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The target user whose messages got deleted","title":"User","x-stream-index":"002.001"}},"required":["type","created_at","custom","user"],"title":"UserMessagesDeletedEvent","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"},"UserMute":{"nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"expires":{"description":"Date/time of mute expiration","format":"date-time","title":"Expires","type":"number","x-stream-index":"008"},"target":{"$ref":"#/components/schemas/User","description":"User who's muted","title":"Target","x-stream-index":"007"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/User","description":"Owner of channel mute","title":"User","x-stream-index":"005"}},"required":["created_at","updated_at"],"type":"object"},"UserMuteResponse":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"expires":{"format":"date-time","type":"number","x-stream-index":"003"},"target":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"}},"required":["created_at","updated_at"],"type":"object"},"UserMutedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"target_user":{"type":"string","x-stream-index":"001"},"target_users":{"items":{"type":"string"},"type":"array","x-stream-index":"002"},"type":{"default":"user.muted","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"UserMutedEvent","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"},"UserPresenceChangedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"type":{"default":"user.presence.changed","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"001.001"}},"required":["type","created_at"],"title":"UserPresenceChangedEvent","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"},"UserReactivatedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"type":{"default":"user.reactivated","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"001"}},"required":["type","created_at"],"title":"UserReactivatedEvent","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"},"UserRequest":{"description":"User request object","properties":{"custom":{"additionalProperties":{},"description":"Custom user data","title":"Custom","type":"object","x-stream-index":"004"},"id":{"description":"User ID","title":"ID","type":"string","x-stream-index":"001"},"image":{"description":"User's profile image URL","title":"Image","type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"006"},"language":{"type":"string","x-stream-index":"005"},"name":{"description":"Optional name of user","title":"Name","type":"string","x-stream-index":"002"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"007"}},"required":["id"],"title":"UserRequest","type":"object"},"UserResponse":{"description":"User response object","properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"banned":{"description":"Whether a user is banned or not","title":"Banned","type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.017"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"001.004"},"deactivated_at":{"description":"Date of deactivation","format":"date-time","title":"Deactivated at","type":"number","x-stream-index":"001.016"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"001.011"},"id":{"description":"Unique user identifier","title":"ID","type":"string","x-stream-index":"001.001"},"image":{"title":"Image","type":"string","x-stream-index":"001.003"},"language":{"description":"Preferred language of a user","title":"Language","type":"string","x-stream-index":"001.005"},"last_active":{"description":"Date of last activity","format":"date-time","title":"Last active","type":"number","x-stream-index":"001.014"},"name":{"description":"Optional name of user","title":"Name","type":"string","x-stream-index":"001.002"},"online":{"description":"Whether a user online or not","title":"Online","type":"boolean","x-stream-index":"001.013"},"revoke_tokens_issued_before":{"description":"Revocation date for tokens","format":"date-time","title":"Revoke tokens issued before","type":"number","x-stream-index":"001.015"},"role":{"description":"Determines the set of user permissions","title":"Role","type":"string","x-stream-index":"001.006"},"teams":{"description":"List of teams user is a part of","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids","shadow_banned","invisible"],"title":"UserResponse","type":"object"},"UserResponseCommonFields":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"018"},"banned":{"type":"boolean","x-stream-index":"012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"017"},"created_at":{"format":"date-time","type":"number","x-stream-index":"009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"id":{"type":"string","x-stream-index":"001"},"image":{"type":"string","x-stream-index":"003"},"language":{"type":"string","x-stream-index":"005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"014"},"name":{"type":"string","x-stream-index":"002"},"online":{"type":"boolean","x-stream-index":"013"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"015"},"role":{"type":"string","x-stream-index":"006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids"],"type":"object"},"UserResponsePrivacyFields":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"banned":{"type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.017"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.011"},"id":{"type":"string","x-stream-index":"001.001"},"image":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"003"},"language":{"type":"string","x-stream-index":"001.005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"001.014"},"name":{"type":"string","x-stream-index":"001.002"},"online":{"type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"002"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.015"},"role":{"type":"string","x-stream-index":"001.006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids"],"type":"object"},"UserRuleParameters":{"properties":{"max_age":{"type":"string","x-stream-index":"001"}},"type":"object"},"UserUnbannedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"005.002"},"shadow":{"type":"boolean","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"004.001"},"type":{"default":"user.unbanned","type":"string","x-stream-index":"005.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["shadow","cid","channel_id","channel_type","type","created_at"],"title":"UserUnbannedEvent","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"},"UserUpdatedEvent":{"description":"This event is sent when a user gets updated. The event contains information about the updated user.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"type":{"default":"user.updated","description":"The type of event: \"user.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.002"},"user":{"$ref":"#/components/schemas/UserResponsePrivacyFields","description":"The updated user","title":"User","x-stream-index":"002.001"}},"required":["type","created_at","custom","user"],"title":"UserUpdatedEvent","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"},"UserWatchingStartEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"team":{"type":"string","x-stream-index":"002.001"},"type":{"default":"user.watching.start","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005.001"},"watcher_count":{"format":"int32","type":"integer","x-stream-index":"001.001"}},"required":["watcher_count","type","created_at","cid","channel_id","channel_type"],"title":"UserWatchingStartEvent","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"},"UserWatchingStopEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"type":{"default":"user.watching.stop","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"},"watcher_count":{"format":"int32","type":"integer","x-stream-index":"001.001"}},"required":["watcher_count","type","created_at","cid","channel_id","channel_type"],"title":"UserWatchingStopEvent","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"},"VelocityFilterConfig":{"properties":{"advanced_filters":{"type":"boolean","x-stream-index":"007"},"async":{"type":"boolean","x-stream-index":"001"},"cascading_actions":{"type":"boolean","x-stream-index":"004"},"cids_per_user":{"format":"int32","type":"integer","x-stream-index":"006"},"enabled":{"type":"boolean","x-stream-index":"002"},"first_message_only":{"type":"boolean","x-stream-index":"005"},"rules":{"items":{"$ref":"#/components/schemas/VelocityFilterConfigRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules","cascading_actions","first_message_only","cids_per_user","advanced_filters"],"type":"object"},"VelocityFilterConfigRule":{"properties":{"action":{"enum":["flag","shadow","remove","ban"],"type":"string","x-stream-index":"001"},"ban_duration":{"format":"int32","type":"integer","x-stream-index":"002"},"cascading_action":{"enum":["flag","shadow","remove","ban"],"type":"string","x-stream-index":"006"},"cascading_threshold":{"format":"int64","type":"integer","x-stream-index":"005"},"check_message_context":{"type":"boolean","x-stream-index":"009"},"fast_spam_threshold":{"format":"int32","type":"integer","x-stream-index":"007"},"fast_spam_ttl":{"format":"int32","type":"integer","x-stream-index":"010"},"ip_ban":{"type":"boolean","x-stream-index":"004"},"probation_period":{"format":"int32","type":"integer","x-stream-index":"014"},"shadow_ban":{"type":"boolean","x-stream-index":"003"},"slow_spam_ban_duration":{"format":"int32","type":"integer","x-stream-index":"012"},"slow_spam_threshold":{"format":"int32","type":"integer","x-stream-index":"008"},"slow_spam_ttl":{"format":"int32","type":"integer","x-stream-index":"011"},"url_only":{"type":"boolean","x-stream-index":"013"}},"required":["action","ban_duration","shadow_ban","ip_ban","cascading_threshold","cascading_action","fast_spam_threshold","slow_spam_threshold","check_message_context","fast_spam_ttl","slow_spam_ttl","url_only","probation_period"],"type":"object"},"VideoCallRuleConfig":{"properties":{"rules":{"additionalProperties":{"$ref":"#/components/schemas/HarmConfig"},"type":"object","x-stream-index":"001"}},"required":["rules"],"type":"object"},"VideoContentParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"type":"object"},"VideoEndCallRequest":{"type":"object"},"VideoKickUserRequest":{"type":"object"},"VideoOrientation":{"properties":{"orientation":{"type":"integer","x-stream-index":"004"}},"type":"object"},"VideoRuleParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"type":"object"},"VideoSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"camera_default_on":{"type":"boolean","x-stream-index":"004"},"camera_facing":{"enum":["front","back","external"],"type":"string","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled","target_resolution","camera_default_on","camera_facing"],"type":"object"},"VideoSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"camera_default_on":{"type":"boolean","x-stream-index":"004"},"camera_facing":{"enum":["front","back","external"],"type":"string","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled","target_resolution","camera_default_on","camera_facing"],"type":"object"},"VoteData":{"properties":{"answer_text":{"type":"string","x-stream-index":"002"},"option_id":{"maxLength":255,"type":"string","x-stream-index":"001"}},"type":"object"},"WSAuthMessage":{"description":"Websocket auth message","nullable":true,"properties":{"products":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"token":{"title":"Token","type":"string","x-stream-index":"002"},"user_details":{"$ref":"#/components/schemas/ConnectUserDetailsRequest","x-stream-index":"001"}},"required":["user_details","token"],"title":"WSAuthMessage","type":"object"},"WSClientEvent":{"description":"The discriminator object for all websocket client events, it maps events' payload to the final type","discriminator":{"mapping":{"app.updated":"#/components/schemas/AppUpdatedEvent","draft.deleted":"#/components/schemas/DraftDeletedEvent","draft.updated":"#/components/schemas/DraftUpdatedEvent","health.check":"#/components/schemas/HealthCheckEvent","message.pending":"#/components/schemas/PendingMessageEvent","notification.reminder_due":"#/components/schemas/ReminderNotificationEvent","poll.closed":"#/components/schemas/PollClosedEvent","poll.deleted":"#/components/schemas/PollDeletedEvent","poll.updated":"#/components/schemas/PollUpdatedEvent","poll.vote_casted":"#/components/schemas/PollVoteCastedEvent","poll.vote_changed":"#/components/schemas/PollVoteChangedEvent","poll.vote_removed":"#/components/schemas/PollVoteRemovedEvent","reminder.created":"#/components/schemas/ReminderCreatedEvent","reminder.deleted":"#/components/schemas/ReminderDeletedEvent","reminder.updated":"#/components/schemas/ReminderUpdatedEvent","user.messages.deleted":"#/components/schemas/UserMessagesDeletedEvent","user.updated":"#/components/schemas/UserUpdatedEvent"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/AppUpdatedEvent"},{"$ref":"#/components/schemas/DraftDeletedEvent"},{"$ref":"#/components/schemas/DraftUpdatedEvent"},{"$ref":"#/components/schemas/HealthCheckEvent"},{"$ref":"#/components/schemas/PendingMessageEvent"},{"$ref":"#/components/schemas/PollClosedEvent"},{"$ref":"#/components/schemas/PollDeletedEvent"},{"$ref":"#/components/schemas/PollUpdatedEvent"},{"$ref":"#/components/schemas/PollVoteCastedEvent"},{"$ref":"#/components/schemas/PollVoteChangedEvent"},{"$ref":"#/components/schemas/PollVoteRemovedEvent"},{"$ref":"#/components/schemas/ReminderCreatedEvent"},{"$ref":"#/components/schemas/ReminderDeletedEvent"},{"$ref":"#/components/schemas/ReminderNotificationEvent"},{"$ref":"#/components/schemas/ReminderUpdatedEvent"},{"$ref":"#/components/schemas/UserMessagesDeletedEvent"},{"$ref":"#/components/schemas/UserUpdatedEvent"}]},"WSEvent":{"description":"The discriminator object for all websocket events, it maps events' payload to the final type","discriminator":{"mapping":{"*":"#/components/schemas/AnyEvent","activity.marked":"#/components/schemas/ActivityMarkedEvent","ai_indicator.clear":"#/components/schemas/AIIndicatorClearEvent","ai_indicator.stop":"#/components/schemas/AIIndicatorStopEvent","ai_indicator.update":"#/components/schemas/AIIndicatorUpdateEvent","app.updated":"#/components/schemas/AppUpdatedEvent","channel.created":"#/components/schemas/ChannelCreatedEvent","channel.deleted":"#/components/schemas/ChannelDeletedEvent","channel.frozen":"#/components/schemas/ChannelFrozenEvent","channel.hidden":"#/components/schemas/ChannelHiddenEvent","channel.kicked":"#/components/schemas/ChannelKickedEvent","channel.truncated":"#/components/schemas/ChannelTruncatedEvent","channel.unfrozen":"#/components/schemas/ChannelUnFrozenEvent","channel.updated":"#/components/schemas/ChannelUpdatedEvent","channel.visible":"#/components/schemas/ChannelVisibleEvent","draft.deleted":"#/components/schemas/DraftDeletedEvent","draft.updated":"#/components/schemas/DraftUpdatedEvent","health.check":"#/components/schemas/HealthCheckEvent","member.added":"#/components/schemas/MemberAddedEvent","member.removed":"#/components/schemas/MemberRemovedEvent","member.updated":"#/components/schemas/MemberUpdatedEvent","message.deleted":"#/components/schemas/MessageDeletedEvent","message.new":"#/components/schemas/MessageNewEvent","message.pending":"#/components/schemas/PendingMessageEvent","message.read":"#/components/schemas/MessageReadEvent","message.undeleted":"#/components/schemas/MessageUndeletedEvent","message.updated":"#/components/schemas/MessageUpdatedEvent","moderation.custom_action":"#/components/schemas/ModerationCustomActionEvent","moderation.flagged":"#/components/schemas/ModerationFlaggedEvent","moderation.mark_reviewed":"#/components/schemas/ModerationMarkReviewedEvent","notification.added_to_channel":"#/components/schemas/NotificationAddedToChannelEvent","notification.channel_deleted":"#/components/schemas/NotificationChannelDeletedEvent","notification.channel_mutes_updated":"#/components/schemas/NotificationChannelMutesUpdatedEvent","notification.channel_truncated":"#/components/schemas/NotificationChannelTruncatedEvent","notification.invite_accepted":"#/components/schemas/NotificationInviteAcceptedEvent","notification.invite_rejected":"#/components/schemas/NotificationInviteRejectedEvent","notification.invited":"#/components/schemas/NotificationInvitedEvent","notification.mark_read":"#/components/schemas/NotificationMarkReadEvent","notification.mark_unread":"#/components/schemas/NotificationMarkUnreadEvent","notification.message_new":"#/components/schemas/NotificationNewMessageEvent","notification.mutes_updated":"#/components/schemas/NotificationMutesUpdatedEvent","notification.reminder_due":"#/components/schemas/ReminderNotificationEvent","notification.removed_from_channel":"#/components/schemas/NotificationRemovedFromChannelEvent","notification.thread_message_new":"#/components/schemas/MessageNewEvent","poll.closed":"#/components/schemas/PollClosedEvent","poll.deleted":"#/components/schemas/PollDeletedEvent","poll.updated":"#/components/schemas/PollUpdatedEvent","poll.vote_casted":"#/components/schemas/PollVoteCastedEvent","poll.vote_changed":"#/components/schemas/PollVoteChangedEvent","poll.vote_removed":"#/components/schemas/PollVoteRemovedEvent","reaction.deleted":"#/components/schemas/ReactionDeletedEvent","reaction.new":"#/components/schemas/ReactionNewEvent","reaction.updated":"#/components/schemas/ReactionUpdatedEvent","reminder.created":"#/components/schemas/ReminderCreatedEvent","reminder.deleted":"#/components/schemas/ReminderDeletedEvent","reminder.updated":"#/components/schemas/ReminderUpdatedEvent","thread.updated":"#/components/schemas/ThreadUpdatedEvent","typing.start":"#/components/schemas/TypingStartEvent","typing.stop":"#/components/schemas/TypingStopEvent","user.banned":"#/components/schemas/UserBannedEvent","user.deactivated":"#/components/schemas/UserDeactivatedEvent","user.deleted":"#/components/schemas/UserDeletedEvent","user.messages.deleted":"#/components/schemas/UserMessagesDeletedEvent","user.muted":"#/components/schemas/UserMutedEvent","user.presence.changed":"#/components/schemas/UserPresenceChangedEvent","user.reactivated":"#/components/schemas/UserReactivatedEvent","user.unbanned":"#/components/schemas/UserUnbannedEvent","user.updated":"#/components/schemas/UserUpdatedEvent","user.watching.start":"#/components/schemas/UserWatchingStartEvent","user.watching.stop":"#/components/schemas/UserWatchingStopEvent"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/AIIndicatorClearEvent"},{"$ref":"#/components/schemas/AIIndicatorStopEvent"},{"$ref":"#/components/schemas/AIIndicatorUpdateEvent"},{"$ref":"#/components/schemas/ActivityMarkedEvent"},{"$ref":"#/components/schemas/AnyEvent"},{"$ref":"#/components/schemas/AppUpdatedEvent"},{"$ref":"#/components/schemas/ChannelCreatedEvent"},{"$ref":"#/components/schemas/ChannelDeletedEvent"},{"$ref":"#/components/schemas/ChannelFrozenEvent"},{"$ref":"#/components/schemas/ChannelHiddenEvent"},{"$ref":"#/components/schemas/ChannelKickedEvent"},{"$ref":"#/components/schemas/ChannelTruncatedEvent"},{"$ref":"#/components/schemas/ChannelUnFrozenEvent"},{"$ref":"#/components/schemas/ChannelUpdatedEvent"},{"$ref":"#/components/schemas/ChannelVisibleEvent"},{"$ref":"#/components/schemas/DraftDeletedEvent"},{"$ref":"#/components/schemas/DraftUpdatedEvent"},{"$ref":"#/components/schemas/HealthCheckEvent"},{"$ref":"#/components/schemas/MemberAddedEvent"},{"$ref":"#/components/schemas/MemberRemovedEvent"},{"$ref":"#/components/schemas/MemberUpdatedEvent"},{"$ref":"#/components/schemas/MessageDeletedEvent"},{"$ref":"#/components/schemas/MessageNewEvent"},{"$ref":"#/components/schemas/MessageNewEvent"},{"$ref":"#/components/schemas/MessageReadEvent"},{"$ref":"#/components/schemas/MessageUndeletedEvent"},{"$ref":"#/components/schemas/MessageUpdatedEvent"},{"$ref":"#/components/schemas/ModerationCustomActionEvent"},{"$ref":"#/components/schemas/ModerationFlaggedEvent"},{"$ref":"#/components/schemas/ModerationMarkReviewedEvent"},{"$ref":"#/components/schemas/NotificationAddedToChannelEvent"},{"$ref":"#/components/schemas/NotificationChannelDeletedEvent"},{"$ref":"#/components/schemas/NotificationChannelMutesUpdatedEvent"},{"$ref":"#/components/schemas/NotificationChannelTruncatedEvent"},{"$ref":"#/components/schemas/NotificationInviteAcceptedEvent"},{"$ref":"#/components/schemas/NotificationInviteRejectedEvent"},{"$ref":"#/components/schemas/NotificationInvitedEvent"},{"$ref":"#/components/schemas/NotificationMarkReadEvent"},{"$ref":"#/components/schemas/NotificationMarkUnreadEvent"},{"$ref":"#/components/schemas/NotificationMutesUpdatedEvent"},{"$ref":"#/components/schemas/NotificationNewMessageEvent"},{"$ref":"#/components/schemas/NotificationRemovedFromChannelEvent"},{"$ref":"#/components/schemas/PendingMessageEvent"},{"$ref":"#/components/schemas/PollClosedEvent"},{"$ref":"#/components/schemas/PollDeletedEvent"},{"$ref":"#/components/schemas/PollUpdatedEvent"},{"$ref":"#/components/schemas/PollVoteCastedEvent"},{"$ref":"#/components/schemas/PollVoteChangedEvent"},{"$ref":"#/components/schemas/PollVoteRemovedEvent"},{"$ref":"#/components/schemas/ReactionDeletedEvent"},{"$ref":"#/components/schemas/ReactionNewEvent"},{"$ref":"#/components/schemas/ReactionUpdatedEvent"},{"$ref":"#/components/schemas/ReminderCreatedEvent"},{"$ref":"#/components/schemas/ReminderDeletedEvent"},{"$ref":"#/components/schemas/ReminderNotificationEvent"},{"$ref":"#/components/schemas/ReminderUpdatedEvent"},{"$ref":"#/components/schemas/ThreadUpdatedEvent"},{"$ref":"#/components/schemas/TypingStartEvent"},{"$ref":"#/components/schemas/TypingStopEvent"},{"$ref":"#/components/schemas/UserBannedEvent"},{"$ref":"#/components/schemas/UserDeactivatedEvent"},{"$ref":"#/components/schemas/UserDeletedEvent"},{"$ref":"#/components/schemas/UserMessagesDeletedEvent"},{"$ref":"#/components/schemas/UserMutedEvent"},{"$ref":"#/components/schemas/UserPresenceChangedEvent"},{"$ref":"#/components/schemas/UserReactivatedEvent"},{"$ref":"#/components/schemas/UserUnbannedEvent"},{"$ref":"#/components/schemas/UserUpdatedEvent"},{"$ref":"#/components/schemas/UserWatchingStartEvent"},{"$ref":"#/components/schemas/UserWatchingStopEvent"}]},"WrappedUnreadCountsResponse":{"description":"Basic response information","nullable":true,"properties":{"channel_type":{"items":{"$ref":"#/components/schemas/UnreadCountsChannelType"},"type":"array","x-stream-index":"001.005"},"channels":{"items":{"$ref":"#/components/schemas/UnreadCountsChannel"},"type":"array","x-stream-index":"001.004"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"threads":{"items":{"$ref":"#/components/schemas/UnreadCountsThread"},"type":"array","x-stream-index":"001.006"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"001.001"},"total_unread_count_by_team":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001.003"},"total_unread_threads_count":{"format":"int32","type":"integer","x-stream-index":"001.002"}},"required":["total_unread_count","total_unread_threads_count","channels","channel_type","threads","duration"],"title":"Response","type":"object"}},"securitySchemes":{"JWT":{"description":"JWT should be always provided when stream-auth-type=jwt.\n\nUsing JWT auth request could be authenticated as user or as server-side.\n\nWhen using user authentication permission checking is going to be applied to requests based on the user that is\nperforming a request.\n\nThe `authorization` header should be a JWT string signed using the secret attached to the API key used to perform\nrequests.\n\n**WARNING** all client-side official SDK do not ship with token generation; this is to make sure that the API secret is not\nshared with an untrusted party such as a browser or a iOS/Android application. Tokens **must** be generated server-side.\nIf you wish, you can configure your application to ignore authentication (see `disable_auth_check`)\nThe JWT string must include only the user_id claim and can include any built-in JWT claim such as iat, exp as well.\n","in":"header","name":"Authorization","type":"apiKey"},"api_key":{"description":"Application API key should be always set in order to authenticate the request.","in":"query","name":"api_key","type":"apiKey"},"stream-auth-type":{"description":"Stream-Auth-Type should be always set in order to authenticate the request. Possible\nvalues: `jwt` or `anonymous`.\n\n`jwt` allows you to authenticate as a user. With this auth type you should also provide valid JWT in Authorization\nheader.\n\n`anonymous` allows you to authenticate as anonymous user. Please note that most advanced features are not available\nto anonymous users.","in":"header","name":"Stream-Auth-Type","type":"apiKey"}}},"info":{"title":"Stream API","version":"v191.1.0"},"openapi":"3.0.3","paths":{"/api/v2/app":{"get":{"description":"This Method returns the application settings\n","operationId":"GetApp","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetApplicationResponse"}}},"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":"Get App Settings","tags":["product:common"]}},"/api/v2/blocklists":{"get":{"description":"Returns all available block lists\n","operationId":"ListBlockLists","parameters":[{"in":"query","name":"team","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListBlockListResponse"}}},"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":"List block lists","tags":["product:common"]},"post":{"description":"Creates a new application blocklist, once created the blocklist can be used by any channel type\n","operationId":"CreateBlockList","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBlockListRequest"}}},"description":"Block list","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBlockListResponse"}}},"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":"Create block list","tags":["product:common"]}},"/api/v2/blocklists/{name}":{"delete":{"description":"Deletes previously created application blocklist\n","operationId":"DeleteBlockList","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"team","schema":{"type":"string","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete block list","tags":["product:common"]},"put":{"description":"Updates contents of the block list\n","operationId":"UpdateBlockList","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Block list name","title":"Name","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBlockListRequest"}}},"description":"Update block list","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBlockListResponse"}}},"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":"Update block list","tags":["product:common"]}},"/api/v2/chat/channels":{"post":{"description":"Query channels with filter query\n","operationId":"QueryChannels","parameters":[{"in":"query","name":"connection_id","schema":{"description":"Websocket connection ID to interact with. You can pass it as Body or URL parameter","title":"Connection ID","type":"string","x-stream-index":"011.003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryChannelsRequest"}}},"description":"Query Channels Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryChannelsResponse"}}},"description":"Channels list"},"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":"Query channels","tags":["product:chat"]}},"/api/v2/chat/channels/delete":{"post":{"description":"Allows to delete several channels at once asynchronously\n\nSends events:\n- channel.deleted\n- channel.deleted\n","operationId":"DeleteChannels","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteChannelsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteChannelsResponse"}}},"description":"Successful 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":"Deletes channels asynchronously","tags":["product:chat"]}},"/api/v2/chat/channels/read":{"post":{"description":"Marks channels as read up to the specific message. If no channels is given, mark all channel as read\n\nSends events:\n- message.read\n- message.read\n","operationId":"MarkChannelsRead","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkChannelsReadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkReadResponse"}}},"description":"Successful 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 channels as read","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/query":{"post":{"description":"This Method creates a channel or returns an existing one with matching attributes\n\nSends events:\n- channel.created\n- member.added\n- member.removed\n- member.updated\n- user.watching.start\n","operationId":"GetOrCreateDistinctChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"connection_id","schema":{"description":"Websocket connection ID to interact with. You can pass it as Body or URL parameter","title":"Connection ID","type":"string","x-stream-index":"012.003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelGetOrCreateRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelStateResponse"}}},"description":"Successful 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":"Get or create channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}":{"delete":{"description":"Deletes channel\n\nSends events:\n- channel.deleted\n- channel.deleted\n","operationId":"DeleteChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"query","name":"hard_delete","schema":{"type":"boolean","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteChannelResponse"}}},"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":"Delete channel","tags":["product:chat"]},"patch":{"description":"Updates certain fields of the channel\n\nSends events:\n- channel.updated\n- channel.updated\n","operationId":"UpdateChannelPartial","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelPartialRequest"}}},"description":"UpdateChannelPartialRequest","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelPartialResponse"}}},"description":"Successful 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":"Partially update channel","tags":["product:chat"]},"post":{"description":"Change channel data\n\nSends events:\n- channel.updated\n- member.added\n- member.removed\n- member.updated\n- message.new\n- channel.updated\n- member.added\n- member.removed\n- member.updated\n- message.new\n","operationId":"UpdateChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"013.002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"013.002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelRequest"}}},"description":"Channel update request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelResponse"}}},"description":"Successful 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":"Update channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/draft":{"delete":{"description":"Deletes a draft\n\nSends events:\n- draft.deleted\n","operationId":"DeleteDraft","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"parent_id","schema":{"description":"Parent message ID","title":"string","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete draft","tags":["product:chat"]},"get":{"description":"Get a draft\n","operationId":"GetDraft","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"parent_id","schema":{"description":"Parent message ID","title":"string","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetDraftResponse"}}},"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":"Get draft","tags":["product:chat"]},"post":{"description":"Creates a draft\n\nSends events:\n- draft.updated\n","operationId":"CreateDraft","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDraftRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDraftResponse"}}},"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":"Create a draft","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/event":{"post":{"description":"Sends event to the channel\n","operationId":"SendEvent","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendEventRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventResponse"}}},"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":"Send event","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/file":{"delete":{"description":"Deletes previously uploaded file\n","operationId":"DeleteFile","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of file","title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"File ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"url","schema":{"description":"File URL to delete","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete file","tags":["product:chat"]},"post":{"description":"Uploads file\n","operationId":"UploadFile","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/FileUploadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileUploadResponse"}}},"description":"Successful 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":"Upload file","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/hide":{"post":{"description":"Marks channel as hidden for current user\n\nSends events:\n- channel.hidden\n- channel.hidden\n","operationId":"HideChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HideChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HideChannelResponse"}}},"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":"Hide channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/image":{"delete":{"description":"Deletes previously uploaded image\n","operationId":"DeleteImage","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of file","title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"File ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"url","schema":{"description":"File URL to delete","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete image","tags":["product:chat"]},"post":{"description":"Uploads image\n","operationId":"UploadImage","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.001.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.001.002"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/ImageUploadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageUploadResponse"}}},"description":"Successful 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":"Upload image","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/member":{"patch":{"description":"\n","operationId":"UpdateMemberPartial","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMemberPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMemberPartialResponse"}}},"description":"Successful 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":"Partially channel member update","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/message":{"post":{"description":"Sends new message to the specified channel\n\nSends events:\n- message.new\n- message.updated\n- message.new\n- message.updated\n","operationId":"SendMessage","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"009.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"009.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendMessageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendMessageResponse"}}},"description":"Successful 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":"Send new message","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/messages":{"get":{"description":"Returns list messages found by IDs\n","operationId":"GetManyMessages","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"ids","required":true,"schema":{"description":"List of comma-separated IDs","items":{"type":"string"},"maximum":50,"minimum":1,"title":"IDs","type":"array","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetManyMessagesResponse"}}},"description":"Successful 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":"Get many messages","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/query":{"post":{"description":"This Method creates a channel or returns an existing one with matching attributes\n\nSends events:\n- channel.created\n- member.added\n- member.removed\n- member.updated\n- user.watching.start\n","operationId":"GetOrCreateChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID (maximum length of 64 characters)","title":"ID","type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"connection_id","schema":{"description":"Websocket connection ID to interact with. You can pass it as Body or URL parameter","title":"Connection ID","type":"string","x-stream-index":"012.003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelGetOrCreateRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelStateResponse"}}},"description":"Successful 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":"Get or create channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/read":{"post":{"description":"Marks channel as read up to the specific message\n\nSends events:\n- message.read\n- message.read\n","operationId":"MarkRead","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkReadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkReadResponse"}}},"description":"Successful 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 read","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/show":{"post":{"description":"Shows previously hidden channel\n\nSends events:\n- channel.visible\n- channel.visible\n","operationId":"ShowChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShowChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShowChannelResponse"}}},"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":"Show channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/stop-watching":{"post":{"description":"Call this Method to stop receiving channel events\n\nSends events:\n- user.watching.stop\n- user.watching.stop\n","operationId":"StopWatchingChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"connection_id","schema":{"type":"string","x-stream-index":"001.003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelStopWatchingRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Stop watching channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/truncate":{"post":{"description":"Truncates messages from a channel. Can be applied to the entire channel or scoped to specific members.\n\nSends events:\n- channel.truncated\n- channel.truncated\n","operationId":"TruncateChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TruncateChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TruncateChannelResponse"}}},"description":"Successful 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":"Truncate channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/unread":{"post":{"description":"Marks channel as unread from a specific message\n","operationId":"MarkUnread","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkUnreadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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 unread","tags":["product:chat"]}},"/api/v2/chat/drafts/query":{"post":{"description":"Queries draft messages for a user\n","operationId":"QueryDrafts","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryDraftsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryDraftsResponse"}}},"description":"Successful 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":"Query draft messages","tags":["product:chat"]}},"/api/v2/chat/members":{"get":{"description":"Find and filter channel members\n","operationId":"QueryMembers","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryMembersPayload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MembersResponse"}}},"description":"Successful 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":"Query members","tags":["product:chat"]}},"/api/v2/chat/messages/{id}":{"delete":{"description":"Deletes message\n\nSends events:\n- message.deleted\n- message.deleted\n","operationId":"DeleteMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID to delete","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"hard","schema":{"description":"Delete all message reactions and replies as well","title":"Hard","type":"boolean","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"deleted_by","schema":{"type":"string","writeOnly":true,"x-stream-index":"003"}},{"in":"query","name":"delete_for_me","schema":{"description":"Delete the message only for the user making the request","title":"Delete for me","type":"boolean","writeOnly":true,"x-stream-index":"004"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteMessageResponse"}}},"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":"Delete message","tags":["product:chat"]},"get":{"description":"Returns message by ID\n","operationId":"GetMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"ID of the message","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetMessageResponse"}}},"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":"Get message","tags":["product:chat"]},"post":{"description":"Updates message with new data\n\nSends events:\n- message.updated\n- message.updated\n","operationId":"UpdateMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"004.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessageResponse"}}},"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":"Update message","tags":["product:chat"]},"put":{"description":"Updates certain fields of the message\n\nSends events:\n- message.updated\n- message.updated\n","operationId":"UpdateMessagePartial","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessagePartialRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessagePartialResponse"}}},"description":"Successful 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":"Partially message update","tags":["product:chat"]}},"/api/v2/chat/messages/{id}/action":{"post":{"description":"Executes message command action with given parameters\n\nSends events:\n- message.new\n- message.new\n","operationId":"RunMessageAction","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageActionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}},"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":"Run message command action","tags":["product:chat"]}},"/api/v2/chat/messages/{id}/reaction":{"post":{"description":"Sends reaction to specified message\n\nSends events:\n- reaction.new\n- reaction.updated\n","operationId":"SendReaction","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID to send reaction for","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendReactionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendReactionResponse"}}},"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":"Send reaction","tags":["product:chat"]}},"/api/v2/chat/messages/{id}/reaction/{type}":{"delete":{"description":"Removes user reaction from the message\n\nSends events:\n- reaction.deleted\n","operationId":"DeleteReaction","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID to remove reaction from","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"type","required":true,"schema":{"description":"Reaction type to remove","title":"Type","type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"description":"**Server-side only**. User ID which server acts upon","title":"User ID","type":"string","writeOnly":true,"x-stream-index":"003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteReactionResponse"}}},"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":"Delete reaction","tags":["product:chat"]}},"/api/v2/chat/messages/{id}/reactions":{"get":{"description":"Returns list of reactions of specific message\n","operationId":"GetReactions","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"limit","schema":{"description":"Number of records to return","format":"int32","title":"Limit","type":"integer","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"offset","schema":{"description":"Number of records to offset","format":"int32","title":"Offset","type":"integer","writeOnly":true,"x-stream-index":"003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetReactionsResponse"}}},"description":"Successful 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":"Get reactions","tags":["product:chat"]},"post":{"description":"Get reactions on a message\n","operationId":"QueryReactions","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryReactionsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryReactionsResponse"}}},"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"}},"tags":["product:chat"]}},"/api/v2/chat/messages/{id}/translate":{"post":{"description":"Translates message to a given language using automated translation software\n\nSends events:\n- message.updated\n- message.updated\n","operationId":"TranslateMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TranslateMessageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}},"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":"Translate message","tags":["product:chat"]}},"/api/v2/chat/messages/{message_id}/polls/{poll_id}/vote":{"post":{"description":"Cast a vote on a poll\n\nSends events:\n- feeds.poll.vote_casted\n- feeds.poll.vote_changed\n- feeds.poll.vote_removed\n- poll.vote_casted\n- poll.vote_changed\n- poll.vote_removed\n","operationId":"CastPollVote","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CastPollVoteRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollVoteResponse"}}},"description":"Successful 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":"Cast vote","tags":["product:chat"]}},"/api/v2/chat/messages/{message_id}/polls/{poll_id}/vote/{vote_id}":{"delete":{"description":"Delete a vote from a poll\n\nSends events:\n- feeds.poll.vote_removed\n- poll.vote_removed\n","operationId":"DeletePollVote","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"004"}},{"in":"path","name":"vote_id","required":true,"schema":{"description":"Vote ID","maxLength":255,"title":"string","type":"string","x-stream-index":"005"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollVoteResponse"}}},"description":"Successful 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":"Delete vote","tags":["product:chat"]}},"/api/v2/chat/messages/{message_id}/reminders":{"delete":{"description":"Deletes a user's created reminder\n\nSends events:\n- reminder.deleted\n","operationId":"DeleteReminder","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteReminderResponse"}}},"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":"Delete reminder","tags":["product:chat"]},"patch":{"description":"Updates an existing reminder\n\nSends events:\n- reminder.updated\n","operationId":"UpdateReminder","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateReminderRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateReminderResponse"}}},"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":"Updates Reminder","tags":["product:chat"]},"post":{"description":"Creates a new reminder\n\nSends events:\n- reminder.created\n","operationId":"CreateReminder","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateReminderRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReminderResponseData"}}},"description":"Successful 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":"Create reminder","tags":["product:chat"]}},"/api/v2/chat/messages/{parent_id}/replies":{"get":{"description":"Returns replies (thread) of the message\n","operationId":"GetReplies","parameters":[{"in":"path","name":"parent_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"sort","schema":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":1,"type":"array","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"limit","schema":{"description":"The maximum number of messages to return (max limit ","format":"int32","minimum":0,"title":"Limit","type":"integer","x-stream-index":"003.001"}},{"in":"query","name":"offset","schema":{"description":"The offset to start from","format":"int32","title":"Offset","type":"integer","x-stream-index":"003.002"}},{"in":"query","name":"id_gte","schema":{"description":"The ID of the message to get messages with a timestamp greater than or equal to","title":"IDGTE","type":"string","x-stream-index":"003.003"}},{"in":"query","name":"id_gt","schema":{"description":"The ID of the message to get messages with a timestamp greater than","title":"IDGT","type":"string","x-stream-index":"003.004"}},{"in":"query","name":"id_lte","schema":{"description":"The ID of the message to get messages with a timestamp smaller than or equal to","title":"IDLTE","type":"string","x-stream-index":"003.005"}},{"in":"query","name":"id_lt","schema":{"description":"The ID of the message to get messages with a timestamp smaller than","title":"IDLT","type":"string","x-stream-index":"003.006"}},{"in":"query","name":"created_at_after_or_equal","schema":{"description":"The timestamp to get messages with a created_at timestamp greater than or equal to","format":"date-time","title":"Created_at after or equal","type":"number","x-stream-index":"003.007"}},{"in":"query","name":"created_at_after","schema":{"description":"The timestamp to get messages with a created_at timestamp greater than","format":"date-time","title":"Created_at after","type":"number","x-stream-index":"003.008"}},{"in":"query","name":"created_at_before_or_equal","schema":{"description":"The timestamp to get messages with a created_at timestamp smaller than or equal to","format":"date-time","title":"Created_at after before or equal","type":"number","x-stream-index":"003.009"}},{"in":"query","name":"created_at_before","schema":{"description":"The timestamp to get messages with a created_at timestamp smaller than","format":"date-time","title":"Created_at after before","type":"number","x-stream-index":"003.010"}},{"in":"query","name":"id_around","schema":{"description":"The result will be a set of messages, that are both older and newer than the message with the provided ID, and the message with the ID provided will be in the middle of the set","title":"Id around","type":"string","x-stream-index":"003.011"}},{"in":"query","name":"created_at_around","schema":{"description":"The result will be a set of messages, that are both older and newer than the created_at timestamp provided, distributed evenly around the timestamp","format":"date-time","title":"Created_at around","type":"number","x-stream-index":"003.012"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRepliesResponse"}}},"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":"Get replies","tags":["product:chat"]}},"/api/v2/chat/moderation/flags/message":{"get":{"description":"Find and filter message flags\n","operationId":"QueryMessageFlags","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryMessageFlagsPayload","description":"JSON object with query message flags payload","title":"Payload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryMessageFlagsResponse"}}},"description":"QueryMessageFlagsResponse"},"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":"Query Message Flags","tags":["product:chat"]}},"/api/v2/chat/moderation/mute/channel":{"post":{"description":"Mutes channel for user\n\nSends events:\n- channel.muted\n- channel.muted\n","operationId":"MuteChannel","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteChannelResponse"}}},"description":"Successful 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":"Mute channel","tags":["product:chat"]}},"/api/v2/chat/moderation/unmute/channel":{"post":{"description":"Unmutes channel for user\n\nSends events:\n- channel.unmuted\n- channel.unmuted\n","operationId":"UnmuteChannel","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnmuteChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnmuteResponse"}}},"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":"Unmute channel","tags":["product:chat"]}},"/api/v2/chat/push_preferences":{"post":{"description":"Update the push preferences for a user and or channel member. Set to all, mentions or none\n","operationId":"UpdatePushNotificationPreferences","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertPushPreferencesRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertPushPreferencesResponse"}}},"description":"Successful 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":"Push notification preferences","tags":["product:chat"]}},"/api/v2/chat/query_banned_users":{"get":{"description":"Find and filter channel scoped or global user bans\n","operationId":"QueryBannedUsers","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryBannedUsersPayload","description":"JSON object with query user bans payload","title":"Payload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryBannedUsersResponse"}}},"description":"Successful 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":"Query Banned Users","tags":["product:chat"]}},"/api/v2/chat/reminders/query":{"post":{"description":"Queries reminders\n","operationId":"QueryReminders","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryRemindersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryRemindersResponse"}}},"description":"Successful 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":"Query reminders","tags":["product:chat"]}},"/api/v2/chat/search":{"get":{"description":"Search messages across channels\n","operationId":"Search","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchPayload","description":"JSON object with search payload","title":"Payload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchResponse"}}},"description":"Successful 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":"Search messages","tags":["product:chat"]}},"/api/v2/chat/sync":{"post":{"description":"Returns all events happened since client disconnect in specified channels\n","operationId":"Sync","parameters":[{"in":"query","name":"with_inaccessible_cids","schema":{"description":"If set to true this will add 'inaccessible_cids' to response type","title":"With inaccessible CIDs","type":"boolean","x-stream-index":"003"}},{"in":"query","name":"watch","schema":{"description":"If set to true this will start watching requested and newly added channels that user has access to. If error occurred with this option enabled and it is not an input error - channels will still be watched.","title":"Watch synced channels","type":"boolean","x-stream-index":"004"}},{"in":"query","name":"connection_id","schema":{"type":"string","x-stream-index":"006.003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncRequest"}}},"description":"SyncRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncResponse"}}},"description":"SyncResponse"},"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":"Sync","tags":["product:chat"]}},"/api/v2/chat/threads":{"post":{"description":"Returns the list of threads for specific user\n","operationId":"QueryThreads","parameters":[{"in":"query","name":"connection_id","schema":{"type":"string","x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryThreadsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryThreadsResponse"}}},"description":"Successful 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":"Query Threads","tags":["product:chat"]}},"/api/v2/chat/threads/{message_id}":{"get":{"description":"Return a specific thread\n","operationId":"GetThread","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"watch","schema":{"description":"Start watching the channel this thread belongs to","title":"Watch","type":"boolean","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"connection_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"003"}},{"in":"query","name":"reply_limit","schema":{"description":"Limit the number of replies returned","format":"int32","minimum":0,"title":"Reply limit","type":"integer","writeOnly":true,"x-stream-index":"004"}},{"in":"query","name":"participant_limit","schema":{"description":"Limit the number of participants returned","format":"int32","maximum":100,"minimum":0,"title":"Participant limit","type":"integer","writeOnly":true,"x-stream-index":"005"}},{"in":"query","name":"member_limit","schema":{"description":"Limit the number of members returned per thread channel","format":"int32","maximum":100,"minimum":0,"title":"Member limit","type":"integer","writeOnly":true,"x-stream-index":"006"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetThreadResponse"}}},"description":"Successful 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":"Get Thread","tags":["product:chat"]},"patch":{"description":"Updates certain fields of the thread\n\nSends events:\n- thread.updated\n- thread.updated\n","operationId":"UpdateThreadPartial","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateThreadPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateThreadPartialResponse"}}},"description":"Successful 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":"Partially update thread","tags":["product:chat"]}},"/api/v2/chat/unread":{"get":{"description":"Fetch unread counts for a single user\n","operationId":"UnreadCounts","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WrappedUnreadCountsResponse"}}},"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":"Unread counts","tags":["product:chat"]}},"/api/v2/devices":{"delete":{"description":"Deletes one device\n","operationId":"DeleteDevice","parameters":[{"in":"query","name":"id","required":true,"schema":{"description":"Device ID to delete","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete device","tags":["product:common"]},"get":{"description":"Returns all available devices\n","operationId":"ListDevices","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDevicesResponse"}}},"description":"ListDevicesResponse"},"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":"List devices","tags":["product:common"]},"post":{"description":"Adds a new device to a user, if the same device already exists the call will have no effect\n","operationId":"CreateDevice","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDeviceRequest"}}},"description":"CreateDeviceRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Create device","tags":["product:common"]}},"/api/v2/guest":{"post":{"description":"\n","operationId":"CreateGuest","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGuestRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGuestResponse"}}},"description":"Successful 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":"Create Guest","tags":["product:common"]}},"/api/v2/longpoll":{"get":{"description":"WebSocket fallback transport endpoint\n\nSends events:\n- user.updated\n","operationId":"LongPoll","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WSAuthMessage","x-stream-index":"001"}}},"in":"query","name":"json"},{"in":"query","name":"connection_id","schema":{"maxLength":36,"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"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":"Long Poll (Transport)","tags":["product:common"]}},"/api/v2/moderation/ban":{"post":{"description":"Ban a user from a channel or the entire app\n","operationId":"ban","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BanRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BanResponse"}}},"description":"Successful 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":"Ban","tags":["product:moderation"]}},"/api/v2/moderation/config":{"post":{"description":"Create a new moderation configuration or update an existing one. Configure settings for content filtering, AI analysis, toxicity detection, and other moderation features.\n","operationId":"upsert_config","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertConfigRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertConfigResponse"}}},"description":"Successful 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":"Create or update moderation configuration","tags":["product:moderation"]}},"/api/v2/moderation/config/{key}":{"delete":{"description":"Delete a specific moderation policy by its name\n","operationId":"delete_config","parameters":[{"in":"path","name":"key","required":true,"schema":{"description":"Key of the moderation configuration to delete","title":"Key","type":"string","x-stream-index":"001"}},{"in":"query","name":"team","schema":{"description":"Team associated with the configuration","title":"Team","type":"string","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteModerationConfigResponse"}}},"description":"Successful 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":"Delete a moderation policy","tags":["product:moderation"]},"get":{"description":"Retrieve a specific moderation configuration by its key and team. This configuration contains settings for various moderation features like toxicity detection, AI analysis, and filtering rules.\n","operationId":"get_config","parameters":[{"in":"path","name":"key","required":true,"schema":{"description":"Key of the moderation configuration to retrieve","title":"Key","type":"string","x-stream-index":"001"}},{"in":"query","name":"team","schema":{"description":"Team associated with the configuration","title":"Team","type":"string","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetConfigResponse"}}},"description":"Successful 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":"Get moderation configuration","tags":["product:moderation"]}},"/api/v2/moderation/configs":{"post":{"description":"Search and filter moderation configurations across your application. This endpoint is designed for building moderation dashboards and managing multiple configuration sets.\n","operationId":"query_moderation_configs","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationConfigsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationConfigsResponse"}}},"description":"Successful 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":"Query moderation configurations","tags":["product:moderation"]}},"/api/v2/moderation/flag":{"post":{"description":"Flag any type of content (messages, users, channels, activities) for moderation review. Supports custom content types and additional metadata for flagged content.\n","operationId":"flag","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlagRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlagResponse"}}},"description":"Successful 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":"Flag content for moderation","tags":["product:moderation"]}},"/api/v2/moderation/mute":{"post":{"description":"Mute a user. Mutes are generally not visible to the user you mute, while block is something you notice.\n","operationId":"mute","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteRequest"}}},"description":"MuteRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteResponse"}}},"description":"MuteResponse"},"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":"Mute","tags":["product:moderation"]}},"/api/v2/moderation/review_queue":{"post":{"description":"Query review queue items allows you to filter the review queue items. This is used for building a moderation dashboard.\n","operationId":"query_review_queue","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryReviewQueueRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryReviewQueueResponse"}}},"description":"Successful 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":"Query review queue items","tags":["product:moderation"]}},"/api/v2/moderation/submit_action":{"post":{"description":"Take action on flagged content, such as marking content as safe, deleting content, banning users, or executing custom moderation actions. Supports various action types with configurable parameters.\n","operationId":"submit_action","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitActionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitActionResponse"}}},"description":"Successful 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":"Submit moderation action","tags":["product:moderation"]}},"/api/v2/og":{"get":{"description":"Get an OpenGraph attachment for a link\n","operationId":"GetOG","parameters":[{"in":"query","name":"url","required":true,"schema":{"description":"URL to be scraped","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOGResponse"}}},"description":"Get OG Attachment"},"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":"Get OG","tags":["product:common"]}},"/api/v2/polls":{"post":{"description":"Creates a new poll\n","operationId":"CreatePoll","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePollRequest"}}},"description":"Create Poll Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Create poll","tags":["product:common"]},"put":{"description":"Updates a poll\n\nSends events:\n- feeds.poll.closed\n- feeds.poll.updated\n- poll.closed\n- poll.updated\n","operationId":"UpdatePoll","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePollRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Update poll","tags":["product:common"]}},"/api/v2/polls/query":{"post":{"description":"Queries polls\n","operationId":"QueryPolls","parameters":[{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryPollsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryPollsResponse"}}},"description":"Successful 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":"Query polls","tags":["product:common"]}},"/api/v2/polls/{poll_id}":{"delete":{"description":"Deletes a poll\n\nSends events:\n- feeds.poll.deleted\n- poll.deleted\n","operationId":"DeletePoll","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete poll","tags":["product:common"]},"get":{"description":"Retrieves a poll\n","operationId":"GetPoll","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Get poll","tags":["product:common"]},"patch":{"description":"Updates a poll partially\n\nSends events:\n- feeds.poll.closed\n- feeds.poll.updated\n- poll.closed\n- poll.updated\n","operationId":"UpdatePollPartial","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePollPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Partial update poll","tags":["product:common"]}},"/api/v2/polls/{poll_id}/options":{"post":{"description":"Creates a poll option\n\nSends events:\n- feeds.poll.updated\n- poll.updated\n","operationId":"CreatePollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePollOptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollOptionResponse"}}},"description":"Successful 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":"Create poll option","tags":["product:common"]},"put":{"description":"Updates a poll option\n\nSends events:\n- feeds.poll.updated\n- poll.updated\n","operationId":"UpdatePollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePollOptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollOptionResponse"}}},"description":"Successful 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":"Update poll option","tags":["product:common"]}},"/api/v2/polls/{poll_id}/options/{option_id}":{"delete":{"description":"Deletes a poll option\n\nSends events:\n- feeds.poll.updated\n- poll.updated\n","operationId":"DeletePollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"path","name":"option_id","required":true,"schema":{"description":"Option ID","maxLength":255,"title":"string","type":"string","x-stream-index":"003"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete poll option","tags":["product:common"]},"get":{"description":"Retrieves a poll option\n","operationId":"GetPollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"path","name":"option_id","required":true,"schema":{"description":"Option ID","maxLength":255,"title":"string","type":"string","x-stream-index":"003"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollOptionResponse"}}},"description":"Successful 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":"Get poll option","tags":["product:common"]}},"/api/v2/polls/{poll_id}/votes":{"post":{"description":"Queries votes\n","operationId":"QueryPollVotes","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryPollVotesRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollVotesResponse"}}},"description":"Successful 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":"Query votes","tags":["product:common"]}},"/api/v2/uploads/file":{"delete":{"description":"Deletes previously uploaded file\n","operationId":"DeleteFileGlobal","parameters":[{"in":"query","name":"url","schema":{"description":"File URL to delete","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete file","tags":["product:common"],"x-stream-sdk-name":"DeleteFile"},"post":{"description":"Uploads file\n","operationId":"UploadFileGlobal","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/FileUploadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileUploadResponse"}}},"description":"Successful 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":"Upload file","tags":["product:common"],"x-stream-sdk-name":"UploadFile"}},"/api/v2/uploads/image":{"delete":{"description":"Deletes previously uploaded image\n","operationId":"DeleteImageGlobal","parameters":[{"in":"query","name":"url","schema":{"description":"File URL to delete","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete image","tags":["product:common"],"x-stream-sdk-name":"DeleteImage"},"post":{"description":"Uploads image\n","operationId":"UploadImageGlobal","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/ImageUploadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageUploadResponse"}}},"description":"Successful 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":"Upload image","tags":["product:common"],"x-stream-sdk-name":"UploadImage"}},"/api/v2/users":{"get":{"description":"Find and filter users\n","operationId":"QueryUsers","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryUsersPayload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryUsersResponse"}}},"description":"Successful 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":"Query users","tags":["product:common"]},"patch":{"description":"Updates certain fields of the user\n\nSends events:\n- user.presence.changed\n- user.updated\n- user.presence.changed\n","operationId":"UpdateUsersPartial","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersResponse"}}},"description":"Successful 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":"Partially update user","tags":["product:common"]},"post":{"description":"Update or create users in bulk\n\nSends events:\n- user.updated\n","operationId":"UpdateUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersResponse"}}},"description":"Successful 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":"Upsert users","tags":["product:common"]}},"/api/v2/users/block":{"get":{"description":"Get list of blocked Users\n","operationId":"GetBlockedUsers","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBlockedUsersResponse"}}},"description":"Successful 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":"Get list of blocked Users","tags":["product:common"]},"post":{"description":"Block users\n","operationId":"BlockUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUsersResponse"}}},"description":"Successful 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":"Block user","tags":["product:common"]}},"/api/v2/users/live_locations":{"get":{"description":"Retrieves all active live locations for a user\n","operationId":"GetUserLiveLocations","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SharedLocationsResponse"}}},"description":"Successful 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":"Get user live locations","tags":["product:common"]},"put":{"description":"Updates an existing live location with new coordinates or expiration time\n","operationId":"UpdateLiveLocation","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateLiveLocationRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SharedLocationResponse"}}},"description":"Successful 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":"Update live location","tags":["product:common"]}},"/api/v2/users/unblock":{"post":{"description":"Unblock users\n","operationId":"UnblockUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUsersResponse"}}},"description":"Successful 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":"Unblock user","tags":["product:common"]}}},"security":[{"JWT":[],"api_key":[],"stream-auth-type":[]},{"api_key":[],"stream-auth-type":[]}],"servers":[{"description":"Stream API","url":"https://chat.stream-io-api.com"}]} \ No newline at end of file diff --git a/openapi/v2/chat-clientside-api.yaml b/openapi/v2/chat-clientside-api.yaml index 1fa7057d4..5f37dd65f 100644 --- a/openapi/v2/chat-clientside-api.yaml +++ b/openapi/v2/chat-clientside-api.yaml @@ -608,6 +608,7 @@ components: - use_hook_v2 - user_response_time_enabled - moderation_bulk_submit_action_enabled + - moderation_llm_configurability_enabled type: object AppUpdatedEvent: description: Emitted when app settings are updated @@ -1017,11 +1018,6 @@ components: shadow_ban: type: boolean x-stream-index: "003" - required: - - duration - - reason - - shadow_ban - - ip_ban type: object BanRequest: nullable: true @@ -1111,8 +1107,6 @@ components: reason: type: string x-stream-index: "001" - required: - - reason type: object BlockListConfig: properties: @@ -2309,6 +2303,14 @@ components: $ref: '#/components/schemas/ChannelMember' type: array x-stream-index: "020" + message_count: + format: int64 + type: integer + x-stream-index: "035" + message_count_updated_at: + format: date-time + type: number + x-stream-index: "036" team: type: string x-stream-index: "028" @@ -2339,39 +2341,39 @@ components: items: type: string type: array - x-stream-index: "001.026" + x-stream-index: "001.027" automod: enum: - disabled - simple - AI type: string - x-stream-index: "001.021" + x-stream-index: "001.022" automod_behavior: enum: - flag - block - shadow_block type: string - x-stream-index: "001.022" + x-stream-index: "001.023" automod_thresholds: $ref: '#/components/schemas/Thresholds' - x-stream-index: "001.027" + x-stream-index: "001.028" blocklist: type: string - x-stream-index: "001.023" + x-stream-index: "001.024" blocklist_behavior: enum: - flag - block - shadow_block type: string - x-stream-index: "001.024" + x-stream-index: "001.025" blocklists: items: $ref: '#/components/schemas/BlockListOptions' type: array - x-stream-index: "001.025" + x-stream-index: "001.026" commands: items: type: string @@ -2380,6 +2382,9 @@ components: connect_events: type: boolean x-stream-index: "001.004" + count_messages: + type: boolean + x-stream-index: "001.019" created_at: format: date-time type: number @@ -2394,7 +2399,7 @@ components: format: int32 maximum: 20000 type: integer - x-stream-index: "001.020" + x-stream-index: "001.021" mutes: type: boolean x-stream-index: "001.009" @@ -2404,10 +2409,10 @@ components: partition_size: format: int32 type: integer - x-stream-index: "001.028" + x-stream-index: "001.029" partition_ttl: type: integer - x-stream-index: "001.029" + x-stream-index: "001.030" polls: type: boolean x-stream-index: "001.016" @@ -2437,7 +2442,7 @@ components: x-stream-index: "001.018" skip_last_msg_update_for_system_msgs: type: boolean - x-stream-index: "001.030" + x-stream-index: "001.031" typing_events: type: boolean x-stream-index: "001.002" @@ -2473,6 +2478,7 @@ components: - polls - user_message_reminders - shared_locations + - count_messages - message_retention - max_message_length - automod @@ -2488,39 +2494,39 @@ components: items: type: string type: array - x-stream-index: 001.002.026 + x-stream-index: 001.002.027 automod: enum: - disabled - simple - AI type: string - x-stream-index: 001.002.021 + x-stream-index: 001.002.022 automod_behavior: enum: - flag - block - shadow_block type: string - x-stream-index: 001.002.022 + x-stream-index: 001.002.023 automod_thresholds: $ref: '#/components/schemas/Thresholds' - x-stream-index: 001.002.027 + x-stream-index: 001.002.028 blocklist: type: string - x-stream-index: 001.002.023 + x-stream-index: 001.002.024 blocklist_behavior: enum: - flag - block - shadow_block type: string - x-stream-index: 001.002.024 + x-stream-index: 001.002.025 blocklists: items: $ref: '#/components/schemas/BlockListOptions' type: array - x-stream-index: 001.002.025 + x-stream-index: 001.002.026 commands: items: $ref: '#/components/schemas/Command' @@ -2529,6 +2535,9 @@ components: connect_events: type: boolean x-stream-index: 001.002.004 + count_messages: + type: boolean + x-stream-index: 001.002.019 created_at: format: date-time type: number @@ -2550,7 +2559,7 @@ components: format: int32 maximum: 20000 type: integer - x-stream-index: 001.002.020 + x-stream-index: 001.002.021 mutes: type: boolean x-stream-index: 001.002.009 @@ -2560,13 +2569,13 @@ components: partition_size: format: int32 type: integer - x-stream-index: 001.002.028 + x-stream-index: 001.002.029 partition_ttl: example: 24h format: duration nullable: true type: string - x-stream-index: 001.002.029 + x-stream-index: 001.002.030 polls: type: boolean x-stream-index: 001.002.016 @@ -2596,7 +2605,7 @@ components: x-stream-index: 001.002.018 skip_last_msg_update_for_system_msgs: type: boolean - x-stream-index: 001.002.030 + x-stream-index: 001.002.031 typing_events: type: boolean x-stream-index: 001.002.002 @@ -2634,6 +2643,7 @@ components: - polls - user_message_reminders - shared_locations + - count_messages - message_retention - max_message_length - automod @@ -2949,6 +2959,11 @@ components: format: date-time type: number x-stream-index: "011" + deleted_messages: + items: + type: string + type: array + x-stream-index: "020" invite_accepted_at: description: Date when invite was accepted format: date-time @@ -3314,6 +3329,12 @@ components: title: ChannelMembers type: array x-stream-index: "011" + message_count: + description: Number of messages in the channel + format: int64 + title: Message count + type: integer + x-stream-index: "027" mute_expires_at: description: Date of mute expiration format: date-time @@ -3380,6 +3401,11 @@ components: channel: $ref: '#/components/schemas/ChannelResponse' x-stream-index: "001.001" + deleted_messages: + items: + type: string + type: array + x-stream-index: "001.016" draft: $ref: '#/components/schemas/DraftResponse' x-stream-index: "001.014" @@ -3457,6 +3483,11 @@ components: channel: $ref: '#/components/schemas/ChannelResponse' x-stream-index: "001" + deleted_messages: + items: + type: string + type: array + x-stream-index: "016" draft: $ref: '#/components/schemas/DraftResponse' x-stream-index: "014" @@ -3764,6 +3795,9 @@ components: type: string type: array x-stream-index: "011" + count_messages: + type: boolean + x-stream-index: "014" grants: additionalProperties: items: @@ -3810,7 +3844,7 @@ components: $ref: '#/components/schemas/AIImageConfig' description: Configuration for AI image analysis title: AI Image Config - x-stream-index: "009" + x-stream-index: "010" ai_text_config: $ref: '#/components/schemas/AITextConfig' description: Configuration for AI text analysis @@ -3820,7 +3854,7 @@ components: $ref: '#/components/schemas/AIVideoConfig' description: Configuration for AI video analysis title: AI Video Config - x-stream-index: "010" + x-stream-index: "011" async: description: Whether moderation should be performed asynchronously title: Async @@ -3851,15 +3885,17 @@ components: format: date-time title: Created At type: number - x-stream-index: "012" + x-stream-index: "013" key: description: Unique identifier for the moderation configuration title: Key type: string x-stream-index: "001" - rule_builder_config: - $ref: '#/components/schemas/RuleBuilderConfig' - x-stream-index: "015" + llm_config: + $ref: '#/components/schemas/LLMConfig' + description: Configuration for customer-configured LLM moderation + title: LLM Config + x-stream-index: "009" team: description: Team associated with the configuration title: Team @@ -3870,15 +3906,15 @@ components: format: date-time title: Updated At type: number - x-stream-index: "013" + x-stream-index: "014" velocity_filter_config: $ref: '#/components/schemas/VelocityFilterConfig' description: Configuration for velocity-based filtering title: Velocity Filter Config - x-stream-index: "011" + x-stream-index: "012" video_call_rule_config: $ref: '#/components/schemas/VideoCallRuleConfig' - x-stream-index: "014" + x-stream-index: "015" required: - key - team @@ -3922,9 +3958,6 @@ components: time_window: type: string x-stream-index: "002" - required: - - threshold - - time_window type: object CreateBlockListRequest: description: Block list contains restricted words @@ -5104,6 +5137,48 @@ components: type: object x-stream-index: "001" type: object + FeedsEventPreferences: + properties: + comments: + type: string + x-stream-index: "002" + mentions: + type: string + x-stream-index: "004" + new_followers: + type: string + x-stream-index: "003" + reactions: + type: string + x-stream-index: "001" + type: object + FeedsEventPreferencesInput: + properties: + comments: + enum: + - all + - none + type: string + x-stream-index: "002" + mentions: + enum: + - all + - none + type: string + x-stream-index: "004" + new_followers: + enum: + - all + - none + type: string + x-stream-index: "003" + reactions: + enum: + - all + - none + type: string + x-stream-index: "001" + type: object Field: nullable: true properties: @@ -5290,8 +5365,6 @@ components: reason: type: string x-stream-index: "001" - required: - - reason type: object FlagDetails: properties: @@ -5403,8 +5476,6 @@ components: reason: type: string x-stream-index: "001" - required: - - reason type: object FrameRecordSettings: properties: @@ -6086,9 +6157,6 @@ components: time_window: type: string x-stream-index: "002" - required: - - threshold - - time_window type: object ImageSize: properties: @@ -6351,6 +6419,61 @@ components: - max_dimension - frame_rate_limit type: object + LLMConfig: + properties: + app_context: + type: string + x-stream-index: "005" + async: + type: boolean + x-stream-index: "001" + enabled: + type: boolean + x-stream-index: "002" + rules: + items: + $ref: '#/components/schemas/LLMRule' + type: array + x-stream-index: "003" + severity_descriptions: + additionalProperties: + type: string + type: object + x-stream-index: "004" + required: + - enabled + - rules + type: object + LLMRule: + properties: + action: + enum: + - flag + - shadow + - remove + - bounce + - bounce_flag + - bounce_remove + - keep + type: string + x-stream-index: "003" + description: + type: string + x-stream-index: "002" + label: + type: string + x-stream-index: "001" + severity_rules: + items: + $ref: '#/components/schemas/BodyguardSeverityRule' + type: array + x-stream-index: "004" + required: + - label + - description + - action + - severity_rules + type: object Label: properties: harm_labels: @@ -6739,6 +6862,9 @@ components: format: date-time type: number x-stream-index: "033" + deleted_for_me: + type: boolean + x-stream-index: "059" deleted_reply_count: format: int32 type: integer @@ -6954,17 +7080,20 @@ components: properties: channel_id: type: string - x-stream-index: "003.002" + x-stream-index: "004.002" channel_type: type: string - x-stream-index: "003.003" + x-stream-index: "004.003" cid: type: string - x-stream-index: "003.001" + x-stream-index: "004.001" created_at: format: date-time type: number - x-stream-index: "006.002" + x-stream-index: "007.002" + deleted_for_me: + type: boolean + x-stream-index: "003" hard_delete: type: boolean x-stream-index: "002.001" @@ -6973,7 +7102,7 @@ components: x-stream-index: "001.001" team: type: string - x-stream-index: "005.001" + x-stream-index: "006.001" thread_participants: items: $ref: '#/components/schemas/User' @@ -6982,10 +7111,10 @@ components: type: default: message.deleted type: string - x-stream-index: "006.001" + x-stream-index: "007.001" user: $ref: '#/components/schemas/User' - x-stream-index: "004.001" + x-stream-index: "005.001" required: - hard_delete - cid @@ -7152,7 +7281,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: @@ -7378,6 +7507,9 @@ components: title: Deleted at type: number x-stream-index: "025" + deleted_for_me: + type: boolean + x-stream-index: "044" deleted_reply_count: format: int32 type: integer @@ -7767,6 +7899,9 @@ components: title: Deleted at type: number x-stream-index: "001.025" + deleted_for_me: + type: boolean + x-stream-index: "001.044" deleted_reply_count: format: int32 type: integer @@ -8074,6 +8209,71 @@ components: x-stream-event-doc-group: other x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent + ModerationFlagResponse: + nullable: true + properties: + created_at: + format: date-time + type: number + x-stream-index: "015" + custom: + additionalProperties: {} + type: object + x-stream-index: "010" + entity_creator_id: + type: string + x-stream-index: "007" + entity_id: + type: string + x-stream-index: "006" + entity_type: + type: string + x-stream-index: "005" + labels: + items: + type: string + type: array + x-stream-index: "011" + moderation_payload: + $ref: '#/components/schemas/ModerationPayload' + x-stream-index: "008" + reason: + type: string + x-stream-index: "009" + result: + items: + additionalProperties: {} + type: object + type: array + x-stream-index: "012" + review_queue_item: + $ref: '#/components/schemas/ReviewQueueItemResponse' + x-stream-index: "014" + review_queue_item_id: + type: string + x-stream-index: "013" + type: + type: string + x-stream-index: "002" + updated_at: + format: date-time + type: number + x-stream-index: "016" + user: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "004" + user_id: + type: string + x-stream-index: "003" + required: + - type + - user_id + - entity_type + - entity_id + - result + - created_at + - updated_at + type: object ModerationFlaggedEvent: properties: created_at: @@ -10086,11 +10286,25 @@ components: description: Disable push notifications till a certain time format: date-time type: number + x-stream-index: "007" + feeds_events: + $ref: '#/components/schemas/FeedsEventPreferencesInput' + description: Set granular feeds event preferences for reactions, comments, + new followers, and mentions + x-stream-index: "006" + feeds_level: + description: Set the level of feeds push notifications for the user. One + of all, none, default + enum: + - all + - none + - default + type: string x-stream-index: "005" remove_disable: description: Remove the disabled until time. (IE stop snoozing notifications) type: boolean - x-stream-index: "006" + x-stream-index: "008" user_id: description: The user id for which to set the push preferences. Required when using server side auths, defaults to current user with client side @@ -10109,6 +10323,12 @@ components: disabled_until: format: date-time type: number + x-stream-index: "005" + feeds_events: + $ref: '#/components/schemas/FeedsEventPreferences' + x-stream-index: "004" + feeds_level: + type: string x-stream-index: "003" type: object Quality: @@ -11927,7 +12147,7 @@ components: flags: description: Associated flag records items: - $ref: '#/components/schemas/FlagResponse' + $ref: '#/components/schemas/ModerationFlagResponse' title: Flags type: array x-stream-index: "023" @@ -12072,8 +12292,6 @@ components: type: type: string x-stream-index: "001" - required: - - type type: object RuleBuilderCondition: properties: @@ -12102,6 +12320,9 @@ components: user_created_within_params: $ref: '#/components/schemas/UserCreatedWithinParameters' x-stream-index: "011" + user_custom_property_params: + $ref: '#/components/schemas/UserCustomPropertyParameters' + x-stream-index: "012" user_rule_params: $ref: '#/components/schemas/UserRuleParameters' x-stream-index: "006" @@ -12111,8 +12332,6 @@ components: video_rule_params: $ref: '#/components/schemas/VideoRuleParameters' x-stream-index: "005" - required: - - type type: object RuleBuilderConditionGroup: properties: @@ -12124,9 +12343,6 @@ components: logic: type: string x-stream-index: "001" - required: - - logic - - conditions type: object RuleBuilderConfig: properties: @@ -12138,48 +12354,37 @@ components: $ref: '#/components/schemas/RuleBuilderRule' type: array x-stream-index: "002" - required: - - rules type: object RuleBuilderRule: properties: action: $ref: '#/components/schemas/RuleBuilderAction' - x-stream-index: "007" + x-stream-index: "006" conditions: items: $ref: '#/components/schemas/RuleBuilderCondition' type: array - x-stream-index: "004" + x-stream-index: "003" cooldown_period: type: string - x-stream-index: "009" - enabled: - type: boolean - x-stream-index: "008" + x-stream-index: "007" groups: items: $ref: '#/components/schemas/RuleBuilderConditionGroup' type: array - x-stream-index: "006" + x-stream-index: "005" id: type: string x-stream-index: "001" logic: type: string - x-stream-index: "005" - name: - type: string - x-stream-index: "002" + x-stream-index: "004" rule_type: type: string - x-stream-index: "003" + x-stream-index: "002" required: - - id - - name - rule_type - action - - enabled type: object SFUIDLastSeen: properties: @@ -12383,6 +12588,9 @@ components: format: date-time type: number x-stream-index: "001.025" + deleted_for_me: + type: boolean + x-stream-index: "001.044" deleted_reply_count: format: int32 type: integer @@ -13081,18 +13289,23 @@ components: items: type: string type: array - x-stream-index: "004" + x-stream-index: "005" contains_url: type: boolean - x-stream-index: "002" + x-stream-index: "003" harm_labels: items: type: string type: array x-stream-index: "001" + llm_harm_labels: + additionalProperties: + type: string + type: object + x-stream-index: "002" severity: type: string - x-stream-index: "003" + x-stream-index: "004" type: object TextRuleParameters: properties: @@ -13100,18 +13313,23 @@ components: items: type: string type: array - x-stream-index: "006" + x-stream-index: "007" contains_url: type: boolean - x-stream-index: "004" + x-stream-index: "005" harm_labels: items: type: string type: array x-stream-index: "003" + llm_harm_labels: + additionalProperties: + type: string + type: object + x-stream-index: "004" severity: type: string - x-stream-index: "005" + x-stream-index: "006" threshold: format: int32 type: integer @@ -13119,9 +13337,6 @@ components: time_window: type: string x-stream-index: "002" - required: - - threshold - - time_window type: object ThreadParticipant: description: Represents a user that is participating in a thread. @@ -14541,7 +14756,7 @@ components: $ref: '#/components/schemas/AIImageConfig' description: Configuration for AI image analysis title: AI Image Config - x-stream-index: "010" + x-stream-index: "011" ai_text_config: $ref: '#/components/schemas/AITextConfig' description: Configuration for AI text analysis @@ -14551,7 +14766,7 @@ components: $ref: '#/components/schemas/AIVideoConfig' description: Configuration for AI video analysis title: AI Video Config - x-stream-index: "011" + x-stream-index: "012" async: description: Whether moderation should be performed asynchronously title: Async @@ -14574,7 +14789,7 @@ components: x-stream-index: "004" aws_rekognition_config: $ref: '#/components/schemas/AIImageConfig' - x-stream-index: "015" + x-stream-index: "016" block_list_config: $ref: '#/components/schemas/BlockListConfig' description: Configuration for block list filtering @@ -14582,23 +14797,28 @@ components: x-stream-index: "007" bodyguard_config: $ref: '#/components/schemas/AITextConfig' - x-stream-index: "014" + x-stream-index: "015" google_vision_config: $ref: '#/components/schemas/GoogleVisionConfig' description: Configuration for Google Vision integration title: Google Vision Config - x-stream-index: "009" + x-stream-index: "010" key: description: Unique identifier for the moderation configuration title: Key type: string x-stream-index: "001" + llm_config: + $ref: '#/components/schemas/LLMConfig' + description: Configuration for customer-configured LLM moderation + title: LLM Config + x-stream-index: "009" rule_builder_config: $ref: '#/components/schemas/RuleBuilderConfig' description: Configuration for custom rule builder (max 3 rules, max 5 conditions per rule) title: Rule Builder Config - x-stream-index: "013" + x-stream-index: "014" team: description: Team associated with the configuration maxLength: 128 @@ -14610,10 +14830,10 @@ components: $ref: '#/components/schemas/VelocityFilterConfig' description: Configuration for velocity-based filtering title: Velocity Filter Config - x-stream-index: "012" + x-stream-index: "013" video_call_rule_config: $ref: '#/components/schemas/VideoCallRuleConfig' - x-stream-index: "016" + x-stream-index: "017" required: - key type: object @@ -14821,6 +15041,15 @@ components: type: string x-stream-index: "001" type: object + UserCustomPropertyParameters: + properties: + operator: + type: string + x-stream-index: "002" + property_key: + type: string + x-stream-index: "001" + type: object UserDeactivatedEvent: properties: created_at: @@ -14881,6 +15110,84 @@ components: x-stream-event-doc-group: other x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent + UserMessagesDeletedEvent: + description: This event is sent when a user's message get deleted. The event + contains information about the user whose messages got deleted. + nullable: true + properties: + channel_custom: + additionalProperties: {} + type: object + x-stream-index: 001.001.005 + channel_id: + description: The ID of the channel where the target user's messages were + deleted + title: Channel ID + type: string + x-stream-index: 001.002.002 + channel_member_count: + format: int32 + type: integer + x-stream-index: 001.001.004 + channel_type: + description: The type of the channel where the target user's messages were + deleted + title: Channel Type + type: string + x-stream-index: 001.002.001 + cid: + description: The CID of the channel where the target user's messages were + deleted + 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: number + x-stream-index: 001.001.001.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 001.001.001.001.007 + hard_delete: + description: Whether Messages were hard deleted + title: Hard Delete + type: boolean + x-stream-index: "003" + received_at: + format: date-time + type: number + x-stream-index: 001.001.001.001.004 + team: + description: The team of the channel where the target user's messages were + deleted + title: Team + type: string + x-stream-index: 001.001.003 + type: + default: user.messages.deleted + description: 'The type of event: "user.messages.deleted" in this case' + title: Event Type + type: string + x-stream-index: 001.001.001.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The target user whose messages got deleted + title: User + x-stream-index: "002.001" + required: + - type + - created_at + - custom + - user + title: UserMessagesDeletedEvent + 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 UserMute: nullable: true properties: @@ -15659,9 +15966,6 @@ components: time_window: type: string x-stream-index: "002" - required: - - threshold - - time_window type: object VideoSettings: properties: @@ -15770,6 +16074,7 @@ components: reminder.created: '#/components/schemas/ReminderCreatedEvent' reminder.deleted: '#/components/schemas/ReminderDeletedEvent' reminder.updated: '#/components/schemas/ReminderUpdatedEvent' + user.messages.deleted: '#/components/schemas/UserMessagesDeletedEvent' user.updated: '#/components/schemas/UserUpdatedEvent' propertyName: type oneOf: @@ -15788,6 +16093,7 @@ components: - $ref: '#/components/schemas/ReminderDeletedEvent' - $ref: '#/components/schemas/ReminderNotificationEvent' - $ref: '#/components/schemas/ReminderUpdatedEvent' + - $ref: '#/components/schemas/UserMessagesDeletedEvent' - $ref: '#/components/schemas/UserUpdatedEvent' WSEvent: description: The discriminator object for all websocket events, it maps events' @@ -15856,6 +16162,7 @@ components: user.banned: '#/components/schemas/UserBannedEvent' user.deactivated: '#/components/schemas/UserDeactivatedEvent' user.deleted: '#/components/schemas/UserDeletedEvent' + user.messages.deleted: '#/components/schemas/UserMessagesDeletedEvent' user.muted: '#/components/schemas/UserMutedEvent' user.presence.changed: '#/components/schemas/UserPresenceChangedEvent' user.reactivated: '#/components/schemas/UserReactivatedEvent' @@ -15927,6 +16234,7 @@ components: - $ref: '#/components/schemas/UserBannedEvent' - $ref: '#/components/schemas/UserDeactivatedEvent' - $ref: '#/components/schemas/UserDeletedEvent' + - $ref: '#/components/schemas/UserMessagesDeletedEvent' - $ref: '#/components/schemas/UserMutedEvent' - $ref: '#/components/schemas/UserPresenceChangedEvent' - $ref: '#/components/schemas/UserReactivatedEvent' @@ -16022,7 +16330,7 @@ components: type: apiKey info: title: Stream API - version: v187.13.0 + version: v191.1.0 openapi: 3.0.3 paths: /api/v2/app: @@ -17606,6 +17914,14 @@ paths: type: string writeOnly: true x-stream-index: "003" + - in: query + name: delete_for_me + schema: + description: Delete the message only for the user making the request + title: Delete for me + type: boolean + writeOnly: true + x-stream-index: "004" responses: "200": content: diff --git a/openapi/v2/chat-serverside-api.json b/openapi/v2/chat-serverside-api.json index 614671f55..07b49ca66 100644 --- a/openapi/v2/chat-serverside-api.json +++ b/openapi/v2/chat-serverside-api.json @@ -1 +1 @@ -{"components":{"schemas":{"AIImageConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"ocr_rules":{"items":{"$ref":"#/components/schemas/OCRRule"},"type":"array","x-stream-index":"004"},"rules":{"items":{"$ref":"#/components/schemas/AWSRekognitionRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules","ocr_rules"],"type":"object"},"AITextConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"profile":{"type":"string","x-stream-index":"003"},"rules":{"items":{"$ref":"#/components/schemas/BodyguardRule"},"type":"array","x-stream-index":"004"},"severity_rules":{"items":{"$ref":"#/components/schemas/BodyguardSeverityRule"},"type":"array","x-stream-index":"005"}},"required":["enabled","profile","rules","severity_rules"],"type":"object"},"AIVideoConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AWSRekognitionRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"APIError":{"nullable":true,"properties":{"StatusCode":{"description":"Response HTTP status code","format":"int32","title":"Status code","type":"integer","x-stream-index":"004"},"code":{"description":"API error code","format":"int32","title":"Code","type":"integer","x-stream-index":"001"},"details":{"description":"Additional error-specific information","items":{"type":"integer"},"title":"Details","type":"array","x-stream-index":"007"},"duration":{"description":"Request duration","title":"Duration","type":"string","x-stream-index":"005"},"exception_fields":{"additionalProperties":{"type":"string"},"description":"Additional error info","title":"Exception fields","type":"object","x-stream-index":"003"},"message":{"description":"Message describing an error","title":"Message","type":"string","x-stream-index":"002"},"more_info":{"description":"URL with additional information","title":"More info","type":"string","x-stream-index":"006"},"unrecoverable":{"description":"Flag that indicates if the error is unrecoverable, requests that return unrecoverable errors should not be retried, this error only applies to the request that caused it","title":"Unrecoverable","type":"boolean","x-stream-index":"008"}},"required":["code","message","StatusCode","duration","more_info","details"],"title":"Error response","type":"object"},"APNConfig":{"properties":{"Disabled":{"type":"boolean","writeOnly":true,"x-stream-index":"005"},"auth_key":{"type":"string","x-stream-index":"006.001"},"auth_type":{"enum":["certificate","token"],"type":"string","x-stream-index":"001"},"bundle_id":{"type":"string","x-stream-index":"004"},"development":{"type":"boolean","x-stream-index":"002"},"host":{"type":"string","x-stream-index":"003"},"key_id":{"type":"string","x-stream-index":"006.002"},"notification_template":{"type":"string","x-stream-index":"008"},"p12_cert":{"type":"string","x-stream-index":"007.001"},"team_id":{"type":"string","x-stream-index":"006.003"}},"type":"object"},"APNConfigFields":{"properties":{"auth_key":{"type":"string","x-stream-index":"009"},"auth_type":{"type":"string","x-stream-index":"003"},"bundle_id":{"type":"string","x-stream-index":"006"},"development":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"host":{"type":"string","x-stream-index":"005"},"key_id":{"type":"string","x-stream-index":"008"},"notification_template":{"type":"string","x-stream-index":"004"},"p12_cert":{"type":"string","x-stream-index":"010"},"team_id":{"type":"string","x-stream-index":"007"}},"required":["enabled","development"],"type":"object"},"APNS":{"properties":{"body":{"type":"string","x-stream-index":"002"},"content-available":{"format":"int32","type":"integer","x-stream-index":"004"},"data":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"mutable-content":{"format":"int32","type":"integer","x-stream-index":"005"},"sound":{"type":"string","x-stream-index":"003"},"title":{"type":"string","x-stream-index":"001"}},"required":["title","body"],"type":"object"},"AWSRekognitionRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"},"min_confidence":{"format":"float","maximum":100,"minimum":0,"type":"number","x-stream-index":"003"}},"required":["label","action","min_confidence"],"type":"object"},"Action":{"nullable":true,"properties":{"name":{"type":"string","x-stream-index":"001"},"style":{"type":"string","x-stream-index":"003"},"text":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"004"},"value":{"type":"string","x-stream-index":"005"}},"required":["name","text","type"],"type":"object"},"ActionLog":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"002"},"reason":{"type":"string","x-stream-index":"008"},"reporter_type":{"type":"string","x-stream-index":"009"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"014"},"review_queue_item_id":{"type":"string","x-stream-index":"012"},"target_user":{"$ref":"#/components/schemas/User","x-stream-index":"013"},"target_user_id":{"type":"string","x-stream-index":"011"},"type":{"type":"string","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007"}},"required":["id","created_at","type","reason","reporter_type","custom","target_user_id","review_queue_item_id"],"type":"object"},"ActionLogResponse":{"nullable":true,"properties":{"created_at":{"description":"Timestamp when the action was taken","format":"date-time","title":"Created At","type":"number","x-stream-index":"002"},"custom":{"additionalProperties":{},"description":"Additional metadata about the action","title":"Custom","type":"object","x-stream-index":"007"},"id":{"description":"Unique identifier of the action log","title":"ID","type":"string","x-stream-index":"001"},"reason":{"description":"Reason for the moderation action","title":"Reason","type":"string","x-stream-index":"006"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"Associated review queue item","title":"Review Queue Item","x-stream-index":"008"},"target_user":{"$ref":"#/components/schemas/UserResponse","description":"User who was the target of the action","title":"Target User","x-stream-index":"009"},"target_user_id":{"description":"ID of the user who was the target of the action","title":"Target User ID","type":"string","x-stream-index":"010"},"type":{"description":"Type of moderation action","title":"Type","type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who performed the action","title":"User","x-stream-index":"004"},"user_id":{"description":"ID of the user who performed the action","title":"User ID","type":"string","x-stream-index":"005"}},"required":["id","created_at","type","user_id","reason","custom","target_user_id"],"type":"object"},"ActionSequence":{"properties":{"action":{"type":"string","x-stream-index":"001"},"blur":{"type":"boolean","x-stream-index":"005"},"cooldown_period":{"format":"int32","type":"integer","x-stream-index":"004"},"threshold":{"format":"int32","type":"integer","x-stream-index":"002"},"time_window":{"format":"int32","type":"integer","x-stream-index":"003"},"warning":{"type":"boolean","x-stream-index":"006"},"warning_text":{"type":"string","x-stream-index":"007"}},"required":["action","threshold","time_window","cooldown_period","blur","warning","warning_text"],"type":"object"},"ActivityMarkedEvent":{"properties":{"all_read":{"type":"boolean","x-stream-index":"006"},"all_seen":{"type":"boolean","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"feed_id":{"type":"string","x-stream-index":"003"},"marked_read":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"marked_watched":{"items":{"type":"string"},"type":"array","x-stream-index":"005"},"type":{"default":"activity.marked","type":"string","x-stream-index":"001.001"},"user_id":{"type":"string","x-stream-index":"002"}},"required":["type","created_at","user_id","feed_id","all_read","all_seen"],"title":"ActivityMarkedEvent","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"},"AnyEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"*","type":"string","x-stream-index":"001.001"}},"required":["type","created_at"],"title":"AnyEvent","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"},"AppResponseFields":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"019"},"async_url_enrich_enabled":{"type":"boolean","x-stream-index":"017"},"auto_translation_enabled":{"type":"boolean","x-stream-index":"020"},"before_message_send_hook_url":{"type":"string","x-stream-index":"021"},"call_types":{"additionalProperties":{"$ref":"#/components/schemas/CallType"},"type":"object","x-stream-index":"007"},"campaign_enabled":{"type":"boolean","x-stream-index":"034"},"cdn_expiration_seconds":{"format":"int32","type":"integer","x-stream-index":"037"},"channel_configs":{"additionalProperties":{"$ref":"#/components/schemas/ChannelConfig"},"type":"object","x-stream-index":"006"},"custom_action_handler_url":{"type":"string","x-stream-index":"022"},"datadog_info":{"$ref":"#/components/schemas/DataDogInfo","x-stream-index":"040"},"disable_auth_checks":{"type":"boolean","x-stream-index":"011"},"disable_permissions_checks":{"type":"boolean","x-stream-index":"012"},"enforce_unique_usernames":{"type":"string","x-stream-index":"023"},"event_hooks":{"items":{"$ref":"#/components/schemas/EventHook"},"type":"array","x-stream-index":"045"},"file_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","x-stream-index":"030"},"geofences":{"items":{"$ref":"#/components/schemas/GeofenceResponse"},"type":"array","x-stream-index":"039"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"033"},"guest_user_creation_disabled":{"type":"boolean","x-stream-index":"043"},"image_moderation_enabled":{"type":"boolean","x-stream-index":"016"},"image_moderation_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"018"},"image_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","x-stream-index":"031"},"moderation_bulk_submit_action_enabled":{"type":"boolean","x-stream-index":"048"},"moderation_dashboard_preferences":{"$ref":"#/components/schemas/ModerationDashboardPreferences","x-stream-index":"044"},"moderation_enabled":{"type":"boolean","x-stream-index":"041"},"moderation_multitenant_blocklist_enabled":{"type":"boolean","x-stream-index":"042"},"moderation_webhook_url":{"type":"string","x-stream-index":"005"},"multi_tenant_enabled":{"type":"boolean","x-stream-index":"015"},"name":{"type":"string","x-stream-index":"001"},"organization":{"type":"string","x-stream-index":"002"},"permission_version":{"type":"string","x-stream-index":"013"},"policies":{"additionalProperties":{"items":{"$ref":"#/components/schemas/Policy"},"type":"array"},"type":"object","x-stream-index":"008"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationFields","x-stream-index":"003"},"reminders_interval":{"format":"int32","type":"integer","x-stream-index":"036"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"032"},"sns_key":{"type":"string","x-stream-index":"028"},"sns_secret":{"type":"string","x-stream-index":"029"},"sns_topic_arn":{"type":"string","x-stream-index":"027"},"sqs_key":{"type":"string","x-stream-index":"025"},"sqs_secret":{"type":"string","x-stream-index":"026"},"sqs_url":{"type":"string","x-stream-index":"024"},"suspended":{"type":"boolean","x-stream-index":"009"},"suspended_explanation":{"type":"string","x-stream-index":"010"},"use_hook_v2":{"type":"boolean","x-stream-index":"046"},"user_response_time_enabled":{"type":"boolean","x-stream-index":"047"},"user_search_disallowed_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"014"},"webhook_events":{"items":{"type":"string"},"type":"array","x-stream-index":"035"},"webhook_url":{"type":"string","x-stream-index":"004"}},"required":["name","organization","push_notifications","webhook_url","moderation_webhook_url","channel_configs","call_types","policies","suspended","suspended_explanation","disable_auth_checks","disable_permissions_checks","permission_version","user_search_disallowed_roles","multi_tenant_enabled","image_moderation_enabled","async_url_enrich_enabled","auto_translation_enabled","custom_action_handler_url","enforce_unique_usernames","sqs_url","sqs_key","sqs_secret","sns_topic_arn","sns_key","sns_secret","file_upload_config","image_upload_config","grants","campaign_enabled","webhook_events","reminders_interval","cdn_expiration_seconds","video_provider","moderation_enabled","moderation_multitenant_blocklist_enabled","guest_user_creation_disabled","event_hooks","use_hook_v2","user_response_time_enabled","moderation_bulk_submit_action_enabled"],"type":"object"},"AsyncBulkImageModerationEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"003.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.007"},"finished_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.004"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"task_id":{"type":"string","x-stream-index":"002.001"},"type":{"default":"export.bulk_image_moderation.success","type":"string","x-stream-index":"003.002"},"url":{"type":"string","x-stream-index":"001"}},"required":["url","task_id","started_at","finished_at","type","created_at","custom"],"title":"AsyncBulkImageModerationEvent","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"},"AsyncExportChannelsEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"003.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.007"},"finished_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.004"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"task_id":{"type":"string","x-stream-index":"002.001"},"type":{"default":"export.channels.success","type":"string","x-stream-index":"003.002"},"url":{"type":"string","x-stream-index":"001"}},"required":["url","task_id","started_at","finished_at","type","created_at","custom"],"title":"AsyncExportChannelsEvent","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"},"AsyncExportErrorEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"003.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.007"},"error":{"type":"string","x-stream-index":"001"},"finished_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.004"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"task_id":{"type":"string","x-stream-index":"002.001"},"type":{"default":"export.moderation_logs.error","type":"string","x-stream-index":"003.002"}},"required":["error","task_id","started_at","finished_at","type","created_at","custom"],"title":"AsyncExportErrorEvent","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"},"AsyncExportModerationLogsEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"003.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.007"},"finished_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.004"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"task_id":{"type":"string","x-stream-index":"002.001"},"type":{"default":"export.moderation_logs.success","type":"string","x-stream-index":"003.002"},"url":{"type":"string","x-stream-index":"001"}},"required":["url","task_id","started_at","finished_at","type","created_at","custom"],"title":"AsyncExportModerationLogsEvent","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"},"AsyncExportUsersEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"003.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.007"},"finished_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.004"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"task_id":{"type":"string","x-stream-index":"002.001"},"type":{"default":"export.users.success","type":"string","x-stream-index":"003.002"},"url":{"type":"string","x-stream-index":"001"}},"required":["url","task_id","started_at","finished_at","type","created_at","custom"],"title":"AsyncExportUsersEvent","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"},"AsyncModerationCallbackConfig":{"properties":{"mode":{"enum":["CALLBACK_MODE_NONE","CALLBACK_MODE_REST","CALLBACK_MODE_TWIRP"],"type":"string","x-stream-index":"002"},"server_url":{"type":"string","x-stream-index":"001"}},"type":"object"},"AsyncModerationConfiguration":{"properties":{"callback":{"$ref":"#/components/schemas/AsyncModerationCallbackConfig","x-stream-index":"002"},"timeout_ms":{"format":"int32","type":"integer","x-stream-index":"001"}},"type":"object"},"Attachment":{"description":"An attachment is a message object that represents a file uploaded by a user.","nullable":true,"properties":{"actions":{"items":{"$ref":"#/components/schemas/Action"},"type":"array","x-stream-index":"015"},"asset_url":{"type":"string","x-stream-index":"017"},"author_icon":{"type":"string","x-stream-index":"007"},"author_link":{"type":"string","x-stream-index":"006"},"author_name":{"type":"string","x-stream-index":"005"},"color":{"type":"string","x-stream-index":"003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"018"},"fallback":{"type":"string","x-stream-index":"002"},"fields":{"items":{"$ref":"#/components/schemas/Field"},"type":"array","x-stream-index":"016"},"footer":{"type":"string","x-stream-index":"013"},"footer_icon":{"type":"string","x-stream-index":"014"},"giphy":{"$ref":"#/components/schemas/Images","x-stream-index":"019"},"image_url":{"type":"string","x-stream-index":"011"},"og_scrape_url":{"type":"string","x-stream-index":"020"},"original_height":{"format":"int32","type":"integer","x-stream-index":"022"},"original_width":{"format":"int32","type":"integer","x-stream-index":"021"},"pretext":{"type":"string","x-stream-index":"004"},"text":{"type":"string","x-stream-index":"010"},"thumb_url":{"type":"string","x-stream-index":"012"},"title":{"type":"string","x-stream-index":"008"},"title_link":{"type":"string","x-stream-index":"009"},"type":{"description":"Attachment type (e.g. image, video, url)","title":"Type","type":"string","x-stream-index":"001"}},"required":["custom"],"title":"Attachment","type":"object","x-stream-docs-page-id":"file_uploads"},"AudioSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"001"},"default_device":{"enum":["speaker","earpiece"],"type":"string","x-stream-index":"006"},"mic_default_on":{"type":"boolean","x-stream-index":"004"},"noise_cancellation":{"$ref":"#/components/schemas/NoiseCancellationSettings","x-stream-index":"007"},"opus_dtx_enabled":{"type":"boolean","x-stream-index":"002"},"redundant_coding_enabled":{"type":"boolean","x-stream-index":"003"},"speaker_default_on":{"type":"boolean","x-stream-index":"005"}},"required":["access_request_enabled","opus_dtx_enabled","redundant_coding_enabled","mic_default_on","speaker_default_on","default_device"],"type":"object"},"AudioSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"001"},"default_device":{"enum":["speaker","earpiece"],"type":"string","x-stream-index":"006"},"mic_default_on":{"type":"boolean","x-stream-index":"004"},"noise_cancellation":{"$ref":"#/components/schemas/NoiseCancellationSettings","x-stream-index":"007"},"opus_dtx_enabled":{"type":"boolean","x-stream-index":"002"},"redundant_coding_enabled":{"type":"boolean","x-stream-index":"003"},"speaker_default_on":{"type":"boolean","x-stream-index":"005"}},"required":["access_request_enabled","opus_dtx_enabled","redundant_coding_enabled","mic_default_on","speaker_default_on","default_device"],"type":"object"},"AutomodDetails":{"properties":{"action":{"type":"string","x-stream-index":"001"},"image_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"005"},"message_details":{"$ref":"#/components/schemas/FlagMessageDetails","x-stream-index":"004"},"original_message_type":{"type":"string","x-stream-index":"002"},"result":{"$ref":"#/components/schemas/MessageModerationResult","x-stream-index":"003"}},"type":"object"},"AutomodPlatformCircumventionConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AutomodRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"AutomodRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"003"},"label":{"type":"string","x-stream-index":"001"},"threshold":{"format":"float","maximum":1,"minimum":0,"type":"number","x-stream-index":"002"}},"required":["label","threshold","action"],"type":"object"},"AutomodSemanticFiltersConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AutomodSemanticFiltersRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"AutomodSemanticFiltersRule":{"properties":{"action":{"enum":["flag","shadow","remove"],"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"threshold":{"format":"float","maximum":1,"minimum":0,"type":"number","x-stream-index":"002"}},"required":["name","threshold","action"],"type":"object"},"AutomodToxicityConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AutomodRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"AzureRequest":{"description":"Config for creating Azure Blob Storage storage","properties":{"abs_account_name":{"description":"The account name","title":"AccountName","type":"string","x-stream-index":"001"},"abs_client_id":{"description":"The client id","title":"ClientID","type":"string","x-stream-index":"003"},"abs_client_secret":{"description":"The client secret","title":"ClientSecret","type":"string","x-stream-index":"004"},"abs_tenant_id":{"description":"The tenant id","title":"TenantID","type":"string","x-stream-index":"002"}},"required":["abs_account_name","abs_tenant_id","abs_client_id","abs_client_secret"],"title":"AzureRequest","type":"object"},"BackstageSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"BackstageSettingsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"Ban":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"012"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"011"},"expires":{"format":"date-time","type":"number","x-stream-index":"007"},"reason":{"type":"string","x-stream-index":"008"},"shadow":{"type":"boolean","x-stream-index":"009"},"target":{"$ref":"#/components/schemas/User","x-stream-index":"006"}},"required":["shadow","created_at"],"type":"object"},"BanActionRequest":{"properties":{"channel_ban_only":{"type":"boolean","x-stream-index":"003"},"delete_messages":{"enum":["soft","pruning","hard"],"type":"string","x-stream-index":"005"},"ip_ban":{"type":"boolean","x-stream-index":"004"},"reason":{"type":"string","x-stream-index":"002"},"shadow":{"type":"boolean","x-stream-index":"001"},"timeout":{"format":"int32","type":"integer","x-stream-index":"006"}},"type":"object"},"BanOptions":{"properties":{"duration":{"format":"int32","type":"integer","x-stream-index":"001"},"ip_ban":{"type":"boolean","x-stream-index":"004"},"reason":{"type":"string","x-stream-index":"002"},"shadow_ban":{"type":"boolean","x-stream-index":"003"}},"required":["duration","reason","shadow_ban","ip_ban"],"type":"object"},"BanRequest":{"nullable":true,"properties":{"banned_by":{"$ref":"#/components/schemas/UserRequest","description":"Details about the user performing the ban","title":"Banned By","x-stream-index":"008"},"banned_by_id":{"description":"ID of the user performing the ban","title":"Banned By ID","type":"string","x-stream-index":"007"},"channel_cid":{"description":"Channel where the ban applies","title":"Channel CID","type":"string","x-stream-index":"004"},"delete_messages":{"enum":["soft","pruning","hard"],"type":"string","x-stream-index":"009"},"ip_ban":{"description":"Whether to ban the user's IP address","title":"IP Ban","type":"boolean","x-stream-index":"006"},"reason":{"description":"Optional explanation for the ban","title":"Reason","type":"string","x-stream-index":"003"},"shadow":{"description":"Whether this is a shadow ban","title":"Shadow","type":"boolean","x-stream-index":"005"},"target_user_id":{"description":"ID of the user to ban","title":"Target User ID","type":"string","x-stream-index":"001"},"timeout":{"description":"Duration of the ban in minutes","minimum":0,"title":"Timeout","type":"integer","x-stream-index":"002"}},"required":["target_user_id"],"type":"object"},"BanResponse":{"nullable":true,"properties":{"banned_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"006"},"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"expires":{"format":"date-time","type":"number","x-stream-index":"003"},"reason":{"type":"string","x-stream-index":"004"},"shadow":{"type":"boolean","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"}},"required":["created_at"],"type":"object"},"BlockContentOptions":{"properties":{"reason":{"type":"string","x-stream-index":"001"}},"required":["reason"],"type":"object"},"BlockListConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/BlockListRule"},"maximum":10,"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"BlockListOptions":{"properties":{"behavior":{"description":"Blocklist behavior","enum":["flag","block","shadow_block"],"title":"Behavior","type":"string","x-stream-index":"002"},"blocklist":{"description":"Blocklist name","title":"Blocklist","type":"string","x-stream-index":"001"}},"required":["blocklist","behavior"],"type":"object"},"BlockListResponse":{"description":"Block list contains restricted words","properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001"},"id":{"type":"string","x-stream-index":"003"},"name":{"description":"Block list name","title":"Name","type":"string","x-stream-index":"004"},"team":{"type":"string","x-stream-index":"007"},"type":{"description":"Block list type.","title":"Type","type":"string","x-stream-index":"005"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"002"},"words":{"description":"List of words to block","items":{"type":"string"},"title":"Words","type":"array","x-stream-index":"006"}},"required":["name","type","words"],"title":"Block list","type":"object","x-stream-docs-page-id":"block_lists"},"BlockListRule":{"properties":{"action":{"enum":["flag","mask_flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"002"}},"required":["name","team","action"],"type":"object"},"BlockUsersRequest":{"nullable":true,"properties":{"blocked_user_id":{"description":"User id to block","title":"BlockedUserID","type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"required":["blocked_user_id"],"type":"object"},"BlockUsersResponse":{"nullable":true,"properties":{"blocked_by_user_id":{"description":"User id who blocked another user","title":"BlockedByUserID","type":"string","x-stream-index":"002"},"blocked_user_id":{"description":"User id who got blocked","title":"BlockedUserID","type":"string","x-stream-index":"003"},"created_at":{"description":"Timestamp when the user was blocked","format":"date-time","title":"CreatedAt","type":"number","x-stream-index":"004"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration","blocked_by_user_id","blocked_user_id","created_at"],"type":"object"},"BlockedUserResponse":{"nullable":true,"properties":{"blocked_user":{"$ref":"#/components/schemas/UserResponse","description":"User who got blocked","title":"User","x-stream-index":"003"},"blocked_user_id":{"description":"ID of the user who got blocked","title":"UserID","type":"string","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who blocked another user","title":"User","x-stream-index":"001"},"user_id":{"description":"ID of the user who blocked another user","title":"UserID","type":"string","x-stream-index":"002"}},"required":["user","user_id","blocked_user","blocked_user_id","created_at"],"type":"object"},"BodyguardRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"},"severity_rules":{"items":{"$ref":"#/components/schemas/BodyguardSeverityRule"},"type":"array","x-stream-index":"003"}},"required":["label","action","severity_rules"],"type":"object"},"BodyguardSeverityRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"severity":{"enum":["low","medium","high","critical"],"type":"string","x-stream-index":"001"}},"required":["severity","action"],"type":"object"},"BroadcastSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettings","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettings","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"BroadcastSettingsResponse":{"description":"BroadcastSettingsResponse is the payload for broadcasting settings","properties":{"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettingsResponse","title":"HLS","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettingsResponse","title":"RTMP","x-stream-index":"003"}},"required":["enabled","hls","rtmp"],"title":"BroadcastSettingsResponse","type":"object"},"BulkImageModerationRequest":{"nullable":true,"properties":{"csv_file":{"description":"URL to CSV file containing image URLs to moderate","title":"string","type":"string","x-stream-index":"001"}},"required":["csv_file"],"type":"object"},"BulkImageModerationResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"task_id":{"description":"ID of the task for processing the bulk image moderation","title":"string","type":"string","x-stream-index":"001"}},"required":["task_id","duration"],"type":"object"},"Call":{"properties":{"AppPK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"002"},"Backstage":{"type":"boolean","writeOnly":true,"x-stream-index":"023"},"BlockedUserIDs":{"items":{"type":"string"},"type":"array","writeOnly":true,"x-stream-index":"018"},"BlockedUsers":{"items":{"$ref":"#/components/schemas/User"},"type":"array","writeOnly":true,"x-stream-index":"019"},"CID":{"type":"string","writeOnly":true,"x-stream-index":"005"},"CallType":{"$ref":"#/components/schemas/CallType","x-stream-index":"020"},"ChannelCID":{"type":"string","writeOnly":true,"x-stream-index":"032"},"CreatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"013"},"CreatedBy":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"CreatedByUserID":{"type":"string","writeOnly":true,"x-stream-index":"007"},"CurrentSessionID":{"type":"string","writeOnly":true,"x-stream-index":"024"},"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"012"},"DeletedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"028"},"EgressUpdatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"027"},"Egresses":{"items":{"$ref":"#/components/schemas/CallEgress"},"type":"array","writeOnly":true,"x-stream-index":"015"},"EndedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"017"},"ID":{"type":"string","writeOnly":true,"x-stream-index":"004"},"JoinAheadTimeSeconds":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"031"},"LastHeartbeatAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"030"},"LastSessionID":{"type":"string","writeOnly":true,"x-stream-index":"025"},"MemberCount":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"010"},"MemberLookup":{"$ref":"#/components/schemas/MemberLookup","x-stream-index":"011"},"Members":{"items":{"$ref":"#/components/schemas/CallMember"},"type":"array","writeOnly":true,"x-stream-index":"009"},"Session":{"$ref":"#/components/schemas/CallSession","x-stream-index":"026"},"Settings":{"$ref":"#/components/schemas/CallSettings","x-stream-index":"022"},"SettingsOverrides":{"$ref":"#/components/schemas/CallSettings","x-stream-index":"021"},"StartsAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"016"},"Team":{"type":"string","writeOnly":true,"x-stream-index":"006"},"ThumbnailURL":{"type":"string","writeOnly":true,"x-stream-index":"029"},"Type":{"type":"string","writeOnly":true,"x-stream-index":"003"},"UpdatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"014"}},"required":["AppPK","Type","ID","CID","Team","CreatedByUserID","Members","Custom","CreatedAt","UpdatedAt","Egresses","BlockedUserIDs","BlockedUsers","Backstage","CurrentSessionID","LastSessionID","ThumbnailURL","ChannelCID"],"type":"object"},"CallEgress":{"nullable":true,"properties":{"app_pk":{"format":"int32","type":"integer","x-stream-index":"002"},"call_id":{"type":"string","x-stream-index":"004"},"call_type":{"type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/EgressTaskConfig","x-stream-index":"007"},"egress_id":{"type":"string","x-stream-index":"005"},"egress_type":{"type":"string","x-stream-index":"006"},"instance_ip":{"type":"string","x-stream-index":"008"},"started_at":{"format":"date-time","type":"number","x-stream-index":"010"},"state":{"type":"string","x-stream-index":"009"},"stopped_at":{"format":"date-time","type":"number","x-stream-index":"011"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"012"}},"required":["app_pk","call_type","call_id","egress_id","egress_type","instance_ip","state","started_at","updated_at"],"type":"object"},"CallIngressResponse":{"description":"CallIngressResponse is the payload for ingress settings","properties":{"rtmp":{"$ref":"#/components/schemas/RTMPIngress","title":"RTMP","x-stream-index":"001"}},"required":["rtmp"],"title":"CallIngressResponse","type":"object"},"CallMember":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"010"},"role":{"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["user_id","role","custom","created_at","updated_at"],"type":"object"},"CallParticipant":{"nullable":true,"properties":{"JoinedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"004"},"Role":{"type":"string","writeOnly":true,"x-stream-index":"002"},"UserSessionID":{"type":"string","writeOnly":true,"x-stream-index":"003"},"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"001.046"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"001.017"},"banned":{"type":"boolean","x-stream-index":"001.016"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.013"},"id":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"001.023"},"language":{"type":"string","x-stream-index":"001.035"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"001.022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"001.026"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.042"},"role":{"type":"string","x-stream-index":"001.004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.005"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.009"}},"required":["id","role","teams_role","custom","banned","online","Role","UserSessionID","JoinedAt"],"type":"object"},"CallParticipantResponse":{"properties":{"joined_at":{"format":"date-time","type":"number","x-stream-index":"004"},"role":{"type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"},"user_session_id":{"type":"string","x-stream-index":"002"}},"required":["user","user_session_id","role","joined_at"],"type":"object"},"CallResponse":{"description":"Represents a call","properties":{"backstage":{"type":"boolean","x-stream-index":"016"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"018"},"captioning":{"type":"boolean","x-stream-index":"013"},"channel_cid":{"type":"string","x-stream-index":"024"},"cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"The user that created the call","title":"Created By","x-stream-index":"007"},"current_session_id":{"type":"string","x-stream-index":"005"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"008"},"egress":{"$ref":"#/components/schemas/EgressResponse","x-stream-index":"021"},"ended_at":{"description":"Date/time when the call ended","format":"date-time","title":"Ended At","type":"number","x-stream-index":"014"},"id":{"description":"Call ID","title":"ID","type":"string","x-stream-index":"003"},"ingress":{"$ref":"#/components/schemas/CallIngressResponse","x-stream-index":"019"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"023"},"recording":{"type":"boolean","x-stream-index":"011"},"session":{"$ref":"#/components/schemas/CallSessionResponse","x-stream-index":"020"},"settings":{"$ref":"#/components/schemas/CallSettingsResponse","x-stream-index":"017"},"starts_at":{"description":"Date/time when the call will start","format":"date-time","title":"Starts At","type":"number","x-stream-index":"015"},"team":{"type":"string","x-stream-index":"006"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailResponse","x-stream-index":"022"},"transcribing":{"type":"boolean","x-stream-index":"012"},"type":{"description":"The type of call","title":"Type","type":"string","x-stream-index":"002"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"}},"required":["type","id","cid","current_session_id","created_by","custom","created_at","updated_at","recording","transcribing","captioning","backstage","settings","blocked_user_ids","ingress","egress"],"title":"CallResponse","type":"object"},"CallSession":{"properties":{"AcceptedBy":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","writeOnly":true,"x-stream-index":"008"},"ActiveSFUs":{"items":{"$ref":"#/components/schemas/SFUIDLastSeen"},"type":"array","writeOnly":true,"x-stream-index":"016"},"AnonymousParticipantCount":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"019"},"AppPK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"002.001"},"CallID":{"type":"string","writeOnly":true,"x-stream-index":"002.003"},"CallType":{"type":"string","writeOnly":true,"x-stream-index":"002.002"},"CreatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"003"},"DeletedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"004"},"EndedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"006"},"LiveEndedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"013"},"LiveStartedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"012"},"MissedBy":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","writeOnly":true,"x-stream-index":"010"},"Participants":{"items":{"$ref":"#/components/schemas/CallParticipant"},"type":"array","writeOnly":true,"x-stream-index":"011"},"ParticipantsCountByRole":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","writeOnly":true,"x-stream-index":"018"},"RejectedBy":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","writeOnly":true,"x-stream-index":"009"},"RingAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"007"},"SFUIDs":{"items":{"type":"string"},"type":"array","writeOnly":true,"x-stream-index":"015"},"SessionID":{"type":"string","writeOnly":true,"x-stream-index":"002.004"},"StartedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"005"},"TimerEndsAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"014"},"UserPermissionOverrides":{"additionalProperties":{"additionalProperties":{"type":"boolean"},"type":"object"},"type":"object","writeOnly":true,"x-stream-index":"017"}},"required":["AppPK","CallType","CallID","SessionID","CreatedAt","AcceptedBy","RejectedBy","MissedBy","Participants","SFUIDs","ActiveSFUs","UserPermissionOverrides","ParticipantsCountByRole","AnonymousParticipantCount"],"type":"object"},"CallSessionResponse":{"properties":{"accepted_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"008"},"anonymous_participant_count":{"format":"int32","type":"integer","x-stream-index":"006"},"ended_at":{"format":"date-time","type":"number","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"live_ended_at":{"format":"date-time","type":"number","x-stream-index":"011"},"live_started_at":{"format":"date-time","type":"number","x-stream-index":"010"},"missed_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"009"},"participants":{"items":{"$ref":"#/components/schemas/CallParticipantResponse"},"type":"array","x-stream-index":"004"},"participants_count_by_role":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"005"},"rejected_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"007"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002"},"timer_ends_at":{"format":"date-time","type":"number","x-stream-index":"012"}},"required":["id","participants","participants_count_by_role","anonymous_participant_count","rejected_by","accepted_by","missed_by"],"type":"object"},"CallSettings":{"properties":{"audio":{"$ref":"#/components/schemas/AudioSettings","x-stream-index":"001"},"backstage":{"$ref":"#/components/schemas/BackstageSettings","x-stream-index":"002"},"broadcasting":{"$ref":"#/components/schemas/BroadcastSettings","x-stream-index":"007"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordSettings","x-stream-index":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettings","x-stream-index":"008"},"ingress":{"$ref":"#/components/schemas/IngressSettings","x-stream-index":"014"},"limits":{"$ref":"#/components/schemas/LimitsSettings","x-stream-index":"012"},"recording":{"$ref":"#/components/schemas/RecordSettings","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettings","x-stream-index":"010"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettings","x-stream-index":"004"},"session":{"$ref":"#/components/schemas/SessionSettings","x-stream-index":"013"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettings","x-stream-index":"011"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettings","x-stream-index":"009"},"video":{"$ref":"#/components/schemas/VideoSettings","x-stream-index":"003"}},"type":"object"},"CallSettingsResponse":{"properties":{"audio":{"$ref":"#/components/schemas/AudioSettingsResponse","x-stream-index":"001"},"backstage":{"$ref":"#/components/schemas/BackstageSettingsResponse","x-stream-index":"002"},"broadcasting":{"$ref":"#/components/schemas/BroadcastSettingsResponse","x-stream-index":"003"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordingSettingsResponse","x-stream-index":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettingsResponse","x-stream-index":"004"},"ingress":{"$ref":"#/components/schemas/IngressSettingsResponse","x-stream-index":"014"},"limits":{"$ref":"#/components/schemas/LimitsSettingsResponse","x-stream-index":"012"},"recording":{"$ref":"#/components/schemas/RecordSettingsResponse","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettingsResponse","x-stream-index":"007"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettingsResponse","x-stream-index":"008"},"session":{"$ref":"#/components/schemas/SessionSettingsResponse","x-stream-index":"013"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettingsResponse","x-stream-index":"011"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettingsResponse","x-stream-index":"009"},"video":{"$ref":"#/components/schemas/VideoSettingsResponse","x-stream-index":"010"}},"required":["audio","backstage","broadcasting","geofencing","recording","frame_recording","ring","screensharing","transcription","video","thumbnails","limits","session"],"type":"object"},"CallType":{"nullable":true,"properties":{"AppPK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"003"},"CreatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"005"},"ExternalStorage":{"type":"string","writeOnly":true,"x-stream-index":"009"},"Name":{"type":"string","writeOnly":true,"x-stream-index":"004"},"NotificationSettings":{"$ref":"#/components/schemas/NotificationSettings","x-stream-index":"008"},"PK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"002"},"Settings":{"$ref":"#/components/schemas/CallSettings","x-stream-index":"007"},"UpdatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"006"}},"required":["PK","AppPK","Name","CreatedAt","UpdatedAt","ExternalStorage"],"type":"object"},"CampaignChannelTemplate":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"002"},"members":{"items":{"type":"string"},"maximum":1000,"type":"array","x-stream-index":"003"},"team":{"maxLength":1000,"type":"string","x-stream-index":"004"},"type":{"maxLength":64,"type":"string","x-stream-index":"001"}},"required":["type","custom"],"type":"object"},"CampaignCompletedEvent":{"nullable":true,"properties":{"campaign":{"$ref":"#/components/schemas/CampaignResponse","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"type":{"default":"campaign.completed","type":"string","x-stream-index":"001.002"}},"required":["type","created_at","custom"],"title":"CampaignCompletedEvent","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"},"CampaignMessageTemplate":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"maximum":30,"type":"array","x-stream-index":"002"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"poll_id":{"type":"string","x-stream-index":"003"},"text":{"type":"string","x-stream-index":"001"}},"required":["text","attachments","poll_id","custom"],"type":"object"},"CampaignResponse":{"properties":{"channel_template":{"$ref":"#/components/schemas/CampaignChannelTemplate","x-stream-index":"016"},"create_channels":{"type":"boolean","x-stream-index":"008"},"created_at":{"format":"date-time","type":"number","x-stream-index":"020"},"description":{"type":"string","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"001"},"message_template":{"$ref":"#/components/schemas/CampaignMessageTemplate","x-stream-index":"015"},"name":{"type":"string","x-stream-index":"007"},"scheduled_for":{"format":"date-time","type":"number","x-stream-index":"013"},"segment_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"002"},"segments":{"items":{"$ref":"#/components/schemas/Segment"},"type":"array","x-stream-index":"003"},"sender":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"005"},"sender_id":{"type":"string","x-stream-index":"004"},"sender_mode":{"type":"string","x-stream-index":"006"},"show_channels":{"type":"boolean","x-stream-index":"009"},"skip_push":{"type":"boolean","x-stream-index":"011"},"skip_webhook":{"type":"boolean","x-stream-index":"012"},"stats":{"$ref":"#/components/schemas/CampaignStatsResponse","x-stream-index":"022"},"status":{"type":"string","x-stream-index":"019"},"stop_at":{"format":"date-time","type":"number","x-stream-index":"014"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"021"},"user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"017"},"users":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"018"}},"required":["id","segment_ids","segments","sender_id","sender_mode","name","create_channels","show_channels","description","skip_push","skip_webhook","user_ids","users","status","created_at","updated_at","stats"],"type":"object"},"CampaignStartedEvent":{"nullable":true,"properties":{"campaign":{"$ref":"#/components/schemas/CampaignResponse","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"type":{"default":"campaign.started","type":"string","x-stream-index":"001.002"}},"required":["type","created_at","custom"],"title":"CampaignStartedEvent","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"},"CampaignStatsResponse":{"properties":{"progress":{"format":"float","type":"number","x-stream-index":"005"},"stats_channels_created":{"format":"int32","type":"integer","x-stream-index":"004"},"stats_completed_at":{"format":"date-time","type":"number","x-stream-index":"002"},"stats_messages_sent":{"format":"int32","type":"integer","x-stream-index":"003"},"stats_started_at":{"format":"date-time","type":"number","x-stream-index":"001"},"stats_users_read":{"format":"int32","type":"integer","x-stream-index":"007"},"stats_users_sent":{"format":"int32","type":"integer","x-stream-index":"006"}},"required":["stats_started_at","stats_completed_at","stats_messages_sent","stats_channels_created","progress","stats_users_sent","stats_users_read"],"type":"object"},"CastPollVoteRequest":{"nullable":true,"properties":{"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"005.002"},"user_id":{"type":"string","x-stream-index":"005.001"},"vote":{"$ref":"#/components/schemas/VoteData","description":"Vote data","title":"VoteData","x-stream-index":"004"}},"type":"object"},"Channel":{"properties":{"active_live_locations":{"items":{"$ref":"#/components/schemas/SharedLocation"},"type":"array","x-stream-index":"034"},"auto_translation_enabled":{"type":"boolean","x-stream-index":"029"},"auto_translation_language":{"type":"string","x-stream-index":"030"},"cid":{"type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/ChannelConfig","x-stream-index":"026"},"config_overrides":{"$ref":"#/components/schemas/ConfigOverrides","x-stream-index":"027"},"cooldown":{"format":"int32","type":"integer","x-stream-index":"031"},"created_at":{"format":"date-time","type":"number","x-stream-index":"009"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"019"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"disabled":{"type":"boolean","x-stream-index":"017"},"frozen":{"type":"boolean","x-stream-index":"016"},"id":{"type":"string","x-stream-index":"004"},"invites":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"022"},"last_campaigns":{"type":"string","x-stream-index":"032"},"last_message_at":{"format":"date-time","type":"number","x-stream-index":"006"},"member_count":{"format":"int32","type":"integer","x-stream-index":"021"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"020"},"team":{"type":"string","x-stream-index":"028"},"truncated_by":{"$ref":"#/components/schemas/User","x-stream-index":"015"},"type":{"type":"string","x-stream-index":"005"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"010"}},"required":["cid","id","type","created_at","updated_at","frozen","disabled","custom","auto_translation_language"],"type":"object"},"ChannelConfig":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.026"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.021"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.022"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.027"},"blocklist":{"type":"string","x-stream-index":"001.023"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.024"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.025"},"commands":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"connect_events":{"type":"boolean","x-stream-index":"001.004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"custom_events":{"type":"boolean","x-stream-index":"001.012"},"mark_messages_pending":{"type":"boolean","x-stream-index":"001.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"001.020"},"mutes":{"type":"boolean","x-stream-index":"001.009"},"name":{"type":"string","x-stream-index":"001.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"001.028"},"partition_ttl":{"type":"integer","x-stream-index":"001.029"},"polls":{"type":"boolean","x-stream-index":"001.016"},"push_notifications":{"type":"boolean","x-stream-index":"001.013"},"quotes":{"type":"boolean","x-stream-index":"001.008"},"reactions":{"type":"boolean","x-stream-index":"001.006"},"read_events":{"type":"boolean","x-stream-index":"001.003"},"reminders":{"type":"boolean","x-stream-index":"001.014"},"replies":{"type":"boolean","x-stream-index":"001.007"},"search":{"type":"boolean","x-stream-index":"001.005"},"shared_locations":{"type":"boolean","x-stream-index":"001.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.030"},"typing_events":{"type":"boolean","x-stream-index":"001.002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"002.004"},"uploads":{"type":"boolean","x-stream-index":"001.010"},"url_enrichment":{"type":"boolean","x-stream-index":"001.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"001.017"}},"required":["name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","created_at","updated_at","commands"],"type":"object"},"ChannelConfigWithInfo":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.002.026"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.002.021"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.022"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.002.027"},"blocklist":{"type":"string","x-stream-index":"001.002.023"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.024"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.002.025"},"commands":{"items":{"$ref":"#/components/schemas/Command"},"type":"array","x-stream-index":"001.003"},"connect_events":{"type":"boolean","x-stream-index":"001.002.004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.001.003"},"custom_events":{"type":"boolean","x-stream-index":"001.002.012"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"002"},"mark_messages_pending":{"type":"boolean","x-stream-index":"001.002.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"001.002.020"},"mutes":{"type":"boolean","x-stream-index":"001.002.009"},"name":{"type":"string","x-stream-index":"001.002.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"001.002.028"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"001.002.029"},"polls":{"type":"boolean","x-stream-index":"001.002.016"},"push_notifications":{"type":"boolean","x-stream-index":"001.002.013"},"quotes":{"type":"boolean","x-stream-index":"001.002.008"},"reactions":{"type":"boolean","x-stream-index":"001.002.006"},"read_events":{"type":"boolean","x-stream-index":"001.002.003"},"reminders":{"type":"boolean","x-stream-index":"001.002.014"},"replies":{"type":"boolean","x-stream-index":"001.002.007"},"search":{"type":"boolean","x-stream-index":"001.002.005"},"shared_locations":{"type":"boolean","x-stream-index":"001.002.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.002.030"},"typing_events":{"type":"boolean","x-stream-index":"001.002.002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"uploads":{"type":"boolean","x-stream-index":"001.002.010"},"url_enrichment":{"type":"boolean","x-stream-index":"001.002.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"001.002.017"}},"required":["created_at","updated_at","name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","commands"],"type":"object"},"ChannelCreatedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"channel.created","type":"string","x-stream-index":"001.001"}},"required":["type","created_at"],"title":"ChannelCreatedEvent","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"},"ChannelDeletedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003.004"},"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"003.005"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"team":{"type":"string","x-stream-index":"001.001"},"type":{"default":"channel.deleted","type":"string","x-stream-index":"002.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"ChannelDeletedEvent","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"},"ChannelExport":{"properties":{"cid":{"type":"string","x-stream-index":"003"},"id":{"description":"Channel ID","title":"ID","type":"string","x-stream-index":"002"},"messages_since":{"description":"Date to export messages since","format":"date-time","title":"Messages since","type":"number","x-stream-index":"004"},"messages_until":{"description":"Date to export messages until","format":"date-time","title":"Messages until","type":"number","x-stream-index":"005"},"type":{"description":"Channel type","title":"Type","type":"string","x-stream-index":"001"}},"title":"Channel Export","type":"object"},"ChannelFrozenEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"channel.frozen","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"ChannelFrozenEvent","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"},"ChannelGetOrCreateRequest":{"nullable":true,"properties":{"data":{"$ref":"#/components/schemas/ChannelInput","x-stream-index":"003"},"hide_for_creator":{"description":"Whether this channel will be hidden for the user who created the channel or not","title":"Hide for creator","type":"boolean","x-stream-index":"007"},"members":{"$ref":"#/components/schemas/PaginationParams","x-stream-index":"010"},"messages":{"$ref":"#/components/schemas/MessagePaginationParams","x-stream-index":"009"},"state":{"description":"Refresh channel state","title":"State","type":"boolean","x-stream-index":"005"},"thread_unread_counts":{"type":"boolean","x-stream-index":"008"},"watchers":{"$ref":"#/components/schemas/PaginationParams","x-stream-index":"011"}},"type":"object"},"ChannelHiddenEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003.004"},"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"003.005"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"clear_history":{"type":"boolean","x-stream-index":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"type":{"default":"channel.hidden","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["clear_history","cid","channel_id","channel_type","channel_member_count","type","created_at"],"title":"ChannelHiddenEvent","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"},"ChannelInput":{"properties":{"auto_translation_enabled":{"description":"Enable or disable auto translation","title":"Auto translation","type":"boolean","x-stream-index":"005"},"auto_translation_language":{"description":"Switch auto translation language","title":"Auto translation language","type":"string","x-stream-index":"006"},"config_overrides":{"$ref":"#/components/schemas/ChannelConfig","x-stream-index":"024"},"created_by":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"009"},"created_by_id":{"type":"string","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"015"},"disabled":{"type":"boolean","x-stream-index":"014"},"frozen":{"description":"Freeze or unfreeze the channel","title":"Frozen","type":"boolean","x-stream-index":"013"},"invites":{"items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"type":"array","x-stream-index":"016"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"type":"array","x-stream-index":"018"},"team":{"description":"Team the channel belongs to (if multi-tenant mode is enabled)","title":"Team","type":"string","x-stream-index":"004"},"truncated_by_id":{"type":"string","x-stream-index":"010"}},"type":"object"},"ChannelMember":{"nullable":true,"properties":{"archived_at":{"format":"date-time","type":"number","x-stream-index":"015"},"ban_expires":{"description":"Expiration date of the ban","format":"date-time","title":"Ban expires","type":"number","x-stream-index":"013"},"banned":{"description":"Whether member is banned this channel or not","title":"Banned","type":"boolean","x-stream-index":"012"},"channel_role":{"description":"Role of the member in the channel","title":"Channel Role","type":"string","x-stream-index":"018"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"invite_accepted_at":{"description":"Date when invite was accepted","format":"date-time","title":"Invited accepted at","type":"number","x-stream-index":"006"},"invite_rejected_at":{"description":"Date when invite was rejected","format":"date-time","title":"Invited rejected at","type":"number","x-stream-index":"007"},"invited":{"description":"Whether member was invited or not","title":"Invited","type":"boolean","x-stream-index":"005"},"is_moderator":{"description":"Whether member is channel moderator or not","title":"Is moderator","type":"boolean","x-stream-index":"003"},"notifications_muted":{"type":"boolean","x-stream-index":"019"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"016"},"role":{"description":"Permission level of the member in the channel (DEPRECATED: use channel_role instead)","enum":["member","moderator","admin","owner"],"title":"Role","type":"string","x-stream-index":"017"},"shadow_banned":{"description":"Whether member is shadow banned in this channel or not","title":"Shadow banned","type":"boolean","x-stream-index":"014"},"status":{"type":"string","x-stream-index":"008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"},"user_id":{"title":"User ID","type":"string","x-stream-index":"001"}},"required":["custom","created_at","updated_at","banned","shadow_banned","channel_role","notifications_muted"],"title":"Channel member","type":"object"},"ChannelMemberResponse":{"nullable":true,"properties":{"archived_at":{"format":"date-time","type":"number","x-stream-index":"016"},"ban_expires":{"description":"Expiration date of the ban","format":"date-time","title":"Ban expires","type":"number","x-stream-index":"013"},"banned":{"description":"Whether member is banned this channel or not","title":"Banned","type":"boolean","x-stream-index":"012"},"channel_role":{"description":"Role of the member in the channel","title":"Channel Role","type":"string","x-stream-index":"018"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"invite_accepted_at":{"description":"Date when invite was accepted","format":"date-time","title":"Invited accepted at","type":"number","x-stream-index":"006"},"invite_rejected_at":{"description":"Date when invite was rejected","format":"date-time","title":"Invited rejected at","type":"number","x-stream-index":"007"},"invited":{"description":"Whether member was invited or not","title":"Invited","type":"boolean","x-stream-index":"005"},"is_moderator":{"description":"Whether member is channel moderator or not","title":"Is moderator","type":"boolean","x-stream-index":"003"},"notifications_muted":{"type":"boolean","x-stream-index":"019"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"015"},"role":{"description":"Permission level of the member in the channel (DEPRECATED: use channel_role instead)","enum":["member","moderator","admin","owner"],"title":"Role","type":"string","x-stream-index":"017"},"shadow_banned":{"description":"Whether member is shadow banned in this channel or not","title":"Shadow banned","type":"boolean","x-stream-index":"014"},"status":{"type":"string","x-stream-index":"008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"},"user_id":{"title":"User ID","type":"string","x-stream-index":"001"}},"required":["custom","created_at","updated_at","banned","shadow_banned","channel_role","notifications_muted"],"title":"Channel member","type":"object"},"ChannelMessages":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001"},"messages":{"items":{"$ref":"#/components/schemas/Message"},"type":"array","x-stream-index":"002"}},"required":["messages"],"type":"object"},"ChannelMute":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel that is muted","title":"Channel","x-stream-index":"002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"004"},"expires":{"description":"Date/time of mute expiration","format":"date-time","title":"Expires","type":"number","x-stream-index":"003"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Owner of channel mute","title":"User","x-stream-index":"001"}},"required":["created_at","updated_at"],"type":"object"},"ChannelMutedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"channel.muted","type":"string","x-stream-index":"001.001"}},"required":["type","created_at"],"title":"ChannelMutedEvent","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"},"ChannelOwnCapability":{"description":"All possibility of string to use","enum":["ban-channel-members","cast-poll-vote","connect-events","create-attachment","delete-any-message","delete-channel","delete-own-message","flag-message","freeze-channel","join-channel","leave-channel","mute-channel","pin-message","query-poll-votes","quote-message","read-events","search-messages","send-custom-events","send-links","send-message","send-poll","send-reaction","send-reply","send-restricted-visibility-message","send-typing-events","set-channel-cooldown","share-location","skip-slow-mode","slow-mode","typing-events","update-any-message","update-channel","update-channel-members","update-own-message","update-thread","upload-file"],"title":"ChannelOwnCapability","type":"string"},"ChannelPushPreferences":{"properties":{"chat_level":{"type":"string","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"number","x-stream-index":"002"}},"type":"object"},"ChannelResponse":{"description":"Represents channel in chat","properties":{"auto_translation_enabled":{"description":"Whether auto translation is enabled or not","title":"Auto translation","type":"boolean","x-stream-index":"017"},"auto_translation_language":{"description":"Language to translate to when auto translation is active","title":"Auto translation language","type":"string","x-stream-index":"018"},"blocked":{"description":"Whether this channel is blocked by current user or not","title":"Blocked","type":"boolean","x-stream-index":"023"},"cid":{"description":"Channel CID (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/ChannelConfigWithInfo","description":"Channel configuration","title":"ChannelConfigWithInfo","x-stream-index":"013"},"cooldown":{"description":"Cooldown period after sending each message","format":"int32","title":"Cooldown","type":"integer","x-stream-index":"020"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"005"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"Creator of the channel","title":"UserResponse","x-stream-index":"008"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"026"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"007"},"disabled":{"type":"boolean","x-stream-index":"010"},"frozen":{"description":"Whether channel is frozen or not","title":"Frozen","type":"boolean","x-stream-index":"009"},"hidden":{"description":"Whether this channel is hidden by current user or not","title":"Hidden","type":"boolean","x-stream-index":"022"},"hide_messages_before":{"description":"Date since when the message history is accessible","format":"date-time","title":"Hide messages before","type":"number","x-stream-index":"019"},"id":{"description":"Channel unique ID","title":"ID","type":"string","x-stream-index":"001"},"last_message_at":{"description":"Date of the last message sent","format":"date-time","title":"Last message at","type":"number","x-stream-index":"004"},"member_count":{"description":"Number of members in the channel","format":"int32","title":"Member count","type":"integer","x-stream-index":"012"},"members":{"description":"List of channel members (max 100)","items":{"$ref":"#/components/schemas/ChannelMember"},"title":"ChannelMembers","type":"array","x-stream-index":"011"},"mute_expires_at":{"description":"Date of mute expiration","format":"date-time","title":"Mute expires at","type":"number","x-stream-index":"015"},"muted":{"description":"Whether this channel is muted or not","title":"Muted","type":"boolean","x-stream-index":"014"},"own_capabilities":{"description":"List of channel capabilities of authenticated user","items":{"$ref":"#/components/schemas/ChannelOwnCapability"},"title":"ChannelOwnCapability","type":"array","x-stream-index":"021"},"team":{"description":"Team the channel belongs to (multi-tenant only)","title":"Team","type":"string","x-stream-index":"016"},"truncated_at":{"description":"Date of the latest truncation of the channel","format":"date-time","title":"UserResponse","type":"number","x-stream-index":"024"},"truncated_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"025"},"type":{"description":"Type of the channel","title":"Type","type":"string","x-stream-docs-page-id":"channel_features","x-stream-index":"002"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"006"}},"required":["id","type","cid","created_at","updated_at","frozen","disabled","custom"],"title":"Channel","type":"object"},"ChannelStateResponse":{"nullable":true,"properties":{"active_live_locations":{"items":{"$ref":"#/components/schemas/SharedLocationResponseData"},"type":"array","x-stream-index":"001.015"},"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001.001"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001.014"},"duration":{"type":"string","x-stream-index":"002.001"},"hidden":{"type":"boolean","x-stream-index":"001.011"},"hide_messages_before":{"format":"date-time","type":"number","x-stream-index":"001.012"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"001.007"},"membership":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"001.008"},"messages":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","x-stream-index":"001.002"},"pending_messages":{"items":{"$ref":"#/components/schemas/PendingMessageResponse"},"type":"array","x-stream-index":"001.013"},"pinned_messages":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","x-stream-index":"001.003"},"push_preferences":{"$ref":"#/components/schemas/ChannelPushPreferences","x-stream-index":"001.009"},"read":{"items":{"$ref":"#/components/schemas/ReadStateResponse"},"type":"array","x-stream-index":"001.006"},"threads":{"items":{"$ref":"#/components/schemas/ThreadStateResponse"},"type":"array","x-stream-index":"001.010"},"watcher_count":{"format":"int32","type":"integer","x-stream-index":"001.004"},"watchers":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"001.005"}},"required":["messages","pinned_messages","members","threads","duration"],"type":"object"},"ChannelStateResponseFields":{"properties":{"active_live_locations":{"description":"Active live locations in the channel","items":{"$ref":"#/components/schemas/SharedLocationResponseData"},"title":"Active Live Locations","type":"array","x-stream-index":"015"},"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"014"},"hidden":{"description":"Whether this channel is hidden or not","title":"Hidden","type":"boolean","x-stream-index":"011"},"hide_messages_before":{"description":"Messages before this date are hidden from the user","format":"date-time","title":"Hide messages before","type":"number","x-stream-index":"012"},"members":{"description":"List of channel members","items":{"$ref":"#/components/schemas/ChannelMember"},"title":"Members","type":"array","x-stream-index":"007"},"membership":{"$ref":"#/components/schemas/ChannelMember","description":"Current user membership object","title":"Membership","x-stream-index":"008"},"messages":{"description":"List of channel messages","items":{"$ref":"#/components/schemas/MessageResponse"},"title":"Message","type":"array","x-stream-index":"002"},"pending_messages":{"description":"Pending messages that this user has sent","items":{"$ref":"#/components/schemas/PendingMessageResponse"},"title":"Pending messages","type":"array","x-stream-index":"013"},"pinned_messages":{"description":"List of pinned messages in the channel","items":{"$ref":"#/components/schemas/MessageResponse"},"title":"Pinned messages","type":"array","x-stream-docs-page-id":"pinned_messages","x-stream-index":"003"},"push_preferences":{"$ref":"#/components/schemas/ChannelPushPreferences","x-stream-index":"009"},"read":{"description":"List of read states","items":{"$ref":"#/components/schemas/ReadStateResponse"},"title":"Read","type":"array","x-stream-index":"006"},"threads":{"items":{"$ref":"#/components/schemas/ThreadStateResponse"},"type":"array","x-stream-index":"010"},"watcher_count":{"description":"Number of channel watchers","format":"int32","title":"Watcher count","type":"integer","x-stream-index":"004"},"watchers":{"description":"List of user who is watching the channel","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Watchers","type":"array","x-stream-index":"005"}},"required":["messages","pinned_messages","members","threads"],"type":"object"},"ChannelTruncatedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001.004"},"channel_id":{"type":"string","x-stream-index":"001.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"001.005"},"channel_type":{"type":"string","x-stream-index":"001.003"},"cid":{"type":"string","x-stream-index":"001.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"type":{"default":"channel.truncated","type":"string","x-stream-index":"002.001"}},"required":["cid","channel_id","channel_type","channel_member_count","type","created_at"],"title":"ChannelTruncatedEvent","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"},"ChannelTypeConfig":{"nullable":true,"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"003.002.026"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"003.002.021"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.002.022"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"003.002.027"},"blocklist":{"type":"string","x-stream-index":"003.002.023"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.002.024"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"003.002.025"},"commands":{"items":{"$ref":"#/components/schemas/Command"},"type":"array","x-stream-index":"003.003"},"connect_events":{"type":"boolean","x-stream-index":"003.002.004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.001.003"},"custom_events":{"type":"boolean","x-stream-index":"003.002.012"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"002"},"mark_messages_pending":{"type":"boolean","x-stream-index":"003.002.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"003.002.020"},"mutes":{"type":"boolean","x-stream-index":"003.002.009"},"name":{"type":"string","x-stream-index":"003.002.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"003.002.028"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"003.002.029"},"permissions":{"items":{"$ref":"#/components/schemas/PolicyRequest"},"type":"array","x-stream-index":"001"},"polls":{"type":"boolean","x-stream-index":"003.002.016"},"push_notifications":{"type":"boolean","x-stream-index":"003.002.013"},"quotes":{"type":"boolean","x-stream-index":"003.002.008"},"reactions":{"type":"boolean","x-stream-index":"003.002.006"},"read_events":{"type":"boolean","x-stream-index":"003.002.003"},"reminders":{"type":"boolean","x-stream-index":"003.002.014"},"replies":{"type":"boolean","x-stream-index":"003.002.007"},"search":{"type":"boolean","x-stream-index":"003.002.005"},"shared_locations":{"type":"boolean","x-stream-index":"003.002.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"003.002.030"},"typing_events":{"type":"boolean","x-stream-index":"003.002.002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"003.001.004"},"uploads":{"type":"boolean","x-stream-index":"003.002.010"},"url_enrichment":{"type":"boolean","x-stream-index":"003.002.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"003.002.017"}},"required":["permissions","grants","created_at","updated_at","name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","commands"],"type":"object"},"ChannelUnFrozenEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"channel.unfrozen","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"ChannelUnFrozenEvent","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"},"ChannelUnmutedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"channel.unmuted","type":"string","x-stream-index":"001.001"}},"required":["type","created_at"],"title":"ChannelUnmutedEvent","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"},"ChannelUpdatedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"004.004"},"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"004.005"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"002.001"},"type":{"default":"channel.updated","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"ChannelUpdatedEvent","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"},"ChannelVisibleEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"001.002"},"channel_type":{"type":"string","x-stream-index":"001.003"},"cid":{"type":"string","x-stream-index":"001.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"type":{"default":"channel.visible","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"ChannelVisibleEvent","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"},"CheckExternalStorageResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"file_url":{"type":"string","x-stream-index":"002"}},"required":["duration","file_url"],"title":"Response","type":"object"},"CheckPushRequest":{"description":"Check push request","nullable":true,"properties":{"apn_template":{"description":"Push message template for APN","title":"APN template","type":"string","x-stream-docs-page-id":"push_template","x-stream-index":"002"},"event_type":{"description":"Type of event for push templates (default: message.new)","enum":["message.new","message.updated","reaction.new","reaction.updated","notification.reminder_due"],"title":"Event type","type":"string","x-stream-index":"008"},"firebase_data_template":{"description":"Push message data template for Firebase","title":"Firebase data template","type":"string","x-stream-docs-page-id":"push_template","x-stream-index":"004"},"firebase_template":{"description":"Push message template for Firebase","title":"Firebase template","type":"string","x-stream-docs-page-id":"push_template","x-stream-index":"003"},"message_id":{"description":"Message ID to send push notification for","title":"Message ID","type":"string","x-stream-index":"001"},"push_provider_name":{"description":"Name of push provider","title":"Name of push provider","type":"string","x-stream-index":"007"},"push_provider_type":{"description":"Push provider type","enum":["firebase","apn","huawei","xiaomi"],"title":"Type of push provider","type":"string","x-stream-index":"006"},"skip_devices":{"description":"Don't require existing devices to render templates","title":"Skip devices","type":"boolean","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"009.002"},"user_id":{"type":"string","x-stream-index":"009.001"}},"title":"CheckPushRequest","type":"object"},"CheckPushResponse":{"nullable":true,"properties":{"device_errors":{"additionalProperties":{"$ref":"#/components/schemas/DeviceErrorInfo"},"description":"Object with device errors","title":"Device errors","type":"object","x-stream-index":"001","x-stream-map":{"key":"device_id"}},"duration":{"type":"string","x-stream-index":"008.001"},"event_type":{"description":"The event type that was tested","title":"Event type","type":"string","x-stream-index":"004"},"general_errors":{"description":"List of general errors","items":{"type":"string"},"title":"General errors","type":"array","x-stream-index":"002"},"rendered_apn_template":{"title":"Rendered APN template","type":"string","x-stream-index":"005"},"rendered_firebase_template":{"title":"Rendered Firebase template","type":"string","x-stream-index":"006"},"rendered_message":{"additionalProperties":{"type":"string"},"title":"Rendered message","type":"object","x-stream-index":"007"},"skip_devices":{"description":"Don't require existing devices to render templates","title":"Skip devices","type":"boolean","x-stream-index":"003"}},"required":["duration"],"type":"object"},"CheckRequest":{"nullable":true,"properties":{"config_key":{"description":"Key of the moderation configuration to use","title":"Config Key","type":"string","x-stream-index":"005"},"config_team":{"description":"Team associated with the configuration","title":"Config Team","type":"string","x-stream-index":"006"},"entity_creator_id":{"description":"ID of the user who created the entity","title":"Entity Creator ID","type":"string","x-stream-index":"003"},"entity_id":{"description":"Unique identifier of the entity to moderate","title":"Entity ID","type":"string","x-stream-index":"002"},"entity_type":{"description":"Type of entity to moderate","title":"Entity Type","type":"string","x-stream-index":"001"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content to be moderated","title":"Moderation Payload","x-stream-index":"004"},"options":{"additionalProperties":{},"description":"Additional moderation configuration options","title":"Options","type":"object","x-stream-index":"007"},"test_mode":{"description":"Whether to run moderation in test mode","title":"Test Mode","type":"boolean","x-stream-index":"008"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"009.002"},"user_id":{"type":"string","x-stream-index":"009.001"}},"required":["entity_type","entity_id","entity_creator_id","config_key"],"type":"object"},"CheckResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"005.001"},"item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"Review queue item (present if action != keep)","title":"Item","x-stream-index":"004"},"recommended_action":{"description":"Suggested action based on moderation results","title":"Recommended Action","type":"string","x-stream-index":"003"},"status":{"description":"Status of the moderation check (completed or pending)","title":"Status","type":"string","x-stream-index":"001"},"task_id":{"description":"ID of the running moderation task","title":"Task ID","type":"string","x-stream-index":"002"}},"required":["status","recommended_action","duration"],"type":"object"},"CheckSNSRequest":{"nullable":true,"properties":{"sns_key":{"description":"AWS SNS access key","title":"SNS key","type":"string","x-stream-index":"002"},"sns_secret":{"description":"AWS SNS key secret","title":"SNS secret","type":"string","x-stream-index":"003"},"sns_topic_arn":{"description":"AWS SNS topic ARN","title":"SNS Topic ARN","type":"string","x-stream-index":"001"}},"type":"object"},"CheckSNSResponse":{"nullable":true,"properties":{"data":{"additionalProperties":{},"description":"Error data","title":"ReadOnlyData","type":"object","x-stream-index":"003"},"duration":{"type":"string","x-stream-index":"004.001"},"error":{"description":"Error text","title":"Error","type":"string","x-stream-index":"002"},"status":{"description":"Validation result","enum":["ok","error"],"title":"Status","type":"string","x-stream-index":"001"}},"required":["status","duration"],"type":"object"},"CheckSQSRequest":{"nullable":true,"properties":{"sqs_key":{"description":"AWS SQS access key","title":"SQS key","type":"string","x-stream-index":"002"},"sqs_secret":{"description":"AWS SQS key secret","title":"SQS secret","type":"string","x-stream-index":"003"},"sqs_url":{"description":"AWS SQS endpoint URL","title":"SQS URL","type":"string","x-stream-index":"001"}},"type":"object"},"CheckSQSResponse":{"nullable":true,"properties":{"data":{"additionalProperties":{},"description":"Error data","title":"ReadOnlyData","type":"object","x-stream-index":"003"},"duration":{"type":"string","x-stream-index":"004.001"},"error":{"description":"Error text","title":"Error","type":"string","x-stream-index":"002"},"status":{"description":"Validation result","enum":["ok","error"],"title":"Status","type":"string","x-stream-index":"001"}},"required":["status","duration"],"type":"object"},"Command":{"description":"Represents custom chat command","nullable":true,"properties":{"args":{"description":"Arguments help text, shown in commands auto-completion","title":"Arguments","type":"string","x-stream-index":"006"},"created_at":{"description":"Date/time of creation","format":"date-time","readOnly":true,"title":"Created at","type":"number","x-stream-index":"001"},"description":{"description":"Description, shown in commands auto-completion","title":"Description","type":"string","x-stream-index":"005"},"name":{"description":"Unique command name","title":"Name","type":"string","x-stream-index":"004"},"set":{"description":"Set name used for grouping commands","title":"Set","type":"string","x-stream-index":"007"},"updated_at":{"description":"Date/time of the last update","format":"date-time","readOnly":true,"title":"Updated at","type":"number","x-stream-index":"002"}},"required":["name","description","args","set"],"title":"Command","type":"object"},"CommitMessageRequest":{"nullable":true,"type":"object"},"CompositeAppSettings":{"properties":{"json_encoded_settings":{"type":"string","x-stream-index":"005"},"url":{"type":"string","x-stream-index":"004"}},"type":"object"},"ConfigOverrides":{"properties":{"blocklist":{"type":"string","x-stream-index":"008"},"blocklist_behavior":{"enum":["flag","block"],"type":"string","x-stream-index":"009"},"commands":{"items":{"type":"string"},"type":"array","x-stream-index":"011"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"010"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"007"},"quotes":{"type":"boolean","x-stream-index":"004"},"reactions":{"type":"boolean","x-stream-index":"002"},"replies":{"type":"boolean","x-stream-index":"003"},"shared_locations":{"type":"boolean","x-stream-index":"013"},"typing_events":{"type":"boolean","x-stream-index":"001"},"uploads":{"type":"boolean","x-stream-index":"005"},"url_enrichment":{"type":"boolean","x-stream-index":"006"},"user_message_reminders":{"type":"boolean","x-stream-index":"012"}},"required":["grants","commands"],"type":"object"},"ConfigResponse":{"properties":{"ai_image_config":{"$ref":"#/components/schemas/AIImageConfig","description":"Configuration for AI image analysis","title":"AI Image Config","x-stream-index":"009"},"ai_text_config":{"$ref":"#/components/schemas/AITextConfig","description":"Configuration for AI text analysis","title":"AI Text Config","x-stream-index":"008"},"ai_video_config":{"$ref":"#/components/schemas/AIVideoConfig","description":"Configuration for AI video analysis","title":"AI Video Config","x-stream-index":"010"},"async":{"description":"Whether moderation should be performed asynchronously","title":"Async","type":"boolean","x-stream-index":"003"},"automod_platform_circumvention_config":{"$ref":"#/components/schemas/AutomodPlatformCircumventionConfig","description":"Configuration for platform circumvention detection","title":"Automod Platform Circumvention Config","x-stream-index":"005"},"automod_semantic_filters_config":{"$ref":"#/components/schemas/AutomodSemanticFiltersConfig","description":"Configuration for semantic filtering","title":"Automod Semantic Filters Config","x-stream-index":"006"},"automod_toxicity_config":{"$ref":"#/components/schemas/AutomodToxicityConfig","description":"Configuration for toxicity detection","title":"Automod Toxicity Config","x-stream-index":"004"},"block_list_config":{"$ref":"#/components/schemas/BlockListConfig","description":"Configuration for block list filtering","title":"Block List Config","x-stream-index":"007"},"created_at":{"description":"When the configuration was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"012"},"key":{"description":"Unique identifier for the moderation configuration","title":"Key","type":"string","x-stream-index":"001"},"rule_builder_config":{"$ref":"#/components/schemas/RuleBuilderConfig","x-stream-index":"015"},"team":{"description":"Team associated with the configuration","title":"Team","type":"string","x-stream-index":"002"},"updated_at":{"description":"When the configuration was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"013"},"velocity_filter_config":{"$ref":"#/components/schemas/VelocityFilterConfig","description":"Configuration for velocity-based filtering","title":"Velocity Filter Config","x-stream-index":"011"},"video_call_rule_config":{"$ref":"#/components/schemas/VideoCallRuleConfig","x-stream-index":"014"}},"required":["key","team","async","created_at","updated_at"],"type":"object"},"ContentCountRuleParameters":{"properties":{"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"required":["threshold","time_window"],"type":"object"},"CreateBlockListRequest":{"description":"Block list contains restricted words","nullable":true,"properties":{"name":{"description":"Block list name","maxLength":255,"title":"Name","type":"string","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"004"},"type":{"description":"Block list type.","enum":["regex","domain","domain_allowlist","email","word"],"title":"Type","type":"string","x-stream-index":"003"},"words":{"description":"List of words to block","items":{"type":"string"},"minimum":1,"title":"Words","type":"array","x-stream-index":"002"}},"required":["name","words"],"title":"Block list","type":"object","x-stream-docs-page-id":"block_lists"},"CreateBlockListResponse":{"description":"Basic response information","nullable":true,"properties":{"blocklist":{"$ref":"#/components/schemas/BlockListResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["duration"],"title":"Response","type":"object"},"CreateChannelTypeRequest":{"nullable":true,"properties":{"automod":{"description":"Automod","enum":["disabled","simple","AI"],"title":"Automod","type":"string","x-stream-index":"019"},"automod_behavior":{"description":"Automod behavior","enum":["flag","block"],"title":"Automod behavior","type":"string","x-stream-index":"020"},"blocklist":{"description":"Blocklist","title":"Blocklist","type":"string","x-stream-index":"024"},"blocklist_behavior":{"description":"Blocklist behavior","enum":["flag","block","shadow_block"],"title":"Blocklist behavior","type":"string","x-stream-index":"025"},"blocklists":{"description":"Blocklists","items":{"$ref":"#/components/schemas/BlockListOptions"},"title":"Blocklists","type":"array","x-stream-index":"026"},"commands":{"description":"List of commands that channel supports","items":{"type":"string"},"title":"Commands","type":"array","x-stream-index":"021"},"connect_events":{"description":"Connect events","title":"Connect events","type":"boolean","x-stream-index":"004"},"custom_events":{"description":"Custom events","title":"Custom events","type":"boolean","x-stream-index":"011"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"List of grants for the channel type","title":"Grants","type":"object","x-stream-index":"023"},"mark_messages_pending":{"description":"Mark messages pending","title":"Mark messages pending","type":"boolean","x-stream-index":"013"},"max_message_length":{"description":"Max message length","format":"int32","title":"Max message length","type":"integer","x-stream-index":"018"},"message_retention":{"description":"Message retention","enum":["infinite","numeric"],"title":"Message retention","type":"string","x-stream-index":"017"},"mutes":{"description":"Mutes","title":"Mutes","type":"boolean","x-stream-index":"008"},"name":{"description":"Channel type name","title":"Name","type":"string","x-stream-index":"001"},"partition_size":{"description":"Partition size","format":"int32","minimum":10,"title":"Partition size","type":"integer","x-stream-index":"027"},"partition_ttl":{"description":"Partition TTL","example":"24h","format":"duration","nullable":true,"title":"Partition TTL","type":"string","x-stream-index":"028"},"permissions":{"description":"List of permissions for the channel type","items":{"$ref":"#/components/schemas/PolicyRequest"},"title":"Permissions","type":"array","x-stream-index":"022"},"polls":{"description":"Polls","title":"Polls","type":"boolean","x-stream-index":"014"},"push_notifications":{"description":"Push notifications","title":"Push notifications","type":"boolean","x-stream-index":"012"},"reactions":{"description":"Reactions","title":"Reactions","type":"boolean","x-stream-index":"005"},"read_events":{"description":"Read events","title":"Read events","type":"boolean","x-stream-index":"003"},"replies":{"description":"Replies","title":"Replies","type":"boolean","x-stream-index":"006"},"search":{"description":"Search","title":"Search","type":"boolean","x-stream-index":"007"},"shared_locations":{"description":"Enables shared location messages","title":"Shared locations","type":"boolean","x-stream-index":"016"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"029"},"typing_events":{"description":"Typing events","title":"Typing events","type":"boolean","x-stream-index":"002"},"uploads":{"description":"Uploads","title":"Uploads","type":"boolean","x-stream-index":"009"},"url_enrichment":{"description":"URL enrichment","title":"URL enrichment","type":"boolean","x-stream-index":"010"},"user_message_reminders":{"type":"boolean","x-stream-index":"015"}},"required":["name","max_message_length","automod","automod_behavior"],"title":"CreateChannelTypeRequest","type":"object"},"CreateChannelTypeResponse":{"nullable":true,"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.001.026"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.001.021"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.001.022"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.001.027"},"blocklist":{"type":"string","x-stream-index":"001.001.023"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.001.024"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.001.025"},"commands":{"items":{"type":"string"},"type":"array","x-stream-index":"001.003"},"connect_events":{"type":"boolean","x-stream-index":"001.001.004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002.003"},"custom_events":{"type":"boolean","x-stream-index":"001.001.012"},"duration":{"type":"string","x-stream-index":"004.001"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"003"},"mark_messages_pending":{"type":"boolean","x-stream-index":"001.001.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"001.001.020"},"mutes":{"type":"boolean","x-stream-index":"001.001.009"},"name":{"type":"string","x-stream-index":"001.001.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"001.001.028"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"001.001.029"},"permissions":{"items":{"$ref":"#/components/schemas/PolicyRequest"},"type":"array","x-stream-index":"002"},"polls":{"type":"boolean","x-stream-index":"001.001.016"},"push_notifications":{"type":"boolean","x-stream-index":"001.001.013"},"quotes":{"type":"boolean","x-stream-index":"001.001.008"},"reactions":{"type":"boolean","x-stream-index":"001.001.006"},"read_events":{"type":"boolean","x-stream-index":"001.001.003"},"reminders":{"type":"boolean","x-stream-index":"001.001.014"},"replies":{"type":"boolean","x-stream-index":"001.001.007"},"search":{"type":"boolean","x-stream-index":"001.001.005"},"shared_locations":{"type":"boolean","x-stream-index":"001.001.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.001.030"},"typing_events":{"type":"boolean","x-stream-index":"001.001.002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.002.004"},"uploads":{"type":"boolean","x-stream-index":"001.001.010"},"url_enrichment":{"type":"boolean","x-stream-index":"001.001.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"001.001.017"}},"required":["name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","created_at","updated_at","commands","permissions","grants","duration"],"type":"object"},"CreateCommandRequest":{"description":"Create a new command","nullable":true,"properties":{"args":{"description":"Arguments help text, shown in commands auto-completion","maxLength":255,"title":"Arguments","type":"string","x-stream-index":"003"},"description":{"description":"Description, shown in commands auto-completion","maxLength":255,"title":"Description","type":"string","x-stream-index":"002"},"name":{"description":"Unique command name","maxLength":255,"minLength":1,"title":"Name","type":"string","x-stream-index":"001"},"set":{"description":"Set name used for grouping commands","maxLength":255,"title":"Set","type":"string","x-stream-index":"004"}},"required":["name","description"],"title":"CreateCommandRequest","type":"object"},"CreateCommandResponse":{"nullable":true,"properties":{"command":{"$ref":"#/components/schemas/Command","description":"Command object","title":"Command","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["duration"],"title":"CreateCommandResponse","type":"object"},"CreateDeviceRequest":{"description":"Create device request","nullable":true,"properties":{"id":{"description":"Device ID","maxLength":255,"minLength":1,"title":"ID","type":"string","x-stream-index":"001"},"push_provider":{"description":"Push provider","enum":["firebase","apn","huawei","xiaomi"],"title":"PushProvider","type":"string","x-stream-index":"002"},"push_provider_name":{"description":"Push provider name","title":"PushProviderName","type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"005.002"},"user_id":{"description":"**Server-side only**. User ID which server acts upon","title":"User ID","type":"string","x-stream-index":"005.001"},"voip_token":{"description":"When true the token is for Apple VoIP push notifications","title":"VoipToken","type":"boolean","x-stream-index":"004"}},"required":["id","push_provider"],"title":"CreateDeviceRequest","type":"object"},"CreateExternalStorageRequest":{"description":"Create external storage","nullable":true,"properties":{"aws_s3":{"$ref":"#/components/schemas/S3Request","description":"Only required if you want to create an Amazon S3 storage","title":"AwsS3","x-stream-index":"003.004"},"azure_blob":{"$ref":"#/components/schemas/AzureRequest","description":"Only required if you want to create an Azure Blob Storage","title":"AzureBlob","x-stream-index":"003.006"},"bucket":{"description":"The name of the bucket on the service provider","title":"Bucket","type":"string","x-stream-index":"003.002"},"gcs_credentials":{"type":"string","x-stream-index":"003.005"},"name":{"description":"The name of the provider, this must be unique","title":"Name","type":"string","x-stream-index":"001"},"path":{"description":"The path prefix to use for storing files","title":"Path","type":"string","x-stream-index":"003.003"},"storage_type":{"description":"The type of storage to use","enum":["s3","gcs","abs"],"title":"StorageType","type":"string","x-stream-index":"003.001"}},"required":["name","storage_type","bucket"],"title":"CreateExternalStorageRequest","type":"object"},"CreateExternalStorageResponse":{"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"},"CreateGuestRequest":{"nullable":true,"properties":{"user":{"$ref":"#/components/schemas/UserRequest","description":"User object which server acts upon","title":"User","x-stream-index":"001"}},"required":["user"],"type":"object"},"CreateGuestResponse":{"nullable":true,"properties":{"access_token":{"description":"the access token to authenticate the user","title":"Access token","type":"string","x-stream-index":"002"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User object which server acts upon","title":"User","x-stream-index":"001"}},"required":["user","access_token","duration"],"type":"object"},"CreateImportRequest":{"nullable":true,"properties":{"mode":{"enum":["insert","upsert"],"type":"string","x-stream-index":"002"},"path":{"type":"string","x-stream-index":"001"}},"required":["path","mode"],"type":"object"},"CreateImportResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"import_task":{"$ref":"#/components/schemas/ImportTask","x-stream-index":"001"}},"required":["duration"],"title":"Response","type":"object"},"CreateImportURLRequest":{"nullable":true,"properties":{"filename":{"type":"string","x-stream-index":"001"}},"type":"object"},"CreateImportURLResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"path":{"type":"string","x-stream-index":"001"},"upload_url":{"type":"string","x-stream-index":"002"}},"required":["path","upload_url","duration"],"title":"Response","type":"object"},"CreatePollOptionRequest":{"nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"003"},"text":{"description":"Option text","title":"string","type":"string","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"required":["text"],"type":"object"},"CreatePollRequest":{"description":"Contains all information needed to create a new poll","nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"011"},"allow_answers":{"description":"Indicates whether users can suggest user defined answers","title":"Allow answers","type":"boolean","x-stream-index":"009"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"008"},"description":{"description":"A description of the poll","title":"Description","type":"string","x-stream-index":"003"},"enforce_unique_vote":{"description":"Indicates whether users can cast multiple votes","title":"Multiple choice","type":"boolean","x-stream-index":"006"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"is_closed":{"description":"Indicates whether the poll is open for voting","title":"Is closed","type":"boolean","x-stream-index":"010"},"max_votes_allowed":{"description":"Indicates the maximum amount of votes a user can cast","format":"int32","maximum":10,"title":"Maximum votes allowed","type":"integer","x-stream-index":"007"},"name":{"description":"The name of the poll","title":"Name","type":"string","x-stream-index":"002"},"options":{"items":{"$ref":"#/components/schemas/PollOptionInput"},"maximum":100,"type":"array","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"012.002"},"user_id":{"type":"string","x-stream-index":"012.001"},"voting_visibility":{"enum":["anonymous","public"],"type":"string","x-stream-index":"005"}},"required":["name"],"title":"Create Poll Request","type":"object"},"CreateReminderRequest":{"nullable":true,"properties":{"remind_at":{"format":"date-time","type":"number","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"type":"object"},"CreateRoleRequest":{"nullable":true,"properties":{"name":{"description":"Role name","maxLength":64,"title":"Name","type":"string","x-stream-index":"001"}},"required":["name"],"type":"object"},"CreateRoleResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"role":{"$ref":"#/components/schemas/Role","x-stream-index":"002"}},"required":["duration","role"],"title":"Response","type":"object"},"CustomActionRequest":{"properties":{"id":{"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"type":"object"},"CustomCheckFlag":{"properties":{"custom":{"additionalProperties":{},"description":"Additional metadata for the flag","title":"Custom","type":"object","x-stream-index":"003"},"labels":{"description":"Labels from various moderation sources","items":{"type":"string"},"title":"Labels","type":"array","x-stream-index":"004"},"reason":{"description":"Optional explanation for the flag","title":"Reason","type":"string","x-stream-index":"002"},"type":{"description":"Type of check (custom_check_text, custom_check_image, custom_check_video)","maxLength":255,"title":"Type","type":"string","x-stream-index":"001"}},"required":["type"],"type":"object"},"CustomCheckRequest":{"nullable":true,"properties":{"entity_creator_id":{"description":"ID of the user who created the entity (required for non-message entities)","title":"Entity Creator ID","type":"string","x-stream-index":"003"},"entity_id":{"description":"Unique identifier of the entity","title":"Entity ID","type":"string","x-stream-index":"002"},"entity_type":{"description":"Type of entity to perform custom check on","title":"Entity Type","type":"string","x-stream-index":"001"},"flags":{"description":"List of custom check flags (1-10 flags required)","items":{"$ref":"#/components/schemas/CustomCheckFlag"},"maximum":10,"minimum":1,"title":"Flags","type":"array","x-stream-index":"005"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content to be checked (required for non-message entities)","title":"Moderation Payload","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"006.002"},"user_id":{"type":"string","x-stream-index":"006.001"}},"required":["entity_type","entity_id","flags"],"type":"object"},"CustomCheckResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"004.001"},"id":{"description":"Unique identifier of the custom check","title":"ID","type":"string","x-stream-index":"001"},"item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"Review queue item details","title":"Item","x-stream-index":"002"},"status":{"description":"Status of the custom check","title":"Status","type":"string","x-stream-index":"003"}},"required":["id","status","duration"],"type":"object"},"Data":{"properties":{"id":{"type":"string","x-stream-index":"001"}},"required":["id"],"type":"object"},"DataDogInfo":{"properties":{"api_key":{"type":"string","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"003"},"site":{"type":"string","x-stream-index":"002"}},"type":"object"},"DeactivateUserRequest":{"nullable":true,"properties":{"created_by_id":{"description":"ID of the user who deactivated the user","title":"Created by ID","type":"string","x-stream-index":"003"},"mark_messages_deleted":{"description":"Makes messages appear to be deleted","title":"Mark messages deleted","type":"boolean","x-stream-index":"002"}},"type":"object"},"DeactivateUserResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Deactivated user object","title":"User","x-stream-index":"001"}},"required":["duration"],"type":"object"},"DeactivateUsersRequest":{"description":"Deactivate users request","nullable":true,"properties":{"created_by_id":{"description":"ID of the user who deactivated the users","title":"Created by ID","type":"string","x-stream-index":"003"},"mark_channels_deleted":{"type":"boolean","x-stream-index":"004"},"mark_messages_deleted":{"description":"Makes messages appear to be deleted","title":"Mark messages deleted","type":"boolean","x-stream-index":"002"},"user_ids":{"description":"User IDs to deactivate","items":{"type":"string"},"maximum":100,"minimum":1,"title":"User IDs","type":"array","x-stream-index":"001"}},"required":["user_ids"],"title":"DeactivateUsersRequest","type":"object"},"DeactivateUsersResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"task_id":{"type":"string","x-stream-index":"001"}},"required":["task_id","duration"],"title":"Response","type":"object"},"DeleteActivityRequest":{"properties":{"hard_delete":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"DeleteChannelResponse":{"description":"Basic response information","nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"Response","type":"object"},"DeleteChannelsRequest":{"nullable":true,"properties":{"cids":{"description":"All channels that should be deleted","items":{"type":"string"},"maximum":100,"minimum":1,"title":"Channels CID","type":"array","x-stream-index":"001"},"hard_delete":{"description":"Specify if channels and all ressources should be hard deleted","title":"Hard delete","type":"boolean","x-stream-index":"002"}},"required":["cids"],"type":"object"},"DeleteChannelsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"result":{"additionalProperties":{"$ref":"#/components/schemas/DeleteChannelsResultResponse"},"description":"Map of channel IDs and their deletion results","title":"Result","type":"object","x-stream-index":"001"},"task_id":{"type":"string","x-stream-index":"002"}},"required":["duration"],"type":"object"},"DeleteChannelsResultResponse":{"nullable":true,"properties":{"error":{"type":"string","x-stream-index":"002"},"status":{"type":"string","x-stream-index":"001"}},"required":["status"],"type":"object"},"DeleteCommandResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"name":{"description":"Command name","title":"Name","type":"string","x-stream-index":"001"}},"required":["name","duration"],"title":"DeleteCommandResponse","type":"object"},"DeleteExternalStorageResponse":{"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"},"DeleteMessageRequest":{"properties":{"hard_delete":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"DeleteMessageResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001"}},"required":["message","duration"],"title":"Response","type":"object"},"DeleteModerationConfigResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"DeleteModerationTemplateResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"DeleteReactionRequest":{"properties":{"hard_delete":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"DeleteReactionResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001"},"reaction":{"$ref":"#/components/schemas/ReactionResponse","x-stream-index":"002"}},"required":["message","reaction","duration"],"title":"Response","type":"object"},"DeleteReminderResponse":{"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"},"DeleteSegmentTargetsRequest":{"nullable":true,"properties":{"target_ids":{"description":"Target IDs","items":{"type":"string"},"maximum":100,"minimum":1,"title":"[]string","type":"array","x-stream-index":"002"}},"required":["target_ids"],"type":"object"},"DeleteUserRequest":{"properties":{"delete_conversation_channels":{"type":"boolean","x-stream-index":"003"},"delete_feeds_content":{"type":"boolean","x-stream-index":"004"},"hard_delete":{"type":"boolean","x-stream-index":"001"},"mark_messages_deleted":{"type":"boolean","x-stream-index":"002"}},"type":"object"},"DeleteUsersRequest":{"nullable":true,"properties":{"calls":{"description":"Calls delete mode.\nAffected calls are those that include exactly two members, one of whom is the user being deleted.\n\n* null or empty string - doesn't delete any calls\n* soft - marks user's calls and their related data as deleted (soft-delete)\n* hard - deletes user's calls and their data completely (hard-delete)\n","enum":["soft","hard"],"title":"Delete User's calls","type":"string","x-stream-index":"001.002.004"},"conversations":{"description":"Conversation channels delete mode.\nConversation channel is any channel which only has two members one of which is the user being deleted.\n\n* null or empty string - doesn't delete any conversation channels\n* soft - marks all conversation channels as deleted (same effect as Delete Channels with 'hard' option disabled)\n* hard - deletes channel and all its data completely including messages (same effect as Delete Channels with 'hard' option enabled)\n","enum":["soft","hard"],"title":"Delete Conversations","type":"string","x-stream-index":"001.002.003"},"files":{"description":"Delete user files.\n* false or empty string - doesn't delete any files\n* true - deletes all files uploaded by the user, including images and attachments.\n","title":"Delete User's files","type":"boolean","x-stream-index":"001.002.005"},"messages":{"description":"Message delete mode.\n\n* null or empty string - doesn't delete user messages\n* soft - marks all user messages as deleted without removing any related message data\n* pruning - marks all user messages as deleted, nullifies message information and removes some message data such as reactions and flags\n* hard - deletes messages completely with all related information\n","enum":["soft","pruning","hard"],"title":"Delete Messages","type":"string","x-stream-index":"001.002.002"},"new_call_owner_id":{"type":"string","x-stream-index":"001.002.007"},"new_channel_owner_id":{"type":"string","x-stream-index":"001.002.006"},"user":{"description":"User delete mode.\n\n* soft - marks user as deleted and retains all user data\n* pruning - marks user as deleted and nullifies user information\n* hard - deletes user completely. Requires 'hard' option for messages and conversations as well\n","enum":["soft","pruning","hard"],"title":"Delete User","type":"string","x-stream-index":"001.002.001"},"user_ids":{"description":"IDs of users to delete","items":{"type":"string"},"maximum":100,"minimum":1,"title":"User IDs","type":"array","x-stream-index":"001.001"}},"required":["user_ids"],"type":"object"},"DeleteUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"task_id":{"description":"ID of the task to delete users","title":"Task ID","type":"string","x-stream-index":"001"}},"required":["task_id","duration"],"type":"object"},"Device":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"disabled":{"type":"boolean","x-stream-index":"002.003"},"disabled_reason":{"type":"string","x-stream-index":"002.004"},"id":{"type":"string","x-stream-index":"002.001.004"},"push_provider":{"enum":["firebase","apn","huawei","xiaomi"],"type":"string","x-stream-index":"002.001.001"},"push_provider_name":{"type":"string","x-stream-index":"002.001.003"},"user_id":{"type":"string","x-stream-index":"004"},"voip":{"type":"boolean","x-stream-index":"002.001.005"}},"required":["push_provider","id","created_at","user_id"],"type":"object"},"DeviceErrorInfo":{"properties":{"error_message":{"type":"string","x-stream-index":"003"},"provider":{"type":"string","x-stream-index":"001"},"provider_name":{"type":"string","x-stream-index":"002"}},"required":["provider","provider_name","error_message"],"type":"object"},"DeviceResponse":{"description":"Response for Device","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"004"},"disabled":{"description":"Whether device is disabled or not","title":"Disabled","type":"boolean","x-stream-index":"005"},"disabled_reason":{"description":"Reason explaining why device had been disabled","title":"Reason","type":"string","x-stream-index":"006"},"id":{"description":"Device ID","title":"ID","type":"string","x-stream-index":"003"},"push_provider":{"description":"Push provider","title":"PushProvider","type":"string","x-stream-index":"001"},"push_provider_name":{"description":"Push provider name","title":"PushProviderName","type":"string","x-stream-index":"002"},"user_id":{"description":"User ID","title":"UserID","type":"string","x-stream-index":"008"},"voip":{"description":"When true the token is for Apple VoIP push notifications","title":"Voip","type":"boolean","x-stream-index":"007"}},"required":["push_provider","id","created_at","user_id"],"title":"DeviceResponse","type":"object"},"DraftPayloadResponse":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"html":{"type":"string","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"001"},"mentioned_users":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"008"},"mml":{"type":"string","x-stream-index":"003"},"parent_id":{"type":"string","x-stream-index":"005"},"poll_id":{"type":"string","x-stream-index":"013"},"quoted_message_id":{"type":"string","x-stream-index":"009"},"show_in_channel":{"type":"boolean","x-stream-index":"006"},"silent":{"type":"boolean","x-stream-index":"012"},"text":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"011"}},"required":["id","text","custom"],"type":"object"},"DraftResponse":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003"},"channel_cid":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"message":{"$ref":"#/components/schemas/DraftPayloadResponse","x-stream-index":"001"},"parent_id":{"type":"string","x-stream-index":"004"},"parent_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"005"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"006"}},"required":["message","channel_cid","created_at"],"type":"object"},"EgressHLSResponse":{"properties":{"playlist_url":{"type":"string","x-stream-index":"001"},"status":{"type":"string","x-stream-index":"002"}},"required":["playlist_url","status"],"type":"object"},"EgressRTMPResponse":{"properties":{"name":{"type":"string","x-stream-index":"001"},"started_at":{"format":"date-time","type":"number","x-stream-index":"004"},"stream_key":{"type":"string","x-stream-index":"003"},"stream_url":{"type":"string","x-stream-index":"002"}},"required":["name","started_at"],"type":"object"},"EgressResponse":{"properties":{"broadcasting":{"type":"boolean","x-stream-index":"001"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordingResponse","x-stream-index":"004"},"hls":{"$ref":"#/components/schemas/EgressHLSResponse","x-stream-index":"002"},"rtmps":{"items":{"$ref":"#/components/schemas/EgressRTMPResponse"},"type":"array","x-stream-index":"003"}},"required":["broadcasting","rtmps"],"type":"object"},"EgressTaskConfig":{"properties":{"egress_user":{"$ref":"#/components/schemas/EgressUser","x-stream-index":"008"},"frame_recording_egress_config":{"$ref":"#/components/schemas/FrameRecordingEgressConfig","x-stream-index":"009"},"hls_egress_config":{"$ref":"#/components/schemas/HLSEgressConfig","x-stream-index":"007"},"recording_egress_config":{"$ref":"#/components/schemas/RecordingEgressConfig","x-stream-index":"006"},"rtmp_egress_config":{"$ref":"#/components/schemas/RTMPEgressConfig","x-stream-index":"004"},"stt_egress_config":{"$ref":"#/components/schemas/STTEgressConfig","x-stream-index":"005"}},"type":"object"},"EgressUser":{"properties":{"token":{"type":"string","x-stream-index":"004"}},"type":"object"},"EnrichedActivity":{"properties":{"actor":{"$ref":"#/components/schemas/Data","x-stream-index":"002"},"foreign_id":{"type":"string","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"latest_reactions":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"013"},"object":{"$ref":"#/components/schemas/Data","x-stream-index":"004"},"origin":{"$ref":"#/components/schemas/Data","x-stream-index":"008"},"own_reactions":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"012"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"011"},"score":{"format":"float","type":"number","x-stream-index":"010"},"target":{"$ref":"#/components/schemas/Data","x-stream-index":"006"},"to":{"items":{"type":"string"},"type":"array","x-stream-index":"009"},"verb":{"type":"string","x-stream-index":"003"}},"type":"object"},"EnrichedReaction":{"nullable":true,"properties":{"activity_id":{"type":"string","x-stream-index":"003"},"children_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"010"},"created_at":{"$ref":"#/components/schemas/Time","x-stream-index":"012"},"data":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"kind":{"type":"string","x-stream-index":"002"},"latest_children":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"008"},"own_children":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"009"},"parent":{"type":"string","x-stream-index":"007"},"target_feeds":{"items":{"type":"string"},"type":"array","x-stream-index":"006"},"updated_at":{"$ref":"#/components/schemas/Time","x-stream-index":"013"},"user":{"$ref":"#/components/schemas/Data","x-stream-index":"011"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["kind","activity_id","user_id"],"type":"object"},"EntityCreator":{"properties":{"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"001.046"},"ban_count":{"format":"int32","type":"integer","x-stream-index":"002"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"001.017"},"banned":{"type":"boolean","x-stream-index":"001.016"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.013"},"deleted_content_count":{"format":"int32","type":"integer","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"001.023"},"language":{"type":"string","x-stream-index":"001.035"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"001.022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"001.026"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.042"},"role":{"type":"string","x-stream-index":"001.004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.005"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.009"}},"required":["id","role","teams_role","custom","banned","online","ban_count","deleted_content_count"],"type":"object"},"EntityCreatorResponse":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.001.018"},"ban_count":{"description":"Number of minor actions performed on the user","format":"int32","title":"Ban Count","type":"integer","x-stream-index":"002"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"001.003"},"banned":{"type":"boolean","x-stream-index":"001.001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.001.017"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.001.016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.001.011"},"deleted_content_count":{"description":"Number of major actions performed on the user","format":"int32","title":"Deleted Content Count","type":"integer","x-stream-index":"003"},"devices":{"items":{"$ref":"#/components/schemas/DeviceResponse"},"type":"array","x-stream-index":"001.006"},"flagged_count":{"description":"Number of flag actions performed on the user","format":"int32","title":"Flagged Count","type":"integer","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001.001.001"},"image":{"type":"string","x-stream-index":"001.001.003"},"invisible":{"type":"boolean","x-stream-index":"001.007"},"language":{"type":"string","x-stream-index":"001.001.005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"001.001.014"},"name":{"type":"string","x-stream-index":"001.001.002"},"online":{"type":"boolean","x-stream-index":"001.001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"001.005"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettingsResponse","x-stream-index":"001.004"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.001.015"},"role":{"type":"string","x-stream-index":"001.001.006"},"shadow_banned":{"type":"boolean","x-stream-index":"001.002"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.001.008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids","shadow_banned","invisible","ban_count","deleted_content_count","flagged_count"],"type":"object"},"ErrorResult":{"properties":{"stacktrace":{"type":"string","x-stream-index":"003"},"type":{"type":"string","x-stream-index":"001"},"version":{"type":"string","x-stream-index":"004"}},"required":["type","description"],"type":"object"},"EventHook":{"nullable":true,"properties":{"callback":{"$ref":"#/components/schemas/AsyncModerationCallbackConfig","x-stream-index":"018.001.002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"019"},"enabled":{"type":"boolean","x-stream-index":"003"},"event_types":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"hook_type":{"type":"string","x-stream-index":"002"},"id":{"type":"string","x-stream-index":"001"},"sns_auth_type":{"type":"string","x-stream-index":"014"},"sns_key":{"type":"string","x-stream-index":"015"},"sns_region":{"type":"string","x-stream-index":"013"},"sns_role_arn":{"type":"string","x-stream-index":"017"},"sns_secret":{"type":"string","x-stream-index":"016"},"sns_topic_arn":{"type":"string","x-stream-index":"012"},"sqs_auth_type":{"type":"string","x-stream-index":"008"},"sqs_key":{"type":"string","x-stream-index":"009"},"sqs_queue_url":{"type":"string","x-stream-index":"006"},"sqs_region":{"type":"string","x-stream-index":"007"},"sqs_role_arn":{"type":"string","x-stream-index":"011"},"sqs_secret":{"type":"string","x-stream-index":"010"},"timeout_ms":{"format":"int32","type":"integer","x-stream-index":"018.001.001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"020"},"webhook_url":{"type":"string","x-stream-index":"005"}},"type":"object"},"EventNotificationSettings":{"properties":{"apns":{"$ref":"#/components/schemas/APNS","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"fcm":{"$ref":"#/components/schemas/FCM","x-stream-index":"003"}},"required":["enabled","apns","fcm"],"type":"object"},"EventRequest":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"parent_id":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"required":["type"],"type":"object"},"EventResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"event":{"$ref":"#/components/schemas/WSEvent","x-stream-index":"001"}},"required":["event","duration"],"title":"Response","type":"object"},"ExportChannelsRequest":{"nullable":true,"properties":{"channels":{"description":"Export options for channels","items":{"$ref":"#/components/schemas/ChannelExport"},"maximum":100,"minimum":1,"title":"Channels","type":"array","x-stream-index":"002.001"},"clear_deleted_message_text":{"description":"Set if deleted message text should be cleared","title":"Clear deleted message text","type":"boolean","x-stream-index":"002.002"},"export_users":{"type":"boolean","x-stream-index":"002.005"},"include_soft_deleted_channels":{"description":"Set if you want to include deleted channels","title":"Include soft deleted channels","type":"boolean","x-stream-index":"002.004"},"include_truncated_messages":{"description":"Set if you want to include truncated messages","title":"Include truncated messages","type":"boolean","x-stream-index":"002.003"},"version":{"description":"Export version","title":"Version","type":"string","x-stream-index":"001"}},"required":["channels"],"type":"object"},"ExportChannelsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"task_id":{"description":"ID of the task to export channels","title":"Task ID","type":"string","x-stream-index":"001"}},"required":["task_id","duration"],"type":"object"},"ExportUserResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"004.001"},"messages":{"description":"List of exported messages","items":{"$ref":"#/components/schemas/MessageResponse"},"title":"Messages","type":"array","x-stream-index":"002"},"reactions":{"description":"List of exported reactions","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Reactions","type":"array","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Exported user object","title":"User","x-stream-index":"001"}},"required":["duration"],"type":"object"},"ExportUsersRequest":{"nullable":true,"properties":{"user_ids":{"items":{"type":"string"},"maximum":25,"minimum":1,"type":"array","x-stream-index":"001"}},"required":["user_ids"],"type":"object"},"ExportUsersResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"task_id":{"type":"string","x-stream-index":"001"}},"required":["task_id","duration"],"title":"Response","type":"object"},"ExternalStorage":{"properties":{"abs_account_name":{"type":"string","x-stream-index":"011"},"abs_client_id":{"type":"string","x-stream-index":"013"},"abs_client_secret":{"type":"string","x-stream-index":"014"},"abs_tenant_id":{"type":"string","x-stream-index":"012"},"bucket":{"type":"string","x-stream-index":"005"},"gcs_credentials":{"type":"string","x-stream-index":"010"},"path":{"type":"string","x-stream-index":"006"},"s3_api_key":{"type":"string","x-stream-index":"007"},"s3_custom_endpoint":{"type":"string","x-stream-index":"016"},"s3_region":{"type":"string","x-stream-index":"009"},"s3_secret_key":{"type":"string","x-stream-index":"008"},"storage_name":{"type":"string","x-stream-index":"015"},"storage_type":{"type":"integer","x-stream-index":"004"}},"type":"object"},"ExternalStorageResponse":{"properties":{"bucket":{"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"path":{"type":"string","x-stream-index":"004"},"type":{"enum":["s3","gcs","abs"],"type":"string","x-stream-index":"002"}},"required":["name","type","bucket","path"],"type":"object"},"FCM":{"properties":{"data":{"additionalProperties":{},"type":"object","x-stream-index":"001"}},"type":"object"},"FeedsModerationTemplateConfig":{"properties":{"config_key":{"type":"string","x-stream-index":"002"},"data_types":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001"}},"required":["data_types","config_key"],"type":"object"},"Field":{"nullable":true,"properties":{"short":{"type":"boolean","x-stream-index":"003"},"title":{"type":"string","x-stream-index":"001"},"value":{"type":"string","x-stream-index":"002"}},"required":["title","value","short"],"type":"object"},"FileUploadConfig":{"properties":{"allowed_file_extensions":{"items":{"type":"string"},"type":"array","x-stream-index":"001"},"allowed_mime_types":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"blocked_file_extensions":{"items":{"type":"string"},"type":"array","x-stream-index":"002"},"blocked_mime_types":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"size_limit":{"format":"int32","maximum":104857600,"minimum":0,"type":"integer","x-stream-index":"005"}},"required":["size_limit"],"type":"object"},"FileUploadRequest":{"nullable":true,"properties":{"file":{"description":"file field","title":"File","type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/OnlyUserID","description":"user for the request **server side only**","title":"User","x-stream-index":"002"}},"type":"object"},"FileUploadResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"file":{"description":"URL to the uploaded asset. Should be used to put to `asset_url` attachment field","title":"File","type":"string","x-stream-index":"001"},"thumb_url":{"description":"URL of the file thumbnail for supported file formats. Should be put to `thumb_url` attachment field","title":"Thumbnail URL","type":"string","x-stream-index":"002"}},"required":["duration"],"type":"object"},"FirebaseConfig":{"properties":{"Disabled":{"type":"boolean","writeOnly":true,"x-stream-index":"001"},"apn_template":{"type":"string","x-stream-index":"005"},"credentials_json":{"type":"string","x-stream-index":"006"},"data_template":{"type":"string","x-stream-index":"004"},"notification_template":{"type":"string","x-stream-index":"003"},"server_key":{"type":"string","x-stream-index":"002"}},"type":"object"},"FirebaseConfigFields":{"properties":{"apn_template":{"type":"string","x-stream-index":"004"},"credentials_json":{"type":"string","x-stream-index":"006"},"data_template":{"type":"string","x-stream-index":"003"},"enabled":{"type":"boolean","x-stream-index":"001"},"notification_template":{"type":"string","x-stream-index":"002"},"server_key":{"type":"string","x-stream-index":"005"}},"required":["enabled"],"type":"object"},"Flag":{"description":"Contains information about flagged user or message","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"019"},"custom":{"additionalProperties":{},"description":"Additional metadata about the flag","title":"Custom","type":"object","x-stream-index":"014"},"entity_creator_id":{"description":"ID of the user who created the flagged entity","title":"Entity Creator ID","type":"string","x-stream-index":"009"},"entity_id":{"description":"Unique identifier of the entity being flagged","title":"Entity ID","type":"string","x-stream-index":"008"},"entity_type":{"description":"Type of entity being flagged (e.g., message, user)","title":"Entity Type","type":"string","x-stream-index":"007"},"is_streamed_content":{"type":"boolean","x-stream-index":"012"},"labels":{"description":"Labels from bodyguard, API calls, our own AI etc","items":{"type":"string"},"title":"Labels","type":"array","x-stream-index":"015"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content being flagged","title":"Moderation Payload","x-stream-index":"010"},"moderation_payload_hash":{"type":"string","x-stream-index":"011"},"reason":{"description":"Optional explanation for why the content is being flagged","title":"Reason","type":"string","x-stream-index":"013"},"result":{"description":"Result of bodyguard, API calls, our own AI etc","items":{"additionalProperties":{},"type":"object"},"title":"Result","type":"array","x-stream-index":"016"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"018"},"review_queue_item_id":{"description":"ID of the review queue item","title":"Review Queue Item ID","type":"string","x-stream-index":"017"},"type":{"type":"string","x-stream-index":"004"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"020"},"user":{"$ref":"#/components/schemas/User","description":"User who flagged a message or a user","title":"User","x-stream-index":"006"}},"required":["entity_type","entity_id","result","created_at","updated_at"],"title":"Flag","type":"object"},"FlagContentOptions":{"properties":{"reason":{"type":"string","x-stream-index":"001"}},"required":["reason"],"type":"object"},"FlagDetails":{"properties":{"Extra":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"002"},"automod":{"$ref":"#/components/schemas/AutomodDetails","x-stream-index":"001"},"original_text":{"type":"string","x-stream-index":"003"}},"required":["Extra","original_text"],"type":"object"},"FlagFeedback":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"005"},"labels":{"items":{"$ref":"#/components/schemas/Label"},"type":"array","x-stream-index":"006"},"message_id":{"type":"string","x-stream-index":"004"}},"required":["message_id","created_at","labels"],"type":"object"},"FlagMessageDetails":{"properties":{"pin_changed":{"type":"boolean","x-stream-index":"002"},"should_enrich":{"type":"boolean","x-stream-index":"003"},"skip_push":{"type":"boolean","x-stream-index":"004"},"updated_by_id":{"type":"string","x-stream-index":"001"}},"type":"object"},"FlagRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"description":"Additional metadata about the flag","title":"Custom","type":"object","x-stream-index":"006"},"entity_creator_id":{"description":"ID of the user who created the flagged entity","title":"Entity Creator ID","type":"string","x-stream-index":"003"},"entity_id":{"description":"Unique identifier of the entity being flagged","title":"Entity ID","type":"string","x-stream-index":"002"},"entity_type":{"description":"Type of entity being flagged (e.g., message, user)","title":"Entity Type","type":"string","x-stream-index":"001"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content being flagged","title":"Moderation Payload","x-stream-index":"005"},"reason":{"description":"Optional explanation for why the content is being flagged","maxLength":255,"title":"Reason","type":"string","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"007.002"},"user_id":{"type":"string","x-stream-index":"007.001"}},"required":["entity_type","entity_id"],"type":"object"},"FlagResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"item_id":{"description":"Unique identifier of the created moderation item","title":"Item ID","type":"string","x-stream-index":"001"}},"required":["item_id","duration"],"type":"object"},"FlagUpdatedEvent":{"nullable":true,"properties":{"CreatedBy":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"004"},"Message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"002"},"User":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"type":{"default":"flag.updated","type":"string","x-stream-index":"001.002"}},"required":["type","created_at","custom"],"title":"FlagUpdatedEvent","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"},"FlagUserOptions":{"properties":{"reason":{"type":"string","x-stream-index":"001"}},"required":["reason"],"type":"object"},"FrameRecordSettings":{"properties":{"capture_interval_in_seconds":{"format":"int32","maximum":60,"minimum":2,"type":"integer","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"},"quality":{"type":"string","x-stream-index":"002"}},"required":["mode","capture_interval_in_seconds"],"type":"object"},"FrameRecordingEgressConfig":{"properties":{"capture_interval_in_seconds":{"format":"int32","type":"integer","x-stream-index":"007"},"external_storage":{"$ref":"#/components/schemas/ExternalStorage","x-stream-index":"006"},"quality":{"$ref":"#/components/schemas/Quality","x-stream-index":"004"},"storage_name":{"type":"string","x-stream-index":"005"}},"type":"object"},"FrameRecordingResponse":{"properties":{"status":{"type":"string","x-stream-index":"001"}},"required":["status"],"type":"object"},"FrameRecordingSettingsResponse":{"properties":{"capture_interval_in_seconds":{"format":"int32","maximum":60,"minimum":2,"type":"integer","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"},"quality":{"type":"string","x-stream-index":"002"}},"required":["mode","capture_interval_in_seconds"],"type":"object"},"FullUserResponse":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"015"},"banned":{"type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"014"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.011"},"devices":{"items":{"$ref":"#/components/schemas/DeviceResponse"},"type":"array","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001.001"},"image":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"005"},"language":{"type":"string","x-stream-index":"001.005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"001.014"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"012"},"mutes":{"items":{"$ref":"#/components/schemas/UserMuteResponse"},"type":"array","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"001.002"},"online":{"type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"003"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.015"},"role":{"type":"string","x-stream-index":"001.006"},"shadow_banned":{"type":"boolean","x-stream-index":"013"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"009"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"010"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"008"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"011"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","devices","invisible","mutes","channel_mutes","unread_count","total_unread_count","unread_channels","unread_threads","shadow_banned","blocked_user_ids"],"type":"object"},"GeofenceResponse":{"nullable":true,"properties":{"country_codes":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"description":{"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"type":{"type":"string","x-stream-index":"002"}},"required":["name"],"type":"object"},"GeofenceSettings":{"properties":{"names":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"required":["names"],"type":"object"},"GeofenceSettingsResponse":{"properties":{"names":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"required":["names"],"type":"object"},"GetApplicationResponse":{"description":"Basic response information","nullable":true,"properties":{"app":{"$ref":"#/components/schemas/AppResponseFields","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["app","duration"],"title":"Response","type":"object"},"GetBlockListResponse":{"description":"Response for get block list","nullable":true,"properties":{"blocklist":{"$ref":"#/components/schemas/BlockListResponse","description":"Block list object","title":"BlockListResponse","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["duration"],"title":"GetBlockListResponse","type":"object","x-stream-docs-page-id":"get_block_list"},"GetBlockedUsersResponse":{"nullable":true,"properties":{"blocks":{"description":"Array of blocked user object","items":{"$ref":"#/components/schemas/BlockedUserResponse"},"title":"Blocks","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["blocks","duration"],"type":"object"},"GetCampaignResponse":{"description":"Basic response information","nullable":true,"properties":{"campaign":{"$ref":"#/components/schemas/CampaignResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"users":{"$ref":"#/components/schemas/PagerResponse","x-stream-index":"002"}},"required":["duration"],"title":"Response","type":"object"},"GetChannelTypeResponse":{"description":"Basic response information","nullable":true,"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"003.002.026"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"003.002.021"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.002.022"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"003.002.027"},"blocklist":{"type":"string","x-stream-index":"003.002.023"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.002.024"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"003.002.025"},"commands":{"items":{"$ref":"#/components/schemas/Command"},"type":"array","x-stream-index":"003.003"},"connect_events":{"type":"boolean","x-stream-index":"003.002.004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.001.003"},"custom_events":{"type":"boolean","x-stream-index":"003.002.012"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"004.001"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"002"},"mark_messages_pending":{"type":"boolean","x-stream-index":"003.002.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"003.002.020"},"mutes":{"type":"boolean","x-stream-index":"003.002.009"},"name":{"type":"string","x-stream-index":"003.002.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"003.002.028"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"003.002.029"},"permissions":{"items":{"$ref":"#/components/schemas/PolicyRequest"},"type":"array","x-stream-index":"001"},"polls":{"type":"boolean","x-stream-index":"003.002.016"},"push_notifications":{"type":"boolean","x-stream-index":"003.002.013"},"quotes":{"type":"boolean","x-stream-index":"003.002.008"},"reactions":{"type":"boolean","x-stream-index":"003.002.006"},"read_events":{"type":"boolean","x-stream-index":"003.002.003"},"reminders":{"type":"boolean","x-stream-index":"003.002.014"},"replies":{"type":"boolean","x-stream-index":"003.002.007"},"search":{"type":"boolean","x-stream-index":"003.002.005"},"shared_locations":{"type":"boolean","x-stream-index":"003.002.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"003.002.030"},"typing_events":{"type":"boolean","x-stream-index":"003.002.002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"003.001.004"},"uploads":{"type":"boolean","x-stream-index":"003.002.010"},"url_enrichment":{"type":"boolean","x-stream-index":"003.002.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"003.002.017"}},"required":["permissions","grants","created_at","updated_at","name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","commands","duration"],"title":"Response","type":"object"},"GetCommandResponse":{"nullable":true,"properties":{"args":{"type":"string","x-stream-index":"001.006"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.001"},"description":{"type":"string","x-stream-index":"001.005"},"duration":{"type":"string","x-stream-index":"002.001"},"name":{"type":"string","x-stream-index":"001.004"},"set":{"type":"string","x-stream-index":"001.007"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.002"}},"required":["name","description","args","set","duration"],"title":"GetCommandResponse","type":"object"},"GetConfigResponse":{"nullable":true,"properties":{"config":{"$ref":"#/components/schemas/ConfigResponse","description":"The retrieved moderation configuration","title":"Config","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["duration"],"type":"object"},"GetCustomPermissionResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"permission":{"$ref":"#/components/schemas/Permission","x-stream-index":"001"}},"required":["permission","duration"],"title":"Response","type":"object"},"GetDraftResponse":{"description":"Basic response information","nullable":true,"properties":{"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["draft","duration"],"title":"Response","type":"object"},"GetImportResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"import_task":{"$ref":"#/components/schemas/ImportTask","x-stream-index":"001"}},"required":["duration"],"title":"Response","type":"object"},"GetManyMessagesResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.002.001"},"messages":{"description":"List of messages","items":{"$ref":"#/components/schemas/MessageResponse"},"title":"Messages","type":"array","x-stream-index":"001.001"}},"required":["messages","duration"],"type":"object"},"GetMessageResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageWithChannelResponse","x-stream-index":"001"},"pending_message_metadata":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"002"}},"required":["message","duration"],"title":"Response","type":"object"},"GetOGResponse":{"nullable":true,"properties":{"actions":{"items":{"$ref":"#/components/schemas/Action"},"type":"array","x-stream-index":"001.015"},"asset_url":{"description":"URL of detected video or audio","title":"Image URL","type":"string","x-stream-index":"001.017"},"author_icon":{"type":"string","x-stream-index":"001.007"},"author_link":{"description":"og:site","title":"Author Link","type":"string","x-stream-index":"001.006"},"author_name":{"description":"og:site_name","title":"Author Name","type":"string","x-stream-index":"001.005"},"color":{"type":"string","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.018"},"duration":{"type":"string","x-stream-index":"002.001"},"fallback":{"type":"string","x-stream-index":"001.002"},"fields":{"items":{"$ref":"#/components/schemas/Field"},"type":"array","x-stream-index":"001.016"},"footer":{"type":"string","x-stream-index":"001.013"},"footer_icon":{"type":"string","x-stream-index":"001.014"},"giphy":{"$ref":"#/components/schemas/Images","x-stream-index":"001.019"},"image_url":{"description":"URL of detected image","title":"Image URL","type":"string","x-stream-index":"001.011"},"og_scrape_url":{"description":"extracted url from the text","title":"OG Scrape URL","type":"string","x-stream-index":"001.020"},"original_height":{"format":"int32","type":"integer","x-stream-index":"001.022"},"original_width":{"format":"int32","type":"integer","x-stream-index":"001.021"},"pretext":{"type":"string","x-stream-index":"001.004"},"text":{"description":"og:description","title":"Text","type":"string","x-stream-index":"001.010"},"thumb_url":{"description":"URL of detected thumb image","title":"Image URL","type":"string","x-stream-index":"001.012"},"title":{"description":"og:title","title":"Title","type":"string","x-stream-index":"001.008"},"title_link":{"description":"og:url","title":"Title Link","type":"string","x-stream-index":"001.009"},"type":{"description":"Attachment type, could be empty, image, audio or video","title":"Type","type":"string","x-stream-index":"001.001"}},"required":["custom","duration"],"title":"Get OG Attachment","type":"object","x-stream-docs-page-id":"og"},"GetPushTemplatesResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"templates":{"items":{"$ref":"#/components/schemas/PushTemplate"},"type":"array","x-stream-index":"002"}},"required":["duration","templates"],"title":"Response","type":"object"},"GetRateLimitsResponse":{"nullable":true,"properties":{"android":{"additionalProperties":{"$ref":"#/components/schemas/LimitInfo"},"description":"Map of endpoint rate limits for the Android platform","title":"Android","type":"object","x-stream-index":"002","x-stream-map":{"key":"endpoint","title":"Endpoint name","description":"The name of the endpoint for which the limits apply"}},"duration":{"type":"string","x-stream-index":"005.001"},"ios":{"additionalProperties":{"$ref":"#/components/schemas/LimitInfo"},"description":"Map of endpoint rate limits for the iOS platform","title":"iOS","type":"object","x-stream-index":"003","x-stream-map":{"key":"endpoint","title":"Endpoint name","description":"The name of the endpoint for which the limits apply"}},"server_side":{"additionalProperties":{"$ref":"#/components/schemas/LimitInfo"},"description":"Map of endpoint rate limits for the server-side platform","title":"Server-side","type":"object","x-stream-index":"001","x-stream-map":{"key":"endpoint","title":"Endpoint name","description":"The name of the endpoint for which the limits apply"}},"web":{"additionalProperties":{"$ref":"#/components/schemas/LimitInfo"},"description":"Map of endpoint rate limits for the web platform","title":"Web","type":"object","x-stream-index":"004","x-stream-map":{"key":"endpoint","title":"Endpoint name","description":"The name of the endpoint for which the limits apply"}}},"required":["duration"],"title":"Get Rate Limits Response","type":"object","x-stream-docs-page-id":"rate_limits"},"GetReactionsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"reactions":{"description":"List of reactions","items":{"$ref":"#/components/schemas/Reaction"},"title":"Reactions","type":"array","x-stream-index":"001"}},"required":["reactions","duration"],"type":"object"},"GetRepliesResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"messages":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","x-stream-index":"001"}},"required":["messages","duration"],"title":"Response","type":"object"},"GetReviewQueueItemResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"Current state of the review queue item","title":"Item","x-stream-index":"001"}},"required":["duration"],"type":"object"},"GetSegmentResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"segment":{"$ref":"#/components/schemas/SegmentResponse","description":"Segment","title":"SegmentResponse","x-stream-index":"001"}},"required":["duration"],"type":"object"},"GetTaskResponse":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.003"},"duration":{"type":"string","x-stream-index":"004.001"},"error":{"$ref":"#/components/schemas/ErrorResult","description":"Error produced by task","title":"Error","x-stream-index":"003"},"result":{"additionalProperties":{},"description":"Result produced by task after completion","title":"Result","type":"object","x-stream-index":"002"},"status":{"description":"Current status of task","title":"Status","type":"string","x-stream-index":"001.002"},"task_id":{"description":"ID of task","title":"Task ID","type":"string","x-stream-index":"001.001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.004"}},"required":["task_id","status","created_at","updated_at","duration"],"title":"Get Task Response","type":"object","x-stream-docs-page-id":"tasks"},"GetThreadResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"thread":{"$ref":"#/components/schemas/ThreadStateResponse","description":"Enriched thread state","title":"Thread","x-stream-index":"001"}},"required":["thread","duration"],"type":"object"},"GoogleVisionConfig":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"HLSEgressConfig":{"properties":{"composite_app_settings":{"$ref":"#/components/schemas/CompositeAppSettings","x-stream-index":"005"},"playlist_url":{"type":"string","x-stream-index":"007"},"qualities":{"items":{"$ref":"#/components/schemas/Quality"},"type":"array","x-stream-index":"004"},"start_unix_nano":{"format":"int64","type":"integer","x-stream-index":"006"}},"type":"object"},"HLSSettings":{"properties":{"auto_on":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"004"},"quality_tracks":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"required":["auto_on","enabled","quality_tracks"],"type":"object"},"HLSSettingsResponse":{"description":"HLSSettings is the payload for HLS settings","properties":{"auto_on":{"title":"Auto On","type":"boolean","x-stream-index":"001"},"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"002"},"layout":{"$ref":"#/components/schemas/LayoutSettingsResponse","title":"Layout","x-stream-index":"004"},"quality_tracks":{"items":{"type":"string"},"title":"Quality Tracks","type":"array","x-stream-index":"003"}},"required":["auto_on","enabled","quality_tracks","layout"],"title":"HLSSettingsResponse","type":"object"},"HarmConfig":{"properties":{"action_sequences":{"items":{"$ref":"#/components/schemas/ActionSequence"},"type":"array","x-stream-index":"001"},"severity":{"type":"integer","x-stream-index":"002"}},"required":["action_sequences","severity"],"type":"object"},"HideChannelRequest":{"nullable":true,"properties":{"clear_history":{"description":"Whether to clear message history of the channel or not","title":"Clear history","type":"boolean","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"type":"object"},"HideChannelResponse":{"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"},"HuaweiConfig":{"properties":{"Disabled":{"type":"boolean","writeOnly":true,"x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"secret":{"type":"string","x-stream-index":"002"}},"type":"object"},"HuaweiConfigFields":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"id":{"type":"string","x-stream-index":"002"},"secret":{"type":"string","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"ImageContentParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"type":"object"},"ImageData":{"properties":{"frames":{"type":"string","x-stream-index":"005"},"height":{"type":"string","x-stream-index":"003"},"size":{"type":"string","x-stream-index":"004"},"url":{"type":"string","x-stream-index":"001"},"width":{"type":"string","x-stream-index":"002"}},"required":["url","width","height","size","frames"],"type":"object"},"ImageRuleParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"required":["threshold","time_window"],"type":"object"},"ImageSize":{"properties":{"crop":{"description":"Crop mode","enum":["top","bottom","left","right","center"],"title":"Crop","type":"string","x-stream-index":"001"},"height":{"description":"Target image height","format":"int32","title":"Height","type":"integer","x-stream-index":"003"},"resize":{"description":"Resize method","enum":["clip","crop","scale","fill"],"title":"Resize","type":"string","x-stream-index":"002"},"width":{"description":"Target image width","format":"int32","title":"Width","type":"integer","x-stream-index":"004"}},"title":"Image size configuration","type":"object"},"ImageUploadRequest":{"nullable":true,"properties":{"file":{"type":"string","x-stream-index":"001.001"},"upload_sizes":{"description":"field with JSON-encoded array of image size configurations","items":{"$ref":"#/components/schemas/ImageSize"},"title":"Upload sizes","type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/OnlyUserID","x-stream-index":"001.002"}},"type":"object"},"ImageUploadResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.003.001"},"file":{"type":"string","x-stream-index":"001.001"},"thumb_url":{"type":"string","x-stream-index":"001.002"},"upload_sizes":{"description":"Array of image size configurations","items":{"$ref":"#/components/schemas/ImageSize"},"title":"Upload sizes","type":"array","x-stream-index":"002"}},"required":["duration"],"type":"object"},"Images":{"properties":{"fixed_height":{"$ref":"#/components/schemas/ImageData","x-stream-index":"002"},"fixed_height_downsampled":{"$ref":"#/components/schemas/ImageData","x-stream-index":"004"},"fixed_height_still":{"$ref":"#/components/schemas/ImageData","x-stream-index":"003"},"fixed_width":{"$ref":"#/components/schemas/ImageData","x-stream-index":"005"},"fixed_width_downsampled":{"$ref":"#/components/schemas/ImageData","x-stream-index":"007"},"fixed_width_still":{"$ref":"#/components/schemas/ImageData","x-stream-index":"006"},"original":{"$ref":"#/components/schemas/ImageData","x-stream-index":"001"}},"required":["original","fixed_height","fixed_height_still","fixed_height_downsampled","fixed_width","fixed_width_still","fixed_width_downsampled"],"type":"object"},"ImportTask":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"011"},"history":{"items":{"$ref":"#/components/schemas/ImportTaskHistory"},"type":"array","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"003"},"mode":{"type":"string","x-stream-index":"006"},"path":{"type":"string","x-stream-index":"005"},"size":{"format":"int64","type":"integer","x-stream-index":"007"},"state":{"type":"string","x-stream-index":"008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"012"}},"required":["id","path","mode","state","history","created_at","updated_at"],"type":"object"},"ImportTaskHistory":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"next_state":{"type":"string","x-stream-index":"006"},"prev_state":{"type":"string","x-stream-index":"005"}},"required":["prev_state","next_state","created_at"],"type":"object"},"IngressAudioEncodingOptions":{"properties":{"bitrate":{"maximum":128000,"minimum":16000,"type":"integer","x-stream-index":"003"},"channels":{"enum":["1","2"],"format":"int32","type":"integer","x-stream-index":"001"},"enable_dtx":{"type":"boolean","x-stream-index":"002"}},"required":["channels","enable_dtx","bitrate"],"type":"object"},"IngressAudioEncodingResponse":{"properties":{"bitrate":{"format":"int32","type":"integer","x-stream-index":"003"},"channels":{"format":"int32","type":"integer","x-stream-index":"001"},"enable_dtx":{"type":"boolean","x-stream-index":"002"}},"required":["channels","enable_dtx","bitrate"],"type":"object"},"IngressSettings":{"properties":{"audio_encoding_options":{"$ref":"#/components/schemas/IngressAudioEncodingOptions","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"video_encoding_options":{"additionalProperties":{"$ref":"#/components/schemas/IngressVideoEncodingOptions"},"type":"object","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"IngressSettingsResponse":{"properties":{"audio_encoding_options":{"$ref":"#/components/schemas/IngressAudioEncodingResponse","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"video_encoding_options":{"additionalProperties":{"$ref":"#/components/schemas/IngressVideoEncodingResponse"},"type":"object","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"IngressVideoEncodingOptions":{"properties":{"layers":{"items":{"$ref":"#/components/schemas/IngressVideoLayer"},"minimum":1,"type":"array","x-stream-index":"001"}},"required":["layers"],"type":"object"},"IngressVideoEncodingResponse":{"properties":{"layers":{"items":{"$ref":"#/components/schemas/IngressVideoLayerResponse"},"type":"array","x-stream-index":"001"}},"required":["layers"],"type":"object"},"IngressVideoLayer":{"nullable":true,"properties":{"bitrate":{"minimum":1000,"type":"integer","x-stream-index":"002"},"codec":{"enum":["h264","vp8"],"type":"string","x-stream-index":"001"},"frame_rate":{"maximum":60,"minimum":1,"type":"integer","x-stream-index":"003"},"max_dimension":{"minimum":240,"type":"integer","x-stream-index":"005"},"min_dimension":{"minimum":240,"type":"integer","x-stream-index":"004"}},"required":["codec","bitrate","frame_rate","min_dimension","max_dimension"],"type":"object"},"IngressVideoLayerResponse":{"nullable":true,"properties":{"bitrate":{"type":"integer","x-stream-index":"002"},"codec":{"type":"string","x-stream-index":"001"},"frame_rate_limit":{"type":"integer","x-stream-index":"005"},"max_dimension":{"type":"integer","x-stream-index":"004"},"min_dimension":{"type":"integer","x-stream-index":"003"}},"required":["codec","bitrate","min_dimension","max_dimension","frame_rate_limit"],"type":"object"},"Label":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"phrase_list_ids":{"items":{"format":"int32","type":"integer"},"type":"array","x-stream-index":"002"}},"required":["name"],"type":"object"},"LabelThresholds":{"properties":{"block":{"description":"Threshold for automatic message block","format":"float","maximum":1,"minimum":0,"title":"Block","type":"number","x-stream-index":"002"},"flag":{"description":"Threshold for automatic message flag","format":"float","maximum":1,"minimum":0,"title":"Flag","type":"number","x-stream-index":"001"}},"type":"object"},"LayoutSettings":{"properties":{"detect_orientation":{"type":"boolean","x-stream-index":"005"},"external_app_url":{"type":"string","x-stream-index":"003"},"external_css_url":{"type":"string","x-stream-index":"004"},"name":{"enum":["spotlight","grid","single-participant","mobile","custom"],"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"required":["name","external_app_url","external_css_url"],"type":"object"},"LayoutSettingsResponse":{"properties":{"detect_orientation":{"type":"boolean","x-stream-index":"005"},"external_app_url":{"type":"string","x-stream-index":"003"},"external_css_url":{"type":"string","x-stream-index":"004"},"name":{"enum":["spotlight","grid","single-participant","mobile","custom"],"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"required":["name","external_app_url","external_css_url"],"type":"object"},"LimitInfo":{"properties":{"limit":{"description":"The maximum number of calls allowed for the time window","format":"int32","title":"Limit","type":"integer","x-stream-index":"001"},"remaining":{"description":"The number of remaining calls in the current window","format":"int64","title":"Remaining","type":"integer","x-stream-index":"002"},"reset":{"description":"The Unix timestamp of the next window","format":"int64","title":"Reset","type":"integer","x-stream-index":"003"}},"required":["limit","remaining","reset"],"title":"Rate Limit info","type":"object","x-stream-docs-page-id":"rate_limits"},"LimitsSettings":{"properties":{"max_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"004"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"},"max_participants_exclude_owner":{"type":"boolean","x-stream-index":"003"},"max_participants_exclude_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"002"}},"required":["max_participants_exclude_roles"],"type":"object"},"LimitsSettingsResponse":{"properties":{"max_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"004"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"},"max_participants_exclude_owner":{"type":"boolean","x-stream-index":"003"},"max_participants_exclude_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"002"}},"required":["max_participants_exclude_roles"],"type":"object"},"ListBlockListResponse":{"description":"Basic response information","nullable":true,"properties":{"blocklists":{"items":{"$ref":"#/components/schemas/BlockListResponse"},"type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["blocklists","duration"],"title":"Response","type":"object"},"ListChannelTypesResponse":{"nullable":true,"properties":{"channel_types":{"additionalProperties":{"$ref":"#/components/schemas/ChannelTypeConfig"},"description":"Object with all channel types","title":"Channel types","type":"object","x-stream-index":"001","x-stream-map":{"key":"channel_type","title":"Channel type","description":"Channel type config object"}},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["channel_types","duration"],"title":"ListChannelTypesResponse","type":"object"},"ListCommandsResponse":{"nullable":true,"properties":{"commands":{"description":"List of commands","items":{"$ref":"#/components/schemas/Command"},"title":"Commands","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["commands","duration"],"title":"ListCommandsResponse","type":"object"},"ListDevicesResponse":{"description":"List devices response","nullable":true,"properties":{"devices":{"description":"List of devices","items":{"$ref":"#/components/schemas/DeviceResponse"},"title":"Devices","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["devices","duration"],"title":"ListDevicesResponse","type":"object"},"ListExternalStorageResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"external_storages":{"additionalProperties":{"$ref":"#/components/schemas/ExternalStorageResponse"},"type":"object","x-stream-index":"002"}},"required":["duration","external_storages"],"title":"Response","type":"object"},"ListImportsResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"import_tasks":{"items":{"$ref":"#/components/schemas/ImportTask"},"type":"array","x-stream-index":"001"}},"required":["import_tasks","duration"],"title":"Response","type":"object"},"ListPermissionsResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"permissions":{"items":{"$ref":"#/components/schemas/Permission"},"type":"array","x-stream-index":"001"}},"required":["permissions","duration"],"title":"Response","type":"object"},"ListPushProvidersResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"push_providers":{"items":{"$ref":"#/components/schemas/PushProviderResponse"},"type":"array","x-stream-index":"001"}},"required":["push_providers","duration"],"title":"Response","type":"object"},"ListRolesResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"roles":{"items":{"$ref":"#/components/schemas/Role"},"type":"array","x-stream-index":"001"}},"required":["roles","duration"],"title":"Response","type":"object"},"MarkChannelsReadRequest":{"nullable":true,"properties":{"read_by_channel":{"additionalProperties":{"type":"string"},"description":"Map of channel ID to last read message ID","maximum":30,"title":"Read by channel","type":"object","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"002.002"},"user_id":{"type":"string","x-stream-index":"002.001"}},"type":"object"},"MarkReadRequest":{"nullable":true,"properties":{"message_id":{"description":"ID of the message that is considered last read by client","title":"Message ID","type":"string","x-stream-index":"001"},"thread_id":{"description":"Optional Thread ID to specifically mark a given thread as read","title":"Thread ID","type":"string","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"type":"object"},"MarkReadResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"event":{"$ref":"#/components/schemas/MessageReadEvent","description":"Mark read event","title":"Event","x-stream-index":"001"}},"required":["duration"],"type":"object"},"MarkReviewedRequest":{"properties":{"content_to_mark_as_reviewed_limit":{"format":"int32","maximum":2500,"type":"integer","x-stream-index":"002"},"disable_marking_content_as_reviewed":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"MarkUnreadRequest":{"nullable":true,"properties":{"message_id":{"description":"ID of the message from where the channel is marked unread","title":"Message ID","type":"string","x-stream-index":"001"},"thread_id":{"description":"Mark a thread unread, specify both the thread and message id","title":"Thread ID","type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"type":"object"},"MemberAddedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"002.001"},"type":{"default":"member.added","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MemberAddedEvent","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"},"MemberLookup":{"properties":{"Limit":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"001"}},"required":["Limit"],"type":"object"},"MemberRemovedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"001.001"},"type":{"default":"member.removed","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MemberRemovedEvent","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"},"MemberUpdatedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"005.002"},"channel_type":{"type":"string","x-stream-index":"005.003"},"cid":{"type":"string","x-stream-index":"005.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"002.001"},"type":{"default":"member.updated","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MemberUpdatedEvent","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"},"MembersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"members":{"description":"List of found members","items":{"$ref":"#/components/schemas/ChannelMember"},"title":"Members","type":"array","x-stream-index":"001"}},"required":["members","duration"],"type":"object"},"Message":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"012"},"before_message_send_failed":{"type":"boolean","x-stream-index":"046"},"cid":{"type":"string","x-stream-index":"028"},"command":{"type":"string","x-stream-index":"006"},"created_at":{"format":"date-time","type":"number","x-stream-index":"030"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"034"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"033"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"023"},"html":{"type":"string","x-stream-index":"007"},"i18n":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"044"},"id":{"type":"string","x-stream-index":"002"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"040"},"latest_reactions":{"items":{"$ref":"#/components/schemas/Reaction"},"type":"array","x-stream-index":"013"},"mentioned_users":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"043"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"052"},"mml":{"type":"string","x-stream-index":"005"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"056"},"own_reactions":{"items":{"$ref":"#/components/schemas/Reaction"},"type":"array","x-stream-index":"014"},"parent_id":{"type":"string","x-stream-index":"019"},"pin_expires":{"format":"date-time","type":"number","x-stream-index":"051"},"pinned":{"type":"boolean","x-stream-index":"047"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"048"},"pinned_by":{"$ref":"#/components/schemas/User","x-stream-index":"050"},"poll":{"$ref":"#/components/schemas/Poll","x-stream-index":"054"},"poll_id":{"type":"string","x-stream-index":"053"},"quoted_message":{"$ref":"#/components/schemas/Message","x-stream-index":"025"},"quoted_message_id":{"type":"string","x-stream-index":"024"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"015"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"017"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"016"},"reminder":{"$ref":"#/components/schemas/MessageReminder","x-stream-index":"058"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"022"},"restricted_visibility":{"items":{"type":"string"},"type":"array","x-stream-index":"011"},"shadowed":{"type":"boolean","x-stream-index":"036"},"shared_location":{"$ref":"#/components/schemas/SharedLocation","x-stream-index":"055"},"show_in_channel":{"type":"boolean","x-stream-index":"021"},"silent":{"type":"boolean","x-stream-index":"045"},"text":{"type":"string","x-stream-index":"004"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"027"},"type":{"type":"string","x-stream-index":"008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"031"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"010"}},"required":["id","text","html","type","restricted_visibility","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reaction_groups","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned"],"type":"object"},"MessageActionRequest":{"nullable":true,"properties":{"form_data":{"additionalProperties":{"type":"string"},"description":"ReadOnlyData to execute command with","title":"Form data","type":"object","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"required":["form_data"],"type":"object"},"MessageChangeSet":{"properties":{"attachments":{"type":"boolean","x-stream-index":"005"},"custom":{"type":"boolean","x-stream-index":"001"},"html":{"type":"boolean","x-stream-index":"004"},"mentioned_user_ids":{"type":"boolean","x-stream-index":"006"},"mml":{"type":"boolean","x-stream-index":"003"},"pin":{"type":"boolean","x-stream-index":"009"},"quoted_message_id":{"type":"boolean","x-stream-index":"007"},"silent":{"type":"boolean","x-stream-index":"008"},"text":{"type":"boolean","x-stream-index":"002"}},"required":["custom","text","mml","html","attachments","mentioned_user_ids","quoted_message_id","silent","pin"],"type":"object"},"MessageDeletedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"006.002"},"hard_delete":{"type":"boolean","x-stream-index":"002.001"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"005.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"message.deleted","type":"string","x-stream-index":"006.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["hard_delete","cid","channel_id","channel_type","type","created_at"],"title":"MessageDeletedEvent","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":{"approved_at":{"format":"date-time","type":"number","x-stream-index":"013"},"created_at":{"format":"date-time","type":"number","x-stream-index":"009"},"created_by_automod":{"type":"boolean","x-stream-index":"001"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"008"},"details":{"$ref":"#/components/schemas/FlagDetails","x-stream-index":"006"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"005"},"moderation_feedback":{"$ref":"#/components/schemas/FlagFeedback","x-stream-index":"003"},"moderation_result":{"$ref":"#/components/schemas/MessageModerationResult","x-stream-index":"002"},"reason":{"type":"string","x-stream-index":"007"},"rejected_at":{"format":"date-time","type":"number","x-stream-index":"014"},"reviewed_at":{"format":"date-time","type":"number","x-stream-index":"011"},"reviewed_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"012"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"004"}},"required":["created_by_automod","created_at","updated_at"],"type":"object"},"MessageFlaggedEvent":{"properties":{"cid":{"type":"string","x-stream-index":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"005.002"},"flag":{"$ref":"#/components/schemas/Flag","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"002.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"002.002"},"type":{"default":"message.flagged","type":"string","x-stream-index":"005.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004"}},"required":["cid","type","created_at"],"title":"MessageFlaggedEvent","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"},"MessageHistoryEntryResponse":{"nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"007"},"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"006"},"is_deleted":{"type":"boolean","x-stream-index":"004"},"message_id":{"type":"string","x-stream-index":"001"},"message_updated_at":{"format":"date-time","type":"number","x-stream-index":"003"},"message_updated_by_id":{"type":"string","x-stream-index":"002"},"text":{"type":"string","x-stream-index":"005"}},"required":["message_id","message_updated_by_id","message_updated_at","is_deleted","text","attachments","Custom"],"type":"object"},"MessageModerationResult":{"description":"Result of the message moderation","properties":{"action":{"description":"Action taken by automod","title":"Action","type":"string","x-stream-index":"002"},"ai_moderation_response":{"$ref":"#/components/schemas/ModerationResponse","description":"Response from AI moderation","title":"ModerationResponse","x-stream-index":"007"},"blocked_word":{"description":"Word that was blocked","title":"Blocked word","type":"string","x-stream-index":"004"},"blocklist_name":{"description":"Name of the blocklist","title":"Blocklist name","type":"string","x-stream-index":"005"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"010"},"message_id":{"description":"ID of the message","title":"Message ID","type":"string","x-stream-index":"001"},"moderated_by":{"description":"User who moderated the message","title":"Moderated by","type":"string","x-stream-index":"003"},"moderation_thresholds":{"$ref":"#/components/schemas/Thresholds","description":"Thresholds for AI moderation","title":"Thresholds","x-stream-index":"006"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"011"},"user_bad_karma":{"description":"Whether user has bad karma","title":"User bad karma","type":"boolean","x-stream-index":"009"},"user_karma":{"description":"Karma of the user","format":"float","title":"User karma","type":"number","x-stream-index":"008"}},"required":["message_id","action","user_karma","user_bad_karma","created_at","updated_at"],"title":"Message moderation result","type":"object"},"MessageNewEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"005.002"},"channel_type":{"type":"string","x-stream-index":"005.003"},"cid":{"type":"string","x-stream-index":"005.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"006.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"message.new","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"},"watcher_count":{"format":"int32","type":"integer","x-stream-index":"002.001"}},"required":["watcher_count","type","created_at","cid","channel_id","channel_type"],"title":"MessageNewEvent","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"},"MessageOptions":{"properties":{"include_thread_participants":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"MessagePaginationParams":{"type":"object"},"MessageReadEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"003"},"channel_last_message_at":{"format":"date-time","type":"number","x-stream-index":"005"},"channel_type":{"type":"string","x-stream-index":"004"},"cid":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"009"},"last_read_message_id":{"type":"string","x-stream-index":"010"},"team":{"type":"string","x-stream-index":"006"},"thread":{"$ref":"#/components/schemas/ThreadResponse","x-stream-index":"008"},"type":{"default":"message.read","type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","x-stream-index":"007"}},"required":["type","cid","channel_id","channel_type","created_at"],"type":"object"},"MessageReminder":{"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"004"},"channel_cid":{"type":"string","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"011"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"006"},"message_id":{"type":"string","x-stream-index":"005"},"remind_at":{"format":"date-time","type":"number","x-stream-index":"009"},"task_id":{"type":"string","x-stream-index":"010"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"012"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"user_id":{"type":"string","x-stream-index":"007"}},"required":["channel_cid","message_id","user_id","task_id","created_at","updated_at"],"type":"object"},"MessageRequest":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"maximum":30,"type":"array","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"html":{"type":"string","x-stream-index":"010"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"mentioned_users":{"items":{"type":"string"},"maximum":100,"type":"array","x-stream-index":"008"},"mml":{"type":"string","x-stream-index":"003"},"parent_id":{"type":"string","x-stream-index":"005"},"pin_expires":{"format":"date-time","type":"number","x-stream-index":"015"},"pinned":{"type":"boolean","x-stream-index":"013"},"pinned_at":{"format":"date-time","nullable":true,"type":"string","x-stream-index":"014"},"poll_id":{"type":"string","x-stream-index":"039"},"quoted_message_id":{"type":"string","x-stream-index":"009"},"restricted_visibility":{"items":{"type":"string"},"maximum":10,"type":"array","x-stream-index":"016"},"shared_location":{"$ref":"#/components/schemas/SharedLocation","x-stream-index":"040"},"show_in_channel":{"type":"boolean","x-stream-index":"006"},"silent":{"type":"boolean","x-stream-index":"012"},"text":{"type":"string","x-stream-index":"002"},"type":{"enum":["''","regular","system"],"type":"string","x-stream-index":"011"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"021.002"},"user_id":{"type":"string","x-stream-index":"021.001"}},"type":"object"},"MessageResponse":{"description":"Represents any chat message","properties":{"attachments":{"description":"Array of message attachments","items":{"$ref":"#/components/schemas/Attachment"},"title":"Message attachments","type":"array","x-stream-docs-page-id":"message_format#attachment-format","x-stream-index":"008"},"cid":{"description":"Channel unique identifier in \u003ctype\u003e:\u003cid\u003e format","title":"Channel CID","type":"string","x-stream-index":"022"},"command":{"description":"Contains provided slash command","title":"Command","type":"string","x-stream-docs-page-id":"custom_commands_webhook","x-stream-index":"004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"023"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"026"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"025"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"018"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"041"},"html":{"description":"Contains HTML markup of the message. Can only be set when using server-side API","title":"HTML content","type":"string","x-stream-index":"005"},"i18n":{"additionalProperties":{"type":"string"},"description":"Object with translations. Key `language` contains the original language key. Other keys contain translations","title":"Internationalization info","type":"object","x-stream-docs-page-id":"translation","x-stream-index":"030"},"id":{"description":"Message ID is unique string identifier of the message","title":"ID","type":"string","x-stream-index":"001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"Contains image moderation information","title":"Image moderation labels","type":"object","x-stream-index":"028"},"latest_reactions":{"description":"List of 10 latest reactions to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Latest reactions","type":"array","x-stream-index":"009"},"mentioned_users":{"description":"List of mentioned users","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Mentioned Users","type":"array","x-stream-index":"029"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"036"},"mml":{"description":"Should be empty if `text` is provided. Can only be set when using server-side API","title":"Messaging Markup Language","type":"string","x-stream-docs-page-id":"mml_overview","x-stream-index":"003"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"039"},"own_reactions":{"description":"List of 10 latest reactions of authenticated user to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Own reactions","type":"array","x-stream-index":"010"},"parent_id":{"description":"ID of parent message (thread)","title":"Parent message ID","type":"string","x-stream-docs-page-id":"threads","x-stream-index":"015"},"pin_expires":{"description":"Date when pinned message expires","format":"date-time","title":"Pin expiration date","type":"number","x-stream-docs-page-id":"pinned_messages","x-stream-index":"035"},"pinned":{"description":"Whether message is pinned or not","title":"Pinned","type":"boolean","x-stream-docs-page-id":"pinned_messages","x-stream-index":"032"},"pinned_at":{"description":"Date when message got pinned","format":"date-time","title":"Pinned at","type":"number","x-stream-docs-page-id":"pinned_messages","x-stream-index":"033"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","description":"Contains user who pinned the message","title":"Pinned by","x-stream-docs-page-id":"pinned_messages","x-stream-index":"034"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"038"},"poll_id":{"description":"Identifier of the poll to include in the message","title":"Poll ID","type":"string","x-stream-index":"037"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","description":"Contains quoted message","title":"Quoted message","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"020"},"quoted_message_id":{"title":"ID of quoted message","type":"string","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"019"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing number of reactions of each type. Key: reaction type (string), value: number of reactions (int)","title":"Reaction counts","type":"object","x-stream-index":"011"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"014"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing scores of reactions of each type. Key: reaction type (string), value: total score of reactions (int)","title":"Reaction scores","type":"object","x-stream-index":"012"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"042"},"reply_count":{"description":"Number of replies to this message","format":"int32","title":"Reply count","type":"integer","x-stream-index":"017"},"restricted_visibility":{"description":"A list of user ids that have restricted visibility to the message, if the list is not empty, the message is only visible to the users in the list","items":{"type":"string"},"title":"Restricted visibility","type":"array","x-stream-index":"040"},"shadowed":{"description":"Whether the message was shadowed or not","title":"Shadowed","type":"boolean","x-stream-docs-page-id":"moderation#shadow-ban","x-stream-index":"027"},"shared_location":{"$ref":"#/components/schemas/SharedLocationResponseData","description":"Contains shared location data","title":"Shared Location","x-stream-index":"043"},"show_in_channel":{"description":"Whether thread reply should be shown in the channel as well","title":"Show in channel","type":"boolean","x-stream-docs-page-id":"threads","x-stream-index":"016"},"silent":{"description":"Whether message is silent or not","title":"Silent","type":"boolean","x-stream-index":"031"},"text":{"description":"Text of the message. Should be empty if `mml` is provided","title":"Text","type":"string","x-stream-index":"002"},"thread_participants":{"description":"List of users who participate in thread","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Thread participants","type":"array","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"021"},"type":{"description":"Contains type of the message","enum":["regular","ephemeral","error","reply","system","deleted"],"title":"Message Type","type":"string","x-stream-docs-page-id":"message_format#message-types","x-stream-index":"006"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"024"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Sender of the message. Required when using server-side API","title":"User object","x-stream-index":"007"}},"required":["id","text","html","type","user","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned","restricted_visibility"],"title":"Message","type":"object","x-stream-docs-page-id":"send_message"},"MessageUnblockedEvent":{"properties":{"cid":{"type":"string","x-stream-index":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"002.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"002.002"},"type":{"default":"message.unblocked","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["cid","type","created_at"],"title":"MessageUnblockedEvent","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"},"MessageUndeletedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"005.002"},"channel_type":{"type":"string","x-stream-index":"005.003"},"cid":{"type":"string","x-stream-index":"005.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"002.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"message.undeleted","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MessageUndeletedEvent","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"},"MessageUpdate":{"properties":{"change_set":{"$ref":"#/components/schemas/MessageChangeSet","x-stream-index":"002"},"old_text":{"type":"string","x-stream-index":"001"}},"type":"object"},"MessageUpdatedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"005.002"},"channel_type":{"type":"string","x-stream-index":"005.003"},"cid":{"type":"string","x-stream-index":"005.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"002.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"message.updated","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MessageUpdatedEvent","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"},"MessageWithChannelResponse":{"description":"Represents any chat message","properties":{"attachments":{"description":"Array of message attachments","items":{"$ref":"#/components/schemas/Attachment"},"title":"Message attachments","type":"array","x-stream-docs-page-id":"message_format#attachment-format","x-stream-index":"001.008"},"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel object","title":"Channel","x-stream-index":"002"},"cid":{"description":"Channel unique identifier in \u003ctype\u003e:\u003cid\u003e format","title":"Channel CID","type":"string","x-stream-index":"001.022"},"command":{"description":"Contains provided slash command","title":"Command","type":"string","x-stream-docs-page-id":"custom_commands_webhook","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.023"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.026"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"001.025"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"001.018"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001.041"},"html":{"description":"Contains HTML markup of the message. Can only be set when using server-side API","title":"HTML content","type":"string","x-stream-index":"001.005"},"i18n":{"additionalProperties":{"type":"string"},"description":"Object with translations. Key `language` contains the original language key. Other keys contain translations","title":"Internationalization info","type":"object","x-stream-docs-page-id":"translation","x-stream-index":"001.030"},"id":{"description":"Message ID is unique string identifier of the message","title":"ID","type":"string","x-stream-index":"001.001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"Contains image moderation information","title":"Image moderation labels","type":"object","x-stream-index":"001.028"},"latest_reactions":{"description":"List of 10 latest reactions to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Latest reactions","type":"array","x-stream-index":"001.009"},"mentioned_users":{"description":"List of mentioned users","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Mentioned Users","type":"array","x-stream-index":"001.029"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"001.036"},"mml":{"description":"Should be empty if `text` is provided. Can only be set when using server-side API","title":"Messaging Markup Language","type":"string","x-stream-docs-page-id":"mml_overview","x-stream-index":"001.003"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"001.039"},"own_reactions":{"description":"List of 10 latest reactions of authenticated user to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Own reactions","type":"array","x-stream-index":"001.010"},"parent_id":{"description":"ID of parent message (thread)","title":"Parent message ID","type":"string","x-stream-docs-page-id":"threads","x-stream-index":"001.015"},"pin_expires":{"description":"Date when pinned message expires","format":"date-time","title":"Pin expiration date","type":"number","x-stream-docs-page-id":"pinned_messages","x-stream-index":"001.035"},"pinned":{"description":"Whether message is pinned or not","title":"Pinned","type":"boolean","x-stream-docs-page-id":"pinned_messages","x-stream-index":"001.032"},"pinned_at":{"description":"Date when message got pinned","format":"date-time","title":"Pinned at","type":"number","x-stream-docs-page-id":"pinned_messages","x-stream-index":"001.033"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","description":"Contains user who pinned the message","title":"Pinned by","x-stream-docs-page-id":"pinned_messages","x-stream-index":"001.034"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001.038"},"poll_id":{"description":"Identifier of the poll to include in the message","title":"Poll ID","type":"string","x-stream-index":"001.037"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","description":"Contains quoted message","title":"Quoted message","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"001.020"},"quoted_message_id":{"title":"ID of quoted message","type":"string","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"001.019"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing number of reactions of each type. Key: reaction type (string), value: number of reactions (int)","title":"Reaction counts","type":"object","x-stream-index":"001.011"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"001.014"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing scores of reactions of each type. Key: reaction type (string), value: total score of reactions (int)","title":"Reaction scores","type":"object","x-stream-index":"001.012"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"001.042"},"reply_count":{"description":"Number of replies to this message","format":"int32","title":"Reply count","type":"integer","x-stream-index":"001.017"},"restricted_visibility":{"description":"A list of user ids that have restricted visibility to the message, if the list is not empty, the message is only visible to the users in the list","items":{"type":"string"},"title":"Restricted visibility","type":"array","x-stream-index":"001.040"},"shadowed":{"description":"Whether the message was shadowed or not","title":"Shadowed","type":"boolean","x-stream-docs-page-id":"moderation#shadow-ban","x-stream-index":"001.027"},"shared_location":{"$ref":"#/components/schemas/SharedLocationResponseData","description":"Contains shared location data","title":"Shared Location","x-stream-index":"001.043"},"show_in_channel":{"description":"Whether thread reply should be shown in the channel as well","title":"Show in channel","type":"boolean","x-stream-docs-page-id":"threads","x-stream-index":"001.016"},"silent":{"description":"Whether message is silent or not","title":"Silent","type":"boolean","x-stream-index":"001.031"},"text":{"description":"Text of the message. Should be empty if `mml` is provided","title":"Text","type":"string","x-stream-index":"001.002"},"thread_participants":{"description":"List of users who participate in thread","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Thread participants","type":"array","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"001.021"},"type":{"description":"Contains type of the message","enum":["regular","ephemeral","error","reply","system","deleted"],"title":"Message Type","type":"string","x-stream-docs-page-id":"message_format#message-types","x-stream-index":"001.006"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.024"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Sender of the message. Required when using server-side API","title":"User object","x-stream-index":"001.007"}},"required":["id","text","html","type","user","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned","restricted_visibility","channel"],"title":"Message","type":"object","x-stream-docs-page-id":"send_message"},"ModerationActionConfig":{"nullable":true,"properties":{"action":{"type":"string","x-stream-index":"006"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"009"},"description":{"type":"string","x-stream-index":"008"},"entity_type":{"type":"string","x-stream-index":"004"},"icon":{"type":"string","x-stream-index":"007"},"order":{"format":"int32","type":"integer","x-stream-index":"005"}},"required":["entity_type","order","action","icon","description","custom"],"type":"object"},"ModerationCheckCompletedEvent":{"description":"This event is sent when a moderation check is completed","nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"entity_id":{"description":"The ID of entity which was moderated","title":"EntityID","type":"string","x-stream-index":"002"},"entity_type":{"description":"The type of the entity which was moderated","title":"EntityType","type":"string","x-stream-index":"003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"recommended_action":{"description":"The recommended action","title":"RecommendedAction","type":"string","x-stream-index":"004"},"review_queue_item_id":{"description":"The review queue item ID","title":"ReviewQueueItemID","type":"string","x-stream-index":"005"},"type":{"default":"moderation_check.completed","type":"string","x-stream-index":"001.002"}},"required":["type","created_at","custom","entity_id","entity_type","recommended_action","review_queue_item_id"],"title":"ModerationCheckCompletedEvent","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"},"ModerationCustomActionEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"001"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"002"},"type":{"default":"moderation.custom_action","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationCustomActionEvent","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"},"ModerationDashboardPreferences":{"properties":{"flag_user_on_flagged_content":{"type":"boolean","x-stream-index":"002"},"media_queue_blur_enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"ModerationFlagResponse":{"nullable":true,"properties":{"created_at":{"type":"string","x-stream-index":"014"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"009"},"entity_creator_id":{"type":"string","x-stream-index":"006"},"entity_id":{"type":"string","x-stream-index":"005"},"entity_type":{"type":"string","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001"},"labels":{"items":{"type":"string"},"type":"array","x-stream-index":"010"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"007"},"reason":{"type":"string","x-stream-index":"008"},"result":{"items":{"additionalProperties":{},"type":"object"},"type":"array","x-stream-index":"011"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","x-stream-index":"013"},"review_queue_item_id":{"type":"string","x-stream-index":"012"},"type":{"type":"string","x-stream-index":"002"},"updated_at":{"type":"string","x-stream-index":"015"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"003"}},"required":["id","type","entity_type","entity_id","created_at","updated_at"],"type":"object"},"ModerationFlaggedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"item":{"type":"string","x-stream-index":"001"},"object_id":{"type":"string","x-stream-index":"002"},"type":{"default":"moderation.flagged","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationFlaggedEvent","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"},"ModerationMarkReviewedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"001"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"002"},"type":{"default":"moderation.mark_reviewed","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationMarkReviewedEvent","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"},"ModerationPayload":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"images":{"items":{"type":"string"},"maximum":30,"type":"array","x-stream-index":"002"},"texts":{"items":{"type":"string"},"type":"array","x-stream-index":"001"},"videos":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"type":"object"},"ModerationResponse":{"properties":{"action":{"type":"string","x-stream-index":"004"},"explicit":{"format":"float","type":"number","x-stream-index":"002"},"spam":{"format":"float","type":"number","x-stream-index":"003"},"toxic":{"format":"float","type":"number","x-stream-index":"001"}},"required":["toxic","explicit","spam","action","automod_response"],"type":"object"},"ModerationV2Response":{"properties":{"action":{"type":"string","x-stream-index":"001"},"blocklist_matched":{"type":"string","x-stream-index":"005"},"image_harms":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"original_text":{"type":"string","x-stream-index":"002"},"platform_circumvented":{"type":"boolean","x-stream-index":"007"},"semantic_filter_matched":{"type":"string","x-stream-index":"006"},"text_harms":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"required":["action","original_text"],"type":"object"},"MuteChannelRequest":{"nullable":true,"properties":{"channel_cids":{"description":"Channel CIDs to mute (if multiple channels)","items":{"type":"string"},"maximum":25,"title":"Channel CIDs","type":"array","x-stream-index":"002"},"expiration":{"description":"Duration of mute in milliseconds","title":"Expiration","type":"integer","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"type":"object"},"MuteChannelResponse":{"nullable":true,"properties":{"channel_mute":{"$ref":"#/components/schemas/ChannelMute","description":"Object with channel mute (if one channel was muted)","title":"Channel mute","x-stream-index":"001"},"channel_mutes":{"description":"Object with mutes (if multiple channels were muted)","items":{"$ref":"#/components/schemas/ChannelMute"},"title":"Channel mutes","type":"array","x-stream-index":"002"},"duration":{"type":"string","x-stream-index":"004.001"},"own_user":{"$ref":"#/components/schemas/OwnUser","description":"Authorized user object with fresh mutes information","title":"Own user","x-stream-index":"003"}},"required":["duration"],"type":"object"},"MuteRequest":{"nullable":true,"properties":{"target_ids":{"description":"User IDs to mute (if multiple users)","items":{"type":"string"},"title":"Target IDs","type":"array","x-stream-index":"001"},"timeout":{"description":"Duration of mute in minutes","minimum":0,"title":"Timeout","type":"integer","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"required":["target_ids"],"title":"MuteRequest","type":"object"},"MuteResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"004.001"},"mutes":{"description":"Object with mutes (if multiple users were muted)","items":{"$ref":"#/components/schemas/UserMute"},"title":"Mutes","type":"array","x-stream-index":"001"},"non_existing_users":{"description":"A list of users that can't be found. Common cause for this is deleted users","items":{"type":"string"},"title":"Non Existing Users","type":"array","x-stream-index":"003"},"own_user":{"$ref":"#/components/schemas/OwnUser","description":"Authorized user object with fresh mutes information","title":"Own User","x-stream-index":"002"}},"required":["duration"],"title":"MuteResponse","type":"object"},"NoiseCancellationSettings":{"properties":{"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode"],"type":"object"},"NotificationMarkUnreadEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003.004"},"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"003.005"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"first_unread_message_id":{"type":"string","x-stream-index":"005"},"last_read_at":{"format":"date-time","type":"number","x-stream-index":"006"},"last_read_message_id":{"type":"string","x-stream-index":"012"},"team":{"type":"string","x-stream-index":"002.001"},"thread_id":{"type":"string","x-stream-index":"013"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"009"},"type":{"default":"notification.mark_unread","type":"string","x-stream-index":"001.001"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"010"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"008"},"unread_messages":{"format":"int32","type":"integer","x-stream-index":"007"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"011"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count","first_unread_message_id","last_read_at","unread_messages","unread_count","total_unread_count","unread_channels","unread_threads"],"title":"NotificationMarkUnreadEvent","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"},"NotificationSettings":{"properties":{"call_live_started":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"002"},"call_missed":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"006"},"call_notification":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"004"},"call_ring":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"session_started":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"003"}},"required":["enabled","call_live_started","session_started","call_notification","call_ring","call_missed"],"type":"object"},"NullTime":{"type":"object"},"OCRRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"}},"required":["label","action"],"type":"object"},"OnlyUserID":{"properties":{"id":{"type":"string","x-stream-index":"001"}},"required":["id"],"type":"object"},"OwnUser":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"046"},"banned":{"type":"boolean","x-stream-index":"016"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"045"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"029"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"014"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"013"},"devices":{"items":{"$ref":"#/components/schemas/Device"},"type":"array","x-stream-index":"027"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"023"},"language":{"type":"string","x-stream-index":"035"},"last_active":{"format":"date-time","type":"number","x-stream-index":"011"},"last_engaged_at":{"format":"date-time","type":"number","x-stream-index":"012"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"037"},"mutes":{"items":{"$ref":"#/components/schemas/UserMute"},"type":"array","x-stream-index":"028"},"online":{"type":"boolean","x-stream-index":"022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"026"},"push_preferences":{"$ref":"#/components/schemas/PushPreferences","x-stream-index":"025"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"005"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"031"},"total_unread_count_by_team":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"032"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"033"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"030"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"034"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"}},"required":["id","role","custom","created_at","updated_at","banned","online","devices","mutes","channel_mutes","unread_count","total_unread_count","total_unread_count_by_team","unread_channels","unread_threads","language"],"type":"object"},"OwnUserResponse":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"banned":{"type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"015"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.011"},"devices":{"items":{"$ref":"#/components/schemas/DeviceResponse"},"title":"Devices","type":"array","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001.001"},"image":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"005"},"language":{"type":"string","x-stream-index":"001.005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"001.014"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"013"},"mutes":{"items":{"$ref":"#/components/schemas/UserMuteResponse"},"type":"array","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"001.002"},"online":{"type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"003"},"push_preferences":{"$ref":"#/components/schemas/PushPreferences","x-stream-index":"002"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.015"},"role":{"type":"string","x-stream-index":"001.006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"009"},"total_unread_count_by_team":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"010"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"011"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"008"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"012"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","devices","invisible","mutes","channel_mutes","unread_count","total_unread_count","unread_channels","unread_threads"],"type":"object"},"PagerResponse":{"properties":{"next":{"type":"string","x-stream-index":"001"},"prev":{"type":"string","x-stream-index":"002"}},"type":"object"},"PaginationParams":{"properties":{"limit":{"format":"int32","minimum":0,"type":"integer","x-stream-index":"001"},"offset":{"format":"int32","type":"integer","x-stream-index":"002"}},"type":"object"},"PendingMessageEvent":{"description":"Pending message event for async moderation","nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"002.007"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"message":{"$ref":"#/components/schemas/Message","description":"The pending message","title":"Message","x-stream-index":"002.009"},"metadata":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"002.010"},"method":{"description":"The method used for the pending message","title":"Method","type":"string","x-stream-index":"003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"type":{"default":"message.pending","description":"The type of event: \"message.pending\" in this case","title":"Event Type","type":"string","x-stream-index":"001.002"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.002"}},"required":["type","custom","method","created_at"],"title":"PendingMessageEvent","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"},"PendingMessageResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"003"},"metadata":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"}},"type":"object"},"Permission":{"properties":{"action":{"description":"Action name this permission is for (e.g. SendMessage)","title":"Action","type":"string","x-stream-index":"004"},"condition":{"additionalProperties":{},"description":"MongoDB style condition which decides whether or not the permission is granted","title":"Condition","type":"object","x-stream-index":"007"},"custom":{"description":"Whether this is a custom permission or built-in","title":"Custom","type":"boolean","x-stream-index":"009"},"description":{"description":"Description of the permission","title":"Description","type":"string","x-stream-index":"003"},"id":{"description":"Unique permission ID","title":"ID","type":"string","x-stream-index":"001"},"level":{"description":"Level at which permission could be applied (app or channel)","enum":["app","channel"],"title":"Level","type":"string","x-stream-index":"010"},"name":{"description":"Name of the permission","title":"Name","type":"string","x-stream-index":"002"},"owner":{"description":"Whether this permission applies to resource owner or not","title":"Owner","type":"boolean","x-stream-index":"005"},"same_team":{"description":"Whether this permission applies to teammates (multi-tenancy mode only)","title":"Same team","type":"boolean","x-stream-index":"006"},"tags":{"description":"List of tags of the permission","items":{"type":"string"},"title":"Tags","type":"array","x-stream-index":"011"}},"required":["id","name","description","action","owner","same_team","custom","level","tags"],"type":"object"},"Policy":{"properties":{"action":{"type":"integer","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"010"},"name":{"type":"string","x-stream-index":"004"},"owner":{"type":"boolean","x-stream-index":"008"},"priority":{"format":"int32","type":"integer","x-stream-index":"009"},"resources":{"items":{"type":"string"},"type":"array","x-stream-index":"005"},"roles":{"items":{"type":"string"},"type":"array","x-stream-index":"006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"011"}},"required":["name","resources","roles","action","owner","priority","created_at","updated_at"],"type":"object"},"PolicyRequest":{"description":"Policy request","properties":{"action":{"enum":["Deny","Allow"],"title":"Action","type":"string","x-stream-index":"001"},"name":{"description":"User-friendly policy name","title":"Name","type":"string","x-stream-index":"002"},"owner":{"description":"Whether policy applies to resource owner or not","title":"Owner","type":"boolean","x-stream-index":"005"},"priority":{"description":"Policy priority","format":"int32","maximum":999,"minimum":1,"title":"Priority","type":"integer","x-stream-index":"006"},"resources":{"description":"List of resources to apply policy to","items":{"type":"string"},"minimum":1,"title":"Resources","type":"array","x-stream-index":"003"},"roles":{"description":"List of roles to apply policy to","items":{"type":"string"},"title":"Roles","type":"array","x-stream-index":"004"}},"required":["action","name","resources","roles","owner","priority"],"title":"PolicyRequest","type":"object"},"Poll":{"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"023"},"allow_answers":{"type":"boolean","x-stream-index":"010"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"009"},"answers_count":{"format":"int32","type":"integer","x-stream-index":"015"},"created_at":{"format":"date-time","type":"number","x-stream-index":"021"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"020"},"created_by_id":{"type":"string","x-stream-index":"019"},"description":{"type":"string","x-stream-index":"005"},"enforce_unique_vote":{"type":"boolean","x-stream-index":"007"},"id":{"type":"string","x-stream-index":"003"},"is_closed":{"type":"boolean","x-stream-index":"011"},"latest_answers":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array","x-stream-index":"017"},"latest_votes_by_option":{"additionalProperties":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array"},"type":"object","x-stream-index":"016"},"max_votes_allowed":{"format":"int32","type":"integer","x-stream-index":"008"},"name":{"type":"string","x-stream-index":"004"},"options":{"items":{"$ref":"#/components/schemas/PollOption"},"type":"array","x-stream-index":"013"},"own_votes":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array","x-stream-index":"018"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"022"},"vote_count":{"format":"int32","type":"integer","x-stream-index":"012"},"vote_counts_by_option":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"014"},"voting_visibility":{"type":"string","x-stream-index":"006"}},"required":["id","name","description","enforce_unique_vote","allow_user_suggested_options","allow_answers","vote_count","options","vote_counts_by_option","answers_count","latest_votes_by_option","latest_answers","own_votes","created_by_id","created_at","updated_at","Custom"],"type":"object"},"PollOption":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id","text","custom"],"type":"object"},"PollOptionInput":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"text":{"type":"string","x-stream-index":"002"}},"type":"object"},"PollOptionRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id"],"type":"object"},"PollOptionResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"poll_option":{"$ref":"#/components/schemas/PollOptionResponseData","description":"Poll option","title":"PollOptionResponseData","x-stream-index":"001"}},"required":["poll_option","duration"],"type":"object"},"PollOptionResponseData":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id","text","custom"],"type":"object"},"PollResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"poll":{"$ref":"#/components/schemas/PollResponseData","description":"Poll","title":"PollResponseData","x-stream-index":"001"}},"required":["poll","duration"],"type":"object"},"PollResponseData":{"properties":{"allow_answers":{"type":"boolean","x-stream-index":"008"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"007"},"answers_count":{"format":"int32","type":"integer","x-stream-index":"012"},"created_at":{"format":"date-time","type":"number","x-stream-index":"019"},"created_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"018"},"created_by_id":{"type":"string","x-stream-index":"017"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"021"},"description":{"type":"string","x-stream-index":"003"},"enforce_unique_vote":{"type":"boolean","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"is_closed":{"type":"boolean","x-stream-index":"009"},"latest_answers":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array","x-stream-index":"015"},"latest_votes_by_option":{"additionalProperties":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array"},"type":"object","x-stream-index":"014"},"max_votes_allowed":{"format":"int32","type":"integer","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"002"},"options":{"items":{"$ref":"#/components/schemas/PollOptionResponseData"},"type":"array","x-stream-index":"011"},"own_votes":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array","x-stream-index":"016"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"020"},"vote_count":{"format":"int32","type":"integer","x-stream-index":"010"},"vote_counts_by_option":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"013"},"voting_visibility":{"type":"string","x-stream-index":"004"}},"required":["id","name","description","voting_visibility","enforce_unique_vote","allow_user_suggested_options","allow_answers","vote_count","options","answers_count","vote_counts_by_option","latest_votes_by_option","latest_answers","own_votes","created_by_id","created_at","updated_at","custom"],"type":"object"},"PollVote":{"nullable":true,"properties":{"answer_text":{"type":"string","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"004"},"is_answer":{"type":"boolean","x-stream-index":"006"},"option_id":{"type":"string","x-stream-index":"005"},"poll_id":{"type":"string","x-stream-index":"003"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"011"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"009"},"user_id":{"type":"string","x-stream-index":"008"}},"required":["poll_id","id","option_id","created_at","updated_at"],"type":"object"},"PollVoteResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"vote":{"$ref":"#/components/schemas/PollVoteResponseData","description":"Poll vote","title":"PollVoteResponseData","x-stream-index":"001"}},"required":["duration"],"type":"object"},"PollVoteResponseData":{"nullable":true,"properties":{"answer_text":{"type":"string","x-stream-index":"005"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"id":{"type":"string","x-stream-index":"002"},"is_answer":{"type":"boolean","x-stream-index":"004"},"option_id":{"type":"string","x-stream-index":"003"},"poll_id":{"type":"string","x-stream-index":"001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"007"},"user_id":{"type":"string","x-stream-index":"006"}},"required":["poll_id","id","option_id","created_at","updated_at"],"type":"object"},"PollVotesResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"votes":{"description":"Poll votes","items":{"$ref":"#/components/schemas/PollVoteResponseData"},"title":"PollVoteResponseList","type":"array","x-stream-index":"001"}},"required":["votes","duration"],"type":"object"},"PrivacySettings":{"properties":{"read_receipts":{"$ref":"#/components/schemas/ReadReceipts","x-stream-index":"002"},"typing_indicators":{"$ref":"#/components/schemas/TypingIndicators","x-stream-index":"001"}},"type":"object"},"PrivacySettingsResponse":{"properties":{"read_receipts":{"$ref":"#/components/schemas/ReadReceiptsResponse","x-stream-index":"002"},"typing_indicators":{"$ref":"#/components/schemas/TypingIndicatorsResponse","x-stream-index":"001"}},"type":"object"},"PushConfig":{"properties":{"offline_only":{"type":"boolean","x-stream-index":"002"},"version":{"enum":["v1","v2","v3"],"type":"string","x-stream-index":"001"}},"required":["version"],"type":"object"},"PushNotificationFields":{"properties":{"apn":{"$ref":"#/components/schemas/APNConfigFields","x-stream-index":"002"},"firebase":{"$ref":"#/components/schemas/FirebaseConfigFields","x-stream-index":"003"},"huawei":{"$ref":"#/components/schemas/HuaweiConfigFields","x-stream-index":"004"},"offline_only":{"type":"boolean","x-stream-index":"001.002"},"providers":{"items":{"$ref":"#/components/schemas/PushProvider"},"type":"array","x-stream-index":"006"},"version":{"type":"string","x-stream-index":"001.001"},"xiaomi":{"$ref":"#/components/schemas/XiaomiConfigFields","x-stream-index":"005"}},"required":["version","offline_only","apn","firebase","huawei","xiaomi"],"type":"object"},"PushNotificationSettingsResponse":{"properties":{"disabled":{"type":"boolean","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"number","x-stream-index":"002"}},"type":"object"},"PushPreferenceInput":{"nullable":true,"properties":{"call_level":{"description":"Set the level of call push notifications for the user. One of all, none, default","enum":["all","none","default"],"type":"string","x-stream-index":"004"},"channel_cid":{"description":"Set the push preferences for a specific channel. If empty it sets the default for the user","type":"string","x-stream-index":"002"},"chat_level":{"description":"Set the level of chat push notifications for the user. One of all, mentions, none, default","enum":["all","mentions","none","default"],"type":"string","x-stream-index":"003"},"disabled_until":{"description":"Disable push notifications till a certain time","format":"date-time","type":"number","x-stream-index":"005"},"remove_disable":{"description":"Remove the disabled until time. (IE stop snoozing notifications)","type":"boolean","x-stream-index":"006"},"user_id":{"description":"The user id for which to set the push preferences. Required when using server side auths, defaults to current user with client side auth.","type":"string","x-stream-index":"001"}},"type":"object"},"PushPreferences":{"properties":{"call_level":{"type":"string","x-stream-index":"002"},"chat_level":{"type":"string","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"number","x-stream-index":"003"}},"type":"object"},"PushProvider":{"nullable":true,"properties":{"apn_auth_key":{"type":"string","x-stream-index":"012"},"apn_auth_type":{"type":"string","x-stream-index":"017"},"apn_development":{"type":"boolean","x-stream-index":"018"},"apn_host":{"type":"string","x-stream-index":"019"},"apn_key_id":{"type":"string","x-stream-index":"013"},"apn_notification_template":{"type":"string","x-stream-index":"020"},"apn_p12_cert":{"type":"string","x-stream-index":"014"},"apn_team_id":{"type":"string","x-stream-index":"015"},"apn_topic":{"type":"string","x-stream-index":"016"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"description":{"maxLength":128,"type":"string","x-stream-index":"007"},"disabled_at":{"format":"date-time","type":"number","x-stream-index":"010"},"disabled_reason":{"maxLength":255,"type":"string","x-stream-index":"011"},"firebase_apn_template":{"type":"string","x-stream-index":"025"},"firebase_credentials":{"type":"string","x-stream-index":"022"},"firebase_data_template":{"type":"string","x-stream-index":"023"},"firebase_host":{"type":"string","x-stream-index":"026"},"firebase_notification_template":{"type":"string","x-stream-index":"024"},"firebase_server_key":{"type":"string","x-stream-index":"021"},"huawei_app_id":{"type":"string","x-stream-index":"027"},"huawei_app_secret":{"type":"string","x-stream-index":"028"},"name":{"maxLength":36,"minLength":1,"type":"string","x-stream-index":"005"},"push_templates":{"items":{"$ref":"#/components/schemas/PushTemplate"},"type":"array","x-stream-index":"031"},"type":{"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"xiaomi_app_secret":{"type":"string","x-stream-index":"030"},"xiaomi_package_name":{"type":"string","x-stream-index":"029"}},"required":["name","type","created_at","updated_at"],"type":"object"},"PushProviderResponse":{"properties":{"apn_auth_key":{"type":"string","x-stream-index":"008"},"apn_auth_type":{"type":"string","x-stream-index":"013"},"apn_development":{"type":"boolean","x-stream-index":"014"},"apn_host":{"type":"string","x-stream-index":"015"},"apn_key_id":{"type":"string","x-stream-index":"009"},"apn_p12_cert":{"type":"string","x-stream-index":"010"},"apn_sandbox_certificate":{"type":"boolean","x-stream-index":"016"},"apn_supports_remote_notifications":{"type":"boolean","x-stream-index":"018"},"apn_supports_voip_notifications":{"type":"boolean","x-stream-index":"017"},"apn_team_id":{"type":"string","x-stream-index":"011"},"apn_topic":{"type":"string","x-stream-index":"012"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"description":{"type":"string","x-stream-index":"003"},"disabled_at":{"format":"date-time","type":"number","x-stream-index":"006"},"disabled_reason":{"type":"string","x-stream-index":"007"},"firebase_apn_template":{"type":"string","x-stream-index":"023"},"firebase_credentials":{"type":"string","x-stream-index":"020"},"firebase_data_template":{"type":"string","x-stream-index":"021"},"firebase_host":{"type":"string","x-stream-index":"024"},"firebase_notification_template":{"type":"string","x-stream-index":"022"},"firebase_server_key":{"type":"string","x-stream-index":"019"},"huawei_app_id":{"type":"string","x-stream-index":"025"},"huawei_app_secret":{"type":"string","x-stream-index":"026"},"name":{"type":"string","x-stream-index":"001"},"type":{"type":"string","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"005"},"xiaomi_app_secret":{"type":"string","x-stream-index":"028"},"xiaomi_package_name":{"type":"string","x-stream-index":"027"}},"required":["name","type","created_at","updated_at"],"type":"object"},"PushTemplate":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"enable_push":{"type":"boolean","x-stream-index":"003"},"event_type":{"enum":["message.new","message.updated","reaction.new","notification.reminder_due"],"type":"string","x-stream-index":"005"},"template":{"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"008"}},"required":["enable_push","event_type","created_at","updated_at"],"type":"object"},"Quality":{"properties":{"bitdepth":{"format":"int32","type":"integer","x-stream-index":"007"},"framerate":{"format":"int32","type":"integer","x-stream-index":"008"},"height":{"format":"int32","type":"integer","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"004"},"video_bitrate":{"format":"int32","type":"integer","x-stream-index":"009"},"width":{"format":"int32","type":"integer","x-stream-index":"005"}},"type":"object"},"QueryBannedUsersPayload":{"properties":{"exclude_expired_bans":{"description":"Whether to exclude expired bans or not","title":"Exclude expired bans","type":"boolean","x-stream-index":"004"},"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"description":"Number of records to return","format":"int32","maximum":300,"minimum":0,"title":"Limit","type":"integer","x-stream-index":"003.003"},"offset":{"description":"Number of records to offset","format":"int32","maximum":10000,"title":"Offset","type":"integer","x-stream-index":"003.004"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":1,"title":"Sort","type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"005.002"},"user_id":{"type":"string","x-stream-index":"005.001"}},"required":["filter_conditions"],"type":"object"},"QueryBannedUsersResponse":{"nullable":true,"properties":{"bans":{"description":"List of found bans","items":{"$ref":"#/components/schemas/BanResponse"},"title":"BanResponse","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["bans","duration"],"type":"object"},"QueryCampaignsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"004.001"},"next":{"type":"string","x-stream-index":"004.002"},"prev":{"type":"string","x-stream-index":"004.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"type":"array","x-stream-index":"002"},"user_limit":{"format":"int32","maximum":1000,"minimum":0,"type":"integer","x-stream-index":"003"}},"type":"object"},"QueryCampaignsResponse":{"description":"Basic response information","nullable":true,"properties":{"campaigns":{"items":{"$ref":"#/components/schemas/CampaignResponse"},"type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["campaigns","duration"],"title":"Response","type":"object"},"QueryChannelsRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"description":"Number of channels to limit","format":"int32","title":"Limit","type":"integer","x-stream-index":"008"},"member_limit":{"description":"Number of members to limit","format":"int32","maximum":100,"minimum":0,"title":"Member limit","type":"integer","x-stream-index":"007"},"message_limit":{"description":"Number of messages to limit","format":"int32","minimum":0,"title":"Message limit","type":"integer","x-stream-index":"006"},"offset":{"description":"Channel pagination offset","format":"int32","title":"Offset","type":"integer","x-stream-index":"009"},"sort":{"description":"List of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"002"},"state":{"description":"Whether to update channel state or not","title":"State","type":"boolean","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"010.002"},"user_id":{"type":"string","x-stream-index":"010.001"}},"title":"Query Channels Request","type":"object","x-stream-docs-page-id":"query_channels"},"QueryChannelsResponse":{"nullable":true,"properties":{"channels":{"description":"List of channels","items":{"$ref":"#/components/schemas/ChannelStateResponseFields"},"title":"Channels","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["channels","duration"],"title":"Channels list","type":"object"},"QueryDraftsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","maximum":3,"title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"type":"object"},"QueryDraftsResponse":{"nullable":true,"properties":{"drafts":{"description":"Drafts","items":{"$ref":"#/components/schemas/DraftResponse"},"title":"DraftsResponseList","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["drafts","duration"],"type":"object"},"QueryFeedModerationTemplate":{"properties":{"config":{"$ref":"#/components/schemas/FeedsModerationTemplateConfig","description":"Configuration for the moderation template","title":"Config","x-stream-index":"002"},"created_at":{"description":"When the template was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"003"},"name":{"description":"Name of the moderation template","title":"Name","type":"string","x-stream-index":"001"},"updated_at":{"description":"When the template was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"004"}},"required":["name","created_at","updated_at"],"type":"object"},"QueryFeedModerationTemplatesResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"templates":{"description":"List of moderation templates","items":{"$ref":"#/components/schemas/QueryFeedModerationTemplate"},"title":"Templates","type":"array","x-stream-index":"001"}},"required":["templates","duration"],"type":"object"},"QueryMembersPayload":{"description":"Client request","properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"002"},"limit":{"format":"int32","maximum":300,"minimum":0,"type":"integer","x-stream-index":"006.003"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"type":"array","x-stream-index":"003"},"offset":{"format":"int32","maximum":10000,"type":"integer","x-stream-index":"006.004"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":1,"type":"array","x-stream-index":"005"},"type":{"maxLength":64,"type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"007.002"},"user_id":{"type":"string","x-stream-index":"007.001"}},"required":["type","filter_conditions"],"title":"ClientRequest","type":"object"},"QueryMessageFlagsPayload":{"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":300,"minimum":0,"type":"integer","x-stream-index":"003.003"},"offset":{"format":"int32","maximum":10000,"type":"integer","x-stream-index":"003.004"},"show_deleted_messages":{"description":"Whether to include deleted messages in the results","title":"ShowDeletedMessages","type":"boolean","x-stream-index":"002"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"type":"array","x-stream-index":"003.005"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"type":"object"},"QueryMessageFlagsResponse":{"description":"Query message flags response","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"flags":{"description":"The flags that match the query","items":{"$ref":"#/components/schemas/MessageFlagResponse"},"title":"MessageFlagResponseList","type":"array","x-stream-index":"001"}},"required":["flags","duration"],"title":"QueryMessageFlagsResponse","type":"object"},"QueryMessageHistoryRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","maximum":3,"minimum":1,"title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"004.001"},"next":{"type":"string","x-stream-index":"004.002"},"prev":{"type":"string","x-stream-index":"004.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"002"}},"required":["filter"],"type":"object"},"QueryMessageHistoryResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message_history":{"description":"Message history entries","items":{"$ref":"#/components/schemas/MessageHistoryEntryResponse"},"title":"MessageHistoryEntryResponseList","type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["message_history","duration"],"type":"object"},"QueryModerationConfigsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter conditions for moderation configs","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"Sorting parameters for the results","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"type":"object"},"QueryModerationConfigsResponse":{"nullable":true,"properties":{"configs":{"description":"List of moderation configurations","items":{"$ref":"#/components/schemas/ConfigResponse"},"title":"Configs","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["configs","duration"],"type":"object"},"QueryModerationFlagsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParam"},"type":"array","x-stream-index":"002"}},"type":"object"},"QueryModerationFlagsResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"flags":{"items":{"$ref":"#/components/schemas/ModerationFlagResponse"},"type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["flags","duration"],"title":"Response","type":"object"},"QueryModerationLogsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter conditions for moderation logs","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"Sorting parameters for the results","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"type":"object"},"QueryModerationLogsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"003.001"},"logs":{"description":"List of moderation action logs","items":{"$ref":"#/components/schemas/ActionLogResponse"},"title":"Logs","type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["logs","duration"],"type":"object"},"QueryPollVotesRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","title":"Filter","type":"object","x-stream-index":"003"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"004"}},"type":"object"},"QueryPollsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","title":"Filter","type":"object","x-stream-index":"002"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"003"}},"type":"object"},"QueryPollsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"polls":{"description":"Polls data returned by the query","items":{"$ref":"#/components/schemas/PollResponseData"},"title":"PollsResponseData","type":"array","x-stream-index":"001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["polls","duration"],"type":"object"},"QueryReactionsRequest":{"properties":{"filter":{"additionalProperties":{},"type":"object","x-stream-index":"002"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"006.001"},"next":{"type":"string","x-stream-index":"006.002"},"prev":{"type":"string","x-stream-index":"006.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":2,"type":"array","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"type":"object"},"QueryReactionsResponse":{"description":"Basic response information","properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"next":{"type":"string","x-stream-index":"003.001"},"prev":{"type":"string","x-stream-index":"003.002"},"reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"001"}},"required":["reactions","duration"],"title":"Response","type":"object"},"QueryRemindersRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"type":"object"},"QueryRemindersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"reminders":{"description":"MessageReminders data returned by the query","items":{"$ref":"#/components/schemas/ReminderResponseData"},"title":"RemindersResponseData","type":"array","x-stream-index":"001"}},"required":["reminders","duration"],"type":"object"},"QueryReviewQueueRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter conditions for review queue items","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"007.001"},"lock_count":{"description":"Number of items to lock (1-25)","format":"int32","maximum":25,"minimum":1,"title":"Lock Count","type":"integer","x-stream-index":"005"},"lock_duration":{"description":"Duration for which items should be locked","title":"Lock Duration","type":"integer","x-stream-index":"004"},"lock_items":{"description":"Whether to lock items for review (true), unlock items (false), or just fetch (nil)","title":"Lock Items","type":"boolean","x-stream-index":"003"},"next":{"type":"string","x-stream-index":"007.002"},"prev":{"type":"string","x-stream-index":"007.003"},"sort":{"description":"Sorting parameters for the results","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"002"},"stats_only":{"description":"Whether to return only statistics","title":"Stats Only","type":"boolean","x-stream-index":"006"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"008.002"},"user_id":{"type":"string","x-stream-index":"008.001"}},"type":"object"},"QueryReviewQueueResponse":{"nullable":true,"properties":{"action_config":{"additionalProperties":{"items":{"$ref":"#/components/schemas/ModerationActionConfig"},"type":"array"},"description":"Configuration for moderation actions","title":"Action Config","type":"object","x-stream-index":"002"},"duration":{"type":"string","x-stream-index":"005.001"},"items":{"description":"List of review queue items","items":{"$ref":"#/components/schemas/ReviewQueueItemResponse"},"title":"Items","type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"004.001"},"prev":{"type":"string","x-stream-index":"004.002"},"stats":{"additionalProperties":{},"description":"Statistics about the review queue","title":"Stats","type":"object","x-stream-index":"003"}},"required":["items","action_config","stats","duration"],"type":"object"},"QuerySegmentTargetsRequest":{"nullable":true,"properties":{"Filter":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"005"},"Sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"type":"array","writeOnly":true,"x-stream-index":"006"},"limit":{"description":"Limit","format":"int32","maximum":10000,"minimum":0,"title":"int","type":"integer","x-stream-index":"002"},"next":{"description":"Next","title":"string","type":"string","x-stream-index":"003"},"prev":{"description":"Prev","title":"string","type":"string","x-stream-index":"004"}},"type":"object"},"QuerySegmentTargetsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"targets":{"description":"Targets","items":{"$ref":"#/components/schemas/SegmentTargetResponse"},"title":"SegmentTargetResponseList","type":"array","x-stream-index":"001"}},"required":["targets","duration"],"type":"object"},"QuerySegmentsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"002"}},"required":["filter"],"type":"object"},"QuerySegmentsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"segments":{"description":"Segments","items":{"$ref":"#/components/schemas/SegmentResponse"},"title":"SegmentResponses","type":"array","x-stream-index":"001"}},"required":["segments","duration"],"type":"object"},"QueryThreadsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter conditions to apply to threads","title":"Filter","type":"object","x-stream-index":"006"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"008.001"},"member_limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005"},"next":{"type":"string","x-stream-index":"008.002"},"participant_limit":{"description":"Limit the number of participants returned per each thread","format":"int32","maximum":100,"minimum":0,"title":"Participant limit","type":"integer","x-stream-index":"004"},"prev":{"type":"string","x-stream-index":"008.003"},"reply_limit":{"description":"Limit the number of replies returned per each thread","format":"int32","maximum":10,"minimum":0,"title":"Reply limit","type":"integer","x-stream-index":"003"},"sort":{"description":"Sort conditions to apply to threads","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"007"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"010.002"},"user_id":{"type":"string","x-stream-index":"010.001"}},"type":"object"},"QueryThreadsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"threads":{"description":"List of enriched thread states","items":{"$ref":"#/components/schemas/ThreadStateResponse"},"title":"Threads","type":"array","x-stream-index":"001"}},"required":["threads","duration"],"type":"object"},"QueryUsersPayload":{"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"include_deactivated_users":{"type":"boolean","x-stream-index":"004"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.003"},"offset":{"format":"int32","maximum":1000,"type":"integer","x-stream-index":"005.004"},"presence":{"type":"boolean","x-stream-index":"003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"006.002"},"user_id":{"type":"string","x-stream-index":"006.001"}},"required":["filter_conditions"],"type":"object"},"QueryUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"users":{"description":"Array of users as result of filters applied.","items":{"$ref":"#/components/schemas/FullUserResponse"},"title":"Users","type":"array","x-stream-index":"001"}},"required":["users","duration"],"type":"object"},"RTMPEgressConfig":{"properties":{"composite_app_settings":{"$ref":"#/components/schemas/CompositeAppSettings","x-stream-index":"005"},"quality":{"$ref":"#/components/schemas/Quality","x-stream-index":"004"},"rtmp_location":{"type":"string","x-stream-index":"006"}},"type":"object"},"RTMPIngress":{"description":"RTMP input settings","properties":{"address":{"title":"Address","type":"string","x-stream-index":"001"}},"required":["address"],"title":"RTMPIngress","type":"object"},"RTMPLocation":{"properties":{"name":{"type":"string","x-stream-index":"001"},"stream_key":{"type":"string","x-stream-index":"003"},"stream_url":{"type":"string","x-stream-index":"002"}},"required":["name","stream_url","stream_key"],"type":"object"},"RTMPSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"003"},"location":{"$ref":"#/components/schemas/RTMPLocation","x-stream-index":"004"},"quality_name":{"type":"string","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"RTMPSettingsResponse":{"description":"RTMPSettingsResponse is the payload for RTMP settings","properties":{"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettingsResponse","title":"Layout","x-stream-index":"003"},"quality":{"title":"Quality","type":"string","x-stream-index":"002"}},"required":["enabled","quality","layout"],"title":"RTMPSettingsResponse","type":"object"},"Reaction":{"nullable":true,"properties":{"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"message_id":{"type":"string","x-stream-index":"003"},"score":{"format":"int32","type":"integer","x-stream-index":"007"},"type":{"maxLength":30,"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["message_id","type","score","created_at","updated_at","custom"],"type":"object"},"ReactionDeletedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"006.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"002"},"team":{"type":"string","x-stream-index":"005.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"reaction.deleted","type":"string","x-stream-index":"006.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"ReactionDeletedEvent","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"},"ReactionGroupResponse":{"description":"ReactionGroupResponse contains all information about a reaction of the same type.","nullable":true,"properties":{"count":{"description":"Count is the number of reactions of this type.","format":"int32","title":"Count","type":"integer","x-stream-index":"001"},"first_reaction_at":{"description":"FirstReactionAt is the time of the first reaction of this type. This is the same also if all reaction of this type are deleted, because if someone will react again with the same type, will be preserved the sorting.","format":"date-time","title":"FirstReactionAt","type":"number","x-stream-index":"003"},"last_reaction_at":{"description":"LastReactionAt is the time of the last reaction of this type.","format":"date-time","title":"LastReactionAt","type":"number","x-stream-index":"004"},"sum_scores":{"description":"SumScores is the sum of all scores of reactions of this type. Medium allows you to clap articles more than once and shows the sum of all claps from all users. For example, you can send `clap` x5 using `score: 5`.","format":"int32","title":"SumScores","type":"integer","x-stream-index":"002"}},"required":["count","sum_scores","first_reaction_at","last_reaction_at"],"title":"ReactionGroupResponse","type":"object"},"ReactionNewEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"006.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"002"},"team":{"type":"string","x-stream-index":"005.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"reaction.new","type":"string","x-stream-index":"006.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"ReactionNewEvent","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"},"ReactionRequest":{"description":"Represents user reaction to a message","properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"score":{"description":"Reaction score. If not specified reaction has score of 1","format":"int32","title":"Score","type":"integer","x-stream-index":"002"},"type":{"description":"The type of reaction (e.g. 'like', 'laugh', 'wow')","maxLength":30,"title":"Type","type":"string","x-stream-index":"001"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"006.002"},"user_id":{"type":"string","x-stream-index":"006.001"}},"required":["type"],"title":"Reaction","type":"object","x-stream-docs-page-id":"send_reaction"},"ReactionResponse":{"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"006"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"008"},"message_id":{"description":"Message ID","title":"Message ID","type":"string","x-stream-index":"001"},"score":{"description":"Score of the reaction","format":"int32","title":"Score","type":"integer","x-stream-index":"005"},"type":{"description":"Type of reaction","title":"Type","type":"string","x-stream-index":"004"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"007"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User","title":"UserResponse","x-stream-index":"003"},"user_id":{"description":"User ID","title":"User ID","type":"string","x-stream-index":"002"}},"required":["message_id","user_id","user","type","score","created_at","updated_at","custom"],"type":"object"},"ReactionUpdatedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"006.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"002"},"team":{"type":"string","x-stream-index":"005.001"},"type":{"default":"reaction.updated","type":"string","x-stream-index":"006.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["message","reaction","cid","channel_id","channel_type","type","created_at"],"title":"ReactionUpdatedEvent","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"},"ReactivateUserRequest":{"nullable":true,"properties":{"created_by_id":{"description":"ID of the user who's reactivating the user","title":"Created by ID","type":"string","x-stream-index":"004"},"name":{"description":"Set this field to put new name for the user","title":"Name","type":"string","x-stream-index":"003"},"restore_messages":{"description":"Restore previously deleted messages","title":"Restore messages","type":"boolean","x-stream-index":"002"}},"type":"object"},"ReactivateUserResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.002.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Deactivated user object","title":"User","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"ReactivateUsersRequest":{"description":"Reactivate users in batches","nullable":true,"properties":{"created_by_id":{"description":"ID of the user who's reactivating the users","title":"Created by ID","type":"string","x-stream-index":"003"},"restore_channels":{"type":"boolean","x-stream-index":"004"},"restore_messages":{"description":"Restore previously deleted messages","title":"Restore messages","type":"boolean","x-stream-index":"002"},"user_ids":{"description":"User IDs to reactivate","items":{"type":"string"},"maximum":100,"minimum":1,"title":"User IDs","type":"array","x-stream-index":"001"}},"required":["user_ids"],"title":"ReactivateUsersRequest","type":"object"},"ReactivateUsersResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.002.001"},"task_id":{"type":"string","x-stream-index":"001.001"}},"required":["task_id","duration"],"title":"Response","type":"object"},"ReadReceipts":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"ReadReceiptsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"ReadStateResponse":{"properties":{"last_read":{"format":"date-time","type":"number","x-stream-index":"002"},"last_read_message_id":{"type":"string","x-stream-index":"004"},"unread_messages":{"format":"int32","type":"integer","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"}},"required":["user","last_read","unread_messages"],"type":"object"},"RecordSettings":{"properties":{"audio_only":{"type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"004"},"mode":{"type":"string","x-stream-index":"002"},"quality":{"type":"string","x-stream-index":"003"}},"required":["mode"],"type":"object"},"RecordSettingsResponse":{"description":"RecordSettings is the payload for recording settings","properties":{"audio_only":{"title":"Audio Only","type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettingsResponse","title":"Layout","x-stream-index":"004"},"mode":{"title":"Mode","type":"string","x-stream-index":"002"},"quality":{"title":"Quality","type":"string","x-stream-index":"003"}},"required":["audio_only","mode","quality","layout"],"title":"RecordSettingsResponse","type":"object"},"RecordingEgressConfig":{"properties":{"audio_only":{"type":"boolean","x-stream-index":"006"},"composite_app_settings":{"$ref":"#/components/schemas/CompositeAppSettings","x-stream-index":"005"},"external_storage":{"$ref":"#/components/schemas/ExternalStorage","x-stream-index":"008"},"quality":{"$ref":"#/components/schemas/Quality","x-stream-index":"004"},"storage_name":{"type":"string","x-stream-index":"007"},"video_orientation_hint":{"$ref":"#/components/schemas/VideoOrientation","x-stream-index":"009"}},"type":"object"},"ReminderCreatedEvent":{"description":"Emitted when a reminder is created.","nullable":true,"properties":{"cid":{"description":"The CID of the Channel for which the reminder was created","title":"Channel CID","type":"string","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.007"},"message_id":{"description":"The ID of the message for which the reminder was created","title":"Message ID","type":"string","x-stream-index":"001.002"},"parent_id":{"description":"The ID of the parent message, if the reminder is for a thread message","title":"Parent ID","type":"string","x-stream-index":"001.005"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","description":"The reminder object which was created","title":"MessageReminder","x-stream-index":"001.006"},"type":{"default":"reminder.created","description":"The type of event: \"reminder.created\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.002"},"user_id":{"description":"The ID of the user for whom the reminder was created","title":"User ID","type":"string","x-stream-index":"001.003"}},"required":["type","created_at","custom","message_id","user_id","cid"],"title":"ReminderCreatedEvent","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"},"ReminderDeletedEvent":{"description":"Emitted when a reminder is deleted.","nullable":true,"properties":{"cid":{"description":"The CID of the Channel for which the reminder was created","title":"Channel CID","type":"string","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.007"},"message_id":{"description":"The ID of the message for which the reminder was created","title":"Message ID","type":"string","x-stream-index":"001.002"},"parent_id":{"description":"The ID of the parent message, if the reminder is for a thread message","title":"Parent ID","type":"string","x-stream-index":"001.005"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","description":"The reminder object which was created","title":"MessageReminder","x-stream-index":"001.006"},"type":{"default":"reminder.deleted","description":"The type of event: \"reminder.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.002"},"user_id":{"description":"The ID of the user for whom the reminder was created","title":"User ID","type":"string","x-stream-index":"001.003"}},"required":["type","created_at","custom","message_id","user_id","cid"],"title":"ReminderDeletedEvent","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"},"ReminderNotificationEvent":{"description":"Emitted when a reminder becomes due, triggering a notification for the user.","nullable":true,"properties":{"cid":{"description":"The CID of the Channel for which the reminder was created","title":"Channel CID","type":"string","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.007"},"message_id":{"description":"The ID of the message for which the reminder was created","title":"Message ID","type":"string","x-stream-index":"001.002"},"parent_id":{"type":"string","x-stream-index":"001.005"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","description":"The reminder object which was created","title":"MessageReminder","x-stream-index":"001.006"},"type":{"default":"notification.reminder_due","description":"The type of event: \"notification.reminder_due\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.002"},"user_id":{"description":"The ID of the user for whom the reminder was created","title":"User ID","type":"string","x-stream-index":"001.003"}},"required":["type","created_at","custom","message_id","user_id","cid"],"title":"ReminderNotificationEvent","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"},"ReminderResponseData":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003"},"channel_cid":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"005"},"message_id":{"type":"string","x-stream-index":"004"},"remind_at":{"format":"date-time","type":"number","x-stream-index":"001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007"},"user_id":{"type":"string","x-stream-index":"006"}},"required":["channel_cid","message_id","user_id","created_at","updated_at"],"type":"object"},"ReminderUpdatedEvent":{"description":"Emitted when a reminder is updated.","nullable":true,"properties":{"cid":{"description":"The CID of the Channel for which the reminder was created","title":"Channel CID","type":"string","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.007"},"message_id":{"description":"The ID of the message for which the reminder was created","title":"Message ID","type":"string","x-stream-index":"001.002"},"parent_id":{"description":"The ID of the parent message, if the reminder is for a thread message","title":"Parent ID","type":"string","x-stream-index":"001.005"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","description":"The reminder object which was created","title":"MessageReminder","x-stream-index":"001.006"},"type":{"default":"reminder.updated","description":"The type of event: \"reminder.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.002"},"user_id":{"description":"The ID of the user for whom the reminder was created","title":"User ID","type":"string","x-stream-index":"001.003"}},"required":["type","created_at","custom","message_id","user_id","cid"],"title":"ReminderUpdatedEvent","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"},"Response":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001"}},"required":["duration"],"title":"Response","type":"object"},"RestoreActionRequest":{"type":"object"},"RestoreUsersRequest":{"nullable":true,"properties":{"user_ids":{"items":{"type":"string"},"maximum":100,"minimum":1,"type":"array","x-stream-index":"001"}},"required":["user_ids"],"type":"object"},"ReviewQueueItem":{"properties":{"actions":{"items":{"$ref":"#/components/schemas/ActionLog"},"type":"array","x-stream-index":"035"},"activity":{"$ref":"#/components/schemas/EnrichedActivity","x-stream-index":"028"},"ai_text_severity":{"type":"string","x-stream-index":"021"},"archived_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"043"},"assigned_to":{"$ref":"#/components/schemas/User","x-stream-index":"032"},"bans":{"items":{"$ref":"#/components/schemas/Ban"},"type":"array","x-stream-index":"033"},"bounce_count":{"format":"int32","type":"integer","x-stream-index":"025"},"call":{"$ref":"#/components/schemas/Call","x-stream-index":"031"},"completed_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"018"},"config_key":{"type":"string","x-stream-index":"009"},"content_changed":{"type":"boolean","x-stream-index":"036"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"entity_creator":{"$ref":"#/components/schemas/EntityCreator","x-stream-index":"030"},"entity_id":{"type":"string","x-stream-index":"007"},"entity_type":{"type":"string","x-stream-index":"006"},"feeds_v2_activity":{"$ref":"#/components/schemas/EnrichedActivity","x-stream-index":"041"},"feeds_v2_reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"042"},"flag_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"045"},"flag_types":{"items":{"type":"string"},"type":"array","x-stream-index":"044"},"flags":{"items":{"$ref":"#/components/schemas/Flag"},"type":"array","x-stream-index":"034"},"flags_count":{"format":"int32","type":"integer","x-stream-index":"026"},"has_image":{"type":"boolean","x-stream-index":"012"},"has_text":{"type":"boolean","x-stream-index":"014"},"has_video":{"type":"boolean","x-stream-index":"013"},"id":{"type":"string","x-stream-index":"003"},"languages":{"items":{"type":"string"},"type":"array","x-stream-index":"019"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"027"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"010"},"moderation_payload_hash":{"type":"string","x-stream-index":"011"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"029"},"recommended_action":{"type":"string","x-stream-index":"017"},"reporter_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"046"},"reviewed_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"022"},"reviewed_by":{"type":"string","x-stream-index":"023"},"severity":{"format":"int32","type":"integer","x-stream-index":"020"},"status":{"type":"string","x-stream-index":"016"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"015"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"005"}},"required":["id","created_at","updated_at","entity_type","entity_id","config_key","moderation_payload_hash","has_image","has_video","has_text","teams","status","recommended_action","completed_at","languages","severity","ai_text_severity","reviewed_at","reviewed_by","bounce_count","flags_count","bans","flags","actions","content_changed","archived_at","flag_types","flag_labels","reporter_ids"],"type":"object"},"ReviewQueueItemNewEvent":{"description":"This event is sent when a new moderation review queue item is created","nullable":true,"properties":{"action":{"$ref":"#/components/schemas/ActionLogResponse","description":"The action log if any action was taken","title":"Action","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"flags":{"description":"The flags associated with this review queue item","items":{"$ref":"#/components/schemas/FlagResponse"},"title":"Flags","type":"array","x-stream-index":"003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"The review queue item that was created","title":"ReviewQueueItem","x-stream-index":"002"},"type":{"default":"review_queue_item.new","type":"string","x-stream-index":"001.002"}},"required":["type","created_at","custom"],"title":"ReviewQueueItemNewEvent","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"},"ReviewQueueItemResponse":{"properties":{"actions":{"description":"Moderation actions taken","items":{"$ref":"#/components/schemas/ActionLogResponse"},"title":"Actions","type":"array","x-stream-index":"024"},"activity":{"$ref":"#/components/schemas/EnrichedActivity","x-stream-index":"016"},"ai_text_severity":{"description":"AI-determined text severity","title":"AI Text Severity","type":"string","x-stream-index":"014"},"assigned_to":{"$ref":"#/components/schemas/UserResponse","description":"Moderator assigned to review this item","title":"Assigned To","x-stream-index":"021"},"bans":{"description":"Associated ban records","items":{"$ref":"#/components/schemas/Ban"},"title":"Bans","type":"array","x-stream-index":"022"},"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"018"},"completed_at":{"description":"When the review was completed","format":"date-time","title":"Completed At","type":"number","x-stream-index":"009"},"config_key":{"type":"string","x-stream-index":"028"},"created_at":{"description":"When the item was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"002"},"entity_creator":{"$ref":"#/components/schemas/EntityCreatorResponse","description":"Details about who created the entity","title":"Entity Creator","x-stream-index":"019"},"entity_creator_id":{"description":"ID of who created the entity","title":"Entity Creator ID","type":"string","x-stream-index":"020"},"entity_id":{"description":"ID of the entity being reviewed","title":"Entity ID","type":"string","x-stream-index":"005"},"entity_type":{"description":"Type of entity being reviewed","title":"Entity Type","type":"string","x-stream-index":"004"},"feeds_v2_activity":{"$ref":"#/components/schemas/EnrichedActivity","description":"Associated feed activity","title":"Feeds V2 Activity","x-stream-index":"025"},"feeds_v2_reaction":{"$ref":"#/components/schemas/Reaction","description":"Associated feed reaction","title":"Feeds V2 Reaction","x-stream-index":"026"},"flags":{"description":"Associated flag records","items":{"$ref":"#/components/schemas/FlagResponse"},"title":"Flags","type":"array","x-stream-index":"023"},"flags_count":{"format":"int32","type":"integer","x-stream-index":"029"},"id":{"description":"Unique identifier of the review queue item","title":"ID","type":"string","x-stream-index":"001"},"languages":{"description":"Detected languages in the content","items":{"type":"string"},"title":"Languages","type":"array","x-stream-index":"012"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Associated message details","title":"Message","x-stream-index":"015"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content being moderated","title":"Moderation Payload","x-stream-index":"006"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"017"},"recommended_action":{"description":"Suggested moderation action","title":"Recommended Action","type":"string","x-stream-index":"008"},"reviewed_at":{"description":"When the item was reviewed","format":"date-time","title":"Reviewed At","type":"number","x-stream-index":"010"},"reviewed_by":{"description":"ID of the moderator who reviewed the item","title":"Reviewed By","type":"string","x-stream-index":"011"},"severity":{"description":"Severity level of the content","format":"int32","title":"Severity","type":"integer","x-stream-index":"013"},"status":{"description":"Current status of the review","title":"Status","type":"string","x-stream-index":"007"},"teams":{"description":"Teams associated with this item","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"027"},"updated_at":{"description":"When the item was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"003"}},"required":["id","created_at","updated_at","entity_type","entity_id","status","recommended_action","reviewed_by","languages","severity","ai_text_severity","bans","flags","actions","flags_count"],"type":"object"},"ReviewQueueItemUpdatedEvent":{"description":"This event is sent when a moderation review queue item is updated","nullable":true,"properties":{"action":{"$ref":"#/components/schemas/ActionLogResponse","description":"The action log if any action was taken","title":"Action","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"flags":{"description":"The flags associated with this review queue item","items":{"$ref":"#/components/schemas/FlagResponse"},"title":"Flags","type":"array","x-stream-index":"003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"The review queue item that was updated","title":"ReviewQueueItem","x-stream-index":"002"},"type":{"default":"review_queue_item.updated","type":"string","x-stream-index":"001.002"}},"required":["type","created_at","custom"],"title":"ReviewQueueItemUpdatedEvent","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"},"RingSettings":{"properties":{"auto_cancel_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_timeout_ms","missed_call_timeout_ms"],"type":"object"},"RingSettingsResponse":{"properties":{"auto_cancel_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_timeout_ms","missed_call_timeout_ms"],"type":"object"},"Role":{"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"004"},"custom":{"description":"Whether this is a custom role or built-in","title":"Custom","type":"boolean","x-stream-index":"002"},"name":{"description":"Unique role name","title":"Name","type":"string","x-stream-index":"001"},"scopes":{"description":"List of scopes where this role is currently present. `.app` means that role is present in app-level grants","items":{"type":"string"},"title":"Scopes","type":"array","x-stream-index":"003"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"005"}},"required":["name","custom","scopes","created_at","updated_at"],"type":"object"},"RuleBuilderAction":{"properties":{"ban_options":{"$ref":"#/components/schemas/BanOptions","x-stream-index":"002"},"flag_content_options":{"$ref":"#/components/schemas/FlagContentOptions","x-stream-index":"004"},"flag_user_options":{"$ref":"#/components/schemas/FlagUserOptions","x-stream-index":"003"},"remove_content_options":{"$ref":"#/components/schemas/BlockContentOptions","x-stream-index":"005"},"type":{"type":"string","x-stream-index":"001"}},"required":["type"],"type":"object"},"RuleBuilderCondition":{"properties":{"confidence":{"format":"float","type":"number","x-stream-index":"002"},"content_count_rule_params":{"$ref":"#/components/schemas/ContentCountRuleParameters","x-stream-index":"007"},"image_content_params":{"$ref":"#/components/schemas/ImageContentParameters","x-stream-index":"009"},"image_rule_params":{"$ref":"#/components/schemas/ImageRuleParameters","x-stream-index":"004"},"text_content_params":{"$ref":"#/components/schemas/TextContentParameters","x-stream-index":"008"},"text_rule_params":{"$ref":"#/components/schemas/TextRuleParameters","x-stream-index":"003"},"type":{"type":"string","x-stream-index":"001"},"user_created_within_params":{"$ref":"#/components/schemas/UserCreatedWithinParameters","x-stream-index":"011"},"user_rule_params":{"$ref":"#/components/schemas/UserRuleParameters","x-stream-index":"006"},"video_content_params":{"$ref":"#/components/schemas/VideoContentParameters","x-stream-index":"010"},"video_rule_params":{"$ref":"#/components/schemas/VideoRuleParameters","x-stream-index":"005"}},"required":["type"],"type":"object"},"RuleBuilderConditionGroup":{"properties":{"conditions":{"items":{"$ref":"#/components/schemas/RuleBuilderCondition"},"type":"array","x-stream-index":"002"},"logic":{"type":"string","x-stream-index":"001"}},"required":["logic","conditions"],"type":"object"},"RuleBuilderConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"rules":{"items":{"$ref":"#/components/schemas/RuleBuilderRule"},"type":"array","x-stream-index":"002"}},"required":["rules"],"type":"object"},"RuleBuilderRule":{"properties":{"action":{"$ref":"#/components/schemas/RuleBuilderAction","x-stream-index":"007"},"conditions":{"items":{"$ref":"#/components/schemas/RuleBuilderCondition"},"type":"array","x-stream-index":"004"},"cooldown_period":{"type":"string","x-stream-index":"009"},"enabled":{"type":"boolean","x-stream-index":"008"},"groups":{"items":{"$ref":"#/components/schemas/RuleBuilderConditionGroup"},"type":"array","x-stream-index":"006"},"id":{"type":"string","x-stream-index":"001"},"logic":{"type":"string","x-stream-index":"005"},"name":{"type":"string","x-stream-index":"002"},"rule_type":{"type":"string","x-stream-index":"003"}},"required":["id","name","rule_type","action","enabled"],"type":"object"},"S3Request":{"description":"Config for creating Amazon S3 storage.","properties":{"s3_api_key":{"description":"The AWS API key. To use Amazon S3 as your storage provider, you have two authentication options: IAM role or API key. If you do not specify the `s3_api_key` parameter, Stream will use IAM role authentication. In that case make sure to have the correct IAM role configured for your application.","title":"S3ApiKey","type":"string","x-stream-index":"002"},"s3_custom_endpoint_url":{"description":"The custom endpoint for S3. If you want to use a custom endpoint, you must also provide the `s3_api_key` and `s3_secret` parameters.","title":"S3CustomEndpointURL","type":"string","x-stream-index":"004"},"s3_region":{"description":"The AWS region where the bucket is hosted","title":"S3Region","type":"string","x-stream-index":"001"},"s3_secret":{"description":"The AWS API Secret","title":"S3Secret","type":"string","x-stream-index":"003"}},"required":["s3_region"],"title":"S3Request","type":"object"},"SFUIDLastSeen":{"properties":{"id":{"type":"string","x-stream-index":"001.001"},"last_seen":{"format":"date-time","type":"number","x-stream-index":"002"},"process_start_time":{"format":"int64","type":"integer","x-stream-index":"001.002"}},"required":["id","process_start_time","last_seen"],"type":"object"},"STTEgressConfig":{"properties":{"closed_captions_enabled":{"type":"boolean","x-stream-index":"005"},"external_storage":{"$ref":"#/components/schemas/ExternalStorage","x-stream-index":"011"},"language":{"type":"string","x-stream-index":"008"},"storage_name":{"type":"string","x-stream-index":"010"},"translation_languages":{"items":{"type":"string"},"type":"array","x-stream-index":"009"},"translations_enabled":{"type":"boolean","x-stream-index":"006"},"upload_transcriptions":{"type":"boolean","x-stream-index":"004"},"whisper_server_base_url":{"type":"string","x-stream-index":"007"}},"type":"object"},"ScreensharingSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled"],"type":"object"},"ScreensharingSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled"],"type":"object"},"SearchPayload":{"properties":{"filter_conditions":{"additionalProperties":{},"description":"Channel filter conditions","maximum":100,"minimum":1,"title":"Channel filter","type":"object","x-stream-docs-page-id":"query_channels","x-stream-index":"002"},"limit":{"description":"Number of messages to return","format":"int32","title":"Limit","type":"integer","x-stream-index":"005"},"message_filter_conditions":{"additionalProperties":{},"description":"Message filter conditions","title":"Message filter","type":"object","x-stream-index":"003"},"message_options":{"$ref":"#/components/schemas/MessageOptions","x-stream-index":"004"},"next":{"description":"Pagination parameter. Cannot be used with non-zero offset.","title":"Next","type":"string","x-stream-index":"008"},"offset":{"description":"Pagination offset. Cannot be used with sort or next.","format":"int32","title":"Offset","type":"integer","x-stream-index":"006"},"query":{"description":"Search phrase","title":"Query","type":"string","x-stream-index":"001"},"sort":{"description":"Sort parameters. Cannot be used with non-zero offset","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"007"}},"required":["filter_conditions"],"type":"object"},"SearchResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"005.001"},"next":{"description":"Value to pass to the next search query in order to paginate","title":"Next","type":"string","x-stream-index":"003"},"previous":{"description":"Value that points to the previous page. Pass as the next value in a search query to paginate backwards","title":"Previous","type":"string","x-stream-index":"004"},"results":{"description":"Search results","items":{"$ref":"#/components/schemas/SearchResult"},"title":"Results","type":"array","x-stream-index":"001"},"results_warning":{"$ref":"#/components/schemas/SearchWarning","description":"Warning about the search results","title":"Results Warning","x-stream-index":"002"}},"required":["results","duration"],"type":"object"},"SearchResult":{"properties":{"message":{"$ref":"#/components/schemas/SearchResultMessage","description":"Found message","title":"Message","x-stream-index":"001"}},"type":"object"},"SearchResultMessage":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"001.008"},"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel object","title":"Channel","x-stream-index":"002"},"cid":{"type":"string","x-stream-index":"001.022"},"command":{"type":"string","x-stream-index":"001.004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.023"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.026"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.025"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"001.018"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001.041"},"html":{"type":"string","x-stream-index":"001.005"},"i18n":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.030"},"id":{"type":"string","x-stream-index":"001.001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"001.028"},"latest_reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"001.009"},"mentioned_users":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"001.029"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"001.036"},"mml":{"type":"string","x-stream-index":"001.003"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"001.039"},"own_reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"001.010"},"parent_id":{"type":"string","x-stream-index":"001.015"},"pin_expires":{"format":"date-time","type":"number","x-stream-index":"001.035"},"pinned":{"type":"boolean","x-stream-index":"001.032"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"001.033"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001.034"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001.038"},"poll_id":{"type":"string","x-stream-index":"001.037"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001.020"},"quoted_message_id":{"type":"string","x-stream-index":"001.019"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001.011"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"001.014"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001.012"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"001.042"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"001.017"},"restricted_visibility":{"items":{"type":"string"},"type":"array","x-stream-index":"001.040"},"shadowed":{"type":"boolean","x-stream-index":"001.027"},"shared_location":{"$ref":"#/components/schemas/SharedLocationResponseData","x-stream-index":"001.043"},"show_in_channel":{"type":"boolean","x-stream-index":"001.016"},"silent":{"type":"boolean","x-stream-index":"001.031"},"text":{"type":"string","x-stream-index":"001.002"},"thread_participants":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"001.021"},"type":{"type":"string","x-stream-index":"001.006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.024"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001.007"}},"required":["id","text","html","type","user","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned","restricted_visibility"],"type":"object"},"SearchWarning":{"properties":{"channel_search_cids":{"description":"Channel CIDs for the searched channels","items":{"type":"string"},"title":"Channel Search CIDs","type":"array","x-stream-index":"004"},"channel_search_count":{"description":"Number of channels searched","format":"int32","title":"Channel Search Count","type":"integer","x-stream-index":"003"},"warning_code":{"description":"Code corresponding to the warning","format":"int32","title":"Warning Code","type":"integer","x-stream-index":"002"},"warning_description":{"description":"Description of the warning","title":"Warning Description","type":"string","x-stream-index":"001"}},"required":["warning_description","warning_code"],"type":"object"},"Segment":{"nullable":true,"properties":{"all_sender_channels":{"type":"boolean","x-stream-index":"007"},"all_users":{"type":"boolean","x-stream-index":"006"},"created_at":{"format":"date-time","type":"number","x-stream-index":"010"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"012"},"description":{"type":"string","x-stream-index":"004"},"filter":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"name":{"type":"string","x-stream-index":"003"},"size":{"format":"int32","type":"integer","x-stream-index":"009"},"task_id":{"type":"string","x-stream-index":"008"},"type":{"type":"string","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"011"}},"required":["id","type","name","all_users","all_sender_channels","size","created_at","updated_at"],"type":"object"},"SegmentResponse":{"properties":{"all_sender_channels":{"type":"boolean","x-stream-index":"007"},"all_users":{"type":"boolean","x-stream-index":"006"},"created_at":{"format":"date-time","type":"number","x-stream-index":"009"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"description":{"type":"string","x-stream-index":"004"},"filter":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"name":{"type":"string","x-stream-index":"003"},"size":{"format":"int32","type":"integer","x-stream-index":"008"},"type":{"type":"string","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"010"}},"required":["id","type","name","description","filter","all_users","all_sender_channels","size","created_at","updated_at","deleted_at"],"type":"object"},"SegmentTargetResponse":{"nullable":true,"properties":{"app_pk":{"format":"int32","type":"integer","x-stream-index":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"segment_id":{"type":"string","x-stream-index":"002"},"target_id":{"type":"string","x-stream-index":"003"}},"required":["app_pk","segment_id","target_id","created_at"],"type":"object"},"SendEventRequest":{"nullable":true,"properties":{"event":{"$ref":"#/components/schemas/EventRequest","x-stream-index":"001"}},"required":["event"],"type":"object"},"SendMessageRequest":{"nullable":true,"properties":{"force_moderation":{"type":"boolean","x-stream-index":"007"},"keep_channel_hidden":{"type":"boolean","x-stream-index":"008"},"message":{"$ref":"#/components/schemas/MessageRequest","x-stream-index":"001"},"pending":{"type":"boolean","x-stream-index":"006"},"pending_message_metadata":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"005"},"skip_enrich_url":{"type":"boolean","x-stream-index":"003"},"skip_push":{"type":"boolean","x-stream-index":"002"}},"required":["message"],"type":"object"},"SendMessageResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Message response","title":"Message","x-stream-index":"001"},"pending_message_metadata":{"additionalProperties":{"type":"string"},"description":"Pending message metadata","title":"Pending message metadata","type":"object","x-stream-index":"002"}},"required":["message","duration"],"type":"object"},"SendReactionRequest":{"nullable":true,"properties":{"enforce_unique":{"description":"Whether to replace all existing user reactions","title":"Enforce unique","type":"boolean","x-stream-index":"003"},"reaction":{"$ref":"#/components/schemas/ReactionRequest","x-stream-index":"002"},"skip_push":{"description":"Skips any mobile push notifications","title":"Skip push","type":"boolean","x-stream-index":"004"}},"required":["reaction"],"type":"object"},"SendReactionResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001"},"reaction":{"$ref":"#/components/schemas/ReactionResponse","x-stream-index":"002"}},"required":["message","reaction","duration"],"title":"Response","type":"object"},"SendUserCustomEventRequest":{"nullable":true,"properties":{"event":{"$ref":"#/components/schemas/UserCustomEventRequest","x-stream-index":"001"}},"required":["event"],"type":"object"},"SessionSettings":{"properties":{"inactivity_timeout_seconds":{"format":"int32","maximum":900,"minimum":5,"type":"integer","x-stream-index":"001"}},"required":["inactivity_timeout_seconds"],"type":"object"},"SessionSettingsResponse":{"properties":{"inactivity_timeout_seconds":{"format":"int32","maximum":900,"minimum":5,"type":"integer","x-stream-index":"001"}},"required":["inactivity_timeout_seconds"],"type":"object"},"ShadowBlockActionRequest":{"type":"object"},"SharedLocation":{"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"013"},"channel_cid":{"type":"string","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"010"},"created_by_device_id":{"type":"string","x-stream-index":"008"},"end_at":{"format":"date-time","type":"number","x-stream-index":"009"},"latitude":{"format":"float","maximum":90,"minimum":18446744073709552000,"type":"number","x-stream-index":"006"},"longitude":{"format":"float","maximum":180,"minimum":18446744073709552000,"type":"number","x-stream-index":"007"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"012"},"message_id":{"type":"string","x-stream-index":"004"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"011"},"user_id":{"type":"string","x-stream-index":"005"}},"required":["channel_cid","message_id","user_id","created_by_device_id","created_at","updated_at"],"type":"object"},"SharedLocationResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001.011"},"channel_cid":{"description":"Channel CID","title":"string","type":"string","x-stream-index":"001.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.008"},"created_by_device_id":{"description":"Device ID that created the live location","title":"string","type":"string","x-stream-index":"001.006"},"duration":{"type":"string","x-stream-index":"002.001"},"end_at":{"description":"Time when the live location expires","format":"date-time","title":"string","type":"number","x-stream-index":"001.007"},"latitude":{"description":"Latitude coordinate","format":"float","title":"number","type":"number","x-stream-index":"001.004"},"longitude":{"description":"Longitude coordinate","format":"float","title":"number","type":"number","x-stream-index":"001.005"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001.010"},"message_id":{"description":"Message ID","title":"string","type":"string","x-stream-index":"001.002"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.009"},"user_id":{"description":"User ID","title":"string","type":"string","x-stream-index":"001.003"}},"required":["channel_cid","message_id","user_id","latitude","longitude","created_by_device_id","created_at","updated_at","duration"],"type":"object"},"SharedLocationResponseData":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"011"},"channel_cid":{"type":"string","x-stream-index":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"created_by_device_id":{"type":"string","x-stream-index":"006"},"end_at":{"format":"date-time","type":"number","x-stream-index":"007"},"latitude":{"format":"float","type":"number","x-stream-index":"004"},"longitude":{"format":"float","type":"number","x-stream-index":"005"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"010"},"message_id":{"type":"string","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["channel_cid","message_id","user_id","latitude","longitude","created_by_device_id","created_at","updated_at"],"type":"object"},"SharedLocationsResponse":{"nullable":true,"properties":{"active_live_locations":{"items":{"$ref":"#/components/schemas/SharedLocationResponseData"},"type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["active_live_locations","duration"],"type":"object"},"ShowChannelRequest":{"nullable":true,"properties":{"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"002.002"},"user_id":{"type":"string","x-stream-index":"002.001"}},"type":"object"},"ShowChannelResponse":{"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"},"SortParam":{"nullable":true,"properties":{"direction":{"format":"int32","type":"integer","x-stream-index":"002"},"field":{"type":"string","x-stream-index":"001"}},"type":"object"},"SortParamRequest":{"nullable":true,"properties":{"direction":{"description":"Direction of sorting, 1 for Ascending, -1 for Descending, default is 1","format":"int32","title":"Direction","type":"integer","x-stream-index":"002"},"field":{"description":"Name of field to sort by","title":"Field","type":"string","x-stream-index":"001"}},"type":"object"},"StartCampaignRequest":{"nullable":true,"properties":{"scheduled_for":{"format":"date-time","type":"number","x-stream-index":"002"},"stop_at":{"format":"date-time","type":"number","x-stream-index":"003"}},"type":"object"},"StartCampaignResponse":{"description":"Basic response information","nullable":true,"properties":{"campaign":{"$ref":"#/components/schemas/CampaignResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"users":{"$ref":"#/components/schemas/PagerResponse","x-stream-index":"002"}},"required":["duration"],"title":"Response","type":"object"},"StopCampaignRequest":{"nullable":true,"type":"object"},"SubmitActionRequest":{"nullable":true,"properties":{"action_type":{"description":"Type of moderation action to perform (mark_reviewed, delete_message, etc.)","enum":["mark_reviewed","delete_message","delete_activity","delete_reaction","ban","custom","unban","restore","delete_user","unblock","shadow_block","unmask","kick_user","end_call"],"title":"Action Type","type":"string","x-stream-index":"002"},"ban":{"$ref":"#/components/schemas/BanActionRequest","description":"Configuration for ban action","title":"Ban","x-stream-index":"008"},"custom":{"$ref":"#/components/schemas/CustomActionRequest","description":"Configuration for custom action","title":"Custom","x-stream-index":"009"},"delete_activity":{"$ref":"#/components/schemas/DeleteActivityRequest","description":"Configuration for activity deletion action","title":"Delete Activity","x-stream-index":"004"},"delete_message":{"$ref":"#/components/schemas/DeleteMessageRequest","description":"Configuration for message deletion action","title":"Delete Message","x-stream-index":"003"},"delete_reaction":{"$ref":"#/components/schemas/DeleteReactionRequest","description":"Configuration for reaction deletion action","title":"Delete Reaction","x-stream-index":"005"},"delete_user":{"$ref":"#/components/schemas/DeleteUserRequest","description":"Configuration for user deletion action","title":"Delete User","x-stream-index":"006"},"item_id":{"description":"UUID of the review queue item to act on","title":"Item ID","type":"string","x-stream-index":"001"},"mark_reviewed":{"$ref":"#/components/schemas/MarkReviewedRequest","description":"Configuration for marking item as reviewed","title":"Mark Reviewed","x-stream-index":"007"},"unban":{"$ref":"#/components/schemas/UnbanActionRequest","description":"Configuration for unban action","title":"Unban","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"016.002"},"user_id":{"type":"string","x-stream-index":"016.001"}},"required":["item_id","action_type"],"type":"object"},"SubmitActionResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"Updated review queue item after action was performed","title":"Item","x-stream-index":"001"}},"required":["duration"],"type":"object"},"TargetResolution":{"properties":{"bitrate":{"format":"int32","maximum":6000000,"type":"integer","x-stream-index":"003"},"height":{"format":"int32","maximum":3840,"minimum":240,"type":"integer","x-stream-index":"002"},"width":{"format":"int32","maximum":3840,"minimum":240,"type":"integer","x-stream-index":"001"}},"required":["width","height","bitrate"],"type":"object"},"TextContentParameters":{"properties":{"blocklist_match":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"contains_url":{"type":"boolean","x-stream-index":"002"},"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001"},"severity":{"type":"string","x-stream-index":"003"}},"type":"object"},"TextRuleParameters":{"properties":{"blocklist_match":{"items":{"type":"string"},"type":"array","x-stream-index":"006"},"contains_url":{"type":"boolean","x-stream-index":"004"},"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"severity":{"type":"string","x-stream-index":"005"},"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"required":["threshold","time_window"],"type":"object"},"ThreadParticipant":{"description":"Represents a user that is participating in a thread.","nullable":true,"properties":{"app_pk":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"001"},"channel_cid":{"type":"string","x-stream-index":"002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"007"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"last_read_at":{"format":"date-time","type":"number","x-stream-index":"009"},"last_thread_message_at":{"format":"date-time","type":"number","x-stream-index":"003"},"left_thread_at":{"description":"Left Thread At is the time when the user left the thread","format":"date-time","title":"Left Thread At","type":"number","x-stream-index":"008"},"thread_id":{"description":"Thead ID is unique string identifier of the thread","title":"ID","type":"string","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User is the user object","title":"User","x-stream-index":"006"},"user_id":{"description":"User ID is unique string identifier of the user","title":"User ID","type":"string","x-stream-index":"005"}},"required":["app_pk","channel_cid","created_at","last_read_at","custom"],"title":"ThreadParticipant","type":"object"},"ThreadResponse":{"properties":{"active_participant_count":{"description":"Active Participant Count","format":"int32","title":"Active Participant Count","type":"integer","x-stream-index":"009"},"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel","title":"ChannelResponse","x-stream-index":"002"},"channel_cid":{"description":"Channel CID","title":"Channel CID","type":"string","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"012"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"Created By User","title":"User","x-stream-index":"006"},"created_by_user_id":{"description":"Created By User ID","title":"Created By User ID","type":"string","x-stream-index":"005"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"016"},"deleted_at":{"description":"Deleted At","format":"date-time","title":"Deleted At","type":"number","x-stream-index":"014"},"last_message_at":{"description":"Last Message At","format":"date-time","title":"Last Message At","type":"number","x-stream-index":"011"},"parent_message":{"$ref":"#/components/schemas/MessageResponse","description":"Parent Message","title":"Message","x-stream-index":"004"},"parent_message_id":{"description":"Parent Message ID","title":"Parent Message ID","type":"string","x-stream-index":"003"},"participant_count":{"description":"Participant Count","format":"int32","title":"Participant Count","type":"integer","x-stream-index":"008"},"reply_count":{"description":"Reply Count","format":"int32","title":"Reply Count","type":"integer","x-stream-index":"007"},"thread_participants":{"description":"Thread Participants","items":{"$ref":"#/components/schemas/ThreadParticipant"},"title":"ThreadParticipants","type":"array","x-stream-index":"010"},"title":{"description":"Title","title":"Title","type":"string","x-stream-index":"015"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"013"}},"required":["channel_cid","parent_message_id","created_by_user_id","created_at","updated_at","title","custom"],"type":"object"},"ThreadStateResponse":{"nullable":true,"properties":{"active_participant_count":{"description":"Active Participant Count","format":"int32","title":"Active Participant Count","type":"integer","x-stream-index":"001.009"},"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel","title":"ChannelResponse","x-stream-index":"001.002"},"channel_cid":{"description":"Channel CID","title":"Channel CID","type":"string","x-stream-index":"001.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.012"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"Created By User","title":"User","x-stream-index":"001.006"},"created_by_user_id":{"description":"Created By User ID","title":"Created By User ID","type":"string","x-stream-index":"001.005"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"001.016"},"deleted_at":{"description":"Deleted At","format":"date-time","title":"Deleted At","type":"number","x-stream-index":"001.014"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"004"},"last_message_at":{"description":"Last Message At","format":"date-time","title":"Last Message At","type":"number","x-stream-index":"001.011"},"latest_replies":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","x-stream-index":"002"},"parent_message":{"$ref":"#/components/schemas/MessageResponse","description":"Parent Message","title":"Message","x-stream-index":"001.004"},"parent_message_id":{"description":"Parent Message ID","title":"Parent Message ID","type":"string","x-stream-index":"001.003"},"participant_count":{"description":"Participant Count","format":"int32","title":"Participant Count","type":"integer","x-stream-index":"001.008"},"read":{"items":{"$ref":"#/components/schemas/ReadStateResponse"},"type":"array","x-stream-index":"003"},"reply_count":{"description":"Reply Count","format":"int32","title":"Reply Count","type":"integer","x-stream-index":"001.007"},"thread_participants":{"description":"Thread Participants","items":{"$ref":"#/components/schemas/ThreadParticipant"},"title":"ThreadParticipants","type":"array","x-stream-index":"001.010"},"title":{"description":"Title","title":"Title","type":"string","x-stream-index":"001.015"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.013"}},"required":["channel_cid","parent_message_id","created_by_user_id","created_at","updated_at","title","custom","latest_replies"],"type":"object"},"ThreadUpdatedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"001.002"},"channel_type":{"type":"string","x-stream-index":"001.003"},"cid":{"type":"string","x-stream-index":"001.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"thread":{"$ref":"#/components/schemas/ThreadResponse","x-stream-index":"003.001"},"type":{"default":"thread.updated","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"ThreadUpdatedEvent","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"},"Thresholds":{"description":"Sets thresholds for AI moderation","properties":{"explicit":{"$ref":"#/components/schemas/LabelThresholds","description":"Thresholds for explicit messages","title":"LabelThresholds","x-stream-index":"001"},"spam":{"$ref":"#/components/schemas/LabelThresholds","description":"Thresholds for spam","title":"LabelThresholds","x-stream-index":"002"},"toxic":{"$ref":"#/components/schemas/LabelThresholds","description":"Thresholds for toxic messages","title":"LabelThresholds","x-stream-index":"003"}},"title":"Auto moderation thresholds","type":"object"},"ThumbnailResponse":{"properties":{"image_url":{"type":"string","x-stream-index":"001"}},"required":["image_url"],"type":"object"},"ThumbnailsSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"ThumbnailsSettingsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"Time":{"type":"object"},"TranscriptionSettings":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"title":"Mode","type":"string","x-stream-index":"002"},"language":{"description":"The language used in this call as a two letter code","enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"title":"Language","type":"string","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"title":"Mode","type":"string","x-stream-index":"001"}},"required":["mode","closed_caption_mode","languages","language"],"type":"object"},"TranscriptionSettingsResponse":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"002"},"language":{"enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"type":"string","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode","closed_caption_mode","languages","language"],"type":"object"},"TranslateMessageRequest":{"nullable":true,"properties":{"language":{"description":"Language to translate message to","enum":["af","sq","am","ar","az","bn","bs","bg","zh","zh-TW","hr","cs","da","fa-AF","nl","en","et","fi","fr","fr-CA","ka","de","el","ha","he","hi","hu","id","it","ja","ko","lv","ms","no","fa","ps","pl","pt","ro","ru","sr","sk","sl","so","es","es-MX","sw","sv","tl","ta","th","tr","uk","ur","vi","lt","ht"],"title":"Language","type":"string","x-stream-index":"001"}},"required":["language"],"type":"object"},"TruncateChannelRequest":{"nullable":true,"properties":{"hard_delete":{"description":"Permanently delete channel data (messages, reactions, etc.)","title":"Hard delete","type":"boolean","x-stream-index":"002"},"member_ids":{"description":"List of member IDs to hide message history for. If empty, truncates the channel for all members","items":{"type":"string"},"maximum":100,"title":"Member IDs","type":"array","x-stream-index":"007"},"message":{"$ref":"#/components/schemas/MessageRequest","x-stream-index":"004"},"skip_push":{"description":"When `message` is set disables all push notifications for it","title":"Skip push","type":"boolean","x-stream-index":"005"},"truncated_at":{"description":"Truncate channel data up to `truncated_at`. The system message (if provided) creation time is always greater than `truncated_at`","format":"date-time","title":"Truncated at","type":"number","x-stream-index":"006"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"008.002"},"user_id":{"type":"string","x-stream-index":"008.001"}},"type":"object"},"TruncateChannelResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Truncated channel object","title":"Channel","x-stream-index":"002"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Truncated message object","title":"Message","x-stream-index":"003"}},"required":["duration"],"type":"object"},"TypingIndicators":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"TypingIndicatorsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"UnbanActionRequest":{"type":"object"},"UnbanRequest":{"nullable":true,"properties":{"unbanned_by":{"$ref":"#/components/schemas/UserRequest","description":"Details about the user performing the unban","title":"Unbanned By","x-stream-index":"005"},"unbanned_by_id":{"description":"ID of the user performing the unban","title":"Unbanned By ID","type":"string","x-stream-index":"004"}},"type":"object"},"UnbanResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"UnblockActionRequest":{"type":"object"},"UnblockUsersRequest":{"nullable":true,"properties":{"blocked_user_id":{"type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"required":["blocked_user_id"],"type":"object"},"UnblockUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"UnmuteChannelRequest":{"nullable":true,"properties":{"channel_cids":{"description":"Channel CIDs to mute (if multiple channels)","items":{"type":"string"},"maximum":25,"title":"Channel CIDs","type":"array","x-stream-index":"001.002"},"expiration":{"description":"Duration of mute in milliseconds","title":"Expiration","type":"integer","x-stream-index":"001.003"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"002.002"},"user_id":{"type":"string","x-stream-index":"002.001"}},"type":"object"},"UnmuteRequest":{"nullable":true,"properties":{"target_ids":{"description":"User IDs to unmute","items":{"type":"string"},"title":"Target IDs","type":"array","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"002.002"},"user_id":{"type":"string","x-stream-index":"002.001"}},"required":["target_ids"],"title":"UnmuteRequest","type":"object"},"UnmuteResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"non_existing_users":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"required":["duration"],"title":"Response","type":"object"},"UnreadCountsBatchRequest":{"nullable":true,"properties":{"user_ids":{"items":{"type":"string"},"maximum":100,"type":"array","x-stream-index":"001"}},"required":["user_ids"],"type":"object"},"UnreadCountsBatchResponse":{"description":"Basic response information","nullable":true,"properties":{"counts_by_user":{"additionalProperties":{"$ref":"#/components/schemas/UnreadCountsResponse"},"type":"object","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["counts_by_user","duration"],"title":"Response","type":"object"},"UnreadCountsChannel":{"properties":{"channel_id":{"type":"string","x-stream-index":"001"},"last_read":{"format":"date-time","type":"number","x-stream-index":"003"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["channel_id","unread_count","last_read"],"type":"object"},"UnreadCountsChannelType":{"properties":{"channel_count":{"format":"int32","type":"integer","x-stream-index":"002"},"channel_type":{"type":"string","x-stream-index":"001"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["channel_type","channel_count","unread_count"],"type":"object"},"UnreadCountsResponse":{"nullable":true,"properties":{"channel_type":{"items":{"$ref":"#/components/schemas/UnreadCountsChannelType"},"type":"array","x-stream-index":"005"},"channels":{"items":{"$ref":"#/components/schemas/UnreadCountsChannel"},"type":"array","x-stream-index":"004"},"threads":{"items":{"$ref":"#/components/schemas/UnreadCountsThread"},"type":"array","x-stream-index":"006"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"001"},"total_unread_count_by_team":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"003"},"total_unread_threads_count":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["total_unread_count","total_unread_threads_count","channels","channel_type","threads"],"type":"object"},"UnreadCountsThread":{"properties":{"last_read":{"format":"date-time","type":"number","x-stream-index":"002"},"last_read_message_id":{"type":"string","x-stream-index":"003"},"parent_message_id":{"type":"string","x-stream-index":"004"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"001"}},"required":["unread_count","last_read","last_read_message_id","parent_message_id"],"type":"object"},"UpdateAppRequest":{"nullable":true,"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.017"},"apn_config":{"$ref":"#/components/schemas/APNConfig","x-stream-index":"001.003"},"async_moderation_config":{"$ref":"#/components/schemas/AsyncModerationConfiguration","x-stream-index":"001.039"},"async_url_enrich_enabled":{"type":"boolean","x-stream-index":"001.019"},"auto_translation_enabled":{"type":"boolean","x-stream-index":"001.018"},"before_message_send_hook_url":{"type":"string","x-stream-index":"001.020"},"cdn_expiration_seconds":{"format":"int32","maximum":1209600,"minimum":14400,"type":"integer","x-stream-index":"001.038"},"channel_hide_members_only":{"type":"boolean","x-stream-index":"001.033"},"custom_action_handler_url":{"type":"string","x-stream-index":"001.021"},"datadog_info":{"$ref":"#/components/schemas/DataDogInfo","x-stream-index":"001.040"},"disable_auth_checks":{"type":"boolean","x-stream-index":"001.001"},"disable_permissions_checks":{"type":"boolean","x-stream-index":"001.002"},"enforce_unique_usernames":{"enum":["no","app","team"],"type":"string","x-stream-index":"001.022"},"event_hooks":{"items":{"$ref":"#/components/schemas/EventHook"},"type":"array","x-stream-index":"001.046"},"feeds_moderation_enabled":{"type":"boolean","x-stream-index":"001.042"},"feeds_v2_region":{"type":"string","x-stream-index":"001.041"},"file_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","x-stream-index":"001.030"},"firebase_config":{"$ref":"#/components/schemas/FirebaseConfig","x-stream-index":"001.004"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"001.034"},"guest_user_creation_disabled":{"type":"boolean","x-stream-index":"001.043"},"huawei_config":{"$ref":"#/components/schemas/HuaweiConfig","x-stream-index":"001.005"},"image_moderation_block_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001.015"},"image_moderation_enabled":{"type":"boolean","x-stream-index":"001.016"},"image_moderation_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001.014"},"image_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","x-stream-index":"001.029"},"migrate_permissions_to_v2":{"type":"boolean","x-stream-index":"001.035"},"moderation_dashboard_preferences":{"$ref":"#/components/schemas/ModerationDashboardPreferences","x-stream-index":"001.044"},"moderation_enabled":{"type":"boolean","x-stream-index":"001.009"},"moderation_webhook_url":{"type":"string","x-stream-index":"001.010"},"multi_tenant_enabled":{"type":"boolean","x-stream-index":"001.013"},"permission_version":{"enum":["v1","v2"],"type":"string","x-stream-index":"001.011"},"push_config":{"$ref":"#/components/schemas/PushConfig","x-stream-index":"001.007"},"reminders_interval":{"format":"int32","maximum":86400,"minimum":60,"type":"integer","x-stream-index":"001.036"},"reminders_max_members":{"format":"int32","minimum":2,"type":"integer","x-stream-index":"001.037"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.031"},"sns_key":{"type":"string","x-stream-index":"001.027"},"sns_secret":{"type":"string","x-stream-index":"001.028"},"sns_topic_arn":{"type":"string","x-stream-index":"001.026"},"sqs_key":{"type":"string","x-stream-index":"001.024"},"sqs_secret":{"type":"string","x-stream-index":"001.025"},"sqs_url":{"type":"string","x-stream-index":"001.023"},"user_response_time_enabled":{"type":"boolean","x-stream-index":"001.048"},"user_search_disallowed_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"001.012"},"webhook_events":{"items":{"type":"string"},"type":"array","x-stream-index":"001.032"},"webhook_url":{"type":"string","x-stream-index":"001.008"},"xiaomi_config":{"$ref":"#/components/schemas/XiaomiConfig","x-stream-index":"001.006"}},"type":"object"},"UpdateBlockListRequest":{"nullable":true,"properties":{"team":{"type":"string","x-stream-index":"002"},"words":{"description":"List of words to block","items":{"type":"string"},"minimum":1,"title":"Words","type":"array","x-stream-index":"003"}},"title":"Update block list","type":"object","x-stream-docs-page-id":"update_block_list"},"UpdateBlockListResponse":{"description":"Basic response information","nullable":true,"properties":{"blocklist":{"$ref":"#/components/schemas/BlockListResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["duration"],"title":"Response","type":"object"},"UpdateChannelPartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"type":"object","x-stream-index":"002.001"},"unset":{"items":{"type":"string"},"type":"array","x-stream-index":"002.002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"title":"UpdateChannelPartialRequest","type":"object"},"UpdateChannelPartialResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Updated channel object","title":"Channel","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"members":{"description":"List of updated members","items":{"$ref":"#/components/schemas/ChannelMemberResponse"},"title":"ChannelMemberResponse","type":"array","x-stream-index":"002"}},"required":["members","duration"],"type":"object"},"UpdateChannelRequest":{"nullable":true,"properties":{"accept_invite":{"description":"Set to `true` to accept the invite","title":"Accept invite","type":"boolean","x-stream-index":"008"},"add_members":{"description":"List of user IDs to add to the channel","items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"title":"Add members","type":"array","x-stream-index":"001"},"add_moderators":{"description":"List of user IDs to make channel moderators","items":{"type":"string"},"maximum":100,"title":"Add moderators","type":"array","x-stream-index":"003"},"assign_roles":{"description":"List of channel member role assignments. If any specified user is not part of the channel, the request will fail","items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"title":"Assign roles","type":"array","x-stream-index":"006"},"cooldown":{"description":"Sets cool down period for the channel in seconds","format":"int32","maximum":120,"minimum":0,"title":"Cool down","type":"integer","x-stream-index":"007"},"data":{"$ref":"#/components/schemas/ChannelInput","x-stream-index":"013.001"},"demote_moderators":{"description":"List of user IDs to take away moderators status from","items":{"type":"string"},"maximum":100,"title":"Demote moderators","type":"array","x-stream-index":"004"},"hide_history":{"description":"Set to `true` to hide channel's history when adding new members","title":"Hide history","type":"boolean","x-stream-index":"012"},"invites":{"description":"List of user IDs to invite to the channel","items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"title":"Invites","type":"array","x-stream-index":"005"},"message":{"$ref":"#/components/schemas/MessageRequest","description":"Message to send to the chat when channel is successfully updated","title":"Message","x-stream-index":"010"},"reject_invite":{"description":"Set to `true` to reject the invite","title":"Reject invite","type":"boolean","x-stream-index":"009"},"remove_members":{"description":"List of user IDs to remove from the channel","items":{"type":"string"},"maximum":100,"title":"Remove members","type":"array","x-stream-index":"002"},"skip_push":{"description":"When `message` is set disables all push notifications for it","title":"Skip push","type":"boolean","x-stream-index":"011"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"014.002"},"user_id":{"type":"string","x-stream-index":"014.001"}},"title":"Channel update request","type":"object","x-stream-docs-page-id":"channel_update"},"UpdateChannelResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Updated channel","title":"Channel","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"004.001"},"members":{"description":"List of channel members","items":{"$ref":"#/components/schemas/ChannelMember"},"title":"Members","type":"array","x-stream-index":"003"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Message sent to the chat","title":"Message","x-stream-index":"002"}},"required":["members","duration"],"type":"object"},"UpdateChannelTypeRequest":{"nullable":true,"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"009.001.026"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"009.001.021"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"009.001.022"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"009.001.027"},"blocklist":{"type":"string","x-stream-index":"009.001.023"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"009.001.024"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"009.001.025"},"commands":{"description":"List of commands that channel supports","items":{"type":"string"},"title":"Commands","type":"array","x-stream-index":"009.003"},"connect_events":{"type":"boolean","x-stream-index":"009.001.004"},"custom_events":{"type":"boolean","x-stream-index":"009.001.012"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"004"},"mark_messages_pending":{"type":"boolean","x-stream-index":"009.001.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"009.001.020"},"mutes":{"type":"boolean","x-stream-index":"009.001.009"},"partition_size":{"format":"int32","minimum":0,"type":"integer","x-stream-index":"007"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"008"},"permissions":{"items":{"$ref":"#/components/schemas/PolicyRequest"},"type":"array","x-stream-index":"003"},"polls":{"type":"boolean","x-stream-index":"009.001.016"},"push_notifications":{"type":"boolean","x-stream-index":"009.001.013"},"quotes":{"type":"boolean","x-stream-index":"009.001.008"},"reactions":{"type":"boolean","x-stream-index":"009.001.006"},"read_events":{"type":"boolean","x-stream-index":"009.001.003"},"reminders":{"type":"boolean","x-stream-index":"009.001.014"},"replies":{"type":"boolean","x-stream-index":"009.001.007"},"search":{"type":"boolean","x-stream-index":"009.001.005"},"shared_locations":{"type":"boolean","x-stream-index":"009.001.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"009.001.030"},"typing_events":{"type":"boolean","x-stream-index":"009.001.002"},"uploads":{"type":"boolean","x-stream-index":"009.001.010"},"url_enrichment":{"type":"boolean","x-stream-index":"009.001.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"009.001.017"}},"required":["max_message_length","automod","automod_behavior"],"type":"object"},"UpdateChannelTypeResponse":{"nullable":true,"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"003.001.026"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"003.001.021"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.001.022"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"003.001.027"},"blocklist":{"type":"string","x-stream-index":"003.001.023"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.001.024"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"003.001.025"},"commands":{"items":{"type":"string"},"type":"array","x-stream-index":"003.003"},"connect_events":{"type":"boolean","x-stream-index":"003.001.004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002.003"},"custom_events":{"type":"boolean","x-stream-index":"003.001.012"},"duration":{"type":"string","x-stream-index":"004.001"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"002"},"mark_messages_pending":{"type":"boolean","x-stream-index":"003.001.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"003.001.020"},"mutes":{"type":"boolean","x-stream-index":"003.001.009"},"name":{"type":"string","x-stream-index":"003.001.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"003.001.028"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"003.001.029"},"permissions":{"items":{"$ref":"#/components/schemas/PolicyRequest"},"type":"array","x-stream-index":"001"},"polls":{"type":"boolean","x-stream-index":"003.001.016"},"push_notifications":{"type":"boolean","x-stream-index":"003.001.013"},"quotes":{"type":"boolean","x-stream-index":"003.001.008"},"reactions":{"type":"boolean","x-stream-index":"003.001.006"},"read_events":{"type":"boolean","x-stream-index":"003.001.003"},"reminders":{"type":"boolean","x-stream-index":"003.001.014"},"replies":{"type":"boolean","x-stream-index":"003.001.007"},"search":{"type":"boolean","x-stream-index":"003.001.005"},"shared_locations":{"type":"boolean","x-stream-index":"003.001.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"003.001.030"},"typing_events":{"type":"boolean","x-stream-index":"003.001.002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"003.002.004"},"uploads":{"type":"boolean","x-stream-index":"003.001.010"},"url_enrichment":{"type":"boolean","x-stream-index":"003.001.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"003.001.017"}},"required":["permissions","grants","name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","created_at","updated_at","commands","duration"],"type":"object"},"UpdateCommandRequest":{"nullable":true,"properties":{"args":{"description":"Arguments help text, shown in commands auto-completion","maxLength":255,"title":"Arguments","type":"string","x-stream-index":"003"},"description":{"description":"Description, shown in commands auto-completion","maxLength":255,"title":"Description","type":"string","x-stream-index":"002"},"set":{"description":"Set name used for grouping commands","maxLength":255,"title":"Set","type":"string","x-stream-index":"004"}},"required":["description"],"title":"UpdateCommandRequest","type":"object"},"UpdateCommandResponse":{"nullable":true,"properties":{"command":{"$ref":"#/components/schemas/Command","description":"Command object","title":"Command","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["duration"],"title":"UpdateCommandResponse","type":"object"},"UpdateExternalStorageRequest":{"description":"External storage","nullable":true,"properties":{"aws_s3":{"$ref":"#/components/schemas/S3Request","description":"Only required if you want to create an Amazon S3 storage","title":"AwsS3","x-stream-index":"003.004"},"azure_blob":{"$ref":"#/components/schemas/AzureRequest","description":"Only required if you want to create an Azure Blob Storage","title":"AzureBlob","x-stream-index":"003.006"},"bucket":{"description":"The name of the bucket on the service provider","title":"Bucket","type":"string","x-stream-index":"003.002"},"gcs_credentials":{"type":"string","x-stream-index":"003.005"},"path":{"description":"The path prefix to use for storing files","title":"Path","type":"string","x-stream-index":"003.003"},"storage_type":{"description":"The type of storage to use","enum":["s3","gcs","abs"],"title":"StorageType","type":"string","x-stream-index":"003.001"}},"required":["storage_type","bucket"],"title":"ExternalStorageRequest","type":"object"},"UpdateExternalStorageResponse":{"description":"Basic response information","nullable":true,"properties":{"bucket":{"type":"string","x-stream-index":"001.003"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"name":{"type":"string","x-stream-index":"001.001"},"path":{"type":"string","x-stream-index":"001.004"},"type":{"enum":["s3","gcs","abs"],"type":"string","x-stream-index":"001.002"}},"required":["name","type","bucket","path","duration"],"title":"Response","type":"object"},"UpdateLiveLocationRequest":{"nullable":true,"properties":{"end_at":{"description":"Time when the live location expires","format":"date-time","title":"string","type":"number","x-stream-index":"004"},"latitude":{"description":"Latitude coordinate","format":"float","maximum":90,"minimum":18446744073709552000,"title":"number","type":"number","x-stream-index":"002"},"longitude":{"description":"Longitude coordinate","format":"float","maximum":180,"minimum":18446744073709552000,"title":"number","type":"number","x-stream-index":"003"},"message_id":{"description":"Live location ID","title":"string","type":"string","x-stream-index":"001"}},"required":["message_id"],"type":"object"},"UpdateMemberPartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"type":"object","x-stream-index":"002.001"},"unset":{"items":{"type":"string"},"type":"array","x-stream-index":"002.002"}},"type":"object"},"UpdateMemberPartialResponse":{"nullable":true,"properties":{"channel_member":{"$ref":"#/components/schemas/ChannelMemberResponse","description":"Updated channel member","title":"Channel member","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["duration"],"type":"object"},"UpdateMessagePartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"description":"Sets new field values","title":"Set","type":"object","x-stream-index":"002.001","x-stream-map":{"key":"field","title":"Value","description":"New value to set"}},"skip_enrich_url":{"description":"Skip enriching the URL in the message","title":"SkipEnrichURL","type":"boolean","x-stream-index":"001"},"unset":{"description":"Array of field names to unset","items":{"type":"string"},"title":"Unset","type":"array","x-stream-index":"002.002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"type":"object"},"UpdateMessagePartialResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Updated message","title":"Message","x-stream-index":"001"},"pending_message_metadata":{"additionalProperties":{"type":"string"},"description":"Pending message metadata","title":"PendingMessageMetadata","type":"object","x-stream-index":"002"}},"required":["duration"],"type":"object"},"UpdateMessageRequest":{"nullable":true,"properties":{"message":{"$ref":"#/components/schemas/MessageRequest","description":"Message","title":"MessageRequest","x-stream-index":"001"},"skip_enrich_url":{"description":"Skip enrich URL","title":"boolean","type":"boolean","x-stream-index":"003"},"skip_push":{"type":"boolean","x-stream-index":"002"}},"required":["message"],"type":"object"},"UpdateMessageResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001"},"pending_message_metadata":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"002"}},"required":["message","duration"],"title":"Response","type":"object"},"UpdatePollOptionRequest":{"nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"004"},"id":{"description":"Option ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"},"text":{"description":"Option text","title":"string","type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"005.002"},"user_id":{"type":"string","x-stream-index":"005.001"}},"required":["id","text"],"type":"object"},"UpdatePollPartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"description":"Sets new field values","title":"Set","type":"object","x-stream-index":"002.001","x-stream-map":{"key":"field","title":"Value","description":"New value to set"}},"unset":{"description":"Array of field names to unset","items":{"type":"string"},"title":"Unset","type":"array","x-stream-index":"002.002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"type":"object"},"UpdatePollRequest":{"nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"011"},"allow_answers":{"description":"Allow answers","title":"boolean","type":"boolean","x-stream-index":"009"},"allow_user_suggested_options":{"description":"Allow user suggested options","title":"boolean","type":"boolean","x-stream-index":"008"},"description":{"description":"Poll description","title":"string","type":"string","x-stream-index":"003"},"enforce_unique_vote":{"description":"Enforce unique vote","title":"boolean","type":"boolean","x-stream-index":"005"},"id":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"},"is_closed":{"description":"Is closed","title":"boolean","type":"boolean","x-stream-index":"010"},"max_votes_allowed":{"description":"Max votes allowed","format":"int32","maximum":10,"title":"integer","type":"integer","x-stream-index":"007"},"name":{"description":"Poll name","title":"string","type":"string","x-stream-index":"002"},"options":{"description":"Poll options","items":{"$ref":"#/components/schemas/PollOptionRequest"},"maximum":100,"title":"PollOptions","type":"array","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"012.002"},"user_id":{"type":"string","x-stream-index":"012.001"},"voting_visibility":{"description":"Voting visibility","enum":["anonymous","public"],"title":"string","type":"string","x-stream-index":"006"}},"required":["id","name"],"type":"object"},"UpdateReminderRequest":{"nullable":true,"properties":{"remind_at":{"format":"date-time","type":"number","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"type":"object"},"UpdateReminderResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"001"}},"required":["reminder","duration"],"title":"Response","type":"object"},"UpdateThreadPartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"description":"Sets new field values","title":"Set","type":"object","x-stream-index":"004.001","x-stream-map":{"key":"field","title":"Value","description":"New value to set"}},"unset":{"description":"Array of field names to unset","items":{"type":"string"},"title":"Unset","type":"array","x-stream-index":"004.002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"type":"object"},"UpdateThreadPartialResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"thread":{"$ref":"#/components/schemas/ThreadResponse","description":"Updated thread (not enriched)","title":"Thread","x-stream-index":"001"}},"required":["thread","duration"],"type":"object"},"UpdateUserPartialRequest":{"properties":{"id":{"description":"User ID to update","title":"ID","type":"string","x-stream-index":"001"},"set":{"additionalProperties":{},"type":"object","x-stream-index":"002.001"},"unset":{"items":{"type":"string"},"type":"array","x-stream-index":"002.002"}},"required":["id"],"type":"object"},"UpdateUsersPartialRequest":{"nullable":true,"properties":{"users":{"items":{"$ref":"#/components/schemas/UpdateUserPartialRequest"},"maximum":100,"type":"array","x-stream-index":"001"}},"required":["users"],"type":"object"},"UpdateUsersRequest":{"nullable":true,"properties":{"users":{"additionalProperties":{"$ref":"#/components/schemas/UserRequest"},"description":"Object containing users","title":"Users","type":"object","x-stream-index":"001","x-stream-map":{"key":"user_id"}}},"required":["users"],"type":"object"},"UpdateUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"membership_deletion_task_id":{"type":"string","x-stream-index":"002"},"users":{"additionalProperties":{"$ref":"#/components/schemas/FullUserResponse"},"description":"Object containing users","title":"Users","type":"object","x-stream-index":"001","x-stream-map":{"key":"user_id"}}},"required":["users","membership_deletion_task_id","duration"],"type":"object"},"UpsertConfigRequest":{"nullable":true,"properties":{"ai_image_config":{"$ref":"#/components/schemas/AIImageConfig","description":"Configuration for AI image analysis","title":"AI Image Config","x-stream-index":"010"},"ai_text_config":{"$ref":"#/components/schemas/AITextConfig","description":"Configuration for AI text analysis","title":"AI Text Config","x-stream-index":"008"},"ai_video_config":{"$ref":"#/components/schemas/AIVideoConfig","description":"Configuration for AI video analysis","title":"AI Video Config","x-stream-index":"011"},"async":{"description":"Whether moderation should be performed asynchronously","title":"Async","type":"boolean","x-stream-index":"003"},"automod_platform_circumvention_config":{"$ref":"#/components/schemas/AutomodPlatformCircumventionConfig","description":"Configuration for platform circumvention detection","title":"Automod Platform Circumvention Config","x-stream-index":"005"},"automod_semantic_filters_config":{"$ref":"#/components/schemas/AutomodSemanticFiltersConfig","description":"Configuration for semantic filtering","title":"Automod Semantic Filters Config","x-stream-index":"006"},"automod_toxicity_config":{"$ref":"#/components/schemas/AutomodToxicityConfig","description":"Configuration for toxicity detection","title":"Automod Toxicity Config","x-stream-index":"004"},"aws_rekognition_config":{"$ref":"#/components/schemas/AIImageConfig","x-stream-index":"015"},"block_list_config":{"$ref":"#/components/schemas/BlockListConfig","description":"Configuration for block list filtering","title":"Block List Config","x-stream-index":"007"},"bodyguard_config":{"$ref":"#/components/schemas/AITextConfig","x-stream-index":"014"},"google_vision_config":{"$ref":"#/components/schemas/GoogleVisionConfig","description":"Configuration for Google Vision integration","title":"Google Vision Config","x-stream-index":"009"},"key":{"description":"Unique identifier for the moderation configuration","title":"Key","type":"string","x-stream-index":"001"},"rule_builder_config":{"$ref":"#/components/schemas/RuleBuilderConfig","description":"Configuration for custom rule builder (max 3 rules, max 5 conditions per rule)","title":"Rule Builder Config","x-stream-index":"013"},"team":{"description":"Team associated with the configuration","maxLength":128,"minLength":1,"title":"Team","type":"string","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"017.002"},"user_id":{"type":"string","x-stream-index":"017.001"},"velocity_filter_config":{"$ref":"#/components/schemas/VelocityFilterConfig","description":"Configuration for velocity-based filtering","title":"Velocity Filter Config","x-stream-index":"012"},"video_call_rule_config":{"$ref":"#/components/schemas/VideoCallRuleConfig","x-stream-index":"016"}},"required":["key"],"type":"object"},"UpsertConfigResponse":{"nullable":true,"properties":{"config":{"$ref":"#/components/schemas/ConfigResponse","description":"The created or updated moderation configuration","title":"Config","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["duration"],"type":"object"},"UpsertModerationTemplateRequest":{"nullable":true,"properties":{"config":{"$ref":"#/components/schemas/FeedsModerationTemplateConfig","description":"Configuration for the moderation template","title":"Config","x-stream-index":"002"},"name":{"description":"Name of the moderation template","title":"Name","type":"string","x-stream-index":"001"}},"required":["name","config"],"type":"object"},"UpsertModerationTemplateResponse":{"nullable":true,"properties":{"config":{"$ref":"#/components/schemas/FeedsModerationTemplateConfig","description":"Configuration for the moderation template","title":"Config","x-stream-index":"002"},"created_at":{"description":"When the template was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"003"},"duration":{"type":"string","x-stream-index":"005.001"},"name":{"description":"Name of the moderation template","title":"Name","type":"string","x-stream-index":"001"},"updated_at":{"description":"When the template was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"004"}},"required":["name","created_at","updated_at","duration"],"type":"object"},"UpsertPushPreferencesRequest":{"nullable":true,"properties":{"preferences":{"description":"A list of push preferences for channels, calls, or the user.","items":{"$ref":"#/components/schemas/PushPreferenceInput"},"type":"array","x-stream-index":"001"}},"required":["preferences"],"type":"object"},"UpsertPushPreferencesResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"user_channel_preferences":{"additionalProperties":{"additionalProperties":{"$ref":"#/components/schemas/ChannelPushPreferences"},"type":"object"},"description":"The channel specific push notification preferences, only returned for channels you've edited.","title":"User Channel Notification Preferences","type":"object","x-stream-index":"002"},"user_preferences":{"additionalProperties":{"$ref":"#/components/schemas/PushPreferences"},"description":"The user preferences, always returned regardless if you edited it","title":"User Preferences","type":"object","x-stream-index":"001"}},"required":["user_preferences","user_channel_preferences","duration"],"type":"object"},"UpsertPushProviderRequest":{"nullable":true,"properties":{"push_provider":{"$ref":"#/components/schemas/PushProvider","x-stream-index":"001"}},"type":"object"},"UpsertPushProviderResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"push_provider":{"$ref":"#/components/schemas/PushProviderResponse","x-stream-index":"001"}},"required":["push_provider","duration"],"title":"Response","type":"object"},"UpsertPushTemplateRequest":{"nullable":true,"properties":{"enable_push":{"description":"Whether to send push notification for this event","title":"boolean","type":"boolean","x-stream-index":"002"},"event_type":{"description":"Event type (message.new, message.updated, reaction.new)","enum":["message.new","message.updated","reaction.new","notification.reminder_due"],"title":"string","type":"string","x-stream-index":"003"},"push_provider_name":{"description":"Push provider name","title":"string","type":"string","x-stream-index":"004"},"push_provider_type":{"description":"Push provider type (firebase, apn)","enum":["firebase","apn"],"title":"string","type":"string","x-stream-index":"005"},"template":{"description":"Push template","title":"string","type":"string","x-stream-index":"006"}},"required":["event_type","push_provider_type"],"type":"object"},"UpsertPushTemplateResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"template":{"$ref":"#/components/schemas/PushTemplate","x-stream-index":"002"}},"required":["duration"],"title":"Response","type":"object"},"User":{"properties":{"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"046"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"017"},"banned":{"type":"boolean","x-stream-index":"016"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"013"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"023"},"language":{"type":"string","x-stream-index":"035"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"026"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"042"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"005"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"009"}},"required":["id","role","teams_role","custom","banned","online"],"type":"object"},"UserBannedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"006.002"},"channel_type":{"type":"string","x-stream-index":"006.003"},"cid":{"type":"string","x-stream-index":"006.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008.002"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"001"},"expiration":{"format":"date-time","type":"number","x-stream-index":"003"},"reason":{"type":"string","x-stream-index":"004"},"shadow":{"type":"boolean","x-stream-index":"002"},"team":{"type":"string","x-stream-index":"005.001"},"type":{"default":"user.banned","type":"string","x-stream-index":"008.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007.001"}},"required":["created_by","shadow","cid","channel_id","channel_type","type","created_at"],"title":"UserBannedEvent","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"},"UserCreatedWithinParameters":{"properties":{"max_age":{"type":"string","x-stream-index":"001"}},"type":"object"},"UserCustomEventRequest":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"001"}},"required":["type"],"type":"object"},"UserDeactivatedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"001"},"type":{"default":"user.deactivated","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["created_by","type","created_at"],"title":"UserDeactivatedEvent","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"},"UserDeletedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"delete_conversation_channels":{"type":"boolean","x-stream-index":"005"},"hard_delete":{"type":"boolean","x-stream-index":"003.001"},"mark_messages_deleted":{"type":"boolean","x-stream-index":"004"},"type":{"default":"user.deleted","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"001.001"}},"required":["type","created_at","hard_delete","mark_messages_deleted","delete_conversation_channels"],"title":"UserDeletedEvent","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"},"UserFlaggedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"target_user":{"type":"string","x-stream-index":"002"},"target_users":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"type":{"default":"user.flagged","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"001"}},"required":["type","created_at"],"title":"UserFlaggedEvent","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"},"UserMute":{"nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"expires":{"description":"Date/time of mute expiration","format":"date-time","title":"Expires","type":"number","x-stream-index":"008"},"target":{"$ref":"#/components/schemas/User","description":"User who's muted","title":"Target","x-stream-index":"007"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/User","description":"Owner of channel mute","title":"User","x-stream-index":"005"}},"required":["created_at","updated_at"],"type":"object"},"UserMuteResponse":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"expires":{"format":"date-time","type":"number","x-stream-index":"003"},"target":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"}},"required":["created_at","updated_at"],"type":"object"},"UserMutedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"target_user":{"type":"string","x-stream-index":"001"},"target_users":{"items":{"type":"string"},"type":"array","x-stream-index":"002"},"type":{"default":"user.muted","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"UserMutedEvent","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"},"UserReactivatedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"type":{"default":"user.reactivated","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"001"}},"required":["type","created_at"],"title":"UserReactivatedEvent","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"},"UserRequest":{"description":"User request object","properties":{"custom":{"additionalProperties":{},"description":"Custom user data","title":"Custom","type":"object","x-stream-index":"004"},"id":{"description":"User ID","title":"ID","type":"string","x-stream-index":"001"},"image":{"description":"User's profile image URL","title":"Image","type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"006"},"language":{"type":"string","x-stream-index":"005"},"name":{"description":"Optional name of user","title":"Name","type":"string","x-stream-index":"002"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"007"},"role":{"description":"User's global role","title":"Role","type":"string","x-stream-index":"008"},"teams":{"description":"List of teams the user belongs to","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"010"},"teams_role":{"additionalProperties":{"type":"string"},"description":"Map of team-specific roles for the user","title":"TeamsRole","type":"object","x-stream-index":"009"}},"required":["id"],"title":"UserRequest","type":"object"},"UserResponse":{"description":"User response object","properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"ban_expires":{"description":"Date when ban expires","format":"date-time","title":"Ban expires","type":"number","x-stream-index":"003"},"banned":{"description":"Whether a user is banned or not","title":"Banned","type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.017"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"001.004"},"deactivated_at":{"description":"Date of deactivation","format":"date-time","title":"Deactivated at","type":"number","x-stream-index":"001.016"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"001.011"},"devices":{"description":"List of devices user is using","items":{"$ref":"#/components/schemas/DeviceResponse"},"title":"Devices","type":"array","x-stream-index":"006"},"id":{"description":"Unique user identifier","title":"ID","type":"string","x-stream-index":"001.001"},"image":{"title":"Image","type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"007"},"language":{"description":"Preferred language of a user","title":"Language","type":"string","x-stream-index":"001.005"},"last_active":{"description":"Date of last activity","format":"date-time","title":"Last active","type":"number","x-stream-index":"001.014"},"name":{"description":"Optional name of user","title":"Name","type":"string","x-stream-index":"001.002"},"online":{"description":"Whether a user online or not","title":"Online","type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","description":"User privacy settings","title":"Privacy settings","x-stream-index":"005"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettingsResponse","description":"User push notification settings","title":"Push notifications","x-stream-index":"004"},"revoke_tokens_issued_before":{"description":"Revocation date for tokens","format":"date-time","title":"Revoke tokens issued before","type":"number","x-stream-index":"001.015"},"role":{"description":"Determines the set of user permissions","title":"Role","type":"string","x-stream-index":"001.006"},"shadow_banned":{"description":"Whether a user is shadow banned","title":"Shadow banned","type":"boolean","x-stream-index":"002"},"teams":{"description":"List of teams user is a part of","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids","shadow_banned","invisible"],"title":"UserResponse","type":"object"},"UserResponseCommonFields":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"018"},"banned":{"type":"boolean","x-stream-index":"012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"017"},"created_at":{"format":"date-time","type":"number","x-stream-index":"009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"id":{"type":"string","x-stream-index":"001"},"image":{"type":"string","x-stream-index":"003"},"language":{"type":"string","x-stream-index":"005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"014"},"name":{"type":"string","x-stream-index":"002"},"online":{"type":"boolean","x-stream-index":"013"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"015"},"role":{"type":"string","x-stream-index":"006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids"],"type":"object"},"UserResponsePrivacyFields":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"banned":{"type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.017"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.011"},"id":{"type":"string","x-stream-index":"001.001"},"image":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"003"},"language":{"type":"string","x-stream-index":"001.005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"001.014"},"name":{"type":"string","x-stream-index":"001.002"},"online":{"type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"002"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.015"},"role":{"type":"string","x-stream-index":"001.006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids"],"type":"object"},"UserRuleParameters":{"properties":{"max_age":{"type":"string","x-stream-index":"001"}},"type":"object"},"UserUnbannedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"005.002"},"shadow":{"type":"boolean","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"004.001"},"type":{"default":"user.unbanned","type":"string","x-stream-index":"005.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["shadow","cid","channel_id","channel_type","type","created_at"],"title":"UserUnbannedEvent","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"},"UserUnmutedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"target_user":{"type":"string","x-stream-index":"002"},"target_users":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"type":{"default":"user.unmuted","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"001"}},"required":["type","created_at"],"title":"UserUnmutedEvent","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"},"UserUnreadReminderEvent":{"properties":{"channels":{"additionalProperties":{"$ref":"#/components/schemas/ChannelMessages"},"type":"object","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"user.unread_message_reminder","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002"}},"required":["type","created_at","channels"],"title":"UserUnreadReminderEvent","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"},"UserUpdatedEvent":{"description":"This event is sent when a user gets updated. The event contains information about the updated user.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"type":{"default":"user.updated","description":"The type of event: \"user.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.002"},"user":{"$ref":"#/components/schemas/UserResponsePrivacyFields","description":"The updated user","title":"User","x-stream-index":"002.001"}},"required":["type","created_at","custom","user"],"title":"UserUpdatedEvent","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"},"VelocityFilterConfig":{"properties":{"advanced_filters":{"type":"boolean","x-stream-index":"007"},"async":{"type":"boolean","x-stream-index":"001"},"cascading_actions":{"type":"boolean","x-stream-index":"004"},"cids_per_user":{"format":"int32","type":"integer","x-stream-index":"006"},"enabled":{"type":"boolean","x-stream-index":"002"},"first_message_only":{"type":"boolean","x-stream-index":"005"},"rules":{"items":{"$ref":"#/components/schemas/VelocityFilterConfigRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules","cascading_actions","first_message_only","cids_per_user","advanced_filters"],"type":"object"},"VelocityFilterConfigRule":{"properties":{"action":{"enum":["flag","shadow","remove","ban"],"type":"string","x-stream-index":"001"},"ban_duration":{"format":"int32","type":"integer","x-stream-index":"002"},"cascading_action":{"enum":["flag","shadow","remove","ban"],"type":"string","x-stream-index":"006"},"cascading_threshold":{"format":"int64","type":"integer","x-stream-index":"005"},"check_message_context":{"type":"boolean","x-stream-index":"009"},"fast_spam_threshold":{"format":"int32","type":"integer","x-stream-index":"007"},"fast_spam_ttl":{"format":"int32","type":"integer","x-stream-index":"010"},"ip_ban":{"type":"boolean","x-stream-index":"004"},"probation_period":{"format":"int32","type":"integer","x-stream-index":"014"},"shadow_ban":{"type":"boolean","x-stream-index":"003"},"slow_spam_ban_duration":{"format":"int32","type":"integer","x-stream-index":"012"},"slow_spam_threshold":{"format":"int32","type":"integer","x-stream-index":"008"},"slow_spam_ttl":{"format":"int32","type":"integer","x-stream-index":"011"},"url_only":{"type":"boolean","x-stream-index":"013"}},"required":["action","ban_duration","shadow_ban","ip_ban","cascading_threshold","cascading_action","fast_spam_threshold","slow_spam_threshold","check_message_context","fast_spam_ttl","slow_spam_ttl","url_only","probation_period"],"type":"object"},"VideoCallRuleConfig":{"properties":{"rules":{"additionalProperties":{"$ref":"#/components/schemas/HarmConfig"},"type":"object","x-stream-index":"001"}},"required":["rules"],"type":"object"},"VideoContentParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"type":"object"},"VideoEndCallRequest":{"type":"object"},"VideoKickUserRequest":{"type":"object"},"VideoOrientation":{"properties":{"orientation":{"type":"integer","x-stream-index":"004"}},"type":"object"},"VideoRuleParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"required":["threshold","time_window"],"type":"object"},"VideoSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"camera_default_on":{"type":"boolean","x-stream-index":"004"},"camera_facing":{"enum":["front","back","external"],"type":"string","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled","target_resolution","camera_default_on","camera_facing"],"type":"object"},"VideoSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"camera_default_on":{"type":"boolean","x-stream-index":"004"},"camera_facing":{"enum":["front","back","external"],"type":"string","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled","target_resolution","camera_default_on","camera_facing"],"type":"object"},"VoteData":{"properties":{"answer_text":{"type":"string","x-stream-index":"002"},"option_id":{"maxLength":255,"type":"string","x-stream-index":"001"}},"type":"object"},"WSEvent":{"description":"Represents an BaseEvent that happened in Stream Chat","properties":{"automoderation":{"type":"boolean","x-stream-index":"023"},"automoderation_scores":{"$ref":"#/components/schemas/ModerationResponse","x-stream-index":"024"},"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"011"},"channel_id":{"type":"string","x-stream-index":"004"},"channel_last_message_at":{"format":"date-time","type":"number","x-stream-index":"007"},"channel_type":{"type":"string","x-stream-index":"005"},"cid":{"type":"string","x-stream-index":"003"},"connection_id":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"028"},"created_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"022"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"027"},"me":{"$ref":"#/components/schemas/OwnUserResponse","x-stream-index":"019"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"014"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"008"},"message_update":{"$ref":"#/components/schemas/MessageUpdate","x-stream-index":"009"},"parent_id":{"type":"string","x-stream-index":"025"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"015"},"poll_vote":{"$ref":"#/components/schemas/PollVoteResponseData","x-stream-index":"016"},"reaction":{"$ref":"#/components/schemas/ReactionResponse","x-stream-index":"010"},"reason":{"type":"string","x-stream-index":"021"},"team":{"type":"string","x-stream-index":"026"},"thread":{"$ref":"#/components/schemas/ThreadResponse","x-stream-index":"013"},"thread_id":{"type":"string","x-stream-index":"012"},"type":{"type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"017"},"user_id":{"type":"string","x-stream-index":"018"},"watcher_count":{"format":"int32","type":"integer","x-stream-index":"020"}},"required":["type","custom","created_at"],"title":"Event","type":"object","x-stream-docs-page-id":"event_object"},"WebhookEvent":{"description":"The discriminator object for all webhook events, it maps events' payload to the final type","discriminator":{"mapping":{"*":"#/components/schemas/AnyEvent","activity.marked":"#/components/schemas/ActivityMarkedEvent","campaign.completed":"#/components/schemas/CampaignCompletedEvent","campaign.started":"#/components/schemas/CampaignStartedEvent","channel.created":"#/components/schemas/ChannelCreatedEvent","channel.deleted":"#/components/schemas/ChannelDeletedEvent","channel.frozen":"#/components/schemas/ChannelFrozenEvent","channel.hidden":"#/components/schemas/ChannelHiddenEvent","channel.muted":"#/components/schemas/ChannelMutedEvent","channel.truncated":"#/components/schemas/ChannelTruncatedEvent","channel.unfrozen":"#/components/schemas/ChannelUnFrozenEvent","channel.unmuted":"#/components/schemas/ChannelUnmutedEvent","channel.updated":"#/components/schemas/ChannelUpdatedEvent","channel.visible":"#/components/schemas/ChannelVisibleEvent","export.bulk_image_moderation.error":"#/components/schemas/AsyncExportErrorEvent","export.bulk_image_moderation.success":"#/components/schemas/AsyncBulkImageModerationEvent","export.channels.error":"#/components/schemas/AsyncExportErrorEvent","export.channels.success":"#/components/schemas/AsyncExportChannelsEvent","export.moderation_logs.error":"#/components/schemas/AsyncExportErrorEvent","export.moderation_logs.success":"#/components/schemas/AsyncExportModerationLogsEvent","export.users.error":"#/components/schemas/AsyncExportErrorEvent","export.users.success":"#/components/schemas/AsyncExportUsersEvent","flag.updated":"#/components/schemas/FlagUpdatedEvent","member.added":"#/components/schemas/MemberAddedEvent","member.removed":"#/components/schemas/MemberRemovedEvent","member.updated":"#/components/schemas/MemberUpdatedEvent","message.deleted":"#/components/schemas/MessageDeletedEvent","message.flagged":"#/components/schemas/MessageFlaggedEvent","message.new":"#/components/schemas/MessageNewEvent","message.pending":"#/components/schemas/PendingMessageEvent","message.read":"#/components/schemas/MessageReadEvent","message.unblocked":"#/components/schemas/MessageUnblockedEvent","message.undeleted":"#/components/schemas/MessageUndeletedEvent","message.updated":"#/components/schemas/MessageUpdatedEvent","moderation.custom_action":"#/components/schemas/ModerationCustomActionEvent","moderation.flagged":"#/components/schemas/ModerationFlaggedEvent","moderation.mark_reviewed":"#/components/schemas/ModerationMarkReviewedEvent","moderation_check.completed":"#/components/schemas/ModerationCheckCompletedEvent","notification.mark_unread":"#/components/schemas/NotificationMarkUnreadEvent","notification.reminder_due":"#/components/schemas/ReminderNotificationEvent","notification.thread_message_new":"#/components/schemas/MessageNewEvent","reaction.deleted":"#/components/schemas/ReactionDeletedEvent","reaction.new":"#/components/schemas/ReactionNewEvent","reaction.updated":"#/components/schemas/ReactionUpdatedEvent","reminder.created":"#/components/schemas/ReminderCreatedEvent","reminder.deleted":"#/components/schemas/ReminderDeletedEvent","reminder.updated":"#/components/schemas/ReminderUpdatedEvent","review_queue_item.new":"#/components/schemas/ReviewQueueItemNewEvent","review_queue_item.updated":"#/components/schemas/ReviewQueueItemUpdatedEvent","thread.updated":"#/components/schemas/ThreadUpdatedEvent","user.banned":"#/components/schemas/UserBannedEvent","user.deactivated":"#/components/schemas/UserDeactivatedEvent","user.deleted":"#/components/schemas/UserDeletedEvent","user.flagged":"#/components/schemas/UserFlaggedEvent","user.muted":"#/components/schemas/UserMutedEvent","user.reactivated":"#/components/schemas/UserReactivatedEvent","user.unbanned":"#/components/schemas/UserUnbannedEvent","user.unmuted":"#/components/schemas/UserUnmutedEvent","user.unread_message_reminder":"#/components/schemas/UserUnreadReminderEvent","user.updated":"#/components/schemas/UserUpdatedEvent"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/ActivityMarkedEvent"},{"$ref":"#/components/schemas/AnyEvent"},{"$ref":"#/components/schemas/AsyncBulkImageModerationEvent"},{"$ref":"#/components/schemas/AsyncExportChannelsEvent"},{"$ref":"#/components/schemas/AsyncExportErrorEvent"},{"$ref":"#/components/schemas/AsyncExportErrorEvent"},{"$ref":"#/components/schemas/AsyncExportErrorEvent"},{"$ref":"#/components/schemas/AsyncExportErrorEvent"},{"$ref":"#/components/schemas/AsyncExportModerationLogsEvent"},{"$ref":"#/components/schemas/AsyncExportUsersEvent"},{"$ref":"#/components/schemas/CampaignCompletedEvent"},{"$ref":"#/components/schemas/CampaignStartedEvent"},{"$ref":"#/components/schemas/ChannelCreatedEvent"},{"$ref":"#/components/schemas/ChannelDeletedEvent"},{"$ref":"#/components/schemas/ChannelFrozenEvent"},{"$ref":"#/components/schemas/ChannelHiddenEvent"},{"$ref":"#/components/schemas/ChannelMutedEvent"},{"$ref":"#/components/schemas/ChannelTruncatedEvent"},{"$ref":"#/components/schemas/ChannelUnFrozenEvent"},{"$ref":"#/components/schemas/ChannelUnmutedEvent"},{"$ref":"#/components/schemas/ChannelUpdatedEvent"},{"$ref":"#/components/schemas/ChannelVisibleEvent"},{"$ref":"#/components/schemas/FlagUpdatedEvent"},{"$ref":"#/components/schemas/MemberAddedEvent"},{"$ref":"#/components/schemas/MemberRemovedEvent"},{"$ref":"#/components/schemas/MemberUpdatedEvent"},{"$ref":"#/components/schemas/MessageDeletedEvent"},{"$ref":"#/components/schemas/MessageFlaggedEvent"},{"$ref":"#/components/schemas/MessageNewEvent"},{"$ref":"#/components/schemas/MessageNewEvent"},{"$ref":"#/components/schemas/MessageReadEvent"},{"$ref":"#/components/schemas/MessageUnblockedEvent"},{"$ref":"#/components/schemas/MessageUndeletedEvent"},{"$ref":"#/components/schemas/MessageUpdatedEvent"},{"$ref":"#/components/schemas/ModerationCheckCompletedEvent"},{"$ref":"#/components/schemas/ModerationCustomActionEvent"},{"$ref":"#/components/schemas/ModerationFlaggedEvent"},{"$ref":"#/components/schemas/ModerationMarkReviewedEvent"},{"$ref":"#/components/schemas/NotificationMarkUnreadEvent"},{"$ref":"#/components/schemas/PendingMessageEvent"},{"$ref":"#/components/schemas/ReactionDeletedEvent"},{"$ref":"#/components/schemas/ReactionNewEvent"},{"$ref":"#/components/schemas/ReactionUpdatedEvent"},{"$ref":"#/components/schemas/ReminderCreatedEvent"},{"$ref":"#/components/schemas/ReminderDeletedEvent"},{"$ref":"#/components/schemas/ReminderNotificationEvent"},{"$ref":"#/components/schemas/ReminderUpdatedEvent"},{"$ref":"#/components/schemas/ReviewQueueItemNewEvent"},{"$ref":"#/components/schemas/ReviewQueueItemUpdatedEvent"},{"$ref":"#/components/schemas/ThreadUpdatedEvent"},{"$ref":"#/components/schemas/UserBannedEvent"},{"$ref":"#/components/schemas/UserDeactivatedEvent"},{"$ref":"#/components/schemas/UserDeletedEvent"},{"$ref":"#/components/schemas/UserFlaggedEvent"},{"$ref":"#/components/schemas/UserMutedEvent"},{"$ref":"#/components/schemas/UserReactivatedEvent"},{"$ref":"#/components/schemas/UserUnbannedEvent"},{"$ref":"#/components/schemas/UserUnmutedEvent"},{"$ref":"#/components/schemas/UserUnreadReminderEvent"},{"$ref":"#/components/schemas/UserUpdatedEvent"}]},"WrappedUnreadCountsResponse":{"description":"Basic response information","nullable":true,"properties":{"channel_type":{"items":{"$ref":"#/components/schemas/UnreadCountsChannelType"},"type":"array","x-stream-index":"001.005"},"channels":{"items":{"$ref":"#/components/schemas/UnreadCountsChannel"},"type":"array","x-stream-index":"001.004"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"threads":{"items":{"$ref":"#/components/schemas/UnreadCountsThread"},"type":"array","x-stream-index":"001.006"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"001.001"},"total_unread_count_by_team":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001.003"},"total_unread_threads_count":{"format":"int32","type":"integer","x-stream-index":"001.002"}},"required":["total_unread_count","total_unread_threads_count","channels","channel_type","threads","duration"],"title":"Response","type":"object"},"XiaomiConfig":{"properties":{"Disabled":{"type":"boolean","writeOnly":true,"x-stream-index":"003"},"package_name":{"type":"string","x-stream-index":"001"},"secret":{"type":"string","x-stream-index":"002"}},"type":"object"},"XiaomiConfigFields":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"package_name":{"type":"string","x-stream-index":"002"},"secret":{"type":"string","x-stream-index":"003"}},"required":["enabled"],"type":"object"}},"securitySchemes":{"JWT":{"description":"JWT should be always provided when stream-auth-type=jwt.\n\nUsing JWT auth request could be authenticated as user or as server-side.\n\nWhen using user authentication permission checking is going to be applied to requests based on the user that is\nperforming a request.\n\nThe `authorization` header should be a JWT string signed using the secret attached to the API key used to perform\nrequests.\n\n**WARNING** all client-side official SDK do not ship with token generation; this is to make sure that the API secret is not\nshared with an untrusted party such as a browser or a iOS/Android application. Tokens **must** be generated server-side.\nIf you wish, you can configure your application to ignore authentication (see `disable_auth_check`)\nThe JWT string must include only the user_id claim and can include any built-in JWT claim such as iat, exp as well.\n","in":"header","name":"Authorization","type":"apiKey"},"api_key":{"description":"Application API key should be always set in order to authenticate the request.","in":"query","name":"api_key","type":"apiKey"},"stream-auth-type":{"description":"Stream-Auth-Type should be always set in order to authenticate the request. Possible\nvalues: `jwt` or `anonymous`.\n\n`jwt` allows you to authenticate as a user. With this auth type you should also provide valid JWT in Authorization\nheader.\n\n`anonymous` allows you to authenticate as anonymous user. Please note that most advanced features are not available\nto anonymous users.","in":"header","name":"Stream-Auth-Type","type":"apiKey"}}},"info":{"title":"Stream API","version":"v187.13.0"},"openapi":"3.0.3","paths":{"/api/v2/app":{"get":{"description":"This Method returns the application settings\n","operationId":"GetApp","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetApplicationResponse"}}},"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":"Get App Settings","tags":["product:common"]},"patch":{"description":"This Method updates one or more application settings\n","operationId":"UpdateApp","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAppRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Update App Settings","tags":["product:common"]}},"/api/v2/blocklists":{"get":{"description":"Returns all available block lists\n","operationId":"ListBlockLists","parameters":[{"in":"query","name":"team","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListBlockListResponse"}}},"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":"List block lists","tags":["product:common"]},"post":{"description":"Creates a new application blocklist, once created the blocklist can be used by any channel type\n","operationId":"CreateBlockList","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBlockListRequest"}}},"description":"Block list","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBlockListResponse"}}},"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":"Create block list","tags":["product:common"]}},"/api/v2/blocklists/{name}":{"delete":{"description":"Deletes previously created application blocklist\n","operationId":"DeleteBlockList","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"team","schema":{"type":"string","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete block list","tags":["product:common"]},"get":{"description":"Returns block list by given name\n","operationId":"GetBlockList","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Block list name","title":"Name","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"team","schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBlockListResponse"}}},"description":"GetBlockListResponse"},"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":"Get block list","tags":["product:common"]},"put":{"description":"Updates contents of the block list\n","operationId":"UpdateBlockList","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Block list name","title":"Name","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBlockListRequest"}}},"description":"Update block list","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBlockListResponse"}}},"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":"Update block list","tags":["product:common"]}},"/api/v2/chat/campaigns/query":{"post":{"description":"Query campaigns with filter query\n","operationId":"QueryCampaigns","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCampaignsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCampaignsResponse"}}},"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":"Query campaigns","tags":["product:chat"]}},"/api/v2/chat/campaigns/{id}":{"get":{"description":"Get campaign by ID.\n","operationId":"GetCampaign","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"The ID of the campaign (uuid)","maxLength":255,"title":"Campaign ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"prev","schema":{"description":"Token for the previous page of campaign users","title":"Previous Users Page","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"query","name":"next","schema":{"description":"Token for the next page of campaign users","title":"Next Users Page","type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"limit","schema":{"description":"Maximum number of campaign users to return in a single request (max: 1000)","format":"int32","maximum":1000,"minimum":0,"title":"Users Limit","type":"integer","writeOnly":true,"x-stream-index":"002.003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCampaignResponse"}}},"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":"Get campaign","tags":["product:chat"]}},"/api/v2/chat/campaigns/{id}/start":{"post":{"description":"Starts or schedules a campaign\n","operationId":"StartCampaign","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartCampaignRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartCampaignResponse"}}},"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":"Start/schedule campaign","tags":["product:chat"]}},"/api/v2/chat/campaigns/{id}/stop":{"post":{"description":"Stops a campaign\n","operationId":"ScheduleCampaign","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopCampaignRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignResponse"}}},"description":"Successful 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":"Stop campaign","tags":["product:chat"]}},"/api/v2/chat/channels":{"post":{"description":"Query channels with filter query\n","operationId":"QueryChannels","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryChannelsRequest"}}},"description":"Query Channels Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryChannelsResponse"}}},"description":"Channels list"},"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":"Query channels","tags":["product:chat"]}},"/api/v2/chat/channels/delete":{"post":{"description":"Allows to delete several channels at once asynchronously\n\nSends events:\n- channel.deleted\n- channel.deleted\n","operationId":"DeleteChannels","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteChannelsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteChannelsResponse"}}},"description":"Successful 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":"Deletes channels asynchronously","tags":["product:chat"]}},"/api/v2/chat/channels/read":{"post":{"description":"Marks channels as read up to the specific message. If no channels is given, mark all channel as read\n\nSends events:\n- message.read\n- message.read\n","operationId":"MarkChannelsRead","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkChannelsReadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkReadResponse"}}},"description":"Successful 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 channels as read","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/query":{"post":{"description":"This Method creates a channel or returns an existing one with matching attributes\n\nSends events:\n- channel.created\n- member.added\n- member.removed\n- member.updated\n- user.watching.start\n","operationId":"GetOrCreateDistinctChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelGetOrCreateRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelStateResponse"}}},"description":"Successful 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":"Get or create channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}":{"delete":{"description":"Deletes channel\n\nSends events:\n- channel.deleted\n- channel.deleted\n","operationId":"DeleteChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"query","name":"hard_delete","schema":{"type":"boolean","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteChannelResponse"}}},"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":"Delete channel","tags":["product:chat"]},"patch":{"description":"Updates certain fields of the channel\n\nSends events:\n- channel.updated\n- channel.updated\n","operationId":"UpdateChannelPartial","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelPartialRequest"}}},"description":"UpdateChannelPartialRequest","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelPartialResponse"}}},"description":"Successful 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":"Partially update channel","tags":["product:chat"]},"post":{"description":"Change channel data\n\nSends events:\n- channel.updated\n- member.added\n- member.removed\n- member.updated\n- message.new\n- channel.updated\n- member.added\n- member.removed\n- member.updated\n- message.new\n","operationId":"UpdateChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"013.002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"013.002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelRequest"}}},"description":"Channel update request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelResponse"}}},"description":"Successful 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":"Update channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/draft":{"delete":{"description":"Deletes a draft\n\nSends events:\n- draft.deleted\n","operationId":"DeleteDraft","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"parent_id","schema":{"description":"Parent message ID","title":"string","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"003.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete draft","tags":["product:chat"]},"get":{"description":"Get a draft\n","operationId":"GetDraft","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"parent_id","schema":{"description":"Parent message ID","title":"string","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"003.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetDraftResponse"}}},"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":"Get draft","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/event":{"post":{"description":"Sends event to the channel\n","operationId":"SendEvent","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendEventRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventResponse"}}},"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":"Send event","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/file":{"delete":{"description":"Deletes previously uploaded file\n","operationId":"DeleteFile","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of file","title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"File ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"url","schema":{"description":"File URL to delete","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete file","tags":["product:chat"]},"post":{"description":"Uploads file\n","operationId":"UploadFile","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/FileUploadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileUploadResponse"}}},"description":"Successful 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":"Upload file","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/hide":{"post":{"description":"Marks channel as hidden for current user\n\nSends events:\n- channel.hidden\n- channel.hidden\n","operationId":"HideChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HideChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HideChannelResponse"}}},"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":"Hide channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/image":{"delete":{"description":"Deletes previously uploaded image\n","operationId":"DeleteImage","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of file","title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"File ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"url","schema":{"description":"File URL to delete","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete image","tags":["product:chat"]},"post":{"description":"Uploads image\n","operationId":"UploadImage","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.001.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.001.002"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/ImageUploadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageUploadResponse"}}},"description":"Successful 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":"Upload image","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/member":{"patch":{"description":"\n","operationId":"UpdateMemberPartial","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"005.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMemberPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMemberPartialResponse"}}},"description":"Successful 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":"Partially channel member update","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/message":{"post":{"description":"Sends new message to the specified channel\n\nSends events:\n- message.new\n- message.updated\n- message.new\n- message.updated\n","operationId":"SendMessage","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"009.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"009.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendMessageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendMessageResponse"}}},"description":"Successful 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":"Send new message","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/messages":{"get":{"description":"Returns list messages found by IDs\n","operationId":"GetManyMessages","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"ids","required":true,"schema":{"description":"List of comma-separated IDs","items":{"type":"string"},"maximum":50,"minimum":1,"title":"IDs","type":"array","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetManyMessagesResponse"}}},"description":"Successful 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":"Get many messages","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/query":{"post":{"description":"This Method creates a channel or returns an existing one with matching attributes\n\nSends events:\n- channel.created\n- member.added\n- member.removed\n- member.updated\n- user.watching.start\n","operationId":"GetOrCreateChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID (maximum length of 64 characters)","title":"ID","type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelGetOrCreateRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelStateResponse"}}},"description":"Successful 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":"Get or create channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/read":{"post":{"description":"Marks channel as read up to the specific message\n\nSends events:\n- message.read\n- message.read\n","operationId":"MarkRead","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkReadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkReadResponse"}}},"description":"Successful 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 read","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/show":{"post":{"description":"Shows previously hidden channel\n\nSends events:\n- channel.visible\n- channel.visible\n","operationId":"ShowChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShowChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShowChannelResponse"}}},"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":"Show channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/truncate":{"post":{"description":"Truncates messages from a channel. Can be applied to the entire channel or scoped to specific members.\n\nSends events:\n- channel.truncated\n- channel.truncated\n","operationId":"TruncateChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TruncateChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TruncateChannelResponse"}}},"description":"Successful 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":"Truncate channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/unread":{"post":{"description":"Marks channel as unread from a specific message\n","operationId":"MarkUnread","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkUnreadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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 unread","tags":["product:chat"]}},"/api/v2/chat/channeltypes":{"get":{"description":"Lists all available channel types\n","operationId":"ListChannelTypes","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListChannelTypesResponse"}}},"description":"ListChannelTypesResponse"},"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":"List channel types","tags":["product:chat"]},"post":{"description":"Creates new channel type\n","operationId":"CreateChannelType","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateChannelTypeRequest"}}},"description":"CreateChannelTypeRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateChannelTypeResponse"}}},"description":"Successful 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":"Create channel type","tags":["product:chat"]}},"/api/v2/chat/channeltypes/{name}":{"delete":{"description":"Deletes channel type\n","operationId":"DeleteChannelType","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Channel type name","title":"Name","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete channel type","tags":["product:chat"]},"get":{"description":"Gets channel type\n","operationId":"GetChannelType","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Channel type name","title":"Name","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetChannelTypeResponse"}}},"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":"Get channel type","tags":["product:chat"]},"put":{"description":"Updates channel type\n","operationId":"UpdateChannelType","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelTypeRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelTypeResponse"}}},"description":"Successful 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":"Update channel type","tags":["product:chat"]}},"/api/v2/chat/commands":{"get":{"description":"Returns all custom commands\n","operationId":"ListCommands","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListCommandsResponse"}}},"description":"ListCommandsResponse"},"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":"List commands","tags":["product:chat"]},"post":{"description":"Creates custom chat command\n","operationId":"CreateCommand","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCommandRequest"}}},"description":"CreateCommandRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCommandResponse"}}},"description":"CreateCommandResponse"},"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":"Create command","tags":["product:chat"]}},"/api/v2/chat/commands/{name}":{"delete":{"description":"Deletes custom chat command\n","operationId":"DeleteCommand","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Command name","title":"Name","type":"string","x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCommandResponse"}}},"description":"DeleteCommandResponse"},"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":"Delete command","tags":["product:chat"]},"get":{"description":"Returns custom command by its name\n","operationId":"GetCommand","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Command name","title":"Name","type":"string","x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCommandResponse"}}},"description":"GetCommandResponse"},"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":"Get command","tags":["product:chat"]},"put":{"description":"Updates custom chat command\n","operationId":"UpdateCommand","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Unique command name","title":"Name","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCommandRequest"}}},"description":"UpdateCommandRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCommandResponse"}}},"description":"UpdateCommandResponse"},"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":"Update command","tags":["product:chat"]}},"/api/v2/chat/drafts/query":{"post":{"description":"Queries draft messages for a user\n","operationId":"QueryDrafts","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryDraftsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryDraftsResponse"}}},"description":"Successful 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":"Query draft messages","tags":["product:chat"]}},"/api/v2/chat/export_channels":{"post":{"description":"Exports channel data to JSON file\n","operationId":"ExportChannels","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportChannelsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportChannelsResponse"}}},"description":"Successful 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":"Export channels","tags":["product:chat"]}},"/api/v2/chat/members":{"get":{"description":"Find and filter channel members\n","operationId":"QueryMembers","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryMembersPayload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MembersResponse"}}},"description":"Successful 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":"Query members","tags":["product:chat"]}},"/api/v2/chat/messages/history":{"post":{"description":"Queries history for one message\n","operationId":"QueryMessageHistory","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryMessageHistoryRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryMessageHistoryResponse"}}},"description":"Successful 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":"Query message history","tags":["product:chat"]}},"/api/v2/chat/messages/{id}":{"delete":{"description":"Deletes message\n\nSends events:\n- message.deleted\n- message.deleted\n","operationId":"DeleteMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID to delete","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"hard","schema":{"description":"Delete all message reactions and replies as well","title":"Hard","type":"boolean","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"deleted_by","schema":{"type":"string","writeOnly":true,"x-stream-index":"003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteMessageResponse"}}},"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":"Delete message","tags":["product:chat"]},"get":{"description":"Returns message by ID\n","operationId":"GetMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"ID of the message","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"show_deleted_message","schema":{"description":"Whether to show deleted message","title":"Show deleted message","type":"boolean","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetMessageResponse"}}},"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":"Get message","tags":["product:chat"]},"post":{"description":"Updates message with new data\n\nSends events:\n- message.updated\n- message.updated\n","operationId":"UpdateMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"004.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessageResponse"}}},"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":"Update message","tags":["product:chat"]},"put":{"description":"Updates certain fields of the message\n\nSends events:\n- message.updated\n- message.updated\n","operationId":"UpdateMessagePartial","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessagePartialRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessagePartialResponse"}}},"description":"Successful 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":"Partially message update","tags":["product:chat"]}},"/api/v2/chat/messages/{id}/action":{"post":{"description":"Executes message command action with given parameters\n\nSends events:\n- message.new\n- message.new\n","operationId":"RunMessageAction","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageActionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}},"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":"Run message command action","tags":["product:chat"]}},"/api/v2/chat/messages/{id}/commit":{"post":{"description":"Commits a pending message, which will make it visible in the channel\n\nSends events:\n- message.new\n- message.updated\n- message.new\n- message.updated\n","operationId":"CommitMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommitMessageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}},"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":"Commit message","tags":["product:chat"]}},"/api/v2/chat/messages/{id}/reaction":{"post":{"description":"Sends reaction to specified message\n\nSends events:\n- reaction.new\n- reaction.updated\n","operationId":"SendReaction","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID to send reaction for","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendReactionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendReactionResponse"}}},"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":"Send reaction","tags":["product:chat"]}},"/api/v2/chat/messages/{id}/reaction/{type}":{"delete":{"description":"Removes user reaction from the message\n\nSends events:\n- reaction.deleted\n","operationId":"DeleteReaction","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID to remove reaction from","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"type","required":true,"schema":{"description":"Reaction type to remove","title":"Type","type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"description":"**Server-side only**. User ID which server acts upon","title":"User ID","type":"string","writeOnly":true,"x-stream-index":"003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteReactionResponse"}}},"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":"Delete reaction","tags":["product:chat"]}},"/api/v2/chat/messages/{id}/reactions":{"get":{"description":"Returns list of reactions of specific message\n","operationId":"GetReactions","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"limit","schema":{"description":"Number of records to return","format":"int32","title":"Limit","type":"integer","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"offset","schema":{"description":"Number of records to offset","format":"int32","title":"Offset","type":"integer","writeOnly":true,"x-stream-index":"003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetReactionsResponse"}}},"description":"Successful 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":"Get reactions","tags":["product:chat"]},"post":{"description":"Get reactions on a message\n","operationId":"QueryReactions","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryReactionsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryReactionsResponse"}}},"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"}},"tags":["product:chat"]}},"/api/v2/chat/messages/{id}/translate":{"post":{"description":"Translates message to a given language using automated translation software\n\nSends events:\n- message.updated\n- message.updated\n","operationId":"TranslateMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TranslateMessageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}},"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":"Translate message","tags":["product:chat"]}},"/api/v2/chat/messages/{id}/undelete":{"post":{"description":"Undelete a message that was previously soft-deleted\n\nSends events:\n- message.undeleted\n- message.undeleted\n","operationId":"UndeleteMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"004.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessageResponse"}}},"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":"Undelete message","tags":["product:chat"]}},"/api/v2/chat/messages/{message_id}/polls/{poll_id}/vote":{"post":{"description":"Cast a vote on a poll\n\nSends events:\n- feeds.poll.vote_casted\n- feeds.poll.vote_changed\n- feeds.poll.vote_removed\n- poll.vote_casted\n- poll.vote_changed\n- poll.vote_removed\n","operationId":"CastPollVote","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CastPollVoteRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollVoteResponse"}}},"description":"Successful 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":"Cast vote","tags":["product:chat"]}},"/api/v2/chat/messages/{message_id}/polls/{poll_id}/vote/{vote_id}":{"delete":{"description":"Delete a vote from a poll\n\nSends events:\n- feeds.poll.vote_removed\n- poll.vote_removed\n","operationId":"DeletePollVote","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"004"}},{"in":"path","name":"vote_id","required":true,"schema":{"description":"Vote ID","maxLength":255,"title":"string","type":"string","x-stream-index":"005"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollVoteResponse"}}},"description":"Successful 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":"Delete vote","tags":["product:chat"]}},"/api/v2/chat/messages/{message_id}/reminders":{"delete":{"description":"Deletes a user's created reminder\n\nSends events:\n- reminder.deleted\n","operationId":"DeleteReminder","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteReminderResponse"}}},"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":"Delete reminder","tags":["product:chat"]},"patch":{"description":"Updates an existing reminder\n\nSends events:\n- reminder.updated\n","operationId":"UpdateReminder","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateReminderRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateReminderResponse"}}},"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":"Updates Reminder","tags":["product:chat"]},"post":{"description":"Creates a new reminder\n\nSends events:\n- reminder.created\n","operationId":"CreateReminder","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateReminderRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReminderResponseData"}}},"description":"Successful 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":"Create reminder","tags":["product:chat"]}},"/api/v2/chat/messages/{parent_id}/replies":{"get":{"description":"Returns replies (thread) of the message\n","operationId":"GetReplies","parameters":[{"in":"path","name":"parent_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"sort","schema":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":1,"type":"array","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"limit","schema":{"description":"The maximum number of messages to return (max limit ","format":"int32","minimum":0,"title":"Limit","type":"integer","x-stream-index":"003.001"}},{"in":"query","name":"offset","schema":{"description":"The offset to start from","format":"int32","title":"Offset","type":"integer","x-stream-index":"003.002"}},{"in":"query","name":"id_gte","schema":{"description":"The ID of the message to get messages with a timestamp greater than or equal to","title":"IDGTE","type":"string","x-stream-index":"003.003"}},{"in":"query","name":"id_gt","schema":{"description":"The ID of the message to get messages with a timestamp greater than","title":"IDGT","type":"string","x-stream-index":"003.004"}},{"in":"query","name":"id_lte","schema":{"description":"The ID of the message to get messages with a timestamp smaller than or equal to","title":"IDLTE","type":"string","x-stream-index":"003.005"}},{"in":"query","name":"id_lt","schema":{"description":"The ID of the message to get messages with a timestamp smaller than","title":"IDLT","type":"string","x-stream-index":"003.006"}},{"in":"query","name":"created_at_after_or_equal","schema":{"description":"The timestamp to get messages with a created_at timestamp greater than or equal to","format":"date-time","title":"Created_at after or equal","type":"number","x-stream-index":"003.007"}},{"in":"query","name":"created_at_after","schema":{"description":"The timestamp to get messages with a created_at timestamp greater than","format":"date-time","title":"Created_at after","type":"number","x-stream-index":"003.008"}},{"in":"query","name":"created_at_before_or_equal","schema":{"description":"The timestamp to get messages with a created_at timestamp smaller than or equal to","format":"date-time","title":"Created_at after before or equal","type":"number","x-stream-index":"003.009"}},{"in":"query","name":"created_at_before","schema":{"description":"The timestamp to get messages with a created_at timestamp smaller than","format":"date-time","title":"Created_at after before","type":"number","x-stream-index":"003.010"}},{"in":"query","name":"id_around","schema":{"description":"The result will be a set of messages, that are both older and newer than the message with the provided ID, and the message with the ID provided will be in the middle of the set","title":"Id around","type":"string","x-stream-index":"003.011"}},{"in":"query","name":"created_at_around","schema":{"description":"The result will be a set of messages, that are both older and newer than the created_at timestamp provided, distributed evenly around the timestamp","format":"date-time","title":"Created_at around","type":"number","x-stream-index":"003.012"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRepliesResponse"}}},"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":"Get replies","tags":["product:chat"]}},"/api/v2/chat/moderation/flags/message":{"get":{"description":"Find and filter message flags\n","operationId":"QueryMessageFlags","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryMessageFlagsPayload","description":"JSON object with query message flags payload","title":"Payload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryMessageFlagsResponse"}}},"description":"QueryMessageFlagsResponse"},"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":"Query Message Flags","tags":["product:chat"]}},"/api/v2/chat/moderation/mute/channel":{"post":{"description":"Mutes channel for user\n\nSends events:\n- channel.muted\n- channel.muted\n","operationId":"MuteChannel","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteChannelResponse"}}},"description":"Successful 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":"Mute channel","tags":["product:chat"]}},"/api/v2/chat/moderation/unmute/channel":{"post":{"description":"Unmutes channel for user\n\nSends events:\n- channel.unmuted\n- channel.unmuted\n","operationId":"UnmuteChannel","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnmuteChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnmuteResponse"}}},"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":"Unmute channel","tags":["product:chat"]}},"/api/v2/chat/push_preferences":{"post":{"description":"Update the push preferences for a user and or channel member. Set to all, mentions or none\n","operationId":"UpdatePushNotificationPreferences","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertPushPreferencesRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertPushPreferencesResponse"}}},"description":"Successful 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":"Push notification preferences","tags":["product:chat"]}},"/api/v2/chat/push_templates":{"get":{"description":"Retrieve push notification templates for Chat.\n","operationId":"GetPushTemplates","parameters":[{"in":"query","name":"push_provider_name","schema":{"description":"Push provider name to filter templates","title":"string","type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"push_provider_type","required":true,"schema":{"description":"Push provider type (firebase, apn) to filter templates","enum":["firebase","apn"],"title":"string","type":"string","writeOnly":true,"x-stream-index":"003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPushTemplatesResponse"}}},"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":"Get push notification templates","tags":["product:chat"]},"post":{"description":"Create or update a push notification template for a specific event type and push provider\n","operationId":"UpsertPushTemplate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertPushTemplateRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertPushTemplateResponse"}}},"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":"Upsert a push notification template","tags":["product:chat"]}},"/api/v2/chat/query_banned_users":{"get":{"description":"Find and filter channel scoped or global user bans\n","operationId":"QueryBannedUsers","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryBannedUsersPayload","description":"JSON object with query user bans payload","title":"Payload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryBannedUsersResponse"}}},"description":"Successful 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":"Query Banned Users","tags":["product:chat"]}},"/api/v2/chat/reminders/query":{"post":{"description":"Queries reminders\n","operationId":"QueryReminders","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryRemindersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryRemindersResponse"}}},"description":"Successful 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":"Query reminders","tags":["product:chat"]}},"/api/v2/chat/search":{"get":{"description":"Search messages across channels\n","operationId":"Search","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchPayload","description":"JSON object with search payload","title":"Payload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchResponse"}}},"description":"Successful 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":"Search messages","tags":["product:chat"]}},"/api/v2/chat/segments/query":{"post":{"description":"Query segments\n","operationId":"QuerySegments","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuerySegmentsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuerySegmentsResponse"}}},"description":"Successful 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":"Query segments","tags":["product:chat"]}},"/api/v2/chat/segments/{id}":{"delete":{"description":"Delete a segment\n","operationId":"DeleteSegment","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete segment","tags":["product:chat"]},"get":{"description":"Get segment\n","operationId":"GetSegment","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetSegmentResponse"}}},"description":"Successful 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":"Get segment","tags":["product:chat"]}},"/api/v2/chat/segments/{id}/deletetargets":{"post":{"description":"Delete targets from a segment\n","operationId":"DeleteSegmentTargets","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteSegmentTargetsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete targets from a segment","tags":["product:chat"]}},"/api/v2/chat/segments/{id}/target/{target_id}":{"get":{"description":"Check whether a target exists in a segment. Returns 200 if the target exists, 404 otherwise\n","operationId":"SegmentTargetExists","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"target_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Check whether a target exists in a segment","tags":["product:chat"]}},"/api/v2/chat/segments/{id}/targets/query":{"post":{"description":"Query segment targets\n","operationId":"QuerySegmentTargets","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuerySegmentTargetsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuerySegmentTargetsResponse"}}},"description":"Successful 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":"Query segment targets","tags":["product:chat"]}},"/api/v2/chat/threads":{"post":{"description":"Returns the list of threads for specific user\n","operationId":"QueryThreads","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryThreadsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryThreadsResponse"}}},"description":"Successful 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":"Query Threads","tags":["product:chat"]}},"/api/v2/chat/threads/{message_id}":{"get":{"description":"Return a specific thread\n","operationId":"GetThread","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"reply_limit","schema":{"description":"Limit the number of replies returned","format":"int32","minimum":0,"title":"Reply limit","type":"integer","writeOnly":true,"x-stream-index":"004"}},{"in":"query","name":"participant_limit","schema":{"description":"Limit the number of participants returned","format":"int32","maximum":100,"minimum":0,"title":"Participant limit","type":"integer","writeOnly":true,"x-stream-index":"005"}},{"in":"query","name":"member_limit","schema":{"description":"Limit the number of members returned per thread channel","format":"int32","maximum":100,"minimum":0,"title":"Member limit","type":"integer","writeOnly":true,"x-stream-index":"006"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetThreadResponse"}}},"description":"Successful 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":"Get Thread","tags":["product:chat"]},"patch":{"description":"Updates certain fields of the thread\n\nSends events:\n- thread.updated\n- thread.updated\n","operationId":"UpdateThreadPartial","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateThreadPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateThreadPartialResponse"}}},"description":"Successful 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":"Partially update thread","tags":["product:chat"]}},"/api/v2/chat/unread":{"get":{"description":"Fetch unread counts for a single user\n","operationId":"UnreadCounts","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WrappedUnreadCountsResponse"}}},"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":"Unread counts","tags":["product:chat"]}},"/api/v2/chat/unread_batch":{"post":{"description":"Fetch unread counts in batch for multiple users in one call\n","operationId":"UnreadCountsBatch","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnreadCountsBatchRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnreadCountsBatchResponse"}}},"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":"Batch unread counts","tags":["product:chat"]}},"/api/v2/chat/users/{user_id}/event":{"post":{"description":"Sends a custom event to a user\n\nSends events:\n- *\n","operationId":"SendUserCustomEvent","parameters":[{"in":"path","name":"user_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendUserCustomEventRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Send user event","tags":["product:chat"]}},"/api/v2/check_push":{"post":{"description":"Sends a test message via push, this is a test endpoint to verify your push settings\n","operationId":"CheckPush","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckPushRequest"}}},"description":"CheckPushRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckPushResponse"}}},"description":"Successful 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":"Check push","tags":["product:common"]}},"/api/v2/check_sns":{"post":{"description":"Validates Amazon SNS configuration\n","operationId":"CheckSNS","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSNSRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSNSResponse"}}},"description":"Successful 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":"Check SNS","tags":["product:common"]}},"/api/v2/check_sqs":{"post":{"description":"Validates Amazon SQS credentials\n","operationId":"CheckSQS","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSQSRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSQSResponse"}}},"description":"Successful 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":"Check SQS","tags":["product:common"]}},"/api/v2/devices":{"delete":{"description":"Deletes one device\n","operationId":"DeleteDevice","parameters":[{"in":"query","name":"id","required":true,"schema":{"description":"Device ID to delete","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"user_id","schema":{"description":"**Server-side only**. User ID which server acts upon","title":"User ID","type":"string","writeOnly":true,"x-stream-index":"002.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete device","tags":["product:common"]},"get":{"description":"Returns all available devices\n","operationId":"ListDevices","parameters":[{"in":"query","name":"user_id","schema":{"description":"**Server-side only**. User ID which server acts upon","title":"User ID","type":"string","writeOnly":true,"x-stream-index":"001.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDevicesResponse"}}},"description":"ListDevicesResponse"},"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":"List devices","tags":["product:common"]},"post":{"description":"Adds a new device to a user, if the same device already exists the call will have no effect\n","operationId":"CreateDevice","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDeviceRequest"}}},"description":"CreateDeviceRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Create device","tags":["product:common"]}},"/api/v2/export/users":{"post":{"description":"Exports user profile, reactions and messages for list of given users\n","operationId":"ExportUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportUsersResponse"}}},"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":"Export users","tags":["product:common"]}},"/api/v2/external_storage":{"get":{"description":"Lists external storage\n","operationId":"ListExternalStorage","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListExternalStorageResponse"}}},"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":"List external storage","tags":["product:common"]},"post":{"description":"Creates new external storage\n","operationId":"CreateExternalStorage","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateExternalStorageRequest"}}},"description":"CreateExternalStorageRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateExternalStorageResponse"}}},"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":"Create external storage","tags":["product:common"]}},"/api/v2/external_storage/{name}":{"delete":{"description":"Deletes external storage\n","operationId":"DeleteExternalStorage","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteExternalStorageResponse"}}},"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":"Delete external storage","tags":["product:common"]},"put":{"description":"\n","operationId":"UpdateExternalStorage","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateExternalStorageRequest"}}},"description":"ExternalStorageRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateExternalStorageResponse"}}},"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":"Update External Storage","tags":["product:common"]}},"/api/v2/external_storage/{name}/check":{"get":{"description":"\n","operationId":"CheckExternalStorage","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckExternalStorageResponse"}}},"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":"Check External Storage","tags":["product:common"]}},"/api/v2/guest":{"post":{"description":"\n","operationId":"CreateGuest","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGuestRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGuestResponse"}}},"description":"Successful 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":"Create Guest","tags":["product:common"]}},"/api/v2/import_urls":{"post":{"description":"Creates a new import URL\n","operationId":"CreateImportURL","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateImportURLRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateImportURLResponse"}}},"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":"Create import URL","tags":["product:common"]}},"/api/v2/imports":{"get":{"description":"Gets an import\n","operationId":"ListImports","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListImportsResponse"}}},"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":"Get import","tags":["product:common"]},"post":{"description":"Creates a new import\n","operationId":"CreateImport","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateImportRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateImportResponse"}}},"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":"Create import","tags":["product:common"]}},"/api/v2/imports/{id}":{"get":{"description":"Gets an import\n","operationId":"GetImport","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetImportResponse"}}},"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":"Get import","tags":["product:common"]}},"/api/v2/moderation/ban":{"post":{"description":"Ban a user from a channel or the entire app\n","operationId":"ban","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BanRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BanResponse"}}},"description":"Successful 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":"Ban","tags":["product:moderation"]}},"/api/v2/moderation/bulk_image_moderation":{"post":{"description":"Moderate multiple images in bulk using a CSV file\n","operationId":"bulk_image_moderation","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkImageModerationRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkImageModerationResponse"}}},"description":"Successful 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":"Bulk image moderation","tags":["product:moderation"]}},"/api/v2/moderation/check":{"post":{"description":"Run moderation checks on the provided content\n","operationId":"check","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckResponse"}}},"description":"Successful 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":"Check","tags":["product:moderation"]}},"/api/v2/moderation/config":{"post":{"description":"Create a new moderation configuration or update an existing one. Configure settings for content filtering, AI analysis, toxicity detection, and other moderation features.\n","operationId":"upsert_config","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertConfigRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertConfigResponse"}}},"description":"Successful 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":"Create or update moderation configuration","tags":["product:moderation"]}},"/api/v2/moderation/config/{key}":{"delete":{"description":"Delete a specific moderation policy by its name\n","operationId":"delete_config","parameters":[{"in":"path","name":"key","required":true,"schema":{"description":"Key of the moderation configuration to delete","title":"Key","type":"string","x-stream-index":"001"}},{"in":"query","name":"team","schema":{"description":"Team associated with the configuration","title":"Team","type":"string","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteModerationConfigResponse"}}},"description":"Successful 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":"Delete a moderation policy","tags":["product:moderation"]},"get":{"description":"Retrieve a specific moderation configuration by its key and team. This configuration contains settings for various moderation features like toxicity detection, AI analysis, and filtering rules.\n","operationId":"get_config","parameters":[{"in":"path","name":"key","required":true,"schema":{"description":"Key of the moderation configuration to retrieve","title":"Key","type":"string","x-stream-index":"001"}},{"in":"query","name":"team","schema":{"description":"Team associated with the configuration","title":"Team","type":"string","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetConfigResponse"}}},"description":"Successful 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":"Get moderation configuration","tags":["product:moderation"]}},"/api/v2/moderation/configs":{"post":{"description":"Search and filter moderation configurations across your application. This endpoint is designed for building moderation dashboards and managing multiple configuration sets.\n","operationId":"query_moderation_configs","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationConfigsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationConfigsResponse"}}},"description":"Successful 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":"Query moderation configurations","tags":["product:moderation"]}},"/api/v2/moderation/custom_check":{"post":{"description":"Custom check, add your own AI model reports to the review queue\n","operationId":"custom_check","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomCheckRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomCheckResponse"}}},"description":"Successful 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":"Custom check endpoint","tags":["product:moderation"]}},"/api/v2/moderation/feeds_moderation_template":{"delete":{"description":"Delete a specific moderation template by its name\n","operationId":"V2DeleteTemplate","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteModerationTemplateResponse"}}},"description":"Successful 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":"Delete a moderation template","tags":["product:moderation"]},"get":{"description":"Retrieve a list of feed moderation templates that define preset moderation rules and configurations. Limited to 100 templates per request.\n","operationId":"V2QueryTemplates","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryFeedModerationTemplatesResponse"}}},"description":"Successful 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":"Query feed moderation templates","tags":["product:moderation"]},"post":{"description":"Upsert feeds template for moderation\n","operationId":"V2UpsertTemplate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertModerationTemplateRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertModerationTemplateResponse"}}},"description":"Successful 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":"Upsert feeds template","tags":["product:moderation"]}},"/api/v2/moderation/flag":{"post":{"description":"Flag any type of content (messages, users, channels, activities) for moderation review. Supports custom content types and additional metadata for flagged content.\n","operationId":"flag","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlagRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlagResponse"}}},"description":"Successful 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":"Flag content for moderation","tags":["product:moderation"]}},"/api/v2/moderation/flags":{"post":{"description":"Query flags associated with moderation items. This is used for building a moderation dashboard.\n","operationId":"query_moderation_flags","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationFlagsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationFlagsResponse"}}},"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":"Query moderation flags","tags":["product:moderation"]}},"/api/v2/moderation/logs":{"post":{"description":"Search and filter moderation action logs with support for pagination. View the history of moderation actions taken, including who performed them and when.\n","operationId":"query_moderation_logs","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationLogsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationLogsResponse"}}},"description":"Successful 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":"Query moderation action logs","tags":["product:moderation"]}},"/api/v2/moderation/mute":{"post":{"description":"Mute a user. Mutes are generally not visible to the user you mute, while block is something you notice.\n","operationId":"mute","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteRequest"}}},"description":"MuteRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteResponse"}}},"description":"MuteResponse"},"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":"Mute","tags":["product:moderation"]}},"/api/v2/moderation/review_queue":{"post":{"description":"Query review queue items allows you to filter the review queue items. This is used for building a moderation dashboard.\n","operationId":"query_review_queue","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryReviewQueueRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryReviewQueueResponse"}}},"description":"Successful 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":"Query review queue items","tags":["product:moderation"]}},"/api/v2/moderation/review_queue/{id}":{"get":{"description":"Retrieve a specific review queue item by its ID\n","operationId":"get_review_queue_item","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Unique identifier of the review queue item to retrieve","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetReviewQueueItemResponse"}}},"description":"Successful 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":"Get review queue item","tags":["product:moderation"]}},"/api/v2/moderation/submit_action":{"post":{"description":"Take action on flagged content, such as marking content as safe, deleting content, banning users, or executing custom moderation actions. Supports various action types with configurable parameters.\n","operationId":"submit_action","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitActionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitActionResponse"}}},"description":"Successful 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":"Submit moderation action","tags":["product:moderation"]}},"/api/v2/moderation/unban":{"post":{"description":"Unban a user from a channel or globally.\n","operationId":"unban","parameters":[{"in":"query","name":"target_user_id","required":true,"schema":{"description":"ID of the user to unban","title":"Target User ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"channel_cid","schema":{"description":"Channel where the unban applies","title":"Channel CID","type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"created_by","schema":{"description":"ID of the user who created the ban","title":"Created By","type":"string","writeOnly":true,"x-stream-index":"003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnbanRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnbanResponse"}}},"description":"Successful 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":"Unban","tags":["product:moderation"]}},"/api/v2/moderation/unmute":{"post":{"description":"Unmute a user\n","operationId":"unmute","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnmuteRequest"}}},"description":"UnmuteRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnmuteResponse"}}},"description":"UnmuteResponse"},"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":"Unmute a user","tags":["product:moderation"]}},"/api/v2/og":{"get":{"description":"Get an OpenGraph attachment for a link\n","operationId":"GetOG","parameters":[{"in":"query","name":"url","required":true,"schema":{"description":"URL to be scraped","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOGResponse"}}},"description":"Get OG Attachment"},"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":"Get OG","tags":["product:common"]}},"/api/v2/permissions":{"get":{"description":"Lists all available permissions\n","operationId":"ListPermissions","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPermissionsResponse"}}},"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":"List permissions","tags":["product:common"]}},"/api/v2/permissions/{id}":{"get":{"description":"Gets custom permission\n","operationId":"GetPermission","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Permission ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCustomPermissionResponse"}}},"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":"Get permission","tags":["product:common"]}},"/api/v2/polls":{"post":{"description":"Creates a new poll\n","operationId":"CreatePoll","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePollRequest"}}},"description":"Create Poll Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Create poll","tags":["product:common"]},"put":{"description":"Updates a poll\n\nSends events:\n- feeds.poll.closed\n- feeds.poll.updated\n- poll.closed\n- poll.updated\n","operationId":"UpdatePoll","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePollRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Update poll","tags":["product:common"]}},"/api/v2/polls/query":{"post":{"description":"Queries polls\n","operationId":"QueryPolls","parameters":[{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryPollsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryPollsResponse"}}},"description":"Successful 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":"Query polls","tags":["product:common"]}},"/api/v2/polls/{poll_id}":{"delete":{"description":"Deletes a poll\n\nSends events:\n- feeds.poll.deleted\n- poll.deleted\n","operationId":"DeletePoll","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete poll","tags":["product:common"]},"get":{"description":"Retrieves a poll\n","operationId":"GetPoll","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Get poll","tags":["product:common"]},"patch":{"description":"Updates a poll partially\n\nSends events:\n- feeds.poll.closed\n- feeds.poll.updated\n- poll.closed\n- poll.updated\n","operationId":"UpdatePollPartial","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePollPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Partial update poll","tags":["product:common"]}},"/api/v2/polls/{poll_id}/options":{"post":{"description":"Creates a poll option\n\nSends events:\n- feeds.poll.updated\n- poll.updated\n","operationId":"CreatePollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePollOptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollOptionResponse"}}},"description":"Successful 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":"Create poll option","tags":["product:common"]},"put":{"description":"Updates a poll option\n\nSends events:\n- feeds.poll.updated\n- poll.updated\n","operationId":"UpdatePollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePollOptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollOptionResponse"}}},"description":"Successful 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":"Update poll option","tags":["product:common"]}},"/api/v2/polls/{poll_id}/options/{option_id}":{"delete":{"description":"Deletes a poll option\n\nSends events:\n- feeds.poll.updated\n- poll.updated\n","operationId":"DeletePollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"path","name":"option_id","required":true,"schema":{"description":"Option ID","maxLength":255,"title":"string","type":"string","x-stream-index":"003"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete poll option","tags":["product:common"]},"get":{"description":"Retrieves a poll option\n","operationId":"GetPollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"path","name":"option_id","required":true,"schema":{"description":"Option ID","maxLength":255,"title":"string","type":"string","x-stream-index":"003"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollOptionResponse"}}},"description":"Successful 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":"Get poll option","tags":["product:common"]}},"/api/v2/polls/{poll_id}/votes":{"post":{"description":"Queries votes\n","operationId":"QueryPollVotes","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryPollVotesRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollVotesResponse"}}},"description":"Successful 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":"Query votes","tags":["product:common"]}},"/api/v2/push_providers":{"get":{"description":"List details of all push providers.\n","operationId":"ListPushProviders","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPushProvidersResponse"}}},"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":"List push providers","tags":["product:common"]},"post":{"description":"Upsert a push provider for v2 with multi bundle/package support\n","operationId":"UpsertPushProvider","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertPushProviderRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertPushProviderResponse"}}},"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":"Upsert a push provider","tags":["product:common"]}},"/api/v2/push_providers/{type}/{name}":{"delete":{"description":"Delete a push provider from v2 with multi bundle/package support. v1 isn't supported in this endpoint\n","operationId":"DeletePushProvider","parameters":[{"in":"path","name":"type","required":true,"schema":{"enum":["apn","firebase","huawei","xiaomi"],"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"name","required":true,"schema":{"maxLength":36,"minLength":1,"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete a push provider","tags":["product:common"]}},"/api/v2/rate_limits":{"get":{"description":"Get rate limits usage and quotas\n","operationId":"GetRateLimits","parameters":[{"in":"query","name":"server_side","schema":{"description":"Whether to include server-side platform limits or not","title":"Server-side","type":"boolean","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"android","schema":{"description":"Whether to include Android platform limits or not","title":"Android","type":"boolean","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"ios","schema":{"description":"Whether to include iOS platform limits or not","title":"iOS","type":"boolean","writeOnly":true,"x-stream-index":"003"}},{"in":"query","name":"web","schema":{"description":"Whether to include web platform limits or not","title":"Web","type":"boolean","writeOnly":true,"x-stream-index":"004"}},{"in":"query","name":"endpoints","schema":{"description":"Specific endpoints to show limits for, as a comma-separated list of values","title":"Endpoints","type":"string","writeOnly":true,"x-stream-index":"005"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRateLimitsResponse"}}},"description":"Get Rate Limits 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":"Get rate limits","tags":["product:common"]}},"/api/v2/roles":{"get":{"description":"Lists all available roles\n","operationId":"ListRoles","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListRolesResponse"}}},"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":"List roles","tags":["product:common"]},"post":{"description":"Creates custom role\n","operationId":"CreateRole","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRoleRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRoleResponse"}}},"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":"Create role","tags":["product:common"]}},"/api/v2/roles/{name}":{"delete":{"description":"Deletes custom role\n","operationId":"DeleteRole","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Role name","title":"Name","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete role","tags":["product:common"]}},"/api/v2/tasks/{id}":{"get":{"description":"Gets status of a task\n","operationId":"GetTask","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Task ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetTaskResponse"}}},"description":"Get Task 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":"Get status of a task","tags":["product:common"]}},"/api/v2/uploads/file":{"delete":{"description":"Deletes previously uploaded file\n","operationId":"DeleteFileGlobal","parameters":[{"in":"query","name":"url","schema":{"description":"File URL to delete","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete file","tags":["product:common"],"x-stream-sdk-name":"DeleteFile"},"post":{"description":"Uploads file\n","operationId":"UploadFileGlobal","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/FileUploadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileUploadResponse"}}},"description":"Successful 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":"Upload file","tags":["product:common"],"x-stream-sdk-name":"UploadFile"}},"/api/v2/uploads/image":{"delete":{"description":"Deletes previously uploaded image\n","operationId":"DeleteImageGlobal","parameters":[{"in":"query","name":"url","schema":{"description":"File URL to delete","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete image","tags":["product:common"],"x-stream-sdk-name":"DeleteImage"},"post":{"description":"Uploads image\n","operationId":"UploadImageGlobal","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/ImageUploadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageUploadResponse"}}},"description":"Successful 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":"Upload image","tags":["product:common"],"x-stream-sdk-name":"UploadImage"}},"/api/v2/users":{"get":{"description":"Find and filter users\n","operationId":"QueryUsers","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryUsersPayload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryUsersResponse"}}},"description":"Successful 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":"Query users","tags":["product:common"]},"patch":{"description":"Updates certain fields of the user\n\nSends events:\n- user.presence.changed\n- user.updated\n- user.presence.changed\n","operationId":"UpdateUsersPartial","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersResponse"}}},"description":"Successful 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":"Partially update user","tags":["product:common"]},"post":{"description":"Update or create users in bulk\n\nSends events:\n- user.updated\n","operationId":"UpdateUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersResponse"}}},"description":"Successful 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":"Upsert users","tags":["product:common"]}},"/api/v2/users/block":{"get":{"description":"Get list of blocked Users\n","operationId":"GetBlockedUsers","parameters":[{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBlockedUsersResponse"}}},"description":"Successful 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":"Get list of blocked Users","tags":["product:common"]},"post":{"description":"Block users\n","operationId":"BlockUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUsersResponse"}}},"description":"Successful 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":"Block user","tags":["product:common"]}},"/api/v2/users/deactivate":{"post":{"description":"Deactivate users in batches\n\nSends events:\n- user.deactivated\n","operationId":"DeactivateUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeactivateUsersRequest"}}},"description":"DeactivateUsersRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeactivateUsersResponse"}}},"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":"Deactivate users","tags":["product:common"]}},"/api/v2/users/delete":{"post":{"description":"Deletes users and optionally all their belongings asynchronously.\n\nSends events:\n- channel.deleted\n- user.deleted\n","operationId":"DeleteUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteUsersResponse"}}},"description":"Successful 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":"Delete Users","tags":["product:common"]}},"/api/v2/users/live_locations":{"get":{"description":"Retrieves all active live locations for a user\n","operationId":"GetUserLiveLocations","parameters":[{"in":"query","name":"user_id","schema":{"description":"User ID to get live locations for. If not provided, returns live locations for the authenticated user.","title":"string","type":"string","writeOnly":true,"x-stream-index":"001.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SharedLocationsResponse"}}},"description":"Successful 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":"Get user live locations","tags":["product:common"]},"put":{"description":"Updates an existing live location with new coordinates or expiration time\n","operationId":"UpdateLiveLocation","parameters":[{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"005.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateLiveLocationRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SharedLocationResponse"}}},"description":"Successful 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":"Update live location","tags":["product:common"]}},"/api/v2/users/reactivate":{"post":{"description":"Reactivate users in batches\n\nSends events:\n- user.reactivated\n- user.reactivated\n","operationId":"ReactivateUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReactivateUsersRequest"}}},"description":"ReactivateUsersRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReactivateUsersResponse"}}},"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":"Reactivate users","tags":["product:common"]}},"/api/v2/users/restore":{"post":{"description":"Restore soft deleted users\n","operationId":"RestoreUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestoreUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Restore users","tags":["product:common"]}},"/api/v2/users/unblock":{"post":{"description":"Unblock users\n","operationId":"UnblockUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUsersResponse"}}},"description":"Successful 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":"Unblock user","tags":["product:common"]}},"/api/v2/users/{user_id}/deactivate":{"post":{"description":"Deactivates user with possibility to activate it back\n\nSends events:\n- user.deactivated\n","operationId":"DeactivateUser","parameters":[{"in":"path","name":"user_id","required":true,"schema":{"title":"User ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeactivateUserRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeactivateUserResponse"}}},"description":"Successful 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":"Deactivate user","tags":["product:common"]}},"/api/v2/users/{user_id}/export":{"get":{"description":"Exports the user's profile, reactions and messages. Raises an error if a user has more than 10k messages or reactions\n","operationId":"ExportUser","parameters":[{"in":"path","name":"user_id","required":true,"schema":{"title":"User ID","type":"string","x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportUserResponse"}}},"description":"Successful 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":"Export user","tags":["product:common"]}},"/api/v2/users/{user_id}/reactivate":{"post":{"description":"Activates user who's been deactivated previously\n\nSends events:\n- user.reactivated\n","operationId":"ReactivateUser","parameters":[{"in":"path","name":"user_id","required":true,"schema":{"title":"User ID","type":"string","x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReactivateUserRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReactivateUserResponse"}}},"description":"Successful 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":"Reactivate user","tags":["product:common"]}}},"security":[{"JWT":[],"api_key":[],"stream-auth-type":[]},{"api_key":[],"stream-auth-type":[]}],"servers":[{"description":"Stream API","url":"https://chat.stream-io-api.com"}]} \ No newline at end of file +{"components":{"schemas":{"AIImageConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"ocr_rules":{"items":{"$ref":"#/components/schemas/OCRRule"},"type":"array","x-stream-index":"004"},"rules":{"items":{"$ref":"#/components/schemas/AWSRekognitionRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules","ocr_rules"],"type":"object"},"AITextConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"profile":{"type":"string","x-stream-index":"003"},"rules":{"items":{"$ref":"#/components/schemas/BodyguardRule"},"type":"array","x-stream-index":"004"},"severity_rules":{"items":{"$ref":"#/components/schemas/BodyguardSeverityRule"},"type":"array","x-stream-index":"005"}},"required":["enabled","profile","rules","severity_rules"],"type":"object"},"AIVideoConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AWSRekognitionRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"APIError":{"nullable":true,"properties":{"StatusCode":{"description":"Response HTTP status code","format":"int32","title":"Status code","type":"integer","x-stream-index":"004"},"code":{"description":"API error code","format":"int32","title":"Code","type":"integer","x-stream-index":"001"},"details":{"description":"Additional error-specific information","items":{"type":"integer"},"title":"Details","type":"array","x-stream-index":"007"},"duration":{"description":"Request duration","title":"Duration","type":"string","x-stream-index":"005"},"exception_fields":{"additionalProperties":{"type":"string"},"description":"Additional error info","title":"Exception fields","type":"object","x-stream-index":"003"},"message":{"description":"Message describing an error","title":"Message","type":"string","x-stream-index":"002"},"more_info":{"description":"URL with additional information","title":"More info","type":"string","x-stream-index":"006"},"unrecoverable":{"description":"Flag that indicates if the error is unrecoverable, requests that return unrecoverable errors should not be retried, this error only applies to the request that caused it","title":"Unrecoverable","type":"boolean","x-stream-index":"008"}},"required":["code","message","StatusCode","duration","more_info","details"],"title":"Error response","type":"object"},"APNConfig":{"properties":{"Disabled":{"type":"boolean","writeOnly":true,"x-stream-index":"005"},"auth_key":{"type":"string","x-stream-index":"006.001"},"auth_type":{"enum":["certificate","token"],"type":"string","x-stream-index":"001"},"bundle_id":{"type":"string","x-stream-index":"004"},"development":{"type":"boolean","x-stream-index":"002"},"host":{"type":"string","x-stream-index":"003"},"key_id":{"type":"string","x-stream-index":"006.002"},"notification_template":{"type":"string","x-stream-index":"008"},"p12_cert":{"type":"string","x-stream-index":"007.001"},"team_id":{"type":"string","x-stream-index":"006.003"}},"type":"object"},"APNConfigFields":{"properties":{"auth_key":{"type":"string","x-stream-index":"009"},"auth_type":{"type":"string","x-stream-index":"003"},"bundle_id":{"type":"string","x-stream-index":"006"},"development":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"host":{"type":"string","x-stream-index":"005"},"key_id":{"type":"string","x-stream-index":"008"},"notification_template":{"type":"string","x-stream-index":"004"},"p12_cert":{"type":"string","x-stream-index":"010"},"team_id":{"type":"string","x-stream-index":"007"}},"required":["enabled","development"],"type":"object"},"APNS":{"properties":{"body":{"type":"string","x-stream-index":"002"},"content-available":{"format":"int32","type":"integer","x-stream-index":"004"},"data":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"mutable-content":{"format":"int32","type":"integer","x-stream-index":"005"},"sound":{"type":"string","x-stream-index":"003"},"title":{"type":"string","x-stream-index":"001"}},"required":["title","body"],"type":"object"},"AWSRekognitionRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"},"min_confidence":{"format":"float","maximum":100,"minimum":0,"type":"number","x-stream-index":"003"}},"required":["label","action","min_confidence"],"type":"object"},"Action":{"nullable":true,"properties":{"name":{"type":"string","x-stream-index":"001"},"style":{"type":"string","x-stream-index":"003"},"text":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"004"},"value":{"type":"string","x-stream-index":"005"}},"required":["name","text","type"],"type":"object"},"ActionLog":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"002"},"reason":{"type":"string","x-stream-index":"008"},"reporter_type":{"type":"string","x-stream-index":"009"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"014"},"review_queue_item_id":{"type":"string","x-stream-index":"012"},"target_user":{"$ref":"#/components/schemas/User","x-stream-index":"013"},"target_user_id":{"type":"string","x-stream-index":"011"},"type":{"type":"string","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007"}},"required":["id","created_at","type","reason","reporter_type","custom","target_user_id","review_queue_item_id"],"type":"object"},"ActionLogResponse":{"nullable":true,"properties":{"created_at":{"description":"Timestamp when the action was taken","format":"date-time","title":"Created At","type":"number","x-stream-index":"002"},"custom":{"additionalProperties":{},"description":"Additional metadata about the action","title":"Custom","type":"object","x-stream-index":"007"},"id":{"description":"Unique identifier of the action log","title":"ID","type":"string","x-stream-index":"001"},"reason":{"description":"Reason for the moderation action","title":"Reason","type":"string","x-stream-index":"006"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"Associated review queue item","title":"Review Queue Item","x-stream-index":"008"},"target_user":{"$ref":"#/components/schemas/UserResponse","description":"User who was the target of the action","title":"Target User","x-stream-index":"009"},"target_user_id":{"description":"ID of the user who was the target of the action","title":"Target User ID","type":"string","x-stream-index":"010"},"type":{"description":"Type of moderation action","title":"Type","type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who performed the action","title":"User","x-stream-index":"004"},"user_id":{"description":"ID of the user who performed the action","title":"User ID","type":"string","x-stream-index":"005"}},"required":["id","created_at","type","user_id","reason","custom","target_user_id"],"type":"object"},"ActionSequence":{"properties":{"action":{"type":"string","x-stream-index":"001"},"blur":{"type":"boolean","x-stream-index":"005"},"cooldown_period":{"format":"int32","type":"integer","x-stream-index":"004"},"threshold":{"format":"int32","type":"integer","x-stream-index":"002"},"time_window":{"format":"int32","type":"integer","x-stream-index":"003"},"warning":{"type":"boolean","x-stream-index":"006"},"warning_text":{"type":"string","x-stream-index":"007"}},"required":["action","threshold","time_window","cooldown_period","blur","warning","warning_text"],"type":"object"},"ActivityMarkedEvent":{"properties":{"all_read":{"type":"boolean","x-stream-index":"006"},"all_seen":{"type":"boolean","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"feed_id":{"type":"string","x-stream-index":"003"},"marked_read":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"marked_watched":{"items":{"type":"string"},"type":"array","x-stream-index":"005"},"type":{"default":"activity.marked","type":"string","x-stream-index":"001.001"},"user_id":{"type":"string","x-stream-index":"002"}},"required":["type","created_at","user_id","feed_id","all_read","all_seen"],"title":"ActivityMarkedEvent","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"},"AnyEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"*","type":"string","x-stream-index":"001.001"}},"required":["type","created_at"],"title":"AnyEvent","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"},"AppResponseFields":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"019"},"async_url_enrich_enabled":{"type":"boolean","x-stream-index":"017"},"auto_translation_enabled":{"type":"boolean","x-stream-index":"020"},"before_message_send_hook_url":{"type":"string","x-stream-index":"021"},"call_types":{"additionalProperties":{"$ref":"#/components/schemas/CallType"},"type":"object","x-stream-index":"007"},"campaign_enabled":{"type":"boolean","x-stream-index":"034"},"cdn_expiration_seconds":{"format":"int32","type":"integer","x-stream-index":"037"},"channel_configs":{"additionalProperties":{"$ref":"#/components/schemas/ChannelConfig"},"type":"object","x-stream-index":"006"},"custom_action_handler_url":{"type":"string","x-stream-index":"022"},"datadog_info":{"$ref":"#/components/schemas/DataDogInfo","x-stream-index":"040"},"disable_auth_checks":{"type":"boolean","x-stream-index":"011"},"disable_permissions_checks":{"type":"boolean","x-stream-index":"012"},"enforce_unique_usernames":{"type":"string","x-stream-index":"023"},"event_hooks":{"items":{"$ref":"#/components/schemas/EventHook"},"type":"array","x-stream-index":"045"},"file_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","x-stream-index":"030"},"geofences":{"items":{"$ref":"#/components/schemas/GeofenceResponse"},"type":"array","x-stream-index":"039"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"033"},"guest_user_creation_disabled":{"type":"boolean","x-stream-index":"043"},"image_moderation_enabled":{"type":"boolean","x-stream-index":"016"},"image_moderation_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"018"},"image_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","x-stream-index":"031"},"moderation_bulk_submit_action_enabled":{"type":"boolean","x-stream-index":"048"},"moderation_dashboard_preferences":{"$ref":"#/components/schemas/ModerationDashboardPreferences","x-stream-index":"044"},"moderation_enabled":{"type":"boolean","x-stream-index":"041"},"moderation_llm_configurability_enabled":{"type":"boolean","x-stream-index":"049"},"moderation_multitenant_blocklist_enabled":{"type":"boolean","x-stream-index":"042"},"moderation_webhook_url":{"type":"string","x-stream-index":"005"},"multi_tenant_enabled":{"type":"boolean","x-stream-index":"015"},"name":{"type":"string","x-stream-index":"001"},"organization":{"type":"string","x-stream-index":"002"},"permission_version":{"type":"string","x-stream-index":"013"},"policies":{"additionalProperties":{"items":{"$ref":"#/components/schemas/Policy"},"type":"array"},"type":"object","x-stream-index":"008"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationFields","x-stream-index":"003"},"reminders_interval":{"format":"int32","type":"integer","x-stream-index":"036"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"032"},"sns_key":{"type":"string","x-stream-index":"028"},"sns_secret":{"type":"string","x-stream-index":"029"},"sns_topic_arn":{"type":"string","x-stream-index":"027"},"sqs_key":{"type":"string","x-stream-index":"025"},"sqs_secret":{"type":"string","x-stream-index":"026"},"sqs_url":{"type":"string","x-stream-index":"024"},"suspended":{"type":"boolean","x-stream-index":"009"},"suspended_explanation":{"type":"string","x-stream-index":"010"},"use_hook_v2":{"type":"boolean","x-stream-index":"046"},"user_response_time_enabled":{"type":"boolean","x-stream-index":"047"},"user_search_disallowed_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"014"},"webhook_events":{"items":{"type":"string"},"type":"array","x-stream-index":"035"},"webhook_url":{"type":"string","x-stream-index":"004"}},"required":["name","organization","push_notifications","webhook_url","moderation_webhook_url","channel_configs","call_types","policies","suspended","suspended_explanation","disable_auth_checks","disable_permissions_checks","permission_version","user_search_disallowed_roles","multi_tenant_enabled","image_moderation_enabled","async_url_enrich_enabled","auto_translation_enabled","custom_action_handler_url","enforce_unique_usernames","sqs_url","sqs_key","sqs_secret","sns_topic_arn","sns_key","sns_secret","file_upload_config","image_upload_config","grants","campaign_enabled","webhook_events","reminders_interval","cdn_expiration_seconds","video_provider","moderation_enabled","moderation_multitenant_blocklist_enabled","guest_user_creation_disabled","event_hooks","use_hook_v2","user_response_time_enabled","moderation_bulk_submit_action_enabled","moderation_llm_configurability_enabled"],"type":"object"},"AsyncBulkImageModerationEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"003.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.007"},"finished_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.004"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"task_id":{"type":"string","x-stream-index":"002.001"},"type":{"default":"export.bulk_image_moderation.success","type":"string","x-stream-index":"003.002"},"url":{"type":"string","x-stream-index":"001"}},"required":["url","task_id","started_at","finished_at","type","created_at","custom"],"title":"AsyncBulkImageModerationEvent","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"},"AsyncExportChannelsEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"003.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.007"},"finished_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.004"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"task_id":{"type":"string","x-stream-index":"002.001"},"type":{"default":"export.channels.success","type":"string","x-stream-index":"003.002"},"url":{"type":"string","x-stream-index":"001"}},"required":["url","task_id","started_at","finished_at","type","created_at","custom"],"title":"AsyncExportChannelsEvent","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"},"AsyncExportErrorEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"003.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.007"},"error":{"type":"string","x-stream-index":"001"},"finished_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.004"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"task_id":{"type":"string","x-stream-index":"002.001"},"type":{"default":"export.users.error","type":"string","x-stream-index":"003.002"}},"required":["error","task_id","started_at","finished_at","type","created_at","custom"],"title":"AsyncExportErrorEvent","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"},"AsyncExportModerationLogsEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"003.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.007"},"finished_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.004"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"task_id":{"type":"string","x-stream-index":"002.001"},"type":{"default":"export.moderation_logs.success","type":"string","x-stream-index":"003.002"},"url":{"type":"string","x-stream-index":"001"}},"required":["url","task_id","started_at","finished_at","type","created_at","custom"],"title":"AsyncExportModerationLogsEvent","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"},"AsyncExportUsersEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"003.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.007"},"finished_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.004"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"task_id":{"type":"string","x-stream-index":"002.001"},"type":{"default":"export.users.success","type":"string","x-stream-index":"003.002"},"url":{"type":"string","x-stream-index":"001"}},"required":["url","task_id","started_at","finished_at","type","created_at","custom"],"title":"AsyncExportUsersEvent","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"},"AsyncModerationCallbackConfig":{"properties":{"mode":{"enum":["CALLBACK_MODE_NONE","CALLBACK_MODE_REST","CALLBACK_MODE_TWIRP"],"type":"string","x-stream-index":"002"},"server_url":{"type":"string","x-stream-index":"001"}},"type":"object"},"AsyncModerationConfiguration":{"properties":{"callback":{"$ref":"#/components/schemas/AsyncModerationCallbackConfig","x-stream-index":"002"},"timeout_ms":{"format":"int32","type":"integer","x-stream-index":"001"}},"type":"object"},"Attachment":{"description":"An attachment is a message object that represents a file uploaded by a user.","nullable":true,"properties":{"actions":{"items":{"$ref":"#/components/schemas/Action"},"type":"array","x-stream-index":"015"},"asset_url":{"type":"string","x-stream-index":"017"},"author_icon":{"type":"string","x-stream-index":"007"},"author_link":{"type":"string","x-stream-index":"006"},"author_name":{"type":"string","x-stream-index":"005"},"color":{"type":"string","x-stream-index":"003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"018"},"fallback":{"type":"string","x-stream-index":"002"},"fields":{"items":{"$ref":"#/components/schemas/Field"},"type":"array","x-stream-index":"016"},"footer":{"type":"string","x-stream-index":"013"},"footer_icon":{"type":"string","x-stream-index":"014"},"giphy":{"$ref":"#/components/schemas/Images","x-stream-index":"019"},"image_url":{"type":"string","x-stream-index":"011"},"og_scrape_url":{"type":"string","x-stream-index":"020"},"original_height":{"format":"int32","type":"integer","x-stream-index":"022"},"original_width":{"format":"int32","type":"integer","x-stream-index":"021"},"pretext":{"type":"string","x-stream-index":"004"},"text":{"type":"string","x-stream-index":"010"},"thumb_url":{"type":"string","x-stream-index":"012"},"title":{"type":"string","x-stream-index":"008"},"title_link":{"type":"string","x-stream-index":"009"},"type":{"description":"Attachment type (e.g. image, video, url)","title":"Type","type":"string","x-stream-index":"001"}},"required":["custom"],"title":"Attachment","type":"object","x-stream-docs-page-id":"file_uploads"},"AudioSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"001"},"default_device":{"enum":["speaker","earpiece"],"type":"string","x-stream-index":"006"},"mic_default_on":{"type":"boolean","x-stream-index":"004"},"noise_cancellation":{"$ref":"#/components/schemas/NoiseCancellationSettings","x-stream-index":"007"},"opus_dtx_enabled":{"type":"boolean","x-stream-index":"002"},"redundant_coding_enabled":{"type":"boolean","x-stream-index":"003"},"speaker_default_on":{"type":"boolean","x-stream-index":"005"}},"required":["access_request_enabled","opus_dtx_enabled","redundant_coding_enabled","mic_default_on","speaker_default_on","default_device"],"type":"object"},"AudioSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"001"},"default_device":{"enum":["speaker","earpiece"],"type":"string","x-stream-index":"006"},"mic_default_on":{"type":"boolean","x-stream-index":"004"},"noise_cancellation":{"$ref":"#/components/schemas/NoiseCancellationSettings","x-stream-index":"007"},"opus_dtx_enabled":{"type":"boolean","x-stream-index":"002"},"redundant_coding_enabled":{"type":"boolean","x-stream-index":"003"},"speaker_default_on":{"type":"boolean","x-stream-index":"005"}},"required":["access_request_enabled","opus_dtx_enabled","redundant_coding_enabled","mic_default_on","speaker_default_on","default_device"],"type":"object"},"AutomodDetails":{"properties":{"action":{"type":"string","x-stream-index":"001"},"image_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"005"},"message_details":{"$ref":"#/components/schemas/FlagMessageDetails","x-stream-index":"004"},"original_message_type":{"type":"string","x-stream-index":"002"},"result":{"$ref":"#/components/schemas/MessageModerationResult","x-stream-index":"003"}},"type":"object"},"AutomodPlatformCircumventionConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AutomodRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"AutomodRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"003"},"label":{"type":"string","x-stream-index":"001"},"threshold":{"format":"float","maximum":1,"minimum":0,"type":"number","x-stream-index":"002"}},"required":["label","threshold","action"],"type":"object"},"AutomodSemanticFiltersConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AutomodSemanticFiltersRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"AutomodSemanticFiltersRule":{"properties":{"action":{"enum":["flag","shadow","remove"],"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"threshold":{"format":"float","maximum":1,"minimum":0,"type":"number","x-stream-index":"002"}},"required":["name","threshold","action"],"type":"object"},"AutomodToxicityConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AutomodRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"AzureRequest":{"description":"Config for creating Azure Blob Storage storage","properties":{"abs_account_name":{"description":"The account name","title":"AccountName","type":"string","x-stream-index":"001"},"abs_client_id":{"description":"The client id","title":"ClientID","type":"string","x-stream-index":"003"},"abs_client_secret":{"description":"The client secret","title":"ClientSecret","type":"string","x-stream-index":"004"},"abs_tenant_id":{"description":"The tenant id","title":"TenantID","type":"string","x-stream-index":"002"}},"required":["abs_account_name","abs_tenant_id","abs_client_id","abs_client_secret"],"title":"AzureRequest","type":"object"},"BackstageSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"BackstageSettingsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"Ban":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"012"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"011"},"expires":{"format":"date-time","type":"number","x-stream-index":"007"},"reason":{"type":"string","x-stream-index":"008"},"shadow":{"type":"boolean","x-stream-index":"009"},"target":{"$ref":"#/components/schemas/User","x-stream-index":"006"}},"required":["shadow","created_at"],"type":"object"},"BanActionRequest":{"properties":{"channel_ban_only":{"type":"boolean","x-stream-index":"003"},"delete_messages":{"enum":["soft","pruning","hard"],"type":"string","x-stream-index":"005"},"ip_ban":{"type":"boolean","x-stream-index":"004"},"reason":{"type":"string","x-stream-index":"002"},"shadow":{"type":"boolean","x-stream-index":"001"},"timeout":{"format":"int32","type":"integer","x-stream-index":"006"}},"type":"object"},"BanOptions":{"properties":{"duration":{"format":"int32","type":"integer","x-stream-index":"001"},"ip_ban":{"type":"boolean","x-stream-index":"004"},"reason":{"type":"string","x-stream-index":"002"},"shadow_ban":{"type":"boolean","x-stream-index":"003"}},"type":"object"},"BanRequest":{"nullable":true,"properties":{"banned_by":{"$ref":"#/components/schemas/UserRequest","description":"Details about the user performing the ban","title":"Banned By","x-stream-index":"008"},"banned_by_id":{"description":"ID of the user performing the ban","title":"Banned By ID","type":"string","x-stream-index":"007"},"channel_cid":{"description":"Channel where the ban applies","title":"Channel CID","type":"string","x-stream-index":"004"},"delete_messages":{"enum":["soft","pruning","hard"],"type":"string","x-stream-index":"009"},"ip_ban":{"description":"Whether to ban the user's IP address","title":"IP Ban","type":"boolean","x-stream-index":"006"},"reason":{"description":"Optional explanation for the ban","title":"Reason","type":"string","x-stream-index":"003"},"shadow":{"description":"Whether this is a shadow ban","title":"Shadow","type":"boolean","x-stream-index":"005"},"target_user_id":{"description":"ID of the user to ban","title":"Target User ID","type":"string","x-stream-index":"001"},"timeout":{"description":"Duration of the ban in minutes","minimum":0,"title":"Timeout","type":"integer","x-stream-index":"002"}},"required":["target_user_id"],"type":"object"},"BanResponse":{"nullable":true,"properties":{"banned_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"006"},"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"expires":{"format":"date-time","type":"number","x-stream-index":"003"},"reason":{"type":"string","x-stream-index":"004"},"shadow":{"type":"boolean","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"}},"required":["created_at"],"type":"object"},"BlockContentOptions":{"properties":{"reason":{"type":"string","x-stream-index":"001"}},"type":"object"},"BlockListConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/BlockListRule"},"maximum":10,"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"BlockListOptions":{"properties":{"behavior":{"description":"Blocklist behavior","enum":["flag","block","shadow_block"],"title":"Behavior","type":"string","x-stream-index":"002"},"blocklist":{"description":"Blocklist name","title":"Blocklist","type":"string","x-stream-index":"001"}},"required":["blocklist","behavior"],"type":"object"},"BlockListResponse":{"description":"Block list contains restricted words","properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001"},"id":{"type":"string","x-stream-index":"003"},"name":{"description":"Block list name","title":"Name","type":"string","x-stream-index":"004"},"team":{"type":"string","x-stream-index":"007"},"type":{"description":"Block list type.","title":"Type","type":"string","x-stream-index":"005"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"002"},"words":{"description":"List of words to block","items":{"type":"string"},"title":"Words","type":"array","x-stream-index":"006"}},"required":["name","type","words"],"title":"Block list","type":"object","x-stream-docs-page-id":"block_lists"},"BlockListRule":{"properties":{"action":{"enum":["flag","mask_flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"002"}},"required":["name","team","action"],"type":"object"},"BlockUsersRequest":{"nullable":true,"properties":{"blocked_user_id":{"description":"User id to block","title":"BlockedUserID","type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"required":["blocked_user_id"],"type":"object"},"BlockUsersResponse":{"nullable":true,"properties":{"blocked_by_user_id":{"description":"User id who blocked another user","title":"BlockedByUserID","type":"string","x-stream-index":"002"},"blocked_user_id":{"description":"User id who got blocked","title":"BlockedUserID","type":"string","x-stream-index":"003"},"created_at":{"description":"Timestamp when the user was blocked","format":"date-time","title":"CreatedAt","type":"number","x-stream-index":"004"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration","blocked_by_user_id","blocked_user_id","created_at"],"type":"object"},"BlockedUserResponse":{"nullable":true,"properties":{"blocked_user":{"$ref":"#/components/schemas/UserResponse","description":"User who got blocked","title":"User","x-stream-index":"003"},"blocked_user_id":{"description":"ID of the user who got blocked","title":"UserID","type":"string","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who blocked another user","title":"User","x-stream-index":"001"},"user_id":{"description":"ID of the user who blocked another user","title":"UserID","type":"string","x-stream-index":"002"}},"required":["user","user_id","blocked_user","blocked_user_id","created_at"],"type":"object"},"BodyguardRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"},"severity_rules":{"items":{"$ref":"#/components/schemas/BodyguardSeverityRule"},"type":"array","x-stream-index":"003"}},"required":["label","action","severity_rules"],"type":"object"},"BodyguardSeverityRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"severity":{"enum":["low","medium","high","critical"],"type":"string","x-stream-index":"001"}},"required":["severity","action"],"type":"object"},"BroadcastSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettings","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettings","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"BroadcastSettingsResponse":{"description":"BroadcastSettingsResponse is the payload for broadcasting settings","properties":{"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettingsResponse","title":"HLS","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettingsResponse","title":"RTMP","x-stream-index":"003"}},"required":["enabled","hls","rtmp"],"title":"BroadcastSettingsResponse","type":"object"},"BulkImageModerationRequest":{"nullable":true,"properties":{"csv_file":{"description":"URL to CSV file containing image URLs to moderate","title":"string","type":"string","x-stream-index":"001"}},"required":["csv_file"],"type":"object"},"BulkImageModerationResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"task_id":{"description":"ID of the task for processing the bulk image moderation","title":"string","type":"string","x-stream-index":"001"}},"required":["task_id","duration"],"type":"object"},"Call":{"properties":{"AppPK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"002"},"Backstage":{"type":"boolean","writeOnly":true,"x-stream-index":"023"},"BlockedUserIDs":{"items":{"type":"string"},"type":"array","writeOnly":true,"x-stream-index":"018"},"BlockedUsers":{"items":{"$ref":"#/components/schemas/User"},"type":"array","writeOnly":true,"x-stream-index":"019"},"CID":{"type":"string","writeOnly":true,"x-stream-index":"005"},"CallType":{"$ref":"#/components/schemas/CallType","x-stream-index":"020"},"ChannelCID":{"type":"string","writeOnly":true,"x-stream-index":"032"},"CreatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"013"},"CreatedBy":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"CreatedByUserID":{"type":"string","writeOnly":true,"x-stream-index":"007"},"CurrentSessionID":{"type":"string","writeOnly":true,"x-stream-index":"024"},"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"012"},"DeletedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"028"},"EgressUpdatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"027"},"Egresses":{"items":{"$ref":"#/components/schemas/CallEgress"},"type":"array","writeOnly":true,"x-stream-index":"015"},"EndedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"017"},"ID":{"type":"string","writeOnly":true,"x-stream-index":"004"},"JoinAheadTimeSeconds":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"031"},"LastHeartbeatAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"030"},"LastSessionID":{"type":"string","writeOnly":true,"x-stream-index":"025"},"MemberCount":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"010"},"MemberLookup":{"$ref":"#/components/schemas/MemberLookup","x-stream-index":"011"},"Members":{"items":{"$ref":"#/components/schemas/CallMember"},"type":"array","writeOnly":true,"x-stream-index":"009"},"Session":{"$ref":"#/components/schemas/CallSession","x-stream-index":"026"},"Settings":{"$ref":"#/components/schemas/CallSettings","x-stream-index":"022"},"SettingsOverrides":{"$ref":"#/components/schemas/CallSettings","x-stream-index":"021"},"StartsAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"016"},"Team":{"type":"string","writeOnly":true,"x-stream-index":"006"},"ThumbnailURL":{"type":"string","writeOnly":true,"x-stream-index":"029"},"Type":{"type":"string","writeOnly":true,"x-stream-index":"003"},"UpdatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"014"}},"required":["AppPK","Type","ID","CID","Team","CreatedByUserID","Members","Custom","CreatedAt","UpdatedAt","Egresses","BlockedUserIDs","BlockedUsers","Backstage","CurrentSessionID","LastSessionID","ThumbnailURL","ChannelCID"],"type":"object"},"CallEgress":{"nullable":true,"properties":{"app_pk":{"format":"int32","type":"integer","x-stream-index":"002"},"call_id":{"type":"string","x-stream-index":"004"},"call_type":{"type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/EgressTaskConfig","x-stream-index":"007"},"egress_id":{"type":"string","x-stream-index":"005"},"egress_type":{"type":"string","x-stream-index":"006"},"instance_ip":{"type":"string","x-stream-index":"008"},"started_at":{"format":"date-time","type":"number","x-stream-index":"010"},"state":{"type":"string","x-stream-index":"009"},"stopped_at":{"format":"date-time","type":"number","x-stream-index":"011"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"012"}},"required":["app_pk","call_type","call_id","egress_id","egress_type","instance_ip","state","started_at","updated_at"],"type":"object"},"CallIngressResponse":{"description":"CallIngressResponse is the payload for ingress settings","properties":{"rtmp":{"$ref":"#/components/schemas/RTMPIngress","title":"RTMP","x-stream-index":"001"}},"required":["rtmp"],"title":"CallIngressResponse","type":"object"},"CallMember":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"010"},"role":{"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["user_id","role","custom","created_at","updated_at"],"type":"object"},"CallParticipant":{"nullable":true,"properties":{"JoinedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"004"},"Role":{"type":"string","writeOnly":true,"x-stream-index":"002"},"UserSessionID":{"type":"string","writeOnly":true,"x-stream-index":"003"},"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"001.046"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"001.017"},"banned":{"type":"boolean","x-stream-index":"001.016"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.013"},"id":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"001.023"},"language":{"type":"string","x-stream-index":"001.035"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"001.022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"001.026"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.042"},"role":{"type":"string","x-stream-index":"001.004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.005"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.009"}},"required":["id","role","teams_role","custom","banned","online","Role","UserSessionID","JoinedAt"],"type":"object"},"CallParticipantResponse":{"properties":{"joined_at":{"format":"date-time","type":"number","x-stream-index":"004"},"role":{"type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"},"user_session_id":{"type":"string","x-stream-index":"002"}},"required":["user","user_session_id","role","joined_at"],"type":"object"},"CallResponse":{"description":"Represents a call","properties":{"backstage":{"type":"boolean","x-stream-index":"016"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"018"},"captioning":{"type":"boolean","x-stream-index":"013"},"channel_cid":{"type":"string","x-stream-index":"024"},"cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"The user that created the call","title":"Created By","x-stream-index":"007"},"current_session_id":{"type":"string","x-stream-index":"005"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"008"},"egress":{"$ref":"#/components/schemas/EgressResponse","x-stream-index":"021"},"ended_at":{"description":"Date/time when the call ended","format":"date-time","title":"Ended At","type":"number","x-stream-index":"014"},"id":{"description":"Call ID","title":"ID","type":"string","x-stream-index":"003"},"ingress":{"$ref":"#/components/schemas/CallIngressResponse","x-stream-index":"019"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"023"},"recording":{"type":"boolean","x-stream-index":"011"},"session":{"$ref":"#/components/schemas/CallSessionResponse","x-stream-index":"020"},"settings":{"$ref":"#/components/schemas/CallSettingsResponse","x-stream-index":"017"},"starts_at":{"description":"Date/time when the call will start","format":"date-time","title":"Starts At","type":"number","x-stream-index":"015"},"team":{"type":"string","x-stream-index":"006"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailResponse","x-stream-index":"022"},"transcribing":{"type":"boolean","x-stream-index":"012"},"type":{"description":"The type of call","title":"Type","type":"string","x-stream-index":"002"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"}},"required":["type","id","cid","current_session_id","created_by","custom","created_at","updated_at","recording","transcribing","captioning","backstage","settings","blocked_user_ids","ingress","egress"],"title":"CallResponse","type":"object"},"CallSession":{"properties":{"AcceptedBy":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","writeOnly":true,"x-stream-index":"008"},"ActiveSFUs":{"items":{"$ref":"#/components/schemas/SFUIDLastSeen"},"type":"array","writeOnly":true,"x-stream-index":"016"},"AnonymousParticipantCount":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"019"},"AppPK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"002.001"},"CallID":{"type":"string","writeOnly":true,"x-stream-index":"002.003"},"CallType":{"type":"string","writeOnly":true,"x-stream-index":"002.002"},"CreatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"003"},"DeletedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"004"},"EndedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"006"},"LiveEndedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"013"},"LiveStartedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"012"},"MissedBy":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","writeOnly":true,"x-stream-index":"010"},"Participants":{"items":{"$ref":"#/components/schemas/CallParticipant"},"type":"array","writeOnly":true,"x-stream-index":"011"},"ParticipantsCountByRole":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","writeOnly":true,"x-stream-index":"018"},"RejectedBy":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","writeOnly":true,"x-stream-index":"009"},"RingAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"007"},"SFUIDs":{"items":{"type":"string"},"type":"array","writeOnly":true,"x-stream-index":"015"},"SessionID":{"type":"string","writeOnly":true,"x-stream-index":"002.004"},"StartedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"005"},"TimerEndsAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"014"},"UserPermissionOverrides":{"additionalProperties":{"additionalProperties":{"type":"boolean"},"type":"object"},"type":"object","writeOnly":true,"x-stream-index":"017"}},"required":["AppPK","CallType","CallID","SessionID","CreatedAt","AcceptedBy","RejectedBy","MissedBy","Participants","SFUIDs","ActiveSFUs","UserPermissionOverrides","ParticipantsCountByRole","AnonymousParticipantCount"],"type":"object"},"CallSessionResponse":{"properties":{"accepted_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"008"},"anonymous_participant_count":{"format":"int32","type":"integer","x-stream-index":"006"},"ended_at":{"format":"date-time","type":"number","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"live_ended_at":{"format":"date-time","type":"number","x-stream-index":"011"},"live_started_at":{"format":"date-time","type":"number","x-stream-index":"010"},"missed_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"009"},"participants":{"items":{"$ref":"#/components/schemas/CallParticipantResponse"},"type":"array","x-stream-index":"004"},"participants_count_by_role":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"005"},"rejected_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"007"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002"},"timer_ends_at":{"format":"date-time","type":"number","x-stream-index":"012"}},"required":["id","participants","participants_count_by_role","anonymous_participant_count","rejected_by","accepted_by","missed_by"],"type":"object"},"CallSettings":{"properties":{"audio":{"$ref":"#/components/schemas/AudioSettings","x-stream-index":"001"},"backstage":{"$ref":"#/components/schemas/BackstageSettings","x-stream-index":"002"},"broadcasting":{"$ref":"#/components/schemas/BroadcastSettings","x-stream-index":"007"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordSettings","x-stream-index":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettings","x-stream-index":"008"},"ingress":{"$ref":"#/components/schemas/IngressSettings","x-stream-index":"014"},"limits":{"$ref":"#/components/schemas/LimitsSettings","x-stream-index":"012"},"recording":{"$ref":"#/components/schemas/RecordSettings","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettings","x-stream-index":"010"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettings","x-stream-index":"004"},"session":{"$ref":"#/components/schemas/SessionSettings","x-stream-index":"013"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettings","x-stream-index":"011"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettings","x-stream-index":"009"},"video":{"$ref":"#/components/schemas/VideoSettings","x-stream-index":"003"}},"type":"object"},"CallSettingsResponse":{"properties":{"audio":{"$ref":"#/components/schemas/AudioSettingsResponse","x-stream-index":"001"},"backstage":{"$ref":"#/components/schemas/BackstageSettingsResponse","x-stream-index":"002"},"broadcasting":{"$ref":"#/components/schemas/BroadcastSettingsResponse","x-stream-index":"003"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordingSettingsResponse","x-stream-index":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettingsResponse","x-stream-index":"004"},"ingress":{"$ref":"#/components/schemas/IngressSettingsResponse","x-stream-index":"014"},"limits":{"$ref":"#/components/schemas/LimitsSettingsResponse","x-stream-index":"012"},"recording":{"$ref":"#/components/schemas/RecordSettingsResponse","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettingsResponse","x-stream-index":"007"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettingsResponse","x-stream-index":"008"},"session":{"$ref":"#/components/schemas/SessionSettingsResponse","x-stream-index":"013"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettingsResponse","x-stream-index":"011"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettingsResponse","x-stream-index":"009"},"video":{"$ref":"#/components/schemas/VideoSettingsResponse","x-stream-index":"010"}},"required":["audio","backstage","broadcasting","geofencing","recording","frame_recording","ring","screensharing","transcription","video","thumbnails","limits","session"],"type":"object"},"CallType":{"nullable":true,"properties":{"AppPK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"003"},"CreatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"005"},"ExternalStorage":{"type":"string","writeOnly":true,"x-stream-index":"009"},"Name":{"type":"string","writeOnly":true,"x-stream-index":"004"},"NotificationSettings":{"$ref":"#/components/schemas/NotificationSettings","x-stream-index":"008"},"PK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"002"},"Settings":{"$ref":"#/components/schemas/CallSettings","x-stream-index":"007"},"UpdatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"006"}},"required":["PK","AppPK","Name","CreatedAt","UpdatedAt","ExternalStorage"],"type":"object"},"CampaignChannelTemplate":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"002"},"members":{"items":{"type":"string"},"maximum":1000,"type":"array","x-stream-index":"003"},"team":{"maxLength":1000,"type":"string","x-stream-index":"004"},"type":{"maxLength":64,"type":"string","x-stream-index":"001"}},"required":["type","custom"],"type":"object"},"CampaignCompletedEvent":{"nullable":true,"properties":{"campaign":{"$ref":"#/components/schemas/CampaignResponse","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"type":{"default":"campaign.completed","type":"string","x-stream-index":"001.002"}},"required":["type","created_at","custom"],"title":"CampaignCompletedEvent","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"},"CampaignMessageTemplate":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"maximum":30,"type":"array","x-stream-index":"002"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"poll_id":{"type":"string","x-stream-index":"003"},"text":{"type":"string","x-stream-index":"001"}},"required":["text","attachments","poll_id","custom"],"type":"object"},"CampaignResponse":{"properties":{"channel_template":{"$ref":"#/components/schemas/CampaignChannelTemplate","x-stream-index":"016"},"create_channels":{"type":"boolean","x-stream-index":"008"},"created_at":{"format":"date-time","type":"number","x-stream-index":"020"},"description":{"type":"string","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"001"},"message_template":{"$ref":"#/components/schemas/CampaignMessageTemplate","x-stream-index":"015"},"name":{"type":"string","x-stream-index":"007"},"scheduled_for":{"format":"date-time","type":"number","x-stream-index":"013"},"segment_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"002"},"segments":{"items":{"$ref":"#/components/schemas/Segment"},"type":"array","x-stream-index":"003"},"sender":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"005"},"sender_id":{"type":"string","x-stream-index":"004"},"sender_mode":{"type":"string","x-stream-index":"006"},"show_channels":{"type":"boolean","x-stream-index":"009"},"skip_push":{"type":"boolean","x-stream-index":"011"},"skip_webhook":{"type":"boolean","x-stream-index":"012"},"stats":{"$ref":"#/components/schemas/CampaignStatsResponse","x-stream-index":"022"},"status":{"type":"string","x-stream-index":"019"},"stop_at":{"format":"date-time","type":"number","x-stream-index":"014"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"021"},"user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"017"},"users":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"018"}},"required":["id","segment_ids","segments","sender_id","sender_mode","name","create_channels","show_channels","description","skip_push","skip_webhook","user_ids","users","status","created_at","updated_at","stats"],"type":"object"},"CampaignStartedEvent":{"nullable":true,"properties":{"campaign":{"$ref":"#/components/schemas/CampaignResponse","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"type":{"default":"campaign.started","type":"string","x-stream-index":"001.002"}},"required":["type","created_at","custom"],"title":"CampaignStartedEvent","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"},"CampaignStatsResponse":{"properties":{"progress":{"format":"float","type":"number","x-stream-index":"005"},"stats_channels_created":{"format":"int32","type":"integer","x-stream-index":"004"},"stats_completed_at":{"format":"date-time","type":"number","x-stream-index":"002"},"stats_messages_sent":{"format":"int32","type":"integer","x-stream-index":"003"},"stats_started_at":{"format":"date-time","type":"number","x-stream-index":"001"},"stats_users_read":{"format":"int32","type":"integer","x-stream-index":"007"},"stats_users_sent":{"format":"int32","type":"integer","x-stream-index":"006"}},"required":["stats_started_at","stats_completed_at","stats_messages_sent","stats_channels_created","progress","stats_users_sent","stats_users_read"],"type":"object"},"CastPollVoteRequest":{"nullable":true,"properties":{"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"005.002"},"user_id":{"type":"string","x-stream-index":"005.001"},"vote":{"$ref":"#/components/schemas/VoteData","description":"Vote data","title":"VoteData","x-stream-index":"004"}},"type":"object"},"Channel":{"properties":{"active_live_locations":{"items":{"$ref":"#/components/schemas/SharedLocation"},"type":"array","x-stream-index":"034"},"auto_translation_enabled":{"type":"boolean","x-stream-index":"029"},"auto_translation_language":{"type":"string","x-stream-index":"030"},"cid":{"type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/ChannelConfig","x-stream-index":"026"},"config_overrides":{"$ref":"#/components/schemas/ConfigOverrides","x-stream-index":"027"},"cooldown":{"format":"int32","type":"integer","x-stream-index":"031"},"created_at":{"format":"date-time","type":"number","x-stream-index":"009"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"019"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"disabled":{"type":"boolean","x-stream-index":"017"},"frozen":{"type":"boolean","x-stream-index":"016"},"id":{"type":"string","x-stream-index":"004"},"invites":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"022"},"last_campaigns":{"type":"string","x-stream-index":"032"},"last_message_at":{"format":"date-time","type":"number","x-stream-index":"006"},"member_count":{"format":"int32","type":"integer","x-stream-index":"021"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"020"},"message_count":{"format":"int64","type":"integer","x-stream-index":"035"},"message_count_updated_at":{"format":"date-time","type":"number","x-stream-index":"036"},"team":{"type":"string","x-stream-index":"028"},"truncated_by":{"$ref":"#/components/schemas/User","x-stream-index":"015"},"type":{"type":"string","x-stream-index":"005"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"010"}},"required":["cid","id","type","created_at","updated_at","frozen","disabled","custom","auto_translation_language"],"type":"object"},"ChannelConfig":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.027"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.022"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.023"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.028"},"blocklist":{"type":"string","x-stream-index":"001.024"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.025"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.026"},"commands":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"connect_events":{"type":"boolean","x-stream-index":"001.004"},"count_messages":{"type":"boolean","x-stream-index":"001.019"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"custom_events":{"type":"boolean","x-stream-index":"001.012"},"mark_messages_pending":{"type":"boolean","x-stream-index":"001.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"001.021"},"mutes":{"type":"boolean","x-stream-index":"001.009"},"name":{"type":"string","x-stream-index":"001.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"001.029"},"partition_ttl":{"type":"integer","x-stream-index":"001.030"},"polls":{"type":"boolean","x-stream-index":"001.016"},"push_notifications":{"type":"boolean","x-stream-index":"001.013"},"quotes":{"type":"boolean","x-stream-index":"001.008"},"reactions":{"type":"boolean","x-stream-index":"001.006"},"read_events":{"type":"boolean","x-stream-index":"001.003"},"reminders":{"type":"boolean","x-stream-index":"001.014"},"replies":{"type":"boolean","x-stream-index":"001.007"},"search":{"type":"boolean","x-stream-index":"001.005"},"shared_locations":{"type":"boolean","x-stream-index":"001.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.031"},"typing_events":{"type":"boolean","x-stream-index":"001.002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"002.004"},"uploads":{"type":"boolean","x-stream-index":"001.010"},"url_enrichment":{"type":"boolean","x-stream-index":"001.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"001.017"}},"required":["name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","count_messages","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","created_at","updated_at","commands"],"type":"object"},"ChannelConfigWithInfo":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.002.027"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.002.022"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.023"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.002.028"},"blocklist":{"type":"string","x-stream-index":"001.002.024"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.025"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.002.026"},"commands":{"items":{"$ref":"#/components/schemas/Command"},"type":"array","x-stream-index":"001.003"},"connect_events":{"type":"boolean","x-stream-index":"001.002.004"},"count_messages":{"type":"boolean","x-stream-index":"001.002.019"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.001.003"},"custom_events":{"type":"boolean","x-stream-index":"001.002.012"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"002"},"mark_messages_pending":{"type":"boolean","x-stream-index":"001.002.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"001.002.021"},"mutes":{"type":"boolean","x-stream-index":"001.002.009"},"name":{"type":"string","x-stream-index":"001.002.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"001.002.029"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"001.002.030"},"polls":{"type":"boolean","x-stream-index":"001.002.016"},"push_notifications":{"type":"boolean","x-stream-index":"001.002.013"},"quotes":{"type":"boolean","x-stream-index":"001.002.008"},"reactions":{"type":"boolean","x-stream-index":"001.002.006"},"read_events":{"type":"boolean","x-stream-index":"001.002.003"},"reminders":{"type":"boolean","x-stream-index":"001.002.014"},"replies":{"type":"boolean","x-stream-index":"001.002.007"},"search":{"type":"boolean","x-stream-index":"001.002.005"},"shared_locations":{"type":"boolean","x-stream-index":"001.002.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.002.031"},"typing_events":{"type":"boolean","x-stream-index":"001.002.002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"uploads":{"type":"boolean","x-stream-index":"001.002.010"},"url_enrichment":{"type":"boolean","x-stream-index":"001.002.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"001.002.017"}},"required":["created_at","updated_at","name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","count_messages","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","commands"],"type":"object"},"ChannelCreatedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"channel.created","type":"string","x-stream-index":"001.001"}},"required":["type","created_at"],"title":"ChannelCreatedEvent","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"},"ChannelDeletedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003.004"},"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"003.005"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"team":{"type":"string","x-stream-index":"001.001"},"type":{"default":"channel.deleted","type":"string","x-stream-index":"002.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"ChannelDeletedEvent","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"},"ChannelExport":{"properties":{"cid":{"type":"string","x-stream-index":"003"},"id":{"description":"Channel ID","title":"ID","type":"string","x-stream-index":"002"},"messages_since":{"description":"Date to export messages since","format":"date-time","title":"Messages since","type":"number","x-stream-index":"004"},"messages_until":{"description":"Date to export messages until","format":"date-time","title":"Messages until","type":"number","x-stream-index":"005"},"type":{"description":"Channel type","title":"Type","type":"string","x-stream-index":"001"}},"title":"Channel Export","type":"object"},"ChannelFrozenEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"channel.frozen","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"ChannelFrozenEvent","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"},"ChannelGetOrCreateRequest":{"nullable":true,"properties":{"data":{"$ref":"#/components/schemas/ChannelInput","x-stream-index":"003"},"hide_for_creator":{"description":"Whether this channel will be hidden for the user who created the channel or not","title":"Hide for creator","type":"boolean","x-stream-index":"007"},"members":{"$ref":"#/components/schemas/PaginationParams","x-stream-index":"010"},"messages":{"$ref":"#/components/schemas/MessagePaginationParams","x-stream-index":"009"},"state":{"description":"Refresh channel state","title":"State","type":"boolean","x-stream-index":"005"},"thread_unread_counts":{"type":"boolean","x-stream-index":"008"},"watchers":{"$ref":"#/components/schemas/PaginationParams","x-stream-index":"011"}},"type":"object"},"ChannelHiddenEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003.004"},"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"003.005"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"clear_history":{"type":"boolean","x-stream-index":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"type":{"default":"channel.hidden","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["clear_history","cid","channel_id","channel_type","channel_member_count","type","created_at"],"title":"ChannelHiddenEvent","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"},"ChannelInput":{"properties":{"auto_translation_enabled":{"description":"Enable or disable auto translation","title":"Auto translation","type":"boolean","x-stream-index":"005"},"auto_translation_language":{"description":"Switch auto translation language","title":"Auto translation language","type":"string","x-stream-index":"006"},"config_overrides":{"$ref":"#/components/schemas/ChannelConfig","x-stream-index":"024"},"created_by":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"009"},"created_by_id":{"type":"string","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"015"},"disabled":{"type":"boolean","x-stream-index":"014"},"frozen":{"description":"Freeze or unfreeze the channel","title":"Frozen","type":"boolean","x-stream-index":"013"},"invites":{"items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"type":"array","x-stream-index":"016"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"type":"array","x-stream-index":"018"},"team":{"description":"Team the channel belongs to (if multi-tenant mode is enabled)","title":"Team","type":"string","x-stream-index":"004"},"truncated_by_id":{"type":"string","x-stream-index":"010"}},"type":"object"},"ChannelMember":{"nullable":true,"properties":{"archived_at":{"format":"date-time","type":"number","x-stream-index":"015"},"ban_expires":{"description":"Expiration date of the ban","format":"date-time","title":"Ban expires","type":"number","x-stream-index":"013"},"banned":{"description":"Whether member is banned this channel or not","title":"Banned","type":"boolean","x-stream-index":"012"},"channel_role":{"description":"Role of the member in the channel","title":"Channel Role","type":"string","x-stream-index":"018"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"deleted_messages":{"items":{"type":"string"},"type":"array","x-stream-index":"020"},"invite_accepted_at":{"description":"Date when invite was accepted","format":"date-time","title":"Invited accepted at","type":"number","x-stream-index":"006"},"invite_rejected_at":{"description":"Date when invite was rejected","format":"date-time","title":"Invited rejected at","type":"number","x-stream-index":"007"},"invited":{"description":"Whether member was invited or not","title":"Invited","type":"boolean","x-stream-index":"005"},"is_moderator":{"description":"Whether member is channel moderator or not","title":"Is moderator","type":"boolean","x-stream-index":"003"},"notifications_muted":{"type":"boolean","x-stream-index":"019"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"016"},"role":{"description":"Permission level of the member in the channel (DEPRECATED: use channel_role instead)","enum":["member","moderator","admin","owner"],"title":"Role","type":"string","x-stream-index":"017"},"shadow_banned":{"description":"Whether member is shadow banned in this channel or not","title":"Shadow banned","type":"boolean","x-stream-index":"014"},"status":{"type":"string","x-stream-index":"008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"},"user_id":{"title":"User ID","type":"string","x-stream-index":"001"}},"required":["custom","created_at","updated_at","banned","shadow_banned","channel_role","notifications_muted"],"title":"Channel member","type":"object"},"ChannelMemberResponse":{"nullable":true,"properties":{"archived_at":{"format":"date-time","type":"number","x-stream-index":"016"},"ban_expires":{"description":"Expiration date of the ban","format":"date-time","title":"Ban expires","type":"number","x-stream-index":"013"},"banned":{"description":"Whether member is banned this channel or not","title":"Banned","type":"boolean","x-stream-index":"012"},"channel_role":{"description":"Role of the member in the channel","title":"Channel Role","type":"string","x-stream-index":"018"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"invite_accepted_at":{"description":"Date when invite was accepted","format":"date-time","title":"Invited accepted at","type":"number","x-stream-index":"006"},"invite_rejected_at":{"description":"Date when invite was rejected","format":"date-time","title":"Invited rejected at","type":"number","x-stream-index":"007"},"invited":{"description":"Whether member was invited or not","title":"Invited","type":"boolean","x-stream-index":"005"},"is_moderator":{"description":"Whether member is channel moderator or not","title":"Is moderator","type":"boolean","x-stream-index":"003"},"notifications_muted":{"type":"boolean","x-stream-index":"019"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"015"},"role":{"description":"Permission level of the member in the channel (DEPRECATED: use channel_role instead)","enum":["member","moderator","admin","owner"],"title":"Role","type":"string","x-stream-index":"017"},"shadow_banned":{"description":"Whether member is shadow banned in this channel or not","title":"Shadow banned","type":"boolean","x-stream-index":"014"},"status":{"type":"string","x-stream-index":"008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"},"user_id":{"title":"User ID","type":"string","x-stream-index":"001"}},"required":["custom","created_at","updated_at","banned","shadow_banned","channel_role","notifications_muted"],"title":"Channel member","type":"object"},"ChannelMessages":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001"},"messages":{"items":{"$ref":"#/components/schemas/Message"},"type":"array","x-stream-index":"002"}},"required":["messages"],"type":"object"},"ChannelMute":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel that is muted","title":"Channel","x-stream-index":"002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"004"},"expires":{"description":"Date/time of mute expiration","format":"date-time","title":"Expires","type":"number","x-stream-index":"003"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Owner of channel mute","title":"User","x-stream-index":"001"}},"required":["created_at","updated_at"],"type":"object"},"ChannelMutedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"channel.muted","type":"string","x-stream-index":"001.001"}},"required":["type","created_at"],"title":"ChannelMutedEvent","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"},"ChannelOwnCapability":{"description":"All possibility of string to use","enum":["ban-channel-members","cast-poll-vote","connect-events","create-attachment","delete-any-message","delete-channel","delete-own-message","flag-message","freeze-channel","join-channel","leave-channel","mute-channel","pin-message","query-poll-votes","quote-message","read-events","search-messages","send-custom-events","send-links","send-message","send-poll","send-reaction","send-reply","send-restricted-visibility-message","send-typing-events","set-channel-cooldown","share-location","skip-slow-mode","slow-mode","typing-events","update-any-message","update-channel","update-channel-members","update-own-message","update-thread","upload-file"],"title":"ChannelOwnCapability","type":"string"},"ChannelPushPreferences":{"properties":{"chat_level":{"type":"string","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"number","x-stream-index":"002"}},"type":"object"},"ChannelResponse":{"description":"Represents channel in chat","properties":{"auto_translation_enabled":{"description":"Whether auto translation is enabled or not","title":"Auto translation","type":"boolean","x-stream-index":"017"},"auto_translation_language":{"description":"Language to translate to when auto translation is active","title":"Auto translation language","type":"string","x-stream-index":"018"},"blocked":{"description":"Whether this channel is blocked by current user or not","title":"Blocked","type":"boolean","x-stream-index":"023"},"cid":{"description":"Channel CID (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/ChannelConfigWithInfo","description":"Channel configuration","title":"ChannelConfigWithInfo","x-stream-index":"013"},"cooldown":{"description":"Cooldown period after sending each message","format":"int32","title":"Cooldown","type":"integer","x-stream-index":"020"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"005"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"Creator of the channel","title":"UserResponse","x-stream-index":"008"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"026"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"007"},"disabled":{"type":"boolean","x-stream-index":"010"},"frozen":{"description":"Whether channel is frozen or not","title":"Frozen","type":"boolean","x-stream-index":"009"},"hidden":{"description":"Whether this channel is hidden by current user or not","title":"Hidden","type":"boolean","x-stream-index":"022"},"hide_messages_before":{"description":"Date since when the message history is accessible","format":"date-time","title":"Hide messages before","type":"number","x-stream-index":"019"},"id":{"description":"Channel unique ID","title":"ID","type":"string","x-stream-index":"001"},"last_message_at":{"description":"Date of the last message sent","format":"date-time","title":"Last message at","type":"number","x-stream-index":"004"},"member_count":{"description":"Number of members in the channel","format":"int32","title":"Member count","type":"integer","x-stream-index":"012"},"members":{"description":"List of channel members (max 100)","items":{"$ref":"#/components/schemas/ChannelMember"},"title":"ChannelMembers","type":"array","x-stream-index":"011"},"message_count":{"description":"Number of messages in the channel","format":"int64","title":"Message count","type":"integer","x-stream-index":"027"},"mute_expires_at":{"description":"Date of mute expiration","format":"date-time","title":"Mute expires at","type":"number","x-stream-index":"015"},"muted":{"description":"Whether this channel is muted or not","title":"Muted","type":"boolean","x-stream-index":"014"},"own_capabilities":{"description":"List of channel capabilities of authenticated user","items":{"$ref":"#/components/schemas/ChannelOwnCapability"},"title":"ChannelOwnCapability","type":"array","x-stream-index":"021"},"team":{"description":"Team the channel belongs to (multi-tenant only)","title":"Team","type":"string","x-stream-index":"016"},"truncated_at":{"description":"Date of the latest truncation of the channel","format":"date-time","title":"UserResponse","type":"number","x-stream-index":"024"},"truncated_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"025"},"type":{"description":"Type of the channel","title":"Type","type":"string","x-stream-docs-page-id":"channel_features","x-stream-index":"002"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"006"}},"required":["id","type","cid","created_at","updated_at","frozen","disabled","custom"],"title":"Channel","type":"object"},"ChannelStateResponse":{"nullable":true,"properties":{"active_live_locations":{"items":{"$ref":"#/components/schemas/SharedLocationResponseData"},"type":"array","x-stream-index":"001.015"},"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001.001"},"deleted_messages":{"items":{"type":"string"},"type":"array","x-stream-index":"001.016"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001.014"},"duration":{"type":"string","x-stream-index":"002.001"},"hidden":{"type":"boolean","x-stream-index":"001.011"},"hide_messages_before":{"format":"date-time","type":"number","x-stream-index":"001.012"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"001.007"},"membership":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"001.008"},"messages":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","x-stream-index":"001.002"},"pending_messages":{"items":{"$ref":"#/components/schemas/PendingMessageResponse"},"type":"array","x-stream-index":"001.013"},"pinned_messages":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","x-stream-index":"001.003"},"push_preferences":{"$ref":"#/components/schemas/ChannelPushPreferences","x-stream-index":"001.009"},"read":{"items":{"$ref":"#/components/schemas/ReadStateResponse"},"type":"array","x-stream-index":"001.006"},"threads":{"items":{"$ref":"#/components/schemas/ThreadStateResponse"},"type":"array","x-stream-index":"001.010"},"watcher_count":{"format":"int32","type":"integer","x-stream-index":"001.004"},"watchers":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"001.005"}},"required":["messages","pinned_messages","members","threads","duration"],"type":"object"},"ChannelStateResponseFields":{"properties":{"active_live_locations":{"description":"Active live locations in the channel","items":{"$ref":"#/components/schemas/SharedLocationResponseData"},"title":"Active Live Locations","type":"array","x-stream-index":"015"},"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001"},"deleted_messages":{"items":{"type":"string"},"type":"array","x-stream-index":"016"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"014"},"hidden":{"description":"Whether this channel is hidden or not","title":"Hidden","type":"boolean","x-stream-index":"011"},"hide_messages_before":{"description":"Messages before this date are hidden from the user","format":"date-time","title":"Hide messages before","type":"number","x-stream-index":"012"},"members":{"description":"List of channel members","items":{"$ref":"#/components/schemas/ChannelMember"},"title":"Members","type":"array","x-stream-index":"007"},"membership":{"$ref":"#/components/schemas/ChannelMember","description":"Current user membership object","title":"Membership","x-stream-index":"008"},"messages":{"description":"List of channel messages","items":{"$ref":"#/components/schemas/MessageResponse"},"title":"Message","type":"array","x-stream-index":"002"},"pending_messages":{"description":"Pending messages that this user has sent","items":{"$ref":"#/components/schemas/PendingMessageResponse"},"title":"Pending messages","type":"array","x-stream-index":"013"},"pinned_messages":{"description":"List of pinned messages in the channel","items":{"$ref":"#/components/schemas/MessageResponse"},"title":"Pinned messages","type":"array","x-stream-docs-page-id":"pinned_messages","x-stream-index":"003"},"push_preferences":{"$ref":"#/components/schemas/ChannelPushPreferences","x-stream-index":"009"},"read":{"description":"List of read states","items":{"$ref":"#/components/schemas/ReadStateResponse"},"title":"Read","type":"array","x-stream-index":"006"},"threads":{"items":{"$ref":"#/components/schemas/ThreadStateResponse"},"type":"array","x-stream-index":"010"},"watcher_count":{"description":"Number of channel watchers","format":"int32","title":"Watcher count","type":"integer","x-stream-index":"004"},"watchers":{"description":"List of user who is watching the channel","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Watchers","type":"array","x-stream-index":"005"}},"required":["messages","pinned_messages","members","threads"],"type":"object"},"ChannelTruncatedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001.004"},"channel_id":{"type":"string","x-stream-index":"001.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"001.005"},"channel_type":{"type":"string","x-stream-index":"001.003"},"cid":{"type":"string","x-stream-index":"001.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"type":{"default":"channel.truncated","type":"string","x-stream-index":"002.001"}},"required":["cid","channel_id","channel_type","channel_member_count","type","created_at"],"title":"ChannelTruncatedEvent","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"},"ChannelTypeConfig":{"nullable":true,"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"003.002.027"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"003.002.022"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.002.023"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"003.002.028"},"blocklist":{"type":"string","x-stream-index":"003.002.024"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.002.025"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"003.002.026"},"commands":{"items":{"$ref":"#/components/schemas/Command"},"type":"array","x-stream-index":"003.003"},"connect_events":{"type":"boolean","x-stream-index":"003.002.004"},"count_messages":{"type":"boolean","x-stream-index":"003.002.019"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.001.003"},"custom_events":{"type":"boolean","x-stream-index":"003.002.012"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"002"},"mark_messages_pending":{"type":"boolean","x-stream-index":"003.002.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"003.002.021"},"mutes":{"type":"boolean","x-stream-index":"003.002.009"},"name":{"type":"string","x-stream-index":"003.002.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"003.002.029"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"003.002.030"},"permissions":{"items":{"$ref":"#/components/schemas/PolicyRequest"},"type":"array","x-stream-index":"001"},"polls":{"type":"boolean","x-stream-index":"003.002.016"},"push_notifications":{"type":"boolean","x-stream-index":"003.002.013"},"quotes":{"type":"boolean","x-stream-index":"003.002.008"},"reactions":{"type":"boolean","x-stream-index":"003.002.006"},"read_events":{"type":"boolean","x-stream-index":"003.002.003"},"reminders":{"type":"boolean","x-stream-index":"003.002.014"},"replies":{"type":"boolean","x-stream-index":"003.002.007"},"search":{"type":"boolean","x-stream-index":"003.002.005"},"shared_locations":{"type":"boolean","x-stream-index":"003.002.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"003.002.031"},"typing_events":{"type":"boolean","x-stream-index":"003.002.002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"003.001.004"},"uploads":{"type":"boolean","x-stream-index":"003.002.010"},"url_enrichment":{"type":"boolean","x-stream-index":"003.002.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"003.002.017"}},"required":["permissions","grants","created_at","updated_at","name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","count_messages","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","commands"],"type":"object"},"ChannelUnFrozenEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"channel.unfrozen","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"ChannelUnFrozenEvent","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"},"ChannelUnmutedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"channel.unmuted","type":"string","x-stream-index":"001.001"}},"required":["type","created_at"],"title":"ChannelUnmutedEvent","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"},"ChannelUpdatedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"004.004"},"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"004.005"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"002.001"},"type":{"default":"channel.updated","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"ChannelUpdatedEvent","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"},"ChannelVisibleEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"001.002"},"channel_type":{"type":"string","x-stream-index":"001.003"},"cid":{"type":"string","x-stream-index":"001.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"type":{"default":"channel.visible","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"ChannelVisibleEvent","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"},"CheckExternalStorageResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"file_url":{"type":"string","x-stream-index":"002"}},"required":["duration","file_url"],"title":"Response","type":"object"},"CheckPushRequest":{"description":"Check push request","nullable":true,"properties":{"apn_template":{"description":"Push message template for APN","title":"APN template","type":"string","x-stream-docs-page-id":"push_template","x-stream-index":"002"},"event_type":{"description":"Type of event for push templates (default: message.new)","enum":["message.new","message.updated","reaction.new","reaction.updated","notification.reminder_due"],"title":"Event type","type":"string","x-stream-index":"008"},"firebase_data_template":{"description":"Push message data template for Firebase","title":"Firebase data template","type":"string","x-stream-docs-page-id":"push_template","x-stream-index":"004"},"firebase_template":{"description":"Push message template for Firebase","title":"Firebase template","type":"string","x-stream-docs-page-id":"push_template","x-stream-index":"003"},"message_id":{"description":"Message ID to send push notification for","title":"Message ID","type":"string","x-stream-index":"001"},"push_provider_name":{"description":"Name of push provider","title":"Name of push provider","type":"string","x-stream-index":"007"},"push_provider_type":{"description":"Push provider type","enum":["firebase","apn","huawei","xiaomi"],"title":"Type of push provider","type":"string","x-stream-index":"006"},"skip_devices":{"description":"Don't require existing devices to render templates","title":"Skip devices","type":"boolean","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"009.002"},"user_id":{"type":"string","x-stream-index":"009.001"}},"title":"CheckPushRequest","type":"object"},"CheckPushResponse":{"nullable":true,"properties":{"device_errors":{"additionalProperties":{"$ref":"#/components/schemas/DeviceErrorInfo"},"description":"Object with device errors","title":"Device errors","type":"object","x-stream-index":"001","x-stream-map":{"key":"device_id"}},"duration":{"type":"string","x-stream-index":"008.001"},"event_type":{"description":"The event type that was tested","title":"Event type","type":"string","x-stream-index":"004"},"general_errors":{"description":"List of general errors","items":{"type":"string"},"title":"General errors","type":"array","x-stream-index":"002"},"rendered_apn_template":{"title":"Rendered APN template","type":"string","x-stream-index":"005"},"rendered_firebase_template":{"title":"Rendered Firebase template","type":"string","x-stream-index":"006"},"rendered_message":{"additionalProperties":{"type":"string"},"title":"Rendered message","type":"object","x-stream-index":"007"},"skip_devices":{"description":"Don't require existing devices to render templates","title":"Skip devices","type":"boolean","x-stream-index":"003"}},"required":["duration"],"type":"object"},"CheckRequest":{"nullable":true,"properties":{"config_key":{"description":"Key of the moderation configuration to use","title":"Config Key","type":"string","x-stream-index":"005"},"config_team":{"description":"Team associated with the configuration","title":"Config Team","type":"string","x-stream-index":"006"},"entity_creator_id":{"description":"ID of the user who created the entity","title":"Entity Creator ID","type":"string","x-stream-index":"003"},"entity_id":{"description":"Unique identifier of the entity to moderate","title":"Entity ID","type":"string","x-stream-index":"002"},"entity_type":{"description":"Type of entity to moderate","title":"Entity Type","type":"string","x-stream-index":"001"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content to be moderated","title":"Moderation Payload","x-stream-index":"004"},"options":{"additionalProperties":{},"description":"Additional moderation configuration options","title":"Options","type":"object","x-stream-index":"007"},"test_mode":{"description":"Whether to run moderation in test mode","title":"Test Mode","type":"boolean","x-stream-index":"008"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"009.002"},"user_id":{"type":"string","x-stream-index":"009.001"}},"required":["entity_type","entity_id","entity_creator_id"],"type":"object"},"CheckResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"005.001"},"item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"Review queue item (present if action != keep)","title":"Item","x-stream-index":"004"},"recommended_action":{"description":"Suggested action based on moderation results","title":"Recommended Action","type":"string","x-stream-index":"003"},"status":{"description":"Status of the moderation check (completed or pending)","title":"Status","type":"string","x-stream-index":"001"},"task_id":{"description":"ID of the running moderation task","title":"Task ID","type":"string","x-stream-index":"002"}},"required":["status","recommended_action","duration"],"type":"object"},"CheckSNSRequest":{"nullable":true,"properties":{"sns_key":{"description":"AWS SNS access key","title":"SNS key","type":"string","x-stream-index":"002"},"sns_secret":{"description":"AWS SNS key secret","title":"SNS secret","type":"string","x-stream-index":"003"},"sns_topic_arn":{"description":"AWS SNS topic ARN","title":"SNS Topic ARN","type":"string","x-stream-index":"001"}},"type":"object"},"CheckSNSResponse":{"nullable":true,"properties":{"data":{"additionalProperties":{},"description":"Error data","title":"ReadOnlyData","type":"object","x-stream-index":"003"},"duration":{"type":"string","x-stream-index":"004.001"},"error":{"description":"Error text","title":"Error","type":"string","x-stream-index":"002"},"status":{"description":"Validation result","enum":["ok","error"],"title":"Status","type":"string","x-stream-index":"001"}},"required":["status","duration"],"type":"object"},"CheckSQSRequest":{"nullable":true,"properties":{"sqs_key":{"description":"AWS SQS access key","title":"SQS key","type":"string","x-stream-index":"002"},"sqs_secret":{"description":"AWS SQS key secret","title":"SQS secret","type":"string","x-stream-index":"003"},"sqs_url":{"description":"AWS SQS endpoint URL","title":"SQS URL","type":"string","x-stream-index":"001"}},"type":"object"},"CheckSQSResponse":{"nullable":true,"properties":{"data":{"additionalProperties":{},"description":"Error data","title":"ReadOnlyData","type":"object","x-stream-index":"003"},"duration":{"type":"string","x-stream-index":"004.001"},"error":{"description":"Error text","title":"Error","type":"string","x-stream-index":"002"},"status":{"description":"Validation result","enum":["ok","error"],"title":"Status","type":"string","x-stream-index":"001"}},"required":["status","duration"],"type":"object"},"Command":{"description":"Represents custom chat command","nullable":true,"properties":{"args":{"description":"Arguments help text, shown in commands auto-completion","title":"Arguments","type":"string","x-stream-index":"006"},"created_at":{"description":"Date/time of creation","format":"date-time","readOnly":true,"title":"Created at","type":"number","x-stream-index":"001"},"description":{"description":"Description, shown in commands auto-completion","title":"Description","type":"string","x-stream-index":"005"},"name":{"description":"Unique command name","title":"Name","type":"string","x-stream-index":"004"},"set":{"description":"Set name used for grouping commands","title":"Set","type":"string","x-stream-index":"007"},"updated_at":{"description":"Date/time of the last update","format":"date-time","readOnly":true,"title":"Updated at","type":"number","x-stream-index":"002"}},"required":["name","description","args","set"],"title":"Command","type":"object"},"CommitMessageRequest":{"nullable":true,"type":"object"},"CompositeAppSettings":{"properties":{"json_encoded_settings":{"type":"string","x-stream-index":"005"},"url":{"type":"string","x-stream-index":"004"}},"type":"object"},"ConfigOverrides":{"properties":{"blocklist":{"type":"string","x-stream-index":"008"},"blocklist_behavior":{"enum":["flag","block"],"type":"string","x-stream-index":"009"},"commands":{"items":{"type":"string"},"type":"array","x-stream-index":"011"},"count_messages":{"type":"boolean","x-stream-index":"014"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"010"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"007"},"quotes":{"type":"boolean","x-stream-index":"004"},"reactions":{"type":"boolean","x-stream-index":"002"},"replies":{"type":"boolean","x-stream-index":"003"},"shared_locations":{"type":"boolean","x-stream-index":"013"},"typing_events":{"type":"boolean","x-stream-index":"001"},"uploads":{"type":"boolean","x-stream-index":"005"},"url_enrichment":{"type":"boolean","x-stream-index":"006"},"user_message_reminders":{"type":"boolean","x-stream-index":"012"}},"required":["grants","commands"],"type":"object"},"ConfigResponse":{"properties":{"ai_image_config":{"$ref":"#/components/schemas/AIImageConfig","description":"Configuration for AI image analysis","title":"AI Image Config","x-stream-index":"010"},"ai_text_config":{"$ref":"#/components/schemas/AITextConfig","description":"Configuration for AI text analysis","title":"AI Text Config","x-stream-index":"008"},"ai_video_config":{"$ref":"#/components/schemas/AIVideoConfig","description":"Configuration for AI video analysis","title":"AI Video Config","x-stream-index":"011"},"async":{"description":"Whether moderation should be performed asynchronously","title":"Async","type":"boolean","x-stream-index":"003"},"automod_platform_circumvention_config":{"$ref":"#/components/schemas/AutomodPlatformCircumventionConfig","description":"Configuration for platform circumvention detection","title":"Automod Platform Circumvention Config","x-stream-index":"005"},"automod_semantic_filters_config":{"$ref":"#/components/schemas/AutomodSemanticFiltersConfig","description":"Configuration for semantic filtering","title":"Automod Semantic Filters Config","x-stream-index":"006"},"automod_toxicity_config":{"$ref":"#/components/schemas/AutomodToxicityConfig","description":"Configuration for toxicity detection","title":"Automod Toxicity Config","x-stream-index":"004"},"block_list_config":{"$ref":"#/components/schemas/BlockListConfig","description":"Configuration for block list filtering","title":"Block List Config","x-stream-index":"007"},"created_at":{"description":"When the configuration was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"013"},"key":{"description":"Unique identifier for the moderation configuration","title":"Key","type":"string","x-stream-index":"001"},"llm_config":{"$ref":"#/components/schemas/LLMConfig","description":"Configuration for customer-configured LLM moderation","title":"LLM Config","x-stream-index":"009"},"team":{"description":"Team associated with the configuration","title":"Team","type":"string","x-stream-index":"002"},"updated_at":{"description":"When the configuration was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"014"},"velocity_filter_config":{"$ref":"#/components/schemas/VelocityFilterConfig","description":"Configuration for velocity-based filtering","title":"Velocity Filter Config","x-stream-index":"012"},"video_call_rule_config":{"$ref":"#/components/schemas/VideoCallRuleConfig","x-stream-index":"015"}},"required":["key","team","async","created_at","updated_at"],"type":"object"},"ContentCountRuleParameters":{"properties":{"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"type":"object"},"CreateBlockListRequest":{"description":"Block list contains restricted words","nullable":true,"properties":{"name":{"description":"Block list name","maxLength":255,"title":"Name","type":"string","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"004"},"type":{"description":"Block list type.","enum":["regex","domain","domain_allowlist","email","word"],"title":"Type","type":"string","x-stream-index":"003"},"words":{"description":"List of words to block","items":{"type":"string"},"minimum":1,"title":"Words","type":"array","x-stream-index":"002"}},"required":["name","words"],"title":"Block list","type":"object","x-stream-docs-page-id":"block_lists"},"CreateBlockListResponse":{"description":"Basic response information","nullable":true,"properties":{"blocklist":{"$ref":"#/components/schemas/BlockListResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["duration"],"title":"Response","type":"object"},"CreateChannelTypeRequest":{"nullable":true,"properties":{"automod":{"description":"Automod","enum":["disabled","simple","AI"],"title":"Automod","type":"string","x-stream-index":"019"},"automod_behavior":{"description":"Automod behavior","enum":["flag","block"],"title":"Automod behavior","type":"string","x-stream-index":"020"},"blocklist":{"description":"Blocklist","title":"Blocklist","type":"string","x-stream-index":"024"},"blocklist_behavior":{"description":"Blocklist behavior","enum":["flag","block","shadow_block"],"title":"Blocklist behavior","type":"string","x-stream-index":"025"},"blocklists":{"description":"Blocklists","items":{"$ref":"#/components/schemas/BlockListOptions"},"title":"Blocklists","type":"array","x-stream-index":"026"},"commands":{"description":"List of commands that channel supports","items":{"type":"string"},"title":"Commands","type":"array","x-stream-index":"021"},"connect_events":{"description":"Connect events","title":"Connect events","type":"boolean","x-stream-index":"004"},"custom_events":{"description":"Custom events","title":"Custom events","type":"boolean","x-stream-index":"011"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"List of grants for the channel type","title":"Grants","type":"object","x-stream-index":"023"},"mark_messages_pending":{"description":"Mark messages pending","title":"Mark messages pending","type":"boolean","x-stream-index":"013"},"max_message_length":{"description":"Max message length","format":"int32","title":"Max message length","type":"integer","x-stream-index":"018"},"message_retention":{"description":"Message retention","enum":["infinite","numeric"],"title":"Message retention","type":"string","x-stream-index":"017"},"mutes":{"description":"Mutes","title":"Mutes","type":"boolean","x-stream-index":"008"},"name":{"description":"Channel type name","title":"Name","type":"string","x-stream-index":"001"},"partition_size":{"description":"Partition size","format":"int32","minimum":10,"title":"Partition size","type":"integer","x-stream-index":"027"},"partition_ttl":{"description":"Partition TTL","example":"24h","format":"duration","nullable":true,"title":"Partition TTL","type":"string","x-stream-index":"028"},"permissions":{"description":"List of permissions for the channel type","items":{"$ref":"#/components/schemas/PolicyRequest"},"title":"Permissions","type":"array","x-stream-index":"022"},"polls":{"description":"Polls","title":"Polls","type":"boolean","x-stream-index":"014"},"push_notifications":{"description":"Push notifications","title":"Push notifications","type":"boolean","x-stream-index":"012"},"reactions":{"description":"Reactions","title":"Reactions","type":"boolean","x-stream-index":"005"},"read_events":{"description":"Read events","title":"Read events","type":"boolean","x-stream-index":"003"},"replies":{"description":"Replies","title":"Replies","type":"boolean","x-stream-index":"006"},"search":{"description":"Search","title":"Search","type":"boolean","x-stream-index":"007"},"shared_locations":{"description":"Enables shared location messages","title":"Shared locations","type":"boolean","x-stream-index":"016"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"029"},"typing_events":{"description":"Typing events","title":"Typing events","type":"boolean","x-stream-index":"002"},"uploads":{"description":"Uploads","title":"Uploads","type":"boolean","x-stream-index":"009"},"url_enrichment":{"description":"URL enrichment","title":"URL enrichment","type":"boolean","x-stream-index":"010"},"user_message_reminders":{"type":"boolean","x-stream-index":"015"}},"required":["name","max_message_length","automod","automod_behavior"],"title":"CreateChannelTypeRequest","type":"object"},"CreateChannelTypeResponse":{"nullable":true,"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.001.027"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.001.022"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.001.023"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.001.028"},"blocklist":{"type":"string","x-stream-index":"001.001.024"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.001.025"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.001.026"},"commands":{"items":{"type":"string"},"type":"array","x-stream-index":"001.003"},"connect_events":{"type":"boolean","x-stream-index":"001.001.004"},"count_messages":{"type":"boolean","x-stream-index":"001.001.019"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002.003"},"custom_events":{"type":"boolean","x-stream-index":"001.001.012"},"duration":{"type":"string","x-stream-index":"004.001"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"003"},"mark_messages_pending":{"type":"boolean","x-stream-index":"001.001.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"001.001.021"},"mutes":{"type":"boolean","x-stream-index":"001.001.009"},"name":{"type":"string","x-stream-index":"001.001.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"001.001.029"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"001.001.030"},"permissions":{"items":{"$ref":"#/components/schemas/PolicyRequest"},"type":"array","x-stream-index":"002"},"polls":{"type":"boolean","x-stream-index":"001.001.016"},"push_notifications":{"type":"boolean","x-stream-index":"001.001.013"},"quotes":{"type":"boolean","x-stream-index":"001.001.008"},"reactions":{"type":"boolean","x-stream-index":"001.001.006"},"read_events":{"type":"boolean","x-stream-index":"001.001.003"},"reminders":{"type":"boolean","x-stream-index":"001.001.014"},"replies":{"type":"boolean","x-stream-index":"001.001.007"},"search":{"type":"boolean","x-stream-index":"001.001.005"},"shared_locations":{"type":"boolean","x-stream-index":"001.001.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.001.031"},"typing_events":{"type":"boolean","x-stream-index":"001.001.002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.002.004"},"uploads":{"type":"boolean","x-stream-index":"001.001.010"},"url_enrichment":{"type":"boolean","x-stream-index":"001.001.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"001.001.017"}},"required":["name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","count_messages","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","created_at","updated_at","commands","permissions","grants","duration"],"type":"object"},"CreateCommandRequest":{"description":"Create a new command","nullable":true,"properties":{"args":{"description":"Arguments help text, shown in commands auto-completion","maxLength":255,"title":"Arguments","type":"string","x-stream-index":"003"},"description":{"description":"Description, shown in commands auto-completion","maxLength":255,"title":"Description","type":"string","x-stream-index":"002"},"name":{"description":"Unique command name","maxLength":255,"minLength":1,"title":"Name","type":"string","x-stream-index":"001"},"set":{"description":"Set name used for grouping commands","maxLength":255,"title":"Set","type":"string","x-stream-index":"004"}},"required":["name","description"],"title":"CreateCommandRequest","type":"object"},"CreateCommandResponse":{"nullable":true,"properties":{"command":{"$ref":"#/components/schemas/Command","description":"Command object","title":"Command","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["duration"],"title":"CreateCommandResponse","type":"object"},"CreateDeviceRequest":{"description":"Create device request","nullable":true,"properties":{"id":{"description":"Device ID","maxLength":255,"minLength":1,"title":"ID","type":"string","x-stream-index":"001"},"push_provider":{"description":"Push provider","enum":["firebase","apn","huawei","xiaomi"],"title":"PushProvider","type":"string","x-stream-index":"002"},"push_provider_name":{"description":"Push provider name","title":"PushProviderName","type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"005.002"},"user_id":{"description":"**Server-side only**. User ID which server acts upon","title":"User ID","type":"string","x-stream-index":"005.001"},"voip_token":{"description":"When true the token is for Apple VoIP push notifications","title":"VoipToken","type":"boolean","x-stream-index":"004"}},"required":["id","push_provider"],"title":"CreateDeviceRequest","type":"object"},"CreateExternalStorageRequest":{"description":"Create external storage","nullable":true,"properties":{"aws_s3":{"$ref":"#/components/schemas/S3Request","description":"Only required if you want to create an Amazon S3 storage","title":"AwsS3","x-stream-index":"003.004"},"azure_blob":{"$ref":"#/components/schemas/AzureRequest","description":"Only required if you want to create an Azure Blob Storage","title":"AzureBlob","x-stream-index":"003.006"},"bucket":{"description":"The name of the bucket on the service provider","title":"Bucket","type":"string","x-stream-index":"003.002"},"gcs_credentials":{"type":"string","x-stream-index":"003.005"},"name":{"description":"The name of the provider, this must be unique","title":"Name","type":"string","x-stream-index":"001"},"path":{"description":"The path prefix to use for storing files","title":"Path","type":"string","x-stream-index":"003.003"},"storage_type":{"description":"The type of storage to use","enum":["s3","gcs","abs"],"title":"StorageType","type":"string","x-stream-index":"003.001"}},"required":["name","storage_type","bucket"],"title":"CreateExternalStorageRequest","type":"object"},"CreateExternalStorageResponse":{"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"},"CreateGuestRequest":{"nullable":true,"properties":{"user":{"$ref":"#/components/schemas/UserRequest","description":"User object which server acts upon","title":"User","x-stream-index":"001"}},"required":["user"],"type":"object"},"CreateGuestResponse":{"nullable":true,"properties":{"access_token":{"description":"the access token to authenticate the user","title":"Access token","type":"string","x-stream-index":"002"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User object which server acts upon","title":"User","x-stream-index":"001"}},"required":["user","access_token","duration"],"type":"object"},"CreateImportRequest":{"nullable":true,"properties":{"mode":{"enum":["insert","upsert"],"type":"string","x-stream-index":"002"},"path":{"type":"string","x-stream-index":"001"}},"required":["path","mode"],"type":"object"},"CreateImportResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"import_task":{"$ref":"#/components/schemas/ImportTask","x-stream-index":"001"}},"required":["duration"],"title":"Response","type":"object"},"CreateImportURLRequest":{"nullable":true,"properties":{"filename":{"type":"string","x-stream-index":"001"}},"type":"object"},"CreateImportURLResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"path":{"type":"string","x-stream-index":"001"},"upload_url":{"type":"string","x-stream-index":"002"}},"required":["path","upload_url","duration"],"title":"Response","type":"object"},"CreatePollOptionRequest":{"nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"003"},"text":{"description":"Option text","title":"string","type":"string","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"required":["text"],"type":"object"},"CreatePollRequest":{"description":"Contains all information needed to create a new poll","nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"011"},"allow_answers":{"description":"Indicates whether users can suggest user defined answers","title":"Allow answers","type":"boolean","x-stream-index":"009"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"008"},"description":{"description":"A description of the poll","title":"Description","type":"string","x-stream-index":"003"},"enforce_unique_vote":{"description":"Indicates whether users can cast multiple votes","title":"Multiple choice","type":"boolean","x-stream-index":"006"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"is_closed":{"description":"Indicates whether the poll is open for voting","title":"Is closed","type":"boolean","x-stream-index":"010"},"max_votes_allowed":{"description":"Indicates the maximum amount of votes a user can cast","format":"int32","maximum":10,"title":"Maximum votes allowed","type":"integer","x-stream-index":"007"},"name":{"description":"The name of the poll","title":"Name","type":"string","x-stream-index":"002"},"options":{"items":{"$ref":"#/components/schemas/PollOptionInput"},"maximum":100,"type":"array","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"012.002"},"user_id":{"type":"string","x-stream-index":"012.001"},"voting_visibility":{"enum":["anonymous","public"],"type":"string","x-stream-index":"005"}},"required":["name"],"title":"Create Poll Request","type":"object"},"CreateReminderRequest":{"nullable":true,"properties":{"remind_at":{"format":"date-time","type":"number","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"type":"object"},"CreateRoleRequest":{"nullable":true,"properties":{"name":{"description":"Role name","maxLength":64,"title":"Name","type":"string","x-stream-index":"001"}},"required":["name"],"type":"object"},"CreateRoleResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"role":{"$ref":"#/components/schemas/Role","x-stream-index":"002"}},"required":["duration","role"],"title":"Response","type":"object"},"CustomActionRequest":{"properties":{"id":{"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"type":"object"},"CustomCheckFlag":{"properties":{"custom":{"additionalProperties":{},"description":"Additional metadata for the flag","title":"Custom","type":"object","x-stream-index":"003"},"labels":{"description":"Labels from various moderation sources","items":{"type":"string"},"title":"Labels","type":"array","x-stream-index":"004"},"reason":{"description":"Optional explanation for the flag","title":"Reason","type":"string","x-stream-index":"002"},"type":{"description":"Type of check (custom_check_text, custom_check_image, custom_check_video)","maxLength":255,"title":"Type","type":"string","x-stream-index":"001"}},"required":["type"],"type":"object"},"CustomCheckRequest":{"nullable":true,"properties":{"entity_creator_id":{"description":"ID of the user who created the entity (required for non-message entities)","title":"Entity Creator ID","type":"string","x-stream-index":"003"},"entity_id":{"description":"Unique identifier of the entity","title":"Entity ID","type":"string","x-stream-index":"002"},"entity_type":{"description":"Type of entity to perform custom check on","title":"Entity Type","type":"string","x-stream-index":"001"},"flags":{"description":"List of custom check flags (1-10 flags required)","items":{"$ref":"#/components/schemas/CustomCheckFlag"},"maximum":10,"minimum":1,"title":"Flags","type":"array","x-stream-index":"005"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content to be checked (required for non-message entities)","title":"Moderation Payload","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"006.002"},"user_id":{"type":"string","x-stream-index":"006.001"}},"required":["entity_type","entity_id","flags"],"type":"object"},"CustomCheckResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"004.001"},"id":{"description":"Unique identifier of the custom check","title":"ID","type":"string","x-stream-index":"001"},"item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"Review queue item details","title":"Item","x-stream-index":"002"},"status":{"description":"Status of the custom check","title":"Status","type":"string","x-stream-index":"003"}},"required":["id","status","duration"],"type":"object"},"Data":{"properties":{"id":{"type":"string","x-stream-index":"001"}},"required":["id"],"type":"object"},"DataDogInfo":{"properties":{"api_key":{"type":"string","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"003"},"site":{"type":"string","x-stream-index":"002"}},"type":"object"},"DeactivateUserRequest":{"nullable":true,"properties":{"created_by_id":{"description":"ID of the user who deactivated the user","title":"Created by ID","type":"string","x-stream-index":"003"},"mark_messages_deleted":{"description":"Makes messages appear to be deleted","title":"Mark messages deleted","type":"boolean","x-stream-index":"002"}},"type":"object"},"DeactivateUserResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Deactivated user object","title":"User","x-stream-index":"001"}},"required":["duration"],"type":"object"},"DeactivateUsersRequest":{"description":"Deactivate users request","nullable":true,"properties":{"created_by_id":{"description":"ID of the user who deactivated the users","title":"Created by ID","type":"string","x-stream-index":"003"},"mark_channels_deleted":{"type":"boolean","x-stream-index":"004"},"mark_messages_deleted":{"description":"Makes messages appear to be deleted","title":"Mark messages deleted","type":"boolean","x-stream-index":"002"},"user_ids":{"description":"User IDs to deactivate","items":{"type":"string"},"maximum":100,"minimum":1,"title":"User IDs","type":"array","x-stream-index":"001"}},"required":["user_ids"],"title":"DeactivateUsersRequest","type":"object"},"DeactivateUsersResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"task_id":{"type":"string","x-stream-index":"001"}},"required":["task_id","duration"],"title":"Response","type":"object"},"DeleteActivityRequest":{"properties":{"hard_delete":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"DeleteChannelResponse":{"description":"Basic response information","nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"Response","type":"object"},"DeleteChannelsRequest":{"nullable":true,"properties":{"cids":{"description":"All channels that should be deleted","items":{"type":"string"},"maximum":100,"minimum":1,"title":"Channels CID","type":"array","x-stream-index":"001"},"hard_delete":{"description":"Specify if channels and all ressources should be hard deleted","title":"Hard delete","type":"boolean","x-stream-index":"002"}},"required":["cids"],"type":"object"},"DeleteChannelsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"result":{"additionalProperties":{"$ref":"#/components/schemas/DeleteChannelsResultResponse"},"description":"Map of channel IDs and their deletion results","title":"Result","type":"object","x-stream-index":"001"},"task_id":{"type":"string","x-stream-index":"002"}},"required":["duration"],"type":"object"},"DeleteChannelsResultResponse":{"nullable":true,"properties":{"error":{"type":"string","x-stream-index":"002"},"status":{"type":"string","x-stream-index":"001"}},"required":["status"],"type":"object"},"DeleteCommandResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"name":{"description":"Command name","title":"Name","type":"string","x-stream-index":"001"}},"required":["name","duration"],"title":"DeleteCommandResponse","type":"object"},"DeleteExternalStorageResponse":{"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"},"DeleteMessageRequest":{"properties":{"hard_delete":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"DeleteMessageResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001"}},"required":["message","duration"],"title":"Response","type":"object"},"DeleteModerationConfigResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"DeleteModerationRuleResponse":{"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"},"DeleteModerationTemplateResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"DeleteReactionRequest":{"properties":{"hard_delete":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"DeleteReactionResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001"},"reaction":{"$ref":"#/components/schemas/ReactionResponse","x-stream-index":"002"}},"required":["message","reaction","duration"],"title":"Response","type":"object"},"DeleteReminderResponse":{"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"},"DeleteSegmentTargetsRequest":{"nullable":true,"properties":{"target_ids":{"description":"Target IDs","items":{"type":"string"},"maximum":100,"minimum":1,"title":"[]string","type":"array","x-stream-index":"002"}},"required":["target_ids"],"type":"object"},"DeleteUserRequest":{"properties":{"delete_conversation_channels":{"type":"boolean","x-stream-index":"003"},"delete_feeds_content":{"type":"boolean","x-stream-index":"004"},"hard_delete":{"type":"boolean","x-stream-index":"001"},"mark_messages_deleted":{"type":"boolean","x-stream-index":"002"}},"type":"object"},"DeleteUsersRequest":{"nullable":true,"properties":{"calls":{"description":"Calls delete mode.\nAffected calls are those that include exactly two members, one of whom is the user being deleted.\n\n* null or empty string - doesn't delete any calls\n* soft - marks user's calls and their related data as deleted (soft-delete)\n* hard - deletes user's calls and their data completely (hard-delete)\n","enum":["soft","hard"],"title":"Delete User's calls","type":"string","x-stream-index":"001.002.004"},"conversations":{"description":"Conversation channels delete mode.\nConversation channel is any channel which only has two members one of which is the user being deleted.\n\n* null or empty string - doesn't delete any conversation channels\n* soft - marks all conversation channels as deleted (same effect as Delete Channels with 'hard' option disabled)\n* hard - deletes channel and all its data completely including messages (same effect as Delete Channels with 'hard' option enabled)\n","enum":["soft","hard"],"title":"Delete Conversations","type":"string","x-stream-index":"001.002.003"},"files":{"description":"Delete user files.\n* false or empty string - doesn't delete any files\n* true - deletes all files uploaded by the user, including images and attachments.\n","title":"Delete User's files","type":"boolean","x-stream-index":"001.002.005"},"messages":{"description":"Message delete mode.\n\n* null or empty string - doesn't delete user messages\n* soft - marks all user messages as deleted without removing any related message data\n* pruning - marks all user messages as deleted, nullifies message information and removes some message data such as reactions and flags\n* hard - deletes messages completely with all related information\n","enum":["soft","pruning","hard"],"title":"Delete Messages","type":"string","x-stream-index":"001.002.002"},"new_call_owner_id":{"type":"string","x-stream-index":"001.002.007"},"new_channel_owner_id":{"type":"string","x-stream-index":"001.002.006"},"user":{"description":"User delete mode.\n\n* soft - marks user as deleted and retains all user data\n* pruning - marks user as deleted and nullifies user information\n* hard - deletes user completely. Requires 'hard' option for messages and conversations as well\n","enum":["soft","pruning","hard"],"title":"Delete User","type":"string","x-stream-index":"001.002.001"},"user_ids":{"description":"IDs of users to delete","items":{"type":"string"},"maximum":100,"minimum":1,"title":"User IDs","type":"array","x-stream-index":"001.001"}},"required":["user_ids"],"type":"object"},"DeleteUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"task_id":{"description":"ID of the task to delete users","title":"Task ID","type":"string","x-stream-index":"001"}},"required":["task_id","duration"],"type":"object"},"Device":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"disabled":{"type":"boolean","x-stream-index":"002.003"},"disabled_reason":{"type":"string","x-stream-index":"002.004"},"id":{"type":"string","x-stream-index":"002.001.004"},"push_provider":{"enum":["firebase","apn","huawei","xiaomi"],"type":"string","x-stream-index":"002.001.001"},"push_provider_name":{"type":"string","x-stream-index":"002.001.003"},"user_id":{"type":"string","x-stream-index":"004"},"voip":{"type":"boolean","x-stream-index":"002.001.005"}},"required":["push_provider","id","created_at","user_id"],"type":"object"},"DeviceErrorInfo":{"properties":{"error_message":{"type":"string","x-stream-index":"003"},"provider":{"type":"string","x-stream-index":"001"},"provider_name":{"type":"string","x-stream-index":"002"}},"required":["provider","provider_name","error_message"],"type":"object"},"DeviceResponse":{"description":"Response for Device","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"004"},"disabled":{"description":"Whether device is disabled or not","title":"Disabled","type":"boolean","x-stream-index":"005"},"disabled_reason":{"description":"Reason explaining why device had been disabled","title":"Reason","type":"string","x-stream-index":"006"},"id":{"description":"Device ID","title":"ID","type":"string","x-stream-index":"003"},"push_provider":{"description":"Push provider","title":"PushProvider","type":"string","x-stream-index":"001"},"push_provider_name":{"description":"Push provider name","title":"PushProviderName","type":"string","x-stream-index":"002"},"user_id":{"description":"User ID","title":"UserID","type":"string","x-stream-index":"008"},"voip":{"description":"When true the token is for Apple VoIP push notifications","title":"Voip","type":"boolean","x-stream-index":"007"}},"required":["push_provider","id","created_at","user_id"],"title":"DeviceResponse","type":"object"},"DraftPayloadResponse":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"html":{"type":"string","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"001"},"mentioned_users":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"008"},"mml":{"type":"string","x-stream-index":"003"},"parent_id":{"type":"string","x-stream-index":"005"},"poll_id":{"type":"string","x-stream-index":"013"},"quoted_message_id":{"type":"string","x-stream-index":"009"},"show_in_channel":{"type":"boolean","x-stream-index":"006"},"silent":{"type":"boolean","x-stream-index":"012"},"text":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"011"}},"required":["id","text","custom"],"type":"object"},"DraftResponse":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003"},"channel_cid":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"message":{"$ref":"#/components/schemas/DraftPayloadResponse","x-stream-index":"001"},"parent_id":{"type":"string","x-stream-index":"004"},"parent_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"005"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"006"}},"required":["message","channel_cid","created_at"],"type":"object"},"EgressHLSResponse":{"properties":{"playlist_url":{"type":"string","x-stream-index":"001"},"status":{"type":"string","x-stream-index":"002"}},"required":["playlist_url","status"],"type":"object"},"EgressRTMPResponse":{"properties":{"name":{"type":"string","x-stream-index":"001"},"started_at":{"format":"date-time","type":"number","x-stream-index":"004"},"stream_key":{"type":"string","x-stream-index":"003"},"stream_url":{"type":"string","x-stream-index":"002"}},"required":["name","started_at"],"type":"object"},"EgressResponse":{"properties":{"broadcasting":{"type":"boolean","x-stream-index":"001"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordingResponse","x-stream-index":"004"},"hls":{"$ref":"#/components/schemas/EgressHLSResponse","x-stream-index":"002"},"rtmps":{"items":{"$ref":"#/components/schemas/EgressRTMPResponse"},"type":"array","x-stream-index":"003"}},"required":["broadcasting","rtmps"],"type":"object"},"EgressTaskConfig":{"properties":{"egress_user":{"$ref":"#/components/schemas/EgressUser","x-stream-index":"008"},"frame_recording_egress_config":{"$ref":"#/components/schemas/FrameRecordingEgressConfig","x-stream-index":"009"},"hls_egress_config":{"$ref":"#/components/schemas/HLSEgressConfig","x-stream-index":"007"},"recording_egress_config":{"$ref":"#/components/schemas/RecordingEgressConfig","x-stream-index":"006"},"rtmp_egress_config":{"$ref":"#/components/schemas/RTMPEgressConfig","x-stream-index":"004"},"stt_egress_config":{"$ref":"#/components/schemas/STTEgressConfig","x-stream-index":"005"}},"type":"object"},"EgressUser":{"properties":{"token":{"type":"string","x-stream-index":"004"}},"type":"object"},"EnrichedActivity":{"properties":{"actor":{"$ref":"#/components/schemas/Data","x-stream-index":"002"},"foreign_id":{"type":"string","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"latest_reactions":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"013"},"object":{"$ref":"#/components/schemas/Data","x-stream-index":"004"},"origin":{"$ref":"#/components/schemas/Data","x-stream-index":"008"},"own_reactions":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"012"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"011"},"score":{"format":"float","type":"number","x-stream-index":"010"},"target":{"$ref":"#/components/schemas/Data","x-stream-index":"006"},"to":{"items":{"type":"string"},"type":"array","x-stream-index":"009"},"verb":{"type":"string","x-stream-index":"003"}},"type":"object"},"EnrichedReaction":{"nullable":true,"properties":{"activity_id":{"type":"string","x-stream-index":"003"},"children_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"010"},"created_at":{"$ref":"#/components/schemas/Time","x-stream-index":"012"},"data":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"kind":{"type":"string","x-stream-index":"002"},"latest_children":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"008"},"own_children":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"009"},"parent":{"type":"string","x-stream-index":"007"},"target_feeds":{"items":{"type":"string"},"type":"array","x-stream-index":"006"},"updated_at":{"$ref":"#/components/schemas/Time","x-stream-index":"013"},"user":{"$ref":"#/components/schemas/Data","x-stream-index":"011"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["kind","activity_id","user_id"],"type":"object"},"EntityCreator":{"properties":{"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"001.046"},"ban_count":{"format":"int32","type":"integer","x-stream-index":"002"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"001.017"},"banned":{"type":"boolean","x-stream-index":"001.016"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.013"},"deleted_content_count":{"format":"int32","type":"integer","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"001.023"},"language":{"type":"string","x-stream-index":"001.035"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"001.022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"001.026"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.042"},"role":{"type":"string","x-stream-index":"001.004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.005"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.009"}},"required":["id","role","teams_role","custom","banned","online","ban_count","deleted_content_count"],"type":"object"},"EntityCreatorResponse":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.001.018"},"ban_count":{"description":"Number of minor actions performed on the user","format":"int32","title":"Ban Count","type":"integer","x-stream-index":"002"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"001.003"},"banned":{"type":"boolean","x-stream-index":"001.001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.001.017"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.001.016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.001.011"},"deleted_content_count":{"description":"Number of major actions performed on the user","format":"int32","title":"Deleted Content Count","type":"integer","x-stream-index":"003"},"devices":{"items":{"$ref":"#/components/schemas/DeviceResponse"},"type":"array","x-stream-index":"001.006"},"flagged_count":{"description":"Number of flag actions performed on the user","format":"int32","title":"Flagged Count","type":"integer","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001.001.001"},"image":{"type":"string","x-stream-index":"001.001.003"},"invisible":{"type":"boolean","x-stream-index":"001.007"},"language":{"type":"string","x-stream-index":"001.001.005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"001.001.014"},"name":{"type":"string","x-stream-index":"001.001.002"},"online":{"type":"boolean","x-stream-index":"001.001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"001.005"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettingsResponse","x-stream-index":"001.004"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.001.015"},"role":{"type":"string","x-stream-index":"001.001.006"},"shadow_banned":{"type":"boolean","x-stream-index":"001.002"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.001.008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids","shadow_banned","invisible","ban_count","deleted_content_count","flagged_count"],"type":"object"},"ErrorResult":{"properties":{"stacktrace":{"type":"string","x-stream-index":"003"},"type":{"type":"string","x-stream-index":"001"},"version":{"type":"string","x-stream-index":"004"}},"required":["type","description"],"type":"object"},"EventHook":{"nullable":true,"properties":{"callback":{"$ref":"#/components/schemas/AsyncModerationCallbackConfig","x-stream-index":"019.001.002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"020"},"enabled":{"type":"boolean","x-stream-index":"003"},"event_types":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"hook_type":{"type":"string","x-stream-index":"002"},"id":{"type":"string","x-stream-index":"001"},"product":{"type":"string","x-stream-index":"018"},"sns_auth_type":{"type":"string","x-stream-index":"014"},"sns_key":{"type":"string","x-stream-index":"015"},"sns_region":{"type":"string","x-stream-index":"013"},"sns_role_arn":{"type":"string","x-stream-index":"017"},"sns_secret":{"type":"string","x-stream-index":"016"},"sns_topic_arn":{"type":"string","x-stream-index":"012"},"sqs_auth_type":{"type":"string","x-stream-index":"008"},"sqs_key":{"type":"string","x-stream-index":"009"},"sqs_queue_url":{"type":"string","x-stream-index":"006"},"sqs_region":{"type":"string","x-stream-index":"007"},"sqs_role_arn":{"type":"string","x-stream-index":"011"},"sqs_secret":{"type":"string","x-stream-index":"010"},"timeout_ms":{"format":"int32","type":"integer","x-stream-index":"019.001.001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"021"},"webhook_url":{"type":"string","x-stream-index":"005"}},"type":"object"},"EventNotificationSettings":{"properties":{"apns":{"$ref":"#/components/schemas/APNS","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"fcm":{"$ref":"#/components/schemas/FCM","x-stream-index":"003"}},"required":["enabled","apns","fcm"],"type":"object"},"EventRequest":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"parent_id":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"required":["type"],"type":"object"},"EventResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"event":{"$ref":"#/components/schemas/WSEvent","x-stream-index":"001"}},"required":["event","duration"],"title":"Response","type":"object"},"ExportChannelsRequest":{"nullable":true,"properties":{"channels":{"description":"Export options for channels","items":{"$ref":"#/components/schemas/ChannelExport"},"maximum":100,"minimum":1,"title":"Channels","type":"array","x-stream-index":"002.001"},"clear_deleted_message_text":{"description":"Set if deleted message text should be cleared","title":"Clear deleted message text","type":"boolean","x-stream-index":"002.002"},"export_users":{"type":"boolean","x-stream-index":"002.005"},"include_soft_deleted_channels":{"description":"Set if you want to include deleted channels","title":"Include soft deleted channels","type":"boolean","x-stream-index":"002.004"},"include_truncated_messages":{"description":"Set if you want to include truncated messages","title":"Include truncated messages","type":"boolean","x-stream-index":"002.003"},"version":{"description":"Export version","title":"Version","type":"string","x-stream-index":"001"}},"required":["channels"],"type":"object"},"ExportChannelsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"task_id":{"description":"ID of the task to export channels","title":"Task ID","type":"string","x-stream-index":"001"}},"required":["task_id","duration"],"type":"object"},"ExportUserResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"004.001"},"messages":{"description":"List of exported messages","items":{"$ref":"#/components/schemas/MessageResponse"},"title":"Messages","type":"array","x-stream-index":"002"},"reactions":{"description":"List of exported reactions","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Reactions","type":"array","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Exported user object","title":"User","x-stream-index":"001"}},"required":["duration"],"type":"object"},"ExportUsersRequest":{"nullable":true,"properties":{"user_ids":{"items":{"type":"string"},"maximum":25,"minimum":1,"type":"array","x-stream-index":"001"}},"required":["user_ids"],"type":"object"},"ExportUsersResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"task_id":{"type":"string","x-stream-index":"001"}},"required":["task_id","duration"],"title":"Response","type":"object"},"ExternalStorage":{"properties":{"abs_account_name":{"type":"string","x-stream-index":"011"},"abs_client_id":{"type":"string","x-stream-index":"013"},"abs_client_secret":{"type":"string","x-stream-index":"014"},"abs_tenant_id":{"type":"string","x-stream-index":"012"},"bucket":{"type":"string","x-stream-index":"005"},"gcs_credentials":{"type":"string","x-stream-index":"010"},"path":{"type":"string","x-stream-index":"006"},"s3_api_key":{"type":"string","x-stream-index":"007"},"s3_custom_endpoint":{"type":"string","x-stream-index":"016"},"s3_region":{"type":"string","x-stream-index":"009"},"s3_secret_key":{"type":"string","x-stream-index":"008"},"storage_name":{"type":"string","x-stream-index":"015"},"storage_type":{"type":"integer","x-stream-index":"004"}},"type":"object"},"ExternalStorageResponse":{"properties":{"bucket":{"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"path":{"type":"string","x-stream-index":"004"},"type":{"enum":["s3","gcs","abs"],"type":"string","x-stream-index":"002"}},"required":["name","type","bucket","path"],"type":"object"},"FCM":{"properties":{"data":{"additionalProperties":{},"type":"object","x-stream-index":"001"}},"type":"object"},"FeedsEventPreferences":{"properties":{"comments":{"type":"string","x-stream-index":"002"},"mentions":{"type":"string","x-stream-index":"004"},"new_followers":{"type":"string","x-stream-index":"003"},"reactions":{"type":"string","x-stream-index":"001"}},"type":"object"},"FeedsEventPreferencesInput":{"properties":{"comments":{"enum":["all","none"],"type":"string","x-stream-index":"002"},"mentions":{"enum":["all","none"],"type":"string","x-stream-index":"004"},"new_followers":{"enum":["all","none"],"type":"string","x-stream-index":"003"},"reactions":{"enum":["all","none"],"type":"string","x-stream-index":"001"}},"type":"object"},"FeedsModerationTemplateConfig":{"properties":{"config_key":{"type":"string","x-stream-index":"002"},"data_types":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001"}},"required":["data_types","config_key"],"type":"object"},"Field":{"nullable":true,"properties":{"short":{"type":"boolean","x-stream-index":"003"},"title":{"type":"string","x-stream-index":"001"},"value":{"type":"string","x-stream-index":"002"}},"required":["title","value","short"],"type":"object"},"FileUploadConfig":{"properties":{"allowed_file_extensions":{"items":{"type":"string"},"type":"array","x-stream-index":"001"},"allowed_mime_types":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"blocked_file_extensions":{"items":{"type":"string"},"type":"array","x-stream-index":"002"},"blocked_mime_types":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"size_limit":{"format":"int32","maximum":104857600,"minimum":0,"type":"integer","x-stream-index":"005"}},"required":["size_limit"],"type":"object"},"FileUploadRequest":{"nullable":true,"properties":{"file":{"description":"file field","title":"File","type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/OnlyUserID","description":"user for the request **server side only**","title":"User","x-stream-index":"002"}},"type":"object"},"FileUploadResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"file":{"description":"URL to the uploaded asset. Should be used to put to `asset_url` attachment field","title":"File","type":"string","x-stream-index":"001"},"thumb_url":{"description":"URL of the file thumbnail for supported file formats. Should be put to `thumb_url` attachment field","title":"Thumbnail URL","type":"string","x-stream-index":"002"}},"required":["duration"],"type":"object"},"FirebaseConfig":{"properties":{"Disabled":{"type":"boolean","writeOnly":true,"x-stream-index":"001"},"apn_template":{"type":"string","x-stream-index":"005"},"credentials_json":{"type":"string","x-stream-index":"006"},"data_template":{"type":"string","x-stream-index":"004"},"notification_template":{"type":"string","x-stream-index":"003"},"server_key":{"type":"string","x-stream-index":"002"}},"type":"object"},"FirebaseConfigFields":{"properties":{"apn_template":{"type":"string","x-stream-index":"004"},"credentials_json":{"type":"string","x-stream-index":"006"},"data_template":{"type":"string","x-stream-index":"003"},"enabled":{"type":"boolean","x-stream-index":"001"},"notification_template":{"type":"string","x-stream-index":"002"},"server_key":{"type":"string","x-stream-index":"005"}},"required":["enabled"],"type":"object"},"Flag":{"description":"Contains information about flagged user or message","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"019"},"custom":{"additionalProperties":{},"description":"Additional metadata about the flag","title":"Custom","type":"object","x-stream-index":"014"},"entity_creator_id":{"description":"ID of the user who created the flagged entity","title":"Entity Creator ID","type":"string","x-stream-index":"009"},"entity_id":{"description":"Unique identifier of the entity being flagged","title":"Entity ID","type":"string","x-stream-index":"008"},"entity_type":{"description":"Type of entity being flagged (e.g., message, user)","title":"Entity Type","type":"string","x-stream-index":"007"},"is_streamed_content":{"type":"boolean","x-stream-index":"012"},"labels":{"description":"Labels from bodyguard, API calls, our own AI etc","items":{"type":"string"},"title":"Labels","type":"array","x-stream-index":"015"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content being flagged","title":"Moderation Payload","x-stream-index":"010"},"moderation_payload_hash":{"type":"string","x-stream-index":"011"},"reason":{"description":"Optional explanation for why the content is being flagged","title":"Reason","type":"string","x-stream-index":"013"},"result":{"description":"Result of bodyguard, API calls, our own AI etc","items":{"additionalProperties":{},"type":"object"},"title":"Result","type":"array","x-stream-index":"016"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"018"},"review_queue_item_id":{"description":"ID of the review queue item","title":"Review Queue Item ID","type":"string","x-stream-index":"017"},"type":{"type":"string","x-stream-index":"004"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"020"},"user":{"$ref":"#/components/schemas/User","description":"User who flagged a message or a user","title":"User","x-stream-index":"006"}},"required":["entity_type","entity_id","result","created_at","updated_at"],"title":"Flag","type":"object"},"FlagContentOptions":{"properties":{"reason":{"type":"string","x-stream-index":"001"}},"type":"object"},"FlagDetails":{"properties":{"Extra":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"002"},"automod":{"$ref":"#/components/schemas/AutomodDetails","x-stream-index":"001"},"original_text":{"type":"string","x-stream-index":"003"}},"required":["Extra","original_text"],"type":"object"},"FlagFeedback":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"005"},"labels":{"items":{"$ref":"#/components/schemas/Label"},"type":"array","x-stream-index":"006"},"message_id":{"type":"string","x-stream-index":"004"}},"required":["message_id","created_at","labels"],"type":"object"},"FlagMessageDetails":{"properties":{"pin_changed":{"type":"boolean","x-stream-index":"002"},"should_enrich":{"type":"boolean","x-stream-index":"003"},"skip_push":{"type":"boolean","x-stream-index":"004"},"updated_by_id":{"type":"string","x-stream-index":"001"}},"type":"object"},"FlagRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"description":"Additional metadata about the flag","title":"Custom","type":"object","x-stream-index":"006"},"entity_creator_id":{"description":"ID of the user who created the flagged entity","title":"Entity Creator ID","type":"string","x-stream-index":"003"},"entity_id":{"description":"Unique identifier of the entity being flagged","title":"Entity ID","type":"string","x-stream-index":"002"},"entity_type":{"description":"Type of entity being flagged (e.g., message, user)","title":"Entity Type","type":"string","x-stream-index":"001"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content being flagged","title":"Moderation Payload","x-stream-index":"005"},"reason":{"description":"Optional explanation for why the content is being flagged","maxLength":255,"title":"Reason","type":"string","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"007.002"},"user_id":{"type":"string","x-stream-index":"007.001"}},"required":["entity_type","entity_id"],"type":"object"},"FlagResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"item_id":{"description":"Unique identifier of the created moderation item","title":"Item ID","type":"string","x-stream-index":"001"}},"required":["item_id","duration"],"type":"object"},"FlagUpdatedEvent":{"nullable":true,"properties":{"CreatedBy":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"004"},"Message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"002"},"User":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"type":{"default":"flag.updated","type":"string","x-stream-index":"001.002"}},"required":["type","created_at","custom"],"title":"FlagUpdatedEvent","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"},"FlagUserOptions":{"properties":{"reason":{"type":"string","x-stream-index":"001"}},"type":"object"},"FrameRecordSettings":{"properties":{"capture_interval_in_seconds":{"format":"int32","maximum":60,"minimum":2,"type":"integer","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"},"quality":{"type":"string","x-stream-index":"002"}},"required":["mode","capture_interval_in_seconds"],"type":"object"},"FrameRecordingEgressConfig":{"properties":{"capture_interval_in_seconds":{"format":"int32","type":"integer","x-stream-index":"007"},"external_storage":{"$ref":"#/components/schemas/ExternalStorage","x-stream-index":"006"},"quality":{"$ref":"#/components/schemas/Quality","x-stream-index":"004"},"storage_name":{"type":"string","x-stream-index":"005"}},"type":"object"},"FrameRecordingResponse":{"properties":{"status":{"type":"string","x-stream-index":"001"}},"required":["status"],"type":"object"},"FrameRecordingSettingsResponse":{"properties":{"capture_interval_in_seconds":{"format":"int32","maximum":60,"minimum":2,"type":"integer","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"},"quality":{"type":"string","x-stream-index":"002"}},"required":["mode","capture_interval_in_seconds"],"type":"object"},"FullUserResponse":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"015"},"banned":{"type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"014"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.011"},"devices":{"items":{"$ref":"#/components/schemas/DeviceResponse"},"type":"array","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001.001"},"image":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"005"},"language":{"type":"string","x-stream-index":"001.005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"001.014"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"012"},"mutes":{"items":{"$ref":"#/components/schemas/UserMuteResponse"},"type":"array","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"001.002"},"online":{"type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"003"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.015"},"role":{"type":"string","x-stream-index":"001.006"},"shadow_banned":{"type":"boolean","x-stream-index":"013"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"009"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"010"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"008"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"011"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","devices","invisible","mutes","channel_mutes","unread_count","total_unread_count","unread_channels","unread_threads","shadow_banned","blocked_user_ids"],"type":"object"},"GeofenceResponse":{"nullable":true,"properties":{"country_codes":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"description":{"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"type":{"type":"string","x-stream-index":"002"}},"required":["name"],"type":"object"},"GeofenceSettings":{"properties":{"names":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"required":["names"],"type":"object"},"GeofenceSettingsResponse":{"properties":{"names":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"required":["names"],"type":"object"},"GetApplicationResponse":{"description":"Basic response information","nullable":true,"properties":{"app":{"$ref":"#/components/schemas/AppResponseFields","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["app","duration"],"title":"Response","type":"object"},"GetBlockListResponse":{"description":"Response for get block list","nullable":true,"properties":{"blocklist":{"$ref":"#/components/schemas/BlockListResponse","description":"Block list object","title":"BlockListResponse","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["duration"],"title":"GetBlockListResponse","type":"object","x-stream-docs-page-id":"get_block_list"},"GetBlockedUsersResponse":{"nullable":true,"properties":{"blocks":{"description":"Array of blocked user object","items":{"$ref":"#/components/schemas/BlockedUserResponse"},"title":"Blocks","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["blocks","duration"],"type":"object"},"GetCampaignResponse":{"description":"Basic response information","nullable":true,"properties":{"campaign":{"$ref":"#/components/schemas/CampaignResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"users":{"$ref":"#/components/schemas/PagerResponse","x-stream-index":"002"}},"required":["duration"],"title":"Response","type":"object"},"GetChannelTypeResponse":{"description":"Basic response information","nullable":true,"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"003.002.027"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"003.002.022"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.002.023"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"003.002.028"},"blocklist":{"type":"string","x-stream-index":"003.002.024"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.002.025"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"003.002.026"},"commands":{"items":{"$ref":"#/components/schemas/Command"},"type":"array","x-stream-index":"003.003"},"connect_events":{"type":"boolean","x-stream-index":"003.002.004"},"count_messages":{"type":"boolean","x-stream-index":"003.002.019"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.001.003"},"custom_events":{"type":"boolean","x-stream-index":"003.002.012"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"004.001"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"002"},"mark_messages_pending":{"type":"boolean","x-stream-index":"003.002.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"003.002.021"},"mutes":{"type":"boolean","x-stream-index":"003.002.009"},"name":{"type":"string","x-stream-index":"003.002.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"003.002.029"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"003.002.030"},"permissions":{"items":{"$ref":"#/components/schemas/PolicyRequest"},"type":"array","x-stream-index":"001"},"polls":{"type":"boolean","x-stream-index":"003.002.016"},"push_notifications":{"type":"boolean","x-stream-index":"003.002.013"},"quotes":{"type":"boolean","x-stream-index":"003.002.008"},"reactions":{"type":"boolean","x-stream-index":"003.002.006"},"read_events":{"type":"boolean","x-stream-index":"003.002.003"},"reminders":{"type":"boolean","x-stream-index":"003.002.014"},"replies":{"type":"boolean","x-stream-index":"003.002.007"},"search":{"type":"boolean","x-stream-index":"003.002.005"},"shared_locations":{"type":"boolean","x-stream-index":"003.002.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"003.002.031"},"typing_events":{"type":"boolean","x-stream-index":"003.002.002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"003.001.004"},"uploads":{"type":"boolean","x-stream-index":"003.002.010"},"url_enrichment":{"type":"boolean","x-stream-index":"003.002.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"003.002.017"}},"required":["permissions","grants","created_at","updated_at","name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","count_messages","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","commands","duration"],"title":"Response","type":"object"},"GetCommandResponse":{"nullable":true,"properties":{"args":{"type":"string","x-stream-index":"001.006"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.001"},"description":{"type":"string","x-stream-index":"001.005"},"duration":{"type":"string","x-stream-index":"002.001"},"name":{"type":"string","x-stream-index":"001.004"},"set":{"type":"string","x-stream-index":"001.007"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.002"}},"required":["name","description","args","set","duration"],"title":"GetCommandResponse","type":"object"},"GetConfigResponse":{"nullable":true,"properties":{"config":{"$ref":"#/components/schemas/ConfigResponse","description":"The retrieved moderation configuration","title":"Config","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["duration"],"type":"object"},"GetCustomPermissionResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"permission":{"$ref":"#/components/schemas/Permission","x-stream-index":"001"}},"required":["permission","duration"],"title":"Response","type":"object"},"GetDraftResponse":{"description":"Basic response information","nullable":true,"properties":{"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["draft","duration"],"title":"Response","type":"object"},"GetImportResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"import_task":{"$ref":"#/components/schemas/ImportTask","x-stream-index":"001"}},"required":["duration"],"title":"Response","type":"object"},"GetManyMessagesResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.002.001"},"messages":{"description":"List of messages","items":{"$ref":"#/components/schemas/MessageResponse"},"title":"Messages","type":"array","x-stream-index":"001.001"}},"required":["messages","duration"],"type":"object"},"GetMessageResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageWithChannelResponse","x-stream-index":"001"},"pending_message_metadata":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"002"}},"required":["message","duration"],"title":"Response","type":"object"},"GetModerationRuleResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"rule":{"$ref":"#/components/schemas/ModerationRuleV2Response","x-stream-index":"002"}},"required":["duration"],"title":"Response","type":"object"},"GetOGResponse":{"nullable":true,"properties":{"actions":{"items":{"$ref":"#/components/schemas/Action"},"type":"array","x-stream-index":"001.015"},"asset_url":{"description":"URL of detected video or audio","title":"Image URL","type":"string","x-stream-index":"001.017"},"author_icon":{"type":"string","x-stream-index":"001.007"},"author_link":{"description":"og:site","title":"Author Link","type":"string","x-stream-index":"001.006"},"author_name":{"description":"og:site_name","title":"Author Name","type":"string","x-stream-index":"001.005"},"color":{"type":"string","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.018"},"duration":{"type":"string","x-stream-index":"002.001"},"fallback":{"type":"string","x-stream-index":"001.002"},"fields":{"items":{"$ref":"#/components/schemas/Field"},"type":"array","x-stream-index":"001.016"},"footer":{"type":"string","x-stream-index":"001.013"},"footer_icon":{"type":"string","x-stream-index":"001.014"},"giphy":{"$ref":"#/components/schemas/Images","x-stream-index":"001.019"},"image_url":{"description":"URL of detected image","title":"Image URL","type":"string","x-stream-index":"001.011"},"og_scrape_url":{"description":"extracted url from the text","title":"OG Scrape URL","type":"string","x-stream-index":"001.020"},"original_height":{"format":"int32","type":"integer","x-stream-index":"001.022"},"original_width":{"format":"int32","type":"integer","x-stream-index":"001.021"},"pretext":{"type":"string","x-stream-index":"001.004"},"text":{"description":"og:description","title":"Text","type":"string","x-stream-index":"001.010"},"thumb_url":{"description":"URL of detected thumb image","title":"Image URL","type":"string","x-stream-index":"001.012"},"title":{"description":"og:title","title":"Title","type":"string","x-stream-index":"001.008"},"title_link":{"description":"og:url","title":"Title Link","type":"string","x-stream-index":"001.009"},"type":{"description":"Attachment type, could be empty, image, audio or video","title":"Type","type":"string","x-stream-index":"001.001"}},"required":["custom","duration"],"title":"Get OG Attachment","type":"object","x-stream-docs-page-id":"og"},"GetPushTemplatesResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"templates":{"items":{"$ref":"#/components/schemas/PushTemplate"},"type":"array","x-stream-index":"002"}},"required":["duration","templates"],"title":"Response","type":"object"},"GetRateLimitsResponse":{"nullable":true,"properties":{"android":{"additionalProperties":{"$ref":"#/components/schemas/LimitInfo"},"description":"Map of endpoint rate limits for the Android platform","title":"Android","type":"object","x-stream-index":"002","x-stream-map":{"key":"endpoint","title":"Endpoint name","description":"The name of the endpoint for which the limits apply"}},"duration":{"type":"string","x-stream-index":"005.001"},"ios":{"additionalProperties":{"$ref":"#/components/schemas/LimitInfo"},"description":"Map of endpoint rate limits for the iOS platform","title":"iOS","type":"object","x-stream-index":"003","x-stream-map":{"key":"endpoint","title":"Endpoint name","description":"The name of the endpoint for which the limits apply"}},"server_side":{"additionalProperties":{"$ref":"#/components/schemas/LimitInfo"},"description":"Map of endpoint rate limits for the server-side platform","title":"Server-side","type":"object","x-stream-index":"001","x-stream-map":{"key":"endpoint","title":"Endpoint name","description":"The name of the endpoint for which the limits apply"}},"web":{"additionalProperties":{"$ref":"#/components/schemas/LimitInfo"},"description":"Map of endpoint rate limits for the web platform","title":"Web","type":"object","x-stream-index":"004","x-stream-map":{"key":"endpoint","title":"Endpoint name","description":"The name of the endpoint for which the limits apply"}}},"required":["duration"],"title":"Get Rate Limits Response","type":"object","x-stream-docs-page-id":"rate_limits"},"GetReactionsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"reactions":{"description":"List of reactions","items":{"$ref":"#/components/schemas/Reaction"},"title":"Reactions","type":"array","x-stream-index":"001"}},"required":["reactions","duration"],"type":"object"},"GetRepliesResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"messages":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","x-stream-index":"001"}},"required":["messages","duration"],"title":"Response","type":"object"},"GetReviewQueueItemResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"Current state of the review queue item","title":"Item","x-stream-index":"001"}},"required":["duration"],"type":"object"},"GetSegmentResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"segment":{"$ref":"#/components/schemas/SegmentResponse","description":"Segment","title":"SegmentResponse","x-stream-index":"001"}},"required":["duration"],"type":"object"},"GetTaskResponse":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.003"},"duration":{"type":"string","x-stream-index":"004.001"},"error":{"$ref":"#/components/schemas/ErrorResult","description":"Error produced by task","title":"Error","x-stream-index":"003"},"result":{"additionalProperties":{},"description":"Result produced by task after completion","title":"Result","type":"object","x-stream-index":"002"},"status":{"description":"Current status of task","title":"Status","type":"string","x-stream-index":"001.002"},"task_id":{"description":"ID of task","title":"Task ID","type":"string","x-stream-index":"001.001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.004"}},"required":["task_id","status","created_at","updated_at","duration"],"title":"Get Task Response","type":"object","x-stream-docs-page-id":"tasks"},"GetThreadResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"thread":{"$ref":"#/components/schemas/ThreadStateResponse","description":"Enriched thread state","title":"Thread","x-stream-index":"001"}},"required":["thread","duration"],"type":"object"},"GoogleVisionConfig":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"HLSEgressConfig":{"properties":{"composite_app_settings":{"$ref":"#/components/schemas/CompositeAppSettings","x-stream-index":"005"},"playlist_url":{"type":"string","x-stream-index":"007"},"qualities":{"items":{"$ref":"#/components/schemas/Quality"},"type":"array","x-stream-index":"004"},"start_unix_nano":{"format":"int64","type":"integer","x-stream-index":"006"}},"type":"object"},"HLSSettings":{"properties":{"auto_on":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"004"},"quality_tracks":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"required":["auto_on","enabled","quality_tracks"],"type":"object"},"HLSSettingsResponse":{"description":"HLSSettings is the payload for HLS settings","properties":{"auto_on":{"title":"Auto On","type":"boolean","x-stream-index":"001"},"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"002"},"layout":{"$ref":"#/components/schemas/LayoutSettingsResponse","title":"Layout","x-stream-index":"004"},"quality_tracks":{"items":{"type":"string"},"title":"Quality Tracks","type":"array","x-stream-index":"003"}},"required":["auto_on","enabled","quality_tracks","layout"],"title":"HLSSettingsResponse","type":"object"},"HarmConfig":{"properties":{"action_sequences":{"items":{"$ref":"#/components/schemas/ActionSequence"},"type":"array","x-stream-index":"001"},"severity":{"type":"integer","x-stream-index":"002"}},"required":["action_sequences","severity"],"type":"object"},"HideChannelRequest":{"nullable":true,"properties":{"clear_history":{"description":"Whether to clear message history of the channel or not","title":"Clear history","type":"boolean","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"type":"object"},"HideChannelResponse":{"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"},"HuaweiConfig":{"properties":{"Disabled":{"type":"boolean","writeOnly":true,"x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"secret":{"type":"string","x-stream-index":"002"}},"type":"object"},"HuaweiConfigFields":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"id":{"type":"string","x-stream-index":"002"},"secret":{"type":"string","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"ImageContentParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"type":"object"},"ImageData":{"properties":{"frames":{"type":"string","x-stream-index":"005"},"height":{"type":"string","x-stream-index":"003"},"size":{"type":"string","x-stream-index":"004"},"url":{"type":"string","x-stream-index":"001"},"width":{"type":"string","x-stream-index":"002"}},"required":["url","width","height","size","frames"],"type":"object"},"ImageRuleParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"type":"object"},"ImageSize":{"properties":{"crop":{"description":"Crop mode","enum":["top","bottom","left","right","center"],"title":"Crop","type":"string","x-stream-index":"001"},"height":{"description":"Target image height","format":"int32","title":"Height","type":"integer","x-stream-index":"003"},"resize":{"description":"Resize method","enum":["clip","crop","scale","fill"],"title":"Resize","type":"string","x-stream-index":"002"},"width":{"description":"Target image width","format":"int32","title":"Width","type":"integer","x-stream-index":"004"}},"title":"Image size configuration","type":"object"},"ImageUploadRequest":{"nullable":true,"properties":{"file":{"type":"string","x-stream-index":"001.001"},"upload_sizes":{"description":"field with JSON-encoded array of image size configurations","items":{"$ref":"#/components/schemas/ImageSize"},"title":"Upload sizes","type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/OnlyUserID","x-stream-index":"001.002"}},"type":"object"},"ImageUploadResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.003.001"},"file":{"type":"string","x-stream-index":"001.001"},"thumb_url":{"type":"string","x-stream-index":"001.002"},"upload_sizes":{"description":"Array of image size configurations","items":{"$ref":"#/components/schemas/ImageSize"},"title":"Upload sizes","type":"array","x-stream-index":"002"}},"required":["duration"],"type":"object"},"Images":{"properties":{"fixed_height":{"$ref":"#/components/schemas/ImageData","x-stream-index":"002"},"fixed_height_downsampled":{"$ref":"#/components/schemas/ImageData","x-stream-index":"004"},"fixed_height_still":{"$ref":"#/components/schemas/ImageData","x-stream-index":"003"},"fixed_width":{"$ref":"#/components/schemas/ImageData","x-stream-index":"005"},"fixed_width_downsampled":{"$ref":"#/components/schemas/ImageData","x-stream-index":"007"},"fixed_width_still":{"$ref":"#/components/schemas/ImageData","x-stream-index":"006"},"original":{"$ref":"#/components/schemas/ImageData","x-stream-index":"001"}},"required":["original","fixed_height","fixed_height_still","fixed_height_downsampled","fixed_width","fixed_width_still","fixed_width_downsampled"],"type":"object"},"ImportTask":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"011"},"history":{"items":{"$ref":"#/components/schemas/ImportTaskHistory"},"type":"array","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"003"},"mode":{"type":"string","x-stream-index":"006"},"path":{"type":"string","x-stream-index":"005"},"size":{"format":"int64","type":"integer","x-stream-index":"007"},"state":{"type":"string","x-stream-index":"008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"012"}},"required":["id","path","mode","state","history","created_at","updated_at"],"type":"object"},"ImportTaskHistory":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"next_state":{"type":"string","x-stream-index":"006"},"prev_state":{"type":"string","x-stream-index":"005"}},"required":["prev_state","next_state","created_at"],"type":"object"},"IngressAudioEncodingOptions":{"properties":{"bitrate":{"maximum":128000,"minimum":16000,"type":"integer","x-stream-index":"003"},"channels":{"enum":["1","2"],"format":"int32","type":"integer","x-stream-index":"001"},"enable_dtx":{"type":"boolean","x-stream-index":"002"}},"required":["channels","enable_dtx","bitrate"],"type":"object"},"IngressAudioEncodingResponse":{"properties":{"bitrate":{"format":"int32","type":"integer","x-stream-index":"003"},"channels":{"format":"int32","type":"integer","x-stream-index":"001"},"enable_dtx":{"type":"boolean","x-stream-index":"002"}},"required":["channels","enable_dtx","bitrate"],"type":"object"},"IngressSettings":{"properties":{"audio_encoding_options":{"$ref":"#/components/schemas/IngressAudioEncodingOptions","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"video_encoding_options":{"additionalProperties":{"$ref":"#/components/schemas/IngressVideoEncodingOptions"},"type":"object","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"IngressSettingsResponse":{"properties":{"audio_encoding_options":{"$ref":"#/components/schemas/IngressAudioEncodingResponse","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"video_encoding_options":{"additionalProperties":{"$ref":"#/components/schemas/IngressVideoEncodingResponse"},"type":"object","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"IngressVideoEncodingOptions":{"properties":{"layers":{"items":{"$ref":"#/components/schemas/IngressVideoLayer"},"minimum":1,"type":"array","x-stream-index":"001"}},"required":["layers"],"type":"object"},"IngressVideoEncodingResponse":{"properties":{"layers":{"items":{"$ref":"#/components/schemas/IngressVideoLayerResponse"},"type":"array","x-stream-index":"001"}},"required":["layers"],"type":"object"},"IngressVideoLayer":{"nullable":true,"properties":{"bitrate":{"minimum":1000,"type":"integer","x-stream-index":"002"},"codec":{"enum":["h264","vp8"],"type":"string","x-stream-index":"001"},"frame_rate":{"maximum":60,"minimum":1,"type":"integer","x-stream-index":"003"},"max_dimension":{"minimum":240,"type":"integer","x-stream-index":"005"},"min_dimension":{"minimum":240,"type":"integer","x-stream-index":"004"}},"required":["codec","bitrate","frame_rate","min_dimension","max_dimension"],"type":"object"},"IngressVideoLayerResponse":{"nullable":true,"properties":{"bitrate":{"type":"integer","x-stream-index":"002"},"codec":{"type":"string","x-stream-index":"001"},"frame_rate_limit":{"type":"integer","x-stream-index":"005"},"max_dimension":{"type":"integer","x-stream-index":"004"},"min_dimension":{"type":"integer","x-stream-index":"003"}},"required":["codec","bitrate","min_dimension","max_dimension","frame_rate_limit"],"type":"object"},"LLMConfig":{"properties":{"app_context":{"type":"string","x-stream-index":"005"},"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/LLMRule"},"type":"array","x-stream-index":"003"},"severity_descriptions":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"004"}},"required":["enabled","rules"],"type":"object"},"LLMRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove","keep"],"type":"string","x-stream-index":"003"},"description":{"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"},"severity_rules":{"items":{"$ref":"#/components/schemas/BodyguardSeverityRule"},"type":"array","x-stream-index":"004"}},"required":["label","description","action","severity_rules"],"type":"object"},"Label":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"phrase_list_ids":{"items":{"format":"int32","type":"integer"},"type":"array","x-stream-index":"002"}},"required":["name"],"type":"object"},"LabelThresholds":{"properties":{"block":{"description":"Threshold for automatic message block","format":"float","maximum":1,"minimum":0,"title":"Block","type":"number","x-stream-index":"002"},"flag":{"description":"Threshold for automatic message flag","format":"float","maximum":1,"minimum":0,"title":"Flag","type":"number","x-stream-index":"001"}},"type":"object"},"LayoutSettings":{"properties":{"detect_orientation":{"type":"boolean","x-stream-index":"005"},"external_app_url":{"type":"string","x-stream-index":"003"},"external_css_url":{"type":"string","x-stream-index":"004"},"name":{"enum":["spotlight","grid","single-participant","mobile","custom"],"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"required":["name","external_app_url","external_css_url"],"type":"object"},"LayoutSettingsResponse":{"properties":{"detect_orientation":{"type":"boolean","x-stream-index":"005"},"external_app_url":{"type":"string","x-stream-index":"003"},"external_css_url":{"type":"string","x-stream-index":"004"},"name":{"enum":["spotlight","grid","single-participant","mobile","custom"],"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"required":["name","external_app_url","external_css_url"],"type":"object"},"LimitInfo":{"properties":{"limit":{"description":"The maximum number of calls allowed for the time window","format":"int32","title":"Limit","type":"integer","x-stream-index":"001"},"remaining":{"description":"The number of remaining calls in the current window","format":"int64","title":"Remaining","type":"integer","x-stream-index":"002"},"reset":{"description":"The Unix timestamp of the next window","format":"int64","title":"Reset","type":"integer","x-stream-index":"003"}},"required":["limit","remaining","reset"],"title":"Rate Limit info","type":"object","x-stream-docs-page-id":"rate_limits"},"LimitsSettings":{"properties":{"max_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"004"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"},"max_participants_exclude_owner":{"type":"boolean","x-stream-index":"003"},"max_participants_exclude_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"002"}},"required":["max_participants_exclude_roles"],"type":"object"},"LimitsSettingsResponse":{"properties":{"max_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"004"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"},"max_participants_exclude_owner":{"type":"boolean","x-stream-index":"003"},"max_participants_exclude_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"002"}},"required":["max_participants_exclude_roles"],"type":"object"},"ListBlockListResponse":{"description":"Basic response information","nullable":true,"properties":{"blocklists":{"items":{"$ref":"#/components/schemas/BlockListResponse"},"type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["blocklists","duration"],"title":"Response","type":"object"},"ListChannelTypesResponse":{"nullable":true,"properties":{"channel_types":{"additionalProperties":{"$ref":"#/components/schemas/ChannelTypeConfig"},"description":"Object with all channel types","title":"Channel types","type":"object","x-stream-index":"001","x-stream-map":{"key":"channel_type","title":"Channel type","description":"Channel type config object"}},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["channel_types","duration"],"title":"ListChannelTypesResponse","type":"object"},"ListCommandsResponse":{"nullable":true,"properties":{"commands":{"description":"List of commands","items":{"$ref":"#/components/schemas/Command"},"title":"Commands","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["commands","duration"],"title":"ListCommandsResponse","type":"object"},"ListDevicesResponse":{"description":"List devices response","nullable":true,"properties":{"devices":{"description":"List of devices","items":{"$ref":"#/components/schemas/DeviceResponse"},"title":"Devices","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["devices","duration"],"title":"ListDevicesResponse","type":"object"},"ListExternalStorageResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"external_storages":{"additionalProperties":{"$ref":"#/components/schemas/ExternalStorageResponse"},"type":"object","x-stream-index":"002"}},"required":["duration","external_storages"],"title":"Response","type":"object"},"ListImportsResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"import_tasks":{"items":{"$ref":"#/components/schemas/ImportTask"},"type":"array","x-stream-index":"001"}},"required":["import_tasks","duration"],"title":"Response","type":"object"},"ListPermissionsResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"permissions":{"items":{"$ref":"#/components/schemas/Permission"},"type":"array","x-stream-index":"001"}},"required":["permissions","duration"],"title":"Response","type":"object"},"ListPushProvidersResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"push_providers":{"items":{"$ref":"#/components/schemas/PushProviderResponse"},"type":"array","x-stream-index":"001"}},"required":["push_providers","duration"],"title":"Response","type":"object"},"ListRolesResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"roles":{"items":{"$ref":"#/components/schemas/Role"},"type":"array","x-stream-index":"001"}},"required":["roles","duration"],"title":"Response","type":"object"},"MarkChannelsReadRequest":{"nullable":true,"properties":{"read_by_channel":{"additionalProperties":{"type":"string"},"description":"Map of channel ID to last read message ID","maximum":30,"title":"Read by channel","type":"object","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"002.002"},"user_id":{"type":"string","x-stream-index":"002.001"}},"type":"object"},"MarkReadRequest":{"nullable":true,"properties":{"message_id":{"description":"ID of the message that is considered last read by client","title":"Message ID","type":"string","x-stream-index":"001"},"thread_id":{"description":"Optional Thread ID to specifically mark a given thread as read","title":"Thread ID","type":"string","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"type":"object"},"MarkReadResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"event":{"$ref":"#/components/schemas/MessageReadEvent","description":"Mark read event","title":"Event","x-stream-index":"001"}},"required":["duration"],"type":"object"},"MarkReviewedRequest":{"properties":{"content_to_mark_as_reviewed_limit":{"format":"int32","maximum":2500,"type":"integer","x-stream-index":"002"},"disable_marking_content_as_reviewed":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"MarkUnreadRequest":{"nullable":true,"properties":{"message_id":{"description":"ID of the message from where the channel is marked unread","title":"Message ID","type":"string","x-stream-index":"001"},"thread_id":{"description":"Mark a thread unread, specify both the thread and message id","title":"Thread ID","type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"type":"object"},"MemberAddedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"002.001"},"type":{"default":"member.added","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MemberAddedEvent","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"},"MemberLookup":{"properties":{"Limit":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"001"}},"required":["Limit"],"type":"object"},"MemberRemovedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"001.001"},"type":{"default":"member.removed","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MemberRemovedEvent","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"},"MemberUpdatedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"005.002"},"channel_type":{"type":"string","x-stream-index":"005.003"},"cid":{"type":"string","x-stream-index":"005.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"002.001"},"type":{"default":"member.updated","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MemberUpdatedEvent","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"},"MembersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"members":{"description":"List of found members","items":{"$ref":"#/components/schemas/ChannelMember"},"title":"Members","type":"array","x-stream-index":"001"}},"required":["members","duration"],"type":"object"},"Message":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"012"},"before_message_send_failed":{"type":"boolean","x-stream-index":"046"},"cid":{"type":"string","x-stream-index":"028"},"command":{"type":"string","x-stream-index":"006"},"created_at":{"format":"date-time","type":"number","x-stream-index":"030"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"034"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"033"},"deleted_for_me":{"type":"boolean","x-stream-index":"059"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"023"},"html":{"type":"string","x-stream-index":"007"},"i18n":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"044"},"id":{"type":"string","x-stream-index":"002"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"040"},"latest_reactions":{"items":{"$ref":"#/components/schemas/Reaction"},"type":"array","x-stream-index":"013"},"mentioned_users":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"043"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"052"},"mml":{"type":"string","x-stream-index":"005"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"056"},"own_reactions":{"items":{"$ref":"#/components/schemas/Reaction"},"type":"array","x-stream-index":"014"},"parent_id":{"type":"string","x-stream-index":"019"},"pin_expires":{"format":"date-time","type":"number","x-stream-index":"051"},"pinned":{"type":"boolean","x-stream-index":"047"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"048"},"pinned_by":{"$ref":"#/components/schemas/User","x-stream-index":"050"},"poll":{"$ref":"#/components/schemas/Poll","x-stream-index":"054"},"poll_id":{"type":"string","x-stream-index":"053"},"quoted_message":{"$ref":"#/components/schemas/Message","x-stream-index":"025"},"quoted_message_id":{"type":"string","x-stream-index":"024"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"015"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"017"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"016"},"reminder":{"$ref":"#/components/schemas/MessageReminder","x-stream-index":"058"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"022"},"restricted_visibility":{"items":{"type":"string"},"type":"array","x-stream-index":"011"},"shadowed":{"type":"boolean","x-stream-index":"036"},"shared_location":{"$ref":"#/components/schemas/SharedLocation","x-stream-index":"055"},"show_in_channel":{"type":"boolean","x-stream-index":"021"},"silent":{"type":"boolean","x-stream-index":"045"},"text":{"type":"string","x-stream-index":"004"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"027"},"type":{"type":"string","x-stream-index":"008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"031"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"010"}},"required":["id","text","html","type","restricted_visibility","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reaction_groups","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned"],"type":"object"},"MessageActionRequest":{"nullable":true,"properties":{"form_data":{"additionalProperties":{"type":"string"},"description":"ReadOnlyData to execute command with","title":"Form data","type":"object","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"required":["form_data"],"type":"object"},"MessageChangeSet":{"properties":{"attachments":{"type":"boolean","x-stream-index":"005"},"custom":{"type":"boolean","x-stream-index":"001"},"html":{"type":"boolean","x-stream-index":"004"},"mentioned_user_ids":{"type":"boolean","x-stream-index":"006"},"mml":{"type":"boolean","x-stream-index":"003"},"pin":{"type":"boolean","x-stream-index":"009"},"quoted_message_id":{"type":"boolean","x-stream-index":"007"},"silent":{"type":"boolean","x-stream-index":"008"},"text":{"type":"boolean","x-stream-index":"002"}},"required":["custom","text","mml","html","attachments","mentioned_user_ids","quoted_message_id","silent","pin"],"type":"object"},"MessageDeletedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"007.002"},"deleted_for_me":{"type":"boolean","x-stream-index":"003"},"hard_delete":{"type":"boolean","x-stream-index":"002.001"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"006.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"message.deleted","type":"string","x-stream-index":"007.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005.001"}},"required":["hard_delete","cid","channel_id","channel_type","type","created_at"],"title":"MessageDeletedEvent","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":{"approved_at":{"format":"date-time","type":"number","x-stream-index":"013"},"created_at":{"format":"date-time","type":"number","x-stream-index":"009"},"created_by_automod":{"type":"boolean","x-stream-index":"001"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"008"},"details":{"$ref":"#/components/schemas/FlagDetails","x-stream-index":"006"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"005"},"moderation_feedback":{"$ref":"#/components/schemas/FlagFeedback","x-stream-index":"003"},"moderation_result":{"$ref":"#/components/schemas/MessageModerationResult","x-stream-index":"002"},"reason":{"type":"string","x-stream-index":"007"},"rejected_at":{"format":"date-time","type":"number","x-stream-index":"014"},"reviewed_at":{"format":"date-time","type":"number","x-stream-index":"011"},"reviewed_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"012"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"004"}},"required":["created_by_automod","created_at","updated_at"],"type":"object"},"MessageFlaggedEvent":{"properties":{"cid":{"type":"string","x-stream-index":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"005.002"},"flag":{"$ref":"#/components/schemas/Flag","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"002.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"002.002"},"type":{"default":"message.flagged","type":"string","x-stream-index":"005.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004"}},"required":["cid","type","created_at"],"title":"MessageFlaggedEvent","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"},"MessageHistoryEntryResponse":{"nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"007"},"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"006"},"is_deleted":{"type":"boolean","x-stream-index":"004"},"message_id":{"type":"string","x-stream-index":"001"},"message_updated_at":{"format":"date-time","type":"number","x-stream-index":"003"},"message_updated_by_id":{"type":"string","x-stream-index":"002"},"text":{"type":"string","x-stream-index":"005"}},"required":["message_id","message_updated_by_id","message_updated_at","is_deleted","text","attachments","Custom"],"type":"object"},"MessageModerationResult":{"description":"Result of the message moderation","properties":{"action":{"description":"Action taken by automod","title":"Action","type":"string","x-stream-index":"002"},"ai_moderation_response":{"$ref":"#/components/schemas/ModerationResponse","description":"Response from AI moderation","title":"ModerationResponse","x-stream-index":"007"},"blocked_word":{"description":"Word that was blocked","title":"Blocked word","type":"string","x-stream-index":"004"},"blocklist_name":{"description":"Name of the blocklist","title":"Blocklist name","type":"string","x-stream-index":"005"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"010"},"message_id":{"description":"ID of the message","title":"Message ID","type":"string","x-stream-index":"001"},"moderated_by":{"description":"User who moderated the message","title":"Moderated by","type":"string","x-stream-index":"003"},"moderation_thresholds":{"$ref":"#/components/schemas/Thresholds","description":"Thresholds for AI moderation","title":"Thresholds","x-stream-index":"006"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"011"},"user_bad_karma":{"description":"Whether user has bad karma","title":"User bad karma","type":"boolean","x-stream-index":"009"},"user_karma":{"description":"Karma of the user","format":"float","title":"User karma","type":"number","x-stream-index":"008"}},"required":["message_id","action","user_karma","user_bad_karma","created_at","updated_at"],"title":"Message moderation result","type":"object"},"MessageNewEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"005.002"},"channel_type":{"type":"string","x-stream-index":"005.003"},"cid":{"type":"string","x-stream-index":"005.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"006.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"notification.thread_message_new","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"},"watcher_count":{"format":"int32","type":"integer","x-stream-index":"002.001"}},"required":["watcher_count","type","created_at","cid","channel_id","channel_type"],"title":"MessageNewEvent","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"},"MessageOptions":{"properties":{"include_thread_participants":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"MessagePaginationParams":{"type":"object"},"MessageReadEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"003"},"channel_last_message_at":{"format":"date-time","type":"number","x-stream-index":"005"},"channel_type":{"type":"string","x-stream-index":"004"},"cid":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"009"},"last_read_message_id":{"type":"string","x-stream-index":"010"},"team":{"type":"string","x-stream-index":"006"},"thread":{"$ref":"#/components/schemas/ThreadResponse","x-stream-index":"008"},"type":{"default":"message.read","type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","x-stream-index":"007"}},"required":["type","cid","channel_id","channel_type","created_at"],"type":"object"},"MessageReminder":{"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"004"},"channel_cid":{"type":"string","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"011"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"006"},"message_id":{"type":"string","x-stream-index":"005"},"remind_at":{"format":"date-time","type":"number","x-stream-index":"009"},"task_id":{"type":"string","x-stream-index":"010"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"012"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"user_id":{"type":"string","x-stream-index":"007"}},"required":["channel_cid","message_id","user_id","task_id","created_at","updated_at"],"type":"object"},"MessageRequest":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"maximum":30,"type":"array","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"html":{"type":"string","x-stream-index":"010"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"mentioned_users":{"items":{"type":"string"},"maximum":100,"type":"array","x-stream-index":"008"},"mml":{"type":"string","x-stream-index":"003"},"parent_id":{"type":"string","x-stream-index":"005"},"pin_expires":{"format":"date-time","type":"number","x-stream-index":"015"},"pinned":{"type":"boolean","x-stream-index":"013"},"pinned_at":{"format":"date-time","nullable":true,"type":"string","x-stream-index":"014"},"poll_id":{"type":"string","x-stream-index":"039"},"quoted_message_id":{"type":"string","x-stream-index":"009"},"restricted_visibility":{"items":{"type":"string"},"maximum":10,"type":"array","x-stream-index":"016"},"shared_location":{"$ref":"#/components/schemas/SharedLocation","x-stream-index":"040"},"show_in_channel":{"type":"boolean","x-stream-index":"006"},"silent":{"type":"boolean","x-stream-index":"012"},"text":{"type":"string","x-stream-index":"002"},"type":{"enum":["''","regular","system"],"type":"string","x-stream-index":"011"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"021.002"},"user_id":{"type":"string","x-stream-index":"021.001"}},"type":"object"},"MessageResponse":{"description":"Represents any chat message","properties":{"attachments":{"description":"Array of message attachments","items":{"$ref":"#/components/schemas/Attachment"},"title":"Message attachments","type":"array","x-stream-docs-page-id":"message_format#attachment-format","x-stream-index":"008"},"cid":{"description":"Channel unique identifier in \u003ctype\u003e:\u003cid\u003e format","title":"Channel CID","type":"string","x-stream-index":"022"},"command":{"description":"Contains provided slash command","title":"Command","type":"string","x-stream-docs-page-id":"custom_commands_webhook","x-stream-index":"004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"023"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"026"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"025"},"deleted_for_me":{"type":"boolean","x-stream-index":"044"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"018"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"041"},"html":{"description":"Contains HTML markup of the message. Can only be set when using server-side API","title":"HTML content","type":"string","x-stream-index":"005"},"i18n":{"additionalProperties":{"type":"string"},"description":"Object with translations. Key `language` contains the original language key. Other keys contain translations","title":"Internationalization info","type":"object","x-stream-docs-page-id":"translation","x-stream-index":"030"},"id":{"description":"Message ID is unique string identifier of the message","title":"ID","type":"string","x-stream-index":"001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"Contains image moderation information","title":"Image moderation labels","type":"object","x-stream-index":"028"},"latest_reactions":{"description":"List of 10 latest reactions to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Latest reactions","type":"array","x-stream-index":"009"},"mentioned_users":{"description":"List of mentioned users","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Mentioned Users","type":"array","x-stream-index":"029"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"036"},"mml":{"description":"Should be empty if `text` is provided. Can only be set when using server-side API","title":"Messaging Markup Language","type":"string","x-stream-docs-page-id":"mml_overview","x-stream-index":"003"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"039"},"own_reactions":{"description":"List of 10 latest reactions of authenticated user to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Own reactions","type":"array","x-stream-index":"010"},"parent_id":{"description":"ID of parent message (thread)","title":"Parent message ID","type":"string","x-stream-docs-page-id":"threads","x-stream-index":"015"},"pin_expires":{"description":"Date when pinned message expires","format":"date-time","title":"Pin expiration date","type":"number","x-stream-docs-page-id":"pinned_messages","x-stream-index":"035"},"pinned":{"description":"Whether message is pinned or not","title":"Pinned","type":"boolean","x-stream-docs-page-id":"pinned_messages","x-stream-index":"032"},"pinned_at":{"description":"Date when message got pinned","format":"date-time","title":"Pinned at","type":"number","x-stream-docs-page-id":"pinned_messages","x-stream-index":"033"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","description":"Contains user who pinned the message","title":"Pinned by","x-stream-docs-page-id":"pinned_messages","x-stream-index":"034"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"038"},"poll_id":{"description":"Identifier of the poll to include in the message","title":"Poll ID","type":"string","x-stream-index":"037"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","description":"Contains quoted message","title":"Quoted message","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"020"},"quoted_message_id":{"title":"ID of quoted message","type":"string","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"019"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing number of reactions of each type. Key: reaction type (string), value: number of reactions (int)","title":"Reaction counts","type":"object","x-stream-index":"011"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"014"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing scores of reactions of each type. Key: reaction type (string), value: total score of reactions (int)","title":"Reaction scores","type":"object","x-stream-index":"012"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"042"},"reply_count":{"description":"Number of replies to this message","format":"int32","title":"Reply count","type":"integer","x-stream-index":"017"},"restricted_visibility":{"description":"A list of user ids that have restricted visibility to the message, if the list is not empty, the message is only visible to the users in the list","items":{"type":"string"},"title":"Restricted visibility","type":"array","x-stream-index":"040"},"shadowed":{"description":"Whether the message was shadowed or not","title":"Shadowed","type":"boolean","x-stream-docs-page-id":"moderation#shadow-ban","x-stream-index":"027"},"shared_location":{"$ref":"#/components/schemas/SharedLocationResponseData","description":"Contains shared location data","title":"Shared Location","x-stream-index":"043"},"show_in_channel":{"description":"Whether thread reply should be shown in the channel as well","title":"Show in channel","type":"boolean","x-stream-docs-page-id":"threads","x-stream-index":"016"},"silent":{"description":"Whether message is silent or not","title":"Silent","type":"boolean","x-stream-index":"031"},"text":{"description":"Text of the message. Should be empty if `mml` is provided","title":"Text","type":"string","x-stream-index":"002"},"thread_participants":{"description":"List of users who participate in thread","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Thread participants","type":"array","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"021"},"type":{"description":"Contains type of the message","enum":["regular","ephemeral","error","reply","system","deleted"],"title":"Message Type","type":"string","x-stream-docs-page-id":"message_format#message-types","x-stream-index":"006"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"024"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Sender of the message. Required when using server-side API","title":"User object","x-stream-index":"007"}},"required":["id","text","html","type","user","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned","restricted_visibility"],"title":"Message","type":"object","x-stream-docs-page-id":"send_message"},"MessageUnblockedEvent":{"properties":{"cid":{"type":"string","x-stream-index":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"002.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"002.002"},"type":{"default":"message.unblocked","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["cid","type","created_at"],"title":"MessageUnblockedEvent","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"},"MessageUndeletedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"005.002"},"channel_type":{"type":"string","x-stream-index":"005.003"},"cid":{"type":"string","x-stream-index":"005.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"002.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"message.undeleted","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MessageUndeletedEvent","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"},"MessageUpdate":{"properties":{"change_set":{"$ref":"#/components/schemas/MessageChangeSet","x-stream-index":"002"},"old_text":{"type":"string","x-stream-index":"001"}},"type":"object"},"MessageUpdatedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"005.002"},"channel_type":{"type":"string","x-stream-index":"005.003"},"cid":{"type":"string","x-stream-index":"005.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"002.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"message.updated","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MessageUpdatedEvent","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"},"MessageWithChannelResponse":{"description":"Represents any chat message","properties":{"attachments":{"description":"Array of message attachments","items":{"$ref":"#/components/schemas/Attachment"},"title":"Message attachments","type":"array","x-stream-docs-page-id":"message_format#attachment-format","x-stream-index":"001.008"},"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel object","title":"Channel","x-stream-index":"002"},"cid":{"description":"Channel unique identifier in \u003ctype\u003e:\u003cid\u003e format","title":"Channel CID","type":"string","x-stream-index":"001.022"},"command":{"description":"Contains provided slash command","title":"Command","type":"string","x-stream-docs-page-id":"custom_commands_webhook","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.023"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.026"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"001.025"},"deleted_for_me":{"type":"boolean","x-stream-index":"001.044"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"001.018"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001.041"},"html":{"description":"Contains HTML markup of the message. Can only be set when using server-side API","title":"HTML content","type":"string","x-stream-index":"001.005"},"i18n":{"additionalProperties":{"type":"string"},"description":"Object with translations. Key `language` contains the original language key. Other keys contain translations","title":"Internationalization info","type":"object","x-stream-docs-page-id":"translation","x-stream-index":"001.030"},"id":{"description":"Message ID is unique string identifier of the message","title":"ID","type":"string","x-stream-index":"001.001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"Contains image moderation information","title":"Image moderation labels","type":"object","x-stream-index":"001.028"},"latest_reactions":{"description":"List of 10 latest reactions to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Latest reactions","type":"array","x-stream-index":"001.009"},"mentioned_users":{"description":"List of mentioned users","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Mentioned Users","type":"array","x-stream-index":"001.029"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"001.036"},"mml":{"description":"Should be empty if `text` is provided. Can only be set when using server-side API","title":"Messaging Markup Language","type":"string","x-stream-docs-page-id":"mml_overview","x-stream-index":"001.003"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"001.039"},"own_reactions":{"description":"List of 10 latest reactions of authenticated user to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Own reactions","type":"array","x-stream-index":"001.010"},"parent_id":{"description":"ID of parent message (thread)","title":"Parent message ID","type":"string","x-stream-docs-page-id":"threads","x-stream-index":"001.015"},"pin_expires":{"description":"Date when pinned message expires","format":"date-time","title":"Pin expiration date","type":"number","x-stream-docs-page-id":"pinned_messages","x-stream-index":"001.035"},"pinned":{"description":"Whether message is pinned or not","title":"Pinned","type":"boolean","x-stream-docs-page-id":"pinned_messages","x-stream-index":"001.032"},"pinned_at":{"description":"Date when message got pinned","format":"date-time","title":"Pinned at","type":"number","x-stream-docs-page-id":"pinned_messages","x-stream-index":"001.033"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","description":"Contains user who pinned the message","title":"Pinned by","x-stream-docs-page-id":"pinned_messages","x-stream-index":"001.034"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001.038"},"poll_id":{"description":"Identifier of the poll to include in the message","title":"Poll ID","type":"string","x-stream-index":"001.037"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","description":"Contains quoted message","title":"Quoted message","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"001.020"},"quoted_message_id":{"title":"ID of quoted message","type":"string","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"001.019"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing number of reactions of each type. Key: reaction type (string), value: number of reactions (int)","title":"Reaction counts","type":"object","x-stream-index":"001.011"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"001.014"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing scores of reactions of each type. Key: reaction type (string), value: total score of reactions (int)","title":"Reaction scores","type":"object","x-stream-index":"001.012"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"001.042"},"reply_count":{"description":"Number of replies to this message","format":"int32","title":"Reply count","type":"integer","x-stream-index":"001.017"},"restricted_visibility":{"description":"A list of user ids that have restricted visibility to the message, if the list is not empty, the message is only visible to the users in the list","items":{"type":"string"},"title":"Restricted visibility","type":"array","x-stream-index":"001.040"},"shadowed":{"description":"Whether the message was shadowed or not","title":"Shadowed","type":"boolean","x-stream-docs-page-id":"moderation#shadow-ban","x-stream-index":"001.027"},"shared_location":{"$ref":"#/components/schemas/SharedLocationResponseData","description":"Contains shared location data","title":"Shared Location","x-stream-index":"001.043"},"show_in_channel":{"description":"Whether thread reply should be shown in the channel as well","title":"Show in channel","type":"boolean","x-stream-docs-page-id":"threads","x-stream-index":"001.016"},"silent":{"description":"Whether message is silent or not","title":"Silent","type":"boolean","x-stream-index":"001.031"},"text":{"description":"Text of the message. Should be empty if `mml` is provided","title":"Text","type":"string","x-stream-index":"001.002"},"thread_participants":{"description":"List of users who participate in thread","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Thread participants","type":"array","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"001.021"},"type":{"description":"Contains type of the message","enum":["regular","ephemeral","error","reply","system","deleted"],"title":"Message Type","type":"string","x-stream-docs-page-id":"message_format#message-types","x-stream-index":"001.006"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.024"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Sender of the message. Required when using server-side API","title":"User object","x-stream-index":"001.007"}},"required":["id","text","html","type","user","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned","restricted_visibility","channel"],"title":"Message","type":"object","x-stream-docs-page-id":"send_message"},"ModerationActionConfig":{"nullable":true,"properties":{"action":{"type":"string","x-stream-index":"006"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"009"},"description":{"type":"string","x-stream-index":"008"},"entity_type":{"type":"string","x-stream-index":"004"},"icon":{"type":"string","x-stream-index":"007"},"order":{"format":"int32","type":"integer","x-stream-index":"005"}},"required":["entity_type","order","action","icon","description","custom"],"type":"object"},"ModerationCheckCompletedEvent":{"description":"This event is sent when a moderation check is completed","nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"entity_id":{"description":"The ID of entity which was moderated","title":"EntityID","type":"string","x-stream-index":"002"},"entity_type":{"description":"The type of the entity which was moderated","title":"EntityType","type":"string","x-stream-index":"003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"recommended_action":{"description":"The recommended action","title":"RecommendedAction","type":"string","x-stream-index":"004"},"review_queue_item_id":{"description":"The review queue item ID","title":"ReviewQueueItemID","type":"string","x-stream-index":"005"},"type":{"default":"moderation_check.completed","type":"string","x-stream-index":"001.002"}},"required":["type","created_at","custom","entity_id","entity_type","recommended_action","review_queue_item_id"],"title":"ModerationCheckCompletedEvent","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"},"ModerationCustomActionEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"001"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"002"},"type":{"default":"moderation.custom_action","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationCustomActionEvent","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"},"ModerationDashboardPreferences":{"properties":{"flag_user_on_flagged_content":{"type":"boolean","x-stream-index":"002"},"media_queue_blur_enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"ModerationFlagResponse":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"015"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"entity_creator_id":{"type":"string","x-stream-index":"007"},"entity_id":{"type":"string","x-stream-index":"006"},"entity_type":{"type":"string","x-stream-index":"005"},"labels":{"items":{"type":"string"},"type":"array","x-stream-index":"011"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"008"},"reason":{"type":"string","x-stream-index":"009"},"result":{"items":{"additionalProperties":{},"type":"object"},"type":"array","x-stream-index":"012"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","x-stream-index":"014"},"review_queue_item_id":{"type":"string","x-stream-index":"013"},"type":{"type":"string","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"016"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"004"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["type","user_id","entity_type","entity_id","result","created_at","updated_at"],"type":"object"},"ModerationFlaggedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"item":{"type":"string","x-stream-index":"001"},"object_id":{"type":"string","x-stream-index":"002"},"type":{"default":"moderation.flagged","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationFlaggedEvent","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"},"ModerationMarkReviewedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"001"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"002"},"type":{"default":"moderation.mark_reviewed","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationMarkReviewedEvent","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"},"ModerationPayload":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"images":{"items":{"type":"string"},"maximum":30,"type":"array","x-stream-index":"002"},"texts":{"items":{"type":"string"},"type":"array","x-stream-index":"001"},"videos":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"type":"object"},"ModerationResponse":{"properties":{"action":{"type":"string","x-stream-index":"004"},"explicit":{"format":"float","type":"number","x-stream-index":"002"},"spam":{"format":"float","type":"number","x-stream-index":"003"},"toxic":{"format":"float","type":"number","x-stream-index":"001"}},"required":["toxic","explicit","spam","action","automod_response"],"type":"object"},"ModerationRuleV2Response":{"properties":{"action":{"$ref":"#/components/schemas/RuleBuilderAction","x-stream-index":"010"},"conditions":{"items":{"$ref":"#/components/schemas/RuleBuilderCondition"},"type":"array","x-stream-index":"007"},"config_keys":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"cooldown_period":{"type":"string","x-stream-index":"011"},"created_at":{"format":"date-time","type":"number","x-stream-index":"013"},"description":{"type":"string","x-stream-index":"003"},"enabled":{"type":"boolean","x-stream-index":"012"},"groups":{"items":{"$ref":"#/components/schemas/RuleBuilderConditionGroup"},"type":"array","x-stream-index":"009"},"id":{"type":"string","x-stream-index":"001"},"logic":{"type":"string","x-stream-index":"008"},"name":{"type":"string","x-stream-index":"002"},"rule_type":{"type":"string","x-stream-index":"006"},"team":{"type":"string","x-stream-index":"005"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"014"}},"required":["id","name","description","config_keys","team","rule_type","action","enabled","created_at","updated_at"],"type":"object"},"ModerationV2Response":{"properties":{"action":{"type":"string","x-stream-index":"001"},"blocklist_matched":{"type":"string","x-stream-index":"005"},"image_harms":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"original_text":{"type":"string","x-stream-index":"002"},"platform_circumvented":{"type":"boolean","x-stream-index":"007"},"semantic_filter_matched":{"type":"string","x-stream-index":"006"},"text_harms":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"required":["action","original_text"],"type":"object"},"MuteChannelRequest":{"nullable":true,"properties":{"channel_cids":{"description":"Channel CIDs to mute (if multiple channels)","items":{"type":"string"},"maximum":25,"title":"Channel CIDs","type":"array","x-stream-index":"002"},"expiration":{"description":"Duration of mute in milliseconds","title":"Expiration","type":"integer","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"type":"object"},"MuteChannelResponse":{"nullable":true,"properties":{"channel_mute":{"$ref":"#/components/schemas/ChannelMute","description":"Object with channel mute (if one channel was muted)","title":"Channel mute","x-stream-index":"001"},"channel_mutes":{"description":"Object with mutes (if multiple channels were muted)","items":{"$ref":"#/components/schemas/ChannelMute"},"title":"Channel mutes","type":"array","x-stream-index":"002"},"duration":{"type":"string","x-stream-index":"004.001"},"own_user":{"$ref":"#/components/schemas/OwnUser","description":"Authorized user object with fresh mutes information","title":"Own user","x-stream-index":"003"}},"required":["duration"],"type":"object"},"MuteRequest":{"nullable":true,"properties":{"target_ids":{"description":"User IDs to mute (if multiple users)","items":{"type":"string"},"title":"Target IDs","type":"array","x-stream-index":"001"},"timeout":{"description":"Duration of mute in minutes","minimum":0,"title":"Timeout","type":"integer","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"required":["target_ids"],"title":"MuteRequest","type":"object"},"MuteResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"004.001"},"mutes":{"description":"Object with mutes (if multiple users were muted)","items":{"$ref":"#/components/schemas/UserMute"},"title":"Mutes","type":"array","x-stream-index":"001"},"non_existing_users":{"description":"A list of users that can't be found. Common cause for this is deleted users","items":{"type":"string"},"title":"Non Existing Users","type":"array","x-stream-index":"003"},"own_user":{"$ref":"#/components/schemas/OwnUser","description":"Authorized user object with fresh mutes information","title":"Own User","x-stream-index":"002"}},"required":["duration"],"title":"MuteResponse","type":"object"},"NoiseCancellationSettings":{"properties":{"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode"],"type":"object"},"NotificationMarkUnreadEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003.004"},"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"003.005"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"first_unread_message_id":{"type":"string","x-stream-index":"005"},"last_read_at":{"format":"date-time","type":"number","x-stream-index":"006"},"last_read_message_id":{"type":"string","x-stream-index":"012"},"team":{"type":"string","x-stream-index":"002.001"},"thread_id":{"type":"string","x-stream-index":"013"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"009"},"type":{"default":"notification.mark_unread","type":"string","x-stream-index":"001.001"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"010"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"008"},"unread_messages":{"format":"int32","type":"integer","x-stream-index":"007"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"011"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count","first_unread_message_id","last_read_at","unread_messages","unread_count","total_unread_count","unread_channels","unread_threads"],"title":"NotificationMarkUnreadEvent","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"},"NotificationSettings":{"properties":{"call_live_started":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"002"},"call_missed":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"006"},"call_notification":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"004"},"call_ring":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"session_started":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"003"}},"required":["enabled","call_live_started","session_started","call_notification","call_ring","call_missed"],"type":"object"},"NullTime":{"type":"object"},"OCRRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"}},"required":["label","action"],"type":"object"},"OnlyUserID":{"properties":{"id":{"type":"string","x-stream-index":"001"}},"required":["id"],"type":"object"},"OwnUser":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"046"},"banned":{"type":"boolean","x-stream-index":"016"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"045"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"029"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"014"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"013"},"devices":{"items":{"$ref":"#/components/schemas/Device"},"type":"array","x-stream-index":"027"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"023"},"language":{"type":"string","x-stream-index":"035"},"last_active":{"format":"date-time","type":"number","x-stream-index":"011"},"last_engaged_at":{"format":"date-time","type":"number","x-stream-index":"012"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"037"},"mutes":{"items":{"$ref":"#/components/schemas/UserMute"},"type":"array","x-stream-index":"028"},"online":{"type":"boolean","x-stream-index":"022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"026"},"push_preferences":{"$ref":"#/components/schemas/PushPreferences","x-stream-index":"025"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"005"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"031"},"total_unread_count_by_team":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"032"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"033"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"030"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"034"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"}},"required":["id","role","custom","created_at","updated_at","banned","online","devices","mutes","channel_mutes","unread_count","total_unread_count","total_unread_count_by_team","unread_channels","unread_threads","language"],"type":"object"},"OwnUserResponse":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"banned":{"type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"015"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.011"},"devices":{"items":{"$ref":"#/components/schemas/DeviceResponse"},"title":"Devices","type":"array","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001.001"},"image":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"005"},"language":{"type":"string","x-stream-index":"001.005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"001.014"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"013"},"mutes":{"items":{"$ref":"#/components/schemas/UserMuteResponse"},"type":"array","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"001.002"},"online":{"type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"003"},"push_preferences":{"$ref":"#/components/schemas/PushPreferences","x-stream-index":"002"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.015"},"role":{"type":"string","x-stream-index":"001.006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"009"},"total_unread_count_by_team":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"010"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"011"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"008"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"012"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","devices","invisible","mutes","channel_mutes","unread_count","total_unread_count","unread_channels","unread_threads"],"type":"object"},"PagerResponse":{"properties":{"next":{"type":"string","x-stream-index":"001"},"prev":{"type":"string","x-stream-index":"002"}},"type":"object"},"PaginationParams":{"properties":{"limit":{"format":"int32","minimum":0,"type":"integer","x-stream-index":"001"},"offset":{"format":"int32","type":"integer","x-stream-index":"002"}},"type":"object"},"PendingMessageEvent":{"description":"Pending message event for async moderation","nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"002.007"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"message":{"$ref":"#/components/schemas/Message","description":"The pending message","title":"Message","x-stream-index":"002.009"},"metadata":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"002.010"},"method":{"description":"The method used for the pending message","title":"Method","type":"string","x-stream-index":"003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"type":{"default":"message.pending","description":"The type of event: \"message.pending\" in this case","title":"Event Type","type":"string","x-stream-index":"001.002"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.002"}},"required":["type","custom","method","created_at"],"title":"PendingMessageEvent","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"},"PendingMessageResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"003"},"metadata":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"}},"type":"object"},"Permission":{"properties":{"action":{"description":"Action name this permission is for (e.g. SendMessage)","title":"Action","type":"string","x-stream-index":"004"},"condition":{"additionalProperties":{},"description":"MongoDB style condition which decides whether or not the permission is granted","title":"Condition","type":"object","x-stream-index":"007"},"custom":{"description":"Whether this is a custom permission or built-in","title":"Custom","type":"boolean","x-stream-index":"009"},"description":{"description":"Description of the permission","title":"Description","type":"string","x-stream-index":"003"},"id":{"description":"Unique permission ID","title":"ID","type":"string","x-stream-index":"001"},"level":{"description":"Level at which permission could be applied (app or channel)","enum":["app","channel"],"title":"Level","type":"string","x-stream-index":"010"},"name":{"description":"Name of the permission","title":"Name","type":"string","x-stream-index":"002"},"owner":{"description":"Whether this permission applies to resource owner or not","title":"Owner","type":"boolean","x-stream-index":"005"},"same_team":{"description":"Whether this permission applies to teammates (multi-tenancy mode only)","title":"Same team","type":"boolean","x-stream-index":"006"},"tags":{"description":"List of tags of the permission","items":{"type":"string"},"title":"Tags","type":"array","x-stream-index":"011"}},"required":["id","name","description","action","owner","same_team","custom","level","tags"],"type":"object"},"Policy":{"properties":{"action":{"type":"integer","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"010"},"name":{"type":"string","x-stream-index":"004"},"owner":{"type":"boolean","x-stream-index":"008"},"priority":{"format":"int32","type":"integer","x-stream-index":"009"},"resources":{"items":{"type":"string"},"type":"array","x-stream-index":"005"},"roles":{"items":{"type":"string"},"type":"array","x-stream-index":"006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"011"}},"required":["name","resources","roles","action","owner","priority","created_at","updated_at"],"type":"object"},"PolicyRequest":{"description":"Policy request","properties":{"action":{"enum":["Deny","Allow"],"title":"Action","type":"string","x-stream-index":"001"},"name":{"description":"User-friendly policy name","title":"Name","type":"string","x-stream-index":"002"},"owner":{"description":"Whether policy applies to resource owner or not","title":"Owner","type":"boolean","x-stream-index":"005"},"priority":{"description":"Policy priority","format":"int32","maximum":999,"minimum":1,"title":"Priority","type":"integer","x-stream-index":"006"},"resources":{"description":"List of resources to apply policy to","items":{"type":"string"},"minimum":1,"title":"Resources","type":"array","x-stream-index":"003"},"roles":{"description":"List of roles to apply policy to","items":{"type":"string"},"title":"Roles","type":"array","x-stream-index":"004"}},"required":["action","name","resources","roles","owner","priority"],"title":"PolicyRequest","type":"object"},"Poll":{"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"023"},"allow_answers":{"type":"boolean","x-stream-index":"010"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"009"},"answers_count":{"format":"int32","type":"integer","x-stream-index":"015"},"created_at":{"format":"date-time","type":"number","x-stream-index":"021"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"020"},"created_by_id":{"type":"string","x-stream-index":"019"},"description":{"type":"string","x-stream-index":"005"},"enforce_unique_vote":{"type":"boolean","x-stream-index":"007"},"id":{"type":"string","x-stream-index":"003"},"is_closed":{"type":"boolean","x-stream-index":"011"},"latest_answers":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array","x-stream-index":"017"},"latest_votes_by_option":{"additionalProperties":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array"},"type":"object","x-stream-index":"016"},"max_votes_allowed":{"format":"int32","type":"integer","x-stream-index":"008"},"name":{"type":"string","x-stream-index":"004"},"options":{"items":{"$ref":"#/components/schemas/PollOption"},"type":"array","x-stream-index":"013"},"own_votes":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array","x-stream-index":"018"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"022"},"vote_count":{"format":"int32","type":"integer","x-stream-index":"012"},"vote_counts_by_option":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"014"},"voting_visibility":{"type":"string","x-stream-index":"006"}},"required":["id","name","description","enforce_unique_vote","allow_user_suggested_options","allow_answers","vote_count","options","vote_counts_by_option","answers_count","latest_votes_by_option","latest_answers","own_votes","created_by_id","created_at","updated_at","Custom"],"type":"object"},"PollOption":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id","text","custom"],"type":"object"},"PollOptionInput":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"text":{"type":"string","x-stream-index":"002"}},"type":"object"},"PollOptionRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id"],"type":"object"},"PollOptionResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"poll_option":{"$ref":"#/components/schemas/PollOptionResponseData","description":"Poll option","title":"PollOptionResponseData","x-stream-index":"001"}},"required":["poll_option","duration"],"type":"object"},"PollOptionResponseData":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id","text","custom"],"type":"object"},"PollResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"poll":{"$ref":"#/components/schemas/PollResponseData","description":"Poll","title":"PollResponseData","x-stream-index":"001"}},"required":["poll","duration"],"type":"object"},"PollResponseData":{"properties":{"allow_answers":{"type":"boolean","x-stream-index":"008"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"007"},"answers_count":{"format":"int32","type":"integer","x-stream-index":"012"},"created_at":{"format":"date-time","type":"number","x-stream-index":"019"},"created_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"018"},"created_by_id":{"type":"string","x-stream-index":"017"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"021"},"description":{"type":"string","x-stream-index":"003"},"enforce_unique_vote":{"type":"boolean","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"is_closed":{"type":"boolean","x-stream-index":"009"},"latest_answers":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array","x-stream-index":"015"},"latest_votes_by_option":{"additionalProperties":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array"},"type":"object","x-stream-index":"014"},"max_votes_allowed":{"format":"int32","type":"integer","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"002"},"options":{"items":{"$ref":"#/components/schemas/PollOptionResponseData"},"type":"array","x-stream-index":"011"},"own_votes":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array","x-stream-index":"016"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"020"},"vote_count":{"format":"int32","type":"integer","x-stream-index":"010"},"vote_counts_by_option":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"013"},"voting_visibility":{"type":"string","x-stream-index":"004"}},"required":["id","name","description","voting_visibility","enforce_unique_vote","allow_user_suggested_options","allow_answers","vote_count","options","answers_count","vote_counts_by_option","latest_votes_by_option","latest_answers","own_votes","created_by_id","created_at","updated_at","custom"],"type":"object"},"PollVote":{"nullable":true,"properties":{"answer_text":{"type":"string","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"004"},"is_answer":{"type":"boolean","x-stream-index":"006"},"option_id":{"type":"string","x-stream-index":"005"},"poll_id":{"type":"string","x-stream-index":"003"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"011"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"009"},"user_id":{"type":"string","x-stream-index":"008"}},"required":["poll_id","id","option_id","created_at","updated_at"],"type":"object"},"PollVoteResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"vote":{"$ref":"#/components/schemas/PollVoteResponseData","description":"Poll vote","title":"PollVoteResponseData","x-stream-index":"001"}},"required":["duration"],"type":"object"},"PollVoteResponseData":{"nullable":true,"properties":{"answer_text":{"type":"string","x-stream-index":"005"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"id":{"type":"string","x-stream-index":"002"},"is_answer":{"type":"boolean","x-stream-index":"004"},"option_id":{"type":"string","x-stream-index":"003"},"poll_id":{"type":"string","x-stream-index":"001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"007"},"user_id":{"type":"string","x-stream-index":"006"}},"required":["poll_id","id","option_id","created_at","updated_at"],"type":"object"},"PollVotesResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"votes":{"description":"Poll votes","items":{"$ref":"#/components/schemas/PollVoteResponseData"},"title":"PollVoteResponseList","type":"array","x-stream-index":"001"}},"required":["votes","duration"],"type":"object"},"PrivacySettings":{"properties":{"read_receipts":{"$ref":"#/components/schemas/ReadReceipts","x-stream-index":"002"},"typing_indicators":{"$ref":"#/components/schemas/TypingIndicators","x-stream-index":"001"}},"type":"object"},"PrivacySettingsResponse":{"properties":{"read_receipts":{"$ref":"#/components/schemas/ReadReceiptsResponse","x-stream-index":"002"},"typing_indicators":{"$ref":"#/components/schemas/TypingIndicatorsResponse","x-stream-index":"001"}},"type":"object"},"PushConfig":{"properties":{"offline_only":{"type":"boolean","x-stream-index":"002"},"version":{"enum":["v1","v2","v3"],"type":"string","x-stream-index":"001"}},"required":["version"],"type":"object"},"PushNotificationFields":{"properties":{"apn":{"$ref":"#/components/schemas/APNConfigFields","x-stream-index":"002"},"firebase":{"$ref":"#/components/schemas/FirebaseConfigFields","x-stream-index":"003"},"huawei":{"$ref":"#/components/schemas/HuaweiConfigFields","x-stream-index":"004"},"offline_only":{"type":"boolean","x-stream-index":"001.002"},"providers":{"items":{"$ref":"#/components/schemas/PushProvider"},"type":"array","x-stream-index":"006"},"version":{"type":"string","x-stream-index":"001.001"},"xiaomi":{"$ref":"#/components/schemas/XiaomiConfigFields","x-stream-index":"005"}},"required":["version","offline_only","apn","firebase","huawei","xiaomi"],"type":"object"},"PushNotificationSettingsResponse":{"properties":{"disabled":{"type":"boolean","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"number","x-stream-index":"002"}},"type":"object"},"PushPreferenceInput":{"nullable":true,"properties":{"call_level":{"description":"Set the level of call push notifications for the user. One of all, none, default","enum":["all","none","default"],"type":"string","x-stream-index":"004"},"channel_cid":{"description":"Set the push preferences for a specific channel. If empty it sets the default for the user","type":"string","x-stream-index":"002"},"chat_level":{"description":"Set the level of chat push notifications for the user. One of all, mentions, none, default","enum":["all","mentions","none","default"],"type":"string","x-stream-index":"003"},"disabled_until":{"description":"Disable push notifications till a certain time","format":"date-time","type":"number","x-stream-index":"007"},"feeds_events":{"$ref":"#/components/schemas/FeedsEventPreferencesInput","description":"Set granular feeds event preferences for reactions, comments, new followers, and mentions","x-stream-index":"006"},"feeds_level":{"description":"Set the level of feeds push notifications for the user. One of all, none, default","enum":["all","none","default"],"type":"string","x-stream-index":"005"},"remove_disable":{"description":"Remove the disabled until time. (IE stop snoozing notifications)","type":"boolean","x-stream-index":"008"},"user_id":{"description":"The user id for which to set the push preferences. Required when using server side auths, defaults to current user with client side auth.","type":"string","x-stream-index":"001"}},"type":"object"},"PushPreferences":{"properties":{"call_level":{"type":"string","x-stream-index":"002"},"chat_level":{"type":"string","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"number","x-stream-index":"005"},"feeds_events":{"$ref":"#/components/schemas/FeedsEventPreferences","x-stream-index":"004"},"feeds_level":{"type":"string","x-stream-index":"003"}},"type":"object"},"PushProvider":{"nullable":true,"properties":{"apn_auth_key":{"type":"string","x-stream-index":"012"},"apn_auth_type":{"type":"string","x-stream-index":"017"},"apn_development":{"type":"boolean","x-stream-index":"018"},"apn_host":{"type":"string","x-stream-index":"019"},"apn_key_id":{"type":"string","x-stream-index":"013"},"apn_notification_template":{"type":"string","x-stream-index":"020"},"apn_p12_cert":{"type":"string","x-stream-index":"014"},"apn_team_id":{"type":"string","x-stream-index":"015"},"apn_topic":{"type":"string","x-stream-index":"016"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"description":{"maxLength":128,"type":"string","x-stream-index":"007"},"disabled_at":{"format":"date-time","type":"number","x-stream-index":"010"},"disabled_reason":{"maxLength":255,"type":"string","x-stream-index":"011"},"firebase_apn_template":{"type":"string","x-stream-index":"025"},"firebase_credentials":{"type":"string","x-stream-index":"022"},"firebase_data_template":{"type":"string","x-stream-index":"023"},"firebase_host":{"type":"string","x-stream-index":"026"},"firebase_notification_template":{"type":"string","x-stream-index":"024"},"firebase_server_key":{"type":"string","x-stream-index":"021"},"huawei_app_id":{"type":"string","x-stream-index":"027"},"huawei_app_secret":{"type":"string","x-stream-index":"028"},"name":{"maxLength":36,"minLength":1,"type":"string","x-stream-index":"005"},"push_templates":{"items":{"$ref":"#/components/schemas/PushTemplate"},"type":"array","x-stream-index":"031"},"type":{"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"xiaomi_app_secret":{"type":"string","x-stream-index":"030"},"xiaomi_package_name":{"type":"string","x-stream-index":"029"}},"required":["name","type","created_at","updated_at"],"type":"object"},"PushProviderResponse":{"properties":{"apn_auth_key":{"type":"string","x-stream-index":"008"},"apn_auth_type":{"type":"string","x-stream-index":"013"},"apn_development":{"type":"boolean","x-stream-index":"014"},"apn_host":{"type":"string","x-stream-index":"015"},"apn_key_id":{"type":"string","x-stream-index":"009"},"apn_p12_cert":{"type":"string","x-stream-index":"010"},"apn_sandbox_certificate":{"type":"boolean","x-stream-index":"016"},"apn_supports_remote_notifications":{"type":"boolean","x-stream-index":"018"},"apn_supports_voip_notifications":{"type":"boolean","x-stream-index":"017"},"apn_team_id":{"type":"string","x-stream-index":"011"},"apn_topic":{"type":"string","x-stream-index":"012"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"description":{"type":"string","x-stream-index":"003"},"disabled_at":{"format":"date-time","type":"number","x-stream-index":"006"},"disabled_reason":{"type":"string","x-stream-index":"007"},"firebase_apn_template":{"type":"string","x-stream-index":"023"},"firebase_credentials":{"type":"string","x-stream-index":"020"},"firebase_data_template":{"type":"string","x-stream-index":"021"},"firebase_host":{"type":"string","x-stream-index":"024"},"firebase_notification_template":{"type":"string","x-stream-index":"022"},"firebase_server_key":{"type":"string","x-stream-index":"019"},"huawei_app_id":{"type":"string","x-stream-index":"025"},"huawei_app_secret":{"type":"string","x-stream-index":"026"},"name":{"type":"string","x-stream-index":"001"},"type":{"type":"string","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"005"},"xiaomi_app_secret":{"type":"string","x-stream-index":"028"},"xiaomi_package_name":{"type":"string","x-stream-index":"027"}},"required":["name","type","created_at","updated_at"],"type":"object"},"PushTemplate":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"enable_push":{"type":"boolean","x-stream-index":"003"},"event_type":{"enum":["message.new","message.updated","reaction.new","notification.reminder_due","feeds.activity.added","feeds.comment.added","feeds.activity.reaction.added","feeds.comment.reaction.added","feeds.follow.created","feeds.notification_feed.updated"],"type":"string","x-stream-index":"005"},"template":{"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"008"}},"required":["enable_push","event_type","created_at","updated_at"],"type":"object"},"Quality":{"properties":{"bitdepth":{"format":"int32","type":"integer","x-stream-index":"007"},"framerate":{"format":"int32","type":"integer","x-stream-index":"008"},"height":{"format":"int32","type":"integer","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"004"},"video_bitrate":{"format":"int32","type":"integer","x-stream-index":"009"},"width":{"format":"int32","type":"integer","x-stream-index":"005"}},"type":"object"},"QueryBannedUsersPayload":{"properties":{"exclude_expired_bans":{"description":"Whether to exclude expired bans or not","title":"Exclude expired bans","type":"boolean","x-stream-index":"004"},"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"description":"Number of records to return","format":"int32","maximum":300,"minimum":0,"title":"Limit","type":"integer","x-stream-index":"003.003"},"offset":{"description":"Number of records to offset","format":"int32","maximum":10000,"title":"Offset","type":"integer","x-stream-index":"003.004"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":1,"title":"Sort","type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"005.002"},"user_id":{"type":"string","x-stream-index":"005.001"}},"required":["filter_conditions"],"type":"object"},"QueryBannedUsersResponse":{"nullable":true,"properties":{"bans":{"description":"List of found bans","items":{"$ref":"#/components/schemas/BanResponse"},"title":"BanResponse","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["bans","duration"],"type":"object"},"QueryCampaignsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"004.001"},"next":{"type":"string","x-stream-index":"004.002"},"prev":{"type":"string","x-stream-index":"004.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"type":"array","x-stream-index":"002"},"user_limit":{"format":"int32","maximum":1000,"minimum":0,"type":"integer","x-stream-index":"003"}},"type":"object"},"QueryCampaignsResponse":{"description":"Basic response information","nullable":true,"properties":{"campaigns":{"items":{"$ref":"#/components/schemas/CampaignResponse"},"type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["campaigns","duration"],"title":"Response","type":"object"},"QueryChannelsRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"description":"Number of channels to limit","format":"int32","title":"Limit","type":"integer","x-stream-index":"008"},"member_limit":{"description":"Number of members to limit","format":"int32","maximum":100,"minimum":0,"title":"Member limit","type":"integer","x-stream-index":"007"},"message_limit":{"description":"Number of messages to limit","format":"int32","minimum":0,"title":"Message limit","type":"integer","x-stream-index":"006"},"offset":{"description":"Channel pagination offset","format":"int32","title":"Offset","type":"integer","x-stream-index":"009"},"sort":{"description":"List of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"002"},"state":{"description":"Whether to update channel state or not","title":"State","type":"boolean","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"010.002"},"user_id":{"type":"string","x-stream-index":"010.001"}},"title":"Query Channels Request","type":"object","x-stream-docs-page-id":"query_channels"},"QueryChannelsResponse":{"nullable":true,"properties":{"channels":{"description":"List of channels","items":{"$ref":"#/components/schemas/ChannelStateResponseFields"},"title":"Channels","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["channels","duration"],"title":"Channels list","type":"object"},"QueryDraftsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","maximum":3,"title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"type":"object"},"QueryDraftsResponse":{"nullable":true,"properties":{"drafts":{"description":"Drafts","items":{"$ref":"#/components/schemas/DraftResponse"},"title":"DraftsResponseList","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["drafts","duration"],"type":"object"},"QueryFeedModerationTemplate":{"properties":{"config":{"$ref":"#/components/schemas/FeedsModerationTemplateConfig","description":"Configuration for the moderation template","title":"Config","x-stream-index":"002"},"created_at":{"description":"When the template was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"003"},"name":{"description":"Name of the moderation template","title":"Name","type":"string","x-stream-index":"001"},"updated_at":{"description":"When the template was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"004"}},"required":["name","created_at","updated_at"],"type":"object"},"QueryFeedModerationTemplatesResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"templates":{"description":"List of moderation templates","items":{"$ref":"#/components/schemas/QueryFeedModerationTemplate"},"title":"Templates","type":"array","x-stream-index":"001"}},"required":["templates","duration"],"type":"object"},"QueryMembersPayload":{"description":"Client request","properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"002"},"limit":{"format":"int32","maximum":300,"minimum":0,"type":"integer","x-stream-index":"006.003"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"type":"array","x-stream-index":"003"},"offset":{"format":"int32","maximum":10000,"type":"integer","x-stream-index":"006.004"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":1,"type":"array","x-stream-index":"005"},"type":{"maxLength":64,"type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"007.002"},"user_id":{"type":"string","x-stream-index":"007.001"}},"required":["type","filter_conditions"],"title":"ClientRequest","type":"object"},"QueryMessageFlagsPayload":{"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":300,"minimum":0,"type":"integer","x-stream-index":"003.003"},"offset":{"format":"int32","maximum":10000,"type":"integer","x-stream-index":"003.004"},"show_deleted_messages":{"description":"Whether to include deleted messages in the results","title":"ShowDeletedMessages","type":"boolean","x-stream-index":"002"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"type":"array","x-stream-index":"003.005"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"type":"object"},"QueryMessageFlagsResponse":{"description":"Query message flags response","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"flags":{"description":"The flags that match the query","items":{"$ref":"#/components/schemas/MessageFlagResponse"},"title":"MessageFlagResponseList","type":"array","x-stream-index":"001"}},"required":["flags","duration"],"title":"QueryMessageFlagsResponse","type":"object"},"QueryMessageHistoryRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","maximum":3,"minimum":1,"title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"004.001"},"next":{"type":"string","x-stream-index":"004.002"},"prev":{"type":"string","x-stream-index":"004.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"002"}},"required":["filter"],"type":"object"},"QueryMessageHistoryResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message_history":{"description":"Message history entries","items":{"$ref":"#/components/schemas/MessageHistoryEntryResponse"},"title":"MessageHistoryEntryResponseList","type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["message_history","duration"],"type":"object"},"QueryModerationConfigsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter conditions for moderation configs","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"Sorting parameters for the results","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"type":"object"},"QueryModerationConfigsResponse":{"nullable":true,"properties":{"configs":{"description":"List of moderation configurations","items":{"$ref":"#/components/schemas/ConfigResponse"},"title":"Configs","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["configs","duration"],"type":"object"},"QueryModerationFlagsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParam"},"type":"array","x-stream-index":"002"}},"type":"object"},"QueryModerationFlagsResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"flags":{"items":{"$ref":"#/components/schemas/ModerationFlagResponse"},"type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["flags","duration"],"title":"Response","type":"object"},"QueryModerationLogsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter conditions for moderation logs","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"Sorting parameters for the results","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"type":"object"},"QueryModerationLogsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"003.001"},"logs":{"description":"List of moderation action logs","items":{"$ref":"#/components/schemas/ActionLogResponse"},"title":"Logs","type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["logs","duration"],"type":"object"},"QueryModerationRulesRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter conditions for moderation rules","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"Sorting parameters for the results","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"type":"object"},"QueryModerationRulesResponse":{"nullable":true,"properties":{"default_llm_labels":{"additionalProperties":{"type":"string"},"description":"Default LLM label descriptions","title":"DefaultLLMLabels","type":"object","x-stream-index":"002"},"duration":{"type":"string","x-stream-index":"004.001"},"next":{"type":"string","x-stream-index":"003.001"},"prev":{"type":"string","x-stream-index":"003.002"},"rules":{"description":"List of moderation rules","items":{"$ref":"#/components/schemas/ModerationRuleV2Response"},"title":"Rules","type":"array","x-stream-index":"001"}},"required":["rules","default_llm_labels","duration"],"type":"object"},"QueryPollVotesRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","title":"Filter","type":"object","x-stream-index":"003"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"004"}},"type":"object"},"QueryPollsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","title":"Filter","type":"object","x-stream-index":"002"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"003"}},"type":"object"},"QueryPollsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"polls":{"description":"Polls data returned by the query","items":{"$ref":"#/components/schemas/PollResponseData"},"title":"PollsResponseData","type":"array","x-stream-index":"001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["polls","duration"],"type":"object"},"QueryReactionsRequest":{"properties":{"filter":{"additionalProperties":{},"type":"object","x-stream-index":"002"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"006.001"},"next":{"type":"string","x-stream-index":"006.002"},"prev":{"type":"string","x-stream-index":"006.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":2,"type":"array","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"type":"object"},"QueryReactionsResponse":{"description":"Basic response information","properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"next":{"type":"string","x-stream-index":"003.001"},"prev":{"type":"string","x-stream-index":"003.002"},"reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"001"}},"required":["reactions","duration"],"title":"Response","type":"object"},"QueryRemindersRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"type":"object"},"QueryRemindersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"reminders":{"description":"MessageReminders data returned by the query","items":{"$ref":"#/components/schemas/ReminderResponseData"},"title":"RemindersResponseData","type":"array","x-stream-index":"001"}},"required":["reminders","duration"],"type":"object"},"QueryReviewQueueRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter conditions for review queue items","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"007.001"},"lock_count":{"description":"Number of items to lock (1-25)","format":"int32","maximum":25,"minimum":1,"title":"Lock Count","type":"integer","x-stream-index":"005"},"lock_duration":{"description":"Duration for which items should be locked","title":"Lock Duration","type":"integer","x-stream-index":"004"},"lock_items":{"description":"Whether to lock items for review (true), unlock items (false), or just fetch (nil)","title":"Lock Items","type":"boolean","x-stream-index":"003"},"next":{"type":"string","x-stream-index":"007.002"},"prev":{"type":"string","x-stream-index":"007.003"},"sort":{"description":"Sorting parameters for the results","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"002"},"stats_only":{"description":"Whether to return only statistics","title":"Stats Only","type":"boolean","x-stream-index":"006"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"008.002"},"user_id":{"type":"string","x-stream-index":"008.001"}},"type":"object"},"QueryReviewQueueResponse":{"nullable":true,"properties":{"action_config":{"additionalProperties":{"items":{"$ref":"#/components/schemas/ModerationActionConfig"},"type":"array"},"description":"Configuration for moderation actions","title":"Action Config","type":"object","x-stream-index":"002"},"duration":{"type":"string","x-stream-index":"005.001"},"items":{"description":"List of review queue items","items":{"$ref":"#/components/schemas/ReviewQueueItemResponse"},"title":"Items","type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"004.001"},"prev":{"type":"string","x-stream-index":"004.002"},"stats":{"additionalProperties":{},"description":"Statistics about the review queue","title":"Stats","type":"object","x-stream-index":"003"}},"required":["items","action_config","stats","duration"],"type":"object"},"QuerySegmentTargetsRequest":{"nullable":true,"properties":{"Filter":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"005"},"Sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"type":"array","writeOnly":true,"x-stream-index":"006"},"limit":{"description":"Limit","format":"int32","maximum":10000,"minimum":0,"title":"int","type":"integer","x-stream-index":"002"},"next":{"description":"Next","title":"string","type":"string","x-stream-index":"003"},"prev":{"description":"Prev","title":"string","type":"string","x-stream-index":"004"}},"type":"object"},"QuerySegmentTargetsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"targets":{"description":"Targets","items":{"$ref":"#/components/schemas/SegmentTargetResponse"},"title":"SegmentTargetResponseList","type":"array","x-stream-index":"001"}},"required":["targets","duration"],"type":"object"},"QuerySegmentsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"002"}},"required":["filter"],"type":"object"},"QuerySegmentsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"segments":{"description":"Segments","items":{"$ref":"#/components/schemas/SegmentResponse"},"title":"SegmentResponses","type":"array","x-stream-index":"001"}},"required":["segments","duration"],"type":"object"},"QueryThreadsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter conditions to apply to threads","title":"Filter","type":"object","x-stream-index":"006"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"008.001"},"member_limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005"},"next":{"type":"string","x-stream-index":"008.002"},"participant_limit":{"description":"Limit the number of participants returned per each thread","format":"int32","maximum":100,"minimum":0,"title":"Participant limit","type":"integer","x-stream-index":"004"},"prev":{"type":"string","x-stream-index":"008.003"},"reply_limit":{"description":"Limit the number of replies returned per each thread","format":"int32","maximum":10,"minimum":0,"title":"Reply limit","type":"integer","x-stream-index":"003"},"sort":{"description":"Sort conditions to apply to threads","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"007"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"010.002"},"user_id":{"type":"string","x-stream-index":"010.001"}},"type":"object"},"QueryThreadsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"threads":{"description":"List of enriched thread states","items":{"$ref":"#/components/schemas/ThreadStateResponse"},"title":"Threads","type":"array","x-stream-index":"001"}},"required":["threads","duration"],"type":"object"},"QueryUsersPayload":{"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"include_deactivated_users":{"type":"boolean","x-stream-index":"004"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.003"},"offset":{"format":"int32","maximum":1000,"type":"integer","x-stream-index":"005.004"},"presence":{"type":"boolean","x-stream-index":"003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"006.002"},"user_id":{"type":"string","x-stream-index":"006.001"}},"required":["filter_conditions"],"type":"object"},"QueryUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"users":{"description":"Array of users as result of filters applied.","items":{"$ref":"#/components/schemas/FullUserResponse"},"title":"Users","type":"array","x-stream-index":"001"}},"required":["users","duration"],"type":"object"},"RTMPEgressConfig":{"properties":{"composite_app_settings":{"$ref":"#/components/schemas/CompositeAppSettings","x-stream-index":"005"},"quality":{"$ref":"#/components/schemas/Quality","x-stream-index":"004"},"rtmp_location":{"type":"string","x-stream-index":"006"}},"type":"object"},"RTMPIngress":{"description":"RTMP input settings","properties":{"address":{"title":"Address","type":"string","x-stream-index":"001"}},"required":["address"],"title":"RTMPIngress","type":"object"},"RTMPLocation":{"properties":{"name":{"type":"string","x-stream-index":"001"},"stream_key":{"type":"string","x-stream-index":"003"},"stream_url":{"type":"string","x-stream-index":"002"}},"required":["name","stream_url","stream_key"],"type":"object"},"RTMPSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"003"},"location":{"$ref":"#/components/schemas/RTMPLocation","x-stream-index":"004"},"quality_name":{"type":"string","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"RTMPSettingsResponse":{"description":"RTMPSettingsResponse is the payload for RTMP settings","properties":{"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettingsResponse","title":"Layout","x-stream-index":"003"},"quality":{"title":"Quality","type":"string","x-stream-index":"002"}},"required":["enabled","quality","layout"],"title":"RTMPSettingsResponse","type":"object"},"Reaction":{"nullable":true,"properties":{"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"message_id":{"type":"string","x-stream-index":"003"},"score":{"format":"int32","type":"integer","x-stream-index":"007"},"type":{"maxLength":30,"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["message_id","type","score","created_at","updated_at","custom"],"type":"object"},"ReactionDeletedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"006.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"002"},"team":{"type":"string","x-stream-index":"005.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"reaction.deleted","type":"string","x-stream-index":"006.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"ReactionDeletedEvent","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"},"ReactionGroupResponse":{"description":"ReactionGroupResponse contains all information about a reaction of the same type.","nullable":true,"properties":{"count":{"description":"Count is the number of reactions of this type.","format":"int32","title":"Count","type":"integer","x-stream-index":"001"},"first_reaction_at":{"description":"FirstReactionAt is the time of the first reaction of this type. This is the same also if all reaction of this type are deleted, because if someone will react again with the same type, will be preserved the sorting.","format":"date-time","title":"FirstReactionAt","type":"number","x-stream-index":"003"},"last_reaction_at":{"description":"LastReactionAt is the time of the last reaction of this type.","format":"date-time","title":"LastReactionAt","type":"number","x-stream-index":"004"},"sum_scores":{"description":"SumScores is the sum of all scores of reactions of this type. Medium allows you to clap articles more than once and shows the sum of all claps from all users. For example, you can send `clap` x5 using `score: 5`.","format":"int32","title":"SumScores","type":"integer","x-stream-index":"002"}},"required":["count","sum_scores","first_reaction_at","last_reaction_at"],"title":"ReactionGroupResponse","type":"object"},"ReactionNewEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"006.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"002"},"team":{"type":"string","x-stream-index":"005.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"reaction.new","type":"string","x-stream-index":"006.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"ReactionNewEvent","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"},"ReactionRequest":{"description":"Represents user reaction to a message","properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"score":{"description":"Reaction score. If not specified reaction has score of 1","format":"int32","title":"Score","type":"integer","x-stream-index":"002"},"type":{"description":"The type of reaction (e.g. 'like', 'laugh', 'wow')","maxLength":30,"title":"Type","type":"string","x-stream-index":"001"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"006.002"},"user_id":{"type":"string","x-stream-index":"006.001"}},"required":["type"],"title":"Reaction","type":"object","x-stream-docs-page-id":"send_reaction"},"ReactionResponse":{"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"006"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"008"},"message_id":{"description":"Message ID","title":"Message ID","type":"string","x-stream-index":"001"},"score":{"description":"Score of the reaction","format":"int32","title":"Score","type":"integer","x-stream-index":"005"},"type":{"description":"Type of reaction","title":"Type","type":"string","x-stream-index":"004"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"007"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User","title":"UserResponse","x-stream-index":"003"},"user_id":{"description":"User ID","title":"User ID","type":"string","x-stream-index":"002"}},"required":["message_id","user_id","user","type","score","created_at","updated_at","custom"],"type":"object"},"ReactionUpdatedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"006.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"002"},"team":{"type":"string","x-stream-index":"005.001"},"type":{"default":"reaction.updated","type":"string","x-stream-index":"006.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["message","reaction","cid","channel_id","channel_type","type","created_at"],"title":"ReactionUpdatedEvent","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"},"ReactivateUserRequest":{"nullable":true,"properties":{"created_by_id":{"description":"ID of the user who's reactivating the user","title":"Created by ID","type":"string","x-stream-index":"004"},"name":{"description":"Set this field to put new name for the user","title":"Name","type":"string","x-stream-index":"003"},"restore_messages":{"description":"Restore previously deleted messages","title":"Restore messages","type":"boolean","x-stream-index":"002"}},"type":"object"},"ReactivateUserResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.002.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Deactivated user object","title":"User","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"ReactivateUsersRequest":{"description":"Reactivate users in batches","nullable":true,"properties":{"created_by_id":{"description":"ID of the user who's reactivating the users","title":"Created by ID","type":"string","x-stream-index":"003"},"restore_channels":{"type":"boolean","x-stream-index":"004"},"restore_messages":{"description":"Restore previously deleted messages","title":"Restore messages","type":"boolean","x-stream-index":"002"},"user_ids":{"description":"User IDs to reactivate","items":{"type":"string"},"maximum":100,"minimum":1,"title":"User IDs","type":"array","x-stream-index":"001"}},"required":["user_ids"],"title":"ReactivateUsersRequest","type":"object"},"ReactivateUsersResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.002.001"},"task_id":{"type":"string","x-stream-index":"001.001"}},"required":["task_id","duration"],"title":"Response","type":"object"},"ReadReceipts":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"ReadReceiptsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"ReadStateResponse":{"properties":{"last_read":{"format":"date-time","type":"number","x-stream-index":"002"},"last_read_message_id":{"type":"string","x-stream-index":"004"},"unread_messages":{"format":"int32","type":"integer","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"}},"required":["user","last_read","unread_messages"],"type":"object"},"RecordSettings":{"properties":{"audio_only":{"type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"004"},"mode":{"type":"string","x-stream-index":"002"},"quality":{"type":"string","x-stream-index":"003"}},"required":["mode"],"type":"object"},"RecordSettingsResponse":{"description":"RecordSettings is the payload for recording settings","properties":{"audio_only":{"title":"Audio Only","type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettingsResponse","title":"Layout","x-stream-index":"004"},"mode":{"title":"Mode","type":"string","x-stream-index":"002"},"quality":{"title":"Quality","type":"string","x-stream-index":"003"}},"required":["audio_only","mode","quality","layout"],"title":"RecordSettingsResponse","type":"object"},"RecordingEgressConfig":{"properties":{"audio_only":{"type":"boolean","x-stream-index":"006"},"composite_app_settings":{"$ref":"#/components/schemas/CompositeAppSettings","x-stream-index":"005"},"external_storage":{"$ref":"#/components/schemas/ExternalStorage","x-stream-index":"008"},"quality":{"$ref":"#/components/schemas/Quality","x-stream-index":"004"},"storage_name":{"type":"string","x-stream-index":"007"},"video_orientation_hint":{"$ref":"#/components/schemas/VideoOrientation","x-stream-index":"009"}},"type":"object"},"ReminderCreatedEvent":{"description":"Emitted when a reminder is created.","nullable":true,"properties":{"cid":{"description":"The CID of the Channel for which the reminder was created","title":"Channel CID","type":"string","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.007"},"message_id":{"description":"The ID of the message for which the reminder was created","title":"Message ID","type":"string","x-stream-index":"001.002"},"parent_id":{"description":"The ID of the parent message, if the reminder is for a thread message","title":"Parent ID","type":"string","x-stream-index":"001.005"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","description":"The reminder object which was created","title":"MessageReminder","x-stream-index":"001.006"},"type":{"default":"reminder.created","description":"The type of event: \"reminder.created\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.002"},"user_id":{"description":"The ID of the user for whom the reminder was created","title":"User ID","type":"string","x-stream-index":"001.003"}},"required":["type","created_at","custom","message_id","user_id","cid"],"title":"ReminderCreatedEvent","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"},"ReminderDeletedEvent":{"description":"Emitted when a reminder is deleted.","nullable":true,"properties":{"cid":{"description":"The CID of the Channel for which the reminder was created","title":"Channel CID","type":"string","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.007"},"message_id":{"description":"The ID of the message for which the reminder was created","title":"Message ID","type":"string","x-stream-index":"001.002"},"parent_id":{"description":"The ID of the parent message, if the reminder is for a thread message","title":"Parent ID","type":"string","x-stream-index":"001.005"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","description":"The reminder object which was created","title":"MessageReminder","x-stream-index":"001.006"},"type":{"default":"reminder.deleted","description":"The type of event: \"reminder.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.002"},"user_id":{"description":"The ID of the user for whom the reminder was created","title":"User ID","type":"string","x-stream-index":"001.003"}},"required":["type","created_at","custom","message_id","user_id","cid"],"title":"ReminderDeletedEvent","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"},"ReminderNotificationEvent":{"description":"Emitted when a reminder becomes due, triggering a notification for the user.","nullable":true,"properties":{"cid":{"description":"The CID of the Channel for which the reminder was created","title":"Channel CID","type":"string","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.007"},"message_id":{"description":"The ID of the message for which the reminder was created","title":"Message ID","type":"string","x-stream-index":"001.002"},"parent_id":{"type":"string","x-stream-index":"001.005"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","description":"The reminder object which was created","title":"MessageReminder","x-stream-index":"001.006"},"type":{"default":"notification.reminder_due","description":"The type of event: \"notification.reminder_due\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.002"},"user_id":{"description":"The ID of the user for whom the reminder was created","title":"User ID","type":"string","x-stream-index":"001.003"}},"required":["type","created_at","custom","message_id","user_id","cid"],"title":"ReminderNotificationEvent","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"},"ReminderResponseData":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003"},"channel_cid":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"005"},"message_id":{"type":"string","x-stream-index":"004"},"remind_at":{"format":"date-time","type":"number","x-stream-index":"001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007"},"user_id":{"type":"string","x-stream-index":"006"}},"required":["channel_cid","message_id","user_id","created_at","updated_at"],"type":"object"},"ReminderUpdatedEvent":{"description":"Emitted when a reminder is updated.","nullable":true,"properties":{"cid":{"description":"The CID of the Channel for which the reminder was created","title":"Channel CID","type":"string","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.007"},"message_id":{"description":"The ID of the message for which the reminder was created","title":"Message ID","type":"string","x-stream-index":"001.002"},"parent_id":{"description":"The ID of the parent message, if the reminder is for a thread message","title":"Parent ID","type":"string","x-stream-index":"001.005"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","description":"The reminder object which was created","title":"MessageReminder","x-stream-index":"001.006"},"type":{"default":"reminder.updated","description":"The type of event: \"reminder.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.002"},"user_id":{"description":"The ID of the user for whom the reminder was created","title":"User ID","type":"string","x-stream-index":"001.003"}},"required":["type","created_at","custom","message_id","user_id","cid"],"title":"ReminderUpdatedEvent","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"},"Response":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001"}},"required":["duration"],"title":"Response","type":"object"},"RestoreActionRequest":{"type":"object"},"RestoreUsersRequest":{"nullable":true,"properties":{"user_ids":{"items":{"type":"string"},"maximum":100,"minimum":1,"type":"array","x-stream-index":"001"}},"required":["user_ids"],"type":"object"},"ReviewQueueItem":{"properties":{"actions":{"items":{"$ref":"#/components/schemas/ActionLog"},"type":"array","x-stream-index":"035"},"activity":{"$ref":"#/components/schemas/EnrichedActivity","x-stream-index":"028"},"ai_text_severity":{"type":"string","x-stream-index":"021"},"archived_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"043"},"assigned_to":{"$ref":"#/components/schemas/User","x-stream-index":"032"},"bans":{"items":{"$ref":"#/components/schemas/Ban"},"type":"array","x-stream-index":"033"},"bounce_count":{"format":"int32","type":"integer","x-stream-index":"025"},"call":{"$ref":"#/components/schemas/Call","x-stream-index":"031"},"completed_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"018"},"config_key":{"type":"string","x-stream-index":"009"},"content_changed":{"type":"boolean","x-stream-index":"036"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"entity_creator":{"$ref":"#/components/schemas/EntityCreator","x-stream-index":"030"},"entity_id":{"type":"string","x-stream-index":"007"},"entity_type":{"type":"string","x-stream-index":"006"},"feeds_v2_activity":{"$ref":"#/components/schemas/EnrichedActivity","x-stream-index":"041"},"feeds_v2_reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"042"},"flag_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"045"},"flag_types":{"items":{"type":"string"},"type":"array","x-stream-index":"044"},"flags":{"items":{"$ref":"#/components/schemas/Flag"},"type":"array","x-stream-index":"034"},"flags_count":{"format":"int32","type":"integer","x-stream-index":"026"},"has_image":{"type":"boolean","x-stream-index":"012"},"has_text":{"type":"boolean","x-stream-index":"014"},"has_video":{"type":"boolean","x-stream-index":"013"},"id":{"type":"string","x-stream-index":"003"},"languages":{"items":{"type":"string"},"type":"array","x-stream-index":"019"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"027"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"010"},"moderation_payload_hash":{"type":"string","x-stream-index":"011"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"029"},"recommended_action":{"type":"string","x-stream-index":"017"},"reporter_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"046"},"reviewed_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"022"},"reviewed_by":{"type":"string","x-stream-index":"023"},"severity":{"format":"int32","type":"integer","x-stream-index":"020"},"status":{"type":"string","x-stream-index":"016"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"015"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"005"}},"required":["id","created_at","updated_at","entity_type","entity_id","config_key","moderation_payload_hash","has_image","has_video","has_text","teams","status","recommended_action","completed_at","languages","severity","ai_text_severity","reviewed_at","reviewed_by","bounce_count","flags_count","bans","flags","actions","content_changed","archived_at","flag_types","flag_labels","reporter_ids"],"type":"object"},"ReviewQueueItemNewEvent":{"description":"This event is sent when a new moderation review queue item is created","nullable":true,"properties":{"action":{"$ref":"#/components/schemas/ActionLogResponse","description":"The action log if any action was taken","title":"Action","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"flags":{"description":"The flags associated with this review queue item","items":{"$ref":"#/components/schemas/ModerationFlagResponse"},"title":"Flags","type":"array","x-stream-index":"003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"The review queue item that was created","title":"ReviewQueueItem","x-stream-index":"002"},"type":{"default":"review_queue_item.new","type":"string","x-stream-index":"001.002"}},"required":["type","created_at","custom"],"title":"ReviewQueueItemNewEvent","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"},"ReviewQueueItemResponse":{"properties":{"actions":{"description":"Moderation actions taken","items":{"$ref":"#/components/schemas/ActionLogResponse"},"title":"Actions","type":"array","x-stream-index":"024"},"activity":{"$ref":"#/components/schemas/EnrichedActivity","x-stream-index":"016"},"ai_text_severity":{"description":"AI-determined text severity","title":"AI Text Severity","type":"string","x-stream-index":"014"},"assigned_to":{"$ref":"#/components/schemas/UserResponse","description":"Moderator assigned to review this item","title":"Assigned To","x-stream-index":"021"},"bans":{"description":"Associated ban records","items":{"$ref":"#/components/schemas/Ban"},"title":"Bans","type":"array","x-stream-index":"022"},"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"018"},"completed_at":{"description":"When the review was completed","format":"date-time","title":"Completed At","type":"number","x-stream-index":"009"},"config_key":{"type":"string","x-stream-index":"028"},"created_at":{"description":"When the item was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"002"},"entity_creator":{"$ref":"#/components/schemas/EntityCreatorResponse","description":"Details about who created the entity","title":"Entity Creator","x-stream-index":"019"},"entity_creator_id":{"description":"ID of who created the entity","title":"Entity Creator ID","type":"string","x-stream-index":"020"},"entity_id":{"description":"ID of the entity being reviewed","title":"Entity ID","type":"string","x-stream-index":"005"},"entity_type":{"description":"Type of entity being reviewed","title":"Entity Type","type":"string","x-stream-index":"004"},"feeds_v2_activity":{"$ref":"#/components/schemas/EnrichedActivity","description":"Associated feed activity","title":"Feeds V2 Activity","x-stream-index":"025"},"feeds_v2_reaction":{"$ref":"#/components/schemas/Reaction","description":"Associated feed reaction","title":"Feeds V2 Reaction","x-stream-index":"026"},"flags":{"description":"Associated flag records","items":{"$ref":"#/components/schemas/ModerationFlagResponse"},"title":"Flags","type":"array","x-stream-index":"023"},"flags_count":{"format":"int32","type":"integer","x-stream-index":"029"},"id":{"description":"Unique identifier of the review queue item","title":"ID","type":"string","x-stream-index":"001"},"languages":{"description":"Detected languages in the content","items":{"type":"string"},"title":"Languages","type":"array","x-stream-index":"012"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Associated message details","title":"Message","x-stream-index":"015"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content being moderated","title":"Moderation Payload","x-stream-index":"006"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"017"},"recommended_action":{"description":"Suggested moderation action","title":"Recommended Action","type":"string","x-stream-index":"008"},"reviewed_at":{"description":"When the item was reviewed","format":"date-time","title":"Reviewed At","type":"number","x-stream-index":"010"},"reviewed_by":{"description":"ID of the moderator who reviewed the item","title":"Reviewed By","type":"string","x-stream-index":"011"},"severity":{"description":"Severity level of the content","format":"int32","title":"Severity","type":"integer","x-stream-index":"013"},"status":{"description":"Current status of the review","title":"Status","type":"string","x-stream-index":"007"},"teams":{"description":"Teams associated with this item","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"027"},"updated_at":{"description":"When the item was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"003"}},"required":["id","created_at","updated_at","entity_type","entity_id","status","recommended_action","reviewed_by","languages","severity","ai_text_severity","bans","flags","actions","flags_count"],"type":"object"},"ReviewQueueItemUpdatedEvent":{"description":"This event is sent when a moderation review queue item is updated","nullable":true,"properties":{"action":{"$ref":"#/components/schemas/ActionLogResponse","description":"The action log if any action was taken","title":"Action","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"flags":{"description":"The flags associated with this review queue item","items":{"$ref":"#/components/schemas/ModerationFlagResponse"},"title":"Flags","type":"array","x-stream-index":"003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"The review queue item that was updated","title":"ReviewQueueItem","x-stream-index":"002"},"type":{"default":"review_queue_item.updated","type":"string","x-stream-index":"001.002"}},"required":["type","created_at","custom"],"title":"ReviewQueueItemUpdatedEvent","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"},"RingSettings":{"properties":{"auto_cancel_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_timeout_ms","missed_call_timeout_ms"],"type":"object"},"RingSettingsResponse":{"properties":{"auto_cancel_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_timeout_ms","missed_call_timeout_ms"],"type":"object"},"Role":{"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"004"},"custom":{"description":"Whether this is a custom role or built-in","title":"Custom","type":"boolean","x-stream-index":"002"},"name":{"description":"Unique role name","title":"Name","type":"string","x-stream-index":"001"},"scopes":{"description":"List of scopes where this role is currently present. `.app` means that role is present in app-level grants","items":{"type":"string"},"title":"Scopes","type":"array","x-stream-index":"003"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"005"}},"required":["name","custom","scopes","created_at","updated_at"],"type":"object"},"RuleBuilderAction":{"properties":{"ban_options":{"$ref":"#/components/schemas/BanOptions","x-stream-index":"002"},"flag_content_options":{"$ref":"#/components/schemas/FlagContentOptions","x-stream-index":"004"},"flag_user_options":{"$ref":"#/components/schemas/FlagUserOptions","x-stream-index":"003"},"remove_content_options":{"$ref":"#/components/schemas/BlockContentOptions","x-stream-index":"005"},"type":{"type":"string","x-stream-index":"001"}},"type":"object"},"RuleBuilderCondition":{"properties":{"confidence":{"format":"float","type":"number","x-stream-index":"002"},"content_count_rule_params":{"$ref":"#/components/schemas/ContentCountRuleParameters","x-stream-index":"007"},"image_content_params":{"$ref":"#/components/schemas/ImageContentParameters","x-stream-index":"009"},"image_rule_params":{"$ref":"#/components/schemas/ImageRuleParameters","x-stream-index":"004"},"text_content_params":{"$ref":"#/components/schemas/TextContentParameters","x-stream-index":"008"},"text_rule_params":{"$ref":"#/components/schemas/TextRuleParameters","x-stream-index":"003"},"type":{"type":"string","x-stream-index":"001"},"user_created_within_params":{"$ref":"#/components/schemas/UserCreatedWithinParameters","x-stream-index":"011"},"user_custom_property_params":{"$ref":"#/components/schemas/UserCustomPropertyParameters","x-stream-index":"012"},"user_rule_params":{"$ref":"#/components/schemas/UserRuleParameters","x-stream-index":"006"},"video_content_params":{"$ref":"#/components/schemas/VideoContentParameters","x-stream-index":"010"},"video_rule_params":{"$ref":"#/components/schemas/VideoRuleParameters","x-stream-index":"005"}},"type":"object"},"RuleBuilderConditionGroup":{"properties":{"conditions":{"items":{"$ref":"#/components/schemas/RuleBuilderCondition"},"type":"array","x-stream-index":"002"},"logic":{"type":"string","x-stream-index":"001"}},"type":"object"},"RuleBuilderConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"rules":{"items":{"$ref":"#/components/schemas/RuleBuilderRule"},"type":"array","x-stream-index":"002"}},"type":"object"},"RuleBuilderRule":{"properties":{"action":{"$ref":"#/components/schemas/RuleBuilderAction","x-stream-index":"006"},"conditions":{"items":{"$ref":"#/components/schemas/RuleBuilderCondition"},"type":"array","x-stream-index":"003"},"cooldown_period":{"type":"string","x-stream-index":"007"},"groups":{"items":{"$ref":"#/components/schemas/RuleBuilderConditionGroup"},"type":"array","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"logic":{"type":"string","x-stream-index":"004"},"rule_type":{"type":"string","x-stream-index":"002"}},"required":["rule_type","action"],"type":"object"},"S3Request":{"description":"Config for creating Amazon S3 storage.","properties":{"s3_api_key":{"description":"The AWS API key. To use Amazon S3 as your storage provider, you have two authentication options: IAM role or API key. If you do not specify the `s3_api_key` parameter, Stream will use IAM role authentication. In that case make sure to have the correct IAM role configured for your application.","title":"S3ApiKey","type":"string","x-stream-index":"002"},"s3_custom_endpoint_url":{"description":"The custom endpoint for S3. If you want to use a custom endpoint, you must also provide the `s3_api_key` and `s3_secret` parameters.","title":"S3CustomEndpointURL","type":"string","x-stream-index":"004"},"s3_region":{"description":"The AWS region where the bucket is hosted","title":"S3Region","type":"string","x-stream-index":"001"},"s3_secret":{"description":"The AWS API Secret","title":"S3Secret","type":"string","x-stream-index":"003"}},"required":["s3_region"],"title":"S3Request","type":"object"},"SFUIDLastSeen":{"properties":{"id":{"type":"string","x-stream-index":"001.001"},"last_seen":{"format":"date-time","type":"number","x-stream-index":"002"},"process_start_time":{"format":"int64","type":"integer","x-stream-index":"001.002"}},"required":["id","process_start_time","last_seen"],"type":"object"},"STTEgressConfig":{"properties":{"closed_captions_enabled":{"type":"boolean","x-stream-index":"005"},"external_storage":{"$ref":"#/components/schemas/ExternalStorage","x-stream-index":"011"},"language":{"type":"string","x-stream-index":"008"},"storage_name":{"type":"string","x-stream-index":"010"},"translation_languages":{"items":{"type":"string"},"type":"array","x-stream-index":"009"},"translations_enabled":{"type":"boolean","x-stream-index":"006"},"upload_transcriptions":{"type":"boolean","x-stream-index":"004"},"whisper_server_base_url":{"type":"string","x-stream-index":"007"}},"type":"object"},"ScreensharingSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled"],"type":"object"},"ScreensharingSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled"],"type":"object"},"SearchPayload":{"properties":{"filter_conditions":{"additionalProperties":{},"description":"Channel filter conditions","maximum":100,"minimum":1,"title":"Channel filter","type":"object","x-stream-docs-page-id":"query_channels","x-stream-index":"002"},"limit":{"description":"Number of messages to return","format":"int32","title":"Limit","type":"integer","x-stream-index":"005"},"message_filter_conditions":{"additionalProperties":{},"description":"Message filter conditions","title":"Message filter","type":"object","x-stream-index":"003"},"message_options":{"$ref":"#/components/schemas/MessageOptions","x-stream-index":"004"},"next":{"description":"Pagination parameter. Cannot be used with non-zero offset.","title":"Next","type":"string","x-stream-index":"008"},"offset":{"description":"Pagination offset. Cannot be used with sort or next.","format":"int32","title":"Offset","type":"integer","x-stream-index":"006"},"query":{"description":"Search phrase","title":"Query","type":"string","x-stream-index":"001"},"sort":{"description":"Sort parameters. Cannot be used with non-zero offset","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"007"}},"required":["filter_conditions"],"type":"object"},"SearchResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"005.001"},"next":{"description":"Value to pass to the next search query in order to paginate","title":"Next","type":"string","x-stream-index":"003"},"previous":{"description":"Value that points to the previous page. Pass as the next value in a search query to paginate backwards","title":"Previous","type":"string","x-stream-index":"004"},"results":{"description":"Search results","items":{"$ref":"#/components/schemas/SearchResult"},"title":"Results","type":"array","x-stream-index":"001"},"results_warning":{"$ref":"#/components/schemas/SearchWarning","description":"Warning about the search results","title":"Results Warning","x-stream-index":"002"}},"required":["results","duration"],"type":"object"},"SearchResult":{"properties":{"message":{"$ref":"#/components/schemas/SearchResultMessage","description":"Found message","title":"Message","x-stream-index":"001"}},"type":"object"},"SearchResultMessage":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"001.008"},"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel object","title":"Channel","x-stream-index":"002"},"cid":{"type":"string","x-stream-index":"001.022"},"command":{"type":"string","x-stream-index":"001.004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.023"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.026"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.025"},"deleted_for_me":{"type":"boolean","x-stream-index":"001.044"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"001.018"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001.041"},"html":{"type":"string","x-stream-index":"001.005"},"i18n":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.030"},"id":{"type":"string","x-stream-index":"001.001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"001.028"},"latest_reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"001.009"},"mentioned_users":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"001.029"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"001.036"},"mml":{"type":"string","x-stream-index":"001.003"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"001.039"},"own_reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"001.010"},"parent_id":{"type":"string","x-stream-index":"001.015"},"pin_expires":{"format":"date-time","type":"number","x-stream-index":"001.035"},"pinned":{"type":"boolean","x-stream-index":"001.032"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"001.033"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001.034"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001.038"},"poll_id":{"type":"string","x-stream-index":"001.037"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001.020"},"quoted_message_id":{"type":"string","x-stream-index":"001.019"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001.011"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"001.014"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001.012"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"001.042"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"001.017"},"restricted_visibility":{"items":{"type":"string"},"type":"array","x-stream-index":"001.040"},"shadowed":{"type":"boolean","x-stream-index":"001.027"},"shared_location":{"$ref":"#/components/schemas/SharedLocationResponseData","x-stream-index":"001.043"},"show_in_channel":{"type":"boolean","x-stream-index":"001.016"},"silent":{"type":"boolean","x-stream-index":"001.031"},"text":{"type":"string","x-stream-index":"001.002"},"thread_participants":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"001.021"},"type":{"type":"string","x-stream-index":"001.006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.024"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001.007"}},"required":["id","text","html","type","user","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned","restricted_visibility"],"type":"object"},"SearchWarning":{"properties":{"channel_search_cids":{"description":"Channel CIDs for the searched channels","items":{"type":"string"},"title":"Channel Search CIDs","type":"array","x-stream-index":"004"},"channel_search_count":{"description":"Number of channels searched","format":"int32","title":"Channel Search Count","type":"integer","x-stream-index":"003"},"warning_code":{"description":"Code corresponding to the warning","format":"int32","title":"Warning Code","type":"integer","x-stream-index":"002"},"warning_description":{"description":"Description of the warning","title":"Warning Description","type":"string","x-stream-index":"001"}},"required":["warning_description","warning_code"],"type":"object"},"Segment":{"nullable":true,"properties":{"all_sender_channels":{"type":"boolean","x-stream-index":"007"},"all_users":{"type":"boolean","x-stream-index":"006"},"created_at":{"format":"date-time","type":"number","x-stream-index":"010"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"012"},"description":{"type":"string","x-stream-index":"004"},"filter":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"name":{"type":"string","x-stream-index":"003"},"size":{"format":"int32","type":"integer","x-stream-index":"009"},"task_id":{"type":"string","x-stream-index":"008"},"type":{"type":"string","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"011"}},"required":["id","type","name","all_users","all_sender_channels","size","created_at","updated_at"],"type":"object"},"SegmentResponse":{"properties":{"all_sender_channels":{"type":"boolean","x-stream-index":"007"},"all_users":{"type":"boolean","x-stream-index":"006"},"created_at":{"format":"date-time","type":"number","x-stream-index":"009"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"description":{"type":"string","x-stream-index":"004"},"filter":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"name":{"type":"string","x-stream-index":"003"},"size":{"format":"int32","type":"integer","x-stream-index":"008"},"type":{"type":"string","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"010"}},"required":["id","type","name","description","filter","all_users","all_sender_channels","size","created_at","updated_at","deleted_at"],"type":"object"},"SegmentTargetResponse":{"nullable":true,"properties":{"app_pk":{"format":"int32","type":"integer","x-stream-index":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"segment_id":{"type":"string","x-stream-index":"002"},"target_id":{"type":"string","x-stream-index":"003"}},"required":["app_pk","segment_id","target_id","created_at"],"type":"object"},"SendEventRequest":{"nullable":true,"properties":{"event":{"$ref":"#/components/schemas/EventRequest","x-stream-index":"001"}},"required":["event"],"type":"object"},"SendMessageRequest":{"nullable":true,"properties":{"force_moderation":{"type":"boolean","x-stream-index":"007"},"keep_channel_hidden":{"type":"boolean","x-stream-index":"008"},"message":{"$ref":"#/components/schemas/MessageRequest","x-stream-index":"001"},"pending":{"type":"boolean","x-stream-index":"006"},"pending_message_metadata":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"005"},"skip_enrich_url":{"type":"boolean","x-stream-index":"003"},"skip_push":{"type":"boolean","x-stream-index":"002"}},"required":["message"],"type":"object"},"SendMessageResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Message response","title":"Message","x-stream-index":"001"},"pending_message_metadata":{"additionalProperties":{"type":"string"},"description":"Pending message metadata","title":"Pending message metadata","type":"object","x-stream-index":"002"}},"required":["message","duration"],"type":"object"},"SendReactionRequest":{"nullable":true,"properties":{"enforce_unique":{"description":"Whether to replace all existing user reactions","title":"Enforce unique","type":"boolean","x-stream-index":"003"},"reaction":{"$ref":"#/components/schemas/ReactionRequest","x-stream-index":"002"},"skip_push":{"description":"Skips any mobile push notifications","title":"Skip push","type":"boolean","x-stream-index":"004"}},"required":["reaction"],"type":"object"},"SendReactionResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001"},"reaction":{"$ref":"#/components/schemas/ReactionResponse","x-stream-index":"002"}},"required":["message","reaction","duration"],"title":"Response","type":"object"},"SendUserCustomEventRequest":{"nullable":true,"properties":{"event":{"$ref":"#/components/schemas/UserCustomEventRequest","x-stream-index":"001"}},"required":["event"],"type":"object"},"SessionSettings":{"properties":{"inactivity_timeout_seconds":{"format":"int32","maximum":900,"minimum":5,"type":"integer","x-stream-index":"001"}},"required":["inactivity_timeout_seconds"],"type":"object"},"SessionSettingsResponse":{"properties":{"inactivity_timeout_seconds":{"format":"int32","maximum":900,"minimum":5,"type":"integer","x-stream-index":"001"}},"required":["inactivity_timeout_seconds"],"type":"object"},"ShadowBlockActionRequest":{"type":"object"},"SharedLocation":{"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"013"},"channel_cid":{"type":"string","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"010"},"created_by_device_id":{"type":"string","x-stream-index":"008"},"end_at":{"format":"date-time","type":"number","x-stream-index":"009"},"latitude":{"format":"float","maximum":90,"minimum":18446744073709552000,"type":"number","x-stream-index":"006"},"longitude":{"format":"float","maximum":180,"minimum":18446744073709552000,"type":"number","x-stream-index":"007"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"012"},"message_id":{"type":"string","x-stream-index":"004"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"011"},"user_id":{"type":"string","x-stream-index":"005"}},"required":["channel_cid","message_id","user_id","created_by_device_id","created_at","updated_at"],"type":"object"},"SharedLocationResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001.011"},"channel_cid":{"description":"Channel CID","title":"string","type":"string","x-stream-index":"001.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.008"},"created_by_device_id":{"description":"Device ID that created the live location","title":"string","type":"string","x-stream-index":"001.006"},"duration":{"type":"string","x-stream-index":"002.001"},"end_at":{"description":"Time when the live location expires","format":"date-time","title":"string","type":"number","x-stream-index":"001.007"},"latitude":{"description":"Latitude coordinate","format":"float","title":"number","type":"number","x-stream-index":"001.004"},"longitude":{"description":"Longitude coordinate","format":"float","title":"number","type":"number","x-stream-index":"001.005"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001.010"},"message_id":{"description":"Message ID","title":"string","type":"string","x-stream-index":"001.002"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.009"},"user_id":{"description":"User ID","title":"string","type":"string","x-stream-index":"001.003"}},"required":["channel_cid","message_id","user_id","latitude","longitude","created_by_device_id","created_at","updated_at","duration"],"type":"object"},"SharedLocationResponseData":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"011"},"channel_cid":{"type":"string","x-stream-index":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"created_by_device_id":{"type":"string","x-stream-index":"006"},"end_at":{"format":"date-time","type":"number","x-stream-index":"007"},"latitude":{"format":"float","type":"number","x-stream-index":"004"},"longitude":{"format":"float","type":"number","x-stream-index":"005"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"010"},"message_id":{"type":"string","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["channel_cid","message_id","user_id","latitude","longitude","created_by_device_id","created_at","updated_at"],"type":"object"},"SharedLocationsResponse":{"nullable":true,"properties":{"active_live_locations":{"items":{"$ref":"#/components/schemas/SharedLocationResponseData"},"type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["active_live_locations","duration"],"type":"object"},"ShowChannelRequest":{"nullable":true,"properties":{"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"002.002"},"user_id":{"type":"string","x-stream-index":"002.001"}},"type":"object"},"ShowChannelResponse":{"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"},"SortParam":{"nullable":true,"properties":{"direction":{"format":"int32","type":"integer","x-stream-index":"002"},"field":{"type":"string","x-stream-index":"001"}},"type":"object"},"SortParamRequest":{"nullable":true,"properties":{"direction":{"description":"Direction of sorting, 1 for Ascending, -1 for Descending, default is 1","format":"int32","title":"Direction","type":"integer","x-stream-index":"002"},"field":{"description":"Name of field to sort by","title":"Field","type":"string","x-stream-index":"001"}},"type":"object"},"StartCampaignRequest":{"nullable":true,"properties":{"scheduled_for":{"format":"date-time","type":"number","x-stream-index":"002"},"stop_at":{"format":"date-time","type":"number","x-stream-index":"003"}},"type":"object"},"StartCampaignResponse":{"description":"Basic response information","nullable":true,"properties":{"campaign":{"$ref":"#/components/schemas/CampaignResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"users":{"$ref":"#/components/schemas/PagerResponse","x-stream-index":"002"}},"required":["duration"],"title":"Response","type":"object"},"StopCampaignRequest":{"nullable":true,"type":"object"},"SubmitActionRequest":{"nullable":true,"properties":{"action_type":{"description":"Type of moderation action to perform (mark_reviewed, delete_message, etc.)","enum":["mark_reviewed","delete_message","delete_activity","delete_reaction","ban","custom","unban","restore","delete_user","unblock","shadow_block","unmask","kick_user","end_call"],"title":"Action Type","type":"string","x-stream-index":"002"},"ban":{"$ref":"#/components/schemas/BanActionRequest","description":"Configuration for ban action","title":"Ban","x-stream-index":"008"},"custom":{"$ref":"#/components/schemas/CustomActionRequest","description":"Configuration for custom action","title":"Custom","x-stream-index":"009"},"delete_activity":{"$ref":"#/components/schemas/DeleteActivityRequest","description":"Configuration for activity deletion action","title":"Delete Activity","x-stream-index":"004"},"delete_message":{"$ref":"#/components/schemas/DeleteMessageRequest","description":"Configuration for message deletion action","title":"Delete Message","x-stream-index":"003"},"delete_reaction":{"$ref":"#/components/schemas/DeleteReactionRequest","description":"Configuration for reaction deletion action","title":"Delete Reaction","x-stream-index":"005"},"delete_user":{"$ref":"#/components/schemas/DeleteUserRequest","description":"Configuration for user deletion action","title":"Delete User","x-stream-index":"006"},"item_id":{"description":"UUID of the review queue item to act on","title":"Item ID","type":"string","x-stream-index":"001"},"mark_reviewed":{"$ref":"#/components/schemas/MarkReviewedRequest","description":"Configuration for marking item as reviewed","title":"Mark Reviewed","x-stream-index":"007"},"unban":{"$ref":"#/components/schemas/UnbanActionRequest","description":"Configuration for unban action","title":"Unban","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"016.002"},"user_id":{"type":"string","x-stream-index":"016.001"}},"required":["item_id","action_type"],"type":"object"},"SubmitActionResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"Updated review queue item after action was performed","title":"Item","x-stream-index":"001"}},"required":["duration"],"type":"object"},"TargetResolution":{"properties":{"bitrate":{"format":"int32","maximum":6000000,"type":"integer","x-stream-index":"003"},"height":{"format":"int32","maximum":3840,"minimum":240,"type":"integer","x-stream-index":"002"},"width":{"format":"int32","maximum":3840,"minimum":240,"type":"integer","x-stream-index":"001"}},"required":["width","height","bitrate"],"type":"object"},"TextContentParameters":{"properties":{"blocklist_match":{"items":{"type":"string"},"type":"array","x-stream-index":"005"},"contains_url":{"type":"boolean","x-stream-index":"003"},"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001"},"llm_harm_labels":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"002"},"severity":{"type":"string","x-stream-index":"004"}},"type":"object"},"TextRuleParameters":{"properties":{"blocklist_match":{"items":{"type":"string"},"type":"array","x-stream-index":"007"},"contains_url":{"type":"boolean","x-stream-index":"005"},"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"llm_harm_labels":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"004"},"severity":{"type":"string","x-stream-index":"006"},"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"type":"object"},"ThreadParticipant":{"description":"Represents a user that is participating in a thread.","nullable":true,"properties":{"app_pk":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"001"},"channel_cid":{"type":"string","x-stream-index":"002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"007"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"last_read_at":{"format":"date-time","type":"number","x-stream-index":"009"},"last_thread_message_at":{"format":"date-time","type":"number","x-stream-index":"003"},"left_thread_at":{"description":"Left Thread At is the time when the user left the thread","format":"date-time","title":"Left Thread At","type":"number","x-stream-index":"008"},"thread_id":{"description":"Thead ID is unique string identifier of the thread","title":"ID","type":"string","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User is the user object","title":"User","x-stream-index":"006"},"user_id":{"description":"User ID is unique string identifier of the user","title":"User ID","type":"string","x-stream-index":"005"}},"required":["app_pk","channel_cid","created_at","last_read_at","custom"],"title":"ThreadParticipant","type":"object"},"ThreadResponse":{"properties":{"active_participant_count":{"description":"Active Participant Count","format":"int32","title":"Active Participant Count","type":"integer","x-stream-index":"009"},"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel","title":"ChannelResponse","x-stream-index":"002"},"channel_cid":{"description":"Channel CID","title":"Channel CID","type":"string","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"012"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"Created By User","title":"User","x-stream-index":"006"},"created_by_user_id":{"description":"Created By User ID","title":"Created By User ID","type":"string","x-stream-index":"005"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"016"},"deleted_at":{"description":"Deleted At","format":"date-time","title":"Deleted At","type":"number","x-stream-index":"014"},"last_message_at":{"description":"Last Message At","format":"date-time","title":"Last Message At","type":"number","x-stream-index":"011"},"parent_message":{"$ref":"#/components/schemas/MessageResponse","description":"Parent Message","title":"Message","x-stream-index":"004"},"parent_message_id":{"description":"Parent Message ID","title":"Parent Message ID","type":"string","x-stream-index":"003"},"participant_count":{"description":"Participant Count","format":"int32","title":"Participant Count","type":"integer","x-stream-index":"008"},"reply_count":{"description":"Reply Count","format":"int32","title":"Reply Count","type":"integer","x-stream-index":"007"},"thread_participants":{"description":"Thread Participants","items":{"$ref":"#/components/schemas/ThreadParticipant"},"title":"ThreadParticipants","type":"array","x-stream-index":"010"},"title":{"description":"Title","title":"Title","type":"string","x-stream-index":"015"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"013"}},"required":["channel_cid","parent_message_id","created_by_user_id","created_at","updated_at","title","custom"],"type":"object"},"ThreadStateResponse":{"nullable":true,"properties":{"active_participant_count":{"description":"Active Participant Count","format":"int32","title":"Active Participant Count","type":"integer","x-stream-index":"001.009"},"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel","title":"ChannelResponse","x-stream-index":"001.002"},"channel_cid":{"description":"Channel CID","title":"Channel CID","type":"string","x-stream-index":"001.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.012"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"Created By User","title":"User","x-stream-index":"001.006"},"created_by_user_id":{"description":"Created By User ID","title":"Created By User ID","type":"string","x-stream-index":"001.005"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"001.016"},"deleted_at":{"description":"Deleted At","format":"date-time","title":"Deleted At","type":"number","x-stream-index":"001.014"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"004"},"last_message_at":{"description":"Last Message At","format":"date-time","title":"Last Message At","type":"number","x-stream-index":"001.011"},"latest_replies":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","x-stream-index":"002"},"parent_message":{"$ref":"#/components/schemas/MessageResponse","description":"Parent Message","title":"Message","x-stream-index":"001.004"},"parent_message_id":{"description":"Parent Message ID","title":"Parent Message ID","type":"string","x-stream-index":"001.003"},"participant_count":{"description":"Participant Count","format":"int32","title":"Participant Count","type":"integer","x-stream-index":"001.008"},"read":{"items":{"$ref":"#/components/schemas/ReadStateResponse"},"type":"array","x-stream-index":"003"},"reply_count":{"description":"Reply Count","format":"int32","title":"Reply Count","type":"integer","x-stream-index":"001.007"},"thread_participants":{"description":"Thread Participants","items":{"$ref":"#/components/schemas/ThreadParticipant"},"title":"ThreadParticipants","type":"array","x-stream-index":"001.010"},"title":{"description":"Title","title":"Title","type":"string","x-stream-index":"001.015"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.013"}},"required":["channel_cid","parent_message_id","created_by_user_id","created_at","updated_at","title","custom","latest_replies"],"type":"object"},"ThreadUpdatedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"001.002"},"channel_type":{"type":"string","x-stream-index":"001.003"},"cid":{"type":"string","x-stream-index":"001.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"thread":{"$ref":"#/components/schemas/ThreadResponse","x-stream-index":"003.001"},"type":{"default":"thread.updated","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"ThreadUpdatedEvent","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"},"Thresholds":{"description":"Sets thresholds for AI moderation","properties":{"explicit":{"$ref":"#/components/schemas/LabelThresholds","description":"Thresholds for explicit messages","title":"LabelThresholds","x-stream-index":"001"},"spam":{"$ref":"#/components/schemas/LabelThresholds","description":"Thresholds for spam","title":"LabelThresholds","x-stream-index":"002"},"toxic":{"$ref":"#/components/schemas/LabelThresholds","description":"Thresholds for toxic messages","title":"LabelThresholds","x-stream-index":"003"}},"title":"Auto moderation thresholds","type":"object"},"ThumbnailResponse":{"properties":{"image_url":{"type":"string","x-stream-index":"001"}},"required":["image_url"],"type":"object"},"ThumbnailsSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"ThumbnailsSettingsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"Time":{"type":"object"},"TranscriptionSettings":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"title":"Mode","type":"string","x-stream-index":"002"},"language":{"description":"The language used in this call as a two letter code","enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"title":"Language","type":"string","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"title":"Mode","type":"string","x-stream-index":"001"}},"required":["mode","closed_caption_mode","languages","language"],"type":"object"},"TranscriptionSettingsResponse":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"002"},"language":{"enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"type":"string","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode","closed_caption_mode","languages","language"],"type":"object"},"TranslateMessageRequest":{"nullable":true,"properties":{"language":{"description":"Language to translate message to","enum":["af","sq","am","ar","az","bn","bs","bg","zh","zh-TW","hr","cs","da","fa-AF","nl","en","et","fi","fr","fr-CA","ka","de","el","ha","he","hi","hu","id","it","ja","ko","lv","ms","no","fa","ps","pl","pt","ro","ru","sr","sk","sl","so","es","es-MX","sw","sv","tl","ta","th","tr","uk","ur","vi","lt","ht"],"title":"Language","type":"string","x-stream-index":"001"}},"required":["language"],"type":"object"},"TruncateChannelRequest":{"nullable":true,"properties":{"hard_delete":{"description":"Permanently delete channel data (messages, reactions, etc.)","title":"Hard delete","type":"boolean","x-stream-index":"002"},"member_ids":{"description":"List of member IDs to hide message history for. If empty, truncates the channel for all members","items":{"type":"string"},"maximum":100,"title":"Member IDs","type":"array","x-stream-index":"007"},"message":{"$ref":"#/components/schemas/MessageRequest","x-stream-index":"004"},"skip_push":{"description":"When `message` is set disables all push notifications for it","title":"Skip push","type":"boolean","x-stream-index":"005"},"truncated_at":{"description":"Truncate channel data up to `truncated_at`. The system message (if provided) creation time is always greater than `truncated_at`","format":"date-time","title":"Truncated at","type":"number","x-stream-index":"006"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"008.002"},"user_id":{"type":"string","x-stream-index":"008.001"}},"type":"object"},"TruncateChannelResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Truncated channel object","title":"Channel","x-stream-index":"002"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Truncated message object","title":"Message","x-stream-index":"003"}},"required":["duration"],"type":"object"},"TypingIndicators":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"TypingIndicatorsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"UnbanActionRequest":{"type":"object"},"UnbanRequest":{"nullable":true,"properties":{"unbanned_by":{"$ref":"#/components/schemas/UserRequest","description":"Details about the user performing the unban","title":"Unbanned By","x-stream-index":"005"},"unbanned_by_id":{"description":"ID of the user performing the unban","title":"Unbanned By ID","type":"string","x-stream-index":"004"}},"type":"object"},"UnbanResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"UnblockActionRequest":{"type":"object"},"UnblockUsersRequest":{"nullable":true,"properties":{"blocked_user_id":{"type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"required":["blocked_user_id"],"type":"object"},"UnblockUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"UnmuteChannelRequest":{"nullable":true,"properties":{"channel_cids":{"description":"Channel CIDs to mute (if multiple channels)","items":{"type":"string"},"maximum":25,"title":"Channel CIDs","type":"array","x-stream-index":"001.002"},"expiration":{"description":"Duration of mute in milliseconds","title":"Expiration","type":"integer","x-stream-index":"001.003"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"002.002"},"user_id":{"type":"string","x-stream-index":"002.001"}},"type":"object"},"UnmuteRequest":{"nullable":true,"properties":{"target_ids":{"description":"User IDs to unmute","items":{"type":"string"},"title":"Target IDs","type":"array","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"002.002"},"user_id":{"type":"string","x-stream-index":"002.001"}},"required":["target_ids"],"title":"UnmuteRequest","type":"object"},"UnmuteResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"non_existing_users":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"required":["duration"],"title":"Response","type":"object"},"UnreadCountsBatchRequest":{"nullable":true,"properties":{"user_ids":{"items":{"type":"string"},"maximum":100,"type":"array","x-stream-index":"001"}},"required":["user_ids"],"type":"object"},"UnreadCountsBatchResponse":{"description":"Basic response information","nullable":true,"properties":{"counts_by_user":{"additionalProperties":{"$ref":"#/components/schemas/UnreadCountsResponse"},"type":"object","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["counts_by_user","duration"],"title":"Response","type":"object"},"UnreadCountsChannel":{"properties":{"channel_id":{"type":"string","x-stream-index":"001"},"last_read":{"format":"date-time","type":"number","x-stream-index":"003"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["channel_id","unread_count","last_read"],"type":"object"},"UnreadCountsChannelType":{"properties":{"channel_count":{"format":"int32","type":"integer","x-stream-index":"002"},"channel_type":{"type":"string","x-stream-index":"001"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["channel_type","channel_count","unread_count"],"type":"object"},"UnreadCountsResponse":{"nullable":true,"properties":{"channel_type":{"items":{"$ref":"#/components/schemas/UnreadCountsChannelType"},"type":"array","x-stream-index":"005"},"channels":{"items":{"$ref":"#/components/schemas/UnreadCountsChannel"},"type":"array","x-stream-index":"004"},"threads":{"items":{"$ref":"#/components/schemas/UnreadCountsThread"},"type":"array","x-stream-index":"006"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"001"},"total_unread_count_by_team":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"003"},"total_unread_threads_count":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["total_unread_count","total_unread_threads_count","channels","channel_type","threads"],"type":"object"},"UnreadCountsThread":{"properties":{"last_read":{"format":"date-time","type":"number","x-stream-index":"002"},"last_read_message_id":{"type":"string","x-stream-index":"003"},"parent_message_id":{"type":"string","x-stream-index":"004"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"001"}},"required":["unread_count","last_read","last_read_message_id","parent_message_id"],"type":"object"},"UpdateAppRequest":{"nullable":true,"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.017"},"apn_config":{"$ref":"#/components/schemas/APNConfig","x-stream-index":"001.003"},"async_moderation_config":{"$ref":"#/components/schemas/AsyncModerationConfiguration","x-stream-index":"001.039"},"async_url_enrich_enabled":{"type":"boolean","x-stream-index":"001.019"},"auto_translation_enabled":{"type":"boolean","x-stream-index":"001.018"},"before_message_send_hook_url":{"type":"string","x-stream-index":"001.020"},"cdn_expiration_seconds":{"format":"int32","maximum":1209600,"minimum":14400,"type":"integer","x-stream-index":"001.038"},"channel_hide_members_only":{"type":"boolean","x-stream-index":"001.033"},"custom_action_handler_url":{"type":"string","x-stream-index":"001.021"},"datadog_info":{"$ref":"#/components/schemas/DataDogInfo","x-stream-index":"001.040"},"disable_auth_checks":{"type":"boolean","x-stream-index":"001.001"},"disable_permissions_checks":{"type":"boolean","x-stream-index":"001.002"},"enforce_unique_usernames":{"enum":["no","app","team"],"type":"string","x-stream-index":"001.022"},"event_hooks":{"items":{"$ref":"#/components/schemas/EventHook"},"type":"array","x-stream-index":"001.046"},"feeds_moderation_enabled":{"type":"boolean","x-stream-index":"001.042"},"feeds_v2_region":{"type":"string","x-stream-index":"001.041"},"file_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","x-stream-index":"001.030"},"firebase_config":{"$ref":"#/components/schemas/FirebaseConfig","x-stream-index":"001.004"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"001.034"},"guest_user_creation_disabled":{"type":"boolean","x-stream-index":"001.043"},"huawei_config":{"$ref":"#/components/schemas/HuaweiConfig","x-stream-index":"001.005"},"image_moderation_block_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001.015"},"image_moderation_enabled":{"type":"boolean","x-stream-index":"001.016"},"image_moderation_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001.014"},"image_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","x-stream-index":"001.029"},"max_aggregated_activities_length":{"format":"int32","type":"integer","x-stream-index":"001.049"},"migrate_permissions_to_v2":{"type":"boolean","x-stream-index":"001.035"},"moderation_dashboard_preferences":{"$ref":"#/components/schemas/ModerationDashboardPreferences","x-stream-index":"001.044"},"moderation_enabled":{"type":"boolean","x-stream-index":"001.009"},"moderation_webhook_url":{"type":"string","x-stream-index":"001.010"},"multi_tenant_enabled":{"type":"boolean","x-stream-index":"001.013"},"permission_version":{"enum":["v1","v2"],"type":"string","x-stream-index":"001.011"},"push_config":{"$ref":"#/components/schemas/PushConfig","x-stream-index":"001.007"},"reminders_interval":{"format":"int32","maximum":86400,"minimum":60,"type":"integer","x-stream-index":"001.036"},"reminders_max_members":{"format":"int32","minimum":2,"type":"integer","x-stream-index":"001.037"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.031"},"sns_key":{"type":"string","x-stream-index":"001.027"},"sns_secret":{"type":"string","x-stream-index":"001.028"},"sns_topic_arn":{"type":"string","x-stream-index":"001.026"},"sqs_key":{"type":"string","x-stream-index":"001.024"},"sqs_secret":{"type":"string","x-stream-index":"001.025"},"sqs_url":{"type":"string","x-stream-index":"001.023"},"user_response_time_enabled":{"type":"boolean","x-stream-index":"001.048"},"user_search_disallowed_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"001.012"},"webhook_events":{"items":{"type":"string"},"type":"array","x-stream-index":"001.032"},"webhook_url":{"type":"string","x-stream-index":"001.008"},"xiaomi_config":{"$ref":"#/components/schemas/XiaomiConfig","x-stream-index":"001.006"}},"type":"object"},"UpdateBlockListRequest":{"nullable":true,"properties":{"team":{"type":"string","x-stream-index":"002"},"words":{"description":"List of words to block","items":{"type":"string"},"minimum":1,"title":"Words","type":"array","x-stream-index":"003"}},"title":"Update block list","type":"object","x-stream-docs-page-id":"update_block_list"},"UpdateBlockListResponse":{"description":"Basic response information","nullable":true,"properties":{"blocklist":{"$ref":"#/components/schemas/BlockListResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["duration"],"title":"Response","type":"object"},"UpdateChannelPartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"type":"object","x-stream-index":"002.001"},"unset":{"items":{"type":"string"},"type":"array","x-stream-index":"002.002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"title":"UpdateChannelPartialRequest","type":"object"},"UpdateChannelPartialResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Updated channel object","title":"Channel","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"members":{"description":"List of updated members","items":{"$ref":"#/components/schemas/ChannelMemberResponse"},"title":"ChannelMemberResponse","type":"array","x-stream-index":"002"}},"required":["members","duration"],"type":"object"},"UpdateChannelRequest":{"nullable":true,"properties":{"accept_invite":{"description":"Set to `true` to accept the invite","title":"Accept invite","type":"boolean","x-stream-index":"008"},"add_members":{"description":"List of user IDs to add to the channel","items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"title":"Add members","type":"array","x-stream-index":"001"},"add_moderators":{"description":"List of user IDs to make channel moderators","items":{"type":"string"},"maximum":100,"title":"Add moderators","type":"array","x-stream-index":"003"},"assign_roles":{"description":"List of channel member role assignments. If any specified user is not part of the channel, the request will fail","items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"title":"Assign roles","type":"array","x-stream-index":"006"},"cooldown":{"description":"Sets cool down period for the channel in seconds","format":"int32","maximum":120,"minimum":0,"title":"Cool down","type":"integer","x-stream-index":"007"},"data":{"$ref":"#/components/schemas/ChannelInput","x-stream-index":"013.001"},"demote_moderators":{"description":"List of user IDs to take away moderators status from","items":{"type":"string"},"maximum":100,"title":"Demote moderators","type":"array","x-stream-index":"004"},"hide_history":{"description":"Set to `true` to hide channel's history when adding new members","title":"Hide history","type":"boolean","x-stream-index":"012"},"invites":{"description":"List of user IDs to invite to the channel","items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"title":"Invites","type":"array","x-stream-index":"005"},"message":{"$ref":"#/components/schemas/MessageRequest","description":"Message to send to the chat when channel is successfully updated","title":"Message","x-stream-index":"010"},"reject_invite":{"description":"Set to `true` to reject the invite","title":"Reject invite","type":"boolean","x-stream-index":"009"},"remove_members":{"description":"List of user IDs to remove from the channel","items":{"type":"string"},"maximum":100,"title":"Remove members","type":"array","x-stream-index":"002"},"skip_push":{"description":"When `message` is set disables all push notifications for it","title":"Skip push","type":"boolean","x-stream-index":"011"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"014.002"},"user_id":{"type":"string","x-stream-index":"014.001"}},"title":"Channel update request","type":"object","x-stream-docs-page-id":"channel_update"},"UpdateChannelResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Updated channel","title":"Channel","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"004.001"},"members":{"description":"List of channel members","items":{"$ref":"#/components/schemas/ChannelMember"},"title":"Members","type":"array","x-stream-index":"003"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Message sent to the chat","title":"Message","x-stream-index":"002"}},"required":["members","duration"],"type":"object"},"UpdateChannelTypeRequest":{"nullable":true,"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"009.001.027"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"009.001.022"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"009.001.023"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"009.001.028"},"blocklist":{"type":"string","x-stream-index":"009.001.024"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"009.001.025"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"009.001.026"},"commands":{"description":"List of commands that channel supports","items":{"type":"string"},"title":"Commands","type":"array","x-stream-index":"009.003"},"connect_events":{"type":"boolean","x-stream-index":"009.001.004"},"count_messages":{"type":"boolean","x-stream-index":"009.001.019"},"custom_events":{"type":"boolean","x-stream-index":"009.001.012"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"004"},"mark_messages_pending":{"type":"boolean","x-stream-index":"009.001.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"009.001.021"},"mutes":{"type":"boolean","x-stream-index":"009.001.009"},"partition_size":{"format":"int32","minimum":0,"type":"integer","x-stream-index":"007"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"008"},"permissions":{"items":{"$ref":"#/components/schemas/PolicyRequest"},"type":"array","x-stream-index":"003"},"polls":{"type":"boolean","x-stream-index":"009.001.016"},"push_notifications":{"type":"boolean","x-stream-index":"009.001.013"},"quotes":{"type":"boolean","x-stream-index":"009.001.008"},"reactions":{"type":"boolean","x-stream-index":"009.001.006"},"read_events":{"type":"boolean","x-stream-index":"009.001.003"},"reminders":{"type":"boolean","x-stream-index":"009.001.014"},"replies":{"type":"boolean","x-stream-index":"009.001.007"},"search":{"type":"boolean","x-stream-index":"009.001.005"},"shared_locations":{"type":"boolean","x-stream-index":"009.001.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"009.001.031"},"typing_events":{"type":"boolean","x-stream-index":"009.001.002"},"uploads":{"type":"boolean","x-stream-index":"009.001.010"},"url_enrichment":{"type":"boolean","x-stream-index":"009.001.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"009.001.017"}},"required":["max_message_length","automod","automod_behavior"],"type":"object"},"UpdateChannelTypeResponse":{"nullable":true,"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"003.001.027"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"003.001.022"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.001.023"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"003.001.028"},"blocklist":{"type":"string","x-stream-index":"003.001.024"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.001.025"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"003.001.026"},"commands":{"items":{"type":"string"},"type":"array","x-stream-index":"003.003"},"connect_events":{"type":"boolean","x-stream-index":"003.001.004"},"count_messages":{"type":"boolean","x-stream-index":"003.001.019"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002.003"},"custom_events":{"type":"boolean","x-stream-index":"003.001.012"},"duration":{"type":"string","x-stream-index":"004.001"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"002"},"mark_messages_pending":{"type":"boolean","x-stream-index":"003.001.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"003.001.021"},"mutes":{"type":"boolean","x-stream-index":"003.001.009"},"name":{"type":"string","x-stream-index":"003.001.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"003.001.029"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"003.001.030"},"permissions":{"items":{"$ref":"#/components/schemas/PolicyRequest"},"type":"array","x-stream-index":"001"},"polls":{"type":"boolean","x-stream-index":"003.001.016"},"push_notifications":{"type":"boolean","x-stream-index":"003.001.013"},"quotes":{"type":"boolean","x-stream-index":"003.001.008"},"reactions":{"type":"boolean","x-stream-index":"003.001.006"},"read_events":{"type":"boolean","x-stream-index":"003.001.003"},"reminders":{"type":"boolean","x-stream-index":"003.001.014"},"replies":{"type":"boolean","x-stream-index":"003.001.007"},"search":{"type":"boolean","x-stream-index":"003.001.005"},"shared_locations":{"type":"boolean","x-stream-index":"003.001.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"003.001.031"},"typing_events":{"type":"boolean","x-stream-index":"003.001.002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"003.002.004"},"uploads":{"type":"boolean","x-stream-index":"003.001.010"},"url_enrichment":{"type":"boolean","x-stream-index":"003.001.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"003.001.017"}},"required":["permissions","grants","name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","count_messages","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","created_at","updated_at","commands","duration"],"type":"object"},"UpdateCommandRequest":{"nullable":true,"properties":{"args":{"description":"Arguments help text, shown in commands auto-completion","maxLength":255,"title":"Arguments","type":"string","x-stream-index":"003"},"description":{"description":"Description, shown in commands auto-completion","maxLength":255,"title":"Description","type":"string","x-stream-index":"002"},"set":{"description":"Set name used for grouping commands","maxLength":255,"title":"Set","type":"string","x-stream-index":"004"}},"required":["description"],"title":"UpdateCommandRequest","type":"object"},"UpdateCommandResponse":{"nullable":true,"properties":{"command":{"$ref":"#/components/schemas/Command","description":"Command object","title":"Command","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["duration"],"title":"UpdateCommandResponse","type":"object"},"UpdateExternalStorageRequest":{"description":"External storage","nullable":true,"properties":{"aws_s3":{"$ref":"#/components/schemas/S3Request","description":"Only required if you want to create an Amazon S3 storage","title":"AwsS3","x-stream-index":"003.004"},"azure_blob":{"$ref":"#/components/schemas/AzureRequest","description":"Only required if you want to create an Azure Blob Storage","title":"AzureBlob","x-stream-index":"003.006"},"bucket":{"description":"The name of the bucket on the service provider","title":"Bucket","type":"string","x-stream-index":"003.002"},"gcs_credentials":{"type":"string","x-stream-index":"003.005"},"path":{"description":"The path prefix to use for storing files","title":"Path","type":"string","x-stream-index":"003.003"},"storage_type":{"description":"The type of storage to use","enum":["s3","gcs","abs"],"title":"StorageType","type":"string","x-stream-index":"003.001"}},"required":["storage_type","bucket"],"title":"ExternalStorageRequest","type":"object"},"UpdateExternalStorageResponse":{"description":"Basic response information","nullable":true,"properties":{"bucket":{"type":"string","x-stream-index":"001.003"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"name":{"type":"string","x-stream-index":"001.001"},"path":{"type":"string","x-stream-index":"001.004"},"type":{"enum":["s3","gcs","abs"],"type":"string","x-stream-index":"001.002"}},"required":["name","type","bucket","path","duration"],"title":"Response","type":"object"},"UpdateLiveLocationRequest":{"nullable":true,"properties":{"end_at":{"description":"Time when the live location expires","format":"date-time","title":"string","type":"number","x-stream-index":"004"},"latitude":{"description":"Latitude coordinate","format":"float","maximum":90,"minimum":18446744073709552000,"title":"number","type":"number","x-stream-index":"002"},"longitude":{"description":"Longitude coordinate","format":"float","maximum":180,"minimum":18446744073709552000,"title":"number","type":"number","x-stream-index":"003"},"message_id":{"description":"Live location ID","title":"string","type":"string","x-stream-index":"001"}},"required":["message_id"],"type":"object"},"UpdateMemberPartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"type":"object","x-stream-index":"002.001"},"unset":{"items":{"type":"string"},"type":"array","x-stream-index":"002.002"}},"type":"object"},"UpdateMemberPartialResponse":{"nullable":true,"properties":{"channel_member":{"$ref":"#/components/schemas/ChannelMemberResponse","description":"Updated channel member","title":"Channel member","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["duration"],"type":"object"},"UpdateMessagePartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"description":"Sets new field values","title":"Set","type":"object","x-stream-index":"002.001","x-stream-map":{"key":"field","title":"Value","description":"New value to set"}},"skip_enrich_url":{"description":"Skip enriching the URL in the message","title":"SkipEnrichURL","type":"boolean","x-stream-index":"001"},"unset":{"description":"Array of field names to unset","items":{"type":"string"},"title":"Unset","type":"array","x-stream-index":"002.002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"type":"object"},"UpdateMessagePartialResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Updated message","title":"Message","x-stream-index":"001"},"pending_message_metadata":{"additionalProperties":{"type":"string"},"description":"Pending message metadata","title":"PendingMessageMetadata","type":"object","x-stream-index":"002"}},"required":["duration"],"type":"object"},"UpdateMessageRequest":{"nullable":true,"properties":{"message":{"$ref":"#/components/schemas/MessageRequest","description":"Message","title":"MessageRequest","x-stream-index":"001"},"skip_enrich_url":{"description":"Skip enrich URL","title":"boolean","type":"boolean","x-stream-index":"003"},"skip_push":{"type":"boolean","x-stream-index":"002"}},"required":["message"],"type":"object"},"UpdateMessageResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001"},"pending_message_metadata":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"002"}},"required":["message","duration"],"title":"Response","type":"object"},"UpdatePollOptionRequest":{"nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"004"},"id":{"description":"Option ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"},"text":{"description":"Option text","title":"string","type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"005.002"},"user_id":{"type":"string","x-stream-index":"005.001"}},"required":["id","text"],"type":"object"},"UpdatePollPartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"description":"Sets new field values","title":"Set","type":"object","x-stream-index":"002.001","x-stream-map":{"key":"field","title":"Value","description":"New value to set"}},"unset":{"description":"Array of field names to unset","items":{"type":"string"},"title":"Unset","type":"array","x-stream-index":"002.002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"type":"object"},"UpdatePollRequest":{"nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"011"},"allow_answers":{"description":"Allow answers","title":"boolean","type":"boolean","x-stream-index":"009"},"allow_user_suggested_options":{"description":"Allow user suggested options","title":"boolean","type":"boolean","x-stream-index":"008"},"description":{"description":"Poll description","title":"string","type":"string","x-stream-index":"003"},"enforce_unique_vote":{"description":"Enforce unique vote","title":"boolean","type":"boolean","x-stream-index":"005"},"id":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"},"is_closed":{"description":"Is closed","title":"boolean","type":"boolean","x-stream-index":"010"},"max_votes_allowed":{"description":"Max votes allowed","format":"int32","maximum":10,"title":"integer","type":"integer","x-stream-index":"007"},"name":{"description":"Poll name","title":"string","type":"string","x-stream-index":"002"},"options":{"description":"Poll options","items":{"$ref":"#/components/schemas/PollOptionRequest"},"maximum":100,"title":"PollOptions","type":"array","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"012.002"},"user_id":{"type":"string","x-stream-index":"012.001"},"voting_visibility":{"description":"Voting visibility","enum":["anonymous","public"],"title":"string","type":"string","x-stream-index":"006"}},"required":["id","name"],"type":"object"},"UpdateReminderRequest":{"nullable":true,"properties":{"remind_at":{"format":"date-time","type":"number","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"type":"object"},"UpdateReminderResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"001"}},"required":["reminder","duration"],"title":"Response","type":"object"},"UpdateThreadPartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"description":"Sets new field values","title":"Set","type":"object","x-stream-index":"004.001","x-stream-map":{"key":"field","title":"Value","description":"New value to set"}},"unset":{"description":"Array of field names to unset","items":{"type":"string"},"title":"Unset","type":"array","x-stream-index":"004.002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"type":"object"},"UpdateThreadPartialResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"thread":{"$ref":"#/components/schemas/ThreadResponse","description":"Updated thread (not enriched)","title":"Thread","x-stream-index":"001"}},"required":["thread","duration"],"type":"object"},"UpdateUserPartialRequest":{"properties":{"id":{"description":"User ID to update","title":"ID","type":"string","x-stream-index":"001"},"set":{"additionalProperties":{},"type":"object","x-stream-index":"002.001"},"unset":{"items":{"type":"string"},"type":"array","x-stream-index":"002.002"}},"required":["id"],"type":"object"},"UpdateUsersPartialRequest":{"nullable":true,"properties":{"users":{"items":{"$ref":"#/components/schemas/UpdateUserPartialRequest"},"maximum":100,"type":"array","x-stream-index":"001"}},"required":["users"],"type":"object"},"UpdateUsersRequest":{"nullable":true,"properties":{"users":{"additionalProperties":{"$ref":"#/components/schemas/UserRequest"},"description":"Object containing users","title":"Users","type":"object","x-stream-index":"001","x-stream-map":{"key":"user_id"}}},"required":["users"],"type":"object"},"UpdateUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"membership_deletion_task_id":{"type":"string","x-stream-index":"002"},"users":{"additionalProperties":{"$ref":"#/components/schemas/FullUserResponse"},"description":"Object containing users","title":"Users","type":"object","x-stream-index":"001","x-stream-map":{"key":"user_id"}}},"required":["users","membership_deletion_task_id","duration"],"type":"object"},"UpsertConfigRequest":{"nullable":true,"properties":{"ai_image_config":{"$ref":"#/components/schemas/AIImageConfig","description":"Configuration for AI image analysis","title":"AI Image Config","x-stream-index":"011"},"ai_text_config":{"$ref":"#/components/schemas/AITextConfig","description":"Configuration for AI text analysis","title":"AI Text Config","x-stream-index":"008"},"ai_video_config":{"$ref":"#/components/schemas/AIVideoConfig","description":"Configuration for AI video analysis","title":"AI Video Config","x-stream-index":"012"},"async":{"description":"Whether moderation should be performed asynchronously","title":"Async","type":"boolean","x-stream-index":"003"},"automod_platform_circumvention_config":{"$ref":"#/components/schemas/AutomodPlatformCircumventionConfig","description":"Configuration for platform circumvention detection","title":"Automod Platform Circumvention Config","x-stream-index":"005"},"automod_semantic_filters_config":{"$ref":"#/components/schemas/AutomodSemanticFiltersConfig","description":"Configuration for semantic filtering","title":"Automod Semantic Filters Config","x-stream-index":"006"},"automod_toxicity_config":{"$ref":"#/components/schemas/AutomodToxicityConfig","description":"Configuration for toxicity detection","title":"Automod Toxicity Config","x-stream-index":"004"},"aws_rekognition_config":{"$ref":"#/components/schemas/AIImageConfig","x-stream-index":"016"},"block_list_config":{"$ref":"#/components/schemas/BlockListConfig","description":"Configuration for block list filtering","title":"Block List Config","x-stream-index":"007"},"bodyguard_config":{"$ref":"#/components/schemas/AITextConfig","x-stream-index":"015"},"google_vision_config":{"$ref":"#/components/schemas/GoogleVisionConfig","description":"Configuration for Google Vision integration","title":"Google Vision Config","x-stream-index":"010"},"key":{"description":"Unique identifier for the moderation configuration","title":"Key","type":"string","x-stream-index":"001"},"llm_config":{"$ref":"#/components/schemas/LLMConfig","description":"Configuration for customer-configured LLM moderation","title":"LLM Config","x-stream-index":"009"},"rule_builder_config":{"$ref":"#/components/schemas/RuleBuilderConfig","description":"Configuration for custom rule builder (max 3 rules, max 5 conditions per rule)","title":"Rule Builder Config","x-stream-index":"014"},"team":{"description":"Team associated with the configuration","maxLength":128,"minLength":1,"title":"Team","type":"string","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"018.002"},"user_id":{"type":"string","x-stream-index":"018.001"},"velocity_filter_config":{"$ref":"#/components/schemas/VelocityFilterConfig","description":"Configuration for velocity-based filtering","title":"Velocity Filter Config","x-stream-index":"013"},"video_call_rule_config":{"$ref":"#/components/schemas/VideoCallRuleConfig","x-stream-index":"017"}},"required":["key"],"type":"object"},"UpsertConfigResponse":{"nullable":true,"properties":{"config":{"$ref":"#/components/schemas/ConfigResponse","description":"The created or updated moderation configuration","title":"Config","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["duration"],"type":"object"},"UpsertModerationRuleRequest":{"nullable":true,"properties":{"action":{"$ref":"#/components/schemas/RuleBuilderAction","x-stream-index":"009"},"conditions":{"items":{"$ref":"#/components/schemas/RuleBuilderCondition"},"type":"array","x-stream-index":"006"},"config_keys":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"cooldown_period":{"type":"string","x-stream-index":"010"},"description":{"type":"string","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"011"},"groups":{"items":{"$ref":"#/components/schemas/RuleBuilderConditionGroup"},"type":"array","x-stream-index":"008"},"logic":{"type":"string","x-stream-index":"007"},"name":{"type":"string","x-stream-index":"001"},"rule_type":{"type":"string","x-stream-index":"005"},"team":{"type":"string","x-stream-index":"004"}},"required":["name","rule_type","action"],"type":"object"},"UpsertModerationRuleResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"rule":{"$ref":"#/components/schemas/ModerationRuleV2Response","x-stream-index":"002"}},"required":["duration"],"title":"Response","type":"object"},"UpsertModerationTemplateRequest":{"nullable":true,"properties":{"config":{"$ref":"#/components/schemas/FeedsModerationTemplateConfig","description":"Configuration for the moderation template","title":"Config","x-stream-index":"002"},"name":{"description":"Name of the moderation template","title":"Name","type":"string","x-stream-index":"001"}},"required":["name","config"],"type":"object"},"UpsertModerationTemplateResponse":{"nullable":true,"properties":{"config":{"$ref":"#/components/schemas/FeedsModerationTemplateConfig","description":"Configuration for the moderation template","title":"Config","x-stream-index":"002"},"created_at":{"description":"When the template was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"003"},"duration":{"type":"string","x-stream-index":"005.001"},"name":{"description":"Name of the moderation template","title":"Name","type":"string","x-stream-index":"001"},"updated_at":{"description":"When the template was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"004"}},"required":["name","created_at","updated_at","duration"],"type":"object"},"UpsertPushPreferencesRequest":{"nullable":true,"properties":{"preferences":{"description":"A list of push preferences for channels, calls, or the user.","items":{"$ref":"#/components/schemas/PushPreferenceInput"},"type":"array","x-stream-index":"001"}},"required":["preferences"],"type":"object"},"UpsertPushPreferencesResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"user_channel_preferences":{"additionalProperties":{"additionalProperties":{"$ref":"#/components/schemas/ChannelPushPreferences"},"type":"object"},"description":"The channel specific push notification preferences, only returned for channels you've edited.","title":"User Channel Notification Preferences","type":"object","x-stream-index":"002"},"user_preferences":{"additionalProperties":{"$ref":"#/components/schemas/PushPreferences"},"description":"The user preferences, always returned regardless if you edited it","title":"User Preferences","type":"object","x-stream-index":"001"}},"required":["user_preferences","user_channel_preferences","duration"],"type":"object"},"UpsertPushProviderRequest":{"nullable":true,"properties":{"push_provider":{"$ref":"#/components/schemas/PushProvider","x-stream-index":"001"}},"type":"object"},"UpsertPushProviderResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"push_provider":{"$ref":"#/components/schemas/PushProviderResponse","x-stream-index":"001"}},"required":["push_provider","duration"],"title":"Response","type":"object"},"UpsertPushTemplateRequest":{"nullable":true,"properties":{"enable_push":{"description":"Whether to send push notification for this event","title":"boolean","type":"boolean","x-stream-index":"002"},"event_type":{"description":"Event type (message.new, message.updated, reaction.new)","enum":["message.new","message.updated","reaction.new","notification.reminder_due","feeds.activity.added","feeds.comment.added","feeds.activity.reaction.added","feeds.comment.reaction.added","feeds.follow.created","feeds.notification_feed.updated"],"title":"string","type":"string","x-stream-index":"003"},"push_provider_name":{"description":"Push provider name","title":"string","type":"string","x-stream-index":"004"},"push_provider_type":{"description":"Push provider type (firebase, apn)","enum":["firebase","apn"],"title":"string","type":"string","x-stream-index":"005"},"template":{"description":"Push template","title":"string","type":"string","x-stream-index":"006"}},"required":["event_type","push_provider_type"],"type":"object"},"UpsertPushTemplateResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"template":{"$ref":"#/components/schemas/PushTemplate","x-stream-index":"002"}},"required":["duration"],"title":"Response","type":"object"},"User":{"properties":{"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"046"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"017"},"banned":{"type":"boolean","x-stream-index":"016"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"013"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"023"},"language":{"type":"string","x-stream-index":"035"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"026"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"042"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"005"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"009"}},"required":["id","role","teams_role","custom","banned","online"],"type":"object"},"UserBannedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"006.002"},"channel_type":{"type":"string","x-stream-index":"006.003"},"cid":{"type":"string","x-stream-index":"006.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008.002"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"001"},"expiration":{"format":"date-time","type":"number","x-stream-index":"003"},"reason":{"type":"string","x-stream-index":"004"},"shadow":{"type":"boolean","x-stream-index":"002"},"team":{"type":"string","x-stream-index":"005.001"},"type":{"default":"user.banned","type":"string","x-stream-index":"008.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007.001"}},"required":["created_by","shadow","cid","channel_id","channel_type","type","created_at"],"title":"UserBannedEvent","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"},"UserCreatedWithinParameters":{"properties":{"max_age":{"type":"string","x-stream-index":"001"}},"type":"object"},"UserCustomEventRequest":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"001"}},"required":["type"],"type":"object"},"UserCustomPropertyParameters":{"properties":{"operator":{"type":"string","x-stream-index":"002"},"property_key":{"type":"string","x-stream-index":"001"}},"type":"object"},"UserDeactivatedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"001"},"type":{"default":"user.deactivated","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["created_by","type","created_at"],"title":"UserDeactivatedEvent","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"},"UserDeletedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"delete_conversation_channels":{"type":"boolean","x-stream-index":"005"},"hard_delete":{"type":"boolean","x-stream-index":"003.001"},"mark_messages_deleted":{"type":"boolean","x-stream-index":"004"},"type":{"default":"user.deleted","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"001.001"}},"required":["type","created_at","hard_delete","mark_messages_deleted","delete_conversation_channels"],"title":"UserDeletedEvent","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"},"UserFlaggedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"target_user":{"type":"string","x-stream-index":"002"},"target_users":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"type":{"default":"user.flagged","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"001"}},"required":["type","created_at"],"title":"UserFlaggedEvent","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"},"UserMessagesDeletedEvent":{"description":"This event is sent when a user's message get deleted. The event contains information about the user whose messages got deleted.","nullable":true,"properties":{"channel_custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.005"},"channel_id":{"description":"The ID of the channel where the target user's messages were deleted","title":"Channel ID","type":"string","x-stream-index":"001.002.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"001.001.004"},"channel_type":{"description":"The type of the channel where the target user's messages were deleted","title":"Channel Type","type":"string","x-stream-index":"001.002.001"},"cid":{"description":"The CID of the channel where the target user's messages were deleted","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":"number","x-stream-index":"001.001.001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.001.001.007"},"hard_delete":{"description":"Whether Messages were hard deleted","title":"Hard Delete","type":"boolean","x-stream-index":"003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.001.001.004"},"team":{"description":"The team of the channel where the target user's messages were deleted","title":"Team","type":"string","x-stream-index":"001.001.003"},"type":{"default":"user.messages.deleted","description":"The type of event: \"user.messages.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.001.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The target user whose messages got deleted","title":"User","x-stream-index":"002.001"}},"required":["type","created_at","custom","user"],"title":"UserMessagesDeletedEvent","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"},"UserMute":{"nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"expires":{"description":"Date/time of mute expiration","format":"date-time","title":"Expires","type":"number","x-stream-index":"008"},"target":{"$ref":"#/components/schemas/User","description":"User who's muted","title":"Target","x-stream-index":"007"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/User","description":"Owner of channel mute","title":"User","x-stream-index":"005"}},"required":["created_at","updated_at"],"type":"object"},"UserMuteResponse":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"expires":{"format":"date-time","type":"number","x-stream-index":"003"},"target":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"}},"required":["created_at","updated_at"],"type":"object"},"UserMutedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"target_user":{"type":"string","x-stream-index":"001"},"target_users":{"items":{"type":"string"},"type":"array","x-stream-index":"002"},"type":{"default":"user.muted","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"UserMutedEvent","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"},"UserReactivatedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"type":{"default":"user.reactivated","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"001"}},"required":["type","created_at"],"title":"UserReactivatedEvent","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"},"UserRequest":{"description":"User request object","properties":{"custom":{"additionalProperties":{},"description":"Custom user data","title":"Custom","type":"object","x-stream-index":"004"},"id":{"description":"User ID","title":"ID","type":"string","x-stream-index":"001"},"image":{"description":"User's profile image URL","title":"Image","type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"006"},"language":{"type":"string","x-stream-index":"005"},"name":{"description":"Optional name of user","title":"Name","type":"string","x-stream-index":"002"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"007"},"role":{"description":"User's global role","title":"Role","type":"string","x-stream-index":"008"},"teams":{"description":"List of teams the user belongs to","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"010"},"teams_role":{"additionalProperties":{"type":"string"},"description":"Map of team-specific roles for the user","title":"TeamsRole","type":"object","x-stream-index":"009"}},"required":["id"],"title":"UserRequest","type":"object"},"UserResponse":{"description":"User response object","properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"ban_expires":{"description":"Date when ban expires","format":"date-time","title":"Ban expires","type":"number","x-stream-index":"003"},"banned":{"description":"Whether a user is banned or not","title":"Banned","type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.017"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"001.004"},"deactivated_at":{"description":"Date of deactivation","format":"date-time","title":"Deactivated at","type":"number","x-stream-index":"001.016"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"001.011"},"devices":{"description":"List of devices user is using","items":{"$ref":"#/components/schemas/DeviceResponse"},"title":"Devices","type":"array","x-stream-index":"006"},"id":{"description":"Unique user identifier","title":"ID","type":"string","x-stream-index":"001.001"},"image":{"title":"Image","type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"007"},"language":{"description":"Preferred language of a user","title":"Language","type":"string","x-stream-index":"001.005"},"last_active":{"description":"Date of last activity","format":"date-time","title":"Last active","type":"number","x-stream-index":"001.014"},"name":{"description":"Optional name of user","title":"Name","type":"string","x-stream-index":"001.002"},"online":{"description":"Whether a user online or not","title":"Online","type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","description":"User privacy settings","title":"Privacy settings","x-stream-index":"005"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettingsResponse","description":"User push notification settings","title":"Push notifications","x-stream-index":"004"},"revoke_tokens_issued_before":{"description":"Revocation date for tokens","format":"date-time","title":"Revoke tokens issued before","type":"number","x-stream-index":"001.015"},"role":{"description":"Determines the set of user permissions","title":"Role","type":"string","x-stream-index":"001.006"},"shadow_banned":{"description":"Whether a user is shadow banned","title":"Shadow banned","type":"boolean","x-stream-index":"002"},"teams":{"description":"List of teams user is a part of","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids","shadow_banned","invisible"],"title":"UserResponse","type":"object"},"UserResponseCommonFields":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"018"},"banned":{"type":"boolean","x-stream-index":"012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"017"},"created_at":{"format":"date-time","type":"number","x-stream-index":"009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"id":{"type":"string","x-stream-index":"001"},"image":{"type":"string","x-stream-index":"003"},"language":{"type":"string","x-stream-index":"005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"014"},"name":{"type":"string","x-stream-index":"002"},"online":{"type":"boolean","x-stream-index":"013"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"015"},"role":{"type":"string","x-stream-index":"006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids"],"type":"object"},"UserResponsePrivacyFields":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"banned":{"type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.017"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.011"},"id":{"type":"string","x-stream-index":"001.001"},"image":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"003"},"language":{"type":"string","x-stream-index":"001.005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"001.014"},"name":{"type":"string","x-stream-index":"001.002"},"online":{"type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"002"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.015"},"role":{"type":"string","x-stream-index":"001.006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids"],"type":"object"},"UserRuleParameters":{"properties":{"max_age":{"type":"string","x-stream-index":"001"}},"type":"object"},"UserUnbannedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"005.002"},"shadow":{"type":"boolean","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"004.001"},"type":{"default":"user.unbanned","type":"string","x-stream-index":"005.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["shadow","cid","channel_id","channel_type","type","created_at"],"title":"UserUnbannedEvent","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"},"UserUnmutedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"target_user":{"type":"string","x-stream-index":"002"},"target_users":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"type":{"default":"user.unmuted","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"001"}},"required":["type","created_at"],"title":"UserUnmutedEvent","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"},"UserUnreadReminderEvent":{"properties":{"channels":{"additionalProperties":{"$ref":"#/components/schemas/ChannelMessages"},"type":"object","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"user.unread_message_reminder","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002"}},"required":["type","created_at","channels"],"title":"UserUnreadReminderEvent","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"},"UserUpdatedEvent":{"description":"This event is sent when a user gets updated. The event contains information about the updated user.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"type":{"default":"user.updated","description":"The type of event: \"user.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.002"},"user":{"$ref":"#/components/schemas/UserResponsePrivacyFields","description":"The updated user","title":"User","x-stream-index":"002.001"}},"required":["type","created_at","custom","user"],"title":"UserUpdatedEvent","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"},"VelocityFilterConfig":{"properties":{"advanced_filters":{"type":"boolean","x-stream-index":"007"},"async":{"type":"boolean","x-stream-index":"001"},"cascading_actions":{"type":"boolean","x-stream-index":"004"},"cids_per_user":{"format":"int32","type":"integer","x-stream-index":"006"},"enabled":{"type":"boolean","x-stream-index":"002"},"first_message_only":{"type":"boolean","x-stream-index":"005"},"rules":{"items":{"$ref":"#/components/schemas/VelocityFilterConfigRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules","cascading_actions","first_message_only","cids_per_user","advanced_filters"],"type":"object"},"VelocityFilterConfigRule":{"properties":{"action":{"enum":["flag","shadow","remove","ban"],"type":"string","x-stream-index":"001"},"ban_duration":{"format":"int32","type":"integer","x-stream-index":"002"},"cascading_action":{"enum":["flag","shadow","remove","ban"],"type":"string","x-stream-index":"006"},"cascading_threshold":{"format":"int64","type":"integer","x-stream-index":"005"},"check_message_context":{"type":"boolean","x-stream-index":"009"},"fast_spam_threshold":{"format":"int32","type":"integer","x-stream-index":"007"},"fast_spam_ttl":{"format":"int32","type":"integer","x-stream-index":"010"},"ip_ban":{"type":"boolean","x-stream-index":"004"},"probation_period":{"format":"int32","type":"integer","x-stream-index":"014"},"shadow_ban":{"type":"boolean","x-stream-index":"003"},"slow_spam_ban_duration":{"format":"int32","type":"integer","x-stream-index":"012"},"slow_spam_threshold":{"format":"int32","type":"integer","x-stream-index":"008"},"slow_spam_ttl":{"format":"int32","type":"integer","x-stream-index":"011"},"url_only":{"type":"boolean","x-stream-index":"013"}},"required":["action","ban_duration","shadow_ban","ip_ban","cascading_threshold","cascading_action","fast_spam_threshold","slow_spam_threshold","check_message_context","fast_spam_ttl","slow_spam_ttl","url_only","probation_period"],"type":"object"},"VideoCallRuleConfig":{"properties":{"rules":{"additionalProperties":{"$ref":"#/components/schemas/HarmConfig"},"type":"object","x-stream-index":"001"}},"required":["rules"],"type":"object"},"VideoContentParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"type":"object"},"VideoEndCallRequest":{"type":"object"},"VideoKickUserRequest":{"type":"object"},"VideoOrientation":{"properties":{"orientation":{"type":"integer","x-stream-index":"004"}},"type":"object"},"VideoRuleParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"type":"object"},"VideoSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"camera_default_on":{"type":"boolean","x-stream-index":"004"},"camera_facing":{"enum":["front","back","external"],"type":"string","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled","target_resolution","camera_default_on","camera_facing"],"type":"object"},"VideoSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"camera_default_on":{"type":"boolean","x-stream-index":"004"},"camera_facing":{"enum":["front","back","external"],"type":"string","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled","target_resolution","camera_default_on","camera_facing"],"type":"object"},"VoteData":{"properties":{"answer_text":{"type":"string","x-stream-index":"002"},"option_id":{"maxLength":255,"type":"string","x-stream-index":"001"}},"type":"object"},"WSEvent":{"description":"Represents an BaseEvent that happened in Stream Chat","properties":{"automoderation":{"type":"boolean","x-stream-index":"023"},"automoderation_scores":{"$ref":"#/components/schemas/ModerationResponse","x-stream-index":"024"},"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"011"},"channel_id":{"type":"string","x-stream-index":"004"},"channel_last_message_at":{"format":"date-time","type":"number","x-stream-index":"007"},"channel_type":{"type":"string","x-stream-index":"005"},"cid":{"type":"string","x-stream-index":"003"},"connection_id":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"028"},"created_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"022"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"027"},"me":{"$ref":"#/components/schemas/OwnUserResponse","x-stream-index":"019"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"014"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"008"},"message_update":{"$ref":"#/components/schemas/MessageUpdate","x-stream-index":"009"},"parent_id":{"type":"string","x-stream-index":"025"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"015"},"poll_vote":{"$ref":"#/components/schemas/PollVoteResponseData","x-stream-index":"016"},"reaction":{"$ref":"#/components/schemas/ReactionResponse","x-stream-index":"010"},"reason":{"type":"string","x-stream-index":"021"},"team":{"type":"string","x-stream-index":"026"},"thread":{"$ref":"#/components/schemas/ThreadResponse","x-stream-index":"013"},"thread_id":{"type":"string","x-stream-index":"012"},"type":{"type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"017"},"user_id":{"type":"string","x-stream-index":"018"},"watcher_count":{"format":"int32","type":"integer","x-stream-index":"020"}},"required":["type","custom","created_at"],"title":"Event","type":"object","x-stream-docs-page-id":"event_object"},"WebhookEvent":{"description":"The discriminator object for all webhook events, it maps events' payload to the final type","discriminator":{"mapping":{"*":"#/components/schemas/AnyEvent","activity.marked":"#/components/schemas/ActivityMarkedEvent","campaign.completed":"#/components/schemas/CampaignCompletedEvent","campaign.started":"#/components/schemas/CampaignStartedEvent","channel.created":"#/components/schemas/ChannelCreatedEvent","channel.deleted":"#/components/schemas/ChannelDeletedEvent","channel.frozen":"#/components/schemas/ChannelFrozenEvent","channel.hidden":"#/components/schemas/ChannelHiddenEvent","channel.muted":"#/components/schemas/ChannelMutedEvent","channel.truncated":"#/components/schemas/ChannelTruncatedEvent","channel.unfrozen":"#/components/schemas/ChannelUnFrozenEvent","channel.unmuted":"#/components/schemas/ChannelUnmutedEvent","channel.updated":"#/components/schemas/ChannelUpdatedEvent","channel.visible":"#/components/schemas/ChannelVisibleEvent","export.bulk_image_moderation.error":"#/components/schemas/AsyncExportErrorEvent","export.bulk_image_moderation.success":"#/components/schemas/AsyncBulkImageModerationEvent","export.channels.error":"#/components/schemas/AsyncExportErrorEvent","export.channels.success":"#/components/schemas/AsyncExportChannelsEvent","export.moderation_logs.error":"#/components/schemas/AsyncExportErrorEvent","export.moderation_logs.success":"#/components/schemas/AsyncExportModerationLogsEvent","export.users.error":"#/components/schemas/AsyncExportErrorEvent","export.users.success":"#/components/schemas/AsyncExportUsersEvent","flag.updated":"#/components/schemas/FlagUpdatedEvent","member.added":"#/components/schemas/MemberAddedEvent","member.removed":"#/components/schemas/MemberRemovedEvent","member.updated":"#/components/schemas/MemberUpdatedEvent","message.deleted":"#/components/schemas/MessageDeletedEvent","message.flagged":"#/components/schemas/MessageFlaggedEvent","message.new":"#/components/schemas/MessageNewEvent","message.pending":"#/components/schemas/PendingMessageEvent","message.read":"#/components/schemas/MessageReadEvent","message.unblocked":"#/components/schemas/MessageUnblockedEvent","message.undeleted":"#/components/schemas/MessageUndeletedEvent","message.updated":"#/components/schemas/MessageUpdatedEvent","moderation.custom_action":"#/components/schemas/ModerationCustomActionEvent","moderation.flagged":"#/components/schemas/ModerationFlaggedEvent","moderation.mark_reviewed":"#/components/schemas/ModerationMarkReviewedEvent","moderation_check.completed":"#/components/schemas/ModerationCheckCompletedEvent","notification.mark_unread":"#/components/schemas/NotificationMarkUnreadEvent","notification.reminder_due":"#/components/schemas/ReminderNotificationEvent","notification.thread_message_new":"#/components/schemas/MessageNewEvent","reaction.deleted":"#/components/schemas/ReactionDeletedEvent","reaction.new":"#/components/schemas/ReactionNewEvent","reaction.updated":"#/components/schemas/ReactionUpdatedEvent","reminder.created":"#/components/schemas/ReminderCreatedEvent","reminder.deleted":"#/components/schemas/ReminderDeletedEvent","reminder.updated":"#/components/schemas/ReminderUpdatedEvent","review_queue_item.new":"#/components/schemas/ReviewQueueItemNewEvent","review_queue_item.updated":"#/components/schemas/ReviewQueueItemUpdatedEvent","thread.updated":"#/components/schemas/ThreadUpdatedEvent","user.banned":"#/components/schemas/UserBannedEvent","user.deactivated":"#/components/schemas/UserDeactivatedEvent","user.deleted":"#/components/schemas/UserDeletedEvent","user.flagged":"#/components/schemas/UserFlaggedEvent","user.messages.deleted":"#/components/schemas/UserMessagesDeletedEvent","user.muted":"#/components/schemas/UserMutedEvent","user.reactivated":"#/components/schemas/UserReactivatedEvent","user.unbanned":"#/components/schemas/UserUnbannedEvent","user.unmuted":"#/components/schemas/UserUnmutedEvent","user.unread_message_reminder":"#/components/schemas/UserUnreadReminderEvent","user.updated":"#/components/schemas/UserUpdatedEvent"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/ActivityMarkedEvent"},{"$ref":"#/components/schemas/AnyEvent"},{"$ref":"#/components/schemas/AsyncBulkImageModerationEvent"},{"$ref":"#/components/schemas/AsyncExportChannelsEvent"},{"$ref":"#/components/schemas/AsyncExportErrorEvent"},{"$ref":"#/components/schemas/AsyncExportErrorEvent"},{"$ref":"#/components/schemas/AsyncExportErrorEvent"},{"$ref":"#/components/schemas/AsyncExportErrorEvent"},{"$ref":"#/components/schemas/AsyncExportModerationLogsEvent"},{"$ref":"#/components/schemas/AsyncExportUsersEvent"},{"$ref":"#/components/schemas/CampaignCompletedEvent"},{"$ref":"#/components/schemas/CampaignStartedEvent"},{"$ref":"#/components/schemas/ChannelCreatedEvent"},{"$ref":"#/components/schemas/ChannelDeletedEvent"},{"$ref":"#/components/schemas/ChannelFrozenEvent"},{"$ref":"#/components/schemas/ChannelHiddenEvent"},{"$ref":"#/components/schemas/ChannelMutedEvent"},{"$ref":"#/components/schemas/ChannelTruncatedEvent"},{"$ref":"#/components/schemas/ChannelUnFrozenEvent"},{"$ref":"#/components/schemas/ChannelUnmutedEvent"},{"$ref":"#/components/schemas/ChannelUpdatedEvent"},{"$ref":"#/components/schemas/ChannelVisibleEvent"},{"$ref":"#/components/schemas/FlagUpdatedEvent"},{"$ref":"#/components/schemas/MemberAddedEvent"},{"$ref":"#/components/schemas/MemberRemovedEvent"},{"$ref":"#/components/schemas/MemberUpdatedEvent"},{"$ref":"#/components/schemas/MessageDeletedEvent"},{"$ref":"#/components/schemas/MessageFlaggedEvent"},{"$ref":"#/components/schemas/MessageNewEvent"},{"$ref":"#/components/schemas/MessageNewEvent"},{"$ref":"#/components/schemas/MessageReadEvent"},{"$ref":"#/components/schemas/MessageUnblockedEvent"},{"$ref":"#/components/schemas/MessageUndeletedEvent"},{"$ref":"#/components/schemas/MessageUpdatedEvent"},{"$ref":"#/components/schemas/ModerationCheckCompletedEvent"},{"$ref":"#/components/schemas/ModerationCustomActionEvent"},{"$ref":"#/components/schemas/ModerationFlaggedEvent"},{"$ref":"#/components/schemas/ModerationMarkReviewedEvent"},{"$ref":"#/components/schemas/NotificationMarkUnreadEvent"},{"$ref":"#/components/schemas/PendingMessageEvent"},{"$ref":"#/components/schemas/ReactionDeletedEvent"},{"$ref":"#/components/schemas/ReactionNewEvent"},{"$ref":"#/components/schemas/ReactionUpdatedEvent"},{"$ref":"#/components/schemas/ReminderCreatedEvent"},{"$ref":"#/components/schemas/ReminderDeletedEvent"},{"$ref":"#/components/schemas/ReminderNotificationEvent"},{"$ref":"#/components/schemas/ReminderUpdatedEvent"},{"$ref":"#/components/schemas/ReviewQueueItemNewEvent"},{"$ref":"#/components/schemas/ReviewQueueItemUpdatedEvent"},{"$ref":"#/components/schemas/ThreadUpdatedEvent"},{"$ref":"#/components/schemas/UserBannedEvent"},{"$ref":"#/components/schemas/UserDeactivatedEvent"},{"$ref":"#/components/schemas/UserDeletedEvent"},{"$ref":"#/components/schemas/UserFlaggedEvent"},{"$ref":"#/components/schemas/UserMessagesDeletedEvent"},{"$ref":"#/components/schemas/UserMutedEvent"},{"$ref":"#/components/schemas/UserReactivatedEvent"},{"$ref":"#/components/schemas/UserUnbannedEvent"},{"$ref":"#/components/schemas/UserUnmutedEvent"},{"$ref":"#/components/schemas/UserUnreadReminderEvent"},{"$ref":"#/components/schemas/UserUpdatedEvent"}]},"WrappedUnreadCountsResponse":{"description":"Basic response information","nullable":true,"properties":{"channel_type":{"items":{"$ref":"#/components/schemas/UnreadCountsChannelType"},"type":"array","x-stream-index":"001.005"},"channels":{"items":{"$ref":"#/components/schemas/UnreadCountsChannel"},"type":"array","x-stream-index":"001.004"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"threads":{"items":{"$ref":"#/components/schemas/UnreadCountsThread"},"type":"array","x-stream-index":"001.006"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"001.001"},"total_unread_count_by_team":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001.003"},"total_unread_threads_count":{"format":"int32","type":"integer","x-stream-index":"001.002"}},"required":["total_unread_count","total_unread_threads_count","channels","channel_type","threads","duration"],"title":"Response","type":"object"},"XiaomiConfig":{"properties":{"Disabled":{"type":"boolean","writeOnly":true,"x-stream-index":"003"},"package_name":{"type":"string","x-stream-index":"001"},"secret":{"type":"string","x-stream-index":"002"}},"type":"object"},"XiaomiConfigFields":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"package_name":{"type":"string","x-stream-index":"002"},"secret":{"type":"string","x-stream-index":"003"}},"required":["enabled"],"type":"object"}},"securitySchemes":{"JWT":{"description":"JWT should be always provided when stream-auth-type=jwt.\n\nUsing JWT auth request could be authenticated as user or as server-side.\n\nWhen using user authentication permission checking is going to be applied to requests based on the user that is\nperforming a request.\n\nThe `authorization` header should be a JWT string signed using the secret attached to the API key used to perform\nrequests.\n\n**WARNING** all client-side official SDK do not ship with token generation; this is to make sure that the API secret is not\nshared with an untrusted party such as a browser or a iOS/Android application. Tokens **must** be generated server-side.\nIf you wish, you can configure your application to ignore authentication (see `disable_auth_check`)\nThe JWT string must include only the user_id claim and can include any built-in JWT claim such as iat, exp as well.\n","in":"header","name":"Authorization","type":"apiKey"},"api_key":{"description":"Application API key should be always set in order to authenticate the request.","in":"query","name":"api_key","type":"apiKey"},"stream-auth-type":{"description":"Stream-Auth-Type should be always set in order to authenticate the request. Possible\nvalues: `jwt` or `anonymous`.\n\n`jwt` allows you to authenticate as a user. With this auth type you should also provide valid JWT in Authorization\nheader.\n\n`anonymous` allows you to authenticate as anonymous user. Please note that most advanced features are not available\nto anonymous users.","in":"header","name":"Stream-Auth-Type","type":"apiKey"}}},"info":{"title":"Stream API","version":"v191.1.0"},"openapi":"3.0.3","paths":{"/api/v2/app":{"get":{"description":"This Method returns the application settings\n","operationId":"GetApp","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetApplicationResponse"}}},"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":"Get App Settings","tags":["product:common"]},"patch":{"description":"This Method updates one or more application settings\n","operationId":"UpdateApp","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAppRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Update App Settings","tags":["product:common"]}},"/api/v2/blocklists":{"get":{"description":"Returns all available block lists\n","operationId":"ListBlockLists","parameters":[{"in":"query","name":"team","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListBlockListResponse"}}},"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":"List block lists","tags":["product:common"]},"post":{"description":"Creates a new application blocklist, once created the blocklist can be used by any channel type\n","operationId":"CreateBlockList","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBlockListRequest"}}},"description":"Block list","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBlockListResponse"}}},"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":"Create block list","tags":["product:common"]}},"/api/v2/blocklists/{name}":{"delete":{"description":"Deletes previously created application blocklist\n","operationId":"DeleteBlockList","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"team","schema":{"type":"string","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete block list","tags":["product:common"]},"get":{"description":"Returns block list by given name\n","operationId":"GetBlockList","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Block list name","title":"Name","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"team","schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBlockListResponse"}}},"description":"GetBlockListResponse"},"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":"Get block list","tags":["product:common"]},"put":{"description":"Updates contents of the block list\n","operationId":"UpdateBlockList","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Block list name","title":"Name","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBlockListRequest"}}},"description":"Update block list","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBlockListResponse"}}},"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":"Update block list","tags":["product:common"]}},"/api/v2/chat/campaigns/query":{"post":{"description":"Query campaigns with filter query\n","operationId":"QueryCampaigns","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCampaignsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCampaignsResponse"}}},"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":"Query campaigns","tags":["product:chat"]}},"/api/v2/chat/campaigns/{id}":{"get":{"description":"Get campaign by ID.\n","operationId":"GetCampaign","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"The ID of the campaign (uuid)","maxLength":255,"title":"Campaign ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"prev","schema":{"description":"Token for the previous page of campaign users","title":"Previous Users Page","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"query","name":"next","schema":{"description":"Token for the next page of campaign users","title":"Next Users Page","type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"limit","schema":{"description":"Maximum number of campaign users to return in a single request (max: 1000)","format":"int32","maximum":1000,"minimum":0,"title":"Users Limit","type":"integer","writeOnly":true,"x-stream-index":"002.003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCampaignResponse"}}},"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":"Get campaign","tags":["product:chat"]}},"/api/v2/chat/campaigns/{id}/start":{"post":{"description":"Starts or schedules a campaign\n","operationId":"StartCampaign","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartCampaignRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartCampaignResponse"}}},"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":"Start/schedule campaign","tags":["product:chat"]}},"/api/v2/chat/campaigns/{id}/stop":{"post":{"description":"Stops a campaign\n","operationId":"ScheduleCampaign","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopCampaignRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignResponse"}}},"description":"Successful 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":"Stop campaign","tags":["product:chat"]}},"/api/v2/chat/channels":{"post":{"description":"Query channels with filter query\n","operationId":"QueryChannels","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryChannelsRequest"}}},"description":"Query Channels Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryChannelsResponse"}}},"description":"Channels list"},"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":"Query channels","tags":["product:chat"]}},"/api/v2/chat/channels/delete":{"post":{"description":"Allows to delete several channels at once asynchronously\n\nSends events:\n- channel.deleted\n- channel.deleted\n","operationId":"DeleteChannels","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteChannelsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteChannelsResponse"}}},"description":"Successful 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":"Deletes channels asynchronously","tags":["product:chat"]}},"/api/v2/chat/channels/read":{"post":{"description":"Marks channels as read up to the specific message. If no channels is given, mark all channel as read\n\nSends events:\n- message.read\n- message.read\n","operationId":"MarkChannelsRead","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkChannelsReadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkReadResponse"}}},"description":"Successful 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 channels as read","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/query":{"post":{"description":"This Method creates a channel or returns an existing one with matching attributes\n\nSends events:\n- channel.created\n- member.added\n- member.removed\n- member.updated\n- user.watching.start\n","operationId":"GetOrCreateDistinctChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelGetOrCreateRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelStateResponse"}}},"description":"Successful 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":"Get or create channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}":{"delete":{"description":"Deletes channel\n\nSends events:\n- channel.deleted\n- channel.deleted\n","operationId":"DeleteChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"query","name":"hard_delete","schema":{"type":"boolean","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteChannelResponse"}}},"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":"Delete channel","tags":["product:chat"]},"patch":{"description":"Updates certain fields of the channel\n\nSends events:\n- channel.updated\n- channel.updated\n","operationId":"UpdateChannelPartial","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelPartialRequest"}}},"description":"UpdateChannelPartialRequest","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelPartialResponse"}}},"description":"Successful 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":"Partially update channel","tags":["product:chat"]},"post":{"description":"Change channel data\n\nSends events:\n- channel.updated\n- member.added\n- member.removed\n- member.updated\n- message.new\n- channel.updated\n- member.added\n- member.removed\n- member.updated\n- message.new\n","operationId":"UpdateChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"013.002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"013.002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelRequest"}}},"description":"Channel update request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelResponse"}}},"description":"Successful 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":"Update channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/draft":{"delete":{"description":"Deletes a draft\n\nSends events:\n- draft.deleted\n","operationId":"DeleteDraft","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"parent_id","schema":{"description":"Parent message ID","title":"string","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"003.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete draft","tags":["product:chat"]},"get":{"description":"Get a draft\n","operationId":"GetDraft","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"parent_id","schema":{"description":"Parent message ID","title":"string","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"003.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetDraftResponse"}}},"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":"Get draft","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/event":{"post":{"description":"Sends event to the channel\n","operationId":"SendEvent","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendEventRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventResponse"}}},"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":"Send event","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/file":{"delete":{"description":"Deletes previously uploaded file\n","operationId":"DeleteFile","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of file","title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"File ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"url","schema":{"description":"File URL to delete","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete file","tags":["product:chat"]},"post":{"description":"Uploads file\n","operationId":"UploadFile","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/FileUploadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileUploadResponse"}}},"description":"Successful 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":"Upload file","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/hide":{"post":{"description":"Marks channel as hidden for current user\n\nSends events:\n- channel.hidden\n- channel.hidden\n","operationId":"HideChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HideChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HideChannelResponse"}}},"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":"Hide channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/image":{"delete":{"description":"Deletes previously uploaded image\n","operationId":"DeleteImage","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of file","title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"File ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"url","schema":{"description":"File URL to delete","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete image","tags":["product:chat"]},"post":{"description":"Uploads image\n","operationId":"UploadImage","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.001.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.001.002"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/ImageUploadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageUploadResponse"}}},"description":"Successful 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":"Upload image","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/member":{"patch":{"description":"\n","operationId":"UpdateMemberPartial","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"005.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMemberPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMemberPartialResponse"}}},"description":"Successful 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":"Partially channel member update","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/message":{"post":{"description":"Sends new message to the specified channel\n\nSends events:\n- message.new\n- message.updated\n- message.new\n- message.updated\n","operationId":"SendMessage","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"009.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"009.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendMessageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendMessageResponse"}}},"description":"Successful 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":"Send new message","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/messages":{"get":{"description":"Returns list messages found by IDs\n","operationId":"GetManyMessages","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"ids","required":true,"schema":{"description":"List of comma-separated IDs","items":{"type":"string"},"maximum":50,"minimum":1,"title":"IDs","type":"array","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetManyMessagesResponse"}}},"description":"Successful 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":"Get many messages","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/query":{"post":{"description":"This Method creates a channel or returns an existing one with matching attributes\n\nSends events:\n- channel.created\n- member.added\n- member.removed\n- member.updated\n- user.watching.start\n","operationId":"GetOrCreateChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID (maximum length of 64 characters)","title":"ID","type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelGetOrCreateRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelStateResponse"}}},"description":"Successful 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":"Get or create channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/read":{"post":{"description":"Marks channel as read up to the specific message\n\nSends events:\n- message.read\n- message.read\n","operationId":"MarkRead","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkReadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkReadResponse"}}},"description":"Successful 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 read","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/show":{"post":{"description":"Shows previously hidden channel\n\nSends events:\n- channel.visible\n- channel.visible\n","operationId":"ShowChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShowChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShowChannelResponse"}}},"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":"Show channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/truncate":{"post":{"description":"Truncates messages from a channel. Can be applied to the entire channel or scoped to specific members.\n\nSends events:\n- channel.truncated\n- channel.truncated\n","operationId":"TruncateChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TruncateChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TruncateChannelResponse"}}},"description":"Successful 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":"Truncate channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/unread":{"post":{"description":"Marks channel as unread from a specific message\n","operationId":"MarkUnread","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkUnreadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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 unread","tags":["product:chat"]}},"/api/v2/chat/channeltypes":{"get":{"description":"Lists all available channel types\n","operationId":"ListChannelTypes","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListChannelTypesResponse"}}},"description":"ListChannelTypesResponse"},"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":"List channel types","tags":["product:chat"]},"post":{"description":"Creates new channel type\n","operationId":"CreateChannelType","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateChannelTypeRequest"}}},"description":"CreateChannelTypeRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateChannelTypeResponse"}}},"description":"Successful 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":"Create channel type","tags":["product:chat"]}},"/api/v2/chat/channeltypes/{name}":{"delete":{"description":"Deletes channel type\n","operationId":"DeleteChannelType","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Channel type name","title":"Name","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete channel type","tags":["product:chat"]},"get":{"description":"Gets channel type\n","operationId":"GetChannelType","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Channel type name","title":"Name","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetChannelTypeResponse"}}},"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":"Get channel type","tags":["product:chat"]},"put":{"description":"Updates channel type\n","operationId":"UpdateChannelType","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelTypeRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelTypeResponse"}}},"description":"Successful 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":"Update channel type","tags":["product:chat"]}},"/api/v2/chat/commands":{"get":{"description":"Returns all custom commands\n","operationId":"ListCommands","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListCommandsResponse"}}},"description":"ListCommandsResponse"},"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":"List commands","tags":["product:chat"]},"post":{"description":"Creates custom chat command\n","operationId":"CreateCommand","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCommandRequest"}}},"description":"CreateCommandRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCommandResponse"}}},"description":"CreateCommandResponse"},"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":"Create command","tags":["product:chat"]}},"/api/v2/chat/commands/{name}":{"delete":{"description":"Deletes custom chat command\n","operationId":"DeleteCommand","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Command name","title":"Name","type":"string","x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCommandResponse"}}},"description":"DeleteCommandResponse"},"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":"Delete command","tags":["product:chat"]},"get":{"description":"Returns custom command by its name\n","operationId":"GetCommand","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Command name","title":"Name","type":"string","x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCommandResponse"}}},"description":"GetCommandResponse"},"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":"Get command","tags":["product:chat"]},"put":{"description":"Updates custom chat command\n","operationId":"UpdateCommand","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Unique command name","title":"Name","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCommandRequest"}}},"description":"UpdateCommandRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCommandResponse"}}},"description":"UpdateCommandResponse"},"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":"Update command","tags":["product:chat"]}},"/api/v2/chat/drafts/query":{"post":{"description":"Queries draft messages for a user\n","operationId":"QueryDrafts","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryDraftsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryDraftsResponse"}}},"description":"Successful 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":"Query draft messages","tags":["product:chat"]}},"/api/v2/chat/export_channels":{"post":{"description":"Exports channel data to JSON file\n","operationId":"ExportChannels","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportChannelsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportChannelsResponse"}}},"description":"Successful 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":"Export channels","tags":["product:chat"]}},"/api/v2/chat/members":{"get":{"description":"Find and filter channel members\n","operationId":"QueryMembers","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryMembersPayload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MembersResponse"}}},"description":"Successful 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":"Query members","tags":["product:chat"]}},"/api/v2/chat/messages/history":{"post":{"description":"Queries history for one message\n","operationId":"QueryMessageHistory","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryMessageHistoryRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryMessageHistoryResponse"}}},"description":"Successful 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":"Query message history","tags":["product:chat"]}},"/api/v2/chat/messages/{id}":{"delete":{"description":"Deletes message\n\nSends events:\n- message.deleted\n- message.deleted\n","operationId":"DeleteMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID to delete","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"hard","schema":{"description":"Delete all message reactions and replies as well","title":"Hard","type":"boolean","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"deleted_by","schema":{"type":"string","writeOnly":true,"x-stream-index":"003"}},{"in":"query","name":"delete_for_me","schema":{"description":"Delete the message only for the user making the request","title":"Delete for me","type":"boolean","writeOnly":true,"x-stream-index":"004"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteMessageResponse"}}},"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":"Delete message","tags":["product:chat"]},"get":{"description":"Returns message by ID\n","operationId":"GetMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"ID of the message","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"show_deleted_message","schema":{"description":"Whether to show deleted message","title":"Show deleted message","type":"boolean","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetMessageResponse"}}},"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":"Get message","tags":["product:chat"]},"post":{"description":"Updates message with new data\n\nSends events:\n- message.updated\n- message.updated\n","operationId":"UpdateMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"004.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessageResponse"}}},"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":"Update message","tags":["product:chat"]},"put":{"description":"Updates certain fields of the message\n\nSends events:\n- message.updated\n- message.updated\n","operationId":"UpdateMessagePartial","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessagePartialRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessagePartialResponse"}}},"description":"Successful 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":"Partially message update","tags":["product:chat"]}},"/api/v2/chat/messages/{id}/action":{"post":{"description":"Executes message command action with given parameters\n\nSends events:\n- message.new\n- message.new\n","operationId":"RunMessageAction","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageActionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}},"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":"Run message command action","tags":["product:chat"]}},"/api/v2/chat/messages/{id}/commit":{"post":{"description":"Commits a pending message, which will make it visible in the channel\n\nSends events:\n- message.new\n- message.updated\n- message.new\n- message.updated\n","operationId":"CommitMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommitMessageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}},"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":"Commit message","tags":["product:chat"]}},"/api/v2/chat/messages/{id}/reaction":{"post":{"description":"Sends reaction to specified message\n\nSends events:\n- reaction.new\n- reaction.updated\n","operationId":"SendReaction","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID to send reaction for","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendReactionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendReactionResponse"}}},"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":"Send reaction","tags":["product:chat"]}},"/api/v2/chat/messages/{id}/reaction/{type}":{"delete":{"description":"Removes user reaction from the message\n\nSends events:\n- reaction.deleted\n","operationId":"DeleteReaction","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID to remove reaction from","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"type","required":true,"schema":{"description":"Reaction type to remove","title":"Type","type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"description":"**Server-side only**. User ID which server acts upon","title":"User ID","type":"string","writeOnly":true,"x-stream-index":"003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteReactionResponse"}}},"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":"Delete reaction","tags":["product:chat"]}},"/api/v2/chat/messages/{id}/reactions":{"get":{"description":"Returns list of reactions of specific message\n","operationId":"GetReactions","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"limit","schema":{"description":"Number of records to return","format":"int32","title":"Limit","type":"integer","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"offset","schema":{"description":"Number of records to offset","format":"int32","title":"Offset","type":"integer","writeOnly":true,"x-stream-index":"003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetReactionsResponse"}}},"description":"Successful 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":"Get reactions","tags":["product:chat"]},"post":{"description":"Get reactions on a message\n","operationId":"QueryReactions","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryReactionsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryReactionsResponse"}}},"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"}},"tags":["product:chat"]}},"/api/v2/chat/messages/{id}/translate":{"post":{"description":"Translates message to a given language using automated translation software\n\nSends events:\n- message.updated\n- message.updated\n","operationId":"TranslateMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TranslateMessageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}},"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":"Translate message","tags":["product:chat"]}},"/api/v2/chat/messages/{id}/undelete":{"post":{"description":"Undelete a message that was previously soft-deleted\n\nSends events:\n- message.undeleted\n- message.undeleted\n","operationId":"UndeleteMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"004.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessageResponse"}}},"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":"Undelete message","tags":["product:chat"]}},"/api/v2/chat/messages/{message_id}/polls/{poll_id}/vote":{"post":{"description":"Cast a vote on a poll\n\nSends events:\n- feeds.poll.vote_casted\n- feeds.poll.vote_changed\n- feeds.poll.vote_removed\n- poll.vote_casted\n- poll.vote_changed\n- poll.vote_removed\n","operationId":"CastPollVote","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CastPollVoteRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollVoteResponse"}}},"description":"Successful 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":"Cast vote","tags":["product:chat"]}},"/api/v2/chat/messages/{message_id}/polls/{poll_id}/vote/{vote_id}":{"delete":{"description":"Delete a vote from a poll\n\nSends events:\n- feeds.poll.vote_removed\n- poll.vote_removed\n","operationId":"DeletePollVote","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"004"}},{"in":"path","name":"vote_id","required":true,"schema":{"description":"Vote ID","maxLength":255,"title":"string","type":"string","x-stream-index":"005"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollVoteResponse"}}},"description":"Successful 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":"Delete vote","tags":["product:chat"]}},"/api/v2/chat/messages/{message_id}/reminders":{"delete":{"description":"Deletes a user's created reminder\n\nSends events:\n- reminder.deleted\n","operationId":"DeleteReminder","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteReminderResponse"}}},"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":"Delete reminder","tags":["product:chat"]},"patch":{"description":"Updates an existing reminder\n\nSends events:\n- reminder.updated\n","operationId":"UpdateReminder","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateReminderRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateReminderResponse"}}},"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":"Updates Reminder","tags":["product:chat"]},"post":{"description":"Creates a new reminder\n\nSends events:\n- reminder.created\n","operationId":"CreateReminder","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateReminderRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReminderResponseData"}}},"description":"Successful 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":"Create reminder","tags":["product:chat"]}},"/api/v2/chat/messages/{parent_id}/replies":{"get":{"description":"Returns replies (thread) of the message\n","operationId":"GetReplies","parameters":[{"in":"path","name":"parent_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"sort","schema":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":1,"type":"array","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"limit","schema":{"description":"The maximum number of messages to return (max limit ","format":"int32","minimum":0,"title":"Limit","type":"integer","x-stream-index":"003.001"}},{"in":"query","name":"offset","schema":{"description":"The offset to start from","format":"int32","title":"Offset","type":"integer","x-stream-index":"003.002"}},{"in":"query","name":"id_gte","schema":{"description":"The ID of the message to get messages with a timestamp greater than or equal to","title":"IDGTE","type":"string","x-stream-index":"003.003"}},{"in":"query","name":"id_gt","schema":{"description":"The ID of the message to get messages with a timestamp greater than","title":"IDGT","type":"string","x-stream-index":"003.004"}},{"in":"query","name":"id_lte","schema":{"description":"The ID of the message to get messages with a timestamp smaller than or equal to","title":"IDLTE","type":"string","x-stream-index":"003.005"}},{"in":"query","name":"id_lt","schema":{"description":"The ID of the message to get messages with a timestamp smaller than","title":"IDLT","type":"string","x-stream-index":"003.006"}},{"in":"query","name":"created_at_after_or_equal","schema":{"description":"The timestamp to get messages with a created_at timestamp greater than or equal to","format":"date-time","title":"Created_at after or equal","type":"number","x-stream-index":"003.007"}},{"in":"query","name":"created_at_after","schema":{"description":"The timestamp to get messages with a created_at timestamp greater than","format":"date-time","title":"Created_at after","type":"number","x-stream-index":"003.008"}},{"in":"query","name":"created_at_before_or_equal","schema":{"description":"The timestamp to get messages with a created_at timestamp smaller than or equal to","format":"date-time","title":"Created_at after before or equal","type":"number","x-stream-index":"003.009"}},{"in":"query","name":"created_at_before","schema":{"description":"The timestamp to get messages with a created_at timestamp smaller than","format":"date-time","title":"Created_at after before","type":"number","x-stream-index":"003.010"}},{"in":"query","name":"id_around","schema":{"description":"The result will be a set of messages, that are both older and newer than the message with the provided ID, and the message with the ID provided will be in the middle of the set","title":"Id around","type":"string","x-stream-index":"003.011"}},{"in":"query","name":"created_at_around","schema":{"description":"The result will be a set of messages, that are both older and newer than the created_at timestamp provided, distributed evenly around the timestamp","format":"date-time","title":"Created_at around","type":"number","x-stream-index":"003.012"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRepliesResponse"}}},"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":"Get replies","tags":["product:chat"]}},"/api/v2/chat/moderation/flags/message":{"get":{"description":"Find and filter message flags\n","operationId":"QueryMessageFlags","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryMessageFlagsPayload","description":"JSON object with query message flags payload","title":"Payload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryMessageFlagsResponse"}}},"description":"QueryMessageFlagsResponse"},"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":"Query Message Flags","tags":["product:chat"]}},"/api/v2/chat/moderation/mute/channel":{"post":{"description":"Mutes channel for user\n\nSends events:\n- channel.muted\n- channel.muted\n","operationId":"MuteChannel","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteChannelResponse"}}},"description":"Successful 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":"Mute channel","tags":["product:chat"]}},"/api/v2/chat/moderation/unmute/channel":{"post":{"description":"Unmutes channel for user\n\nSends events:\n- channel.unmuted\n- channel.unmuted\n","operationId":"UnmuteChannel","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnmuteChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnmuteResponse"}}},"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":"Unmute channel","tags":["product:chat"]}},"/api/v2/chat/push_preferences":{"post":{"description":"Update the push preferences for a user and or channel member. Set to all, mentions or none\n","operationId":"UpdatePushNotificationPreferences","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertPushPreferencesRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertPushPreferencesResponse"}}},"description":"Successful 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":"Push notification preferences","tags":["product:chat"]}},"/api/v2/chat/push_templates":{"get":{"description":"Retrieve push notification templates for Chat.\n","operationId":"GetPushTemplates","parameters":[{"in":"query","name":"push_provider_name","schema":{"description":"Push provider name to filter templates","title":"string","type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"push_provider_type","required":true,"schema":{"description":"Push provider type (firebase, apn) to filter templates","enum":["firebase","apn"],"title":"string","type":"string","writeOnly":true,"x-stream-index":"003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPushTemplatesResponse"}}},"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":"Get push notification templates","tags":["product:chat"]},"post":{"description":"Create or update a push notification template for a specific event type and push provider\n","operationId":"UpsertPushTemplate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertPushTemplateRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertPushTemplateResponse"}}},"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":"Upsert a push notification template","tags":["product:chat"]}},"/api/v2/chat/query_banned_users":{"get":{"description":"Find and filter channel scoped or global user bans\n","operationId":"QueryBannedUsers","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryBannedUsersPayload","description":"JSON object with query user bans payload","title":"Payload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryBannedUsersResponse"}}},"description":"Successful 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":"Query Banned Users","tags":["product:chat"]}},"/api/v2/chat/reminders/query":{"post":{"description":"Queries reminders\n","operationId":"QueryReminders","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryRemindersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryRemindersResponse"}}},"description":"Successful 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":"Query reminders","tags":["product:chat"]}},"/api/v2/chat/search":{"get":{"description":"Search messages across channels\n","operationId":"Search","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchPayload","description":"JSON object with search payload","title":"Payload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchResponse"}}},"description":"Successful 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":"Search messages","tags":["product:chat"]}},"/api/v2/chat/segments/query":{"post":{"description":"Query segments\n","operationId":"QuerySegments","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuerySegmentsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuerySegmentsResponse"}}},"description":"Successful 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":"Query segments","tags":["product:chat"]}},"/api/v2/chat/segments/{id}":{"delete":{"description":"Delete a segment\n","operationId":"DeleteSegment","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete segment","tags":["product:chat"]},"get":{"description":"Get segment\n","operationId":"GetSegment","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetSegmentResponse"}}},"description":"Successful 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":"Get segment","tags":["product:chat"]}},"/api/v2/chat/segments/{id}/deletetargets":{"post":{"description":"Delete targets from a segment\n","operationId":"DeleteSegmentTargets","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteSegmentTargetsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete targets from a segment","tags":["product:chat"]}},"/api/v2/chat/segments/{id}/target/{target_id}":{"get":{"description":"Check whether a target exists in a segment. Returns 200 if the target exists, 404 otherwise\n","operationId":"SegmentTargetExists","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"target_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Check whether a target exists in a segment","tags":["product:chat"]}},"/api/v2/chat/segments/{id}/targets/query":{"post":{"description":"Query segment targets\n","operationId":"QuerySegmentTargets","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuerySegmentTargetsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuerySegmentTargetsResponse"}}},"description":"Successful 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":"Query segment targets","tags":["product:chat"]}},"/api/v2/chat/threads":{"post":{"description":"Returns the list of threads for specific user\n","operationId":"QueryThreads","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryThreadsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryThreadsResponse"}}},"description":"Successful 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":"Query Threads","tags":["product:chat"]}},"/api/v2/chat/threads/{message_id}":{"get":{"description":"Return a specific thread\n","operationId":"GetThread","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"reply_limit","schema":{"description":"Limit the number of replies returned","format":"int32","minimum":0,"title":"Reply limit","type":"integer","writeOnly":true,"x-stream-index":"004"}},{"in":"query","name":"participant_limit","schema":{"description":"Limit the number of participants returned","format":"int32","maximum":100,"minimum":0,"title":"Participant limit","type":"integer","writeOnly":true,"x-stream-index":"005"}},{"in":"query","name":"member_limit","schema":{"description":"Limit the number of members returned per thread channel","format":"int32","maximum":100,"minimum":0,"title":"Member limit","type":"integer","writeOnly":true,"x-stream-index":"006"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetThreadResponse"}}},"description":"Successful 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":"Get Thread","tags":["product:chat"]},"patch":{"description":"Updates certain fields of the thread\n\nSends events:\n- thread.updated\n- thread.updated\n","operationId":"UpdateThreadPartial","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateThreadPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateThreadPartialResponse"}}},"description":"Successful 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":"Partially update thread","tags":["product:chat"]}},"/api/v2/chat/unread":{"get":{"description":"Fetch unread counts for a single user\n","operationId":"UnreadCounts","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WrappedUnreadCountsResponse"}}},"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":"Unread counts","tags":["product:chat"]}},"/api/v2/chat/unread_batch":{"post":{"description":"Fetch unread counts in batch for multiple users in one call\n","operationId":"UnreadCountsBatch","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnreadCountsBatchRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnreadCountsBatchResponse"}}},"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":"Batch unread counts","tags":["product:chat"]}},"/api/v2/chat/users/{user_id}/event":{"post":{"description":"Sends a custom event to a user\n\nSends events:\n- *\n","operationId":"SendUserCustomEvent","parameters":[{"in":"path","name":"user_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendUserCustomEventRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Send user event","tags":["product:chat"]}},"/api/v2/check_push":{"post":{"description":"Sends a test message via push, this is a test endpoint to verify your push settings\n","operationId":"CheckPush","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckPushRequest"}}},"description":"CheckPushRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckPushResponse"}}},"description":"Successful 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":"Check push","tags":["product:common"]}},"/api/v2/check_sns":{"post":{"description":"Validates Amazon SNS configuration\n","operationId":"CheckSNS","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSNSRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSNSResponse"}}},"description":"Successful 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":"Check SNS","tags":["product:common"]}},"/api/v2/check_sqs":{"post":{"description":"Validates Amazon SQS credentials\n","operationId":"CheckSQS","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSQSRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSQSResponse"}}},"description":"Successful 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":"Check SQS","tags":["product:common"]}},"/api/v2/devices":{"delete":{"description":"Deletes one device\n","operationId":"DeleteDevice","parameters":[{"in":"query","name":"id","required":true,"schema":{"description":"Device ID to delete","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"user_id","schema":{"description":"**Server-side only**. User ID which server acts upon","title":"User ID","type":"string","writeOnly":true,"x-stream-index":"002.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete device","tags":["product:common"]},"get":{"description":"Returns all available devices\n","operationId":"ListDevices","parameters":[{"in":"query","name":"user_id","schema":{"description":"**Server-side only**. User ID which server acts upon","title":"User ID","type":"string","writeOnly":true,"x-stream-index":"001.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDevicesResponse"}}},"description":"ListDevicesResponse"},"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":"List devices","tags":["product:common"]},"post":{"description":"Adds a new device to a user, if the same device already exists the call will have no effect\n","operationId":"CreateDevice","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDeviceRequest"}}},"description":"CreateDeviceRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Create device","tags":["product:common"]}},"/api/v2/export/users":{"post":{"description":"Exports user profile, reactions and messages for list of given users\n","operationId":"ExportUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportUsersResponse"}}},"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":"Export users","tags":["product:common"]}},"/api/v2/external_storage":{"get":{"description":"Lists external storage\n","operationId":"ListExternalStorage","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListExternalStorageResponse"}}},"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":"List external storage","tags":["product:common"]},"post":{"description":"Creates new external storage\n","operationId":"CreateExternalStorage","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateExternalStorageRequest"}}},"description":"CreateExternalStorageRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateExternalStorageResponse"}}},"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":"Create external storage","tags":["product:common"]}},"/api/v2/external_storage/{name}":{"delete":{"description":"Deletes external storage\n","operationId":"DeleteExternalStorage","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteExternalStorageResponse"}}},"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":"Delete external storage","tags":["product:common"]},"put":{"description":"\n","operationId":"UpdateExternalStorage","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateExternalStorageRequest"}}},"description":"ExternalStorageRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateExternalStorageResponse"}}},"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":"Update External Storage","tags":["product:common"]}},"/api/v2/external_storage/{name}/check":{"get":{"description":"\n","operationId":"CheckExternalStorage","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckExternalStorageResponse"}}},"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":"Check External Storage","tags":["product:common"]}},"/api/v2/guest":{"post":{"description":"\n","operationId":"CreateGuest","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGuestRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGuestResponse"}}},"description":"Successful 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":"Create Guest","tags":["product:common"]}},"/api/v2/import_urls":{"post":{"description":"Creates a new import URL\n","operationId":"CreateImportURL","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateImportURLRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateImportURLResponse"}}},"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":"Create import URL","tags":["product:common"]}},"/api/v2/imports":{"get":{"description":"Gets an import\n","operationId":"ListImports","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListImportsResponse"}}},"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":"Get import","tags":["product:common"]},"post":{"description":"Creates a new import\n","operationId":"CreateImport","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateImportRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateImportResponse"}}},"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":"Create import","tags":["product:common"]}},"/api/v2/imports/{id}":{"get":{"description":"Gets an import\n","operationId":"GetImport","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetImportResponse"}}},"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":"Get import","tags":["product:common"]}},"/api/v2/moderation/ban":{"post":{"description":"Ban a user from a channel or the entire app\n","operationId":"ban","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BanRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BanResponse"}}},"description":"Successful 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":"Ban","tags":["product:moderation"]}},"/api/v2/moderation/bulk_image_moderation":{"post":{"description":"Moderate multiple images in bulk using a CSV file\n","operationId":"bulk_image_moderation","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkImageModerationRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkImageModerationResponse"}}},"description":"Successful 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":"Bulk image moderation","tags":["product:moderation"]}},"/api/v2/moderation/check":{"post":{"description":"Run moderation checks on the provided content\n","operationId":"check","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckResponse"}}},"description":"Successful 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":"Check","tags":["product:moderation"]}},"/api/v2/moderation/config":{"post":{"description":"Create a new moderation configuration or update an existing one. Configure settings for content filtering, AI analysis, toxicity detection, and other moderation features.\n","operationId":"upsert_config","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertConfigRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertConfigResponse"}}},"description":"Successful 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":"Create or update moderation configuration","tags":["product:moderation"]}},"/api/v2/moderation/config/{key}":{"delete":{"description":"Delete a specific moderation policy by its name\n","operationId":"delete_config","parameters":[{"in":"path","name":"key","required":true,"schema":{"description":"Key of the moderation configuration to delete","title":"Key","type":"string","x-stream-index":"001"}},{"in":"query","name":"team","schema":{"description":"Team associated with the configuration","title":"Team","type":"string","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteModerationConfigResponse"}}},"description":"Successful 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":"Delete a moderation policy","tags":["product:moderation"]},"get":{"description":"Retrieve a specific moderation configuration by its key and team. This configuration contains settings for various moderation features like toxicity detection, AI analysis, and filtering rules.\n","operationId":"get_config","parameters":[{"in":"path","name":"key","required":true,"schema":{"description":"Key of the moderation configuration to retrieve","title":"Key","type":"string","x-stream-index":"001"}},{"in":"query","name":"team","schema":{"description":"Team associated with the configuration","title":"Team","type":"string","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetConfigResponse"}}},"description":"Successful 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":"Get moderation configuration","tags":["product:moderation"]}},"/api/v2/moderation/configs":{"post":{"description":"Search and filter moderation configurations across your application. This endpoint is designed for building moderation dashboards and managing multiple configuration sets.\n","operationId":"query_moderation_configs","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationConfigsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationConfigsResponse"}}},"description":"Successful 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":"Query moderation configurations","tags":["product:moderation"]}},"/api/v2/moderation/custom_check":{"post":{"description":"Custom check, add your own AI model reports to the review queue\n","operationId":"custom_check","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomCheckRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomCheckResponse"}}},"description":"Successful 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":"Custom check endpoint","tags":["product:moderation"]}},"/api/v2/moderation/feeds_moderation_template":{"delete":{"description":"Delete a specific moderation template by its name\n","operationId":"V2DeleteTemplate","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteModerationTemplateResponse"}}},"description":"Successful 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":"Delete a moderation template","tags":["product:moderation"]},"get":{"description":"Retrieve a list of feed moderation templates that define preset moderation rules and configurations. Limited to 100 templates per request.\n","operationId":"V2QueryTemplates","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryFeedModerationTemplatesResponse"}}},"description":"Successful 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":"Query feed moderation templates","tags":["product:moderation"]},"post":{"description":"Upsert feeds template for moderation\n","operationId":"V2UpsertTemplate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertModerationTemplateRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertModerationTemplateResponse"}}},"description":"Successful 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":"Upsert feeds template","tags":["product:moderation"]}},"/api/v2/moderation/flag":{"post":{"description":"Flag any type of content (messages, users, channels, activities) for moderation review. Supports custom content types and additional metadata for flagged content.\n","operationId":"flag","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlagRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlagResponse"}}},"description":"Successful 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":"Flag content for moderation","tags":["product:moderation"]}},"/api/v2/moderation/flags":{"post":{"description":"Query flags associated with moderation items. This is used for building a moderation dashboard.\n","operationId":"query_moderation_flags","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationFlagsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationFlagsResponse"}}},"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":"Query moderation flags","tags":["product:moderation"]}},"/api/v2/moderation/logs":{"post":{"description":"Search and filter moderation action logs with support for pagination. View the history of moderation actions taken, including who performed them and when.\n","operationId":"query_moderation_logs","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationLogsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationLogsResponse"}}},"description":"Successful 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":"Query moderation action logs","tags":["product:moderation"]}},"/api/v2/moderation/moderation_rule":{"post":{"description":"Create or update a moderation rule that can apply app-wide or to specific moderation configs\n","operationId":"upsert_moderation_rule","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertModerationRuleRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertModerationRuleResponse"}}},"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":"Upsert moderation rule","tags":["product:moderation"]}},"/api/v2/moderation/moderation_rule/{id}":{"delete":{"description":"Delete an existing moderation rule\n","operationId":"delete_moderation_rule","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteModerationRuleResponse"}}},"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":"Delete moderation rule","tags":["product:moderation"]},"get":{"description":"Get a specific moderation rule by ID\n","operationId":"get_moderation_rule","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetModerationRuleResponse"}}},"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":"Get moderation rule","tags":["product:moderation"]}},"/api/v2/moderation/moderation_rules":{"post":{"description":"Search and filter moderation rules across your application. This endpoint is designed for building moderation dashboards and managing multiple rule sets.\n","operationId":"query_moderation_rules","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationRulesRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationRulesResponse"}}},"description":"Successful 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":"Query moderation rules","tags":["product:moderation"]}},"/api/v2/moderation/mute":{"post":{"description":"Mute a user. Mutes are generally not visible to the user you mute, while block is something you notice.\n","operationId":"mute","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteRequest"}}},"description":"MuteRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteResponse"}}},"description":"MuteResponse"},"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":"Mute","tags":["product:moderation"]}},"/api/v2/moderation/review_queue":{"post":{"description":"Query review queue items allows you to filter the review queue items. This is used for building a moderation dashboard.\n","operationId":"query_review_queue","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryReviewQueueRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryReviewQueueResponse"}}},"description":"Successful 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":"Query review queue items","tags":["product:moderation"]}},"/api/v2/moderation/review_queue/{id}":{"get":{"description":"Retrieve a specific review queue item by its ID\n","operationId":"get_review_queue_item","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Unique identifier of the review queue item to retrieve","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetReviewQueueItemResponse"}}},"description":"Successful 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":"Get review queue item","tags":["product:moderation"]}},"/api/v2/moderation/submit_action":{"post":{"description":"Take action on flagged content, such as marking content as safe, deleting content, banning users, or executing custom moderation actions. Supports various action types with configurable parameters.\n","operationId":"submit_action","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitActionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitActionResponse"}}},"description":"Successful 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":"Submit moderation action","tags":["product:moderation"]}},"/api/v2/moderation/unban":{"post":{"description":"Unban a user from a channel or globally.\n","operationId":"unban","parameters":[{"in":"query","name":"target_user_id","required":true,"schema":{"description":"ID of the user to unban","title":"Target User ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"channel_cid","schema":{"description":"Channel where the unban applies","title":"Channel CID","type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"created_by","schema":{"description":"ID of the user who created the ban","title":"Created By","type":"string","writeOnly":true,"x-stream-index":"003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnbanRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnbanResponse"}}},"description":"Successful 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":"Unban","tags":["product:moderation"]}},"/api/v2/moderation/unmute":{"post":{"description":"Unmute a user\n","operationId":"unmute","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnmuteRequest"}}},"description":"UnmuteRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnmuteResponse"}}},"description":"UnmuteResponse"},"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":"Unmute a user","tags":["product:moderation"]}},"/api/v2/og":{"get":{"description":"Get an OpenGraph attachment for a link\n","operationId":"GetOG","parameters":[{"in":"query","name":"url","required":true,"schema":{"description":"URL to be scraped","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOGResponse"}}},"description":"Get OG Attachment"},"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":"Get OG","tags":["product:common"]}},"/api/v2/permissions":{"get":{"description":"Lists all available permissions\n","operationId":"ListPermissions","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPermissionsResponse"}}},"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":"List permissions","tags":["product:common"]}},"/api/v2/permissions/{id}":{"get":{"description":"Gets custom permission\n","operationId":"GetPermission","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Permission ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCustomPermissionResponse"}}},"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":"Get permission","tags":["product:common"]}},"/api/v2/polls":{"post":{"description":"Creates a new poll\n","operationId":"CreatePoll","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePollRequest"}}},"description":"Create Poll Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Create poll","tags":["product:common"]},"put":{"description":"Updates a poll\n\nSends events:\n- feeds.poll.closed\n- feeds.poll.updated\n- poll.closed\n- poll.updated\n","operationId":"UpdatePoll","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePollRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Update poll","tags":["product:common"]}},"/api/v2/polls/query":{"post":{"description":"Queries polls\n","operationId":"QueryPolls","parameters":[{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryPollsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryPollsResponse"}}},"description":"Successful 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":"Query polls","tags":["product:common"]}},"/api/v2/polls/{poll_id}":{"delete":{"description":"Deletes a poll\n\nSends events:\n- feeds.poll.deleted\n- poll.deleted\n","operationId":"DeletePoll","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete poll","tags":["product:common"]},"get":{"description":"Retrieves a poll\n","operationId":"GetPoll","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Get poll","tags":["product:common"]},"patch":{"description":"Updates a poll partially\n\nSends events:\n- feeds.poll.closed\n- feeds.poll.updated\n- poll.closed\n- poll.updated\n","operationId":"UpdatePollPartial","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePollPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Partial update poll","tags":["product:common"]}},"/api/v2/polls/{poll_id}/options":{"post":{"description":"Creates a poll option\n\nSends events:\n- feeds.poll.updated\n- poll.updated\n","operationId":"CreatePollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePollOptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollOptionResponse"}}},"description":"Successful 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":"Create poll option","tags":["product:common"]},"put":{"description":"Updates a poll option\n\nSends events:\n- feeds.poll.updated\n- poll.updated\n","operationId":"UpdatePollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePollOptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollOptionResponse"}}},"description":"Successful 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":"Update poll option","tags":["product:common"]}},"/api/v2/polls/{poll_id}/options/{option_id}":{"delete":{"description":"Deletes a poll option\n\nSends events:\n- feeds.poll.updated\n- poll.updated\n","operationId":"DeletePollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"path","name":"option_id","required":true,"schema":{"description":"Option ID","maxLength":255,"title":"string","type":"string","x-stream-index":"003"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete poll option","tags":["product:common"]},"get":{"description":"Retrieves a poll option\n","operationId":"GetPollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"path","name":"option_id","required":true,"schema":{"description":"Option ID","maxLength":255,"title":"string","type":"string","x-stream-index":"003"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollOptionResponse"}}},"description":"Successful 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":"Get poll option","tags":["product:common"]}},"/api/v2/polls/{poll_id}/votes":{"post":{"description":"Queries votes\n","operationId":"QueryPollVotes","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryPollVotesRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollVotesResponse"}}},"description":"Successful 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":"Query votes","tags":["product:common"]}},"/api/v2/push_providers":{"get":{"description":"List details of all push providers.\n","operationId":"ListPushProviders","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPushProvidersResponse"}}},"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":"List push providers","tags":["product:common"]},"post":{"description":"Upsert a push provider for v2 with multi bundle/package support\n","operationId":"UpsertPushProvider","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertPushProviderRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertPushProviderResponse"}}},"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":"Upsert a push provider","tags":["product:common"]}},"/api/v2/push_providers/{type}/{name}":{"delete":{"description":"Delete a push provider from v2 with multi bundle/package support. v1 isn't supported in this endpoint\n","operationId":"DeletePushProvider","parameters":[{"in":"path","name":"type","required":true,"schema":{"enum":["apn","firebase","huawei","xiaomi"],"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"name","required":true,"schema":{"maxLength":36,"minLength":1,"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete a push provider","tags":["product:common"]}},"/api/v2/rate_limits":{"get":{"description":"Get rate limits usage and quotas\n","operationId":"GetRateLimits","parameters":[{"in":"query","name":"server_side","schema":{"description":"Whether to include server-side platform limits or not","title":"Server-side","type":"boolean","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"android","schema":{"description":"Whether to include Android platform limits or not","title":"Android","type":"boolean","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"ios","schema":{"description":"Whether to include iOS platform limits or not","title":"iOS","type":"boolean","writeOnly":true,"x-stream-index":"003"}},{"in":"query","name":"web","schema":{"description":"Whether to include web platform limits or not","title":"Web","type":"boolean","writeOnly":true,"x-stream-index":"004"}},{"in":"query","name":"endpoints","schema":{"description":"Specific endpoints to show limits for, as a comma-separated list of values","title":"Endpoints","type":"string","writeOnly":true,"x-stream-index":"005"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRateLimitsResponse"}}},"description":"Get Rate Limits 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":"Get rate limits","tags":["product:common"]}},"/api/v2/roles":{"get":{"description":"Lists all available roles\n","operationId":"ListRoles","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListRolesResponse"}}},"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":"List roles","tags":["product:common"]},"post":{"description":"Creates custom role\n","operationId":"CreateRole","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRoleRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRoleResponse"}}},"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":"Create role","tags":["product:common"]}},"/api/v2/roles/{name}":{"delete":{"description":"Deletes custom role\n","operationId":"DeleteRole","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Role name","title":"Name","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete role","tags":["product:common"]}},"/api/v2/tasks/{id}":{"get":{"description":"Gets status of a task\n","operationId":"GetTask","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Task ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetTaskResponse"}}},"description":"Get Task 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":"Get status of a task","tags":["product:common"]}},"/api/v2/uploads/file":{"delete":{"description":"Deletes previously uploaded file\n","operationId":"DeleteFileGlobal","parameters":[{"in":"query","name":"url","schema":{"description":"File URL to delete","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete file","tags":["product:common"],"x-stream-sdk-name":"DeleteFile"},"post":{"description":"Uploads file\n","operationId":"UploadFileGlobal","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/FileUploadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileUploadResponse"}}},"description":"Successful 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":"Upload file","tags":["product:common"],"x-stream-sdk-name":"UploadFile"}},"/api/v2/uploads/image":{"delete":{"description":"Deletes previously uploaded image\n","operationId":"DeleteImageGlobal","parameters":[{"in":"query","name":"url","schema":{"description":"File URL to delete","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete image","tags":["product:common"],"x-stream-sdk-name":"DeleteImage"},"post":{"description":"Uploads image\n","operationId":"UploadImageGlobal","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/ImageUploadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageUploadResponse"}}},"description":"Successful 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":"Upload image","tags":["product:common"],"x-stream-sdk-name":"UploadImage"}},"/api/v2/users":{"get":{"description":"Find and filter users\n","operationId":"QueryUsers","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryUsersPayload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryUsersResponse"}}},"description":"Successful 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":"Query users","tags":["product:common"]},"patch":{"description":"Updates certain fields of the user\n\nSends events:\n- user.presence.changed\n- user.updated\n- user.presence.changed\n","operationId":"UpdateUsersPartial","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersResponse"}}},"description":"Successful 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":"Partially update user","tags":["product:common"]},"post":{"description":"Update or create users in bulk\n\nSends events:\n- user.updated\n","operationId":"UpdateUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersResponse"}}},"description":"Successful 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":"Upsert users","tags":["product:common"]}},"/api/v2/users/block":{"get":{"description":"Get list of blocked Users\n","operationId":"GetBlockedUsers","parameters":[{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBlockedUsersResponse"}}},"description":"Successful 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":"Get list of blocked Users","tags":["product:common"]},"post":{"description":"Block users\n","operationId":"BlockUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUsersResponse"}}},"description":"Successful 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":"Block user","tags":["product:common"]}},"/api/v2/users/deactivate":{"post":{"description":"Deactivate users in batches\n\nSends events:\n- user.deactivated\n","operationId":"DeactivateUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeactivateUsersRequest"}}},"description":"DeactivateUsersRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeactivateUsersResponse"}}},"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":"Deactivate users","tags":["product:common"]}},"/api/v2/users/delete":{"post":{"description":"Deletes users and optionally all their belongings asynchronously.\n\nSends events:\n- channel.deleted\n- user.deleted\n","operationId":"DeleteUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteUsersResponse"}}},"description":"Successful 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":"Delete Users","tags":["product:common"]}},"/api/v2/users/live_locations":{"get":{"description":"Retrieves all active live locations for a user\n","operationId":"GetUserLiveLocations","parameters":[{"in":"query","name":"user_id","schema":{"description":"User ID to get live locations for. If not provided, returns live locations for the authenticated user.","title":"string","type":"string","writeOnly":true,"x-stream-index":"001.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SharedLocationsResponse"}}},"description":"Successful 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":"Get user live locations","tags":["product:common"]},"put":{"description":"Updates an existing live location with new coordinates or expiration time\n","operationId":"UpdateLiveLocation","parameters":[{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"005.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateLiveLocationRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SharedLocationResponse"}}},"description":"Successful 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":"Update live location","tags":["product:common"]}},"/api/v2/users/reactivate":{"post":{"description":"Reactivate users in batches\n\nSends events:\n- user.reactivated\n- user.reactivated\n","operationId":"ReactivateUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReactivateUsersRequest"}}},"description":"ReactivateUsersRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReactivateUsersResponse"}}},"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":"Reactivate users","tags":["product:common"]}},"/api/v2/users/restore":{"post":{"description":"Restore soft deleted users\n","operationId":"RestoreUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestoreUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Restore users","tags":["product:common"]}},"/api/v2/users/unblock":{"post":{"description":"Unblock users\n","operationId":"UnblockUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUsersResponse"}}},"description":"Successful 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":"Unblock user","tags":["product:common"]}},"/api/v2/users/{user_id}/deactivate":{"post":{"description":"Deactivates user with possibility to activate it back\n\nSends events:\n- user.deactivated\n","operationId":"DeactivateUser","parameters":[{"in":"path","name":"user_id","required":true,"schema":{"title":"User ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeactivateUserRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeactivateUserResponse"}}},"description":"Successful 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":"Deactivate user","tags":["product:common"]}},"/api/v2/users/{user_id}/export":{"get":{"description":"Exports the user's profile, reactions and messages. Raises an error if a user has more than 10k messages or reactions\n","operationId":"ExportUser","parameters":[{"in":"path","name":"user_id","required":true,"schema":{"title":"User ID","type":"string","x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportUserResponse"}}},"description":"Successful 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":"Export user","tags":["product:common"]}},"/api/v2/users/{user_id}/reactivate":{"post":{"description":"Activates user who's been deactivated previously\n\nSends events:\n- user.reactivated\n","operationId":"ReactivateUser","parameters":[{"in":"path","name":"user_id","required":true,"schema":{"title":"User ID","type":"string","x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReactivateUserRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReactivateUserResponse"}}},"description":"Successful 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":"Reactivate user","tags":["product:common"]}}},"security":[{"JWT":[],"api_key":[],"stream-auth-type":[]},{"api_key":[],"stream-auth-type":[]}],"servers":[{"description":"Stream API","url":"https://chat.stream-io-api.com"}]} \ No newline at end of file diff --git a/openapi/v2/chat-serverside-api.yaml b/openapi/v2/chat-serverside-api.yaml index b8cdb024d..542679f08 100644 --- a/openapi/v2/chat-serverside-api.yaml +++ b/openapi/v2/chat-serverside-api.yaml @@ -578,6 +578,9 @@ components: moderation_enabled: type: boolean x-stream-index: "041" + moderation_llm_configurability_enabled: + type: boolean + x-stream-index: "049" moderation_multitenant_blocklist_enabled: type: boolean x-stream-index: "042" @@ -699,6 +702,7 @@ components: - use_hook_v2 - user_response_time_enabled - moderation_bulk_submit_action_enabled + - moderation_llm_configurability_enabled type: object AsyncBulkImageModerationEvent: nullable: true @@ -824,7 +828,7 @@ components: type: string x-stream-index: "002.001" type: - default: export.moderation_logs.error + default: export.users.error type: string x-stream-index: "003.002" required: @@ -1356,11 +1360,6 @@ components: shadow_ban: type: boolean x-stream-index: "003" - required: - - duration - - reason - - shadow_ban - - ip_ban type: object BanRequest: nullable: true @@ -1450,8 +1449,6 @@ components: reason: type: string x-stream-index: "001" - required: - - reason type: object BlockListConfig: properties: @@ -2940,6 +2937,14 @@ components: $ref: '#/components/schemas/ChannelMember' type: array x-stream-index: "020" + message_count: + format: int64 + type: integer + x-stream-index: "035" + message_count_updated_at: + format: date-time + type: number + x-stream-index: "036" team: type: string x-stream-index: "028" @@ -2970,39 +2975,39 @@ components: items: type: string type: array - x-stream-index: "001.026" + x-stream-index: "001.027" automod: enum: - disabled - simple - AI type: string - x-stream-index: "001.021" + x-stream-index: "001.022" automod_behavior: enum: - flag - block - shadow_block type: string - x-stream-index: "001.022" + x-stream-index: "001.023" automod_thresholds: $ref: '#/components/schemas/Thresholds' - x-stream-index: "001.027" + x-stream-index: "001.028" blocklist: type: string - x-stream-index: "001.023" + x-stream-index: "001.024" blocklist_behavior: enum: - flag - block - shadow_block type: string - x-stream-index: "001.024" + x-stream-index: "001.025" blocklists: items: $ref: '#/components/schemas/BlockListOptions' type: array - x-stream-index: "001.025" + x-stream-index: "001.026" commands: items: type: string @@ -3011,6 +3016,9 @@ components: connect_events: type: boolean x-stream-index: "001.004" + count_messages: + type: boolean + x-stream-index: "001.019" created_at: format: date-time type: number @@ -3025,7 +3033,7 @@ components: format: int32 maximum: 20000 type: integer - x-stream-index: "001.020" + x-stream-index: "001.021" mutes: type: boolean x-stream-index: "001.009" @@ -3035,10 +3043,10 @@ components: partition_size: format: int32 type: integer - x-stream-index: "001.028" + x-stream-index: "001.029" partition_ttl: type: integer - x-stream-index: "001.029" + x-stream-index: "001.030" polls: type: boolean x-stream-index: "001.016" @@ -3068,7 +3076,7 @@ components: x-stream-index: "001.018" skip_last_msg_update_for_system_msgs: type: boolean - x-stream-index: "001.030" + x-stream-index: "001.031" typing_events: type: boolean x-stream-index: "001.002" @@ -3104,6 +3112,7 @@ components: - polls - user_message_reminders - shared_locations + - count_messages - message_retention - max_message_length - automod @@ -3119,39 +3128,39 @@ components: items: type: string type: array - x-stream-index: 001.002.026 + x-stream-index: 001.002.027 automod: enum: - disabled - simple - AI type: string - x-stream-index: 001.002.021 + x-stream-index: 001.002.022 automod_behavior: enum: - flag - block - shadow_block type: string - x-stream-index: 001.002.022 + x-stream-index: 001.002.023 automod_thresholds: $ref: '#/components/schemas/Thresholds' - x-stream-index: 001.002.027 + x-stream-index: 001.002.028 blocklist: type: string - x-stream-index: 001.002.023 + x-stream-index: 001.002.024 blocklist_behavior: enum: - flag - block - shadow_block type: string - x-stream-index: 001.002.024 + x-stream-index: 001.002.025 blocklists: items: $ref: '#/components/schemas/BlockListOptions' type: array - x-stream-index: 001.002.025 + x-stream-index: 001.002.026 commands: items: $ref: '#/components/schemas/Command' @@ -3160,6 +3169,9 @@ components: connect_events: type: boolean x-stream-index: 001.002.004 + count_messages: + type: boolean + x-stream-index: 001.002.019 created_at: format: date-time type: number @@ -3181,7 +3193,7 @@ components: format: int32 maximum: 20000 type: integer - x-stream-index: 001.002.020 + x-stream-index: 001.002.021 mutes: type: boolean x-stream-index: 001.002.009 @@ -3191,13 +3203,13 @@ components: partition_size: format: int32 type: integer - x-stream-index: 001.002.028 + x-stream-index: 001.002.029 partition_ttl: example: 24h format: duration nullable: true type: string - x-stream-index: 001.002.029 + x-stream-index: 001.002.030 polls: type: boolean x-stream-index: 001.002.016 @@ -3227,7 +3239,7 @@ components: x-stream-index: 001.002.018 skip_last_msg_update_for_system_msgs: type: boolean - x-stream-index: 001.002.030 + x-stream-index: 001.002.031 typing_events: type: boolean x-stream-index: 001.002.002 @@ -3265,6 +3277,7 @@ components: - polls - user_message_reminders - shared_locations + - count_messages - message_retention - max_message_length - automod @@ -3560,6 +3573,11 @@ components: format: date-time type: number x-stream-index: "011" + deleted_messages: + items: + type: string + type: array + x-stream-index: "020" invite_accepted_at: description: Date when invite was accepted format: date-time @@ -3958,6 +3976,12 @@ components: title: ChannelMembers type: array x-stream-index: "011" + message_count: + description: Number of messages in the channel + format: int64 + title: Message count + type: integer + x-stream-index: "027" mute_expires_at: description: Date of mute expiration format: date-time @@ -4024,6 +4048,11 @@ components: channel: $ref: '#/components/schemas/ChannelResponse' x-stream-index: "001.001" + deleted_messages: + items: + type: string + type: array + x-stream-index: "001.016" draft: $ref: '#/components/schemas/DraftResponse' x-stream-index: "001.014" @@ -4101,6 +4130,11 @@ components: channel: $ref: '#/components/schemas/ChannelResponse' x-stream-index: "001" + deleted_messages: + items: + type: string + type: array + x-stream-index: "016" draft: $ref: '#/components/schemas/DraftResponse' x-stream-index: "014" @@ -4229,39 +4263,39 @@ components: items: type: string type: array - x-stream-index: 003.002.026 + x-stream-index: 003.002.027 automod: enum: - disabled - simple - AI type: string - x-stream-index: 003.002.021 + x-stream-index: 003.002.022 automod_behavior: enum: - flag - block - shadow_block type: string - x-stream-index: 003.002.022 + x-stream-index: 003.002.023 automod_thresholds: $ref: '#/components/schemas/Thresholds' - x-stream-index: 003.002.027 + x-stream-index: 003.002.028 blocklist: type: string - x-stream-index: 003.002.023 + x-stream-index: 003.002.024 blocklist_behavior: enum: - flag - block - shadow_block type: string - x-stream-index: 003.002.024 + x-stream-index: 003.002.025 blocklists: items: $ref: '#/components/schemas/BlockListOptions' type: array - x-stream-index: 003.002.025 + x-stream-index: 003.002.026 commands: items: $ref: '#/components/schemas/Command' @@ -4270,6 +4304,9 @@ components: connect_events: type: boolean x-stream-index: 003.002.004 + count_messages: + type: boolean + x-stream-index: 003.002.019 created_at: format: date-time type: number @@ -4291,7 +4328,7 @@ components: format: int32 maximum: 20000 type: integer - x-stream-index: 003.002.020 + x-stream-index: 003.002.021 mutes: type: boolean x-stream-index: 003.002.009 @@ -4301,13 +4338,13 @@ components: partition_size: format: int32 type: integer - x-stream-index: 003.002.028 + x-stream-index: 003.002.029 partition_ttl: example: 24h format: duration nullable: true type: string - x-stream-index: 003.002.029 + x-stream-index: 003.002.030 permissions: items: $ref: '#/components/schemas/PolicyRequest' @@ -4342,7 +4379,7 @@ components: x-stream-index: 003.002.018 skip_last_msg_update_for_system_msgs: type: boolean - x-stream-index: 003.002.030 + x-stream-index: 003.002.031 typing_events: type: boolean x-stream-index: 003.002.002 @@ -4382,6 +4419,7 @@ components: - polls - user_message_reminders - shared_locations + - count_messages - message_retention - max_message_length - automod @@ -4707,7 +4745,6 @@ components: - entity_type - entity_id - entity_creator_id - - config_key type: object CheckResponse: nullable: true @@ -4909,6 +4946,9 @@ components: type: string type: array x-stream-index: "011" + count_messages: + type: boolean + x-stream-index: "014" grants: additionalProperties: items: @@ -4955,7 +4995,7 @@ components: $ref: '#/components/schemas/AIImageConfig' description: Configuration for AI image analysis title: AI Image Config - x-stream-index: "009" + x-stream-index: "010" ai_text_config: $ref: '#/components/schemas/AITextConfig' description: Configuration for AI text analysis @@ -4965,7 +5005,7 @@ components: $ref: '#/components/schemas/AIVideoConfig' description: Configuration for AI video analysis title: AI Video Config - x-stream-index: "010" + x-stream-index: "011" async: description: Whether moderation should be performed asynchronously title: Async @@ -4996,15 +5036,17 @@ components: format: date-time title: Created At type: number - x-stream-index: "012" + x-stream-index: "013" key: description: Unique identifier for the moderation configuration title: Key type: string x-stream-index: "001" - rule_builder_config: - $ref: '#/components/schemas/RuleBuilderConfig' - x-stream-index: "015" + llm_config: + $ref: '#/components/schemas/LLMConfig' + description: Configuration for customer-configured LLM moderation + title: LLM Config + x-stream-index: "009" team: description: Team associated with the configuration title: Team @@ -5015,15 +5057,15 @@ components: format: date-time title: Updated At type: number - x-stream-index: "013" + x-stream-index: "014" velocity_filter_config: $ref: '#/components/schemas/VelocityFilterConfig' description: Configuration for velocity-based filtering title: Velocity Filter Config - x-stream-index: "011" + x-stream-index: "012" video_call_rule_config: $ref: '#/components/schemas/VideoCallRuleConfig' - x-stream-index: "014" + x-stream-index: "015" required: - key - team @@ -5040,9 +5082,6 @@ components: time_window: type: string x-stream-index: "002" - required: - - threshold - - time_window type: object CreateBlockListRequest: description: Block list contains restricted words @@ -5286,39 +5325,39 @@ components: items: type: string type: array - x-stream-index: 001.001.026 + x-stream-index: 001.001.027 automod: enum: - disabled - simple - AI type: string - x-stream-index: 001.001.021 + x-stream-index: 001.001.022 automod_behavior: enum: - flag - block - shadow_block type: string - x-stream-index: 001.001.022 + x-stream-index: 001.001.023 automod_thresholds: $ref: '#/components/schemas/Thresholds' - x-stream-index: 001.001.027 + x-stream-index: 001.001.028 blocklist: type: string - x-stream-index: 001.001.023 + x-stream-index: 001.001.024 blocklist_behavior: enum: - flag - block - shadow_block type: string - x-stream-index: 001.001.024 + x-stream-index: 001.001.025 blocklists: items: $ref: '#/components/schemas/BlockListOptions' type: array - x-stream-index: 001.001.025 + x-stream-index: 001.001.026 commands: items: type: string @@ -5327,6 +5366,9 @@ components: connect_events: type: boolean x-stream-index: 001.001.004 + count_messages: + type: boolean + x-stream-index: 001.001.019 created_at: format: date-time type: number @@ -5351,7 +5393,7 @@ components: format: int32 maximum: 20000 type: integer - x-stream-index: 001.001.020 + x-stream-index: 001.001.021 mutes: type: boolean x-stream-index: 001.001.009 @@ -5361,13 +5403,13 @@ components: partition_size: format: int32 type: integer - x-stream-index: 001.001.028 + x-stream-index: 001.001.029 partition_ttl: example: 24h format: duration nullable: true type: string - x-stream-index: 001.001.029 + x-stream-index: 001.001.030 permissions: items: $ref: '#/components/schemas/PolicyRequest' @@ -5402,7 +5444,7 @@ components: x-stream-index: 001.001.018 skip_last_msg_update_for_system_msgs: type: boolean - x-stream-index: 001.001.030 + x-stream-index: 001.001.031 typing_events: type: boolean x-stream-index: 001.001.002 @@ -5438,6 +5480,7 @@ components: - polls - user_message_reminders - shared_locations + - count_messages - message_retention - max_message_length - automod @@ -6174,6 +6217,19 @@ components: required: - duration type: object + DeleteModerationRuleResponse: + 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 DeleteModerationTemplateResponse: nullable: true properties: @@ -6980,11 +7036,11 @@ components: properties: callback: $ref: '#/components/schemas/AsyncModerationCallbackConfig' - x-stream-index: 018.001.002 + x-stream-index: 019.001.002 created_at: format: date-time type: number - x-stream-index: "019" + x-stream-index: "020" enabled: type: boolean x-stream-index: "003" @@ -6999,6 +7055,9 @@ components: id: type: string x-stream-index: "001" + product: + type: string + x-stream-index: "018" sns_auth_type: type: string x-stream-index: "014" @@ -7038,11 +7097,11 @@ components: timeout_ms: format: int32 type: integer - x-stream-index: 018.001.001 + x-stream-index: 019.001.001 updated_at: format: date-time type: number - x-stream-index: "020" + x-stream-index: "021" webhook_url: type: string x-stream-index: "005" @@ -7289,6 +7348,48 @@ components: type: object x-stream-index: "001" type: object + FeedsEventPreferences: + properties: + comments: + type: string + x-stream-index: "002" + mentions: + type: string + x-stream-index: "004" + new_followers: + type: string + x-stream-index: "003" + reactions: + type: string + x-stream-index: "001" + type: object + FeedsEventPreferencesInput: + properties: + comments: + enum: + - all + - none + type: string + x-stream-index: "002" + mentions: + enum: + - all + - none + type: string + x-stream-index: "004" + new_followers: + enum: + - all + - none + type: string + x-stream-index: "003" + reactions: + enum: + - all + - none + type: string + x-stream-index: "001" + type: object FeedsModerationTemplateConfig: properties: config_key: @@ -7530,8 +7631,6 @@ components: reason: type: string x-stream-index: "001" - required: - - reason type: object FlagDetails: properties: @@ -7687,8 +7786,6 @@ components: reason: type: string x-stream-index: "001" - required: - - reason type: object FrameRecordSettings: properties: @@ -8018,39 +8115,39 @@ components: items: type: string type: array - x-stream-index: 003.002.026 + x-stream-index: 003.002.027 automod: enum: - disabled - simple - AI type: string - x-stream-index: 003.002.021 + x-stream-index: 003.002.022 automod_behavior: enum: - flag - block - shadow_block type: string - x-stream-index: 003.002.022 + x-stream-index: 003.002.023 automod_thresholds: $ref: '#/components/schemas/Thresholds' - x-stream-index: 003.002.027 + x-stream-index: 003.002.028 blocklist: type: string - x-stream-index: 003.002.023 + x-stream-index: 003.002.024 blocklist_behavior: enum: - flag - block - shadow_block type: string - x-stream-index: 003.002.024 + x-stream-index: 003.002.025 blocklists: items: $ref: '#/components/schemas/BlockListOptions' type: array - x-stream-index: 003.002.025 + x-stream-index: 003.002.026 commands: items: $ref: '#/components/schemas/Command' @@ -8059,6 +8156,9 @@ components: connect_events: type: boolean x-stream-index: 003.002.004 + count_messages: + type: boolean + x-stream-index: 003.002.019 created_at: format: date-time type: number @@ -8085,7 +8185,7 @@ components: format: int32 maximum: 20000 type: integer - x-stream-index: 003.002.020 + x-stream-index: 003.002.021 mutes: type: boolean x-stream-index: 003.002.009 @@ -8095,13 +8195,13 @@ components: partition_size: format: int32 type: integer - x-stream-index: 003.002.028 + x-stream-index: 003.002.029 partition_ttl: example: 24h format: duration nullable: true type: string - x-stream-index: 003.002.029 + x-stream-index: 003.002.030 permissions: items: $ref: '#/components/schemas/PolicyRequest' @@ -8136,7 +8236,7 @@ components: x-stream-index: 003.002.018 skip_last_msg_update_for_system_msgs: type: boolean - x-stream-index: 003.002.030 + x-stream-index: 003.002.031 typing_events: type: boolean x-stream-index: 003.002.002 @@ -8176,6 +8276,7 @@ components: - polls - user_message_reminders - shared_locations + - count_messages - message_retention - max_message_length - automod @@ -8324,6 +8425,22 @@ components: - duration title: Response type: object + GetModerationRuleResponse: + description: Basic response information + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "001.001" + rule: + $ref: '#/components/schemas/ModerationRuleV2Response' + x-stream-index: "002" + required: + - duration + title: Response + type: object GetOGResponse: nullable: true properties: @@ -8816,9 +8933,6 @@ components: time_window: type: string x-stream-index: "002" - required: - - threshold - - time_window type: object ImageSize: properties: @@ -9139,25 +9253,80 @@ components: - max_dimension - frame_rate_limit type: object - Label: + LLMConfig: properties: - harm_labels: - items: - type: string - type: array - x-stream-index: "003" - name: + app_context: type: string + x-stream-index: "005" + async: + type: boolean x-stream-index: "001" - phrase_list_ids: + enabled: + type: boolean + x-stream-index: "002" + rules: items: - format: int32 - type: integer + $ref: '#/components/schemas/LLMRule' type: array - x-stream-index: "002" + x-stream-index: "003" + severity_descriptions: + additionalProperties: + type: string + type: object + x-stream-index: "004" required: - - name - type: object + - enabled + - rules + type: object + LLMRule: + properties: + action: + enum: + - flag + - shadow + - remove + - bounce + - bounce_flag + - bounce_remove + - keep + type: string + x-stream-index: "003" + description: + type: string + x-stream-index: "002" + label: + type: string + x-stream-index: "001" + severity_rules: + items: + $ref: '#/components/schemas/BodyguardSeverityRule' + type: array + x-stream-index: "004" + required: + - label + - description + - action + - severity_rules + type: object + Label: + properties: + harm_labels: + items: + type: string + type: array + x-stream-index: "003" + name: + type: string + x-stream-index: "001" + phrase_list_ids: + items: + format: int32 + type: integer + type: array + x-stream-index: "002" + required: + - name + type: object LabelThresholds: properties: block: @@ -9736,6 +9905,9 @@ components: format: date-time type: number x-stream-index: "033" + deleted_for_me: + type: boolean + x-stream-index: "059" deleted_reply_count: format: int32 type: integer @@ -9957,17 +10129,20 @@ components: properties: channel_id: type: string - x-stream-index: "003.002" + x-stream-index: "004.002" channel_type: type: string - x-stream-index: "003.003" + x-stream-index: "004.003" cid: type: string - x-stream-index: "003.001" + x-stream-index: "004.001" created_at: format: date-time type: number - x-stream-index: "006.002" + x-stream-index: "007.002" + deleted_for_me: + type: boolean + x-stream-index: "003" hard_delete: type: boolean x-stream-index: "002.001" @@ -9976,7 +10151,7 @@ components: x-stream-index: "001.001" team: type: string - x-stream-index: "005.001" + x-stream-index: "006.001" thread_participants: items: $ref: '#/components/schemas/User' @@ -9985,10 +10160,10 @@ components: type: default: message.deleted type: string - x-stream-index: "006.001" + x-stream-index: "007.001" user: $ref: '#/components/schemas/User' - x-stream-index: "004.001" + x-stream-index: "005.001" required: - hard_delete - cid @@ -10230,7 +10405,7 @@ components: type: array x-stream-index: "001.002" type: - default: message.new + default: notification.thread_message_new type: string x-stream-index: "004.001" user: @@ -10465,6 +10640,9 @@ components: title: Deleted at type: number x-stream-index: "025" + deleted_for_me: + type: boolean + x-stream-index: "044" deleted_reply_count: format: int32 type: integer @@ -10888,6 +11066,9 @@ components: title: Deleted at type: number x-stream-index: "001.025" + deleted_for_me: + type: boolean + x-stream-index: "001.044" deleted_reply_count: format: int32 type: integer @@ -11262,61 +11443,64 @@ components: nullable: true properties: created_at: - type: string - x-stream-index: "014" + format: date-time + type: number + x-stream-index: "015" custom: additionalProperties: {} type: object - x-stream-index: "009" + x-stream-index: "010" entity_creator_id: type: string - x-stream-index: "006" + x-stream-index: "007" entity_id: type: string - x-stream-index: "005" + x-stream-index: "006" entity_type: type: string - x-stream-index: "004" - id: - type: string - x-stream-index: "001" + x-stream-index: "005" labels: items: type: string type: array - x-stream-index: "010" + x-stream-index: "011" moderation_payload: $ref: '#/components/schemas/ModerationPayload' - x-stream-index: "007" + x-stream-index: "008" reason: type: string - x-stream-index: "008" + x-stream-index: "009" result: items: additionalProperties: {} type: object type: array - x-stream-index: "011" + x-stream-index: "012" review_queue_item: $ref: '#/components/schemas/ReviewQueueItemResponse' - x-stream-index: "013" + x-stream-index: "014" review_queue_item_id: type: string - x-stream-index: "012" + x-stream-index: "013" type: type: string x-stream-index: "002" updated_at: - type: string - x-stream-index: "015" + format: date-time + type: number + x-stream-index: "016" user: $ref: '#/components/schemas/UserResponse' + x-stream-index: "004" + user_id: + type: string x-stream-index: "003" required: - - id - type + - user_id - entity_type - entity_id + - result - created_at - updated_at type: object @@ -11423,6 +11607,70 @@ components: - action - automod_response type: object + ModerationRuleV2Response: + properties: + action: + $ref: '#/components/schemas/RuleBuilderAction' + x-stream-index: "010" + conditions: + items: + $ref: '#/components/schemas/RuleBuilderCondition' + type: array + x-stream-index: "007" + config_keys: + items: + type: string + type: array + x-stream-index: "004" + cooldown_period: + type: string + x-stream-index: "011" + created_at: + format: date-time + type: number + x-stream-index: "013" + description: + type: string + x-stream-index: "003" + enabled: + type: boolean + x-stream-index: "012" + groups: + items: + $ref: '#/components/schemas/RuleBuilderConditionGroup' + type: array + x-stream-index: "009" + id: + type: string + x-stream-index: "001" + logic: + type: string + x-stream-index: "008" + name: + type: string + x-stream-index: "002" + rule_type: + type: string + x-stream-index: "006" + team: + type: string + x-stream-index: "005" + updated_at: + format: date-time + type: number + x-stream-index: "014" + required: + - id + - name + - description + - config_keys + - team + - rule_type + - action + - enabled + - created_at + - updated_at + type: object ModerationV2Response: properties: action: @@ -12781,11 +13029,25 @@ components: description: Disable push notifications till a certain time format: date-time type: number + x-stream-index: "007" + feeds_events: + $ref: '#/components/schemas/FeedsEventPreferencesInput' + description: Set granular feeds event preferences for reactions, comments, + new followers, and mentions + x-stream-index: "006" + feeds_level: + description: Set the level of feeds push notifications for the user. One + of all, none, default + enum: + - all + - none + - default + type: string x-stream-index: "005" remove_disable: description: Remove the disabled until time. (IE stop snoozing notifications) type: boolean - x-stream-index: "006" + x-stream-index: "008" user_id: description: The user id for which to set the push preferences. Required when using server side auths, defaults to current user with client side @@ -12804,6 +13066,12 @@ components: disabled_until: format: date-time type: number + x-stream-index: "005" + feeds_events: + $ref: '#/components/schemas/FeedsEventPreferences' + x-stream-index: "004" + feeds_level: + type: string x-stream-index: "003" type: object PushProvider: @@ -13016,6 +13284,12 @@ components: - message.updated - reaction.new - notification.reminder_due + - feeds.activity.added + - feeds.comment.added + - feeds.activity.reaction.added + - feeds.comment.reaction.added + - feeds.follow.created + - feeds.notification_feed.updated type: string x-stream-index: "005" template: @@ -13688,6 +13962,72 @@ components: - logs - duration type: object + QueryModerationRulesRequest: + nullable: true + properties: + filter: + additionalProperties: {} + description: Filter conditions for moderation rules + title: Filter + type: object + x-stream-index: "001" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "003.001" + next: + type: string + x-stream-index: "003.002" + prev: + type: string + x-stream-index: "003.003" + sort: + description: Sorting parameters for the results + items: + $ref: '#/components/schemas/SortParamRequest' + title: Sort + type: array + x-stream-index: "002" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "004.002" + user_id: + type: string + x-stream-index: "004.001" + type: object + QueryModerationRulesResponse: + nullable: true + properties: + default_llm_labels: + additionalProperties: + type: string + description: Default LLM label descriptions + title: DefaultLLMLabels + type: object + x-stream-index: "002" + duration: + type: string + x-stream-index: "004.001" + next: + type: string + x-stream-index: "003.001" + prev: + type: string + x-stream-index: "003.002" + rules: + description: List of moderation rules + items: + $ref: '#/components/schemas/ModerationRuleV2Response' + title: Rules + type: array + x-stream-index: "001" + required: + - rules + - default_llm_labels + - duration + type: object QueryPollVotesRequest: nullable: true properties: @@ -15328,7 +15668,7 @@ components: flags: description: The flags associated with this review queue item items: - $ref: '#/components/schemas/FlagResponse' + $ref: '#/components/schemas/ModerationFlagResponse' title: Flags type: array x-stream-index: "003" @@ -15435,7 +15775,7 @@ components: flags: description: Associated flag records items: - $ref: '#/components/schemas/FlagResponse' + $ref: '#/components/schemas/ModerationFlagResponse' title: Flags type: array x-stream-index: "023" @@ -15545,7 +15885,7 @@ components: flags: description: The flags associated with this review queue item items: - $ref: '#/components/schemas/FlagResponse' + $ref: '#/components/schemas/ModerationFlagResponse' title: Flags type: array x-stream-index: "003" @@ -15666,8 +16006,6 @@ components: type: type: string x-stream-index: "001" - required: - - type type: object RuleBuilderCondition: properties: @@ -15696,6 +16034,9 @@ components: user_created_within_params: $ref: '#/components/schemas/UserCreatedWithinParameters' x-stream-index: "011" + user_custom_property_params: + $ref: '#/components/schemas/UserCustomPropertyParameters' + x-stream-index: "012" user_rule_params: $ref: '#/components/schemas/UserRuleParameters' x-stream-index: "006" @@ -15705,8 +16046,6 @@ components: video_rule_params: $ref: '#/components/schemas/VideoRuleParameters' x-stream-index: "005" - required: - - type type: object RuleBuilderConditionGroup: properties: @@ -15718,9 +16057,6 @@ components: logic: type: string x-stream-index: "001" - required: - - logic - - conditions type: object RuleBuilderConfig: properties: @@ -15732,48 +16068,37 @@ components: $ref: '#/components/schemas/RuleBuilderRule' type: array x-stream-index: "002" - required: - - rules type: object RuleBuilderRule: properties: action: $ref: '#/components/schemas/RuleBuilderAction' - x-stream-index: "007" + x-stream-index: "006" conditions: items: $ref: '#/components/schemas/RuleBuilderCondition' type: array - x-stream-index: "004" + x-stream-index: "003" cooldown_period: type: string - x-stream-index: "009" - enabled: - type: boolean - x-stream-index: "008" + x-stream-index: "007" groups: items: $ref: '#/components/schemas/RuleBuilderConditionGroup' type: array - x-stream-index: "006" + x-stream-index: "005" id: type: string x-stream-index: "001" logic: type: string - x-stream-index: "005" - name: - type: string - x-stream-index: "002" + x-stream-index: "004" rule_type: type: string - x-stream-index: "003" + x-stream-index: "002" required: - - id - - name - rule_type - action - - enabled type: object S3Request: description: Config for creating Amazon S3 storage. @@ -16009,6 +16334,9 @@ components: format: date-time type: number x-stream-index: "001.025" + deleted_for_me: + type: boolean + x-stream-index: "001.044" deleted_reply_count: format: int32 type: integer @@ -16862,18 +17190,23 @@ components: items: type: string type: array - x-stream-index: "004" + x-stream-index: "005" contains_url: type: boolean - x-stream-index: "002" + x-stream-index: "003" harm_labels: items: type: string type: array x-stream-index: "001" + llm_harm_labels: + additionalProperties: + type: string + type: object + x-stream-index: "002" severity: type: string - x-stream-index: "003" + x-stream-index: "004" type: object TextRuleParameters: properties: @@ -16881,18 +17214,23 @@ components: items: type: string type: array - x-stream-index: "006" + x-stream-index: "007" contains_url: type: boolean - x-stream-index: "004" + x-stream-index: "005" harm_labels: items: type: string type: array x-stream-index: "003" + llm_harm_labels: + additionalProperties: + type: string + type: object + x-stream-index: "004" severity: type: string - x-stream-index: "005" + x-stream-index: "006" threshold: format: int32 type: integer @@ -16900,9 +17238,6 @@ components: time_window: type: string x-stream-index: "002" - required: - - threshold - - time_window type: object ThreadParticipant: description: Represents a user that is participating in a thread. @@ -17875,6 +18210,10 @@ components: image_upload_config: $ref: '#/components/schemas/FileUploadConfig' x-stream-index: "001.029" + max_aggregated_activities_length: + format: int32 + type: integer + x-stream-index: "001.049" migrate_permissions_to_v2: type: boolean x-stream-index: "001.035" @@ -18162,39 +18501,39 @@ components: items: type: string type: array - x-stream-index: 009.001.026 + x-stream-index: 009.001.027 automod: enum: - disabled - simple - AI type: string - x-stream-index: 009.001.021 + x-stream-index: 009.001.022 automod_behavior: enum: - flag - block - shadow_block type: string - x-stream-index: 009.001.022 + x-stream-index: 009.001.023 automod_thresholds: $ref: '#/components/schemas/Thresholds' - x-stream-index: 009.001.027 + x-stream-index: 009.001.028 blocklist: type: string - x-stream-index: 009.001.023 + x-stream-index: 009.001.024 blocklist_behavior: enum: - flag - block - shadow_block type: string - x-stream-index: 009.001.024 + x-stream-index: 009.001.025 blocklists: items: $ref: '#/components/schemas/BlockListOptions' type: array - x-stream-index: 009.001.025 + x-stream-index: 009.001.026 commands: description: List of commands that channel supports items: @@ -18205,6 +18544,9 @@ components: connect_events: type: boolean x-stream-index: 009.001.004 + count_messages: + type: boolean + x-stream-index: 009.001.019 custom_events: type: boolean x-stream-index: 009.001.012 @@ -18222,7 +18564,7 @@ components: format: int32 maximum: 20000 type: integer - x-stream-index: 009.001.020 + x-stream-index: 009.001.021 mutes: type: boolean x-stream-index: 009.001.009 @@ -18271,7 +18613,7 @@ components: x-stream-index: 009.001.018 skip_last_msg_update_for_system_msgs: type: boolean - x-stream-index: 009.001.030 + x-stream-index: 009.001.031 typing_events: type: boolean x-stream-index: 009.001.002 @@ -18296,39 +18638,39 @@ components: items: type: string type: array - x-stream-index: 003.001.026 + x-stream-index: 003.001.027 automod: enum: - disabled - simple - AI type: string - x-stream-index: 003.001.021 + x-stream-index: 003.001.022 automod_behavior: enum: - flag - block - shadow_block type: string - x-stream-index: 003.001.022 + x-stream-index: 003.001.023 automod_thresholds: $ref: '#/components/schemas/Thresholds' - x-stream-index: 003.001.027 + x-stream-index: 003.001.028 blocklist: type: string - x-stream-index: 003.001.023 + x-stream-index: 003.001.024 blocklist_behavior: enum: - flag - block - shadow_block type: string - x-stream-index: 003.001.024 + x-stream-index: 003.001.025 blocklists: items: $ref: '#/components/schemas/BlockListOptions' type: array - x-stream-index: 003.001.025 + x-stream-index: 003.001.026 commands: items: type: string @@ -18337,6 +18679,9 @@ components: connect_events: type: boolean x-stream-index: 003.001.004 + count_messages: + type: boolean + x-stream-index: 003.001.019 created_at: format: date-time type: number @@ -18361,7 +18706,7 @@ components: format: int32 maximum: 20000 type: integer - x-stream-index: 003.001.020 + x-stream-index: 003.001.021 mutes: type: boolean x-stream-index: 003.001.009 @@ -18371,13 +18716,13 @@ components: partition_size: format: int32 type: integer - x-stream-index: 003.001.028 + x-stream-index: 003.001.029 partition_ttl: example: 24h format: duration nullable: true type: string - x-stream-index: 003.001.029 + x-stream-index: 003.001.030 permissions: items: $ref: '#/components/schemas/PolicyRequest' @@ -18412,7 +18757,7 @@ components: x-stream-index: 003.001.018 skip_last_msg_update_for_system_msgs: type: boolean - x-stream-index: 003.001.030 + x-stream-index: 003.001.031 typing_events: type: boolean x-stream-index: 003.001.002 @@ -18450,6 +18795,7 @@ components: - polls - user_message_reminders - shared_locations + - count_messages - message_retention - max_message_length - automod @@ -19018,7 +19364,7 @@ components: $ref: '#/components/schemas/AIImageConfig' description: Configuration for AI image analysis title: AI Image Config - x-stream-index: "010" + x-stream-index: "011" ai_text_config: $ref: '#/components/schemas/AITextConfig' description: Configuration for AI text analysis @@ -19028,7 +19374,7 @@ components: $ref: '#/components/schemas/AIVideoConfig' description: Configuration for AI video analysis title: AI Video Config - x-stream-index: "011" + x-stream-index: "012" async: description: Whether moderation should be performed asynchronously title: Async @@ -19051,7 +19397,7 @@ components: x-stream-index: "004" aws_rekognition_config: $ref: '#/components/schemas/AIImageConfig' - x-stream-index: "015" + x-stream-index: "016" block_list_config: $ref: '#/components/schemas/BlockListConfig' description: Configuration for block list filtering @@ -19059,23 +19405,28 @@ components: x-stream-index: "007" bodyguard_config: $ref: '#/components/schemas/AITextConfig' - x-stream-index: "014" + x-stream-index: "015" google_vision_config: $ref: '#/components/schemas/GoogleVisionConfig' description: Configuration for Google Vision integration title: Google Vision Config - x-stream-index: "009" + x-stream-index: "010" key: description: Unique identifier for the moderation configuration title: Key type: string x-stream-index: "001" + llm_config: + $ref: '#/components/schemas/LLMConfig' + description: Configuration for customer-configured LLM moderation + title: LLM Config + x-stream-index: "009" rule_builder_config: $ref: '#/components/schemas/RuleBuilderConfig' description: Configuration for custom rule builder (max 3 rules, max 5 conditions per rule) title: Rule Builder Config - x-stream-index: "013" + x-stream-index: "014" team: description: Team associated with the configuration maxLength: 128 @@ -19085,18 +19436,18 @@ components: x-stream-index: "002" user: $ref: '#/components/schemas/UserRequest' - x-stream-index: "017.002" + x-stream-index: "018.002" user_id: type: string - x-stream-index: "017.001" + x-stream-index: "018.001" velocity_filter_config: $ref: '#/components/schemas/VelocityFilterConfig' description: Configuration for velocity-based filtering title: Velocity Filter Config - x-stream-index: "012" + x-stream-index: "013" video_call_rule_config: $ref: '#/components/schemas/VideoCallRuleConfig' - x-stream-index: "016" + x-stream-index: "017" required: - key type: object @@ -19114,6 +19465,69 @@ components: required: - duration type: object + UpsertModerationRuleRequest: + nullable: true + properties: + action: + $ref: '#/components/schemas/RuleBuilderAction' + x-stream-index: "009" + conditions: + items: + $ref: '#/components/schemas/RuleBuilderCondition' + type: array + x-stream-index: "006" + config_keys: + items: + type: string + type: array + x-stream-index: "003" + cooldown_period: + type: string + x-stream-index: "010" + description: + type: string + x-stream-index: "002" + enabled: + type: boolean + x-stream-index: "011" + groups: + items: + $ref: '#/components/schemas/RuleBuilderConditionGroup' + type: array + x-stream-index: "008" + logic: + type: string + x-stream-index: "007" + name: + type: string + x-stream-index: "001" + rule_type: + type: string + x-stream-index: "005" + team: + type: string + x-stream-index: "004" + required: + - name + - rule_type + - action + type: object + UpsertModerationRuleResponse: + description: Basic response information + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "001.001" + rule: + $ref: '#/components/schemas/ModerationRuleV2Response' + x-stream-index: "002" + required: + - duration + title: Response + type: object UpsertModerationTemplateRequest: nullable: true properties: @@ -19247,6 +19661,12 @@ components: - message.updated - reaction.new - notification.reminder_due + - feeds.activity.added + - feeds.comment.added + - feeds.activity.reaction.added + - feeds.comment.reaction.added + - feeds.follow.created + - feeds.notification_feed.updated title: string type: string x-stream-index: "003" @@ -19447,6 +19867,15 @@ components: required: - type type: object + UserCustomPropertyParameters: + properties: + operator: + type: string + x-stream-index: "002" + property_key: + type: string + x-stream-index: "001" + type: object UserDeactivatedEvent: properties: created_at: @@ -19537,6 +19966,84 @@ components: x-stream-event-doc-group: other x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent + UserMessagesDeletedEvent: + description: This event is sent when a user's message get deleted. The event + contains information about the user whose messages got deleted. + nullable: true + properties: + channel_custom: + additionalProperties: {} + type: object + x-stream-index: 001.001.005 + channel_id: + description: The ID of the channel where the target user's messages were + deleted + title: Channel ID + type: string + x-stream-index: 001.002.002 + channel_member_count: + format: int32 + type: integer + x-stream-index: 001.001.004 + channel_type: + description: The type of the channel where the target user's messages were + deleted + title: Channel Type + type: string + x-stream-index: 001.002.001 + cid: + description: The CID of the channel where the target user's messages were + deleted + 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: number + x-stream-index: 001.001.001.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 001.001.001.001.007 + hard_delete: + description: Whether Messages were hard deleted + title: Hard Delete + type: boolean + x-stream-index: "003" + received_at: + format: date-time + type: number + x-stream-index: 001.001.001.001.004 + team: + description: The team of the channel where the target user's messages were + deleted + title: Team + type: string + x-stream-index: 001.001.003 + type: + default: user.messages.deleted + description: 'The type of event: "user.messages.deleted" in this case' + title: Event Type + type: string + x-stream-index: 001.001.001.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The target user whose messages got deleted + title: User + x-stream-index: "002.001" + required: + - type + - created_at + - custom + - user + title: UserMessagesDeletedEvent + 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 UserMute: nullable: true properties: @@ -20320,9 +20827,6 @@ components: time_window: type: string x-stream-index: "002" - required: - - threshold - - time_window type: object VideoSettings: properties: @@ -20544,6 +21048,7 @@ components: user.deactivated: '#/components/schemas/UserDeactivatedEvent' user.deleted: '#/components/schemas/UserDeletedEvent' user.flagged: '#/components/schemas/UserFlaggedEvent' + user.messages.deleted: '#/components/schemas/UserMessagesDeletedEvent' user.muted: '#/components/schemas/UserMutedEvent' user.reactivated: '#/components/schemas/UserReactivatedEvent' user.unbanned: '#/components/schemas/UserUnbannedEvent' @@ -20606,6 +21111,7 @@ components: - $ref: '#/components/schemas/UserDeactivatedEvent' - $ref: '#/components/schemas/UserDeletedEvent' - $ref: '#/components/schemas/UserFlaggedEvent' + - $ref: '#/components/schemas/UserMessagesDeletedEvent' - $ref: '#/components/schemas/UserMutedEvent' - $ref: '#/components/schemas/UserReactivatedEvent' - $ref: '#/components/schemas/UserUnbannedEvent' @@ -20727,7 +21233,7 @@ components: type: apiKey info: title: Stream API - version: v187.13.0 + version: v191.1.0 openapi: 3.0.3 paths: /api/v2/app: @@ -22830,6 +23336,14 @@ paths: type: string writeOnly: true x-stream-index: "003" + - in: query + name: delete_for_me + schema: + description: Delete the message only for the user making the request + title: Delete for me + type: boolean + writeOnly: true + x-stream-index: "004" responses: "200": content: @@ -25658,6 +26172,125 @@ paths: summary: Query moderation action logs tags: - product:moderation + /api/v2/moderation/moderation_rule: + post: + description: | + Create or update a moderation rule that can apply app-wide or to specific moderation configs + operationId: upsert_moderation_rule + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpsertModerationRuleRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/UpsertModerationRuleResponse' + 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: Upsert moderation rule + tags: + - product:moderation + /api/v2/moderation/moderation_rule/{id}: + delete: + description: | + Delete an existing moderation rule + operationId: delete_moderation_rule + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteModerationRuleResponse' + 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: Delete moderation rule + tags: + - product:moderation + get: + description: | + Get a specific moderation rule by ID + operationId: get_moderation_rule + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/GetModerationRuleResponse' + 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: Get moderation rule + tags: + - product:moderation + /api/v2/moderation/moderation_rules: + post: + description: | + Search and filter moderation rules across your application. This endpoint is designed for building moderation dashboards and managing multiple rule sets. + operationId: query_moderation_rules + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueryModerationRulesRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/QueryModerationRulesResponse' + description: Successful 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: Query moderation rules + tags: + - product:moderation /api/v2/moderation/mute: post: description: | diff --git a/openapi/v2/clientside-api.json b/openapi/v2/clientside-api.json index 9745beb4a..cf395ea2a 100644 --- a/openapi/v2/clientside-api.json +++ b/openapi/v2/clientside-api.json @@ -1 +1 @@ -{"components":{"schemas":{"AIImageConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"ocr_rules":{"items":{"$ref":"#/components/schemas/OCRRule"},"type":"array","x-stream-index":"004"},"rules":{"items":{"$ref":"#/components/schemas/AWSRekognitionRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules","ocr_rules"],"type":"object"},"AIIndicatorClearEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"ai_indicator.clear","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"AIIndicatorClearEvent","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"},"AIIndicatorStopEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"ai_indicator.stop","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"AIIndicatorStopEvent","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"},"AIIndicatorUpdateEvent":{"properties":{"ai_message":{"type":"string","x-stream-index":"005"},"ai_state":{"type":"string","x-stream-index":"004"},"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"message_id":{"type":"string","x-stream-index":"003"},"type":{"default":"ai_indicator.update","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","cid","channel_id","channel_type","message_id","ai_state"],"title":"AIIndicatorUpdateEvent","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"},"AITextConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"profile":{"type":"string","x-stream-index":"003"},"rules":{"items":{"$ref":"#/components/schemas/BodyguardRule"},"type":"array","x-stream-index":"004"},"severity_rules":{"items":{"$ref":"#/components/schemas/BodyguardSeverityRule"},"type":"array","x-stream-index":"005"}},"required":["enabled","profile","rules","severity_rules"],"type":"object"},"AIVideoConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AWSRekognitionRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"APIError":{"properties":{"StatusCode":{"description":"Response HTTP status code","format":"int32","title":"Status code","type":"integer","x-stream-index":"004"},"code":{"description":"API error code","format":"int32","title":"Code","type":"integer","x-stream-index":"001"},"details":{"description":"Additional error-specific information","items":{"type":"integer"},"title":"Details","type":"array","x-stream-index":"007"},"duration":{"description":"Request duration","title":"Duration","type":"string","x-stream-index":"005"},"exception_fields":{"additionalProperties":{"type":"string"},"description":"Additional error info","title":"Exception fields","type":"object","x-stream-index":"003"},"message":{"description":"Message describing an error","title":"Message","type":"string","x-stream-index":"002"},"more_info":{"description":"URL with additional information","title":"More info","type":"string","x-stream-index":"006"},"unrecoverable":{"description":"Flag that indicates if the error is unrecoverable, requests that return unrecoverable errors should not be retried, this error only applies to the request that caused it","title":"Unrecoverable","type":"boolean","x-stream-index":"008"}},"required":["code","message","StatusCode","duration","more_info","details"],"title":"Error response","type":"object"},"APNS":{"properties":{"body":{"type":"string","x-stream-index":"002"},"content-available":{"format":"int32","type":"integer","x-stream-index":"004"},"data":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"mutable-content":{"format":"int32","type":"integer","x-stream-index":"005"},"sound":{"type":"string","x-stream-index":"003"},"title":{"type":"string","x-stream-index":"001"}},"required":["title","body"],"type":"object"},"AWSRekognitionRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"},"min_confidence":{"format":"float","maximum":100,"minimum":0,"type":"number","x-stream-index":"003"}},"required":["label","action","min_confidence"],"type":"object"},"AcceptCallRequest":{"description":"AcceptCallRequest is the payload for accepting a call.","nullable":true,"title":"AcceptCallRequest","type":"object"},"AcceptCallResponse":{"description":"AcceptCallResponse is the payload for accepting a call.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"AcceptCallResponse","type":"object"},"Action":{"nullable":true,"properties":{"name":{"type":"string","x-stream-index":"001"},"style":{"type":"string","x-stream-index":"003"},"text":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"004"},"value":{"type":"string","x-stream-index":"005"}},"required":["name","text","type"],"type":"object"},"ActionLog":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"002"},"reason":{"type":"string","x-stream-index":"008"},"reporter_type":{"type":"string","x-stream-index":"009"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"014"},"review_queue_item_id":{"type":"string","x-stream-index":"012"},"target_user":{"$ref":"#/components/schemas/User","x-stream-index":"013"},"target_user_id":{"type":"string","x-stream-index":"011"},"type":{"type":"string","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007"}},"required":["id","created_at","type","reason","reporter_type","custom","target_user_id","review_queue_item_id"],"type":"object"},"ActionLogResponse":{"nullable":true,"properties":{"created_at":{"description":"Timestamp when the action was taken","format":"date-time","title":"Created At","type":"number","x-stream-index":"002"},"custom":{"additionalProperties":{},"description":"Additional metadata about the action","title":"Custom","type":"object","x-stream-index":"007"},"id":{"description":"Unique identifier of the action log","title":"ID","type":"string","x-stream-index":"001"},"reason":{"description":"Reason for the moderation action","title":"Reason","type":"string","x-stream-index":"006"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"Associated review queue item","title":"Review Queue Item","x-stream-index":"008"},"target_user":{"$ref":"#/components/schemas/UserResponse","description":"User who was the target of the action","title":"Target User","x-stream-index":"009"},"target_user_id":{"description":"ID of the user who was the target of the action","title":"Target User ID","type":"string","x-stream-index":"010"},"type":{"description":"Type of moderation action","title":"Type","type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who performed the action","title":"User","x-stream-index":"004"},"user_id":{"description":"ID of the user who performed the action","title":"User ID","type":"string","x-stream-index":"005"}},"required":["id","created_at","type","user_id","reason","custom","target_user_id"],"type":"object"},"ActionSequence":{"properties":{"action":{"type":"string","x-stream-index":"001"},"blur":{"type":"boolean","x-stream-index":"005"},"cooldown_period":{"format":"int32","type":"integer","x-stream-index":"004"},"threshold":{"format":"int32","type":"integer","x-stream-index":"002"},"time_window":{"format":"int32","type":"integer","x-stream-index":"003"},"warning":{"type":"boolean","x-stream-index":"006"},"warning_text":{"type":"string","x-stream-index":"007"}},"required":["action","threshold","time_window","cooldown_period","blur","warning","warning_text"],"type":"object"},"ActivityMarkedEvent":{"properties":{"all_read":{"type":"boolean","x-stream-index":"006"},"all_seen":{"type":"boolean","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"feed_id":{"type":"string","x-stream-index":"003"},"marked_read":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"marked_watched":{"items":{"type":"string"},"type":"array","x-stream-index":"005"},"type":{"default":"activity.marked","type":"string","x-stream-index":"001.001"},"user_id":{"type":"string","x-stream-index":"002"}},"required":["type","created_at","user_id","feed_id","all_read","all_seen"],"title":"ActivityMarkedEvent","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"},"AnyEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"*","type":"string","x-stream-index":"001.001"}},"required":["type","created_at"],"title":"AnyEvent","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"},"AppEventResponse":{"properties":{"async_url_enrich_enabled":{"description":"boolean","title":"Async URL Enrichment Enabled","type":"boolean","x-stream-index":"002"},"auto_translation_enabled":{"description":"boolean","title":"Auto Translation Enabled","type":"boolean","x-stream-index":"003"},"file_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","description":"file upload config","title":"File Upload Config","x-stream-index":"004"},"image_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","description":"file upload config","title":"Image Upload Config","x-stream-index":"005"},"name":{"description":"string","title":"App name","type":"string","x-stream-index":"001"}},"required":["name","auto_translation_enabled"],"type":"object"},"AppResponseFields":{"properties":{"async_url_enrich_enabled":{"type":"boolean","x-stream-index":"017"},"auto_translation_enabled":{"type":"boolean","x-stream-index":"020"},"file_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","x-stream-index":"030"},"image_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","x-stream-index":"031"},"name":{"type":"string","x-stream-index":"001"}},"required":["name","organization","push_notifications","webhook_url","moderation_webhook_url","channel_configs","call_types","policies","suspended","suspended_explanation","disable_auth_checks","disable_permissions_checks","permission_version","user_search_disallowed_roles","multi_tenant_enabled","image_moderation_enabled","async_url_enrich_enabled","auto_translation_enabled","custom_action_handler_url","enforce_unique_usernames","sqs_url","sqs_key","sqs_secret","sns_topic_arn","sns_key","sns_secret","file_upload_config","image_upload_config","grants","campaign_enabled","webhook_events","reminders_interval","cdn_expiration_seconds","video_provider","moderation_enabled","moderation_multitenant_blocklist_enabled","guest_user_creation_disabled","event_hooks","use_hook_v2","user_response_time_enabled","moderation_bulk_submit_action_enabled"],"type":"object"},"AppUpdatedEvent":{"description":"Emitted when app settings are updated","nullable":true,"properties":{"app":{"$ref":"#/components/schemas/AppEventResponse","description":"application configuration","title":"App settings","x-stream-index":"002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"type":{"default":"app.updated","description":"The type of event: \"app.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.002"}},"required":["type","created_at","custom","app"],"title":"AppUpdatedEvent","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"},"Attachment":{"description":"An attachment is a message object that represents a file uploaded by a user.","nullable":true,"properties":{"actions":{"items":{"$ref":"#/components/schemas/Action"},"type":"array","x-stream-index":"015"},"asset_url":{"type":"string","x-stream-index":"017"},"author_icon":{"type":"string","x-stream-index":"007"},"author_link":{"type":"string","x-stream-index":"006"},"author_name":{"type":"string","x-stream-index":"005"},"color":{"type":"string","x-stream-index":"003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"018"},"fallback":{"type":"string","x-stream-index":"002"},"fields":{"items":{"$ref":"#/components/schemas/Field"},"type":"array","x-stream-index":"016"},"footer":{"type":"string","x-stream-index":"013"},"footer_icon":{"type":"string","x-stream-index":"014"},"giphy":{"$ref":"#/components/schemas/Images","x-stream-index":"019"},"image_url":{"type":"string","x-stream-index":"011"},"og_scrape_url":{"type":"string","x-stream-index":"020"},"original_height":{"format":"int32","type":"integer","x-stream-index":"022"},"original_width":{"format":"int32","type":"integer","x-stream-index":"021"},"pretext":{"type":"string","x-stream-index":"004"},"text":{"type":"string","x-stream-index":"010"},"thumb_url":{"type":"string","x-stream-index":"012"},"title":{"type":"string","x-stream-index":"008"},"title_link":{"type":"string","x-stream-index":"009"},"type":{"description":"Attachment type (e.g. image, video, url)","title":"Type","type":"string","x-stream-index":"001"}},"required":["custom"],"title":"Attachment","type":"object","x-stream-docs-page-id":"file_uploads"},"AudioSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"001"},"default_device":{"enum":["speaker","earpiece"],"type":"string","x-stream-index":"006"},"mic_default_on":{"type":"boolean","x-stream-index":"004"},"noise_cancellation":{"$ref":"#/components/schemas/NoiseCancellationSettings","x-stream-index":"007"},"opus_dtx_enabled":{"type":"boolean","x-stream-index":"002"},"redundant_coding_enabled":{"type":"boolean","x-stream-index":"003"},"speaker_default_on":{"type":"boolean","x-stream-index":"005"}},"required":["access_request_enabled","opus_dtx_enabled","redundant_coding_enabled","mic_default_on","speaker_default_on","default_device"],"type":"object"},"AudioSettingsRequest":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"001"},"default_device":{"enum":["speaker","earpiece"],"type":"string","x-stream-index":"006"},"mic_default_on":{"type":"boolean","x-stream-index":"004"},"noise_cancellation":{"$ref":"#/components/schemas/NoiseCancellationSettings","x-stream-index":"007"},"opus_dtx_enabled":{"type":"boolean","x-stream-index":"002"},"redundant_coding_enabled":{"type":"boolean","x-stream-index":"003"},"speaker_default_on":{"type":"boolean","x-stream-index":"005"}},"required":["default_device"],"type":"object"},"AudioSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"001"},"default_device":{"enum":["speaker","earpiece"],"type":"string","x-stream-index":"006"},"mic_default_on":{"type":"boolean","x-stream-index":"004"},"noise_cancellation":{"$ref":"#/components/schemas/NoiseCancellationSettings","x-stream-index":"007"},"opus_dtx_enabled":{"type":"boolean","x-stream-index":"002"},"redundant_coding_enabled":{"type":"boolean","x-stream-index":"003"},"speaker_default_on":{"type":"boolean","x-stream-index":"005"}},"required":["access_request_enabled","opus_dtx_enabled","redundant_coding_enabled","mic_default_on","speaker_default_on","default_device"],"type":"object"},"AutomodDetails":{"properties":{"action":{"type":"string","x-stream-index":"001"},"image_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"005"},"message_details":{"$ref":"#/components/schemas/FlagMessageDetails","x-stream-index":"004"},"original_message_type":{"type":"string","x-stream-index":"002"},"result":{"$ref":"#/components/schemas/MessageModerationResult","x-stream-index":"003"}},"type":"object"},"AutomodPlatformCircumventionConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AutomodRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"AutomodRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"003"},"label":{"type":"string","x-stream-index":"001"},"threshold":{"format":"float","maximum":1,"minimum":0,"type":"number","x-stream-index":"002"}},"required":["label","threshold","action"],"type":"object"},"AutomodSemanticFiltersConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AutomodSemanticFiltersRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"AutomodSemanticFiltersRule":{"properties":{"action":{"enum":["flag","shadow","remove"],"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"threshold":{"format":"float","maximum":1,"minimum":0,"type":"number","x-stream-index":"002"}},"required":["name","threshold","action"],"type":"object"},"AutomodToxicityConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AutomodRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"BackstageSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"BackstageSettingsRequest":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"002"}},"type":"object"},"BackstageSettingsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"Ban":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"012"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"011"},"expires":{"format":"date-time","type":"number","x-stream-index":"007"},"reason":{"type":"string","x-stream-index":"008"},"shadow":{"type":"boolean","x-stream-index":"009"},"target":{"$ref":"#/components/schemas/User","x-stream-index":"006"}},"required":["shadow","created_at"],"type":"object"},"BanActionRequest":{"properties":{"channel_ban_only":{"type":"boolean","x-stream-index":"003"},"delete_messages":{"enum":["soft","pruning","hard"],"type":"string","x-stream-index":"005"},"ip_ban":{"type":"boolean","x-stream-index":"004"},"reason":{"type":"string","x-stream-index":"002"},"shadow":{"type":"boolean","x-stream-index":"001"},"timeout":{"format":"int32","type":"integer","x-stream-index":"006"}},"type":"object"},"BanOptions":{"properties":{"duration":{"format":"int32","type":"integer","x-stream-index":"001"},"ip_ban":{"type":"boolean","x-stream-index":"004"},"reason":{"type":"string","x-stream-index":"002"},"shadow_ban":{"type":"boolean","x-stream-index":"003"}},"required":["duration","reason","shadow_ban","ip_ban"],"type":"object"},"BanRequest":{"nullable":true,"properties":{"banned_by":{"$ref":"#/components/schemas/UserRequest","description":"Details about the user performing the ban","title":"Banned By","x-stream-index":"008"},"banned_by_id":{"description":"ID of the user performing the ban","title":"Banned By ID","type":"string","x-stream-index":"007"},"channel_cid":{"description":"Channel where the ban applies","title":"Channel CID","type":"string","x-stream-index":"004"},"delete_messages":{"enum":["soft","pruning","hard"],"type":"string","x-stream-index":"009"},"ip_ban":{"description":"Whether to ban the user's IP address","title":"IP Ban","type":"boolean","x-stream-index":"006"},"reason":{"description":"Optional explanation for the ban","title":"Reason","type":"string","x-stream-index":"003"},"shadow":{"description":"Whether this is a shadow ban","title":"Shadow","type":"boolean","x-stream-index":"005"},"target_user_id":{"description":"ID of the user to ban","title":"Target User ID","type":"string","x-stream-index":"001"},"timeout":{"description":"Duration of the ban in minutes","minimum":0,"title":"Timeout","type":"integer","x-stream-index":"002"}},"required":["target_user_id"],"type":"object"},"BanResponse":{"nullable":true,"properties":{"banned_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"006"},"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"expires":{"format":"date-time","type":"number","x-stream-index":"003"},"reason":{"type":"string","x-stream-index":"004"},"shadow":{"type":"boolean","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"}},"required":["created_at"],"type":"object"},"BlockContentOptions":{"properties":{"reason":{"type":"string","x-stream-index":"001"}},"required":["reason"],"type":"object"},"BlockListConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/BlockListRule"},"maximum":10,"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"BlockListOptions":{"properties":{"behavior":{"description":"Blocklist behavior","enum":["flag","block","shadow_block"],"title":"Behavior","type":"string","x-stream-index":"002"},"blocklist":{"description":"Blocklist name","title":"Blocklist","type":"string","x-stream-index":"001"}},"required":["blocklist","behavior"],"type":"object"},"BlockListResponse":{"description":"Block list contains restricted words","properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001"},"id":{"type":"string","x-stream-index":"003"},"name":{"description":"Block list name","title":"Name","type":"string","x-stream-index":"004"},"team":{"type":"string","x-stream-index":"007"},"type":{"description":"Block list type.","title":"Type","type":"string","x-stream-index":"005"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"002"},"words":{"description":"List of words to block","items":{"type":"string"},"title":"Words","type":"array","x-stream-index":"006"}},"required":["name","type","words"],"title":"Block list","type":"object","x-stream-docs-page-id":"block_lists"},"BlockListRule":{"properties":{"action":{"enum":["flag","mask_flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"002"}},"required":["name","team","action"],"type":"object"},"BlockUserRequest":{"description":"BlockUserRequest is the payload for blocking a user.","nullable":true,"properties":{"user_id":{"description":"the user to block","title":"UserID","type":"string","x-stream-index":"003"}},"required":["user_id"],"title":"BlockUserRequest","type":"object"},"BlockUserResponse":{"description":"BlockUserResponse is the payload for blocking a user.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"BlockUserResponse","type":"object"},"BlockUsersRequest":{"nullable":true,"properties":{"blocked_user_id":{"description":"User id to block","title":"BlockedUserID","type":"string","x-stream-index":"001"}},"required":["blocked_user_id"],"type":"object"},"BlockUsersResponse":{"nullable":true,"properties":{"blocked_by_user_id":{"description":"User id who blocked another user","title":"BlockedByUserID","type":"string","x-stream-index":"002"},"blocked_user_id":{"description":"User id who got blocked","title":"BlockedUserID","type":"string","x-stream-index":"003"},"created_at":{"description":"Timestamp when the user was blocked","format":"date-time","title":"CreatedAt","type":"number","x-stream-index":"004"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration","blocked_by_user_id","blocked_user_id","created_at"],"type":"object"},"BlockedUserEvent":{"description":"This event is sent to call participants to notify when a user is blocked on a call, clients can use this event to show a notification.\nIf the user is the current user, the client should leave the call screen as well","properties":{"blocked_by_user":{"$ref":"#/components/schemas/UserResponse","description":"The user that blocked the user, null if the user was blocked by server-side","title":"Blocked by","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.blocked_user","description":"The type of event: \"call.blocked_user\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user that was blocked","title":"User","x-stream-index":"003"}},"required":["type","created_at","call_cid","user"],"title":"BlockedUserEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"BlockedUserResponse":{"nullable":true,"properties":{"blocked_user":{"$ref":"#/components/schemas/UserResponse","description":"User who got blocked","title":"User","x-stream-index":"003"},"blocked_user_id":{"description":"ID of the user who got blocked","title":"UserID","type":"string","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who blocked another user","title":"User","x-stream-index":"001"},"user_id":{"description":"ID of the user who blocked another user","title":"UserID","type":"string","x-stream-index":"002"}},"required":["user","user_id","blocked_user","blocked_user_id","created_at"],"type":"object"},"BodyguardRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"},"severity_rules":{"items":{"$ref":"#/components/schemas/BodyguardSeverityRule"},"type":"array","x-stream-index":"003"}},"required":["label","action","severity_rules"],"type":"object"},"BodyguardSeverityRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"severity":{"enum":["low","medium","high","critical"],"type":"string","x-stream-index":"001"}},"required":["severity","action"],"type":"object"},"Bound":{"properties":{"inclusive":{"type":"boolean","x-stream-index":"002"},"value":{"format":"float","type":"number","x-stream-index":"001"}},"required":["value","inclusive"],"type":"object"},"BroadcastSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettings","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettings","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"BroadcastSettingsRequest":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettingsRequest","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettingsRequest","x-stream-index":"003"}},"type":"object"},"BroadcastSettingsResponse":{"description":"BroadcastSettingsResponse is the payload for broadcasting settings","properties":{"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettingsResponse","title":"HLS","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettingsResponse","title":"RTMP","x-stream-index":"003"}},"required":["enabled","hls","rtmp"],"title":"BroadcastSettingsResponse","type":"object"},"Call":{"properties":{"AppPK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"002"},"Backstage":{"type":"boolean","writeOnly":true,"x-stream-index":"023"},"BlockedUserIDs":{"items":{"type":"string"},"type":"array","writeOnly":true,"x-stream-index":"018"},"BlockedUsers":{"items":{"$ref":"#/components/schemas/User"},"type":"array","writeOnly":true,"x-stream-index":"019"},"CID":{"type":"string","writeOnly":true,"x-stream-index":"005"},"CallType":{"$ref":"#/components/schemas/CallType","x-stream-index":"020"},"ChannelCID":{"type":"string","writeOnly":true,"x-stream-index":"032"},"CreatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"013"},"CreatedBy":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"CreatedByUserID":{"type":"string","writeOnly":true,"x-stream-index":"007"},"CurrentSessionID":{"type":"string","writeOnly":true,"x-stream-index":"024"},"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"012"},"DeletedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"028"},"EgressUpdatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"027"},"Egresses":{"items":{"$ref":"#/components/schemas/CallEgress"},"type":"array","writeOnly":true,"x-stream-index":"015"},"EndedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"017"},"ID":{"type":"string","writeOnly":true,"x-stream-index":"004"},"JoinAheadTimeSeconds":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"031"},"LastHeartbeatAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"030"},"LastSessionID":{"type":"string","writeOnly":true,"x-stream-index":"025"},"MemberCount":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"010"},"MemberLookup":{"$ref":"#/components/schemas/MemberLookup","x-stream-index":"011"},"Members":{"items":{"$ref":"#/components/schemas/CallMember"},"type":"array","writeOnly":true,"x-stream-index":"009"},"Session":{"$ref":"#/components/schemas/CallSession","x-stream-index":"026"},"Settings":{"$ref":"#/components/schemas/CallSettings","x-stream-index":"022"},"SettingsOverrides":{"$ref":"#/components/schemas/CallSettings","x-stream-index":"021"},"StartsAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"016"},"Team":{"type":"string","writeOnly":true,"x-stream-index":"006"},"ThumbnailURL":{"type":"string","writeOnly":true,"x-stream-index":"029"},"Type":{"type":"string","writeOnly":true,"x-stream-index":"003"},"UpdatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"014"}},"required":["AppPK","Type","ID","CID","Team","CreatedByUserID","Members","Custom","CreatedAt","UpdatedAt","Egresses","BlockedUserIDs","BlockedUsers","Backstage","CurrentSessionID","LastSessionID","ThumbnailURL","ChannelCID"],"type":"object"},"CallAcceptedEvent":{"description":"This event is sent when a user accepts a notification to join a call.","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.accepted","description":"The type of event: \"call.accepted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who accepted the call","title":"User","x-stream-index":"004"}},"required":["type","created_at","call_cid","call","user"],"title":"CallAcceptedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallClosedCaption":{"description":"CallClosedCaption represents a closed caption of a call.","properties":{"end_time":{"format":"date-time","title":"The end time of the closed caption.","type":"number","x-stream-index":"003"},"speaker_id":{"title":"The speaker ID of the closed caption.","type":"string","x-stream-index":"004"},"start_time":{"format":"date-time","title":"The start time of the closed caption.","type":"number","x-stream-index":"002"},"text":{"title":"The text of the closed caption.","type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserResponse","title":"The full user for the closed caption.","x-stream-index":"005"}},"required":["text","start_time","end_time","speaker_id","user"],"title":"CallClosedCaption","type":"object"},"CallClosedCaptionsFailedEvent":{"description":"This event is sent when call closed captions has failed","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.closed_captions_failed","description":"The type of event: \"call.closed_captions_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallClosedCaptionsFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallClosedCaptionsStartedEvent":{"description":"This event is sent when call closed caption has started","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.closed_captions_started","description":"The type of event: \"call.closed_captions_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallClosedCaptionsStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallClosedCaptionsStoppedEvent":{"description":"This event is sent when call closed captions has stopped","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.closed_captions_stopped","description":"The type of event: \"call.transcription_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallClosedCaptionsStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallCreatedEvent":{"description":"This event is sent when a call is created. Clients receiving this event should check if the ringing\nfield is set to true and if so, show the call screen","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"the members added to this call","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"004"},"type":{"default":"call.created","description":"The type of event: \"call.created\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","members"],"title":"CallCreatedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallDeletedEvent":{"description":"This event is sent when a call is deleted. Clients receiving this event should leave the call screen","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.deleted","description":"The type of event: \"call.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call"],"title":"CallDeletedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallDurationReport":{"properties":{"histogram":{"items":{"$ref":"#/components/schemas/ReportByHistogramBucket"},"type":"array","x-stream-index":"001"}},"required":["histogram"],"type":"object"},"CallDurationReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateCallDurationReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"CallEgress":{"nullable":true,"properties":{"app_pk":{"format":"int32","type":"integer","x-stream-index":"002"},"call_id":{"type":"string","x-stream-index":"004"},"call_type":{"type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/EgressTaskConfig","x-stream-index":"007"},"egress_id":{"type":"string","x-stream-index":"005"},"egress_type":{"type":"string","x-stream-index":"006"},"instance_ip":{"type":"string","x-stream-index":"008"},"started_at":{"format":"date-time","type":"number","x-stream-index":"010"},"state":{"type":"string","x-stream-index":"009"},"stopped_at":{"format":"date-time","type":"number","x-stream-index":"011"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"012"}},"required":["app_pk","call_type","call_id","egress_id","egress_type","instance_ip","state","started_at","updated_at"],"type":"object"},"CallEndedEvent":{"description":"This event is sent when a call is mark as ended for all its participants. Clients receiving this event should leave the call screen","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"reason":{"description":"The reason why the call ended, if available","title":"CallEndedReason","type":"string","x-stream-index":"005"},"type":{"default":"call.ended","description":"The type of event: \"call.ended\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who ended the call, null if the call was ended by the server","title":"User","x-stream-index":"004"}},"required":["type","created_at","call_cid","call"],"title":"CallEndedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallFrameRecordingFailedEvent":{"description":"This event is sent when frame recording has failed","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.frame_recording_failed","description":"The type of event: \"call.frame_recording_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","egress_id"],"title":"CallFrameRecordingFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallFrameRecordingFrameReadyEvent":{"description":"This event is sent when a frame is captured from a call","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"captured_at":{"description":"The time the frame was captured","format":"date-time","title":"CapturedAt","type":"number","x-stream-index":"006"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"008"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"track_type":{"description":"The type of the track frame was captured from (TRACK_TYPE_VIDEO|TRACK_TYPE_SCREEN_SHARE)","title":"TrackType","type":"string","x-stream-index":"004"},"type":{"default":"call.frame_recording_ready","description":"The type of event: \"call.frame_recording_ready\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"url":{"description":"The URL of the frame","title":"URL","type":"string","x-stream-index":"005"},"users":{"additionalProperties":{"$ref":"#/components/schemas/UserResponse"},"description":"The users in the frame","title":"Users","type":"object","x-stream-index":"007"}},"required":["type","created_at","call_cid","session_id","track_type","url","captured_at","users","egress_id"],"title":"CallFrameRecordingFrameReadyEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallFrameRecordingStartedEvent":{"description":"This event is sent when frame recording has started","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.frame_recording_started","description":"The type of event: \"call.frame_recording_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","egress_id"],"title":"CallFrameRecordingStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallFrameRecordingStoppedEvent":{"description":"This event is sent when frame recording has stopped","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.frame_recording_stopped","description":"The type of event: \"call.frame_recording_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","egress_id"],"title":"CallFrameRecordingStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallHLSBroadcastingFailedEvent":{"description":"This event is sent when HLS broadcasting has failed","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.hls_broadcasting_failed","description":"The type of event: \"call.hls_broadcasting_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallHLSBroadcastingFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallHLSBroadcastingStartedEvent":{"description":"This event is sent when HLS broadcasting has started","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"hls_playlist_url":{"type":"string","x-stream-index":"004"},"type":{"default":"call.hls_broadcasting_started","description":"The type of event: \"call.hls_broadcasting_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","hls_playlist_url"],"title":"CallHLSBroadcastingStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallHLSBroadcastingStoppedEvent":{"description":"This event is sent when HLS broadcasting has stopped","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.hls_broadcasting_stopped","description":"The type of event: \"call.hls_broadcasting_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallHLSBroadcastingStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallIngressResponse":{"description":"CallIngressResponse is the payload for ingress settings","properties":{"rtmp":{"$ref":"#/components/schemas/RTMPIngress","title":"RTMP","x-stream-index":"001"}},"required":["rtmp"],"title":"CallIngressResponse","type":"object"},"CallLiveStartedEvent":{"description":"This event is sent when a call is started. Clients receiving this event should start the call.","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.live_started","description":"The type of event: \"call.live_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call"],"title":"CallLiveStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMember":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"010"},"role":{"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["user_id","role","custom","created_at","updated_at"],"type":"object"},"CallMemberAddedEvent":{"description":"This event is sent when one or more members are added to a call","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"the members added to this call","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"004"},"type":{"default":"call.member_added","description":"The type of event: \"call.member_added\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","members"],"title":"CallMemberAddedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMemberRemovedEvent":{"description":"This event is sent when one or more members are removed from a call","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"the list of member IDs removed from the call","items":{"type":"string"},"title":"Members","type":"array","x-stream-index":"004"},"type":{"default":"call.member_removed","description":"The type of event: \"call.member_removed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","members"],"title":"CallMemberRemovedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMemberUpdatedEvent":{"description":"This event is sent when one or more members are updated","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"The list of members that were updated","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"004"},"type":{"default":"call.member_updated","description":"The type of event: \"call.member_updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","members"],"title":"CallMemberUpdatedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMemberUpdatedPermissionEvent":{"description":"This event is sent when one or more members get its role updated","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"capabilities_by_role":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"The capabilities by role for this call","title":"CapabilitiesByRole","type":"object","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"The list of members that were updated","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"005"},"type":{"default":"call.member_updated_permission","description":"The type of event: \"call.member_added\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","capabilities_by_role","members"],"title":"CallMemberUpdatedPermissionEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMissedEvent":{"description":"This event is sent to call members who did not accept/reject/join the call to notify they missed the call","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"List of members who missed the call","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"005"},"notify_user":{"type":"boolean","x-stream-index":"007"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.missed","description":"The type of event: \"call.notification\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The caller from whom the call was missed","title":"User","x-stream-index":"006"}},"required":["type","created_at","call_cid","session_id","call","members","user","notify_user"],"title":"CallMissedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallModerationBlurEvent":{"properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"type":{"default":"call.moderation_blur","type":"string","x-stream-index":"001.001"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["type","created_at","call_cid","user_id","custom"],"title":"CallModerationBlurEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallModerationWarningEvent":{"properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"message":{"type":"string","x-stream-index":"004"},"type":{"default":"call.moderation_warning","type":"string","x-stream-index":"001.001"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["type","created_at","call_cid","user_id","message","custom"],"title":"CallModerationWarningEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallNotificationEvent":{"description":"This event is sent to all call members to notify they are getting called","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"Call members","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"005"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.notification","description":"The type of event: \"call.notification\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user that sent the call notification","title":"User","x-stream-index":"006"}},"required":["type","created_at","call_cid","session_id","call","members","user"],"title":"CallNotificationEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallParticipant":{"nullable":true,"properties":{"JoinedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"004"},"Role":{"type":"string","writeOnly":true,"x-stream-index":"002"},"UserSessionID":{"type":"string","writeOnly":true,"x-stream-index":"003"},"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"001.046"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"001.017"},"banned":{"type":"boolean","x-stream-index":"001.016"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.013"},"id":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"001.023"},"language":{"type":"string","x-stream-index":"001.035"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"001.022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"001.026"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.042"},"role":{"type":"string","x-stream-index":"001.004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.005"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.009"}},"required":["id","role","teams_role","custom","banned","online","Role","UserSessionID","JoinedAt"],"type":"object"},"CallParticipantCountReport":{"properties":{"histogram":{"items":{"$ref":"#/components/schemas/ReportByHistogramBucket"},"type":"array","x-stream-index":"001"}},"required":["histogram"],"type":"object"},"CallParticipantCountReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateCallParticipantCountReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"CallParticipantResponse":{"properties":{"joined_at":{"format":"date-time","type":"number","x-stream-index":"004"},"role":{"type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"},"user_session_id":{"type":"string","x-stream-index":"002"}},"required":["user","user_session_id","role","joined_at"],"type":"object"},"CallReactionEvent":{"description":"This event is sent when a reaction is sent in a call, clients should use this to show the reaction in the call screen","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"reaction":{"$ref":"#/components/schemas/ReactionResponse","description":"the reaction object sent by the user on the call","title":"reaction","x-stream-index":"003"},"type":{"default":"call.reaction_new","description":"The type of event: \"call.reaction_new\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","reaction"],"title":"CallReactionEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRecording":{"description":"CallRecording represents a recording of a call.","properties":{"end_time":{"format":"date-time","title":"The end time of the recording.","type":"number","x-stream-index":"004"},"filename":{"title":"The filename of the recording.","type":"string","x-stream-index":"001"},"session_id":{"title":"The session ID of the recording.","type":"string","x-stream-index":"005"},"start_time":{"format":"date-time","title":"The start time of the recording.","type":"number","x-stream-index":"003"},"url":{"title":"The URL of the recording.","type":"string","x-stream-index":"002"}},"required":["filename","url","start_time","end_time","session_id"],"title":"CallRecording","type":"object"},"CallRecordingFailedEvent":{"description":"This event is sent when call recording has failed","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"003"},"type":{"default":"call.recording_failed","description":"The type of event: \"call.recording_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","egress_id"],"title":"CallRecordingFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRecordingReadyEvent":{"description":"This event is sent when call recording is ready","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"call_recording":{"$ref":"#/components/schemas/CallRecording","description":"The call recording object","title":"CallRecording","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.recording_ready","description":"The type of event: \"call.recording_ready\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call_recording","egress_id"],"title":"CallRecordingReadyEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRecordingStartedEvent":{"description":"This event is sent when call recording has started","properties":{"call_cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"egress_id":{"type":"string","x-stream-index":"001"},"type":{"default":"call.recording_started","description":"The type of event: \"call.recording_started\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001"}},"required":["egress_id","type","created_at","call_cid"],"title":"CallRecordingStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRecordingStoppedEvent":{"description":"This event is sent when call recording has stopped","properties":{"call_cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"egress_id":{"type":"string","x-stream-index":"001"},"type":{"default":"call.recording_stopped","description":"The type of event: \"call.recording_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001"}},"required":["egress_id","type","created_at","call_cid"],"title":"CallRecordingStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRejectedEvent":{"description":"This event is sent when a user rejects a notification to join a call.","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"reason":{"description":"Provides information about why the call was rejected. You can provide any value, but the Stream API and SDKs use these default values: rejected, cancel, timeout and busy","title":"Reason","type":"string","x-stream-index":"005"},"type":{"default":"call.rejected","description":"The type of event: \"call.rejected\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who rejected the call","title":"User","x-stream-index":"004"}},"required":["type","created_at","call_cid","call","user"],"title":"CallRejectedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallReportResponse":{"properties":{"ended_at":{"format":"date-time","type":"number","x-stream-index":"003"},"score":{"format":"float","type":"number","x-stream-index":"001"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002"}},"required":["score"],"type":"object"},"CallRequest":{"description":"CallRequest is the payload for creating a call.","properties":{"channel_cid":{"type":"string","x-stream-index":"009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"members":{"items":{"$ref":"#/components/schemas/MemberRequest"},"maximum":100,"type":"array","x-stream-index":"005"},"settings_override":{"$ref":"#/components/schemas/CallSettingsRequest","x-stream-index":"006"},"starts_at":{"format":"date-time","type":"number","x-stream-index":"007"},"team":{"type":"string","x-stream-index":"001"},"video":{"type":"boolean","x-stream-index":"008"}},"title":"CallRequest","type":"object"},"CallResponse":{"description":"Represents a call","properties":{"backstage":{"type":"boolean","x-stream-index":"016"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"018"},"captioning":{"type":"boolean","x-stream-index":"013"},"channel_cid":{"type":"string","x-stream-index":"024"},"cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"The user that created the call","title":"Created By","x-stream-index":"007"},"current_session_id":{"type":"string","x-stream-index":"005"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"008"},"egress":{"$ref":"#/components/schemas/EgressResponse","x-stream-index":"021"},"ended_at":{"description":"Date/time when the call ended","format":"date-time","title":"Ended At","type":"number","x-stream-index":"014"},"id":{"description":"Call ID","title":"ID","type":"string","x-stream-index":"003"},"ingress":{"$ref":"#/components/schemas/CallIngressResponse","x-stream-index":"019"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"023"},"recording":{"type":"boolean","x-stream-index":"011"},"session":{"$ref":"#/components/schemas/CallSessionResponse","x-stream-index":"020"},"settings":{"$ref":"#/components/schemas/CallSettingsResponse","x-stream-index":"017"},"starts_at":{"description":"Date/time when the call will start","format":"date-time","title":"Starts At","type":"number","x-stream-index":"015"},"team":{"type":"string","x-stream-index":"006"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailResponse","x-stream-index":"022"},"transcribing":{"type":"boolean","x-stream-index":"012"},"type":{"description":"The type of call","title":"Type","type":"string","x-stream-index":"002"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"}},"required":["type","id","cid","current_session_id","created_by","custom","created_at","updated_at","recording","transcribing","captioning","backstage","settings","blocked_user_ids","ingress","egress"],"title":"CallResponse","type":"object"},"CallRingEvent":{"description":"This event is sent to all call members to notify they are getting called","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"005"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"Call members","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"006"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.ring","description":"The type of event: \"call.notification\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user that sent the call notification","title":"User","x-stream-index":"007"},"video":{"type":"boolean","x-stream-index":"008"}},"required":["type","created_at","call_cid","session_id","call","members","user","video"],"title":"CallRingEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRtmpBroadcastFailedEvent":{"description":"This event is sent when a call RTMP broadcast has failed","properties":{"call_cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"002.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.002"},"name":{"description":"Name of the given RTMP broadcast","title":"Name","type":"string","x-stream-index":"003"},"type":{"default":"call.rtmp_broadcast_failed","description":"The type of event: \"call.rtmp_broadcast_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","name"],"title":"CallRtmpBroadcastFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRtmpBroadcastStartedEvent":{"description":"This event is sent when RTMP broadcast has started","properties":{"call_cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"002.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.002"},"name":{"description":"Name of the given RTMP broadcast","title":"Name","type":"string","x-stream-index":"003"},"type":{"default":"call.rtmp_broadcast_started","description":"The type of event: \"call.rtmp_broadcast_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","name"],"title":"CallRtmpBroadcastStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRtmpBroadcastStoppedEvent":{"description":"This event is sent when RTMP broadcast has stopped","properties":{"call_cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"002.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.002"},"name":{"description":"Name of the given RTMP broadcast","title":"Name","type":"string","x-stream-index":"003"},"type":{"default":"call.rtmp_broadcast_stopped","description":"The type of event: \"call.rtmp_broadcast_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","name"],"title":"CallRtmpBroadcastStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSession":{"properties":{"AcceptedBy":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","writeOnly":true,"x-stream-index":"008"},"ActiveSFUs":{"items":{"$ref":"#/components/schemas/SFUIDLastSeen"},"type":"array","writeOnly":true,"x-stream-index":"016"},"AnonymousParticipantCount":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"019"},"AppPK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"002.001"},"CallID":{"type":"string","writeOnly":true,"x-stream-index":"002.003"},"CallType":{"type":"string","writeOnly":true,"x-stream-index":"002.002"},"CreatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"003"},"DeletedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"004"},"EndedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"006"},"LiveEndedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"013"},"LiveStartedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"012"},"MissedBy":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","writeOnly":true,"x-stream-index":"010"},"Participants":{"items":{"$ref":"#/components/schemas/CallParticipant"},"type":"array","writeOnly":true,"x-stream-index":"011"},"ParticipantsCountByRole":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","writeOnly":true,"x-stream-index":"018"},"RejectedBy":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","writeOnly":true,"x-stream-index":"009"},"RingAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"007"},"SFUIDs":{"items":{"type":"string"},"type":"array","writeOnly":true,"x-stream-index":"015"},"SessionID":{"type":"string","writeOnly":true,"x-stream-index":"002.004"},"StartedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"005"},"TimerEndsAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"014"},"UserPermissionOverrides":{"additionalProperties":{"additionalProperties":{"type":"boolean"},"type":"object"},"type":"object","writeOnly":true,"x-stream-index":"017"}},"required":["AppPK","CallType","CallID","SessionID","CreatedAt","AcceptedBy","RejectedBy","MissedBy","Participants","SFUIDs","ActiveSFUs","UserPermissionOverrides","ParticipantsCountByRole","AnonymousParticipantCount"],"type":"object"},"CallSessionEndedEvent":{"description":"This event is sent when a call session ends","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_ended","description":"The type of event: \"call.session_ended\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","call"],"title":"CallSessionEndedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSessionParticipantCountsUpdatedEvent":{"description":"This event is sent when the participant counts in a call session are updated","properties":{"anonymous_participant_count":{"format":"int32","type":"integer","x-stream-index":"005"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"participants_count_by_role":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"004"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_participant_count_updated","description":"The type of event: \"call.session_participant_count_updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","participants_count_by_role","anonymous_participant_count"],"title":"CallSessionParticipantCountsUpdatedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSessionParticipantJoinedEvent":{"description":"This event is sent when a participant joins a call session","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"participant":{"$ref":"#/components/schemas/CallParticipantResponse","description":"The participant that joined the session","title":"Participant","x-stream-index":"004"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_participant_joined","description":"The type of event: \"call.session_participant_joined\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","participant"],"title":"CallSessionParticipantJoinedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSessionParticipantLeftEvent":{"description":"This event is sent when a participant leaves a call session","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"duration_seconds":{"description":"The duration participant was in the session in seconds","format":"int32","title":"Duration","type":"integer","x-stream-index":"005"},"participant":{"$ref":"#/components/schemas/CallParticipantResponse","description":"The participant that left the session","title":"Participant","x-stream-index":"004"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_participant_left","description":"The type of event: \"call.session_participant_left\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","participant","duration_seconds"],"title":"CallSessionParticipantLeftEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSessionResponse":{"properties":{"accepted_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"008"},"anonymous_participant_count":{"format":"int32","type":"integer","x-stream-index":"006"},"ended_at":{"format":"date-time","type":"number","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"live_ended_at":{"format":"date-time","type":"number","x-stream-index":"011"},"live_started_at":{"format":"date-time","type":"number","x-stream-index":"010"},"missed_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"009"},"participants":{"items":{"$ref":"#/components/schemas/CallParticipantResponse"},"type":"array","x-stream-index":"004"},"participants_count_by_role":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"005"},"rejected_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"007"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002"},"timer_ends_at":{"format":"date-time","type":"number","x-stream-index":"012"}},"required":["id","participants","participants_count_by_role","anonymous_participant_count","rejected_by","accepted_by","missed_by"],"type":"object"},"CallSessionStartedEvent":{"description":"This event is sent when a call session starts","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_started","description":"The type of event: \"call.session_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","call"],"title":"CallSessionStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSettings":{"properties":{"audio":{"$ref":"#/components/schemas/AudioSettings","x-stream-index":"001"},"backstage":{"$ref":"#/components/schemas/BackstageSettings","x-stream-index":"002"},"broadcasting":{"$ref":"#/components/schemas/BroadcastSettings","x-stream-index":"007"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordSettings","x-stream-index":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettings","x-stream-index":"008"},"ingress":{"$ref":"#/components/schemas/IngressSettings","x-stream-index":"014"},"limits":{"$ref":"#/components/schemas/LimitsSettings","x-stream-index":"012"},"recording":{"$ref":"#/components/schemas/RecordSettings","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettings","x-stream-index":"010"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettings","x-stream-index":"004"},"session":{"$ref":"#/components/schemas/SessionSettings","x-stream-index":"013"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettings","x-stream-index":"011"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettings","x-stream-index":"009"},"video":{"$ref":"#/components/schemas/VideoSettings","x-stream-index":"003"}},"type":"object"},"CallSettingsRequest":{"properties":{"audio":{"$ref":"#/components/schemas/AudioSettingsRequest","x-stream-index":"001"},"backstage":{"$ref":"#/components/schemas/BackstageSettingsRequest","x-stream-index":"002"},"broadcasting":{"$ref":"#/components/schemas/BroadcastSettingsRequest","x-stream-index":"010"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordingSettingsRequest","x-stream-index":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettingsRequest","x-stream-index":"003"},"ingress":{"$ref":"#/components/schemas/IngressSettingsRequest","x-stream-index":"014"},"limits":{"$ref":"#/components/schemas/LimitsSettingsRequest","x-stream-index":"012"},"recording":{"$ref":"#/components/schemas/RecordSettingsRequest","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettingsRequest","x-stream-index":"007"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettingsRequest","x-stream-index":"008"},"session":{"$ref":"#/components/schemas/SessionSettingsRequest","x-stream-index":"013"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettingsRequest","x-stream-index":"011"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettingsRequest","x-stream-index":"009"},"video":{"$ref":"#/components/schemas/VideoSettingsRequest","x-stream-index":"004"}},"type":"object"},"CallSettingsResponse":{"properties":{"audio":{"$ref":"#/components/schemas/AudioSettingsResponse","x-stream-index":"001"},"backstage":{"$ref":"#/components/schemas/BackstageSettingsResponse","x-stream-index":"002"},"broadcasting":{"$ref":"#/components/schemas/BroadcastSettingsResponse","x-stream-index":"003"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordingSettingsResponse","x-stream-index":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettingsResponse","x-stream-index":"004"},"ingress":{"$ref":"#/components/schemas/IngressSettingsResponse","x-stream-index":"014"},"limits":{"$ref":"#/components/schemas/LimitsSettingsResponse","x-stream-index":"012"},"recording":{"$ref":"#/components/schemas/RecordSettingsResponse","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettingsResponse","x-stream-index":"007"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettingsResponse","x-stream-index":"008"},"session":{"$ref":"#/components/schemas/SessionSettingsResponse","x-stream-index":"013"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettingsResponse","x-stream-index":"011"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettingsResponse","x-stream-index":"009"},"video":{"$ref":"#/components/schemas/VideoSettingsResponse","x-stream-index":"010"}},"required":["audio","backstage","broadcasting","geofencing","recording","frame_recording","ring","screensharing","transcription","video","thumbnails","limits","session"],"type":"object"},"CallStateResponseFields":{"description":"CallStateResponseFields is the payload for call state response","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001"},"members":{"description":"List of call members","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"002"},"membership":{"$ref":"#/components/schemas/MemberResponse","description":"Current user membership object","title":"Membership","x-stream-index":"003"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"004"}},"required":["call","members","own_capabilities","blocked_users"],"title":"CallStateResponseFields","type":"object"},"CallStatsReportReadyEvent":{"description":"This event is sent when the insights report is ready","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.stats_report_ready","description":"The type of event, \"call.report_ready\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id"],"title":"CallStatsReportReadyEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallStatsReportSummaryResponse":{"properties":{"call_cid":{"type":"string","x-stream-index":"001"},"call_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"008"},"call_session_id":{"type":"string","x-stream-index":"002"},"call_status":{"type":"string","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"first_stats_time":{"format":"date-time","type":"number","x-stream-index":"003"},"min_user_rating":{"format":"int32","type":"integer","x-stream-index":"006"},"quality_score":{"format":"int32","type":"integer","x-stream-index":"005"}},"required":["call_cid","call_session_id","first_stats_time","call_status","call_duration_seconds"],"type":"object"},"CallTranscription":{"description":"CallTranscription represents a transcription of a call.","properties":{"end_time":{"format":"date-time","title":"The end time of the transcription.","type":"number","x-stream-index":"004"},"filename":{"title":"The filename of the transcription.","type":"string","x-stream-index":"001"},"session_id":{"title":"The session ID of the transcription.","type":"string","x-stream-index":"005"},"start_time":{"format":"date-time","title":"The start time of the transcription.","type":"number","x-stream-index":"003"},"url":{"title":"The URL of the transcription.","type":"string","x-stream-index":"002"}},"required":["filename","url","start_time","end_time","session_id"],"title":"CallTranscription","type":"object"},"CallTranscriptionFailedEvent":{"description":"This event is sent when call transcription has failed","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"003"},"error":{"description":"The error message detailing why transcription failed.","title":"string","type":"string","x-stream-index":"004"},"type":{"default":"call.transcription_failed","description":"The type of event: \"call.transcription_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","egress_id"],"title":"CallTranscriptionFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallTranscriptionReadyEvent":{"description":"This event is sent when call transcription is ready","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"call_transcription":{"$ref":"#/components/schemas/CallTranscription","description":"The call transcription object","title":"CallTranscription","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.transcription_ready","description":"The type of event: \"call.transcription_ready\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call_transcription","egress_id"],"title":"CallTranscriptionReadyEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallTranscriptionStartedEvent":{"description":"This event is sent when call transcription has started","properties":{"call_cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"egress_id":{"type":"string","x-stream-index":"001"},"type":{"default":"call.transcription_started","description":"The type of event: \"call.transcription_started\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001"}},"required":["egress_id","type","created_at","call_cid"],"title":"CallTranscriptionStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallTranscriptionStoppedEvent":{"description":"This event is sent when call transcription has stopped","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"003"},"type":{"default":"call.transcription_stopped","description":"The type of event: \"call.transcription_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","egress_id"],"title":"CallTranscriptionStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallType":{"properties":{"AppPK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"003"},"CreatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"005"},"ExternalStorage":{"type":"string","writeOnly":true,"x-stream-index":"009"},"Name":{"type":"string","writeOnly":true,"x-stream-index":"004"},"NotificationSettings":{"$ref":"#/components/schemas/NotificationSettings","x-stream-index":"008"},"PK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"002"},"Settings":{"$ref":"#/components/schemas/CallSettings","x-stream-index":"007"},"UpdatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"006"}},"required":["PK","AppPK","Name","CreatedAt","UpdatedAt","ExternalStorage"],"type":"object"},"CallUpdatedEvent":{"description":"This event is sent when a call is updated, clients should use this update the local state of the call.\nThis event also contains the capabilities by role for the call, clients should update the own_capability for the current.","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"capabilities_by_role":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"The capabilities by role for this call","title":"CapabilitiesByRole","type":"object","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.updated","description":"The type of event: \"call.ended\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","capabilities_by_role"],"title":"CallUpdatedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallUserFeedbackSubmittedEvent":{"description":"This event is sent when a user submits feedback for a call.","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"custom":{"additionalProperties":{},"description":"Custom data provided by the user","title":"Custom","type":"object","x-stream-index":"007"},"rating":{"description":"The rating given by the user (1-5)","format":"int32","title":"Rating","type":"integer","x-stream-index":"005"},"reason":{"description":"The reason provided by the user for the rating","title":"Reason","type":"string","x-stream-index":"006"},"sdk":{"type":"string","x-stream-index":"008"},"sdk_version":{"type":"string","x-stream-index":"009"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.user_feedback_submitted","description":"The type of event, \"call.user_feedback\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who submitted the feedback","title":"User","x-stream-index":"004"}},"required":["type","created_at","call_cid","session_id","user","rating"],"title":"CallUserFeedbackSubmittedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallUserMutedEvent":{"description":"This event is sent when a call member is muted","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"from_user_id":{"type":"string","x-stream-index":"003"},"muted_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"type":{"default":"call.user_muted","description":"The type of event: \"call.user_muted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","from_user_id","muted_user_ids"],"title":"CallUserMutedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallsPerDayReport":{"properties":{"count":{"format":"int64","type":"integer","x-stream-index":"001"}},"required":["count"],"type":"object"},"CallsPerDayReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateCallsPerDayReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"CastPollVoteRequest":{"nullable":true,"properties":{"vote":{"$ref":"#/components/schemas/VoteData","description":"Vote data","title":"VoteData","x-stream-index":"004"}},"type":"object"},"Channel":{"properties":{"active_live_locations":{"items":{"$ref":"#/components/schemas/SharedLocation"},"type":"array","x-stream-index":"034"},"auto_translation_enabled":{"type":"boolean","x-stream-index":"029"},"auto_translation_language":{"type":"string","x-stream-index":"030"},"cid":{"type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/ChannelConfig","x-stream-index":"026"},"config_overrides":{"$ref":"#/components/schemas/ConfigOverrides","x-stream-index":"027"},"cooldown":{"format":"int32","type":"integer","x-stream-index":"031"},"created_at":{"format":"date-time","type":"number","x-stream-index":"009"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"019"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"disabled":{"type":"boolean","x-stream-index":"017"},"frozen":{"type":"boolean","x-stream-index":"016"},"id":{"type":"string","x-stream-index":"004"},"invites":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"022"},"last_campaigns":{"type":"string","x-stream-index":"032"},"last_message_at":{"format":"date-time","type":"number","x-stream-index":"006"},"member_count":{"format":"int32","type":"integer","x-stream-index":"021"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"020"},"team":{"type":"string","x-stream-index":"028"},"truncated_by":{"$ref":"#/components/schemas/User","x-stream-index":"015"},"type":{"type":"string","x-stream-index":"005"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"010"}},"required":["cid","id","type","created_at","updated_at","frozen","disabled","custom","auto_translation_language"],"type":"object"},"ChannelConfig":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.026"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.021"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.022"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.027"},"blocklist":{"type":"string","x-stream-index":"001.023"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.024"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.025"},"commands":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"connect_events":{"type":"boolean","x-stream-index":"001.004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"custom_events":{"type":"boolean","x-stream-index":"001.012"},"mark_messages_pending":{"type":"boolean","x-stream-index":"001.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"001.020"},"mutes":{"type":"boolean","x-stream-index":"001.009"},"name":{"type":"string","x-stream-index":"001.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"001.028"},"partition_ttl":{"type":"integer","x-stream-index":"001.029"},"polls":{"type":"boolean","x-stream-index":"001.016"},"push_notifications":{"type":"boolean","x-stream-index":"001.013"},"quotes":{"type":"boolean","x-stream-index":"001.008"},"reactions":{"type":"boolean","x-stream-index":"001.006"},"read_events":{"type":"boolean","x-stream-index":"001.003"},"reminders":{"type":"boolean","x-stream-index":"001.014"},"replies":{"type":"boolean","x-stream-index":"001.007"},"search":{"type":"boolean","x-stream-index":"001.005"},"shared_locations":{"type":"boolean","x-stream-index":"001.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.030"},"typing_events":{"type":"boolean","x-stream-index":"001.002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"002.004"},"uploads":{"type":"boolean","x-stream-index":"001.010"},"url_enrichment":{"type":"boolean","x-stream-index":"001.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"001.017"}},"required":["name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","created_at","updated_at","commands"],"type":"object"},"ChannelConfigWithInfo":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.002.026"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.002.021"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.022"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.002.027"},"blocklist":{"type":"string","x-stream-index":"001.002.023"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.024"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.002.025"},"commands":{"items":{"$ref":"#/components/schemas/Command"},"type":"array","x-stream-index":"001.003"},"connect_events":{"type":"boolean","x-stream-index":"001.002.004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.001.003"},"custom_events":{"type":"boolean","x-stream-index":"001.002.012"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"002"},"mark_messages_pending":{"type":"boolean","x-stream-index":"001.002.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"001.002.020"},"mutes":{"type":"boolean","x-stream-index":"001.002.009"},"name":{"type":"string","x-stream-index":"001.002.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"001.002.028"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"001.002.029"},"polls":{"type":"boolean","x-stream-index":"001.002.016"},"push_notifications":{"type":"boolean","x-stream-index":"001.002.013"},"quotes":{"type":"boolean","x-stream-index":"001.002.008"},"reactions":{"type":"boolean","x-stream-index":"001.002.006"},"read_events":{"type":"boolean","x-stream-index":"001.002.003"},"reminders":{"type":"boolean","x-stream-index":"001.002.014"},"replies":{"type":"boolean","x-stream-index":"001.002.007"},"search":{"type":"boolean","x-stream-index":"001.002.005"},"shared_locations":{"type":"boolean","x-stream-index":"001.002.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.002.030"},"typing_events":{"type":"boolean","x-stream-index":"001.002.002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"uploads":{"type":"boolean","x-stream-index":"001.002.010"},"url_enrichment":{"type":"boolean","x-stream-index":"001.002.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"001.002.017"}},"required":["created_at","updated_at","name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","commands"],"type":"object"},"ChannelCreatedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"channel.created","type":"string","x-stream-index":"001.001"}},"required":["type","created_at"],"title":"ChannelCreatedEvent","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"},"ChannelDeletedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003.004"},"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"003.005"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"team":{"type":"string","x-stream-index":"001.001"},"type":{"default":"channel.deleted","type":"string","x-stream-index":"002.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"ChannelDeletedEvent","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"},"ChannelFrozenEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"channel.frozen","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"ChannelFrozenEvent","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"},"ChannelGetOrCreateRequest":{"nullable":true,"properties":{"data":{"$ref":"#/components/schemas/ChannelInput","x-stream-index":"003"},"hide_for_creator":{"description":"Whether this channel will be hidden for the user who created the channel or not","title":"Hide for creator","type":"boolean","x-stream-index":"007"},"members":{"$ref":"#/components/schemas/PaginationParams","x-stream-index":"010"},"messages":{"$ref":"#/components/schemas/MessagePaginationParams","x-stream-index":"009"},"presence":{"description":"Fetch user presence info","title":"Presence","type":"boolean","x-stream-index":"006"},"state":{"description":"Refresh channel state","title":"State","type":"boolean","x-stream-index":"005"},"thread_unread_counts":{"type":"boolean","x-stream-index":"008"},"watch":{"description":"Start watching the channel","title":"Watch","type":"boolean","x-stream-index":"004"},"watchers":{"$ref":"#/components/schemas/PaginationParams","x-stream-index":"011"}},"type":"object"},"ChannelHiddenEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003.004"},"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"003.005"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"clear_history":{"type":"boolean","x-stream-index":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"type":{"default":"channel.hidden","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["clear_history","cid","channel_id","channel_type","channel_member_count","type","created_at"],"title":"ChannelHiddenEvent","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"},"ChannelInput":{"properties":{"auto_translation_enabled":{"description":"Enable or disable auto translation","title":"Auto translation","type":"boolean","x-stream-index":"005"},"auto_translation_language":{"description":"Switch auto translation language","title":"Auto translation language","type":"string","x-stream-index":"006"},"config_overrides":{"$ref":"#/components/schemas/ChannelConfig","x-stream-index":"024"},"created_by":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"009"},"created_by_id":{"type":"string","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"015"},"disabled":{"type":"boolean","x-stream-index":"014"},"frozen":{"description":"Freeze or unfreeze the channel","title":"Frozen","type":"boolean","x-stream-index":"013"},"invites":{"items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"type":"array","x-stream-index":"016"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"type":"array","x-stream-index":"018"},"team":{"description":"Team the channel belongs to (if multi-tenant mode is enabled)","title":"Team","type":"string","x-stream-index":"004"},"truncated_by_id":{"type":"string","x-stream-index":"010"}},"type":"object"},"ChannelKickedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002.004"},"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"002.005"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"channel.kicked","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"ChannelKickedEvent","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"},"ChannelMember":{"nullable":true,"properties":{"archived_at":{"format":"date-time","type":"number","x-stream-index":"015"},"ban_expires":{"description":"Expiration date of the ban","format":"date-time","title":"Ban expires","type":"number","x-stream-index":"013"},"banned":{"description":"Whether member is banned this channel or not","title":"Banned","type":"boolean","x-stream-index":"012"},"channel_role":{"description":"Role of the member in the channel","title":"Channel Role","type":"string","x-stream-index":"018"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"invite_accepted_at":{"description":"Date when invite was accepted","format":"date-time","title":"Invited accepted at","type":"number","x-stream-index":"006"},"invite_rejected_at":{"description":"Date when invite was rejected","format":"date-time","title":"Invited rejected at","type":"number","x-stream-index":"007"},"invited":{"description":"Whether member was invited or not","title":"Invited","type":"boolean","x-stream-index":"005"},"is_moderator":{"description":"Whether member is channel moderator or not","title":"Is moderator","type":"boolean","x-stream-index":"003"},"notifications_muted":{"type":"boolean","x-stream-index":"019"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"016"},"role":{"description":"Permission level of the member in the channel (DEPRECATED: use channel_role instead)","enum":["member","moderator","admin","owner"],"title":"Role","type":"string","x-stream-index":"017"},"shadow_banned":{"description":"Whether member is shadow banned in this channel or not","title":"Shadow banned","type":"boolean","x-stream-index":"014"},"status":{"type":"string","x-stream-index":"008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"},"user_id":{"title":"User ID","type":"string","x-stream-index":"001"}},"required":["custom","created_at","updated_at","banned","shadow_banned","channel_role","notifications_muted"],"title":"Channel member","type":"object"},"ChannelMemberResponse":{"nullable":true,"properties":{"archived_at":{"format":"date-time","type":"number","x-stream-index":"016"},"ban_expires":{"description":"Expiration date of the ban","format":"date-time","title":"Ban expires","type":"number","x-stream-index":"013"},"banned":{"description":"Whether member is banned this channel or not","title":"Banned","type":"boolean","x-stream-index":"012"},"channel_role":{"description":"Role of the member in the channel","title":"Channel Role","type":"string","x-stream-index":"018"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"invite_accepted_at":{"description":"Date when invite was accepted","format":"date-time","title":"Invited accepted at","type":"number","x-stream-index":"006"},"invite_rejected_at":{"description":"Date when invite was rejected","format":"date-time","title":"Invited rejected at","type":"number","x-stream-index":"007"},"invited":{"description":"Whether member was invited or not","title":"Invited","type":"boolean","x-stream-index":"005"},"is_moderator":{"description":"Whether member is channel moderator or not","title":"Is moderator","type":"boolean","x-stream-index":"003"},"notifications_muted":{"type":"boolean","x-stream-index":"019"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"015"},"role":{"description":"Permission level of the member in the channel (DEPRECATED: use channel_role instead)","enum":["member","moderator","admin","owner"],"title":"Role","type":"string","x-stream-index":"017"},"shadow_banned":{"description":"Whether member is shadow banned in this channel or not","title":"Shadow banned","type":"boolean","x-stream-index":"014"},"status":{"type":"string","x-stream-index":"008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"},"user_id":{"title":"User ID","type":"string","x-stream-index":"001"}},"required":["custom","created_at","updated_at","banned","shadow_banned","channel_role","notifications_muted"],"title":"Channel member","type":"object"},"ChannelMute":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel that is muted","title":"Channel","x-stream-index":"002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"004"},"expires":{"description":"Date/time of mute expiration","format":"date-time","title":"Expires","type":"number","x-stream-index":"003"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Owner of channel mute","title":"User","x-stream-index":"001"}},"required":["created_at","updated_at"],"type":"object"},"ChannelOwnCapability":{"description":"All possibility of string to use","enum":["ban-channel-members","cast-poll-vote","connect-events","create-attachment","delete-any-message","delete-channel","delete-own-message","flag-message","freeze-channel","join-channel","leave-channel","mute-channel","pin-message","query-poll-votes","quote-message","read-events","search-messages","send-custom-events","send-links","send-message","send-poll","send-reaction","send-reply","send-restricted-visibility-message","send-typing-events","set-channel-cooldown","share-location","skip-slow-mode","slow-mode","typing-events","update-any-message","update-channel","update-channel-members","update-own-message","update-thread","upload-file"],"title":"ChannelOwnCapability","type":"string"},"ChannelPushPreferences":{"properties":{"chat_level":{"type":"string","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"number","x-stream-index":"002"}},"type":"object"},"ChannelResponse":{"description":"Represents channel in chat","properties":{"auto_translation_enabled":{"description":"Whether auto translation is enabled or not","title":"Auto translation","type":"boolean","x-stream-index":"017"},"auto_translation_language":{"description":"Language to translate to when auto translation is active","title":"Auto translation language","type":"string","x-stream-index":"018"},"blocked":{"description":"Whether this channel is blocked by current user or not","title":"Blocked","type":"boolean","x-stream-index":"023"},"cid":{"description":"Channel CID (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/ChannelConfigWithInfo","description":"Channel configuration","title":"ChannelConfigWithInfo","x-stream-index":"013"},"cooldown":{"description":"Cooldown period after sending each message","format":"int32","title":"Cooldown","type":"integer","x-stream-index":"020"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"005"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"Creator of the channel","title":"UserResponse","x-stream-index":"008"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"026"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"007"},"disabled":{"type":"boolean","x-stream-index":"010"},"frozen":{"description":"Whether channel is frozen or not","title":"Frozen","type":"boolean","x-stream-index":"009"},"hidden":{"description":"Whether this channel is hidden by current user or not","title":"Hidden","type":"boolean","x-stream-index":"022"},"hide_messages_before":{"description":"Date since when the message history is accessible","format":"date-time","title":"Hide messages before","type":"number","x-stream-index":"019"},"id":{"description":"Channel unique ID","title":"ID","type":"string","x-stream-index":"001"},"last_message_at":{"description":"Date of the last message sent","format":"date-time","title":"Last message at","type":"number","x-stream-index":"004"},"member_count":{"description":"Number of members in the channel","format":"int32","title":"Member count","type":"integer","x-stream-index":"012"},"members":{"description":"List of channel members (max 100)","items":{"$ref":"#/components/schemas/ChannelMember"},"title":"ChannelMembers","type":"array","x-stream-index":"011"},"mute_expires_at":{"description":"Date of mute expiration","format":"date-time","title":"Mute expires at","type":"number","x-stream-index":"015"},"muted":{"description":"Whether this channel is muted or not","title":"Muted","type":"boolean","x-stream-index":"014"},"own_capabilities":{"description":"List of channel capabilities of authenticated user","items":{"$ref":"#/components/schemas/ChannelOwnCapability"},"title":"ChannelOwnCapability","type":"array","x-stream-index":"021"},"team":{"description":"Team the channel belongs to (multi-tenant only)","title":"Team","type":"string","x-stream-index":"016"},"truncated_at":{"description":"Date of the latest truncation of the channel","format":"date-time","title":"UserResponse","type":"number","x-stream-index":"024"},"truncated_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"025"},"type":{"description":"Type of the channel","title":"Type","type":"string","x-stream-docs-page-id":"channel_features","x-stream-index":"002"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"006"}},"required":["id","type","cid","created_at","updated_at","frozen","disabled","custom"],"title":"Channel","type":"object"},"ChannelStateResponse":{"nullable":true,"properties":{"active_live_locations":{"items":{"$ref":"#/components/schemas/SharedLocationResponseData"},"type":"array","x-stream-index":"001.015"},"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001.001"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001.014"},"duration":{"type":"string","x-stream-index":"002.001"},"hidden":{"type":"boolean","x-stream-index":"001.011"},"hide_messages_before":{"format":"date-time","type":"number","x-stream-index":"001.012"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"001.007"},"membership":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"001.008"},"messages":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","x-stream-index":"001.002"},"pending_messages":{"items":{"$ref":"#/components/schemas/PendingMessageResponse"},"type":"array","x-stream-index":"001.013"},"pinned_messages":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","x-stream-index":"001.003"},"push_preferences":{"$ref":"#/components/schemas/ChannelPushPreferences","x-stream-index":"001.009"},"read":{"items":{"$ref":"#/components/schemas/ReadStateResponse"},"type":"array","x-stream-index":"001.006"},"threads":{"items":{"$ref":"#/components/schemas/ThreadStateResponse"},"type":"array","x-stream-index":"001.010"},"watcher_count":{"format":"int32","type":"integer","x-stream-index":"001.004"},"watchers":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"001.005"}},"required":["messages","pinned_messages","members","threads","duration"],"type":"object"},"ChannelStateResponseFields":{"properties":{"active_live_locations":{"description":"Active live locations in the channel","items":{"$ref":"#/components/schemas/SharedLocationResponseData"},"title":"Active Live Locations","type":"array","x-stream-index":"015"},"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"014"},"hidden":{"description":"Whether this channel is hidden or not","title":"Hidden","type":"boolean","x-stream-index":"011"},"hide_messages_before":{"description":"Messages before this date are hidden from the user","format":"date-time","title":"Hide messages before","type":"number","x-stream-index":"012"},"members":{"description":"List of channel members","items":{"$ref":"#/components/schemas/ChannelMember"},"title":"Members","type":"array","x-stream-index":"007"},"membership":{"$ref":"#/components/schemas/ChannelMember","description":"Current user membership object","title":"Membership","x-stream-index":"008"},"messages":{"description":"List of channel messages","items":{"$ref":"#/components/schemas/MessageResponse"},"title":"Message","type":"array","x-stream-index":"002"},"pending_messages":{"description":"Pending messages that this user has sent","items":{"$ref":"#/components/schemas/PendingMessageResponse"},"title":"Pending messages","type":"array","x-stream-index":"013"},"pinned_messages":{"description":"List of pinned messages in the channel","items":{"$ref":"#/components/schemas/MessageResponse"},"title":"Pinned messages","type":"array","x-stream-docs-page-id":"pinned_messages","x-stream-index":"003"},"push_preferences":{"$ref":"#/components/schemas/ChannelPushPreferences","x-stream-index":"009"},"read":{"description":"List of read states","items":{"$ref":"#/components/schemas/ReadStateResponse"},"title":"Read","type":"array","x-stream-index":"006"},"threads":{"items":{"$ref":"#/components/schemas/ThreadStateResponse"},"type":"array","x-stream-index":"010"},"watcher_count":{"description":"Number of channel watchers","format":"int32","title":"Watcher count","type":"integer","x-stream-index":"004"},"watchers":{"description":"List of user who is watching the channel","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Watchers","type":"array","x-stream-index":"005"}},"required":["messages","pinned_messages","members","threads"],"type":"object"},"ChannelStopWatchingRequest":{"nullable":true,"type":"object"},"ChannelTruncatedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001.004"},"channel_id":{"type":"string","x-stream-index":"001.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"001.005"},"channel_type":{"type":"string","x-stream-index":"001.003"},"cid":{"type":"string","x-stream-index":"001.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"type":{"default":"channel.truncated","type":"string","x-stream-index":"002.001"}},"required":["cid","channel_id","channel_type","channel_member_count","type","created_at"],"title":"ChannelTruncatedEvent","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"},"ChannelUnFrozenEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"channel.unfrozen","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"ChannelUnFrozenEvent","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"},"ChannelUpdatedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"004.004"},"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"004.005"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"002.001"},"type":{"default":"channel.updated","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"ChannelUpdatedEvent","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"},"ChannelVisibleEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"001.002"},"channel_type":{"type":"string","x-stream-index":"001.003"},"cid":{"type":"string","x-stream-index":"001.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"type":{"default":"channel.visible","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"ChannelVisibleEvent","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"},"ChatActivityStatsResponse":{"properties":{"Messages":{"$ref":"#/components/schemas/MessageStatsResponse","x-stream-index":"001"}},"type":"object"},"ClosedCaptionEvent":{"description":"This event is sent when closed captions are being sent in a call, clients should use this to show the closed captions in the call screen","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"closed_caption":{"$ref":"#/components/schemas/CallClosedCaption","description":"The closed caption object","title":"CallClosedCaption","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.closed_caption","description":"The type of event: \"call.closed_caption\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","closed_caption"],"title":"ClosedCaptionEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CollectUserFeedbackRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"009"},"rating":{"format":"int32","maximum":5,"minimum":1,"type":"integer","x-stream-index":"007"},"reason":{"maxLength":1000,"type":"string","x-stream-index":"008"},"sdk":{"maxLength":50,"type":"string","x-stream-index":"005"},"sdk_version":{"maxLength":50,"type":"string","x-stream-index":"006"},"user_session_id":{"maxLength":50,"type":"string","x-stream-index":"004"}},"required":["sdk","sdk_version","rating"],"type":"object"},"CollectUserFeedbackResponse":{"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"},"Command":{"description":"Represents custom chat command","nullable":true,"properties":{"args":{"description":"Arguments help text, shown in commands auto-completion","title":"Arguments","type":"string","x-stream-index":"006"},"created_at":{"description":"Date/time of creation","format":"date-time","readOnly":true,"title":"Created at","type":"number","x-stream-index":"001"},"description":{"description":"Description, shown in commands auto-completion","title":"Description","type":"string","x-stream-index":"005"},"name":{"description":"Unique command name","title":"Name","type":"string","x-stream-index":"004"},"set":{"description":"Set name used for grouping commands","title":"Set","type":"string","x-stream-index":"007"},"updated_at":{"description":"Date/time of the last update","format":"date-time","readOnly":true,"title":"Updated at","type":"number","x-stream-index":"002"}},"required":["name","description","args","set"],"title":"Command","type":"object"},"CompositeAppSettings":{"properties":{"json_encoded_settings":{"type":"string","x-stream-index":"005"},"url":{"type":"string","x-stream-index":"004"}},"type":"object"},"ConfigOverrides":{"properties":{"blocklist":{"type":"string","x-stream-index":"008"},"blocklist_behavior":{"enum":["flag","block"],"type":"string","x-stream-index":"009"},"commands":{"items":{"type":"string"},"type":"array","x-stream-index":"011"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"010"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"007"},"quotes":{"type":"boolean","x-stream-index":"004"},"reactions":{"type":"boolean","x-stream-index":"002"},"replies":{"type":"boolean","x-stream-index":"003"},"shared_locations":{"type":"boolean","x-stream-index":"013"},"typing_events":{"type":"boolean","x-stream-index":"001"},"uploads":{"type":"boolean","x-stream-index":"005"},"url_enrichment":{"type":"boolean","x-stream-index":"006"},"user_message_reminders":{"type":"boolean","x-stream-index":"012"}},"required":["grants","commands"],"type":"object"},"ConfigResponse":{"properties":{"ai_image_config":{"$ref":"#/components/schemas/AIImageConfig","description":"Configuration for AI image analysis","title":"AI Image Config","x-stream-index":"009"},"ai_text_config":{"$ref":"#/components/schemas/AITextConfig","description":"Configuration for AI text analysis","title":"AI Text Config","x-stream-index":"008"},"ai_video_config":{"$ref":"#/components/schemas/AIVideoConfig","description":"Configuration for AI video analysis","title":"AI Video Config","x-stream-index":"010"},"async":{"description":"Whether moderation should be performed asynchronously","title":"Async","type":"boolean","x-stream-index":"003"},"automod_platform_circumvention_config":{"$ref":"#/components/schemas/AutomodPlatformCircumventionConfig","description":"Configuration for platform circumvention detection","title":"Automod Platform Circumvention Config","x-stream-index":"005"},"automod_semantic_filters_config":{"$ref":"#/components/schemas/AutomodSemanticFiltersConfig","description":"Configuration for semantic filtering","title":"Automod Semantic Filters Config","x-stream-index":"006"},"automod_toxicity_config":{"$ref":"#/components/schemas/AutomodToxicityConfig","description":"Configuration for toxicity detection","title":"Automod Toxicity Config","x-stream-index":"004"},"block_list_config":{"$ref":"#/components/schemas/BlockListConfig","description":"Configuration for block list filtering","title":"Block List Config","x-stream-index":"007"},"created_at":{"description":"When the configuration was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"012"},"key":{"description":"Unique identifier for the moderation configuration","title":"Key","type":"string","x-stream-index":"001"},"rule_builder_config":{"$ref":"#/components/schemas/RuleBuilderConfig","x-stream-index":"015"},"team":{"description":"Team associated with the configuration","title":"Team","type":"string","x-stream-index":"002"},"updated_at":{"description":"When the configuration was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"013"},"velocity_filter_config":{"$ref":"#/components/schemas/VelocityFilterConfig","description":"Configuration for velocity-based filtering","title":"Velocity Filter Config","x-stream-index":"011"},"video_call_rule_config":{"$ref":"#/components/schemas/VideoCallRuleConfig","x-stream-index":"014"}},"required":["key","team","async","created_at","updated_at"],"type":"object"},"ConnectUserDetailsRequest":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001"},"image":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"006"},"language":{"type":"string","x-stream-index":"005"},"name":{"type":"string","x-stream-index":"002"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"007"}},"required":["id"],"type":"object"},"ConnectedEvent":{"description":"This event is sent when the WS connection is established and authenticated, this event contains the full user object as it is stored on the server","properties":{"connection_id":{"description":"The connection_id for this client","title":"Connection ID","type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"me":{"$ref":"#/components/schemas/OwnUserResponse","description":"The full user object as it is stored on the server","title":"OwnUserResponse","x-stream-index":"003"},"type":{"default":"connection.ok","description":"The type of event: \"connection.ok\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","connection_id","me"],"title":"ConnectedEvent","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"},"ConnectionErrorEvent":{"description":"This event is sent when the WS connection fails","properties":{"connection_id":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"error":{"$ref":"#/components/schemas/APIError","description":"The error that caused the connection to fail","title":"Error","x-stream-index":"003"},"type":{"default":"connection.error","description":"The type of event: \"connection.ok\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","connection_id","error"],"title":"ConnectionErrorEvent","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"},"ContentCountRuleParameters":{"properties":{"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"required":["threshold","time_window"],"type":"object"},"CountByMinuteResponse":{"nullable":true,"properties":{"count":{"format":"int32","type":"integer","x-stream-index":"002"},"start_ts":{"format":"date-time","type":"number","x-stream-index":"001"}},"required":["start_ts","count"],"type":"object"},"CreateBlockListRequest":{"description":"Block list contains restricted words","nullable":true,"properties":{"name":{"description":"Block list name","maxLength":255,"title":"Name","type":"string","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"004"},"type":{"description":"Block list type.","enum":["regex","domain","domain_allowlist","email","word"],"title":"Type","type":"string","x-stream-index":"003"},"words":{"description":"List of words to block","items":{"type":"string"},"minimum":1,"title":"Words","type":"array","x-stream-index":"002"}},"required":["name","words"],"title":"Block list","type":"object","x-stream-docs-page-id":"block_lists"},"CreateBlockListResponse":{"description":"Basic response information","nullable":true,"properties":{"blocklist":{"$ref":"#/components/schemas/BlockListResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["duration"],"title":"Response","type":"object"},"CreateDeviceRequest":{"description":"Create device request","nullable":true,"properties":{"id":{"description":"Device ID","maxLength":255,"minLength":1,"title":"ID","type":"string","x-stream-index":"001"},"push_provider":{"description":"Push provider","enum":["firebase","apn","huawei","xiaomi"],"title":"PushProvider","type":"string","x-stream-index":"002"},"push_provider_name":{"description":"Push provider name","title":"PushProviderName","type":"string","x-stream-index":"003"},"voip_token":{"description":"When true the token is for Apple VoIP push notifications","title":"VoipToken","type":"boolean","x-stream-index":"004"}},"required":["id","push_provider"],"title":"CreateDeviceRequest","type":"object"},"CreateDraftRequest":{"nullable":true,"properties":{"message":{"$ref":"#/components/schemas/MessageRequest","x-stream-index":"001"}},"required":["message"],"type":"object"},"CreateDraftResponse":{"description":"Basic response information","nullable":true,"properties":{"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["draft","duration"],"title":"Response","type":"object"},"CreateGuestRequest":{"nullable":true,"properties":{"user":{"$ref":"#/components/schemas/UserRequest","description":"User object which server acts upon","title":"User","x-stream-index":"001"}},"required":["user"],"type":"object"},"CreateGuestResponse":{"nullable":true,"properties":{"access_token":{"description":"the access token to authenticate the user","title":"Access token","type":"string","x-stream-index":"002"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User object which server acts upon","title":"User","x-stream-index":"001"}},"required":["user","access_token","duration"],"type":"object"},"CreatePollOptionRequest":{"nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"003"},"text":{"description":"Option text","title":"string","type":"string","x-stream-index":"002"}},"required":["text"],"type":"object"},"CreatePollRequest":{"description":"Contains all information needed to create a new poll","nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"011"},"allow_answers":{"description":"Indicates whether users can suggest user defined answers","title":"Allow answers","type":"boolean","x-stream-index":"009"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"008"},"description":{"description":"A description of the poll","title":"Description","type":"string","x-stream-index":"003"},"enforce_unique_vote":{"description":"Indicates whether users can cast multiple votes","title":"Multiple choice","type":"boolean","x-stream-index":"006"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"is_closed":{"description":"Indicates whether the poll is open for voting","title":"Is closed","type":"boolean","x-stream-index":"010"},"max_votes_allowed":{"description":"Indicates the maximum amount of votes a user can cast","format":"int32","maximum":10,"title":"Maximum votes allowed","type":"integer","x-stream-index":"007"},"name":{"description":"The name of the poll","title":"Name","type":"string","x-stream-index":"002"},"options":{"items":{"$ref":"#/components/schemas/PollOptionInput"},"maximum":100,"type":"array","x-stream-index":"004"},"voting_visibility":{"enum":["anonymous","public"],"type":"string","x-stream-index":"005"}},"required":["name"],"title":"Create Poll Request","type":"object"},"CreateReminderRequest":{"nullable":true,"properties":{"remind_at":{"format":"date-time","type":"number","x-stream-index":"001"}},"type":"object"},"Credentials":{"properties":{"ice_servers":{"items":{"$ref":"#/components/schemas/ICEServer"},"type":"array","x-stream-index":"003"},"server":{"$ref":"#/components/schemas/SFUResponse","x-stream-index":"001"},"token":{"type":"string","x-stream-index":"002"}},"required":["server","token","ice_servers"],"type":"object"},"CustomActionRequest":{"properties":{"id":{"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"type":"object"},"CustomVideoEvent":{"description":"A custom event, this event is used to send custom events to other participants in the call.","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"003"},"type":{"default":"custom","description":"The type of event, \"custom\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"004"}},"required":["type","created_at","call_cid","custom","user"],"title":"CustomVideoEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"DailyAggregateCallDurationReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/CallDurationReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateCallParticipantCountReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/CallParticipantCountReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateCallsPerDayReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/CallsPerDayReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateQualityScoreReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/QualityScoreReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateSDKUsageReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/SDKUsageReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateUserFeedbackReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/UserFeedbackReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"Data":{"properties":{"id":{"type":"string","x-stream-index":"001"}},"required":["id"],"type":"object"},"DeleteActivityRequest":{"properties":{"hard_delete":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"DeleteCallRequest":{"description":"DeleteCallRequest is the payload for deleting a call.","nullable":true,"properties":{"hard":{"description":"if true the call will be hard deleted along with all related data","title":"Hard","type":"boolean","x-stream-index":"001"}},"title":"DeleteCallRequest","type":"object"},"DeleteCallResponse":{"description":"DeleteCallResponse is the payload for deleting a call.","nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","title":"Call","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"task_id":{"title":"TaskID","type":"string","x-stream-index":"002"}},"required":["call","duration"],"title":"DeleteCallResponse","type":"object"},"DeleteChannelResponse":{"description":"Basic response information","nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"Response","type":"object"},"DeleteChannelsRequest":{"nullable":true,"properties":{"cids":{"description":"All channels that should be deleted","items":{"type":"string"},"maximum":100,"minimum":1,"title":"Channels CID","type":"array","x-stream-index":"001"},"hard_delete":{"description":"Specify if channels and all ressources should be hard deleted","title":"Hard delete","type":"boolean","x-stream-index":"002"}},"required":["cids"],"type":"object"},"DeleteChannelsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"result":{"additionalProperties":{"$ref":"#/components/schemas/DeleteChannelsResultResponse"},"description":"Map of channel IDs and their deletion results","title":"Result","type":"object","x-stream-index":"001"},"task_id":{"type":"string","x-stream-index":"002"}},"required":["duration"],"type":"object"},"DeleteChannelsResultResponse":{"nullable":true,"properties":{"error":{"type":"string","x-stream-index":"002"},"status":{"type":"string","x-stream-index":"001"}},"required":["status"],"type":"object"},"DeleteMessageRequest":{"properties":{"hard_delete":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"DeleteMessageResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001"}},"required":["message","duration"],"title":"Response","type":"object"},"DeleteModerationConfigResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"DeleteReactionRequest":{"properties":{"hard_delete":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"DeleteReactionResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001"},"reaction":{"$ref":"#/components/schemas/ReactionResponse","x-stream-index":"002"}},"required":["message","reaction","duration"],"title":"Response","type":"object"},"DeleteRecordingResponse":{"description":"Response for DeleteRecording","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"DeleteRecordingResponse","type":"object"},"DeleteReminderResponse":{"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"},"DeleteTranscriptionResponse":{"description":"DeleteTranscriptionResponse is the payload for deleting a transcription.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"DeleteTranscriptionResponse","type":"object"},"DeleteUserRequest":{"properties":{"delete_conversation_channels":{"type":"boolean","x-stream-index":"003"},"delete_feeds_content":{"type":"boolean","x-stream-index":"004"},"hard_delete":{"type":"boolean","x-stream-index":"001"},"mark_messages_deleted":{"type":"boolean","x-stream-index":"002"}},"type":"object"},"Device":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"disabled":{"type":"boolean","x-stream-index":"002.003"},"disabled_reason":{"type":"string","x-stream-index":"002.004"},"id":{"type":"string","x-stream-index":"002.001.004"},"push_provider":{"enum":["firebase","apn","huawei","xiaomi"],"type":"string","x-stream-index":"002.001.001"},"push_provider_name":{"type":"string","x-stream-index":"002.001.003"},"user_id":{"type":"string","x-stream-index":"004"},"voip":{"type":"boolean","x-stream-index":"002.001.005"}},"required":["push_provider","id","created_at","user_id"],"type":"object"},"DeviceResponse":{"description":"Response for Device","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"004"},"disabled":{"description":"Whether device is disabled or not","title":"Disabled","type":"boolean","x-stream-index":"005"},"disabled_reason":{"description":"Reason explaining why device had been disabled","title":"Reason","type":"string","x-stream-index":"006"},"id":{"description":"Device ID","title":"ID","type":"string","x-stream-index":"003"},"push_provider":{"description":"Push provider","title":"PushProvider","type":"string","x-stream-index":"001"},"push_provider_name":{"description":"Push provider name","title":"PushProviderName","type":"string","x-stream-index":"002"},"user_id":{"description":"User ID","title":"UserID","type":"string","x-stream-index":"008"},"voip":{"description":"When true the token is for Apple VoIP push notifications","title":"Voip","type":"boolean","x-stream-index":"007"}},"required":["push_provider","id","created_at","user_id"],"title":"DeviceResponse","type":"object"},"DraftDeletedEvent":{"description":"Emitted when a Draft is deleted.","nullable":true,"properties":{"cid":{"description":"The CID of the channel where the draft was created","title":"Channel CID","type":"string","x-stream-index":"001.001.002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.001.007"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001.003"},"parent_id":{"description":"The ID of the parent message","title":"Message ID","type":"string","x-stream-index":"001.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.001.004"},"type":{"default":"draft.deleted","description":"The type of event: \"draft.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.001.002"}},"required":["type","created_at","custom"],"title":"DraftDeletedEvent","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"},"DraftPayloadResponse":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"html":{"type":"string","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"001"},"mentioned_users":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"008"},"mml":{"type":"string","x-stream-index":"003"},"parent_id":{"type":"string","x-stream-index":"005"},"poll_id":{"type":"string","x-stream-index":"013"},"quoted_message_id":{"type":"string","x-stream-index":"009"},"show_in_channel":{"type":"boolean","x-stream-index":"006"},"silent":{"type":"boolean","x-stream-index":"012"},"text":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"011"}},"required":["id","text","custom"],"type":"object"},"DraftResponse":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003"},"channel_cid":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"message":{"$ref":"#/components/schemas/DraftPayloadResponse","x-stream-index":"001"},"parent_id":{"type":"string","x-stream-index":"004"},"parent_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"005"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"006"}},"required":["message","channel_cid","created_at"],"type":"object"},"DraftUpdatedEvent":{"description":"Emitted when a Draft is created or updated.","nullable":true,"properties":{"cid":{"description":"The CID of the channel where the draft was created/updated","title":"Channel CID","type":"string","x-stream-index":"001.001.002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.001.007"},"draft":{"$ref":"#/components/schemas/DraftResponse","description":"The draft object which was created/updated","title":"Draft","x-stream-index":"001.003"},"parent_id":{"description":"The ID of the parent message","title":"Parent ID","type":"string","x-stream-index":"001.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.001.004"},"type":{"default":"draft.updated","description":"The type of event: \"draft.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.001.002"}},"required":["type","created_at","custom"],"title":"DraftUpdatedEvent","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"},"EdgeResponse":{"properties":{"continent_code":{"type":"string","x-stream-index":"007.003"},"country_iso_code":{"type":"string","x-stream-index":"007.002"},"green":{"format":"int32","type":"integer","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"latency_test_url":{"type":"string","x-stream-index":"002"},"latitude":{"format":"float","type":"number","x-stream-index":"006.001"},"longitude":{"format":"float","type":"number","x-stream-index":"006.002"},"red":{"format":"int32","type":"integer","x-stream-index":"005"},"subdivision_iso_code":{"type":"string","x-stream-index":"007.001"},"yellow":{"format":"int32","type":"integer","x-stream-index":"004"}},"required":["id","latency_test_url","green","yellow","red","latitude","longitude","subdivision_iso_code","country_iso_code","continent_code"],"type":"object"},"EgressHLSResponse":{"properties":{"playlist_url":{"type":"string","x-stream-index":"001"},"status":{"type":"string","x-stream-index":"002"}},"required":["playlist_url","status"],"type":"object"},"EgressRTMPResponse":{"properties":{"name":{"type":"string","x-stream-index":"001"},"started_at":{"format":"date-time","type":"number","x-stream-index":"004"},"stream_key":{"type":"string","x-stream-index":"003"},"stream_url":{"type":"string","x-stream-index":"002"}},"required":["name","started_at"],"type":"object"},"EgressResponse":{"properties":{"broadcasting":{"type":"boolean","x-stream-index":"001"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordingResponse","x-stream-index":"004"},"hls":{"$ref":"#/components/schemas/EgressHLSResponse","x-stream-index":"002"},"rtmps":{"items":{"$ref":"#/components/schemas/EgressRTMPResponse"},"type":"array","x-stream-index":"003"}},"required":["broadcasting","rtmps"],"type":"object"},"EgressTaskConfig":{"properties":{"egress_user":{"$ref":"#/components/schemas/EgressUser","x-stream-index":"008"},"frame_recording_egress_config":{"$ref":"#/components/schemas/FrameRecordingEgressConfig","x-stream-index":"009"},"hls_egress_config":{"$ref":"#/components/schemas/HLSEgressConfig","x-stream-index":"007"},"recording_egress_config":{"$ref":"#/components/schemas/RecordingEgressConfig","x-stream-index":"006"},"rtmp_egress_config":{"$ref":"#/components/schemas/RTMPEgressConfig","x-stream-index":"004"},"stt_egress_config":{"$ref":"#/components/schemas/STTEgressConfig","x-stream-index":"005"}},"type":"object"},"EgressUser":{"properties":{"token":{"type":"string","x-stream-index":"004"}},"type":"object"},"EndCallRequest":{"description":"Request for ending a call","nullable":true,"title":"EndCallRequest","type":"object"},"EndCallResponse":{"description":"Response for ending a call","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"EndCallResponse","type":"object"},"EnrichedActivity":{"properties":{"actor":{"$ref":"#/components/schemas/Data","x-stream-index":"002"},"foreign_id":{"type":"string","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"latest_reactions":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"013"},"object":{"$ref":"#/components/schemas/Data","x-stream-index":"004"},"origin":{"$ref":"#/components/schemas/Data","x-stream-index":"008"},"own_reactions":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"012"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"011"},"score":{"format":"float","type":"number","x-stream-index":"010"},"target":{"$ref":"#/components/schemas/Data","x-stream-index":"006"},"to":{"items":{"type":"string"},"type":"array","x-stream-index":"009"},"verb":{"type":"string","x-stream-index":"003"}},"type":"object"},"EnrichedReaction":{"nullable":true,"properties":{"activity_id":{"type":"string","x-stream-index":"003"},"children_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"010"},"created_at":{"$ref":"#/components/schemas/Time","x-stream-index":"012"},"data":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"kind":{"type":"string","x-stream-index":"002"},"latest_children":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"008"},"own_children":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"009"},"parent":{"type":"string","x-stream-index":"007"},"target_feeds":{"items":{"type":"string"},"type":"array","x-stream-index":"006"},"updated_at":{"$ref":"#/components/schemas/Time","x-stream-index":"013"},"user":{"$ref":"#/components/schemas/Data","x-stream-index":"011"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["kind","activity_id","user_id"],"type":"object"},"EntityCreator":{"properties":{"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"001.046"},"ban_count":{"format":"int32","type":"integer","x-stream-index":"002"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"001.017"},"banned":{"type":"boolean","x-stream-index":"001.016"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.013"},"deleted_content_count":{"format":"int32","type":"integer","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"001.023"},"language":{"type":"string","x-stream-index":"001.035"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"001.022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"001.026"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.042"},"role":{"type":"string","x-stream-index":"001.004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.005"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.009"}},"required":["id","role","teams_role","custom","banned","online","ban_count","deleted_content_count"],"type":"object"},"EntityCreatorResponse":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.001.018"},"ban_count":{"description":"Number of minor actions performed on the user","format":"int32","title":"Ban Count","type":"integer","x-stream-index":"002"},"banned":{"type":"boolean","x-stream-index":"001.001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.001.017"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.001.016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.001.011"},"deleted_content_count":{"description":"Number of major actions performed on the user","format":"int32","title":"Deleted Content Count","type":"integer","x-stream-index":"003"},"flagged_count":{"description":"Number of flag actions performed on the user","format":"int32","title":"Flagged Count","type":"integer","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001.001.001"},"image":{"type":"string","x-stream-index":"001.001.003"},"language":{"type":"string","x-stream-index":"001.001.005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"001.001.014"},"name":{"type":"string","x-stream-index":"001.001.002"},"online":{"type":"boolean","x-stream-index":"001.001.013"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.001.015"},"role":{"type":"string","x-stream-index":"001.001.006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.001.008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids","shadow_banned","invisible","ban_count","deleted_content_count","flagged_count"],"type":"object"},"EventNotificationSettings":{"properties":{"apns":{"$ref":"#/components/schemas/APNS","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"fcm":{"$ref":"#/components/schemas/FCM","x-stream-index":"003"}},"required":["enabled","apns","fcm"],"type":"object"},"EventRequest":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"parent_id":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"001"}},"required":["type"],"type":"object"},"EventResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"event":{"$ref":"#/components/schemas/WSEvent","x-stream-index":"001"}},"required":["event","duration"],"title":"Response","type":"object"},"ExternalStorage":{"properties":{"abs_account_name":{"type":"string","x-stream-index":"011"},"abs_client_id":{"type":"string","x-stream-index":"013"},"abs_client_secret":{"type":"string","x-stream-index":"014"},"abs_tenant_id":{"type":"string","x-stream-index":"012"},"bucket":{"type":"string","x-stream-index":"005"},"gcs_credentials":{"type":"string","x-stream-index":"010"},"path":{"type":"string","x-stream-index":"006"},"s3_api_key":{"type":"string","x-stream-index":"007"},"s3_custom_endpoint":{"type":"string","x-stream-index":"016"},"s3_region":{"type":"string","x-stream-index":"009"},"s3_secret_key":{"type":"string","x-stream-index":"008"},"storage_name":{"type":"string","x-stream-index":"015"},"storage_type":{"type":"integer","x-stream-index":"004"}},"type":"object"},"FCM":{"properties":{"data":{"additionalProperties":{},"type":"object","x-stream-index":"001"}},"type":"object"},"Field":{"nullable":true,"properties":{"short":{"type":"boolean","x-stream-index":"003"},"title":{"type":"string","x-stream-index":"001"},"value":{"type":"string","x-stream-index":"002"}},"required":["title","value","short"],"type":"object"},"FileUploadConfig":{"properties":{"allowed_file_extensions":{"items":{"type":"string"},"type":"array","x-stream-index":"001"},"allowed_mime_types":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"blocked_file_extensions":{"items":{"type":"string"},"type":"array","x-stream-index":"002"},"blocked_mime_types":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"size_limit":{"format":"int32","maximum":104857600,"minimum":0,"type":"integer","x-stream-index":"005"}},"required":["allowed_file_extensions","blocked_file_extensions","allowed_mime_types","blocked_mime_types","size_limit"],"type":"object"},"FileUploadRequest":{"nullable":true,"properties":{"file":{"description":"file field","title":"File","type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/OnlyUserID","description":"user for the request **server side only**","title":"User","x-stream-index":"002"}},"type":"object"},"FileUploadResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"file":{"description":"URL to the uploaded asset. Should be used to put to `asset_url` attachment field","title":"File","type":"string","x-stream-index":"001"},"thumb_url":{"description":"URL of the file thumbnail for supported file formats. Should be put to `thumb_url` attachment field","title":"Thumbnail URL","type":"string","x-stream-index":"002"}},"required":["duration"],"type":"object"},"Flag":{"description":"Contains information about flagged user or message","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"019"},"custom":{"additionalProperties":{},"description":"Additional metadata about the flag","title":"Custom","type":"object","x-stream-index":"014"},"entity_creator_id":{"description":"ID of the user who created the flagged entity","title":"Entity Creator ID","type":"string","x-stream-index":"009"},"entity_id":{"description":"Unique identifier of the entity being flagged","title":"Entity ID","type":"string","x-stream-index":"008"},"entity_type":{"description":"Type of entity being flagged (e.g., message, user)","title":"Entity Type","type":"string","x-stream-index":"007"},"is_streamed_content":{"type":"boolean","x-stream-index":"012"},"labels":{"description":"Labels from bodyguard, API calls, our own AI etc","items":{"type":"string"},"title":"Labels","type":"array","x-stream-index":"015"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content being flagged","title":"Moderation Payload","x-stream-index":"010"},"moderation_payload_hash":{"type":"string","x-stream-index":"011"},"reason":{"description":"Optional explanation for why the content is being flagged","title":"Reason","type":"string","x-stream-index":"013"},"result":{"description":"Result of bodyguard, API calls, our own AI etc","items":{"additionalProperties":{},"type":"object"},"title":"Result","type":"array","x-stream-index":"016"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"018"},"review_queue_item_id":{"description":"ID of the review queue item","title":"Review Queue Item ID","type":"string","x-stream-index":"017"},"type":{"type":"string","x-stream-index":"004"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"020"},"user":{"$ref":"#/components/schemas/User","description":"User who flagged a message or a user","title":"User","x-stream-index":"006"}},"required":["entity_type","entity_id","result","created_at","updated_at"],"title":"Flag","type":"object"},"FlagContentOptions":{"properties":{"reason":{"type":"string","x-stream-index":"001"}},"required":["reason"],"type":"object"},"FlagDetails":{"properties":{"Extra":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"002"},"automod":{"$ref":"#/components/schemas/AutomodDetails","x-stream-index":"001"},"original_text":{"type":"string","x-stream-index":"003"}},"required":["Extra","original_text"],"type":"object"},"FlagFeedback":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"005"},"labels":{"items":{"$ref":"#/components/schemas/Label"},"type":"array","x-stream-index":"006"},"message_id":{"type":"string","x-stream-index":"004"}},"required":["message_id","created_at","labels"],"type":"object"},"FlagMessageDetails":{"properties":{"pin_changed":{"type":"boolean","x-stream-index":"002"},"should_enrich":{"type":"boolean","x-stream-index":"003"},"skip_push":{"type":"boolean","x-stream-index":"004"},"updated_by_id":{"type":"string","x-stream-index":"001"}},"type":"object"},"FlagRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"description":"Additional metadata about the flag","title":"Custom","type":"object","x-stream-index":"006"},"entity_creator_id":{"description":"ID of the user who created the flagged entity","title":"Entity Creator ID","type":"string","x-stream-index":"003"},"entity_id":{"description":"Unique identifier of the entity being flagged","title":"Entity ID","type":"string","x-stream-index":"002"},"entity_type":{"description":"Type of entity being flagged (e.g., message, user)","title":"Entity Type","type":"string","x-stream-index":"001"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content being flagged","title":"Moderation Payload","x-stream-index":"005"},"reason":{"description":"Optional explanation for why the content is being flagged","maxLength":255,"title":"Reason","type":"string","x-stream-index":"004"}},"required":["entity_type","entity_id"],"type":"object"},"FlagResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"item_id":{"description":"Unique identifier of the created moderation item","title":"Item ID","type":"string","x-stream-index":"001"}},"required":["item_id","duration"],"type":"object"},"FlagUserOptions":{"properties":{"reason":{"type":"string","x-stream-index":"001"}},"required":["reason"],"type":"object"},"FrameRecordSettings":{"properties":{"capture_interval_in_seconds":{"format":"int32","maximum":60,"minimum":2,"type":"integer","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"},"quality":{"type":"string","x-stream-index":"002"}},"required":["mode","capture_interval_in_seconds"],"type":"object"},"FrameRecordingEgressConfig":{"properties":{"capture_interval_in_seconds":{"format":"int32","type":"integer","x-stream-index":"007"},"external_storage":{"$ref":"#/components/schemas/ExternalStorage","x-stream-index":"006"},"quality":{"$ref":"#/components/schemas/Quality","x-stream-index":"004"},"storage_name":{"type":"string","x-stream-index":"005"}},"type":"object"},"FrameRecordingResponse":{"properties":{"status":{"type":"string","x-stream-index":"001"}},"required":["status"],"type":"object"},"FrameRecordingSettingsRequest":{"properties":{"capture_interval_in_seconds":{"format":"int32","maximum":60,"minimum":2,"type":"integer","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"},"quality":{"enum":["360p","480p","720p","1080p","1440p"],"type":"string","x-stream-index":"002"}},"required":["mode","capture_interval_in_seconds"],"type":"object"},"FrameRecordingSettingsResponse":{"properties":{"capture_interval_in_seconds":{"format":"int32","maximum":60,"minimum":2,"type":"integer","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"},"quality":{"type":"string","x-stream-index":"002"}},"required":["mode","capture_interval_in_seconds"],"type":"object"},"FullUserResponse":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"015"},"banned":{"type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"014"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.011"},"devices":{"items":{"$ref":"#/components/schemas/DeviceResponse"},"type":"array","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001.001"},"image":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"005"},"language":{"type":"string","x-stream-index":"001.005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"001.014"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"012"},"mutes":{"items":{"$ref":"#/components/schemas/UserMuteResponse"},"type":"array","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"001.002"},"online":{"type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"003"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.015"},"role":{"type":"string","x-stream-index":"001.006"},"shadow_banned":{"type":"boolean","x-stream-index":"013"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"009"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"010"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"008"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"011"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","devices","invisible","mutes","channel_mutes","unread_count","total_unread_count","unread_channels","unread_threads","shadow_banned","blocked_user_ids"],"type":"object"},"GeofenceSettings":{"properties":{"names":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"required":["names"],"type":"object"},"GeofenceSettingsRequest":{"properties":{"names":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"type":"object"},"GeofenceSettingsResponse":{"properties":{"names":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"required":["names"],"type":"object"},"GetApplicationResponse":{"description":"Basic response information","nullable":true,"properties":{"app":{"$ref":"#/components/schemas/AppResponseFields","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["app","duration"],"title":"Response","type":"object"},"GetBlockedUsersResponse":{"nullable":true,"properties":{"blocks":{"description":"Array of blocked user object","items":{"$ref":"#/components/schemas/BlockedUserResponse"},"title":"Blocks","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["blocks","duration"],"type":"object"},"GetCallReportResponse":{"description":"Basic response information","nullable":true,"properties":{"chat_activity":{"$ref":"#/components/schemas/ChatActivityStatsResponse","x-stream-index":"004"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"report":{"$ref":"#/components/schemas/ReportResponse","x-stream-index":"003"},"session_id":{"type":"string","x-stream-index":"002"},"video_reactions":{"items":{"$ref":"#/components/schemas/VideoReactionsResponse"},"type":"array","x-stream-index":"005"}},"required":["duration","session_id","report"],"title":"Response","type":"object"},"GetCallResponse":{"nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001.001"},"duration":{"type":"string","x-stream-index":"002.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001.002"},"membership":{"$ref":"#/components/schemas/MemberResponse","x-stream-index":"001.003"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"001.004"}},"required":["call","members","own_capabilities","blocked_users","duration"],"title":"GetCallResponse","type":"object"},"GetConfigResponse":{"nullable":true,"properties":{"config":{"$ref":"#/components/schemas/ConfigResponse","description":"The retrieved moderation configuration","title":"Config","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["duration"],"type":"object"},"GetDraftResponse":{"description":"Basic response information","nullable":true,"properties":{"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["draft","duration"],"title":"Response","type":"object"},"GetEdgesResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"edges":{"items":{"$ref":"#/components/schemas/EdgeResponse"},"type":"array","x-stream-index":"001"}},"required":["edges","duration"],"title":"Response","type":"object"},"GetManyMessagesResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.002.001"},"messages":{"description":"List of messages","items":{"$ref":"#/components/schemas/MessageResponse"},"title":"Messages","type":"array","x-stream-index":"001.001"}},"required":["messages","duration"],"type":"object"},"GetMessageResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageWithChannelResponse","x-stream-index":"001"},"pending_message_metadata":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"002"}},"required":["message","duration"],"title":"Response","type":"object"},"GetOGResponse":{"nullable":true,"properties":{"actions":{"items":{"$ref":"#/components/schemas/Action"},"type":"array","x-stream-index":"001.015"},"asset_url":{"description":"URL of detected video or audio","title":"Image URL","type":"string","x-stream-index":"001.017"},"author_icon":{"type":"string","x-stream-index":"001.007"},"author_link":{"description":"og:site","title":"Author Link","type":"string","x-stream-index":"001.006"},"author_name":{"description":"og:site_name","title":"Author Name","type":"string","x-stream-index":"001.005"},"color":{"type":"string","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.018"},"duration":{"type":"string","x-stream-index":"002.001"},"fallback":{"type":"string","x-stream-index":"001.002"},"fields":{"items":{"$ref":"#/components/schemas/Field"},"type":"array","x-stream-index":"001.016"},"footer":{"type":"string","x-stream-index":"001.013"},"footer_icon":{"type":"string","x-stream-index":"001.014"},"giphy":{"$ref":"#/components/schemas/Images","x-stream-index":"001.019"},"image_url":{"description":"URL of detected image","title":"Image URL","type":"string","x-stream-index":"001.011"},"og_scrape_url":{"description":"extracted url from the text","title":"OG Scrape URL","type":"string","x-stream-index":"001.020"},"original_height":{"format":"int32","type":"integer","x-stream-index":"001.022"},"original_width":{"format":"int32","type":"integer","x-stream-index":"001.021"},"pretext":{"type":"string","x-stream-index":"001.004"},"text":{"description":"og:description","title":"Text","type":"string","x-stream-index":"001.010"},"thumb_url":{"description":"URL of detected thumb image","title":"Image URL","type":"string","x-stream-index":"001.012"},"title":{"description":"og:title","title":"Title","type":"string","x-stream-index":"001.008"},"title_link":{"description":"og:url","title":"Title Link","type":"string","x-stream-index":"001.009"},"type":{"description":"Attachment type, could be empty, image, audio or video","title":"Type","type":"string","x-stream-index":"001.001"}},"required":["custom","duration"],"title":"Get OG Attachment","type":"object","x-stream-docs-page-id":"og"},"GetOrCreateCallRequest":{"nullable":true,"properties":{"data":{"$ref":"#/components/schemas/CallRequest","title":"ReadOnlyData","x-stream-index":"003"},"members_limit":{"format":"int32","maximum":100,"type":"integer","x-stream-index":"007"},"notify":{"description":"if provided it sends a notification event to the members for this call","title":"Notify","type":"boolean","x-stream-index":"005"},"ring":{"description":"if provided it sends a ring event to the members for this call","title":"Ring","type":"boolean","x-stream-index":"004"},"video":{"type":"boolean","x-stream-index":"006"}},"title":"GetOrCreateCallRequest","type":"object"},"GetOrCreateCallResponse":{"nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001.001"},"created":{"type":"boolean","x-stream-index":"002"},"duration":{"type":"string","x-stream-index":"003.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001.002"},"membership":{"$ref":"#/components/schemas/MemberResponse","x-stream-index":"001.003"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"001.004"}},"required":["call","members","own_capabilities","blocked_users","created","duration"],"title":"GetOrCreateCallResponse","type":"object"},"GetReactionsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"reactions":{"description":"List of reactions","items":{"$ref":"#/components/schemas/Reaction"},"title":"Reactions","type":"array","x-stream-index":"001"}},"required":["reactions","duration"],"type":"object"},"GetRepliesResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"messages":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","x-stream-index":"001"}},"required":["messages","duration"],"title":"Response","type":"object"},"GetThreadResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"thread":{"$ref":"#/components/schemas/ThreadStateResponse","description":"Enriched thread state","title":"Thread","x-stream-index":"001"}},"required":["thread","duration"],"type":"object"},"GoLiveRequest":{"nullable":true,"properties":{"recording_storage_name":{"type":"string","x-stream-index":"005"},"start_closed_caption":{"type":"boolean","x-stream-index":"008"},"start_hls":{"type":"boolean","x-stream-index":"003"},"start_recording":{"type":"boolean","x-stream-index":"004"},"start_transcription":{"type":"boolean","x-stream-index":"007"},"transcription_storage_name":{"type":"string","x-stream-index":"006"}},"title":"GoLiveRequest","type":"object"},"GoLiveResponse":{"description":"Basic response information","nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["call","duration"],"title":"Response","type":"object"},"GoogleVisionConfig":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"GroupedStatsResponse":{"nullable":true,"properties":{"name":{"type":"string","x-stream-index":"001"},"unique":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["name","unique"],"type":"object"},"HLSEgressConfig":{"properties":{"composite_app_settings":{"$ref":"#/components/schemas/CompositeAppSettings","x-stream-index":"005"},"playlist_url":{"type":"string","x-stream-index":"007"},"qualities":{"items":{"$ref":"#/components/schemas/Quality"},"type":"array","x-stream-index":"004"},"start_unix_nano":{"format":"int64","type":"integer","x-stream-index":"006"}},"type":"object"},"HLSSettings":{"properties":{"auto_on":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"004"},"quality_tracks":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"required":["auto_on","enabled","quality_tracks"],"type":"object"},"HLSSettingsRequest":{"properties":{"auto_on":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"quality_tracks":{"items":{"type":"string"},"maximum":3,"minimum":1,"type":"array","x-stream-index":"003"}},"required":["quality_tracks"],"title":"HLSSettingsRequest","type":"object"},"HLSSettingsResponse":{"description":"HLSSettings is the payload for HLS settings","properties":{"auto_on":{"title":"Auto On","type":"boolean","x-stream-index":"001"},"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"002"},"quality_tracks":{"items":{"type":"string"},"title":"Quality Tracks","type":"array","x-stream-index":"003"}},"required":["auto_on","enabled","quality_tracks","layout"],"title":"HLSSettingsResponse","type":"object"},"HarmConfig":{"properties":{"action_sequences":{"items":{"$ref":"#/components/schemas/ActionSequence"},"type":"array","x-stream-index":"001"},"severity":{"type":"integer","x-stream-index":"002"}},"required":["action_sequences","severity"],"type":"object"},"HealthCheckEvent":{"nullable":true,"properties":{"cid":{"type":"string","x-stream-index":"003"},"connection_id":{"type":"string","x-stream-index":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004.007"},"me":{"$ref":"#/components/schemas/OwnUserResponse","x-stream-index":"002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"004.004"},"type":{"default":"health.check","type":"string","x-stream-index":"004.002"}},"required":["connection_id","type","created_at","custom"],"title":"HealthCheckEvent","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"},"HideChannelRequest":{"nullable":true,"properties":{"clear_history":{"description":"Whether to clear message history of the channel or not","title":"Clear history","type":"boolean","x-stream-index":"001"}},"type":"object"},"HideChannelResponse":{"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"},"ICEServer":{"properties":{"password":{"type":"string","x-stream-index":"003"},"urls":{"items":{"type":"string"},"type":"array","x-stream-index":"001"},"username":{"type":"string","x-stream-index":"002"}},"required":["urls","username","password"],"type":"object"},"ImageContentParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"type":"object"},"ImageData":{"properties":{"frames":{"type":"string","x-stream-index":"005"},"height":{"type":"string","x-stream-index":"003"},"size":{"type":"string","x-stream-index":"004"},"url":{"type":"string","x-stream-index":"001"},"width":{"type":"string","x-stream-index":"002"}},"required":["url","width","height","size","frames"],"type":"object"},"ImageRuleParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"required":["threshold","time_window"],"type":"object"},"ImageSize":{"properties":{"crop":{"description":"Crop mode","enum":["top","bottom","left","right","center"],"title":"Crop","type":"string","x-stream-index":"001"},"height":{"description":"Target image height","format":"int32","title":"Height","type":"integer","x-stream-index":"003"},"resize":{"description":"Resize method","enum":["clip","crop","scale","fill"],"title":"Resize","type":"string","x-stream-index":"002"},"width":{"description":"Target image width","format":"int32","title":"Width","type":"integer","x-stream-index":"004"}},"title":"Image size configuration","type":"object"},"ImageUploadRequest":{"nullable":true,"properties":{"file":{"type":"string","x-stream-index":"001.001"},"upload_sizes":{"description":"field with JSON-encoded array of image size configurations","items":{"$ref":"#/components/schemas/ImageSize"},"title":"Upload sizes","type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/OnlyUserID","x-stream-index":"001.002"}},"type":"object"},"ImageUploadResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.003.001"},"file":{"type":"string","x-stream-index":"001.001"},"thumb_url":{"type":"string","x-stream-index":"001.002"},"upload_sizes":{"description":"Array of image size configurations","items":{"$ref":"#/components/schemas/ImageSize"},"title":"Upload sizes","type":"array","x-stream-index":"002"}},"required":["duration"],"type":"object"},"Images":{"properties":{"fixed_height":{"$ref":"#/components/schemas/ImageData","x-stream-index":"002"},"fixed_height_downsampled":{"$ref":"#/components/schemas/ImageData","x-stream-index":"004"},"fixed_height_still":{"$ref":"#/components/schemas/ImageData","x-stream-index":"003"},"fixed_width":{"$ref":"#/components/schemas/ImageData","x-stream-index":"005"},"fixed_width_downsampled":{"$ref":"#/components/schemas/ImageData","x-stream-index":"007"},"fixed_width_still":{"$ref":"#/components/schemas/ImageData","x-stream-index":"006"},"original":{"$ref":"#/components/schemas/ImageData","x-stream-index":"001"}},"required":["original","fixed_height","fixed_height_still","fixed_height_downsampled","fixed_width","fixed_width_still","fixed_width_downsampled"],"type":"object"},"IngressAudioEncodingOptions":{"properties":{"bitrate":{"maximum":128000,"minimum":16000,"type":"integer","x-stream-index":"003"},"channels":{"enum":["1","2"],"format":"int32","type":"integer","x-stream-index":"001"},"enable_dtx":{"type":"boolean","x-stream-index":"002"}},"required":["channels","enable_dtx","bitrate"],"type":"object"},"IngressAudioEncodingOptionsRequest":{"properties":{"bitrate":{"maximum":128000,"minimum":16000,"type":"integer","x-stream-index":"003"},"channels":{"enum":["1","2"],"format":"int32","type":"integer","x-stream-index":"001"},"enable_dtx":{"type":"boolean","x-stream-index":"002"}},"required":["channels","bitrate"],"type":"object"},"IngressAudioEncodingResponse":{"properties":{"bitrate":{"format":"int32","type":"integer","x-stream-index":"003"},"channels":{"format":"int32","type":"integer","x-stream-index":"001"},"enable_dtx":{"type":"boolean","x-stream-index":"002"}},"required":["channels","enable_dtx","bitrate"],"type":"object"},"IngressSettings":{"properties":{"audio_encoding_options":{"$ref":"#/components/schemas/IngressAudioEncodingOptions","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"video_encoding_options":{"additionalProperties":{"$ref":"#/components/schemas/IngressVideoEncodingOptions"},"type":"object","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"IngressSettingsRequest":{"properties":{"audio_encoding_options":{"$ref":"#/components/schemas/IngressAudioEncodingOptionsRequest","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"video_encoding_options":{"additionalProperties":{"$ref":"#/components/schemas/IngressVideoEncodingOptionsRequest"},"type":"object","x-stream-index":"003"}},"type":"object"},"IngressSettingsResponse":{"properties":{"audio_encoding_options":{"$ref":"#/components/schemas/IngressAudioEncodingResponse","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"video_encoding_options":{"additionalProperties":{"$ref":"#/components/schemas/IngressVideoEncodingResponse"},"type":"object","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"IngressVideoEncodingOptions":{"properties":{"layers":{"items":{"$ref":"#/components/schemas/IngressVideoLayer"},"minimum":1,"type":"array","x-stream-index":"001"}},"required":["layers"],"type":"object"},"IngressVideoEncodingOptionsRequest":{"properties":{"layers":{"items":{"$ref":"#/components/schemas/IngressVideoLayerRequest"},"minimum":1,"type":"array","x-stream-index":"001"}},"required":["layers"],"type":"object"},"IngressVideoEncodingResponse":{"properties":{"layers":{"items":{"$ref":"#/components/schemas/IngressVideoLayerResponse"},"type":"array","x-stream-index":"001"}},"required":["layers"],"type":"object"},"IngressVideoLayer":{"nullable":true,"properties":{"bitrate":{"minimum":1000,"type":"integer","x-stream-index":"002"},"codec":{"enum":["h264","vp8"],"type":"string","x-stream-index":"001"},"frame_rate":{"maximum":60,"minimum":1,"type":"integer","x-stream-index":"003"},"max_dimension":{"minimum":240,"type":"integer","x-stream-index":"005"},"min_dimension":{"minimum":240,"type":"integer","x-stream-index":"004"}},"required":["codec","bitrate","frame_rate","min_dimension","max_dimension"],"type":"object"},"IngressVideoLayerRequest":{"nullable":true,"properties":{"bitrate":{"format":"int32","minimum":1000,"type":"integer","x-stream-index":"002"},"codec":{"enum":["h264","vp8"],"type":"string","x-stream-index":"001"},"frame_rate_limit":{"maximum":60,"minimum":1,"type":"integer","x-stream-index":"005"},"max_dimension":{"minimum":240,"type":"integer","x-stream-index":"004"},"min_dimension":{"minimum":240,"type":"integer","x-stream-index":"003"}},"required":["codec","bitrate","min_dimension","max_dimension","frame_rate_limit"],"type":"object"},"IngressVideoLayerResponse":{"nullable":true,"properties":{"bitrate":{"type":"integer","x-stream-index":"002"},"codec":{"type":"string","x-stream-index":"001"},"frame_rate_limit":{"type":"integer","x-stream-index":"005"},"max_dimension":{"type":"integer","x-stream-index":"004"},"min_dimension":{"type":"integer","x-stream-index":"003"}},"required":["codec","bitrate","min_dimension","max_dimension","frame_rate_limit"],"type":"object"},"JoinCallRequest":{"nullable":true,"properties":{"create":{"description":"if true the call will be created if it doesn't exist","title":"Create","type":"boolean","x-stream-index":"002"},"data":{"$ref":"#/components/schemas/CallRequest","x-stream-index":"003"},"location":{"title":"Location","type":"string","x-stream-index":"009"},"members_limit":{"format":"int32","maximum":100,"title":"The amount of members that should be returned","type":"integer","x-stream-index":"007"},"migrating_from":{"description":"If the participant is migrating from another SFU, then this is the ID of the previous SFU","title":"MigratingFrom","type":"string","x-stream-index":"010"},"notify":{"type":"boolean","x-stream-index":"005"},"ring":{"description":"if true and the call is created, the notification will include ring=true","title":"Ring","type":"boolean","x-stream-index":"004"},"video":{"type":"boolean","x-stream-index":"006"}},"required":["location"],"title":"JoinCallRequest","type":"object"},"JoinCallResponse":{"nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001.001"},"created":{"title":"Created","type":"boolean","x-stream-index":"002"},"credentials":{"$ref":"#/components/schemas/Credentials","title":"Credentials","x-stream-index":"003"},"duration":{"type":"string","x-stream-index":"005.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001.002"},"membership":{"$ref":"#/components/schemas/MemberResponse","x-stream-index":"001.003"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"001.004"},"stats_options":{"$ref":"#/components/schemas/StatsOptions","x-stream-index":"004"}},"required":["call","members","own_capabilities","blocked_users","created","credentials","stats_options","duration"],"title":"JoinCallResponse","type":"object"},"Label":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"phrase_list_ids":{"items":{"format":"int32","type":"integer"},"type":"array","x-stream-index":"002"}},"required":["name"],"type":"object"},"LabelThresholds":{"properties":{"block":{"description":"Threshold for automatic message block","format":"float","maximum":1,"minimum":0,"title":"Block","type":"number","x-stream-index":"002"},"flag":{"description":"Threshold for automatic message flag","format":"float","maximum":1,"minimum":0,"title":"Flag","type":"number","x-stream-index":"001"}},"type":"object"},"LayoutSettings":{"properties":{"detect_orientation":{"type":"boolean","x-stream-index":"005"},"external_app_url":{"type":"string","x-stream-index":"003"},"external_css_url":{"type":"string","x-stream-index":"004"},"name":{"enum":["spotlight","grid","single-participant","mobile","custom"],"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"required":["name","external_app_url","external_css_url"],"type":"object"},"LayoutSettingsRequest":{"properties":{"detect_orientation":{"type":"boolean","x-stream-index":"005"},"external_app_url":{"type":"string","x-stream-index":"003"},"external_css_url":{"type":"string","x-stream-index":"004"},"name":{"enum":["spotlight","grid","single-participant","mobile","custom"],"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"required":["name"],"type":"object"},"LimitsSettings":{"properties":{"max_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"004"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"},"max_participants_exclude_owner":{"type":"boolean","x-stream-index":"003"},"max_participants_exclude_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"002"}},"required":["max_participants_exclude_roles"],"type":"object"},"LimitsSettingsRequest":{"properties":{"max_duration_seconds":{"format":"int32","minimum":0,"type":"integer","x-stream-index":"004"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"},"max_participants_exclude_owner":{"type":"boolean","x-stream-index":"003"},"max_participants_exclude_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"002"}},"type":"object"},"LimitsSettingsResponse":{"properties":{"max_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"004"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"},"max_participants_exclude_owner":{"type":"boolean","x-stream-index":"003"},"max_participants_exclude_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"002"}},"required":["max_participants_exclude_roles"],"type":"object"},"ListBlockListResponse":{"description":"Basic response information","nullable":true,"properties":{"blocklists":{"items":{"$ref":"#/components/schemas/BlockListResponse"},"type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["blocklists","duration"],"title":"Response","type":"object"},"ListDevicesResponse":{"description":"List devices response","nullable":true,"properties":{"devices":{"description":"List of devices","items":{"$ref":"#/components/schemas/DeviceResponse"},"title":"Devices","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["devices","duration"],"title":"ListDevicesResponse","type":"object"},"ListRecordingsResponse":{"description":"Response for listing recordings","nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"},"recordings":{"items":{"$ref":"#/components/schemas/CallRecording"},"title":"The list of recordings.","type":"array","x-stream-index":"002"}},"required":["duration","recordings"],"title":"ListRecordingsResponse","type":"object"},"ListTranscriptionsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"},"transcriptions":{"description":"List of transcriptions for the call","items":{"$ref":"#/components/schemas/CallTranscription"},"title":"Transcriptions","type":"array","x-stream-index":"002"}},"required":["duration","transcriptions"],"title":"ListTranscriptionsResponse","type":"object"},"MarkChannelsReadRequest":{"nullable":true,"properties":{"read_by_channel":{"additionalProperties":{"type":"string"},"description":"Map of channel ID to last read message ID","maximum":30,"title":"Read by channel","type":"object","x-stream-index":"001"}},"type":"object"},"MarkReadRequest":{"nullable":true,"properties":{"message_id":{"description":"ID of the message that is considered last read by client","title":"Message ID","type":"string","x-stream-index":"001"},"thread_id":{"description":"Optional Thread ID to specifically mark a given thread as read","title":"Thread ID","type":"string","x-stream-index":"002"}},"type":"object"},"MarkReadResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"event":{"$ref":"#/components/schemas/MessageReadEvent","description":"Mark read event","title":"Event","x-stream-index":"001"}},"required":["duration"],"type":"object"},"MarkReviewedRequest":{"properties":{"content_to_mark_as_reviewed_limit":{"format":"int32","maximum":2500,"type":"integer","x-stream-index":"002"},"disable_marking_content_as_reviewed":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"MarkUnreadRequest":{"nullable":true,"properties":{"message_id":{"description":"ID of the message from where the channel is marked unread","title":"Message ID","type":"string","x-stream-index":"001"},"thread_id":{"description":"Mark a thread unread, specify both the thread and message id","title":"Thread ID","type":"string","x-stream-index":"003"}},"type":"object"},"MemberAddedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"002.001"},"type":{"default":"member.added","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MemberAddedEvent","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"},"MemberLookup":{"properties":{"Limit":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"001"}},"required":["Limit"],"type":"object"},"MemberRemovedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"001.001"},"type":{"default":"member.removed","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MemberRemovedEvent","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"},"MemberRequest":{"description":"MemberRequest is the payload for adding a member to a call.","properties":{"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"003"},"role":{"title":"Role","type":"string","x-stream-index":"002"},"user_id":{"minLength":1,"title":"User ID","type":"string","x-stream-index":"001"}},"required":["user_id"],"title":"MemberRequest","type":"object"},"MemberResponse":{"description":"MemberResponse is the payload for a member of a call.","properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"005"},"custom":{"additionalProperties":{},"description":"Custom member response data","title":"Custom","type":"object","x-stream-index":"004"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"007"},"role":{"title":"Role","type":"string","x-stream-index":"003"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"006"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"},"user_id":{"type":"string","x-stream-index":"002"}},"required":["user","user_id","custom","created_at","updated_at"],"title":"MemberResponse","type":"object"},"MemberUpdatedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"005.002"},"channel_type":{"type":"string","x-stream-index":"005.003"},"cid":{"type":"string","x-stream-index":"005.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"002.001"},"type":{"default":"member.updated","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MemberUpdatedEvent","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"},"MembersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"members":{"description":"List of found members","items":{"$ref":"#/components/schemas/ChannelMember"},"title":"Members","type":"array","x-stream-index":"001"}},"required":["members","duration"],"type":"object"},"Message":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"012"},"before_message_send_failed":{"type":"boolean","x-stream-index":"046"},"cid":{"type":"string","x-stream-index":"028"},"command":{"type":"string","x-stream-index":"006"},"created_at":{"format":"date-time","type":"number","x-stream-index":"030"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"034"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"033"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"023"},"html":{"type":"string","x-stream-index":"007"},"i18n":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"044"},"id":{"type":"string","x-stream-index":"002"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"040"},"latest_reactions":{"items":{"$ref":"#/components/schemas/Reaction"},"type":"array","x-stream-index":"013"},"mentioned_users":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"043"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"052"},"mml":{"type":"string","x-stream-index":"005"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"056"},"own_reactions":{"items":{"$ref":"#/components/schemas/Reaction"},"type":"array","x-stream-index":"014"},"parent_id":{"type":"string","x-stream-index":"019"},"pin_expires":{"format":"date-time","type":"number","x-stream-index":"051"},"pinned":{"type":"boolean","x-stream-index":"047"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"048"},"pinned_by":{"$ref":"#/components/schemas/User","x-stream-index":"050"},"poll":{"$ref":"#/components/schemas/Poll","x-stream-index":"054"},"poll_id":{"type":"string","x-stream-index":"053"},"quoted_message":{"$ref":"#/components/schemas/Message","x-stream-index":"025"},"quoted_message_id":{"type":"string","x-stream-index":"024"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"015"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"017"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"016"},"reminder":{"$ref":"#/components/schemas/MessageReminder","x-stream-index":"058"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"022"},"restricted_visibility":{"items":{"type":"string"},"type":"array","x-stream-index":"011"},"shadowed":{"type":"boolean","x-stream-index":"036"},"shared_location":{"$ref":"#/components/schemas/SharedLocation","x-stream-index":"055"},"show_in_channel":{"type":"boolean","x-stream-index":"021"},"silent":{"type":"boolean","x-stream-index":"045"},"text":{"type":"string","x-stream-index":"004"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"027"},"type":{"type":"string","x-stream-index":"008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"031"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"010"}},"required":["id","text","html","type","restricted_visibility","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reaction_groups","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned"],"type":"object"},"MessageActionRequest":{"nullable":true,"properties":{"form_data":{"additionalProperties":{"type":"string"},"description":"ReadOnlyData to execute command with","title":"Form data","type":"object","x-stream-index":"002"}},"required":["form_data"],"type":"object"},"MessageChangeSet":{"properties":{"attachments":{"type":"boolean","x-stream-index":"005"},"custom":{"type":"boolean","x-stream-index":"001"},"html":{"type":"boolean","x-stream-index":"004"},"mentioned_user_ids":{"type":"boolean","x-stream-index":"006"},"mml":{"type":"boolean","x-stream-index":"003"},"pin":{"type":"boolean","x-stream-index":"009"},"quoted_message_id":{"type":"boolean","x-stream-index":"007"},"silent":{"type":"boolean","x-stream-index":"008"},"text":{"type":"boolean","x-stream-index":"002"}},"required":["custom","text","mml","html","attachments","mentioned_user_ids","quoted_message_id","silent","pin"],"type":"object"},"MessageDeletedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"006.002"},"hard_delete":{"type":"boolean","x-stream-index":"002.001"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"005.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"message.deleted","type":"string","x-stream-index":"006.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["hard_delete","cid","channel_id","channel_type","type","created_at"],"title":"MessageDeletedEvent","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":{"approved_at":{"format":"date-time","type":"number","x-stream-index":"013"},"created_at":{"format":"date-time","type":"number","x-stream-index":"009"},"created_by_automod":{"type":"boolean","x-stream-index":"001"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"008"},"details":{"$ref":"#/components/schemas/FlagDetails","x-stream-index":"006"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"005"},"moderation_feedback":{"$ref":"#/components/schemas/FlagFeedback","x-stream-index":"003"},"moderation_result":{"$ref":"#/components/schemas/MessageModerationResult","x-stream-index":"002"},"reason":{"type":"string","x-stream-index":"007"},"rejected_at":{"format":"date-time","type":"number","x-stream-index":"014"},"reviewed_at":{"format":"date-time","type":"number","x-stream-index":"011"},"reviewed_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"012"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"004"}},"required":["created_by_automod","created_at","updated_at"],"type":"object"},"MessageModerationResult":{"description":"Result of the message moderation","properties":{"action":{"description":"Action taken by automod","title":"Action","type":"string","x-stream-index":"002"},"ai_moderation_response":{"$ref":"#/components/schemas/ModerationResponse","description":"Response from AI moderation","title":"ModerationResponse","x-stream-index":"007"},"blocked_word":{"description":"Word that was blocked","title":"Blocked word","type":"string","x-stream-index":"004"},"blocklist_name":{"description":"Name of the blocklist","title":"Blocklist name","type":"string","x-stream-index":"005"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"010"},"message_id":{"description":"ID of the message","title":"Message ID","type":"string","x-stream-index":"001"},"moderated_by":{"description":"User who moderated the message","title":"Moderated by","type":"string","x-stream-index":"003"},"moderation_thresholds":{"$ref":"#/components/schemas/Thresholds","description":"Thresholds for AI moderation","title":"Thresholds","x-stream-index":"006"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"011"},"user_bad_karma":{"description":"Whether user has bad karma","title":"User bad karma","type":"boolean","x-stream-index":"009"},"user_karma":{"description":"Karma of the user","format":"float","title":"User karma","type":"number","x-stream-index":"008"}},"required":["message_id","action","user_karma","user_bad_karma","created_at","updated_at"],"title":"Message moderation result","type":"object"},"MessageNewEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"005.002"},"channel_type":{"type":"string","x-stream-index":"005.003"},"cid":{"type":"string","x-stream-index":"005.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"006.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"notification.thread_message_new","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"},"watcher_count":{"format":"int32","type":"integer","x-stream-index":"002.001"}},"required":["watcher_count","type","created_at","cid","channel_id","channel_type"],"title":"MessageNewEvent","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"},"MessageOptions":{"properties":{"include_thread_participants":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"MessagePaginationParams":{"type":"object"},"MessageReadEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"003"},"channel_last_message_at":{"format":"date-time","type":"number","x-stream-index":"005"},"channel_type":{"type":"string","x-stream-index":"004"},"cid":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"009"},"last_read_message_id":{"type":"string","x-stream-index":"010"},"team":{"type":"string","x-stream-index":"006"},"thread":{"$ref":"#/components/schemas/ThreadResponse","x-stream-index":"008"},"type":{"default":"message.read","type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","x-stream-index":"007"}},"required":["type","cid","channel_id","channel_type","created_at"],"type":"object"},"MessageReminder":{"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"004"},"channel_cid":{"type":"string","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"011"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"006"},"message_id":{"type":"string","x-stream-index":"005"},"remind_at":{"format":"date-time","type":"number","x-stream-index":"009"},"task_id":{"type":"string","x-stream-index":"010"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"012"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"user_id":{"type":"string","x-stream-index":"007"}},"required":["channel_cid","message_id","user_id","task_id","created_at","updated_at"],"type":"object"},"MessageRequest":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"maximum":30,"type":"array","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"mentioned_users":{"items":{"type":"string"},"maximum":100,"type":"array","x-stream-index":"008"},"mml":{"type":"string","x-stream-index":"003"},"parent_id":{"type":"string","x-stream-index":"005"},"pin_expires":{"format":"date-time","type":"number","x-stream-index":"015"},"pinned":{"type":"boolean","x-stream-index":"013"},"pinned_at":{"format":"date-time","nullable":true,"type":"string","x-stream-index":"014"},"poll_id":{"type":"string","x-stream-index":"039"},"quoted_message_id":{"type":"string","x-stream-index":"009"},"restricted_visibility":{"items":{"type":"string"},"maximum":10,"type":"array","x-stream-index":"016"},"shared_location":{"$ref":"#/components/schemas/SharedLocation","x-stream-index":"040"},"show_in_channel":{"type":"boolean","x-stream-index":"006"},"silent":{"type":"boolean","x-stream-index":"012"},"text":{"type":"string","x-stream-index":"002"},"type":{"enum":["''","regular","system"],"type":"string","x-stream-index":"011"}},"type":"object"},"MessageResponse":{"description":"Represents any chat message","properties":{"attachments":{"description":"Array of message attachments","items":{"$ref":"#/components/schemas/Attachment"},"title":"Message attachments","type":"array","x-stream-docs-page-id":"message_format#attachment-format","x-stream-index":"008"},"cid":{"description":"Channel unique identifier in \u003ctype\u003e:\u003cid\u003e format","title":"Channel CID","type":"string","x-stream-index":"022"},"command":{"description":"Contains provided slash command","title":"Command","type":"string","x-stream-docs-page-id":"custom_commands_webhook","x-stream-index":"004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"023"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"026"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"025"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"018"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"041"},"html":{"description":"Contains HTML markup of the message. Can only be set when using server-side API","title":"HTML content","type":"string","x-stream-index":"005"},"i18n":{"additionalProperties":{"type":"string"},"description":"Object with translations. Key `language` contains the original language key. Other keys contain translations","title":"Internationalization info","type":"object","x-stream-docs-page-id":"translation","x-stream-index":"030"},"id":{"description":"Message ID is unique string identifier of the message","title":"ID","type":"string","x-stream-index":"001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"Contains image moderation information","title":"Image moderation labels","type":"object","x-stream-index":"028"},"latest_reactions":{"description":"List of 10 latest reactions to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Latest reactions","type":"array","x-stream-index":"009"},"mentioned_users":{"description":"List of mentioned users","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Mentioned Users","type":"array","x-stream-index":"029"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"036"},"mml":{"description":"Should be empty if `text` is provided. Can only be set when using server-side API","title":"Messaging Markup Language","type":"string","x-stream-docs-page-id":"mml_overview","x-stream-index":"003"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"039"},"own_reactions":{"description":"List of 10 latest reactions of authenticated user to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Own reactions","type":"array","x-stream-index":"010"},"parent_id":{"description":"ID of parent message (thread)","title":"Parent message ID","type":"string","x-stream-docs-page-id":"threads","x-stream-index":"015"},"pin_expires":{"description":"Date when pinned message expires","format":"date-time","title":"Pin expiration date","type":"number","x-stream-docs-page-id":"pinned_messages","x-stream-index":"035"},"pinned":{"description":"Whether message is pinned or not","title":"Pinned","type":"boolean","x-stream-docs-page-id":"pinned_messages","x-stream-index":"032"},"pinned_at":{"description":"Date when message got pinned","format":"date-time","title":"Pinned at","type":"number","x-stream-docs-page-id":"pinned_messages","x-stream-index":"033"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","description":"Contains user who pinned the message","title":"Pinned by","x-stream-docs-page-id":"pinned_messages","x-stream-index":"034"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"038"},"poll_id":{"description":"Identifier of the poll to include in the message","title":"Poll ID","type":"string","x-stream-index":"037"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","description":"Contains quoted message","title":"Quoted message","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"020"},"quoted_message_id":{"title":"ID of quoted message","type":"string","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"019"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing number of reactions of each type. Key: reaction type (string), value: number of reactions (int)","title":"Reaction counts","type":"object","x-stream-index":"011"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"014"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing scores of reactions of each type. Key: reaction type (string), value: total score of reactions (int)","title":"Reaction scores","type":"object","x-stream-index":"012"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"042"},"reply_count":{"description":"Number of replies to this message","format":"int32","title":"Reply count","type":"integer","x-stream-index":"017"},"restricted_visibility":{"description":"A list of user ids that have restricted visibility to the message, if the list is not empty, the message is only visible to the users in the list","items":{"type":"string"},"title":"Restricted visibility","type":"array","x-stream-index":"040"},"shadowed":{"description":"Whether the message was shadowed or not","title":"Shadowed","type":"boolean","x-stream-docs-page-id":"moderation#shadow-ban","x-stream-index":"027"},"shared_location":{"$ref":"#/components/schemas/SharedLocationResponseData","description":"Contains shared location data","title":"Shared Location","x-stream-index":"043"},"show_in_channel":{"description":"Whether thread reply should be shown in the channel as well","title":"Show in channel","type":"boolean","x-stream-docs-page-id":"threads","x-stream-index":"016"},"silent":{"description":"Whether message is silent or not","title":"Silent","type":"boolean","x-stream-index":"031"},"text":{"description":"Text of the message. Should be empty if `mml` is provided","title":"Text","type":"string","x-stream-index":"002"},"thread_participants":{"description":"List of users who participate in thread","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Thread participants","type":"array","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"021"},"type":{"description":"Contains type of the message","enum":["regular","ephemeral","error","reply","system","deleted"],"title":"Message Type","type":"string","x-stream-docs-page-id":"message_format#message-types","x-stream-index":"006"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"024"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Sender of the message. Required when using server-side API","title":"User object","x-stream-index":"007"}},"required":["id","text","html","type","user","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned","restricted_visibility"],"title":"Message","type":"object","x-stream-docs-page-id":"send_message"},"MessageStatsResponse":{"properties":{"count_over_time":{"items":{"$ref":"#/components/schemas/CountByMinuteResponse"},"type":"array","x-stream-index":"001"}},"type":"object"},"MessageUndeletedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"005.002"},"channel_type":{"type":"string","x-stream-index":"005.003"},"cid":{"type":"string","x-stream-index":"005.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"002.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"message.undeleted","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MessageUndeletedEvent","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"},"MessageUpdate":{"properties":{"change_set":{"$ref":"#/components/schemas/MessageChangeSet","x-stream-index":"002"},"old_text":{"type":"string","x-stream-index":"001"}},"type":"object"},"MessageUpdatedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"005.002"},"channel_type":{"type":"string","x-stream-index":"005.003"},"cid":{"type":"string","x-stream-index":"005.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"002.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"message.updated","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MessageUpdatedEvent","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"},"MessageWithChannelResponse":{"description":"Represents any chat message","properties":{"attachments":{"description":"Array of message attachments","items":{"$ref":"#/components/schemas/Attachment"},"title":"Message attachments","type":"array","x-stream-docs-page-id":"message_format#attachment-format","x-stream-index":"001.008"},"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel object","title":"Channel","x-stream-index":"002"},"cid":{"description":"Channel unique identifier in \u003ctype\u003e:\u003cid\u003e format","title":"Channel CID","type":"string","x-stream-index":"001.022"},"command":{"description":"Contains provided slash command","title":"Command","type":"string","x-stream-docs-page-id":"custom_commands_webhook","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.023"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.026"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"001.025"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"001.018"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001.041"},"html":{"description":"Contains HTML markup of the message. Can only be set when using server-side API","title":"HTML content","type":"string","x-stream-index":"001.005"},"i18n":{"additionalProperties":{"type":"string"},"description":"Object with translations. Key `language` contains the original language key. Other keys contain translations","title":"Internationalization info","type":"object","x-stream-docs-page-id":"translation","x-stream-index":"001.030"},"id":{"description":"Message ID is unique string identifier of the message","title":"ID","type":"string","x-stream-index":"001.001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"Contains image moderation information","title":"Image moderation labels","type":"object","x-stream-index":"001.028"},"latest_reactions":{"description":"List of 10 latest reactions to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Latest reactions","type":"array","x-stream-index":"001.009"},"mentioned_users":{"description":"List of mentioned users","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Mentioned Users","type":"array","x-stream-index":"001.029"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"001.036"},"mml":{"description":"Should be empty if `text` is provided. Can only be set when using server-side API","title":"Messaging Markup Language","type":"string","x-stream-docs-page-id":"mml_overview","x-stream-index":"001.003"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"001.039"},"own_reactions":{"description":"List of 10 latest reactions of authenticated user to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Own reactions","type":"array","x-stream-index":"001.010"},"parent_id":{"description":"ID of parent message (thread)","title":"Parent message ID","type":"string","x-stream-docs-page-id":"threads","x-stream-index":"001.015"},"pin_expires":{"description":"Date when pinned message expires","format":"date-time","title":"Pin expiration date","type":"number","x-stream-docs-page-id":"pinned_messages","x-stream-index":"001.035"},"pinned":{"description":"Whether message is pinned or not","title":"Pinned","type":"boolean","x-stream-docs-page-id":"pinned_messages","x-stream-index":"001.032"},"pinned_at":{"description":"Date when message got pinned","format":"date-time","title":"Pinned at","type":"number","x-stream-docs-page-id":"pinned_messages","x-stream-index":"001.033"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","description":"Contains user who pinned the message","title":"Pinned by","x-stream-docs-page-id":"pinned_messages","x-stream-index":"001.034"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001.038"},"poll_id":{"description":"Identifier of the poll to include in the message","title":"Poll ID","type":"string","x-stream-index":"001.037"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","description":"Contains quoted message","title":"Quoted message","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"001.020"},"quoted_message_id":{"title":"ID of quoted message","type":"string","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"001.019"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing number of reactions of each type. Key: reaction type (string), value: number of reactions (int)","title":"Reaction counts","type":"object","x-stream-index":"001.011"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"001.014"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing scores of reactions of each type. Key: reaction type (string), value: total score of reactions (int)","title":"Reaction scores","type":"object","x-stream-index":"001.012"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"001.042"},"reply_count":{"description":"Number of replies to this message","format":"int32","title":"Reply count","type":"integer","x-stream-index":"001.017"},"restricted_visibility":{"description":"A list of user ids that have restricted visibility to the message, if the list is not empty, the message is only visible to the users in the list","items":{"type":"string"},"title":"Restricted visibility","type":"array","x-stream-index":"001.040"},"shadowed":{"description":"Whether the message was shadowed or not","title":"Shadowed","type":"boolean","x-stream-docs-page-id":"moderation#shadow-ban","x-stream-index":"001.027"},"shared_location":{"$ref":"#/components/schemas/SharedLocationResponseData","description":"Contains shared location data","title":"Shared Location","x-stream-index":"001.043"},"show_in_channel":{"description":"Whether thread reply should be shown in the channel as well","title":"Show in channel","type":"boolean","x-stream-docs-page-id":"threads","x-stream-index":"001.016"},"silent":{"description":"Whether message is silent or not","title":"Silent","type":"boolean","x-stream-index":"001.031"},"text":{"description":"Text of the message. Should be empty if `mml` is provided","title":"Text","type":"string","x-stream-index":"001.002"},"thread_participants":{"description":"List of users who participate in thread","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Thread participants","type":"array","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"001.021"},"type":{"description":"Contains type of the message","enum":["regular","ephemeral","error","reply","system","deleted"],"title":"Message Type","type":"string","x-stream-docs-page-id":"message_format#message-types","x-stream-index":"001.006"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.024"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Sender of the message. Required when using server-side API","title":"User object","x-stream-index":"001.007"}},"required":["id","text","html","type","user","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned","restricted_visibility","channel"],"title":"Message","type":"object","x-stream-docs-page-id":"send_message"},"ModerationActionConfig":{"nullable":true,"properties":{"action":{"type":"string","x-stream-index":"006"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"009"},"description":{"type":"string","x-stream-index":"008"},"entity_type":{"type":"string","x-stream-index":"004"},"icon":{"type":"string","x-stream-index":"007"},"order":{"format":"int32","type":"integer","x-stream-index":"005"}},"required":["entity_type","order","action","icon","description","custom"],"type":"object"},"ModerationCustomActionEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"001"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"002"},"type":{"default":"moderation.custom_action","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationCustomActionEvent","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"},"ModerationFlaggedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"item":{"type":"string","x-stream-index":"001"},"object_id":{"type":"string","x-stream-index":"002"},"type":{"default":"moderation.flagged","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationFlaggedEvent","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"},"ModerationMarkReviewedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"001"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"002"},"type":{"default":"moderation.mark_reviewed","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationMarkReviewedEvent","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"},"ModerationPayload":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"images":{"items":{"type":"string"},"maximum":30,"type":"array","x-stream-index":"002"},"texts":{"items":{"type":"string"},"type":"array","x-stream-index":"001"},"videos":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"type":"object"},"ModerationResponse":{"properties":{"action":{"type":"string","x-stream-index":"004"},"explicit":{"format":"float","type":"number","x-stream-index":"002"},"spam":{"format":"float","type":"number","x-stream-index":"003"},"toxic":{"format":"float","type":"number","x-stream-index":"001"}},"required":["toxic","explicit","spam","action","automod_response"],"type":"object"},"ModerationV2Response":{"properties":{"action":{"type":"string","x-stream-index":"001"},"blocklist_matched":{"type":"string","x-stream-index":"005"},"image_harms":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"original_text":{"type":"string","x-stream-index":"002"},"platform_circumvented":{"type":"boolean","x-stream-index":"007"},"semantic_filter_matched":{"type":"string","x-stream-index":"006"},"text_harms":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"required":["action","original_text"],"type":"object"},"MuteChannelRequest":{"nullable":true,"properties":{"channel_cids":{"description":"Channel CIDs to mute (if multiple channels)","items":{"type":"string"},"maximum":25,"title":"Channel CIDs","type":"array","x-stream-index":"002"},"expiration":{"description":"Duration of mute in milliseconds","title":"Expiration","type":"integer","x-stream-index":"003"}},"type":"object"},"MuteChannelResponse":{"nullable":true,"properties":{"channel_mute":{"$ref":"#/components/schemas/ChannelMute","description":"Object with channel mute (if one channel was muted)","title":"Channel mute","x-stream-index":"001"},"channel_mutes":{"description":"Object with mutes (if multiple channels were muted)","items":{"$ref":"#/components/schemas/ChannelMute"},"title":"Channel mutes","type":"array","x-stream-index":"002"},"duration":{"type":"string","x-stream-index":"004.001"},"own_user":{"$ref":"#/components/schemas/OwnUser","description":"Authorized user object with fresh mutes information","title":"Own user","x-stream-index":"003"}},"required":["duration"],"type":"object"},"MuteRequest":{"nullable":true,"properties":{"target_ids":{"description":"User IDs to mute (if multiple users)","items":{"type":"string"},"title":"Target IDs","type":"array","x-stream-index":"001"},"timeout":{"description":"Duration of mute in minutes","minimum":0,"title":"Timeout","type":"integer","x-stream-index":"002"}},"required":["target_ids"],"title":"MuteRequest","type":"object"},"MuteResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"004.001"},"mutes":{"description":"Object with mutes (if multiple users were muted)","items":{"$ref":"#/components/schemas/UserMute"},"title":"Mutes","type":"array","x-stream-index":"001"},"non_existing_users":{"description":"A list of users that can't be found. Common cause for this is deleted users","items":{"type":"string"},"title":"Non Existing Users","type":"array","x-stream-index":"003"},"own_user":{"$ref":"#/components/schemas/OwnUser","description":"Authorized user object with fresh mutes information","title":"Own User","x-stream-index":"002"}},"required":["duration"],"title":"MuteResponse","type":"object"},"MuteUsersRequest":{"nullable":true,"properties":{"audio":{"title":"Audio","type":"boolean","x-stream-index":"005"},"mute_all_users":{"type":"boolean","x-stream-index":"003"},"screenshare":{"title":"Screenshare","type":"boolean","x-stream-index":"007"},"screenshare_audio":{"title":"ScreenshareAudio","type":"boolean","x-stream-index":"008"},"user_ids":{"items":{"type":"string"},"title":"UserIDs","type":"array","x-stream-index":"004"},"video":{"title":"Video","type":"boolean","x-stream-index":"006"}},"title":"MuteUsersRequest","type":"object"},"MuteUsersResponse":{"description":"MuteUsersResponse is the response payload for the mute users endpoint.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"MuteUsersResponse","type":"object"},"NetworkMetricsReportResponse":{"properties":{"average_connection_time":{"format":"float","type":"number","x-stream-index":"003"},"average_jitter":{"format":"float","type":"number","x-stream-index":"002"},"average_latency":{"format":"float","type":"number","x-stream-index":"001"},"average_time_to_reconnect":{"format":"float","type":"number","x-stream-index":"004"}},"type":"object"},"NoiseCancellationSettings":{"properties":{"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode"],"type":"object"},"NotificationAddedToChannelEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003.004"},"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"003.005"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"001.001"},"type":{"default":"notification.added_to_channel","type":"string","x-stream-index":"002.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"NotificationAddedToChannelEvent","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"},"NotificationChannelDeletedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003.004"},"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"003.005"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"team":{"type":"string","x-stream-index":"001.001"},"type":{"default":"notification.channel_deleted","type":"string","x-stream-index":"002.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"NotificationChannelDeletedEvent","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"},"NotificationChannelMutesUpdatedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"me":{"$ref":"#/components/schemas/OwnUser","x-stream-index":"001"},"type":{"default":"notification.channel_mutes_updated","type":"string","x-stream-index":"002.001"}},"required":["me","type","created_at"],"title":"NotificationChannelMutesUpdatedEvent","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"},"NotificationChannelTruncatedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002.004"},"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"002.005"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"notification.channel_truncated","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"NotificationChannelTruncatedEvent","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"},"NotificationInviteAcceptedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002.004"},"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"002.005"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"004.001"},"type":{"default":"notification.invite_accepted","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"NotificationInviteAcceptedEvent","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"},"NotificationInviteRejectedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002.004"},"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"002.005"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"004.001"},"type":{"default":"notification.invite_rejected","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"NotificationInviteRejectedEvent","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"},"NotificationInvitedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002.004"},"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"002.005"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"004.001"},"type":{"default":"notification.invited","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"NotificationInvitedEvent","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"},"NotificationMarkReadEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003.004"},"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"003.005"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"team":{"type":"string","x-stream-index":"002.001"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"006"},"type":{"default":"notification.mark_read","type":"string","x-stream-index":"001.001"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"007"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"005"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"008"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count","unread_count","total_unread_count","unread_channels","unread_threads"],"title":"NotificationMarkReadEvent","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"},"NotificationMarkUnreadEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003.004"},"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"003.005"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"first_unread_message_id":{"type":"string","x-stream-index":"005"},"last_read_at":{"format":"date-time","type":"number","x-stream-index":"006"},"last_read_message_id":{"type":"string","x-stream-index":"012"},"team":{"type":"string","x-stream-index":"002.001"},"thread_id":{"type":"string","x-stream-index":"013"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"009"},"type":{"default":"notification.mark_unread","type":"string","x-stream-index":"001.001"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"010"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"008"},"unread_messages":{"format":"int32","type":"integer","x-stream-index":"007"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"011"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count","first_unread_message_id","last_read_at","unread_messages","unread_count","total_unread_count","unread_channels","unread_threads"],"title":"NotificationMarkUnreadEvent","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"},"NotificationMutesUpdatedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"me":{"$ref":"#/components/schemas/OwnUser","x-stream-index":"001"},"type":{"default":"notification.mutes_updated","type":"string","x-stream-index":"002.001"}},"required":["me","type","created_at"],"title":"NotificationMutesUpdatedEvent","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"},"NotificationNewMessageEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"004.004"},"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"004.005"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"002.001"},"type":{"default":"notification.message_new","type":"string","x-stream-index":"003.001"}},"required":["message","type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"NotificationNewMessageEvent","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"},"NotificationRemovedFromChannelEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002.004"},"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"002.005"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"004.001"},"type":{"default":"notification.removed_from_channel","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"NotificationRemovedFromChannelEvent","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"},"NotificationSettings":{"properties":{"call_live_started":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"002"},"call_missed":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"006"},"call_notification":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"004"},"call_ring":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"session_started":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"003"}},"required":["enabled","call_live_started","session_started","call_notification","call_ring","call_missed"],"type":"object"},"NullTime":{"type":"object"},"OCRRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"}},"required":["label","action"],"type":"object"},"OnlyUserID":{"properties":{"id":{"type":"string","x-stream-index":"001"}},"required":["id"],"type":"object"},"OwnCapability":{"description":"All possibility of string to use","enum":["block-users","change-max-duration","create-call","create-reaction","enable-noise-cancellation","end-call","join-backstage","join-call","join-ended-call","mute-users","pin-for-everyone","read-call","remove-call-member","screenshare","send-audio","send-video","start-broadcast-call","start-closed-captions-call","start-frame-record-call","start-record-call","start-transcription-call","stop-broadcast-call","stop-closed-captions-call","stop-frame-record-call","stop-record-call","stop-transcription-call","update-call","update-call-member","update-call-permissions","update-call-settings"],"title":"OwnCapability","type":"string"},"OwnUser":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"046"},"banned":{"type":"boolean","x-stream-index":"016"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"045"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"029"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"014"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"013"},"devices":{"items":{"$ref":"#/components/schemas/Device"},"type":"array","x-stream-index":"027"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"023"},"language":{"type":"string","x-stream-index":"035"},"last_active":{"format":"date-time","type":"number","x-stream-index":"011"},"last_engaged_at":{"format":"date-time","type":"number","x-stream-index":"012"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"037"},"mutes":{"items":{"$ref":"#/components/schemas/UserMute"},"type":"array","x-stream-index":"028"},"online":{"type":"boolean","x-stream-index":"022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"026"},"push_preferences":{"$ref":"#/components/schemas/PushPreferences","x-stream-index":"025"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"005"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"031"},"total_unread_count_by_team":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"032"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"033"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"030"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"034"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"}},"required":["id","role","custom","created_at","updated_at","banned","online","devices","mutes","channel_mutes","unread_count","total_unread_count","total_unread_count_by_team","unread_channels","unread_threads","language"],"type":"object"},"OwnUserResponse":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"banned":{"type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"015"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.011"},"devices":{"items":{"$ref":"#/components/schemas/DeviceResponse"},"title":"Devices","type":"array","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001.001"},"image":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"005"},"language":{"type":"string","x-stream-index":"001.005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"001.014"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"013"},"mutes":{"items":{"$ref":"#/components/schemas/UserMuteResponse"},"type":"array","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"001.002"},"online":{"type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"003"},"push_preferences":{"$ref":"#/components/schemas/PushPreferences","x-stream-index":"002"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.015"},"role":{"type":"string","x-stream-index":"001.006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"009"},"total_unread_count_by_team":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"010"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"011"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"008"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"012"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","devices","invisible","mutes","channel_mutes","unread_count","total_unread_count","unread_channels","unread_threads"],"type":"object"},"PaginationParams":{"properties":{"limit":{"format":"int32","minimum":0,"type":"integer","x-stream-index":"001"},"offset":{"format":"int32","type":"integer","x-stream-index":"002"}},"type":"object"},"ParticipantCountByMinuteResponse":{"nullable":true,"properties":{"first":{"format":"int32","type":"integer","x-stream-index":"002"},"last":{"format":"int32","type":"integer","x-stream-index":"003"},"max":{"format":"int32","type":"integer","x-stream-index":"004"},"min":{"format":"int32","type":"integer","x-stream-index":"005"},"start_ts":{"format":"date-time","type":"number","x-stream-index":"001"}},"required":["start_ts","first","last","max","min"],"type":"object"},"ParticipantCountOverTimeResponse":{"properties":{"by_minute":{"items":{"$ref":"#/components/schemas/ParticipantCountByMinuteResponse"},"type":"array","x-stream-index":"001"}},"type":"object"},"ParticipantReportResponse":{"properties":{"by_browser":{"items":{"$ref":"#/components/schemas/GroupedStatsResponse"},"type":"array","x-stream-index":"008"},"by_country":{"items":{"$ref":"#/components/schemas/GroupedStatsResponse"},"type":"array","x-stream-index":"005"},"by_device":{"items":{"$ref":"#/components/schemas/GroupedStatsResponse"},"type":"array","x-stream-index":"006"},"by_operating_system":{"items":{"$ref":"#/components/schemas/GroupedStatsResponse"},"type":"array","x-stream-index":"007"},"count_over_time":{"$ref":"#/components/schemas/ParticipantCountOverTimeResponse","x-stream-index":"004"},"max_concurrent":{"format":"int32","type":"integer","x-stream-index":"003"},"publishers":{"$ref":"#/components/schemas/PublisherStatsResponse","x-stream-index":"009"},"subscribers":{"$ref":"#/components/schemas/SubscriberStatsResponse","x-stream-index":"010"},"sum":{"format":"int32","type":"integer","x-stream-index":"001"},"unique":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["sum","unique"],"type":"object"},"PendingMessageEvent":{"description":"Pending message event for async moderation","nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"002.007"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"message":{"$ref":"#/components/schemas/Message","description":"The pending message","title":"Message","x-stream-index":"002.009"},"metadata":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"002.010"},"method":{"description":"The method used for the pending message","title":"Method","type":"string","x-stream-index":"003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"type":{"default":"message.pending","description":"The type of event: \"message.pending\" in this case","title":"Event Type","type":"string","x-stream-index":"001.002"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.002"}},"required":["type","custom","method","created_at"],"title":"PendingMessageEvent","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"},"PendingMessageResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"003"},"metadata":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"}},"type":"object"},"PerSDKUsageReport":{"nullable":true,"properties":{"by_version":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"002"},"total":{"format":"int32","type":"integer","x-stream-index":"001"}},"required":["total","by_version"],"type":"object"},"PermissionRequestEvent":{"description":"This event is sent when a user requests access to a feature on a call,\nclients receiving this event should display a permission request to the user","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"permissions":{"description":"The list of permissions requested by the user","items":{"type":"string"},"title":"Permissions","type":"array","x-stream-index":"004"},"type":{"default":"call.permission_request","description":"The type of event: \"call.permission_request\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who sent the permission request","title":"User","x-stream-index":"003"}},"required":["type","created_at","call_cid","user","permissions"],"title":"PermissionRequestEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"PinRequest":{"description":"PinRequest is the payload for pinning a message.","nullable":true,"properties":{"session_id":{"description":"the session ID of the user who pinned the message","title":"SessionID","type":"string","x-stream-index":"003"},"user_id":{"description":"the user ID of the user who pinned the message","title":"UserID","type":"string","x-stream-index":"002"}},"required":["user_id","session_id"],"title":"PinRequest","type":"object"},"PinResponse":{"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"},"Poll":{"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"023"},"allow_answers":{"type":"boolean","x-stream-index":"010"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"009"},"answers_count":{"format":"int32","type":"integer","x-stream-index":"015"},"created_at":{"format":"date-time","type":"number","x-stream-index":"021"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"020"},"created_by_id":{"type":"string","x-stream-index":"019"},"description":{"type":"string","x-stream-index":"005"},"enforce_unique_vote":{"type":"boolean","x-stream-index":"007"},"id":{"type":"string","x-stream-index":"003"},"is_closed":{"type":"boolean","x-stream-index":"011"},"latest_answers":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array","x-stream-index":"017"},"latest_votes_by_option":{"additionalProperties":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array"},"type":"object","x-stream-index":"016"},"max_votes_allowed":{"format":"int32","type":"integer","x-stream-index":"008"},"name":{"type":"string","x-stream-index":"004"},"options":{"items":{"$ref":"#/components/schemas/PollOption"},"type":"array","x-stream-index":"013"},"own_votes":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array","x-stream-index":"018"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"022"},"vote_count":{"format":"int32","type":"integer","x-stream-index":"012"},"vote_counts_by_option":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"014"},"voting_visibility":{"type":"string","x-stream-index":"006"}},"required":["id","name","description","enforce_unique_vote","allow_user_suggested_options","allow_answers","vote_count","options","vote_counts_by_option","answers_count","latest_votes_by_option","latest_answers","own_votes","created_by_id","created_at","updated_at","Custom"],"type":"object"},"PollClosedEvent":{"description":"Emitted when a poll is closed.","nullable":true,"properties":{"activity_id":{"type":"string","x-stream-index":"001.003"},"cid":{"description":"The CID of the channel containing the poll","title":"Channel CID","type":"string","x-stream-index":"001.001.002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.001.007"},"message_id":{"description":"The ID of the message containing the poll","title":"Message ID","type":"string","x-stream-index":"001.002"},"poll":{"$ref":"#/components/schemas/PollResponseData","description":"The poll object which was closed","title":"Poll","x-stream-index":"001.004"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.001.004"},"type":{"default":"poll.closed","description":"The type of event: \"poll.closed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.001.002"}},"required":["type","created_at","custom","poll"],"title":"PollClosedEvent","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"},"PollDeletedEvent":{"description":"Emitted when a poll is deleted.","nullable":true,"properties":{"activity_id":{"type":"string","x-stream-index":"001.003"},"cid":{"description":"The CID of the channel containing the poll","title":"Channel CID","type":"string","x-stream-index":"001.001.002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.001.007"},"message_id":{"description":"The ID of the message containing the poll","title":"Message ID","type":"string","x-stream-index":"001.002"},"poll":{"$ref":"#/components/schemas/PollResponseData","description":"The poll object which was deleted","title":"Poll","x-stream-index":"001.004"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.001.004"},"type":{"default":"poll.deleted","description":"The type of event: \"poll.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.001.002"}},"required":["type","created_at","custom","poll"],"title":"PollDeletedEvent","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"},"PollOption":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id","text","custom"],"type":"object"},"PollOptionInput":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"text":{"type":"string","x-stream-index":"002"}},"type":"object"},"PollOptionRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id"],"type":"object"},"PollOptionResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"poll_option":{"$ref":"#/components/schemas/PollOptionResponseData","description":"Poll option","title":"PollOptionResponseData","x-stream-index":"001"}},"required":["poll_option","duration"],"type":"object"},"PollOptionResponseData":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id","text","custom"],"type":"object"},"PollResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"poll":{"$ref":"#/components/schemas/PollResponseData","description":"Poll","title":"PollResponseData","x-stream-index":"001"}},"required":["poll","duration"],"type":"object"},"PollResponseData":{"properties":{"allow_answers":{"type":"boolean","x-stream-index":"008"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"007"},"answers_count":{"format":"int32","type":"integer","x-stream-index":"012"},"created_at":{"format":"date-time","type":"number","x-stream-index":"019"},"created_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"018"},"created_by_id":{"type":"string","x-stream-index":"017"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"021"},"description":{"type":"string","x-stream-index":"003"},"enforce_unique_vote":{"type":"boolean","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"is_closed":{"type":"boolean","x-stream-index":"009"},"latest_answers":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array","x-stream-index":"015"},"latest_votes_by_option":{"additionalProperties":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array"},"type":"object","x-stream-index":"014"},"max_votes_allowed":{"format":"int32","type":"integer","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"002"},"options":{"items":{"$ref":"#/components/schemas/PollOptionResponseData"},"type":"array","x-stream-index":"011"},"own_votes":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array","x-stream-index":"016"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"020"},"vote_count":{"format":"int32","type":"integer","x-stream-index":"010"},"vote_counts_by_option":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"013"},"voting_visibility":{"type":"string","x-stream-index":"004"}},"required":["id","name","description","voting_visibility","enforce_unique_vote","allow_user_suggested_options","allow_answers","vote_count","options","answers_count","vote_counts_by_option","latest_votes_by_option","latest_answers","own_votes","created_by_id","created_at","updated_at","custom"],"type":"object"},"PollUpdatedEvent":{"description":"Emitted when a poll is updated.","nullable":true,"properties":{"activity_id":{"type":"string","x-stream-index":"001.003"},"cid":{"description":"The CID of the channel containing the poll","title":"Channel CID","type":"string","x-stream-index":"001.001.002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.001.007"},"message_id":{"description":"The ID of the message containing the poll","title":"Message ID","type":"string","x-stream-index":"001.002"},"poll":{"$ref":"#/components/schemas/PollResponseData","description":"The poll object which was updated","title":"Poll","x-stream-index":"001.004"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.001.004"},"type":{"default":"poll.updated","description":"The type of event: \"poll.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.001.002"}},"required":["type","created_at","custom","poll"],"title":"PollUpdatedEvent","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"},"PollVote":{"nullable":true,"properties":{"answer_text":{"type":"string","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"004"},"is_answer":{"type":"boolean","x-stream-index":"006"},"option_id":{"type":"string","x-stream-index":"005"},"poll_id":{"type":"string","x-stream-index":"003"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"011"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"009"},"user_id":{"type":"string","x-stream-index":"008"}},"required":["poll_id","id","option_id","created_at","updated_at"],"type":"object"},"PollVoteCastedEvent":{"description":"Emitted when a vote is cast on a poll.","nullable":true,"properties":{"activity_id":{"type":"string","x-stream-index":"001.001.003"},"cid":{"description":"The CID of the channel containing the poll","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":"number","x-stream-index":"001.001.001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.001.001.007"},"message_id":{"description":"The ID of the message containing the poll","title":"Message ID","type":"string","x-stream-index":"001.001.002"},"poll":{"$ref":"#/components/schemas/PollResponseData","description":"The poll object","title":"Poll","x-stream-index":"001.001.004"},"poll_vote":{"$ref":"#/components/schemas/PollVoteResponseData","description":"The vote that was cast","title":"Poll Vote","x-stream-index":"001.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.001.001.004"},"type":{"default":"poll.vote_casted","description":"The type of event: \"poll.vote_casted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.001.001.002"}},"required":["type","created_at","custom","poll","poll_vote"],"title":"PollVoteCastedEvent","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"},"PollVoteChangedEvent":{"description":"Emitted when a vote on a poll is changed.","nullable":true,"properties":{"activity_id":{"type":"string","x-stream-index":"001.001.003"},"cid":{"description":"The CID of the channel containing the poll","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":"number","x-stream-index":"001.001.001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.001.001.007"},"message_id":{"description":"The ID of the message containing the poll","title":"Message ID","type":"string","x-stream-index":"001.001.002"},"poll":{"$ref":"#/components/schemas/PollResponseData","description":"The poll object","title":"Poll","x-stream-index":"001.001.004"},"poll_vote":{"$ref":"#/components/schemas/PollVoteResponseData","description":"The updated vote","title":"Poll Vote","x-stream-index":"001.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.001.001.004"},"type":{"default":"poll.vote_changed","description":"The type of event: \"poll.vote_changed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.001.001.002"}},"required":["type","created_at","custom","poll","poll_vote"],"title":"PollVoteChangedEvent","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"},"PollVoteRemovedEvent":{"description":"Emitted when a vote is removed from a poll.","nullable":true,"properties":{"activity_id":{"type":"string","x-stream-index":"001.001.003"},"cid":{"description":"The CID of the channel containing the poll","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":"number","x-stream-index":"001.001.001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.001.001.007"},"message_id":{"description":"The ID of the message containing the poll","title":"Message ID","type":"string","x-stream-index":"001.001.002"},"poll":{"$ref":"#/components/schemas/PollResponseData","description":"The poll object","title":"Poll","x-stream-index":"001.001.004"},"poll_vote":{"$ref":"#/components/schemas/PollVoteResponseData","description":"The vote that was removed","title":"Poll Vote","x-stream-index":"001.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.001.001.004"},"type":{"default":"poll.vote_removed","description":"The type of event: \"poll.vote_removed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.001.001.002"}},"required":["type","created_at","custom","poll","poll_vote"],"title":"PollVoteRemovedEvent","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"},"PollVoteResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"vote":{"$ref":"#/components/schemas/PollVoteResponseData","description":"Poll vote","title":"PollVoteResponseData","x-stream-index":"001"}},"required":["duration"],"type":"object"},"PollVoteResponseData":{"nullable":true,"properties":{"answer_text":{"type":"string","x-stream-index":"005"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"id":{"type":"string","x-stream-index":"002"},"is_answer":{"type":"boolean","x-stream-index":"004"},"option_id":{"type":"string","x-stream-index":"003"},"poll_id":{"type":"string","x-stream-index":"001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"007"},"user_id":{"type":"string","x-stream-index":"006"}},"required":["poll_id","id","option_id","created_at","updated_at"],"type":"object"},"PollVotesResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"votes":{"description":"Poll votes","items":{"$ref":"#/components/schemas/PollVoteResponseData"},"title":"PollVoteResponseList","type":"array","x-stream-index":"001"}},"required":["votes","duration"],"type":"object"},"PrivacySettings":{"properties":{"read_receipts":{"$ref":"#/components/schemas/ReadReceipts","x-stream-index":"002"},"typing_indicators":{"$ref":"#/components/schemas/TypingIndicators","x-stream-index":"001"}},"type":"object"},"PrivacySettingsResponse":{"properties":{"read_receipts":{"$ref":"#/components/schemas/ReadReceiptsResponse","x-stream-index":"002"},"typing_indicators":{"$ref":"#/components/schemas/TypingIndicatorsResponse","x-stream-index":"001"}},"type":"object"},"PublisherStatsResponse":{"properties":{"by_track":{"items":{"$ref":"#/components/schemas/TrackStatsResponse"},"type":"array","x-stream-index":"003"},"total":{"format":"int32","type":"integer","x-stream-index":"001"},"unique":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["total","unique"],"type":"object"},"PushPreferenceInput":{"nullable":true,"properties":{"call_level":{"description":"Set the level of call push notifications for the user. One of all, none, default","enum":["all","none","default"],"type":"string","x-stream-index":"004"},"channel_cid":{"description":"Set the push preferences for a specific channel. If empty it sets the default for the user","type":"string","x-stream-index":"002"},"chat_level":{"description":"Set the level of chat push notifications for the user. One of all, mentions, none, default","enum":["all","mentions","none","default"],"type":"string","x-stream-index":"003"},"disabled_until":{"description":"Disable push notifications till a certain time","format":"date-time","type":"number","x-stream-index":"005"},"remove_disable":{"description":"Remove the disabled until time. (IE stop snoozing notifications)","type":"boolean","x-stream-index":"006"},"user_id":{"description":"The user id for which to set the push preferences. Required when using server side auths, defaults to current user with client side auth.","type":"string","x-stream-index":"001"}},"type":"object"},"PushPreferences":{"properties":{"call_level":{"type":"string","x-stream-index":"002"},"chat_level":{"type":"string","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"number","x-stream-index":"003"}},"type":"object"},"Quality":{"properties":{"bitdepth":{"format":"int32","type":"integer","x-stream-index":"007"},"framerate":{"format":"int32","type":"integer","x-stream-index":"008"},"height":{"format":"int32","type":"integer","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"004"},"video_bitrate":{"format":"int32","type":"integer","x-stream-index":"009"},"width":{"format":"int32","type":"integer","x-stream-index":"005"}},"type":"object"},"QualityScoreReport":{"properties":{"histogram":{"items":{"$ref":"#/components/schemas/ReportByHistogramBucket"},"type":"array","x-stream-index":"001"}},"required":["histogram"],"type":"object"},"QualityScoreReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateQualityScoreReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"QueryAggregateCallStatsRequest":{"nullable":true,"properties":{"from":{"type":"string","x-stream-index":"002"},"report_types":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"to":{"type":"string","x-stream-index":"003"}},"type":"object"},"QueryAggregateCallStatsResponse":{"description":"Basic response information","nullable":true,"properties":{"call_duration_report":{"$ref":"#/components/schemas/CallDurationReportResponse","x-stream-index":"002"},"call_participant_count_report":{"$ref":"#/components/schemas/CallParticipantCountReportResponse","x-stream-index":"004"},"calls_per_day_report":{"$ref":"#/components/schemas/CallsPerDayReportResponse","x-stream-index":"003"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"network_metrics_report":{"$ref":"#/components/schemas/NetworkMetricsReportResponse","x-stream-index":"008"},"quality_score_report":{"$ref":"#/components/schemas/QualityScoreReportResponse","x-stream-index":"005"},"sdk_usage_report":{"$ref":"#/components/schemas/SDKUsageReportResponse","x-stream-index":"006"},"user_feedback_report":{"$ref":"#/components/schemas/UserFeedbackReportResponse","x-stream-index":"007"}},"required":["duration"],"title":"Response","type":"object"},"QueryBannedUsersPayload":{"properties":{"exclude_expired_bans":{"description":"Whether to exclude expired bans or not","title":"Exclude expired bans","type":"boolean","x-stream-index":"004"},"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"description":"Number of records to return","format":"int32","maximum":300,"minimum":0,"title":"Limit","type":"integer","x-stream-index":"003.003"},"offset":{"description":"Number of records to offset","format":"int32","maximum":10000,"title":"Offset","type":"integer","x-stream-index":"003.004"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":1,"title":"Sort","type":"array","x-stream-index":"002"}},"required":["filter_conditions"],"type":"object"},"QueryBannedUsersResponse":{"nullable":true,"properties":{"bans":{"description":"List of found bans","items":{"$ref":"#/components/schemas/BanResponse"},"title":"BanResponse","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["bans","duration"],"type":"object"},"QueryCallMembersRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"002"},"id":{"maxLength":64,"type":"string","x-stream-index":"001.002"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"004.001"},"next":{"type":"string","x-stream-index":"004.002"},"prev":{"type":"string","x-stream-index":"004.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":1,"type":"array","x-stream-index":"003"},"type":{"maxLength":64,"type":"string","x-stream-index":"001.001"}},"required":["type","id"],"type":"object"},"QueryCallMembersResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["members","duration"],"title":"Response","type":"object"},"QueryCallParticipantsRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"003"}},"type":"object"},"QueryCallParticipantsResponse":{"nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001.001"},"duration":{"type":"string","x-stream-index":"004.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001.002"},"membership":{"$ref":"#/components/schemas/MemberResponse","x-stream-index":"001.003"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"001.004"},"participants":{"description":"List of call participants","items":{"$ref":"#/components/schemas/CallParticipantResponse"},"title":"[]CallParticipantResponse","type":"array","x-stream-index":"002"},"total_participants":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["call","members","own_capabilities","blocked_users","participants","total_participants","duration"],"type":"object"},"QueryCallStatsRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"004.001"},"next":{"type":"string","x-stream-index":"004.002"},"prev":{"type":"string","x-stream-index":"004.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":2,"type":"array","x-stream-index":"002"}},"type":"object"},"QueryCallStatsResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"next":{"type":"string","x-stream-index":"003.001"},"prev":{"type":"string","x-stream-index":"003.002"},"reports":{"items":{"$ref":"#/components/schemas/CallStatsReportSummaryResponse"},"type":"array","x-stream-index":"001"}},"required":["reports","duration"],"title":"Response","type":"object"},"QueryCallsRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"title":"Filters","type":"object","x-stream-index":"003"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"006.001"},"next":{"type":"string","x-stream-index":"006.002"},"prev":{"type":"string","x-stream-index":"006.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":2,"title":"Sort","type":"array","x-stream-index":"004"},"watch":{"title":"Watch","type":"boolean","x-stream-index":"001"}},"title":"QueryCallsRequest","type":"object"},"QueryCallsResponse":{"nullable":true,"properties":{"calls":{"items":{"$ref":"#/components/schemas/CallStateResponseFields"},"title":"Calls","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["calls","duration"],"title":"QueryCallsResponse","type":"object"},"QueryChannelsRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"description":"Number of channels to limit","format":"int32","title":"Limit","type":"integer","x-stream-index":"008"},"member_limit":{"description":"Number of members to limit","format":"int32","maximum":100,"minimum":0,"title":"Member limit","type":"integer","x-stream-index":"007"},"message_limit":{"description":"Number of messages to limit","format":"int32","minimum":0,"title":"Message limit","type":"integer","x-stream-index":"006"},"offset":{"description":"Channel pagination offset","format":"int32","title":"Offset","type":"integer","x-stream-index":"009"},"presence":{"title":"Presence","type":"boolean","x-stream-index":"005"},"sort":{"description":"List of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"002"},"state":{"description":"Whether to update channel state or not","title":"State","type":"boolean","x-stream-index":"004"},"watch":{"description":"Whether to start watching found channels or not","title":"Watch","type":"boolean","x-stream-index":"003"}},"title":"Query Channels Request","type":"object","x-stream-docs-page-id":"query_channels"},"QueryChannelsResponse":{"nullable":true,"properties":{"channels":{"description":"List of channels","items":{"$ref":"#/components/schemas/ChannelStateResponseFields"},"title":"Channels","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["channels","duration"],"title":"Channels list","type":"object"},"QueryDraftsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","maximum":3,"title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"002"}},"type":"object"},"QueryDraftsResponse":{"nullable":true,"properties":{"drafts":{"description":"Drafts","items":{"$ref":"#/components/schemas/DraftResponse"},"title":"DraftsResponseList","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["drafts","duration"],"type":"object"},"QueryMembersPayload":{"description":"Client request","properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"002"},"limit":{"format":"int32","maximum":300,"minimum":0,"type":"integer","x-stream-index":"006.003"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"type":"array","x-stream-index":"003"},"offset":{"format":"int32","maximum":10000,"type":"integer","x-stream-index":"006.004"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":1,"type":"array","x-stream-index":"005"},"type":{"maxLength":64,"type":"string","x-stream-index":"001"}},"required":["type","filter_conditions"],"title":"ClientRequest","type":"object"},"QueryMessageFlagsPayload":{"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":300,"minimum":0,"type":"integer","x-stream-index":"003.003"},"offset":{"format":"int32","maximum":10000,"type":"integer","x-stream-index":"003.004"},"show_deleted_messages":{"description":"Whether to include deleted messages in the results","title":"ShowDeletedMessages","type":"boolean","x-stream-index":"002"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"type":"array","x-stream-index":"003.005"}},"type":"object"},"QueryMessageFlagsResponse":{"description":"Query message flags response","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"flags":{"description":"The flags that match the query","items":{"$ref":"#/components/schemas/MessageFlagResponse"},"title":"MessageFlagResponseList","type":"array","x-stream-index":"001"}},"required":["flags","duration"],"title":"QueryMessageFlagsResponse","type":"object"},"QueryModerationConfigsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter conditions for moderation configs","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"Sorting parameters for the results","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"002"}},"type":"object"},"QueryModerationConfigsResponse":{"nullable":true,"properties":{"configs":{"description":"List of moderation configurations","items":{"$ref":"#/components/schemas/ConfigResponse"},"title":"Configs","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["configs","duration"],"type":"object"},"QueryPollVotesRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","title":"Filter","type":"object","x-stream-index":"003"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"004"}},"type":"object"},"QueryPollsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","title":"Filter","type":"object","x-stream-index":"002"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"003"}},"type":"object"},"QueryPollsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"polls":{"description":"Polls data returned by the query","items":{"$ref":"#/components/schemas/PollResponseData"},"title":"PollsResponseData","type":"array","x-stream-index":"001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["polls","duration"],"type":"object"},"QueryReactionsRequest":{"properties":{"filter":{"additionalProperties":{},"type":"object","x-stream-index":"002"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"006.001"},"next":{"type":"string","x-stream-index":"006.002"},"prev":{"type":"string","x-stream-index":"006.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":2,"type":"array","x-stream-index":"003"}},"type":"object"},"QueryReactionsResponse":{"description":"Basic response information","properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"next":{"type":"string","x-stream-index":"003.001"},"prev":{"type":"string","x-stream-index":"003.002"},"reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"001"}},"required":["reactions","duration"],"title":"Response","type":"object"},"QueryRemindersRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"002"}},"type":"object"},"QueryRemindersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"reminders":{"description":"MessageReminders data returned by the query","items":{"$ref":"#/components/schemas/ReminderResponseData"},"title":"RemindersResponseData","type":"array","x-stream-index":"001"}},"required":["reminders","duration"],"type":"object"},"QueryReviewQueueRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter conditions for review queue items","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"007.001"},"lock_count":{"description":"Number of items to lock (1-25)","format":"int32","maximum":25,"minimum":1,"title":"Lock Count","type":"integer","x-stream-index":"005"},"lock_duration":{"description":"Duration for which items should be locked","title":"Lock Duration","type":"integer","x-stream-index":"004"},"lock_items":{"description":"Whether to lock items for review (true), unlock items (false), or just fetch (nil)","title":"Lock Items","type":"boolean","x-stream-index":"003"},"next":{"type":"string","x-stream-index":"007.002"},"prev":{"type":"string","x-stream-index":"007.003"},"sort":{"description":"Sorting parameters for the results","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"002"},"stats_only":{"description":"Whether to return only statistics","title":"Stats Only","type":"boolean","x-stream-index":"006"}},"type":"object"},"QueryReviewQueueResponse":{"nullable":true,"properties":{"action_config":{"additionalProperties":{"items":{"$ref":"#/components/schemas/ModerationActionConfig"},"type":"array"},"description":"Configuration for moderation actions","title":"Action Config","type":"object","x-stream-index":"002"},"duration":{"type":"string","x-stream-index":"005.001"},"items":{"description":"List of review queue items","items":{"$ref":"#/components/schemas/ReviewQueueItemResponse"},"title":"Items","type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"004.001"},"prev":{"type":"string","x-stream-index":"004.002"},"stats":{"additionalProperties":{},"description":"Statistics about the review queue","title":"Stats","type":"object","x-stream-index":"003"}},"required":["items","action_config","stats","duration"],"type":"object"},"QueryThreadsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter conditions to apply to threads","title":"Filter","type":"object","x-stream-index":"006"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"008.001"},"member_limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005"},"next":{"type":"string","x-stream-index":"008.002"},"participant_limit":{"description":"Limit the number of participants returned per each thread","format":"int32","maximum":100,"minimum":0,"title":"Participant limit","type":"integer","x-stream-index":"004"},"prev":{"type":"string","x-stream-index":"008.003"},"reply_limit":{"description":"Limit the number of replies returned per each thread","format":"int32","maximum":10,"minimum":0,"title":"Reply limit","type":"integer","x-stream-index":"003"},"sort":{"description":"Sort conditions to apply to threads","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"007"},"watch":{"description":"Start watching the channel this thread belongs to","title":"Watch","type":"boolean","x-stream-index":"001"}},"type":"object"},"QueryThreadsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"threads":{"description":"List of enriched thread states","items":{"$ref":"#/components/schemas/ThreadStateResponse"},"title":"Threads","type":"array","x-stream-index":"001"}},"required":["threads","duration"],"type":"object"},"QueryUsersPayload":{"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"include_deactivated_users":{"type":"boolean","x-stream-index":"004"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.003"},"offset":{"format":"int32","maximum":1000,"type":"integer","x-stream-index":"005.004"},"presence":{"type":"boolean","x-stream-index":"003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"type":"array","x-stream-index":"002"}},"required":["filter_conditions"],"type":"object"},"QueryUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"users":{"description":"Array of users as result of filters applied.","items":{"$ref":"#/components/schemas/FullUserResponse"},"title":"Users","type":"array","x-stream-index":"001"}},"required":["users","duration"],"type":"object"},"RTMPBroadcastRequest":{"description":"RTMPBroadcastRequest is the payload for starting an RTMP broadcast.","properties":{"layout":{"$ref":"#/components/schemas/LayoutSettingsRequest","description":"If provided, will override the call's RTMP settings layout","title":"Layout","x-stream-index":"005"},"name":{"description":"Name identifier for RTMP broadcast, must be unique in call","maxLength":255,"title":"Name","type":"string","x-stream-index":"001"},"quality":{"description":"If provided, will override the call's RTMP settings quality","enum":["360p","480p","720p","1080p","1440p","portrait-360x640","portrait-480x854","portrait-720x1280","portrait-1080x1920","portrait-1440x2560"],"title":"Quality","type":"string","x-stream-index":"004"},"stream_key":{"description":"If provided, will be appended at the end of stream_url","title":"Stream Key","type":"string","x-stream-index":"003"},"stream_url":{"description":"URL for the RTMP server to send the call to","maxLength":255,"title":"Stream URL","type":"string","x-stream-index":"002"}},"required":["name","stream_url"],"title":"RTMPBroadcastRequest","type":"object"},"RTMPEgressConfig":{"properties":{"composite_app_settings":{"$ref":"#/components/schemas/CompositeAppSettings","x-stream-index":"005"},"quality":{"$ref":"#/components/schemas/Quality","x-stream-index":"004"},"rtmp_location":{"type":"string","x-stream-index":"006"}},"type":"object"},"RTMPIngress":{"description":"RTMP input settings","properties":{"address":{"title":"Address","type":"string","x-stream-index":"001"}},"required":["address"],"title":"RTMPIngress","type":"object"},"RTMPLocation":{"properties":{"name":{"type":"string","x-stream-index":"001"},"stream_key":{"type":"string","x-stream-index":"003"},"stream_url":{"type":"string","x-stream-index":"002"}},"required":["name","stream_url","stream_key"],"type":"object"},"RTMPSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"003"},"location":{"$ref":"#/components/schemas/RTMPLocation","x-stream-index":"004"},"quality_name":{"type":"string","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"RTMPSettingsRequest":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"quality":{"description":"Resolution to set for the RTMP stream","enum":["360p","480p","720p","1080p","1440p","portrait-360x640","portrait-480x854","portrait-720x1280","portrait-1080x1920","portrait-1440x2560"],"title":"Quality","type":"string","x-stream-index":"002"}},"title":"RTMPSettingsRequest","type":"object"},"RTMPSettingsResponse":{"description":"RTMPSettingsResponse is the payload for RTMP settings","properties":{"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"001"},"quality":{"title":"Quality","type":"string","x-stream-index":"002"}},"required":["enabled","quality","layout"],"title":"RTMPSettingsResponse","type":"object"},"Reaction":{"nullable":true,"properties":{"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"message_id":{"type":"string","x-stream-index":"003"},"score":{"format":"int32","type":"integer","x-stream-index":"007"},"type":{"maxLength":30,"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["message_id","type","score","created_at","updated_at","custom"],"type":"object"},"ReactionDeletedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"006.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"002"},"team":{"type":"string","x-stream-index":"005.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"reaction.deleted","type":"string","x-stream-index":"006.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"ReactionDeletedEvent","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"},"ReactionGroupResponse":{"description":"ReactionGroupResponse contains all information about a reaction of the same type.","nullable":true,"properties":{"count":{"description":"Count is the number of reactions of this type.","format":"int32","title":"Count","type":"integer","x-stream-index":"001"},"first_reaction_at":{"description":"FirstReactionAt is the time of the first reaction of this type. This is the same also if all reaction of this type are deleted, because if someone will react again with the same type, will be preserved the sorting.","format":"date-time","title":"FirstReactionAt","type":"number","x-stream-index":"003"},"last_reaction_at":{"description":"LastReactionAt is the time of the last reaction of this type.","format":"date-time","title":"LastReactionAt","type":"number","x-stream-index":"004"},"sum_scores":{"description":"SumScores is the sum of all scores of reactions of this type. Medium allows you to clap articles more than once and shows the sum of all claps from all users. For example, you can send `clap` x5 using `score: 5`.","format":"int32","title":"SumScores","type":"integer","x-stream-index":"002"}},"required":["count","sum_scores","first_reaction_at","last_reaction_at"],"title":"ReactionGroupResponse","type":"object"},"ReactionNewEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"006.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"002"},"team":{"type":"string","x-stream-index":"005.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"reaction.new","type":"string","x-stream-index":"006.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"ReactionNewEvent","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"},"ReactionRequest":{"description":"Represents user reaction to a message","properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"score":{"description":"Reaction score. If not specified reaction has score of 1","format":"int32","title":"Score","type":"integer","x-stream-index":"002"},"type":{"description":"The type of reaction (e.g. 'like', 'laugh', 'wow')","maxLength":30,"title":"Type","type":"string","x-stream-index":"001"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"004"}},"required":["type"],"title":"Reaction","type":"object","x-stream-docs-page-id":"send_reaction"},"ReactionResponse":{"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"006"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"008"},"message_id":{"description":"Message ID","title":"Message ID","type":"string","x-stream-index":"001"},"score":{"description":"Score of the reaction","format":"int32","title":"Score","type":"integer","x-stream-index":"005"},"type":{"description":"Type of reaction","title":"Type","type":"string","x-stream-index":"004"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"007"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User","title":"UserResponse","x-stream-index":"003"},"user_id":{"description":"User ID","title":"User ID","type":"string","x-stream-index":"002"}},"required":["message_id","user_id","user","type","score","created_at","updated_at","custom"],"type":"object"},"ReactionUpdatedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"006.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"002"},"team":{"type":"string","x-stream-index":"005.001"},"type":{"default":"reaction.updated","type":"string","x-stream-index":"006.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["message","reaction","cid","channel_id","channel_type","type","created_at"],"title":"ReactionUpdatedEvent","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"},"ReadReceipts":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"ReadReceiptsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"ReadStateResponse":{"properties":{"last_read":{"format":"date-time","type":"number","x-stream-index":"002"},"last_read_message_id":{"type":"string","x-stream-index":"004"},"unread_messages":{"format":"int32","type":"integer","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"}},"required":["user","last_read","unread_messages"],"type":"object"},"RecordSettings":{"properties":{"audio_only":{"type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"004"},"mode":{"type":"string","x-stream-index":"002"},"quality":{"type":"string","x-stream-index":"003"}},"required":["mode"],"type":"object"},"RecordSettingsRequest":{"properties":{"audio_only":{"type":"boolean","x-stream-index":"001"},"mode":{"enum":["available","disabled","auto-on"],"title":"Mode","type":"string","x-stream-index":"002"},"quality":{"enum":["360p","480p","720p","1080p","1440p","portrait-360x640","portrait-480x854","portrait-720x1280","portrait-1080x1920","portrait-1440x2560"],"type":"string","x-stream-index":"003"}},"required":["mode"],"title":"RecordSettingsRequest","type":"object"},"RecordSettingsResponse":{"description":"RecordSettings is the payload for recording settings","properties":{"audio_only":{"title":"Audio Only","type":"boolean","x-stream-index":"001"},"mode":{"title":"Mode","type":"string","x-stream-index":"002"},"quality":{"title":"Quality","type":"string","x-stream-index":"003"}},"required":["audio_only","mode","quality","layout"],"title":"RecordSettingsResponse","type":"object"},"RecordingEgressConfig":{"properties":{"audio_only":{"type":"boolean","x-stream-index":"006"},"composite_app_settings":{"$ref":"#/components/schemas/CompositeAppSettings","x-stream-index":"005"},"external_storage":{"$ref":"#/components/schemas/ExternalStorage","x-stream-index":"008"},"quality":{"$ref":"#/components/schemas/Quality","x-stream-index":"004"},"storage_name":{"type":"string","x-stream-index":"007"},"video_orientation_hint":{"$ref":"#/components/schemas/VideoOrientation","x-stream-index":"009"}},"type":"object"},"RejectCallRequest":{"nullable":true,"properties":{"reason":{"description":"Reason for rejecting the call","title":"Reason","type":"string","x-stream-index":"003"}},"title":"RejectCallRequest","type":"object"},"RejectCallResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"RejectCallResponse","type":"object"},"ReminderCreatedEvent":{"description":"Emitted when a reminder is created.","nullable":true,"properties":{"cid":{"description":"The CID of the Channel for which the reminder was created","title":"Channel CID","type":"string","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.007"},"message_id":{"description":"The ID of the message for which the reminder was created","title":"Message ID","type":"string","x-stream-index":"001.002"},"parent_id":{"description":"The ID of the parent message, if the reminder is for a thread message","title":"Parent ID","type":"string","x-stream-index":"001.005"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","description":"The reminder object which was created","title":"MessageReminder","x-stream-index":"001.006"},"type":{"default":"reminder.created","description":"The type of event: \"reminder.created\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.002"},"user_id":{"description":"The ID of the user for whom the reminder was created","title":"User ID","type":"string","x-stream-index":"001.003"}},"required":["type","created_at","custom","message_id","user_id","cid"],"title":"ReminderCreatedEvent","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"},"ReminderDeletedEvent":{"description":"Emitted when a reminder is deleted.","nullable":true,"properties":{"cid":{"description":"The CID of the Channel for which the reminder was created","title":"Channel CID","type":"string","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.007"},"message_id":{"description":"The ID of the message for which the reminder was created","title":"Message ID","type":"string","x-stream-index":"001.002"},"parent_id":{"description":"The ID of the parent message, if the reminder is for a thread message","title":"Parent ID","type":"string","x-stream-index":"001.005"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","description":"The reminder object which was created","title":"MessageReminder","x-stream-index":"001.006"},"type":{"default":"reminder.deleted","description":"The type of event: \"reminder.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.002"},"user_id":{"description":"The ID of the user for whom the reminder was created","title":"User ID","type":"string","x-stream-index":"001.003"}},"required":["type","created_at","custom","message_id","user_id","cid"],"title":"ReminderDeletedEvent","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"},"ReminderNotificationEvent":{"description":"Emitted when a reminder becomes due, triggering a notification for the user.","nullable":true,"properties":{"cid":{"description":"The CID of the Channel for which the reminder was created","title":"Channel CID","type":"string","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.007"},"message_id":{"description":"The ID of the message for which the reminder was created","title":"Message ID","type":"string","x-stream-index":"001.002"},"parent_id":{"type":"string","x-stream-index":"001.005"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","description":"The reminder object which was created","title":"MessageReminder","x-stream-index":"001.006"},"type":{"default":"notification.reminder_due","description":"The type of event: \"notification.reminder_due\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.002"},"user_id":{"description":"The ID of the user for whom the reminder was created","title":"User ID","type":"string","x-stream-index":"001.003"}},"required":["type","created_at","custom","message_id","user_id","cid"],"title":"ReminderNotificationEvent","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"},"ReminderResponseData":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003"},"channel_cid":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"005"},"message_id":{"type":"string","x-stream-index":"004"},"remind_at":{"format":"date-time","type":"number","x-stream-index":"001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007"},"user_id":{"type":"string","x-stream-index":"006"}},"required":["channel_cid","message_id","user_id","created_at","updated_at"],"type":"object"},"ReminderUpdatedEvent":{"description":"Emitted when a reminder is updated.","nullable":true,"properties":{"cid":{"description":"The CID of the Channel for which the reminder was created","title":"Channel CID","type":"string","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.007"},"message_id":{"description":"The ID of the message for which the reminder was created","title":"Message ID","type":"string","x-stream-index":"001.002"},"parent_id":{"description":"The ID of the parent message, if the reminder is for a thread message","title":"Parent ID","type":"string","x-stream-index":"001.005"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","description":"The reminder object which was created","title":"MessageReminder","x-stream-index":"001.006"},"type":{"default":"reminder.updated","description":"The type of event: \"reminder.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.002"},"user_id":{"description":"The ID of the user for whom the reminder was created","title":"User ID","type":"string","x-stream-index":"001.003"}},"required":["type","created_at","custom","message_id","user_id","cid"],"title":"ReminderUpdatedEvent","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"},"ReportByHistogramBucket":{"properties":{"category":{"type":"string","x-stream-index":"001"},"count":{"format":"int32","type":"integer","x-stream-index":"005"},"lower_bound":{"$ref":"#/components/schemas/Bound","x-stream-index":"002"},"sum":{"format":"float","type":"number","x-stream-index":"004"},"upper_bound":{"$ref":"#/components/schemas/Bound","x-stream-index":"003"}},"required":["category","sum","count"],"type":"object"},"ReportResponse":{"properties":{"call":{"$ref":"#/components/schemas/CallReportResponse","x-stream-index":"003"},"participants":{"$ref":"#/components/schemas/ParticipantReportResponse","x-stream-index":"001"},"user_ratings":{"$ref":"#/components/schemas/UserRatingReportResponse","x-stream-index":"002"}},"required":["participants","user_ratings","call"],"type":"object"},"RequestPermissionRequest":{"nullable":true,"properties":{"permissions":{"items":{"type":"string"},"title":"Permissions","type":"array","x-stream-index":"003"}},"required":["permissions"],"title":"RequestPermissionRequest","type":"object"},"RequestPermissionResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"RequestPermissionResponse","type":"object"},"Response":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001"}},"required":["duration"],"title":"Response","type":"object"},"RestoreActionRequest":{"type":"object"},"ReviewQueueItem":{"properties":{"actions":{"items":{"$ref":"#/components/schemas/ActionLog"},"type":"array","x-stream-index":"035"},"activity":{"$ref":"#/components/schemas/EnrichedActivity","x-stream-index":"028"},"ai_text_severity":{"type":"string","x-stream-index":"021"},"archived_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"043"},"assigned_to":{"$ref":"#/components/schemas/User","x-stream-index":"032"},"bans":{"items":{"$ref":"#/components/schemas/Ban"},"type":"array","x-stream-index":"033"},"bounce_count":{"format":"int32","type":"integer","x-stream-index":"025"},"call":{"$ref":"#/components/schemas/Call","x-stream-index":"031"},"completed_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"018"},"config_key":{"type":"string","x-stream-index":"009"},"content_changed":{"type":"boolean","x-stream-index":"036"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"entity_creator":{"$ref":"#/components/schemas/EntityCreator","x-stream-index":"030"},"entity_id":{"type":"string","x-stream-index":"007"},"entity_type":{"type":"string","x-stream-index":"006"},"feeds_v2_activity":{"$ref":"#/components/schemas/EnrichedActivity","x-stream-index":"041"},"feeds_v2_reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"042"},"flag_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"045"},"flag_types":{"items":{"type":"string"},"type":"array","x-stream-index":"044"},"flags":{"items":{"$ref":"#/components/schemas/Flag"},"type":"array","x-stream-index":"034"},"flags_count":{"format":"int32","type":"integer","x-stream-index":"026"},"has_image":{"type":"boolean","x-stream-index":"012"},"has_text":{"type":"boolean","x-stream-index":"014"},"has_video":{"type":"boolean","x-stream-index":"013"},"id":{"type":"string","x-stream-index":"003"},"languages":{"items":{"type":"string"},"type":"array","x-stream-index":"019"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"027"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"010"},"moderation_payload_hash":{"type":"string","x-stream-index":"011"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"029"},"recommended_action":{"type":"string","x-stream-index":"017"},"reporter_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"046"},"reviewed_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"022"},"reviewed_by":{"type":"string","x-stream-index":"023"},"severity":{"format":"int32","type":"integer","x-stream-index":"020"},"status":{"type":"string","x-stream-index":"016"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"015"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"005"}},"required":["id","created_at","updated_at","entity_type","entity_id","config_key","moderation_payload_hash","has_image","has_video","has_text","teams","status","recommended_action","completed_at","languages","severity","ai_text_severity","reviewed_at","reviewed_by","bounce_count","flags_count","bans","flags","actions","content_changed","archived_at","flag_types","flag_labels","reporter_ids"],"type":"object"},"ReviewQueueItemResponse":{"nullable":true,"properties":{"actions":{"description":"Moderation actions taken","items":{"$ref":"#/components/schemas/ActionLogResponse"},"title":"Actions","type":"array","x-stream-index":"024"},"activity":{"$ref":"#/components/schemas/EnrichedActivity","x-stream-index":"016"},"ai_text_severity":{"description":"AI-determined text severity","title":"AI Text Severity","type":"string","x-stream-index":"014"},"assigned_to":{"$ref":"#/components/schemas/UserResponse","description":"Moderator assigned to review this item","title":"Assigned To","x-stream-index":"021"},"bans":{"description":"Associated ban records","items":{"$ref":"#/components/schemas/Ban"},"title":"Bans","type":"array","x-stream-index":"022"},"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"018"},"completed_at":{"description":"When the review was completed","format":"date-time","title":"Completed At","type":"number","x-stream-index":"009"},"config_key":{"type":"string","x-stream-index":"028"},"created_at":{"description":"When the item was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"002"},"entity_creator":{"$ref":"#/components/schemas/EntityCreatorResponse","description":"Details about who created the entity","title":"Entity Creator","x-stream-index":"019"},"entity_creator_id":{"description":"ID of who created the entity","title":"Entity Creator ID","type":"string","x-stream-index":"020"},"entity_id":{"description":"ID of the entity being reviewed","title":"Entity ID","type":"string","x-stream-index":"005"},"entity_type":{"description":"Type of entity being reviewed","title":"Entity Type","type":"string","x-stream-index":"004"},"feeds_v2_activity":{"$ref":"#/components/schemas/EnrichedActivity","description":"Associated feed activity","title":"Feeds V2 Activity","x-stream-index":"025"},"feeds_v2_reaction":{"$ref":"#/components/schemas/Reaction","description":"Associated feed reaction","title":"Feeds V2 Reaction","x-stream-index":"026"},"flags":{"description":"Associated flag records","items":{"$ref":"#/components/schemas/FlagResponse"},"title":"Flags","type":"array","x-stream-index":"023"},"flags_count":{"format":"int32","type":"integer","x-stream-index":"029"},"id":{"description":"Unique identifier of the review queue item","title":"ID","type":"string","x-stream-index":"001"},"languages":{"description":"Detected languages in the content","items":{"type":"string"},"title":"Languages","type":"array","x-stream-index":"012"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Associated message details","title":"Message","x-stream-index":"015"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content being moderated","title":"Moderation Payload","x-stream-index":"006"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"017"},"recommended_action":{"description":"Suggested moderation action","title":"Recommended Action","type":"string","x-stream-index":"008"},"reviewed_at":{"description":"When the item was reviewed","format":"date-time","title":"Reviewed At","type":"number","x-stream-index":"010"},"reviewed_by":{"description":"ID of the moderator who reviewed the item","title":"Reviewed By","type":"string","x-stream-index":"011"},"severity":{"description":"Severity level of the content","format":"int32","title":"Severity","type":"integer","x-stream-index":"013"},"status":{"description":"Current status of the review","title":"Status","type":"string","x-stream-index":"007"},"teams":{"description":"Teams associated with this item","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"027"},"updated_at":{"description":"When the item was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"003"}},"required":["id","created_at","updated_at","entity_type","entity_id","status","recommended_action","reviewed_by","languages","severity","ai_text_severity","bans","flags","actions","flags_count"],"type":"object"},"RingSettings":{"properties":{"auto_cancel_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_timeout_ms","missed_call_timeout_ms"],"type":"object"},"RingSettingsRequest":{"properties":{"auto_cancel_timeout_ms":{"description":"When none of the callees accept a ring call in this time a rejection will be sent by the caller with reason 'timeout' by the SDKs","format":"int32","maximum":180000,"minimum":5000,"title":"AutoCancelTimeoutMs","type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"description":"When a callee is online but doesn't answer a ring call in this time a rejection will be sent with reason 'timeout' by the SDKs","format":"int32","maximum":180000,"minimum":5000,"title":"IncomingCallTimeoutMs","type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"description":"When a callee doesn't accept or reject a ring call in this time a missed call event will be sent","format":"int32","maximum":180000,"minimum":5000,"title":"MissedCallTimeoutMs","type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_timeout_ms"],"title":"RingSettingsRequest","type":"object"},"RingSettingsResponse":{"properties":{"auto_cancel_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_timeout_ms","missed_call_timeout_ms"],"type":"object"},"RuleBuilderAction":{"properties":{"ban_options":{"$ref":"#/components/schemas/BanOptions","x-stream-index":"002"},"flag_content_options":{"$ref":"#/components/schemas/FlagContentOptions","x-stream-index":"004"},"flag_user_options":{"$ref":"#/components/schemas/FlagUserOptions","x-stream-index":"003"},"remove_content_options":{"$ref":"#/components/schemas/BlockContentOptions","x-stream-index":"005"},"type":{"type":"string","x-stream-index":"001"}},"required":["type"],"type":"object"},"RuleBuilderCondition":{"properties":{"confidence":{"format":"float","type":"number","x-stream-index":"002"},"content_count_rule_params":{"$ref":"#/components/schemas/ContentCountRuleParameters","x-stream-index":"007"},"image_content_params":{"$ref":"#/components/schemas/ImageContentParameters","x-stream-index":"009"},"image_rule_params":{"$ref":"#/components/schemas/ImageRuleParameters","x-stream-index":"004"},"text_content_params":{"$ref":"#/components/schemas/TextContentParameters","x-stream-index":"008"},"text_rule_params":{"$ref":"#/components/schemas/TextRuleParameters","x-stream-index":"003"},"type":{"type":"string","x-stream-index":"001"},"user_created_within_params":{"$ref":"#/components/schemas/UserCreatedWithinParameters","x-stream-index":"011"},"user_rule_params":{"$ref":"#/components/schemas/UserRuleParameters","x-stream-index":"006"},"video_content_params":{"$ref":"#/components/schemas/VideoContentParameters","x-stream-index":"010"},"video_rule_params":{"$ref":"#/components/schemas/VideoRuleParameters","x-stream-index":"005"}},"required":["type"],"type":"object"},"RuleBuilderConditionGroup":{"properties":{"conditions":{"items":{"$ref":"#/components/schemas/RuleBuilderCondition"},"type":"array","x-stream-index":"002"},"logic":{"type":"string","x-stream-index":"001"}},"required":["logic","conditions"],"type":"object"},"RuleBuilderConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"rules":{"items":{"$ref":"#/components/schemas/RuleBuilderRule"},"type":"array","x-stream-index":"002"}},"required":["rules"],"type":"object"},"RuleBuilderRule":{"properties":{"action":{"$ref":"#/components/schemas/RuleBuilderAction","x-stream-index":"007"},"conditions":{"items":{"$ref":"#/components/schemas/RuleBuilderCondition"},"type":"array","x-stream-index":"004"},"cooldown_period":{"type":"string","x-stream-index":"009"},"enabled":{"type":"boolean","x-stream-index":"008"},"groups":{"items":{"$ref":"#/components/schemas/RuleBuilderConditionGroup"},"type":"array","x-stream-index":"006"},"id":{"type":"string","x-stream-index":"001"},"logic":{"type":"string","x-stream-index":"005"},"name":{"type":"string","x-stream-index":"002"},"rule_type":{"type":"string","x-stream-index":"003"}},"required":["id","name","rule_type","action","enabled"],"type":"object"},"SDKUsageReport":{"properties":{"per_sdk_usage":{"additionalProperties":{"$ref":"#/components/schemas/PerSDKUsageReport"},"type":"object","x-stream-index":"001"}},"required":["per_sdk_usage"],"type":"object"},"SDKUsageReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateSDKUsageReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"SFUIDLastSeen":{"properties":{"id":{"type":"string","x-stream-index":"001.001"},"last_seen":{"format":"date-time","type":"number","x-stream-index":"002"},"process_start_time":{"format":"int64","type":"integer","x-stream-index":"001.002"}},"required":["id","process_start_time","last_seen"],"type":"object"},"SFUResponse":{"properties":{"edge_name":{"type":"string","x-stream-index":"001"},"url":{"type":"string","x-stream-index":"002"},"ws_endpoint":{"type":"string","x-stream-index":"003"}},"required":["edge_name","url","ws_endpoint"],"type":"object"},"STTEgressConfig":{"properties":{"closed_captions_enabled":{"type":"boolean","x-stream-index":"005"},"external_storage":{"$ref":"#/components/schemas/ExternalStorage","x-stream-index":"011"},"language":{"type":"string","x-stream-index":"008"},"storage_name":{"type":"string","x-stream-index":"010"},"translation_languages":{"items":{"type":"string"},"type":"array","x-stream-index":"009"},"translations_enabled":{"type":"boolean","x-stream-index":"006"},"upload_transcriptions":{"type":"boolean","x-stream-index":"004"},"whisper_server_base_url":{"type":"string","x-stream-index":"007"}},"type":"object"},"ScreensharingSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled"],"type":"object"},"ScreensharingSettingsRequest":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"type":"object"},"ScreensharingSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled"],"type":"object"},"SearchPayload":{"properties":{"filter_conditions":{"additionalProperties":{},"description":"Channel filter conditions","maximum":100,"minimum":1,"title":"Channel filter","type":"object","x-stream-docs-page-id":"query_channels","x-stream-index":"002"},"limit":{"description":"Number of messages to return","format":"int32","title":"Limit","type":"integer","x-stream-index":"005"},"message_filter_conditions":{"additionalProperties":{},"description":"Message filter conditions","title":"Message filter","type":"object","x-stream-index":"003"},"message_options":{"$ref":"#/components/schemas/MessageOptions","x-stream-index":"004"},"next":{"description":"Pagination parameter. Cannot be used with non-zero offset.","title":"Next","type":"string","x-stream-index":"008"},"offset":{"description":"Pagination offset. Cannot be used with sort or next.","format":"int32","title":"Offset","type":"integer","x-stream-index":"006"},"query":{"description":"Search phrase","title":"Query","type":"string","x-stream-index":"001"},"sort":{"description":"Sort parameters. Cannot be used with non-zero offset","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"007"}},"required":["filter_conditions"],"type":"object"},"SearchResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"005.001"},"next":{"description":"Value to pass to the next search query in order to paginate","title":"Next","type":"string","x-stream-index":"003"},"previous":{"description":"Value that points to the previous page. Pass as the next value in a search query to paginate backwards","title":"Previous","type":"string","x-stream-index":"004"},"results":{"description":"Search results","items":{"$ref":"#/components/schemas/SearchResult"},"title":"Results","type":"array","x-stream-index":"001"},"results_warning":{"$ref":"#/components/schemas/SearchWarning","description":"Warning about the search results","title":"Results Warning","x-stream-index":"002"}},"required":["results","duration"],"type":"object"},"SearchResult":{"properties":{"message":{"$ref":"#/components/schemas/SearchResultMessage","description":"Found message","title":"Message","x-stream-index":"001"}},"type":"object"},"SearchResultMessage":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"001.008"},"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel object","title":"Channel","x-stream-index":"002"},"cid":{"type":"string","x-stream-index":"001.022"},"command":{"type":"string","x-stream-index":"001.004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.023"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.026"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.025"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"001.018"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001.041"},"html":{"type":"string","x-stream-index":"001.005"},"i18n":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.030"},"id":{"type":"string","x-stream-index":"001.001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"001.028"},"latest_reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"001.009"},"mentioned_users":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"001.029"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"001.036"},"mml":{"type":"string","x-stream-index":"001.003"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"001.039"},"own_reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"001.010"},"parent_id":{"type":"string","x-stream-index":"001.015"},"pin_expires":{"format":"date-time","type":"number","x-stream-index":"001.035"},"pinned":{"type":"boolean","x-stream-index":"001.032"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"001.033"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001.034"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001.038"},"poll_id":{"type":"string","x-stream-index":"001.037"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001.020"},"quoted_message_id":{"type":"string","x-stream-index":"001.019"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001.011"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"001.014"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001.012"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"001.042"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"001.017"},"restricted_visibility":{"items":{"type":"string"},"type":"array","x-stream-index":"001.040"},"shadowed":{"type":"boolean","x-stream-index":"001.027"},"shared_location":{"$ref":"#/components/schemas/SharedLocationResponseData","x-stream-index":"001.043"},"show_in_channel":{"type":"boolean","x-stream-index":"001.016"},"silent":{"type":"boolean","x-stream-index":"001.031"},"text":{"type":"string","x-stream-index":"001.002"},"thread_participants":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"001.021"},"type":{"type":"string","x-stream-index":"001.006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.024"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001.007"}},"required":["id","text","html","type","user","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned","restricted_visibility"],"type":"object"},"SearchWarning":{"properties":{"channel_search_cids":{"description":"Channel CIDs for the searched channels","items":{"type":"string"},"title":"Channel Search CIDs","type":"array","x-stream-index":"004"},"channel_search_count":{"description":"Number of channels searched","format":"int32","title":"Channel Search Count","type":"integer","x-stream-index":"003"},"warning_code":{"description":"Code corresponding to the warning","format":"int32","title":"Warning Code","type":"integer","x-stream-index":"002"},"warning_description":{"description":"Description of the warning","title":"Warning Description","type":"string","x-stream-index":"001"}},"required":["warning_description","warning_code"],"type":"object"},"SendCallEventRequest":{"description":"Send a call event to the other user","nullable":true,"properties":{"custom":{"additionalProperties":{},"title":"Custom","type":"object","x-stream-index":"004"}},"title":"SendCallEventRequest","type":"object"},"SendCallEventResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"SendCallEventResponse","type":"object"},"SendEventRequest":{"nullable":true,"properties":{"event":{"$ref":"#/components/schemas/EventRequest","x-stream-index":"001"}},"required":["event"],"type":"object"},"SendMessageRequest":{"nullable":true,"properties":{"keep_channel_hidden":{"type":"boolean","x-stream-index":"008"},"message":{"$ref":"#/components/schemas/MessageRequest","x-stream-index":"001"},"skip_enrich_url":{"type":"boolean","x-stream-index":"003"},"skip_push":{"type":"boolean","x-stream-index":"002"}},"required":["message"],"type":"object"},"SendMessageResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Message response","title":"Message","x-stream-index":"001"},"pending_message_metadata":{"additionalProperties":{"type":"string"},"description":"Pending message metadata","title":"Pending message metadata","type":"object","x-stream-index":"002"}},"required":["message","duration"],"type":"object"},"SendReactionRequest":{"nullable":true,"properties":{"enforce_unique":{"description":"Whether to replace all existing user reactions","title":"Enforce unique","type":"boolean","x-stream-index":"003"},"reaction":{"$ref":"#/components/schemas/ReactionRequest","x-stream-index":"002"},"skip_push":{"description":"Skips any mobile push notifications","title":"Skip push","type":"boolean","x-stream-index":"004"}},"required":["reaction"],"type":"object"},"SendReactionResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001"},"reaction":{"$ref":"#/components/schemas/ReactionResponse","x-stream-index":"002"}},"required":["message","reaction","duration"],"title":"Response","type":"object"},"SessionSettings":{"properties":{"inactivity_timeout_seconds":{"format":"int32","maximum":900,"minimum":5,"type":"integer","x-stream-index":"001"}},"required":["inactivity_timeout_seconds"],"type":"object"},"SessionSettingsRequest":{"properties":{"inactivity_timeout_seconds":{"format":"int32","maximum":900,"minimum":5,"type":"integer","x-stream-index":"001"}},"required":["inactivity_timeout_seconds"],"type":"object"},"SessionSettingsResponse":{"properties":{"inactivity_timeout_seconds":{"format":"int32","maximum":900,"minimum":5,"type":"integer","x-stream-index":"001"}},"required":["inactivity_timeout_seconds"],"type":"object"},"ShadowBlockActionRequest":{"type":"object"},"SharedLocation":{"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"013"},"channel_cid":{"type":"string","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"010"},"created_by_device_id":{"type":"string","x-stream-index":"008"},"end_at":{"format":"date-time","type":"number","x-stream-index":"009"},"latitude":{"format":"float","maximum":90,"minimum":18446744073709552000,"type":"number","x-stream-index":"006"},"longitude":{"format":"float","maximum":180,"minimum":18446744073709552000,"type":"number","x-stream-index":"007"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"012"},"message_id":{"type":"string","x-stream-index":"004"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"011"},"user_id":{"type":"string","x-stream-index":"005"}},"required":["channel_cid","message_id","user_id","created_by_device_id","created_at","updated_at"],"type":"object"},"SharedLocationResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001.011"},"channel_cid":{"description":"Channel CID","title":"string","type":"string","x-stream-index":"001.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.008"},"created_by_device_id":{"description":"Device ID that created the live location","title":"string","type":"string","x-stream-index":"001.006"},"duration":{"type":"string","x-stream-index":"002.001"},"end_at":{"description":"Time when the live location expires","format":"date-time","title":"string","type":"number","x-stream-index":"001.007"},"latitude":{"description":"Latitude coordinate","format":"float","title":"number","type":"number","x-stream-index":"001.004"},"longitude":{"description":"Longitude coordinate","format":"float","title":"number","type":"number","x-stream-index":"001.005"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001.010"},"message_id":{"description":"Message ID","title":"string","type":"string","x-stream-index":"001.002"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.009"},"user_id":{"description":"User ID","title":"string","type":"string","x-stream-index":"001.003"}},"required":["channel_cid","message_id","user_id","latitude","longitude","created_by_device_id","created_at","updated_at","duration"],"type":"object"},"SharedLocationResponseData":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"011"},"channel_cid":{"type":"string","x-stream-index":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"created_by_device_id":{"type":"string","x-stream-index":"006"},"end_at":{"format":"date-time","type":"number","x-stream-index":"007"},"latitude":{"format":"float","type":"number","x-stream-index":"004"},"longitude":{"format":"float","type":"number","x-stream-index":"005"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"010"},"message_id":{"type":"string","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["channel_cid","message_id","user_id","latitude","longitude","created_by_device_id","created_at","updated_at"],"type":"object"},"SharedLocationsResponse":{"nullable":true,"properties":{"active_live_locations":{"items":{"$ref":"#/components/schemas/SharedLocationResponseData"},"type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["active_live_locations","duration"],"type":"object"},"ShowChannelRequest":{"nullable":true,"type":"object"},"ShowChannelResponse":{"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"},"SortParamRequest":{"nullable":true,"properties":{"direction":{"description":"Direction of sorting, 1 for Ascending, -1 for Descending, default is 1","format":"int32","title":"Direction","type":"integer","x-stream-index":"002"},"field":{"description":"Name of field to sort by","title":"Field","type":"string","x-stream-index":"001"}},"type":"object"},"StartClosedCaptionsRequest":{"nullable":true,"properties":{"enable_transcription":{"description":"Enable transcriptions along with closed captions","title":"Enable Transcription","type":"boolean","x-stream-index":"002"},"external_storage":{"description":"Which external storage to use for transcriptions (only applicable if enable_transcription is true)","title":"External Storage","type":"string","x-stream-index":"003"},"language":{"description":"The spoken language in the call, if not provided the language defined in the transcription settings will be used","enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"title":"Language","type":"string","x-stream-index":"004"}},"type":"object"},"StartClosedCaptionsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"StartFrameRecordingRequest":{"nullable":true,"properties":{"recording_external_storage":{"type":"string","x-stream-index":"002"}},"title":"StartFrameRecordingRequest","type":"object"},"StartFrameRecordingResponse":{"description":"StartFrameRecordingResponse is the response payload for the start frame recording endpoint.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StartFrameRecordingResponse","type":"object"},"StartHLSBroadcastingRequest":{"description":"StartHLSBroadcastingRequest is the payload for starting an HLS broadcasting.","nullable":true,"title":"StartHLSBroadcastingRequest","type":"object"},"StartHLSBroadcastingResponse":{"description":"StartHLSBroadcastingResponse is the payload for starting an HLS broadcasting.","nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"},"playlist_url":{"description":"the URL of the HLS playlist","title":"PlaylistURL","type":"string","x-stream-index":"002"}},"required":["duration","playlist_url"],"title":"StartHLSBroadcastingResponse","type":"object"},"StartRTMPBroadcastsRequest":{"description":"StartRTMPBroadcastsRequest is the payload for starting RTMP broadcasts.","nullable":true,"properties":{"broadcasts":{"description":"List of broadcasts to start","items":{"$ref":"#/components/schemas/RTMPBroadcastRequest"},"maximum":1,"minimum":1,"title":"Broadcasts","type":"array","x-stream-index":"002"}},"required":["broadcasts"],"title":"StartRTMPBroadcastsRequest","type":"object"},"StartRTMPBroadcastsResponse":{"description":"StartRTMPBroadcastsResponse is the payload for starting an RTMP broadcast.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StartRTMPBroadcastsResponse","type":"object"},"StartRecordingRequest":{"nullable":true,"properties":{"recording_external_storage":{"type":"string","x-stream-index":"002"}},"title":"StartRecordingRequest","type":"object"},"StartRecordingResponse":{"description":"StartRecordingResponse is the response payload for the start recording endpoint.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StartRecordingResponse","type":"object"},"StartTranscriptionRequest":{"nullable":true,"properties":{"enable_closed_captions":{"description":"Enable closed captions along with transcriptions","title":"Enable Closed Captions","type":"boolean","x-stream-index":"003"},"language":{"description":"The spoken language in the call, if not provided the language defined in the transcription settings will be used","enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"title":"Language","type":"string","x-stream-index":"004"},"transcription_external_storage":{"description":"Store transcriptions in this external storage","title":"External Storage","type":"string","x-stream-index":"002"}},"type":"object"},"StartTranscriptionResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StartTranscriptionResponse","type":"object"},"StatsOptions":{"properties":{"enable_rtc_stats":{"type":"boolean","x-stream-index":"002"},"reporting_interval_ms":{"format":"int32","type":"integer","x-stream-index":"001"}},"required":["reporting_interval_ms","enable_rtc_stats"],"type":"object"},"StopAllRTMPBroadcastsRequest":{"nullable":true,"title":"StopAllRTMPBroadcastsRequest","type":"object"},"StopAllRTMPBroadcastsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StopAllRTMPBroadcastsResponse","type":"object"},"StopClosedCaptionsRequest":{"nullable":true,"properties":{"stop_transcription":{"type":"boolean","x-stream-index":"003"}},"type":"object"},"StopClosedCaptionsResponse":{"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"},"StopFrameRecordingRequest":{"nullable":true,"type":"object"},"StopFrameRecordingResponse":{"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"},"StopHLSBroadcastingRequest":{"nullable":true,"type":"object"},"StopHLSBroadcastingResponse":{"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"},"StopLiveRequest":{"nullable":true,"properties":{"continue_closed_caption":{"type":"boolean","x-stream-index":"006"},"continue_hls":{"type":"boolean","x-stream-index":"003"},"continue_recording":{"type":"boolean","x-stream-index":"004"},"continue_rtmp_broadcasts":{"type":"boolean","x-stream-index":"007"},"continue_transcription":{"type":"boolean","x-stream-index":"005"}},"title":"StopLiveRequest","type":"object"},"StopLiveResponse":{"nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"The call that was stopped","title":"Call","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["call","duration"],"title":"StopLiveResponse","type":"object"},"StopRTMPBroadcastsRequest":{"description":"Request for stopping RTMP broadcasts","nullable":true,"title":"StopRTMPBroadcastsRequest","type":"object"},"StopRTMPBroadcastsResponse":{"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"},"StopRecordingRequest":{"nullable":true,"type":"object"},"StopRecordingResponse":{"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"},"StopTranscriptionRequest":{"nullable":true,"properties":{"stop_closed_captions":{"type":"boolean","x-stream-index":"003"}},"type":"object"},"StopTranscriptionResponse":{"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"},"SubmitActionRequest":{"nullable":true,"properties":{"action_type":{"description":"Type of moderation action to perform (mark_reviewed, delete_message, etc.)","enum":["mark_reviewed","delete_message","delete_activity","delete_reaction","ban","custom","unban","restore","delete_user","unblock","shadow_block","unmask","kick_user","end_call"],"title":"Action Type","type":"string","x-stream-index":"002"},"ban":{"$ref":"#/components/schemas/BanActionRequest","description":"Configuration for ban action","title":"Ban","x-stream-index":"008"},"custom":{"$ref":"#/components/schemas/CustomActionRequest","description":"Configuration for custom action","title":"Custom","x-stream-index":"009"},"delete_activity":{"$ref":"#/components/schemas/DeleteActivityRequest","description":"Configuration for activity deletion action","title":"Delete Activity","x-stream-index":"004"},"delete_message":{"$ref":"#/components/schemas/DeleteMessageRequest","description":"Configuration for message deletion action","title":"Delete Message","x-stream-index":"003"},"delete_reaction":{"$ref":"#/components/schemas/DeleteReactionRequest","description":"Configuration for reaction deletion action","title":"Delete Reaction","x-stream-index":"005"},"delete_user":{"$ref":"#/components/schemas/DeleteUserRequest","description":"Configuration for user deletion action","title":"Delete User","x-stream-index":"006"},"item_id":{"description":"UUID of the review queue item to act on","title":"Item ID","type":"string","x-stream-index":"001"},"mark_reviewed":{"$ref":"#/components/schemas/MarkReviewedRequest","description":"Configuration for marking item as reviewed","title":"Mark Reviewed","x-stream-index":"007"},"unban":{"$ref":"#/components/schemas/UnbanActionRequest","description":"Configuration for unban action","title":"Unban","x-stream-index":"010"}},"required":["item_id","action_type"],"type":"object"},"SubmitActionResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"Updated review queue item after action was performed","title":"Item","x-stream-index":"001"}},"required":["duration"],"type":"object"},"SubscriberStatsResponse":{"properties":{"total":{"format":"int32","type":"integer","x-stream-index":"001"},"total_subscribed_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"003"},"unique":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["total","unique","total_subscribed_duration_seconds"],"type":"object"},"SyncRequest":{"description":"Sync request","nullable":true,"properties":{"channel_cids":{"description":"List of channel CIDs to sync","items":{"type":"string"},"maximum":255,"minimum":1,"title":"Channel CIDs","type":"array","x-stream-index":"001"},"last_sync_at":{"description":"Date from which synchronization should happen","format":"date-time","title":"Last sync at","type":"number","x-stream-index":"002"}},"required":["channel_cids","last_sync_at"],"title":"SyncRequest","type":"object"},"SyncResponse":{"description":"Sync response","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"events":{"description":"List of events","items":{"$ref":"#/components/schemas/WSEvent"},"title":"Events","type":"array","x-stream-index":"001"},"inaccessible_cids":{"description":"List of CIDs that user can't access","items":{"type":"string"},"title":"Inaccessible CIDs","type":"array","x-stream-index":"002"}},"required":["events","duration"],"title":"SyncResponse","type":"object"},"TargetResolution":{"properties":{"bitrate":{"format":"int32","maximum":6000000,"type":"integer","x-stream-index":"003"},"height":{"format":"int32","maximum":3840,"minimum":240,"type":"integer","x-stream-index":"002"},"width":{"format":"int32","maximum":3840,"minimum":240,"type":"integer","x-stream-index":"001"}},"required":["width","height"],"type":"object"},"TextContentParameters":{"properties":{"blocklist_match":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"contains_url":{"type":"boolean","x-stream-index":"002"},"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001"},"severity":{"type":"string","x-stream-index":"003"}},"type":"object"},"TextRuleParameters":{"properties":{"blocklist_match":{"items":{"type":"string"},"type":"array","x-stream-index":"006"},"contains_url":{"type":"boolean","x-stream-index":"004"},"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"severity":{"type":"string","x-stream-index":"005"},"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"required":["threshold","time_window"],"type":"object"},"ThreadParticipant":{"description":"Represents a user that is participating in a thread.","nullable":true,"properties":{"app_pk":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"001"},"channel_cid":{"type":"string","x-stream-index":"002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"007"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"last_read_at":{"format":"date-time","type":"number","x-stream-index":"009"},"last_thread_message_at":{"format":"date-time","type":"number","x-stream-index":"003"},"left_thread_at":{"description":"Left Thread At is the time when the user left the thread","format":"date-time","title":"Left Thread At","type":"number","x-stream-index":"008"},"thread_id":{"description":"Thead ID is unique string identifier of the thread","title":"ID","type":"string","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User is the user object","title":"User","x-stream-index":"006"},"user_id":{"description":"User ID is unique string identifier of the user","title":"User ID","type":"string","x-stream-index":"005"}},"required":["app_pk","channel_cid","created_at","last_read_at","custom"],"title":"ThreadParticipant","type":"object"},"ThreadResponse":{"properties":{"active_participant_count":{"description":"Active Participant Count","format":"int32","title":"Active Participant Count","type":"integer","x-stream-index":"009"},"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel","title":"ChannelResponse","x-stream-index":"002"},"channel_cid":{"description":"Channel CID","title":"Channel CID","type":"string","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"012"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"Created By User","title":"User","x-stream-index":"006"},"created_by_user_id":{"description":"Created By User ID","title":"Created By User ID","type":"string","x-stream-index":"005"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"016"},"deleted_at":{"description":"Deleted At","format":"date-time","title":"Deleted At","type":"number","x-stream-index":"014"},"last_message_at":{"description":"Last Message At","format":"date-time","title":"Last Message At","type":"number","x-stream-index":"011"},"parent_message":{"$ref":"#/components/schemas/MessageResponse","description":"Parent Message","title":"Message","x-stream-index":"004"},"parent_message_id":{"description":"Parent Message ID","title":"Parent Message ID","type":"string","x-stream-index":"003"},"participant_count":{"description":"Participant Count","format":"int32","title":"Participant Count","type":"integer","x-stream-index":"008"},"reply_count":{"description":"Reply Count","format":"int32","title":"Reply Count","type":"integer","x-stream-index":"007"},"thread_participants":{"description":"Thread Participants","items":{"$ref":"#/components/schemas/ThreadParticipant"},"title":"ThreadParticipants","type":"array","x-stream-index":"010"},"title":{"description":"Title","title":"Title","type":"string","x-stream-index":"015"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"013"}},"required":["channel_cid","parent_message_id","created_by_user_id","created_at","updated_at","title","custom"],"type":"object"},"ThreadStateResponse":{"nullable":true,"properties":{"active_participant_count":{"description":"Active Participant Count","format":"int32","title":"Active Participant Count","type":"integer","x-stream-index":"001.009"},"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel","title":"ChannelResponse","x-stream-index":"001.002"},"channel_cid":{"description":"Channel CID","title":"Channel CID","type":"string","x-stream-index":"001.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.012"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"Created By User","title":"User","x-stream-index":"001.006"},"created_by_user_id":{"description":"Created By User ID","title":"Created By User ID","type":"string","x-stream-index":"001.005"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"001.016"},"deleted_at":{"description":"Deleted At","format":"date-time","title":"Deleted At","type":"number","x-stream-index":"001.014"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"004"},"last_message_at":{"description":"Last Message At","format":"date-time","title":"Last Message At","type":"number","x-stream-index":"001.011"},"latest_replies":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","x-stream-index":"002"},"parent_message":{"$ref":"#/components/schemas/MessageResponse","description":"Parent Message","title":"Message","x-stream-index":"001.004"},"parent_message_id":{"description":"Parent Message ID","title":"Parent Message ID","type":"string","x-stream-index":"001.003"},"participant_count":{"description":"Participant Count","format":"int32","title":"Participant Count","type":"integer","x-stream-index":"001.008"},"read":{"items":{"$ref":"#/components/schemas/ReadStateResponse"},"type":"array","x-stream-index":"003"},"reply_count":{"description":"Reply Count","format":"int32","title":"Reply Count","type":"integer","x-stream-index":"001.007"},"thread_participants":{"description":"Thread Participants","items":{"$ref":"#/components/schemas/ThreadParticipant"},"title":"ThreadParticipants","type":"array","x-stream-index":"001.010"},"title":{"description":"Title","title":"Title","type":"string","x-stream-index":"001.015"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.013"}},"required":["channel_cid","parent_message_id","created_by_user_id","created_at","updated_at","title","custom","latest_replies"],"type":"object"},"ThreadUpdatedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"001.002"},"channel_type":{"type":"string","x-stream-index":"001.003"},"cid":{"type":"string","x-stream-index":"001.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"thread":{"$ref":"#/components/schemas/ThreadResponse","x-stream-index":"003.001"},"type":{"default":"thread.updated","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"ThreadUpdatedEvent","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"},"Thresholds":{"description":"Sets thresholds for AI moderation","properties":{"explicit":{"$ref":"#/components/schemas/LabelThresholds","description":"Thresholds for explicit messages","title":"LabelThresholds","x-stream-index":"001"},"spam":{"$ref":"#/components/schemas/LabelThresholds","description":"Thresholds for spam","title":"LabelThresholds","x-stream-index":"002"},"toxic":{"$ref":"#/components/schemas/LabelThresholds","description":"Thresholds for toxic messages","title":"LabelThresholds","x-stream-index":"003"}},"title":"Auto moderation thresholds","type":"object"},"ThumbnailResponse":{"properties":{"image_url":{"type":"string","x-stream-index":"001"}},"required":["image_url"],"type":"object"},"ThumbnailsSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"ThumbnailsSettingsRequest":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"ThumbnailsSettingsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"Time":{"type":"object"},"TrackStatsResponse":{"nullable":true,"properties":{"duration_seconds":{"format":"int32","type":"integer","x-stream-index":"002"},"track_type":{"type":"string","x-stream-index":"001"}},"required":["track_type","duration_seconds"],"type":"object"},"TranscriptionSettings":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"title":"Mode","type":"string","x-stream-index":"002"},"language":{"description":"The language used in this call as a two letter code","enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"title":"Language","type":"string","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"title":"Mode","type":"string","x-stream-index":"001"}},"required":["mode","closed_caption_mode","languages","language"],"type":"object"},"TranscriptionSettingsRequest":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"002"},"language":{"enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"type":"string","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode"],"type":"object"},"TranscriptionSettingsResponse":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"002"},"language":{"enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"type":"string","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode","closed_caption_mode","languages","language"],"type":"object"},"TranslateMessageRequest":{"nullable":true,"properties":{"language":{"description":"Language to translate message to","enum":["af","sq","am","ar","az","bn","bs","bg","zh","zh-TW","hr","cs","da","fa-AF","nl","en","et","fi","fr","fr-CA","ka","de","el","ha","he","hi","hu","id","it","ja","ko","lv","ms","no","fa","ps","pl","pt","ro","ru","sr","sk","sl","so","es","es-MX","sw","sv","tl","ta","th","tr","uk","ur","vi","lt","ht"],"title":"Language","type":"string","x-stream-index":"001"}},"required":["language"],"type":"object"},"TruncateChannelRequest":{"nullable":true,"properties":{"hard_delete":{"description":"Permanently delete channel data (messages, reactions, etc.)","title":"Hard delete","type":"boolean","x-stream-index":"002"},"member_ids":{"description":"List of member IDs to hide message history for. If empty, truncates the channel for all members","items":{"type":"string"},"maximum":100,"title":"Member IDs","type":"array","x-stream-index":"007"},"message":{"$ref":"#/components/schemas/MessageRequest","x-stream-index":"004"},"skip_push":{"description":"When `message` is set disables all push notifications for it","title":"Skip push","type":"boolean","x-stream-index":"005"},"truncated_at":{"description":"Truncate channel data up to `truncated_at`. The system message (if provided) creation time is always greater than `truncated_at`","format":"date-time","title":"Truncated at","type":"number","x-stream-index":"006"}},"type":"object"},"TruncateChannelResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Truncated channel object","title":"Channel","x-stream-index":"002"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Truncated message object","title":"Message","x-stream-index":"003"}},"required":["duration"],"type":"object"},"TypingIndicators":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"TypingIndicatorsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"TypingStartEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"parent_id":{"type":"string","x-stream-index":"001"},"type":{"default":"typing.start","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"TypingStartEvent","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"},"TypingStopEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"parent_id":{"type":"string","x-stream-index":"001"},"type":{"default":"typing.stop","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"TypingStopEvent","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"},"UnbanActionRequest":{"type":"object"},"UnblockActionRequest":{"type":"object"},"UnblockUserRequest":{"description":"UnblockUserRequest is the payload for unblocking a user.","nullable":true,"properties":{"user_id":{"description":"the user to unblock","title":"UserID","type":"string","x-stream-index":"003"}},"required":["user_id"],"title":"UnblockUserRequest","type":"object"},"UnblockUserResponse":{"description":"UnblockUserResponse is the payload for unblocking a user.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"UnblockUserResponse","type":"object"},"UnblockUsersRequest":{"nullable":true,"properties":{"blocked_user_id":{"type":"string","x-stream-index":"001"}},"required":["blocked_user_id"],"type":"object"},"UnblockUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"UnblockedUserEvent":{"description":"This event is sent when a user is unblocked on a call,\nthis can be useful to notify the user that they can now join the call again","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.unblocked_user","description":"The type of event: \"call.unblocked_user\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user that was unblocked","title":"User","x-stream-index":"003"}},"required":["type","created_at","call_cid","user"],"title":"UnblockedUserEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"UnmuteChannelRequest":{"nullable":true,"properties":{"channel_cids":{"description":"Channel CIDs to mute (if multiple channels)","items":{"type":"string"},"maximum":25,"title":"Channel CIDs","type":"array","x-stream-index":"001.002"},"expiration":{"description":"Duration of mute in milliseconds","title":"Expiration","type":"integer","x-stream-index":"001.003"}},"type":"object"},"UnmuteResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"non_existing_users":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"required":["duration"],"title":"Response","type":"object"},"UnpinRequest":{"description":"UnpinRequest is the payload for unpinning a message.","nullable":true,"properties":{"session_id":{"description":"the session ID of the user who pinned the message","title":"SessionID","type":"string","x-stream-index":"003"},"user_id":{"description":"the user ID of the user who pinned the message","title":"UserID","type":"string","x-stream-index":"002"}},"required":["user_id","session_id"],"title":"UnpinRequest","type":"object"},"UnpinResponse":{"description":"UnpinResponse is the payload for unpinning a message.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"UnpinResponse","type":"object"},"UnreadCountsChannel":{"properties":{"channel_id":{"type":"string","x-stream-index":"001"},"last_read":{"format":"date-time","type":"number","x-stream-index":"003"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["channel_id","unread_count","last_read"],"type":"object"},"UnreadCountsChannelType":{"properties":{"channel_count":{"format":"int32","type":"integer","x-stream-index":"002"},"channel_type":{"type":"string","x-stream-index":"001"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["channel_type","channel_count","unread_count"],"type":"object"},"UnreadCountsThread":{"properties":{"last_read":{"format":"date-time","type":"number","x-stream-index":"002"},"last_read_message_id":{"type":"string","x-stream-index":"003"},"parent_message_id":{"type":"string","x-stream-index":"004"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"001"}},"required":["unread_count","last_read","last_read_message_id","parent_message_id"],"type":"object"},"UpdateBlockListRequest":{"nullable":true,"properties":{"team":{"type":"string","x-stream-index":"002"},"words":{"description":"List of words to block","items":{"type":"string"},"minimum":1,"title":"Words","type":"array","x-stream-index":"003"}},"title":"Update block list","type":"object","x-stream-docs-page-id":"update_block_list"},"UpdateBlockListResponse":{"description":"Basic response information","nullable":true,"properties":{"blocklist":{"$ref":"#/components/schemas/BlockListResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["duration"],"title":"Response","type":"object"},"UpdateCallMembersRequest":{"description":"Update call members","nullable":true,"properties":{"remove_members":{"description":"List of userID to remove","items":{"type":"string"},"maximum":100,"title":"Remove Members","type":"array","x-stream-index":"003"},"update_members":{"description":"List of members to update or insert","items":{"$ref":"#/components/schemas/MemberRequest"},"maximum":100,"title":"Update Members","type":"array","x-stream-index":"004"}},"title":"UpdateCallMembersRequest","type":"object"},"UpdateCallMembersResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"002"}},"required":["duration","members"],"title":"Response","type":"object"},"UpdateCallRequest":{"description":"Request for updating a call","nullable":true,"properties":{"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"003"},"settings_override":{"$ref":"#/components/schemas/CallSettingsRequest","description":"the settings to change for this call","title":"Settings Override","x-stream-index":"004"},"starts_at":{"description":"the time the call is scheduled to start","format":"date-time","title":"Starts At","type":"number","x-stream-index":"005"}},"title":"UpdateCallRequest","type":"object"},"UpdateCallResponse":{"description":"Response for updating a call","nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001.001"},"duration":{"type":"string","x-stream-index":"002.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001.002"},"membership":{"$ref":"#/components/schemas/MemberResponse","x-stream-index":"001.003"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"001.004"}},"required":["call","members","own_capabilities","blocked_users","duration"],"title":"UpdateCallResponse","type":"object"},"UpdateChannelPartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"type":"object","x-stream-index":"002.001"},"unset":{"items":{"type":"string"},"type":"array","x-stream-index":"002.002"}},"title":"UpdateChannelPartialRequest","type":"object"},"UpdateChannelPartialResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Updated channel object","title":"Channel","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"members":{"description":"List of updated members","items":{"$ref":"#/components/schemas/ChannelMemberResponse"},"title":"ChannelMemberResponse","type":"array","x-stream-index":"002"}},"required":["members","duration"],"type":"object"},"UpdateChannelRequest":{"nullable":true,"properties":{"accept_invite":{"description":"Set to `true` to accept the invite","title":"Accept invite","type":"boolean","x-stream-index":"008"},"add_members":{"description":"List of user IDs to add to the channel","items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"title":"Add members","type":"array","x-stream-index":"001"},"add_moderators":{"description":"List of user IDs to make channel moderators","items":{"type":"string"},"maximum":100,"title":"Add moderators","type":"array","x-stream-index":"003"},"assign_roles":{"description":"List of channel member role assignments. If any specified user is not part of the channel, the request will fail","items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"title":"Assign roles","type":"array","x-stream-index":"006"},"cooldown":{"description":"Sets cool down period for the channel in seconds","format":"int32","maximum":120,"minimum":0,"title":"Cool down","type":"integer","x-stream-index":"007"},"data":{"$ref":"#/components/schemas/ChannelInput","x-stream-index":"013.001"},"demote_moderators":{"description":"List of user IDs to take away moderators status from","items":{"type":"string"},"maximum":100,"title":"Demote moderators","type":"array","x-stream-index":"004"},"hide_history":{"description":"Set to `true` to hide channel's history when adding new members","title":"Hide history","type":"boolean","x-stream-index":"012"},"invites":{"description":"List of user IDs to invite to the channel","items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"title":"Invites","type":"array","x-stream-index":"005"},"message":{"$ref":"#/components/schemas/MessageRequest","description":"Message to send to the chat when channel is successfully updated","title":"Message","x-stream-index":"010"},"reject_invite":{"description":"Set to `true` to reject the invite","title":"Reject invite","type":"boolean","x-stream-index":"009"},"remove_members":{"description":"List of user IDs to remove from the channel","items":{"type":"string"},"maximum":100,"title":"Remove members","type":"array","x-stream-index":"002"},"skip_push":{"description":"When `message` is set disables all push notifications for it","title":"Skip push","type":"boolean","x-stream-index":"011"}},"title":"Channel update request","type":"object","x-stream-docs-page-id":"channel_update"},"UpdateChannelResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Updated channel","title":"Channel","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"004.001"},"members":{"description":"List of channel members","items":{"$ref":"#/components/schemas/ChannelMember"},"title":"Members","type":"array","x-stream-index":"003"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Message sent to the chat","title":"Message","x-stream-index":"002"}},"required":["members","duration"],"type":"object"},"UpdateLiveLocationRequest":{"nullable":true,"properties":{"end_at":{"description":"Time when the live location expires","format":"date-time","title":"string","type":"number","x-stream-index":"004"},"latitude":{"description":"Latitude coordinate","format":"float","maximum":90,"minimum":18446744073709552000,"title":"number","type":"number","x-stream-index":"002"},"longitude":{"description":"Longitude coordinate","format":"float","maximum":180,"minimum":18446744073709552000,"title":"number","type":"number","x-stream-index":"003"},"message_id":{"description":"Live location ID","title":"string","type":"string","x-stream-index":"001"}},"required":["message_id"],"type":"object"},"UpdateMemberPartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"type":"object","x-stream-index":"002.001"},"unset":{"items":{"type":"string"},"type":"array","x-stream-index":"002.002"}},"type":"object"},"UpdateMemberPartialResponse":{"nullable":true,"properties":{"channel_member":{"$ref":"#/components/schemas/ChannelMemberResponse","description":"Updated channel member","title":"Channel member","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["duration"],"type":"object"},"UpdateMessagePartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"description":"Sets new field values","title":"Set","type":"object","x-stream-index":"002.001","x-stream-map":{"key":"field","title":"Value","description":"New value to set"}},"skip_enrich_url":{"description":"Skip enriching the URL in the message","title":"SkipEnrichURL","type":"boolean","x-stream-index":"001"},"unset":{"description":"Array of field names to unset","items":{"type":"string"},"title":"Unset","type":"array","x-stream-index":"002.002"}},"type":"object"},"UpdateMessagePartialResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Updated message","title":"Message","x-stream-index":"001"},"pending_message_metadata":{"additionalProperties":{"type":"string"},"description":"Pending message metadata","title":"PendingMessageMetadata","type":"object","x-stream-index":"002"}},"required":["duration"],"type":"object"},"UpdateMessageRequest":{"nullable":true,"properties":{"message":{"$ref":"#/components/schemas/MessageRequest","description":"Message","title":"MessageRequest","x-stream-index":"001"},"skip_enrich_url":{"description":"Skip enrich URL","title":"boolean","type":"boolean","x-stream-index":"003"},"skip_push":{"type":"boolean","x-stream-index":"002"}},"required":["message"],"type":"object"},"UpdateMessageResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001"},"pending_message_metadata":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"002"}},"required":["message","duration"],"title":"Response","type":"object"},"UpdatePollOptionRequest":{"nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"004"},"id":{"description":"Option ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"},"text":{"description":"Option text","title":"string","type":"string","x-stream-index":"003"}},"required":["id","text"],"type":"object"},"UpdatePollPartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"description":"Sets new field values","title":"Set","type":"object","x-stream-index":"002.001","x-stream-map":{"key":"field","title":"Value","description":"New value to set"}},"unset":{"description":"Array of field names to unset","items":{"type":"string"},"title":"Unset","type":"array","x-stream-index":"002.002"}},"type":"object"},"UpdatePollRequest":{"nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"011"},"allow_answers":{"description":"Allow answers","title":"boolean","type":"boolean","x-stream-index":"009"},"allow_user_suggested_options":{"description":"Allow user suggested options","title":"boolean","type":"boolean","x-stream-index":"008"},"description":{"description":"Poll description","title":"string","type":"string","x-stream-index":"003"},"enforce_unique_vote":{"description":"Enforce unique vote","title":"boolean","type":"boolean","x-stream-index":"005"},"id":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"},"is_closed":{"description":"Is closed","title":"boolean","type":"boolean","x-stream-index":"010"},"max_votes_allowed":{"description":"Max votes allowed","format":"int32","maximum":10,"title":"integer","type":"integer","x-stream-index":"007"},"name":{"description":"Poll name","title":"string","type":"string","x-stream-index":"002"},"options":{"description":"Poll options","items":{"$ref":"#/components/schemas/PollOptionRequest"},"maximum":100,"title":"PollOptions","type":"array","x-stream-index":"004"},"voting_visibility":{"description":"Voting visibility","enum":["anonymous","public"],"title":"string","type":"string","x-stream-index":"006"}},"required":["id","name"],"type":"object"},"UpdateReminderRequest":{"nullable":true,"properties":{"remind_at":{"format":"date-time","type":"number","x-stream-index":"001"}},"type":"object"},"UpdateReminderResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"001"}},"required":["reminder","duration"],"title":"Response","type":"object"},"UpdateThreadPartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"description":"Sets new field values","title":"Set","type":"object","x-stream-index":"004.001","x-stream-map":{"key":"field","title":"Value","description":"New value to set"}},"unset":{"description":"Array of field names to unset","items":{"type":"string"},"title":"Unset","type":"array","x-stream-index":"004.002"}},"type":"object"},"UpdateThreadPartialResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"thread":{"$ref":"#/components/schemas/ThreadResponse","description":"Updated thread (not enriched)","title":"Thread","x-stream-index":"001"}},"required":["thread","duration"],"type":"object"},"UpdateUserPartialRequest":{"properties":{"id":{"description":"User ID to update","title":"ID","type":"string","x-stream-index":"001"},"set":{"additionalProperties":{},"type":"object","x-stream-index":"002.001"},"unset":{"items":{"type":"string"},"type":"array","x-stream-index":"002.002"}},"required":["id"],"type":"object"},"UpdateUserPermissionsRequest":{"nullable":true,"properties":{"grant_permissions":{"items":{"type":"string"},"type":"array","x-stream-index":"002"},"revoke_permissions":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"user_id":{"type":"string","x-stream-index":"001"}},"required":["user_id"],"type":"object"},"UpdateUserPermissionsResponse":{"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"},"UpdateUsersPartialRequest":{"nullable":true,"properties":{"users":{"items":{"$ref":"#/components/schemas/UpdateUserPartialRequest"},"maximum":100,"type":"array","x-stream-index":"001"}},"required":["users"],"type":"object"},"UpdateUsersRequest":{"nullable":true,"properties":{"users":{"additionalProperties":{"$ref":"#/components/schemas/UserRequest"},"description":"Object containing users","title":"Users","type":"object","x-stream-index":"001","x-stream-map":{"key":"user_id"}}},"required":["users"],"type":"object"},"UpdateUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"membership_deletion_task_id":{"type":"string","x-stream-index":"002"},"users":{"additionalProperties":{"$ref":"#/components/schemas/FullUserResponse"},"description":"Object containing users","title":"Users","type":"object","x-stream-index":"001","x-stream-map":{"key":"user_id"}}},"required":["users","membership_deletion_task_id","duration"],"type":"object"},"UpdatedCallPermissionsEvent":{"description":"This event is sent to notify about permission changes for a user, clients receiving this event should update their UI accordingly","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"own_capabilities":{"description":"The capabilities of the current user","items":{"$ref":"#/components/schemas/OwnCapability"},"title":"Own capabilities","type":"array","x-stream-index":"004"},"type":{"default":"call.permissions_updated","description":"The type of event: \"call.permissions_updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who received the new permissions","title":"User","x-stream-index":"003"}},"required":["type","created_at","call_cid","user","own_capabilities"],"title":"UpdatedCallPermissionsEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"UpsertConfigRequest":{"nullable":true,"properties":{"ai_image_config":{"$ref":"#/components/schemas/AIImageConfig","description":"Configuration for AI image analysis","title":"AI Image Config","x-stream-index":"010"},"ai_text_config":{"$ref":"#/components/schemas/AITextConfig","description":"Configuration for AI text analysis","title":"AI Text Config","x-stream-index":"008"},"ai_video_config":{"$ref":"#/components/schemas/AIVideoConfig","description":"Configuration for AI video analysis","title":"AI Video Config","x-stream-index":"011"},"async":{"description":"Whether moderation should be performed asynchronously","title":"Async","type":"boolean","x-stream-index":"003"},"automod_platform_circumvention_config":{"$ref":"#/components/schemas/AutomodPlatformCircumventionConfig","description":"Configuration for platform circumvention detection","title":"Automod Platform Circumvention Config","x-stream-index":"005"},"automod_semantic_filters_config":{"$ref":"#/components/schemas/AutomodSemanticFiltersConfig","description":"Configuration for semantic filtering","title":"Automod Semantic Filters Config","x-stream-index":"006"},"automod_toxicity_config":{"$ref":"#/components/schemas/AutomodToxicityConfig","description":"Configuration for toxicity detection","title":"Automod Toxicity Config","x-stream-index":"004"},"aws_rekognition_config":{"$ref":"#/components/schemas/AIImageConfig","x-stream-index":"015"},"block_list_config":{"$ref":"#/components/schemas/BlockListConfig","description":"Configuration for block list filtering","title":"Block List Config","x-stream-index":"007"},"bodyguard_config":{"$ref":"#/components/schemas/AITextConfig","x-stream-index":"014"},"google_vision_config":{"$ref":"#/components/schemas/GoogleVisionConfig","description":"Configuration for Google Vision integration","title":"Google Vision Config","x-stream-index":"009"},"key":{"description":"Unique identifier for the moderation configuration","title":"Key","type":"string","x-stream-index":"001"},"rule_builder_config":{"$ref":"#/components/schemas/RuleBuilderConfig","description":"Configuration for custom rule builder (max 3 rules, max 5 conditions per rule)","title":"Rule Builder Config","x-stream-index":"013"},"team":{"description":"Team associated with the configuration","maxLength":128,"minLength":1,"title":"Team","type":"string","x-stream-index":"002"},"velocity_filter_config":{"$ref":"#/components/schemas/VelocityFilterConfig","description":"Configuration for velocity-based filtering","title":"Velocity Filter Config","x-stream-index":"012"},"video_call_rule_config":{"$ref":"#/components/schemas/VideoCallRuleConfig","x-stream-index":"016"}},"required":["key"],"type":"object"},"UpsertConfigResponse":{"nullable":true,"properties":{"config":{"$ref":"#/components/schemas/ConfigResponse","description":"The created or updated moderation configuration","title":"Config","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["duration"],"type":"object"},"UpsertPushPreferencesRequest":{"nullable":true,"properties":{"preferences":{"description":"A list of push preferences for channels, calls, or the user.","items":{"$ref":"#/components/schemas/PushPreferenceInput"},"type":"array","x-stream-index":"001"}},"required":["preferences"],"type":"object"},"UpsertPushPreferencesResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"user_channel_preferences":{"additionalProperties":{"additionalProperties":{"$ref":"#/components/schemas/ChannelPushPreferences"},"type":"object"},"description":"The channel specific push notification preferences, only returned for channels you've edited.","title":"User Channel Notification Preferences","type":"object","x-stream-index":"002"},"user_preferences":{"additionalProperties":{"$ref":"#/components/schemas/PushPreferences"},"description":"The user preferences, always returned regardless if you edited it","title":"User Preferences","type":"object","x-stream-index":"001"}},"required":["user_preferences","user_channel_preferences","duration"],"type":"object"},"User":{"properties":{"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"046"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"017"},"banned":{"type":"boolean","x-stream-index":"016"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"013"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"023"},"language":{"type":"string","x-stream-index":"035"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"026"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"042"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"005"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"009"}},"required":["id","role","teams_role","custom","banned","online"],"type":"object"},"UserBannedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"006.002"},"channel_type":{"type":"string","x-stream-index":"006.003"},"cid":{"type":"string","x-stream-index":"006.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008.002"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"001"},"expiration":{"format":"date-time","type":"number","x-stream-index":"003"},"reason":{"type":"string","x-stream-index":"004"},"shadow":{"type":"boolean","x-stream-index":"002"},"team":{"type":"string","x-stream-index":"005.001"},"type":{"default":"user.banned","type":"string","x-stream-index":"008.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007.001"}},"required":["created_by","shadow","cid","channel_id","channel_type","type","created_at"],"title":"UserBannedEvent","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"},"UserCreatedWithinParameters":{"properties":{"max_age":{"type":"string","x-stream-index":"001"}},"type":"object"},"UserDeactivatedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"001"},"type":{"default":"user.deactivated","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["created_by","type","created_at"],"title":"UserDeactivatedEvent","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"},"UserDeletedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"delete_conversation_channels":{"type":"boolean","x-stream-index":"005"},"hard_delete":{"type":"boolean","x-stream-index":"003.001"},"mark_messages_deleted":{"type":"boolean","x-stream-index":"004"},"type":{"default":"user.deleted","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"001.001"}},"required":["type","created_at","hard_delete","mark_messages_deleted","delete_conversation_channels"],"title":"UserDeletedEvent","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"},"UserFeedbackReport":{"properties":{"count_by_rating":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001"},"unreported_count":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["count_by_rating","unreported_count"],"type":"object"},"UserFeedbackReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateUserFeedbackReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"UserMute":{"nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"expires":{"description":"Date/time of mute expiration","format":"date-time","title":"Expires","type":"number","x-stream-index":"008"},"target":{"$ref":"#/components/schemas/User","description":"User who's muted","title":"Target","x-stream-index":"007"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/User","description":"Owner of channel mute","title":"User","x-stream-index":"005"}},"required":["created_at","updated_at"],"type":"object"},"UserMuteResponse":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"expires":{"format":"date-time","type":"number","x-stream-index":"003"},"target":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"}},"required":["created_at","updated_at"],"type":"object"},"UserMutedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"target_user":{"type":"string","x-stream-index":"001"},"target_users":{"items":{"type":"string"},"type":"array","x-stream-index":"002"},"type":{"default":"user.muted","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"UserMutedEvent","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"},"UserPresenceChangedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"type":{"default":"user.presence.changed","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"001.001"}},"required":["type","created_at"],"title":"UserPresenceChangedEvent","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"},"UserRatingReportResponse":{"properties":{"average":{"format":"float","type":"number","x-stream-index":"002"},"count":{"format":"int32","type":"integer","x-stream-index":"001"}},"required":["count","average"],"type":"object"},"UserReactivatedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"type":{"default":"user.reactivated","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"001"}},"required":["type","created_at"],"title":"UserReactivatedEvent","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"},"UserRequest":{"description":"User request object","properties":{"custom":{"additionalProperties":{},"description":"Custom user data","title":"Custom","type":"object","x-stream-index":"004"},"id":{"description":"User ID","title":"ID","type":"string","x-stream-index":"001"},"image":{"description":"User's profile image URL","title":"Image","type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"006"},"language":{"type":"string","x-stream-index":"005"},"name":{"description":"Optional name of user","title":"Name","type":"string","x-stream-index":"002"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"007"}},"required":["id"],"title":"UserRequest","type":"object"},"UserResponse":{"description":"User response object","properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"banned":{"description":"Whether a user is banned or not","title":"Banned","type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.017"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"001.004"},"deactivated_at":{"description":"Date of deactivation","format":"date-time","title":"Deactivated at","type":"number","x-stream-index":"001.016"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"001.011"},"id":{"description":"Unique user identifier","title":"ID","type":"string","x-stream-index":"001.001"},"image":{"title":"Image","type":"string","x-stream-index":"001.003"},"language":{"description":"Preferred language of a user","title":"Language","type":"string","x-stream-index":"001.005"},"last_active":{"description":"Date of last activity","format":"date-time","title":"Last active","type":"number","x-stream-index":"001.014"},"name":{"description":"Optional name of user","title":"Name","type":"string","x-stream-index":"001.002"},"online":{"description":"Whether a user online or not","title":"Online","type":"boolean","x-stream-index":"001.013"},"revoke_tokens_issued_before":{"description":"Revocation date for tokens","format":"date-time","title":"Revoke tokens issued before","type":"number","x-stream-index":"001.015"},"role":{"description":"Determines the set of user permissions","title":"Role","type":"string","x-stream-index":"001.006"},"teams":{"description":"List of teams user is a part of","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids","shadow_banned","invisible"],"title":"UserResponse","type":"object"},"UserResponseCommonFields":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"018"},"banned":{"type":"boolean","x-stream-index":"012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"017"},"created_at":{"format":"date-time","type":"number","x-stream-index":"009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"id":{"type":"string","x-stream-index":"001"},"image":{"type":"string","x-stream-index":"003"},"language":{"type":"string","x-stream-index":"005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"014"},"name":{"type":"string","x-stream-index":"002"},"online":{"type":"boolean","x-stream-index":"013"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"015"},"role":{"type":"string","x-stream-index":"006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids"],"type":"object"},"UserResponsePrivacyFields":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"banned":{"type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.017"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.011"},"id":{"type":"string","x-stream-index":"001.001"},"image":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"003"},"language":{"type":"string","x-stream-index":"001.005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"001.014"},"name":{"type":"string","x-stream-index":"001.002"},"online":{"type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"002"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.015"},"role":{"type":"string","x-stream-index":"001.006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids"],"type":"object"},"UserRuleParameters":{"properties":{"max_age":{"type":"string","x-stream-index":"001"}},"type":"object"},"UserUnbannedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"005.002"},"shadow":{"type":"boolean","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"004.001"},"type":{"default":"user.unbanned","type":"string","x-stream-index":"005.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["shadow","cid","channel_id","channel_type","type","created_at"],"title":"UserUnbannedEvent","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"},"UserUpdatedEvent":{"description":"This event is sent when a user gets updated. The event contains information about the updated user.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"type":{"default":"user.updated","description":"The type of event: \"user.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.002"},"user":{"$ref":"#/components/schemas/UserResponsePrivacyFields","description":"The updated user","title":"User","x-stream-index":"002.001"}},"required":["type","created_at","custom","user"],"title":"UserUpdatedEvent","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"},"UserWatchingStartEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"team":{"type":"string","x-stream-index":"002.001"},"type":{"default":"user.watching.start","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005.001"},"watcher_count":{"format":"int32","type":"integer","x-stream-index":"001.001"}},"required":["watcher_count","type","created_at","cid","channel_id","channel_type"],"title":"UserWatchingStartEvent","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"},"UserWatchingStopEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"type":{"default":"user.watching.stop","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"},"watcher_count":{"format":"int32","type":"integer","x-stream-index":"001.001"}},"required":["watcher_count","type","created_at","cid","channel_id","channel_type"],"title":"UserWatchingStopEvent","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"},"VelocityFilterConfig":{"properties":{"advanced_filters":{"type":"boolean","x-stream-index":"007"},"async":{"type":"boolean","x-stream-index":"001"},"cascading_actions":{"type":"boolean","x-stream-index":"004"},"cids_per_user":{"format":"int32","type":"integer","x-stream-index":"006"},"enabled":{"type":"boolean","x-stream-index":"002"},"first_message_only":{"type":"boolean","x-stream-index":"005"},"rules":{"items":{"$ref":"#/components/schemas/VelocityFilterConfigRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules","cascading_actions","first_message_only","cids_per_user","advanced_filters"],"type":"object"},"VelocityFilterConfigRule":{"properties":{"action":{"enum":["flag","shadow","remove","ban"],"type":"string","x-stream-index":"001"},"ban_duration":{"format":"int32","type":"integer","x-stream-index":"002"},"cascading_action":{"enum":["flag","shadow","remove","ban"],"type":"string","x-stream-index":"006"},"cascading_threshold":{"format":"int64","type":"integer","x-stream-index":"005"},"check_message_context":{"type":"boolean","x-stream-index":"009"},"fast_spam_threshold":{"format":"int32","type":"integer","x-stream-index":"007"},"fast_spam_ttl":{"format":"int32","type":"integer","x-stream-index":"010"},"ip_ban":{"type":"boolean","x-stream-index":"004"},"probation_period":{"format":"int32","type":"integer","x-stream-index":"014"},"shadow_ban":{"type":"boolean","x-stream-index":"003"},"slow_spam_ban_duration":{"format":"int32","type":"integer","x-stream-index":"012"},"slow_spam_threshold":{"format":"int32","type":"integer","x-stream-index":"008"},"slow_spam_ttl":{"format":"int32","type":"integer","x-stream-index":"011"},"url_only":{"type":"boolean","x-stream-index":"013"}},"required":["action","ban_duration","shadow_ban","ip_ban","cascading_threshold","cascading_action","fast_spam_threshold","slow_spam_threshold","check_message_context","fast_spam_ttl","slow_spam_ttl","url_only","probation_period"],"type":"object"},"VideoCallRuleConfig":{"properties":{"rules":{"additionalProperties":{"$ref":"#/components/schemas/HarmConfig"},"type":"object","x-stream-index":"001"}},"required":["rules"],"type":"object"},"VideoContentParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"type":"object"},"VideoEndCallRequest":{"type":"object"},"VideoKickUserRequest":{"type":"object"},"VideoOrientation":{"properties":{"orientation":{"type":"integer","x-stream-index":"004"}},"type":"object"},"VideoReactionOverTimeResponse":{"properties":{"by_minute":{"items":{"$ref":"#/components/schemas/CountByMinuteResponse"},"type":"array","x-stream-index":"001"}},"type":"object"},"VideoReactionsResponse":{"nullable":true,"properties":{"count_over_time":{"$ref":"#/components/schemas/VideoReactionOverTimeResponse","x-stream-index":"002"},"reaction":{"type":"string","x-stream-index":"001"}},"required":["reaction"],"type":"object"},"VideoRuleParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"required":["threshold","time_window"],"type":"object"},"VideoSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"camera_default_on":{"type":"boolean","x-stream-index":"004"},"camera_facing":{"enum":["front","back","external"],"type":"string","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled","target_resolution","camera_default_on","camera_facing"],"type":"object"},"VideoSettingsRequest":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"camera_default_on":{"type":"boolean","x-stream-index":"004"},"camera_facing":{"enum":["front","back","external"],"type":"string","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"type":"object"},"VideoSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"camera_default_on":{"type":"boolean","x-stream-index":"004"},"camera_facing":{"enum":["front","back","external"],"type":"string","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled","target_resolution","camera_default_on","camera_facing"],"type":"object"},"VoteData":{"properties":{"answer_text":{"type":"string","x-stream-index":"002"},"option_id":{"maxLength":255,"type":"string","x-stream-index":"001"}},"type":"object"},"WSAuthMessage":{"description":"Websocket auth message","nullable":true,"properties":{"products":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"token":{"title":"Token","type":"string","x-stream-index":"002"},"user_details":{"$ref":"#/components/schemas/ConnectUserDetailsRequest","x-stream-index":"001"}},"required":["user_details","token"],"title":"WSAuthMessage","type":"object"},"WSClientEvent":{"description":"The discriminator object for all websocket client events, it maps events' payload to the final type","discriminator":{"mapping":{"app.updated":"#/components/schemas/AppUpdatedEvent","draft.deleted":"#/components/schemas/DraftDeletedEvent","draft.updated":"#/components/schemas/DraftUpdatedEvent","health.check":"#/components/schemas/HealthCheckEvent","message.pending":"#/components/schemas/PendingMessageEvent","notification.reminder_due":"#/components/schemas/ReminderNotificationEvent","poll.closed":"#/components/schemas/PollClosedEvent","poll.deleted":"#/components/schemas/PollDeletedEvent","poll.updated":"#/components/schemas/PollUpdatedEvent","poll.vote_casted":"#/components/schemas/PollVoteCastedEvent","poll.vote_changed":"#/components/schemas/PollVoteChangedEvent","poll.vote_removed":"#/components/schemas/PollVoteRemovedEvent","reminder.created":"#/components/schemas/ReminderCreatedEvent","reminder.deleted":"#/components/schemas/ReminderDeletedEvent","reminder.updated":"#/components/schemas/ReminderUpdatedEvent","user.updated":"#/components/schemas/UserUpdatedEvent"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/AppUpdatedEvent"},{"$ref":"#/components/schemas/DraftDeletedEvent"},{"$ref":"#/components/schemas/DraftUpdatedEvent"},{"$ref":"#/components/schemas/HealthCheckEvent"},{"$ref":"#/components/schemas/PendingMessageEvent"},{"$ref":"#/components/schemas/PollClosedEvent"},{"$ref":"#/components/schemas/PollDeletedEvent"},{"$ref":"#/components/schemas/PollUpdatedEvent"},{"$ref":"#/components/schemas/PollVoteCastedEvent"},{"$ref":"#/components/schemas/PollVoteChangedEvent"},{"$ref":"#/components/schemas/PollVoteRemovedEvent"},{"$ref":"#/components/schemas/ReminderCreatedEvent"},{"$ref":"#/components/schemas/ReminderDeletedEvent"},{"$ref":"#/components/schemas/ReminderNotificationEvent"},{"$ref":"#/components/schemas/ReminderUpdatedEvent"},{"$ref":"#/components/schemas/UserUpdatedEvent"}]},"WSEvent":{"description":"The discriminator object for all websocket events, it maps events' payload to the final type","discriminator":{"mapping":{"*":"#/components/schemas/AnyEvent","activity.marked":"#/components/schemas/ActivityMarkedEvent","ai_indicator.clear":"#/components/schemas/AIIndicatorClearEvent","ai_indicator.stop":"#/components/schemas/AIIndicatorStopEvent","ai_indicator.update":"#/components/schemas/AIIndicatorUpdateEvent","app.updated":"#/components/schemas/AppUpdatedEvent","call.accepted":"#/components/schemas/CallAcceptedEvent","call.blocked_user":"#/components/schemas/BlockedUserEvent","call.closed_caption":"#/components/schemas/ClosedCaptionEvent","call.closed_captions_failed":"#/components/schemas/CallClosedCaptionsFailedEvent","call.closed_captions_started":"#/components/schemas/CallClosedCaptionsStartedEvent","call.closed_captions_stopped":"#/components/schemas/CallClosedCaptionsStoppedEvent","call.created":"#/components/schemas/CallCreatedEvent","call.deleted":"#/components/schemas/CallDeletedEvent","call.ended":"#/components/schemas/CallEndedEvent","call.frame_recording_failed":"#/components/schemas/CallFrameRecordingFailedEvent","call.frame_recording_ready":"#/components/schemas/CallFrameRecordingFrameReadyEvent","call.frame_recording_started":"#/components/schemas/CallFrameRecordingStartedEvent","call.frame_recording_stopped":"#/components/schemas/CallFrameRecordingStoppedEvent","call.hls_broadcasting_failed":"#/components/schemas/CallHLSBroadcastingFailedEvent","call.hls_broadcasting_started":"#/components/schemas/CallHLSBroadcastingStartedEvent","call.hls_broadcasting_stopped":"#/components/schemas/CallHLSBroadcastingStoppedEvent","call.live_started":"#/components/schemas/CallLiveStartedEvent","call.member_added":"#/components/schemas/CallMemberAddedEvent","call.member_removed":"#/components/schemas/CallMemberRemovedEvent","call.member_updated":"#/components/schemas/CallMemberUpdatedEvent","call.member_updated_permission":"#/components/schemas/CallMemberUpdatedPermissionEvent","call.missed":"#/components/schemas/CallMissedEvent","call.moderation_blur":"#/components/schemas/CallModerationBlurEvent","call.moderation_warning":"#/components/schemas/CallModerationWarningEvent","call.notification":"#/components/schemas/CallNotificationEvent","call.permission_request":"#/components/schemas/PermissionRequestEvent","call.permissions_updated":"#/components/schemas/UpdatedCallPermissionsEvent","call.reaction_new":"#/components/schemas/CallReactionEvent","call.recording_failed":"#/components/schemas/CallRecordingFailedEvent","call.recording_ready":"#/components/schemas/CallRecordingReadyEvent","call.recording_started":"#/components/schemas/CallRecordingStartedEvent","call.recording_stopped":"#/components/schemas/CallRecordingStoppedEvent","call.rejected":"#/components/schemas/CallRejectedEvent","call.ring":"#/components/schemas/CallRingEvent","call.rtmp_broadcast_failed":"#/components/schemas/CallRtmpBroadcastFailedEvent","call.rtmp_broadcast_started":"#/components/schemas/CallRtmpBroadcastStartedEvent","call.rtmp_broadcast_stopped":"#/components/schemas/CallRtmpBroadcastStoppedEvent","call.session_ended":"#/components/schemas/CallSessionEndedEvent","call.session_participant_count_updated":"#/components/schemas/CallSessionParticipantCountsUpdatedEvent","call.session_participant_joined":"#/components/schemas/CallSessionParticipantJoinedEvent","call.session_participant_left":"#/components/schemas/CallSessionParticipantLeftEvent","call.session_started":"#/components/schemas/CallSessionStartedEvent","call.stats_report_ready":"#/components/schemas/CallStatsReportReadyEvent","call.transcription_failed":"#/components/schemas/CallTranscriptionFailedEvent","call.transcription_ready":"#/components/schemas/CallTranscriptionReadyEvent","call.transcription_started":"#/components/schemas/CallTranscriptionStartedEvent","call.transcription_stopped":"#/components/schemas/CallTranscriptionStoppedEvent","call.unblocked_user":"#/components/schemas/UnblockedUserEvent","call.updated":"#/components/schemas/CallUpdatedEvent","call.user_feedback_submitted":"#/components/schemas/CallUserFeedbackSubmittedEvent","call.user_muted":"#/components/schemas/CallUserMutedEvent","channel.created":"#/components/schemas/ChannelCreatedEvent","channel.deleted":"#/components/schemas/ChannelDeletedEvent","channel.frozen":"#/components/schemas/ChannelFrozenEvent","channel.hidden":"#/components/schemas/ChannelHiddenEvent","channel.kicked":"#/components/schemas/ChannelKickedEvent","channel.truncated":"#/components/schemas/ChannelTruncatedEvent","channel.unfrozen":"#/components/schemas/ChannelUnFrozenEvent","channel.updated":"#/components/schemas/ChannelUpdatedEvent","channel.visible":"#/components/schemas/ChannelVisibleEvent","connection.error":"#/components/schemas/ConnectionErrorEvent","connection.ok":"#/components/schemas/ConnectedEvent","custom":"#/components/schemas/CustomVideoEvent","draft.deleted":"#/components/schemas/DraftDeletedEvent","draft.updated":"#/components/schemas/DraftUpdatedEvent","health.check":"#/components/schemas/HealthCheckEvent","member.added":"#/components/schemas/MemberAddedEvent","member.removed":"#/components/schemas/MemberRemovedEvent","member.updated":"#/components/schemas/MemberUpdatedEvent","message.deleted":"#/components/schemas/MessageDeletedEvent","message.new":"#/components/schemas/MessageNewEvent","message.pending":"#/components/schemas/PendingMessageEvent","message.read":"#/components/schemas/MessageReadEvent","message.undeleted":"#/components/schemas/MessageUndeletedEvent","message.updated":"#/components/schemas/MessageUpdatedEvent","moderation.custom_action":"#/components/schemas/ModerationCustomActionEvent","moderation.flagged":"#/components/schemas/ModerationFlaggedEvent","moderation.mark_reviewed":"#/components/schemas/ModerationMarkReviewedEvent","notification.added_to_channel":"#/components/schemas/NotificationAddedToChannelEvent","notification.channel_deleted":"#/components/schemas/NotificationChannelDeletedEvent","notification.channel_mutes_updated":"#/components/schemas/NotificationChannelMutesUpdatedEvent","notification.channel_truncated":"#/components/schemas/NotificationChannelTruncatedEvent","notification.invite_accepted":"#/components/schemas/NotificationInviteAcceptedEvent","notification.invite_rejected":"#/components/schemas/NotificationInviteRejectedEvent","notification.invited":"#/components/schemas/NotificationInvitedEvent","notification.mark_read":"#/components/schemas/NotificationMarkReadEvent","notification.mark_unread":"#/components/schemas/NotificationMarkUnreadEvent","notification.message_new":"#/components/schemas/NotificationNewMessageEvent","notification.mutes_updated":"#/components/schemas/NotificationMutesUpdatedEvent","notification.reminder_due":"#/components/schemas/ReminderNotificationEvent","notification.removed_from_channel":"#/components/schemas/NotificationRemovedFromChannelEvent","notification.thread_message_new":"#/components/schemas/MessageNewEvent","poll.closed":"#/components/schemas/PollClosedEvent","poll.deleted":"#/components/schemas/PollDeletedEvent","poll.updated":"#/components/schemas/PollUpdatedEvent","poll.vote_casted":"#/components/schemas/PollVoteCastedEvent","poll.vote_changed":"#/components/schemas/PollVoteChangedEvent","poll.vote_removed":"#/components/schemas/PollVoteRemovedEvent","reaction.deleted":"#/components/schemas/ReactionDeletedEvent","reaction.new":"#/components/schemas/ReactionNewEvent","reaction.updated":"#/components/schemas/ReactionUpdatedEvent","reminder.created":"#/components/schemas/ReminderCreatedEvent","reminder.deleted":"#/components/schemas/ReminderDeletedEvent","reminder.updated":"#/components/schemas/ReminderUpdatedEvent","thread.updated":"#/components/schemas/ThreadUpdatedEvent","typing.start":"#/components/schemas/TypingStartEvent","typing.stop":"#/components/schemas/TypingStopEvent","user.banned":"#/components/schemas/UserBannedEvent","user.deactivated":"#/components/schemas/UserDeactivatedEvent","user.deleted":"#/components/schemas/UserDeletedEvent","user.muted":"#/components/schemas/UserMutedEvent","user.presence.changed":"#/components/schemas/UserPresenceChangedEvent","user.reactivated":"#/components/schemas/UserReactivatedEvent","user.unbanned":"#/components/schemas/UserUnbannedEvent","user.updated":"#/components/schemas/UserUpdatedEvent","user.watching.start":"#/components/schemas/UserWatchingStartEvent","user.watching.stop":"#/components/schemas/UserWatchingStopEvent"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/AIIndicatorClearEvent"},{"$ref":"#/components/schemas/AIIndicatorStopEvent"},{"$ref":"#/components/schemas/AIIndicatorUpdateEvent"},{"$ref":"#/components/schemas/ActivityMarkedEvent"},{"$ref":"#/components/schemas/AnyEvent"},{"$ref":"#/components/schemas/AppUpdatedEvent"},{"$ref":"#/components/schemas/BlockedUserEvent"},{"$ref":"#/components/schemas/CallAcceptedEvent"},{"$ref":"#/components/schemas/CallClosedCaptionsFailedEvent"},{"$ref":"#/components/schemas/CallClosedCaptionsStartedEvent"},{"$ref":"#/components/schemas/CallClosedCaptionsStoppedEvent"},{"$ref":"#/components/schemas/CallCreatedEvent"},{"$ref":"#/components/schemas/CallDeletedEvent"},{"$ref":"#/components/schemas/CallEndedEvent"},{"$ref":"#/components/schemas/CallFrameRecordingFailedEvent"},{"$ref":"#/components/schemas/CallFrameRecordingFrameReadyEvent"},{"$ref":"#/components/schemas/CallFrameRecordingStartedEvent"},{"$ref":"#/components/schemas/CallFrameRecordingStoppedEvent"},{"$ref":"#/components/schemas/CallHLSBroadcastingFailedEvent"},{"$ref":"#/components/schemas/CallHLSBroadcastingStartedEvent"},{"$ref":"#/components/schemas/CallHLSBroadcastingStoppedEvent"},{"$ref":"#/components/schemas/CallLiveStartedEvent"},{"$ref":"#/components/schemas/CallMemberAddedEvent"},{"$ref":"#/components/schemas/CallMemberRemovedEvent"},{"$ref":"#/components/schemas/CallMemberUpdatedEvent"},{"$ref":"#/components/schemas/CallMemberUpdatedPermissionEvent"},{"$ref":"#/components/schemas/CallMissedEvent"},{"$ref":"#/components/schemas/CallModerationBlurEvent"},{"$ref":"#/components/schemas/CallModerationWarningEvent"},{"$ref":"#/components/schemas/CallNotificationEvent"},{"$ref":"#/components/schemas/CallReactionEvent"},{"$ref":"#/components/schemas/CallRecordingFailedEvent"},{"$ref":"#/components/schemas/CallRecordingReadyEvent"},{"$ref":"#/components/schemas/CallRecordingStartedEvent"},{"$ref":"#/components/schemas/CallRecordingStoppedEvent"},{"$ref":"#/components/schemas/CallRejectedEvent"},{"$ref":"#/components/schemas/CallRingEvent"},{"$ref":"#/components/schemas/CallRtmpBroadcastFailedEvent"},{"$ref":"#/components/schemas/CallRtmpBroadcastStartedEvent"},{"$ref":"#/components/schemas/CallRtmpBroadcastStoppedEvent"},{"$ref":"#/components/schemas/CallSessionEndedEvent"},{"$ref":"#/components/schemas/CallSessionParticipantCountsUpdatedEvent"},{"$ref":"#/components/schemas/CallSessionParticipantJoinedEvent"},{"$ref":"#/components/schemas/CallSessionParticipantLeftEvent"},{"$ref":"#/components/schemas/CallSessionStartedEvent"},{"$ref":"#/components/schemas/CallStatsReportReadyEvent"},{"$ref":"#/components/schemas/CallTranscriptionFailedEvent"},{"$ref":"#/components/schemas/CallTranscriptionReadyEvent"},{"$ref":"#/components/schemas/CallTranscriptionStartedEvent"},{"$ref":"#/components/schemas/CallTranscriptionStoppedEvent"},{"$ref":"#/components/schemas/CallUpdatedEvent"},{"$ref":"#/components/schemas/CallUserFeedbackSubmittedEvent"},{"$ref":"#/components/schemas/CallUserMutedEvent"},{"$ref":"#/components/schemas/ChannelCreatedEvent"},{"$ref":"#/components/schemas/ChannelDeletedEvent"},{"$ref":"#/components/schemas/ChannelFrozenEvent"},{"$ref":"#/components/schemas/ChannelHiddenEvent"},{"$ref":"#/components/schemas/ChannelKickedEvent"},{"$ref":"#/components/schemas/ChannelTruncatedEvent"},{"$ref":"#/components/schemas/ChannelUnFrozenEvent"},{"$ref":"#/components/schemas/ChannelUpdatedEvent"},{"$ref":"#/components/schemas/ChannelVisibleEvent"},{"$ref":"#/components/schemas/ClosedCaptionEvent"},{"$ref":"#/components/schemas/ConnectedEvent"},{"$ref":"#/components/schemas/ConnectionErrorEvent"},{"$ref":"#/components/schemas/CustomVideoEvent"},{"$ref":"#/components/schemas/DraftDeletedEvent"},{"$ref":"#/components/schemas/DraftUpdatedEvent"},{"$ref":"#/components/schemas/HealthCheckEvent"},{"$ref":"#/components/schemas/MemberAddedEvent"},{"$ref":"#/components/schemas/MemberRemovedEvent"},{"$ref":"#/components/schemas/MemberUpdatedEvent"},{"$ref":"#/components/schemas/MessageDeletedEvent"},{"$ref":"#/components/schemas/MessageNewEvent"},{"$ref":"#/components/schemas/MessageNewEvent"},{"$ref":"#/components/schemas/MessageReadEvent"},{"$ref":"#/components/schemas/MessageUndeletedEvent"},{"$ref":"#/components/schemas/MessageUpdatedEvent"},{"$ref":"#/components/schemas/ModerationCustomActionEvent"},{"$ref":"#/components/schemas/ModerationFlaggedEvent"},{"$ref":"#/components/schemas/ModerationMarkReviewedEvent"},{"$ref":"#/components/schemas/NotificationAddedToChannelEvent"},{"$ref":"#/components/schemas/NotificationChannelDeletedEvent"},{"$ref":"#/components/schemas/NotificationChannelMutesUpdatedEvent"},{"$ref":"#/components/schemas/NotificationChannelTruncatedEvent"},{"$ref":"#/components/schemas/NotificationInviteAcceptedEvent"},{"$ref":"#/components/schemas/NotificationInviteRejectedEvent"},{"$ref":"#/components/schemas/NotificationInvitedEvent"},{"$ref":"#/components/schemas/NotificationMarkReadEvent"},{"$ref":"#/components/schemas/NotificationMarkUnreadEvent"},{"$ref":"#/components/schemas/NotificationMutesUpdatedEvent"},{"$ref":"#/components/schemas/NotificationNewMessageEvent"},{"$ref":"#/components/schemas/NotificationRemovedFromChannelEvent"},{"$ref":"#/components/schemas/PendingMessageEvent"},{"$ref":"#/components/schemas/PermissionRequestEvent"},{"$ref":"#/components/schemas/PollClosedEvent"},{"$ref":"#/components/schemas/PollDeletedEvent"},{"$ref":"#/components/schemas/PollUpdatedEvent"},{"$ref":"#/components/schemas/PollVoteCastedEvent"},{"$ref":"#/components/schemas/PollVoteChangedEvent"},{"$ref":"#/components/schemas/PollVoteRemovedEvent"},{"$ref":"#/components/schemas/ReactionDeletedEvent"},{"$ref":"#/components/schemas/ReactionNewEvent"},{"$ref":"#/components/schemas/ReactionUpdatedEvent"},{"$ref":"#/components/schemas/ReminderCreatedEvent"},{"$ref":"#/components/schemas/ReminderDeletedEvent"},{"$ref":"#/components/schemas/ReminderNotificationEvent"},{"$ref":"#/components/schemas/ReminderUpdatedEvent"},{"$ref":"#/components/schemas/ThreadUpdatedEvent"},{"$ref":"#/components/schemas/TypingStartEvent"},{"$ref":"#/components/schemas/TypingStopEvent"},{"$ref":"#/components/schemas/UnblockedUserEvent"},{"$ref":"#/components/schemas/UpdatedCallPermissionsEvent"},{"$ref":"#/components/schemas/UserBannedEvent"},{"$ref":"#/components/schemas/UserDeactivatedEvent"},{"$ref":"#/components/schemas/UserDeletedEvent"},{"$ref":"#/components/schemas/UserMutedEvent"},{"$ref":"#/components/schemas/UserPresenceChangedEvent"},{"$ref":"#/components/schemas/UserReactivatedEvent"},{"$ref":"#/components/schemas/UserUnbannedEvent"},{"$ref":"#/components/schemas/UserUpdatedEvent"},{"$ref":"#/components/schemas/UserWatchingStartEvent"},{"$ref":"#/components/schemas/UserWatchingStopEvent"}]},"WrappedUnreadCountsResponse":{"description":"Basic response information","nullable":true,"properties":{"channel_type":{"items":{"$ref":"#/components/schemas/UnreadCountsChannelType"},"type":"array","x-stream-index":"001.005"},"channels":{"items":{"$ref":"#/components/schemas/UnreadCountsChannel"},"type":"array","x-stream-index":"001.004"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"threads":{"items":{"$ref":"#/components/schemas/UnreadCountsThread"},"type":"array","x-stream-index":"001.006"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"001.001"},"total_unread_count_by_team":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001.003"},"total_unread_threads_count":{"format":"int32","type":"integer","x-stream-index":"001.002"}},"required":["total_unread_count","total_unread_threads_count","channels","channel_type","threads","duration"],"title":"Response","type":"object"}},"securitySchemes":{"JWT":{"description":"JWT should be always provided when stream-auth-type=jwt.\n\nUsing JWT auth request could be authenticated as user or as server-side.\n\nWhen using user authentication permission checking is going to be applied to requests based on the user that is\nperforming a request.\n\nThe `authorization` header should be a JWT string signed using the secret attached to the API key used to perform\nrequests.\n\n**WARNING** all client-side official SDK do not ship with token generation; this is to make sure that the API secret is not\nshared with an untrusted party such as a browser or a iOS/Android application. Tokens **must** be generated server-side.\nIf you wish, you can configure your application to ignore authentication (see `disable_auth_check`)\nThe JWT string must include only the user_id claim and can include any built-in JWT claim such as iat, exp as well.\n","in":"header","name":"Authorization","type":"apiKey"},"api_key":{"description":"Application API key should be always set in order to authenticate the request.","in":"query","name":"api_key","type":"apiKey"},"stream-auth-type":{"description":"Stream-Auth-Type should be always set in order to authenticate the request. Possible\nvalues: `jwt` or `anonymous`.\n\n`jwt` allows you to authenticate as a user. With this auth type you should also provide valid JWT in Authorization\nheader.\n\n`anonymous` allows you to authenticate as anonymous user. Please note that most advanced features are not available\nto anonymous users.","in":"header","name":"Stream-Auth-Type","type":"apiKey"}}},"info":{"title":"Stream API","version":"v187.13.0"},"openapi":"3.0.3","paths":{"/api/v2/app":{"get":{"description":"This Method returns the application settings\n","operationId":"GetApp","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetApplicationResponse"}}},"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":"Get App Settings","tags":["product:common"]}},"/api/v2/blocklists":{"get":{"description":"Returns all available block lists\n","operationId":"ListBlockLists","parameters":[{"in":"query","name":"team","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListBlockListResponse"}}},"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":"List block lists","tags":["product:common"]},"post":{"description":"Creates a new application blocklist, once created the blocklist can be used by any channel type\n","operationId":"CreateBlockList","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBlockListRequest"}}},"description":"Block list","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBlockListResponse"}}},"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":"Create block list","tags":["product:common"]}},"/api/v2/blocklists/{name}":{"delete":{"description":"Deletes previously created application blocklist\n","operationId":"DeleteBlockList","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"team","schema":{"type":"string","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete block list","tags":["product:common"]},"put":{"description":"Updates contents of the block list\n","operationId":"UpdateBlockList","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Block list name","title":"Name","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBlockListRequest"}}},"description":"Update block list","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBlockListResponse"}}},"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":"Update block list","tags":["product:common"]}},"/api/v2/chat/channels":{"post":{"description":"Query channels with filter query\n","operationId":"QueryChannels","parameters":[{"in":"query","name":"connection_id","schema":{"description":"Websocket connection ID to interact with. You can pass it as Body or URL parameter","title":"Connection ID","type":"string","x-stream-index":"011.003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryChannelsRequest"}}},"description":"Query Channels Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryChannelsResponse"}}},"description":"Channels list"},"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":"Query channels","tags":["product:chat"]}},"/api/v2/chat/channels/delete":{"post":{"description":"Allows to delete several channels at once asynchronously\n\nSends events:\n- channel.deleted\n- channel.deleted\n","operationId":"DeleteChannels","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteChannelsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteChannelsResponse"}}},"description":"Successful 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":"Deletes channels asynchronously","tags":["product:chat"]}},"/api/v2/chat/channels/read":{"post":{"description":"Marks channels as read up to the specific message. If no channels is given, mark all channel as read\n\nSends events:\n- message.read\n- message.read\n","operationId":"MarkChannelsRead","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkChannelsReadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkReadResponse"}}},"description":"Successful 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 channels as read","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/query":{"post":{"description":"This Method creates a channel or returns an existing one with matching attributes\n\nSends events:\n- channel.created\n- member.added\n- member.removed\n- member.updated\n- user.watching.start\n","operationId":"GetOrCreateDistinctChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"connection_id","schema":{"description":"Websocket connection ID to interact with. You can pass it as Body or URL parameter","title":"Connection ID","type":"string","x-stream-index":"012.003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelGetOrCreateRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelStateResponse"}}},"description":"Successful 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":"Get or create channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}":{"delete":{"description":"Deletes channel\n\nSends events:\n- channel.deleted\n- channel.deleted\n","operationId":"DeleteChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"query","name":"hard_delete","schema":{"type":"boolean","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteChannelResponse"}}},"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":"Delete channel","tags":["product:chat"]},"patch":{"description":"Updates certain fields of the channel\n\nSends events:\n- channel.updated\n- channel.updated\n","operationId":"UpdateChannelPartial","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelPartialRequest"}}},"description":"UpdateChannelPartialRequest","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelPartialResponse"}}},"description":"Successful 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":"Partially update channel","tags":["product:chat"]},"post":{"description":"Change channel data\n\nSends events:\n- channel.updated\n- member.added\n- member.removed\n- member.updated\n- message.new\n- channel.updated\n- member.added\n- member.removed\n- member.updated\n- message.new\n","operationId":"UpdateChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"013.002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"013.002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelRequest"}}},"description":"Channel update request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelResponse"}}},"description":"Successful 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":"Update channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/draft":{"delete":{"description":"Deletes a draft\n\nSends events:\n- draft.deleted\n","operationId":"DeleteDraft","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"parent_id","schema":{"description":"Parent message ID","title":"string","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete draft","tags":["product:chat"]},"get":{"description":"Get a draft\n","operationId":"GetDraft","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"parent_id","schema":{"description":"Parent message ID","title":"string","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetDraftResponse"}}},"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":"Get draft","tags":["product:chat"]},"post":{"description":"Creates a draft\n\nSends events:\n- draft.updated\n","operationId":"CreateDraft","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDraftRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDraftResponse"}}},"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":"Create a draft","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/event":{"post":{"description":"Sends event to the channel\n","operationId":"SendEvent","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendEventRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventResponse"}}},"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":"Send event","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/file":{"delete":{"description":"Deletes previously uploaded file\n","operationId":"DeleteFile","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of file","title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"File ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"url","schema":{"description":"File URL to delete","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete file","tags":["product:chat"]},"post":{"description":"Uploads file\n","operationId":"UploadFile","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/FileUploadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileUploadResponse"}}},"description":"Successful 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":"Upload file","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/hide":{"post":{"description":"Marks channel as hidden for current user\n\nSends events:\n- channel.hidden\n- channel.hidden\n","operationId":"HideChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HideChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HideChannelResponse"}}},"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":"Hide channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/image":{"delete":{"description":"Deletes previously uploaded image\n","operationId":"DeleteImage","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of file","title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"File ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"url","schema":{"description":"File URL to delete","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete image","tags":["product:chat"]},"post":{"description":"Uploads image\n","operationId":"UploadImage","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.001.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.001.002"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/ImageUploadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageUploadResponse"}}},"description":"Successful 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":"Upload image","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/member":{"patch":{"description":"\n","operationId":"UpdateMemberPartial","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMemberPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMemberPartialResponse"}}},"description":"Successful 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":"Partially channel member update","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/message":{"post":{"description":"Sends new message to the specified channel\n\nSends events:\n- message.new\n- message.updated\n- message.new\n- message.updated\n","operationId":"SendMessage","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"009.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"009.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendMessageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendMessageResponse"}}},"description":"Successful 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":"Send new message","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/messages":{"get":{"description":"Returns list messages found by IDs\n","operationId":"GetManyMessages","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"ids","required":true,"schema":{"description":"List of comma-separated IDs","items":{"type":"string"},"maximum":50,"minimum":1,"title":"IDs","type":"array","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetManyMessagesResponse"}}},"description":"Successful 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":"Get many messages","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/query":{"post":{"description":"This Method creates a channel or returns an existing one with matching attributes\n\nSends events:\n- channel.created\n- member.added\n- member.removed\n- member.updated\n- user.watching.start\n","operationId":"GetOrCreateChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID (maximum length of 64 characters)","title":"ID","type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"connection_id","schema":{"description":"Websocket connection ID to interact with. You can pass it as Body or URL parameter","title":"Connection ID","type":"string","x-stream-index":"012.003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelGetOrCreateRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelStateResponse"}}},"description":"Successful 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":"Get or create channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/read":{"post":{"description":"Marks channel as read up to the specific message\n\nSends events:\n- message.read\n- message.read\n","operationId":"MarkRead","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkReadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkReadResponse"}}},"description":"Successful 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 read","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/show":{"post":{"description":"Shows previously hidden channel\n\nSends events:\n- channel.visible\n- channel.visible\n","operationId":"ShowChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShowChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShowChannelResponse"}}},"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":"Show channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/stop-watching":{"post":{"description":"Call this Method to stop receiving channel events\n\nSends events:\n- user.watching.stop\n- user.watching.stop\n","operationId":"StopWatchingChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"connection_id","schema":{"type":"string","x-stream-index":"001.003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelStopWatchingRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Stop watching channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/truncate":{"post":{"description":"Truncates messages from a channel. Can be applied to the entire channel or scoped to specific members.\n\nSends events:\n- channel.truncated\n- channel.truncated\n","operationId":"TruncateChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TruncateChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TruncateChannelResponse"}}},"description":"Successful 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":"Truncate channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/unread":{"post":{"description":"Marks channel as unread from a specific message\n","operationId":"MarkUnread","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkUnreadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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 unread","tags":["product:chat"]}},"/api/v2/chat/drafts/query":{"post":{"description":"Queries draft messages for a user\n","operationId":"QueryDrafts","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryDraftsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryDraftsResponse"}}},"description":"Successful 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":"Query draft messages","tags":["product:chat"]}},"/api/v2/chat/members":{"get":{"description":"Find and filter channel members\n","operationId":"QueryMembers","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryMembersPayload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MembersResponse"}}},"description":"Successful 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":"Query members","tags":["product:chat"]}},"/api/v2/chat/messages/{id}":{"delete":{"description":"Deletes message\n\nSends events:\n- message.deleted\n- message.deleted\n","operationId":"DeleteMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID to delete","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"hard","schema":{"description":"Delete all message reactions and replies as well","title":"Hard","type":"boolean","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"deleted_by","schema":{"type":"string","writeOnly":true,"x-stream-index":"003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteMessageResponse"}}},"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":"Delete message","tags":["product:chat"]},"get":{"description":"Returns message by ID\n","operationId":"GetMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"ID of the message","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetMessageResponse"}}},"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":"Get message","tags":["product:chat"]},"post":{"description":"Updates message with new data\n\nSends events:\n- message.updated\n- message.updated\n","operationId":"UpdateMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"004.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessageResponse"}}},"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":"Update message","tags":["product:chat"]},"put":{"description":"Updates certain fields of the message\n\nSends events:\n- message.updated\n- message.updated\n","operationId":"UpdateMessagePartial","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessagePartialRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessagePartialResponse"}}},"description":"Successful 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":"Partially message update","tags":["product:chat"]}},"/api/v2/chat/messages/{id}/action":{"post":{"description":"Executes message command action with given parameters\n\nSends events:\n- message.new\n- message.new\n","operationId":"RunMessageAction","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageActionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}},"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":"Run message command action","tags":["product:chat"]}},"/api/v2/chat/messages/{id}/reaction":{"post":{"description":"Sends reaction to specified message\n\nSends events:\n- reaction.new\n- reaction.updated\n","operationId":"SendReaction","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID to send reaction for","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendReactionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendReactionResponse"}}},"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":"Send reaction","tags":["product:chat"]}},"/api/v2/chat/messages/{id}/reaction/{type}":{"delete":{"description":"Removes user reaction from the message\n\nSends events:\n- reaction.deleted\n","operationId":"DeleteReaction","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID to remove reaction from","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"type","required":true,"schema":{"description":"Reaction type to remove","title":"Type","type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"description":"**Server-side only**. User ID which server acts upon","title":"User ID","type":"string","writeOnly":true,"x-stream-index":"003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteReactionResponse"}}},"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":"Delete reaction","tags":["product:chat"]}},"/api/v2/chat/messages/{id}/reactions":{"get":{"description":"Returns list of reactions of specific message\n","operationId":"GetReactions","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"limit","schema":{"description":"Number of records to return","format":"int32","title":"Limit","type":"integer","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"offset","schema":{"description":"Number of records to offset","format":"int32","title":"Offset","type":"integer","writeOnly":true,"x-stream-index":"003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetReactionsResponse"}}},"description":"Successful 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":"Get reactions","tags":["product:chat"]},"post":{"description":"Get reactions on a message\n","operationId":"QueryReactions","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryReactionsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryReactionsResponse"}}},"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"}},"tags":["product:chat"]}},"/api/v2/chat/messages/{id}/translate":{"post":{"description":"Translates message to a given language using automated translation software\n\nSends events:\n- message.updated\n- message.updated\n","operationId":"TranslateMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TranslateMessageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}},"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":"Translate message","tags":["product:chat"]}},"/api/v2/chat/messages/{message_id}/polls/{poll_id}/vote":{"post":{"description":"Cast a vote on a poll\n\nSends events:\n- feeds.poll.vote_casted\n- feeds.poll.vote_changed\n- feeds.poll.vote_removed\n- poll.vote_casted\n- poll.vote_changed\n- poll.vote_removed\n","operationId":"CastPollVote","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CastPollVoteRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollVoteResponse"}}},"description":"Successful 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":"Cast vote","tags":["product:chat"]}},"/api/v2/chat/messages/{message_id}/polls/{poll_id}/vote/{vote_id}":{"delete":{"description":"Delete a vote from a poll\n\nSends events:\n- feeds.poll.vote_removed\n- poll.vote_removed\n","operationId":"DeletePollVote","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"004"}},{"in":"path","name":"vote_id","required":true,"schema":{"description":"Vote ID","maxLength":255,"title":"string","type":"string","x-stream-index":"005"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollVoteResponse"}}},"description":"Successful 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":"Delete vote","tags":["product:chat"]}},"/api/v2/chat/messages/{message_id}/reminders":{"delete":{"description":"Deletes a user's created reminder\n\nSends events:\n- reminder.deleted\n","operationId":"DeleteReminder","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteReminderResponse"}}},"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":"Delete reminder","tags":["product:chat"]},"patch":{"description":"Updates an existing reminder\n\nSends events:\n- reminder.updated\n","operationId":"UpdateReminder","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateReminderRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateReminderResponse"}}},"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":"Updates Reminder","tags":["product:chat"]},"post":{"description":"Creates a new reminder\n\nSends events:\n- reminder.created\n","operationId":"CreateReminder","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateReminderRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReminderResponseData"}}},"description":"Successful 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":"Create reminder","tags":["product:chat"]}},"/api/v2/chat/messages/{parent_id}/replies":{"get":{"description":"Returns replies (thread) of the message\n","operationId":"GetReplies","parameters":[{"in":"path","name":"parent_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"sort","schema":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":1,"type":"array","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"limit","schema":{"description":"The maximum number of messages to return (max limit ","format":"int32","minimum":0,"title":"Limit","type":"integer","x-stream-index":"003.001"}},{"in":"query","name":"offset","schema":{"description":"The offset to start from","format":"int32","title":"Offset","type":"integer","x-stream-index":"003.002"}},{"in":"query","name":"id_gte","schema":{"description":"The ID of the message to get messages with a timestamp greater than or equal to","title":"IDGTE","type":"string","x-stream-index":"003.003"}},{"in":"query","name":"id_gt","schema":{"description":"The ID of the message to get messages with a timestamp greater than","title":"IDGT","type":"string","x-stream-index":"003.004"}},{"in":"query","name":"id_lte","schema":{"description":"The ID of the message to get messages with a timestamp smaller than or equal to","title":"IDLTE","type":"string","x-stream-index":"003.005"}},{"in":"query","name":"id_lt","schema":{"description":"The ID of the message to get messages with a timestamp smaller than","title":"IDLT","type":"string","x-stream-index":"003.006"}},{"in":"query","name":"created_at_after_or_equal","schema":{"description":"The timestamp to get messages with a created_at timestamp greater than or equal to","format":"date-time","title":"Created_at after or equal","type":"number","x-stream-index":"003.007"}},{"in":"query","name":"created_at_after","schema":{"description":"The timestamp to get messages with a created_at timestamp greater than","format":"date-time","title":"Created_at after","type":"number","x-stream-index":"003.008"}},{"in":"query","name":"created_at_before_or_equal","schema":{"description":"The timestamp to get messages with a created_at timestamp smaller than or equal to","format":"date-time","title":"Created_at after before or equal","type":"number","x-stream-index":"003.009"}},{"in":"query","name":"created_at_before","schema":{"description":"The timestamp to get messages with a created_at timestamp smaller than","format":"date-time","title":"Created_at after before","type":"number","x-stream-index":"003.010"}},{"in":"query","name":"id_around","schema":{"description":"The result will be a set of messages, that are both older and newer than the message with the provided ID, and the message with the ID provided will be in the middle of the set","title":"Id around","type":"string","x-stream-index":"003.011"}},{"in":"query","name":"created_at_around","schema":{"description":"The result will be a set of messages, that are both older and newer than the created_at timestamp provided, distributed evenly around the timestamp","format":"date-time","title":"Created_at around","type":"number","x-stream-index":"003.012"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRepliesResponse"}}},"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":"Get replies","tags":["product:chat"]}},"/api/v2/chat/moderation/flags/message":{"get":{"description":"Find and filter message flags\n","operationId":"QueryMessageFlags","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryMessageFlagsPayload","description":"JSON object with query message flags payload","title":"Payload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryMessageFlagsResponse"}}},"description":"QueryMessageFlagsResponse"},"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":"Query Message Flags","tags":["product:chat"]}},"/api/v2/chat/moderation/mute/channel":{"post":{"description":"Mutes channel for user\n\nSends events:\n- channel.muted\n- channel.muted\n","operationId":"MuteChannel","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteChannelResponse"}}},"description":"Successful 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":"Mute channel","tags":["product:chat"]}},"/api/v2/chat/moderation/unmute/channel":{"post":{"description":"Unmutes channel for user\n\nSends events:\n- channel.unmuted\n- channel.unmuted\n","operationId":"UnmuteChannel","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnmuteChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnmuteResponse"}}},"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":"Unmute channel","tags":["product:chat"]}},"/api/v2/chat/push_preferences":{"post":{"description":"Update the push preferences for a user and or channel member. Set to all, mentions or none\n","operationId":"UpdatePushNotificationPreferences","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertPushPreferencesRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertPushPreferencesResponse"}}},"description":"Successful 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":"Push notification preferences","tags":["product:chat"]}},"/api/v2/chat/query_banned_users":{"get":{"description":"Find and filter channel scoped or global user bans\n","operationId":"QueryBannedUsers","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryBannedUsersPayload","description":"JSON object with query user bans payload","title":"Payload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryBannedUsersResponse"}}},"description":"Successful 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":"Query Banned Users","tags":["product:chat"]}},"/api/v2/chat/reminders/query":{"post":{"description":"Queries reminders\n","operationId":"QueryReminders","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryRemindersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryRemindersResponse"}}},"description":"Successful 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":"Query reminders","tags":["product:chat"]}},"/api/v2/chat/search":{"get":{"description":"Search messages across channels\n","operationId":"Search","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchPayload","description":"JSON object with search payload","title":"Payload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchResponse"}}},"description":"Successful 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":"Search messages","tags":["product:chat"]}},"/api/v2/chat/sync":{"post":{"description":"Returns all events happened since client disconnect in specified channels\n","operationId":"Sync","parameters":[{"in":"query","name":"with_inaccessible_cids","schema":{"description":"If set to true this will add 'inaccessible_cids' to response type","title":"With inaccessible CIDs","type":"boolean","x-stream-index":"003"}},{"in":"query","name":"watch","schema":{"description":"If set to true this will start watching requested and newly added channels that user has access to. If error occurred with this option enabled and it is not an input error - channels will still be watched.","title":"Watch synced channels","type":"boolean","x-stream-index":"004"}},{"in":"query","name":"connection_id","schema":{"type":"string","x-stream-index":"006.003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncRequest"}}},"description":"SyncRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncResponse"}}},"description":"SyncResponse"},"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":"Sync","tags":["product:chat"]}},"/api/v2/chat/threads":{"post":{"description":"Returns the list of threads for specific user\n","operationId":"QueryThreads","parameters":[{"in":"query","name":"connection_id","schema":{"type":"string","x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryThreadsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryThreadsResponse"}}},"description":"Successful 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":"Query Threads","tags":["product:chat"]}},"/api/v2/chat/threads/{message_id}":{"get":{"description":"Return a specific thread\n","operationId":"GetThread","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"watch","schema":{"description":"Start watching the channel this thread belongs to","title":"Watch","type":"boolean","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"connection_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"003"}},{"in":"query","name":"reply_limit","schema":{"description":"Limit the number of replies returned","format":"int32","minimum":0,"title":"Reply limit","type":"integer","writeOnly":true,"x-stream-index":"004"}},{"in":"query","name":"participant_limit","schema":{"description":"Limit the number of participants returned","format":"int32","maximum":100,"minimum":0,"title":"Participant limit","type":"integer","writeOnly":true,"x-stream-index":"005"}},{"in":"query","name":"member_limit","schema":{"description":"Limit the number of members returned per thread channel","format":"int32","maximum":100,"minimum":0,"title":"Member limit","type":"integer","writeOnly":true,"x-stream-index":"006"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetThreadResponse"}}},"description":"Successful 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":"Get Thread","tags":["product:chat"]},"patch":{"description":"Updates certain fields of the thread\n\nSends events:\n- thread.updated\n- thread.updated\n","operationId":"UpdateThreadPartial","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateThreadPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateThreadPartialResponse"}}},"description":"Successful 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":"Partially update thread","tags":["product:chat"]}},"/api/v2/chat/unread":{"get":{"description":"Fetch unread counts for a single user\n","operationId":"UnreadCounts","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WrappedUnreadCountsResponse"}}},"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":"Unread counts","tags":["product:chat"]}},"/api/v2/devices":{"delete":{"description":"Deletes one device\n","operationId":"DeleteDevice","parameters":[{"in":"query","name":"id","required":true,"schema":{"description":"Device ID to delete","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete device","tags":["product:common"]},"get":{"description":"Returns all available devices\n","operationId":"ListDevices","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDevicesResponse"}}},"description":"ListDevicesResponse"},"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":"List devices","tags":["product:common"]},"post":{"description":"Adds a new device to a user, if the same device already exists the call will have no effect\n","operationId":"CreateDevice","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDeviceRequest"}}},"description":"CreateDeviceRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Create device","tags":["product:common"]}},"/api/v2/guest":{"post":{"description":"\n","operationId":"CreateGuest","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGuestRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGuestResponse"}}},"description":"Successful 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":"Create Guest","tags":["product:common"]}},"/api/v2/longpoll":{"get":{"description":"WebSocket fallback transport endpoint\n\nSends events:\n- user.updated\n","operationId":"LongPoll","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WSAuthMessage","x-stream-index":"001"}}},"in":"query","name":"json"},{"in":"query","name":"connection_id","schema":{"maxLength":36,"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"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":"Long Poll (Transport)","tags":["product:common"]}},"/api/v2/moderation/ban":{"post":{"description":"Ban a user from a channel or the entire app\n","operationId":"ban","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BanRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BanResponse"}}},"description":"Successful 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":"Ban","tags":["product:moderation"]}},"/api/v2/moderation/config":{"post":{"description":"Create a new moderation configuration or update an existing one. Configure settings for content filtering, AI analysis, toxicity detection, and other moderation features.\n","operationId":"upsert_config","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertConfigRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertConfigResponse"}}},"description":"Successful 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":"Create or update moderation configuration","tags":["product:moderation"]}},"/api/v2/moderation/config/{key}":{"delete":{"description":"Delete a specific moderation policy by its name\n","operationId":"delete_config","parameters":[{"in":"path","name":"key","required":true,"schema":{"description":"Key of the moderation configuration to delete","title":"Key","type":"string","x-stream-index":"001"}},{"in":"query","name":"team","schema":{"description":"Team associated with the configuration","title":"Team","type":"string","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteModerationConfigResponse"}}},"description":"Successful 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":"Delete a moderation policy","tags":["product:moderation"]},"get":{"description":"Retrieve a specific moderation configuration by its key and team. This configuration contains settings for various moderation features like toxicity detection, AI analysis, and filtering rules.\n","operationId":"get_config","parameters":[{"in":"path","name":"key","required":true,"schema":{"description":"Key of the moderation configuration to retrieve","title":"Key","type":"string","x-stream-index":"001"}},{"in":"query","name":"team","schema":{"description":"Team associated with the configuration","title":"Team","type":"string","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetConfigResponse"}}},"description":"Successful 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":"Get moderation configuration","tags":["product:moderation"]}},"/api/v2/moderation/configs":{"post":{"description":"Search and filter moderation configurations across your application. This endpoint is designed for building moderation dashboards and managing multiple configuration sets.\n","operationId":"query_moderation_configs","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationConfigsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationConfigsResponse"}}},"description":"Successful 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":"Query moderation configurations","tags":["product:moderation"]}},"/api/v2/moderation/flag":{"post":{"description":"Flag any type of content (messages, users, channels, activities) for moderation review. Supports custom content types and additional metadata for flagged content.\n","operationId":"flag","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlagRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlagResponse"}}},"description":"Successful 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":"Flag content for moderation","tags":["product:moderation"]}},"/api/v2/moderation/mute":{"post":{"description":"Mute a user. Mutes are generally not visible to the user you mute, while block is something you notice.\n","operationId":"mute","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteRequest"}}},"description":"MuteRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteResponse"}}},"description":"MuteResponse"},"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":"Mute","tags":["product:moderation"]}},"/api/v2/moderation/review_queue":{"post":{"description":"Query review queue items allows you to filter the review queue items. This is used for building a moderation dashboard.\n","operationId":"query_review_queue","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryReviewQueueRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryReviewQueueResponse"}}},"description":"Successful 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":"Query review queue items","tags":["product:moderation"]}},"/api/v2/moderation/submit_action":{"post":{"description":"Take action on flagged content, such as marking content as safe, deleting content, banning users, or executing custom moderation actions. Supports various action types with configurable parameters.\n","operationId":"submit_action","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitActionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitActionResponse"}}},"description":"Successful 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":"Submit moderation action","tags":["product:moderation"]}},"/api/v2/og":{"get":{"description":"Get an OpenGraph attachment for a link\n","operationId":"GetOG","parameters":[{"in":"query","name":"url","required":true,"schema":{"description":"URL to be scraped","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOGResponse"}}},"description":"Get OG Attachment"},"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":"Get OG","tags":["product:common"]}},"/api/v2/polls":{"post":{"description":"Creates a new poll\n","operationId":"CreatePoll","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePollRequest"}}},"description":"Create Poll Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Create poll","tags":["product:common"]},"put":{"description":"Updates a poll\n\nSends events:\n- feeds.poll.closed\n- feeds.poll.updated\n- poll.closed\n- poll.updated\n","operationId":"UpdatePoll","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePollRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Update poll","tags":["product:common"]}},"/api/v2/polls/query":{"post":{"description":"Queries polls\n","operationId":"QueryPolls","parameters":[{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryPollsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryPollsResponse"}}},"description":"Successful 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":"Query polls","tags":["product:common"]}},"/api/v2/polls/{poll_id}":{"delete":{"description":"Deletes a poll\n\nSends events:\n- feeds.poll.deleted\n- poll.deleted\n","operationId":"DeletePoll","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete poll","tags":["product:common"]},"get":{"description":"Retrieves a poll\n","operationId":"GetPoll","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Get poll","tags":["product:common"]},"patch":{"description":"Updates a poll partially\n\nSends events:\n- feeds.poll.closed\n- feeds.poll.updated\n- poll.closed\n- poll.updated\n","operationId":"UpdatePollPartial","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePollPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Partial update poll","tags":["product:common"]}},"/api/v2/polls/{poll_id}/options":{"post":{"description":"Creates a poll option\n\nSends events:\n- feeds.poll.updated\n- poll.updated\n","operationId":"CreatePollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePollOptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollOptionResponse"}}},"description":"Successful 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":"Create poll option","tags":["product:common"]},"put":{"description":"Updates a poll option\n\nSends events:\n- feeds.poll.updated\n- poll.updated\n","operationId":"UpdatePollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePollOptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollOptionResponse"}}},"description":"Successful 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":"Update poll option","tags":["product:common"]}},"/api/v2/polls/{poll_id}/options/{option_id}":{"delete":{"description":"Deletes a poll option\n\nSends events:\n- feeds.poll.updated\n- poll.updated\n","operationId":"DeletePollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"path","name":"option_id","required":true,"schema":{"description":"Option ID","maxLength":255,"title":"string","type":"string","x-stream-index":"003"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete poll option","tags":["product:common"]},"get":{"description":"Retrieves a poll option\n","operationId":"GetPollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"path","name":"option_id","required":true,"schema":{"description":"Option ID","maxLength":255,"title":"string","type":"string","x-stream-index":"003"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollOptionResponse"}}},"description":"Successful 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":"Get poll option","tags":["product:common"]}},"/api/v2/polls/{poll_id}/votes":{"post":{"description":"Queries votes\n","operationId":"QueryPollVotes","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryPollVotesRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollVotesResponse"}}},"description":"Successful 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":"Query votes","tags":["product:common"]}},"/api/v2/uploads/file":{"delete":{"description":"Deletes previously uploaded file\n","operationId":"DeleteFileGlobal","parameters":[{"in":"query","name":"url","schema":{"description":"File URL to delete","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete file","tags":["product:common"],"x-stream-sdk-name":"DeleteFile"},"post":{"description":"Uploads file\n","operationId":"UploadFileGlobal","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/FileUploadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileUploadResponse"}}},"description":"Successful 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":"Upload file","tags":["product:common"],"x-stream-sdk-name":"UploadFile"}},"/api/v2/uploads/image":{"delete":{"description":"Deletes previously uploaded image\n","operationId":"DeleteImageGlobal","parameters":[{"in":"query","name":"url","schema":{"description":"File URL to delete","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete image","tags":["product:common"],"x-stream-sdk-name":"DeleteImage"},"post":{"description":"Uploads image\n","operationId":"UploadImageGlobal","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/ImageUploadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageUploadResponse"}}},"description":"Successful 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":"Upload image","tags":["product:common"],"x-stream-sdk-name":"UploadImage"}},"/api/v2/users":{"get":{"description":"Find and filter users\n","operationId":"QueryUsers","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryUsersPayload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryUsersResponse"}}},"description":"Successful 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":"Query users","tags":["product:common"]},"patch":{"description":"Updates certain fields of the user\n\nSends events:\n- user.presence.changed\n- user.updated\n- user.presence.changed\n","operationId":"UpdateUsersPartial","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersResponse"}}},"description":"Successful 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":"Partially update user","tags":["product:common"]},"post":{"description":"Update or create users in bulk\n\nSends events:\n- user.updated\n","operationId":"UpdateUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersResponse"}}},"description":"Successful 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":"Upsert users","tags":["product:common"]}},"/api/v2/users/block":{"get":{"description":"Get list of blocked Users\n","operationId":"GetBlockedUsers","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBlockedUsersResponse"}}},"description":"Successful 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":"Get list of blocked Users","tags":["product:common"]},"post":{"description":"Block users\n","operationId":"BlockUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUsersResponse"}}},"description":"Successful 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":"Block user","tags":["product:common"]}},"/api/v2/users/live_locations":{"get":{"description":"Retrieves all active live locations for a user\n","operationId":"GetUserLiveLocations","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SharedLocationsResponse"}}},"description":"Successful 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":"Get user live locations","tags":["product:common"]},"put":{"description":"Updates an existing live location with new coordinates or expiration time\n","operationId":"UpdateLiveLocation","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateLiveLocationRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SharedLocationResponse"}}},"description":"Successful 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":"Update live location","tags":["product:common"]}},"/api/v2/users/unblock":{"post":{"description":"Unblock users\n","operationId":"UnblockUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUsersResponse"}}},"description":"Successful 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":"Unblock user","tags":["product:common"]}},"/api/v2/video/call/members":{"post":{"description":"Query call members with filter query\n","operationId":"QueryCallMembers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallMembersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallMembersResponse"}}},"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":"Query call members","tags":["product:video"]}},"/api/v2/video/call/stats":{"post":{"description":"\n","operationId":"QueryCallStats","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallStatsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallStatsResponse"}}},"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":"Query Call Stats","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}":{"get":{"description":"\n","operationId":"GetCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"query","name":"connection_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"003"}},{"in":"query","name":"members_limit","schema":{"format":"int32","maximum":100,"minimum":0,"type":"integer","writeOnly":true,"x-stream-index":"004"}},{"in":"query","name":"ring","schema":{"type":"boolean","writeOnly":true,"x-stream-index":"005"}},{"in":"query","name":"notify","schema":{"type":"boolean","writeOnly":true,"x-stream-index":"006"}},{"in":"query","name":"video","schema":{"type":"boolean","writeOnly":true,"x-stream-index":"007"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCallResponse"}}},"description":"GetCallResponse"},"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":"Get Call","tags":["product:video"]},"patch":{"description":"\n\nSends events:\n- call.updated\n","operationId":"UpdateCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallRequest"}}},"description":"UpdateCallRequest","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallResponse"}}},"description":"UpdateCallResponse"},"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":"Update Call","tags":["product:video"]},"post":{"description":"Gets or creates a new call\n\nSends events:\n- call.created\n- call.notification\n- call.ring\n","operationId":"GetOrCreateCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"connection_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"008"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrCreateCallRequest"}}},"description":"GetOrCreateCallRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrCreateCallResponse"}}},"description":"GetOrCreateCallResponse"},"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":"Get or create a call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/accept":{"post":{"description":"\n\nSends events:\n- call.accepted\n","operationId":"AcceptCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcceptCallResponse"}}},"description":"AcceptCallResponse"},"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":"Accept Call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/block":{"post":{"description":"Block a user, preventing them from joining the call until they are unblocked.\n\nSends events:\n- call.blocked_user\n","operationId":"BlockUser","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUserRequest"}}},"description":"BlockUserRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUserResponse"}}},"description":"BlockUserResponse"},"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":"Block user on a call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/delete":{"post":{"description":"\n\nSends events:\n- call.deleted\n","operationId":"DeleteCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCallRequest"}}},"description":"DeleteCallRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCallResponse"}}},"description":"DeleteCallResponse"},"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":"Delete Call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/event":{"post":{"description":"Sends custom event to the call\n\nSends events:\n- custom\n","operationId":"SendCallEvent","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendCallEventRequest"}}},"description":"SendCallEventRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendCallEventResponse"}}},"description":"SendCallEventResponse"},"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":"Send custom event","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/feedback":{"post":{"description":"\n\nSends events:\n- call.user_feedback_submitted\n","operationId":"CollectUserFeedback","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectUserFeedbackRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectUserFeedbackResponse"}}},"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":"Collect user feedback","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/go_live":{"post":{"description":"\n\nSends events:\n- call.live_started\n","operationId":"GoLive","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoLiveRequest"}}},"description":"GoLiveRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoLiveResponse"}}},"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":"Set call as live","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/join":{"post":{"description":"Request to join a call\n","operationId":"JoinCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"query","name":"connection_id","schema":{"title":"ConnectionID","type":"string","writeOnly":true,"x-stream-index":"008"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JoinCallRequest"}}},"description":"JoinCallRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JoinCallResponse"}}},"description":"JoinCallResponse"},"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":"Join call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/mark_ended":{"post":{"description":"\n\nSends events:\n- call.ended\n","operationId":"EndCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EndCallResponse"}}},"description":"EndCallResponse"},"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":"End call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/members":{"post":{"description":"\n\nSends events:\n- call.member_added\n- call.member_removed\n- call.member_updated\n","operationId":"UpdateCallMembers","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallMembersRequest"}}},"description":"UpdateCallMembersRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallMembersResponse"}}},"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":"Update Call Member","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/mute_users":{"post":{"description":"Mutes users in a call\n","operationId":"MuteUsers","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteUsersRequest"}}},"description":"MuteUsersRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteUsersResponse"}}},"description":"MuteUsersResponse"},"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":"Mute users","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/participants":{"post":{"description":"Returns a list of participants connected to the call\n","operationId":"QueryCallParticipants","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"type","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"limit","schema":{"format":"int32","maximum":100,"type":"integer","x-stream-index":"004"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallParticipantsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallParticipantsResponse"}}},"description":"Successful 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":"Query call participants","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/pin":{"post":{"description":"Pins a track for all users in the call.\n","operationId":"VideoPin","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PinRequest"}}},"description":"PinRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PinResponse"}}},"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":"Pin","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/reaction":{"post":{"description":"Sends reaction to the call\n\nSends events:\n- call.reaction_new\n","operationId":"SendVideoReaction","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendReactionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendReactionResponse"}}},"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":"Send reaction to the call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/recordings":{"get":{"description":"Lists recordings\n","operationId":"ListRecordings","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListRecordingsResponse"}}},"description":"ListRecordingsResponse"},"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":"List recordings","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/reject":{"post":{"description":"\n\nSends events:\n- call.rejected\n","operationId":"RejectCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RejectCallRequest"}}},"description":"RejectCallRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RejectCallResponse"}}},"description":"RejectCallResponse"},"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":"Reject Call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/report":{"get":{"description":"\n","operationId":"GetCallReport","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"query","name":"session_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCallReportResponse"}}},"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":"Get call report","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/request_permission":{"post":{"description":"Request permission to perform an action\n\nSends events:\n- call.permission_request\n","operationId":"RequestPermission","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestPermissionRequest"}}},"description":"RequestPermissionRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestPermissionResponse"}}},"description":"RequestPermissionResponse"},"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":"Request permission","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/rtmp_broadcasts":{"post":{"description":"Starts RTMP broadcasts for the provided RTMP destinations\n","operationId":"StartRTMPBroadcasts","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRTMPBroadcastsRequest"}}},"description":"StartRTMPBroadcastsRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRTMPBroadcastsResponse"}}},"description":"StartRTMPBroadcastsResponse"},"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":"Start RTMP broadcasts","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/rtmp_broadcasts/stop":{"post":{"description":"Stop all RTMP broadcasts for the provided call\n","operationId":"StopAllRTMPBroadcasts","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopAllRTMPBroadcastsResponse"}}},"description":"StopAllRTMPBroadcastsResponse"},"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":"Stop all RTMP broadcasts for a call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/rtmp_broadcasts/{name}/stop":{"post":{"description":"Stop RTMP broadcasts for the provided RTMP destinations\n","operationId":"StopRTMPBroadcast","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopRTMPBroadcastsRequest"}}},"description":"StopRTMPBroadcastsRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopRTMPBroadcastsResponse"}}},"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":"Stop RTMP broadcasts","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/start_broadcasting":{"post":{"description":"Starts HLS broadcasting\n","operationId":"StartHLSBroadcasting","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartHLSBroadcastingResponse"}}},"description":"StartHLSBroadcastingResponse"},"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":"Start HLS broadcasting","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/start_closed_captions":{"post":{"description":"Starts closed captions\n","operationId":"StartClosedCaptions","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartClosedCaptionsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartClosedCaptionsResponse"}}},"description":"Successful 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":"Start closed captions","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/start_frame_recording":{"post":{"description":"Starts frame by frame recording\n\nSends events:\n- call.frame_recording_started\n","operationId":"StartFrameRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartFrameRecordingRequest"}}},"description":"StartFrameRecordingRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartFrameRecordingResponse"}}},"description":"StartFrameRecordingResponse"},"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":"Start frame recording","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/start_recording":{"post":{"description":"Starts recording\n\nSends events:\n- call.recording_started\n","operationId":"StartRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRecordingRequest"}}},"description":"StartRecordingRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRecordingResponse"}}},"description":"StartRecordingResponse"},"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":"Start recording","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/start_transcription":{"post":{"description":"Starts transcription\n","operationId":"StartTranscription","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartTranscriptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartTranscriptionResponse"}}},"description":"StartTranscriptionResponse"},"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":"Start transcription","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_broadcasting":{"post":{"description":"Stops HLS broadcasting\n","operationId":"StopHLSBroadcasting","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopHLSBroadcastingResponse"}}},"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":"Stop HLS broadcasting","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_closed_captions":{"post":{"description":"Stops closed captions\n\nSends events:\n- call.transcription_stopped\n","operationId":"StopClosedCaptions","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopClosedCaptionsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopClosedCaptionsResponse"}}},"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":"Stop closed captions","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_frame_recording":{"post":{"description":"Stops frame recording\n\nSends events:\n- call.frame_recording_stopped\n","operationId":"StopFrameRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopFrameRecordingResponse"}}},"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":"Stop frame recording","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_live":{"post":{"description":"\n\nSends events:\n- call.updated\n","operationId":"StopLive","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopLiveRequest"}}},"description":"StopLiveRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopLiveResponse"}}},"description":"StopLiveResponse"},"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":"Set call as not live","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_recording":{"post":{"description":"Stops recording\n\nSends events:\n- call.recording_stopped\n","operationId":"StopRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopRecordingResponse"}}},"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":"Stop recording","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_transcription":{"post":{"description":"Stops transcription\n\nSends events:\n- call.transcription_stopped\n","operationId":"StopTranscription","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopTranscriptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopTranscriptionResponse"}}},"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":"Stop transcription","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/transcriptions":{"get":{"description":"Lists transcriptions\n","operationId":"ListTranscriptions","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTranscriptionsResponse"}}},"description":"ListTranscriptionsResponse"},"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":"List transcriptions","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/unblock":{"post":{"description":"Removes the block for a user on a call. The user will be able to join the call again.\n\nSends events:\n- call.unblocked_user\n","operationId":"UnblockUser","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUserRequest"}}},"description":"UnblockUserRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUserResponse"}}},"description":"UnblockUserResponse"},"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":"Unblocks user on a call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/unpin":{"post":{"description":"Unpins a track for all users in the call.\n","operationId":"VideoUnpin","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnpinRequest"}}},"description":"UnpinRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnpinResponse"}}},"description":"UnpinResponse"},"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":"Unpin","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/user_permissions":{"post":{"description":"Updates user permissions\n\nSends events:\n- call.permissions_updated\n","operationId":"UpdateUserPermissions","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"005.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"005.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUserPermissionsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUserPermissionsResponse"}}},"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":"Update user permissions","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/{session}/recordings/{filename}":{"delete":{"description":"Deletes recording\n","operationId":"DeleteRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"path","name":"session","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"003"}},{"in":"path","name":"filename","required":true,"schema":{"maxLength":256,"type":"string","writeOnly":true,"x-stream-index":"004"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteRecordingResponse"}}},"description":"DeleteRecordingResponse"},"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":"Delete recording","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/{session}/transcriptions/{filename}":{"delete":{"description":"Deletes transcription\n","operationId":"DeleteTranscription","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"path","name":"session","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"003"}},{"in":"path","name":"filename","required":true,"schema":{"maxLength":256,"type":"string","writeOnly":true,"x-stream-index":"004"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteTranscriptionResponse"}}},"description":"DeleteTranscriptionResponse"},"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":"Delete transcription","tags":["product:video"]}},"/api/v2/video/calls":{"post":{"description":"Query calls with filter query\n","operationId":"QueryCalls","parameters":[{"in":"query","name":"connection_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallsRequest"}}},"description":"QueryCallsRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallsResponse"}}},"description":"QueryCallsResponse"},"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":"Query call","tags":["product:video"]}},"/api/v2/video/edges":{"get":{"description":"Returns the list of all edges available for video calls.\n","operationId":"GetEdges","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetEdgesResponse"}}},"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":"Get Edges","tags":["product:video"]}},"/api/v2/video/stats":{"post":{"description":"\n","operationId":"QueryAggregateCallStats","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryAggregateCallStatsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryAggregateCallStatsResponse"}}},"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":"Query Aggregate call Stats","tags":["product:video"]}}},"security":[{"JWT":[],"api_key":[],"stream-auth-type":[]},{"api_key":[],"stream-auth-type":[]}],"servers":[{"description":"Stream API","url":"https://chat.stream-io-api.com"}]} \ No newline at end of file +{"components":{"schemas":{"AIImageConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"ocr_rules":{"items":{"$ref":"#/components/schemas/OCRRule"},"type":"array","x-stream-index":"004"},"rules":{"items":{"$ref":"#/components/schemas/AWSRekognitionRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules","ocr_rules"],"type":"object"},"AIIndicatorClearEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"ai_indicator.clear","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"AIIndicatorClearEvent","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"},"AIIndicatorStopEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"ai_indicator.stop","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"AIIndicatorStopEvent","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"},"AIIndicatorUpdateEvent":{"properties":{"ai_message":{"type":"string","x-stream-index":"005"},"ai_state":{"type":"string","x-stream-index":"004"},"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"message_id":{"type":"string","x-stream-index":"003"},"type":{"default":"ai_indicator.update","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","cid","channel_id","channel_type","message_id","ai_state"],"title":"AIIndicatorUpdateEvent","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"},"AITextConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"profile":{"type":"string","x-stream-index":"003"},"rules":{"items":{"$ref":"#/components/schemas/BodyguardRule"},"type":"array","x-stream-index":"004"},"severity_rules":{"items":{"$ref":"#/components/schemas/BodyguardSeverityRule"},"type":"array","x-stream-index":"005"}},"required":["enabled","profile","rules","severity_rules"],"type":"object"},"AIVideoConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AWSRekognitionRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"APIError":{"properties":{"StatusCode":{"description":"Response HTTP status code","format":"int32","title":"Status code","type":"integer","x-stream-index":"004"},"code":{"description":"API error code","format":"int32","title":"Code","type":"integer","x-stream-index":"001"},"details":{"description":"Additional error-specific information","items":{"type":"integer"},"title":"Details","type":"array","x-stream-index":"007"},"duration":{"description":"Request duration","title":"Duration","type":"string","x-stream-index":"005"},"exception_fields":{"additionalProperties":{"type":"string"},"description":"Additional error info","title":"Exception fields","type":"object","x-stream-index":"003"},"message":{"description":"Message describing an error","title":"Message","type":"string","x-stream-index":"002"},"more_info":{"description":"URL with additional information","title":"More info","type":"string","x-stream-index":"006"},"unrecoverable":{"description":"Flag that indicates if the error is unrecoverable, requests that return unrecoverable errors should not be retried, this error only applies to the request that caused it","title":"Unrecoverable","type":"boolean","x-stream-index":"008"}},"required":["code","message","StatusCode","duration","more_info","details"],"title":"Error response","type":"object"},"APNS":{"properties":{"body":{"type":"string","x-stream-index":"002"},"content-available":{"format":"int32","type":"integer","x-stream-index":"004"},"data":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"mutable-content":{"format":"int32","type":"integer","x-stream-index":"005"},"sound":{"type":"string","x-stream-index":"003"},"title":{"type":"string","x-stream-index":"001"}},"required":["title","body"],"type":"object"},"AWSRekognitionRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"},"min_confidence":{"format":"float","maximum":100,"minimum":0,"type":"number","x-stream-index":"003"}},"required":["label","action","min_confidence"],"type":"object"},"AcceptCallRequest":{"description":"AcceptCallRequest is the payload for accepting a call.","nullable":true,"title":"AcceptCallRequest","type":"object"},"AcceptCallResponse":{"description":"AcceptCallResponse is the payload for accepting a call.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"AcceptCallResponse","type":"object"},"AcceptFeedMemberInviteRequest":{"nullable":true,"title":"Accept Feed Member Invite Request","type":"object"},"AcceptFeedMemberInviteResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"member":{"$ref":"#/components/schemas/FeedMemberResponse","description":"The feed member after accepting the invite","title":"Feed Member","x-stream-index":"001"}},"required":["member","duration"],"title":"Accept Feed Member Invite Response","type":"object"},"AcceptFollowRequest":{"nullable":true,"properties":{"follower_role":{"description":"Optional role for the follower in the follow relationship","title":"Follower Role","type":"string","x-stream-index":"003"},"source":{"description":"Fully qualified ID of the source feed","maxLength":255,"title":"Source Feed ID","type":"string","x-stream-index":"001"},"target":{"description":"Fully qualified ID of the target feed","maxLength":255,"title":"Target Feed ID","type":"string","x-stream-index":"002"}},"required":["source","target"],"title":"Accept Follow Request","type":"object"},"AcceptFollowResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"follow":{"$ref":"#/components/schemas/FollowResponse","description":"The accepted follow relationship","title":"Follow","x-stream-index":"001"}},"required":["follow","duration"],"title":"Accept Follow Response","type":"object"},"Action":{"nullable":true,"properties":{"name":{"type":"string","x-stream-index":"001"},"style":{"type":"string","x-stream-index":"003"},"text":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"004"},"value":{"type":"string","x-stream-index":"005"}},"required":["name","text","type"],"type":"object"},"ActionLog":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"002"},"reason":{"type":"string","x-stream-index":"008"},"reporter_type":{"type":"string","x-stream-index":"009"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"014"},"review_queue_item_id":{"type":"string","x-stream-index":"012"},"target_user":{"$ref":"#/components/schemas/User","x-stream-index":"013"},"target_user_id":{"type":"string","x-stream-index":"011"},"type":{"type":"string","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007"}},"required":["id","created_at","type","reason","reporter_type","custom","target_user_id","review_queue_item_id"],"type":"object"},"ActionLogResponse":{"nullable":true,"properties":{"created_at":{"description":"Timestamp when the action was taken","format":"date-time","title":"Created At","type":"number","x-stream-index":"002"},"custom":{"additionalProperties":{},"description":"Additional metadata about the action","title":"Custom","type":"object","x-stream-index":"007"},"id":{"description":"Unique identifier of the action log","title":"ID","type":"string","x-stream-index":"001"},"reason":{"description":"Reason for the moderation action","title":"Reason","type":"string","x-stream-index":"006"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"Associated review queue item","title":"Review Queue Item","x-stream-index":"008"},"target_user":{"$ref":"#/components/schemas/UserResponse","description":"User who was the target of the action","title":"Target User","x-stream-index":"009"},"target_user_id":{"description":"ID of the user who was the target of the action","title":"Target User ID","type":"string","x-stream-index":"010"},"type":{"description":"Type of moderation action","title":"Type","type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who performed the action","title":"User","x-stream-index":"004"},"user_id":{"description":"ID of the user who performed the action","title":"User ID","type":"string","x-stream-index":"005"}},"required":["id","created_at","type","user_id","reason","custom","target_user_id"],"type":"object"},"ActionSequence":{"properties":{"action":{"type":"string","x-stream-index":"001"},"blur":{"type":"boolean","x-stream-index":"005"},"cooldown_period":{"format":"int32","type":"integer","x-stream-index":"004"},"threshold":{"format":"int32","type":"integer","x-stream-index":"002"},"time_window":{"format":"int32","type":"integer","x-stream-index":"003"},"warning":{"type":"boolean","x-stream-index":"006"},"warning_text":{"type":"string","x-stream-index":"007"}},"required":["action","threshold","time_window","cooldown_period","blur","warning","warning_text"],"type":"object"},"ActivityAddedEvent":{"description":"Emitted when an activity is added to a feed.","nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","description":"The activity that was added","title":"Activity","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"type":"string","x-stream-index":"002.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.activity.added","description":"The type of event: \"feeds.activity.added\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who added the activity","title":"User","x-stream-index":"003.001"}},"required":["activity","type","created_at","custom","fid"],"title":"ActivityAddedEvent","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"},"ActivityDeletedEvent":{"description":"Emitted when an activity is deleted.","nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","description":"The activity that was updated","title":"Activity","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"type":"string","x-stream-index":"002.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.activity.deleted","description":"The type of event: \"feeds.activity.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","x-stream-index":"003.001"}},"required":["activity","type","created_at","custom","fid"],"title":"ActivityDeletedEvent","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"},"ActivityFeedbackRequest":{"description":"Request to provide feedback on an activity","nullable":true,"properties":{"hide":{"description":"Whether to hide this activity","title":"bool","type":"boolean","x-stream-index":"003"},"mute_user":{"description":"Whether to mute the user who created this activity","title":"bool","type":"boolean","x-stream-index":"005"},"reason":{"description":"Reason for the feedback (optional)","maxLength":1000,"title":"string","type":"string","x-stream-index":"006"},"report":{"description":"Whether to report this activity","title":"bool","type":"boolean","x-stream-index":"004"},"show_less":{"description":"Whether to show less content like this","title":"bool","type":"boolean","x-stream-index":"002"}},"title":"Activity Feedback Request","type":"object"},"ActivityFeedbackResponse":{"description":"Response for activity feedback submission","nullable":true,"properties":{"activity_id":{"description":"The ID of the activity that received feedback","title":"string","type":"string","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["activity_id","duration"],"title":"Activity Feedback Response","type":"object"},"ActivityLocation":{"properties":{"lat":{"description":"Latitude coordinate","format":"float","title":"Latitude","type":"number","x-stream-index":"001"},"lng":{"description":"Longitude coordinate","format":"float","title":"Longitude","type":"number","x-stream-index":"002"}},"required":["lat","lng"],"title":"Activity Location","type":"object"},"ActivityMarkEvent":{"description":"Emitted when activities are marked as read, seen, or watched.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"006.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006.001.007"},"feed_visibility":{"type":"string","x-stream-index":"006.003"},"fid":{"type":"string","x-stream-index":"006.002"},"mark_all_read":{"description":"Whether all activities were marked as read","title":"Mark All Read","type":"boolean","x-stream-index":"004"},"mark_all_seen":{"description":"Whether all activities were marked as seen","title":"Mark All Seen","type":"boolean","x-stream-index":"005"},"mark_read":{"description":"The IDs of activities marked as read","items":{"type":"string"},"title":"Mark Read","type":"array","x-stream-index":"001"},"mark_seen":{"description":"The IDs of activities marked as seen","items":{"type":"string"},"title":"Mark Seen","type":"array","x-stream-index":"002"},"mark_watched":{"description":"The IDs of activities marked as watched","items":{"type":"string"},"title":"Mark Watched","type":"array","x-stream-index":"003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"006.001.004"},"type":{"default":"feeds.activity.marked","description":"The type of event: \"feeds.activity.marked\" in this case","title":"Event Type","type":"string","x-stream-index":"006.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who marked the activities","title":"User","x-stream-index":"007.001"}},"required":["type","created_at","custom","fid"],"title":"ActivityMarkEvent","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"},"ActivityMarkedEvent":{"properties":{"all_read":{"type":"boolean","x-stream-index":"006"},"all_seen":{"type":"boolean","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"feed_id":{"type":"string","x-stream-index":"003"},"marked_read":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"marked_watched":{"items":{"type":"string"},"type":"array","x-stream-index":"005"},"type":{"default":"activity.marked","type":"string","x-stream-index":"001.001"},"user_id":{"type":"string","x-stream-index":"002"}},"required":["type","created_at","user_id","feed_id","all_read","all_seen"],"title":"ActivityMarkedEvent","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"},"ActivityPinResponse":{"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","description":"The pinned activity","title":"Activity","x-stream-index":"002"},"created_at":{"description":"When the pin was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"004"},"feed":{"description":"ID of the feed where activity is pinned","title":"Feed ID","type":"string","x-stream-index":"003"},"updated_at":{"description":"When the pin was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who pinned the activity","title":"User","x-stream-index":"001"}},"required":["user","activity","feed","created_at","updated_at"],"title":"Activity Pin","type":"object"},"ActivityPinnedEvent":{"description":"Emitted when an activity is pinned.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"description":"The ID of the feed","title":"Feed ID","type":"string","x-stream-index":"002.002"},"pinned_activity":{"$ref":"#/components/schemas/PinActivityResponse","x-stream-index":"001"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.activity.pinned","description":"The type of event: \"feeds.activity.pinned\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who pinned the activity","title":"User","x-stream-index":"003.001"}},"required":["pinned_activity","type","created_at","custom","fid"],"title":"ActivityPinnedEvent","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"},"ActivityProcessorConfig":{"nullable":true,"properties":{"config":{"additionalProperties":{},"type":"object","x-stream-index":"002"},"openai_key":{"type":"string","x-stream-index":"003"},"type":{"type":"string","x-stream-index":"001"}},"required":["type"],"type":"object"},"ActivityReactionAddedEvent":{"description":"Emitted when a reaction is added to an activity.","nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"003.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.001.007"},"feed_visibility":{"type":"string","x-stream-index":"003.003"},"fid":{"type":"string","x-stream-index":"003.002"},"reaction":{"$ref":"#/components/schemas/FeedsReactionResponse","description":"The reaction that was added","title":"Reaction","x-stream-index":"002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.001.004"},"type":{"default":"feeds.activity.reaction.added","description":"The type of event: \"feeds.activity.reaction.added\" in this case","title":"Event Type","type":"string","x-stream-index":"003.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who added the reaction","title":"User","x-stream-index":"004.001"}},"required":["activity","reaction","type","created_at","custom","fid"],"title":"ActivityReactionAddedEvent","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"},"ActivityReactionDeletedEvent":{"description":"Emitted when a reaction is deleted from an activity.","nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"003.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.001.007"},"feed_visibility":{"type":"string","x-stream-index":"003.003"},"fid":{"type":"string","x-stream-index":"003.002"},"reaction":{"$ref":"#/components/schemas/FeedsReactionResponse","x-stream-index":"002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.001.004"},"type":{"default":"feeds.activity.reaction.deleted","description":"The type of the reaction that was removed","title":"Type","type":"string","x-stream-index":"003.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who removed the reaction","title":"User","x-stream-index":"004.001"}},"required":["activity","reaction","type","created_at","custom","fid"],"title":"ActivityReactionDeletedEvent","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"},"ActivityReactionUpdatedEvent":{"description":"Emitted when a reaction is updated on an activity.","nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"003.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.001.007"},"feed_visibility":{"type":"string","x-stream-index":"003.003"},"fid":{"type":"string","x-stream-index":"003.002"},"reaction":{"$ref":"#/components/schemas/FeedsReactionResponse","description":"The reaction that was updated","title":"Reaction","x-stream-index":"002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.001.004"},"type":{"default":"feeds.activity.reaction.updated","description":"The type of event: \"feeds.activity.reaction.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"003.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who updated the reaction","title":"User","x-stream-index":"004.001"}},"required":["activity","reaction","type","created_at","custom","fid"],"title":"ActivityReactionUpdatedEvent","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"},"ActivityRemovedFromFeedEvent":{"description":"Emitted when an activity is removed from a feed.","nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"type":"string","x-stream-index":"002.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.activity.removed_from_feed","description":"The type of event: \"feeds.activity.removed_from_feed\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who removed the activity","title":"User","x-stream-index":"003.001"}},"required":["activity","type","created_at","custom","fid"],"title":"ActivityRemovedFromFeedEvent","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"},"ActivityRequest":{"properties":{"attachments":{"description":"List of attachments for the activity","items":{"$ref":"#/components/schemas/Attachment"},"title":"Attachments","type":"array","x-stream-index":"006"},"custom":{"additionalProperties":{},"description":"Custom data for the activity","title":"Custom Data","type":"object","x-stream-index":"017"},"expires_at":{"description":"Expiration time for the activity","title":"Expires At","type":"string","x-stream-index":"010"},"feeds":{"description":"List of feed IDs to add the activity to","items":{"type":"string"},"maximum":255,"minimum":1,"title":"Feed IDs","type":"array","x-stream-index":"004"},"filter_tags":{"description":"Tags for filtering activities","items":{"type":"string"},"maximum":255,"title":"Filter Tags","type":"array","x-stream-index":"013"},"id":{"description":"Optional ID for the activity","maxLength":255,"title":"Activity ID","type":"string","x-stream-index":"001"},"interest_tags":{"description":"Tags for indicating user interests","items":{"type":"string"},"maximum":255,"title":"Interest Tags","type":"array","x-stream-index":"014"},"location":{"$ref":"#/components/schemas/ActivityLocation","description":"Geographic location related to the activity","title":"Location","x-stream-index":"009"},"mentioned_user_ids":{"description":"List of users mentioned in the activity","items":{"type":"string"},"maximum":255,"title":"Mentioned User IDs","type":"array","x-stream-index":"011"},"parent_id":{"description":"ID of parent activity for replies/comments","maxLength":255,"title":"Parent ID","type":"string","x-stream-index":"015"},"poll_id":{"description":"ID of a poll to attach to activity","title":"Poll ID","type":"string","x-stream-index":"016"},"search_data":{"additionalProperties":{},"description":"Additional data for search indexing","title":"Search Data","type":"object","x-stream-index":"012"},"text":{"description":"Text content of the activity","title":"Text","type":"string","x-stream-index":"005"},"type":{"description":"Type of activity","maxLength":255,"title":"Activity Type","type":"string","x-stream-index":"002"},"visibility":{"description":"Visibility setting for the activity","enum":["public","private","tag"],"title":"Visibility","type":"string","x-stream-index":"007"},"visibility_tag":{"description":"If visibility is 'tag', this is the tag name and is required","maxLength":32,"title":"Visibility Tag","type":"string","x-stream-index":"008"}},"required":["type","feeds"],"title":"Activity Request","type":"object"},"ActivityResponse":{"properties":{"attachments":{"description":"Media attachments for the activity","items":{"$ref":"#/components/schemas/Attachment"},"title":"Attachments","type":"array","x-stream-index":"009"},"bookmark_count":{"description":"Number of bookmarks on the activity","format":"int32","title":"Bookmark Count","type":"integer","x-stream-index":"028"},"comment_count":{"description":"Number of comments on the activity","format":"int32","title":"Comment Count","type":"integer","x-stream-index":"027"},"comments":{"description":"Comments on this activity","items":{"$ref":"#/components/schemas/CommentResponse"},"title":"Comments","type":"array","x-stream-index":"015"},"created_at":{"description":"When the activity was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"007"},"current_feed":{"$ref":"#/components/schemas/FeedResponse","description":"Feed context for this activity view. If an activity is added only to one feed, it's always set. If an activity is added to multiple feeds, it's only set when calling the GetOrCreateFeed endpoint.","title":"Current Feed","x-stream-index":"035"},"custom":{"additionalProperties":{},"description":"Custom data for the activity","title":"Custom Data","type":"object","x-stream-index":"011"},"deleted_at":{"description":"When the activity was deleted","format":"date-time","title":"Deleted At","type":"number","x-stream-index":"021"},"edited_at":{"description":"When the activity was last edited","format":"date-time","title":"Edited At","type":"number","x-stream-index":"020"},"expires_at":{"description":"When the activity will expire","format":"date-time","title":"Expires At","type":"number","x-stream-index":"022"},"feeds":{"description":"List of feed IDs containing this activity","items":{"type":"string"},"title":"Feeds","type":"array","x-stream-index":"004"},"filter_tags":{"description":"Tags for filtering","items":{"type":"string"},"title":"Filter Tags","type":"array","x-stream-index":"024"},"hidden":{"description":"If this activity is hidden for this user. For premium content where you want to show a preview","title":"Hidden","type":"boolean","x-stream-index":"036"},"id":{"description":"Unique identifier for the activity","title":"ID","type":"string","x-stream-index":"001"},"interest_tags":{"description":"Tags for user interests","items":{"type":"string"},"title":"Interest Tags","type":"array","x-stream-index":"025"},"latest_reactions":{"description":"Recent reactions to the activity","items":{"$ref":"#/components/schemas/FeedsReactionResponse"},"title":"Latest Reactions","type":"array","x-stream-index":"031"},"location":{"$ref":"#/components/schemas/ActivityLocation","description":"Geographic location related to the activity","title":"Location","x-stream-index":"017"},"mentioned_users":{"description":"Users mentioned in the activity","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Mentioned Users","type":"array","x-stream-index":"010"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","description":"Moderation information","title":"Moderation","x-stream-index":"026"},"notification_context":{"additionalProperties":{},"description":"Notification context data for the activity (if this is a reaction, comment, follow, etc.)","title":"Notification Context","type":"object","x-stream-index":"012"},"own_bookmarks":{"description":"Current user's bookmarks for this activity","items":{"$ref":"#/components/schemas/BookmarkResponse"},"title":"Own Bookmarks","type":"array","x-stream-index":"034"},"own_reactions":{"description":"Current user's reactions to this activity","items":{"$ref":"#/components/schemas/FeedsReactionResponse"},"title":"Own Reactions","type":"array","x-stream-index":"033"},"parent":{"$ref":"#/components/schemas/ActivityResponse","description":"Parent activity (if this is a reply/comment)","title":"Parent","x-stream-index":"018"},"poll":{"$ref":"#/components/schemas/PollResponseData","description":"Poll attached to this activity","title":"Poll","x-stream-index":"019"},"popularity":{"description":"Popularity score of the activity","format":"int32","title":"Popularity","type":"integer","x-stream-index":"013"},"reaction_count":{"description":"Number of reactions to the activity","format":"int32","title":"Reaction Count","type":"integer","x-stream-index":"030"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"description":"Grouped reactions by type","title":"Reaction Groups","type":"object","x-stream-index":"032"},"score":{"description":"Ranking score for this activity","format":"float","title":"Score","type":"number","x-stream-index":"014"},"search_data":{"additionalProperties":{},"description":"Data for search indexing","title":"Search Data","type":"object","x-stream-index":"023"},"share_count":{"description":"Number of times the activity was shared","format":"int32","title":"Share Count","type":"integer","x-stream-index":"029"},"text":{"description":"Text content of the activity","title":"Text","type":"string","x-stream-index":"016"},"type":{"description":"Type of activity","title":"Type","type":"string","x-stream-index":"002"},"updated_at":{"description":"When the activity was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"008"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who created the activity","title":"User","x-stream-index":"003"},"visibility":{"description":"Visibility setting for the activity","enum":["public","private","tag"],"title":"Visibility","type":"string","x-stream-index":"005"},"visibility_tag":{"description":"If visibility is 'tag', this is the tag name","title":"Visibility Tag","type":"string","x-stream-index":"006"}},"required":["id","type","user","feeds","visibility","created_at","updated_at","attachments","mentioned_users","custom","popularity","score","comments","search_data","filter_tags","interest_tags","comment_count","bookmark_count","share_count","reaction_count","latest_reactions","reaction_groups","own_reactions","own_bookmarks"],"title":"Base Activity","type":"object"},"ActivitySelectorConfig":{"nullable":true,"properties":{"cutoff_time":{"format":"date-time","type":"number","x-stream-index":"004"},"filter":{"additionalProperties":{},"type":"object","x-stream-index":"002"},"min_popularity":{"format":"int32","type":"integer","x-stream-index":"005"},"sort":{"items":{"$ref":"#/components/schemas/SortParam"},"type":"array","x-stream-index":"003"},"type":{"type":"string","x-stream-index":"001"}},"required":["cutoff_time"],"type":"object"},"ActivityUnpinnedEvent":{"description":"Emitted when an activity is unpinned.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"description":"The ID of the feed","title":"Feed ID","type":"string","x-stream-index":"002.002"},"pinned_activity":{"$ref":"#/components/schemas/PinActivityResponse","x-stream-index":"001"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.activity.unpinned","description":"The type of event: \"feeds.activity.unpinned\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who unpinned the activity","title":"User","x-stream-index":"003.001"}},"required":["pinned_activity","type","created_at","custom","fid"],"title":"ActivityUnpinnedEvent","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"},"ActivityUpdatedEvent":{"description":"Emitted when an activity is updated.","nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","description":"The activity that was updated","title":"Activity","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"type":"string","x-stream-index":"002.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.activity.updated","description":"The type of the event","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who updated the activity","title":"User","x-stream-index":"003.001"}},"required":["activity","type","created_at","custom","fid"],"title":"ActivityUpdatedEvent","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"},"AddActivityRequest":{"nullable":true,"properties":{"attachments":{"description":"List of attachments for the activity","items":{"$ref":"#/components/schemas/Attachment"},"title":"Attachments","type":"array","x-stream-index":"001.006"},"custom":{"additionalProperties":{},"description":"Custom data for the activity","title":"Custom Data","type":"object","x-stream-index":"001.017"},"expires_at":{"description":"Expiration time for the activity","title":"Expires At","type":"string","x-stream-index":"001.010"},"feeds":{"description":"List of feed IDs to add the activity to","items":{"type":"string"},"maximum":255,"minimum":1,"title":"Feed IDs","type":"array","x-stream-index":"001.004"},"filter_tags":{"description":"Tags for filtering activities","items":{"type":"string"},"maximum":255,"title":"Filter Tags","type":"array","x-stream-index":"001.013"},"id":{"description":"Optional ID for the activity","maxLength":255,"title":"Activity ID","type":"string","x-stream-index":"001.001"},"interest_tags":{"description":"Tags for indicating user interests","items":{"type":"string"},"maximum":255,"title":"Interest Tags","type":"array","x-stream-index":"001.014"},"location":{"$ref":"#/components/schemas/ActivityLocation","description":"Geographic location related to the activity","title":"Location","x-stream-index":"001.009"},"mentioned_user_ids":{"description":"List of users mentioned in the activity","items":{"type":"string"},"maximum":255,"title":"Mentioned User IDs","type":"array","x-stream-index":"001.011"},"parent_id":{"description":"ID of parent activity for replies/comments","maxLength":255,"title":"Parent ID","type":"string","x-stream-index":"001.015"},"poll_id":{"description":"ID of a poll to attach to activity","title":"Poll ID","type":"string","x-stream-index":"001.016"},"search_data":{"additionalProperties":{},"description":"Additional data for search indexing","title":"Search Data","type":"object","x-stream-index":"001.012"},"text":{"description":"Text content of the activity","title":"Text","type":"string","x-stream-index":"001.005"},"type":{"description":"Type of activity","maxLength":255,"title":"Activity Type","type":"string","x-stream-index":"001.002"},"visibility":{"description":"Visibility setting for the activity","enum":["public","private","tag"],"title":"Visibility","type":"string","x-stream-index":"001.007"},"visibility_tag":{"description":"If visibility is 'tag', this is the tag name and is required","maxLength":32,"title":"Visibility Tag","type":"string","x-stream-index":"001.008"}},"required":["type","feeds"],"title":"Activity Request","type":"object"},"AddActivityResponse":{"nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","description":"The created activity","title":"Activity","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["activity","duration"],"title":"Add Activity Response","type":"object"},"AddBookmarkRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"description":"Custom data for the bookmark","title":"Custom Data","type":"object","x-stream-index":"004"},"folder_id":{"description":"ID of the folder to add the bookmark to","maxLength":255,"title":"Folder ID","type":"string","x-stream-index":"002"},"new_folder":{"$ref":"#/components/schemas/AddFolderRequest","description":"Create a new folder for this bookmark","title":"New Folder","x-stream-index":"003"}},"title":"Add Bookmark Request","type":"object"},"AddBookmarkResponse":{"nullable":true,"properties":{"bookmark":{"$ref":"#/components/schemas/BookmarkResponse","description":"The created bookmark","title":"Bookmark","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["bookmark","duration"],"title":"Add Bookmark Response","type":"object"},"AddCommentReactionRequest":{"nullable":true,"properties":{"create_notification_activity":{"description":"Whether to create a notification activity for this reaction","title":"boolean","type":"boolean","x-stream-index":"004"},"custom":{"additionalProperties":{},"description":"Optional custom data to add to the reaction","title":"object","type":"object","x-stream-index":"003"},"skip_push":{"type":"boolean","x-stream-index":"005"},"type":{"description":"The type of reaction, eg upvote, like, ...","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},"required":["type"],"type":"object"},"AddCommentReactionResponse":{"nullable":true,"properties":{"comment":{"$ref":"#/components/schemas/CommentResponse","description":"The comment the reaction was added to","title":"object","x-stream-index":"001"},"duration":{"description":"Duration of the request","title":"string","type":"string","x-stream-index":"003.001"},"reaction":{"$ref":"#/components/schemas/FeedsReactionResponse","description":"The created or updated reaction","title":"object","x-stream-index":"002"}},"required":["comment","reaction","duration"],"type":"object"},"AddCommentRequest":{"nullable":true,"properties":{"attachments":{"description":"Media attachments for the reply","items":{"$ref":"#/components/schemas/Attachment"},"title":"Attachments","type":"array","x-stream-index":"004"},"comment":{"description":"Text content of the comment","title":"Comment","type":"string","x-stream-index":"003"},"create_notification_activity":{"description":"Whether to create a notification activity for this comment","title":"Create Notification Activity","type":"boolean","x-stream-index":"008"},"custom":{"additionalProperties":{},"description":"Custom data for the comment","title":"Custom Data","type":"object","x-stream-index":"007"},"mentioned_user_ids":{"description":"List of users mentioned in the reply","items":{"type":"string"},"maximum":255,"title":"Mentioned User IDs","type":"array","x-stream-index":"005"},"object_id":{"description":"ID of the object to comment on","title":"Object ID","type":"string","x-stream-index":"001"},"object_type":{"description":"Type of the object to comment on","title":"Object Type","type":"string","x-stream-index":"002"},"parent_id":{"description":"ID of parent comment for replies","title":"Parent ID","type":"string","x-stream-index":"006"},"skip_push":{"type":"boolean","x-stream-index":"009"}},"required":["object_id","object_type","comment"],"title":"Add Comment Request","type":"object"},"AddCommentResponse":{"nullable":true,"properties":{"comment":{"$ref":"#/components/schemas/CommentResponse","description":"The created comment","title":"Comment","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["comment","duration"],"title":"Add Comment Response","type":"object"},"AddCommentsBatchRequest":{"nullable":true,"properties":{"comments":{"description":"List of comments to add","items":{"$ref":"#/components/schemas/AddCommentRequest"},"title":"Comments","type":"array","x-stream-index":"001"}},"required":["comments"],"title":"Add Comments Batch Request","type":"object"},"AddCommentsBatchResponse":{"nullable":true,"properties":{"comments":{"description":"List of comments added","items":{"$ref":"#/components/schemas/CommentResponse"},"title":"Comments","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["comments","duration"],"title":"Add Comments Batch Response","type":"object"},"AddFolderRequest":{"properties":{"custom":{"additionalProperties":{},"description":"Custom data for the folder","title":"Custom Data","type":"object","x-stream-index":"002"},"name":{"description":"Name of the folder","maxLength":255,"title":"Name","type":"string","x-stream-index":"001"}},"required":["name"],"title":"Add Folder Request","type":"object"},"AddReactionRequest":{"nullable":true,"properties":{"create_notification_activity":{"description":"Whether to create a notification activity for this reaction","title":"Create Notification Activity","type":"boolean","x-stream-index":"004"},"custom":{"additionalProperties":{},"description":"Custom data for the reaction","title":"Custom Data","type":"object","x-stream-index":"003"},"skip_push":{"type":"boolean","x-stream-index":"005"},"type":{"description":"Type of reaction","maxLength":255,"title":"Reaction Type","type":"string","x-stream-index":"002"}},"required":["type"],"title":"Add Reaction Request","type":"object"},"AddReactionResponse":{"nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"reaction":{"$ref":"#/components/schemas/FeedsReactionResponse","description":"The created reaction","title":"Reaction","x-stream-index":"002"}},"required":["activity","reaction","duration"],"title":"Add Reaction Response","type":"object"},"AggregatedActivityResponse":{"properties":{"activities":{"description":"List of activities in this aggregation","items":{"$ref":"#/components/schemas/ActivityResponse"},"title":"Activities","type":"array","x-stream-index":"001"},"activity_count":{"description":"Number of activities in this aggregation","format":"int32","title":"Activity Count","type":"integer","x-stream-index":"002"},"created_at":{"description":"When the aggregation was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"006"},"group":{"description":"Grouping identifier","title":"Group","type":"string","x-stream-index":"004"},"score":{"description":"Ranking score for this aggregation","format":"float","title":"Score","type":"number","x-stream-index":"005"},"updated_at":{"description":"When the aggregation was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"007"},"user_count":{"description":"Number of unique users in this aggregation","format":"int32","title":"User Count","type":"integer","x-stream-index":"003"}},"required":["activities","activity_count","user_count","group","score","created_at","updated_at"],"title":"Aggregated Activity","type":"object"},"AggregationConfig":{"properties":{"format":{"type":"string","x-stream-index":"001"},"group_size":{"format":"int32","type":"integer","x-stream-index":"002"}},"type":"object"},"AnyEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"*","type":"string","x-stream-index":"001.001"}},"required":["type","created_at"],"title":"AnyEvent","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"},"AppEventResponse":{"properties":{"async_url_enrich_enabled":{"description":"boolean","title":"Async URL Enrichment Enabled","type":"boolean","x-stream-index":"002"},"auto_translation_enabled":{"description":"boolean","title":"Auto Translation Enabled","type":"boolean","x-stream-index":"003"},"file_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","description":"file upload config","title":"File Upload Config","x-stream-index":"004"},"image_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","description":"file upload config","title":"Image Upload Config","x-stream-index":"005"},"name":{"description":"string","title":"App name","type":"string","x-stream-index":"001"}},"required":["name","auto_translation_enabled"],"type":"object"},"AppResponseFields":{"properties":{"async_url_enrich_enabled":{"type":"boolean","x-stream-index":"017"},"auto_translation_enabled":{"type":"boolean","x-stream-index":"020"},"file_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","x-stream-index":"030"},"image_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","x-stream-index":"031"},"name":{"type":"string","x-stream-index":"001"}},"required":["name","organization","push_notifications","webhook_url","moderation_webhook_url","channel_configs","call_types","policies","suspended","suspended_explanation","disable_auth_checks","disable_permissions_checks","permission_version","user_search_disallowed_roles","multi_tenant_enabled","image_moderation_enabled","async_url_enrich_enabled","auto_translation_enabled","custom_action_handler_url","enforce_unique_usernames","sqs_url","sqs_key","sqs_secret","sns_topic_arn","sns_key","sns_secret","file_upload_config","image_upload_config","grants","campaign_enabled","webhook_events","reminders_interval","cdn_expiration_seconds","video_provider","moderation_enabled","moderation_multitenant_blocklist_enabled","guest_user_creation_disabled","event_hooks","use_hook_v2","user_response_time_enabled","moderation_bulk_submit_action_enabled","moderation_llm_configurability_enabled"],"type":"object"},"AppUpdatedEvent":{"description":"Emitted when app settings are updated","nullable":true,"properties":{"app":{"$ref":"#/components/schemas/AppEventResponse","description":"application configuration","title":"App settings","x-stream-index":"002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"type":{"default":"app.updated","description":"The type of event: \"app.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.002"}},"required":["type","created_at","custom","app"],"title":"AppUpdatedEvent","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"},"Attachment":{"description":"An attachment is a message object that represents a file uploaded by a user.","nullable":true,"properties":{"actions":{"items":{"$ref":"#/components/schemas/Action"},"type":"array","x-stream-index":"015"},"asset_url":{"type":"string","x-stream-index":"017"},"author_icon":{"type":"string","x-stream-index":"007"},"author_link":{"type":"string","x-stream-index":"006"},"author_name":{"type":"string","x-stream-index":"005"},"color":{"type":"string","x-stream-index":"003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"018"},"fallback":{"type":"string","x-stream-index":"002"},"fields":{"items":{"$ref":"#/components/schemas/Field"},"type":"array","x-stream-index":"016"},"footer":{"type":"string","x-stream-index":"013"},"footer_icon":{"type":"string","x-stream-index":"014"},"giphy":{"$ref":"#/components/schemas/Images","x-stream-index":"019"},"image_url":{"type":"string","x-stream-index":"011"},"og_scrape_url":{"type":"string","x-stream-index":"020"},"original_height":{"format":"int32","type":"integer","x-stream-index":"022"},"original_width":{"format":"int32","type":"integer","x-stream-index":"021"},"pretext":{"type":"string","x-stream-index":"004"},"text":{"type":"string","x-stream-index":"010"},"thumb_url":{"type":"string","x-stream-index":"012"},"title":{"type":"string","x-stream-index":"008"},"title_link":{"type":"string","x-stream-index":"009"},"type":{"description":"Attachment type (e.g. image, video, url)","title":"Type","type":"string","x-stream-index":"001"}},"required":["custom"],"title":"Attachment","type":"object","x-stream-docs-page-id":"file_uploads"},"AudioSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"001"},"default_device":{"enum":["speaker","earpiece"],"type":"string","x-stream-index":"006"},"mic_default_on":{"type":"boolean","x-stream-index":"004"},"noise_cancellation":{"$ref":"#/components/schemas/NoiseCancellationSettings","x-stream-index":"007"},"opus_dtx_enabled":{"type":"boolean","x-stream-index":"002"},"redundant_coding_enabled":{"type":"boolean","x-stream-index":"003"},"speaker_default_on":{"type":"boolean","x-stream-index":"005"}},"required":["access_request_enabled","opus_dtx_enabled","redundant_coding_enabled","mic_default_on","speaker_default_on","default_device"],"type":"object"},"AudioSettingsRequest":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"001"},"default_device":{"enum":["speaker","earpiece"],"type":"string","x-stream-index":"006"},"mic_default_on":{"type":"boolean","x-stream-index":"004"},"noise_cancellation":{"$ref":"#/components/schemas/NoiseCancellationSettings","x-stream-index":"007"},"opus_dtx_enabled":{"type":"boolean","x-stream-index":"002"},"redundant_coding_enabled":{"type":"boolean","x-stream-index":"003"},"speaker_default_on":{"type":"boolean","x-stream-index":"005"}},"required":["default_device"],"type":"object"},"AudioSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"001"},"default_device":{"enum":["speaker","earpiece"],"type":"string","x-stream-index":"006"},"mic_default_on":{"type":"boolean","x-stream-index":"004"},"noise_cancellation":{"$ref":"#/components/schemas/NoiseCancellationSettings","x-stream-index":"007"},"opus_dtx_enabled":{"type":"boolean","x-stream-index":"002"},"redundant_coding_enabled":{"type":"boolean","x-stream-index":"003"},"speaker_default_on":{"type":"boolean","x-stream-index":"005"}},"required":["access_request_enabled","opus_dtx_enabled","redundant_coding_enabled","mic_default_on","speaker_default_on","default_device"],"type":"object"},"AutomodDetails":{"properties":{"action":{"type":"string","x-stream-index":"001"},"image_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"005"},"message_details":{"$ref":"#/components/schemas/FlagMessageDetails","x-stream-index":"004"},"original_message_type":{"type":"string","x-stream-index":"002"},"result":{"$ref":"#/components/schemas/MessageModerationResult","x-stream-index":"003"}},"type":"object"},"AutomodPlatformCircumventionConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AutomodRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"AutomodRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"003"},"label":{"type":"string","x-stream-index":"001"},"threshold":{"format":"float","maximum":1,"minimum":0,"type":"number","x-stream-index":"002"}},"required":["label","threshold","action"],"type":"object"},"AutomodSemanticFiltersConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AutomodSemanticFiltersRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"AutomodSemanticFiltersRule":{"properties":{"action":{"enum":["flag","shadow","remove"],"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"threshold":{"format":"float","maximum":1,"minimum":0,"type":"number","x-stream-index":"002"}},"required":["name","threshold","action"],"type":"object"},"AutomodToxicityConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AutomodRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"BackstageSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"BackstageSettingsRequest":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"002"}},"type":"object"},"BackstageSettingsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"Ban":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"012"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"011"},"expires":{"format":"date-time","type":"number","x-stream-index":"007"},"reason":{"type":"string","x-stream-index":"008"},"shadow":{"type":"boolean","x-stream-index":"009"},"target":{"$ref":"#/components/schemas/User","x-stream-index":"006"}},"required":["shadow","created_at"],"type":"object"},"BanActionRequest":{"properties":{"channel_ban_only":{"type":"boolean","x-stream-index":"003"},"delete_messages":{"enum":["soft","pruning","hard"],"type":"string","x-stream-index":"005"},"ip_ban":{"type":"boolean","x-stream-index":"004"},"reason":{"type":"string","x-stream-index":"002"},"shadow":{"type":"boolean","x-stream-index":"001"},"timeout":{"format":"int32","type":"integer","x-stream-index":"006"}},"type":"object"},"BanOptions":{"properties":{"duration":{"format":"int32","type":"integer","x-stream-index":"001"},"ip_ban":{"type":"boolean","x-stream-index":"004"},"reason":{"type":"string","x-stream-index":"002"},"shadow_ban":{"type":"boolean","x-stream-index":"003"}},"type":"object"},"BanRequest":{"nullable":true,"properties":{"banned_by":{"$ref":"#/components/schemas/UserRequest","description":"Details about the user performing the ban","title":"Banned By","x-stream-index":"008"},"banned_by_id":{"description":"ID of the user performing the ban","title":"Banned By ID","type":"string","x-stream-index":"007"},"channel_cid":{"description":"Channel where the ban applies","title":"Channel CID","type":"string","x-stream-index":"004"},"delete_messages":{"enum":["soft","pruning","hard"],"type":"string","x-stream-index":"009"},"ip_ban":{"description":"Whether to ban the user's IP address","title":"IP Ban","type":"boolean","x-stream-index":"006"},"reason":{"description":"Optional explanation for the ban","title":"Reason","type":"string","x-stream-index":"003"},"shadow":{"description":"Whether this is a shadow ban","title":"Shadow","type":"boolean","x-stream-index":"005"},"target_user_id":{"description":"ID of the user to ban","title":"Target User ID","type":"string","x-stream-index":"001"},"timeout":{"description":"Duration of the ban in minutes","minimum":0,"title":"Timeout","type":"integer","x-stream-index":"002"}},"required":["target_user_id"],"type":"object"},"BanResponse":{"nullable":true,"properties":{"banned_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"006"},"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"expires":{"format":"date-time","type":"number","x-stream-index":"003"},"reason":{"type":"string","x-stream-index":"004"},"shadow":{"type":"boolean","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"}},"required":["created_at"],"type":"object"},"BlockContentOptions":{"properties":{"reason":{"type":"string","x-stream-index":"001"}},"type":"object"},"BlockListConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/BlockListRule"},"maximum":10,"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"BlockListOptions":{"properties":{"behavior":{"description":"Blocklist behavior","enum":["flag","block","shadow_block"],"title":"Behavior","type":"string","x-stream-index":"002"},"blocklist":{"description":"Blocklist name","title":"Blocklist","type":"string","x-stream-index":"001"}},"required":["blocklist","behavior"],"type":"object"},"BlockListResponse":{"description":"Block list contains restricted words","properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001"},"id":{"type":"string","x-stream-index":"003"},"name":{"description":"Block list name","title":"Name","type":"string","x-stream-index":"004"},"team":{"type":"string","x-stream-index":"007"},"type":{"description":"Block list type.","title":"Type","type":"string","x-stream-index":"005"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"002"},"words":{"description":"List of words to block","items":{"type":"string"},"title":"Words","type":"array","x-stream-index":"006"}},"required":["name","type","words"],"title":"Block list","type":"object","x-stream-docs-page-id":"block_lists"},"BlockListRule":{"properties":{"action":{"enum":["flag","mask_flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"002"}},"required":["name","team","action"],"type":"object"},"BlockUserRequest":{"description":"BlockUserRequest is the payload for blocking a user.","nullable":true,"properties":{"user_id":{"description":"the user to block","title":"UserID","type":"string","x-stream-index":"003"}},"required":["user_id"],"title":"BlockUserRequest","type":"object"},"BlockUserResponse":{"description":"BlockUserResponse is the payload for blocking a user.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"BlockUserResponse","type":"object"},"BlockUsersRequest":{"nullable":true,"properties":{"blocked_user_id":{"description":"User id to block","title":"BlockedUserID","type":"string","x-stream-index":"001"}},"required":["blocked_user_id"],"type":"object"},"BlockUsersResponse":{"nullable":true,"properties":{"blocked_by_user_id":{"description":"User id who blocked another user","title":"BlockedByUserID","type":"string","x-stream-index":"002"},"blocked_user_id":{"description":"User id who got blocked","title":"BlockedUserID","type":"string","x-stream-index":"003"},"created_at":{"description":"Timestamp when the user was blocked","format":"date-time","title":"CreatedAt","type":"number","x-stream-index":"004"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration","blocked_by_user_id","blocked_user_id","created_at"],"type":"object"},"BlockedUserEvent":{"description":"This event is sent to call participants to notify when a user is blocked on a call, clients can use this event to show a notification.\nIf the user is the current user, the client should leave the call screen as well","properties":{"blocked_by_user":{"$ref":"#/components/schemas/UserResponse","description":"The user that blocked the user, null if the user was blocked by server-side","title":"Blocked by","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.blocked_user","description":"The type of event: \"call.blocked_user\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user that was blocked","title":"User","x-stream-index":"003"}},"required":["type","created_at","call_cid","user"],"title":"BlockedUserEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"BlockedUserResponse":{"nullable":true,"properties":{"blocked_user":{"$ref":"#/components/schemas/UserResponse","description":"User who got blocked","title":"User","x-stream-index":"003"},"blocked_user_id":{"description":"ID of the user who got blocked","title":"UserID","type":"string","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who blocked another user","title":"User","x-stream-index":"001"},"user_id":{"description":"ID of the user who blocked another user","title":"UserID","type":"string","x-stream-index":"002"}},"required":["user","user_id","blocked_user","blocked_user_id","created_at"],"type":"object"},"BodyguardRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"},"severity_rules":{"items":{"$ref":"#/components/schemas/BodyguardSeverityRule"},"type":"array","x-stream-index":"003"}},"required":["label","action","severity_rules"],"type":"object"},"BodyguardSeverityRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"severity":{"enum":["low","medium","high","critical"],"type":"string","x-stream-index":"001"}},"required":["severity","action"],"type":"object"},"BookmarkAddedEvent":{"description":"Emitted when a user bookmarks an activity.","nullable":true,"properties":{"bookmark":{"$ref":"#/components/schemas/BookmarkResponse","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.bookmark.added","description":"The type of event: \"feeds.bookmark.added\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who added the bookmark","title":"User","x-stream-index":"003.001"}},"required":["bookmark","type","created_at","custom"],"title":"BookmarkAddedEvent","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"},"BookmarkDeletedEvent":{"description":"Emitted when a user deletes a bookmark from an activity.","nullable":true,"properties":{"bookmark":{"$ref":"#/components/schemas/BookmarkResponse","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.bookmark.deleted","description":"The type of event: \"feeds.bookmark.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who removed the bookmark","title":"User","x-stream-index":"003.001"}},"required":["bookmark","type","created_at","custom"],"title":"BookmarkDeletedEvent","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"},"BookmarkFolderDeletedEvent":{"description":"Emitted when a bookmark folder is deleted.","nullable":true,"properties":{"bookmark_folder":{"$ref":"#/components/schemas/BookmarkFolderResponse","description":"The bookmark folder that was deleted","title":"Bookmark Folder","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.bookmark_folder.deleted","description":"The type of event: \"feeds.bookmark_folder.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who deleted the bookmark folder","title":"User","x-stream-index":"003.001"}},"required":["bookmark_folder","type","created_at","custom"],"title":"BookmarkFolderDeletedEvent","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"},"BookmarkFolderResponse":{"properties":{"created_at":{"description":"When the folder was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"004"},"custom":{"additionalProperties":{},"description":"Custom data for the folder","title":"Custom Data","type":"object","x-stream-index":"003"},"id":{"description":"Unique identifier for the folder","title":"ID","type":"string","x-stream-index":"001"},"name":{"description":"Name of the folder","title":"Name","type":"string","x-stream-index":"002"},"updated_at":{"description":"When the folder was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"005"}},"required":["id","name","created_at","updated_at"],"title":"Bookmark Folder","type":"object"},"BookmarkFolderUpdatedEvent":{"description":"Emitted when a bookmark folder is updated.","nullable":true,"properties":{"bookmark_folder":{"$ref":"#/components/schemas/BookmarkFolderResponse","description":"The bookmark folder that was updated","title":"Bookmark Folder","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.bookmark_folder.updated","description":"The type of event: \"feeds.bookmark_folder.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who updated the bookmark folder","title":"User","x-stream-index":"003.001"}},"required":["bookmark_folder","type","created_at","custom"],"title":"BookmarkFolderUpdatedEvent","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"},"BookmarkResponse":{"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","description":"The bookmarked activity","title":"Activity","x-stream-index":"002"},"created_at":{"description":"When the bookmark was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"005"},"custom":{"additionalProperties":{},"description":"Custom data for the bookmark","title":"Custom Data","type":"object","x-stream-index":"004"},"folder":{"$ref":"#/components/schemas/BookmarkFolderResponse","description":"Folder containing this bookmark","title":"Folder","x-stream-index":"003"},"updated_at":{"description":"When the bookmark was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"006"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who created the bookmark","title":"User","x-stream-index":"001"}},"required":["user","activity","created_at","updated_at"],"title":"Bookmark","type":"object"},"BookmarkUpdatedEvent":{"description":"Emitted when a user updates a bookmark.","nullable":true,"properties":{"bookmark":{"$ref":"#/components/schemas/BookmarkResponse","description":"The updated bookmark","title":"Bookmark","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.bookmark.updated","description":"The type of event: \"feeds.bookmark.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who updated the bookmark","title":"User","x-stream-index":"003.001"}},"required":["bookmark","type","created_at","custom"],"title":"BookmarkUpdatedEvent","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"},"Bound":{"properties":{"inclusive":{"type":"boolean","x-stream-index":"002"},"value":{"format":"float","type":"number","x-stream-index":"001"}},"required":["value","inclusive"],"type":"object"},"BroadcastSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettings","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettings","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"BroadcastSettingsRequest":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettingsRequest","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettingsRequest","x-stream-index":"003"}},"type":"object"},"BroadcastSettingsResponse":{"description":"BroadcastSettingsResponse is the payload for broadcasting settings","properties":{"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettingsResponse","title":"HLS","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettingsResponse","title":"RTMP","x-stream-index":"003"}},"required":["enabled","hls","rtmp"],"title":"BroadcastSettingsResponse","type":"object"},"Call":{"properties":{"AppPK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"002"},"Backstage":{"type":"boolean","writeOnly":true,"x-stream-index":"023"},"BlockedUserIDs":{"items":{"type":"string"},"type":"array","writeOnly":true,"x-stream-index":"018"},"BlockedUsers":{"items":{"$ref":"#/components/schemas/User"},"type":"array","writeOnly":true,"x-stream-index":"019"},"CID":{"type":"string","writeOnly":true,"x-stream-index":"005"},"CallType":{"$ref":"#/components/schemas/CallType","x-stream-index":"020"},"ChannelCID":{"type":"string","writeOnly":true,"x-stream-index":"032"},"CreatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"013"},"CreatedBy":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"CreatedByUserID":{"type":"string","writeOnly":true,"x-stream-index":"007"},"CurrentSessionID":{"type":"string","writeOnly":true,"x-stream-index":"024"},"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"012"},"DeletedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"028"},"EgressUpdatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"027"},"Egresses":{"items":{"$ref":"#/components/schemas/CallEgress"},"type":"array","writeOnly":true,"x-stream-index":"015"},"EndedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"017"},"ID":{"type":"string","writeOnly":true,"x-stream-index":"004"},"JoinAheadTimeSeconds":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"031"},"LastHeartbeatAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"030"},"LastSessionID":{"type":"string","writeOnly":true,"x-stream-index":"025"},"MemberCount":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"010"},"MemberLookup":{"$ref":"#/components/schemas/MemberLookup","x-stream-index":"011"},"Members":{"items":{"$ref":"#/components/schemas/CallMember"},"type":"array","writeOnly":true,"x-stream-index":"009"},"Session":{"$ref":"#/components/schemas/CallSession","x-stream-index":"026"},"Settings":{"$ref":"#/components/schemas/CallSettings","x-stream-index":"022"},"SettingsOverrides":{"$ref":"#/components/schemas/CallSettings","x-stream-index":"021"},"StartsAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"016"},"Team":{"type":"string","writeOnly":true,"x-stream-index":"006"},"ThumbnailURL":{"type":"string","writeOnly":true,"x-stream-index":"029"},"Type":{"type":"string","writeOnly":true,"x-stream-index":"003"},"UpdatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"014"}},"required":["AppPK","Type","ID","CID","Team","CreatedByUserID","Members","Custom","CreatedAt","UpdatedAt","Egresses","BlockedUserIDs","BlockedUsers","Backstage","CurrentSessionID","LastSessionID","ThumbnailURL","ChannelCID"],"type":"object"},"CallAcceptedEvent":{"description":"This event is sent when a user accepts a notification to join a call.","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.accepted","description":"The type of event: \"call.accepted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who accepted the call","title":"User","x-stream-index":"004"}},"required":["type","created_at","call_cid","call","user"],"title":"CallAcceptedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallClosedCaption":{"description":"CallClosedCaption represents a closed caption of a call.","properties":{"end_time":{"format":"date-time","title":"The end time of the closed caption.","type":"number","x-stream-index":"003"},"speaker_id":{"title":"The speaker ID of the closed caption.","type":"string","x-stream-index":"004"},"start_time":{"format":"date-time","title":"The start time of the closed caption.","type":"number","x-stream-index":"002"},"text":{"title":"The text of the closed caption.","type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserResponse","title":"The full user for the closed caption.","x-stream-index":"005"}},"required":["text","start_time","end_time","speaker_id","user"],"title":"CallClosedCaption","type":"object"},"CallClosedCaptionsFailedEvent":{"description":"This event is sent when call closed captions has failed","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.closed_captions_failed","description":"The type of event: \"call.closed_captions_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallClosedCaptionsFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallClosedCaptionsStartedEvent":{"description":"This event is sent when call closed caption has started","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.closed_captions_started","description":"The type of event: \"call.closed_captions_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallClosedCaptionsStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallClosedCaptionsStoppedEvent":{"description":"This event is sent when call closed captions has stopped","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.closed_captions_stopped","description":"The type of event: \"call.transcription_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallClosedCaptionsStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallCreatedEvent":{"description":"This event is sent when a call is created. Clients receiving this event should check if the ringing\nfield is set to true and if so, show the call screen","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"the members added to this call","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"004"},"type":{"default":"call.created","description":"The type of event: \"call.created\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","members"],"title":"CallCreatedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallDeletedEvent":{"description":"This event is sent when a call is deleted. Clients receiving this event should leave the call screen","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.deleted","description":"The type of event: \"call.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call"],"title":"CallDeletedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallDurationReport":{"properties":{"histogram":{"items":{"$ref":"#/components/schemas/ReportByHistogramBucket"},"type":"array","x-stream-index":"001"}},"required":["histogram"],"type":"object"},"CallDurationReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateCallDurationReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"CallEgress":{"nullable":true,"properties":{"app_pk":{"format":"int32","type":"integer","x-stream-index":"002"},"call_id":{"type":"string","x-stream-index":"004"},"call_type":{"type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/EgressTaskConfig","x-stream-index":"007"},"egress_id":{"type":"string","x-stream-index":"005"},"egress_type":{"type":"string","x-stream-index":"006"},"instance_ip":{"type":"string","x-stream-index":"008"},"started_at":{"format":"date-time","type":"number","x-stream-index":"010"},"state":{"type":"string","x-stream-index":"009"},"stopped_at":{"format":"date-time","type":"number","x-stream-index":"011"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"012"}},"required":["app_pk","call_type","call_id","egress_id","egress_type","instance_ip","state","started_at","updated_at"],"type":"object"},"CallEndedEvent":{"description":"This event is sent when a call is mark as ended for all its participants. Clients receiving this event should leave the call screen","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"reason":{"description":"The reason why the call ended, if available","title":"CallEndedReason","type":"string","x-stream-index":"005"},"type":{"default":"call.ended","description":"The type of event: \"call.ended\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who ended the call, null if the call was ended by the server","title":"User","x-stream-index":"004"}},"required":["type","created_at","call_cid","call"],"title":"CallEndedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallFrameRecordingFailedEvent":{"description":"This event is sent when frame recording has failed","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.frame_recording_failed","description":"The type of event: \"call.frame_recording_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","egress_id"],"title":"CallFrameRecordingFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallFrameRecordingFrameReadyEvent":{"description":"This event is sent when a frame is captured from a call","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"captured_at":{"description":"The time the frame was captured","format":"date-time","title":"CapturedAt","type":"number","x-stream-index":"006"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"008"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"track_type":{"description":"The type of the track frame was captured from (TRACK_TYPE_VIDEO|TRACK_TYPE_SCREEN_SHARE)","title":"TrackType","type":"string","x-stream-index":"004"},"type":{"default":"call.frame_recording_ready","description":"The type of event: \"call.frame_recording_ready\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"url":{"description":"The URL of the frame","title":"URL","type":"string","x-stream-index":"005"},"users":{"additionalProperties":{"$ref":"#/components/schemas/UserResponse"},"description":"The users in the frame","title":"Users","type":"object","x-stream-index":"007"}},"required":["type","created_at","call_cid","session_id","track_type","url","captured_at","users","egress_id"],"title":"CallFrameRecordingFrameReadyEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallFrameRecordingStartedEvent":{"description":"This event is sent when frame recording has started","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.frame_recording_started","description":"The type of event: \"call.frame_recording_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","egress_id"],"title":"CallFrameRecordingStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallFrameRecordingStoppedEvent":{"description":"This event is sent when frame recording has stopped","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.frame_recording_stopped","description":"The type of event: \"call.frame_recording_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","egress_id"],"title":"CallFrameRecordingStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallHLSBroadcastingFailedEvent":{"description":"This event is sent when HLS broadcasting has failed","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.hls_broadcasting_failed","description":"The type of event: \"call.hls_broadcasting_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallHLSBroadcastingFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallHLSBroadcastingStartedEvent":{"description":"This event is sent when HLS broadcasting has started","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"hls_playlist_url":{"type":"string","x-stream-index":"004"},"type":{"default":"call.hls_broadcasting_started","description":"The type of event: \"call.hls_broadcasting_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","hls_playlist_url"],"title":"CallHLSBroadcastingStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallHLSBroadcastingStoppedEvent":{"description":"This event is sent when HLS broadcasting has stopped","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.hls_broadcasting_stopped","description":"The type of event: \"call.hls_broadcasting_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallHLSBroadcastingStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallIngressResponse":{"description":"CallIngressResponse is the payload for ingress settings","properties":{"rtmp":{"$ref":"#/components/schemas/RTMPIngress","title":"RTMP","x-stream-index":"001"}},"required":["rtmp"],"title":"CallIngressResponse","type":"object"},"CallLiveStartedEvent":{"description":"This event is sent when a call is started. Clients receiving this event should start the call.","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.live_started","description":"The type of event: \"call.live_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call"],"title":"CallLiveStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMember":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"010"},"role":{"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["user_id","role","custom","created_at","updated_at"],"type":"object"},"CallMemberAddedEvent":{"description":"This event is sent when one or more members are added to a call","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"the members added to this call","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"004"},"type":{"default":"call.member_added","description":"The type of event: \"call.member_added\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","members"],"title":"CallMemberAddedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMemberRemovedEvent":{"description":"This event is sent when one or more members are removed from a call","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"the list of member IDs removed from the call","items":{"type":"string"},"title":"Members","type":"array","x-stream-index":"004"},"type":{"default":"call.member_removed","description":"The type of event: \"call.member_removed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","members"],"title":"CallMemberRemovedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMemberUpdatedEvent":{"description":"This event is sent when one or more members are updated","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"The list of members that were updated","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"004"},"type":{"default":"call.member_updated","description":"The type of event: \"call.member_updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","members"],"title":"CallMemberUpdatedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMemberUpdatedPermissionEvent":{"description":"This event is sent when one or more members get its role updated","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"capabilities_by_role":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"The capabilities by role for this call","title":"CapabilitiesByRole","type":"object","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"The list of members that were updated","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"005"},"type":{"default":"call.member_updated_permission","description":"The type of event: \"call.member_added\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","capabilities_by_role","members"],"title":"CallMemberUpdatedPermissionEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMissedEvent":{"description":"This event is sent to call members who did not accept/reject/join the call to notify they missed the call","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"List of members who missed the call","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"005"},"notify_user":{"type":"boolean","x-stream-index":"007"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.missed","description":"The type of event: \"call.notification\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The caller from whom the call was missed","title":"User","x-stream-index":"006"}},"required":["type","created_at","call_cid","session_id","call","members","user","notify_user"],"title":"CallMissedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallModerationBlurEvent":{"properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"type":{"default":"call.moderation_blur","type":"string","x-stream-index":"001.001"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["type","created_at","call_cid","user_id","custom"],"title":"CallModerationBlurEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallModerationWarningEvent":{"properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"message":{"type":"string","x-stream-index":"004"},"type":{"default":"call.moderation_warning","type":"string","x-stream-index":"001.001"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["type","created_at","call_cid","user_id","message","custom"],"title":"CallModerationWarningEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallNotificationEvent":{"description":"This event is sent to all call members to notify they are getting called","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"Call members","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"005"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.notification","description":"The type of event: \"call.notification\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user that sent the call notification","title":"User","x-stream-index":"006"}},"required":["type","created_at","call_cid","session_id","call","members","user"],"title":"CallNotificationEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallParticipant":{"nullable":true,"properties":{"JoinedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"004"},"Role":{"type":"string","writeOnly":true,"x-stream-index":"002"},"UserSessionID":{"type":"string","writeOnly":true,"x-stream-index":"003"},"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"001.046"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"001.017"},"banned":{"type":"boolean","x-stream-index":"001.016"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.013"},"id":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"001.023"},"language":{"type":"string","x-stream-index":"001.035"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"001.022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"001.026"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.042"},"role":{"type":"string","x-stream-index":"001.004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.005"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.009"}},"required":["id","role","teams_role","custom","banned","online","Role","UserSessionID","JoinedAt"],"type":"object"},"CallParticipantCountReport":{"properties":{"histogram":{"items":{"$ref":"#/components/schemas/ReportByHistogramBucket"},"type":"array","x-stream-index":"001"}},"required":["histogram"],"type":"object"},"CallParticipantCountReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateCallParticipantCountReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"CallParticipantResponse":{"properties":{"joined_at":{"format":"date-time","type":"number","x-stream-index":"004"},"role":{"type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"},"user_session_id":{"type":"string","x-stream-index":"002"}},"required":["user","user_session_id","role","joined_at"],"type":"object"},"CallReactionEvent":{"description":"This event is sent when a reaction is sent in a call, clients should use this to show the reaction in the call screen","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"reaction":{"$ref":"#/components/schemas/ReactionResponse","description":"the reaction object sent by the user on the call","title":"reaction","x-stream-index":"003"},"type":{"default":"call.reaction_new","description":"The type of event: \"call.reaction_new\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","reaction"],"title":"CallReactionEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRecording":{"description":"CallRecording represents a recording of a call.","properties":{"end_time":{"format":"date-time","title":"The end time of the recording.","type":"number","x-stream-index":"004"},"filename":{"title":"The filename of the recording.","type":"string","x-stream-index":"001"},"session_id":{"title":"The session ID of the recording.","type":"string","x-stream-index":"005"},"start_time":{"format":"date-time","title":"The start time of the recording.","type":"number","x-stream-index":"003"},"url":{"title":"The URL of the recording.","type":"string","x-stream-index":"002"}},"required":["filename","url","start_time","end_time","session_id"],"title":"CallRecording","type":"object"},"CallRecordingFailedEvent":{"description":"This event is sent when call recording has failed","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"003"},"type":{"default":"call.recording_failed","description":"The type of event: \"call.recording_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","egress_id"],"title":"CallRecordingFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRecordingReadyEvent":{"description":"This event is sent when call recording is ready","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"call_recording":{"$ref":"#/components/schemas/CallRecording","description":"The call recording object","title":"CallRecording","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.recording_ready","description":"The type of event: \"call.recording_ready\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call_recording","egress_id"],"title":"CallRecordingReadyEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRecordingStartedEvent":{"description":"This event is sent when call recording has started","properties":{"call_cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"egress_id":{"type":"string","x-stream-index":"001"},"type":{"default":"call.recording_started","description":"The type of event: \"call.recording_started\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001"}},"required":["egress_id","type","created_at","call_cid"],"title":"CallRecordingStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRecordingStoppedEvent":{"description":"This event is sent when call recording has stopped","properties":{"call_cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"egress_id":{"type":"string","x-stream-index":"001"},"type":{"default":"call.recording_stopped","description":"The type of event: \"call.recording_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001"}},"required":["egress_id","type","created_at","call_cid"],"title":"CallRecordingStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRejectedEvent":{"description":"This event is sent when a user rejects a notification to join a call.","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"reason":{"description":"Provides information about why the call was rejected. You can provide any value, but the Stream API and SDKs use these default values: rejected, cancel, timeout and busy","title":"Reason","type":"string","x-stream-index":"005"},"type":{"default":"call.rejected","description":"The type of event: \"call.rejected\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who rejected the call","title":"User","x-stream-index":"004"}},"required":["type","created_at","call_cid","call","user"],"title":"CallRejectedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallReportResponse":{"properties":{"ended_at":{"format":"date-time","type":"number","x-stream-index":"003"},"score":{"format":"float","type":"number","x-stream-index":"001"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002"}},"required":["score"],"type":"object"},"CallRequest":{"description":"CallRequest is the payload for creating a call.","properties":{"channel_cid":{"type":"string","x-stream-index":"009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"members":{"items":{"$ref":"#/components/schemas/MemberRequest"},"maximum":100,"type":"array","x-stream-index":"005"},"settings_override":{"$ref":"#/components/schemas/CallSettingsRequest","x-stream-index":"006"},"starts_at":{"format":"date-time","type":"number","x-stream-index":"007"},"team":{"type":"string","x-stream-index":"001"},"video":{"type":"boolean","x-stream-index":"008"}},"title":"CallRequest","type":"object"},"CallResponse":{"description":"Represents a call","properties":{"backstage":{"type":"boolean","x-stream-index":"016"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"018"},"captioning":{"type":"boolean","x-stream-index":"013"},"channel_cid":{"type":"string","x-stream-index":"024"},"cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"The user that created the call","title":"Created By","x-stream-index":"007"},"current_session_id":{"type":"string","x-stream-index":"005"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"008"},"egress":{"$ref":"#/components/schemas/EgressResponse","x-stream-index":"021"},"ended_at":{"description":"Date/time when the call ended","format":"date-time","title":"Ended At","type":"number","x-stream-index":"014"},"id":{"description":"Call ID","title":"ID","type":"string","x-stream-index":"003"},"ingress":{"$ref":"#/components/schemas/CallIngressResponse","x-stream-index":"019"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"023"},"recording":{"type":"boolean","x-stream-index":"011"},"session":{"$ref":"#/components/schemas/CallSessionResponse","x-stream-index":"020"},"settings":{"$ref":"#/components/schemas/CallSettingsResponse","x-stream-index":"017"},"starts_at":{"description":"Date/time when the call will start","format":"date-time","title":"Starts At","type":"number","x-stream-index":"015"},"team":{"type":"string","x-stream-index":"006"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailResponse","x-stream-index":"022"},"transcribing":{"type":"boolean","x-stream-index":"012"},"type":{"description":"The type of call","title":"Type","type":"string","x-stream-index":"002"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"}},"required":["type","id","cid","current_session_id","created_by","custom","created_at","updated_at","recording","transcribing","captioning","backstage","settings","blocked_user_ids","ingress","egress"],"title":"CallResponse","type":"object"},"CallRingEvent":{"description":"This event is sent to all call members to notify they are getting called","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"005"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"Call members","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"006"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.ring","description":"The type of event: \"call.notification\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user that sent the call notification","title":"User","x-stream-index":"007"},"video":{"type":"boolean","x-stream-index":"008"}},"required":["type","created_at","call_cid","session_id","call","members","user","video"],"title":"CallRingEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRtmpBroadcastFailedEvent":{"description":"This event is sent when a call RTMP broadcast has failed","properties":{"call_cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"002.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.002"},"name":{"description":"Name of the given RTMP broadcast","title":"Name","type":"string","x-stream-index":"003"},"type":{"default":"call.rtmp_broadcast_failed","description":"The type of event: \"call.rtmp_broadcast_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","name"],"title":"CallRtmpBroadcastFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRtmpBroadcastStartedEvent":{"description":"This event is sent when RTMP broadcast has started","properties":{"call_cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"002.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.002"},"name":{"description":"Name of the given RTMP broadcast","title":"Name","type":"string","x-stream-index":"003"},"type":{"default":"call.rtmp_broadcast_started","description":"The type of event: \"call.rtmp_broadcast_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","name"],"title":"CallRtmpBroadcastStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRtmpBroadcastStoppedEvent":{"description":"This event is sent when RTMP broadcast has stopped","properties":{"call_cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"002.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.002"},"name":{"description":"Name of the given RTMP broadcast","title":"Name","type":"string","x-stream-index":"003"},"type":{"default":"call.rtmp_broadcast_stopped","description":"The type of event: \"call.rtmp_broadcast_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","name"],"title":"CallRtmpBroadcastStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSession":{"properties":{"AcceptedBy":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","writeOnly":true,"x-stream-index":"008"},"ActiveSFUs":{"items":{"$ref":"#/components/schemas/SFUIDLastSeen"},"type":"array","writeOnly":true,"x-stream-index":"016"},"AnonymousParticipantCount":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"019"},"AppPK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"002.001"},"CallID":{"type":"string","writeOnly":true,"x-stream-index":"002.003"},"CallType":{"type":"string","writeOnly":true,"x-stream-index":"002.002"},"CreatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"003"},"DeletedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"004"},"EndedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"006"},"LiveEndedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"013"},"LiveStartedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"012"},"MissedBy":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","writeOnly":true,"x-stream-index":"010"},"Participants":{"items":{"$ref":"#/components/schemas/CallParticipant"},"type":"array","writeOnly":true,"x-stream-index":"011"},"ParticipantsCountByRole":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","writeOnly":true,"x-stream-index":"018"},"RejectedBy":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","writeOnly":true,"x-stream-index":"009"},"RingAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"007"},"SFUIDs":{"items":{"type":"string"},"type":"array","writeOnly":true,"x-stream-index":"015"},"SessionID":{"type":"string","writeOnly":true,"x-stream-index":"002.004"},"StartedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"005"},"TimerEndsAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"014"},"UserPermissionOverrides":{"additionalProperties":{"additionalProperties":{"type":"boolean"},"type":"object"},"type":"object","writeOnly":true,"x-stream-index":"017"}},"required":["AppPK","CallType","CallID","SessionID","CreatedAt","AcceptedBy","RejectedBy","MissedBy","Participants","SFUIDs","ActiveSFUs","UserPermissionOverrides","ParticipantsCountByRole","AnonymousParticipantCount"],"type":"object"},"CallSessionEndedEvent":{"description":"This event is sent when a call session ends","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_ended","description":"The type of event: \"call.session_ended\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","call"],"title":"CallSessionEndedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSessionParticipantCountsUpdatedEvent":{"description":"This event is sent when the participant counts in a call session are updated","properties":{"anonymous_participant_count":{"format":"int32","type":"integer","x-stream-index":"005"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"participants_count_by_role":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"004"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_participant_count_updated","description":"The type of event: \"call.session_participant_count_updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","participants_count_by_role","anonymous_participant_count"],"title":"CallSessionParticipantCountsUpdatedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSessionParticipantJoinedEvent":{"description":"This event is sent when a participant joins a call session","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"participant":{"$ref":"#/components/schemas/CallParticipantResponse","description":"The participant that joined the session","title":"Participant","x-stream-index":"004"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_participant_joined","description":"The type of event: \"call.session_participant_joined\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","participant"],"title":"CallSessionParticipantJoinedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSessionParticipantLeftEvent":{"description":"This event is sent when a participant leaves a call session","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"duration_seconds":{"description":"The duration participant was in the session in seconds","format":"int32","title":"Duration","type":"integer","x-stream-index":"005"},"participant":{"$ref":"#/components/schemas/CallParticipantResponse","description":"The participant that left the session","title":"Participant","x-stream-index":"004"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_participant_left","description":"The type of event: \"call.session_participant_left\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","participant","duration_seconds"],"title":"CallSessionParticipantLeftEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSessionResponse":{"properties":{"accepted_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"008"},"anonymous_participant_count":{"format":"int32","type":"integer","x-stream-index":"006"},"ended_at":{"format":"date-time","type":"number","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"live_ended_at":{"format":"date-time","type":"number","x-stream-index":"011"},"live_started_at":{"format":"date-time","type":"number","x-stream-index":"010"},"missed_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"009"},"participants":{"items":{"$ref":"#/components/schemas/CallParticipantResponse"},"type":"array","x-stream-index":"004"},"participants_count_by_role":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"005"},"rejected_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"007"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002"},"timer_ends_at":{"format":"date-time","type":"number","x-stream-index":"012"}},"required":["id","participants","participants_count_by_role","anonymous_participant_count","rejected_by","accepted_by","missed_by"],"type":"object"},"CallSessionStartedEvent":{"description":"This event is sent when a call session starts","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_started","description":"The type of event: \"call.session_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","call"],"title":"CallSessionStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSettings":{"properties":{"audio":{"$ref":"#/components/schemas/AudioSettings","x-stream-index":"001"},"backstage":{"$ref":"#/components/schemas/BackstageSettings","x-stream-index":"002"},"broadcasting":{"$ref":"#/components/schemas/BroadcastSettings","x-stream-index":"007"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordSettings","x-stream-index":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettings","x-stream-index":"008"},"ingress":{"$ref":"#/components/schemas/IngressSettings","x-stream-index":"014"},"limits":{"$ref":"#/components/schemas/LimitsSettings","x-stream-index":"012"},"recording":{"$ref":"#/components/schemas/RecordSettings","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettings","x-stream-index":"010"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettings","x-stream-index":"004"},"session":{"$ref":"#/components/schemas/SessionSettings","x-stream-index":"013"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettings","x-stream-index":"011"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettings","x-stream-index":"009"},"video":{"$ref":"#/components/schemas/VideoSettings","x-stream-index":"003"}},"type":"object"},"CallSettingsRequest":{"properties":{"audio":{"$ref":"#/components/schemas/AudioSettingsRequest","x-stream-index":"001"},"backstage":{"$ref":"#/components/schemas/BackstageSettingsRequest","x-stream-index":"002"},"broadcasting":{"$ref":"#/components/schemas/BroadcastSettingsRequest","x-stream-index":"010"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordingSettingsRequest","x-stream-index":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettingsRequest","x-stream-index":"003"},"ingress":{"$ref":"#/components/schemas/IngressSettingsRequest","x-stream-index":"014"},"limits":{"$ref":"#/components/schemas/LimitsSettingsRequest","x-stream-index":"012"},"recording":{"$ref":"#/components/schemas/RecordSettingsRequest","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettingsRequest","x-stream-index":"007"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettingsRequest","x-stream-index":"008"},"session":{"$ref":"#/components/schemas/SessionSettingsRequest","x-stream-index":"013"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettingsRequest","x-stream-index":"011"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettingsRequest","x-stream-index":"009"},"video":{"$ref":"#/components/schemas/VideoSettingsRequest","x-stream-index":"004"}},"type":"object"},"CallSettingsResponse":{"properties":{"audio":{"$ref":"#/components/schemas/AudioSettingsResponse","x-stream-index":"001"},"backstage":{"$ref":"#/components/schemas/BackstageSettingsResponse","x-stream-index":"002"},"broadcasting":{"$ref":"#/components/schemas/BroadcastSettingsResponse","x-stream-index":"003"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordingSettingsResponse","x-stream-index":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettingsResponse","x-stream-index":"004"},"ingress":{"$ref":"#/components/schemas/IngressSettingsResponse","x-stream-index":"014"},"limits":{"$ref":"#/components/schemas/LimitsSettingsResponse","x-stream-index":"012"},"recording":{"$ref":"#/components/schemas/RecordSettingsResponse","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettingsResponse","x-stream-index":"007"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettingsResponse","x-stream-index":"008"},"session":{"$ref":"#/components/schemas/SessionSettingsResponse","x-stream-index":"013"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettingsResponse","x-stream-index":"011"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettingsResponse","x-stream-index":"009"},"video":{"$ref":"#/components/schemas/VideoSettingsResponse","x-stream-index":"010"}},"required":["audio","backstage","broadcasting","geofencing","recording","frame_recording","ring","screensharing","transcription","video","thumbnails","limits","session"],"type":"object"},"CallStateResponseFields":{"description":"CallStateResponseFields is the payload for call state response","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001"},"members":{"description":"List of call members","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"002"},"membership":{"$ref":"#/components/schemas/MemberResponse","description":"Current user membership object","title":"Membership","x-stream-index":"003"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"004"}},"required":["call","members","own_capabilities","blocked_users"],"title":"CallStateResponseFields","type":"object"},"CallStatsReportReadyEvent":{"description":"This event is sent when the insights report is ready","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.stats_report_ready","description":"The type of event, \"call.report_ready\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id"],"title":"CallStatsReportReadyEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallStatsReportSummaryResponse":{"properties":{"call_cid":{"type":"string","x-stream-index":"001"},"call_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"008"},"call_session_id":{"type":"string","x-stream-index":"002"},"call_status":{"type":"string","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"first_stats_time":{"format":"date-time","type":"number","x-stream-index":"003"},"min_user_rating":{"format":"int32","type":"integer","x-stream-index":"006"},"quality_score":{"format":"int32","type":"integer","x-stream-index":"005"}},"required":["call_cid","call_session_id","first_stats_time","call_status","call_duration_seconds"],"type":"object"},"CallTranscription":{"description":"CallTranscription represents a transcription of a call.","properties":{"end_time":{"format":"date-time","title":"The end time of the transcription.","type":"number","x-stream-index":"004"},"filename":{"title":"The filename of the transcription.","type":"string","x-stream-index":"001"},"session_id":{"title":"The session ID of the transcription.","type":"string","x-stream-index":"005"},"start_time":{"format":"date-time","title":"The start time of the transcription.","type":"number","x-stream-index":"003"},"url":{"title":"The URL of the transcription.","type":"string","x-stream-index":"002"}},"required":["filename","url","start_time","end_time","session_id"],"title":"CallTranscription","type":"object"},"CallTranscriptionFailedEvent":{"description":"This event is sent when call transcription has failed","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"003"},"error":{"description":"The error message detailing why transcription failed.","title":"string","type":"string","x-stream-index":"004"},"type":{"default":"call.transcription_failed","description":"The type of event: \"call.transcription_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","egress_id"],"title":"CallTranscriptionFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallTranscriptionReadyEvent":{"description":"This event is sent when call transcription is ready","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"call_transcription":{"$ref":"#/components/schemas/CallTranscription","description":"The call transcription object","title":"CallTranscription","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.transcription_ready","description":"The type of event: \"call.transcription_ready\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call_transcription","egress_id"],"title":"CallTranscriptionReadyEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallTranscriptionStartedEvent":{"description":"This event is sent when call transcription has started","properties":{"call_cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"egress_id":{"type":"string","x-stream-index":"001"},"type":{"default":"call.transcription_started","description":"The type of event: \"call.transcription_started\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001"}},"required":["egress_id","type","created_at","call_cid"],"title":"CallTranscriptionStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallTranscriptionStoppedEvent":{"description":"This event is sent when call transcription has stopped","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"003"},"type":{"default":"call.transcription_stopped","description":"The type of event: \"call.transcription_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","egress_id"],"title":"CallTranscriptionStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallType":{"properties":{"AppPK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"003"},"CreatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"005"},"ExternalStorage":{"type":"string","writeOnly":true,"x-stream-index":"009"},"Name":{"type":"string","writeOnly":true,"x-stream-index":"004"},"NotificationSettings":{"$ref":"#/components/schemas/NotificationSettings","x-stream-index":"008"},"PK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"002"},"Settings":{"$ref":"#/components/schemas/CallSettings","x-stream-index":"007"},"UpdatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"006"}},"required":["PK","AppPK","Name","CreatedAt","UpdatedAt","ExternalStorage"],"type":"object"},"CallUpdatedEvent":{"description":"This event is sent when a call is updated, clients should use this update the local state of the call.\nThis event also contains the capabilities by role for the call, clients should update the own_capability for the current.","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"capabilities_by_role":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"The capabilities by role for this call","title":"CapabilitiesByRole","type":"object","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.updated","description":"The type of event: \"call.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","capabilities_by_role"],"title":"CallUpdatedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallUserFeedbackSubmittedEvent":{"description":"This event is sent when a user submits feedback for a call.","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"custom":{"additionalProperties":{},"description":"Custom data provided by the user","title":"Custom","type":"object","x-stream-index":"007"},"rating":{"description":"The rating given by the user (1-5)","format":"int32","title":"Rating","type":"integer","x-stream-index":"005"},"reason":{"description":"The reason provided by the user for the rating","title":"Reason","type":"string","x-stream-index":"006"},"sdk":{"type":"string","x-stream-index":"008"},"sdk_version":{"type":"string","x-stream-index":"009"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.user_feedback_submitted","description":"The type of event, \"call.user_feedback\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who submitted the feedback","title":"User","x-stream-index":"004"}},"required":["type","created_at","call_cid","session_id","user","rating"],"title":"CallUserFeedbackSubmittedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallUserMutedEvent":{"description":"This event is sent when a call member is muted","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"from_user_id":{"type":"string","x-stream-index":"003"},"muted_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"type":{"default":"call.user_muted","description":"The type of event: \"call.user_muted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","from_user_id","muted_user_ids"],"title":"CallUserMutedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallsPerDayReport":{"properties":{"count":{"format":"int64","type":"integer","x-stream-index":"001"}},"required":["count"],"type":"object"},"CallsPerDayReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateCallsPerDayReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"CastPollVoteRequest":{"nullable":true,"properties":{"vote":{"$ref":"#/components/schemas/VoteData","description":"Vote data","title":"VoteData","x-stream-index":"004"}},"type":"object"},"Channel":{"properties":{"active_live_locations":{"items":{"$ref":"#/components/schemas/SharedLocation"},"type":"array","x-stream-index":"034"},"auto_translation_enabled":{"type":"boolean","x-stream-index":"029"},"auto_translation_language":{"type":"string","x-stream-index":"030"},"cid":{"type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/ChannelConfig","x-stream-index":"026"},"config_overrides":{"$ref":"#/components/schemas/ConfigOverrides","x-stream-index":"027"},"cooldown":{"format":"int32","type":"integer","x-stream-index":"031"},"created_at":{"format":"date-time","type":"number","x-stream-index":"009"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"019"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"disabled":{"type":"boolean","x-stream-index":"017"},"frozen":{"type":"boolean","x-stream-index":"016"},"id":{"type":"string","x-stream-index":"004"},"invites":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"022"},"last_campaigns":{"type":"string","x-stream-index":"032"},"last_message_at":{"format":"date-time","type":"number","x-stream-index":"006"},"member_count":{"format":"int32","type":"integer","x-stream-index":"021"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"020"},"message_count":{"format":"int64","type":"integer","x-stream-index":"035"},"message_count_updated_at":{"format":"date-time","type":"number","x-stream-index":"036"},"team":{"type":"string","x-stream-index":"028"},"truncated_by":{"$ref":"#/components/schemas/User","x-stream-index":"015"},"type":{"type":"string","x-stream-index":"005"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"010"}},"required":["cid","id","type","created_at","updated_at","frozen","disabled","custom","auto_translation_language"],"type":"object"},"ChannelConfig":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.027"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.022"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.023"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.028"},"blocklist":{"type":"string","x-stream-index":"001.024"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.025"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.026"},"commands":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"connect_events":{"type":"boolean","x-stream-index":"001.004"},"count_messages":{"type":"boolean","x-stream-index":"001.019"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"custom_events":{"type":"boolean","x-stream-index":"001.012"},"mark_messages_pending":{"type":"boolean","x-stream-index":"001.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"001.021"},"mutes":{"type":"boolean","x-stream-index":"001.009"},"name":{"type":"string","x-stream-index":"001.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"001.029"},"partition_ttl":{"type":"integer","x-stream-index":"001.030"},"polls":{"type":"boolean","x-stream-index":"001.016"},"push_notifications":{"type":"boolean","x-stream-index":"001.013"},"quotes":{"type":"boolean","x-stream-index":"001.008"},"reactions":{"type":"boolean","x-stream-index":"001.006"},"read_events":{"type":"boolean","x-stream-index":"001.003"},"reminders":{"type":"boolean","x-stream-index":"001.014"},"replies":{"type":"boolean","x-stream-index":"001.007"},"search":{"type":"boolean","x-stream-index":"001.005"},"shared_locations":{"type":"boolean","x-stream-index":"001.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.031"},"typing_events":{"type":"boolean","x-stream-index":"001.002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"002.004"},"uploads":{"type":"boolean","x-stream-index":"001.010"},"url_enrichment":{"type":"boolean","x-stream-index":"001.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"001.017"}},"required":["name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","count_messages","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","created_at","updated_at","commands"],"type":"object"},"ChannelConfigWithInfo":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.002.027"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.002.022"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.023"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.002.028"},"blocklist":{"type":"string","x-stream-index":"001.002.024"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.025"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.002.026"},"commands":{"items":{"$ref":"#/components/schemas/Command"},"type":"array","x-stream-index":"001.003"},"connect_events":{"type":"boolean","x-stream-index":"001.002.004"},"count_messages":{"type":"boolean","x-stream-index":"001.002.019"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.001.003"},"custom_events":{"type":"boolean","x-stream-index":"001.002.012"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"002"},"mark_messages_pending":{"type":"boolean","x-stream-index":"001.002.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"001.002.021"},"mutes":{"type":"boolean","x-stream-index":"001.002.009"},"name":{"type":"string","x-stream-index":"001.002.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"001.002.029"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"001.002.030"},"polls":{"type":"boolean","x-stream-index":"001.002.016"},"push_notifications":{"type":"boolean","x-stream-index":"001.002.013"},"quotes":{"type":"boolean","x-stream-index":"001.002.008"},"reactions":{"type":"boolean","x-stream-index":"001.002.006"},"read_events":{"type":"boolean","x-stream-index":"001.002.003"},"reminders":{"type":"boolean","x-stream-index":"001.002.014"},"replies":{"type":"boolean","x-stream-index":"001.002.007"},"search":{"type":"boolean","x-stream-index":"001.002.005"},"shared_locations":{"type":"boolean","x-stream-index":"001.002.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.002.031"},"typing_events":{"type":"boolean","x-stream-index":"001.002.002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"uploads":{"type":"boolean","x-stream-index":"001.002.010"},"url_enrichment":{"type":"boolean","x-stream-index":"001.002.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"001.002.017"}},"required":["created_at","updated_at","name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","count_messages","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","commands"],"type":"object"},"ChannelCreatedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"channel.created","type":"string","x-stream-index":"001.001"}},"required":["type","created_at"],"title":"ChannelCreatedEvent","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"},"ChannelDeletedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003.004"},"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"003.005"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"team":{"type":"string","x-stream-index":"001.001"},"type":{"default":"channel.deleted","type":"string","x-stream-index":"002.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"ChannelDeletedEvent","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"},"ChannelFrozenEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"channel.frozen","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"ChannelFrozenEvent","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"},"ChannelGetOrCreateRequest":{"nullable":true,"properties":{"data":{"$ref":"#/components/schemas/ChannelInput","x-stream-index":"003"},"hide_for_creator":{"description":"Whether this channel will be hidden for the user who created the channel or not","title":"Hide for creator","type":"boolean","x-stream-index":"007"},"members":{"$ref":"#/components/schemas/PaginationParams","x-stream-index":"010"},"messages":{"$ref":"#/components/schemas/MessagePaginationParams","x-stream-index":"009"},"presence":{"description":"Fetch user presence info","title":"Presence","type":"boolean","x-stream-index":"006"},"state":{"description":"Refresh channel state","title":"State","type":"boolean","x-stream-index":"005"},"thread_unread_counts":{"type":"boolean","x-stream-index":"008"},"watch":{"description":"Start watching the channel","title":"Watch","type":"boolean","x-stream-index":"004"},"watchers":{"$ref":"#/components/schemas/PaginationParams","x-stream-index":"011"}},"type":"object"},"ChannelHiddenEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003.004"},"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"003.005"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"clear_history":{"type":"boolean","x-stream-index":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"type":{"default":"channel.hidden","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["clear_history","cid","channel_id","channel_type","channel_member_count","type","created_at"],"title":"ChannelHiddenEvent","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"},"ChannelInput":{"properties":{"auto_translation_enabled":{"description":"Enable or disable auto translation","title":"Auto translation","type":"boolean","x-stream-index":"005"},"auto_translation_language":{"description":"Switch auto translation language","title":"Auto translation language","type":"string","x-stream-index":"006"},"config_overrides":{"$ref":"#/components/schemas/ChannelConfig","x-stream-index":"024"},"created_by":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"009"},"created_by_id":{"type":"string","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"015"},"disabled":{"type":"boolean","x-stream-index":"014"},"frozen":{"description":"Freeze or unfreeze the channel","title":"Frozen","type":"boolean","x-stream-index":"013"},"invites":{"items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"type":"array","x-stream-index":"016"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"type":"array","x-stream-index":"018"},"team":{"description":"Team the channel belongs to (if multi-tenant mode is enabled)","title":"Team","type":"string","x-stream-index":"004"},"truncated_by_id":{"type":"string","x-stream-index":"010"}},"type":"object"},"ChannelKickedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002.004"},"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"002.005"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"channel.kicked","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"ChannelKickedEvent","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"},"ChannelMember":{"nullable":true,"properties":{"archived_at":{"format":"date-time","type":"number","x-stream-index":"015"},"ban_expires":{"description":"Expiration date of the ban","format":"date-time","title":"Ban expires","type":"number","x-stream-index":"013"},"banned":{"description":"Whether member is banned this channel or not","title":"Banned","type":"boolean","x-stream-index":"012"},"channel_role":{"description":"Role of the member in the channel","title":"Channel Role","type":"string","x-stream-index":"018"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"deleted_messages":{"items":{"type":"string"},"type":"array","x-stream-index":"020"},"invite_accepted_at":{"description":"Date when invite was accepted","format":"date-time","title":"Invited accepted at","type":"number","x-stream-index":"006"},"invite_rejected_at":{"description":"Date when invite was rejected","format":"date-time","title":"Invited rejected at","type":"number","x-stream-index":"007"},"invited":{"description":"Whether member was invited or not","title":"Invited","type":"boolean","x-stream-index":"005"},"is_moderator":{"description":"Whether member is channel moderator or not","title":"Is moderator","type":"boolean","x-stream-index":"003"},"notifications_muted":{"type":"boolean","x-stream-index":"019"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"016"},"role":{"description":"Permission level of the member in the channel (DEPRECATED: use channel_role instead)","enum":["member","moderator","admin","owner"],"title":"Role","type":"string","x-stream-index":"017"},"shadow_banned":{"description":"Whether member is shadow banned in this channel or not","title":"Shadow banned","type":"boolean","x-stream-index":"014"},"status":{"type":"string","x-stream-index":"008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"},"user_id":{"title":"User ID","type":"string","x-stream-index":"001"}},"required":["custom","created_at","updated_at","banned","shadow_banned","channel_role","notifications_muted"],"title":"Channel member","type":"object"},"ChannelMemberResponse":{"nullable":true,"properties":{"archived_at":{"format":"date-time","type":"number","x-stream-index":"016"},"ban_expires":{"description":"Expiration date of the ban","format":"date-time","title":"Ban expires","type":"number","x-stream-index":"013"},"banned":{"description":"Whether member is banned this channel or not","title":"Banned","type":"boolean","x-stream-index":"012"},"channel_role":{"description":"Role of the member in the channel","title":"Channel Role","type":"string","x-stream-index":"018"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"invite_accepted_at":{"description":"Date when invite was accepted","format":"date-time","title":"Invited accepted at","type":"number","x-stream-index":"006"},"invite_rejected_at":{"description":"Date when invite was rejected","format":"date-time","title":"Invited rejected at","type":"number","x-stream-index":"007"},"invited":{"description":"Whether member was invited or not","title":"Invited","type":"boolean","x-stream-index":"005"},"is_moderator":{"description":"Whether member is channel moderator or not","title":"Is moderator","type":"boolean","x-stream-index":"003"},"notifications_muted":{"type":"boolean","x-stream-index":"019"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"015"},"role":{"description":"Permission level of the member in the channel (DEPRECATED: use channel_role instead)","enum":["member","moderator","admin","owner"],"title":"Role","type":"string","x-stream-index":"017"},"shadow_banned":{"description":"Whether member is shadow banned in this channel or not","title":"Shadow banned","type":"boolean","x-stream-index":"014"},"status":{"type":"string","x-stream-index":"008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"},"user_id":{"title":"User ID","type":"string","x-stream-index":"001"}},"required":["custom","created_at","updated_at","banned","shadow_banned","channel_role","notifications_muted"],"title":"Channel member","type":"object"},"ChannelMute":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel that is muted","title":"Channel","x-stream-index":"002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"004"},"expires":{"description":"Date/time of mute expiration","format":"date-time","title":"Expires","type":"number","x-stream-index":"003"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Owner of channel mute","title":"User","x-stream-index":"001"}},"required":["created_at","updated_at"],"type":"object"},"ChannelOwnCapability":{"description":"All possibility of string to use","enum":["ban-channel-members","cast-poll-vote","connect-events","create-attachment","delete-any-message","delete-channel","delete-own-message","flag-message","freeze-channel","join-channel","leave-channel","mute-channel","pin-message","query-poll-votes","quote-message","read-events","search-messages","send-custom-events","send-links","send-message","send-poll","send-reaction","send-reply","send-restricted-visibility-message","send-typing-events","set-channel-cooldown","share-location","skip-slow-mode","slow-mode","typing-events","update-any-message","update-channel","update-channel-members","update-own-message","update-thread","upload-file"],"title":"ChannelOwnCapability","type":"string"},"ChannelPushPreferences":{"properties":{"chat_level":{"type":"string","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"number","x-stream-index":"002"}},"type":"object"},"ChannelResponse":{"description":"Represents channel in chat","properties":{"auto_translation_enabled":{"description":"Whether auto translation is enabled or not","title":"Auto translation","type":"boolean","x-stream-index":"017"},"auto_translation_language":{"description":"Language to translate to when auto translation is active","title":"Auto translation language","type":"string","x-stream-index":"018"},"blocked":{"description":"Whether this channel is blocked by current user or not","title":"Blocked","type":"boolean","x-stream-index":"023"},"cid":{"description":"Channel CID (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/ChannelConfigWithInfo","description":"Channel configuration","title":"ChannelConfigWithInfo","x-stream-index":"013"},"cooldown":{"description":"Cooldown period after sending each message","format":"int32","title":"Cooldown","type":"integer","x-stream-index":"020"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"005"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"Creator of the channel","title":"UserResponse","x-stream-index":"008"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"026"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"007"},"disabled":{"type":"boolean","x-stream-index":"010"},"frozen":{"description":"Whether channel is frozen or not","title":"Frozen","type":"boolean","x-stream-index":"009"},"hidden":{"description":"Whether this channel is hidden by current user or not","title":"Hidden","type":"boolean","x-stream-index":"022"},"hide_messages_before":{"description":"Date since when the message history is accessible","format":"date-time","title":"Hide messages before","type":"number","x-stream-index":"019"},"id":{"description":"Channel unique ID","title":"ID","type":"string","x-stream-index":"001"},"last_message_at":{"description":"Date of the last message sent","format":"date-time","title":"Last message at","type":"number","x-stream-index":"004"},"member_count":{"description":"Number of members in the channel","format":"int32","title":"Member count","type":"integer","x-stream-index":"012"},"members":{"description":"List of channel members (max 100)","items":{"$ref":"#/components/schemas/ChannelMember"},"title":"ChannelMembers","type":"array","x-stream-index":"011"},"message_count":{"description":"Number of messages in the channel","format":"int64","title":"Message count","type":"integer","x-stream-index":"027"},"mute_expires_at":{"description":"Date of mute expiration","format":"date-time","title":"Mute expires at","type":"number","x-stream-index":"015"},"muted":{"description":"Whether this channel is muted or not","title":"Muted","type":"boolean","x-stream-index":"014"},"own_capabilities":{"description":"List of channel capabilities of authenticated user","items":{"$ref":"#/components/schemas/ChannelOwnCapability"},"title":"ChannelOwnCapability","type":"array","x-stream-index":"021"},"team":{"description":"Team the channel belongs to (multi-tenant only)","title":"Team","type":"string","x-stream-index":"016"},"truncated_at":{"description":"Date of the latest truncation of the channel","format":"date-time","title":"UserResponse","type":"number","x-stream-index":"024"},"truncated_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"025"},"type":{"description":"Type of the channel","title":"Type","type":"string","x-stream-docs-page-id":"channel_features","x-stream-index":"002"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"006"}},"required":["id","type","cid","created_at","updated_at","frozen","disabled","custom"],"title":"Channel","type":"object"},"ChannelStateResponse":{"nullable":true,"properties":{"active_live_locations":{"items":{"$ref":"#/components/schemas/SharedLocationResponseData"},"type":"array","x-stream-index":"001.015"},"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001.001"},"deleted_messages":{"items":{"type":"string"},"type":"array","x-stream-index":"001.016"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001.014"},"duration":{"type":"string","x-stream-index":"002.001"},"hidden":{"type":"boolean","x-stream-index":"001.011"},"hide_messages_before":{"format":"date-time","type":"number","x-stream-index":"001.012"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"001.007"},"membership":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"001.008"},"messages":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","x-stream-index":"001.002"},"pending_messages":{"items":{"$ref":"#/components/schemas/PendingMessageResponse"},"type":"array","x-stream-index":"001.013"},"pinned_messages":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","x-stream-index":"001.003"},"push_preferences":{"$ref":"#/components/schemas/ChannelPushPreferences","x-stream-index":"001.009"},"read":{"items":{"$ref":"#/components/schemas/ReadStateResponse"},"type":"array","x-stream-index":"001.006"},"threads":{"items":{"$ref":"#/components/schemas/ThreadStateResponse"},"type":"array","x-stream-index":"001.010"},"watcher_count":{"format":"int32","type":"integer","x-stream-index":"001.004"},"watchers":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"001.005"}},"required":["messages","pinned_messages","members","threads","duration"],"type":"object"},"ChannelStateResponseFields":{"properties":{"active_live_locations":{"description":"Active live locations in the channel","items":{"$ref":"#/components/schemas/SharedLocationResponseData"},"title":"Active Live Locations","type":"array","x-stream-index":"015"},"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001"},"deleted_messages":{"items":{"type":"string"},"type":"array","x-stream-index":"016"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"014"},"hidden":{"description":"Whether this channel is hidden or not","title":"Hidden","type":"boolean","x-stream-index":"011"},"hide_messages_before":{"description":"Messages before this date are hidden from the user","format":"date-time","title":"Hide messages before","type":"number","x-stream-index":"012"},"members":{"description":"List of channel members","items":{"$ref":"#/components/schemas/ChannelMember"},"title":"Members","type":"array","x-stream-index":"007"},"membership":{"$ref":"#/components/schemas/ChannelMember","description":"Current user membership object","title":"Membership","x-stream-index":"008"},"messages":{"description":"List of channel messages","items":{"$ref":"#/components/schemas/MessageResponse"},"title":"Message","type":"array","x-stream-index":"002"},"pending_messages":{"description":"Pending messages that this user has sent","items":{"$ref":"#/components/schemas/PendingMessageResponse"},"title":"Pending messages","type":"array","x-stream-index":"013"},"pinned_messages":{"description":"List of pinned messages in the channel","items":{"$ref":"#/components/schemas/MessageResponse"},"title":"Pinned messages","type":"array","x-stream-docs-page-id":"pinned_messages","x-stream-index":"003"},"push_preferences":{"$ref":"#/components/schemas/ChannelPushPreferences","x-stream-index":"009"},"read":{"description":"List of read states","items":{"$ref":"#/components/schemas/ReadStateResponse"},"title":"Read","type":"array","x-stream-index":"006"},"threads":{"items":{"$ref":"#/components/schemas/ThreadStateResponse"},"type":"array","x-stream-index":"010"},"watcher_count":{"description":"Number of channel watchers","format":"int32","title":"Watcher count","type":"integer","x-stream-index":"004"},"watchers":{"description":"List of user who is watching the channel","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Watchers","type":"array","x-stream-index":"005"}},"required":["messages","pinned_messages","members","threads"],"type":"object"},"ChannelStopWatchingRequest":{"nullable":true,"type":"object"},"ChannelTruncatedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001.004"},"channel_id":{"type":"string","x-stream-index":"001.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"001.005"},"channel_type":{"type":"string","x-stream-index":"001.003"},"cid":{"type":"string","x-stream-index":"001.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"type":{"default":"channel.truncated","type":"string","x-stream-index":"002.001"}},"required":["cid","channel_id","channel_type","channel_member_count","type","created_at"],"title":"ChannelTruncatedEvent","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"},"ChannelUnFrozenEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"channel.unfrozen","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"ChannelUnFrozenEvent","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"},"ChannelUpdatedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"004.004"},"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"004.005"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"002.001"},"type":{"default":"channel.updated","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"ChannelUpdatedEvent","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"},"ChannelVisibleEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"001.002"},"channel_type":{"type":"string","x-stream-index":"001.003"},"cid":{"type":"string","x-stream-index":"001.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"type":{"default":"channel.visible","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"ChannelVisibleEvent","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"},"ChatActivityStatsResponse":{"properties":{"Messages":{"$ref":"#/components/schemas/MessageStatsResponse","x-stream-index":"001"}},"type":"object"},"ClosedCaptionEvent":{"description":"This event is sent when closed captions are being sent in a call, clients should use this to show the closed captions in the call screen","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"closed_caption":{"$ref":"#/components/schemas/CallClosedCaption","description":"The closed caption object","title":"CallClosedCaption","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.closed_caption","description":"The type of event: \"call.closed_caption\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","closed_caption"],"title":"ClosedCaptionEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CollectUserFeedbackRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"009"},"rating":{"format":"int32","maximum":5,"minimum":1,"type":"integer","x-stream-index":"007"},"reason":{"maxLength":1000,"type":"string","x-stream-index":"008"},"sdk":{"maxLength":50,"type":"string","x-stream-index":"005"},"sdk_version":{"maxLength":50,"type":"string","x-stream-index":"006"},"user_session_id":{"maxLength":50,"type":"string","x-stream-index":"004"}},"required":["sdk","sdk_version","rating"],"type":"object"},"CollectUserFeedbackResponse":{"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"},"Command":{"description":"Represents custom chat command","nullable":true,"properties":{"args":{"description":"Arguments help text, shown in commands auto-completion","title":"Arguments","type":"string","x-stream-index":"006"},"created_at":{"description":"Date/time of creation","format":"date-time","readOnly":true,"title":"Created at","type":"number","x-stream-index":"001"},"description":{"description":"Description, shown in commands auto-completion","title":"Description","type":"string","x-stream-index":"005"},"name":{"description":"Unique command name","title":"Name","type":"string","x-stream-index":"004"},"set":{"description":"Set name used for grouping commands","title":"Set","type":"string","x-stream-index":"007"},"updated_at":{"description":"Date/time of the last update","format":"date-time","readOnly":true,"title":"Updated at","type":"number","x-stream-index":"002"}},"required":["name","description","args","set"],"title":"Command","type":"object"},"CommentAddedEvent":{"description":"Emitted when a comment is added to an activity.","nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","x-stream-index":"002"},"comment":{"$ref":"#/components/schemas/CommentResponse","description":"The comment that was added","title":"Text","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"003.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.001.007"},"feed_visibility":{"type":"string","x-stream-index":"003.003"},"fid":{"type":"string","x-stream-index":"003.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.001.004"},"type":{"default":"feeds.comment.added","description":"The type of event: \"feeds.comment.added\" in this case","title":"Event Type","type":"string","x-stream-index":"003.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who added the comment","title":"User","x-stream-index":"004.001"}},"required":["comment","activity","type","created_at","custom","fid"],"title":"CommentAddedEvent","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"},"CommentDeletedEvent":{"description":"Emitted when a comment is deleted.","nullable":true,"properties":{"comment":{"$ref":"#/components/schemas/CommentResponse","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"type":"string","x-stream-index":"002.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.comment.deleted","description":"The type of event: \"feeds.comment.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who deleted the comment","title":"User","x-stream-index":"003.001"}},"required":["comment","type","created_at","custom","fid"],"title":"CommentDeletedEvent","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"},"CommentReactionAddedEvent":{"description":"Emitted when a reaction is added to a comment.","nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","x-stream-index":"003"},"comment":{"$ref":"#/components/schemas/CommentResponse","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"004.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004.001.007"},"feed_visibility":{"type":"string","x-stream-index":"004.003"},"fid":{"type":"string","x-stream-index":"004.002"},"reaction":{"$ref":"#/components/schemas/FeedsReactionResponse","description":"The reaction that was added","title":"Reaction","x-stream-index":"002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"004.001.004"},"type":{"default":"feeds.comment.reaction.added","description":"The type of event: \"feeds.comment.reaction.added\" in this case","title":"Event Type","type":"string","x-stream-index":"004.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who added the reaction","title":"User","x-stream-index":"005.001"}},"required":["comment","reaction","activity","type","created_at","custom","fid"],"title":"CommentReactionAddedEvent","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"},"CommentReactionDeletedEvent":{"description":"Emitted when a reaction is deleted from a comment.","nullable":true,"properties":{"comment":{"$ref":"#/components/schemas/CommentResponse","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"003.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.001.007"},"feed_visibility":{"type":"string","x-stream-index":"003.003"},"fid":{"type":"string","x-stream-index":"003.002"},"reaction":{"$ref":"#/components/schemas/FeedsReactionResponse","x-stream-index":"002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.001.004"},"type":{"default":"feeds.comment.reaction.deleted","description":"The type of reaction that was removed","title":"Type","type":"string","x-stream-index":"003.001.002"}},"required":["comment","reaction","type","created_at","custom","fid"],"title":"CommentReactionDeletedEvent","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"},"CommentReactionUpdatedEvent":{"description":"Emitted when a reaction is updated on a comment.","nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","x-stream-index":"003"},"comment":{"$ref":"#/components/schemas/CommentResponse","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"004.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004.001.007"},"feed_visibility":{"type":"string","x-stream-index":"004.003"},"fid":{"type":"string","x-stream-index":"004.002"},"reaction":{"$ref":"#/components/schemas/FeedsReactionResponse","description":"The reaction that was updated","title":"Reaction","x-stream-index":"002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"004.001.004"},"type":{"default":"feeds.comment.reaction.updated","description":"The type of event: \"feeds.comment.reaction.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"004.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who updated the reaction","title":"User","x-stream-index":"005.001"}},"required":["comment","reaction","activity","type","created_at","custom","fid"],"title":"CommentReactionUpdatedEvent","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"},"CommentResponse":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"011"},"confidence_score":{"description":"Confidence score of the comment","format":"float","title":"Confidence Score","type":"number","x-stream-index":"022"},"controversy_score":{"description":"Controversy score of the comment","format":"float","title":"Controversy Score","type":"number","x-stream-index":"023"},"created_at":{"description":"When the comment was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"014"},"custom":{"additionalProperties":{},"description":"Custom data for the comment","title":"Custom Data","type":"object","x-stream-index":"006"},"deleted_at":{"description":"When the comment was deleted","format":"date-time","title":"Deleted At","type":"number","x-stream-index":"016"},"downvote_count":{"description":"Number of downvotes for this comment","format":"int32","title":"Downvote Count","type":"integer","x-stream-index":"020"},"id":{"description":"Unique identifier for the comment","title":"ID","type":"string","x-stream-index":"001"},"latest_reactions":{"description":"Recent reactions to the comment","items":{"$ref":"#/components/schemas/FeedsReactionResponse"},"title":"Latest Reactions","type":"array","x-stream-index":"009"},"mentioned_users":{"description":"Users mentioned in the comment","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Mention Users","type":"array","x-stream-index":"012"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"017"},"object_id":{"description":"ID of the object this comment is associated with","title":"Object ID","type":"string","x-stream-index":"002"},"object_type":{"description":"Type of the object this comment is associated with","title":"Object Type","type":"string","x-stream-index":"003"},"own_reactions":{"description":"Current user's reactions to this activity","items":{"$ref":"#/components/schemas/FeedsReactionResponse"},"title":"Own Reactions","type":"array","x-stream-index":"024"},"parent_id":{"description":"ID of parent comment for nested replies","title":"Parent ID","type":"string","x-stream-index":"007"},"reaction_count":{"description":"Number of reactions to this comment","format":"int32","title":"Reaction Count","type":"integer","x-stream-index":"008"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"description":"Grouped reactions by type","title":"Reaction Groups","type":"object","x-stream-index":"010"},"reply_count":{"description":"Number of replies to this comment","format":"int32","title":"Reply Count","type":"integer","x-stream-index":"018"},"score":{"description":"Score of the comment based on reactions","format":"int32","title":"Score","type":"integer","x-stream-index":"021"},"status":{"description":"Status of the comment (e.g., active, deleted)","title":"Status","type":"string","x-stream-index":"013"},"text":{"description":"Text content of the comment","title":"Text","type":"string","x-stream-index":"005"},"updated_at":{"description":"When the comment was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"015"},"upvote_count":{"description":"Number of upvotes for this comment","format":"int32","title":"Upvote Count","type":"integer","x-stream-index":"019"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who created the comment","title":"User","x-stream-index":"004"}},"required":["id","object_id","object_type","user","reaction_count","mentioned_users","status","created_at","updated_at","reply_count","upvote_count","downvote_count","score","confidence_score","own_reactions"],"title":"Comment","type":"object"},"CommentUpdatedEvent":{"description":"Emitted when a comment is updated.","nullable":true,"properties":{"comment":{"$ref":"#/components/schemas/CommentResponse","description":"The comment that was updated","title":"Text","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"type":"string","x-stream-index":"002.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.comment.updated","description":"The type of event: \"feeds.comment.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who updated the comment","title":"User","x-stream-index":"003.001"}},"required":["comment","type","created_at","custom","fid"],"title":"CommentUpdatedEvent","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"},"CompositeAppSettings":{"properties":{"json_encoded_settings":{"type":"string","x-stream-index":"005"},"url":{"type":"string","x-stream-index":"004"}},"type":"object"},"ConfigOverrides":{"properties":{"blocklist":{"type":"string","x-stream-index":"008"},"blocklist_behavior":{"enum":["flag","block"],"type":"string","x-stream-index":"009"},"commands":{"items":{"type":"string"},"type":"array","x-stream-index":"011"},"count_messages":{"type":"boolean","x-stream-index":"014"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"010"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"007"},"quotes":{"type":"boolean","x-stream-index":"004"},"reactions":{"type":"boolean","x-stream-index":"002"},"replies":{"type":"boolean","x-stream-index":"003"},"shared_locations":{"type":"boolean","x-stream-index":"013"},"typing_events":{"type":"boolean","x-stream-index":"001"},"uploads":{"type":"boolean","x-stream-index":"005"},"url_enrichment":{"type":"boolean","x-stream-index":"006"},"user_message_reminders":{"type":"boolean","x-stream-index":"012"}},"required":["grants","commands"],"type":"object"},"ConfigResponse":{"properties":{"ai_image_config":{"$ref":"#/components/schemas/AIImageConfig","description":"Configuration for AI image analysis","title":"AI Image Config","x-stream-index":"010"},"ai_text_config":{"$ref":"#/components/schemas/AITextConfig","description":"Configuration for AI text analysis","title":"AI Text Config","x-stream-index":"008"},"ai_video_config":{"$ref":"#/components/schemas/AIVideoConfig","description":"Configuration for AI video analysis","title":"AI Video Config","x-stream-index":"011"},"async":{"description":"Whether moderation should be performed asynchronously","title":"Async","type":"boolean","x-stream-index":"003"},"automod_platform_circumvention_config":{"$ref":"#/components/schemas/AutomodPlatformCircumventionConfig","description":"Configuration for platform circumvention detection","title":"Automod Platform Circumvention Config","x-stream-index":"005"},"automod_semantic_filters_config":{"$ref":"#/components/schemas/AutomodSemanticFiltersConfig","description":"Configuration for semantic filtering","title":"Automod Semantic Filters Config","x-stream-index":"006"},"automod_toxicity_config":{"$ref":"#/components/schemas/AutomodToxicityConfig","description":"Configuration for toxicity detection","title":"Automod Toxicity Config","x-stream-index":"004"},"block_list_config":{"$ref":"#/components/schemas/BlockListConfig","description":"Configuration for block list filtering","title":"Block List Config","x-stream-index":"007"},"created_at":{"description":"When the configuration was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"013"},"key":{"description":"Unique identifier for the moderation configuration","title":"Key","type":"string","x-stream-index":"001"},"llm_config":{"$ref":"#/components/schemas/LLMConfig","description":"Configuration for customer-configured LLM moderation","title":"LLM Config","x-stream-index":"009"},"team":{"description":"Team associated with the configuration","title":"Team","type":"string","x-stream-index":"002"},"updated_at":{"description":"When the configuration was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"014"},"velocity_filter_config":{"$ref":"#/components/schemas/VelocityFilterConfig","description":"Configuration for velocity-based filtering","title":"Velocity Filter Config","x-stream-index":"012"},"video_call_rule_config":{"$ref":"#/components/schemas/VideoCallRuleConfig","x-stream-index":"015"}},"required":["key","team","async","created_at","updated_at"],"type":"object"},"ConnectUserDetailsRequest":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001"},"image":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"006"},"language":{"type":"string","x-stream-index":"005"},"name":{"type":"string","x-stream-index":"002"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"007"}},"required":["id"],"type":"object"},"ConnectedEvent":{"description":"This event is sent when the WS connection is established and authenticated, this event contains the full user object as it is stored on the server","properties":{"connection_id":{"description":"The connection_id for this client","title":"Connection ID","type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"me":{"$ref":"#/components/schemas/OwnUserResponse","description":"The full user object as it is stored on the server","title":"OwnUserResponse","x-stream-index":"003"},"type":{"default":"connection.ok","description":"The type of event: \"connection.ok\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","connection_id","me"],"title":"ConnectedEvent","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"},"ConnectionErrorEvent":{"description":"This event is sent when the WS connection fails","properties":{"connection_id":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"error":{"$ref":"#/components/schemas/APIError","description":"The error that caused the connection to fail","title":"Error","x-stream-index":"003"},"type":{"default":"connection.error","description":"The type of event: \"connection.ok\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","connection_id","error"],"title":"ConnectionErrorEvent","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"},"ContentCountRuleParameters":{"properties":{"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"type":"object"},"CountByMinuteResponse":{"nullable":true,"properties":{"count":{"format":"int32","type":"integer","x-stream-index":"002"},"start_ts":{"format":"date-time","type":"number","x-stream-index":"001"}},"required":["start_ts","count"],"type":"object"},"CreateBlockListRequest":{"description":"Block list contains restricted words","nullable":true,"properties":{"name":{"description":"Block list name","maxLength":255,"title":"Name","type":"string","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"004"},"type":{"description":"Block list type.","enum":["regex","domain","domain_allowlist","email","word"],"title":"Type","type":"string","x-stream-index":"003"},"words":{"description":"List of words to block","items":{"type":"string"},"minimum":1,"title":"Words","type":"array","x-stream-index":"002"}},"required":["name","words"],"title":"Block list","type":"object","x-stream-docs-page-id":"block_lists"},"CreateBlockListResponse":{"description":"Basic response information","nullable":true,"properties":{"blocklist":{"$ref":"#/components/schemas/BlockListResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["duration"],"title":"Response","type":"object"},"CreateDeviceRequest":{"description":"Create device request","nullable":true,"properties":{"id":{"description":"Device ID","maxLength":255,"minLength":1,"title":"ID","type":"string","x-stream-index":"001"},"push_provider":{"description":"Push provider","enum":["firebase","apn","huawei","xiaomi"],"title":"PushProvider","type":"string","x-stream-index":"002"},"push_provider_name":{"description":"Push provider name","title":"PushProviderName","type":"string","x-stream-index":"003"},"voip_token":{"description":"When true the token is for Apple VoIP push notifications","title":"VoipToken","type":"boolean","x-stream-index":"004"}},"required":["id","push_provider"],"title":"CreateDeviceRequest","type":"object"},"CreateDraftRequest":{"nullable":true,"properties":{"message":{"$ref":"#/components/schemas/MessageRequest","x-stream-index":"001"}},"required":["message"],"type":"object"},"CreateDraftResponse":{"description":"Basic response information","nullable":true,"properties":{"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["draft","duration"],"title":"Response","type":"object"},"CreateFeedsBatchRequest":{"nullable":true,"properties":{"feeds":{"description":"List of feeds to create","items":{"$ref":"#/components/schemas/FeedRequest"},"maximum":1000,"minimum":1,"title":"Feeds","type":"array","x-stream-index":"001"}},"required":["feeds"],"title":"Create Feeds Batch Request","type":"object"},"CreateFeedsBatchResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"feeds":{"description":"List of created feeds","items":{"$ref":"#/components/schemas/FeedResponse"},"title":"Feeds","type":"array","x-stream-index":"001"}},"required":["feeds","duration"],"title":"Create Feeds Batch Response","type":"object"},"CreateGuestRequest":{"nullable":true,"properties":{"user":{"$ref":"#/components/schemas/UserRequest","description":"User object which server acts upon","title":"User","x-stream-index":"001"}},"required":["user"],"type":"object"},"CreateGuestResponse":{"nullable":true,"properties":{"access_token":{"description":"the access token to authenticate the user","title":"Access token","type":"string","x-stream-index":"002"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User object which server acts upon","title":"User","x-stream-index":"001"}},"required":["user","access_token","duration"],"type":"object"},"CreatePollOptionRequest":{"nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"003"},"text":{"description":"Option text","title":"string","type":"string","x-stream-index":"002"}},"required":["text"],"type":"object"},"CreatePollRequest":{"description":"Contains all information needed to create a new poll","nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"011"},"allow_answers":{"description":"Indicates whether users can suggest user defined answers","title":"Allow answers","type":"boolean","x-stream-index":"009"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"008"},"description":{"description":"A description of the poll","title":"Description","type":"string","x-stream-index":"003"},"enforce_unique_vote":{"description":"Indicates whether users can cast multiple votes","title":"Multiple choice","type":"boolean","x-stream-index":"006"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"is_closed":{"description":"Indicates whether the poll is open for voting","title":"Is closed","type":"boolean","x-stream-index":"010"},"max_votes_allowed":{"description":"Indicates the maximum amount of votes a user can cast","format":"int32","maximum":10,"title":"Maximum votes allowed","type":"integer","x-stream-index":"007"},"name":{"description":"The name of the poll","title":"Name","type":"string","x-stream-index":"002"},"options":{"items":{"$ref":"#/components/schemas/PollOptionInput"},"maximum":100,"type":"array","x-stream-index":"004"},"voting_visibility":{"enum":["anonymous","public"],"type":"string","x-stream-index":"005"}},"required":["name"],"title":"Create Poll Request","type":"object"},"CreateReminderRequest":{"nullable":true,"properties":{"remind_at":{"format":"date-time","type":"number","x-stream-index":"001"}},"type":"object"},"Credentials":{"properties":{"ice_servers":{"items":{"$ref":"#/components/schemas/ICEServer"},"type":"array","x-stream-index":"003"},"server":{"$ref":"#/components/schemas/SFUResponse","x-stream-index":"001"},"token":{"type":"string","x-stream-index":"002"}},"required":["server","token","ice_servers"],"type":"object"},"CustomActionRequest":{"properties":{"id":{"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"type":"object"},"CustomVideoEvent":{"description":"A custom event, this event is used to send custom events to other participants in the call.","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"003"},"type":{"default":"custom","description":"The type of event, \"custom\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"004"}},"required":["type","created_at","call_cid","custom","user"],"title":"CustomVideoEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"DailyAggregateCallDurationReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/CallDurationReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateCallParticipantCountReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/CallParticipantCountReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateCallsPerDayReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/CallsPerDayReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateQualityScoreReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/QualityScoreReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateSDKUsageReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/SDKUsageReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateUserFeedbackReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/UserFeedbackReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"Data":{"properties":{"id":{"type":"string","x-stream-index":"001"}},"required":["id"],"type":"object"},"DecayFunctionConfig":{"properties":{"base":{"type":"string","x-stream-index":"001"},"decay":{"type":"string","x-stream-index":"005"},"direction":{"type":"string","x-stream-index":"006"},"offset":{"type":"string","x-stream-index":"004"},"origin":{"type":"string","x-stream-index":"002"},"scale":{"type":"string","x-stream-index":"003"}},"type":"object"},"DeleteActivitiesRequest":{"nullable":true,"properties":{"hard_delete":{"description":"Whether to permanently delete the activities","title":"Hard Delete","type":"boolean","x-stream-index":"002"},"ids":{"description":"List of activity IDs to delete","items":{"type":"string"},"minimum":1,"title":"Activity IDs","type":"array","x-stream-index":"001"}},"required":["ids"],"title":"Delete Activities Request","type":"object"},"DeleteActivitiesResponse":{"nullable":true,"properties":{"deleted_ids":{"description":"List of activity IDs that were successfully deleted","items":{"type":"string"},"title":"Deleted Activity IDs","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["deleted_ids","duration"],"title":"Delete Activities Response","type":"object"},"DeleteActivityReactionResponse":{"nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"reaction":{"$ref":"#/components/schemas/FeedsReactionResponse","x-stream-index":"002"}},"required":["activity","reaction","duration"],"title":"Delete Activity Reaction Response","type":"object"},"DeleteActivityRequest":{"properties":{"hard_delete":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"DeleteActivityResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"Delete Activity Response","type":"object"},"DeleteBookmarkFolderResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"Delete Bookmark Folder Response","type":"object"},"DeleteBookmarkResponse":{"nullable":true,"properties":{"bookmark":{"$ref":"#/components/schemas/BookmarkResponse","description":"The deleted bookmark","title":"Bookmark","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["bookmark","duration"],"title":"Delete Bookmark Response","type":"object"},"DeleteCallRequest":{"description":"DeleteCallRequest is the payload for deleting a call.","nullable":true,"properties":{"hard":{"description":"if true the call will be hard deleted along with all related data","title":"Hard","type":"boolean","x-stream-index":"001"}},"title":"DeleteCallRequest","type":"object"},"DeleteCallResponse":{"description":"DeleteCallResponse is the payload for deleting a call.","nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","title":"Call","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"task_id":{"title":"TaskID","type":"string","x-stream-index":"002"}},"required":["call","duration"],"title":"DeleteCallResponse","type":"object"},"DeleteChannelResponse":{"description":"Basic response information","nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"Response","type":"object"},"DeleteChannelsRequest":{"nullable":true,"properties":{"cids":{"description":"All channels that should be deleted","items":{"type":"string"},"maximum":100,"minimum":1,"title":"Channels CID","type":"array","x-stream-index":"001"},"hard_delete":{"description":"Specify if channels and all ressources should be hard deleted","title":"Hard delete","type":"boolean","x-stream-index":"002"}},"required":["cids"],"type":"object"},"DeleteChannelsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"result":{"additionalProperties":{"$ref":"#/components/schemas/DeleteChannelsResultResponse"},"description":"Map of channel IDs and their deletion results","title":"Result","type":"object","x-stream-index":"001"},"task_id":{"type":"string","x-stream-index":"002"}},"required":["duration"],"type":"object"},"DeleteChannelsResultResponse":{"nullable":true,"properties":{"error":{"type":"string","x-stream-index":"002"},"status":{"type":"string","x-stream-index":"001"}},"required":["status"],"type":"object"},"DeleteCommentReactionResponse":{"nullable":true,"properties":{"comment":{"$ref":"#/components/schemas/CommentResponse","description":"The comment after reaction removal","title":"Comment","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"reaction":{"$ref":"#/components/schemas/FeedsReactionResponse","description":"The removed reaction","title":"Reaction","x-stream-index":"002"}},"required":["comment","reaction","duration"],"title":"Delete Comment Reaction Response","type":"object"},"DeleteCommentResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"Delete Comment Response","type":"object"},"DeleteFeedResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"Delete Feed Response","type":"object"},"DeleteMessageRequest":{"properties":{"hard_delete":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"DeleteMessageResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001"}},"required":["message","duration"],"title":"Response","type":"object"},"DeleteModerationConfigResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"DeleteReactionRequest":{"properties":{"hard_delete":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"DeleteReactionResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001"},"reaction":{"$ref":"#/components/schemas/ReactionResponse","x-stream-index":"002"}},"required":["message","reaction","duration"],"title":"Response","type":"object"},"DeleteRecordingResponse":{"description":"Response for DeleteRecording","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"DeleteRecordingResponse","type":"object"},"DeleteReminderResponse":{"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"},"DeleteTranscriptionResponse":{"description":"DeleteTranscriptionResponse is the payload for deleting a transcription.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"DeleteTranscriptionResponse","type":"object"},"DeleteUserRequest":{"properties":{"delete_conversation_channels":{"type":"boolean","x-stream-index":"003"},"delete_feeds_content":{"type":"boolean","x-stream-index":"004"},"hard_delete":{"type":"boolean","x-stream-index":"001"},"mark_messages_deleted":{"type":"boolean","x-stream-index":"002"}},"type":"object"},"Device":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"disabled":{"type":"boolean","x-stream-index":"002.003"},"disabled_reason":{"type":"string","x-stream-index":"002.004"},"id":{"type":"string","x-stream-index":"002.001.004"},"push_provider":{"enum":["firebase","apn","huawei","xiaomi"],"type":"string","x-stream-index":"002.001.001"},"push_provider_name":{"type":"string","x-stream-index":"002.001.003"},"user_id":{"type":"string","x-stream-index":"004"},"voip":{"type":"boolean","x-stream-index":"002.001.005"}},"required":["push_provider","id","created_at","user_id"],"type":"object"},"DeviceResponse":{"description":"Response for Device","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"004"},"disabled":{"description":"Whether device is disabled or not","title":"Disabled","type":"boolean","x-stream-index":"005"},"disabled_reason":{"description":"Reason explaining why device had been disabled","title":"Reason","type":"string","x-stream-index":"006"},"id":{"description":"Device ID","title":"ID","type":"string","x-stream-index":"003"},"push_provider":{"description":"Push provider","title":"PushProvider","type":"string","x-stream-index":"001"},"push_provider_name":{"description":"Push provider name","title":"PushProviderName","type":"string","x-stream-index":"002"},"user_id":{"description":"User ID","title":"UserID","type":"string","x-stream-index":"008"},"voip":{"description":"When true the token is for Apple VoIP push notifications","title":"Voip","type":"boolean","x-stream-index":"007"}},"required":["push_provider","id","created_at","user_id"],"title":"DeviceResponse","type":"object"},"DraftDeletedEvent":{"description":"Emitted when a Draft is deleted.","nullable":true,"properties":{"cid":{"description":"The CID of the channel where the draft was created","title":"Channel CID","type":"string","x-stream-index":"001.001.002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.001.007"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001.003"},"parent_id":{"description":"The ID of the parent message","title":"Message ID","type":"string","x-stream-index":"001.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.001.004"},"type":{"default":"draft.deleted","description":"The type of event: \"draft.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.001.002"}},"required":["type","created_at","custom"],"title":"DraftDeletedEvent","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"},"DraftPayloadResponse":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"html":{"type":"string","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"001"},"mentioned_users":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"008"},"mml":{"type":"string","x-stream-index":"003"},"parent_id":{"type":"string","x-stream-index":"005"},"poll_id":{"type":"string","x-stream-index":"013"},"quoted_message_id":{"type":"string","x-stream-index":"009"},"show_in_channel":{"type":"boolean","x-stream-index":"006"},"silent":{"type":"boolean","x-stream-index":"012"},"text":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"011"}},"required":["id","text","custom"],"type":"object"},"DraftResponse":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003"},"channel_cid":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"message":{"$ref":"#/components/schemas/DraftPayloadResponse","x-stream-index":"001"},"parent_id":{"type":"string","x-stream-index":"004"},"parent_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"005"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"006"}},"required":["message","channel_cid","created_at"],"type":"object"},"DraftUpdatedEvent":{"description":"Emitted when a Draft is created or updated.","nullable":true,"properties":{"cid":{"description":"The CID of the channel where the draft was created/updated","title":"Channel CID","type":"string","x-stream-index":"001.001.002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.001.007"},"draft":{"$ref":"#/components/schemas/DraftResponse","description":"The draft object which was created/updated","title":"Draft","x-stream-index":"001.003"},"parent_id":{"description":"The ID of the parent message","title":"Parent ID","type":"string","x-stream-index":"001.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.001.004"},"type":{"default":"draft.updated","description":"The type of event: \"draft.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.001.002"}},"required":["type","created_at","custom"],"title":"DraftUpdatedEvent","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"},"EdgeResponse":{"properties":{"continent_code":{"type":"string","x-stream-index":"007.003"},"country_iso_code":{"type":"string","x-stream-index":"007.002"},"green":{"format":"int32","type":"integer","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"latency_test_url":{"type":"string","x-stream-index":"002"},"latitude":{"format":"float","type":"number","x-stream-index":"006.001"},"longitude":{"format":"float","type":"number","x-stream-index":"006.002"},"red":{"format":"int32","type":"integer","x-stream-index":"005"},"subdivision_iso_code":{"type":"string","x-stream-index":"007.001"},"yellow":{"format":"int32","type":"integer","x-stream-index":"004"}},"required":["id","latency_test_url","green","yellow","red","latitude","longitude","subdivision_iso_code","country_iso_code","continent_code"],"type":"object"},"EgressHLSResponse":{"properties":{"playlist_url":{"type":"string","x-stream-index":"001"},"status":{"type":"string","x-stream-index":"002"}},"required":["playlist_url","status"],"type":"object"},"EgressRTMPResponse":{"properties":{"name":{"type":"string","x-stream-index":"001"},"started_at":{"format":"date-time","type":"number","x-stream-index":"004"},"stream_key":{"type":"string","x-stream-index":"003"},"stream_url":{"type":"string","x-stream-index":"002"}},"required":["name","started_at"],"type":"object"},"EgressResponse":{"properties":{"broadcasting":{"type":"boolean","x-stream-index":"001"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordingResponse","x-stream-index":"004"},"hls":{"$ref":"#/components/schemas/EgressHLSResponse","x-stream-index":"002"},"rtmps":{"items":{"$ref":"#/components/schemas/EgressRTMPResponse"},"type":"array","x-stream-index":"003"}},"required":["broadcasting","rtmps"],"type":"object"},"EgressTaskConfig":{"properties":{"egress_user":{"$ref":"#/components/schemas/EgressUser","x-stream-index":"008"},"frame_recording_egress_config":{"$ref":"#/components/schemas/FrameRecordingEgressConfig","x-stream-index":"009"},"hls_egress_config":{"$ref":"#/components/schemas/HLSEgressConfig","x-stream-index":"007"},"recording_egress_config":{"$ref":"#/components/schemas/RecordingEgressConfig","x-stream-index":"006"},"rtmp_egress_config":{"$ref":"#/components/schemas/RTMPEgressConfig","x-stream-index":"004"},"stt_egress_config":{"$ref":"#/components/schemas/STTEgressConfig","x-stream-index":"005"}},"type":"object"},"EgressUser":{"properties":{"token":{"type":"string","x-stream-index":"004"}},"type":"object"},"EndCallRequest":{"description":"Request for ending a call","nullable":true,"title":"EndCallRequest","type":"object"},"EndCallResponse":{"description":"Response for ending a call","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"EndCallResponse","type":"object"},"EnrichedActivity":{"properties":{"actor":{"$ref":"#/components/schemas/Data","x-stream-index":"002"},"foreign_id":{"type":"string","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"latest_reactions":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"013"},"object":{"$ref":"#/components/schemas/Data","x-stream-index":"004"},"origin":{"$ref":"#/components/schemas/Data","x-stream-index":"008"},"own_reactions":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"012"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"011"},"score":{"format":"float","type":"number","x-stream-index":"010"},"target":{"$ref":"#/components/schemas/Data","x-stream-index":"006"},"to":{"items":{"type":"string"},"type":"array","x-stream-index":"009"},"verb":{"type":"string","x-stream-index":"003"}},"type":"object"},"EnrichedReaction":{"nullable":true,"properties":{"activity_id":{"type":"string","x-stream-index":"003"},"children_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"010"},"created_at":{"$ref":"#/components/schemas/Time","x-stream-index":"012"},"data":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"kind":{"type":"string","x-stream-index":"002"},"latest_children":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"008"},"own_children":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"009"},"parent":{"type":"string","x-stream-index":"007"},"target_feeds":{"items":{"type":"string"},"type":"array","x-stream-index":"006"},"updated_at":{"$ref":"#/components/schemas/Time","x-stream-index":"013"},"user":{"$ref":"#/components/schemas/Data","x-stream-index":"011"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["kind","activity_id","user_id"],"type":"object"},"EntityCreator":{"properties":{"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"001.046"},"ban_count":{"format":"int32","type":"integer","x-stream-index":"002"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"001.017"},"banned":{"type":"boolean","x-stream-index":"001.016"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.013"},"deleted_content_count":{"format":"int32","type":"integer","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"001.023"},"language":{"type":"string","x-stream-index":"001.035"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"001.022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"001.026"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.042"},"role":{"type":"string","x-stream-index":"001.004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.005"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.009"}},"required":["id","role","teams_role","custom","banned","online","ban_count","deleted_content_count"],"type":"object"},"EntityCreatorResponse":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.001.018"},"ban_count":{"description":"Number of minor actions performed on the user","format":"int32","title":"Ban Count","type":"integer","x-stream-index":"002"},"banned":{"type":"boolean","x-stream-index":"001.001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.001.017"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.001.016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.001.011"},"deleted_content_count":{"description":"Number of major actions performed on the user","format":"int32","title":"Deleted Content Count","type":"integer","x-stream-index":"003"},"flagged_count":{"description":"Number of flag actions performed on the user","format":"int32","title":"Flagged Count","type":"integer","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001.001.001"},"image":{"type":"string","x-stream-index":"001.001.003"},"language":{"type":"string","x-stream-index":"001.001.005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"001.001.014"},"name":{"type":"string","x-stream-index":"001.001.002"},"online":{"type":"boolean","x-stream-index":"001.001.013"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.001.015"},"role":{"type":"string","x-stream-index":"001.001.006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.001.008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids","shadow_banned","invisible","ban_count","deleted_content_count","flagged_count"],"type":"object"},"EventNotificationSettings":{"properties":{"apns":{"$ref":"#/components/schemas/APNS","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"fcm":{"$ref":"#/components/schemas/FCM","x-stream-index":"003"}},"required":["enabled","apns","fcm"],"type":"object"},"EventRequest":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"parent_id":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"001"}},"required":["type"],"type":"object"},"EventResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"event":{"$ref":"#/components/schemas/WSEvent","x-stream-index":"001"}},"required":["event","duration"],"title":"Response","type":"object"},"ExternalStorage":{"properties":{"abs_account_name":{"type":"string","x-stream-index":"011"},"abs_client_id":{"type":"string","x-stream-index":"013"},"abs_client_secret":{"type":"string","x-stream-index":"014"},"abs_tenant_id":{"type":"string","x-stream-index":"012"},"bucket":{"type":"string","x-stream-index":"005"},"gcs_credentials":{"type":"string","x-stream-index":"010"},"path":{"type":"string","x-stream-index":"006"},"s3_api_key":{"type":"string","x-stream-index":"007"},"s3_custom_endpoint":{"type":"string","x-stream-index":"016"},"s3_region":{"type":"string","x-stream-index":"009"},"s3_secret_key":{"type":"string","x-stream-index":"008"},"storage_name":{"type":"string","x-stream-index":"015"},"storage_type":{"type":"integer","x-stream-index":"004"}},"type":"object"},"FCM":{"properties":{"data":{"additionalProperties":{},"type":"object","x-stream-index":"001"}},"type":"object"},"FeedCreatedEvent":{"description":"Emitted when a feed is created.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"003.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.001.007"},"feed":{"$ref":"#/components/schemas/FeedResponse","description":"The feed that was created","title":"Feed","x-stream-index":"001"},"feed_visibility":{"type":"string","x-stream-index":"003.003"},"fid":{"type":"string","x-stream-index":"003.002"},"members":{"items":{"$ref":"#/components/schemas/FeedMemberResponse"},"type":"array","x-stream-index":"002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.001.004"},"type":{"default":"feeds.feed.created","description":"The type of event: \"feeds.feed.created\" in this case","title":"Event Type","type":"string","x-stream-index":"003.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who created the feed","title":"User","x-stream-index":"004.001"}},"required":["feed","members","type","created_at","custom","fid","user"],"title":"FeedCreatedEvent","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"},"FeedDeletedEvent":{"description":"Emitted when a feed is deleted.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.007"},"feed_visibility":{"type":"string","x-stream-index":"001.003"},"fid":{"type":"string","x-stream-index":"001.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"type":{"default":"feeds.feed.deleted","description":"The type of event: \"feeds.feed.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who deleted the feed","title":"User","x-stream-index":"002.001"}},"required":["type","created_at","custom","fid"],"title":"FeedDeletedEvent","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"},"FeedGroup":{"properties":{"ActivityProcessors":{"items":{"$ref":"#/components/schemas/ActivityProcessorConfig"},"type":"array","writeOnly":true,"x-stream-index":"012"},"ActivitySelectors":{"items":{"$ref":"#/components/schemas/ActivitySelectorConfig"},"type":"array","writeOnly":true,"x-stream-index":"013"},"Aggregation":{"$ref":"#/components/schemas/AggregationConfig","x-stream-index":"015"},"AggregationVersion":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"016"},"AppPK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"002"},"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"007"},"DefaultVisibility":{"type":"string","writeOnly":true,"x-stream-index":"006"},"DeletedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"010"},"ID":{"type":"string","writeOnly":true,"x-stream-index":"003"},"LastFeedGetAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"017"},"Notification":{"$ref":"#/components/schemas/NotificationConfig","x-stream-index":"004"},"PushNotification":{"$ref":"#/components/schemas/PushNotificationConfig","x-stream-index":"005"},"Ranking":{"$ref":"#/components/schemas/RankingConfig","x-stream-index":"014"},"Stories":{"$ref":"#/components/schemas/StoriesConfig","x-stream-index":"011"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"}},"required":["AppPK","ID","DefaultVisibility","Custom","created_at","updated_at","ActivityProcessors","ActivitySelectors","AggregationVersion"],"type":"object"},"FeedGroupChangedEvent":{"description":"Emitted when a feed group is changed.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.007"},"feed_group":{"$ref":"#/components/schemas/FeedGroup","description":"The feed group that was changed","title":"Feed Type","x-stream-index":"003"},"feed_visibility":{"type":"string","x-stream-index":"001.003"},"fid":{"type":"string","x-stream-index":"001.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"type":{"default":"feeds.feed_group.changed","description":"The type of event: \"feeds.feed_group.changed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who changed the feed group","title":"User","x-stream-index":"002.001"}},"required":["type","created_at","custom","fid"],"title":"FeedGroupChangedEvent","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"},"FeedGroupDeletedEvent":{"description":"Emitted when a feed group is deleted.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"type":"string","x-stream-index":"002.002"},"group_id":{"description":"The ID of the feed group that was deleted","title":"Group ID","type":"string","x-stream-index":"001"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.feed_group.deleted","description":"The type of event: \"feeds.feed_group.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"}},"required":["group_id","type","created_at","custom","fid"],"title":"FeedGroupDeletedEvent","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"},"FeedInput":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"description":{"maxLength":1000,"type":"string","x-stream-index":"002"},"filter_tags":{"items":{"type":"string"},"maximum":255,"type":"array","x-stream-index":"005"},"members":{"items":{"$ref":"#/components/schemas/FeedMemberRequest"},"type":"array","x-stream-index":"006"},"name":{"maxLength":255,"type":"string","x-stream-index":"001"},"visibility":{"enum":["public","visible","followers","members","private"],"type":"string","x-stream-index":"003"}},"type":"object"},"FeedMemberAddedEvent":{"description":"Emitted when a feed member is added.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"003.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.001.007"},"feed_visibility":{"type":"string","x-stream-index":"003.003"},"fid":{"type":"string","x-stream-index":"003.002"},"member":{"$ref":"#/components/schemas/FeedMemberResponse","description":"The member that was added","title":"Member","x-stream-index":"001"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.001.004"},"type":{"default":"feeds.feed_member.added","description":"The type of event: \"feeds.feed_member.added\" in this case","title":"Event Type","type":"string","x-stream-index":"003.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who added the member","title":"User","x-stream-index":"002.001"}},"required":["member","type","created_at","custom","fid"],"title":"FeedMemberAddedEvent","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"},"FeedMemberRemovedEvent":{"description":"Emitted when a feed member is removed.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"003.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.001.007"},"feed_visibility":{"type":"string","x-stream-index":"003.003"},"fid":{"type":"string","x-stream-index":"003.002"},"member_id":{"type":"string","x-stream-index":"001"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.001.004"},"type":{"default":"feeds.feed_member.removed","description":"The type of event: \"feeds.feed_member.removed\" in this case","title":"Event Type","type":"string","x-stream-index":"003.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who removed the member","title":"User","x-stream-index":"002.001"}},"required":["member_id","type","created_at","custom","fid"],"title":"FeedMemberRemovedEvent","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"},"FeedMemberRequest":{"properties":{"custom":{"additionalProperties":{},"description":"Custom data for the member","title":"Custom Data","type":"object","x-stream-index":"004"},"invite":{"description":"Whether this is an invite to become a member","title":"Invite","type":"boolean","x-stream-index":"005"},"membership_level":{"description":"ID of the membership level to assign to the member","maxLength":255,"title":"Membership Level","type":"string","x-stream-index":"003"},"role":{"description":"Role of the member in the feed","maxLength":255,"title":"Role","type":"string","x-stream-index":"002"},"user_id":{"description":"ID of the user to add as a member","maxLength":255,"title":"User ID","type":"string","x-stream-index":"001"}},"required":["user_id"],"title":"Feed Member Payload","type":"object"},"FeedMemberResponse":{"properties":{"created_at":{"description":"When the membership was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"description":"Custom data for the membership","title":"Custom Data","type":"object","x-stream-index":"007"},"invite_accepted_at":{"description":"When the invite was accepted","format":"date-time","title":"Invite Accepted At","type":"number","x-stream-index":"005"},"invite_rejected_at":{"description":"When the invite was rejected","format":"date-time","title":"Invite Rejected At","type":"number","x-stream-index":"006"},"membership_level":{"$ref":"#/components/schemas/MembershipLevelResponse","description":"Membership level assigned to the member","title":"Membership Level","x-stream-index":"004"},"role":{"description":"Role of the member in the feed","title":"Role","type":"string","x-stream-index":"002"},"status":{"description":"Status of the membership","enum":["member","pending","rejected"],"title":"Status","type":"string","x-stream-index":"003"},"updated_at":{"description":"When the membership was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who is a member","title":"User","x-stream-index":"001"}},"required":["user","role","status","created_at","updated_at"],"title":"Feed Member","type":"object"},"FeedMemberUpdatedEvent":{"description":"Emitted when a feed member is updated.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"003.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.001.007"},"feed_visibility":{"type":"string","x-stream-index":"003.003"},"fid":{"type":"string","x-stream-index":"003.002"},"member":{"$ref":"#/components/schemas/FeedMemberResponse","description":"The member that was updated","title":"Member","x-stream-index":"001"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.001.004"},"type":{"default":"feeds.feed_member.updated","description":"The type of event: \"feeds.feed_member.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"003.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who updated the member","title":"User","x-stream-index":"002.001"}},"required":["member","type","created_at","custom","fid"],"title":"FeedMemberUpdatedEvent","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"},"FeedOwnCapability":{"description":"All possibility of string to use","enum":["add-activity","add-activity-reaction","add-comment","add-comment-reaction","bookmark-activity","create-feed","delete-bookmark","delete-comment","delete-feed","edit-bookmark","follow","invite-feed","join-feed","leave-feed","manage-feed-group","mark-activity","pin-activity","query-feed-members","query-follows","read-activities","read-feed","remove-activity","remove-activity-reaction","remove-comment-reaction","unfollow","update-activity","update-comment","update-feed","update-feed-followers","update-feed-members"],"title":"FeedOwnCapability","type":"string"},"FeedRequest":{"properties":{"created_by_id":{"description":"ID of the feed creator","title":"Created By ID","type":"string","x-stream-index":"003"},"custom":{"additionalProperties":{},"description":"Custom data for the feed","title":"Custom Data","type":"object","x-stream-index":"004.004"},"description":{"description":"Description of the feed","maxLength":1000,"title":"Description","type":"string","x-stream-index":"004.002"},"feed_group_id":{"description":"ID of the feed group","maxLength":255,"title":"Feed Group ID","type":"string","x-stream-index":"001"},"feed_id":{"description":"ID of the feed","maxLength":255,"title":"Feed ID","type":"string","x-stream-index":"002"},"filter_tags":{"description":"Tags used for filtering feeds","items":{"type":"string"},"maximum":255,"title":"Filter Tags","type":"array","x-stream-index":"004.005"},"members":{"description":"Initial members for the feed","items":{"$ref":"#/components/schemas/FeedMemberRequest"},"title":"Members","type":"array","x-stream-index":"004.006"},"name":{"description":"Name of the feed","maxLength":255,"title":"Name","type":"string","x-stream-index":"004.001"},"visibility":{"description":"Visibility setting for the feed","enum":["public","visible","followers","members","private"],"title":"Visibility","type":"string","x-stream-index":"004.003"}},"required":["feed_group_id","feed_id"],"title":"Feed Payload","type":"object"},"FeedResponse":{"properties":{"created_at":{"description":"When the feed was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"015"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"User who created the feed","title":"Created By","x-stream-index":"009"},"custom":{"additionalProperties":{},"description":"Custom data for the feed","title":"Custom Data","type":"object","x-stream-index":"006"},"deleted_at":{"description":"When the feed was deleted","format":"date-time","title":"Deleted At","type":"number","x-stream-index":"017"},"description":{"description":"Description of the feed","title":"Description","type":"string","x-stream-index":"005"},"feed":{"description":"Fully qualified feed ID (group_id:id)","title":"FID","type":"string","x-stream-index":"003"},"filter_tags":{"description":"Tags used for filtering feeds","items":{"type":"string"},"title":"Filter Tags","type":"array","x-stream-index":"007"},"follower_count":{"description":"Number of followers of this feed","format":"int32","title":"Follower Count","type":"integer","x-stream-index":"011"},"following_count":{"description":"Number of feeds this feed follows","format":"int32","title":"Following Count","type":"integer","x-stream-index":"012"},"group_id":{"description":"Group this feed belongs to","title":"Group ID","type":"string","x-stream-index":"001"},"id":{"description":"Unique identifier for the feed","title":"ID","type":"string","x-stream-index":"002"},"member_count":{"description":"Number of members in this feed","format":"int32","title":"Member Count","type":"integer","x-stream-index":"010"},"name":{"description":"Name of the feed","title":"Name","type":"string","x-stream-index":"004"},"own_follows":{"description":"Follow relationships where the current user's feeds are following this feed","items":{"$ref":"#/components/schemas/FollowResponse"},"title":"Own Follows","type":"array","x-stream-index":"014"},"pin_count":{"description":"Number of pinned activities in this feed","format":"int32","title":"Pin Count","type":"integer","x-stream-index":"013"},"updated_at":{"description":"When the feed was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"016"},"visibility":{"description":"Visibility setting for the feed","title":"Visibility","type":"string","x-stream-index":"008"}},"required":["group_id","id","feed","name","description","created_by","member_count","follower_count","following_count","pin_count","created_at","updated_at"],"title":"Feed","type":"object"},"FeedUpdatedEvent":{"description":"Emitted when a feed is created.","nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed":{"$ref":"#/components/schemas/FeedResponse","description":"The feed that was created","title":"Feed","x-stream-index":"001"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"type":"string","x-stream-index":"002.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.feed.updated","description":"The type of event: \"feeds.feed.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who created the feed","title":"User","x-stream-index":"003.001"}},"required":["feed","type","created_at","custom","fid"],"title":"FeedUpdatedEvent","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"},"FeedsEventPreferences":{"properties":{"comments":{"type":"string","x-stream-index":"002"},"mentions":{"type":"string","x-stream-index":"004"},"new_followers":{"type":"string","x-stream-index":"003"},"reactions":{"type":"string","x-stream-index":"001"}},"type":"object"},"FeedsEventPreferencesInput":{"properties":{"comments":{"enum":["all","none"],"type":"string","x-stream-index":"002"},"mentions":{"enum":["all","none"],"type":"string","x-stream-index":"004"},"new_followers":{"enum":["all","none"],"type":"string","x-stream-index":"003"},"reactions":{"enum":["all","none"],"type":"string","x-stream-index":"001"}},"type":"object"},"FeedsReactionResponse":{"properties":{"activity_id":{"description":"ID of the activity that was reacted to","title":"Activity ID","type":"string","x-stream-index":"002"},"comment_id":{"description":"ID of the comment that was reacted to","title":"Comment ID","type":"string","x-stream-index":"003"},"created_at":{"description":"When the reaction was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"006"},"custom":{"additionalProperties":{},"description":"Custom data for the reaction","title":"Custom Data","type":"object","x-stream-index":"005"},"type":{"description":"Type of reaction","title":"Type","type":"string","x-stream-index":"004"},"updated_at":{"description":"When the reaction was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"007"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who created the reaction","title":"User","x-stream-index":"001"}},"required":["user","activity_id","type","created_at","updated_at"],"title":"Activity Reaction","type":"object"},"Field":{"nullable":true,"properties":{"short":{"type":"boolean","x-stream-index":"003"},"title":{"type":"string","x-stream-index":"001"},"value":{"type":"string","x-stream-index":"002"}},"required":["title","value","short"],"type":"object"},"FileUploadConfig":{"properties":{"allowed_file_extensions":{"items":{"type":"string"},"type":"array","x-stream-index":"001"},"allowed_mime_types":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"blocked_file_extensions":{"items":{"type":"string"},"type":"array","x-stream-index":"002"},"blocked_mime_types":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"size_limit":{"format":"int32","maximum":104857600,"minimum":0,"type":"integer","x-stream-index":"005"}},"required":["allowed_file_extensions","blocked_file_extensions","allowed_mime_types","blocked_mime_types","size_limit"],"type":"object"},"FileUploadRequest":{"nullable":true,"properties":{"file":{"description":"file field","title":"File","type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/OnlyUserID","description":"user for the request **server side only**","title":"User","x-stream-index":"002"}},"type":"object"},"FileUploadResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"file":{"description":"URL to the uploaded asset. Should be used to put to `asset_url` attachment field","title":"File","type":"string","x-stream-index":"001"},"thumb_url":{"description":"URL of the file thumbnail for supported file formats. Should be put to `thumb_url` attachment field","title":"Thumbnail URL","type":"string","x-stream-index":"002"}},"required":["duration"],"type":"object"},"Flag":{"description":"Contains information about flagged user or message","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"019"},"custom":{"additionalProperties":{},"description":"Additional metadata about the flag","title":"Custom","type":"object","x-stream-index":"014"},"entity_creator_id":{"description":"ID of the user who created the flagged entity","title":"Entity Creator ID","type":"string","x-stream-index":"009"},"entity_id":{"description":"Unique identifier of the entity being flagged","title":"Entity ID","type":"string","x-stream-index":"008"},"entity_type":{"description":"Type of entity being flagged (e.g., message, user)","title":"Entity Type","type":"string","x-stream-index":"007"},"is_streamed_content":{"type":"boolean","x-stream-index":"012"},"labels":{"description":"Labels from bodyguard, API calls, our own AI etc","items":{"type":"string"},"title":"Labels","type":"array","x-stream-index":"015"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content being flagged","title":"Moderation Payload","x-stream-index":"010"},"moderation_payload_hash":{"type":"string","x-stream-index":"011"},"reason":{"description":"Optional explanation for why the content is being flagged","title":"Reason","type":"string","x-stream-index":"013"},"result":{"description":"Result of bodyguard, API calls, our own AI etc","items":{"additionalProperties":{},"type":"object"},"title":"Result","type":"array","x-stream-index":"016"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"018"},"review_queue_item_id":{"description":"ID of the review queue item","title":"Review Queue Item ID","type":"string","x-stream-index":"017"},"type":{"type":"string","x-stream-index":"004"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"020"},"user":{"$ref":"#/components/schemas/User","description":"User who flagged a message or a user","title":"User","x-stream-index":"006"}},"required":["entity_type","entity_id","result","created_at","updated_at"],"title":"Flag","type":"object"},"FlagContentOptions":{"properties":{"reason":{"type":"string","x-stream-index":"001"}},"type":"object"},"FlagDetails":{"properties":{"Extra":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"002"},"automod":{"$ref":"#/components/schemas/AutomodDetails","x-stream-index":"001"},"original_text":{"type":"string","x-stream-index":"003"}},"required":["Extra","original_text"],"type":"object"},"FlagFeedback":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"005"},"labels":{"items":{"$ref":"#/components/schemas/Label"},"type":"array","x-stream-index":"006"},"message_id":{"type":"string","x-stream-index":"004"}},"required":["message_id","created_at","labels"],"type":"object"},"FlagMessageDetails":{"properties":{"pin_changed":{"type":"boolean","x-stream-index":"002"},"should_enrich":{"type":"boolean","x-stream-index":"003"},"skip_push":{"type":"boolean","x-stream-index":"004"},"updated_by_id":{"type":"string","x-stream-index":"001"}},"type":"object"},"FlagRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"description":"Additional metadata about the flag","title":"Custom","type":"object","x-stream-index":"006"},"entity_creator_id":{"description":"ID of the user who created the flagged entity","title":"Entity Creator ID","type":"string","x-stream-index":"003"},"entity_id":{"description":"Unique identifier of the entity being flagged","title":"Entity ID","type":"string","x-stream-index":"002"},"entity_type":{"description":"Type of entity being flagged (e.g., message, user)","title":"Entity Type","type":"string","x-stream-index":"001"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content being flagged","title":"Moderation Payload","x-stream-index":"005"},"reason":{"description":"Optional explanation for why the content is being flagged","maxLength":255,"title":"Reason","type":"string","x-stream-index":"004"}},"required":["entity_type","entity_id"],"type":"object"},"FlagResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"item_id":{"description":"Unique identifier of the created moderation item","title":"Item ID","type":"string","x-stream-index":"001"}},"required":["item_id","duration"],"type":"object"},"FlagUserOptions":{"properties":{"reason":{"type":"string","x-stream-index":"001"}},"type":"object"},"FollowBatchRequest":{"nullable":true,"properties":{"follows":{"description":"List of follow relationships to create","items":{"$ref":"#/components/schemas/FollowRequest"},"maximum":1000,"minimum":1,"title":"Follows","type":"array","x-stream-index":"001"}},"required":["follows"],"title":"Follow Batch Request","type":"object"},"FollowBatchResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"follows":{"description":"List of created follow relationships","items":{"$ref":"#/components/schemas/FollowResponse"},"title":"Follows","type":"array","x-stream-index":"001"}},"required":["follows","duration"],"title":"Follow Batch Response","type":"object"},"FollowCreatedEvent":{"description":"Emitted when a feed follows another feed.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"type":"string","x-stream-index":"002.002"},"follow":{"$ref":"#/components/schemas/FollowResponse","x-stream-index":"001"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.follow.created","description":"The type of event: \"feeds.follow.created\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"}},"required":["follow","type","created_at","custom","fid"],"title":"FollowCreatedEvent","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"},"FollowDeletedEvent":{"description":"Emitted when a feed unfollows another feed.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"type":"string","x-stream-index":"002.002"},"follow":{"$ref":"#/components/schemas/FollowResponse","x-stream-index":"001"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.follow.deleted","description":"The type of event: \"feeds.follow.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"}},"required":["follow","type","created_at","custom","fid"],"title":"FollowDeletedEvent","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"},"FollowRequest":{"nullable":true,"properties":{"create_notification_activity":{"description":"Whether to create a notification activity for this follow","title":"Create Notification Activity","type":"boolean","x-stream-index":"004"},"custom":{"additionalProperties":{},"description":"Custom data for the follow relationship","title":"Custom Data","type":"object","x-stream-index":"002"},"push_preference":{"description":"Push preference for the follow relationship","enum":["all","none"],"title":"Push Preference","type":"string","x-stream-index":"003"},"skip_push":{"type":"boolean","x-stream-index":"005"},"source":{"description":"Fully qualified ID of the source feed","maxLength":255,"title":"Source Feed","type":"string","x-stream-index":"001.001"},"target":{"description":"Fully qualified ID of the target feed","maxLength":255,"title":"Target Feed","type":"string","x-stream-index":"001.002"}},"required":["source","target"],"title":"Follow Request","type":"object"},"FollowResponse":{"properties":{"created_at":{"description":"When the follow relationship was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"009"},"custom":{"additionalProperties":{},"description":"Custom data for the follow relationship","title":"Custom Data","type":"object","x-stream-index":"004"},"follower_role":{"description":"Role of the follower (source user) in the follow relationship","title":"Follower Role","type":"string","x-stream-index":"008"},"push_preference":{"description":"Push preference for notifications","enum":["all","none"],"title":"Push Preference","type":"string","x-stream-index":"003"},"request_accepted_at":{"description":"When the follow request was accepted","format":"date-time","title":"Request Accepted At","type":"number","x-stream-index":"005"},"request_rejected_at":{"description":"When the follow request was rejected","format":"date-time","title":"Request Rejected At","type":"number","x-stream-index":"006"},"source_feed":{"$ref":"#/components/schemas/FeedResponse","description":"Source feed object","title":"Source Feed","x-stream-index":"001"},"status":{"description":"Status of the follow relationship","enum":["accepted","pending","rejected"],"title":"Status","type":"string","x-stream-index":"007"},"target_feed":{"$ref":"#/components/schemas/FeedResponse","description":"Target feed object","title":"Target Feed","x-stream-index":"002"},"updated_at":{"description":"When the follow relationship was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"010"}},"required":["source_feed","target_feed","push_preference","status","follower_role","created_at","updated_at"],"title":"Follow","type":"object"},"FollowUpdatedEvent":{"description":"Emitted when a follow relationship is updated.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"type":"string","x-stream-index":"002.002"},"follow":{"$ref":"#/components/schemas/FollowResponse","x-stream-index":"001"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.follow.updated","description":"The type of event: \"feeds.follow.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"}},"required":["follow","type","created_at","custom","fid"],"title":"FollowUpdatedEvent","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"},"FrameRecordSettings":{"properties":{"capture_interval_in_seconds":{"format":"int32","maximum":60,"minimum":2,"type":"integer","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"},"quality":{"type":"string","x-stream-index":"002"}},"required":["mode","capture_interval_in_seconds"],"type":"object"},"FrameRecordingEgressConfig":{"properties":{"capture_interval_in_seconds":{"format":"int32","type":"integer","x-stream-index":"007"},"external_storage":{"$ref":"#/components/schemas/ExternalStorage","x-stream-index":"006"},"quality":{"$ref":"#/components/schemas/Quality","x-stream-index":"004"},"storage_name":{"type":"string","x-stream-index":"005"}},"type":"object"},"FrameRecordingResponse":{"properties":{"status":{"type":"string","x-stream-index":"001"}},"required":["status"],"type":"object"},"FrameRecordingSettingsRequest":{"properties":{"capture_interval_in_seconds":{"format":"int32","maximum":60,"minimum":2,"type":"integer","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"},"quality":{"enum":["360p","480p","720p","1080p","1440p"],"type":"string","x-stream-index":"002"}},"required":["mode","capture_interval_in_seconds"],"type":"object"},"FrameRecordingSettingsResponse":{"properties":{"capture_interval_in_seconds":{"format":"int32","maximum":60,"minimum":2,"type":"integer","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"},"quality":{"type":"string","x-stream-index":"002"}},"required":["mode","capture_interval_in_seconds"],"type":"object"},"FullUserResponse":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"015"},"banned":{"type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"014"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.011"},"devices":{"items":{"$ref":"#/components/schemas/DeviceResponse"},"type":"array","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001.001"},"image":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"005"},"language":{"type":"string","x-stream-index":"001.005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"001.014"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"012"},"mutes":{"items":{"$ref":"#/components/schemas/UserMuteResponse"},"type":"array","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"001.002"},"online":{"type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"003"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.015"},"role":{"type":"string","x-stream-index":"001.006"},"shadow_banned":{"type":"boolean","x-stream-index":"013"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"009"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"010"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"008"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"011"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","devices","invisible","mutes","channel_mutes","unread_count","total_unread_count","unread_channels","unread_threads","shadow_banned","blocked_user_ids"],"type":"object"},"GeofenceSettings":{"properties":{"names":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"required":["names"],"type":"object"},"GeofenceSettingsRequest":{"properties":{"names":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"type":"object"},"GeofenceSettingsResponse":{"properties":{"names":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"required":["names"],"type":"object"},"GetActivityResponse":{"nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","description":"The requested activity","title":"Activity","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["activity","duration"],"title":"Get Activity Response","type":"object"},"GetApplicationResponse":{"description":"Basic response information","nullable":true,"properties":{"app":{"$ref":"#/components/schemas/AppResponseFields","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["app","duration"],"title":"Response","type":"object"},"GetBlockedUsersResponse":{"nullable":true,"properties":{"blocks":{"description":"Array of blocked user object","items":{"$ref":"#/components/schemas/BlockedUserResponse"},"title":"Blocks","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["blocks","duration"],"type":"object"},"GetCallReportResponse":{"description":"Basic response information","nullable":true,"properties":{"chat_activity":{"$ref":"#/components/schemas/ChatActivityStatsResponse","x-stream-index":"004"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"report":{"$ref":"#/components/schemas/ReportResponse","x-stream-index":"003"},"session_id":{"type":"string","x-stream-index":"002"},"video_reactions":{"items":{"$ref":"#/components/schemas/VideoReactionsResponse"},"type":"array","x-stream-index":"005"}},"required":["duration","session_id","report"],"title":"Response","type":"object"},"GetCallResponse":{"nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001.001"},"duration":{"type":"string","x-stream-index":"002.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001.002"},"membership":{"$ref":"#/components/schemas/MemberResponse","x-stream-index":"001.003"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"001.004"}},"required":["call","members","own_capabilities","blocked_users","duration"],"title":"GetCallResponse","type":"object"},"GetCommentRepliesResponse":{"nullable":true,"properties":{"comments":{"description":"Threaded listing of replies to the comment","items":{"$ref":"#/components/schemas/ThreadedCommentResponse"},"title":"Comments","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["comments","duration"],"title":"Get Comment Replies Response","type":"object"},"GetCommentResponse":{"nullable":true,"properties":{"comment":{"$ref":"#/components/schemas/CommentResponse","description":"Comment","title":"Comment","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["comment","duration"],"title":"Get Comment Response","type":"object"},"GetCommentsResponse":{"nullable":true,"properties":{"comments":{"description":"Threaded listing for the activity","items":{"$ref":"#/components/schemas/ThreadedCommentResponse"},"title":"Comments","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["comments","duration"],"title":"Get Comments Response","type":"object"},"GetConfigResponse":{"nullable":true,"properties":{"config":{"$ref":"#/components/schemas/ConfigResponse","description":"The retrieved moderation configuration","title":"Config","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["duration"],"type":"object"},"GetDraftResponse":{"description":"Basic response information","nullable":true,"properties":{"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["draft","duration"],"title":"Response","type":"object"},"GetEdgesResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"edges":{"items":{"$ref":"#/components/schemas/EdgeResponse"},"type":"array","x-stream-index":"001"}},"required":["edges","duration"],"title":"Response","type":"object"},"GetFollowSuggestionsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"suggestions":{"description":"List of suggested feeds to follow","items":{"$ref":"#/components/schemas/FeedResponse"},"title":"Suggestions","type":"array","x-stream-index":"001"}},"required":["suggestions","duration"],"title":"Follow Suggestions Response","type":"object"},"GetManyMessagesResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.002.001"},"messages":{"description":"List of messages","items":{"$ref":"#/components/schemas/MessageResponse"},"title":"Messages","type":"array","x-stream-index":"001.001"}},"required":["messages","duration"],"type":"object"},"GetMessageResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageWithChannelResponse","x-stream-index":"001"},"pending_message_metadata":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"002"}},"required":["message","duration"],"title":"Response","type":"object"},"GetOGResponse":{"nullable":true,"properties":{"actions":{"items":{"$ref":"#/components/schemas/Action"},"type":"array","x-stream-index":"001.015"},"asset_url":{"description":"URL of detected video or audio","title":"Image URL","type":"string","x-stream-index":"001.017"},"author_icon":{"type":"string","x-stream-index":"001.007"},"author_link":{"description":"og:site","title":"Author Link","type":"string","x-stream-index":"001.006"},"author_name":{"description":"og:site_name","title":"Author Name","type":"string","x-stream-index":"001.005"},"color":{"type":"string","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.018"},"duration":{"type":"string","x-stream-index":"002.001"},"fallback":{"type":"string","x-stream-index":"001.002"},"fields":{"items":{"$ref":"#/components/schemas/Field"},"type":"array","x-stream-index":"001.016"},"footer":{"type":"string","x-stream-index":"001.013"},"footer_icon":{"type":"string","x-stream-index":"001.014"},"giphy":{"$ref":"#/components/schemas/Images","x-stream-index":"001.019"},"image_url":{"description":"URL of detected image","title":"Image URL","type":"string","x-stream-index":"001.011"},"og_scrape_url":{"description":"extracted url from the text","title":"OG Scrape URL","type":"string","x-stream-index":"001.020"},"original_height":{"format":"int32","type":"integer","x-stream-index":"001.022"},"original_width":{"format":"int32","type":"integer","x-stream-index":"001.021"},"pretext":{"type":"string","x-stream-index":"001.004"},"text":{"description":"og:description","title":"Text","type":"string","x-stream-index":"001.010"},"thumb_url":{"description":"URL of detected thumb image","title":"Image URL","type":"string","x-stream-index":"001.012"},"title":{"description":"og:title","title":"Title","type":"string","x-stream-index":"001.008"},"title_link":{"description":"og:url","title":"Title Link","type":"string","x-stream-index":"001.009"},"type":{"description":"Attachment type, could be empty, image, audio or video","title":"Type","type":"string","x-stream-index":"001.001"}},"required":["custom","duration"],"title":"Get OG Attachment","type":"object","x-stream-docs-page-id":"og"},"GetOrCreateCallRequest":{"nullable":true,"properties":{"data":{"$ref":"#/components/schemas/CallRequest","title":"ReadOnlyData","x-stream-index":"003"},"members_limit":{"format":"int32","maximum":100,"type":"integer","x-stream-index":"007"},"notify":{"description":"if provided it sends a notification event to the members for this call","title":"Notify","type":"boolean","x-stream-index":"005"},"ring":{"description":"if provided it sends a ring event to the members for this call","title":"Ring","type":"boolean","x-stream-index":"004"},"video":{"type":"boolean","x-stream-index":"006"}},"title":"GetOrCreateCallRequest","type":"object"},"GetOrCreateCallResponse":{"nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001.001"},"created":{"type":"boolean","x-stream-index":"002"},"duration":{"type":"string","x-stream-index":"003.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001.002"},"membership":{"$ref":"#/components/schemas/MemberResponse","x-stream-index":"001.003"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"001.004"}},"required":["call","members","own_capabilities","blocked_users","created","duration"],"title":"GetOrCreateCallResponse","type":"object"},"GetOrCreateFeedRequest":{"description":"Client request","nullable":true,"properties":{"activity_selector_options":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"data":{"$ref":"#/components/schemas/FeedInput","x-stream-index":"003"},"external_ranking":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"filter":{"additionalProperties":{},"type":"object","x-stream-index":"009"},"followers_pagination":{"$ref":"#/components/schemas/PagerRequest","x-stream-index":"011"},"following_pagination":{"$ref":"#/components/schemas/PagerRequest","x-stream-index":"012"},"interest_weights":{"additionalProperties":{"format":"float","type":"number"},"type":"object","x-stream-index":"008"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"013.001"},"member_pagination":{"$ref":"#/components/schemas/PagerRequest","x-stream-index":"010"},"next":{"type":"string","x-stream-index":"013.002"},"prev":{"type":"string","x-stream-index":"013.003"},"view":{"type":"string","x-stream-index":"005"},"watch":{"type":"boolean","x-stream-index":"004"}},"title":"ClientRequest","type":"object"},"GetOrCreateFeedResponse":{"description":"Basic response information","nullable":true,"properties":{"activities":{"items":{"$ref":"#/components/schemas/ActivityResponse"},"type":"array","x-stream-index":"002"},"aggregated_activities":{"items":{"$ref":"#/components/schemas/AggregatedActivityResponse"},"type":"array","x-stream-index":"003"},"created":{"type":"boolean","x-stream-index":"015"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"017.001"},"feed":{"$ref":"#/components/schemas/FeedResponse","x-stream-index":"001"},"followers":{"items":{"$ref":"#/components/schemas/FollowResponse"},"type":"array","x-stream-index":"005"},"followers_pagination":{"$ref":"#/components/schemas/PagerResponse","x-stream-index":"012"},"following":{"items":{"$ref":"#/components/schemas/FollowResponse"},"type":"array","x-stream-index":"006"},"following_pagination":{"$ref":"#/components/schemas/PagerResponse","x-stream-index":"013"},"member_pagination":{"$ref":"#/components/schemas/PagerResponse","x-stream-index":"011"},"members":{"items":{"$ref":"#/components/schemas/FeedMemberResponse"},"type":"array","x-stream-index":"004"},"next":{"type":"string","x-stream-index":"016.001"},"notification_status":{"$ref":"#/components/schemas/NotificationStatusResponse","x-stream-index":"014"},"own_capabilities":{"items":{"$ref":"#/components/schemas/FeedOwnCapability"},"type":"array","x-stream-index":"008"},"own_follows":{"items":{"$ref":"#/components/schemas/FollowResponse"},"type":"array","x-stream-index":"009"},"own_membership":{"$ref":"#/components/schemas/FeedMemberResponse","x-stream-index":"010"},"pinned_activities":{"items":{"$ref":"#/components/schemas/ActivityPinResponse"},"type":"array","x-stream-index":"007"},"prev":{"type":"string","x-stream-index":"016.002"}},"required":["feed","activities","aggregated_activities","members","followers","following","pinned_activities","own_capabilities","created","duration"],"title":"Response","type":"object"},"GetReactionsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"reactions":{"description":"List of reactions","items":{"$ref":"#/components/schemas/Reaction"},"title":"Reactions","type":"array","x-stream-index":"001"}},"required":["reactions","duration"],"type":"object"},"GetRepliesResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"messages":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","x-stream-index":"001"}},"required":["messages","duration"],"title":"Response","type":"object"},"GetThreadResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"thread":{"$ref":"#/components/schemas/ThreadStateResponse","description":"Enriched thread state","title":"Thread","x-stream-index":"001"}},"required":["thread","duration"],"type":"object"},"GoLiveRequest":{"nullable":true,"properties":{"recording_storage_name":{"type":"string","x-stream-index":"005"},"start_closed_caption":{"type":"boolean","x-stream-index":"008"},"start_hls":{"type":"boolean","x-stream-index":"003"},"start_recording":{"type":"boolean","x-stream-index":"004"},"start_transcription":{"type":"boolean","x-stream-index":"007"},"transcription_storage_name":{"type":"string","x-stream-index":"006"}},"title":"GoLiveRequest","type":"object"},"GoLiveResponse":{"description":"Basic response information","nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["call","duration"],"title":"Response","type":"object"},"GoogleVisionConfig":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"GroupedStatsResponse":{"nullable":true,"properties":{"name":{"type":"string","x-stream-index":"001"},"unique":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["name","unique"],"type":"object"},"HLSEgressConfig":{"properties":{"composite_app_settings":{"$ref":"#/components/schemas/CompositeAppSettings","x-stream-index":"005"},"playlist_url":{"type":"string","x-stream-index":"007"},"qualities":{"items":{"$ref":"#/components/schemas/Quality"},"type":"array","x-stream-index":"004"},"start_unix_nano":{"format":"int64","type":"integer","x-stream-index":"006"}},"type":"object"},"HLSSettings":{"properties":{"auto_on":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"004"},"quality_tracks":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"required":["auto_on","enabled","quality_tracks"],"type":"object"},"HLSSettingsRequest":{"properties":{"auto_on":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"quality_tracks":{"items":{"type":"string"},"maximum":3,"minimum":1,"type":"array","x-stream-index":"003"}},"required":["quality_tracks"],"title":"HLSSettingsRequest","type":"object"},"HLSSettingsResponse":{"description":"HLSSettings is the payload for HLS settings","properties":{"auto_on":{"title":"Auto On","type":"boolean","x-stream-index":"001"},"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"002"},"quality_tracks":{"items":{"type":"string"},"title":"Quality Tracks","type":"array","x-stream-index":"003"}},"required":["auto_on","enabled","quality_tracks","layout"],"title":"HLSSettingsResponse","type":"object"},"HarmConfig":{"properties":{"action_sequences":{"items":{"$ref":"#/components/schemas/ActionSequence"},"type":"array","x-stream-index":"001"},"severity":{"type":"integer","x-stream-index":"002"}},"required":["action_sequences","severity"],"type":"object"},"HealthCheckEvent":{"nullable":true,"properties":{"cid":{"type":"string","x-stream-index":"003"},"connection_id":{"type":"string","x-stream-index":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004.007"},"me":{"$ref":"#/components/schemas/OwnUserResponse","x-stream-index":"002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"004.004"},"type":{"default":"health.check","type":"string","x-stream-index":"004.002"}},"required":["connection_id","type","created_at","custom"],"title":"HealthCheckEvent","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"},"HideChannelRequest":{"nullable":true,"properties":{"clear_history":{"description":"Whether to clear message history of the channel or not","title":"Clear history","type":"boolean","x-stream-index":"001"}},"type":"object"},"HideChannelResponse":{"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"},"ICEServer":{"properties":{"password":{"type":"string","x-stream-index":"003"},"urls":{"items":{"type":"string"},"type":"array","x-stream-index":"001"},"username":{"type":"string","x-stream-index":"002"}},"required":["urls","username","password"],"type":"object"},"ImageContentParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"type":"object"},"ImageData":{"properties":{"frames":{"type":"string","x-stream-index":"005"},"height":{"type":"string","x-stream-index":"003"},"size":{"type":"string","x-stream-index":"004"},"url":{"type":"string","x-stream-index":"001"},"width":{"type":"string","x-stream-index":"002"}},"required":["url","width","height","size","frames"],"type":"object"},"ImageRuleParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"type":"object"},"ImageSize":{"properties":{"crop":{"description":"Crop mode","enum":["top","bottom","left","right","center"],"title":"Crop","type":"string","x-stream-index":"001"},"height":{"description":"Target image height","format":"int32","title":"Height","type":"integer","x-stream-index":"003"},"resize":{"description":"Resize method","enum":["clip","crop","scale","fill"],"title":"Resize","type":"string","x-stream-index":"002"},"width":{"description":"Target image width","format":"int32","title":"Width","type":"integer","x-stream-index":"004"}},"title":"Image size configuration","type":"object"},"ImageUploadRequest":{"nullable":true,"properties":{"file":{"type":"string","x-stream-index":"001.001"},"upload_sizes":{"description":"field with JSON-encoded array of image size configurations","items":{"$ref":"#/components/schemas/ImageSize"},"title":"Upload sizes","type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/OnlyUserID","x-stream-index":"001.002"}},"type":"object"},"ImageUploadResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.003.001"},"file":{"type":"string","x-stream-index":"001.001"},"thumb_url":{"type":"string","x-stream-index":"001.002"},"upload_sizes":{"description":"Array of image size configurations","items":{"$ref":"#/components/schemas/ImageSize"},"title":"Upload sizes","type":"array","x-stream-index":"002"}},"required":["duration"],"type":"object"},"Images":{"properties":{"fixed_height":{"$ref":"#/components/schemas/ImageData","x-stream-index":"002"},"fixed_height_downsampled":{"$ref":"#/components/schemas/ImageData","x-stream-index":"004"},"fixed_height_still":{"$ref":"#/components/schemas/ImageData","x-stream-index":"003"},"fixed_width":{"$ref":"#/components/schemas/ImageData","x-stream-index":"005"},"fixed_width_downsampled":{"$ref":"#/components/schemas/ImageData","x-stream-index":"007"},"fixed_width_still":{"$ref":"#/components/schemas/ImageData","x-stream-index":"006"},"original":{"$ref":"#/components/schemas/ImageData","x-stream-index":"001"}},"required":["original","fixed_height","fixed_height_still","fixed_height_downsampled","fixed_width","fixed_width_still","fixed_width_downsampled"],"type":"object"},"IngressAudioEncodingOptions":{"properties":{"bitrate":{"maximum":128000,"minimum":16000,"type":"integer","x-stream-index":"003"},"channels":{"enum":["1","2"],"format":"int32","type":"integer","x-stream-index":"001"},"enable_dtx":{"type":"boolean","x-stream-index":"002"}},"required":["channels","enable_dtx","bitrate"],"type":"object"},"IngressAudioEncodingOptionsRequest":{"properties":{"bitrate":{"maximum":128000,"minimum":16000,"type":"integer","x-stream-index":"003"},"channels":{"enum":["1","2"],"format":"int32","type":"integer","x-stream-index":"001"},"enable_dtx":{"type":"boolean","x-stream-index":"002"}},"required":["channels","bitrate"],"type":"object"},"IngressAudioEncodingResponse":{"properties":{"bitrate":{"format":"int32","type":"integer","x-stream-index":"003"},"channels":{"format":"int32","type":"integer","x-stream-index":"001"},"enable_dtx":{"type":"boolean","x-stream-index":"002"}},"required":["channels","enable_dtx","bitrate"],"type":"object"},"IngressSettings":{"properties":{"audio_encoding_options":{"$ref":"#/components/schemas/IngressAudioEncodingOptions","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"video_encoding_options":{"additionalProperties":{"$ref":"#/components/schemas/IngressVideoEncodingOptions"},"type":"object","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"IngressSettingsRequest":{"properties":{"audio_encoding_options":{"$ref":"#/components/schemas/IngressAudioEncodingOptionsRequest","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"video_encoding_options":{"additionalProperties":{"$ref":"#/components/schemas/IngressVideoEncodingOptionsRequest"},"type":"object","x-stream-index":"003"}},"type":"object"},"IngressSettingsResponse":{"properties":{"audio_encoding_options":{"$ref":"#/components/schemas/IngressAudioEncodingResponse","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"video_encoding_options":{"additionalProperties":{"$ref":"#/components/schemas/IngressVideoEncodingResponse"},"type":"object","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"IngressVideoEncodingOptions":{"properties":{"layers":{"items":{"$ref":"#/components/schemas/IngressVideoLayer"},"minimum":1,"type":"array","x-stream-index":"001"}},"required":["layers"],"type":"object"},"IngressVideoEncodingOptionsRequest":{"properties":{"layers":{"items":{"$ref":"#/components/schemas/IngressVideoLayerRequest"},"minimum":1,"type":"array","x-stream-index":"001"}},"required":["layers"],"type":"object"},"IngressVideoEncodingResponse":{"properties":{"layers":{"items":{"$ref":"#/components/schemas/IngressVideoLayerResponse"},"type":"array","x-stream-index":"001"}},"required":["layers"],"type":"object"},"IngressVideoLayer":{"nullable":true,"properties":{"bitrate":{"minimum":1000,"type":"integer","x-stream-index":"002"},"codec":{"enum":["h264","vp8"],"type":"string","x-stream-index":"001"},"frame_rate":{"maximum":60,"minimum":1,"type":"integer","x-stream-index":"003"},"max_dimension":{"minimum":240,"type":"integer","x-stream-index":"005"},"min_dimension":{"minimum":240,"type":"integer","x-stream-index":"004"}},"required":["codec","bitrate","frame_rate","min_dimension","max_dimension"],"type":"object"},"IngressVideoLayerRequest":{"nullable":true,"properties":{"bitrate":{"format":"int32","minimum":1000,"type":"integer","x-stream-index":"002"},"codec":{"enum":["h264","vp8"],"type":"string","x-stream-index":"001"},"frame_rate_limit":{"maximum":60,"minimum":1,"type":"integer","x-stream-index":"005"},"max_dimension":{"minimum":240,"type":"integer","x-stream-index":"004"},"min_dimension":{"minimum":240,"type":"integer","x-stream-index":"003"}},"required":["codec","bitrate","min_dimension","max_dimension","frame_rate_limit"],"type":"object"},"IngressVideoLayerResponse":{"nullable":true,"properties":{"bitrate":{"type":"integer","x-stream-index":"002"},"codec":{"type":"string","x-stream-index":"001"},"frame_rate_limit":{"type":"integer","x-stream-index":"005"},"max_dimension":{"type":"integer","x-stream-index":"004"},"min_dimension":{"type":"integer","x-stream-index":"003"}},"required":["codec","bitrate","min_dimension","max_dimension","frame_rate_limit"],"type":"object"},"JoinCallRequest":{"nullable":true,"properties":{"create":{"description":"if true the call will be created if it doesn't exist","title":"Create","type":"boolean","x-stream-index":"002"},"data":{"$ref":"#/components/schemas/CallRequest","x-stream-index":"003"},"location":{"title":"Location","type":"string","x-stream-index":"009"},"members_limit":{"format":"int32","maximum":100,"title":"The amount of members that should be returned","type":"integer","x-stream-index":"007"},"migrating_from":{"description":"If the participant is migrating from another SFU, then this is the ID of the previous SFU","title":"MigratingFrom","type":"string","x-stream-index":"010"},"notify":{"type":"boolean","x-stream-index":"005"},"ring":{"description":"if true and the call is created, the notification will include ring=true","title":"Ring","type":"boolean","x-stream-index":"004"},"video":{"type":"boolean","x-stream-index":"006"}},"required":["location"],"title":"JoinCallRequest","type":"object"},"JoinCallResponse":{"nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001.001"},"created":{"title":"Created","type":"boolean","x-stream-index":"002"},"credentials":{"$ref":"#/components/schemas/Credentials","title":"Credentials","x-stream-index":"003"},"duration":{"type":"string","x-stream-index":"005.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001.002"},"membership":{"$ref":"#/components/schemas/MemberResponse","x-stream-index":"001.003"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"001.004"},"stats_options":{"$ref":"#/components/schemas/StatsOptions","x-stream-index":"004"}},"required":["call","members","own_capabilities","blocked_users","created","credentials","stats_options","duration"],"title":"JoinCallResponse","type":"object"},"KickUserRequest":{"description":"KickUserRequest is the payload for kicking a user from a call. Optionally block the user as well.","nullable":true,"properties":{"block":{"description":"If true, also block the user from rejoining the call","title":"Block","type":"boolean","x-stream-index":"004"},"user_id":{"description":"The user to kick","title":"UserID","type":"string","x-stream-index":"003"}},"required":["user_id"],"title":"KickUserRequest","type":"object"},"KickUserResponse":{"description":"KickUserResponse is the payload for kicking a user from a call.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"KickUserResponse","type":"object"},"KickedUserEvent":{"description":"This event is sent to call participants to notify when a user is kicked from a call. Clients should make the kicked user leave the call UI.","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"kicked_by_user":{"$ref":"#/components/schemas/UserResponse","description":"The user that kicked the participant, null if server-side","title":"Kicked by","x-stream-index":"004"},"type":{"default":"call.kicked_user","description":"The type of event: \"call.kicked_user\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user that was kicked","title":"User","x-stream-index":"003"}},"required":["type","created_at","call_cid","user"],"title":"KickedUserEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"LLMConfig":{"properties":{"app_context":{"type":"string","x-stream-index":"005"},"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/LLMRule"},"type":"array","x-stream-index":"003"},"severity_descriptions":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"004"}},"required":["enabled","rules"],"type":"object"},"LLMRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove","keep"],"type":"string","x-stream-index":"003"},"description":{"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"},"severity_rules":{"items":{"$ref":"#/components/schemas/BodyguardSeverityRule"},"type":"array","x-stream-index":"004"}},"required":["label","description","action","severity_rules"],"type":"object"},"Label":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"phrase_list_ids":{"items":{"format":"int32","type":"integer"},"type":"array","x-stream-index":"002"}},"required":["name"],"type":"object"},"LabelThresholds":{"properties":{"block":{"description":"Threshold for automatic message block","format":"float","maximum":1,"minimum":0,"title":"Block","type":"number","x-stream-index":"002"},"flag":{"description":"Threshold for automatic message flag","format":"float","maximum":1,"minimum":0,"title":"Flag","type":"number","x-stream-index":"001"}},"type":"object"},"LayoutSettings":{"properties":{"detect_orientation":{"type":"boolean","x-stream-index":"005"},"external_app_url":{"type":"string","x-stream-index":"003"},"external_css_url":{"type":"string","x-stream-index":"004"},"name":{"enum":["spotlight","grid","single-participant","mobile","custom"],"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"required":["name","external_app_url","external_css_url"],"type":"object"},"LayoutSettingsRequest":{"properties":{"detect_orientation":{"type":"boolean","x-stream-index":"005"},"external_app_url":{"type":"string","x-stream-index":"003"},"external_css_url":{"type":"string","x-stream-index":"004"},"name":{"enum":["spotlight","grid","single-participant","mobile","custom"],"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"required":["name"],"type":"object"},"LimitsSettings":{"properties":{"max_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"004"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"},"max_participants_exclude_owner":{"type":"boolean","x-stream-index":"003"},"max_participants_exclude_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"002"}},"required":["max_participants_exclude_roles"],"type":"object"},"LimitsSettingsRequest":{"properties":{"max_duration_seconds":{"format":"int32","minimum":0,"type":"integer","x-stream-index":"004"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"},"max_participants_exclude_owner":{"type":"boolean","x-stream-index":"003"},"max_participants_exclude_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"002"}},"type":"object"},"LimitsSettingsResponse":{"properties":{"max_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"004"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"},"max_participants_exclude_owner":{"type":"boolean","x-stream-index":"003"},"max_participants_exclude_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"002"}},"required":["max_participants_exclude_roles"],"type":"object"},"ListBlockListResponse":{"description":"Basic response information","nullable":true,"properties":{"blocklists":{"items":{"$ref":"#/components/schemas/BlockListResponse"},"type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["blocklists","duration"],"title":"Response","type":"object"},"ListDevicesResponse":{"description":"List devices response","nullable":true,"properties":{"devices":{"description":"List of devices","items":{"$ref":"#/components/schemas/DeviceResponse"},"title":"Devices","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["devices","duration"],"title":"ListDevicesResponse","type":"object"},"ListRecordingsResponse":{"description":"Response for listing recordings","nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"},"recordings":{"items":{"$ref":"#/components/schemas/CallRecording"},"title":"The list of recordings.","type":"array","x-stream-index":"002"}},"required":["duration","recordings"],"title":"ListRecordingsResponse","type":"object"},"ListTranscriptionsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"},"transcriptions":{"description":"List of transcriptions for the call","items":{"$ref":"#/components/schemas/CallTranscription"},"title":"Transcriptions","type":"array","x-stream-index":"002"}},"required":["duration","transcriptions"],"title":"ListTranscriptionsResponse","type":"object"},"MarkActivityRequest":{"nullable":true,"properties":{"mark_all_read":{"description":"Whether to mark all activities as read","title":"Mark All Read","type":"boolean","x-stream-index":"005"},"mark_all_seen":{"description":"Whether to mark all activities as seen","title":"Mark All Seen","type":"boolean","x-stream-index":"003"},"mark_read":{"description":"List of activity IDs to mark as read","items":{"type":"string"},"title":"Mark Read","type":"array","x-stream-index":"004"},"mark_seen":{"description":"List of activity IDs to mark as seen","items":{"type":"string"},"title":"Mark Seen","type":"array","x-stream-index":"006"},"mark_watched":{"description":"List of activity IDs to mark as watched (for stories)","items":{"type":"string"},"title":"Mark Watched","type":"array","x-stream-index":"007"}},"title":"Mark Activity Request","type":"object"},"MarkChannelsReadRequest":{"nullable":true,"properties":{"read_by_channel":{"additionalProperties":{"type":"string"},"description":"Map of channel ID to last read message ID","maximum":30,"title":"Read by channel","type":"object","x-stream-index":"001"}},"type":"object"},"MarkReadRequest":{"nullable":true,"properties":{"message_id":{"description":"ID of the message that is considered last read by client","title":"Message ID","type":"string","x-stream-index":"001"},"thread_id":{"description":"Optional Thread ID to specifically mark a given thread as read","title":"Thread ID","type":"string","x-stream-index":"002"}},"type":"object"},"MarkReadResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"event":{"$ref":"#/components/schemas/MessageReadEvent","description":"Mark read event","title":"Event","x-stream-index":"001"}},"required":["duration"],"type":"object"},"MarkReviewedRequest":{"properties":{"content_to_mark_as_reviewed_limit":{"format":"int32","maximum":2500,"type":"integer","x-stream-index":"002"},"disable_marking_content_as_reviewed":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"MarkUnreadRequest":{"nullable":true,"properties":{"message_id":{"description":"ID of the message from where the channel is marked unread","title":"Message ID","type":"string","x-stream-index":"001"},"thread_id":{"description":"Mark a thread unread, specify both the thread and message id","title":"Thread ID","type":"string","x-stream-index":"003"}},"type":"object"},"MemberAddedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"002.001"},"type":{"default":"member.added","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MemberAddedEvent","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"},"MemberLookup":{"properties":{"Limit":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"001"}},"required":["Limit"],"type":"object"},"MemberRemovedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"001.001"},"type":{"default":"member.removed","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MemberRemovedEvent","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"},"MemberRequest":{"description":"MemberRequest is the payload for adding a member to a call.","properties":{"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"003"},"role":{"title":"Role","type":"string","x-stream-index":"002"},"user_id":{"minLength":1,"title":"User ID","type":"string","x-stream-index":"001"}},"required":["user_id"],"title":"MemberRequest","type":"object"},"MemberResponse":{"description":"MemberResponse is the payload for a member of a call.","properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"005"},"custom":{"additionalProperties":{},"description":"Custom member response data","title":"Custom","type":"object","x-stream-index":"004"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"007"},"role":{"title":"Role","type":"string","x-stream-index":"003"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"006"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"},"user_id":{"type":"string","x-stream-index":"002"}},"required":["user","user_id","custom","created_at","updated_at"],"title":"MemberResponse","type":"object"},"MemberUpdatedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"005.002"},"channel_type":{"type":"string","x-stream-index":"005.003"},"cid":{"type":"string","x-stream-index":"005.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"002.001"},"type":{"default":"member.updated","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MemberUpdatedEvent","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"},"MembersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"members":{"description":"List of found members","items":{"$ref":"#/components/schemas/ChannelMember"},"title":"Members","type":"array","x-stream-index":"001"}},"required":["members","duration"],"type":"object"},"MembershipLevelResponse":{"properties":{"created_at":{"description":"When the membership level was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"007"},"custom":{"additionalProperties":{},"description":"Custom data for the membership level","title":"Custom Data","type":"object","x-stream-index":"006"},"description":{"description":"Description of the membership level","title":"Description","type":"string","x-stream-index":"003"},"id":{"description":"Unique identifier for the membership level","title":"ID","type":"string","x-stream-index":"001"},"name":{"description":"Display name for the membership level","title":"Name","type":"string","x-stream-index":"002"},"priority":{"description":"Priority level","format":"int32","title":"Priority","type":"integer","x-stream-index":"004"},"tags":{"description":"Activity tags this membership level gives access to","items":{"type":"string"},"title":"Tags","type":"array","x-stream-index":"005"},"updated_at":{"description":"When the membership level was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"008"}},"required":["id","name","priority","tags","created_at","updated_at"],"title":"Membership Level Response","type":"object"},"Message":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"012"},"before_message_send_failed":{"type":"boolean","x-stream-index":"046"},"cid":{"type":"string","x-stream-index":"028"},"command":{"type":"string","x-stream-index":"006"},"created_at":{"format":"date-time","type":"number","x-stream-index":"030"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"034"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"033"},"deleted_for_me":{"type":"boolean","x-stream-index":"059"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"023"},"html":{"type":"string","x-stream-index":"007"},"i18n":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"044"},"id":{"type":"string","x-stream-index":"002"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"040"},"latest_reactions":{"items":{"$ref":"#/components/schemas/Reaction"},"type":"array","x-stream-index":"013"},"mentioned_users":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"043"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"052"},"mml":{"type":"string","x-stream-index":"005"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"056"},"own_reactions":{"items":{"$ref":"#/components/schemas/Reaction"},"type":"array","x-stream-index":"014"},"parent_id":{"type":"string","x-stream-index":"019"},"pin_expires":{"format":"date-time","type":"number","x-stream-index":"051"},"pinned":{"type":"boolean","x-stream-index":"047"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"048"},"pinned_by":{"$ref":"#/components/schemas/User","x-stream-index":"050"},"poll":{"$ref":"#/components/schemas/Poll","x-stream-index":"054"},"poll_id":{"type":"string","x-stream-index":"053"},"quoted_message":{"$ref":"#/components/schemas/Message","x-stream-index":"025"},"quoted_message_id":{"type":"string","x-stream-index":"024"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"015"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"017"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"016"},"reminder":{"$ref":"#/components/schemas/MessageReminder","x-stream-index":"058"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"022"},"restricted_visibility":{"items":{"type":"string"},"type":"array","x-stream-index":"011"},"shadowed":{"type":"boolean","x-stream-index":"036"},"shared_location":{"$ref":"#/components/schemas/SharedLocation","x-stream-index":"055"},"show_in_channel":{"type":"boolean","x-stream-index":"021"},"silent":{"type":"boolean","x-stream-index":"045"},"text":{"type":"string","x-stream-index":"004"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"027"},"type":{"type":"string","x-stream-index":"008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"031"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"010"}},"required":["id","text","html","type","restricted_visibility","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reaction_groups","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned"],"type":"object"},"MessageActionRequest":{"nullable":true,"properties":{"form_data":{"additionalProperties":{"type":"string"},"description":"ReadOnlyData to execute command with","title":"Form data","type":"object","x-stream-index":"002"}},"required":["form_data"],"type":"object"},"MessageChangeSet":{"properties":{"attachments":{"type":"boolean","x-stream-index":"005"},"custom":{"type":"boolean","x-stream-index":"001"},"html":{"type":"boolean","x-stream-index":"004"},"mentioned_user_ids":{"type":"boolean","x-stream-index":"006"},"mml":{"type":"boolean","x-stream-index":"003"},"pin":{"type":"boolean","x-stream-index":"009"},"quoted_message_id":{"type":"boolean","x-stream-index":"007"},"silent":{"type":"boolean","x-stream-index":"008"},"text":{"type":"boolean","x-stream-index":"002"}},"required":["custom","text","mml","html","attachments","mentioned_user_ids","quoted_message_id","silent","pin"],"type":"object"},"MessageDeletedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"007.002"},"deleted_for_me":{"type":"boolean","x-stream-index":"003"},"hard_delete":{"type":"boolean","x-stream-index":"002.001"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"006.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"message.deleted","type":"string","x-stream-index":"007.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005.001"}},"required":["hard_delete","cid","channel_id","channel_type","type","created_at"],"title":"MessageDeletedEvent","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":{"approved_at":{"format":"date-time","type":"number","x-stream-index":"013"},"created_at":{"format":"date-time","type":"number","x-stream-index":"009"},"created_by_automod":{"type":"boolean","x-stream-index":"001"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"008"},"details":{"$ref":"#/components/schemas/FlagDetails","x-stream-index":"006"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"005"},"moderation_feedback":{"$ref":"#/components/schemas/FlagFeedback","x-stream-index":"003"},"moderation_result":{"$ref":"#/components/schemas/MessageModerationResult","x-stream-index":"002"},"reason":{"type":"string","x-stream-index":"007"},"rejected_at":{"format":"date-time","type":"number","x-stream-index":"014"},"reviewed_at":{"format":"date-time","type":"number","x-stream-index":"011"},"reviewed_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"012"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"004"}},"required":["created_by_automod","created_at","updated_at"],"type":"object"},"MessageModerationResult":{"description":"Result of the message moderation","properties":{"action":{"description":"Action taken by automod","title":"Action","type":"string","x-stream-index":"002"},"ai_moderation_response":{"$ref":"#/components/schemas/ModerationResponse","description":"Response from AI moderation","title":"ModerationResponse","x-stream-index":"007"},"blocked_word":{"description":"Word that was blocked","title":"Blocked word","type":"string","x-stream-index":"004"},"blocklist_name":{"description":"Name of the blocklist","title":"Blocklist name","type":"string","x-stream-index":"005"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"010"},"message_id":{"description":"ID of the message","title":"Message ID","type":"string","x-stream-index":"001"},"moderated_by":{"description":"User who moderated the message","title":"Moderated by","type":"string","x-stream-index":"003"},"moderation_thresholds":{"$ref":"#/components/schemas/Thresholds","description":"Thresholds for AI moderation","title":"Thresholds","x-stream-index":"006"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"011"},"user_bad_karma":{"description":"Whether user has bad karma","title":"User bad karma","type":"boolean","x-stream-index":"009"},"user_karma":{"description":"Karma of the user","format":"float","title":"User karma","type":"number","x-stream-index":"008"}},"required":["message_id","action","user_karma","user_bad_karma","created_at","updated_at"],"title":"Message moderation result","type":"object"},"MessageNewEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"005.002"},"channel_type":{"type":"string","x-stream-index":"005.003"},"cid":{"type":"string","x-stream-index":"005.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"006.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"message.new","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"},"watcher_count":{"format":"int32","type":"integer","x-stream-index":"002.001"}},"required":["watcher_count","type","created_at","cid","channel_id","channel_type"],"title":"MessageNewEvent","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"},"MessageOptions":{"properties":{"include_thread_participants":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"MessagePaginationParams":{"type":"object"},"MessageReadEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"003"},"channel_last_message_at":{"format":"date-time","type":"number","x-stream-index":"005"},"channel_type":{"type":"string","x-stream-index":"004"},"cid":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"009"},"last_read_message_id":{"type":"string","x-stream-index":"010"},"team":{"type":"string","x-stream-index":"006"},"thread":{"$ref":"#/components/schemas/ThreadResponse","x-stream-index":"008"},"type":{"default":"message.read","type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","x-stream-index":"007"}},"required":["type","cid","channel_id","channel_type","created_at"],"type":"object"},"MessageReminder":{"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"004"},"channel_cid":{"type":"string","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"011"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"006"},"message_id":{"type":"string","x-stream-index":"005"},"remind_at":{"format":"date-time","type":"number","x-stream-index":"009"},"task_id":{"type":"string","x-stream-index":"010"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"012"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"user_id":{"type":"string","x-stream-index":"007"}},"required":["channel_cid","message_id","user_id","task_id","created_at","updated_at"],"type":"object"},"MessageRequest":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"maximum":30,"type":"array","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"mentioned_users":{"items":{"type":"string"},"maximum":100,"type":"array","x-stream-index":"008"},"mml":{"type":"string","x-stream-index":"003"},"parent_id":{"type":"string","x-stream-index":"005"},"pin_expires":{"format":"date-time","type":"number","x-stream-index":"015"},"pinned":{"type":"boolean","x-stream-index":"013"},"pinned_at":{"format":"date-time","nullable":true,"type":"string","x-stream-index":"014"},"poll_id":{"type":"string","x-stream-index":"039"},"quoted_message_id":{"type":"string","x-stream-index":"009"},"restricted_visibility":{"items":{"type":"string"},"maximum":10,"type":"array","x-stream-index":"016"},"shared_location":{"$ref":"#/components/schemas/SharedLocation","x-stream-index":"040"},"show_in_channel":{"type":"boolean","x-stream-index":"006"},"silent":{"type":"boolean","x-stream-index":"012"},"text":{"type":"string","x-stream-index":"002"},"type":{"enum":["''","regular","system"],"type":"string","x-stream-index":"011"}},"type":"object"},"MessageResponse":{"description":"Represents any chat message","properties":{"attachments":{"description":"Array of message attachments","items":{"$ref":"#/components/schemas/Attachment"},"title":"Message attachments","type":"array","x-stream-docs-page-id":"message_format#attachment-format","x-stream-index":"008"},"cid":{"description":"Channel unique identifier in \u003ctype\u003e:\u003cid\u003e format","title":"Channel CID","type":"string","x-stream-index":"022"},"command":{"description":"Contains provided slash command","title":"Command","type":"string","x-stream-docs-page-id":"custom_commands_webhook","x-stream-index":"004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"023"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"026"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"025"},"deleted_for_me":{"type":"boolean","x-stream-index":"044"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"018"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"041"},"html":{"description":"Contains HTML markup of the message. Can only be set when using server-side API","title":"HTML content","type":"string","x-stream-index":"005"},"i18n":{"additionalProperties":{"type":"string"},"description":"Object with translations. Key `language` contains the original language key. Other keys contain translations","title":"Internationalization info","type":"object","x-stream-docs-page-id":"translation","x-stream-index":"030"},"id":{"description":"Message ID is unique string identifier of the message","title":"ID","type":"string","x-stream-index":"001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"Contains image moderation information","title":"Image moderation labels","type":"object","x-stream-index":"028"},"latest_reactions":{"description":"List of 10 latest reactions to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Latest reactions","type":"array","x-stream-index":"009"},"mentioned_users":{"description":"List of mentioned users","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Mentioned Users","type":"array","x-stream-index":"029"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"036"},"mml":{"description":"Should be empty if `text` is provided. Can only be set when using server-side API","title":"Messaging Markup Language","type":"string","x-stream-docs-page-id":"mml_overview","x-stream-index":"003"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"039"},"own_reactions":{"description":"List of 10 latest reactions of authenticated user to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Own reactions","type":"array","x-stream-index":"010"},"parent_id":{"description":"ID of parent message (thread)","title":"Parent message ID","type":"string","x-stream-docs-page-id":"threads","x-stream-index":"015"},"pin_expires":{"description":"Date when pinned message expires","format":"date-time","title":"Pin expiration date","type":"number","x-stream-docs-page-id":"pinned_messages","x-stream-index":"035"},"pinned":{"description":"Whether message is pinned or not","title":"Pinned","type":"boolean","x-stream-docs-page-id":"pinned_messages","x-stream-index":"032"},"pinned_at":{"description":"Date when message got pinned","format":"date-time","title":"Pinned at","type":"number","x-stream-docs-page-id":"pinned_messages","x-stream-index":"033"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","description":"Contains user who pinned the message","title":"Pinned by","x-stream-docs-page-id":"pinned_messages","x-stream-index":"034"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"038"},"poll_id":{"description":"Identifier of the poll to include in the message","title":"Poll ID","type":"string","x-stream-index":"037"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","description":"Contains quoted message","title":"Quoted message","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"020"},"quoted_message_id":{"title":"ID of quoted message","type":"string","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"019"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing number of reactions of each type. Key: reaction type (string), value: number of reactions (int)","title":"Reaction counts","type":"object","x-stream-index":"011"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"014"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing scores of reactions of each type. Key: reaction type (string), value: total score of reactions (int)","title":"Reaction scores","type":"object","x-stream-index":"012"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"042"},"reply_count":{"description":"Number of replies to this message","format":"int32","title":"Reply count","type":"integer","x-stream-index":"017"},"restricted_visibility":{"description":"A list of user ids that have restricted visibility to the message, if the list is not empty, the message is only visible to the users in the list","items":{"type":"string"},"title":"Restricted visibility","type":"array","x-stream-index":"040"},"shadowed":{"description":"Whether the message was shadowed or not","title":"Shadowed","type":"boolean","x-stream-docs-page-id":"moderation#shadow-ban","x-stream-index":"027"},"shared_location":{"$ref":"#/components/schemas/SharedLocationResponseData","description":"Contains shared location data","title":"Shared Location","x-stream-index":"043"},"show_in_channel":{"description":"Whether thread reply should be shown in the channel as well","title":"Show in channel","type":"boolean","x-stream-docs-page-id":"threads","x-stream-index":"016"},"silent":{"description":"Whether message is silent or not","title":"Silent","type":"boolean","x-stream-index":"031"},"text":{"description":"Text of the message. Should be empty if `mml` is provided","title":"Text","type":"string","x-stream-index":"002"},"thread_participants":{"description":"List of users who participate in thread","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Thread participants","type":"array","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"021"},"type":{"description":"Contains type of the message","enum":["regular","ephemeral","error","reply","system","deleted"],"title":"Message Type","type":"string","x-stream-docs-page-id":"message_format#message-types","x-stream-index":"006"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"024"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Sender of the message. Required when using server-side API","title":"User object","x-stream-index":"007"}},"required":["id","text","html","type","user","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned","restricted_visibility"],"title":"Message","type":"object","x-stream-docs-page-id":"send_message"},"MessageStatsResponse":{"properties":{"count_over_time":{"items":{"$ref":"#/components/schemas/CountByMinuteResponse"},"type":"array","x-stream-index":"001"}},"type":"object"},"MessageUndeletedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"005.002"},"channel_type":{"type":"string","x-stream-index":"005.003"},"cid":{"type":"string","x-stream-index":"005.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"002.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"message.undeleted","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MessageUndeletedEvent","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"},"MessageUpdate":{"properties":{"change_set":{"$ref":"#/components/schemas/MessageChangeSet","x-stream-index":"002"},"old_text":{"type":"string","x-stream-index":"001"}},"type":"object"},"MessageUpdatedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"005.002"},"channel_type":{"type":"string","x-stream-index":"005.003"},"cid":{"type":"string","x-stream-index":"005.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"002.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"message.updated","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MessageUpdatedEvent","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"},"MessageWithChannelResponse":{"description":"Represents any chat message","properties":{"attachments":{"description":"Array of message attachments","items":{"$ref":"#/components/schemas/Attachment"},"title":"Message attachments","type":"array","x-stream-docs-page-id":"message_format#attachment-format","x-stream-index":"001.008"},"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel object","title":"Channel","x-stream-index":"002"},"cid":{"description":"Channel unique identifier in \u003ctype\u003e:\u003cid\u003e format","title":"Channel CID","type":"string","x-stream-index":"001.022"},"command":{"description":"Contains provided slash command","title":"Command","type":"string","x-stream-docs-page-id":"custom_commands_webhook","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.023"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.026"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"001.025"},"deleted_for_me":{"type":"boolean","x-stream-index":"001.044"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"001.018"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001.041"},"html":{"description":"Contains HTML markup of the message. Can only be set when using server-side API","title":"HTML content","type":"string","x-stream-index":"001.005"},"i18n":{"additionalProperties":{"type":"string"},"description":"Object with translations. Key `language` contains the original language key. Other keys contain translations","title":"Internationalization info","type":"object","x-stream-docs-page-id":"translation","x-stream-index":"001.030"},"id":{"description":"Message ID is unique string identifier of the message","title":"ID","type":"string","x-stream-index":"001.001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"Contains image moderation information","title":"Image moderation labels","type":"object","x-stream-index":"001.028"},"latest_reactions":{"description":"List of 10 latest reactions to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Latest reactions","type":"array","x-stream-index":"001.009"},"mentioned_users":{"description":"List of mentioned users","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Mentioned Users","type":"array","x-stream-index":"001.029"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"001.036"},"mml":{"description":"Should be empty if `text` is provided. Can only be set when using server-side API","title":"Messaging Markup Language","type":"string","x-stream-docs-page-id":"mml_overview","x-stream-index":"001.003"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"001.039"},"own_reactions":{"description":"List of 10 latest reactions of authenticated user to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Own reactions","type":"array","x-stream-index":"001.010"},"parent_id":{"description":"ID of parent message (thread)","title":"Parent message ID","type":"string","x-stream-docs-page-id":"threads","x-stream-index":"001.015"},"pin_expires":{"description":"Date when pinned message expires","format":"date-time","title":"Pin expiration date","type":"number","x-stream-docs-page-id":"pinned_messages","x-stream-index":"001.035"},"pinned":{"description":"Whether message is pinned or not","title":"Pinned","type":"boolean","x-stream-docs-page-id":"pinned_messages","x-stream-index":"001.032"},"pinned_at":{"description":"Date when message got pinned","format":"date-time","title":"Pinned at","type":"number","x-stream-docs-page-id":"pinned_messages","x-stream-index":"001.033"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","description":"Contains user who pinned the message","title":"Pinned by","x-stream-docs-page-id":"pinned_messages","x-stream-index":"001.034"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001.038"},"poll_id":{"description":"Identifier of the poll to include in the message","title":"Poll ID","type":"string","x-stream-index":"001.037"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","description":"Contains quoted message","title":"Quoted message","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"001.020"},"quoted_message_id":{"title":"ID of quoted message","type":"string","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"001.019"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing number of reactions of each type. Key: reaction type (string), value: number of reactions (int)","title":"Reaction counts","type":"object","x-stream-index":"001.011"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"001.014"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing scores of reactions of each type. Key: reaction type (string), value: total score of reactions (int)","title":"Reaction scores","type":"object","x-stream-index":"001.012"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"001.042"},"reply_count":{"description":"Number of replies to this message","format":"int32","title":"Reply count","type":"integer","x-stream-index":"001.017"},"restricted_visibility":{"description":"A list of user ids that have restricted visibility to the message, if the list is not empty, the message is only visible to the users in the list","items":{"type":"string"},"title":"Restricted visibility","type":"array","x-stream-index":"001.040"},"shadowed":{"description":"Whether the message was shadowed or not","title":"Shadowed","type":"boolean","x-stream-docs-page-id":"moderation#shadow-ban","x-stream-index":"001.027"},"shared_location":{"$ref":"#/components/schemas/SharedLocationResponseData","description":"Contains shared location data","title":"Shared Location","x-stream-index":"001.043"},"show_in_channel":{"description":"Whether thread reply should be shown in the channel as well","title":"Show in channel","type":"boolean","x-stream-docs-page-id":"threads","x-stream-index":"001.016"},"silent":{"description":"Whether message is silent or not","title":"Silent","type":"boolean","x-stream-index":"001.031"},"text":{"description":"Text of the message. Should be empty if `mml` is provided","title":"Text","type":"string","x-stream-index":"001.002"},"thread_participants":{"description":"List of users who participate in thread","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Thread participants","type":"array","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"001.021"},"type":{"description":"Contains type of the message","enum":["regular","ephemeral","error","reply","system","deleted"],"title":"Message Type","type":"string","x-stream-docs-page-id":"message_format#message-types","x-stream-index":"001.006"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.024"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Sender of the message. Required when using server-side API","title":"User object","x-stream-index":"001.007"}},"required":["id","text","html","type","user","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned","restricted_visibility","channel"],"title":"Message","type":"object","x-stream-docs-page-id":"send_message"},"ModerationActionConfig":{"nullable":true,"properties":{"action":{"type":"string","x-stream-index":"006"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"009"},"description":{"type":"string","x-stream-index":"008"},"entity_type":{"type":"string","x-stream-index":"004"},"icon":{"type":"string","x-stream-index":"007"},"order":{"format":"int32","type":"integer","x-stream-index":"005"}},"required":["entity_type","order","action","icon","description","custom"],"type":"object"},"ModerationCustomActionEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"001"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"002"},"type":{"default":"moderation.custom_action","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationCustomActionEvent","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"},"ModerationFlagResponse":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"015"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"entity_creator_id":{"type":"string","x-stream-index":"007"},"entity_id":{"type":"string","x-stream-index":"006"},"entity_type":{"type":"string","x-stream-index":"005"},"labels":{"items":{"type":"string"},"type":"array","x-stream-index":"011"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"008"},"reason":{"type":"string","x-stream-index":"009"},"result":{"items":{"additionalProperties":{},"type":"object"},"type":"array","x-stream-index":"012"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","x-stream-index":"014"},"review_queue_item_id":{"type":"string","x-stream-index":"013"},"type":{"type":"string","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"016"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"004"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["type","user_id","entity_type","entity_id","result","created_at","updated_at"],"type":"object"},"ModerationFlaggedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"item":{"type":"string","x-stream-index":"001"},"object_id":{"type":"string","x-stream-index":"002"},"type":{"default":"moderation.flagged","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationFlaggedEvent","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"},"ModerationMarkReviewedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"001"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"002"},"type":{"default":"moderation.mark_reviewed","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationMarkReviewedEvent","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"},"ModerationPayload":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"images":{"items":{"type":"string"},"maximum":30,"type":"array","x-stream-index":"002"},"texts":{"items":{"type":"string"},"type":"array","x-stream-index":"001"},"videos":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"type":"object"},"ModerationResponse":{"properties":{"action":{"type":"string","x-stream-index":"004"},"explicit":{"format":"float","type":"number","x-stream-index":"002"},"spam":{"format":"float","type":"number","x-stream-index":"003"},"toxic":{"format":"float","type":"number","x-stream-index":"001"}},"required":["toxic","explicit","spam","action","automod_response"],"type":"object"},"ModerationV2Response":{"properties":{"action":{"type":"string","x-stream-index":"001"},"blocklist_matched":{"type":"string","x-stream-index":"005"},"image_harms":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"original_text":{"type":"string","x-stream-index":"002"},"platform_circumvented":{"type":"boolean","x-stream-index":"007"},"semantic_filter_matched":{"type":"string","x-stream-index":"006"},"text_harms":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"required":["action","original_text"],"type":"object"},"MuteChannelRequest":{"nullable":true,"properties":{"channel_cids":{"description":"Channel CIDs to mute (if multiple channels)","items":{"type":"string"},"maximum":25,"title":"Channel CIDs","type":"array","x-stream-index":"002"},"expiration":{"description":"Duration of mute in milliseconds","title":"Expiration","type":"integer","x-stream-index":"003"}},"type":"object"},"MuteChannelResponse":{"nullable":true,"properties":{"channel_mute":{"$ref":"#/components/schemas/ChannelMute","description":"Object with channel mute (if one channel was muted)","title":"Channel mute","x-stream-index":"001"},"channel_mutes":{"description":"Object with mutes (if multiple channels were muted)","items":{"$ref":"#/components/schemas/ChannelMute"},"title":"Channel mutes","type":"array","x-stream-index":"002"},"duration":{"type":"string","x-stream-index":"004.001"},"own_user":{"$ref":"#/components/schemas/OwnUser","description":"Authorized user object with fresh mutes information","title":"Own user","x-stream-index":"003"}},"required":["duration"],"type":"object"},"MuteRequest":{"nullable":true,"properties":{"target_ids":{"description":"User IDs to mute (if multiple users)","items":{"type":"string"},"title":"Target IDs","type":"array","x-stream-index":"001"},"timeout":{"description":"Duration of mute in minutes","minimum":0,"title":"Timeout","type":"integer","x-stream-index":"002"}},"required":["target_ids"],"title":"MuteRequest","type":"object"},"MuteResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"004.001"},"mutes":{"description":"Object with mutes (if multiple users were muted)","items":{"$ref":"#/components/schemas/UserMute"},"title":"Mutes","type":"array","x-stream-index":"001"},"non_existing_users":{"description":"A list of users that can't be found. Common cause for this is deleted users","items":{"type":"string"},"title":"Non Existing Users","type":"array","x-stream-index":"003"},"own_user":{"$ref":"#/components/schemas/OwnUser","description":"Authorized user object with fresh mutes information","title":"Own User","x-stream-index":"002"}},"required":["duration"],"title":"MuteResponse","type":"object"},"MuteUsersRequest":{"nullable":true,"properties":{"audio":{"title":"Audio","type":"boolean","x-stream-index":"005"},"mute_all_users":{"type":"boolean","x-stream-index":"003"},"screenshare":{"title":"Screenshare","type":"boolean","x-stream-index":"007"},"screenshare_audio":{"title":"ScreenshareAudio","type":"boolean","x-stream-index":"008"},"user_ids":{"items":{"type":"string"},"title":"UserIDs","type":"array","x-stream-index":"004"},"video":{"title":"Video","type":"boolean","x-stream-index":"006"}},"title":"MuteUsersRequest","type":"object"},"MuteUsersResponse":{"description":"MuteUsersResponse is the response payload for the mute users endpoint.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"MuteUsersResponse","type":"object"},"NetworkMetricsReportResponse":{"properties":{"average_connection_time":{"format":"float","type":"number","x-stream-index":"003"},"average_jitter":{"format":"float","type":"number","x-stream-index":"002"},"average_latency":{"format":"float","type":"number","x-stream-index":"001"},"average_time_to_reconnect":{"format":"float","type":"number","x-stream-index":"004"}},"type":"object"},"NoiseCancellationSettings":{"properties":{"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode"],"type":"object"},"NotificationAddedToChannelEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003.004"},"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"003.005"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"001.001"},"type":{"default":"notification.added_to_channel","type":"string","x-stream-index":"002.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"NotificationAddedToChannelEvent","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"},"NotificationChannelDeletedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003.004"},"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"003.005"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"team":{"type":"string","x-stream-index":"001.001"},"type":{"default":"notification.channel_deleted","type":"string","x-stream-index":"002.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"NotificationChannelDeletedEvent","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"},"NotificationChannelMutesUpdatedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"me":{"$ref":"#/components/schemas/OwnUser","x-stream-index":"001"},"type":{"default":"notification.channel_mutes_updated","type":"string","x-stream-index":"002.001"}},"required":["me","type","created_at"],"title":"NotificationChannelMutesUpdatedEvent","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"},"NotificationChannelTruncatedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002.004"},"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"002.005"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"notification.channel_truncated","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"NotificationChannelTruncatedEvent","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"},"NotificationConfig":{"properties":{"track_read":{"type":"boolean","x-stream-index":"002"},"track_seen":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"NotificationFeedUpdatedEvent":{"description":"Emitted when notification feed is updated.","nullable":true,"properties":{"aggregated_activities":{"description":"Aggregated activities for notification feeds","items":{"$ref":"#/components/schemas/AggregatedActivityResponse"},"title":"Aggregated Activities","type":"array","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"003.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.001.007"},"feed_visibility":{"type":"string","x-stream-index":"003.003"},"fid":{"description":"The ID of the feed","title":"Feed ID","type":"string","x-stream-index":"003.002"},"notification_status":{"$ref":"#/components/schemas/NotificationStatusResponse","description":"Notification status including unread/unseen counts","title":"Notification Status","x-stream-index":"002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.001.004"},"type":{"default":"feeds.notification_feed.updated","description":"The type of event: \"feeds.notification_feed.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"003.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who triggered the notification","title":"User","x-stream-index":"004.001"}},"required":["type","created_at","custom","fid"],"title":"NotificationFeedUpdatedEvent","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"},"NotificationInviteAcceptedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002.004"},"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"002.005"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"004.001"},"type":{"default":"notification.invite_accepted","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"NotificationInviteAcceptedEvent","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"},"NotificationInviteRejectedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002.004"},"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"002.005"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"004.001"},"type":{"default":"notification.invite_rejected","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"NotificationInviteRejectedEvent","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"},"NotificationInvitedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002.004"},"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"002.005"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"004.001"},"type":{"default":"notification.invited","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"NotificationInvitedEvent","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"},"NotificationMarkReadEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003.004"},"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"003.005"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"team":{"type":"string","x-stream-index":"002.001"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"006"},"type":{"default":"notification.mark_read","type":"string","x-stream-index":"001.001"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"007"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"005"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"008"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count","unread_count","total_unread_count","unread_channels","unread_threads"],"title":"NotificationMarkReadEvent","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"},"NotificationMarkUnreadEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003.004"},"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"003.005"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"first_unread_message_id":{"type":"string","x-stream-index":"005"},"last_read_at":{"format":"date-time","type":"number","x-stream-index":"006"},"last_read_message_id":{"type":"string","x-stream-index":"012"},"team":{"type":"string","x-stream-index":"002.001"},"thread_id":{"type":"string","x-stream-index":"013"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"009"},"type":{"default":"notification.mark_unread","type":"string","x-stream-index":"001.001"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"010"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"008"},"unread_messages":{"format":"int32","type":"integer","x-stream-index":"007"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"011"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count","first_unread_message_id","last_read_at","unread_messages","unread_count","total_unread_count","unread_channels","unread_threads"],"title":"NotificationMarkUnreadEvent","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"},"NotificationMutesUpdatedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"me":{"$ref":"#/components/schemas/OwnUser","x-stream-index":"001"},"type":{"default":"notification.mutes_updated","type":"string","x-stream-index":"002.001"}},"required":["me","type","created_at"],"title":"NotificationMutesUpdatedEvent","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"},"NotificationNewMessageEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"004.004"},"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"004.005"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"002.001"},"type":{"default":"notification.message_new","type":"string","x-stream-index":"003.001"}},"required":["message","type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"NotificationNewMessageEvent","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"},"NotificationRemovedFromChannelEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002.004"},"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"002.005"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"004.001"},"type":{"default":"notification.removed_from_channel","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"NotificationRemovedFromChannelEvent","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"},"NotificationSettings":{"properties":{"call_live_started":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"002"},"call_missed":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"006"},"call_notification":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"004"},"call_ring":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"session_started":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"003"}},"required":["enabled","call_live_started","session_started","call_notification","call_ring","call_missed"],"type":"object"},"NotificationStatusResponse":{"properties":{"last_read_at":{"format":"date-time","type":"number","x-stream-index":"006"},"last_seen_at":{"description":"When notifications were last seen","format":"date-time","title":"Last Seen At","type":"number","x-stream-index":"005"},"read_activities":{"description":"IDs of activities that have been read","items":{"type":"string"},"title":"Read Activities","type":"array","x-stream-index":"003"},"seen_activities":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"unread":{"description":"Number of unread notifications","format":"int32","title":"Unread","type":"integer","x-stream-index":"001"},"unseen":{"description":"Number of unseen notifications","format":"int32","title":"Unseen","type":"integer","x-stream-index":"002"}},"required":["unread","unseen"],"title":"Notification Status","type":"object"},"NullTime":{"type":"object"},"OCRRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"}},"required":["label","action"],"type":"object"},"OnlyUserID":{"properties":{"id":{"type":"string","x-stream-index":"001"}},"required":["id"],"type":"object"},"OwnCapability":{"description":"All possibility of string to use","enum":["block-users","change-max-duration","create-call","create-reaction","enable-noise-cancellation","end-call","join-backstage","join-call","join-ended-call","kick-user","mute-users","pin-for-everyone","read-call","remove-call-member","screenshare","send-audio","send-video","start-broadcast-call","start-closed-captions-call","start-frame-record-call","start-record-call","start-transcription-call","stop-broadcast-call","stop-closed-captions-call","stop-frame-record-call","stop-record-call","stop-transcription-call","update-call","update-call-member","update-call-permissions","update-call-settings"],"title":"OwnCapability","type":"string"},"OwnUser":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"046"},"banned":{"type":"boolean","x-stream-index":"016"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"045"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"029"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"014"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"013"},"devices":{"items":{"$ref":"#/components/schemas/Device"},"type":"array","x-stream-index":"027"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"023"},"language":{"type":"string","x-stream-index":"035"},"last_active":{"format":"date-time","type":"number","x-stream-index":"011"},"last_engaged_at":{"format":"date-time","type":"number","x-stream-index":"012"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"037"},"mutes":{"items":{"$ref":"#/components/schemas/UserMute"},"type":"array","x-stream-index":"028"},"online":{"type":"boolean","x-stream-index":"022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"026"},"push_preferences":{"$ref":"#/components/schemas/PushPreferences","x-stream-index":"025"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"005"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"031"},"total_unread_count_by_team":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"032"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"033"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"030"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"034"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"}},"required":["id","role","custom","created_at","updated_at","banned","online","devices","mutes","channel_mutes","unread_count","total_unread_count","total_unread_count_by_team","unread_channels","unread_threads","language"],"type":"object"},"OwnUserResponse":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"banned":{"type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"015"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.011"},"devices":{"items":{"$ref":"#/components/schemas/DeviceResponse"},"title":"Devices","type":"array","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001.001"},"image":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"005"},"language":{"type":"string","x-stream-index":"001.005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"001.014"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"013"},"mutes":{"items":{"$ref":"#/components/schemas/UserMuteResponse"},"type":"array","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"001.002"},"online":{"type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"003"},"push_preferences":{"$ref":"#/components/schemas/PushPreferences","x-stream-index":"002"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.015"},"role":{"type":"string","x-stream-index":"001.006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"009"},"total_unread_count_by_team":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"010"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"011"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"008"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"012"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","devices","invisible","mutes","channel_mutes","unread_count","total_unread_count","unread_channels","unread_threads"],"type":"object"},"PagerRequest":{"properties":{"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"002"},"prev":{"type":"string","x-stream-index":"003"}},"type":"object"},"PagerResponse":{"properties":{"next":{"type":"string","x-stream-index":"001"},"prev":{"type":"string","x-stream-index":"002"}},"type":"object"},"PaginationParams":{"properties":{"limit":{"format":"int32","minimum":0,"type":"integer","x-stream-index":"001"},"offset":{"format":"int32","type":"integer","x-stream-index":"002"}},"type":"object"},"ParticipantCountByMinuteResponse":{"nullable":true,"properties":{"first":{"format":"int32","type":"integer","x-stream-index":"002"},"last":{"format":"int32","type":"integer","x-stream-index":"003"},"max":{"format":"int32","type":"integer","x-stream-index":"004"},"min":{"format":"int32","type":"integer","x-stream-index":"005"},"start_ts":{"format":"date-time","type":"number","x-stream-index":"001"}},"required":["start_ts","first","last","max","min"],"type":"object"},"ParticipantCountOverTimeResponse":{"properties":{"by_minute":{"items":{"$ref":"#/components/schemas/ParticipantCountByMinuteResponse"},"type":"array","x-stream-index":"001"}},"type":"object"},"ParticipantReportResponse":{"properties":{"by_browser":{"items":{"$ref":"#/components/schemas/GroupedStatsResponse"},"type":"array","x-stream-index":"008"},"by_country":{"items":{"$ref":"#/components/schemas/GroupedStatsResponse"},"type":"array","x-stream-index":"005"},"by_device":{"items":{"$ref":"#/components/schemas/GroupedStatsResponse"},"type":"array","x-stream-index":"006"},"by_operating_system":{"items":{"$ref":"#/components/schemas/GroupedStatsResponse"},"type":"array","x-stream-index":"007"},"count_over_time":{"$ref":"#/components/schemas/ParticipantCountOverTimeResponse","x-stream-index":"004"},"max_concurrent":{"format":"int32","type":"integer","x-stream-index":"003"},"publishers":{"$ref":"#/components/schemas/PublisherStatsResponse","x-stream-index":"009"},"subscribers":{"$ref":"#/components/schemas/SubscriberStatsResponse","x-stream-index":"010"},"sum":{"format":"int32","type":"integer","x-stream-index":"001"},"unique":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["sum","unique"],"type":"object"},"PendingMessageEvent":{"description":"Pending message event for async moderation","nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"002.007"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"message":{"$ref":"#/components/schemas/Message","description":"The pending message","title":"Message","x-stream-index":"002.009"},"metadata":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"002.010"},"method":{"description":"The method used for the pending message","title":"Method","type":"string","x-stream-index":"003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"type":{"default":"message.pending","description":"The type of event: \"message.pending\" in this case","title":"Event Type","type":"string","x-stream-index":"001.002"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.002"}},"required":["type","custom","method","created_at"],"title":"PendingMessageEvent","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"},"PendingMessageResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"003"},"metadata":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"}},"type":"object"},"PerSDKUsageReport":{"nullable":true,"properties":{"by_version":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"002"},"total":{"format":"int32","type":"integer","x-stream-index":"001"}},"required":["total","by_version"],"type":"object"},"PermissionRequestEvent":{"description":"This event is sent when a user requests access to a feature on a call,\nclients receiving this event should display a permission request to the user","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"permissions":{"description":"The list of permissions requested by the user","items":{"type":"string"},"title":"Permissions","type":"array","x-stream-index":"004"},"type":{"default":"call.permission_request","description":"The type of event: \"call.permission_request\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who sent the permission request","title":"User","x-stream-index":"003"}},"required":["type","created_at","call_cid","user","permissions"],"title":"PermissionRequestEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"PinActivityRequest":{"nullable":true,"title":"Pin Activity Request","type":"object"},"PinActivityResponse":{"nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","description":"The pinned activity","title":"Activity","x-stream-index":"001"},"created_at":{"description":"When the activity was pinned","format":"date-time","title":"Created At","type":"number","x-stream-index":"004"},"duration":{"type":"string","x-stream-index":"005.001"},"feed":{"description":"Fully qualified ID of the feed the activity was pinned to","title":"Feed ID","type":"string","x-stream-index":"002"},"user_id":{"description":"ID of the user who pinned the activity","title":"User ID","type":"string","x-stream-index":"003"}},"required":["activity","feed","user_id","created_at","duration"],"title":"Pin Activity Response","type":"object"},"PinRequest":{"description":"PinRequest is the payload for pinning a message.","nullable":true,"properties":{"session_id":{"description":"the session ID of the user who pinned the message","title":"SessionID","type":"string","x-stream-index":"003"},"user_id":{"description":"the user ID of the user who pinned the message","title":"UserID","type":"string","x-stream-index":"002"}},"required":["user_id","session_id"],"title":"PinRequest","type":"object"},"PinResponse":{"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"},"Poll":{"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"023"},"allow_answers":{"type":"boolean","x-stream-index":"010"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"009"},"answers_count":{"format":"int32","type":"integer","x-stream-index":"015"},"created_at":{"format":"date-time","type":"number","x-stream-index":"021"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"020"},"created_by_id":{"type":"string","x-stream-index":"019"},"description":{"type":"string","x-stream-index":"005"},"enforce_unique_vote":{"type":"boolean","x-stream-index":"007"},"id":{"type":"string","x-stream-index":"003"},"is_closed":{"type":"boolean","x-stream-index":"011"},"latest_answers":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array","x-stream-index":"017"},"latest_votes_by_option":{"additionalProperties":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array"},"type":"object","x-stream-index":"016"},"max_votes_allowed":{"format":"int32","type":"integer","x-stream-index":"008"},"name":{"type":"string","x-stream-index":"004"},"options":{"items":{"$ref":"#/components/schemas/PollOption"},"type":"array","x-stream-index":"013"},"own_votes":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array","x-stream-index":"018"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"022"},"vote_count":{"format":"int32","type":"integer","x-stream-index":"012"},"vote_counts_by_option":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"014"},"voting_visibility":{"type":"string","x-stream-index":"006"}},"required":["id","name","description","enforce_unique_vote","allow_user_suggested_options","allow_answers","vote_count","options","vote_counts_by_option","answers_count","latest_votes_by_option","latest_answers","own_votes","created_by_id","created_at","updated_at","Custom"],"type":"object"},"PollClosedEvent":{"description":"Emitted when a poll is closed.","nullable":true,"properties":{"activity_id":{"type":"string","x-stream-index":"001.003"},"cid":{"description":"The CID of the channel containing the poll","title":"Channel CID","type":"string","x-stream-index":"001.001.002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.001.007"},"message_id":{"description":"The ID of the message containing the poll","title":"Message ID","type":"string","x-stream-index":"001.002"},"poll":{"$ref":"#/components/schemas/PollResponseData","description":"The poll object which was closed","title":"Poll","x-stream-index":"001.004"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.001.004"},"type":{"default":"poll.closed","description":"The type of event: \"poll.closed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.001.002"}},"required":["type","created_at","custom","poll"],"title":"PollClosedEvent","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"},"PollClosedFeedEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"001.002.003"},"fid":{"type":"string","x-stream-index":"001.002.002"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001.001"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.002.001.004"},"type":{"default":"feeds.poll.closed","type":"string","x-stream-index":"001.002.001.002"}},"required":["poll","type","created_at","custom","fid"],"title":"PollClosedFeedEvent","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"},"PollDeletedEvent":{"description":"Emitted when a poll is deleted.","nullable":true,"properties":{"activity_id":{"type":"string","x-stream-index":"001.003"},"cid":{"description":"The CID of the channel containing the poll","title":"Channel CID","type":"string","x-stream-index":"001.001.002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.001.007"},"message_id":{"description":"The ID of the message containing the poll","title":"Message ID","type":"string","x-stream-index":"001.002"},"poll":{"$ref":"#/components/schemas/PollResponseData","description":"The poll object which was deleted","title":"Poll","x-stream-index":"001.004"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.001.004"},"type":{"default":"poll.deleted","description":"The type of event: \"poll.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.001.002"}},"required":["type","created_at","custom","poll"],"title":"PollDeletedEvent","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"},"PollDeletedFeedEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"001.002.003"},"fid":{"type":"string","x-stream-index":"001.002.002"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001.001"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.002.001.004"},"type":{"default":"feeds.poll.deleted","type":"string","x-stream-index":"001.002.001.002"}},"required":["poll","type","created_at","custom","fid"],"title":"PollDeletedFeedEvent","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"},"PollOption":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id","text","custom"],"type":"object"},"PollOptionInput":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"text":{"type":"string","x-stream-index":"002"}},"type":"object"},"PollOptionRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id"],"type":"object"},"PollOptionResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"poll_option":{"$ref":"#/components/schemas/PollOptionResponseData","description":"Poll option","title":"PollOptionResponseData","x-stream-index":"001"}},"required":["poll_option","duration"],"type":"object"},"PollOptionResponseData":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id","text","custom"],"type":"object"},"PollResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"poll":{"$ref":"#/components/schemas/PollResponseData","description":"Poll","title":"PollResponseData","x-stream-index":"001"}},"required":["poll","duration"],"type":"object"},"PollResponseData":{"properties":{"allow_answers":{"type":"boolean","x-stream-index":"008"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"007"},"answers_count":{"format":"int32","type":"integer","x-stream-index":"012"},"created_at":{"format":"date-time","type":"number","x-stream-index":"019"},"created_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"018"},"created_by_id":{"type":"string","x-stream-index":"017"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"021"},"description":{"type":"string","x-stream-index":"003"},"enforce_unique_vote":{"type":"boolean","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"is_closed":{"type":"boolean","x-stream-index":"009"},"latest_answers":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array","x-stream-index":"015"},"latest_votes_by_option":{"additionalProperties":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array"},"type":"object","x-stream-index":"014"},"max_votes_allowed":{"format":"int32","type":"integer","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"002"},"options":{"items":{"$ref":"#/components/schemas/PollOptionResponseData"},"type":"array","x-stream-index":"011"},"own_votes":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array","x-stream-index":"016"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"020"},"vote_count":{"format":"int32","type":"integer","x-stream-index":"010"},"vote_counts_by_option":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"013"},"voting_visibility":{"type":"string","x-stream-index":"004"}},"required":["id","name","description","voting_visibility","enforce_unique_vote","allow_user_suggested_options","allow_answers","vote_count","options","answers_count","vote_counts_by_option","latest_votes_by_option","latest_answers","own_votes","created_by_id","created_at","updated_at","custom"],"type":"object"},"PollUpdatedEvent":{"description":"Emitted when a poll is updated.","nullable":true,"properties":{"activity_id":{"type":"string","x-stream-index":"001.003"},"cid":{"description":"The CID of the channel containing the poll","title":"Channel CID","type":"string","x-stream-index":"001.001.002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.001.007"},"message_id":{"description":"The ID of the message containing the poll","title":"Message ID","type":"string","x-stream-index":"001.002"},"poll":{"$ref":"#/components/schemas/PollResponseData","description":"The poll object which was updated","title":"Poll","x-stream-index":"001.004"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.001.004"},"type":{"default":"poll.updated","description":"The type of event: \"poll.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.001.002"}},"required":["type","created_at","custom","poll"],"title":"PollUpdatedEvent","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"},"PollUpdatedFeedEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"001.002.003"},"fid":{"type":"string","x-stream-index":"001.002.002"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001.001"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.002.001.004"},"type":{"default":"feeds.poll.updated","type":"string","x-stream-index":"001.002.001.002"}},"required":["poll","type","created_at","custom","fid"],"title":"PollUpdatedFeedEvent","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"},"PollVote":{"nullable":true,"properties":{"answer_text":{"type":"string","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"004"},"is_answer":{"type":"boolean","x-stream-index":"006"},"option_id":{"type":"string","x-stream-index":"005"},"poll_id":{"type":"string","x-stream-index":"003"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"011"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"009"},"user_id":{"type":"string","x-stream-index":"008"}},"required":["poll_id","id","option_id","created_at","updated_at"],"type":"object"},"PollVoteCastedEvent":{"description":"Emitted when a vote is cast on a poll.","nullable":true,"properties":{"activity_id":{"type":"string","x-stream-index":"001.001.003"},"cid":{"description":"The CID of the channel containing the poll","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":"number","x-stream-index":"001.001.001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.001.001.007"},"message_id":{"description":"The ID of the message containing the poll","title":"Message ID","type":"string","x-stream-index":"001.001.002"},"poll":{"$ref":"#/components/schemas/PollResponseData","description":"The poll object","title":"Poll","x-stream-index":"001.001.004"},"poll_vote":{"$ref":"#/components/schemas/PollVoteResponseData","description":"The vote that was cast","title":"Poll Vote","x-stream-index":"001.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.001.001.004"},"type":{"default":"poll.vote_casted","description":"The type of event: \"poll.vote_casted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.001.001.002"}},"required":["type","created_at","custom","poll","poll_vote"],"title":"PollVoteCastedEvent","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"},"PollVoteCastedFeedEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.001.002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"001.001.002.003"},"fid":{"type":"string","x-stream-index":"001.001.002.002"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001.001.001"},"poll_vote":{"$ref":"#/components/schemas/PollVoteResponseData","x-stream-index":"001.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.002.001.004"},"type":{"default":"feeds.poll.vote_casted","type":"string","x-stream-index":"001.001.002.001.002"}},"required":["poll","type","created_at","custom","fid","poll_vote"],"title":"PollVoteCastedFeedEvent","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"},"PollVoteChangedEvent":{"description":"Emitted when a vote on a poll is changed.","nullable":true,"properties":{"activity_id":{"type":"string","x-stream-index":"001.001.003"},"cid":{"description":"The CID of the channel containing the poll","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":"number","x-stream-index":"001.001.001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.001.001.007"},"message_id":{"description":"The ID of the message containing the poll","title":"Message ID","type":"string","x-stream-index":"001.001.002"},"poll":{"$ref":"#/components/schemas/PollResponseData","description":"The poll object","title":"Poll","x-stream-index":"001.001.004"},"poll_vote":{"$ref":"#/components/schemas/PollVoteResponseData","description":"The updated vote","title":"Poll Vote","x-stream-index":"001.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.001.001.004"},"type":{"default":"poll.vote_changed","description":"The type of event: \"poll.vote_changed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.001.001.002"}},"required":["type","created_at","custom","poll","poll_vote"],"title":"PollVoteChangedEvent","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"},"PollVoteChangedFeedEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.001.002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"001.001.002.003"},"fid":{"type":"string","x-stream-index":"001.001.002.002"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001.001.001"},"poll_vote":{"$ref":"#/components/schemas/PollVoteResponseData","x-stream-index":"001.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.002.001.004"},"type":{"default":"feeds.poll.vote_changed","type":"string","x-stream-index":"001.001.002.001.002"}},"required":["poll","type","created_at","custom","fid","poll_vote"],"title":"PollVoteChangedFeedEvent","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"},"PollVoteRemovedEvent":{"description":"Emitted when a vote is removed from a poll.","nullable":true,"properties":{"activity_id":{"type":"string","x-stream-index":"001.001.003"},"cid":{"description":"The CID of the channel containing the poll","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":"number","x-stream-index":"001.001.001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.001.001.007"},"message_id":{"description":"The ID of the message containing the poll","title":"Message ID","type":"string","x-stream-index":"001.001.002"},"poll":{"$ref":"#/components/schemas/PollResponseData","description":"The poll object","title":"Poll","x-stream-index":"001.001.004"},"poll_vote":{"$ref":"#/components/schemas/PollVoteResponseData","description":"The vote that was removed","title":"Poll Vote","x-stream-index":"001.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.001.001.004"},"type":{"default":"poll.vote_removed","description":"The type of event: \"poll.vote_removed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.001.001.002"}},"required":["type","created_at","custom","poll","poll_vote"],"title":"PollVoteRemovedEvent","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"},"PollVoteRemovedFeedEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.001.002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"001.001.002.003"},"fid":{"type":"string","x-stream-index":"001.001.002.002"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001.001.001"},"poll_vote":{"$ref":"#/components/schemas/PollVoteResponseData","x-stream-index":"001.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.002.001.004"},"type":{"default":"feeds.poll.vote_removed","type":"string","x-stream-index":"001.001.002.001.002"}},"required":["poll","type","created_at","custom","fid","poll_vote"],"title":"PollVoteRemovedFeedEvent","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"},"PollVoteResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"vote":{"$ref":"#/components/schemas/PollVoteResponseData","description":"Poll vote","title":"PollVoteResponseData","x-stream-index":"001"}},"required":["duration"],"type":"object"},"PollVoteResponseData":{"nullable":true,"properties":{"answer_text":{"type":"string","x-stream-index":"005"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"id":{"type":"string","x-stream-index":"002"},"is_answer":{"type":"boolean","x-stream-index":"004"},"option_id":{"type":"string","x-stream-index":"003"},"poll_id":{"type":"string","x-stream-index":"001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"007"},"user_id":{"type":"string","x-stream-index":"006"}},"required":["poll_id","id","option_id","created_at","updated_at"],"type":"object"},"PollVotesResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"votes":{"description":"Poll votes","items":{"$ref":"#/components/schemas/PollVoteResponseData"},"title":"PollVoteResponseList","type":"array","x-stream-index":"001"}},"required":["votes","duration"],"type":"object"},"PrivacySettings":{"properties":{"read_receipts":{"$ref":"#/components/schemas/ReadReceipts","x-stream-index":"002"},"typing_indicators":{"$ref":"#/components/schemas/TypingIndicators","x-stream-index":"001"}},"type":"object"},"PrivacySettingsResponse":{"properties":{"read_receipts":{"$ref":"#/components/schemas/ReadReceiptsResponse","x-stream-index":"002"},"typing_indicators":{"$ref":"#/components/schemas/TypingIndicatorsResponse","x-stream-index":"001"}},"type":"object"},"PublisherStatsResponse":{"properties":{"by_track":{"items":{"$ref":"#/components/schemas/TrackStatsResponse"},"type":"array","x-stream-index":"003"},"total":{"format":"int32","type":"integer","x-stream-index":"001"},"unique":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["total","unique"],"type":"object"},"PushNotificationConfig":{"properties":{"activity_types":{"items":{"type":"string"},"type":"array","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"PushPreferenceInput":{"nullable":true,"properties":{"call_level":{"description":"Set the level of call push notifications for the user. One of all, none, default","enum":["all","none","default"],"type":"string","x-stream-index":"004"},"channel_cid":{"description":"Set the push preferences for a specific channel. If empty it sets the default for the user","type":"string","x-stream-index":"002"},"chat_level":{"description":"Set the level of chat push notifications for the user. One of all, mentions, none, default","enum":["all","mentions","none","default"],"type":"string","x-stream-index":"003"},"disabled_until":{"description":"Disable push notifications till a certain time","format":"date-time","type":"number","x-stream-index":"007"},"feeds_events":{"$ref":"#/components/schemas/FeedsEventPreferencesInput","description":"Set granular feeds event preferences for reactions, comments, new followers, and mentions","x-stream-index":"006"},"feeds_level":{"description":"Set the level of feeds push notifications for the user. One of all, none, default","enum":["all","none","default"],"type":"string","x-stream-index":"005"},"remove_disable":{"description":"Remove the disabled until time. (IE stop snoozing notifications)","type":"boolean","x-stream-index":"008"},"user_id":{"description":"The user id for which to set the push preferences. Required when using server side auths, defaults to current user with client side auth.","type":"string","x-stream-index":"001"}},"type":"object"},"PushPreferences":{"properties":{"call_level":{"type":"string","x-stream-index":"002"},"chat_level":{"type":"string","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"number","x-stream-index":"005"},"feeds_events":{"$ref":"#/components/schemas/FeedsEventPreferences","x-stream-index":"004"},"feeds_level":{"type":"string","x-stream-index":"003"}},"type":"object"},"Quality":{"properties":{"bitdepth":{"format":"int32","type":"integer","x-stream-index":"007"},"framerate":{"format":"int32","type":"integer","x-stream-index":"008"},"height":{"format":"int32","type":"integer","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"004"},"video_bitrate":{"format":"int32","type":"integer","x-stream-index":"009"},"width":{"format":"int32","type":"integer","x-stream-index":"005"}},"type":"object"},"QualityScoreReport":{"properties":{"histogram":{"items":{"$ref":"#/components/schemas/ReportByHistogramBucket"},"type":"array","x-stream-index":"001"}},"required":["histogram"],"type":"object"},"QualityScoreReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateQualityScoreReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"QueryActivitiesRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filters to apply to the query. Supports location-based queries with 'near' and 'within_bounds' operators.","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"Sorting parameters for the query","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"002"}},"title":"Query Activities Request","type":"object"},"QueryActivitiesResponse":{"nullable":true,"properties":{"activities":{"description":"List of activities matching the query","items":{"$ref":"#/components/schemas/ActivityResponse"},"title":"Activities","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"next":{"description":"Cursor for next page","title":"Next","type":"string","x-stream-index":"002.001"},"prev":{"description":"Cursor for previous page","title":"Previous","type":"string","x-stream-index":"002.002"}},"required":["activities","duration"],"title":"Query Activities Response","type":"object"},"QueryActivityReactionsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"type":"object","x-stream-index":"002"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"004.001"},"next":{"type":"string","x-stream-index":"004.002"},"prev":{"type":"string","x-stream-index":"004.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"type":"array","x-stream-index":"003"}},"type":"object"},"QueryActivityReactionsResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"reactions":{"items":{"$ref":"#/components/schemas/FeedsReactionResponse"},"type":"array","x-stream-index":"001"}},"required":["reactions","duration"],"title":"Response","type":"object"},"QueryAggregateCallStatsRequest":{"nullable":true,"properties":{"from":{"type":"string","x-stream-index":"002"},"report_types":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"to":{"type":"string","x-stream-index":"003"}},"type":"object"},"QueryAggregateCallStatsResponse":{"description":"Basic response information","nullable":true,"properties":{"call_duration_report":{"$ref":"#/components/schemas/CallDurationReportResponse","x-stream-index":"002"},"call_participant_count_report":{"$ref":"#/components/schemas/CallParticipantCountReportResponse","x-stream-index":"004"},"calls_per_day_report":{"$ref":"#/components/schemas/CallsPerDayReportResponse","x-stream-index":"003"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"network_metrics_report":{"$ref":"#/components/schemas/NetworkMetricsReportResponse","x-stream-index":"008"},"quality_score_report":{"$ref":"#/components/schemas/QualityScoreReportResponse","x-stream-index":"005"},"sdk_usage_report":{"$ref":"#/components/schemas/SDKUsageReportResponse","x-stream-index":"006"},"user_feedback_report":{"$ref":"#/components/schemas/UserFeedbackReportResponse","x-stream-index":"007"}},"required":["duration"],"title":"Response","type":"object"},"QueryBannedUsersPayload":{"properties":{"exclude_expired_bans":{"description":"Whether to exclude expired bans or not","title":"Exclude expired bans","type":"boolean","x-stream-index":"004"},"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"description":"Number of records to return","format":"int32","maximum":300,"minimum":0,"title":"Limit","type":"integer","x-stream-index":"003.003"},"offset":{"description":"Number of records to offset","format":"int32","maximum":10000,"title":"Offset","type":"integer","x-stream-index":"003.004"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":1,"title":"Sort","type":"array","x-stream-index":"002"}},"required":["filter_conditions"],"type":"object"},"QueryBannedUsersResponse":{"nullable":true,"properties":{"bans":{"description":"List of found bans","items":{"$ref":"#/components/schemas/BanResponse"},"title":"BanResponse","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["bans","duration"],"type":"object"},"QueryBookmarkFoldersRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filters to apply to the query","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"Sorting parameters for the query","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"002"}},"title":"Query Bookmark Folders Request","type":"object"},"QueryBookmarkFoldersResponse":{"nullable":true,"properties":{"bookmark_folders":{"description":"List of bookmark folders matching the query","items":{"$ref":"#/components/schemas/BookmarkFolderResponse"},"title":"Bookmark Folders","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"next":{"description":"Cursor for next page","title":"Next","type":"string","x-stream-index":"002.001"},"prev":{"description":"Cursor for previous page","title":"Previous","type":"string","x-stream-index":"002.002"}},"required":["bookmark_folders","duration"],"title":"Query Bookmark Folders Response","type":"object"},"QueryBookmarksRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filters to apply to the query","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"Sorting parameters for the query","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"002"}},"title":"Query Bookmarks Request","type":"object"},"QueryBookmarksResponse":{"nullable":true,"properties":{"bookmarks":{"description":"List of bookmarks matching the query","items":{"$ref":"#/components/schemas/BookmarkResponse"},"title":"Bookmarks","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"next":{"description":"Cursor for next page","title":"Next","type":"string","x-stream-index":"002.001"},"prev":{"description":"Cursor for previous page","title":"Previous","type":"string","x-stream-index":"002.002"}},"required":["bookmarks","duration"],"title":"Query Bookmarks Response","type":"object"},"QueryCallMembersRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"002"},"id":{"maxLength":64,"type":"string","x-stream-index":"001.002"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"004.001"},"next":{"type":"string","x-stream-index":"004.002"},"prev":{"type":"string","x-stream-index":"004.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":1,"type":"array","x-stream-index":"003"},"type":{"maxLength":64,"type":"string","x-stream-index":"001.001"}},"required":["type","id"],"type":"object"},"QueryCallMembersResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["members","duration"],"title":"Response","type":"object"},"QueryCallParticipantsRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"003"}},"type":"object"},"QueryCallParticipantsResponse":{"nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001.001"},"duration":{"type":"string","x-stream-index":"004.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001.002"},"membership":{"$ref":"#/components/schemas/MemberResponse","x-stream-index":"001.003"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"001.004"},"participants":{"description":"List of call participants","items":{"$ref":"#/components/schemas/CallParticipantResponse"},"title":"[]CallParticipantResponse","type":"array","x-stream-index":"002"},"total_participants":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["call","members","own_capabilities","blocked_users","participants","total_participants","duration"],"type":"object"},"QueryCallStatsRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"004.001"},"next":{"type":"string","x-stream-index":"004.002"},"prev":{"type":"string","x-stream-index":"004.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":2,"type":"array","x-stream-index":"002"}},"type":"object"},"QueryCallStatsResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"next":{"type":"string","x-stream-index":"003.001"},"prev":{"type":"string","x-stream-index":"003.002"},"reports":{"items":{"$ref":"#/components/schemas/CallStatsReportSummaryResponse"},"type":"array","x-stream-index":"001"}},"required":["reports","duration"],"title":"Response","type":"object"},"QueryCallsRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"title":"Filters","type":"object","x-stream-index":"003"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"006.001"},"next":{"type":"string","x-stream-index":"006.002"},"prev":{"type":"string","x-stream-index":"006.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":2,"title":"Sort","type":"array","x-stream-index":"004"},"watch":{"title":"Watch","type":"boolean","x-stream-index":"001"}},"title":"QueryCallsRequest","type":"object"},"QueryCallsResponse":{"nullable":true,"properties":{"calls":{"items":{"$ref":"#/components/schemas/CallStateResponseFields"},"title":"Calls","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["calls","duration"],"title":"QueryCallsResponse","type":"object"},"QueryChannelsRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"description":"Number of channels to limit","format":"int32","title":"Limit","type":"integer","x-stream-index":"008"},"member_limit":{"description":"Number of members to limit","format":"int32","maximum":100,"minimum":0,"title":"Member limit","type":"integer","x-stream-index":"007"},"message_limit":{"description":"Number of messages to limit","format":"int32","minimum":0,"title":"Message limit","type":"integer","x-stream-index":"006"},"offset":{"description":"Channel pagination offset","format":"int32","title":"Offset","type":"integer","x-stream-index":"009"},"presence":{"title":"Presence","type":"boolean","x-stream-index":"005"},"sort":{"description":"List of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"002"},"state":{"description":"Whether to update channel state or not","title":"State","type":"boolean","x-stream-index":"004"},"watch":{"description":"Whether to start watching found channels or not","title":"Watch","type":"boolean","x-stream-index":"003"}},"title":"Query Channels Request","type":"object","x-stream-docs-page-id":"query_channels"},"QueryChannelsResponse":{"nullable":true,"properties":{"channels":{"description":"List of channels","items":{"$ref":"#/components/schemas/ChannelStateResponseFields"},"title":"Channels","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["channels","duration"],"title":"Channels list","type":"object"},"QueryCommentReactionsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"type":"object","x-stream-index":"002"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"004.001"},"next":{"type":"string","x-stream-index":"004.002"},"prev":{"type":"string","x-stream-index":"004.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"type":"array","x-stream-index":"003"}},"type":"object"},"QueryCommentReactionsResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"reactions":{"items":{"$ref":"#/components/schemas/FeedsReactionResponse"},"type":"array","x-stream-index":"001"}},"required":["reactions","duration"],"title":"Response","type":"object"},"QueryCommentsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"MongoDB-style filter for querying comments","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"description":"Maximum number of comments to return","format":"int32","maximum":100,"minimum":0,"title":"Limit","type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"first (oldest), last (newest) or top","enum":["first","last","top","best","controversial"],"title":"Sort Order","type":"string","x-stream-index":"002"}},"required":["filter"],"title":"Query Comments Request","type":"object"},"QueryCommentsResponse":{"nullable":true,"properties":{"comments":{"description":"List of comments matching the query","items":{"$ref":"#/components/schemas/CommentResponse"},"title":"Comments","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"next":{"description":"Cursor for next page","title":"Next","type":"string","x-stream-index":"002.001"},"prev":{"description":"Cursor for previous page","title":"Previous","type":"string","x-stream-index":"002.002"}},"required":["comments","duration"],"title":"Query Comments Response","type":"object"},"QueryDraftsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","maximum":3,"title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"002"}},"type":"object"},"QueryDraftsResponse":{"nullable":true,"properties":{"drafts":{"description":"Drafts","items":{"$ref":"#/components/schemas/DraftResponse"},"title":"DraftsResponseList","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["drafts","duration"],"type":"object"},"QueryFeedMembersRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter parameters for the query","title":"object","type":"object","x-stream-index":"003"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Sort parameters for the query","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"array","type":"array","x-stream-index":"004"}},"type":"object"},"QueryFeedMembersResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"003.001"},"members":{"description":"List of feed members","items":{"$ref":"#/components/schemas/FeedMemberResponse"},"title":"array","type":"array","x-stream-index":"001"},"next":{"description":"Cursor for next page","title":"Next","type":"string","x-stream-index":"002.001"},"prev":{"description":"Cursor for previous page","title":"Previous","type":"string","x-stream-index":"002.002"}},"required":["members","duration"],"type":"object"},"QueryFeedsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filters to apply to the query","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"004.001"},"next":{"type":"string","x-stream-index":"004.002"},"prev":{"type":"string","x-stream-index":"004.003"},"sort":{"description":"Sorting parameters for the query","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"003"},"watch":{"description":"Whether to subscribe to realtime updates","title":"Watch","type":"boolean","x-stream-index":"002"}},"title":"Query Feeds Request","type":"object"},"QueryFeedsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"003.001"},"feeds":{"description":"List of feeds matching the query","items":{"$ref":"#/components/schemas/FeedResponse"},"title":"Feeds","type":"array","x-stream-index":"001"},"next":{"description":"Cursor for next page","title":"Next","type":"string","x-stream-index":"002.001"},"prev":{"description":"Cursor for previous page","title":"Previous","type":"string","x-stream-index":"002.002"}},"required":["feeds","duration"],"title":"Query Feeds Response","type":"object"},"QueryFollowsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filters to apply to the query","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"Sorting parameters for the query","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"002"}},"title":"Query Follows Request","type":"object"},"QueryFollowsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"003.001"},"follows":{"description":"List of follow relationships matching the query","items":{"$ref":"#/components/schemas/FollowResponse"},"title":"Follows","type":"array","x-stream-index":"001"},"next":{"description":"Cursor for next page","title":"Next","type":"string","x-stream-index":"002.001"},"prev":{"description":"Cursor for previous page","title":"Previous","type":"string","x-stream-index":"002.002"}},"required":["follows","duration"],"title":"Query Follows Response","type":"object"},"QueryMembersPayload":{"description":"Client request","properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"002"},"limit":{"format":"int32","maximum":300,"minimum":0,"type":"integer","x-stream-index":"006.003"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"type":"array","x-stream-index":"003"},"offset":{"format":"int32","maximum":10000,"type":"integer","x-stream-index":"006.004"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":1,"type":"array","x-stream-index":"005"},"type":{"maxLength":64,"type":"string","x-stream-index":"001"}},"required":["type","filter_conditions"],"title":"ClientRequest","type":"object"},"QueryMessageFlagsPayload":{"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":300,"minimum":0,"type":"integer","x-stream-index":"003.003"},"offset":{"format":"int32","maximum":10000,"type":"integer","x-stream-index":"003.004"},"show_deleted_messages":{"description":"Whether to include deleted messages in the results","title":"ShowDeletedMessages","type":"boolean","x-stream-index":"002"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"type":"array","x-stream-index":"003.005"}},"type":"object"},"QueryMessageFlagsResponse":{"description":"Query message flags response","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"flags":{"description":"The flags that match the query","items":{"$ref":"#/components/schemas/MessageFlagResponse"},"title":"MessageFlagResponseList","type":"array","x-stream-index":"001"}},"required":["flags","duration"],"title":"QueryMessageFlagsResponse","type":"object"},"QueryModerationConfigsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter conditions for moderation configs","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"Sorting parameters for the results","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"002"}},"type":"object"},"QueryModerationConfigsResponse":{"nullable":true,"properties":{"configs":{"description":"List of moderation configurations","items":{"$ref":"#/components/schemas/ConfigResponse"},"title":"Configs","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["configs","duration"],"type":"object"},"QueryPollVotesRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","title":"Filter","type":"object","x-stream-index":"003"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"004"}},"type":"object"},"QueryPollsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","title":"Filter","type":"object","x-stream-index":"002"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"003"}},"type":"object"},"QueryPollsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"polls":{"description":"Polls data returned by the query","items":{"$ref":"#/components/schemas/PollResponseData"},"title":"PollsResponseData","type":"array","x-stream-index":"001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["polls","duration"],"type":"object"},"QueryReactionsRequest":{"properties":{"filter":{"additionalProperties":{},"type":"object","x-stream-index":"002"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"006.001"},"next":{"type":"string","x-stream-index":"006.002"},"prev":{"type":"string","x-stream-index":"006.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":2,"type":"array","x-stream-index":"003"}},"type":"object"},"QueryReactionsResponse":{"description":"Basic response information","properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"next":{"type":"string","x-stream-index":"003.001"},"prev":{"type":"string","x-stream-index":"003.002"},"reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"001"}},"required":["reactions","duration"],"title":"Response","type":"object"},"QueryRemindersRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"002"}},"type":"object"},"QueryRemindersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"reminders":{"description":"MessageReminders data returned by the query","items":{"$ref":"#/components/schemas/ReminderResponseData"},"title":"RemindersResponseData","type":"array","x-stream-index":"001"}},"required":["reminders","duration"],"type":"object"},"QueryReviewQueueRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter conditions for review queue items","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"007.001"},"lock_count":{"description":"Number of items to lock (1-25)","format":"int32","maximum":25,"minimum":1,"title":"Lock Count","type":"integer","x-stream-index":"005"},"lock_duration":{"description":"Duration for which items should be locked","title":"Lock Duration","type":"integer","x-stream-index":"004"},"lock_items":{"description":"Whether to lock items for review (true), unlock items (false), or just fetch (nil)","title":"Lock Items","type":"boolean","x-stream-index":"003"},"next":{"type":"string","x-stream-index":"007.002"},"prev":{"type":"string","x-stream-index":"007.003"},"sort":{"description":"Sorting parameters for the results","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"002"},"stats_only":{"description":"Whether to return only statistics","title":"Stats Only","type":"boolean","x-stream-index":"006"}},"type":"object"},"QueryReviewQueueResponse":{"nullable":true,"properties":{"action_config":{"additionalProperties":{"items":{"$ref":"#/components/schemas/ModerationActionConfig"},"type":"array"},"description":"Configuration for moderation actions","title":"Action Config","type":"object","x-stream-index":"002"},"duration":{"type":"string","x-stream-index":"005.001"},"items":{"description":"List of review queue items","items":{"$ref":"#/components/schemas/ReviewQueueItemResponse"},"title":"Items","type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"004.001"},"prev":{"type":"string","x-stream-index":"004.002"},"stats":{"additionalProperties":{},"description":"Statistics about the review queue","title":"Stats","type":"object","x-stream-index":"003"}},"required":["items","action_config","stats","duration"],"type":"object"},"QueryThreadsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter conditions to apply to threads","title":"Filter","type":"object","x-stream-index":"006"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"008.001"},"member_limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005"},"next":{"type":"string","x-stream-index":"008.002"},"participant_limit":{"description":"Limit the number of participants returned per each thread","format":"int32","maximum":100,"minimum":0,"title":"Participant limit","type":"integer","x-stream-index":"004"},"prev":{"type":"string","x-stream-index":"008.003"},"reply_limit":{"description":"Limit the number of replies returned per each thread","format":"int32","maximum":10,"minimum":0,"title":"Reply limit","type":"integer","x-stream-index":"003"},"sort":{"description":"Sort conditions to apply to threads","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"007"},"watch":{"description":"Start watching the channel this thread belongs to","title":"Watch","type":"boolean","x-stream-index":"001"}},"type":"object"},"QueryThreadsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"threads":{"description":"List of enriched thread states","items":{"$ref":"#/components/schemas/ThreadStateResponse"},"title":"Threads","type":"array","x-stream-index":"001"}},"required":["threads","duration"],"type":"object"},"QueryUsersPayload":{"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"include_deactivated_users":{"type":"boolean","x-stream-index":"004"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.003"},"offset":{"format":"int32","maximum":1000,"type":"integer","x-stream-index":"005.004"},"presence":{"type":"boolean","x-stream-index":"003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"type":"array","x-stream-index":"002"}},"required":["filter_conditions"],"type":"object"},"QueryUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"users":{"description":"Array of users as result of filters applied.","items":{"$ref":"#/components/schemas/FullUserResponse"},"title":"Users","type":"array","x-stream-index":"001"}},"required":["users","duration"],"type":"object"},"RTMPBroadcastRequest":{"description":"RTMPBroadcastRequest is the payload for starting an RTMP broadcast.","properties":{"layout":{"$ref":"#/components/schemas/LayoutSettingsRequest","description":"If provided, will override the call's RTMP settings layout","title":"Layout","x-stream-index":"005"},"name":{"description":"Name identifier for RTMP broadcast, must be unique in call","maxLength":255,"title":"Name","type":"string","x-stream-index":"001"},"quality":{"description":"If provided, will override the call's RTMP settings quality","enum":["360p","480p","720p","1080p","1440p","portrait-360x640","portrait-480x854","portrait-720x1280","portrait-1080x1920","portrait-1440x2560"],"title":"Quality","type":"string","x-stream-index":"004"},"stream_key":{"description":"If provided, will be appended at the end of stream_url","title":"Stream Key","type":"string","x-stream-index":"003"},"stream_url":{"description":"URL for the RTMP server to send the call to","maxLength":255,"title":"Stream URL","type":"string","x-stream-index":"002"}},"required":["name","stream_url"],"title":"RTMPBroadcastRequest","type":"object"},"RTMPEgressConfig":{"properties":{"composite_app_settings":{"$ref":"#/components/schemas/CompositeAppSettings","x-stream-index":"005"},"quality":{"$ref":"#/components/schemas/Quality","x-stream-index":"004"},"rtmp_location":{"type":"string","x-stream-index":"006"}},"type":"object"},"RTMPIngress":{"description":"RTMP input settings","properties":{"address":{"title":"Address","type":"string","x-stream-index":"001"}},"required":["address"],"title":"RTMPIngress","type":"object"},"RTMPLocation":{"properties":{"name":{"type":"string","x-stream-index":"001"},"stream_key":{"type":"string","x-stream-index":"003"},"stream_url":{"type":"string","x-stream-index":"002"}},"required":["name","stream_url","stream_key"],"type":"object"},"RTMPSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"003"},"location":{"$ref":"#/components/schemas/RTMPLocation","x-stream-index":"004"},"quality_name":{"type":"string","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"RTMPSettingsRequest":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"quality":{"description":"Resolution to set for the RTMP stream","enum":["360p","480p","720p","1080p","1440p","portrait-360x640","portrait-480x854","portrait-720x1280","portrait-1080x1920","portrait-1440x2560"],"title":"Quality","type":"string","x-stream-index":"002"}},"title":"RTMPSettingsRequest","type":"object"},"RTMPSettingsResponse":{"description":"RTMPSettingsResponse is the payload for RTMP settings","properties":{"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"001"},"quality":{"title":"Quality","type":"string","x-stream-index":"002"}},"required":["enabled","quality","layout"],"title":"RTMPSettingsResponse","type":"object"},"RankingConfig":{"properties":{"defaults":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"functions":{"additionalProperties":{"$ref":"#/components/schemas/DecayFunctionConfig"},"type":"object","x-stream-index":"004"},"score":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"001"}},"type":"object"},"Reaction":{"nullable":true,"properties":{"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"message_id":{"type":"string","x-stream-index":"003"},"score":{"format":"int32","type":"integer","x-stream-index":"007"},"type":{"maxLength":30,"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["message_id","type","score","created_at","updated_at","custom"],"type":"object"},"ReactionDeletedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"006.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"002"},"team":{"type":"string","x-stream-index":"005.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"reaction.deleted","type":"string","x-stream-index":"006.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"ReactionDeletedEvent","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"},"ReactionGroupResponse":{"description":"ReactionGroupResponse contains all information about a reaction of the same type.","nullable":true,"properties":{"count":{"description":"Count is the number of reactions of this type.","format":"int32","title":"Count","type":"integer","x-stream-index":"001"},"first_reaction_at":{"description":"FirstReactionAt is the time of the first reaction of this type. This is the same also if all reaction of this type are deleted, because if someone will react again with the same type, will be preserved the sorting.","format":"date-time","title":"FirstReactionAt","type":"number","x-stream-index":"003"},"last_reaction_at":{"description":"LastReactionAt is the time of the last reaction of this type.","format":"date-time","title":"LastReactionAt","type":"number","x-stream-index":"004"},"sum_scores":{"description":"SumScores is the sum of all scores of reactions of this type. Medium allows you to clap articles more than once and shows the sum of all claps from all users. For example, you can send `clap` x5 using `score: 5`.","format":"int32","title":"SumScores","type":"integer","x-stream-index":"002"}},"required":["count","sum_scores","first_reaction_at","last_reaction_at"],"title":"ReactionGroupResponse","type":"object"},"ReactionNewEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"006.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"002"},"team":{"type":"string","x-stream-index":"005.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"reaction.new","type":"string","x-stream-index":"006.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"ReactionNewEvent","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"},"ReactionRequest":{"description":"Represents user reaction to a message","properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"score":{"description":"Reaction score. If not specified reaction has score of 1","format":"int32","title":"Score","type":"integer","x-stream-index":"002"},"type":{"description":"The type of reaction (e.g. 'like', 'laugh', 'wow')","maxLength":30,"title":"Type","type":"string","x-stream-index":"001"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"004"}},"required":["type"],"title":"Reaction","type":"object","x-stream-docs-page-id":"send_reaction"},"ReactionResponse":{"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"006"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"008"},"message_id":{"description":"Message ID","title":"Message ID","type":"string","x-stream-index":"001"},"score":{"description":"Score of the reaction","format":"int32","title":"Score","type":"integer","x-stream-index":"005"},"type":{"description":"Type of reaction","title":"Type","type":"string","x-stream-index":"004"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"007"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User","title":"UserResponse","x-stream-index":"003"},"user_id":{"description":"User ID","title":"User ID","type":"string","x-stream-index":"002"}},"required":["message_id","user_id","user","type","score","created_at","updated_at","custom"],"type":"object"},"ReactionUpdatedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"006.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"002"},"team":{"type":"string","x-stream-index":"005.001"},"type":{"default":"reaction.updated","type":"string","x-stream-index":"006.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["message","reaction","cid","channel_id","channel_type","type","created_at"],"title":"ReactionUpdatedEvent","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"},"ReadReceipts":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"ReadReceiptsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"ReadStateResponse":{"properties":{"last_read":{"format":"date-time","type":"number","x-stream-index":"002"},"last_read_message_id":{"type":"string","x-stream-index":"004"},"unread_messages":{"format":"int32","type":"integer","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"}},"required":["user","last_read","unread_messages"],"type":"object"},"RecordSettings":{"properties":{"audio_only":{"type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"004"},"mode":{"type":"string","x-stream-index":"002"},"quality":{"type":"string","x-stream-index":"003"}},"required":["mode"],"type":"object"},"RecordSettingsRequest":{"properties":{"audio_only":{"type":"boolean","x-stream-index":"001"},"mode":{"enum":["available","disabled","auto-on"],"title":"Mode","type":"string","x-stream-index":"002"},"quality":{"enum":["360p","480p","720p","1080p","1440p","portrait-360x640","portrait-480x854","portrait-720x1280","portrait-1080x1920","portrait-1440x2560"],"type":"string","x-stream-index":"003"}},"required":["mode"],"title":"RecordSettingsRequest","type":"object"},"RecordSettingsResponse":{"description":"RecordSettings is the payload for recording settings","properties":{"audio_only":{"title":"Audio Only","type":"boolean","x-stream-index":"001"},"mode":{"title":"Mode","type":"string","x-stream-index":"002"},"quality":{"title":"Quality","type":"string","x-stream-index":"003"}},"required":["audio_only","mode","quality","layout"],"title":"RecordSettingsResponse","type":"object"},"RecordingEgressConfig":{"properties":{"audio_only":{"type":"boolean","x-stream-index":"006"},"composite_app_settings":{"$ref":"#/components/schemas/CompositeAppSettings","x-stream-index":"005"},"external_storage":{"$ref":"#/components/schemas/ExternalStorage","x-stream-index":"008"},"quality":{"$ref":"#/components/schemas/Quality","x-stream-index":"004"},"storage_name":{"type":"string","x-stream-index":"007"},"video_orientation_hint":{"$ref":"#/components/schemas/VideoOrientation","x-stream-index":"009"}},"type":"object"},"RejectCallRequest":{"nullable":true,"properties":{"reason":{"description":"Reason for rejecting the call","title":"Reason","type":"string","x-stream-index":"003"}},"title":"RejectCallRequest","type":"object"},"RejectCallResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"RejectCallResponse","type":"object"},"RejectFeedMemberInviteRequest":{"nullable":true,"title":"Reject Feed Member Request","type":"object"},"RejectFeedMemberInviteResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"member":{"$ref":"#/components/schemas/FeedMemberResponse","description":"The feed member after rejecting the invite","title":"Feed Member","x-stream-index":"001"}},"required":["member","duration"],"title":"Reject Feed Member Response","type":"object"},"RejectFollowRequest":{"nullable":true,"properties":{"source":{"description":"Fully qualified ID of the source feed","maxLength":255,"title":"Source Feed ID","type":"string","x-stream-index":"001"},"target":{"description":"Fully qualified ID of the target feed","maxLength":255,"title":"Target Feed ID","type":"string","x-stream-index":"002"}},"required":["source","target"],"title":"Reject Follow Request","type":"object"},"RejectFollowResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"follow":{"$ref":"#/components/schemas/FollowResponse","description":"The rejected follow relationship","title":"Follow","x-stream-index":"001"}},"required":["follow","duration"],"title":"Reject Follow Response","type":"object"},"ReminderCreatedEvent":{"description":"Emitted when a reminder is created.","nullable":true,"properties":{"cid":{"description":"The CID of the Channel for which the reminder was created","title":"Channel CID","type":"string","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.007"},"message_id":{"description":"The ID of the message for which the reminder was created","title":"Message ID","type":"string","x-stream-index":"001.002"},"parent_id":{"description":"The ID of the parent message, if the reminder is for a thread message","title":"Parent ID","type":"string","x-stream-index":"001.005"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","description":"The reminder object which was created","title":"MessageReminder","x-stream-index":"001.006"},"type":{"default":"reminder.created","description":"The type of event: \"reminder.created\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.002"},"user_id":{"description":"The ID of the user for whom the reminder was created","title":"User ID","type":"string","x-stream-index":"001.003"}},"required":["type","created_at","custom","message_id","user_id","cid"],"title":"ReminderCreatedEvent","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"},"ReminderDeletedEvent":{"description":"Emitted when a reminder is deleted.","nullable":true,"properties":{"cid":{"description":"The CID of the Channel for which the reminder was created","title":"Channel CID","type":"string","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.007"},"message_id":{"description":"The ID of the message for which the reminder was created","title":"Message ID","type":"string","x-stream-index":"001.002"},"parent_id":{"description":"The ID of the parent message, if the reminder is for a thread message","title":"Parent ID","type":"string","x-stream-index":"001.005"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","description":"The reminder object which was created","title":"MessageReminder","x-stream-index":"001.006"},"type":{"default":"reminder.deleted","description":"The type of event: \"reminder.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.002"},"user_id":{"description":"The ID of the user for whom the reminder was created","title":"User ID","type":"string","x-stream-index":"001.003"}},"required":["type","created_at","custom","message_id","user_id","cid"],"title":"ReminderDeletedEvent","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"},"ReminderNotificationEvent":{"description":"Emitted when a reminder becomes due, triggering a notification for the user.","nullable":true,"properties":{"cid":{"description":"The CID of the Channel for which the reminder was created","title":"Channel CID","type":"string","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.007"},"message_id":{"description":"The ID of the message for which the reminder was created","title":"Message ID","type":"string","x-stream-index":"001.002"},"parent_id":{"type":"string","x-stream-index":"001.005"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","description":"The reminder object which was created","title":"MessageReminder","x-stream-index":"001.006"},"type":{"default":"notification.reminder_due","description":"The type of event: \"notification.reminder_due\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.002"},"user_id":{"description":"The ID of the user for whom the reminder was created","title":"User ID","type":"string","x-stream-index":"001.003"}},"required":["type","created_at","custom","message_id","user_id","cid"],"title":"ReminderNotificationEvent","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"},"ReminderResponseData":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003"},"channel_cid":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"005"},"message_id":{"type":"string","x-stream-index":"004"},"remind_at":{"format":"date-time","type":"number","x-stream-index":"001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007"},"user_id":{"type":"string","x-stream-index":"006"}},"required":["channel_cid","message_id","user_id","created_at","updated_at"],"type":"object"},"ReminderUpdatedEvent":{"description":"Emitted when a reminder is updated.","nullable":true,"properties":{"cid":{"description":"The CID of the Channel for which the reminder was created","title":"Channel CID","type":"string","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.007"},"message_id":{"description":"The ID of the message for which the reminder was created","title":"Message ID","type":"string","x-stream-index":"001.002"},"parent_id":{"description":"The ID of the parent message, if the reminder is for a thread message","title":"Parent ID","type":"string","x-stream-index":"001.005"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","description":"The reminder object which was created","title":"MessageReminder","x-stream-index":"001.006"},"type":{"default":"reminder.updated","description":"The type of event: \"reminder.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.002"},"user_id":{"description":"The ID of the user for whom the reminder was created","title":"User ID","type":"string","x-stream-index":"001.003"}},"required":["type","created_at","custom","message_id","user_id","cid"],"title":"ReminderUpdatedEvent","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"},"RepliesMeta":{"description":"Cursor \u0026 depth information for a comment's direct replies. Mirrors Reddit's 'load more replies' semantics.","properties":{"depth_truncated":{"description":"True if the subtree was cut because the requested depth was reached.","title":"Depth Truncated","type":"boolean","x-stream-index":"004"},"has_more":{"description":"True if more siblings exist in the database.","title":"Has More","type":"boolean","x-stream-index":"001"},"next_cursor":{"description":"Opaque cursor to request the next page of siblings.","title":"Next Cursor","type":"string","x-stream-index":"002"},"remaining":{"description":"Number of unread siblings that match current filters.","format":"int32","title":"Remaining","type":"integer","x-stream-index":"003"}},"required":["has_more","remaining","depth_truncated"],"title":"Replies Meta","type":"object"},"ReportByHistogramBucket":{"properties":{"category":{"type":"string","x-stream-index":"001"},"count":{"format":"int32","type":"integer","x-stream-index":"005"},"lower_bound":{"$ref":"#/components/schemas/Bound","x-stream-index":"002"},"sum":{"format":"float","type":"number","x-stream-index":"004"},"upper_bound":{"$ref":"#/components/schemas/Bound","x-stream-index":"003"}},"required":["category","sum","count"],"type":"object"},"ReportResponse":{"properties":{"call":{"$ref":"#/components/schemas/CallReportResponse","x-stream-index":"003"},"participants":{"$ref":"#/components/schemas/ParticipantReportResponse","x-stream-index":"001"},"user_ratings":{"$ref":"#/components/schemas/UserRatingReportResponse","x-stream-index":"002"}},"required":["participants","user_ratings","call"],"type":"object"},"RequestPermissionRequest":{"nullable":true,"properties":{"permissions":{"items":{"type":"string"},"title":"Permissions","type":"array","x-stream-index":"003"}},"required":["permissions"],"title":"RequestPermissionRequest","type":"object"},"RequestPermissionResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"RequestPermissionResponse","type":"object"},"Response":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001"}},"required":["duration"],"title":"Response","type":"object"},"RestoreActionRequest":{"type":"object"},"ReviewQueueItem":{"properties":{"actions":{"items":{"$ref":"#/components/schemas/ActionLog"},"type":"array","x-stream-index":"035"},"activity":{"$ref":"#/components/schemas/EnrichedActivity","x-stream-index":"028"},"ai_text_severity":{"type":"string","x-stream-index":"021"},"archived_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"043"},"assigned_to":{"$ref":"#/components/schemas/User","x-stream-index":"032"},"bans":{"items":{"$ref":"#/components/schemas/Ban"},"type":"array","x-stream-index":"033"},"bounce_count":{"format":"int32","type":"integer","x-stream-index":"025"},"call":{"$ref":"#/components/schemas/Call","x-stream-index":"031"},"completed_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"018"},"config_key":{"type":"string","x-stream-index":"009"},"content_changed":{"type":"boolean","x-stream-index":"036"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"entity_creator":{"$ref":"#/components/schemas/EntityCreator","x-stream-index":"030"},"entity_id":{"type":"string","x-stream-index":"007"},"entity_type":{"type":"string","x-stream-index":"006"},"feeds_v2_activity":{"$ref":"#/components/schemas/EnrichedActivity","x-stream-index":"041"},"feeds_v2_reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"042"},"flag_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"045"},"flag_types":{"items":{"type":"string"},"type":"array","x-stream-index":"044"},"flags":{"items":{"$ref":"#/components/schemas/Flag"},"type":"array","x-stream-index":"034"},"flags_count":{"format":"int32","type":"integer","x-stream-index":"026"},"has_image":{"type":"boolean","x-stream-index":"012"},"has_text":{"type":"boolean","x-stream-index":"014"},"has_video":{"type":"boolean","x-stream-index":"013"},"id":{"type":"string","x-stream-index":"003"},"languages":{"items":{"type":"string"},"type":"array","x-stream-index":"019"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"027"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"010"},"moderation_payload_hash":{"type":"string","x-stream-index":"011"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"029"},"recommended_action":{"type":"string","x-stream-index":"017"},"reporter_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"046"},"reviewed_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"022"},"reviewed_by":{"type":"string","x-stream-index":"023"},"severity":{"format":"int32","type":"integer","x-stream-index":"020"},"status":{"type":"string","x-stream-index":"016"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"015"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"005"}},"required":["id","created_at","updated_at","entity_type","entity_id","config_key","moderation_payload_hash","has_image","has_video","has_text","teams","status","recommended_action","completed_at","languages","severity","ai_text_severity","reviewed_at","reviewed_by","bounce_count","flags_count","bans","flags","actions","content_changed","archived_at","flag_types","flag_labels","reporter_ids"],"type":"object"},"ReviewQueueItemResponse":{"nullable":true,"properties":{"actions":{"description":"Moderation actions taken","items":{"$ref":"#/components/schemas/ActionLogResponse"},"title":"Actions","type":"array","x-stream-index":"024"},"activity":{"$ref":"#/components/schemas/EnrichedActivity","x-stream-index":"016"},"ai_text_severity":{"description":"AI-determined text severity","title":"AI Text Severity","type":"string","x-stream-index":"014"},"assigned_to":{"$ref":"#/components/schemas/UserResponse","description":"Moderator assigned to review this item","title":"Assigned To","x-stream-index":"021"},"bans":{"description":"Associated ban records","items":{"$ref":"#/components/schemas/Ban"},"title":"Bans","type":"array","x-stream-index":"022"},"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"018"},"completed_at":{"description":"When the review was completed","format":"date-time","title":"Completed At","type":"number","x-stream-index":"009"},"config_key":{"type":"string","x-stream-index":"028"},"created_at":{"description":"When the item was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"002"},"entity_creator":{"$ref":"#/components/schemas/EntityCreatorResponse","description":"Details about who created the entity","title":"Entity Creator","x-stream-index":"019"},"entity_creator_id":{"description":"ID of who created the entity","title":"Entity Creator ID","type":"string","x-stream-index":"020"},"entity_id":{"description":"ID of the entity being reviewed","title":"Entity ID","type":"string","x-stream-index":"005"},"entity_type":{"description":"Type of entity being reviewed","title":"Entity Type","type":"string","x-stream-index":"004"},"feeds_v2_activity":{"$ref":"#/components/schemas/EnrichedActivity","description":"Associated feed activity","title":"Feeds V2 Activity","x-stream-index":"025"},"feeds_v2_reaction":{"$ref":"#/components/schemas/Reaction","description":"Associated feed reaction","title":"Feeds V2 Reaction","x-stream-index":"026"},"flags":{"description":"Associated flag records","items":{"$ref":"#/components/schemas/ModerationFlagResponse"},"title":"Flags","type":"array","x-stream-index":"023"},"flags_count":{"format":"int32","type":"integer","x-stream-index":"029"},"id":{"description":"Unique identifier of the review queue item","title":"ID","type":"string","x-stream-index":"001"},"languages":{"description":"Detected languages in the content","items":{"type":"string"},"title":"Languages","type":"array","x-stream-index":"012"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Associated message details","title":"Message","x-stream-index":"015"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content being moderated","title":"Moderation Payload","x-stream-index":"006"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"017"},"recommended_action":{"description":"Suggested moderation action","title":"Recommended Action","type":"string","x-stream-index":"008"},"reviewed_at":{"description":"When the item was reviewed","format":"date-time","title":"Reviewed At","type":"number","x-stream-index":"010"},"reviewed_by":{"description":"ID of the moderator who reviewed the item","title":"Reviewed By","type":"string","x-stream-index":"011"},"severity":{"description":"Severity level of the content","format":"int32","title":"Severity","type":"integer","x-stream-index":"013"},"status":{"description":"Current status of the review","title":"Status","type":"string","x-stream-index":"007"},"teams":{"description":"Teams associated with this item","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"027"},"updated_at":{"description":"When the item was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"003"}},"required":["id","created_at","updated_at","entity_type","entity_id","status","recommended_action","reviewed_by","languages","severity","ai_text_severity","bans","flags","actions","flags_count"],"type":"object"},"RingSettings":{"properties":{"auto_cancel_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_timeout_ms","missed_call_timeout_ms"],"type":"object"},"RingSettingsRequest":{"properties":{"auto_cancel_timeout_ms":{"description":"When none of the callees accept a ring call in this time a rejection will be sent by the caller with reason 'timeout' by the SDKs","format":"int32","maximum":180000,"minimum":5000,"title":"AutoCancelTimeoutMs","type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"description":"When a callee is online but doesn't answer a ring call in this time a rejection will be sent with reason 'timeout' by the SDKs","format":"int32","maximum":180000,"minimum":5000,"title":"IncomingCallTimeoutMs","type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"description":"When a callee doesn't accept or reject a ring call in this time a missed call event will be sent","format":"int32","maximum":180000,"minimum":5000,"title":"MissedCallTimeoutMs","type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_timeout_ms"],"title":"RingSettingsRequest","type":"object"},"RingSettingsResponse":{"properties":{"auto_cancel_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_timeout_ms","missed_call_timeout_ms"],"type":"object"},"RuleBuilderAction":{"properties":{"ban_options":{"$ref":"#/components/schemas/BanOptions","x-stream-index":"002"},"flag_content_options":{"$ref":"#/components/schemas/FlagContentOptions","x-stream-index":"004"},"flag_user_options":{"$ref":"#/components/schemas/FlagUserOptions","x-stream-index":"003"},"remove_content_options":{"$ref":"#/components/schemas/BlockContentOptions","x-stream-index":"005"},"type":{"type":"string","x-stream-index":"001"}},"type":"object"},"RuleBuilderCondition":{"properties":{"confidence":{"format":"float","type":"number","x-stream-index":"002"},"content_count_rule_params":{"$ref":"#/components/schemas/ContentCountRuleParameters","x-stream-index":"007"},"image_content_params":{"$ref":"#/components/schemas/ImageContentParameters","x-stream-index":"009"},"image_rule_params":{"$ref":"#/components/schemas/ImageRuleParameters","x-stream-index":"004"},"text_content_params":{"$ref":"#/components/schemas/TextContentParameters","x-stream-index":"008"},"text_rule_params":{"$ref":"#/components/schemas/TextRuleParameters","x-stream-index":"003"},"type":{"type":"string","x-stream-index":"001"},"user_created_within_params":{"$ref":"#/components/schemas/UserCreatedWithinParameters","x-stream-index":"011"},"user_custom_property_params":{"$ref":"#/components/schemas/UserCustomPropertyParameters","x-stream-index":"012"},"user_rule_params":{"$ref":"#/components/schemas/UserRuleParameters","x-stream-index":"006"},"video_content_params":{"$ref":"#/components/schemas/VideoContentParameters","x-stream-index":"010"},"video_rule_params":{"$ref":"#/components/schemas/VideoRuleParameters","x-stream-index":"005"}},"type":"object"},"RuleBuilderConditionGroup":{"properties":{"conditions":{"items":{"$ref":"#/components/schemas/RuleBuilderCondition"},"type":"array","x-stream-index":"002"},"logic":{"type":"string","x-stream-index":"001"}},"type":"object"},"RuleBuilderConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"rules":{"items":{"$ref":"#/components/schemas/RuleBuilderRule"},"type":"array","x-stream-index":"002"}},"type":"object"},"RuleBuilderRule":{"properties":{"action":{"$ref":"#/components/schemas/RuleBuilderAction","x-stream-index":"006"},"conditions":{"items":{"$ref":"#/components/schemas/RuleBuilderCondition"},"type":"array","x-stream-index":"003"},"cooldown_period":{"type":"string","x-stream-index":"007"},"groups":{"items":{"$ref":"#/components/schemas/RuleBuilderConditionGroup"},"type":"array","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"logic":{"type":"string","x-stream-index":"004"},"rule_type":{"type":"string","x-stream-index":"002"}},"required":["rule_type","action"],"type":"object"},"SDKUsageReport":{"properties":{"per_sdk_usage":{"additionalProperties":{"$ref":"#/components/schemas/PerSDKUsageReport"},"type":"object","x-stream-index":"001"}},"required":["per_sdk_usage"],"type":"object"},"SDKUsageReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateSDKUsageReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"SFUIDLastSeen":{"properties":{"id":{"type":"string","x-stream-index":"001.001"},"last_seen":{"format":"date-time","type":"number","x-stream-index":"002"},"process_start_time":{"format":"int64","type":"integer","x-stream-index":"001.002"}},"required":["id","process_start_time","last_seen"],"type":"object"},"SFUResponse":{"properties":{"edge_name":{"type":"string","x-stream-index":"001"},"url":{"type":"string","x-stream-index":"002"},"ws_endpoint":{"type":"string","x-stream-index":"003"}},"required":["edge_name","url","ws_endpoint"],"type":"object"},"STTEgressConfig":{"properties":{"closed_captions_enabled":{"type":"boolean","x-stream-index":"005"},"external_storage":{"$ref":"#/components/schemas/ExternalStorage","x-stream-index":"011"},"language":{"type":"string","x-stream-index":"008"},"storage_name":{"type":"string","x-stream-index":"010"},"translation_languages":{"items":{"type":"string"},"type":"array","x-stream-index":"009"},"translations_enabled":{"type":"boolean","x-stream-index":"006"},"upload_transcriptions":{"type":"boolean","x-stream-index":"004"},"whisper_server_base_url":{"type":"string","x-stream-index":"007"}},"type":"object"},"ScreensharingSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled"],"type":"object"},"ScreensharingSettingsRequest":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"type":"object"},"ScreensharingSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled"],"type":"object"},"SearchPayload":{"properties":{"filter_conditions":{"additionalProperties":{},"description":"Channel filter conditions","maximum":100,"minimum":1,"title":"Channel filter","type":"object","x-stream-docs-page-id":"query_channels","x-stream-index":"002"},"limit":{"description":"Number of messages to return","format":"int32","title":"Limit","type":"integer","x-stream-index":"005"},"message_filter_conditions":{"additionalProperties":{},"description":"Message filter conditions","title":"Message filter","type":"object","x-stream-index":"003"},"message_options":{"$ref":"#/components/schemas/MessageOptions","x-stream-index":"004"},"next":{"description":"Pagination parameter. Cannot be used with non-zero offset.","title":"Next","type":"string","x-stream-index":"008"},"offset":{"description":"Pagination offset. Cannot be used with sort or next.","format":"int32","title":"Offset","type":"integer","x-stream-index":"006"},"query":{"description":"Search phrase","title":"Query","type":"string","x-stream-index":"001"},"sort":{"description":"Sort parameters. Cannot be used with non-zero offset","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"007"}},"required":["filter_conditions"],"type":"object"},"SearchResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"005.001"},"next":{"description":"Value to pass to the next search query in order to paginate","title":"Next","type":"string","x-stream-index":"003"},"previous":{"description":"Value that points to the previous page. Pass as the next value in a search query to paginate backwards","title":"Previous","type":"string","x-stream-index":"004"},"results":{"description":"Search results","items":{"$ref":"#/components/schemas/SearchResult"},"title":"Results","type":"array","x-stream-index":"001"},"results_warning":{"$ref":"#/components/schemas/SearchWarning","description":"Warning about the search results","title":"Results Warning","x-stream-index":"002"}},"required":["results","duration"],"type":"object"},"SearchResult":{"properties":{"message":{"$ref":"#/components/schemas/SearchResultMessage","description":"Found message","title":"Message","x-stream-index":"001"}},"type":"object"},"SearchResultMessage":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"001.008"},"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel object","title":"Channel","x-stream-index":"002"},"cid":{"type":"string","x-stream-index":"001.022"},"command":{"type":"string","x-stream-index":"001.004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.023"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.026"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.025"},"deleted_for_me":{"type":"boolean","x-stream-index":"001.044"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"001.018"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001.041"},"html":{"type":"string","x-stream-index":"001.005"},"i18n":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.030"},"id":{"type":"string","x-stream-index":"001.001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"001.028"},"latest_reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"001.009"},"mentioned_users":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"001.029"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"001.036"},"mml":{"type":"string","x-stream-index":"001.003"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"001.039"},"own_reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"001.010"},"parent_id":{"type":"string","x-stream-index":"001.015"},"pin_expires":{"format":"date-time","type":"number","x-stream-index":"001.035"},"pinned":{"type":"boolean","x-stream-index":"001.032"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"001.033"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001.034"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001.038"},"poll_id":{"type":"string","x-stream-index":"001.037"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001.020"},"quoted_message_id":{"type":"string","x-stream-index":"001.019"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001.011"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"001.014"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001.012"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"001.042"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"001.017"},"restricted_visibility":{"items":{"type":"string"},"type":"array","x-stream-index":"001.040"},"shadowed":{"type":"boolean","x-stream-index":"001.027"},"shared_location":{"$ref":"#/components/schemas/SharedLocationResponseData","x-stream-index":"001.043"},"show_in_channel":{"type":"boolean","x-stream-index":"001.016"},"silent":{"type":"boolean","x-stream-index":"001.031"},"text":{"type":"string","x-stream-index":"001.002"},"thread_participants":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"001.021"},"type":{"type":"string","x-stream-index":"001.006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.024"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001.007"}},"required":["id","text","html","type","user","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned","restricted_visibility"],"type":"object"},"SearchWarning":{"properties":{"channel_search_cids":{"description":"Channel CIDs for the searched channels","items":{"type":"string"},"title":"Channel Search CIDs","type":"array","x-stream-index":"004"},"channel_search_count":{"description":"Number of channels searched","format":"int32","title":"Channel Search Count","type":"integer","x-stream-index":"003"},"warning_code":{"description":"Code corresponding to the warning","format":"int32","title":"Warning Code","type":"integer","x-stream-index":"002"},"warning_description":{"description":"Description of the warning","title":"Warning Description","type":"string","x-stream-index":"001"}},"required":["warning_description","warning_code"],"type":"object"},"SendCallEventRequest":{"description":"Send a call event to the other user","nullable":true,"properties":{"custom":{"additionalProperties":{},"title":"Custom","type":"object","x-stream-index":"004"}},"title":"SendCallEventRequest","type":"object"},"SendCallEventResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"SendCallEventResponse","type":"object"},"SendEventRequest":{"nullable":true,"properties":{"event":{"$ref":"#/components/schemas/EventRequest","x-stream-index":"001"}},"required":["event"],"type":"object"},"SendMessageRequest":{"nullable":true,"properties":{"keep_channel_hidden":{"type":"boolean","x-stream-index":"008"},"message":{"$ref":"#/components/schemas/MessageRequest","x-stream-index":"001"},"skip_enrich_url":{"type":"boolean","x-stream-index":"003"},"skip_push":{"type":"boolean","x-stream-index":"002"}},"required":["message"],"type":"object"},"SendMessageResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Message response","title":"Message","x-stream-index":"001"},"pending_message_metadata":{"additionalProperties":{"type":"string"},"description":"Pending message metadata","title":"Pending message metadata","type":"object","x-stream-index":"002"}},"required":["message","duration"],"type":"object"},"SendReactionRequest":{"nullable":true,"properties":{"enforce_unique":{"description":"Whether to replace all existing user reactions","title":"Enforce unique","type":"boolean","x-stream-index":"003"},"reaction":{"$ref":"#/components/schemas/ReactionRequest","x-stream-index":"002"},"skip_push":{"description":"Skips any mobile push notifications","title":"Skip push","type":"boolean","x-stream-index":"004"}},"required":["reaction"],"type":"object"},"SendReactionResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001"},"reaction":{"$ref":"#/components/schemas/ReactionResponse","x-stream-index":"002"}},"required":["message","reaction","duration"],"title":"Response","type":"object"},"SessionSettings":{"properties":{"inactivity_timeout_seconds":{"format":"int32","maximum":900,"minimum":5,"type":"integer","x-stream-index":"001"}},"required":["inactivity_timeout_seconds"],"type":"object"},"SessionSettingsRequest":{"properties":{"inactivity_timeout_seconds":{"format":"int32","maximum":900,"minimum":5,"type":"integer","x-stream-index":"001"}},"required":["inactivity_timeout_seconds"],"type":"object"},"SessionSettingsResponse":{"properties":{"inactivity_timeout_seconds":{"format":"int32","maximum":900,"minimum":5,"type":"integer","x-stream-index":"001"}},"required":["inactivity_timeout_seconds"],"type":"object"},"ShadowBlockActionRequest":{"type":"object"},"SharedLocation":{"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"013"},"channel_cid":{"type":"string","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"010"},"created_by_device_id":{"type":"string","x-stream-index":"008"},"end_at":{"format":"date-time","type":"number","x-stream-index":"009"},"latitude":{"format":"float","maximum":90,"minimum":18446744073709552000,"type":"number","x-stream-index":"006"},"longitude":{"format":"float","maximum":180,"minimum":18446744073709552000,"type":"number","x-stream-index":"007"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"012"},"message_id":{"type":"string","x-stream-index":"004"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"011"},"user_id":{"type":"string","x-stream-index":"005"}},"required":["channel_cid","message_id","user_id","created_by_device_id","created_at","updated_at"],"type":"object"},"SharedLocationResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001.011"},"channel_cid":{"description":"Channel CID","title":"string","type":"string","x-stream-index":"001.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.008"},"created_by_device_id":{"description":"Device ID that created the live location","title":"string","type":"string","x-stream-index":"001.006"},"duration":{"type":"string","x-stream-index":"002.001"},"end_at":{"description":"Time when the live location expires","format":"date-time","title":"string","type":"number","x-stream-index":"001.007"},"latitude":{"description":"Latitude coordinate","format":"float","title":"number","type":"number","x-stream-index":"001.004"},"longitude":{"description":"Longitude coordinate","format":"float","title":"number","type":"number","x-stream-index":"001.005"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001.010"},"message_id":{"description":"Message ID","title":"string","type":"string","x-stream-index":"001.002"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.009"},"user_id":{"description":"User ID","title":"string","type":"string","x-stream-index":"001.003"}},"required":["channel_cid","message_id","user_id","latitude","longitude","created_by_device_id","created_at","updated_at","duration"],"type":"object"},"SharedLocationResponseData":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"011"},"channel_cid":{"type":"string","x-stream-index":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"created_by_device_id":{"type":"string","x-stream-index":"006"},"end_at":{"format":"date-time","type":"number","x-stream-index":"007"},"latitude":{"format":"float","type":"number","x-stream-index":"004"},"longitude":{"format":"float","type":"number","x-stream-index":"005"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"010"},"message_id":{"type":"string","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["channel_cid","message_id","user_id","latitude","longitude","created_by_device_id","created_at","updated_at"],"type":"object"},"SharedLocationsResponse":{"nullable":true,"properties":{"active_live_locations":{"items":{"$ref":"#/components/schemas/SharedLocationResponseData"},"type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["active_live_locations","duration"],"type":"object"},"ShowChannelRequest":{"nullable":true,"type":"object"},"ShowChannelResponse":{"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"},"SingleFollowResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"follow":{"$ref":"#/components/schemas/FollowResponse","description":"The created follow relationship","title":"Follow","x-stream-index":"001"}},"required":["follow","duration"],"title":"Follow Response","type":"object"},"SortParam":{"nullable":true,"properties":{"direction":{"format":"int32","type":"integer","x-stream-index":"002"},"field":{"type":"string","x-stream-index":"001"}},"required":["field","direction"],"type":"object"},"SortParamRequest":{"nullable":true,"properties":{"direction":{"description":"Direction of sorting, 1 for Ascending, -1 for Descending, default is 1","format":"int32","title":"Direction","type":"integer","x-stream-index":"002"},"field":{"description":"Name of field to sort by","title":"Field","type":"string","x-stream-index":"001"}},"type":"object"},"StartClosedCaptionsRequest":{"nullable":true,"properties":{"enable_transcription":{"description":"Enable transcriptions along with closed captions","title":"Enable Transcription","type":"boolean","x-stream-index":"002"},"external_storage":{"description":"Which external storage to use for transcriptions (only applicable if enable_transcription is true)","title":"External Storage","type":"string","x-stream-index":"003"},"language":{"description":"The spoken language in the call, if not provided the language defined in the transcription settings will be used","enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"title":"Language","type":"string","x-stream-index":"004"}},"type":"object"},"StartClosedCaptionsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"StartFrameRecordingRequest":{"nullable":true,"properties":{"recording_external_storage":{"type":"string","x-stream-index":"002"}},"title":"StartFrameRecordingRequest","type":"object"},"StartFrameRecordingResponse":{"description":"StartFrameRecordingResponse is the response payload for the start frame recording endpoint.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StartFrameRecordingResponse","type":"object"},"StartHLSBroadcastingRequest":{"description":"StartHLSBroadcastingRequest is the payload for starting an HLS broadcasting.","nullable":true,"title":"StartHLSBroadcastingRequest","type":"object"},"StartHLSBroadcastingResponse":{"description":"StartHLSBroadcastingResponse is the payload for starting an HLS broadcasting.","nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"},"playlist_url":{"description":"the URL of the HLS playlist","title":"PlaylistURL","type":"string","x-stream-index":"002"}},"required":["duration","playlist_url"],"title":"StartHLSBroadcastingResponse","type":"object"},"StartRTMPBroadcastsRequest":{"description":"StartRTMPBroadcastsRequest is the payload for starting RTMP broadcasts.","nullable":true,"properties":{"broadcasts":{"description":"List of broadcasts to start","items":{"$ref":"#/components/schemas/RTMPBroadcastRequest"},"maximum":1,"minimum":1,"title":"Broadcasts","type":"array","x-stream-index":"002"}},"required":["broadcasts"],"title":"StartRTMPBroadcastsRequest","type":"object"},"StartRTMPBroadcastsResponse":{"description":"StartRTMPBroadcastsResponse is the payload for starting an RTMP broadcast.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StartRTMPBroadcastsResponse","type":"object"},"StartRecordingRequest":{"nullable":true,"properties":{"recording_external_storage":{"type":"string","x-stream-index":"002"}},"title":"StartRecordingRequest","type":"object"},"StartRecordingResponse":{"description":"StartRecordingResponse is the response payload for the start recording endpoint.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StartRecordingResponse","type":"object"},"StartTranscriptionRequest":{"nullable":true,"properties":{"enable_closed_captions":{"description":"Enable closed captions along with transcriptions","title":"Enable Closed Captions","type":"boolean","x-stream-index":"003"},"language":{"description":"The spoken language in the call, if not provided the language defined in the transcription settings will be used","enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"title":"Language","type":"string","x-stream-index":"004"},"transcription_external_storage":{"description":"Store transcriptions in this external storage","title":"External Storage","type":"string","x-stream-index":"002"}},"type":"object"},"StartTranscriptionResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StartTranscriptionResponse","type":"object"},"StatsOptions":{"properties":{"enable_rtc_stats":{"type":"boolean","x-stream-index":"002"},"reporting_interval_ms":{"format":"int32","type":"integer","x-stream-index":"001"}},"required":["reporting_interval_ms","enable_rtc_stats"],"type":"object"},"StopAllRTMPBroadcastsRequest":{"nullable":true,"title":"StopAllRTMPBroadcastsRequest","type":"object"},"StopAllRTMPBroadcastsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StopAllRTMPBroadcastsResponse","type":"object"},"StopClosedCaptionsRequest":{"nullable":true,"properties":{"stop_transcription":{"type":"boolean","x-stream-index":"003"}},"type":"object"},"StopClosedCaptionsResponse":{"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"},"StopFrameRecordingRequest":{"nullable":true,"type":"object"},"StopFrameRecordingResponse":{"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"},"StopHLSBroadcastingRequest":{"nullable":true,"type":"object"},"StopHLSBroadcastingResponse":{"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"},"StopLiveRequest":{"nullable":true,"properties":{"continue_closed_caption":{"type":"boolean","x-stream-index":"006"},"continue_hls":{"type":"boolean","x-stream-index":"003"},"continue_recording":{"type":"boolean","x-stream-index":"004"},"continue_rtmp_broadcasts":{"type":"boolean","x-stream-index":"007"},"continue_transcription":{"type":"boolean","x-stream-index":"005"}},"title":"StopLiveRequest","type":"object"},"StopLiveResponse":{"nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"The call that was stopped","title":"Call","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["call","duration"],"title":"StopLiveResponse","type":"object"},"StopRTMPBroadcastsRequest":{"description":"Request for stopping RTMP broadcasts","nullable":true,"title":"StopRTMPBroadcastsRequest","type":"object"},"StopRTMPBroadcastsResponse":{"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"},"StopRecordingRequest":{"nullable":true,"type":"object"},"StopRecordingResponse":{"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"},"StopTranscriptionRequest":{"nullable":true,"properties":{"stop_closed_captions":{"type":"boolean","x-stream-index":"003"}},"type":"object"},"StopTranscriptionResponse":{"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"},"StoriesConfig":{"properties":{"expiration_behaviour":{"enum":["hide_for_everyone","visible_for_author"],"type":"string","x-stream-index":"001"},"skip_watched":{"type":"boolean","x-stream-index":"002"}},"type":"object"},"SubmitActionRequest":{"nullable":true,"properties":{"action_type":{"description":"Type of moderation action to perform (mark_reviewed, delete_message, etc.)","enum":["mark_reviewed","delete_message","delete_activity","delete_reaction","ban","custom","unban","restore","delete_user","unblock","shadow_block","unmask","kick_user","end_call"],"title":"Action Type","type":"string","x-stream-index":"002"},"ban":{"$ref":"#/components/schemas/BanActionRequest","description":"Configuration for ban action","title":"Ban","x-stream-index":"008"},"custom":{"$ref":"#/components/schemas/CustomActionRequest","description":"Configuration for custom action","title":"Custom","x-stream-index":"009"},"delete_activity":{"$ref":"#/components/schemas/DeleteActivityRequest","description":"Configuration for activity deletion action","title":"Delete Activity","x-stream-index":"004"},"delete_message":{"$ref":"#/components/schemas/DeleteMessageRequest","description":"Configuration for message deletion action","title":"Delete Message","x-stream-index":"003"},"delete_reaction":{"$ref":"#/components/schemas/DeleteReactionRequest","description":"Configuration for reaction deletion action","title":"Delete Reaction","x-stream-index":"005"},"delete_user":{"$ref":"#/components/schemas/DeleteUserRequest","description":"Configuration for user deletion action","title":"Delete User","x-stream-index":"006"},"item_id":{"description":"UUID of the review queue item to act on","title":"Item ID","type":"string","x-stream-index":"001"},"mark_reviewed":{"$ref":"#/components/schemas/MarkReviewedRequest","description":"Configuration for marking item as reviewed","title":"Mark Reviewed","x-stream-index":"007"},"unban":{"$ref":"#/components/schemas/UnbanActionRequest","description":"Configuration for unban action","title":"Unban","x-stream-index":"010"}},"required":["item_id","action_type"],"type":"object"},"SubmitActionResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"Updated review queue item after action was performed","title":"Item","x-stream-index":"001"}},"required":["duration"],"type":"object"},"SubscriberStatsResponse":{"properties":{"total":{"format":"int32","type":"integer","x-stream-index":"001"},"total_subscribed_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"003"},"unique":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["total","unique","total_subscribed_duration_seconds"],"type":"object"},"SyncRequest":{"description":"Sync request","nullable":true,"properties":{"channel_cids":{"description":"List of channel CIDs to sync","items":{"type":"string"},"maximum":255,"minimum":1,"title":"Channel CIDs","type":"array","x-stream-index":"001"},"last_sync_at":{"description":"Date from which synchronization should happen","format":"date-time","title":"Last sync at","type":"number","x-stream-index":"002"}},"required":["channel_cids","last_sync_at"],"title":"SyncRequest","type":"object"},"SyncResponse":{"description":"Sync response","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"events":{"description":"List of events","items":{"$ref":"#/components/schemas/WSEvent"},"title":"Events","type":"array","x-stream-index":"001"},"inaccessible_cids":{"description":"List of CIDs that user can't access","items":{"type":"string"},"title":"Inaccessible CIDs","type":"array","x-stream-index":"002"}},"required":["events","duration"],"title":"SyncResponse","type":"object"},"TargetResolution":{"properties":{"bitrate":{"format":"int32","maximum":6000000,"type":"integer","x-stream-index":"003"},"height":{"format":"int32","maximum":3840,"minimum":240,"type":"integer","x-stream-index":"002"},"width":{"format":"int32","maximum":3840,"minimum":240,"type":"integer","x-stream-index":"001"}},"required":["width","height"],"type":"object"},"TextContentParameters":{"properties":{"blocklist_match":{"items":{"type":"string"},"type":"array","x-stream-index":"005"},"contains_url":{"type":"boolean","x-stream-index":"003"},"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001"},"llm_harm_labels":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"002"},"severity":{"type":"string","x-stream-index":"004"}},"type":"object"},"TextRuleParameters":{"properties":{"blocklist_match":{"items":{"type":"string"},"type":"array","x-stream-index":"007"},"contains_url":{"type":"boolean","x-stream-index":"005"},"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"llm_harm_labels":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"004"},"severity":{"type":"string","x-stream-index":"006"},"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"type":"object"},"ThreadParticipant":{"description":"Represents a user that is participating in a thread.","nullable":true,"properties":{"app_pk":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"001"},"channel_cid":{"type":"string","x-stream-index":"002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"007"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"last_read_at":{"format":"date-time","type":"number","x-stream-index":"009"},"last_thread_message_at":{"format":"date-time","type":"number","x-stream-index":"003"},"left_thread_at":{"description":"Left Thread At is the time when the user left the thread","format":"date-time","title":"Left Thread At","type":"number","x-stream-index":"008"},"thread_id":{"description":"Thead ID is unique string identifier of the thread","title":"ID","type":"string","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User is the user object","title":"User","x-stream-index":"006"},"user_id":{"description":"User ID is unique string identifier of the user","title":"User ID","type":"string","x-stream-index":"005"}},"required":["app_pk","channel_cid","created_at","last_read_at","custom"],"title":"ThreadParticipant","type":"object"},"ThreadResponse":{"properties":{"active_participant_count":{"description":"Active Participant Count","format":"int32","title":"Active Participant Count","type":"integer","x-stream-index":"009"},"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel","title":"ChannelResponse","x-stream-index":"002"},"channel_cid":{"description":"Channel CID","title":"Channel CID","type":"string","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"012"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"Created By User","title":"User","x-stream-index":"006"},"created_by_user_id":{"description":"Created By User ID","title":"Created By User ID","type":"string","x-stream-index":"005"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"016"},"deleted_at":{"description":"Deleted At","format":"date-time","title":"Deleted At","type":"number","x-stream-index":"014"},"last_message_at":{"description":"Last Message At","format":"date-time","title":"Last Message At","type":"number","x-stream-index":"011"},"parent_message":{"$ref":"#/components/schemas/MessageResponse","description":"Parent Message","title":"Message","x-stream-index":"004"},"parent_message_id":{"description":"Parent Message ID","title":"Parent Message ID","type":"string","x-stream-index":"003"},"participant_count":{"description":"Participant Count","format":"int32","title":"Participant Count","type":"integer","x-stream-index":"008"},"reply_count":{"description":"Reply Count","format":"int32","title":"Reply Count","type":"integer","x-stream-index":"007"},"thread_participants":{"description":"Thread Participants","items":{"$ref":"#/components/schemas/ThreadParticipant"},"title":"ThreadParticipants","type":"array","x-stream-index":"010"},"title":{"description":"Title","title":"Title","type":"string","x-stream-index":"015"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"013"}},"required":["channel_cid","parent_message_id","created_by_user_id","created_at","updated_at","title","custom"],"type":"object"},"ThreadStateResponse":{"nullable":true,"properties":{"active_participant_count":{"description":"Active Participant Count","format":"int32","title":"Active Participant Count","type":"integer","x-stream-index":"001.009"},"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel","title":"ChannelResponse","x-stream-index":"001.002"},"channel_cid":{"description":"Channel CID","title":"Channel CID","type":"string","x-stream-index":"001.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.012"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"Created By User","title":"User","x-stream-index":"001.006"},"created_by_user_id":{"description":"Created By User ID","title":"Created By User ID","type":"string","x-stream-index":"001.005"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"001.016"},"deleted_at":{"description":"Deleted At","format":"date-time","title":"Deleted At","type":"number","x-stream-index":"001.014"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"004"},"last_message_at":{"description":"Last Message At","format":"date-time","title":"Last Message At","type":"number","x-stream-index":"001.011"},"latest_replies":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","x-stream-index":"002"},"parent_message":{"$ref":"#/components/schemas/MessageResponse","description":"Parent Message","title":"Message","x-stream-index":"001.004"},"parent_message_id":{"description":"Parent Message ID","title":"Parent Message ID","type":"string","x-stream-index":"001.003"},"participant_count":{"description":"Participant Count","format":"int32","title":"Participant Count","type":"integer","x-stream-index":"001.008"},"read":{"items":{"$ref":"#/components/schemas/ReadStateResponse"},"type":"array","x-stream-index":"003"},"reply_count":{"description":"Reply Count","format":"int32","title":"Reply Count","type":"integer","x-stream-index":"001.007"},"thread_participants":{"description":"Thread Participants","items":{"$ref":"#/components/schemas/ThreadParticipant"},"title":"ThreadParticipants","type":"array","x-stream-index":"001.010"},"title":{"description":"Title","title":"Title","type":"string","x-stream-index":"001.015"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.013"}},"required":["channel_cid","parent_message_id","created_by_user_id","created_at","updated_at","title","custom","latest_replies"],"type":"object"},"ThreadUpdatedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"001.002"},"channel_type":{"type":"string","x-stream-index":"001.003"},"cid":{"type":"string","x-stream-index":"001.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"thread":{"$ref":"#/components/schemas/ThreadResponse","x-stream-index":"003.001"},"type":{"default":"thread.updated","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"ThreadUpdatedEvent","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"},"ThreadedCommentResponse":{"description":"A comment with an optional, depth‑limited slice of nested replies.","properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"001.011"},"confidence_score":{"format":"float","type":"number","x-stream-index":"001.022"},"controversy_score":{"format":"float","type":"number","x-stream-index":"001.023"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.014"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.006"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.016"},"downvote_count":{"format":"int32","type":"integer","x-stream-index":"001.020"},"id":{"type":"string","x-stream-index":"001.001"},"latest_reactions":{"items":{"$ref":"#/components/schemas/FeedsReactionResponse"},"type":"array","x-stream-index":"001.009"},"mentioned_users":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"001.012"},"meta":{"$ref":"#/components/schemas/RepliesMeta","description":"Pagination \u0026 depth info for this node's direct replies.","title":"Replies Meta","x-stream-index":"002"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"001.017"},"object_id":{"type":"string","x-stream-index":"001.002"},"object_type":{"type":"string","x-stream-index":"001.003"},"own_reactions":{"items":{"$ref":"#/components/schemas/FeedsReactionResponse"},"type":"array","x-stream-index":"001.024"},"parent_id":{"type":"string","x-stream-index":"001.007"},"reaction_count":{"format":"int32","type":"integer","x-stream-index":"001.008"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"001.010"},"replies":{"description":"Slice of nested comments (may be empty).","items":{"$ref":"#/components/schemas/ThreadedCommentResponse"},"title":"Replies","type":"array","x-stream-index":"003"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"001.018"},"score":{"format":"int32","type":"integer","x-stream-index":"001.021"},"status":{"type":"string","x-stream-index":"001.013"},"text":{"type":"string","x-stream-index":"001.005"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.015"},"upvote_count":{"format":"int32","type":"integer","x-stream-index":"001.019"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001.004"}},"required":["id","object_id","object_type","user","reaction_count","mentioned_users","status","created_at","updated_at","reply_count","upvote_count","downvote_count","score","confidence_score","own_reactions"],"title":"Threaded Comment","type":"object"},"Thresholds":{"description":"Sets thresholds for AI moderation","properties":{"explicit":{"$ref":"#/components/schemas/LabelThresholds","description":"Thresholds for explicit messages","title":"LabelThresholds","x-stream-index":"001"},"spam":{"$ref":"#/components/schemas/LabelThresholds","description":"Thresholds for spam","title":"LabelThresholds","x-stream-index":"002"},"toxic":{"$ref":"#/components/schemas/LabelThresholds","description":"Thresholds for toxic messages","title":"LabelThresholds","x-stream-index":"003"}},"title":"Auto moderation thresholds","type":"object"},"ThumbnailResponse":{"properties":{"image_url":{"type":"string","x-stream-index":"001"}},"required":["image_url"],"type":"object"},"ThumbnailsSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"ThumbnailsSettingsRequest":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"ThumbnailsSettingsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"Time":{"type":"object"},"TrackStatsResponse":{"nullable":true,"properties":{"duration_seconds":{"format":"int32","type":"integer","x-stream-index":"002"},"track_type":{"type":"string","x-stream-index":"001"}},"required":["track_type","duration_seconds"],"type":"object"},"TranscriptionSettings":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"title":"Mode","type":"string","x-stream-index":"002"},"language":{"description":"The language used in this call as a two letter code","enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"title":"Language","type":"string","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"title":"Mode","type":"string","x-stream-index":"001"}},"required":["mode","closed_caption_mode","languages","language"],"type":"object"},"TranscriptionSettingsRequest":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"002"},"language":{"enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"type":"string","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode"],"type":"object"},"TranscriptionSettingsResponse":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"002"},"language":{"enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"type":"string","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode","closed_caption_mode","languages","language"],"type":"object"},"TranslateMessageRequest":{"nullable":true,"properties":{"language":{"description":"Language to translate message to","enum":["af","sq","am","ar","az","bn","bs","bg","zh","zh-TW","hr","cs","da","fa-AF","nl","en","et","fi","fr","fr-CA","ka","de","el","ha","he","hi","hu","id","it","ja","ko","lv","ms","no","fa","ps","pl","pt","ro","ru","sr","sk","sl","so","es","es-MX","sw","sv","tl","ta","th","tr","uk","ur","vi","lt","ht"],"title":"Language","type":"string","x-stream-index":"001"}},"required":["language"],"type":"object"},"TruncateChannelRequest":{"nullable":true,"properties":{"hard_delete":{"description":"Permanently delete channel data (messages, reactions, etc.)","title":"Hard delete","type":"boolean","x-stream-index":"002"},"member_ids":{"description":"List of member IDs to hide message history for. If empty, truncates the channel for all members","items":{"type":"string"},"maximum":100,"title":"Member IDs","type":"array","x-stream-index":"007"},"message":{"$ref":"#/components/schemas/MessageRequest","x-stream-index":"004"},"skip_push":{"description":"When `message` is set disables all push notifications for it","title":"Skip push","type":"boolean","x-stream-index":"005"},"truncated_at":{"description":"Truncate channel data up to `truncated_at`. The system message (if provided) creation time is always greater than `truncated_at`","format":"date-time","title":"Truncated at","type":"number","x-stream-index":"006"}},"type":"object"},"TruncateChannelResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Truncated channel object","title":"Channel","x-stream-index":"002"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Truncated message object","title":"Message","x-stream-index":"003"}},"required":["duration"],"type":"object"},"TypingIndicators":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"TypingIndicatorsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"TypingStartEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"parent_id":{"type":"string","x-stream-index":"001"},"type":{"default":"typing.start","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"TypingStartEvent","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"},"TypingStopEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"parent_id":{"type":"string","x-stream-index":"001"},"type":{"default":"typing.stop","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"TypingStopEvent","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"},"UnbanActionRequest":{"type":"object"},"UnblockActionRequest":{"type":"object"},"UnblockUserRequest":{"description":"UnblockUserRequest is the payload for unblocking a user.","nullable":true,"properties":{"user_id":{"description":"the user to unblock","title":"UserID","type":"string","x-stream-index":"003"}},"required":["user_id"],"title":"UnblockUserRequest","type":"object"},"UnblockUserResponse":{"description":"UnblockUserResponse is the payload for unblocking a user.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"UnblockUserResponse","type":"object"},"UnblockUsersRequest":{"nullable":true,"properties":{"blocked_user_id":{"type":"string","x-stream-index":"001"}},"required":["blocked_user_id"],"type":"object"},"UnblockUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"UnblockedUserEvent":{"description":"This event is sent when a user is unblocked on a call,\nthis can be useful to notify the user that they can now join the call again","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.unblocked_user","description":"The type of event: \"call.unblocked_user\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user that was unblocked","title":"User","x-stream-index":"003"}},"required":["type","created_at","call_cid","user"],"title":"UnblockedUserEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"UnfollowResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"follow":{"$ref":"#/components/schemas/FollowResponse","description":"The deleted follow relationship","title":"Follow","x-stream-index":"001"}},"required":["follow","duration"],"title":"Unfollow Response","type":"object"},"UnmuteChannelRequest":{"nullable":true,"properties":{"channel_cids":{"description":"Channel CIDs to mute (if multiple channels)","items":{"type":"string"},"maximum":25,"title":"Channel CIDs","type":"array","x-stream-index":"001.002"},"expiration":{"description":"Duration of mute in milliseconds","title":"Expiration","type":"integer","x-stream-index":"001.003"}},"type":"object"},"UnmuteResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"non_existing_users":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"required":["duration"],"title":"Response","type":"object"},"UnpinActivityResponse":{"nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","description":"The unpinned activity","title":"Activity","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"004.001"},"feed":{"description":"Fully qualified ID of the feed the activity was unpinned from","title":"Feed ID","type":"string","x-stream-index":"002"},"user_id":{"description":"ID of the user who unpinned the activity","title":"User ID","type":"string","x-stream-index":"003"}},"required":["activity","feed","user_id","duration"],"title":"Unpin Activity Response","type":"object"},"UnpinRequest":{"description":"UnpinRequest is the payload for unpinning a message.","nullable":true,"properties":{"session_id":{"description":"the session ID of the user who pinned the message","title":"SessionID","type":"string","x-stream-index":"003"},"user_id":{"description":"the user ID of the user who pinned the message","title":"UserID","type":"string","x-stream-index":"002"}},"required":["user_id","session_id"],"title":"UnpinRequest","type":"object"},"UnpinResponse":{"description":"UnpinResponse is the payload for unpinning a message.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"UnpinResponse","type":"object"},"UnreadCountsChannel":{"properties":{"channel_id":{"type":"string","x-stream-index":"001"},"last_read":{"format":"date-time","type":"number","x-stream-index":"003"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["channel_id","unread_count","last_read"],"type":"object"},"UnreadCountsChannelType":{"properties":{"channel_count":{"format":"int32","type":"integer","x-stream-index":"002"},"channel_type":{"type":"string","x-stream-index":"001"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["channel_type","channel_count","unread_count"],"type":"object"},"UnreadCountsThread":{"properties":{"last_read":{"format":"date-time","type":"number","x-stream-index":"002"},"last_read_message_id":{"type":"string","x-stream-index":"003"},"parent_message_id":{"type":"string","x-stream-index":"004"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"001"}},"required":["unread_count","last_read","last_read_message_id","parent_message_id"],"type":"object"},"UpdateActivityPartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"description":"Map of dot-notation field paths to new values","title":"object","type":"object","x-stream-index":"002"},"unset":{"description":"List of dot-notation paths to remove","items":{"type":"string"},"title":"[]string","type":"array","x-stream-index":"003"}},"type":"object"},"UpdateActivityPartialResponse":{"nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","description":"The updated activity","title":"ActivityResponse","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["activity","duration"],"type":"object"},"UpdateActivityRequest":{"nullable":true,"properties":{"attachments":{"description":"List of attachments for the activity","items":{"$ref":"#/components/schemas/Attachment"},"title":"[]ActivityAttachment","type":"array","x-stream-index":"003"},"custom":{"additionalProperties":{},"description":"Custom data for the activity","title":"object","type":"object","x-stream-index":"004"},"expires_at":{"description":"Time when the activity will expire","format":"date-time","title":"string","type":"number","x-stream-index":"007"},"filter_tags":{"description":"Tags used for filtering the activity","items":{"type":"string"},"title":"[]string","type":"array","x-stream-index":"008"},"interest_tags":{"description":"Tags indicating interest categories","items":{"type":"string"},"title":"[]string","type":"array","x-stream-index":"009"},"location":{"$ref":"#/components/schemas/ActivityLocation","description":"Geographic location for the activity","title":"ActivityLocation","x-stream-index":"006"},"poll_id":{"description":"Poll ID","title":"string","type":"string","x-stream-index":"010"},"text":{"description":"The text content of the activity","title":"string","type":"string","x-stream-index":"002"},"visibility":{"description":"Visibility setting for the activity","title":"string","type":"string","x-stream-index":"005"}},"type":"object"},"UpdateActivityResponse":{"nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","description":"The updated activity","title":"ActivityResponse","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["activity","duration"],"type":"object"},"UpdateBlockListRequest":{"nullable":true,"properties":{"team":{"type":"string","x-stream-index":"002"},"words":{"description":"List of words to block","items":{"type":"string"},"minimum":1,"title":"Words","type":"array","x-stream-index":"003"}},"title":"Update block list","type":"object","x-stream-docs-page-id":"update_block_list"},"UpdateBlockListResponse":{"description":"Basic response information","nullable":true,"properties":{"blocklist":{"$ref":"#/components/schemas/BlockListResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["duration"],"title":"Response","type":"object"},"UpdateBookmarkFolderRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"description":"Custom data for the folder","title":"Custom Data","type":"object","x-stream-index":"003"},"name":{"description":"Name of the folder","maxLength":255,"title":"Name","type":"string","x-stream-index":"002"}},"title":"Update Bookmark Folder Request","type":"object"},"UpdateBookmarkFolderResponse":{"nullable":true,"properties":{"bookmark_folder":{"$ref":"#/components/schemas/BookmarkFolderResponse","description":"The updated bookmark folder","title":"Bookmark Folder","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["bookmark_folder","duration"],"title":"Update Bookmark Folder Response","type":"object"},"UpdateBookmarkRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"description":"Custom data for the bookmark","title":"Custom Data","type":"object","x-stream-index":"005"},"folder_id":{"description":"ID of the folder to move the bookmark to","maxLength":255,"title":"Folder ID","type":"string","x-stream-index":"002"},"new_folder":{"$ref":"#/components/schemas/AddFolderRequest","x-stream-index":"004"},"new_folder_id":{"maxLength":255,"type":"string","x-stream-index":"003"}},"title":"Update Bookmark Request","type":"object"},"UpdateBookmarkResponse":{"nullable":true,"properties":{"bookmark":{"$ref":"#/components/schemas/BookmarkResponse","description":"The updated bookmark","title":"Bookmark","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["bookmark","duration"],"title":"Update Bookmark Response","type":"object"},"UpdateCallMembersRequest":{"description":"Update call members","nullable":true,"properties":{"remove_members":{"description":"List of userID to remove","items":{"type":"string"},"maximum":100,"title":"Remove Members","type":"array","x-stream-index":"003"},"update_members":{"description":"List of members to update or insert","items":{"$ref":"#/components/schemas/MemberRequest"},"maximum":100,"title":"Update Members","type":"array","x-stream-index":"004"}},"title":"UpdateCallMembersRequest","type":"object"},"UpdateCallMembersResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"002"}},"required":["duration","members"],"title":"Response","type":"object"},"UpdateCallRequest":{"description":"Request for updating a call","nullable":true,"properties":{"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"003"},"settings_override":{"$ref":"#/components/schemas/CallSettingsRequest","description":"the settings to change for this call","title":"Settings Override","x-stream-index":"004"},"starts_at":{"description":"the time the call is scheduled to start","format":"date-time","title":"Starts At","type":"number","x-stream-index":"005"}},"title":"UpdateCallRequest","type":"object"},"UpdateCallResponse":{"description":"Response for updating a call","nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001.001"},"duration":{"type":"string","x-stream-index":"002.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001.002"},"membership":{"$ref":"#/components/schemas/MemberResponse","x-stream-index":"001.003"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"001.004"}},"required":["call","members","own_capabilities","blocked_users","duration"],"title":"UpdateCallResponse","type":"object"},"UpdateChannelPartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"type":"object","x-stream-index":"002.001"},"unset":{"items":{"type":"string"},"type":"array","x-stream-index":"002.002"}},"title":"UpdateChannelPartialRequest","type":"object"},"UpdateChannelPartialResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Updated channel object","title":"Channel","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"members":{"description":"List of updated members","items":{"$ref":"#/components/schemas/ChannelMemberResponse"},"title":"ChannelMemberResponse","type":"array","x-stream-index":"002"}},"required":["members","duration"],"type":"object"},"UpdateChannelRequest":{"nullable":true,"properties":{"accept_invite":{"description":"Set to `true` to accept the invite","title":"Accept invite","type":"boolean","x-stream-index":"008"},"add_members":{"description":"List of user IDs to add to the channel","items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"title":"Add members","type":"array","x-stream-index":"001"},"add_moderators":{"description":"List of user IDs to make channel moderators","items":{"type":"string"},"maximum":100,"title":"Add moderators","type":"array","x-stream-index":"003"},"assign_roles":{"description":"List of channel member role assignments. If any specified user is not part of the channel, the request will fail","items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"title":"Assign roles","type":"array","x-stream-index":"006"},"cooldown":{"description":"Sets cool down period for the channel in seconds","format":"int32","maximum":120,"minimum":0,"title":"Cool down","type":"integer","x-stream-index":"007"},"data":{"$ref":"#/components/schemas/ChannelInput","x-stream-index":"013.001"},"demote_moderators":{"description":"List of user IDs to take away moderators status from","items":{"type":"string"},"maximum":100,"title":"Demote moderators","type":"array","x-stream-index":"004"},"hide_history":{"description":"Set to `true` to hide channel's history when adding new members","title":"Hide history","type":"boolean","x-stream-index":"012"},"invites":{"description":"List of user IDs to invite to the channel","items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"title":"Invites","type":"array","x-stream-index":"005"},"message":{"$ref":"#/components/schemas/MessageRequest","description":"Message to send to the chat when channel is successfully updated","title":"Message","x-stream-index":"010"},"reject_invite":{"description":"Set to `true` to reject the invite","title":"Reject invite","type":"boolean","x-stream-index":"009"},"remove_members":{"description":"List of user IDs to remove from the channel","items":{"type":"string"},"maximum":100,"title":"Remove members","type":"array","x-stream-index":"002"},"skip_push":{"description":"When `message` is set disables all push notifications for it","title":"Skip push","type":"boolean","x-stream-index":"011"}},"title":"Channel update request","type":"object","x-stream-docs-page-id":"channel_update"},"UpdateChannelResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Updated channel","title":"Channel","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"004.001"},"members":{"description":"List of channel members","items":{"$ref":"#/components/schemas/ChannelMember"},"title":"Members","type":"array","x-stream-index":"003"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Message sent to the chat","title":"Message","x-stream-index":"002"}},"required":["members","duration"],"type":"object"},"UpdateCommentRequest":{"nullable":true,"properties":{"comment":{"description":"Updated text content of the comment","title":"Comment","type":"string","x-stream-index":"002"},"custom":{"additionalProperties":{},"description":"Updated custom data for the comment","title":"Custom Data","type":"object","x-stream-index":"003"},"skip_push":{"type":"boolean","x-stream-index":"004"}},"title":"Update Comment Request","type":"object"},"UpdateCommentResponse":{"nullable":true,"properties":{"comment":{"$ref":"#/components/schemas/CommentResponse","description":"The updated comment","title":"Comment","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["comment","duration"],"title":"Update Comment Response","type":"object"},"UpdateFeedMembersRequest":{"nullable":true,"properties":{"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"006.001"},"members":{"description":"List of members to upsert, remove, or set","items":{"$ref":"#/components/schemas/FeedMemberRequest"},"title":"Members","type":"array","x-stream-index":"004"},"next":{"type":"string","x-stream-index":"006.002"},"operation":{"description":"Type of update operation to perform","enum":["upsert","remove","set"],"title":"Operation","type":"string","x-stream-index":"003"},"prev":{"type":"string","x-stream-index":"006.003"}},"required":["operation"],"title":"Update Feed Members Request","type":"object"},"UpdateFeedMembersResponse":{"description":"Basic response information","nullable":true,"properties":{"added":{"items":{"$ref":"#/components/schemas/FeedMemberResponse"},"type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"004.001"},"removed_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"updated":{"items":{"$ref":"#/components/schemas/FeedMemberResponse"},"type":"array","x-stream-index":"002"}},"required":["added","updated","removed_ids","duration"],"title":"Response","type":"object"},"UpdateFeedRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"description":"Custom data for the feed","title":"Custom Data","type":"object","x-stream-index":"004"}},"title":"Update Feed Request","type":"object"},"UpdateFeedResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"feed":{"$ref":"#/components/schemas/FeedResponse","description":"The updated feed","title":"Feed","x-stream-index":"001"}},"required":["feed","duration"],"title":"Update Feed Response","type":"object"},"UpdateFollowRequest":{"nullable":true,"properties":{"create_notification_activity":{"description":"Whether to create a notification activity for this follow","title":"Create Notification Activity","type":"boolean","x-stream-index":"001.004"},"custom":{"additionalProperties":{},"description":"Custom data for the follow relationship","title":"Custom Data","type":"object","x-stream-index":"001.002"},"follower_role":{"type":"string","x-stream-index":"002"},"push_preference":{"description":"Push preference for the follow relationship","enum":["all","none"],"title":"Push Preference","type":"string","x-stream-index":"001.003"},"skip_push":{"type":"boolean","x-stream-index":"001.005"},"source":{"description":"Fully qualified ID of the source feed","maxLength":255,"title":"Source Feed","type":"string","x-stream-index":"001.001.001"},"target":{"description":"Fully qualified ID of the target feed","maxLength":255,"title":"Target Feed","type":"string","x-stream-index":"001.001.002"}},"required":["source","target"],"title":"Update Follow Request","type":"object"},"UpdateFollowResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"follow":{"$ref":"#/components/schemas/FollowResponse","description":"Details of the updated follow relationship","title":"Follow","x-stream-index":"001"}},"required":["follow","duration"],"title":"Update Follow Response","type":"object"},"UpdateLiveLocationRequest":{"nullable":true,"properties":{"end_at":{"description":"Time when the live location expires","format":"date-time","title":"string","type":"number","x-stream-index":"004"},"latitude":{"description":"Latitude coordinate","format":"float","maximum":90,"minimum":18446744073709552000,"title":"number","type":"number","x-stream-index":"002"},"longitude":{"description":"Longitude coordinate","format":"float","maximum":180,"minimum":18446744073709552000,"title":"number","type":"number","x-stream-index":"003"},"message_id":{"description":"Live location ID","title":"string","type":"string","x-stream-index":"001"}},"required":["message_id"],"type":"object"},"UpdateMemberPartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"type":"object","x-stream-index":"002.001"},"unset":{"items":{"type":"string"},"type":"array","x-stream-index":"002.002"}},"type":"object"},"UpdateMemberPartialResponse":{"nullable":true,"properties":{"channel_member":{"$ref":"#/components/schemas/ChannelMemberResponse","description":"Updated channel member","title":"Channel member","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["duration"],"type":"object"},"UpdateMessagePartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"description":"Sets new field values","title":"Set","type":"object","x-stream-index":"002.001","x-stream-map":{"key":"field","title":"Value","description":"New value to set"}},"skip_enrich_url":{"description":"Skip enriching the URL in the message","title":"SkipEnrichURL","type":"boolean","x-stream-index":"001"},"unset":{"description":"Array of field names to unset","items":{"type":"string"},"title":"Unset","type":"array","x-stream-index":"002.002"}},"type":"object"},"UpdateMessagePartialResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Updated message","title":"Message","x-stream-index":"001"},"pending_message_metadata":{"additionalProperties":{"type":"string"},"description":"Pending message metadata","title":"PendingMessageMetadata","type":"object","x-stream-index":"002"}},"required":["duration"],"type":"object"},"UpdateMessageRequest":{"nullable":true,"properties":{"message":{"$ref":"#/components/schemas/MessageRequest","description":"Message","title":"MessageRequest","x-stream-index":"001"},"skip_enrich_url":{"description":"Skip enrich URL","title":"boolean","type":"boolean","x-stream-index":"003"},"skip_push":{"type":"boolean","x-stream-index":"002"}},"required":["message"],"type":"object"},"UpdateMessageResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001"},"pending_message_metadata":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"002"}},"required":["message","duration"],"title":"Response","type":"object"},"UpdatePollOptionRequest":{"nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"004"},"id":{"description":"Option ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"},"text":{"description":"Option text","title":"string","type":"string","x-stream-index":"003"}},"required":["id","text"],"type":"object"},"UpdatePollPartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"description":"Sets new field values","title":"Set","type":"object","x-stream-index":"002.001","x-stream-map":{"key":"field","title":"Value","description":"New value to set"}},"unset":{"description":"Array of field names to unset","items":{"type":"string"},"title":"Unset","type":"array","x-stream-index":"002.002"}},"type":"object"},"UpdatePollRequest":{"nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"011"},"allow_answers":{"description":"Allow answers","title":"boolean","type":"boolean","x-stream-index":"009"},"allow_user_suggested_options":{"description":"Allow user suggested options","title":"boolean","type":"boolean","x-stream-index":"008"},"description":{"description":"Poll description","title":"string","type":"string","x-stream-index":"003"},"enforce_unique_vote":{"description":"Enforce unique vote","title":"boolean","type":"boolean","x-stream-index":"005"},"id":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"},"is_closed":{"description":"Is closed","title":"boolean","type":"boolean","x-stream-index":"010"},"max_votes_allowed":{"description":"Max votes allowed","format":"int32","maximum":10,"title":"integer","type":"integer","x-stream-index":"007"},"name":{"description":"Poll name","title":"string","type":"string","x-stream-index":"002"},"options":{"description":"Poll options","items":{"$ref":"#/components/schemas/PollOptionRequest"},"maximum":100,"title":"PollOptions","type":"array","x-stream-index":"004"},"voting_visibility":{"description":"Voting visibility","enum":["anonymous","public"],"title":"string","type":"string","x-stream-index":"006"}},"required":["id","name"],"type":"object"},"UpdateReminderRequest":{"nullable":true,"properties":{"remind_at":{"format":"date-time","type":"number","x-stream-index":"001"}},"type":"object"},"UpdateReminderResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"001"}},"required":["reminder","duration"],"title":"Response","type":"object"},"UpdateThreadPartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"description":"Sets new field values","title":"Set","type":"object","x-stream-index":"004.001","x-stream-map":{"key":"field","title":"Value","description":"New value to set"}},"unset":{"description":"Array of field names to unset","items":{"type":"string"},"title":"Unset","type":"array","x-stream-index":"004.002"}},"type":"object"},"UpdateThreadPartialResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"thread":{"$ref":"#/components/schemas/ThreadResponse","description":"Updated thread (not enriched)","title":"Thread","x-stream-index":"001"}},"required":["thread","duration"],"type":"object"},"UpdateUserPartialRequest":{"properties":{"id":{"description":"User ID to update","title":"ID","type":"string","x-stream-index":"001"},"set":{"additionalProperties":{},"type":"object","x-stream-index":"002.001"},"unset":{"items":{"type":"string"},"type":"array","x-stream-index":"002.002"}},"required":["id"],"type":"object"},"UpdateUserPermissionsRequest":{"nullable":true,"properties":{"grant_permissions":{"items":{"type":"string"},"type":"array","x-stream-index":"002"},"revoke_permissions":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"user_id":{"type":"string","x-stream-index":"001"}},"required":["user_id"],"type":"object"},"UpdateUserPermissionsResponse":{"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"},"UpdateUsersPartialRequest":{"nullable":true,"properties":{"users":{"items":{"$ref":"#/components/schemas/UpdateUserPartialRequest"},"maximum":100,"type":"array","x-stream-index":"001"}},"required":["users"],"type":"object"},"UpdateUsersRequest":{"nullable":true,"properties":{"users":{"additionalProperties":{"$ref":"#/components/schemas/UserRequest"},"description":"Object containing users","title":"Users","type":"object","x-stream-index":"001","x-stream-map":{"key":"user_id"}}},"required":["users"],"type":"object"},"UpdateUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"membership_deletion_task_id":{"type":"string","x-stream-index":"002"},"users":{"additionalProperties":{"$ref":"#/components/schemas/FullUserResponse"},"description":"Object containing users","title":"Users","type":"object","x-stream-index":"001","x-stream-map":{"key":"user_id"}}},"required":["users","membership_deletion_task_id","duration"],"type":"object"},"UpdatedCallPermissionsEvent":{"description":"This event is sent to notify about permission changes for a user, clients receiving this event should update their UI accordingly","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"own_capabilities":{"description":"The capabilities of the current user","items":{"$ref":"#/components/schemas/OwnCapability"},"title":"Own capabilities","type":"array","x-stream-index":"004"},"type":{"default":"call.permissions_updated","description":"The type of event: \"call.permissions_updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who received the new permissions","title":"User","x-stream-index":"003"}},"required":["type","created_at","call_cid","user","own_capabilities"],"title":"UpdatedCallPermissionsEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"UpsertActivitiesRequest":{"nullable":true,"properties":{"activities":{"description":"List of activities to create or update","items":{"$ref":"#/components/schemas/ActivityRequest"},"maximum":100,"minimum":1,"title":"Activities","type":"array","x-stream-index":"001"}},"required":["activities"],"title":"Upsert Activities Request","type":"object"},"UpsertActivitiesResponse":{"nullable":true,"properties":{"activities":{"description":"List of created or updated activities","items":{"$ref":"#/components/schemas/ActivityResponse"},"title":"Activities","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["activities","duration"],"title":"Upsert Activities Response","type":"object"},"UpsertConfigRequest":{"nullable":true,"properties":{"ai_image_config":{"$ref":"#/components/schemas/AIImageConfig","description":"Configuration for AI image analysis","title":"AI Image Config","x-stream-index":"011"},"ai_text_config":{"$ref":"#/components/schemas/AITextConfig","description":"Configuration for AI text analysis","title":"AI Text Config","x-stream-index":"008"},"ai_video_config":{"$ref":"#/components/schemas/AIVideoConfig","description":"Configuration for AI video analysis","title":"AI Video Config","x-stream-index":"012"},"async":{"description":"Whether moderation should be performed asynchronously","title":"Async","type":"boolean","x-stream-index":"003"},"automod_platform_circumvention_config":{"$ref":"#/components/schemas/AutomodPlatformCircumventionConfig","description":"Configuration for platform circumvention detection","title":"Automod Platform Circumvention Config","x-stream-index":"005"},"automod_semantic_filters_config":{"$ref":"#/components/schemas/AutomodSemanticFiltersConfig","description":"Configuration for semantic filtering","title":"Automod Semantic Filters Config","x-stream-index":"006"},"automod_toxicity_config":{"$ref":"#/components/schemas/AutomodToxicityConfig","description":"Configuration for toxicity detection","title":"Automod Toxicity Config","x-stream-index":"004"},"aws_rekognition_config":{"$ref":"#/components/schemas/AIImageConfig","x-stream-index":"016"},"block_list_config":{"$ref":"#/components/schemas/BlockListConfig","description":"Configuration for block list filtering","title":"Block List Config","x-stream-index":"007"},"bodyguard_config":{"$ref":"#/components/schemas/AITextConfig","x-stream-index":"015"},"google_vision_config":{"$ref":"#/components/schemas/GoogleVisionConfig","description":"Configuration for Google Vision integration","title":"Google Vision Config","x-stream-index":"010"},"key":{"description":"Unique identifier for the moderation configuration","title":"Key","type":"string","x-stream-index":"001"},"llm_config":{"$ref":"#/components/schemas/LLMConfig","description":"Configuration for customer-configured LLM moderation","title":"LLM Config","x-stream-index":"009"},"rule_builder_config":{"$ref":"#/components/schemas/RuleBuilderConfig","description":"Configuration for custom rule builder (max 3 rules, max 5 conditions per rule)","title":"Rule Builder Config","x-stream-index":"014"},"team":{"description":"Team associated with the configuration","maxLength":128,"minLength":1,"title":"Team","type":"string","x-stream-index":"002"},"velocity_filter_config":{"$ref":"#/components/schemas/VelocityFilterConfig","description":"Configuration for velocity-based filtering","title":"Velocity Filter Config","x-stream-index":"013"},"video_call_rule_config":{"$ref":"#/components/schemas/VideoCallRuleConfig","x-stream-index":"017"}},"required":["key"],"type":"object"},"UpsertConfigResponse":{"nullable":true,"properties":{"config":{"$ref":"#/components/schemas/ConfigResponse","description":"The created or updated moderation configuration","title":"Config","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["duration"],"type":"object"},"UpsertPushPreferencesRequest":{"nullable":true,"properties":{"preferences":{"description":"A list of push preferences for channels, calls, or the user.","items":{"$ref":"#/components/schemas/PushPreferenceInput"},"type":"array","x-stream-index":"001"}},"required":["preferences"],"type":"object"},"UpsertPushPreferencesResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"user_channel_preferences":{"additionalProperties":{"additionalProperties":{"$ref":"#/components/schemas/ChannelPushPreferences"},"type":"object"},"description":"The channel specific push notification preferences, only returned for channels you've edited.","title":"User Channel Notification Preferences","type":"object","x-stream-index":"002"},"user_preferences":{"additionalProperties":{"$ref":"#/components/schemas/PushPreferences"},"description":"The user preferences, always returned regardless if you edited it","title":"User Preferences","type":"object","x-stream-index":"001"}},"required":["user_preferences","user_channel_preferences","duration"],"type":"object"},"User":{"properties":{"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"046"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"017"},"banned":{"type":"boolean","x-stream-index":"016"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"013"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"023"},"language":{"type":"string","x-stream-index":"035"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"026"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"042"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"005"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"009"}},"required":["id","role","teams_role","custom","banned","online"],"type":"object"},"UserBannedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"006.002"},"channel_type":{"type":"string","x-stream-index":"006.003"},"cid":{"type":"string","x-stream-index":"006.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008.002"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"001"},"expiration":{"format":"date-time","type":"number","x-stream-index":"003"},"reason":{"type":"string","x-stream-index":"004"},"shadow":{"type":"boolean","x-stream-index":"002"},"team":{"type":"string","x-stream-index":"005.001"},"type":{"default":"user.banned","type":"string","x-stream-index":"008.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007.001"}},"required":["created_by","shadow","cid","channel_id","channel_type","type","created_at"],"title":"UserBannedEvent","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"},"UserCreatedWithinParameters":{"properties":{"max_age":{"type":"string","x-stream-index":"001"}},"type":"object"},"UserCustomPropertyParameters":{"properties":{"operator":{"type":"string","x-stream-index":"002"},"property_key":{"type":"string","x-stream-index":"001"}},"type":"object"},"UserDeactivatedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"001"},"type":{"default":"user.deactivated","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["created_by","type","created_at"],"title":"UserDeactivatedEvent","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"},"UserDeletedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"delete_conversation_channels":{"type":"boolean","x-stream-index":"005"},"hard_delete":{"type":"boolean","x-stream-index":"003.001"},"mark_messages_deleted":{"type":"boolean","x-stream-index":"004"},"type":{"default":"user.deleted","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"001.001"}},"required":["type","created_at","hard_delete","mark_messages_deleted","delete_conversation_channels"],"title":"UserDeletedEvent","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"},"UserFeedbackReport":{"properties":{"count_by_rating":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001"},"unreported_count":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["count_by_rating","unreported_count"],"type":"object"},"UserFeedbackReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateUserFeedbackReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"UserMessagesDeletedEvent":{"description":"This event is sent when a user's message get deleted. The event contains information about the user whose messages got deleted.","nullable":true,"properties":{"channel_custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.005"},"channel_id":{"description":"The ID of the channel where the target user's messages were deleted","title":"Channel ID","type":"string","x-stream-index":"001.002.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"001.001.004"},"channel_type":{"description":"The type of the channel where the target user's messages were deleted","title":"Channel Type","type":"string","x-stream-index":"001.002.001"},"cid":{"description":"The CID of the channel where the target user's messages were deleted","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":"number","x-stream-index":"001.001.001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.001.001.007"},"hard_delete":{"description":"Whether Messages were hard deleted","title":"Hard Delete","type":"boolean","x-stream-index":"003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.001.001.004"},"team":{"description":"The team of the channel where the target user's messages were deleted","title":"Team","type":"string","x-stream-index":"001.001.003"},"type":{"default":"user.messages.deleted","description":"The type of event: \"user.messages.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.001.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The target user whose messages got deleted","title":"User","x-stream-index":"002.001"}},"required":["type","created_at","custom","user"],"title":"UserMessagesDeletedEvent","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"},"UserMute":{"nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"expires":{"description":"Date/time of mute expiration","format":"date-time","title":"Expires","type":"number","x-stream-index":"008"},"target":{"$ref":"#/components/schemas/User","description":"User who's muted","title":"Target","x-stream-index":"007"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/User","description":"Owner of channel mute","title":"User","x-stream-index":"005"}},"required":["created_at","updated_at"],"type":"object"},"UserMuteResponse":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"expires":{"format":"date-time","type":"number","x-stream-index":"003"},"target":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"}},"required":["created_at","updated_at"],"type":"object"},"UserMutedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"target_user":{"type":"string","x-stream-index":"001"},"target_users":{"items":{"type":"string"},"type":"array","x-stream-index":"002"},"type":{"default":"user.muted","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"UserMutedEvent","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"},"UserPresenceChangedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"type":{"default":"user.presence.changed","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"001.001"}},"required":["type","created_at"],"title":"UserPresenceChangedEvent","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"},"UserRatingReportResponse":{"properties":{"average":{"format":"float","type":"number","x-stream-index":"002"},"count":{"format":"int32","type":"integer","x-stream-index":"001"}},"required":["count","average"],"type":"object"},"UserReactivatedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"type":{"default":"user.reactivated","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"001"}},"required":["type","created_at"],"title":"UserReactivatedEvent","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"},"UserRequest":{"description":"User request object","properties":{"custom":{"additionalProperties":{},"description":"Custom user data","title":"Custom","type":"object","x-stream-index":"004"},"id":{"description":"User ID","title":"ID","type":"string","x-stream-index":"001"},"image":{"description":"User's profile image URL","title":"Image","type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"006"},"language":{"type":"string","x-stream-index":"005"},"name":{"description":"Optional name of user","title":"Name","type":"string","x-stream-index":"002"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"007"}},"required":["id"],"title":"UserRequest","type":"object"},"UserResponse":{"description":"User response object","properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"banned":{"description":"Whether a user is banned or not","title":"Banned","type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.017"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"001.004"},"deactivated_at":{"description":"Date of deactivation","format":"date-time","title":"Deactivated at","type":"number","x-stream-index":"001.016"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"001.011"},"id":{"description":"Unique user identifier","title":"ID","type":"string","x-stream-index":"001.001"},"image":{"title":"Image","type":"string","x-stream-index":"001.003"},"language":{"description":"Preferred language of a user","title":"Language","type":"string","x-stream-index":"001.005"},"last_active":{"description":"Date of last activity","format":"date-time","title":"Last active","type":"number","x-stream-index":"001.014"},"name":{"description":"Optional name of user","title":"Name","type":"string","x-stream-index":"001.002"},"online":{"description":"Whether a user online or not","title":"Online","type":"boolean","x-stream-index":"001.013"},"revoke_tokens_issued_before":{"description":"Revocation date for tokens","format":"date-time","title":"Revoke tokens issued before","type":"number","x-stream-index":"001.015"},"role":{"description":"Determines the set of user permissions","title":"Role","type":"string","x-stream-index":"001.006"},"teams":{"description":"List of teams user is a part of","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids","shadow_banned","invisible"],"title":"UserResponse","type":"object"},"UserResponseCommonFields":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"018"},"banned":{"type":"boolean","x-stream-index":"012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"017"},"created_at":{"format":"date-time","type":"number","x-stream-index":"009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"id":{"type":"string","x-stream-index":"001"},"image":{"type":"string","x-stream-index":"003"},"language":{"type":"string","x-stream-index":"005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"014"},"name":{"type":"string","x-stream-index":"002"},"online":{"type":"boolean","x-stream-index":"013"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"015"},"role":{"type":"string","x-stream-index":"006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids"],"type":"object"},"UserResponsePrivacyFields":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"banned":{"type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.017"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.011"},"id":{"type":"string","x-stream-index":"001.001"},"image":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"003"},"language":{"type":"string","x-stream-index":"001.005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"001.014"},"name":{"type":"string","x-stream-index":"001.002"},"online":{"type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"002"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.015"},"role":{"type":"string","x-stream-index":"001.006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids"],"type":"object"},"UserRuleParameters":{"properties":{"max_age":{"type":"string","x-stream-index":"001"}},"type":"object"},"UserUnbannedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"005.002"},"shadow":{"type":"boolean","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"004.001"},"type":{"default":"user.unbanned","type":"string","x-stream-index":"005.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["shadow","cid","channel_id","channel_type","type","created_at"],"title":"UserUnbannedEvent","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"},"UserUpdatedEvent":{"description":"This event is sent when a user gets updated. The event contains information about the updated user.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"type":{"default":"user.updated","description":"The type of event: \"user.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.002"},"user":{"$ref":"#/components/schemas/UserResponsePrivacyFields","description":"The updated user","title":"User","x-stream-index":"002.001"}},"required":["type","created_at","custom","user"],"title":"UserUpdatedEvent","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"},"UserWatchingStartEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"team":{"type":"string","x-stream-index":"002.001"},"type":{"default":"user.watching.start","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005.001"},"watcher_count":{"format":"int32","type":"integer","x-stream-index":"001.001"}},"required":["watcher_count","type","created_at","cid","channel_id","channel_type"],"title":"UserWatchingStartEvent","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"},"UserWatchingStopEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"type":{"default":"user.watching.stop","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"},"watcher_count":{"format":"int32","type":"integer","x-stream-index":"001.001"}},"required":["watcher_count","type","created_at","cid","channel_id","channel_type"],"title":"UserWatchingStopEvent","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"},"VelocityFilterConfig":{"properties":{"advanced_filters":{"type":"boolean","x-stream-index":"007"},"async":{"type":"boolean","x-stream-index":"001"},"cascading_actions":{"type":"boolean","x-stream-index":"004"},"cids_per_user":{"format":"int32","type":"integer","x-stream-index":"006"},"enabled":{"type":"boolean","x-stream-index":"002"},"first_message_only":{"type":"boolean","x-stream-index":"005"},"rules":{"items":{"$ref":"#/components/schemas/VelocityFilterConfigRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules","cascading_actions","first_message_only","cids_per_user","advanced_filters"],"type":"object"},"VelocityFilterConfigRule":{"properties":{"action":{"enum":["flag","shadow","remove","ban"],"type":"string","x-stream-index":"001"},"ban_duration":{"format":"int32","type":"integer","x-stream-index":"002"},"cascading_action":{"enum":["flag","shadow","remove","ban"],"type":"string","x-stream-index":"006"},"cascading_threshold":{"format":"int64","type":"integer","x-stream-index":"005"},"check_message_context":{"type":"boolean","x-stream-index":"009"},"fast_spam_threshold":{"format":"int32","type":"integer","x-stream-index":"007"},"fast_spam_ttl":{"format":"int32","type":"integer","x-stream-index":"010"},"ip_ban":{"type":"boolean","x-stream-index":"004"},"probation_period":{"format":"int32","type":"integer","x-stream-index":"014"},"shadow_ban":{"type":"boolean","x-stream-index":"003"},"slow_spam_ban_duration":{"format":"int32","type":"integer","x-stream-index":"012"},"slow_spam_threshold":{"format":"int32","type":"integer","x-stream-index":"008"},"slow_spam_ttl":{"format":"int32","type":"integer","x-stream-index":"011"},"url_only":{"type":"boolean","x-stream-index":"013"}},"required":["action","ban_duration","shadow_ban","ip_ban","cascading_threshold","cascading_action","fast_spam_threshold","slow_spam_threshold","check_message_context","fast_spam_ttl","slow_spam_ttl","url_only","probation_period"],"type":"object"},"VideoCallRuleConfig":{"properties":{"rules":{"additionalProperties":{"$ref":"#/components/schemas/HarmConfig"},"type":"object","x-stream-index":"001"}},"required":["rules"],"type":"object"},"VideoContentParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"type":"object"},"VideoEndCallRequest":{"type":"object"},"VideoKickUserRequest":{"type":"object"},"VideoOrientation":{"properties":{"orientation":{"type":"integer","x-stream-index":"004"}},"type":"object"},"VideoReactionOverTimeResponse":{"properties":{"by_minute":{"items":{"$ref":"#/components/schemas/CountByMinuteResponse"},"type":"array","x-stream-index":"001"}},"type":"object"},"VideoReactionsResponse":{"nullable":true,"properties":{"count_over_time":{"$ref":"#/components/schemas/VideoReactionOverTimeResponse","x-stream-index":"002"},"reaction":{"type":"string","x-stream-index":"001"}},"required":["reaction"],"type":"object"},"VideoRuleParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"type":"object"},"VideoSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"camera_default_on":{"type":"boolean","x-stream-index":"004"},"camera_facing":{"enum":["front","back","external"],"type":"string","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled","target_resolution","camera_default_on","camera_facing"],"type":"object"},"VideoSettingsRequest":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"camera_default_on":{"type":"boolean","x-stream-index":"004"},"camera_facing":{"enum":["front","back","external"],"type":"string","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"type":"object"},"VideoSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"camera_default_on":{"type":"boolean","x-stream-index":"004"},"camera_facing":{"enum":["front","back","external"],"type":"string","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled","target_resolution","camera_default_on","camera_facing"],"type":"object"},"VoteData":{"properties":{"answer_text":{"type":"string","x-stream-index":"002"},"option_id":{"maxLength":255,"type":"string","x-stream-index":"001"}},"type":"object"},"WSAuthMessage":{"description":"Websocket auth message","nullable":true,"properties":{"products":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"token":{"title":"Token","type":"string","x-stream-index":"002"},"user_details":{"$ref":"#/components/schemas/ConnectUserDetailsRequest","x-stream-index":"001"}},"required":["user_details","token"],"title":"WSAuthMessage","type":"object"},"WSClientEvent":{"description":"The discriminator object for all websocket client events, it maps events' payload to the final type","discriminator":{"mapping":{"app.updated":"#/components/schemas/AppUpdatedEvent","draft.deleted":"#/components/schemas/DraftDeletedEvent","draft.updated":"#/components/schemas/DraftUpdatedEvent","feeds.activity.added":"#/components/schemas/ActivityAddedEvent","feeds.activity.deleted":"#/components/schemas/ActivityDeletedEvent","feeds.activity.marked":"#/components/schemas/ActivityMarkEvent","feeds.activity.pinned":"#/components/schemas/ActivityPinnedEvent","feeds.activity.reaction.added":"#/components/schemas/ActivityReactionAddedEvent","feeds.activity.reaction.deleted":"#/components/schemas/ActivityReactionDeletedEvent","feeds.activity.reaction.updated":"#/components/schemas/ActivityReactionUpdatedEvent","feeds.activity.removed_from_feed":"#/components/schemas/ActivityRemovedFromFeedEvent","feeds.activity.unpinned":"#/components/schemas/ActivityUnpinnedEvent","feeds.activity.updated":"#/components/schemas/ActivityUpdatedEvent","feeds.bookmark.added":"#/components/schemas/BookmarkAddedEvent","feeds.bookmark.deleted":"#/components/schemas/BookmarkDeletedEvent","feeds.bookmark.updated":"#/components/schemas/BookmarkUpdatedEvent","feeds.bookmark_folder.deleted":"#/components/schemas/BookmarkFolderDeletedEvent","feeds.bookmark_folder.updated":"#/components/schemas/BookmarkFolderUpdatedEvent","feeds.comment.added":"#/components/schemas/CommentAddedEvent","feeds.comment.deleted":"#/components/schemas/CommentDeletedEvent","feeds.comment.reaction.added":"#/components/schemas/CommentReactionAddedEvent","feeds.comment.reaction.deleted":"#/components/schemas/CommentReactionDeletedEvent","feeds.comment.reaction.updated":"#/components/schemas/CommentReactionUpdatedEvent","feeds.comment.updated":"#/components/schemas/CommentUpdatedEvent","feeds.feed.created":"#/components/schemas/FeedCreatedEvent","feeds.feed.deleted":"#/components/schemas/FeedDeletedEvent","feeds.feed.updated":"#/components/schemas/FeedUpdatedEvent","feeds.feed_group.changed":"#/components/schemas/FeedGroupChangedEvent","feeds.feed_group.deleted":"#/components/schemas/FeedGroupDeletedEvent","feeds.feed_member.added":"#/components/schemas/FeedMemberAddedEvent","feeds.feed_member.removed":"#/components/schemas/FeedMemberRemovedEvent","feeds.feed_member.updated":"#/components/schemas/FeedMemberUpdatedEvent","feeds.follow.created":"#/components/schemas/FollowCreatedEvent","feeds.follow.deleted":"#/components/schemas/FollowDeletedEvent","feeds.follow.updated":"#/components/schemas/FollowUpdatedEvent","feeds.notification_feed.updated":"#/components/schemas/NotificationFeedUpdatedEvent","feeds.poll.closed":"#/components/schemas/PollClosedFeedEvent","feeds.poll.deleted":"#/components/schemas/PollDeletedFeedEvent","feeds.poll.updated":"#/components/schemas/PollUpdatedFeedEvent","feeds.poll.vote_casted":"#/components/schemas/PollVoteCastedFeedEvent","feeds.poll.vote_changed":"#/components/schemas/PollVoteChangedFeedEvent","feeds.poll.vote_removed":"#/components/schemas/PollVoteRemovedFeedEvent","health.check":"#/components/schemas/HealthCheckEvent","message.pending":"#/components/schemas/PendingMessageEvent","notification.reminder_due":"#/components/schemas/ReminderNotificationEvent","poll.closed":"#/components/schemas/PollClosedEvent","poll.deleted":"#/components/schemas/PollDeletedEvent","poll.updated":"#/components/schemas/PollUpdatedEvent","poll.vote_casted":"#/components/schemas/PollVoteCastedEvent","poll.vote_changed":"#/components/schemas/PollVoteChangedEvent","poll.vote_removed":"#/components/schemas/PollVoteRemovedEvent","reminder.created":"#/components/schemas/ReminderCreatedEvent","reminder.deleted":"#/components/schemas/ReminderDeletedEvent","reminder.updated":"#/components/schemas/ReminderUpdatedEvent","user.messages.deleted":"#/components/schemas/UserMessagesDeletedEvent","user.updated":"#/components/schemas/UserUpdatedEvent"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/ActivityAddedEvent"},{"$ref":"#/components/schemas/ActivityDeletedEvent"},{"$ref":"#/components/schemas/ActivityMarkEvent"},{"$ref":"#/components/schemas/ActivityPinnedEvent"},{"$ref":"#/components/schemas/ActivityReactionAddedEvent"},{"$ref":"#/components/schemas/ActivityReactionDeletedEvent"},{"$ref":"#/components/schemas/ActivityReactionUpdatedEvent"},{"$ref":"#/components/schemas/ActivityRemovedFromFeedEvent"},{"$ref":"#/components/schemas/ActivityUnpinnedEvent"},{"$ref":"#/components/schemas/ActivityUpdatedEvent"},{"$ref":"#/components/schemas/AppUpdatedEvent"},{"$ref":"#/components/schemas/BookmarkAddedEvent"},{"$ref":"#/components/schemas/BookmarkDeletedEvent"},{"$ref":"#/components/schemas/BookmarkFolderDeletedEvent"},{"$ref":"#/components/schemas/BookmarkFolderUpdatedEvent"},{"$ref":"#/components/schemas/BookmarkUpdatedEvent"},{"$ref":"#/components/schemas/CommentAddedEvent"},{"$ref":"#/components/schemas/CommentDeletedEvent"},{"$ref":"#/components/schemas/CommentReactionAddedEvent"},{"$ref":"#/components/schemas/CommentReactionDeletedEvent"},{"$ref":"#/components/schemas/CommentReactionUpdatedEvent"},{"$ref":"#/components/schemas/CommentUpdatedEvent"},{"$ref":"#/components/schemas/DraftDeletedEvent"},{"$ref":"#/components/schemas/DraftUpdatedEvent"},{"$ref":"#/components/schemas/FeedCreatedEvent"},{"$ref":"#/components/schemas/FeedDeletedEvent"},{"$ref":"#/components/schemas/FeedGroupChangedEvent"},{"$ref":"#/components/schemas/FeedGroupDeletedEvent"},{"$ref":"#/components/schemas/FeedMemberAddedEvent"},{"$ref":"#/components/schemas/FeedMemberRemovedEvent"},{"$ref":"#/components/schemas/FeedMemberUpdatedEvent"},{"$ref":"#/components/schemas/FeedUpdatedEvent"},{"$ref":"#/components/schemas/FollowCreatedEvent"},{"$ref":"#/components/schemas/FollowDeletedEvent"},{"$ref":"#/components/schemas/FollowUpdatedEvent"},{"$ref":"#/components/schemas/HealthCheckEvent"},{"$ref":"#/components/schemas/NotificationFeedUpdatedEvent"},{"$ref":"#/components/schemas/PendingMessageEvent"},{"$ref":"#/components/schemas/PollClosedEvent"},{"$ref":"#/components/schemas/PollClosedFeedEvent"},{"$ref":"#/components/schemas/PollDeletedEvent"},{"$ref":"#/components/schemas/PollDeletedFeedEvent"},{"$ref":"#/components/schemas/PollUpdatedEvent"},{"$ref":"#/components/schemas/PollUpdatedFeedEvent"},{"$ref":"#/components/schemas/PollVoteCastedEvent"},{"$ref":"#/components/schemas/PollVoteCastedFeedEvent"},{"$ref":"#/components/schemas/PollVoteChangedEvent"},{"$ref":"#/components/schemas/PollVoteChangedFeedEvent"},{"$ref":"#/components/schemas/PollVoteRemovedEvent"},{"$ref":"#/components/schemas/PollVoteRemovedFeedEvent"},{"$ref":"#/components/schemas/ReminderCreatedEvent"},{"$ref":"#/components/schemas/ReminderDeletedEvent"},{"$ref":"#/components/schemas/ReminderNotificationEvent"},{"$ref":"#/components/schemas/ReminderUpdatedEvent"},{"$ref":"#/components/schemas/UserMessagesDeletedEvent"},{"$ref":"#/components/schemas/UserUpdatedEvent"}]},"WSEvent":{"description":"The discriminator object for all websocket events, it maps events' payload to the final type","discriminator":{"mapping":{"*":"#/components/schemas/AnyEvent","activity.marked":"#/components/schemas/ActivityMarkedEvent","ai_indicator.clear":"#/components/schemas/AIIndicatorClearEvent","ai_indicator.stop":"#/components/schemas/AIIndicatorStopEvent","ai_indicator.update":"#/components/schemas/AIIndicatorUpdateEvent","app.updated":"#/components/schemas/AppUpdatedEvent","call.accepted":"#/components/schemas/CallAcceptedEvent","call.blocked_user":"#/components/schemas/BlockedUserEvent","call.closed_caption":"#/components/schemas/ClosedCaptionEvent","call.closed_captions_failed":"#/components/schemas/CallClosedCaptionsFailedEvent","call.closed_captions_started":"#/components/schemas/CallClosedCaptionsStartedEvent","call.closed_captions_stopped":"#/components/schemas/CallClosedCaptionsStoppedEvent","call.created":"#/components/schemas/CallCreatedEvent","call.deleted":"#/components/schemas/CallDeletedEvent","call.ended":"#/components/schemas/CallEndedEvent","call.frame_recording_failed":"#/components/schemas/CallFrameRecordingFailedEvent","call.frame_recording_ready":"#/components/schemas/CallFrameRecordingFrameReadyEvent","call.frame_recording_started":"#/components/schemas/CallFrameRecordingStartedEvent","call.frame_recording_stopped":"#/components/schemas/CallFrameRecordingStoppedEvent","call.hls_broadcasting_failed":"#/components/schemas/CallHLSBroadcastingFailedEvent","call.hls_broadcasting_started":"#/components/schemas/CallHLSBroadcastingStartedEvent","call.hls_broadcasting_stopped":"#/components/schemas/CallHLSBroadcastingStoppedEvent","call.kicked_user":"#/components/schemas/KickedUserEvent","call.live_started":"#/components/schemas/CallLiveStartedEvent","call.member_added":"#/components/schemas/CallMemberAddedEvent","call.member_removed":"#/components/schemas/CallMemberRemovedEvent","call.member_updated":"#/components/schemas/CallMemberUpdatedEvent","call.member_updated_permission":"#/components/schemas/CallMemberUpdatedPermissionEvent","call.missed":"#/components/schemas/CallMissedEvent","call.moderation_blur":"#/components/schemas/CallModerationBlurEvent","call.moderation_warning":"#/components/schemas/CallModerationWarningEvent","call.notification":"#/components/schemas/CallNotificationEvent","call.permission_request":"#/components/schemas/PermissionRequestEvent","call.permissions_updated":"#/components/schemas/UpdatedCallPermissionsEvent","call.reaction_new":"#/components/schemas/CallReactionEvent","call.recording_failed":"#/components/schemas/CallRecordingFailedEvent","call.recording_ready":"#/components/schemas/CallRecordingReadyEvent","call.recording_started":"#/components/schemas/CallRecordingStartedEvent","call.recording_stopped":"#/components/schemas/CallRecordingStoppedEvent","call.rejected":"#/components/schemas/CallRejectedEvent","call.ring":"#/components/schemas/CallRingEvent","call.rtmp_broadcast_failed":"#/components/schemas/CallRtmpBroadcastFailedEvent","call.rtmp_broadcast_started":"#/components/schemas/CallRtmpBroadcastStartedEvent","call.rtmp_broadcast_stopped":"#/components/schemas/CallRtmpBroadcastStoppedEvent","call.session_ended":"#/components/schemas/CallSessionEndedEvent","call.session_participant_count_updated":"#/components/schemas/CallSessionParticipantCountsUpdatedEvent","call.session_participant_joined":"#/components/schemas/CallSessionParticipantJoinedEvent","call.session_participant_left":"#/components/schemas/CallSessionParticipantLeftEvent","call.session_started":"#/components/schemas/CallSessionStartedEvent","call.stats_report_ready":"#/components/schemas/CallStatsReportReadyEvent","call.transcription_failed":"#/components/schemas/CallTranscriptionFailedEvent","call.transcription_ready":"#/components/schemas/CallTranscriptionReadyEvent","call.transcription_started":"#/components/schemas/CallTranscriptionStartedEvent","call.transcription_stopped":"#/components/schemas/CallTranscriptionStoppedEvent","call.unblocked_user":"#/components/schemas/UnblockedUserEvent","call.updated":"#/components/schemas/CallUpdatedEvent","call.user_feedback_submitted":"#/components/schemas/CallUserFeedbackSubmittedEvent","call.user_muted":"#/components/schemas/CallUserMutedEvent","channel.created":"#/components/schemas/ChannelCreatedEvent","channel.deleted":"#/components/schemas/ChannelDeletedEvent","channel.frozen":"#/components/schemas/ChannelFrozenEvent","channel.hidden":"#/components/schemas/ChannelHiddenEvent","channel.kicked":"#/components/schemas/ChannelKickedEvent","channel.truncated":"#/components/schemas/ChannelTruncatedEvent","channel.unfrozen":"#/components/schemas/ChannelUnFrozenEvent","channel.updated":"#/components/schemas/ChannelUpdatedEvent","channel.visible":"#/components/schemas/ChannelVisibleEvent","connection.error":"#/components/schemas/ConnectionErrorEvent","connection.ok":"#/components/schemas/ConnectedEvent","custom":"#/components/schemas/CustomVideoEvent","draft.deleted":"#/components/schemas/DraftDeletedEvent","draft.updated":"#/components/schemas/DraftUpdatedEvent","feeds.activity.added":"#/components/schemas/ActivityAddedEvent","feeds.activity.deleted":"#/components/schemas/ActivityDeletedEvent","feeds.activity.marked":"#/components/schemas/ActivityMarkEvent","feeds.activity.pinned":"#/components/schemas/ActivityPinnedEvent","feeds.activity.reaction.added":"#/components/schemas/ActivityReactionAddedEvent","feeds.activity.reaction.deleted":"#/components/schemas/ActivityReactionDeletedEvent","feeds.activity.reaction.updated":"#/components/schemas/ActivityReactionUpdatedEvent","feeds.activity.removed_from_feed":"#/components/schemas/ActivityRemovedFromFeedEvent","feeds.activity.unpinned":"#/components/schemas/ActivityUnpinnedEvent","feeds.activity.updated":"#/components/schemas/ActivityUpdatedEvent","feeds.bookmark.added":"#/components/schemas/BookmarkAddedEvent","feeds.bookmark.deleted":"#/components/schemas/BookmarkDeletedEvent","feeds.bookmark.updated":"#/components/schemas/BookmarkUpdatedEvent","feeds.bookmark_folder.deleted":"#/components/schemas/BookmarkFolderDeletedEvent","feeds.bookmark_folder.updated":"#/components/schemas/BookmarkFolderUpdatedEvent","feeds.comment.added":"#/components/schemas/CommentAddedEvent","feeds.comment.deleted":"#/components/schemas/CommentDeletedEvent","feeds.comment.reaction.added":"#/components/schemas/CommentReactionAddedEvent","feeds.comment.reaction.deleted":"#/components/schemas/CommentReactionDeletedEvent","feeds.comment.reaction.updated":"#/components/schemas/CommentReactionUpdatedEvent","feeds.comment.updated":"#/components/schemas/CommentUpdatedEvent","feeds.feed.created":"#/components/schemas/FeedCreatedEvent","feeds.feed.deleted":"#/components/schemas/FeedDeletedEvent","feeds.feed.updated":"#/components/schemas/FeedUpdatedEvent","feeds.feed_group.changed":"#/components/schemas/FeedGroupChangedEvent","feeds.feed_group.deleted":"#/components/schemas/FeedGroupDeletedEvent","feeds.feed_member.added":"#/components/schemas/FeedMemberAddedEvent","feeds.feed_member.removed":"#/components/schemas/FeedMemberRemovedEvent","feeds.feed_member.updated":"#/components/schemas/FeedMemberUpdatedEvent","feeds.follow.created":"#/components/schemas/FollowCreatedEvent","feeds.follow.deleted":"#/components/schemas/FollowDeletedEvent","feeds.follow.updated":"#/components/schemas/FollowUpdatedEvent","feeds.notification_feed.updated":"#/components/schemas/NotificationFeedUpdatedEvent","feeds.poll.closed":"#/components/schemas/PollClosedFeedEvent","feeds.poll.deleted":"#/components/schemas/PollDeletedFeedEvent","feeds.poll.updated":"#/components/schemas/PollUpdatedFeedEvent","feeds.poll.vote_casted":"#/components/schemas/PollVoteCastedFeedEvent","feeds.poll.vote_changed":"#/components/schemas/PollVoteChangedFeedEvent","feeds.poll.vote_removed":"#/components/schemas/PollVoteRemovedFeedEvent","health.check":"#/components/schemas/HealthCheckEvent","member.added":"#/components/schemas/MemberAddedEvent","member.removed":"#/components/schemas/MemberRemovedEvent","member.updated":"#/components/schemas/MemberUpdatedEvent","message.deleted":"#/components/schemas/MessageDeletedEvent","message.new":"#/components/schemas/MessageNewEvent","message.pending":"#/components/schemas/PendingMessageEvent","message.read":"#/components/schemas/MessageReadEvent","message.undeleted":"#/components/schemas/MessageUndeletedEvent","message.updated":"#/components/schemas/MessageUpdatedEvent","moderation.custom_action":"#/components/schemas/ModerationCustomActionEvent","moderation.flagged":"#/components/schemas/ModerationFlaggedEvent","moderation.mark_reviewed":"#/components/schemas/ModerationMarkReviewedEvent","notification.added_to_channel":"#/components/schemas/NotificationAddedToChannelEvent","notification.channel_deleted":"#/components/schemas/NotificationChannelDeletedEvent","notification.channel_mutes_updated":"#/components/schemas/NotificationChannelMutesUpdatedEvent","notification.channel_truncated":"#/components/schemas/NotificationChannelTruncatedEvent","notification.invite_accepted":"#/components/schemas/NotificationInviteAcceptedEvent","notification.invite_rejected":"#/components/schemas/NotificationInviteRejectedEvent","notification.invited":"#/components/schemas/NotificationInvitedEvent","notification.mark_read":"#/components/schemas/NotificationMarkReadEvent","notification.mark_unread":"#/components/schemas/NotificationMarkUnreadEvent","notification.message_new":"#/components/schemas/NotificationNewMessageEvent","notification.mutes_updated":"#/components/schemas/NotificationMutesUpdatedEvent","notification.reminder_due":"#/components/schemas/ReminderNotificationEvent","notification.removed_from_channel":"#/components/schemas/NotificationRemovedFromChannelEvent","notification.thread_message_new":"#/components/schemas/MessageNewEvent","poll.closed":"#/components/schemas/PollClosedEvent","poll.deleted":"#/components/schemas/PollDeletedEvent","poll.updated":"#/components/schemas/PollUpdatedEvent","poll.vote_casted":"#/components/schemas/PollVoteCastedEvent","poll.vote_changed":"#/components/schemas/PollVoteChangedEvent","poll.vote_removed":"#/components/schemas/PollVoteRemovedEvent","reaction.deleted":"#/components/schemas/ReactionDeletedEvent","reaction.new":"#/components/schemas/ReactionNewEvent","reaction.updated":"#/components/schemas/ReactionUpdatedEvent","reminder.created":"#/components/schemas/ReminderCreatedEvent","reminder.deleted":"#/components/schemas/ReminderDeletedEvent","reminder.updated":"#/components/schemas/ReminderUpdatedEvent","thread.updated":"#/components/schemas/ThreadUpdatedEvent","typing.start":"#/components/schemas/TypingStartEvent","typing.stop":"#/components/schemas/TypingStopEvent","user.banned":"#/components/schemas/UserBannedEvent","user.deactivated":"#/components/schemas/UserDeactivatedEvent","user.deleted":"#/components/schemas/UserDeletedEvent","user.messages.deleted":"#/components/schemas/UserMessagesDeletedEvent","user.muted":"#/components/schemas/UserMutedEvent","user.presence.changed":"#/components/schemas/UserPresenceChangedEvent","user.reactivated":"#/components/schemas/UserReactivatedEvent","user.unbanned":"#/components/schemas/UserUnbannedEvent","user.updated":"#/components/schemas/UserUpdatedEvent","user.watching.start":"#/components/schemas/UserWatchingStartEvent","user.watching.stop":"#/components/schemas/UserWatchingStopEvent"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/AIIndicatorClearEvent"},{"$ref":"#/components/schemas/AIIndicatorStopEvent"},{"$ref":"#/components/schemas/AIIndicatorUpdateEvent"},{"$ref":"#/components/schemas/ActivityAddedEvent"},{"$ref":"#/components/schemas/ActivityDeletedEvent"},{"$ref":"#/components/schemas/ActivityMarkEvent"},{"$ref":"#/components/schemas/ActivityMarkedEvent"},{"$ref":"#/components/schemas/ActivityPinnedEvent"},{"$ref":"#/components/schemas/ActivityReactionAddedEvent"},{"$ref":"#/components/schemas/ActivityReactionDeletedEvent"},{"$ref":"#/components/schemas/ActivityReactionUpdatedEvent"},{"$ref":"#/components/schemas/ActivityRemovedFromFeedEvent"},{"$ref":"#/components/schemas/ActivityUnpinnedEvent"},{"$ref":"#/components/schemas/ActivityUpdatedEvent"},{"$ref":"#/components/schemas/AnyEvent"},{"$ref":"#/components/schemas/AppUpdatedEvent"},{"$ref":"#/components/schemas/BlockedUserEvent"},{"$ref":"#/components/schemas/BookmarkAddedEvent"},{"$ref":"#/components/schemas/BookmarkDeletedEvent"},{"$ref":"#/components/schemas/BookmarkFolderDeletedEvent"},{"$ref":"#/components/schemas/BookmarkFolderUpdatedEvent"},{"$ref":"#/components/schemas/BookmarkUpdatedEvent"},{"$ref":"#/components/schemas/CallAcceptedEvent"},{"$ref":"#/components/schemas/CallClosedCaptionsFailedEvent"},{"$ref":"#/components/schemas/CallClosedCaptionsStartedEvent"},{"$ref":"#/components/schemas/CallClosedCaptionsStoppedEvent"},{"$ref":"#/components/schemas/CallCreatedEvent"},{"$ref":"#/components/schemas/CallDeletedEvent"},{"$ref":"#/components/schemas/CallEndedEvent"},{"$ref":"#/components/schemas/CallFrameRecordingFailedEvent"},{"$ref":"#/components/schemas/CallFrameRecordingFrameReadyEvent"},{"$ref":"#/components/schemas/CallFrameRecordingStartedEvent"},{"$ref":"#/components/schemas/CallFrameRecordingStoppedEvent"},{"$ref":"#/components/schemas/CallHLSBroadcastingFailedEvent"},{"$ref":"#/components/schemas/CallHLSBroadcastingStartedEvent"},{"$ref":"#/components/schemas/CallHLSBroadcastingStoppedEvent"},{"$ref":"#/components/schemas/CallLiveStartedEvent"},{"$ref":"#/components/schemas/CallMemberAddedEvent"},{"$ref":"#/components/schemas/CallMemberRemovedEvent"},{"$ref":"#/components/schemas/CallMemberUpdatedEvent"},{"$ref":"#/components/schemas/CallMemberUpdatedPermissionEvent"},{"$ref":"#/components/schemas/CallMissedEvent"},{"$ref":"#/components/schemas/CallModerationBlurEvent"},{"$ref":"#/components/schemas/CallModerationWarningEvent"},{"$ref":"#/components/schemas/CallNotificationEvent"},{"$ref":"#/components/schemas/CallReactionEvent"},{"$ref":"#/components/schemas/CallRecordingFailedEvent"},{"$ref":"#/components/schemas/CallRecordingReadyEvent"},{"$ref":"#/components/schemas/CallRecordingStartedEvent"},{"$ref":"#/components/schemas/CallRecordingStoppedEvent"},{"$ref":"#/components/schemas/CallRejectedEvent"},{"$ref":"#/components/schemas/CallRingEvent"},{"$ref":"#/components/schemas/CallRtmpBroadcastFailedEvent"},{"$ref":"#/components/schemas/CallRtmpBroadcastStartedEvent"},{"$ref":"#/components/schemas/CallRtmpBroadcastStoppedEvent"},{"$ref":"#/components/schemas/CallSessionEndedEvent"},{"$ref":"#/components/schemas/CallSessionParticipantCountsUpdatedEvent"},{"$ref":"#/components/schemas/CallSessionParticipantJoinedEvent"},{"$ref":"#/components/schemas/CallSessionParticipantLeftEvent"},{"$ref":"#/components/schemas/CallSessionStartedEvent"},{"$ref":"#/components/schemas/CallStatsReportReadyEvent"},{"$ref":"#/components/schemas/CallTranscriptionFailedEvent"},{"$ref":"#/components/schemas/CallTranscriptionReadyEvent"},{"$ref":"#/components/schemas/CallTranscriptionStartedEvent"},{"$ref":"#/components/schemas/CallTranscriptionStoppedEvent"},{"$ref":"#/components/schemas/CallUpdatedEvent"},{"$ref":"#/components/schemas/CallUserFeedbackSubmittedEvent"},{"$ref":"#/components/schemas/CallUserMutedEvent"},{"$ref":"#/components/schemas/ChannelCreatedEvent"},{"$ref":"#/components/schemas/ChannelDeletedEvent"},{"$ref":"#/components/schemas/ChannelFrozenEvent"},{"$ref":"#/components/schemas/ChannelHiddenEvent"},{"$ref":"#/components/schemas/ChannelKickedEvent"},{"$ref":"#/components/schemas/ChannelTruncatedEvent"},{"$ref":"#/components/schemas/ChannelUnFrozenEvent"},{"$ref":"#/components/schemas/ChannelUpdatedEvent"},{"$ref":"#/components/schemas/ChannelVisibleEvent"},{"$ref":"#/components/schemas/ClosedCaptionEvent"},{"$ref":"#/components/schemas/CommentAddedEvent"},{"$ref":"#/components/schemas/CommentDeletedEvent"},{"$ref":"#/components/schemas/CommentReactionAddedEvent"},{"$ref":"#/components/schemas/CommentReactionDeletedEvent"},{"$ref":"#/components/schemas/CommentReactionUpdatedEvent"},{"$ref":"#/components/schemas/CommentUpdatedEvent"},{"$ref":"#/components/schemas/ConnectedEvent"},{"$ref":"#/components/schemas/ConnectionErrorEvent"},{"$ref":"#/components/schemas/CustomVideoEvent"},{"$ref":"#/components/schemas/DraftDeletedEvent"},{"$ref":"#/components/schemas/DraftUpdatedEvent"},{"$ref":"#/components/schemas/FeedCreatedEvent"},{"$ref":"#/components/schemas/FeedDeletedEvent"},{"$ref":"#/components/schemas/FeedGroupChangedEvent"},{"$ref":"#/components/schemas/FeedGroupDeletedEvent"},{"$ref":"#/components/schemas/FeedMemberAddedEvent"},{"$ref":"#/components/schemas/FeedMemberRemovedEvent"},{"$ref":"#/components/schemas/FeedMemberUpdatedEvent"},{"$ref":"#/components/schemas/FeedUpdatedEvent"},{"$ref":"#/components/schemas/FollowCreatedEvent"},{"$ref":"#/components/schemas/FollowDeletedEvent"},{"$ref":"#/components/schemas/FollowUpdatedEvent"},{"$ref":"#/components/schemas/HealthCheckEvent"},{"$ref":"#/components/schemas/KickedUserEvent"},{"$ref":"#/components/schemas/MemberAddedEvent"},{"$ref":"#/components/schemas/MemberRemovedEvent"},{"$ref":"#/components/schemas/MemberUpdatedEvent"},{"$ref":"#/components/schemas/MessageDeletedEvent"},{"$ref":"#/components/schemas/MessageNewEvent"},{"$ref":"#/components/schemas/MessageNewEvent"},{"$ref":"#/components/schemas/MessageReadEvent"},{"$ref":"#/components/schemas/MessageUndeletedEvent"},{"$ref":"#/components/schemas/MessageUpdatedEvent"},{"$ref":"#/components/schemas/ModerationCustomActionEvent"},{"$ref":"#/components/schemas/ModerationFlaggedEvent"},{"$ref":"#/components/schemas/ModerationMarkReviewedEvent"},{"$ref":"#/components/schemas/NotificationAddedToChannelEvent"},{"$ref":"#/components/schemas/NotificationChannelDeletedEvent"},{"$ref":"#/components/schemas/NotificationChannelMutesUpdatedEvent"},{"$ref":"#/components/schemas/NotificationChannelTruncatedEvent"},{"$ref":"#/components/schemas/NotificationFeedUpdatedEvent"},{"$ref":"#/components/schemas/NotificationInviteAcceptedEvent"},{"$ref":"#/components/schemas/NotificationInviteRejectedEvent"},{"$ref":"#/components/schemas/NotificationInvitedEvent"},{"$ref":"#/components/schemas/NotificationMarkReadEvent"},{"$ref":"#/components/schemas/NotificationMarkUnreadEvent"},{"$ref":"#/components/schemas/NotificationMutesUpdatedEvent"},{"$ref":"#/components/schemas/NotificationNewMessageEvent"},{"$ref":"#/components/schemas/NotificationRemovedFromChannelEvent"},{"$ref":"#/components/schemas/PendingMessageEvent"},{"$ref":"#/components/schemas/PermissionRequestEvent"},{"$ref":"#/components/schemas/PollClosedEvent"},{"$ref":"#/components/schemas/PollClosedFeedEvent"},{"$ref":"#/components/schemas/PollDeletedEvent"},{"$ref":"#/components/schemas/PollDeletedFeedEvent"},{"$ref":"#/components/schemas/PollUpdatedEvent"},{"$ref":"#/components/schemas/PollUpdatedFeedEvent"},{"$ref":"#/components/schemas/PollVoteCastedEvent"},{"$ref":"#/components/schemas/PollVoteCastedFeedEvent"},{"$ref":"#/components/schemas/PollVoteChangedEvent"},{"$ref":"#/components/schemas/PollVoteChangedFeedEvent"},{"$ref":"#/components/schemas/PollVoteRemovedEvent"},{"$ref":"#/components/schemas/PollVoteRemovedFeedEvent"},{"$ref":"#/components/schemas/ReactionDeletedEvent"},{"$ref":"#/components/schemas/ReactionNewEvent"},{"$ref":"#/components/schemas/ReactionUpdatedEvent"},{"$ref":"#/components/schemas/ReminderCreatedEvent"},{"$ref":"#/components/schemas/ReminderDeletedEvent"},{"$ref":"#/components/schemas/ReminderNotificationEvent"},{"$ref":"#/components/schemas/ReminderUpdatedEvent"},{"$ref":"#/components/schemas/ThreadUpdatedEvent"},{"$ref":"#/components/schemas/TypingStartEvent"},{"$ref":"#/components/schemas/TypingStopEvent"},{"$ref":"#/components/schemas/UnblockedUserEvent"},{"$ref":"#/components/schemas/UpdatedCallPermissionsEvent"},{"$ref":"#/components/schemas/UserBannedEvent"},{"$ref":"#/components/schemas/UserDeactivatedEvent"},{"$ref":"#/components/schemas/UserDeletedEvent"},{"$ref":"#/components/schemas/UserMessagesDeletedEvent"},{"$ref":"#/components/schemas/UserMutedEvent"},{"$ref":"#/components/schemas/UserPresenceChangedEvent"},{"$ref":"#/components/schemas/UserReactivatedEvent"},{"$ref":"#/components/schemas/UserUnbannedEvent"},{"$ref":"#/components/schemas/UserUpdatedEvent"},{"$ref":"#/components/schemas/UserWatchingStartEvent"},{"$ref":"#/components/schemas/UserWatchingStopEvent"}]},"WrappedUnreadCountsResponse":{"description":"Basic response information","nullable":true,"properties":{"channel_type":{"items":{"$ref":"#/components/schemas/UnreadCountsChannelType"},"type":"array","x-stream-index":"001.005"},"channels":{"items":{"$ref":"#/components/schemas/UnreadCountsChannel"},"type":"array","x-stream-index":"001.004"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"threads":{"items":{"$ref":"#/components/schemas/UnreadCountsThread"},"type":"array","x-stream-index":"001.006"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"001.001"},"total_unread_count_by_team":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001.003"},"total_unread_threads_count":{"format":"int32","type":"integer","x-stream-index":"001.002"}},"required":["total_unread_count","total_unread_threads_count","channels","channel_type","threads","duration"],"title":"Response","type":"object"}},"securitySchemes":{"JWT":{"description":"JWT should be always provided when stream-auth-type=jwt.\n\nUsing JWT auth request could be authenticated as user or as server-side.\n\nWhen using user authentication permission checking is going to be applied to requests based on the user that is\nperforming a request.\n\nThe `authorization` header should be a JWT string signed using the secret attached to the API key used to perform\nrequests.\n\n**WARNING** all client-side official SDK do not ship with token generation; this is to make sure that the API secret is not\nshared with an untrusted party such as a browser or a iOS/Android application. Tokens **must** be generated server-side.\nIf you wish, you can configure your application to ignore authentication (see `disable_auth_check`)\nThe JWT string must include only the user_id claim and can include any built-in JWT claim such as iat, exp as well.\n","in":"header","name":"Authorization","type":"apiKey"},"api_key":{"description":"Application API key should be always set in order to authenticate the request.","in":"query","name":"api_key","type":"apiKey"},"stream-auth-type":{"description":"Stream-Auth-Type should be always set in order to authenticate the request. Possible\nvalues: `jwt` or `anonymous`.\n\n`jwt` allows you to authenticate as a user. With this auth type you should also provide valid JWT in Authorization\nheader.\n\n`anonymous` allows you to authenticate as anonymous user. Please note that most advanced features are not available\nto anonymous users.","in":"header","name":"Stream-Auth-Type","type":"apiKey"}}},"info":{"title":"Stream API","version":"v191.1.0"},"openapi":"3.0.3","paths":{"/api/v2/app":{"get":{"description":"This Method returns the application settings\n","operationId":"GetApp","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetApplicationResponse"}}},"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":"Get App Settings","tags":["product:common"]}},"/api/v2/blocklists":{"get":{"description":"Returns all available block lists\n","operationId":"ListBlockLists","parameters":[{"in":"query","name":"team","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListBlockListResponse"}}},"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":"List block lists","tags":["product:common"]},"post":{"description":"Creates a new application blocklist, once created the blocklist can be used by any channel type\n","operationId":"CreateBlockList","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBlockListRequest"}}},"description":"Block list","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBlockListResponse"}}},"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":"Create block list","tags":["product:common"]}},"/api/v2/blocklists/{name}":{"delete":{"description":"Deletes previously created application blocklist\n","operationId":"DeleteBlockList","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"team","schema":{"type":"string","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete block list","tags":["product:common"]},"put":{"description":"Updates contents of the block list\n","operationId":"UpdateBlockList","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Block list name","title":"Name","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBlockListRequest"}}},"description":"Update block list","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBlockListResponse"}}},"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":"Update block list","tags":["product:common"]}},"/api/v2/chat/channels":{"post":{"description":"Query channels with filter query\n","operationId":"QueryChannels","parameters":[{"in":"query","name":"connection_id","schema":{"description":"Websocket connection ID to interact with. You can pass it as Body or URL parameter","title":"Connection ID","type":"string","x-stream-index":"011.003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryChannelsRequest"}}},"description":"Query Channels Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryChannelsResponse"}}},"description":"Channels list"},"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":"Query channels","tags":["product:chat"]}},"/api/v2/chat/channels/delete":{"post":{"description":"Allows to delete several channels at once asynchronously\n\nSends events:\n- channel.deleted\n- channel.deleted\n","operationId":"DeleteChannels","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteChannelsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteChannelsResponse"}}},"description":"Successful 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":"Deletes channels asynchronously","tags":["product:chat"]}},"/api/v2/chat/channels/read":{"post":{"description":"Marks channels as read up to the specific message. If no channels is given, mark all channel as read\n\nSends events:\n- message.read\n- message.read\n","operationId":"MarkChannelsRead","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkChannelsReadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkReadResponse"}}},"description":"Successful 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 channels as read","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/query":{"post":{"description":"This Method creates a channel or returns an existing one with matching attributes\n\nSends events:\n- channel.created\n- member.added\n- member.removed\n- member.updated\n- user.watching.start\n","operationId":"GetOrCreateDistinctChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"connection_id","schema":{"description":"Websocket connection ID to interact with. You can pass it as Body or URL parameter","title":"Connection ID","type":"string","x-stream-index":"012.003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelGetOrCreateRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelStateResponse"}}},"description":"Successful 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":"Get or create channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}":{"delete":{"description":"Deletes channel\n\nSends events:\n- channel.deleted\n- channel.deleted\n","operationId":"DeleteChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"query","name":"hard_delete","schema":{"type":"boolean","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteChannelResponse"}}},"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":"Delete channel","tags":["product:chat"]},"patch":{"description":"Updates certain fields of the channel\n\nSends events:\n- channel.updated\n- channel.updated\n","operationId":"UpdateChannelPartial","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelPartialRequest"}}},"description":"UpdateChannelPartialRequest","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelPartialResponse"}}},"description":"Successful 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":"Partially update channel","tags":["product:chat"]},"post":{"description":"Change channel data\n\nSends events:\n- channel.updated\n- member.added\n- member.removed\n- member.updated\n- message.new\n- channel.updated\n- member.added\n- member.removed\n- member.updated\n- message.new\n","operationId":"UpdateChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"013.002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"013.002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelRequest"}}},"description":"Channel update request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelResponse"}}},"description":"Successful 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":"Update channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/draft":{"delete":{"description":"Deletes a draft\n\nSends events:\n- draft.deleted\n","operationId":"DeleteDraft","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"parent_id","schema":{"description":"Parent message ID","title":"string","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete draft","tags":["product:chat"]},"get":{"description":"Get a draft\n","operationId":"GetDraft","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"parent_id","schema":{"description":"Parent message ID","title":"string","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetDraftResponse"}}},"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":"Get draft","tags":["product:chat"]},"post":{"description":"Creates a draft\n\nSends events:\n- draft.updated\n","operationId":"CreateDraft","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDraftRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDraftResponse"}}},"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":"Create a draft","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/event":{"post":{"description":"Sends event to the channel\n","operationId":"SendEvent","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendEventRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventResponse"}}},"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":"Send event","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/file":{"delete":{"description":"Deletes previously uploaded file\n","operationId":"DeleteFile","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of file","title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"File ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"url","schema":{"description":"File URL to delete","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete file","tags":["product:chat"]},"post":{"description":"Uploads file\n","operationId":"UploadFile","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/FileUploadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileUploadResponse"}}},"description":"Successful 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":"Upload file","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/hide":{"post":{"description":"Marks channel as hidden for current user\n\nSends events:\n- channel.hidden\n- channel.hidden\n","operationId":"HideChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HideChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HideChannelResponse"}}},"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":"Hide channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/image":{"delete":{"description":"Deletes previously uploaded image\n","operationId":"DeleteImage","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of file","title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"File ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"url","schema":{"description":"File URL to delete","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete image","tags":["product:chat"]},"post":{"description":"Uploads image\n","operationId":"UploadImage","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.001.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.001.002"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/ImageUploadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageUploadResponse"}}},"description":"Successful 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":"Upload image","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/member":{"patch":{"description":"\n","operationId":"UpdateMemberPartial","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMemberPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMemberPartialResponse"}}},"description":"Successful 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":"Partially channel member update","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/message":{"post":{"description":"Sends new message to the specified channel\n\nSends events:\n- message.new\n- message.updated\n- message.new\n- message.updated\n","operationId":"SendMessage","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"009.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"009.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendMessageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendMessageResponse"}}},"description":"Successful 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":"Send new message","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/messages":{"get":{"description":"Returns list messages found by IDs\n","operationId":"GetManyMessages","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"ids","required":true,"schema":{"description":"List of comma-separated IDs","items":{"type":"string"},"maximum":50,"minimum":1,"title":"IDs","type":"array","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetManyMessagesResponse"}}},"description":"Successful 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":"Get many messages","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/query":{"post":{"description":"This Method creates a channel or returns an existing one with matching attributes\n\nSends events:\n- channel.created\n- member.added\n- member.removed\n- member.updated\n- user.watching.start\n","operationId":"GetOrCreateChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID (maximum length of 64 characters)","title":"ID","type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"connection_id","schema":{"description":"Websocket connection ID to interact with. You can pass it as Body or URL parameter","title":"Connection ID","type":"string","x-stream-index":"012.003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelGetOrCreateRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelStateResponse"}}},"description":"Successful 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":"Get or create channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/read":{"post":{"description":"Marks channel as read up to the specific message\n\nSends events:\n- message.read\n- message.read\n","operationId":"MarkRead","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkReadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkReadResponse"}}},"description":"Successful 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 read","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/show":{"post":{"description":"Shows previously hidden channel\n\nSends events:\n- channel.visible\n- channel.visible\n","operationId":"ShowChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShowChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShowChannelResponse"}}},"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":"Show channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/stop-watching":{"post":{"description":"Call this Method to stop receiving channel events\n\nSends events:\n- user.watching.stop\n- user.watching.stop\n","operationId":"StopWatchingChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"connection_id","schema":{"type":"string","x-stream-index":"001.003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelStopWatchingRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Stop watching channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/truncate":{"post":{"description":"Truncates messages from a channel. Can be applied to the entire channel or scoped to specific members.\n\nSends events:\n- channel.truncated\n- channel.truncated\n","operationId":"TruncateChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TruncateChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TruncateChannelResponse"}}},"description":"Successful 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":"Truncate channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/unread":{"post":{"description":"Marks channel as unread from a specific message\n","operationId":"MarkUnread","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkUnreadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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 unread","tags":["product:chat"]}},"/api/v2/chat/drafts/query":{"post":{"description":"Queries draft messages for a user\n","operationId":"QueryDrafts","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryDraftsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryDraftsResponse"}}},"description":"Successful 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":"Query draft messages","tags":["product:chat"]}},"/api/v2/chat/members":{"get":{"description":"Find and filter channel members\n","operationId":"QueryMembers","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryMembersPayload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MembersResponse"}}},"description":"Successful 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":"Query members","tags":["product:chat"]}},"/api/v2/chat/messages/{id}":{"delete":{"description":"Deletes message\n\nSends events:\n- message.deleted\n- message.deleted\n","operationId":"DeleteMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID to delete","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"hard","schema":{"description":"Delete all message reactions and replies as well","title":"Hard","type":"boolean","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"deleted_by","schema":{"type":"string","writeOnly":true,"x-stream-index":"003"}},{"in":"query","name":"delete_for_me","schema":{"description":"Delete the message only for the user making the request","title":"Delete for me","type":"boolean","writeOnly":true,"x-stream-index":"004"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteMessageResponse"}}},"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":"Delete message","tags":["product:chat"]},"get":{"description":"Returns message by ID\n","operationId":"GetMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"ID of the message","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetMessageResponse"}}},"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":"Get message","tags":["product:chat"]},"post":{"description":"Updates message with new data\n\nSends events:\n- message.updated\n- message.updated\n","operationId":"UpdateMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"004.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessageResponse"}}},"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":"Update message","tags":["product:chat"]},"put":{"description":"Updates certain fields of the message\n\nSends events:\n- message.updated\n- message.updated\n","operationId":"UpdateMessagePartial","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessagePartialRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessagePartialResponse"}}},"description":"Successful 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":"Partially message update","tags":["product:chat"]}},"/api/v2/chat/messages/{id}/action":{"post":{"description":"Executes message command action with given parameters\n\nSends events:\n- message.new\n- message.new\n","operationId":"RunMessageAction","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageActionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}},"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":"Run message command action","tags":["product:chat"]}},"/api/v2/chat/messages/{id}/reaction":{"post":{"description":"Sends reaction to specified message\n\nSends events:\n- reaction.new\n- reaction.updated\n","operationId":"SendReaction","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID to send reaction for","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendReactionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendReactionResponse"}}},"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":"Send reaction","tags":["product:chat"]}},"/api/v2/chat/messages/{id}/reaction/{type}":{"delete":{"description":"Removes user reaction from the message\n\nSends events:\n- reaction.deleted\n","operationId":"DeleteReaction","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID to remove reaction from","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"type","required":true,"schema":{"description":"Reaction type to remove","title":"Type","type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"description":"**Server-side only**. User ID which server acts upon","title":"User ID","type":"string","writeOnly":true,"x-stream-index":"003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteReactionResponse"}}},"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":"Delete reaction","tags":["product:chat"]}},"/api/v2/chat/messages/{id}/reactions":{"get":{"description":"Returns list of reactions of specific message\n","operationId":"GetReactions","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"limit","schema":{"description":"Number of records to return","format":"int32","title":"Limit","type":"integer","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"offset","schema":{"description":"Number of records to offset","format":"int32","title":"Offset","type":"integer","writeOnly":true,"x-stream-index":"003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetReactionsResponse"}}},"description":"Successful 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":"Get reactions","tags":["product:chat"]},"post":{"description":"Get reactions on a message\n","operationId":"QueryReactions","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryReactionsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryReactionsResponse"}}},"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"}},"tags":["product:chat"]}},"/api/v2/chat/messages/{id}/translate":{"post":{"description":"Translates message to a given language using automated translation software\n\nSends events:\n- message.updated\n- message.updated\n","operationId":"TranslateMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TranslateMessageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}},"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":"Translate message","tags":["product:chat"]}},"/api/v2/chat/messages/{message_id}/polls/{poll_id}/vote":{"post":{"description":"Cast a vote on a poll\n\nSends events:\n- feeds.poll.vote_casted\n- feeds.poll.vote_changed\n- feeds.poll.vote_removed\n- poll.vote_casted\n- poll.vote_changed\n- poll.vote_removed\n","operationId":"CastPollVote","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CastPollVoteRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollVoteResponse"}}},"description":"Successful 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":"Cast vote","tags":["product:chat"]}},"/api/v2/chat/messages/{message_id}/polls/{poll_id}/vote/{vote_id}":{"delete":{"description":"Delete a vote from a poll\n\nSends events:\n- feeds.poll.vote_removed\n- poll.vote_removed\n","operationId":"DeletePollVote","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"004"}},{"in":"path","name":"vote_id","required":true,"schema":{"description":"Vote ID","maxLength":255,"title":"string","type":"string","x-stream-index":"005"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollVoteResponse"}}},"description":"Successful 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":"Delete vote","tags":["product:chat"]}},"/api/v2/chat/messages/{message_id}/reminders":{"delete":{"description":"Deletes a user's created reminder\n\nSends events:\n- reminder.deleted\n","operationId":"DeleteReminder","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteReminderResponse"}}},"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":"Delete reminder","tags":["product:chat"]},"patch":{"description":"Updates an existing reminder\n\nSends events:\n- reminder.updated\n","operationId":"UpdateReminder","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateReminderRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateReminderResponse"}}},"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":"Updates Reminder","tags":["product:chat"]},"post":{"description":"Creates a new reminder\n\nSends events:\n- reminder.created\n","operationId":"CreateReminder","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateReminderRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReminderResponseData"}}},"description":"Successful 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":"Create reminder","tags":["product:chat"]}},"/api/v2/chat/messages/{parent_id}/replies":{"get":{"description":"Returns replies (thread) of the message\n","operationId":"GetReplies","parameters":[{"in":"path","name":"parent_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"sort","schema":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":1,"type":"array","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"limit","schema":{"description":"The maximum number of messages to return (max limit ","format":"int32","minimum":0,"title":"Limit","type":"integer","x-stream-index":"003.001"}},{"in":"query","name":"offset","schema":{"description":"The offset to start from","format":"int32","title":"Offset","type":"integer","x-stream-index":"003.002"}},{"in":"query","name":"id_gte","schema":{"description":"The ID of the message to get messages with a timestamp greater than or equal to","title":"IDGTE","type":"string","x-stream-index":"003.003"}},{"in":"query","name":"id_gt","schema":{"description":"The ID of the message to get messages with a timestamp greater than","title":"IDGT","type":"string","x-stream-index":"003.004"}},{"in":"query","name":"id_lte","schema":{"description":"The ID of the message to get messages with a timestamp smaller than or equal to","title":"IDLTE","type":"string","x-stream-index":"003.005"}},{"in":"query","name":"id_lt","schema":{"description":"The ID of the message to get messages with a timestamp smaller than","title":"IDLT","type":"string","x-stream-index":"003.006"}},{"in":"query","name":"created_at_after_or_equal","schema":{"description":"The timestamp to get messages with a created_at timestamp greater than or equal to","format":"date-time","title":"Created_at after or equal","type":"number","x-stream-index":"003.007"}},{"in":"query","name":"created_at_after","schema":{"description":"The timestamp to get messages with a created_at timestamp greater than","format":"date-time","title":"Created_at after","type":"number","x-stream-index":"003.008"}},{"in":"query","name":"created_at_before_or_equal","schema":{"description":"The timestamp to get messages with a created_at timestamp smaller than or equal to","format":"date-time","title":"Created_at after before or equal","type":"number","x-stream-index":"003.009"}},{"in":"query","name":"created_at_before","schema":{"description":"The timestamp to get messages with a created_at timestamp smaller than","format":"date-time","title":"Created_at after before","type":"number","x-stream-index":"003.010"}},{"in":"query","name":"id_around","schema":{"description":"The result will be a set of messages, that are both older and newer than the message with the provided ID, and the message with the ID provided will be in the middle of the set","title":"Id around","type":"string","x-stream-index":"003.011"}},{"in":"query","name":"created_at_around","schema":{"description":"The result will be a set of messages, that are both older and newer than the created_at timestamp provided, distributed evenly around the timestamp","format":"date-time","title":"Created_at around","type":"number","x-stream-index":"003.012"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRepliesResponse"}}},"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":"Get replies","tags":["product:chat"]}},"/api/v2/chat/moderation/flags/message":{"get":{"description":"Find and filter message flags\n","operationId":"QueryMessageFlags","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryMessageFlagsPayload","description":"JSON object with query message flags payload","title":"Payload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryMessageFlagsResponse"}}},"description":"QueryMessageFlagsResponse"},"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":"Query Message Flags","tags":["product:chat"]}},"/api/v2/chat/moderation/mute/channel":{"post":{"description":"Mutes channel for user\n\nSends events:\n- channel.muted\n- channel.muted\n","operationId":"MuteChannel","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteChannelResponse"}}},"description":"Successful 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":"Mute channel","tags":["product:chat"]}},"/api/v2/chat/moderation/unmute/channel":{"post":{"description":"Unmutes channel for user\n\nSends events:\n- channel.unmuted\n- channel.unmuted\n","operationId":"UnmuteChannel","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnmuteChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnmuteResponse"}}},"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":"Unmute channel","tags":["product:chat"]}},"/api/v2/chat/push_preferences":{"post":{"description":"Update the push preferences for a user and or channel member. Set to all, mentions or none\n","operationId":"UpdatePushNotificationPreferences","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertPushPreferencesRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertPushPreferencesResponse"}}},"description":"Successful 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":"Push notification preferences","tags":["product:chat"]}},"/api/v2/chat/query_banned_users":{"get":{"description":"Find and filter channel scoped or global user bans\n","operationId":"QueryBannedUsers","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryBannedUsersPayload","description":"JSON object with query user bans payload","title":"Payload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryBannedUsersResponse"}}},"description":"Successful 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":"Query Banned Users","tags":["product:chat"]}},"/api/v2/chat/reminders/query":{"post":{"description":"Queries reminders\n","operationId":"QueryReminders","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryRemindersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryRemindersResponse"}}},"description":"Successful 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":"Query reminders","tags":["product:chat"]}},"/api/v2/chat/search":{"get":{"description":"Search messages across channels\n","operationId":"Search","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchPayload","description":"JSON object with search payload","title":"Payload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchResponse"}}},"description":"Successful 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":"Search messages","tags":["product:chat"]}},"/api/v2/chat/sync":{"post":{"description":"Returns all events happened since client disconnect in specified channels\n","operationId":"Sync","parameters":[{"in":"query","name":"with_inaccessible_cids","schema":{"description":"If set to true this will add 'inaccessible_cids' to response type","title":"With inaccessible CIDs","type":"boolean","x-stream-index":"003"}},{"in":"query","name":"watch","schema":{"description":"If set to true this will start watching requested and newly added channels that user has access to. If error occurred with this option enabled and it is not an input error - channels will still be watched.","title":"Watch synced channels","type":"boolean","x-stream-index":"004"}},{"in":"query","name":"connection_id","schema":{"type":"string","x-stream-index":"006.003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncRequest"}}},"description":"SyncRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncResponse"}}},"description":"SyncResponse"},"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":"Sync","tags":["product:chat"]}},"/api/v2/chat/threads":{"post":{"description":"Returns the list of threads for specific user\n","operationId":"QueryThreads","parameters":[{"in":"query","name":"connection_id","schema":{"type":"string","x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryThreadsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryThreadsResponse"}}},"description":"Successful 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":"Query Threads","tags":["product:chat"]}},"/api/v2/chat/threads/{message_id}":{"get":{"description":"Return a specific thread\n","operationId":"GetThread","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"watch","schema":{"description":"Start watching the channel this thread belongs to","title":"Watch","type":"boolean","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"connection_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"003"}},{"in":"query","name":"reply_limit","schema":{"description":"Limit the number of replies returned","format":"int32","minimum":0,"title":"Reply limit","type":"integer","writeOnly":true,"x-stream-index":"004"}},{"in":"query","name":"participant_limit","schema":{"description":"Limit the number of participants returned","format":"int32","maximum":100,"minimum":0,"title":"Participant limit","type":"integer","writeOnly":true,"x-stream-index":"005"}},{"in":"query","name":"member_limit","schema":{"description":"Limit the number of members returned per thread channel","format":"int32","maximum":100,"minimum":0,"title":"Member limit","type":"integer","writeOnly":true,"x-stream-index":"006"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetThreadResponse"}}},"description":"Successful 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":"Get Thread","tags":["product:chat"]},"patch":{"description":"Updates certain fields of the thread\n\nSends events:\n- thread.updated\n- thread.updated\n","operationId":"UpdateThreadPartial","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateThreadPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateThreadPartialResponse"}}},"description":"Successful 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":"Partially update thread","tags":["product:chat"]}},"/api/v2/chat/unread":{"get":{"description":"Fetch unread counts for a single user\n","operationId":"UnreadCounts","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WrappedUnreadCountsResponse"}}},"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":"Unread counts","tags":["product:chat"]}},"/api/v2/devices":{"delete":{"description":"Deletes one device\n","operationId":"DeleteDevice","parameters":[{"in":"query","name":"id","required":true,"schema":{"description":"Device ID to delete","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete device","tags":["product:common"]},"get":{"description":"Returns all available devices\n","operationId":"ListDevices","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDevicesResponse"}}},"description":"ListDevicesResponse"},"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":"List devices","tags":["product:common"]},"post":{"description":"Adds a new device to a user, if the same device already exists the call will have no effect\n","operationId":"CreateDevice","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDeviceRequest"}}},"description":"CreateDeviceRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Create device","tags":["product:common"]}},"/api/v2/feeds/activities":{"post":{"description":"Create a new activity or update an existing one\n","operationId":"AddActivity","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddActivityRequest"}}},"description":"Activity Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddActivityResponse"}}},"description":"Add Activity 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":"Add a single activity","tags":["product:feeds"]}},"/api/v2/feeds/activities/batch":{"post":{"description":"Create new activities or update existing ones in a batch operation\n","operationId":"UpsertActivities","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertActivitiesRequest"}}},"description":"Upsert Activities Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertActivitiesResponse"}}},"description":"Upsert Activities 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":"Upsert multiple activities","tags":["product:feeds"]}},"/api/v2/feeds/activities/delete":{"post":{"description":"Delete one or more activities by their IDs\n","operationId":"DeleteActivities","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteActivitiesRequest"}}},"description":"Delete Activities Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteActivitiesResponse"}}},"description":"Delete Activities 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":"Remove multiple activities","tags":["product:feeds"]}},"/api/v2/feeds/activities/query":{"post":{"description":"Query activities based on filters with pagination and sorting options\n","operationId":"QueryActivities","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryActivitiesRequest"}}},"description":"Query Activities Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryActivitiesResponse"}}},"description":"Query Activities 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":"Query activities","tags":["product:feeds"]}},"/api/v2/feeds/activities/{activity_id}/bookmarks":{"delete":{"description":"Deletes a bookmark from an activity\n","operationId":"DeleteBookmark","parameters":[{"in":"path","name":"activity_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"folder_id","schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteBookmarkResponse"}}},"description":"Delete Bookmark 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":"Delete a bookmark","tags":["product:feeds"]},"patch":{"description":"Updates a bookmark for an activity\n","operationId":"UpdateBookmark","parameters":[{"in":"path","name":"activity_id","required":true,"schema":{"description":"ID of the activity","maxLength":255,"title":"Activity ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBookmarkRequest"}}},"description":"Update Bookmark Request","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBookmarkResponse"}}},"description":"Update Bookmark 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":"Update bookmark","tags":["product:feeds"]},"post":{"description":"Adds a bookmark to an activity\n","operationId":"AddBookmark","parameters":[{"in":"path","name":"activity_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddBookmarkRequest"}}},"description":"Add Bookmark Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddBookmarkResponse"}}},"description":"Add Bookmark 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":"Add bookmark","tags":["product:feeds"]}},"/api/v2/feeds/activities/{activity_id}/feedback":{"post":{"description":"Submit feedback for an activity including options to show less, hide, report, or mute the user\n","operationId":"ActivityFeedback","parameters":[{"in":"path","name":"activity_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivityFeedbackRequest"}}},"description":"Activity Feedback Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivityFeedbackResponse"}}},"description":"Activity Feedback 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":"Provide feedback on an activity","tags":["product:feeds"]}},"/api/v2/feeds/activities/{activity_id}/polls/{poll_id}/vote":{"post":{"description":"Cast a vote on a poll\n\nSends events:\n- feeds.poll.vote_casted\n- feeds.poll.vote_changed\n- feeds.poll.vote_removed\n- poll.vote_casted\n- poll.vote_changed\n- poll.vote_removed\n","operationId":"CastPollVote","parameters":[{"in":"path","name":"activity_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CastPollVoteRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollVoteResponse"}}},"description":"Successful 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":"Cast vote","tags":["product:feeds"]}},"/api/v2/feeds/activities/{activity_id}/polls/{poll_id}/vote/{vote_id}":{"delete":{"description":"Delete a vote from a poll\n\nSends events:\n- feeds.poll.vote_removed\n- poll.vote_removed\n","operationId":"DeletePollVote","parameters":[{"in":"path","name":"activity_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003"}},{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"004"}},{"in":"path","name":"vote_id","required":true,"schema":{"description":"Vote ID","maxLength":255,"title":"string","type":"string","x-stream-index":"005"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollVoteResponse"}}},"description":"Successful 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":"Delete vote","tags":["product:feeds"]}},"/api/v2/feeds/activities/{activity_id}/reactions":{"post":{"description":"Adds a reaction to an activity\n","operationId":"AddReaction","parameters":[{"in":"path","name":"activity_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddReactionRequest"}}},"description":"Add Reaction Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddReactionResponse"}}},"description":"Add Reaction 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":"Add reaction","tags":["product:feeds"]}},"/api/v2/feeds/activities/{activity_id}/reactions/query":{"post":{"description":"Query activity reactions\n","operationId":"QueryActivityReactions","parameters":[{"in":"path","name":"activity_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryActivityReactionsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryActivityReactionsResponse"}}},"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":"Query activity reactions","tags":["product:feeds"]}},"/api/v2/feeds/activities/{activity_id}/reactions/{type}":{"delete":{"description":"Removes a reaction from an activity\n","operationId":"DeleteActivityReaction","parameters":[{"in":"path","name":"activity_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"type","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteActivityReactionResponse"}}},"description":"Delete Activity Reaction 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":"Remove reaction","tags":["product:feeds"]}},"/api/v2/feeds/activities/{id}":{"delete":{"description":"Delete a single activity by its ID\n","operationId":"DeleteActivity","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"hard_delete","schema":{"description":"Whether to permanently delete the activity instead of soft delete","title":"boolean","type":"boolean","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteActivityResponse"}}},"description":"Delete Activity 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":"Delete a single activity","tags":["product:feeds"]},"get":{"description":"Returns activity by ID\n","operationId":"GetActivity","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetActivityResponse"}}},"description":"Get Activity 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":"Get activity","tags":["product:feeds"]},"patch":{"description":"Updates certain fields of the activity\n\nSends events:\n- feeds.activity.updated\n","operationId":"UpdateActivityPartial","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateActivityPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateActivityPartialResponse"}}},"description":"Successful 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":"Partially activity update","tags":["product:feeds"]},"put":{"description":"Replaces an activity with the provided data\n\nSends events:\n- feeds.activity.updated\n","operationId":"UpdateActivity","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateActivityRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateActivityResponse"}}},"description":"Successful 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":"Full activity update","tags":["product:feeds"]}},"/api/v2/feeds/bookmark_folders/query":{"post":{"description":"Query bookmark folders with filter query\n","operationId":"QueryBookmarkFolders","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryBookmarkFoldersRequest"}}},"description":"Query Bookmark Folders Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryBookmarkFoldersResponse"}}},"description":"Query Bookmark Folders 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":"Query bookmark folders","tags":["product:feeds"]}},"/api/v2/feeds/bookmark_folders/{folder_id}":{"delete":{"description":"Delete a bookmark folder by its ID\n","operationId":"DeleteBookmarkFolder","parameters":[{"in":"path","name":"folder_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteBookmarkFolderResponse"}}},"description":"Delete Bookmark Folder 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":"Delete a bookmark folder","tags":["product:feeds"]},"patch":{"description":"Update a bookmark folder by its ID\n","operationId":"UpdateBookmarkFolder","parameters":[{"in":"path","name":"folder_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBookmarkFolderRequest"}}},"description":"Update Bookmark Folder Request","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBookmarkFolderResponse"}}},"description":"Update Bookmark Folder 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":"Update a bookmark folder","tags":["product:feeds"]}},"/api/v2/feeds/bookmarks/query":{"post":{"description":"Query bookmarks with filter query\n","operationId":"QueryBookmarks","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryBookmarksRequest"}}},"description":"Query Bookmarks Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryBookmarksResponse"}}},"description":"Query Bookmarks 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":"Query bookmarks","tags":["product:feeds"]}},"/api/v2/feeds/comments":{"get":{"description":"Retrieve a threaded list of comments for a specific object (e.g., activity), with configurable depth, sorting, and pagination\n","operationId":"GetComments","parameters":[{"in":"query","name":"object_id","required":true,"schema":{"description":"ID of the object to get comments for","title":"Object ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"object_type","required":true,"schema":{"description":"Type of the object to get comments for","title":"Object Type","type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"depth","schema":{"description":"Maximum nested depth to return (0 = only first level)","format":"int32","maximum":5,"minimum":0,"title":"Max Depth","type":"integer","writeOnly":true,"x-stream-index":"003"}},{"in":"query","name":"sort","schema":{"description":"Sort order for the comments","enum":["first","last","top","best","controversial"],"title":"Sort Order","type":"string","writeOnly":true,"x-stream-index":"004"}},{"in":"query","name":"replies_limit","schema":{"format":"int32","maximum":20,"minimum":0,"type":"integer","writeOnly":true,"x-stream-index":"005"}},{"in":"query","name":"limit","schema":{"description":"Max number of top‑level comments to return","format":"int32","maximum":100,"minimum":0,"title":"Root Limit","type":"integer","writeOnly":true,"x-stream-index":"006.001"}},{"in":"query","name":"prev","schema":{"type":"string","writeOnly":true,"x-stream-index":"006.002"}},{"in":"query","name":"next","schema":{"type":"string","writeOnly":true,"x-stream-index":"006.003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCommentsResponse"}}},"description":"Get Comments 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":"Get comments for an object","tags":["product:feeds"]},"post":{"description":"Adds a comment to an object (e.g., activity) or a reply to an existing comment, and broadcasts appropriate events\n","operationId":"AddComment","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddCommentRequest"}}},"description":"Add Comment Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddCommentResponse"}}},"description":"Add Comment 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":"Add a comment or reply","tags":["product:feeds"]}},"/api/v2/feeds/comments/batch":{"post":{"description":"Adds multiple comments in a single request. Each comment must specify the object type and ID.\n","operationId":"AddCommentsBatch","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddCommentsBatchRequest"}}},"description":"Add Comments Batch Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddCommentsBatchResponse"}}},"description":"Add Comments Batch 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":"Add multiple comments in a batch","tags":["product:feeds"]}},"/api/v2/feeds/comments/query":{"post":{"description":"Query comments using MongoDB-style filters with pagination and sorting options\n","operationId":"QueryComments","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCommentsRequest"}}},"description":"Query Comments Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCommentsResponse"}}},"description":"Query Comments 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":"Query comments","tags":["product:feeds"]}},"/api/v2/feeds/comments/{id}":{"delete":{"description":"Deletes a comment from an object (e.g., activity) and broadcasts appropriate events\n","operationId":"DeleteComment","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"hard_delete","schema":{"description":"Whether to permanently delete the comment instead of soft delete","title":"Hard Delete","type":"boolean","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCommentResponse"}}},"description":"Delete Comment 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":"Delete a comment","tags":["product:feeds"]},"get":{"description":"Get a comment by ID\n","operationId":"GetComment","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCommentResponse"}}},"description":"Get Comment 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":"Get comment","tags":["product:feeds"]},"patch":{"description":"Updates a comment on an object (e.g., activity) and broadcasts appropriate events\n","operationId":"UpdateComment","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCommentRequest"}}},"description":"Update Comment Request","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCommentResponse"}}},"description":"Update Comment 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":"Update a comment","tags":["product:feeds"]}},"/api/v2/feeds/comments/{id}/reactions":{"post":{"description":"Adds a reaction to a comment\n","operationId":"AddCommentReaction","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddCommentReactionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddCommentReactionResponse"}}},"description":"Successful 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":"Add comment reaction","tags":["product:feeds"]}},"/api/v2/feeds/comments/{id}/reactions/query":{"post":{"description":"Query comment reactions\n","operationId":"QueryCommentReactions","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCommentReactionsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCommentReactionsResponse"}}},"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":"Query comment reactions","tags":["product:feeds"]}},"/api/v2/feeds/comments/{id}/reactions/{type}":{"delete":{"description":"Deletes a reaction from a comment\n","operationId":"DeleteCommentReaction","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"type","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCommentReactionResponse"}}},"description":"Delete Comment Reaction 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":"Delete comment reaction","tags":["product:feeds"]}},"/api/v2/feeds/comments/{id}/replies":{"get":{"description":"Retrieve a threaded list of replies for a single comment, with configurable depth, sorting, and pagination\n","operationId":"GetCommentReplies","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"depth","schema":{"description":"Maximum nested depth to return (0 = unlimited)","format":"int32","maximum":5,"minimum":0,"title":"Max Depth","type":"integer","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"sort","schema":{"description":"first (oldest), last (newest) or top","enum":["first","last","top","best","controversial"],"title":"Sort Order","type":"string","writeOnly":true,"x-stream-index":"003"}},{"in":"query","name":"replies_limit","schema":{"description":"Max number of replies to return","format":"int32","minimum":0,"title":"Replies Limit","type":"integer","writeOnly":true,"x-stream-index":"004"}},{"in":"query","name":"limit","schema":{"description":"Max number of direct replies to return","format":"int32","maximum":100,"minimum":0,"title":"Reply Limit","type":"integer","writeOnly":true,"x-stream-index":"005.001"}},{"in":"query","name":"prev","schema":{"type":"string","writeOnly":true,"x-stream-index":"005.002"}},{"in":"query","name":"next","schema":{"type":"string","writeOnly":true,"x-stream-index":"005.003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCommentRepliesResponse"}}},"description":"Get Comment Replies 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":"Get replies for a comment","tags":["product:feeds"]}},"/api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}":{"delete":{"description":"Delete a single feed by its ID\n","operationId":"DeleteFeed","parameters":[{"in":"path","name":"feed_group_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"feed_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"hard_delete","schema":{"description":"Whether to permanently delete the feed instead of soft delete","title":"boolean","type":"boolean","writeOnly":true,"x-stream-index":"003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteFeedResponse"}}},"description":"Delete Feed 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":"Delete a single feed","tags":["product:feeds"]},"post":{"description":"Create a single feed for a given feed group\n","operationId":"GetOrCreateFeed","parameters":[{"in":"path","name":"feed_group_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"feed_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"connection_id","schema":{"description":"Websocket connection ID to interact with. You can pass it as Body or URL parameter","title":"Connection ID","type":"string","x-stream-index":"015.003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrCreateFeedRequest"}}},"description":"ClientRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrCreateFeedResponse"}}},"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":"Create a new feed","tags":["product:feeds"]},"put":{"description":"Update an existing feed\n","operationId":"UpdateFeed","parameters":[{"in":"path","name":"feed_group_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"feed_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFeedRequest"}}},"description":"Update Feed Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFeedResponse"}}},"description":"Update Feed 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":"Update a feed","tags":["product:feeds"]}},"/api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/activities/mark/batch":{"post":{"description":"Mark activities as read/seen/watched. Can mark by timestamp (seen), activity IDs (read), or all as read.\n","operationId":"MarkActivity","parameters":[{"in":"path","name":"feed_group_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"feed_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkActivityRequest"}}},"description":"Mark Activity Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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 activities as read/seen/watched","tags":["product:feeds"]}},"/api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/activities/{activity_id}/pin":{"delete":{"description":"Unpin an activity from a feed. This removes the pin, so the activity will no longer be displayed at the top of the feed.\n","operationId":"UnpinActivity","parameters":[{"in":"path","name":"feed_group_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"feed_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"path","name":"activity_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnpinActivityResponse"}}},"description":"Unpin Activity 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":"Unpin an activity from a feed","tags":["product:feeds"]},"post":{"description":"Pin an activity to a feed. Pinned activities are typically displayed at the top of a feed.\n","operationId":"PinActivity","parameters":[{"in":"path","name":"feed_group_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"feed_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"path","name":"activity_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PinActivityRequest"}}},"description":"Pin Activity Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PinActivityResponse"}}},"description":"Pin Activity 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":"Pin an activity to a feed","tags":["product:feeds"]}},"/api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/members":{"patch":{"description":"Add, remove, or set members for a feed\n","operationId":"UpdateFeedMembers","parameters":[{"in":"path","name":"feed_group_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"feed_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFeedMembersRequest"}}},"description":"Update Feed Members Request","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFeedMembersResponse"}}},"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":"Update feed members","tags":["product:feeds"]}},"/api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/members/accept":{"post":{"description":"Accepts a pending feed member request\n","operationId":"AcceptFeedMemberInvite","parameters":[{"in":"path","name":"feed_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"feed_group_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcceptFeedMemberInviteRequest"}}},"description":"Accept Feed Member Invite Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcceptFeedMemberInviteResponse"}}},"description":"Accept Feed Member Invite 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":"Accept a feed member request","tags":["product:feeds"]}},"/api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/members/query":{"post":{"description":"Query feed members based on filters with pagination and sorting options\n","operationId":"QueryFeedMembers","parameters":[{"in":"path","name":"feed_group_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"feed_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryFeedMembersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryFeedMembersResponse"}}},"description":"Successful 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":"Query feed members","tags":["product:feeds"]}},"/api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/members/reject":{"post":{"description":"Rejects a pending feed member request\n","operationId":"RejectFeedMemberInvite","parameters":[{"in":"path","name":"feed_group_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"feed_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RejectFeedMemberInviteRequest"}}},"description":"Reject Feed Member Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RejectFeedMemberInviteResponse"}}},"description":"Reject Feed Member 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":"Reject an invite to become a feed member","tags":["product:feeds"]}},"/api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/watch":{"delete":{"description":"Call this Method to stop receiving feed events\n","operationId":"StopWatchingFeed","parameters":[{"in":"path","name":"feed_group_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"path","name":"feed_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"003"}},{"in":"query","name":"connection_id","schema":{"type":"string","x-stream-index":"001.003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Stop watching feed","tags":["product:feeds"]}},"/api/v2/feeds/feed_groups/{feed_group_id}/follow_suggestions":{"get":{"description":"Get follow suggestions for a feed group\n","operationId":"GetFollowSuggestions","parameters":[{"in":"path","name":"feed_group_id","required":true,"schema":{"description":"The ID of the feed group to get suggestions for","maxLength":255,"title":"Feed Group ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"limit","schema":{"description":"Maximum number of suggestions to return","format":"int32","maximum":100,"minimum":1,"title":"Limit","type":"integer","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetFollowSuggestionsResponse"}}},"description":"Follow Suggestions 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":"Get follow suggestions","tags":["product:feeds"]}},"/api/v2/feeds/feeds/batch":{"post":{"description":"Create multiple feeds at once for a given feed group\n","operationId":"CreateFeedsBatch","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFeedsBatchRequest"}}},"description":"Create Feeds Batch Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFeedsBatchResponse"}}},"description":"Create Feeds Batch 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":"Create multiple feeds at once","tags":["product:feeds"]}},"/api/v2/feeds/feeds/query":{"post":{"description":"Query feeds with filter query\n","operationId":"QueryFeeds","parameters":[{"in":"query","name":"connection_id","schema":{"type":"string","x-stream-index":"005.003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryFeedsRequest"}}},"description":"Query Feeds Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryFeedsResponse"}}},"description":"Query Feeds 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":"Query feeds","tags":["product:feeds"]}},"/api/v2/feeds/follows":{"patch":{"description":"Updates a follow's custom data, push preference, and follower role. Source owner can update custom data and push preference. Target owner can update follower role.\n","operationId":"UpdateFollow","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFollowRequest"}}},"description":"Update Follow Request","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFollowResponse"}}},"description":"Update Follow 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":"Update a follow","tags":["product:feeds"]},"post":{"description":"Creates a follow and broadcasts FollowAddedEvent\n","operationId":"Follow","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FollowRequest"}}},"description":"Follow Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SingleFollowResponse"}}},"description":"Follow 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":"Create a follow","tags":["product:feeds"]}},"/api/v2/feeds/follows/accept":{"post":{"description":"Accepts a pending follow request\n","operationId":"AcceptFollow","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcceptFollowRequest"}}},"description":"Accept Follow Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcceptFollowResponse"}}},"description":"Accept Follow 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":"Accept a follow request","tags":["product:feeds"]}},"/api/v2/feeds/follows/batch":{"post":{"description":"Creates multiple follows at once and broadcasts FollowAddedEvent for each follow\n","operationId":"FollowBatch","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FollowBatchRequest"}}},"description":"Follow Batch Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FollowBatchResponse"}}},"description":"Follow Batch 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":"Create multiple follows at once","tags":["product:feeds"]}},"/api/v2/feeds/follows/query":{"post":{"description":"Query follows based on filters with pagination and sorting options\n","operationId":"QueryFollows","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryFollowsRequest"}}},"description":"Query Follows Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryFollowsResponse"}}},"description":"Query Follows 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":"Query follows","tags":["product:feeds"]}},"/api/v2/feeds/follows/reject":{"post":{"description":"Rejects a pending follow request\n","operationId":"RejectFollow","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RejectFollowRequest"}}},"description":"Reject Follow Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RejectFollowResponse"}}},"description":"Reject Follow 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":"Reject a follow request","tags":["product:feeds"]}},"/api/v2/feeds/follows/{source}/{target}":{"delete":{"description":"Removes a follow and broadcasts FollowRemovedEvent\n","operationId":"Unfollow","parameters":[{"in":"path","name":"source","required":true,"schema":{"description":"Fully qualified ID of the source feed","maxLength":255,"title":"Source Feed","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"target","required":true,"schema":{"description":"Fully qualified ID of the target feed","maxLength":255,"title":"Target Feed","type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnfollowResponse"}}},"description":"Unfollow 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":"Unfollow a feed","tags":["product:feeds"]}},"/api/v2/guest":{"post":{"description":"\n","operationId":"CreateGuest","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGuestRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGuestResponse"}}},"description":"Successful 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":"Create Guest","tags":["product:common"]}},"/api/v2/longpoll":{"get":{"description":"WebSocket fallback transport endpoint\n\nSends events:\n- user.updated\n","operationId":"LongPoll","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WSAuthMessage","x-stream-index":"001"}}},"in":"query","name":"json"},{"in":"query","name":"connection_id","schema":{"maxLength":36,"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"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":"Long Poll (Transport)","tags":["product:common"]}},"/api/v2/moderation/ban":{"post":{"description":"Ban a user from a channel or the entire app\n","operationId":"ban","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BanRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BanResponse"}}},"description":"Successful 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":"Ban","tags":["product:moderation"]}},"/api/v2/moderation/config":{"post":{"description":"Create a new moderation configuration or update an existing one. Configure settings for content filtering, AI analysis, toxicity detection, and other moderation features.\n","operationId":"upsert_config","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertConfigRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertConfigResponse"}}},"description":"Successful 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":"Create or update moderation configuration","tags":["product:moderation"]}},"/api/v2/moderation/config/{key}":{"delete":{"description":"Delete a specific moderation policy by its name\n","operationId":"delete_config","parameters":[{"in":"path","name":"key","required":true,"schema":{"description":"Key of the moderation configuration to delete","title":"Key","type":"string","x-stream-index":"001"}},{"in":"query","name":"team","schema":{"description":"Team associated with the configuration","title":"Team","type":"string","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteModerationConfigResponse"}}},"description":"Successful 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":"Delete a moderation policy","tags":["product:moderation"]},"get":{"description":"Retrieve a specific moderation configuration by its key and team. This configuration contains settings for various moderation features like toxicity detection, AI analysis, and filtering rules.\n","operationId":"get_config","parameters":[{"in":"path","name":"key","required":true,"schema":{"description":"Key of the moderation configuration to retrieve","title":"Key","type":"string","x-stream-index":"001"}},{"in":"query","name":"team","schema":{"description":"Team associated with the configuration","title":"Team","type":"string","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetConfigResponse"}}},"description":"Successful 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":"Get moderation configuration","tags":["product:moderation"]}},"/api/v2/moderation/configs":{"post":{"description":"Search and filter moderation configurations across your application. This endpoint is designed for building moderation dashboards and managing multiple configuration sets.\n","operationId":"query_moderation_configs","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationConfigsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationConfigsResponse"}}},"description":"Successful 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":"Query moderation configurations","tags":["product:moderation"]}},"/api/v2/moderation/flag":{"post":{"description":"Flag any type of content (messages, users, channels, activities) for moderation review. Supports custom content types and additional metadata for flagged content.\n","operationId":"flag","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlagRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlagResponse"}}},"description":"Successful 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":"Flag content for moderation","tags":["product:moderation"]}},"/api/v2/moderation/mute":{"post":{"description":"Mute a user. Mutes are generally not visible to the user you mute, while block is something you notice.\n","operationId":"mute","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteRequest"}}},"description":"MuteRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteResponse"}}},"description":"MuteResponse"},"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":"Mute","tags":["product:moderation"]}},"/api/v2/moderation/review_queue":{"post":{"description":"Query review queue items allows you to filter the review queue items. This is used for building a moderation dashboard.\n","operationId":"query_review_queue","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryReviewQueueRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryReviewQueueResponse"}}},"description":"Successful 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":"Query review queue items","tags":["product:moderation"]}},"/api/v2/moderation/submit_action":{"post":{"description":"Take action on flagged content, such as marking content as safe, deleting content, banning users, or executing custom moderation actions. Supports various action types with configurable parameters.\n","operationId":"submit_action","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitActionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitActionResponse"}}},"description":"Successful 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":"Submit moderation action","tags":["product:moderation"]}},"/api/v2/og":{"get":{"description":"Get an OpenGraph attachment for a link\n","operationId":"GetOG","parameters":[{"in":"query","name":"url","required":true,"schema":{"description":"URL to be scraped","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOGResponse"}}},"description":"Get OG Attachment"},"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":"Get OG","tags":["product:common"]}},"/api/v2/polls":{"post":{"description":"Creates a new poll\n","operationId":"CreatePoll","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePollRequest"}}},"description":"Create Poll Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Create poll","tags":["product:common"]},"put":{"description":"Updates a poll\n\nSends events:\n- feeds.poll.closed\n- feeds.poll.updated\n- poll.closed\n- poll.updated\n","operationId":"UpdatePoll","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePollRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Update poll","tags":["product:common"]}},"/api/v2/polls/query":{"post":{"description":"Queries polls\n","operationId":"QueryPolls","parameters":[{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryPollsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryPollsResponse"}}},"description":"Successful 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":"Query polls","tags":["product:common"]}},"/api/v2/polls/{poll_id}":{"delete":{"description":"Deletes a poll\n\nSends events:\n- feeds.poll.deleted\n- poll.deleted\n","operationId":"DeletePoll","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete poll","tags":["product:common"]},"get":{"description":"Retrieves a poll\n","operationId":"GetPoll","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Get poll","tags":["product:common"]},"patch":{"description":"Updates a poll partially\n\nSends events:\n- feeds.poll.closed\n- feeds.poll.updated\n- poll.closed\n- poll.updated\n","operationId":"UpdatePollPartial","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePollPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Partial update poll","tags":["product:common"]}},"/api/v2/polls/{poll_id}/options":{"post":{"description":"Creates a poll option\n\nSends events:\n- feeds.poll.updated\n- poll.updated\n","operationId":"CreatePollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePollOptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollOptionResponse"}}},"description":"Successful 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":"Create poll option","tags":["product:common"]},"put":{"description":"Updates a poll option\n\nSends events:\n- feeds.poll.updated\n- poll.updated\n","operationId":"UpdatePollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePollOptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollOptionResponse"}}},"description":"Successful 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":"Update poll option","tags":["product:common"]}},"/api/v2/polls/{poll_id}/options/{option_id}":{"delete":{"description":"Deletes a poll option\n\nSends events:\n- feeds.poll.updated\n- poll.updated\n","operationId":"DeletePollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"path","name":"option_id","required":true,"schema":{"description":"Option ID","maxLength":255,"title":"string","type":"string","x-stream-index":"003"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete poll option","tags":["product:common"]},"get":{"description":"Retrieves a poll option\n","operationId":"GetPollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"path","name":"option_id","required":true,"schema":{"description":"Option ID","maxLength":255,"title":"string","type":"string","x-stream-index":"003"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollOptionResponse"}}},"description":"Successful 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":"Get poll option","tags":["product:common"]}},"/api/v2/polls/{poll_id}/votes":{"post":{"description":"Queries votes\n","operationId":"QueryPollVotes","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryPollVotesRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollVotesResponse"}}},"description":"Successful 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":"Query votes","tags":["product:common"]}},"/api/v2/uploads/file":{"delete":{"description":"Deletes previously uploaded file\n","operationId":"DeleteFileGlobal","parameters":[{"in":"query","name":"url","schema":{"description":"File URL to delete","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete file","tags":["product:common"],"x-stream-sdk-name":"DeleteFile"},"post":{"description":"Uploads file\n","operationId":"UploadFileGlobal","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/FileUploadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileUploadResponse"}}},"description":"Successful 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":"Upload file","tags":["product:common"],"x-stream-sdk-name":"UploadFile"}},"/api/v2/uploads/image":{"delete":{"description":"Deletes previously uploaded image\n","operationId":"DeleteImageGlobal","parameters":[{"in":"query","name":"url","schema":{"description":"File URL to delete","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete image","tags":["product:common"],"x-stream-sdk-name":"DeleteImage"},"post":{"description":"Uploads image\n","operationId":"UploadImageGlobal","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/ImageUploadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageUploadResponse"}}},"description":"Successful 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":"Upload image","tags":["product:common"],"x-stream-sdk-name":"UploadImage"}},"/api/v2/users":{"get":{"description":"Find and filter users\n","operationId":"QueryUsers","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryUsersPayload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryUsersResponse"}}},"description":"Successful 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":"Query users","tags":["product:common"]},"patch":{"description":"Updates certain fields of the user\n\nSends events:\n- user.presence.changed\n- user.updated\n- user.presence.changed\n","operationId":"UpdateUsersPartial","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersResponse"}}},"description":"Successful 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":"Partially update user","tags":["product:common"]},"post":{"description":"Update or create users in bulk\n\nSends events:\n- user.updated\n","operationId":"UpdateUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersResponse"}}},"description":"Successful 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":"Upsert users","tags":["product:common"]}},"/api/v2/users/block":{"get":{"description":"Get list of blocked Users\n","operationId":"GetBlockedUsers","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBlockedUsersResponse"}}},"description":"Successful 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":"Get list of blocked Users","tags":["product:common"]},"post":{"description":"Block users\n","operationId":"BlockUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUsersResponse"}}},"description":"Successful 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":"Block user","tags":["product:common"]}},"/api/v2/users/live_locations":{"get":{"description":"Retrieves all active live locations for a user\n","operationId":"GetUserLiveLocations","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SharedLocationsResponse"}}},"description":"Successful 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":"Get user live locations","tags":["product:common"]},"put":{"description":"Updates an existing live location with new coordinates or expiration time\n","operationId":"UpdateLiveLocation","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateLiveLocationRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SharedLocationResponse"}}},"description":"Successful 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":"Update live location","tags":["product:common"]}},"/api/v2/users/unblock":{"post":{"description":"Unblock users\n","operationId":"UnblockUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUsersResponse"}}},"description":"Successful 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":"Unblock user","tags":["product:common"]}},"/api/v2/video/call/members":{"post":{"description":"Query call members with filter query\n","operationId":"QueryCallMembers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallMembersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallMembersResponse"}}},"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":"Query call members","tags":["product:video"]}},"/api/v2/video/call/stats":{"post":{"description":"\n","operationId":"QueryCallStats","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallStatsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallStatsResponse"}}},"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":"Query Call Stats","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}":{"get":{"description":"\n","operationId":"GetCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"query","name":"connection_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"003"}},{"in":"query","name":"members_limit","schema":{"format":"int32","maximum":100,"minimum":0,"type":"integer","writeOnly":true,"x-stream-index":"004"}},{"in":"query","name":"ring","schema":{"type":"boolean","writeOnly":true,"x-stream-index":"005"}},{"in":"query","name":"notify","schema":{"type":"boolean","writeOnly":true,"x-stream-index":"006"}},{"in":"query","name":"video","schema":{"type":"boolean","writeOnly":true,"x-stream-index":"007"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCallResponse"}}},"description":"GetCallResponse"},"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":"Get Call","tags":["product:video"]},"patch":{"description":"\n\nSends events:\n- call.updated\n","operationId":"UpdateCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallRequest"}}},"description":"UpdateCallRequest","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallResponse"}}},"description":"UpdateCallResponse"},"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":"Update Call","tags":["product:video"]},"post":{"description":"Gets or creates a new call\n\nSends events:\n- call.created\n- call.notification\n- call.ring\n","operationId":"GetOrCreateCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"connection_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"008"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrCreateCallRequest"}}},"description":"GetOrCreateCallRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrCreateCallResponse"}}},"description":"GetOrCreateCallResponse"},"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":"Get or create a call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/accept":{"post":{"description":"\n\nSends events:\n- call.accepted\n","operationId":"AcceptCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcceptCallResponse"}}},"description":"AcceptCallResponse"},"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":"Accept Call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/block":{"post":{"description":"Block a user, preventing them from joining the call until they are unblocked.\n\nSends events:\n- call.blocked_user\n","operationId":"BlockUser","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUserRequest"}}},"description":"BlockUserRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUserResponse"}}},"description":"BlockUserResponse"},"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":"Block user on a call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/delete":{"post":{"description":"\n\nSends events:\n- call.deleted\n","operationId":"DeleteCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCallRequest"}}},"description":"DeleteCallRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCallResponse"}}},"description":"DeleteCallResponse"},"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":"Delete Call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/event":{"post":{"description":"Sends custom event to the call\n\nSends events:\n- custom\n","operationId":"SendCallEvent","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendCallEventRequest"}}},"description":"SendCallEventRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendCallEventResponse"}}},"description":"SendCallEventResponse"},"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":"Send custom event","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/feedback":{"post":{"description":"\n\nSends events:\n- call.user_feedback_submitted\n","operationId":"CollectUserFeedback","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectUserFeedbackRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectUserFeedbackResponse"}}},"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":"Collect user feedback","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/go_live":{"post":{"description":"\n\nSends events:\n- call.live_started\n","operationId":"GoLive","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoLiveRequest"}}},"description":"GoLiveRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoLiveResponse"}}},"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":"Set call as live","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/join":{"post":{"description":"Request to join a call\n","operationId":"JoinCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"query","name":"connection_id","schema":{"title":"ConnectionID","type":"string","writeOnly":true,"x-stream-index":"008"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JoinCallRequest"}}},"description":"JoinCallRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JoinCallResponse"}}},"description":"JoinCallResponse"},"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":"Join call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/kick":{"post":{"description":"Kicks a user from the call. Optionally block the user from rejoining by setting block=true.\n\nSends events:\n- call.blocked_user\n- call.kicked_user\n","operationId":"KickUser","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KickUserRequest"}}},"description":"KickUserRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KickUserResponse"}}},"description":"KickUserResponse"},"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":"Kick user from a call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/mark_ended":{"post":{"description":"\n\nSends events:\n- call.ended\n","operationId":"EndCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EndCallResponse"}}},"description":"EndCallResponse"},"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":"End call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/members":{"post":{"description":"\n\nSends events:\n- call.member_added\n- call.member_removed\n- call.member_updated\n","operationId":"UpdateCallMembers","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallMembersRequest"}}},"description":"UpdateCallMembersRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallMembersResponse"}}},"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":"Update Call Member","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/mute_users":{"post":{"description":"Mutes users in a call\n","operationId":"MuteUsers","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteUsersRequest"}}},"description":"MuteUsersRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteUsersResponse"}}},"description":"MuteUsersResponse"},"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":"Mute users","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/participants":{"post":{"description":"Returns a list of participants connected to the call\n","operationId":"QueryCallParticipants","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"type","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"limit","schema":{"format":"int32","maximum":100,"type":"integer","x-stream-index":"004"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallParticipantsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallParticipantsResponse"}}},"description":"Successful 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":"Query call participants","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/pin":{"post":{"description":"Pins a track for all users in the call.\n","operationId":"VideoPin","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PinRequest"}}},"description":"PinRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PinResponse"}}},"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":"Pin","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/reaction":{"post":{"description":"Sends reaction to the call\n\nSends events:\n- call.reaction_new\n","operationId":"SendVideoReaction","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendReactionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendReactionResponse"}}},"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":"Send reaction to the call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/recordings":{"get":{"description":"Lists recordings\n","operationId":"ListRecordings","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListRecordingsResponse"}}},"description":"ListRecordingsResponse"},"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":"List recordings","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/reject":{"post":{"description":"\n\nSends events:\n- call.rejected\n","operationId":"RejectCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RejectCallRequest"}}},"description":"RejectCallRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RejectCallResponse"}}},"description":"RejectCallResponse"},"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":"Reject Call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/report":{"get":{"description":"\n","operationId":"GetCallReport","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"query","name":"session_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCallReportResponse"}}},"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":"Get call report","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/request_permission":{"post":{"description":"Request permission to perform an action\n\nSends events:\n- call.permission_request\n","operationId":"RequestPermission","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestPermissionRequest"}}},"description":"RequestPermissionRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestPermissionResponse"}}},"description":"RequestPermissionResponse"},"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":"Request permission","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/rtmp_broadcasts":{"post":{"description":"Starts RTMP broadcasts for the provided RTMP destinations\n","operationId":"StartRTMPBroadcasts","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRTMPBroadcastsRequest"}}},"description":"StartRTMPBroadcastsRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRTMPBroadcastsResponse"}}},"description":"StartRTMPBroadcastsResponse"},"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":"Start RTMP broadcasts","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/rtmp_broadcasts/stop":{"post":{"description":"Stop all RTMP broadcasts for the provided call\n","operationId":"StopAllRTMPBroadcasts","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopAllRTMPBroadcastsResponse"}}},"description":"StopAllRTMPBroadcastsResponse"},"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":"Stop all RTMP broadcasts for a call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/rtmp_broadcasts/{name}/stop":{"post":{"description":"Stop RTMP broadcasts for the provided RTMP destinations\n","operationId":"StopRTMPBroadcast","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopRTMPBroadcastsRequest"}}},"description":"StopRTMPBroadcastsRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopRTMPBroadcastsResponse"}}},"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":"Stop RTMP broadcasts","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/start_broadcasting":{"post":{"description":"Starts HLS broadcasting\n","operationId":"StartHLSBroadcasting","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartHLSBroadcastingResponse"}}},"description":"StartHLSBroadcastingResponse"},"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":"Start HLS broadcasting","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/start_closed_captions":{"post":{"description":"Starts closed captions\n","operationId":"StartClosedCaptions","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartClosedCaptionsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartClosedCaptionsResponse"}}},"description":"Successful 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":"Start closed captions","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/start_frame_recording":{"post":{"description":"Starts frame by frame recording\n\nSends events:\n- call.frame_recording_started\n","operationId":"StartFrameRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartFrameRecordingRequest"}}},"description":"StartFrameRecordingRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartFrameRecordingResponse"}}},"description":"StartFrameRecordingResponse"},"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":"Start frame recording","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/start_recording":{"post":{"description":"Starts recording\n\nSends events:\n- call.recording_started\n","operationId":"StartRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRecordingRequest"}}},"description":"StartRecordingRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRecordingResponse"}}},"description":"StartRecordingResponse"},"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":"Start recording","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/start_transcription":{"post":{"description":"Starts transcription\n","operationId":"StartTranscription","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartTranscriptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartTranscriptionResponse"}}},"description":"StartTranscriptionResponse"},"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":"Start transcription","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_broadcasting":{"post":{"description":"Stops HLS broadcasting\n","operationId":"StopHLSBroadcasting","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopHLSBroadcastingResponse"}}},"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":"Stop HLS broadcasting","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_closed_captions":{"post":{"description":"Stops closed captions\n\nSends events:\n- call.transcription_stopped\n","operationId":"StopClosedCaptions","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopClosedCaptionsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopClosedCaptionsResponse"}}},"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":"Stop closed captions","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_frame_recording":{"post":{"description":"Stops frame recording\n\nSends events:\n- call.frame_recording_stopped\n","operationId":"StopFrameRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopFrameRecordingResponse"}}},"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":"Stop frame recording","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_live":{"post":{"description":"\n\nSends events:\n- call.updated\n","operationId":"StopLive","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopLiveRequest"}}},"description":"StopLiveRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopLiveResponse"}}},"description":"StopLiveResponse"},"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":"Set call as not live","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_recording":{"post":{"description":"Stops recording\n\nSends events:\n- call.recording_stopped\n","operationId":"StopRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopRecordingResponse"}}},"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":"Stop recording","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_transcription":{"post":{"description":"Stops transcription\n\nSends events:\n- call.transcription_stopped\n","operationId":"StopTranscription","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopTranscriptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopTranscriptionResponse"}}},"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":"Stop transcription","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/transcriptions":{"get":{"description":"Lists transcriptions\n","operationId":"ListTranscriptions","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTranscriptionsResponse"}}},"description":"ListTranscriptionsResponse"},"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":"List transcriptions","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/unblock":{"post":{"description":"Removes the block for a user on a call. The user will be able to join the call again.\n\nSends events:\n- call.unblocked_user\n","operationId":"UnblockUser","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUserRequest"}}},"description":"UnblockUserRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUserResponse"}}},"description":"UnblockUserResponse"},"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":"Unblocks user on a call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/unpin":{"post":{"description":"Unpins a track for all users in the call.\n","operationId":"VideoUnpin","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnpinRequest"}}},"description":"UnpinRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnpinResponse"}}},"description":"UnpinResponse"},"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":"Unpin","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/user_permissions":{"post":{"description":"Updates user permissions\n\nSends events:\n- call.permissions_updated\n","operationId":"UpdateUserPermissions","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"005.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"005.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUserPermissionsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUserPermissionsResponse"}}},"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":"Update user permissions","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/{session}/recordings/{filename}":{"delete":{"description":"Deletes recording\n","operationId":"DeleteRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"path","name":"session","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"003"}},{"in":"path","name":"filename","required":true,"schema":{"maxLength":256,"type":"string","writeOnly":true,"x-stream-index":"004"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteRecordingResponse"}}},"description":"DeleteRecordingResponse"},"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":"Delete recording","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/{session}/transcriptions/{filename}":{"delete":{"description":"Deletes transcription\n","operationId":"DeleteTranscription","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"path","name":"session","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"003"}},{"in":"path","name":"filename","required":true,"schema":{"maxLength":256,"type":"string","writeOnly":true,"x-stream-index":"004"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteTranscriptionResponse"}}},"description":"DeleteTranscriptionResponse"},"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":"Delete transcription","tags":["product:video"]}},"/api/v2/video/calls":{"post":{"description":"Query calls with filter query\n","operationId":"QueryCalls","parameters":[{"in":"query","name":"connection_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallsRequest"}}},"description":"QueryCallsRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallsResponse"}}},"description":"QueryCallsResponse"},"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":"Query call","tags":["product:video"]}},"/api/v2/video/edges":{"get":{"description":"Returns the list of all edges available for video calls.\n","operationId":"GetEdges","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetEdgesResponse"}}},"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":"Get Edges","tags":["product:video"]}},"/api/v2/video/stats":{"post":{"description":"\n","operationId":"QueryAggregateCallStats","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryAggregateCallStatsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryAggregateCallStatsResponse"}}},"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":"Query Aggregate call Stats","tags":["product:video"]}}},"security":[{"JWT":[],"api_key":[],"stream-auth-type":[]},{"api_key":[],"stream-auth-type":[]}],"servers":[{"description":"Stream API","url":"https://chat.stream-io-api.com"}]} \ No newline at end of file diff --git a/openapi/v2/clientside-api.yaml b/openapi/v2/clientside-api.yaml index 21f27af4e..f47c68c9e 100644 --- a/openapi/v2/clientside-api.yaml +++ b/openapi/v2/clientside-api.yaml @@ -301,6 +301,67 @@ components: - duration title: AcceptCallResponse type: object + AcceptFeedMemberInviteRequest: + nullable: true + title: Accept Feed Member Invite Request + type: object + AcceptFeedMemberInviteResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + member: + $ref: '#/components/schemas/FeedMemberResponse' + description: The feed member after accepting the invite + title: Feed Member + x-stream-index: "001" + required: + - member + - duration + title: Accept Feed Member Invite Response + type: object + AcceptFollowRequest: + nullable: true + properties: + follower_role: + description: Optional role for the follower in the follow relationship + title: Follower Role + type: string + x-stream-index: "003" + source: + description: Fully qualified ID of the source feed + maxLength: 255 + title: Source Feed ID + type: string + x-stream-index: "001" + target: + description: Fully qualified ID of the target feed + maxLength: 255 + title: Target Feed ID + type: string + x-stream-index: "002" + required: + - source + - target + title: Accept Follow Request + type: object + AcceptFollowResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + follow: + $ref: '#/components/schemas/FollowResponse' + description: The accepted follow relationship + title: Follow + x-stream-index: "001" + required: + - follow + - duration + title: Accept Follow Response + type: object Action: nullable: true properties: @@ -471,6 +532,253 @@ components: - warning - warning_text type: object + ActivityAddedEvent: + description: Emitted when an activity is added to a feed. + nullable: true + properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + description: The activity that was added + title: Activity + x-stream-index: "001" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + feed_visibility: + type: string + x-stream-index: "002.003" + fid: + type: string + x-stream-index: "002.002" + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 + type: + default: feeds.activity.added + description: 'The type of event: "feeds.activity.added" in this case' + title: Event Type + type: string + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who added the activity + title: User + x-stream-index: "003.001" + required: + - activity + - type + - created_at + - custom + - fid + title: ActivityAddedEvent + 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 + ActivityDeletedEvent: + description: Emitted when an activity is deleted. + nullable: true + properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + description: The activity that was updated + title: Activity + x-stream-index: "001" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + feed_visibility: + type: string + x-stream-index: "002.003" + fid: + type: string + x-stream-index: "002.002" + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 + type: + default: feeds.activity.deleted + description: 'The type of event: "feeds.activity.deleted" in this case' + title: Event Type + type: string + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + x-stream-index: "003.001" + required: + - activity + - type + - created_at + - custom + - fid + title: ActivityDeletedEvent + 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 + ActivityFeedbackRequest: + description: Request to provide feedback on an activity + nullable: true + properties: + hide: + description: Whether to hide this activity + title: bool + type: boolean + x-stream-index: "003" + mute_user: + description: Whether to mute the user who created this activity + title: bool + type: boolean + x-stream-index: "005" + reason: + description: Reason for the feedback (optional) + maxLength: 1000 + title: string + type: string + x-stream-index: "006" + report: + description: Whether to report this activity + title: bool + type: boolean + x-stream-index: "004" + show_less: + description: Whether to show less content like this + title: bool + type: boolean + x-stream-index: "002" + title: Activity Feedback Request + type: object + ActivityFeedbackResponse: + description: Response for activity feedback submission + nullable: true + properties: + activity_id: + description: The ID of the activity that received feedback + title: string + type: string + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - activity_id + - duration + title: Activity Feedback Response + type: object + ActivityLocation: + properties: + lat: + description: Latitude coordinate + format: float + title: Latitude + type: number + x-stream-index: "001" + lng: + description: Longitude coordinate + format: float + title: Longitude + type: number + x-stream-index: "002" + required: + - lat + - lng + title: Activity Location + type: object + ActivityMarkEvent: + description: Emitted when activities are marked as read, seen, or watched. + nullable: true + properties: + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 006.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 006.001.007 + feed_visibility: + type: string + x-stream-index: "006.003" + fid: + type: string + x-stream-index: "006.002" + mark_all_read: + description: Whether all activities were marked as read + title: Mark All Read + type: boolean + x-stream-index: "004" + mark_all_seen: + description: Whether all activities were marked as seen + title: Mark All Seen + type: boolean + x-stream-index: "005" + mark_read: + description: The IDs of activities marked as read + items: + type: string + title: Mark Read + type: array + x-stream-index: "001" + mark_seen: + description: The IDs of activities marked as seen + items: + type: string + title: Mark Seen + type: array + x-stream-index: "002" + mark_watched: + description: The IDs of activities marked as watched + items: + type: string + title: Mark Watched + type: array + x-stream-index: "003" + received_at: + format: date-time + type: number + x-stream-index: 006.001.004 + type: + default: feeds.activity.marked + description: 'The type of event: "feeds.activity.marked" in this case' + title: Event Type + type: string + x-stream-index: 006.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who marked the activities + title: User + x-stream-index: "007.001" + required: + - type + - created_at + - custom + - fid + title: ActivityMarkEvent + 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 ActivityMarkedEvent: properties: all_read: @@ -516,1376 +824,2107 @@ components: x-stream-event-doc-group: other x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - AnyEvent: + ActivityPinResponse: properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + description: The pinned activity + title: Activity + x-stream-index: "002" created_at: + description: When the pin was created format: date-time + title: Created At type: number - x-stream-index: "001.002" + x-stream-index: "004" + feed: + description: ID of the feed where activity is pinned + title: Feed ID + type: string + x-stream-index: "003" + updated_at: + description: When the pin was last updated + format: date-time + title: Updated At + type: number + x-stream-index: "005" + user: + $ref: '#/components/schemas/UserResponse' + description: User who pinned the activity + title: User + x-stream-index: "001" + required: + - user + - activity + - feed + - created_at + - updated_at + title: Activity Pin + type: object + ActivityPinnedEvent: + description: Emitted when an activity is pinned. + nullable: true + properties: + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + feed_visibility: + type: string + x-stream-index: "002.003" + fid: + description: The ID of the feed + title: Feed ID + type: string + x-stream-index: "002.002" + pinned_activity: + $ref: '#/components/schemas/PinActivityResponse' + x-stream-index: "001" + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 type: - default: '*' + default: feeds.activity.pinned + description: 'The type of event: "feeds.activity.pinned" in this case' + title: Event Type type: string - x-stream-index: "001.001" + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who pinned the activity + title: User + x-stream-index: "003.001" required: + - pinned_activity - type - created_at - title: AnyEvent + - custom + - fid + title: ActivityPinnedEvent 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 - AppEventResponse: + ActivityProcessorConfig: + nullable: true properties: - async_url_enrich_enabled: - description: boolean - title: Async URL Enrichment Enabled - type: boolean - x-stream-index: "002" - auto_translation_enabled: - description: boolean - title: Auto Translation Enabled - type: boolean + config: + additionalProperties: {} + type: object + x-stream-index: "002" + openai_key: + type: string x-stream-index: "003" - file_upload_config: - $ref: '#/components/schemas/FileUploadConfig' - description: file upload config - title: File Upload Config - x-stream-index: "004" - image_upload_config: - $ref: '#/components/schemas/FileUploadConfig' - description: file upload config - title: Image Upload Config - x-stream-index: "005" - name: - description: string - title: App name + type: type: string x-stream-index: "001" required: - - name - - auto_translation_enabled + - type type: object - AppResponseFields: + ActivityReactionAddedEvent: + description: Emitted when a reaction is added to an activity. + nullable: true properties: - async_url_enrich_enabled: - type: boolean - x-stream-index: "017" - auto_translation_enabled: - type: boolean - x-stream-index: "020" - file_upload_config: - $ref: '#/components/schemas/FileUploadConfig' - x-stream-index: "030" - image_upload_config: - $ref: '#/components/schemas/FileUploadConfig' - x-stream-index: "031" - name: - type: string + activity: + $ref: '#/components/schemas/ActivityResponse' x-stream-index: "001" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 003.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 003.001.007 + feed_visibility: + type: string + x-stream-index: "003.003" + fid: + type: string + x-stream-index: "003.002" + reaction: + $ref: '#/components/schemas/FeedsReactionResponse' + description: The reaction that was added + title: Reaction + x-stream-index: "002" + received_at: + format: date-time + type: number + x-stream-index: 003.001.004 + type: + default: feeds.activity.reaction.added + description: 'The type of event: "feeds.activity.reaction.added" in this + case' + title: Event Type + type: string + x-stream-index: 003.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who added the reaction + title: User + x-stream-index: "004.001" required: - - name - - organization - - push_notifications - - webhook_url - - moderation_webhook_url - - channel_configs - - call_types - - policies - - suspended - - suspended_explanation - - disable_auth_checks - - disable_permissions_checks - - permission_version - - user_search_disallowed_roles - - multi_tenant_enabled - - image_moderation_enabled - - async_url_enrich_enabled - - auto_translation_enabled - - custom_action_handler_url - - enforce_unique_usernames - - sqs_url - - sqs_key - - sqs_secret - - sns_topic_arn - - sns_key - - sns_secret - - file_upload_config - - image_upload_config - - grants - - campaign_enabled - - webhook_events - - reminders_interval - - cdn_expiration_seconds - - video_provider - - moderation_enabled - - moderation_multitenant_blocklist_enabled - - guest_user_creation_disabled - - event_hooks - - use_hook_v2 - - user_response_time_enabled - - moderation_bulk_submit_action_enabled + - activity + - reaction + - type + - created_at + - custom + - fid + title: ActivityReactionAddedEvent type: object - AppUpdatedEvent: - description: Emitted when app settings are updated + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + ActivityReactionDeletedEvent: + description: Emitted when a reaction is deleted from an activity. nullable: true properties: - app: - $ref: '#/components/schemas/AppEventResponse' - description: application configuration - title: App settings + activity: + $ref: '#/components/schemas/ActivityResponse' + x-stream-index: "001" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 003.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 003.001.007 + feed_visibility: + type: string + x-stream-index: "003.003" + fid: + type: string + x-stream-index: "003.002" + reaction: + $ref: '#/components/schemas/FeedsReactionResponse' x-stream-index: "002" + received_at: + format: date-time + type: number + x-stream-index: 003.001.004 + type: + default: feeds.activity.reaction.deleted + description: The type of the reaction that was removed + title: Type + type: string + x-stream-index: 003.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who removed the reaction + title: User + x-stream-index: "004.001" + required: + - activity + - reaction + - type + - created_at + - custom + - fid + title: ActivityReactionDeletedEvent + 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 + ActivityReactionUpdatedEvent: + description: Emitted when a reaction is updated on an activity. + nullable: true + properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + x-stream-index: "001" created_at: description: Date/time of creation format: date-time title: Created at type: number - x-stream-index: "001.003" + x-stream-index: 003.001.003 custom: additionalProperties: {} type: object - x-stream-index: "001.007" + x-stream-index: 003.001.007 + feed_visibility: + type: string + x-stream-index: "003.003" + fid: + type: string + x-stream-index: "003.002" + reaction: + $ref: '#/components/schemas/FeedsReactionResponse' + description: The reaction that was updated + title: Reaction + x-stream-index: "002" received_at: format: date-time type: number - x-stream-index: "001.004" + x-stream-index: 003.001.004 type: - default: app.updated - description: 'The type of event: "app.updated" in this case' + default: feeds.activity.reaction.updated + description: 'The type of event: "feeds.activity.reaction.updated" in this + case' title: Event Type type: string - x-stream-index: "001.002" + x-stream-index: 003.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who updated the reaction + title: User + x-stream-index: "004.001" required: + - activity + - reaction - type - created_at - custom - - app - title: AppUpdatedEvent + - fid + title: ActivityReactionUpdatedEvent 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 - Attachment: - description: An attachment is a message object that represents a file uploaded - by a user. + ActivityRemovedFromFeedEvent: + description: Emitted when an activity is removed from a feed. nullable: true properties: - actions: - items: - $ref: '#/components/schemas/Action' - type: array - x-stream-index: "015" - asset_url: + activity: + $ref: '#/components/schemas/ActivityResponse' + x-stream-index: "001" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + feed_visibility: type: string - x-stream-index: "017" - author_icon: + x-stream-index: "002.003" + fid: type: string - x-stream-index: "007" - author_link: + x-stream-index: "002.002" + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 + type: + default: feeds.activity.removed_from_feed + description: 'The type of event: "feeds.activity.removed_from_feed" in this + case' + title: Event Type type: string + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who removed the activity + title: User + x-stream-index: "003.001" + required: + - activity + - type + - created_at + - custom + - fid + title: ActivityRemovedFromFeedEvent + 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 + ActivityRequest: + properties: + attachments: + description: List of attachments for the activity + items: + $ref: '#/components/schemas/Attachment' + title: Attachments + type: array x-stream-index: "006" - author_name: - type: string - x-stream-index: "005" - color: - type: string - x-stream-index: "003" custom: additionalProperties: {} + description: Custom data for the activity + title: Custom Data type: object - x-stream-index: "018" - fallback: + x-stream-index: "017" + expires_at: + description: Expiration time for the activity + title: Expires At type: string - x-stream-index: "002" - fields: + x-stream-index: "010" + feeds: + description: List of feed IDs to add the activity to items: - $ref: '#/components/schemas/Field' + type: string + maximum: 255 + minimum: 1 + title: Feed IDs + type: array + x-stream-index: "004" + filter_tags: + description: Tags for filtering activities + items: + type: string + maximum: 255 + title: Filter Tags type: array - x-stream-index: "016" - footer: - type: string x-stream-index: "013" - footer_icon: + id: + description: Optional ID for the activity + maxLength: 255 + title: Activity ID type: string + x-stream-index: "001" + interest_tags: + description: Tags for indicating user interests + items: + type: string + maximum: 255 + title: Interest Tags + type: array x-stream-index: "014" - giphy: - $ref: '#/components/schemas/Images' - x-stream-index: "019" - image_url: - type: string + location: + $ref: '#/components/schemas/ActivityLocation' + description: Geographic location related to the activity + title: Location + x-stream-index: "009" + mentioned_user_ids: + description: List of users mentioned in the activity + items: + type: string + maximum: 255 + title: Mentioned User IDs + type: array x-stream-index: "011" - og_scrape_url: + parent_id: + description: ID of parent activity for replies/comments + maxLength: 255 + title: Parent ID type: string - x-stream-index: "020" - original_height: + x-stream-index: "015" + poll_id: + description: ID of a poll to attach to activity + title: Poll ID + type: string + x-stream-index: "016" + search_data: + additionalProperties: {} + description: Additional data for search indexing + title: Search Data + type: object + x-stream-index: "012" + text: + description: Text content of the activity + title: Text + type: string + x-stream-index: "005" + type: + description: Type of activity + maxLength: 255 + title: Activity Type + type: string + x-stream-index: "002" + visibility: + description: Visibility setting for the activity + enum: + - public + - private + - tag + title: Visibility + type: string + x-stream-index: "007" + visibility_tag: + description: If visibility is 'tag', this is the tag name and is required + maxLength: 32 + title: Visibility Tag + type: string + x-stream-index: "008" + required: + - type + - feeds + title: Activity Request + type: object + ActivityResponse: + properties: + attachments: + description: Media attachments for the activity + items: + $ref: '#/components/schemas/Attachment' + title: Attachments + type: array + x-stream-index: "009" + bookmark_count: + description: Number of bookmarks on the activity format: int32 + title: Bookmark Count type: integer - x-stream-index: "022" - original_width: + x-stream-index: "028" + comment_count: + description: Number of comments on the activity format: int32 + title: Comment Count type: integer + x-stream-index: "027" + comments: + description: Comments on this activity + items: + $ref: '#/components/schemas/CommentResponse' + title: Comments + type: array + x-stream-index: "015" + created_at: + description: When the activity was created + format: date-time + title: Created At + type: number + x-stream-index: "007" + current_feed: + $ref: '#/components/schemas/FeedResponse' + description: Feed context for this activity view. If an activity is added + only to one feed, it's always set. If an activity is added to multiple + feeds, it's only set when calling the GetOrCreateFeed endpoint. + title: Current Feed + x-stream-index: "035" + custom: + additionalProperties: {} + description: Custom data for the activity + title: Custom Data + type: object + x-stream-index: "011" + deleted_at: + description: When the activity was deleted + format: date-time + title: Deleted At + type: number x-stream-index: "021" - pretext: - type: string + edited_at: + description: When the activity was last edited + format: date-time + title: Edited At + type: number + x-stream-index: "020" + expires_at: + description: When the activity will expire + format: date-time + title: Expires At + type: number + x-stream-index: "022" + feeds: + description: List of feed IDs containing this activity + items: + type: string + title: Feeds + type: array x-stream-index: "004" - text: + filter_tags: + description: Tags for filtering + items: + type: string + title: Filter Tags + type: array + x-stream-index: "024" + hidden: + description: If this activity is hidden for this user. For premium content + where you want to show a preview + title: Hidden + type: boolean + x-stream-index: "036" + id: + description: Unique identifier for the activity + title: ID type: string + x-stream-index: "001" + interest_tags: + description: Tags for user interests + items: + type: string + title: Interest Tags + type: array + x-stream-index: "025" + latest_reactions: + description: Recent reactions to the activity + items: + $ref: '#/components/schemas/FeedsReactionResponse' + title: Latest Reactions + type: array + x-stream-index: "031" + location: + $ref: '#/components/schemas/ActivityLocation' + description: Geographic location related to the activity + title: Location + x-stream-index: "017" + mentioned_users: + description: Users mentioned in the activity + items: + $ref: '#/components/schemas/UserResponse' + title: Mentioned Users + type: array x-stream-index: "010" - thumb_url: - type: string + moderation: + $ref: '#/components/schemas/ModerationV2Response' + description: Moderation information + title: Moderation + x-stream-index: "026" + notification_context: + additionalProperties: {} + description: Notification context data for the activity (if this is a reaction, + comment, follow, etc.) + title: Notification Context + type: object x-stream-index: "012" - title: - type: string - x-stream-index: "008" - title_link: + own_bookmarks: + description: Current user's bookmarks for this activity + items: + $ref: '#/components/schemas/BookmarkResponse' + title: Own Bookmarks + type: array + x-stream-index: "034" + own_reactions: + description: Current user's reactions to this activity + items: + $ref: '#/components/schemas/FeedsReactionResponse' + title: Own Reactions + type: array + x-stream-index: "033" + parent: + $ref: '#/components/schemas/ActivityResponse' + description: Parent activity (if this is a reply/comment) + title: Parent + x-stream-index: "018" + poll: + $ref: '#/components/schemas/PollResponseData' + description: Poll attached to this activity + title: Poll + x-stream-index: "019" + popularity: + description: Popularity score of the activity + format: int32 + title: Popularity + type: integer + x-stream-index: "013" + reaction_count: + description: Number of reactions to the activity + format: int32 + title: Reaction Count + type: integer + x-stream-index: "030" + reaction_groups: + additionalProperties: + $ref: '#/components/schemas/ReactionGroupResponse' + description: Grouped reactions by type + title: Reaction Groups + type: object + x-stream-index: "032" + score: + description: Ranking score for this activity + format: float + title: Score + type: number + x-stream-index: "014" + search_data: + additionalProperties: {} + description: Data for search indexing + title: Search Data + type: object + x-stream-index: "023" + share_count: + description: Number of times the activity was shared + format: int32 + title: Share Count + type: integer + x-stream-index: "029" + text: + description: Text content of the activity + title: Text type: string - x-stream-index: "009" + x-stream-index: "016" type: - description: Attachment type (e.g. image, video, url) + description: Type of activity title: Type type: string - x-stream-index: "001" + x-stream-index: "002" + updated_at: + description: When the activity was last updated + format: date-time + title: Updated At + type: number + x-stream-index: "008" + user: + $ref: '#/components/schemas/UserResponse' + description: User who created the activity + title: User + x-stream-index: "003" + visibility: + description: Visibility setting for the activity + enum: + - public + - private + - tag + title: Visibility + type: string + x-stream-index: "005" + visibility_tag: + description: If visibility is 'tag', this is the tag name + title: Visibility Tag + type: string + x-stream-index: "006" required: + - id + - type + - user + - feeds + - visibility + - created_at + - updated_at + - attachments + - mentioned_users - custom - title: Attachment + - popularity + - score + - comments + - search_data + - filter_tags + - interest_tags + - comment_count + - bookmark_count + - share_count + - reaction_count + - latest_reactions + - reaction_groups + - own_reactions + - own_bookmarks + title: Base Activity type: object - x-stream-docs-page-id: file_uploads - AudioSettings: + ActivitySelectorConfig: + nullable: true properties: - access_request_enabled: - type: boolean - x-stream-index: "001" - default_device: - enum: - - speaker - - earpiece - type: string - x-stream-index: "006" - mic_default_on: - type: boolean + cutoff_time: + format: date-time + type: number x-stream-index: "004" - noise_cancellation: - $ref: '#/components/schemas/NoiseCancellationSettings' - x-stream-index: "007" - opus_dtx_enabled: - type: boolean + filter: + additionalProperties: {} + type: object x-stream-index: "002" - redundant_coding_enabled: - type: boolean - x-stream-index: "003" - speaker_default_on: - type: boolean + min_popularity: + format: int32 + type: integer x-stream-index: "005" + sort: + items: + $ref: '#/components/schemas/SortParam' + type: array + x-stream-index: "003" + type: + type: string + x-stream-index: "001" required: - - access_request_enabled - - opus_dtx_enabled - - redundant_coding_enabled - - mic_default_on - - speaker_default_on - - default_device + - cutoff_time type: object - AudioSettingsRequest: + ActivityUnpinnedEvent: + description: Emitted when an activity is unpinned. + nullable: true properties: - access_request_enabled: - type: boolean - x-stream-index: "001" - default_device: - enum: - - speaker - - earpiece - type: string - x-stream-index: "006" - mic_default_on: - type: boolean - x-stream-index: "004" - noise_cancellation: - $ref: '#/components/schemas/NoiseCancellationSettings' - x-stream-index: "007" - opus_dtx_enabled: - type: boolean - x-stream-index: "002" - redundant_coding_enabled: - type: boolean - x-stream-index: "003" - speaker_default_on: - type: boolean - x-stream-index: "005" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + feed_visibility: + type: string + x-stream-index: "002.003" + fid: + description: The ID of the feed + title: Feed ID + type: string + x-stream-index: "002.002" + pinned_activity: + $ref: '#/components/schemas/PinActivityResponse' + x-stream-index: "001" + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 + type: + default: feeds.activity.unpinned + description: 'The type of event: "feeds.activity.unpinned" in this case' + title: Event Type + type: string + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who unpinned the activity + title: User + x-stream-index: "003.001" required: - - default_device + - pinned_activity + - type + - created_at + - custom + - fid + title: ActivityUnpinnedEvent type: object - AudioSettingsResponse: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + ActivityUpdatedEvent: + description: Emitted when an activity is updated. + nullable: true properties: - access_request_enabled: - type: boolean + activity: + $ref: '#/components/schemas/ActivityResponse' + description: The activity that was updated + title: Activity x-stream-index: "001" - default_device: - enum: - - speaker - - earpiece + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + feed_visibility: type: string - x-stream-index: "006" - mic_default_on: - type: boolean - x-stream-index: "004" - noise_cancellation: - $ref: '#/components/schemas/NoiseCancellationSettings' - x-stream-index: "007" - opus_dtx_enabled: - type: boolean - x-stream-index: "002" - redundant_coding_enabled: - type: boolean - x-stream-index: "003" - speaker_default_on: - type: boolean - x-stream-index: "005" + x-stream-index: "002.003" + fid: + type: string + x-stream-index: "002.002" + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 + type: + default: feeds.activity.updated + description: The type of the event + title: Event Type + type: string + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who updated the activity + title: User + x-stream-index: "003.001" required: - - access_request_enabled - - opus_dtx_enabled - - redundant_coding_enabled - - mic_default_on - - speaker_default_on - - default_device + - activity + - type + - created_at + - custom + - fid + title: ActivityUpdatedEvent type: object - AutomodDetails: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + AddActivityRequest: + nullable: true properties: - action: + attachments: + description: List of attachments for the activity + items: + $ref: '#/components/schemas/Attachment' + title: Attachments + type: array + x-stream-index: "001.006" + custom: + additionalProperties: {} + description: Custom data for the activity + title: Custom Data + type: object + x-stream-index: "001.017" + expires_at: + description: Expiration time for the activity + title: Expires At type: string - x-stream-index: "001" - image_labels: + x-stream-index: "001.010" + feeds: + description: List of feed IDs to add the activity to items: type: string + maximum: 255 + minimum: 1 + title: Feed IDs type: array - x-stream-index: "005" - message_details: - $ref: '#/components/schemas/FlagMessageDetails' + x-stream-index: "001.004" + filter_tags: + description: Tags for filtering activities + items: + type: string + maximum: 255 + title: Filter Tags + type: array + x-stream-index: "001.013" + id: + description: Optional ID for the activity + maxLength: 255 + title: Activity ID + type: string + x-stream-index: "001.001" + interest_tags: + description: Tags for indicating user interests + items: + type: string + maximum: 255 + title: Interest Tags + type: array + x-stream-index: "001.014" + location: + $ref: '#/components/schemas/ActivityLocation' + description: Geographic location related to the activity + title: Location + x-stream-index: "001.009" + mentioned_user_ids: + description: List of users mentioned in the activity + items: + type: string + maximum: 255 + title: Mentioned User IDs + type: array + x-stream-index: "001.011" + parent_id: + description: ID of parent activity for replies/comments + maxLength: 255 + title: Parent ID + type: string + x-stream-index: "001.015" + poll_id: + description: ID of a poll to attach to activity + title: Poll ID + type: string + x-stream-index: "001.016" + search_data: + additionalProperties: {} + description: Additional data for search indexing + title: Search Data + type: object + x-stream-index: "001.012" + text: + description: Text content of the activity + title: Text + type: string + x-stream-index: "001.005" + type: + description: Type of activity + maxLength: 255 + title: Activity Type + type: string + x-stream-index: "001.002" + visibility: + description: Visibility setting for the activity + enum: + - public + - private + - tag + title: Visibility + type: string + x-stream-index: "001.007" + visibility_tag: + description: If visibility is 'tag', this is the tag name and is required + maxLength: 32 + title: Visibility Tag + type: string + x-stream-index: "001.008" + required: + - type + - feeds + title: Activity Request + type: object + AddActivityResponse: + nullable: true + properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + description: The created activity + title: Activity + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - activity + - duration + title: Add Activity Response + type: object + AddBookmarkRequest: + nullable: true + properties: + custom: + additionalProperties: {} + description: Custom data for the bookmark + title: Custom Data + type: object x-stream-index: "004" - original_message_type: + folder_id: + description: ID of the folder to add the bookmark to + maxLength: 255 + title: Folder ID type: string x-stream-index: "002" - result: - $ref: '#/components/schemas/MessageModerationResult' + new_folder: + $ref: '#/components/schemas/AddFolderRequest' + description: Create a new folder for this bookmark + title: New Folder x-stream-index: "003" + title: Add Bookmark Request type: object - AutomodPlatformCircumventionConfig: + AddBookmarkResponse: + nullable: true properties: - async: - type: boolean + bookmark: + $ref: '#/components/schemas/BookmarkResponse' + description: The created bookmark + title: Bookmark x-stream-index: "001" - enabled: - type: boolean - x-stream-index: "002" - rules: - items: - $ref: '#/components/schemas/AutomodRule' - type: array - x-stream-index: "003" + duration: + type: string + x-stream-index: "002.001" required: - - enabled - - rules + - bookmark + - duration + title: Add Bookmark Response type: object - AutomodRule: + AddCommentReactionRequest: + nullable: true properties: - action: - enum: - - flag - - shadow - - remove - - bounce - - bounce_flag - - bounce_remove - type: string + create_notification_activity: + description: Whether to create a notification activity for this reaction + title: boolean + type: boolean + x-stream-index: "004" + custom: + additionalProperties: {} + description: Optional custom data to add to the reaction + title: object + type: object x-stream-index: "003" - label: + skip_push: + type: boolean + x-stream-index: "005" + type: + description: The type of reaction, eg upvote, like, ... + maxLength: 255 + title: string type: string - x-stream-index: "001" - threshold: - format: float - maximum: 1 - minimum: 0 - type: number x-stream-index: "002" required: - - label - - threshold - - action + - type type: object - AutomodSemanticFiltersConfig: + AddCommentReactionResponse: + nullable: true properties: - async: - type: boolean + comment: + $ref: '#/components/schemas/CommentResponse' + description: The comment the reaction was added to + title: object x-stream-index: "001" - enabled: - type: boolean + duration: + description: Duration of the request + title: string + type: string + x-stream-index: "003.001" + reaction: + $ref: '#/components/schemas/FeedsReactionResponse' + description: The created or updated reaction + title: object x-stream-index: "002" - rules: + required: + - comment + - reaction + - duration + type: object + AddCommentRequest: + nullable: true + properties: + attachments: + description: Media attachments for the reply items: - $ref: '#/components/schemas/AutomodSemanticFiltersRule' + $ref: '#/components/schemas/Attachment' + title: Attachments type: array + x-stream-index: "004" + comment: + description: Text content of the comment + title: Comment + type: string x-stream-index: "003" + create_notification_activity: + description: Whether to create a notification activity for this comment + title: Create Notification Activity + type: boolean + x-stream-index: "008" + custom: + additionalProperties: {} + description: Custom data for the comment + title: Custom Data + type: object + x-stream-index: "007" + mentioned_user_ids: + description: List of users mentioned in the reply + items: + type: string + maximum: 255 + title: Mentioned User IDs + type: array + x-stream-index: "005" + object_id: + description: ID of the object to comment on + title: Object ID + type: string + x-stream-index: "001" + object_type: + description: Type of the object to comment on + title: Object Type + type: string + x-stream-index: "002" + parent_id: + description: ID of parent comment for replies + title: Parent ID + type: string + x-stream-index: "006" + skip_push: + type: boolean + x-stream-index: "009" required: - - enabled - - rules + - object_id + - object_type + - comment + title: Add Comment Request type: object - AutomodSemanticFiltersRule: + AddCommentResponse: + nullable: true properties: - action: - enum: - - flag - - shadow - - remove + comment: + $ref: '#/components/schemas/CommentResponse' + description: The created comment + title: Comment + x-stream-index: "001" + duration: type: string - x-stream-index: "003" + x-stream-index: "002.001" + required: + - comment + - duration + title: Add Comment Response + type: object + AddCommentsBatchRequest: + nullable: true + properties: + comments: + description: List of comments to add + items: + $ref: '#/components/schemas/AddCommentRequest' + title: Comments + type: array + x-stream-index: "001" + required: + - comments + title: Add Comments Batch Request + type: object + AddCommentsBatchResponse: + nullable: true + properties: + comments: + description: List of comments added + items: + $ref: '#/components/schemas/CommentResponse' + title: Comments + type: array + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - comments + - duration + title: Add Comments Batch Response + type: object + AddFolderRequest: + properties: + custom: + additionalProperties: {} + description: Custom data for the folder + title: Custom Data + type: object + x-stream-index: "002" name: + description: Name of the folder + maxLength: 255 + title: Name type: string x-stream-index: "001" - threshold: - format: float - maximum: 1 - minimum: 0 - type: number - x-stream-index: "002" required: - name - - threshold - - action + title: Add Folder Request type: object - AutomodToxicityConfig: + AddReactionRequest: + nullable: true properties: - async: + create_notification_activity: + description: Whether to create a notification activity for this reaction + title: Create Notification Activity type: boolean - x-stream-index: "001" - enabled: + x-stream-index: "004" + custom: + additionalProperties: {} + description: Custom data for the reaction + title: Custom Data + type: object + x-stream-index: "003" + skip_push: type: boolean + x-stream-index: "005" + type: + description: Type of reaction + maxLength: 255 + title: Reaction Type + type: string x-stream-index: "002" - rules: - items: - $ref: '#/components/schemas/AutomodRule' - type: array - x-stream-index: "003" required: - - enabled - - rules + - type + title: Add Reaction Request type: object - BackstageSettings: + AddReactionResponse: + nullable: true properties: - enabled: - type: boolean + activity: + $ref: '#/components/schemas/ActivityResponse' x-stream-index: "001" - join_ahead_time_seconds: - format: int32 - type: integer + duration: + type: string + x-stream-index: "003.001" + reaction: + $ref: '#/components/schemas/FeedsReactionResponse' + description: The created reaction + title: Reaction x-stream-index: "002" required: - - enabled + - activity + - reaction + - duration + title: Add Reaction Response type: object - BackstageSettingsRequest: + AggregatedActivityResponse: properties: - enabled: - type: boolean + activities: + description: List of activities in this aggregation + items: + $ref: '#/components/schemas/ActivityResponse' + title: Activities + type: array x-stream-index: "001" - join_ahead_time_seconds: + activity_count: + description: Number of activities in this aggregation format: int32 + title: Activity Count type: integer x-stream-index: "002" + created_at: + description: When the aggregation was created + format: date-time + title: Created At + type: number + x-stream-index: "006" + group: + description: Grouping identifier + title: Group + type: string + x-stream-index: "004" + score: + description: Ranking score for this aggregation + format: float + title: Score + type: number + x-stream-index: "005" + updated_at: + description: When the aggregation was last updated + format: date-time + title: Updated At + type: number + x-stream-index: "007" + user_count: + description: Number of unique users in this aggregation + format: int32 + title: User Count + type: integer + x-stream-index: "003" + required: + - activities + - activity_count + - user_count + - group + - score + - created_at + - updated_at + title: Aggregated Activity type: object - BackstageSettingsResponse: + AggregationConfig: properties: - enabled: - type: boolean + format: + type: string x-stream-index: "001" - join_ahead_time_seconds: + group_size: format: int32 type: integer x-stream-index: "002" - required: - - enabled type: object - Ban: - nullable: true + AnyEvent: properties: - channel: - $ref: '#/components/schemas/Channel' - x-stream-index: "004" created_at: format: date-time type: number - x-stream-index: "012" - created_by: - $ref: '#/components/schemas/User' - x-stream-index: "011" - expires: - format: date-time - type: number - x-stream-index: "007" - reason: + x-stream-index: "001.002" + type: + default: '*' type: string - x-stream-index: "008" - shadow: - type: boolean - x-stream-index: "009" - target: - $ref: '#/components/schemas/User' - x-stream-index: "006" + x-stream-index: "001.001" required: - - shadow + - type - created_at + title: AnyEvent type: object - BanActionRequest: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + AppEventResponse: properties: - channel_ban_only: + async_url_enrich_enabled: + description: boolean + title: Async URL Enrichment Enabled type: boolean - x-stream-index: "003" - delete_messages: - enum: - - soft - - pruning - - hard - type: string - x-stream-index: "005" - ip_ban: + x-stream-index: "002" + auto_translation_enabled: + description: boolean + title: Auto Translation Enabled type: boolean + x-stream-index: "003" + file_upload_config: + $ref: '#/components/schemas/FileUploadConfig' + description: file upload config + title: File Upload Config x-stream-index: "004" - reason: + image_upload_config: + $ref: '#/components/schemas/FileUploadConfig' + description: file upload config + title: Image Upload Config + x-stream-index: "005" + name: + description: string + title: App name type: string - x-stream-index: "002" - shadow: - type: boolean x-stream-index: "001" - timeout: - format: int32 - type: integer - x-stream-index: "006" + required: + - name + - auto_translation_enabled type: object - BanOptions: + AppResponseFields: properties: - duration: - format: int32 - type: integer - x-stream-index: "001" - ip_ban: - type: boolean - x-stream-index: "004" - reason: - type: string - x-stream-index: "002" - shadow_ban: + async_url_enrich_enabled: type: boolean - x-stream-index: "003" - required: - - duration - - reason - - shadow_ban - - ip_ban - type: object - BanRequest: - nullable: true - properties: - banned_by: - $ref: '#/components/schemas/UserRequest' - description: Details about the user performing the ban - title: Banned By - x-stream-index: "008" - banned_by_id: - description: ID of the user performing the ban - title: Banned By ID - type: string - x-stream-index: "007" - channel_cid: - description: Channel where the ban applies - title: Channel CID - type: string - x-stream-index: "004" - delete_messages: - enum: - - soft - - pruning - - hard - type: string - x-stream-index: "009" - ip_ban: - description: Whether to ban the user's IP address - title: IP Ban - type: boolean - x-stream-index: "006" - reason: - description: Optional explanation for the ban - title: Reason - type: string - x-stream-index: "003" - shadow: - description: Whether this is a shadow ban - title: Shadow + x-stream-index: "017" + auto_translation_enabled: type: boolean - x-stream-index: "005" - target_user_id: - description: ID of the user to ban - title: Target User ID + x-stream-index: "020" + file_upload_config: + $ref: '#/components/schemas/FileUploadConfig' + x-stream-index: "030" + image_upload_config: + $ref: '#/components/schemas/FileUploadConfig' + x-stream-index: "031" + name: type: string x-stream-index: "001" - timeout: - description: Duration of the ban in minutes - minimum: 0 - title: Timeout - type: integer - x-stream-index: "002" required: - - target_user_id + - name + - organization + - push_notifications + - webhook_url + - moderation_webhook_url + - channel_configs + - call_types + - policies + - suspended + - suspended_explanation + - disable_auth_checks + - disable_permissions_checks + - permission_version + - user_search_disallowed_roles + - multi_tenant_enabled + - image_moderation_enabled + - async_url_enrich_enabled + - auto_translation_enabled + - custom_action_handler_url + - enforce_unique_usernames + - sqs_url + - sqs_key + - sqs_secret + - sns_topic_arn + - sns_key + - sns_secret + - file_upload_config + - image_upload_config + - grants + - campaign_enabled + - webhook_events + - reminders_interval + - cdn_expiration_seconds + - video_provider + - moderation_enabled + - moderation_multitenant_blocklist_enabled + - guest_user_creation_disabled + - event_hooks + - use_hook_v2 + - user_response_time_enabled + - moderation_bulk_submit_action_enabled + - moderation_llm_configurability_enabled type: object - BanResponse: + AppUpdatedEvent: + description: Emitted when app settings are updated nullable: true properties: - banned_by: - $ref: '#/components/schemas/UserResponse' - x-stream-index: "006" - channel: - $ref: '#/components/schemas/ChannelResponse' - x-stream-index: "001" + app: + $ref: '#/components/schemas/AppEventResponse' + description: application configuration + title: App settings + x-stream-index: "002" created_at: + description: Date/time of creation format: date-time + title: Created at type: number - x-stream-index: "007" - expires: + x-stream-index: "001.003" + custom: + additionalProperties: {} + type: object + x-stream-index: "001.007" + received_at: format: date-time type: number - x-stream-index: "003" - reason: + x-stream-index: "001.004" + type: + default: app.updated + description: 'The type of event: "app.updated" in this case' + title: Event Type type: string - x-stream-index: "004" - shadow: - type: boolean - x-stream-index: "005" - user: - $ref: '#/components/schemas/UserResponse' - x-stream-index: "002" + x-stream-index: "001.002" required: + - type - created_at + - custom + - app + title: AppUpdatedEvent type: object - BlockContentOptions: - properties: - reason: - type: string - x-stream-index: "001" - required: - - reason - type: object - BlockListConfig: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + Attachment: + description: An attachment is a message object that represents a file uploaded + by a user. + nullable: true properties: - async: - type: boolean - x-stream-index: "001" - enabled: - type: boolean - x-stream-index: "002" - rules: + actions: items: - $ref: '#/components/schemas/BlockListRule' - maximum: 10 + $ref: '#/components/schemas/Action' type: array - x-stream-index: "003" - required: - - enabled - - rules - type: object - BlockListOptions: - properties: - behavior: - description: Blocklist behavior - enum: - - flag - - block - - shadow_block - title: Behavior + x-stream-index: "015" + asset_url: type: string - x-stream-index: "002" - blocklist: - description: Blocklist name - title: Blocklist + x-stream-index: "017" + author_icon: type: string - x-stream-index: "001" - required: - - blocklist - - behavior - type: object - BlockListResponse: - description: Block list contains restricted words - properties: - created_at: - description: Date/time of creation - format: date-time - title: Created at - type: number - x-stream-index: "001" - id: + x-stream-index: "007" + author_link: type: string - x-stream-index: "003" - name: - description: Block list name - title: Name + x-stream-index: "006" + author_name: type: string - x-stream-index: "004" - team: + x-stream-index: "005" + color: type: string - x-stream-index: "007" - type: - description: Block list type. - title: Type + x-stream-index: "003" + custom: + additionalProperties: {} + type: object + x-stream-index: "018" + fallback: type: string - x-stream-index: "005" - updated_at: - description: Date/time of the last update - format: date-time - title: Updated at - type: number x-stream-index: "002" - words: - description: List of words to block + fields: items: - type: string - title: Words + $ref: '#/components/schemas/Field' type: array - x-stream-index: "006" - required: - - name - - type - - words - title: Block list - type: object - x-stream-docs-page-id: block_lists - BlockListRule: - properties: - action: - enum: - - flag - - mask_flag - - shadow - - remove - - bounce - - bounce_flag - - bounce_remove + x-stream-index: "016" + footer: type: string - x-stream-index: "003" - name: + x-stream-index: "013" + footer_icon: + type: string + x-stream-index: "014" + giphy: + $ref: '#/components/schemas/Images' + x-stream-index: "019" + image_url: + type: string + x-stream-index: "011" + og_scrape_url: + type: string + x-stream-index: "020" + original_height: + format: int32 + type: integer + x-stream-index: "022" + original_width: + format: int32 + type: integer + x-stream-index: "021" + pretext: + type: string + x-stream-index: "004" + text: + type: string + x-stream-index: "010" + thumb_url: + type: string + x-stream-index: "012" + title: + type: string + x-stream-index: "008" + title_link: + type: string + x-stream-index: "009" + type: + description: Attachment type (e.g. image, video, url) + title: Type type: string x-stream-index: "001" - team: + required: + - custom + title: Attachment + type: object + x-stream-docs-page-id: file_uploads + AudioSettings: + properties: + access_request_enabled: + type: boolean + x-stream-index: "001" + default_device: + enum: + - speaker + - earpiece type: string + x-stream-index: "006" + mic_default_on: + type: boolean + x-stream-index: "004" + noise_cancellation: + $ref: '#/components/schemas/NoiseCancellationSettings' + x-stream-index: "007" + opus_dtx_enabled: + type: boolean x-stream-index: "002" + redundant_coding_enabled: + type: boolean + x-stream-index: "003" + speaker_default_on: + type: boolean + x-stream-index: "005" required: - - name - - team - - action + - access_request_enabled + - opus_dtx_enabled + - redundant_coding_enabled + - mic_default_on + - speaker_default_on + - default_device type: object - BlockUserRequest: - description: BlockUserRequest is the payload for blocking a user. - nullable: true + AudioSettingsRequest: properties: - user_id: - description: the user to block - title: UserID + access_request_enabled: + type: boolean + x-stream-index: "001" + default_device: + enum: + - speaker + - earpiece type: string + x-stream-index: "006" + mic_default_on: + type: boolean + x-stream-index: "004" + noise_cancellation: + $ref: '#/components/schemas/NoiseCancellationSettings' + x-stream-index: "007" + opus_dtx_enabled: + type: boolean + x-stream-index: "002" + redundant_coding_enabled: + type: boolean x-stream-index: "003" + speaker_default_on: + type: boolean + x-stream-index: "005" required: - - user_id - title: BlockUserRequest + - default_device type: object - BlockUserResponse: - description: BlockUserResponse is the payload for blocking a user. - nullable: true + AudioSettingsResponse: properties: - duration: - description: Duration of the request in milliseconds - title: Duration + access_request_enabled: + type: boolean + x-stream-index: "001" + default_device: + enum: + - speaker + - earpiece type: string - x-stream-index: "001.001" + x-stream-index: "006" + mic_default_on: + type: boolean + x-stream-index: "004" + noise_cancellation: + $ref: '#/components/schemas/NoiseCancellationSettings' + x-stream-index: "007" + opus_dtx_enabled: + type: boolean + x-stream-index: "002" + redundant_coding_enabled: + type: boolean + x-stream-index: "003" + speaker_default_on: + type: boolean + x-stream-index: "005" required: - - duration - title: BlockUserResponse + - access_request_enabled + - opus_dtx_enabled + - redundant_coding_enabled + - mic_default_on + - speaker_default_on + - default_device type: object - BlockUsersRequest: - nullable: true + AutomodDetails: properties: - blocked_user_id: - description: User id to block - title: BlockedUserID + action: type: string x-stream-index: "001" - required: - - blocked_user_id + image_labels: + items: + type: string + type: array + x-stream-index: "005" + message_details: + $ref: '#/components/schemas/FlagMessageDetails' + x-stream-index: "004" + original_message_type: + type: string + x-stream-index: "002" + result: + $ref: '#/components/schemas/MessageModerationResult' + x-stream-index: "003" type: object - BlockUsersResponse: - nullable: true + AutomodPlatformCircumventionConfig: properties: - blocked_by_user_id: - description: User id who blocked another user - title: BlockedByUserID - type: string + async: + type: boolean + x-stream-index: "001" + enabled: + type: boolean x-stream-index: "002" - blocked_user_id: - description: User id who got blocked - title: BlockedUserID - type: string + rules: + items: + $ref: '#/components/schemas/AutomodRule' + type: array x-stream-index: "003" - created_at: - description: Timestamp when the user was blocked - format: date-time - title: CreatedAt - type: number - x-stream-index: "004" - duration: - description: Duration of the request in milliseconds - title: Duration - type: string - x-stream-index: "001.001" required: - - duration - - blocked_by_user_id - - blocked_user_id - - created_at + - enabled + - rules type: object - BlockedUserEvent: - description: |- - This event is sent to call participants to notify when a user is blocked on a call, clients can use this event to show a notification. - If the user is the current user, the client should leave the call screen as well + AutomodRule: properties: - blocked_by_user: - $ref: '#/components/schemas/UserResponse' - description: The user that blocked the user, null if the user was blocked - by server-side - title: Blocked by - x-stream-index: "004" - call_cid: + action: + enum: + - flag + - shadow + - remove + - bounce + - bounce_flag + - bounce_remove type: string - x-stream-index: "002.001" - created_at: - format: date-time - type: number - x-stream-index: "001.002" - type: - default: call.blocked_user - description: 'The type of event: "call.blocked_user" in this case' - title: Event Type + x-stream-index: "003" + label: type: string - x-stream-index: "001.001" - user: - $ref: '#/components/schemas/UserResponse' - description: The user that was blocked - title: User - x-stream-index: "003" - required: - - type - - created_at - - call_cid - - user - title: BlockedUserEvent - type: object - x-stream-event-call-type: true - x-stream-event-doc-group: call - x-stream-is-event: true - x-stream-ws-base-event-name: VideoEvent - BlockedUserResponse: - nullable: true - properties: - blocked_user: - $ref: '#/components/schemas/UserResponse' - description: User who got blocked - title: User - x-stream-index: "003" - blocked_user_id: - description: ID of the user who got blocked - title: UserID - type: string - x-stream-index: "004" - created_at: - format: date-time - type: number - x-stream-index: "005" - user: - $ref: '#/components/schemas/UserResponse' - description: User who blocked another user - title: User x-stream-index: "001" - user_id: - description: ID of the user who blocked another user - title: UserID - type: string + threshold: + format: float + maximum: 1 + minimum: 0 + type: number x-stream-index: "002" required: - - user - - user_id - - blocked_user - - blocked_user_id - - created_at + - label + - threshold + - action type: object - BodyguardRule: + AutomodSemanticFiltersConfig: properties: - action: - enum: - - flag - - shadow - - remove - - bounce - - bounce_flag - - bounce_remove - type: string - x-stream-index: "002" - label: - type: string + async: + type: boolean x-stream-index: "001" - severity_rules: + enabled: + type: boolean + x-stream-index: "002" + rules: items: - $ref: '#/components/schemas/BodyguardSeverityRule' + $ref: '#/components/schemas/AutomodSemanticFiltersRule' type: array x-stream-index: "003" required: - - label - - action - - severity_rules + - enabled + - rules type: object - BodyguardSeverityRule: + AutomodSemanticFiltersRule: properties: action: enum: - flag - shadow - remove - - bounce - - bounce_flag - - bounce_remove type: string - x-stream-index: "002" - severity: - enum: - - low - - medium - - high - - critical + x-stream-index: "003" + name: type: string x-stream-index: "001" + threshold: + format: float + maximum: 1 + minimum: 0 + type: number + x-stream-index: "002" required: - - severity + - name + - threshold - action type: object - Bound: + AutomodToxicityConfig: properties: - inclusive: + async: type: boolean - x-stream-index: "002" - value: - format: float - type: number x-stream-index: "001" + enabled: + type: boolean + x-stream-index: "002" + rules: + items: + $ref: '#/components/schemas/AutomodRule' + type: array + x-stream-index: "003" required: - - value - - inclusive + - enabled + - rules type: object - BroadcastSettings: + BackstageSettings: properties: enabled: type: boolean x-stream-index: "001" - hls: - $ref: '#/components/schemas/HLSSettings' + join_ahead_time_seconds: + format: int32 + type: integer x-stream-index: "002" - rtmp: - $ref: '#/components/schemas/RTMPSettings' - x-stream-index: "003" required: - enabled type: object - BroadcastSettingsRequest: + BackstageSettingsRequest: properties: enabled: type: boolean x-stream-index: "001" - hls: - $ref: '#/components/schemas/HLSSettingsRequest' + join_ahead_time_seconds: + format: int32 + type: integer x-stream-index: "002" - rtmp: - $ref: '#/components/schemas/RTMPSettingsRequest' - x-stream-index: "003" type: object - BroadcastSettingsResponse: - description: BroadcastSettingsResponse is the payload for broadcasting settings + BackstageSettingsResponse: properties: enabled: - title: Enabled type: boolean x-stream-index: "001" - hls: - $ref: '#/components/schemas/HLSSettingsResponse' - title: HLS + join_ahead_time_seconds: + format: int32 + type: integer x-stream-index: "002" - rtmp: - $ref: '#/components/schemas/RTMPSettingsResponse' - title: RTMP - x-stream-index: "003" required: - enabled - - hls - - rtmp - title: BroadcastSettingsResponse type: object - Call: + Ban: + nullable: true properties: - AppPK: - format: int32 - type: integer - writeOnly: true - x-stream-index: "002" - Backstage: - type: boolean - writeOnly: true - x-stream-index: "023" - BlockedUserIDs: - items: - type: string - type: array - writeOnly: true - x-stream-index: "018" - BlockedUsers: - items: - $ref: '#/components/schemas/User' - type: array - writeOnly: true - x-stream-index: "019" - CID: - type: string - writeOnly: true - x-stream-index: "005" - CallType: - $ref: '#/components/schemas/CallType' - x-stream-index: "020" - ChannelCID: - type: string - writeOnly: true - x-stream-index: "032" - CreatedAt: + channel: + $ref: '#/components/schemas/Channel' + x-stream-index: "004" + created_at: format: date-time type: number - writeOnly: true - x-stream-index: "013" - CreatedBy: - $ref: '#/components/schemas/User' - x-stream-index: "008" - CreatedByUserID: - type: string - writeOnly: true - x-stream-index: "007" - CurrentSessionID: - type: string - writeOnly: true - x-stream-index: "024" - Custom: - additionalProperties: {} - type: object - writeOnly: true x-stream-index: "012" - DeletedAt: - format: date-time - type: number - writeOnly: true - x-stream-index: "028" - EgressUpdatedAt: - format: date-time - type: number - writeOnly: true - x-stream-index: "027" - Egresses: - items: - $ref: '#/components/schemas/CallEgress' - type: array - writeOnly: true - x-stream-index: "015" - EndedAt: + created_by: + $ref: '#/components/schemas/User' + x-stream-index: "011" + expires: format: date-time type: number - writeOnly: true - x-stream-index: "017" - ID: + x-stream-index: "007" + reason: type: string - writeOnly: true - x-stream-index: "004" - JoinAheadTimeSeconds: - format: int32 - type: integer - writeOnly: true - x-stream-index: "031" - LastHeartbeatAt: - format: date-time - type: number - writeOnly: true - x-stream-index: "030" - LastSessionID: - type: string - writeOnly: true - x-stream-index: "025" - MemberCount: - format: int32 - type: integer - writeOnly: true - x-stream-index: "010" - MemberLookup: - $ref: '#/components/schemas/MemberLookup' - x-stream-index: "011" - Members: - items: - $ref: '#/components/schemas/CallMember' - type: array - writeOnly: true + x-stream-index: "008" + shadow: + type: boolean x-stream-index: "009" - Session: - $ref: '#/components/schemas/CallSession' - x-stream-index: "026" - Settings: - $ref: '#/components/schemas/CallSettings' - x-stream-index: "022" - SettingsOverrides: - $ref: '#/components/schemas/CallSettings' - x-stream-index: "021" - StartsAt: - format: date-time - type: number - writeOnly: true - x-stream-index: "016" - Team: - type: string - writeOnly: true + target: + $ref: '#/components/schemas/User' x-stream-index: "006" - ThumbnailURL: - type: string - writeOnly: true - x-stream-index: "029" - Type: - type: string - writeOnly: true - x-stream-index: "003" - UpdatedAt: - format: date-time - type: number - writeOnly: true - x-stream-index: "014" required: - - AppPK - - Type - - ID - - CID - - Team - - CreatedByUserID - - Members - - Custom - - CreatedAt - - UpdatedAt - - Egresses - - BlockedUserIDs - - BlockedUsers - - Backstage - - CurrentSessionID - - LastSessionID - - ThumbnailURL - - ChannelCID + - shadow + - created_at type: object - CallAcceptedEvent: - description: This event is sent when a user accepts a notification to join a - call. + BanActionRequest: properties: - call: - $ref: '#/components/schemas/CallResponse' + channel_ban_only: + type: boolean x-stream-index: "003" - call_cid: - type: string - x-stream-index: "002.001" - created_at: - format: date-time - type: number - x-stream-index: "001.002" - type: - default: call.accepted - description: 'The type of event: "call.accepted" in this case' - title: Event Type + delete_messages: + enum: + - soft + - pruning + - hard type: string - x-stream-index: "001.001" - user: - $ref: '#/components/schemas/UserResponse' - description: The user who accepted the call - title: User + x-stream-index: "005" + ip_ban: + type: boolean x-stream-index: "004" - required: - - type - - created_at - - call_cid - - call - - user - title: CallAcceptedEvent + reason: + type: string + x-stream-index: "002" + shadow: + type: boolean + x-stream-index: "001" + timeout: + format: int32 + type: integer + x-stream-index: "006" type: object - x-stream-event-call-type: true - x-stream-event-doc-group: ring - x-stream-is-event: true - x-stream-ws-base-event-name: VideoEvent - CallClosedCaption: - description: CallClosedCaption represents a closed caption of a call. + BanOptions: properties: - end_time: - format: date-time - title: The end time of the closed caption. - type: number + duration: + format: int32 + type: integer + x-stream-index: "001" + ip_ban: + type: boolean + x-stream-index: "004" + reason: + type: string + x-stream-index: "002" + shadow_ban: + type: boolean x-stream-index: "003" - speaker_id: - title: The speaker ID of the closed caption. + type: object + BanRequest: + nullable: true + properties: + banned_by: + $ref: '#/components/schemas/UserRequest' + description: Details about the user performing the ban + title: Banned By + x-stream-index: "008" + banned_by_id: + description: ID of the user performing the ban + title: Banned By ID + type: string + x-stream-index: "007" + channel_cid: + description: Channel where the ban applies + title: Channel CID type: string x-stream-index: "004" - start_time: - format: date-time - title: The start time of the closed caption. - type: number - x-stream-index: "002" - text: - title: The text of the closed caption. + delete_messages: + enum: + - soft + - pruning + - hard type: string - x-stream-index: "001" - user: - $ref: '#/components/schemas/UserResponse' - title: The full user for the closed caption. + x-stream-index: "009" + ip_ban: + description: Whether to ban the user's IP address + title: IP Ban + type: boolean + x-stream-index: "006" + reason: + description: Optional explanation for the ban + title: Reason + type: string + x-stream-index: "003" + shadow: + description: Whether this is a shadow ban + title: Shadow + type: boolean x-stream-index: "005" + target_user_id: + description: ID of the user to ban + title: Target User ID + type: string + x-stream-index: "001" + timeout: + description: Duration of the ban in minutes + minimum: 0 + title: Timeout + type: integer + x-stream-index: "002" required: - - text - - start_time - - end_time - - speaker_id - - user - title: CallClosedCaption + - target_user_id type: object - CallClosedCaptionsFailedEvent: - description: This event is sent when call closed captions has failed + BanResponse: + nullable: true properties: - call_cid: - type: string - x-stream-index: "002.001" + banned_by: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "006" + channel: + $ref: '#/components/schemas/ChannelResponse' + x-stream-index: "001" created_at: format: date-time type: number - x-stream-index: "001.002" - type: - default: call.closed_captions_failed - description: 'The type of event: "call.closed_captions_failed" in this case' - title: Event Type + x-stream-index: "007" + expires: + format: date-time + type: number + x-stream-index: "003" + reason: type: string - x-stream-index: "001.001" + x-stream-index: "004" + shadow: + type: boolean + x-stream-index: "005" + user: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "002" required: - - type - created_at - - call_cid - title: CallClosedCaptionsFailedEvent type: object - x-stream-event-call-type: true - x-stream-event-doc-group: transcription - x-stream-is-event: true - x-stream-ws-base-event-name: VideoEvent - CallClosedCaptionsStartedEvent: - description: This event is sent when call closed caption has started + BlockContentOptions: properties: - call_cid: + reason: type: string - x-stream-index: "002.001" + x-stream-index: "001" + type: object + BlockListConfig: + properties: + async: + type: boolean + x-stream-index: "001" + enabled: + type: boolean + x-stream-index: "002" + rules: + items: + $ref: '#/components/schemas/BlockListRule' + maximum: 10 + type: array + x-stream-index: "003" + required: + - enabled + - rules + type: object + BlockListOptions: + properties: + behavior: + description: Blocklist behavior + enum: + - flag + - block + - shadow_block + title: Behavior + type: string + x-stream-index: "002" + blocklist: + description: Blocklist name + title: Blocklist + type: string + x-stream-index: "001" + required: + - blocklist + - behavior + type: object + BlockListResponse: + description: Block list contains restricted words + properties: created_at: + description: Date/time of creation format: date-time + title: Created at type: number - x-stream-index: "001.002" + x-stream-index: "001" + id: + type: string + x-stream-index: "003" + name: + description: Block list name + title: Name + type: string + x-stream-index: "004" + team: + type: string + x-stream-index: "007" type: - default: call.closed_captions_started - description: 'The type of event: "call.closed_captions_started" in this - case' - title: Event Type + description: Block list type. + title: Type type: string - x-stream-index: "001.001" + x-stream-index: "005" + updated_at: + description: Date/time of the last update + format: date-time + title: Updated at + type: number + x-stream-index: "002" + words: + description: List of words to block + items: + type: string + title: Words + type: array + x-stream-index: "006" required: + - name - type - - created_at - - call_cid - title: CallClosedCaptionsStartedEvent + - words + title: Block list type: object - x-stream-event-call-type: true - x-stream-event-doc-group: transcription - x-stream-is-event: true - x-stream-ws-base-event-name: VideoEvent - CallClosedCaptionsStoppedEvent: - description: This event is sent when call closed captions has stopped + x-stream-docs-page-id: block_lists + BlockListRule: properties: - call_cid: + action: + enum: + - flag + - mask_flag + - shadow + - remove + - bounce + - bounce_flag + - bounce_remove type: string - x-stream-index: "002.001" - created_at: - format: date-time - type: number - x-stream-index: "001.002" - type: - default: call.closed_captions_stopped - description: 'The type of event: "call.transcription_stopped" in this case' - title: Event Type + x-stream-index: "003" + name: type: string - x-stream-index: "001.001" + x-stream-index: "001" + team: + type: string + x-stream-index: "002" required: - - type - - created_at - - call_cid - title: CallClosedCaptionsStoppedEvent + - name + - team + - action type: object - x-stream-event-call-type: true - x-stream-event-doc-group: transcription - x-stream-is-event: true - x-stream-ws-base-event-name: VideoEvent - CallCreatedEvent: - description: |- - This event is sent when a call is created. Clients receiving this event should check if the ringing - field is set to true and if so, show the call screen + BlockUserRequest: + description: BlockUserRequest is the payload for blocking a user. + nullable: true properties: - call: - $ref: '#/components/schemas/CallResponse' - description: Call object - title: Call + user_id: + description: the user to block + title: UserID + type: string x-stream-index: "003" - call_cid: + required: + - user_id + title: BlockUserRequest + type: object + BlockUserResponse: + description: BlockUserResponse is the payload for blocking a user. + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration type: string - x-stream-index: "002.001" + x-stream-index: "001.001" + required: + - duration + title: BlockUserResponse + type: object + BlockUsersRequest: + nullable: true + properties: + blocked_user_id: + description: User id to block + title: BlockedUserID + type: string + x-stream-index: "001" + required: + - blocked_user_id + type: object + BlockUsersResponse: + nullable: true + properties: + blocked_by_user_id: + description: User id who blocked another user + title: BlockedByUserID + type: string + x-stream-index: "002" + blocked_user_id: + description: User id who got blocked + title: BlockedUserID + type: string + x-stream-index: "003" created_at: + description: Timestamp when the user was blocked format: date-time + title: CreatedAt type: number - x-stream-index: "001.002" - members: - description: the members added to this call - items: - $ref: '#/components/schemas/MemberResponse' - title: Members - type: array x-stream-index: "004" - type: - default: call.created - description: 'The type of event: "call.created" in this case' - title: Event Type + duration: + description: Duration of the request in milliseconds + title: Duration type: string x-stream-index: "001.001" required: - - type + - duration + - blocked_by_user_id + - blocked_user_id - created_at - - call_cid - - call - - members - title: CallCreatedEvent type: object - x-stream-event-call-type: true - x-stream-event-doc-group: call - x-stream-is-event: true - x-stream-ws-base-event-name: VideoEvent - CallDeletedEvent: - description: This event is sent when a call is deleted. Clients receiving this - event should leave the call screen + BlockedUserEvent: + description: |- + This event is sent to call participants to notify when a user is blocked on a call, clients can use this event to show a notification. + If the user is the current user, the client should leave the call screen as well properties: - call: - $ref: '#/components/schemas/CallResponse' - description: Call object - title: Call - x-stream-index: "003" + blocked_by_user: + $ref: '#/components/schemas/UserResponse' + description: The user that blocked the user, null if the user was blocked + by server-side + title: Blocked by + x-stream-index: "004" call_cid: type: string x-stream-index: "002.001" @@ -1894,477 +2933,637 @@ components: type: number x-stream-index: "001.002" type: - default: call.deleted - description: 'The type of event: "call.deleted" in this case' + default: call.blocked_user + description: 'The type of event: "call.blocked_user" in this case' title: Event Type type: string x-stream-index: "001.001" + user: + $ref: '#/components/schemas/UserResponse' + description: The user that was blocked + title: User + x-stream-index: "003" required: - type - created_at - call_cid - - call - title: CallDeletedEvent + - user + title: BlockedUserEvent type: object x-stream-event-call-type: true x-stream-event-doc-group: call x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallDurationReport: + BlockedUserResponse: + nullable: true properties: - histogram: - items: - $ref: '#/components/schemas/ReportByHistogramBucket' - type: array + blocked_user: + $ref: '#/components/schemas/UserResponse' + description: User who got blocked + title: User + x-stream-index: "003" + blocked_user_id: + description: ID of the user who got blocked + title: UserID + type: string + x-stream-index: "004" + created_at: + format: date-time + type: number + x-stream-index: "005" + user: + $ref: '#/components/schemas/UserResponse' + description: User who blocked another user + title: User x-stream-index: "001" + user_id: + description: ID of the user who blocked another user + title: UserID + type: string + x-stream-index: "002" required: - - histogram + - user + - user_id + - blocked_user + - blocked_user_id + - created_at type: object - CallDurationReportResponse: + BodyguardRule: properties: - daily: + action: + enum: + - flag + - shadow + - remove + - bounce + - bounce_flag + - bounce_remove + type: string + x-stream-index: "002" + label: + type: string + x-stream-index: "001" + severity_rules: items: - $ref: '#/components/schemas/DailyAggregateCallDurationReportResponse' + $ref: '#/components/schemas/BodyguardSeverityRule' type: array - x-stream-index: "001" + x-stream-index: "003" required: - - daily + - label + - action + - severity_rules type: object - CallEgress: - nullable: true + BodyguardSeverityRule: properties: - app_pk: - format: int32 - type: integer - x-stream-index: "002" - call_id: - type: string - x-stream-index: "004" - call_type: - type: string - x-stream-index: "003" - config: - $ref: '#/components/schemas/EgressTaskConfig' - x-stream-index: "007" - egress_id: - type: string - x-stream-index: "005" - egress_type: - type: string - x-stream-index: "006" - instance_ip: + action: + enum: + - flag + - shadow + - remove + - bounce + - bounce_flag + - bounce_remove type: string - x-stream-index: "008" - started_at: - format: date-time - type: number - x-stream-index: "010" - state: + x-stream-index: "002" + severity: + enum: + - low + - medium + - high + - critical type: string - x-stream-index: "009" - stopped_at: + x-stream-index: "001" + required: + - severity + - action + type: object + BookmarkAddedEvent: + description: Emitted when a user bookmarks an activity. + nullable: true + properties: + bookmark: + $ref: '#/components/schemas/BookmarkResponse' + x-stream-index: "001" + created_at: + description: Date/time of creation format: date-time + title: Created at type: number - x-stream-index: "011" - updated_at: + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + received_at: format: date-time type: number - x-stream-index: "012" + x-stream-index: 002.001.004 + type: + default: feeds.bookmark.added + description: 'The type of event: "feeds.bookmark.added" in this case' + title: Event Type + type: string + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who added the bookmark + title: User + x-stream-index: "003.001" required: - - app_pk - - call_type - - call_id - - egress_id - - egress_type - - instance_ip - - state - - started_at - - updated_at + - bookmark + - type + - created_at + - custom + title: BookmarkAddedEvent type: object - CallEndedEvent: - description: This event is sent when a call is mark as ended for all its participants. - Clients receiving this event should leave the call screen + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + BookmarkDeletedEvent: + description: Emitted when a user deletes a bookmark from an activity. + nullable: true properties: - call: - $ref: '#/components/schemas/CallResponse' - x-stream-index: "003" - call_cid: - type: string - x-stream-index: "002.001" + bookmark: + $ref: '#/components/schemas/BookmarkResponse' + x-stream-index: "001" created_at: + description: Date/time of creation format: date-time + title: Created at type: number - x-stream-index: "001.002" - reason: - description: The reason why the call ended, if available - title: CallEndedReason - type: string - x-stream-index: "005" + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 type: - default: call.ended - description: 'The type of event: "call.ended" in this case' + default: feeds.bookmark.deleted + description: 'The type of event: "feeds.bookmark.deleted" in this case' title: Event Type type: string - x-stream-index: "001.001" + x-stream-index: 002.001.002 user: - $ref: '#/components/schemas/UserResponse' - description: The user who ended the call, null if the call was ended by - the server + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who removed the bookmark title: User - x-stream-index: "004" + x-stream-index: "003.001" required: + - bookmark - type - created_at - - call_cid - - call - title: CallEndedEvent + - custom + title: BookmarkDeletedEvent type: object - x-stream-event-call-type: true - x-stream-event-doc-group: call + x-stream-event-client-type: true + x-stream-event-doc-group: other x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallFrameRecordingFailedEvent: - description: This event is sent when frame recording has failed + BookmarkFolderDeletedEvent: + description: Emitted when a bookmark folder is deleted. + nullable: true properties: - call: - $ref: '#/components/schemas/CallResponse' - x-stream-index: "003" - call_cid: - type: string - x-stream-index: "002.001" + bookmark_folder: + $ref: '#/components/schemas/BookmarkFolderResponse' + description: The bookmark folder that was deleted + title: Bookmark Folder + x-stream-index: "001" created_at: + description: Date/time of creation format: date-time + title: Created at type: number - x-stream-index: "001.002" - egress_id: - type: string - x-stream-index: "004" + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 type: - default: call.frame_recording_failed - description: 'The type of event: "call.frame_recording_failed" in this case' + default: feeds.bookmark_folder.deleted + description: 'The type of event: "feeds.bookmark_folder.deleted" in this + case' title: Event Type type: string - x-stream-index: "001.001" + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who deleted the bookmark folder + title: User + x-stream-index: "003.001" required: + - bookmark_folder - type - created_at - - call_cid - - call - - egress_id - title: CallFrameRecordingFailedEvent + - custom + title: BookmarkFolderDeletedEvent type: object - x-stream-event-call-type: true - x-stream-event-doc-group: recording + x-stream-event-client-type: true + x-stream-event-doc-group: other x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallFrameRecordingFrameReadyEvent: - description: This event is sent when a frame is captured from a call + BookmarkFolderResponse: properties: - call_cid: - type: string - x-stream-index: "002.001" - captured_at: - description: The time the frame was captured - format: date-time - title: CapturedAt - type: number - x-stream-index: "006" created_at: + description: When the folder was created format: date-time + title: Created At type: number - x-stream-index: "001.002" - egress_id: + x-stream-index: "004" + custom: + additionalProperties: {} + description: Custom data for the folder + title: Custom Data + type: object + x-stream-index: "003" + id: + description: Unique identifier for the folder + title: ID type: string - x-stream-index: "008" - session_id: - description: Call session ID - title: Session ID - type: string - x-stream-index: "003.001" - track_type: - description: The type of the track frame was captured from (TRACK_TYPE_VIDEO|TRACK_TYPE_SCREEN_SHARE) - title: TrackType - type: string - x-stream-index: "004" - type: - default: call.frame_recording_ready - description: 'The type of event: "call.frame_recording_ready" in this case' - title: Event Type - type: string - x-stream-index: "001.001" - url: - description: The URL of the frame - title: URL + x-stream-index: "001" + name: + description: Name of the folder + title: Name type: string + x-stream-index: "002" + updated_at: + description: When the folder was last updated + format: date-time + title: Updated At + type: number x-stream-index: "005" - users: - additionalProperties: - $ref: '#/components/schemas/UserResponse' - description: The users in the frame - title: Users - type: object - x-stream-index: "007" required: - - type + - id + - name - created_at - - call_cid - - session_id - - track_type - - url - - captured_at - - users - - egress_id - title: CallFrameRecordingFrameReadyEvent + - updated_at + title: Bookmark Folder type: object - x-stream-event-call-type: true - x-stream-event-doc-group: recording - x-stream-is-event: true - x-stream-ws-base-event-name: VideoEvent - CallFrameRecordingStartedEvent: - description: This event is sent when frame recording has started + BookmarkFolderUpdatedEvent: + description: Emitted when a bookmark folder is updated. + nullable: true properties: - call: - $ref: '#/components/schemas/CallResponse' - x-stream-index: "003" - call_cid: - type: string - x-stream-index: "002.001" + bookmark_folder: + $ref: '#/components/schemas/BookmarkFolderResponse' + description: The bookmark folder that was updated + title: Bookmark Folder + x-stream-index: "001" created_at: + description: Date/time of creation format: date-time + title: Created at type: number - x-stream-index: "001.002" - egress_id: - type: string - x-stream-index: "004" + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 type: - default: call.frame_recording_started - description: 'The type of event: "call.frame_recording_started" in this + default: feeds.bookmark_folder.updated + description: 'The type of event: "feeds.bookmark_folder.updated" in this case' title: Event Type type: string - x-stream-index: "001.001" + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who updated the bookmark folder + title: User + x-stream-index: "003.001" required: + - bookmark_folder - type - created_at - - call_cid - - call - - egress_id - title: CallFrameRecordingStartedEvent + - custom + title: BookmarkFolderUpdatedEvent type: object - x-stream-event-call-type: true - x-stream-event-doc-group: recording + x-stream-event-client-type: true + x-stream-event-doc-group: other x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallFrameRecordingStoppedEvent: - description: This event is sent when frame recording has stopped + BookmarkResponse: properties: - call: - $ref: '#/components/schemas/CallResponse' - x-stream-index: "003" - call_cid: - type: string - x-stream-index: "002.001" + activity: + $ref: '#/components/schemas/ActivityResponse' + description: The bookmarked activity + title: Activity + x-stream-index: "002" created_at: + description: When the bookmark was created format: date-time + title: Created At type: number - x-stream-index: "001.002" - egress_id: - type: string + x-stream-index: "005" + custom: + additionalProperties: {} + description: Custom data for the bookmark + title: Custom Data + type: object x-stream-index: "004" - type: - default: call.frame_recording_stopped - description: 'The type of event: "call.frame_recording_stopped" in this - case' - title: Event Type - type: string - x-stream-index: "001.001" - required: - - type - - created_at - - call_cid - - call - - egress_id - title: CallFrameRecordingStoppedEvent - type: object - x-stream-event-call-type: true - x-stream-event-doc-group: recording - x-stream-is-event: true - x-stream-ws-base-event-name: VideoEvent - CallHLSBroadcastingFailedEvent: - description: This event is sent when HLS broadcasting has failed - properties: - call_cid: - type: string - x-stream-index: "002.001" - created_at: + folder: + $ref: '#/components/schemas/BookmarkFolderResponse' + description: Folder containing this bookmark + title: Folder + x-stream-index: "003" + updated_at: + description: When the bookmark was last updated format: date-time + title: Updated At type: number - x-stream-index: "001.002" - type: - default: call.hls_broadcasting_failed - description: 'The type of event: "call.hls_broadcasting_failed" in this - case' - title: Event Type - type: string - x-stream-index: "001.001" + x-stream-index: "006" + user: + $ref: '#/components/schemas/UserResponse' + description: User who created the bookmark + title: User + x-stream-index: "001" required: - - type + - user + - activity - created_at - - call_cid - title: CallHLSBroadcastingFailedEvent + - updated_at + title: Bookmark type: object - x-stream-event-call-type: true - x-stream-event-doc-group: streaming - x-stream-is-event: true - x-stream-ws-base-event-name: VideoEvent - CallHLSBroadcastingStartedEvent: - description: This event is sent when HLS broadcasting has started + BookmarkUpdatedEvent: + description: Emitted when a user updates a bookmark. + nullable: true properties: - call: - $ref: '#/components/schemas/CallResponse' - x-stream-index: "003" - call_cid: - type: string - x-stream-index: "002.001" + bookmark: + $ref: '#/components/schemas/BookmarkResponse' + description: The updated bookmark + title: Bookmark + x-stream-index: "001" created_at: + description: Date/time of creation format: date-time + title: Created at type: number - x-stream-index: "001.002" - hls_playlist_url: - type: string - x-stream-index: "004" + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 type: - default: call.hls_broadcasting_started - description: 'The type of event: "call.hls_broadcasting_started" in this - case' + default: feeds.bookmark.updated + description: 'The type of event: "feeds.bookmark.updated" in this case' title: Event Type type: string - x-stream-index: "001.001" + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who updated the bookmark + title: User + x-stream-index: "003.001" required: + - bookmark - type - created_at - - call_cid - - call - - hls_playlist_url - title: CallHLSBroadcastingStartedEvent + - custom + title: BookmarkUpdatedEvent type: object - x-stream-event-call-type: true - x-stream-event-doc-group: streaming + x-stream-event-client-type: true + x-stream-event-doc-group: other x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallHLSBroadcastingStoppedEvent: - description: This event is sent when HLS broadcasting has stopped + Bound: properties: - call_cid: - type: string - x-stream-index: "002.001" - created_at: - format: date-time + inclusive: + type: boolean + x-stream-index: "002" + value: + format: float type: number - x-stream-index: "001.002" - type: - default: call.hls_broadcasting_stopped - description: 'The type of event: "call.hls_broadcasting_stopped" in this - case' - title: Event Type - type: string - x-stream-index: "001.001" + x-stream-index: "001" required: - - type - - created_at - - call_cid - title: CallHLSBroadcastingStoppedEvent + - value + - inclusive type: object - x-stream-event-call-type: true - x-stream-event-doc-group: streaming - x-stream-is-event: true - x-stream-ws-base-event-name: VideoEvent - CallIngressResponse: - description: CallIngressResponse is the payload for ingress settings + BroadcastSettings: properties: - rtmp: - $ref: '#/components/schemas/RTMPIngress' - title: RTMP + enabled: + type: boolean x-stream-index: "001" + hls: + $ref: '#/components/schemas/HLSSettings' + x-stream-index: "002" + rtmp: + $ref: '#/components/schemas/RTMPSettings' + x-stream-index: "003" required: - - rtmp - title: CallIngressResponse + - enabled type: object - CallLiveStartedEvent: - description: This event is sent when a call is started. Clients receiving this - event should start the call. + BroadcastSettingsRequest: properties: - call: - $ref: '#/components/schemas/CallResponse' - description: Call object - title: Call - x-stream-index: "003" - call_cid: - type: string - x-stream-index: "002.001" - created_at: - format: date-time - type: number - x-stream-index: "001.002" - type: - default: call.live_started - description: 'The type of event: "call.live_started" in this case' - title: Event Type - type: string - x-stream-index: "001.001" + enabled: + type: boolean + x-stream-index: "001" + hls: + $ref: '#/components/schemas/HLSSettingsRequest' + x-stream-index: "002" + rtmp: + $ref: '#/components/schemas/RTMPSettingsRequest' + x-stream-index: "003" + type: object + BroadcastSettingsResponse: + description: BroadcastSettingsResponse is the payload for broadcasting settings + properties: + enabled: + title: Enabled + type: boolean + x-stream-index: "001" + hls: + $ref: '#/components/schemas/HLSSettingsResponse' + title: HLS + x-stream-index: "002" + rtmp: + $ref: '#/components/schemas/RTMPSettingsResponse' + title: RTMP + x-stream-index: "003" required: - - type - - created_at - - call_cid - - call - title: CallLiveStartedEvent + - enabled + - hls + - rtmp + title: BroadcastSettingsResponse type: object - x-stream-event-call-type: true - x-stream-event-doc-group: streaming - x-stream-is-event: true - x-stream-ws-base-event-name: VideoEvent - CallMember: - nullable: true + Call: properties: - created_at: + AppPK: + format: int32 + type: integer + writeOnly: true + x-stream-index: "002" + Backstage: + type: boolean + writeOnly: true + x-stream-index: "023" + BlockedUserIDs: + items: + type: string + type: array + writeOnly: true + x-stream-index: "018" + BlockedUsers: + items: + $ref: '#/components/schemas/User' + type: array + writeOnly: true + x-stream-index: "019" + CID: + type: string + writeOnly: true + x-stream-index: "005" + CallType: + $ref: '#/components/schemas/CallType' + x-stream-index: "020" + ChannelCID: + type: string + writeOnly: true + x-stream-index: "032" + CreatedAt: format: date-time type: number + writeOnly: true + x-stream-index: "013" + CreatedBy: + $ref: '#/components/schemas/User' x-stream-index: "008" - custom: + CreatedByUserID: + type: string + writeOnly: true + x-stream-index: "007" + CurrentSessionID: + type: string + writeOnly: true + x-stream-index: "024" + Custom: additionalProperties: {} type: object - x-stream-index: "007" - deleted_at: + writeOnly: true + x-stream-index: "012" + DeletedAt: format: date-time type: number - x-stream-index: "010" - role: + writeOnly: true + x-stream-index: "028" + EgressUpdatedAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "027" + Egresses: + items: + $ref: '#/components/schemas/CallEgress' + type: array + writeOnly: true + x-stream-index: "015" + EndedAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "017" + ID: type: string - x-stream-index: "006" - updated_at: + writeOnly: true + x-stream-index: "004" + JoinAheadTimeSeconds: + format: int32 + type: integer + writeOnly: true + x-stream-index: "031" + LastHeartbeatAt: format: date-time type: number + writeOnly: true + x-stream-index: "030" + LastSessionID: + type: string + writeOnly: true + x-stream-index: "025" + MemberCount: + format: int32 + type: integer + writeOnly: true + x-stream-index: "010" + MemberLookup: + $ref: '#/components/schemas/MemberLookup' + x-stream-index: "011" + Members: + items: + $ref: '#/components/schemas/CallMember' + type: array + writeOnly: true x-stream-index: "009" - user: - $ref: '#/components/schemas/User' - x-stream-index: "005" - user_id: + Session: + $ref: '#/components/schemas/CallSession' + x-stream-index: "026" + Settings: + $ref: '#/components/schemas/CallSettings' + x-stream-index: "022" + SettingsOverrides: + $ref: '#/components/schemas/CallSettings' + x-stream-index: "021" + StartsAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "016" + Team: type: string - x-stream-index: "004" + writeOnly: true + x-stream-index: "006" + ThumbnailURL: + type: string + writeOnly: true + x-stream-index: "029" + Type: + type: string + writeOnly: true + x-stream-index: "003" + UpdatedAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "014" required: - - user_id - - role - - custom - - created_at - - updated_at + - AppPK + - Type + - ID + - CID + - Team + - CreatedByUserID + - Members + - Custom + - CreatedAt + - UpdatedAt + - Egresses + - BlockedUserIDs + - BlockedUsers + - Backstage + - CurrentSessionID + - LastSessionID + - ThumbnailURL + - ChannelCID type: object - CallMemberAddedEvent: - description: This event is sent when one or more members are added to a call + CallAcceptedEvent: + description: This event is sent when a user accepts a notification to join a + call. properties: call: $ref: '#/components/schemas/CallResponse' - description: Call object - title: Call x-stream-index: "003" call_cid: type: string @@ -2373,146 +3572,75 @@ components: format: date-time type: number x-stream-index: "001.002" - members: - description: the members added to this call - items: - $ref: '#/components/schemas/MemberResponse' - title: Members - type: array - x-stream-index: "004" type: - default: call.member_added - description: 'The type of event: "call.member_added" in this case' + default: call.accepted + description: 'The type of event: "call.accepted" in this case' title: Event Type type: string x-stream-index: "001.001" + user: + $ref: '#/components/schemas/UserResponse' + description: The user who accepted the call + title: User + x-stream-index: "004" required: - type - created_at - call_cid - call - - members - title: CallMemberAddedEvent + - user + title: CallAcceptedEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: call + x-stream-event-doc-group: ring x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallMemberRemovedEvent: - description: This event is sent when one or more members are removed from a - call + CallClosedCaption: + description: CallClosedCaption represents a closed caption of a call. properties: - call: - $ref: '#/components/schemas/CallResponse' - description: Call object - title: Call - x-stream-index: "003" - call_cid: - type: string - x-stream-index: "002.001" - created_at: + end_time: format: date-time + title: The end time of the closed caption. type: number - x-stream-index: "001.002" - members: - description: the list of member IDs removed from the call - items: - type: string - title: Members - type: array - x-stream-index: "004" - type: - default: call.member_removed - description: 'The type of event: "call.member_removed" in this case' - title: Event Type - type: string - x-stream-index: "001.001" - required: - - type - - created_at - - call_cid - - call - - members - title: CallMemberRemovedEvent - type: object - x-stream-event-call-type: true - x-stream-event-doc-group: call - x-stream-is-event: true - x-stream-ws-base-event-name: VideoEvent - CallMemberUpdatedEvent: - description: This event is sent when one or more members are updated - properties: - call: - $ref: '#/components/schemas/CallResponse' - description: Call object - title: Call x-stream-index: "003" - call_cid: + speaker_id: + title: The speaker ID of the closed caption. type: string - x-stream-index: "002.001" - created_at: + x-stream-index: "004" + start_time: format: date-time + title: The start time of the closed caption. type: number - x-stream-index: "001.002" - members: - description: The list of members that were updated - items: - $ref: '#/components/schemas/MemberResponse' - title: Members - type: array - x-stream-index: "004" - type: - default: call.member_updated - description: 'The type of event: "call.member_updated" in this case' - title: Event Type + x-stream-index: "002" + text: + title: The text of the closed caption. type: string - x-stream-index: "001.001" + x-stream-index: "001" + user: + $ref: '#/components/schemas/UserResponse' + title: The full user for the closed caption. + x-stream-index: "005" required: - - type - - created_at - - call_cid - - call - - members - title: CallMemberUpdatedEvent + - text + - start_time + - end_time + - speaker_id + - user + title: CallClosedCaption type: object - x-stream-event-call-type: true - x-stream-event-doc-group: call - x-stream-is-event: true - x-stream-ws-base-event-name: VideoEvent - CallMemberUpdatedPermissionEvent: - description: This event is sent when one or more members get its role updated + CallClosedCaptionsFailedEvent: + description: This event is sent when call closed captions has failed properties: - call: - $ref: '#/components/schemas/CallResponse' - description: Call object - title: Call - x-stream-index: "003" call_cid: type: string x-stream-index: "002.001" - capabilities_by_role: - additionalProperties: - items: - type: string - type: array - description: The capabilities by role for this call - title: CapabilitiesByRole - type: object - x-stream-index: "004" created_at: format: date-time type: number x-stream-index: "001.002" - members: - description: The list of members that were updated - items: - $ref: '#/components/schemas/MemberResponse' - title: Members - type: array - x-stream-index: "005" type: - default: call.member_updated_permission - description: 'The type of event: "call.member_added" in this case' + default: call.closed_captions_failed + description: 'The type of event: "call.closed_captions_failed" in this case' title: Event Type type: string x-stream-index: "001.001" @@ -2520,24 +3648,15 @@ components: - type - created_at - call_cid - - call - - capabilities_by_role - - members - title: CallMemberUpdatedPermissionEvent + title: CallClosedCaptionsFailedEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: call + x-stream-event-doc-group: transcription x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallMissedEvent: - description: This event is sent to call members who did not accept/reject/join - the call to notify they missed the call + CallClosedCaptionsStartedEvent: + description: This event is sent when call closed caption has started properties: - call: - $ref: '#/components/schemas/CallResponse' - description: Call object - title: Call - x-stream-index: "004" call_cid: type: string x-stream-index: "002.001" @@ -2545,48 +3664,25 @@ components: format: date-time type: number x-stream-index: "001.002" - members: - description: List of members who missed the call - items: - $ref: '#/components/schemas/MemberResponse' - title: Members - type: array - x-stream-index: "005" - notify_user: - type: boolean - x-stream-index: "007" - session_id: - description: Call session ID - title: Session ID - type: string - x-stream-index: "003.001" type: - default: call.missed - description: 'The type of event: "call.notification" in this case' + default: call.closed_captions_started + description: 'The type of event: "call.closed_captions_started" in this + case' title: Event Type type: string x-stream-index: "001.001" - user: - $ref: '#/components/schemas/UserResponse' - description: The caller from whom the call was missed - title: User - x-stream-index: "006" required: - type - created_at - call_cid - - session_id - - call - - members - - user - - notify_user - title: CallMissedEvent + title: CallClosedCaptionsStartedEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: ring + x-stream-event-doc-group: transcription x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallModerationBlurEvent: + CallClosedCaptionsStoppedEvent: + description: This event is sent when call closed captions has stopped properties: call_cid: type: string @@ -2595,31 +3691,32 @@ components: format: date-time type: number x-stream-index: "001.002" - custom: - additionalProperties: {} - type: object - x-stream-index: "004" type: - default: call.moderation_blur + default: call.closed_captions_stopped + description: 'The type of event: "call.transcription_stopped" in this case' + title: Event Type type: string x-stream-index: "001.001" - user_id: - type: string - x-stream-index: "003" required: - type - created_at - call_cid - - user_id - - custom - title: CallModerationBlurEvent + title: CallClosedCaptionsStoppedEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: other + x-stream-event-doc-group: transcription x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallModerationWarningEvent: + CallCreatedEvent: + description: |- + This event is sent when a call is created. Clients receiving this event should check if the ringing + field is set to true and if so, show the call screen properties: + call: + $ref: '#/components/schemas/CallResponse' + description: Call object + title: Call + x-stream-index: "003" call_cid: type: string x-stream-index: "002.001" @@ -2627,42 +3724,40 @@ components: format: date-time type: number x-stream-index: "001.002" - custom: - additionalProperties: {} - type: object - x-stream-index: "005" - message: - type: string + members: + description: the members added to this call + items: + $ref: '#/components/schemas/MemberResponse' + title: Members + type: array x-stream-index: "004" type: - default: call.moderation_warning + default: call.created + description: 'The type of event: "call.created" in this case' + title: Event Type type: string x-stream-index: "001.001" - user_id: - type: string - x-stream-index: "003" required: - type - created_at - call_cid - - user_id - - message - - custom - title: CallModerationWarningEvent + - call + - members + title: CallCreatedEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: other + x-stream-event-doc-group: call x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallNotificationEvent: - description: This event is sent to all call members to notify they are getting - called + CallDeletedEvent: + description: This event is sent when a call is deleted. Clients receiving this + event should leave the call screen properties: call: $ref: '#/components/schemas/CallResponse' description: Call object title: Call - x-stream-index: "004" + x-stream-index: "003" call_cid: type: string x-stream-index: "002.001" @@ -2670,150 +3765,24 @@ components: format: date-time type: number x-stream-index: "001.002" - members: - description: Call members - items: - $ref: '#/components/schemas/MemberResponse' - title: Members - type: array - x-stream-index: "005" - session_id: - description: Call session ID - title: Session ID - type: string - x-stream-index: "003.001" type: - default: call.notification - description: 'The type of event: "call.notification" in this case' + default: call.deleted + description: 'The type of event: "call.deleted" in this case' title: Event Type type: string x-stream-index: "001.001" - user: - $ref: '#/components/schemas/UserResponse' - description: The user that sent the call notification - title: User - x-stream-index: "006" required: - type - created_at - call_cid - - session_id - call - - members - - user - title: CallNotificationEvent + title: CallDeletedEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: ring + x-stream-event-doc-group: call x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallParticipant: - nullable: true - properties: - JoinedAt: - format: date-time - type: number - writeOnly: true - x-stream-index: "004" - Role: - type: string - writeOnly: true - x-stream-index: "002" - UserSessionID: - type: string - writeOnly: true - x-stream-index: "003" - avg_response_time: - format: int32 - readOnly: true - type: integer - x-stream-index: "001.046" - ban_expires: - format: date-time - type: number - x-stream-index: "001.017" - banned: - type: boolean - x-stream-index: "001.016" - created_at: - format: date-time - readOnly: true - type: number - x-stream-index: "001.008" - custom: - additionalProperties: {} - type: object - x-stream-index: "001.006" - deactivated_at: - format: date-time - readOnly: true - type: number - x-stream-index: "001.014" - deleted_at: - format: date-time - readOnly: true - type: number - x-stream-index: "001.013" - id: - type: string - x-stream-index: "001.003" - invisible: - type: boolean - x-stream-index: "001.023" - language: - type: string - x-stream-index: "001.035" - last_active: - format: date-time - readOnly: true - type: number - x-stream-index: "001.011" - last_engaged_at: - format: date-time - readOnly: true - type: number - x-stream-index: "001.012" - online: - readOnly: true - type: boolean - x-stream-index: "001.022" - privacy_settings: - $ref: '#/components/schemas/PrivacySettings' - x-stream-index: "001.026" - revoke_tokens_issued_before: - format: date-time - type: number - x-stream-index: "001.042" - role: - type: string - x-stream-index: "001.004" - teams: - items: - type: string - type: array - x-stream-index: "001.036" - teams_role: - additionalProperties: - type: string - type: object - x-stream-index: "001.005" - updated_at: - format: date-time - readOnly: true - type: number - x-stream-index: "001.009" - required: - - id - - role - - teams_role - - custom - - banned - - online - - Role - - UserSessionID - - JoinedAt - type: object - CallParticipantCountReport: + CallDurationReport: properties: histogram: items: @@ -2823,41 +3792,74 @@ components: required: - histogram type: object - CallParticipantCountReportResponse: + CallDurationReportResponse: properties: daily: items: - $ref: '#/components/schemas/DailyAggregateCallParticipantCountReportResponse' + $ref: '#/components/schemas/DailyAggregateCallDurationReportResponse' type: array x-stream-index: "001" required: - daily type: object - CallParticipantResponse: + CallEgress: + nullable: true properties: - joined_at: - format: date-time - type: number + app_pk: + format: int32 + type: integer + x-stream-index: "002" + call_id: + type: string x-stream-index: "004" - role: + call_type: type: string x-stream-index: "003" - user: - $ref: '#/components/schemas/UserResponse' - x-stream-index: "001" - user_session_id: + config: + $ref: '#/components/schemas/EgressTaskConfig' + x-stream-index: "007" + egress_id: type: string - x-stream-index: "002" + x-stream-index: "005" + egress_type: + type: string + x-stream-index: "006" + instance_ip: + type: string + x-stream-index: "008" + started_at: + format: date-time + type: number + x-stream-index: "010" + state: + type: string + x-stream-index: "009" + stopped_at: + format: date-time + type: number + x-stream-index: "011" + updated_at: + format: date-time + type: number + x-stream-index: "012" required: - - user - - user_session_id - - role - - joined_at + - app_pk + - call_type + - call_id + - egress_id + - egress_type + - instance_ip + - state + - started_at + - updated_at type: object - CallReactionEvent: - description: This event is sent when a reaction is sent in a call, clients should - use this to show the reaction in the call screen + CallEndedEvent: + description: This event is sent when a call is mark as ended for all its participants. + Clients receiving this event should leave the call screen properties: + call: + $ref: '#/components/schemas/CallResponse' + x-stream-index: "003" call_cid: type: string x-stream-index: "002.001" @@ -2865,64 +3867,40 @@ components: format: date-time type: number x-stream-index: "001.002" - reaction: - $ref: '#/components/schemas/ReactionResponse' - description: the reaction object sent by the user on the call - title: reaction - x-stream-index: "003" + reason: + description: The reason why the call ended, if available + title: CallEndedReason + type: string + x-stream-index: "005" type: - default: call.reaction_new - description: 'The type of event: "call.reaction_new" in this case' + default: call.ended + description: 'The type of event: "call.ended" in this case' title: Event Type type: string x-stream-index: "001.001" + user: + $ref: '#/components/schemas/UserResponse' + description: The user who ended the call, null if the call was ended by + the server + title: User + x-stream-index: "004" required: - type - created_at - call_cid - - reaction - title: CallReactionEvent + - call + title: CallEndedEvent type: object x-stream-event-call-type: true x-stream-event-doc-group: call x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallRecording: - description: CallRecording represents a recording of a call. + CallFrameRecordingFailedEvent: + description: This event is sent when frame recording has failed properties: - end_time: - format: date-time - title: The end time of the recording. - type: number - x-stream-index: "004" - filename: - title: The filename of the recording. - type: string - x-stream-index: "001" - session_id: - title: The session ID of the recording. - type: string - x-stream-index: "005" - start_time: - format: date-time - title: The start time of the recording. - type: number + call: + $ref: '#/components/schemas/CallResponse' x-stream-index: "003" - url: - title: The URL of the recording. - type: string - x-stream-index: "002" - required: - - filename - - url - - start_time - - end_time - - session_id - title: CallRecording - type: object - CallRecordingFailedEvent: - description: This event is sent when call recording has failed - properties: call_cid: type: string x-stream-index: "002.001" @@ -2932,10 +3910,10 @@ components: x-stream-index: "001.002" egress_id: type: string - x-stream-index: "003" + x-stream-index: "004" type: - default: call.recording_failed - description: 'The type of event: "call.recording_failed" in this case' + default: call.frame_recording_failed + description: 'The type of event: "call.frame_recording_failed" in this case' title: Event Type type: string x-stream-index: "001.001" @@ -2943,112 +3921,176 @@ components: - type - created_at - call_cid + - call - egress_id - title: CallRecordingFailedEvent + title: CallFrameRecordingFailedEvent type: object x-stream-event-call-type: true x-stream-event-doc-group: recording x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallRecordingReadyEvent: - description: This event is sent when call recording is ready + CallFrameRecordingFrameReadyEvent: + description: This event is sent when a frame is captured from a call properties: call_cid: type: string x-stream-index: "002.001" - call_recording: - $ref: '#/components/schemas/CallRecording' - description: The call recording object - title: CallRecording - x-stream-index: "003" - created_at: + captured_at: + description: The time the frame was captured + format: date-time + title: CapturedAt + type: number + x-stream-index: "006" + created_at: format: date-time type: number x-stream-index: "001.002" egress_id: + type: string + x-stream-index: "008" + session_id: + description: Call session ID + title: Session ID + type: string + x-stream-index: "003.001" + track_type: + description: The type of the track frame was captured from (TRACK_TYPE_VIDEO|TRACK_TYPE_SCREEN_SHARE) + title: TrackType type: string x-stream-index: "004" type: - default: call.recording_ready - description: 'The type of event: "call.recording_ready" in this case' + default: call.frame_recording_ready + description: 'The type of event: "call.frame_recording_ready" in this case' title: Event Type type: string x-stream-index: "001.001" + url: + description: The URL of the frame + title: URL + type: string + x-stream-index: "005" + users: + additionalProperties: + $ref: '#/components/schemas/UserResponse' + description: The users in the frame + title: Users + type: object + x-stream-index: "007" required: - type - created_at - call_cid - - call_recording + - session_id + - track_type + - url + - captured_at + - users - egress_id - title: CallRecordingReadyEvent + title: CallFrameRecordingFrameReadyEvent type: object x-stream-event-call-type: true x-stream-event-doc-group: recording x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallRecordingStartedEvent: - description: This event is sent when call recording has started + CallFrameRecordingStartedEvent: + description: This event is sent when frame recording has started properties: + call: + $ref: '#/components/schemas/CallResponse' + x-stream-index: "003" call_cid: type: string - x-stream-index: "003.001" + x-stream-index: "002.001" created_at: format: date-time type: number - x-stream-index: "002.002" + x-stream-index: "001.002" egress_id: type: string - x-stream-index: "001" + x-stream-index: "004" type: - default: call.recording_started - description: 'The type of event: "call.recording_started" in this case' + default: call.frame_recording_started + description: 'The type of event: "call.frame_recording_started" in this + case' title: Event Type type: string - x-stream-index: "002.001" + x-stream-index: "001.001" required: - - egress_id - type - created_at - call_cid - title: CallRecordingStartedEvent + - call + - egress_id + title: CallFrameRecordingStartedEvent type: object x-stream-event-call-type: true x-stream-event-doc-group: recording x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallRecordingStoppedEvent: - description: This event is sent when call recording has stopped + CallFrameRecordingStoppedEvent: + description: This event is sent when frame recording has stopped properties: + call: + $ref: '#/components/schemas/CallResponse' + x-stream-index: "003" call_cid: type: string - x-stream-index: "003.001" + x-stream-index: "002.001" created_at: format: date-time type: number - x-stream-index: "002.002" + x-stream-index: "001.002" egress_id: type: string - x-stream-index: "001" + x-stream-index: "004" type: - default: call.recording_stopped - description: 'The type of event: "call.recording_stopped" in this case' + default: call.frame_recording_stopped + description: 'The type of event: "call.frame_recording_stopped" in this + case' title: Event Type type: string - x-stream-index: "002.001" + x-stream-index: "001.001" required: - - egress_id - type - created_at - call_cid - title: CallRecordingStoppedEvent + - call + - egress_id + title: CallFrameRecordingStoppedEvent type: object x-stream-event-call-type: true x-stream-event-doc-group: recording x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallRejectedEvent: - description: This event is sent when a user rejects a notification to join a - call. + CallHLSBroadcastingFailedEvent: + description: This event is sent when HLS broadcasting has failed + properties: + call_cid: + type: string + x-stream-index: "002.001" + created_at: + format: date-time + type: number + x-stream-index: "001.002" + type: + default: call.hls_broadcasting_failed + description: 'The type of event: "call.hls_broadcasting_failed" in this + case' + title: Event Type + type: string + x-stream-index: "001.001" + required: + - type + - created_at + - call_cid + title: CallHLSBroadcastingFailedEvent + type: object + x-stream-event-call-type: true + x-stream-event-doc-group: streaming + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + CallHLSBroadcastingStartedEvent: + description: This event is sent when HLS broadcasting has started properties: call: $ref: '#/components/schemas/CallResponse' @@ -3060,210 +4102,142 @@ components: format: date-time type: number x-stream-index: "001.002" - reason: - description: 'Provides information about why the call was rejected. You - can provide any value, but the Stream API and SDKs use these default values: - rejected, cancel, timeout and busy' - title: Reason + hls_playlist_url: type: string - x-stream-index: "005" + x-stream-index: "004" type: - default: call.rejected - description: 'The type of event: "call.rejected" in this case' + default: call.hls_broadcasting_started + description: 'The type of event: "call.hls_broadcasting_started" in this + case' title: Event Type type: string x-stream-index: "001.001" - user: - $ref: '#/components/schemas/UserResponse' - description: The user who rejected the call - title: User - x-stream-index: "004" required: - type - created_at - call_cid - call - - user - title: CallRejectedEvent + - hls_playlist_url + title: CallHLSBroadcastingStartedEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: ring + x-stream-event-doc-group: streaming x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallReportResponse: + CallHLSBroadcastingStoppedEvent: + description: This event is sent when HLS broadcasting has stopped properties: - ended_at: + call_cid: + type: string + x-stream-index: "002.001" + created_at: format: date-time type: number - x-stream-index: "003" - score: - format: float - type: number + x-stream-index: "001.002" + type: + default: call.hls_broadcasting_stopped + description: 'The type of event: "call.hls_broadcasting_stopped" in this + case' + title: Event Type + type: string + x-stream-index: "001.001" + required: + - type + - created_at + - call_cid + title: CallHLSBroadcastingStoppedEvent + type: object + x-stream-event-call-type: true + x-stream-event-doc-group: streaming + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + CallIngressResponse: + description: CallIngressResponse is the payload for ingress settings + properties: + rtmp: + $ref: '#/components/schemas/RTMPIngress' + title: RTMP x-stream-index: "001" - started_at: + required: + - rtmp + title: CallIngressResponse + type: object + CallLiveStartedEvent: + description: This event is sent when a call is started. Clients receiving this + event should start the call. + properties: + call: + $ref: '#/components/schemas/CallResponse' + description: Call object + title: Call + x-stream-index: "003" + call_cid: + type: string + x-stream-index: "002.001" + created_at: format: date-time type: number - x-stream-index: "002" + x-stream-index: "001.002" + type: + default: call.live_started + description: 'The type of event: "call.live_started" in this case' + title: Event Type + type: string + x-stream-index: "001.001" required: - - score + - type + - created_at + - call_cid + - call + title: CallLiveStartedEvent type: object - CallRequest: - description: CallRequest is the payload for creating a call. + x-stream-event-call-type: true + x-stream-event-doc-group: streaming + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + CallMember: + nullable: true properties: - channel_cid: - type: string - x-stream-index: "009" + created_at: + format: date-time + type: number + x-stream-index: "008" custom: additionalProperties: {} type: object - x-stream-index: "004" - members: - items: - $ref: '#/components/schemas/MemberRequest' - maximum: 100 - type: array - x-stream-index: "005" - settings_override: - $ref: '#/components/schemas/CallSettingsRequest' + x-stream-index: "007" + deleted_at: + format: date-time + type: number + x-stream-index: "010" + role: + type: string x-stream-index: "006" - starts_at: + updated_at: format: date-time type: number - x-stream-index: "007" - team: - type: string - x-stream-index: "001" - video: - type: boolean - x-stream-index: "008" - title: CallRequest - type: object - CallResponse: - description: Represents a call - properties: - backstage: - type: boolean - x-stream-index: "016" - blocked_user_ids: - items: - type: string - type: array - x-stream-index: "018" - captioning: - type: boolean - x-stream-index: "013" - channel_cid: - type: string - x-stream-index: "024" - cid: - description: The unique identifier for a call (:) - title: CID + x-stream-index: "009" + user: + $ref: '#/components/schemas/User' + x-stream-index: "005" + user_id: type: string x-stream-index: "004" - created_at: - description: Date/time of creation - format: date-time - title: Created at - type: number - x-stream-index: "009" - created_by: - $ref: '#/components/schemas/UserResponse' - description: The user that created the call - title: Created By - x-stream-index: "007" - current_session_id: - type: string - x-stream-index: "005" - custom: - additionalProperties: {} - description: Custom data for this object - title: Custom data - type: object - x-stream-index: "008" - egress: - $ref: '#/components/schemas/EgressResponse' - x-stream-index: "021" - ended_at: - description: Date/time when the call ended - format: date-time - title: Ended At - type: number - x-stream-index: "014" - id: - description: Call ID - title: ID - type: string - x-stream-index: "003" - ingress: - $ref: '#/components/schemas/CallIngressResponse' - x-stream-index: "019" - join_ahead_time_seconds: - format: int32 - type: integer - x-stream-index: "023" - recording: - type: boolean - x-stream-index: "011" - session: - $ref: '#/components/schemas/CallSessionResponse' - x-stream-index: "020" - settings: - $ref: '#/components/schemas/CallSettingsResponse' - x-stream-index: "017" - starts_at: - description: Date/time when the call will start - format: date-time - title: Starts At - type: number - x-stream-index: "015" - team: - type: string - x-stream-index: "006" - thumbnails: - $ref: '#/components/schemas/ThumbnailResponse' - x-stream-index: "022" - transcribing: - type: boolean - x-stream-index: "012" - type: - description: The type of call - title: Type - type: string - x-stream-index: "002" - updated_at: - description: Date/time of the last update - format: date-time - title: Updated at - type: number - x-stream-index: "010" required: - - type - - id - - cid - - current_session_id - - created_by + - user_id + - role - custom - created_at - updated_at - - recording - - transcribing - - captioning - - backstage - - settings - - blocked_user_ids - - ingress - - egress - title: CallResponse type: object - CallRingEvent: - description: This event is sent to all call members to notify they are getting - called + CallMemberAddedEvent: + description: This event is sent when one or more members are added to a call properties: call: $ref: '#/components/schemas/CallResponse' description: Call object title: Call - x-stream-index: "005" + x-stream-index: "003" call_cid: type: string x-stream-index: "002.001" @@ -3272,68 +4246,56 @@ components: type: number x-stream-index: "001.002" members: - description: Call members + description: the members added to this call items: $ref: '#/components/schemas/MemberResponse' title: Members type: array - x-stream-index: "006" - session_id: - description: Call session ID - title: Session ID - type: string - x-stream-index: "003.001" + x-stream-index: "004" type: - default: call.ring - description: 'The type of event: "call.notification" in this case' + default: call.member_added + description: 'The type of event: "call.member_added" in this case' title: Event Type type: string x-stream-index: "001.001" - user: - $ref: '#/components/schemas/UserResponse' - description: The user that sent the call notification - title: User - x-stream-index: "007" - video: - type: boolean - x-stream-index: "008" required: - type - created_at - call_cid - - session_id - call - members - - user - - video - title: CallRingEvent + title: CallMemberAddedEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: ring + x-stream-event-doc-group: call x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallRtmpBroadcastFailedEvent: - description: This event is sent when a call RTMP broadcast has failed + CallMemberRemovedEvent: + description: This event is sent when one or more members are removed from a + call properties: + call: + $ref: '#/components/schemas/CallResponse' + description: Call object + title: Call + x-stream-index: "003" call_cid: - description: The unique identifier for a call (:) - title: CID type: string x-stream-index: "002.001" created_at: - description: Date/time of creation format: date-time - title: Created at type: number x-stream-index: "001.002" - name: - description: Name of the given RTMP broadcast - title: Name - type: string - x-stream-index: "003" + members: + description: the list of member IDs removed from the call + items: + type: string + title: Members + type: array + x-stream-index: "004" type: - default: call.rtmp_broadcast_failed - description: 'The type of event: "call.rtmp_broadcast_failed" in this case' + default: call.member_removed + description: 'The type of event: "call.member_removed" in this case' title: Event Type type: string x-stream-index: "001.001" @@ -3341,35 +4303,39 @@ components: - type - created_at - call_cid - - name - title: CallRtmpBroadcastFailedEvent + - call + - members + title: CallMemberRemovedEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: streaming + x-stream-event-doc-group: call x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallRtmpBroadcastStartedEvent: - description: This event is sent when RTMP broadcast has started + CallMemberUpdatedEvent: + description: This event is sent when one or more members are updated properties: + call: + $ref: '#/components/schemas/CallResponse' + description: Call object + title: Call + x-stream-index: "003" call_cid: - description: The unique identifier for a call (:) - title: CID type: string x-stream-index: "002.001" created_at: - description: Date/time of creation format: date-time - title: Created at type: number x-stream-index: "001.002" - name: - description: Name of the given RTMP broadcast - title: Name - type: string - x-stream-index: "003" + members: + description: The list of members that were updated + items: + $ref: '#/components/schemas/MemberResponse' + title: Members + type: array + x-stream-index: "004" type: - default: call.rtmp_broadcast_started - description: 'The type of event: "call.rtmp_broadcast_started" in this case' + default: call.member_updated + description: 'The type of event: "call.member_updated" in this case' title: Event Type type: string x-stream-index: "001.001" @@ -3377,35 +4343,48 @@ components: - type - created_at - call_cid - - name - title: CallRtmpBroadcastStartedEvent + - call + - members + title: CallMemberUpdatedEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: streaming + x-stream-event-doc-group: call x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallRtmpBroadcastStoppedEvent: - description: This event is sent when RTMP broadcast has stopped + CallMemberUpdatedPermissionEvent: + description: This event is sent when one or more members get its role updated properties: + call: + $ref: '#/components/schemas/CallResponse' + description: Call object + title: Call + x-stream-index: "003" call_cid: - description: The unique identifier for a call (:) - title: CID type: string x-stream-index: "002.001" + capabilities_by_role: + additionalProperties: + items: + type: string + type: array + description: The capabilities by role for this call + title: CapabilitiesByRole + type: object + x-stream-index: "004" created_at: - description: Date/time of creation format: date-time - title: Created at type: number x-stream-index: "001.002" - name: - description: Name of the given RTMP broadcast - title: Name - type: string - x-stream-index: "003" - type: - default: call.rtmp_broadcast_stopped - description: 'The type of event: "call.rtmp_broadcast_stopped" in this case' + members: + description: The list of members that were updated + items: + $ref: '#/components/schemas/MemberResponse' + title: Members + type: array + x-stream-index: "005" + type: + default: call.member_updated_permission + description: 'The type of event: "call.member_added" in this case' title: Event Type type: string x-stream-index: "001.001" @@ -3413,149 +4392,18 @@ components: - type - created_at - call_cid - - name - title: CallRtmpBroadcastStoppedEvent + - call + - capabilities_by_role + - members + title: CallMemberUpdatedPermissionEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: streaming + x-stream-event-doc-group: call x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallSession: - properties: - AcceptedBy: - additionalProperties: - format: date-time - type: number - type: object - writeOnly: true - x-stream-index: "008" - ActiveSFUs: - items: - $ref: '#/components/schemas/SFUIDLastSeen' - type: array - writeOnly: true - x-stream-index: "016" - AnonymousParticipantCount: - format: int32 - type: integer - writeOnly: true - x-stream-index: "019" - AppPK: - format: int32 - type: integer - writeOnly: true - x-stream-index: "002.001" - CallID: - type: string - writeOnly: true - x-stream-index: "002.003" - CallType: - type: string - writeOnly: true - x-stream-index: "002.002" - CreatedAt: - format: date-time - type: number - writeOnly: true - x-stream-index: "003" - DeletedAt: - format: date-time - type: number - writeOnly: true - x-stream-index: "004" - EndedAt: - format: date-time - type: number - writeOnly: true - x-stream-index: "006" - LiveEndedAt: - format: date-time - type: number - writeOnly: true - x-stream-index: "013" - LiveStartedAt: - format: date-time - type: number - writeOnly: true - x-stream-index: "012" - MissedBy: - additionalProperties: - format: date-time - type: number - type: object - writeOnly: true - x-stream-index: "010" - Participants: - items: - $ref: '#/components/schemas/CallParticipant' - type: array - writeOnly: true - x-stream-index: "011" - ParticipantsCountByRole: - additionalProperties: - format: int32 - type: integer - type: object - writeOnly: true - x-stream-index: "018" - RejectedBy: - additionalProperties: - format: date-time - type: number - type: object - writeOnly: true - x-stream-index: "009" - RingAt: - format: date-time - type: number - writeOnly: true - x-stream-index: "007" - SFUIDs: - items: - type: string - type: array - writeOnly: true - x-stream-index: "015" - SessionID: - type: string - writeOnly: true - x-stream-index: "002.004" - StartedAt: - format: date-time - type: number - writeOnly: true - x-stream-index: "005" - TimerEndsAt: - format: date-time - type: number - writeOnly: true - x-stream-index: "014" - UserPermissionOverrides: - additionalProperties: - additionalProperties: - type: boolean - type: object - type: object - writeOnly: true - x-stream-index: "017" - required: - - AppPK - - CallType - - CallID - - SessionID - - CreatedAt - - AcceptedBy - - RejectedBy - - MissedBy - - Participants - - SFUIDs - - ActiveSFUs - - UserPermissionOverrides - - ParticipantsCountByRole - - AnonymousParticipantCount - type: object - CallSessionEndedEvent: - description: This event is sent when a call session ends + CallMissedEvent: + description: This event is sent to call members who did not accept/reject/join + the call to notify they missed the call properties: call: $ref: '#/components/schemas/CallResponse' @@ -3569,37 +4417,49 @@ components: format: date-time type: number x-stream-index: "001.002" + members: + description: List of members who missed the call + items: + $ref: '#/components/schemas/MemberResponse' + title: Members + type: array + x-stream-index: "005" + notify_user: + type: boolean + x-stream-index: "007" session_id: description: Call session ID title: Session ID type: string x-stream-index: "003.001" type: - default: call.session_ended - description: 'The type of event: "call.session_ended" in this case' + default: call.missed + description: 'The type of event: "call.notification" in this case' title: Event Type type: string x-stream-index: "001.001" + user: + $ref: '#/components/schemas/UserResponse' + description: The caller from whom the call was missed + title: User + x-stream-index: "006" required: - type - created_at - call_cid - session_id - call - title: CallSessionEndedEvent + - members + - user + - notify_user + title: CallMissedEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: session + x-stream-event-doc-group: ring x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallSessionParticipantCountsUpdatedEvent: - description: This event is sent when the participant counts in a call session - are updated + CallModerationBlurEvent: properties: - anonymous_participant_count: - format: int32 - type: integer - x-stream-index: "005" call_cid: type: string x-stream-index: "002.001" @@ -3607,39 +4467,30 @@ components: format: date-time type: number x-stream-index: "001.002" - participants_count_by_role: - additionalProperties: - format: int32 - type: integer + custom: + additionalProperties: {} type: object x-stream-index: "004" - session_id: - description: Call session ID - title: Session ID - type: string - x-stream-index: "003.001" type: - default: call.session_participant_count_updated - description: 'The type of event: "call.session_participant_count_updated" - in this case' - title: Event Type + default: call.moderation_blur type: string x-stream-index: "001.001" + user_id: + type: string + x-stream-index: "003" required: - type - created_at - call_cid - - session_id - - participants_count_by_role - - anonymous_participant_count - title: CallSessionParticipantCountsUpdatedEvent + - user_id + - custom + title: CallModerationBlurEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: session + x-stream-event-doc-group: other x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallSessionParticipantJoinedEvent: - description: This event is sent when a participant joins a call session + CallModerationWarningEvent: properties: call_cid: type: string @@ -3648,38 +4499,42 @@ components: format: date-time type: number x-stream-index: "001.002" - participant: - $ref: '#/components/schemas/CallParticipantResponse' - description: The participant that joined the session - title: Participant - x-stream-index: "004" - session_id: - description: Call session ID - title: Session ID + custom: + additionalProperties: {} + type: object + x-stream-index: "005" + message: type: string - x-stream-index: "003.001" + x-stream-index: "004" type: - default: call.session_participant_joined - description: 'The type of event: "call.session_participant_joined" in this - case' - title: Event Type + default: call.moderation_warning type: string x-stream-index: "001.001" + user_id: + type: string + x-stream-index: "003" required: - type - created_at - call_cid - - session_id - - participant - title: CallSessionParticipantJoinedEvent + - user_id + - message + - custom + title: CallModerationWarningEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: session + x-stream-event-doc-group: other x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallSessionParticipantLeftEvent: - description: This event is sent when a participant leaves a call session + CallNotificationEvent: + description: This event is sent to all call members to notify they are getting + called properties: + call: + $ref: '#/components/schemas/CallResponse' + description: Call object + title: Call + x-stream-index: "004" call_cid: type: string x-stream-index: "002.001" @@ -3687,117 +4542,194 @@ components: format: date-time type: number x-stream-index: "001.002" - duration_seconds: - description: The duration participant was in the session in seconds - format: int32 - title: Duration - type: integer + members: + description: Call members + items: + $ref: '#/components/schemas/MemberResponse' + title: Members + type: array x-stream-index: "005" - participant: - $ref: '#/components/schemas/CallParticipantResponse' - description: The participant that left the session - title: Participant - x-stream-index: "004" session_id: description: Call session ID title: Session ID type: string x-stream-index: "003.001" type: - default: call.session_participant_left - description: 'The type of event: "call.session_participant_left" in this - case' + default: call.notification + description: 'The type of event: "call.notification" in this case' title: Event Type type: string x-stream-index: "001.001" + user: + $ref: '#/components/schemas/UserResponse' + description: The user that sent the call notification + title: User + x-stream-index: "006" required: - type - created_at - call_cid - session_id - - participant - - duration_seconds - title: CallSessionParticipantLeftEvent + - call + - members + - user + title: CallNotificationEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: session + x-stream-event-doc-group: ring x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallSessionResponse: + CallParticipant: + nullable: true properties: - accepted_by: - additionalProperties: - format: date-time - type: number - type: object - x-stream-index: "008" - anonymous_participant_count: + JoinedAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "004" + Role: + type: string + writeOnly: true + x-stream-index: "002" + UserSessionID: + type: string + writeOnly: true + x-stream-index: "003" + avg_response_time: format: int32 + readOnly: true type: integer - x-stream-index: "006" - ended_at: + x-stream-index: "001.046" + ban_expires: format: date-time type: number - x-stream-index: "003" + x-stream-index: "001.017" + banned: + type: boolean + x-stream-index: "001.016" + created_at: + format: date-time + readOnly: true + type: number + x-stream-index: "001.008" + custom: + additionalProperties: {} + type: object + x-stream-index: "001.006" + deactivated_at: + format: date-time + readOnly: true + type: number + x-stream-index: "001.014" + deleted_at: + format: date-time + readOnly: true + type: number + x-stream-index: "001.013" id: type: string - x-stream-index: "001" - live_ended_at: + x-stream-index: "001.003" + invisible: + type: boolean + x-stream-index: "001.023" + language: + type: string + x-stream-index: "001.035" + last_active: format: date-time + readOnly: true type: number - x-stream-index: "011" - live_started_at: + x-stream-index: "001.011" + last_engaged_at: format: date-time + readOnly: true type: number - x-stream-index: "010" - missed_by: - additionalProperties: - format: date-time - type: number - type: object - x-stream-index: "009" - participants: + x-stream-index: "001.012" + online: + readOnly: true + type: boolean + x-stream-index: "001.022" + privacy_settings: + $ref: '#/components/schemas/PrivacySettings' + x-stream-index: "001.026" + revoke_tokens_issued_before: + format: date-time + type: number + x-stream-index: "001.042" + role: + type: string + x-stream-index: "001.004" + teams: items: - $ref: '#/components/schemas/CallParticipantResponse' + type: string type: array - x-stream-index: "004" - participants_count_by_role: - additionalProperties: - format: int32 - type: integer - type: object - x-stream-index: "005" - rejected_by: + x-stream-index: "001.036" + teams_role: additionalProperties: - format: date-time - type: number + type: string type: object - x-stream-index: "007" - started_at: - format: date-time - type: number - x-stream-index: "002" - timer_ends_at: + x-stream-index: "001.005" + updated_at: format: date-time + readOnly: true type: number - x-stream-index: "012" + x-stream-index: "001.009" required: - id - - participants - - participants_count_by_role - - anonymous_participant_count - - rejected_by - - accepted_by - - missed_by + - role + - teams_role + - custom + - banned + - online + - Role + - UserSessionID + - JoinedAt type: object - CallSessionStartedEvent: - description: This event is sent when a call session starts + CallParticipantCountReport: properties: - call: - $ref: '#/components/schemas/CallResponse' - description: Call object - title: Call + histogram: + items: + $ref: '#/components/schemas/ReportByHistogramBucket' + type: array + x-stream-index: "001" + required: + - histogram + type: object + CallParticipantCountReportResponse: + properties: + daily: + items: + $ref: '#/components/schemas/DailyAggregateCallParticipantCountReportResponse' + type: array + x-stream-index: "001" + required: + - daily + type: object + CallParticipantResponse: + properties: + joined_at: + format: date-time + type: number x-stream-index: "004" + role: + type: string + x-stream-index: "003" + user: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "001" + user_session_id: + type: string + x-stream-index: "002" + required: + - user + - user_session_id + - role + - joined_at + type: object + CallReactionEvent: + description: This event is sent when a reaction is sent in a call, clients should + use this to show the reaction in the call screen + properties: call_cid: type: string x-stream-index: "002.001" @@ -3805,14 +4737,14 @@ components: format: date-time type: number x-stream-index: "001.002" - session_id: - description: Call session ID - title: Session ID - type: string - x-stream-index: "003.001" + reaction: + $ref: '#/components/schemas/ReactionResponse' + description: the reaction object sent by the user on the call + title: reaction + x-stream-index: "003" type: - default: call.session_started - description: 'The type of event: "call.session_started" in this case' + default: call.reaction_new + description: 'The type of event: "call.reaction_new" in this case' title: Event Type type: string x-stream-index: "001.001" @@ -3820,211 +4752,97 @@ components: - type - created_at - call_cid - - session_id - - call - title: CallSessionStartedEvent + - reaction + title: CallReactionEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: session + x-stream-event-doc-group: call x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallSettings: + CallRecording: + description: CallRecording represents a recording of a call. properties: - audio: - $ref: '#/components/schemas/AudioSettings' - x-stream-index: "001" - backstage: - $ref: '#/components/schemas/BackstageSettings' - x-stream-index: "002" - broadcasting: - $ref: '#/components/schemas/BroadcastSettings' - x-stream-index: "007" - frame_recording: - $ref: '#/components/schemas/FrameRecordSettings' - x-stream-index: "006" - geofencing: - $ref: '#/components/schemas/GeofenceSettings' - x-stream-index: "008" - ingress: - $ref: '#/components/schemas/IngressSettings' - x-stream-index: "014" - limits: - $ref: '#/components/schemas/LimitsSettings' - x-stream-index: "012" - recording: - $ref: '#/components/schemas/RecordSettings' - x-stream-index: "005" - ring: - $ref: '#/components/schemas/RingSettings' - x-stream-index: "010" - screensharing: - $ref: '#/components/schemas/ScreensharingSettings' + end_time: + format: date-time + title: The end time of the recording. + type: number x-stream-index: "004" - session: - $ref: '#/components/schemas/SessionSettings' - x-stream-index: "013" - thumbnails: - $ref: '#/components/schemas/ThumbnailsSettings' - x-stream-index: "011" - transcription: - $ref: '#/components/schemas/TranscriptionSettings' - x-stream-index: "009" - video: - $ref: '#/components/schemas/VideoSettings' - x-stream-index: "003" - type: object - CallSettingsRequest: - properties: - audio: - $ref: '#/components/schemas/AudioSettingsRequest' + filename: + title: The filename of the recording. + type: string x-stream-index: "001" - backstage: - $ref: '#/components/schemas/BackstageSettingsRequest' - x-stream-index: "002" - broadcasting: - $ref: '#/components/schemas/BroadcastSettingsRequest' - x-stream-index: "010" - frame_recording: - $ref: '#/components/schemas/FrameRecordingSettingsRequest' - x-stream-index: "006" - geofencing: - $ref: '#/components/schemas/GeofenceSettingsRequest' - x-stream-index: "003" - ingress: - $ref: '#/components/schemas/IngressSettingsRequest' - x-stream-index: "014" - limits: - $ref: '#/components/schemas/LimitsSettingsRequest' - x-stream-index: "012" - recording: - $ref: '#/components/schemas/RecordSettingsRequest' + session_id: + title: The session ID of the recording. + type: string x-stream-index: "005" - ring: - $ref: '#/components/schemas/RingSettingsRequest' - x-stream-index: "007" - screensharing: - $ref: '#/components/schemas/ScreensharingSettingsRequest' - x-stream-index: "008" - session: - $ref: '#/components/schemas/SessionSettingsRequest' - x-stream-index: "013" - thumbnails: - $ref: '#/components/schemas/ThumbnailsSettingsRequest' - x-stream-index: "011" - transcription: - $ref: '#/components/schemas/TranscriptionSettingsRequest' - x-stream-index: "009" - video: - $ref: '#/components/schemas/VideoSettingsRequest' - x-stream-index: "004" - type: object - CallSettingsResponse: - properties: - audio: - $ref: '#/components/schemas/AudioSettingsResponse' - x-stream-index: "001" - backstage: - $ref: '#/components/schemas/BackstageSettingsResponse' - x-stream-index: "002" - broadcasting: - $ref: '#/components/schemas/BroadcastSettingsResponse' + start_time: + format: date-time + title: The start time of the recording. + type: number x-stream-index: "003" - frame_recording: - $ref: '#/components/schemas/FrameRecordingSettingsResponse' - x-stream-index: "006" - geofencing: - $ref: '#/components/schemas/GeofenceSettingsResponse' - x-stream-index: "004" - ingress: - $ref: '#/components/schemas/IngressSettingsResponse' - x-stream-index: "014" - limits: - $ref: '#/components/schemas/LimitsSettingsResponse' - x-stream-index: "012" - recording: - $ref: '#/components/schemas/RecordSettingsResponse' - x-stream-index: "005" - ring: - $ref: '#/components/schemas/RingSettingsResponse' - x-stream-index: "007" - screensharing: - $ref: '#/components/schemas/ScreensharingSettingsResponse' - x-stream-index: "008" - session: - $ref: '#/components/schemas/SessionSettingsResponse' - x-stream-index: "013" - thumbnails: - $ref: '#/components/schemas/ThumbnailsSettingsResponse' - x-stream-index: "011" - transcription: - $ref: '#/components/schemas/TranscriptionSettingsResponse' - x-stream-index: "009" - video: - $ref: '#/components/schemas/VideoSettingsResponse' - x-stream-index: "010" + url: + title: The URL of the recording. + type: string + x-stream-index: "002" required: - - audio - - backstage - - broadcasting - - geofencing - - recording - - frame_recording - - ring - - screensharing - - transcription - - video - - thumbnails - - limits - - session + - filename + - url + - start_time + - end_time + - session_id + title: CallRecording type: object - CallStateResponseFields: - description: CallStateResponseFields is the payload for call state response + CallRecordingFailedEvent: + description: This event is sent when call recording has failed properties: - call: - $ref: '#/components/schemas/CallResponse' - x-stream-index: "001" - members: - description: List of call members - items: - $ref: '#/components/schemas/MemberResponse' - title: Members - type: array - x-stream-index: "002" - membership: - $ref: '#/components/schemas/MemberResponse' - description: Current user membership object - title: Membership + call_cid: + type: string + x-stream-index: "002.001" + created_at: + format: date-time + type: number + x-stream-index: "001.002" + egress_id: + type: string x-stream-index: "003" - own_capabilities: - items: - $ref: '#/components/schemas/OwnCapability' - type: array - x-stream-index: "004" + type: + default: call.recording_failed + description: 'The type of event: "call.recording_failed" in this case' + title: Event Type + type: string + x-stream-index: "001.001" required: - - call - - members - - own_capabilities - - blocked_users - title: CallStateResponseFields + - type + - created_at + - call_cid + - egress_id + title: CallRecordingFailedEvent type: object - CallStatsReportReadyEvent: - description: This event is sent when the insights report is ready + x-stream-event-call-type: true + x-stream-event-doc-group: recording + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + CallRecordingReadyEvent: + description: This event is sent when call recording is ready properties: call_cid: type: string x-stream-index: "002.001" + call_recording: + $ref: '#/components/schemas/CallRecording' + description: The call recording object + title: CallRecording + x-stream-index: "003" created_at: format: date-time type: number x-stream-index: "001.002" - session_id: - description: Call session ID - title: Session ID + egress_id: type: string - x-stream-index: "003.001" + x-stream-index: "004" type: - default: call.stats_report_ready - description: The type of event, "call.report_ready" in this case + default: call.recording_ready + description: 'The type of event: "call.recording_ready" in this case' title: Event Type type: string x-stream-index: "001.001" @@ -4032,157 +4850,46 @@ components: - type - created_at - call_cid - - session_id - title: CallStatsReportReadyEvent + - call_recording + - egress_id + title: CallRecordingReadyEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: other + x-stream-event-doc-group: recording x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallStatsReportSummaryResponse: + CallRecordingStartedEvent: + description: This event is sent when call recording has started properties: call_cid: type: string - x-stream-index: "001" - call_duration_seconds: - format: int32 - type: integer - x-stream-index: "008" - call_session_id: - type: string - x-stream-index: "002" - call_status: - type: string - x-stream-index: "004" + x-stream-index: "003.001" created_at: format: date-time type: number - x-stream-index: "007" - first_stats_time: - format: date-time - type: number - x-stream-index: "003" - min_user_rating: - format: int32 - type: integer - x-stream-index: "006" - quality_score: - format: int32 - type: integer - x-stream-index: "005" - required: - - call_cid - - call_session_id - - first_stats_time - - call_status - - call_duration_seconds - type: object - CallTranscription: - description: CallTranscription represents a transcription of a call. - properties: - end_time: - format: date-time - title: The end time of the transcription. - type: number - x-stream-index: "004" - filename: - title: The filename of the transcription. - type: string - x-stream-index: "001" - session_id: - title: The session ID of the transcription. - type: string - x-stream-index: "005" - start_time: - format: date-time - title: The start time of the transcription. - type: number - x-stream-index: "003" - url: - title: The URL of the transcription. - type: string - x-stream-index: "002" - required: - - filename - - url - - start_time - - end_time - - session_id - title: CallTranscription - type: object - CallTranscriptionFailedEvent: - description: This event is sent when call transcription has failed - properties: - call_cid: - type: string - x-stream-index: "002.001" - created_at: - format: date-time - type: number - x-stream-index: "001.002" + x-stream-index: "002.002" egress_id: type: string - x-stream-index: "003" - error: - description: The error message detailing why transcription failed. - title: string - type: string - x-stream-index: "004" + x-stream-index: "001" type: - default: call.transcription_failed - description: 'The type of event: "call.transcription_failed" in this case' + default: call.recording_started + description: 'The type of event: "call.recording_started" in this case' title: Event Type - type: string - x-stream-index: "001.001" - required: - - type - - created_at - - call_cid - - egress_id - title: CallTranscriptionFailedEvent - type: object - x-stream-event-call-type: true - x-stream-event-doc-group: transcription - x-stream-is-event: true - x-stream-ws-base-event-name: VideoEvent - CallTranscriptionReadyEvent: - description: This event is sent when call transcription is ready - properties: - call_cid: type: string x-stream-index: "002.001" - call_transcription: - $ref: '#/components/schemas/CallTranscription' - description: The call transcription object - title: CallTranscription - x-stream-index: "003" - created_at: - format: date-time - type: number - x-stream-index: "001.002" - egress_id: - type: string - x-stream-index: "004" - type: - default: call.transcription_ready - description: 'The type of event: "call.transcription_ready" in this case' - title: Event Type - type: string - x-stream-index: "001.001" required: + - egress_id - type - created_at - call_cid - - call_transcription - - egress_id - title: CallTranscriptionReadyEvent + title: CallRecordingStartedEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: transcription + x-stream-event-doc-group: recording x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallTranscriptionStartedEvent: - description: This event is sent when call transcription has started + CallRecordingStoppedEvent: + description: This event is sent when call recording has stopped properties: call_cid: type: string @@ -4195,8 +4902,8 @@ components: type: string x-stream-index: "001" type: - default: call.transcription_started - description: 'The type of event: "call.transcription_started" in this case' + default: call.recording_stopped + description: 'The type of event: "call.recording_stopped" in this case' title: Event Type type: string x-stream-index: "002.001" @@ -4205,15 +4912,19 @@ components: - type - created_at - call_cid - title: CallTranscriptionStartedEvent + title: CallRecordingStoppedEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: transcription + x-stream-event-doc-group: recording x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallTranscriptionStoppedEvent: - description: This event is sent when call transcription has stopped + CallRejectedEvent: + description: This event is sent when a user rejects a notification to join a + call. properties: + call: + $ref: '#/components/schemas/CallResponse' + x-stream-index: "003" call_cid: type: string x-stream-index: "002.001" @@ -4221,197 +4932,280 @@ components: format: date-time type: number x-stream-index: "001.002" - egress_id: + reason: + description: 'Provides information about why the call was rejected. You + can provide any value, but the Stream API and SDKs use these default values: + rejected, cancel, timeout and busy' + title: Reason type: string - x-stream-index: "003" + x-stream-index: "005" type: - default: call.transcription_stopped - description: 'The type of event: "call.transcription_stopped" in this case' + default: call.rejected + description: 'The type of event: "call.rejected" in this case' title: Event Type type: string x-stream-index: "001.001" + user: + $ref: '#/components/schemas/UserResponse' + description: The user who rejected the call + title: User + x-stream-index: "004" required: - type - created_at - call_cid - - egress_id - title: CallTranscriptionStoppedEvent + - call + - user + title: CallRejectedEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: transcription + x-stream-event-doc-group: ring x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallType: + CallReportResponse: properties: - AppPK: - format: int32 - type: integer - writeOnly: true - x-stream-index: "003" - CreatedAt: + ended_at: format: date-time type: number - writeOnly: true - x-stream-index: "005" - ExternalStorage: - type: string - writeOnly: true - x-stream-index: "009" - Name: - type: string - writeOnly: true - x-stream-index: "004" - NotificationSettings: - $ref: '#/components/schemas/NotificationSettings' - x-stream-index: "008" - PK: - format: int32 - type: integer - writeOnly: true - x-stream-index: "002" - Settings: - $ref: '#/components/schemas/CallSettings' - x-stream-index: "007" - UpdatedAt: + x-stream-index: "003" + score: + format: float + type: number + x-stream-index: "001" + started_at: format: date-time type: number - writeOnly: true - x-stream-index: "006" + x-stream-index: "002" required: - - PK - - AppPK - - Name - - CreatedAt - - UpdatedAt - - ExternalStorage + - score type: object - CallUpdatedEvent: - description: |- - This event is sent when a call is updated, clients should use this update the local state of the call. - This event also contains the capabilities by role for the call, clients should update the own_capability for the current. + CallRequest: + description: CallRequest is the payload for creating a call. properties: - call: - $ref: '#/components/schemas/CallResponse' - description: Call object - title: Call - x-stream-index: "003" - call_cid: + channel_cid: type: string - x-stream-index: "002.001" - capabilities_by_role: - additionalProperties: - items: - type: string - type: array - description: The capabilities by role for this call - title: CapabilitiesByRole + x-stream-index: "009" + custom: + additionalProperties: {} type: object x-stream-index: "004" - created_at: + members: + items: + $ref: '#/components/schemas/MemberRequest' + maximum: 100 + type: array + x-stream-index: "005" + settings_override: + $ref: '#/components/schemas/CallSettingsRequest' + x-stream-index: "006" + starts_at: format: date-time type: number - x-stream-index: "001.002" - type: - default: call.updated - description: 'The type of event: "call.ended" in this case' - title: Event Type + x-stream-index: "007" + team: type: string - x-stream-index: "001.001" - required: - - type - - created_at - - call_cid - - call - - capabilities_by_role - title: CallUpdatedEvent - type: object - x-stream-event-call-type: true - x-stream-event-doc-group: call - x-stream-is-event: true - x-stream-ws-base-event-name: VideoEvent - CallUserFeedbackSubmittedEvent: - description: This event is sent when a user submits feedback for a call. + x-stream-index: "001" + video: + type: boolean + x-stream-index: "008" + title: CallRequest + type: object + CallResponse: + description: Represents a call properties: - call_cid: + backstage: + type: boolean + x-stream-index: "016" + blocked_user_ids: + items: + type: string + type: array + x-stream-index: "018" + captioning: + type: boolean + x-stream-index: "013" + channel_cid: type: string - x-stream-index: "002.001" + x-stream-index: "024" + cid: + description: The unique identifier for a call (:) + title: CID + type: string + x-stream-index: "004" created_at: + description: Date/time of creation format: date-time + title: Created at type: number - x-stream-index: "001.002" + x-stream-index: "009" + created_by: + $ref: '#/components/schemas/UserResponse' + description: The user that created the call + title: Created By + x-stream-index: "007" + current_session_id: + type: string + x-stream-index: "005" custom: additionalProperties: {} - description: Custom data provided by the user - title: Custom + description: Custom data for this object + title: Custom data type: object - x-stream-index: "007" - rating: - description: The rating given by the user (1-5) + x-stream-index: "008" + egress: + $ref: '#/components/schemas/EgressResponse' + x-stream-index: "021" + ended_at: + description: Date/time when the call ended + format: date-time + title: Ended At + type: number + x-stream-index: "014" + id: + description: Call ID + title: ID + type: string + x-stream-index: "003" + ingress: + $ref: '#/components/schemas/CallIngressResponse' + x-stream-index: "019" + join_ahead_time_seconds: format: int32 - title: Rating type: integer - x-stream-index: "005" - reason: - description: The reason provided by the user for the rating - title: Reason + x-stream-index: "023" + recording: + type: boolean + x-stream-index: "011" + session: + $ref: '#/components/schemas/CallSessionResponse' + x-stream-index: "020" + settings: + $ref: '#/components/schemas/CallSettingsResponse' + x-stream-index: "017" + starts_at: + description: Date/time when the call will start + format: date-time + title: Starts At + type: number + x-stream-index: "015" + team: type: string x-stream-index: "006" - sdk: + thumbnails: + $ref: '#/components/schemas/ThumbnailResponse' + x-stream-index: "022" + transcribing: + type: boolean + x-stream-index: "012" + type: + description: The type of call + title: Type type: string - x-stream-index: "008" - sdk_version: + x-stream-index: "002" + updated_at: + description: Date/time of the last update + format: date-time + title: Updated at + type: number + x-stream-index: "010" + required: + - type + - id + - cid + - current_session_id + - created_by + - custom + - created_at + - updated_at + - recording + - transcribing + - captioning + - backstage + - settings + - blocked_user_ids + - ingress + - egress + title: CallResponse + type: object + CallRingEvent: + description: This event is sent to all call members to notify they are getting + called + properties: + call: + $ref: '#/components/schemas/CallResponse' + description: Call object + title: Call + x-stream-index: "005" + call_cid: type: string - x-stream-index: "009" + x-stream-index: "002.001" + created_at: + format: date-time + type: number + x-stream-index: "001.002" + members: + description: Call members + items: + $ref: '#/components/schemas/MemberResponse' + title: Members + type: array + x-stream-index: "006" session_id: description: Call session ID title: Session ID type: string x-stream-index: "003.001" type: - default: call.user_feedback_submitted - description: The type of event, "call.user_feedback" in this case + default: call.ring + description: 'The type of event: "call.notification" in this case' title: Event Type type: string x-stream-index: "001.001" user: $ref: '#/components/schemas/UserResponse' - description: The user who submitted the feedback + description: The user that sent the call notification title: User - x-stream-index: "004" + x-stream-index: "007" + video: + type: boolean + x-stream-index: "008" required: - type - created_at - call_cid - session_id + - call + - members - user - - rating - title: CallUserFeedbackSubmittedEvent + - video + title: CallRingEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: other + x-stream-event-doc-group: ring x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallUserMutedEvent: - description: This event is sent when a call member is muted + CallRtmpBroadcastFailedEvent: + description: This event is sent when a call RTMP broadcast has failed properties: call_cid: + description: The unique identifier for a call (:) + title: CID type: string x-stream-index: "002.001" created_at: + description: Date/time of creation format: date-time + title: Created at type: number x-stream-index: "001.002" - from_user_id: + name: + description: Name of the given RTMP broadcast + title: Name type: string x-stream-index: "003" - muted_user_ids: - items: - type: string - type: array - x-stream-index: "004" type: - default: call.user_muted - description: 'The type of event: "call.user_muted" in this case' + default: call.rtmp_broadcast_failed + description: 'The type of event: "call.rtmp_broadcast_failed" in this case' title: Event Type type: string x-stream-index: "001.001" @@ -4419,1386 +5213,1601 @@ components: - type - created_at - call_cid - - from_user_id - - muted_user_ids - title: CallUserMutedEvent + - name + title: CallRtmpBroadcastFailedEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: call + x-stream-event-doc-group: streaming x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallsPerDayReport: - properties: - count: - format: int64 - type: integer - x-stream-index: "001" - required: - - count - type: object - CallsPerDayReportResponse: - properties: - daily: - items: - $ref: '#/components/schemas/DailyAggregateCallsPerDayReportResponse' - type: array - x-stream-index: "001" - required: - - daily - type: object - CastPollVoteRequest: - nullable: true - properties: - vote: - $ref: '#/components/schemas/VoteData' - description: Vote data - title: VoteData - x-stream-index: "004" - type: object - Channel: + CallRtmpBroadcastStartedEvent: + description: This event is sent when RTMP broadcast has started properties: - active_live_locations: - items: - $ref: '#/components/schemas/SharedLocation' - type: array - x-stream-index: "034" - auto_translation_enabled: - type: boolean - x-stream-index: "029" - auto_translation_language: + call_cid: + description: The unique identifier for a call (:) + title: CID type: string - x-stream-index: "030" - cid: + x-stream-index: "002.001" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: "001.002" + name: + description: Name of the given RTMP broadcast + title: Name type: string x-stream-index: "003" - config: - $ref: '#/components/schemas/ChannelConfig' - x-stream-index: "026" - config_overrides: - $ref: '#/components/schemas/ConfigOverrides' - x-stream-index: "027" - cooldown: - format: int32 - type: integer - x-stream-index: "031" + type: + default: call.rtmp_broadcast_started + description: 'The type of event: "call.rtmp_broadcast_started" in this case' + title: Event Type + type: string + x-stream-index: "001.001" + required: + - type + - created_at + - call_cid + - name + title: CallRtmpBroadcastStartedEvent + type: object + x-stream-event-call-type: true + x-stream-event-doc-group: streaming + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + CallRtmpBroadcastStoppedEvent: + description: This event is sent when RTMP broadcast has stopped + properties: + call_cid: + description: The unique identifier for a call (:) + title: CID + type: string + x-stream-index: "002.001" created_at: + description: Date/time of creation format: date-time + title: Created at type: number - x-stream-index: "009" - created_by: - $ref: '#/components/schemas/User' - x-stream-index: "008" - custom: - additionalProperties: {} + x-stream-index: "001.002" + name: + description: Name of the given RTMP broadcast + title: Name + type: string + x-stream-index: "003" + type: + default: call.rtmp_broadcast_stopped + description: 'The type of event: "call.rtmp_broadcast_stopped" in this case' + title: Event Type + type: string + x-stream-index: "001.001" + required: + - type + - created_at + - call_cid + - name + title: CallRtmpBroadcastStoppedEvent + type: object + x-stream-event-call-type: true + x-stream-event-doc-group: streaming + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + CallSession: + properties: + AcceptedBy: + additionalProperties: + format: date-time + type: number type: object + writeOnly: true + x-stream-index: "008" + ActiveSFUs: + items: + $ref: '#/components/schemas/SFUIDLastSeen' + type: array + writeOnly: true + x-stream-index: "016" + AnonymousParticipantCount: + format: int32 + type: integer + writeOnly: true x-stream-index: "019" - deleted_at: + AppPK: + format: int32 + type: integer + writeOnly: true + x-stream-index: "002.001" + CallID: + type: string + writeOnly: true + x-stream-index: "002.003" + CallType: + type: string + writeOnly: true + x-stream-index: "002.002" + CreatedAt: format: date-time type: number - x-stream-index: "011" - disabled: - type: boolean - x-stream-index: "017" - frozen: - type: boolean - x-stream-index: "016" - id: - type: string + writeOnly: true + x-stream-index: "003" + DeletedAt: + format: date-time + type: number + writeOnly: true x-stream-index: "004" - invites: + EndedAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "006" + LiveEndedAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "013" + LiveStartedAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "012" + MissedBy: + additionalProperties: + format: date-time + type: number + type: object + writeOnly: true + x-stream-index: "010" + Participants: items: - $ref: '#/components/schemas/ChannelMember' + $ref: '#/components/schemas/CallParticipant' type: array - x-stream-index: "022" - last_campaigns: - type: string - x-stream-index: "032" - last_message_at: + writeOnly: true + x-stream-index: "011" + ParticipantsCountByRole: + additionalProperties: + format: int32 + type: integer + type: object + writeOnly: true + x-stream-index: "018" + RejectedBy: + additionalProperties: + format: date-time + type: number + type: object + writeOnly: true + x-stream-index: "009" + RingAt: format: date-time type: number - x-stream-index: "006" - member_count: - format: int32 - type: integer - x-stream-index: "021" - members: + writeOnly: true + x-stream-index: "007" + SFUIDs: items: - $ref: '#/components/schemas/ChannelMember' + type: string type: array - x-stream-index: "020" - team: - type: string - x-stream-index: "028" - truncated_by: - $ref: '#/components/schemas/User' + writeOnly: true x-stream-index: "015" - type: + SessionID: type: string + writeOnly: true + x-stream-index: "002.004" + StartedAt: + format: date-time + type: number + writeOnly: true x-stream-index: "005" - updated_at: + TimerEndsAt: format: date-time type: number - x-stream-index: "010" + writeOnly: true + x-stream-index: "014" + UserPermissionOverrides: + additionalProperties: + additionalProperties: + type: boolean + type: object + type: object + writeOnly: true + x-stream-index: "017" required: - - cid - - id - - type - - created_at - - updated_at - - frozen - - disabled - - custom - - auto_translation_language + - AppPK + - CallType + - CallID + - SessionID + - CreatedAt + - AcceptedBy + - RejectedBy + - MissedBy + - Participants + - SFUIDs + - ActiveSFUs + - UserPermissionOverrides + - ParticipantsCountByRole + - AnonymousParticipantCount type: object - ChannelConfig: + CallSessionEndedEvent: + description: This event is sent when a call session ends properties: - allowed_flag_reasons: - items: - type: string - type: array - x-stream-index: "001.026" - automod: - enum: - - disabled - - simple - - AI + call: + $ref: '#/components/schemas/CallResponse' + description: Call object + title: Call + x-stream-index: "004" + call_cid: type: string - x-stream-index: "001.021" - automod_behavior: - enum: - - flag - - block - - shadow_block + x-stream-index: "002.001" + created_at: + format: date-time + type: number + x-stream-index: "001.002" + session_id: + description: Call session ID + title: Session ID type: string - x-stream-index: "001.022" - automod_thresholds: - $ref: '#/components/schemas/Thresholds' - x-stream-index: "001.027" - blocklist: + x-stream-index: "003.001" + type: + default: call.session_ended + description: 'The type of event: "call.session_ended" in this case' + title: Event Type type: string - x-stream-index: "001.023" - blocklist_behavior: - enum: - - flag - - block - - shadow_block + x-stream-index: "001.001" + required: + - type + - created_at + - call_cid + - session_id + - call + title: CallSessionEndedEvent + type: object + x-stream-event-call-type: true + x-stream-event-doc-group: session + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + CallSessionParticipantCountsUpdatedEvent: + description: This event is sent when the participant counts in a call session + are updated + properties: + anonymous_participant_count: + format: int32 + type: integer + x-stream-index: "005" + call_cid: type: string - x-stream-index: "001.024" - blocklists: - items: - $ref: '#/components/schemas/BlockListOptions' - type: array - x-stream-index: "001.025" - commands: - items: - type: string - type: array - x-stream-index: "003" - connect_events: - type: boolean - x-stream-index: "001.004" + x-stream-index: "002.001" created_at: format: date-time type: number - x-stream-index: "002.003" - custom_events: - type: boolean - x-stream-index: "001.012" - mark_messages_pending: - type: boolean - x-stream-index: "001.015" - max_message_length: - format: int32 - maximum: 20000 - type: integer - x-stream-index: "001.020" - mutes: - type: boolean - x-stream-index: "001.009" - name: + x-stream-index: "001.002" + participants_count_by_role: + additionalProperties: + format: int32 + type: integer + type: object + x-stream-index: "004" + session_id: + description: Call session ID + title: Session ID + type: string + x-stream-index: "003.001" + type: + default: call.session_participant_count_updated + description: 'The type of event: "call.session_participant_count_updated" + in this case' + title: Event Type type: string x-stream-index: "001.001" - partition_size: - format: int32 - type: integer - x-stream-index: "001.028" - partition_ttl: - type: integer - x-stream-index: "001.029" - polls: - type: boolean - x-stream-index: "001.016" - push_notifications: - type: boolean - x-stream-index: "001.013" - quotes: - type: boolean - x-stream-index: "001.008" - reactions: - type: boolean - x-stream-index: "001.006" - read_events: - type: boolean - x-stream-index: "001.003" - reminders: - type: boolean - x-stream-index: "001.014" - replies: - type: boolean - x-stream-index: "001.007" - search: - type: boolean - x-stream-index: "001.005" - shared_locations: - type: boolean - x-stream-index: "001.018" - skip_last_msg_update_for_system_msgs: - type: boolean - x-stream-index: "001.030" - typing_events: - type: boolean - x-stream-index: "001.002" - updated_at: - format: date-time - type: number - x-stream-index: "002.004" - uploads: - type: boolean - x-stream-index: "001.010" - url_enrichment: - type: boolean - x-stream-index: "001.011" - user_message_reminders: - type: boolean - x-stream-index: "001.017" required: - - name - - typing_events - - read_events - - connect_events - - search - - reactions - - replies - - quotes - - mutes - - uploads - - url_enrichment - - custom_events - - push_notifications - - reminders - - mark_messages_pending - - polls - - user_message_reminders - - shared_locations - - message_retention - - max_message_length - - automod - - automod_behavior - - skip_last_msg_update_for_system_msgs + - type - created_at - - updated_at - - commands + - call_cid + - session_id + - participants_count_by_role + - anonymous_participant_count + title: CallSessionParticipantCountsUpdatedEvent type: object - ChannelConfigWithInfo: + x-stream-event-call-type: true + x-stream-event-doc-group: session + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + CallSessionParticipantJoinedEvent: + description: This event is sent when a participant joins a call session properties: - allowed_flag_reasons: - items: - type: string - type: array - x-stream-index: 001.002.026 - automod: - enum: - - disabled - - simple - - AI + call_cid: type: string - x-stream-index: 001.002.021 - automod_behavior: - enum: - - flag - - block - - shadow_block + x-stream-index: "002.001" + created_at: + format: date-time + type: number + x-stream-index: "001.002" + participant: + $ref: '#/components/schemas/CallParticipantResponse' + description: The participant that joined the session + title: Participant + x-stream-index: "004" + session_id: + description: Call session ID + title: Session ID type: string - x-stream-index: 001.002.022 - automod_thresholds: - $ref: '#/components/schemas/Thresholds' - x-stream-index: 001.002.027 - blocklist: + x-stream-index: "003.001" + type: + default: call.session_participant_joined + description: 'The type of event: "call.session_participant_joined" in this + case' + title: Event Type type: string - x-stream-index: 001.002.023 - blocklist_behavior: - enum: - - flag - - block - - shadow_block + x-stream-index: "001.001" + required: + - type + - created_at + - call_cid + - session_id + - participant + title: CallSessionParticipantJoinedEvent + type: object + x-stream-event-call-type: true + x-stream-event-doc-group: session + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + CallSessionParticipantLeftEvent: + description: This event is sent when a participant leaves a call session + properties: + call_cid: type: string - x-stream-index: 001.002.024 - blocklists: - items: - $ref: '#/components/schemas/BlockListOptions' - type: array - x-stream-index: 001.002.025 - commands: - items: - $ref: '#/components/schemas/Command' - type: array - x-stream-index: "001.003" - connect_events: - type: boolean - x-stream-index: 001.002.004 + x-stream-index: "002.001" created_at: format: date-time type: number - x-stream-index: 001.001.003 - custom_events: - type: boolean - x-stream-index: 001.002.012 - grants: - additionalProperties: - items: - type: string - type: array - type: object - x-stream-index: "002" - mark_messages_pending: - type: boolean - x-stream-index: 001.002.015 - max_message_length: - format: int32 - maximum: 20000 - type: integer - x-stream-index: 001.002.020 - mutes: - type: boolean - x-stream-index: 001.002.009 - name: - type: string - x-stream-index: 001.002.001 - partition_size: + x-stream-index: "001.002" + duration_seconds: + description: The duration participant was in the session in seconds format: int32 + title: Duration type: integer - x-stream-index: 001.002.028 - partition_ttl: - example: 24h - format: duration - nullable: true + x-stream-index: "005" + participant: + $ref: '#/components/schemas/CallParticipantResponse' + description: The participant that left the session + title: Participant + x-stream-index: "004" + session_id: + description: Call session ID + title: Session ID type: string - x-stream-index: 001.002.029 - polls: - type: boolean - x-stream-index: 001.002.016 - push_notifications: - type: boolean - x-stream-index: 001.002.013 - quotes: - type: boolean - x-stream-index: 001.002.008 - reactions: - type: boolean - x-stream-index: 001.002.006 - read_events: - type: boolean - x-stream-index: 001.002.003 - reminders: - type: boolean - x-stream-index: 001.002.014 - replies: - type: boolean - x-stream-index: 001.002.007 - search: - type: boolean - x-stream-index: 001.002.005 - shared_locations: - type: boolean - x-stream-index: 001.002.018 - skip_last_msg_update_for_system_msgs: - type: boolean - x-stream-index: 001.002.030 - typing_events: - type: boolean - x-stream-index: 001.002.002 - updated_at: - format: date-time - type: number - x-stream-index: 001.001.004 - uploads: - type: boolean - x-stream-index: 001.002.010 - url_enrichment: - type: boolean - x-stream-index: 001.002.011 - user_message_reminders: - type: boolean - x-stream-index: 001.002.017 - required: - - created_at - - updated_at - - name - - typing_events - - read_events - - connect_events - - search - - reactions - - replies - - quotes - - mutes - - uploads - - url_enrichment - - custom_events - - push_notifications - - reminders - - mark_messages_pending - - polls - - user_message_reminders - - shared_locations - - message_retention - - max_message_length - - automod - - automod_behavior - - skip_last_msg_update_for_system_msgs - - commands - type: object - ChannelCreatedEvent: - properties: - created_at: - format: date-time - type: number - x-stream-index: "001.002" + x-stream-index: "003.001" type: - default: channel.created + default: call.session_participant_left + description: 'The type of event: "call.session_participant_left" in this + case' + title: Event Type type: string x-stream-index: "001.001" required: - type - created_at - title: ChannelCreatedEvent + - call_cid + - session_id + - participant + - duration_seconds + title: CallSessionParticipantLeftEvent type: object - x-stream-event-client-type: true - x-stream-event-doc-group: other + x-stream-event-call-type: true + x-stream-event-doc-group: session x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - ChannelDeletedEvent: + CallSessionResponse: properties: - channel: - $ref: '#/components/schemas/ChannelResponse' - x-stream-index: "003.004" - channel_id: - type: string - x-stream-index: "003.002" - channel_member_count: + accepted_by: + additionalProperties: + format: date-time + type: number + type: object + x-stream-index: "008" + anonymous_participant_count: format: int32 type: integer - x-stream-index: "003.005" - channel_type: + x-stream-index: "006" + ended_at: + format: date-time + type: number + x-stream-index: "003" + id: type: string - x-stream-index: "003.003" - cid: + x-stream-index: "001" + live_ended_at: + format: date-time + type: number + x-stream-index: "011" + live_started_at: + format: date-time + type: number + x-stream-index: "010" + missed_by: + additionalProperties: + format: date-time + type: number + type: object + x-stream-index: "009" + participants: + items: + $ref: '#/components/schemas/CallParticipantResponse' + type: array + x-stream-index: "004" + participants_count_by_role: + additionalProperties: + format: int32 + type: integer + type: object + x-stream-index: "005" + rejected_by: + additionalProperties: + format: date-time + type: number + type: object + x-stream-index: "007" + started_at: + format: date-time + type: number + x-stream-index: "002" + timer_ends_at: + format: date-time + type: number + x-stream-index: "012" + required: + - id + - participants + - participants_count_by_role + - anonymous_participant_count + - rejected_by + - accepted_by + - missed_by + type: object + CallSessionStartedEvent: + description: This event is sent when a call session starts + properties: + call: + $ref: '#/components/schemas/CallResponse' + description: Call object + title: Call + x-stream-index: "004" + call_cid: type: string - x-stream-index: "003.001" + x-stream-index: "002.001" created_at: format: date-time type: number - x-stream-index: "002.002" - team: + x-stream-index: "001.002" + session_id: + description: Call session ID + title: Session ID type: string - x-stream-index: "001.001" + x-stream-index: "003.001" type: - default: channel.deleted + default: call.session_started + description: 'The type of event: "call.session_started" in this case' + title: Event Type type: string - x-stream-index: "002.001" + x-stream-index: "001.001" required: - type - created_at - - cid - - channel_id - - channel_type - - channel_member_count - title: ChannelDeletedEvent + - call_cid + - session_id + - call + title: CallSessionStartedEvent type: object - x-stream-event-client-type: true - x-stream-event-doc-group: other + x-stream-event-call-type: true + x-stream-event-doc-group: session x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - ChannelFrozenEvent: + CallSettings: properties: - channel_id: - type: string - x-stream-index: "002.002" - channel_type: - type: string - x-stream-index: "002.003" - cid: + audio: + $ref: '#/components/schemas/AudioSettings' + x-stream-index: "001" + backstage: + $ref: '#/components/schemas/BackstageSettings' + x-stream-index: "002" + broadcasting: + $ref: '#/components/schemas/BroadcastSettings' + x-stream-index: "007" + frame_recording: + $ref: '#/components/schemas/FrameRecordSettings' + x-stream-index: "006" + geofencing: + $ref: '#/components/schemas/GeofenceSettings' + x-stream-index: "008" + ingress: + $ref: '#/components/schemas/IngressSettings' + x-stream-index: "014" + limits: + $ref: '#/components/schemas/LimitsSettings' + x-stream-index: "012" + recording: + $ref: '#/components/schemas/RecordSettings' + x-stream-index: "005" + ring: + $ref: '#/components/schemas/RingSettings' + x-stream-index: "010" + screensharing: + $ref: '#/components/schemas/ScreensharingSettings' + x-stream-index: "004" + session: + $ref: '#/components/schemas/SessionSettings' + x-stream-index: "013" + thumbnails: + $ref: '#/components/schemas/ThumbnailsSettings' + x-stream-index: "011" + transcription: + $ref: '#/components/schemas/TranscriptionSettings' + x-stream-index: "009" + video: + $ref: '#/components/schemas/VideoSettings' + x-stream-index: "003" + type: object + CallSettingsRequest: + properties: + audio: + $ref: '#/components/schemas/AudioSettingsRequest' + x-stream-index: "001" + backstage: + $ref: '#/components/schemas/BackstageSettingsRequest' + x-stream-index: "002" + broadcasting: + $ref: '#/components/schemas/BroadcastSettingsRequest' + x-stream-index: "010" + frame_recording: + $ref: '#/components/schemas/FrameRecordingSettingsRequest' + x-stream-index: "006" + geofencing: + $ref: '#/components/schemas/GeofenceSettingsRequest' + x-stream-index: "003" + ingress: + $ref: '#/components/schemas/IngressSettingsRequest' + x-stream-index: "014" + limits: + $ref: '#/components/schemas/LimitsSettingsRequest' + x-stream-index: "012" + recording: + $ref: '#/components/schemas/RecordSettingsRequest' + x-stream-index: "005" + ring: + $ref: '#/components/schemas/RingSettingsRequest' + x-stream-index: "007" + screensharing: + $ref: '#/components/schemas/ScreensharingSettingsRequest' + x-stream-index: "008" + session: + $ref: '#/components/schemas/SessionSettingsRequest' + x-stream-index: "013" + thumbnails: + $ref: '#/components/schemas/ThumbnailsSettingsRequest' + x-stream-index: "011" + transcription: + $ref: '#/components/schemas/TranscriptionSettingsRequest' + x-stream-index: "009" + video: + $ref: '#/components/schemas/VideoSettingsRequest' + x-stream-index: "004" + type: object + CallSettingsResponse: + properties: + audio: + $ref: '#/components/schemas/AudioSettingsResponse' + x-stream-index: "001" + backstage: + $ref: '#/components/schemas/BackstageSettingsResponse' + x-stream-index: "002" + broadcasting: + $ref: '#/components/schemas/BroadcastSettingsResponse' + x-stream-index: "003" + frame_recording: + $ref: '#/components/schemas/FrameRecordingSettingsResponse' + x-stream-index: "006" + geofencing: + $ref: '#/components/schemas/GeofenceSettingsResponse' + x-stream-index: "004" + ingress: + $ref: '#/components/schemas/IngressSettingsResponse' + x-stream-index: "014" + limits: + $ref: '#/components/schemas/LimitsSettingsResponse' + x-stream-index: "012" + recording: + $ref: '#/components/schemas/RecordSettingsResponse' + x-stream-index: "005" + ring: + $ref: '#/components/schemas/RingSettingsResponse' + x-stream-index: "007" + screensharing: + $ref: '#/components/schemas/ScreensharingSettingsResponse' + x-stream-index: "008" + session: + $ref: '#/components/schemas/SessionSettingsResponse' + x-stream-index: "013" + thumbnails: + $ref: '#/components/schemas/ThumbnailsSettingsResponse' + x-stream-index: "011" + transcription: + $ref: '#/components/schemas/TranscriptionSettingsResponse' + x-stream-index: "009" + video: + $ref: '#/components/schemas/VideoSettingsResponse' + x-stream-index: "010" + required: + - audio + - backstage + - broadcasting + - geofencing + - recording + - frame_recording + - ring + - screensharing + - transcription + - video + - thumbnails + - limits + - session + type: object + CallStateResponseFields: + description: CallStateResponseFields is the payload for call state response + properties: + call: + $ref: '#/components/schemas/CallResponse' + x-stream-index: "001" + members: + description: List of call members + items: + $ref: '#/components/schemas/MemberResponse' + title: Members + type: array + x-stream-index: "002" + membership: + $ref: '#/components/schemas/MemberResponse' + description: Current user membership object + title: Membership + x-stream-index: "003" + own_capabilities: + items: + $ref: '#/components/schemas/OwnCapability' + type: array + x-stream-index: "004" + required: + - call + - members + - own_capabilities + - blocked_users + title: CallStateResponseFields + type: object + CallStatsReportReadyEvent: + description: This event is sent when the insights report is ready + properties: + call_cid: type: string x-stream-index: "002.001" created_at: format: date-time type: number x-stream-index: "001.002" + session_id: + description: Call session ID + title: Session ID + type: string + x-stream-index: "003.001" type: - default: channel.frozen + default: call.stats_report_ready + description: The type of event, "call.report_ready" in this case + title: Event Type type: string x-stream-index: "001.001" required: - type - created_at - - cid - - channel_id - - channel_type - title: ChannelFrozenEvent + - call_cid + - session_id + title: CallStatsReportReadyEvent type: object - x-stream-event-client-type: true + x-stream-event-call-type: true x-stream-event-doc-group: other x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - ChannelGetOrCreateRequest: - nullable: true - properties: - data: - $ref: '#/components/schemas/ChannelInput' - x-stream-index: "003" - hide_for_creator: - description: Whether this channel will be hidden for the user who created - the channel or not - title: Hide for creator - type: boolean - x-stream-index: "007" - members: - $ref: '#/components/schemas/PaginationParams' - x-stream-index: "010" - messages: - $ref: '#/components/schemas/MessagePaginationParams' - x-stream-index: "009" - presence: - description: Fetch user presence info - title: Presence - type: boolean - x-stream-index: "006" - state: - description: Refresh channel state - title: State - type: boolean - x-stream-index: "005" - thread_unread_counts: - type: boolean - x-stream-index: "008" - watch: - description: Start watching the channel - title: Watch - type: boolean - x-stream-index: "004" - watchers: - $ref: '#/components/schemas/PaginationParams' - x-stream-index: "011" - type: object - ChannelHiddenEvent: + CallStatsReportSummaryResponse: properties: - channel: - $ref: '#/components/schemas/ChannelResponse' - x-stream-index: "003.004" - channel_id: + call_cid: type: string - x-stream-index: "003.002" - channel_member_count: + x-stream-index: "001" + call_duration_seconds: format: int32 type: integer - x-stream-index: "003.005" - channel_type: + x-stream-index: "008" + call_session_id: type: string - x-stream-index: "003.003" - cid: + x-stream-index: "002" + call_status: + type: string + x-stream-index: "004" + created_at: + format: date-time + type: number + x-stream-index: "007" + first_stats_time: + format: date-time + type: number + x-stream-index: "003" + min_user_rating: + format: int32 + type: integer + x-stream-index: "006" + quality_score: + format: int32 + type: integer + x-stream-index: "005" + required: + - call_cid + - call_session_id + - first_stats_time + - call_status + - call_duration_seconds + type: object + CallTranscription: + description: CallTranscription represents a transcription of a call. + properties: + end_time: + format: date-time + title: The end time of the transcription. + type: number + x-stream-index: "004" + filename: + title: The filename of the transcription. type: string - x-stream-index: "003.001" - clear_history: - type: boolean x-stream-index: "001" + session_id: + title: The session ID of the transcription. + type: string + x-stream-index: "005" + start_time: + format: date-time + title: The start time of the transcription. + type: number + x-stream-index: "003" + url: + title: The URL of the transcription. + type: string + x-stream-index: "002" + required: + - filename + - url + - start_time + - end_time + - session_id + title: CallTranscription + type: object + CallTranscriptionFailedEvent: + description: This event is sent when call transcription has failed + properties: + call_cid: + type: string + x-stream-index: "002.001" created_at: format: date-time type: number - x-stream-index: "004.002" + x-stream-index: "001.002" + egress_id: + type: string + x-stream-index: "003" + error: + description: The error message detailing why transcription failed. + title: string + type: string + x-stream-index: "004" type: - default: channel.hidden + default: call.transcription_failed + description: 'The type of event: "call.transcription_failed" in this case' + title: Event Type type: string - x-stream-index: "004.001" - user: - $ref: '#/components/schemas/User' - x-stream-index: "002.001" + x-stream-index: "001.001" required: - - clear_history - - cid - - channel_id - - channel_type - - channel_member_count - type - created_at - title: ChannelHiddenEvent + - call_cid + - egress_id + title: CallTranscriptionFailedEvent type: object - x-stream-event-client-type: true - x-stream-event-doc-group: other + x-stream-event-call-type: true + x-stream-event-doc-group: transcription x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - ChannelInput: + CallTranscriptionReadyEvent: + description: This event is sent when call transcription is ready properties: - auto_translation_enabled: - description: Enable or disable auto translation - title: Auto translation - type: boolean - x-stream-index: "005" - auto_translation_language: - description: Switch auto translation language - title: Auto translation language - type: string - x-stream-index: "006" - config_overrides: - $ref: '#/components/schemas/ChannelConfig' - x-stream-index: "024" - created_by: - $ref: '#/components/schemas/UserRequest' - x-stream-index: "009" - created_by_id: + call_cid: type: string - x-stream-index: "008" - custom: - additionalProperties: {} - type: object - x-stream-index: "015" - disabled: - type: boolean - x-stream-index: "014" - frozen: - description: Freeze or unfreeze the channel - title: Frozen - type: boolean - x-stream-index: "013" - invites: - items: - $ref: '#/components/schemas/ChannelMember' - maximum: 100 - type: array - x-stream-index: "016" - members: - items: - $ref: '#/components/schemas/ChannelMember' - maximum: 100 - type: array - x-stream-index: "018" - team: - description: Team the channel belongs to (if multi-tenant mode is enabled) - title: Team + x-stream-index: "002.001" + call_transcription: + $ref: '#/components/schemas/CallTranscription' + description: The call transcription object + title: CallTranscription + x-stream-index: "003" + created_at: + format: date-time + type: number + x-stream-index: "001.002" + egress_id: type: string x-stream-index: "004" - truncated_by_id: + type: + default: call.transcription_ready + description: 'The type of event: "call.transcription_ready" in this case' + title: Event Type type: string - x-stream-index: "010" + x-stream-index: "001.001" + required: + - type + - created_at + - call_cid + - call_transcription + - egress_id + title: CallTranscriptionReadyEvent type: object - ChannelKickedEvent: + x-stream-event-call-type: true + x-stream-event-doc-group: transcription + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + CallTranscriptionStartedEvent: + description: This event is sent when call transcription has started properties: - channel: - $ref: '#/components/schemas/ChannelResponse' - x-stream-index: "002.004" - channel_id: + call_cid: type: string + x-stream-index: "003.001" + created_at: + format: date-time + type: number x-stream-index: "002.002" - channel_member_count: - format: int32 - type: integer - x-stream-index: "002.005" - channel_type: + egress_id: type: string - x-stream-index: "002.003" - cid: + x-stream-index: "001" + type: + default: call.transcription_started + description: 'The type of event: "call.transcription_started" in this case' + title: Event Type + type: string + x-stream-index: "002.001" + required: + - egress_id + - type + - created_at + - call_cid + title: CallTranscriptionStartedEvent + type: object + x-stream-event-call-type: true + x-stream-event-doc-group: transcription + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + CallTranscriptionStoppedEvent: + description: This event is sent when call transcription has stopped + properties: + call_cid: type: string x-stream-index: "002.001" created_at: format: date-time type: number x-stream-index: "001.002" + egress_id: + type: string + x-stream-index: "003" type: - default: channel.kicked + default: call.transcription_stopped + description: 'The type of event: "call.transcription_stopped" in this case' + title: Event Type type: string x-stream-index: "001.001" required: - type - created_at - - cid - - channel_id - - channel_type - - channel_member_count - title: ChannelKickedEvent + - call_cid + - egress_id + title: CallTranscriptionStoppedEvent type: object - x-stream-event-client-type: true - x-stream-event-doc-group: other + x-stream-event-call-type: true + x-stream-event-doc-group: transcription x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - ChannelMember: - nullable: true + CallType: properties: - archived_at: + AppPK: + format: int32 + type: integer + writeOnly: true + x-stream-index: "003" + CreatedAt: format: date-time type: number - x-stream-index: "015" - ban_expires: - description: Expiration date of the ban - format: date-time - title: Ban expires - type: number - x-stream-index: "013" - banned: - description: Whether member is banned this channel or not - title: Banned - type: boolean - x-stream-index: "012" - channel_role: - description: Role of the member in the channel - title: Channel Role + writeOnly: true + x-stream-index: "005" + ExternalStorage: type: string - x-stream-index: "018" - created_at: - description: Date/time of creation - format: date-time - title: Created at - type: number + writeOnly: true x-stream-index: "009" - custom: - additionalProperties: {} - type: object + Name: + type: string + writeOnly: true x-stream-index: "004" - deleted_at: - format: date-time - type: number - x-stream-index: "011" - invite_accepted_at: - description: Date when invite was accepted + NotificationSettings: + $ref: '#/components/schemas/NotificationSettings' + x-stream-index: "008" + PK: + format: int32 + type: integer + writeOnly: true + x-stream-index: "002" + Settings: + $ref: '#/components/schemas/CallSettings' + x-stream-index: "007" + UpdatedAt: format: date-time - title: Invited accepted at type: number + writeOnly: true x-stream-index: "006" - invite_rejected_at: - description: Date when invite was rejected - format: date-time - title: Invited rejected at - type: number - x-stream-index: "007" - invited: - description: Whether member was invited or not - title: Invited - type: boolean - x-stream-index: "005" - is_moderator: - description: Whether member is channel moderator or not - title: Is moderator - type: boolean + required: + - PK + - AppPK + - Name + - CreatedAt + - UpdatedAt + - ExternalStorage + type: object + CallUpdatedEvent: + description: |- + This event is sent when a call is updated, clients should use this update the local state of the call. + This event also contains the capabilities by role for the call, clients should update the own_capability for the current. + properties: + call: + $ref: '#/components/schemas/CallResponse' + description: Call object + title: Call x-stream-index: "003" - notifications_muted: - type: boolean - x-stream-index: "019" - pinned_at: - format: date-time - type: number - x-stream-index: "016" - role: - description: 'Permission level of the member in the channel (DEPRECATED: - use channel_role instead)' - enum: - - member - - moderator - - admin - - owner - title: Role - type: string - x-stream-index: "017" - shadow_banned: - description: Whether member is shadow banned in this channel or not - title: Shadow banned - type: boolean - x-stream-index: "014" - status: + call_cid: type: string - x-stream-index: "008" - updated_at: - description: Date/time of the last update + x-stream-index: "002.001" + capabilities_by_role: + additionalProperties: + items: + type: string + type: array + description: The capabilities by role for this call + title: CapabilitiesByRole + type: object + x-stream-index: "004" + created_at: format: date-time - title: Updated at type: number - x-stream-index: "010" - user: - $ref: '#/components/schemas/UserResponse' - x-stream-index: "002" - user_id: - title: User ID + x-stream-index: "001.002" + type: + default: call.updated + description: 'The type of event: "call.updated" in this case' + title: Event Type type: string - x-stream-index: "001" + x-stream-index: "001.001" required: - - custom + - type - created_at - - updated_at - - banned - - shadow_banned - - channel_role - - notifications_muted - title: Channel member + - call_cid + - call + - capabilities_by_role + title: CallUpdatedEvent type: object - ChannelMemberResponse: - nullable: true + x-stream-event-call-type: true + x-stream-event-doc-group: call + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + CallUserFeedbackSubmittedEvent: + description: This event is sent when a user submits feedback for a call. properties: - archived_at: - format: date-time - type: number - x-stream-index: "016" - ban_expires: - description: Expiration date of the ban - format: date-time - title: Ban expires - type: number - x-stream-index: "013" - banned: - description: Whether member is banned this channel or not - title: Banned - type: boolean - x-stream-index: "012" - channel_role: - description: Role of the member in the channel - title: Channel Role + call_cid: type: string - x-stream-index: "018" + x-stream-index: "002.001" created_at: - description: Date/time of creation format: date-time - title: Created at type: number - x-stream-index: "009" + x-stream-index: "001.002" custom: additionalProperties: {} + description: Custom data provided by the user + title: Custom type: object - x-stream-index: "004" - deleted_at: - format: date-time - type: number - x-stream-index: "011" - invite_accepted_at: - description: Date when invite was accepted - format: date-time - title: Invited accepted at - type: number - x-stream-index: "006" - invite_rejected_at: - description: Date when invite was rejected - format: date-time - title: Invited rejected at - type: number x-stream-index: "007" - invited: - description: Whether member was invited or not - title: Invited - type: boolean + rating: + description: The rating given by the user (1-5) + format: int32 + title: Rating + type: integer x-stream-index: "005" - is_moderator: - description: Whether member is channel moderator or not - title: Is moderator - type: boolean - x-stream-index: "003" - notifications_muted: - type: boolean - x-stream-index: "019" - pinned_at: - format: date-time - type: number - x-stream-index: "015" - role: - description: 'Permission level of the member in the channel (DEPRECATED: - use channel_role instead)' - enum: - - member - - moderator - - admin - - owner - title: Role + reason: + description: The reason provided by the user for the rating + title: Reason type: string - x-stream-index: "017" - shadow_banned: - description: Whether member is shadow banned in this channel or not - title: Shadow banned - type: boolean - x-stream-index: "014" - status: + x-stream-index: "006" + sdk: type: string x-stream-index: "008" - updated_at: - description: Date/time of the last update - format: date-time - title: Updated at - type: number - x-stream-index: "010" - user: - $ref: '#/components/schemas/UserResponse' - x-stream-index: "002" - user_id: - title: User ID + sdk_version: type: string - x-stream-index: "001" - required: - - custom - - created_at - - updated_at - - banned - - shadow_banned - - channel_role - - notifications_muted - title: Channel member + x-stream-index: "009" + session_id: + description: Call session ID + title: Session ID + type: string + x-stream-index: "003.001" + type: + default: call.user_feedback_submitted + description: The type of event, "call.user_feedback" in this case + title: Event Type + type: string + x-stream-index: "001.001" + user: + $ref: '#/components/schemas/UserResponse' + description: The user who submitted the feedback + title: User + x-stream-index: "004" + required: + - type + - created_at + - call_cid + - session_id + - user + - rating + title: CallUserFeedbackSubmittedEvent type: object - ChannelMute: - nullable: true + x-stream-event-call-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + CallUserMutedEvent: + description: This event is sent when a call member is muted properties: - channel: - $ref: '#/components/schemas/ChannelResponse' - description: Channel that is muted - title: Channel - x-stream-index: "002" + call_cid: + type: string + x-stream-index: "002.001" created_at: - description: Date/time of creation - format: date-time - title: Created at - type: number - x-stream-index: "004" - expires: - description: Date/time of mute expiration format: date-time - title: Expires type: number + x-stream-index: "001.002" + from_user_id: + type: string x-stream-index: "003" - updated_at: - description: Date/time of the last update - format: date-time - title: Updated at - type: number - x-stream-index: "005" - user: - $ref: '#/components/schemas/UserResponse' - description: Owner of channel mute - title: User - x-stream-index: "001" + muted_user_ids: + items: + type: string + type: array + x-stream-index: "004" + type: + default: call.user_muted + description: 'The type of event: "call.user_muted" in this case' + title: Event Type + type: string + x-stream-index: "001.001" required: + - type - created_at - - updated_at + - call_cid + - from_user_id + - muted_user_ids + title: CallUserMutedEvent type: object - ChannelOwnCapability: - description: All possibility of string to use - enum: - - ban-channel-members - - cast-poll-vote - - connect-events - - create-attachment - - delete-any-message - - delete-channel - - delete-own-message - - flag-message - - freeze-channel - - join-channel - - leave-channel - - mute-channel - - pin-message - - query-poll-votes - - quote-message - - read-events - - search-messages - - send-custom-events - - send-links - - send-message - - send-poll - - send-reaction - - send-reply - - send-restricted-visibility-message - - send-typing-events - - set-channel-cooldown - - share-location - - skip-slow-mode - - slow-mode - - typing-events - - update-any-message - - update-channel - - update-channel-members - - update-own-message - - update-thread - - upload-file - title: ChannelOwnCapability - type: string - ChannelPushPreferences: + x-stream-event-call-type: true + x-stream-event-doc-group: call + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + CallsPerDayReport: properties: - chat_level: - type: string + count: + format: int64 + type: integer x-stream-index: "001" - disabled_until: - format: date-time - type: number - x-stream-index: "002" + required: + - count type: object - ChannelResponse: - description: Represents channel in chat + CallsPerDayReportResponse: + properties: + daily: + items: + $ref: '#/components/schemas/DailyAggregateCallsPerDayReportResponse' + type: array + x-stream-index: "001" + required: + - daily + type: object + CastPollVoteRequest: + nullable: true + properties: + vote: + $ref: '#/components/schemas/VoteData' + description: Vote data + title: VoteData + x-stream-index: "004" + type: object + Channel: properties: + active_live_locations: + items: + $ref: '#/components/schemas/SharedLocation' + type: array + x-stream-index: "034" auto_translation_enabled: - description: Whether auto translation is enabled or not - title: Auto translation type: boolean - x-stream-index: "017" + x-stream-index: "029" auto_translation_language: - description: Language to translate to when auto translation is active - title: Auto translation language type: string - x-stream-index: "018" - blocked: - description: Whether this channel is blocked by current user or not - title: Blocked - type: boolean - x-stream-index: "023" + x-stream-index: "030" cid: - description: Channel CID (:) - title: CID type: string x-stream-index: "003" config: - $ref: '#/components/schemas/ChannelConfigWithInfo' - description: Channel configuration - title: ChannelConfigWithInfo - x-stream-index: "013" + $ref: '#/components/schemas/ChannelConfig' + x-stream-index: "026" + config_overrides: + $ref: '#/components/schemas/ConfigOverrides' + x-stream-index: "027" cooldown: - description: Cooldown period after sending each message format: int32 - title: Cooldown type: integer - x-stream-index: "020" + x-stream-index: "031" created_at: - description: Date/time of creation format: date-time - title: Created at type: number - x-stream-index: "005" + x-stream-index: "009" created_by: - $ref: '#/components/schemas/UserResponse' - description: Creator of the channel - title: UserResponse + $ref: '#/components/schemas/User' x-stream-index: "008" custom: additionalProperties: {} - description: Custom data for this object - title: Custom data type: object - x-stream-index: "026" + x-stream-index: "019" deleted_at: - description: Date/time of deletion format: date-time - title: Deleted at type: number - x-stream-index: "007" + x-stream-index: "011" disabled: type: boolean - x-stream-index: "010" + x-stream-index: "017" frozen: - description: Whether channel is frozen or not - title: Frozen - type: boolean - x-stream-index: "009" - hidden: - description: Whether this channel is hidden by current user or not - title: Hidden type: boolean - x-stream-index: "022" - hide_messages_before: - description: Date since when the message history is accessible - format: date-time - title: Hide messages before - type: number - x-stream-index: "019" + x-stream-index: "016" id: - description: Channel unique ID - title: ID type: string - x-stream-index: "001" + x-stream-index: "004" + invites: + items: + $ref: '#/components/schemas/ChannelMember' + type: array + x-stream-index: "022" + last_campaigns: + type: string + x-stream-index: "032" last_message_at: - description: Date of the last message sent format: date-time - title: Last message at type: number - x-stream-index: "004" + x-stream-index: "006" member_count: - description: Number of members in the channel format: int32 - title: Member count type: integer - x-stream-index: "012" + x-stream-index: "021" members: - description: List of channel members (max 100) items: $ref: '#/components/schemas/ChannelMember' - title: ChannelMembers type: array - x-stream-index: "011" - mute_expires_at: - description: Date of mute expiration - format: date-time - title: Mute expires at + x-stream-index: "020" + message_count: + format: int64 + type: integer + x-stream-index: "035" + message_count_updated_at: + format: date-time type: number - x-stream-index: "015" - muted: - description: Whether this channel is muted or not - title: Muted - type: boolean - x-stream-index: "014" - own_capabilities: - description: List of channel capabilities of authenticated user - items: - $ref: '#/components/schemas/ChannelOwnCapability' - title: ChannelOwnCapability - type: array - x-stream-index: "021" + x-stream-index: "036" team: - description: Team the channel belongs to (multi-tenant only) - title: Team type: string - x-stream-index: "016" - truncated_at: - description: Date of the latest truncation of the channel - format: date-time - title: UserResponse - type: number - x-stream-index: "024" + x-stream-index: "028" truncated_by: - $ref: '#/components/schemas/UserResponse' - x-stream-index: "025" + $ref: '#/components/schemas/User' + x-stream-index: "015" type: - description: Type of the channel - title: Type type: string - x-stream-docs-page-id: channel_features - x-stream-index: "002" + x-stream-index: "005" updated_at: - description: Date/time of the last update format: date-time - title: Updated at type: number - x-stream-index: "006" + x-stream-index: "010" required: + - cid - id - type - - cid - created_at - updated_at - frozen - disabled - custom - title: Channel + - auto_translation_language type: object - ChannelStateResponse: - nullable: true + ChannelConfig: properties: - active_live_locations: + allowed_flag_reasons: items: - $ref: '#/components/schemas/SharedLocationResponseData' + type: string type: array - x-stream-index: "001.015" - channel: - $ref: '#/components/schemas/ChannelResponse' - x-stream-index: "001.001" - draft: - $ref: '#/components/schemas/DraftResponse' - x-stream-index: "001.014" - duration: + x-stream-index: "001.027" + automod: + enum: + - disabled + - simple + - AI type: string - x-stream-index: "002.001" - hidden: - type: boolean - x-stream-index: "001.011" - hide_messages_before: - format: date-time - type: number - x-stream-index: "001.012" - members: - items: - $ref: '#/components/schemas/ChannelMember' - type: array - x-stream-index: "001.007" - membership: - $ref: '#/components/schemas/ChannelMember' - x-stream-index: "001.008" - messages: - items: - $ref: '#/components/schemas/MessageResponse' - type: array - x-stream-index: "001.002" - pending_messages: + x-stream-index: "001.022" + automod_behavior: + enum: + - flag + - block + - shadow_block + type: string + x-stream-index: "001.023" + automod_thresholds: + $ref: '#/components/schemas/Thresholds' + x-stream-index: "001.028" + blocklist: + type: string + x-stream-index: "001.024" + blocklist_behavior: + enum: + - flag + - block + - shadow_block + type: string + x-stream-index: "001.025" + blocklists: items: - $ref: '#/components/schemas/PendingMessageResponse' + $ref: '#/components/schemas/BlockListOptions' type: array - x-stream-index: "001.013" - pinned_messages: + x-stream-index: "001.026" + commands: items: - $ref: '#/components/schemas/MessageResponse' + type: string type: array - x-stream-index: "001.003" - push_preferences: - $ref: '#/components/schemas/ChannelPushPreferences' + x-stream-index: "003" + connect_events: + type: boolean + x-stream-index: "001.004" + count_messages: + type: boolean + x-stream-index: "001.019" + created_at: + format: date-time + type: number + x-stream-index: "002.003" + custom_events: + type: boolean + x-stream-index: "001.012" + mark_messages_pending: + type: boolean + x-stream-index: "001.015" + max_message_length: + format: int32 + maximum: 20000 + type: integer + x-stream-index: "001.021" + mutes: + type: boolean x-stream-index: "001.009" - read: - items: - $ref: '#/components/schemas/ReadStateResponse' - type: array - x-stream-index: "001.006" - threads: - items: - $ref: '#/components/schemas/ThreadStateResponse' - type: array - x-stream-index: "001.010" - watcher_count: + name: + type: string + x-stream-index: "001.001" + partition_size: format: int32 type: integer - x-stream-index: "001.004" - watchers: - items: - $ref: '#/components/schemas/UserResponse' - type: array + x-stream-index: "001.029" + partition_ttl: + type: integer + x-stream-index: "001.030" + polls: + type: boolean + x-stream-index: "001.016" + push_notifications: + type: boolean + x-stream-index: "001.013" + quotes: + type: boolean + x-stream-index: "001.008" + reactions: + type: boolean + x-stream-index: "001.006" + read_events: + type: boolean + x-stream-index: "001.003" + reminders: + type: boolean + x-stream-index: "001.014" + replies: + type: boolean + x-stream-index: "001.007" + search: + type: boolean x-stream-index: "001.005" + shared_locations: + type: boolean + x-stream-index: "001.018" + skip_last_msg_update_for_system_msgs: + type: boolean + x-stream-index: "001.031" + typing_events: + type: boolean + x-stream-index: "001.002" + updated_at: + format: date-time + type: number + x-stream-index: "002.004" + uploads: + type: boolean + x-stream-index: "001.010" + url_enrichment: + type: boolean + x-stream-index: "001.011" + user_message_reminders: + type: boolean + x-stream-index: "001.017" required: - - messages - - pinned_messages - - members - - threads - - duration + - name + - typing_events + - read_events + - connect_events + - search + - reactions + - replies + - quotes + - mutes + - uploads + - url_enrichment + - custom_events + - push_notifications + - reminders + - mark_messages_pending + - polls + - user_message_reminders + - shared_locations + - count_messages + - message_retention + - max_message_length + - automod + - automod_behavior + - skip_last_msg_update_for_system_msgs + - created_at + - updated_at + - commands type: object - ChannelStateResponseFields: + ChannelConfigWithInfo: properties: - active_live_locations: - description: Active live locations in the channel + allowed_flag_reasons: items: - $ref: '#/components/schemas/SharedLocationResponseData' - title: Active Live Locations + type: string type: array - x-stream-index: "015" - channel: - $ref: '#/components/schemas/ChannelResponse' - x-stream-index: "001" - draft: - $ref: '#/components/schemas/DraftResponse' - x-stream-index: "014" - hidden: - description: Whether this channel is hidden or not - title: Hidden - type: boolean - x-stream-index: "011" - hide_messages_before: - description: Messages before this date are hidden from the user - format: date-time - title: Hide messages before - type: number - x-stream-index: "012" - members: - description: List of channel members + x-stream-index: 001.002.027 + automod: + enum: + - disabled + - simple + - AI + type: string + x-stream-index: 001.002.022 + automod_behavior: + enum: + - flag + - block + - shadow_block + type: string + x-stream-index: 001.002.023 + automod_thresholds: + $ref: '#/components/schemas/Thresholds' + x-stream-index: 001.002.028 + blocklist: + type: string + x-stream-index: 001.002.024 + blocklist_behavior: + enum: + - flag + - block + - shadow_block + type: string + x-stream-index: 001.002.025 + blocklists: items: - $ref: '#/components/schemas/ChannelMember' - title: Members + $ref: '#/components/schemas/BlockListOptions' type: array - x-stream-index: "007" - membership: - $ref: '#/components/schemas/ChannelMember' - description: Current user membership object - title: Membership - x-stream-index: "008" - messages: - description: List of channel messages + x-stream-index: 001.002.026 + commands: items: - $ref: '#/components/schemas/MessageResponse' - title: Message + $ref: '#/components/schemas/Command' type: array + x-stream-index: "001.003" + connect_events: + type: boolean + x-stream-index: 001.002.004 + count_messages: + type: boolean + x-stream-index: 001.002.019 + created_at: + format: date-time + type: number + x-stream-index: 001.001.003 + custom_events: + type: boolean + x-stream-index: 001.002.012 + grants: + additionalProperties: + items: + type: string + type: array + type: object x-stream-index: "002" - pending_messages: - description: Pending messages that this user has sent - items: - $ref: '#/components/schemas/PendingMessageResponse' - title: Pending messages - type: array - x-stream-index: "013" - pinned_messages: - description: List of pinned messages in the channel - items: - $ref: '#/components/schemas/MessageResponse' - title: Pinned messages - type: array - x-stream-docs-page-id: pinned_messages - x-stream-index: "003" - push_preferences: - $ref: '#/components/schemas/ChannelPushPreferences' - x-stream-index: "009" - read: - description: List of read states - items: - $ref: '#/components/schemas/ReadStateResponse' - title: Read - type: array - x-stream-index: "006" - threads: - items: - $ref: '#/components/schemas/ThreadStateResponse' - type: array - x-stream-index: "010" - watcher_count: - description: Number of channel watchers + mark_messages_pending: + type: boolean + x-stream-index: 001.002.015 + max_message_length: format: int32 - title: Watcher count + maximum: 20000 type: integer - x-stream-index: "004" - watchers: - description: List of user who is watching the channel - items: - $ref: '#/components/schemas/UserResponse' - title: Watchers - type: array - x-stream-index: "005" + x-stream-index: 001.002.021 + mutes: + type: boolean + x-stream-index: 001.002.009 + name: + type: string + x-stream-index: 001.002.001 + partition_size: + format: int32 + type: integer + x-stream-index: 001.002.029 + partition_ttl: + example: 24h + format: duration + nullable: true + type: string + x-stream-index: 001.002.030 + polls: + type: boolean + x-stream-index: 001.002.016 + push_notifications: + type: boolean + x-stream-index: 001.002.013 + quotes: + type: boolean + x-stream-index: 001.002.008 + reactions: + type: boolean + x-stream-index: 001.002.006 + read_events: + type: boolean + x-stream-index: 001.002.003 + reminders: + type: boolean + x-stream-index: 001.002.014 + replies: + type: boolean + x-stream-index: 001.002.007 + search: + type: boolean + x-stream-index: 001.002.005 + shared_locations: + type: boolean + x-stream-index: 001.002.018 + skip_last_msg_update_for_system_msgs: + type: boolean + x-stream-index: 001.002.031 + typing_events: + type: boolean + x-stream-index: 001.002.002 + updated_at: + format: date-time + type: number + x-stream-index: 001.001.004 + uploads: + type: boolean + x-stream-index: 001.002.010 + url_enrichment: + type: boolean + x-stream-index: 001.002.011 + user_message_reminders: + type: boolean + x-stream-index: 001.002.017 required: - - messages - - pinned_messages - - members - - threads + - created_at + - updated_at + - name + - typing_events + - read_events + - connect_events + - search + - reactions + - replies + - quotes + - mutes + - uploads + - url_enrichment + - custom_events + - push_notifications + - reminders + - mark_messages_pending + - polls + - user_message_reminders + - shared_locations + - count_messages + - message_retention + - max_message_length + - automod + - automod_behavior + - skip_last_msg_update_for_system_msgs + - commands type: object - ChannelStopWatchingRequest: - nullable: true + ChannelCreatedEvent: + properties: + created_at: + format: date-time + type: number + x-stream-index: "001.002" + type: + default: channel.created + type: string + x-stream-index: "001.001" + required: + - type + - created_at + title: ChannelCreatedEvent type: object - ChannelTruncatedEvent: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + ChannelDeletedEvent: properties: channel: $ref: '#/components/schemas/ChannelResponse' - x-stream-index: "001.004" + x-stream-index: "003.004" channel_id: type: string - x-stream-index: "001.002" + x-stream-index: "003.002" channel_member_count: format: int32 type: integer - x-stream-index: "001.005" + x-stream-index: "003.005" channel_type: type: string - x-stream-index: "001.003" + x-stream-index: "003.003" cid: type: string - x-stream-index: "001.001" + x-stream-index: "003.001" created_at: format: date-time type: number x-stream-index: "002.002" + team: + type: string + x-stream-index: "001.001" type: - default: channel.truncated + default: channel.deleted type: string x-stream-index: "002.001" required: + - type + - created_at - cid - channel_id - channel_type - channel_member_count - - type - - created_at - title: ChannelTruncatedEvent + title: ChannelDeletedEvent 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 - ChannelUnFrozenEvent: + ChannelFrozenEvent: properties: channel_id: type: string @@ -5814,7 +6823,7 @@ components: type: number x-stream-index: "001.002" type: - default: channel.unfrozen + default: channel.frozen type: string x-stream-index: "001.001" required: @@ -5823,2618 +6832,2569 @@ components: - cid - channel_id - channel_type - title: ChannelUnFrozenEvent + title: ChannelFrozenEvent 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 - ChannelUpdatedEvent: + ChannelGetOrCreateRequest: + nullable: true + properties: + data: + $ref: '#/components/schemas/ChannelInput' + x-stream-index: "003" + hide_for_creator: + description: Whether this channel will be hidden for the user who created + the channel or not + title: Hide for creator + type: boolean + x-stream-index: "007" + members: + $ref: '#/components/schemas/PaginationParams' + x-stream-index: "010" + messages: + $ref: '#/components/schemas/MessagePaginationParams' + x-stream-index: "009" + presence: + description: Fetch user presence info + title: Presence + type: boolean + x-stream-index: "006" + state: + description: Refresh channel state + title: State + type: boolean + x-stream-index: "005" + thread_unread_counts: + type: boolean + x-stream-index: "008" + watch: + description: Start watching the channel + title: Watch + type: boolean + x-stream-index: "004" + watchers: + $ref: '#/components/schemas/PaginationParams' + x-stream-index: "011" + type: object + ChannelHiddenEvent: properties: channel: $ref: '#/components/schemas/ChannelResponse' - x-stream-index: "004.004" + x-stream-index: "003.004" channel_id: type: string - x-stream-index: "004.002" + x-stream-index: "003.002" channel_member_count: format: int32 type: integer - x-stream-index: "004.005" + x-stream-index: "003.005" channel_type: type: string - x-stream-index: "004.003" + x-stream-index: "003.003" cid: type: string - x-stream-index: "004.001" + x-stream-index: "003.001" + clear_history: + type: boolean + x-stream-index: "001" created_at: format: date-time type: number - x-stream-index: "003.002" - message: - $ref: '#/components/schemas/Message' - x-stream-index: "001" - team: - type: string - x-stream-index: "002.001" + x-stream-index: "004.002" type: - default: channel.updated + default: channel.hidden type: string - x-stream-index: "003.001" + x-stream-index: "004.001" user: $ref: '#/components/schemas/User' - x-stream-index: "005.001" + x-stream-index: "002.001" required: - - type - - created_at + - clear_history - cid - channel_id - channel_type - channel_member_count - title: ChannelUpdatedEvent + - type + - created_at + title: ChannelHiddenEvent 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 - ChannelVisibleEvent: + ChannelInput: + properties: + auto_translation_enabled: + description: Enable or disable auto translation + title: Auto translation + type: boolean + x-stream-index: "005" + auto_translation_language: + description: Switch auto translation language + title: Auto translation language + type: string + x-stream-index: "006" + config_overrides: + $ref: '#/components/schemas/ChannelConfig' + x-stream-index: "024" + created_by: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "009" + created_by_id: + type: string + x-stream-index: "008" + custom: + additionalProperties: {} + type: object + x-stream-index: "015" + disabled: + type: boolean + x-stream-index: "014" + frozen: + description: Freeze or unfreeze the channel + title: Frozen + type: boolean + x-stream-index: "013" + invites: + items: + $ref: '#/components/schemas/ChannelMember' + maximum: 100 + type: array + x-stream-index: "016" + members: + items: + $ref: '#/components/schemas/ChannelMember' + maximum: 100 + type: array + x-stream-index: "018" + team: + description: Team the channel belongs to (if multi-tenant mode is enabled) + title: Team + type: string + x-stream-index: "004" + truncated_by_id: + type: string + x-stream-index: "010" + type: object + ChannelKickedEvent: properties: + channel: + $ref: '#/components/schemas/ChannelResponse' + x-stream-index: "002.004" channel_id: type: string - x-stream-index: "001.002" + x-stream-index: "002.002" + channel_member_count: + format: int32 + type: integer + x-stream-index: "002.005" channel_type: type: string - x-stream-index: "001.003" + x-stream-index: "002.003" cid: type: string - x-stream-index: "001.001" + x-stream-index: "002.001" created_at: format: date-time type: number - x-stream-index: "003.002" + x-stream-index: "001.002" type: - default: channel.visible + default: channel.kicked type: string - x-stream-index: "003.001" - user: - $ref: '#/components/schemas/User' - x-stream-index: "002.001" + x-stream-index: "001.001" required: + - type + - created_at - cid - channel_id - channel_type - - type - - created_at - title: ChannelVisibleEvent + - channel_member_count + title: ChannelKickedEvent 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 - ChatActivityStatsResponse: - properties: - Messages: - $ref: '#/components/schemas/MessageStatsResponse' - x-stream-index: "001" - type: object - ClosedCaptionEvent: - description: This event is sent when closed captions are being sent in a call, - clients should use this to show the closed captions in the call screen + ChannelMember: + nullable: true properties: - call_cid: + archived_at: + format: date-time + type: number + x-stream-index: "015" + ban_expires: + description: Expiration date of the ban + format: date-time + title: Ban expires + type: number + x-stream-index: "013" + banned: + description: Whether member is banned this channel or not + title: Banned + type: boolean + x-stream-index: "012" + channel_role: + description: Role of the member in the channel + title: Channel Role type: string - x-stream-index: "002.001" - closed_caption: - $ref: '#/components/schemas/CallClosedCaption' - description: The closed caption object - title: CallClosedCaption - x-stream-index: "003" + x-stream-index: "018" created_at: + description: Date/time of creation format: date-time + title: Created at type: number - x-stream-index: "001.002" - type: - default: call.closed_caption - description: 'The type of event: "call.closed_caption" in this case' - title: Event Type - type: string - x-stream-index: "001.001" - required: - - type - - created_at - - call_cid - - closed_caption - title: ClosedCaptionEvent - type: object - x-stream-event-call-type: true - x-stream-event-doc-group: transcription - x-stream-is-event: true - x-stream-ws-base-event-name: VideoEvent - CollectUserFeedbackRequest: - nullable: true - properties: + x-stream-index: "009" custom: additionalProperties: {} type: object - x-stream-index: "009" - rating: - format: int32 - maximum: 5 - minimum: 1 - type: integer - x-stream-index: "007" - reason: - maxLength: 1000 - type: string - x-stream-index: "008" - sdk: - maxLength: 50 - type: string - x-stream-index: "005" - sdk_version: - maxLength: 50 - type: string - x-stream-index: "006" - user_session_id: - maxLength: 50 - type: string x-stream-index: "004" - required: - - sdk - - sdk_version - - rating - type: object - CollectUserFeedbackResponse: - 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 - Command: - description: Represents custom chat command - nullable: true - properties: - args: - description: Arguments help text, shown in commands auto-completion - title: Arguments - type: string + deleted_at: + format: date-time + type: number + x-stream-index: "011" + deleted_messages: + items: + type: string + type: array + x-stream-index: "020" + invite_accepted_at: + description: Date when invite was accepted + format: date-time + title: Invited accepted at + type: number x-stream-index: "006" - created_at: - description: Date/time of creation + invite_rejected_at: + description: Date when invite was rejected format: date-time - readOnly: true - title: Created at + title: Invited rejected at type: number - x-stream-index: "001" - description: - description: Description, shown in commands auto-completion - title: Description - type: string + x-stream-index: "007" + invited: + description: Whether member was invited or not + title: Invited + type: boolean x-stream-index: "005" - name: - description: Unique command name - title: Name + is_moderator: + description: Whether member is channel moderator or not + title: Is moderator + type: boolean + x-stream-index: "003" + notifications_muted: + type: boolean + x-stream-index: "019" + pinned_at: + format: date-time + type: number + x-stream-index: "016" + role: + description: 'Permission level of the member in the channel (DEPRECATED: + use channel_role instead)' + enum: + - member + - moderator + - admin + - owner + title: Role type: string - x-stream-index: "004" - set: - description: Set name used for grouping commands - title: Set + x-stream-index: "017" + shadow_banned: + description: Whether member is shadow banned in this channel or not + title: Shadow banned + type: boolean + x-stream-index: "014" + status: type: string - x-stream-index: "007" + x-stream-index: "008" updated_at: description: Date/time of the last update format: date-time - readOnly: true title: Updated at type: number + x-stream-index: "010" + user: + $ref: '#/components/schemas/UserResponse' x-stream-index: "002" - required: - - name - - description - - args - - set - title: Command - type: object - CompositeAppSettings: - properties: - json_encoded_settings: - type: string - x-stream-index: "005" - url: + user_id: + title: User ID type: string - x-stream-index: "004" + x-stream-index: "001" + required: + - custom + - created_at + - updated_at + - banned + - shadow_banned + - channel_role + - notifications_muted + title: Channel member type: object - ConfigOverrides: + ChannelMemberResponse: + nullable: true properties: - blocklist: - type: string - x-stream-index: "008" - blocklist_behavior: - enum: - - flag - - block + archived_at: + format: date-time + type: number + x-stream-index: "016" + ban_expires: + description: Expiration date of the ban + format: date-time + title: Ban expires + type: number + x-stream-index: "013" + banned: + description: Whether member is banned this channel or not + title: Banned + type: boolean + x-stream-index: "012" + channel_role: + description: Role of the member in the channel + title: Channel Role type: string + x-stream-index: "018" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number x-stream-index: "009" - commands: - items: - type: string - type: array - x-stream-index: "011" - grants: - additionalProperties: - items: - type: string - type: array + custom: + additionalProperties: {} type: object - x-stream-index: "010" - max_message_length: - format: int32 - maximum: 20000 - type: integer - x-stream-index: "007" - quotes: - type: boolean x-stream-index: "004" - reactions: + deleted_at: + format: date-time + type: number + x-stream-index: "011" + invite_accepted_at: + description: Date when invite was accepted + format: date-time + title: Invited accepted at + type: number + x-stream-index: "006" + invite_rejected_at: + description: Date when invite was rejected + format: date-time + title: Invited rejected at + type: number + x-stream-index: "007" + invited: + description: Whether member was invited or not + title: Invited type: boolean - x-stream-index: "002" - replies: + x-stream-index: "005" + is_moderator: + description: Whether member is channel moderator or not + title: Is moderator type: boolean x-stream-index: "003" - shared_locations: + notifications_muted: type: boolean - x-stream-index: "013" - typing_events: + x-stream-index: "019" + pinned_at: + format: date-time + type: number + x-stream-index: "015" + role: + description: 'Permission level of the member in the channel (DEPRECATED: + use channel_role instead)' + enum: + - member + - moderator + - admin + - owner + title: Role + type: string + x-stream-index: "017" + shadow_banned: + description: Whether member is shadow banned in this channel or not + title: Shadow banned type: boolean + x-stream-index: "014" + status: + type: string + x-stream-index: "008" + updated_at: + description: Date/time of the last update + format: date-time + title: Updated at + type: number + x-stream-index: "010" + user: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "002" + user_id: + title: User ID + type: string x-stream-index: "001" - uploads: - type: boolean - x-stream-index: "005" - url_enrichment: - type: boolean - x-stream-index: "006" - user_message_reminders: - type: boolean - x-stream-index: "012" required: - - grants - - commands - type: object - ConfigResponse: - properties: - ai_image_config: - $ref: '#/components/schemas/AIImageConfig' - description: Configuration for AI image analysis - title: AI Image Config - x-stream-index: "009" - ai_text_config: - $ref: '#/components/schemas/AITextConfig' - description: Configuration for AI text analysis - title: AI Text Config - x-stream-index: "008" - ai_video_config: - $ref: '#/components/schemas/AIVideoConfig' - description: Configuration for AI video analysis - title: AI Video Config - x-stream-index: "010" - async: - description: Whether moderation should be performed asynchronously - title: Async - type: boolean - x-stream-index: "003" - automod_platform_circumvention_config: - $ref: '#/components/schemas/AutomodPlatformCircumventionConfig' - description: Configuration for platform circumvention detection - title: Automod Platform Circumvention Config - x-stream-index: "005" - automod_semantic_filters_config: - $ref: '#/components/schemas/AutomodSemanticFiltersConfig' - description: Configuration for semantic filtering - title: Automod Semantic Filters Config - x-stream-index: "006" - automod_toxicity_config: - $ref: '#/components/schemas/AutomodToxicityConfig' - description: Configuration for toxicity detection - title: Automod Toxicity Config - x-stream-index: "004" - block_list_config: - $ref: '#/components/schemas/BlockListConfig' - description: Configuration for block list filtering - title: Block List Config - x-stream-index: "007" + - custom + - created_at + - updated_at + - banned + - shadow_banned + - channel_role + - notifications_muted + title: Channel member + type: object + ChannelMute: + nullable: true + properties: + channel: + $ref: '#/components/schemas/ChannelResponse' + description: Channel that is muted + title: Channel + x-stream-index: "002" created_at: - description: When the configuration was created + description: Date/time of creation format: date-time - title: Created At + title: Created at type: number - x-stream-index: "012" - key: - description: Unique identifier for the moderation configuration - title: Key - type: string - x-stream-index: "001" - rule_builder_config: - $ref: '#/components/schemas/RuleBuilderConfig' - x-stream-index: "015" - team: - description: Team associated with the configuration - title: Team - type: string - x-stream-index: "002" + x-stream-index: "004" + expires: + description: Date/time of mute expiration + format: date-time + title: Expires + type: number + x-stream-index: "003" updated_at: - description: When the configuration was last updated + description: Date/time of the last update format: date-time - title: Updated At + title: Updated at type: number - x-stream-index: "013" - velocity_filter_config: - $ref: '#/components/schemas/VelocityFilterConfig' - description: Configuration for velocity-based filtering - title: Velocity Filter Config - x-stream-index: "011" - video_call_rule_config: - $ref: '#/components/schemas/VideoCallRuleConfig' - x-stream-index: "014" + x-stream-index: "005" + user: + $ref: '#/components/schemas/UserResponse' + description: Owner of channel mute + title: User + x-stream-index: "001" required: - - key - - team - - async - created_at - updated_at type: object - ConnectUserDetailsRequest: + ChannelOwnCapability: + description: All possibility of string to use + enum: + - ban-channel-members + - cast-poll-vote + - connect-events + - create-attachment + - delete-any-message + - delete-channel + - delete-own-message + - flag-message + - freeze-channel + - join-channel + - leave-channel + - mute-channel + - pin-message + - query-poll-votes + - quote-message + - read-events + - search-messages + - send-custom-events + - send-links + - send-message + - send-poll + - send-reaction + - send-reply + - send-restricted-visibility-message + - send-typing-events + - set-channel-cooldown + - share-location + - skip-slow-mode + - slow-mode + - typing-events + - update-any-message + - update-channel + - update-channel-members + - update-own-message + - update-thread + - upload-file + title: ChannelOwnCapability + type: string + ChannelPushPreferences: properties: - custom: - additionalProperties: {} - type: object - x-stream-index: "004" - id: + chat_level: type: string x-stream-index: "001" - image: - type: string - x-stream-index: "003" - invisible: - type: boolean - x-stream-index: "006" - language: - type: string - x-stream-index: "005" - name: - type: string - x-stream-index: "002" - privacy_settings: - $ref: '#/components/schemas/PrivacySettingsResponse' - x-stream-index: "007" - required: - - id - type: object - ConnectedEvent: - description: This event is sent when the WS connection is established and authenticated, - this event contains the full user object as it is stored on the server - properties: - connection_id: - description: The connection_id for this client - title: Connection ID - type: string - x-stream-index: "002" - created_at: + disabled_until: format: date-time type: number - x-stream-index: "001.002" - me: - $ref: '#/components/schemas/OwnUserResponse' - description: The full user object as it is stored on the server - title: OwnUserResponse - x-stream-index: "003" - type: - default: connection.ok - description: 'The type of event: "connection.ok" in this case' - title: Event Type - type: string - x-stream-index: "001.001" - required: - - type - - created_at - - connection_id - - me - title: ConnectedEvent + x-stream-index: "002" 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 - ConnectionErrorEvent: - description: This event is sent when the WS connection fails + ChannelResponse: + description: Represents channel in chat properties: - connection_id: + auto_translation_enabled: + description: Whether auto translation is enabled or not + title: Auto translation + type: boolean + x-stream-index: "017" + auto_translation_language: + description: Language to translate to when auto translation is active + title: Auto translation language type: string - x-stream-index: "002" + x-stream-index: "018" + blocked: + description: Whether this channel is blocked by current user or not + title: Blocked + type: boolean + x-stream-index: "023" + cid: + description: Channel CID (:) + title: CID + type: string + x-stream-index: "003" + config: + $ref: '#/components/schemas/ChannelConfigWithInfo' + description: Channel configuration + title: ChannelConfigWithInfo + x-stream-index: "013" + cooldown: + description: Cooldown period after sending each message + format: int32 + title: Cooldown + type: integer + x-stream-index: "020" created_at: + description: Date/time of creation format: date-time + title: Created at type: number - x-stream-index: "001.002" - error: - $ref: '#/components/schemas/APIError' - description: The error that caused the connection to fail - title: Error - x-stream-index: "003" - type: - default: connection.error - description: 'The type of event: "connection.ok" in this case' - title: Event Type - type: string - x-stream-index: "001.001" - required: - - type - - created_at - - connection_id - - error - title: ConnectionErrorEvent - 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 - ContentCountRuleParameters: - properties: - threshold: - format: int32 - type: integer - x-stream-index: "001" - time_window: + x-stream-index: "005" + created_by: + $ref: '#/components/schemas/UserResponse' + description: Creator of the channel + title: UserResponse + x-stream-index: "008" + custom: + additionalProperties: {} + description: Custom data for this object + title: Custom data + type: object + x-stream-index: "026" + deleted_at: + description: Date/time of deletion + format: date-time + title: Deleted at + type: number + x-stream-index: "007" + disabled: + type: boolean + x-stream-index: "010" + frozen: + description: Whether channel is frozen or not + title: Frozen + type: boolean + x-stream-index: "009" + hidden: + description: Whether this channel is hidden by current user or not + title: Hidden + type: boolean + x-stream-index: "022" + hide_messages_before: + description: Date since when the message history is accessible + format: date-time + title: Hide messages before + type: number + x-stream-index: "019" + id: + description: Channel unique ID + title: ID type: string - x-stream-index: "002" - required: - - threshold - - time_window - type: object - CountByMinuteResponse: - nullable: true - properties: - count: + x-stream-index: "001" + last_message_at: + description: Date of the last message sent + format: date-time + title: Last message at + type: number + x-stream-index: "004" + member_count: + description: Number of members in the channel format: int32 + title: Member count type: integer - x-stream-index: "002" - start_ts: + x-stream-index: "012" + members: + description: List of channel members (max 100) + items: + $ref: '#/components/schemas/ChannelMember' + title: ChannelMembers + type: array + x-stream-index: "011" + message_count: + description: Number of messages in the channel + format: int64 + title: Message count + type: integer + x-stream-index: "027" + mute_expires_at: + description: Date of mute expiration format: date-time + title: Mute expires at type: number - x-stream-index: "001" - required: - - start_ts - - count - type: object - CreateBlockListRequest: - description: Block list contains restricted words - nullable: true - properties: - name: - description: Block list name - maxLength: 255 - title: Name - type: string - x-stream-index: "001" + x-stream-index: "015" + muted: + description: Whether this channel is muted or not + title: Muted + type: boolean + x-stream-index: "014" + own_capabilities: + description: List of channel capabilities of authenticated user + items: + $ref: '#/components/schemas/ChannelOwnCapability' + title: ChannelOwnCapability + type: array + x-stream-index: "021" team: + description: Team the channel belongs to (multi-tenant only) + title: Team type: string - x-stream-index: "004" + x-stream-index: "016" + truncated_at: + description: Date of the latest truncation of the channel + format: date-time + title: UserResponse + type: number + x-stream-index: "024" + truncated_by: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "025" type: - description: Block list type. - enum: - - regex - - domain - - domain_allowlist - - email - - word + description: Type of the channel title: Type type: string - x-stream-index: "003" - words: - description: List of words to block - items: - type: string - minimum: 1 - title: Words - type: array + x-stream-docs-page-id: channel_features x-stream-index: "002" + updated_at: + description: Date/time of the last update + format: date-time + title: Updated at + type: number + x-stream-index: "006" required: - - name - - words - title: Block list + - id + - type + - cid + - created_at + - updated_at + - frozen + - disabled + - custom + title: Channel type: object - x-stream-docs-page-id: block_lists - CreateBlockListResponse: - description: Basic response information + ChannelStateResponse: nullable: true properties: - blocklist: - $ref: '#/components/schemas/BlockListResponse' - x-stream-index: "001" + active_live_locations: + items: + $ref: '#/components/schemas/SharedLocationResponseData' + type: array + x-stream-index: "001.015" + channel: + $ref: '#/components/schemas/ChannelResponse' + x-stream-index: "001.001" + deleted_messages: + items: + type: string + type: array + x-stream-index: "001.016" + draft: + $ref: '#/components/schemas/DraftResponse' + x-stream-index: "001.014" duration: - description: Duration of the request in milliseconds - title: Duration type: string x-stream-index: "002.001" + hidden: + type: boolean + x-stream-index: "001.011" + hide_messages_before: + format: date-time + type: number + x-stream-index: "001.012" + members: + items: + $ref: '#/components/schemas/ChannelMember' + type: array + x-stream-index: "001.007" + membership: + $ref: '#/components/schemas/ChannelMember' + x-stream-index: "001.008" + messages: + items: + $ref: '#/components/schemas/MessageResponse' + type: array + x-stream-index: "001.002" + pending_messages: + items: + $ref: '#/components/schemas/PendingMessageResponse' + type: array + x-stream-index: "001.013" + pinned_messages: + items: + $ref: '#/components/schemas/MessageResponse' + type: array + x-stream-index: "001.003" + push_preferences: + $ref: '#/components/schemas/ChannelPushPreferences' + x-stream-index: "001.009" + read: + items: + $ref: '#/components/schemas/ReadStateResponse' + type: array + x-stream-index: "001.006" + threads: + items: + $ref: '#/components/schemas/ThreadStateResponse' + type: array + x-stream-index: "001.010" + watcher_count: + format: int32 + type: integer + x-stream-index: "001.004" + watchers: + items: + $ref: '#/components/schemas/UserResponse' + type: array + x-stream-index: "001.005" required: + - messages + - pinned_messages + - members + - threads - duration - title: Response type: object - CreateDeviceRequest: - description: Create device request - nullable: true + ChannelStateResponseFields: properties: - id: - description: Device ID - maxLength: 255 - minLength: 1 - title: ID - type: string + active_live_locations: + description: Active live locations in the channel + items: + $ref: '#/components/schemas/SharedLocationResponseData' + title: Active Live Locations + type: array + x-stream-index: "015" + channel: + $ref: '#/components/schemas/ChannelResponse' x-stream-index: "001" - push_provider: - description: Push provider - enum: - - firebase - - apn - - huawei - - xiaomi - title: PushProvider - type: string + deleted_messages: + items: + type: string + type: array + x-stream-index: "016" + draft: + $ref: '#/components/schemas/DraftResponse' + x-stream-index: "014" + hidden: + description: Whether this channel is hidden or not + title: Hidden + type: boolean + x-stream-index: "011" + hide_messages_before: + description: Messages before this date are hidden from the user + format: date-time + title: Hide messages before + type: number + x-stream-index: "012" + members: + description: List of channel members + items: + $ref: '#/components/schemas/ChannelMember' + title: Members + type: array + x-stream-index: "007" + membership: + $ref: '#/components/schemas/ChannelMember' + description: Current user membership object + title: Membership + x-stream-index: "008" + messages: + description: List of channel messages + items: + $ref: '#/components/schemas/MessageResponse' + title: Message + type: array x-stream-index: "002" - push_provider_name: - description: Push provider name - title: PushProviderName - type: string + pending_messages: + description: Pending messages that this user has sent + items: + $ref: '#/components/schemas/PendingMessageResponse' + title: Pending messages + type: array + x-stream-index: "013" + pinned_messages: + description: List of pinned messages in the channel + items: + $ref: '#/components/schemas/MessageResponse' + title: Pinned messages + type: array + x-stream-docs-page-id: pinned_messages x-stream-index: "003" - voip_token: - description: When true the token is for Apple VoIP push notifications - title: VoipToken - type: boolean + push_preferences: + $ref: '#/components/schemas/ChannelPushPreferences' + x-stream-index: "009" + read: + description: List of read states + items: + $ref: '#/components/schemas/ReadStateResponse' + title: Read + type: array + x-stream-index: "006" + threads: + items: + $ref: '#/components/schemas/ThreadStateResponse' + type: array + x-stream-index: "010" + watcher_count: + description: Number of channel watchers + format: int32 + title: Watcher count + type: integer x-stream-index: "004" + watchers: + description: List of user who is watching the channel + items: + $ref: '#/components/schemas/UserResponse' + title: Watchers + type: array + x-stream-index: "005" required: - - id - - push_provider - title: CreateDeviceRequest + - messages + - pinned_messages + - members + - threads type: object - CreateDraftRequest: + ChannelStopWatchingRequest: nullable: true - properties: - message: - $ref: '#/components/schemas/MessageRequest' - x-stream-index: "001" - required: - - message type: object - CreateDraftResponse: - description: Basic response information - nullable: true + ChannelTruncatedEvent: properties: - draft: - $ref: '#/components/schemas/DraftResponse' - x-stream-index: "001" - duration: - description: Duration of the request in milliseconds - title: Duration + channel: + $ref: '#/components/schemas/ChannelResponse' + x-stream-index: "001.004" + channel_id: + type: string + x-stream-index: "001.002" + channel_member_count: + format: int32 + type: integer + x-stream-index: "001.005" + channel_type: + type: string + x-stream-index: "001.003" + cid: + type: string + x-stream-index: "001.001" + created_at: + format: date-time + type: number + x-stream-index: "002.002" + type: + default: channel.truncated type: string x-stream-index: "002.001" required: - - draft - - duration - title: Response + - cid + - channel_id + - channel_type + - channel_member_count + - type + - created_at + title: ChannelTruncatedEvent type: object - CreateGuestRequest: - nullable: true + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + ChannelUnFrozenEvent: properties: - user: - $ref: '#/components/schemas/UserRequest' - description: User object which server acts upon - title: User - x-stream-index: "001" + channel_id: + type: string + x-stream-index: "002.002" + channel_type: + type: string + x-stream-index: "002.003" + cid: + type: string + x-stream-index: "002.001" + created_at: + format: date-time + type: number + x-stream-index: "001.002" + type: + default: channel.unfrozen + type: string + x-stream-index: "001.001" required: - - user + - type + - created_at + - cid + - channel_id + - channel_type + title: ChannelUnFrozenEvent type: object - CreateGuestResponse: - nullable: true + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + ChannelUpdatedEvent: properties: - access_token: - description: the access token to authenticate the user - title: Access token + channel: + $ref: '#/components/schemas/ChannelResponse' + x-stream-index: "004.004" + channel_id: type: string - x-stream-index: "002" - duration: - description: Duration of the request in milliseconds - title: Duration + x-stream-index: "004.002" + channel_member_count: + format: int32 + type: integer + x-stream-index: "004.005" + channel_type: + type: string + x-stream-index: "004.003" + cid: + type: string + x-stream-index: "004.001" + created_at: + format: date-time + type: number + x-stream-index: "003.002" + message: + $ref: '#/components/schemas/Message' + x-stream-index: "001" + team: + type: string + x-stream-index: "002.001" + type: + default: channel.updated type: string x-stream-index: "003.001" user: - $ref: '#/components/schemas/UserResponse' - description: User object which server acts upon - title: User - x-stream-index: "001" + $ref: '#/components/schemas/User' + x-stream-index: "005.001" required: - - user - - access_token - - duration + - type + - created_at + - cid + - channel_id + - channel_type + - channel_member_count + title: ChannelUpdatedEvent type: object - CreatePollOptionRequest: - nullable: true - properties: - Custom: - additionalProperties: {} - type: object - writeOnly: true - x-stream-index: "003" - text: - description: Option text - title: string - type: string - x-stream-index: "002" - required: - - text - type: object - CreatePollRequest: - description: Contains all information needed to create a new poll - nullable: true + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + ChannelVisibleEvent: properties: - Custom: - additionalProperties: {} - type: object - writeOnly: true - x-stream-index: "011" - allow_answers: - description: Indicates whether users can suggest user defined answers - title: Allow answers - type: boolean - x-stream-index: "009" - allow_user_suggested_options: - type: boolean - x-stream-index: "008" - description: - description: A description of the poll - title: Description - type: string - x-stream-index: "003" - enforce_unique_vote: - description: Indicates whether users can cast multiple votes - title: Multiple choice - type: boolean - x-stream-index: "006" - id: - maxLength: 255 + channel_id: type: string - x-stream-index: "001" - is_closed: - description: Indicates whether the poll is open for voting - title: Is closed - type: boolean - x-stream-index: "010" - max_votes_allowed: - description: Indicates the maximum amount of votes a user can cast - format: int32 - maximum: 10 - title: Maximum votes allowed - type: integer - x-stream-index: "007" - name: - description: The name of the poll - title: Name + x-stream-index: "001.002" + channel_type: type: string - x-stream-index: "002" - options: - items: - $ref: '#/components/schemas/PollOptionInput' - maximum: 100 - type: array - x-stream-index: "004" - voting_visibility: - enum: - - anonymous - - public + x-stream-index: "001.003" + cid: type: string - x-stream-index: "005" - required: - - name - title: Create Poll Request - type: object - CreateReminderRequest: - nullable: true - properties: - remind_at: + x-stream-index: "001.001" + created_at: format: date-time type: number - x-stream-index: "001" - type: object - Credentials: - properties: - ice_servers: - items: - $ref: '#/components/schemas/ICEServer' - type: array - x-stream-index: "003" - server: - $ref: '#/components/schemas/SFUResponse' - x-stream-index: "001" - token: + x-stream-index: "003.002" + type: + default: channel.visible type: string - x-stream-index: "002" + x-stream-index: "003.001" + user: + $ref: '#/components/schemas/User' + x-stream-index: "002.001" required: - - server - - token - - ice_servers + - cid + - channel_id + - channel_type + - type + - created_at + title: ChannelVisibleEvent type: object - CustomActionRequest: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + ChatActivityStatsResponse: properties: - id: - type: string + Messages: + $ref: '#/components/schemas/MessageStatsResponse' x-stream-index: "001" - options: - additionalProperties: {} - type: object - x-stream-index: "002" type: object - CustomVideoEvent: - description: A custom event, this event is used to send custom events to other - participants in the call. + ClosedCaptionEvent: + description: This event is sent when closed captions are being sent in a call, + clients should use this to show the closed captions in the call screen properties: call_cid: type: string x-stream-index: "002.001" + closed_caption: + $ref: '#/components/schemas/CallClosedCaption' + description: The closed caption object + title: CallClosedCaption + x-stream-index: "003" created_at: format: date-time type: number x-stream-index: "001.002" - custom: - additionalProperties: {} - description: Custom data for this object - title: Custom data - type: object - x-stream-index: "003" type: - default: custom - description: The type of event, "custom" in this case + default: call.closed_caption + description: 'The type of event: "call.closed_caption" in this case' title: Event Type type: string x-stream-index: "001.001" - user: - $ref: '#/components/schemas/UserResponse' - x-stream-index: "004" required: - type - created_at - call_cid - - custom - - user - title: CustomVideoEvent + - closed_caption + title: ClosedCaptionEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: other + x-stream-event-doc-group: transcription x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - DailyAggregateCallDurationReportResponse: + CollectUserFeedbackRequest: + nullable: true properties: - date: + custom: + additionalProperties: {} + type: object + x-stream-index: "009" + rating: + format: int32 + maximum: 5 + minimum: 1 + type: integer + x-stream-index: "007" + reason: + maxLength: 1000 type: string - x-stream-index: "001" - report: - $ref: '#/components/schemas/CallDurationReport' - x-stream-index: "002" - required: - - date - - report - type: object - DailyAggregateCallParticipantCountReportResponse: - properties: - date: + x-stream-index: "008" + sdk: + maxLength: 50 type: string - x-stream-index: "001" - report: - $ref: '#/components/schemas/CallParticipantCountReport' - x-stream-index: "002" - required: - - date - - report - type: object - DailyAggregateCallsPerDayReportResponse: - properties: - date: + x-stream-index: "005" + sdk_version: + maxLength: 50 type: string - x-stream-index: "001" - report: - $ref: '#/components/schemas/CallsPerDayReport' - x-stream-index: "002" - required: - - date - - report - type: object - DailyAggregateQualityScoreReportResponse: - properties: - date: + x-stream-index: "006" + user_session_id: + maxLength: 50 type: string - x-stream-index: "001" - report: - $ref: '#/components/schemas/QualityScoreReport' - x-stream-index: "002" + x-stream-index: "004" required: - - date - - report + - sdk + - sdk_version + - rating type: object - DailyAggregateSDKUsageReportResponse: + CollectUserFeedbackResponse: + description: Basic response information + nullable: true properties: - date: + duration: + description: Duration of the request in milliseconds + title: Duration type: string - x-stream-index: "001" - report: - $ref: '#/components/schemas/SDKUsageReport' - x-stream-index: "002" + x-stream-index: "001.001" required: - - date - - report + - duration + title: Response type: object - DailyAggregateUserFeedbackReportResponse: + Command: + description: Represents custom chat command + nullable: true properties: - date: + args: + description: Arguments help text, shown in commands auto-completion + title: Arguments type: string + x-stream-index: "006" + created_at: + description: Date/time of creation + format: date-time + readOnly: true + title: Created at + type: number x-stream-index: "001" - report: - $ref: '#/components/schemas/UserFeedbackReport' - x-stream-index: "002" - required: - - date - - report - type: object - Data: - properties: - id: + description: + description: Description, shown in commands auto-completion + title: Description type: string - x-stream-index: "001" - required: - - id - type: object - DeleteActivityRequest: - properties: - hard_delete: - type: boolean - x-stream-index: "001" - type: object - DeleteCallRequest: - description: DeleteCallRequest is the payload for deleting a call. - nullable: true - properties: - hard: - description: if true the call will be hard deleted along with all related - data - title: Hard - type: boolean - x-stream-index: "001" - title: DeleteCallRequest - type: object - DeleteCallResponse: - description: DeleteCallResponse is the payload for deleting a call. - nullable: true - properties: - call: - $ref: '#/components/schemas/CallResponse' - title: Call - x-stream-index: "001" - duration: + x-stream-index: "005" + name: + description: Unique command name + title: Name type: string - x-stream-index: "003.001" - task_id: - title: TaskID + x-stream-index: "004" + set: + description: Set name used for grouping commands + title: Set type: string + x-stream-index: "007" + updated_at: + description: Date/time of the last update + format: date-time + readOnly: true + title: Updated at + type: number x-stream-index: "002" required: - - call - - duration - title: DeleteCallResponse + - name + - description + - args + - set + title: Command type: object - DeleteChannelResponse: - description: Basic response information + CommentAddedEvent: + description: Emitted when a comment is added to an activity. nullable: true properties: - channel: - $ref: '#/components/schemas/ChannelResponse' + activity: + $ref: '#/components/schemas/ActivityResponse' x-stream-index: "002" - duration: - description: Duration of the request in milliseconds - title: Duration + comment: + $ref: '#/components/schemas/CommentResponse' + description: The comment that was added + title: Text + x-stream-index: "001" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 003.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 003.001.007 + feed_visibility: type: string - x-stream-index: "001.001" + x-stream-index: "003.003" + fid: + type: string + x-stream-index: "003.002" + received_at: + format: date-time + type: number + x-stream-index: 003.001.004 + type: + default: feeds.comment.added + description: 'The type of event: "feeds.comment.added" in this case' + title: Event Type + type: string + x-stream-index: 003.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who added the comment + title: User + x-stream-index: "004.001" required: - - duration - title: Response + - comment + - activity + - type + - created_at + - custom + - fid + title: CommentAddedEvent type: object - DeleteChannelsRequest: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + CommentDeletedEvent: + description: Emitted when a comment is deleted. nullable: true properties: - cids: - description: All channels that should be deleted - items: - type: string - maximum: 100 - minimum: 1 - title: Channels CID - type: array + comment: + $ref: '#/components/schemas/CommentResponse' x-stream-index: "001" - hard_delete: - description: Specify if channels and all ressources should be hard deleted - title: Hard delete - type: boolean - x-stream-index: "002" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + feed_visibility: + type: string + x-stream-index: "002.003" + fid: + type: string + x-stream-index: "002.002" + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 + type: + default: feeds.comment.deleted + description: 'The type of event: "feeds.comment.deleted" in this case' + title: Event Type + type: string + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who deleted the comment + title: User + x-stream-index: "003.001" required: - - cids + - comment + - type + - created_at + - custom + - fid + title: CommentDeletedEvent type: object - DeleteChannelsResponse: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + CommentReactionAddedEvent: + description: Emitted when a reaction is added to a comment. nullable: true properties: - duration: - description: Duration of the request in milliseconds - title: Duration - type: string - x-stream-index: "003.001" - result: - additionalProperties: - $ref: '#/components/schemas/DeleteChannelsResultResponse' - description: Map of channel IDs and their deletion results - title: Result - type: object + activity: + $ref: '#/components/schemas/ActivityResponse' + x-stream-index: "003" + comment: + $ref: '#/components/schemas/CommentResponse' x-stream-index: "001" - task_id: + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 004.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 004.001.007 + feed_visibility: + type: string + x-stream-index: "004.003" + fid: type: string + x-stream-index: "004.002" + reaction: + $ref: '#/components/schemas/FeedsReactionResponse' + description: The reaction that was added + title: Reaction x-stream-index: "002" + received_at: + format: date-time + type: number + x-stream-index: 004.001.004 + type: + default: feeds.comment.reaction.added + description: 'The type of event: "feeds.comment.reaction.added" in this + case' + title: Event Type + type: string + x-stream-index: 004.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who added the reaction + title: User + x-stream-index: "005.001" required: - - duration + - comment + - reaction + - activity + - type + - created_at + - custom + - fid + title: CommentReactionAddedEvent type: object - DeleteChannelsResultResponse: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + CommentReactionDeletedEvent: + description: Emitted when a reaction is deleted from a comment. nullable: true properties: - error: + comment: + $ref: '#/components/schemas/CommentResponse' + x-stream-index: "001" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 003.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 003.001.007 + feed_visibility: + type: string + x-stream-index: "003.003" + fid: type: string + x-stream-index: "003.002" + reaction: + $ref: '#/components/schemas/FeedsReactionResponse' x-stream-index: "002" - status: + received_at: + format: date-time + type: number + x-stream-index: 003.001.004 + type: + default: feeds.comment.reaction.deleted + description: The type of reaction that was removed + title: Type type: string - x-stream-index: "001" + x-stream-index: 003.001.002 required: - - status - type: object - DeleteMessageRequest: - properties: - hard_delete: - type: boolean - x-stream-index: "001" + - comment + - reaction + - type + - created_at + - custom + - fid + title: CommentReactionDeletedEvent type: object - DeleteMessageResponse: - description: Basic response information + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + CommentReactionUpdatedEvent: + description: Emitted when a reaction is updated on a comment. nullable: true properties: - duration: - description: Duration of the request in milliseconds - title: Duration - type: string - x-stream-index: "002.001" - message: - $ref: '#/components/schemas/MessageResponse' - x-stream-index: "001" - required: - - message - - duration - title: Response - type: object - DeleteModerationConfigResponse: - nullable: true - properties: - duration: - type: string - x-stream-index: "001.001" - required: - - duration - type: object - DeleteReactionRequest: - properties: - hard_delete: - type: boolean - x-stream-index: "001" - type: object - DeleteReactionResponse: - description: Basic response information - nullable: true - properties: - duration: - description: Duration of the request in milliseconds - title: Duration - type: string - x-stream-index: "003.001" - message: - $ref: '#/components/schemas/MessageResponse' - x-stream-index: "001" - reaction: - $ref: '#/components/schemas/ReactionResponse' - x-stream-index: "002" - required: - - message - - reaction - - duration - title: Response - type: object - DeleteRecordingResponse: - description: Response for DeleteRecording - nullable: true - properties: - duration: - description: Duration of the request in milliseconds - title: Duration - type: string - x-stream-index: "001.001" - required: - - duration - title: DeleteRecordingResponse - type: object - DeleteReminderResponse: - 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 - DeleteTranscriptionResponse: - description: DeleteTranscriptionResponse is the payload for deleting a transcription. - nullable: true - properties: - duration: - description: Duration of the request in milliseconds - title: Duration - type: string - x-stream-index: "001.001" - required: - - duration - title: DeleteTranscriptionResponse - type: object - DeleteUserRequest: - properties: - delete_conversation_channels: - type: boolean - x-stream-index: "003" - delete_feeds_content: - type: boolean - x-stream-index: "004" - hard_delete: - type: boolean - x-stream-index: "001" - mark_messages_deleted: - type: boolean - x-stream-index: "002" - type: object - Device: - nullable: true - properties: - created_at: - format: date-time - type: number - x-stream-index: "002.002" - disabled: - type: boolean - x-stream-index: "002.003" - disabled_reason: - type: string - x-stream-index: "002.004" - id: - type: string - x-stream-index: 002.001.004 - push_provider: - enum: - - firebase - - apn - - huawei - - xiaomi - type: string - x-stream-index: 002.001.001 - push_provider_name: - type: string - x-stream-index: 002.001.003 - user_id: - type: string - x-stream-index: "004" - voip: - type: boolean - x-stream-index: 002.001.005 - required: - - push_provider - - id - - created_at - - user_id - type: object - DeviceResponse: - description: Response for Device - nullable: true - properties: - created_at: - description: Date/time of creation - format: date-time - title: Created at - type: number - x-stream-index: "004" - disabled: - description: Whether device is disabled or not - title: Disabled - type: boolean - x-stream-index: "005" - disabled_reason: - description: Reason explaining why device had been disabled - title: Reason - type: string - x-stream-index: "006" - id: - description: Device ID - title: ID - type: string + activity: + $ref: '#/components/schemas/ActivityResponse' x-stream-index: "003" - push_provider: - description: Push provider - title: PushProvider - type: string + comment: + $ref: '#/components/schemas/CommentResponse' x-stream-index: "001" - push_provider_name: - description: Push provider name - title: PushProviderName - type: string - x-stream-index: "002" - user_id: - description: User ID - title: UserID - type: string - x-stream-index: "008" - voip: - description: When true the token is for Apple VoIP push notifications - title: Voip - type: boolean - x-stream-index: "007" - required: - - push_provider - - id - - created_at - - user_id - title: DeviceResponse - type: object - DraftDeletedEvent: - description: Emitted when a Draft is deleted. - nullable: true - properties: - cid: - description: The CID of the channel where the draft was created - title: Channel CID - type: string - x-stream-index: 001.001.002 created_at: description: Date/time of creation format: date-time title: Created at type: number - x-stream-index: 001.001.001.003 + x-stream-index: 004.001.003 custom: additionalProperties: {} type: object - x-stream-index: 001.001.001.007 - draft: - $ref: '#/components/schemas/DraftResponse' - x-stream-index: "001.003" - parent_id: - description: The ID of the parent message - title: Message ID + x-stream-index: 004.001.007 + feed_visibility: type: string - x-stream-index: "001.002" + x-stream-index: "004.003" + fid: + type: string + x-stream-index: "004.002" + reaction: + $ref: '#/components/schemas/FeedsReactionResponse' + description: The reaction that was updated + title: Reaction + x-stream-index: "002" received_at: format: date-time type: number - x-stream-index: 001.001.001.004 + x-stream-index: 004.001.004 type: - default: draft.deleted - description: 'The type of event: "draft.deleted" in this case' + default: feeds.comment.reaction.updated + description: 'The type of event: "feeds.comment.reaction.updated" in this + case' title: Event Type type: string - x-stream-index: 001.001.001.002 + x-stream-index: 004.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who updated the reaction + title: User + x-stream-index: "005.001" required: + - comment + - reaction + - activity - type - created_at - custom - title: DraftDeletedEvent + - fid + title: CommentReactionUpdatedEvent 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 - DraftPayloadResponse: + CommentResponse: properties: attachments: items: $ref: '#/components/schemas/Attachment' type: array - x-stream-index: "004" + x-stream-index: "011" + confidence_score: + description: Confidence score of the comment + format: float + title: Confidence Score + type: number + x-stream-index: "022" + controversy_score: + description: Controversy score of the comment + format: float + title: Controversy Score + type: number + x-stream-index: "023" + created_at: + description: When the comment was created + format: date-time + title: Created At + type: number + x-stream-index: "014" custom: additionalProperties: {} + description: Custom data for the comment + title: Custom Data type: object - x-stream-index: "007" - html: - type: string - x-stream-index: "010" + x-stream-index: "006" + deleted_at: + description: When the comment was deleted + format: date-time + title: Deleted At + type: number + x-stream-index: "016" + downvote_count: + description: Number of downvotes for this comment + format: int32 + title: Downvote Count + type: integer + x-stream-index: "020" id: + description: Unique identifier for the comment + title: ID type: string x-stream-index: "001" - mentioned_users: + latest_reactions: + description: Recent reactions to the comment items: - $ref: '#/components/schemas/UserResponse' + $ref: '#/components/schemas/FeedsReactionResponse' + title: Latest Reactions type: array - x-stream-index: "008" - mml: + x-stream-index: "009" + mentioned_users: + description: Users mentioned in the comment + items: + $ref: '#/components/schemas/UserResponse' + title: Mention Users + type: array + x-stream-index: "012" + moderation: + $ref: '#/components/schemas/ModerationV2Response' + x-stream-index: "017" + object_id: + description: ID of the object this comment is associated with + title: Object ID + type: string + x-stream-index: "002" + object_type: + description: Type of the object this comment is associated with + title: Object Type type: string x-stream-index: "003" + own_reactions: + description: Current user's reactions to this activity + items: + $ref: '#/components/schemas/FeedsReactionResponse' + title: Own Reactions + type: array + x-stream-index: "024" parent_id: + description: ID of parent comment for nested replies + title: Parent ID type: string - x-stream-index: "005" - poll_id: + x-stream-index: "007" + reaction_count: + description: Number of reactions to this comment + format: int32 + title: Reaction Count + type: integer + x-stream-index: "008" + reaction_groups: + additionalProperties: + $ref: '#/components/schemas/ReactionGroupResponse' + description: Grouped reactions by type + title: Reaction Groups + type: object + x-stream-index: "010" + reply_count: + description: Number of replies to this comment + format: int32 + title: Reply Count + type: integer + x-stream-index: "018" + score: + description: Score of the comment based on reactions + format: int32 + title: Score + type: integer + x-stream-index: "021" + status: + description: Status of the comment (e.g., active, deleted) + title: Status type: string x-stream-index: "013" - quoted_message_id: - type: string - x-stream-index: "009" - show_in_channel: - type: boolean - x-stream-index: "006" - silent: - type: boolean - x-stream-index: "012" text: + description: Text content of the comment + title: Text type: string - x-stream-index: "002" - type: - type: string - x-stream-index: "011" - required: - - id - - text - - custom - type: object - DraftResponse: - properties: - channel: - $ref: '#/components/schemas/ChannelResponse' - x-stream-index: "003" - channel_cid: - type: string - x-stream-index: "002" - created_at: + x-stream-index: "005" + updated_at: + description: When the comment was last updated format: date-time + title: Updated At type: number - x-stream-index: "007" - message: - $ref: '#/components/schemas/DraftPayloadResponse' - x-stream-index: "001" - parent_id: - type: string + x-stream-index: "015" + upvote_count: + description: Number of upvotes for this comment + format: int32 + title: Upvote Count + type: integer + x-stream-index: "019" + user: + $ref: '#/components/schemas/UserResponse' + description: User who created the comment + title: User x-stream-index: "004" - parent_message: - $ref: '#/components/schemas/MessageResponse' - x-stream-index: "005" - quoted_message: - $ref: '#/components/schemas/MessageResponse' - x-stream-index: "006" required: - - message - - channel_cid + - id + - object_id + - object_type + - user + - reaction_count + - mentioned_users + - status - created_at + - updated_at + - reply_count + - upvote_count + - downvote_count + - score + - confidence_score + - own_reactions + title: Comment type: object - DraftUpdatedEvent: - description: Emitted when a Draft is created or updated. + CommentUpdatedEvent: + description: Emitted when a comment is updated. nullable: true properties: - cid: - description: The CID of the channel where the draft was created/updated - title: Channel CID - type: string - x-stream-index: 001.001.002 + comment: + $ref: '#/components/schemas/CommentResponse' + description: The comment that was updated + title: Text + x-stream-index: "001" created_at: description: Date/time of creation format: date-time title: Created at type: number - x-stream-index: 001.001.001.003 + x-stream-index: 002.001.003 custom: additionalProperties: {} type: object - x-stream-index: 001.001.001.007 - draft: - $ref: '#/components/schemas/DraftResponse' - description: The draft object which was created/updated - title: Draft - x-stream-index: "001.003" - parent_id: - description: The ID of the parent message - title: Parent ID + x-stream-index: 002.001.007 + feed_visibility: type: string - x-stream-index: "001.002" + x-stream-index: "002.003" + fid: + type: string + x-stream-index: "002.002" received_at: format: date-time type: number - x-stream-index: 001.001.001.004 + x-stream-index: 002.001.004 type: - default: draft.updated - description: 'The type of event: "draft.updated" in this case' + default: feeds.comment.updated + description: 'The type of event: "feeds.comment.updated" in this case' title: Event Type type: string - x-stream-index: 001.001.001.002 + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who updated the comment + title: User + x-stream-index: "003.001" required: + - comment - type - created_at - custom - title: DraftUpdatedEvent + - fid + title: CommentUpdatedEvent 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 - EdgeResponse: + CompositeAppSettings: properties: - continent_code: - type: string - x-stream-index: "007.003" - country_iso_code: - type: string - x-stream-index: "007.002" - green: - format: int32 - type: integer - x-stream-index: "003" - id: - type: string - x-stream-index: "001" - latency_test_url: + json_encoded_settings: type: string - x-stream-index: "002" - latitude: - format: float - type: number - x-stream-index: "006.001" - longitude: - format: float - type: number - x-stream-index: "006.002" - red: - format: int32 - type: integer x-stream-index: "005" - subdivision_iso_code: + url: type: string - x-stream-index: "007.001" - yellow: - format: int32 - type: integer x-stream-index: "004" - required: - - id - - latency_test_url - - green - - yellow - - red - - latitude - - longitude - - subdivision_iso_code - - country_iso_code - - continent_code - type: object - EgressHLSResponse: - properties: - playlist_url: - type: string - x-stream-index: "001" - status: - type: string - x-stream-index: "002" - required: - - playlist_url - - status type: object - EgressRTMPResponse: + ConfigOverrides: properties: - name: - type: string - x-stream-index: "001" - started_at: - format: date-time - type: number - x-stream-index: "004" - stream_key: + blocklist: type: string - x-stream-index: "003" - stream_url: + x-stream-index: "008" + blocklist_behavior: + enum: + - flag + - block type: string - x-stream-index: "002" - required: - - name - - started_at - type: object - EgressResponse: - properties: - broadcasting: + x-stream-index: "009" + commands: + items: + type: string + type: array + x-stream-index: "011" + count_messages: + type: boolean + x-stream-index: "014" + grants: + additionalProperties: + items: + type: string + type: array + type: object + x-stream-index: "010" + max_message_length: + format: int32 + maximum: 20000 + type: integer + x-stream-index: "007" + quotes: type: boolean - x-stream-index: "001" - frame_recording: - $ref: '#/components/schemas/FrameRecordingResponse' x-stream-index: "004" - hls: - $ref: '#/components/schemas/EgressHLSResponse' + reactions: + type: boolean x-stream-index: "002" - rtmps: - items: - $ref: '#/components/schemas/EgressRTMPResponse' - type: array + replies: + type: boolean x-stream-index: "003" - required: - - broadcasting - - rtmps + shared_locations: + type: boolean + x-stream-index: "013" + typing_events: + type: boolean + x-stream-index: "001" + uploads: + type: boolean + x-stream-index: "005" + url_enrichment: + type: boolean + x-stream-index: "006" + user_message_reminders: + type: boolean + x-stream-index: "012" + required: + - grants + - commands type: object - EgressTaskConfig: + ConfigResponse: properties: - egress_user: - $ref: '#/components/schemas/EgressUser' + ai_image_config: + $ref: '#/components/schemas/AIImageConfig' + description: Configuration for AI image analysis + title: AI Image Config + x-stream-index: "010" + ai_text_config: + $ref: '#/components/schemas/AITextConfig' + description: Configuration for AI text analysis + title: AI Text Config x-stream-index: "008" - frame_recording_egress_config: - $ref: '#/components/schemas/FrameRecordingEgressConfig' - x-stream-index: "009" - hls_egress_config: - $ref: '#/components/schemas/HLSEgressConfig' - x-stream-index: "007" - recording_egress_config: - $ref: '#/components/schemas/RecordingEgressConfig' + ai_video_config: + $ref: '#/components/schemas/AIVideoConfig' + description: Configuration for AI video analysis + title: AI Video Config + x-stream-index: "011" + async: + description: Whether moderation should be performed asynchronously + title: Async + type: boolean + x-stream-index: "003" + automod_platform_circumvention_config: + $ref: '#/components/schemas/AutomodPlatformCircumventionConfig' + description: Configuration for platform circumvention detection + title: Automod Platform Circumvention Config + x-stream-index: "005" + automod_semantic_filters_config: + $ref: '#/components/schemas/AutomodSemanticFiltersConfig' + description: Configuration for semantic filtering + title: Automod Semantic Filters Config x-stream-index: "006" - rtmp_egress_config: - $ref: '#/components/schemas/RTMPEgressConfig' + automod_toxicity_config: + $ref: '#/components/schemas/AutomodToxicityConfig' + description: Configuration for toxicity detection + title: Automod Toxicity Config x-stream-index: "004" - stt_egress_config: - $ref: '#/components/schemas/STTEgressConfig' - x-stream-index: "005" - type: object - EgressUser: - properties: - token: + block_list_config: + $ref: '#/components/schemas/BlockListConfig' + description: Configuration for block list filtering + title: Block List Config + x-stream-index: "007" + created_at: + description: When the configuration was created + format: date-time + title: Created At + type: number + x-stream-index: "013" + key: + description: Unique identifier for the moderation configuration + title: Key type: string - x-stream-index: "004" - type: object - EndCallRequest: - description: Request for ending a call - nullable: true - title: EndCallRequest - type: object - EndCallResponse: - description: Response for ending a call - nullable: true - properties: - duration: - description: Duration of the request in milliseconds - title: Duration + x-stream-index: "001" + llm_config: + $ref: '#/components/schemas/LLMConfig' + description: Configuration for customer-configured LLM moderation + title: LLM Config + x-stream-index: "009" + team: + description: Team associated with the configuration + title: Team type: string - x-stream-index: "001.001" + x-stream-index: "002" + updated_at: + description: When the configuration was last updated + format: date-time + title: Updated At + type: number + x-stream-index: "014" + velocity_filter_config: + $ref: '#/components/schemas/VelocityFilterConfig' + description: Configuration for velocity-based filtering + title: Velocity Filter Config + x-stream-index: "012" + video_call_rule_config: + $ref: '#/components/schemas/VideoCallRuleConfig' + x-stream-index: "015" required: - - duration - title: EndCallResponse + - key + - team + - async + - created_at + - updated_at type: object - EnrichedActivity: + ConnectUserDetailsRequest: properties: - actor: - $ref: '#/components/schemas/Data' - x-stream-index: "002" - foreign_id: - type: string - x-stream-index: "005" + custom: + additionalProperties: {} + type: object + x-stream-index: "004" id: type: string x-stream-index: "001" - latest_reactions: - additionalProperties: - items: - $ref: '#/components/schemas/EnrichedReaction' - type: array - type: object - x-stream-index: "013" - object: - $ref: '#/components/schemas/Data' - x-stream-index: "004" - origin: - $ref: '#/components/schemas/Data' - x-stream-index: "008" - own_reactions: - additionalProperties: - items: - $ref: '#/components/schemas/EnrichedReaction' - type: array - type: object - x-stream-index: "012" - reaction_counts: - additionalProperties: - format: int32 - type: integer - type: object - x-stream-index: "011" - score: - format: float - type: number - x-stream-index: "010" - target: - $ref: '#/components/schemas/Data' - x-stream-index: "006" - to: - items: - type: string - type: array - x-stream-index: "009" - verb: + image: type: string x-stream-index: "003" - type: object - EnrichedReaction: - nullable: true - properties: - activity_id: + invisible: + type: boolean + x-stream-index: "006" + language: type: string - x-stream-index: "003" - children_counts: - additionalProperties: - format: int32 - type: integer - type: object - x-stream-index: "010" - created_at: - $ref: '#/components/schemas/Time' - x-stream-index: "012" - data: - additionalProperties: {} - type: object x-stream-index: "005" - id: - type: string - x-stream-index: "001" - kind: + name: type: string x-stream-index: "002" - latest_children: - additionalProperties: - items: - $ref: '#/components/schemas/EnrichedReaction' - type: array - type: object - x-stream-index: "008" - own_children: - additionalProperties: - items: - $ref: '#/components/schemas/EnrichedReaction' - type: array - type: object - x-stream-index: "009" - parent: - type: string + privacy_settings: + $ref: '#/components/schemas/PrivacySettingsResponse' x-stream-index: "007" - target_feeds: - items: - type: string - type: array - x-stream-index: "006" - updated_at: - $ref: '#/components/schemas/Time' - x-stream-index: "013" - user: - $ref: '#/components/schemas/Data' - x-stream-index: "011" - user_id: - type: string - x-stream-index: "004" required: - - kind - - activity_id - - user_id + - id type: object - EntityCreator: + ConnectedEvent: + description: This event is sent when the WS connection is established and authenticated, + this event contains the full user object as it is stored on the server properties: - avg_response_time: - format: int32 - readOnly: true - type: integer - x-stream-index: "001.046" - ban_count: - format: int32 - type: integer - x-stream-index: "002" - ban_expires: - format: date-time - type: number - x-stream-index: "001.017" - banned: - type: boolean - x-stream-index: "001.016" + connection_id: + description: The connection_id for this client + title: Connection ID + type: string + x-stream-index: "002" created_at: format: date-time - readOnly: true - type: number - x-stream-index: "001.008" - custom: - additionalProperties: {} - type: object - x-stream-index: "001.006" - deactivated_at: - format: date-time - readOnly: true - type: number - x-stream-index: "001.014" - deleted_at: - format: date-time - readOnly: true type: number - x-stream-index: "001.013" - deleted_content_count: - format: int32 - type: integer + x-stream-index: "001.002" + me: + $ref: '#/components/schemas/OwnUserResponse' + description: The full user object as it is stored on the server + title: OwnUserResponse x-stream-index: "003" - id: + type: + default: connection.ok + description: 'The type of event: "connection.ok" in this case' + title: Event Type type: string - x-stream-index: "001.003" - invisible: - type: boolean - x-stream-index: "001.023" - language: + x-stream-index: "001.001" + required: + - type + - created_at + - connection_id + - me + title: ConnectedEvent + 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 + ConnectionErrorEvent: + description: This event is sent when the WS connection fails + properties: + connection_id: type: string - x-stream-index: "001.035" - last_active: - format: date-time - readOnly: true - type: number - x-stream-index: "001.011" - last_engaged_at: - format: date-time - readOnly: true - type: number - x-stream-index: "001.012" - online: - readOnly: true - type: boolean - x-stream-index: "001.022" - privacy_settings: - $ref: '#/components/schemas/PrivacySettings' - x-stream-index: "001.026" - revoke_tokens_issued_before: + x-stream-index: "002" + created_at: format: date-time type: number - x-stream-index: "001.042" - role: + x-stream-index: "001.002" + error: + $ref: '#/components/schemas/APIError' + description: The error that caused the connection to fail + title: Error + x-stream-index: "003" + type: + default: connection.error + description: 'The type of event: "connection.ok" in this case' + title: Event Type type: string - x-stream-index: "001.004" - teams: - items: - type: string - type: array - x-stream-index: "001.036" - teams_role: - additionalProperties: - type: string - type: object - x-stream-index: "001.005" - updated_at: - format: date-time - readOnly: true - type: number - x-stream-index: "001.009" + x-stream-index: "001.001" required: - - id - - role - - teams_role - - custom - - banned - - online - - ban_count - - deleted_content_count + - type + - created_at + - connection_id + - error + title: ConnectionErrorEvent type: object - EntityCreatorResponse: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + ContentCountRuleParameters: properties: - avg_response_time: - format: int32 - type: integer - x-stream-index: 001.001.018 - ban_count: - description: Number of minor actions performed on the user + threshold: format: int32 - title: Ban Count type: integer + x-stream-index: "001" + time_window: + type: string x-stream-index: "002" - banned: - type: boolean - x-stream-index: 001.001.012 - blocked_user_ids: - items: - type: string - type: array - x-stream-index: 001.001.017 - created_at: - format: date-time - type: number - x-stream-index: 001.001.009 - custom: - additionalProperties: {} - type: object - x-stream-index: 001.001.004 - deactivated_at: - format: date-time - type: number - x-stream-index: 001.001.016 - deleted_at: - format: date-time - type: number - x-stream-index: 001.001.011 - deleted_content_count: - description: Number of major actions performed on the user - format: int32 - title: Deleted Content Count - type: integer - x-stream-index: "003" - flagged_count: - description: Number of flag actions performed on the user + type: object + CountByMinuteResponse: + nullable: true + properties: + count: format: int32 - title: Flagged Count type: integer - x-stream-index: "004" - id: - type: string - x-stream-index: 001.001.001 - image: - type: string - x-stream-index: 001.001.003 - language: - type: string - x-stream-index: 001.001.005 - last_active: + x-stream-index: "002" + start_ts: format: date-time type: number - x-stream-index: 001.001.014 + x-stream-index: "001" + required: + - start_ts + - count + type: object + CreateBlockListRequest: + description: Block list contains restricted words + nullable: true + properties: name: + description: Block list name + maxLength: 255 + title: Name type: string - x-stream-index: 001.001.002 - online: - type: boolean - x-stream-index: 001.001.013 - revoke_tokens_issued_before: - format: date-time - type: number - x-stream-index: 001.001.015 - role: + x-stream-index: "001" + team: type: string - x-stream-index: 001.001.006 - teams: + x-stream-index: "004" + type: + description: Block list type. + enum: + - regex + - domain + - domain_allowlist + - email + - word + title: Type + type: string + x-stream-index: "003" + words: + description: List of words to block items: type: string + minimum: 1 + title: Words type: array - x-stream-index: 001.001.007 - teams_role: - additionalProperties: - type: string - type: object - x-stream-index: 001.001.008 - updated_at: - format: date-time - type: number - x-stream-index: 001.001.010 + x-stream-index: "002" required: - - id - - custom - - language - - role - - teams - - created_at - - updated_at - - banned - - online - - blocked_user_ids - - shadow_banned - - invisible - - ban_count - - deleted_content_count - - flagged_count - type: object - EventNotificationSettings: - properties: - apns: - $ref: '#/components/schemas/APNS' - x-stream-index: "002" - enabled: - type: boolean - x-stream-index: "001" - fcm: - $ref: '#/components/schemas/FCM' - x-stream-index: "003" - required: - - enabled - - apns - - fcm - type: object - EventRequest: - properties: - custom: - additionalProperties: {} - type: object - x-stream-index: "003" - parent_id: - type: string - x-stream-index: "002" - type: - type: string - x-stream-index: "001" - required: - - type + - name + - words + title: Block list type: object - EventResponse: + x-stream-docs-page-id: block_lists + CreateBlockListResponse: description: Basic response information nullable: true properties: + blocklist: + $ref: '#/components/schemas/BlockListResponse' + x-stream-index: "001" duration: description: Duration of the request in milliseconds title: Duration type: string x-stream-index: "002.001" - event: - $ref: '#/components/schemas/WSEvent' - x-stream-index: "001" required: - - event - duration title: Response type: object - ExternalStorage: + CreateDeviceRequest: + description: Create device request + nullable: true properties: - abs_account_name: - type: string - x-stream-index: "011" - abs_client_id: - type: string - x-stream-index: "013" - abs_client_secret: - type: string - x-stream-index: "014" - abs_tenant_id: - type: string - x-stream-index: "012" - bucket: - type: string - x-stream-index: "005" - gcs_credentials: - type: string - x-stream-index: "010" - path: - type: string - x-stream-index: "006" - s3_api_key: - type: string - x-stream-index: "007" - s3_custom_endpoint: - type: string - x-stream-index: "016" - s3_region: + id: + description: Device ID + maxLength: 255 + minLength: 1 + title: ID type: string - x-stream-index: "009" - s3_secret_key: + x-stream-index: "001" + push_provider: + description: Push provider + enum: + - firebase + - apn + - huawei + - xiaomi + title: PushProvider type: string - x-stream-index: "008" - storage_name: + x-stream-index: "002" + push_provider_name: + description: Push provider name + title: PushProviderName type: string - x-stream-index: "015" - storage_type: - type: integer + x-stream-index: "003" + voip_token: + description: When true the token is for Apple VoIP push notifications + title: VoipToken + type: boolean x-stream-index: "004" + required: + - id + - push_provider + title: CreateDeviceRequest type: object - FCM: + CreateDraftRequest: + nullable: true properties: - data: - additionalProperties: {} - type: object + message: + $ref: '#/components/schemas/MessageRequest' x-stream-index: "001" + required: + - message type: object - Field: + CreateDraftResponse: + description: Basic response information nullable: true properties: - short: - type: boolean - x-stream-index: "003" - title: - type: string + draft: + $ref: '#/components/schemas/DraftResponse' x-stream-index: "001" - value: + duration: + description: Duration of the request in milliseconds + title: Duration type: string - x-stream-index: "002" + x-stream-index: "002.001" required: - - title - - value - - short + - draft + - duration + title: Response type: object - FileUploadConfig: + CreateFeedsBatchRequest: + nullable: true properties: - allowed_file_extensions: + feeds: + description: List of feeds to create items: - type: string + $ref: '#/components/schemas/FeedRequest' + maximum: 1000 + minimum: 1 + title: Feeds type: array x-stream-index: "001" - allowed_mime_types: - items: - type: string - type: array - x-stream-index: "003" - blocked_file_extensions: - items: - type: string - type: array - x-stream-index: "002" - blocked_mime_types: - items: - type: string - type: array - x-stream-index: "004" - size_limit: - format: int32 - maximum: 104857600 - minimum: 0 - type: integer - x-stream-index: "005" required: - - allowed_file_extensions - - blocked_file_extensions - - allowed_mime_types - - blocked_mime_types - - size_limit + - feeds + title: Create Feeds Batch Request type: object - FileUploadRequest: + CreateFeedsBatchResponse: nullable: true properties: - file: - description: file field - title: File + duration: type: string + x-stream-index: "002.001" + feeds: + description: List of created feeds + items: + $ref: '#/components/schemas/FeedResponse' + title: Feeds + type: array x-stream-index: "001" + required: + - feeds + - duration + title: Create Feeds Batch Response + type: object + CreateGuestRequest: + nullable: true + properties: user: - $ref: '#/components/schemas/OnlyUserID' - description: user for the request **server side only** + $ref: '#/components/schemas/UserRequest' + description: User object which server acts upon title: User - x-stream-index: "002" + x-stream-index: "001" + required: + - user type: object - FileUploadResponse: + CreateGuestResponse: nullable: true properties: + access_token: + description: the access token to authenticate the user + title: Access token + type: string + x-stream-index: "002" duration: description: Duration of the request in milliseconds title: Duration type: string x-stream-index: "003.001" - file: - description: URL to the uploaded asset. Should be used to put to `asset_url` - attachment field - title: File - type: string + user: + $ref: '#/components/schemas/UserResponse' + description: User object which server acts upon + title: User x-stream-index: "001" - thumb_url: - description: URL of the file thumbnail for supported file formats. Should - be put to `thumb_url` attachment field - title: Thumbnail URL - type: string - x-stream-index: "002" required: + - user + - access_token - duration type: object - Flag: - description: Contains information about flagged user or message + CreatePollOptionRequest: nullable: true properties: - created_at: - description: Date/time of creation - format: date-time - title: Created at - type: number - x-stream-index: "019" - custom: + Custom: additionalProperties: {} - description: Additional metadata about the flag - title: Custom type: object - x-stream-index: "014" - entity_creator_id: - description: ID of the user who created the flagged entity - title: Entity Creator ID - type: string - x-stream-index: "009" - entity_id: - description: Unique identifier of the entity being flagged - title: Entity ID + writeOnly: true + x-stream-index: "003" + text: + description: Option text + title: string type: string - x-stream-index: "008" - entity_type: - description: Type of entity being flagged (e.g., message, user) - title: Entity Type + x-stream-index: "002" + required: + - text + type: object + CreatePollRequest: + description: Contains all information needed to create a new poll + nullable: true + properties: + Custom: + additionalProperties: {} + type: object + writeOnly: true + x-stream-index: "011" + allow_answers: + description: Indicates whether users can suggest user defined answers + title: Allow answers + type: boolean + x-stream-index: "009" + allow_user_suggested_options: + type: boolean + x-stream-index: "008" + description: + description: A description of the poll + title: Description type: string - x-stream-index: "007" - is_streamed_content: + x-stream-index: "003" + enforce_unique_vote: + description: Indicates whether users can cast multiple votes + title: Multiple choice type: boolean - x-stream-index: "012" - labels: - description: Labels from bodyguard, API calls, our own AI etc - items: - type: string - title: Labels - type: array - x-stream-index: "015" - moderation_payload: - $ref: '#/components/schemas/ModerationPayload' - description: Content being flagged - title: Moderation Payload - x-stream-index: "010" - moderation_payload_hash: + x-stream-index: "006" + id: + maxLength: 255 type: string - x-stream-index: "011" - reason: - description: Optional explanation for why the content is being flagged - title: Reason + x-stream-index: "001" + is_closed: + description: Indicates whether the poll is open for voting + title: Is closed + type: boolean + x-stream-index: "010" + max_votes_allowed: + description: Indicates the maximum amount of votes a user can cast + format: int32 + maximum: 10 + title: Maximum votes allowed + type: integer + x-stream-index: "007" + name: + description: The name of the poll + title: Name type: string - x-stream-index: "013" - result: - description: Result of bodyguard, API calls, our own AI etc + x-stream-index: "002" + options: items: - additionalProperties: {} - type: object - title: Result + $ref: '#/components/schemas/PollOptionInput' + maximum: 100 type: array - x-stream-index: "016" - review_queue_item: - $ref: '#/components/schemas/ReviewQueueItem' - x-stream-index: "018" - review_queue_item_id: - description: ID of the review queue item - title: Review Queue Item ID - type: string - x-stream-index: "017" - type: - type: string x-stream-index: "004" - updated_at: - description: Date/time of the last update + voting_visibility: + enum: + - anonymous + - public + type: string + x-stream-index: "005" + required: + - name + title: Create Poll Request + type: object + CreateReminderRequest: + nullable: true + properties: + remind_at: format: date-time - title: Updated at type: number - x-stream-index: "020" - user: - $ref: '#/components/schemas/User' - description: User who flagged a message or a user - title: User - x-stream-index: "006" - required: - - entity_type - - entity_id - - result - - created_at - - updated_at - title: Flag + x-stream-index: "001" type: object - FlagContentOptions: + Credentials: properties: - reason: - type: string + ice_servers: + items: + $ref: '#/components/schemas/ICEServer' + type: array + x-stream-index: "003" + server: + $ref: '#/components/schemas/SFUResponse' x-stream-index: "001" + token: + type: string + x-stream-index: "002" required: - - reason + - server + - token + - ice_servers type: object - FlagDetails: + CustomActionRequest: properties: - Extra: + id: + type: string + x-stream-index: "001" + options: additionalProperties: {} type: object - writeOnly: true x-stream-index: "002" - automod: - $ref: '#/components/schemas/AutomodDetails' - x-stream-index: "001" - original_text: - type: string - x-stream-index: "003" - required: - - Extra - - original_text type: object - FlagFeedback: + CustomVideoEvent: + description: A custom event, this event is used to send custom events to other + participants in the call. properties: + call_cid: + type: string + x-stream-index: "002.001" created_at: format: date-time type: number - x-stream-index: "005" - labels: - items: - $ref: '#/components/schemas/Label' - type: array - x-stream-index: "006" - message_id: + x-stream-index: "001.002" + custom: + additionalProperties: {} + description: Custom data for this object + title: Custom data + type: object + x-stream-index: "003" + type: + default: custom + description: The type of event, "custom" in this case + title: Event Type type: string + x-stream-index: "001.001" + user: + $ref: '#/components/schemas/UserResponse' x-stream-index: "004" required: - - message_id + - type - created_at - - labels + - call_cid + - custom + - user + title: CustomVideoEvent type: object - FlagMessageDetails: + x-stream-event-call-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + DailyAggregateCallDurationReportResponse: properties: - pin_changed: - type: boolean - x-stream-index: "002" - should_enrich: - type: boolean - x-stream-index: "003" - skip_push: - type: boolean - x-stream-index: "004" - updated_by_id: + date: type: string x-stream-index: "001" + report: + $ref: '#/components/schemas/CallDurationReport' + x-stream-index: "002" + required: + - date + - report type: object - FlagRequest: - nullable: true + DailyAggregateCallParticipantCountReportResponse: properties: - custom: - additionalProperties: {} - description: Additional metadata about the flag - title: Custom - type: object - x-stream-index: "006" - entity_creator_id: - description: ID of the user who created the flagged entity - title: Entity Creator ID - type: string - x-stream-index: "003" - entity_id: - description: Unique identifier of the entity being flagged - title: Entity ID - type: string - x-stream-index: "002" - entity_type: - description: Type of entity being flagged (e.g., message, user) - title: Entity Type + date: type: string x-stream-index: "001" - moderation_payload: - $ref: '#/components/schemas/ModerationPayload' - description: Content being flagged - title: Moderation Payload - x-stream-index: "005" - reason: - description: Optional explanation for why the content is being flagged - maxLength: 255 - title: Reason - type: string - x-stream-index: "004" + report: + $ref: '#/components/schemas/CallParticipantCountReport' + x-stream-index: "002" required: - - entity_type - - entity_id + - date + - report type: object - FlagResponse: - nullable: true + DailyAggregateCallsPerDayReportResponse: properties: - duration: - type: string - x-stream-index: "002.001" - item_id: - description: Unique identifier of the created moderation item - title: Item ID + date: type: string x-stream-index: "001" + report: + $ref: '#/components/schemas/CallsPerDayReport' + x-stream-index: "002" required: - - item_id - - duration + - date + - report type: object - FlagUserOptions: + DailyAggregateQualityScoreReportResponse: properties: - reason: + date: type: string x-stream-index: "001" + report: + $ref: '#/components/schemas/QualityScoreReport' + x-stream-index: "002" required: - - reason + - date + - report type: object - FrameRecordSettings: + DailyAggregateSDKUsageReportResponse: properties: - capture_interval_in_seconds: - format: int32 - maximum: 60 - minimum: 2 - type: integer - x-stream-index: "003" - mode: - enum: - - available - - disabled - - auto-on + date: type: string x-stream-index: "001" - quality: - type: string + report: + $ref: '#/components/schemas/SDKUsageReport' x-stream-index: "002" required: - - mode - - capture_interval_in_seconds - type: object - FrameRecordingEgressConfig: - properties: - capture_interval_in_seconds: - format: int32 - type: integer - x-stream-index: "007" - external_storage: - $ref: '#/components/schemas/ExternalStorage' - x-stream-index: "006" - quality: - $ref: '#/components/schemas/Quality' - x-stream-index: "004" - storage_name: - type: string - x-stream-index: "005" + - date + - report type: object - FrameRecordingResponse: + DailyAggregateUserFeedbackReportResponse: properties: - status: + date: type: string x-stream-index: "001" + report: + $ref: '#/components/schemas/UserFeedbackReport' + x-stream-index: "002" required: - - status + - date + - report type: object - FrameRecordingSettingsRequest: + Data: properties: - capture_interval_in_seconds: - format: int32 - maximum: 60 - minimum: 2 - type: integer - x-stream-index: "003" - mode: - enum: - - available - - disabled - - auto-on + id: type: string x-stream-index: "001" - quality: - enum: - - 360p - - 480p - - 720p - - 1080p - - 1440p - type: string - x-stream-index: "002" required: - - mode - - capture_interval_in_seconds + - id type: object - FrameRecordingSettingsResponse: + DecayFunctionConfig: properties: - capture_interval_in_seconds: - format: int32 - maximum: 60 - minimum: 2 - type: integer - x-stream-index: "003" - mode: - enum: - - available - - disabled - - auto-on + base: type: string x-stream-index: "001" - quality: + decay: + type: string + x-stream-index: "005" + direction: + type: string + x-stream-index: "006" + offset: + type: string + x-stream-index: "004" + origin: type: string x-stream-index: "002" - required: - - mode - - capture_interval_in_seconds + scale: + type: string + x-stream-index: "003" type: object - FullUserResponse: + DeleteActivitiesRequest: + nullable: true properties: - avg_response_time: - format: int32 - type: integer - x-stream-index: "001.018" - ban_expires: - format: date-time - type: number - x-stream-index: "015" - banned: + hard_delete: + description: Whether to permanently delete the activities + title: Hard Delete type: boolean - x-stream-index: "001.012" - blocked_user_ids: + x-stream-index: "002" + ids: + description: List of activity IDs to delete items: type: string + minimum: 1 + title: Activity IDs type: array - x-stream-index: "014" - channel_mutes: - items: - $ref: '#/components/schemas/ChannelMute' - type: array - x-stream-index: "007" - created_at: - format: date-time - type: number - x-stream-index: "001.009" - custom: - additionalProperties: {} - type: object - x-stream-index: "001.004" - deactivated_at: - format: date-time - type: number - x-stream-index: "001.016" - deleted_at: - format: date-time - type: number - x-stream-index: "001.011" - devices: + x-stream-index: "001" + required: + - ids + title: Delete Activities Request + type: object + DeleteActivitiesResponse: + nullable: true + properties: + deleted_ids: + description: List of activity IDs that were successfully deleted items: - $ref: '#/components/schemas/DeviceResponse' + type: string + title: Deleted Activity IDs type: array - x-stream-index: "004" - id: + x-stream-index: "001" + duration: type: string - x-stream-index: "001.001" - image: + x-stream-index: "002.001" + required: + - deleted_ids + - duration + title: Delete Activities Response + type: object + DeleteActivityReactionResponse: + nullable: true + properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + x-stream-index: "001" + duration: type: string - x-stream-index: "001.003" - invisible: + x-stream-index: "003.001" + reaction: + $ref: '#/components/schemas/FeedsReactionResponse' + x-stream-index: "002" + required: + - activity + - reaction + - duration + title: Delete Activity Reaction Response + type: object + DeleteActivityRequest: + properties: + hard_delete: type: boolean - x-stream-index: "005" - language: + x-stream-index: "001" + type: object + DeleteActivityResponse: + nullable: true + properties: + duration: type: string - x-stream-index: "001.005" - last_active: - format: date-time - type: number - x-stream-index: "001.014" - latest_hidden_channels: - items: - type: string - type: array - x-stream-index: "012" - mutes: - items: - $ref: '#/components/schemas/UserMuteResponse' - type: array - x-stream-index: "006" - name: + x-stream-index: "001.001" + required: + - duration + title: Delete Activity Response + type: object + DeleteBookmarkFolderResponse: + nullable: true + properties: + duration: type: string - x-stream-index: "001.002" - online: - type: boolean - x-stream-index: "001.013" - privacy_settings: - $ref: '#/components/schemas/PrivacySettingsResponse' - x-stream-index: "003" - revoke_tokens_issued_before: - format: date-time - type: number - x-stream-index: "001.015" - role: + x-stream-index: "001.001" + required: + - duration + title: Delete Bookmark Folder Response + type: object + DeleteBookmarkResponse: + nullable: true + properties: + bookmark: + $ref: '#/components/schemas/BookmarkResponse' + description: The deleted bookmark + title: Bookmark + x-stream-index: "001" + duration: type: string - x-stream-index: "001.006" - shadow_banned: - type: boolean - x-stream-index: "013" - teams: - items: - type: string - type: array - x-stream-index: "001.007" - teams_role: - additionalProperties: - type: string - type: object - x-stream-index: "001.008" - total_unread_count: - format: int32 - type: integer - x-stream-index: "009" - unread_channels: - format: int32 - type: integer - x-stream-index: "010" - unread_count: - format: int32 - type: integer - x-stream-index: "008" - unread_threads: - format: int32 - type: integer - x-stream-index: "011" - updated_at: - format: date-time - type: number - x-stream-index: "001.010" - required: - - id - - custom - - language - - role - - teams - - created_at - - updated_at - - banned - - online - - devices - - invisible - - mutes - - channel_mutes - - unread_count - - total_unread_count - - unread_channels - - unread_threads - - shadow_banned - - blocked_user_ids - type: object - GeofenceSettings: - properties: - names: - items: - type: string - type: array - x-stream-index: "001" + x-stream-index: "002.001" required: - - names + - bookmark + - duration + title: Delete Bookmark Response type: object - GeofenceSettingsRequest: + DeleteCallRequest: + description: DeleteCallRequest is the payload for deleting a call. + nullable: true properties: - names: - items: - type: string - type: array + hard: + description: if true the call will be hard deleted along with all related + data + title: Hard + type: boolean x-stream-index: "001" + title: DeleteCallRequest type: object - GeofenceSettingsResponse: + DeleteCallResponse: + description: DeleteCallResponse is the payload for deleting a call. + nullable: true properties: - names: - items: - type: string - type: array + call: + $ref: '#/components/schemas/CallResponse' + title: Call x-stream-index: "001" + duration: + type: string + x-stream-index: "003.001" + task_id: + title: TaskID + type: string + x-stream-index: "002" required: - - names + - call + - duration + title: DeleteCallResponse type: object - GetApplicationResponse: + DeleteChannelResponse: description: Basic response information nullable: true properties: - app: - $ref: '#/components/schemas/AppResponseFields' - x-stream-index: "001" + channel: + $ref: '#/components/schemas/ChannelResponse' + x-stream-index: "002" duration: description: Duration of the request in milliseconds title: Duration type: string - x-stream-index: "002.001" + x-stream-index: "001.001" required: - - app - duration title: Response type: object - GetBlockedUsersResponse: + DeleteChannelsRequest: nullable: true properties: - blocks: - description: Array of blocked user object + cids: + description: All channels that should be deleted items: - $ref: '#/components/schemas/BlockedUserResponse' - title: Blocks + type: string + maximum: 100 + minimum: 1 + title: Channels CID type: array x-stream-index: "001" - duration: - description: Duration of the request in milliseconds - title: Duration - type: string - x-stream-index: "002.001" + hard_delete: + description: Specify if channels and all ressources should be hard deleted + title: Hard delete + type: boolean + x-stream-index: "002" required: - - blocks - - duration + - cids type: object - GetCallReportResponse: - description: Basic response information + DeleteChannelsResponse: nullable: true properties: - chat_activity: - $ref: '#/components/schemas/ChatActivityStatsResponse' - x-stream-index: "004" duration: description: Duration of the request in milliseconds title: Duration type: string - x-stream-index: "001.001" - report: - $ref: '#/components/schemas/ReportResponse' - x-stream-index: "003" - session_id: + x-stream-index: "003.001" + result: + additionalProperties: + $ref: '#/components/schemas/DeleteChannelsResultResponse' + description: Map of channel IDs and their deletion results + title: Result + type: object + x-stream-index: "001" + task_id: type: string x-stream-index: "002" - video_reactions: - items: - $ref: '#/components/schemas/VideoReactionsResponse' - type: array - x-stream-index: "005" required: - duration - - session_id - - report - title: Response type: object - GetCallResponse: + DeleteChannelsResultResponse: nullable: true properties: - call: - $ref: '#/components/schemas/CallResponse' - x-stream-index: "001.001" + error: + type: string + x-stream-index: "002" + status: + type: string + x-stream-index: "001" + required: + - status + type: object + DeleteCommentReactionResponse: + nullable: true + properties: + comment: + $ref: '#/components/schemas/CommentResponse' + description: The comment after reaction removal + title: Comment + x-stream-index: "001" duration: type: string - x-stream-index: "002.001" - members: - items: - $ref: '#/components/schemas/MemberResponse' - type: array - x-stream-index: "001.002" - membership: - $ref: '#/components/schemas/MemberResponse' - x-stream-index: "001.003" - own_capabilities: - items: - $ref: '#/components/schemas/OwnCapability' - type: array - x-stream-index: "001.004" + x-stream-index: "003.001" + reaction: + $ref: '#/components/schemas/FeedsReactionResponse' + description: The removed reaction + title: Reaction + x-stream-index: "002" required: - - call - - members - - own_capabilities - - blocked_users + - comment + - reaction - duration - title: GetCallResponse + title: Delete Comment Reaction Response type: object - GetConfigResponse: + DeleteCommentResponse: nullable: true properties: - config: - $ref: '#/components/schemas/ConfigResponse' - description: The retrieved moderation configuration - title: Config - x-stream-index: "001" duration: type: string - x-stream-index: "002.001" + x-stream-index: "001.001" required: - duration + title: Delete Comment Response type: object - GetDraftResponse: - description: Basic response information + DeleteFeedResponse: nullable: true properties: - draft: - $ref: '#/components/schemas/DraftResponse' - x-stream-index: "001" duration: - description: Duration of the request in milliseconds - title: Duration type: string - x-stream-index: "002.001" + x-stream-index: "001.001" required: - - draft - duration - title: Response + title: Delete Feed Response type: object - GetEdgesResponse: + DeleteMessageRequest: + properties: + hard_delete: + type: boolean + x-stream-index: "001" + type: object + DeleteMessageResponse: description: Basic response information nullable: true properties: @@ -8443,34 +9403,30 @@ components: title: Duration type: string x-stream-index: "002.001" - edges: - items: - $ref: '#/components/schemas/EdgeResponse' - type: array + message: + $ref: '#/components/schemas/MessageResponse' x-stream-index: "001" required: - - edges + - message - duration title: Response type: object - GetManyMessagesResponse: + DeleteModerationConfigResponse: nullable: true properties: duration: type: string - x-stream-index: 001.002.001 - messages: - description: List of messages - items: - $ref: '#/components/schemas/MessageResponse' - title: Messages - type: array x-stream-index: "001.001" required: - - messages - duration type: object - GetMessageResponse: + DeleteReactionRequest: + properties: + hard_delete: + type: boolean + x-stream-index: "001" + type: object + DeleteReactionResponse: description: Basic response information nullable: true properties: @@ -8480,203 +9436,31 @@ components: type: string x-stream-index: "003.001" message: - $ref: '#/components/schemas/MessageWithChannelResponse' + $ref: '#/components/schemas/MessageResponse' x-stream-index: "001" - pending_message_metadata: - additionalProperties: - type: string - type: object + reaction: + $ref: '#/components/schemas/ReactionResponse' x-stream-index: "002" required: - message + - reaction - duration title: Response type: object - GetOGResponse: + DeleteRecordingResponse: + description: Response for DeleteRecording nullable: true properties: - actions: - items: - $ref: '#/components/schemas/Action' - type: array - x-stream-index: "001.015" - asset_url: - description: URL of detected video or audio - title: Image URL - type: string - x-stream-index: "001.017" - author_icon: - type: string - x-stream-index: "001.007" - author_link: - description: og:site - title: Author Link - type: string - x-stream-index: "001.006" - author_name: - description: og:site_name - title: Author Name - type: string - x-stream-index: "001.005" - color: - type: string - x-stream-index: "001.003" - custom: - additionalProperties: {} - type: object - x-stream-index: "001.018" duration: + description: Duration of the request in milliseconds + title: Duration type: string - x-stream-index: "002.001" - fallback: - type: string - x-stream-index: "001.002" - fields: - items: - $ref: '#/components/schemas/Field' - type: array - x-stream-index: "001.016" - footer: - type: string - x-stream-index: "001.013" - footer_icon: - type: string - x-stream-index: "001.014" - giphy: - $ref: '#/components/schemas/Images' - x-stream-index: "001.019" - image_url: - description: URL of detected image - title: Image URL - type: string - x-stream-index: "001.011" - og_scrape_url: - description: extracted url from the text - title: OG Scrape URL - type: string - x-stream-index: "001.020" - original_height: - format: int32 - type: integer - x-stream-index: "001.022" - original_width: - format: int32 - type: integer - x-stream-index: "001.021" - pretext: - type: string - x-stream-index: "001.004" - text: - description: og:description - title: Text - type: string - x-stream-index: "001.010" - thumb_url: - description: URL of detected thumb image - title: Image URL - type: string - x-stream-index: "001.012" - title: - description: og:title - title: Title - type: string - x-stream-index: "001.008" - title_link: - description: og:url - title: Title Link - type: string - x-stream-index: "001.009" - type: - description: Attachment type, could be empty, image, audio or video - title: Type - type: string - x-stream-index: "001.001" - required: - - custom - - duration - title: Get OG Attachment - type: object - x-stream-docs-page-id: og - GetOrCreateCallRequest: - nullable: true - properties: - data: - $ref: '#/components/schemas/CallRequest' - title: ReadOnlyData - x-stream-index: "003" - members_limit: - format: int32 - maximum: 100 - type: integer - x-stream-index: "007" - notify: - description: if provided it sends a notification event to the members for - this call - title: Notify - type: boolean - x-stream-index: "005" - ring: - description: if provided it sends a ring event to the members for this call - title: Ring - type: boolean - x-stream-index: "004" - video: - type: boolean - x-stream-index: "006" - title: GetOrCreateCallRequest - type: object - GetOrCreateCallResponse: - nullable: true - properties: - call: - $ref: '#/components/schemas/CallResponse' x-stream-index: "001.001" - created: - type: boolean - x-stream-index: "002" - duration: - type: string - x-stream-index: "003.001" - members: - items: - $ref: '#/components/schemas/MemberResponse' - type: array - x-stream-index: "001.002" - membership: - $ref: '#/components/schemas/MemberResponse' - x-stream-index: "001.003" - own_capabilities: - items: - $ref: '#/components/schemas/OwnCapability' - type: array - x-stream-index: "001.004" required: - - call - - members - - own_capabilities - - blocked_users - - created - - duration - title: GetOrCreateCallResponse - type: object - GetReactionsResponse: - nullable: true - properties: - duration: - type: string - x-stream-index: "002.001" - reactions: - description: List of reactions - items: - $ref: '#/components/schemas/Reaction' - title: Reactions - type: array - x-stream-index: "001" - required: - - reactions - duration + title: DeleteRecordingResponse type: object - GetRepliesResponse: + DeleteReminderResponse: description: Basic response information nullable: true properties: @@ -8684,4030 +9468,4031 @@ components: description: Duration of the request in milliseconds title: Duration type: string - x-stream-index: "002.001" - messages: - items: - $ref: '#/components/schemas/MessageResponse' - type: array - x-stream-index: "001" + x-stream-index: "001.001" required: - - messages - duration title: Response type: object - GetThreadResponse: + DeleteTranscriptionResponse: + description: DeleteTranscriptionResponse is the payload for deleting a transcription. nullable: true properties: duration: + description: Duration of the request in milliseconds + title: Duration type: string - x-stream-index: "002.001" - thread: - $ref: '#/components/schemas/ThreadStateResponse' - description: Enriched thread state - title: Thread - x-stream-index: "001" + x-stream-index: "001.001" required: - - thread - duration + title: DeleteTranscriptionResponse type: object - GoLiveRequest: - nullable: true + DeleteUserRequest: properties: - recording_storage_name: - type: string - x-stream-index: "005" - start_closed_caption: - type: boolean - x-stream-index: "008" - start_hls: + delete_conversation_channels: type: boolean x-stream-index: "003" - start_recording: + delete_feeds_content: type: boolean x-stream-index: "004" - start_transcription: + hard_delete: type: boolean - x-stream-index: "007" - transcription_storage_name: - type: string - x-stream-index: "006" - title: GoLiveRequest - type: object - GoLiveResponse: - description: Basic response information - nullable: true - properties: - call: - $ref: '#/components/schemas/CallResponse' x-stream-index: "001" - duration: - description: Duration of the request in milliseconds - title: Duration - type: string - x-stream-index: "002.001" - required: - - call - - duration - title: Response - type: object - GoogleVisionConfig: - properties: - enabled: + mark_messages_deleted: type: boolean - x-stream-index: "001" + x-stream-index: "002" type: object - GroupedStatsResponse: + Device: nullable: true properties: - name: - type: string - x-stream-index: "001" - unique: - format: int32 - type: integer - x-stream-index: "002" - required: - - name - - unique - type: object - HLSEgressConfig: - properties: - composite_app_settings: - $ref: '#/components/schemas/CompositeAppSettings' - x-stream-index: "005" - playlist_url: - type: string - x-stream-index: "007" - qualities: - items: - $ref: '#/components/schemas/Quality' - type: array - x-stream-index: "004" - start_unix_nano: - format: int64 - type: integer - x-stream-index: "006" - type: object - HLSSettings: - properties: - auto_on: - type: boolean - x-stream-index: "001" - enabled: + created_at: + format: date-time + type: number + x-stream-index: "002.002" + disabled: type: boolean - x-stream-index: "002" - layout: - $ref: '#/components/schemas/LayoutSettings' + x-stream-index: "002.003" + disabled_reason: + type: string + x-stream-index: "002.004" + id: + type: string + x-stream-index: 002.001.004 + push_provider: + enum: + - firebase + - apn + - huawei + - xiaomi + type: string + x-stream-index: 002.001.001 + push_provider_name: + type: string + x-stream-index: 002.001.003 + user_id: + type: string x-stream-index: "004" - quality_tracks: - items: - type: string - type: array - x-stream-index: "003" - required: - - auto_on - - enabled - - quality_tracks - type: object - HLSSettingsRequest: - properties: - auto_on: - type: boolean - x-stream-index: "001" - enabled: + voip: type: boolean - x-stream-index: "002" - quality_tracks: - items: - type: string - maximum: 3 - minimum: 1 - type: array - x-stream-index: "003" + x-stream-index: 002.001.005 required: - - quality_tracks - title: HLSSettingsRequest + - push_provider + - id + - created_at + - user_id type: object - HLSSettingsResponse: - description: HLSSettings is the payload for HLS settings + DeviceResponse: + description: Response for Device + nullable: true properties: - auto_on: - title: Auto On - type: boolean - x-stream-index: "001" - enabled: - title: Enabled + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: "004" + disabled: + description: Whether device is disabled or not + title: Disabled type: boolean - x-stream-index: "002" - quality_tracks: - items: - type: string - title: Quality Tracks - type: array + x-stream-index: "005" + disabled_reason: + description: Reason explaining why device had been disabled + title: Reason + type: string + x-stream-index: "006" + id: + description: Device ID + title: ID + type: string x-stream-index: "003" - required: - - auto_on - - enabled - - quality_tracks - - layout - title: HLSSettingsResponse - type: object - HarmConfig: - properties: - action_sequences: - items: - $ref: '#/components/schemas/ActionSequence' - type: array + push_provider: + description: Push provider + title: PushProvider + type: string x-stream-index: "001" - severity: - type: integer + push_provider_name: + description: Push provider name + title: PushProviderName + type: string x-stream-index: "002" + user_id: + description: User ID + title: UserID + type: string + x-stream-index: "008" + voip: + description: When true the token is for Apple VoIP push notifications + title: Voip + type: boolean + x-stream-index: "007" required: - - action_sequences - - severity + - push_provider + - id + - created_at + - user_id + title: DeviceResponse type: object - HealthCheckEvent: + DraftDeletedEvent: + description: Emitted when a Draft is deleted. nullable: true properties: cid: + description: The CID of the channel where the draft was created + title: Channel CID type: string - x-stream-index: "003" - connection_id: - type: string - x-stream-index: "001" + x-stream-index: 001.001.002 created_at: + description: Date/time of creation format: date-time + title: Created at type: number - x-stream-index: "004.003" + x-stream-index: 001.001.001.003 custom: additionalProperties: {} type: object - x-stream-index: "004.007" - me: - $ref: '#/components/schemas/OwnUserResponse' - x-stream-index: "002" + x-stream-index: 001.001.001.007 + draft: + $ref: '#/components/schemas/DraftResponse' + x-stream-index: "001.003" + parent_id: + description: The ID of the parent message + title: Message ID + type: string + x-stream-index: "001.002" received_at: format: date-time type: number - x-stream-index: "004.004" + x-stream-index: 001.001.001.004 type: - default: health.check + default: draft.deleted + description: 'The type of event: "draft.deleted" in this case' + title: Event Type type: string - x-stream-index: "004.002" + x-stream-index: 001.001.001.002 required: - - connection_id - type - created_at - custom - title: HealthCheckEvent + title: DraftDeletedEvent 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 - HideChannelRequest: - nullable: true - properties: - clear_history: - description: Whether to clear message history of the channel or not - title: Clear history - type: boolean - x-stream-index: "001" - type: object - HideChannelResponse: - description: Basic response information - nullable: true + DraftPayloadResponse: properties: - duration: - description: Duration of the request in milliseconds - title: Duration + attachments: + items: + $ref: '#/components/schemas/Attachment' + type: array + x-stream-index: "004" + custom: + additionalProperties: {} + type: object + x-stream-index: "007" + html: type: string - x-stream-index: "001.001" - required: - - duration - title: Response - type: object - ICEServer: - properties: - password: + x-stream-index: "010" + id: type: string - x-stream-index: "003" - urls: + x-stream-index: "001" + mentioned_users: items: - type: string + $ref: '#/components/schemas/UserResponse' type: array - x-stream-index: "001" - username: + x-stream-index: "008" + mml: type: string - x-stream-index: "002" - required: - - urls - - username - - password - type: object - ImageContentParameters: - properties: - harm_labels: - items: - type: string - type: array - x-stream-index: "001" - type: object - ImageData: - properties: - frames: + x-stream-index: "003" + parent_id: type: string x-stream-index: "005" - height: - type: string - x-stream-index: "003" - size: + poll_id: type: string - x-stream-index: "004" - url: + x-stream-index: "013" + quoted_message_id: type: string - x-stream-index: "001" - width: + x-stream-index: "009" + show_in_channel: + type: boolean + x-stream-index: "006" + silent: + type: boolean + x-stream-index: "012" + text: type: string x-stream-index: "002" + type: + type: string + x-stream-index: "011" required: - - url - - width - - height - - size - - frames + - id + - text + - custom type: object - ImageRuleParameters: + DraftResponse: properties: - harm_labels: - items: - type: string - type: array + channel: + $ref: '#/components/schemas/ChannelResponse' x-stream-index: "003" - threshold: - format: int32 - type: integer - x-stream-index: "001" - time_window: + channel_cid: type: string x-stream-index: "002" + created_at: + format: date-time + type: number + x-stream-index: "007" + message: + $ref: '#/components/schemas/DraftPayloadResponse' + x-stream-index: "001" + parent_id: + type: string + x-stream-index: "004" + parent_message: + $ref: '#/components/schemas/MessageResponse' + x-stream-index: "005" + quoted_message: + $ref: '#/components/schemas/MessageResponse' + x-stream-index: "006" required: - - threshold - - time_window + - message + - channel_cid + - created_at type: object - ImageSize: + DraftUpdatedEvent: + description: Emitted when a Draft is created or updated. + nullable: true properties: - crop: - description: Crop mode - enum: - - top - - bottom - - left - - right - - center - title: Crop + cid: + description: The CID of the channel where the draft was created/updated + title: Channel CID type: string - x-stream-index: "001" - height: - description: Target image height + x-stream-index: 001.001.002 + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 001.001.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 001.001.001.007 + draft: + $ref: '#/components/schemas/DraftResponse' + description: The draft object which was created/updated + title: Draft + x-stream-index: "001.003" + parent_id: + description: The ID of the parent message + title: Parent ID + type: string + x-stream-index: "001.002" + received_at: + format: date-time + type: number + x-stream-index: 001.001.001.004 + type: + default: draft.updated + description: 'The type of event: "draft.updated" in this case' + title: Event Type + type: string + x-stream-index: 001.001.001.002 + required: + - type + - created_at + - custom + title: DraftUpdatedEvent + 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 + EdgeResponse: + properties: + continent_code: + type: string + x-stream-index: "007.003" + country_iso_code: + type: string + x-stream-index: "007.002" + green: format: int32 - title: Height type: integer x-stream-index: "003" - resize: - description: Resize method - enum: - - clip - - crop - - scale - - fill - title: Resize + id: + type: string + x-stream-index: "001" + latency_test_url: type: string x-stream-index: "002" - width: - description: Target image width + latitude: + format: float + type: number + x-stream-index: "006.001" + longitude: + format: float + type: number + x-stream-index: "006.002" + red: + format: int32 + type: integer + x-stream-index: "005" + subdivision_iso_code: + type: string + x-stream-index: "007.001" + yellow: format: int32 - title: Width type: integer x-stream-index: "004" - title: Image size configuration + required: + - id + - latency_test_url + - green + - yellow + - red + - latitude + - longitude + - subdivision_iso_code + - country_iso_code + - continent_code type: object - ImageUploadRequest: - nullable: true + EgressHLSResponse: properties: - file: + playlist_url: + type: string + x-stream-index: "001" + status: type: string - x-stream-index: "001.001" - upload_sizes: - description: field with JSON-encoded array of image size configurations - items: - $ref: '#/components/schemas/ImageSize' - title: Upload sizes - type: array x-stream-index: "002" - user: - $ref: '#/components/schemas/OnlyUserID' - x-stream-index: "001.002" + required: + - playlist_url + - status type: object - ImageUploadResponse: - nullable: true + EgressRTMPResponse: properties: - duration: - description: Duration of the request in milliseconds - title: Duration + name: type: string - x-stream-index: 001.003.001 - file: + x-stream-index: "001" + started_at: + format: date-time + type: number + x-stream-index: "004" + stream_key: type: string - x-stream-index: "001.001" - thumb_url: + x-stream-index: "003" + stream_url: type: string - x-stream-index: "001.002" - upload_sizes: - description: Array of image size configurations - items: - $ref: '#/components/schemas/ImageSize' - title: Upload sizes - type: array x-stream-index: "002" required: - - duration + - name + - started_at type: object - Images: + EgressResponse: properties: - fixed_height: - $ref: '#/components/schemas/ImageData' - x-stream-index: "002" - fixed_height_downsampled: - $ref: '#/components/schemas/ImageData' + broadcasting: + type: boolean + x-stream-index: "001" + frame_recording: + $ref: '#/components/schemas/FrameRecordingResponse' x-stream-index: "004" - fixed_height_still: - $ref: '#/components/schemas/ImageData' + hls: + $ref: '#/components/schemas/EgressHLSResponse' + x-stream-index: "002" + rtmps: + items: + $ref: '#/components/schemas/EgressRTMPResponse' + type: array x-stream-index: "003" - fixed_width: - $ref: '#/components/schemas/ImageData' - x-stream-index: "005" - fixed_width_downsampled: - $ref: '#/components/schemas/ImageData' - x-stream-index: "007" - fixed_width_still: - $ref: '#/components/schemas/ImageData' - x-stream-index: "006" - original: - $ref: '#/components/schemas/ImageData' - x-stream-index: "001" required: - - original - - fixed_height - - fixed_height_still - - fixed_height_downsampled - - fixed_width - - fixed_width_still - - fixed_width_downsampled + - broadcasting + - rtmps type: object - IngressAudioEncodingOptions: + EgressTaskConfig: properties: - bitrate: - maximum: 128000 - minimum: 16000 - type: integer - x-stream-index: "003" - channels: - enum: - - "1" - - "2" - format: int32 - type: integer - x-stream-index: "001" - enable_dtx: - type: boolean - x-stream-index: "002" - required: - - channels - - enable_dtx - - bitrate + egress_user: + $ref: '#/components/schemas/EgressUser' + x-stream-index: "008" + frame_recording_egress_config: + $ref: '#/components/schemas/FrameRecordingEgressConfig' + x-stream-index: "009" + hls_egress_config: + $ref: '#/components/schemas/HLSEgressConfig' + x-stream-index: "007" + recording_egress_config: + $ref: '#/components/schemas/RecordingEgressConfig' + x-stream-index: "006" + rtmp_egress_config: + $ref: '#/components/schemas/RTMPEgressConfig' + x-stream-index: "004" + stt_egress_config: + $ref: '#/components/schemas/STTEgressConfig' + x-stream-index: "005" type: object - IngressAudioEncodingOptionsRequest: + EgressUser: properties: - bitrate: - maximum: 128000 - minimum: 16000 - type: integer - x-stream-index: "003" - channels: - enum: - - "1" - - "2" - format: int32 - type: integer - x-stream-index: "001" - enable_dtx: - type: boolean - x-stream-index: "002" - required: - - channels - - bitrate + token: + type: string + x-stream-index: "004" type: object - IngressAudioEncodingResponse: + EndCallRequest: + description: Request for ending a call + nullable: true + title: EndCallRequest + type: object + EndCallResponse: + description: Response for ending a call + nullable: true properties: - bitrate: - format: int32 - type: integer - x-stream-index: "003" - channels: - format: int32 - type: integer - x-stream-index: "001" - enable_dtx: - type: boolean - x-stream-index: "002" + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "001.001" required: - - channels - - enable_dtx - - bitrate + - duration + title: EndCallResponse type: object - IngressSettings: + EnrichedActivity: properties: - audio_encoding_options: - $ref: '#/components/schemas/IngressAudioEncodingOptions' + actor: + $ref: '#/components/schemas/Data' x-stream-index: "002" - enabled: - type: boolean + foreign_id: + type: string + x-stream-index: "005" + id: + type: string x-stream-index: "001" - video_encoding_options: + latest_reactions: additionalProperties: - $ref: '#/components/schemas/IngressVideoEncodingOptions' + items: + $ref: '#/components/schemas/EnrichedReaction' + type: array type: object - x-stream-index: "003" - required: - - enabled - type: object - IngressSettingsRequest: - properties: - audio_encoding_options: - $ref: '#/components/schemas/IngressAudioEncodingOptionsRequest' - x-stream-index: "002" - enabled: - type: boolean - x-stream-index: "001" - video_encoding_options: + x-stream-index: "013" + object: + $ref: '#/components/schemas/Data' + x-stream-index: "004" + origin: + $ref: '#/components/schemas/Data' + x-stream-index: "008" + own_reactions: additionalProperties: - $ref: '#/components/schemas/IngressVideoEncodingOptionsRequest' + items: + $ref: '#/components/schemas/EnrichedReaction' + type: array type: object - x-stream-index: "003" - type: object - IngressSettingsResponse: - properties: - audio_encoding_options: - $ref: '#/components/schemas/IngressAudioEncodingResponse' - x-stream-index: "002" - enabled: - type: boolean - x-stream-index: "001" - video_encoding_options: + x-stream-index: "012" + reaction_counts: additionalProperties: - $ref: '#/components/schemas/IngressVideoEncodingResponse' + format: int32 + type: integer type: object - x-stream-index: "003" - required: - - enabled - type: object - IngressVideoEncodingOptions: - properties: - layers: - items: - $ref: '#/components/schemas/IngressVideoLayer' - minimum: 1 - type: array - x-stream-index: "001" - required: - - layers - type: object - IngressVideoEncodingOptionsRequest: - properties: - layers: - items: - $ref: '#/components/schemas/IngressVideoLayerRequest' - minimum: 1 - type: array - x-stream-index: "001" - required: - - layers - type: object - IngressVideoEncodingResponse: - properties: - layers: + x-stream-index: "011" + score: + format: float + type: number + x-stream-index: "010" + target: + $ref: '#/components/schemas/Data' + x-stream-index: "006" + to: items: - $ref: '#/components/schemas/IngressVideoLayerResponse' + type: string type: array - x-stream-index: "001" - required: - - layers + x-stream-index: "009" + verb: + type: string + x-stream-index: "003" type: object - IngressVideoLayer: + EnrichedReaction: nullable: true properties: - bitrate: - minimum: 1000 - type: integer - x-stream-index: "002" - codec: - enum: - - h264 - - vp8 + activity_id: type: string - x-stream-index: "001" - frame_rate: - maximum: 60 - minimum: 1 - type: integer x-stream-index: "003" - max_dimension: - minimum: 240 - type: integer - x-stream-index: "005" - min_dimension: - minimum: 240 - type: integer - x-stream-index: "004" - required: - - codec - - bitrate - - frame_rate - - min_dimension - - max_dimension - type: object - IngressVideoLayerRequest: - nullable: true - properties: - bitrate: - format: int32 - minimum: 1000 - type: integer - x-stream-index: "002" - codec: - enum: - - h264 - - vp8 - type: string - x-stream-index: "001" - frame_rate_limit: - maximum: 60 - minimum: 1 - type: integer + children_counts: + additionalProperties: + format: int32 + type: integer + type: object + x-stream-index: "010" + created_at: + $ref: '#/components/schemas/Time' + x-stream-index: "012" + data: + additionalProperties: {} + type: object x-stream-index: "005" - max_dimension: - minimum: 240 - type: integer - x-stream-index: "004" - min_dimension: - minimum: 240 - type: integer - x-stream-index: "003" - required: - - codec - - bitrate - - min_dimension - - max_dimension - - frame_rate_limit - type: object - IngressVideoLayerResponse: - nullable: true - properties: - bitrate: - type: integer - x-stream-index: "002" - codec: + id: type: string x-stream-index: "001" - frame_rate_limit: - type: integer - x-stream-index: "005" - max_dimension: - type: integer - x-stream-index: "004" - min_dimension: - type: integer - x-stream-index: "003" - required: - - codec - - bitrate - - min_dimension - - max_dimension - - frame_rate_limit - type: object - JoinCallRequest: - nullable: true - properties: - create: - description: if true the call will be created if it doesn't exist - title: Create - type: boolean - x-stream-index: "002" - data: - $ref: '#/components/schemas/CallRequest' - x-stream-index: "003" - location: - title: Location + kind: type: string + x-stream-index: "002" + latest_children: + additionalProperties: + items: + $ref: '#/components/schemas/EnrichedReaction' + type: array + type: object + x-stream-index: "008" + own_children: + additionalProperties: + items: + $ref: '#/components/schemas/EnrichedReaction' + type: array + type: object x-stream-index: "009" - members_limit: - format: int32 - maximum: 100 - title: The amount of members that should be returned - type: integer + parent: + type: string x-stream-index: "007" - migrating_from: - description: If the participant is migrating from another SFU, then this - is the ID of the previous SFU - title: MigratingFrom + target_feeds: + items: + type: string + type: array + x-stream-index: "006" + updated_at: + $ref: '#/components/schemas/Time' + x-stream-index: "013" + user: + $ref: '#/components/schemas/Data' + x-stream-index: "011" + user_id: type: string - x-stream-index: "010" - notify: - type: boolean - x-stream-index: "005" - ring: - description: if true and the call is created, the notification will include - ring=true - title: Ring - type: boolean x-stream-index: "004" - video: - type: boolean - x-stream-index: "006" required: - - location - title: JoinCallRequest + - kind + - activity_id + - user_id type: object - JoinCallResponse: - nullable: true + EntityCreator: properties: - call: - $ref: '#/components/schemas/CallResponse' - x-stream-index: "001.001" - created: - title: Created - type: boolean + avg_response_time: + format: int32 + readOnly: true + type: integer + x-stream-index: "001.046" + ban_count: + format: int32 + type: integer x-stream-index: "002" - credentials: - $ref: '#/components/schemas/Credentials' - title: Credentials + ban_expires: + format: date-time + type: number + x-stream-index: "001.017" + banned: + type: boolean + x-stream-index: "001.016" + created_at: + format: date-time + readOnly: true + type: number + x-stream-index: "001.008" + custom: + additionalProperties: {} + type: object + x-stream-index: "001.006" + deactivated_at: + format: date-time + readOnly: true + type: number + x-stream-index: "001.014" + deleted_at: + format: date-time + readOnly: true + type: number + x-stream-index: "001.013" + deleted_content_count: + format: int32 + type: integer x-stream-index: "003" - duration: + id: type: string - x-stream-index: "005.001" - members: - items: - $ref: '#/components/schemas/MemberResponse' - type: array - x-stream-index: "001.002" - membership: - $ref: '#/components/schemas/MemberResponse' x-stream-index: "001.003" - own_capabilities: - items: - $ref: '#/components/schemas/OwnCapability' - type: array + invisible: + type: boolean + x-stream-index: "001.023" + language: + type: string + x-stream-index: "001.035" + last_active: + format: date-time + readOnly: true + type: number + x-stream-index: "001.011" + last_engaged_at: + format: date-time + readOnly: true + type: number + x-stream-index: "001.012" + online: + readOnly: true + type: boolean + x-stream-index: "001.022" + privacy_settings: + $ref: '#/components/schemas/PrivacySettings' + x-stream-index: "001.026" + revoke_tokens_issued_before: + format: date-time + type: number + x-stream-index: "001.042" + role: + type: string x-stream-index: "001.004" - stats_options: - $ref: '#/components/schemas/StatsOptions' - x-stream-index: "004" - required: - - call - - members - - own_capabilities - - blocked_users - - created - - credentials - - stats_options - - duration - title: JoinCallResponse - type: object - Label: - properties: - harm_labels: + teams: items: type: string type: array - x-stream-index: "003" - name: - type: string - x-stream-index: "001" - phrase_list_ids: - items: - format: int32 - type: integer - type: array - x-stream-index: "002" - required: - - name - type: object - LabelThresholds: - properties: - block: - description: Threshold for automatic message block - format: float - maximum: 1 - minimum: 0 - title: Block - type: number - x-stream-index: "002" - flag: - description: Threshold for automatic message flag - format: float - maximum: 1 - minimum: 0 - title: Flag - type: number - x-stream-index: "001" - type: object - LayoutSettings: - properties: - detect_orientation: - type: boolean - x-stream-index: "005" - external_app_url: - type: string - x-stream-index: "003" - external_css_url: - type: string - x-stream-index: "004" - name: - enum: - - spotlight - - grid - - single-participant - - mobile - - custom - type: string - x-stream-index: "001" - options: - additionalProperties: {} - type: object - x-stream-index: "002" - required: - - name - - external_app_url - - external_css_url - type: object - LayoutSettingsRequest: - properties: - detect_orientation: - type: boolean - x-stream-index: "005" - external_app_url: - type: string - x-stream-index: "003" - external_css_url: - type: string - x-stream-index: "004" - name: - enum: - - spotlight - - grid - - single-participant - - mobile - - custom - type: string - x-stream-index: "001" - options: - additionalProperties: {} + x-stream-index: "001.036" + teams_role: + additionalProperties: + type: string type: object - x-stream-index: "002" + x-stream-index: "001.005" + updated_at: + format: date-time + readOnly: true + type: number + x-stream-index: "001.009" required: - - name + - id + - role + - teams_role + - custom + - banned + - online + - ban_count + - deleted_content_count type: object - LimitsSettings: + EntityCreatorResponse: properties: - max_duration_seconds: + avg_response_time: format: int32 type: integer - x-stream-index: "004" - max_participants: + x-stream-index: 001.001.018 + ban_count: + description: Number of minor actions performed on the user format: int32 + title: Ban Count type: integer - x-stream-index: "001" - max_participants_exclude_owner: + x-stream-index: "002" + banned: type: boolean - x-stream-index: "003" - max_participants_exclude_roles: + x-stream-index: 001.001.012 + blocked_user_ids: items: type: string type: array - x-stream-index: "002" - required: - - max_participants_exclude_roles - type: object - LimitsSettingsRequest: - properties: - max_duration_seconds: + x-stream-index: 001.001.017 + created_at: + format: date-time + type: number + x-stream-index: 001.001.009 + custom: + additionalProperties: {} + type: object + x-stream-index: 001.001.004 + deactivated_at: + format: date-time + type: number + x-stream-index: 001.001.016 + deleted_at: + format: date-time + type: number + x-stream-index: 001.001.011 + deleted_content_count: + description: Number of major actions performed on the user format: int32 - minimum: 0 + title: Deleted Content Count type: integer - x-stream-index: "004" - max_participants: + x-stream-index: "003" + flagged_count: + description: Number of flag actions performed on the user format: int32 + title: Flagged Count type: integer - x-stream-index: "001" - max_participants_exclude_owner: + x-stream-index: "004" + id: + type: string + x-stream-index: 001.001.001 + image: + type: string + x-stream-index: 001.001.003 + language: + type: string + x-stream-index: 001.001.005 + last_active: + format: date-time + type: number + x-stream-index: 001.001.014 + name: + type: string + x-stream-index: 001.001.002 + online: type: boolean - x-stream-index: "003" - max_participants_exclude_roles: + x-stream-index: 001.001.013 + revoke_tokens_issued_before: + format: date-time + type: number + x-stream-index: 001.001.015 + role: + type: string + x-stream-index: 001.001.006 + teams: items: type: string type: array - x-stream-index: "002" + x-stream-index: 001.001.007 + teams_role: + additionalProperties: + type: string + type: object + x-stream-index: 001.001.008 + updated_at: + format: date-time + type: number + x-stream-index: 001.001.010 + required: + - id + - custom + - language + - role + - teams + - created_at + - updated_at + - banned + - online + - blocked_user_ids + - shadow_banned + - invisible + - ban_count + - deleted_content_count + - flagged_count type: object - LimitsSettingsResponse: + EventNotificationSettings: properties: - max_duration_seconds: - format: int32 - type: integer - x-stream-index: "004" - max_participants: - format: int32 - type: integer - x-stream-index: "001" - max_participants_exclude_owner: + apns: + $ref: '#/components/schemas/APNS' + x-stream-index: "002" + enabled: type: boolean + x-stream-index: "001" + fcm: + $ref: '#/components/schemas/FCM' x-stream-index: "003" - max_participants_exclude_roles: - items: - type: string - type: array + required: + - enabled + - apns + - fcm + type: object + EventRequest: + properties: + custom: + additionalProperties: {} + type: object + x-stream-index: "003" + parent_id: + type: string x-stream-index: "002" + type: + type: string + x-stream-index: "001" required: - - max_participants_exclude_roles + - type type: object - ListBlockListResponse: + EventResponse: description: Basic response information nullable: true properties: - blocklists: - items: - $ref: '#/components/schemas/BlockListResponse' - type: array - x-stream-index: "001" duration: description: Duration of the request in milliseconds title: Duration type: string x-stream-index: "002.001" - required: - - blocklists - - duration - title: Response - type: object - ListDevicesResponse: - description: List devices response - nullable: true - properties: - devices: - description: List of devices - items: - $ref: '#/components/schemas/DeviceResponse' - title: Devices - type: array + event: + $ref: '#/components/schemas/WSEvent' x-stream-index: "001" - duration: - type: string - x-stream-index: "002.001" required: - - devices + - event - duration - title: ListDevicesResponse + title: Response type: object - ListRecordingsResponse: - description: Response for listing recordings - nullable: true + ExternalStorage: properties: - duration: + abs_account_name: type: string - x-stream-index: "001.001" - recordings: - items: - $ref: '#/components/schemas/CallRecording' - title: The list of recordings. - type: array - x-stream-index: "002" - required: - - duration - - recordings - title: ListRecordingsResponse - type: object - ListTranscriptionsResponse: - nullable: true - properties: - duration: + x-stream-index: "011" + abs_client_id: type: string - x-stream-index: "001.001" - transcriptions: - description: List of transcriptions for the call - items: - $ref: '#/components/schemas/CallTranscription' - title: Transcriptions - type: array - x-stream-index: "002" - required: - - duration - - transcriptions - title: ListTranscriptionsResponse - type: object - MarkChannelsReadRequest: - nullable: true - properties: - read_by_channel: - additionalProperties: - type: string - description: Map of channel ID to last read message ID - maximum: 30 - title: Read by channel - type: object - x-stream-index: "001" - type: object - MarkReadRequest: - nullable: true - properties: - message_id: - description: ID of the message that is considered last read by client - title: Message ID + x-stream-index: "013" + abs_client_secret: type: string - x-stream-index: "001" - thread_id: - description: Optional Thread ID to specifically mark a given thread as read - title: Thread ID + x-stream-index: "014" + abs_tenant_id: type: string - x-stream-index: "002" - type: object - MarkReadResponse: - nullable: true - properties: - duration: - description: Duration of the request in milliseconds - title: Duration + x-stream-index: "012" + bucket: type: string - x-stream-index: "002.001" - event: - $ref: '#/components/schemas/MessageReadEvent' - description: Mark read event - title: Event - x-stream-index: "001" - required: - - duration + x-stream-index: "005" + gcs_credentials: + type: string + x-stream-index: "010" + path: + type: string + x-stream-index: "006" + s3_api_key: + type: string + x-stream-index: "007" + s3_custom_endpoint: + type: string + x-stream-index: "016" + s3_region: + type: string + x-stream-index: "009" + s3_secret_key: + type: string + x-stream-index: "008" + storage_name: + type: string + x-stream-index: "015" + storage_type: + type: integer + x-stream-index: "004" type: object - MarkReviewedRequest: + FCM: properties: - content_to_mark_as_reviewed_limit: - format: int32 - maximum: 2500 - type: integer - x-stream-index: "002" - disable_marking_content_as_reviewed: - type: boolean + data: + additionalProperties: {} + type: object x-stream-index: "001" type: object - MarkUnreadRequest: + FeedCreatedEvent: + description: Emitted when a feed is created. nullable: true properties: - message_id: - description: ID of the message from where the channel is marked unread - title: Message ID - type: string + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 003.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 003.001.007 + feed: + $ref: '#/components/schemas/FeedResponse' + description: The feed that was created + title: Feed x-stream-index: "001" - thread_id: - description: Mark a thread unread, specify both the thread and message id - title: Thread ID - type: string - x-stream-index: "003" - type: object - MemberAddedEvent: - properties: - channel_id: - type: string - x-stream-index: "004.002" - channel_type: + feed_visibility: type: string - x-stream-index: "004.003" - cid: + x-stream-index: "003.003" + fid: type: string - x-stream-index: "004.001" - created_at: + x-stream-index: "003.002" + members: + items: + $ref: '#/components/schemas/FeedMemberResponse' + type: array + x-stream-index: "002" + received_at: format: date-time type: number - x-stream-index: "003.002" - member: - $ref: '#/components/schemas/ChannelMember' - x-stream-index: "001.001" - team: - type: string - x-stream-index: "002.001" + x-stream-index: 003.001.004 type: - default: member.added + default: feeds.feed.created + description: 'The type of event: "feeds.feed.created" in this case' + title: Event Type type: string - x-stream-index: "003.001" + x-stream-index: 003.001.002 user: - $ref: '#/components/schemas/User' - x-stream-index: "005.001" + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who created the feed + title: User + x-stream-index: "004.001" required: + - feed + - members - type - created_at - - cid - - channel_id - - channel_type - title: MemberAddedEvent + - custom + - fid + - user + title: FeedCreatedEvent 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 - MemberLookup: - properties: - Limit: - format: int32 - type: integer - writeOnly: true - x-stream-index: "001" - required: - - Limit - type: object - MemberRemovedEvent: + FeedDeletedEvent: + description: Emitted when a feed is deleted. + nullable: true properties: - channel_id: - type: string - x-stream-index: "003.002" - channel_type: + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 001.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 001.001.007 + feed_visibility: type: string - x-stream-index: "003.003" - cid: + x-stream-index: "001.003" + fid: type: string - x-stream-index: "003.001" - created_at: + x-stream-index: "001.002" + received_at: format: date-time type: number - x-stream-index: "002.002" - member: - $ref: '#/components/schemas/ChannelMember' - x-stream-index: "001.001" + x-stream-index: 001.001.004 type: - default: member.removed + default: feeds.feed.deleted + description: 'The type of event: "feeds.feed.deleted" in this case' + title: Event Type type: string - x-stream-index: "002.001" + x-stream-index: 001.001.002 user: - $ref: '#/components/schemas/User' - x-stream-index: "004.001" + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who deleted the feed + title: User + x-stream-index: "002.001" required: - type - created_at - - cid - - channel_id - - channel_type - title: MemberRemovedEvent + - custom + - fid + title: FeedDeletedEvent 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 - MemberRequest: - description: MemberRequest is the payload for adding a member to a call. + FeedGroup: properties: - custom: - additionalProperties: {} - description: Custom data for this object - title: Custom data + ActivityProcessors: + items: + $ref: '#/components/schemas/ActivityProcessorConfig' + type: array + writeOnly: true + x-stream-index: "012" + ActivitySelectors: + items: + $ref: '#/components/schemas/ActivitySelectorConfig' + type: array + writeOnly: true + x-stream-index: "013" + Aggregation: + $ref: '#/components/schemas/AggregationConfig' + x-stream-index: "015" + AggregationVersion: + format: int32 + type: integer + writeOnly: true + x-stream-index: "016" + AppPK: + format: int32 + type: integer + writeOnly: true + x-stream-index: "002" + Custom: + additionalProperties: {} type: object - x-stream-index: "003" - role: - title: Role + writeOnly: true + x-stream-index: "007" + DefaultVisibility: type: string - x-stream-index: "002" - user_id: - minLength: 1 - title: User ID + writeOnly: true + x-stream-index: "006" + DeletedAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "010" + ID: type: string - x-stream-index: "001" + writeOnly: true + x-stream-index: "003" + LastFeedGetAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "017" + Notification: + $ref: '#/components/schemas/NotificationConfig' + x-stream-index: "004" + PushNotification: + $ref: '#/components/schemas/PushNotificationConfig' + x-stream-index: "005" + Ranking: + $ref: '#/components/schemas/RankingConfig' + x-stream-index: "014" + Stories: + $ref: '#/components/schemas/StoriesConfig' + x-stream-index: "011" + created_at: + format: date-time + type: number + x-stream-index: "008" + updated_at: + format: date-time + type: number + x-stream-index: "009" required: - - user_id - title: MemberRequest + - AppPK + - ID + - DefaultVisibility + - Custom + - created_at + - updated_at + - ActivityProcessors + - ActivitySelectors + - AggregationVersion type: object - MemberResponse: - description: MemberResponse is the payload for a member of a call. + FeedGroupChangedEvent: + description: Emitted when a feed group is changed. + nullable: true properties: created_at: description: Date/time of creation format: date-time title: Created at type: number - x-stream-index: "005" + x-stream-index: 001.001.003 custom: additionalProperties: {} - description: Custom member response data - title: Custom type: object - x-stream-index: "004" - deleted_at: - description: Date/time of deletion - format: date-time - title: Deleted at - type: number - x-stream-index: "007" - role: - title: Role - type: string + x-stream-index: 001.001.007 + feed_group: + $ref: '#/components/schemas/FeedGroup' + description: The feed group that was changed + title: Feed Type x-stream-index: "003" - updated_at: - description: Date/time of the last update + feed_visibility: + type: string + x-stream-index: "001.003" + fid: + type: string + x-stream-index: "001.002" + received_at: format: date-time - title: Updated at type: number - x-stream-index: "006" - user: - $ref: '#/components/schemas/UserResponse' - x-stream-index: "001" - user_id: + x-stream-index: 001.001.004 + type: + default: feeds.feed_group.changed + description: 'The type of event: "feeds.feed_group.changed" in this case' + title: Event Type type: string - x-stream-index: "002" + x-stream-index: 001.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who changed the feed group + title: User + x-stream-index: "002.001" required: - - user - - user_id - - custom + - type - created_at - - updated_at - title: MemberResponse + - custom + - fid + title: FeedGroupChangedEvent type: object - MemberUpdatedEvent: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + FeedGroupDeletedEvent: + description: Emitted when a feed group is deleted. + nullable: true properties: - channel_id: + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + feed_visibility: type: string - x-stream-index: "005.002" - channel_type: + x-stream-index: "002.003" + fid: type: string - x-stream-index: "005.003" - cid: + x-stream-index: "002.002" + group_id: + description: The ID of the feed group that was deleted + title: Group ID type: string - x-stream-index: "005.001" - created_at: + x-stream-index: "001" + received_at: format: date-time type: number - x-stream-index: "003.002" - member: - $ref: '#/components/schemas/ChannelMember' - x-stream-index: "001.001" - team: - type: string - x-stream-index: "002.001" + x-stream-index: 002.001.004 type: - default: member.updated + default: feeds.feed_group.deleted + description: 'The type of event: "feeds.feed_group.deleted" in this case' + title: Event Type type: string - x-stream-index: "003.001" - user: - $ref: '#/components/schemas/User' - x-stream-index: "004.001" + x-stream-index: 002.001.002 required: + - group_id - type - created_at - - cid - - channel_id - - channel_type - title: MemberUpdatedEvent + - custom + - fid + title: FeedGroupDeletedEvent 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 - MembersResponse: - nullable: true + FeedInput: properties: - duration: - description: Duration of the request in milliseconds - title: Duration + custom: + additionalProperties: {} + type: object + x-stream-index: "004" + description: + maxLength: 1000 type: string - x-stream-index: "002.001" - members: - description: List of found members + x-stream-index: "002" + filter_tags: items: - $ref: '#/components/schemas/ChannelMember' - title: Members + type: string + maximum: 255 type: array - x-stream-index: "001" - required: - - members - - duration - type: object - Message: - properties: - attachments: + x-stream-index: "005" + members: items: - $ref: '#/components/schemas/Attachment' + $ref: '#/components/schemas/FeedMemberRequest' type: array - x-stream-index: "012" - before_message_send_failed: - type: boolean - x-stream-index: "046" - cid: + x-stream-index: "006" + name: + maxLength: 255 type: string - x-stream-index: "028" - command: + x-stream-index: "001" + visibility: + enum: + - public + - visible + - followers + - members + - private type: string - x-stream-index: "006" + x-stream-index: "003" + type: object + FeedMemberAddedEvent: + description: Emitted when a feed member is added. + nullable: true + properties: created_at: + description: Date/time of creation format: date-time + title: Created at type: number - x-stream-index: "030" + x-stream-index: 003.001.003 custom: additionalProperties: {} type: object - x-stream-index: "034" - deleted_at: - format: date-time - type: number - x-stream-index: "033" - deleted_reply_count: - format: int32 - type: integer - x-stream-index: "023" - html: + x-stream-index: 003.001.007 + feed_visibility: type: string - x-stream-index: "007" - i18n: - additionalProperties: - type: string - type: object - x-stream-index: "044" - id: + x-stream-index: "003.003" + fid: type: string - x-stream-index: "002" - image_labels: - additionalProperties: - items: - type: string - type: array - type: object - x-stream-index: "040" - latest_reactions: - items: - $ref: '#/components/schemas/Reaction' - type: array - x-stream-index: "013" - mentioned_users: - items: - $ref: '#/components/schemas/User' - type: array - x-stream-index: "043" - message_text_updated_at: + x-stream-index: "003.002" + member: + $ref: '#/components/schemas/FeedMemberResponse' + description: The member that was added + title: Member + x-stream-index: "001" + received_at: format: date-time type: number - x-stream-index: "052" - mml: + x-stream-index: 003.001.004 + type: + default: feeds.feed_member.added + description: 'The type of event: "feeds.feed_member.added" in this case' + title: Event Type type: string - x-stream-index: "005" - moderation: - $ref: '#/components/schemas/ModerationV2Response' - x-stream-index: "056" - own_reactions: - items: - $ref: '#/components/schemas/Reaction' - type: array - x-stream-index: "014" - parent_id: - type: string - x-stream-index: "019" - pin_expires: - format: date-time - type: number - x-stream-index: "051" - pinned: - type: boolean - x-stream-index: "047" - pinned_at: - format: date-time - type: number - x-stream-index: "048" - pinned_by: - $ref: '#/components/schemas/User' - x-stream-index: "050" - poll: - $ref: '#/components/schemas/Poll' - x-stream-index: "054" - poll_id: - type: string - x-stream-index: "053" - quoted_message: - $ref: '#/components/schemas/Message' - x-stream-index: "025" - quoted_message_id: - type: string - x-stream-index: "024" - reaction_counts: - additionalProperties: - format: int32 - type: integer - type: object - x-stream-index: "015" - reaction_groups: - additionalProperties: - $ref: '#/components/schemas/ReactionGroupResponse' - type: object - x-stream-index: "017" - reaction_scores: - additionalProperties: - format: int32 - type: integer - type: object - x-stream-index: "016" - reminder: - $ref: '#/components/schemas/MessageReminder' - x-stream-index: "058" - reply_count: - format: int32 - type: integer - x-stream-index: "022" - restricted_visibility: - items: - type: string - type: array - x-stream-index: "011" - shadowed: - type: boolean - x-stream-index: "036" - shared_location: - $ref: '#/components/schemas/SharedLocation' - x-stream-index: "055" - show_in_channel: - type: boolean - x-stream-index: "021" - silent: - type: boolean - x-stream-index: "045" - text: - type: string - x-stream-index: "004" - thread_participants: - items: - $ref: '#/components/schemas/User' - type: array - x-stream-index: "027" - type: - type: string - x-stream-index: "008" - updated_at: - format: date-time - type: number - x-stream-index: "031" + x-stream-index: 003.001.002 user: - $ref: '#/components/schemas/User' - x-stream-index: "010" + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who added the member + title: User + x-stream-index: "002.001" required: - - id - - text - - html + - member - type - - restricted_visibility - - attachments - - latest_reactions - - own_reactions - - reaction_counts - - reaction_scores - - reaction_groups - - reply_count - - deleted_reply_count - - cid - created_at - - updated_at - custom - - shadowed - - mentioned_users - - silent - - pinned + - fid + title: FeedMemberAddedEvent type: object - MessageActionRequest: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + FeedMemberRemovedEvent: + description: Emitted when a feed member is removed. nullable: true properties: - form_data: - additionalProperties: - type: string - description: ReadOnlyData to execute command with - title: Form data - type: object - x-stream-index: "002" - required: - - form_data - type: object - MessageChangeSet: - properties: - attachments: - type: boolean - x-stream-index: "005" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 003.001.003 custom: - type: boolean - x-stream-index: "001" - html: - type: boolean - x-stream-index: "004" - mentioned_user_ids: - type: boolean - x-stream-index: "006" - mml: - type: boolean - x-stream-index: "003" - pin: - type: boolean - x-stream-index: "009" - quoted_message_id: - type: boolean - x-stream-index: "007" - silent: - type: boolean - x-stream-index: "008" - text: - type: boolean - x-stream-index: "002" - required: - - custom - - text - - mml - - html - - attachments - - mentioned_user_ids - - quoted_message_id - - silent - - pin - type: object - MessageDeletedEvent: - properties: - channel_id: - type: string - x-stream-index: "003.002" - channel_type: + additionalProperties: {} + type: object + x-stream-index: 003.001.007 + feed_visibility: type: string x-stream-index: "003.003" - cid: + fid: type: string - x-stream-index: "003.001" - created_at: + x-stream-index: "003.002" + member_id: + type: string + x-stream-index: "001" + received_at: format: date-time type: number - x-stream-index: "006.002" - hard_delete: - type: boolean - x-stream-index: "002.001" - message: - $ref: '#/components/schemas/Message' - x-stream-index: "001.001" - team: - type: string - x-stream-index: "005.001" - thread_participants: - items: - $ref: '#/components/schemas/User' - type: array - x-stream-index: "001.002" + x-stream-index: 003.001.004 type: - default: message.deleted + default: feeds.feed_member.removed + description: 'The type of event: "feeds.feed_member.removed" in this case' + title: Event Type type: string - x-stream-index: "006.001" + x-stream-index: 003.001.002 user: - $ref: '#/components/schemas/User' - x-stream-index: "004.001" + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who removed the member + title: User + x-stream-index: "002.001" required: - - hard_delete - - cid - - channel_id - - channel_type + - member_id - type - created_at - title: MessageDeletedEvent + - custom + - fid + title: FeedMemberRemovedEvent 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 + FeedMemberRequest: properties: - approved_at: - format: date-time - type: number - x-stream-index: "013" - created_at: - format: date-time - type: number - x-stream-index: "009" - created_by_automod: - type: boolean - x-stream-index: "001" custom: additionalProperties: {} + description: Custom data for the member + title: Custom Data type: object - x-stream-index: "008" - details: - $ref: '#/components/schemas/FlagDetails' - x-stream-index: "006" - message: - $ref: '#/components/schemas/Message' + x-stream-index: "004" + invite: + description: Whether this is an invite to become a member + title: Invite + type: boolean x-stream-index: "005" - moderation_feedback: - $ref: '#/components/schemas/FlagFeedback' + membership_level: + description: ID of the membership level to assign to the member + maxLength: 255 + title: Membership Level + type: string x-stream-index: "003" - moderation_result: - $ref: '#/components/schemas/MessageModerationResult' + role: + description: Role of the member in the feed + maxLength: 255 + title: Role + type: string x-stream-index: "002" - reason: + user_id: + description: ID of the user to add as a member + maxLength: 255 + title: User ID type: string - x-stream-index: "007" - rejected_at: - format: date-time - type: number - x-stream-index: "014" - reviewed_at: - format: date-time - type: number - x-stream-index: "011" - reviewed_by: - $ref: '#/components/schemas/UserResponse' - x-stream-index: "012" - updated_at: - format: date-time - type: number - x-stream-index: "010" - user: - $ref: '#/components/schemas/UserResponse' - x-stream-index: "004" + x-stream-index: "001" required: - - created_by_automod - - created_at - - updated_at + - user_id + title: Feed Member Payload type: object - MessageModerationResult: - description: Result of the message moderation + FeedMemberResponse: properties: - action: - description: Action taken by automod - title: Action - type: string - x-stream-index: "002" - ai_moderation_response: - $ref: '#/components/schemas/ModerationResponse' - description: Response from AI moderation - title: ModerationResponse + created_at: + description: When the membership was created + format: date-time + title: Created At + type: number + x-stream-index: "008" + custom: + additionalProperties: {} + description: Custom data for the membership + title: Custom Data + type: object x-stream-index: "007" - blocked_word: - description: Word that was blocked - title: Blocked word - type: string - x-stream-index: "004" - blocklist_name: - description: Name of the blocklist - title: Blocklist name - type: string + invite_accepted_at: + description: When the invite was accepted + format: date-time + title: Invite Accepted At + type: number x-stream-index: "005" - created_at: - description: Date/time of creation + invite_rejected_at: + description: When the invite was rejected format: date-time - title: Created at + title: Invite Rejected At type: number - x-stream-index: "010" - message_id: - description: ID of the message - title: Message ID + x-stream-index: "006" + membership_level: + $ref: '#/components/schemas/MembershipLevelResponse' + description: Membership level assigned to the member + title: Membership Level + x-stream-index: "004" + role: + description: Role of the member in the feed + title: Role type: string - x-stream-index: "001" - moderated_by: - description: User who moderated the message - title: Moderated by + x-stream-index: "002" + status: + description: Status of the membership + enum: + - member + - pending + - rejected + title: Status type: string x-stream-index: "003" - moderation_thresholds: - $ref: '#/components/schemas/Thresholds' - description: Thresholds for AI moderation - title: Thresholds - x-stream-index: "006" updated_at: - description: Date/time of the last update + description: When the membership was last updated format: date-time - title: Updated at + title: Updated At type: number - x-stream-index: "011" - user_bad_karma: - description: Whether user has bad karma - title: User bad karma - type: boolean x-stream-index: "009" - user_karma: - description: Karma of the user - format: float - title: User karma - type: number - x-stream-index: "008" + user: + $ref: '#/components/schemas/UserResponse' + description: User who is a member + title: User + x-stream-index: "001" required: - - message_id - - action - - user_karma - - user_bad_karma + - user + - role + - status - created_at - updated_at - title: Message moderation result + title: Feed Member type: object - MessageNewEvent: + FeedMemberUpdatedEvent: + description: Emitted when a feed member is updated. + nullable: true properties: - channel_id: - type: string - x-stream-index: "005.002" - channel_type: - type: string - x-stream-index: "005.003" - cid: - type: string - x-stream-index: "005.001" created_at: + description: Date/time of creation format: date-time + title: Created at type: number - x-stream-index: "004.002" - message: - $ref: '#/components/schemas/Message' - x-stream-index: "001.001" - team: + x-stream-index: 003.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 003.001.007 + feed_visibility: type: string - x-stream-index: "006.001" - thread_participants: - items: - $ref: '#/components/schemas/User' - type: array - x-stream-index: "001.002" + x-stream-index: "003.003" + fid: + type: string + x-stream-index: "003.002" + member: + $ref: '#/components/schemas/FeedMemberResponse' + description: The member that was updated + title: Member + x-stream-index: "001" + received_at: + format: date-time + type: number + x-stream-index: 003.001.004 type: - default: notification.thread_message_new + default: feeds.feed_member.updated + description: 'The type of event: "feeds.feed_member.updated" in this case' + title: Event Type type: string - x-stream-index: "004.001" + x-stream-index: 003.001.002 user: - $ref: '#/components/schemas/User' - x-stream-index: "003.001" - watcher_count: - format: int32 - type: integer + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who updated the member + title: User x-stream-index: "002.001" required: - - watcher_count + - member - type - created_at - - cid - - channel_id - - channel_type - title: MessageNewEvent + - custom + - fid + title: FeedMemberUpdatedEvent 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 - MessageOptions: - properties: - include_thread_participants: - type: boolean - x-stream-index: "001" - type: object - MessagePaginationParams: - type: object - MessageReadEvent: + FeedOwnCapability: + description: All possibility of string to use + enum: + - add-activity + - add-activity-reaction + - add-comment + - add-comment-reaction + - bookmark-activity + - create-feed + - delete-bookmark + - delete-comment + - delete-feed + - edit-bookmark + - follow + - invite-feed + - join-feed + - leave-feed + - manage-feed-group + - mark-activity + - pin-activity + - query-feed-members + - query-follows + - read-activities + - read-feed + - remove-activity + - remove-activity-reaction + - remove-comment-reaction + - unfollow + - update-activity + - update-comment + - update-feed + - update-feed-followers + - update-feed-members + title: FeedOwnCapability + type: string + FeedRequest: properties: - channel_id: + created_by_id: + description: ID of the feed creator + title: Created By ID type: string x-stream-index: "003" - channel_last_message_at: - format: date-time - type: number - x-stream-index: "005" - channel_type: + custom: + additionalProperties: {} + description: Custom data for the feed + title: Custom Data + type: object + x-stream-index: "004.004" + description: + description: Description of the feed + maxLength: 1000 + title: Description type: string - x-stream-index: "004" - cid: + x-stream-index: "004.002" + feed_group_id: + description: ID of the feed group + maxLength: 255 + title: Feed Group ID type: string - x-stream-index: "002" - created_at: - format: date-time - type: number - x-stream-index: "009" - last_read_message_id: + x-stream-index: "001" + feed_id: + description: ID of the feed + maxLength: 255 + title: Feed ID type: string - x-stream-index: "010" - team: + x-stream-index: "002" + filter_tags: + description: Tags used for filtering feeds + items: + type: string + maximum: 255 + title: Filter Tags + type: array + x-stream-index: "004.005" + members: + description: Initial members for the feed + items: + $ref: '#/components/schemas/FeedMemberRequest' + title: Members + type: array + x-stream-index: "004.006" + name: + description: Name of the feed + maxLength: 255 + title: Name type: string - x-stream-index: "006" - thread: - $ref: '#/components/schemas/ThreadResponse' - x-stream-index: "008" - type: - default: message.read + x-stream-index: "004.001" + visibility: + description: Visibility setting for the feed + enum: + - public + - visible + - followers + - members + - private + title: Visibility type: string - x-stream-index: "001" - user: - $ref: '#/components/schemas/UserResponseCommonFields' - x-stream-index: "007" + x-stream-index: "004.003" required: - - type - - cid - - channel_id - - channel_type - - created_at + - feed_group_id + - feed_id + title: Feed Payload type: object - MessageReminder: + FeedResponse: properties: - channel: - $ref: '#/components/schemas/Channel' - x-stream-index: "004" - channel_cid: - type: string - x-stream-index: "003" created_at: + description: When the feed was created format: date-time + title: Created At type: number - x-stream-index: "011" - message: - $ref: '#/components/schemas/Message' + x-stream-index: "015" + created_by: + $ref: '#/components/schemas/UserResponse' + description: User who created the feed + title: Created By + x-stream-index: "009" + custom: + additionalProperties: {} + description: Custom data for the feed + title: Custom Data + type: object x-stream-index: "006" - message_id: - type: string - x-stream-index: "005" - remind_at: + deleted_at: + description: When the feed was deleted format: date-time + title: Deleted At type: number - x-stream-index: "009" - task_id: + x-stream-index: "017" + description: + description: Description of the feed + title: Description type: string - x-stream-index: "010" + x-stream-index: "005" + feed: + description: Fully qualified feed ID (group_id:id) + title: FID + type: string + x-stream-index: "003" + filter_tags: + description: Tags used for filtering feeds + items: + type: string + title: Filter Tags + type: array + x-stream-index: "007" + follower_count: + description: Number of followers of this feed + format: int32 + title: Follower Count + type: integer + x-stream-index: "011" + following_count: + description: Number of feeds this feed follows + format: int32 + title: Following Count + type: integer + x-stream-index: "012" + group_id: + description: Group this feed belongs to + title: Group ID + type: string + x-stream-index: "001" + id: + description: Unique identifier for the feed + title: ID + type: string + x-stream-index: "002" + member_count: + description: Number of members in this feed + format: int32 + title: Member Count + type: integer + x-stream-index: "010" + name: + description: Name of the feed + title: Name + type: string + x-stream-index: "004" + own_follows: + description: Follow relationships where the current user's feeds are following + this feed + items: + $ref: '#/components/schemas/FollowResponse' + title: Own Follows + type: array + x-stream-index: "014" + pin_count: + description: Number of pinned activities in this feed + format: int32 + title: Pin Count + type: integer + x-stream-index: "013" updated_at: + description: When the feed was last updated format: date-time + title: Updated At type: number - x-stream-index: "012" - user: - $ref: '#/components/schemas/User' - x-stream-index: "008" - user_id: + x-stream-index: "016" + visibility: + description: Visibility setting for the feed + title: Visibility type: string - x-stream-index: "007" + x-stream-index: "008" required: - - channel_cid - - message_id - - user_id - - task_id + - group_id + - id + - feed + - name + - description + - created_by + - member_count + - follower_count + - following_count + - pin_count - created_at - updated_at + title: Feed type: object - MessageRequest: + FeedUpdatedEvent: + description: Emitted when a feed is created. + nullable: true properties: - attachments: - items: - $ref: '#/components/schemas/Attachment' - maximum: 30 - type: array - x-stream-index: "004" + created_at: + format: date-time + type: number + x-stream-index: 002.001.003 custom: additionalProperties: {} type: object - x-stream-index: "007" - id: - maxLength: 255 - type: string + x-stream-index: 002.001.007 + feed: + $ref: '#/components/schemas/FeedResponse' + description: The feed that was created + title: Feed x-stream-index: "001" - mentioned_users: - items: - type: string - maximum: 100 - type: array - x-stream-index: "008" - mml: + feed_visibility: type: string - x-stream-index: "003" - parent_id: + x-stream-index: "002.003" + fid: type: string - x-stream-index: "005" - pin_expires: + x-stream-index: "002.002" + received_at: format: date-time type: number - x-stream-index: "015" - pinned: - type: boolean - x-stream-index: "013" - pinned_at: - format: date-time - nullable: true + x-stream-index: 002.001.004 + type: + default: feeds.feed.updated + description: 'The type of event: "feeds.feed.updated" in this case' + title: Event Type type: string - x-stream-index: "014" - poll_id: + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who created the feed + title: User + x-stream-index: "003.001" + required: + - feed + - type + - created_at + - custom + - fid + title: FeedUpdatedEvent + 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 + FeedsEventPreferences: + properties: + comments: type: string - x-stream-index: "039" - quoted_message_id: + x-stream-index: "002" + mentions: type: string - x-stream-index: "009" - restricted_visibility: - items: - type: string - maximum: 10 - type: array - x-stream-index: "016" - shared_location: - $ref: '#/components/schemas/SharedLocation' - x-stream-index: "040" - show_in_channel: - type: boolean - x-stream-index: "006" - silent: - type: boolean - x-stream-index: "012" - text: + x-stream-index: "004" + new_followers: + type: string + x-stream-index: "003" + reactions: + type: string + x-stream-index: "001" + type: object + FeedsEventPreferencesInput: + properties: + comments: + enum: + - all + - none type: string x-stream-index: "002" - type: + mentions: enum: - - '''''' - - regular - - system + - all + - none type: string - x-stream-index: "011" + x-stream-index: "004" + new_followers: + enum: + - all + - none + type: string + x-stream-index: "003" + reactions: + enum: + - all + - none + type: string + x-stream-index: "001" type: object - MessageResponse: - description: Represents any chat message + FeedsReactionResponse: properties: - attachments: - description: Array of message attachments - items: - $ref: '#/components/schemas/Attachment' - title: Message attachments - type: array - x-stream-docs-page-id: message_format#attachment-format - x-stream-index: "008" - cid: - description: Channel unique identifier in : format - title: Channel CID + activity_id: + description: ID of the activity that was reacted to + title: Activity ID type: string - x-stream-index: "022" - command: - description: Contains provided slash command - title: Command + x-stream-index: "002" + comment_id: + description: ID of the comment that was reacted to + title: Comment ID type: string - x-stream-docs-page-id: custom_commands_webhook - x-stream-index: "004" + x-stream-index: "003" created_at: - description: Date/time of creation + description: When the reaction was created format: date-time - title: Created at + title: Created At type: number - x-stream-index: "023" + x-stream-index: "006" custom: additionalProperties: {} + description: Custom data for the reaction + title: Custom Data type: object - x-stream-index: "026" - deleted_at: - description: Date/time of deletion + x-stream-index: "005" + type: + description: Type of reaction + title: Type + type: string + x-stream-index: "004" + updated_at: + description: When the reaction was last updated format: date-time - title: Deleted at + title: Updated At type: number - x-stream-index: "025" - deleted_reply_count: - format: int32 - type: integer - x-stream-index: "018" - draft: - $ref: '#/components/schemas/DraftResponse' - x-stream-index: "041" - html: - description: Contains HTML markup of the message. Can only be set when using - server-side API - title: HTML content + x-stream-index: "007" + user: + $ref: '#/components/schemas/UserResponse' + description: User who created the reaction + title: User + x-stream-index: "001" + required: + - user + - activity_id + - type + - created_at + - updated_at + title: Activity Reaction + type: object + Field: + nullable: true + properties: + short: + type: boolean + x-stream-index: "003" + title: type: string - x-stream-index: "005" - i18n: - additionalProperties: - type: string - description: Object with translations. Key `language` contains the original - language key. Other keys contain translations - title: Internationalization info - type: object - x-stream-docs-page-id: translation - x-stream-index: "030" - id: - description: Message ID is unique string identifier of the message - title: ID + x-stream-index: "001" + value: type: string + x-stream-index: "002" + required: + - title + - value + - short + type: object + FileUploadConfig: + properties: + allowed_file_extensions: + items: + type: string + type: array x-stream-index: "001" - image_labels: - additionalProperties: - items: - type: string - type: array - description: Contains image moderation information - title: Image moderation labels - type: object - x-stream-index: "028" - latest_reactions: - description: List of 10 latest reactions to this message + allowed_mime_types: items: - $ref: '#/components/schemas/ReactionResponse' - title: Latest reactions + type: string type: array - x-stream-index: "009" - mentioned_users: - description: List of mentioned users + x-stream-index: "003" + blocked_file_extensions: items: - $ref: '#/components/schemas/UserResponse' - title: Mentioned Users + type: string type: array - x-stream-index: "029" - message_text_updated_at: - format: date-time - type: number - x-stream-index: "036" - mml: - description: Should be empty if `text` is provided. Can only be set when - using server-side API - title: Messaging Markup Language - type: string - x-stream-docs-page-id: mml_overview - x-stream-index: "003" - moderation: - $ref: '#/components/schemas/ModerationV2Response' - x-stream-index: "039" - own_reactions: - description: List of 10 latest reactions of authenticated user to this message + x-stream-index: "002" + blocked_mime_types: items: - $ref: '#/components/schemas/ReactionResponse' - title: Own reactions + type: string type: array - x-stream-index: "010" - parent_id: - description: ID of parent message (thread) - title: Parent message ID + x-stream-index: "004" + size_limit: + format: int32 + maximum: 104857600 + minimum: 0 + type: integer + x-stream-index: "005" + required: + - allowed_file_extensions + - blocked_file_extensions + - allowed_mime_types + - blocked_mime_types + - size_limit + type: object + FileUploadRequest: + nullable: true + properties: + file: + description: file field + title: File type: string - x-stream-docs-page-id: threads - x-stream-index: "015" - pin_expires: - description: Date when pinned message expires - format: date-time - title: Pin expiration date - type: number - x-stream-docs-page-id: pinned_messages - x-stream-index: "035" - pinned: - description: Whether message is pinned or not - title: Pinned - type: boolean - x-stream-docs-page-id: pinned_messages - x-stream-index: "032" - pinned_at: - description: Date when message got pinned - format: date-time - title: Pinned at - type: number - x-stream-docs-page-id: pinned_messages - x-stream-index: "033" - pinned_by: - $ref: '#/components/schemas/UserResponse' - description: Contains user who pinned the message - title: Pinned by - x-stream-docs-page-id: pinned_messages - x-stream-index: "034" - poll: - $ref: '#/components/schemas/PollResponseData' - x-stream-index: "038" - poll_id: - description: Identifier of the poll to include in the message - title: Poll ID + x-stream-index: "001" + user: + $ref: '#/components/schemas/OnlyUserID' + description: user for the request **server side only** + title: User + x-stream-index: "002" + type: object + FileUploadResponse: + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration type: string - x-stream-index: "037" - quoted_message: - $ref: '#/components/schemas/MessageResponse' - description: Contains quoted message - title: Quoted message - x-stream-docs-page-id: threads#quote-message - x-stream-index: "020" - quoted_message_id: - title: ID of quoted message + x-stream-index: "003.001" + file: + description: URL to the uploaded asset. Should be used to put to `asset_url` + attachment field + title: File type: string - x-stream-docs-page-id: threads#quote-message + x-stream-index: "001" + thumb_url: + description: URL of the file thumbnail for supported file formats. Should + be put to `thumb_url` attachment field + title: Thumbnail URL + type: string + x-stream-index: "002" + required: + - duration + type: object + Flag: + description: Contains information about flagged user or message + nullable: true + properties: + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number x-stream-index: "019" - reaction_counts: - additionalProperties: - format: int32 - type: integer - description: 'An object containing number of reactions of each type. Key: - reaction type (string), value: number of reactions (int)' - title: Reaction counts - type: object - x-stream-index: "011" - reaction_groups: - additionalProperties: - $ref: '#/components/schemas/ReactionGroupResponse' + custom: + additionalProperties: {} + description: Additional metadata about the flag + title: Custom type: object x-stream-index: "014" - reaction_scores: - additionalProperties: - format: int32 - type: integer - description: 'An object containing scores of reactions of each type. Key: - reaction type (string), value: total score of reactions (int)' - title: Reaction scores - type: object + entity_creator_id: + description: ID of the user who created the flagged entity + title: Entity Creator ID + type: string + x-stream-index: "009" + entity_id: + description: Unique identifier of the entity being flagged + title: Entity ID + type: string + x-stream-index: "008" + entity_type: + description: Type of entity being flagged (e.g., message, user) + title: Entity Type + type: string + x-stream-index: "007" + is_streamed_content: + type: boolean x-stream-index: "012" - reminder: - $ref: '#/components/schemas/ReminderResponseData' - x-stream-index: "042" - reply_count: - description: Number of replies to this message - format: int32 - title: Reply count - type: integer - x-stream-index: "017" - restricted_visibility: - description: A list of user ids that have restricted visibility to the message, - if the list is not empty, the message is only visible to the users in - the list + labels: + description: Labels from bodyguard, API calls, our own AI etc items: type: string - title: Restricted visibility + title: Labels type: array - x-stream-index: "040" - shadowed: - description: Whether the message was shadowed or not - title: Shadowed - type: boolean - x-stream-docs-page-id: moderation#shadow-ban - x-stream-index: "027" - shared_location: - $ref: '#/components/schemas/SharedLocationResponseData' - description: Contains shared location data - title: Shared Location - x-stream-index: "043" - show_in_channel: - description: Whether thread reply should be shown in the channel as well - title: Show in channel - type: boolean - x-stream-docs-page-id: threads - x-stream-index: "016" - silent: - description: Whether message is silent or not - title: Silent - type: boolean - x-stream-index: "031" - text: - description: Text of the message. Should be empty if `mml` is provided - title: Text + x-stream-index: "015" + moderation_payload: + $ref: '#/components/schemas/ModerationPayload' + description: Content being flagged + title: Moderation Payload + x-stream-index: "010" + moderation_payload_hash: type: string - x-stream-index: "002" - thread_participants: - description: List of users who participate in thread + x-stream-index: "011" + reason: + description: Optional explanation for why the content is being flagged + title: Reason + type: string + x-stream-index: "013" + result: + description: Result of bodyguard, API calls, our own AI etc items: - $ref: '#/components/schemas/UserResponse' - title: Thread participants + additionalProperties: {} + type: object + title: Result type: array - x-stream-docs-page-id: threads#quote-message - x-stream-index: "021" + x-stream-index: "016" + review_queue_item: + $ref: '#/components/schemas/ReviewQueueItem' + x-stream-index: "018" + review_queue_item_id: + description: ID of the review queue item + title: Review Queue Item ID + type: string + x-stream-index: "017" type: - description: Contains type of the message - enum: - - regular - - ephemeral - - error - - reply - - system - - deleted - title: Message Type type: string - x-stream-docs-page-id: message_format#message-types - x-stream-index: "006" + x-stream-index: "004" updated_at: description: Date/time of the last update format: date-time title: Updated at type: number - x-stream-index: "024" + x-stream-index: "020" user: - $ref: '#/components/schemas/UserResponse' - description: Sender of the message. Required when using server-side API - title: User object - x-stream-index: "007" + $ref: '#/components/schemas/User' + description: User who flagged a message or a user + title: User + x-stream-index: "006" required: - - id - - text - - html - - type - - user - - attachments - - latest_reactions - - own_reactions - - reaction_counts - - reaction_scores - - reply_count - - deleted_reply_count - - cid + - entity_type + - entity_id + - result - created_at - updated_at - - custom - - shadowed - - mentioned_users - - silent - - pinned - - restricted_visibility - title: Message + title: Flag type: object - x-stream-docs-page-id: send_message - MessageStatsResponse: + FlagContentOptions: properties: - count_over_time: - items: - $ref: '#/components/schemas/CountByMinuteResponse' - type: array + reason: + type: string x-stream-index: "001" type: object - MessageUndeletedEvent: + FlagDetails: properties: - channel_id: - type: string - x-stream-index: "005.002" - channel_type: - type: string - x-stream-index: "005.003" - cid: + Extra: + additionalProperties: {} + type: object + writeOnly: true + x-stream-index: "002" + automod: + $ref: '#/components/schemas/AutomodDetails' + x-stream-index: "001" + original_text: type: string - x-stream-index: "005.001" + x-stream-index: "003" + required: + - Extra + - original_text + type: object + FlagFeedback: + properties: created_at: format: date-time type: number - x-stream-index: "004.002" - message: - $ref: '#/components/schemas/Message' - x-stream-index: "001.001" - team: - type: string - x-stream-index: "002.001" - thread_participants: + x-stream-index: "005" + labels: items: - $ref: '#/components/schemas/User' + $ref: '#/components/schemas/Label' type: array - x-stream-index: "001.002" - type: - default: message.undeleted + x-stream-index: "006" + message_id: type: string - x-stream-index: "004.001" - user: - $ref: '#/components/schemas/User' - x-stream-index: "003.001" + x-stream-index: "004" required: - - type + - message_id - created_at - - cid - - channel_id - - channel_type - title: MessageUndeletedEvent + - labels 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 - MessageUpdate: + FlagMessageDetails: properties: - change_set: - $ref: '#/components/schemas/MessageChangeSet' + pin_changed: + type: boolean x-stream-index: "002" - old_text: + should_enrich: + type: boolean + x-stream-index: "003" + skip_push: + type: boolean + x-stream-index: "004" + updated_by_id: type: string x-stream-index: "001" type: object - MessageUpdatedEvent: + FlagRequest: + nullable: true properties: - channel_id: + custom: + additionalProperties: {} + description: Additional metadata about the flag + title: Custom + type: object + x-stream-index: "006" + entity_creator_id: + description: ID of the user who created the flagged entity + title: Entity Creator ID type: string - x-stream-index: "005.002" - channel_type: + x-stream-index: "003" + entity_id: + description: Unique identifier of the entity being flagged + title: Entity ID type: string - x-stream-index: "005.003" - cid: + x-stream-index: "002" + entity_type: + description: Type of entity being flagged (e.g., message, user) + title: Entity Type type: string - x-stream-index: "005.001" - created_at: - format: date-time - type: number - x-stream-index: "004.002" - message: - $ref: '#/components/schemas/Message' - x-stream-index: "001.001" - team: + x-stream-index: "001" + moderation_payload: + $ref: '#/components/schemas/ModerationPayload' + description: Content being flagged + title: Moderation Payload + x-stream-index: "005" + reason: + description: Optional explanation for why the content is being flagged + maxLength: 255 + title: Reason + type: string + x-stream-index: "004" + required: + - entity_type + - entity_id + type: object + FlagResponse: + nullable: true + properties: + duration: type: string x-stream-index: "002.001" - thread_participants: - items: - $ref: '#/components/schemas/User' - type: array - x-stream-index: "001.002" - type: - default: message.updated + item_id: + description: Unique identifier of the created moderation item + title: Item ID type: string - x-stream-index: "004.001" - user: - $ref: '#/components/schemas/User' - x-stream-index: "003.001" + x-stream-index: "001" required: - - type - - created_at - - cid - - channel_id - - channel_type - title: MessageUpdatedEvent + - item_id + - duration 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 - MessageWithChannelResponse: - description: Represents any chat message + FlagUserOptions: properties: - attachments: - description: Array of message attachments + reason: + type: string + x-stream-index: "001" + type: object + FollowBatchRequest: + nullable: true + properties: + follows: + description: List of follow relationships to create items: - $ref: '#/components/schemas/Attachment' - title: Message attachments + $ref: '#/components/schemas/FollowRequest' + maximum: 1000 + minimum: 1 + title: Follows type: array - x-stream-docs-page-id: message_format#attachment-format - x-stream-index: "001.008" - channel: - $ref: '#/components/schemas/ChannelResponse' - description: Channel object - title: Channel - x-stream-index: "002" - cid: - description: Channel unique identifier in : format - title: Channel CID - type: string - x-stream-index: "001.022" - command: - description: Contains provided slash command - title: Command + x-stream-index: "001" + required: + - follows + title: Follow Batch Request + type: object + FollowBatchResponse: + nullable: true + properties: + duration: type: string - x-stream-docs-page-id: custom_commands_webhook - x-stream-index: "001.004" + x-stream-index: "002.001" + follows: + description: List of created follow relationships + items: + $ref: '#/components/schemas/FollowResponse' + title: Follows + type: array + x-stream-index: "001" + required: + - follows + - duration + title: Follow Batch Response + type: object + FollowCreatedEvent: + description: Emitted when a feed follows another feed. + nullable: true + properties: created_at: description: Date/time of creation format: date-time title: Created at type: number - x-stream-index: "001.023" + x-stream-index: 002.001.003 custom: additionalProperties: {} type: object - x-stream-index: "001.026" - deleted_at: - description: Date/time of deletion + x-stream-index: 002.001.007 + feed_visibility: + type: string + x-stream-index: "002.003" + fid: + type: string + x-stream-index: "002.002" + follow: + $ref: '#/components/schemas/FollowResponse' + x-stream-index: "001" + received_at: format: date-time - title: Deleted at type: number - x-stream-index: "001.025" - deleted_reply_count: - format: int32 - type: integer - x-stream-index: "001.018" - draft: - $ref: '#/components/schemas/DraftResponse' - x-stream-index: "001.041" - html: - description: Contains HTML markup of the message. Can only be set when using - server-side API - title: HTML content + x-stream-index: 002.001.004 + type: + default: feeds.follow.created + description: 'The type of event: "feeds.follow.created" in this case' + title: Event Type type: string - x-stream-index: "001.005" - i18n: - additionalProperties: - type: string - description: Object with translations. Key `language` contains the original - language key. Other keys contain translations - title: Internationalization info + x-stream-index: 002.001.002 + required: + - follow + - type + - created_at + - custom + - fid + title: FollowCreatedEvent + 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 + FollowDeletedEvent: + description: Emitted when a feed unfollows another feed. + nullable: true + properties: + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 002.001.003 + custom: + additionalProperties: {} type: object - x-stream-docs-page-id: translation - x-stream-index: "001.030" - id: - description: Message ID is unique string identifier of the message - title: ID + x-stream-index: 002.001.007 + feed_visibility: type: string - x-stream-index: "001.001" - image_labels: - additionalProperties: - items: - type: string - type: array - description: Contains image moderation information - title: Image moderation labels + x-stream-index: "002.003" + fid: + type: string + x-stream-index: "002.002" + follow: + $ref: '#/components/schemas/FollowResponse' + x-stream-index: "001" + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 + type: + default: feeds.follow.deleted + description: 'The type of event: "feeds.follow.deleted" in this case' + title: Event Type + type: string + x-stream-index: 002.001.002 + required: + - follow + - type + - created_at + - custom + - fid + title: FollowDeletedEvent + 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 + FollowRequest: + nullable: true + properties: + create_notification_activity: + description: Whether to create a notification activity for this follow + title: Create Notification Activity + type: boolean + x-stream-index: "004" + custom: + additionalProperties: {} + description: Custom data for the follow relationship + title: Custom Data type: object - x-stream-index: "001.028" - latest_reactions: - description: List of 10 latest reactions to this message - items: - $ref: '#/components/schemas/ReactionResponse' - title: Latest reactions - type: array - x-stream-index: "001.009" - mentioned_users: - description: List of mentioned users - items: - $ref: '#/components/schemas/UserResponse' - title: Mentioned Users - type: array - x-stream-index: "001.029" - message_text_updated_at: + x-stream-index: "002" + push_preference: + description: Push preference for the follow relationship + enum: + - all + - none + title: Push Preference + type: string + x-stream-index: "003" + skip_push: + type: boolean + x-stream-index: "005" + source: + description: Fully qualified ID of the source feed + maxLength: 255 + title: Source Feed + type: string + x-stream-index: "001.001" + target: + description: Fully qualified ID of the target feed + maxLength: 255 + title: Target Feed + type: string + x-stream-index: "001.002" + required: + - source + - target + title: Follow Request + type: object + FollowResponse: + properties: + created_at: + description: When the follow relationship was created format: date-time + title: Created At type: number - x-stream-index: "001.036" - mml: - description: Should be empty if `text` is provided. Can only be set when - using server-side API - title: Messaging Markup Language + x-stream-index: "009" + custom: + additionalProperties: {} + description: Custom data for the follow relationship + title: Custom Data + type: object + x-stream-index: "004" + follower_role: + description: Role of the follower (source user) in the follow relationship + title: Follower Role type: string - x-stream-docs-page-id: mml_overview - x-stream-index: "001.003" - moderation: - $ref: '#/components/schemas/ModerationV2Response' - x-stream-index: "001.039" - own_reactions: - description: List of 10 latest reactions of authenticated user to this message - items: - $ref: '#/components/schemas/ReactionResponse' - title: Own reactions - type: array - x-stream-index: "001.010" - parent_id: - description: ID of parent message (thread) - title: Parent message ID + x-stream-index: "008" + push_preference: + description: Push preference for notifications + enum: + - all + - none + title: Push Preference type: string - x-stream-docs-page-id: threads - x-stream-index: "001.015" - pin_expires: - description: Date when pinned message expires + x-stream-index: "003" + request_accepted_at: + description: When the follow request was accepted format: date-time - title: Pin expiration date + title: Request Accepted At type: number - x-stream-docs-page-id: pinned_messages - x-stream-index: "001.035" - pinned: - description: Whether message is pinned or not - title: Pinned - type: boolean - x-stream-docs-page-id: pinned_messages - x-stream-index: "001.032" - pinned_at: - description: Date when message got pinned + x-stream-index: "005" + request_rejected_at: + description: When the follow request was rejected format: date-time - title: Pinned at + title: Request Rejected At type: number - x-stream-docs-page-id: pinned_messages - x-stream-index: "001.033" - pinned_by: - $ref: '#/components/schemas/UserResponse' - description: Contains user who pinned the message - title: Pinned by - x-stream-docs-page-id: pinned_messages - x-stream-index: "001.034" - poll: - $ref: '#/components/schemas/PollResponseData' - x-stream-index: "001.038" - poll_id: - description: Identifier of the poll to include in the message - title: Poll ID - type: string - x-stream-index: "001.037" - quoted_message: - $ref: '#/components/schemas/MessageResponse' - description: Contains quoted message - title: Quoted message - x-stream-docs-page-id: threads#quote-message - x-stream-index: "001.020" - quoted_message_id: - title: ID of quoted message + x-stream-index: "006" + source_feed: + $ref: '#/components/schemas/FeedResponse' + description: Source feed object + title: Source Feed + x-stream-index: "001" + status: + description: Status of the follow relationship + enum: + - accepted + - pending + - rejected + title: Status type: string - x-stream-docs-page-id: threads#quote-message - x-stream-index: "001.019" - reaction_counts: - additionalProperties: - format: int32 - type: integer - description: 'An object containing number of reactions of each type. Key: - reaction type (string), value: number of reactions (int)' - title: Reaction counts - type: object - x-stream-index: "001.011" - reaction_groups: - additionalProperties: - $ref: '#/components/schemas/ReactionGroupResponse' + x-stream-index: "007" + target_feed: + $ref: '#/components/schemas/FeedResponse' + description: Target feed object + title: Target Feed + x-stream-index: "002" + updated_at: + description: When the follow relationship was last updated + format: date-time + title: Updated At + type: number + x-stream-index: "010" + required: + - source_feed + - target_feed + - push_preference + - status + - follower_role + - created_at + - updated_at + title: Follow + type: object + FollowUpdatedEvent: + description: Emitted when a follow relationship is updated. + nullable: true + properties: + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 002.001.003 + custom: + additionalProperties: {} type: object - x-stream-index: "001.014" - reaction_scores: - additionalProperties: - format: int32 - type: integer - description: 'An object containing scores of reactions of each type. Key: - reaction type (string), value: total score of reactions (int)' - title: Reaction scores - type: object - x-stream-index: "001.012" - reminder: - $ref: '#/components/schemas/ReminderResponseData' - x-stream-index: "001.042" - reply_count: - description: Number of replies to this message - format: int32 - title: Reply count - type: integer - x-stream-index: "001.017" - restricted_visibility: - description: A list of user ids that have restricted visibility to the message, - if the list is not empty, the message is only visible to the users in - the list - items: - type: string - title: Restricted visibility - type: array - x-stream-index: "001.040" - shadowed: - description: Whether the message was shadowed or not - title: Shadowed - type: boolean - x-stream-docs-page-id: moderation#shadow-ban - x-stream-index: "001.027" - shared_location: - $ref: '#/components/schemas/SharedLocationResponseData' - description: Contains shared location data - title: Shared Location - x-stream-index: "001.043" - show_in_channel: - description: Whether thread reply should be shown in the channel as well - title: Show in channel - type: boolean - x-stream-docs-page-id: threads - x-stream-index: "001.016" - silent: - description: Whether message is silent or not - title: Silent - type: boolean - x-stream-index: "001.031" - text: - description: Text of the message. Should be empty if `mml` is provided - title: Text + x-stream-index: 002.001.007 + feed_visibility: type: string - x-stream-index: "001.002" - thread_participants: - description: List of users who participate in thread - items: - $ref: '#/components/schemas/UserResponse' - title: Thread participants - type: array - x-stream-docs-page-id: threads#quote-message - x-stream-index: "001.021" - type: - description: Contains type of the message - enum: - - regular - - ephemeral - - error - - reply - - system - - deleted - title: Message Type + x-stream-index: "002.003" + fid: type: string - x-stream-docs-page-id: message_format#message-types - x-stream-index: "001.006" - updated_at: - description: Date/time of the last update + x-stream-index: "002.002" + follow: + $ref: '#/components/schemas/FollowResponse' + x-stream-index: "001" + received_at: format: date-time - title: Updated at type: number - x-stream-index: "001.024" - user: - $ref: '#/components/schemas/UserResponse' - description: Sender of the message. Required when using server-side API - title: User object - x-stream-index: "001.007" + x-stream-index: 002.001.004 + type: + default: feeds.follow.updated + description: 'The type of event: "feeds.follow.updated" in this case' + title: Event Type + type: string + x-stream-index: 002.001.002 required: - - id - - text - - html + - follow - type - - user - - attachments - - latest_reactions - - own_reactions - - reaction_counts - - reaction_scores - - reply_count - - deleted_reply_count - - cid - created_at - - updated_at - custom - - shadowed - - mentioned_users - - silent - - pinned - - restricted_visibility - - channel - title: Message + - fid + title: FollowUpdatedEvent type: object - x-stream-docs-page-id: send_message - ModerationActionConfig: - nullable: true + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + FrameRecordSettings: properties: - action: - type: string - x-stream-index: "006" - custom: - additionalProperties: {} - type: object - x-stream-index: "009" - description: - type: string - x-stream-index: "008" - entity_type: + capture_interval_in_seconds: + format: int32 + maximum: 60 + minimum: 2 + type: integer + x-stream-index: "003" + mode: + enum: + - available + - disabled + - auto-on type: string - x-stream-index: "004" - icon: + x-stream-index: "001" + quality: type: string - x-stream-index: "007" - order: + x-stream-index: "002" + required: + - mode + - capture_interval_in_seconds + type: object + FrameRecordingEgressConfig: + properties: + capture_interval_in_seconds: format: int32 type: integer + x-stream-index: "007" + external_storage: + $ref: '#/components/schemas/ExternalStorage' + x-stream-index: "006" + quality: + $ref: '#/components/schemas/Quality' + x-stream-index: "004" + storage_name: + type: string x-stream-index: "005" + type: object + FrameRecordingResponse: + properties: + status: + type: string + x-stream-index: "001" required: - - entity_type - - order - - action - - icon - - description - - custom + - status type: object - ModerationCustomActionEvent: + FrameRecordingSettingsRequest: properties: - created_at: - format: date-time - type: number - x-stream-index: "004.002" - item: - $ref: '#/components/schemas/ReviewQueueItem' + capture_interval_in_seconds: + format: int32 + maximum: 60 + minimum: 2 + type: integer + x-stream-index: "003" + mode: + enum: + - available + - disabled + - auto-on + type: string x-stream-index: "001" - message: - $ref: '#/components/schemas/Message' - x-stream-index: "002" - type: - default: moderation.custom_action + quality: + enum: + - 360p + - 480p + - 720p + - 1080p + - 1440p type: string - x-stream-index: "004.001" - user: - $ref: '#/components/schemas/User' - x-stream-index: "003.001" + x-stream-index: "002" required: - - type - - created_at - title: ModerationCustomActionEvent + - mode + - capture_interval_in_seconds 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 - ModerationFlaggedEvent: + FrameRecordingSettingsResponse: properties: - created_at: - format: date-time - type: number - x-stream-index: "004.002" - item: + capture_interval_in_seconds: + format: int32 + maximum: 60 + minimum: 2 + type: integer + x-stream-index: "003" + mode: + enum: + - available + - disabled + - auto-on type: string x-stream-index: "001" - object_id: + quality: type: string x-stream-index: "002" - type: - default: moderation.flagged - type: string - x-stream-index: "004.001" - user: - $ref: '#/components/schemas/User' - x-stream-index: "003.001" required: - - type - - created_at - title: ModerationFlaggedEvent + - mode + - capture_interval_in_seconds 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 - ModerationMarkReviewedEvent: + FullUserResponse: properties: - created_at: + avg_response_time: + format: int32 + type: integer + x-stream-index: "001.018" + ban_expires: format: date-time type: number - x-stream-index: "004.002" - item: - $ref: '#/components/schemas/ReviewQueueItem' - x-stream-index: "001" - message: - $ref: '#/components/schemas/Message' - x-stream-index: "002" - type: - default: moderation.mark_reviewed - type: string - x-stream-index: "004.001" - user: - $ref: '#/components/schemas/User' - x-stream-index: "003.001" - required: - - type - - created_at - title: ModerationMarkReviewedEvent - 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 - ModerationPayload: - properties: - custom: - additionalProperties: {} - type: object - x-stream-index: "004" - images: - items: - type: string - maximum: 30 - type: array - x-stream-index: "002" - texts: + x-stream-index: "015" + banned: + type: boolean + x-stream-index: "001.012" + blocked_user_ids: items: type: string type: array - x-stream-index: "001" - videos: + x-stream-index: "014" + channel_mutes: items: - type: string + $ref: '#/components/schemas/ChannelMute' type: array - x-stream-index: "003" - type: object - ModerationResponse: - properties: - action: - type: string - x-stream-index: "004" - explicit: - format: float + x-stream-index: "007" + created_at: + format: date-time type: number - x-stream-index: "002" - spam: - format: float + x-stream-index: "001.009" + custom: + additionalProperties: {} + type: object + x-stream-index: "001.004" + deactivated_at: + format: date-time type: number - x-stream-index: "003" - toxic: - format: float + x-stream-index: "001.016" + deleted_at: + format: date-time type: number - x-stream-index: "001" - required: - - toxic - - explicit - - spam - - action - - automod_response - type: object - ModerationV2Response: - properties: - action: + x-stream-index: "001.011" + devices: + items: + $ref: '#/components/schemas/DeviceResponse' + type: array + x-stream-index: "004" + id: type: string - x-stream-index: "001" - blocklist_matched: + x-stream-index: "001.001" + image: type: string + x-stream-index: "001.003" + invisible: + type: boolean x-stream-index: "005" - image_harms: + language: + type: string + x-stream-index: "001.005" + last_active: + format: date-time + type: number + x-stream-index: "001.014" + latest_hidden_channels: items: type: string type: array - x-stream-index: "004" - original_text: + x-stream-index: "012" + mutes: + items: + $ref: '#/components/schemas/UserMuteResponse' + type: array + x-stream-index: "006" + name: type: string - x-stream-index: "002" - platform_circumvented: + x-stream-index: "001.002" + online: type: boolean - x-stream-index: "007" - semantic_filter_matched: + x-stream-index: "001.013" + privacy_settings: + $ref: '#/components/schemas/PrivacySettingsResponse' + x-stream-index: "003" + revoke_tokens_issued_before: + format: date-time + type: number + x-stream-index: "001.015" + role: type: string - x-stream-index: "006" - text_harms: + x-stream-index: "001.006" + shadow_banned: + type: boolean + x-stream-index: "013" + teams: items: type: string type: array - x-stream-index: "003" + x-stream-index: "001.007" + teams_role: + additionalProperties: + type: string + type: object + x-stream-index: "001.008" + total_unread_count: + format: int32 + type: integer + x-stream-index: "009" + unread_channels: + format: int32 + type: integer + x-stream-index: "010" + unread_count: + format: int32 + type: integer + x-stream-index: "008" + unread_threads: + format: int32 + type: integer + x-stream-index: "011" + updated_at: + format: date-time + type: number + x-stream-index: "001.010" required: - - action - - original_text + - id + - custom + - language + - role + - teams + - created_at + - updated_at + - banned + - online + - devices + - invisible + - mutes + - channel_mutes + - unread_count + - total_unread_count + - unread_channels + - unread_threads + - shadow_banned + - blocked_user_ids type: object - MuteChannelRequest: - nullable: true + GeofenceSettings: properties: - channel_cids: - description: Channel CIDs to mute (if multiple channels) + names: items: type: string - maximum: 25 - title: Channel CIDs type: array - x-stream-index: "002" - expiration: - description: Duration of mute in milliseconds - title: Expiration - type: integer - x-stream-index: "003" + x-stream-index: "001" + required: + - names type: object - MuteChannelResponse: - nullable: true + GeofenceSettingsRequest: properties: - channel_mute: - $ref: '#/components/schemas/ChannelMute' - description: Object with channel mute (if one channel was muted) - title: Channel mute - x-stream-index: "001" - channel_mutes: - description: Object with mutes (if multiple channels were muted) + names: items: - $ref: '#/components/schemas/ChannelMute' - title: Channel mutes + type: string type: array - x-stream-index: "002" - duration: - type: string - x-stream-index: "004.001" - own_user: - $ref: '#/components/schemas/OwnUser' - description: Authorized user object with fresh mutes information - title: Own user - x-stream-index: "003" - required: - - duration + x-stream-index: "001" type: object - MuteRequest: - nullable: true + GeofenceSettingsResponse: properties: - target_ids: - description: User IDs to mute (if multiple users) + names: items: type: string - title: Target IDs type: array x-stream-index: "001" - timeout: - description: Duration of mute in minutes - minimum: 0 - title: Timeout - type: integer - x-stream-index: "002" required: - - target_ids - title: MuteRequest + - names type: object - MuteResponse: + GetActivityResponse: nullable: true properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + description: The requested activity + title: Activity + x-stream-index: "001" duration: type: string - x-stream-index: "004.001" - mutes: - description: Object with mutes (if multiple users were muted) - items: - $ref: '#/components/schemas/UserMute' - title: Mutes - type: array - x-stream-index: "001" - non_existing_users: - description: A list of users that can't be found. Common cause for this - is deleted users - items: - type: string - title: Non Existing Users - type: array - x-stream-index: "003" - own_user: - $ref: '#/components/schemas/OwnUser' - description: Authorized user object with fresh mutes information - title: Own User - x-stream-index: "002" + x-stream-index: "002.001" required: + - activity - duration - title: MuteResponse + title: Get Activity Response type: object - MuteUsersRequest: + GetApplicationResponse: + description: Basic response information nullable: true properties: - audio: - title: Audio - type: boolean - x-stream-index: "005" - mute_all_users: - type: boolean - x-stream-index: "003" - screenshare: - title: Screenshare - type: boolean - x-stream-index: "007" - screenshare_audio: - title: ScreenshareAudio - type: boolean - x-stream-index: "008" - user_ids: - items: - type: string - title: UserIDs - type: array - x-stream-index: "004" - video: - title: Video - type: boolean - x-stream-index: "006" - title: MuteUsersRequest + app: + $ref: '#/components/schemas/AppResponseFields' + x-stream-index: "001" + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "002.001" + required: + - app + - duration + title: Response type: object - MuteUsersResponse: - description: MuteUsersResponse is the response payload for the mute users endpoint. + GetBlockedUsersResponse: nullable: true properties: + blocks: + description: Array of blocked user object + items: + $ref: '#/components/schemas/BlockedUserResponse' + title: Blocks + type: array + x-stream-index: "001" duration: description: Duration of the request in milliseconds title: Duration type: string - x-stream-index: "001.001" + x-stream-index: "002.001" required: + - blocks - duration - title: MuteUsersResponse type: object - NetworkMetricsReportResponse: + GetCallReportResponse: + description: Basic response information + nullable: true properties: - average_connection_time: - format: float - type: number + chat_activity: + $ref: '#/components/schemas/ChatActivityStatsResponse' + x-stream-index: "004" + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "001.001" + report: + $ref: '#/components/schemas/ReportResponse' x-stream-index: "003" - average_jitter: - format: float - type: number + session_id: + type: string x-stream-index: "002" - average_latency: - format: float - type: number - x-stream-index: "001" - average_time_to_reconnect: - format: float - type: number - x-stream-index: "004" + video_reactions: + items: + $ref: '#/components/schemas/VideoReactionsResponse' + type: array + x-stream-index: "005" + required: + - duration + - session_id + - report + title: Response type: object - NoiseCancellationSettings: + GetCallResponse: + nullable: true properties: - mode: - enum: - - available - - disabled - - auto-on + call: + $ref: '#/components/schemas/CallResponse' + x-stream-index: "001.001" + duration: type: string - x-stream-index: "001" + x-stream-index: "002.001" + members: + items: + $ref: '#/components/schemas/MemberResponse' + type: array + x-stream-index: "001.002" + membership: + $ref: '#/components/schemas/MemberResponse' + x-stream-index: "001.003" + own_capabilities: + items: + $ref: '#/components/schemas/OwnCapability' + type: array + x-stream-index: "001.004" required: - - mode + - call + - members + - own_capabilities + - blocked_users + - duration + title: GetCallResponse type: object - NotificationAddedToChannelEvent: + GetCommentRepliesResponse: + nullable: true properties: - channel: - $ref: '#/components/schemas/ChannelResponse' - x-stream-index: "003.004" - channel_id: + comments: + description: Threaded listing of replies to the comment + items: + $ref: '#/components/schemas/ThreadedCommentResponse' + title: Comments + type: array + x-stream-index: "001" + duration: type: string - x-stream-index: "003.002" - channel_member_count: - format: int32 - type: integer - x-stream-index: "003.005" - channel_type: + x-stream-index: "003.001" + next: type: string - x-stream-index: "003.003" - cid: + x-stream-index: "002.001" + prev: type: string - x-stream-index: "003.001" - created_at: - format: date-time - type: number x-stream-index: "002.002" - member: - $ref: '#/components/schemas/ChannelMember' - x-stream-index: "001.001" - type: - default: notification.added_to_channel + required: + - comments + - duration + title: Get Comment Replies Response + type: object + GetCommentResponse: + nullable: true + properties: + comment: + $ref: '#/components/schemas/CommentResponse' + description: Comment + title: Comment + x-stream-index: "001" + duration: type: string x-stream-index: "002.001" required: - - type - - created_at - - cid - - channel_id - - channel_type - - channel_member_count - title: NotificationAddedToChannelEvent + - comment + - duration + title: Get Comment Response 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 - NotificationChannelDeletedEvent: + GetCommentsResponse: + nullable: true properties: - channel: - $ref: '#/components/schemas/ChannelResponse' - x-stream-index: "003.004" - channel_id: + comments: + description: Threaded listing for the activity + items: + $ref: '#/components/schemas/ThreadedCommentResponse' + title: Comments + type: array + x-stream-index: "001" + duration: type: string - x-stream-index: "003.002" - channel_member_count: - format: int32 - type: integer - x-stream-index: "003.005" - channel_type: + x-stream-index: "003.001" + next: type: string - x-stream-index: "003.003" - cid: + x-stream-index: "002.001" + prev: type: string - x-stream-index: "003.001" - created_at: - format: date-time - type: number x-stream-index: "002.002" - team: - type: string - x-stream-index: "001.001" - type: - default: notification.channel_deleted + required: + - comments + - duration + title: Get Comments Response + type: object + GetConfigResponse: + nullable: true + properties: + config: + $ref: '#/components/schemas/ConfigResponse' + description: The retrieved moderation configuration + title: Config + x-stream-index: "001" + duration: type: string x-stream-index: "002.001" required: - - type - - created_at - - cid - - channel_id - - channel_type - - channel_member_count - title: NotificationChannelDeletedEvent + - duration 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 - NotificationChannelMutesUpdatedEvent: + GetDraftResponse: + description: Basic response information + nullable: true properties: - created_at: - format: date-time - type: number - x-stream-index: "002.002" - me: - $ref: '#/components/schemas/OwnUser' + draft: + $ref: '#/components/schemas/DraftResponse' x-stream-index: "001" - type: - default: notification.channel_mutes_updated + duration: + description: Duration of the request in milliseconds + title: Duration type: string x-stream-index: "002.001" required: - - me - - type - - created_at - title: NotificationChannelMutesUpdatedEvent + - draft + - duration + title: Response 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 - NotificationChannelTruncatedEvent: + GetEdgesResponse: + description: Basic response information + nullable: true properties: - channel: - $ref: '#/components/schemas/ChannelResponse' - x-stream-index: "002.004" - channel_id: - type: string - x-stream-index: "002.002" - channel_member_count: - format: int32 - type: integer - x-stream-index: "002.005" - channel_type: - type: string - x-stream-index: "002.003" - cid: + duration: + description: Duration of the request in milliseconds + title: Duration type: string x-stream-index: "002.001" - created_at: - format: date-time - type: number - x-stream-index: "001.002" - type: - default: notification.channel_truncated - type: string - x-stream-index: "001.001" + edges: + items: + $ref: '#/components/schemas/EdgeResponse' + type: array + x-stream-index: "001" required: - - type - - created_at - - cid - - channel_id - - channel_type - - channel_member_count - title: NotificationChannelTruncatedEvent + - edges + - duration + title: Response 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 - NotificationInviteAcceptedEvent: + GetFollowSuggestionsResponse: + nullable: true properties: - channel: - $ref: '#/components/schemas/ChannelResponse' - x-stream-index: "002.004" - channel_id: - type: string - x-stream-index: "002.002" - channel_member_count: - format: int32 - type: integer - x-stream-index: "002.005" - channel_type: - type: string - x-stream-index: "002.003" - cid: + duration: type: string x-stream-index: "002.001" - created_at: - format: date-time - type: number - x-stream-index: "001.002" - member: - $ref: '#/components/schemas/ChannelMember' - x-stream-index: "004.001" - type: - default: notification.invite_accepted + suggestions: + description: List of suggested feeds to follow + items: + $ref: '#/components/schemas/FeedResponse' + title: Suggestions + type: array + x-stream-index: "001" + required: + - suggestions + - duration + title: Follow Suggestions Response + type: object + GetManyMessagesResponse: + nullable: true + properties: + duration: type: string + x-stream-index: 001.002.001 + messages: + description: List of messages + items: + $ref: '#/components/schemas/MessageResponse' + title: Messages + type: array x-stream-index: "001.001" - user: - $ref: '#/components/schemas/User' - x-stream-index: "003.001" required: - - type - - created_at - - cid - - channel_id - - channel_type - - channel_member_count - title: NotificationInviteAcceptedEvent + - messages + - duration 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 - NotificationInviteRejectedEvent: + GetMessageResponse: + description: Basic response information + nullable: true properties: - channel: - $ref: '#/components/schemas/ChannelResponse' - x-stream-index: "002.004" - channel_id: - type: string - x-stream-index: "002.002" - channel_member_count: - format: int32 - type: integer - x-stream-index: "002.005" - channel_type: - type: string - x-stream-index: "002.003" - cid: - type: string - x-stream-index: "002.001" - created_at: - format: date-time - type: number - x-stream-index: "001.002" - member: - $ref: '#/components/schemas/ChannelMember' - x-stream-index: "004.001" - type: - default: notification.invite_rejected + duration: + description: Duration of the request in milliseconds + title: Duration type: string - x-stream-index: "001.001" - user: - $ref: '#/components/schemas/User' x-stream-index: "003.001" + message: + $ref: '#/components/schemas/MessageWithChannelResponse' + x-stream-index: "001" + pending_message_metadata: + additionalProperties: + type: string + type: object + x-stream-index: "002" required: - - type - - created_at - - cid - - channel_id - - channel_type - - channel_member_count - title: NotificationInviteRejectedEvent + - message + - duration + title: Response 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 - NotificationInvitedEvent: + GetOGResponse: + nullable: true properties: - channel: - $ref: '#/components/schemas/ChannelResponse' - x-stream-index: "002.004" - channel_id: + actions: + items: + $ref: '#/components/schemas/Action' + type: array + x-stream-index: "001.015" + asset_url: + description: URL of detected video or audio + title: Image URL type: string - x-stream-index: "002.002" - channel_member_count: - format: int32 - type: integer - x-stream-index: "002.005" - channel_type: + x-stream-index: "001.017" + author_icon: type: string - x-stream-index: "002.003" - cid: + x-stream-index: "001.007" + author_link: + description: og:site + title: Author Link + type: string + x-stream-index: "001.006" + author_name: + description: og:site_name + title: Author Name + type: string + x-stream-index: "001.005" + color: + type: string + x-stream-index: "001.003" + custom: + additionalProperties: {} + type: object + x-stream-index: "001.018" + duration: type: string x-stream-index: "002.001" - created_at: - format: date-time - type: number + fallback: + type: string x-stream-index: "001.002" - member: - $ref: '#/components/schemas/ChannelMember' - x-stream-index: "004.001" - type: - default: notification.invited + fields: + items: + $ref: '#/components/schemas/Field' + type: array + x-stream-index: "001.016" + footer: type: string - x-stream-index: "001.001" - user: - $ref: '#/components/schemas/User' - x-stream-index: "003.001" - required: - - type - - created_at - - cid - - channel_id - - channel_type - - channel_member_count - title: NotificationInvitedEvent - 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 - NotificationMarkReadEvent: - properties: - channel: - $ref: '#/components/schemas/ChannelResponse' - x-stream-index: "003.004" - channel_id: + x-stream-index: "001.013" + footer_icon: type: string - x-stream-index: "003.002" - channel_member_count: + x-stream-index: "001.014" + giphy: + $ref: '#/components/schemas/Images' + x-stream-index: "001.019" + image_url: + description: URL of detected image + title: Image URL + type: string + x-stream-index: "001.011" + og_scrape_url: + description: extracted url from the text + title: OG Scrape URL + type: string + x-stream-index: "001.020" + original_height: format: int32 type: integer - x-stream-index: "003.005" - channel_type: + x-stream-index: "001.022" + original_width: + format: int32 + type: integer + x-stream-index: "001.021" + pretext: type: string - x-stream-index: "003.003" - cid: + x-stream-index: "001.004" + text: + description: og:description + title: Text type: string - x-stream-index: "003.001" - created_at: - format: date-time - type: number - x-stream-index: "001.002" - team: + x-stream-index: "001.010" + thumb_url: + description: URL of detected thumb image + title: Image URL type: string - x-stream-index: "002.001" - total_unread_count: - format: int32 - type: integer - x-stream-index: "006" + x-stream-index: "001.012" + title: + description: og:title + title: Title + type: string + x-stream-index: "001.008" + title_link: + description: og:url + title: Title Link + type: string + x-stream-index: "001.009" type: - default: notification.mark_read + description: Attachment type, could be empty, image, audio or video + title: Type type: string x-stream-index: "001.001" - unread_channels: + required: + - custom + - duration + title: Get OG Attachment + type: object + x-stream-docs-page-id: og + GetOrCreateCallRequest: + nullable: true + properties: + data: + $ref: '#/components/schemas/CallRequest' + title: ReadOnlyData + x-stream-index: "003" + members_limit: format: int32 + maximum: 100 type: integer x-stream-index: "007" - unread_count: - format: int32 - type: integer + notify: + description: if provided it sends a notification event to the members for + this call + title: Notify + type: boolean x-stream-index: "005" - unread_threads: - format: int32 - type: integer - x-stream-index: "008" - user: - $ref: '#/components/schemas/User' - x-stream-index: "004.001" - required: - - type - - created_at - - cid - - channel_id - - channel_type - - channel_member_count - - unread_count - - total_unread_count - - unread_channels - - unread_threads - title: NotificationMarkReadEvent + ring: + description: if provided it sends a ring event to the members for this call + title: Ring + type: boolean + x-stream-index: "004" + video: + type: boolean + x-stream-index: "006" + title: GetOrCreateCallRequest 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 - NotificationMarkUnreadEvent: + GetOrCreateCallResponse: + nullable: true properties: - channel: - $ref: '#/components/schemas/ChannelResponse' - x-stream-index: "003.004" - channel_id: + call: + $ref: '#/components/schemas/CallResponse' + x-stream-index: "001.001" + created: + type: boolean + x-stream-index: "002" + duration: type: string - x-stream-index: "003.002" - channel_member_count: + x-stream-index: "003.001" + members: + items: + $ref: '#/components/schemas/MemberResponse' + type: array + x-stream-index: "001.002" + membership: + $ref: '#/components/schemas/MemberResponse' + x-stream-index: "001.003" + own_capabilities: + items: + $ref: '#/components/schemas/OwnCapability' + type: array + x-stream-index: "001.004" + required: + - call + - members + - own_capabilities + - blocked_users + - created + - duration + title: GetOrCreateCallResponse + type: object + GetOrCreateFeedRequest: + description: Client request + nullable: true + properties: + activity_selector_options: + additionalProperties: {} + type: object + x-stream-index: "006" + data: + $ref: '#/components/schemas/FeedInput' + x-stream-index: "003" + external_ranking: + additionalProperties: {} + type: object + x-stream-index: "007" + filter: + additionalProperties: {} + type: object + x-stream-index: "009" + followers_pagination: + $ref: '#/components/schemas/PagerRequest' + x-stream-index: "011" + following_pagination: + $ref: '#/components/schemas/PagerRequest' + x-stream-index: "012" + interest_weights: + additionalProperties: + format: float + type: number + type: object + x-stream-index: "008" + limit: format: int32 + maximum: 100 + minimum: 0 type: integer - x-stream-index: "003.005" - channel_type: + x-stream-index: "013.001" + member_pagination: + $ref: '#/components/schemas/PagerRequest' + x-stream-index: "010" + next: type: string - x-stream-index: "003.003" - cid: + x-stream-index: "013.002" + prev: type: string - x-stream-index: "003.001" - created_at: - format: date-time - type: number - x-stream-index: "001.002" - first_unread_message_id: + x-stream-index: "013.003" + view: type: string x-stream-index: "005" - last_read_at: - format: date-time - type: number - x-stream-index: "006" - last_read_message_id: + watch: + type: boolean + x-stream-index: "004" + title: ClientRequest + type: object + GetOrCreateFeedResponse: + description: Basic response information + nullable: true + properties: + activities: + items: + $ref: '#/components/schemas/ActivityResponse' + type: array + x-stream-index: "002" + aggregated_activities: + items: + $ref: '#/components/schemas/AggregatedActivityResponse' + type: array + x-stream-index: "003" + created: + type: boolean + x-stream-index: "015" + duration: + description: Duration of the request in milliseconds + title: Duration type: string + x-stream-index: "017.001" + feed: + $ref: '#/components/schemas/FeedResponse' + x-stream-index: "001" + followers: + items: + $ref: '#/components/schemas/FollowResponse' + type: array + x-stream-index: "005" + followers_pagination: + $ref: '#/components/schemas/PagerResponse' x-stream-index: "012" - team: - type: string - x-stream-index: "002.001" - thread_id: - type: string + following: + items: + $ref: '#/components/schemas/FollowResponse' + type: array + x-stream-index: "006" + following_pagination: + $ref: '#/components/schemas/PagerResponse' x-stream-index: "013" - total_unread_count: - format: int32 - type: integer - x-stream-index: "009" - type: - default: notification.mark_unread + member_pagination: + $ref: '#/components/schemas/PagerResponse' + x-stream-index: "011" + members: + items: + $ref: '#/components/schemas/FeedMemberResponse' + type: array + x-stream-index: "004" + next: type: string - x-stream-index: "001.001" - unread_channels: - format: int32 - type: integer - x-stream-index: "010" - unread_count: - format: int32 - type: integer + x-stream-index: "016.001" + notification_status: + $ref: '#/components/schemas/NotificationStatusResponse' + x-stream-index: "014" + own_capabilities: + items: + $ref: '#/components/schemas/FeedOwnCapability' + type: array x-stream-index: "008" - unread_messages: - format: int32 - type: integer + own_follows: + items: + $ref: '#/components/schemas/FollowResponse' + type: array + x-stream-index: "009" + own_membership: + $ref: '#/components/schemas/FeedMemberResponse' + x-stream-index: "010" + pinned_activities: + items: + $ref: '#/components/schemas/ActivityPinResponse' + type: array x-stream-index: "007" - unread_threads: - format: int32 - type: integer - x-stream-index: "011" - user: - $ref: '#/components/schemas/User' - x-stream-index: "004.001" + prev: + type: string + x-stream-index: "016.002" required: - - type - - created_at - - cid - - channel_id - - channel_type - - channel_member_count - - first_unread_message_id - - last_read_at - - unread_messages - - unread_count - - total_unread_count - - unread_channels - - unread_threads - title: NotificationMarkUnreadEvent + - feed + - activities + - aggregated_activities + - members + - followers + - following + - pinned_activities + - own_capabilities + - created + - duration + title: Response 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 - NotificationMutesUpdatedEvent: + GetReactionsResponse: + nullable: true properties: - created_at: - format: date-time - type: number - x-stream-index: "002.002" - me: - $ref: '#/components/schemas/OwnUser' - x-stream-index: "001" - type: - default: notification.mutes_updated + duration: type: string x-stream-index: "002.001" + reactions: + description: List of reactions + items: + $ref: '#/components/schemas/Reaction' + title: Reactions + type: array + x-stream-index: "001" required: - - me - - type - - created_at - title: NotificationMutesUpdatedEvent + - reactions + - duration 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 - NotificationNewMessageEvent: + GetRepliesResponse: + description: Basic response information + nullable: true properties: - channel: - $ref: '#/components/schemas/ChannelResponse' - x-stream-index: "004.004" - channel_id: - type: string - x-stream-index: "004.002" - channel_member_count: - format: int32 - type: integer - x-stream-index: "004.005" - channel_type: - type: string - x-stream-index: "004.003" - cid: + duration: + description: Duration of the request in milliseconds + title: Duration type: string - x-stream-index: "004.001" - created_at: - format: date-time - type: number - x-stream-index: "003.002" - message: - $ref: '#/components/schemas/Message' + x-stream-index: "002.001" + messages: + items: + $ref: '#/components/schemas/MessageResponse' + type: array x-stream-index: "001" - team: + required: + - messages + - duration + title: Response + type: object + GetThreadResponse: + nullable: true + properties: + duration: type: string x-stream-index: "002.001" - type: - default: notification.message_new - type: string - x-stream-index: "003.001" + thread: + $ref: '#/components/schemas/ThreadStateResponse' + description: Enriched thread state + title: Thread + x-stream-index: "001" required: - - message - - type - - created_at - - cid - - channel_id - - channel_type - - channel_member_count - title: NotificationNewMessageEvent + - thread + - duration 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 - NotificationRemovedFromChannelEvent: + GoLiveRequest: + nullable: true properties: - channel: - $ref: '#/components/schemas/ChannelResponse' - x-stream-index: "002.004" - channel_id: + recording_storage_name: type: string - x-stream-index: "002.002" - channel_member_count: - format: int32 - type: integer - x-stream-index: "002.005" - channel_type: + x-stream-index: "005" + start_closed_caption: + type: boolean + x-stream-index: "008" + start_hls: + type: boolean + x-stream-index: "003" + start_recording: + type: boolean + x-stream-index: "004" + start_transcription: + type: boolean + x-stream-index: "007" + transcription_storage_name: type: string - x-stream-index: "002.003" - cid: + x-stream-index: "006" + title: GoLiveRequest + type: object + GoLiveResponse: + description: Basic response information + nullable: true + properties: + call: + $ref: '#/components/schemas/CallResponse' + x-stream-index: "001" + duration: + description: Duration of the request in milliseconds + title: Duration type: string x-stream-index: "002.001" - created_at: - format: date-time - type: number - x-stream-index: "001.002" - member: - $ref: '#/components/schemas/ChannelMember' - x-stream-index: "004.001" - type: - default: notification.removed_from_channel - type: string - x-stream-index: "001.001" - user: - $ref: '#/components/schemas/User' - x-stream-index: "003.001" required: - - type - - created_at - - cid - - channel_id - - channel_type - - channel_member_count - title: NotificationRemovedFromChannelEvent + - call + - duration + title: Response 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 - NotificationSettings: + GoogleVisionConfig: properties: - call_live_started: - $ref: '#/components/schemas/EventNotificationSettings' - x-stream-index: "002" - call_missed: - $ref: '#/components/schemas/EventNotificationSettings' - x-stream-index: "006" - call_notification: - $ref: '#/components/schemas/EventNotificationSettings' - x-stream-index: "004" - call_ring: - $ref: '#/components/schemas/EventNotificationSettings' - x-stream-index: "005" enabled: type: boolean x-stream-index: "001" - session_started: - $ref: '#/components/schemas/EventNotificationSettings' - x-stream-index: "003" - required: - - enabled - - call_live_started - - session_started - - call_notification - - call_ring - - call_missed - type: object - NullTime: type: object - OCRRule: + GroupedStatsResponse: + nullable: true properties: - action: - enum: - - flag - - shadow - - remove - - bounce - - bounce_flag - - bounce_remove + name: type: string + x-stream-index: "001" + unique: + format: int32 + type: integer x-stream-index: "002" - label: + required: + - name + - unique + type: object + HLSEgressConfig: + properties: + composite_app_settings: + $ref: '#/components/schemas/CompositeAppSettings' + x-stream-index: "005" + playlist_url: type: string + x-stream-index: "007" + qualities: + items: + $ref: '#/components/schemas/Quality' + type: array + x-stream-index: "004" + start_unix_nano: + format: int64 + type: integer + x-stream-index: "006" + type: object + HLSSettings: + properties: + auto_on: + type: boolean x-stream-index: "001" + enabled: + type: boolean + x-stream-index: "002" + layout: + $ref: '#/components/schemas/LayoutSettings' + x-stream-index: "004" + quality_tracks: + items: + type: string + type: array + x-stream-index: "003" required: - - label - - action + - auto_on + - enabled + - quality_tracks type: object - OnlyUserID: + HLSSettingsRequest: properties: - id: - type: string + auto_on: + type: boolean x-stream-index: "001" + enabled: + type: boolean + x-stream-index: "002" + quality_tracks: + items: + type: string + maximum: 3 + minimum: 1 + type: array + x-stream-index: "003" required: - - id + - quality_tracks + title: HLSSettingsRequest type: object - OwnCapability: - description: All possibility of string to use - enum: - - block-users - - change-max-duration - - create-call - - create-reaction - - enable-noise-cancellation - - end-call - - join-backstage - - join-call - - join-ended-call - - mute-users - - pin-for-everyone - - read-call - - remove-call-member - - screenshare - - send-audio - - send-video - - start-broadcast-call - - start-closed-captions-call - - start-frame-record-call - - start-record-call - - start-transcription-call - - stop-broadcast-call - - stop-closed-captions-call - - stop-frame-record-call - - stop-record-call - - stop-transcription-call - - update-call - - update-call-member - - update-call-permissions - - update-call-settings - title: OwnCapability - type: string - OwnUser: + HLSSettingsResponse: + description: HLSSettings is the payload for HLS settings properties: - avg_response_time: - format: int32 - type: integer - x-stream-index: "046" - banned: + auto_on: + title: Auto On type: boolean - x-stream-index: "016" - blocked_user_ids: + x-stream-index: "001" + enabled: + title: Enabled + type: boolean + x-stream-index: "002" + quality_tracks: items: type: string + title: Quality Tracks type: array - x-stream-index: "045" - channel_mutes: + x-stream-index: "003" + required: + - auto_on + - enabled + - quality_tracks + - layout + title: HLSSettingsResponse + type: object + HarmConfig: + properties: + action_sequences: items: - $ref: '#/components/schemas/ChannelMute' + $ref: '#/components/schemas/ActionSequence' type: array - x-stream-index: "029" + x-stream-index: "001" + severity: + type: integer + x-stream-index: "002" + required: + - action_sequences + - severity + type: object + HealthCheckEvent: + nullable: true + properties: + cid: + type: string + x-stream-index: "003" + connection_id: + type: string + x-stream-index: "001" created_at: format: date-time type: number - x-stream-index: "008" + x-stream-index: "004.003" custom: additionalProperties: {} type: object - x-stream-index: "006" - deactivated_at: - format: date-time - type: number - x-stream-index: "014" - deleted_at: + x-stream-index: "004.007" + me: + $ref: '#/components/schemas/OwnUserResponse' + x-stream-index: "002" + received_at: format: date-time type: number - x-stream-index: "013" - devices: - items: - $ref: '#/components/schemas/Device' - type: array - x-stream-index: "027" - id: + x-stream-index: "004.004" + type: + default: health.check type: string - x-stream-index: "003" - invisible: + x-stream-index: "004.002" + required: + - connection_id + - type + - created_at + - custom + title: HealthCheckEvent + 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 + HideChannelRequest: + nullable: true + properties: + clear_history: + description: Whether to clear message history of the channel or not + title: Clear history type: boolean - x-stream-index: "023" - language: + x-stream-index: "001" + type: object + HideChannelResponse: + description: Basic response information + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration type: string - x-stream-index: "035" - last_active: - format: date-time - type: number - x-stream-index: "011" - last_engaged_at: - format: date-time - type: number - x-stream-index: "012" - latest_hidden_channels: + x-stream-index: "001.001" + required: + - duration + title: Response + type: object + ICEServer: + properties: + password: + type: string + x-stream-index: "003" + urls: items: type: string type: array - x-stream-index: "037" - mutes: + x-stream-index: "001" + username: + type: string + x-stream-index: "002" + required: + - urls + - username + - password + type: object + ImageContentParameters: + properties: + harm_labels: items: - $ref: '#/components/schemas/UserMute' + type: string type: array - x-stream-index: "028" - online: - type: boolean - x-stream-index: "022" - privacy_settings: - $ref: '#/components/schemas/PrivacySettings' - x-stream-index: "026" - push_preferences: - $ref: '#/components/schemas/PushPreferences' - x-stream-index: "025" - role: + x-stream-index: "001" + type: object + ImageData: + properties: + frames: + type: string + x-stream-index: "005" + height: + type: string + x-stream-index: "003" + size: type: string x-stream-index: "004" - teams: + url: + type: string + x-stream-index: "001" + width: + type: string + x-stream-index: "002" + required: + - url + - width + - height + - size + - frames + type: object + ImageRuleParameters: + properties: + harm_labels: items: type: string type: array - x-stream-index: "036" - teams_role: - additionalProperties: - type: string - type: object - x-stream-index: "005" - total_unread_count: - format: int32 - type: integer - x-stream-index: "031" - total_unread_count_by_team: - additionalProperties: - format: int32 - type: integer - type: object - x-stream-index: "032" - unread_channels: + x-stream-index: "003" + threshold: format: int32 type: integer - x-stream-index: "033" - unread_count: + x-stream-index: "001" + time_window: + type: string + x-stream-index: "002" + type: object + ImageSize: + properties: + crop: + description: Crop mode + enum: + - top + - bottom + - left + - right + - center + title: Crop + type: string + x-stream-index: "001" + height: + description: Target image height format: int32 + title: Height type: integer - x-stream-index: "030" - unread_threads: + x-stream-index: "003" + resize: + description: Resize method + enum: + - clip + - crop + - scale + - fill + title: Resize + type: string + x-stream-index: "002" + width: + description: Target image width format: int32 + title: Width type: integer - x-stream-index: "034" - updated_at: - format: date-time - type: number - x-stream-index: "009" - required: - - id - - role - - custom - - created_at - - updated_at - - banned - - online - - devices - - mutes - - channel_mutes - - unread_count - - total_unread_count - - total_unread_count_by_team - - unread_channels - - unread_threads - - language + x-stream-index: "004" + title: Image size configuration type: object - OwnUserResponse: + ImageUploadRequest: + nullable: true properties: - avg_response_time: - format: int32 - type: integer - x-stream-index: "001.018" - banned: - type: boolean - x-stream-index: "001.012" - blocked_user_ids: - items: - type: string - type: array - x-stream-index: "015" - channel_mutes: - items: - $ref: '#/components/schemas/ChannelMute' - type: array - x-stream-index: "007" - created_at: - format: date-time - type: number - x-stream-index: "001.009" - custom: - additionalProperties: {} - type: object - x-stream-index: "001.004" - deactivated_at: - format: date-time - type: number - x-stream-index: "001.016" - deleted_at: - format: date-time - type: number - x-stream-index: "001.011" - devices: + file: + type: string + x-stream-index: "001.001" + upload_sizes: + description: field with JSON-encoded array of image size configurations items: - $ref: '#/components/schemas/DeviceResponse' - title: Devices + $ref: '#/components/schemas/ImageSize' + title: Upload sizes type: array - x-stream-index: "004" - id: + x-stream-index: "002" + user: + $ref: '#/components/schemas/OnlyUserID' + x-stream-index: "001.002" + type: object + ImageUploadResponse: + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration type: string - x-stream-index: "001.001" - image: + x-stream-index: 001.003.001 + file: type: string - x-stream-index: "001.003" - invisible: - type: boolean - x-stream-index: "005" - language: + x-stream-index: "001.001" + thumb_url: type: string - x-stream-index: "001.005" - last_active: - format: date-time - type: number - x-stream-index: "001.014" - latest_hidden_channels: - items: - type: string - type: array - x-stream-index: "013" - mutes: + x-stream-index: "001.002" + upload_sizes: + description: Array of image size configurations items: - $ref: '#/components/schemas/UserMuteResponse' + $ref: '#/components/schemas/ImageSize' + title: Upload sizes type: array + x-stream-index: "002" + required: + - duration + type: object + Images: + properties: + fixed_height: + $ref: '#/components/schemas/ImageData' + x-stream-index: "002" + fixed_height_downsampled: + $ref: '#/components/schemas/ImageData' + x-stream-index: "004" + fixed_height_still: + $ref: '#/components/schemas/ImageData' + x-stream-index: "003" + fixed_width: + $ref: '#/components/schemas/ImageData' + x-stream-index: "005" + fixed_width_downsampled: + $ref: '#/components/schemas/ImageData' + x-stream-index: "007" + fixed_width_still: + $ref: '#/components/schemas/ImageData' x-stream-index: "006" - name: - type: string - x-stream-index: "001.002" - online: - type: boolean - x-stream-index: "001.013" - privacy_settings: - $ref: '#/components/schemas/PrivacySettingsResponse' + original: + $ref: '#/components/schemas/ImageData' + x-stream-index: "001" + required: + - original + - fixed_height + - fixed_height_still + - fixed_height_downsampled + - fixed_width + - fixed_width_still + - fixed_width_downsampled + type: object + IngressAudioEncodingOptions: + properties: + bitrate: + maximum: 128000 + minimum: 16000 + type: integer x-stream-index: "003" - push_preferences: - $ref: '#/components/schemas/PushPreferences' - x-stream-index: "002" - revoke_tokens_issued_before: - format: date-time - type: number - x-stream-index: "001.015" - role: - type: string - x-stream-index: "001.006" - teams: - items: - type: string - type: array - x-stream-index: "001.007" - teams_role: - additionalProperties: - type: string - type: object - x-stream-index: "001.008" - total_unread_count: - format: int32 - type: integer - x-stream-index: "009" - total_unread_count_by_team: - additionalProperties: - format: int32 - type: integer - type: object - x-stream-index: "010" - unread_channels: + channels: + enum: + - "1" + - "2" format: int32 type: integer - x-stream-index: "011" - unread_count: - format: int32 + x-stream-index: "001" + enable_dtx: + type: boolean + x-stream-index: "002" + required: + - channels + - enable_dtx + - bitrate + type: object + IngressAudioEncodingOptionsRequest: + properties: + bitrate: + maximum: 128000 + minimum: 16000 type: integer - x-stream-index: "008" - unread_threads: + x-stream-index: "003" + channels: + enum: + - "1" + - "2" format: int32 type: integer - x-stream-index: "012" - updated_at: - format: date-time - type: number - x-stream-index: "001.010" + x-stream-index: "001" + enable_dtx: + type: boolean + x-stream-index: "002" required: - - id - - custom - - language - - role - - teams - - created_at - - updated_at - - banned - - online - - devices - - invisible - - mutes - - channel_mutes - - unread_count - - total_unread_count - - unread_channels - - unread_threads + - channels + - bitrate type: object - PaginationParams: + IngressAudioEncodingResponse: properties: - limit: + bitrate: format: int32 - minimum: 0 type: integer - x-stream-index: "001" - offset: + x-stream-index: "003" + channels: format: int32 type: integer + x-stream-index: "001" + enable_dtx: + type: boolean x-stream-index: "002" + required: + - channels + - enable_dtx + - bitrate type: object - ParticipantCountByMinuteResponse: - nullable: true + IngressSettings: properties: - first: - format: int32 - type: integer + audio_encoding_options: + $ref: '#/components/schemas/IngressAudioEncodingOptions' x-stream-index: "002" - last: - format: int32 - type: integer + enabled: + type: boolean + x-stream-index: "001" + video_encoding_options: + additionalProperties: + $ref: '#/components/schemas/IngressVideoEncodingOptions' + type: object x-stream-index: "003" - max: - format: int32 - type: integer - x-stream-index: "004" - min: - format: int32 - type: integer - x-stream-index: "005" - start_ts: - format: date-time - type: number + required: + - enabled + type: object + IngressSettingsRequest: + properties: + audio_encoding_options: + $ref: '#/components/schemas/IngressAudioEncodingOptionsRequest' + x-stream-index: "002" + enabled: + type: boolean + x-stream-index: "001" + video_encoding_options: + additionalProperties: + $ref: '#/components/schemas/IngressVideoEncodingOptionsRequest' + type: object + x-stream-index: "003" + type: object + IngressSettingsResponse: + properties: + audio_encoding_options: + $ref: '#/components/schemas/IngressAudioEncodingResponse' + x-stream-index: "002" + enabled: + type: boolean x-stream-index: "001" + video_encoding_options: + additionalProperties: + $ref: '#/components/schemas/IngressVideoEncodingResponse' + type: object + x-stream-index: "003" required: - - start_ts - - first - - last - - max - - min + - enabled type: object - ParticipantCountOverTimeResponse: + IngressVideoEncodingOptions: properties: - by_minute: + layers: items: - $ref: '#/components/schemas/ParticipantCountByMinuteResponse' + $ref: '#/components/schemas/IngressVideoLayer' + minimum: 1 type: array x-stream-index: "001" + required: + - layers type: object - ParticipantReportResponse: + IngressVideoEncodingOptionsRequest: properties: - by_browser: - items: - $ref: '#/components/schemas/GroupedStatsResponse' - type: array - x-stream-index: "008" - by_country: - items: - $ref: '#/components/schemas/GroupedStatsResponse' - type: array - x-stream-index: "005" - by_device: + layers: items: - $ref: '#/components/schemas/GroupedStatsResponse' + $ref: '#/components/schemas/IngressVideoLayerRequest' + minimum: 1 type: array - x-stream-index: "006" - by_operating_system: + x-stream-index: "001" + required: + - layers + type: object + IngressVideoEncodingResponse: + properties: + layers: items: - $ref: '#/components/schemas/GroupedStatsResponse' + $ref: '#/components/schemas/IngressVideoLayerResponse' type: array - x-stream-index: "007" - count_over_time: - $ref: '#/components/schemas/ParticipantCountOverTimeResponse' - x-stream-index: "004" - max_concurrent: - format: int32 + x-stream-index: "001" + required: + - layers + type: object + IngressVideoLayer: + nullable: true + properties: + bitrate: + minimum: 1000 + type: integer + x-stream-index: "002" + codec: + enum: + - h264 + - vp8 + type: string + x-stream-index: "001" + frame_rate: + maximum: 60 + minimum: 1 type: integer x-stream-index: "003" - publishers: - $ref: '#/components/schemas/PublisherStatsResponse' - x-stream-index: "009" - subscribers: - $ref: '#/components/schemas/SubscriberStatsResponse' - x-stream-index: "010" - sum: - format: int32 + max_dimension: + minimum: 240 type: integer - x-stream-index: "001" - unique: - format: int32 + x-stream-index: "005" + min_dimension: + minimum: 240 type: integer - x-stream-index: "002" + x-stream-index: "004" required: - - sum - - unique + - codec + - bitrate + - frame_rate + - min_dimension + - max_dimension type: object - PendingMessageEvent: - description: Pending message event for async moderation + IngressVideoLayerRequest: nullable: true properties: - channel: - $ref: '#/components/schemas/Channel' - x-stream-index: "002.007" - created_at: - description: Date/time of creation - format: date-time - title: Created at - type: number - x-stream-index: "004" - custom: - additionalProperties: {} - type: object - x-stream-index: "001.007" - message: - $ref: '#/components/schemas/Message' - description: The pending message - title: Message - x-stream-index: "002.009" - metadata: - additionalProperties: - type: string - type: object - x-stream-index: "002.010" - method: - description: The method used for the pending message - title: Method + bitrate: + format: int32 + minimum: 1000 + type: integer + x-stream-index: "002" + codec: + enum: + - h264 + - vp8 type: string + x-stream-index: "001" + frame_rate_limit: + maximum: 60 + minimum: 1 + type: integer + x-stream-index: "005" + max_dimension: + minimum: 240 + type: integer + x-stream-index: "004" + min_dimension: + minimum: 240 + type: integer x-stream-index: "003" - received_at: - format: date-time - type: number - x-stream-index: "001.004" - type: - default: message.pending - description: 'The type of event: "message.pending" in this case' - title: Event Type - type: string - x-stream-index: "001.002" - user: - $ref: '#/components/schemas/User' - x-stream-index: "002.002" required: - - type - - custom - - method - - created_at - title: PendingMessageEvent + - codec + - bitrate + - min_dimension + - max_dimension + - frame_rate_limit 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 - PendingMessageResponse: + IngressVideoLayerResponse: nullable: true properties: - channel: - $ref: '#/components/schemas/ChannelResponse' + bitrate: + type: integer x-stream-index: "002" - message: - $ref: '#/components/schemas/MessageResponse' - x-stream-index: "003" - metadata: - additionalProperties: - type: string - type: object - x-stream-index: "004" - user: - $ref: '#/components/schemas/UserResponse' + codec: + type: string x-stream-index: "001" + frame_rate_limit: + type: integer + x-stream-index: "005" + max_dimension: + type: integer + x-stream-index: "004" + min_dimension: + type: integer + x-stream-index: "003" + required: + - codec + - bitrate + - min_dimension + - max_dimension + - frame_rate_limit type: object - PerSDKUsageReport: + JoinCallRequest: nullable: true properties: - by_version: - additionalProperties: - format: int32 - type: integer - type: object + create: + description: if true the call will be created if it doesn't exist + title: Create + type: boolean x-stream-index: "002" - total: + data: + $ref: '#/components/schemas/CallRequest' + x-stream-index: "003" + location: + title: Location + type: string + x-stream-index: "009" + members_limit: format: int32 + maximum: 100 + title: The amount of members that should be returned type: integer - x-stream-index: "001" + x-stream-index: "007" + migrating_from: + description: If the participant is migrating from another SFU, then this + is the ID of the previous SFU + title: MigratingFrom + type: string + x-stream-index: "010" + notify: + type: boolean + x-stream-index: "005" + ring: + description: if true and the call is created, the notification will include + ring=true + title: Ring + type: boolean + x-stream-index: "004" + video: + type: boolean + x-stream-index: "006" required: - - total - - by_version + - location + title: JoinCallRequest type: object - PermissionRequestEvent: - description: |- - This event is sent when a user requests access to a feature on a call, - clients receiving this event should display a permission request to the user + JoinCallResponse: + nullable: true + properties: + call: + $ref: '#/components/schemas/CallResponse' + x-stream-index: "001.001" + created: + title: Created + type: boolean + x-stream-index: "002" + credentials: + $ref: '#/components/schemas/Credentials' + title: Credentials + x-stream-index: "003" + duration: + type: string + x-stream-index: "005.001" + members: + items: + $ref: '#/components/schemas/MemberResponse' + type: array + x-stream-index: "001.002" + membership: + $ref: '#/components/schemas/MemberResponse' + x-stream-index: "001.003" + own_capabilities: + items: + $ref: '#/components/schemas/OwnCapability' + type: array + x-stream-index: "001.004" + stats_options: + $ref: '#/components/schemas/StatsOptions' + x-stream-index: "004" + required: + - call + - members + - own_capabilities + - blocked_users + - created + - credentials + - stats_options + - duration + title: JoinCallResponse + type: object + KickUserRequest: + description: KickUserRequest is the payload for kicking a user from a call. + Optionally block the user as well. + nullable: true + properties: + block: + description: If true, also block the user from rejoining the call + title: Block + type: boolean + x-stream-index: "004" + user_id: + description: The user to kick + title: UserID + type: string + x-stream-index: "003" + required: + - user_id + title: KickUserRequest + type: object + KickUserResponse: + description: KickUserResponse is the payload for kicking a user from a call. + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "001.001" + required: + - duration + title: KickUserResponse + type: object + KickedUserEvent: + description: This event is sent to call participants to notify when a user is + kicked from a call. Clients should make the kicked user leave the call UI. properties: call_cid: type: string @@ -12716,22 +13501,20 @@ components: format: date-time type: number x-stream-index: "001.002" - permissions: - description: The list of permissions requested by the user - items: - type: string - title: Permissions - type: array + kicked_by_user: + $ref: '#/components/schemas/UserResponse' + description: The user that kicked the participant, null if server-side + title: Kicked by x-stream-index: "004" type: - default: call.permission_request - description: 'The type of event: "call.permission_request" in this case' + default: call.kicked_user + description: 'The type of event: "call.kicked_user" in this case' title: Event Type type: string x-stream-index: "001.001" user: $ref: '#/components/schemas/UserResponse' - description: The user who sent the permission request + description: The user that was kicked title: User x-stream-index: "003" required: @@ -12739,728 +13522,595 @@ components: - created_at - call_cid - user - - permissions - title: PermissionRequestEvent + title: KickedUserEvent type: object x-stream-event-call-type: true x-stream-event-doc-group: call x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - PinRequest: - description: PinRequest is the payload for pinning a message. - nullable: true + LLMConfig: properties: - session_id: - description: the session ID of the user who pinned the message - title: SessionID - type: string - x-stream-index: "003" - user_id: - description: the user ID of the user who pinned the message - title: UserID + app_context: type: string + x-stream-index: "005" + async: + type: boolean + x-stream-index: "001" + enabled: + type: boolean x-stream-index: "002" + rules: + items: + $ref: '#/components/schemas/LLMRule' + type: array + x-stream-index: "003" + severity_descriptions: + additionalProperties: + type: string + type: object + x-stream-index: "004" required: - - user_id - - session_id - title: PinRequest - type: object - PinResponse: - 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 + - enabled + - rules type: object - Poll: + LLMRule: properties: - Custom: - additionalProperties: {} - type: object - writeOnly: true - x-stream-index: "023" - allow_answers: - type: boolean - x-stream-index: "010" - allow_user_suggested_options: - type: boolean - x-stream-index: "009" - answers_count: - format: int32 - type: integer - x-stream-index: "015" - created_at: - format: date-time - type: number - x-stream-index: "021" - created_by: - $ref: '#/components/schemas/User' - x-stream-index: "020" - created_by_id: + action: + enum: + - flag + - shadow + - remove + - bounce + - bounce_flag + - bounce_remove + - keep type: string - x-stream-index: "019" + x-stream-index: "003" description: type: string - x-stream-index: "005" - enforce_unique_vote: - type: boolean - x-stream-index: "007" - id: + x-stream-index: "002" + label: type: string - x-stream-index: "003" - is_closed: - type: boolean - x-stream-index: "011" - latest_answers: + x-stream-index: "001" + severity_rules: items: - $ref: '#/components/schemas/PollVote' + $ref: '#/components/schemas/BodyguardSeverityRule' type: array - x-stream-index: "017" - latest_votes_by_option: - additionalProperties: - items: - $ref: '#/components/schemas/PollVote' - type: array - type: object - x-stream-index: "016" - max_votes_allowed: - format: int32 - type: integer - x-stream-index: "008" - name: - type: string x-stream-index: "004" - options: + required: + - label + - description + - action + - severity_rules + type: object + Label: + properties: + harm_labels: items: - $ref: '#/components/schemas/PollOption' + type: string type: array - x-stream-index: "013" - own_votes: + x-stream-index: "003" + name: + type: string + x-stream-index: "001" + phrase_list_ids: items: - $ref: '#/components/schemas/PollVote' - type: array - x-stream-index: "018" - updated_at: - format: date-time - type: number - x-stream-index: "022" - vote_count: - format: int32 - type: integer - x-stream-index: "012" - vote_counts_by_option: - additionalProperties: format: int32 type: integer - type: object - x-stream-index: "014" - voting_visibility: - type: string - x-stream-index: "006" + type: array + x-stream-index: "002" required: - - id - name - - description - - enforce_unique_vote - - allow_user_suggested_options - - allow_answers - - vote_count - - options - - vote_counts_by_option - - answers_count - - latest_votes_by_option - - latest_answers - - own_votes - - created_by_id - - created_at - - updated_at - - Custom type: object - PollClosedEvent: - description: Emitted when a poll is closed. - nullable: true + LabelThresholds: properties: - activity_id: - type: string - x-stream-index: "001.003" - cid: - description: The CID of the channel containing the poll - title: Channel CID - type: string - x-stream-index: 001.001.002 - created_at: - description: Date/time of creation - format: date-time - title: Created at + block: + description: Threshold for automatic message block + format: float + maximum: 1 + minimum: 0 + title: Block type: number - x-stream-index: 001.001.001.003 - custom: - additionalProperties: {} - type: object - x-stream-index: 001.001.001.007 - message_id: - description: The ID of the message containing the poll - title: Message ID - type: string - x-stream-index: "001.002" - poll: - $ref: '#/components/schemas/PollResponseData' - description: The poll object which was closed - title: Poll - x-stream-index: "001.004" - received_at: - format: date-time + x-stream-index: "002" + flag: + description: Threshold for automatic message flag + format: float + maximum: 1 + minimum: 0 + title: Flag type: number - x-stream-index: 001.001.001.004 - type: - default: poll.closed - description: 'The type of event: "poll.closed" in this case' - title: Event Type - type: string - x-stream-index: 001.001.001.002 - required: - - type - - created_at - - custom - - poll - title: PollClosedEvent + x-stream-index: "001" 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 - PollDeletedEvent: - description: Emitted when a poll is deleted. - nullable: true + LayoutSettings: properties: - activity_id: + detect_orientation: + type: boolean + x-stream-index: "005" + external_app_url: type: string - x-stream-index: "001.003" - cid: - description: The CID of the channel containing the poll - title: Channel CID + x-stream-index: "003" + external_css_url: type: string - x-stream-index: 001.001.002 - created_at: - description: Date/time of creation - format: date-time - title: Created at - type: number - x-stream-index: 001.001.001.003 - custom: + x-stream-index: "004" + name: + enum: + - spotlight + - grid + - single-participant + - mobile + - custom + type: string + x-stream-index: "001" + options: additionalProperties: {} type: object - x-stream-index: 001.001.001.007 - message_id: - description: The ID of the message containing the poll - title: Message ID + x-stream-index: "002" + required: + - name + - external_app_url + - external_css_url + type: object + LayoutSettingsRequest: + properties: + detect_orientation: + type: boolean + x-stream-index: "005" + external_app_url: type: string - x-stream-index: "001.002" - poll: - $ref: '#/components/schemas/PollResponseData' - description: The poll object which was deleted - title: Poll - x-stream-index: "001.004" - received_at: - format: date-time - type: number - x-stream-index: 001.001.001.004 - type: - default: poll.deleted - description: 'The type of event: "poll.deleted" in this case' - title: Event Type + x-stream-index: "003" + external_css_url: type: string - x-stream-index: 001.001.001.002 + x-stream-index: "004" + name: + enum: + - spotlight + - grid + - single-participant + - mobile + - custom + type: string + x-stream-index: "001" + options: + additionalProperties: {} + type: object + x-stream-index: "002" required: - - type - - created_at - - custom - - poll - title: PollDeletedEvent + - name 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 - PollOption: - nullable: true + LimitsSettings: properties: - custom: - additionalProperties: {} - type: object - x-stream-index: "003" - id: - maxLength: 255 - type: string + max_duration_seconds: + format: int32 + type: integer + x-stream-index: "004" + max_participants: + format: int32 + type: integer x-stream-index: "001" - text: - type: string + max_participants_exclude_owner: + type: boolean + x-stream-index: "003" + max_participants_exclude_roles: + items: + type: string + type: array x-stream-index: "002" required: - - id - - text - - custom + - max_participants_exclude_roles type: object - PollOptionInput: - nullable: true + LimitsSettingsRequest: properties: - custom: - additionalProperties: {} - type: object + max_duration_seconds: + format: int32 + minimum: 0 + type: integer + x-stream-index: "004" + max_participants: + format: int32 + type: integer + x-stream-index: "001" + max_participants_exclude_owner: + type: boolean x-stream-index: "003" - text: - type: string + max_participants_exclude_roles: + items: + type: string + type: array x-stream-index: "002" type: object - PollOptionRequest: - nullable: true + LimitsSettingsResponse: properties: - custom: - additionalProperties: {} - type: object - x-stream-index: "003" - id: - maxLength: 255 - type: string + max_duration_seconds: + format: int32 + type: integer + x-stream-index: "004" + max_participants: + format: int32 + type: integer x-stream-index: "001" - text: - type: string + max_participants_exclude_owner: + type: boolean + x-stream-index: "003" + max_participants_exclude_roles: + items: + type: string + type: array x-stream-index: "002" required: - - id + - max_participants_exclude_roles type: object - PollOptionResponse: + ListBlockListResponse: + description: Basic response information nullable: true properties: + blocklists: + items: + $ref: '#/components/schemas/BlockListResponse' + type: array + x-stream-index: "001" duration: description: Duration of the request in milliseconds title: Duration type: string x-stream-index: "002.001" - poll_option: - $ref: '#/components/schemas/PollOptionResponseData' - description: Poll option - title: PollOptionResponseData - x-stream-index: "001" required: - - poll_option + - blocklists - duration + title: Response type: object - PollOptionResponseData: + ListDevicesResponse: + description: List devices response nullable: true properties: - custom: - additionalProperties: {} - type: object - x-stream-index: "003" - id: - type: string + devices: + description: List of devices + items: + $ref: '#/components/schemas/DeviceResponse' + title: Devices + type: array x-stream-index: "001" - text: + duration: type: string - x-stream-index: "002" + x-stream-index: "002.001" required: - - id - - text - - custom + - devices + - duration + title: ListDevicesResponse type: object - PollResponse: + ListRecordingsResponse: + description: Response for listing recordings nullable: true properties: duration: - description: Duration of the request in milliseconds - title: Duration type: string - x-stream-index: "002.001" - poll: - $ref: '#/components/schemas/PollResponseData' - description: Poll - title: PollResponseData - x-stream-index: "001" + x-stream-index: "001.001" + recordings: + items: + $ref: '#/components/schemas/CallRecording' + title: The list of recordings. + type: array + x-stream-index: "002" required: - - poll - duration + - recordings + title: ListRecordingsResponse type: object - PollResponseData: + ListTranscriptionsResponse: + nullable: true properties: - allow_answers: - type: boolean - x-stream-index: "008" - allow_user_suggested_options: - type: boolean - x-stream-index: "007" - answers_count: - format: int32 - type: integer - x-stream-index: "012" - created_at: - format: date-time - type: number - x-stream-index: "019" - created_by: - $ref: '#/components/schemas/UserResponse' - x-stream-index: "018" - created_by_id: - type: string - x-stream-index: "017" - custom: - additionalProperties: {} - type: object - x-stream-index: "021" - description: + duration: type: string - x-stream-index: "003" - enforce_unique_vote: + x-stream-index: "001.001" + transcriptions: + description: List of transcriptions for the call + items: + $ref: '#/components/schemas/CallTranscription' + title: Transcriptions + type: array + x-stream-index: "002" + required: + - duration + - transcriptions + title: ListTranscriptionsResponse + type: object + MarkActivityRequest: + nullable: true + properties: + mark_all_read: + description: Whether to mark all activities as read + title: Mark All Read type: boolean x-stream-index: "005" - id: - type: string - x-stream-index: "001" - is_closed: + mark_all_seen: + description: Whether to mark all activities as seen + title: Mark All Seen type: boolean - x-stream-index: "009" - latest_answers: + x-stream-index: "003" + mark_read: + description: List of activity IDs to mark as read items: - $ref: '#/components/schemas/PollVoteResponseData' + type: string + title: Mark Read type: array - x-stream-index: "015" - latest_votes_by_option: - additionalProperties: - items: - $ref: '#/components/schemas/PollVoteResponseData' - type: array - type: object - x-stream-index: "014" - max_votes_allowed: - format: int32 - type: integer - x-stream-index: "006" - name: - type: string - x-stream-index: "002" - options: + x-stream-index: "004" + mark_seen: + description: List of activity IDs to mark as seen items: - $ref: '#/components/schemas/PollOptionResponseData' + type: string + title: Mark Seen type: array - x-stream-index: "011" - own_votes: + x-stream-index: "006" + mark_watched: + description: List of activity IDs to mark as watched (for stories) items: - $ref: '#/components/schemas/PollVoteResponseData' + type: string + title: Mark Watched type: array - x-stream-index: "016" - updated_at: - format: date-time - type: number - x-stream-index: "020" - vote_count: - format: int32 - type: integer - x-stream-index: "010" - vote_counts_by_option: + x-stream-index: "007" + title: Mark Activity Request + type: object + MarkChannelsReadRequest: + nullable: true + properties: + read_by_channel: additionalProperties: - format: int32 - type: integer + type: string + description: Map of channel ID to last read message ID + maximum: 30 + title: Read by channel type: object - x-stream-index: "013" - voting_visibility: + x-stream-index: "001" + type: object + MarkReadRequest: + nullable: true + properties: + message_id: + description: ID of the message that is considered last read by client + title: Message ID type: string - x-stream-index: "004" + x-stream-index: "001" + thread_id: + description: Optional Thread ID to specifically mark a given thread as read + title: Thread ID + type: string + x-stream-index: "002" + type: object + MarkReadResponse: + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "002.001" + event: + $ref: '#/components/schemas/MessageReadEvent' + description: Mark read event + title: Event + x-stream-index: "001" required: - - id - - name - - description - - voting_visibility - - enforce_unique_vote - - allow_user_suggested_options - - allow_answers - - vote_count - - options - - answers_count - - vote_counts_by_option - - latest_votes_by_option - - latest_answers - - own_votes - - created_by_id - - created_at - - updated_at - - custom + - duration type: object - PollUpdatedEvent: - description: Emitted when a poll is updated. + MarkReviewedRequest: + properties: + content_to_mark_as_reviewed_limit: + format: int32 + maximum: 2500 + type: integer + x-stream-index: "002" + disable_marking_content_as_reviewed: + type: boolean + x-stream-index: "001" + type: object + MarkUnreadRequest: nullable: true properties: - activity_id: + message_id: + description: ID of the message from where the channel is marked unread + title: Message ID type: string - x-stream-index: "001.003" + x-stream-index: "001" + thread_id: + description: Mark a thread unread, specify both the thread and message id + title: Thread ID + type: string + x-stream-index: "003" + type: object + MemberAddedEvent: + properties: + channel_id: + type: string + x-stream-index: "004.002" + channel_type: + type: string + x-stream-index: "004.003" cid: - description: The CID of the channel containing the poll - title: Channel CID type: string - x-stream-index: 001.001.002 + x-stream-index: "004.001" created_at: - description: Date/time of creation format: date-time - title: Created at type: number - x-stream-index: 001.001.001.003 - custom: - additionalProperties: {} - type: object - x-stream-index: 001.001.001.007 - message_id: - description: The ID of the message containing the poll - title: Message ID + x-stream-index: "003.002" + member: + $ref: '#/components/schemas/ChannelMember' + x-stream-index: "001.001" + team: type: string - x-stream-index: "001.002" - poll: - $ref: '#/components/schemas/PollResponseData' - description: The poll object which was updated - title: Poll - x-stream-index: "001.004" - received_at: - format: date-time - type: number - x-stream-index: 001.001.001.004 + x-stream-index: "002.001" type: - default: poll.updated - description: 'The type of event: "poll.updated" in this case' - title: Event Type + default: member.added type: string - x-stream-index: 001.001.001.002 + x-stream-index: "003.001" + user: + $ref: '#/components/schemas/User' + x-stream-index: "005.001" required: - type - created_at - - custom - - poll - title: PollUpdatedEvent + - cid + - channel_id + - channel_type + title: MemberAddedEvent 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 - PollVote: - nullable: true + MemberLookup: properties: - answer_text: - type: string - x-stream-index: "007" - created_at: - format: date-time - type: number - x-stream-index: "010" - id: + Limit: + format: int32 + type: integer + writeOnly: true + x-stream-index: "001" + required: + - Limit + type: object + MemberRemovedEvent: + properties: + channel_id: type: string - x-stream-index: "004" - is_answer: - type: boolean - x-stream-index: "006" - option_id: + x-stream-index: "003.002" + channel_type: type: string - x-stream-index: "005" - poll_id: + x-stream-index: "003.003" + cid: type: string - x-stream-index: "003" - updated_at: + x-stream-index: "003.001" + created_at: format: date-time type: number - x-stream-index: "011" + x-stream-index: "002.002" + member: + $ref: '#/components/schemas/ChannelMember' + x-stream-index: "001.001" + type: + default: member.removed + type: string + x-stream-index: "002.001" user: $ref: '#/components/schemas/User' - x-stream-index: "009" - user_id: - type: string - x-stream-index: "008" + x-stream-index: "004.001" required: - - poll_id - - id - - option_id + - type - created_at - - updated_at + - cid + - channel_id + - channel_type + title: MemberRemovedEvent type: object - PollVoteCastedEvent: - description: Emitted when a vote is cast on a poll. - nullable: true + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + MemberRequest: + description: MemberRequest is the payload for adding a member to a call. properties: - activity_id: + custom: + additionalProperties: {} + description: Custom data for this object + title: Custom data + type: object + x-stream-index: "003" + role: + title: Role type: string - x-stream-index: 001.001.003 - cid: - description: The CID of the channel containing the poll - title: Channel CID + x-stream-index: "002" + user_id: + minLength: 1 + title: User ID type: string - x-stream-index: 001.001.001.002 + x-stream-index: "001" + required: + - user_id + title: MemberRequest + type: object + MemberResponse: + description: MemberResponse is the payload for a member of a call. + properties: created_at: description: Date/time of creation format: date-time title: Created at type: number - x-stream-index: 001.001.001.001.003 + x-stream-index: "005" custom: additionalProperties: {} + description: Custom member response data + title: Custom type: object - x-stream-index: 001.001.001.001.007 - message_id: - description: The ID of the message containing the poll - title: Message ID - type: string - x-stream-index: 001.001.002 - poll: - $ref: '#/components/schemas/PollResponseData' - description: The poll object - title: Poll - x-stream-index: 001.001.004 - poll_vote: - $ref: '#/components/schemas/PollVoteResponseData' - description: The vote that was cast - title: Poll Vote - x-stream-index: "001.002" - received_at: - format: date-time - type: number - x-stream-index: 001.001.001.001.004 - type: - default: poll.vote_casted - description: 'The type of event: "poll.vote_casted" in this case' - title: Event Type - type: string - x-stream-index: 001.001.001.001.002 - required: - - type - - created_at - - custom - - poll - - poll_vote - title: PollVoteCastedEvent - 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 - PollVoteChangedEvent: - description: Emitted when a vote on a poll is changed. - nullable: true - properties: - activity_id: - type: string - x-stream-index: 001.001.003 - cid: - description: The CID of the channel containing the poll - title: Channel CID - type: string - x-stream-index: 001.001.001.002 - created_at: - description: Date/time of creation + x-stream-index: "004" + deleted_at: + description: Date/time of deletion format: date-time - title: Created at + title: Deleted at type: number - x-stream-index: 001.001.001.001.003 - custom: - additionalProperties: {} - type: object - x-stream-index: 001.001.001.001.007 - message_id: - description: The ID of the message containing the poll - title: Message ID + x-stream-index: "007" + role: + title: Role type: string - x-stream-index: 001.001.002 - poll: - $ref: '#/components/schemas/PollResponseData' - description: The poll object - title: Poll - x-stream-index: 001.001.004 - poll_vote: - $ref: '#/components/schemas/PollVoteResponseData' - description: The updated vote - title: Poll Vote - x-stream-index: "001.002" - received_at: + x-stream-index: "003" + updated_at: + description: Date/time of the last update format: date-time + title: Updated at type: number - x-stream-index: 001.001.001.001.004 - type: - default: poll.vote_changed - description: 'The type of event: "poll.vote_changed" in this case' - title: Event Type + x-stream-index: "006" + user: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "001" + user_id: type: string - x-stream-index: 001.001.001.001.002 + x-stream-index: "002" required: - - type - - created_at + - user + - user_id - custom - - poll - - poll_vote - title: PollVoteChangedEvent + - created_at + - updated_at + title: MemberResponse 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 - PollVoteRemovedEvent: - description: Emitted when a vote is removed from a poll. - nullable: true + MemberUpdatedEvent: properties: - activity_id: + channel_id: type: string - x-stream-index: 001.001.003 + x-stream-index: "005.002" + channel_type: + type: string + x-stream-index: "005.003" cid: - description: The CID of the channel containing the poll - title: Channel CID type: string - x-stream-index: 001.001.001.002 + x-stream-index: "005.001" created_at: - description: Date/time of creation format: date-time - title: Created at type: number - x-stream-index: 001.001.001.001.003 - custom: - additionalProperties: {} - type: object - x-stream-index: 001.001.001.001.007 - message_id: - description: The ID of the message containing the poll - title: Message ID + x-stream-index: "003.002" + member: + $ref: '#/components/schemas/ChannelMember' + x-stream-index: "001.001" + team: type: string - x-stream-index: 001.001.002 - poll: - $ref: '#/components/schemas/PollResponseData' - description: The poll object - title: Poll - x-stream-index: 001.001.004 - poll_vote: - $ref: '#/components/schemas/PollVoteResponseData' - description: The vote that was removed - title: Poll Vote - x-stream-index: "001.002" - received_at: - format: date-time - type: number - x-stream-index: 001.001.001.001.004 + x-stream-index: "002.001" type: - default: poll.vote_removed - description: 'The type of event: "poll.vote_removed" in this case' - title: Event Type + default: member.updated type: string - x-stream-index: 001.001.001.001.002 + x-stream-index: "003.001" + user: + $ref: '#/components/schemas/User' + x-stream-index: "004.001" required: - type - created_at - - custom - - poll - - poll_vote - title: PollVoteRemovedEvent + - cid + - channel_id + - channel_type + title: MemberUpdatedEvent 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 - PollVoteResponse: + MembersResponse: nullable: true properties: duration: @@ -13468,3288 +14118,3159 @@ components: title: Duration type: string x-stream-index: "002.001" - vote: - $ref: '#/components/schemas/PollVoteResponseData' - description: Poll vote - title: PollVoteResponseData + members: + description: List of found members + items: + $ref: '#/components/schemas/ChannelMember' + title: Members + type: array x-stream-index: "001" required: + - members - duration type: object - PollVoteResponseData: - nullable: true + MembershipLevelResponse: properties: - answer_text: - type: string - x-stream-index: "005" created_at: + description: When the membership level was created format: date-time + title: Created At type: number - x-stream-index: "008" - id: - type: string - x-stream-index: "002" - is_answer: - type: boolean - x-stream-index: "004" - option_id: + x-stream-index: "007" + custom: + additionalProperties: {} + description: Custom data for the membership level + title: Custom Data + type: object + x-stream-index: "006" + description: + description: Description of the membership level + title: Description type: string x-stream-index: "003" - poll_id: + id: + description: Unique identifier for the membership level + title: ID type: string x-stream-index: "001" + name: + description: Display name for the membership level + title: Name + type: string + x-stream-index: "002" + priority: + description: Priority level + format: int32 + title: Priority + type: integer + x-stream-index: "004" + tags: + description: Activity tags this membership level gives access to + items: + type: string + title: Tags + type: array + x-stream-index: "005" updated_at: + description: When the membership level was last updated format: date-time + title: Updated At type: number - x-stream-index: "009" - user: - $ref: '#/components/schemas/UserResponse' - x-stream-index: "007" - user_id: - type: string - x-stream-index: "006" + x-stream-index: "008" required: - - poll_id - id - - option_id + - name + - priority + - tags - created_at - updated_at + title: Membership Level Response type: object - PollVotesResponse: - nullable: true + Message: properties: - duration: - description: Duration of the request in milliseconds - title: Duration - type: string - x-stream-index: "003.001" - next: - type: string - x-stream-index: "002.001" - prev: - type: string - x-stream-index: "002.002" - votes: - description: Poll votes + attachments: items: - $ref: '#/components/schemas/PollVoteResponseData' - title: PollVoteResponseList + $ref: '#/components/schemas/Attachment' type: array - x-stream-index: "001" - required: - - votes - - duration - type: object - PrivacySettings: - properties: - read_receipts: - $ref: '#/components/schemas/ReadReceipts' - x-stream-index: "002" - typing_indicators: - $ref: '#/components/schemas/TypingIndicators' - x-stream-index: "001" - type: object - PrivacySettingsResponse: - properties: - read_receipts: - $ref: '#/components/schemas/ReadReceiptsResponse' - x-stream-index: "002" - typing_indicators: - $ref: '#/components/schemas/TypingIndicatorsResponse' - x-stream-index: "001" - type: object - PublisherStatsResponse: - properties: - by_track: - items: - $ref: '#/components/schemas/TrackStatsResponse' - type: array - x-stream-index: "003" - total: - format: int32 - type: integer - x-stream-index: "001" - unique: - format: int32 - type: integer - x-stream-index: "002" - required: - - total - - unique - type: object - PushPreferenceInput: - nullable: true - properties: - call_level: - description: Set the level of call push notifications for the user. One - of all, none, default - enum: - - all - - none - - default - type: string - x-stream-index: "004" - channel_cid: - description: Set the push preferences for a specific channel. If empty it - sets the default for the user + x-stream-index: "012" + before_message_send_failed: + type: boolean + x-stream-index: "046" + cid: type: string - x-stream-index: "002" - chat_level: - description: Set the level of chat push notifications for the user. One - of all, mentions, none, default - enum: - - all - - mentions - - none - - default + x-stream-index: "028" + command: type: string - x-stream-index: "003" - disabled_until: - description: Disable push notifications till a certain time + x-stream-index: "006" + created_at: format: date-time type: number - x-stream-index: "005" - remove_disable: - description: Remove the disabled until time. (IE stop snoozing notifications) - type: boolean - x-stream-index: "006" - user_id: - description: The user id for which to set the push preferences. Required - when using server side auths, defaults to current user with client side - auth. - type: string - x-stream-index: "001" - type: object - PushPreferences: - properties: - call_level: - type: string - x-stream-index: "002" - chat_level: - type: string - x-stream-index: "001" - disabled_until: + x-stream-index: "030" + custom: + additionalProperties: {} + type: object + x-stream-index: "034" + deleted_at: format: date-time type: number - x-stream-index: "003" - type: object - Quality: - properties: - bitdepth: + x-stream-index: "033" + deleted_for_me: + type: boolean + x-stream-index: "059" + deleted_reply_count: format: int32 type: integer + x-stream-index: "023" + html: + type: string x-stream-index: "007" - framerate: - format: int32 - type: integer - x-stream-index: "008" - height: - format: int32 - type: integer - x-stream-index: "006" - name: + i18n: + additionalProperties: + type: string + type: object + x-stream-index: "044" + id: type: string - x-stream-index: "004" - video_bitrate: - format: int32 - type: integer - x-stream-index: "009" - width: - format: int32 - type: integer - x-stream-index: "005" - type: object - QualityScoreReport: - properties: - histogram: + x-stream-index: "002" + image_labels: + additionalProperties: + items: + type: string + type: array + type: object + x-stream-index: "040" + latest_reactions: items: - $ref: '#/components/schemas/ReportByHistogramBucket' + $ref: '#/components/schemas/Reaction' type: array - x-stream-index: "001" - required: - - histogram - type: object - QualityScoreReportResponse: - properties: - daily: + x-stream-index: "013" + mentioned_users: items: - $ref: '#/components/schemas/DailyAggregateQualityScoreReportResponse' + $ref: '#/components/schemas/User' type: array - x-stream-index: "001" - required: - - daily - type: object - QueryAggregateCallStatsRequest: - nullable: true - properties: - from: + x-stream-index: "043" + message_text_updated_at: + format: date-time + type: number + x-stream-index: "052" + mml: type: string - x-stream-index: "002" - report_types: + x-stream-index: "005" + moderation: + $ref: '#/components/schemas/ModerationV2Response' + x-stream-index: "056" + own_reactions: items: - type: string + $ref: '#/components/schemas/Reaction' type: array - x-stream-index: "004" - to: - type: string - x-stream-index: "003" - type: object - QueryAggregateCallStatsResponse: - description: Basic response information - nullable: true - properties: - call_duration_report: - $ref: '#/components/schemas/CallDurationReportResponse' - x-stream-index: "002" - call_participant_count_report: - $ref: '#/components/schemas/CallParticipantCountReportResponse' - x-stream-index: "004" - calls_per_day_report: - $ref: '#/components/schemas/CallsPerDayReportResponse' - x-stream-index: "003" - duration: - description: Duration of the request in milliseconds - title: Duration + x-stream-index: "014" + parent_id: type: string - x-stream-index: "001.001" - network_metrics_report: - $ref: '#/components/schemas/NetworkMetricsReportResponse' - x-stream-index: "008" - quality_score_report: - $ref: '#/components/schemas/QualityScoreReportResponse' - x-stream-index: "005" - sdk_usage_report: - $ref: '#/components/schemas/SDKUsageReportResponse' - x-stream-index: "006" - user_feedback_report: - $ref: '#/components/schemas/UserFeedbackReportResponse' - x-stream-index: "007" - required: - - duration - title: Response - type: object - QueryBannedUsersPayload: - properties: - exclude_expired_bans: - description: Whether to exclude expired bans or not - title: Exclude expired bans + x-stream-index: "019" + pin_expires: + format: date-time + type: number + x-stream-index: "051" + pinned: type: boolean - x-stream-index: "004" - filter_conditions: - additionalProperties: {} - type: object - x-stream-index: "001" - limit: - description: Number of records to return - format: int32 - maximum: 300 - minimum: 0 - title: Limit - type: integer - x-stream-index: "003.003" - offset: - description: Number of records to offset - format: int32 - maximum: 10000 - title: Offset + x-stream-index: "047" + pinned_at: + format: date-time + type: number + x-stream-index: "048" + pinned_by: + $ref: '#/components/schemas/User' + x-stream-index: "050" + poll: + $ref: '#/components/schemas/Poll' + x-stream-index: "054" + poll_id: + type: string + x-stream-index: "053" + quoted_message: + $ref: '#/components/schemas/Message' + x-stream-index: "025" + quoted_message_id: + type: string + x-stream-index: "024" + reaction_counts: + additionalProperties: + format: int32 + type: integer + type: object + x-stream-index: "015" + reaction_groups: + additionalProperties: + $ref: '#/components/schemas/ReactionGroupResponse' + type: object + x-stream-index: "017" + reaction_scores: + additionalProperties: + format: int32 + type: integer + type: object + x-stream-index: "016" + reminder: + $ref: '#/components/schemas/MessageReminder' + x-stream-index: "058" + reply_count: + format: int32 type: integer - x-stream-index: "003.004" - sort: - description: Array of sort parameters + x-stream-index: "022" + restricted_visibility: items: - $ref: '#/components/schemas/SortParamRequest' - maximum: 1 - title: Sort + type: string type: array - x-stream-index: "002" - required: - - filter_conditions - type: object - QueryBannedUsersResponse: - nullable: true - properties: - bans: - description: List of found bans + x-stream-index: "011" + shadowed: + type: boolean + x-stream-index: "036" + shared_location: + $ref: '#/components/schemas/SharedLocation' + x-stream-index: "055" + show_in_channel: + type: boolean + x-stream-index: "021" + silent: + type: boolean + x-stream-index: "045" + text: + type: string + x-stream-index: "004" + thread_participants: items: - $ref: '#/components/schemas/BanResponse' - title: BanResponse + $ref: '#/components/schemas/User' type: array - x-stream-index: "001" - duration: - description: Duration of the request in milliseconds - title: Duration + x-stream-index: "027" + type: type: string - x-stream-index: "002.001" + x-stream-index: "008" + updated_at: + format: date-time + type: number + x-stream-index: "031" + user: + $ref: '#/components/schemas/User' + x-stream-index: "010" required: - - bans - - duration + - id + - text + - html + - type + - restricted_visibility + - attachments + - latest_reactions + - own_reactions + - reaction_counts + - reaction_scores + - reaction_groups + - reply_count + - deleted_reply_count + - cid + - created_at + - updated_at + - custom + - shadowed + - mentioned_users + - silent + - pinned type: object - QueryCallMembersRequest: + MessageActionRequest: nullable: true properties: - filter_conditions: - additionalProperties: {} + form_data: + additionalProperties: + type: string + description: ReadOnlyData to execute command with + title: Form data type: object x-stream-index: "002" - id: - maxLength: 64 - type: string - x-stream-index: "001.002" - limit: - format: int32 - maximum: 100 - minimum: 0 - type: integer - x-stream-index: "004.001" - next: + required: + - form_data + type: object + MessageChangeSet: + properties: + attachments: + type: boolean + x-stream-index: "005" + custom: + type: boolean + x-stream-index: "001" + html: + type: boolean + x-stream-index: "004" + mentioned_user_ids: + type: boolean + x-stream-index: "006" + mml: + type: boolean + x-stream-index: "003" + pin: + type: boolean + x-stream-index: "009" + quoted_message_id: + type: boolean + x-stream-index: "007" + silent: + type: boolean + x-stream-index: "008" + text: + type: boolean + x-stream-index: "002" + required: + - custom + - text + - mml + - html + - attachments + - mentioned_user_ids + - quoted_message_id + - silent + - pin + type: object + MessageDeletedEvent: + properties: + channel_id: type: string x-stream-index: "004.002" - prev: + channel_type: type: string x-stream-index: "004.003" - sort: - items: - $ref: '#/components/schemas/SortParamRequest' - maximum: 1 - type: array - x-stream-index: "003" - type: - maxLength: 64 + cid: type: string + x-stream-index: "004.001" + created_at: + format: date-time + type: number + x-stream-index: "007.002" + deleted_for_me: + type: boolean + x-stream-index: "003" + hard_delete: + type: boolean + x-stream-index: "002.001" + message: + $ref: '#/components/schemas/Message' x-stream-index: "001.001" - required: - - type - - id - type: object - QueryCallMembersResponse: - description: Basic response information - nullable: true - properties: - duration: - description: Duration of the request in milliseconds - title: Duration + team: type: string - x-stream-index: "003.001" - members: + x-stream-index: "006.001" + thread_participants: items: - $ref: '#/components/schemas/MemberResponse' + $ref: '#/components/schemas/User' type: array - x-stream-index: "001" - next: - type: string - x-stream-index: "002.001" - prev: + x-stream-index: "001.002" + type: + default: message.deleted type: string - x-stream-index: "002.002" + x-stream-index: "007.001" + user: + $ref: '#/components/schemas/User' + x-stream-index: "005.001" required: - - members - - duration - title: Response + - hard_delete + - cid + - channel_id + - channel_type + - type + - created_at + title: MessageDeletedEvent type: object - QueryCallParticipantsRequest: + 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: - filter_conditions: + approved_at: + format: date-time + type: number + x-stream-index: "013" + created_at: + format: date-time + type: number + x-stream-index: "009" + created_by_automod: + type: boolean + x-stream-index: "001" + custom: additionalProperties: {} type: object + x-stream-index: "008" + details: + $ref: '#/components/schemas/FlagDetails' + x-stream-index: "006" + message: + $ref: '#/components/schemas/Message' + x-stream-index: "005" + moderation_feedback: + $ref: '#/components/schemas/FlagFeedback' x-stream-index: "003" - type: object - QueryCallParticipantsResponse: - nullable: true - properties: - call: - $ref: '#/components/schemas/CallResponse' - x-stream-index: "001.001" - duration: - type: string - x-stream-index: "004.001" - members: - items: - $ref: '#/components/schemas/MemberResponse' - type: array - x-stream-index: "001.002" - membership: - $ref: '#/components/schemas/MemberResponse' - x-stream-index: "001.003" - own_capabilities: - items: - $ref: '#/components/schemas/OwnCapability' - type: array - x-stream-index: "001.004" - participants: - description: List of call participants - items: - $ref: '#/components/schemas/CallParticipantResponse' - title: '[]CallParticipantResponse' - type: array + moderation_result: + $ref: '#/components/schemas/MessageModerationResult' x-stream-index: "002" - total_participants: - format: int32 - type: integer - x-stream-index: "003" + reason: + type: string + x-stream-index: "007" + rejected_at: + format: date-time + type: number + x-stream-index: "014" + reviewed_at: + format: date-time + type: number + x-stream-index: "011" + reviewed_by: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "012" + updated_at: + format: date-time + type: number + x-stream-index: "010" + user: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "004" required: - - call - - members - - own_capabilities - - blocked_users - - participants - - total_participants - - duration + - created_by_automod + - created_at + - updated_at type: object - QueryCallStatsRequest: - nullable: true + MessageModerationResult: + description: Result of the message moderation properties: - filter_conditions: - additionalProperties: {} - type: object - x-stream-index: "001" - limit: - format: int32 - maximum: 100 - minimum: 0 - type: integer - x-stream-index: "004.001" - next: - type: string - x-stream-index: "004.002" - prev: + action: + description: Action taken by automod + title: Action type: string - x-stream-index: "004.003" - sort: - items: - $ref: '#/components/schemas/SortParamRequest' - maximum: 2 - type: array x-stream-index: "002" - type: object - QueryCallStatsResponse: - description: Basic response information - nullable: true - properties: - duration: - description: Duration of the request in milliseconds - title: Duration + ai_moderation_response: + $ref: '#/components/schemas/ModerationResponse' + description: Response from AI moderation + title: ModerationResponse + x-stream-index: "007" + blocked_word: + description: Word that was blocked + title: Blocked word type: string - x-stream-index: "002.001" - next: + x-stream-index: "004" + blocklist_name: + description: Name of the blocklist + title: Blocklist name type: string - x-stream-index: "003.001" - prev: + x-stream-index: "005" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: "010" + message_id: + description: ID of the message + title: Message ID type: string - x-stream-index: "003.002" - reports: - items: - $ref: '#/components/schemas/CallStatsReportSummaryResponse' - type: array x-stream-index: "001" + moderated_by: + description: User who moderated the message + title: Moderated by + type: string + x-stream-index: "003" + moderation_thresholds: + $ref: '#/components/schemas/Thresholds' + description: Thresholds for AI moderation + title: Thresholds + x-stream-index: "006" + updated_at: + description: Date/time of the last update + format: date-time + title: Updated at + type: number + x-stream-index: "011" + user_bad_karma: + description: Whether user has bad karma + title: User bad karma + type: boolean + x-stream-index: "009" + user_karma: + description: Karma of the user + format: float + title: User karma + type: number + x-stream-index: "008" required: - - reports - - duration - title: Response + - message_id + - action + - user_karma + - user_bad_karma + - created_at + - updated_at + title: Message moderation result type: object - QueryCallsRequest: - nullable: true + MessageNewEvent: properties: - filter_conditions: - additionalProperties: {} - title: Filters - type: object - x-stream-index: "003" - limit: - format: int32 - maximum: 100 - minimum: 0 - type: integer - x-stream-index: "006.001" - next: + channel_id: type: string - x-stream-index: "006.002" - prev: + x-stream-index: "005.002" + channel_type: type: string - x-stream-index: "006.003" - sort: - description: Array of sort parameters - items: - $ref: '#/components/schemas/SortParamRequest' - maximum: 2 - title: Sort - type: array - x-stream-index: "004" - watch: - title: Watch - type: boolean - x-stream-index: "001" - title: QueryCallsRequest - type: object - QueryCallsResponse: - nullable: true - properties: - calls: + x-stream-index: "005.003" + cid: + type: string + x-stream-index: "005.001" + created_at: + format: date-time + type: number + x-stream-index: "004.002" + message: + $ref: '#/components/schemas/Message' + x-stream-index: "001.001" + team: + type: string + x-stream-index: "006.001" + thread_participants: items: - $ref: '#/components/schemas/CallStateResponseFields' - title: Calls + $ref: '#/components/schemas/User' type: array - x-stream-index: "001" - duration: - description: Duration of the request in milliseconds - title: Duration + x-stream-index: "001.002" + type: + default: message.new type: string + x-stream-index: "004.001" + user: + $ref: '#/components/schemas/User' x-stream-index: "003.001" - next: - type: string + watcher_count: + format: int32 + type: integer x-stream-index: "002.001" - prev: - type: string - x-stream-index: "002.002" required: - - calls - - duration - title: QueryCallsResponse + - watcher_count + - type + - created_at + - cid + - channel_id + - channel_type + title: MessageNewEvent type: object - QueryChannelsRequest: - nullable: true + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + MessageOptions: properties: - filter_conditions: - additionalProperties: {} - type: object - x-stream-index: "001" - limit: - description: Number of channels to limit - format: int32 - title: Limit - type: integer - x-stream-index: "008" - member_limit: - description: Number of members to limit - format: int32 - maximum: 100 - minimum: 0 - title: Member limit - type: integer - x-stream-index: "007" - message_limit: - description: Number of messages to limit - format: int32 - minimum: 0 - title: Message limit - type: integer - x-stream-index: "006" - offset: - description: Channel pagination offset - format: int32 - title: Offset - type: integer - x-stream-index: "009" - presence: - title: Presence - type: boolean - x-stream-index: "005" - sort: - description: List of sort parameters - items: - $ref: '#/components/schemas/SortParamRequest' - maximum: 5 - title: Sort - type: array - x-stream-index: "002" - state: - description: Whether to update channel state or not - title: State - type: boolean - x-stream-index: "004" - watch: - description: Whether to start watching found channels or not - title: Watch + include_thread_participants: type: boolean - x-stream-index: "003" - title: Query Channels Request - type: object - x-stream-docs-page-id: query_channels - QueryChannelsResponse: - nullable: true - properties: - channels: - description: List of channels - items: - $ref: '#/components/schemas/ChannelStateResponseFields' - title: Channels - type: array x-stream-index: "001" - duration: - description: Duration of the request in milliseconds - title: Duration - type: string - x-stream-index: "002.001" - required: - - channels - - duration - title: Channels list type: object - QueryDraftsRequest: - nullable: true + MessagePaginationParams: + type: object + MessageReadEvent: properties: - filter: - additionalProperties: {} - description: Filter to apply to the query - maximum: 3 - title: Filter - type: object - x-stream-index: "001" - limit: - format: int32 - maximum: 100 - minimum: 0 - type: integer - x-stream-index: "005.001" - next: + channel_id: type: string - x-stream-index: "005.002" - prev: + x-stream-index: "003" + channel_last_message_at: + format: date-time + type: number + x-stream-index: "005" + channel_type: + type: string + x-stream-index: "004" + cid: type: string - x-stream-index: "005.003" - sort: - description: Array of sort parameters - items: - $ref: '#/components/schemas/SortParamRequest' - maximum: 5 - title: Sort - type: array x-stream-index: "002" + created_at: + format: date-time + type: number + x-stream-index: "009" + last_read_message_id: + type: string + x-stream-index: "010" + team: + type: string + x-stream-index: "006" + thread: + $ref: '#/components/schemas/ThreadResponse' + x-stream-index: "008" + type: + default: message.read + type: string + x-stream-index: "001" + user: + $ref: '#/components/schemas/UserResponseCommonFields' + x-stream-index: "007" + required: + - type + - cid + - channel_id + - channel_type + - created_at type: object - QueryDraftsResponse: - nullable: true + MessageReminder: properties: - drafts: - description: Drafts - items: - $ref: '#/components/schemas/DraftResponse' - title: DraftsResponseList - type: array - x-stream-index: "001" - duration: - description: Duration of the request in milliseconds - title: Duration + channel: + $ref: '#/components/schemas/Channel' + x-stream-index: "004" + channel_cid: type: string - x-stream-index: "003.001" - next: + x-stream-index: "003" + created_at: + format: date-time + type: number + x-stream-index: "011" + message: + $ref: '#/components/schemas/Message' + x-stream-index: "006" + message_id: type: string - x-stream-index: "002.001" - prev: + x-stream-index: "005" + remind_at: + format: date-time + type: number + x-stream-index: "009" + task_id: type: string - x-stream-index: "002.002" + x-stream-index: "010" + updated_at: + format: date-time + type: number + x-stream-index: "012" + user: + $ref: '#/components/schemas/User' + x-stream-index: "008" + user_id: + type: string + x-stream-index: "007" required: - - drafts - - duration + - channel_cid + - message_id + - user_id + - task_id + - created_at + - updated_at type: object - QueryMembersPayload: - description: Client request + MessageRequest: properties: - filter_conditions: + attachments: + items: + $ref: '#/components/schemas/Attachment' + maximum: 30 + type: array + x-stream-index: "004" + custom: additionalProperties: {} type: object - x-stream-index: "004" + x-stream-index: "007" id: + maxLength: 255 type: string - x-stream-index: "002" - limit: - format: int32 - maximum: 300 - minimum: 0 - type: integer - x-stream-index: "006.003" - members: + x-stream-index: "001" + mentioned_users: items: - $ref: '#/components/schemas/ChannelMember' + type: string maximum: 100 type: array + x-stream-index: "008" + mml: + type: string x-stream-index: "003" - offset: - format: int32 - maximum: 10000 - type: integer - x-stream-index: "006.004" - sort: - items: - $ref: '#/components/schemas/SortParamRequest' - maximum: 1 - type: array - x-stream-index: "005" - type: - maxLength: 64 + parent_id: type: string - x-stream-index: "001" - required: - - type - - filter_conditions - title: ClientRequest - type: object - QueryMessageFlagsPayload: - properties: - filter_conditions: - additionalProperties: {} - type: object - x-stream-index: "001" - limit: - format: int32 - maximum: 300 - minimum: 0 - type: integer - x-stream-index: "003.003" - offset: - format: int32 - maximum: 10000 - type: integer - x-stream-index: "003.004" - show_deleted_messages: - description: Whether to include deleted messages in the results - title: ShowDeletedMessages + x-stream-index: "005" + pin_expires: + format: date-time + type: number + x-stream-index: "015" + pinned: type: boolean - x-stream-index: "002" - sort: - items: - $ref: '#/components/schemas/SortParamRequest' - maximum: 5 - type: array - x-stream-index: "003.005" - type: object - QueryMessageFlagsResponse: - description: Query message flags response - nullable: true - properties: - duration: - description: Duration of the request in milliseconds - title: Duration + x-stream-index: "013" + pinned_at: + format: date-time + nullable: true type: string - x-stream-index: "002.001" - flags: - description: The flags that match the query - items: - $ref: '#/components/schemas/MessageFlagResponse' - title: MessageFlagResponseList - type: array - x-stream-index: "001" - required: - - flags - - duration - title: QueryMessageFlagsResponse - type: object - QueryModerationConfigsRequest: - nullable: true - properties: - filter: - additionalProperties: {} - description: Filter conditions for moderation configs - title: Filter - type: object - x-stream-index: "001" - limit: - format: int32 - maximum: 100 - minimum: 0 - type: integer - x-stream-index: "003.001" - next: + x-stream-index: "014" + poll_id: type: string - x-stream-index: "003.002" - prev: + x-stream-index: "039" + quoted_message_id: type: string - x-stream-index: "003.003" - sort: - description: Sorting parameters for the results + x-stream-index: "009" + restricted_visibility: items: - $ref: '#/components/schemas/SortParamRequest' - title: Sort + type: string + maximum: 10 type: array + x-stream-index: "016" + shared_location: + $ref: '#/components/schemas/SharedLocation' + x-stream-index: "040" + show_in_channel: + type: boolean + x-stream-index: "006" + silent: + type: boolean + x-stream-index: "012" + text: + type: string x-stream-index: "002" + type: + enum: + - '''''' + - regular + - system + type: string + x-stream-index: "011" type: object - QueryModerationConfigsResponse: - nullable: true + MessageResponse: + description: Represents any chat message properties: - configs: - description: List of moderation configurations + attachments: + description: Array of message attachments items: - $ref: '#/components/schemas/ConfigResponse' - title: Configs + $ref: '#/components/schemas/Attachment' + title: Message attachments type: array - x-stream-index: "001" - duration: - type: string - x-stream-index: "003.001" - next: - type: string - x-stream-index: "002.001" - prev: - type: string - x-stream-index: "002.002" - required: - - configs - - duration - type: object - QueryPollVotesRequest: - nullable: true - properties: - filter: - additionalProperties: {} - description: Filter to apply to the query - title: Filter - type: object - x-stream-index: "003" - limit: - format: int32 - maximum: 100 - minimum: 0 - type: integer - x-stream-index: "005.001" - next: + x-stream-docs-page-id: message_format#attachment-format + x-stream-index: "008" + cid: + description: Channel unique identifier in : format + title: Channel CID type: string - x-stream-index: "005.002" - prev: + x-stream-index: "022" + command: + description: Contains provided slash command + title: Command type: string - x-stream-index: "005.003" - sort: - description: Array of sort parameters - items: - $ref: '#/components/schemas/SortParamRequest' - maximum: 5 - title: Sort - type: array + x-stream-docs-page-id: custom_commands_webhook x-stream-index: "004" - type: object - QueryPollsRequest: - nullable: true - properties: - filter: + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: "023" + custom: additionalProperties: {} - description: Filter to apply to the query - title: Filter type: object - x-stream-index: "002" - limit: + x-stream-index: "026" + deleted_at: + description: Date/time of deletion + format: date-time + title: Deleted at + type: number + x-stream-index: "025" + deleted_for_me: + type: boolean + x-stream-index: "044" + deleted_reply_count: format: int32 - maximum: 100 - minimum: 0 type: integer - x-stream-index: "005.001" - next: + x-stream-index: "018" + draft: + $ref: '#/components/schemas/DraftResponse' + x-stream-index: "041" + html: + description: Contains HTML markup of the message. Can only be set when using + server-side API + title: HTML content type: string - x-stream-index: "005.002" - prev: + x-stream-index: "005" + i18n: + additionalProperties: + type: string + description: Object with translations. Key `language` contains the original + language key. Other keys contain translations + title: Internationalization info + type: object + x-stream-docs-page-id: translation + x-stream-index: "030" + id: + description: Message ID is unique string identifier of the message + title: ID type: string - x-stream-index: "005.003" - sort: - description: Array of sort parameters + x-stream-index: "001" + image_labels: + additionalProperties: + items: + type: string + type: array + description: Contains image moderation information + title: Image moderation labels + type: object + x-stream-index: "028" + latest_reactions: + description: List of 10 latest reactions to this message items: - $ref: '#/components/schemas/SortParamRequest' - maximum: 5 - title: Sort + $ref: '#/components/schemas/ReactionResponse' + title: Latest reactions type: array - x-stream-index: "003" - type: object - QueryPollsResponse: - nullable: true - properties: - duration: - description: Duration of the request in milliseconds - title: Duration - type: string - x-stream-index: "003.001" - next: - type: string - x-stream-index: "002.001" - polls: - description: Polls data returned by the query + x-stream-index: "009" + mentioned_users: + description: List of mentioned users items: - $ref: '#/components/schemas/PollResponseData' - title: PollsResponseData + $ref: '#/components/schemas/UserResponse' + title: Mentioned Users type: array - x-stream-index: "001" - prev: - type: string - x-stream-index: "002.002" - required: - - polls - - duration - type: object - QueryReactionsRequest: - properties: - filter: - additionalProperties: {} - type: object - x-stream-index: "002" - limit: - format: int32 - maximum: 100 - minimum: 0 - type: integer - x-stream-index: "006.001" - next: - type: string - x-stream-index: "006.002" - prev: + x-stream-index: "029" + message_text_updated_at: + format: date-time + type: number + x-stream-index: "036" + mml: + description: Should be empty if `text` is provided. Can only be set when + using server-side API + title: Messaging Markup Language type: string - x-stream-index: "006.003" - sort: + x-stream-docs-page-id: mml_overview + x-stream-index: "003" + moderation: + $ref: '#/components/schemas/ModerationV2Response' + x-stream-index: "039" + own_reactions: + description: List of 10 latest reactions of authenticated user to this message items: - $ref: '#/components/schemas/SortParamRequest' - maximum: 2 + $ref: '#/components/schemas/ReactionResponse' + title: Own reactions type: array - x-stream-index: "003" - type: object - QueryReactionsResponse: - description: Basic response information - properties: - duration: - description: Duration of the request in milliseconds - title: Duration + x-stream-index: "010" + parent_id: + description: ID of parent message (thread) + title: Parent message ID type: string - x-stream-index: "002.001" - next: + x-stream-docs-page-id: threads + x-stream-index: "015" + pin_expires: + description: Date when pinned message expires + format: date-time + title: Pin expiration date + type: number + x-stream-docs-page-id: pinned_messages + x-stream-index: "035" + pinned: + description: Whether message is pinned or not + title: Pinned + type: boolean + x-stream-docs-page-id: pinned_messages + x-stream-index: "032" + pinned_at: + description: Date when message got pinned + format: date-time + title: Pinned at + type: number + x-stream-docs-page-id: pinned_messages + x-stream-index: "033" + pinned_by: + $ref: '#/components/schemas/UserResponse' + description: Contains user who pinned the message + title: Pinned by + x-stream-docs-page-id: pinned_messages + x-stream-index: "034" + poll: + $ref: '#/components/schemas/PollResponseData' + x-stream-index: "038" + poll_id: + description: Identifier of the poll to include in the message + title: Poll ID type: string - x-stream-index: "003.001" - prev: + x-stream-index: "037" + quoted_message: + $ref: '#/components/schemas/MessageResponse' + description: Contains quoted message + title: Quoted message + x-stream-docs-page-id: threads#quote-message + x-stream-index: "020" + quoted_message_id: + title: ID of quoted message type: string - x-stream-index: "003.002" - reactions: - items: - $ref: '#/components/schemas/ReactionResponse' - type: array - x-stream-index: "001" - required: - - reactions - - duration - title: Response - type: object - QueryRemindersRequest: - nullable: true - properties: - filter: - additionalProperties: {} - description: Filter to apply to the query - title: Filter + x-stream-docs-page-id: threads#quote-message + x-stream-index: "019" + reaction_counts: + additionalProperties: + format: int32 + type: integer + description: 'An object containing number of reactions of each type. Key: + reaction type (string), value: number of reactions (int)' + title: Reaction counts type: object - x-stream-index: "001" - limit: + x-stream-index: "011" + reaction_groups: + additionalProperties: + $ref: '#/components/schemas/ReactionGroupResponse' + type: object + x-stream-index: "014" + reaction_scores: + additionalProperties: + format: int32 + type: integer + description: 'An object containing scores of reactions of each type. Key: + reaction type (string), value: total score of reactions (int)' + title: Reaction scores + type: object + x-stream-index: "012" + reminder: + $ref: '#/components/schemas/ReminderResponseData' + x-stream-index: "042" + reply_count: + description: Number of replies to this message format: int32 - maximum: 100 - minimum: 0 + title: Reply count type: integer - x-stream-index: "005.001" - next: - type: string - x-stream-index: "005.002" - prev: - type: string - x-stream-index: "005.003" - sort: - description: Array of sort parameters + x-stream-index: "017" + restricted_visibility: + description: A list of user ids that have restricted visibility to the message, + if the list is not empty, the message is only visible to the users in + the list items: - $ref: '#/components/schemas/SortParamRequest' - maximum: 5 - title: Sort + type: string + title: Restricted visibility type: array - x-stream-index: "002" - type: object - QueryRemindersResponse: - nullable: true - properties: - duration: - description: Duration of the request in milliseconds - title: Duration - type: string - x-stream-index: "003.001" - next: - type: string - x-stream-index: "002.001" - prev: + x-stream-index: "040" + shadowed: + description: Whether the message was shadowed or not + title: Shadowed + type: boolean + x-stream-docs-page-id: moderation#shadow-ban + x-stream-index: "027" + shared_location: + $ref: '#/components/schemas/SharedLocationResponseData' + description: Contains shared location data + title: Shared Location + x-stream-index: "043" + show_in_channel: + description: Whether thread reply should be shown in the channel as well + title: Show in channel + type: boolean + x-stream-docs-page-id: threads + x-stream-index: "016" + silent: + description: Whether message is silent or not + title: Silent + type: boolean + x-stream-index: "031" + text: + description: Text of the message. Should be empty if `mml` is provided + title: Text type: string - x-stream-index: "002.002" - reminders: - description: MessageReminders data returned by the query + x-stream-index: "002" + thread_participants: + description: List of users who participate in thread items: - $ref: '#/components/schemas/ReminderResponseData' - title: RemindersResponseData + $ref: '#/components/schemas/UserResponse' + title: Thread participants type: array - x-stream-index: "001" - required: - - reminders - - duration - type: object - QueryReviewQueueRequest: - nullable: true - properties: - filter: - additionalProperties: {} - description: Filter conditions for review queue items - title: Filter - type: object - x-stream-index: "001" - limit: - format: int32 - maximum: 100 - minimum: 0 - type: integer - x-stream-index: "007.001" - lock_count: - description: Number of items to lock (1-25) - format: int32 - maximum: 25 - minimum: 1 - title: Lock Count - type: integer - x-stream-index: "005" - lock_duration: - description: Duration for which items should be locked - title: Lock Duration - type: integer - x-stream-index: "004" - lock_items: - description: Whether to lock items for review (true), unlock items (false), - or just fetch (nil) - title: Lock Items - type: boolean - x-stream-index: "003" - next: - type: string - x-stream-index: "007.002" - prev: + x-stream-docs-page-id: threads#quote-message + x-stream-index: "021" + type: + description: Contains type of the message + enum: + - regular + - ephemeral + - error + - reply + - system + - deleted + title: Message Type type: string - x-stream-index: "007.003" - sort: - description: Sorting parameters for the results + x-stream-docs-page-id: message_format#message-types + x-stream-index: "006" + updated_at: + description: Date/time of the last update + format: date-time + title: Updated at + type: number + x-stream-index: "024" + user: + $ref: '#/components/schemas/UserResponse' + description: Sender of the message. Required when using server-side API + title: User object + x-stream-index: "007" + required: + - id + - text + - html + - type + - user + - attachments + - latest_reactions + - own_reactions + - reaction_counts + - reaction_scores + - reply_count + - deleted_reply_count + - cid + - created_at + - updated_at + - custom + - shadowed + - mentioned_users + - silent + - pinned + - restricted_visibility + title: Message + type: object + x-stream-docs-page-id: send_message + MessageStatsResponse: + properties: + count_over_time: items: - $ref: '#/components/schemas/SortParamRequest' - title: Sort + $ref: '#/components/schemas/CountByMinuteResponse' type: array - x-stream-index: "002" - stats_only: - description: Whether to return only statistics - title: Stats Only - type: boolean - x-stream-index: "006" + x-stream-index: "001" type: object - QueryReviewQueueResponse: - nullable: true + MessageUndeletedEvent: properties: - action_config: - additionalProperties: - items: - $ref: '#/components/schemas/ModerationActionConfig' - type: array - description: Configuration for moderation actions - title: Action Config - type: object - x-stream-index: "002" - duration: + channel_id: + type: string + x-stream-index: "005.002" + channel_type: + type: string + x-stream-index: "005.003" + cid: type: string x-stream-index: "005.001" - items: - description: List of review queue items + created_at: + format: date-time + type: number + x-stream-index: "004.002" + message: + $ref: '#/components/schemas/Message' + x-stream-index: "001.001" + team: + type: string + x-stream-index: "002.001" + thread_participants: items: - $ref: '#/components/schemas/ReviewQueueItemResponse' - title: Items + $ref: '#/components/schemas/User' type: array - x-stream-index: "001" - next: + x-stream-index: "001.002" + type: + default: message.undeleted type: string x-stream-index: "004.001" - prev: - type: string - x-stream-index: "004.002" - stats: - additionalProperties: {} - description: Statistics about the review queue - title: Stats - type: object - x-stream-index: "003" + user: + $ref: '#/components/schemas/User' + x-stream-index: "003.001" required: - - items - - action_config - - stats - - duration + - type + - created_at + - cid + - channel_id + - channel_type + title: MessageUndeletedEvent type: object - QueryThreadsRequest: - nullable: true + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + MessageUpdate: properties: - filter: - additionalProperties: {} - description: Filter conditions to apply to threads - title: Filter - type: object - x-stream-index: "006" - limit: - format: int32 - maximum: 100 - minimum: 0 - type: integer - x-stream-index: "008.001" - member_limit: - format: int32 - maximum: 100 - minimum: 0 - type: integer - x-stream-index: "005" - next: - type: string - x-stream-index: "008.002" - participant_limit: - description: Limit the number of participants returned per each thread - format: int32 - maximum: 100 - minimum: 0 - title: Participant limit - type: integer - x-stream-index: "004" - prev: + change_set: + $ref: '#/components/schemas/MessageChangeSet' + x-stream-index: "002" + old_text: type: string - x-stream-index: "008.003" - reply_limit: - description: Limit the number of replies returned per each thread - format: int32 - maximum: 10 - minimum: 0 - title: Reply limit - type: integer - x-stream-index: "003" - sort: - description: Sort conditions to apply to threads - items: - $ref: '#/components/schemas/SortParamRequest' - maximum: 5 - title: Sort - type: array - x-stream-index: "007" - watch: - description: Start watching the channel this thread belongs to - title: Watch - type: boolean x-stream-index: "001" type: object - QueryThreadsResponse: - nullable: true + MessageUpdatedEvent: properties: - duration: - description: Duration of the request in milliseconds - title: Duration + channel_id: type: string - x-stream-index: "003.001" - next: + x-stream-index: "005.002" + channel_type: type: string - x-stream-index: "002.001" - prev: + x-stream-index: "005.003" + cid: type: string - x-stream-index: "002.002" - threads: - description: List of enriched thread states + x-stream-index: "005.001" + created_at: + format: date-time + type: number + x-stream-index: "004.002" + message: + $ref: '#/components/schemas/Message' + x-stream-index: "001.001" + team: + type: string + x-stream-index: "002.001" + thread_participants: items: - $ref: '#/components/schemas/ThreadStateResponse' - title: Threads - type: array - x-stream-index: "001" - required: - - threads - - duration - type: object - QueryUsersPayload: - properties: - filter_conditions: - additionalProperties: {} - type: object - x-stream-index: "001" - include_deactivated_users: - type: boolean - x-stream-index: "004" - limit: - format: int32 - maximum: 100 - minimum: 0 - type: integer - x-stream-index: "005.003" - offset: - format: int32 - maximum: 1000 - type: integer - x-stream-index: "005.004" - presence: - type: boolean - x-stream-index: "003" - sort: - items: - $ref: '#/components/schemas/SortParamRequest' - maximum: 5 + $ref: '#/components/schemas/User' type: array - x-stream-index: "002" + x-stream-index: "001.002" + type: + default: message.updated + type: string + x-stream-index: "004.001" + user: + $ref: '#/components/schemas/User' + x-stream-index: "003.001" required: - - filter_conditions + - type + - created_at + - cid + - channel_id + - channel_type + title: MessageUpdatedEvent type: object - QueryUsersResponse: - nullable: true + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + MessageWithChannelResponse: + description: Represents any chat message properties: - duration: - description: Duration of the request in milliseconds - title: Duration - type: string - x-stream-index: "002.001" - users: - description: Array of users as result of filters applied. + attachments: + description: Array of message attachments items: - $ref: '#/components/schemas/FullUserResponse' - title: Users + $ref: '#/components/schemas/Attachment' + title: Message attachments type: array - x-stream-index: "001" - required: - - users - - duration - type: object - RTMPBroadcastRequest: - description: RTMPBroadcastRequest is the payload for starting an RTMP broadcast. - properties: - layout: - $ref: '#/components/schemas/LayoutSettingsRequest' - description: If provided, will override the call's RTMP settings layout - title: Layout - x-stream-index: "005" - name: - description: Name identifier for RTMP broadcast, must be unique in call - maxLength: 255 - title: Name - type: string - x-stream-index: "001" - quality: - description: If provided, will override the call's RTMP settings quality - enum: - - 360p - - 480p - - 720p - - 1080p - - 1440p - - portrait-360x640 - - portrait-480x854 - - portrait-720x1280 - - portrait-1080x1920 - - portrait-1440x2560 - title: Quality - type: string - x-stream-index: "004" - stream_key: - description: If provided, will be appended at the end of stream_url - title: Stream Key - type: string - x-stream-index: "003" - stream_url: - description: URL for the RTMP server to send the call to - maxLength: 255 - title: Stream URL - type: string - x-stream-index: "002" - required: - - name - - stream_url - title: RTMPBroadcastRequest - type: object - RTMPEgressConfig: - properties: - composite_app_settings: - $ref: '#/components/schemas/CompositeAppSettings' - x-stream-index: "005" - quality: - $ref: '#/components/schemas/Quality' - x-stream-index: "004" - rtmp_location: - type: string - x-stream-index: "006" - type: object - RTMPIngress: - description: RTMP input settings - properties: - address: - title: Address - type: string - x-stream-index: "001" - required: - - address - title: RTMPIngress - type: object - RTMPLocation: - properties: - name: - type: string - x-stream-index: "001" - stream_key: - type: string - x-stream-index: "003" - stream_url: - type: string - x-stream-index: "002" - required: - - name - - stream_url - - stream_key - type: object - RTMPSettings: - properties: - enabled: - type: boolean - x-stream-index: "001" - layout: - $ref: '#/components/schemas/LayoutSettings' - x-stream-index: "003" - location: - $ref: '#/components/schemas/RTMPLocation' - x-stream-index: "004" - quality_name: - type: string + x-stream-docs-page-id: message_format#attachment-format + x-stream-index: "001.008" + channel: + $ref: '#/components/schemas/ChannelResponse' + description: Channel object + title: Channel x-stream-index: "002" - required: - - enabled - type: object - RTMPSettingsRequest: - properties: - enabled: - type: boolean - x-stream-index: "001" - quality: - description: Resolution to set for the RTMP stream - enum: - - 360p - - 480p - - 720p - - 1080p - - 1440p - - portrait-360x640 - - portrait-480x854 - - portrait-720x1280 - - portrait-1080x1920 - - portrait-1440x2560 - title: Quality + cid: + description: Channel unique identifier in : format + title: Channel CID type: string - x-stream-index: "002" - title: RTMPSettingsRequest - type: object - RTMPSettingsResponse: - description: RTMPSettingsResponse is the payload for RTMP settings - properties: - enabled: - title: Enabled - type: boolean - x-stream-index: "001" - quality: - title: Quality + x-stream-index: "001.022" + command: + description: Contains provided slash command + title: Command type: string - x-stream-index: "002" - required: - - enabled - - quality - - layout - title: RTMPSettingsResponse - type: object - Reaction: - nullable: true - properties: + x-stream-docs-page-id: custom_commands_webhook + x-stream-index: "001.004" created_at: + description: Date/time of creation format: date-time - readOnly: true + title: Created at type: number - x-stream-index: "008" + x-stream-index: "001.023" custom: additionalProperties: {} type: object - x-stream-index: "010" - message_id: - type: string - x-stream-index: "003" - score: + x-stream-index: "001.026" + deleted_at: + description: Date/time of deletion + format: date-time + title: Deleted at + type: number + x-stream-index: "001.025" + deleted_for_me: + type: boolean + x-stream-index: "001.044" + deleted_reply_count: format: int32 type: integer - x-stream-index: "007" - type: - maxLength: 30 + x-stream-index: "001.018" + draft: + $ref: '#/components/schemas/DraftResponse' + x-stream-index: "001.041" + html: + description: Contains HTML markup of the message. Can only be set when using + server-side API + title: HTML content type: string - x-stream-index: "006" - updated_at: + x-stream-index: "001.005" + i18n: + additionalProperties: + type: string + description: Object with translations. Key `language` contains the original + language key. Other keys contain translations + title: Internationalization info + type: object + x-stream-docs-page-id: translation + x-stream-index: "001.030" + id: + description: Message ID is unique string identifier of the message + title: ID + type: string + x-stream-index: "001.001" + image_labels: + additionalProperties: + items: + type: string + type: array + description: Contains image moderation information + title: Image moderation labels + type: object + x-stream-index: "001.028" + latest_reactions: + description: List of 10 latest reactions to this message + items: + $ref: '#/components/schemas/ReactionResponse' + title: Latest reactions + type: array + x-stream-index: "001.009" + mentioned_users: + description: List of mentioned users + items: + $ref: '#/components/schemas/UserResponse' + title: Mentioned Users + type: array + x-stream-index: "001.029" + message_text_updated_at: format: date-time - readOnly: true type: number - x-stream-index: "009" - user: - $ref: '#/components/schemas/User' - x-stream-index: "005" - user_id: - type: string - x-stream-index: "004" - required: - - message_id - - type - - score - - created_at - - updated_at - - custom - type: object - ReactionDeletedEvent: - properties: - channel_id: - type: string - x-stream-index: "003.002" - channel_type: + x-stream-index: "001.036" + mml: + description: Should be empty if `text` is provided. Can only be set when + using server-side API + title: Messaging Markup Language type: string - x-stream-index: "003.003" - cid: + x-stream-docs-page-id: mml_overview + x-stream-index: "001.003" + moderation: + $ref: '#/components/schemas/ModerationV2Response' + x-stream-index: "001.039" + own_reactions: + description: List of 10 latest reactions of authenticated user to this message + items: + $ref: '#/components/schemas/ReactionResponse' + title: Own reactions + type: array + x-stream-index: "001.010" + parent_id: + description: ID of parent message (thread) + title: Parent message ID type: string - x-stream-index: "003.001" - created_at: + x-stream-docs-page-id: threads + x-stream-index: "001.015" + pin_expires: + description: Date when pinned message expires format: date-time + title: Pin expiration date type: number - x-stream-index: "006.002" - message: - $ref: '#/components/schemas/Message' - x-stream-index: "001.001" - reaction: - $ref: '#/components/schemas/Reaction' - x-stream-index: "002" - team: + x-stream-docs-page-id: pinned_messages + x-stream-index: "001.035" + pinned: + description: Whether message is pinned or not + title: Pinned + type: boolean + x-stream-docs-page-id: pinned_messages + x-stream-index: "001.032" + pinned_at: + description: Date when message got pinned + format: date-time + title: Pinned at + type: number + x-stream-docs-page-id: pinned_messages + x-stream-index: "001.033" + pinned_by: + $ref: '#/components/schemas/UserResponse' + description: Contains user who pinned the message + title: Pinned by + x-stream-docs-page-id: pinned_messages + x-stream-index: "001.034" + poll: + $ref: '#/components/schemas/PollResponseData' + x-stream-index: "001.038" + poll_id: + description: Identifier of the poll to include in the message + title: Poll ID type: string - x-stream-index: "005.001" - thread_participants: + x-stream-index: "001.037" + quoted_message: + $ref: '#/components/schemas/MessageResponse' + description: Contains quoted message + title: Quoted message + x-stream-docs-page-id: threads#quote-message + x-stream-index: "001.020" + quoted_message_id: + title: ID of quoted message + type: string + x-stream-docs-page-id: threads#quote-message + x-stream-index: "001.019" + reaction_counts: + additionalProperties: + format: int32 + type: integer + description: 'An object containing number of reactions of each type. Key: + reaction type (string), value: number of reactions (int)' + title: Reaction counts + type: object + x-stream-index: "001.011" + reaction_groups: + additionalProperties: + $ref: '#/components/schemas/ReactionGroupResponse' + type: object + x-stream-index: "001.014" + reaction_scores: + additionalProperties: + format: int32 + type: integer + description: 'An object containing scores of reactions of each type. Key: + reaction type (string), value: total score of reactions (int)' + title: Reaction scores + type: object + x-stream-index: "001.012" + reminder: + $ref: '#/components/schemas/ReminderResponseData' + x-stream-index: "001.042" + reply_count: + description: Number of replies to this message + format: int32 + title: Reply count + type: integer + x-stream-index: "001.017" + restricted_visibility: + description: A list of user ids that have restricted visibility to the message, + if the list is not empty, the message is only visible to the users in + the list items: - $ref: '#/components/schemas/User' + type: string + title: Restricted visibility type: array + x-stream-index: "001.040" + shadowed: + description: Whether the message was shadowed or not + title: Shadowed + type: boolean + x-stream-docs-page-id: moderation#shadow-ban + x-stream-index: "001.027" + shared_location: + $ref: '#/components/schemas/SharedLocationResponseData' + description: Contains shared location data + title: Shared Location + x-stream-index: "001.043" + show_in_channel: + description: Whether thread reply should be shown in the channel as well + title: Show in channel + type: boolean + x-stream-docs-page-id: threads + x-stream-index: "001.016" + silent: + description: Whether message is silent or not + title: Silent + type: boolean + x-stream-index: "001.031" + text: + description: Text of the message. Should be empty if `mml` is provided + title: Text + type: string x-stream-index: "001.002" + thread_participants: + description: List of users who participate in thread + items: + $ref: '#/components/schemas/UserResponse' + title: Thread participants + type: array + x-stream-docs-page-id: threads#quote-message + x-stream-index: "001.021" type: - default: reaction.deleted + description: Contains type of the message + enum: + - regular + - ephemeral + - error + - reply + - system + - deleted + title: Message Type type: string - x-stream-index: "006.001" + x-stream-docs-page-id: message_format#message-types + x-stream-index: "001.006" + updated_at: + description: Date/time of the last update + format: date-time + title: Updated at + type: number + x-stream-index: "001.024" user: - $ref: '#/components/schemas/User' - x-stream-index: "004.001" + $ref: '#/components/schemas/UserResponse' + description: Sender of the message. Required when using server-side API + title: User object + x-stream-index: "001.007" required: - - cid - - channel_id - - channel_type + - id + - text + - html - type - - created_at - title: ReactionDeletedEvent + - user + - attachments + - latest_reactions + - own_reactions + - reaction_counts + - reaction_scores + - reply_count + - deleted_reply_count + - cid + - created_at + - updated_at + - custom + - shadowed + - mentioned_users + - silent + - pinned + - restricted_visibility + - channel + title: Message 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 - ReactionGroupResponse: - description: ReactionGroupResponse contains all information about a reaction - of the same type. + x-stream-docs-page-id: send_message + ModerationActionConfig: nullable: true properties: - count: - description: Count is the number of reactions of this type. - format: int32 - title: Count - type: integer - x-stream-index: "001" - first_reaction_at: - description: FirstReactionAt is the time of the first reaction of this type. - This is the same also if all reaction of this type are deleted, because - if someone will react again with the same type, will be preserved the - sorting. - format: date-time - title: FirstReactionAt - type: number - x-stream-index: "003" - last_reaction_at: - description: LastReactionAt is the time of the last reaction of this type. - format: date-time - title: LastReactionAt - type: number + action: + type: string + x-stream-index: "006" + custom: + additionalProperties: {} + type: object + x-stream-index: "009" + description: + type: string + x-stream-index: "008" + entity_type: + type: string x-stream-index: "004" - sum_scores: - description: 'SumScores is the sum of all scores of reactions of this type. - Medium allows you to clap articles more than once and shows the sum of - all claps from all users. For example, you can send `clap` x5 using `score: - 5`.' + icon: + type: string + x-stream-index: "007" + order: format: int32 - title: SumScores type: integer - x-stream-index: "002" + x-stream-index: "005" required: - - count - - sum_scores - - first_reaction_at - - last_reaction_at - title: ReactionGroupResponse + - entity_type + - order + - action + - icon + - description + - custom type: object - ReactionNewEvent: + ModerationCustomActionEvent: properties: - channel_id: - type: string - x-stream-index: "004.002" - channel_type: - type: string - x-stream-index: "004.003" - cid: - type: string - x-stream-index: "004.001" created_at: format: date-time type: number - x-stream-index: "006.002" + x-stream-index: "004.002" + item: + $ref: '#/components/schemas/ReviewQueueItem' + x-stream-index: "001" message: $ref: '#/components/schemas/Message' - x-stream-index: "001.001" - reaction: - $ref: '#/components/schemas/Reaction' x-stream-index: "002" - team: - type: string - x-stream-index: "005.001" - thread_participants: - items: - $ref: '#/components/schemas/User' - type: array - x-stream-index: "001.002" type: - default: reaction.new + default: moderation.custom_action type: string - x-stream-index: "006.001" + x-stream-index: "004.001" user: $ref: '#/components/schemas/User' x-stream-index: "003.001" required: - - cid - - channel_id - - channel_type - type - created_at - title: ReactionNewEvent + title: ModerationCustomActionEvent 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 - ReactionRequest: - description: Represents user reaction to a message + ModerationFlagResponse: + nullable: true properties: created_at: - description: Date/time of creation format: date-time - title: Created at type: number - x-stream-index: "003" + x-stream-index: "015" custom: additionalProperties: {} type: object - x-stream-index: "005" - score: - description: Reaction score. If not specified reaction has score of 1 - format: int32 - title: Score - type: integer - x-stream-index: "002" - type: - description: The type of reaction (e.g. 'like', 'laugh', 'wow') - maxLength: 30 - title: Type + x-stream-index: "010" + entity_creator_id: + type: string + x-stream-index: "007" + entity_id: type: string - x-stream-index: "001" - updated_at: - description: Date/time of the last update - format: date-time - title: Updated at - type: number - x-stream-index: "004" - required: - - type - title: Reaction - type: object - x-stream-docs-page-id: send_reaction - ReactionResponse: - properties: - created_at: - description: Date/time of creation - format: date-time - title: Created at - type: number x-stream-index: "006" - custom: - additionalProperties: {} - description: Custom data for this object - title: Custom data - type: object - x-stream-index: "008" - message_id: - description: Message ID - title: Message ID + entity_type: type: string - x-stream-index: "001" - score: - description: Score of the reaction - format: int32 - title: Score - type: integer x-stream-index: "005" + labels: + items: + type: string + type: array + x-stream-index: "011" + moderation_payload: + $ref: '#/components/schemas/ModerationPayload' + x-stream-index: "008" + reason: + type: string + x-stream-index: "009" + result: + items: + additionalProperties: {} + type: object + type: array + x-stream-index: "012" + review_queue_item: + $ref: '#/components/schemas/ReviewQueueItemResponse' + x-stream-index: "014" + review_queue_item_id: + type: string + x-stream-index: "013" type: - description: Type of reaction - title: Type type: string - x-stream-index: "004" + x-stream-index: "002" updated_at: - description: Date/time of the last update format: date-time - title: Updated at type: number - x-stream-index: "007" + x-stream-index: "016" user: $ref: '#/components/schemas/UserResponse' - description: User - title: UserResponse - x-stream-index: "003" + x-stream-index: "004" user_id: - description: User ID - title: User ID type: string - x-stream-index: "002" + x-stream-index: "003" required: - - message_id - - user_id - - user - type - - score + - user_id + - entity_type + - entity_id + - result - created_at - updated_at - - custom type: object - ReactionUpdatedEvent: + ModerationFlaggedEvent: properties: - channel_id: - type: string - x-stream-index: "004.002" - channel_type: - type: string - x-stream-index: "004.003" - cid: - type: string - x-stream-index: "004.001" created_at: format: date-time type: number - x-stream-index: "006.002" - message: - $ref: '#/components/schemas/Message' + x-stream-index: "004.002" + item: + type: string x-stream-index: "001" - reaction: - $ref: '#/components/schemas/Reaction' - x-stream-index: "002" - team: + object_id: type: string - x-stream-index: "005.001" + x-stream-index: "002" type: - default: reaction.updated + default: moderation.flagged type: string - x-stream-index: "006.001" + x-stream-index: "004.001" user: $ref: '#/components/schemas/User' x-stream-index: "003.001" required: - - message - - reaction - - cid - - channel_id - - channel_type - type - created_at - title: ReactionUpdatedEvent + title: ModerationFlaggedEvent 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 - ReadReceipts: - properties: - enabled: - type: boolean - x-stream-index: "001" - required: - - enabled - type: object - ReadReceiptsResponse: - properties: - enabled: - type: boolean - x-stream-index: "001" - required: - - enabled - type: object - ReadStateResponse: + ModerationMarkReviewedEvent: properties: - last_read: + created_at: format: date-time type: number + x-stream-index: "004.002" + item: + $ref: '#/components/schemas/ReviewQueueItem' + x-stream-index: "001" + message: + $ref: '#/components/schemas/Message' x-stream-index: "002" - last_read_message_id: + type: + default: moderation.mark_reviewed type: string - x-stream-index: "004" - unread_messages: - format: int32 - type: integer - x-stream-index: "003" + x-stream-index: "004.001" user: - $ref: '#/components/schemas/UserResponse' - x-stream-index: "001" + $ref: '#/components/schemas/User' + x-stream-index: "003.001" required: - - user - - last_read - - unread_messages + - type + - created_at + title: ModerationMarkReviewedEvent type: object - RecordSettings: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + ModerationPayload: properties: - audio_only: - type: boolean - x-stream-index: "001" - layout: - $ref: '#/components/schemas/LayoutSettings' + custom: + additionalProperties: {} + type: object x-stream-index: "004" - mode: - type: string + images: + items: + type: string + maximum: 30 + type: array x-stream-index: "002" - quality: - type: string + texts: + items: + type: string + type: array + x-stream-index: "001" + videos: + items: + type: string + type: array x-stream-index: "003" - required: - - mode type: object - RecordSettingsRequest: + ModerationResponse: properties: - audio_only: - type: boolean - x-stream-index: "001" - mode: - enum: - - available - - disabled - - auto-on - title: Mode + action: type: string + x-stream-index: "004" + explicit: + format: float + type: number x-stream-index: "002" - quality: - enum: - - 360p - - 480p - - 720p - - 1080p - - 1440p - - portrait-360x640 - - portrait-480x854 - - portrait-720x1280 - - portrait-1080x1920 - - portrait-1440x2560 - type: string + spam: + format: float + type: number x-stream-index: "003" + toxic: + format: float + type: number + x-stream-index: "001" required: - - mode - title: RecordSettingsRequest + - toxic + - explicit + - spam + - action + - automod_response type: object - RecordSettingsResponse: - description: RecordSettings is the payload for recording settings + ModerationV2Response: properties: - audio_only: - title: Audio Only - type: boolean - x-stream-index: "001" - mode: - title: Mode + action: type: string - x-stream-index: "002" - quality: - title: Quality + x-stream-index: "001" + blocklist_matched: type: string - x-stream-index: "003" - required: - - audio_only - - mode - - quality - - layout - title: RecordSettingsResponse - type: object - RecordingEgressConfig: - properties: - audio_only: - type: boolean - x-stream-index: "006" - composite_app_settings: - $ref: '#/components/schemas/CompositeAppSettings' x-stream-index: "005" - external_storage: - $ref: '#/components/schemas/ExternalStorage' - x-stream-index: "008" - quality: - $ref: '#/components/schemas/Quality' + image_harms: + items: + type: string + type: array x-stream-index: "004" - storage_name: + original_text: type: string + x-stream-index: "002" + platform_circumvented: + type: boolean x-stream-index: "007" - video_orientation_hint: - $ref: '#/components/schemas/VideoOrientation' - x-stream-index: "009" + semantic_filter_matched: + type: string + x-stream-index: "006" + text_harms: + items: + type: string + type: array + x-stream-index: "003" + required: + - action + - original_text type: object - RejectCallRequest: + MuteChannelRequest: nullable: true properties: - reason: - description: Reason for rejecting the call - title: Reason - type: string + channel_cids: + description: Channel CIDs to mute (if multiple channels) + items: + type: string + maximum: 25 + title: Channel CIDs + type: array + x-stream-index: "002" + expiration: + description: Duration of mute in milliseconds + title: Expiration + type: integer x-stream-index: "003" - title: RejectCallRequest type: object - RejectCallResponse: + MuteChannelResponse: nullable: true properties: + channel_mute: + $ref: '#/components/schemas/ChannelMute' + description: Object with channel mute (if one channel was muted) + title: Channel mute + x-stream-index: "001" + channel_mutes: + description: Object with mutes (if multiple channels were muted) + items: + $ref: '#/components/schemas/ChannelMute' + title: Channel mutes + type: array + x-stream-index: "002" duration: - description: Duration of the request in milliseconds - title: Duration type: string - x-stream-index: "001.001" + x-stream-index: "004.001" + own_user: + $ref: '#/components/schemas/OwnUser' + description: Authorized user object with fresh mutes information + title: Own user + x-stream-index: "003" required: - duration - title: RejectCallResponse type: object - ReminderCreatedEvent: - description: Emitted when a reminder is created. + MuteRequest: nullable: true properties: - cid: - description: The CID of the Channel for which the reminder was created - title: Channel CID + target_ids: + description: User IDs to mute (if multiple users) + items: + type: string + title: Target IDs + type: array + x-stream-index: "001" + timeout: + description: Duration of mute in minutes + minimum: 0 + title: Timeout + type: integer + x-stream-index: "002" + required: + - target_ids + title: MuteRequest + type: object + MuteResponse: + nullable: true + properties: + duration: type: string - x-stream-index: "001.004" - created_at: - description: Date/time of creation - format: date-time - title: Created at + x-stream-index: "004.001" + mutes: + description: Object with mutes (if multiple users were muted) + items: + $ref: '#/components/schemas/UserMute' + title: Mutes + type: array + x-stream-index: "001" + non_existing_users: + description: A list of users that can't be found. Common cause for this + is deleted users + items: + type: string + title: Non Existing Users + type: array + x-stream-index: "003" + own_user: + $ref: '#/components/schemas/OwnUser' + description: Authorized user object with fresh mutes information + title: Own User + x-stream-index: "002" + required: + - duration + title: MuteResponse + type: object + MuteUsersRequest: + nullable: true + properties: + audio: + title: Audio + type: boolean + x-stream-index: "005" + mute_all_users: + type: boolean + x-stream-index: "003" + screenshare: + title: Screenshare + type: boolean + x-stream-index: "007" + screenshare_audio: + title: ScreenshareAudio + type: boolean + x-stream-index: "008" + user_ids: + items: + type: string + title: UserIDs + type: array + x-stream-index: "004" + video: + title: Video + type: boolean + x-stream-index: "006" + title: MuteUsersRequest + type: object + MuteUsersResponse: + description: MuteUsersResponse is the response payload for the mute users endpoint. + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "001.001" + required: + - duration + title: MuteUsersResponse + type: object + NetworkMetricsReportResponse: + properties: + average_connection_time: + format: float type: number - x-stream-index: 001.001.003 - custom: - additionalProperties: {} - type: object - x-stream-index: 001.001.007 - message_id: - description: The ID of the message for which the reminder was created - title: Message ID + x-stream-index: "003" + average_jitter: + format: float + type: number + x-stream-index: "002" + average_latency: + format: float + type: number + x-stream-index: "001" + average_time_to_reconnect: + format: float + type: number + x-stream-index: "004" + type: object + NoiseCancellationSettings: + properties: + mode: + enum: + - available + - disabled + - auto-on type: string - x-stream-index: "001.002" - parent_id: - description: The ID of the parent message, if the reminder is for a thread - message - title: Parent ID + x-stream-index: "001" + required: + - mode + type: object + NotificationAddedToChannelEvent: + properties: + channel: + $ref: '#/components/schemas/ChannelResponse' + x-stream-index: "003.004" + channel_id: type: string - x-stream-index: "001.005" - received_at: + x-stream-index: "003.002" + channel_member_count: + format: int32 + type: integer + x-stream-index: "003.005" + channel_type: + type: string + x-stream-index: "003.003" + cid: + type: string + x-stream-index: "003.001" + created_at: format: date-time type: number - x-stream-index: 001.001.004 - reminder: - $ref: '#/components/schemas/ReminderResponseData' - description: The reminder object which was created - title: MessageReminder - x-stream-index: "001.006" + x-stream-index: "002.002" + member: + $ref: '#/components/schemas/ChannelMember' + x-stream-index: "001.001" type: - default: reminder.created - description: 'The type of event: "reminder.created" in this case' - title: Event Type - type: string - x-stream-index: 001.001.002 - user_id: - description: The ID of the user for whom the reminder was created - title: User ID + default: notification.added_to_channel type: string - x-stream-index: "001.003" + x-stream-index: "002.001" required: - type - created_at - - custom - - message_id - - user_id - cid - title: ReminderCreatedEvent + - channel_id + - channel_type + - channel_member_count + title: NotificationAddedToChannelEvent 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 - ReminderDeletedEvent: - description: Emitted when a reminder is deleted. - nullable: true + NotificationChannelDeletedEvent: properties: + channel: + $ref: '#/components/schemas/ChannelResponse' + x-stream-index: "003.004" + channel_id: + type: string + x-stream-index: "003.002" + channel_member_count: + format: int32 + type: integer + x-stream-index: "003.005" + channel_type: + type: string + x-stream-index: "003.003" cid: - description: The CID of the Channel for which the reminder was created - title: Channel CID type: string - x-stream-index: "001.004" + x-stream-index: "003.001" created_at: - description: Date/time of creation format: date-time - title: Created at type: number - x-stream-index: 001.001.003 - custom: - additionalProperties: {} - type: object - x-stream-index: 001.001.007 - message_id: - description: The ID of the message for which the reminder was created - title: Message ID - type: string - x-stream-index: "001.002" - parent_id: - description: The ID of the parent message, if the reminder is for a thread - message - title: Parent ID + x-stream-index: "002.002" + team: type: string - x-stream-index: "001.005" - received_at: - format: date-time - type: number - x-stream-index: 001.001.004 - reminder: - $ref: '#/components/schemas/ReminderResponseData' - description: The reminder object which was created - title: MessageReminder - x-stream-index: "001.006" + x-stream-index: "001.001" type: - default: reminder.deleted - description: 'The type of event: "reminder.deleted" in this case' - title: Event Type - type: string - x-stream-index: 001.001.002 - user_id: - description: The ID of the user for whom the reminder was created - title: User ID + default: notification.channel_deleted type: string - x-stream-index: "001.003" + x-stream-index: "002.001" required: - type - created_at - - custom - - message_id - - user_id - cid - title: ReminderDeletedEvent + - channel_id + - channel_type + - channel_member_count + title: NotificationChannelDeletedEvent 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 - ReminderNotificationEvent: - description: Emitted when a reminder becomes due, triggering a notification - for the user. - nullable: true + NotificationChannelMutesUpdatedEvent: properties: - cid: - description: The CID of the Channel for which the reminder was created - title: Channel CID - type: string - x-stream-index: "001.004" created_at: - description: Date/time of creation format: date-time - title: Created at type: number - x-stream-index: 001.001.003 - custom: - additionalProperties: {} - type: object - x-stream-index: 001.001.007 - message_id: - description: The ID of the message for which the reminder was created - title: Message ID - type: string - x-stream-index: "001.002" - parent_id: - type: string - x-stream-index: "001.005" - received_at: - format: date-time - type: number - x-stream-index: 001.001.004 - reminder: - $ref: '#/components/schemas/ReminderResponseData' - description: The reminder object which was created - title: MessageReminder - x-stream-index: "001.006" + x-stream-index: "002.002" + me: + $ref: '#/components/schemas/OwnUser' + x-stream-index: "001" type: - default: notification.reminder_due - description: 'The type of event: "notification.reminder_due" in this case' - title: Event Type - type: string - x-stream-index: 001.001.002 - user_id: - description: The ID of the user for whom the reminder was created - title: User ID + default: notification.channel_mutes_updated type: string - x-stream-index: "001.003" + x-stream-index: "002.001" required: + - me - type - created_at - - custom - - message_id - - user_id - - cid - title: ReminderNotificationEvent + title: NotificationChannelMutesUpdatedEvent 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 - ReminderResponseData: + NotificationChannelTruncatedEvent: properties: channel: $ref: '#/components/schemas/ChannelResponse' - x-stream-index: "003" - channel_cid: + x-stream-index: "002.004" + channel_id: type: string - x-stream-index: "002" - created_at: - format: date-time - type: number - x-stream-index: "008" - message: - $ref: '#/components/schemas/Message' - x-stream-index: "005" - message_id: + x-stream-index: "002.002" + channel_member_count: + format: int32 + type: integer + x-stream-index: "002.005" + channel_type: type: string - x-stream-index: "004" - remind_at: - format: date-time - type: number - x-stream-index: "001" - updated_at: + x-stream-index: "002.003" + cid: + type: string + x-stream-index: "002.001" + created_at: format: date-time type: number - x-stream-index: "009" - user: - $ref: '#/components/schemas/User' - x-stream-index: "007" - user_id: + x-stream-index: "001.002" + type: + default: notification.channel_truncated type: string - x-stream-index: "006" + x-stream-index: "001.001" required: - - channel_cid - - message_id - - user_id + - type - created_at - - updated_at + - cid + - channel_id + - channel_type + - channel_member_count + title: NotificationChannelTruncatedEvent type: object - ReminderUpdatedEvent: - description: Emitted when a reminder is updated. + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + NotificationConfig: + properties: + track_read: + type: boolean + x-stream-index: "002" + track_seen: + type: boolean + x-stream-index: "001" + type: object + NotificationFeedUpdatedEvent: + description: Emitted when notification feed is updated. nullable: true properties: - cid: - description: The CID of the Channel for which the reminder was created - title: Channel CID - type: string - x-stream-index: "001.004" + aggregated_activities: + description: Aggregated activities for notification feeds + items: + $ref: '#/components/schemas/AggregatedActivityResponse' + title: Aggregated Activities + type: array + x-stream-index: "001" created_at: description: Date/time of creation format: date-time title: Created at type: number - x-stream-index: 001.001.003 + x-stream-index: 003.001.003 custom: additionalProperties: {} type: object - x-stream-index: 001.001.007 - message_id: - description: The ID of the message for which the reminder was created - title: Message ID + x-stream-index: 003.001.007 + feed_visibility: type: string - x-stream-index: "001.002" - parent_id: - description: The ID of the parent message, if the reminder is for a thread - message - title: Parent ID + x-stream-index: "003.003" + fid: + description: The ID of the feed + title: Feed ID type: string - x-stream-index: "001.005" + x-stream-index: "003.002" + notification_status: + $ref: '#/components/schemas/NotificationStatusResponse' + description: Notification status including unread/unseen counts + title: Notification Status + x-stream-index: "002" received_at: format: date-time type: number - x-stream-index: 001.001.004 - reminder: - $ref: '#/components/schemas/ReminderResponseData' - description: The reminder object which was created - title: MessageReminder - x-stream-index: "001.006" + x-stream-index: 003.001.004 type: - default: reminder.updated - description: 'The type of event: "reminder.updated" in this case' + default: feeds.notification_feed.updated + description: 'The type of event: "feeds.notification_feed.updated" in this + case' title: Event Type type: string - x-stream-index: 001.001.002 - user_id: - description: The ID of the user for whom the reminder was created - title: User ID - type: string - x-stream-index: "001.003" + x-stream-index: 003.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who triggered the notification + title: User + x-stream-index: "004.001" required: - type - created_at - custom - - message_id - - user_id - - cid - title: ReminderUpdatedEvent + - fid + title: NotificationFeedUpdatedEvent 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 - ReportByHistogramBucket: + NotificationInviteAcceptedEvent: properties: - category: + channel: + $ref: '#/components/schemas/ChannelResponse' + x-stream-index: "002.004" + channel_id: type: string - x-stream-index: "001" - count: + x-stream-index: "002.002" + channel_member_count: format: int32 type: integer - x-stream-index: "005" - lower_bound: - $ref: '#/components/schemas/Bound' - x-stream-index: "002" - sum: - format: float + x-stream-index: "002.005" + channel_type: + type: string + x-stream-index: "002.003" + cid: + type: string + x-stream-index: "002.001" + created_at: + format: date-time type: number - x-stream-index: "004" - upper_bound: - $ref: '#/components/schemas/Bound' - x-stream-index: "003" - required: - - category - - sum - - count - type: object - ReportResponse: - properties: - call: - $ref: '#/components/schemas/CallReportResponse' - x-stream-index: "003" - participants: - $ref: '#/components/schemas/ParticipantReportResponse' - x-stream-index: "001" - user_ratings: - $ref: '#/components/schemas/UserRatingReportResponse' - x-stream-index: "002" - required: - - participants - - user_ratings - - call - type: object - RequestPermissionRequest: - nullable: true - properties: - permissions: - items: - type: string - title: Permissions - type: array - x-stream-index: "003" - required: - - permissions - title: RequestPermissionRequest - type: object - RequestPermissionResponse: - nullable: true - properties: - duration: - description: Duration of the request in milliseconds - title: Duration + x-stream-index: "001.002" + member: + $ref: '#/components/schemas/ChannelMember' + x-stream-index: "004.001" + type: + default: notification.invite_accepted type: string x-stream-index: "001.001" + user: + $ref: '#/components/schemas/User' + x-stream-index: "003.001" required: - - duration - title: RequestPermissionResponse + - type + - created_at + - cid + - channel_id + - channel_type + - channel_member_count + title: NotificationInviteAcceptedEvent type: object - Response: - description: Basic response information - nullable: true + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + NotificationInviteRejectedEvent: properties: - duration: - description: Duration of the request in milliseconds - title: Duration + channel: + $ref: '#/components/schemas/ChannelResponse' + x-stream-index: "002.004" + channel_id: type: string - x-stream-index: "001" - required: - - duration - title: Response - type: object - RestoreActionRequest: - type: object - ReviewQueueItem: - properties: - actions: - items: - $ref: '#/components/schemas/ActionLog' - type: array - x-stream-index: "035" - activity: - $ref: '#/components/schemas/EnrichedActivity' - x-stream-index: "028" - ai_text_severity: - type: string - x-stream-index: "021" - archived_at: - $ref: '#/components/schemas/NullTime' - x-stream-index: "043" - assigned_to: - $ref: '#/components/schemas/User' - x-stream-index: "032" - bans: - items: - $ref: '#/components/schemas/Ban' - type: array - x-stream-index: "033" - bounce_count: + x-stream-index: "002.002" + channel_member_count: format: int32 type: integer - x-stream-index: "025" - call: - $ref: '#/components/schemas/Call' - x-stream-index: "031" - completed_at: - $ref: '#/components/schemas/NullTime' - x-stream-index: "018" - config_key: + x-stream-index: "002.005" + channel_type: type: string - x-stream-index: "009" - content_changed: - type: boolean - x-stream-index: "036" + x-stream-index: "002.003" + cid: + type: string + x-stream-index: "002.001" created_at: format: date-time type: number - x-stream-index: "004" - entity_creator: - $ref: '#/components/schemas/EntityCreator' - x-stream-index: "030" - entity_id: + x-stream-index: "001.002" + member: + $ref: '#/components/schemas/ChannelMember' + x-stream-index: "004.001" + type: + default: notification.invite_rejected type: string - x-stream-index: "007" - entity_type: + x-stream-index: "001.001" + user: + $ref: '#/components/schemas/User' + x-stream-index: "003.001" + required: + - type + - created_at + - cid + - channel_id + - channel_type + - channel_member_count + title: NotificationInviteRejectedEvent + 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 + NotificationInvitedEvent: + properties: + channel: + $ref: '#/components/schemas/ChannelResponse' + x-stream-index: "002.004" + channel_id: type: string - x-stream-index: "006" - feeds_v2_activity: - $ref: '#/components/schemas/EnrichedActivity' - x-stream-index: "041" - feeds_v2_reaction: - $ref: '#/components/schemas/Reaction' - x-stream-index: "042" - flag_labels: - items: - type: string - type: array - x-stream-index: "045" - flag_types: - items: - type: string - type: array - x-stream-index: "044" - flags: - items: - $ref: '#/components/schemas/Flag' - type: array - x-stream-index: "034" - flags_count: + x-stream-index: "002.002" + channel_member_count: format: int32 type: integer - x-stream-index: "026" - has_image: - type: boolean - x-stream-index: "012" - has_text: - type: boolean - x-stream-index: "014" - has_video: - type: boolean - x-stream-index: "013" - id: + x-stream-index: "002.005" + channel_type: type: string - x-stream-index: "003" - languages: - items: - type: string - type: array - x-stream-index: "019" - message: - $ref: '#/components/schemas/Message' - x-stream-index: "027" - moderation_payload: - $ref: '#/components/schemas/ModerationPayload' - x-stream-index: "010" - moderation_payload_hash: + x-stream-index: "002.003" + cid: type: string - x-stream-index: "011" - reaction: - $ref: '#/components/schemas/Reaction' - x-stream-index: "029" - recommended_action: + x-stream-index: "002.001" + created_at: + format: date-time + type: number + x-stream-index: "001.002" + member: + $ref: '#/components/schemas/ChannelMember' + x-stream-index: "004.001" + type: + default: notification.invited type: string - x-stream-index: "017" - reporter_ids: - items: - type: string - type: array - x-stream-index: "046" - reviewed_at: - $ref: '#/components/schemas/NullTime' - x-stream-index: "022" - reviewed_by: + x-stream-index: "001.001" + user: + $ref: '#/components/schemas/User' + x-stream-index: "003.001" + required: + - type + - created_at + - cid + - channel_id + - channel_type + - channel_member_count + title: NotificationInvitedEvent + 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 + NotificationMarkReadEvent: + properties: + channel: + $ref: '#/components/schemas/ChannelResponse' + x-stream-index: "003.004" + channel_id: type: string - x-stream-index: "023" - severity: + x-stream-index: "003.002" + channel_member_count: format: int32 type: integer - x-stream-index: "020" - status: + x-stream-index: "003.005" + channel_type: type: string - x-stream-index: "016" - teams: - items: - type: string - type: array - x-stream-index: "015" - updated_at: + x-stream-index: "003.003" + cid: + type: string + x-stream-index: "003.001" + created_at: format: date-time type: number + x-stream-index: "001.002" + team: + type: string + x-stream-index: "002.001" + total_unread_count: + format: int32 + type: integer + x-stream-index: "006" + type: + default: notification.mark_read + type: string + x-stream-index: "001.001" + unread_channels: + format: int32 + type: integer + x-stream-index: "007" + unread_count: + format: int32 + type: integer x-stream-index: "005" + unread_threads: + format: int32 + type: integer + x-stream-index: "008" + user: + $ref: '#/components/schemas/User' + x-stream-index: "004.001" required: - - id + - type - created_at - - updated_at - - entity_type - - entity_id - - config_key - - moderation_payload_hash - - has_image - - has_video - - has_text - - teams - - status - - recommended_action - - completed_at - - languages - - severity - - ai_text_severity - - reviewed_at - - reviewed_by - - bounce_count - - flags_count - - bans - - flags - - actions - - content_changed - - archived_at - - flag_types - - flag_labels - - reporter_ids - type: object - ReviewQueueItemResponse: - nullable: true - properties: - actions: - description: Moderation actions taken - items: - $ref: '#/components/schemas/ActionLogResponse' - title: Actions - type: array - x-stream-index: "024" - activity: - $ref: '#/components/schemas/EnrichedActivity' - x-stream-index: "016" - ai_text_severity: - description: AI-determined text severity - title: AI Text Severity + - cid + - channel_id + - channel_type + - channel_member_count + - unread_count + - total_unread_count + - unread_channels + - unread_threads + title: NotificationMarkReadEvent + 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 + NotificationMarkUnreadEvent: + properties: + channel: + $ref: '#/components/schemas/ChannelResponse' + x-stream-index: "003.004" + channel_id: type: string - x-stream-index: "014" - assigned_to: - $ref: '#/components/schemas/UserResponse' - description: Moderator assigned to review this item - title: Assigned To - x-stream-index: "021" - bans: - description: Associated ban records - items: - $ref: '#/components/schemas/Ban' - title: Bans - type: array - x-stream-index: "022" - call: - $ref: '#/components/schemas/CallResponse' - x-stream-index: "018" - completed_at: - description: When the review was completed - format: date-time - title: Completed At - type: number - x-stream-index: "009" - config_key: + x-stream-index: "003.002" + channel_member_count: + format: int32 + type: integer + x-stream-index: "003.005" + channel_type: type: string - x-stream-index: "028" + x-stream-index: "003.003" + cid: + type: string + x-stream-index: "003.001" created_at: - description: When the item was created format: date-time - title: Created At type: number - x-stream-index: "002" - entity_creator: - $ref: '#/components/schemas/EntityCreatorResponse' - description: Details about who created the entity - title: Entity Creator - x-stream-index: "019" - entity_creator_id: - description: ID of who created the entity - title: Entity Creator ID - type: string - x-stream-index: "020" - entity_id: - description: ID of the entity being reviewed - title: Entity ID + x-stream-index: "001.002" + first_unread_message_id: type: string x-stream-index: "005" - entity_type: - description: Type of entity being reviewed - title: Entity Type - type: string - x-stream-index: "004" - feeds_v2_activity: - $ref: '#/components/schemas/EnrichedActivity' - description: Associated feed activity - title: Feeds V2 Activity - x-stream-index: "025" - feeds_v2_reaction: - $ref: '#/components/schemas/Reaction' - description: Associated feed reaction - title: Feeds V2 Reaction - x-stream-index: "026" - flags: - description: Associated flag records - items: - $ref: '#/components/schemas/FlagResponse' - title: Flags - type: array - x-stream-index: "023" - flags_count: - format: int32 - type: integer - x-stream-index: "029" - id: - description: Unique identifier of the review queue item - title: ID + last_read_at: + format: date-time + type: number + x-stream-index: "006" + last_read_message_id: type: string - x-stream-index: "001" - languages: - description: Detected languages in the content - items: - type: string - title: Languages - type: array x-stream-index: "012" - message: - $ref: '#/components/schemas/MessageResponse' - description: Associated message details - title: Message - x-stream-index: "015" - moderation_payload: - $ref: '#/components/schemas/ModerationPayload' - description: Content being moderated - title: Moderation Payload - x-stream-index: "006" - reaction: - $ref: '#/components/schemas/Reaction' - x-stream-index: "017" - recommended_action: - description: Suggested moderation action - title: Recommended Action + team: type: string - x-stream-index: "008" - reviewed_at: - description: When the item was reviewed - format: date-time - title: Reviewed At - type: number - x-stream-index: "010" - reviewed_by: - description: ID of the moderator who reviewed the item - title: Reviewed By + x-stream-index: "002.001" + thread_id: type: string - x-stream-index: "011" - severity: - description: Severity level of the content - format: int32 - title: Severity - type: integer x-stream-index: "013" - status: - description: Current status of the review - title: Status - type: string - x-stream-index: "007" - teams: - description: Teams associated with this item - items: - type: string - title: Teams - type: array - x-stream-index: "027" - updated_at: - description: When the item was last updated - format: date-time - title: Updated At - type: number - x-stream-index: "003" - required: - - id - - created_at - - updated_at - - entity_type - - entity_id - - status - - recommended_action - - reviewed_by - - languages - - severity - - ai_text_severity - - bans - - flags - - actions - - flags_count - type: object - RingSettings: - properties: - auto_cancel_timeout_ms: - format: int32 - type: integer - x-stream-index: "002" - incoming_call_timeout_ms: + total_unread_count: format: int32 type: integer - x-stream-index: "001" - missed_call_timeout_ms: + x-stream-index: "009" + type: + default: notification.mark_unread + type: string + x-stream-index: "001.001" + unread_channels: format: int32 type: integer - x-stream-index: "003" - required: - - incoming_call_timeout_ms - - auto_cancel_timeout_ms - - missed_call_timeout_ms - type: object - RingSettingsRequest: - properties: - auto_cancel_timeout_ms: - description: When none of the callees accept a ring call in this time a - rejection will be sent by the caller with reason 'timeout' by the SDKs + x-stream-index: "010" + unread_count: format: int32 - maximum: 180000 - minimum: 5000 - title: AutoCancelTimeoutMs type: integer - x-stream-index: "002" - incoming_call_timeout_ms: - description: When a callee is online but doesn't answer a ring call in this - time a rejection will be sent with reason 'timeout' by the SDKs + x-stream-index: "008" + unread_messages: format: int32 - maximum: 180000 - minimum: 5000 - title: IncomingCallTimeoutMs type: integer - x-stream-index: "001" - missed_call_timeout_ms: - description: When a callee doesn't accept or reject a ring call in this - time a missed call event will be sent + x-stream-index: "007" + unread_threads: format: int32 - maximum: 180000 - minimum: 5000 - title: MissedCallTimeoutMs type: integer - x-stream-index: "003" + x-stream-index: "011" + user: + $ref: '#/components/schemas/User' + x-stream-index: "004.001" required: - - incoming_call_timeout_ms - - auto_cancel_timeout_ms - title: RingSettingsRequest - type: object - RingSettingsResponse: - properties: - auto_cancel_timeout_ms: - format: int32 - type: integer - x-stream-index: "002" - incoming_call_timeout_ms: - format: int32 - type: integer - x-stream-index: "001" - missed_call_timeout_ms: - format: int32 - type: integer - x-stream-index: "003" - required: - - incoming_call_timeout_ms - - auto_cancel_timeout_ms - - missed_call_timeout_ms + - type + - created_at + - cid + - channel_id + - channel_type + - channel_member_count + - first_unread_message_id + - last_read_at + - unread_messages + - unread_count + - total_unread_count + - unread_channels + - unread_threads + title: NotificationMarkUnreadEvent type: object - RuleBuilderAction: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + NotificationMutesUpdatedEvent: properties: - ban_options: - $ref: '#/components/schemas/BanOptions' - x-stream-index: "002" - flag_content_options: - $ref: '#/components/schemas/FlagContentOptions' - x-stream-index: "004" - flag_user_options: - $ref: '#/components/schemas/FlagUserOptions' - x-stream-index: "003" - remove_content_options: - $ref: '#/components/schemas/BlockContentOptions' - x-stream-index: "005" + created_at: + format: date-time + type: number + x-stream-index: "002.002" + me: + $ref: '#/components/schemas/OwnUser' + x-stream-index: "001" type: + default: notification.mutes_updated type: string - x-stream-index: "001" + x-stream-index: "002.001" required: + - me - type + - created_at + title: NotificationMutesUpdatedEvent type: object - RuleBuilderCondition: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + NotificationNewMessageEvent: properties: - confidence: - format: float + channel: + $ref: '#/components/schemas/ChannelResponse' + x-stream-index: "004.004" + channel_id: + type: string + x-stream-index: "004.002" + channel_member_count: + format: int32 + type: integer + x-stream-index: "004.005" + channel_type: + type: string + x-stream-index: "004.003" + cid: + type: string + x-stream-index: "004.001" + created_at: + format: date-time type: number - x-stream-index: "002" - content_count_rule_params: - $ref: '#/components/schemas/ContentCountRuleParameters' - x-stream-index: "007" - image_content_params: - $ref: '#/components/schemas/ImageContentParameters' - x-stream-index: "009" - image_rule_params: - $ref: '#/components/schemas/ImageRuleParameters' - x-stream-index: "004" - text_content_params: - $ref: '#/components/schemas/TextContentParameters' - x-stream-index: "008" - text_rule_params: - $ref: '#/components/schemas/TextRuleParameters' - x-stream-index: "003" + x-stream-index: "003.002" + message: + $ref: '#/components/schemas/Message' + x-stream-index: "001" + team: + type: string + x-stream-index: "002.001" type: + default: notification.message_new type: string - x-stream-index: "001" - user_created_within_params: - $ref: '#/components/schemas/UserCreatedWithinParameters' - x-stream-index: "011" - user_rule_params: - $ref: '#/components/schemas/UserRuleParameters' - x-stream-index: "006" - video_content_params: - $ref: '#/components/schemas/VideoContentParameters' - x-stream-index: "010" - video_rule_params: - $ref: '#/components/schemas/VideoRuleParameters' - x-stream-index: "005" + x-stream-index: "003.001" required: + - message - type + - created_at + - cid + - channel_id + - channel_type + - channel_member_count + title: NotificationNewMessageEvent type: object - RuleBuilderConditionGroup: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + NotificationRemovedFromChannelEvent: properties: - conditions: - items: - $ref: '#/components/schemas/RuleBuilderCondition' - type: array - x-stream-index: "002" - logic: + channel: + $ref: '#/components/schemas/ChannelResponse' + x-stream-index: "002.004" + channel_id: type: string - x-stream-index: "001" + x-stream-index: "002.002" + channel_member_count: + format: int32 + type: integer + x-stream-index: "002.005" + channel_type: + type: string + x-stream-index: "002.003" + cid: + type: string + x-stream-index: "002.001" + created_at: + format: date-time + type: number + x-stream-index: "001.002" + member: + $ref: '#/components/schemas/ChannelMember' + x-stream-index: "004.001" + type: + default: notification.removed_from_channel + type: string + x-stream-index: "001.001" + user: + $ref: '#/components/schemas/User' + x-stream-index: "003.001" required: - - logic - - conditions + - type + - created_at + - cid + - channel_id + - channel_type + - channel_member_count + title: NotificationRemovedFromChannelEvent type: object - RuleBuilderConfig: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + NotificationSettings: properties: - async: + call_live_started: + $ref: '#/components/schemas/EventNotificationSettings' + x-stream-index: "002" + call_missed: + $ref: '#/components/schemas/EventNotificationSettings' + x-stream-index: "006" + call_notification: + $ref: '#/components/schemas/EventNotificationSettings' + x-stream-index: "004" + call_ring: + $ref: '#/components/schemas/EventNotificationSettings' + x-stream-index: "005" + enabled: type: boolean x-stream-index: "001" - rules: - items: - $ref: '#/components/schemas/RuleBuilderRule' - type: array - x-stream-index: "002" + session_started: + $ref: '#/components/schemas/EventNotificationSettings' + x-stream-index: "003" required: - - rules + - enabled + - call_live_started + - session_started + - call_notification + - call_ring + - call_missed type: object - RuleBuilderRule: + NotificationStatusResponse: properties: - action: - $ref: '#/components/schemas/RuleBuilderAction' - x-stream-index: "007" - conditions: + last_read_at: + format: date-time + type: number + x-stream-index: "006" + last_seen_at: + description: When notifications were last seen + format: date-time + title: Last Seen At + type: number + x-stream-index: "005" + read_activities: + description: IDs of activities that have been read items: - $ref: '#/components/schemas/RuleBuilderCondition' + type: string + title: Read Activities type: array - x-stream-index: "004" - cooldown_period: - type: string - x-stream-index: "009" - enabled: - type: boolean - x-stream-index: "008" - groups: + x-stream-index: "003" + seen_activities: items: - $ref: '#/components/schemas/RuleBuilderConditionGroup' + type: string type: array - x-stream-index: "006" - id: - type: string + x-stream-index: "004" + unread: + description: Number of unread notifications + format: int32 + title: Unread + type: integer x-stream-index: "001" - logic: - type: string - x-stream-index: "005" - name: - type: string + unseen: + description: Number of unseen notifications + format: int32 + title: Unseen + type: integer x-stream-index: "002" - rule_type: - type: string - x-stream-index: "003" required: - - id - - name - - rule_type - - action - - enabled + - unread + - unseen + title: Notification Status type: object - SDKUsageReport: - properties: - per_sdk_usage: - additionalProperties: - $ref: '#/components/schemas/PerSDKUsageReport' - type: object - x-stream-index: "001" - required: - - per_sdk_usage + NullTime: type: object - SDKUsageReportResponse: + OCRRule: properties: - daily: - items: - $ref: '#/components/schemas/DailyAggregateSDKUsageReportResponse' - type: array + action: + enum: + - flag + - shadow + - remove + - bounce + - bounce_flag + - bounce_remove + type: string + x-stream-index: "002" + label: + type: string x-stream-index: "001" required: - - daily + - label + - action type: object - SFUIDLastSeen: + OnlyUserID: properties: id: type: string - x-stream-index: "001.001" - last_seen: - format: date-time - type: number - x-stream-index: "002" - process_start_time: - format: int64 - type: integer - x-stream-index: "001.002" + x-stream-index: "001" required: - id - - process_start_time - - last_seen type: object - SFUResponse: + OwnCapability: + description: All possibility of string to use + enum: + - block-users + - change-max-duration + - create-call + - create-reaction + - enable-noise-cancellation + - end-call + - join-backstage + - join-call + - join-ended-call + - kick-user + - mute-users + - pin-for-everyone + - read-call + - remove-call-member + - screenshare + - send-audio + - send-video + - start-broadcast-call + - start-closed-captions-call + - start-frame-record-call + - start-record-call + - start-transcription-call + - stop-broadcast-call + - stop-closed-captions-call + - stop-frame-record-call + - stop-record-call + - stop-transcription-call + - update-call + - update-call-member + - update-call-permissions + - update-call-settings + title: OwnCapability + type: string + OwnUser: properties: - edge_name: - type: string - x-stream-index: "001" - url: - type: string - x-stream-index: "002" - ws_endpoint: + avg_response_time: + format: int32 + type: integer + x-stream-index: "046" + banned: + type: boolean + x-stream-index: "016" + blocked_user_ids: + items: + type: string + type: array + x-stream-index: "045" + channel_mutes: + items: + $ref: '#/components/schemas/ChannelMute' + type: array + x-stream-index: "029" + created_at: + format: date-time + type: number + x-stream-index: "008" + custom: + additionalProperties: {} + type: object + x-stream-index: "006" + deactivated_at: + format: date-time + type: number + x-stream-index: "014" + deleted_at: + format: date-time + type: number + x-stream-index: "013" + devices: + items: + $ref: '#/components/schemas/Device' + type: array + x-stream-index: "027" + id: type: string x-stream-index: "003" - required: - - edge_name - - url - - ws_endpoint - type: object - STTEgressConfig: - properties: - closed_captions_enabled: + invisible: type: boolean - x-stream-index: "005" - external_storage: - $ref: '#/components/schemas/ExternalStorage' - x-stream-index: "011" + x-stream-index: "023" language: type: string - x-stream-index: "008" - storage_name: - type: string - x-stream-index: "010" - translation_languages: + x-stream-index: "035" + last_active: + format: date-time + type: number + x-stream-index: "011" + last_engaged_at: + format: date-time + type: number + x-stream-index: "012" + latest_hidden_channels: items: type: string type: array - x-stream-index: "009" - translations_enabled: - type: boolean - x-stream-index: "006" - upload_transcriptions: + x-stream-index: "037" + mutes: + items: + $ref: '#/components/schemas/UserMute' + type: array + x-stream-index: "028" + online: type: boolean - x-stream-index: "004" - whisper_server_base_url: + x-stream-index: "022" + privacy_settings: + $ref: '#/components/schemas/PrivacySettings' + x-stream-index: "026" + push_preferences: + $ref: '#/components/schemas/PushPreferences' + x-stream-index: "025" + role: type: string - x-stream-index: "007" - type: object - ScreensharingSettings: - properties: - access_request_enabled: - type: boolean - x-stream-index: "002" - enabled: - type: boolean - x-stream-index: "001" - target_resolution: - $ref: '#/components/schemas/TargetResolution' - x-stream-index: "003" - required: - - enabled - - access_request_enabled - type: object - ScreensharingSettingsRequest: - properties: - access_request_enabled: - type: boolean - x-stream-index: "002" - enabled: - type: boolean - x-stream-index: "001" - target_resolution: - $ref: '#/components/schemas/TargetResolution' - x-stream-index: "003" - type: object - ScreensharingSettingsResponse: - properties: - access_request_enabled: - type: boolean - x-stream-index: "002" - enabled: - type: boolean - x-stream-index: "001" - target_resolution: - $ref: '#/components/schemas/TargetResolution' - x-stream-index: "003" - required: - - enabled - - access_request_enabled - type: object - SearchPayload: - properties: - filter_conditions: - additionalProperties: {} - description: Channel filter conditions - maximum: 100 - minimum: 1 - title: Channel filter + x-stream-index: "004" + teams: + items: + type: string + type: array + x-stream-index: "036" + teams_role: + additionalProperties: + type: string type: object - x-stream-docs-page-id: query_channels - x-stream-index: "002" - limit: - description: Number of messages to return + x-stream-index: "005" + total_unread_count: format: int32 - title: Limit type: integer - x-stream-index: "005" - message_filter_conditions: - additionalProperties: {} - description: Message filter conditions - title: Message filter + x-stream-index: "031" + total_unread_count_by_team: + additionalProperties: + format: int32 + type: integer type: object - x-stream-index: "003" - message_options: - $ref: '#/components/schemas/MessageOptions' - x-stream-index: "004" - next: - description: Pagination parameter. Cannot be used with non-zero offset. - title: Next - type: string - x-stream-index: "008" - offset: - description: Pagination offset. Cannot be used with sort or next. + x-stream-index: "032" + unread_channels: format: int32 - title: Offset type: integer - x-stream-index: "006" - query: - description: Search phrase - title: Query - type: string - x-stream-index: "001" - sort: - description: Sort parameters. Cannot be used with non-zero offset - items: - $ref: '#/components/schemas/SortParamRequest' - title: Sort - type: array - x-stream-index: "007" + x-stream-index: "033" + unread_count: + format: int32 + type: integer + x-stream-index: "030" + unread_threads: + format: int32 + type: integer + x-stream-index: "034" + updated_at: + format: date-time + type: number + x-stream-index: "009" required: - - filter_conditions + - id + - role + - custom + - created_at + - updated_at + - banned + - online + - devices + - mutes + - channel_mutes + - unread_count + - total_unread_count + - total_unread_count_by_team + - unread_channels + - unread_threads + - language type: object - SearchResponse: - nullable: true + OwnUserResponse: properties: - duration: - description: Duration of the request in milliseconds - title: Duration - type: string - x-stream-index: "005.001" - next: - description: Value to pass to the next search query in order to paginate - title: Next - type: string - x-stream-index: "003" - previous: - description: Value that points to the previous page. Pass as the next value - in a search query to paginate backwards - title: Previous - type: string - x-stream-index: "004" - results: - description: Search results + avg_response_time: + format: int32 + type: integer + x-stream-index: "001.018" + banned: + type: boolean + x-stream-index: "001.012" + blocked_user_ids: items: - $ref: '#/components/schemas/SearchResult' - title: Results + type: string type: array - x-stream-index: "001" - results_warning: - $ref: '#/components/schemas/SearchWarning' - description: Warning about the search results - title: Results Warning - x-stream-index: "002" - required: - - results - - duration - type: object - SearchResult: - properties: - message: - $ref: '#/components/schemas/SearchResultMessage' - description: Found message - title: Message - x-stream-index: "001" - type: object - SearchResultMessage: - properties: - attachments: + x-stream-index: "015" + channel_mutes: items: - $ref: '#/components/schemas/Attachment' + $ref: '#/components/schemas/ChannelMute' type: array - x-stream-index: "001.008" - channel: - $ref: '#/components/schemas/ChannelResponse' - description: Channel object - title: Channel - x-stream-index: "002" - cid: - type: string - x-stream-index: "001.022" - command: - type: string - x-stream-index: "001.004" + x-stream-index: "007" created_at: format: date-time type: number - x-stream-index: "001.023" + x-stream-index: "001.009" custom: additionalProperties: {} type: object - x-stream-index: "001.026" + x-stream-index: "001.004" + deactivated_at: + format: date-time + type: number + x-stream-index: "001.016" deleted_at: format: date-time type: number - x-stream-index: "001.025" - deleted_reply_count: - format: int32 - type: integer - x-stream-index: "001.018" - draft: - $ref: '#/components/schemas/DraftResponse' - x-stream-index: "001.041" - html: - type: string - x-stream-index: "001.005" - i18n: - additionalProperties: - type: string - type: object - x-stream-index: "001.030" + x-stream-index: "001.011" + devices: + items: + $ref: '#/components/schemas/DeviceResponse' + title: Devices + type: array + x-stream-index: "004" id: type: string x-stream-index: "001.001" - image_labels: - additionalProperties: - items: - type: string - type: array - type: object - x-stream-index: "001.028" - latest_reactions: + image: + type: string + x-stream-index: "001.003" + invisible: + type: boolean + x-stream-index: "005" + language: + type: string + x-stream-index: "001.005" + last_active: + format: date-time + type: number + x-stream-index: "001.014" + latest_hidden_channels: items: - $ref: '#/components/schemas/ReactionResponse' + type: string type: array - x-stream-index: "001.009" - mentioned_users: + x-stream-index: "013" + mutes: items: - $ref: '#/components/schemas/UserResponse' + $ref: '#/components/schemas/UserMuteResponse' type: array - x-stream-index: "001.029" - message_text_updated_at: + x-stream-index: "006" + name: + type: string + x-stream-index: "001.002" + online: + type: boolean + x-stream-index: "001.013" + privacy_settings: + $ref: '#/components/schemas/PrivacySettingsResponse' + x-stream-index: "003" + push_preferences: + $ref: '#/components/schemas/PushPreferences' + x-stream-index: "002" + revoke_tokens_issued_before: format: date-time type: number - x-stream-index: "001.036" - mml: + x-stream-index: "001.015" + role: type: string - x-stream-index: "001.003" - moderation: - $ref: '#/components/schemas/ModerationV2Response' - x-stream-index: "001.039" - own_reactions: + x-stream-index: "001.006" + teams: items: - $ref: '#/components/schemas/ReactionResponse' + type: string type: array + x-stream-index: "001.007" + teams_role: + additionalProperties: + type: string + type: object + x-stream-index: "001.008" + total_unread_count: + format: int32 + type: integer + x-stream-index: "009" + total_unread_count_by_team: + additionalProperties: + format: int32 + type: integer + type: object + x-stream-index: "010" + unread_channels: + format: int32 + type: integer + x-stream-index: "011" + unread_count: + format: int32 + type: integer + x-stream-index: "008" + unread_threads: + format: int32 + type: integer + x-stream-index: "012" + updated_at: + format: date-time + type: number x-stream-index: "001.010" - parent_id: + required: + - id + - custom + - language + - role + - teams + - created_at + - updated_at + - banned + - online + - devices + - invisible + - mutes + - channel_mutes + - unread_count + - total_unread_count + - unread_channels + - unread_threads + type: object + PagerRequest: + properties: + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "001" + next: type: string - x-stream-index: "001.015" - pin_expires: - format: date-time - type: number - x-stream-index: "001.035" - pinned: - type: boolean - x-stream-index: "001.032" - pinned_at: - format: date-time - type: number - x-stream-index: "001.033" - pinned_by: - $ref: '#/components/schemas/UserResponse' - x-stream-index: "001.034" - poll: - $ref: '#/components/schemas/PollResponseData' - x-stream-index: "001.038" - poll_id: + x-stream-index: "002" + prev: type: string - x-stream-index: "001.037" - quoted_message: - $ref: '#/components/schemas/MessageResponse' - x-stream-index: "001.020" - quoted_message_id: + x-stream-index: "003" + type: object + PagerResponse: + properties: + next: type: string - x-stream-index: "001.019" - reaction_counts: - additionalProperties: - format: int32 - type: integer - type: object - x-stream-index: "001.011" - reaction_groups: - additionalProperties: - $ref: '#/components/schemas/ReactionGroupResponse' - type: object - x-stream-index: "001.014" - reaction_scores: - additionalProperties: - format: int32 - type: integer - type: object - x-stream-index: "001.012" - reminder: - $ref: '#/components/schemas/ReminderResponseData' - x-stream-index: "001.042" - reply_count: + x-stream-index: "001" + prev: + type: string + x-stream-index: "002" + type: object + PaginationParams: + properties: + limit: format: int32 + minimum: 0 type: integer - x-stream-index: "001.017" - restricted_visibility: - items: - type: string - type: array - x-stream-index: "001.040" - shadowed: - type: boolean - x-stream-index: "001.027" - shared_location: - $ref: '#/components/schemas/SharedLocationResponseData' - x-stream-index: "001.043" - show_in_channel: - type: boolean - x-stream-index: "001.016" - silent: - type: boolean - x-stream-index: "001.031" - text: - type: string - x-stream-index: "001.002" - thread_participants: - items: - $ref: '#/components/schemas/UserResponse' - type: array - x-stream-index: "001.021" - type: - type: string - x-stream-index: "001.006" - updated_at: + x-stream-index: "001" + offset: + format: int32 + type: integer + x-stream-index: "002" + type: object + ParticipantCountByMinuteResponse: + nullable: true + properties: + first: + format: int32 + type: integer + x-stream-index: "002" + last: + format: int32 + type: integer + x-stream-index: "003" + max: + format: int32 + type: integer + x-stream-index: "004" + min: + format: int32 + type: integer + x-stream-index: "005" + start_ts: format: date-time type: number - x-stream-index: "001.024" - user: - $ref: '#/components/schemas/UserResponse' - x-stream-index: "001.007" + x-stream-index: "001" required: - - id - - text - - html - - type - - user - - attachments - - latest_reactions - - own_reactions - - reaction_counts - - reaction_scores - - reply_count - - deleted_reply_count - - cid - - created_at - - updated_at - - custom - - shadowed - - mentioned_users - - silent - - pinned - - restricted_visibility + - start_ts + - first + - last + - max + - min type: object - SearchWarning: + ParticipantCountOverTimeResponse: properties: - channel_search_cids: - description: Channel CIDs for the searched channels + by_minute: items: - type: string - title: Channel Search CIDs + $ref: '#/components/schemas/ParticipantCountByMinuteResponse' + type: array + x-stream-index: "001" + type: object + ParticipantReportResponse: + properties: + by_browser: + items: + $ref: '#/components/schemas/GroupedStatsResponse' + type: array + x-stream-index: "008" + by_country: + items: + $ref: '#/components/schemas/GroupedStatsResponse' + type: array + x-stream-index: "005" + by_device: + items: + $ref: '#/components/schemas/GroupedStatsResponse' + type: array + x-stream-index: "006" + by_operating_system: + items: + $ref: '#/components/schemas/GroupedStatsResponse' type: array + x-stream-index: "007" + count_over_time: + $ref: '#/components/schemas/ParticipantCountOverTimeResponse' x-stream-index: "004" - channel_search_count: - description: Number of channels searched + max_concurrent: format: int32 - title: Channel Search Count type: integer x-stream-index: "003" - warning_code: - description: Code corresponding to the warning + publishers: + $ref: '#/components/schemas/PublisherStatsResponse' + x-stream-index: "009" + subscribers: + $ref: '#/components/schemas/SubscriberStatsResponse' + x-stream-index: "010" + sum: format: int32 - title: Warning Code type: integer - x-stream-index: "002" - warning_description: - description: Description of the warning - title: Warning Description - type: string x-stream-index: "001" + unique: + format: int32 + type: integer + x-stream-index: "002" required: - - warning_description - - warning_code + - sum + - unique type: object - SendCallEventRequest: - description: Send a call event to the other user + PendingMessageEvent: + description: Pending message event for async moderation nullable: true properties: + channel: + $ref: '#/components/schemas/Channel' + x-stream-index: "002.007" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: "004" custom: additionalProperties: {} - title: Custom type: object - x-stream-index: "004" - title: SendCallEventRequest - type: object - SendCallEventResponse: - nullable: true - properties: - duration: - description: Duration of the request in milliseconds - title: Duration + x-stream-index: "001.007" + message: + $ref: '#/components/schemas/Message' + description: The pending message + title: Message + x-stream-index: "002.009" + metadata: + additionalProperties: + type: string + type: object + x-stream-index: "002.010" + method: + description: The method used for the pending message + title: Method type: string - x-stream-index: "001.001" + x-stream-index: "003" + received_at: + format: date-time + type: number + x-stream-index: "001.004" + type: + default: message.pending + description: 'The type of event: "message.pending" in this case' + title: Event Type + type: string + x-stream-index: "001.002" + user: + $ref: '#/components/schemas/User' + x-stream-index: "002.002" required: - - duration - title: SendCallEventResponse + - type + - custom + - method + - created_at + title: PendingMessageEvent type: object - SendEventRequest: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + PendingMessageResponse: nullable: true properties: - event: - $ref: '#/components/schemas/EventRequest' + channel: + $ref: '#/components/schemas/ChannelResponse' + x-stream-index: "002" + message: + $ref: '#/components/schemas/MessageResponse' + x-stream-index: "003" + metadata: + additionalProperties: + type: string + type: object + x-stream-index: "004" + user: + $ref: '#/components/schemas/UserResponse' x-stream-index: "001" - required: - - event type: object - SendMessageRequest: + PerSDKUsageReport: nullable: true properties: - keep_channel_hidden: - type: boolean - x-stream-index: "008" - message: - $ref: '#/components/schemas/MessageRequest' + by_version: + additionalProperties: + format: int32 + type: integer + type: object + x-stream-index: "002" + total: + format: int32 + type: integer x-stream-index: "001" - skip_enrich_url: - type: boolean + required: + - total + - by_version + type: object + PermissionRequestEvent: + description: |- + This event is sent when a user requests access to a feature on a call, + clients receiving this event should display a permission request to the user + properties: + call_cid: + type: string + x-stream-index: "002.001" + created_at: + format: date-time + type: number + x-stream-index: "001.002" + permissions: + description: The list of permissions requested by the user + items: + type: string + title: Permissions + type: array + x-stream-index: "004" + type: + default: call.permission_request + description: 'The type of event: "call.permission_request" in this case' + title: Event Type + type: string + x-stream-index: "001.001" + user: + $ref: '#/components/schemas/UserResponse' + description: The user who sent the permission request + title: User x-stream-index: "003" - skip_push: - type: boolean - x-stream-index: "002" required: - - message + - type + - created_at + - call_cid + - user + - permissions + title: PermissionRequestEvent type: object - SendMessageResponse: + x-stream-event-call-type: true + x-stream-event-doc-group: call + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + PinActivityRequest: + nullable: true + title: Pin Activity Request + type: object + PinActivityResponse: nullable: true properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + description: The pinned activity + title: Activity + x-stream-index: "001" + created_at: + description: When the activity was pinned + format: date-time + title: Created At + type: number + x-stream-index: "004" duration: - description: Duration of the request in milliseconds - title: Duration type: string - x-stream-index: "003.001" - message: - $ref: '#/components/schemas/MessageResponse' - description: Message response - title: Message - x-stream-index: "001" - pending_message_metadata: - additionalProperties: - type: string - description: Pending message metadata - title: Pending message metadata - type: object + x-stream-index: "005.001" + feed: + description: Fully qualified ID of the feed the activity was pinned to + title: Feed ID + type: string x-stream-index: "002" + user_id: + description: ID of the user who pinned the activity + title: User ID + type: string + x-stream-index: "003" required: - - message + - activity + - feed + - user_id + - created_at - duration + title: Pin Activity Response type: object - SendReactionRequest: + PinRequest: + description: PinRequest is the payload for pinning a message. nullable: true properties: - enforce_unique: - description: Whether to replace all existing user reactions - title: Enforce unique - type: boolean + session_id: + description: the session ID of the user who pinned the message + title: SessionID + type: string x-stream-index: "003" - reaction: - $ref: '#/components/schemas/ReactionRequest' + user_id: + description: the user ID of the user who pinned the message + title: UserID + type: string x-stream-index: "002" - skip_push: - description: Skips any mobile push notifications - title: Skip push - type: boolean - x-stream-index: "004" required: - - reaction + - user_id + - session_id + title: PinRequest type: object - SendReactionResponse: + PinResponse: description: Basic response information nullable: true properties: @@ -16757,2280 +17278,2387 @@ components: description: Duration of the request in milliseconds title: Duration type: string - x-stream-index: "003.001" - message: - $ref: '#/components/schemas/MessageResponse' - x-stream-index: "001" - reaction: - $ref: '#/components/schemas/ReactionResponse' - x-stream-index: "002" + x-stream-index: "001.001" required: - - message - - reaction - duration title: Response type: object - SessionSettings: - properties: - inactivity_timeout_seconds: - format: int32 - maximum: 900 - minimum: 5 - type: integer - x-stream-index: "001" - required: - - inactivity_timeout_seconds - type: object - SessionSettingsRequest: - properties: - inactivity_timeout_seconds: - format: int32 - maximum: 900 - minimum: 5 - type: integer - x-stream-index: "001" - required: - - inactivity_timeout_seconds - type: object - SessionSettingsResponse: + Poll: properties: - inactivity_timeout_seconds: + Custom: + additionalProperties: {} + type: object + writeOnly: true + x-stream-index: "023" + allow_answers: + type: boolean + x-stream-index: "010" + allow_user_suggested_options: + type: boolean + x-stream-index: "009" + answers_count: format: int32 - maximum: 900 - minimum: 5 type: integer - x-stream-index: "001" - required: - - inactivity_timeout_seconds - type: object - ShadowBlockActionRequest: - type: object - SharedLocation: - properties: - channel: - $ref: '#/components/schemas/Channel' - x-stream-index: "013" - channel_cid: - type: string - x-stream-index: "003" + x-stream-index: "015" created_at: format: date-time type: number - x-stream-index: "010" - created_by_device_id: - type: string - x-stream-index: "008" - end_at: - format: date-time - type: number - x-stream-index: "009" - latitude: - format: float - maximum: 90 - minimum: 1.8446744073709552e+19 - type: number - x-stream-index: "006" - longitude: - format: float - maximum: 180 - minimum: 1.8446744073709552e+19 - type: number + x-stream-index: "021" + created_by: + $ref: '#/components/schemas/User' + x-stream-index: "020" + created_by_id: + type: string + x-stream-index: "019" + description: + type: string + x-stream-index: "005" + enforce_unique_vote: + type: boolean x-stream-index: "007" - message: - $ref: '#/components/schemas/Message' - x-stream-index: "012" - message_id: + id: + type: string + x-stream-index: "003" + is_closed: + type: boolean + x-stream-index: "011" + latest_answers: + items: + $ref: '#/components/schemas/PollVote' + type: array + x-stream-index: "017" + latest_votes_by_option: + additionalProperties: + items: + $ref: '#/components/schemas/PollVote' + type: array + type: object + x-stream-index: "016" + max_votes_allowed: + format: int32 + type: integer + x-stream-index: "008" + name: type: string x-stream-index: "004" + options: + items: + $ref: '#/components/schemas/PollOption' + type: array + x-stream-index: "013" + own_votes: + items: + $ref: '#/components/schemas/PollVote' + type: array + x-stream-index: "018" updated_at: format: date-time type: number - x-stream-index: "011" - user_id: + x-stream-index: "022" + vote_count: + format: int32 + type: integer + x-stream-index: "012" + vote_counts_by_option: + additionalProperties: + format: int32 + type: integer + type: object + x-stream-index: "014" + voting_visibility: type: string - x-stream-index: "005" + x-stream-index: "006" required: - - channel_cid - - message_id - - user_id - - created_by_device_id + - id + - name + - description + - enforce_unique_vote + - allow_user_suggested_options + - allow_answers + - vote_count + - options + - vote_counts_by_option + - answers_count + - latest_votes_by_option + - latest_answers + - own_votes + - created_by_id - created_at - updated_at + - Custom type: object - SharedLocationResponse: + PollClosedEvent: + description: Emitted when a poll is closed. nullable: true properties: - channel: - $ref: '#/components/schemas/ChannelResponse' - x-stream-index: "001.011" - channel_cid: - description: Channel CID - title: string + activity_id: type: string - x-stream-index: "001.001" + x-stream-index: "001.003" + cid: + description: The CID of the channel containing the poll + title: Channel CID + type: string + x-stream-index: 001.001.002 created_at: description: Date/time of creation format: date-time title: Created at type: number - x-stream-index: "001.008" - created_by_device_id: - description: Device ID that created the live location - title: string - type: string - x-stream-index: "001.006" - duration: - type: string - x-stream-index: "002.001" - end_at: - description: Time when the live location expires - format: date-time - title: string - type: number - x-stream-index: "001.007" - latitude: - description: Latitude coordinate - format: float - title: number - type: number - x-stream-index: "001.004" - longitude: - description: Longitude coordinate - format: float - title: number - type: number - x-stream-index: "001.005" - message: - $ref: '#/components/schemas/MessageResponse' - x-stream-index: "001.010" + x-stream-index: 001.001.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 001.001.001.007 message_id: - description: Message ID - title: string + description: The ID of the message containing the poll + title: Message ID type: string x-stream-index: "001.002" - updated_at: - description: Date/time of the last update + poll: + $ref: '#/components/schemas/PollResponseData' + description: The poll object which was closed + title: Poll + x-stream-index: "001.004" + received_at: format: date-time - title: Updated at type: number - x-stream-index: "001.009" - user_id: - description: User ID - title: string + x-stream-index: 001.001.001.004 + type: + default: poll.closed + description: 'The type of event: "poll.closed" in this case' + title: Event Type type: string - x-stream-index: "001.003" + x-stream-index: 001.001.001.002 required: - - channel_cid - - message_id - - user_id - - latitude - - longitude - - created_by_device_id + - type - created_at - - updated_at - - duration + - custom + - poll + title: PollClosedEvent type: object - SharedLocationResponseData: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + PollClosedFeedEvent: nullable: true properties: - channel: - $ref: '#/components/schemas/ChannelResponse' - x-stream-index: "011" - channel_cid: - type: string - x-stream-index: "001" created_at: format: date-time type: number - x-stream-index: "008" - created_by_device_id: + x-stream-index: 001.002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 001.002.001.007 + feed_visibility: type: string - x-stream-index: "006" - end_at: - format: date-time - type: number - x-stream-index: "007" - latitude: - format: float - type: number - x-stream-index: "004" - longitude: - format: float - type: number - x-stream-index: "005" - message: - $ref: '#/components/schemas/MessageResponse' - x-stream-index: "010" - message_id: + x-stream-index: 001.002.003 + fid: type: string - x-stream-index: "002" - updated_at: + x-stream-index: 001.002.002 + poll: + $ref: '#/components/schemas/PollResponseData' + x-stream-index: "001.001" + received_at: format: date-time type: number - x-stream-index: "009" - user_id: + x-stream-index: 001.002.001.004 + type: + default: feeds.poll.closed type: string - x-stream-index: "003" + x-stream-index: 001.002.001.002 required: - - channel_cid - - message_id - - user_id - - latitude - - longitude - - created_by_device_id + - poll + - type - created_at - - updated_at + - custom + - fid + title: PollClosedFeedEvent type: object - SharedLocationsResponse: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + PollDeletedEvent: + description: Emitted when a poll is deleted. nullable: true properties: - active_live_locations: - items: - $ref: '#/components/schemas/SharedLocationResponseData' - type: array - x-stream-index: "001" - duration: + activity_id: type: string - x-stream-index: "002.001" + x-stream-index: "001.003" + cid: + description: The CID of the channel containing the poll + title: Channel CID + type: string + x-stream-index: 001.001.002 + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 001.001.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 001.001.001.007 + message_id: + description: The ID of the message containing the poll + title: Message ID + type: string + x-stream-index: "001.002" + poll: + $ref: '#/components/schemas/PollResponseData' + description: The poll object which was deleted + title: Poll + x-stream-index: "001.004" + received_at: + format: date-time + type: number + x-stream-index: 001.001.001.004 + type: + default: poll.deleted + description: 'The type of event: "poll.deleted" in this case' + title: Event Type + type: string + x-stream-index: 001.001.001.002 required: - - active_live_locations - - duration - type: object - ShowChannelRequest: - nullable: true + - type + - created_at + - custom + - poll + title: PollDeletedEvent type: object - ShowChannelResponse: - description: Basic response information + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + PollDeletedFeedEvent: nullable: true properties: - duration: - description: Duration of the request in milliseconds - title: Duration + created_at: + format: date-time + type: number + x-stream-index: 001.002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 001.002.001.007 + feed_visibility: + type: string + x-stream-index: 001.002.003 + fid: type: string + x-stream-index: 001.002.002 + poll: + $ref: '#/components/schemas/PollResponseData' x-stream-index: "001.001" + received_at: + format: date-time + type: number + x-stream-index: 001.002.001.004 + type: + default: feeds.poll.deleted + type: string + x-stream-index: 001.002.001.002 required: - - duration - title: Response + - poll + - type + - created_at + - custom + - fid + title: PollDeletedFeedEvent type: object - SortParamRequest: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + PollOption: nullable: true properties: - direction: - description: Direction of sorting, 1 for Ascending, -1 for Descending, default - is 1 - format: int32 - title: Direction - type: integer - x-stream-index: "002" - field: - description: Name of field to sort by - title: Field + custom: + additionalProperties: {} + type: object + x-stream-index: "003" + id: + maxLength: 255 type: string x-stream-index: "001" + text: + type: string + x-stream-index: "002" + required: + - id + - text + - custom type: object - StartClosedCaptionsRequest: + PollOptionInput: nullable: true properties: - enable_transcription: - description: Enable transcriptions along with closed captions - title: Enable Transcription - type: boolean - x-stream-index: "002" - external_storage: - description: Which external storage to use for transcriptions (only applicable - if enable_transcription is true) - title: External Storage - type: string + custom: + additionalProperties: {} + type: object x-stream-index: "003" - language: - description: The spoken language in the call, if not provided the language - defined in the transcription settings will be used - enum: - - auto - - en - - fr - - es - - de - - it - - nl - - pt - - pl - - ca - - cs - - da - - el - - fi - - id - - ja - - ru - - sv - - ta - - th - - tr - - hu - - ro - - zh - - ar - - tl - - he - - hi - - hr - - ko - - ms - - "no" - - uk - - bg - - et - - sl - - sk - title: Language + text: type: string - x-stream-index: "004" + x-stream-index: "002" type: object - StartClosedCaptionsResponse: + PollOptionRequest: nullable: true properties: - duration: + custom: + additionalProperties: {} + type: object + x-stream-index: "003" + id: + maxLength: 255 type: string - x-stream-index: "001.001" - required: - - duration - type: object - StartFrameRecordingRequest: - nullable: true - properties: - recording_external_storage: + x-stream-index: "001" + text: type: string x-stream-index: "002" - title: StartFrameRecordingRequest + required: + - id type: object - StartFrameRecordingResponse: - description: StartFrameRecordingResponse is the response payload for the start - frame recording endpoint. + PollOptionResponse: nullable: true properties: duration: description: Duration of the request in milliseconds title: Duration type: string - x-stream-index: "001.001" + x-stream-index: "002.001" + poll_option: + $ref: '#/components/schemas/PollOptionResponseData' + description: Poll option + title: PollOptionResponseData + x-stream-index: "001" required: + - poll_option - duration - title: StartFrameRecordingResponse - type: object - StartHLSBroadcastingRequest: - description: StartHLSBroadcastingRequest is the payload for starting an HLS - broadcasting. - nullable: true - title: StartHLSBroadcastingRequest type: object - StartHLSBroadcastingResponse: - description: StartHLSBroadcastingResponse is the payload for starting an HLS - broadcasting. + PollOptionResponseData: nullable: true properties: - duration: + custom: + additionalProperties: {} + type: object + x-stream-index: "003" + id: type: string - x-stream-index: "001.001" - playlist_url: - description: the URL of the HLS playlist - title: PlaylistURL + x-stream-index: "001" + text: type: string x-stream-index: "002" required: - - duration - - playlist_url - title: StartHLSBroadcastingResponse - type: object - StartRTMPBroadcastsRequest: - description: StartRTMPBroadcastsRequest is the payload for starting RTMP broadcasts. - nullable: true - properties: - broadcasts: - description: List of broadcasts to start - items: - $ref: '#/components/schemas/RTMPBroadcastRequest' - maximum: 1 - minimum: 1 - title: Broadcasts - type: array - x-stream-index: "002" - required: - - broadcasts - title: StartRTMPBroadcastsRequest + - id + - text + - custom type: object - StartRTMPBroadcastsResponse: - description: StartRTMPBroadcastsResponse is the payload for starting an RTMP - broadcast. + PollResponse: nullable: true properties: duration: description: Duration of the request in milliseconds title: Duration type: string - x-stream-index: "001.001" - required: - - duration - title: StartRTMPBroadcastsResponse - type: object - StartRecordingRequest: - nullable: true - properties: - recording_external_storage: - type: string - x-stream-index: "002" - title: StartRecordingRequest - type: object - StartRecordingResponse: - description: StartRecordingResponse is the response payload for the start recording - endpoint. - nullable: true - properties: - duration: - description: Duration of the request in milliseconds - title: Duration - type: string - x-stream-index: "001.001" + x-stream-index: "002.001" + poll: + $ref: '#/components/schemas/PollResponseData' + description: Poll + title: PollResponseData + x-stream-index: "001" required: + - poll - duration - title: StartRecordingResponse type: object - StartTranscriptionRequest: - nullable: true + PollResponseData: properties: - enable_closed_captions: - description: Enable closed captions along with transcriptions - title: Enable Closed Captions + allow_answers: type: boolean - x-stream-index: "003" - language: - description: The spoken language in the call, if not provided the language - defined in the transcription settings will be used - enum: - - auto - - en - - fr - - es - - de - - it - - nl - - pt - - pl - - ca - - cs - - da - - el - - fi - - id - - ja - - ru - - sv - - ta - - th - - tr - - hu - - ro - - zh - - ar - - tl - - he - - hi - - hr - - ko - - ms - - "no" - - uk - - bg - - et - - sl - - sk - title: Language + x-stream-index: "008" + allow_user_suggested_options: + type: boolean + x-stream-index: "007" + answers_count: + format: int32 + type: integer + x-stream-index: "012" + created_at: + format: date-time + type: number + x-stream-index: "019" + created_by: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "018" + created_by_id: type: string - x-stream-index: "004" - transcription_external_storage: - description: Store transcriptions in this external storage - title: External Storage + x-stream-index: "017" + custom: + additionalProperties: {} + type: object + x-stream-index: "021" + description: type: string - x-stream-index: "002" - type: object - StartTranscriptionResponse: - nullable: true - properties: - duration: - description: Duration of the request in milliseconds - title: Duration + x-stream-index: "003" + enforce_unique_vote: + type: boolean + x-stream-index: "005" + id: type: string - x-stream-index: "001.001" - required: - - duration - title: StartTranscriptionResponse - type: object - StatsOptions: - properties: - enable_rtc_stats: + x-stream-index: "001" + is_closed: type: boolean + x-stream-index: "009" + latest_answers: + items: + $ref: '#/components/schemas/PollVoteResponseData' + type: array + x-stream-index: "015" + latest_votes_by_option: + additionalProperties: + items: + $ref: '#/components/schemas/PollVoteResponseData' + type: array + type: object + x-stream-index: "014" + max_votes_allowed: + format: int32 + type: integer + x-stream-index: "006" + name: + type: string x-stream-index: "002" - reporting_interval_ms: + options: + items: + $ref: '#/components/schemas/PollOptionResponseData' + type: array + x-stream-index: "011" + own_votes: + items: + $ref: '#/components/schemas/PollVoteResponseData' + type: array + x-stream-index: "016" + updated_at: + format: date-time + type: number + x-stream-index: "020" + vote_count: format: int32 type: integer - x-stream-index: "001" + x-stream-index: "010" + vote_counts_by_option: + additionalProperties: + format: int32 + type: integer + type: object + x-stream-index: "013" + voting_visibility: + type: string + x-stream-index: "004" required: - - reporting_interval_ms - - enable_rtc_stats - type: object - StopAllRTMPBroadcastsRequest: - nullable: true - title: StopAllRTMPBroadcastsRequest + - id + - name + - description + - voting_visibility + - enforce_unique_vote + - allow_user_suggested_options + - allow_answers + - vote_count + - options + - answers_count + - vote_counts_by_option + - latest_votes_by_option + - latest_answers + - own_votes + - created_by_id + - created_at + - updated_at + - custom type: object - StopAllRTMPBroadcastsResponse: + PollUpdatedEvent: + description: Emitted when a poll is updated. nullable: true properties: - duration: - description: Duration of the request in milliseconds - title: Duration + activity_id: type: string - x-stream-index: "001.001" + x-stream-index: "001.003" + cid: + description: The CID of the channel containing the poll + title: Channel CID + type: string + x-stream-index: 001.001.002 + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 001.001.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 001.001.001.007 + message_id: + description: The ID of the message containing the poll + title: Message ID + type: string + x-stream-index: "001.002" + poll: + $ref: '#/components/schemas/PollResponseData' + description: The poll object which was updated + title: Poll + x-stream-index: "001.004" + received_at: + format: date-time + type: number + x-stream-index: 001.001.001.004 + type: + default: poll.updated + description: 'The type of event: "poll.updated" in this case' + title: Event Type + type: string + x-stream-index: 001.001.001.002 required: - - duration - title: StopAllRTMPBroadcastsResponse + - type + - created_at + - custom + - poll + title: PollUpdatedEvent type: object - StopClosedCaptionsRequest: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + PollUpdatedFeedEvent: nullable: true properties: - stop_transcription: - type: boolean - x-stream-index: "003" - type: object - StopClosedCaptionsResponse: - description: Basic response information - nullable: true - properties: - duration: - description: Duration of the request in milliseconds - title: Duration + created_at: + format: date-time + type: number + x-stream-index: 001.002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 001.002.001.007 + feed_visibility: type: string - x-stream-index: "001.001" - required: - - duration - title: Response - type: object - StopFrameRecordingRequest: - nullable: true - type: object - StopFrameRecordingResponse: - description: Basic response information - nullable: true - properties: - duration: - description: Duration of the request in milliseconds - title: Duration + x-stream-index: 001.002.003 + fid: type: string + x-stream-index: 001.002.002 + poll: + $ref: '#/components/schemas/PollResponseData' x-stream-index: "001.001" - required: - - duration - title: Response - type: object - StopHLSBroadcastingRequest: - nullable: true - type: object - StopHLSBroadcastingResponse: - description: Basic response information - nullable: true - properties: - duration: - description: Duration of the request in milliseconds - title: Duration + received_at: + format: date-time + type: number + x-stream-index: 001.002.001.004 + type: + default: feeds.poll.updated type: string - x-stream-index: "001.001" + x-stream-index: 001.002.001.002 required: - - duration - title: Response + - poll + - type + - created_at + - custom + - fid + title: PollUpdatedFeedEvent type: object - StopLiveRequest: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + PollVote: nullable: true properties: - continue_closed_caption: - type: boolean - x-stream-index: "006" - continue_hls: - type: boolean - x-stream-index: "003" - continue_recording: - type: boolean - x-stream-index: "004" - continue_rtmp_broadcasts: - type: boolean + answer_text: + type: string x-stream-index: "007" - continue_transcription: + created_at: + format: date-time + type: number + x-stream-index: "010" + id: + type: string + x-stream-index: "004" + is_answer: type: boolean + x-stream-index: "006" + option_id: + type: string x-stream-index: "005" - title: StopLiveRequest - type: object - StopLiveResponse: - nullable: true - properties: - call: - $ref: '#/components/schemas/CallResponse' - description: The call that was stopped - title: Call - x-stream-index: "001" - duration: + poll_id: type: string - x-stream-index: "002.001" - required: - - call - - duration - title: StopLiveResponse - type: object - StopRTMPBroadcastsRequest: - description: Request for stopping RTMP broadcasts - nullable: true - title: StopRTMPBroadcastsRequest - type: object - StopRTMPBroadcastsResponse: - description: Basic response information - nullable: true - properties: - duration: - description: Duration of the request in milliseconds - title: Duration + x-stream-index: "003" + updated_at: + format: date-time + type: number + x-stream-index: "011" + user: + $ref: '#/components/schemas/User' + x-stream-index: "009" + user_id: type: string - x-stream-index: "001.001" + x-stream-index: "008" required: - - duration - title: Response - type: object - StopRecordingRequest: - nullable: true + - poll_id + - id + - option_id + - created_at + - updated_at type: object - StopRecordingResponse: - description: Basic response information + PollVoteCastedEvent: + description: Emitted when a vote is cast on a poll. nullable: true properties: - duration: - description: Duration of the request in milliseconds - title: Duration + activity_id: type: string - x-stream-index: "001.001" + x-stream-index: 001.001.003 + cid: + description: The CID of the channel containing the poll + 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: number + x-stream-index: 001.001.001.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 001.001.001.001.007 + message_id: + description: The ID of the message containing the poll + title: Message ID + type: string + x-stream-index: 001.001.002 + poll: + $ref: '#/components/schemas/PollResponseData' + description: The poll object + title: Poll + x-stream-index: 001.001.004 + poll_vote: + $ref: '#/components/schemas/PollVoteResponseData' + description: The vote that was cast + title: Poll Vote + x-stream-index: "001.002" + received_at: + format: date-time + type: number + x-stream-index: 001.001.001.001.004 + type: + default: poll.vote_casted + description: 'The type of event: "poll.vote_casted" in this case' + title: Event Type + type: string + x-stream-index: 001.001.001.001.002 required: - - duration - title: Response - type: object - StopTranscriptionRequest: - nullable: true - properties: - stop_closed_captions: - type: boolean - x-stream-index: "003" + - type + - created_at + - custom + - poll + - poll_vote + title: PollVoteCastedEvent type: object - StopTranscriptionResponse: - description: Basic response information + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + PollVoteCastedFeedEvent: nullable: true properties: - duration: - description: Duration of the request in milliseconds - title: Duration + created_at: + format: date-time + type: number + x-stream-index: 001.001.002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 001.001.002.001.007 + feed_visibility: type: string - x-stream-index: "001.001" + x-stream-index: 001.001.002.003 + fid: + type: string + x-stream-index: 001.001.002.002 + poll: + $ref: '#/components/schemas/PollResponseData' + x-stream-index: 001.001.001 + poll_vote: + $ref: '#/components/schemas/PollVoteResponseData' + x-stream-index: "001.002" + received_at: + format: date-time + type: number + x-stream-index: 001.001.002.001.004 + type: + default: feeds.poll.vote_casted + type: string + x-stream-index: 001.001.002.001.002 required: - - duration - title: Response + - poll + - type + - created_at + - custom + - fid + - poll_vote + title: PollVoteCastedFeedEvent type: object - SubmitActionRequest: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + PollVoteChangedEvent: + description: Emitted when a vote on a poll is changed. nullable: true properties: - action_type: - description: Type of moderation action to perform (mark_reviewed, delete_message, - etc.) - enum: - - mark_reviewed - - delete_message - - delete_activity - - delete_reaction - - ban - - custom - - unban - - restore - - delete_user - - unblock - - shadow_block - - unmask - - kick_user - - end_call - title: Action Type + activity_id: type: string - x-stream-index: "002" - ban: - $ref: '#/components/schemas/BanActionRequest' - description: Configuration for ban action - title: Ban - x-stream-index: "008" + x-stream-index: 001.001.003 + cid: + description: The CID of the channel containing the poll + 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: number + x-stream-index: 001.001.001.001.003 custom: - $ref: '#/components/schemas/CustomActionRequest' - description: Configuration for custom action - title: Custom - x-stream-index: "009" - delete_activity: - $ref: '#/components/schemas/DeleteActivityRequest' - description: Configuration for activity deletion action - title: Delete Activity - x-stream-index: "004" - delete_message: - $ref: '#/components/schemas/DeleteMessageRequest' - description: Configuration for message deletion action - title: Delete Message - x-stream-index: "003" - delete_reaction: - $ref: '#/components/schemas/DeleteReactionRequest' - description: Configuration for reaction deletion action - title: Delete Reaction - x-stream-index: "005" - delete_user: - $ref: '#/components/schemas/DeleteUserRequest' - description: Configuration for user deletion action - title: Delete User - x-stream-index: "006" - item_id: - description: UUID of the review queue item to act on - title: Item ID + additionalProperties: {} + type: object + x-stream-index: 001.001.001.001.007 + message_id: + description: The ID of the message containing the poll + title: Message ID type: string - x-stream-index: "001" - mark_reviewed: - $ref: '#/components/schemas/MarkReviewedRequest' - description: Configuration for marking item as reviewed - title: Mark Reviewed - x-stream-index: "007" - unban: - $ref: '#/components/schemas/UnbanActionRequest' - description: Configuration for unban action - title: Unban - x-stream-index: "010" + x-stream-index: 001.001.002 + poll: + $ref: '#/components/schemas/PollResponseData' + description: The poll object + title: Poll + x-stream-index: 001.001.004 + poll_vote: + $ref: '#/components/schemas/PollVoteResponseData' + description: The updated vote + title: Poll Vote + x-stream-index: "001.002" + received_at: + format: date-time + type: number + x-stream-index: 001.001.001.001.004 + type: + default: poll.vote_changed + description: 'The type of event: "poll.vote_changed" in this case' + title: Event Type + type: string + x-stream-index: 001.001.001.001.002 required: - - item_id - - action_type + - type + - created_at + - custom + - poll + - poll_vote + title: PollVoteChangedEvent type: object - SubmitActionResponse: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + PollVoteChangedFeedEvent: nullable: true properties: - duration: + created_at: + format: date-time + type: number + x-stream-index: 001.001.002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 001.001.002.001.007 + feed_visibility: type: string - x-stream-index: "002.001" - item: - $ref: '#/components/schemas/ReviewQueueItemResponse' - description: Updated review queue item after action was performed - title: Item - x-stream-index: "001" - required: - - duration - type: object - SubscriberStatsResponse: - properties: - total: - format: int32 - type: integer - x-stream-index: "001" - total_subscribed_duration_seconds: - format: int32 - type: integer - x-stream-index: "003" - unique: - format: int32 - type: integer - x-stream-index: "002" + x-stream-index: 001.001.002.003 + fid: + type: string + x-stream-index: 001.001.002.002 + poll: + $ref: '#/components/schemas/PollResponseData' + x-stream-index: 001.001.001 + poll_vote: + $ref: '#/components/schemas/PollVoteResponseData' + x-stream-index: "001.002" + received_at: + format: date-time + type: number + x-stream-index: 001.001.002.001.004 + type: + default: feeds.poll.vote_changed + type: string + x-stream-index: 001.001.002.001.002 required: - - total - - unique - - total_subscribed_duration_seconds + - poll + - type + - created_at + - custom + - fid + - poll_vote + title: PollVoteChangedFeedEvent type: object - SyncRequest: - description: Sync request + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + PollVoteRemovedEvent: + description: Emitted when a vote is removed from a poll. nullable: true properties: - channel_cids: - description: List of channel CIDs to sync - items: - type: string - maximum: 255 - minimum: 1 - title: Channel CIDs - type: array - x-stream-index: "001" - last_sync_at: - description: Date from which synchronization should happen + activity_id: + type: string + x-stream-index: 001.001.003 + cid: + description: The CID of the channel containing the poll + title: Channel CID + type: string + x-stream-index: 001.001.001.002 + created_at: + description: Date/time of creation format: date-time - title: Last sync at + title: Created at type: number - x-stream-index: "002" + x-stream-index: 001.001.001.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 001.001.001.001.007 + message_id: + description: The ID of the message containing the poll + title: Message ID + type: string + x-stream-index: 001.001.002 + poll: + $ref: '#/components/schemas/PollResponseData' + description: The poll object + title: Poll + x-stream-index: 001.001.004 + poll_vote: + $ref: '#/components/schemas/PollVoteResponseData' + description: The vote that was removed + title: Poll Vote + x-stream-index: "001.002" + received_at: + format: date-time + type: number + x-stream-index: 001.001.001.001.004 + type: + default: poll.vote_removed + description: 'The type of event: "poll.vote_removed" in this case' + title: Event Type + type: string + x-stream-index: 001.001.001.001.002 required: - - channel_cids - - last_sync_at - title: SyncRequest + - type + - created_at + - custom + - poll + - poll_vote + title: PollVoteRemovedEvent type: object - SyncResponse: - description: Sync response + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + PollVoteRemovedFeedEvent: nullable: true properties: - duration: - description: Duration of the request in milliseconds - title: Duration + created_at: + format: date-time + type: number + x-stream-index: 001.001.002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 001.001.002.001.007 + feed_visibility: type: string - x-stream-index: "003.001" - events: - description: List of events - items: - $ref: '#/components/schemas/WSEvent' - title: Events - type: array - x-stream-index: "001" - inaccessible_cids: - description: List of CIDs that user can't access - items: - type: string - title: Inaccessible CIDs - type: array - x-stream-index: "002" + x-stream-index: 001.001.002.003 + fid: + type: string + x-stream-index: 001.001.002.002 + poll: + $ref: '#/components/schemas/PollResponseData' + x-stream-index: 001.001.001 + poll_vote: + $ref: '#/components/schemas/PollVoteResponseData' + x-stream-index: "001.002" + received_at: + format: date-time + type: number + x-stream-index: 001.001.002.001.004 + type: + default: feeds.poll.vote_removed + type: string + x-stream-index: 001.001.002.001.002 + required: + - poll + - type + - created_at + - custom + - fid + - poll_vote + title: PollVoteRemovedFeedEvent + 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 + PollVoteResponse: + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "002.001" + vote: + $ref: '#/components/schemas/PollVoteResponseData' + description: Poll vote + title: PollVoteResponseData + x-stream-index: "001" required: - - events - duration - title: SyncResponse type: object - TargetResolution: + PollVoteResponseData: + nullable: true properties: - bitrate: - format: int32 - maximum: 6000000 - type: integer - x-stream-index: "003" - height: - format: int32 - maximum: 3840 - minimum: 240 - type: integer + answer_text: + type: string + x-stream-index: "005" + created_at: + format: date-time + type: number + x-stream-index: "008" + id: + type: string x-stream-index: "002" - width: - format: int32 - maximum: 3840 - minimum: 240 - type: integer + is_answer: + type: boolean + x-stream-index: "004" + option_id: + type: string + x-stream-index: "003" + poll_id: + type: string x-stream-index: "001" + updated_at: + format: date-time + type: number + x-stream-index: "009" + user: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "007" + user_id: + type: string + x-stream-index: "006" required: - - width - - height + - poll_id + - id + - option_id + - created_at + - updated_at type: object - TextContentParameters: + PollVotesResponse: + nullable: true properties: - blocklist_match: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "003.001" + next: + type: string + x-stream-index: "002.001" + prev: + type: string + x-stream-index: "002.002" + votes: + description: Poll votes items: - type: string + $ref: '#/components/schemas/PollVoteResponseData' + title: PollVoteResponseList type: array - x-stream-index: "004" - contains_url: - type: boolean + x-stream-index: "001" + required: + - votes + - duration + type: object + PrivacySettings: + properties: + read_receipts: + $ref: '#/components/schemas/ReadReceipts' x-stream-index: "002" - harm_labels: - items: - type: string - type: array + typing_indicators: + $ref: '#/components/schemas/TypingIndicators' x-stream-index: "001" - severity: - type: string - x-stream-index: "003" type: object - TextRuleParameters: + PrivacySettingsResponse: properties: - blocklist_match: - items: - type: string - type: array - x-stream-index: "006" - contains_url: - type: boolean - x-stream-index: "004" - harm_labels: + read_receipts: + $ref: '#/components/schemas/ReadReceiptsResponse' + x-stream-index: "002" + typing_indicators: + $ref: '#/components/schemas/TypingIndicatorsResponse' + x-stream-index: "001" + type: object + PublisherStatsResponse: + properties: + by_track: items: - type: string + $ref: '#/components/schemas/TrackStatsResponse' type: array x-stream-index: "003" - severity: - type: string - x-stream-index: "005" - threshold: + total: format: int32 type: integer x-stream-index: "001" - time_window: - type: string + unique: + format: int32 + type: integer x-stream-index: "002" required: - - threshold - - time_window + - total + - unique type: object - ThreadParticipant: - description: Represents a user that is participating in a thread. - nullable: true + PushNotificationConfig: properties: - app_pk: - format: int32 - readOnly: true - type: integer + activity_types: + items: + type: string + type: array + x-stream-index: "002" + enabled: + type: boolean x-stream-index: "001" + type: object + PushPreferenceInput: + nullable: true + properties: + call_level: + description: Set the level of call push notifications for the user. One + of all, none, default + enum: + - all + - none + - default + type: string + x-stream-index: "004" channel_cid: + description: Set the push preferences for a specific channel. If empty it + sets the default for the user type: string x-stream-index: "002" - created_at: - description: Date/time of creation - format: date-time - title: Created at - type: number - x-stream-index: "007" - custom: - additionalProperties: {} - type: object - x-stream-index: "010" - last_read_at: - format: date-time - type: number - x-stream-index: "009" - last_thread_message_at: - format: date-time - type: number + chat_level: + description: Set the level of chat push notifications for the user. One + of all, mentions, none, default + enum: + - all + - mentions + - none + - default + type: string x-stream-index: "003" - left_thread_at: - description: Left Thread At is the time when the user left the thread + disabled_until: + description: Disable push notifications till a certain time format: date-time - title: Left Thread At type: number - x-stream-index: "008" - thread_id: - description: Thead ID is unique string identifier of the thread - title: ID - type: string - x-stream-index: "004" - user: - $ref: '#/components/schemas/UserResponse' - description: User is the user object - title: User + x-stream-index: "007" + feeds_events: + $ref: '#/components/schemas/FeedsEventPreferencesInput' + description: Set granular feeds event preferences for reactions, comments, + new followers, and mentions x-stream-index: "006" - user_id: - description: User ID is unique string identifier of the user - title: User ID + feeds_level: + description: Set the level of feeds push notifications for the user. One + of all, none, default + enum: + - all + - none + - default type: string x-stream-index: "005" - required: - - app_pk - - channel_cid - - created_at - - last_read_at - - custom - title: ThreadParticipant - type: object - ThreadResponse: - properties: - active_participant_count: - description: Active Participant Count - format: int32 - title: Active Participant Count - type: integer - x-stream-index: "009" - channel: - $ref: '#/components/schemas/ChannelResponse' - description: Channel - title: ChannelResponse + remove_disable: + description: Remove the disabled until time. (IE stop snoozing notifications) + type: boolean + x-stream-index: "008" + user_id: + description: The user id for which to set the push preferences. Required + when using server side auths, defaults to current user with client side + auth. + type: string + x-stream-index: "001" + type: object + PushPreferences: + properties: + call_level: + type: string x-stream-index: "002" - channel_cid: - description: Channel CID - title: Channel CID + chat_level: type: string x-stream-index: "001" - created_at: - description: Date/time of creation + disabled_until: format: date-time - title: Created at type: number - x-stream-index: "012" - created_by: - $ref: '#/components/schemas/UserResponse' - description: Created By User - title: User - x-stream-index: "006" - created_by_user_id: - description: Created By User ID - title: Created By User ID - type: string x-stream-index: "005" - custom: - additionalProperties: {} - description: Custom data for this object - title: Custom data - type: object - x-stream-index: "016" - deleted_at: - description: Deleted At - format: date-time - title: Deleted At - type: number - x-stream-index: "014" - last_message_at: - description: Last Message At - format: date-time - title: Last Message At - type: number - x-stream-index: "011" - parent_message: - $ref: '#/components/schemas/MessageResponse' - description: Parent Message - title: Message + feeds_events: + $ref: '#/components/schemas/FeedsEventPreferences' x-stream-index: "004" - parent_message_id: - description: Parent Message ID - title: Parent Message ID + feeds_level: type: string x-stream-index: "003" - participant_count: - description: Participant Count + type: object + Quality: + properties: + bitdepth: + format: int32 + type: integer + x-stream-index: "007" + framerate: format: int32 - title: Participant Count type: integer x-stream-index: "008" - reply_count: - description: Reply Count + height: format: int32 - title: Reply Count type: integer - x-stream-index: "007" - thread_participants: - description: Thread Participants + x-stream-index: "006" + name: + type: string + x-stream-index: "004" + video_bitrate: + format: int32 + type: integer + x-stream-index: "009" + width: + format: int32 + type: integer + x-stream-index: "005" + type: object + QualityScoreReport: + properties: + histogram: items: - $ref: '#/components/schemas/ThreadParticipant' - title: ThreadParticipants + $ref: '#/components/schemas/ReportByHistogramBucket' type: array - x-stream-index: "010" - title: - description: Title - title: Title - type: string - x-stream-index: "015" - updated_at: - description: Date/time of the last update - format: date-time - title: Updated at - type: number - x-stream-index: "013" + x-stream-index: "001" required: - - channel_cid - - parent_message_id - - created_by_user_id - - created_at - - updated_at - - title - - custom + - histogram type: object - ThreadStateResponse: + QualityScoreReportResponse: + properties: + daily: + items: + $ref: '#/components/schemas/DailyAggregateQualityScoreReportResponse' + type: array + x-stream-index: "001" + required: + - daily + type: object + QueryActivitiesRequest: nullable: true properties: - active_participant_count: - description: Active Participant Count + filter: + additionalProperties: {} + description: Filters to apply to the query. Supports location-based queries + with 'near' and 'within_bounds' operators. + title: Filter + type: object + x-stream-index: "001" + limit: format: int32 - title: Active Participant Count + maximum: 100 + minimum: 0 type: integer - x-stream-index: "001.009" - channel: - $ref: '#/components/schemas/ChannelResponse' - description: Channel - title: ChannelResponse - x-stream-index: "001.002" - channel_cid: - description: Channel CID - title: Channel CID + x-stream-index: "003.001" + next: type: string - x-stream-index: "001.001" - created_at: - description: Date/time of creation - format: date-time - title: Created at - type: number - x-stream-index: "001.012" - created_by: - $ref: '#/components/schemas/UserResponse' - description: Created By User - title: User - x-stream-index: "001.006" - created_by_user_id: - description: Created By User ID - title: Created By User ID + x-stream-index: "003.002" + prev: type: string - x-stream-index: "001.005" - custom: - additionalProperties: {} - description: Custom data for this object - title: Custom data - type: object - x-stream-index: "001.016" - deleted_at: - description: Deleted At - format: date-time - title: Deleted At - type: number - x-stream-index: "001.014" - draft: - $ref: '#/components/schemas/DraftResponse' - x-stream-index: "004" - last_message_at: - description: Last Message At - format: date-time - title: Last Message At - type: number - x-stream-index: "001.011" - latest_replies: + x-stream-index: "003.003" + sort: + description: Sorting parameters for the query items: - $ref: '#/components/schemas/MessageResponse' + $ref: '#/components/schemas/SortParamRequest' + maximum: 5 + title: Sort type: array x-stream-index: "002" - parent_message: - $ref: '#/components/schemas/MessageResponse' - description: Parent Message - title: Message - x-stream-index: "001.004" - parent_message_id: - description: Parent Message ID - title: Parent Message ID - type: string - x-stream-index: "001.003" - participant_count: - description: Participant Count - format: int32 - title: Participant Count - type: integer - x-stream-index: "001.008" - read: + title: Query Activities Request + type: object + QueryActivitiesResponse: + nullable: true + properties: + activities: + description: List of activities matching the query items: - $ref: '#/components/schemas/ReadStateResponse' + $ref: '#/components/schemas/ActivityResponse' + title: Activities type: array - x-stream-index: "003" - reply_count: - description: Reply Count + x-stream-index: "001" + duration: + type: string + x-stream-index: "003.001" + next: + description: Cursor for next page + title: Next + type: string + x-stream-index: "002.001" + prev: + description: Cursor for previous page + title: Previous + type: string + x-stream-index: "002.002" + required: + - activities + - duration + title: Query Activities Response + type: object + QueryActivityReactionsRequest: + nullable: true + properties: + filter: + additionalProperties: {} + type: object + x-stream-index: "002" + limit: format: int32 - title: Reply Count + maximum: 100 + minimum: 0 type: integer - x-stream-index: "001.007" - thread_participants: - description: Thread Participants + x-stream-index: "004.001" + next: + type: string + x-stream-index: "004.002" + prev: + type: string + x-stream-index: "004.003" + sort: items: - $ref: '#/components/schemas/ThreadParticipant' - title: ThreadParticipants + $ref: '#/components/schemas/SortParamRequest' + maximum: 5 type: array - x-stream-index: "001.010" - title: - description: Title - title: Title - type: string - x-stream-index: "001.015" - updated_at: - description: Date/time of the last update - format: date-time - title: Updated at - type: number - x-stream-index: "001.013" - required: - - channel_cid - - parent_message_id - - created_by_user_id - - created_at - - updated_at - - title - - custom - - latest_replies + x-stream-index: "003" type: object - ThreadUpdatedEvent: + QueryActivityReactionsResponse: + description: Basic response information + nullable: true properties: - channel_id: - type: string - x-stream-index: "001.002" - channel_type: - type: string - x-stream-index: "001.003" - cid: + duration: + description: Duration of the request in milliseconds + title: Duration type: string - x-stream-index: "001.001" - created_at: - format: date-time - type: number - x-stream-index: "004.002" - thread: - $ref: '#/components/schemas/ThreadResponse' x-stream-index: "003.001" - type: - default: thread.updated + next: type: string - x-stream-index: "004.001" - user: - $ref: '#/components/schemas/User' x-stream-index: "002.001" + prev: + type: string + x-stream-index: "002.002" + reactions: + items: + $ref: '#/components/schemas/FeedsReactionResponse' + type: array + x-stream-index: "001" required: - - cid - - channel_id - - channel_type - - type - - created_at - title: ThreadUpdatedEvent + - reactions + - duration + title: Response 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 - Thresholds: - description: Sets thresholds for AI moderation + QueryAggregateCallStatsRequest: + nullable: true properties: - explicit: - $ref: '#/components/schemas/LabelThresholds' - description: Thresholds for explicit messages - title: LabelThresholds - x-stream-index: "001" - spam: - $ref: '#/components/schemas/LabelThresholds' - description: Thresholds for spam - title: LabelThresholds + from: + type: string x-stream-index: "002" - toxic: - $ref: '#/components/schemas/LabelThresholds' - description: Thresholds for toxic messages - title: LabelThresholds + report_types: + items: + type: string + type: array + x-stream-index: "004" + to: + type: string x-stream-index: "003" - title: Auto moderation thresholds type: object - ThumbnailResponse: + QueryAggregateCallStatsResponse: + description: Basic response information + nullable: true properties: - image_url: + call_duration_report: + $ref: '#/components/schemas/CallDurationReportResponse' + x-stream-index: "002" + call_participant_count_report: + $ref: '#/components/schemas/CallParticipantCountReportResponse' + x-stream-index: "004" + calls_per_day_report: + $ref: '#/components/schemas/CallsPerDayReportResponse' + x-stream-index: "003" + duration: + description: Duration of the request in milliseconds + title: Duration type: string - x-stream-index: "001" + x-stream-index: "001.001" + network_metrics_report: + $ref: '#/components/schemas/NetworkMetricsReportResponse' + x-stream-index: "008" + quality_score_report: + $ref: '#/components/schemas/QualityScoreReportResponse' + x-stream-index: "005" + sdk_usage_report: + $ref: '#/components/schemas/SDKUsageReportResponse' + x-stream-index: "006" + user_feedback_report: + $ref: '#/components/schemas/UserFeedbackReportResponse' + x-stream-index: "007" required: - - image_url + - duration + title: Response type: object - ThumbnailsSettings: + QueryBannedUsersPayload: properties: - enabled: + exclude_expired_bans: + description: Whether to exclude expired bans or not + title: Exclude expired bans type: boolean + x-stream-index: "004" + filter_conditions: + additionalProperties: {} + type: object x-stream-index: "001" + limit: + description: Number of records to return + format: int32 + maximum: 300 + minimum: 0 + title: Limit + type: integer + x-stream-index: "003.003" + offset: + description: Number of records to offset + format: int32 + maximum: 10000 + title: Offset + type: integer + x-stream-index: "003.004" + sort: + description: Array of sort parameters + items: + $ref: '#/components/schemas/SortParamRequest' + maximum: 1 + title: Sort + type: array + x-stream-index: "002" required: - - enabled - type: object - ThumbnailsSettingsRequest: - properties: - enabled: - type: boolean - x-stream-index: "001" + - filter_conditions type: object - ThumbnailsSettingsResponse: + QueryBannedUsersResponse: + nullable: true properties: - enabled: - type: boolean + bans: + description: List of found bans + items: + $ref: '#/components/schemas/BanResponse' + title: BanResponse + type: array x-stream-index: "001" + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "002.001" required: - - enabled - type: object - Time: + - bans + - duration type: object - TrackStatsResponse: + QueryBookmarkFoldersRequest: nullable: true properties: - duration_seconds: + filter: + additionalProperties: {} + description: Filters to apply to the query + title: Filter + type: object + x-stream-index: "001" + limit: format: int32 + maximum: 100 + minimum: 0 type: integer - x-stream-index: "002" - track_type: + x-stream-index: "003.001" + next: + type: string + x-stream-index: "003.002" + prev: type: string + x-stream-index: "003.003" + sort: + description: Sorting parameters for the query + items: + $ref: '#/components/schemas/SortParamRequest' + title: Sort + type: array + x-stream-index: "002" + title: Query Bookmark Folders Request + type: object + QueryBookmarkFoldersResponse: + nullable: true + properties: + bookmark_folders: + description: List of bookmark folders matching the query + items: + $ref: '#/components/schemas/BookmarkFolderResponse' + title: Bookmark Folders + type: array x-stream-index: "001" + duration: + type: string + x-stream-index: "003.001" + next: + description: Cursor for next page + title: Next + type: string + x-stream-index: "002.001" + prev: + description: Cursor for previous page + title: Previous + type: string + x-stream-index: "002.002" required: - - track_type - - duration_seconds + - bookmark_folders + - duration + title: Query Bookmark Folders Response type: object - TranscriptionSettings: + QueryBookmarksRequest: + nullable: true properties: - closed_caption_mode: - enum: - - available - - disabled - - auto-on - title: Mode - type: string - x-stream-index: "002" - language: - description: The language used in this call as a two letter code - enum: - - auto - - en - - fr - - es - - de - - it - - nl - - pt - - pl - - ca - - cs - - da - - el - - fi - - id - - ja - - ru - - sv - - ta - - th - - tr - - hu - - ro - - zh - - ar - - tl - - he - - hi - - hr - - ko - - ms - - "no" - - uk - - bg - - et - - sl - - sk - title: Language + filter: + additionalProperties: {} + description: Filters to apply to the query + title: Filter + type: object + x-stream-index: "001" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "003.001" + next: type: string - x-stream-index: "004" - mode: - enum: - - available - - disabled - - auto-on - title: Mode + x-stream-index: "003.002" + prev: type: string + x-stream-index: "003.003" + sort: + description: Sorting parameters for the query + items: + $ref: '#/components/schemas/SortParamRequest' + maximum: 5 + title: Sort + type: array + x-stream-index: "002" + title: Query Bookmarks Request + type: object + QueryBookmarksResponse: + nullable: true + properties: + bookmarks: + description: List of bookmarks matching the query + items: + $ref: '#/components/schemas/BookmarkResponse' + title: Bookmarks + type: array x-stream-index: "001" + duration: + type: string + x-stream-index: "003.001" + next: + description: Cursor for next page + title: Next + type: string + x-stream-index: "002.001" + prev: + description: Cursor for previous page + title: Previous + type: string + x-stream-index: "002.002" required: - - mode - - closed_caption_mode - - languages - - language + - bookmarks + - duration + title: Query Bookmarks Response type: object - TranscriptionSettingsRequest: + QueryCallMembersRequest: + nullable: true properties: - closed_caption_mode: - enum: - - available - - disabled - - auto-on - type: string + filter_conditions: + additionalProperties: {} + type: object x-stream-index: "002" - language: - enum: - - auto - - en - - fr - - es - - de - - it - - nl - - pt - - pl - - ca - - cs - - da - - el - - fi - - id - - ja - - ru - - sv - - ta - - th - - tr - - hu - - ro - - zh - - ar - - tl - - he - - hi - - hr - - ko - - ms - - "no" - - uk - - bg - - et - - sl - - sk + id: + maxLength: 64 type: string - x-stream-index: "004" - mode: - enum: - - available - - disabled - - auto-on + x-stream-index: "001.002" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "004.001" + next: type: string - x-stream-index: "001" + x-stream-index: "004.002" + prev: + type: string + x-stream-index: "004.003" + sort: + items: + $ref: '#/components/schemas/SortParamRequest' + maximum: 1 + type: array + x-stream-index: "003" + type: + maxLength: 64 + type: string + x-stream-index: "001.001" required: - - mode + - type + - id type: object - TranscriptionSettingsResponse: + QueryCallMembersResponse: + description: Basic response information + nullable: true properties: - closed_caption_mode: - enum: - - available - - disabled - - auto-on + duration: + description: Duration of the request in milliseconds + title: Duration type: string - x-stream-index: "002" - language: - enum: - - auto - - en - - fr - - es - - de - - it - - nl - - pt - - pl - - ca - - cs - - da - - el - - fi - - id - - ja - - ru - - sv - - ta - - th - - tr - - hu - - ro - - zh - - ar - - tl - - he - - hi - - hr - - ko - - ms - - "no" - - uk - - bg - - et - - sl - - sk + x-stream-index: "003.001" + members: + items: + $ref: '#/components/schemas/MemberResponse' + type: array + x-stream-index: "001" + next: type: string - x-stream-index: "004" - mode: - enum: - - available - - disabled - - auto-on + x-stream-index: "002.001" + prev: type: string - x-stream-index: "001" + x-stream-index: "002.002" required: - - mode - - closed_caption_mode - - languages - - language + - members + - duration + title: Response type: object - TranslateMessageRequest: + QueryCallParticipantsRequest: nullable: true properties: - language: - description: Language to translate message to - enum: - - af - - sq - - am - - ar - - az - - bn - - bs - - bg - - zh - - zh-TW - - hr - - cs - - da - - fa-AF - - nl - - en - - et - - fi - - fr - - fr-CA - - ka - - de - - el - - ha - - he - - hi - - hu - - id - - it - - ja - - ko - - lv - - ms - - "no" - - fa - - ps - - pl - - pt - - ro - - ru - - sr - - sk - - sl - - so - - es - - es-MX - - sw - - sv - - tl - - ta - - th - - tr - - uk - - ur - - vi - - lt - - ht - title: Language + filter_conditions: + additionalProperties: {} + type: object + x-stream-index: "003" + type: object + QueryCallParticipantsResponse: + nullable: true + properties: + call: + $ref: '#/components/schemas/CallResponse' + x-stream-index: "001.001" + duration: type: string - x-stream-index: "001" + x-stream-index: "004.001" + members: + items: + $ref: '#/components/schemas/MemberResponse' + type: array + x-stream-index: "001.002" + membership: + $ref: '#/components/schemas/MemberResponse' + x-stream-index: "001.003" + own_capabilities: + items: + $ref: '#/components/schemas/OwnCapability' + type: array + x-stream-index: "001.004" + participants: + description: List of call participants + items: + $ref: '#/components/schemas/CallParticipantResponse' + title: '[]CallParticipantResponse' + type: array + x-stream-index: "002" + total_participants: + format: int32 + type: integer + x-stream-index: "003" required: - - language + - call + - members + - own_capabilities + - blocked_users + - participants + - total_participants + - duration type: object - TruncateChannelRequest: + QueryCallStatsRequest: nullable: true properties: - hard_delete: - description: Permanently delete channel data (messages, reactions, etc.) - title: Hard delete - type: boolean - x-stream-index: "002" - member_ids: - description: List of member IDs to hide message history for. If empty, truncates - the channel for all members - items: - type: string + filter_conditions: + additionalProperties: {} + type: object + x-stream-index: "001" + limit: + format: int32 maximum: 100 - title: Member IDs + minimum: 0 + type: integer + x-stream-index: "004.001" + next: + type: string + x-stream-index: "004.002" + prev: + type: string + x-stream-index: "004.003" + sort: + items: + $ref: '#/components/schemas/SortParamRequest' + maximum: 2 type: array - x-stream-index: "007" - message: - $ref: '#/components/schemas/MessageRequest' - x-stream-index: "004" - skip_push: - description: When `message` is set disables all push notifications for it - title: Skip push - type: boolean - x-stream-index: "005" - truncated_at: - description: Truncate channel data up to `truncated_at`. The system message - (if provided) creation time is always greater than `truncated_at` - format: date-time - title: Truncated at - type: number - x-stream-index: "006" + x-stream-index: "002" type: object - TruncateChannelResponse: + QueryCallStatsResponse: + description: Basic response information nullable: true properties: - channel: - $ref: '#/components/schemas/ChannelResponse' - description: Truncated channel object - title: Channel - x-stream-index: "002" duration: description: Duration of the request in milliseconds title: Duration type: string - x-stream-index: "001.001" - message: - $ref: '#/components/schemas/MessageResponse' - description: Truncated message object - title: Message - x-stream-index: "003" + x-stream-index: "002.001" + next: + type: string + x-stream-index: "003.001" + prev: + type: string + x-stream-index: "003.002" + reports: + items: + $ref: '#/components/schemas/CallStatsReportSummaryResponse' + type: array + x-stream-index: "001" required: + - reports - duration + title: Response type: object - TypingIndicators: + QueryCallsRequest: + nullable: true properties: - enabled: + filter_conditions: + additionalProperties: {} + title: Filters + type: object + x-stream-index: "003" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "006.001" + next: + type: string + x-stream-index: "006.002" + prev: + type: string + x-stream-index: "006.003" + sort: + description: Array of sort parameters + items: + $ref: '#/components/schemas/SortParamRequest' + maximum: 2 + title: Sort + type: array + x-stream-index: "004" + watch: + title: Watch type: boolean x-stream-index: "001" - required: - - enabled + title: QueryCallsRequest type: object - TypingIndicatorsResponse: + QueryCallsResponse: + nullable: true properties: - enabled: - type: boolean + calls: + items: + $ref: '#/components/schemas/CallStateResponseFields' + title: Calls + type: array x-stream-index: "001" - required: - - enabled - type: object - TypingStartEvent: - properties: - channel_id: - type: string - x-stream-index: "003.002" - channel_type: - type: string - x-stream-index: "003.003" - cid: + duration: + description: Duration of the request in milliseconds + title: Duration type: string x-stream-index: "003.001" - created_at: - format: date-time - type: number - x-stream-index: "004.002" - parent_id: - type: string - x-stream-index: "001" - type: - default: typing.start + next: type: string - x-stream-index: "004.001" - user: - $ref: '#/components/schemas/User' x-stream-index: "002.001" - required: - - cid - - channel_id - - channel_type - - type - - created_at - title: TypingStartEvent - 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 - TypingStopEvent: - properties: - channel_id: + prev: type: string x-stream-index: "002.002" - channel_type: - type: string - x-stream-index: "002.003" - cid: - type: string - x-stream-index: "002.001" - created_at: - format: date-time - type: number - x-stream-index: "004.002" - parent_id: - type: string - x-stream-index: "001" - type: - default: typing.stop - type: string - x-stream-index: "004.001" - user: - $ref: '#/components/schemas/User' - x-stream-index: "003.001" - required: - - cid - - channel_id - - channel_type - - type - - created_at - title: TypingStopEvent - 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 - UnbanActionRequest: - type: object - UnblockActionRequest: - type: object - UnblockUserRequest: - description: UnblockUserRequest is the payload for unblocking a user. - nullable: true - properties: - user_id: - description: the user to unblock - title: UserID - type: string - x-stream-index: "003" - required: - - user_id - title: UnblockUserRequest - type: object - UnblockUserResponse: - description: UnblockUserResponse is the payload for unblocking a user. - nullable: true - properties: - duration: - description: Duration of the request in milliseconds - title: Duration - type: string - x-stream-index: "001.001" required: + - calls - duration - title: UnblockUserResponse + title: QueryCallsResponse type: object - UnblockUsersRequest: + QueryChannelsRequest: nullable: true properties: - blocked_user_id: - type: string + filter_conditions: + additionalProperties: {} + type: object x-stream-index: "001" - required: - - blocked_user_id + limit: + description: Number of channels to limit + format: int32 + title: Limit + type: integer + x-stream-index: "008" + member_limit: + description: Number of members to limit + format: int32 + maximum: 100 + minimum: 0 + title: Member limit + type: integer + x-stream-index: "007" + message_limit: + description: Number of messages to limit + format: int32 + minimum: 0 + title: Message limit + type: integer + x-stream-index: "006" + offset: + description: Channel pagination offset + format: int32 + title: Offset + type: integer + x-stream-index: "009" + presence: + title: Presence + type: boolean + x-stream-index: "005" + sort: + description: List of sort parameters + items: + $ref: '#/components/schemas/SortParamRequest' + maximum: 5 + title: Sort + type: array + x-stream-index: "002" + state: + description: Whether to update channel state or not + title: State + type: boolean + x-stream-index: "004" + watch: + description: Whether to start watching found channels or not + title: Watch + type: boolean + x-stream-index: "003" + title: Query Channels Request type: object - UnblockUsersResponse: + x-stream-docs-page-id: query_channels + QueryChannelsResponse: nullable: true properties: + channels: + description: List of channels + items: + $ref: '#/components/schemas/ChannelStateResponseFields' + title: Channels + type: array + x-stream-index: "001" duration: description: Duration of the request in milliseconds title: Duration type: string - x-stream-index: "001.001" + x-stream-index: "002.001" required: + - channels - duration + title: Channels list type: object - UnblockedUserEvent: - description: |- - This event is sent when a user is unblocked on a call, - this can be useful to notify the user that they can now join the call again + QueryCommentReactionsRequest: + nullable: true properties: - call_cid: + filter: + additionalProperties: {} + type: object + x-stream-index: "002" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "004.001" + next: type: string - x-stream-index: "002.001" - created_at: - format: date-time - type: number - x-stream-index: "001.002" - type: - default: call.unblocked_user - description: 'The type of event: "call.unblocked_user" in this case' - title: Event Type + x-stream-index: "004.002" + prev: type: string - x-stream-index: "001.001" - user: - $ref: '#/components/schemas/UserResponse' - description: The user that was unblocked - title: User - x-stream-index: "003" - required: - - type - - created_at - - call_cid - - user - title: UnblockedUserEvent - type: object - x-stream-event-call-type: true - x-stream-event-doc-group: call - x-stream-is-event: true - x-stream-ws-base-event-name: VideoEvent - UnmuteChannelRequest: - nullable: true - properties: - channel_cids: - description: Channel CIDs to mute (if multiple channels) + x-stream-index: "004.003" + sort: items: - type: string - maximum: 25 - title: Channel CIDs + $ref: '#/components/schemas/SortParamRequest' + maximum: 5 type: array - x-stream-index: "001.002" - expiration: - description: Duration of mute in milliseconds - title: Expiration - type: integer - x-stream-index: "001.003" + x-stream-index: "003" type: object - UnmuteResponse: + QueryCommentReactionsResponse: description: Basic response information nullable: true properties: duration: description: Duration of the request in milliseconds title: Duration + type: string + x-stream-index: "003.001" + next: type: string x-stream-index: "002.001" - non_existing_users: + prev: + type: string + x-stream-index: "002.002" + reactions: items: - type: string + $ref: '#/components/schemas/FeedsReactionResponse' type: array x-stream-index: "001" required: + - reactions - duration title: Response type: object - UnpinRequest: - description: UnpinRequest is the payload for unpinning a message. + QueryCommentsRequest: nullable: true properties: - session_id: - description: the session ID of the user who pinned the message - title: SessionID + filter: + additionalProperties: {} + description: MongoDB-style filter for querying comments + title: Filter + type: object + x-stream-index: "001" + limit: + description: Maximum number of comments to return + format: int32 + maximum: 100 + minimum: 0 + title: Limit + type: integer + x-stream-index: "003.001" + next: type: string - x-stream-index: "003" - user_id: - description: the user ID of the user who pinned the message - title: UserID + x-stream-index: "003.002" + prev: + type: string + x-stream-index: "003.003" + sort: + description: first (oldest), last (newest) or top + enum: + - first + - last + - top + - best + - controversial + title: Sort Order type: string x-stream-index: "002" required: - - user_id - - session_id - title: UnpinRequest + - filter + title: Query Comments Request type: object - UnpinResponse: - description: UnpinResponse is the payload for unpinning a message. + QueryCommentsResponse: nullable: true properties: + comments: + description: List of comments matching the query + items: + $ref: '#/components/schemas/CommentResponse' + title: Comments + type: array + x-stream-index: "001" duration: - description: Duration of the request in milliseconds - title: Duration type: string - x-stream-index: "001.001" - required: - - duration - title: UnpinResponse - type: object - UnreadCountsChannel: - properties: - channel_id: + x-stream-index: "003.001" + next: + description: Cursor for next page + title: Next type: string - x-stream-index: "001" - last_read: - format: date-time - type: number - x-stream-index: "003" - unread_count: - format: int32 - type: integer - x-stream-index: "002" + x-stream-index: "002.001" + prev: + description: Cursor for previous page + title: Previous + type: string + x-stream-index: "002.002" required: - - channel_id - - unread_count - - last_read + - comments + - duration + title: Query Comments Response type: object - UnreadCountsChannelType: + QueryDraftsRequest: + nullable: true properties: - channel_count: - format: int32 - type: integer - x-stream-index: "002" - channel_type: - type: string + filter: + additionalProperties: {} + description: Filter to apply to the query + maximum: 3 + title: Filter + type: object x-stream-index: "001" - unread_count: + limit: format: int32 + maximum: 100 + minimum: 0 type: integer - x-stream-index: "003" - required: - - channel_type - - channel_count - - unread_count - type: object - UnreadCountsThread: - properties: - last_read: - format: date-time - type: number - x-stream-index: "002" - last_read_message_id: - type: string - x-stream-index: "003" - parent_message_id: + x-stream-index: "005.001" + next: type: string - x-stream-index: "004" - unread_count: - format: int32 - type: integer - x-stream-index: "001" - required: - - unread_count - - last_read - - last_read_message_id - - parent_message_id - type: object - UpdateBlockListRequest: - nullable: true - properties: - team: + x-stream-index: "005.002" + prev: type: string - x-stream-index: "002" - words: - description: List of words to block + x-stream-index: "005.003" + sort: + description: Array of sort parameters items: - type: string - minimum: 1 - title: Words + $ref: '#/components/schemas/SortParamRequest' + maximum: 5 + title: Sort type: array - x-stream-index: "003" - title: Update block list + x-stream-index: "002" type: object - x-stream-docs-page-id: update_block_list - UpdateBlockListResponse: - description: Basic response information + QueryDraftsResponse: nullable: true properties: - blocklist: - $ref: '#/components/schemas/BlockListResponse' + drafts: + description: Drafts + items: + $ref: '#/components/schemas/DraftResponse' + title: DraftsResponseList + type: array x-stream-index: "001" duration: description: Duration of the request in milliseconds title: Duration + type: string + x-stream-index: "003.001" + next: type: string x-stream-index: "002.001" + prev: + type: string + x-stream-index: "002.002" required: + - drafts - duration - title: Response type: object - UpdateCallMembersRequest: - description: Update call members + QueryFeedMembersRequest: nullable: true properties: - remove_members: - description: List of userID to remove - items: - type: string - maximum: 100 - title: Remove Members - type: array + filter: + additionalProperties: {} + description: Filter parameters for the query + title: object + type: object x-stream-index: "003" - update_members: - description: List of members to update or insert - items: - $ref: '#/components/schemas/MemberRequest' + limit: + format: int32 maximum: 100 - title: Update Members + minimum: 0 + type: integer + x-stream-index: "005.001" + next: + type: string + x-stream-index: "005.002" + prev: + type: string + x-stream-index: "005.003" + sort: + description: Sort parameters for the query + items: + $ref: '#/components/schemas/SortParamRequest' + maximum: 5 + title: array type: array x-stream-index: "004" - title: UpdateCallMembersRequest type: object - UpdateCallMembersResponse: - description: Basic response information + QueryFeedMembersResponse: nullable: true properties: duration: - description: Duration of the request in milliseconds - title: Duration type: string - x-stream-index: "001.001" + x-stream-index: "003.001" members: + description: List of feed members items: - $ref: '#/components/schemas/MemberResponse' + $ref: '#/components/schemas/FeedMemberResponse' + title: array type: array - x-stream-index: "002" + x-stream-index: "001" + next: + description: Cursor for next page + title: Next + type: string + x-stream-index: "002.001" + prev: + description: Cursor for previous page + title: Previous + type: string + x-stream-index: "002.002" required: - - duration - members - title: Response + - duration type: object - UpdateCallRequest: - description: Request for updating a call + QueryFeedsRequest: nullable: true properties: - custom: + filter: additionalProperties: {} - description: Custom data for this object - title: Custom data + description: Filters to apply to the query + title: Filter type: object + x-stream-index: "001" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "004.001" + next: + type: string + x-stream-index: "004.002" + prev: + type: string + x-stream-index: "004.003" + sort: + description: Sorting parameters for the query + items: + $ref: '#/components/schemas/SortParamRequest' + maximum: 5 + title: Sort + type: array x-stream-index: "003" - settings_override: - $ref: '#/components/schemas/CallSettingsRequest' - description: the settings to change for this call - title: Settings Override - x-stream-index: "004" - starts_at: - description: the time the call is scheduled to start - format: date-time - title: Starts At - type: number - x-stream-index: "005" - title: UpdateCallRequest + watch: + description: Whether to subscribe to realtime updates + title: Watch + type: boolean + x-stream-index: "002" + title: Query Feeds Request type: object - UpdateCallResponse: - description: Response for updating a call + QueryFeedsResponse: nullable: true properties: - call: - $ref: '#/components/schemas/CallResponse' - x-stream-index: "001.001" duration: type: string - x-stream-index: "002.001" - members: - items: - $ref: '#/components/schemas/MemberResponse' - type: array - x-stream-index: "001.002" - membership: - $ref: '#/components/schemas/MemberResponse' - x-stream-index: "001.003" - own_capabilities: + x-stream-index: "003.001" + feeds: + description: List of feeds matching the query items: - $ref: '#/components/schemas/OwnCapability' + $ref: '#/components/schemas/FeedResponse' + title: Feeds type: array - x-stream-index: "001.004" + x-stream-index: "001" + next: + description: Cursor for next page + title: Next + type: string + x-stream-index: "002.001" + prev: + description: Cursor for previous page + title: Previous + type: string + x-stream-index: "002.002" required: - - call - - members - - own_capabilities - - blocked_users + - feeds - duration - title: UpdateCallResponse + title: Query Feeds Response type: object - UpdateChannelPartialRequest: + QueryFollowsRequest: nullable: true properties: - set: + filter: additionalProperties: {} + description: Filters to apply to the query + title: Filter type: object - x-stream-index: "002.001" - unset: + x-stream-index: "001" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "003.001" + next: + type: string + x-stream-index: "003.002" + prev: + type: string + x-stream-index: "003.003" + sort: + description: Sorting parameters for the query items: - type: string + $ref: '#/components/schemas/SortParamRequest' + maximum: 5 + title: Sort type: array - x-stream-index: "002.002" - title: UpdateChannelPartialRequest + x-stream-index: "002" + title: Query Follows Request type: object - UpdateChannelPartialResponse: + QueryFollowsResponse: nullable: true properties: - channel: - $ref: '#/components/schemas/ChannelResponse' - description: Updated channel object - title: Channel - x-stream-index: "001" duration: - description: Duration of the request in milliseconds - title: Duration type: string x-stream-index: "003.001" - members: - description: List of updated members + follows: + description: List of follow relationships matching the query items: - $ref: '#/components/schemas/ChannelMemberResponse' - title: ChannelMemberResponse + $ref: '#/components/schemas/FollowResponse' + title: Follows type: array - x-stream-index: "002" + x-stream-index: "001" + next: + description: Cursor for next page + title: Next + type: string + x-stream-index: "002.001" + prev: + description: Cursor for previous page + title: Previous + type: string + x-stream-index: "002.002" required: - - members + - follows - duration + title: Query Follows Response type: object - UpdateChannelRequest: - nullable: true + QueryMembersPayload: + description: Client request properties: - accept_invite: - description: Set to `true` to accept the invite - title: Accept invite - type: boolean - x-stream-index: "008" - add_members: - description: List of user IDs to add to the channel + filter_conditions: + additionalProperties: {} + type: object + x-stream-index: "004" + id: + type: string + x-stream-index: "002" + limit: + format: int32 + maximum: 300 + minimum: 0 + type: integer + x-stream-index: "006.003" + members: items: $ref: '#/components/schemas/ChannelMember' maximum: 100 - title: Add members - type: array - x-stream-index: "001" - add_moderators: - description: List of user IDs to make channel moderators - items: - type: string - maximum: 100 - title: Add moderators type: array x-stream-index: "003" - assign_roles: - description: List of channel member role assignments. If any specified user - is not part of the channel, the request will fail - items: - $ref: '#/components/schemas/ChannelMember' - maximum: 100 - title: Assign roles - type: array - x-stream-index: "006" - cooldown: - description: Sets cool down period for the channel in seconds + offset: format: int32 - maximum: 120 - minimum: 0 - title: Cool down + maximum: 10000 type: integer - x-stream-index: "007" - data: - $ref: '#/components/schemas/ChannelInput' - x-stream-index: "013.001" - demote_moderators: - description: List of user IDs to take away moderators status from - items: - type: string - maximum: 100 - title: Demote moderators - type: array - x-stream-index: "004" - hide_history: - description: Set to `true` to hide channel's history when adding new members - title: Hide history - type: boolean - x-stream-index: "012" - invites: - description: List of user IDs to invite to the channel + x-stream-index: "006.004" + sort: items: - $ref: '#/components/schemas/ChannelMember' - maximum: 100 - title: Invites + $ref: '#/components/schemas/SortParamRequest' + maximum: 1 type: array x-stream-index: "005" - message: - $ref: '#/components/schemas/MessageRequest' - description: Message to send to the chat when channel is successfully updated - title: Message - x-stream-index: "010" - reject_invite: - description: Set to `true` to reject the invite - title: Reject invite + type: + maxLength: 64 + type: string + x-stream-index: "001" + required: + - type + - filter_conditions + title: ClientRequest + type: object + QueryMessageFlagsPayload: + properties: + filter_conditions: + additionalProperties: {} + type: object + x-stream-index: "001" + limit: + format: int32 + maximum: 300 + minimum: 0 + type: integer + x-stream-index: "003.003" + offset: + format: int32 + maximum: 10000 + type: integer + x-stream-index: "003.004" + show_deleted_messages: + description: Whether to include deleted messages in the results + title: ShowDeletedMessages type: boolean - x-stream-index: "009" - remove_members: - description: List of user IDs to remove from the channel + x-stream-index: "002" + sort: items: - type: string - maximum: 100 - title: Remove members + $ref: '#/components/schemas/SortParamRequest' + maximum: 5 type: array - x-stream-index: "002" - skip_push: - description: When `message` is set disables all push notifications for it - title: Skip push - type: boolean - x-stream-index: "011" - title: Channel update request + x-stream-index: "003.005" type: object - x-stream-docs-page-id: channel_update - UpdateChannelResponse: + QueryMessageFlagsResponse: + description: Query message flags response nullable: true properties: - channel: - $ref: '#/components/schemas/ChannelResponse' - description: Updated channel - title: Channel - x-stream-index: "001" duration: description: Duration of the request in milliseconds title: Duration type: string - x-stream-index: "004.001" - members: - description: List of channel members + x-stream-index: "002.001" + flags: + description: The flags that match the query items: - $ref: '#/components/schemas/ChannelMember' - title: Members + $ref: '#/components/schemas/MessageFlagResponse' + title: MessageFlagResponseList type: array - x-stream-index: "003" - message: - $ref: '#/components/schemas/MessageResponse' - description: Message sent to the chat - title: Message - x-stream-index: "002" - required: - - members - - duration - type: object - UpdateLiveLocationRequest: - nullable: true - properties: - end_at: - description: Time when the live location expires - format: date-time - title: string - type: number - x-stream-index: "004" - latitude: - description: Latitude coordinate - format: float - maximum: 90 - minimum: 1.8446744073709552e+19 - title: number - type: number - x-stream-index: "002" - longitude: - description: Longitude coordinate - format: float - maximum: 180 - minimum: 1.8446744073709552e+19 - title: number - type: number - x-stream-index: "003" - message_id: - description: Live location ID - title: string - type: string x-stream-index: "001" required: - - message_id + - flags + - duration + title: QueryMessageFlagsResponse type: object - UpdateMemberPartialRequest: + QueryModerationConfigsRequest: nullable: true properties: - set: + filter: additionalProperties: {} + description: Filter conditions for moderation configs + title: Filter type: object - x-stream-index: "002.001" - unset: - items: - type: string - type: array - x-stream-index: "002.002" - type: object - UpdateMemberPartialResponse: - nullable: true - properties: - channel_member: - $ref: '#/components/schemas/ChannelMemberResponse' - description: Updated channel member - title: Channel member + x-stream-index: "001" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "003.001" + next: + type: string + x-stream-index: "003.002" + prev: + type: string + x-stream-index: "003.003" + sort: + description: Sorting parameters for the results + items: + $ref: '#/components/schemas/SortParamRequest' + title: Sort + type: array + x-stream-index: "002" + type: object + QueryModerationConfigsResponse: + nullable: true + properties: + configs: + description: List of moderation configurations + items: + $ref: '#/components/schemas/ConfigResponse' + title: Configs + type: array x-stream-index: "001" duration: - description: Duration of the request in milliseconds - title: Duration + type: string + x-stream-index: "003.001" + next: type: string x-stream-index: "002.001" + prev: + type: string + x-stream-index: "002.002" required: + - configs - duration type: object - UpdateMessagePartialRequest: + QueryPollVotesRequest: nullable: true properties: - set: + filter: additionalProperties: {} - description: Sets new field values - title: Set + description: Filter to apply to the query + title: Filter type: object - x-stream-index: "002.001" - x-stream-map: - description: New value to set - key: field - title: Value - skip_enrich_url: - description: Skip enriching the URL in the message - title: SkipEnrichURL - type: boolean - x-stream-index: "001" - unset: - description: Array of field names to unset + x-stream-index: "003" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "005.001" + next: + type: string + x-stream-index: "005.002" + prev: + type: string + x-stream-index: "005.003" + sort: + description: Array of sort parameters items: - type: string - title: Unset + $ref: '#/components/schemas/SortParamRequest' + maximum: 5 + title: Sort type: array - x-stream-index: "002.002" + x-stream-index: "004" type: object - UpdateMessagePartialResponse: + QueryPollsRequest: + nullable: true + properties: + filter: + additionalProperties: {} + description: Filter to apply to the query + title: Filter + type: object + x-stream-index: "002" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "005.001" + next: + type: string + x-stream-index: "005.002" + prev: + type: string + x-stream-index: "005.003" + sort: + description: Array of sort parameters + items: + $ref: '#/components/schemas/SortParamRequest' + maximum: 5 + title: Sort + type: array + x-stream-index: "003" + type: object + QueryPollsResponse: nullable: true properties: duration: @@ -19038,538 +19666,516 @@ components: title: Duration type: string x-stream-index: "003.001" - message: - $ref: '#/components/schemas/MessageResponse' - description: Updated message - title: Message + next: + type: string + x-stream-index: "002.001" + polls: + description: Polls data returned by the query + items: + $ref: '#/components/schemas/PollResponseData' + title: PollsResponseData + type: array x-stream-index: "001" - pending_message_metadata: - additionalProperties: - type: string - description: Pending message metadata - title: PendingMessageMetadata - type: object - x-stream-index: "002" + prev: + type: string + x-stream-index: "002.002" required: + - polls - duration type: object - UpdateMessageRequest: - nullable: true + QueryReactionsRequest: properties: - message: - $ref: '#/components/schemas/MessageRequest' - description: Message - title: MessageRequest - x-stream-index: "001" - skip_enrich_url: - description: Skip enrich URL - title: boolean - type: boolean - x-stream-index: "003" - skip_push: - type: boolean + filter: + additionalProperties: {} + type: object x-stream-index: "002" - required: - - message + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "006.001" + next: + type: string + x-stream-index: "006.002" + prev: + type: string + x-stream-index: "006.003" + sort: + items: + $ref: '#/components/schemas/SortParamRequest' + maximum: 2 + type: array + x-stream-index: "003" type: object - UpdateMessageResponse: + QueryReactionsResponse: description: Basic response information - nullable: true properties: duration: description: Duration of the request in milliseconds title: Duration + type: string + x-stream-index: "002.001" + next: type: string x-stream-index: "003.001" - message: - $ref: '#/components/schemas/MessageResponse' + prev: + type: string + x-stream-index: "003.002" + reactions: + items: + $ref: '#/components/schemas/ReactionResponse' + type: array x-stream-index: "001" - pending_message_metadata: - additionalProperties: - type: string - type: object - x-stream-index: "002" required: - - message + - reactions - duration title: Response type: object - UpdatePollOptionRequest: + QueryRemindersRequest: nullable: true properties: - Custom: + filter: additionalProperties: {} + description: Filter to apply to the query + title: Filter type: object - writeOnly: true - x-stream-index: "004" - id: - description: Option ID - maxLength: 255 - title: string + x-stream-index: "001" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "005.001" + next: type: string - x-stream-index: "002" - text: - description: Option text - title: string + x-stream-index: "005.002" + prev: type: string - x-stream-index: "003" - required: - - id - - text + x-stream-index: "005.003" + sort: + description: Array of sort parameters + items: + $ref: '#/components/schemas/SortParamRequest' + maximum: 5 + title: Sort + type: array + x-stream-index: "002" type: object - UpdatePollPartialRequest: + QueryRemindersResponse: nullable: true properties: - set: - additionalProperties: {} - description: Sets new field values - title: Set - type: object + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "003.001" + next: + type: string x-stream-index: "002.001" - x-stream-map: - description: New value to set - key: field - title: Value - unset: - description: Array of field names to unset + prev: + type: string + x-stream-index: "002.002" + reminders: + description: MessageReminders data returned by the query items: - type: string - title: Unset + $ref: '#/components/schemas/ReminderResponseData' + title: RemindersResponseData type: array - x-stream-index: "002.002" + x-stream-index: "001" + required: + - reminders + - duration type: object - UpdatePollRequest: + QueryReviewQueueRequest: nullable: true properties: - Custom: + filter: additionalProperties: {} + description: Filter conditions for review queue items + title: Filter type: object - writeOnly: true - x-stream-index: "011" - allow_answers: - description: Allow answers - title: boolean - type: boolean - x-stream-index: "009" - allow_user_suggested_options: - description: Allow user suggested options - title: boolean - type: boolean - x-stream-index: "008" - description: - description: Poll description - title: string - type: string - x-stream-index: "003" - enforce_unique_vote: - description: Enforce unique vote - title: boolean - type: boolean - x-stream-index: "005" - id: - description: Poll ID - maxLength: 255 - title: string - type: string x-stream-index: "001" - is_closed: - description: Is closed - title: boolean - type: boolean - x-stream-index: "010" - max_votes_allowed: - description: Max votes allowed + limit: format: int32 - maximum: 10 - title: integer + maximum: 100 + minimum: 0 type: integer - x-stream-index: "007" - name: - description: Poll name - title: string + x-stream-index: "007.001" + lock_count: + description: Number of items to lock (1-25) + format: int32 + maximum: 25 + minimum: 1 + title: Lock Count + type: integer + x-stream-index: "005" + lock_duration: + description: Duration for which items should be locked + title: Lock Duration + type: integer + x-stream-index: "004" + lock_items: + description: Whether to lock items for review (true), unlock items (false), + or just fetch (nil) + title: Lock Items + type: boolean + x-stream-index: "003" + next: type: string - x-stream-index: "002" - options: - description: Poll options + x-stream-index: "007.002" + prev: + type: string + x-stream-index: "007.003" + sort: + description: Sorting parameters for the results items: - $ref: '#/components/schemas/PollOptionRequest' - maximum: 100 - title: PollOptions + $ref: '#/components/schemas/SortParamRequest' + title: Sort type: array - x-stream-index: "004" - voting_visibility: - description: Voting visibility - enum: - - anonymous - - public - title: string - type: string + x-stream-index: "002" + stats_only: + description: Whether to return only statistics + title: Stats Only + type: boolean x-stream-index: "006" - required: - - id - - name - type: object - UpdateReminderRequest: - nullable: true - properties: - remind_at: - format: date-time - type: number - x-stream-index: "001" type: object - UpdateReminderResponse: - description: Basic response information + QueryReviewQueueResponse: nullable: true properties: + action_config: + additionalProperties: + items: + $ref: '#/components/schemas/ModerationActionConfig' + type: array + description: Configuration for moderation actions + title: Action Config + type: object + x-stream-index: "002" duration: - description: Duration of the request in milliseconds - title: Duration type: string - x-stream-index: "002.001" - reminder: - $ref: '#/components/schemas/ReminderResponseData' + x-stream-index: "005.001" + items: + description: List of review queue items + items: + $ref: '#/components/schemas/ReviewQueueItemResponse' + title: Items + type: array x-stream-index: "001" + next: + type: string + x-stream-index: "004.001" + prev: + type: string + x-stream-index: "004.002" + stats: + additionalProperties: {} + description: Statistics about the review queue + title: Stats + type: object + x-stream-index: "003" required: - - reminder + - items + - action_config + - stats - duration - title: Response type: object - UpdateThreadPartialRequest: + QueryThreadsRequest: nullable: true properties: - set: + filter: additionalProperties: {} - description: Sets new field values - title: Set + description: Filter conditions to apply to threads + title: Filter type: object - x-stream-index: "004.001" - x-stream-map: - description: New value to set - key: field - title: Value - unset: - description: Array of field names to unset + x-stream-index: "006" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "008.001" + member_limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "005" + next: + type: string + x-stream-index: "008.002" + participant_limit: + description: Limit the number of participants returned per each thread + format: int32 + maximum: 100 + minimum: 0 + title: Participant limit + type: integer + x-stream-index: "004" + prev: + type: string + x-stream-index: "008.003" + reply_limit: + description: Limit the number of replies returned per each thread + format: int32 + maximum: 10 + minimum: 0 + title: Reply limit + type: integer + x-stream-index: "003" + sort: + description: Sort conditions to apply to threads items: - type: string - title: Unset + $ref: '#/components/schemas/SortParamRequest' + maximum: 5 + title: Sort type: array - x-stream-index: "004.002" + x-stream-index: "007" + watch: + description: Start watching the channel this thread belongs to + title: Watch + type: boolean + x-stream-index: "001" type: object - UpdateThreadPartialResponse: + QueryThreadsResponse: nullable: true properties: duration: description: Duration of the request in milliseconds title: Duration + type: string + x-stream-index: "003.001" + next: type: string x-stream-index: "002.001" - thread: - $ref: '#/components/schemas/ThreadResponse' - description: Updated thread (not enriched) - title: Thread + prev: + type: string + x-stream-index: "002.002" + threads: + description: List of enriched thread states + items: + $ref: '#/components/schemas/ThreadStateResponse' + title: Threads + type: array x-stream-index: "001" required: - - thread + - threads - duration type: object - UpdateUserPartialRequest: + QueryUsersPayload: properties: - id: - description: User ID to update - title: ID - type: string - x-stream-index: "001" - set: + filter_conditions: additionalProperties: {} type: object - x-stream-index: "002.001" - unset: - items: - type: string - type: array - x-stream-index: "002.002" - required: - - id - type: object - UpdateUserPermissionsRequest: - nullable: true - properties: - grant_permissions: + x-stream-index: "001" + include_deactivated_users: + type: boolean + x-stream-index: "004" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "005.003" + offset: + format: int32 + maximum: 1000 + type: integer + x-stream-index: "005.004" + presence: + type: boolean + x-stream-index: "003" + sort: items: - type: string + $ref: '#/components/schemas/SortParamRequest' + maximum: 5 type: array x-stream-index: "002" - revoke_permissions: - items: - type: string - type: array - x-stream-index: "003" - user_id: - type: string - x-stream-index: "001" required: - - user_id + - filter_conditions type: object - UpdateUserPermissionsResponse: - description: Basic response information + QueryUsersResponse: 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 - UpdateUsersPartialRequest: - nullable: true - properties: + x-stream-index: "002.001" users: + description: Array of users as result of filters applied. items: - $ref: '#/components/schemas/UpdateUserPartialRequest' - maximum: 100 + $ref: '#/components/schemas/FullUserResponse' + title: Users type: array x-stream-index: "001" required: - users + - duration type: object - UpdateUsersRequest: - nullable: true + RTMPBroadcastRequest: + description: RTMPBroadcastRequest is the payload for starting an RTMP broadcast. properties: - users: - additionalProperties: - $ref: '#/components/schemas/UserRequest' - description: Object containing users - title: Users - type: object + layout: + $ref: '#/components/schemas/LayoutSettingsRequest' + description: If provided, will override the call's RTMP settings layout + title: Layout + x-stream-index: "005" + name: + description: Name identifier for RTMP broadcast, must be unique in call + maxLength: 255 + title: Name + type: string x-stream-index: "001" - x-stream-map: - key: user_id + quality: + description: If provided, will override the call's RTMP settings quality + enum: + - 360p + - 480p + - 720p + - 1080p + - 1440p + - portrait-360x640 + - portrait-480x854 + - portrait-720x1280 + - portrait-1080x1920 + - portrait-1440x2560 + title: Quality + type: string + x-stream-index: "004" + stream_key: + description: If provided, will be appended at the end of stream_url + title: Stream Key + type: string + x-stream-index: "003" + stream_url: + description: URL for the RTMP server to send the call to + maxLength: 255 + title: Stream URL + type: string + x-stream-index: "002" required: - - users + - name + - stream_url + title: RTMPBroadcastRequest type: object - UpdateUsersResponse: - nullable: true + RTMPEgressConfig: properties: - duration: - description: Duration of the request in milliseconds - title: Duration + composite_app_settings: + $ref: '#/components/schemas/CompositeAppSettings' + x-stream-index: "005" + quality: + $ref: '#/components/schemas/Quality' + x-stream-index: "004" + rtmp_location: type: string - x-stream-index: "003.001" - membership_deletion_task_id: + x-stream-index: "006" + type: object + RTMPIngress: + description: RTMP input settings + properties: + address: + title: Address type: string - x-stream-index: "002" - users: - additionalProperties: - $ref: '#/components/schemas/FullUserResponse' - description: Object containing users - title: Users - type: object x-stream-index: "001" - x-stream-map: - key: user_id required: - - users - - membership_deletion_task_id - - duration + - address + title: RTMPIngress type: object - UpdatedCallPermissionsEvent: - description: This event is sent to notify about permission changes for a user, - clients receiving this event should update their UI accordingly + RTMPLocation: properties: - call_cid: + name: type: string - x-stream-index: "002.001" - created_at: - format: date-time - type: number - x-stream-index: "001.002" - own_capabilities: - description: The capabilities of the current user - items: - $ref: '#/components/schemas/OwnCapability' - title: Own capabilities - type: array - x-stream-index: "004" - type: - default: call.permissions_updated - description: 'The type of event: "call.permissions_updated" in this case' - title: Event Type + x-stream-index: "001" + stream_key: type: string - x-stream-index: "001.001" - user: - $ref: '#/components/schemas/UserResponse' - description: The user who received the new permissions - title: User x-stream-index: "003" + stream_url: + type: string + x-stream-index: "002" required: - - type - - created_at - - call_cid - - user - - own_capabilities - title: UpdatedCallPermissionsEvent + - name + - stream_url + - stream_key type: object - x-stream-event-call-type: true - x-stream-event-doc-group: call - x-stream-is-event: true - x-stream-ws-base-event-name: VideoEvent - UpsertConfigRequest: - nullable: true + RTMPSettings: properties: - ai_image_config: - $ref: '#/components/schemas/AIImageConfig' - description: Configuration for AI image analysis - title: AI Image Config - x-stream-index: "010" - ai_text_config: - $ref: '#/components/schemas/AITextConfig' - description: Configuration for AI text analysis - title: AI Text Config - x-stream-index: "008" - ai_video_config: - $ref: '#/components/schemas/AIVideoConfig' - description: Configuration for AI video analysis - title: AI Video Config - x-stream-index: "011" - async: - description: Whether moderation should be performed asynchronously - title: Async + enabled: type: boolean + x-stream-index: "001" + layout: + $ref: '#/components/schemas/LayoutSettings' x-stream-index: "003" - automod_platform_circumvention_config: - $ref: '#/components/schemas/AutomodPlatformCircumventionConfig' - description: Configuration for platform circumvention detection - title: Automod Platform Circumvention Config - x-stream-index: "005" - automod_semantic_filters_config: - $ref: '#/components/schemas/AutomodSemanticFiltersConfig' - description: Configuration for semantic filtering - title: Automod Semantic Filters Config - x-stream-index: "006" - automod_toxicity_config: - $ref: '#/components/schemas/AutomodToxicityConfig' - description: Configuration for toxicity detection - title: Automod Toxicity Config + location: + $ref: '#/components/schemas/RTMPLocation' x-stream-index: "004" - aws_rekognition_config: - $ref: '#/components/schemas/AIImageConfig' - x-stream-index: "015" - block_list_config: - $ref: '#/components/schemas/BlockListConfig' - description: Configuration for block list filtering - title: Block List Config - x-stream-index: "007" - bodyguard_config: - $ref: '#/components/schemas/AITextConfig' - x-stream-index: "014" - google_vision_config: - $ref: '#/components/schemas/GoogleVisionConfig' - description: Configuration for Google Vision integration - title: Google Vision Config - x-stream-index: "009" - key: - description: Unique identifier for the moderation configuration - title: Key - type: string - x-stream-index: "001" - rule_builder_config: - $ref: '#/components/schemas/RuleBuilderConfig' - description: Configuration for custom rule builder (max 3 rules, max 5 conditions - per rule) - title: Rule Builder Config - x-stream-index: "013" - team: - description: Team associated with the configuration - maxLength: 128 - minLength: 1 - title: Team + quality_name: type: string x-stream-index: "002" - velocity_filter_config: - $ref: '#/components/schemas/VelocityFilterConfig' - description: Configuration for velocity-based filtering - title: Velocity Filter Config - x-stream-index: "012" - video_call_rule_config: - $ref: '#/components/schemas/VideoCallRuleConfig' - x-stream-index: "016" required: - - key + - enabled type: object - UpsertConfigResponse: - nullable: true + RTMPSettingsRequest: properties: - config: - $ref: '#/components/schemas/ConfigResponse' - description: The created or updated moderation configuration - title: Config + enabled: + type: boolean x-stream-index: "001" - duration: + quality: + description: Resolution to set for the RTMP stream + enum: + - 360p + - 480p + - 720p + - 1080p + - 1440p + - portrait-360x640 + - portrait-480x854 + - portrait-720x1280 + - portrait-1080x1920 + - portrait-1440x2560 + title: Quality type: string - x-stream-index: "002.001" - required: - - duration + x-stream-index: "002" + title: RTMPSettingsRequest type: object - UpsertPushPreferencesRequest: - nullable: true + RTMPSettingsResponse: + description: RTMPSettingsResponse is the payload for RTMP settings properties: - preferences: - description: A list of push preferences for channels, calls, or the user. - items: - $ref: '#/components/schemas/PushPreferenceInput' - type: array + enabled: + title: Enabled + type: boolean x-stream-index: "001" + quality: + title: Quality + type: string + x-stream-index: "002" required: - - preferences + - enabled + - quality + - layout + title: RTMPSettingsResponse type: object - UpsertPushPreferencesResponse: - nullable: true + RankingConfig: properties: - duration: - description: Duration of the request in milliseconds - title: Duration - type: string - x-stream-index: "003.001" - user_channel_preferences: - additionalProperties: - additionalProperties: - $ref: '#/components/schemas/ChannelPushPreferences' - type: object - description: The channel specific push notification preferences, only returned - for channels you've edited. - title: User Channel Notification Preferences + defaults: + additionalProperties: {} type: object - x-stream-index: "002" - user_preferences: + x-stream-index: "003" + functions: additionalProperties: - $ref: '#/components/schemas/PushPreferences' - description: The user preferences, always returned regardless if you edited - it - title: User Preferences + $ref: '#/components/schemas/DecayFunctionConfig' type: object + x-stream-index: "004" + score: + type: string + x-stream-index: "002" + type: + type: string x-stream-index: "001" - required: - - user_preferences - - user_channel_preferences - - duration type: object - User: + Reaction: + nullable: true properties: - avg_response_time: - format: int32 - readOnly: true - type: integer - x-stream-index: "046" - ban_expires: - format: date-time - type: number - x-stream-index: "017" - banned: - type: boolean - x-stream-index: "016" created_at: format: date-time readOnly: true @@ -19578,1150 +20184,6698 @@ components: custom: additionalProperties: {} type: object - x-stream-index: "006" - deactivated_at: - format: date-time - readOnly: true - type: number - x-stream-index: "014" - deleted_at: - format: date-time - readOnly: true - type: number - x-stream-index: "013" - id: + x-stream-index: "010" + message_id: type: string x-stream-index: "003" - invisible: - type: boolean - x-stream-index: "023" - language: - type: string - x-stream-index: "035" - last_active: - format: date-time - readOnly: true - type: number - x-stream-index: "011" - last_engaged_at: - format: date-time - readOnly: true - type: number - x-stream-index: "012" - online: - readOnly: true - type: boolean - x-stream-index: "022" - privacy_settings: - $ref: '#/components/schemas/PrivacySettings' - x-stream-index: "026" - revoke_tokens_issued_before: - format: date-time - type: number - x-stream-index: "042" - role: + score: + format: int32 + type: integer + x-stream-index: "007" + type: + maxLength: 30 type: string - x-stream-index: "004" - teams: - items: - type: string - type: array - x-stream-index: "036" - teams_role: - additionalProperties: - type: string - type: object - x-stream-index: "005" + x-stream-index: "006" updated_at: format: date-time readOnly: true type: number x-stream-index: "009" + user: + $ref: '#/components/schemas/User' + x-stream-index: "005" + user_id: + type: string + x-stream-index: "004" required: - - id - - role - - teams_role + - message_id + - type + - score + - created_at + - updated_at - custom - - banned - - online type: object - UserBannedEvent: + ReactionDeletedEvent: properties: channel_id: type: string - x-stream-index: "006.002" + x-stream-index: "003.002" channel_type: type: string - x-stream-index: "006.003" + x-stream-index: "003.003" cid: type: string - x-stream-index: "006.001" + x-stream-index: "003.001" created_at: format: date-time type: number - x-stream-index: "008.002" - created_by: - $ref: '#/components/schemas/User' - x-stream-index: "001" - expiration: - format: date-time - type: number - x-stream-index: "003" - reason: - type: string - x-stream-index: "004" - shadow: - type: boolean + x-stream-index: "006.002" + message: + $ref: '#/components/schemas/Message' + x-stream-index: "001.001" + reaction: + $ref: '#/components/schemas/Reaction' x-stream-index: "002" team: type: string x-stream-index: "005.001" + thread_participants: + items: + $ref: '#/components/schemas/User' + type: array + x-stream-index: "001.002" type: - default: user.banned + default: reaction.deleted type: string - x-stream-index: "008.001" + x-stream-index: "006.001" user: $ref: '#/components/schemas/User' - x-stream-index: "007.001" + x-stream-index: "004.001" required: - - created_by - - shadow - cid - channel_id - channel_type - type - created_at - title: UserBannedEvent + title: ReactionDeletedEvent 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 - UserCreatedWithinParameters: + ReactionGroupResponse: + description: ReactionGroupResponse contains all information about a reaction + of the same type. + nullable: true properties: - max_age: - type: string + count: + description: Count is the number of reactions of this type. + format: int32 + title: Count + type: integer x-stream-index: "001" - type: object - UserDeactivatedEvent: - properties: - created_at: + first_reaction_at: + description: FirstReactionAt is the time of the first reaction of this type. + This is the same also if all reaction of this type are deleted, because + if someone will react again with the same type, will be preserved the + sorting. format: date-time + title: FirstReactionAt type: number - x-stream-index: "003.002" - created_by: - $ref: '#/components/schemas/User' - x-stream-index: "001" - type: - default: user.deactivated - type: string - x-stream-index: "003.001" - user: - $ref: '#/components/schemas/User' - x-stream-index: "002.001" + x-stream-index: "003" + last_reaction_at: + description: LastReactionAt is the time of the last reaction of this type. + format: date-time + title: LastReactionAt + type: number + x-stream-index: "004" + sum_scores: + description: 'SumScores is the sum of all scores of reactions of this type. + Medium allows you to clap articles more than once and shows the sum of + all claps from all users. For example, you can send `clap` x5 using `score: + 5`.' + format: int32 + title: SumScores + type: integer + x-stream-index: "002" required: - - created_by - - type - - created_at - title: UserDeactivatedEvent + - count + - sum_scores + - first_reaction_at + - last_reaction_at + title: ReactionGroupResponse 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 - UserDeletedEvent: + ReactionNewEvent: properties: + channel_id: + type: string + x-stream-index: "004.002" + channel_type: + type: string + x-stream-index: "004.003" + cid: + type: string + x-stream-index: "004.001" created_at: format: date-time type: number - x-stream-index: "002.002" - delete_conversation_channels: - type: boolean - x-stream-index: "005" - hard_delete: - type: boolean - x-stream-index: "003.001" - mark_messages_deleted: - type: boolean - x-stream-index: "004" + x-stream-index: "006.002" + message: + $ref: '#/components/schemas/Message' + x-stream-index: "001.001" + reaction: + $ref: '#/components/schemas/Reaction' + x-stream-index: "002" + team: + type: string + x-stream-index: "005.001" + thread_participants: + items: + $ref: '#/components/schemas/User' + type: array + x-stream-index: "001.002" type: - default: user.deleted + default: reaction.new type: string - x-stream-index: "002.001" + x-stream-index: "006.001" user: $ref: '#/components/schemas/User' - x-stream-index: "001.001" + x-stream-index: "003.001" required: + - cid + - channel_id + - channel_type - type - created_at - - hard_delete - - mark_messages_deleted - - delete_conversation_channels - title: UserDeletedEvent + title: ReactionNewEvent 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 - UserFeedbackReport: - properties: - count_by_rating: - additionalProperties: - format: int32 - type: integer - type: object - x-stream-index: "001" - unreported_count: - format: int32 - type: integer - x-stream-index: "002" - required: - - count_by_rating - - unreported_count - type: object - UserFeedbackReportResponse: - properties: - daily: - items: - $ref: '#/components/schemas/DailyAggregateUserFeedbackReportResponse' - type: array - x-stream-index: "001" - required: - - daily - type: object - UserMute: - nullable: true + ReactionRequest: + description: Represents user reaction to a message properties: created_at: description: Date/time of creation format: date-time title: Created at type: number - x-stream-index: "009" - expires: - description: Date/time of mute expiration - format: date-time - title: Expires - type: number - x-stream-index: "008" - target: - $ref: '#/components/schemas/User' - description: User who's muted - title: Target - x-stream-index: "007" + x-stream-index: "003" + custom: + additionalProperties: {} + type: object + x-stream-index: "005" + score: + description: Reaction score. If not specified reaction has score of 1 + format: int32 + title: Score + type: integer + x-stream-index: "002" + type: + description: The type of reaction (e.g. 'like', 'laugh', 'wow') + maxLength: 30 + title: Type + type: string + x-stream-index: "001" updated_at: description: Date/time of the last update format: date-time title: Updated at type: number - x-stream-index: "010" - user: - $ref: '#/components/schemas/User' - description: Owner of channel mute - title: User - x-stream-index: "005" + x-stream-index: "004" required: - - created_at - - updated_at + - type + title: Reaction type: object - UserMuteResponse: - nullable: true + x-stream-docs-page-id: send_reaction + ReactionResponse: properties: created_at: + description: Date/time of creation format: date-time + title: Created at type: number + x-stream-index: "006" + custom: + additionalProperties: {} + description: Custom data for this object + title: Custom data + type: object + x-stream-index: "008" + message_id: + description: Message ID + title: Message ID + type: string + x-stream-index: "001" + score: + description: Score of the reaction + format: int32 + title: Score + type: integer + x-stream-index: "005" + type: + description: Type of reaction + title: Type + type: string x-stream-index: "004" - expires: - format: date-time - type: number - x-stream-index: "003" - target: - $ref: '#/components/schemas/UserResponse' - x-stream-index: "002" updated_at: + description: Date/time of the last update format: date-time + title: Updated at type: number - x-stream-index: "005" + x-stream-index: "007" user: $ref: '#/components/schemas/UserResponse' - x-stream-index: "001" + description: User + title: UserResponse + x-stream-index: "003" + user_id: + description: User ID + title: User ID + type: string + x-stream-index: "002" required: + - message_id + - user_id + - user + - type + - score - created_at - updated_at + - custom type: object - UserMutedEvent: + ReactionUpdatedEvent: properties: + channel_id: + type: string + x-stream-index: "004.002" + channel_type: + type: string + x-stream-index: "004.003" + cid: + type: string + x-stream-index: "004.001" created_at: format: date-time type: number - x-stream-index: "004.002" - target_user: - type: string + x-stream-index: "006.002" + message: + $ref: '#/components/schemas/Message' x-stream-index: "001" - target_users: - items: - type: string - type: array + reaction: + $ref: '#/components/schemas/Reaction' x-stream-index: "002" + team: + type: string + x-stream-index: "005.001" type: - default: user.muted + default: reaction.updated type: string - x-stream-index: "004.001" + x-stream-index: "006.001" user: $ref: '#/components/schemas/User' x-stream-index: "003.001" required: - - type - - created_at - title: UserMutedEvent + - message + - reaction + - cid + - channel_id + - channel_type + - type + - created_at + title: ReactionUpdatedEvent 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 - UserPresenceChangedEvent: + ReadReceipts: properties: - created_at: - format: date-time - type: number - x-stream-index: "002.002" - type: - default: user.presence.changed - type: string - x-stream-index: "002.001" - user: - $ref: '#/components/schemas/User' - x-stream-index: "001.001" + enabled: + type: boolean + x-stream-index: "001" required: - - type - - created_at - title: UserPresenceChangedEvent + - enabled 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 - UserRatingReportResponse: + ReadReceiptsResponse: properties: - average: - format: float - type: number - x-stream-index: "002" - count: - format: int32 - type: integer + enabled: + type: boolean x-stream-index: "001" required: - - count - - average + - enabled type: object - UserReactivatedEvent: + ReadStateResponse: properties: - created_at: + last_read: format: date-time type: number - x-stream-index: "002.002" - type: - default: user.reactivated + x-stream-index: "002" + last_read_message_id: type: string - x-stream-index: "002.001" + x-stream-index: "004" + unread_messages: + format: int32 + type: integer + x-stream-index: "003" user: - $ref: '#/components/schemas/User' + $ref: '#/components/schemas/UserResponse' x-stream-index: "001" required: - - type - - created_at - title: UserReactivatedEvent + - user + - last_read + - unread_messages 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 - UserRequest: - description: User request object + RecordSettings: properties: - custom: - additionalProperties: {} - description: Custom user data - title: Custom - type: object + audio_only: + type: boolean + x-stream-index: "001" + layout: + $ref: '#/components/schemas/LayoutSettings' x-stream-index: "004" - id: - description: User ID - title: ID + mode: + type: string + x-stream-index: "002" + quality: type: string + x-stream-index: "003" + required: + - mode + type: object + RecordSettingsRequest: + properties: + audio_only: + type: boolean x-stream-index: "001" - image: - description: User's profile image URL - title: Image + mode: + enum: + - available + - disabled + - auto-on + title: Mode + type: string + x-stream-index: "002" + quality: + enum: + - 360p + - 480p + - 720p + - 1080p + - 1440p + - portrait-360x640 + - portrait-480x854 + - portrait-720x1280 + - portrait-1080x1920 + - portrait-1440x2560 type: string x-stream-index: "003" - invisible: + required: + - mode + title: RecordSettingsRequest + type: object + RecordSettingsResponse: + description: RecordSettings is the payload for recording settings + properties: + audio_only: + title: Audio Only type: boolean - x-stream-index: "006" - language: + x-stream-index: "001" + mode: + title: Mode + type: string + x-stream-index: "002" + quality: + title: Quality type: string + x-stream-index: "003" + required: + - audio_only + - mode + - quality + - layout + title: RecordSettingsResponse + type: object + RecordingEgressConfig: + properties: + audio_only: + type: boolean + x-stream-index: "006" + composite_app_settings: + $ref: '#/components/schemas/CompositeAppSettings' x-stream-index: "005" - name: - description: Optional name of user - title: Name + external_storage: + $ref: '#/components/schemas/ExternalStorage' + x-stream-index: "008" + quality: + $ref: '#/components/schemas/Quality' + x-stream-index: "004" + storage_name: type: string - x-stream-index: "002" - privacy_settings: - $ref: '#/components/schemas/PrivacySettingsResponse' x-stream-index: "007" + video_orientation_hint: + $ref: '#/components/schemas/VideoOrientation' + x-stream-index: "009" + type: object + RejectCallRequest: + nullable: true + properties: + reason: + description: Reason for rejecting the call + title: Reason + type: string + x-stream-index: "003" + title: RejectCallRequest + type: object + RejectCallResponse: + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "001.001" required: - - id - title: UserRequest + - duration + title: RejectCallResponse type: object - UserResponse: - description: User response object + RejectFeedMemberInviteRequest: + nullable: true + title: Reject Feed Member Request + type: object + RejectFeedMemberInviteResponse: + nullable: true properties: - avg_response_time: - format: int32 - type: integer - x-stream-index: "001.018" - banned: - description: Whether a user is banned or not - title: Banned - type: boolean - x-stream-index: "001.012" - blocked_user_ids: - items: - type: string - type: array - x-stream-index: "001.017" + duration: + type: string + x-stream-index: "002.001" + member: + $ref: '#/components/schemas/FeedMemberResponse' + description: The feed member after rejecting the invite + title: Feed Member + x-stream-index: "001" + required: + - member + - duration + title: Reject Feed Member Response + type: object + RejectFollowRequest: + nullable: true + properties: + source: + description: Fully qualified ID of the source feed + maxLength: 255 + title: Source Feed ID + type: string + x-stream-index: "001" + target: + description: Fully qualified ID of the target feed + maxLength: 255 + title: Target Feed ID + type: string + x-stream-index: "002" + required: + - source + - target + title: Reject Follow Request + type: object + RejectFollowResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + follow: + $ref: '#/components/schemas/FollowResponse' + description: The rejected follow relationship + title: Follow + x-stream-index: "001" + required: + - follow + - duration + title: Reject Follow Response + type: object + ReminderCreatedEvent: + description: Emitted when a reminder is created. + nullable: true + properties: + cid: + description: The CID of the Channel for which the reminder was created + title: Channel CID + type: string + x-stream-index: "001.004" created_at: description: Date/time of creation format: date-time title: Created at type: number - x-stream-index: "001.009" + x-stream-index: 001.001.003 custom: additionalProperties: {} - description: Custom data for this object - title: Custom data type: object - x-stream-index: "001.004" - deactivated_at: - description: Date of deactivation - format: date-time - title: Deactivated at - type: number - x-stream-index: "001.016" - deleted_at: - description: Date/time of deletion - format: date-time - title: Deleted at - type: number - x-stream-index: "001.011" - id: - description: Unique user identifier - title: ID - type: string - x-stream-index: "001.001" - image: - title: Image + x-stream-index: 001.001.007 + message_id: + description: The ID of the message for which the reminder was created + title: Message ID type: string - x-stream-index: "001.003" - language: - description: Preferred language of a user - title: Language + x-stream-index: "001.002" + parent_id: + description: The ID of the parent message, if the reminder is for a thread + message + title: Parent ID type: string x-stream-index: "001.005" - last_active: - description: Date of last activity + received_at: format: date-time - title: Last active type: number - x-stream-index: "001.014" - name: - description: Optional name of user - title: Name + x-stream-index: 001.001.004 + reminder: + $ref: '#/components/schemas/ReminderResponseData' + description: The reminder object which was created + title: MessageReminder + x-stream-index: "001.006" + type: + default: reminder.created + description: 'The type of event: "reminder.created" in this case' + title: Event Type type: string - x-stream-index: "001.002" - online: - description: Whether a user online or not - title: Online - type: boolean - x-stream-index: "001.013" - revoke_tokens_issued_before: - description: Revocation date for tokens - format: date-time - title: Revoke tokens issued before - type: number - x-stream-index: "001.015" - role: - description: Determines the set of user permissions - title: Role + x-stream-index: 001.001.002 + user_id: + description: The ID of the user for whom the reminder was created + title: User ID type: string - x-stream-index: "001.006" - teams: - description: List of teams user is a part of - items: - type: string - title: Teams - type: array - x-stream-index: "001.007" - teams_role: - additionalProperties: - type: string - type: object - x-stream-index: "001.008" - updated_at: - description: Date/time of the last update - format: date-time - title: Updated at - type: number - x-stream-index: "001.010" + x-stream-index: "001.003" required: - - id - - custom - - language - - role - - teams + - type - created_at - - updated_at - - banned - - online - - blocked_user_ids - - shadow_banned - - invisible - title: UserResponse + - custom + - message_id + - user_id + - cid + title: ReminderCreatedEvent type: object - UserResponseCommonFields: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + ReminderDeletedEvent: + description: Emitted when a reminder is deleted. + nullable: true properties: - avg_response_time: - format: int32 - type: integer - x-stream-index: "018" - banned: - type: boolean - x-stream-index: "012" - blocked_user_ids: - items: - type: string - type: array - x-stream-index: "017" + cid: + description: The CID of the Channel for which the reminder was created + title: Channel CID + type: string + x-stream-index: "001.004" created_at: + description: Date/time of creation format: date-time + title: Created at type: number - x-stream-index: "009" + x-stream-index: 001.001.003 custom: additionalProperties: {} type: object - x-stream-index: "004" - deactivated_at: - format: date-time - type: number - x-stream-index: "016" - deleted_at: - format: date-time - type: number - x-stream-index: "011" - id: - type: string - x-stream-index: "001" - image: + x-stream-index: 001.001.007 + message_id: + description: The ID of the message for which the reminder was created + title: Message ID type: string - x-stream-index: "003" - language: + x-stream-index: "001.002" + parent_id: + description: The ID of the parent message, if the reminder is for a thread + message + title: Parent ID type: string - x-stream-index: "005" - last_active: + x-stream-index: "001.005" + received_at: format: date-time type: number - x-stream-index: "014" - name: + x-stream-index: 001.001.004 + reminder: + $ref: '#/components/schemas/ReminderResponseData' + description: The reminder object which was created + title: MessageReminder + x-stream-index: "001.006" + type: + default: reminder.deleted + description: 'The type of event: "reminder.deleted" in this case' + title: Event Type type: string - x-stream-index: "002" - online: - type: boolean - x-stream-index: "013" - revoke_tokens_issued_before: - format: date-time - type: number - x-stream-index: "015" - role: + x-stream-index: 001.001.002 + user_id: + description: The ID of the user for whom the reminder was created + title: User ID type: string - x-stream-index: "006" - teams: - items: - type: string - type: array - x-stream-index: "007" - teams_role: - additionalProperties: - type: string - type: object - x-stream-index: "008" - updated_at: - format: date-time - type: number - x-stream-index: "010" + x-stream-index: "001.003" required: - - id - - custom - - language - - role - - teams + - type - created_at - - updated_at - - banned - - online - - blocked_user_ids + - custom + - message_id + - user_id + - cid + title: ReminderDeletedEvent type: object - UserResponsePrivacyFields: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + ReminderNotificationEvent: + description: Emitted when a reminder becomes due, triggering a notification + for the user. + nullable: true properties: - avg_response_time: - format: int32 - type: integer - x-stream-index: "001.018" - banned: - type: boolean - x-stream-index: "001.012" - blocked_user_ids: - items: - type: string - type: array - x-stream-index: "001.017" + cid: + description: The CID of the Channel for which the reminder was created + title: Channel CID + type: string + x-stream-index: "001.004" created_at: + description: Date/time of creation format: date-time + title: Created at type: number - x-stream-index: "001.009" + x-stream-index: 001.001.003 custom: additionalProperties: {} type: object - x-stream-index: "001.004" - deactivated_at: - format: date-time - type: number - x-stream-index: "001.016" - deleted_at: - format: date-time - type: number - x-stream-index: "001.011" - id: - type: string - x-stream-index: "001.001" - image: + x-stream-index: 001.001.007 + message_id: + description: The ID of the message for which the reminder was created + title: Message ID type: string - x-stream-index: "001.003" - invisible: - type: boolean - x-stream-index: "003" - language: + x-stream-index: "001.002" + parent_id: type: string x-stream-index: "001.005" - last_active: + received_at: format: date-time type: number - x-stream-index: "001.014" - name: + x-stream-index: 001.001.004 + reminder: + $ref: '#/components/schemas/ReminderResponseData' + description: The reminder object which was created + title: MessageReminder + x-stream-index: "001.006" + type: + default: notification.reminder_due + description: 'The type of event: "notification.reminder_due" in this case' + title: Event Type type: string - x-stream-index: "001.002" - online: - type: boolean - x-stream-index: "001.013" - privacy_settings: - $ref: '#/components/schemas/PrivacySettingsResponse' - x-stream-index: "002" - revoke_tokens_issued_before: - format: date-time - type: number - x-stream-index: "001.015" - role: + x-stream-index: 001.001.002 + user_id: + description: The ID of the user for whom the reminder was created + title: User ID type: string - x-stream-index: "001.006" - teams: - items: - type: string - type: array - x-stream-index: "001.007" - teams_role: - additionalProperties: - type: string - type: object - x-stream-index: "001.008" - updated_at: - format: date-time - type: number - x-stream-index: "001.010" + x-stream-index: "001.003" required: - - id - - custom - - language - - role - - teams + - type - created_at - - updated_at - - banned - - online - - blocked_user_ids - type: object - UserRuleParameters: - properties: - max_age: - type: string - x-stream-index: "001" + - custom + - message_id + - user_id + - cid + title: ReminderNotificationEvent type: object - UserUnbannedEvent: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + ReminderResponseData: properties: - channel_id: - type: string - x-stream-index: "002.002" - channel_type: - type: string - x-stream-index: "002.003" - cid: + channel: + $ref: '#/components/schemas/ChannelResponse' + x-stream-index: "003" + channel_cid: type: string - x-stream-index: "002.001" + x-stream-index: "002" created_at: format: date-time type: number - x-stream-index: "005.002" - shadow: - type: boolean - x-stream-index: "001" - team: - type: string - x-stream-index: "004.001" - type: - default: user.unbanned + x-stream-index: "008" + message: + $ref: '#/components/schemas/Message' + x-stream-index: "005" + message_id: type: string - x-stream-index: "005.001" + x-stream-index: "004" + remind_at: + format: date-time + type: number + x-stream-index: "001" + updated_at: + format: date-time + type: number + x-stream-index: "009" user: $ref: '#/components/schemas/User' - x-stream-index: "003.001" + x-stream-index: "007" + user_id: + type: string + x-stream-index: "006" required: - - shadow - - cid - - channel_id - - channel_type - - type + - channel_cid + - message_id + - user_id - created_at - title: UserUnbannedEvent + - updated_at 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 - UserUpdatedEvent: - description: This event is sent when a user gets updated. The event contains - information about the updated user. + ReminderUpdatedEvent: + description: Emitted when a reminder is updated. nullable: true properties: + cid: + description: The CID of the Channel for which the reminder was created + title: Channel CID + type: string + x-stream-index: "001.004" created_at: description: Date/time of creation format: date-time title: Created at type: number - x-stream-index: "001.003" + x-stream-index: 001.001.003 custom: additionalProperties: {} type: object - x-stream-index: "001.007" + x-stream-index: 001.001.007 + message_id: + description: The ID of the message for which the reminder was created + title: Message ID + type: string + x-stream-index: "001.002" + parent_id: + description: The ID of the parent message, if the reminder is for a thread + message + title: Parent ID + type: string + x-stream-index: "001.005" received_at: format: date-time type: number - x-stream-index: "001.004" + x-stream-index: 001.001.004 + reminder: + $ref: '#/components/schemas/ReminderResponseData' + description: The reminder object which was created + title: MessageReminder + x-stream-index: "001.006" type: - default: user.updated - description: 'The type of event: "user.updated" in this case' + default: reminder.updated + description: 'The type of event: "reminder.updated" in this case' title: Event Type type: string - x-stream-index: "001.002" - user: - $ref: '#/components/schemas/UserResponsePrivacyFields' - description: The updated user - title: User - x-stream-index: "002.001" + x-stream-index: 001.001.002 + user_id: + description: The ID of the user for whom the reminder was created + title: User ID + type: string + x-stream-index: "001.003" required: - type - created_at - custom - - user - title: UserUpdatedEvent + - message_id + - user_id + - cid + title: ReminderUpdatedEvent 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 - UserWatchingStartEvent: + RepliesMeta: + description: Cursor & depth information for a comment's direct replies. Mirrors + Reddit's 'load more replies' semantics. properties: - channel_id: - type: string - x-stream-index: "004.002" - channel_type: - type: string - x-stream-index: "004.003" - cid: - type: string - x-stream-index: "004.001" - created_at: - format: date-time - type: number - x-stream-index: "003.002" - team: - type: string - x-stream-index: "002.001" - type: - default: user.watching.start + depth_truncated: + description: True if the subtree was cut because the requested depth was + reached. + title: Depth Truncated + type: boolean + x-stream-index: "004" + has_more: + description: True if more siblings exist in the database. + title: Has More + type: boolean + x-stream-index: "001" + next_cursor: + description: Opaque cursor to request the next page of siblings. + title: Next Cursor type: string - x-stream-index: "003.001" - user: - $ref: '#/components/schemas/User' - x-stream-index: "005.001" - watcher_count: + x-stream-index: "002" + remaining: + description: Number of unread siblings that match current filters. format: int32 + title: Remaining type: integer - x-stream-index: "001.001" + x-stream-index: "003" required: - - watcher_count - - type - - created_at - - cid - - channel_id - - channel_type - title: UserWatchingStartEvent + - has_more + - remaining + - depth_truncated + title: Replies Meta 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 - UserWatchingStopEvent: + ReportByHistogramBucket: properties: - channel_id: - type: string - x-stream-index: "004.002" - channel_type: - type: string - x-stream-index: "004.003" - cid: + category: type: string - x-stream-index: "004.001" - created_at: - format: date-time - type: number - x-stream-index: "002.002" - type: - default: user.watching.stop - type: string - x-stream-index: "002.001" - user: - $ref: '#/components/schemas/User' - x-stream-index: "003.001" - watcher_count: - format: int32 - type: integer - x-stream-index: "001.001" - required: - - watcher_count - - type - - created_at - - cid - - channel_id - - channel_type - title: UserWatchingStopEvent - 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 - VelocityFilterConfig: - properties: - advanced_filters: - type: boolean - x-stream-index: "007" - async: - type: boolean x-stream-index: "001" - cascading_actions: - type: boolean - x-stream-index: "004" - cids_per_user: + count: format: int32 type: integer - x-stream-index: "006" - enabled: - type: boolean - x-stream-index: "002" - first_message_only: - type: boolean x-stream-index: "005" - rules: - items: - $ref: '#/components/schemas/VelocityFilterConfigRule' - type: array - x-stream-index: "003" - required: - - enabled - - rules - - cascading_actions - - first_message_only - - cids_per_user - - advanced_filters - type: object - VelocityFilterConfigRule: - properties: - action: - enum: - - flag - - shadow - - remove - - ban - type: string - x-stream-index: "001" - ban_duration: - format: int32 - type: integer + lower_bound: + $ref: '#/components/schemas/Bound' x-stream-index: "002" - cascading_action: - enum: - - flag - - shadow - - remove - - ban - type: string - x-stream-index: "006" - cascading_threshold: - format: int64 - type: integer - x-stream-index: "005" - check_message_context: - type: boolean - x-stream-index: "009" - fast_spam_threshold: - format: int32 - type: integer - x-stream-index: "007" - fast_spam_ttl: - format: int32 - type: integer - x-stream-index: "010" - ip_ban: - type: boolean + sum: + format: float + type: number x-stream-index: "004" - probation_period: - format: int32 - type: integer - x-stream-index: "014" - shadow_ban: - type: boolean + upper_bound: + $ref: '#/components/schemas/Bound' x-stream-index: "003" - slow_spam_ban_duration: - format: int32 - type: integer - x-stream-index: "012" - slow_spam_threshold: - format: int32 - type: integer - x-stream-index: "008" - slow_spam_ttl: - format: int32 - type: integer - x-stream-index: "011" - url_only: - type: boolean - x-stream-index: "013" required: - - action - - ban_duration - - shadow_ban - - ip_ban - - cascading_threshold - - cascading_action - - fast_spam_threshold - - slow_spam_threshold - - check_message_context - - fast_spam_ttl - - slow_spam_ttl - - url_only - - probation_period + - category + - sum + - count type: object - VideoCallRuleConfig: + ReportResponse: properties: - rules: - additionalProperties: - $ref: '#/components/schemas/HarmConfig' - type: object + call: + $ref: '#/components/schemas/CallReportResponse' + x-stream-index: "003" + participants: + $ref: '#/components/schemas/ParticipantReportResponse' x-stream-index: "001" + user_ratings: + $ref: '#/components/schemas/UserRatingReportResponse' + x-stream-index: "002" required: - - rules + - participants + - user_ratings + - call type: object - VideoContentParameters: + RequestPermissionRequest: + nullable: true properties: - harm_labels: + permissions: items: type: string + title: Permissions type: array - x-stream-index: "001" - type: object - VideoEndCallRequest: - type: object - VideoKickUserRequest: - type: object - VideoOrientation: - properties: - orientation: - type: integer - x-stream-index: "004" + x-stream-index: "003" + required: + - permissions + title: RequestPermissionRequest type: object - VideoReactionOverTimeResponse: + RequestPermissionResponse: + nullable: true properties: - by_minute: - items: - $ref: '#/components/schemas/CountByMinuteResponse' - type: array - x-stream-index: "001" + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "001.001" + required: + - duration + title: RequestPermissionResponse type: object - VideoReactionsResponse: + Response: + description: Basic response information nullable: true properties: - count_over_time: - $ref: '#/components/schemas/VideoReactionOverTimeResponse' - x-stream-index: "002" - reaction: + duration: + description: Duration of the request in milliseconds + title: Duration type: string x-stream-index: "001" required: - - reaction + - duration + title: Response type: object - VideoRuleParameters: + RestoreActionRequest: + type: object + ReviewQueueItem: properties: - harm_labels: + actions: items: - type: string + $ref: '#/components/schemas/ActionLog' type: array - x-stream-index: "003" - threshold: + x-stream-index: "035" + activity: + $ref: '#/components/schemas/EnrichedActivity' + x-stream-index: "028" + ai_text_severity: + type: string + x-stream-index: "021" + archived_at: + $ref: '#/components/schemas/NullTime' + x-stream-index: "043" + assigned_to: + $ref: '#/components/schemas/User' + x-stream-index: "032" + bans: + items: + $ref: '#/components/schemas/Ban' + type: array + x-stream-index: "033" + bounce_count: format: int32 type: integer - x-stream-index: "001" - time_window: + x-stream-index: "025" + call: + $ref: '#/components/schemas/Call' + x-stream-index: "031" + completed_at: + $ref: '#/components/schemas/NullTime' + x-stream-index: "018" + config_key: type: string - x-stream-index: "002" - required: - - threshold - - time_window - type: object - VideoSettings: - properties: - access_request_enabled: - type: boolean - x-stream-index: "002" - camera_default_on: + x-stream-index: "009" + content_changed: type: boolean + x-stream-index: "036" + created_at: + format: date-time + type: number x-stream-index: "004" - camera_facing: - enum: - - front - - back - - external + entity_creator: + $ref: '#/components/schemas/EntityCreator' + x-stream-index: "030" + entity_id: type: string - x-stream-index: "005" - enabled: - type: boolean - x-stream-index: "001" - target_resolution: - $ref: '#/components/schemas/TargetResolution' - x-stream-index: "003" - required: - - enabled - - access_request_enabled - - target_resolution - - camera_default_on - - camera_facing - type: object - VideoSettingsRequest: - properties: - access_request_enabled: - type: boolean - x-stream-index: "002" - camera_default_on: - type: boolean - x-stream-index: "004" - camera_facing: - enum: - - front - - back - - external + x-stream-index: "007" + entity_type: type: string - x-stream-index: "005" - enabled: + x-stream-index: "006" + feeds_v2_activity: + $ref: '#/components/schemas/EnrichedActivity' + x-stream-index: "041" + feeds_v2_reaction: + $ref: '#/components/schemas/Reaction' + x-stream-index: "042" + flag_labels: + items: + type: string + type: array + x-stream-index: "045" + flag_types: + items: + type: string + type: array + x-stream-index: "044" + flags: + items: + $ref: '#/components/schemas/Flag' + type: array + x-stream-index: "034" + flags_count: + format: int32 + type: integer + x-stream-index: "026" + has_image: type: boolean - x-stream-index: "001" - target_resolution: - $ref: '#/components/schemas/TargetResolution' - x-stream-index: "003" - type: object - VideoSettingsResponse: - properties: - access_request_enabled: + x-stream-index: "012" + has_text: type: boolean - x-stream-index: "002" - camera_default_on: + x-stream-index: "014" + has_video: type: boolean - x-stream-index: "004" - camera_facing: - enum: - - front - - back - - external + x-stream-index: "013" + id: type: string - x-stream-index: "005" - enabled: - type: boolean - x-stream-index: "001" - target_resolution: - $ref: '#/components/schemas/TargetResolution' x-stream-index: "003" - required: - - enabled - - access_request_enabled - - target_resolution - - camera_default_on - - camera_facing - type: object - VoteData: - properties: - answer_text: + languages: + items: + type: string + type: array + x-stream-index: "019" + message: + $ref: '#/components/schemas/Message' + x-stream-index: "027" + moderation_payload: + $ref: '#/components/schemas/ModerationPayload' + x-stream-index: "010" + moderation_payload_hash: type: string - x-stream-index: "002" - option_id: - maxLength: 255 + x-stream-index: "011" + reaction: + $ref: '#/components/schemas/Reaction' + x-stream-index: "029" + recommended_action: type: string - x-stream-index: "001" + x-stream-index: "017" + reporter_ids: + items: + type: string + type: array + x-stream-index: "046" + reviewed_at: + $ref: '#/components/schemas/NullTime' + x-stream-index: "022" + reviewed_by: + type: string + x-stream-index: "023" + severity: + format: int32 + type: integer + x-stream-index: "020" + status: + type: string + x-stream-index: "016" + teams: + items: + type: string + type: array + x-stream-index: "015" + updated_at: + format: date-time + type: number + x-stream-index: "005" + required: + - id + - created_at + - updated_at + - entity_type + - entity_id + - config_key + - moderation_payload_hash + - has_image + - has_video + - has_text + - teams + - status + - recommended_action + - completed_at + - languages + - severity + - ai_text_severity + - reviewed_at + - reviewed_by + - bounce_count + - flags_count + - bans + - flags + - actions + - content_changed + - archived_at + - flag_types + - flag_labels + - reporter_ids type: object - WSAuthMessage: - description: Websocket auth message + ReviewQueueItemResponse: nullable: true properties: - products: + actions: + description: Moderation actions taken items: - type: string + $ref: '#/components/schemas/ActionLogResponse' + title: Actions type: array - x-stream-index: "003" - token: - title: Token + x-stream-index: "024" + activity: + $ref: '#/components/schemas/EnrichedActivity' + x-stream-index: "016" + ai_text_severity: + description: AI-determined text severity + title: AI Text Severity + type: string + x-stream-index: "014" + assigned_to: + $ref: '#/components/schemas/UserResponse' + description: Moderator assigned to review this item + title: Assigned To + x-stream-index: "021" + bans: + description: Associated ban records + items: + $ref: '#/components/schemas/Ban' + title: Bans + type: array + x-stream-index: "022" + call: + $ref: '#/components/schemas/CallResponse' + x-stream-index: "018" + completed_at: + description: When the review was completed + format: date-time + title: Completed At + type: number + x-stream-index: "009" + config_key: type: string + x-stream-index: "028" + created_at: + description: When the item was created + format: date-time + title: Created At + type: number x-stream-index: "002" - user_details: - $ref: '#/components/schemas/ConnectUserDetailsRequest' - x-stream-index: "001" - required: - - user_details - - token - title: WSAuthMessage - type: object - WSClientEvent: - description: The discriminator object for all websocket client events, it maps - events' payload to the final type - discriminator: - mapping: + entity_creator: + $ref: '#/components/schemas/EntityCreatorResponse' + description: Details about who created the entity + title: Entity Creator + x-stream-index: "019" + entity_creator_id: + description: ID of who created the entity + title: Entity Creator ID + type: string + x-stream-index: "020" + entity_id: + description: ID of the entity being reviewed + title: Entity ID + type: string + x-stream-index: "005" + entity_type: + description: Type of entity being reviewed + title: Entity Type + type: string + x-stream-index: "004" + feeds_v2_activity: + $ref: '#/components/schemas/EnrichedActivity' + description: Associated feed activity + title: Feeds V2 Activity + x-stream-index: "025" + feeds_v2_reaction: + $ref: '#/components/schemas/Reaction' + description: Associated feed reaction + title: Feeds V2 Reaction + x-stream-index: "026" + flags: + description: Associated flag records + items: + $ref: '#/components/schemas/ModerationFlagResponse' + title: Flags + type: array + x-stream-index: "023" + flags_count: + format: int32 + type: integer + x-stream-index: "029" + id: + description: Unique identifier of the review queue item + title: ID + type: string + x-stream-index: "001" + languages: + description: Detected languages in the content + items: + type: string + title: Languages + type: array + x-stream-index: "012" + message: + $ref: '#/components/schemas/MessageResponse' + description: Associated message details + title: Message + x-stream-index: "015" + moderation_payload: + $ref: '#/components/schemas/ModerationPayload' + description: Content being moderated + title: Moderation Payload + x-stream-index: "006" + reaction: + $ref: '#/components/schemas/Reaction' + x-stream-index: "017" + recommended_action: + description: Suggested moderation action + title: Recommended Action + type: string + x-stream-index: "008" + reviewed_at: + description: When the item was reviewed + format: date-time + title: Reviewed At + type: number + x-stream-index: "010" + reviewed_by: + description: ID of the moderator who reviewed the item + title: Reviewed By + type: string + x-stream-index: "011" + severity: + description: Severity level of the content + format: int32 + title: Severity + type: integer + x-stream-index: "013" + status: + description: Current status of the review + title: Status + type: string + x-stream-index: "007" + teams: + description: Teams associated with this item + items: + type: string + title: Teams + type: array + x-stream-index: "027" + updated_at: + description: When the item was last updated + format: date-time + title: Updated At + type: number + x-stream-index: "003" + required: + - id + - created_at + - updated_at + - entity_type + - entity_id + - status + - recommended_action + - reviewed_by + - languages + - severity + - ai_text_severity + - bans + - flags + - actions + - flags_count + type: object + RingSettings: + properties: + auto_cancel_timeout_ms: + format: int32 + type: integer + x-stream-index: "002" + incoming_call_timeout_ms: + format: int32 + type: integer + x-stream-index: "001" + missed_call_timeout_ms: + format: int32 + type: integer + x-stream-index: "003" + required: + - incoming_call_timeout_ms + - auto_cancel_timeout_ms + - missed_call_timeout_ms + type: object + RingSettingsRequest: + properties: + auto_cancel_timeout_ms: + description: When none of the callees accept a ring call in this time a + rejection will be sent by the caller with reason 'timeout' by the SDKs + format: int32 + maximum: 180000 + minimum: 5000 + title: AutoCancelTimeoutMs + type: integer + x-stream-index: "002" + incoming_call_timeout_ms: + description: When a callee is online but doesn't answer a ring call in this + time a rejection will be sent with reason 'timeout' by the SDKs + format: int32 + maximum: 180000 + minimum: 5000 + title: IncomingCallTimeoutMs + type: integer + x-stream-index: "001" + missed_call_timeout_ms: + description: When a callee doesn't accept or reject a ring call in this + time a missed call event will be sent + format: int32 + maximum: 180000 + minimum: 5000 + title: MissedCallTimeoutMs + type: integer + x-stream-index: "003" + required: + - incoming_call_timeout_ms + - auto_cancel_timeout_ms + title: RingSettingsRequest + type: object + RingSettingsResponse: + properties: + auto_cancel_timeout_ms: + format: int32 + type: integer + x-stream-index: "002" + incoming_call_timeout_ms: + format: int32 + type: integer + x-stream-index: "001" + missed_call_timeout_ms: + format: int32 + type: integer + x-stream-index: "003" + required: + - incoming_call_timeout_ms + - auto_cancel_timeout_ms + - missed_call_timeout_ms + type: object + RuleBuilderAction: + properties: + ban_options: + $ref: '#/components/schemas/BanOptions' + x-stream-index: "002" + flag_content_options: + $ref: '#/components/schemas/FlagContentOptions' + x-stream-index: "004" + flag_user_options: + $ref: '#/components/schemas/FlagUserOptions' + x-stream-index: "003" + remove_content_options: + $ref: '#/components/schemas/BlockContentOptions' + x-stream-index: "005" + type: + type: string + x-stream-index: "001" + type: object + RuleBuilderCondition: + properties: + confidence: + format: float + type: number + x-stream-index: "002" + content_count_rule_params: + $ref: '#/components/schemas/ContentCountRuleParameters' + x-stream-index: "007" + image_content_params: + $ref: '#/components/schemas/ImageContentParameters' + x-stream-index: "009" + image_rule_params: + $ref: '#/components/schemas/ImageRuleParameters' + x-stream-index: "004" + text_content_params: + $ref: '#/components/schemas/TextContentParameters' + x-stream-index: "008" + text_rule_params: + $ref: '#/components/schemas/TextRuleParameters' + x-stream-index: "003" + type: + type: string + x-stream-index: "001" + user_created_within_params: + $ref: '#/components/schemas/UserCreatedWithinParameters' + x-stream-index: "011" + user_custom_property_params: + $ref: '#/components/schemas/UserCustomPropertyParameters' + x-stream-index: "012" + user_rule_params: + $ref: '#/components/schemas/UserRuleParameters' + x-stream-index: "006" + video_content_params: + $ref: '#/components/schemas/VideoContentParameters' + x-stream-index: "010" + video_rule_params: + $ref: '#/components/schemas/VideoRuleParameters' + x-stream-index: "005" + type: object + RuleBuilderConditionGroup: + properties: + conditions: + items: + $ref: '#/components/schemas/RuleBuilderCondition' + type: array + x-stream-index: "002" + logic: + type: string + x-stream-index: "001" + type: object + RuleBuilderConfig: + properties: + async: + type: boolean + x-stream-index: "001" + rules: + items: + $ref: '#/components/schemas/RuleBuilderRule' + type: array + x-stream-index: "002" + type: object + RuleBuilderRule: + properties: + action: + $ref: '#/components/schemas/RuleBuilderAction' + x-stream-index: "006" + conditions: + items: + $ref: '#/components/schemas/RuleBuilderCondition' + type: array + x-stream-index: "003" + cooldown_period: + type: string + x-stream-index: "007" + groups: + items: + $ref: '#/components/schemas/RuleBuilderConditionGroup' + type: array + x-stream-index: "005" + id: + type: string + x-stream-index: "001" + logic: + type: string + x-stream-index: "004" + rule_type: + type: string + x-stream-index: "002" + required: + - rule_type + - action + type: object + SDKUsageReport: + properties: + per_sdk_usage: + additionalProperties: + $ref: '#/components/schemas/PerSDKUsageReport' + type: object + x-stream-index: "001" + required: + - per_sdk_usage + type: object + SDKUsageReportResponse: + properties: + daily: + items: + $ref: '#/components/schemas/DailyAggregateSDKUsageReportResponse' + type: array + x-stream-index: "001" + required: + - daily + type: object + SFUIDLastSeen: + properties: + id: + type: string + x-stream-index: "001.001" + last_seen: + format: date-time + type: number + x-stream-index: "002" + process_start_time: + format: int64 + type: integer + x-stream-index: "001.002" + required: + - id + - process_start_time + - last_seen + type: object + SFUResponse: + properties: + edge_name: + type: string + x-stream-index: "001" + url: + type: string + x-stream-index: "002" + ws_endpoint: + type: string + x-stream-index: "003" + required: + - edge_name + - url + - ws_endpoint + type: object + STTEgressConfig: + properties: + closed_captions_enabled: + type: boolean + x-stream-index: "005" + external_storage: + $ref: '#/components/schemas/ExternalStorage' + x-stream-index: "011" + language: + type: string + x-stream-index: "008" + storage_name: + type: string + x-stream-index: "010" + translation_languages: + items: + type: string + type: array + x-stream-index: "009" + translations_enabled: + type: boolean + x-stream-index: "006" + upload_transcriptions: + type: boolean + x-stream-index: "004" + whisper_server_base_url: + type: string + x-stream-index: "007" + type: object + ScreensharingSettings: + properties: + access_request_enabled: + type: boolean + x-stream-index: "002" + enabled: + type: boolean + x-stream-index: "001" + target_resolution: + $ref: '#/components/schemas/TargetResolution' + x-stream-index: "003" + required: + - enabled + - access_request_enabled + type: object + ScreensharingSettingsRequest: + properties: + access_request_enabled: + type: boolean + x-stream-index: "002" + enabled: + type: boolean + x-stream-index: "001" + target_resolution: + $ref: '#/components/schemas/TargetResolution' + x-stream-index: "003" + type: object + ScreensharingSettingsResponse: + properties: + access_request_enabled: + type: boolean + x-stream-index: "002" + enabled: + type: boolean + x-stream-index: "001" + target_resolution: + $ref: '#/components/schemas/TargetResolution' + x-stream-index: "003" + required: + - enabled + - access_request_enabled + type: object + SearchPayload: + properties: + filter_conditions: + additionalProperties: {} + description: Channel filter conditions + maximum: 100 + minimum: 1 + title: Channel filter + type: object + x-stream-docs-page-id: query_channels + x-stream-index: "002" + limit: + description: Number of messages to return + format: int32 + title: Limit + type: integer + x-stream-index: "005" + message_filter_conditions: + additionalProperties: {} + description: Message filter conditions + title: Message filter + type: object + x-stream-index: "003" + message_options: + $ref: '#/components/schemas/MessageOptions' + x-stream-index: "004" + next: + description: Pagination parameter. Cannot be used with non-zero offset. + title: Next + type: string + x-stream-index: "008" + offset: + description: Pagination offset. Cannot be used with sort or next. + format: int32 + title: Offset + type: integer + x-stream-index: "006" + query: + description: Search phrase + title: Query + type: string + x-stream-index: "001" + sort: + description: Sort parameters. Cannot be used with non-zero offset + items: + $ref: '#/components/schemas/SortParamRequest' + title: Sort + type: array + x-stream-index: "007" + required: + - filter_conditions + type: object + SearchResponse: + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "005.001" + next: + description: Value to pass to the next search query in order to paginate + title: Next + type: string + x-stream-index: "003" + previous: + description: Value that points to the previous page. Pass as the next value + in a search query to paginate backwards + title: Previous + type: string + x-stream-index: "004" + results: + description: Search results + items: + $ref: '#/components/schemas/SearchResult' + title: Results + type: array + x-stream-index: "001" + results_warning: + $ref: '#/components/schemas/SearchWarning' + description: Warning about the search results + title: Results Warning + x-stream-index: "002" + required: + - results + - duration + type: object + SearchResult: + properties: + message: + $ref: '#/components/schemas/SearchResultMessage' + description: Found message + title: Message + x-stream-index: "001" + type: object + SearchResultMessage: + properties: + attachments: + items: + $ref: '#/components/schemas/Attachment' + type: array + x-stream-index: "001.008" + channel: + $ref: '#/components/schemas/ChannelResponse' + description: Channel object + title: Channel + x-stream-index: "002" + cid: + type: string + x-stream-index: "001.022" + command: + type: string + x-stream-index: "001.004" + created_at: + format: date-time + type: number + x-stream-index: "001.023" + custom: + additionalProperties: {} + type: object + x-stream-index: "001.026" + deleted_at: + format: date-time + type: number + x-stream-index: "001.025" + deleted_for_me: + type: boolean + x-stream-index: "001.044" + deleted_reply_count: + format: int32 + type: integer + x-stream-index: "001.018" + draft: + $ref: '#/components/schemas/DraftResponse' + x-stream-index: "001.041" + html: + type: string + x-stream-index: "001.005" + i18n: + additionalProperties: + type: string + type: object + x-stream-index: "001.030" + id: + type: string + x-stream-index: "001.001" + image_labels: + additionalProperties: + items: + type: string + type: array + type: object + x-stream-index: "001.028" + latest_reactions: + items: + $ref: '#/components/schemas/ReactionResponse' + type: array + x-stream-index: "001.009" + mentioned_users: + items: + $ref: '#/components/schemas/UserResponse' + type: array + x-stream-index: "001.029" + message_text_updated_at: + format: date-time + type: number + x-stream-index: "001.036" + mml: + type: string + x-stream-index: "001.003" + moderation: + $ref: '#/components/schemas/ModerationV2Response' + x-stream-index: "001.039" + own_reactions: + items: + $ref: '#/components/schemas/ReactionResponse' + type: array + x-stream-index: "001.010" + parent_id: + type: string + x-stream-index: "001.015" + pin_expires: + format: date-time + type: number + x-stream-index: "001.035" + pinned: + type: boolean + x-stream-index: "001.032" + pinned_at: + format: date-time + type: number + x-stream-index: "001.033" + pinned_by: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "001.034" + poll: + $ref: '#/components/schemas/PollResponseData' + x-stream-index: "001.038" + poll_id: + type: string + x-stream-index: "001.037" + quoted_message: + $ref: '#/components/schemas/MessageResponse' + x-stream-index: "001.020" + quoted_message_id: + type: string + x-stream-index: "001.019" + reaction_counts: + additionalProperties: + format: int32 + type: integer + type: object + x-stream-index: "001.011" + reaction_groups: + additionalProperties: + $ref: '#/components/schemas/ReactionGroupResponse' + type: object + x-stream-index: "001.014" + reaction_scores: + additionalProperties: + format: int32 + type: integer + type: object + x-stream-index: "001.012" + reminder: + $ref: '#/components/schemas/ReminderResponseData' + x-stream-index: "001.042" + reply_count: + format: int32 + type: integer + x-stream-index: "001.017" + restricted_visibility: + items: + type: string + type: array + x-stream-index: "001.040" + shadowed: + type: boolean + x-stream-index: "001.027" + shared_location: + $ref: '#/components/schemas/SharedLocationResponseData' + x-stream-index: "001.043" + show_in_channel: + type: boolean + x-stream-index: "001.016" + silent: + type: boolean + x-stream-index: "001.031" + text: + type: string + x-stream-index: "001.002" + thread_participants: + items: + $ref: '#/components/schemas/UserResponse' + type: array + x-stream-index: "001.021" + type: + type: string + x-stream-index: "001.006" + updated_at: + format: date-time + type: number + x-stream-index: "001.024" + user: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "001.007" + required: + - id + - text + - html + - type + - user + - attachments + - latest_reactions + - own_reactions + - reaction_counts + - reaction_scores + - reply_count + - deleted_reply_count + - cid + - created_at + - updated_at + - custom + - shadowed + - mentioned_users + - silent + - pinned + - restricted_visibility + type: object + SearchWarning: + properties: + channel_search_cids: + description: Channel CIDs for the searched channels + items: + type: string + title: Channel Search CIDs + type: array + x-stream-index: "004" + channel_search_count: + description: Number of channels searched + format: int32 + title: Channel Search Count + type: integer + x-stream-index: "003" + warning_code: + description: Code corresponding to the warning + format: int32 + title: Warning Code + type: integer + x-stream-index: "002" + warning_description: + description: Description of the warning + title: Warning Description + type: string + x-stream-index: "001" + required: + - warning_description + - warning_code + type: object + SendCallEventRequest: + description: Send a call event to the other user + nullable: true + properties: + custom: + additionalProperties: {} + title: Custom + type: object + x-stream-index: "004" + title: SendCallEventRequest + type: object + SendCallEventResponse: + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "001.001" + required: + - duration + title: SendCallEventResponse + type: object + SendEventRequest: + nullable: true + properties: + event: + $ref: '#/components/schemas/EventRequest' + x-stream-index: "001" + required: + - event + type: object + SendMessageRequest: + nullable: true + properties: + keep_channel_hidden: + type: boolean + x-stream-index: "008" + message: + $ref: '#/components/schemas/MessageRequest' + x-stream-index: "001" + skip_enrich_url: + type: boolean + x-stream-index: "003" + skip_push: + type: boolean + x-stream-index: "002" + required: + - message + type: object + SendMessageResponse: + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "003.001" + message: + $ref: '#/components/schemas/MessageResponse' + description: Message response + title: Message + x-stream-index: "001" + pending_message_metadata: + additionalProperties: + type: string + description: Pending message metadata + title: Pending message metadata + type: object + x-stream-index: "002" + required: + - message + - duration + type: object + SendReactionRequest: + nullable: true + properties: + enforce_unique: + description: Whether to replace all existing user reactions + title: Enforce unique + type: boolean + x-stream-index: "003" + reaction: + $ref: '#/components/schemas/ReactionRequest' + x-stream-index: "002" + skip_push: + description: Skips any mobile push notifications + title: Skip push + type: boolean + x-stream-index: "004" + required: + - reaction + type: object + SendReactionResponse: + description: Basic response information + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "003.001" + message: + $ref: '#/components/schemas/MessageResponse' + x-stream-index: "001" + reaction: + $ref: '#/components/schemas/ReactionResponse' + x-stream-index: "002" + required: + - message + - reaction + - duration + title: Response + type: object + SessionSettings: + properties: + inactivity_timeout_seconds: + format: int32 + maximum: 900 + minimum: 5 + type: integer + x-stream-index: "001" + required: + - inactivity_timeout_seconds + type: object + SessionSettingsRequest: + properties: + inactivity_timeout_seconds: + format: int32 + maximum: 900 + minimum: 5 + type: integer + x-stream-index: "001" + required: + - inactivity_timeout_seconds + type: object + SessionSettingsResponse: + properties: + inactivity_timeout_seconds: + format: int32 + maximum: 900 + minimum: 5 + type: integer + x-stream-index: "001" + required: + - inactivity_timeout_seconds + type: object + ShadowBlockActionRequest: + type: object + SharedLocation: + properties: + channel: + $ref: '#/components/schemas/Channel' + x-stream-index: "013" + channel_cid: + type: string + x-stream-index: "003" + created_at: + format: date-time + type: number + x-stream-index: "010" + created_by_device_id: + type: string + x-stream-index: "008" + end_at: + format: date-time + type: number + x-stream-index: "009" + latitude: + format: float + maximum: 90 + minimum: 1.8446744073709552e+19 + type: number + x-stream-index: "006" + longitude: + format: float + maximum: 180 + minimum: 1.8446744073709552e+19 + type: number + x-stream-index: "007" + message: + $ref: '#/components/schemas/Message' + x-stream-index: "012" + message_id: + type: string + x-stream-index: "004" + updated_at: + format: date-time + type: number + x-stream-index: "011" + user_id: + type: string + x-stream-index: "005" + required: + - channel_cid + - message_id + - user_id + - created_by_device_id + - created_at + - updated_at + type: object + SharedLocationResponse: + nullable: true + properties: + channel: + $ref: '#/components/schemas/ChannelResponse' + x-stream-index: "001.011" + channel_cid: + description: Channel CID + title: string + type: string + x-stream-index: "001.001" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: "001.008" + created_by_device_id: + description: Device ID that created the live location + title: string + type: string + x-stream-index: "001.006" + duration: + type: string + x-stream-index: "002.001" + end_at: + description: Time when the live location expires + format: date-time + title: string + type: number + x-stream-index: "001.007" + latitude: + description: Latitude coordinate + format: float + title: number + type: number + x-stream-index: "001.004" + longitude: + description: Longitude coordinate + format: float + title: number + type: number + x-stream-index: "001.005" + message: + $ref: '#/components/schemas/MessageResponse' + x-stream-index: "001.010" + message_id: + description: Message ID + title: string + type: string + x-stream-index: "001.002" + updated_at: + description: Date/time of the last update + format: date-time + title: Updated at + type: number + x-stream-index: "001.009" + user_id: + description: User ID + title: string + type: string + x-stream-index: "001.003" + required: + - channel_cid + - message_id + - user_id + - latitude + - longitude + - created_by_device_id + - created_at + - updated_at + - duration + type: object + SharedLocationResponseData: + nullable: true + properties: + channel: + $ref: '#/components/schemas/ChannelResponse' + x-stream-index: "011" + channel_cid: + type: string + x-stream-index: "001" + created_at: + format: date-time + type: number + x-stream-index: "008" + created_by_device_id: + type: string + x-stream-index: "006" + end_at: + format: date-time + type: number + x-stream-index: "007" + latitude: + format: float + type: number + x-stream-index: "004" + longitude: + format: float + type: number + x-stream-index: "005" + message: + $ref: '#/components/schemas/MessageResponse' + x-stream-index: "010" + message_id: + type: string + x-stream-index: "002" + updated_at: + format: date-time + type: number + x-stream-index: "009" + user_id: + type: string + x-stream-index: "003" + required: + - channel_cid + - message_id + - user_id + - latitude + - longitude + - created_by_device_id + - created_at + - updated_at + type: object + SharedLocationsResponse: + nullable: true + properties: + active_live_locations: + items: + $ref: '#/components/schemas/SharedLocationResponseData' + type: array + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - active_live_locations + - duration + type: object + ShowChannelRequest: + nullable: true + type: object + ShowChannelResponse: + 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 + SingleFollowResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + follow: + $ref: '#/components/schemas/FollowResponse' + description: The created follow relationship + title: Follow + x-stream-index: "001" + required: + - follow + - duration + title: Follow Response + type: object + SortParam: + nullable: true + properties: + direction: + format: int32 + type: integer + x-stream-index: "002" + field: + type: string + x-stream-index: "001" + required: + - field + - direction + type: object + SortParamRequest: + nullable: true + properties: + direction: + description: Direction of sorting, 1 for Ascending, -1 for Descending, default + is 1 + format: int32 + title: Direction + type: integer + x-stream-index: "002" + field: + description: Name of field to sort by + title: Field + type: string + x-stream-index: "001" + type: object + StartClosedCaptionsRequest: + nullable: true + properties: + enable_transcription: + description: Enable transcriptions along with closed captions + title: Enable Transcription + type: boolean + x-stream-index: "002" + external_storage: + description: Which external storage to use for transcriptions (only applicable + if enable_transcription is true) + title: External Storage + type: string + x-stream-index: "003" + language: + description: The spoken language in the call, if not provided the language + defined in the transcription settings will be used + enum: + - auto + - en + - fr + - es + - de + - it + - nl + - pt + - pl + - ca + - cs + - da + - el + - fi + - id + - ja + - ru + - sv + - ta + - th + - tr + - hu + - ro + - zh + - ar + - tl + - he + - hi + - hr + - ko + - ms + - "no" + - uk + - bg + - et + - sl + - sk + title: Language + type: string + x-stream-index: "004" + type: object + StartClosedCaptionsResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "001.001" + required: + - duration + type: object + StartFrameRecordingRequest: + nullable: true + properties: + recording_external_storage: + type: string + x-stream-index: "002" + title: StartFrameRecordingRequest + type: object + StartFrameRecordingResponse: + description: StartFrameRecordingResponse is the response payload for the start + frame recording endpoint. + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "001.001" + required: + - duration + title: StartFrameRecordingResponse + type: object + StartHLSBroadcastingRequest: + description: StartHLSBroadcastingRequest is the payload for starting an HLS + broadcasting. + nullable: true + title: StartHLSBroadcastingRequest + type: object + StartHLSBroadcastingResponse: + description: StartHLSBroadcastingResponse is the payload for starting an HLS + broadcasting. + nullable: true + properties: + duration: + type: string + x-stream-index: "001.001" + playlist_url: + description: the URL of the HLS playlist + title: PlaylistURL + type: string + x-stream-index: "002" + required: + - duration + - playlist_url + title: StartHLSBroadcastingResponse + type: object + StartRTMPBroadcastsRequest: + description: StartRTMPBroadcastsRequest is the payload for starting RTMP broadcasts. + nullable: true + properties: + broadcasts: + description: List of broadcasts to start + items: + $ref: '#/components/schemas/RTMPBroadcastRequest' + maximum: 1 + minimum: 1 + title: Broadcasts + type: array + x-stream-index: "002" + required: + - broadcasts + title: StartRTMPBroadcastsRequest + type: object + StartRTMPBroadcastsResponse: + description: StartRTMPBroadcastsResponse is the payload for starting an RTMP + broadcast. + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "001.001" + required: + - duration + title: StartRTMPBroadcastsResponse + type: object + StartRecordingRequest: + nullable: true + properties: + recording_external_storage: + type: string + x-stream-index: "002" + title: StartRecordingRequest + type: object + StartRecordingResponse: + description: StartRecordingResponse is the response payload for the start recording + endpoint. + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "001.001" + required: + - duration + title: StartRecordingResponse + type: object + StartTranscriptionRequest: + nullable: true + properties: + enable_closed_captions: + description: Enable closed captions along with transcriptions + title: Enable Closed Captions + type: boolean + x-stream-index: "003" + language: + description: The spoken language in the call, if not provided the language + defined in the transcription settings will be used + enum: + - auto + - en + - fr + - es + - de + - it + - nl + - pt + - pl + - ca + - cs + - da + - el + - fi + - id + - ja + - ru + - sv + - ta + - th + - tr + - hu + - ro + - zh + - ar + - tl + - he + - hi + - hr + - ko + - ms + - "no" + - uk + - bg + - et + - sl + - sk + title: Language + type: string + x-stream-index: "004" + transcription_external_storage: + description: Store transcriptions in this external storage + title: External Storage + type: string + x-stream-index: "002" + type: object + StartTranscriptionResponse: + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "001.001" + required: + - duration + title: StartTranscriptionResponse + type: object + StatsOptions: + properties: + enable_rtc_stats: + type: boolean + x-stream-index: "002" + reporting_interval_ms: + format: int32 + type: integer + x-stream-index: "001" + required: + - reporting_interval_ms + - enable_rtc_stats + type: object + StopAllRTMPBroadcastsRequest: + nullable: true + title: StopAllRTMPBroadcastsRequest + type: object + StopAllRTMPBroadcastsResponse: + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "001.001" + required: + - duration + title: StopAllRTMPBroadcastsResponse + type: object + StopClosedCaptionsRequest: + nullable: true + properties: + stop_transcription: + type: boolean + x-stream-index: "003" + type: object + StopClosedCaptionsResponse: + 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 + StopFrameRecordingRequest: + nullable: true + type: object + StopFrameRecordingResponse: + 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 + StopHLSBroadcastingRequest: + nullable: true + type: object + StopHLSBroadcastingResponse: + 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 + StopLiveRequest: + nullable: true + properties: + continue_closed_caption: + type: boolean + x-stream-index: "006" + continue_hls: + type: boolean + x-stream-index: "003" + continue_recording: + type: boolean + x-stream-index: "004" + continue_rtmp_broadcasts: + type: boolean + x-stream-index: "007" + continue_transcription: + type: boolean + x-stream-index: "005" + title: StopLiveRequest + type: object + StopLiveResponse: + nullable: true + properties: + call: + $ref: '#/components/schemas/CallResponse' + description: The call that was stopped + title: Call + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - call + - duration + title: StopLiveResponse + type: object + StopRTMPBroadcastsRequest: + description: Request for stopping RTMP broadcasts + nullable: true + title: StopRTMPBroadcastsRequest + type: object + StopRTMPBroadcastsResponse: + 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 + StopRecordingRequest: + nullable: true + type: object + StopRecordingResponse: + 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 + StopTranscriptionRequest: + nullable: true + properties: + stop_closed_captions: + type: boolean + x-stream-index: "003" + type: object + StopTranscriptionResponse: + 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 + StoriesConfig: + properties: + expiration_behaviour: + enum: + - hide_for_everyone + - visible_for_author + type: string + x-stream-index: "001" + skip_watched: + type: boolean + x-stream-index: "002" + type: object + SubmitActionRequest: + nullable: true + properties: + action_type: + description: Type of moderation action to perform (mark_reviewed, delete_message, + etc.) + enum: + - mark_reviewed + - delete_message + - delete_activity + - delete_reaction + - ban + - custom + - unban + - restore + - delete_user + - unblock + - shadow_block + - unmask + - kick_user + - end_call + title: Action Type + type: string + x-stream-index: "002" + ban: + $ref: '#/components/schemas/BanActionRequest' + description: Configuration for ban action + title: Ban + x-stream-index: "008" + custom: + $ref: '#/components/schemas/CustomActionRequest' + description: Configuration for custom action + title: Custom + x-stream-index: "009" + delete_activity: + $ref: '#/components/schemas/DeleteActivityRequest' + description: Configuration for activity deletion action + title: Delete Activity + x-stream-index: "004" + delete_message: + $ref: '#/components/schemas/DeleteMessageRequest' + description: Configuration for message deletion action + title: Delete Message + x-stream-index: "003" + delete_reaction: + $ref: '#/components/schemas/DeleteReactionRequest' + description: Configuration for reaction deletion action + title: Delete Reaction + x-stream-index: "005" + delete_user: + $ref: '#/components/schemas/DeleteUserRequest' + description: Configuration for user deletion action + title: Delete User + x-stream-index: "006" + item_id: + description: UUID of the review queue item to act on + title: Item ID + type: string + x-stream-index: "001" + mark_reviewed: + $ref: '#/components/schemas/MarkReviewedRequest' + description: Configuration for marking item as reviewed + title: Mark Reviewed + x-stream-index: "007" + unban: + $ref: '#/components/schemas/UnbanActionRequest' + description: Configuration for unban action + title: Unban + x-stream-index: "010" + required: + - item_id + - action_type + type: object + SubmitActionResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + item: + $ref: '#/components/schemas/ReviewQueueItemResponse' + description: Updated review queue item after action was performed + title: Item + x-stream-index: "001" + required: + - duration + type: object + SubscriberStatsResponse: + properties: + total: + format: int32 + type: integer + x-stream-index: "001" + total_subscribed_duration_seconds: + format: int32 + type: integer + x-stream-index: "003" + unique: + format: int32 + type: integer + x-stream-index: "002" + required: + - total + - unique + - total_subscribed_duration_seconds + type: object + SyncRequest: + description: Sync request + nullable: true + properties: + channel_cids: + description: List of channel CIDs to sync + items: + type: string + maximum: 255 + minimum: 1 + title: Channel CIDs + type: array + x-stream-index: "001" + last_sync_at: + description: Date from which synchronization should happen + format: date-time + title: Last sync at + type: number + x-stream-index: "002" + required: + - channel_cids + - last_sync_at + title: SyncRequest + type: object + SyncResponse: + description: Sync response + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "003.001" + events: + description: List of events + items: + $ref: '#/components/schemas/WSEvent' + title: Events + type: array + x-stream-index: "001" + inaccessible_cids: + description: List of CIDs that user can't access + items: + type: string + title: Inaccessible CIDs + type: array + x-stream-index: "002" + required: + - events + - duration + title: SyncResponse + type: object + TargetResolution: + properties: + bitrate: + format: int32 + maximum: 6000000 + type: integer + x-stream-index: "003" + height: + format: int32 + maximum: 3840 + minimum: 240 + type: integer + x-stream-index: "002" + width: + format: int32 + maximum: 3840 + minimum: 240 + type: integer + x-stream-index: "001" + required: + - width + - height + type: object + TextContentParameters: + properties: + blocklist_match: + items: + type: string + type: array + x-stream-index: "005" + contains_url: + type: boolean + x-stream-index: "003" + harm_labels: + items: + type: string + type: array + x-stream-index: "001" + llm_harm_labels: + additionalProperties: + type: string + type: object + x-stream-index: "002" + severity: + type: string + x-stream-index: "004" + type: object + TextRuleParameters: + properties: + blocklist_match: + items: + type: string + type: array + x-stream-index: "007" + contains_url: + type: boolean + x-stream-index: "005" + harm_labels: + items: + type: string + type: array + x-stream-index: "003" + llm_harm_labels: + additionalProperties: + type: string + type: object + x-stream-index: "004" + severity: + type: string + x-stream-index: "006" + threshold: + format: int32 + type: integer + x-stream-index: "001" + time_window: + type: string + x-stream-index: "002" + type: object + ThreadParticipant: + description: Represents a user that is participating in a thread. + nullable: true + properties: + app_pk: + format: int32 + readOnly: true + type: integer + x-stream-index: "001" + channel_cid: + type: string + x-stream-index: "002" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: "007" + custom: + additionalProperties: {} + type: object + x-stream-index: "010" + last_read_at: + format: date-time + type: number + x-stream-index: "009" + last_thread_message_at: + format: date-time + type: number + x-stream-index: "003" + left_thread_at: + description: Left Thread At is the time when the user left the thread + format: date-time + title: Left Thread At + type: number + x-stream-index: "008" + thread_id: + description: Thead ID is unique string identifier of the thread + title: ID + type: string + x-stream-index: "004" + user: + $ref: '#/components/schemas/UserResponse' + description: User is the user object + title: User + x-stream-index: "006" + user_id: + description: User ID is unique string identifier of the user + title: User ID + type: string + x-stream-index: "005" + required: + - app_pk + - channel_cid + - created_at + - last_read_at + - custom + title: ThreadParticipant + type: object + ThreadResponse: + properties: + active_participant_count: + description: Active Participant Count + format: int32 + title: Active Participant Count + type: integer + x-stream-index: "009" + channel: + $ref: '#/components/schemas/ChannelResponse' + description: Channel + title: ChannelResponse + x-stream-index: "002" + channel_cid: + description: Channel CID + title: Channel CID + type: string + x-stream-index: "001" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: "012" + created_by: + $ref: '#/components/schemas/UserResponse' + description: Created By User + title: User + x-stream-index: "006" + created_by_user_id: + description: Created By User ID + title: Created By User ID + type: string + x-stream-index: "005" + custom: + additionalProperties: {} + description: Custom data for this object + title: Custom data + type: object + x-stream-index: "016" + deleted_at: + description: Deleted At + format: date-time + title: Deleted At + type: number + x-stream-index: "014" + last_message_at: + description: Last Message At + format: date-time + title: Last Message At + type: number + x-stream-index: "011" + parent_message: + $ref: '#/components/schemas/MessageResponse' + description: Parent Message + title: Message + x-stream-index: "004" + parent_message_id: + description: Parent Message ID + title: Parent Message ID + type: string + x-stream-index: "003" + participant_count: + description: Participant Count + format: int32 + title: Participant Count + type: integer + x-stream-index: "008" + reply_count: + description: Reply Count + format: int32 + title: Reply Count + type: integer + x-stream-index: "007" + thread_participants: + description: Thread Participants + items: + $ref: '#/components/schemas/ThreadParticipant' + title: ThreadParticipants + type: array + x-stream-index: "010" + title: + description: Title + title: Title + type: string + x-stream-index: "015" + updated_at: + description: Date/time of the last update + format: date-time + title: Updated at + type: number + x-stream-index: "013" + required: + - channel_cid + - parent_message_id + - created_by_user_id + - created_at + - updated_at + - title + - custom + type: object + ThreadStateResponse: + nullable: true + properties: + active_participant_count: + description: Active Participant Count + format: int32 + title: Active Participant Count + type: integer + x-stream-index: "001.009" + channel: + $ref: '#/components/schemas/ChannelResponse' + description: Channel + title: ChannelResponse + x-stream-index: "001.002" + channel_cid: + description: Channel CID + title: Channel CID + type: string + x-stream-index: "001.001" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: "001.012" + created_by: + $ref: '#/components/schemas/UserResponse' + description: Created By User + title: User + x-stream-index: "001.006" + created_by_user_id: + description: Created By User ID + title: Created By User ID + type: string + x-stream-index: "001.005" + custom: + additionalProperties: {} + description: Custom data for this object + title: Custom data + type: object + x-stream-index: "001.016" + deleted_at: + description: Deleted At + format: date-time + title: Deleted At + type: number + x-stream-index: "001.014" + draft: + $ref: '#/components/schemas/DraftResponse' + x-stream-index: "004" + last_message_at: + description: Last Message At + format: date-time + title: Last Message At + type: number + x-stream-index: "001.011" + latest_replies: + items: + $ref: '#/components/schemas/MessageResponse' + type: array + x-stream-index: "002" + parent_message: + $ref: '#/components/schemas/MessageResponse' + description: Parent Message + title: Message + x-stream-index: "001.004" + parent_message_id: + description: Parent Message ID + title: Parent Message ID + type: string + x-stream-index: "001.003" + participant_count: + description: Participant Count + format: int32 + title: Participant Count + type: integer + x-stream-index: "001.008" + read: + items: + $ref: '#/components/schemas/ReadStateResponse' + type: array + x-stream-index: "003" + reply_count: + description: Reply Count + format: int32 + title: Reply Count + type: integer + x-stream-index: "001.007" + thread_participants: + description: Thread Participants + items: + $ref: '#/components/schemas/ThreadParticipant' + title: ThreadParticipants + type: array + x-stream-index: "001.010" + title: + description: Title + title: Title + type: string + x-stream-index: "001.015" + updated_at: + description: Date/time of the last update + format: date-time + title: Updated at + type: number + x-stream-index: "001.013" + required: + - channel_cid + - parent_message_id + - created_by_user_id + - created_at + - updated_at + - title + - custom + - latest_replies + type: object + ThreadUpdatedEvent: + properties: + channel_id: + type: string + x-stream-index: "001.002" + channel_type: + type: string + x-stream-index: "001.003" + cid: + type: string + x-stream-index: "001.001" + created_at: + format: date-time + type: number + x-stream-index: "004.002" + thread: + $ref: '#/components/schemas/ThreadResponse' + x-stream-index: "003.001" + type: + default: thread.updated + type: string + x-stream-index: "004.001" + user: + $ref: '#/components/schemas/User' + x-stream-index: "002.001" + required: + - cid + - channel_id + - channel_type + - type + - created_at + title: ThreadUpdatedEvent + 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 + ThreadedCommentResponse: + description: A comment with an optional, depth‑limited slice of nested replies. + properties: + attachments: + items: + $ref: '#/components/schemas/Attachment' + type: array + x-stream-index: "001.011" + confidence_score: + format: float + type: number + x-stream-index: "001.022" + controversy_score: + format: float + type: number + x-stream-index: "001.023" + created_at: + format: date-time + type: number + x-stream-index: "001.014" + custom: + additionalProperties: {} + type: object + x-stream-index: "001.006" + deleted_at: + format: date-time + type: number + x-stream-index: "001.016" + downvote_count: + format: int32 + type: integer + x-stream-index: "001.020" + id: + type: string + x-stream-index: "001.001" + latest_reactions: + items: + $ref: '#/components/schemas/FeedsReactionResponse' + type: array + x-stream-index: "001.009" + mentioned_users: + items: + $ref: '#/components/schemas/UserResponse' + type: array + x-stream-index: "001.012" + meta: + $ref: '#/components/schemas/RepliesMeta' + description: Pagination & depth info for this node's direct replies. + title: Replies Meta + x-stream-index: "002" + moderation: + $ref: '#/components/schemas/ModerationV2Response' + x-stream-index: "001.017" + object_id: + type: string + x-stream-index: "001.002" + object_type: + type: string + x-stream-index: "001.003" + own_reactions: + items: + $ref: '#/components/schemas/FeedsReactionResponse' + type: array + x-stream-index: "001.024" + parent_id: + type: string + x-stream-index: "001.007" + reaction_count: + format: int32 + type: integer + x-stream-index: "001.008" + reaction_groups: + additionalProperties: + $ref: '#/components/schemas/ReactionGroupResponse' + type: object + x-stream-index: "001.010" + replies: + description: Slice of nested comments (may be empty). + items: + $ref: '#/components/schemas/ThreadedCommentResponse' + title: Replies + type: array + x-stream-index: "003" + reply_count: + format: int32 + type: integer + x-stream-index: "001.018" + score: + format: int32 + type: integer + x-stream-index: "001.021" + status: + type: string + x-stream-index: "001.013" + text: + type: string + x-stream-index: "001.005" + updated_at: + format: date-time + type: number + x-stream-index: "001.015" + upvote_count: + format: int32 + type: integer + x-stream-index: "001.019" + user: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "001.004" + required: + - id + - object_id + - object_type + - user + - reaction_count + - mentioned_users + - status + - created_at + - updated_at + - reply_count + - upvote_count + - downvote_count + - score + - confidence_score + - own_reactions + title: Threaded Comment + type: object + Thresholds: + description: Sets thresholds for AI moderation + properties: + explicit: + $ref: '#/components/schemas/LabelThresholds' + description: Thresholds for explicit messages + title: LabelThresholds + x-stream-index: "001" + spam: + $ref: '#/components/schemas/LabelThresholds' + description: Thresholds for spam + title: LabelThresholds + x-stream-index: "002" + toxic: + $ref: '#/components/schemas/LabelThresholds' + description: Thresholds for toxic messages + title: LabelThresholds + x-stream-index: "003" + title: Auto moderation thresholds + type: object + ThumbnailResponse: + properties: + image_url: + type: string + x-stream-index: "001" + required: + - image_url + type: object + ThumbnailsSettings: + properties: + enabled: + type: boolean + x-stream-index: "001" + required: + - enabled + type: object + ThumbnailsSettingsRequest: + properties: + enabled: + type: boolean + x-stream-index: "001" + type: object + ThumbnailsSettingsResponse: + properties: + enabled: + type: boolean + x-stream-index: "001" + required: + - enabled + type: object + Time: + type: object + TrackStatsResponse: + nullable: true + properties: + duration_seconds: + format: int32 + type: integer + x-stream-index: "002" + track_type: + type: string + x-stream-index: "001" + required: + - track_type + - duration_seconds + type: object + TranscriptionSettings: + properties: + closed_caption_mode: + enum: + - available + - disabled + - auto-on + title: Mode + type: string + x-stream-index: "002" + language: + description: The language used in this call as a two letter code + enum: + - auto + - en + - fr + - es + - de + - it + - nl + - pt + - pl + - ca + - cs + - da + - el + - fi + - id + - ja + - ru + - sv + - ta + - th + - tr + - hu + - ro + - zh + - ar + - tl + - he + - hi + - hr + - ko + - ms + - "no" + - uk + - bg + - et + - sl + - sk + title: Language + type: string + x-stream-index: "004" + mode: + enum: + - available + - disabled + - auto-on + title: Mode + type: string + x-stream-index: "001" + required: + - mode + - closed_caption_mode + - languages + - language + type: object + TranscriptionSettingsRequest: + properties: + closed_caption_mode: + enum: + - available + - disabled + - auto-on + type: string + x-stream-index: "002" + language: + enum: + - auto + - en + - fr + - es + - de + - it + - nl + - pt + - pl + - ca + - cs + - da + - el + - fi + - id + - ja + - ru + - sv + - ta + - th + - tr + - hu + - ro + - zh + - ar + - tl + - he + - hi + - hr + - ko + - ms + - "no" + - uk + - bg + - et + - sl + - sk + type: string + x-stream-index: "004" + mode: + enum: + - available + - disabled + - auto-on + type: string + x-stream-index: "001" + required: + - mode + type: object + TranscriptionSettingsResponse: + properties: + closed_caption_mode: + enum: + - available + - disabled + - auto-on + type: string + x-stream-index: "002" + language: + enum: + - auto + - en + - fr + - es + - de + - it + - nl + - pt + - pl + - ca + - cs + - da + - el + - fi + - id + - ja + - ru + - sv + - ta + - th + - tr + - hu + - ro + - zh + - ar + - tl + - he + - hi + - hr + - ko + - ms + - "no" + - uk + - bg + - et + - sl + - sk + type: string + x-stream-index: "004" + mode: + enum: + - available + - disabled + - auto-on + type: string + x-stream-index: "001" + required: + - mode + - closed_caption_mode + - languages + - language + type: object + TranslateMessageRequest: + nullable: true + properties: + language: + description: Language to translate message to + enum: + - af + - sq + - am + - ar + - az + - bn + - bs + - bg + - zh + - zh-TW + - hr + - cs + - da + - fa-AF + - nl + - en + - et + - fi + - fr + - fr-CA + - ka + - de + - el + - ha + - he + - hi + - hu + - id + - it + - ja + - ko + - lv + - ms + - "no" + - fa + - ps + - pl + - pt + - ro + - ru + - sr + - sk + - sl + - so + - es + - es-MX + - sw + - sv + - tl + - ta + - th + - tr + - uk + - ur + - vi + - lt + - ht + title: Language + type: string + x-stream-index: "001" + required: + - language + type: object + TruncateChannelRequest: + nullable: true + properties: + hard_delete: + description: Permanently delete channel data (messages, reactions, etc.) + title: Hard delete + type: boolean + x-stream-index: "002" + member_ids: + description: List of member IDs to hide message history for. If empty, truncates + the channel for all members + items: + type: string + maximum: 100 + title: Member IDs + type: array + x-stream-index: "007" + message: + $ref: '#/components/schemas/MessageRequest' + x-stream-index: "004" + skip_push: + description: When `message` is set disables all push notifications for it + title: Skip push + type: boolean + x-stream-index: "005" + truncated_at: + description: Truncate channel data up to `truncated_at`. The system message + (if provided) creation time is always greater than `truncated_at` + format: date-time + title: Truncated at + type: number + x-stream-index: "006" + type: object + TruncateChannelResponse: + nullable: true + properties: + channel: + $ref: '#/components/schemas/ChannelResponse' + description: Truncated channel object + title: Channel + x-stream-index: "002" + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "001.001" + message: + $ref: '#/components/schemas/MessageResponse' + description: Truncated message object + title: Message + x-stream-index: "003" + required: + - duration + type: object + TypingIndicators: + properties: + enabled: + type: boolean + x-stream-index: "001" + required: + - enabled + type: object + TypingIndicatorsResponse: + properties: + enabled: + type: boolean + x-stream-index: "001" + required: + - enabled + type: object + TypingStartEvent: + properties: + channel_id: + type: string + x-stream-index: "003.002" + channel_type: + type: string + x-stream-index: "003.003" + cid: + type: string + x-stream-index: "003.001" + created_at: + format: date-time + type: number + x-stream-index: "004.002" + parent_id: + type: string + x-stream-index: "001" + type: + default: typing.start + type: string + x-stream-index: "004.001" + user: + $ref: '#/components/schemas/User' + x-stream-index: "002.001" + required: + - cid + - channel_id + - channel_type + - type + - created_at + title: TypingStartEvent + 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 + TypingStopEvent: + properties: + channel_id: + type: string + x-stream-index: "002.002" + channel_type: + type: string + x-stream-index: "002.003" + cid: + type: string + x-stream-index: "002.001" + created_at: + format: date-time + type: number + x-stream-index: "004.002" + parent_id: + type: string + x-stream-index: "001" + type: + default: typing.stop + type: string + x-stream-index: "004.001" + user: + $ref: '#/components/schemas/User' + x-stream-index: "003.001" + required: + - cid + - channel_id + - channel_type + - type + - created_at + title: TypingStopEvent + 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 + UnbanActionRequest: + type: object + UnblockActionRequest: + type: object + UnblockUserRequest: + description: UnblockUserRequest is the payload for unblocking a user. + nullable: true + properties: + user_id: + description: the user to unblock + title: UserID + type: string + x-stream-index: "003" + required: + - user_id + title: UnblockUserRequest + type: object + UnblockUserResponse: + description: UnblockUserResponse is the payload for unblocking a user. + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "001.001" + required: + - duration + title: UnblockUserResponse + type: object + UnblockUsersRequest: + nullable: true + properties: + blocked_user_id: + type: string + x-stream-index: "001" + required: + - blocked_user_id + type: object + UnblockUsersResponse: + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "001.001" + required: + - duration + type: object + UnblockedUserEvent: + description: |- + This event is sent when a user is unblocked on a call, + this can be useful to notify the user that they can now join the call again + properties: + call_cid: + type: string + x-stream-index: "002.001" + created_at: + format: date-time + type: number + x-stream-index: "001.002" + type: + default: call.unblocked_user + description: 'The type of event: "call.unblocked_user" in this case' + title: Event Type + type: string + x-stream-index: "001.001" + user: + $ref: '#/components/schemas/UserResponse' + description: The user that was unblocked + title: User + x-stream-index: "003" + required: + - type + - created_at + - call_cid + - user + title: UnblockedUserEvent + type: object + x-stream-event-call-type: true + x-stream-event-doc-group: call + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + UnfollowResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + follow: + $ref: '#/components/schemas/FollowResponse' + description: The deleted follow relationship + title: Follow + x-stream-index: "001" + required: + - follow + - duration + title: Unfollow Response + type: object + UnmuteChannelRequest: + nullable: true + properties: + channel_cids: + description: Channel CIDs to mute (if multiple channels) + items: + type: string + maximum: 25 + title: Channel CIDs + type: array + x-stream-index: "001.002" + expiration: + description: Duration of mute in milliseconds + title: Expiration + type: integer + x-stream-index: "001.003" + type: object + UnmuteResponse: + description: Basic response information + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "002.001" + non_existing_users: + items: + type: string + type: array + x-stream-index: "001" + required: + - duration + title: Response + type: object + UnpinActivityResponse: + nullable: true + properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + description: The unpinned activity + title: Activity + x-stream-index: "001" + duration: + type: string + x-stream-index: "004.001" + feed: + description: Fully qualified ID of the feed the activity was unpinned from + title: Feed ID + type: string + x-stream-index: "002" + user_id: + description: ID of the user who unpinned the activity + title: User ID + type: string + x-stream-index: "003" + required: + - activity + - feed + - user_id + - duration + title: Unpin Activity Response + type: object + UnpinRequest: + description: UnpinRequest is the payload for unpinning a message. + nullable: true + properties: + session_id: + description: the session ID of the user who pinned the message + title: SessionID + type: string + x-stream-index: "003" + user_id: + description: the user ID of the user who pinned the message + title: UserID + type: string + x-stream-index: "002" + required: + - user_id + - session_id + title: UnpinRequest + type: object + UnpinResponse: + description: UnpinResponse is the payload for unpinning a message. + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "001.001" + required: + - duration + title: UnpinResponse + type: object + UnreadCountsChannel: + properties: + channel_id: + type: string + x-stream-index: "001" + last_read: + format: date-time + type: number + x-stream-index: "003" + unread_count: + format: int32 + type: integer + x-stream-index: "002" + required: + - channel_id + - unread_count + - last_read + type: object + UnreadCountsChannelType: + properties: + channel_count: + format: int32 + type: integer + x-stream-index: "002" + channel_type: + type: string + x-stream-index: "001" + unread_count: + format: int32 + type: integer + x-stream-index: "003" + required: + - channel_type + - channel_count + - unread_count + type: object + UnreadCountsThread: + properties: + last_read: + format: date-time + type: number + x-stream-index: "002" + last_read_message_id: + type: string + x-stream-index: "003" + parent_message_id: + type: string + x-stream-index: "004" + unread_count: + format: int32 + type: integer + x-stream-index: "001" + required: + - unread_count + - last_read + - last_read_message_id + - parent_message_id + type: object + UpdateActivityPartialRequest: + nullable: true + properties: + set: + additionalProperties: {} + description: Map of dot-notation field paths to new values + title: object + type: object + x-stream-index: "002" + unset: + description: List of dot-notation paths to remove + items: + type: string + title: '[]string' + type: array + x-stream-index: "003" + type: object + UpdateActivityPartialResponse: + nullable: true + properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + description: The updated activity + title: ActivityResponse + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - activity + - duration + type: object + UpdateActivityRequest: + nullable: true + properties: + attachments: + description: List of attachments for the activity + items: + $ref: '#/components/schemas/Attachment' + title: '[]ActivityAttachment' + type: array + x-stream-index: "003" + custom: + additionalProperties: {} + description: Custom data for the activity + title: object + type: object + x-stream-index: "004" + expires_at: + description: Time when the activity will expire + format: date-time + title: string + type: number + x-stream-index: "007" + filter_tags: + description: Tags used for filtering the activity + items: + type: string + title: '[]string' + type: array + x-stream-index: "008" + interest_tags: + description: Tags indicating interest categories + items: + type: string + title: '[]string' + type: array + x-stream-index: "009" + location: + $ref: '#/components/schemas/ActivityLocation' + description: Geographic location for the activity + title: ActivityLocation + x-stream-index: "006" + poll_id: + description: Poll ID + title: string + type: string + x-stream-index: "010" + text: + description: The text content of the activity + title: string + type: string + x-stream-index: "002" + visibility: + description: Visibility setting for the activity + title: string + type: string + x-stream-index: "005" + type: object + UpdateActivityResponse: + nullable: true + properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + description: The updated activity + title: ActivityResponse + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - activity + - duration + type: object + UpdateBlockListRequest: + nullable: true + properties: + team: + type: string + x-stream-index: "002" + words: + description: List of words to block + items: + type: string + minimum: 1 + title: Words + type: array + x-stream-index: "003" + title: Update block list + type: object + x-stream-docs-page-id: update_block_list + UpdateBlockListResponse: + description: Basic response information + nullable: true + properties: + blocklist: + $ref: '#/components/schemas/BlockListResponse' + x-stream-index: "001" + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "002.001" + required: + - duration + title: Response + type: object + UpdateBookmarkFolderRequest: + nullable: true + properties: + custom: + additionalProperties: {} + description: Custom data for the folder + title: Custom Data + type: object + x-stream-index: "003" + name: + description: Name of the folder + maxLength: 255 + title: Name + type: string + x-stream-index: "002" + title: Update Bookmark Folder Request + type: object + UpdateBookmarkFolderResponse: + nullable: true + properties: + bookmark_folder: + $ref: '#/components/schemas/BookmarkFolderResponse' + description: The updated bookmark folder + title: Bookmark Folder + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - bookmark_folder + - duration + title: Update Bookmark Folder Response + type: object + UpdateBookmarkRequest: + nullable: true + properties: + custom: + additionalProperties: {} + description: Custom data for the bookmark + title: Custom Data + type: object + x-stream-index: "005" + folder_id: + description: ID of the folder to move the bookmark to + maxLength: 255 + title: Folder ID + type: string + x-stream-index: "002" + new_folder: + $ref: '#/components/schemas/AddFolderRequest' + x-stream-index: "004" + new_folder_id: + maxLength: 255 + type: string + x-stream-index: "003" + title: Update Bookmark Request + type: object + UpdateBookmarkResponse: + nullable: true + properties: + bookmark: + $ref: '#/components/schemas/BookmarkResponse' + description: The updated bookmark + title: Bookmark + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - bookmark + - duration + title: Update Bookmark Response + type: object + UpdateCallMembersRequest: + description: Update call members + nullable: true + properties: + remove_members: + description: List of userID to remove + items: + type: string + maximum: 100 + title: Remove Members + type: array + x-stream-index: "003" + update_members: + description: List of members to update or insert + items: + $ref: '#/components/schemas/MemberRequest' + maximum: 100 + title: Update Members + type: array + x-stream-index: "004" + title: UpdateCallMembersRequest + type: object + UpdateCallMembersResponse: + description: Basic response information + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "001.001" + members: + items: + $ref: '#/components/schemas/MemberResponse' + type: array + x-stream-index: "002" + required: + - duration + - members + title: Response + type: object + UpdateCallRequest: + description: Request for updating a call + nullable: true + properties: + custom: + additionalProperties: {} + description: Custom data for this object + title: Custom data + type: object + x-stream-index: "003" + settings_override: + $ref: '#/components/schemas/CallSettingsRequest' + description: the settings to change for this call + title: Settings Override + x-stream-index: "004" + starts_at: + description: the time the call is scheduled to start + format: date-time + title: Starts At + type: number + x-stream-index: "005" + title: UpdateCallRequest + type: object + UpdateCallResponse: + description: Response for updating a call + nullable: true + properties: + call: + $ref: '#/components/schemas/CallResponse' + x-stream-index: "001.001" + duration: + type: string + x-stream-index: "002.001" + members: + items: + $ref: '#/components/schemas/MemberResponse' + type: array + x-stream-index: "001.002" + membership: + $ref: '#/components/schemas/MemberResponse' + x-stream-index: "001.003" + own_capabilities: + items: + $ref: '#/components/schemas/OwnCapability' + type: array + x-stream-index: "001.004" + required: + - call + - members + - own_capabilities + - blocked_users + - duration + title: UpdateCallResponse + type: object + UpdateChannelPartialRequest: + nullable: true + properties: + set: + additionalProperties: {} + type: object + x-stream-index: "002.001" + unset: + items: + type: string + type: array + x-stream-index: "002.002" + title: UpdateChannelPartialRequest + type: object + UpdateChannelPartialResponse: + nullable: true + properties: + channel: + $ref: '#/components/schemas/ChannelResponse' + description: Updated channel object + title: Channel + x-stream-index: "001" + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "003.001" + members: + description: List of updated members + items: + $ref: '#/components/schemas/ChannelMemberResponse' + title: ChannelMemberResponse + type: array + x-stream-index: "002" + required: + - members + - duration + type: object + UpdateChannelRequest: + nullable: true + properties: + accept_invite: + description: Set to `true` to accept the invite + title: Accept invite + type: boolean + x-stream-index: "008" + add_members: + description: List of user IDs to add to the channel + items: + $ref: '#/components/schemas/ChannelMember' + maximum: 100 + title: Add members + type: array + x-stream-index: "001" + add_moderators: + description: List of user IDs to make channel moderators + items: + type: string + maximum: 100 + title: Add moderators + type: array + x-stream-index: "003" + assign_roles: + description: List of channel member role assignments. If any specified user + is not part of the channel, the request will fail + items: + $ref: '#/components/schemas/ChannelMember' + maximum: 100 + title: Assign roles + type: array + x-stream-index: "006" + cooldown: + description: Sets cool down period for the channel in seconds + format: int32 + maximum: 120 + minimum: 0 + title: Cool down + type: integer + x-stream-index: "007" + data: + $ref: '#/components/schemas/ChannelInput' + x-stream-index: "013.001" + demote_moderators: + description: List of user IDs to take away moderators status from + items: + type: string + maximum: 100 + title: Demote moderators + type: array + x-stream-index: "004" + hide_history: + description: Set to `true` to hide channel's history when adding new members + title: Hide history + type: boolean + x-stream-index: "012" + invites: + description: List of user IDs to invite to the channel + items: + $ref: '#/components/schemas/ChannelMember' + maximum: 100 + title: Invites + type: array + x-stream-index: "005" + message: + $ref: '#/components/schemas/MessageRequest' + description: Message to send to the chat when channel is successfully updated + title: Message + x-stream-index: "010" + reject_invite: + description: Set to `true` to reject the invite + title: Reject invite + type: boolean + x-stream-index: "009" + remove_members: + description: List of user IDs to remove from the channel + items: + type: string + maximum: 100 + title: Remove members + type: array + x-stream-index: "002" + skip_push: + description: When `message` is set disables all push notifications for it + title: Skip push + type: boolean + x-stream-index: "011" + title: Channel update request + type: object + x-stream-docs-page-id: channel_update + UpdateChannelResponse: + nullable: true + properties: + channel: + $ref: '#/components/schemas/ChannelResponse' + description: Updated channel + title: Channel + x-stream-index: "001" + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "004.001" + members: + description: List of channel members + items: + $ref: '#/components/schemas/ChannelMember' + title: Members + type: array + x-stream-index: "003" + message: + $ref: '#/components/schemas/MessageResponse' + description: Message sent to the chat + title: Message + x-stream-index: "002" + required: + - members + - duration + type: object + UpdateCommentRequest: + nullable: true + properties: + comment: + description: Updated text content of the comment + title: Comment + type: string + x-stream-index: "002" + custom: + additionalProperties: {} + description: Updated custom data for the comment + title: Custom Data + type: object + x-stream-index: "003" + skip_push: + type: boolean + x-stream-index: "004" + title: Update Comment Request + type: object + UpdateCommentResponse: + nullable: true + properties: + comment: + $ref: '#/components/schemas/CommentResponse' + description: The updated comment + title: Comment + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - comment + - duration + title: Update Comment Response + type: object + UpdateFeedMembersRequest: + nullable: true + properties: + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "006.001" + members: + description: List of members to upsert, remove, or set + items: + $ref: '#/components/schemas/FeedMemberRequest' + title: Members + type: array + x-stream-index: "004" + next: + type: string + x-stream-index: "006.002" + operation: + description: Type of update operation to perform + enum: + - upsert + - remove + - set + title: Operation + type: string + x-stream-index: "003" + prev: + type: string + x-stream-index: "006.003" + required: + - operation + title: Update Feed Members Request + type: object + UpdateFeedMembersResponse: + description: Basic response information + nullable: true + properties: + added: + items: + $ref: '#/components/schemas/FeedMemberResponse' + type: array + x-stream-index: "001" + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "004.001" + removed_ids: + items: + type: string + type: array + x-stream-index: "003" + updated: + items: + $ref: '#/components/schemas/FeedMemberResponse' + type: array + x-stream-index: "002" + required: + - added + - updated + - removed_ids + - duration + title: Response + type: object + UpdateFeedRequest: + nullable: true + properties: + custom: + additionalProperties: {} + description: Custom data for the feed + title: Custom Data + type: object + x-stream-index: "004" + title: Update Feed Request + type: object + UpdateFeedResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + feed: + $ref: '#/components/schemas/FeedResponse' + description: The updated feed + title: Feed + x-stream-index: "001" + required: + - feed + - duration + title: Update Feed Response + type: object + UpdateFollowRequest: + nullable: true + properties: + create_notification_activity: + description: Whether to create a notification activity for this follow + title: Create Notification Activity + type: boolean + x-stream-index: "001.004" + custom: + additionalProperties: {} + description: Custom data for the follow relationship + title: Custom Data + type: object + x-stream-index: "001.002" + follower_role: + type: string + x-stream-index: "002" + push_preference: + description: Push preference for the follow relationship + enum: + - all + - none + title: Push Preference + type: string + x-stream-index: "001.003" + skip_push: + type: boolean + x-stream-index: "001.005" + source: + description: Fully qualified ID of the source feed + maxLength: 255 + title: Source Feed + type: string + x-stream-index: 001.001.001 + target: + description: Fully qualified ID of the target feed + maxLength: 255 + title: Target Feed + type: string + x-stream-index: 001.001.002 + required: + - source + - target + title: Update Follow Request + type: object + UpdateFollowResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + follow: + $ref: '#/components/schemas/FollowResponse' + description: Details of the updated follow relationship + title: Follow + x-stream-index: "001" + required: + - follow + - duration + title: Update Follow Response + type: object + UpdateLiveLocationRequest: + nullable: true + properties: + end_at: + description: Time when the live location expires + format: date-time + title: string + type: number + x-stream-index: "004" + latitude: + description: Latitude coordinate + format: float + maximum: 90 + minimum: 1.8446744073709552e+19 + title: number + type: number + x-stream-index: "002" + longitude: + description: Longitude coordinate + format: float + maximum: 180 + minimum: 1.8446744073709552e+19 + title: number + type: number + x-stream-index: "003" + message_id: + description: Live location ID + title: string + type: string + x-stream-index: "001" + required: + - message_id + type: object + UpdateMemberPartialRequest: + nullable: true + properties: + set: + additionalProperties: {} + type: object + x-stream-index: "002.001" + unset: + items: + type: string + type: array + x-stream-index: "002.002" + type: object + UpdateMemberPartialResponse: + nullable: true + properties: + channel_member: + $ref: '#/components/schemas/ChannelMemberResponse' + description: Updated channel member + title: Channel member + x-stream-index: "001" + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "002.001" + required: + - duration + type: object + UpdateMessagePartialRequest: + nullable: true + properties: + set: + additionalProperties: {} + description: Sets new field values + title: Set + type: object + x-stream-index: "002.001" + x-stream-map: + description: New value to set + key: field + title: Value + skip_enrich_url: + description: Skip enriching the URL in the message + title: SkipEnrichURL + type: boolean + x-stream-index: "001" + unset: + description: Array of field names to unset + items: + type: string + title: Unset + type: array + x-stream-index: "002.002" + type: object + UpdateMessagePartialResponse: + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "003.001" + message: + $ref: '#/components/schemas/MessageResponse' + description: Updated message + title: Message + x-stream-index: "001" + pending_message_metadata: + additionalProperties: + type: string + description: Pending message metadata + title: PendingMessageMetadata + type: object + x-stream-index: "002" + required: + - duration + type: object + UpdateMessageRequest: + nullable: true + properties: + message: + $ref: '#/components/schemas/MessageRequest' + description: Message + title: MessageRequest + x-stream-index: "001" + skip_enrich_url: + description: Skip enrich URL + title: boolean + type: boolean + x-stream-index: "003" + skip_push: + type: boolean + x-stream-index: "002" + required: + - message + type: object + UpdateMessageResponse: + description: Basic response information + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "003.001" + message: + $ref: '#/components/schemas/MessageResponse' + x-stream-index: "001" + pending_message_metadata: + additionalProperties: + type: string + type: object + x-stream-index: "002" + required: + - message + - duration + title: Response + type: object + UpdatePollOptionRequest: + nullable: true + properties: + Custom: + additionalProperties: {} + type: object + writeOnly: true + x-stream-index: "004" + id: + description: Option ID + maxLength: 255 + title: string + type: string + x-stream-index: "002" + text: + description: Option text + title: string + type: string + x-stream-index: "003" + required: + - id + - text + type: object + UpdatePollPartialRequest: + nullable: true + properties: + set: + additionalProperties: {} + description: Sets new field values + title: Set + type: object + x-stream-index: "002.001" + x-stream-map: + description: New value to set + key: field + title: Value + unset: + description: Array of field names to unset + items: + type: string + title: Unset + type: array + x-stream-index: "002.002" + type: object + UpdatePollRequest: + nullable: true + properties: + Custom: + additionalProperties: {} + type: object + writeOnly: true + x-stream-index: "011" + allow_answers: + description: Allow answers + title: boolean + type: boolean + x-stream-index: "009" + allow_user_suggested_options: + description: Allow user suggested options + title: boolean + type: boolean + x-stream-index: "008" + description: + description: Poll description + title: string + type: string + x-stream-index: "003" + enforce_unique_vote: + description: Enforce unique vote + title: boolean + type: boolean + x-stream-index: "005" + id: + description: Poll ID + maxLength: 255 + title: string + type: string + x-stream-index: "001" + is_closed: + description: Is closed + title: boolean + type: boolean + x-stream-index: "010" + max_votes_allowed: + description: Max votes allowed + format: int32 + maximum: 10 + title: integer + type: integer + x-stream-index: "007" + name: + description: Poll name + title: string + type: string + x-stream-index: "002" + options: + description: Poll options + items: + $ref: '#/components/schemas/PollOptionRequest' + maximum: 100 + title: PollOptions + type: array + x-stream-index: "004" + voting_visibility: + description: Voting visibility + enum: + - anonymous + - public + title: string + type: string + x-stream-index: "006" + required: + - id + - name + type: object + UpdateReminderRequest: + nullable: true + properties: + remind_at: + format: date-time + type: number + x-stream-index: "001" + type: object + UpdateReminderResponse: + description: Basic response information + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "002.001" + reminder: + $ref: '#/components/schemas/ReminderResponseData' + x-stream-index: "001" + required: + - reminder + - duration + title: Response + type: object + UpdateThreadPartialRequest: + nullable: true + properties: + set: + additionalProperties: {} + description: Sets new field values + title: Set + type: object + x-stream-index: "004.001" + x-stream-map: + description: New value to set + key: field + title: Value + unset: + description: Array of field names to unset + items: + type: string + title: Unset + type: array + x-stream-index: "004.002" + type: object + UpdateThreadPartialResponse: + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "002.001" + thread: + $ref: '#/components/schemas/ThreadResponse' + description: Updated thread (not enriched) + title: Thread + x-stream-index: "001" + required: + - thread + - duration + type: object + UpdateUserPartialRequest: + properties: + id: + description: User ID to update + title: ID + type: string + x-stream-index: "001" + set: + additionalProperties: {} + type: object + x-stream-index: "002.001" + unset: + items: + type: string + type: array + x-stream-index: "002.002" + required: + - id + type: object + UpdateUserPermissionsRequest: + nullable: true + properties: + grant_permissions: + items: + type: string + type: array + x-stream-index: "002" + revoke_permissions: + items: + type: string + type: array + x-stream-index: "003" + user_id: + type: string + x-stream-index: "001" + required: + - user_id + type: object + UpdateUserPermissionsResponse: + 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 + UpdateUsersPartialRequest: + nullable: true + properties: + users: + items: + $ref: '#/components/schemas/UpdateUserPartialRequest' + maximum: 100 + type: array + x-stream-index: "001" + required: + - users + type: object + UpdateUsersRequest: + nullable: true + properties: + users: + additionalProperties: + $ref: '#/components/schemas/UserRequest' + description: Object containing users + title: Users + type: object + x-stream-index: "001" + x-stream-map: + key: user_id + required: + - users + type: object + UpdateUsersResponse: + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "003.001" + membership_deletion_task_id: + type: string + x-stream-index: "002" + users: + additionalProperties: + $ref: '#/components/schemas/FullUserResponse' + description: Object containing users + title: Users + type: object + x-stream-index: "001" + x-stream-map: + key: user_id + required: + - users + - membership_deletion_task_id + - duration + type: object + UpdatedCallPermissionsEvent: + description: This event is sent to notify about permission changes for a user, + clients receiving this event should update their UI accordingly + properties: + call_cid: + type: string + x-stream-index: "002.001" + created_at: + format: date-time + type: number + x-stream-index: "001.002" + own_capabilities: + description: The capabilities of the current user + items: + $ref: '#/components/schemas/OwnCapability' + title: Own capabilities + type: array + x-stream-index: "004" + type: + default: call.permissions_updated + description: 'The type of event: "call.permissions_updated" in this case' + title: Event Type + type: string + x-stream-index: "001.001" + user: + $ref: '#/components/schemas/UserResponse' + description: The user who received the new permissions + title: User + x-stream-index: "003" + required: + - type + - created_at + - call_cid + - user + - own_capabilities + title: UpdatedCallPermissionsEvent + type: object + x-stream-event-call-type: true + x-stream-event-doc-group: call + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + UpsertActivitiesRequest: + nullable: true + properties: + activities: + description: List of activities to create or update + items: + $ref: '#/components/schemas/ActivityRequest' + maximum: 100 + minimum: 1 + title: Activities + type: array + x-stream-index: "001" + required: + - activities + title: Upsert Activities Request + type: object + UpsertActivitiesResponse: + nullable: true + properties: + activities: + description: List of created or updated activities + items: + $ref: '#/components/schemas/ActivityResponse' + title: Activities + type: array + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - activities + - duration + title: Upsert Activities Response + type: object + UpsertConfigRequest: + nullable: true + properties: + ai_image_config: + $ref: '#/components/schemas/AIImageConfig' + description: Configuration for AI image analysis + title: AI Image Config + x-stream-index: "011" + ai_text_config: + $ref: '#/components/schemas/AITextConfig' + description: Configuration for AI text analysis + title: AI Text Config + x-stream-index: "008" + ai_video_config: + $ref: '#/components/schemas/AIVideoConfig' + description: Configuration for AI video analysis + title: AI Video Config + x-stream-index: "012" + async: + description: Whether moderation should be performed asynchronously + title: Async + type: boolean + x-stream-index: "003" + automod_platform_circumvention_config: + $ref: '#/components/schemas/AutomodPlatformCircumventionConfig' + description: Configuration for platform circumvention detection + title: Automod Platform Circumvention Config + x-stream-index: "005" + automod_semantic_filters_config: + $ref: '#/components/schemas/AutomodSemanticFiltersConfig' + description: Configuration for semantic filtering + title: Automod Semantic Filters Config + x-stream-index: "006" + automod_toxicity_config: + $ref: '#/components/schemas/AutomodToxicityConfig' + description: Configuration for toxicity detection + title: Automod Toxicity Config + x-stream-index: "004" + aws_rekognition_config: + $ref: '#/components/schemas/AIImageConfig' + x-stream-index: "016" + block_list_config: + $ref: '#/components/schemas/BlockListConfig' + description: Configuration for block list filtering + title: Block List Config + x-stream-index: "007" + bodyguard_config: + $ref: '#/components/schemas/AITextConfig' + x-stream-index: "015" + google_vision_config: + $ref: '#/components/schemas/GoogleVisionConfig' + description: Configuration for Google Vision integration + title: Google Vision Config + x-stream-index: "010" + key: + description: Unique identifier for the moderation configuration + title: Key + type: string + x-stream-index: "001" + llm_config: + $ref: '#/components/schemas/LLMConfig' + description: Configuration for customer-configured LLM moderation + title: LLM Config + x-stream-index: "009" + rule_builder_config: + $ref: '#/components/schemas/RuleBuilderConfig' + description: Configuration for custom rule builder (max 3 rules, max 5 conditions + per rule) + title: Rule Builder Config + x-stream-index: "014" + team: + description: Team associated with the configuration + maxLength: 128 + minLength: 1 + title: Team + type: string + x-stream-index: "002" + velocity_filter_config: + $ref: '#/components/schemas/VelocityFilterConfig' + description: Configuration for velocity-based filtering + title: Velocity Filter Config + x-stream-index: "013" + video_call_rule_config: + $ref: '#/components/schemas/VideoCallRuleConfig' + x-stream-index: "017" + required: + - key + type: object + UpsertConfigResponse: + nullable: true + properties: + config: + $ref: '#/components/schemas/ConfigResponse' + description: The created or updated moderation configuration + title: Config + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - duration + type: object + UpsertPushPreferencesRequest: + nullable: true + properties: + preferences: + description: A list of push preferences for channels, calls, or the user. + items: + $ref: '#/components/schemas/PushPreferenceInput' + type: array + x-stream-index: "001" + required: + - preferences + type: object + UpsertPushPreferencesResponse: + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "003.001" + user_channel_preferences: + additionalProperties: + additionalProperties: + $ref: '#/components/schemas/ChannelPushPreferences' + type: object + description: The channel specific push notification preferences, only returned + for channels you've edited. + title: User Channel Notification Preferences + type: object + x-stream-index: "002" + user_preferences: + additionalProperties: + $ref: '#/components/schemas/PushPreferences' + description: The user preferences, always returned regardless if you edited + it + title: User Preferences + type: object + x-stream-index: "001" + required: + - user_preferences + - user_channel_preferences + - duration + type: object + User: + properties: + avg_response_time: + format: int32 + readOnly: true + type: integer + x-stream-index: "046" + ban_expires: + format: date-time + type: number + x-stream-index: "017" + banned: + type: boolean + x-stream-index: "016" + created_at: + format: date-time + readOnly: true + type: number + x-stream-index: "008" + custom: + additionalProperties: {} + type: object + x-stream-index: "006" + deactivated_at: + format: date-time + readOnly: true + type: number + x-stream-index: "014" + deleted_at: + format: date-time + readOnly: true + type: number + x-stream-index: "013" + id: + type: string + x-stream-index: "003" + invisible: + type: boolean + x-stream-index: "023" + language: + type: string + x-stream-index: "035" + last_active: + format: date-time + readOnly: true + type: number + x-stream-index: "011" + last_engaged_at: + format: date-time + readOnly: true + type: number + x-stream-index: "012" + online: + readOnly: true + type: boolean + x-stream-index: "022" + privacy_settings: + $ref: '#/components/schemas/PrivacySettings' + x-stream-index: "026" + revoke_tokens_issued_before: + format: date-time + type: number + x-stream-index: "042" + role: + type: string + x-stream-index: "004" + teams: + items: + type: string + type: array + x-stream-index: "036" + teams_role: + additionalProperties: + type: string + type: object + x-stream-index: "005" + updated_at: + format: date-time + readOnly: true + type: number + x-stream-index: "009" + required: + - id + - role + - teams_role + - custom + - banned + - online + type: object + UserBannedEvent: + properties: + channel_id: + type: string + x-stream-index: "006.002" + channel_type: + type: string + x-stream-index: "006.003" + cid: + type: string + x-stream-index: "006.001" + created_at: + format: date-time + type: number + x-stream-index: "008.002" + created_by: + $ref: '#/components/schemas/User' + x-stream-index: "001" + expiration: + format: date-time + type: number + x-stream-index: "003" + reason: + type: string + x-stream-index: "004" + shadow: + type: boolean + x-stream-index: "002" + team: + type: string + x-stream-index: "005.001" + type: + default: user.banned + type: string + x-stream-index: "008.001" + user: + $ref: '#/components/schemas/User' + x-stream-index: "007.001" + required: + - created_by + - shadow + - cid + - channel_id + - channel_type + - type + - created_at + title: UserBannedEvent + 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 + UserCreatedWithinParameters: + properties: + max_age: + type: string + x-stream-index: "001" + type: object + UserCustomPropertyParameters: + properties: + operator: + type: string + x-stream-index: "002" + property_key: + type: string + x-stream-index: "001" + type: object + UserDeactivatedEvent: + properties: + created_at: + format: date-time + type: number + x-stream-index: "003.002" + created_by: + $ref: '#/components/schemas/User' + x-stream-index: "001" + type: + default: user.deactivated + type: string + x-stream-index: "003.001" + user: + $ref: '#/components/schemas/User' + x-stream-index: "002.001" + required: + - created_by + - type + - created_at + title: UserDeactivatedEvent + 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 + UserDeletedEvent: + properties: + created_at: + format: date-time + type: number + x-stream-index: "002.002" + delete_conversation_channels: + type: boolean + x-stream-index: "005" + hard_delete: + type: boolean + x-stream-index: "003.001" + mark_messages_deleted: + type: boolean + x-stream-index: "004" + type: + default: user.deleted + type: string + x-stream-index: "002.001" + user: + $ref: '#/components/schemas/User' + x-stream-index: "001.001" + required: + - type + - created_at + - hard_delete + - mark_messages_deleted + - delete_conversation_channels + title: UserDeletedEvent + 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 + UserFeedbackReport: + properties: + count_by_rating: + additionalProperties: + format: int32 + type: integer + type: object + x-stream-index: "001" + unreported_count: + format: int32 + type: integer + x-stream-index: "002" + required: + - count_by_rating + - unreported_count + type: object + UserFeedbackReportResponse: + properties: + daily: + items: + $ref: '#/components/schemas/DailyAggregateUserFeedbackReportResponse' + type: array + x-stream-index: "001" + required: + - daily + type: object + UserMessagesDeletedEvent: + description: This event is sent when a user's message get deleted. The event + contains information about the user whose messages got deleted. + nullable: true + properties: + channel_custom: + additionalProperties: {} + type: object + x-stream-index: 001.001.005 + channel_id: + description: The ID of the channel where the target user's messages were + deleted + title: Channel ID + type: string + x-stream-index: 001.002.002 + channel_member_count: + format: int32 + type: integer + x-stream-index: 001.001.004 + channel_type: + description: The type of the channel where the target user's messages were + deleted + title: Channel Type + type: string + x-stream-index: 001.002.001 + cid: + description: The CID of the channel where the target user's messages were + deleted + 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: number + x-stream-index: 001.001.001.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 001.001.001.001.007 + hard_delete: + description: Whether Messages were hard deleted + title: Hard Delete + type: boolean + x-stream-index: "003" + received_at: + format: date-time + type: number + x-stream-index: 001.001.001.001.004 + team: + description: The team of the channel where the target user's messages were + deleted + title: Team + type: string + x-stream-index: 001.001.003 + type: + default: user.messages.deleted + description: 'The type of event: "user.messages.deleted" in this case' + title: Event Type + type: string + x-stream-index: 001.001.001.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The target user whose messages got deleted + title: User + x-stream-index: "002.001" + required: + - type + - created_at + - custom + - user + title: UserMessagesDeletedEvent + 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 + UserMute: + nullable: true + properties: + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: "009" + expires: + description: Date/time of mute expiration + format: date-time + title: Expires + type: number + x-stream-index: "008" + target: + $ref: '#/components/schemas/User' + description: User who's muted + title: Target + x-stream-index: "007" + updated_at: + description: Date/time of the last update + format: date-time + title: Updated at + type: number + x-stream-index: "010" + user: + $ref: '#/components/schemas/User' + description: Owner of channel mute + title: User + x-stream-index: "005" + required: + - created_at + - updated_at + type: object + UserMuteResponse: + nullable: true + properties: + created_at: + format: date-time + type: number + x-stream-index: "004" + expires: + format: date-time + type: number + x-stream-index: "003" + target: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "002" + updated_at: + format: date-time + type: number + x-stream-index: "005" + user: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "001" + required: + - created_at + - updated_at + type: object + UserMutedEvent: + properties: + created_at: + format: date-time + type: number + x-stream-index: "004.002" + target_user: + type: string + x-stream-index: "001" + target_users: + items: + type: string + type: array + x-stream-index: "002" + type: + default: user.muted + type: string + x-stream-index: "004.001" + user: + $ref: '#/components/schemas/User' + x-stream-index: "003.001" + required: + - type + - created_at + title: UserMutedEvent + 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 + UserPresenceChangedEvent: + properties: + created_at: + format: date-time + type: number + x-stream-index: "002.002" + type: + default: user.presence.changed + type: string + x-stream-index: "002.001" + user: + $ref: '#/components/schemas/User' + x-stream-index: "001.001" + required: + - type + - created_at + title: UserPresenceChangedEvent + 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 + UserRatingReportResponse: + properties: + average: + format: float + type: number + x-stream-index: "002" + count: + format: int32 + type: integer + x-stream-index: "001" + required: + - count + - average + type: object + UserReactivatedEvent: + properties: + created_at: + format: date-time + type: number + x-stream-index: "002.002" + type: + default: user.reactivated + type: string + x-stream-index: "002.001" + user: + $ref: '#/components/schemas/User' + x-stream-index: "001" + required: + - type + - created_at + title: UserReactivatedEvent + 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 + UserRequest: + description: User request object + properties: + custom: + additionalProperties: {} + description: Custom user data + title: Custom + type: object + x-stream-index: "004" + id: + description: User ID + title: ID + type: string + x-stream-index: "001" + image: + description: User's profile image URL + title: Image + type: string + x-stream-index: "003" + invisible: + type: boolean + x-stream-index: "006" + language: + type: string + x-stream-index: "005" + name: + description: Optional name of user + title: Name + type: string + x-stream-index: "002" + privacy_settings: + $ref: '#/components/schemas/PrivacySettingsResponse' + x-stream-index: "007" + required: + - id + title: UserRequest + type: object + UserResponse: + description: User response object + properties: + avg_response_time: + format: int32 + type: integer + x-stream-index: "001.018" + banned: + description: Whether a user is banned or not + title: Banned + type: boolean + x-stream-index: "001.012" + blocked_user_ids: + items: + type: string + type: array + x-stream-index: "001.017" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: "001.009" + custom: + additionalProperties: {} + description: Custom data for this object + title: Custom data + type: object + x-stream-index: "001.004" + deactivated_at: + description: Date of deactivation + format: date-time + title: Deactivated at + type: number + x-stream-index: "001.016" + deleted_at: + description: Date/time of deletion + format: date-time + title: Deleted at + type: number + x-stream-index: "001.011" + id: + description: Unique user identifier + title: ID + type: string + x-stream-index: "001.001" + image: + title: Image + type: string + x-stream-index: "001.003" + language: + description: Preferred language of a user + title: Language + type: string + x-stream-index: "001.005" + last_active: + description: Date of last activity + format: date-time + title: Last active + type: number + x-stream-index: "001.014" + name: + description: Optional name of user + title: Name + type: string + x-stream-index: "001.002" + online: + description: Whether a user online or not + title: Online + type: boolean + x-stream-index: "001.013" + revoke_tokens_issued_before: + description: Revocation date for tokens + format: date-time + title: Revoke tokens issued before + type: number + x-stream-index: "001.015" + role: + description: Determines the set of user permissions + title: Role + type: string + x-stream-index: "001.006" + teams: + description: List of teams user is a part of + items: + type: string + title: Teams + type: array + x-stream-index: "001.007" + teams_role: + additionalProperties: + type: string + type: object + x-stream-index: "001.008" + updated_at: + description: Date/time of the last update + format: date-time + title: Updated at + type: number + x-stream-index: "001.010" + required: + - id + - custom + - language + - role + - teams + - created_at + - updated_at + - banned + - online + - blocked_user_ids + - shadow_banned + - invisible + title: UserResponse + type: object + UserResponseCommonFields: + properties: + avg_response_time: + format: int32 + type: integer + x-stream-index: "018" + banned: + type: boolean + x-stream-index: "012" + blocked_user_ids: + items: + type: string + type: array + x-stream-index: "017" + created_at: + format: date-time + type: number + x-stream-index: "009" + custom: + additionalProperties: {} + type: object + x-stream-index: "004" + deactivated_at: + format: date-time + type: number + x-stream-index: "016" + deleted_at: + format: date-time + type: number + x-stream-index: "011" + id: + type: string + x-stream-index: "001" + image: + type: string + x-stream-index: "003" + language: + type: string + x-stream-index: "005" + last_active: + format: date-time + type: number + x-stream-index: "014" + name: + type: string + x-stream-index: "002" + online: + type: boolean + x-stream-index: "013" + revoke_tokens_issued_before: + format: date-time + type: number + x-stream-index: "015" + role: + type: string + x-stream-index: "006" + teams: + items: + type: string + type: array + x-stream-index: "007" + teams_role: + additionalProperties: + type: string + type: object + x-stream-index: "008" + updated_at: + format: date-time + type: number + x-stream-index: "010" + required: + - id + - custom + - language + - role + - teams + - created_at + - updated_at + - banned + - online + - blocked_user_ids + type: object + UserResponsePrivacyFields: + properties: + avg_response_time: + format: int32 + type: integer + x-stream-index: "001.018" + banned: + type: boolean + x-stream-index: "001.012" + blocked_user_ids: + items: + type: string + type: array + x-stream-index: "001.017" + created_at: + format: date-time + type: number + x-stream-index: "001.009" + custom: + additionalProperties: {} + type: object + x-stream-index: "001.004" + deactivated_at: + format: date-time + type: number + x-stream-index: "001.016" + deleted_at: + format: date-time + type: number + x-stream-index: "001.011" + id: + type: string + x-stream-index: "001.001" + image: + type: string + x-stream-index: "001.003" + invisible: + type: boolean + x-stream-index: "003" + language: + type: string + x-stream-index: "001.005" + last_active: + format: date-time + type: number + x-stream-index: "001.014" + name: + type: string + x-stream-index: "001.002" + online: + type: boolean + x-stream-index: "001.013" + privacy_settings: + $ref: '#/components/schemas/PrivacySettingsResponse' + x-stream-index: "002" + revoke_tokens_issued_before: + format: date-time + type: number + x-stream-index: "001.015" + role: + type: string + x-stream-index: "001.006" + teams: + items: + type: string + type: array + x-stream-index: "001.007" + teams_role: + additionalProperties: + type: string + type: object + x-stream-index: "001.008" + updated_at: + format: date-time + type: number + x-stream-index: "001.010" + required: + - id + - custom + - language + - role + - teams + - created_at + - updated_at + - banned + - online + - blocked_user_ids + type: object + UserRuleParameters: + properties: + max_age: + type: string + x-stream-index: "001" + type: object + UserUnbannedEvent: + properties: + channel_id: + type: string + x-stream-index: "002.002" + channel_type: + type: string + x-stream-index: "002.003" + cid: + type: string + x-stream-index: "002.001" + created_at: + format: date-time + type: number + x-stream-index: "005.002" + shadow: + type: boolean + x-stream-index: "001" + team: + type: string + x-stream-index: "004.001" + type: + default: user.unbanned + type: string + x-stream-index: "005.001" + user: + $ref: '#/components/schemas/User' + x-stream-index: "003.001" + required: + - shadow + - cid + - channel_id + - channel_type + - type + - created_at + title: UserUnbannedEvent + 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 + UserUpdatedEvent: + description: This event is sent when a user gets updated. The event contains + information about the updated user. + nullable: true + properties: + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: "001.003" + custom: + additionalProperties: {} + type: object + x-stream-index: "001.007" + received_at: + format: date-time + type: number + x-stream-index: "001.004" + type: + default: user.updated + description: 'The type of event: "user.updated" in this case' + title: Event Type + type: string + x-stream-index: "001.002" + user: + $ref: '#/components/schemas/UserResponsePrivacyFields' + description: The updated user + title: User + x-stream-index: "002.001" + required: + - type + - created_at + - custom + - user + title: UserUpdatedEvent + 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 + UserWatchingStartEvent: + properties: + channel_id: + type: string + x-stream-index: "004.002" + channel_type: + type: string + x-stream-index: "004.003" + cid: + type: string + x-stream-index: "004.001" + created_at: + format: date-time + type: number + x-stream-index: "003.002" + team: + type: string + x-stream-index: "002.001" + type: + default: user.watching.start + type: string + x-stream-index: "003.001" + user: + $ref: '#/components/schemas/User' + x-stream-index: "005.001" + watcher_count: + format: int32 + type: integer + x-stream-index: "001.001" + required: + - watcher_count + - type + - created_at + - cid + - channel_id + - channel_type + title: UserWatchingStartEvent + 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 + UserWatchingStopEvent: + properties: + channel_id: + type: string + x-stream-index: "004.002" + channel_type: + type: string + x-stream-index: "004.003" + cid: + type: string + x-stream-index: "004.001" + created_at: + format: date-time + type: number + x-stream-index: "002.002" + type: + default: user.watching.stop + type: string + x-stream-index: "002.001" + user: + $ref: '#/components/schemas/User' + x-stream-index: "003.001" + watcher_count: + format: int32 + type: integer + x-stream-index: "001.001" + required: + - watcher_count + - type + - created_at + - cid + - channel_id + - channel_type + title: UserWatchingStopEvent + 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 + VelocityFilterConfig: + properties: + advanced_filters: + type: boolean + x-stream-index: "007" + async: + type: boolean + x-stream-index: "001" + cascading_actions: + type: boolean + x-stream-index: "004" + cids_per_user: + format: int32 + type: integer + x-stream-index: "006" + enabled: + type: boolean + x-stream-index: "002" + first_message_only: + type: boolean + x-stream-index: "005" + rules: + items: + $ref: '#/components/schemas/VelocityFilterConfigRule' + type: array + x-stream-index: "003" + required: + - enabled + - rules + - cascading_actions + - first_message_only + - cids_per_user + - advanced_filters + type: object + VelocityFilterConfigRule: + properties: + action: + enum: + - flag + - shadow + - remove + - ban + type: string + x-stream-index: "001" + ban_duration: + format: int32 + type: integer + x-stream-index: "002" + cascading_action: + enum: + - flag + - shadow + - remove + - ban + type: string + x-stream-index: "006" + cascading_threshold: + format: int64 + type: integer + x-stream-index: "005" + check_message_context: + type: boolean + x-stream-index: "009" + fast_spam_threshold: + format: int32 + type: integer + x-stream-index: "007" + fast_spam_ttl: + format: int32 + type: integer + x-stream-index: "010" + ip_ban: + type: boolean + x-stream-index: "004" + probation_period: + format: int32 + type: integer + x-stream-index: "014" + shadow_ban: + type: boolean + x-stream-index: "003" + slow_spam_ban_duration: + format: int32 + type: integer + x-stream-index: "012" + slow_spam_threshold: + format: int32 + type: integer + x-stream-index: "008" + slow_spam_ttl: + format: int32 + type: integer + x-stream-index: "011" + url_only: + type: boolean + x-stream-index: "013" + required: + - action + - ban_duration + - shadow_ban + - ip_ban + - cascading_threshold + - cascading_action + - fast_spam_threshold + - slow_spam_threshold + - check_message_context + - fast_spam_ttl + - slow_spam_ttl + - url_only + - probation_period + type: object + VideoCallRuleConfig: + properties: + rules: + additionalProperties: + $ref: '#/components/schemas/HarmConfig' + type: object + x-stream-index: "001" + required: + - rules + type: object + VideoContentParameters: + properties: + harm_labels: + items: + type: string + type: array + x-stream-index: "001" + type: object + VideoEndCallRequest: + type: object + VideoKickUserRequest: + type: object + VideoOrientation: + properties: + orientation: + type: integer + x-stream-index: "004" + type: object + VideoReactionOverTimeResponse: + properties: + by_minute: + items: + $ref: '#/components/schemas/CountByMinuteResponse' + type: array + x-stream-index: "001" + type: object + VideoReactionsResponse: + nullable: true + properties: + count_over_time: + $ref: '#/components/schemas/VideoReactionOverTimeResponse' + x-stream-index: "002" + reaction: + type: string + x-stream-index: "001" + required: + - reaction + type: object + VideoRuleParameters: + properties: + harm_labels: + items: + type: string + type: array + x-stream-index: "003" + threshold: + format: int32 + type: integer + x-stream-index: "001" + time_window: + type: string + x-stream-index: "002" + type: object + VideoSettings: + properties: + access_request_enabled: + type: boolean + x-stream-index: "002" + camera_default_on: + type: boolean + x-stream-index: "004" + camera_facing: + enum: + - front + - back + - external + type: string + x-stream-index: "005" + enabled: + type: boolean + x-stream-index: "001" + target_resolution: + $ref: '#/components/schemas/TargetResolution' + x-stream-index: "003" + required: + - enabled + - access_request_enabled + - target_resolution + - camera_default_on + - camera_facing + type: object + VideoSettingsRequest: + properties: + access_request_enabled: + type: boolean + x-stream-index: "002" + camera_default_on: + type: boolean + x-stream-index: "004" + camera_facing: + enum: + - front + - back + - external + type: string + x-stream-index: "005" + enabled: + type: boolean + x-stream-index: "001" + target_resolution: + $ref: '#/components/schemas/TargetResolution' + x-stream-index: "003" + type: object + VideoSettingsResponse: + properties: + access_request_enabled: + type: boolean + x-stream-index: "002" + camera_default_on: + type: boolean + x-stream-index: "004" + camera_facing: + enum: + - front + - back + - external + type: string + x-stream-index: "005" + enabled: + type: boolean + x-stream-index: "001" + target_resolution: + $ref: '#/components/schemas/TargetResolution' + x-stream-index: "003" + required: + - enabled + - access_request_enabled + - target_resolution + - camera_default_on + - camera_facing + type: object + VoteData: + properties: + answer_text: + type: string + x-stream-index: "002" + option_id: + maxLength: 255 + type: string + x-stream-index: "001" + type: object + WSAuthMessage: + description: Websocket auth message + nullable: true + properties: + products: + items: + type: string + type: array + x-stream-index: "003" + token: + title: Token + type: string + x-stream-index: "002" + user_details: + $ref: '#/components/schemas/ConnectUserDetailsRequest' + x-stream-index: "001" + required: + - user_details + - token + title: WSAuthMessage + type: object + WSClientEvent: + description: The discriminator object for all websocket client events, it maps + events' payload to the final type + discriminator: + mapping: app.updated: '#/components/schemas/AppUpdatedEvent' draft.deleted: '#/components/schemas/DraftDeletedEvent' draft.updated: '#/components/schemas/DraftUpdatedEvent' + feeds.activity.added: '#/components/schemas/ActivityAddedEvent' + feeds.activity.deleted: '#/components/schemas/ActivityDeletedEvent' + feeds.activity.marked: '#/components/schemas/ActivityMarkEvent' + feeds.activity.pinned: '#/components/schemas/ActivityPinnedEvent' + feeds.activity.reaction.added: '#/components/schemas/ActivityReactionAddedEvent' + feeds.activity.reaction.deleted: '#/components/schemas/ActivityReactionDeletedEvent' + feeds.activity.reaction.updated: '#/components/schemas/ActivityReactionUpdatedEvent' + feeds.activity.removed_from_feed: '#/components/schemas/ActivityRemovedFromFeedEvent' + feeds.activity.unpinned: '#/components/schemas/ActivityUnpinnedEvent' + feeds.activity.updated: '#/components/schemas/ActivityUpdatedEvent' + feeds.bookmark.added: '#/components/schemas/BookmarkAddedEvent' + feeds.bookmark.deleted: '#/components/schemas/BookmarkDeletedEvent' + feeds.bookmark.updated: '#/components/schemas/BookmarkUpdatedEvent' + feeds.bookmark_folder.deleted: '#/components/schemas/BookmarkFolderDeletedEvent' + feeds.bookmark_folder.updated: '#/components/schemas/BookmarkFolderUpdatedEvent' + feeds.comment.added: '#/components/schemas/CommentAddedEvent' + feeds.comment.deleted: '#/components/schemas/CommentDeletedEvent' + feeds.comment.reaction.added: '#/components/schemas/CommentReactionAddedEvent' + feeds.comment.reaction.deleted: '#/components/schemas/CommentReactionDeletedEvent' + feeds.comment.reaction.updated: '#/components/schemas/CommentReactionUpdatedEvent' + feeds.comment.updated: '#/components/schemas/CommentUpdatedEvent' + feeds.feed.created: '#/components/schemas/FeedCreatedEvent' + feeds.feed.deleted: '#/components/schemas/FeedDeletedEvent' + feeds.feed.updated: '#/components/schemas/FeedUpdatedEvent' + feeds.feed_group.changed: '#/components/schemas/FeedGroupChangedEvent' + feeds.feed_group.deleted: '#/components/schemas/FeedGroupDeletedEvent' + feeds.feed_member.added: '#/components/schemas/FeedMemberAddedEvent' + feeds.feed_member.removed: '#/components/schemas/FeedMemberRemovedEvent' + feeds.feed_member.updated: '#/components/schemas/FeedMemberUpdatedEvent' + feeds.follow.created: '#/components/schemas/FollowCreatedEvent' + feeds.follow.deleted: '#/components/schemas/FollowDeletedEvent' + feeds.follow.updated: '#/components/schemas/FollowUpdatedEvent' + feeds.notification_feed.updated: '#/components/schemas/NotificationFeedUpdatedEvent' + feeds.poll.closed: '#/components/schemas/PollClosedFeedEvent' + feeds.poll.deleted: '#/components/schemas/PollDeletedFeedEvent' + feeds.poll.updated: '#/components/schemas/PollUpdatedFeedEvent' + feeds.poll.vote_casted: '#/components/schemas/PollVoteCastedFeedEvent' + feeds.poll.vote_changed: '#/components/schemas/PollVoteChangedFeedEvent' + feeds.poll.vote_removed: '#/components/schemas/PollVoteRemovedFeedEvent' health.check: '#/components/schemas/HealthCheckEvent' message.pending: '#/components/schemas/PendingMessageEvent' notification.reminder_due: '#/components/schemas/ReminderNotificationEvent' @@ -20734,24 +26888,65 @@ components: reminder.created: '#/components/schemas/ReminderCreatedEvent' reminder.deleted: '#/components/schemas/ReminderDeletedEvent' reminder.updated: '#/components/schemas/ReminderUpdatedEvent' + user.messages.deleted: '#/components/schemas/UserMessagesDeletedEvent' user.updated: '#/components/schemas/UserUpdatedEvent' propertyName: type oneOf: + - $ref: '#/components/schemas/ActivityAddedEvent' + - $ref: '#/components/schemas/ActivityDeletedEvent' + - $ref: '#/components/schemas/ActivityMarkEvent' + - $ref: '#/components/schemas/ActivityPinnedEvent' + - $ref: '#/components/schemas/ActivityReactionAddedEvent' + - $ref: '#/components/schemas/ActivityReactionDeletedEvent' + - $ref: '#/components/schemas/ActivityReactionUpdatedEvent' + - $ref: '#/components/schemas/ActivityRemovedFromFeedEvent' + - $ref: '#/components/schemas/ActivityUnpinnedEvent' + - $ref: '#/components/schemas/ActivityUpdatedEvent' - $ref: '#/components/schemas/AppUpdatedEvent' + - $ref: '#/components/schemas/BookmarkAddedEvent' + - $ref: '#/components/schemas/BookmarkDeletedEvent' + - $ref: '#/components/schemas/BookmarkFolderDeletedEvent' + - $ref: '#/components/schemas/BookmarkFolderUpdatedEvent' + - $ref: '#/components/schemas/BookmarkUpdatedEvent' + - $ref: '#/components/schemas/CommentAddedEvent' + - $ref: '#/components/schemas/CommentDeletedEvent' + - $ref: '#/components/schemas/CommentReactionAddedEvent' + - $ref: '#/components/schemas/CommentReactionDeletedEvent' + - $ref: '#/components/schemas/CommentReactionUpdatedEvent' + - $ref: '#/components/schemas/CommentUpdatedEvent' - $ref: '#/components/schemas/DraftDeletedEvent' - $ref: '#/components/schemas/DraftUpdatedEvent' + - $ref: '#/components/schemas/FeedCreatedEvent' + - $ref: '#/components/schemas/FeedDeletedEvent' + - $ref: '#/components/schemas/FeedGroupChangedEvent' + - $ref: '#/components/schemas/FeedGroupDeletedEvent' + - $ref: '#/components/schemas/FeedMemberAddedEvent' + - $ref: '#/components/schemas/FeedMemberRemovedEvent' + - $ref: '#/components/schemas/FeedMemberUpdatedEvent' + - $ref: '#/components/schemas/FeedUpdatedEvent' + - $ref: '#/components/schemas/FollowCreatedEvent' + - $ref: '#/components/schemas/FollowDeletedEvent' + - $ref: '#/components/schemas/FollowUpdatedEvent' - $ref: '#/components/schemas/HealthCheckEvent' + - $ref: '#/components/schemas/NotificationFeedUpdatedEvent' - $ref: '#/components/schemas/PendingMessageEvent' - $ref: '#/components/schemas/PollClosedEvent' + - $ref: '#/components/schemas/PollClosedFeedEvent' - $ref: '#/components/schemas/PollDeletedEvent' + - $ref: '#/components/schemas/PollDeletedFeedEvent' - $ref: '#/components/schemas/PollUpdatedEvent' + - $ref: '#/components/schemas/PollUpdatedFeedEvent' - $ref: '#/components/schemas/PollVoteCastedEvent' + - $ref: '#/components/schemas/PollVoteCastedFeedEvent' - $ref: '#/components/schemas/PollVoteChangedEvent' + - $ref: '#/components/schemas/PollVoteChangedFeedEvent' - $ref: '#/components/schemas/PollVoteRemovedEvent' + - $ref: '#/components/schemas/PollVoteRemovedFeedEvent' - $ref: '#/components/schemas/ReminderCreatedEvent' - $ref: '#/components/schemas/ReminderDeletedEvent' - $ref: '#/components/schemas/ReminderNotificationEvent' - $ref: '#/components/schemas/ReminderUpdatedEvent' + - $ref: '#/components/schemas/UserMessagesDeletedEvent' - $ref: '#/components/schemas/UserUpdatedEvent' WSEvent: description: The discriminator object for all websocket events, it maps events' @@ -20780,6 +26975,7 @@ components: call.hls_broadcasting_failed: '#/components/schemas/CallHLSBroadcastingFailedEvent' call.hls_broadcasting_started: '#/components/schemas/CallHLSBroadcastingStartedEvent' call.hls_broadcasting_stopped: '#/components/schemas/CallHLSBroadcastingStoppedEvent' + call.kicked_user: '#/components/schemas/KickedUserEvent' call.live_started: '#/components/schemas/CallLiveStartedEvent' call.member_added: '#/components/schemas/CallMemberAddedEvent' call.member_removed: '#/components/schemas/CallMemberRemovedEvent' @@ -20829,6 +27025,45 @@ components: custom: '#/components/schemas/CustomVideoEvent' draft.deleted: '#/components/schemas/DraftDeletedEvent' draft.updated: '#/components/schemas/DraftUpdatedEvent' + feeds.activity.added: '#/components/schemas/ActivityAddedEvent' + feeds.activity.deleted: '#/components/schemas/ActivityDeletedEvent' + feeds.activity.marked: '#/components/schemas/ActivityMarkEvent' + feeds.activity.pinned: '#/components/schemas/ActivityPinnedEvent' + feeds.activity.reaction.added: '#/components/schemas/ActivityReactionAddedEvent' + feeds.activity.reaction.deleted: '#/components/schemas/ActivityReactionDeletedEvent' + feeds.activity.reaction.updated: '#/components/schemas/ActivityReactionUpdatedEvent' + feeds.activity.removed_from_feed: '#/components/schemas/ActivityRemovedFromFeedEvent' + feeds.activity.unpinned: '#/components/schemas/ActivityUnpinnedEvent' + feeds.activity.updated: '#/components/schemas/ActivityUpdatedEvent' + feeds.bookmark.added: '#/components/schemas/BookmarkAddedEvent' + feeds.bookmark.deleted: '#/components/schemas/BookmarkDeletedEvent' + feeds.bookmark.updated: '#/components/schemas/BookmarkUpdatedEvent' + feeds.bookmark_folder.deleted: '#/components/schemas/BookmarkFolderDeletedEvent' + feeds.bookmark_folder.updated: '#/components/schemas/BookmarkFolderUpdatedEvent' + feeds.comment.added: '#/components/schemas/CommentAddedEvent' + feeds.comment.deleted: '#/components/schemas/CommentDeletedEvent' + feeds.comment.reaction.added: '#/components/schemas/CommentReactionAddedEvent' + feeds.comment.reaction.deleted: '#/components/schemas/CommentReactionDeletedEvent' + feeds.comment.reaction.updated: '#/components/schemas/CommentReactionUpdatedEvent' + feeds.comment.updated: '#/components/schemas/CommentUpdatedEvent' + feeds.feed.created: '#/components/schemas/FeedCreatedEvent' + feeds.feed.deleted: '#/components/schemas/FeedDeletedEvent' + feeds.feed.updated: '#/components/schemas/FeedUpdatedEvent' + feeds.feed_group.changed: '#/components/schemas/FeedGroupChangedEvent' + feeds.feed_group.deleted: '#/components/schemas/FeedGroupDeletedEvent' + feeds.feed_member.added: '#/components/schemas/FeedMemberAddedEvent' + feeds.feed_member.removed: '#/components/schemas/FeedMemberRemovedEvent' + feeds.feed_member.updated: '#/components/schemas/FeedMemberUpdatedEvent' + feeds.follow.created: '#/components/schemas/FollowCreatedEvent' + feeds.follow.deleted: '#/components/schemas/FollowDeletedEvent' + feeds.follow.updated: '#/components/schemas/FollowUpdatedEvent' + feeds.notification_feed.updated: '#/components/schemas/NotificationFeedUpdatedEvent' + feeds.poll.closed: '#/components/schemas/PollClosedFeedEvent' + feeds.poll.deleted: '#/components/schemas/PollDeletedFeedEvent' + feeds.poll.updated: '#/components/schemas/PollUpdatedFeedEvent' + feeds.poll.vote_casted: '#/components/schemas/PollVoteCastedFeedEvent' + feeds.poll.vote_changed: '#/components/schemas/PollVoteChangedFeedEvent' + feeds.poll.vote_removed: '#/components/schemas/PollVoteRemovedFeedEvent' health.check: '#/components/schemas/HealthCheckEvent' member.added: '#/components/schemas/MemberAddedEvent' member.removed: '#/components/schemas/MemberRemovedEvent' @@ -20874,6 +27109,7 @@ components: user.banned: '#/components/schemas/UserBannedEvent' user.deactivated: '#/components/schemas/UserDeactivatedEvent' user.deleted: '#/components/schemas/UserDeletedEvent' + user.messages.deleted: '#/components/schemas/UserMessagesDeletedEvent' user.muted: '#/components/schemas/UserMutedEvent' user.presence.changed: '#/components/schemas/UserPresenceChangedEvent' user.reactivated: '#/components/schemas/UserReactivatedEvent' @@ -20886,10 +27122,25 @@ components: - $ref: '#/components/schemas/AIIndicatorClearEvent' - $ref: '#/components/schemas/AIIndicatorStopEvent' - $ref: '#/components/schemas/AIIndicatorUpdateEvent' + - $ref: '#/components/schemas/ActivityAddedEvent' + - $ref: '#/components/schemas/ActivityDeletedEvent' + - $ref: '#/components/schemas/ActivityMarkEvent' - $ref: '#/components/schemas/ActivityMarkedEvent' + - $ref: '#/components/schemas/ActivityPinnedEvent' + - $ref: '#/components/schemas/ActivityReactionAddedEvent' + - $ref: '#/components/schemas/ActivityReactionDeletedEvent' + - $ref: '#/components/schemas/ActivityReactionUpdatedEvent' + - $ref: '#/components/schemas/ActivityRemovedFromFeedEvent' + - $ref: '#/components/schemas/ActivityUnpinnedEvent' + - $ref: '#/components/schemas/ActivityUpdatedEvent' - $ref: '#/components/schemas/AnyEvent' - $ref: '#/components/schemas/AppUpdatedEvent' - $ref: '#/components/schemas/BlockedUserEvent' + - $ref: '#/components/schemas/BookmarkAddedEvent' + - $ref: '#/components/schemas/BookmarkDeletedEvent' + - $ref: '#/components/schemas/BookmarkFolderDeletedEvent' + - $ref: '#/components/schemas/BookmarkFolderUpdatedEvent' + - $ref: '#/components/schemas/BookmarkUpdatedEvent' - $ref: '#/components/schemas/CallAcceptedEvent' - $ref: '#/components/schemas/CallClosedCaptionsFailedEvent' - $ref: '#/components/schemas/CallClosedCaptionsStartedEvent' @@ -20946,12 +27197,30 @@ components: - $ref: '#/components/schemas/ChannelUpdatedEvent' - $ref: '#/components/schemas/ChannelVisibleEvent' - $ref: '#/components/schemas/ClosedCaptionEvent' + - $ref: '#/components/schemas/CommentAddedEvent' + - $ref: '#/components/schemas/CommentDeletedEvent' + - $ref: '#/components/schemas/CommentReactionAddedEvent' + - $ref: '#/components/schemas/CommentReactionDeletedEvent' + - $ref: '#/components/schemas/CommentReactionUpdatedEvent' + - $ref: '#/components/schemas/CommentUpdatedEvent' - $ref: '#/components/schemas/ConnectedEvent' - $ref: '#/components/schemas/ConnectionErrorEvent' - $ref: '#/components/schemas/CustomVideoEvent' - $ref: '#/components/schemas/DraftDeletedEvent' - $ref: '#/components/schemas/DraftUpdatedEvent' + - $ref: '#/components/schemas/FeedCreatedEvent' + - $ref: '#/components/schemas/FeedDeletedEvent' + - $ref: '#/components/schemas/FeedGroupChangedEvent' + - $ref: '#/components/schemas/FeedGroupDeletedEvent' + - $ref: '#/components/schemas/FeedMemberAddedEvent' + - $ref: '#/components/schemas/FeedMemberRemovedEvent' + - $ref: '#/components/schemas/FeedMemberUpdatedEvent' + - $ref: '#/components/schemas/FeedUpdatedEvent' + - $ref: '#/components/schemas/FollowCreatedEvent' + - $ref: '#/components/schemas/FollowDeletedEvent' + - $ref: '#/components/schemas/FollowUpdatedEvent' - $ref: '#/components/schemas/HealthCheckEvent' + - $ref: '#/components/schemas/KickedUserEvent' - $ref: '#/components/schemas/MemberAddedEvent' - $ref: '#/components/schemas/MemberRemovedEvent' - $ref: '#/components/schemas/MemberUpdatedEvent' @@ -20968,6 +27237,7 @@ components: - $ref: '#/components/schemas/NotificationChannelDeletedEvent' - $ref: '#/components/schemas/NotificationChannelMutesUpdatedEvent' - $ref: '#/components/schemas/NotificationChannelTruncatedEvent' + - $ref: '#/components/schemas/NotificationFeedUpdatedEvent' - $ref: '#/components/schemas/NotificationInviteAcceptedEvent' - $ref: '#/components/schemas/NotificationInviteRejectedEvent' - $ref: '#/components/schemas/NotificationInvitedEvent' @@ -20979,11 +27249,17 @@ components: - $ref: '#/components/schemas/PendingMessageEvent' - $ref: '#/components/schemas/PermissionRequestEvent' - $ref: '#/components/schemas/PollClosedEvent' + - $ref: '#/components/schemas/PollClosedFeedEvent' - $ref: '#/components/schemas/PollDeletedEvent' + - $ref: '#/components/schemas/PollDeletedFeedEvent' - $ref: '#/components/schemas/PollUpdatedEvent' + - $ref: '#/components/schemas/PollUpdatedFeedEvent' - $ref: '#/components/schemas/PollVoteCastedEvent' + - $ref: '#/components/schemas/PollVoteCastedFeedEvent' - $ref: '#/components/schemas/PollVoteChangedEvent' + - $ref: '#/components/schemas/PollVoteChangedFeedEvent' - $ref: '#/components/schemas/PollVoteRemovedEvent' + - $ref: '#/components/schemas/PollVoteRemovedFeedEvent' - $ref: '#/components/schemas/ReactionDeletedEvent' - $ref: '#/components/schemas/ReactionNewEvent' - $ref: '#/components/schemas/ReactionUpdatedEvent' @@ -20999,6 +27275,7 @@ components: - $ref: '#/components/schemas/UserBannedEvent' - $ref: '#/components/schemas/UserDeactivatedEvent' - $ref: '#/components/schemas/UserDeletedEvent' + - $ref: '#/components/schemas/UserMessagesDeletedEvent' - $ref: '#/components/schemas/UserMutedEvent' - $ref: '#/components/schemas/UserPresenceChangedEvent' - $ref: '#/components/schemas/UserReactivatedEvent' @@ -21017,97 +27294,2492 @@ components: x-stream-index: "001.005" channels: items: - $ref: '#/components/schemas/UnreadCountsChannel' + $ref: '#/components/schemas/UnreadCountsChannel' + type: array + x-stream-index: "001.004" + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "002.001" + threads: + items: + $ref: '#/components/schemas/UnreadCountsThread' + type: array + x-stream-index: "001.006" + total_unread_count: + format: int32 + type: integer + x-stream-index: "001.001" + total_unread_count_by_team: + additionalProperties: + format: int32 + type: integer + type: object + x-stream-index: "001.003" + total_unread_threads_count: + format: int32 + type: integer + x-stream-index: "001.002" + required: + - total_unread_count + - total_unread_threads_count + - channels + - channel_type + - threads + - duration + title: Response + type: object + securitySchemes: + JWT: + description: | + JWT should be always provided when stream-auth-type=jwt. + + Using JWT auth request could be authenticated as user or as server-side. + + When using user authentication permission checking is going to be applied to requests based on the user that is + performing a request. + + The `authorization` header should be a JWT string signed using the secret attached to the API key used to perform + requests. + + **WARNING** all client-side official SDK do not ship with token generation; this is to make sure that the API secret is not + shared with an untrusted party such as a browser or a iOS/Android application. Tokens **must** be generated server-side. + If you wish, you can configure your application to ignore authentication (see `disable_auth_check`) + The JWT string must include only the user_id claim and can include any built-in JWT claim such as iat, exp as well. + in: header + name: Authorization + type: apiKey + api_key: + description: Application API key should be always set in order to authenticate + the request. + in: query + name: api_key + type: apiKey + stream-auth-type: + description: |- + Stream-Auth-Type should be always set in order to authenticate the request. Possible + values: `jwt` or `anonymous`. + + `jwt` allows you to authenticate as a user. With this auth type you should also provide valid JWT in Authorization + header. + + `anonymous` allows you to authenticate as anonymous user. Please note that most advanced features are not available + to anonymous users. + in: header + name: Stream-Auth-Type + type: apiKey +info: + title: Stream API + version: v191.1.0 +openapi: 3.0.3 +paths: + /api/v2/app: + get: + description: | + This Method returns the application settings + operationId: GetApp + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/GetApplicationResponse' + 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: Get App Settings + tags: + - product:common + /api/v2/blocklists: + get: + description: | + Returns all available block lists + operationId: ListBlockLists + parameters: + - in: query + name: team + schema: + type: string + writeOnly: true + x-stream-index: "001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/ListBlockListResponse' + 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: List block lists + tags: + - product:common + post: + description: | + Creates a new application blocklist, once created the blocklist can be used by any channel type + operationId: CreateBlockList + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateBlockListRequest' + description: Block list + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/CreateBlockListResponse' + 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: Create block list + tags: + - product:common + /api/v2/blocklists/{name}: + delete: + description: | + Deletes previously created application blocklist + operationId: DeleteBlockList + parameters: + - in: path + name: name + required: true + schema: + type: string + writeOnly: true + x-stream-index: "001" + - in: query + name: team + schema: + type: string + x-stream-index: "002" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/Response' + 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: Delete block list + tags: + - product:common + put: + description: | + Updates contents of the block list + operationId: UpdateBlockList + parameters: + - in: path + name: name + required: true + schema: + description: Block list name + title: Name + type: string + writeOnly: true + x-stream-index: "001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateBlockListRequest' + description: Update block list + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateBlockListResponse' + 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: Update block list + tags: + - product:common + /api/v2/chat/channels: + post: + description: | + Query channels with filter query + operationId: QueryChannels + parameters: + - in: query + name: connection_id + schema: + description: Websocket connection ID to interact with. You can pass it as + Body or URL parameter + title: Connection ID + type: string + x-stream-index: "011.003" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueryChannelsRequest' + description: Query Channels Request + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/QueryChannelsResponse' + description: Channels list + "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: Query channels + tags: + - product:chat + /api/v2/chat/channels/{type}/{id}: + delete: + description: | + Deletes channel + + Sends events: + - channel.deleted + - channel.deleted + operationId: DeleteChannel + parameters: + - in: path + name: type + required: true + schema: + description: Channel type to interact with + title: Channel type + type: string + writeOnly: true + x-stream-index: "001.001" + - in: path + name: id + required: true + schema: + description: Channel ID to interact with + title: Channel ID + type: string + writeOnly: true + x-stream-index: "001.002" + - in: query + name: hard_delete + schema: + type: boolean + x-stream-index: "002" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteChannelResponse' + 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: Delete channel + tags: + - product:chat + patch: + description: | + Updates certain fields of the channel + + Sends events: + - channel.updated + - channel.updated + operationId: UpdateChannelPartial + parameters: + - in: path + name: type + required: true + schema: + description: Channel type to interact with + title: Channel type + type: string + writeOnly: true + x-stream-index: "001.001" + - in: path + name: id + required: true + schema: + description: Channel ID to interact with + title: Channel ID + type: string + writeOnly: true + x-stream-index: "001.002" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateChannelPartialRequest' + description: UpdateChannelPartialRequest + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateChannelPartialResponse' + description: Successful 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: Partially update channel + tags: + - product:chat + post: + description: | + Change channel data + + Sends events: + - channel.updated + - member.added + - member.removed + - member.updated + - message.new + - channel.updated + - member.added + - member.removed + - member.updated + - message.new + operationId: UpdateChannel + parameters: + - in: path + name: type + required: true + schema: + type: string + writeOnly: true + x-stream-index: 013.002.001 + - in: path + name: id + required: true + schema: + type: string + writeOnly: true + x-stream-index: 013.002.002 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateChannelRequest' + description: Channel update request + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateChannelResponse' + description: Successful 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: Update channel + tags: + - product:chat + /api/v2/chat/channels/{type}/{id}/draft: + delete: + description: | + Deletes a draft + + Sends events: + - draft.deleted + operationId: DeleteDraft + parameters: + - in: path + name: type + required: true + schema: + type: string + writeOnly: true + x-stream-index: "002.001" + - in: path + name: id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "002.002" + - in: query + name: parent_id + schema: + description: Parent message ID + title: string + type: string + writeOnly: true + x-stream-index: "001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/Response' + 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: Delete draft + tags: + - product:chat + get: + description: | + Get a draft + operationId: GetDraft + parameters: + - in: path + name: type + required: true + schema: + type: string + writeOnly: true + x-stream-index: "002.001" + - in: path + name: id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "002.002" + - in: query + name: parent_id + schema: + description: Parent message ID + title: string + type: string + writeOnly: true + x-stream-index: "001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/GetDraftResponse' + 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: Get draft + tags: + - product:chat + post: + description: | + Creates a draft + + Sends events: + - draft.updated + operationId: CreateDraft + parameters: + - in: path + name: type + required: true + schema: + description: Channel type to interact with + title: Channel type + type: string + writeOnly: true + x-stream-index: "002.001" + - in: path + name: id + required: true + schema: + description: Channel ID to interact with + title: Channel ID + type: string + writeOnly: true + x-stream-index: "002.002" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateDraftRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/CreateDraftResponse' + 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: Create a draft + tags: + - product:chat + /api/v2/chat/channels/{type}/{id}/event: + post: + description: | + Sends event to the channel + operationId: SendEvent + parameters: + - in: path + name: type + required: true + schema: + description: Channel type to interact with + title: Channel type + type: string + writeOnly: true + x-stream-index: "002.001" + - in: path + name: id + required: true + schema: + description: Channel ID to interact with + title: Channel ID + type: string + writeOnly: true + x-stream-index: "002.002" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SendEventRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/EventResponse' + 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: Send event + tags: + - product:chat + /api/v2/chat/channels/{type}/{id}/file: + delete: + description: | + Deletes previously uploaded file + operationId: DeleteFile + parameters: + - in: path + name: type + required: true + schema: + description: The type of file + title: Type + type: string + writeOnly: true + x-stream-index: "002.001" + - in: path + name: id + required: true + schema: + description: File ID + title: ID + type: string + writeOnly: true + x-stream-index: "002.002" + - in: query + name: url + schema: + description: File URL to delete + title: URL + type: string + writeOnly: true + x-stream-index: "001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/Response' + 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: Delete file + tags: + - product:chat + post: + description: | + Uploads file + operationId: UploadFile + parameters: + - in: path + name: type + required: true + schema: + type: string + writeOnly: true + x-stream-index: "001.001" + - in: path + name: id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "001.002" + requestBody: + content: + multipart/form-data: + schema: + $ref: '#/components/schemas/FileUploadRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/FileUploadResponse' + description: Successful 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: Upload file + tags: + - product:chat + /api/v2/chat/channels/{type}/{id}/hide: + post: + description: | + Marks channel as hidden for current user + + Sends events: + - channel.hidden + - channel.hidden + operationId: HideChannel + parameters: + - in: path + name: type + required: true + schema: + type: string + writeOnly: true + x-stream-index: "002.001" + - in: path + name: id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "002.002" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/HideChannelRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/HideChannelResponse' + 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: Hide channel + tags: + - product:chat + /api/v2/chat/channels/{type}/{id}/image: + delete: + description: | + Deletes previously uploaded image + operationId: DeleteImage + parameters: + - in: path + name: type + required: true + schema: + description: The type of file + title: Type + type: string + writeOnly: true + x-stream-index: "002.001" + - in: path + name: id + required: true + schema: + description: File ID + title: ID + type: string + writeOnly: true + x-stream-index: "002.002" + - in: query + name: url + schema: + description: File URL to delete + title: URL + type: string + writeOnly: true + x-stream-index: "001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/Response' + 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: Delete image + tags: + - product:chat + post: + description: | + Uploads image + operationId: UploadImage + parameters: + - in: path + name: type + required: true + schema: + type: string + writeOnly: true + x-stream-index: 001.001.001 + - in: path + name: id + required: true + schema: + type: string + writeOnly: true + x-stream-index: 001.001.002 + requestBody: + content: + multipart/form-data: + schema: + $ref: '#/components/schemas/ImageUploadRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/ImageUploadResponse' + description: Successful 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: Upload image + tags: + - product:chat + /api/v2/chat/channels/{type}/{id}/member: + patch: + description: |2+ + + operationId: UpdateMemberPartial + parameters: + - in: path + name: type + required: true + schema: + type: string + writeOnly: true + x-stream-index: "003.001" + - in: path + name: id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "003.002" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateMemberPartialRequest' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateMemberPartialResponse' + description: Successful 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: Partially channel member update + tags: + - product:chat + /api/v2/chat/channels/{type}/{id}/message: + post: + description: | + Sends new message to the specified channel + + Sends events: + - message.new + - message.updated + - message.new + - message.updated + operationId: SendMessage + parameters: + - in: path + name: type + required: true + schema: + description: Channel type to interact with + title: Channel type + type: string + writeOnly: true + x-stream-index: "009.001" + - in: path + name: id + required: true + schema: + description: Channel ID to interact with + title: Channel ID + type: string + writeOnly: true + x-stream-index: "009.002" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SendMessageRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/SendMessageResponse' + description: Successful 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: Send new message + tags: + - product:chat + /api/v2/chat/channels/{type}/{id}/messages: + get: + description: | + Returns list messages found by IDs + operationId: GetManyMessages + parameters: + - in: path + name: type + required: true + schema: + type: string + writeOnly: true + x-stream-index: "002.001" + - in: path + name: id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "002.002" + - in: query + name: ids + required: true + schema: + description: List of comma-separated IDs + items: + type: string + maximum: 50 + minimum: 1 + title: IDs type: array - x-stream-index: "001.004" - duration: - description: Duration of the request in milliseconds - title: Duration + writeOnly: true + x-stream-index: "001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/GetManyMessagesResponse' + description: Successful 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: Get many messages + tags: + - product:chat + /api/v2/chat/channels/{type}/{id}/query: + post: + description: | + This Method creates a channel or returns an existing one with matching attributes + + Sends events: + - channel.created + - member.added + - member.removed + - member.updated + - user.watching.start + operationId: GetOrCreateChannel + parameters: + - in: path + name: type + required: true + schema: + description: Channel type + maxLength: 64 + title: Type + type: string + writeOnly: true + x-stream-index: "001" + - in: path + name: id + required: true + schema: + description: Channel ID (maximum length of 64 characters) + title: ID + type: string + writeOnly: true + x-stream-index: "002" + - in: query + name: connection_id + schema: + description: Websocket connection ID to interact with. You can pass it as + Body or URL parameter + title: Connection ID + type: string + x-stream-index: "012.003" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChannelGetOrCreateRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/ChannelStateResponse' + description: Successful 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: Get or create channel + tags: + - product:chat + /api/v2/chat/channels/{type}/{id}/read: + post: + description: | + Marks channel as read up to the specific message + + Sends events: + - message.read + - message.read + operationId: MarkRead + parameters: + - in: path + name: type + required: true + schema: + type: string + writeOnly: true + x-stream-index: "003.001" + - in: path + name: id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "003.002" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MarkReadRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/MarkReadResponse' + description: Successful 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 read + tags: + - product:chat + /api/v2/chat/channels/{type}/{id}/show: + post: + description: | + Shows previously hidden channel + + Sends events: + - channel.visible + - channel.visible + operationId: ShowChannel + parameters: + - in: path + name: type + required: true + schema: + description: Channel type to interact with + title: Channel type + type: string + writeOnly: true + x-stream-index: "001.001" + - in: path + name: id + required: true + schema: + description: Channel ID to interact with + title: Channel ID + type: string + writeOnly: true + x-stream-index: "001.002" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ShowChannelRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/ShowChannelResponse' + 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: Show channel + tags: + - product:chat + /api/v2/chat/channels/{type}/{id}/stop-watching: + post: + description: | + Call this Method to stop receiving channel events + + Sends events: + - user.watching.stop + - user.watching.stop + operationId: StopWatchingChannel + parameters: + - in: path + name: type + required: true + schema: + type: string + writeOnly: true + x-stream-index: "002.001" + - in: path + name: id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "002.002" + - in: query + name: connection_id + schema: + type: string + x-stream-index: "001.003" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChannelStopWatchingRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/Response' + 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: Stop watching channel + tags: + - product:chat + /api/v2/chat/channels/{type}/{id}/truncate: + post: + description: | + Truncates messages from a channel. Can be applied to the entire channel or scoped to specific members. + + Sends events: + - channel.truncated + - channel.truncated + operationId: TruncateChannel + parameters: + - in: path + name: type + required: true + schema: + type: string + writeOnly: true + x-stream-index: "001.001" + - in: path + name: id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "001.002" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TruncateChannelRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/TruncateChannelResponse' + description: Successful 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: Truncate channel + tags: + - product:chat + /api/v2/chat/channels/{type}/{id}/unread: + post: + description: | + Marks channel as unread from a specific message + operationId: MarkUnread + parameters: + - in: path + name: type + required: true + schema: + type: string + writeOnly: true + x-stream-index: "002.001" + - in: path + name: id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "002.002" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MarkUnreadRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/Response' + 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 unread + tags: + - product:chat + /api/v2/chat/channels/{type}/query: + post: + description: | + This Method creates a channel or returns an existing one with matching attributes + + Sends events: + - channel.created + - member.added + - member.removed + - member.updated + - user.watching.start + operationId: GetOrCreateDistinctChannel + parameters: + - in: path + name: type + required: true + schema: + description: Channel type + maxLength: 64 + title: Type + type: string + writeOnly: true + x-stream-index: "001" + - in: query + name: connection_id + schema: + description: Websocket connection ID to interact with. You can pass it as + Body or URL parameter + title: Connection ID + type: string + x-stream-index: "012.003" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChannelGetOrCreateRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/ChannelStateResponse' + description: Successful 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: Get or create channel + tags: + - product:chat + /api/v2/chat/channels/delete: + post: + description: | + Allows to delete several channels at once asynchronously + + Sends events: + - channel.deleted + - channel.deleted + operationId: DeleteChannels + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteChannelsRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteChannelsResponse' + description: Successful 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: Deletes channels asynchronously + tags: + - product:chat + /api/v2/chat/channels/read: + post: + description: | + Marks channels as read up to the specific message. If no channels is given, mark all channel as read + + Sends events: + - message.read + - message.read + operationId: MarkChannelsRead + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MarkChannelsReadRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/MarkReadResponse' + description: Successful 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 channels as read + tags: + - product:chat + /api/v2/chat/drafts/query: + post: + description: | + Queries draft messages for a user + operationId: QueryDrafts + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueryDraftsRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/QueryDraftsResponse' + description: Successful 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: Query draft messages + tags: + - product:chat + /api/v2/chat/members: + get: + description: | + Find and filter channel members + operationId: QueryMembers + parameters: + - content: + application/json: + schema: + $ref: '#/components/schemas/QueryMembersPayload' + x-stream-index: "001" + in: query + name: payload + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/MembersResponse' + description: Successful 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: Query members + tags: + - product:chat + /api/v2/chat/messages/{id}: + delete: + description: | + Deletes message + + Sends events: + - message.deleted + - message.deleted + operationId: DeleteMessage + parameters: + - in: path + name: id + required: true + schema: + description: Message ID to delete + title: ID + type: string + writeOnly: true + x-stream-index: "001" + - in: query + name: hard + schema: + description: Delete all message reactions and replies as well + title: Hard + type: boolean + writeOnly: true + x-stream-index: "002" + - in: query + name: deleted_by + schema: + type: string + writeOnly: true + x-stream-index: "003" + - in: query + name: delete_for_me + schema: + description: Delete the message only for the user making the request + title: Delete for me + type: boolean + writeOnly: true + x-stream-index: "004" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteMessageResponse' + 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: Delete message + tags: + - product:chat + get: + description: | + Returns message by ID + operationId: GetMessage + parameters: + - in: path + name: id + required: true + schema: + description: ID of the message + title: ID + type: string + writeOnly: true + x-stream-index: "001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/GetMessageResponse' + 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: Get message + tags: + - product:chat + post: + description: | + Updates message with new data + + Sends events: + - message.updated + - message.updated + operationId: UpdateMessage + parameters: + - in: path + name: id + required: true + schema: + description: Message ID + title: ID + type: string + writeOnly: true + x-stream-index: "004.001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateMessageRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateMessageResponse' + 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: Update message + tags: + - product:chat + put: + description: | + Updates certain fields of the message + + Sends events: + - message.updated + - message.updated + operationId: UpdateMessagePartial + parameters: + - in: path + name: id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "003.001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateMessagePartialRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateMessagePartialResponse' + description: Successful 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: Partially message update + tags: + - product:chat + /api/v2/chat/messages/{id}/action: + post: + description: | + Executes message command action with given parameters + + Sends events: + - message.new + - message.new + operationId: RunMessageAction + parameters: + - in: path + name: id + required: true + schema: + description: Message ID + title: ID + type: string + writeOnly: true + x-stream-index: "001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MessageActionRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/MessageResponse' + 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: Run message command action + tags: + - product:chat + /api/v2/chat/messages/{id}/reaction: + post: + description: | + Sends reaction to specified message + + Sends events: + - reaction.new + - reaction.updated + operationId: SendReaction + parameters: + - in: path + name: id + required: true + schema: + description: Message ID to send reaction for + title: ID + type: string + writeOnly: true + x-stream-index: "001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SendReactionRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/SendReactionResponse' + 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: Send reaction + tags: + - product:chat + /api/v2/chat/messages/{id}/reaction/{type}: + delete: + description: | + Removes user reaction from the message + + Sends events: + - reaction.deleted + operationId: DeleteReaction + parameters: + - in: path + name: id + required: true + schema: + description: Message ID to remove reaction from + title: ID + type: string + writeOnly: true + x-stream-index: "001" + - in: path + name: type + required: true + schema: + description: Reaction type to remove + title: Type + type: string + writeOnly: true + x-stream-index: "002" + - in: query + name: user_id + schema: + description: '**Server-side only**. User ID which server acts upon' + title: User ID + type: string + writeOnly: true + x-stream-index: "003" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteReactionResponse' + 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: Delete reaction + tags: + - product:chat + /api/v2/chat/messages/{id}/reactions: + get: + description: | + Returns list of reactions of specific message + operationId: GetReactions + parameters: + - in: path + name: id + required: true + schema: + description: Message ID + title: ID + type: string + writeOnly: true + x-stream-index: "001" + - in: query + name: limit + schema: + description: Number of records to return + format: int32 + title: Limit + type: integer + writeOnly: true + x-stream-index: "002" + - in: query + name: offset + schema: + description: Number of records to offset + format: int32 + title: Offset + type: integer + writeOnly: true + x-stream-index: "003" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/GetReactionsResponse' + description: Successful 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: Get reactions + tags: + - product:chat + post: + description: | + Get reactions on a message + operationId: QueryReactions + parameters: + - in: path + name: id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueryReactionsRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/QueryReactionsResponse' + 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 + tags: + - product:chat + /api/v2/chat/messages/{id}/translate: + post: + description: | + Translates message to a given language using automated translation software + + Sends events: + - message.updated + - message.updated + operationId: TranslateMessage + parameters: + - in: path + name: id + required: true + schema: + description: Message ID + title: ID + type: string + writeOnly: true + x-stream-index: "002.001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TranslateMessageRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/MessageResponse' + 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: Translate message + tags: + - product:chat + /api/v2/chat/messages/{message_id}/polls/{poll_id}/vote: + post: + description: | + Cast a vote on a poll + + Sends events: + - feeds.poll.vote_casted + - feeds.poll.vote_changed + - feeds.poll.vote_removed + - poll.vote_casted + - poll.vote_changed + - poll.vote_removed + operationId: CastPollVote + parameters: + - in: path + name: message_id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "001" + - in: path + name: poll_id + required: true + schema: + description: Poll ID + maxLength: 255 + title: string + type: string + x-stream-index: "003" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CastPollVoteRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/PollVoteResponse' + description: Successful 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: Cast vote + tags: + - product:chat + /api/v2/chat/messages/{message_id}/polls/{poll_id}/vote/{vote_id}: + delete: + description: | + Delete a vote from a poll + + Sends events: + - feeds.poll.vote_removed + - poll.vote_removed + operationId: DeletePollVote + parameters: + - in: path + name: message_id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "002" + - in: path + name: poll_id + required: true + schema: + description: Poll ID + maxLength: 255 + title: string + type: string + x-stream-index: "004" + - in: path + name: vote_id + required: true + schema: + description: Vote ID + maxLength: 255 + title: string + type: string + x-stream-index: "005" + - in: query + name: user_id + schema: + type: string + writeOnly: true + x-stream-index: "001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/PollVoteResponse' + description: Successful 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: Delete vote + tags: + - product:chat + /api/v2/chat/messages/{message_id}/reminders: + delete: + description: | + Deletes a user's created reminder + + Sends events: + - reminder.deleted + operationId: DeleteReminder + parameters: + - in: path + name: message_id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "002" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteReminderResponse' + 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: Delete reminder + tags: + - product:chat + patch: + description: | + Updates an existing reminder + + Sends events: + - reminder.updated + operationId: UpdateReminder + parameters: + - in: path + name: message_id + required: true + schema: type: string - x-stream-index: "002.001" - threads: + writeOnly: true + x-stream-index: "002" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateReminderRequest' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateReminderResponse' + 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: Updates Reminder + tags: + - product:chat + post: + description: | + Creates a new reminder + + Sends events: + - reminder.created + operationId: CreateReminder + parameters: + - in: path + name: message_id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "002" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateReminderRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/ReminderResponseData' + description: Successful 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: Create reminder + tags: + - product:chat + /api/v2/chat/messages/{parent_id}/replies: + get: + description: | + Returns replies (thread) of the message + operationId: GetReplies + parameters: + - in: path + name: parent_id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "001" + - in: query + name: sort + schema: items: - $ref: '#/components/schemas/UnreadCountsThread' + $ref: '#/components/schemas/SortParamRequest' + maximum: 1 type: array - x-stream-index: "001.006" - total_unread_count: + writeOnly: true + x-stream-index: "002" + - in: query + name: limit + schema: + description: 'The maximum number of messages to return (max limit ' format: int32 + minimum: 0 + title: Limit type: integer - x-stream-index: "001.001" - total_unread_count_by_team: - additionalProperties: - format: int32 - type: integer - type: object - x-stream-index: "001.003" - total_unread_threads_count: + x-stream-index: "003.001" + - in: query + name: offset + schema: + description: The offset to start from format: int32 + title: Offset type: integer - x-stream-index: "001.002" - required: - - total_unread_count - - total_unread_threads_count - - channels - - channel_type - - threads - - duration - title: Response - type: object - securitySchemes: - JWT: - description: | - JWT should be always provided when stream-auth-type=jwt. - - Using JWT auth request could be authenticated as user or as server-side. - - When using user authentication permission checking is going to be applied to requests based on the user that is - performing a request. - - The `authorization` header should be a JWT string signed using the secret attached to the API key used to perform - requests. - - **WARNING** all client-side official SDK do not ship with token generation; this is to make sure that the API secret is not - shared with an untrusted party such as a browser or a iOS/Android application. Tokens **must** be generated server-side. - If you wish, you can configure your application to ignore authentication (see `disable_auth_check`) - The JWT string must include only the user_id claim and can include any built-in JWT claim such as iat, exp as well. - in: header - name: Authorization - type: apiKey - api_key: - description: Application API key should be always set in order to authenticate - the request. - in: query - name: api_key - type: apiKey - stream-auth-type: - description: |- - Stream-Auth-Type should be always set in order to authenticate the request. Possible - values: `jwt` or `anonymous`. - - `jwt` allows you to authenticate as a user. With this auth type you should also provide valid JWT in Authorization - header. - - `anonymous` allows you to authenticate as anonymous user. Please note that most advanced features are not available - to anonymous users. - in: header - name: Stream-Auth-Type - type: apiKey -info: - title: Stream API - version: v187.13.0 -openapi: 3.0.3 -paths: - /api/v2/app: - get: - description: | - This Method returns the application settings - operationId: GetApp + x-stream-index: "003.002" + - in: query + name: id_gte + schema: + description: The ID of the message to get messages with a timestamp greater + than or equal to + title: IDGTE + type: string + x-stream-index: "003.003" + - in: query + name: id_gt + schema: + description: The ID of the message to get messages with a timestamp greater + than + title: IDGT + type: string + x-stream-index: "003.004" + - in: query + name: id_lte + schema: + description: The ID of the message to get messages with a timestamp smaller + than or equal to + title: IDLTE + type: string + x-stream-index: "003.005" + - in: query + name: id_lt + schema: + description: The ID of the message to get messages with a timestamp smaller + than + title: IDLT + type: string + x-stream-index: "003.006" + - in: query + name: created_at_after_or_equal + schema: + description: The timestamp to get messages with a created_at timestamp greater + than or equal to + format: date-time + title: Created_at after or equal + type: number + x-stream-index: "003.007" + - in: query + name: created_at_after + schema: + description: The timestamp to get messages with a created_at timestamp greater + than + format: date-time + title: Created_at after + type: number + x-stream-index: "003.008" + - in: query + name: created_at_before_or_equal + schema: + description: The timestamp to get messages with a created_at timestamp smaller + than or equal to + format: date-time + title: Created_at after before or equal + type: number + x-stream-index: "003.009" + - in: query + name: created_at_before + schema: + description: The timestamp to get messages with a created_at timestamp smaller + than + format: date-time + title: Created_at after before + type: number + x-stream-index: "003.010" + - in: query + name: id_around + schema: + description: The result will be a set of messages, that are both older and + newer than the message with the provided ID, and the message with the + ID provided will be in the middle of the set + title: Id around + type: string + x-stream-index: "003.011" + - in: query + name: created_at_around + schema: + description: The result will be a set of messages, that are both older and + newer than the created_at timestamp provided, distributed evenly around + the timestamp + format: date-time + title: Created_at around + type: number + x-stream-index: "003.012" responses: "200": content: application/json: schema: - $ref: '#/components/schemas/GetApplicationResponse' + $ref: '#/components/schemas/GetRepliesResponse' description: Response "400": content: @@ -21121,28 +29793,31 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Get App Settings + summary: Get replies tags: - - product:common - /api/v2/blocklists: + - product:chat + /api/v2/chat/moderation/flags/message: get: description: | - Returns all available block lists - operationId: ListBlockLists + Find and filter message flags + operationId: QueryMessageFlags parameters: - - in: query - name: team - schema: - type: string - writeOnly: true - x-stream-index: "001" + - content: + application/json: + schema: + $ref: '#/components/schemas/QueryMessageFlagsPayload' + description: JSON object with query message flags payload + title: Payload + x-stream-index: "001" + in: query + name: payload responses: "200": content: application/json: schema: - $ref: '#/components/schemas/ListBlockListResponse' - description: Response + $ref: '#/components/schemas/QueryMessageFlagsResponse' + description: QueryMessageFlagsResponse "400": content: application/json: @@ -21155,27 +29830,31 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: List block lists + summary: Query Message Flags tags: - - product:common + - product:chat + /api/v2/chat/moderation/mute/channel: post: description: | - Creates a new application blocklist, once created the blocklist can be used by any channel type - operationId: CreateBlockList + Mutes channel for user + + Sends events: + - channel.muted + - channel.muted + operationId: MuteChannel requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateBlockListRequest' - description: Block list + $ref: '#/components/schemas/MuteChannelRequest' required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/CreateBlockListResponse' - description: Response + $ref: '#/components/schemas/MuteChannelResponse' + description: Successful response "400": content: application/json: @@ -21188,33 +29867,30 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Create block list + summary: Mute channel tags: - - product:common - /api/v2/blocklists/{name}: - delete: + - product:chat + /api/v2/chat/moderation/unmute/channel: + post: description: | - Deletes previously created application blocklist - operationId: DeleteBlockList - parameters: - - in: path - name: name + Unmutes channel for user + + Sends events: + - channel.unmuted + - channel.unmuted + operationId: UnmuteChannel + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UnmuteChannelRequest' required: true - schema: - type: string - writeOnly: true - x-stream-index: "001" - - in: query - name: team - schema: - type: string - x-stream-index: "002" responses: - "200": + "201": content: application/json: schema: - $ref: '#/components/schemas/Response' + $ref: '#/components/schemas/UnmuteResponse' description: Response "400": content: @@ -21228,37 +29904,27 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Delete block list + summary: Unmute channel tags: - - product:common - put: + - product:chat + /api/v2/chat/push_preferences: + post: description: | - Updates contents of the block list - operationId: UpdateBlockList - parameters: - - in: path - name: name - required: true - schema: - description: Block list name - title: Name - type: string - writeOnly: true - x-stream-index: "001" + Update the push preferences for a user and or channel member. Set to all, mentions or none + operationId: UpdatePushNotificationPreferences requestBody: content: application/json: schema: - $ref: '#/components/schemas/UpdateBlockListRequest' - description: Update block list + $ref: '#/components/schemas/UpsertPushPreferencesRequest' required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/UpdateBlockListResponse' - description: Response + $ref: '#/components/schemas/UpsertPushPreferencesResponse' + description: Successful response "400": content: application/json: @@ -21271,37 +29937,64 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Update block list + summary: Push notification preferences tags: - - product:common - /api/v2/chat/channels: - post: + - product:chat + /api/v2/chat/query_banned_users: + get: description: | - Query channels with filter query - operationId: QueryChannels + Find and filter channel scoped or global user bans + operationId: QueryBannedUsers parameters: - - in: query - name: connection_id - schema: - description: Websocket connection ID to interact with. You can pass it as - Body or URL parameter - title: Connection ID - type: string - x-stream-index: "011.003" + - content: + application/json: + schema: + $ref: '#/components/schemas/QueryBannedUsersPayload' + description: JSON object with query user bans payload + title: Payload + x-stream-index: "001" + in: query + name: payload + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/QueryBannedUsersResponse' + description: Successful 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: Query Banned Users + tags: + - product:chat + /api/v2/chat/reminders/query: + post: + description: | + Queries reminders + operationId: QueryReminders requestBody: content: application/json: schema: - $ref: '#/components/schemas/QueryChannelsRequest' - description: Query Channels Request + $ref: '#/components/schemas/QueryRemindersRequest' required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/QueryChannelsResponse' - description: Channels list + $ref: '#/components/schemas/QueryRemindersResponse' + description: Successful response "400": content: application/json: @@ -21314,49 +30007,31 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Query channels + summary: Query reminders tags: - product:chat - /api/v2/chat/channels/{type}/{id}: - delete: + /api/v2/chat/search: + get: description: | - Deletes channel - - Sends events: - - channel.deleted - - channel.deleted - operationId: DeleteChannel - parameters: - - in: path - name: type - required: true - schema: - description: Channel type to interact with - title: Channel type - type: string - writeOnly: true - x-stream-index: "001.001" - - in: path - name: id - required: true - schema: - description: Channel ID to interact with - title: Channel ID - type: string - writeOnly: true - x-stream-index: "001.002" - - in: query - name: hard_delete - schema: - type: boolean - x-stream-index: "002" + Search messages across channels + operationId: Search + parameters: + - content: + application/json: + schema: + $ref: '#/components/schemas/SearchPayload' + description: JSON object with search payload + title: Payload + x-stream-index: "001" + in: query + name: payload responses: "200": content: application/json: schema: - $ref: '#/components/schemas/DeleteChannelResponse' - description: Response + $ref: '#/components/schemas/SearchResponse' + description: Successful response "400": content: application/json: @@ -21369,50 +30044,51 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Delete channel + summary: Search messages tags: - product:chat - patch: + /api/v2/chat/sync: + post: description: | - Updates certain fields of the channel - - Sends events: - - channel.updated - - channel.updated - operationId: UpdateChannelPartial + Returns all events happened since client disconnect in specified channels + operationId: Sync parameters: - - in: path - name: type - required: true + - in: query + name: with_inaccessible_cids schema: - description: Channel type to interact with - title: Channel type - type: string - writeOnly: true - x-stream-index: "001.001" - - in: path - name: id - required: true + description: If set to true this will add 'inaccessible_cids' to response + type + title: With inaccessible CIDs + type: boolean + x-stream-index: "003" + - in: query + name: watch + schema: + description: If set to true this will start watching requested and newly + added channels that user has access to. If error occurred with this option + enabled and it is not an input error - channels will still be watched. + title: Watch synced channels + type: boolean + x-stream-index: "004" + - in: query + name: connection_id schema: - description: Channel ID to interact with - title: Channel ID type: string - writeOnly: true - x-stream-index: "001.002" + x-stream-index: "006.003" requestBody: content: application/json: schema: - $ref: '#/components/schemas/UpdateChannelPartialRequest' - description: UpdateChannelPartialRequest + $ref: '#/components/schemas/SyncRequest' + description: SyncRequest required: true responses: - "200": + "201": content: application/json: schema: - $ref: '#/components/schemas/UpdateChannelPartialResponse' - description: Successful response + $ref: '#/components/schemas/SyncResponse' + description: SyncResponse "400": content: application/json: @@ -21425,53 +30101,32 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Partially update channel + summary: Sync tags: - product:chat + /api/v2/chat/threads: post: description: | - Change channel data - - Sends events: - - channel.updated - - member.added - - member.removed - - member.updated - - message.new - - channel.updated - - member.added - - member.removed - - member.updated - - message.new - operationId: UpdateChannel + Returns the list of threads for specific user + operationId: QueryThreads parameters: - - in: path - name: type - required: true - schema: - type: string - writeOnly: true - x-stream-index: 013.002.001 - - in: path - name: id - required: true + - in: query + name: connection_id schema: type: string - writeOnly: true - x-stream-index: 013.002.002 + x-stream-index: "002" requestBody: content: application/json: schema: - $ref: '#/components/schemas/UpdateChannelRequest' - description: Channel update request + $ref: '#/components/schemas/QueryThreadsRequest' required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/UpdateChannelResponse' + $ref: '#/components/schemas/QueryThreadsResponse' description: Successful response "400": content: @@ -21485,47 +30140,75 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Update channel + summary: Query Threads tags: - product:chat - /api/v2/chat/channels/{type}/{id}/draft: - delete: + /api/v2/chat/threads/{message_id}: + get: description: | - Deletes a draft - - Sends events: - - draft.deleted - operationId: DeleteDraft + Return a specific thread + operationId: GetThread parameters: - in: path - name: type + name: message_id required: true schema: type: string writeOnly: true - x-stream-index: "002.001" - - in: path - name: id - required: true + x-stream-index: "001" + - in: query + name: watch schema: - type: string + description: Start watching the channel this thread belongs to + title: Watch + type: boolean writeOnly: true - x-stream-index: "002.002" + x-stream-index: "002" - in: query - name: parent_id + name: connection_id schema: - description: Parent message ID - title: string type: string writeOnly: true - x-stream-index: "001" + x-stream-index: "003" + - in: query + name: reply_limit + schema: + description: Limit the number of replies returned + format: int32 + minimum: 0 + title: Reply limit + type: integer + writeOnly: true + x-stream-index: "004" + - in: query + name: participant_limit + schema: + description: Limit the number of participants returned + format: int32 + maximum: 100 + minimum: 0 + title: Participant limit + type: integer + writeOnly: true + x-stream-index: "005" + - in: query + name: member_limit + schema: + description: Limit the number of members returned per thread channel + format: int32 + maximum: 100 + minimum: 0 + title: Member limit + type: integer + writeOnly: true + x-stream-index: "006" responses: "200": content: application/json: schema: - $ref: '#/components/schemas/Response' - description: Response + $ref: '#/components/schemas/GetThreadResponse' + description: Successful response "400": content: application/json: @@ -21538,43 +30221,38 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Delete draft + summary: Get Thread tags: - product:chat - get: + patch: description: | - Get a draft - operationId: GetDraft + Updates certain fields of the thread + + Sends events: + - thread.updated + - thread.updated + operationId: UpdateThreadPartial parameters: - in: path - name: type - required: true - schema: - type: string - writeOnly: true - x-stream-index: "002.001" - - in: path - name: id + name: message_id required: true schema: - type: string - writeOnly: true - x-stream-index: "002.002" - - in: query - name: parent_id - schema: - description: Parent message ID - title: string type: string writeOnly: true x-stream-index: "001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateThreadPartialRequest' + required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/GetDraftResponse' - description: Response + $ref: '#/components/schemas/UpdateThreadPartialResponse' + description: Successful response "400": content: application/json: @@ -21587,47 +30265,20 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Get draft + summary: Partially update thread tags: - product:chat - post: + /api/v2/chat/unread: + get: description: | - Creates a draft - - Sends events: - - draft.updated - operationId: CreateDraft - parameters: - - in: path - name: type - required: true - schema: - description: Channel type to interact with - title: Channel type - type: string - writeOnly: true - x-stream-index: "002.001" - - in: path - name: id - required: true - schema: - description: Channel ID to interact with - title: Channel ID - type: string - writeOnly: true - x-stream-index: "002.002" - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CreateDraftRequest' - required: true + Fetch unread counts for a single user + operationId: UnreadCounts responses: - "201": + "200": content: application/json: schema: - $ref: '#/components/schemas/CreateDraftResponse' + $ref: '#/components/schemas/WrappedUnreadCountsResponse' description: Response "400": content: @@ -21641,45 +30292,30 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Create a draft + summary: Unread counts tags: - product:chat - /api/v2/chat/channels/{type}/{id}/event: - post: + /api/v2/devices: + delete: description: | - Sends event to the channel - operationId: SendEvent + Deletes one device + operationId: DeleteDevice parameters: - - in: path - name: type - required: true - schema: - description: Channel type to interact with - title: Channel type - type: string - writeOnly: true - x-stream-index: "002.001" - - in: path + - in: query name: id required: true schema: - description: Channel ID to interact with - title: Channel ID + description: Device ID to delete + title: ID type: string writeOnly: true - x-stream-index: "002.002" - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SendEventRequest' - required: true + x-stream-index: "001" responses: - "201": + "200": content: application/json: schema: - $ref: '#/components/schemas/EventResponse' + $ref: '#/components/schemas/Response' description: Response "400": content: @@ -21693,48 +30329,20 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Send event + summary: Delete device tags: - - product:chat - /api/v2/chat/channels/{type}/{id}/file: - delete: + - product:common + get: description: | - Deletes previously uploaded file - operationId: DeleteFile - parameters: - - in: path - name: type - required: true - schema: - description: The type of file - title: Type - type: string - writeOnly: true - x-stream-index: "002.001" - - in: path - name: id - required: true - schema: - description: File ID - title: ID - type: string - writeOnly: true - x-stream-index: "002.002" - - in: query - name: url - schema: - description: File URL to delete - title: URL - type: string - writeOnly: true - x-stream-index: "001" + Returns all available devices + operationId: ListDevices responses: "200": content: application/json: schema: - $ref: '#/components/schemas/Response' - description: Response + $ref: '#/components/schemas/ListDevicesResponse' + description: ListDevicesResponse "400": content: application/json: @@ -21747,41 +30355,27 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Delete file + summary: List devices tags: - - product:chat + - product:common post: description: | - Uploads file - operationId: UploadFile - parameters: - - in: path - name: type - required: true - schema: - type: string - writeOnly: true - x-stream-index: "001.001" - - in: path - name: id - required: true - schema: - type: string - writeOnly: true - x-stream-index: "001.002" + Adds a new device to a user, if the same device already exists the call will have no effect + operationId: CreateDevice requestBody: content: - multipart/form-data: + application/json: schema: - $ref: '#/components/schemas/FileUploadRequest' + $ref: '#/components/schemas/CreateDeviceRequest' + description: CreateDeviceRequest required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/FileUploadResponse' - description: Successful response + $ref: '#/components/schemas/Response' + description: Response "400": content: application/json: @@ -21794,46 +30388,28 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Upload file + summary: Create device tags: - - product:chat - /api/v2/chat/channels/{type}/{id}/hide: + - product:common + /api/v2/feeds/activities: post: description: | - Marks channel as hidden for current user - - Sends events: - - channel.hidden - - channel.hidden - operationId: HideChannel - parameters: - - in: path - name: type - required: true - schema: - type: string - writeOnly: true - x-stream-index: "002.001" - - in: path - name: id - required: true - schema: - type: string - writeOnly: true - x-stream-index: "002.002" + Create a new activity or update an existing one + operationId: AddActivity requestBody: content: application/json: schema: - $ref: '#/components/schemas/HideChannelRequest' + $ref: '#/components/schemas/AddActivityRequest' + description: Activity Request required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/HideChannelResponse' - description: Response + $ref: '#/components/schemas/AddActivityResponse' + description: Add Activity Response "400": content: application/json: @@ -21846,48 +30422,37 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Hide channel + summary: Add a single activity tags: - - product:chat - /api/v2/chat/channels/{type}/{id}/image: + - product:feeds + /api/v2/feeds/activities/{activity_id}/bookmarks: delete: description: | - Deletes previously uploaded image - operationId: DeleteImage + Deletes a bookmark from an activity + operationId: DeleteBookmark parameters: - in: path - name: type - required: true - schema: - description: The type of file - title: Type - type: string - writeOnly: true - x-stream-index: "002.001" - - in: path - name: id + name: activity_id required: true schema: - description: File ID - title: ID + maxLength: 255 type: string writeOnly: true - x-stream-index: "002.002" + x-stream-index: "001" - in: query - name: url + name: folder_id schema: - description: File URL to delete - title: URL + maxLength: 255 type: string writeOnly: true - x-stream-index: "001" + x-stream-index: "002" responses: "200": content: application/json: schema: - $ref: '#/components/schemas/Response' - description: Response + $ref: '#/components/schemas/DeleteBookmarkResponse' + description: Delete Bookmark Response "400": content: application/json: @@ -21900,41 +30465,80 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Delete image + summary: Delete a bookmark tags: - - product:chat - post: + - product:feeds + patch: description: | - Uploads image - operationId: UploadImage + Updates a bookmark for an activity + operationId: UpdateBookmark parameters: - in: path - name: type + name: activity_id required: true schema: + description: ID of the activity + maxLength: 255 + title: Activity ID type: string writeOnly: true - x-stream-index: 001.001.001 + x-stream-index: "001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateBookmarkRequest' + description: Update Bookmark Request + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateBookmarkResponse' + description: Update Bookmark 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: Update bookmark + tags: + - product:feeds + post: + description: | + Adds a bookmark to an activity + operationId: AddBookmark + parameters: - in: path - name: id + name: activity_id required: true schema: + maxLength: 255 type: string writeOnly: true - x-stream-index: 001.001.002 + x-stream-index: "001" requestBody: content: - multipart/form-data: + application/json: schema: - $ref: '#/components/schemas/ImageUploadRequest' + $ref: '#/components/schemas/AddBookmarkRequest' + description: Add Bookmark Request required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/ImageUploadResponse' - description: Successful response + $ref: '#/components/schemas/AddBookmarkResponse' + description: Add Bookmark Response "400": content: application/json: @@ -21947,42 +30551,37 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Upload image + summary: Add bookmark tags: - - product:chat - /api/v2/chat/channels/{type}/{id}/member: - patch: - description: |2+ - - operationId: UpdateMemberPartial + - product:feeds + /api/v2/feeds/activities/{activity_id}/feedback: + post: + description: | + Submit feedback for an activity including options to show less, hide, report, or mute the user + operationId: ActivityFeedback parameters: - in: path - name: type - required: true - schema: - type: string - writeOnly: true - x-stream-index: "003.001" - - in: path - name: id + name: activity_id required: true schema: + maxLength: 255 type: string writeOnly: true - x-stream-index: "003.002" + x-stream-index: "001" requestBody: content: application/json: schema: - $ref: '#/components/schemas/UpdateMemberPartialRequest' + $ref: '#/components/schemas/ActivityFeedbackRequest' + description: Activity Feedback Request required: true responses: - "200": + "201": content: application/json: schema: - $ref: '#/components/schemas/UpdateMemberPartialResponse' - description: Successful response + $ref: '#/components/schemas/ActivityFeedbackResponse' + description: Activity Feedback Response "400": content: application/json: @@ -21995,51 +30594,51 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Partially channel member update + summary: Provide feedback on an activity tags: - - product:chat - /api/v2/chat/channels/{type}/{id}/message: + - product:feeds + /api/v2/feeds/activities/{activity_id}/polls/{poll_id}/vote: post: - description: | - Sends new message to the specified channel - - Sends events: - - message.new - - message.updated - - message.new - - message.updated - operationId: SendMessage + description: | + Cast a vote on a poll + + Sends events: + - feeds.poll.vote_casted + - feeds.poll.vote_changed + - feeds.poll.vote_removed + - poll.vote_casted + - poll.vote_changed + - poll.vote_removed + operationId: CastPollVote parameters: - in: path - name: type + name: activity_id required: true schema: - description: Channel type to interact with - title: Channel type type: string writeOnly: true - x-stream-index: "009.001" + x-stream-index: "002" - in: path - name: id + name: poll_id required: true schema: - description: Channel ID to interact with - title: Channel ID + description: Poll ID + maxLength: 255 + title: string type: string - writeOnly: true - x-stream-index: "009.002" + x-stream-index: "003" requestBody: content: application/json: schema: - $ref: '#/components/schemas/SendMessageRequest' + $ref: '#/components/schemas/CastPollVoteRequest' required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/SendMessageResponse' + $ref: '#/components/schemas/PollVoteResponse' description: Successful response "400": content: @@ -22053,40 +30652,48 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Send new message + summary: Cast vote tags: - - product:chat - /api/v2/chat/channels/{type}/{id}/messages: - get: + - product:feeds + /api/v2/feeds/activities/{activity_id}/polls/{poll_id}/vote/{vote_id}: + delete: description: | - Returns list messages found by IDs - operationId: GetManyMessages + Delete a vote from a poll + + Sends events: + - feeds.poll.vote_removed + - poll.vote_removed + operationId: DeletePollVote parameters: - in: path - name: type + name: activity_id required: true schema: type: string writeOnly: true - x-stream-index: "002.001" + x-stream-index: "003" - in: path - name: id + name: poll_id required: true schema: + description: Poll ID + maxLength: 255 + title: string type: string - writeOnly: true - x-stream-index: "002.002" - - in: query - name: ids + x-stream-index: "004" + - in: path + name: vote_id required: true schema: - description: List of comma-separated IDs - items: - type: string - maximum: 50 - minimum: 1 - title: IDs - type: array + description: Vote ID + maxLength: 255 + title: string + type: string + x-stream-index: "005" + - in: query + name: user_id + schema: + type: string writeOnly: true x-stream-index: "001" responses: @@ -22094,7 +30701,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GetManyMessagesResponse' + $ref: '#/components/schemas/PollVoteResponse' description: Successful response "400": content: @@ -22108,62 +30715,37 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Get many messages + summary: Delete vote tags: - - product:chat - /api/v2/chat/channels/{type}/{id}/query: + - product:feeds + /api/v2/feeds/activities/{activity_id}/reactions: post: description: | - This Method creates a channel or returns an existing one with matching attributes - - Sends events: - - channel.created - - member.added - - member.removed - - member.updated - - user.watching.start - operationId: GetOrCreateChannel + Adds a reaction to an activity + operationId: AddReaction parameters: - in: path - name: type + name: activity_id required: true schema: - description: Channel type - maxLength: 64 - title: Type + maxLength: 255 type: string writeOnly: true x-stream-index: "001" - - in: path - name: id - required: true - schema: - description: Channel ID (maximum length of 64 characters) - title: ID - type: string - writeOnly: true - x-stream-index: "002" - - in: query - name: connection_id - schema: - description: Websocket connection ID to interact with. You can pass it as - Body or URL parameter - title: Connection ID - type: string - x-stream-index: "012.003" requestBody: content: application/json: schema: - $ref: '#/components/schemas/ChannelGetOrCreateRequest' + $ref: '#/components/schemas/AddReactionRequest' + description: Add Reaction Request required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/ChannelStateResponse' - description: Successful response + $ref: '#/components/schemas/AddReactionResponse' + description: Add Reaction Response "400": content: application/json: @@ -22176,46 +30758,38 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Get or create channel + summary: Add reaction tags: - - product:chat - /api/v2/chat/channels/{type}/{id}/read: - post: + - product:feeds + /api/v2/feeds/activities/{activity_id}/reactions/{type}: + delete: description: | - Marks channel as read up to the specific message - - Sends events: - - message.read - - message.read - operationId: MarkRead + Removes a reaction from an activity + operationId: DeleteActivityReaction parameters: - in: path - name: type + name: activity_id required: true schema: + maxLength: 255 type: string writeOnly: true - x-stream-index: "003.001" + x-stream-index: "001" - in: path - name: id + name: type required: true schema: + maxLength: 255 type: string writeOnly: true - x-stream-index: "003.002" - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MarkReadRequest' - required: true + x-stream-index: "002" responses: - "201": + "200": content: application/json: schema: - $ref: '#/components/schemas/MarkReadResponse' - description: Successful response + $ref: '#/components/schemas/DeleteActivityReactionResponse' + description: Delete Activity Reaction Response "400": content: application/json: @@ -22228,49 +30802,34 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Mark read + summary: Remove reaction tags: - - product:chat - /api/v2/chat/channels/{type}/{id}/show: + - product:feeds + /api/v2/feeds/activities/{activity_id}/reactions/query: post: description: | - Shows previously hidden channel - - Sends events: - - channel.visible - - channel.visible - operationId: ShowChannel + Query activity reactions + operationId: QueryActivityReactions parameters: - in: path - name: type - required: true - schema: - description: Channel type to interact with - title: Channel type - type: string - writeOnly: true - x-stream-index: "001.001" - - in: path - name: id + name: activity_id required: true schema: - description: Channel ID to interact with - title: Channel ID type: string writeOnly: true - x-stream-index: "001.002" + x-stream-index: "001" requestBody: content: application/json: schema: - $ref: '#/components/schemas/ShowChannelRequest' + $ref: '#/components/schemas/QueryActivityReactionsRequest' required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/ShowChannelResponse' + $ref: '#/components/schemas/QueryActivityReactionsResponse' description: Response "400": content: @@ -22284,51 +30843,39 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Show channel + summary: Query activity reactions tags: - - product:chat - /api/v2/chat/channels/{type}/{id}/stop-watching: - post: + - product:feeds + /api/v2/feeds/activities/{id}: + delete: description: | - Call this Method to stop receiving channel events - - Sends events: - - user.watching.stop - - user.watching.stop - operationId: StopWatchingChannel + Delete a single activity by its ID + operationId: DeleteActivity parameters: - - in: path - name: type - required: true - schema: - type: string - writeOnly: true - x-stream-index: "002.001" - in: path name: id required: true schema: + maxLength: 255 type: string writeOnly: true - x-stream-index: "002.002" + x-stream-index: "001" - in: query - name: connection_id + name: hard_delete schema: - type: string - x-stream-index: "001.003" - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ChannelStopWatchingRequest' - required: true + description: Whether to permanently delete the activity instead of soft + delete + title: boolean + type: boolean + writeOnly: true + x-stream-index: "002" responses: - "201": + "200": content: application/json: schema: - $ref: '#/components/schemas/Response' - description: Response + $ref: '#/components/schemas/DeleteActivityResponse' + description: Delete Activity Response "400": content: application/json: @@ -22341,46 +30888,28 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Stop watching channel + summary: Delete a single activity tags: - - product:chat - /api/v2/chat/channels/{type}/{id}/truncate: - post: + - product:feeds + get: description: | - Truncates messages from a channel. Can be applied to the entire channel or scoped to specific members. - - Sends events: - - channel.truncated - - channel.truncated - operationId: TruncateChannel + Returns activity by ID + operationId: GetActivity parameters: - - in: path - name: type - required: true - schema: - type: string - writeOnly: true - x-stream-index: "001.001" - in: path name: id required: true schema: type: string writeOnly: true - x-stream-index: "001.002" - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/TruncateChannelRequest' - required: true + x-stream-index: "001" responses: - "201": + "200": content: application/json: schema: - $ref: '#/components/schemas/TruncateChannelResponse' - description: Successful response + $ref: '#/components/schemas/GetActivityResponse' + description: Get Activity Response "400": content: application/json: @@ -22393,42 +30922,38 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Truncate channel + summary: Get activity tags: - - product:chat - /api/v2/chat/channels/{type}/{id}/unread: - post: + - product:feeds + patch: description: | - Marks channel as unread from a specific message - operationId: MarkUnread - parameters: - - in: path - name: type - required: true - schema: - type: string - writeOnly: true - x-stream-index: "002.001" + Updates certain fields of the activity + + Sends events: + - feeds.activity.updated + operationId: UpdateActivityPartial + parameters: - in: path name: id required: true schema: + maxLength: 255 type: string writeOnly: true - x-stream-index: "002.002" + x-stream-index: "001" requestBody: content: application/json: schema: - $ref: '#/components/schemas/MarkUnreadRequest' + $ref: '#/components/schemas/UpdateActivityPartialRequest' required: true responses: - "201": + "200": content: application/json: schema: - $ref: '#/components/schemas/Response' - description: Response + $ref: '#/components/schemas/UpdateActivityPartialResponse' + description: Successful response "400": content: application/json: @@ -22441,52 +30966,37 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Mark unread + summary: Partially activity update tags: - - product:chat - /api/v2/chat/channels/{type}/query: - post: + - product:feeds + put: description: | - This Method creates a channel or returns an existing one with matching attributes + Replaces an activity with the provided data Sends events: - - channel.created - - member.added - - member.removed - - member.updated - - user.watching.start - operationId: GetOrCreateDistinctChannel + - feeds.activity.updated + operationId: UpdateActivity parameters: - in: path - name: type + name: id required: true schema: - description: Channel type - maxLength: 64 - title: Type + maxLength: 255 type: string writeOnly: true x-stream-index: "001" - - in: query - name: connection_id - schema: - description: Websocket connection ID to interact with. You can pass it as - Body or URL parameter - title: Connection ID - type: string - x-stream-index: "012.003" requestBody: content: application/json: schema: - $ref: '#/components/schemas/ChannelGetOrCreateRequest' + $ref: '#/components/schemas/UpdateActivityRequest' required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/ChannelStateResponse' + $ref: '#/components/schemas/UpdateActivityResponse' description: Successful response "400": content: @@ -22500,31 +31010,28 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Get or create channel + summary: Full activity update tags: - - product:chat - /api/v2/chat/channels/delete: + - product:feeds + /api/v2/feeds/activities/batch: post: description: | - Allows to delete several channels at once asynchronously - - Sends events: - - channel.deleted - - channel.deleted - operationId: DeleteChannels + Create new activities or update existing ones in a batch operation + operationId: UpsertActivities requestBody: content: application/json: schema: - $ref: '#/components/schemas/DeleteChannelsRequest' + $ref: '#/components/schemas/UpsertActivitiesRequest' + description: Upsert Activities Request required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/DeleteChannelsResponse' - description: Successful response + $ref: '#/components/schemas/UpsertActivitiesResponse' + description: Upsert Activities Response "400": content: application/json: @@ -22537,31 +31044,28 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Deletes channels asynchronously + summary: Upsert multiple activities tags: - - product:chat - /api/v2/chat/channels/read: + - product:feeds + /api/v2/feeds/activities/delete: post: description: | - Marks channels as read up to the specific message. If no channels is given, mark all channel as read - - Sends events: - - message.read - - message.read - operationId: MarkChannelsRead + Delete one or more activities by their IDs + operationId: DeleteActivities requestBody: content: application/json: schema: - $ref: '#/components/schemas/MarkChannelsReadRequest' + $ref: '#/components/schemas/DeleteActivitiesRequest' + description: Delete Activities Request required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/MarkReadResponse' - description: Successful response + $ref: '#/components/schemas/DeleteActivitiesResponse' + description: Delete Activities Response "400": content: application/json: @@ -22574,27 +31078,28 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Mark channels as read + summary: Remove multiple activities tags: - - product:chat - /api/v2/chat/drafts/query: + - product:feeds + /api/v2/feeds/activities/query: post: description: | - Queries draft messages for a user - operationId: QueryDrafts + Query activities based on filters with pagination and sorting options + operationId: QueryActivities requestBody: content: application/json: schema: - $ref: '#/components/schemas/QueryDraftsRequest' + $ref: '#/components/schemas/QueryActivitiesRequest' + description: Query Activities Request required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/QueryDraftsResponse' - description: Successful response + $ref: '#/components/schemas/QueryActivitiesResponse' + description: Query Activities Response "400": content: application/json: @@ -22607,29 +31112,30 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Query draft messages + summary: Query activities tags: - - product:chat - /api/v2/chat/members: - get: + - product:feeds + /api/v2/feeds/bookmark_folders/{folder_id}: + delete: description: | - Find and filter channel members - operationId: QueryMembers + Delete a bookmark folder by its ID + operationId: DeleteBookmarkFolder parameters: - - content: - application/json: - schema: - $ref: '#/components/schemas/QueryMembersPayload' - x-stream-index: "001" - in: query - name: payload + - in: path + name: folder_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" responses: "200": content: application/json: schema: - $ref: '#/components/schemas/MembersResponse' - description: Successful response + $ref: '#/components/schemas/DeleteBookmarkFolderResponse' + description: Delete Bookmark Folder Response "400": content: application/json: @@ -22642,49 +31148,36 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Query members + summary: Delete a bookmark folder tags: - - product:chat - /api/v2/chat/messages/{id}: - delete: + - product:feeds + patch: description: | - Deletes message - - Sends events: - - message.deleted - - message.deleted - operationId: DeleteMessage + Update a bookmark folder by its ID + operationId: UpdateBookmarkFolder parameters: - in: path - name: id + name: folder_id required: true schema: - description: Message ID to delete - title: ID + maxLength: 255 type: string writeOnly: true x-stream-index: "001" - - in: query - name: hard - schema: - description: Delete all message reactions and replies as well - title: Hard - type: boolean - writeOnly: true - x-stream-index: "002" - - in: query - name: deleted_by - schema: - type: string - writeOnly: true - x-stream-index: "003" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateBookmarkFolderRequest' + description: Update Bookmark Folder Request + required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/DeleteMessageResponse' - description: Response + $ref: '#/components/schemas/UpdateBookmarkFolderResponse' + description: Update Bookmark Folder Response "400": content: application/json: @@ -22697,30 +31190,165 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Delete message + summary: Update a bookmark folder tags: - - product:chat + - product:feeds + /api/v2/feeds/bookmark_folders/query: + post: + description: | + Query bookmark folders with filter query + operationId: QueryBookmarkFolders + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueryBookmarkFoldersRequest' + description: Query Bookmark Folders Request + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/QueryBookmarkFoldersResponse' + description: Query Bookmark Folders 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: Query bookmark folders + tags: + - product:feeds + /api/v2/feeds/bookmarks/query: + post: + description: | + Query bookmarks with filter query + operationId: QueryBookmarks + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueryBookmarksRequest' + description: Query Bookmarks Request + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/QueryBookmarksResponse' + description: Query Bookmarks 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: Query bookmarks + tags: + - product:feeds + /api/v2/feeds/comments: get: description: | - Returns message by ID - operationId: GetMessage + Retrieve a threaded list of comments for a specific object (e.g., activity), with configurable depth, sorting, and pagination + operationId: GetComments parameters: - - in: path - name: id + - in: query + name: object_id required: true schema: - description: ID of the message - title: ID + description: ID of the object to get comments for + title: Object ID type: string writeOnly: true x-stream-index: "001" + - in: query + name: object_type + required: true + schema: + description: Type of the object to get comments for + title: Object Type + type: string + writeOnly: true + x-stream-index: "002" + - in: query + name: depth + schema: + description: Maximum nested depth to return (0 = only first level) + format: int32 + maximum: 5 + minimum: 0 + title: Max Depth + type: integer + writeOnly: true + x-stream-index: "003" + - in: query + name: sort + schema: + description: Sort order for the comments + enum: + - first + - last + - top + - best + - controversial + title: Sort Order + type: string + writeOnly: true + x-stream-index: "004" + - in: query + name: replies_limit + schema: + format: int32 + maximum: 20 + minimum: 0 + type: integer + writeOnly: true + x-stream-index: "005" + - in: query + name: limit + schema: + description: Max number of top‑level comments to return + format: int32 + maximum: 100 + minimum: 0 + title: Root Limit + type: integer + writeOnly: true + x-stream-index: "006.001" + - in: query + name: prev + schema: + type: string + writeOnly: true + x-stream-index: "006.002" + - in: query + name: next + schema: + type: string + writeOnly: true + x-stream-index: "006.003" responses: "200": content: application/json: schema: - $ref: '#/components/schemas/GetMessageResponse' - description: Response + $ref: '#/components/schemas/GetCommentsResponse' + description: Get Comments Response "400": content: application/json: @@ -22733,40 +31361,27 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Get message + summary: Get comments for an object tags: - - product:chat + - product:feeds post: description: | - Updates message with new data - - Sends events: - - message.updated - - message.updated - operationId: UpdateMessage - parameters: - - in: path - name: id - required: true - schema: - description: Message ID - title: ID - type: string - writeOnly: true - x-stream-index: "004.001" + Adds a comment to an object (e.g., activity) or a reply to an existing comment, and broadcasts appropriate events + operationId: AddComment requestBody: content: application/json: schema: - $ref: '#/components/schemas/UpdateMessageRequest' + $ref: '#/components/schemas/AddCommentRequest' + description: Add Comment Request required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/UpdateMessageResponse' - description: Response + $ref: '#/components/schemas/AddCommentResponse' + description: Add Comment Response "400": content: application/json: @@ -22779,17 +31394,14 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Update message + summary: Add a comment or reply tags: - - product:chat - put: + - product:feeds + /api/v2/feeds/comments/{id}: + delete: description: | - Updates certain fields of the message - - Sends events: - - message.updated - - message.updated - operationId: UpdateMessagePartial + Deletes a comment from an object (e.g., activity) and broadcasts appropriate events + operationId: DeleteComment parameters: - in: path name: id @@ -22797,20 +31409,22 @@ paths: schema: type: string writeOnly: true - x-stream-index: "003.001" - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/UpdateMessagePartialRequest' - required: true + x-stream-index: "001" + - in: query + name: hard_delete + schema: + description: Whether to permanently delete the comment instead of soft delete + title: Hard Delete + type: boolean + writeOnly: true + x-stream-index: "002" responses: - "201": + "200": content: application/json: schema: - $ref: '#/components/schemas/UpdateMessagePartialResponse' - description: Successful response + $ref: '#/components/schemas/DeleteCommentResponse' + description: Delete Comment Response "400": content: application/json: @@ -22823,41 +31437,28 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Partially message update + summary: Delete a comment tags: - - product:chat - /api/v2/chat/messages/{id}/action: - post: + - product:feeds + get: description: | - Executes message command action with given parameters - - Sends events: - - message.new - - message.new - operationId: RunMessageAction + Get a comment by ID + operationId: GetComment parameters: - in: path name: id required: true schema: - description: Message ID - title: ID type: string writeOnly: true x-stream-index: "001" - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MessageActionRequest' - required: true responses: - "201": + "200": content: application/json: schema: - $ref: '#/components/schemas/MessageResponse' - description: Response + $ref: '#/components/schemas/GetCommentResponse' + description: Get Comment Response "400": content: application/json: @@ -22870,25 +31471,18 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Run message command action + summary: Get comment tags: - - product:chat - /api/v2/chat/messages/{id}/reaction: - post: + - product:feeds + patch: description: | - Sends reaction to specified message - - Sends events: - - reaction.new - - reaction.updated - operationId: SendReaction + Updates a comment on an object (e.g., activity) and broadcasts appropriate events + operationId: UpdateComment parameters: - in: path name: id required: true schema: - description: Message ID to send reaction for - title: ID type: string writeOnly: true x-stream-index: "001" @@ -22896,15 +31490,16 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SendReactionRequest' + $ref: '#/components/schemas/UpdateCommentRequest' + description: Update Comment Request required: true responses: - "201": + "200": content: application/json: schema: - $ref: '#/components/schemas/SendReactionResponse' - description: Response + $ref: '#/components/schemas/UpdateCommentResponse' + description: Update Comment Response "400": content: application/json: @@ -22917,51 +31512,36 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Send reaction + summary: Update a comment tags: - - product:chat - /api/v2/chat/messages/{id}/reaction/{type}: - delete: + - product:feeds + /api/v2/feeds/comments/{id}/reactions: + post: description: | - Removes user reaction from the message - - Sends events: - - reaction.deleted - operationId: DeleteReaction + Adds a reaction to a comment + operationId: AddCommentReaction parameters: - in: path name: id required: true schema: - description: Message ID to remove reaction from - title: ID + maxLength: 255 type: string writeOnly: true x-stream-index: "001" - - in: path - name: type + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AddCommentReactionRequest' required: true - schema: - description: Reaction type to remove - title: Type - type: string - writeOnly: true - x-stream-index: "002" - - in: query - name: user_id - schema: - description: '**Server-side only**. User ID which server acts upon' - title: User ID - type: string - writeOnly: true - x-stream-index: "003" responses: - "200": + "201": content: application/json: schema: - $ref: '#/components/schemas/DeleteReactionResponse' - description: Response + $ref: '#/components/schemas/AddCommentReactionResponse' + description: Successful response "400": content: application/json: @@ -22974,49 +31554,38 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Delete reaction + summary: Add comment reaction tags: - - product:chat - /api/v2/chat/messages/{id}/reactions: - get: + - product:feeds + /api/v2/feeds/comments/{id}/reactions/{type}: + delete: description: | - Returns list of reactions of specific message - operationId: GetReactions + Deletes a reaction from a comment + operationId: DeleteCommentReaction parameters: - in: path name: id required: true schema: - description: Message ID - title: ID + maxLength: 255 type: string writeOnly: true x-stream-index: "001" - - in: query - name: limit + - in: path + name: type + required: true schema: - description: Number of records to return - format: int32 - title: Limit - type: integer + maxLength: 255 + type: string writeOnly: true x-stream-index: "002" - - in: query - name: offset - schema: - description: Number of records to offset - format: int32 - title: Offset - type: integer - writeOnly: true - x-stream-index: "003" responses: "200": content: application/json: schema: - $ref: '#/components/schemas/GetReactionsResponse' - description: Successful response + $ref: '#/components/schemas/DeleteCommentReactionResponse' + description: Delete Comment Reaction Response "400": content: application/json: @@ -23029,13 +31598,14 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Get reactions + summary: Delete comment reaction tags: - - product:chat + - product:feeds + /api/v2/feeds/comments/{id}/reactions/query: post: description: | - Get reactions on a message - operationId: QueryReactions + Query comment reactions + operationId: QueryCommentReactions parameters: - in: path name: id @@ -23048,14 +31618,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/QueryReactionsRequest' + $ref: '#/components/schemas/QueryCommentReactionsRequest' required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/QueryReactionsResponse' + $ref: '#/components/schemas/QueryCommentReactionsResponse' description: Response "400": content: @@ -23069,40 +31639,87 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests + summary: Query comment reactions tags: - - product:chat - /api/v2/chat/messages/{id}/translate: - post: + - product:feeds + /api/v2/feeds/comments/{id}/replies: + get: description: | - Translates message to a given language using automated translation software - - Sends events: - - message.updated - - message.updated - operationId: TranslateMessage + Retrieve a threaded list of replies for a single comment, with configurable depth, sorting, and pagination + operationId: GetCommentReplies parameters: - in: path name: id required: true schema: - description: Message ID - title: ID type: string writeOnly: true - x-stream-index: "002.001" - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/TranslateMessageRequest' - required: true + x-stream-index: "001" + - in: query + name: depth + schema: + description: Maximum nested depth to return (0 = unlimited) + format: int32 + maximum: 5 + minimum: 0 + title: Max Depth + type: integer + writeOnly: true + x-stream-index: "002" + - in: query + name: sort + schema: + description: first (oldest), last (newest) or top + enum: + - first + - last + - top + - best + - controversial + title: Sort Order + type: string + writeOnly: true + x-stream-index: "003" + - in: query + name: replies_limit + schema: + description: Max number of replies to return + format: int32 + minimum: 0 + title: Replies Limit + type: integer + writeOnly: true + x-stream-index: "004" + - in: query + name: limit + schema: + description: Max number of direct replies to return + format: int32 + maximum: 100 + minimum: 0 + title: Reply Limit + type: integer + writeOnly: true + x-stream-index: "005.001" + - in: query + name: prev + schema: + type: string + writeOnly: true + x-stream-index: "005.002" + - in: query + name: next + schema: + type: string + writeOnly: true + x-stream-index: "005.003" responses: - "201": + "200": content: application/json: schema: - $ref: '#/components/schemas/MessageResponse' - description: Response + $ref: '#/components/schemas/GetCommentRepliesResponse' + description: Get Comment Replies Response "400": content: application/json: @@ -23115,52 +31732,62 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Translate message + summary: Get replies for a comment tags: - - product:chat - /api/v2/chat/messages/{message_id}/polls/{poll_id}/vote: + - product:feeds + /api/v2/feeds/comments/batch: post: description: | - Cast a vote on a poll - - Sends events: - - feeds.poll.vote_casted - - feeds.poll.vote_changed - - feeds.poll.vote_removed - - poll.vote_casted - - poll.vote_changed - - poll.vote_removed - operationId: CastPollVote - parameters: - - in: path - name: message_id - required: true - schema: - type: string - writeOnly: true - x-stream-index: "001" - - in: path - name: poll_id + Adds multiple comments in a single request. Each comment must specify the object type and ID. + operationId: AddCommentsBatch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AddCommentsBatchRequest' + description: Add Comments Batch Request required: true - schema: - description: Poll ID - maxLength: 255 - title: string - type: string - x-stream-index: "003" + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/AddCommentsBatchResponse' + description: Add Comments Batch 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: Add multiple comments in a batch + tags: + - product:feeds + /api/v2/feeds/comments/query: + post: + description: | + Query comments using MongoDB-style filters with pagination and sorting options + operationId: QueryComments requestBody: content: application/json: schema: - $ref: '#/components/schemas/CastPollVoteRequest' + $ref: '#/components/schemas/QueryCommentsRequest' + description: Query Comments Request required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/PollVoteResponse' - description: Successful response + $ref: '#/components/schemas/QueryCommentsResponse' + description: Query Comments Response "400": content: application/json: @@ -23173,57 +31800,46 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Cast vote + summary: Query comments tags: - - product:chat - /api/v2/chat/messages/{message_id}/polls/{poll_id}/vote/{vote_id}: + - product:feeds + /api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}: delete: description: | - Delete a vote from a poll - - Sends events: - - feeds.poll.vote_removed - - poll.vote_removed - operationId: DeletePollVote + Delete a single feed by its ID + operationId: DeleteFeed parameters: - in: path - name: message_id - required: true - schema: - type: string - writeOnly: true - x-stream-index: "002" - - in: path - name: poll_id + name: feed_group_id required: true schema: - description: Poll ID maxLength: 255 - title: string type: string - x-stream-index: "004" + writeOnly: true + x-stream-index: "001" - in: path - name: vote_id + name: feed_id required: true schema: - description: Vote ID maxLength: 255 - title: string type: string - x-stream-index: "005" + writeOnly: true + x-stream-index: "002" - in: query - name: user_id + name: hard_delete schema: - type: string + description: Whether to permanently delete the feed instead of soft delete + title: boolean + type: boolean writeOnly: true - x-stream-index: "001" + x-stream-index: "003" responses: "200": content: application/json: schema: - $ref: '#/components/schemas/PollVoteResponse' - description: Successful response + $ref: '#/components/schemas/DeleteFeedResponse' + description: Delete Feed Response "400": content: application/json: @@ -23236,31 +31852,51 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Delete vote + summary: Delete a single feed tags: - - product:chat - /api/v2/chat/messages/{message_id}/reminders: - delete: + - product:feeds + post: description: | - Deletes a user's created reminder - - Sends events: - - reminder.deleted - operationId: DeleteReminder + Create a single feed for a given feed group + operationId: GetOrCreateFeed parameters: - in: path - name: message_id + name: feed_group_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + - in: path + name: feed_id required: true schema: + maxLength: 255 type: string writeOnly: true x-stream-index: "002" + - in: query + name: connection_id + schema: + description: Websocket connection ID to interact with. You can pass it as + Body or URL parameter + title: Connection ID + type: string + x-stream-index: "015.003" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GetOrCreateFeedRequest' + description: ClientRequest + required: true responses: - "200": + "201": content: application/json: schema: - $ref: '#/components/schemas/DeleteReminderResponse' + $ref: '#/components/schemas/GetOrCreateFeedResponse' description: Response "400": content: @@ -23274,21 +31910,27 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Delete reminder + summary: Create a new feed tags: - - product:chat - patch: + - product:feeds + put: description: | - Updates an existing reminder - - Sends events: - - reminder.updated - operationId: UpdateReminder + Update an existing feed + operationId: UpdateFeed parameters: - in: path - name: message_id + name: feed_group_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + - in: path + name: feed_id required: true schema: + maxLength: 255 type: string writeOnly: true x-stream-index: "002" @@ -23296,15 +31938,16 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/UpdateReminderRequest' + $ref: '#/components/schemas/UpdateFeedRequest' + description: Update Feed Request required: true responses: - "200": + "201": content: application/json: schema: - $ref: '#/components/schemas/UpdateReminderResponse' - description: Response + $ref: '#/components/schemas/UpdateFeedResponse' + description: Update Feed Response "400": content: application/json: @@ -23317,37 +31960,45 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Updates Reminder + summary: Update a feed tags: - - product:chat - post: + - product:feeds + /api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/activities/{activity_id}/pin: + delete: description: | - Creates a new reminder - - Sends events: - - reminder.created - operationId: CreateReminder + Unpin an activity from a feed. This removes the pin, so the activity will no longer be displayed at the top of the feed. + operationId: UnpinActivity parameters: - in: path - name: message_id + name: feed_group_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + - in: path + name: feed_id required: true schema: + maxLength: 255 type: string writeOnly: true x-stream-index: "002" - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CreateReminderRequest' + - in: path + name: activity_id required: true + schema: + type: string + writeOnly: true + x-stream-index: "003" responses: - "201": + "200": content: application/json: schema: - $ref: '#/components/schemas/ReminderResponseData' - description: Successful response + $ref: '#/components/schemas/UnpinActivityResponse' + description: Unpin Activity Response "400": content: application/json: @@ -23360,141 +32011,101 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Create reminder + summary: Unpin an activity from a feed tags: - - product:chat - /api/v2/chat/messages/{parent_id}/replies: - get: + - product:feeds + post: description: | - Returns replies (thread) of the message - operationId: GetReplies + Pin an activity to a feed. Pinned activities are typically displayed at the top of a feed. + operationId: PinActivity parameters: - in: path - name: parent_id + name: feed_group_id required: true schema: + maxLength: 255 type: string writeOnly: true x-stream-index: "001" - - in: query - name: sort + - in: path + name: feed_id + required: true schema: - items: - $ref: '#/components/schemas/SortParamRequest' - maximum: 1 - type: array + maxLength: 255 + type: string writeOnly: true x-stream-index: "002" - - in: query - name: limit - schema: - description: 'The maximum number of messages to return (max limit ' - format: int32 - minimum: 0 - title: Limit - type: integer - x-stream-index: "003.001" - - in: query - name: offset - schema: - description: The offset to start from - format: int32 - title: Offset - type: integer - x-stream-index: "003.002" - - in: query - name: id_gte - schema: - description: The ID of the message to get messages with a timestamp greater - than or equal to - title: IDGTE - type: string - x-stream-index: "003.003" - - in: query - name: id_gt - schema: - description: The ID of the message to get messages with a timestamp greater - than - title: IDGT - type: string - x-stream-index: "003.004" - - in: query - name: id_lte - schema: - description: The ID of the message to get messages with a timestamp smaller - than or equal to - title: IDLTE - type: string - x-stream-index: "003.005" - - in: query - name: id_lt + - in: path + name: activity_id + required: true schema: - description: The ID of the message to get messages with a timestamp smaller - than - title: IDLT type: string - x-stream-index: "003.006" - - in: query - name: created_at_after_or_equal - schema: - description: The timestamp to get messages with a created_at timestamp greater - than or equal to - format: date-time - title: Created_at after or equal - type: number - x-stream-index: "003.007" - - in: query - name: created_at_after - schema: - description: The timestamp to get messages with a created_at timestamp greater - than - format: date-time - title: Created_at after - type: number - x-stream-index: "003.008" - - in: query - name: created_at_before_or_equal - schema: - description: The timestamp to get messages with a created_at timestamp smaller - than or equal to - format: date-time - title: Created_at after before or equal - type: number - x-stream-index: "003.009" - - in: query - name: created_at_before - schema: - description: The timestamp to get messages with a created_at timestamp smaller - than - format: date-time - title: Created_at after before - type: number - x-stream-index: "003.010" - - in: query - name: id_around + writeOnly: true + x-stream-index: "003" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PinActivityRequest' + description: Pin Activity Request + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/PinActivityResponse' + description: Pin Activity 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: Pin an activity to a feed + tags: + - product:feeds + /api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/activities/mark/batch: + post: + description: | + Mark activities as read/seen/watched. Can mark by timestamp (seen), activity IDs (read), or all as read. + operationId: MarkActivity + parameters: + - in: path + name: feed_group_id + required: true schema: - description: The result will be a set of messages, that are both older and - newer than the message with the provided ID, and the message with the - ID provided will be in the middle of the set - title: Id around + maxLength: 255 type: string - x-stream-index: "003.011" - - in: query - name: created_at_around + writeOnly: true + x-stream-index: "001" + - in: path + name: feed_id + required: true schema: - description: The result will be a set of messages, that are both older and - newer than the created_at timestamp provided, distributed evenly around - the timestamp - format: date-time - title: Created_at around - type: number - x-stream-index: "003.012" + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "002" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MarkActivityRequest' + description: Mark Activity Request + required: true responses: - "200": + "201": content: application/json: schema: - $ref: '#/components/schemas/GetRepliesResponse' + $ref: '#/components/schemas/Response' description: Response "400": content: @@ -23508,31 +32119,45 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Get replies + summary: Mark activities as read/seen/watched tags: - - product:chat - /api/v2/chat/moderation/flags/message: - get: + - product:feeds + /api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/members: + patch: description: | - Find and filter message flags - operationId: QueryMessageFlags + Add, remove, or set members for a feed + operationId: UpdateFeedMembers parameters: - - content: + - in: path + name: feed_group_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + - in: path + name: feed_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "002" + requestBody: + content: application/json: schema: - $ref: '#/components/schemas/QueryMessageFlagsPayload' - description: JSON object with query message flags payload - title: Payload - x-stream-index: "001" - in: query - name: payload + $ref: '#/components/schemas/UpdateFeedMembersRequest' + description: Update Feed Members Request + required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/QueryMessageFlagsResponse' - description: QueryMessageFlagsResponse + $ref: '#/components/schemas/UpdateFeedMembersResponse' + description: Response "400": content: application/json: @@ -23545,31 +32170,45 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Query Message Flags + summary: Update feed members tags: - - product:chat - /api/v2/chat/moderation/mute/channel: + - product:feeds + /api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/members/accept: post: description: | - Mutes channel for user - - Sends events: - - channel.muted - - channel.muted - operationId: MuteChannel + Accepts a pending feed member request + operationId: AcceptFeedMemberInvite + parameters: + - in: path + name: feed_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + - in: path + name: feed_group_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "002" requestBody: content: application/json: schema: - $ref: '#/components/schemas/MuteChannelRequest' + $ref: '#/components/schemas/AcceptFeedMemberInviteRequest' + description: Accept Feed Member Invite Request required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/MuteChannelResponse' - description: Successful response + $ref: '#/components/schemas/AcceptFeedMemberInviteResponse' + description: Accept Feed Member Invite Response "400": content: application/json: @@ -23582,31 +32221,44 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Mute channel + summary: Accept a feed member request tags: - - product:chat - /api/v2/chat/moderation/unmute/channel: + - product:feeds + /api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/members/query: post: description: | - Unmutes channel for user - - Sends events: - - channel.unmuted - - channel.unmuted - operationId: UnmuteChannel + Query feed members based on filters with pagination and sorting options + operationId: QueryFeedMembers + parameters: + - in: path + name: feed_group_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + - in: path + name: feed_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "002" requestBody: content: application/json: schema: - $ref: '#/components/schemas/UnmuteChannelRequest' + $ref: '#/components/schemas/QueryFeedMembersRequest' required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/UnmuteResponse' - description: Response + $ref: '#/components/schemas/QueryFeedMembersResponse' + description: Successful response "400": content: application/json: @@ -23619,27 +32271,45 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Unmute channel + summary: Query feed members tags: - - product:chat - /api/v2/chat/push_preferences: + - product:feeds + /api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/members/reject: post: description: | - Update the push preferences for a user and or channel member. Set to all, mentions or none - operationId: UpdatePushNotificationPreferences + Rejects a pending feed member request + operationId: RejectFeedMemberInvite + parameters: + - in: path + name: feed_group_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + - in: path + name: feed_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "002" requestBody: content: application/json: schema: - $ref: '#/components/schemas/UpsertPushPreferencesRequest' + $ref: '#/components/schemas/RejectFeedMemberInviteRequest' + description: Reject Feed Member Request required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/UpsertPushPreferencesResponse' - description: Successful response + $ref: '#/components/schemas/RejectFeedMemberInviteResponse' + description: Reject Feed Member Response "400": content: application/json: @@ -23652,31 +32322,43 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Push notification preferences + summary: Reject an invite to become a feed member tags: - - product:chat - /api/v2/chat/query_banned_users: - get: + - product:feeds + /api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/watch: + delete: description: | - Find and filter channel scoped or global user bans - operationId: QueryBannedUsers + Call this Method to stop receiving feed events + operationId: StopWatchingFeed parameters: - - content: - application/json: - schema: - $ref: '#/components/schemas/QueryBannedUsersPayload' - description: JSON object with query user bans payload - title: Payload - x-stream-index: "001" - in: query - name: payload + - in: path + name: feed_group_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "002" + - in: path + name: feed_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "003" + - in: query + name: connection_id + schema: + type: string + x-stream-index: "001.003" responses: "200": content: application/json: schema: - $ref: '#/components/schemas/QueryBannedUsersResponse' - description: Successful response + $ref: '#/components/schemas/Response' + description: Response "400": content: application/json: @@ -23689,27 +32371,43 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Query Banned Users + summary: Stop watching feed tags: - - product:chat - /api/v2/chat/reminders/query: - post: + - product:feeds + /api/v2/feeds/feed_groups/{feed_group_id}/follow_suggestions: + get: description: | - Queries reminders - operationId: QueryReminders - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/QueryRemindersRequest' + Get follow suggestions for a feed group + operationId: GetFollowSuggestions + parameters: + - in: path + name: feed_group_id required: true + schema: + description: The ID of the feed group to get suggestions for + maxLength: 255 + title: Feed Group ID + type: string + writeOnly: true + x-stream-index: "001" + - in: query + name: limit + schema: + description: Maximum number of suggestions to return + format: int32 + maximum: 100 + minimum: 1 + title: Limit + type: integer + writeOnly: true + x-stream-index: "002" responses: - "201": + "200": content: application/json: schema: - $ref: '#/components/schemas/QueryRemindersResponse' - description: Successful response + $ref: '#/components/schemas/GetFollowSuggestionsResponse' + description: Follow Suggestions Response "400": content: application/json: @@ -23722,31 +32420,28 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Query reminders + summary: Get follow suggestions tags: - - product:chat - /api/v2/chat/search: - get: + - product:feeds + /api/v2/feeds/feeds/batch: + post: description: | - Search messages across channels - operationId: Search - parameters: - - content: + Create multiple feeds at once for a given feed group + operationId: CreateFeedsBatch + requestBody: + content: application/json: schema: - $ref: '#/components/schemas/SearchPayload' - description: JSON object with search payload - title: Payload - x-stream-index: "001" - in: query - name: payload + $ref: '#/components/schemas/CreateFeedsBatchRequest' + description: Create Feeds Batch Request + required: true responses: - "200": + "201": content: application/json: schema: - $ref: '#/components/schemas/SearchResponse' - description: Successful response + $ref: '#/components/schemas/CreateFeedsBatchResponse' + description: Create Feeds Batch Response "400": content: application/json: @@ -23759,51 +32454,34 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Search messages + summary: Create multiple feeds at once tags: - - product:chat - /api/v2/chat/sync: + - product:feeds + /api/v2/feeds/feeds/query: post: description: | - Returns all events happened since client disconnect in specified channels - operationId: Sync + Query feeds with filter query + operationId: QueryFeeds parameters: - - in: query - name: with_inaccessible_cids - schema: - description: If set to true this will add 'inaccessible_cids' to response - type - title: With inaccessible CIDs - type: boolean - x-stream-index: "003" - - in: query - name: watch - schema: - description: If set to true this will start watching requested and newly - added channels that user has access to. If error occurred with this option - enabled and it is not an input error - channels will still be watched. - title: Watch synced channels - type: boolean - x-stream-index: "004" - in: query name: connection_id schema: type: string - x-stream-index: "006.003" + x-stream-index: "005.003" requestBody: content: application/json: schema: - $ref: '#/components/schemas/SyncRequest' - description: SyncRequest + $ref: '#/components/schemas/QueryFeedsRequest' + description: Query Feeds Request required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/SyncResponse' - description: SyncResponse + $ref: '#/components/schemas/QueryFeedsResponse' + description: Query Feeds Response "400": content: application/json: @@ -23816,33 +32494,28 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Sync + summary: Query feeds tags: - - product:chat - /api/v2/chat/threads: - post: + - product:feeds + /api/v2/feeds/follows: + patch: description: | - Returns the list of threads for specific user - operationId: QueryThreads - parameters: - - in: query - name: connection_id - schema: - type: string - x-stream-index: "002" + Updates a follow's custom data, push preference, and follower role. Source owner can update custom data and push preference. Target owner can update follower role. + operationId: UpdateFollow requestBody: content: application/json: schema: - $ref: '#/components/schemas/QueryThreadsRequest' + $ref: '#/components/schemas/UpdateFollowRequest' + description: Update Follow Request required: true responses: - "201": + "200": content: application/json: schema: - $ref: '#/components/schemas/QueryThreadsResponse' - description: Successful response + $ref: '#/components/schemas/UpdateFollowResponse' + description: Update Follow Response "400": content: application/json: @@ -23855,75 +32528,27 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Query Threads + summary: Update a follow tags: - - product:chat - /api/v2/chat/threads/{message_id}: - get: + - product:feeds + post: description: | - Return a specific thread - operationId: GetThread - parameters: - - in: path - name: message_id + Creates a follow and broadcasts FollowAddedEvent + operationId: Follow + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/FollowRequest' + description: Follow Request required: true - schema: - type: string - writeOnly: true - x-stream-index: "001" - - in: query - name: watch - schema: - description: Start watching the channel this thread belongs to - title: Watch - type: boolean - writeOnly: true - x-stream-index: "002" - - in: query - name: connection_id - schema: - type: string - writeOnly: true - x-stream-index: "003" - - in: query - name: reply_limit - schema: - description: Limit the number of replies returned - format: int32 - minimum: 0 - title: Reply limit - type: integer - writeOnly: true - x-stream-index: "004" - - in: query - name: participant_limit - schema: - description: Limit the number of participants returned - format: int32 - maximum: 100 - minimum: 0 - title: Participant limit - type: integer - writeOnly: true - x-stream-index: "005" - - in: query - name: member_limit - schema: - description: Limit the number of members returned per thread channel - format: int32 - maximum: 100 - minimum: 0 - title: Member limit - type: integer - writeOnly: true - x-stream-index: "006" responses: - "200": + "201": content: application/json: schema: - $ref: '#/components/schemas/GetThreadResponse' - description: Successful response + $ref: '#/components/schemas/SingleFollowResponse' + description: Follow Response "400": content: application/json: @@ -23936,38 +32561,42 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Get Thread + summary: Create a follow tags: - - product:chat - patch: + - product:feeds + /api/v2/feeds/follows/{source}/{target}: + delete: description: | - Updates certain fields of the thread - - Sends events: - - thread.updated - - thread.updated - operationId: UpdateThreadPartial + Removes a follow and broadcasts FollowRemovedEvent + operationId: Unfollow parameters: - in: path - name: message_id + name: source required: true schema: + description: Fully qualified ID of the source feed + maxLength: 255 + title: Source Feed type: string writeOnly: true x-stream-index: "001" - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/UpdateThreadPartialRequest' + - in: path + name: target required: true + schema: + description: Fully qualified ID of the target feed + maxLength: 255 + title: Target Feed + type: string + writeOnly: true + x-stream-index: "002" responses: "200": content: application/json: schema: - $ref: '#/components/schemas/UpdateThreadPartialResponse' - description: Successful response + $ref: '#/components/schemas/UnfollowResponse' + description: Unfollow Response "400": content: application/json: @@ -23980,21 +32609,28 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Partially update thread + summary: Unfollow a feed tags: - - product:chat - /api/v2/chat/unread: - get: + - product:feeds + /api/v2/feeds/follows/accept: + post: description: | - Fetch unread counts for a single user - operationId: UnreadCounts + Accepts a pending follow request + operationId: AcceptFollow + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AcceptFollowRequest' + description: Accept Follow Request + required: true responses: - "200": + "201": content: application/json: schema: - $ref: '#/components/schemas/WrappedUnreadCountsResponse' - description: Response + $ref: '#/components/schemas/AcceptFollowResponse' + description: Accept Follow Response "400": content: application/json: @@ -24007,31 +32643,28 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Unread counts + summary: Accept a follow request tags: - - product:chat - /api/v2/devices: - delete: + - product:feeds + /api/v2/feeds/follows/batch: + post: description: | - Deletes one device - operationId: DeleteDevice - parameters: - - in: query - name: id + Creates multiple follows at once and broadcasts FollowAddedEvent for each follow + operationId: FollowBatch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/FollowBatchRequest' + description: Follow Batch Request required: true - schema: - description: Device ID to delete - title: ID - type: string - writeOnly: true - x-stream-index: "001" responses: - "200": + "201": content: application/json: schema: - $ref: '#/components/schemas/Response' - description: Response + $ref: '#/components/schemas/FollowBatchResponse' + description: Follow Batch Response "400": content: application/json: @@ -24044,20 +32677,28 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Delete device + summary: Create multiple follows at once tags: - - product:common - get: + - product:feeds + /api/v2/feeds/follows/query: + post: description: | - Returns all available devices - operationId: ListDevices + Query follows based on filters with pagination and sorting options + operationId: QueryFollows + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueryFollowsRequest' + description: Query Follows Request + required: true responses: - "200": + "201": content: application/json: schema: - $ref: '#/components/schemas/ListDevicesResponse' - description: ListDevicesResponse + $ref: '#/components/schemas/QueryFollowsResponse' + description: Query Follows Response "400": content: application/json: @@ -24070,27 +32711,28 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: List devices + summary: Query follows tags: - - product:common + - product:feeds + /api/v2/feeds/follows/reject: post: description: | - Adds a new device to a user, if the same device already exists the call will have no effect - operationId: CreateDevice + Rejects a pending follow request + operationId: RejectFollow requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateDeviceRequest' - description: CreateDeviceRequest + $ref: '#/components/schemas/RejectFollowRequest' + description: Reject Follow Request required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/Response' - description: Response + $ref: '#/components/schemas/RejectFollowResponse' + description: Reject Follow Response "400": content: application/json: @@ -24103,9 +32745,9 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Create device + summary: Reject a follow request tags: - - product:common + - product:feeds /api/v2/guest: post: description: |2+ @@ -26155,6 +34797,65 @@ paths: summary: Join call tags: - product:video + /api/v2/video/call/{type}/{id}/kick: + post: + description: | + Kicks a user from the call. Optionally block the user from rejoining by setting block=true. + + Sends events: + - call.blocked_user + - call.kicked_user + operationId: KickUser + parameters: + - in: path + name: type + required: true + schema: + description: The type of call + maxLength: 64 + title: Type + type: string + writeOnly: true + x-stream-index: "002.001" + - in: path + name: id + required: true + schema: + description: Call ID + maxLength: 64 + title: ID + type: string + writeOnly: true + x-stream-index: "002.002" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/KickUserRequest' + description: KickUserRequest + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/KickUserResponse' + description: KickUserResponse + "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: Kick user from a call + tags: + - product:video /api/v2/video/call/{type}/{id}/mark_ended: post: description: |2 diff --git a/openapi/v2/feeds-clientside-api.json b/openapi/v2/feeds-clientside-api.json new file mode 100644 index 000000000..18b7441e7 --- /dev/null +++ b/openapi/v2/feeds-clientside-api.json @@ -0,0 +1 @@ +{"components":{"schemas":{"AIImageConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"ocr_rules":{"items":{"$ref":"#/components/schemas/OCRRule"},"type":"array","x-stream-index":"004"},"rules":{"items":{"$ref":"#/components/schemas/AWSRekognitionRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules","ocr_rules"],"type":"object"},"AITextConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"profile":{"type":"string","x-stream-index":"003"},"rules":{"items":{"$ref":"#/components/schemas/BodyguardRule"},"type":"array","x-stream-index":"004"},"severity_rules":{"items":{"$ref":"#/components/schemas/BodyguardSeverityRule"},"type":"array","x-stream-index":"005"}},"required":["enabled","profile","rules","severity_rules"],"type":"object"},"AIVideoConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AWSRekognitionRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"APIError":{"nullable":true,"properties":{"StatusCode":{"description":"Response HTTP status code","format":"int32","title":"Status code","type":"integer","x-stream-index":"004"},"code":{"description":"API error code","format":"int32","title":"Code","type":"integer","x-stream-index":"001"},"details":{"description":"Additional error-specific information","items":{"type":"integer"},"title":"Details","type":"array","x-stream-index":"007"},"duration":{"description":"Request duration","title":"Duration","type":"string","x-stream-index":"005"},"exception_fields":{"additionalProperties":{"type":"string"},"description":"Additional error info","title":"Exception fields","type":"object","x-stream-index":"003"},"message":{"description":"Message describing an error","title":"Message","type":"string","x-stream-index":"002"},"more_info":{"description":"URL with additional information","title":"More info","type":"string","x-stream-index":"006"},"unrecoverable":{"description":"Flag that indicates if the error is unrecoverable, requests that return unrecoverable errors should not be retried, this error only applies to the request that caused it","title":"Unrecoverable","type":"boolean","x-stream-index":"008"}},"required":["code","message","StatusCode","duration","more_info","details"],"title":"Error response","type":"object"},"APNS":{"properties":{"body":{"type":"string","x-stream-index":"002"},"content-available":{"format":"int32","type":"integer","x-stream-index":"004"},"data":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"mutable-content":{"format":"int32","type":"integer","x-stream-index":"005"},"sound":{"type":"string","x-stream-index":"003"},"title":{"type":"string","x-stream-index":"001"}},"required":["title","body"],"type":"object"},"AWSRekognitionRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"},"min_confidence":{"format":"float","maximum":100,"minimum":0,"type":"number","x-stream-index":"003"}},"required":["label","action","min_confidence"],"type":"object"},"AcceptFeedMemberInviteRequest":{"nullable":true,"title":"Accept Feed Member Invite Request","type":"object"},"AcceptFeedMemberInviteResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"member":{"$ref":"#/components/schemas/FeedMemberResponse","description":"The feed member after accepting the invite","title":"Feed Member","x-stream-index":"001"}},"required":["member","duration"],"title":"Accept Feed Member Invite Response","type":"object"},"AcceptFollowRequest":{"nullable":true,"properties":{"follower_role":{"description":"Optional role for the follower in the follow relationship","title":"Follower Role","type":"string","x-stream-index":"003"},"source":{"description":"Fully qualified ID of the source feed","maxLength":255,"title":"Source Feed ID","type":"string","x-stream-index":"001"},"target":{"description":"Fully qualified ID of the target feed","maxLength":255,"title":"Target Feed ID","type":"string","x-stream-index":"002"}},"required":["source","target"],"title":"Accept Follow Request","type":"object"},"AcceptFollowResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"follow":{"$ref":"#/components/schemas/FollowResponse","description":"The accepted follow relationship","title":"Follow","x-stream-index":"001"}},"required":["follow","duration"],"title":"Accept Follow Response","type":"object"},"Action":{"nullable":true,"properties":{"name":{"type":"string","x-stream-index":"001"},"style":{"type":"string","x-stream-index":"003"},"text":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"004"},"value":{"type":"string","x-stream-index":"005"}},"required":["name","text","type"],"type":"object"},"ActionLog":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"002"},"reason":{"type":"string","x-stream-index":"008"},"reporter_type":{"type":"string","x-stream-index":"009"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"014"},"review_queue_item_id":{"type":"string","x-stream-index":"012"},"target_user":{"$ref":"#/components/schemas/User","x-stream-index":"013"},"target_user_id":{"type":"string","x-stream-index":"011"},"type":{"type":"string","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007"}},"required":["id","created_at","type","reason","reporter_type","custom","target_user_id","review_queue_item_id"],"type":"object"},"ActionLogResponse":{"nullable":true,"properties":{"created_at":{"description":"Timestamp when the action was taken","format":"date-time","title":"Created At","type":"number","x-stream-index":"002"},"custom":{"additionalProperties":{},"description":"Additional metadata about the action","title":"Custom","type":"object","x-stream-index":"007"},"id":{"description":"Unique identifier of the action log","title":"ID","type":"string","x-stream-index":"001"},"reason":{"description":"Reason for the moderation action","title":"Reason","type":"string","x-stream-index":"006"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"Associated review queue item","title":"Review Queue Item","x-stream-index":"008"},"target_user":{"$ref":"#/components/schemas/UserResponse","description":"User who was the target of the action","title":"Target User","x-stream-index":"009"},"target_user_id":{"description":"ID of the user who was the target of the action","title":"Target User ID","type":"string","x-stream-index":"010"},"type":{"description":"Type of moderation action","title":"Type","type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who performed the action","title":"User","x-stream-index":"004"},"user_id":{"description":"ID of the user who performed the action","title":"User ID","type":"string","x-stream-index":"005"}},"required":["id","created_at","type","user_id","reason","custom","target_user_id"],"type":"object"},"ActionSequence":{"properties":{"action":{"type":"string","x-stream-index":"001"},"blur":{"type":"boolean","x-stream-index":"005"},"cooldown_period":{"format":"int32","type":"integer","x-stream-index":"004"},"threshold":{"format":"int32","type":"integer","x-stream-index":"002"},"time_window":{"format":"int32","type":"integer","x-stream-index":"003"},"warning":{"type":"boolean","x-stream-index":"006"},"warning_text":{"type":"string","x-stream-index":"007"}},"required":["action","threshold","time_window","cooldown_period","blur","warning","warning_text"],"type":"object"},"ActivityAddedEvent":{"description":"Emitted when an activity is added to a feed.","nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","description":"The activity that was added","title":"Activity","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"type":"string","x-stream-index":"002.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.activity.added","description":"The type of event: \"feeds.activity.added\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who added the activity","title":"User","x-stream-index":"003.001"}},"required":["activity","type","created_at","custom","fid"],"title":"ActivityAddedEvent","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"},"ActivityDeletedEvent":{"description":"Emitted when an activity is deleted.","nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","description":"The activity that was updated","title":"Activity","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"type":"string","x-stream-index":"002.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.activity.deleted","description":"The type of event: \"feeds.activity.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","x-stream-index":"003.001"}},"required":["activity","type","created_at","custom","fid"],"title":"ActivityDeletedEvent","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"},"ActivityFeedbackRequest":{"description":"Request to provide feedback on an activity","nullable":true,"properties":{"hide":{"description":"Whether to hide this activity","title":"bool","type":"boolean","x-stream-index":"003"},"mute_user":{"description":"Whether to mute the user who created this activity","title":"bool","type":"boolean","x-stream-index":"005"},"reason":{"description":"Reason for the feedback (optional)","maxLength":1000,"title":"string","type":"string","x-stream-index":"006"},"report":{"description":"Whether to report this activity","title":"bool","type":"boolean","x-stream-index":"004"},"show_less":{"description":"Whether to show less content like this","title":"bool","type":"boolean","x-stream-index":"002"}},"title":"Activity Feedback Request","type":"object"},"ActivityFeedbackResponse":{"description":"Response for activity feedback submission","nullable":true,"properties":{"activity_id":{"description":"The ID of the activity that received feedback","title":"string","type":"string","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["activity_id","duration"],"title":"Activity Feedback Response","type":"object"},"ActivityLocation":{"properties":{"lat":{"description":"Latitude coordinate","format":"float","title":"Latitude","type":"number","x-stream-index":"001"},"lng":{"description":"Longitude coordinate","format":"float","title":"Longitude","type":"number","x-stream-index":"002"}},"required":["lat","lng"],"title":"Activity Location","type":"object"},"ActivityMarkEvent":{"description":"Emitted when activities are marked as read, seen, or watched.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"006.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006.001.007"},"feed_visibility":{"type":"string","x-stream-index":"006.003"},"fid":{"type":"string","x-stream-index":"006.002"},"mark_all_read":{"description":"Whether all activities were marked as read","title":"Mark All Read","type":"boolean","x-stream-index":"004"},"mark_all_seen":{"description":"Whether all activities were marked as seen","title":"Mark All Seen","type":"boolean","x-stream-index":"005"},"mark_read":{"description":"The IDs of activities marked as read","items":{"type":"string"},"title":"Mark Read","type":"array","x-stream-index":"001"},"mark_seen":{"description":"The IDs of activities marked as seen","items":{"type":"string"},"title":"Mark Seen","type":"array","x-stream-index":"002"},"mark_watched":{"description":"The IDs of activities marked as watched","items":{"type":"string"},"title":"Mark Watched","type":"array","x-stream-index":"003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"006.001.004"},"type":{"default":"feeds.activity.marked","description":"The type of event: \"feeds.activity.marked\" in this case","title":"Event Type","type":"string","x-stream-index":"006.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who marked the activities","title":"User","x-stream-index":"007.001"}},"required":["type","created_at","custom","fid"],"title":"ActivityMarkEvent","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"},"ActivityPinResponse":{"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","description":"The pinned activity","title":"Activity","x-stream-index":"002"},"created_at":{"description":"When the pin was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"004"},"feed":{"description":"ID of the feed where activity is pinned","title":"Feed ID","type":"string","x-stream-index":"003"},"updated_at":{"description":"When the pin was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who pinned the activity","title":"User","x-stream-index":"001"}},"required":["user","activity","feed","created_at","updated_at"],"title":"Activity Pin","type":"object"},"ActivityPinnedEvent":{"description":"Emitted when an activity is pinned.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"description":"The ID of the feed","title":"Feed ID","type":"string","x-stream-index":"002.002"},"pinned_activity":{"$ref":"#/components/schemas/PinActivityResponse","x-stream-index":"001"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.activity.pinned","description":"The type of event: \"feeds.activity.pinned\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who pinned the activity","title":"User","x-stream-index":"003.001"}},"required":["pinned_activity","type","created_at","custom","fid"],"title":"ActivityPinnedEvent","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"},"ActivityProcessorConfig":{"nullable":true,"properties":{"config":{"additionalProperties":{},"type":"object","x-stream-index":"002"},"openai_key":{"type":"string","x-stream-index":"003"},"type":{"type":"string","x-stream-index":"001"}},"required":["type"],"type":"object"},"ActivityReactionAddedEvent":{"description":"Emitted when a reaction is added to an activity.","nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"003.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.001.007"},"feed_visibility":{"type":"string","x-stream-index":"003.003"},"fid":{"type":"string","x-stream-index":"003.002"},"reaction":{"$ref":"#/components/schemas/FeedsReactionResponse","description":"The reaction that was added","title":"Reaction","x-stream-index":"002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.001.004"},"type":{"default":"feeds.activity.reaction.added","description":"The type of event: \"feeds.activity.reaction.added\" in this case","title":"Event Type","type":"string","x-stream-index":"003.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who added the reaction","title":"User","x-stream-index":"004.001"}},"required":["activity","reaction","type","created_at","custom","fid"],"title":"ActivityReactionAddedEvent","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"},"ActivityReactionDeletedEvent":{"description":"Emitted when a reaction is deleted from an activity.","nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"003.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.001.007"},"feed_visibility":{"type":"string","x-stream-index":"003.003"},"fid":{"type":"string","x-stream-index":"003.002"},"reaction":{"$ref":"#/components/schemas/FeedsReactionResponse","x-stream-index":"002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.001.004"},"type":{"default":"feeds.activity.reaction.deleted","description":"The type of the reaction that was removed","title":"Type","type":"string","x-stream-index":"003.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who removed the reaction","title":"User","x-stream-index":"004.001"}},"required":["activity","reaction","type","created_at","custom","fid"],"title":"ActivityReactionDeletedEvent","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"},"ActivityReactionUpdatedEvent":{"description":"Emitted when a reaction is updated on an activity.","nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"003.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.001.007"},"feed_visibility":{"type":"string","x-stream-index":"003.003"},"fid":{"type":"string","x-stream-index":"003.002"},"reaction":{"$ref":"#/components/schemas/FeedsReactionResponse","description":"The reaction that was updated","title":"Reaction","x-stream-index":"002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.001.004"},"type":{"default":"feeds.activity.reaction.updated","description":"The type of event: \"feeds.activity.reaction.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"003.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who updated the reaction","title":"User","x-stream-index":"004.001"}},"required":["activity","reaction","type","created_at","custom","fid"],"title":"ActivityReactionUpdatedEvent","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"},"ActivityRemovedFromFeedEvent":{"description":"Emitted when an activity is removed from a feed.","nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"type":"string","x-stream-index":"002.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.activity.removed_from_feed","description":"The type of event: \"feeds.activity.removed_from_feed\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who removed the activity","title":"User","x-stream-index":"003.001"}},"required":["activity","type","created_at","custom","fid"],"title":"ActivityRemovedFromFeedEvent","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"},"ActivityRequest":{"properties":{"attachments":{"description":"List of attachments for the activity","items":{"$ref":"#/components/schemas/Attachment"},"title":"Attachments","type":"array","x-stream-index":"006"},"custom":{"additionalProperties":{},"description":"Custom data for the activity","title":"Custom Data","type":"object","x-stream-index":"017"},"expires_at":{"description":"Expiration time for the activity","title":"Expires At","type":"string","x-stream-index":"010"},"feeds":{"description":"List of feed IDs to add the activity to","items":{"type":"string"},"maximum":255,"minimum":1,"title":"Feed IDs","type":"array","x-stream-index":"004"},"filter_tags":{"description":"Tags for filtering activities","items":{"type":"string"},"maximum":255,"title":"Filter Tags","type":"array","x-stream-index":"013"},"id":{"description":"Optional ID for the activity","maxLength":255,"title":"Activity ID","type":"string","x-stream-index":"001"},"interest_tags":{"description":"Tags for indicating user interests","items":{"type":"string"},"maximum":255,"title":"Interest Tags","type":"array","x-stream-index":"014"},"location":{"$ref":"#/components/schemas/ActivityLocation","description":"Geographic location related to the activity","title":"Location","x-stream-index":"009"},"mentioned_user_ids":{"description":"List of users mentioned in the activity","items":{"type":"string"},"maximum":255,"title":"Mentioned User IDs","type":"array","x-stream-index":"011"},"parent_id":{"description":"ID of parent activity for replies/comments","maxLength":255,"title":"Parent ID","type":"string","x-stream-index":"015"},"poll_id":{"description":"ID of a poll to attach to activity","title":"Poll ID","type":"string","x-stream-index":"016"},"search_data":{"additionalProperties":{},"description":"Additional data for search indexing","title":"Search Data","type":"object","x-stream-index":"012"},"text":{"description":"Text content of the activity","title":"Text","type":"string","x-stream-index":"005"},"type":{"description":"Type of activity","maxLength":255,"title":"Activity Type","type":"string","x-stream-index":"002"},"visibility":{"description":"Visibility setting for the activity","enum":["public","private","tag"],"title":"Visibility","type":"string","x-stream-index":"007"},"visibility_tag":{"description":"If visibility is 'tag', this is the tag name and is required","maxLength":32,"title":"Visibility Tag","type":"string","x-stream-index":"008"}},"required":["type","feeds"],"title":"Activity Request","type":"object"},"ActivityResponse":{"properties":{"attachments":{"description":"Media attachments for the activity","items":{"$ref":"#/components/schemas/Attachment"},"title":"Attachments","type":"array","x-stream-index":"009"},"bookmark_count":{"description":"Number of bookmarks on the activity","format":"int32","title":"Bookmark Count","type":"integer","x-stream-index":"028"},"comment_count":{"description":"Number of comments on the activity","format":"int32","title":"Comment Count","type":"integer","x-stream-index":"027"},"comments":{"description":"Comments on this activity","items":{"$ref":"#/components/schemas/CommentResponse"},"title":"Comments","type":"array","x-stream-index":"015"},"created_at":{"description":"When the activity was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"007"},"current_feed":{"$ref":"#/components/schemas/FeedResponse","description":"Feed context for this activity view. If an activity is added only to one feed, it's always set. If an activity is added to multiple feeds, it's only set when calling the GetOrCreateFeed endpoint.","title":"Current Feed","x-stream-index":"035"},"custom":{"additionalProperties":{},"description":"Custom data for the activity","title":"Custom Data","type":"object","x-stream-index":"011"},"deleted_at":{"description":"When the activity was deleted","format":"date-time","title":"Deleted At","type":"number","x-stream-index":"021"},"edited_at":{"description":"When the activity was last edited","format":"date-time","title":"Edited At","type":"number","x-stream-index":"020"},"expires_at":{"description":"When the activity will expire","format":"date-time","title":"Expires At","type":"number","x-stream-index":"022"},"feeds":{"description":"List of feed IDs containing this activity","items":{"type":"string"},"title":"Feeds","type":"array","x-stream-index":"004"},"filter_tags":{"description":"Tags for filtering","items":{"type":"string"},"title":"Filter Tags","type":"array","x-stream-index":"024"},"hidden":{"description":"If this activity is hidden for this user. For premium content where you want to show a preview","title":"Hidden","type":"boolean","x-stream-index":"036"},"id":{"description":"Unique identifier for the activity","title":"ID","type":"string","x-stream-index":"001"},"interest_tags":{"description":"Tags for user interests","items":{"type":"string"},"title":"Interest Tags","type":"array","x-stream-index":"025"},"latest_reactions":{"description":"Recent reactions to the activity","items":{"$ref":"#/components/schemas/FeedsReactionResponse"},"title":"Latest Reactions","type":"array","x-stream-index":"031"},"location":{"$ref":"#/components/schemas/ActivityLocation","description":"Geographic location related to the activity","title":"Location","x-stream-index":"017"},"mentioned_users":{"description":"Users mentioned in the activity","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Mentioned Users","type":"array","x-stream-index":"010"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","description":"Moderation information","title":"Moderation","x-stream-index":"026"},"notification_context":{"additionalProperties":{},"description":"Notification context data for the activity (if this is a reaction, comment, follow, etc.)","title":"Notification Context","type":"object","x-stream-index":"012"},"own_bookmarks":{"description":"Current user's bookmarks for this activity","items":{"$ref":"#/components/schemas/BookmarkResponse"},"title":"Own Bookmarks","type":"array","x-stream-index":"034"},"own_reactions":{"description":"Current user's reactions to this activity","items":{"$ref":"#/components/schemas/FeedsReactionResponse"},"title":"Own Reactions","type":"array","x-stream-index":"033"},"parent":{"$ref":"#/components/schemas/ActivityResponse","description":"Parent activity (if this is a reply/comment)","title":"Parent","x-stream-index":"018"},"poll":{"$ref":"#/components/schemas/PollResponseData","description":"Poll attached to this activity","title":"Poll","x-stream-index":"019"},"popularity":{"description":"Popularity score of the activity","format":"int32","title":"Popularity","type":"integer","x-stream-index":"013"},"reaction_count":{"description":"Number of reactions to the activity","format":"int32","title":"Reaction Count","type":"integer","x-stream-index":"030"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"description":"Grouped reactions by type","title":"Reaction Groups","type":"object","x-stream-index":"032"},"score":{"description":"Ranking score for this activity","format":"float","title":"Score","type":"number","x-stream-index":"014"},"search_data":{"additionalProperties":{},"description":"Data for search indexing","title":"Search Data","type":"object","x-stream-index":"023"},"share_count":{"description":"Number of times the activity was shared","format":"int32","title":"Share Count","type":"integer","x-stream-index":"029"},"text":{"description":"Text content of the activity","title":"Text","type":"string","x-stream-index":"016"},"type":{"description":"Type of activity","title":"Type","type":"string","x-stream-index":"002"},"updated_at":{"description":"When the activity was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"008"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who created the activity","title":"User","x-stream-index":"003"},"visibility":{"description":"Visibility setting for the activity","enum":["public","private","tag"],"title":"Visibility","type":"string","x-stream-index":"005"},"visibility_tag":{"description":"If visibility is 'tag', this is the tag name","title":"Visibility Tag","type":"string","x-stream-index":"006"}},"required":["id","type","user","feeds","visibility","created_at","updated_at","attachments","mentioned_users","custom","popularity","score","comments","search_data","filter_tags","interest_tags","comment_count","bookmark_count","share_count","reaction_count","latest_reactions","reaction_groups","own_reactions","own_bookmarks"],"title":"Base Activity","type":"object"},"ActivitySelectorConfig":{"nullable":true,"properties":{"cutoff_time":{"format":"date-time","type":"number","x-stream-index":"004"},"filter":{"additionalProperties":{},"type":"object","x-stream-index":"002"},"min_popularity":{"format":"int32","type":"integer","x-stream-index":"005"},"sort":{"items":{"$ref":"#/components/schemas/SortParam"},"type":"array","x-stream-index":"003"},"type":{"type":"string","x-stream-index":"001"}},"required":["cutoff_time"],"type":"object"},"ActivityUnpinnedEvent":{"description":"Emitted when an activity is unpinned.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"description":"The ID of the feed","title":"Feed ID","type":"string","x-stream-index":"002.002"},"pinned_activity":{"$ref":"#/components/schemas/PinActivityResponse","x-stream-index":"001"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.activity.unpinned","description":"The type of event: \"feeds.activity.unpinned\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who unpinned the activity","title":"User","x-stream-index":"003.001"}},"required":["pinned_activity","type","created_at","custom","fid"],"title":"ActivityUnpinnedEvent","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"},"ActivityUpdatedEvent":{"description":"Emitted when an activity is updated.","nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","description":"The activity that was updated","title":"Activity","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"type":"string","x-stream-index":"002.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.activity.updated","description":"The type of the event","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who updated the activity","title":"User","x-stream-index":"003.001"}},"required":["activity","type","created_at","custom","fid"],"title":"ActivityUpdatedEvent","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"},"AddActivityRequest":{"nullable":true,"properties":{"attachments":{"description":"List of attachments for the activity","items":{"$ref":"#/components/schemas/Attachment"},"title":"Attachments","type":"array","x-stream-index":"001.006"},"custom":{"additionalProperties":{},"description":"Custom data for the activity","title":"Custom Data","type":"object","x-stream-index":"001.017"},"expires_at":{"description":"Expiration time for the activity","title":"Expires At","type":"string","x-stream-index":"001.010"},"feeds":{"description":"List of feed IDs to add the activity to","items":{"type":"string"},"maximum":255,"minimum":1,"title":"Feed IDs","type":"array","x-stream-index":"001.004"},"filter_tags":{"description":"Tags for filtering activities","items":{"type":"string"},"maximum":255,"title":"Filter Tags","type":"array","x-stream-index":"001.013"},"id":{"description":"Optional ID for the activity","maxLength":255,"title":"Activity ID","type":"string","x-stream-index":"001.001"},"interest_tags":{"description":"Tags for indicating user interests","items":{"type":"string"},"maximum":255,"title":"Interest Tags","type":"array","x-stream-index":"001.014"},"location":{"$ref":"#/components/schemas/ActivityLocation","description":"Geographic location related to the activity","title":"Location","x-stream-index":"001.009"},"mentioned_user_ids":{"description":"List of users mentioned in the activity","items":{"type":"string"},"maximum":255,"title":"Mentioned User IDs","type":"array","x-stream-index":"001.011"},"parent_id":{"description":"ID of parent activity for replies/comments","maxLength":255,"title":"Parent ID","type":"string","x-stream-index":"001.015"},"poll_id":{"description":"ID of a poll to attach to activity","title":"Poll ID","type":"string","x-stream-index":"001.016"},"search_data":{"additionalProperties":{},"description":"Additional data for search indexing","title":"Search Data","type":"object","x-stream-index":"001.012"},"text":{"description":"Text content of the activity","title":"Text","type":"string","x-stream-index":"001.005"},"type":{"description":"Type of activity","maxLength":255,"title":"Activity Type","type":"string","x-stream-index":"001.002"},"visibility":{"description":"Visibility setting for the activity","enum":["public","private","tag"],"title":"Visibility","type":"string","x-stream-index":"001.007"},"visibility_tag":{"description":"If visibility is 'tag', this is the tag name and is required","maxLength":32,"title":"Visibility Tag","type":"string","x-stream-index":"001.008"}},"required":["type","feeds"],"title":"Activity Request","type":"object"},"AddActivityResponse":{"nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","description":"The created activity","title":"Activity","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["activity","duration"],"title":"Add Activity Response","type":"object"},"AddBookmarkRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"description":"Custom data for the bookmark","title":"Custom Data","type":"object","x-stream-index":"004"},"folder_id":{"description":"ID of the folder to add the bookmark to","maxLength":255,"title":"Folder ID","type":"string","x-stream-index":"002"},"new_folder":{"$ref":"#/components/schemas/AddFolderRequest","description":"Create a new folder for this bookmark","title":"New Folder","x-stream-index":"003"}},"title":"Add Bookmark Request","type":"object"},"AddBookmarkResponse":{"nullable":true,"properties":{"bookmark":{"$ref":"#/components/schemas/BookmarkResponse","description":"The created bookmark","title":"Bookmark","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["bookmark","duration"],"title":"Add Bookmark Response","type":"object"},"AddCommentReactionRequest":{"nullable":true,"properties":{"create_notification_activity":{"description":"Whether to create a notification activity for this reaction","title":"boolean","type":"boolean","x-stream-index":"004"},"custom":{"additionalProperties":{},"description":"Optional custom data to add to the reaction","title":"object","type":"object","x-stream-index":"003"},"skip_push":{"type":"boolean","x-stream-index":"005"},"type":{"description":"The type of reaction, eg upvote, like, ...","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},"required":["type"],"type":"object"},"AddCommentReactionResponse":{"nullable":true,"properties":{"comment":{"$ref":"#/components/schemas/CommentResponse","description":"The comment the reaction was added to","title":"object","x-stream-index":"001"},"duration":{"description":"Duration of the request","title":"string","type":"string","x-stream-index":"003.001"},"reaction":{"$ref":"#/components/schemas/FeedsReactionResponse","description":"The created or updated reaction","title":"object","x-stream-index":"002"}},"required":["comment","reaction","duration"],"type":"object"},"AddCommentRequest":{"nullable":true,"properties":{"attachments":{"description":"Media attachments for the reply","items":{"$ref":"#/components/schemas/Attachment"},"title":"Attachments","type":"array","x-stream-index":"004"},"comment":{"description":"Text content of the comment","title":"Comment","type":"string","x-stream-index":"003"},"create_notification_activity":{"description":"Whether to create a notification activity for this comment","title":"Create Notification Activity","type":"boolean","x-stream-index":"008"},"custom":{"additionalProperties":{},"description":"Custom data for the comment","title":"Custom Data","type":"object","x-stream-index":"007"},"mentioned_user_ids":{"description":"List of users mentioned in the reply","items":{"type":"string"},"maximum":255,"title":"Mentioned User IDs","type":"array","x-stream-index":"005"},"object_id":{"description":"ID of the object to comment on","title":"Object ID","type":"string","x-stream-index":"001"},"object_type":{"description":"Type of the object to comment on","title":"Object Type","type":"string","x-stream-index":"002"},"parent_id":{"description":"ID of parent comment for replies","title":"Parent ID","type":"string","x-stream-index":"006"},"skip_push":{"type":"boolean","x-stream-index":"009"}},"required":["object_id","object_type","comment"],"title":"Add Comment Request","type":"object"},"AddCommentResponse":{"nullable":true,"properties":{"comment":{"$ref":"#/components/schemas/CommentResponse","description":"The created comment","title":"Comment","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["comment","duration"],"title":"Add Comment Response","type":"object"},"AddCommentsBatchRequest":{"nullable":true,"properties":{"comments":{"description":"List of comments to add","items":{"$ref":"#/components/schemas/AddCommentRequest"},"title":"Comments","type":"array","x-stream-index":"001"}},"required":["comments"],"title":"Add Comments Batch Request","type":"object"},"AddCommentsBatchResponse":{"nullable":true,"properties":{"comments":{"description":"List of comments added","items":{"$ref":"#/components/schemas/CommentResponse"},"title":"Comments","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["comments","duration"],"title":"Add Comments Batch Response","type":"object"},"AddFolderRequest":{"properties":{"custom":{"additionalProperties":{},"description":"Custom data for the folder","title":"Custom Data","type":"object","x-stream-index":"002"},"name":{"description":"Name of the folder","maxLength":255,"title":"Name","type":"string","x-stream-index":"001"}},"required":["name"],"title":"Add Folder Request","type":"object"},"AddReactionRequest":{"nullable":true,"properties":{"create_notification_activity":{"description":"Whether to create a notification activity for this reaction","title":"Create Notification Activity","type":"boolean","x-stream-index":"004"},"custom":{"additionalProperties":{},"description":"Custom data for the reaction","title":"Custom Data","type":"object","x-stream-index":"003"},"skip_push":{"type":"boolean","x-stream-index":"005"},"type":{"description":"Type of reaction","maxLength":255,"title":"Reaction Type","type":"string","x-stream-index":"002"}},"required":["type"],"title":"Add Reaction Request","type":"object"},"AddReactionResponse":{"nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"reaction":{"$ref":"#/components/schemas/FeedsReactionResponse","description":"The created reaction","title":"Reaction","x-stream-index":"002"}},"required":["activity","reaction","duration"],"title":"Add Reaction Response","type":"object"},"AggregatedActivityResponse":{"properties":{"activities":{"description":"List of activities in this aggregation","items":{"$ref":"#/components/schemas/ActivityResponse"},"title":"Activities","type":"array","x-stream-index":"001"},"activity_count":{"description":"Number of activities in this aggregation","format":"int32","title":"Activity Count","type":"integer","x-stream-index":"002"},"created_at":{"description":"When the aggregation was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"006"},"group":{"description":"Grouping identifier","title":"Group","type":"string","x-stream-index":"004"},"score":{"description":"Ranking score for this aggregation","format":"float","title":"Score","type":"number","x-stream-index":"005"},"updated_at":{"description":"When the aggregation was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"007"},"user_count":{"description":"Number of unique users in this aggregation","format":"int32","title":"User Count","type":"integer","x-stream-index":"003"}},"required":["activities","activity_count","user_count","group","score","created_at","updated_at"],"title":"Aggregated Activity","type":"object"},"AggregationConfig":{"properties":{"format":{"type":"string","x-stream-index":"001"},"group_size":{"format":"int32","type":"integer","x-stream-index":"002"}},"type":"object"},"AppEventResponse":{"properties":{"async_url_enrich_enabled":{"description":"boolean","title":"Async URL Enrichment Enabled","type":"boolean","x-stream-index":"002"},"auto_translation_enabled":{"description":"boolean","title":"Auto Translation Enabled","type":"boolean","x-stream-index":"003"},"file_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","description":"file upload config","title":"File Upload Config","x-stream-index":"004"},"image_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","description":"file upload config","title":"Image Upload Config","x-stream-index":"005"},"name":{"description":"string","title":"App name","type":"string","x-stream-index":"001"}},"required":["name","auto_translation_enabled"],"type":"object"},"AppResponseFields":{"properties":{"async_url_enrich_enabled":{"type":"boolean","x-stream-index":"017"},"auto_translation_enabled":{"type":"boolean","x-stream-index":"020"},"file_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","x-stream-index":"030"},"image_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","x-stream-index":"031"},"name":{"type":"string","x-stream-index":"001"}},"required":["name","organization","push_notifications","webhook_url","moderation_webhook_url","channel_configs","call_types","policies","suspended","suspended_explanation","disable_auth_checks","disable_permissions_checks","permission_version","user_search_disallowed_roles","multi_tenant_enabled","image_moderation_enabled","async_url_enrich_enabled","auto_translation_enabled","custom_action_handler_url","enforce_unique_usernames","sqs_url","sqs_key","sqs_secret","sns_topic_arn","sns_key","sns_secret","file_upload_config","image_upload_config","grants","campaign_enabled","webhook_events","reminders_interval","cdn_expiration_seconds","video_provider","moderation_enabled","moderation_multitenant_blocklist_enabled","guest_user_creation_disabled","event_hooks","use_hook_v2","user_response_time_enabled","moderation_bulk_submit_action_enabled","moderation_llm_configurability_enabled"],"type":"object"},"AppUpdatedEvent":{"description":"Emitted when app settings are updated","nullable":true,"properties":{"app":{"$ref":"#/components/schemas/AppEventResponse","description":"application configuration","title":"App settings","x-stream-index":"002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"type":{"default":"app.updated","description":"The type of event: \"app.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.002"}},"required":["type","created_at","custom","app"],"title":"AppUpdatedEvent","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"},"Attachment":{"description":"An attachment is a message object that represents a file uploaded by a user.","nullable":true,"properties":{"actions":{"items":{"$ref":"#/components/schemas/Action"},"type":"array","x-stream-index":"015"},"asset_url":{"type":"string","x-stream-index":"017"},"author_icon":{"type":"string","x-stream-index":"007"},"author_link":{"type":"string","x-stream-index":"006"},"author_name":{"type":"string","x-stream-index":"005"},"color":{"type":"string","x-stream-index":"003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"018"},"fallback":{"type":"string","x-stream-index":"002"},"fields":{"items":{"$ref":"#/components/schemas/Field"},"type":"array","x-stream-index":"016"},"footer":{"type":"string","x-stream-index":"013"},"footer_icon":{"type":"string","x-stream-index":"014"},"giphy":{"$ref":"#/components/schemas/Images","x-stream-index":"019"},"image_url":{"type":"string","x-stream-index":"011"},"og_scrape_url":{"type":"string","x-stream-index":"020"},"original_height":{"format":"int32","type":"integer","x-stream-index":"022"},"original_width":{"format":"int32","type":"integer","x-stream-index":"021"},"pretext":{"type":"string","x-stream-index":"004"},"text":{"type":"string","x-stream-index":"010"},"thumb_url":{"type":"string","x-stream-index":"012"},"title":{"type":"string","x-stream-index":"008"},"title_link":{"type":"string","x-stream-index":"009"},"type":{"description":"Attachment type (e.g. image, video, url)","title":"Type","type":"string","x-stream-index":"001"}},"required":["custom"],"title":"Attachment","type":"object","x-stream-docs-page-id":"file_uploads"},"AudioSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"001"},"default_device":{"enum":["speaker","earpiece"],"type":"string","x-stream-index":"006"},"mic_default_on":{"type":"boolean","x-stream-index":"004"},"noise_cancellation":{"$ref":"#/components/schemas/NoiseCancellationSettings","x-stream-index":"007"},"opus_dtx_enabled":{"type":"boolean","x-stream-index":"002"},"redundant_coding_enabled":{"type":"boolean","x-stream-index":"003"},"speaker_default_on":{"type":"boolean","x-stream-index":"005"}},"required":["access_request_enabled","opus_dtx_enabled","redundant_coding_enabled","mic_default_on","speaker_default_on","default_device"],"type":"object"},"AudioSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"001"},"default_device":{"enum":["speaker","earpiece"],"type":"string","x-stream-index":"006"},"mic_default_on":{"type":"boolean","x-stream-index":"004"},"noise_cancellation":{"$ref":"#/components/schemas/NoiseCancellationSettings","x-stream-index":"007"},"opus_dtx_enabled":{"type":"boolean","x-stream-index":"002"},"redundant_coding_enabled":{"type":"boolean","x-stream-index":"003"},"speaker_default_on":{"type":"boolean","x-stream-index":"005"}},"required":["access_request_enabled","opus_dtx_enabled","redundant_coding_enabled","mic_default_on","speaker_default_on","default_device"],"type":"object"},"AutomodPlatformCircumventionConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AutomodRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"AutomodRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"003"},"label":{"type":"string","x-stream-index":"001"},"threshold":{"format":"float","maximum":1,"minimum":0,"type":"number","x-stream-index":"002"}},"required":["label","threshold","action"],"type":"object"},"AutomodSemanticFiltersConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AutomodSemanticFiltersRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"AutomodSemanticFiltersRule":{"properties":{"action":{"enum":["flag","shadow","remove"],"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"threshold":{"format":"float","maximum":1,"minimum":0,"type":"number","x-stream-index":"002"}},"required":["name","threshold","action"],"type":"object"},"AutomodToxicityConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AutomodRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"BackstageSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"BackstageSettingsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"Ban":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"012"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"011"},"expires":{"format":"date-time","type":"number","x-stream-index":"007"},"reason":{"type":"string","x-stream-index":"008"},"shadow":{"type":"boolean","x-stream-index":"009"},"target":{"$ref":"#/components/schemas/User","x-stream-index":"006"}},"required":["shadow","created_at"],"type":"object"},"BanActionRequest":{"properties":{"channel_ban_only":{"type":"boolean","x-stream-index":"003"},"delete_messages":{"enum":["soft","pruning","hard"],"type":"string","x-stream-index":"005"},"ip_ban":{"type":"boolean","x-stream-index":"004"},"reason":{"type":"string","x-stream-index":"002"},"shadow":{"type":"boolean","x-stream-index":"001"},"timeout":{"format":"int32","type":"integer","x-stream-index":"006"}},"type":"object"},"BanOptions":{"properties":{"duration":{"format":"int32","type":"integer","x-stream-index":"001"},"ip_ban":{"type":"boolean","x-stream-index":"004"},"reason":{"type":"string","x-stream-index":"002"},"shadow_ban":{"type":"boolean","x-stream-index":"003"}},"type":"object"},"BanRequest":{"nullable":true,"properties":{"banned_by":{"$ref":"#/components/schemas/UserRequest","description":"Details about the user performing the ban","title":"Banned By","x-stream-index":"008"},"banned_by_id":{"description":"ID of the user performing the ban","title":"Banned By ID","type":"string","x-stream-index":"007"},"channel_cid":{"description":"Channel where the ban applies","title":"Channel CID","type":"string","x-stream-index":"004"},"delete_messages":{"enum":["soft","pruning","hard"],"type":"string","x-stream-index":"009"},"ip_ban":{"description":"Whether to ban the user's IP address","title":"IP Ban","type":"boolean","x-stream-index":"006"},"reason":{"description":"Optional explanation for the ban","title":"Reason","type":"string","x-stream-index":"003"},"shadow":{"description":"Whether this is a shadow ban","title":"Shadow","type":"boolean","x-stream-index":"005"},"target_user_id":{"description":"ID of the user to ban","title":"Target User ID","type":"string","x-stream-index":"001"},"timeout":{"description":"Duration of the ban in minutes","minimum":0,"title":"Timeout","type":"integer","x-stream-index":"002"}},"required":["target_user_id"],"type":"object"},"BanResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"BlockContentOptions":{"properties":{"reason":{"type":"string","x-stream-index":"001"}},"type":"object"},"BlockListConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/BlockListRule"},"maximum":10,"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"BlockListOptions":{"properties":{"behavior":{"description":"Blocklist behavior","enum":["flag","block","shadow_block"],"title":"Behavior","type":"string","x-stream-index":"002"},"blocklist":{"description":"Blocklist name","title":"Blocklist","type":"string","x-stream-index":"001"}},"required":["blocklist","behavior"],"type":"object"},"BlockListResponse":{"description":"Block list contains restricted words","properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001"},"id":{"type":"string","x-stream-index":"003"},"name":{"description":"Block list name","title":"Name","type":"string","x-stream-index":"004"},"team":{"type":"string","x-stream-index":"007"},"type":{"description":"Block list type.","title":"Type","type":"string","x-stream-index":"005"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"002"},"words":{"description":"List of words to block","items":{"type":"string"},"title":"Words","type":"array","x-stream-index":"006"}},"required":["name","type","words"],"title":"Block list","type":"object","x-stream-docs-page-id":"block_lists"},"BlockListRule":{"properties":{"action":{"enum":["flag","mask_flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"002"}},"required":["name","team","action"],"type":"object"},"BlockUsersRequest":{"nullable":true,"properties":{"blocked_user_id":{"description":"User id to block","title":"BlockedUserID","type":"string","x-stream-index":"001"}},"required":["blocked_user_id"],"type":"object"},"BlockUsersResponse":{"nullable":true,"properties":{"blocked_by_user_id":{"description":"User id who blocked another user","title":"BlockedByUserID","type":"string","x-stream-index":"002"},"blocked_user_id":{"description":"User id who got blocked","title":"BlockedUserID","type":"string","x-stream-index":"003"},"created_at":{"description":"Timestamp when the user was blocked","format":"date-time","title":"CreatedAt","type":"number","x-stream-index":"004"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration","blocked_by_user_id","blocked_user_id","created_at"],"type":"object"},"BlockedUserResponse":{"nullable":true,"properties":{"blocked_user":{"$ref":"#/components/schemas/UserResponse","description":"User who got blocked","title":"User","x-stream-index":"003"},"blocked_user_id":{"description":"ID of the user who got blocked","title":"UserID","type":"string","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who blocked another user","title":"User","x-stream-index":"001"},"user_id":{"description":"ID of the user who blocked another user","title":"UserID","type":"string","x-stream-index":"002"}},"required":["user","user_id","blocked_user","blocked_user_id","created_at"],"type":"object"},"BodyguardRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"},"severity_rules":{"items":{"$ref":"#/components/schemas/BodyguardSeverityRule"},"type":"array","x-stream-index":"003"}},"required":["label","action","severity_rules"],"type":"object"},"BodyguardSeverityRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"severity":{"enum":["low","medium","high","critical"],"type":"string","x-stream-index":"001"}},"required":["severity","action"],"type":"object"},"BookmarkAddedEvent":{"description":"Emitted when a user bookmarks an activity.","nullable":true,"properties":{"bookmark":{"$ref":"#/components/schemas/BookmarkResponse","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.bookmark.added","description":"The type of event: \"feeds.bookmark.added\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who added the bookmark","title":"User","x-stream-index":"003.001"}},"required":["bookmark","type","created_at","custom"],"title":"BookmarkAddedEvent","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"},"BookmarkDeletedEvent":{"description":"Emitted when a user deletes a bookmark from an activity.","nullable":true,"properties":{"bookmark":{"$ref":"#/components/schemas/BookmarkResponse","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.bookmark.deleted","description":"The type of event: \"feeds.bookmark.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who removed the bookmark","title":"User","x-stream-index":"003.001"}},"required":["bookmark","type","created_at","custom"],"title":"BookmarkDeletedEvent","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"},"BookmarkFolderDeletedEvent":{"description":"Emitted when a bookmark folder is deleted.","nullable":true,"properties":{"bookmark_folder":{"$ref":"#/components/schemas/BookmarkFolderResponse","description":"The bookmark folder that was deleted","title":"Bookmark Folder","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.bookmark_folder.deleted","description":"The type of event: \"feeds.bookmark_folder.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who deleted the bookmark folder","title":"User","x-stream-index":"003.001"}},"required":["bookmark_folder","type","created_at","custom"],"title":"BookmarkFolderDeletedEvent","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"},"BookmarkFolderResponse":{"properties":{"created_at":{"description":"When the folder was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"004"},"custom":{"additionalProperties":{},"description":"Custom data for the folder","title":"Custom Data","type":"object","x-stream-index":"003"},"id":{"description":"Unique identifier for the folder","title":"ID","type":"string","x-stream-index":"001"},"name":{"description":"Name of the folder","title":"Name","type":"string","x-stream-index":"002"},"updated_at":{"description":"When the folder was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"005"}},"required":["id","name","created_at","updated_at"],"title":"Bookmark Folder","type":"object"},"BookmarkFolderUpdatedEvent":{"description":"Emitted when a bookmark folder is updated.","nullable":true,"properties":{"bookmark_folder":{"$ref":"#/components/schemas/BookmarkFolderResponse","description":"The bookmark folder that was updated","title":"Bookmark Folder","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.bookmark_folder.updated","description":"The type of event: \"feeds.bookmark_folder.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who updated the bookmark folder","title":"User","x-stream-index":"003.001"}},"required":["bookmark_folder","type","created_at","custom"],"title":"BookmarkFolderUpdatedEvent","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"},"BookmarkResponse":{"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","description":"The bookmarked activity","title":"Activity","x-stream-index":"002"},"created_at":{"description":"When the bookmark was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"005"},"custom":{"additionalProperties":{},"description":"Custom data for the bookmark","title":"Custom Data","type":"object","x-stream-index":"004"},"folder":{"$ref":"#/components/schemas/BookmarkFolderResponse","description":"Folder containing this bookmark","title":"Folder","x-stream-index":"003"},"updated_at":{"description":"When the bookmark was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"006"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who created the bookmark","title":"User","x-stream-index":"001"}},"required":["user","activity","created_at","updated_at"],"title":"Bookmark","type":"object"},"BookmarkUpdatedEvent":{"description":"Emitted when a user updates a bookmark.","nullable":true,"properties":{"bookmark":{"$ref":"#/components/schemas/BookmarkResponse","description":"The updated bookmark","title":"Bookmark","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.bookmark.updated","description":"The type of event: \"feeds.bookmark.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who updated the bookmark","title":"User","x-stream-index":"003.001"}},"required":["bookmark","type","created_at","custom"],"title":"BookmarkUpdatedEvent","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"},"BroadcastSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettings","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettings","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"BroadcastSettingsResponse":{"description":"BroadcastSettingsResponse is the payload for broadcasting settings","properties":{"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettingsResponse","title":"HLS","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettingsResponse","title":"RTMP","x-stream-index":"003"}},"required":["enabled","hls","rtmp"],"title":"BroadcastSettingsResponse","type":"object"},"Call":{"properties":{"AppPK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"002"},"Backstage":{"type":"boolean","writeOnly":true,"x-stream-index":"023"},"BlockedUserIDs":{"items":{"type":"string"},"type":"array","writeOnly":true,"x-stream-index":"018"},"BlockedUsers":{"items":{"$ref":"#/components/schemas/User"},"type":"array","writeOnly":true,"x-stream-index":"019"},"CID":{"type":"string","writeOnly":true,"x-stream-index":"005"},"CallType":{"$ref":"#/components/schemas/CallType","x-stream-index":"020"},"ChannelCID":{"type":"string","writeOnly":true,"x-stream-index":"032"},"CreatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"013"},"CreatedBy":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"CreatedByUserID":{"type":"string","writeOnly":true,"x-stream-index":"007"},"CurrentSessionID":{"type":"string","writeOnly":true,"x-stream-index":"024"},"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"012"},"DeletedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"028"},"EgressUpdatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"027"},"Egresses":{"items":{"$ref":"#/components/schemas/CallEgress"},"type":"array","writeOnly":true,"x-stream-index":"015"},"EndedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"017"},"ID":{"type":"string","writeOnly":true,"x-stream-index":"004"},"JoinAheadTimeSeconds":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"031"},"LastHeartbeatAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"030"},"LastSessionID":{"type":"string","writeOnly":true,"x-stream-index":"025"},"MemberCount":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"010"},"MemberLookup":{"$ref":"#/components/schemas/MemberLookup","x-stream-index":"011"},"Members":{"items":{"$ref":"#/components/schemas/CallMember"},"type":"array","writeOnly":true,"x-stream-index":"009"},"Session":{"$ref":"#/components/schemas/CallSession","x-stream-index":"026"},"Settings":{"$ref":"#/components/schemas/CallSettings","x-stream-index":"022"},"SettingsOverrides":{"$ref":"#/components/schemas/CallSettings","x-stream-index":"021"},"StartsAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"016"},"Team":{"type":"string","writeOnly":true,"x-stream-index":"006"},"ThumbnailURL":{"type":"string","writeOnly":true,"x-stream-index":"029"},"Type":{"type":"string","writeOnly":true,"x-stream-index":"003"},"UpdatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"014"}},"required":["AppPK","Type","ID","CID","Team","CreatedByUserID","Members","Custom","CreatedAt","UpdatedAt","Egresses","BlockedUserIDs","BlockedUsers","Backstage","CurrentSessionID","LastSessionID","ThumbnailURL","ChannelCID"],"type":"object"},"CallEgress":{"nullable":true,"properties":{"app_pk":{"format":"int32","type":"integer","x-stream-index":"002"},"call_id":{"type":"string","x-stream-index":"004"},"call_type":{"type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/EgressTaskConfig","x-stream-index":"007"},"egress_id":{"type":"string","x-stream-index":"005"},"egress_type":{"type":"string","x-stream-index":"006"},"instance_ip":{"type":"string","x-stream-index":"008"},"started_at":{"format":"date-time","type":"number","x-stream-index":"010"},"state":{"type":"string","x-stream-index":"009"},"stopped_at":{"format":"date-time","type":"number","x-stream-index":"011"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"012"}},"required":["app_pk","call_type","call_id","egress_id","egress_type","instance_ip","state","started_at","updated_at"],"type":"object"},"CallIngressResponse":{"description":"CallIngressResponse is the payload for ingress settings","properties":{"rtmp":{"$ref":"#/components/schemas/RTMPIngress","title":"RTMP","x-stream-index":"001"}},"required":["rtmp"],"title":"CallIngressResponse","type":"object"},"CallMember":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"010"},"role":{"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["user_id","role","custom","created_at","updated_at"],"type":"object"},"CallParticipant":{"nullable":true,"properties":{"JoinedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"004"},"Role":{"type":"string","writeOnly":true,"x-stream-index":"002"},"UserSessionID":{"type":"string","writeOnly":true,"x-stream-index":"003"},"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"001.046"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"001.017"},"banned":{"type":"boolean","x-stream-index":"001.016"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.013"},"id":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"001.023"},"language":{"type":"string","x-stream-index":"001.035"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"001.022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"001.026"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.042"},"role":{"type":"string","x-stream-index":"001.004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.005"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.009"}},"required":["id","role","teams_role","custom","banned","online","Role","UserSessionID","JoinedAt"],"type":"object"},"CallParticipantResponse":{"properties":{"joined_at":{"format":"date-time","type":"number","x-stream-index":"004"},"role":{"type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"},"user_session_id":{"type":"string","x-stream-index":"002"}},"required":["user","user_session_id","role","joined_at"],"type":"object"},"CallResponse":{"description":"Represents a call","properties":{"backstage":{"type":"boolean","x-stream-index":"016"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"018"},"captioning":{"type":"boolean","x-stream-index":"013"},"channel_cid":{"type":"string","x-stream-index":"024"},"cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"The user that created the call","title":"Created By","x-stream-index":"007"},"current_session_id":{"type":"string","x-stream-index":"005"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"008"},"egress":{"$ref":"#/components/schemas/EgressResponse","x-stream-index":"021"},"ended_at":{"description":"Date/time when the call ended","format":"date-time","title":"Ended At","type":"number","x-stream-index":"014"},"id":{"description":"Call ID","title":"ID","type":"string","x-stream-index":"003"},"ingress":{"$ref":"#/components/schemas/CallIngressResponse","x-stream-index":"019"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"023"},"recording":{"type":"boolean","x-stream-index":"011"},"session":{"$ref":"#/components/schemas/CallSessionResponse","x-stream-index":"020"},"settings":{"$ref":"#/components/schemas/CallSettingsResponse","x-stream-index":"017"},"starts_at":{"description":"Date/time when the call will start","format":"date-time","title":"Starts At","type":"number","x-stream-index":"015"},"team":{"type":"string","x-stream-index":"006"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailResponse","x-stream-index":"022"},"transcribing":{"type":"boolean","x-stream-index":"012"},"type":{"description":"The type of call","title":"Type","type":"string","x-stream-index":"002"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"}},"required":["type","id","cid","current_session_id","created_by","custom","created_at","updated_at","recording","transcribing","captioning","backstage","settings","blocked_user_ids","ingress","egress"],"title":"CallResponse","type":"object"},"CallSession":{"properties":{"AcceptedBy":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","writeOnly":true,"x-stream-index":"008"},"ActiveSFUs":{"items":{"$ref":"#/components/schemas/SFUIDLastSeen"},"type":"array","writeOnly":true,"x-stream-index":"016"},"AnonymousParticipantCount":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"019"},"AppPK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"002.001"},"CallID":{"type":"string","writeOnly":true,"x-stream-index":"002.003"},"CallType":{"type":"string","writeOnly":true,"x-stream-index":"002.002"},"CreatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"003"},"DeletedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"004"},"EndedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"006"},"LiveEndedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"013"},"LiveStartedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"012"},"MissedBy":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","writeOnly":true,"x-stream-index":"010"},"Participants":{"items":{"$ref":"#/components/schemas/CallParticipant"},"type":"array","writeOnly":true,"x-stream-index":"011"},"ParticipantsCountByRole":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","writeOnly":true,"x-stream-index":"018"},"RejectedBy":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","writeOnly":true,"x-stream-index":"009"},"RingAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"007"},"SFUIDs":{"items":{"type":"string"},"type":"array","writeOnly":true,"x-stream-index":"015"},"SessionID":{"type":"string","writeOnly":true,"x-stream-index":"002.004"},"StartedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"005"},"TimerEndsAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"014"},"UserPermissionOverrides":{"additionalProperties":{"additionalProperties":{"type":"boolean"},"type":"object"},"type":"object","writeOnly":true,"x-stream-index":"017"}},"required":["AppPK","CallType","CallID","SessionID","CreatedAt","AcceptedBy","RejectedBy","MissedBy","Participants","SFUIDs","ActiveSFUs","UserPermissionOverrides","ParticipantsCountByRole","AnonymousParticipantCount"],"type":"object"},"CallSessionResponse":{"properties":{"accepted_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"008"},"anonymous_participant_count":{"format":"int32","type":"integer","x-stream-index":"006"},"ended_at":{"format":"date-time","type":"number","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"live_ended_at":{"format":"date-time","type":"number","x-stream-index":"011"},"live_started_at":{"format":"date-time","type":"number","x-stream-index":"010"},"missed_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"009"},"participants":{"items":{"$ref":"#/components/schemas/CallParticipantResponse"},"type":"array","x-stream-index":"004"},"participants_count_by_role":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"005"},"rejected_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"007"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002"},"timer_ends_at":{"format":"date-time","type":"number","x-stream-index":"012"}},"required":["id","participants","participants_count_by_role","anonymous_participant_count","rejected_by","accepted_by","missed_by"],"type":"object"},"CallSettings":{"properties":{"audio":{"$ref":"#/components/schemas/AudioSettings","x-stream-index":"001"},"backstage":{"$ref":"#/components/schemas/BackstageSettings","x-stream-index":"002"},"broadcasting":{"$ref":"#/components/schemas/BroadcastSettings","x-stream-index":"007"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordSettings","x-stream-index":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettings","x-stream-index":"008"},"ingress":{"$ref":"#/components/schemas/IngressSettings","x-stream-index":"014"},"limits":{"$ref":"#/components/schemas/LimitsSettings","x-stream-index":"012"},"recording":{"$ref":"#/components/schemas/RecordSettings","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettings","x-stream-index":"010"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettings","x-stream-index":"004"},"session":{"$ref":"#/components/schemas/SessionSettings","x-stream-index":"013"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettings","x-stream-index":"011"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettings","x-stream-index":"009"},"video":{"$ref":"#/components/schemas/VideoSettings","x-stream-index":"003"}},"type":"object"},"CallSettingsResponse":{"properties":{"audio":{"$ref":"#/components/schemas/AudioSettingsResponse","x-stream-index":"001"},"backstage":{"$ref":"#/components/schemas/BackstageSettingsResponse","x-stream-index":"002"},"broadcasting":{"$ref":"#/components/schemas/BroadcastSettingsResponse","x-stream-index":"003"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordingSettingsResponse","x-stream-index":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettingsResponse","x-stream-index":"004"},"ingress":{"$ref":"#/components/schemas/IngressSettingsResponse","x-stream-index":"014"},"limits":{"$ref":"#/components/schemas/LimitsSettingsResponse","x-stream-index":"012"},"recording":{"$ref":"#/components/schemas/RecordSettingsResponse","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettingsResponse","x-stream-index":"007"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettingsResponse","x-stream-index":"008"},"session":{"$ref":"#/components/schemas/SessionSettingsResponse","x-stream-index":"013"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettingsResponse","x-stream-index":"011"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettingsResponse","x-stream-index":"009"},"video":{"$ref":"#/components/schemas/VideoSettingsResponse","x-stream-index":"010"}},"required":["audio","backstage","broadcasting","geofencing","recording","frame_recording","ring","screensharing","transcription","video","thumbnails","limits","session"],"type":"object"},"CallType":{"properties":{"AppPK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"003"},"CreatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"005"},"ExternalStorage":{"type":"string","writeOnly":true,"x-stream-index":"009"},"Name":{"type":"string","writeOnly":true,"x-stream-index":"004"},"NotificationSettings":{"$ref":"#/components/schemas/NotificationSettings","x-stream-index":"008"},"PK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"002"},"Settings":{"$ref":"#/components/schemas/CallSettings","x-stream-index":"007"},"UpdatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"006"}},"required":["PK","AppPK","Name","CreatedAt","UpdatedAt","ExternalStorage"],"type":"object"},"CastPollVoteRequest":{"nullable":true,"properties":{"vote":{"$ref":"#/components/schemas/VoteData","description":"Vote data","title":"VoteData","x-stream-index":"004"}},"type":"object"},"Channel":{"properties":{"active_live_locations":{"items":{"$ref":"#/components/schemas/SharedLocation"},"type":"array","x-stream-index":"034"},"auto_translation_enabled":{"type":"boolean","x-stream-index":"029"},"auto_translation_language":{"type":"string","x-stream-index":"030"},"cid":{"type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/ChannelConfig","x-stream-index":"026"},"config_overrides":{"$ref":"#/components/schemas/ConfigOverrides","x-stream-index":"027"},"cooldown":{"format":"int32","type":"integer","x-stream-index":"031"},"created_at":{"format":"date-time","type":"number","x-stream-index":"009"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"019"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"disabled":{"type":"boolean","x-stream-index":"017"},"frozen":{"type":"boolean","x-stream-index":"016"},"id":{"type":"string","x-stream-index":"004"},"invites":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"022"},"last_campaigns":{"type":"string","x-stream-index":"032"},"last_message_at":{"format":"date-time","type":"number","x-stream-index":"006"},"member_count":{"format":"int32","type":"integer","x-stream-index":"021"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"020"},"message_count":{"format":"int64","type":"integer","x-stream-index":"035"},"message_count_updated_at":{"format":"date-time","type":"number","x-stream-index":"036"},"team":{"type":"string","x-stream-index":"028"},"truncated_by":{"$ref":"#/components/schemas/User","x-stream-index":"015"},"type":{"type":"string","x-stream-index":"005"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"010"}},"required":["cid","id","type","created_at","updated_at","frozen","disabled","custom","auto_translation_language"],"type":"object"},"ChannelConfig":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.027"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.022"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.023"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.028"},"blocklist":{"type":"string","x-stream-index":"001.024"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.025"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.026"},"commands":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"connect_events":{"type":"boolean","x-stream-index":"001.004"},"count_messages":{"type":"boolean","x-stream-index":"001.019"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"custom_events":{"type":"boolean","x-stream-index":"001.012"},"mark_messages_pending":{"type":"boolean","x-stream-index":"001.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"001.021"},"mutes":{"type":"boolean","x-stream-index":"001.009"},"name":{"type":"string","x-stream-index":"001.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"001.029"},"partition_ttl":{"type":"integer","x-stream-index":"001.030"},"polls":{"type":"boolean","x-stream-index":"001.016"},"push_notifications":{"type":"boolean","x-stream-index":"001.013"},"quotes":{"type":"boolean","x-stream-index":"001.008"},"reactions":{"type":"boolean","x-stream-index":"001.006"},"read_events":{"type":"boolean","x-stream-index":"001.003"},"reminders":{"type":"boolean","x-stream-index":"001.014"},"replies":{"type":"boolean","x-stream-index":"001.007"},"search":{"type":"boolean","x-stream-index":"001.005"},"shared_locations":{"type":"boolean","x-stream-index":"001.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.031"},"typing_events":{"type":"boolean","x-stream-index":"001.002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"002.004"},"uploads":{"type":"boolean","x-stream-index":"001.010"},"url_enrichment":{"type":"boolean","x-stream-index":"001.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"001.017"}},"required":["name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","count_messages","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","created_at","updated_at","commands"],"type":"object"},"ChannelConfigWithInfo":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.002.027"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.002.022"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.023"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.002.028"},"blocklist":{"type":"string","x-stream-index":"001.002.024"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.025"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.002.026"},"commands":{"items":{"$ref":"#/components/schemas/Command"},"type":"array","x-stream-index":"001.003"},"connect_events":{"type":"boolean","x-stream-index":"001.002.004"},"count_messages":{"type":"boolean","x-stream-index":"001.002.019"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.001.003"},"custom_events":{"type":"boolean","x-stream-index":"001.002.012"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"002"},"mark_messages_pending":{"type":"boolean","x-stream-index":"001.002.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"001.002.021"},"mutes":{"type":"boolean","x-stream-index":"001.002.009"},"name":{"type":"string","x-stream-index":"001.002.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"001.002.029"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"001.002.030"},"polls":{"type":"boolean","x-stream-index":"001.002.016"},"push_notifications":{"type":"boolean","x-stream-index":"001.002.013"},"quotes":{"type":"boolean","x-stream-index":"001.002.008"},"reactions":{"type":"boolean","x-stream-index":"001.002.006"},"read_events":{"type":"boolean","x-stream-index":"001.002.003"},"reminders":{"type":"boolean","x-stream-index":"001.002.014"},"replies":{"type":"boolean","x-stream-index":"001.002.007"},"search":{"type":"boolean","x-stream-index":"001.002.005"},"shared_locations":{"type":"boolean","x-stream-index":"001.002.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.002.031"},"typing_events":{"type":"boolean","x-stream-index":"001.002.002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"uploads":{"type":"boolean","x-stream-index":"001.002.010"},"url_enrichment":{"type":"boolean","x-stream-index":"001.002.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"001.002.017"}},"required":["created_at","updated_at","name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","count_messages","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","commands"],"type":"object"},"ChannelMember":{"nullable":true,"properties":{"archived_at":{"format":"date-time","type":"number","x-stream-index":"015"},"ban_expires":{"description":"Expiration date of the ban","format":"date-time","title":"Ban expires","type":"number","x-stream-index":"013"},"banned":{"description":"Whether member is banned this channel or not","title":"Banned","type":"boolean","x-stream-index":"012"},"channel_role":{"description":"Role of the member in the channel","title":"Channel Role","type":"string","x-stream-index":"018"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"deleted_messages":{"items":{"type":"string"},"type":"array","x-stream-index":"020"},"invite_accepted_at":{"description":"Date when invite was accepted","format":"date-time","title":"Invited accepted at","type":"number","x-stream-index":"006"},"invite_rejected_at":{"description":"Date when invite was rejected","format":"date-time","title":"Invited rejected at","type":"number","x-stream-index":"007"},"invited":{"description":"Whether member was invited or not","title":"Invited","type":"boolean","x-stream-index":"005"},"is_moderator":{"description":"Whether member is channel moderator or not","title":"Is moderator","type":"boolean","x-stream-index":"003"},"notifications_muted":{"type":"boolean","x-stream-index":"019"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"016"},"role":{"description":"Permission level of the member in the channel (DEPRECATED: use channel_role instead)","enum":["member","moderator","admin","owner"],"title":"Role","type":"string","x-stream-index":"017"},"shadow_banned":{"description":"Whether member is shadow banned in this channel or not","title":"Shadow banned","type":"boolean","x-stream-index":"014"},"status":{"type":"string","x-stream-index":"008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"},"user_id":{"title":"User ID","type":"string","x-stream-index":"001"}},"required":["custom","created_at","updated_at","banned","shadow_banned","channel_role","notifications_muted"],"title":"Channel member","type":"object"},"ChannelMute":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel that is muted","title":"Channel","x-stream-index":"002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"004"},"expires":{"description":"Date/time of mute expiration","format":"date-time","title":"Expires","type":"number","x-stream-index":"003"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Owner of channel mute","title":"User","x-stream-index":"001"}},"required":["created_at","updated_at"],"type":"object"},"ChannelOwnCapability":{"description":"All possibility of string to use","enum":["ban-channel-members","cast-poll-vote","connect-events","create-attachment","delete-any-message","delete-channel","delete-own-message","flag-message","freeze-channel","join-channel","leave-channel","mute-channel","pin-message","query-poll-votes","quote-message","read-events","search-messages","send-custom-events","send-links","send-message","send-poll","send-reaction","send-reply","send-restricted-visibility-message","send-typing-events","set-channel-cooldown","share-location","skip-slow-mode","slow-mode","typing-events","update-any-message","update-channel","update-channel-members","update-own-message","update-thread","upload-file"],"title":"ChannelOwnCapability","type":"string"},"ChannelResponse":{"description":"Represents channel in chat","properties":{"auto_translation_enabled":{"description":"Whether auto translation is enabled or not","title":"Auto translation","type":"boolean","x-stream-index":"017"},"auto_translation_language":{"description":"Language to translate to when auto translation is active","title":"Auto translation language","type":"string","x-stream-index":"018"},"blocked":{"description":"Whether this channel is blocked by current user or not","title":"Blocked","type":"boolean","x-stream-index":"023"},"cid":{"description":"Channel CID (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/ChannelConfigWithInfo","description":"Channel configuration","title":"ChannelConfigWithInfo","x-stream-index":"013"},"cooldown":{"description":"Cooldown period after sending each message","format":"int32","title":"Cooldown","type":"integer","x-stream-index":"020"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"005"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"Creator of the channel","title":"UserResponse","x-stream-index":"008"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"026"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"007"},"disabled":{"type":"boolean","x-stream-index":"010"},"frozen":{"description":"Whether channel is frozen or not","title":"Frozen","type":"boolean","x-stream-index":"009"},"hidden":{"description":"Whether this channel is hidden by current user or not","title":"Hidden","type":"boolean","x-stream-index":"022"},"hide_messages_before":{"description":"Date since when the message history is accessible","format":"date-time","title":"Hide messages before","type":"number","x-stream-index":"019"},"id":{"description":"Channel unique ID","title":"ID","type":"string","x-stream-index":"001"},"last_message_at":{"description":"Date of the last message sent","format":"date-time","title":"Last message at","type":"number","x-stream-index":"004"},"member_count":{"description":"Number of members in the channel","format":"int32","title":"Member count","type":"integer","x-stream-index":"012"},"members":{"description":"List of channel members (max 100)","items":{"$ref":"#/components/schemas/ChannelMember"},"title":"ChannelMembers","type":"array","x-stream-index":"011"},"message_count":{"description":"Number of messages in the channel","format":"int64","title":"Message count","type":"integer","x-stream-index":"027"},"mute_expires_at":{"description":"Date of mute expiration","format":"date-time","title":"Mute expires at","type":"number","x-stream-index":"015"},"muted":{"description":"Whether this channel is muted or not","title":"Muted","type":"boolean","x-stream-index":"014"},"own_capabilities":{"description":"List of channel capabilities of authenticated user","items":{"$ref":"#/components/schemas/ChannelOwnCapability"},"title":"ChannelOwnCapability","type":"array","x-stream-index":"021"},"team":{"description":"Team the channel belongs to (multi-tenant only)","title":"Team","type":"string","x-stream-index":"016"},"truncated_at":{"description":"Date of the latest truncation of the channel","format":"date-time","title":"UserResponse","type":"number","x-stream-index":"024"},"truncated_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"025"},"type":{"description":"Type of the channel","title":"Type","type":"string","x-stream-docs-page-id":"channel_features","x-stream-index":"002"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"006"}},"required":["id","type","cid","created_at","updated_at","frozen","disabled","custom"],"title":"Channel","type":"object"},"Command":{"description":"Represents custom chat command","nullable":true,"properties":{"args":{"description":"Arguments help text, shown in commands auto-completion","title":"Arguments","type":"string","x-stream-index":"006"},"created_at":{"description":"Date/time of creation","format":"date-time","readOnly":true,"title":"Created at","type":"number","x-stream-index":"001"},"description":{"description":"Description, shown in commands auto-completion","title":"Description","type":"string","x-stream-index":"005"},"name":{"description":"Unique command name","title":"Name","type":"string","x-stream-index":"004"},"set":{"description":"Set name used for grouping commands","title":"Set","type":"string","x-stream-index":"007"},"updated_at":{"description":"Date/time of the last update","format":"date-time","readOnly":true,"title":"Updated at","type":"number","x-stream-index":"002"}},"required":["name","description","args","set"],"title":"Command","type":"object"},"CommentAddedEvent":{"description":"Emitted when a comment is added to an activity.","nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","x-stream-index":"002"},"comment":{"$ref":"#/components/schemas/CommentResponse","description":"The comment that was added","title":"Text","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"003.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.001.007"},"feed_visibility":{"type":"string","x-stream-index":"003.003"},"fid":{"type":"string","x-stream-index":"003.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.001.004"},"type":{"default":"feeds.comment.added","description":"The type of event: \"feeds.comment.added\" in this case","title":"Event Type","type":"string","x-stream-index":"003.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who added the comment","title":"User","x-stream-index":"004.001"}},"required":["comment","activity","type","created_at","custom","fid"],"title":"CommentAddedEvent","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"},"CommentDeletedEvent":{"description":"Emitted when a comment is deleted.","nullable":true,"properties":{"comment":{"$ref":"#/components/schemas/CommentResponse","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"type":"string","x-stream-index":"002.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.comment.deleted","description":"The type of event: \"feeds.comment.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who deleted the comment","title":"User","x-stream-index":"003.001"}},"required":["comment","type","created_at","custom","fid"],"title":"CommentDeletedEvent","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"},"CommentReactionAddedEvent":{"description":"Emitted when a reaction is added to a comment.","nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","x-stream-index":"003"},"comment":{"$ref":"#/components/schemas/CommentResponse","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"004.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004.001.007"},"feed_visibility":{"type":"string","x-stream-index":"004.003"},"fid":{"type":"string","x-stream-index":"004.002"},"reaction":{"$ref":"#/components/schemas/FeedsReactionResponse","description":"The reaction that was added","title":"Reaction","x-stream-index":"002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"004.001.004"},"type":{"default":"feeds.comment.reaction.added","description":"The type of event: \"feeds.comment.reaction.added\" in this case","title":"Event Type","type":"string","x-stream-index":"004.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who added the reaction","title":"User","x-stream-index":"005.001"}},"required":["comment","reaction","activity","type","created_at","custom","fid"],"title":"CommentReactionAddedEvent","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"},"CommentReactionDeletedEvent":{"description":"Emitted when a reaction is deleted from a comment.","nullable":true,"properties":{"comment":{"$ref":"#/components/schemas/CommentResponse","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"003.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.001.007"},"feed_visibility":{"type":"string","x-stream-index":"003.003"},"fid":{"type":"string","x-stream-index":"003.002"},"reaction":{"$ref":"#/components/schemas/FeedsReactionResponse","x-stream-index":"002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.001.004"},"type":{"default":"feeds.comment.reaction.deleted","description":"The type of reaction that was removed","title":"Type","type":"string","x-stream-index":"003.001.002"}},"required":["comment","reaction","type","created_at","custom","fid"],"title":"CommentReactionDeletedEvent","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"},"CommentReactionUpdatedEvent":{"description":"Emitted when a reaction is updated on a comment.","nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","x-stream-index":"003"},"comment":{"$ref":"#/components/schemas/CommentResponse","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"004.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004.001.007"},"feed_visibility":{"type":"string","x-stream-index":"004.003"},"fid":{"type":"string","x-stream-index":"004.002"},"reaction":{"$ref":"#/components/schemas/FeedsReactionResponse","description":"The reaction that was updated","title":"Reaction","x-stream-index":"002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"004.001.004"},"type":{"default":"feeds.comment.reaction.updated","description":"The type of event: \"feeds.comment.reaction.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"004.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who updated the reaction","title":"User","x-stream-index":"005.001"}},"required":["comment","reaction","activity","type","created_at","custom","fid"],"title":"CommentReactionUpdatedEvent","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"},"CommentResponse":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"011"},"confidence_score":{"description":"Confidence score of the comment","format":"float","title":"Confidence Score","type":"number","x-stream-index":"022"},"controversy_score":{"description":"Controversy score of the comment","format":"float","title":"Controversy Score","type":"number","x-stream-index":"023"},"created_at":{"description":"When the comment was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"014"},"custom":{"additionalProperties":{},"description":"Custom data for the comment","title":"Custom Data","type":"object","x-stream-index":"006"},"deleted_at":{"description":"When the comment was deleted","format":"date-time","title":"Deleted At","type":"number","x-stream-index":"016"},"downvote_count":{"description":"Number of downvotes for this comment","format":"int32","title":"Downvote Count","type":"integer","x-stream-index":"020"},"id":{"description":"Unique identifier for the comment","title":"ID","type":"string","x-stream-index":"001"},"latest_reactions":{"description":"Recent reactions to the comment","items":{"$ref":"#/components/schemas/FeedsReactionResponse"},"title":"Latest Reactions","type":"array","x-stream-index":"009"},"mentioned_users":{"description":"Users mentioned in the comment","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Mention Users","type":"array","x-stream-index":"012"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"017"},"object_id":{"description":"ID of the object this comment is associated with","title":"Object ID","type":"string","x-stream-index":"002"},"object_type":{"description":"Type of the object this comment is associated with","title":"Object Type","type":"string","x-stream-index":"003"},"own_reactions":{"description":"Current user's reactions to this activity","items":{"$ref":"#/components/schemas/FeedsReactionResponse"},"title":"Own Reactions","type":"array","x-stream-index":"024"},"parent_id":{"description":"ID of parent comment for nested replies","title":"Parent ID","type":"string","x-stream-index":"007"},"reaction_count":{"description":"Number of reactions to this comment","format":"int32","title":"Reaction Count","type":"integer","x-stream-index":"008"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"description":"Grouped reactions by type","title":"Reaction Groups","type":"object","x-stream-index":"010"},"reply_count":{"description":"Number of replies to this comment","format":"int32","title":"Reply Count","type":"integer","x-stream-index":"018"},"score":{"description":"Score of the comment based on reactions","format":"int32","title":"Score","type":"integer","x-stream-index":"021"},"status":{"description":"Status of the comment (e.g., active, deleted)","title":"Status","type":"string","x-stream-index":"013"},"text":{"description":"Text content of the comment","title":"Text","type":"string","x-stream-index":"005"},"updated_at":{"description":"When the comment was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"015"},"upvote_count":{"description":"Number of upvotes for this comment","format":"int32","title":"Upvote Count","type":"integer","x-stream-index":"019"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who created the comment","title":"User","x-stream-index":"004"}},"required":["id","object_id","object_type","user","reaction_count","mentioned_users","status","created_at","updated_at","reply_count","upvote_count","downvote_count","score","confidence_score","own_reactions"],"title":"Comment","type":"object"},"CommentUpdatedEvent":{"description":"Emitted when a comment is updated.","nullable":true,"properties":{"comment":{"$ref":"#/components/schemas/CommentResponse","description":"The comment that was updated","title":"Text","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"type":"string","x-stream-index":"002.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.comment.updated","description":"The type of event: \"feeds.comment.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who updated the comment","title":"User","x-stream-index":"003.001"}},"required":["comment","type","created_at","custom","fid"],"title":"CommentUpdatedEvent","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"},"CompositeAppSettings":{"properties":{"json_encoded_settings":{"type":"string","x-stream-index":"005"},"url":{"type":"string","x-stream-index":"004"}},"type":"object"},"ConfigOverrides":{"properties":{"blocklist":{"type":"string","x-stream-index":"008"},"blocklist_behavior":{"enum":["flag","block"],"type":"string","x-stream-index":"009"},"commands":{"items":{"type":"string"},"type":"array","x-stream-index":"011"},"count_messages":{"type":"boolean","x-stream-index":"014"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"010"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"007"},"quotes":{"type":"boolean","x-stream-index":"004"},"reactions":{"type":"boolean","x-stream-index":"002"},"replies":{"type":"boolean","x-stream-index":"003"},"shared_locations":{"type":"boolean","x-stream-index":"013"},"typing_events":{"type":"boolean","x-stream-index":"001"},"uploads":{"type":"boolean","x-stream-index":"005"},"url_enrichment":{"type":"boolean","x-stream-index":"006"},"user_message_reminders":{"type":"boolean","x-stream-index":"012"}},"required":["grants","commands"],"type":"object"},"ConfigResponse":{"properties":{"ai_image_config":{"$ref":"#/components/schemas/AIImageConfig","description":"Configuration for AI image analysis","title":"AI Image Config","x-stream-index":"010"},"ai_text_config":{"$ref":"#/components/schemas/AITextConfig","description":"Configuration for AI text analysis","title":"AI Text Config","x-stream-index":"008"},"ai_video_config":{"$ref":"#/components/schemas/AIVideoConfig","description":"Configuration for AI video analysis","title":"AI Video Config","x-stream-index":"011"},"async":{"description":"Whether moderation should be performed asynchronously","title":"Async","type":"boolean","x-stream-index":"003"},"automod_platform_circumvention_config":{"$ref":"#/components/schemas/AutomodPlatformCircumventionConfig","description":"Configuration for platform circumvention detection","title":"Automod Platform Circumvention Config","x-stream-index":"005"},"automod_semantic_filters_config":{"$ref":"#/components/schemas/AutomodSemanticFiltersConfig","description":"Configuration for semantic filtering","title":"Automod Semantic Filters Config","x-stream-index":"006"},"automod_toxicity_config":{"$ref":"#/components/schemas/AutomodToxicityConfig","description":"Configuration for toxicity detection","title":"Automod Toxicity Config","x-stream-index":"004"},"block_list_config":{"$ref":"#/components/schemas/BlockListConfig","description":"Configuration for block list filtering","title":"Block List Config","x-stream-index":"007"},"created_at":{"description":"When the configuration was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"013"},"key":{"description":"Unique identifier for the moderation configuration","title":"Key","type":"string","x-stream-index":"001"},"llm_config":{"$ref":"#/components/schemas/LLMConfig","description":"Configuration for customer-configured LLM moderation","title":"LLM Config","x-stream-index":"009"},"team":{"description":"Team associated with the configuration","title":"Team","type":"string","x-stream-index":"002"},"updated_at":{"description":"When the configuration was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"014"},"velocity_filter_config":{"$ref":"#/components/schemas/VelocityFilterConfig","description":"Configuration for velocity-based filtering","title":"Velocity Filter Config","x-stream-index":"012"},"video_call_rule_config":{"$ref":"#/components/schemas/VideoCallRuleConfig","x-stream-index":"015"}},"required":["key","team","async","created_at","updated_at"],"type":"object"},"ConnectUserDetailsRequest":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001"},"image":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"006"},"language":{"type":"string","x-stream-index":"005"},"name":{"type":"string","x-stream-index":"002"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"007"}},"required":["id"],"type":"object"},"ContentCountRuleParameters":{"properties":{"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"type":"object"},"CreateBlockListRequest":{"description":"Block list contains restricted words","nullable":true,"properties":{"name":{"description":"Block list name","maxLength":255,"title":"Name","type":"string","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"004"},"type":{"description":"Block list type.","enum":["regex","domain","domain_allowlist","email","word"],"title":"Type","type":"string","x-stream-index":"003"},"words":{"description":"List of words to block","items":{"type":"string"},"minimum":1,"title":"Words","type":"array","x-stream-index":"002"}},"required":["name","words"],"title":"Block list","type":"object","x-stream-docs-page-id":"block_lists"},"CreateBlockListResponse":{"description":"Basic response information","nullable":true,"properties":{"blocklist":{"$ref":"#/components/schemas/BlockListResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["duration"],"title":"Response","type":"object"},"CreateDeviceRequest":{"description":"Create device request","nullable":true,"properties":{"id":{"description":"Device ID","maxLength":255,"minLength":1,"title":"ID","type":"string","x-stream-index":"001"},"push_provider":{"description":"Push provider","enum":["firebase","apn","huawei","xiaomi"],"title":"PushProvider","type":"string","x-stream-index":"002"},"push_provider_name":{"description":"Push provider name","title":"PushProviderName","type":"string","x-stream-index":"003"},"voip_token":{"description":"When true the token is for Apple VoIP push notifications","title":"VoipToken","type":"boolean","x-stream-index":"004"}},"required":["id","push_provider"],"title":"CreateDeviceRequest","type":"object"},"CreateFeedsBatchRequest":{"nullable":true,"properties":{"feeds":{"description":"List of feeds to create","items":{"$ref":"#/components/schemas/FeedRequest"},"maximum":1000,"minimum":1,"title":"Feeds","type":"array","x-stream-index":"001"}},"required":["feeds"],"title":"Create Feeds Batch Request","type":"object"},"CreateFeedsBatchResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"feeds":{"description":"List of created feeds","items":{"$ref":"#/components/schemas/FeedResponse"},"title":"Feeds","type":"array","x-stream-index":"001"}},"required":["feeds","duration"],"title":"Create Feeds Batch Response","type":"object"},"CreateGuestRequest":{"nullable":true,"properties":{"user":{"$ref":"#/components/schemas/UserRequest","description":"User object which server acts upon","title":"User","x-stream-index":"001"}},"required":["user"],"type":"object"},"CreateGuestResponse":{"nullable":true,"properties":{"access_token":{"description":"the access token to authenticate the user","title":"Access token","type":"string","x-stream-index":"002"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User object which server acts upon","title":"User","x-stream-index":"001"}},"required":["user","access_token","duration"],"type":"object"},"CreatePollOptionRequest":{"nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"003"},"text":{"description":"Option text","title":"string","type":"string","x-stream-index":"002"}},"required":["text"],"type":"object"},"CreatePollRequest":{"description":"Contains all information needed to create a new poll","nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"011"},"allow_answers":{"description":"Indicates whether users can suggest user defined answers","title":"Allow answers","type":"boolean","x-stream-index":"009"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"008"},"description":{"description":"A description of the poll","title":"Description","type":"string","x-stream-index":"003"},"enforce_unique_vote":{"description":"Indicates whether users can cast multiple votes","title":"Multiple choice","type":"boolean","x-stream-index":"006"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"is_closed":{"description":"Indicates whether the poll is open for voting","title":"Is closed","type":"boolean","x-stream-index":"010"},"max_votes_allowed":{"description":"Indicates the maximum amount of votes a user can cast","format":"int32","maximum":10,"title":"Maximum votes allowed","type":"integer","x-stream-index":"007"},"name":{"description":"The name of the poll","title":"Name","type":"string","x-stream-index":"002"},"options":{"items":{"$ref":"#/components/schemas/PollOptionInput"},"maximum":100,"type":"array","x-stream-index":"004"},"voting_visibility":{"enum":["anonymous","public"],"type":"string","x-stream-index":"005"}},"required":["name"],"title":"Create Poll Request","type":"object"},"CustomActionRequest":{"properties":{"id":{"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"type":"object"},"Data":{"properties":{"id":{"type":"string","x-stream-index":"001"}},"required":["id"],"type":"object"},"DecayFunctionConfig":{"properties":{"base":{"type":"string","x-stream-index":"001"},"decay":{"type":"string","x-stream-index":"005"},"direction":{"type":"string","x-stream-index":"006"},"offset":{"type":"string","x-stream-index":"004"},"origin":{"type":"string","x-stream-index":"002"},"scale":{"type":"string","x-stream-index":"003"}},"type":"object"},"DeleteActivitiesRequest":{"nullable":true,"properties":{"hard_delete":{"description":"Whether to permanently delete the activities","title":"Hard Delete","type":"boolean","x-stream-index":"002"},"ids":{"description":"List of activity IDs to delete","items":{"type":"string"},"minimum":1,"title":"Activity IDs","type":"array","x-stream-index":"001"}},"required":["ids"],"title":"Delete Activities Request","type":"object"},"DeleteActivitiesResponse":{"nullable":true,"properties":{"deleted_ids":{"description":"List of activity IDs that were successfully deleted","items":{"type":"string"},"title":"Deleted Activity IDs","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["deleted_ids","duration"],"title":"Delete Activities Response","type":"object"},"DeleteActivityReactionResponse":{"nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"reaction":{"$ref":"#/components/schemas/FeedsReactionResponse","x-stream-index":"002"}},"required":["activity","reaction","duration"],"title":"Delete Activity Reaction Response","type":"object"},"DeleteActivityRequest":{"properties":{"hard_delete":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"DeleteActivityResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"Delete Activity Response","type":"object"},"DeleteBookmarkFolderResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"Delete Bookmark Folder Response","type":"object"},"DeleteBookmarkResponse":{"nullable":true,"properties":{"bookmark":{"$ref":"#/components/schemas/BookmarkResponse","description":"The deleted bookmark","title":"Bookmark","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["bookmark","duration"],"title":"Delete Bookmark Response","type":"object"},"DeleteCommentReactionResponse":{"nullable":true,"properties":{"comment":{"$ref":"#/components/schemas/CommentResponse","description":"The comment after reaction removal","title":"Comment","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"reaction":{"$ref":"#/components/schemas/FeedsReactionResponse","description":"The removed reaction","title":"Reaction","x-stream-index":"002"}},"required":["comment","reaction","duration"],"title":"Delete Comment Reaction Response","type":"object"},"DeleteCommentResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"Delete Comment Response","type":"object"},"DeleteFeedResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"Delete Feed Response","type":"object"},"DeleteMessageRequest":{"properties":{"hard_delete":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"DeleteModerationConfigResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"DeleteReactionRequest":{"properties":{"hard_delete":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"DeleteUserRequest":{"properties":{"delete_conversation_channels":{"type":"boolean","x-stream-index":"003"},"delete_feeds_content":{"type":"boolean","x-stream-index":"004"},"hard_delete":{"type":"boolean","x-stream-index":"001"},"mark_messages_deleted":{"type":"boolean","x-stream-index":"002"}},"type":"object"},"Device":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"disabled":{"type":"boolean","x-stream-index":"002.003"},"disabled_reason":{"type":"string","x-stream-index":"002.004"},"id":{"type":"string","x-stream-index":"002.001.004"},"push_provider":{"enum":["firebase","apn","huawei","xiaomi"],"type":"string","x-stream-index":"002.001.001"},"push_provider_name":{"type":"string","x-stream-index":"002.001.003"},"user_id":{"type":"string","x-stream-index":"004"},"voip":{"type":"boolean","x-stream-index":"002.001.005"}},"required":["push_provider","id","created_at","user_id"],"type":"object"},"DeviceResponse":{"description":"Response for Device","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"004"},"disabled":{"description":"Whether device is disabled or not","title":"Disabled","type":"boolean","x-stream-index":"005"},"disabled_reason":{"description":"Reason explaining why device had been disabled","title":"Reason","type":"string","x-stream-index":"006"},"id":{"description":"Device ID","title":"ID","type":"string","x-stream-index":"003"},"push_provider":{"description":"Push provider","title":"PushProvider","type":"string","x-stream-index":"001"},"push_provider_name":{"description":"Push provider name","title":"PushProviderName","type":"string","x-stream-index":"002"},"user_id":{"description":"User ID","title":"UserID","type":"string","x-stream-index":"008"},"voip":{"description":"When true the token is for Apple VoIP push notifications","title":"Voip","type":"boolean","x-stream-index":"007"}},"required":["push_provider","id","created_at","user_id"],"title":"DeviceResponse","type":"object"},"DraftPayloadResponse":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"html":{"type":"string","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"001"},"mentioned_users":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"008"},"mml":{"type":"string","x-stream-index":"003"},"parent_id":{"type":"string","x-stream-index":"005"},"poll_id":{"type":"string","x-stream-index":"013"},"quoted_message_id":{"type":"string","x-stream-index":"009"},"show_in_channel":{"type":"boolean","x-stream-index":"006"},"silent":{"type":"boolean","x-stream-index":"012"},"text":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"011"}},"required":["id","text","custom"],"type":"object"},"DraftResponse":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003"},"channel_cid":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"message":{"$ref":"#/components/schemas/DraftPayloadResponse","x-stream-index":"001"},"parent_id":{"type":"string","x-stream-index":"004"},"parent_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"005"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"006"}},"required":["message","channel_cid","created_at"],"type":"object"},"EgressHLSResponse":{"properties":{"playlist_url":{"type":"string","x-stream-index":"001"},"status":{"type":"string","x-stream-index":"002"}},"required":["playlist_url","status"],"type":"object"},"EgressRTMPResponse":{"properties":{"name":{"type":"string","x-stream-index":"001"},"started_at":{"format":"date-time","type":"number","x-stream-index":"004"},"stream_key":{"type":"string","x-stream-index":"003"},"stream_url":{"type":"string","x-stream-index":"002"}},"required":["name","started_at"],"type":"object"},"EgressResponse":{"properties":{"broadcasting":{"type":"boolean","x-stream-index":"001"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordingResponse","x-stream-index":"004"},"hls":{"$ref":"#/components/schemas/EgressHLSResponse","x-stream-index":"002"},"rtmps":{"items":{"$ref":"#/components/schemas/EgressRTMPResponse"},"type":"array","x-stream-index":"003"}},"required":["broadcasting","rtmps"],"type":"object"},"EgressTaskConfig":{"properties":{"egress_user":{"$ref":"#/components/schemas/EgressUser","x-stream-index":"008"},"frame_recording_egress_config":{"$ref":"#/components/schemas/FrameRecordingEgressConfig","x-stream-index":"009"},"hls_egress_config":{"$ref":"#/components/schemas/HLSEgressConfig","x-stream-index":"007"},"recording_egress_config":{"$ref":"#/components/schemas/RecordingEgressConfig","x-stream-index":"006"},"rtmp_egress_config":{"$ref":"#/components/schemas/RTMPEgressConfig","x-stream-index":"004"},"stt_egress_config":{"$ref":"#/components/schemas/STTEgressConfig","x-stream-index":"005"}},"type":"object"},"EgressUser":{"properties":{"token":{"type":"string","x-stream-index":"004"}},"type":"object"},"EnrichedActivity":{"properties":{"actor":{"$ref":"#/components/schemas/Data","x-stream-index":"002"},"foreign_id":{"type":"string","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"latest_reactions":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"013"},"object":{"$ref":"#/components/schemas/Data","x-stream-index":"004"},"origin":{"$ref":"#/components/schemas/Data","x-stream-index":"008"},"own_reactions":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"012"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"011"},"score":{"format":"float","type":"number","x-stream-index":"010"},"target":{"$ref":"#/components/schemas/Data","x-stream-index":"006"},"to":{"items":{"type":"string"},"type":"array","x-stream-index":"009"},"verb":{"type":"string","x-stream-index":"003"}},"type":"object"},"EnrichedReaction":{"nullable":true,"properties":{"activity_id":{"type":"string","x-stream-index":"003"},"children_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"010"},"created_at":{"$ref":"#/components/schemas/Time","x-stream-index":"012"},"data":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"kind":{"type":"string","x-stream-index":"002"},"latest_children":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"008"},"own_children":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"009"},"parent":{"type":"string","x-stream-index":"007"},"target_feeds":{"items":{"type":"string"},"type":"array","x-stream-index":"006"},"updated_at":{"$ref":"#/components/schemas/Time","x-stream-index":"013"},"user":{"$ref":"#/components/schemas/Data","x-stream-index":"011"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["kind","activity_id","user_id"],"type":"object"},"EntityCreator":{"properties":{"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"001.046"},"ban_count":{"format":"int32","type":"integer","x-stream-index":"002"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"001.017"},"banned":{"type":"boolean","x-stream-index":"001.016"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.013"},"deleted_content_count":{"format":"int32","type":"integer","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"001.023"},"language":{"type":"string","x-stream-index":"001.035"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"001.022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"001.026"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.042"},"role":{"type":"string","x-stream-index":"001.004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.005"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.009"}},"required":["id","role","teams_role","custom","banned","online","ban_count","deleted_content_count"],"type":"object"},"EntityCreatorResponse":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.001.018"},"ban_count":{"description":"Number of minor actions performed on the user","format":"int32","title":"Ban Count","type":"integer","x-stream-index":"002"},"banned":{"type":"boolean","x-stream-index":"001.001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.001.017"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.001.016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.001.011"},"deleted_content_count":{"description":"Number of major actions performed on the user","format":"int32","title":"Deleted Content Count","type":"integer","x-stream-index":"003"},"flagged_count":{"description":"Number of flag actions performed on the user","format":"int32","title":"Flagged Count","type":"integer","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001.001.001"},"image":{"type":"string","x-stream-index":"001.001.003"},"language":{"type":"string","x-stream-index":"001.001.005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"001.001.014"},"name":{"type":"string","x-stream-index":"001.001.002"},"online":{"type":"boolean","x-stream-index":"001.001.013"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.001.015"},"role":{"type":"string","x-stream-index":"001.001.006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.001.008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids","shadow_banned","invisible","ban_count","deleted_content_count","flagged_count"],"type":"object"},"EventNotificationSettings":{"properties":{"apns":{"$ref":"#/components/schemas/APNS","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"fcm":{"$ref":"#/components/schemas/FCM","x-stream-index":"003"}},"required":["enabled","apns","fcm"],"type":"object"},"ExternalStorage":{"properties":{"abs_account_name":{"type":"string","x-stream-index":"011"},"abs_client_id":{"type":"string","x-stream-index":"013"},"abs_client_secret":{"type":"string","x-stream-index":"014"},"abs_tenant_id":{"type":"string","x-stream-index":"012"},"bucket":{"type":"string","x-stream-index":"005"},"gcs_credentials":{"type":"string","x-stream-index":"010"},"path":{"type":"string","x-stream-index":"006"},"s3_api_key":{"type":"string","x-stream-index":"007"},"s3_custom_endpoint":{"type":"string","x-stream-index":"016"},"s3_region":{"type":"string","x-stream-index":"009"},"s3_secret_key":{"type":"string","x-stream-index":"008"},"storage_name":{"type":"string","x-stream-index":"015"},"storage_type":{"type":"integer","x-stream-index":"004"}},"type":"object"},"FCM":{"properties":{"data":{"additionalProperties":{},"type":"object","x-stream-index":"001"}},"type":"object"},"FeedCreatedEvent":{"description":"Emitted when a feed is created.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"003.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.001.007"},"feed":{"$ref":"#/components/schemas/FeedResponse","description":"The feed that was created","title":"Feed","x-stream-index":"001"},"feed_visibility":{"type":"string","x-stream-index":"003.003"},"fid":{"type":"string","x-stream-index":"003.002"},"members":{"items":{"$ref":"#/components/schemas/FeedMemberResponse"},"type":"array","x-stream-index":"002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.001.004"},"type":{"default":"feeds.feed.created","description":"The type of event: \"feeds.feed.created\" in this case","title":"Event Type","type":"string","x-stream-index":"003.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who created the feed","title":"User","x-stream-index":"004.001"}},"required":["feed","members","type","created_at","custom","fid","user"],"title":"FeedCreatedEvent","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"},"FeedDeletedEvent":{"description":"Emitted when a feed is deleted.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.007"},"feed_visibility":{"type":"string","x-stream-index":"001.003"},"fid":{"type":"string","x-stream-index":"001.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"type":{"default":"feeds.feed.deleted","description":"The type of event: \"feeds.feed.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who deleted the feed","title":"User","x-stream-index":"002.001"}},"required":["type","created_at","custom","fid"],"title":"FeedDeletedEvent","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"},"FeedGroup":{"properties":{"ActivityProcessors":{"items":{"$ref":"#/components/schemas/ActivityProcessorConfig"},"type":"array","writeOnly":true,"x-stream-index":"012"},"ActivitySelectors":{"items":{"$ref":"#/components/schemas/ActivitySelectorConfig"},"type":"array","writeOnly":true,"x-stream-index":"013"},"Aggregation":{"$ref":"#/components/schemas/AggregationConfig","x-stream-index":"015"},"AggregationVersion":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"016"},"AppPK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"002"},"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"007"},"DefaultVisibility":{"type":"string","writeOnly":true,"x-stream-index":"006"},"DeletedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"010"},"ID":{"type":"string","writeOnly":true,"x-stream-index":"003"},"LastFeedGetAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"017"},"Notification":{"$ref":"#/components/schemas/NotificationConfig","x-stream-index":"004"},"PushNotification":{"$ref":"#/components/schemas/PushNotificationConfig","x-stream-index":"005"},"Ranking":{"$ref":"#/components/schemas/RankingConfig","x-stream-index":"014"},"Stories":{"$ref":"#/components/schemas/StoriesConfig","x-stream-index":"011"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"}},"required":["AppPK","ID","DefaultVisibility","Custom","created_at","updated_at","ActivityProcessors","ActivitySelectors","AggregationVersion"],"type":"object"},"FeedGroupChangedEvent":{"description":"Emitted when a feed group is changed.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.007"},"feed_group":{"$ref":"#/components/schemas/FeedGroup","description":"The feed group that was changed","title":"Feed Type","x-stream-index":"003"},"feed_visibility":{"type":"string","x-stream-index":"001.003"},"fid":{"type":"string","x-stream-index":"001.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"type":{"default":"feeds.feed_group.changed","description":"The type of event: \"feeds.feed_group.changed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who changed the feed group","title":"User","x-stream-index":"002.001"}},"required":["type","created_at","custom","fid"],"title":"FeedGroupChangedEvent","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"},"FeedGroupDeletedEvent":{"description":"Emitted when a feed group is deleted.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"type":"string","x-stream-index":"002.002"},"group_id":{"description":"The ID of the feed group that was deleted","title":"Group ID","type":"string","x-stream-index":"001"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.feed_group.deleted","description":"The type of event: \"feeds.feed_group.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"}},"required":["group_id","type","created_at","custom","fid"],"title":"FeedGroupDeletedEvent","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"},"FeedInput":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"description":{"maxLength":1000,"type":"string","x-stream-index":"002"},"filter_tags":{"items":{"type":"string"},"maximum":255,"type":"array","x-stream-index":"005"},"members":{"items":{"$ref":"#/components/schemas/FeedMemberRequest"},"type":"array","x-stream-index":"006"},"name":{"maxLength":255,"type":"string","x-stream-index":"001"},"visibility":{"enum":["public","visible","followers","members","private"],"type":"string","x-stream-index":"003"}},"type":"object"},"FeedMemberAddedEvent":{"description":"Emitted when a feed member is added.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"003.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.001.007"},"feed_visibility":{"type":"string","x-stream-index":"003.003"},"fid":{"type":"string","x-stream-index":"003.002"},"member":{"$ref":"#/components/schemas/FeedMemberResponse","description":"The member that was added","title":"Member","x-stream-index":"001"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.001.004"},"type":{"default":"feeds.feed_member.added","description":"The type of event: \"feeds.feed_member.added\" in this case","title":"Event Type","type":"string","x-stream-index":"003.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who added the member","title":"User","x-stream-index":"002.001"}},"required":["member","type","created_at","custom","fid"],"title":"FeedMemberAddedEvent","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"},"FeedMemberRemovedEvent":{"description":"Emitted when a feed member is removed.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"003.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.001.007"},"feed_visibility":{"type":"string","x-stream-index":"003.003"},"fid":{"type":"string","x-stream-index":"003.002"},"member_id":{"type":"string","x-stream-index":"001"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.001.004"},"type":{"default":"feeds.feed_member.removed","description":"The type of event: \"feeds.feed_member.removed\" in this case","title":"Event Type","type":"string","x-stream-index":"003.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who removed the member","title":"User","x-stream-index":"002.001"}},"required":["member_id","type","created_at","custom","fid"],"title":"FeedMemberRemovedEvent","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"},"FeedMemberRequest":{"properties":{"custom":{"additionalProperties":{},"description":"Custom data for the member","title":"Custom Data","type":"object","x-stream-index":"004"},"invite":{"description":"Whether this is an invite to become a member","title":"Invite","type":"boolean","x-stream-index":"005"},"membership_level":{"description":"ID of the membership level to assign to the member","maxLength":255,"title":"Membership Level","type":"string","x-stream-index":"003"},"role":{"description":"Role of the member in the feed","maxLength":255,"title":"Role","type":"string","x-stream-index":"002"},"user_id":{"description":"ID of the user to add as a member","maxLength":255,"title":"User ID","type":"string","x-stream-index":"001"}},"required":["user_id"],"title":"Feed Member Payload","type":"object"},"FeedMemberResponse":{"properties":{"created_at":{"description":"When the membership was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"description":"Custom data for the membership","title":"Custom Data","type":"object","x-stream-index":"007"},"invite_accepted_at":{"description":"When the invite was accepted","format":"date-time","title":"Invite Accepted At","type":"number","x-stream-index":"005"},"invite_rejected_at":{"description":"When the invite was rejected","format":"date-time","title":"Invite Rejected At","type":"number","x-stream-index":"006"},"membership_level":{"$ref":"#/components/schemas/MembershipLevelResponse","description":"Membership level assigned to the member","title":"Membership Level","x-stream-index":"004"},"role":{"description":"Role of the member in the feed","title":"Role","type":"string","x-stream-index":"002"},"status":{"description":"Status of the membership","enum":["member","pending","rejected"],"title":"Status","type":"string","x-stream-index":"003"},"updated_at":{"description":"When the membership was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who is a member","title":"User","x-stream-index":"001"}},"required":["user","role","status","created_at","updated_at"],"title":"Feed Member","type":"object"},"FeedMemberUpdatedEvent":{"description":"Emitted when a feed member is updated.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"003.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.001.007"},"feed_visibility":{"type":"string","x-stream-index":"003.003"},"fid":{"type":"string","x-stream-index":"003.002"},"member":{"$ref":"#/components/schemas/FeedMemberResponse","description":"The member that was updated","title":"Member","x-stream-index":"001"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.001.004"},"type":{"default":"feeds.feed_member.updated","description":"The type of event: \"feeds.feed_member.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"003.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who updated the member","title":"User","x-stream-index":"002.001"}},"required":["member","type","created_at","custom","fid"],"title":"FeedMemberUpdatedEvent","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"},"FeedOwnCapability":{"description":"All possibility of string to use","enum":["add-activity","add-activity-reaction","add-comment","add-comment-reaction","bookmark-activity","create-feed","delete-bookmark","delete-comment","delete-feed","edit-bookmark","follow","invite-feed","join-feed","leave-feed","manage-feed-group","mark-activity","pin-activity","query-feed-members","query-follows","read-activities","read-feed","remove-activity","remove-activity-reaction","remove-comment-reaction","unfollow","update-activity","update-comment","update-feed","update-feed-followers","update-feed-members"],"title":"FeedOwnCapability","type":"string"},"FeedRequest":{"properties":{"created_by_id":{"description":"ID of the feed creator","title":"Created By ID","type":"string","x-stream-index":"003"},"custom":{"additionalProperties":{},"description":"Custom data for the feed","title":"Custom Data","type":"object","x-stream-index":"004.004"},"description":{"description":"Description of the feed","maxLength":1000,"title":"Description","type":"string","x-stream-index":"004.002"},"feed_group_id":{"description":"ID of the feed group","maxLength":255,"title":"Feed Group ID","type":"string","x-stream-index":"001"},"feed_id":{"description":"ID of the feed","maxLength":255,"title":"Feed ID","type":"string","x-stream-index":"002"},"filter_tags":{"description":"Tags used for filtering feeds","items":{"type":"string"},"maximum":255,"title":"Filter Tags","type":"array","x-stream-index":"004.005"},"members":{"description":"Initial members for the feed","items":{"$ref":"#/components/schemas/FeedMemberRequest"},"title":"Members","type":"array","x-stream-index":"004.006"},"name":{"description":"Name of the feed","maxLength":255,"title":"Name","type":"string","x-stream-index":"004.001"},"visibility":{"description":"Visibility setting for the feed","enum":["public","visible","followers","members","private"],"title":"Visibility","type":"string","x-stream-index":"004.003"}},"required":["feed_group_id","feed_id"],"title":"Feed Payload","type":"object"},"FeedResponse":{"properties":{"created_at":{"description":"When the feed was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"015"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"User who created the feed","title":"Created By","x-stream-index":"009"},"custom":{"additionalProperties":{},"description":"Custom data for the feed","title":"Custom Data","type":"object","x-stream-index":"006"},"deleted_at":{"description":"When the feed was deleted","format":"date-time","title":"Deleted At","type":"number","x-stream-index":"017"},"description":{"description":"Description of the feed","title":"Description","type":"string","x-stream-index":"005"},"feed":{"description":"Fully qualified feed ID (group_id:id)","title":"FID","type":"string","x-stream-index":"003"},"filter_tags":{"description":"Tags used for filtering feeds","items":{"type":"string"},"title":"Filter Tags","type":"array","x-stream-index":"007"},"follower_count":{"description":"Number of followers of this feed","format":"int32","title":"Follower Count","type":"integer","x-stream-index":"011"},"following_count":{"description":"Number of feeds this feed follows","format":"int32","title":"Following Count","type":"integer","x-stream-index":"012"},"group_id":{"description":"Group this feed belongs to","title":"Group ID","type":"string","x-stream-index":"001"},"id":{"description":"Unique identifier for the feed","title":"ID","type":"string","x-stream-index":"002"},"member_count":{"description":"Number of members in this feed","format":"int32","title":"Member Count","type":"integer","x-stream-index":"010"},"name":{"description":"Name of the feed","title":"Name","type":"string","x-stream-index":"004"},"own_follows":{"description":"Follow relationships where the current user's feeds are following this feed","items":{"$ref":"#/components/schemas/FollowResponse"},"title":"Own Follows","type":"array","x-stream-index":"014"},"pin_count":{"description":"Number of pinned activities in this feed","format":"int32","title":"Pin Count","type":"integer","x-stream-index":"013"},"updated_at":{"description":"When the feed was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"016"},"visibility":{"description":"Visibility setting for the feed","title":"Visibility","type":"string","x-stream-index":"008"}},"required":["group_id","id","feed","name","description","created_by","member_count","follower_count","following_count","pin_count","created_at","updated_at"],"title":"Feed","type":"object"},"FeedUpdatedEvent":{"description":"Emitted when a feed is created.","nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed":{"$ref":"#/components/schemas/FeedResponse","description":"The feed that was created","title":"Feed","x-stream-index":"001"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"type":"string","x-stream-index":"002.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.feed.updated","description":"The type of event: \"feeds.feed.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who created the feed","title":"User","x-stream-index":"003.001"}},"required":["feed","type","created_at","custom","fid"],"title":"FeedUpdatedEvent","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"},"FeedsEventPreferences":{"properties":{"comments":{"type":"string","x-stream-index":"002"},"mentions":{"type":"string","x-stream-index":"004"},"new_followers":{"type":"string","x-stream-index":"003"},"reactions":{"type":"string","x-stream-index":"001"}},"type":"object"},"FeedsReactionResponse":{"properties":{"activity_id":{"description":"ID of the activity that was reacted to","title":"Activity ID","type":"string","x-stream-index":"002"},"comment_id":{"description":"ID of the comment that was reacted to","title":"Comment ID","type":"string","x-stream-index":"003"},"created_at":{"description":"When the reaction was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"006"},"custom":{"additionalProperties":{},"description":"Custom data for the reaction","title":"Custom Data","type":"object","x-stream-index":"005"},"type":{"description":"Type of reaction","title":"Type","type":"string","x-stream-index":"004"},"updated_at":{"description":"When the reaction was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"007"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who created the reaction","title":"User","x-stream-index":"001"}},"required":["user","activity_id","type","created_at","updated_at"],"title":"Activity Reaction","type":"object"},"Field":{"nullable":true,"properties":{"short":{"type":"boolean","x-stream-index":"003"},"title":{"type":"string","x-stream-index":"001"},"value":{"type":"string","x-stream-index":"002"}},"required":["title","value","short"],"type":"object"},"FileUploadConfig":{"properties":{"allowed_file_extensions":{"items":{"type":"string"},"type":"array","x-stream-index":"001"},"allowed_mime_types":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"blocked_file_extensions":{"items":{"type":"string"},"type":"array","x-stream-index":"002"},"blocked_mime_types":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"size_limit":{"format":"int32","maximum":104857600,"minimum":0,"type":"integer","x-stream-index":"005"}},"required":["allowed_file_extensions","blocked_file_extensions","allowed_mime_types","blocked_mime_types","size_limit"],"type":"object"},"FileUploadRequest":{"nullable":true,"properties":{"file":{"description":"file field","title":"File","type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/OnlyUserID","description":"user for the request **server side only**","title":"User","x-stream-index":"002"}},"type":"object"},"FileUploadResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"file":{"description":"URL to the uploaded asset. Should be used to put to `asset_url` attachment field","title":"File","type":"string","x-stream-index":"001"},"thumb_url":{"description":"URL of the file thumbnail for supported file formats. Should be put to `thumb_url` attachment field","title":"Thumbnail URL","type":"string","x-stream-index":"002"}},"required":["duration"],"type":"object"},"Flag":{"description":"Contains information about flagged user or message","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"019"},"custom":{"additionalProperties":{},"description":"Additional metadata about the flag","title":"Custom","type":"object","x-stream-index":"014"},"entity_creator_id":{"description":"ID of the user who created the flagged entity","title":"Entity Creator ID","type":"string","x-stream-index":"009"},"entity_id":{"description":"Unique identifier of the entity being flagged","title":"Entity ID","type":"string","x-stream-index":"008"},"entity_type":{"description":"Type of entity being flagged (e.g., message, user)","title":"Entity Type","type":"string","x-stream-index":"007"},"is_streamed_content":{"type":"boolean","x-stream-index":"012"},"labels":{"description":"Labels from bodyguard, API calls, our own AI etc","items":{"type":"string"},"title":"Labels","type":"array","x-stream-index":"015"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content being flagged","title":"Moderation Payload","x-stream-index":"010"},"moderation_payload_hash":{"type":"string","x-stream-index":"011"},"reason":{"description":"Optional explanation for why the content is being flagged","title":"Reason","type":"string","x-stream-index":"013"},"result":{"description":"Result of bodyguard, API calls, our own AI etc","items":{"additionalProperties":{},"type":"object"},"title":"Result","type":"array","x-stream-index":"016"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"018"},"review_queue_item_id":{"description":"ID of the review queue item","title":"Review Queue Item ID","type":"string","x-stream-index":"017"},"type":{"type":"string","x-stream-index":"004"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"020"},"user":{"$ref":"#/components/schemas/User","description":"User who flagged a message or a user","title":"User","x-stream-index":"006"}},"required":["entity_type","entity_id","result","created_at","updated_at"],"title":"Flag","type":"object"},"FlagContentOptions":{"properties":{"reason":{"type":"string","x-stream-index":"001"}},"type":"object"},"FlagRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"description":"Additional metadata about the flag","title":"Custom","type":"object","x-stream-index":"006"},"entity_creator_id":{"description":"ID of the user who created the flagged entity","title":"Entity Creator ID","type":"string","x-stream-index":"003"},"entity_id":{"description":"Unique identifier of the entity being flagged","title":"Entity ID","type":"string","x-stream-index":"002"},"entity_type":{"description":"Type of entity being flagged (e.g., message, user)","title":"Entity Type","type":"string","x-stream-index":"001"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content being flagged","title":"Moderation Payload","x-stream-index":"005"},"reason":{"description":"Optional explanation for why the content is being flagged","maxLength":255,"title":"Reason","type":"string","x-stream-index":"004"}},"required":["entity_type","entity_id"],"type":"object"},"FlagResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"item_id":{"description":"Unique identifier of the created moderation item","title":"Item ID","type":"string","x-stream-index":"001"}},"required":["item_id","duration"],"type":"object"},"FlagUserOptions":{"properties":{"reason":{"type":"string","x-stream-index":"001"}},"type":"object"},"FollowBatchRequest":{"nullable":true,"properties":{"follows":{"description":"List of follow relationships to create","items":{"$ref":"#/components/schemas/FollowRequest"},"maximum":1000,"minimum":1,"title":"Follows","type":"array","x-stream-index":"001"}},"required":["follows"],"title":"Follow Batch Request","type":"object"},"FollowBatchResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"follows":{"description":"List of created follow relationships","items":{"$ref":"#/components/schemas/FollowResponse"},"title":"Follows","type":"array","x-stream-index":"001"}},"required":["follows","duration"],"title":"Follow Batch Response","type":"object"},"FollowCreatedEvent":{"description":"Emitted when a feed follows another feed.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"type":"string","x-stream-index":"002.002"},"follow":{"$ref":"#/components/schemas/FollowResponse","x-stream-index":"001"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.follow.created","description":"The type of event: \"feeds.follow.created\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"}},"required":["follow","type","created_at","custom","fid"],"title":"FollowCreatedEvent","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"},"FollowDeletedEvent":{"description":"Emitted when a feed unfollows another feed.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"type":"string","x-stream-index":"002.002"},"follow":{"$ref":"#/components/schemas/FollowResponse","x-stream-index":"001"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.follow.deleted","description":"The type of event: \"feeds.follow.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"}},"required":["follow","type","created_at","custom","fid"],"title":"FollowDeletedEvent","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"},"FollowRequest":{"nullable":true,"properties":{"create_notification_activity":{"description":"Whether to create a notification activity for this follow","title":"Create Notification Activity","type":"boolean","x-stream-index":"004"},"custom":{"additionalProperties":{},"description":"Custom data for the follow relationship","title":"Custom Data","type":"object","x-stream-index":"002"},"push_preference":{"description":"Push preference for the follow relationship","enum":["all","none"],"title":"Push Preference","type":"string","x-stream-index":"003"},"skip_push":{"type":"boolean","x-stream-index":"005"},"source":{"description":"Fully qualified ID of the source feed","maxLength":255,"title":"Source Feed","type":"string","x-stream-index":"001.001"},"target":{"description":"Fully qualified ID of the target feed","maxLength":255,"title":"Target Feed","type":"string","x-stream-index":"001.002"}},"required":["source","target"],"title":"Follow Request","type":"object"},"FollowResponse":{"properties":{"created_at":{"description":"When the follow relationship was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"009"},"custom":{"additionalProperties":{},"description":"Custom data for the follow relationship","title":"Custom Data","type":"object","x-stream-index":"004"},"follower_role":{"description":"Role of the follower (source user) in the follow relationship","title":"Follower Role","type":"string","x-stream-index":"008"},"push_preference":{"description":"Push preference for notifications","enum":["all","none"],"title":"Push Preference","type":"string","x-stream-index":"003"},"request_accepted_at":{"description":"When the follow request was accepted","format":"date-time","title":"Request Accepted At","type":"number","x-stream-index":"005"},"request_rejected_at":{"description":"When the follow request was rejected","format":"date-time","title":"Request Rejected At","type":"number","x-stream-index":"006"},"source_feed":{"$ref":"#/components/schemas/FeedResponse","description":"Source feed object","title":"Source Feed","x-stream-index":"001"},"status":{"description":"Status of the follow relationship","enum":["accepted","pending","rejected"],"title":"Status","type":"string","x-stream-index":"007"},"target_feed":{"$ref":"#/components/schemas/FeedResponse","description":"Target feed object","title":"Target Feed","x-stream-index":"002"},"updated_at":{"description":"When the follow relationship was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"010"}},"required":["source_feed","target_feed","push_preference","status","follower_role","created_at","updated_at"],"title":"Follow","type":"object"},"FollowUpdatedEvent":{"description":"Emitted when a follow relationship is updated.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"type":"string","x-stream-index":"002.002"},"follow":{"$ref":"#/components/schemas/FollowResponse","x-stream-index":"001"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.follow.updated","description":"The type of event: \"feeds.follow.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"}},"required":["follow","type","created_at","custom","fid"],"title":"FollowUpdatedEvent","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"},"FrameRecordSettings":{"properties":{"capture_interval_in_seconds":{"format":"int32","maximum":60,"minimum":2,"type":"integer","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"},"quality":{"type":"string","x-stream-index":"002"}},"required":["mode","capture_interval_in_seconds"],"type":"object"},"FrameRecordingEgressConfig":{"properties":{"capture_interval_in_seconds":{"format":"int32","type":"integer","x-stream-index":"007"},"external_storage":{"$ref":"#/components/schemas/ExternalStorage","x-stream-index":"006"},"quality":{"$ref":"#/components/schemas/Quality","x-stream-index":"004"},"storage_name":{"type":"string","x-stream-index":"005"}},"type":"object"},"FrameRecordingResponse":{"properties":{"status":{"type":"string","x-stream-index":"001"}},"required":["status"],"type":"object"},"FrameRecordingSettingsResponse":{"properties":{"capture_interval_in_seconds":{"format":"int32","maximum":60,"minimum":2,"type":"integer","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"},"quality":{"type":"string","x-stream-index":"002"}},"required":["mode","capture_interval_in_seconds"],"type":"object"},"FullUserResponse":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"015"},"banned":{"type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"014"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.011"},"devices":{"items":{"$ref":"#/components/schemas/DeviceResponse"},"type":"array","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001.001"},"image":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"005"},"language":{"type":"string","x-stream-index":"001.005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"001.014"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"012"},"mutes":{"items":{"$ref":"#/components/schemas/UserMuteResponse"},"type":"array","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"001.002"},"online":{"type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"003"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.015"},"role":{"type":"string","x-stream-index":"001.006"},"shadow_banned":{"type":"boolean","x-stream-index":"013"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"009"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"010"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"008"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"011"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","devices","invisible","mutes","channel_mutes","unread_count","total_unread_count","unread_channels","unread_threads","shadow_banned","blocked_user_ids"],"type":"object"},"GeofenceSettings":{"properties":{"names":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"required":["names"],"type":"object"},"GeofenceSettingsResponse":{"properties":{"names":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"required":["names"],"type":"object"},"GetActivityResponse":{"nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","description":"The requested activity","title":"Activity","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["activity","duration"],"title":"Get Activity Response","type":"object"},"GetApplicationResponse":{"description":"Basic response information","nullable":true,"properties":{"app":{"$ref":"#/components/schemas/AppResponseFields","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["app","duration"],"title":"Response","type":"object"},"GetBlockedUsersResponse":{"nullable":true,"properties":{"blocks":{"description":"Array of blocked user object","items":{"$ref":"#/components/schemas/BlockedUserResponse"},"title":"Blocks","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["blocks","duration"],"type":"object"},"GetCommentRepliesResponse":{"nullable":true,"properties":{"comments":{"description":"Threaded listing of replies to the comment","items":{"$ref":"#/components/schemas/ThreadedCommentResponse"},"title":"Comments","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["comments","duration"],"title":"Get Comment Replies Response","type":"object"},"GetCommentResponse":{"nullable":true,"properties":{"comment":{"$ref":"#/components/schemas/CommentResponse","description":"Comment","title":"Comment","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["comment","duration"],"title":"Get Comment Response","type":"object"},"GetCommentsResponse":{"nullable":true,"properties":{"comments":{"description":"Threaded listing for the activity","items":{"$ref":"#/components/schemas/ThreadedCommentResponse"},"title":"Comments","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["comments","duration"],"title":"Get Comments Response","type":"object"},"GetConfigResponse":{"nullable":true,"properties":{"config":{"$ref":"#/components/schemas/ConfigResponse","description":"The retrieved moderation configuration","title":"Config","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["duration"],"type":"object"},"GetFollowSuggestionsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"suggestions":{"description":"List of suggested feeds to follow","items":{"$ref":"#/components/schemas/FeedResponse"},"title":"Suggestions","type":"array","x-stream-index":"001"}},"required":["suggestions","duration"],"title":"Follow Suggestions Response","type":"object"},"GetOGResponse":{"nullable":true,"properties":{"actions":{"items":{"$ref":"#/components/schemas/Action"},"type":"array","x-stream-index":"001.015"},"asset_url":{"description":"URL of detected video or audio","title":"Image URL","type":"string","x-stream-index":"001.017"},"author_icon":{"type":"string","x-stream-index":"001.007"},"author_link":{"description":"og:site","title":"Author Link","type":"string","x-stream-index":"001.006"},"author_name":{"description":"og:site_name","title":"Author Name","type":"string","x-stream-index":"001.005"},"color":{"type":"string","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.018"},"duration":{"type":"string","x-stream-index":"002.001"},"fallback":{"type":"string","x-stream-index":"001.002"},"fields":{"items":{"$ref":"#/components/schemas/Field"},"type":"array","x-stream-index":"001.016"},"footer":{"type":"string","x-stream-index":"001.013"},"footer_icon":{"type":"string","x-stream-index":"001.014"},"giphy":{"$ref":"#/components/schemas/Images","x-stream-index":"001.019"},"image_url":{"description":"URL of detected image","title":"Image URL","type":"string","x-stream-index":"001.011"},"og_scrape_url":{"description":"extracted url from the text","title":"OG Scrape URL","type":"string","x-stream-index":"001.020"},"original_height":{"format":"int32","type":"integer","x-stream-index":"001.022"},"original_width":{"format":"int32","type":"integer","x-stream-index":"001.021"},"pretext":{"type":"string","x-stream-index":"001.004"},"text":{"description":"og:description","title":"Text","type":"string","x-stream-index":"001.010"},"thumb_url":{"description":"URL of detected thumb image","title":"Image URL","type":"string","x-stream-index":"001.012"},"title":{"description":"og:title","title":"Title","type":"string","x-stream-index":"001.008"},"title_link":{"description":"og:url","title":"Title Link","type":"string","x-stream-index":"001.009"},"type":{"description":"Attachment type, could be empty, image, audio or video","title":"Type","type":"string","x-stream-index":"001.001"}},"required":["custom","duration"],"title":"Get OG Attachment","type":"object","x-stream-docs-page-id":"og"},"GetOrCreateFeedRequest":{"description":"Client request","nullable":true,"properties":{"activity_selector_options":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"data":{"$ref":"#/components/schemas/FeedInput","x-stream-index":"003"},"external_ranking":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"filter":{"additionalProperties":{},"type":"object","x-stream-index":"009"},"followers_pagination":{"$ref":"#/components/schemas/PagerRequest","x-stream-index":"011"},"following_pagination":{"$ref":"#/components/schemas/PagerRequest","x-stream-index":"012"},"interest_weights":{"additionalProperties":{"format":"float","type":"number"},"type":"object","x-stream-index":"008"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"013.001"},"member_pagination":{"$ref":"#/components/schemas/PagerRequest","x-stream-index":"010"},"next":{"type":"string","x-stream-index":"013.002"},"prev":{"type":"string","x-stream-index":"013.003"},"view":{"type":"string","x-stream-index":"005"},"watch":{"type":"boolean","x-stream-index":"004"}},"title":"ClientRequest","type":"object"},"GetOrCreateFeedResponse":{"description":"Basic response information","nullable":true,"properties":{"activities":{"items":{"$ref":"#/components/schemas/ActivityResponse"},"type":"array","x-stream-index":"002"},"aggregated_activities":{"items":{"$ref":"#/components/schemas/AggregatedActivityResponse"},"type":"array","x-stream-index":"003"},"created":{"type":"boolean","x-stream-index":"015"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"017.001"},"feed":{"$ref":"#/components/schemas/FeedResponse","x-stream-index":"001"},"followers":{"items":{"$ref":"#/components/schemas/FollowResponse"},"type":"array","x-stream-index":"005"},"followers_pagination":{"$ref":"#/components/schemas/PagerResponse","x-stream-index":"012"},"following":{"items":{"$ref":"#/components/schemas/FollowResponse"},"type":"array","x-stream-index":"006"},"following_pagination":{"$ref":"#/components/schemas/PagerResponse","x-stream-index":"013"},"member_pagination":{"$ref":"#/components/schemas/PagerResponse","x-stream-index":"011"},"members":{"items":{"$ref":"#/components/schemas/FeedMemberResponse"},"type":"array","x-stream-index":"004"},"next":{"type":"string","x-stream-index":"016.001"},"notification_status":{"$ref":"#/components/schemas/NotificationStatusResponse","x-stream-index":"014"},"own_capabilities":{"items":{"$ref":"#/components/schemas/FeedOwnCapability"},"type":"array","x-stream-index":"008"},"own_follows":{"items":{"$ref":"#/components/schemas/FollowResponse"},"type":"array","x-stream-index":"009"},"own_membership":{"$ref":"#/components/schemas/FeedMemberResponse","x-stream-index":"010"},"pinned_activities":{"items":{"$ref":"#/components/schemas/ActivityPinResponse"},"type":"array","x-stream-index":"007"},"prev":{"type":"string","x-stream-index":"016.002"}},"required":["feed","activities","aggregated_activities","members","followers","following","pinned_activities","own_capabilities","created","duration"],"title":"Response","type":"object"},"GoogleVisionConfig":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"HLSEgressConfig":{"properties":{"composite_app_settings":{"$ref":"#/components/schemas/CompositeAppSettings","x-stream-index":"005"},"playlist_url":{"type":"string","x-stream-index":"007"},"qualities":{"items":{"$ref":"#/components/schemas/Quality"},"type":"array","x-stream-index":"004"},"start_unix_nano":{"format":"int64","type":"integer","x-stream-index":"006"}},"type":"object"},"HLSSettings":{"properties":{"auto_on":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"004"},"quality_tracks":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"required":["auto_on","enabled","quality_tracks"],"type":"object"},"HLSSettingsResponse":{"description":"HLSSettings is the payload for HLS settings","properties":{"auto_on":{"title":"Auto On","type":"boolean","x-stream-index":"001"},"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"002"},"quality_tracks":{"items":{"type":"string"},"title":"Quality Tracks","type":"array","x-stream-index":"003"}},"required":["auto_on","enabled","quality_tracks","layout"],"title":"HLSSettingsResponse","type":"object"},"HarmConfig":{"properties":{"action_sequences":{"items":{"$ref":"#/components/schemas/ActionSequence"},"type":"array","x-stream-index":"001"},"severity":{"type":"integer","x-stream-index":"002"}},"required":["action_sequences","severity"],"type":"object"},"HealthCheckEvent":{"nullable":true,"properties":{"cid":{"type":"string","x-stream-index":"003"},"connection_id":{"type":"string","x-stream-index":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004.007"},"me":{"$ref":"#/components/schemas/OwnUserResponse","x-stream-index":"002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"004.004"},"type":{"default":"health.check","type":"string","x-stream-index":"004.002"}},"required":["connection_id","type","created_at","custom"],"title":"HealthCheckEvent","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"},"ImageContentParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"type":"object"},"ImageData":{"properties":{"frames":{"type":"string","x-stream-index":"005"},"height":{"type":"string","x-stream-index":"003"},"size":{"type":"string","x-stream-index":"004"},"url":{"type":"string","x-stream-index":"001"},"width":{"type":"string","x-stream-index":"002"}},"required":["url","width","height","size","frames"],"type":"object"},"ImageRuleParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"type":"object"},"ImageSize":{"properties":{"crop":{"description":"Crop mode","enum":["top","bottom","left","right","center"],"title":"Crop","type":"string","x-stream-index":"001"},"height":{"description":"Target image height","format":"int32","title":"Height","type":"integer","x-stream-index":"003"},"resize":{"description":"Resize method","enum":["clip","crop","scale","fill"],"title":"Resize","type":"string","x-stream-index":"002"},"width":{"description":"Target image width","format":"int32","title":"Width","type":"integer","x-stream-index":"004"}},"title":"Image size configuration","type":"object"},"ImageUploadRequest":{"nullable":true,"properties":{"file":{"type":"string","x-stream-index":"001.001"},"upload_sizes":{"description":"field with JSON-encoded array of image size configurations","items":{"$ref":"#/components/schemas/ImageSize"},"title":"Upload sizes","type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/OnlyUserID","x-stream-index":"001.002"}},"type":"object"},"ImageUploadResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.003.001"},"file":{"type":"string","x-stream-index":"001.001"},"thumb_url":{"type":"string","x-stream-index":"001.002"},"upload_sizes":{"description":"Array of image size configurations","items":{"$ref":"#/components/schemas/ImageSize"},"title":"Upload sizes","type":"array","x-stream-index":"002"}},"required":["duration"],"type":"object"},"Images":{"properties":{"fixed_height":{"$ref":"#/components/schemas/ImageData","x-stream-index":"002"},"fixed_height_downsampled":{"$ref":"#/components/schemas/ImageData","x-stream-index":"004"},"fixed_height_still":{"$ref":"#/components/schemas/ImageData","x-stream-index":"003"},"fixed_width":{"$ref":"#/components/schemas/ImageData","x-stream-index":"005"},"fixed_width_downsampled":{"$ref":"#/components/schemas/ImageData","x-stream-index":"007"},"fixed_width_still":{"$ref":"#/components/schemas/ImageData","x-stream-index":"006"},"original":{"$ref":"#/components/schemas/ImageData","x-stream-index":"001"}},"required":["original","fixed_height","fixed_height_still","fixed_height_downsampled","fixed_width","fixed_width_still","fixed_width_downsampled"],"type":"object"},"IngressAudioEncodingOptions":{"properties":{"bitrate":{"maximum":128000,"minimum":16000,"type":"integer","x-stream-index":"003"},"channels":{"enum":["1","2"],"format":"int32","type":"integer","x-stream-index":"001"},"enable_dtx":{"type":"boolean","x-stream-index":"002"}},"required":["channels","enable_dtx","bitrate"],"type":"object"},"IngressAudioEncodingResponse":{"properties":{"bitrate":{"format":"int32","type":"integer","x-stream-index":"003"},"channels":{"format":"int32","type":"integer","x-stream-index":"001"},"enable_dtx":{"type":"boolean","x-stream-index":"002"}},"required":["channels","enable_dtx","bitrate"],"type":"object"},"IngressSettings":{"properties":{"audio_encoding_options":{"$ref":"#/components/schemas/IngressAudioEncodingOptions","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"video_encoding_options":{"additionalProperties":{"$ref":"#/components/schemas/IngressVideoEncodingOptions"},"type":"object","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"IngressSettingsResponse":{"properties":{"audio_encoding_options":{"$ref":"#/components/schemas/IngressAudioEncodingResponse","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"video_encoding_options":{"additionalProperties":{"$ref":"#/components/schemas/IngressVideoEncodingResponse"},"type":"object","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"IngressVideoEncodingOptions":{"properties":{"layers":{"items":{"$ref":"#/components/schemas/IngressVideoLayer"},"minimum":1,"type":"array","x-stream-index":"001"}},"required":["layers"],"type":"object"},"IngressVideoEncodingResponse":{"properties":{"layers":{"items":{"$ref":"#/components/schemas/IngressVideoLayerResponse"},"type":"array","x-stream-index":"001"}},"required":["layers"],"type":"object"},"IngressVideoLayer":{"nullable":true,"properties":{"bitrate":{"minimum":1000,"type":"integer","x-stream-index":"002"},"codec":{"enum":["h264","vp8"],"type":"string","x-stream-index":"001"},"frame_rate":{"maximum":60,"minimum":1,"type":"integer","x-stream-index":"003"},"max_dimension":{"minimum":240,"type":"integer","x-stream-index":"005"},"min_dimension":{"minimum":240,"type":"integer","x-stream-index":"004"}},"required":["codec","bitrate","frame_rate","min_dimension","max_dimension"],"type":"object"},"IngressVideoLayerResponse":{"nullable":true,"properties":{"bitrate":{"type":"integer","x-stream-index":"002"},"codec":{"type":"string","x-stream-index":"001"},"frame_rate_limit":{"type":"integer","x-stream-index":"005"},"max_dimension":{"type":"integer","x-stream-index":"004"},"min_dimension":{"type":"integer","x-stream-index":"003"}},"required":["codec","bitrate","min_dimension","max_dimension","frame_rate_limit"],"type":"object"},"LLMConfig":{"properties":{"app_context":{"type":"string","x-stream-index":"005"},"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/LLMRule"},"type":"array","x-stream-index":"003"},"severity_descriptions":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"004"}},"required":["enabled","rules"],"type":"object"},"LLMRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove","keep"],"type":"string","x-stream-index":"003"},"description":{"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"},"severity_rules":{"items":{"$ref":"#/components/schemas/BodyguardSeverityRule"},"type":"array","x-stream-index":"004"}},"required":["label","description","action","severity_rules"],"type":"object"},"LabelThresholds":{"properties":{"block":{"description":"Threshold for automatic message block","format":"float","maximum":1,"minimum":0,"title":"Block","type":"number","x-stream-index":"002"},"flag":{"description":"Threshold for automatic message flag","format":"float","maximum":1,"minimum":0,"title":"Flag","type":"number","x-stream-index":"001"}},"type":"object"},"LayoutSettings":{"properties":{"detect_orientation":{"type":"boolean","x-stream-index":"005"},"external_app_url":{"type":"string","x-stream-index":"003"},"external_css_url":{"type":"string","x-stream-index":"004"},"name":{"enum":["spotlight","grid","single-participant","mobile","custom"],"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"required":["name","external_app_url","external_css_url"],"type":"object"},"LimitsSettings":{"properties":{"max_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"004"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"},"max_participants_exclude_owner":{"type":"boolean","x-stream-index":"003"},"max_participants_exclude_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"002"}},"required":["max_participants_exclude_roles"],"type":"object"},"LimitsSettingsResponse":{"properties":{"max_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"004"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"},"max_participants_exclude_owner":{"type":"boolean","x-stream-index":"003"},"max_participants_exclude_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"002"}},"required":["max_participants_exclude_roles"],"type":"object"},"ListBlockListResponse":{"description":"Basic response information","nullable":true,"properties":{"blocklists":{"items":{"$ref":"#/components/schemas/BlockListResponse"},"type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["blocklists","duration"],"title":"Response","type":"object"},"ListDevicesResponse":{"description":"List devices response","nullable":true,"properties":{"devices":{"description":"List of devices","items":{"$ref":"#/components/schemas/DeviceResponse"},"title":"Devices","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["devices","duration"],"title":"ListDevicesResponse","type":"object"},"MarkActivityRequest":{"nullable":true,"properties":{"mark_all_read":{"description":"Whether to mark all activities as read","title":"Mark All Read","type":"boolean","x-stream-index":"005"},"mark_all_seen":{"description":"Whether to mark all activities as seen","title":"Mark All Seen","type":"boolean","x-stream-index":"003"},"mark_read":{"description":"List of activity IDs to mark as read","items":{"type":"string"},"title":"Mark Read","type":"array","x-stream-index":"004"},"mark_seen":{"description":"List of activity IDs to mark as seen","items":{"type":"string"},"title":"Mark Seen","type":"array","x-stream-index":"006"},"mark_watched":{"description":"List of activity IDs to mark as watched (for stories)","items":{"type":"string"},"title":"Mark Watched","type":"array","x-stream-index":"007"}},"title":"Mark Activity Request","type":"object"},"MarkReviewedRequest":{"properties":{"content_to_mark_as_reviewed_limit":{"format":"int32","maximum":2500,"type":"integer","x-stream-index":"002"},"disable_marking_content_as_reviewed":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"MemberLookup":{"properties":{"Limit":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"001"}},"required":["Limit"],"type":"object"},"MembershipLevelResponse":{"properties":{"created_at":{"description":"When the membership level was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"007"},"custom":{"additionalProperties":{},"description":"Custom data for the membership level","title":"Custom Data","type":"object","x-stream-index":"006"},"description":{"description":"Description of the membership level","title":"Description","type":"string","x-stream-index":"003"},"id":{"description":"Unique identifier for the membership level","title":"ID","type":"string","x-stream-index":"001"},"name":{"description":"Display name for the membership level","title":"Name","type":"string","x-stream-index":"002"},"priority":{"description":"Priority level","format":"int32","title":"Priority","type":"integer","x-stream-index":"004"},"tags":{"description":"Activity tags this membership level gives access to","items":{"type":"string"},"title":"Tags","type":"array","x-stream-index":"005"},"updated_at":{"description":"When the membership level was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"008"}},"required":["id","name","priority","tags","created_at","updated_at"],"title":"Membership Level Response","type":"object"},"Message":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"012"},"before_message_send_failed":{"type":"boolean","x-stream-index":"046"},"cid":{"type":"string","x-stream-index":"028"},"command":{"type":"string","x-stream-index":"006"},"created_at":{"format":"date-time","type":"number","x-stream-index":"030"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"034"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"033"},"deleted_for_me":{"type":"boolean","x-stream-index":"059"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"023"},"html":{"type":"string","x-stream-index":"007"},"i18n":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"044"},"id":{"type":"string","x-stream-index":"002"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"040"},"latest_reactions":{"items":{"$ref":"#/components/schemas/Reaction"},"type":"array","x-stream-index":"013"},"mentioned_users":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"043"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"052"},"mml":{"type":"string","x-stream-index":"005"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"056"},"own_reactions":{"items":{"$ref":"#/components/schemas/Reaction"},"type":"array","x-stream-index":"014"},"parent_id":{"type":"string","x-stream-index":"019"},"pin_expires":{"format":"date-time","type":"number","x-stream-index":"051"},"pinned":{"type":"boolean","x-stream-index":"047"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"048"},"pinned_by":{"$ref":"#/components/schemas/User","x-stream-index":"050"},"poll":{"$ref":"#/components/schemas/Poll","x-stream-index":"054"},"poll_id":{"type":"string","x-stream-index":"053"},"quoted_message":{"$ref":"#/components/schemas/Message","x-stream-index":"025"},"quoted_message_id":{"type":"string","x-stream-index":"024"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"015"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"017"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"016"},"reminder":{"$ref":"#/components/schemas/MessageReminder","x-stream-index":"058"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"022"},"restricted_visibility":{"items":{"type":"string"},"type":"array","x-stream-index":"011"},"shadowed":{"type":"boolean","x-stream-index":"036"},"shared_location":{"$ref":"#/components/schemas/SharedLocation","x-stream-index":"055"},"show_in_channel":{"type":"boolean","x-stream-index":"021"},"silent":{"type":"boolean","x-stream-index":"045"},"text":{"type":"string","x-stream-index":"004"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"027"},"type":{"type":"string","x-stream-index":"008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"031"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"010"}},"required":["id","text","html","type","restricted_visibility","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reaction_groups","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned"],"type":"object"},"MessageReminder":{"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"004"},"channel_cid":{"type":"string","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"011"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"006"},"message_id":{"type":"string","x-stream-index":"005"},"remind_at":{"format":"date-time","type":"number","x-stream-index":"009"},"task_id":{"type":"string","x-stream-index":"010"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"012"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"user_id":{"type":"string","x-stream-index":"007"}},"required":["channel_cid","message_id","user_id","task_id","created_at","updated_at"],"type":"object"},"MessageResponse":{"description":"Represents any chat message","properties":{"attachments":{"description":"Array of message attachments","items":{"$ref":"#/components/schemas/Attachment"},"title":"Message attachments","type":"array","x-stream-docs-page-id":"message_format#attachment-format","x-stream-index":"008"},"cid":{"description":"Channel unique identifier in \u003ctype\u003e:\u003cid\u003e format","title":"Channel CID","type":"string","x-stream-index":"022"},"command":{"description":"Contains provided slash command","title":"Command","type":"string","x-stream-docs-page-id":"custom_commands_webhook","x-stream-index":"004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"023"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"026"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"025"},"deleted_for_me":{"type":"boolean","x-stream-index":"044"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"018"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"041"},"html":{"description":"Contains HTML markup of the message. Can only be set when using server-side API","title":"HTML content","type":"string","x-stream-index":"005"},"i18n":{"additionalProperties":{"type":"string"},"description":"Object with translations. Key `language` contains the original language key. Other keys contain translations","title":"Internationalization info","type":"object","x-stream-docs-page-id":"translation","x-stream-index":"030"},"id":{"description":"Message ID is unique string identifier of the message","title":"ID","type":"string","x-stream-index":"001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"Contains image moderation information","title":"Image moderation labels","type":"object","x-stream-index":"028"},"latest_reactions":{"description":"List of 10 latest reactions to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Latest reactions","type":"array","x-stream-index":"009"},"mentioned_users":{"description":"List of mentioned users","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Mentioned Users","type":"array","x-stream-index":"029"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"036"},"mml":{"description":"Should be empty if `text` is provided. Can only be set when using server-side API","title":"Messaging Markup Language","type":"string","x-stream-docs-page-id":"mml_overview","x-stream-index":"003"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"039"},"own_reactions":{"description":"List of 10 latest reactions of authenticated user to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Own reactions","type":"array","x-stream-index":"010"},"parent_id":{"description":"ID of parent message (thread)","title":"Parent message ID","type":"string","x-stream-docs-page-id":"threads","x-stream-index":"015"},"pin_expires":{"description":"Date when pinned message expires","format":"date-time","title":"Pin expiration date","type":"number","x-stream-docs-page-id":"pinned_messages","x-stream-index":"035"},"pinned":{"description":"Whether message is pinned or not","title":"Pinned","type":"boolean","x-stream-docs-page-id":"pinned_messages","x-stream-index":"032"},"pinned_at":{"description":"Date when message got pinned","format":"date-time","title":"Pinned at","type":"number","x-stream-docs-page-id":"pinned_messages","x-stream-index":"033"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","description":"Contains user who pinned the message","title":"Pinned by","x-stream-docs-page-id":"pinned_messages","x-stream-index":"034"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"038"},"poll_id":{"description":"Identifier of the poll to include in the message","title":"Poll ID","type":"string","x-stream-index":"037"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","description":"Contains quoted message","title":"Quoted message","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"020"},"quoted_message_id":{"title":"ID of quoted message","type":"string","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"019"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing number of reactions of each type. Key: reaction type (string), value: number of reactions (int)","title":"Reaction counts","type":"object","x-stream-index":"011"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"014"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing scores of reactions of each type. Key: reaction type (string), value: total score of reactions (int)","title":"Reaction scores","type":"object","x-stream-index":"012"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"042"},"reply_count":{"description":"Number of replies to this message","format":"int32","title":"Reply count","type":"integer","x-stream-index":"017"},"restricted_visibility":{"description":"A list of user ids that have restricted visibility to the message, if the list is not empty, the message is only visible to the users in the list","items":{"type":"string"},"title":"Restricted visibility","type":"array","x-stream-index":"040"},"shadowed":{"description":"Whether the message was shadowed or not","title":"Shadowed","type":"boolean","x-stream-docs-page-id":"moderation#shadow-ban","x-stream-index":"027"},"shared_location":{"$ref":"#/components/schemas/SharedLocationResponseData","description":"Contains shared location data","title":"Shared Location","x-stream-index":"043"},"show_in_channel":{"description":"Whether thread reply should be shown in the channel as well","title":"Show in channel","type":"boolean","x-stream-docs-page-id":"threads","x-stream-index":"016"},"silent":{"description":"Whether message is silent or not","title":"Silent","type":"boolean","x-stream-index":"031"},"text":{"description":"Text of the message. Should be empty if `mml` is provided","title":"Text","type":"string","x-stream-index":"002"},"thread_participants":{"description":"List of users who participate in thread","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Thread participants","type":"array","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"021"},"type":{"description":"Contains type of the message","enum":["regular","ephemeral","error","reply","system","deleted"],"title":"Message Type","type":"string","x-stream-docs-page-id":"message_format#message-types","x-stream-index":"006"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"024"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Sender of the message. Required when using server-side API","title":"User object","x-stream-index":"007"}},"required":["id","text","html","type","user","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned","restricted_visibility"],"title":"Message","type":"object","x-stream-docs-page-id":"send_message"},"ModerationActionConfig":{"nullable":true,"properties":{"action":{"type":"string","x-stream-index":"006"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"009"},"description":{"type":"string","x-stream-index":"008"},"entity_type":{"type":"string","x-stream-index":"004"},"icon":{"type":"string","x-stream-index":"007"},"order":{"format":"int32","type":"integer","x-stream-index":"005"}},"required":["entity_type","order","action","icon","description","custom"],"type":"object"},"ModerationCustomActionEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"001"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"002"},"type":{"default":"moderation.custom_action","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationCustomActionEvent","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"},"ModerationFlagResponse":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"015"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"entity_creator_id":{"type":"string","x-stream-index":"007"},"entity_id":{"type":"string","x-stream-index":"006"},"entity_type":{"type":"string","x-stream-index":"005"},"labels":{"items":{"type":"string"},"type":"array","x-stream-index":"011"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"008"},"reason":{"type":"string","x-stream-index":"009"},"result":{"items":{"additionalProperties":{},"type":"object"},"type":"array","x-stream-index":"012"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","x-stream-index":"014"},"review_queue_item_id":{"type":"string","x-stream-index":"013"},"type":{"type":"string","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"016"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"004"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["type","user_id","entity_type","entity_id","result","created_at","updated_at"],"type":"object"},"ModerationFlaggedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"item":{"type":"string","x-stream-index":"001"},"object_id":{"type":"string","x-stream-index":"002"},"type":{"default":"moderation.flagged","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationFlaggedEvent","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"},"ModerationMarkReviewedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"001"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"002"},"type":{"default":"moderation.mark_reviewed","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationMarkReviewedEvent","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"},"ModerationPayload":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"images":{"items":{"type":"string"},"maximum":30,"type":"array","x-stream-index":"002"},"texts":{"items":{"type":"string"},"type":"array","x-stream-index":"001"},"videos":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"type":"object"},"ModerationV2Response":{"properties":{"action":{"type":"string","x-stream-index":"001"},"blocklist_matched":{"type":"string","x-stream-index":"005"},"image_harms":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"original_text":{"type":"string","x-stream-index":"002"},"platform_circumvented":{"type":"boolean","x-stream-index":"007"},"semantic_filter_matched":{"type":"string","x-stream-index":"006"},"text_harms":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"required":["action","original_text"],"type":"object"},"MuteRequest":{"nullable":true,"properties":{"target_ids":{"description":"User IDs to mute (if multiple users)","items":{"type":"string"},"title":"Target IDs","type":"array","x-stream-index":"001"},"timeout":{"description":"Duration of mute in minutes","minimum":0,"title":"Timeout","type":"integer","x-stream-index":"002"}},"required":["target_ids"],"title":"MuteRequest","type":"object"},"MuteResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"004.001"},"mutes":{"description":"Object with mutes (if multiple users were muted)","items":{"$ref":"#/components/schemas/UserMute"},"title":"Mutes","type":"array","x-stream-index":"001"},"non_existing_users":{"description":"A list of users that can't be found. Common cause for this is deleted users","items":{"type":"string"},"title":"Non Existing Users","type":"array","x-stream-index":"003"},"own_user":{"$ref":"#/components/schemas/OwnUser","description":"Authorized user object with fresh mutes information","title":"Own User","x-stream-index":"002"}},"required":["duration"],"title":"MuteResponse","type":"object"},"NoiseCancellationSettings":{"properties":{"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode"],"type":"object"},"NotificationConfig":{"properties":{"track_read":{"type":"boolean","x-stream-index":"002"},"track_seen":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"NotificationFeedUpdatedEvent":{"description":"Emitted when notification feed is updated.","nullable":true,"properties":{"aggregated_activities":{"description":"Aggregated activities for notification feeds","items":{"$ref":"#/components/schemas/AggregatedActivityResponse"},"title":"Aggregated Activities","type":"array","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"003.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.001.007"},"feed_visibility":{"type":"string","x-stream-index":"003.003"},"fid":{"description":"The ID of the feed","title":"Feed ID","type":"string","x-stream-index":"003.002"},"notification_status":{"$ref":"#/components/schemas/NotificationStatusResponse","description":"Notification status including unread/unseen counts","title":"Notification Status","x-stream-index":"002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.001.004"},"type":{"default":"feeds.notification_feed.updated","description":"The type of event: \"feeds.notification_feed.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"003.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who triggered the notification","title":"User","x-stream-index":"004.001"}},"required":["type","created_at","custom","fid"],"title":"NotificationFeedUpdatedEvent","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"},"NotificationSettings":{"properties":{"call_live_started":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"002"},"call_missed":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"006"},"call_notification":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"004"},"call_ring":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"session_started":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"003"}},"required":["enabled","call_live_started","session_started","call_notification","call_ring","call_missed"],"type":"object"},"NotificationStatusResponse":{"properties":{"last_read_at":{"format":"date-time","type":"number","x-stream-index":"006"},"last_seen_at":{"description":"When notifications were last seen","format":"date-time","title":"Last Seen At","type":"number","x-stream-index":"005"},"read_activities":{"description":"IDs of activities that have been read","items":{"type":"string"},"title":"Read Activities","type":"array","x-stream-index":"003"},"seen_activities":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"unread":{"description":"Number of unread notifications","format":"int32","title":"Unread","type":"integer","x-stream-index":"001"},"unseen":{"description":"Number of unseen notifications","format":"int32","title":"Unseen","type":"integer","x-stream-index":"002"}},"required":["unread","unseen"],"title":"Notification Status","type":"object"},"NullTime":{"type":"object"},"OCRRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"}},"required":["label","action"],"type":"object"},"OnlyUserID":{"properties":{"id":{"type":"string","x-stream-index":"001"}},"required":["id"],"type":"object"},"OwnUser":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"046"},"banned":{"type":"boolean","x-stream-index":"016"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"045"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"029"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"014"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"013"},"devices":{"items":{"$ref":"#/components/schemas/Device"},"type":"array","x-stream-index":"027"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"023"},"language":{"type":"string","x-stream-index":"035"},"last_active":{"format":"date-time","type":"number","x-stream-index":"011"},"last_engaged_at":{"format":"date-time","type":"number","x-stream-index":"012"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"037"},"mutes":{"items":{"$ref":"#/components/schemas/UserMute"},"type":"array","x-stream-index":"028"},"online":{"type":"boolean","x-stream-index":"022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"026"},"push_preferences":{"$ref":"#/components/schemas/PushPreferences","x-stream-index":"025"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"005"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"031"},"total_unread_count_by_team":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"032"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"033"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"030"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"034"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"}},"required":["id","role","custom","created_at","updated_at","banned","online","devices","mutes","channel_mutes","unread_count","total_unread_count","total_unread_count_by_team","unread_channels","unread_threads","language"],"type":"object"},"OwnUserResponse":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"banned":{"type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"015"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.011"},"devices":{"items":{"$ref":"#/components/schemas/DeviceResponse"},"title":"Devices","type":"array","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001.001"},"image":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"005"},"language":{"type":"string","x-stream-index":"001.005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"001.014"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"013"},"mutes":{"items":{"$ref":"#/components/schemas/UserMuteResponse"},"type":"array","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"001.002"},"online":{"type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"003"},"push_preferences":{"$ref":"#/components/schemas/PushPreferences","x-stream-index":"002"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.015"},"role":{"type":"string","x-stream-index":"001.006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"009"},"total_unread_count_by_team":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"010"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"011"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"008"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"012"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","devices","invisible","mutes","channel_mutes","unread_count","total_unread_count","unread_channels","unread_threads"],"type":"object"},"PagerRequest":{"properties":{"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"002"},"prev":{"type":"string","x-stream-index":"003"}},"type":"object"},"PagerResponse":{"properties":{"next":{"type":"string","x-stream-index":"001"},"prev":{"type":"string","x-stream-index":"002"}},"type":"object"},"PinActivityRequest":{"nullable":true,"title":"Pin Activity Request","type":"object"},"PinActivityResponse":{"nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","description":"The pinned activity","title":"Activity","x-stream-index":"001"},"created_at":{"description":"When the activity was pinned","format":"date-time","title":"Created At","type":"number","x-stream-index":"004"},"duration":{"type":"string","x-stream-index":"005.001"},"feed":{"description":"Fully qualified ID of the feed the activity was pinned to","title":"Feed ID","type":"string","x-stream-index":"002"},"user_id":{"description":"ID of the user who pinned the activity","title":"User ID","type":"string","x-stream-index":"003"}},"required":["activity","feed","user_id","created_at","duration"],"title":"Pin Activity Response","type":"object"},"Poll":{"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"023"},"allow_answers":{"type":"boolean","x-stream-index":"010"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"009"},"answers_count":{"format":"int32","type":"integer","x-stream-index":"015"},"created_at":{"format":"date-time","type":"number","x-stream-index":"021"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"020"},"created_by_id":{"type":"string","x-stream-index":"019"},"description":{"type":"string","x-stream-index":"005"},"enforce_unique_vote":{"type":"boolean","x-stream-index":"007"},"id":{"type":"string","x-stream-index":"003"},"is_closed":{"type":"boolean","x-stream-index":"011"},"latest_answers":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array","x-stream-index":"017"},"latest_votes_by_option":{"additionalProperties":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array"},"type":"object","x-stream-index":"016"},"max_votes_allowed":{"format":"int32","type":"integer","x-stream-index":"008"},"name":{"type":"string","x-stream-index":"004"},"options":{"items":{"$ref":"#/components/schemas/PollOption"},"type":"array","x-stream-index":"013"},"own_votes":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array","x-stream-index":"018"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"022"},"vote_count":{"format":"int32","type":"integer","x-stream-index":"012"},"vote_counts_by_option":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"014"},"voting_visibility":{"type":"string","x-stream-index":"006"}},"required":["id","name","description","enforce_unique_vote","allow_user_suggested_options","allow_answers","vote_count","options","vote_counts_by_option","answers_count","latest_votes_by_option","latest_answers","own_votes","created_by_id","created_at","updated_at","Custom"],"type":"object"},"PollClosedFeedEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"001.002.003"},"fid":{"type":"string","x-stream-index":"001.002.002"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001.001"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.002.001.004"},"type":{"default":"feeds.poll.closed","type":"string","x-stream-index":"001.002.001.002"}},"required":["poll","type","created_at","custom","fid"],"title":"PollClosedFeedEvent","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"},"PollDeletedFeedEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"001.002.003"},"fid":{"type":"string","x-stream-index":"001.002.002"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001.001"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.002.001.004"},"type":{"default":"feeds.poll.deleted","type":"string","x-stream-index":"001.002.001.002"}},"required":["poll","type","created_at","custom","fid"],"title":"PollDeletedFeedEvent","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"},"PollOption":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id","text","custom"],"type":"object"},"PollOptionInput":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"text":{"type":"string","x-stream-index":"002"}},"type":"object"},"PollOptionRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id"],"type":"object"},"PollOptionResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"poll_option":{"$ref":"#/components/schemas/PollOptionResponseData","description":"Poll option","title":"PollOptionResponseData","x-stream-index":"001"}},"required":["poll_option","duration"],"type":"object"},"PollOptionResponseData":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id","text","custom"],"type":"object"},"PollResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"poll":{"$ref":"#/components/schemas/PollResponseData","description":"Poll","title":"PollResponseData","x-stream-index":"001"}},"required":["poll","duration"],"type":"object"},"PollResponseData":{"properties":{"allow_answers":{"type":"boolean","x-stream-index":"008"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"007"},"answers_count":{"format":"int32","type":"integer","x-stream-index":"012"},"created_at":{"format":"date-time","type":"number","x-stream-index":"019"},"created_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"018"},"created_by_id":{"type":"string","x-stream-index":"017"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"021"},"description":{"type":"string","x-stream-index":"003"},"enforce_unique_vote":{"type":"boolean","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"is_closed":{"type":"boolean","x-stream-index":"009"},"latest_answers":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array","x-stream-index":"015"},"latest_votes_by_option":{"additionalProperties":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array"},"type":"object","x-stream-index":"014"},"max_votes_allowed":{"format":"int32","type":"integer","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"002"},"options":{"items":{"$ref":"#/components/schemas/PollOptionResponseData"},"type":"array","x-stream-index":"011"},"own_votes":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array","x-stream-index":"016"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"020"},"vote_count":{"format":"int32","type":"integer","x-stream-index":"010"},"vote_counts_by_option":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"013"},"voting_visibility":{"type":"string","x-stream-index":"004"}},"required":["id","name","description","voting_visibility","enforce_unique_vote","allow_user_suggested_options","allow_answers","vote_count","options","answers_count","vote_counts_by_option","latest_votes_by_option","latest_answers","own_votes","created_by_id","created_at","updated_at","custom"],"type":"object"},"PollUpdatedFeedEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"001.002.003"},"fid":{"type":"string","x-stream-index":"001.002.002"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001.001"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.002.001.004"},"type":{"default":"feeds.poll.updated","type":"string","x-stream-index":"001.002.001.002"}},"required":["poll","type","created_at","custom","fid"],"title":"PollUpdatedFeedEvent","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"},"PollVote":{"nullable":true,"properties":{"answer_text":{"type":"string","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"004"},"is_answer":{"type":"boolean","x-stream-index":"006"},"option_id":{"type":"string","x-stream-index":"005"},"poll_id":{"type":"string","x-stream-index":"003"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"011"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"009"},"user_id":{"type":"string","x-stream-index":"008"}},"required":["poll_id","id","option_id","created_at","updated_at"],"type":"object"},"PollVoteCastedFeedEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.001.002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"001.001.002.003"},"fid":{"type":"string","x-stream-index":"001.001.002.002"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001.001.001"},"poll_vote":{"$ref":"#/components/schemas/PollVoteResponseData","x-stream-index":"001.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.002.001.004"},"type":{"default":"feeds.poll.vote_casted","type":"string","x-stream-index":"001.001.002.001.002"}},"required":["poll","type","created_at","custom","fid","poll_vote"],"title":"PollVoteCastedFeedEvent","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"},"PollVoteChangedFeedEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.001.002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"001.001.002.003"},"fid":{"type":"string","x-stream-index":"001.001.002.002"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001.001.001"},"poll_vote":{"$ref":"#/components/schemas/PollVoteResponseData","x-stream-index":"001.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.002.001.004"},"type":{"default":"feeds.poll.vote_changed","type":"string","x-stream-index":"001.001.002.001.002"}},"required":["poll","type","created_at","custom","fid","poll_vote"],"title":"PollVoteChangedFeedEvent","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"},"PollVoteRemovedFeedEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.001.002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"001.001.002.003"},"fid":{"type":"string","x-stream-index":"001.001.002.002"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001.001.001"},"poll_vote":{"$ref":"#/components/schemas/PollVoteResponseData","x-stream-index":"001.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.002.001.004"},"type":{"default":"feeds.poll.vote_removed","type":"string","x-stream-index":"001.001.002.001.002"}},"required":["poll","type","created_at","custom","fid","poll_vote"],"title":"PollVoteRemovedFeedEvent","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"},"PollVoteResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"vote":{"$ref":"#/components/schemas/PollVoteResponseData","description":"Poll vote","title":"PollVoteResponseData","x-stream-index":"001"}},"required":["duration"],"type":"object"},"PollVoteResponseData":{"nullable":true,"properties":{"answer_text":{"type":"string","x-stream-index":"005"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"id":{"type":"string","x-stream-index":"002"},"is_answer":{"type":"boolean","x-stream-index":"004"},"option_id":{"type":"string","x-stream-index":"003"},"poll_id":{"type":"string","x-stream-index":"001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"007"},"user_id":{"type":"string","x-stream-index":"006"}},"required":["poll_id","id","option_id","created_at","updated_at"],"type":"object"},"PollVotesResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"votes":{"description":"Poll votes","items":{"$ref":"#/components/schemas/PollVoteResponseData"},"title":"PollVoteResponseList","type":"array","x-stream-index":"001"}},"required":["votes","duration"],"type":"object"},"PrivacySettings":{"properties":{"read_receipts":{"$ref":"#/components/schemas/ReadReceipts","x-stream-index":"002"},"typing_indicators":{"$ref":"#/components/schemas/TypingIndicators","x-stream-index":"001"}},"type":"object"},"PrivacySettingsResponse":{"properties":{"read_receipts":{"$ref":"#/components/schemas/ReadReceiptsResponse","x-stream-index":"002"},"typing_indicators":{"$ref":"#/components/schemas/TypingIndicatorsResponse","x-stream-index":"001"}},"type":"object"},"PushNotificationConfig":{"properties":{"activity_types":{"items":{"type":"string"},"type":"array","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"PushPreferences":{"properties":{"call_level":{"type":"string","x-stream-index":"002"},"chat_level":{"type":"string","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"number","x-stream-index":"005"},"feeds_events":{"$ref":"#/components/schemas/FeedsEventPreferences","x-stream-index":"004"},"feeds_level":{"type":"string","x-stream-index":"003"}},"type":"object"},"Quality":{"properties":{"bitdepth":{"format":"int32","type":"integer","x-stream-index":"007"},"framerate":{"format":"int32","type":"integer","x-stream-index":"008"},"height":{"format":"int32","type":"integer","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"004"},"video_bitrate":{"format":"int32","type":"integer","x-stream-index":"009"},"width":{"format":"int32","type":"integer","x-stream-index":"005"}},"type":"object"},"QueryActivitiesRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filters to apply to the query. Supports location-based queries with 'near' and 'within_bounds' operators.","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"Sorting parameters for the query","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"002"}},"title":"Query Activities Request","type":"object"},"QueryActivitiesResponse":{"nullable":true,"properties":{"activities":{"description":"List of activities matching the query","items":{"$ref":"#/components/schemas/ActivityResponse"},"title":"Activities","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"next":{"description":"Cursor for next page","title":"Next","type":"string","x-stream-index":"002.001"},"prev":{"description":"Cursor for previous page","title":"Previous","type":"string","x-stream-index":"002.002"}},"required":["activities","duration"],"title":"Query Activities Response","type":"object"},"QueryActivityReactionsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"type":"object","x-stream-index":"002"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"004.001"},"next":{"type":"string","x-stream-index":"004.002"},"prev":{"type":"string","x-stream-index":"004.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"type":"array","x-stream-index":"003"}},"type":"object"},"QueryActivityReactionsResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"reactions":{"items":{"$ref":"#/components/schemas/FeedsReactionResponse"},"type":"array","x-stream-index":"001"}},"required":["reactions","duration"],"title":"Response","type":"object"},"QueryBookmarkFoldersRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filters to apply to the query","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"Sorting parameters for the query","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"002"}},"title":"Query Bookmark Folders Request","type":"object"},"QueryBookmarkFoldersResponse":{"nullable":true,"properties":{"bookmark_folders":{"description":"List of bookmark folders matching the query","items":{"$ref":"#/components/schemas/BookmarkFolderResponse"},"title":"Bookmark Folders","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"next":{"description":"Cursor for next page","title":"Next","type":"string","x-stream-index":"002.001"},"prev":{"description":"Cursor for previous page","title":"Previous","type":"string","x-stream-index":"002.002"}},"required":["bookmark_folders","duration"],"title":"Query Bookmark Folders Response","type":"object"},"QueryBookmarksRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filters to apply to the query","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"Sorting parameters for the query","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"002"}},"title":"Query Bookmarks Request","type":"object"},"QueryBookmarksResponse":{"nullable":true,"properties":{"bookmarks":{"description":"List of bookmarks matching the query","items":{"$ref":"#/components/schemas/BookmarkResponse"},"title":"Bookmarks","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"next":{"description":"Cursor for next page","title":"Next","type":"string","x-stream-index":"002.001"},"prev":{"description":"Cursor for previous page","title":"Previous","type":"string","x-stream-index":"002.002"}},"required":["bookmarks","duration"],"title":"Query Bookmarks Response","type":"object"},"QueryCommentReactionsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"type":"object","x-stream-index":"002"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"004.001"},"next":{"type":"string","x-stream-index":"004.002"},"prev":{"type":"string","x-stream-index":"004.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"type":"array","x-stream-index":"003"}},"type":"object"},"QueryCommentReactionsResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"reactions":{"items":{"$ref":"#/components/schemas/FeedsReactionResponse"},"type":"array","x-stream-index":"001"}},"required":["reactions","duration"],"title":"Response","type":"object"},"QueryCommentsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"MongoDB-style filter for querying comments","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"description":"Maximum number of comments to return","format":"int32","maximum":100,"minimum":0,"title":"Limit","type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"first (oldest), last (newest) or top","enum":["first","last","top","best","controversial"],"title":"Sort Order","type":"string","x-stream-index":"002"}},"required":["filter"],"title":"Query Comments Request","type":"object"},"QueryCommentsResponse":{"nullable":true,"properties":{"comments":{"description":"List of comments matching the query","items":{"$ref":"#/components/schemas/CommentResponse"},"title":"Comments","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"next":{"description":"Cursor for next page","title":"Next","type":"string","x-stream-index":"002.001"},"prev":{"description":"Cursor for previous page","title":"Previous","type":"string","x-stream-index":"002.002"}},"required":["comments","duration"],"title":"Query Comments Response","type":"object"},"QueryFeedMembersRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter parameters for the query","title":"object","type":"object","x-stream-index":"003"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Sort parameters for the query","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"array","type":"array","x-stream-index":"004"}},"type":"object"},"QueryFeedMembersResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"003.001"},"members":{"description":"List of feed members","items":{"$ref":"#/components/schemas/FeedMemberResponse"},"title":"array","type":"array","x-stream-index":"001"},"next":{"description":"Cursor for next page","title":"Next","type":"string","x-stream-index":"002.001"},"prev":{"description":"Cursor for previous page","title":"Previous","type":"string","x-stream-index":"002.002"}},"required":["members","duration"],"type":"object"},"QueryFeedsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filters to apply to the query","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"004.001"},"next":{"type":"string","x-stream-index":"004.002"},"prev":{"type":"string","x-stream-index":"004.003"},"sort":{"description":"Sorting parameters for the query","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"003"},"watch":{"description":"Whether to subscribe to realtime updates","title":"Watch","type":"boolean","x-stream-index":"002"}},"title":"Query Feeds Request","type":"object"},"QueryFeedsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"003.001"},"feeds":{"description":"List of feeds matching the query","items":{"$ref":"#/components/schemas/FeedResponse"},"title":"Feeds","type":"array","x-stream-index":"001"},"next":{"description":"Cursor for next page","title":"Next","type":"string","x-stream-index":"002.001"},"prev":{"description":"Cursor for previous page","title":"Previous","type":"string","x-stream-index":"002.002"}},"required":["feeds","duration"],"title":"Query Feeds Response","type":"object"},"QueryFollowsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filters to apply to the query","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"Sorting parameters for the query","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"002"}},"title":"Query Follows Request","type":"object"},"QueryFollowsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"003.001"},"follows":{"description":"List of follow relationships matching the query","items":{"$ref":"#/components/schemas/FollowResponse"},"title":"Follows","type":"array","x-stream-index":"001"},"next":{"description":"Cursor for next page","title":"Next","type":"string","x-stream-index":"002.001"},"prev":{"description":"Cursor for previous page","title":"Previous","type":"string","x-stream-index":"002.002"}},"required":["follows","duration"],"title":"Query Follows Response","type":"object"},"QueryModerationConfigsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter conditions for moderation configs","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"Sorting parameters for the results","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"002"}},"type":"object"},"QueryModerationConfigsResponse":{"nullable":true,"properties":{"configs":{"description":"List of moderation configurations","items":{"$ref":"#/components/schemas/ConfigResponse"},"title":"Configs","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["configs","duration"],"type":"object"},"QueryPollVotesRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","title":"Filter","type":"object","x-stream-index":"003"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"004"}},"type":"object"},"QueryPollsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","title":"Filter","type":"object","x-stream-index":"002"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"003"}},"type":"object"},"QueryPollsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"polls":{"description":"Polls data returned by the query","items":{"$ref":"#/components/schemas/PollResponseData"},"title":"PollsResponseData","type":"array","x-stream-index":"001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["polls","duration"],"type":"object"},"QueryReviewQueueRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter conditions for review queue items","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"007.001"},"lock_count":{"description":"Number of items to lock (1-25)","format":"int32","maximum":25,"minimum":1,"title":"Lock Count","type":"integer","x-stream-index":"005"},"lock_duration":{"description":"Duration for which items should be locked","title":"Lock Duration","type":"integer","x-stream-index":"004"},"lock_items":{"description":"Whether to lock items for review (true), unlock items (false), or just fetch (nil)","title":"Lock Items","type":"boolean","x-stream-index":"003"},"next":{"type":"string","x-stream-index":"007.002"},"prev":{"type":"string","x-stream-index":"007.003"},"sort":{"description":"Sorting parameters for the results","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"002"},"stats_only":{"description":"Whether to return only statistics","title":"Stats Only","type":"boolean","x-stream-index":"006"}},"type":"object"},"QueryReviewQueueResponse":{"nullable":true,"properties":{"action_config":{"additionalProperties":{"items":{"$ref":"#/components/schemas/ModerationActionConfig"},"type":"array"},"description":"Configuration for moderation actions","title":"Action Config","type":"object","x-stream-index":"002"},"duration":{"type":"string","x-stream-index":"005.001"},"items":{"description":"List of review queue items","items":{"$ref":"#/components/schemas/ReviewQueueItemResponse"},"title":"Items","type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"004.001"},"prev":{"type":"string","x-stream-index":"004.002"},"stats":{"additionalProperties":{},"description":"Statistics about the review queue","title":"Stats","type":"object","x-stream-index":"003"}},"required":["items","action_config","stats","duration"],"type":"object"},"QueryUsersPayload":{"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"include_deactivated_users":{"type":"boolean","x-stream-index":"004"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.003"},"offset":{"format":"int32","maximum":1000,"type":"integer","x-stream-index":"005.004"},"presence":{"type":"boolean","x-stream-index":"003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"type":"array","x-stream-index":"002"}},"required":["filter_conditions"],"type":"object"},"QueryUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"users":{"description":"Array of users as result of filters applied.","items":{"$ref":"#/components/schemas/FullUserResponse"},"title":"Users","type":"array","x-stream-index":"001"}},"required":["users","duration"],"type":"object"},"RTMPEgressConfig":{"properties":{"composite_app_settings":{"$ref":"#/components/schemas/CompositeAppSettings","x-stream-index":"005"},"quality":{"$ref":"#/components/schemas/Quality","x-stream-index":"004"},"rtmp_location":{"type":"string","x-stream-index":"006"}},"type":"object"},"RTMPIngress":{"description":"RTMP input settings","properties":{"address":{"title":"Address","type":"string","x-stream-index":"001"}},"required":["address"],"title":"RTMPIngress","type":"object"},"RTMPLocation":{"properties":{"name":{"type":"string","x-stream-index":"001"},"stream_key":{"type":"string","x-stream-index":"003"},"stream_url":{"type":"string","x-stream-index":"002"}},"required":["name","stream_url","stream_key"],"type":"object"},"RTMPSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"003"},"location":{"$ref":"#/components/schemas/RTMPLocation","x-stream-index":"004"},"quality_name":{"type":"string","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"RTMPSettingsResponse":{"description":"RTMPSettingsResponse is the payload for RTMP settings","properties":{"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"001"},"quality":{"title":"Quality","type":"string","x-stream-index":"002"}},"required":["enabled","quality","layout"],"title":"RTMPSettingsResponse","type":"object"},"RankingConfig":{"properties":{"defaults":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"functions":{"additionalProperties":{"$ref":"#/components/schemas/DecayFunctionConfig"},"type":"object","x-stream-index":"004"},"score":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"001"}},"type":"object"},"Reaction":{"nullable":true,"properties":{"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"message_id":{"type":"string","x-stream-index":"003"},"score":{"format":"int32","type":"integer","x-stream-index":"007"},"type":{"maxLength":30,"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["message_id","type","score","created_at","updated_at","custom"],"type":"object"},"ReactionGroupResponse":{"description":"ReactionGroupResponse contains all information about a reaction of the same type.","nullable":true,"properties":{"count":{"description":"Count is the number of reactions of this type.","format":"int32","title":"Count","type":"integer","x-stream-index":"001"},"first_reaction_at":{"description":"FirstReactionAt is the time of the first reaction of this type. This is the same also if all reaction of this type are deleted, because if someone will react again with the same type, will be preserved the sorting.","format":"date-time","title":"FirstReactionAt","type":"number","x-stream-index":"003"},"last_reaction_at":{"description":"LastReactionAt is the time of the last reaction of this type.","format":"date-time","title":"LastReactionAt","type":"number","x-stream-index":"004"},"sum_scores":{"description":"SumScores is the sum of all scores of reactions of this type. Medium allows you to clap articles more than once and shows the sum of all claps from all users. For example, you can send `clap` x5 using `score: 5`.","format":"int32","title":"SumScores","type":"integer","x-stream-index":"002"}},"required":["count","sum_scores","first_reaction_at","last_reaction_at"],"title":"ReactionGroupResponse","type":"object"},"ReactionResponse":{"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"006"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"008"},"message_id":{"description":"Message ID","title":"Message ID","type":"string","x-stream-index":"001"},"score":{"description":"Score of the reaction","format":"int32","title":"Score","type":"integer","x-stream-index":"005"},"type":{"description":"Type of reaction","title":"Type","type":"string","x-stream-index":"004"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"007"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User","title":"UserResponse","x-stream-index":"003"},"user_id":{"description":"User ID","title":"User ID","type":"string","x-stream-index":"002"}},"required":["message_id","user_id","user","type","score","created_at","updated_at","custom"],"type":"object"},"ReadReceipts":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"ReadReceiptsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"RecordSettings":{"properties":{"audio_only":{"type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"004"},"mode":{"type":"string","x-stream-index":"002"},"quality":{"type":"string","x-stream-index":"003"}},"required":["mode"],"type":"object"},"RecordSettingsResponse":{"description":"RecordSettings is the payload for recording settings","properties":{"audio_only":{"title":"Audio Only","type":"boolean","x-stream-index":"001"},"mode":{"title":"Mode","type":"string","x-stream-index":"002"},"quality":{"title":"Quality","type":"string","x-stream-index":"003"}},"required":["audio_only","mode","quality","layout"],"title":"RecordSettingsResponse","type":"object"},"RecordingEgressConfig":{"properties":{"audio_only":{"type":"boolean","x-stream-index":"006"},"composite_app_settings":{"$ref":"#/components/schemas/CompositeAppSettings","x-stream-index":"005"},"external_storage":{"$ref":"#/components/schemas/ExternalStorage","x-stream-index":"008"},"quality":{"$ref":"#/components/schemas/Quality","x-stream-index":"004"},"storage_name":{"type":"string","x-stream-index":"007"},"video_orientation_hint":{"$ref":"#/components/schemas/VideoOrientation","x-stream-index":"009"}},"type":"object"},"RejectFeedMemberInviteRequest":{"nullable":true,"title":"Reject Feed Member Request","type":"object"},"RejectFeedMemberInviteResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"member":{"$ref":"#/components/schemas/FeedMemberResponse","description":"The feed member after rejecting the invite","title":"Feed Member","x-stream-index":"001"}},"required":["member","duration"],"title":"Reject Feed Member Response","type":"object"},"RejectFollowRequest":{"nullable":true,"properties":{"source":{"description":"Fully qualified ID of the source feed","maxLength":255,"title":"Source Feed ID","type":"string","x-stream-index":"001"},"target":{"description":"Fully qualified ID of the target feed","maxLength":255,"title":"Target Feed ID","type":"string","x-stream-index":"002"}},"required":["source","target"],"title":"Reject Follow Request","type":"object"},"RejectFollowResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"follow":{"$ref":"#/components/schemas/FollowResponse","description":"The rejected follow relationship","title":"Follow","x-stream-index":"001"}},"required":["follow","duration"],"title":"Reject Follow Response","type":"object"},"ReminderResponseData":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003"},"channel_cid":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"005"},"message_id":{"type":"string","x-stream-index":"004"},"remind_at":{"format":"date-time","type":"number","x-stream-index":"001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007"},"user_id":{"type":"string","x-stream-index":"006"}},"required":["channel_cid","message_id","user_id","created_at","updated_at"],"type":"object"},"RepliesMeta":{"description":"Cursor \u0026 depth information for a comment's direct replies. Mirrors Reddit's 'load more replies' semantics.","properties":{"depth_truncated":{"description":"True if the subtree was cut because the requested depth was reached.","title":"Depth Truncated","type":"boolean","x-stream-index":"004"},"has_more":{"description":"True if more siblings exist in the database.","title":"Has More","type":"boolean","x-stream-index":"001"},"next_cursor":{"description":"Opaque cursor to request the next page of siblings.","title":"Next Cursor","type":"string","x-stream-index":"002"},"remaining":{"description":"Number of unread siblings that match current filters.","format":"int32","title":"Remaining","type":"integer","x-stream-index":"003"}},"required":["has_more","remaining","depth_truncated"],"title":"Replies Meta","type":"object"},"Response":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001"}},"required":["duration"],"title":"Response","type":"object"},"RestoreActionRequest":{"type":"object"},"ReviewQueueItem":{"properties":{"actions":{"items":{"$ref":"#/components/schemas/ActionLog"},"type":"array","x-stream-index":"035"},"activity":{"$ref":"#/components/schemas/EnrichedActivity","x-stream-index":"028"},"ai_text_severity":{"type":"string","x-stream-index":"021"},"archived_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"043"},"assigned_to":{"$ref":"#/components/schemas/User","x-stream-index":"032"},"bans":{"items":{"$ref":"#/components/schemas/Ban"},"type":"array","x-stream-index":"033"},"bounce_count":{"format":"int32","type":"integer","x-stream-index":"025"},"call":{"$ref":"#/components/schemas/Call","x-stream-index":"031"},"completed_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"018"},"config_key":{"type":"string","x-stream-index":"009"},"content_changed":{"type":"boolean","x-stream-index":"036"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"entity_creator":{"$ref":"#/components/schemas/EntityCreator","x-stream-index":"030"},"entity_id":{"type":"string","x-stream-index":"007"},"entity_type":{"type":"string","x-stream-index":"006"},"feeds_v2_activity":{"$ref":"#/components/schemas/EnrichedActivity","x-stream-index":"041"},"feeds_v2_reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"042"},"flag_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"045"},"flag_types":{"items":{"type":"string"},"type":"array","x-stream-index":"044"},"flags":{"items":{"$ref":"#/components/schemas/Flag"},"type":"array","x-stream-index":"034"},"flags_count":{"format":"int32","type":"integer","x-stream-index":"026"},"has_image":{"type":"boolean","x-stream-index":"012"},"has_text":{"type":"boolean","x-stream-index":"014"},"has_video":{"type":"boolean","x-stream-index":"013"},"id":{"type":"string","x-stream-index":"003"},"languages":{"items":{"type":"string"},"type":"array","x-stream-index":"019"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"027"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"010"},"moderation_payload_hash":{"type":"string","x-stream-index":"011"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"029"},"recommended_action":{"type":"string","x-stream-index":"017"},"reporter_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"046"},"reviewed_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"022"},"reviewed_by":{"type":"string","x-stream-index":"023"},"severity":{"format":"int32","type":"integer","x-stream-index":"020"},"status":{"type":"string","x-stream-index":"016"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"015"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"005"}},"required":["id","created_at","updated_at","entity_type","entity_id","config_key","moderation_payload_hash","has_image","has_video","has_text","teams","status","recommended_action","completed_at","languages","severity","ai_text_severity","reviewed_at","reviewed_by","bounce_count","flags_count","bans","flags","actions","content_changed","archived_at","flag_types","flag_labels","reporter_ids"],"type":"object"},"ReviewQueueItemResponse":{"nullable":true,"properties":{"actions":{"description":"Moderation actions taken","items":{"$ref":"#/components/schemas/ActionLogResponse"},"title":"Actions","type":"array","x-stream-index":"024"},"activity":{"$ref":"#/components/schemas/EnrichedActivity","x-stream-index":"016"},"ai_text_severity":{"description":"AI-determined text severity","title":"AI Text Severity","type":"string","x-stream-index":"014"},"assigned_to":{"$ref":"#/components/schemas/UserResponse","description":"Moderator assigned to review this item","title":"Assigned To","x-stream-index":"021"},"bans":{"description":"Associated ban records","items":{"$ref":"#/components/schemas/Ban"},"title":"Bans","type":"array","x-stream-index":"022"},"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"018"},"completed_at":{"description":"When the review was completed","format":"date-time","title":"Completed At","type":"number","x-stream-index":"009"},"config_key":{"type":"string","x-stream-index":"028"},"created_at":{"description":"When the item was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"002"},"entity_creator":{"$ref":"#/components/schemas/EntityCreatorResponse","description":"Details about who created the entity","title":"Entity Creator","x-stream-index":"019"},"entity_creator_id":{"description":"ID of who created the entity","title":"Entity Creator ID","type":"string","x-stream-index":"020"},"entity_id":{"description":"ID of the entity being reviewed","title":"Entity ID","type":"string","x-stream-index":"005"},"entity_type":{"description":"Type of entity being reviewed","title":"Entity Type","type":"string","x-stream-index":"004"},"feeds_v2_activity":{"$ref":"#/components/schemas/EnrichedActivity","description":"Associated feed activity","title":"Feeds V2 Activity","x-stream-index":"025"},"feeds_v2_reaction":{"$ref":"#/components/schemas/Reaction","description":"Associated feed reaction","title":"Feeds V2 Reaction","x-stream-index":"026"},"flags":{"description":"Associated flag records","items":{"$ref":"#/components/schemas/ModerationFlagResponse"},"title":"Flags","type":"array","x-stream-index":"023"},"flags_count":{"format":"int32","type":"integer","x-stream-index":"029"},"id":{"description":"Unique identifier of the review queue item","title":"ID","type":"string","x-stream-index":"001"},"languages":{"description":"Detected languages in the content","items":{"type":"string"},"title":"Languages","type":"array","x-stream-index":"012"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Associated message details","title":"Message","x-stream-index":"015"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content being moderated","title":"Moderation Payload","x-stream-index":"006"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"017"},"recommended_action":{"description":"Suggested moderation action","title":"Recommended Action","type":"string","x-stream-index":"008"},"reviewed_at":{"description":"When the item was reviewed","format":"date-time","title":"Reviewed At","type":"number","x-stream-index":"010"},"reviewed_by":{"description":"ID of the moderator who reviewed the item","title":"Reviewed By","type":"string","x-stream-index":"011"},"severity":{"description":"Severity level of the content","format":"int32","title":"Severity","type":"integer","x-stream-index":"013"},"status":{"description":"Current status of the review","title":"Status","type":"string","x-stream-index":"007"},"teams":{"description":"Teams associated with this item","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"027"},"updated_at":{"description":"When the item was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"003"}},"required":["id","created_at","updated_at","entity_type","entity_id","status","recommended_action","reviewed_by","languages","severity","ai_text_severity","bans","flags","actions","flags_count"],"type":"object"},"RingSettings":{"properties":{"auto_cancel_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_timeout_ms","missed_call_timeout_ms"],"type":"object"},"RingSettingsResponse":{"properties":{"auto_cancel_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_timeout_ms","missed_call_timeout_ms"],"type":"object"},"RuleBuilderAction":{"properties":{"ban_options":{"$ref":"#/components/schemas/BanOptions","x-stream-index":"002"},"flag_content_options":{"$ref":"#/components/schemas/FlagContentOptions","x-stream-index":"004"},"flag_user_options":{"$ref":"#/components/schemas/FlagUserOptions","x-stream-index":"003"},"remove_content_options":{"$ref":"#/components/schemas/BlockContentOptions","x-stream-index":"005"},"type":{"type":"string","x-stream-index":"001"}},"type":"object"},"RuleBuilderCondition":{"properties":{"confidence":{"format":"float","type":"number","x-stream-index":"002"},"content_count_rule_params":{"$ref":"#/components/schemas/ContentCountRuleParameters","x-stream-index":"007"},"image_content_params":{"$ref":"#/components/schemas/ImageContentParameters","x-stream-index":"009"},"image_rule_params":{"$ref":"#/components/schemas/ImageRuleParameters","x-stream-index":"004"},"text_content_params":{"$ref":"#/components/schemas/TextContentParameters","x-stream-index":"008"},"text_rule_params":{"$ref":"#/components/schemas/TextRuleParameters","x-stream-index":"003"},"type":{"type":"string","x-stream-index":"001"},"user_created_within_params":{"$ref":"#/components/schemas/UserCreatedWithinParameters","x-stream-index":"011"},"user_custom_property_params":{"$ref":"#/components/schemas/UserCustomPropertyParameters","x-stream-index":"012"},"user_rule_params":{"$ref":"#/components/schemas/UserRuleParameters","x-stream-index":"006"},"video_content_params":{"$ref":"#/components/schemas/VideoContentParameters","x-stream-index":"010"},"video_rule_params":{"$ref":"#/components/schemas/VideoRuleParameters","x-stream-index":"005"}},"type":"object"},"RuleBuilderConditionGroup":{"properties":{"conditions":{"items":{"$ref":"#/components/schemas/RuleBuilderCondition"},"type":"array","x-stream-index":"002"},"logic":{"type":"string","x-stream-index":"001"}},"type":"object"},"RuleBuilderConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"rules":{"items":{"$ref":"#/components/schemas/RuleBuilderRule"},"type":"array","x-stream-index":"002"}},"type":"object"},"RuleBuilderRule":{"properties":{"action":{"$ref":"#/components/schemas/RuleBuilderAction","x-stream-index":"006"},"conditions":{"items":{"$ref":"#/components/schemas/RuleBuilderCondition"},"type":"array","x-stream-index":"003"},"cooldown_period":{"type":"string","x-stream-index":"007"},"groups":{"items":{"$ref":"#/components/schemas/RuleBuilderConditionGroup"},"type":"array","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"logic":{"type":"string","x-stream-index":"004"},"rule_type":{"type":"string","x-stream-index":"002"}},"required":["rule_type","action"],"type":"object"},"SFUIDLastSeen":{"properties":{"id":{"type":"string","x-stream-index":"001.001"},"last_seen":{"format":"date-time","type":"number","x-stream-index":"002"},"process_start_time":{"format":"int64","type":"integer","x-stream-index":"001.002"}},"required":["id","process_start_time","last_seen"],"type":"object"},"STTEgressConfig":{"properties":{"closed_captions_enabled":{"type":"boolean","x-stream-index":"005"},"external_storage":{"$ref":"#/components/schemas/ExternalStorage","x-stream-index":"011"},"language":{"type":"string","x-stream-index":"008"},"storage_name":{"type":"string","x-stream-index":"010"},"translation_languages":{"items":{"type":"string"},"type":"array","x-stream-index":"009"},"translations_enabled":{"type":"boolean","x-stream-index":"006"},"upload_transcriptions":{"type":"boolean","x-stream-index":"004"},"whisper_server_base_url":{"type":"string","x-stream-index":"007"}},"type":"object"},"ScreensharingSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled"],"type":"object"},"ScreensharingSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled"],"type":"object"},"SessionSettings":{"properties":{"inactivity_timeout_seconds":{"format":"int32","maximum":900,"minimum":5,"type":"integer","x-stream-index":"001"}},"required":["inactivity_timeout_seconds"],"type":"object"},"SessionSettingsResponse":{"properties":{"inactivity_timeout_seconds":{"format":"int32","maximum":900,"minimum":5,"type":"integer","x-stream-index":"001"}},"required":["inactivity_timeout_seconds"],"type":"object"},"ShadowBlockActionRequest":{"type":"object"},"SharedLocation":{"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"013"},"channel_cid":{"type":"string","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"010"},"created_by_device_id":{"type":"string","x-stream-index":"008"},"end_at":{"format":"date-time","type":"number","x-stream-index":"009"},"latitude":{"format":"float","maximum":90,"minimum":18446744073709552000,"type":"number","x-stream-index":"006"},"longitude":{"format":"float","maximum":180,"minimum":18446744073709552000,"type":"number","x-stream-index":"007"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"012"},"message_id":{"type":"string","x-stream-index":"004"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"011"},"user_id":{"type":"string","x-stream-index":"005"}},"required":["channel_cid","message_id","user_id","created_by_device_id","created_at","updated_at"],"type":"object"},"SharedLocationResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001.011"},"channel_cid":{"description":"Channel CID","title":"string","type":"string","x-stream-index":"001.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.008"},"created_by_device_id":{"description":"Device ID that created the live location","title":"string","type":"string","x-stream-index":"001.006"},"duration":{"type":"string","x-stream-index":"002.001"},"end_at":{"description":"Time when the live location expires","format":"date-time","title":"string","type":"number","x-stream-index":"001.007"},"latitude":{"description":"Latitude coordinate","format":"float","title":"number","type":"number","x-stream-index":"001.004"},"longitude":{"description":"Longitude coordinate","format":"float","title":"number","type":"number","x-stream-index":"001.005"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001.010"},"message_id":{"description":"Message ID","title":"string","type":"string","x-stream-index":"001.002"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.009"},"user_id":{"description":"User ID","title":"string","type":"string","x-stream-index":"001.003"}},"required":["channel_cid","message_id","user_id","latitude","longitude","created_by_device_id","created_at","updated_at","duration"],"type":"object"},"SharedLocationResponseData":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"011"},"channel_cid":{"type":"string","x-stream-index":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"created_by_device_id":{"type":"string","x-stream-index":"006"},"end_at":{"format":"date-time","type":"number","x-stream-index":"007"},"latitude":{"format":"float","type":"number","x-stream-index":"004"},"longitude":{"format":"float","type":"number","x-stream-index":"005"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"010"},"message_id":{"type":"string","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["channel_cid","message_id","user_id","latitude","longitude","created_by_device_id","created_at","updated_at"],"type":"object"},"SharedLocationsResponse":{"nullable":true,"properties":{"active_live_locations":{"items":{"$ref":"#/components/schemas/SharedLocationResponseData"},"type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["active_live_locations","duration"],"type":"object"},"SingleFollowResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"follow":{"$ref":"#/components/schemas/FollowResponse","description":"The created follow relationship","title":"Follow","x-stream-index":"001"}},"required":["follow","duration"],"title":"Follow Response","type":"object"},"SortParam":{"nullable":true,"properties":{"direction":{"format":"int32","type":"integer","x-stream-index":"002"},"field":{"type":"string","x-stream-index":"001"}},"required":["field","direction"],"type":"object"},"SortParamRequest":{"nullable":true,"properties":{"direction":{"description":"Direction of sorting, 1 for Ascending, -1 for Descending, default is 1","format":"int32","title":"Direction","type":"integer","x-stream-index":"002"},"field":{"description":"Name of field to sort by","title":"Field","type":"string","x-stream-index":"001"}},"type":"object"},"StoriesConfig":{"properties":{"expiration_behaviour":{"enum":["hide_for_everyone","visible_for_author"],"type":"string","x-stream-index":"001"},"skip_watched":{"type":"boolean","x-stream-index":"002"}},"type":"object"},"SubmitActionRequest":{"nullable":true,"properties":{"action_type":{"description":"Type of moderation action to perform (mark_reviewed, delete_message, etc.)","enum":["mark_reviewed","delete_message","delete_activity","delete_reaction","ban","custom","unban","restore","delete_user","unblock","shadow_block","unmask","kick_user","end_call"],"title":"Action Type","type":"string","x-stream-index":"002"},"ban":{"$ref":"#/components/schemas/BanActionRequest","description":"Configuration for ban action","title":"Ban","x-stream-index":"008"},"custom":{"$ref":"#/components/schemas/CustomActionRequest","description":"Configuration for custom action","title":"Custom","x-stream-index":"009"},"delete_activity":{"$ref":"#/components/schemas/DeleteActivityRequest","description":"Configuration for activity deletion action","title":"Delete Activity","x-stream-index":"004"},"delete_message":{"$ref":"#/components/schemas/DeleteMessageRequest","description":"Configuration for message deletion action","title":"Delete Message","x-stream-index":"003"},"delete_reaction":{"$ref":"#/components/schemas/DeleteReactionRequest","description":"Configuration for reaction deletion action","title":"Delete Reaction","x-stream-index":"005"},"delete_user":{"$ref":"#/components/schemas/DeleteUserRequest","description":"Configuration for user deletion action","title":"Delete User","x-stream-index":"006"},"item_id":{"description":"UUID of the review queue item to act on","title":"Item ID","type":"string","x-stream-index":"001"},"mark_reviewed":{"$ref":"#/components/schemas/MarkReviewedRequest","description":"Configuration for marking item as reviewed","title":"Mark Reviewed","x-stream-index":"007"},"unban":{"$ref":"#/components/schemas/UnbanActionRequest","description":"Configuration for unban action","title":"Unban","x-stream-index":"010"}},"required":["item_id","action_type"],"type":"object"},"SubmitActionResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"Updated review queue item after action was performed","title":"Item","x-stream-index":"001"}},"required":["duration"],"type":"object"},"TargetResolution":{"properties":{"bitrate":{"format":"int32","maximum":6000000,"type":"integer","x-stream-index":"003"},"height":{"format":"int32","maximum":3840,"minimum":240,"type":"integer","x-stream-index":"002"},"width":{"format":"int32","maximum":3840,"minimum":240,"type":"integer","x-stream-index":"001"}},"required":["width","height","bitrate"],"type":"object"},"TextContentParameters":{"properties":{"blocklist_match":{"items":{"type":"string"},"type":"array","x-stream-index":"005"},"contains_url":{"type":"boolean","x-stream-index":"003"},"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001"},"llm_harm_labels":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"002"},"severity":{"type":"string","x-stream-index":"004"}},"type":"object"},"TextRuleParameters":{"properties":{"blocklist_match":{"items":{"type":"string"},"type":"array","x-stream-index":"007"},"contains_url":{"type":"boolean","x-stream-index":"005"},"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"llm_harm_labels":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"004"},"severity":{"type":"string","x-stream-index":"006"},"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"type":"object"},"ThreadedCommentResponse":{"description":"A comment with an optional, depth‑limited slice of nested replies.","properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"001.011"},"confidence_score":{"format":"float","type":"number","x-stream-index":"001.022"},"controversy_score":{"format":"float","type":"number","x-stream-index":"001.023"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.014"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.006"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.016"},"downvote_count":{"format":"int32","type":"integer","x-stream-index":"001.020"},"id":{"type":"string","x-stream-index":"001.001"},"latest_reactions":{"items":{"$ref":"#/components/schemas/FeedsReactionResponse"},"type":"array","x-stream-index":"001.009"},"mentioned_users":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"001.012"},"meta":{"$ref":"#/components/schemas/RepliesMeta","description":"Pagination \u0026 depth info for this node's direct replies.","title":"Replies Meta","x-stream-index":"002"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"001.017"},"object_id":{"type":"string","x-stream-index":"001.002"},"object_type":{"type":"string","x-stream-index":"001.003"},"own_reactions":{"items":{"$ref":"#/components/schemas/FeedsReactionResponse"},"type":"array","x-stream-index":"001.024"},"parent_id":{"type":"string","x-stream-index":"001.007"},"reaction_count":{"format":"int32","type":"integer","x-stream-index":"001.008"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"001.010"},"replies":{"description":"Slice of nested comments (may be empty).","items":{"$ref":"#/components/schemas/ThreadedCommentResponse"},"title":"Replies","type":"array","x-stream-index":"003"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"001.018"},"score":{"format":"int32","type":"integer","x-stream-index":"001.021"},"status":{"type":"string","x-stream-index":"001.013"},"text":{"type":"string","x-stream-index":"001.005"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.015"},"upvote_count":{"format":"int32","type":"integer","x-stream-index":"001.019"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001.004"}},"required":["id","object_id","object_type","user","reaction_count","mentioned_users","status","created_at","updated_at","reply_count","upvote_count","downvote_count","score","confidence_score","own_reactions"],"title":"Threaded Comment","type":"object"},"Thresholds":{"description":"Sets thresholds for AI moderation","properties":{"explicit":{"$ref":"#/components/schemas/LabelThresholds","description":"Thresholds for explicit messages","title":"LabelThresholds","x-stream-index":"001"},"spam":{"$ref":"#/components/schemas/LabelThresholds","description":"Thresholds for spam","title":"LabelThresholds","x-stream-index":"002"},"toxic":{"$ref":"#/components/schemas/LabelThresholds","description":"Thresholds for toxic messages","title":"LabelThresholds","x-stream-index":"003"}},"title":"Auto moderation thresholds","type":"object"},"ThumbnailResponse":{"properties":{"image_url":{"type":"string","x-stream-index":"001"}},"required":["image_url"],"type":"object"},"ThumbnailsSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"ThumbnailsSettingsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"Time":{"type":"object"},"TranscriptionSettings":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"title":"Mode","type":"string","x-stream-index":"002"},"language":{"description":"The language used in this call as a two letter code","enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"title":"Language","type":"string","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"title":"Mode","type":"string","x-stream-index":"001"}},"required":["mode","closed_caption_mode","languages","language"],"type":"object"},"TranscriptionSettingsResponse":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"002"},"language":{"enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"type":"string","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode","closed_caption_mode","languages","language"],"type":"object"},"TypingIndicators":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"TypingIndicatorsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"UnbanActionRequest":{"type":"object"},"UnblockActionRequest":{"type":"object"},"UnblockUsersRequest":{"nullable":true,"properties":{"blocked_user_id":{"type":"string","x-stream-index":"001"}},"required":["blocked_user_id"],"type":"object"},"UnblockUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"UnfollowResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"follow":{"$ref":"#/components/schemas/FollowResponse","description":"The deleted follow relationship","title":"Follow","x-stream-index":"001"}},"required":["follow","duration"],"title":"Unfollow Response","type":"object"},"UnpinActivityResponse":{"nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","description":"The unpinned activity","title":"Activity","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"004.001"},"feed":{"description":"Fully qualified ID of the feed the activity was unpinned from","title":"Feed ID","type":"string","x-stream-index":"002"},"user_id":{"description":"ID of the user who unpinned the activity","title":"User ID","type":"string","x-stream-index":"003"}},"required":["activity","feed","user_id","duration"],"title":"Unpin Activity Response","type":"object"},"UpdateActivityPartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"description":"Map of dot-notation field paths to new values","title":"object","type":"object","x-stream-index":"002"},"unset":{"description":"List of dot-notation paths to remove","items":{"type":"string"},"title":"[]string","type":"array","x-stream-index":"003"}},"type":"object"},"UpdateActivityPartialResponse":{"nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","description":"The updated activity","title":"ActivityResponse","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["activity","duration"],"type":"object"},"UpdateActivityRequest":{"nullable":true,"properties":{"attachments":{"description":"List of attachments for the activity","items":{"$ref":"#/components/schemas/Attachment"},"title":"[]ActivityAttachment","type":"array","x-stream-index":"003"},"custom":{"additionalProperties":{},"description":"Custom data for the activity","title":"object","type":"object","x-stream-index":"004"},"expires_at":{"description":"Time when the activity will expire","format":"date-time","title":"string","type":"number","x-stream-index":"007"},"filter_tags":{"description":"Tags used for filtering the activity","items":{"type":"string"},"title":"[]string","type":"array","x-stream-index":"008"},"interest_tags":{"description":"Tags indicating interest categories","items":{"type":"string"},"title":"[]string","type":"array","x-stream-index":"009"},"location":{"$ref":"#/components/schemas/ActivityLocation","description":"Geographic location for the activity","title":"ActivityLocation","x-stream-index":"006"},"poll_id":{"description":"Poll ID","title":"string","type":"string","x-stream-index":"010"},"text":{"description":"The text content of the activity","title":"string","type":"string","x-stream-index":"002"},"visibility":{"description":"Visibility setting for the activity","title":"string","type":"string","x-stream-index":"005"}},"type":"object"},"UpdateActivityResponse":{"nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","description":"The updated activity","title":"ActivityResponse","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["activity","duration"],"type":"object"},"UpdateBlockListRequest":{"nullable":true,"properties":{"team":{"type":"string","x-stream-index":"002"},"words":{"description":"List of words to block","items":{"type":"string"},"minimum":1,"title":"Words","type":"array","x-stream-index":"003"}},"title":"Update block list","type":"object","x-stream-docs-page-id":"update_block_list"},"UpdateBlockListResponse":{"description":"Basic response information","nullable":true,"properties":{"blocklist":{"$ref":"#/components/schemas/BlockListResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["duration"],"title":"Response","type":"object"},"UpdateBookmarkFolderRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"description":"Custom data for the folder","title":"Custom Data","type":"object","x-stream-index":"003"},"name":{"description":"Name of the folder","maxLength":255,"title":"Name","type":"string","x-stream-index":"002"}},"title":"Update Bookmark Folder Request","type":"object"},"UpdateBookmarkFolderResponse":{"nullable":true,"properties":{"bookmark_folder":{"$ref":"#/components/schemas/BookmarkFolderResponse","description":"The updated bookmark folder","title":"Bookmark Folder","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["bookmark_folder","duration"],"title":"Update Bookmark Folder Response","type":"object"},"UpdateBookmarkRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"description":"Custom data for the bookmark","title":"Custom Data","type":"object","x-stream-index":"005"},"folder_id":{"description":"ID of the folder to move the bookmark to","maxLength":255,"title":"Folder ID","type":"string","x-stream-index":"002"},"new_folder":{"$ref":"#/components/schemas/AddFolderRequest","x-stream-index":"004"},"new_folder_id":{"maxLength":255,"type":"string","x-stream-index":"003"}},"title":"Update Bookmark Request","type":"object"},"UpdateBookmarkResponse":{"nullable":true,"properties":{"bookmark":{"$ref":"#/components/schemas/BookmarkResponse","description":"The updated bookmark","title":"Bookmark","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["bookmark","duration"],"title":"Update Bookmark Response","type":"object"},"UpdateCommentRequest":{"nullable":true,"properties":{"comment":{"description":"Updated text content of the comment","title":"Comment","type":"string","x-stream-index":"002"},"custom":{"additionalProperties":{},"description":"Updated custom data for the comment","title":"Custom Data","type":"object","x-stream-index":"003"},"skip_push":{"type":"boolean","x-stream-index":"004"}},"title":"Update Comment Request","type":"object"},"UpdateCommentResponse":{"nullable":true,"properties":{"comment":{"$ref":"#/components/schemas/CommentResponse","description":"The updated comment","title":"Comment","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["comment","duration"],"title":"Update Comment Response","type":"object"},"UpdateFeedMembersRequest":{"nullable":true,"properties":{"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"006.001"},"members":{"description":"List of members to upsert, remove, or set","items":{"$ref":"#/components/schemas/FeedMemberRequest"},"title":"Members","type":"array","x-stream-index":"004"},"next":{"type":"string","x-stream-index":"006.002"},"operation":{"description":"Type of update operation to perform","enum":["upsert","remove","set"],"title":"Operation","type":"string","x-stream-index":"003"},"prev":{"type":"string","x-stream-index":"006.003"}},"required":["operation"],"title":"Update Feed Members Request","type":"object"},"UpdateFeedMembersResponse":{"description":"Basic response information","nullable":true,"properties":{"added":{"items":{"$ref":"#/components/schemas/FeedMemberResponse"},"type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"004.001"},"removed_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"updated":{"items":{"$ref":"#/components/schemas/FeedMemberResponse"},"type":"array","x-stream-index":"002"}},"required":["added","updated","removed_ids","duration"],"title":"Response","type":"object"},"UpdateFeedRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"description":"Custom data for the feed","title":"Custom Data","type":"object","x-stream-index":"004"}},"title":"Update Feed Request","type":"object"},"UpdateFeedResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"feed":{"$ref":"#/components/schemas/FeedResponse","description":"The updated feed","title":"Feed","x-stream-index":"001"}},"required":["feed","duration"],"title":"Update Feed Response","type":"object"},"UpdateFollowRequest":{"nullable":true,"properties":{"create_notification_activity":{"description":"Whether to create a notification activity for this follow","title":"Create Notification Activity","type":"boolean","x-stream-index":"001.004"},"custom":{"additionalProperties":{},"description":"Custom data for the follow relationship","title":"Custom Data","type":"object","x-stream-index":"001.002"},"follower_role":{"type":"string","x-stream-index":"002"},"push_preference":{"description":"Push preference for the follow relationship","enum":["all","none"],"title":"Push Preference","type":"string","x-stream-index":"001.003"},"skip_push":{"type":"boolean","x-stream-index":"001.005"},"source":{"description":"Fully qualified ID of the source feed","maxLength":255,"title":"Source Feed","type":"string","x-stream-index":"001.001.001"},"target":{"description":"Fully qualified ID of the target feed","maxLength":255,"title":"Target Feed","type":"string","x-stream-index":"001.001.002"}},"required":["source","target"],"title":"Update Follow Request","type":"object"},"UpdateFollowResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"follow":{"$ref":"#/components/schemas/FollowResponse","description":"Details of the updated follow relationship","title":"Follow","x-stream-index":"001"}},"required":["follow","duration"],"title":"Update Follow Response","type":"object"},"UpdateLiveLocationRequest":{"nullable":true,"properties":{"end_at":{"description":"Time when the live location expires","format":"date-time","title":"string","type":"number","x-stream-index":"004"},"latitude":{"description":"Latitude coordinate","format":"float","maximum":90,"minimum":18446744073709552000,"title":"number","type":"number","x-stream-index":"002"},"longitude":{"description":"Longitude coordinate","format":"float","maximum":180,"minimum":18446744073709552000,"title":"number","type":"number","x-stream-index":"003"},"message_id":{"description":"Live location ID","title":"string","type":"string","x-stream-index":"001"}},"required":["message_id"],"type":"object"},"UpdatePollOptionRequest":{"nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"004"},"id":{"description":"Option ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"},"text":{"description":"Option text","title":"string","type":"string","x-stream-index":"003"}},"required":["id","text"],"type":"object"},"UpdatePollPartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"description":"Sets new field values","title":"Set","type":"object","x-stream-index":"002.001","x-stream-map":{"key":"field","title":"Value","description":"New value to set"}},"unset":{"description":"Array of field names to unset","items":{"type":"string"},"title":"Unset","type":"array","x-stream-index":"002.002"}},"type":"object"},"UpdatePollRequest":{"nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"011"},"allow_answers":{"description":"Allow answers","title":"boolean","type":"boolean","x-stream-index":"009"},"allow_user_suggested_options":{"description":"Allow user suggested options","title":"boolean","type":"boolean","x-stream-index":"008"},"description":{"description":"Poll description","title":"string","type":"string","x-stream-index":"003"},"enforce_unique_vote":{"description":"Enforce unique vote","title":"boolean","type":"boolean","x-stream-index":"005"},"id":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"},"is_closed":{"description":"Is closed","title":"boolean","type":"boolean","x-stream-index":"010"},"max_votes_allowed":{"description":"Max votes allowed","format":"int32","maximum":10,"title":"integer","type":"integer","x-stream-index":"007"},"name":{"description":"Poll name","title":"string","type":"string","x-stream-index":"002"},"options":{"description":"Poll options","items":{"$ref":"#/components/schemas/PollOptionRequest"},"maximum":100,"title":"PollOptions","type":"array","x-stream-index":"004"},"voting_visibility":{"description":"Voting visibility","enum":["anonymous","public"],"title":"string","type":"string","x-stream-index":"006"}},"required":["id","name"],"type":"object"},"UpdateUserPartialRequest":{"properties":{"id":{"description":"User ID to update","title":"ID","type":"string","x-stream-index":"001"},"set":{"additionalProperties":{},"type":"object","x-stream-index":"002.001"},"unset":{"items":{"type":"string"},"type":"array","x-stream-index":"002.002"}},"required":["id"],"type":"object"},"UpdateUsersPartialRequest":{"nullable":true,"properties":{"users":{"items":{"$ref":"#/components/schemas/UpdateUserPartialRequest"},"maximum":100,"type":"array","x-stream-index":"001"}},"required":["users"],"type":"object"},"UpdateUsersRequest":{"nullable":true,"properties":{"users":{"additionalProperties":{"$ref":"#/components/schemas/UserRequest"},"description":"Object containing users","title":"Users","type":"object","x-stream-index":"001","x-stream-map":{"key":"user_id"}}},"required":["users"],"type":"object"},"UpdateUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"membership_deletion_task_id":{"type":"string","x-stream-index":"002"},"users":{"additionalProperties":{"$ref":"#/components/schemas/FullUserResponse"},"description":"Object containing users","title":"Users","type":"object","x-stream-index":"001","x-stream-map":{"key":"user_id"}}},"required":["users","membership_deletion_task_id","duration"],"type":"object"},"UpsertActivitiesRequest":{"nullable":true,"properties":{"activities":{"description":"List of activities to create or update","items":{"$ref":"#/components/schemas/ActivityRequest"},"maximum":100,"minimum":1,"title":"Activities","type":"array","x-stream-index":"001"}},"required":["activities"],"title":"Upsert Activities Request","type":"object"},"UpsertActivitiesResponse":{"nullable":true,"properties":{"activities":{"description":"List of created or updated activities","items":{"$ref":"#/components/schemas/ActivityResponse"},"title":"Activities","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["activities","duration"],"title":"Upsert Activities Response","type":"object"},"UpsertConfigRequest":{"nullable":true,"properties":{"ai_image_config":{"$ref":"#/components/schemas/AIImageConfig","description":"Configuration for AI image analysis","title":"AI Image Config","x-stream-index":"011"},"ai_text_config":{"$ref":"#/components/schemas/AITextConfig","description":"Configuration for AI text analysis","title":"AI Text Config","x-stream-index":"008"},"ai_video_config":{"$ref":"#/components/schemas/AIVideoConfig","description":"Configuration for AI video analysis","title":"AI Video Config","x-stream-index":"012"},"async":{"description":"Whether moderation should be performed asynchronously","title":"Async","type":"boolean","x-stream-index":"003"},"automod_platform_circumvention_config":{"$ref":"#/components/schemas/AutomodPlatformCircumventionConfig","description":"Configuration for platform circumvention detection","title":"Automod Platform Circumvention Config","x-stream-index":"005"},"automod_semantic_filters_config":{"$ref":"#/components/schemas/AutomodSemanticFiltersConfig","description":"Configuration for semantic filtering","title":"Automod Semantic Filters Config","x-stream-index":"006"},"automod_toxicity_config":{"$ref":"#/components/schemas/AutomodToxicityConfig","description":"Configuration for toxicity detection","title":"Automod Toxicity Config","x-stream-index":"004"},"aws_rekognition_config":{"$ref":"#/components/schemas/AIImageConfig","x-stream-index":"016"},"block_list_config":{"$ref":"#/components/schemas/BlockListConfig","description":"Configuration for block list filtering","title":"Block List Config","x-stream-index":"007"},"bodyguard_config":{"$ref":"#/components/schemas/AITextConfig","x-stream-index":"015"},"google_vision_config":{"$ref":"#/components/schemas/GoogleVisionConfig","description":"Configuration for Google Vision integration","title":"Google Vision Config","x-stream-index":"010"},"key":{"description":"Unique identifier for the moderation configuration","title":"Key","type":"string","x-stream-index":"001"},"llm_config":{"$ref":"#/components/schemas/LLMConfig","description":"Configuration for customer-configured LLM moderation","title":"LLM Config","x-stream-index":"009"},"rule_builder_config":{"$ref":"#/components/schemas/RuleBuilderConfig","description":"Configuration for custom rule builder (max 3 rules, max 5 conditions per rule)","title":"Rule Builder Config","x-stream-index":"014"},"team":{"description":"Team associated with the configuration","maxLength":128,"minLength":1,"title":"Team","type":"string","x-stream-index":"002"},"velocity_filter_config":{"$ref":"#/components/schemas/VelocityFilterConfig","description":"Configuration for velocity-based filtering","title":"Velocity Filter Config","x-stream-index":"013"},"video_call_rule_config":{"$ref":"#/components/schemas/VideoCallRuleConfig","x-stream-index":"017"}},"required":["key"],"type":"object"},"UpsertConfigResponse":{"nullable":true,"properties":{"config":{"$ref":"#/components/schemas/ConfigResponse","description":"The created or updated moderation configuration","title":"Config","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["duration"],"type":"object"},"User":{"properties":{"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"046"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"017"},"banned":{"type":"boolean","x-stream-index":"016"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"013"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"023"},"language":{"type":"string","x-stream-index":"035"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"026"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"042"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"005"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"009"}},"required":["id","role","teams_role","custom","banned","online"],"type":"object"},"UserBannedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"006.002"},"channel_type":{"type":"string","x-stream-index":"006.003"},"cid":{"type":"string","x-stream-index":"006.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008.002"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"001"},"expiration":{"format":"date-time","type":"number","x-stream-index":"003"},"reason":{"type":"string","x-stream-index":"004"},"shadow":{"type":"boolean","x-stream-index":"002"},"team":{"type":"string","x-stream-index":"005.001"},"type":{"default":"user.banned","type":"string","x-stream-index":"008.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007.001"}},"required":["created_by","shadow","cid","channel_id","channel_type","type","created_at"],"title":"UserBannedEvent","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"},"UserCreatedWithinParameters":{"properties":{"max_age":{"type":"string","x-stream-index":"001"}},"type":"object"},"UserCustomPropertyParameters":{"properties":{"operator":{"type":"string","x-stream-index":"002"},"property_key":{"type":"string","x-stream-index":"001"}},"type":"object"},"UserDeactivatedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"001"},"type":{"default":"user.deactivated","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["created_by","type","created_at"],"title":"UserDeactivatedEvent","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"},"UserMute":{"nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"expires":{"description":"Date/time of mute expiration","format":"date-time","title":"Expires","type":"number","x-stream-index":"008"},"target":{"$ref":"#/components/schemas/User","description":"User who's muted","title":"Target","x-stream-index":"007"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/User","description":"Owner of channel mute","title":"User","x-stream-index":"005"}},"required":["created_at","updated_at"],"type":"object"},"UserMuteResponse":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"expires":{"format":"date-time","type":"number","x-stream-index":"003"},"target":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"}},"required":["created_at","updated_at"],"type":"object"},"UserMutedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"target_user":{"type":"string","x-stream-index":"001"},"target_users":{"items":{"type":"string"},"type":"array","x-stream-index":"002"},"type":{"default":"user.muted","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"UserMutedEvent","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"},"UserReactivatedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"type":{"default":"user.reactivated","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"001"}},"required":["type","created_at"],"title":"UserReactivatedEvent","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"},"UserRequest":{"description":"User request object","properties":{"custom":{"additionalProperties":{},"description":"Custom user data","title":"Custom","type":"object","x-stream-index":"004"},"id":{"description":"User ID","title":"ID","type":"string","x-stream-index":"001"},"image":{"description":"User's profile image URL","title":"Image","type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"006"},"language":{"type":"string","x-stream-index":"005"},"name":{"description":"Optional name of user","title":"Name","type":"string","x-stream-index":"002"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"007"}},"required":["id"],"title":"UserRequest","type":"object"},"UserResponse":{"description":"User response object","properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"banned":{"description":"Whether a user is banned or not","title":"Banned","type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.017"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"001.004"},"deactivated_at":{"description":"Date of deactivation","format":"date-time","title":"Deactivated at","type":"number","x-stream-index":"001.016"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"001.011"},"id":{"description":"Unique user identifier","title":"ID","type":"string","x-stream-index":"001.001"},"image":{"title":"Image","type":"string","x-stream-index":"001.003"},"language":{"description":"Preferred language of a user","title":"Language","type":"string","x-stream-index":"001.005"},"last_active":{"description":"Date of last activity","format":"date-time","title":"Last active","type":"number","x-stream-index":"001.014"},"name":{"description":"Optional name of user","title":"Name","type":"string","x-stream-index":"001.002"},"online":{"description":"Whether a user online or not","title":"Online","type":"boolean","x-stream-index":"001.013"},"revoke_tokens_issued_before":{"description":"Revocation date for tokens","format":"date-time","title":"Revoke tokens issued before","type":"number","x-stream-index":"001.015"},"role":{"description":"Determines the set of user permissions","title":"Role","type":"string","x-stream-index":"001.006"},"teams":{"description":"List of teams user is a part of","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids","shadow_banned","invisible"],"title":"UserResponse","type":"object"},"UserResponseCommonFields":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"018"},"banned":{"type":"boolean","x-stream-index":"012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"017"},"created_at":{"format":"date-time","type":"number","x-stream-index":"009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"id":{"type":"string","x-stream-index":"001"},"image":{"type":"string","x-stream-index":"003"},"language":{"type":"string","x-stream-index":"005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"014"},"name":{"type":"string","x-stream-index":"002"},"online":{"type":"boolean","x-stream-index":"013"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"015"},"role":{"type":"string","x-stream-index":"006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids"],"type":"object"},"UserResponsePrivacyFields":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"banned":{"type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.017"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.011"},"id":{"type":"string","x-stream-index":"001.001"},"image":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"003"},"language":{"type":"string","x-stream-index":"001.005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"001.014"},"name":{"type":"string","x-stream-index":"001.002"},"online":{"type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"002"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.015"},"role":{"type":"string","x-stream-index":"001.006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids"],"type":"object"},"UserRuleParameters":{"properties":{"max_age":{"type":"string","x-stream-index":"001"}},"type":"object"},"UserUpdatedEvent":{"description":"This event is sent when a user gets updated. The event contains information about the updated user.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"type":{"default":"user.updated","description":"The type of event: \"user.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.002"},"user":{"$ref":"#/components/schemas/UserResponsePrivacyFields","description":"The updated user","title":"User","x-stream-index":"002.001"}},"required":["type","created_at","custom","user"],"title":"UserUpdatedEvent","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"},"VelocityFilterConfig":{"properties":{"advanced_filters":{"type":"boolean","x-stream-index":"007"},"async":{"type":"boolean","x-stream-index":"001"},"cascading_actions":{"type":"boolean","x-stream-index":"004"},"cids_per_user":{"format":"int32","type":"integer","x-stream-index":"006"},"enabled":{"type":"boolean","x-stream-index":"002"},"first_message_only":{"type":"boolean","x-stream-index":"005"},"rules":{"items":{"$ref":"#/components/schemas/VelocityFilterConfigRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules","cascading_actions","first_message_only","cids_per_user","advanced_filters"],"type":"object"},"VelocityFilterConfigRule":{"properties":{"action":{"enum":["flag","shadow","remove","ban"],"type":"string","x-stream-index":"001"},"ban_duration":{"format":"int32","type":"integer","x-stream-index":"002"},"cascading_action":{"enum":["flag","shadow","remove","ban"],"type":"string","x-stream-index":"006"},"cascading_threshold":{"format":"int64","type":"integer","x-stream-index":"005"},"check_message_context":{"type":"boolean","x-stream-index":"009"},"fast_spam_threshold":{"format":"int32","type":"integer","x-stream-index":"007"},"fast_spam_ttl":{"format":"int32","type":"integer","x-stream-index":"010"},"ip_ban":{"type":"boolean","x-stream-index":"004"},"probation_period":{"format":"int32","type":"integer","x-stream-index":"014"},"shadow_ban":{"type":"boolean","x-stream-index":"003"},"slow_spam_ban_duration":{"format":"int32","type":"integer","x-stream-index":"012"},"slow_spam_threshold":{"format":"int32","type":"integer","x-stream-index":"008"},"slow_spam_ttl":{"format":"int32","type":"integer","x-stream-index":"011"},"url_only":{"type":"boolean","x-stream-index":"013"}},"required":["action","ban_duration","shadow_ban","ip_ban","cascading_threshold","cascading_action","fast_spam_threshold","slow_spam_threshold","check_message_context","fast_spam_ttl","slow_spam_ttl","url_only","probation_period"],"type":"object"},"VideoCallRuleConfig":{"properties":{"rules":{"additionalProperties":{"$ref":"#/components/schemas/HarmConfig"},"type":"object","x-stream-index":"001"}},"required":["rules"],"type":"object"},"VideoContentParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"type":"object"},"VideoEndCallRequest":{"type":"object"},"VideoKickUserRequest":{"type":"object"},"VideoOrientation":{"properties":{"orientation":{"type":"integer","x-stream-index":"004"}},"type":"object"},"VideoRuleParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"type":"object"},"VideoSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"camera_default_on":{"type":"boolean","x-stream-index":"004"},"camera_facing":{"enum":["front","back","external"],"type":"string","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled","target_resolution","camera_default_on","camera_facing"],"type":"object"},"VideoSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"camera_default_on":{"type":"boolean","x-stream-index":"004"},"camera_facing":{"enum":["front","back","external"],"type":"string","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled","target_resolution","camera_default_on","camera_facing"],"type":"object"},"VoteData":{"properties":{"answer_text":{"type":"string","x-stream-index":"002"},"option_id":{"maxLength":255,"type":"string","x-stream-index":"001"}},"type":"object"},"WSAuthMessage":{"description":"Websocket auth message","nullable":true,"properties":{"products":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"token":{"title":"Token","type":"string","x-stream-index":"002"},"user_details":{"$ref":"#/components/schemas/ConnectUserDetailsRequest","x-stream-index":"001"}},"required":["user_details","token"],"title":"WSAuthMessage","type":"object"},"WSClientEvent":{"description":"The discriminator object for all websocket client events, it maps events' payload to the final type","discriminator":{"mapping":{"app.updated":"#/components/schemas/AppUpdatedEvent","feeds.activity.added":"#/components/schemas/ActivityAddedEvent","feeds.activity.deleted":"#/components/schemas/ActivityDeletedEvent","feeds.activity.marked":"#/components/schemas/ActivityMarkEvent","feeds.activity.pinned":"#/components/schemas/ActivityPinnedEvent","feeds.activity.reaction.added":"#/components/schemas/ActivityReactionAddedEvent","feeds.activity.reaction.deleted":"#/components/schemas/ActivityReactionDeletedEvent","feeds.activity.reaction.updated":"#/components/schemas/ActivityReactionUpdatedEvent","feeds.activity.removed_from_feed":"#/components/schemas/ActivityRemovedFromFeedEvent","feeds.activity.unpinned":"#/components/schemas/ActivityUnpinnedEvent","feeds.activity.updated":"#/components/schemas/ActivityUpdatedEvent","feeds.bookmark.added":"#/components/schemas/BookmarkAddedEvent","feeds.bookmark.deleted":"#/components/schemas/BookmarkDeletedEvent","feeds.bookmark.updated":"#/components/schemas/BookmarkUpdatedEvent","feeds.bookmark_folder.deleted":"#/components/schemas/BookmarkFolderDeletedEvent","feeds.bookmark_folder.updated":"#/components/schemas/BookmarkFolderUpdatedEvent","feeds.comment.added":"#/components/schemas/CommentAddedEvent","feeds.comment.deleted":"#/components/schemas/CommentDeletedEvent","feeds.comment.reaction.added":"#/components/schemas/CommentReactionAddedEvent","feeds.comment.reaction.deleted":"#/components/schemas/CommentReactionDeletedEvent","feeds.comment.reaction.updated":"#/components/schemas/CommentReactionUpdatedEvent","feeds.comment.updated":"#/components/schemas/CommentUpdatedEvent","feeds.feed.created":"#/components/schemas/FeedCreatedEvent","feeds.feed.deleted":"#/components/schemas/FeedDeletedEvent","feeds.feed.updated":"#/components/schemas/FeedUpdatedEvent","feeds.feed_group.changed":"#/components/schemas/FeedGroupChangedEvent","feeds.feed_group.deleted":"#/components/schemas/FeedGroupDeletedEvent","feeds.feed_member.added":"#/components/schemas/FeedMemberAddedEvent","feeds.feed_member.removed":"#/components/schemas/FeedMemberRemovedEvent","feeds.feed_member.updated":"#/components/schemas/FeedMemberUpdatedEvent","feeds.follow.created":"#/components/schemas/FollowCreatedEvent","feeds.follow.deleted":"#/components/schemas/FollowDeletedEvent","feeds.follow.updated":"#/components/schemas/FollowUpdatedEvent","feeds.notification_feed.updated":"#/components/schemas/NotificationFeedUpdatedEvent","feeds.poll.closed":"#/components/schemas/PollClosedFeedEvent","feeds.poll.deleted":"#/components/schemas/PollDeletedFeedEvent","feeds.poll.updated":"#/components/schemas/PollUpdatedFeedEvent","feeds.poll.vote_casted":"#/components/schemas/PollVoteCastedFeedEvent","feeds.poll.vote_changed":"#/components/schemas/PollVoteChangedFeedEvent","feeds.poll.vote_removed":"#/components/schemas/PollVoteRemovedFeedEvent","health.check":"#/components/schemas/HealthCheckEvent","user.updated":"#/components/schemas/UserUpdatedEvent"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/ActivityAddedEvent"},{"$ref":"#/components/schemas/ActivityDeletedEvent"},{"$ref":"#/components/schemas/ActivityMarkEvent"},{"$ref":"#/components/schemas/ActivityPinnedEvent"},{"$ref":"#/components/schemas/ActivityReactionAddedEvent"},{"$ref":"#/components/schemas/ActivityReactionDeletedEvent"},{"$ref":"#/components/schemas/ActivityReactionUpdatedEvent"},{"$ref":"#/components/schemas/ActivityRemovedFromFeedEvent"},{"$ref":"#/components/schemas/ActivityUnpinnedEvent"},{"$ref":"#/components/schemas/ActivityUpdatedEvent"},{"$ref":"#/components/schemas/AppUpdatedEvent"},{"$ref":"#/components/schemas/BookmarkAddedEvent"},{"$ref":"#/components/schemas/BookmarkDeletedEvent"},{"$ref":"#/components/schemas/BookmarkFolderDeletedEvent"},{"$ref":"#/components/schemas/BookmarkFolderUpdatedEvent"},{"$ref":"#/components/schemas/BookmarkUpdatedEvent"},{"$ref":"#/components/schemas/CommentAddedEvent"},{"$ref":"#/components/schemas/CommentDeletedEvent"},{"$ref":"#/components/schemas/CommentReactionAddedEvent"},{"$ref":"#/components/schemas/CommentReactionDeletedEvent"},{"$ref":"#/components/schemas/CommentReactionUpdatedEvent"},{"$ref":"#/components/schemas/CommentUpdatedEvent"},{"$ref":"#/components/schemas/FeedCreatedEvent"},{"$ref":"#/components/schemas/FeedDeletedEvent"},{"$ref":"#/components/schemas/FeedGroupChangedEvent"},{"$ref":"#/components/schemas/FeedGroupDeletedEvent"},{"$ref":"#/components/schemas/FeedMemberAddedEvent"},{"$ref":"#/components/schemas/FeedMemberRemovedEvent"},{"$ref":"#/components/schemas/FeedMemberUpdatedEvent"},{"$ref":"#/components/schemas/FeedUpdatedEvent"},{"$ref":"#/components/schemas/FollowCreatedEvent"},{"$ref":"#/components/schemas/FollowDeletedEvent"},{"$ref":"#/components/schemas/FollowUpdatedEvent"},{"$ref":"#/components/schemas/HealthCheckEvent"},{"$ref":"#/components/schemas/NotificationFeedUpdatedEvent"},{"$ref":"#/components/schemas/PollClosedFeedEvent"},{"$ref":"#/components/schemas/PollDeletedFeedEvent"},{"$ref":"#/components/schemas/PollUpdatedFeedEvent"},{"$ref":"#/components/schemas/PollVoteCastedFeedEvent"},{"$ref":"#/components/schemas/PollVoteChangedFeedEvent"},{"$ref":"#/components/schemas/PollVoteRemovedFeedEvent"},{"$ref":"#/components/schemas/UserUpdatedEvent"}]},"WSEvent":{"description":"The discriminator object for all websocket events, it maps events' payload to the final type","discriminator":{"mapping":{"app.updated":"#/components/schemas/AppUpdatedEvent","feeds.activity.added":"#/components/schemas/ActivityAddedEvent","feeds.activity.deleted":"#/components/schemas/ActivityDeletedEvent","feeds.activity.marked":"#/components/schemas/ActivityMarkEvent","feeds.activity.pinned":"#/components/schemas/ActivityPinnedEvent","feeds.activity.reaction.added":"#/components/schemas/ActivityReactionAddedEvent","feeds.activity.reaction.deleted":"#/components/schemas/ActivityReactionDeletedEvent","feeds.activity.reaction.updated":"#/components/schemas/ActivityReactionUpdatedEvent","feeds.activity.removed_from_feed":"#/components/schemas/ActivityRemovedFromFeedEvent","feeds.activity.unpinned":"#/components/schemas/ActivityUnpinnedEvent","feeds.activity.updated":"#/components/schemas/ActivityUpdatedEvent","feeds.bookmark.added":"#/components/schemas/BookmarkAddedEvent","feeds.bookmark.deleted":"#/components/schemas/BookmarkDeletedEvent","feeds.bookmark.updated":"#/components/schemas/BookmarkUpdatedEvent","feeds.bookmark_folder.deleted":"#/components/schemas/BookmarkFolderDeletedEvent","feeds.bookmark_folder.updated":"#/components/schemas/BookmarkFolderUpdatedEvent","feeds.comment.added":"#/components/schemas/CommentAddedEvent","feeds.comment.deleted":"#/components/schemas/CommentDeletedEvent","feeds.comment.reaction.added":"#/components/schemas/CommentReactionAddedEvent","feeds.comment.reaction.deleted":"#/components/schemas/CommentReactionDeletedEvent","feeds.comment.reaction.updated":"#/components/schemas/CommentReactionUpdatedEvent","feeds.comment.updated":"#/components/schemas/CommentUpdatedEvent","feeds.feed.created":"#/components/schemas/FeedCreatedEvent","feeds.feed.deleted":"#/components/schemas/FeedDeletedEvent","feeds.feed.updated":"#/components/schemas/FeedUpdatedEvent","feeds.feed_group.changed":"#/components/schemas/FeedGroupChangedEvent","feeds.feed_group.deleted":"#/components/schemas/FeedGroupDeletedEvent","feeds.feed_member.added":"#/components/schemas/FeedMemberAddedEvent","feeds.feed_member.removed":"#/components/schemas/FeedMemberRemovedEvent","feeds.feed_member.updated":"#/components/schemas/FeedMemberUpdatedEvent","feeds.follow.created":"#/components/schemas/FollowCreatedEvent","feeds.follow.deleted":"#/components/schemas/FollowDeletedEvent","feeds.follow.updated":"#/components/schemas/FollowUpdatedEvent","feeds.notification_feed.updated":"#/components/schemas/NotificationFeedUpdatedEvent","feeds.poll.closed":"#/components/schemas/PollClosedFeedEvent","feeds.poll.deleted":"#/components/schemas/PollDeletedFeedEvent","feeds.poll.updated":"#/components/schemas/PollUpdatedFeedEvent","feeds.poll.vote_casted":"#/components/schemas/PollVoteCastedFeedEvent","feeds.poll.vote_changed":"#/components/schemas/PollVoteChangedFeedEvent","feeds.poll.vote_removed":"#/components/schemas/PollVoteRemovedFeedEvent","health.check":"#/components/schemas/HealthCheckEvent","moderation.custom_action":"#/components/schemas/ModerationCustomActionEvent","moderation.flagged":"#/components/schemas/ModerationFlaggedEvent","moderation.mark_reviewed":"#/components/schemas/ModerationMarkReviewedEvent","user.banned":"#/components/schemas/UserBannedEvent","user.deactivated":"#/components/schemas/UserDeactivatedEvent","user.muted":"#/components/schemas/UserMutedEvent","user.reactivated":"#/components/schemas/UserReactivatedEvent","user.updated":"#/components/schemas/UserUpdatedEvent"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/ActivityAddedEvent"},{"$ref":"#/components/schemas/ActivityDeletedEvent"},{"$ref":"#/components/schemas/ActivityMarkEvent"},{"$ref":"#/components/schemas/ActivityPinnedEvent"},{"$ref":"#/components/schemas/ActivityReactionAddedEvent"},{"$ref":"#/components/schemas/ActivityReactionDeletedEvent"},{"$ref":"#/components/schemas/ActivityReactionUpdatedEvent"},{"$ref":"#/components/schemas/ActivityRemovedFromFeedEvent"},{"$ref":"#/components/schemas/ActivityUnpinnedEvent"},{"$ref":"#/components/schemas/ActivityUpdatedEvent"},{"$ref":"#/components/schemas/AppUpdatedEvent"},{"$ref":"#/components/schemas/BookmarkAddedEvent"},{"$ref":"#/components/schemas/BookmarkDeletedEvent"},{"$ref":"#/components/schemas/BookmarkFolderDeletedEvent"},{"$ref":"#/components/schemas/BookmarkFolderUpdatedEvent"},{"$ref":"#/components/schemas/BookmarkUpdatedEvent"},{"$ref":"#/components/schemas/CommentAddedEvent"},{"$ref":"#/components/schemas/CommentDeletedEvent"},{"$ref":"#/components/schemas/CommentReactionAddedEvent"},{"$ref":"#/components/schemas/CommentReactionDeletedEvent"},{"$ref":"#/components/schemas/CommentReactionUpdatedEvent"},{"$ref":"#/components/schemas/CommentUpdatedEvent"},{"$ref":"#/components/schemas/FeedCreatedEvent"},{"$ref":"#/components/schemas/FeedDeletedEvent"},{"$ref":"#/components/schemas/FeedGroupChangedEvent"},{"$ref":"#/components/schemas/FeedGroupDeletedEvent"},{"$ref":"#/components/schemas/FeedMemberAddedEvent"},{"$ref":"#/components/schemas/FeedMemberRemovedEvent"},{"$ref":"#/components/schemas/FeedMemberUpdatedEvent"},{"$ref":"#/components/schemas/FeedUpdatedEvent"},{"$ref":"#/components/schemas/FollowCreatedEvent"},{"$ref":"#/components/schemas/FollowDeletedEvent"},{"$ref":"#/components/schemas/FollowUpdatedEvent"},{"$ref":"#/components/schemas/HealthCheckEvent"},{"$ref":"#/components/schemas/ModerationCustomActionEvent"},{"$ref":"#/components/schemas/ModerationFlaggedEvent"},{"$ref":"#/components/schemas/ModerationMarkReviewedEvent"},{"$ref":"#/components/schemas/NotificationFeedUpdatedEvent"},{"$ref":"#/components/schemas/PollClosedFeedEvent"},{"$ref":"#/components/schemas/PollDeletedFeedEvent"},{"$ref":"#/components/schemas/PollUpdatedFeedEvent"},{"$ref":"#/components/schemas/PollVoteCastedFeedEvent"},{"$ref":"#/components/schemas/PollVoteChangedFeedEvent"},{"$ref":"#/components/schemas/PollVoteRemovedFeedEvent"},{"$ref":"#/components/schemas/UserBannedEvent"},{"$ref":"#/components/schemas/UserDeactivatedEvent"},{"$ref":"#/components/schemas/UserMutedEvent"},{"$ref":"#/components/schemas/UserReactivatedEvent"},{"$ref":"#/components/schemas/UserUpdatedEvent"}]}},"securitySchemes":{"JWT":{"description":"JWT should be always provided when stream-auth-type=jwt.\n\nUsing JWT auth request could be authenticated as user or as server-side.\n\nWhen using user authentication permission checking is going to be applied to requests based on the user that is\nperforming a request.\n\nThe `authorization` header should be a JWT string signed using the secret attached to the API key used to perform\nrequests.\n\n**WARNING** all client-side official SDK do not ship with token generation; this is to make sure that the API secret is not\nshared with an untrusted party such as a browser or a iOS/Android application. Tokens **must** be generated server-side.\nIf you wish, you can configure your application to ignore authentication (see `disable_auth_check`)\nThe JWT string must include only the user_id claim and can include any built-in JWT claim such as iat, exp as well.\n","in":"header","name":"Authorization","type":"apiKey"},"api_key":{"description":"Application API key should be always set in order to authenticate the request.","in":"query","name":"api_key","type":"apiKey"},"stream-auth-type":{"description":"Stream-Auth-Type should be always set in order to authenticate the request. Possible\nvalues: `jwt` or `anonymous`.\n\n`jwt` allows you to authenticate as a user. With this auth type you should also provide valid JWT in Authorization\nheader.\n\n`anonymous` allows you to authenticate as anonymous user. Please note that most advanced features are not available\nto anonymous users.","in":"header","name":"Stream-Auth-Type","type":"apiKey"}}},"info":{"title":"Stream API","version":"v191.1.0"},"openapi":"3.0.3","paths":{"/api/v2/app":{"get":{"description":"This Method returns the application settings\n","operationId":"GetApp","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetApplicationResponse"}}},"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":"Get App Settings","tags":["product:common"]}},"/api/v2/blocklists":{"get":{"description":"Returns all available block lists\n","operationId":"ListBlockLists","parameters":[{"in":"query","name":"team","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListBlockListResponse"}}},"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":"List block lists","tags":["product:common"]},"post":{"description":"Creates a new application blocklist, once created the blocklist can be used by any channel type\n","operationId":"CreateBlockList","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBlockListRequest"}}},"description":"Block list","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBlockListResponse"}}},"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":"Create block list","tags":["product:common"]}},"/api/v2/blocklists/{name}":{"delete":{"description":"Deletes previously created application blocklist\n","operationId":"DeleteBlockList","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"team","schema":{"type":"string","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete block list","tags":["product:common"]},"put":{"description":"Updates contents of the block list\n","operationId":"UpdateBlockList","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Block list name","title":"Name","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBlockListRequest"}}},"description":"Update block list","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBlockListResponse"}}},"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":"Update block list","tags":["product:common"]}},"/api/v2/devices":{"delete":{"description":"Deletes one device\n","operationId":"DeleteDevice","parameters":[{"in":"query","name":"id","required":true,"schema":{"description":"Device ID to delete","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete device","tags":["product:common"]},"get":{"description":"Returns all available devices\n","operationId":"ListDevices","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDevicesResponse"}}},"description":"ListDevicesResponse"},"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":"List devices","tags":["product:common"]},"post":{"description":"Adds a new device to a user, if the same device already exists the call will have no effect\n","operationId":"CreateDevice","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDeviceRequest"}}},"description":"CreateDeviceRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Create device","tags":["product:common"]}},"/api/v2/feeds/activities":{"post":{"description":"Create a new activity or update an existing one\n","operationId":"AddActivity","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddActivityRequest"}}},"description":"Activity Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddActivityResponse"}}},"description":"Add Activity 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":"Add a single activity","tags":["product:feeds"]}},"/api/v2/feeds/activities/batch":{"post":{"description":"Create new activities or update existing ones in a batch operation\n","operationId":"UpsertActivities","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertActivitiesRequest"}}},"description":"Upsert Activities Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertActivitiesResponse"}}},"description":"Upsert Activities 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":"Upsert multiple activities","tags":["product:feeds"]}},"/api/v2/feeds/activities/delete":{"post":{"description":"Delete one or more activities by their IDs\n","operationId":"DeleteActivities","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteActivitiesRequest"}}},"description":"Delete Activities Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteActivitiesResponse"}}},"description":"Delete Activities 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":"Remove multiple activities","tags":["product:feeds"]}},"/api/v2/feeds/activities/query":{"post":{"description":"Query activities based on filters with pagination and sorting options\n","operationId":"QueryActivities","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryActivitiesRequest"}}},"description":"Query Activities Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryActivitiesResponse"}}},"description":"Query Activities 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":"Query activities","tags":["product:feeds"]}},"/api/v2/feeds/activities/{activity_id}/bookmarks":{"delete":{"description":"Deletes a bookmark from an activity\n","operationId":"DeleteBookmark","parameters":[{"in":"path","name":"activity_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"folder_id","schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteBookmarkResponse"}}},"description":"Delete Bookmark 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":"Delete a bookmark","tags":["product:feeds"]},"patch":{"description":"Updates a bookmark for an activity\n","operationId":"UpdateBookmark","parameters":[{"in":"path","name":"activity_id","required":true,"schema":{"description":"ID of the activity","maxLength":255,"title":"Activity ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBookmarkRequest"}}},"description":"Update Bookmark Request","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBookmarkResponse"}}},"description":"Update Bookmark 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":"Update bookmark","tags":["product:feeds"]},"post":{"description":"Adds a bookmark to an activity\n","operationId":"AddBookmark","parameters":[{"in":"path","name":"activity_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddBookmarkRequest"}}},"description":"Add Bookmark Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddBookmarkResponse"}}},"description":"Add Bookmark 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":"Add bookmark","tags":["product:feeds"]}},"/api/v2/feeds/activities/{activity_id}/feedback":{"post":{"description":"Submit feedback for an activity including options to show less, hide, report, or mute the user\n","operationId":"ActivityFeedback","parameters":[{"in":"path","name":"activity_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivityFeedbackRequest"}}},"description":"Activity Feedback Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivityFeedbackResponse"}}},"description":"Activity Feedback 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":"Provide feedback on an activity","tags":["product:feeds"]}},"/api/v2/feeds/activities/{activity_id}/polls/{poll_id}/vote":{"post":{"description":"Cast a vote on a poll\n\nSends events:\n- feeds.poll.vote_casted\n- feeds.poll.vote_changed\n- feeds.poll.vote_removed\n- poll.vote_casted\n- poll.vote_changed\n- poll.vote_removed\n","operationId":"CastPollVote","parameters":[{"in":"path","name":"activity_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CastPollVoteRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollVoteResponse"}}},"description":"Successful 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":"Cast vote","tags":["product:feeds"]}},"/api/v2/feeds/activities/{activity_id}/polls/{poll_id}/vote/{vote_id}":{"delete":{"description":"Delete a vote from a poll\n\nSends events:\n- feeds.poll.vote_removed\n- poll.vote_removed\n","operationId":"DeletePollVote","parameters":[{"in":"path","name":"activity_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003"}},{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"004"}},{"in":"path","name":"vote_id","required":true,"schema":{"description":"Vote ID","maxLength":255,"title":"string","type":"string","x-stream-index":"005"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollVoteResponse"}}},"description":"Successful 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":"Delete vote","tags":["product:feeds"]}},"/api/v2/feeds/activities/{activity_id}/reactions":{"post":{"description":"Adds a reaction to an activity\n","operationId":"AddReaction","parameters":[{"in":"path","name":"activity_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddReactionRequest"}}},"description":"Add Reaction Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddReactionResponse"}}},"description":"Add Reaction 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":"Add reaction","tags":["product:feeds"]}},"/api/v2/feeds/activities/{activity_id}/reactions/query":{"post":{"description":"Query activity reactions\n","operationId":"QueryActivityReactions","parameters":[{"in":"path","name":"activity_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryActivityReactionsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryActivityReactionsResponse"}}},"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":"Query activity reactions","tags":["product:feeds"]}},"/api/v2/feeds/activities/{activity_id}/reactions/{type}":{"delete":{"description":"Removes a reaction from an activity\n","operationId":"DeleteActivityReaction","parameters":[{"in":"path","name":"activity_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"type","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteActivityReactionResponse"}}},"description":"Delete Activity Reaction 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":"Remove reaction","tags":["product:feeds"]}},"/api/v2/feeds/activities/{id}":{"delete":{"description":"Delete a single activity by its ID\n","operationId":"DeleteActivity","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"hard_delete","schema":{"description":"Whether to permanently delete the activity instead of soft delete","title":"boolean","type":"boolean","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteActivityResponse"}}},"description":"Delete Activity 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":"Delete a single activity","tags":["product:feeds"]},"get":{"description":"Returns activity by ID\n","operationId":"GetActivity","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetActivityResponse"}}},"description":"Get Activity 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":"Get activity","tags":["product:feeds"]},"patch":{"description":"Updates certain fields of the activity\n\nSends events:\n- feeds.activity.updated\n","operationId":"UpdateActivityPartial","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateActivityPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateActivityPartialResponse"}}},"description":"Successful 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":"Partially activity update","tags":["product:feeds"]},"put":{"description":"Replaces an activity with the provided data\n\nSends events:\n- feeds.activity.updated\n","operationId":"UpdateActivity","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateActivityRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateActivityResponse"}}},"description":"Successful 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":"Full activity update","tags":["product:feeds"]}},"/api/v2/feeds/bookmark_folders/query":{"post":{"description":"Query bookmark folders with filter query\n","operationId":"QueryBookmarkFolders","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryBookmarkFoldersRequest"}}},"description":"Query Bookmark Folders Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryBookmarkFoldersResponse"}}},"description":"Query Bookmark Folders 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":"Query bookmark folders","tags":["product:feeds"]}},"/api/v2/feeds/bookmark_folders/{folder_id}":{"delete":{"description":"Delete a bookmark folder by its ID\n","operationId":"DeleteBookmarkFolder","parameters":[{"in":"path","name":"folder_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteBookmarkFolderResponse"}}},"description":"Delete Bookmark Folder 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":"Delete a bookmark folder","tags":["product:feeds"]},"patch":{"description":"Update a bookmark folder by its ID\n","operationId":"UpdateBookmarkFolder","parameters":[{"in":"path","name":"folder_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBookmarkFolderRequest"}}},"description":"Update Bookmark Folder Request","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBookmarkFolderResponse"}}},"description":"Update Bookmark Folder 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":"Update a bookmark folder","tags":["product:feeds"]}},"/api/v2/feeds/bookmarks/query":{"post":{"description":"Query bookmarks with filter query\n","operationId":"QueryBookmarks","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryBookmarksRequest"}}},"description":"Query Bookmarks Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryBookmarksResponse"}}},"description":"Query Bookmarks 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":"Query bookmarks","tags":["product:feeds"]}},"/api/v2/feeds/comments":{"get":{"description":"Retrieve a threaded list of comments for a specific object (e.g., activity), with configurable depth, sorting, and pagination\n","operationId":"GetComments","parameters":[{"in":"query","name":"object_id","required":true,"schema":{"description":"ID of the object to get comments for","title":"Object ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"object_type","required":true,"schema":{"description":"Type of the object to get comments for","title":"Object Type","type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"depth","schema":{"description":"Maximum nested depth to return (0 = only first level)","format":"int32","maximum":5,"minimum":0,"title":"Max Depth","type":"integer","writeOnly":true,"x-stream-index":"003"}},{"in":"query","name":"sort","schema":{"description":"Sort order for the comments","enum":["first","last","top","best","controversial"],"title":"Sort Order","type":"string","writeOnly":true,"x-stream-index":"004"}},{"in":"query","name":"replies_limit","schema":{"format":"int32","maximum":20,"minimum":0,"type":"integer","writeOnly":true,"x-stream-index":"005"}},{"in":"query","name":"limit","schema":{"description":"Max number of top‑level comments to return","format":"int32","maximum":100,"minimum":0,"title":"Root Limit","type":"integer","writeOnly":true,"x-stream-index":"006.001"}},{"in":"query","name":"prev","schema":{"type":"string","writeOnly":true,"x-stream-index":"006.002"}},{"in":"query","name":"next","schema":{"type":"string","writeOnly":true,"x-stream-index":"006.003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCommentsResponse"}}},"description":"Get Comments 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":"Get comments for an object","tags":["product:feeds"]},"post":{"description":"Adds a comment to an object (e.g., activity) or a reply to an existing comment, and broadcasts appropriate events\n","operationId":"AddComment","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddCommentRequest"}}},"description":"Add Comment Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddCommentResponse"}}},"description":"Add Comment 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":"Add a comment or reply","tags":["product:feeds"]}},"/api/v2/feeds/comments/batch":{"post":{"description":"Adds multiple comments in a single request. Each comment must specify the object type and ID.\n","operationId":"AddCommentsBatch","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddCommentsBatchRequest"}}},"description":"Add Comments Batch Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddCommentsBatchResponse"}}},"description":"Add Comments Batch 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":"Add multiple comments in a batch","tags":["product:feeds"]}},"/api/v2/feeds/comments/query":{"post":{"description":"Query comments using MongoDB-style filters with pagination and sorting options\n","operationId":"QueryComments","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCommentsRequest"}}},"description":"Query Comments Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCommentsResponse"}}},"description":"Query Comments 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":"Query comments","tags":["product:feeds"]}},"/api/v2/feeds/comments/{id}":{"delete":{"description":"Deletes a comment from an object (e.g., activity) and broadcasts appropriate events\n","operationId":"DeleteComment","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"hard_delete","schema":{"description":"Whether to permanently delete the comment instead of soft delete","title":"Hard Delete","type":"boolean","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCommentResponse"}}},"description":"Delete Comment 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":"Delete a comment","tags":["product:feeds"]},"get":{"description":"Get a comment by ID\n","operationId":"GetComment","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCommentResponse"}}},"description":"Get Comment 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":"Get comment","tags":["product:feeds"]},"patch":{"description":"Updates a comment on an object (e.g., activity) and broadcasts appropriate events\n","operationId":"UpdateComment","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCommentRequest"}}},"description":"Update Comment Request","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCommentResponse"}}},"description":"Update Comment 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":"Update a comment","tags":["product:feeds"]}},"/api/v2/feeds/comments/{id}/reactions":{"post":{"description":"Adds a reaction to a comment\n","operationId":"AddCommentReaction","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddCommentReactionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddCommentReactionResponse"}}},"description":"Successful 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":"Add comment reaction","tags":["product:feeds"]}},"/api/v2/feeds/comments/{id}/reactions/query":{"post":{"description":"Query comment reactions\n","operationId":"QueryCommentReactions","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCommentReactionsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCommentReactionsResponse"}}},"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":"Query comment reactions","tags":["product:feeds"]}},"/api/v2/feeds/comments/{id}/reactions/{type}":{"delete":{"description":"Deletes a reaction from a comment\n","operationId":"DeleteCommentReaction","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"type","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCommentReactionResponse"}}},"description":"Delete Comment Reaction 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":"Delete comment reaction","tags":["product:feeds"]}},"/api/v2/feeds/comments/{id}/replies":{"get":{"description":"Retrieve a threaded list of replies for a single comment, with configurable depth, sorting, and pagination\n","operationId":"GetCommentReplies","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"depth","schema":{"description":"Maximum nested depth to return (0 = unlimited)","format":"int32","maximum":5,"minimum":0,"title":"Max Depth","type":"integer","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"sort","schema":{"description":"first (oldest), last (newest) or top","enum":["first","last","top","best","controversial"],"title":"Sort Order","type":"string","writeOnly":true,"x-stream-index":"003"}},{"in":"query","name":"replies_limit","schema":{"description":"Max number of replies to return","format":"int32","minimum":0,"title":"Replies Limit","type":"integer","writeOnly":true,"x-stream-index":"004"}},{"in":"query","name":"limit","schema":{"description":"Max number of direct replies to return","format":"int32","maximum":100,"minimum":0,"title":"Reply Limit","type":"integer","writeOnly":true,"x-stream-index":"005.001"}},{"in":"query","name":"prev","schema":{"type":"string","writeOnly":true,"x-stream-index":"005.002"}},{"in":"query","name":"next","schema":{"type":"string","writeOnly":true,"x-stream-index":"005.003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCommentRepliesResponse"}}},"description":"Get Comment Replies 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":"Get replies for a comment","tags":["product:feeds"]}},"/api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}":{"delete":{"description":"Delete a single feed by its ID\n","operationId":"DeleteFeed","parameters":[{"in":"path","name":"feed_group_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"feed_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"hard_delete","schema":{"description":"Whether to permanently delete the feed instead of soft delete","title":"boolean","type":"boolean","writeOnly":true,"x-stream-index":"003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteFeedResponse"}}},"description":"Delete Feed 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":"Delete a single feed","tags":["product:feeds"]},"post":{"description":"Create a single feed for a given feed group\n","operationId":"GetOrCreateFeed","parameters":[{"in":"path","name":"feed_group_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"feed_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"connection_id","schema":{"description":"Websocket connection ID to interact with. You can pass it as Body or URL parameter","title":"Connection ID","type":"string","x-stream-index":"015.003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrCreateFeedRequest"}}},"description":"ClientRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrCreateFeedResponse"}}},"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":"Create a new feed","tags":["product:feeds"]},"put":{"description":"Update an existing feed\n","operationId":"UpdateFeed","parameters":[{"in":"path","name":"feed_group_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"feed_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFeedRequest"}}},"description":"Update Feed Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFeedResponse"}}},"description":"Update Feed 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":"Update a feed","tags":["product:feeds"]}},"/api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/activities/mark/batch":{"post":{"description":"Mark activities as read/seen/watched. Can mark by timestamp (seen), activity IDs (read), or all as read.\n","operationId":"MarkActivity","parameters":[{"in":"path","name":"feed_group_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"feed_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkActivityRequest"}}},"description":"Mark Activity Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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 activities as read/seen/watched","tags":["product:feeds"]}},"/api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/activities/{activity_id}/pin":{"delete":{"description":"Unpin an activity from a feed. This removes the pin, so the activity will no longer be displayed at the top of the feed.\n","operationId":"UnpinActivity","parameters":[{"in":"path","name":"feed_group_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"feed_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"path","name":"activity_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnpinActivityResponse"}}},"description":"Unpin Activity 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":"Unpin an activity from a feed","tags":["product:feeds"]},"post":{"description":"Pin an activity to a feed. Pinned activities are typically displayed at the top of a feed.\n","operationId":"PinActivity","parameters":[{"in":"path","name":"feed_group_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"feed_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"path","name":"activity_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PinActivityRequest"}}},"description":"Pin Activity Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PinActivityResponse"}}},"description":"Pin Activity 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":"Pin an activity to a feed","tags":["product:feeds"]}},"/api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/members":{"patch":{"description":"Add, remove, or set members for a feed\n","operationId":"UpdateFeedMembers","parameters":[{"in":"path","name":"feed_group_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"feed_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFeedMembersRequest"}}},"description":"Update Feed Members Request","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFeedMembersResponse"}}},"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":"Update feed members","tags":["product:feeds"]}},"/api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/members/accept":{"post":{"description":"Accepts a pending feed member request\n","operationId":"AcceptFeedMemberInvite","parameters":[{"in":"path","name":"feed_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"feed_group_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcceptFeedMemberInviteRequest"}}},"description":"Accept Feed Member Invite Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcceptFeedMemberInviteResponse"}}},"description":"Accept Feed Member Invite 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":"Accept a feed member request","tags":["product:feeds"]}},"/api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/members/query":{"post":{"description":"Query feed members based on filters with pagination and sorting options\n","operationId":"QueryFeedMembers","parameters":[{"in":"path","name":"feed_group_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"feed_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryFeedMembersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryFeedMembersResponse"}}},"description":"Successful 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":"Query feed members","tags":["product:feeds"]}},"/api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/members/reject":{"post":{"description":"Rejects a pending feed member request\n","operationId":"RejectFeedMemberInvite","parameters":[{"in":"path","name":"feed_group_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"feed_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RejectFeedMemberInviteRequest"}}},"description":"Reject Feed Member Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RejectFeedMemberInviteResponse"}}},"description":"Reject Feed Member 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":"Reject an invite to become a feed member","tags":["product:feeds"]}},"/api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/watch":{"delete":{"description":"Call this Method to stop receiving feed events\n","operationId":"StopWatchingFeed","parameters":[{"in":"path","name":"feed_group_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"path","name":"feed_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"003"}},{"in":"query","name":"connection_id","schema":{"type":"string","x-stream-index":"001.003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Stop watching feed","tags":["product:feeds"]}},"/api/v2/feeds/feed_groups/{feed_group_id}/follow_suggestions":{"get":{"description":"Get follow suggestions for a feed group\n","operationId":"GetFollowSuggestions","parameters":[{"in":"path","name":"feed_group_id","required":true,"schema":{"description":"The ID of the feed group to get suggestions for","maxLength":255,"title":"Feed Group ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"limit","schema":{"description":"Maximum number of suggestions to return","format":"int32","maximum":100,"minimum":1,"title":"Limit","type":"integer","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetFollowSuggestionsResponse"}}},"description":"Follow Suggestions 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":"Get follow suggestions","tags":["product:feeds"]}},"/api/v2/feeds/feeds/batch":{"post":{"description":"Create multiple feeds at once for a given feed group\n","operationId":"CreateFeedsBatch","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFeedsBatchRequest"}}},"description":"Create Feeds Batch Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFeedsBatchResponse"}}},"description":"Create Feeds Batch 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":"Create multiple feeds at once","tags":["product:feeds"]}},"/api/v2/feeds/feeds/query":{"post":{"description":"Query feeds with filter query\n","operationId":"QueryFeeds","parameters":[{"in":"query","name":"connection_id","schema":{"type":"string","x-stream-index":"005.003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryFeedsRequest"}}},"description":"Query Feeds Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryFeedsResponse"}}},"description":"Query Feeds 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":"Query feeds","tags":["product:feeds"]}},"/api/v2/feeds/follows":{"patch":{"description":"Updates a follow's custom data, push preference, and follower role. Source owner can update custom data and push preference. Target owner can update follower role.\n","operationId":"UpdateFollow","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFollowRequest"}}},"description":"Update Follow Request","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFollowResponse"}}},"description":"Update Follow 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":"Update a follow","tags":["product:feeds"]},"post":{"description":"Creates a follow and broadcasts FollowAddedEvent\n","operationId":"Follow","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FollowRequest"}}},"description":"Follow Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SingleFollowResponse"}}},"description":"Follow 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":"Create a follow","tags":["product:feeds"]}},"/api/v2/feeds/follows/accept":{"post":{"description":"Accepts a pending follow request\n","operationId":"AcceptFollow","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcceptFollowRequest"}}},"description":"Accept Follow Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcceptFollowResponse"}}},"description":"Accept Follow 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":"Accept a follow request","tags":["product:feeds"]}},"/api/v2/feeds/follows/batch":{"post":{"description":"Creates multiple follows at once and broadcasts FollowAddedEvent for each follow\n","operationId":"FollowBatch","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FollowBatchRequest"}}},"description":"Follow Batch Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FollowBatchResponse"}}},"description":"Follow Batch 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":"Create multiple follows at once","tags":["product:feeds"]}},"/api/v2/feeds/follows/query":{"post":{"description":"Query follows based on filters with pagination and sorting options\n","operationId":"QueryFollows","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryFollowsRequest"}}},"description":"Query Follows Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryFollowsResponse"}}},"description":"Query Follows 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":"Query follows","tags":["product:feeds"]}},"/api/v2/feeds/follows/reject":{"post":{"description":"Rejects a pending follow request\n","operationId":"RejectFollow","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RejectFollowRequest"}}},"description":"Reject Follow Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RejectFollowResponse"}}},"description":"Reject Follow 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":"Reject a follow request","tags":["product:feeds"]}},"/api/v2/feeds/follows/{source}/{target}":{"delete":{"description":"Removes a follow and broadcasts FollowRemovedEvent\n","operationId":"Unfollow","parameters":[{"in":"path","name":"source","required":true,"schema":{"description":"Fully qualified ID of the source feed","maxLength":255,"title":"Source Feed","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"target","required":true,"schema":{"description":"Fully qualified ID of the target feed","maxLength":255,"title":"Target Feed","type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnfollowResponse"}}},"description":"Unfollow 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":"Unfollow a feed","tags":["product:feeds"]}},"/api/v2/guest":{"post":{"description":"\n","operationId":"CreateGuest","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGuestRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGuestResponse"}}},"description":"Successful 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":"Create Guest","tags":["product:common"]}},"/api/v2/longpoll":{"get":{"description":"WebSocket fallback transport endpoint\n\nSends events:\n- user.updated\n","operationId":"LongPoll","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WSAuthMessage","x-stream-index":"001"}}},"in":"query","name":"json"},{"in":"query","name":"connection_id","schema":{"maxLength":36,"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"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":"Long Poll (Transport)","tags":["product:common"]}},"/api/v2/moderation/ban":{"post":{"description":"Ban a user from a channel or the entire app\n","operationId":"ban","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BanRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BanResponse"}}},"description":"Successful 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":"Ban","tags":["product:moderation"]}},"/api/v2/moderation/config":{"post":{"description":"Create a new moderation configuration or update an existing one. Configure settings for content filtering, AI analysis, toxicity detection, and other moderation features.\n","operationId":"upsert_config","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertConfigRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertConfigResponse"}}},"description":"Successful 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":"Create or update moderation configuration","tags":["product:moderation"]}},"/api/v2/moderation/config/{key}":{"delete":{"description":"Delete a specific moderation policy by its name\n","operationId":"delete_config","parameters":[{"in":"path","name":"key","required":true,"schema":{"description":"Key of the moderation configuration to delete","title":"Key","type":"string","x-stream-index":"001"}},{"in":"query","name":"team","schema":{"description":"Team associated with the configuration","title":"Team","type":"string","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteModerationConfigResponse"}}},"description":"Successful 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":"Delete a moderation policy","tags":["product:moderation"]},"get":{"description":"Retrieve a specific moderation configuration by its key and team. This configuration contains settings for various moderation features like toxicity detection, AI analysis, and filtering rules.\n","operationId":"get_config","parameters":[{"in":"path","name":"key","required":true,"schema":{"description":"Key of the moderation configuration to retrieve","title":"Key","type":"string","x-stream-index":"001"}},{"in":"query","name":"team","schema":{"description":"Team associated with the configuration","title":"Team","type":"string","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetConfigResponse"}}},"description":"Successful 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":"Get moderation configuration","tags":["product:moderation"]}},"/api/v2/moderation/configs":{"post":{"description":"Search and filter moderation configurations across your application. This endpoint is designed for building moderation dashboards and managing multiple configuration sets.\n","operationId":"query_moderation_configs","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationConfigsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationConfigsResponse"}}},"description":"Successful 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":"Query moderation configurations","tags":["product:moderation"]}},"/api/v2/moderation/flag":{"post":{"description":"Flag any type of content (messages, users, channels, activities) for moderation review. Supports custom content types and additional metadata for flagged content.\n","operationId":"flag","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlagRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlagResponse"}}},"description":"Successful 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":"Flag content for moderation","tags":["product:moderation"]}},"/api/v2/moderation/mute":{"post":{"description":"Mute a user. Mutes are generally not visible to the user you mute, while block is something you notice.\n","operationId":"mute","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteRequest"}}},"description":"MuteRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteResponse"}}},"description":"MuteResponse"},"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":"Mute","tags":["product:moderation"]}},"/api/v2/moderation/review_queue":{"post":{"description":"Query review queue items allows you to filter the review queue items. This is used for building a moderation dashboard.\n","operationId":"query_review_queue","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryReviewQueueRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryReviewQueueResponse"}}},"description":"Successful 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":"Query review queue items","tags":["product:moderation"]}},"/api/v2/moderation/submit_action":{"post":{"description":"Take action on flagged content, such as marking content as safe, deleting content, banning users, or executing custom moderation actions. Supports various action types with configurable parameters.\n","operationId":"submit_action","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitActionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitActionResponse"}}},"description":"Successful 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":"Submit moderation action","tags":["product:moderation"]}},"/api/v2/og":{"get":{"description":"Get an OpenGraph attachment for a link\n","operationId":"GetOG","parameters":[{"in":"query","name":"url","required":true,"schema":{"description":"URL to be scraped","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOGResponse"}}},"description":"Get OG Attachment"},"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":"Get OG","tags":["product:common"]}},"/api/v2/polls":{"post":{"description":"Creates a new poll\n","operationId":"CreatePoll","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePollRequest"}}},"description":"Create Poll Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Create poll","tags":["product:common"]},"put":{"description":"Updates a poll\n\nSends events:\n- feeds.poll.closed\n- feeds.poll.updated\n- poll.closed\n- poll.updated\n","operationId":"UpdatePoll","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePollRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Update poll","tags":["product:common"]}},"/api/v2/polls/query":{"post":{"description":"Queries polls\n","operationId":"QueryPolls","parameters":[{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryPollsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryPollsResponse"}}},"description":"Successful 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":"Query polls","tags":["product:common"]}},"/api/v2/polls/{poll_id}":{"delete":{"description":"Deletes a poll\n\nSends events:\n- feeds.poll.deleted\n- poll.deleted\n","operationId":"DeletePoll","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete poll","tags":["product:common"]},"get":{"description":"Retrieves a poll\n","operationId":"GetPoll","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Get poll","tags":["product:common"]},"patch":{"description":"Updates a poll partially\n\nSends events:\n- feeds.poll.closed\n- feeds.poll.updated\n- poll.closed\n- poll.updated\n","operationId":"UpdatePollPartial","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePollPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Partial update poll","tags":["product:common"]}},"/api/v2/polls/{poll_id}/options":{"post":{"description":"Creates a poll option\n\nSends events:\n- feeds.poll.updated\n- poll.updated\n","operationId":"CreatePollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePollOptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollOptionResponse"}}},"description":"Successful 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":"Create poll option","tags":["product:common"]},"put":{"description":"Updates a poll option\n\nSends events:\n- feeds.poll.updated\n- poll.updated\n","operationId":"UpdatePollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePollOptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollOptionResponse"}}},"description":"Successful 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":"Update poll option","tags":["product:common"]}},"/api/v2/polls/{poll_id}/options/{option_id}":{"delete":{"description":"Deletes a poll option\n\nSends events:\n- feeds.poll.updated\n- poll.updated\n","operationId":"DeletePollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"path","name":"option_id","required":true,"schema":{"description":"Option ID","maxLength":255,"title":"string","type":"string","x-stream-index":"003"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete poll option","tags":["product:common"]},"get":{"description":"Retrieves a poll option\n","operationId":"GetPollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"path","name":"option_id","required":true,"schema":{"description":"Option ID","maxLength":255,"title":"string","type":"string","x-stream-index":"003"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollOptionResponse"}}},"description":"Successful 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":"Get poll option","tags":["product:common"]}},"/api/v2/polls/{poll_id}/votes":{"post":{"description":"Queries votes\n","operationId":"QueryPollVotes","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryPollVotesRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollVotesResponse"}}},"description":"Successful 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":"Query votes","tags":["product:common"]}},"/api/v2/uploads/file":{"delete":{"description":"Deletes previously uploaded file\n","operationId":"DeleteFileGlobal","parameters":[{"in":"query","name":"url","schema":{"description":"File URL to delete","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete file","tags":["product:common"],"x-stream-sdk-name":"DeleteFile"},"post":{"description":"Uploads file\n","operationId":"UploadFileGlobal","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/FileUploadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileUploadResponse"}}},"description":"Successful 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":"Upload file","tags":["product:common"],"x-stream-sdk-name":"UploadFile"}},"/api/v2/uploads/image":{"delete":{"description":"Deletes previously uploaded image\n","operationId":"DeleteImageGlobal","parameters":[{"in":"query","name":"url","schema":{"description":"File URL to delete","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete image","tags":["product:common"],"x-stream-sdk-name":"DeleteImage"},"post":{"description":"Uploads image\n","operationId":"UploadImageGlobal","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/ImageUploadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageUploadResponse"}}},"description":"Successful 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":"Upload image","tags":["product:common"],"x-stream-sdk-name":"UploadImage"}},"/api/v2/users":{"get":{"description":"Find and filter users\n","operationId":"QueryUsers","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryUsersPayload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryUsersResponse"}}},"description":"Successful 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":"Query users","tags":["product:common"]},"patch":{"description":"Updates certain fields of the user\n\nSends events:\n- user.presence.changed\n- user.updated\n- user.presence.changed\n","operationId":"UpdateUsersPartial","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersResponse"}}},"description":"Successful 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":"Partially update user","tags":["product:common"]},"post":{"description":"Update or create users in bulk\n\nSends events:\n- user.updated\n","operationId":"UpdateUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersResponse"}}},"description":"Successful 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":"Upsert users","tags":["product:common"]}},"/api/v2/users/block":{"get":{"description":"Get list of blocked Users\n","operationId":"GetBlockedUsers","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBlockedUsersResponse"}}},"description":"Successful 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":"Get list of blocked Users","tags":["product:common"]},"post":{"description":"Block users\n","operationId":"BlockUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUsersResponse"}}},"description":"Successful 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":"Block user","tags":["product:common"]}},"/api/v2/users/live_locations":{"get":{"description":"Retrieves all active live locations for a user\n","operationId":"GetUserLiveLocations","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SharedLocationsResponse"}}},"description":"Successful 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":"Get user live locations","tags":["product:common"]},"put":{"description":"Updates an existing live location with new coordinates or expiration time\n","operationId":"UpdateLiveLocation","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateLiveLocationRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SharedLocationResponse"}}},"description":"Successful 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":"Update live location","tags":["product:common"]}},"/api/v2/users/unblock":{"post":{"description":"Unblock users\n","operationId":"UnblockUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUsersResponse"}}},"description":"Successful 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":"Unblock user","tags":["product:common"]}}},"security":[{"JWT":[],"api_key":[],"stream-auth-type":[]},{"api_key":[],"stream-auth-type":[]}],"servers":[{"description":"Stream API","url":"https://chat.stream-io-api.com"}]} \ No newline at end of file diff --git a/openapi/v2/feeds-clientside-api.yaml b/openapi/v2/feeds-clientside-api.yaml new file mode 100644 index 000000000..23c7d5300 --- /dev/null +++ b/openapi/v2/feeds-clientside-api.yaml @@ -0,0 +1,19841 @@ +components: + schemas: + AIImageConfig: + properties: + async: + type: boolean + x-stream-index: "001" + enabled: + type: boolean + x-stream-index: "002" + ocr_rules: + items: + $ref: '#/components/schemas/OCRRule' + type: array + x-stream-index: "004" + rules: + items: + $ref: '#/components/schemas/AWSRekognitionRule' + type: array + x-stream-index: "003" + required: + - enabled + - rules + - ocr_rules + type: object + AITextConfig: + properties: + async: + type: boolean + x-stream-index: "001" + enabled: + type: boolean + x-stream-index: "002" + profile: + type: string + x-stream-index: "003" + rules: + items: + $ref: '#/components/schemas/BodyguardRule' + type: array + x-stream-index: "004" + severity_rules: + items: + $ref: '#/components/schemas/BodyguardSeverityRule' + type: array + x-stream-index: "005" + required: + - enabled + - profile + - rules + - severity_rules + type: object + AIVideoConfig: + properties: + async: + type: boolean + x-stream-index: "001" + enabled: + type: boolean + x-stream-index: "002" + rules: + items: + $ref: '#/components/schemas/AWSRekognitionRule' + type: array + x-stream-index: "003" + required: + - enabled + - rules + type: object + APIError: + nullable: true + properties: + StatusCode: + description: Response HTTP status code + format: int32 + title: Status code + type: integer + x-stream-index: "004" + code: + description: API error code + format: int32 + title: Code + type: integer + x-stream-index: "001" + details: + description: Additional error-specific information + items: + type: integer + title: Details + type: array + x-stream-index: "007" + duration: + description: Request duration + title: Duration + type: string + x-stream-index: "005" + exception_fields: + additionalProperties: + type: string + description: Additional error info + title: Exception fields + type: object + x-stream-index: "003" + message: + description: Message describing an error + title: Message + type: string + x-stream-index: "002" + more_info: + description: URL with additional information + title: More info + type: string + x-stream-index: "006" + unrecoverable: + description: Flag that indicates if the error is unrecoverable, requests + that return unrecoverable errors should not be retried, this error only + applies to the request that caused it + title: Unrecoverable + type: boolean + x-stream-index: "008" + required: + - code + - message + - StatusCode + - duration + - more_info + - details + title: Error response + type: object + APNS: + properties: + body: + type: string + x-stream-index: "002" + content-available: + format: int32 + type: integer + x-stream-index: "004" + data: + additionalProperties: {} + type: object + x-stream-index: "006" + mutable-content: + format: int32 + type: integer + x-stream-index: "005" + sound: + type: string + x-stream-index: "003" + title: + type: string + x-stream-index: "001" + required: + - title + - body + type: object + AWSRekognitionRule: + properties: + action: + enum: + - flag + - shadow + - remove + - bounce + - bounce_flag + - bounce_remove + type: string + x-stream-index: "002" + label: + type: string + x-stream-index: "001" + min_confidence: + format: float + maximum: 100 + minimum: 0 + type: number + x-stream-index: "003" + required: + - label + - action + - min_confidence + type: object + AcceptFeedMemberInviteRequest: + nullable: true + title: Accept Feed Member Invite Request + type: object + AcceptFeedMemberInviteResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + member: + $ref: '#/components/schemas/FeedMemberResponse' + description: The feed member after accepting the invite + title: Feed Member + x-stream-index: "001" + required: + - member + - duration + title: Accept Feed Member Invite Response + type: object + AcceptFollowRequest: + nullable: true + properties: + follower_role: + description: Optional role for the follower in the follow relationship + title: Follower Role + type: string + x-stream-index: "003" + source: + description: Fully qualified ID of the source feed + maxLength: 255 + title: Source Feed ID + type: string + x-stream-index: "001" + target: + description: Fully qualified ID of the target feed + maxLength: 255 + title: Target Feed ID + type: string + x-stream-index: "002" + required: + - source + - target + title: Accept Follow Request + type: object + AcceptFollowResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + follow: + $ref: '#/components/schemas/FollowResponse' + description: The accepted follow relationship + title: Follow + x-stream-index: "001" + required: + - follow + - duration + title: Accept Follow Response + type: object + Action: + nullable: true + properties: + name: + type: string + x-stream-index: "001" + style: + type: string + x-stream-index: "003" + text: + type: string + x-stream-index: "002" + type: + type: string + x-stream-index: "004" + value: + type: string + x-stream-index: "005" + required: + - name + - text + - type + type: object + ActionLog: + nullable: true + properties: + created_at: + format: date-time + type: number + x-stream-index: "004" + custom: + additionalProperties: {} + type: object + x-stream-index: "010" + id: + type: string + x-stream-index: "002" + reason: + type: string + x-stream-index: "008" + reporter_type: + type: string + x-stream-index: "009" + review_queue_item: + $ref: '#/components/schemas/ReviewQueueItem' + x-stream-index: "014" + review_queue_item_id: + type: string + x-stream-index: "012" + target_user: + $ref: '#/components/schemas/User' + x-stream-index: "013" + target_user_id: + type: string + x-stream-index: "011" + type: + type: string + x-stream-index: "005" + user: + $ref: '#/components/schemas/User' + x-stream-index: "007" + required: + - id + - created_at + - type + - reason + - reporter_type + - custom + - target_user_id + - review_queue_item_id + type: object + ActionLogResponse: + nullable: true + properties: + created_at: + description: Timestamp when the action was taken + format: date-time + title: Created At + type: number + x-stream-index: "002" + custom: + additionalProperties: {} + description: Additional metadata about the action + title: Custom + type: object + x-stream-index: "007" + id: + description: Unique identifier of the action log + title: ID + type: string + x-stream-index: "001" + reason: + description: Reason for the moderation action + title: Reason + type: string + x-stream-index: "006" + review_queue_item: + $ref: '#/components/schemas/ReviewQueueItemResponse' + description: Associated review queue item + title: Review Queue Item + x-stream-index: "008" + target_user: + $ref: '#/components/schemas/UserResponse' + description: User who was the target of the action + title: Target User + x-stream-index: "009" + target_user_id: + description: ID of the user who was the target of the action + title: Target User ID + type: string + x-stream-index: "010" + type: + description: Type of moderation action + title: Type + type: string + x-stream-index: "003" + user: + $ref: '#/components/schemas/UserResponse' + description: User who performed the action + title: User + x-stream-index: "004" + user_id: + description: ID of the user who performed the action + title: User ID + type: string + x-stream-index: "005" + required: + - id + - created_at + - type + - user_id + - reason + - custom + - target_user_id + type: object + ActionSequence: + properties: + action: + type: string + x-stream-index: "001" + blur: + type: boolean + x-stream-index: "005" + cooldown_period: + format: int32 + type: integer + x-stream-index: "004" + threshold: + format: int32 + type: integer + x-stream-index: "002" + time_window: + format: int32 + type: integer + x-stream-index: "003" + warning: + type: boolean + x-stream-index: "006" + warning_text: + type: string + x-stream-index: "007" + required: + - action + - threshold + - time_window + - cooldown_period + - blur + - warning + - warning_text + type: object + ActivityAddedEvent: + description: Emitted when an activity is added to a feed. + nullable: true + properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + description: The activity that was added + title: Activity + x-stream-index: "001" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + feed_visibility: + type: string + x-stream-index: "002.003" + fid: + type: string + x-stream-index: "002.002" + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 + type: + default: feeds.activity.added + description: 'The type of event: "feeds.activity.added" in this case' + title: Event Type + type: string + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who added the activity + title: User + x-stream-index: "003.001" + required: + - activity + - type + - created_at + - custom + - fid + title: ActivityAddedEvent + 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 + ActivityDeletedEvent: + description: Emitted when an activity is deleted. + nullable: true + properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + description: The activity that was updated + title: Activity + x-stream-index: "001" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + feed_visibility: + type: string + x-stream-index: "002.003" + fid: + type: string + x-stream-index: "002.002" + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 + type: + default: feeds.activity.deleted + description: 'The type of event: "feeds.activity.deleted" in this case' + title: Event Type + type: string + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + x-stream-index: "003.001" + required: + - activity + - type + - created_at + - custom + - fid + title: ActivityDeletedEvent + 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 + ActivityFeedbackRequest: + description: Request to provide feedback on an activity + nullable: true + properties: + hide: + description: Whether to hide this activity + title: bool + type: boolean + x-stream-index: "003" + mute_user: + description: Whether to mute the user who created this activity + title: bool + type: boolean + x-stream-index: "005" + reason: + description: Reason for the feedback (optional) + maxLength: 1000 + title: string + type: string + x-stream-index: "006" + report: + description: Whether to report this activity + title: bool + type: boolean + x-stream-index: "004" + show_less: + description: Whether to show less content like this + title: bool + type: boolean + x-stream-index: "002" + title: Activity Feedback Request + type: object + ActivityFeedbackResponse: + description: Response for activity feedback submission + nullable: true + properties: + activity_id: + description: The ID of the activity that received feedback + title: string + type: string + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - activity_id + - duration + title: Activity Feedback Response + type: object + ActivityLocation: + properties: + lat: + description: Latitude coordinate + format: float + title: Latitude + type: number + x-stream-index: "001" + lng: + description: Longitude coordinate + format: float + title: Longitude + type: number + x-stream-index: "002" + required: + - lat + - lng + title: Activity Location + type: object + ActivityMarkEvent: + description: Emitted when activities are marked as read, seen, or watched. + nullable: true + properties: + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 006.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 006.001.007 + feed_visibility: + type: string + x-stream-index: "006.003" + fid: + type: string + x-stream-index: "006.002" + mark_all_read: + description: Whether all activities were marked as read + title: Mark All Read + type: boolean + x-stream-index: "004" + mark_all_seen: + description: Whether all activities were marked as seen + title: Mark All Seen + type: boolean + x-stream-index: "005" + mark_read: + description: The IDs of activities marked as read + items: + type: string + title: Mark Read + type: array + x-stream-index: "001" + mark_seen: + description: The IDs of activities marked as seen + items: + type: string + title: Mark Seen + type: array + x-stream-index: "002" + mark_watched: + description: The IDs of activities marked as watched + items: + type: string + title: Mark Watched + type: array + x-stream-index: "003" + received_at: + format: date-time + type: number + x-stream-index: 006.001.004 + type: + default: feeds.activity.marked + description: 'The type of event: "feeds.activity.marked" in this case' + title: Event Type + type: string + x-stream-index: 006.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who marked the activities + title: User + x-stream-index: "007.001" + required: + - type + - created_at + - custom + - fid + title: ActivityMarkEvent + 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 + ActivityPinResponse: + properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + description: The pinned activity + title: Activity + x-stream-index: "002" + created_at: + description: When the pin was created + format: date-time + title: Created At + type: number + x-stream-index: "004" + feed: + description: ID of the feed where activity is pinned + title: Feed ID + type: string + x-stream-index: "003" + updated_at: + description: When the pin was last updated + format: date-time + title: Updated At + type: number + x-stream-index: "005" + user: + $ref: '#/components/schemas/UserResponse' + description: User who pinned the activity + title: User + x-stream-index: "001" + required: + - user + - activity + - feed + - created_at + - updated_at + title: Activity Pin + type: object + ActivityPinnedEvent: + description: Emitted when an activity is pinned. + nullable: true + properties: + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + feed_visibility: + type: string + x-stream-index: "002.003" + fid: + description: The ID of the feed + title: Feed ID + type: string + x-stream-index: "002.002" + pinned_activity: + $ref: '#/components/schemas/PinActivityResponse' + x-stream-index: "001" + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 + type: + default: feeds.activity.pinned + description: 'The type of event: "feeds.activity.pinned" in this case' + title: Event Type + type: string + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who pinned the activity + title: User + x-stream-index: "003.001" + required: + - pinned_activity + - type + - created_at + - custom + - fid + title: ActivityPinnedEvent + 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 + ActivityProcessorConfig: + nullable: true + properties: + config: + additionalProperties: {} + type: object + x-stream-index: "002" + openai_key: + type: string + x-stream-index: "003" + type: + type: string + x-stream-index: "001" + required: + - type + type: object + ActivityReactionAddedEvent: + description: Emitted when a reaction is added to an activity. + nullable: true + properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + x-stream-index: "001" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 003.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 003.001.007 + feed_visibility: + type: string + x-stream-index: "003.003" + fid: + type: string + x-stream-index: "003.002" + reaction: + $ref: '#/components/schemas/FeedsReactionResponse' + description: The reaction that was added + title: Reaction + x-stream-index: "002" + received_at: + format: date-time + type: number + x-stream-index: 003.001.004 + type: + default: feeds.activity.reaction.added + description: 'The type of event: "feeds.activity.reaction.added" in this + case' + title: Event Type + type: string + x-stream-index: 003.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who added the reaction + title: User + x-stream-index: "004.001" + required: + - activity + - reaction + - type + - created_at + - custom + - fid + title: ActivityReactionAddedEvent + 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 + ActivityReactionDeletedEvent: + description: Emitted when a reaction is deleted from an activity. + nullable: true + properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + x-stream-index: "001" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 003.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 003.001.007 + feed_visibility: + type: string + x-stream-index: "003.003" + fid: + type: string + x-stream-index: "003.002" + reaction: + $ref: '#/components/schemas/FeedsReactionResponse' + x-stream-index: "002" + received_at: + format: date-time + type: number + x-stream-index: 003.001.004 + type: + default: feeds.activity.reaction.deleted + description: The type of the reaction that was removed + title: Type + type: string + x-stream-index: 003.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who removed the reaction + title: User + x-stream-index: "004.001" + required: + - activity + - reaction + - type + - created_at + - custom + - fid + title: ActivityReactionDeletedEvent + 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 + ActivityReactionUpdatedEvent: + description: Emitted when a reaction is updated on an activity. + nullable: true + properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + x-stream-index: "001" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 003.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 003.001.007 + feed_visibility: + type: string + x-stream-index: "003.003" + fid: + type: string + x-stream-index: "003.002" + reaction: + $ref: '#/components/schemas/FeedsReactionResponse' + description: The reaction that was updated + title: Reaction + x-stream-index: "002" + received_at: + format: date-time + type: number + x-stream-index: 003.001.004 + type: + default: feeds.activity.reaction.updated + description: 'The type of event: "feeds.activity.reaction.updated" in this + case' + title: Event Type + type: string + x-stream-index: 003.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who updated the reaction + title: User + x-stream-index: "004.001" + required: + - activity + - reaction + - type + - created_at + - custom + - fid + title: ActivityReactionUpdatedEvent + 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 + ActivityRemovedFromFeedEvent: + description: Emitted when an activity is removed from a feed. + nullable: true + properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + x-stream-index: "001" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + feed_visibility: + type: string + x-stream-index: "002.003" + fid: + type: string + x-stream-index: "002.002" + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 + type: + default: feeds.activity.removed_from_feed + description: 'The type of event: "feeds.activity.removed_from_feed" in this + case' + title: Event Type + type: string + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who removed the activity + title: User + x-stream-index: "003.001" + required: + - activity + - type + - created_at + - custom + - fid + title: ActivityRemovedFromFeedEvent + 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 + ActivityRequest: + properties: + attachments: + description: List of attachments for the activity + items: + $ref: '#/components/schemas/Attachment' + title: Attachments + type: array + x-stream-index: "006" + custom: + additionalProperties: {} + description: Custom data for the activity + title: Custom Data + type: object + x-stream-index: "017" + expires_at: + description: Expiration time for the activity + title: Expires At + type: string + x-stream-index: "010" + feeds: + description: List of feed IDs to add the activity to + items: + type: string + maximum: 255 + minimum: 1 + title: Feed IDs + type: array + x-stream-index: "004" + filter_tags: + description: Tags for filtering activities + items: + type: string + maximum: 255 + title: Filter Tags + type: array + x-stream-index: "013" + id: + description: Optional ID for the activity + maxLength: 255 + title: Activity ID + type: string + x-stream-index: "001" + interest_tags: + description: Tags for indicating user interests + items: + type: string + maximum: 255 + title: Interest Tags + type: array + x-stream-index: "014" + location: + $ref: '#/components/schemas/ActivityLocation' + description: Geographic location related to the activity + title: Location + x-stream-index: "009" + mentioned_user_ids: + description: List of users mentioned in the activity + items: + type: string + maximum: 255 + title: Mentioned User IDs + type: array + x-stream-index: "011" + parent_id: + description: ID of parent activity for replies/comments + maxLength: 255 + title: Parent ID + type: string + x-stream-index: "015" + poll_id: + description: ID of a poll to attach to activity + title: Poll ID + type: string + x-stream-index: "016" + search_data: + additionalProperties: {} + description: Additional data for search indexing + title: Search Data + type: object + x-stream-index: "012" + text: + description: Text content of the activity + title: Text + type: string + x-stream-index: "005" + type: + description: Type of activity + maxLength: 255 + title: Activity Type + type: string + x-stream-index: "002" + visibility: + description: Visibility setting for the activity + enum: + - public + - private + - tag + title: Visibility + type: string + x-stream-index: "007" + visibility_tag: + description: If visibility is 'tag', this is the tag name and is required + maxLength: 32 + title: Visibility Tag + type: string + x-stream-index: "008" + required: + - type + - feeds + title: Activity Request + type: object + ActivityResponse: + properties: + attachments: + description: Media attachments for the activity + items: + $ref: '#/components/schemas/Attachment' + title: Attachments + type: array + x-stream-index: "009" + bookmark_count: + description: Number of bookmarks on the activity + format: int32 + title: Bookmark Count + type: integer + x-stream-index: "028" + comment_count: + description: Number of comments on the activity + format: int32 + title: Comment Count + type: integer + x-stream-index: "027" + comments: + description: Comments on this activity + items: + $ref: '#/components/schemas/CommentResponse' + title: Comments + type: array + x-stream-index: "015" + created_at: + description: When the activity was created + format: date-time + title: Created At + type: number + x-stream-index: "007" + current_feed: + $ref: '#/components/schemas/FeedResponse' + description: Feed context for this activity view. If an activity is added + only to one feed, it's always set. If an activity is added to multiple + feeds, it's only set when calling the GetOrCreateFeed endpoint. + title: Current Feed + x-stream-index: "035" + custom: + additionalProperties: {} + description: Custom data for the activity + title: Custom Data + type: object + x-stream-index: "011" + deleted_at: + description: When the activity was deleted + format: date-time + title: Deleted At + type: number + x-stream-index: "021" + edited_at: + description: When the activity was last edited + format: date-time + title: Edited At + type: number + x-stream-index: "020" + expires_at: + description: When the activity will expire + format: date-time + title: Expires At + type: number + x-stream-index: "022" + feeds: + description: List of feed IDs containing this activity + items: + type: string + title: Feeds + type: array + x-stream-index: "004" + filter_tags: + description: Tags for filtering + items: + type: string + title: Filter Tags + type: array + x-stream-index: "024" + hidden: + description: If this activity is hidden for this user. For premium content + where you want to show a preview + title: Hidden + type: boolean + x-stream-index: "036" + id: + description: Unique identifier for the activity + title: ID + type: string + x-stream-index: "001" + interest_tags: + description: Tags for user interests + items: + type: string + title: Interest Tags + type: array + x-stream-index: "025" + latest_reactions: + description: Recent reactions to the activity + items: + $ref: '#/components/schemas/FeedsReactionResponse' + title: Latest Reactions + type: array + x-stream-index: "031" + location: + $ref: '#/components/schemas/ActivityLocation' + description: Geographic location related to the activity + title: Location + x-stream-index: "017" + mentioned_users: + description: Users mentioned in the activity + items: + $ref: '#/components/schemas/UserResponse' + title: Mentioned Users + type: array + x-stream-index: "010" + moderation: + $ref: '#/components/schemas/ModerationV2Response' + description: Moderation information + title: Moderation + x-stream-index: "026" + notification_context: + additionalProperties: {} + description: Notification context data for the activity (if this is a reaction, + comment, follow, etc.) + title: Notification Context + type: object + x-stream-index: "012" + own_bookmarks: + description: Current user's bookmarks for this activity + items: + $ref: '#/components/schemas/BookmarkResponse' + title: Own Bookmarks + type: array + x-stream-index: "034" + own_reactions: + description: Current user's reactions to this activity + items: + $ref: '#/components/schemas/FeedsReactionResponse' + title: Own Reactions + type: array + x-stream-index: "033" + parent: + $ref: '#/components/schemas/ActivityResponse' + description: Parent activity (if this is a reply/comment) + title: Parent + x-stream-index: "018" + poll: + $ref: '#/components/schemas/PollResponseData' + description: Poll attached to this activity + title: Poll + x-stream-index: "019" + popularity: + description: Popularity score of the activity + format: int32 + title: Popularity + type: integer + x-stream-index: "013" + reaction_count: + description: Number of reactions to the activity + format: int32 + title: Reaction Count + type: integer + x-stream-index: "030" + reaction_groups: + additionalProperties: + $ref: '#/components/schemas/ReactionGroupResponse' + description: Grouped reactions by type + title: Reaction Groups + type: object + x-stream-index: "032" + score: + description: Ranking score for this activity + format: float + title: Score + type: number + x-stream-index: "014" + search_data: + additionalProperties: {} + description: Data for search indexing + title: Search Data + type: object + x-stream-index: "023" + share_count: + description: Number of times the activity was shared + format: int32 + title: Share Count + type: integer + x-stream-index: "029" + text: + description: Text content of the activity + title: Text + type: string + x-stream-index: "016" + type: + description: Type of activity + title: Type + type: string + x-stream-index: "002" + updated_at: + description: When the activity was last updated + format: date-time + title: Updated At + type: number + x-stream-index: "008" + user: + $ref: '#/components/schemas/UserResponse' + description: User who created the activity + title: User + x-stream-index: "003" + visibility: + description: Visibility setting for the activity + enum: + - public + - private + - tag + title: Visibility + type: string + x-stream-index: "005" + visibility_tag: + description: If visibility is 'tag', this is the tag name + title: Visibility Tag + type: string + x-stream-index: "006" + required: + - id + - type + - user + - feeds + - visibility + - created_at + - updated_at + - attachments + - mentioned_users + - custom + - popularity + - score + - comments + - search_data + - filter_tags + - interest_tags + - comment_count + - bookmark_count + - share_count + - reaction_count + - latest_reactions + - reaction_groups + - own_reactions + - own_bookmarks + title: Base Activity + type: object + ActivitySelectorConfig: + nullable: true + properties: + cutoff_time: + format: date-time + type: number + x-stream-index: "004" + filter: + additionalProperties: {} + type: object + x-stream-index: "002" + min_popularity: + format: int32 + type: integer + x-stream-index: "005" + sort: + items: + $ref: '#/components/schemas/SortParam' + type: array + x-stream-index: "003" + type: + type: string + x-stream-index: "001" + required: + - cutoff_time + type: object + ActivityUnpinnedEvent: + description: Emitted when an activity is unpinned. + nullable: true + properties: + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + feed_visibility: + type: string + x-stream-index: "002.003" + fid: + description: The ID of the feed + title: Feed ID + type: string + x-stream-index: "002.002" + pinned_activity: + $ref: '#/components/schemas/PinActivityResponse' + x-stream-index: "001" + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 + type: + default: feeds.activity.unpinned + description: 'The type of event: "feeds.activity.unpinned" in this case' + title: Event Type + type: string + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who unpinned the activity + title: User + x-stream-index: "003.001" + required: + - pinned_activity + - type + - created_at + - custom + - fid + title: ActivityUnpinnedEvent + 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 + ActivityUpdatedEvent: + description: Emitted when an activity is updated. + nullable: true + properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + description: The activity that was updated + title: Activity + x-stream-index: "001" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + feed_visibility: + type: string + x-stream-index: "002.003" + fid: + type: string + x-stream-index: "002.002" + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 + type: + default: feeds.activity.updated + description: The type of the event + title: Event Type + type: string + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who updated the activity + title: User + x-stream-index: "003.001" + required: + - activity + - type + - created_at + - custom + - fid + title: ActivityUpdatedEvent + 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 + AddActivityRequest: + nullable: true + properties: + attachments: + description: List of attachments for the activity + items: + $ref: '#/components/schemas/Attachment' + title: Attachments + type: array + x-stream-index: "001.006" + custom: + additionalProperties: {} + description: Custom data for the activity + title: Custom Data + type: object + x-stream-index: "001.017" + expires_at: + description: Expiration time for the activity + title: Expires At + type: string + x-stream-index: "001.010" + feeds: + description: List of feed IDs to add the activity to + items: + type: string + maximum: 255 + minimum: 1 + title: Feed IDs + type: array + x-stream-index: "001.004" + filter_tags: + description: Tags for filtering activities + items: + type: string + maximum: 255 + title: Filter Tags + type: array + x-stream-index: "001.013" + id: + description: Optional ID for the activity + maxLength: 255 + title: Activity ID + type: string + x-stream-index: "001.001" + interest_tags: + description: Tags for indicating user interests + items: + type: string + maximum: 255 + title: Interest Tags + type: array + x-stream-index: "001.014" + location: + $ref: '#/components/schemas/ActivityLocation' + description: Geographic location related to the activity + title: Location + x-stream-index: "001.009" + mentioned_user_ids: + description: List of users mentioned in the activity + items: + type: string + maximum: 255 + title: Mentioned User IDs + type: array + x-stream-index: "001.011" + parent_id: + description: ID of parent activity for replies/comments + maxLength: 255 + title: Parent ID + type: string + x-stream-index: "001.015" + poll_id: + description: ID of a poll to attach to activity + title: Poll ID + type: string + x-stream-index: "001.016" + search_data: + additionalProperties: {} + description: Additional data for search indexing + title: Search Data + type: object + x-stream-index: "001.012" + text: + description: Text content of the activity + title: Text + type: string + x-stream-index: "001.005" + type: + description: Type of activity + maxLength: 255 + title: Activity Type + type: string + x-stream-index: "001.002" + visibility: + description: Visibility setting for the activity + enum: + - public + - private + - tag + title: Visibility + type: string + x-stream-index: "001.007" + visibility_tag: + description: If visibility is 'tag', this is the tag name and is required + maxLength: 32 + title: Visibility Tag + type: string + x-stream-index: "001.008" + required: + - type + - feeds + title: Activity Request + type: object + AddActivityResponse: + nullable: true + properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + description: The created activity + title: Activity + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - activity + - duration + title: Add Activity Response + type: object + AddBookmarkRequest: + nullable: true + properties: + custom: + additionalProperties: {} + description: Custom data for the bookmark + title: Custom Data + type: object + x-stream-index: "004" + folder_id: + description: ID of the folder to add the bookmark to + maxLength: 255 + title: Folder ID + type: string + x-stream-index: "002" + new_folder: + $ref: '#/components/schemas/AddFolderRequest' + description: Create a new folder for this bookmark + title: New Folder + x-stream-index: "003" + title: Add Bookmark Request + type: object + AddBookmarkResponse: + nullable: true + properties: + bookmark: + $ref: '#/components/schemas/BookmarkResponse' + description: The created bookmark + title: Bookmark + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - bookmark + - duration + title: Add Bookmark Response + type: object + AddCommentReactionRequest: + nullable: true + properties: + create_notification_activity: + description: Whether to create a notification activity for this reaction + title: boolean + type: boolean + x-stream-index: "004" + custom: + additionalProperties: {} + description: Optional custom data to add to the reaction + title: object + type: object + x-stream-index: "003" + skip_push: + type: boolean + x-stream-index: "005" + type: + description: The type of reaction, eg upvote, like, ... + maxLength: 255 + title: string + type: string + x-stream-index: "002" + required: + - type + type: object + AddCommentReactionResponse: + nullable: true + properties: + comment: + $ref: '#/components/schemas/CommentResponse' + description: The comment the reaction was added to + title: object + x-stream-index: "001" + duration: + description: Duration of the request + title: string + type: string + x-stream-index: "003.001" + reaction: + $ref: '#/components/schemas/FeedsReactionResponse' + description: The created or updated reaction + title: object + x-stream-index: "002" + required: + - comment + - reaction + - duration + type: object + AddCommentRequest: + nullable: true + properties: + attachments: + description: Media attachments for the reply + items: + $ref: '#/components/schemas/Attachment' + title: Attachments + type: array + x-stream-index: "004" + comment: + description: Text content of the comment + title: Comment + type: string + x-stream-index: "003" + create_notification_activity: + description: Whether to create a notification activity for this comment + title: Create Notification Activity + type: boolean + x-stream-index: "008" + custom: + additionalProperties: {} + description: Custom data for the comment + title: Custom Data + type: object + x-stream-index: "007" + mentioned_user_ids: + description: List of users mentioned in the reply + items: + type: string + maximum: 255 + title: Mentioned User IDs + type: array + x-stream-index: "005" + object_id: + description: ID of the object to comment on + title: Object ID + type: string + x-stream-index: "001" + object_type: + description: Type of the object to comment on + title: Object Type + type: string + x-stream-index: "002" + parent_id: + description: ID of parent comment for replies + title: Parent ID + type: string + x-stream-index: "006" + skip_push: + type: boolean + x-stream-index: "009" + required: + - object_id + - object_type + - comment + title: Add Comment Request + type: object + AddCommentResponse: + nullable: true + properties: + comment: + $ref: '#/components/schemas/CommentResponse' + description: The created comment + title: Comment + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - comment + - duration + title: Add Comment Response + type: object + AddCommentsBatchRequest: + nullable: true + properties: + comments: + description: List of comments to add + items: + $ref: '#/components/schemas/AddCommentRequest' + title: Comments + type: array + x-stream-index: "001" + required: + - comments + title: Add Comments Batch Request + type: object + AddCommentsBatchResponse: + nullable: true + properties: + comments: + description: List of comments added + items: + $ref: '#/components/schemas/CommentResponse' + title: Comments + type: array + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - comments + - duration + title: Add Comments Batch Response + type: object + AddFolderRequest: + properties: + custom: + additionalProperties: {} + description: Custom data for the folder + title: Custom Data + type: object + x-stream-index: "002" + name: + description: Name of the folder + maxLength: 255 + title: Name + type: string + x-stream-index: "001" + required: + - name + title: Add Folder Request + type: object + AddReactionRequest: + nullable: true + properties: + create_notification_activity: + description: Whether to create a notification activity for this reaction + title: Create Notification Activity + type: boolean + x-stream-index: "004" + custom: + additionalProperties: {} + description: Custom data for the reaction + title: Custom Data + type: object + x-stream-index: "003" + skip_push: + type: boolean + x-stream-index: "005" + type: + description: Type of reaction + maxLength: 255 + title: Reaction Type + type: string + x-stream-index: "002" + required: + - type + title: Add Reaction Request + type: object + AddReactionResponse: + nullable: true + properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + x-stream-index: "001" + duration: + type: string + x-stream-index: "003.001" + reaction: + $ref: '#/components/schemas/FeedsReactionResponse' + description: The created reaction + title: Reaction + x-stream-index: "002" + required: + - activity + - reaction + - duration + title: Add Reaction Response + type: object + AggregatedActivityResponse: + properties: + activities: + description: List of activities in this aggregation + items: + $ref: '#/components/schemas/ActivityResponse' + title: Activities + type: array + x-stream-index: "001" + activity_count: + description: Number of activities in this aggregation + format: int32 + title: Activity Count + type: integer + x-stream-index: "002" + created_at: + description: When the aggregation was created + format: date-time + title: Created At + type: number + x-stream-index: "006" + group: + description: Grouping identifier + title: Group + type: string + x-stream-index: "004" + score: + description: Ranking score for this aggregation + format: float + title: Score + type: number + x-stream-index: "005" + updated_at: + description: When the aggregation was last updated + format: date-time + title: Updated At + type: number + x-stream-index: "007" + user_count: + description: Number of unique users in this aggregation + format: int32 + title: User Count + type: integer + x-stream-index: "003" + required: + - activities + - activity_count + - user_count + - group + - score + - created_at + - updated_at + title: Aggregated Activity + type: object + AggregationConfig: + properties: + format: + type: string + x-stream-index: "001" + group_size: + format: int32 + type: integer + x-stream-index: "002" + type: object + AppEventResponse: + properties: + async_url_enrich_enabled: + description: boolean + title: Async URL Enrichment Enabled + type: boolean + x-stream-index: "002" + auto_translation_enabled: + description: boolean + title: Auto Translation Enabled + type: boolean + x-stream-index: "003" + file_upload_config: + $ref: '#/components/schemas/FileUploadConfig' + description: file upload config + title: File Upload Config + x-stream-index: "004" + image_upload_config: + $ref: '#/components/schemas/FileUploadConfig' + description: file upload config + title: Image Upload Config + x-stream-index: "005" + name: + description: string + title: App name + type: string + x-stream-index: "001" + required: + - name + - auto_translation_enabled + type: object + AppResponseFields: + properties: + async_url_enrich_enabled: + type: boolean + x-stream-index: "017" + auto_translation_enabled: + type: boolean + x-stream-index: "020" + file_upload_config: + $ref: '#/components/schemas/FileUploadConfig' + x-stream-index: "030" + image_upload_config: + $ref: '#/components/schemas/FileUploadConfig' + x-stream-index: "031" + name: + type: string + x-stream-index: "001" + required: + - name + - organization + - push_notifications + - webhook_url + - moderation_webhook_url + - channel_configs + - call_types + - policies + - suspended + - suspended_explanation + - disable_auth_checks + - disable_permissions_checks + - permission_version + - user_search_disallowed_roles + - multi_tenant_enabled + - image_moderation_enabled + - async_url_enrich_enabled + - auto_translation_enabled + - custom_action_handler_url + - enforce_unique_usernames + - sqs_url + - sqs_key + - sqs_secret + - sns_topic_arn + - sns_key + - sns_secret + - file_upload_config + - image_upload_config + - grants + - campaign_enabled + - webhook_events + - reminders_interval + - cdn_expiration_seconds + - video_provider + - moderation_enabled + - moderation_multitenant_blocklist_enabled + - guest_user_creation_disabled + - event_hooks + - use_hook_v2 + - user_response_time_enabled + - moderation_bulk_submit_action_enabled + - moderation_llm_configurability_enabled + type: object + AppUpdatedEvent: + description: Emitted when app settings are updated + nullable: true + properties: + app: + $ref: '#/components/schemas/AppEventResponse' + description: application configuration + title: App settings + x-stream-index: "002" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: "001.003" + custom: + additionalProperties: {} + type: object + x-stream-index: "001.007" + received_at: + format: date-time + type: number + x-stream-index: "001.004" + type: + default: app.updated + description: 'The type of event: "app.updated" in this case' + title: Event Type + type: string + x-stream-index: "001.002" + required: + - type + - created_at + - custom + - app + title: AppUpdatedEvent + 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 + Attachment: + description: An attachment is a message object that represents a file uploaded + by a user. + nullable: true + properties: + actions: + items: + $ref: '#/components/schemas/Action' + type: array + x-stream-index: "015" + asset_url: + type: string + x-stream-index: "017" + author_icon: + type: string + x-stream-index: "007" + author_link: + type: string + x-stream-index: "006" + author_name: + type: string + x-stream-index: "005" + color: + type: string + x-stream-index: "003" + custom: + additionalProperties: {} + type: object + x-stream-index: "018" + fallback: + type: string + x-stream-index: "002" + fields: + items: + $ref: '#/components/schemas/Field' + type: array + x-stream-index: "016" + footer: + type: string + x-stream-index: "013" + footer_icon: + type: string + x-stream-index: "014" + giphy: + $ref: '#/components/schemas/Images' + x-stream-index: "019" + image_url: + type: string + x-stream-index: "011" + og_scrape_url: + type: string + x-stream-index: "020" + original_height: + format: int32 + type: integer + x-stream-index: "022" + original_width: + format: int32 + type: integer + x-stream-index: "021" + pretext: + type: string + x-stream-index: "004" + text: + type: string + x-stream-index: "010" + thumb_url: + type: string + x-stream-index: "012" + title: + type: string + x-stream-index: "008" + title_link: + type: string + x-stream-index: "009" + type: + description: Attachment type (e.g. image, video, url) + title: Type + type: string + x-stream-index: "001" + required: + - custom + title: Attachment + type: object + x-stream-docs-page-id: file_uploads + AudioSettings: + properties: + access_request_enabled: + type: boolean + x-stream-index: "001" + default_device: + enum: + - speaker + - earpiece + type: string + x-stream-index: "006" + mic_default_on: + type: boolean + x-stream-index: "004" + noise_cancellation: + $ref: '#/components/schemas/NoiseCancellationSettings' + x-stream-index: "007" + opus_dtx_enabled: + type: boolean + x-stream-index: "002" + redundant_coding_enabled: + type: boolean + x-stream-index: "003" + speaker_default_on: + type: boolean + x-stream-index: "005" + required: + - access_request_enabled + - opus_dtx_enabled + - redundant_coding_enabled + - mic_default_on + - speaker_default_on + - default_device + type: object + AudioSettingsResponse: + properties: + access_request_enabled: + type: boolean + x-stream-index: "001" + default_device: + enum: + - speaker + - earpiece + type: string + x-stream-index: "006" + mic_default_on: + type: boolean + x-stream-index: "004" + noise_cancellation: + $ref: '#/components/schemas/NoiseCancellationSettings' + x-stream-index: "007" + opus_dtx_enabled: + type: boolean + x-stream-index: "002" + redundant_coding_enabled: + type: boolean + x-stream-index: "003" + speaker_default_on: + type: boolean + x-stream-index: "005" + required: + - access_request_enabled + - opus_dtx_enabled + - redundant_coding_enabled + - mic_default_on + - speaker_default_on + - default_device + type: object + AutomodPlatformCircumventionConfig: + properties: + async: + type: boolean + x-stream-index: "001" + enabled: + type: boolean + x-stream-index: "002" + rules: + items: + $ref: '#/components/schemas/AutomodRule' + type: array + x-stream-index: "003" + required: + - enabled + - rules + type: object + AutomodRule: + properties: + action: + enum: + - flag + - shadow + - remove + - bounce + - bounce_flag + - bounce_remove + type: string + x-stream-index: "003" + label: + type: string + x-stream-index: "001" + threshold: + format: float + maximum: 1 + minimum: 0 + type: number + x-stream-index: "002" + required: + - label + - threshold + - action + type: object + AutomodSemanticFiltersConfig: + properties: + async: + type: boolean + x-stream-index: "001" + enabled: + type: boolean + x-stream-index: "002" + rules: + items: + $ref: '#/components/schemas/AutomodSemanticFiltersRule' + type: array + x-stream-index: "003" + required: + - enabled + - rules + type: object + AutomodSemanticFiltersRule: + properties: + action: + enum: + - flag + - shadow + - remove + type: string + x-stream-index: "003" + name: + type: string + x-stream-index: "001" + threshold: + format: float + maximum: 1 + minimum: 0 + type: number + x-stream-index: "002" + required: + - name + - threshold + - action + type: object + AutomodToxicityConfig: + properties: + async: + type: boolean + x-stream-index: "001" + enabled: + type: boolean + x-stream-index: "002" + rules: + items: + $ref: '#/components/schemas/AutomodRule' + type: array + x-stream-index: "003" + required: + - enabled + - rules + type: object + BackstageSettings: + properties: + enabled: + type: boolean + x-stream-index: "001" + join_ahead_time_seconds: + format: int32 + type: integer + x-stream-index: "002" + required: + - enabled + type: object + BackstageSettingsResponse: + properties: + enabled: + type: boolean + x-stream-index: "001" + join_ahead_time_seconds: + format: int32 + type: integer + x-stream-index: "002" + required: + - enabled + type: object + Ban: + nullable: true + properties: + channel: + $ref: '#/components/schemas/Channel' + x-stream-index: "004" + created_at: + format: date-time + type: number + x-stream-index: "012" + created_by: + $ref: '#/components/schemas/User' + x-stream-index: "011" + expires: + format: date-time + type: number + x-stream-index: "007" + reason: + type: string + x-stream-index: "008" + shadow: + type: boolean + x-stream-index: "009" + target: + $ref: '#/components/schemas/User' + x-stream-index: "006" + required: + - shadow + - created_at + type: object + BanActionRequest: + properties: + channel_ban_only: + type: boolean + x-stream-index: "003" + delete_messages: + enum: + - soft + - pruning + - hard + type: string + x-stream-index: "005" + ip_ban: + type: boolean + x-stream-index: "004" + reason: + type: string + x-stream-index: "002" + shadow: + type: boolean + x-stream-index: "001" + timeout: + format: int32 + type: integer + x-stream-index: "006" + type: object + BanOptions: + properties: + duration: + format: int32 + type: integer + x-stream-index: "001" + ip_ban: + type: boolean + x-stream-index: "004" + reason: + type: string + x-stream-index: "002" + shadow_ban: + type: boolean + x-stream-index: "003" + type: object + BanRequest: + nullable: true + properties: + banned_by: + $ref: '#/components/schemas/UserRequest' + description: Details about the user performing the ban + title: Banned By + x-stream-index: "008" + banned_by_id: + description: ID of the user performing the ban + title: Banned By ID + type: string + x-stream-index: "007" + channel_cid: + description: Channel where the ban applies + title: Channel CID + type: string + x-stream-index: "004" + delete_messages: + enum: + - soft + - pruning + - hard + type: string + x-stream-index: "009" + ip_ban: + description: Whether to ban the user's IP address + title: IP Ban + type: boolean + x-stream-index: "006" + reason: + description: Optional explanation for the ban + title: Reason + type: string + x-stream-index: "003" + shadow: + description: Whether this is a shadow ban + title: Shadow + type: boolean + x-stream-index: "005" + target_user_id: + description: ID of the user to ban + title: Target User ID + type: string + x-stream-index: "001" + timeout: + description: Duration of the ban in minutes + minimum: 0 + title: Timeout + type: integer + x-stream-index: "002" + required: + - target_user_id + type: object + BanResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "001.001" + required: + - duration + type: object + BlockContentOptions: + properties: + reason: + type: string + x-stream-index: "001" + type: object + BlockListConfig: + properties: + async: + type: boolean + x-stream-index: "001" + enabled: + type: boolean + x-stream-index: "002" + rules: + items: + $ref: '#/components/schemas/BlockListRule' + maximum: 10 + type: array + x-stream-index: "003" + required: + - enabled + - rules + type: object + BlockListOptions: + properties: + behavior: + description: Blocklist behavior + enum: + - flag + - block + - shadow_block + title: Behavior + type: string + x-stream-index: "002" + blocklist: + description: Blocklist name + title: Blocklist + type: string + x-stream-index: "001" + required: + - blocklist + - behavior + type: object + BlockListResponse: + description: Block list contains restricted words + properties: + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: "001" + id: + type: string + x-stream-index: "003" + name: + description: Block list name + title: Name + type: string + x-stream-index: "004" + team: + type: string + x-stream-index: "007" + type: + description: Block list type. + title: Type + type: string + x-stream-index: "005" + updated_at: + description: Date/time of the last update + format: date-time + title: Updated at + type: number + x-stream-index: "002" + words: + description: List of words to block + items: + type: string + title: Words + type: array + x-stream-index: "006" + required: + - name + - type + - words + title: Block list + type: object + x-stream-docs-page-id: block_lists + BlockListRule: + properties: + action: + enum: + - flag + - mask_flag + - shadow + - remove + - bounce + - bounce_flag + - bounce_remove + type: string + x-stream-index: "003" + name: + type: string + x-stream-index: "001" + team: + type: string + x-stream-index: "002" + required: + - name + - team + - action + type: object + BlockUsersRequest: + nullable: true + properties: + blocked_user_id: + description: User id to block + title: BlockedUserID + type: string + x-stream-index: "001" + required: + - blocked_user_id + type: object + BlockUsersResponse: + nullable: true + properties: + blocked_by_user_id: + description: User id who blocked another user + title: BlockedByUserID + type: string + x-stream-index: "002" + blocked_user_id: + description: User id who got blocked + title: BlockedUserID + type: string + x-stream-index: "003" + created_at: + description: Timestamp when the user was blocked + format: date-time + title: CreatedAt + type: number + x-stream-index: "004" + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "001.001" + required: + - duration + - blocked_by_user_id + - blocked_user_id + - created_at + type: object + BlockedUserResponse: + nullable: true + properties: + blocked_user: + $ref: '#/components/schemas/UserResponse' + description: User who got blocked + title: User + x-stream-index: "003" + blocked_user_id: + description: ID of the user who got blocked + title: UserID + type: string + x-stream-index: "004" + created_at: + format: date-time + type: number + x-stream-index: "005" + user: + $ref: '#/components/schemas/UserResponse' + description: User who blocked another user + title: User + x-stream-index: "001" + user_id: + description: ID of the user who blocked another user + title: UserID + type: string + x-stream-index: "002" + required: + - user + - user_id + - blocked_user + - blocked_user_id + - created_at + type: object + BodyguardRule: + properties: + action: + enum: + - flag + - shadow + - remove + - bounce + - bounce_flag + - bounce_remove + type: string + x-stream-index: "002" + label: + type: string + x-stream-index: "001" + severity_rules: + items: + $ref: '#/components/schemas/BodyguardSeverityRule' + type: array + x-stream-index: "003" + required: + - label + - action + - severity_rules + type: object + BodyguardSeverityRule: + properties: + action: + enum: + - flag + - shadow + - remove + - bounce + - bounce_flag + - bounce_remove + type: string + x-stream-index: "002" + severity: + enum: + - low + - medium + - high + - critical + type: string + x-stream-index: "001" + required: + - severity + - action + type: object + BookmarkAddedEvent: + description: Emitted when a user bookmarks an activity. + nullable: true + properties: + bookmark: + $ref: '#/components/schemas/BookmarkResponse' + x-stream-index: "001" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 + type: + default: feeds.bookmark.added + description: 'The type of event: "feeds.bookmark.added" in this case' + title: Event Type + type: string + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who added the bookmark + title: User + x-stream-index: "003.001" + required: + - bookmark + - type + - created_at + - custom + title: BookmarkAddedEvent + 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 + BookmarkDeletedEvent: + description: Emitted when a user deletes a bookmark from an activity. + nullable: true + properties: + bookmark: + $ref: '#/components/schemas/BookmarkResponse' + x-stream-index: "001" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 + type: + default: feeds.bookmark.deleted + description: 'The type of event: "feeds.bookmark.deleted" in this case' + title: Event Type + type: string + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who removed the bookmark + title: User + x-stream-index: "003.001" + required: + - bookmark + - type + - created_at + - custom + title: BookmarkDeletedEvent + 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 + BookmarkFolderDeletedEvent: + description: Emitted when a bookmark folder is deleted. + nullable: true + properties: + bookmark_folder: + $ref: '#/components/schemas/BookmarkFolderResponse' + description: The bookmark folder that was deleted + title: Bookmark Folder + x-stream-index: "001" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 + type: + default: feeds.bookmark_folder.deleted + description: 'The type of event: "feeds.bookmark_folder.deleted" in this + case' + title: Event Type + type: string + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who deleted the bookmark folder + title: User + x-stream-index: "003.001" + required: + - bookmark_folder + - type + - created_at + - custom + title: BookmarkFolderDeletedEvent + 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 + BookmarkFolderResponse: + properties: + created_at: + description: When the folder was created + format: date-time + title: Created At + type: number + x-stream-index: "004" + custom: + additionalProperties: {} + description: Custom data for the folder + title: Custom Data + type: object + x-stream-index: "003" + id: + description: Unique identifier for the folder + title: ID + type: string + x-stream-index: "001" + name: + description: Name of the folder + title: Name + type: string + x-stream-index: "002" + updated_at: + description: When the folder was last updated + format: date-time + title: Updated At + type: number + x-stream-index: "005" + required: + - id + - name + - created_at + - updated_at + title: Bookmark Folder + type: object + BookmarkFolderUpdatedEvent: + description: Emitted when a bookmark folder is updated. + nullable: true + properties: + bookmark_folder: + $ref: '#/components/schemas/BookmarkFolderResponse' + description: The bookmark folder that was updated + title: Bookmark Folder + x-stream-index: "001" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 + type: + default: feeds.bookmark_folder.updated + description: 'The type of event: "feeds.bookmark_folder.updated" in this + case' + title: Event Type + type: string + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who updated the bookmark folder + title: User + x-stream-index: "003.001" + required: + - bookmark_folder + - type + - created_at + - custom + title: BookmarkFolderUpdatedEvent + 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 + BookmarkResponse: + properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + description: The bookmarked activity + title: Activity + x-stream-index: "002" + created_at: + description: When the bookmark was created + format: date-time + title: Created At + type: number + x-stream-index: "005" + custom: + additionalProperties: {} + description: Custom data for the bookmark + title: Custom Data + type: object + x-stream-index: "004" + folder: + $ref: '#/components/schemas/BookmarkFolderResponse' + description: Folder containing this bookmark + title: Folder + x-stream-index: "003" + updated_at: + description: When the bookmark was last updated + format: date-time + title: Updated At + type: number + x-stream-index: "006" + user: + $ref: '#/components/schemas/UserResponse' + description: User who created the bookmark + title: User + x-stream-index: "001" + required: + - user + - activity + - created_at + - updated_at + title: Bookmark + type: object + BookmarkUpdatedEvent: + description: Emitted when a user updates a bookmark. + nullable: true + properties: + bookmark: + $ref: '#/components/schemas/BookmarkResponse' + description: The updated bookmark + title: Bookmark + x-stream-index: "001" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 + type: + default: feeds.bookmark.updated + description: 'The type of event: "feeds.bookmark.updated" in this case' + title: Event Type + type: string + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who updated the bookmark + title: User + x-stream-index: "003.001" + required: + - bookmark + - type + - created_at + - custom + title: BookmarkUpdatedEvent + 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 + BroadcastSettings: + properties: + enabled: + type: boolean + x-stream-index: "001" + hls: + $ref: '#/components/schemas/HLSSettings' + x-stream-index: "002" + rtmp: + $ref: '#/components/schemas/RTMPSettings' + x-stream-index: "003" + required: + - enabled + type: object + BroadcastSettingsResponse: + description: BroadcastSettingsResponse is the payload for broadcasting settings + properties: + enabled: + title: Enabled + type: boolean + x-stream-index: "001" + hls: + $ref: '#/components/schemas/HLSSettingsResponse' + title: HLS + x-stream-index: "002" + rtmp: + $ref: '#/components/schemas/RTMPSettingsResponse' + title: RTMP + x-stream-index: "003" + required: + - enabled + - hls + - rtmp + title: BroadcastSettingsResponse + type: object + Call: + properties: + AppPK: + format: int32 + type: integer + writeOnly: true + x-stream-index: "002" + Backstage: + type: boolean + writeOnly: true + x-stream-index: "023" + BlockedUserIDs: + items: + type: string + type: array + writeOnly: true + x-stream-index: "018" + BlockedUsers: + items: + $ref: '#/components/schemas/User' + type: array + writeOnly: true + x-stream-index: "019" + CID: + type: string + writeOnly: true + x-stream-index: "005" + CallType: + $ref: '#/components/schemas/CallType' + x-stream-index: "020" + ChannelCID: + type: string + writeOnly: true + x-stream-index: "032" + CreatedAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "013" + CreatedBy: + $ref: '#/components/schemas/User' + x-stream-index: "008" + CreatedByUserID: + type: string + writeOnly: true + x-stream-index: "007" + CurrentSessionID: + type: string + writeOnly: true + x-stream-index: "024" + Custom: + additionalProperties: {} + type: object + writeOnly: true + x-stream-index: "012" + DeletedAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "028" + EgressUpdatedAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "027" + Egresses: + items: + $ref: '#/components/schemas/CallEgress' + type: array + writeOnly: true + x-stream-index: "015" + EndedAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "017" + ID: + type: string + writeOnly: true + x-stream-index: "004" + JoinAheadTimeSeconds: + format: int32 + type: integer + writeOnly: true + x-stream-index: "031" + LastHeartbeatAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "030" + LastSessionID: + type: string + writeOnly: true + x-stream-index: "025" + MemberCount: + format: int32 + type: integer + writeOnly: true + x-stream-index: "010" + MemberLookup: + $ref: '#/components/schemas/MemberLookup' + x-stream-index: "011" + Members: + items: + $ref: '#/components/schemas/CallMember' + type: array + writeOnly: true + x-stream-index: "009" + Session: + $ref: '#/components/schemas/CallSession' + x-stream-index: "026" + Settings: + $ref: '#/components/schemas/CallSettings' + x-stream-index: "022" + SettingsOverrides: + $ref: '#/components/schemas/CallSettings' + x-stream-index: "021" + StartsAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "016" + Team: + type: string + writeOnly: true + x-stream-index: "006" + ThumbnailURL: + type: string + writeOnly: true + x-stream-index: "029" + Type: + type: string + writeOnly: true + x-stream-index: "003" + UpdatedAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "014" + required: + - AppPK + - Type + - ID + - CID + - Team + - CreatedByUserID + - Members + - Custom + - CreatedAt + - UpdatedAt + - Egresses + - BlockedUserIDs + - BlockedUsers + - Backstage + - CurrentSessionID + - LastSessionID + - ThumbnailURL + - ChannelCID + type: object + CallEgress: + nullable: true + properties: + app_pk: + format: int32 + type: integer + x-stream-index: "002" + call_id: + type: string + x-stream-index: "004" + call_type: + type: string + x-stream-index: "003" + config: + $ref: '#/components/schemas/EgressTaskConfig' + x-stream-index: "007" + egress_id: + type: string + x-stream-index: "005" + egress_type: + type: string + x-stream-index: "006" + instance_ip: + type: string + x-stream-index: "008" + started_at: + format: date-time + type: number + x-stream-index: "010" + state: + type: string + x-stream-index: "009" + stopped_at: + format: date-time + type: number + x-stream-index: "011" + updated_at: + format: date-time + type: number + x-stream-index: "012" + required: + - app_pk + - call_type + - call_id + - egress_id + - egress_type + - instance_ip + - state + - started_at + - updated_at + type: object + CallIngressResponse: + description: CallIngressResponse is the payload for ingress settings + properties: + rtmp: + $ref: '#/components/schemas/RTMPIngress' + title: RTMP + x-stream-index: "001" + required: + - rtmp + title: CallIngressResponse + type: object + CallMember: + nullable: true + properties: + created_at: + format: date-time + type: number + x-stream-index: "008" + custom: + additionalProperties: {} + type: object + x-stream-index: "007" + deleted_at: + format: date-time + type: number + x-stream-index: "010" + role: + type: string + x-stream-index: "006" + updated_at: + format: date-time + type: number + x-stream-index: "009" + user: + $ref: '#/components/schemas/User' + x-stream-index: "005" + user_id: + type: string + x-stream-index: "004" + required: + - user_id + - role + - custom + - created_at + - updated_at + type: object + CallParticipant: + nullable: true + properties: + JoinedAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "004" + Role: + type: string + writeOnly: true + x-stream-index: "002" + UserSessionID: + type: string + writeOnly: true + x-stream-index: "003" + avg_response_time: + format: int32 + readOnly: true + type: integer + x-stream-index: "001.046" + ban_expires: + format: date-time + type: number + x-stream-index: "001.017" + banned: + type: boolean + x-stream-index: "001.016" + created_at: + format: date-time + readOnly: true + type: number + x-stream-index: "001.008" + custom: + additionalProperties: {} + type: object + x-stream-index: "001.006" + deactivated_at: + format: date-time + readOnly: true + type: number + x-stream-index: "001.014" + deleted_at: + format: date-time + readOnly: true + type: number + x-stream-index: "001.013" + id: + type: string + x-stream-index: "001.003" + invisible: + type: boolean + x-stream-index: "001.023" + language: + type: string + x-stream-index: "001.035" + last_active: + format: date-time + readOnly: true + type: number + x-stream-index: "001.011" + last_engaged_at: + format: date-time + readOnly: true + type: number + x-stream-index: "001.012" + online: + readOnly: true + type: boolean + x-stream-index: "001.022" + privacy_settings: + $ref: '#/components/schemas/PrivacySettings' + x-stream-index: "001.026" + revoke_tokens_issued_before: + format: date-time + type: number + x-stream-index: "001.042" + role: + type: string + x-stream-index: "001.004" + teams: + items: + type: string + type: array + x-stream-index: "001.036" + teams_role: + additionalProperties: + type: string + type: object + x-stream-index: "001.005" + updated_at: + format: date-time + readOnly: true + type: number + x-stream-index: "001.009" + required: + - id + - role + - teams_role + - custom + - banned + - online + - Role + - UserSessionID + - JoinedAt + type: object + CallParticipantResponse: + properties: + joined_at: + format: date-time + type: number + x-stream-index: "004" + role: + type: string + x-stream-index: "003" + user: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "001" + user_session_id: + type: string + x-stream-index: "002" + required: + - user + - user_session_id + - role + - joined_at + type: object + CallResponse: + description: Represents a call + properties: + backstage: + type: boolean + x-stream-index: "016" + blocked_user_ids: + items: + type: string + type: array + x-stream-index: "018" + captioning: + type: boolean + x-stream-index: "013" + channel_cid: + type: string + x-stream-index: "024" + cid: + description: The unique identifier for a call (:) + title: CID + type: string + x-stream-index: "004" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: "009" + created_by: + $ref: '#/components/schemas/UserResponse' + description: The user that created the call + title: Created By + x-stream-index: "007" + current_session_id: + type: string + x-stream-index: "005" + custom: + additionalProperties: {} + description: Custom data for this object + title: Custom data + type: object + x-stream-index: "008" + egress: + $ref: '#/components/schemas/EgressResponse' + x-stream-index: "021" + ended_at: + description: Date/time when the call ended + format: date-time + title: Ended At + type: number + x-stream-index: "014" + id: + description: Call ID + title: ID + type: string + x-stream-index: "003" + ingress: + $ref: '#/components/schemas/CallIngressResponse' + x-stream-index: "019" + join_ahead_time_seconds: + format: int32 + type: integer + x-stream-index: "023" + recording: + type: boolean + x-stream-index: "011" + session: + $ref: '#/components/schemas/CallSessionResponse' + x-stream-index: "020" + settings: + $ref: '#/components/schemas/CallSettingsResponse' + x-stream-index: "017" + starts_at: + description: Date/time when the call will start + format: date-time + title: Starts At + type: number + x-stream-index: "015" + team: + type: string + x-stream-index: "006" + thumbnails: + $ref: '#/components/schemas/ThumbnailResponse' + x-stream-index: "022" + transcribing: + type: boolean + x-stream-index: "012" + type: + description: The type of call + title: Type + type: string + x-stream-index: "002" + updated_at: + description: Date/time of the last update + format: date-time + title: Updated at + type: number + x-stream-index: "010" + required: + - type + - id + - cid + - current_session_id + - created_by + - custom + - created_at + - updated_at + - recording + - transcribing + - captioning + - backstage + - settings + - blocked_user_ids + - ingress + - egress + title: CallResponse + type: object + CallSession: + properties: + AcceptedBy: + additionalProperties: + format: date-time + type: number + type: object + writeOnly: true + x-stream-index: "008" + ActiveSFUs: + items: + $ref: '#/components/schemas/SFUIDLastSeen' + type: array + writeOnly: true + x-stream-index: "016" + AnonymousParticipantCount: + format: int32 + type: integer + writeOnly: true + x-stream-index: "019" + AppPK: + format: int32 + type: integer + writeOnly: true + x-stream-index: "002.001" + CallID: + type: string + writeOnly: true + x-stream-index: "002.003" + CallType: + type: string + writeOnly: true + x-stream-index: "002.002" + CreatedAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "003" + DeletedAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "004" + EndedAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "006" + LiveEndedAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "013" + LiveStartedAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "012" + MissedBy: + additionalProperties: + format: date-time + type: number + type: object + writeOnly: true + x-stream-index: "010" + Participants: + items: + $ref: '#/components/schemas/CallParticipant' + type: array + writeOnly: true + x-stream-index: "011" + ParticipantsCountByRole: + additionalProperties: + format: int32 + type: integer + type: object + writeOnly: true + x-stream-index: "018" + RejectedBy: + additionalProperties: + format: date-time + type: number + type: object + writeOnly: true + x-stream-index: "009" + RingAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "007" + SFUIDs: + items: + type: string + type: array + writeOnly: true + x-stream-index: "015" + SessionID: + type: string + writeOnly: true + x-stream-index: "002.004" + StartedAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "005" + TimerEndsAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "014" + UserPermissionOverrides: + additionalProperties: + additionalProperties: + type: boolean + type: object + type: object + writeOnly: true + x-stream-index: "017" + required: + - AppPK + - CallType + - CallID + - SessionID + - CreatedAt + - AcceptedBy + - RejectedBy + - MissedBy + - Participants + - SFUIDs + - ActiveSFUs + - UserPermissionOverrides + - ParticipantsCountByRole + - AnonymousParticipantCount + type: object + CallSessionResponse: + properties: + accepted_by: + additionalProperties: + format: date-time + type: number + type: object + x-stream-index: "008" + anonymous_participant_count: + format: int32 + type: integer + x-stream-index: "006" + ended_at: + format: date-time + type: number + x-stream-index: "003" + id: + type: string + x-stream-index: "001" + live_ended_at: + format: date-time + type: number + x-stream-index: "011" + live_started_at: + format: date-time + type: number + x-stream-index: "010" + missed_by: + additionalProperties: + format: date-time + type: number + type: object + x-stream-index: "009" + participants: + items: + $ref: '#/components/schemas/CallParticipantResponse' + type: array + x-stream-index: "004" + participants_count_by_role: + additionalProperties: + format: int32 + type: integer + type: object + x-stream-index: "005" + rejected_by: + additionalProperties: + format: date-time + type: number + type: object + x-stream-index: "007" + started_at: + format: date-time + type: number + x-stream-index: "002" + timer_ends_at: + format: date-time + type: number + x-stream-index: "012" + required: + - id + - participants + - participants_count_by_role + - anonymous_participant_count + - rejected_by + - accepted_by + - missed_by + type: object + CallSettings: + properties: + audio: + $ref: '#/components/schemas/AudioSettings' + x-stream-index: "001" + backstage: + $ref: '#/components/schemas/BackstageSettings' + x-stream-index: "002" + broadcasting: + $ref: '#/components/schemas/BroadcastSettings' + x-stream-index: "007" + frame_recording: + $ref: '#/components/schemas/FrameRecordSettings' + x-stream-index: "006" + geofencing: + $ref: '#/components/schemas/GeofenceSettings' + x-stream-index: "008" + ingress: + $ref: '#/components/schemas/IngressSettings' + x-stream-index: "014" + limits: + $ref: '#/components/schemas/LimitsSettings' + x-stream-index: "012" + recording: + $ref: '#/components/schemas/RecordSettings' + x-stream-index: "005" + ring: + $ref: '#/components/schemas/RingSettings' + x-stream-index: "010" + screensharing: + $ref: '#/components/schemas/ScreensharingSettings' + x-stream-index: "004" + session: + $ref: '#/components/schemas/SessionSettings' + x-stream-index: "013" + thumbnails: + $ref: '#/components/schemas/ThumbnailsSettings' + x-stream-index: "011" + transcription: + $ref: '#/components/schemas/TranscriptionSettings' + x-stream-index: "009" + video: + $ref: '#/components/schemas/VideoSettings' + x-stream-index: "003" + type: object + CallSettingsResponse: + properties: + audio: + $ref: '#/components/schemas/AudioSettingsResponse' + x-stream-index: "001" + backstage: + $ref: '#/components/schemas/BackstageSettingsResponse' + x-stream-index: "002" + broadcasting: + $ref: '#/components/schemas/BroadcastSettingsResponse' + x-stream-index: "003" + frame_recording: + $ref: '#/components/schemas/FrameRecordingSettingsResponse' + x-stream-index: "006" + geofencing: + $ref: '#/components/schemas/GeofenceSettingsResponse' + x-stream-index: "004" + ingress: + $ref: '#/components/schemas/IngressSettingsResponse' + x-stream-index: "014" + limits: + $ref: '#/components/schemas/LimitsSettingsResponse' + x-stream-index: "012" + recording: + $ref: '#/components/schemas/RecordSettingsResponse' + x-stream-index: "005" + ring: + $ref: '#/components/schemas/RingSettingsResponse' + x-stream-index: "007" + screensharing: + $ref: '#/components/schemas/ScreensharingSettingsResponse' + x-stream-index: "008" + session: + $ref: '#/components/schemas/SessionSettingsResponse' + x-stream-index: "013" + thumbnails: + $ref: '#/components/schemas/ThumbnailsSettingsResponse' + x-stream-index: "011" + transcription: + $ref: '#/components/schemas/TranscriptionSettingsResponse' + x-stream-index: "009" + video: + $ref: '#/components/schemas/VideoSettingsResponse' + x-stream-index: "010" + required: + - audio + - backstage + - broadcasting + - geofencing + - recording + - frame_recording + - ring + - screensharing + - transcription + - video + - thumbnails + - limits + - session + type: object + CallType: + properties: + AppPK: + format: int32 + type: integer + writeOnly: true + x-stream-index: "003" + CreatedAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "005" + ExternalStorage: + type: string + writeOnly: true + x-stream-index: "009" + Name: + type: string + writeOnly: true + x-stream-index: "004" + NotificationSettings: + $ref: '#/components/schemas/NotificationSettings' + x-stream-index: "008" + PK: + format: int32 + type: integer + writeOnly: true + x-stream-index: "002" + Settings: + $ref: '#/components/schemas/CallSettings' + x-stream-index: "007" + UpdatedAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "006" + required: + - PK + - AppPK + - Name + - CreatedAt + - UpdatedAt + - ExternalStorage + type: object + CastPollVoteRequest: + nullable: true + properties: + vote: + $ref: '#/components/schemas/VoteData' + description: Vote data + title: VoteData + x-stream-index: "004" + type: object + Channel: + properties: + active_live_locations: + items: + $ref: '#/components/schemas/SharedLocation' + type: array + x-stream-index: "034" + auto_translation_enabled: + type: boolean + x-stream-index: "029" + auto_translation_language: + type: string + x-stream-index: "030" + cid: + type: string + x-stream-index: "003" + config: + $ref: '#/components/schemas/ChannelConfig' + x-stream-index: "026" + config_overrides: + $ref: '#/components/schemas/ConfigOverrides' + x-stream-index: "027" + cooldown: + format: int32 + type: integer + x-stream-index: "031" + created_at: + format: date-time + type: number + x-stream-index: "009" + created_by: + $ref: '#/components/schemas/User' + x-stream-index: "008" + custom: + additionalProperties: {} + type: object + x-stream-index: "019" + deleted_at: + format: date-time + type: number + x-stream-index: "011" + disabled: + type: boolean + x-stream-index: "017" + frozen: + type: boolean + x-stream-index: "016" + id: + type: string + x-stream-index: "004" + invites: + items: + $ref: '#/components/schemas/ChannelMember' + type: array + x-stream-index: "022" + last_campaigns: + type: string + x-stream-index: "032" + last_message_at: + format: date-time + type: number + x-stream-index: "006" + member_count: + format: int32 + type: integer + x-stream-index: "021" + members: + items: + $ref: '#/components/schemas/ChannelMember' + type: array + x-stream-index: "020" + message_count: + format: int64 + type: integer + x-stream-index: "035" + message_count_updated_at: + format: date-time + type: number + x-stream-index: "036" + team: + type: string + x-stream-index: "028" + truncated_by: + $ref: '#/components/schemas/User' + x-stream-index: "015" + type: + type: string + x-stream-index: "005" + updated_at: + format: date-time + type: number + x-stream-index: "010" + required: + - cid + - id + - type + - created_at + - updated_at + - frozen + - disabled + - custom + - auto_translation_language + type: object + ChannelConfig: + properties: + allowed_flag_reasons: + items: + type: string + type: array + x-stream-index: "001.027" + automod: + enum: + - disabled + - simple + - AI + type: string + x-stream-index: "001.022" + automod_behavior: + enum: + - flag + - block + - shadow_block + type: string + x-stream-index: "001.023" + automod_thresholds: + $ref: '#/components/schemas/Thresholds' + x-stream-index: "001.028" + blocklist: + type: string + x-stream-index: "001.024" + blocklist_behavior: + enum: + - flag + - block + - shadow_block + type: string + x-stream-index: "001.025" + blocklists: + items: + $ref: '#/components/schemas/BlockListOptions' + type: array + x-stream-index: "001.026" + commands: + items: + type: string + type: array + x-stream-index: "003" + connect_events: + type: boolean + x-stream-index: "001.004" + count_messages: + type: boolean + x-stream-index: "001.019" + created_at: + format: date-time + type: number + x-stream-index: "002.003" + custom_events: + type: boolean + x-stream-index: "001.012" + mark_messages_pending: + type: boolean + x-stream-index: "001.015" + max_message_length: + format: int32 + maximum: 20000 + type: integer + x-stream-index: "001.021" + mutes: + type: boolean + x-stream-index: "001.009" + name: + type: string + x-stream-index: "001.001" + partition_size: + format: int32 + type: integer + x-stream-index: "001.029" + partition_ttl: + type: integer + x-stream-index: "001.030" + polls: + type: boolean + x-stream-index: "001.016" + push_notifications: + type: boolean + x-stream-index: "001.013" + quotes: + type: boolean + x-stream-index: "001.008" + reactions: + type: boolean + x-stream-index: "001.006" + read_events: + type: boolean + x-stream-index: "001.003" + reminders: + type: boolean + x-stream-index: "001.014" + replies: + type: boolean + x-stream-index: "001.007" + search: + type: boolean + x-stream-index: "001.005" + shared_locations: + type: boolean + x-stream-index: "001.018" + skip_last_msg_update_for_system_msgs: + type: boolean + x-stream-index: "001.031" + typing_events: + type: boolean + x-stream-index: "001.002" + updated_at: + format: date-time + type: number + x-stream-index: "002.004" + uploads: + type: boolean + x-stream-index: "001.010" + url_enrichment: + type: boolean + x-stream-index: "001.011" + user_message_reminders: + type: boolean + x-stream-index: "001.017" + required: + - name + - typing_events + - read_events + - connect_events + - search + - reactions + - replies + - quotes + - mutes + - uploads + - url_enrichment + - custom_events + - push_notifications + - reminders + - mark_messages_pending + - polls + - user_message_reminders + - shared_locations + - count_messages + - message_retention + - max_message_length + - automod + - automod_behavior + - skip_last_msg_update_for_system_msgs + - created_at + - updated_at + - commands + type: object + ChannelConfigWithInfo: + properties: + allowed_flag_reasons: + items: + type: string + type: array + x-stream-index: 001.002.027 + automod: + enum: + - disabled + - simple + - AI + type: string + x-stream-index: 001.002.022 + automod_behavior: + enum: + - flag + - block + - shadow_block + type: string + x-stream-index: 001.002.023 + automod_thresholds: + $ref: '#/components/schemas/Thresholds' + x-stream-index: 001.002.028 + blocklist: + type: string + x-stream-index: 001.002.024 + blocklist_behavior: + enum: + - flag + - block + - shadow_block + type: string + x-stream-index: 001.002.025 + blocklists: + items: + $ref: '#/components/schemas/BlockListOptions' + type: array + x-stream-index: 001.002.026 + commands: + items: + $ref: '#/components/schemas/Command' + type: array + x-stream-index: "001.003" + connect_events: + type: boolean + x-stream-index: 001.002.004 + count_messages: + type: boolean + x-stream-index: 001.002.019 + created_at: + format: date-time + type: number + x-stream-index: 001.001.003 + custom_events: + type: boolean + x-stream-index: 001.002.012 + grants: + additionalProperties: + items: + type: string + type: array + type: object + x-stream-index: "002" + mark_messages_pending: + type: boolean + x-stream-index: 001.002.015 + max_message_length: + format: int32 + maximum: 20000 + type: integer + x-stream-index: 001.002.021 + mutes: + type: boolean + x-stream-index: 001.002.009 + name: + type: string + x-stream-index: 001.002.001 + partition_size: + format: int32 + type: integer + x-stream-index: 001.002.029 + partition_ttl: + example: 24h + format: duration + nullable: true + type: string + x-stream-index: 001.002.030 + polls: + type: boolean + x-stream-index: 001.002.016 + push_notifications: + type: boolean + x-stream-index: 001.002.013 + quotes: + type: boolean + x-stream-index: 001.002.008 + reactions: + type: boolean + x-stream-index: 001.002.006 + read_events: + type: boolean + x-stream-index: 001.002.003 + reminders: + type: boolean + x-stream-index: 001.002.014 + replies: + type: boolean + x-stream-index: 001.002.007 + search: + type: boolean + x-stream-index: 001.002.005 + shared_locations: + type: boolean + x-stream-index: 001.002.018 + skip_last_msg_update_for_system_msgs: + type: boolean + x-stream-index: 001.002.031 + typing_events: + type: boolean + x-stream-index: 001.002.002 + updated_at: + format: date-time + type: number + x-stream-index: 001.001.004 + uploads: + type: boolean + x-stream-index: 001.002.010 + url_enrichment: + type: boolean + x-stream-index: 001.002.011 + user_message_reminders: + type: boolean + x-stream-index: 001.002.017 + required: + - created_at + - updated_at + - name + - typing_events + - read_events + - connect_events + - search + - reactions + - replies + - quotes + - mutes + - uploads + - url_enrichment + - custom_events + - push_notifications + - reminders + - mark_messages_pending + - polls + - user_message_reminders + - shared_locations + - count_messages + - message_retention + - max_message_length + - automod + - automod_behavior + - skip_last_msg_update_for_system_msgs + - commands + type: object + ChannelMember: + nullable: true + properties: + archived_at: + format: date-time + type: number + x-stream-index: "015" + ban_expires: + description: Expiration date of the ban + format: date-time + title: Ban expires + type: number + x-stream-index: "013" + banned: + description: Whether member is banned this channel or not + title: Banned + type: boolean + x-stream-index: "012" + channel_role: + description: Role of the member in the channel + title: Channel Role + type: string + x-stream-index: "018" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: "009" + custom: + additionalProperties: {} + type: object + x-stream-index: "004" + deleted_at: + format: date-time + type: number + x-stream-index: "011" + deleted_messages: + items: + type: string + type: array + x-stream-index: "020" + invite_accepted_at: + description: Date when invite was accepted + format: date-time + title: Invited accepted at + type: number + x-stream-index: "006" + invite_rejected_at: + description: Date when invite was rejected + format: date-time + title: Invited rejected at + type: number + x-stream-index: "007" + invited: + description: Whether member was invited or not + title: Invited + type: boolean + x-stream-index: "005" + is_moderator: + description: Whether member is channel moderator or not + title: Is moderator + type: boolean + x-stream-index: "003" + notifications_muted: + type: boolean + x-stream-index: "019" + pinned_at: + format: date-time + type: number + x-stream-index: "016" + role: + description: 'Permission level of the member in the channel (DEPRECATED: + use channel_role instead)' + enum: + - member + - moderator + - admin + - owner + title: Role + type: string + x-stream-index: "017" + shadow_banned: + description: Whether member is shadow banned in this channel or not + title: Shadow banned + type: boolean + x-stream-index: "014" + status: + type: string + x-stream-index: "008" + updated_at: + description: Date/time of the last update + format: date-time + title: Updated at + type: number + x-stream-index: "010" + user: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "002" + user_id: + title: User ID + type: string + x-stream-index: "001" + required: + - custom + - created_at + - updated_at + - banned + - shadow_banned + - channel_role + - notifications_muted + title: Channel member + type: object + ChannelMute: + nullable: true + properties: + channel: + $ref: '#/components/schemas/ChannelResponse' + description: Channel that is muted + title: Channel + x-stream-index: "002" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: "004" + expires: + description: Date/time of mute expiration + format: date-time + title: Expires + type: number + x-stream-index: "003" + updated_at: + description: Date/time of the last update + format: date-time + title: Updated at + type: number + x-stream-index: "005" + user: + $ref: '#/components/schemas/UserResponse' + description: Owner of channel mute + title: User + x-stream-index: "001" + required: + - created_at + - updated_at + type: object + ChannelOwnCapability: + description: All possibility of string to use + enum: + - ban-channel-members + - cast-poll-vote + - connect-events + - create-attachment + - delete-any-message + - delete-channel + - delete-own-message + - flag-message + - freeze-channel + - join-channel + - leave-channel + - mute-channel + - pin-message + - query-poll-votes + - quote-message + - read-events + - search-messages + - send-custom-events + - send-links + - send-message + - send-poll + - send-reaction + - send-reply + - send-restricted-visibility-message + - send-typing-events + - set-channel-cooldown + - share-location + - skip-slow-mode + - slow-mode + - typing-events + - update-any-message + - update-channel + - update-channel-members + - update-own-message + - update-thread + - upload-file + title: ChannelOwnCapability + type: string + ChannelResponse: + description: Represents channel in chat + properties: + auto_translation_enabled: + description: Whether auto translation is enabled or not + title: Auto translation + type: boolean + x-stream-index: "017" + auto_translation_language: + description: Language to translate to when auto translation is active + title: Auto translation language + type: string + x-stream-index: "018" + blocked: + description: Whether this channel is blocked by current user or not + title: Blocked + type: boolean + x-stream-index: "023" + cid: + description: Channel CID (:) + title: CID + type: string + x-stream-index: "003" + config: + $ref: '#/components/schemas/ChannelConfigWithInfo' + description: Channel configuration + title: ChannelConfigWithInfo + x-stream-index: "013" + cooldown: + description: Cooldown period after sending each message + format: int32 + title: Cooldown + type: integer + x-stream-index: "020" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: "005" + created_by: + $ref: '#/components/schemas/UserResponse' + description: Creator of the channel + title: UserResponse + x-stream-index: "008" + custom: + additionalProperties: {} + description: Custom data for this object + title: Custom data + type: object + x-stream-index: "026" + deleted_at: + description: Date/time of deletion + format: date-time + title: Deleted at + type: number + x-stream-index: "007" + disabled: + type: boolean + x-stream-index: "010" + frozen: + description: Whether channel is frozen or not + title: Frozen + type: boolean + x-stream-index: "009" + hidden: + description: Whether this channel is hidden by current user or not + title: Hidden + type: boolean + x-stream-index: "022" + hide_messages_before: + description: Date since when the message history is accessible + format: date-time + title: Hide messages before + type: number + x-stream-index: "019" + id: + description: Channel unique ID + title: ID + type: string + x-stream-index: "001" + last_message_at: + description: Date of the last message sent + format: date-time + title: Last message at + type: number + x-stream-index: "004" + member_count: + description: Number of members in the channel + format: int32 + title: Member count + type: integer + x-stream-index: "012" + members: + description: List of channel members (max 100) + items: + $ref: '#/components/schemas/ChannelMember' + title: ChannelMembers + type: array + x-stream-index: "011" + message_count: + description: Number of messages in the channel + format: int64 + title: Message count + type: integer + x-stream-index: "027" + mute_expires_at: + description: Date of mute expiration + format: date-time + title: Mute expires at + type: number + x-stream-index: "015" + muted: + description: Whether this channel is muted or not + title: Muted + type: boolean + x-stream-index: "014" + own_capabilities: + description: List of channel capabilities of authenticated user + items: + $ref: '#/components/schemas/ChannelOwnCapability' + title: ChannelOwnCapability + type: array + x-stream-index: "021" + team: + description: Team the channel belongs to (multi-tenant only) + title: Team + type: string + x-stream-index: "016" + truncated_at: + description: Date of the latest truncation of the channel + format: date-time + title: UserResponse + type: number + x-stream-index: "024" + truncated_by: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "025" + type: + description: Type of the channel + title: Type + type: string + x-stream-docs-page-id: channel_features + x-stream-index: "002" + updated_at: + description: Date/time of the last update + format: date-time + title: Updated at + type: number + x-stream-index: "006" + required: + - id + - type + - cid + - created_at + - updated_at + - frozen + - disabled + - custom + title: Channel + type: object + Command: + description: Represents custom chat command + nullable: true + properties: + args: + description: Arguments help text, shown in commands auto-completion + title: Arguments + type: string + x-stream-index: "006" + created_at: + description: Date/time of creation + format: date-time + readOnly: true + title: Created at + type: number + x-stream-index: "001" + description: + description: Description, shown in commands auto-completion + title: Description + type: string + x-stream-index: "005" + name: + description: Unique command name + title: Name + type: string + x-stream-index: "004" + set: + description: Set name used for grouping commands + title: Set + type: string + x-stream-index: "007" + updated_at: + description: Date/time of the last update + format: date-time + readOnly: true + title: Updated at + type: number + x-stream-index: "002" + required: + - name + - description + - args + - set + title: Command + type: object + CommentAddedEvent: + description: Emitted when a comment is added to an activity. + nullable: true + properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + x-stream-index: "002" + comment: + $ref: '#/components/schemas/CommentResponse' + description: The comment that was added + title: Text + x-stream-index: "001" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 003.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 003.001.007 + feed_visibility: + type: string + x-stream-index: "003.003" + fid: + type: string + x-stream-index: "003.002" + received_at: + format: date-time + type: number + x-stream-index: 003.001.004 + type: + default: feeds.comment.added + description: 'The type of event: "feeds.comment.added" in this case' + title: Event Type + type: string + x-stream-index: 003.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who added the comment + title: User + x-stream-index: "004.001" + required: + - comment + - activity + - type + - created_at + - custom + - fid + title: CommentAddedEvent + 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 + CommentDeletedEvent: + description: Emitted when a comment is deleted. + nullable: true + properties: + comment: + $ref: '#/components/schemas/CommentResponse' + x-stream-index: "001" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + feed_visibility: + type: string + x-stream-index: "002.003" + fid: + type: string + x-stream-index: "002.002" + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 + type: + default: feeds.comment.deleted + description: 'The type of event: "feeds.comment.deleted" in this case' + title: Event Type + type: string + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who deleted the comment + title: User + x-stream-index: "003.001" + required: + - comment + - type + - created_at + - custom + - fid + title: CommentDeletedEvent + 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 + CommentReactionAddedEvent: + description: Emitted when a reaction is added to a comment. + nullable: true + properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + x-stream-index: "003" + comment: + $ref: '#/components/schemas/CommentResponse' + x-stream-index: "001" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 004.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 004.001.007 + feed_visibility: + type: string + x-stream-index: "004.003" + fid: + type: string + x-stream-index: "004.002" + reaction: + $ref: '#/components/schemas/FeedsReactionResponse' + description: The reaction that was added + title: Reaction + x-stream-index: "002" + received_at: + format: date-time + type: number + x-stream-index: 004.001.004 + type: + default: feeds.comment.reaction.added + description: 'The type of event: "feeds.comment.reaction.added" in this + case' + title: Event Type + type: string + x-stream-index: 004.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who added the reaction + title: User + x-stream-index: "005.001" + required: + - comment + - reaction + - activity + - type + - created_at + - custom + - fid + title: CommentReactionAddedEvent + 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 + CommentReactionDeletedEvent: + description: Emitted when a reaction is deleted from a comment. + nullable: true + properties: + comment: + $ref: '#/components/schemas/CommentResponse' + x-stream-index: "001" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 003.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 003.001.007 + feed_visibility: + type: string + x-stream-index: "003.003" + fid: + type: string + x-stream-index: "003.002" + reaction: + $ref: '#/components/schemas/FeedsReactionResponse' + x-stream-index: "002" + received_at: + format: date-time + type: number + x-stream-index: 003.001.004 + type: + default: feeds.comment.reaction.deleted + description: The type of reaction that was removed + title: Type + type: string + x-stream-index: 003.001.002 + required: + - comment + - reaction + - type + - created_at + - custom + - fid + title: CommentReactionDeletedEvent + 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 + CommentReactionUpdatedEvent: + description: Emitted when a reaction is updated on a comment. + nullable: true + properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + x-stream-index: "003" + comment: + $ref: '#/components/schemas/CommentResponse' + x-stream-index: "001" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 004.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 004.001.007 + feed_visibility: + type: string + x-stream-index: "004.003" + fid: + type: string + x-stream-index: "004.002" + reaction: + $ref: '#/components/schemas/FeedsReactionResponse' + description: The reaction that was updated + title: Reaction + x-stream-index: "002" + received_at: + format: date-time + type: number + x-stream-index: 004.001.004 + type: + default: feeds.comment.reaction.updated + description: 'The type of event: "feeds.comment.reaction.updated" in this + case' + title: Event Type + type: string + x-stream-index: 004.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who updated the reaction + title: User + x-stream-index: "005.001" + required: + - comment + - reaction + - activity + - type + - created_at + - custom + - fid + title: CommentReactionUpdatedEvent + 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 + CommentResponse: + properties: + attachments: + items: + $ref: '#/components/schemas/Attachment' + type: array + x-stream-index: "011" + confidence_score: + description: Confidence score of the comment + format: float + title: Confidence Score + type: number + x-stream-index: "022" + controversy_score: + description: Controversy score of the comment + format: float + title: Controversy Score + type: number + x-stream-index: "023" + created_at: + description: When the comment was created + format: date-time + title: Created At + type: number + x-stream-index: "014" + custom: + additionalProperties: {} + description: Custom data for the comment + title: Custom Data + type: object + x-stream-index: "006" + deleted_at: + description: When the comment was deleted + format: date-time + title: Deleted At + type: number + x-stream-index: "016" + downvote_count: + description: Number of downvotes for this comment + format: int32 + title: Downvote Count + type: integer + x-stream-index: "020" + id: + description: Unique identifier for the comment + title: ID + type: string + x-stream-index: "001" + latest_reactions: + description: Recent reactions to the comment + items: + $ref: '#/components/schemas/FeedsReactionResponse' + title: Latest Reactions + type: array + x-stream-index: "009" + mentioned_users: + description: Users mentioned in the comment + items: + $ref: '#/components/schemas/UserResponse' + title: Mention Users + type: array + x-stream-index: "012" + moderation: + $ref: '#/components/schemas/ModerationV2Response' + x-stream-index: "017" + object_id: + description: ID of the object this comment is associated with + title: Object ID + type: string + x-stream-index: "002" + object_type: + description: Type of the object this comment is associated with + title: Object Type + type: string + x-stream-index: "003" + own_reactions: + description: Current user's reactions to this activity + items: + $ref: '#/components/schemas/FeedsReactionResponse' + title: Own Reactions + type: array + x-stream-index: "024" + parent_id: + description: ID of parent comment for nested replies + title: Parent ID + type: string + x-stream-index: "007" + reaction_count: + description: Number of reactions to this comment + format: int32 + title: Reaction Count + type: integer + x-stream-index: "008" + reaction_groups: + additionalProperties: + $ref: '#/components/schemas/ReactionGroupResponse' + description: Grouped reactions by type + title: Reaction Groups + type: object + x-stream-index: "010" + reply_count: + description: Number of replies to this comment + format: int32 + title: Reply Count + type: integer + x-stream-index: "018" + score: + description: Score of the comment based on reactions + format: int32 + title: Score + type: integer + x-stream-index: "021" + status: + description: Status of the comment (e.g., active, deleted) + title: Status + type: string + x-stream-index: "013" + text: + description: Text content of the comment + title: Text + type: string + x-stream-index: "005" + updated_at: + description: When the comment was last updated + format: date-time + title: Updated At + type: number + x-stream-index: "015" + upvote_count: + description: Number of upvotes for this comment + format: int32 + title: Upvote Count + type: integer + x-stream-index: "019" + user: + $ref: '#/components/schemas/UserResponse' + description: User who created the comment + title: User + x-stream-index: "004" + required: + - id + - object_id + - object_type + - user + - reaction_count + - mentioned_users + - status + - created_at + - updated_at + - reply_count + - upvote_count + - downvote_count + - score + - confidence_score + - own_reactions + title: Comment + type: object + CommentUpdatedEvent: + description: Emitted when a comment is updated. + nullable: true + properties: + comment: + $ref: '#/components/schemas/CommentResponse' + description: The comment that was updated + title: Text + x-stream-index: "001" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + feed_visibility: + type: string + x-stream-index: "002.003" + fid: + type: string + x-stream-index: "002.002" + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 + type: + default: feeds.comment.updated + description: 'The type of event: "feeds.comment.updated" in this case' + title: Event Type + type: string + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who updated the comment + title: User + x-stream-index: "003.001" + required: + - comment + - type + - created_at + - custom + - fid + title: CommentUpdatedEvent + 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 + CompositeAppSettings: + properties: + json_encoded_settings: + type: string + x-stream-index: "005" + url: + type: string + x-stream-index: "004" + type: object + ConfigOverrides: + properties: + blocklist: + type: string + x-stream-index: "008" + blocklist_behavior: + enum: + - flag + - block + type: string + x-stream-index: "009" + commands: + items: + type: string + type: array + x-stream-index: "011" + count_messages: + type: boolean + x-stream-index: "014" + grants: + additionalProperties: + items: + type: string + type: array + type: object + x-stream-index: "010" + max_message_length: + format: int32 + maximum: 20000 + type: integer + x-stream-index: "007" + quotes: + type: boolean + x-stream-index: "004" + reactions: + type: boolean + x-stream-index: "002" + replies: + type: boolean + x-stream-index: "003" + shared_locations: + type: boolean + x-stream-index: "013" + typing_events: + type: boolean + x-stream-index: "001" + uploads: + type: boolean + x-stream-index: "005" + url_enrichment: + type: boolean + x-stream-index: "006" + user_message_reminders: + type: boolean + x-stream-index: "012" + required: + - grants + - commands + type: object + ConfigResponse: + properties: + ai_image_config: + $ref: '#/components/schemas/AIImageConfig' + description: Configuration for AI image analysis + title: AI Image Config + x-stream-index: "010" + ai_text_config: + $ref: '#/components/schemas/AITextConfig' + description: Configuration for AI text analysis + title: AI Text Config + x-stream-index: "008" + ai_video_config: + $ref: '#/components/schemas/AIVideoConfig' + description: Configuration for AI video analysis + title: AI Video Config + x-stream-index: "011" + async: + description: Whether moderation should be performed asynchronously + title: Async + type: boolean + x-stream-index: "003" + automod_platform_circumvention_config: + $ref: '#/components/schemas/AutomodPlatformCircumventionConfig' + description: Configuration for platform circumvention detection + title: Automod Platform Circumvention Config + x-stream-index: "005" + automod_semantic_filters_config: + $ref: '#/components/schemas/AutomodSemanticFiltersConfig' + description: Configuration for semantic filtering + title: Automod Semantic Filters Config + x-stream-index: "006" + automod_toxicity_config: + $ref: '#/components/schemas/AutomodToxicityConfig' + description: Configuration for toxicity detection + title: Automod Toxicity Config + x-stream-index: "004" + block_list_config: + $ref: '#/components/schemas/BlockListConfig' + description: Configuration for block list filtering + title: Block List Config + x-stream-index: "007" + created_at: + description: When the configuration was created + format: date-time + title: Created At + type: number + x-stream-index: "013" + key: + description: Unique identifier for the moderation configuration + title: Key + type: string + x-stream-index: "001" + llm_config: + $ref: '#/components/schemas/LLMConfig' + description: Configuration for customer-configured LLM moderation + title: LLM Config + x-stream-index: "009" + team: + description: Team associated with the configuration + title: Team + type: string + x-stream-index: "002" + updated_at: + description: When the configuration was last updated + format: date-time + title: Updated At + type: number + x-stream-index: "014" + velocity_filter_config: + $ref: '#/components/schemas/VelocityFilterConfig' + description: Configuration for velocity-based filtering + title: Velocity Filter Config + x-stream-index: "012" + video_call_rule_config: + $ref: '#/components/schemas/VideoCallRuleConfig' + x-stream-index: "015" + required: + - key + - team + - async + - created_at + - updated_at + type: object + ConnectUserDetailsRequest: + properties: + custom: + additionalProperties: {} + type: object + x-stream-index: "004" + id: + type: string + x-stream-index: "001" + image: + type: string + x-stream-index: "003" + invisible: + type: boolean + x-stream-index: "006" + language: + type: string + x-stream-index: "005" + name: + type: string + x-stream-index: "002" + privacy_settings: + $ref: '#/components/schemas/PrivacySettingsResponse' + x-stream-index: "007" + required: + - id + type: object + ContentCountRuleParameters: + properties: + threshold: + format: int32 + type: integer + x-stream-index: "001" + time_window: + type: string + x-stream-index: "002" + type: object + CreateBlockListRequest: + description: Block list contains restricted words + nullable: true + properties: + name: + description: Block list name + maxLength: 255 + title: Name + type: string + x-stream-index: "001" + team: + type: string + x-stream-index: "004" + type: + description: Block list type. + enum: + - regex + - domain + - domain_allowlist + - email + - word + title: Type + type: string + x-stream-index: "003" + words: + description: List of words to block + items: + type: string + minimum: 1 + title: Words + type: array + x-stream-index: "002" + required: + - name + - words + title: Block list + type: object + x-stream-docs-page-id: block_lists + CreateBlockListResponse: + description: Basic response information + nullable: true + properties: + blocklist: + $ref: '#/components/schemas/BlockListResponse' + x-stream-index: "001" + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "002.001" + required: + - duration + title: Response + type: object + CreateDeviceRequest: + description: Create device request + nullable: true + properties: + id: + description: Device ID + maxLength: 255 + minLength: 1 + title: ID + type: string + x-stream-index: "001" + push_provider: + description: Push provider + enum: + - firebase + - apn + - huawei + - xiaomi + title: PushProvider + type: string + x-stream-index: "002" + push_provider_name: + description: Push provider name + title: PushProviderName + type: string + x-stream-index: "003" + voip_token: + description: When true the token is for Apple VoIP push notifications + title: VoipToken + type: boolean + x-stream-index: "004" + required: + - id + - push_provider + title: CreateDeviceRequest + type: object + CreateFeedsBatchRequest: + nullable: true + properties: + feeds: + description: List of feeds to create + items: + $ref: '#/components/schemas/FeedRequest' + maximum: 1000 + minimum: 1 + title: Feeds + type: array + x-stream-index: "001" + required: + - feeds + title: Create Feeds Batch Request + type: object + CreateFeedsBatchResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + feeds: + description: List of created feeds + items: + $ref: '#/components/schemas/FeedResponse' + title: Feeds + type: array + x-stream-index: "001" + required: + - feeds + - duration + title: Create Feeds Batch Response + type: object + CreateGuestRequest: + nullable: true + properties: + user: + $ref: '#/components/schemas/UserRequest' + description: User object which server acts upon + title: User + x-stream-index: "001" + required: + - user + type: object + CreateGuestResponse: + nullable: true + properties: + access_token: + description: the access token to authenticate the user + title: Access token + type: string + x-stream-index: "002" + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "003.001" + user: + $ref: '#/components/schemas/UserResponse' + description: User object which server acts upon + title: User + x-stream-index: "001" + required: + - user + - access_token + - duration + type: object + CreatePollOptionRequest: + nullable: true + properties: + Custom: + additionalProperties: {} + type: object + writeOnly: true + x-stream-index: "003" + text: + description: Option text + title: string + type: string + x-stream-index: "002" + required: + - text + type: object + CreatePollRequest: + description: Contains all information needed to create a new poll + nullable: true + properties: + Custom: + additionalProperties: {} + type: object + writeOnly: true + x-stream-index: "011" + allow_answers: + description: Indicates whether users can suggest user defined answers + title: Allow answers + type: boolean + x-stream-index: "009" + allow_user_suggested_options: + type: boolean + x-stream-index: "008" + description: + description: A description of the poll + title: Description + type: string + x-stream-index: "003" + enforce_unique_vote: + description: Indicates whether users can cast multiple votes + title: Multiple choice + type: boolean + x-stream-index: "006" + id: + maxLength: 255 + type: string + x-stream-index: "001" + is_closed: + description: Indicates whether the poll is open for voting + title: Is closed + type: boolean + x-stream-index: "010" + max_votes_allowed: + description: Indicates the maximum amount of votes a user can cast + format: int32 + maximum: 10 + title: Maximum votes allowed + type: integer + x-stream-index: "007" + name: + description: The name of the poll + title: Name + type: string + x-stream-index: "002" + options: + items: + $ref: '#/components/schemas/PollOptionInput' + maximum: 100 + type: array + x-stream-index: "004" + voting_visibility: + enum: + - anonymous + - public + type: string + x-stream-index: "005" + required: + - name + title: Create Poll Request + type: object + CustomActionRequest: + properties: + id: + type: string + x-stream-index: "001" + options: + additionalProperties: {} + type: object + x-stream-index: "002" + type: object + Data: + properties: + id: + type: string + x-stream-index: "001" + required: + - id + type: object + DecayFunctionConfig: + properties: + base: + type: string + x-stream-index: "001" + decay: + type: string + x-stream-index: "005" + direction: + type: string + x-stream-index: "006" + offset: + type: string + x-stream-index: "004" + origin: + type: string + x-stream-index: "002" + scale: + type: string + x-stream-index: "003" + type: object + DeleteActivitiesRequest: + nullable: true + properties: + hard_delete: + description: Whether to permanently delete the activities + title: Hard Delete + type: boolean + x-stream-index: "002" + ids: + description: List of activity IDs to delete + items: + type: string + minimum: 1 + title: Activity IDs + type: array + x-stream-index: "001" + required: + - ids + title: Delete Activities Request + type: object + DeleteActivitiesResponse: + nullable: true + properties: + deleted_ids: + description: List of activity IDs that were successfully deleted + items: + type: string + title: Deleted Activity IDs + type: array + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - deleted_ids + - duration + title: Delete Activities Response + type: object + DeleteActivityReactionResponse: + nullable: true + properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + x-stream-index: "001" + duration: + type: string + x-stream-index: "003.001" + reaction: + $ref: '#/components/schemas/FeedsReactionResponse' + x-stream-index: "002" + required: + - activity + - reaction + - duration + title: Delete Activity Reaction Response + type: object + DeleteActivityRequest: + properties: + hard_delete: + type: boolean + x-stream-index: "001" + type: object + DeleteActivityResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "001.001" + required: + - duration + title: Delete Activity Response + type: object + DeleteBookmarkFolderResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "001.001" + required: + - duration + title: Delete Bookmark Folder Response + type: object + DeleteBookmarkResponse: + nullable: true + properties: + bookmark: + $ref: '#/components/schemas/BookmarkResponse' + description: The deleted bookmark + title: Bookmark + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - bookmark + - duration + title: Delete Bookmark Response + type: object + DeleteCommentReactionResponse: + nullable: true + properties: + comment: + $ref: '#/components/schemas/CommentResponse' + description: The comment after reaction removal + title: Comment + x-stream-index: "001" + duration: + type: string + x-stream-index: "003.001" + reaction: + $ref: '#/components/schemas/FeedsReactionResponse' + description: The removed reaction + title: Reaction + x-stream-index: "002" + required: + - comment + - reaction + - duration + title: Delete Comment Reaction Response + type: object + DeleteCommentResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "001.001" + required: + - duration + title: Delete Comment Response + type: object + DeleteFeedResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "001.001" + required: + - duration + title: Delete Feed Response + type: object + DeleteMessageRequest: + properties: + hard_delete: + type: boolean + x-stream-index: "001" + type: object + DeleteModerationConfigResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "001.001" + required: + - duration + type: object + DeleteReactionRequest: + properties: + hard_delete: + type: boolean + x-stream-index: "001" + type: object + DeleteUserRequest: + properties: + delete_conversation_channels: + type: boolean + x-stream-index: "003" + delete_feeds_content: + type: boolean + x-stream-index: "004" + hard_delete: + type: boolean + x-stream-index: "001" + mark_messages_deleted: + type: boolean + x-stream-index: "002" + type: object + Device: + nullable: true + properties: + created_at: + format: date-time + type: number + x-stream-index: "002.002" + disabled: + type: boolean + x-stream-index: "002.003" + disabled_reason: + type: string + x-stream-index: "002.004" + id: + type: string + x-stream-index: 002.001.004 + push_provider: + enum: + - firebase + - apn + - huawei + - xiaomi + type: string + x-stream-index: 002.001.001 + push_provider_name: + type: string + x-stream-index: 002.001.003 + user_id: + type: string + x-stream-index: "004" + voip: + type: boolean + x-stream-index: 002.001.005 + required: + - push_provider + - id + - created_at + - user_id + type: object + DeviceResponse: + description: Response for Device + nullable: true + properties: + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: "004" + disabled: + description: Whether device is disabled or not + title: Disabled + type: boolean + x-stream-index: "005" + disabled_reason: + description: Reason explaining why device had been disabled + title: Reason + type: string + x-stream-index: "006" + id: + description: Device ID + title: ID + type: string + x-stream-index: "003" + push_provider: + description: Push provider + title: PushProvider + type: string + x-stream-index: "001" + push_provider_name: + description: Push provider name + title: PushProviderName + type: string + x-stream-index: "002" + user_id: + description: User ID + title: UserID + type: string + x-stream-index: "008" + voip: + description: When true the token is for Apple VoIP push notifications + title: Voip + type: boolean + x-stream-index: "007" + required: + - push_provider + - id + - created_at + - user_id + title: DeviceResponse + type: object + DraftPayloadResponse: + properties: + attachments: + items: + $ref: '#/components/schemas/Attachment' + type: array + x-stream-index: "004" + custom: + additionalProperties: {} + type: object + x-stream-index: "007" + html: + type: string + x-stream-index: "010" + id: + type: string + x-stream-index: "001" + mentioned_users: + items: + $ref: '#/components/schemas/UserResponse' + type: array + x-stream-index: "008" + mml: + type: string + x-stream-index: "003" + parent_id: + type: string + x-stream-index: "005" + poll_id: + type: string + x-stream-index: "013" + quoted_message_id: + type: string + x-stream-index: "009" + show_in_channel: + type: boolean + x-stream-index: "006" + silent: + type: boolean + x-stream-index: "012" + text: + type: string + x-stream-index: "002" + type: + type: string + x-stream-index: "011" + required: + - id + - text + - custom + type: object + DraftResponse: + properties: + channel: + $ref: '#/components/schemas/ChannelResponse' + x-stream-index: "003" + channel_cid: + type: string + x-stream-index: "002" + created_at: + format: date-time + type: number + x-stream-index: "007" + message: + $ref: '#/components/schemas/DraftPayloadResponse' + x-stream-index: "001" + parent_id: + type: string + x-stream-index: "004" + parent_message: + $ref: '#/components/schemas/MessageResponse' + x-stream-index: "005" + quoted_message: + $ref: '#/components/schemas/MessageResponse' + x-stream-index: "006" + required: + - message + - channel_cid + - created_at + type: object + EgressHLSResponse: + properties: + playlist_url: + type: string + x-stream-index: "001" + status: + type: string + x-stream-index: "002" + required: + - playlist_url + - status + type: object + EgressRTMPResponse: + properties: + name: + type: string + x-stream-index: "001" + started_at: + format: date-time + type: number + x-stream-index: "004" + stream_key: + type: string + x-stream-index: "003" + stream_url: + type: string + x-stream-index: "002" + required: + - name + - started_at + type: object + EgressResponse: + properties: + broadcasting: + type: boolean + x-stream-index: "001" + frame_recording: + $ref: '#/components/schemas/FrameRecordingResponse' + x-stream-index: "004" + hls: + $ref: '#/components/schemas/EgressHLSResponse' + x-stream-index: "002" + rtmps: + items: + $ref: '#/components/schemas/EgressRTMPResponse' + type: array + x-stream-index: "003" + required: + - broadcasting + - rtmps + type: object + EgressTaskConfig: + properties: + egress_user: + $ref: '#/components/schemas/EgressUser' + x-stream-index: "008" + frame_recording_egress_config: + $ref: '#/components/schemas/FrameRecordingEgressConfig' + x-stream-index: "009" + hls_egress_config: + $ref: '#/components/schemas/HLSEgressConfig' + x-stream-index: "007" + recording_egress_config: + $ref: '#/components/schemas/RecordingEgressConfig' + x-stream-index: "006" + rtmp_egress_config: + $ref: '#/components/schemas/RTMPEgressConfig' + x-stream-index: "004" + stt_egress_config: + $ref: '#/components/schemas/STTEgressConfig' + x-stream-index: "005" + type: object + EgressUser: + properties: + token: + type: string + x-stream-index: "004" + type: object + EnrichedActivity: + properties: + actor: + $ref: '#/components/schemas/Data' + x-stream-index: "002" + foreign_id: + type: string + x-stream-index: "005" + id: + type: string + x-stream-index: "001" + latest_reactions: + additionalProperties: + items: + $ref: '#/components/schemas/EnrichedReaction' + type: array + type: object + x-stream-index: "013" + object: + $ref: '#/components/schemas/Data' + x-stream-index: "004" + origin: + $ref: '#/components/schemas/Data' + x-stream-index: "008" + own_reactions: + additionalProperties: + items: + $ref: '#/components/schemas/EnrichedReaction' + type: array + type: object + x-stream-index: "012" + reaction_counts: + additionalProperties: + format: int32 + type: integer + type: object + x-stream-index: "011" + score: + format: float + type: number + x-stream-index: "010" + target: + $ref: '#/components/schemas/Data' + x-stream-index: "006" + to: + items: + type: string + type: array + x-stream-index: "009" + verb: + type: string + x-stream-index: "003" + type: object + EnrichedReaction: + nullable: true + properties: + activity_id: + type: string + x-stream-index: "003" + children_counts: + additionalProperties: + format: int32 + type: integer + type: object + x-stream-index: "010" + created_at: + $ref: '#/components/schemas/Time' + x-stream-index: "012" + data: + additionalProperties: {} + type: object + x-stream-index: "005" + id: + type: string + x-stream-index: "001" + kind: + type: string + x-stream-index: "002" + latest_children: + additionalProperties: + items: + $ref: '#/components/schemas/EnrichedReaction' + type: array + type: object + x-stream-index: "008" + own_children: + additionalProperties: + items: + $ref: '#/components/schemas/EnrichedReaction' + type: array + type: object + x-stream-index: "009" + parent: + type: string + x-stream-index: "007" + target_feeds: + items: + type: string + type: array + x-stream-index: "006" + updated_at: + $ref: '#/components/schemas/Time' + x-stream-index: "013" + user: + $ref: '#/components/schemas/Data' + x-stream-index: "011" + user_id: + type: string + x-stream-index: "004" + required: + - kind + - activity_id + - user_id + type: object + EntityCreator: + properties: + avg_response_time: + format: int32 + readOnly: true + type: integer + x-stream-index: "001.046" + ban_count: + format: int32 + type: integer + x-stream-index: "002" + ban_expires: + format: date-time + type: number + x-stream-index: "001.017" + banned: + type: boolean + x-stream-index: "001.016" + created_at: + format: date-time + readOnly: true + type: number + x-stream-index: "001.008" + custom: + additionalProperties: {} + type: object + x-stream-index: "001.006" + deactivated_at: + format: date-time + readOnly: true + type: number + x-stream-index: "001.014" + deleted_at: + format: date-time + readOnly: true + type: number + x-stream-index: "001.013" + deleted_content_count: + format: int32 + type: integer + x-stream-index: "003" + id: + type: string + x-stream-index: "001.003" + invisible: + type: boolean + x-stream-index: "001.023" + language: + type: string + x-stream-index: "001.035" + last_active: + format: date-time + readOnly: true + type: number + x-stream-index: "001.011" + last_engaged_at: + format: date-time + readOnly: true + type: number + x-stream-index: "001.012" + online: + readOnly: true + type: boolean + x-stream-index: "001.022" + privacy_settings: + $ref: '#/components/schemas/PrivacySettings' + x-stream-index: "001.026" + revoke_tokens_issued_before: + format: date-time + type: number + x-stream-index: "001.042" + role: + type: string + x-stream-index: "001.004" + teams: + items: + type: string + type: array + x-stream-index: "001.036" + teams_role: + additionalProperties: + type: string + type: object + x-stream-index: "001.005" + updated_at: + format: date-time + readOnly: true + type: number + x-stream-index: "001.009" + required: + - id + - role + - teams_role + - custom + - banned + - online + - ban_count + - deleted_content_count + type: object + EntityCreatorResponse: + properties: + avg_response_time: + format: int32 + type: integer + x-stream-index: 001.001.018 + ban_count: + description: Number of minor actions performed on the user + format: int32 + title: Ban Count + type: integer + x-stream-index: "002" + banned: + type: boolean + x-stream-index: 001.001.012 + blocked_user_ids: + items: + type: string + type: array + x-stream-index: 001.001.017 + created_at: + format: date-time + type: number + x-stream-index: 001.001.009 + custom: + additionalProperties: {} + type: object + x-stream-index: 001.001.004 + deactivated_at: + format: date-time + type: number + x-stream-index: 001.001.016 + deleted_at: + format: date-time + type: number + x-stream-index: 001.001.011 + deleted_content_count: + description: Number of major actions performed on the user + format: int32 + title: Deleted Content Count + type: integer + x-stream-index: "003" + flagged_count: + description: Number of flag actions performed on the user + format: int32 + title: Flagged Count + type: integer + x-stream-index: "004" + id: + type: string + x-stream-index: 001.001.001 + image: + type: string + x-stream-index: 001.001.003 + language: + type: string + x-stream-index: 001.001.005 + last_active: + format: date-time + type: number + x-stream-index: 001.001.014 + name: + type: string + x-stream-index: 001.001.002 + online: + type: boolean + x-stream-index: 001.001.013 + revoke_tokens_issued_before: + format: date-time + type: number + x-stream-index: 001.001.015 + role: + type: string + x-stream-index: 001.001.006 + teams: + items: + type: string + type: array + x-stream-index: 001.001.007 + teams_role: + additionalProperties: + type: string + type: object + x-stream-index: 001.001.008 + updated_at: + format: date-time + type: number + x-stream-index: 001.001.010 + required: + - id + - custom + - language + - role + - teams + - created_at + - updated_at + - banned + - online + - blocked_user_ids + - shadow_banned + - invisible + - ban_count + - deleted_content_count + - flagged_count + type: object + EventNotificationSettings: + properties: + apns: + $ref: '#/components/schemas/APNS' + x-stream-index: "002" + enabled: + type: boolean + x-stream-index: "001" + fcm: + $ref: '#/components/schemas/FCM' + x-stream-index: "003" + required: + - enabled + - apns + - fcm + type: object + ExternalStorage: + properties: + abs_account_name: + type: string + x-stream-index: "011" + abs_client_id: + type: string + x-stream-index: "013" + abs_client_secret: + type: string + x-stream-index: "014" + abs_tenant_id: + type: string + x-stream-index: "012" + bucket: + type: string + x-stream-index: "005" + gcs_credentials: + type: string + x-stream-index: "010" + path: + type: string + x-stream-index: "006" + s3_api_key: + type: string + x-stream-index: "007" + s3_custom_endpoint: + type: string + x-stream-index: "016" + s3_region: + type: string + x-stream-index: "009" + s3_secret_key: + type: string + x-stream-index: "008" + storage_name: + type: string + x-stream-index: "015" + storage_type: + type: integer + x-stream-index: "004" + type: object + FCM: + properties: + data: + additionalProperties: {} + type: object + x-stream-index: "001" + type: object + FeedCreatedEvent: + description: Emitted when a feed is created. + nullable: true + properties: + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 003.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 003.001.007 + feed: + $ref: '#/components/schemas/FeedResponse' + description: The feed that was created + title: Feed + x-stream-index: "001" + feed_visibility: + type: string + x-stream-index: "003.003" + fid: + type: string + x-stream-index: "003.002" + members: + items: + $ref: '#/components/schemas/FeedMemberResponse' + type: array + x-stream-index: "002" + received_at: + format: date-time + type: number + x-stream-index: 003.001.004 + type: + default: feeds.feed.created + description: 'The type of event: "feeds.feed.created" in this case' + title: Event Type + type: string + x-stream-index: 003.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who created the feed + title: User + x-stream-index: "004.001" + required: + - feed + - members + - type + - created_at + - custom + - fid + - user + title: FeedCreatedEvent + 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 + FeedDeletedEvent: + description: Emitted when a feed is deleted. + nullable: true + properties: + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 001.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 001.001.007 + feed_visibility: + type: string + x-stream-index: "001.003" + fid: + type: string + x-stream-index: "001.002" + received_at: + format: date-time + type: number + x-stream-index: 001.001.004 + type: + default: feeds.feed.deleted + description: 'The type of event: "feeds.feed.deleted" in this case' + title: Event Type + type: string + x-stream-index: 001.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who deleted the feed + title: User + x-stream-index: "002.001" + required: + - type + - created_at + - custom + - fid + title: FeedDeletedEvent + 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 + FeedGroup: + properties: + ActivityProcessors: + items: + $ref: '#/components/schemas/ActivityProcessorConfig' + type: array + writeOnly: true + x-stream-index: "012" + ActivitySelectors: + items: + $ref: '#/components/schemas/ActivitySelectorConfig' + type: array + writeOnly: true + x-stream-index: "013" + Aggregation: + $ref: '#/components/schemas/AggregationConfig' + x-stream-index: "015" + AggregationVersion: + format: int32 + type: integer + writeOnly: true + x-stream-index: "016" + AppPK: + format: int32 + type: integer + writeOnly: true + x-stream-index: "002" + Custom: + additionalProperties: {} + type: object + writeOnly: true + x-stream-index: "007" + DefaultVisibility: + type: string + writeOnly: true + x-stream-index: "006" + DeletedAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "010" + ID: + type: string + writeOnly: true + x-stream-index: "003" + LastFeedGetAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "017" + Notification: + $ref: '#/components/schemas/NotificationConfig' + x-stream-index: "004" + PushNotification: + $ref: '#/components/schemas/PushNotificationConfig' + x-stream-index: "005" + Ranking: + $ref: '#/components/schemas/RankingConfig' + x-stream-index: "014" + Stories: + $ref: '#/components/schemas/StoriesConfig' + x-stream-index: "011" + created_at: + format: date-time + type: number + x-stream-index: "008" + updated_at: + format: date-time + type: number + x-stream-index: "009" + required: + - AppPK + - ID + - DefaultVisibility + - Custom + - created_at + - updated_at + - ActivityProcessors + - ActivitySelectors + - AggregationVersion + type: object + FeedGroupChangedEvent: + description: Emitted when a feed group is changed. + nullable: true + properties: + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 001.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 001.001.007 + feed_group: + $ref: '#/components/schemas/FeedGroup' + description: The feed group that was changed + title: Feed Type + x-stream-index: "003" + feed_visibility: + type: string + x-stream-index: "001.003" + fid: + type: string + x-stream-index: "001.002" + received_at: + format: date-time + type: number + x-stream-index: 001.001.004 + type: + default: feeds.feed_group.changed + description: 'The type of event: "feeds.feed_group.changed" in this case' + title: Event Type + type: string + x-stream-index: 001.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who changed the feed group + title: User + x-stream-index: "002.001" + required: + - type + - created_at + - custom + - fid + title: FeedGroupChangedEvent + 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 + FeedGroupDeletedEvent: + description: Emitted when a feed group is deleted. + nullable: true + properties: + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + feed_visibility: + type: string + x-stream-index: "002.003" + fid: + type: string + x-stream-index: "002.002" + group_id: + description: The ID of the feed group that was deleted + title: Group ID + type: string + x-stream-index: "001" + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 + type: + default: feeds.feed_group.deleted + description: 'The type of event: "feeds.feed_group.deleted" in this case' + title: Event Type + type: string + x-stream-index: 002.001.002 + required: + - group_id + - type + - created_at + - custom + - fid + title: FeedGroupDeletedEvent + 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 + FeedInput: + properties: + custom: + additionalProperties: {} + type: object + x-stream-index: "004" + description: + maxLength: 1000 + type: string + x-stream-index: "002" + filter_tags: + items: + type: string + maximum: 255 + type: array + x-stream-index: "005" + members: + items: + $ref: '#/components/schemas/FeedMemberRequest' + type: array + x-stream-index: "006" + name: + maxLength: 255 + type: string + x-stream-index: "001" + visibility: + enum: + - public + - visible + - followers + - members + - private + type: string + x-stream-index: "003" + type: object + FeedMemberAddedEvent: + description: Emitted when a feed member is added. + nullable: true + properties: + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 003.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 003.001.007 + feed_visibility: + type: string + x-stream-index: "003.003" + fid: + type: string + x-stream-index: "003.002" + member: + $ref: '#/components/schemas/FeedMemberResponse' + description: The member that was added + title: Member + x-stream-index: "001" + received_at: + format: date-time + type: number + x-stream-index: 003.001.004 + type: + default: feeds.feed_member.added + description: 'The type of event: "feeds.feed_member.added" in this case' + title: Event Type + type: string + x-stream-index: 003.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who added the member + title: User + x-stream-index: "002.001" + required: + - member + - type + - created_at + - custom + - fid + title: FeedMemberAddedEvent + 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 + FeedMemberRemovedEvent: + description: Emitted when a feed member is removed. + nullable: true + properties: + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 003.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 003.001.007 + feed_visibility: + type: string + x-stream-index: "003.003" + fid: + type: string + x-stream-index: "003.002" + member_id: + type: string + x-stream-index: "001" + received_at: + format: date-time + type: number + x-stream-index: 003.001.004 + type: + default: feeds.feed_member.removed + description: 'The type of event: "feeds.feed_member.removed" in this case' + title: Event Type + type: string + x-stream-index: 003.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who removed the member + title: User + x-stream-index: "002.001" + required: + - member_id + - type + - created_at + - custom + - fid + title: FeedMemberRemovedEvent + 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 + FeedMemberRequest: + properties: + custom: + additionalProperties: {} + description: Custom data for the member + title: Custom Data + type: object + x-stream-index: "004" + invite: + description: Whether this is an invite to become a member + title: Invite + type: boolean + x-stream-index: "005" + membership_level: + description: ID of the membership level to assign to the member + maxLength: 255 + title: Membership Level + type: string + x-stream-index: "003" + role: + description: Role of the member in the feed + maxLength: 255 + title: Role + type: string + x-stream-index: "002" + user_id: + description: ID of the user to add as a member + maxLength: 255 + title: User ID + type: string + x-stream-index: "001" + required: + - user_id + title: Feed Member Payload + type: object + FeedMemberResponse: + properties: + created_at: + description: When the membership was created + format: date-time + title: Created At + type: number + x-stream-index: "008" + custom: + additionalProperties: {} + description: Custom data for the membership + title: Custom Data + type: object + x-stream-index: "007" + invite_accepted_at: + description: When the invite was accepted + format: date-time + title: Invite Accepted At + type: number + x-stream-index: "005" + invite_rejected_at: + description: When the invite was rejected + format: date-time + title: Invite Rejected At + type: number + x-stream-index: "006" + membership_level: + $ref: '#/components/schemas/MembershipLevelResponse' + description: Membership level assigned to the member + title: Membership Level + x-stream-index: "004" + role: + description: Role of the member in the feed + title: Role + type: string + x-stream-index: "002" + status: + description: Status of the membership + enum: + - member + - pending + - rejected + title: Status + type: string + x-stream-index: "003" + updated_at: + description: When the membership was last updated + format: date-time + title: Updated At + type: number + x-stream-index: "009" + user: + $ref: '#/components/schemas/UserResponse' + description: User who is a member + title: User + x-stream-index: "001" + required: + - user + - role + - status + - created_at + - updated_at + title: Feed Member + type: object + FeedMemberUpdatedEvent: + description: Emitted when a feed member is updated. + nullable: true + properties: + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 003.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 003.001.007 + feed_visibility: + type: string + x-stream-index: "003.003" + fid: + type: string + x-stream-index: "003.002" + member: + $ref: '#/components/schemas/FeedMemberResponse' + description: The member that was updated + title: Member + x-stream-index: "001" + received_at: + format: date-time + type: number + x-stream-index: 003.001.004 + type: + default: feeds.feed_member.updated + description: 'The type of event: "feeds.feed_member.updated" in this case' + title: Event Type + type: string + x-stream-index: 003.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who updated the member + title: User + x-stream-index: "002.001" + required: + - member + - type + - created_at + - custom + - fid + title: FeedMemberUpdatedEvent + 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 + FeedOwnCapability: + description: All possibility of string to use + enum: + - add-activity + - add-activity-reaction + - add-comment + - add-comment-reaction + - bookmark-activity + - create-feed + - delete-bookmark + - delete-comment + - delete-feed + - edit-bookmark + - follow + - invite-feed + - join-feed + - leave-feed + - manage-feed-group + - mark-activity + - pin-activity + - query-feed-members + - query-follows + - read-activities + - read-feed + - remove-activity + - remove-activity-reaction + - remove-comment-reaction + - unfollow + - update-activity + - update-comment + - update-feed + - update-feed-followers + - update-feed-members + title: FeedOwnCapability + type: string + FeedRequest: + properties: + created_by_id: + description: ID of the feed creator + title: Created By ID + type: string + x-stream-index: "003" + custom: + additionalProperties: {} + description: Custom data for the feed + title: Custom Data + type: object + x-stream-index: "004.004" + description: + description: Description of the feed + maxLength: 1000 + title: Description + type: string + x-stream-index: "004.002" + feed_group_id: + description: ID of the feed group + maxLength: 255 + title: Feed Group ID + type: string + x-stream-index: "001" + feed_id: + description: ID of the feed + maxLength: 255 + title: Feed ID + type: string + x-stream-index: "002" + filter_tags: + description: Tags used for filtering feeds + items: + type: string + maximum: 255 + title: Filter Tags + type: array + x-stream-index: "004.005" + members: + description: Initial members for the feed + items: + $ref: '#/components/schemas/FeedMemberRequest' + title: Members + type: array + x-stream-index: "004.006" + name: + description: Name of the feed + maxLength: 255 + title: Name + type: string + x-stream-index: "004.001" + visibility: + description: Visibility setting for the feed + enum: + - public + - visible + - followers + - members + - private + title: Visibility + type: string + x-stream-index: "004.003" + required: + - feed_group_id + - feed_id + title: Feed Payload + type: object + FeedResponse: + properties: + created_at: + description: When the feed was created + format: date-time + title: Created At + type: number + x-stream-index: "015" + created_by: + $ref: '#/components/schemas/UserResponse' + description: User who created the feed + title: Created By + x-stream-index: "009" + custom: + additionalProperties: {} + description: Custom data for the feed + title: Custom Data + type: object + x-stream-index: "006" + deleted_at: + description: When the feed was deleted + format: date-time + title: Deleted At + type: number + x-stream-index: "017" + description: + description: Description of the feed + title: Description + type: string + x-stream-index: "005" + feed: + description: Fully qualified feed ID (group_id:id) + title: FID + type: string + x-stream-index: "003" + filter_tags: + description: Tags used for filtering feeds + items: + type: string + title: Filter Tags + type: array + x-stream-index: "007" + follower_count: + description: Number of followers of this feed + format: int32 + title: Follower Count + type: integer + x-stream-index: "011" + following_count: + description: Number of feeds this feed follows + format: int32 + title: Following Count + type: integer + x-stream-index: "012" + group_id: + description: Group this feed belongs to + title: Group ID + type: string + x-stream-index: "001" + id: + description: Unique identifier for the feed + title: ID + type: string + x-stream-index: "002" + member_count: + description: Number of members in this feed + format: int32 + title: Member Count + type: integer + x-stream-index: "010" + name: + description: Name of the feed + title: Name + type: string + x-stream-index: "004" + own_follows: + description: Follow relationships where the current user's feeds are following + this feed + items: + $ref: '#/components/schemas/FollowResponse' + title: Own Follows + type: array + x-stream-index: "014" + pin_count: + description: Number of pinned activities in this feed + format: int32 + title: Pin Count + type: integer + x-stream-index: "013" + updated_at: + description: When the feed was last updated + format: date-time + title: Updated At + type: number + x-stream-index: "016" + visibility: + description: Visibility setting for the feed + title: Visibility + type: string + x-stream-index: "008" + required: + - group_id + - id + - feed + - name + - description + - created_by + - member_count + - follower_count + - following_count + - pin_count + - created_at + - updated_at + title: Feed + type: object + FeedUpdatedEvent: + description: Emitted when a feed is created. + nullable: true + properties: + created_at: + format: date-time + type: number + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + feed: + $ref: '#/components/schemas/FeedResponse' + description: The feed that was created + title: Feed + x-stream-index: "001" + feed_visibility: + type: string + x-stream-index: "002.003" + fid: + type: string + x-stream-index: "002.002" + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 + type: + default: feeds.feed.updated + description: 'The type of event: "feeds.feed.updated" in this case' + title: Event Type + type: string + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who created the feed + title: User + x-stream-index: "003.001" + required: + - feed + - type + - created_at + - custom + - fid + title: FeedUpdatedEvent + 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 + FeedsEventPreferences: + properties: + comments: + type: string + x-stream-index: "002" + mentions: + type: string + x-stream-index: "004" + new_followers: + type: string + x-stream-index: "003" + reactions: + type: string + x-stream-index: "001" + type: object + FeedsReactionResponse: + properties: + activity_id: + description: ID of the activity that was reacted to + title: Activity ID + type: string + x-stream-index: "002" + comment_id: + description: ID of the comment that was reacted to + title: Comment ID + type: string + x-stream-index: "003" + created_at: + description: When the reaction was created + format: date-time + title: Created At + type: number + x-stream-index: "006" + custom: + additionalProperties: {} + description: Custom data for the reaction + title: Custom Data + type: object + x-stream-index: "005" + type: + description: Type of reaction + title: Type + type: string + x-stream-index: "004" + updated_at: + description: When the reaction was last updated + format: date-time + title: Updated At + type: number + x-stream-index: "007" + user: + $ref: '#/components/schemas/UserResponse' + description: User who created the reaction + title: User + x-stream-index: "001" + required: + - user + - activity_id + - type + - created_at + - updated_at + title: Activity Reaction + type: object + Field: + nullable: true + properties: + short: + type: boolean + x-stream-index: "003" + title: + type: string + x-stream-index: "001" + value: + type: string + x-stream-index: "002" + required: + - title + - value + - short + type: object + FileUploadConfig: + properties: + allowed_file_extensions: + items: + type: string + type: array + x-stream-index: "001" + allowed_mime_types: + items: + type: string + type: array + x-stream-index: "003" + blocked_file_extensions: + items: + type: string + type: array + x-stream-index: "002" + blocked_mime_types: + items: + type: string + type: array + x-stream-index: "004" + size_limit: + format: int32 + maximum: 104857600 + minimum: 0 + type: integer + x-stream-index: "005" + required: + - allowed_file_extensions + - blocked_file_extensions + - allowed_mime_types + - blocked_mime_types + - size_limit + type: object + FileUploadRequest: + nullable: true + properties: + file: + description: file field + title: File + type: string + x-stream-index: "001" + user: + $ref: '#/components/schemas/OnlyUserID' + description: user for the request **server side only** + title: User + x-stream-index: "002" + type: object + FileUploadResponse: + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "003.001" + file: + description: URL to the uploaded asset. Should be used to put to `asset_url` + attachment field + title: File + type: string + x-stream-index: "001" + thumb_url: + description: URL of the file thumbnail for supported file formats. Should + be put to `thumb_url` attachment field + title: Thumbnail URL + type: string + x-stream-index: "002" + required: + - duration + type: object + Flag: + description: Contains information about flagged user or message + nullable: true + properties: + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: "019" + custom: + additionalProperties: {} + description: Additional metadata about the flag + title: Custom + type: object + x-stream-index: "014" + entity_creator_id: + description: ID of the user who created the flagged entity + title: Entity Creator ID + type: string + x-stream-index: "009" + entity_id: + description: Unique identifier of the entity being flagged + title: Entity ID + type: string + x-stream-index: "008" + entity_type: + description: Type of entity being flagged (e.g., message, user) + title: Entity Type + type: string + x-stream-index: "007" + is_streamed_content: + type: boolean + x-stream-index: "012" + labels: + description: Labels from bodyguard, API calls, our own AI etc + items: + type: string + title: Labels + type: array + x-stream-index: "015" + moderation_payload: + $ref: '#/components/schemas/ModerationPayload' + description: Content being flagged + title: Moderation Payload + x-stream-index: "010" + moderation_payload_hash: + type: string + x-stream-index: "011" + reason: + description: Optional explanation for why the content is being flagged + title: Reason + type: string + x-stream-index: "013" + result: + description: Result of bodyguard, API calls, our own AI etc + items: + additionalProperties: {} + type: object + title: Result + type: array + x-stream-index: "016" + review_queue_item: + $ref: '#/components/schemas/ReviewQueueItem' + x-stream-index: "018" + review_queue_item_id: + description: ID of the review queue item + title: Review Queue Item ID + type: string + x-stream-index: "017" + type: + type: string + x-stream-index: "004" + updated_at: + description: Date/time of the last update + format: date-time + title: Updated at + type: number + x-stream-index: "020" + user: + $ref: '#/components/schemas/User' + description: User who flagged a message or a user + title: User + x-stream-index: "006" + required: + - entity_type + - entity_id + - result + - created_at + - updated_at + title: Flag + type: object + FlagContentOptions: + properties: + reason: + type: string + x-stream-index: "001" + type: object + FlagRequest: + nullable: true + properties: + custom: + additionalProperties: {} + description: Additional metadata about the flag + title: Custom + type: object + x-stream-index: "006" + entity_creator_id: + description: ID of the user who created the flagged entity + title: Entity Creator ID + type: string + x-stream-index: "003" + entity_id: + description: Unique identifier of the entity being flagged + title: Entity ID + type: string + x-stream-index: "002" + entity_type: + description: Type of entity being flagged (e.g., message, user) + title: Entity Type + type: string + x-stream-index: "001" + moderation_payload: + $ref: '#/components/schemas/ModerationPayload' + description: Content being flagged + title: Moderation Payload + x-stream-index: "005" + reason: + description: Optional explanation for why the content is being flagged + maxLength: 255 + title: Reason + type: string + x-stream-index: "004" + required: + - entity_type + - entity_id + type: object + FlagResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + item_id: + description: Unique identifier of the created moderation item + title: Item ID + type: string + x-stream-index: "001" + required: + - item_id + - duration + type: object + FlagUserOptions: + properties: + reason: + type: string + x-stream-index: "001" + type: object + FollowBatchRequest: + nullable: true + properties: + follows: + description: List of follow relationships to create + items: + $ref: '#/components/schemas/FollowRequest' + maximum: 1000 + minimum: 1 + title: Follows + type: array + x-stream-index: "001" + required: + - follows + title: Follow Batch Request + type: object + FollowBatchResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + follows: + description: List of created follow relationships + items: + $ref: '#/components/schemas/FollowResponse' + title: Follows + type: array + x-stream-index: "001" + required: + - follows + - duration + title: Follow Batch Response + type: object + FollowCreatedEvent: + description: Emitted when a feed follows another feed. + nullable: true + properties: + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + feed_visibility: + type: string + x-stream-index: "002.003" + fid: + type: string + x-stream-index: "002.002" + follow: + $ref: '#/components/schemas/FollowResponse' + x-stream-index: "001" + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 + type: + default: feeds.follow.created + description: 'The type of event: "feeds.follow.created" in this case' + title: Event Type + type: string + x-stream-index: 002.001.002 + required: + - follow + - type + - created_at + - custom + - fid + title: FollowCreatedEvent + 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 + FollowDeletedEvent: + description: Emitted when a feed unfollows another feed. + nullable: true + properties: + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + feed_visibility: + type: string + x-stream-index: "002.003" + fid: + type: string + x-stream-index: "002.002" + follow: + $ref: '#/components/schemas/FollowResponse' + x-stream-index: "001" + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 + type: + default: feeds.follow.deleted + description: 'The type of event: "feeds.follow.deleted" in this case' + title: Event Type + type: string + x-stream-index: 002.001.002 + required: + - follow + - type + - created_at + - custom + - fid + title: FollowDeletedEvent + 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 + FollowRequest: + nullable: true + properties: + create_notification_activity: + description: Whether to create a notification activity for this follow + title: Create Notification Activity + type: boolean + x-stream-index: "004" + custom: + additionalProperties: {} + description: Custom data for the follow relationship + title: Custom Data + type: object + x-stream-index: "002" + push_preference: + description: Push preference for the follow relationship + enum: + - all + - none + title: Push Preference + type: string + x-stream-index: "003" + skip_push: + type: boolean + x-stream-index: "005" + source: + description: Fully qualified ID of the source feed + maxLength: 255 + title: Source Feed + type: string + x-stream-index: "001.001" + target: + description: Fully qualified ID of the target feed + maxLength: 255 + title: Target Feed + type: string + x-stream-index: "001.002" + required: + - source + - target + title: Follow Request + type: object + FollowResponse: + properties: + created_at: + description: When the follow relationship was created + format: date-time + title: Created At + type: number + x-stream-index: "009" + custom: + additionalProperties: {} + description: Custom data for the follow relationship + title: Custom Data + type: object + x-stream-index: "004" + follower_role: + description: Role of the follower (source user) in the follow relationship + title: Follower Role + type: string + x-stream-index: "008" + push_preference: + description: Push preference for notifications + enum: + - all + - none + title: Push Preference + type: string + x-stream-index: "003" + request_accepted_at: + description: When the follow request was accepted + format: date-time + title: Request Accepted At + type: number + x-stream-index: "005" + request_rejected_at: + description: When the follow request was rejected + format: date-time + title: Request Rejected At + type: number + x-stream-index: "006" + source_feed: + $ref: '#/components/schemas/FeedResponse' + description: Source feed object + title: Source Feed + x-stream-index: "001" + status: + description: Status of the follow relationship + enum: + - accepted + - pending + - rejected + title: Status + type: string + x-stream-index: "007" + target_feed: + $ref: '#/components/schemas/FeedResponse' + description: Target feed object + title: Target Feed + x-stream-index: "002" + updated_at: + description: When the follow relationship was last updated + format: date-time + title: Updated At + type: number + x-stream-index: "010" + required: + - source_feed + - target_feed + - push_preference + - status + - follower_role + - created_at + - updated_at + title: Follow + type: object + FollowUpdatedEvent: + description: Emitted when a follow relationship is updated. + nullable: true + properties: + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + feed_visibility: + type: string + x-stream-index: "002.003" + fid: + type: string + x-stream-index: "002.002" + follow: + $ref: '#/components/schemas/FollowResponse' + x-stream-index: "001" + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 + type: + default: feeds.follow.updated + description: 'The type of event: "feeds.follow.updated" in this case' + title: Event Type + type: string + x-stream-index: 002.001.002 + required: + - follow + - type + - created_at + - custom + - fid + title: FollowUpdatedEvent + 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 + FrameRecordSettings: + properties: + capture_interval_in_seconds: + format: int32 + maximum: 60 + minimum: 2 + type: integer + x-stream-index: "003" + mode: + enum: + - available + - disabled + - auto-on + type: string + x-stream-index: "001" + quality: + type: string + x-stream-index: "002" + required: + - mode + - capture_interval_in_seconds + type: object + FrameRecordingEgressConfig: + properties: + capture_interval_in_seconds: + format: int32 + type: integer + x-stream-index: "007" + external_storage: + $ref: '#/components/schemas/ExternalStorage' + x-stream-index: "006" + quality: + $ref: '#/components/schemas/Quality' + x-stream-index: "004" + storage_name: + type: string + x-stream-index: "005" + type: object + FrameRecordingResponse: + properties: + status: + type: string + x-stream-index: "001" + required: + - status + type: object + FrameRecordingSettingsResponse: + properties: + capture_interval_in_seconds: + format: int32 + maximum: 60 + minimum: 2 + type: integer + x-stream-index: "003" + mode: + enum: + - available + - disabled + - auto-on + type: string + x-stream-index: "001" + quality: + type: string + x-stream-index: "002" + required: + - mode + - capture_interval_in_seconds + type: object + FullUserResponse: + properties: + avg_response_time: + format: int32 + type: integer + x-stream-index: "001.018" + ban_expires: + format: date-time + type: number + x-stream-index: "015" + banned: + type: boolean + x-stream-index: "001.012" + blocked_user_ids: + items: + type: string + type: array + x-stream-index: "014" + channel_mutes: + items: + $ref: '#/components/schemas/ChannelMute' + type: array + x-stream-index: "007" + created_at: + format: date-time + type: number + x-stream-index: "001.009" + custom: + additionalProperties: {} + type: object + x-stream-index: "001.004" + deactivated_at: + format: date-time + type: number + x-stream-index: "001.016" + deleted_at: + format: date-time + type: number + x-stream-index: "001.011" + devices: + items: + $ref: '#/components/schemas/DeviceResponse' + type: array + x-stream-index: "004" + id: + type: string + x-stream-index: "001.001" + image: + type: string + x-stream-index: "001.003" + invisible: + type: boolean + x-stream-index: "005" + language: + type: string + x-stream-index: "001.005" + last_active: + format: date-time + type: number + x-stream-index: "001.014" + latest_hidden_channels: + items: + type: string + type: array + x-stream-index: "012" + mutes: + items: + $ref: '#/components/schemas/UserMuteResponse' + type: array + x-stream-index: "006" + name: + type: string + x-stream-index: "001.002" + online: + type: boolean + x-stream-index: "001.013" + privacy_settings: + $ref: '#/components/schemas/PrivacySettingsResponse' + x-stream-index: "003" + revoke_tokens_issued_before: + format: date-time + type: number + x-stream-index: "001.015" + role: + type: string + x-stream-index: "001.006" + shadow_banned: + type: boolean + x-stream-index: "013" + teams: + items: + type: string + type: array + x-stream-index: "001.007" + teams_role: + additionalProperties: + type: string + type: object + x-stream-index: "001.008" + total_unread_count: + format: int32 + type: integer + x-stream-index: "009" + unread_channels: + format: int32 + type: integer + x-stream-index: "010" + unread_count: + format: int32 + type: integer + x-stream-index: "008" + unread_threads: + format: int32 + type: integer + x-stream-index: "011" + updated_at: + format: date-time + type: number + x-stream-index: "001.010" + required: + - id + - custom + - language + - role + - teams + - created_at + - updated_at + - banned + - online + - devices + - invisible + - mutes + - channel_mutes + - unread_count + - total_unread_count + - unread_channels + - unread_threads + - shadow_banned + - blocked_user_ids + type: object + GeofenceSettings: + properties: + names: + items: + type: string + type: array + x-stream-index: "001" + required: + - names + type: object + GeofenceSettingsResponse: + properties: + names: + items: + type: string + type: array + x-stream-index: "001" + required: + - names + type: object + GetActivityResponse: + nullable: true + properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + description: The requested activity + title: Activity + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - activity + - duration + title: Get Activity Response + type: object + GetApplicationResponse: + description: Basic response information + nullable: true + properties: + app: + $ref: '#/components/schemas/AppResponseFields' + x-stream-index: "001" + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "002.001" + required: + - app + - duration + title: Response + type: object + GetBlockedUsersResponse: + nullable: true + properties: + blocks: + description: Array of blocked user object + items: + $ref: '#/components/schemas/BlockedUserResponse' + title: Blocks + type: array + x-stream-index: "001" + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "002.001" + required: + - blocks + - duration + type: object + GetCommentRepliesResponse: + nullable: true + properties: + comments: + description: Threaded listing of replies to the comment + items: + $ref: '#/components/schemas/ThreadedCommentResponse' + title: Comments + type: array + x-stream-index: "001" + duration: + type: string + x-stream-index: "003.001" + next: + type: string + x-stream-index: "002.001" + prev: + type: string + x-stream-index: "002.002" + required: + - comments + - duration + title: Get Comment Replies Response + type: object + GetCommentResponse: + nullable: true + properties: + comment: + $ref: '#/components/schemas/CommentResponse' + description: Comment + title: Comment + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - comment + - duration + title: Get Comment Response + type: object + GetCommentsResponse: + nullable: true + properties: + comments: + description: Threaded listing for the activity + items: + $ref: '#/components/schemas/ThreadedCommentResponse' + title: Comments + type: array + x-stream-index: "001" + duration: + type: string + x-stream-index: "003.001" + next: + type: string + x-stream-index: "002.001" + prev: + type: string + x-stream-index: "002.002" + required: + - comments + - duration + title: Get Comments Response + type: object + GetConfigResponse: + nullable: true + properties: + config: + $ref: '#/components/schemas/ConfigResponse' + description: The retrieved moderation configuration + title: Config + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - duration + type: object + GetFollowSuggestionsResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + suggestions: + description: List of suggested feeds to follow + items: + $ref: '#/components/schemas/FeedResponse' + title: Suggestions + type: array + x-stream-index: "001" + required: + - suggestions + - duration + title: Follow Suggestions Response + type: object + GetOGResponse: + nullable: true + properties: + actions: + items: + $ref: '#/components/schemas/Action' + type: array + x-stream-index: "001.015" + asset_url: + description: URL of detected video or audio + title: Image URL + type: string + x-stream-index: "001.017" + author_icon: + type: string + x-stream-index: "001.007" + author_link: + description: og:site + title: Author Link + type: string + x-stream-index: "001.006" + author_name: + description: og:site_name + title: Author Name + type: string + x-stream-index: "001.005" + color: + type: string + x-stream-index: "001.003" + custom: + additionalProperties: {} + type: object + x-stream-index: "001.018" + duration: + type: string + x-stream-index: "002.001" + fallback: + type: string + x-stream-index: "001.002" + fields: + items: + $ref: '#/components/schemas/Field' + type: array + x-stream-index: "001.016" + footer: + type: string + x-stream-index: "001.013" + footer_icon: + type: string + x-stream-index: "001.014" + giphy: + $ref: '#/components/schemas/Images' + x-stream-index: "001.019" + image_url: + description: URL of detected image + title: Image URL + type: string + x-stream-index: "001.011" + og_scrape_url: + description: extracted url from the text + title: OG Scrape URL + type: string + x-stream-index: "001.020" + original_height: + format: int32 + type: integer + x-stream-index: "001.022" + original_width: + format: int32 + type: integer + x-stream-index: "001.021" + pretext: + type: string + x-stream-index: "001.004" + text: + description: og:description + title: Text + type: string + x-stream-index: "001.010" + thumb_url: + description: URL of detected thumb image + title: Image URL + type: string + x-stream-index: "001.012" + title: + description: og:title + title: Title + type: string + x-stream-index: "001.008" + title_link: + description: og:url + title: Title Link + type: string + x-stream-index: "001.009" + type: + description: Attachment type, could be empty, image, audio or video + title: Type + type: string + x-stream-index: "001.001" + required: + - custom + - duration + title: Get OG Attachment + type: object + x-stream-docs-page-id: og + GetOrCreateFeedRequest: + description: Client request + nullable: true + properties: + activity_selector_options: + additionalProperties: {} + type: object + x-stream-index: "006" + data: + $ref: '#/components/schemas/FeedInput' + x-stream-index: "003" + external_ranking: + additionalProperties: {} + type: object + x-stream-index: "007" + filter: + additionalProperties: {} + type: object + x-stream-index: "009" + followers_pagination: + $ref: '#/components/schemas/PagerRequest' + x-stream-index: "011" + following_pagination: + $ref: '#/components/schemas/PagerRequest' + x-stream-index: "012" + interest_weights: + additionalProperties: + format: float + type: number + type: object + x-stream-index: "008" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "013.001" + member_pagination: + $ref: '#/components/schemas/PagerRequest' + x-stream-index: "010" + next: + type: string + x-stream-index: "013.002" + prev: + type: string + x-stream-index: "013.003" + view: + type: string + x-stream-index: "005" + watch: + type: boolean + x-stream-index: "004" + title: ClientRequest + type: object + GetOrCreateFeedResponse: + description: Basic response information + nullable: true + properties: + activities: + items: + $ref: '#/components/schemas/ActivityResponse' + type: array + x-stream-index: "002" + aggregated_activities: + items: + $ref: '#/components/schemas/AggregatedActivityResponse' + type: array + x-stream-index: "003" + created: + type: boolean + x-stream-index: "015" + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "017.001" + feed: + $ref: '#/components/schemas/FeedResponse' + x-stream-index: "001" + followers: + items: + $ref: '#/components/schemas/FollowResponse' + type: array + x-stream-index: "005" + followers_pagination: + $ref: '#/components/schemas/PagerResponse' + x-stream-index: "012" + following: + items: + $ref: '#/components/schemas/FollowResponse' + type: array + x-stream-index: "006" + following_pagination: + $ref: '#/components/schemas/PagerResponse' + x-stream-index: "013" + member_pagination: + $ref: '#/components/schemas/PagerResponse' + x-stream-index: "011" + members: + items: + $ref: '#/components/schemas/FeedMemberResponse' + type: array + x-stream-index: "004" + next: + type: string + x-stream-index: "016.001" + notification_status: + $ref: '#/components/schemas/NotificationStatusResponse' + x-stream-index: "014" + own_capabilities: + items: + $ref: '#/components/schemas/FeedOwnCapability' + type: array + x-stream-index: "008" + own_follows: + items: + $ref: '#/components/schemas/FollowResponse' + type: array + x-stream-index: "009" + own_membership: + $ref: '#/components/schemas/FeedMemberResponse' + x-stream-index: "010" + pinned_activities: + items: + $ref: '#/components/schemas/ActivityPinResponse' + type: array + x-stream-index: "007" + prev: + type: string + x-stream-index: "016.002" + required: + - feed + - activities + - aggregated_activities + - members + - followers + - following + - pinned_activities + - own_capabilities + - created + - duration + title: Response + type: object + GoogleVisionConfig: + properties: + enabled: + type: boolean + x-stream-index: "001" + type: object + HLSEgressConfig: + properties: + composite_app_settings: + $ref: '#/components/schemas/CompositeAppSettings' + x-stream-index: "005" + playlist_url: + type: string + x-stream-index: "007" + qualities: + items: + $ref: '#/components/schemas/Quality' + type: array + x-stream-index: "004" + start_unix_nano: + format: int64 + type: integer + x-stream-index: "006" + type: object + HLSSettings: + properties: + auto_on: + type: boolean + x-stream-index: "001" + enabled: + type: boolean + x-stream-index: "002" + layout: + $ref: '#/components/schemas/LayoutSettings' + x-stream-index: "004" + quality_tracks: + items: + type: string + type: array + x-stream-index: "003" + required: + - auto_on + - enabled + - quality_tracks + type: object + HLSSettingsResponse: + description: HLSSettings is the payload for HLS settings + properties: + auto_on: + title: Auto On + type: boolean + x-stream-index: "001" + enabled: + title: Enabled + type: boolean + x-stream-index: "002" + quality_tracks: + items: + type: string + title: Quality Tracks + type: array + x-stream-index: "003" + required: + - auto_on + - enabled + - quality_tracks + - layout + title: HLSSettingsResponse + type: object + HarmConfig: + properties: + action_sequences: + items: + $ref: '#/components/schemas/ActionSequence' + type: array + x-stream-index: "001" + severity: + type: integer + x-stream-index: "002" + required: + - action_sequences + - severity + type: object + HealthCheckEvent: + nullable: true + properties: + cid: + type: string + x-stream-index: "003" + connection_id: + type: string + x-stream-index: "001" + created_at: + format: date-time + type: number + x-stream-index: "004.003" + custom: + additionalProperties: {} + type: object + x-stream-index: "004.007" + me: + $ref: '#/components/schemas/OwnUserResponse' + x-stream-index: "002" + received_at: + format: date-time + type: number + x-stream-index: "004.004" + type: + default: health.check + type: string + x-stream-index: "004.002" + required: + - connection_id + - type + - created_at + - custom + title: HealthCheckEvent + 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 + ImageContentParameters: + properties: + harm_labels: + items: + type: string + type: array + x-stream-index: "001" + type: object + ImageData: + properties: + frames: + type: string + x-stream-index: "005" + height: + type: string + x-stream-index: "003" + size: + type: string + x-stream-index: "004" + url: + type: string + x-stream-index: "001" + width: + type: string + x-stream-index: "002" + required: + - url + - width + - height + - size + - frames + type: object + ImageRuleParameters: + properties: + harm_labels: + items: + type: string + type: array + x-stream-index: "003" + threshold: + format: int32 + type: integer + x-stream-index: "001" + time_window: + type: string + x-stream-index: "002" + type: object + ImageSize: + properties: + crop: + description: Crop mode + enum: + - top + - bottom + - left + - right + - center + title: Crop + type: string + x-stream-index: "001" + height: + description: Target image height + format: int32 + title: Height + type: integer + x-stream-index: "003" + resize: + description: Resize method + enum: + - clip + - crop + - scale + - fill + title: Resize + type: string + x-stream-index: "002" + width: + description: Target image width + format: int32 + title: Width + type: integer + x-stream-index: "004" + title: Image size configuration + type: object + ImageUploadRequest: + nullable: true + properties: + file: + type: string + x-stream-index: "001.001" + upload_sizes: + description: field with JSON-encoded array of image size configurations + items: + $ref: '#/components/schemas/ImageSize' + title: Upload sizes + type: array + x-stream-index: "002" + user: + $ref: '#/components/schemas/OnlyUserID' + x-stream-index: "001.002" + type: object + ImageUploadResponse: + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: 001.003.001 + file: + type: string + x-stream-index: "001.001" + thumb_url: + type: string + x-stream-index: "001.002" + upload_sizes: + description: Array of image size configurations + items: + $ref: '#/components/schemas/ImageSize' + title: Upload sizes + type: array + x-stream-index: "002" + required: + - duration + type: object + Images: + properties: + fixed_height: + $ref: '#/components/schemas/ImageData' + x-stream-index: "002" + fixed_height_downsampled: + $ref: '#/components/schemas/ImageData' + x-stream-index: "004" + fixed_height_still: + $ref: '#/components/schemas/ImageData' + x-stream-index: "003" + fixed_width: + $ref: '#/components/schemas/ImageData' + x-stream-index: "005" + fixed_width_downsampled: + $ref: '#/components/schemas/ImageData' + x-stream-index: "007" + fixed_width_still: + $ref: '#/components/schemas/ImageData' + x-stream-index: "006" + original: + $ref: '#/components/schemas/ImageData' + x-stream-index: "001" + required: + - original + - fixed_height + - fixed_height_still + - fixed_height_downsampled + - fixed_width + - fixed_width_still + - fixed_width_downsampled + type: object + IngressAudioEncodingOptions: + properties: + bitrate: + maximum: 128000 + minimum: 16000 + type: integer + x-stream-index: "003" + channels: + enum: + - "1" + - "2" + format: int32 + type: integer + x-stream-index: "001" + enable_dtx: + type: boolean + x-stream-index: "002" + required: + - channels + - enable_dtx + - bitrate + type: object + IngressAudioEncodingResponse: + properties: + bitrate: + format: int32 + type: integer + x-stream-index: "003" + channels: + format: int32 + type: integer + x-stream-index: "001" + enable_dtx: + type: boolean + x-stream-index: "002" + required: + - channels + - enable_dtx + - bitrate + type: object + IngressSettings: + properties: + audio_encoding_options: + $ref: '#/components/schemas/IngressAudioEncodingOptions' + x-stream-index: "002" + enabled: + type: boolean + x-stream-index: "001" + video_encoding_options: + additionalProperties: + $ref: '#/components/schemas/IngressVideoEncodingOptions' + type: object + x-stream-index: "003" + required: + - enabled + type: object + IngressSettingsResponse: + properties: + audio_encoding_options: + $ref: '#/components/schemas/IngressAudioEncodingResponse' + x-stream-index: "002" + enabled: + type: boolean + x-stream-index: "001" + video_encoding_options: + additionalProperties: + $ref: '#/components/schemas/IngressVideoEncodingResponse' + type: object + x-stream-index: "003" + required: + - enabled + type: object + IngressVideoEncodingOptions: + properties: + layers: + items: + $ref: '#/components/schemas/IngressVideoLayer' + minimum: 1 + type: array + x-stream-index: "001" + required: + - layers + type: object + IngressVideoEncodingResponse: + properties: + layers: + items: + $ref: '#/components/schemas/IngressVideoLayerResponse' + type: array + x-stream-index: "001" + required: + - layers + type: object + IngressVideoLayer: + nullable: true + properties: + bitrate: + minimum: 1000 + type: integer + x-stream-index: "002" + codec: + enum: + - h264 + - vp8 + type: string + x-stream-index: "001" + frame_rate: + maximum: 60 + minimum: 1 + type: integer + x-stream-index: "003" + max_dimension: + minimum: 240 + type: integer + x-stream-index: "005" + min_dimension: + minimum: 240 + type: integer + x-stream-index: "004" + required: + - codec + - bitrate + - frame_rate + - min_dimension + - max_dimension + type: object + IngressVideoLayerResponse: + nullable: true + properties: + bitrate: + type: integer + x-stream-index: "002" + codec: + type: string + x-stream-index: "001" + frame_rate_limit: + type: integer + x-stream-index: "005" + max_dimension: + type: integer + x-stream-index: "004" + min_dimension: + type: integer + x-stream-index: "003" + required: + - codec + - bitrate + - min_dimension + - max_dimension + - frame_rate_limit + type: object + LLMConfig: + properties: + app_context: + type: string + x-stream-index: "005" + async: + type: boolean + x-stream-index: "001" + enabled: + type: boolean + x-stream-index: "002" + rules: + items: + $ref: '#/components/schemas/LLMRule' + type: array + x-stream-index: "003" + severity_descriptions: + additionalProperties: + type: string + type: object + x-stream-index: "004" + required: + - enabled + - rules + type: object + LLMRule: + properties: + action: + enum: + - flag + - shadow + - remove + - bounce + - bounce_flag + - bounce_remove + - keep + type: string + x-stream-index: "003" + description: + type: string + x-stream-index: "002" + label: + type: string + x-stream-index: "001" + severity_rules: + items: + $ref: '#/components/schemas/BodyguardSeverityRule' + type: array + x-stream-index: "004" + required: + - label + - description + - action + - severity_rules + type: object + LabelThresholds: + properties: + block: + description: Threshold for automatic message block + format: float + maximum: 1 + minimum: 0 + title: Block + type: number + x-stream-index: "002" + flag: + description: Threshold for automatic message flag + format: float + maximum: 1 + minimum: 0 + title: Flag + type: number + x-stream-index: "001" + type: object + LayoutSettings: + properties: + detect_orientation: + type: boolean + x-stream-index: "005" + external_app_url: + type: string + x-stream-index: "003" + external_css_url: + type: string + x-stream-index: "004" + name: + enum: + - spotlight + - grid + - single-participant + - mobile + - custom + type: string + x-stream-index: "001" + options: + additionalProperties: {} + type: object + x-stream-index: "002" + required: + - name + - external_app_url + - external_css_url + type: object + LimitsSettings: + properties: + max_duration_seconds: + format: int32 + type: integer + x-stream-index: "004" + max_participants: + format: int32 + type: integer + x-stream-index: "001" + max_participants_exclude_owner: + type: boolean + x-stream-index: "003" + max_participants_exclude_roles: + items: + type: string + type: array + x-stream-index: "002" + required: + - max_participants_exclude_roles + type: object + LimitsSettingsResponse: + properties: + max_duration_seconds: + format: int32 + type: integer + x-stream-index: "004" + max_participants: + format: int32 + type: integer + x-stream-index: "001" + max_participants_exclude_owner: + type: boolean + x-stream-index: "003" + max_participants_exclude_roles: + items: + type: string + type: array + x-stream-index: "002" + required: + - max_participants_exclude_roles + type: object + ListBlockListResponse: + description: Basic response information + nullable: true + properties: + blocklists: + items: + $ref: '#/components/schemas/BlockListResponse' + type: array + x-stream-index: "001" + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "002.001" + required: + - blocklists + - duration + title: Response + type: object + ListDevicesResponse: + description: List devices response + nullable: true + properties: + devices: + description: List of devices + items: + $ref: '#/components/schemas/DeviceResponse' + title: Devices + type: array + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - devices + - duration + title: ListDevicesResponse + type: object + MarkActivityRequest: + nullable: true + properties: + mark_all_read: + description: Whether to mark all activities as read + title: Mark All Read + type: boolean + x-stream-index: "005" + mark_all_seen: + description: Whether to mark all activities as seen + title: Mark All Seen + type: boolean + x-stream-index: "003" + mark_read: + description: List of activity IDs to mark as read + items: + type: string + title: Mark Read + type: array + x-stream-index: "004" + mark_seen: + description: List of activity IDs to mark as seen + items: + type: string + title: Mark Seen + type: array + x-stream-index: "006" + mark_watched: + description: List of activity IDs to mark as watched (for stories) + items: + type: string + title: Mark Watched + type: array + x-stream-index: "007" + title: Mark Activity Request + type: object + MarkReviewedRequest: + properties: + content_to_mark_as_reviewed_limit: + format: int32 + maximum: 2500 + type: integer + x-stream-index: "002" + disable_marking_content_as_reviewed: + type: boolean + x-stream-index: "001" + type: object + MemberLookup: + properties: + Limit: + format: int32 + type: integer + writeOnly: true + x-stream-index: "001" + required: + - Limit + type: object + MembershipLevelResponse: + properties: + created_at: + description: When the membership level was created + format: date-time + title: Created At + type: number + x-stream-index: "007" + custom: + additionalProperties: {} + description: Custom data for the membership level + title: Custom Data + type: object + x-stream-index: "006" + description: + description: Description of the membership level + title: Description + type: string + x-stream-index: "003" + id: + description: Unique identifier for the membership level + title: ID + type: string + x-stream-index: "001" + name: + description: Display name for the membership level + title: Name + type: string + x-stream-index: "002" + priority: + description: Priority level + format: int32 + title: Priority + type: integer + x-stream-index: "004" + tags: + description: Activity tags this membership level gives access to + items: + type: string + title: Tags + type: array + x-stream-index: "005" + updated_at: + description: When the membership level was last updated + format: date-time + title: Updated At + type: number + x-stream-index: "008" + required: + - id + - name + - priority + - tags + - created_at + - updated_at + title: Membership Level Response + type: object + Message: + properties: + attachments: + items: + $ref: '#/components/schemas/Attachment' + type: array + x-stream-index: "012" + before_message_send_failed: + type: boolean + x-stream-index: "046" + cid: + type: string + x-stream-index: "028" + command: + type: string + x-stream-index: "006" + created_at: + format: date-time + type: number + x-stream-index: "030" + custom: + additionalProperties: {} + type: object + x-stream-index: "034" + deleted_at: + format: date-time + type: number + x-stream-index: "033" + deleted_for_me: + type: boolean + x-stream-index: "059" + deleted_reply_count: + format: int32 + type: integer + x-stream-index: "023" + html: + type: string + x-stream-index: "007" + i18n: + additionalProperties: + type: string + type: object + x-stream-index: "044" + id: + type: string + x-stream-index: "002" + image_labels: + additionalProperties: + items: + type: string + type: array + type: object + x-stream-index: "040" + latest_reactions: + items: + $ref: '#/components/schemas/Reaction' + type: array + x-stream-index: "013" + mentioned_users: + items: + $ref: '#/components/schemas/User' + type: array + x-stream-index: "043" + message_text_updated_at: + format: date-time + type: number + x-stream-index: "052" + mml: + type: string + x-stream-index: "005" + moderation: + $ref: '#/components/schemas/ModerationV2Response' + x-stream-index: "056" + own_reactions: + items: + $ref: '#/components/schemas/Reaction' + type: array + x-stream-index: "014" + parent_id: + type: string + x-stream-index: "019" + pin_expires: + format: date-time + type: number + x-stream-index: "051" + pinned: + type: boolean + x-stream-index: "047" + pinned_at: + format: date-time + type: number + x-stream-index: "048" + pinned_by: + $ref: '#/components/schemas/User' + x-stream-index: "050" + poll: + $ref: '#/components/schemas/Poll' + x-stream-index: "054" + poll_id: + type: string + x-stream-index: "053" + quoted_message: + $ref: '#/components/schemas/Message' + x-stream-index: "025" + quoted_message_id: + type: string + x-stream-index: "024" + reaction_counts: + additionalProperties: + format: int32 + type: integer + type: object + x-stream-index: "015" + reaction_groups: + additionalProperties: + $ref: '#/components/schemas/ReactionGroupResponse' + type: object + x-stream-index: "017" + reaction_scores: + additionalProperties: + format: int32 + type: integer + type: object + x-stream-index: "016" + reminder: + $ref: '#/components/schemas/MessageReminder' + x-stream-index: "058" + reply_count: + format: int32 + type: integer + x-stream-index: "022" + restricted_visibility: + items: + type: string + type: array + x-stream-index: "011" + shadowed: + type: boolean + x-stream-index: "036" + shared_location: + $ref: '#/components/schemas/SharedLocation' + x-stream-index: "055" + show_in_channel: + type: boolean + x-stream-index: "021" + silent: + type: boolean + x-stream-index: "045" + text: + type: string + x-stream-index: "004" + thread_participants: + items: + $ref: '#/components/schemas/User' + type: array + x-stream-index: "027" + type: + type: string + x-stream-index: "008" + updated_at: + format: date-time + type: number + x-stream-index: "031" + user: + $ref: '#/components/schemas/User' + x-stream-index: "010" + required: + - id + - text + - html + - type + - restricted_visibility + - attachments + - latest_reactions + - own_reactions + - reaction_counts + - reaction_scores + - reaction_groups + - reply_count + - deleted_reply_count + - cid + - created_at + - updated_at + - custom + - shadowed + - mentioned_users + - silent + - pinned + type: object + MessageReminder: + properties: + channel: + $ref: '#/components/schemas/Channel' + x-stream-index: "004" + channel_cid: + type: string + x-stream-index: "003" + created_at: + format: date-time + type: number + x-stream-index: "011" + message: + $ref: '#/components/schemas/Message' + x-stream-index: "006" + message_id: + type: string + x-stream-index: "005" + remind_at: + format: date-time + type: number + x-stream-index: "009" + task_id: + type: string + x-stream-index: "010" + updated_at: + format: date-time + type: number + x-stream-index: "012" + user: + $ref: '#/components/schemas/User' + x-stream-index: "008" + user_id: + type: string + x-stream-index: "007" + required: + - channel_cid + - message_id + - user_id + - task_id + - created_at + - updated_at + type: object + MessageResponse: + description: Represents any chat message + properties: + attachments: + description: Array of message attachments + items: + $ref: '#/components/schemas/Attachment' + title: Message attachments + type: array + x-stream-docs-page-id: message_format#attachment-format + x-stream-index: "008" + cid: + description: Channel unique identifier in : format + title: Channel CID + type: string + x-stream-index: "022" + command: + description: Contains provided slash command + title: Command + type: string + x-stream-docs-page-id: custom_commands_webhook + x-stream-index: "004" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: "023" + custom: + additionalProperties: {} + type: object + x-stream-index: "026" + deleted_at: + description: Date/time of deletion + format: date-time + title: Deleted at + type: number + x-stream-index: "025" + deleted_for_me: + type: boolean + x-stream-index: "044" + deleted_reply_count: + format: int32 + type: integer + x-stream-index: "018" + draft: + $ref: '#/components/schemas/DraftResponse' + x-stream-index: "041" + html: + description: Contains HTML markup of the message. Can only be set when using + server-side API + title: HTML content + type: string + x-stream-index: "005" + i18n: + additionalProperties: + type: string + description: Object with translations. Key `language` contains the original + language key. Other keys contain translations + title: Internationalization info + type: object + x-stream-docs-page-id: translation + x-stream-index: "030" + id: + description: Message ID is unique string identifier of the message + title: ID + type: string + x-stream-index: "001" + image_labels: + additionalProperties: + items: + type: string + type: array + description: Contains image moderation information + title: Image moderation labels + type: object + x-stream-index: "028" + latest_reactions: + description: List of 10 latest reactions to this message + items: + $ref: '#/components/schemas/ReactionResponse' + title: Latest reactions + type: array + x-stream-index: "009" + mentioned_users: + description: List of mentioned users + items: + $ref: '#/components/schemas/UserResponse' + title: Mentioned Users + type: array + x-stream-index: "029" + message_text_updated_at: + format: date-time + type: number + x-stream-index: "036" + mml: + description: Should be empty if `text` is provided. Can only be set when + using server-side API + title: Messaging Markup Language + type: string + x-stream-docs-page-id: mml_overview + x-stream-index: "003" + moderation: + $ref: '#/components/schemas/ModerationV2Response' + x-stream-index: "039" + own_reactions: + description: List of 10 latest reactions of authenticated user to this message + items: + $ref: '#/components/schemas/ReactionResponse' + title: Own reactions + type: array + x-stream-index: "010" + parent_id: + description: ID of parent message (thread) + title: Parent message ID + type: string + x-stream-docs-page-id: threads + x-stream-index: "015" + pin_expires: + description: Date when pinned message expires + format: date-time + title: Pin expiration date + type: number + x-stream-docs-page-id: pinned_messages + x-stream-index: "035" + pinned: + description: Whether message is pinned or not + title: Pinned + type: boolean + x-stream-docs-page-id: pinned_messages + x-stream-index: "032" + pinned_at: + description: Date when message got pinned + format: date-time + title: Pinned at + type: number + x-stream-docs-page-id: pinned_messages + x-stream-index: "033" + pinned_by: + $ref: '#/components/schemas/UserResponse' + description: Contains user who pinned the message + title: Pinned by + x-stream-docs-page-id: pinned_messages + x-stream-index: "034" + poll: + $ref: '#/components/schemas/PollResponseData' + x-stream-index: "038" + poll_id: + description: Identifier of the poll to include in the message + title: Poll ID + type: string + x-stream-index: "037" + quoted_message: + $ref: '#/components/schemas/MessageResponse' + description: Contains quoted message + title: Quoted message + x-stream-docs-page-id: threads#quote-message + x-stream-index: "020" + quoted_message_id: + title: ID of quoted message + type: string + x-stream-docs-page-id: threads#quote-message + x-stream-index: "019" + reaction_counts: + additionalProperties: + format: int32 + type: integer + description: 'An object containing number of reactions of each type. Key: + reaction type (string), value: number of reactions (int)' + title: Reaction counts + type: object + x-stream-index: "011" + reaction_groups: + additionalProperties: + $ref: '#/components/schemas/ReactionGroupResponse' + type: object + x-stream-index: "014" + reaction_scores: + additionalProperties: + format: int32 + type: integer + description: 'An object containing scores of reactions of each type. Key: + reaction type (string), value: total score of reactions (int)' + title: Reaction scores + type: object + x-stream-index: "012" + reminder: + $ref: '#/components/schemas/ReminderResponseData' + x-stream-index: "042" + reply_count: + description: Number of replies to this message + format: int32 + title: Reply count + type: integer + x-stream-index: "017" + restricted_visibility: + description: A list of user ids that have restricted visibility to the message, + if the list is not empty, the message is only visible to the users in + the list + items: + type: string + title: Restricted visibility + type: array + x-stream-index: "040" + shadowed: + description: Whether the message was shadowed or not + title: Shadowed + type: boolean + x-stream-docs-page-id: moderation#shadow-ban + x-stream-index: "027" + shared_location: + $ref: '#/components/schemas/SharedLocationResponseData' + description: Contains shared location data + title: Shared Location + x-stream-index: "043" + show_in_channel: + description: Whether thread reply should be shown in the channel as well + title: Show in channel + type: boolean + x-stream-docs-page-id: threads + x-stream-index: "016" + silent: + description: Whether message is silent or not + title: Silent + type: boolean + x-stream-index: "031" + text: + description: Text of the message. Should be empty if `mml` is provided + title: Text + type: string + x-stream-index: "002" + thread_participants: + description: List of users who participate in thread + items: + $ref: '#/components/schemas/UserResponse' + title: Thread participants + type: array + x-stream-docs-page-id: threads#quote-message + x-stream-index: "021" + type: + description: Contains type of the message + enum: + - regular + - ephemeral + - error + - reply + - system + - deleted + title: Message Type + type: string + x-stream-docs-page-id: message_format#message-types + x-stream-index: "006" + updated_at: + description: Date/time of the last update + format: date-time + title: Updated at + type: number + x-stream-index: "024" + user: + $ref: '#/components/schemas/UserResponse' + description: Sender of the message. Required when using server-side API + title: User object + x-stream-index: "007" + required: + - id + - text + - html + - type + - user + - attachments + - latest_reactions + - own_reactions + - reaction_counts + - reaction_scores + - reply_count + - deleted_reply_count + - cid + - created_at + - updated_at + - custom + - shadowed + - mentioned_users + - silent + - pinned + - restricted_visibility + title: Message + type: object + x-stream-docs-page-id: send_message + ModerationActionConfig: + nullable: true + properties: + action: + type: string + x-stream-index: "006" + custom: + additionalProperties: {} + type: object + x-stream-index: "009" + description: + type: string + x-stream-index: "008" + entity_type: + type: string + x-stream-index: "004" + icon: + type: string + x-stream-index: "007" + order: + format: int32 + type: integer + x-stream-index: "005" + required: + - entity_type + - order + - action + - icon + - description + - custom + type: object + ModerationCustomActionEvent: + properties: + created_at: + format: date-time + type: number + x-stream-index: "004.002" + item: + $ref: '#/components/schemas/ReviewQueueItem' + x-stream-index: "001" + message: + $ref: '#/components/schemas/Message' + x-stream-index: "002" + type: + default: moderation.custom_action + type: string + x-stream-index: "004.001" + user: + $ref: '#/components/schemas/User' + x-stream-index: "003.001" + required: + - type + - created_at + title: ModerationCustomActionEvent + 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 + ModerationFlagResponse: + nullable: true + properties: + created_at: + format: date-time + type: number + x-stream-index: "015" + custom: + additionalProperties: {} + type: object + x-stream-index: "010" + entity_creator_id: + type: string + x-stream-index: "007" + entity_id: + type: string + x-stream-index: "006" + entity_type: + type: string + x-stream-index: "005" + labels: + items: + type: string + type: array + x-stream-index: "011" + moderation_payload: + $ref: '#/components/schemas/ModerationPayload' + x-stream-index: "008" + reason: + type: string + x-stream-index: "009" + result: + items: + additionalProperties: {} + type: object + type: array + x-stream-index: "012" + review_queue_item: + $ref: '#/components/schemas/ReviewQueueItemResponse' + x-stream-index: "014" + review_queue_item_id: + type: string + x-stream-index: "013" + type: + type: string + x-stream-index: "002" + updated_at: + format: date-time + type: number + x-stream-index: "016" + user: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "004" + user_id: + type: string + x-stream-index: "003" + required: + - type + - user_id + - entity_type + - entity_id + - result + - created_at + - updated_at + type: object + ModerationFlaggedEvent: + properties: + created_at: + format: date-time + type: number + x-stream-index: "004.002" + item: + type: string + x-stream-index: "001" + object_id: + type: string + x-stream-index: "002" + type: + default: moderation.flagged + type: string + x-stream-index: "004.001" + user: + $ref: '#/components/schemas/User' + x-stream-index: "003.001" + required: + - type + - created_at + title: ModerationFlaggedEvent + 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 + ModerationMarkReviewedEvent: + properties: + created_at: + format: date-time + type: number + x-stream-index: "004.002" + item: + $ref: '#/components/schemas/ReviewQueueItem' + x-stream-index: "001" + message: + $ref: '#/components/schemas/Message' + x-stream-index: "002" + type: + default: moderation.mark_reviewed + type: string + x-stream-index: "004.001" + user: + $ref: '#/components/schemas/User' + x-stream-index: "003.001" + required: + - type + - created_at + title: ModerationMarkReviewedEvent + 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 + ModerationPayload: + properties: + custom: + additionalProperties: {} + type: object + x-stream-index: "004" + images: + items: + type: string + maximum: 30 + type: array + x-stream-index: "002" + texts: + items: + type: string + type: array + x-stream-index: "001" + videos: + items: + type: string + type: array + x-stream-index: "003" + type: object + ModerationV2Response: + properties: + action: + type: string + x-stream-index: "001" + blocklist_matched: + type: string + x-stream-index: "005" + image_harms: + items: + type: string + type: array + x-stream-index: "004" + original_text: + type: string + x-stream-index: "002" + platform_circumvented: + type: boolean + x-stream-index: "007" + semantic_filter_matched: + type: string + x-stream-index: "006" + text_harms: + items: + type: string + type: array + x-stream-index: "003" + required: + - action + - original_text + type: object + MuteRequest: + nullable: true + properties: + target_ids: + description: User IDs to mute (if multiple users) + items: + type: string + title: Target IDs + type: array + x-stream-index: "001" + timeout: + description: Duration of mute in minutes + minimum: 0 + title: Timeout + type: integer + x-stream-index: "002" + required: + - target_ids + title: MuteRequest + type: object + MuteResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "004.001" + mutes: + description: Object with mutes (if multiple users were muted) + items: + $ref: '#/components/schemas/UserMute' + title: Mutes + type: array + x-stream-index: "001" + non_existing_users: + description: A list of users that can't be found. Common cause for this + is deleted users + items: + type: string + title: Non Existing Users + type: array + x-stream-index: "003" + own_user: + $ref: '#/components/schemas/OwnUser' + description: Authorized user object with fresh mutes information + title: Own User + x-stream-index: "002" + required: + - duration + title: MuteResponse + type: object + NoiseCancellationSettings: + properties: + mode: + enum: + - available + - disabled + - auto-on + type: string + x-stream-index: "001" + required: + - mode + type: object + NotificationConfig: + properties: + track_read: + type: boolean + x-stream-index: "002" + track_seen: + type: boolean + x-stream-index: "001" + type: object + NotificationFeedUpdatedEvent: + description: Emitted when notification feed is updated. + nullable: true + properties: + aggregated_activities: + description: Aggregated activities for notification feeds + items: + $ref: '#/components/schemas/AggregatedActivityResponse' + title: Aggregated Activities + type: array + x-stream-index: "001" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 003.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 003.001.007 + feed_visibility: + type: string + x-stream-index: "003.003" + fid: + description: The ID of the feed + title: Feed ID + type: string + x-stream-index: "003.002" + notification_status: + $ref: '#/components/schemas/NotificationStatusResponse' + description: Notification status including unread/unseen counts + title: Notification Status + x-stream-index: "002" + received_at: + format: date-time + type: number + x-stream-index: 003.001.004 + type: + default: feeds.notification_feed.updated + description: 'The type of event: "feeds.notification_feed.updated" in this + case' + title: Event Type + type: string + x-stream-index: 003.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who triggered the notification + title: User + x-stream-index: "004.001" + required: + - type + - created_at + - custom + - fid + title: NotificationFeedUpdatedEvent + 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 + NotificationSettings: + properties: + call_live_started: + $ref: '#/components/schemas/EventNotificationSettings' + x-stream-index: "002" + call_missed: + $ref: '#/components/schemas/EventNotificationSettings' + x-stream-index: "006" + call_notification: + $ref: '#/components/schemas/EventNotificationSettings' + x-stream-index: "004" + call_ring: + $ref: '#/components/schemas/EventNotificationSettings' + x-stream-index: "005" + enabled: + type: boolean + x-stream-index: "001" + session_started: + $ref: '#/components/schemas/EventNotificationSettings' + x-stream-index: "003" + required: + - enabled + - call_live_started + - session_started + - call_notification + - call_ring + - call_missed + type: object + NotificationStatusResponse: + properties: + last_read_at: + format: date-time + type: number + x-stream-index: "006" + last_seen_at: + description: When notifications were last seen + format: date-time + title: Last Seen At + type: number + x-stream-index: "005" + read_activities: + description: IDs of activities that have been read + items: + type: string + title: Read Activities + type: array + x-stream-index: "003" + seen_activities: + items: + type: string + type: array + x-stream-index: "004" + unread: + description: Number of unread notifications + format: int32 + title: Unread + type: integer + x-stream-index: "001" + unseen: + description: Number of unseen notifications + format: int32 + title: Unseen + type: integer + x-stream-index: "002" + required: + - unread + - unseen + title: Notification Status + type: object + NullTime: + type: object + OCRRule: + properties: + action: + enum: + - flag + - shadow + - remove + - bounce + - bounce_flag + - bounce_remove + type: string + x-stream-index: "002" + label: + type: string + x-stream-index: "001" + required: + - label + - action + type: object + OnlyUserID: + properties: + id: + type: string + x-stream-index: "001" + required: + - id + type: object + OwnUser: + properties: + avg_response_time: + format: int32 + type: integer + x-stream-index: "046" + banned: + type: boolean + x-stream-index: "016" + blocked_user_ids: + items: + type: string + type: array + x-stream-index: "045" + channel_mutes: + items: + $ref: '#/components/schemas/ChannelMute' + type: array + x-stream-index: "029" + created_at: + format: date-time + type: number + x-stream-index: "008" + custom: + additionalProperties: {} + type: object + x-stream-index: "006" + deactivated_at: + format: date-time + type: number + x-stream-index: "014" + deleted_at: + format: date-time + type: number + x-stream-index: "013" + devices: + items: + $ref: '#/components/schemas/Device' + type: array + x-stream-index: "027" + id: + type: string + x-stream-index: "003" + invisible: + type: boolean + x-stream-index: "023" + language: + type: string + x-stream-index: "035" + last_active: + format: date-time + type: number + x-stream-index: "011" + last_engaged_at: + format: date-time + type: number + x-stream-index: "012" + latest_hidden_channels: + items: + type: string + type: array + x-stream-index: "037" + mutes: + items: + $ref: '#/components/schemas/UserMute' + type: array + x-stream-index: "028" + online: + type: boolean + x-stream-index: "022" + privacy_settings: + $ref: '#/components/schemas/PrivacySettings' + x-stream-index: "026" + push_preferences: + $ref: '#/components/schemas/PushPreferences' + x-stream-index: "025" + role: + type: string + x-stream-index: "004" + teams: + items: + type: string + type: array + x-stream-index: "036" + teams_role: + additionalProperties: + type: string + type: object + x-stream-index: "005" + total_unread_count: + format: int32 + type: integer + x-stream-index: "031" + total_unread_count_by_team: + additionalProperties: + format: int32 + type: integer + type: object + x-stream-index: "032" + unread_channels: + format: int32 + type: integer + x-stream-index: "033" + unread_count: + format: int32 + type: integer + x-stream-index: "030" + unread_threads: + format: int32 + type: integer + x-stream-index: "034" + updated_at: + format: date-time + type: number + x-stream-index: "009" + required: + - id + - role + - custom + - created_at + - updated_at + - banned + - online + - devices + - mutes + - channel_mutes + - unread_count + - total_unread_count + - total_unread_count_by_team + - unread_channels + - unread_threads + - language + type: object + OwnUserResponse: + properties: + avg_response_time: + format: int32 + type: integer + x-stream-index: "001.018" + banned: + type: boolean + x-stream-index: "001.012" + blocked_user_ids: + items: + type: string + type: array + x-stream-index: "015" + channel_mutes: + items: + $ref: '#/components/schemas/ChannelMute' + type: array + x-stream-index: "007" + created_at: + format: date-time + type: number + x-stream-index: "001.009" + custom: + additionalProperties: {} + type: object + x-stream-index: "001.004" + deactivated_at: + format: date-time + type: number + x-stream-index: "001.016" + deleted_at: + format: date-time + type: number + x-stream-index: "001.011" + devices: + items: + $ref: '#/components/schemas/DeviceResponse' + title: Devices + type: array + x-stream-index: "004" + id: + type: string + x-stream-index: "001.001" + image: + type: string + x-stream-index: "001.003" + invisible: + type: boolean + x-stream-index: "005" + language: + type: string + x-stream-index: "001.005" + last_active: + format: date-time + type: number + x-stream-index: "001.014" + latest_hidden_channels: + items: + type: string + type: array + x-stream-index: "013" + mutes: + items: + $ref: '#/components/schemas/UserMuteResponse' + type: array + x-stream-index: "006" + name: + type: string + x-stream-index: "001.002" + online: + type: boolean + x-stream-index: "001.013" + privacy_settings: + $ref: '#/components/schemas/PrivacySettingsResponse' + x-stream-index: "003" + push_preferences: + $ref: '#/components/schemas/PushPreferences' + x-stream-index: "002" + revoke_tokens_issued_before: + format: date-time + type: number + x-stream-index: "001.015" + role: + type: string + x-stream-index: "001.006" + teams: + items: + type: string + type: array + x-stream-index: "001.007" + teams_role: + additionalProperties: + type: string + type: object + x-stream-index: "001.008" + total_unread_count: + format: int32 + type: integer + x-stream-index: "009" + total_unread_count_by_team: + additionalProperties: + format: int32 + type: integer + type: object + x-stream-index: "010" + unread_channels: + format: int32 + type: integer + x-stream-index: "011" + unread_count: + format: int32 + type: integer + x-stream-index: "008" + unread_threads: + format: int32 + type: integer + x-stream-index: "012" + updated_at: + format: date-time + type: number + x-stream-index: "001.010" + required: + - id + - custom + - language + - role + - teams + - created_at + - updated_at + - banned + - online + - devices + - invisible + - mutes + - channel_mutes + - unread_count + - total_unread_count + - unread_channels + - unread_threads + type: object + PagerRequest: + properties: + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "001" + next: + type: string + x-stream-index: "002" + prev: + type: string + x-stream-index: "003" + type: object + PagerResponse: + properties: + next: + type: string + x-stream-index: "001" + prev: + type: string + x-stream-index: "002" + type: object + PinActivityRequest: + nullable: true + title: Pin Activity Request + type: object + PinActivityResponse: + nullable: true + properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + description: The pinned activity + title: Activity + x-stream-index: "001" + created_at: + description: When the activity was pinned + format: date-time + title: Created At + type: number + x-stream-index: "004" + duration: + type: string + x-stream-index: "005.001" + feed: + description: Fully qualified ID of the feed the activity was pinned to + title: Feed ID + type: string + x-stream-index: "002" + user_id: + description: ID of the user who pinned the activity + title: User ID + type: string + x-stream-index: "003" + required: + - activity + - feed + - user_id + - created_at + - duration + title: Pin Activity Response + type: object + Poll: + properties: + Custom: + additionalProperties: {} + type: object + writeOnly: true + x-stream-index: "023" + allow_answers: + type: boolean + x-stream-index: "010" + allow_user_suggested_options: + type: boolean + x-stream-index: "009" + answers_count: + format: int32 + type: integer + x-stream-index: "015" + created_at: + format: date-time + type: number + x-stream-index: "021" + created_by: + $ref: '#/components/schemas/User' + x-stream-index: "020" + created_by_id: + type: string + x-stream-index: "019" + description: + type: string + x-stream-index: "005" + enforce_unique_vote: + type: boolean + x-stream-index: "007" + id: + type: string + x-stream-index: "003" + is_closed: + type: boolean + x-stream-index: "011" + latest_answers: + items: + $ref: '#/components/schemas/PollVote' + type: array + x-stream-index: "017" + latest_votes_by_option: + additionalProperties: + items: + $ref: '#/components/schemas/PollVote' + type: array + type: object + x-stream-index: "016" + max_votes_allowed: + format: int32 + type: integer + x-stream-index: "008" + name: + type: string + x-stream-index: "004" + options: + items: + $ref: '#/components/schemas/PollOption' + type: array + x-stream-index: "013" + own_votes: + items: + $ref: '#/components/schemas/PollVote' + type: array + x-stream-index: "018" + updated_at: + format: date-time + type: number + x-stream-index: "022" + vote_count: + format: int32 + type: integer + x-stream-index: "012" + vote_counts_by_option: + additionalProperties: + format: int32 + type: integer + type: object + x-stream-index: "014" + voting_visibility: + type: string + x-stream-index: "006" + required: + - id + - name + - description + - enforce_unique_vote + - allow_user_suggested_options + - allow_answers + - vote_count + - options + - vote_counts_by_option + - answers_count + - latest_votes_by_option + - latest_answers + - own_votes + - created_by_id + - created_at + - updated_at + - Custom + type: object + PollClosedFeedEvent: + nullable: true + properties: + created_at: + format: date-time + type: number + x-stream-index: 001.002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 001.002.001.007 + feed_visibility: + type: string + x-stream-index: 001.002.003 + fid: + type: string + x-stream-index: 001.002.002 + poll: + $ref: '#/components/schemas/PollResponseData' + x-stream-index: "001.001" + received_at: + format: date-time + type: number + x-stream-index: 001.002.001.004 + type: + default: feeds.poll.closed + type: string + x-stream-index: 001.002.001.002 + required: + - poll + - type + - created_at + - custom + - fid + title: PollClosedFeedEvent + 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 + PollDeletedFeedEvent: + nullable: true + properties: + created_at: + format: date-time + type: number + x-stream-index: 001.002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 001.002.001.007 + feed_visibility: + type: string + x-stream-index: 001.002.003 + fid: + type: string + x-stream-index: 001.002.002 + poll: + $ref: '#/components/schemas/PollResponseData' + x-stream-index: "001.001" + received_at: + format: date-time + type: number + x-stream-index: 001.002.001.004 + type: + default: feeds.poll.deleted + type: string + x-stream-index: 001.002.001.002 + required: + - poll + - type + - created_at + - custom + - fid + title: PollDeletedFeedEvent + 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 + PollOption: + nullable: true + properties: + custom: + additionalProperties: {} + type: object + x-stream-index: "003" + id: + maxLength: 255 + type: string + x-stream-index: "001" + text: + type: string + x-stream-index: "002" + required: + - id + - text + - custom + type: object + PollOptionInput: + nullable: true + properties: + custom: + additionalProperties: {} + type: object + x-stream-index: "003" + text: + type: string + x-stream-index: "002" + type: object + PollOptionRequest: + nullable: true + properties: + custom: + additionalProperties: {} + type: object + x-stream-index: "003" + id: + maxLength: 255 + type: string + x-stream-index: "001" + text: + type: string + x-stream-index: "002" + required: + - id + type: object + PollOptionResponse: + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "002.001" + poll_option: + $ref: '#/components/schemas/PollOptionResponseData' + description: Poll option + title: PollOptionResponseData + x-stream-index: "001" + required: + - poll_option + - duration + type: object + PollOptionResponseData: + nullable: true + properties: + custom: + additionalProperties: {} + type: object + x-stream-index: "003" + id: + type: string + x-stream-index: "001" + text: + type: string + x-stream-index: "002" + required: + - id + - text + - custom + type: object + PollResponse: + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "002.001" + poll: + $ref: '#/components/schemas/PollResponseData' + description: Poll + title: PollResponseData + x-stream-index: "001" + required: + - poll + - duration + type: object + PollResponseData: + properties: + allow_answers: + type: boolean + x-stream-index: "008" + allow_user_suggested_options: + type: boolean + x-stream-index: "007" + answers_count: + format: int32 + type: integer + x-stream-index: "012" + created_at: + format: date-time + type: number + x-stream-index: "019" + created_by: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "018" + created_by_id: + type: string + x-stream-index: "017" + custom: + additionalProperties: {} + type: object + x-stream-index: "021" + description: + type: string + x-stream-index: "003" + enforce_unique_vote: + type: boolean + x-stream-index: "005" + id: + type: string + x-stream-index: "001" + is_closed: + type: boolean + x-stream-index: "009" + latest_answers: + items: + $ref: '#/components/schemas/PollVoteResponseData' + type: array + x-stream-index: "015" + latest_votes_by_option: + additionalProperties: + items: + $ref: '#/components/schemas/PollVoteResponseData' + type: array + type: object + x-stream-index: "014" + max_votes_allowed: + format: int32 + type: integer + x-stream-index: "006" + name: + type: string + x-stream-index: "002" + options: + items: + $ref: '#/components/schemas/PollOptionResponseData' + type: array + x-stream-index: "011" + own_votes: + items: + $ref: '#/components/schemas/PollVoteResponseData' + type: array + x-stream-index: "016" + updated_at: + format: date-time + type: number + x-stream-index: "020" + vote_count: + format: int32 + type: integer + x-stream-index: "010" + vote_counts_by_option: + additionalProperties: + format: int32 + type: integer + type: object + x-stream-index: "013" + voting_visibility: + type: string + x-stream-index: "004" + required: + - id + - name + - description + - voting_visibility + - enforce_unique_vote + - allow_user_suggested_options + - allow_answers + - vote_count + - options + - answers_count + - vote_counts_by_option + - latest_votes_by_option + - latest_answers + - own_votes + - created_by_id + - created_at + - updated_at + - custom + type: object + PollUpdatedFeedEvent: + nullable: true + properties: + created_at: + format: date-time + type: number + x-stream-index: 001.002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 001.002.001.007 + feed_visibility: + type: string + x-stream-index: 001.002.003 + fid: + type: string + x-stream-index: 001.002.002 + poll: + $ref: '#/components/schemas/PollResponseData' + x-stream-index: "001.001" + received_at: + format: date-time + type: number + x-stream-index: 001.002.001.004 + type: + default: feeds.poll.updated + type: string + x-stream-index: 001.002.001.002 + required: + - poll + - type + - created_at + - custom + - fid + title: PollUpdatedFeedEvent + 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 + PollVote: + nullable: true + properties: + answer_text: + type: string + x-stream-index: "007" + created_at: + format: date-time + type: number + x-stream-index: "010" + id: + type: string + x-stream-index: "004" + is_answer: + type: boolean + x-stream-index: "006" + option_id: + type: string + x-stream-index: "005" + poll_id: + type: string + x-stream-index: "003" + updated_at: + format: date-time + type: number + x-stream-index: "011" + user: + $ref: '#/components/schemas/User' + x-stream-index: "009" + user_id: + type: string + x-stream-index: "008" + required: + - poll_id + - id + - option_id + - created_at + - updated_at + type: object + PollVoteCastedFeedEvent: + nullable: true + properties: + created_at: + format: date-time + type: number + x-stream-index: 001.001.002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 001.001.002.001.007 + feed_visibility: + type: string + x-stream-index: 001.001.002.003 + fid: + type: string + x-stream-index: 001.001.002.002 + poll: + $ref: '#/components/schemas/PollResponseData' + x-stream-index: 001.001.001 + poll_vote: + $ref: '#/components/schemas/PollVoteResponseData' + x-stream-index: "001.002" + received_at: + format: date-time + type: number + x-stream-index: 001.001.002.001.004 + type: + default: feeds.poll.vote_casted + type: string + x-stream-index: 001.001.002.001.002 + required: + - poll + - type + - created_at + - custom + - fid + - poll_vote + title: PollVoteCastedFeedEvent + 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 + PollVoteChangedFeedEvent: + nullable: true + properties: + created_at: + format: date-time + type: number + x-stream-index: 001.001.002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 001.001.002.001.007 + feed_visibility: + type: string + x-stream-index: 001.001.002.003 + fid: + type: string + x-stream-index: 001.001.002.002 + poll: + $ref: '#/components/schemas/PollResponseData' + x-stream-index: 001.001.001 + poll_vote: + $ref: '#/components/schemas/PollVoteResponseData' + x-stream-index: "001.002" + received_at: + format: date-time + type: number + x-stream-index: 001.001.002.001.004 + type: + default: feeds.poll.vote_changed + type: string + x-stream-index: 001.001.002.001.002 + required: + - poll + - type + - created_at + - custom + - fid + - poll_vote + title: PollVoteChangedFeedEvent + 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 + PollVoteRemovedFeedEvent: + nullable: true + properties: + created_at: + format: date-time + type: number + x-stream-index: 001.001.002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 001.001.002.001.007 + feed_visibility: + type: string + x-stream-index: 001.001.002.003 + fid: + type: string + x-stream-index: 001.001.002.002 + poll: + $ref: '#/components/schemas/PollResponseData' + x-stream-index: 001.001.001 + poll_vote: + $ref: '#/components/schemas/PollVoteResponseData' + x-stream-index: "001.002" + received_at: + format: date-time + type: number + x-stream-index: 001.001.002.001.004 + type: + default: feeds.poll.vote_removed + type: string + x-stream-index: 001.001.002.001.002 + required: + - poll + - type + - created_at + - custom + - fid + - poll_vote + title: PollVoteRemovedFeedEvent + 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 + PollVoteResponse: + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "002.001" + vote: + $ref: '#/components/schemas/PollVoteResponseData' + description: Poll vote + title: PollVoteResponseData + x-stream-index: "001" + required: + - duration + type: object + PollVoteResponseData: + nullable: true + properties: + answer_text: + type: string + x-stream-index: "005" + created_at: + format: date-time + type: number + x-stream-index: "008" + id: + type: string + x-stream-index: "002" + is_answer: + type: boolean + x-stream-index: "004" + option_id: + type: string + x-stream-index: "003" + poll_id: + type: string + x-stream-index: "001" + updated_at: + format: date-time + type: number + x-stream-index: "009" + user: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "007" + user_id: + type: string + x-stream-index: "006" + required: + - poll_id + - id + - option_id + - created_at + - updated_at + type: object + PollVotesResponse: + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "003.001" + next: + type: string + x-stream-index: "002.001" + prev: + type: string + x-stream-index: "002.002" + votes: + description: Poll votes + items: + $ref: '#/components/schemas/PollVoteResponseData' + title: PollVoteResponseList + type: array + x-stream-index: "001" + required: + - votes + - duration + type: object + PrivacySettings: + properties: + read_receipts: + $ref: '#/components/schemas/ReadReceipts' + x-stream-index: "002" + typing_indicators: + $ref: '#/components/schemas/TypingIndicators' + x-stream-index: "001" + type: object + PrivacySettingsResponse: + properties: + read_receipts: + $ref: '#/components/schemas/ReadReceiptsResponse' + x-stream-index: "002" + typing_indicators: + $ref: '#/components/schemas/TypingIndicatorsResponse' + x-stream-index: "001" + type: object + PushNotificationConfig: + properties: + activity_types: + items: + type: string + type: array + x-stream-index: "002" + enabled: + type: boolean + x-stream-index: "001" + type: object + PushPreferences: + properties: + call_level: + type: string + x-stream-index: "002" + chat_level: + type: string + x-stream-index: "001" + disabled_until: + format: date-time + type: number + x-stream-index: "005" + feeds_events: + $ref: '#/components/schemas/FeedsEventPreferences' + x-stream-index: "004" + feeds_level: + type: string + x-stream-index: "003" + type: object + Quality: + properties: + bitdepth: + format: int32 + type: integer + x-stream-index: "007" + framerate: + format: int32 + type: integer + x-stream-index: "008" + height: + format: int32 + type: integer + x-stream-index: "006" + name: + type: string + x-stream-index: "004" + video_bitrate: + format: int32 + type: integer + x-stream-index: "009" + width: + format: int32 + type: integer + x-stream-index: "005" + type: object + QueryActivitiesRequest: + nullable: true + properties: + filter: + additionalProperties: {} + description: Filters to apply to the query. Supports location-based queries + with 'near' and 'within_bounds' operators. + title: Filter + type: object + x-stream-index: "001" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "003.001" + next: + type: string + x-stream-index: "003.002" + prev: + type: string + x-stream-index: "003.003" + sort: + description: Sorting parameters for the query + items: + $ref: '#/components/schemas/SortParamRequest' + maximum: 5 + title: Sort + type: array + x-stream-index: "002" + title: Query Activities Request + type: object + QueryActivitiesResponse: + nullable: true + properties: + activities: + description: List of activities matching the query + items: + $ref: '#/components/schemas/ActivityResponse' + title: Activities + type: array + x-stream-index: "001" + duration: + type: string + x-stream-index: "003.001" + next: + description: Cursor for next page + title: Next + type: string + x-stream-index: "002.001" + prev: + description: Cursor for previous page + title: Previous + type: string + x-stream-index: "002.002" + required: + - activities + - duration + title: Query Activities Response + type: object + QueryActivityReactionsRequest: + nullable: true + properties: + filter: + additionalProperties: {} + type: object + x-stream-index: "002" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "004.001" + next: + type: string + x-stream-index: "004.002" + prev: + type: string + x-stream-index: "004.003" + sort: + items: + $ref: '#/components/schemas/SortParamRequest' + maximum: 5 + type: array + x-stream-index: "003" + type: object + QueryActivityReactionsResponse: + description: Basic response information + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "003.001" + next: + type: string + x-stream-index: "002.001" + prev: + type: string + x-stream-index: "002.002" + reactions: + items: + $ref: '#/components/schemas/FeedsReactionResponse' + type: array + x-stream-index: "001" + required: + - reactions + - duration + title: Response + type: object + QueryBookmarkFoldersRequest: + nullable: true + properties: + filter: + additionalProperties: {} + description: Filters to apply to the query + title: Filter + type: object + x-stream-index: "001" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "003.001" + next: + type: string + x-stream-index: "003.002" + prev: + type: string + x-stream-index: "003.003" + sort: + description: Sorting parameters for the query + items: + $ref: '#/components/schemas/SortParamRequest' + title: Sort + type: array + x-stream-index: "002" + title: Query Bookmark Folders Request + type: object + QueryBookmarkFoldersResponse: + nullable: true + properties: + bookmark_folders: + description: List of bookmark folders matching the query + items: + $ref: '#/components/schemas/BookmarkFolderResponse' + title: Bookmark Folders + type: array + x-stream-index: "001" + duration: + type: string + x-stream-index: "003.001" + next: + description: Cursor for next page + title: Next + type: string + x-stream-index: "002.001" + prev: + description: Cursor for previous page + title: Previous + type: string + x-stream-index: "002.002" + required: + - bookmark_folders + - duration + title: Query Bookmark Folders Response + type: object + QueryBookmarksRequest: + nullable: true + properties: + filter: + additionalProperties: {} + description: Filters to apply to the query + title: Filter + type: object + x-stream-index: "001" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "003.001" + next: + type: string + x-stream-index: "003.002" + prev: + type: string + x-stream-index: "003.003" + sort: + description: Sorting parameters for the query + items: + $ref: '#/components/schemas/SortParamRequest' + maximum: 5 + title: Sort + type: array + x-stream-index: "002" + title: Query Bookmarks Request + type: object + QueryBookmarksResponse: + nullable: true + properties: + bookmarks: + description: List of bookmarks matching the query + items: + $ref: '#/components/schemas/BookmarkResponse' + title: Bookmarks + type: array + x-stream-index: "001" + duration: + type: string + x-stream-index: "003.001" + next: + description: Cursor for next page + title: Next + type: string + x-stream-index: "002.001" + prev: + description: Cursor for previous page + title: Previous + type: string + x-stream-index: "002.002" + required: + - bookmarks + - duration + title: Query Bookmarks Response + type: object + QueryCommentReactionsRequest: + nullable: true + properties: + filter: + additionalProperties: {} + type: object + x-stream-index: "002" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "004.001" + next: + type: string + x-stream-index: "004.002" + prev: + type: string + x-stream-index: "004.003" + sort: + items: + $ref: '#/components/schemas/SortParamRequest' + maximum: 5 + type: array + x-stream-index: "003" + type: object + QueryCommentReactionsResponse: + description: Basic response information + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "003.001" + next: + type: string + x-stream-index: "002.001" + prev: + type: string + x-stream-index: "002.002" + reactions: + items: + $ref: '#/components/schemas/FeedsReactionResponse' + type: array + x-stream-index: "001" + required: + - reactions + - duration + title: Response + type: object + QueryCommentsRequest: + nullable: true + properties: + filter: + additionalProperties: {} + description: MongoDB-style filter for querying comments + title: Filter + type: object + x-stream-index: "001" + limit: + description: Maximum number of comments to return + format: int32 + maximum: 100 + minimum: 0 + title: Limit + type: integer + x-stream-index: "003.001" + next: + type: string + x-stream-index: "003.002" + prev: + type: string + x-stream-index: "003.003" + sort: + description: first (oldest), last (newest) or top + enum: + - first + - last + - top + - best + - controversial + title: Sort Order + type: string + x-stream-index: "002" + required: + - filter + title: Query Comments Request + type: object + QueryCommentsResponse: + nullable: true + properties: + comments: + description: List of comments matching the query + items: + $ref: '#/components/schemas/CommentResponse' + title: Comments + type: array + x-stream-index: "001" + duration: + type: string + x-stream-index: "003.001" + next: + description: Cursor for next page + title: Next + type: string + x-stream-index: "002.001" + prev: + description: Cursor for previous page + title: Previous + type: string + x-stream-index: "002.002" + required: + - comments + - duration + title: Query Comments Response + type: object + QueryFeedMembersRequest: + nullable: true + properties: + filter: + additionalProperties: {} + description: Filter parameters for the query + title: object + type: object + x-stream-index: "003" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "005.001" + next: + type: string + x-stream-index: "005.002" + prev: + type: string + x-stream-index: "005.003" + sort: + description: Sort parameters for the query + items: + $ref: '#/components/schemas/SortParamRequest' + maximum: 5 + title: array + type: array + x-stream-index: "004" + type: object + QueryFeedMembersResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "003.001" + members: + description: List of feed members + items: + $ref: '#/components/schemas/FeedMemberResponse' + title: array + type: array + x-stream-index: "001" + next: + description: Cursor for next page + title: Next + type: string + x-stream-index: "002.001" + prev: + description: Cursor for previous page + title: Previous + type: string + x-stream-index: "002.002" + required: + - members + - duration + type: object + QueryFeedsRequest: + nullable: true + properties: + filter: + additionalProperties: {} + description: Filters to apply to the query + title: Filter + type: object + x-stream-index: "001" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "004.001" + next: + type: string + x-stream-index: "004.002" + prev: + type: string + x-stream-index: "004.003" + sort: + description: Sorting parameters for the query + items: + $ref: '#/components/schemas/SortParamRequest' + maximum: 5 + title: Sort + type: array + x-stream-index: "003" + watch: + description: Whether to subscribe to realtime updates + title: Watch + type: boolean + x-stream-index: "002" + title: Query Feeds Request + type: object + QueryFeedsResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "003.001" + feeds: + description: List of feeds matching the query + items: + $ref: '#/components/schemas/FeedResponse' + title: Feeds + type: array + x-stream-index: "001" + next: + description: Cursor for next page + title: Next + type: string + x-stream-index: "002.001" + prev: + description: Cursor for previous page + title: Previous + type: string + x-stream-index: "002.002" + required: + - feeds + - duration + title: Query Feeds Response + type: object + QueryFollowsRequest: + nullable: true + properties: + filter: + additionalProperties: {} + description: Filters to apply to the query + title: Filter + type: object + x-stream-index: "001" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "003.001" + next: + type: string + x-stream-index: "003.002" + prev: + type: string + x-stream-index: "003.003" + sort: + description: Sorting parameters for the query + items: + $ref: '#/components/schemas/SortParamRequest' + maximum: 5 + title: Sort + type: array + x-stream-index: "002" + title: Query Follows Request + type: object + QueryFollowsResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "003.001" + follows: + description: List of follow relationships matching the query + items: + $ref: '#/components/schemas/FollowResponse' + title: Follows + type: array + x-stream-index: "001" + next: + description: Cursor for next page + title: Next + type: string + x-stream-index: "002.001" + prev: + description: Cursor for previous page + title: Previous + type: string + x-stream-index: "002.002" + required: + - follows + - duration + title: Query Follows Response + type: object + QueryModerationConfigsRequest: + nullable: true + properties: + filter: + additionalProperties: {} + description: Filter conditions for moderation configs + title: Filter + type: object + x-stream-index: "001" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "003.001" + next: + type: string + x-stream-index: "003.002" + prev: + type: string + x-stream-index: "003.003" + sort: + description: Sorting parameters for the results + items: + $ref: '#/components/schemas/SortParamRequest' + title: Sort + type: array + x-stream-index: "002" + type: object + QueryModerationConfigsResponse: + nullable: true + properties: + configs: + description: List of moderation configurations + items: + $ref: '#/components/schemas/ConfigResponse' + title: Configs + type: array + x-stream-index: "001" + duration: + type: string + x-stream-index: "003.001" + next: + type: string + x-stream-index: "002.001" + prev: + type: string + x-stream-index: "002.002" + required: + - configs + - duration + type: object + QueryPollVotesRequest: + nullable: true + properties: + filter: + additionalProperties: {} + description: Filter to apply to the query + title: Filter + type: object + x-stream-index: "003" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "005.001" + next: + type: string + x-stream-index: "005.002" + prev: + type: string + x-stream-index: "005.003" + sort: + description: Array of sort parameters + items: + $ref: '#/components/schemas/SortParamRequest' + maximum: 5 + title: Sort + type: array + x-stream-index: "004" + type: object + QueryPollsRequest: + nullable: true + properties: + filter: + additionalProperties: {} + description: Filter to apply to the query + title: Filter + type: object + x-stream-index: "002" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "005.001" + next: + type: string + x-stream-index: "005.002" + prev: + type: string + x-stream-index: "005.003" + sort: + description: Array of sort parameters + items: + $ref: '#/components/schemas/SortParamRequest' + maximum: 5 + title: Sort + type: array + x-stream-index: "003" + type: object + QueryPollsResponse: + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "003.001" + next: + type: string + x-stream-index: "002.001" + polls: + description: Polls data returned by the query + items: + $ref: '#/components/schemas/PollResponseData' + title: PollsResponseData + type: array + x-stream-index: "001" + prev: + type: string + x-stream-index: "002.002" + required: + - polls + - duration + type: object + QueryReviewQueueRequest: + nullable: true + properties: + filter: + additionalProperties: {} + description: Filter conditions for review queue items + title: Filter + type: object + x-stream-index: "001" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "007.001" + lock_count: + description: Number of items to lock (1-25) + format: int32 + maximum: 25 + minimum: 1 + title: Lock Count + type: integer + x-stream-index: "005" + lock_duration: + description: Duration for which items should be locked + title: Lock Duration + type: integer + x-stream-index: "004" + lock_items: + description: Whether to lock items for review (true), unlock items (false), + or just fetch (nil) + title: Lock Items + type: boolean + x-stream-index: "003" + next: + type: string + x-stream-index: "007.002" + prev: + type: string + x-stream-index: "007.003" + sort: + description: Sorting parameters for the results + items: + $ref: '#/components/schemas/SortParamRequest' + title: Sort + type: array + x-stream-index: "002" + stats_only: + description: Whether to return only statistics + title: Stats Only + type: boolean + x-stream-index: "006" + type: object + QueryReviewQueueResponse: + nullable: true + properties: + action_config: + additionalProperties: + items: + $ref: '#/components/schemas/ModerationActionConfig' + type: array + description: Configuration for moderation actions + title: Action Config + type: object + x-stream-index: "002" + duration: + type: string + x-stream-index: "005.001" + items: + description: List of review queue items + items: + $ref: '#/components/schemas/ReviewQueueItemResponse' + title: Items + type: array + x-stream-index: "001" + next: + type: string + x-stream-index: "004.001" + prev: + type: string + x-stream-index: "004.002" + stats: + additionalProperties: {} + description: Statistics about the review queue + title: Stats + type: object + x-stream-index: "003" + required: + - items + - action_config + - stats + - duration + type: object + QueryUsersPayload: + properties: + filter_conditions: + additionalProperties: {} + type: object + x-stream-index: "001" + include_deactivated_users: + type: boolean + x-stream-index: "004" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "005.003" + offset: + format: int32 + maximum: 1000 + type: integer + x-stream-index: "005.004" + presence: + type: boolean + x-stream-index: "003" + sort: + items: + $ref: '#/components/schemas/SortParamRequest' + maximum: 5 + type: array + x-stream-index: "002" + required: + - filter_conditions + type: object + QueryUsersResponse: + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "002.001" + users: + description: Array of users as result of filters applied. + items: + $ref: '#/components/schemas/FullUserResponse' + title: Users + type: array + x-stream-index: "001" + required: + - users + - duration + type: object + RTMPEgressConfig: + properties: + composite_app_settings: + $ref: '#/components/schemas/CompositeAppSettings' + x-stream-index: "005" + quality: + $ref: '#/components/schemas/Quality' + x-stream-index: "004" + rtmp_location: + type: string + x-stream-index: "006" + type: object + RTMPIngress: + description: RTMP input settings + properties: + address: + title: Address + type: string + x-stream-index: "001" + required: + - address + title: RTMPIngress + type: object + RTMPLocation: + properties: + name: + type: string + x-stream-index: "001" + stream_key: + type: string + x-stream-index: "003" + stream_url: + type: string + x-stream-index: "002" + required: + - name + - stream_url + - stream_key + type: object + RTMPSettings: + properties: + enabled: + type: boolean + x-stream-index: "001" + layout: + $ref: '#/components/schemas/LayoutSettings' + x-stream-index: "003" + location: + $ref: '#/components/schemas/RTMPLocation' + x-stream-index: "004" + quality_name: + type: string + x-stream-index: "002" + required: + - enabled + type: object + RTMPSettingsResponse: + description: RTMPSettingsResponse is the payload for RTMP settings + properties: + enabled: + title: Enabled + type: boolean + x-stream-index: "001" + quality: + title: Quality + type: string + x-stream-index: "002" + required: + - enabled + - quality + - layout + title: RTMPSettingsResponse + type: object + RankingConfig: + properties: + defaults: + additionalProperties: {} + type: object + x-stream-index: "003" + functions: + additionalProperties: + $ref: '#/components/schemas/DecayFunctionConfig' + type: object + x-stream-index: "004" + score: + type: string + x-stream-index: "002" + type: + type: string + x-stream-index: "001" + type: object + Reaction: + nullable: true + properties: + created_at: + format: date-time + readOnly: true + type: number + x-stream-index: "008" + custom: + additionalProperties: {} + type: object + x-stream-index: "010" + message_id: + type: string + x-stream-index: "003" + score: + format: int32 + type: integer + x-stream-index: "007" + type: + maxLength: 30 + type: string + x-stream-index: "006" + updated_at: + format: date-time + readOnly: true + type: number + x-stream-index: "009" + user: + $ref: '#/components/schemas/User' + x-stream-index: "005" + user_id: + type: string + x-stream-index: "004" + required: + - message_id + - type + - score + - created_at + - updated_at + - custom + type: object + ReactionGroupResponse: + description: ReactionGroupResponse contains all information about a reaction + of the same type. + nullable: true + properties: + count: + description: Count is the number of reactions of this type. + format: int32 + title: Count + type: integer + x-stream-index: "001" + first_reaction_at: + description: FirstReactionAt is the time of the first reaction of this type. + This is the same also if all reaction of this type are deleted, because + if someone will react again with the same type, will be preserved the + sorting. + format: date-time + title: FirstReactionAt + type: number + x-stream-index: "003" + last_reaction_at: + description: LastReactionAt is the time of the last reaction of this type. + format: date-time + title: LastReactionAt + type: number + x-stream-index: "004" + sum_scores: + description: 'SumScores is the sum of all scores of reactions of this type. + Medium allows you to clap articles more than once and shows the sum of + all claps from all users. For example, you can send `clap` x5 using `score: + 5`.' + format: int32 + title: SumScores + type: integer + x-stream-index: "002" + required: + - count + - sum_scores + - first_reaction_at + - last_reaction_at + title: ReactionGroupResponse + type: object + ReactionResponse: + properties: + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: "006" + custom: + additionalProperties: {} + description: Custom data for this object + title: Custom data + type: object + x-stream-index: "008" + message_id: + description: Message ID + title: Message ID + type: string + x-stream-index: "001" + score: + description: Score of the reaction + format: int32 + title: Score + type: integer + x-stream-index: "005" + type: + description: Type of reaction + title: Type + type: string + x-stream-index: "004" + updated_at: + description: Date/time of the last update + format: date-time + title: Updated at + type: number + x-stream-index: "007" + user: + $ref: '#/components/schemas/UserResponse' + description: User + title: UserResponse + x-stream-index: "003" + user_id: + description: User ID + title: User ID + type: string + x-stream-index: "002" + required: + - message_id + - user_id + - user + - type + - score + - created_at + - updated_at + - custom + type: object + ReadReceipts: + properties: + enabled: + type: boolean + x-stream-index: "001" + required: + - enabled + type: object + ReadReceiptsResponse: + properties: + enabled: + type: boolean + x-stream-index: "001" + required: + - enabled + type: object + RecordSettings: + properties: + audio_only: + type: boolean + x-stream-index: "001" + layout: + $ref: '#/components/schemas/LayoutSettings' + x-stream-index: "004" + mode: + type: string + x-stream-index: "002" + quality: + type: string + x-stream-index: "003" + required: + - mode + type: object + RecordSettingsResponse: + description: RecordSettings is the payload for recording settings + properties: + audio_only: + title: Audio Only + type: boolean + x-stream-index: "001" + mode: + title: Mode + type: string + x-stream-index: "002" + quality: + title: Quality + type: string + x-stream-index: "003" + required: + - audio_only + - mode + - quality + - layout + title: RecordSettingsResponse + type: object + RecordingEgressConfig: + properties: + audio_only: + type: boolean + x-stream-index: "006" + composite_app_settings: + $ref: '#/components/schemas/CompositeAppSettings' + x-stream-index: "005" + external_storage: + $ref: '#/components/schemas/ExternalStorage' + x-stream-index: "008" + quality: + $ref: '#/components/schemas/Quality' + x-stream-index: "004" + storage_name: + type: string + x-stream-index: "007" + video_orientation_hint: + $ref: '#/components/schemas/VideoOrientation' + x-stream-index: "009" + type: object + RejectFeedMemberInviteRequest: + nullable: true + title: Reject Feed Member Request + type: object + RejectFeedMemberInviteResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + member: + $ref: '#/components/schemas/FeedMemberResponse' + description: The feed member after rejecting the invite + title: Feed Member + x-stream-index: "001" + required: + - member + - duration + title: Reject Feed Member Response + type: object + RejectFollowRequest: + nullable: true + properties: + source: + description: Fully qualified ID of the source feed + maxLength: 255 + title: Source Feed ID + type: string + x-stream-index: "001" + target: + description: Fully qualified ID of the target feed + maxLength: 255 + title: Target Feed ID + type: string + x-stream-index: "002" + required: + - source + - target + title: Reject Follow Request + type: object + RejectFollowResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + follow: + $ref: '#/components/schemas/FollowResponse' + description: The rejected follow relationship + title: Follow + x-stream-index: "001" + required: + - follow + - duration + title: Reject Follow Response + type: object + ReminderResponseData: + properties: + channel: + $ref: '#/components/schemas/ChannelResponse' + x-stream-index: "003" + channel_cid: + type: string + x-stream-index: "002" + created_at: + format: date-time + type: number + x-stream-index: "008" + message: + $ref: '#/components/schemas/Message' + x-stream-index: "005" + message_id: + type: string + x-stream-index: "004" + remind_at: + format: date-time + type: number + x-stream-index: "001" + updated_at: + format: date-time + type: number + x-stream-index: "009" + user: + $ref: '#/components/schemas/User' + x-stream-index: "007" + user_id: + type: string + x-stream-index: "006" + required: + - channel_cid + - message_id + - user_id + - created_at + - updated_at + type: object + RepliesMeta: + description: Cursor & depth information for a comment's direct replies. Mirrors + Reddit's 'load more replies' semantics. + properties: + depth_truncated: + description: True if the subtree was cut because the requested depth was + reached. + title: Depth Truncated + type: boolean + x-stream-index: "004" + has_more: + description: True if more siblings exist in the database. + title: Has More + type: boolean + x-stream-index: "001" + next_cursor: + description: Opaque cursor to request the next page of siblings. + title: Next Cursor + type: string + x-stream-index: "002" + remaining: + description: Number of unread siblings that match current filters. + format: int32 + title: Remaining + type: integer + x-stream-index: "003" + required: + - has_more + - remaining + - depth_truncated + title: Replies Meta + type: object + Response: + description: Basic response information + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "001" + required: + - duration + title: Response + type: object + RestoreActionRequest: + type: object + ReviewQueueItem: + properties: + actions: + items: + $ref: '#/components/schemas/ActionLog' + type: array + x-stream-index: "035" + activity: + $ref: '#/components/schemas/EnrichedActivity' + x-stream-index: "028" + ai_text_severity: + type: string + x-stream-index: "021" + archived_at: + $ref: '#/components/schemas/NullTime' + x-stream-index: "043" + assigned_to: + $ref: '#/components/schemas/User' + x-stream-index: "032" + bans: + items: + $ref: '#/components/schemas/Ban' + type: array + x-stream-index: "033" + bounce_count: + format: int32 + type: integer + x-stream-index: "025" + call: + $ref: '#/components/schemas/Call' + x-stream-index: "031" + completed_at: + $ref: '#/components/schemas/NullTime' + x-stream-index: "018" + config_key: + type: string + x-stream-index: "009" + content_changed: + type: boolean + x-stream-index: "036" + created_at: + format: date-time + type: number + x-stream-index: "004" + entity_creator: + $ref: '#/components/schemas/EntityCreator' + x-stream-index: "030" + entity_id: + type: string + x-stream-index: "007" + entity_type: + type: string + x-stream-index: "006" + feeds_v2_activity: + $ref: '#/components/schemas/EnrichedActivity' + x-stream-index: "041" + feeds_v2_reaction: + $ref: '#/components/schemas/Reaction' + x-stream-index: "042" + flag_labels: + items: + type: string + type: array + x-stream-index: "045" + flag_types: + items: + type: string + type: array + x-stream-index: "044" + flags: + items: + $ref: '#/components/schemas/Flag' + type: array + x-stream-index: "034" + flags_count: + format: int32 + type: integer + x-stream-index: "026" + has_image: + type: boolean + x-stream-index: "012" + has_text: + type: boolean + x-stream-index: "014" + has_video: + type: boolean + x-stream-index: "013" + id: + type: string + x-stream-index: "003" + languages: + items: + type: string + type: array + x-stream-index: "019" + message: + $ref: '#/components/schemas/Message' + x-stream-index: "027" + moderation_payload: + $ref: '#/components/schemas/ModerationPayload' + x-stream-index: "010" + moderation_payload_hash: + type: string + x-stream-index: "011" + reaction: + $ref: '#/components/schemas/Reaction' + x-stream-index: "029" + recommended_action: + type: string + x-stream-index: "017" + reporter_ids: + items: + type: string + type: array + x-stream-index: "046" + reviewed_at: + $ref: '#/components/schemas/NullTime' + x-stream-index: "022" + reviewed_by: + type: string + x-stream-index: "023" + severity: + format: int32 + type: integer + x-stream-index: "020" + status: + type: string + x-stream-index: "016" + teams: + items: + type: string + type: array + x-stream-index: "015" + updated_at: + format: date-time + type: number + x-stream-index: "005" + required: + - id + - created_at + - updated_at + - entity_type + - entity_id + - config_key + - moderation_payload_hash + - has_image + - has_video + - has_text + - teams + - status + - recommended_action + - completed_at + - languages + - severity + - ai_text_severity + - reviewed_at + - reviewed_by + - bounce_count + - flags_count + - bans + - flags + - actions + - content_changed + - archived_at + - flag_types + - flag_labels + - reporter_ids + type: object + ReviewQueueItemResponse: + nullable: true + properties: + actions: + description: Moderation actions taken + items: + $ref: '#/components/schemas/ActionLogResponse' + title: Actions + type: array + x-stream-index: "024" + activity: + $ref: '#/components/schemas/EnrichedActivity' + x-stream-index: "016" + ai_text_severity: + description: AI-determined text severity + title: AI Text Severity + type: string + x-stream-index: "014" + assigned_to: + $ref: '#/components/schemas/UserResponse' + description: Moderator assigned to review this item + title: Assigned To + x-stream-index: "021" + bans: + description: Associated ban records + items: + $ref: '#/components/schemas/Ban' + title: Bans + type: array + x-stream-index: "022" + call: + $ref: '#/components/schemas/CallResponse' + x-stream-index: "018" + completed_at: + description: When the review was completed + format: date-time + title: Completed At + type: number + x-stream-index: "009" + config_key: + type: string + x-stream-index: "028" + created_at: + description: When the item was created + format: date-time + title: Created At + type: number + x-stream-index: "002" + entity_creator: + $ref: '#/components/schemas/EntityCreatorResponse' + description: Details about who created the entity + title: Entity Creator + x-stream-index: "019" + entity_creator_id: + description: ID of who created the entity + title: Entity Creator ID + type: string + x-stream-index: "020" + entity_id: + description: ID of the entity being reviewed + title: Entity ID + type: string + x-stream-index: "005" + entity_type: + description: Type of entity being reviewed + title: Entity Type + type: string + x-stream-index: "004" + feeds_v2_activity: + $ref: '#/components/schemas/EnrichedActivity' + description: Associated feed activity + title: Feeds V2 Activity + x-stream-index: "025" + feeds_v2_reaction: + $ref: '#/components/schemas/Reaction' + description: Associated feed reaction + title: Feeds V2 Reaction + x-stream-index: "026" + flags: + description: Associated flag records + items: + $ref: '#/components/schemas/ModerationFlagResponse' + title: Flags + type: array + x-stream-index: "023" + flags_count: + format: int32 + type: integer + x-stream-index: "029" + id: + description: Unique identifier of the review queue item + title: ID + type: string + x-stream-index: "001" + languages: + description: Detected languages in the content + items: + type: string + title: Languages + type: array + x-stream-index: "012" + message: + $ref: '#/components/schemas/MessageResponse' + description: Associated message details + title: Message + x-stream-index: "015" + moderation_payload: + $ref: '#/components/schemas/ModerationPayload' + description: Content being moderated + title: Moderation Payload + x-stream-index: "006" + reaction: + $ref: '#/components/schemas/Reaction' + x-stream-index: "017" + recommended_action: + description: Suggested moderation action + title: Recommended Action + type: string + x-stream-index: "008" + reviewed_at: + description: When the item was reviewed + format: date-time + title: Reviewed At + type: number + x-stream-index: "010" + reviewed_by: + description: ID of the moderator who reviewed the item + title: Reviewed By + type: string + x-stream-index: "011" + severity: + description: Severity level of the content + format: int32 + title: Severity + type: integer + x-stream-index: "013" + status: + description: Current status of the review + title: Status + type: string + x-stream-index: "007" + teams: + description: Teams associated with this item + items: + type: string + title: Teams + type: array + x-stream-index: "027" + updated_at: + description: When the item was last updated + format: date-time + title: Updated At + type: number + x-stream-index: "003" + required: + - id + - created_at + - updated_at + - entity_type + - entity_id + - status + - recommended_action + - reviewed_by + - languages + - severity + - ai_text_severity + - bans + - flags + - actions + - flags_count + type: object + RingSettings: + properties: + auto_cancel_timeout_ms: + format: int32 + type: integer + x-stream-index: "002" + incoming_call_timeout_ms: + format: int32 + type: integer + x-stream-index: "001" + missed_call_timeout_ms: + format: int32 + type: integer + x-stream-index: "003" + required: + - incoming_call_timeout_ms + - auto_cancel_timeout_ms + - missed_call_timeout_ms + type: object + RingSettingsResponse: + properties: + auto_cancel_timeout_ms: + format: int32 + type: integer + x-stream-index: "002" + incoming_call_timeout_ms: + format: int32 + type: integer + x-stream-index: "001" + missed_call_timeout_ms: + format: int32 + type: integer + x-stream-index: "003" + required: + - incoming_call_timeout_ms + - auto_cancel_timeout_ms + - missed_call_timeout_ms + type: object + RuleBuilderAction: + properties: + ban_options: + $ref: '#/components/schemas/BanOptions' + x-stream-index: "002" + flag_content_options: + $ref: '#/components/schemas/FlagContentOptions' + x-stream-index: "004" + flag_user_options: + $ref: '#/components/schemas/FlagUserOptions' + x-stream-index: "003" + remove_content_options: + $ref: '#/components/schemas/BlockContentOptions' + x-stream-index: "005" + type: + type: string + x-stream-index: "001" + type: object + RuleBuilderCondition: + properties: + confidence: + format: float + type: number + x-stream-index: "002" + content_count_rule_params: + $ref: '#/components/schemas/ContentCountRuleParameters' + x-stream-index: "007" + image_content_params: + $ref: '#/components/schemas/ImageContentParameters' + x-stream-index: "009" + image_rule_params: + $ref: '#/components/schemas/ImageRuleParameters' + x-stream-index: "004" + text_content_params: + $ref: '#/components/schemas/TextContentParameters' + x-stream-index: "008" + text_rule_params: + $ref: '#/components/schemas/TextRuleParameters' + x-stream-index: "003" + type: + type: string + x-stream-index: "001" + user_created_within_params: + $ref: '#/components/schemas/UserCreatedWithinParameters' + x-stream-index: "011" + user_custom_property_params: + $ref: '#/components/schemas/UserCustomPropertyParameters' + x-stream-index: "012" + user_rule_params: + $ref: '#/components/schemas/UserRuleParameters' + x-stream-index: "006" + video_content_params: + $ref: '#/components/schemas/VideoContentParameters' + x-stream-index: "010" + video_rule_params: + $ref: '#/components/schemas/VideoRuleParameters' + x-stream-index: "005" + type: object + RuleBuilderConditionGroup: + properties: + conditions: + items: + $ref: '#/components/schemas/RuleBuilderCondition' + type: array + x-stream-index: "002" + logic: + type: string + x-stream-index: "001" + type: object + RuleBuilderConfig: + properties: + async: + type: boolean + x-stream-index: "001" + rules: + items: + $ref: '#/components/schemas/RuleBuilderRule' + type: array + x-stream-index: "002" + type: object + RuleBuilderRule: + properties: + action: + $ref: '#/components/schemas/RuleBuilderAction' + x-stream-index: "006" + conditions: + items: + $ref: '#/components/schemas/RuleBuilderCondition' + type: array + x-stream-index: "003" + cooldown_period: + type: string + x-stream-index: "007" + groups: + items: + $ref: '#/components/schemas/RuleBuilderConditionGroup' + type: array + x-stream-index: "005" + id: + type: string + x-stream-index: "001" + logic: + type: string + x-stream-index: "004" + rule_type: + type: string + x-stream-index: "002" + required: + - rule_type + - action + type: object + SFUIDLastSeen: + properties: + id: + type: string + x-stream-index: "001.001" + last_seen: + format: date-time + type: number + x-stream-index: "002" + process_start_time: + format: int64 + type: integer + x-stream-index: "001.002" + required: + - id + - process_start_time + - last_seen + type: object + STTEgressConfig: + properties: + closed_captions_enabled: + type: boolean + x-stream-index: "005" + external_storage: + $ref: '#/components/schemas/ExternalStorage' + x-stream-index: "011" + language: + type: string + x-stream-index: "008" + storage_name: + type: string + x-stream-index: "010" + translation_languages: + items: + type: string + type: array + x-stream-index: "009" + translations_enabled: + type: boolean + x-stream-index: "006" + upload_transcriptions: + type: boolean + x-stream-index: "004" + whisper_server_base_url: + type: string + x-stream-index: "007" + type: object + ScreensharingSettings: + properties: + access_request_enabled: + type: boolean + x-stream-index: "002" + enabled: + type: boolean + x-stream-index: "001" + target_resolution: + $ref: '#/components/schemas/TargetResolution' + x-stream-index: "003" + required: + - enabled + - access_request_enabled + type: object + ScreensharingSettingsResponse: + properties: + access_request_enabled: + type: boolean + x-stream-index: "002" + enabled: + type: boolean + x-stream-index: "001" + target_resolution: + $ref: '#/components/schemas/TargetResolution' + x-stream-index: "003" + required: + - enabled + - access_request_enabled + type: object + SessionSettings: + properties: + inactivity_timeout_seconds: + format: int32 + maximum: 900 + minimum: 5 + type: integer + x-stream-index: "001" + required: + - inactivity_timeout_seconds + type: object + SessionSettingsResponse: + properties: + inactivity_timeout_seconds: + format: int32 + maximum: 900 + minimum: 5 + type: integer + x-stream-index: "001" + required: + - inactivity_timeout_seconds + type: object + ShadowBlockActionRequest: + type: object + SharedLocation: + properties: + channel: + $ref: '#/components/schemas/Channel' + x-stream-index: "013" + channel_cid: + type: string + x-stream-index: "003" + created_at: + format: date-time + type: number + x-stream-index: "010" + created_by_device_id: + type: string + x-stream-index: "008" + end_at: + format: date-time + type: number + x-stream-index: "009" + latitude: + format: float + maximum: 90 + minimum: 1.8446744073709552e+19 + type: number + x-stream-index: "006" + longitude: + format: float + maximum: 180 + minimum: 1.8446744073709552e+19 + type: number + x-stream-index: "007" + message: + $ref: '#/components/schemas/Message' + x-stream-index: "012" + message_id: + type: string + x-stream-index: "004" + updated_at: + format: date-time + type: number + x-stream-index: "011" + user_id: + type: string + x-stream-index: "005" + required: + - channel_cid + - message_id + - user_id + - created_by_device_id + - created_at + - updated_at + type: object + SharedLocationResponse: + nullable: true + properties: + channel: + $ref: '#/components/schemas/ChannelResponse' + x-stream-index: "001.011" + channel_cid: + description: Channel CID + title: string + type: string + x-stream-index: "001.001" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: "001.008" + created_by_device_id: + description: Device ID that created the live location + title: string + type: string + x-stream-index: "001.006" + duration: + type: string + x-stream-index: "002.001" + end_at: + description: Time when the live location expires + format: date-time + title: string + type: number + x-stream-index: "001.007" + latitude: + description: Latitude coordinate + format: float + title: number + type: number + x-stream-index: "001.004" + longitude: + description: Longitude coordinate + format: float + title: number + type: number + x-stream-index: "001.005" + message: + $ref: '#/components/schemas/MessageResponse' + x-stream-index: "001.010" + message_id: + description: Message ID + title: string + type: string + x-stream-index: "001.002" + updated_at: + description: Date/time of the last update + format: date-time + title: Updated at + type: number + x-stream-index: "001.009" + user_id: + description: User ID + title: string + type: string + x-stream-index: "001.003" + required: + - channel_cid + - message_id + - user_id + - latitude + - longitude + - created_by_device_id + - created_at + - updated_at + - duration + type: object + SharedLocationResponseData: + nullable: true + properties: + channel: + $ref: '#/components/schemas/ChannelResponse' + x-stream-index: "011" + channel_cid: + type: string + x-stream-index: "001" + created_at: + format: date-time + type: number + x-stream-index: "008" + created_by_device_id: + type: string + x-stream-index: "006" + end_at: + format: date-time + type: number + x-stream-index: "007" + latitude: + format: float + type: number + x-stream-index: "004" + longitude: + format: float + type: number + x-stream-index: "005" + message: + $ref: '#/components/schemas/MessageResponse' + x-stream-index: "010" + message_id: + type: string + x-stream-index: "002" + updated_at: + format: date-time + type: number + x-stream-index: "009" + user_id: + type: string + x-stream-index: "003" + required: + - channel_cid + - message_id + - user_id + - latitude + - longitude + - created_by_device_id + - created_at + - updated_at + type: object + SharedLocationsResponse: + nullable: true + properties: + active_live_locations: + items: + $ref: '#/components/schemas/SharedLocationResponseData' + type: array + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - active_live_locations + - duration + type: object + SingleFollowResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + follow: + $ref: '#/components/schemas/FollowResponse' + description: The created follow relationship + title: Follow + x-stream-index: "001" + required: + - follow + - duration + title: Follow Response + type: object + SortParam: + nullable: true + properties: + direction: + format: int32 + type: integer + x-stream-index: "002" + field: + type: string + x-stream-index: "001" + required: + - field + - direction + type: object + SortParamRequest: + nullable: true + properties: + direction: + description: Direction of sorting, 1 for Ascending, -1 for Descending, default + is 1 + format: int32 + title: Direction + type: integer + x-stream-index: "002" + field: + description: Name of field to sort by + title: Field + type: string + x-stream-index: "001" + type: object + StoriesConfig: + properties: + expiration_behaviour: + enum: + - hide_for_everyone + - visible_for_author + type: string + x-stream-index: "001" + skip_watched: + type: boolean + x-stream-index: "002" + type: object + SubmitActionRequest: + nullable: true + properties: + action_type: + description: Type of moderation action to perform (mark_reviewed, delete_message, + etc.) + enum: + - mark_reviewed + - delete_message + - delete_activity + - delete_reaction + - ban + - custom + - unban + - restore + - delete_user + - unblock + - shadow_block + - unmask + - kick_user + - end_call + title: Action Type + type: string + x-stream-index: "002" + ban: + $ref: '#/components/schemas/BanActionRequest' + description: Configuration for ban action + title: Ban + x-stream-index: "008" + custom: + $ref: '#/components/schemas/CustomActionRequest' + description: Configuration for custom action + title: Custom + x-stream-index: "009" + delete_activity: + $ref: '#/components/schemas/DeleteActivityRequest' + description: Configuration for activity deletion action + title: Delete Activity + x-stream-index: "004" + delete_message: + $ref: '#/components/schemas/DeleteMessageRequest' + description: Configuration for message deletion action + title: Delete Message + x-stream-index: "003" + delete_reaction: + $ref: '#/components/schemas/DeleteReactionRequest' + description: Configuration for reaction deletion action + title: Delete Reaction + x-stream-index: "005" + delete_user: + $ref: '#/components/schemas/DeleteUserRequest' + description: Configuration for user deletion action + title: Delete User + x-stream-index: "006" + item_id: + description: UUID of the review queue item to act on + title: Item ID + type: string + x-stream-index: "001" + mark_reviewed: + $ref: '#/components/schemas/MarkReviewedRequest' + description: Configuration for marking item as reviewed + title: Mark Reviewed + x-stream-index: "007" + unban: + $ref: '#/components/schemas/UnbanActionRequest' + description: Configuration for unban action + title: Unban + x-stream-index: "010" + required: + - item_id + - action_type + type: object + SubmitActionResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + item: + $ref: '#/components/schemas/ReviewQueueItemResponse' + description: Updated review queue item after action was performed + title: Item + x-stream-index: "001" + required: + - duration + type: object + TargetResolution: + properties: + bitrate: + format: int32 + maximum: 6000000 + type: integer + x-stream-index: "003" + height: + format: int32 + maximum: 3840 + minimum: 240 + type: integer + x-stream-index: "002" + width: + format: int32 + maximum: 3840 + minimum: 240 + type: integer + x-stream-index: "001" + required: + - width + - height + - bitrate + type: object + TextContentParameters: + properties: + blocklist_match: + items: + type: string + type: array + x-stream-index: "005" + contains_url: + type: boolean + x-stream-index: "003" + harm_labels: + items: + type: string + type: array + x-stream-index: "001" + llm_harm_labels: + additionalProperties: + type: string + type: object + x-stream-index: "002" + severity: + type: string + x-stream-index: "004" + type: object + TextRuleParameters: + properties: + blocklist_match: + items: + type: string + type: array + x-stream-index: "007" + contains_url: + type: boolean + x-stream-index: "005" + harm_labels: + items: + type: string + type: array + x-stream-index: "003" + llm_harm_labels: + additionalProperties: + type: string + type: object + x-stream-index: "004" + severity: + type: string + x-stream-index: "006" + threshold: + format: int32 + type: integer + x-stream-index: "001" + time_window: + type: string + x-stream-index: "002" + type: object + ThreadedCommentResponse: + description: A comment with an optional, depth‑limited slice of nested replies. + properties: + attachments: + items: + $ref: '#/components/schemas/Attachment' + type: array + x-stream-index: "001.011" + confidence_score: + format: float + type: number + x-stream-index: "001.022" + controversy_score: + format: float + type: number + x-stream-index: "001.023" + created_at: + format: date-time + type: number + x-stream-index: "001.014" + custom: + additionalProperties: {} + type: object + x-stream-index: "001.006" + deleted_at: + format: date-time + type: number + x-stream-index: "001.016" + downvote_count: + format: int32 + type: integer + x-stream-index: "001.020" + id: + type: string + x-stream-index: "001.001" + latest_reactions: + items: + $ref: '#/components/schemas/FeedsReactionResponse' + type: array + x-stream-index: "001.009" + mentioned_users: + items: + $ref: '#/components/schemas/UserResponse' + type: array + x-stream-index: "001.012" + meta: + $ref: '#/components/schemas/RepliesMeta' + description: Pagination & depth info for this node's direct replies. + title: Replies Meta + x-stream-index: "002" + moderation: + $ref: '#/components/schemas/ModerationV2Response' + x-stream-index: "001.017" + object_id: + type: string + x-stream-index: "001.002" + object_type: + type: string + x-stream-index: "001.003" + own_reactions: + items: + $ref: '#/components/schemas/FeedsReactionResponse' + type: array + x-stream-index: "001.024" + parent_id: + type: string + x-stream-index: "001.007" + reaction_count: + format: int32 + type: integer + x-stream-index: "001.008" + reaction_groups: + additionalProperties: + $ref: '#/components/schemas/ReactionGroupResponse' + type: object + x-stream-index: "001.010" + replies: + description: Slice of nested comments (may be empty). + items: + $ref: '#/components/schemas/ThreadedCommentResponse' + title: Replies + type: array + x-stream-index: "003" + reply_count: + format: int32 + type: integer + x-stream-index: "001.018" + score: + format: int32 + type: integer + x-stream-index: "001.021" + status: + type: string + x-stream-index: "001.013" + text: + type: string + x-stream-index: "001.005" + updated_at: + format: date-time + type: number + x-stream-index: "001.015" + upvote_count: + format: int32 + type: integer + x-stream-index: "001.019" + user: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "001.004" + required: + - id + - object_id + - object_type + - user + - reaction_count + - mentioned_users + - status + - created_at + - updated_at + - reply_count + - upvote_count + - downvote_count + - score + - confidence_score + - own_reactions + title: Threaded Comment + type: object + Thresholds: + description: Sets thresholds for AI moderation + properties: + explicit: + $ref: '#/components/schemas/LabelThresholds' + description: Thresholds for explicit messages + title: LabelThresholds + x-stream-index: "001" + spam: + $ref: '#/components/schemas/LabelThresholds' + description: Thresholds for spam + title: LabelThresholds + x-stream-index: "002" + toxic: + $ref: '#/components/schemas/LabelThresholds' + description: Thresholds for toxic messages + title: LabelThresholds + x-stream-index: "003" + title: Auto moderation thresholds + type: object + ThumbnailResponse: + properties: + image_url: + type: string + x-stream-index: "001" + required: + - image_url + type: object + ThumbnailsSettings: + properties: + enabled: + type: boolean + x-stream-index: "001" + required: + - enabled + type: object + ThumbnailsSettingsResponse: + properties: + enabled: + type: boolean + x-stream-index: "001" + required: + - enabled + type: object + Time: + type: object + TranscriptionSettings: + properties: + closed_caption_mode: + enum: + - available + - disabled + - auto-on + title: Mode + type: string + x-stream-index: "002" + language: + description: The language used in this call as a two letter code + enum: + - auto + - en + - fr + - es + - de + - it + - nl + - pt + - pl + - ca + - cs + - da + - el + - fi + - id + - ja + - ru + - sv + - ta + - th + - tr + - hu + - ro + - zh + - ar + - tl + - he + - hi + - hr + - ko + - ms + - "no" + - uk + - bg + - et + - sl + - sk + title: Language + type: string + x-stream-index: "004" + mode: + enum: + - available + - disabled + - auto-on + title: Mode + type: string + x-stream-index: "001" + required: + - mode + - closed_caption_mode + - languages + - language + type: object + TranscriptionSettingsResponse: + properties: + closed_caption_mode: + enum: + - available + - disabled + - auto-on + type: string + x-stream-index: "002" + language: + enum: + - auto + - en + - fr + - es + - de + - it + - nl + - pt + - pl + - ca + - cs + - da + - el + - fi + - id + - ja + - ru + - sv + - ta + - th + - tr + - hu + - ro + - zh + - ar + - tl + - he + - hi + - hr + - ko + - ms + - "no" + - uk + - bg + - et + - sl + - sk + type: string + x-stream-index: "004" + mode: + enum: + - available + - disabled + - auto-on + type: string + x-stream-index: "001" + required: + - mode + - closed_caption_mode + - languages + - language + type: object + TypingIndicators: + properties: + enabled: + type: boolean + x-stream-index: "001" + required: + - enabled + type: object + TypingIndicatorsResponse: + properties: + enabled: + type: boolean + x-stream-index: "001" + required: + - enabled + type: object + UnbanActionRequest: + type: object + UnblockActionRequest: + type: object + UnblockUsersRequest: + nullable: true + properties: + blocked_user_id: + type: string + x-stream-index: "001" + required: + - blocked_user_id + type: object + UnblockUsersResponse: + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "001.001" + required: + - duration + type: object + UnfollowResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + follow: + $ref: '#/components/schemas/FollowResponse' + description: The deleted follow relationship + title: Follow + x-stream-index: "001" + required: + - follow + - duration + title: Unfollow Response + type: object + UnpinActivityResponse: + nullable: true + properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + description: The unpinned activity + title: Activity + x-stream-index: "001" + duration: + type: string + x-stream-index: "004.001" + feed: + description: Fully qualified ID of the feed the activity was unpinned from + title: Feed ID + type: string + x-stream-index: "002" + user_id: + description: ID of the user who unpinned the activity + title: User ID + type: string + x-stream-index: "003" + required: + - activity + - feed + - user_id + - duration + title: Unpin Activity Response + type: object + UpdateActivityPartialRequest: + nullable: true + properties: + set: + additionalProperties: {} + description: Map of dot-notation field paths to new values + title: object + type: object + x-stream-index: "002" + unset: + description: List of dot-notation paths to remove + items: + type: string + title: '[]string' + type: array + x-stream-index: "003" + type: object + UpdateActivityPartialResponse: + nullable: true + properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + description: The updated activity + title: ActivityResponse + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - activity + - duration + type: object + UpdateActivityRequest: + nullable: true + properties: + attachments: + description: List of attachments for the activity + items: + $ref: '#/components/schemas/Attachment' + title: '[]ActivityAttachment' + type: array + x-stream-index: "003" + custom: + additionalProperties: {} + description: Custom data for the activity + title: object + type: object + x-stream-index: "004" + expires_at: + description: Time when the activity will expire + format: date-time + title: string + type: number + x-stream-index: "007" + filter_tags: + description: Tags used for filtering the activity + items: + type: string + title: '[]string' + type: array + x-stream-index: "008" + interest_tags: + description: Tags indicating interest categories + items: + type: string + title: '[]string' + type: array + x-stream-index: "009" + location: + $ref: '#/components/schemas/ActivityLocation' + description: Geographic location for the activity + title: ActivityLocation + x-stream-index: "006" + poll_id: + description: Poll ID + title: string + type: string + x-stream-index: "010" + text: + description: The text content of the activity + title: string + type: string + x-stream-index: "002" + visibility: + description: Visibility setting for the activity + title: string + type: string + x-stream-index: "005" + type: object + UpdateActivityResponse: + nullable: true + properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + description: The updated activity + title: ActivityResponse + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - activity + - duration + type: object + UpdateBlockListRequest: + nullable: true + properties: + team: + type: string + x-stream-index: "002" + words: + description: List of words to block + items: + type: string + minimum: 1 + title: Words + type: array + x-stream-index: "003" + title: Update block list + type: object + x-stream-docs-page-id: update_block_list + UpdateBlockListResponse: + description: Basic response information + nullable: true + properties: + blocklist: + $ref: '#/components/schemas/BlockListResponse' + x-stream-index: "001" + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "002.001" + required: + - duration + title: Response + type: object + UpdateBookmarkFolderRequest: + nullable: true + properties: + custom: + additionalProperties: {} + description: Custom data for the folder + title: Custom Data + type: object + x-stream-index: "003" + name: + description: Name of the folder + maxLength: 255 + title: Name + type: string + x-stream-index: "002" + title: Update Bookmark Folder Request + type: object + UpdateBookmarkFolderResponse: + nullable: true + properties: + bookmark_folder: + $ref: '#/components/schemas/BookmarkFolderResponse' + description: The updated bookmark folder + title: Bookmark Folder + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - bookmark_folder + - duration + title: Update Bookmark Folder Response + type: object + UpdateBookmarkRequest: + nullable: true + properties: + custom: + additionalProperties: {} + description: Custom data for the bookmark + title: Custom Data + type: object + x-stream-index: "005" + folder_id: + description: ID of the folder to move the bookmark to + maxLength: 255 + title: Folder ID + type: string + x-stream-index: "002" + new_folder: + $ref: '#/components/schemas/AddFolderRequest' + x-stream-index: "004" + new_folder_id: + maxLength: 255 + type: string + x-stream-index: "003" + title: Update Bookmark Request + type: object + UpdateBookmarkResponse: + nullable: true + properties: + bookmark: + $ref: '#/components/schemas/BookmarkResponse' + description: The updated bookmark + title: Bookmark + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - bookmark + - duration + title: Update Bookmark Response + type: object + UpdateCommentRequest: + nullable: true + properties: + comment: + description: Updated text content of the comment + title: Comment + type: string + x-stream-index: "002" + custom: + additionalProperties: {} + description: Updated custom data for the comment + title: Custom Data + type: object + x-stream-index: "003" + skip_push: + type: boolean + x-stream-index: "004" + title: Update Comment Request + type: object + UpdateCommentResponse: + nullable: true + properties: + comment: + $ref: '#/components/schemas/CommentResponse' + description: The updated comment + title: Comment + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - comment + - duration + title: Update Comment Response + type: object + UpdateFeedMembersRequest: + nullable: true + properties: + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "006.001" + members: + description: List of members to upsert, remove, or set + items: + $ref: '#/components/schemas/FeedMemberRequest' + title: Members + type: array + x-stream-index: "004" + next: + type: string + x-stream-index: "006.002" + operation: + description: Type of update operation to perform + enum: + - upsert + - remove + - set + title: Operation + type: string + x-stream-index: "003" + prev: + type: string + x-stream-index: "006.003" + required: + - operation + title: Update Feed Members Request + type: object + UpdateFeedMembersResponse: + description: Basic response information + nullable: true + properties: + added: + items: + $ref: '#/components/schemas/FeedMemberResponse' + type: array + x-stream-index: "001" + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "004.001" + removed_ids: + items: + type: string + type: array + x-stream-index: "003" + updated: + items: + $ref: '#/components/schemas/FeedMemberResponse' + type: array + x-stream-index: "002" + required: + - added + - updated + - removed_ids + - duration + title: Response + type: object + UpdateFeedRequest: + nullable: true + properties: + custom: + additionalProperties: {} + description: Custom data for the feed + title: Custom Data + type: object + x-stream-index: "004" + title: Update Feed Request + type: object + UpdateFeedResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + feed: + $ref: '#/components/schemas/FeedResponse' + description: The updated feed + title: Feed + x-stream-index: "001" + required: + - feed + - duration + title: Update Feed Response + type: object + UpdateFollowRequest: + nullable: true + properties: + create_notification_activity: + description: Whether to create a notification activity for this follow + title: Create Notification Activity + type: boolean + x-stream-index: "001.004" + custom: + additionalProperties: {} + description: Custom data for the follow relationship + title: Custom Data + type: object + x-stream-index: "001.002" + follower_role: + type: string + x-stream-index: "002" + push_preference: + description: Push preference for the follow relationship + enum: + - all + - none + title: Push Preference + type: string + x-stream-index: "001.003" + skip_push: + type: boolean + x-stream-index: "001.005" + source: + description: Fully qualified ID of the source feed + maxLength: 255 + title: Source Feed + type: string + x-stream-index: 001.001.001 + target: + description: Fully qualified ID of the target feed + maxLength: 255 + title: Target Feed + type: string + x-stream-index: 001.001.002 + required: + - source + - target + title: Update Follow Request + type: object + UpdateFollowResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + follow: + $ref: '#/components/schemas/FollowResponse' + description: Details of the updated follow relationship + title: Follow + x-stream-index: "001" + required: + - follow + - duration + title: Update Follow Response + type: object + UpdateLiveLocationRequest: + nullable: true + properties: + end_at: + description: Time when the live location expires + format: date-time + title: string + type: number + x-stream-index: "004" + latitude: + description: Latitude coordinate + format: float + maximum: 90 + minimum: 1.8446744073709552e+19 + title: number + type: number + x-stream-index: "002" + longitude: + description: Longitude coordinate + format: float + maximum: 180 + minimum: 1.8446744073709552e+19 + title: number + type: number + x-stream-index: "003" + message_id: + description: Live location ID + title: string + type: string + x-stream-index: "001" + required: + - message_id + type: object + UpdatePollOptionRequest: + nullable: true + properties: + Custom: + additionalProperties: {} + type: object + writeOnly: true + x-stream-index: "004" + id: + description: Option ID + maxLength: 255 + title: string + type: string + x-stream-index: "002" + text: + description: Option text + title: string + type: string + x-stream-index: "003" + required: + - id + - text + type: object + UpdatePollPartialRequest: + nullable: true + properties: + set: + additionalProperties: {} + description: Sets new field values + title: Set + type: object + x-stream-index: "002.001" + x-stream-map: + description: New value to set + key: field + title: Value + unset: + description: Array of field names to unset + items: + type: string + title: Unset + type: array + x-stream-index: "002.002" + type: object + UpdatePollRequest: + nullable: true + properties: + Custom: + additionalProperties: {} + type: object + writeOnly: true + x-stream-index: "011" + allow_answers: + description: Allow answers + title: boolean + type: boolean + x-stream-index: "009" + allow_user_suggested_options: + description: Allow user suggested options + title: boolean + type: boolean + x-stream-index: "008" + description: + description: Poll description + title: string + type: string + x-stream-index: "003" + enforce_unique_vote: + description: Enforce unique vote + title: boolean + type: boolean + x-stream-index: "005" + id: + description: Poll ID + maxLength: 255 + title: string + type: string + x-stream-index: "001" + is_closed: + description: Is closed + title: boolean + type: boolean + x-stream-index: "010" + max_votes_allowed: + description: Max votes allowed + format: int32 + maximum: 10 + title: integer + type: integer + x-stream-index: "007" + name: + description: Poll name + title: string + type: string + x-stream-index: "002" + options: + description: Poll options + items: + $ref: '#/components/schemas/PollOptionRequest' + maximum: 100 + title: PollOptions + type: array + x-stream-index: "004" + voting_visibility: + description: Voting visibility + enum: + - anonymous + - public + title: string + type: string + x-stream-index: "006" + required: + - id + - name + type: object + UpdateUserPartialRequest: + properties: + id: + description: User ID to update + title: ID + type: string + x-stream-index: "001" + set: + additionalProperties: {} + type: object + x-stream-index: "002.001" + unset: + items: + type: string + type: array + x-stream-index: "002.002" + required: + - id + type: object + UpdateUsersPartialRequest: + nullable: true + properties: + users: + items: + $ref: '#/components/schemas/UpdateUserPartialRequest' + maximum: 100 + type: array + x-stream-index: "001" + required: + - users + type: object + UpdateUsersRequest: + nullable: true + properties: + users: + additionalProperties: + $ref: '#/components/schemas/UserRequest' + description: Object containing users + title: Users + type: object + x-stream-index: "001" + x-stream-map: + key: user_id + required: + - users + type: object + UpdateUsersResponse: + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "003.001" + membership_deletion_task_id: + type: string + x-stream-index: "002" + users: + additionalProperties: + $ref: '#/components/schemas/FullUserResponse' + description: Object containing users + title: Users + type: object + x-stream-index: "001" + x-stream-map: + key: user_id + required: + - users + - membership_deletion_task_id + - duration + type: object + UpsertActivitiesRequest: + nullable: true + properties: + activities: + description: List of activities to create or update + items: + $ref: '#/components/schemas/ActivityRequest' + maximum: 100 + minimum: 1 + title: Activities + type: array + x-stream-index: "001" + required: + - activities + title: Upsert Activities Request + type: object + UpsertActivitiesResponse: + nullable: true + properties: + activities: + description: List of created or updated activities + items: + $ref: '#/components/schemas/ActivityResponse' + title: Activities + type: array + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - activities + - duration + title: Upsert Activities Response + type: object + UpsertConfigRequest: + nullable: true + properties: + ai_image_config: + $ref: '#/components/schemas/AIImageConfig' + description: Configuration for AI image analysis + title: AI Image Config + x-stream-index: "011" + ai_text_config: + $ref: '#/components/schemas/AITextConfig' + description: Configuration for AI text analysis + title: AI Text Config + x-stream-index: "008" + ai_video_config: + $ref: '#/components/schemas/AIVideoConfig' + description: Configuration for AI video analysis + title: AI Video Config + x-stream-index: "012" + async: + description: Whether moderation should be performed asynchronously + title: Async + type: boolean + x-stream-index: "003" + automod_platform_circumvention_config: + $ref: '#/components/schemas/AutomodPlatformCircumventionConfig' + description: Configuration for platform circumvention detection + title: Automod Platform Circumvention Config + x-stream-index: "005" + automod_semantic_filters_config: + $ref: '#/components/schemas/AutomodSemanticFiltersConfig' + description: Configuration for semantic filtering + title: Automod Semantic Filters Config + x-stream-index: "006" + automod_toxicity_config: + $ref: '#/components/schemas/AutomodToxicityConfig' + description: Configuration for toxicity detection + title: Automod Toxicity Config + x-stream-index: "004" + aws_rekognition_config: + $ref: '#/components/schemas/AIImageConfig' + x-stream-index: "016" + block_list_config: + $ref: '#/components/schemas/BlockListConfig' + description: Configuration for block list filtering + title: Block List Config + x-stream-index: "007" + bodyguard_config: + $ref: '#/components/schemas/AITextConfig' + x-stream-index: "015" + google_vision_config: + $ref: '#/components/schemas/GoogleVisionConfig' + description: Configuration for Google Vision integration + title: Google Vision Config + x-stream-index: "010" + key: + description: Unique identifier for the moderation configuration + title: Key + type: string + x-stream-index: "001" + llm_config: + $ref: '#/components/schemas/LLMConfig' + description: Configuration for customer-configured LLM moderation + title: LLM Config + x-stream-index: "009" + rule_builder_config: + $ref: '#/components/schemas/RuleBuilderConfig' + description: Configuration for custom rule builder (max 3 rules, max 5 conditions + per rule) + title: Rule Builder Config + x-stream-index: "014" + team: + description: Team associated with the configuration + maxLength: 128 + minLength: 1 + title: Team + type: string + x-stream-index: "002" + velocity_filter_config: + $ref: '#/components/schemas/VelocityFilterConfig' + description: Configuration for velocity-based filtering + title: Velocity Filter Config + x-stream-index: "013" + video_call_rule_config: + $ref: '#/components/schemas/VideoCallRuleConfig' + x-stream-index: "017" + required: + - key + type: object + UpsertConfigResponse: + nullable: true + properties: + config: + $ref: '#/components/schemas/ConfigResponse' + description: The created or updated moderation configuration + title: Config + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - duration + type: object + User: + properties: + avg_response_time: + format: int32 + readOnly: true + type: integer + x-stream-index: "046" + ban_expires: + format: date-time + type: number + x-stream-index: "017" + banned: + type: boolean + x-stream-index: "016" + created_at: + format: date-time + readOnly: true + type: number + x-stream-index: "008" + custom: + additionalProperties: {} + type: object + x-stream-index: "006" + deactivated_at: + format: date-time + readOnly: true + type: number + x-stream-index: "014" + deleted_at: + format: date-time + readOnly: true + type: number + x-stream-index: "013" + id: + type: string + x-stream-index: "003" + invisible: + type: boolean + x-stream-index: "023" + language: + type: string + x-stream-index: "035" + last_active: + format: date-time + readOnly: true + type: number + x-stream-index: "011" + last_engaged_at: + format: date-time + readOnly: true + type: number + x-stream-index: "012" + online: + readOnly: true + type: boolean + x-stream-index: "022" + privacy_settings: + $ref: '#/components/schemas/PrivacySettings' + x-stream-index: "026" + revoke_tokens_issued_before: + format: date-time + type: number + x-stream-index: "042" + role: + type: string + x-stream-index: "004" + teams: + items: + type: string + type: array + x-stream-index: "036" + teams_role: + additionalProperties: + type: string + type: object + x-stream-index: "005" + updated_at: + format: date-time + readOnly: true + type: number + x-stream-index: "009" + required: + - id + - role + - teams_role + - custom + - banned + - online + type: object + UserBannedEvent: + properties: + channel_id: + type: string + x-stream-index: "006.002" + channel_type: + type: string + x-stream-index: "006.003" + cid: + type: string + x-stream-index: "006.001" + created_at: + format: date-time + type: number + x-stream-index: "008.002" + created_by: + $ref: '#/components/schemas/User' + x-stream-index: "001" + expiration: + format: date-time + type: number + x-stream-index: "003" + reason: + type: string + x-stream-index: "004" + shadow: + type: boolean + x-stream-index: "002" + team: + type: string + x-stream-index: "005.001" + type: + default: user.banned + type: string + x-stream-index: "008.001" + user: + $ref: '#/components/schemas/User' + x-stream-index: "007.001" + required: + - created_by + - shadow + - cid + - channel_id + - channel_type + - type + - created_at + title: UserBannedEvent + 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 + UserCreatedWithinParameters: + properties: + max_age: + type: string + x-stream-index: "001" + type: object + UserCustomPropertyParameters: + properties: + operator: + type: string + x-stream-index: "002" + property_key: + type: string + x-stream-index: "001" + type: object + UserDeactivatedEvent: + properties: + created_at: + format: date-time + type: number + x-stream-index: "003.002" + created_by: + $ref: '#/components/schemas/User' + x-stream-index: "001" + type: + default: user.deactivated + type: string + x-stream-index: "003.001" + user: + $ref: '#/components/schemas/User' + x-stream-index: "002.001" + required: + - created_by + - type + - created_at + title: UserDeactivatedEvent + 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 + UserMute: + nullable: true + properties: + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: "009" + expires: + description: Date/time of mute expiration + format: date-time + title: Expires + type: number + x-stream-index: "008" + target: + $ref: '#/components/schemas/User' + description: User who's muted + title: Target + x-stream-index: "007" + updated_at: + description: Date/time of the last update + format: date-time + title: Updated at + type: number + x-stream-index: "010" + user: + $ref: '#/components/schemas/User' + description: Owner of channel mute + title: User + x-stream-index: "005" + required: + - created_at + - updated_at + type: object + UserMuteResponse: + nullable: true + properties: + created_at: + format: date-time + type: number + x-stream-index: "004" + expires: + format: date-time + type: number + x-stream-index: "003" + target: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "002" + updated_at: + format: date-time + type: number + x-stream-index: "005" + user: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "001" + required: + - created_at + - updated_at + type: object + UserMutedEvent: + properties: + created_at: + format: date-time + type: number + x-stream-index: "004.002" + target_user: + type: string + x-stream-index: "001" + target_users: + items: + type: string + type: array + x-stream-index: "002" + type: + default: user.muted + type: string + x-stream-index: "004.001" + user: + $ref: '#/components/schemas/User' + x-stream-index: "003.001" + required: + - type + - created_at + title: UserMutedEvent + 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 + UserReactivatedEvent: + properties: + created_at: + format: date-time + type: number + x-stream-index: "002.002" + type: + default: user.reactivated + type: string + x-stream-index: "002.001" + user: + $ref: '#/components/schemas/User' + x-stream-index: "001" + required: + - type + - created_at + title: UserReactivatedEvent + 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 + UserRequest: + description: User request object + properties: + custom: + additionalProperties: {} + description: Custom user data + title: Custom + type: object + x-stream-index: "004" + id: + description: User ID + title: ID + type: string + x-stream-index: "001" + image: + description: User's profile image URL + title: Image + type: string + x-stream-index: "003" + invisible: + type: boolean + x-stream-index: "006" + language: + type: string + x-stream-index: "005" + name: + description: Optional name of user + title: Name + type: string + x-stream-index: "002" + privacy_settings: + $ref: '#/components/schemas/PrivacySettingsResponse' + x-stream-index: "007" + required: + - id + title: UserRequest + type: object + UserResponse: + description: User response object + properties: + avg_response_time: + format: int32 + type: integer + x-stream-index: "001.018" + banned: + description: Whether a user is banned or not + title: Banned + type: boolean + x-stream-index: "001.012" + blocked_user_ids: + items: + type: string + type: array + x-stream-index: "001.017" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: "001.009" + custom: + additionalProperties: {} + description: Custom data for this object + title: Custom data + type: object + x-stream-index: "001.004" + deactivated_at: + description: Date of deactivation + format: date-time + title: Deactivated at + type: number + x-stream-index: "001.016" + deleted_at: + description: Date/time of deletion + format: date-time + title: Deleted at + type: number + x-stream-index: "001.011" + id: + description: Unique user identifier + title: ID + type: string + x-stream-index: "001.001" + image: + title: Image + type: string + x-stream-index: "001.003" + language: + description: Preferred language of a user + title: Language + type: string + x-stream-index: "001.005" + last_active: + description: Date of last activity + format: date-time + title: Last active + type: number + x-stream-index: "001.014" + name: + description: Optional name of user + title: Name + type: string + x-stream-index: "001.002" + online: + description: Whether a user online or not + title: Online + type: boolean + x-stream-index: "001.013" + revoke_tokens_issued_before: + description: Revocation date for tokens + format: date-time + title: Revoke tokens issued before + type: number + x-stream-index: "001.015" + role: + description: Determines the set of user permissions + title: Role + type: string + x-stream-index: "001.006" + teams: + description: List of teams user is a part of + items: + type: string + title: Teams + type: array + x-stream-index: "001.007" + teams_role: + additionalProperties: + type: string + type: object + x-stream-index: "001.008" + updated_at: + description: Date/time of the last update + format: date-time + title: Updated at + type: number + x-stream-index: "001.010" + required: + - id + - custom + - language + - role + - teams + - created_at + - updated_at + - banned + - online + - blocked_user_ids + - shadow_banned + - invisible + title: UserResponse + type: object + UserResponseCommonFields: + properties: + avg_response_time: + format: int32 + type: integer + x-stream-index: "018" + banned: + type: boolean + x-stream-index: "012" + blocked_user_ids: + items: + type: string + type: array + x-stream-index: "017" + created_at: + format: date-time + type: number + x-stream-index: "009" + custom: + additionalProperties: {} + type: object + x-stream-index: "004" + deactivated_at: + format: date-time + type: number + x-stream-index: "016" + deleted_at: + format: date-time + type: number + x-stream-index: "011" + id: + type: string + x-stream-index: "001" + image: + type: string + x-stream-index: "003" + language: + type: string + x-stream-index: "005" + last_active: + format: date-time + type: number + x-stream-index: "014" + name: + type: string + x-stream-index: "002" + online: + type: boolean + x-stream-index: "013" + revoke_tokens_issued_before: + format: date-time + type: number + x-stream-index: "015" + role: + type: string + x-stream-index: "006" + teams: + items: + type: string + type: array + x-stream-index: "007" + teams_role: + additionalProperties: + type: string + type: object + x-stream-index: "008" + updated_at: + format: date-time + type: number + x-stream-index: "010" + required: + - id + - custom + - language + - role + - teams + - created_at + - updated_at + - banned + - online + - blocked_user_ids + type: object + UserResponsePrivacyFields: + properties: + avg_response_time: + format: int32 + type: integer + x-stream-index: "001.018" + banned: + type: boolean + x-stream-index: "001.012" + blocked_user_ids: + items: + type: string + type: array + x-stream-index: "001.017" + created_at: + format: date-time + type: number + x-stream-index: "001.009" + custom: + additionalProperties: {} + type: object + x-stream-index: "001.004" + deactivated_at: + format: date-time + type: number + x-stream-index: "001.016" + deleted_at: + format: date-time + type: number + x-stream-index: "001.011" + id: + type: string + x-stream-index: "001.001" + image: + type: string + x-stream-index: "001.003" + invisible: + type: boolean + x-stream-index: "003" + language: + type: string + x-stream-index: "001.005" + last_active: + format: date-time + type: number + x-stream-index: "001.014" + name: + type: string + x-stream-index: "001.002" + online: + type: boolean + x-stream-index: "001.013" + privacy_settings: + $ref: '#/components/schemas/PrivacySettingsResponse' + x-stream-index: "002" + revoke_tokens_issued_before: + format: date-time + type: number + x-stream-index: "001.015" + role: + type: string + x-stream-index: "001.006" + teams: + items: + type: string + type: array + x-stream-index: "001.007" + teams_role: + additionalProperties: + type: string + type: object + x-stream-index: "001.008" + updated_at: + format: date-time + type: number + x-stream-index: "001.010" + required: + - id + - custom + - language + - role + - teams + - created_at + - updated_at + - banned + - online + - blocked_user_ids + type: object + UserRuleParameters: + properties: + max_age: + type: string + x-stream-index: "001" + type: object + UserUpdatedEvent: + description: This event is sent when a user gets updated. The event contains + information about the updated user. + nullable: true + properties: + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: "001.003" + custom: + additionalProperties: {} + type: object + x-stream-index: "001.007" + received_at: + format: date-time + type: number + x-stream-index: "001.004" + type: + default: user.updated + description: 'The type of event: "user.updated" in this case' + title: Event Type + type: string + x-stream-index: "001.002" + user: + $ref: '#/components/schemas/UserResponsePrivacyFields' + description: The updated user + title: User + x-stream-index: "002.001" + required: + - type + - created_at + - custom + - user + title: UserUpdatedEvent + 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 + VelocityFilterConfig: + properties: + advanced_filters: + type: boolean + x-stream-index: "007" + async: + type: boolean + x-stream-index: "001" + cascading_actions: + type: boolean + x-stream-index: "004" + cids_per_user: + format: int32 + type: integer + x-stream-index: "006" + enabled: + type: boolean + x-stream-index: "002" + first_message_only: + type: boolean + x-stream-index: "005" + rules: + items: + $ref: '#/components/schemas/VelocityFilterConfigRule' + type: array + x-stream-index: "003" + required: + - enabled + - rules + - cascading_actions + - first_message_only + - cids_per_user + - advanced_filters + type: object + VelocityFilterConfigRule: + properties: + action: + enum: + - flag + - shadow + - remove + - ban + type: string + x-stream-index: "001" + ban_duration: + format: int32 + type: integer + x-stream-index: "002" + cascading_action: + enum: + - flag + - shadow + - remove + - ban + type: string + x-stream-index: "006" + cascading_threshold: + format: int64 + type: integer + x-stream-index: "005" + check_message_context: + type: boolean + x-stream-index: "009" + fast_spam_threshold: + format: int32 + type: integer + x-stream-index: "007" + fast_spam_ttl: + format: int32 + type: integer + x-stream-index: "010" + ip_ban: + type: boolean + x-stream-index: "004" + probation_period: + format: int32 + type: integer + x-stream-index: "014" + shadow_ban: + type: boolean + x-stream-index: "003" + slow_spam_ban_duration: + format: int32 + type: integer + x-stream-index: "012" + slow_spam_threshold: + format: int32 + type: integer + x-stream-index: "008" + slow_spam_ttl: + format: int32 + type: integer + x-stream-index: "011" + url_only: + type: boolean + x-stream-index: "013" + required: + - action + - ban_duration + - shadow_ban + - ip_ban + - cascading_threshold + - cascading_action + - fast_spam_threshold + - slow_spam_threshold + - check_message_context + - fast_spam_ttl + - slow_spam_ttl + - url_only + - probation_period + type: object + VideoCallRuleConfig: + properties: + rules: + additionalProperties: + $ref: '#/components/schemas/HarmConfig' + type: object + x-stream-index: "001" + required: + - rules + type: object + VideoContentParameters: + properties: + harm_labels: + items: + type: string + type: array + x-stream-index: "001" + type: object + VideoEndCallRequest: + type: object + VideoKickUserRequest: + type: object + VideoOrientation: + properties: + orientation: + type: integer + x-stream-index: "004" + type: object + VideoRuleParameters: + properties: + harm_labels: + items: + type: string + type: array + x-stream-index: "003" + threshold: + format: int32 + type: integer + x-stream-index: "001" + time_window: + type: string + x-stream-index: "002" + type: object + VideoSettings: + properties: + access_request_enabled: + type: boolean + x-stream-index: "002" + camera_default_on: + type: boolean + x-stream-index: "004" + camera_facing: + enum: + - front + - back + - external + type: string + x-stream-index: "005" + enabled: + type: boolean + x-stream-index: "001" + target_resolution: + $ref: '#/components/schemas/TargetResolution' + x-stream-index: "003" + required: + - enabled + - access_request_enabled + - target_resolution + - camera_default_on + - camera_facing + type: object + VideoSettingsResponse: + properties: + access_request_enabled: + type: boolean + x-stream-index: "002" + camera_default_on: + type: boolean + x-stream-index: "004" + camera_facing: + enum: + - front + - back + - external + type: string + x-stream-index: "005" + enabled: + type: boolean + x-stream-index: "001" + target_resolution: + $ref: '#/components/schemas/TargetResolution' + x-stream-index: "003" + required: + - enabled + - access_request_enabled + - target_resolution + - camera_default_on + - camera_facing + type: object + VoteData: + properties: + answer_text: + type: string + x-stream-index: "002" + option_id: + maxLength: 255 + type: string + x-stream-index: "001" + type: object + WSAuthMessage: + description: Websocket auth message + nullable: true + properties: + products: + items: + type: string + type: array + x-stream-index: "003" + token: + title: Token + type: string + x-stream-index: "002" + user_details: + $ref: '#/components/schemas/ConnectUserDetailsRequest' + x-stream-index: "001" + required: + - user_details + - token + title: WSAuthMessage + type: object + WSClientEvent: + description: The discriminator object for all websocket client events, it maps + events' payload to the final type + discriminator: + mapping: + app.updated: '#/components/schemas/AppUpdatedEvent' + feeds.activity.added: '#/components/schemas/ActivityAddedEvent' + feeds.activity.deleted: '#/components/schemas/ActivityDeletedEvent' + feeds.activity.marked: '#/components/schemas/ActivityMarkEvent' + feeds.activity.pinned: '#/components/schemas/ActivityPinnedEvent' + feeds.activity.reaction.added: '#/components/schemas/ActivityReactionAddedEvent' + feeds.activity.reaction.deleted: '#/components/schemas/ActivityReactionDeletedEvent' + feeds.activity.reaction.updated: '#/components/schemas/ActivityReactionUpdatedEvent' + feeds.activity.removed_from_feed: '#/components/schemas/ActivityRemovedFromFeedEvent' + feeds.activity.unpinned: '#/components/schemas/ActivityUnpinnedEvent' + feeds.activity.updated: '#/components/schemas/ActivityUpdatedEvent' + feeds.bookmark.added: '#/components/schemas/BookmarkAddedEvent' + feeds.bookmark.deleted: '#/components/schemas/BookmarkDeletedEvent' + feeds.bookmark.updated: '#/components/schemas/BookmarkUpdatedEvent' + feeds.bookmark_folder.deleted: '#/components/schemas/BookmarkFolderDeletedEvent' + feeds.bookmark_folder.updated: '#/components/schemas/BookmarkFolderUpdatedEvent' + feeds.comment.added: '#/components/schemas/CommentAddedEvent' + feeds.comment.deleted: '#/components/schemas/CommentDeletedEvent' + feeds.comment.reaction.added: '#/components/schemas/CommentReactionAddedEvent' + feeds.comment.reaction.deleted: '#/components/schemas/CommentReactionDeletedEvent' + feeds.comment.reaction.updated: '#/components/schemas/CommentReactionUpdatedEvent' + feeds.comment.updated: '#/components/schemas/CommentUpdatedEvent' + feeds.feed.created: '#/components/schemas/FeedCreatedEvent' + feeds.feed.deleted: '#/components/schemas/FeedDeletedEvent' + feeds.feed.updated: '#/components/schemas/FeedUpdatedEvent' + feeds.feed_group.changed: '#/components/schemas/FeedGroupChangedEvent' + feeds.feed_group.deleted: '#/components/schemas/FeedGroupDeletedEvent' + feeds.feed_member.added: '#/components/schemas/FeedMemberAddedEvent' + feeds.feed_member.removed: '#/components/schemas/FeedMemberRemovedEvent' + feeds.feed_member.updated: '#/components/schemas/FeedMemberUpdatedEvent' + feeds.follow.created: '#/components/schemas/FollowCreatedEvent' + feeds.follow.deleted: '#/components/schemas/FollowDeletedEvent' + feeds.follow.updated: '#/components/schemas/FollowUpdatedEvent' + feeds.notification_feed.updated: '#/components/schemas/NotificationFeedUpdatedEvent' + feeds.poll.closed: '#/components/schemas/PollClosedFeedEvent' + feeds.poll.deleted: '#/components/schemas/PollDeletedFeedEvent' + feeds.poll.updated: '#/components/schemas/PollUpdatedFeedEvent' + feeds.poll.vote_casted: '#/components/schemas/PollVoteCastedFeedEvent' + feeds.poll.vote_changed: '#/components/schemas/PollVoteChangedFeedEvent' + feeds.poll.vote_removed: '#/components/schemas/PollVoteRemovedFeedEvent' + health.check: '#/components/schemas/HealthCheckEvent' + user.updated: '#/components/schemas/UserUpdatedEvent' + propertyName: type + oneOf: + - $ref: '#/components/schemas/ActivityAddedEvent' + - $ref: '#/components/schemas/ActivityDeletedEvent' + - $ref: '#/components/schemas/ActivityMarkEvent' + - $ref: '#/components/schemas/ActivityPinnedEvent' + - $ref: '#/components/schemas/ActivityReactionAddedEvent' + - $ref: '#/components/schemas/ActivityReactionDeletedEvent' + - $ref: '#/components/schemas/ActivityReactionUpdatedEvent' + - $ref: '#/components/schemas/ActivityRemovedFromFeedEvent' + - $ref: '#/components/schemas/ActivityUnpinnedEvent' + - $ref: '#/components/schemas/ActivityUpdatedEvent' + - $ref: '#/components/schemas/AppUpdatedEvent' + - $ref: '#/components/schemas/BookmarkAddedEvent' + - $ref: '#/components/schemas/BookmarkDeletedEvent' + - $ref: '#/components/schemas/BookmarkFolderDeletedEvent' + - $ref: '#/components/schemas/BookmarkFolderUpdatedEvent' + - $ref: '#/components/schemas/BookmarkUpdatedEvent' + - $ref: '#/components/schemas/CommentAddedEvent' + - $ref: '#/components/schemas/CommentDeletedEvent' + - $ref: '#/components/schemas/CommentReactionAddedEvent' + - $ref: '#/components/schemas/CommentReactionDeletedEvent' + - $ref: '#/components/schemas/CommentReactionUpdatedEvent' + - $ref: '#/components/schemas/CommentUpdatedEvent' + - $ref: '#/components/schemas/FeedCreatedEvent' + - $ref: '#/components/schemas/FeedDeletedEvent' + - $ref: '#/components/schemas/FeedGroupChangedEvent' + - $ref: '#/components/schemas/FeedGroupDeletedEvent' + - $ref: '#/components/schemas/FeedMemberAddedEvent' + - $ref: '#/components/schemas/FeedMemberRemovedEvent' + - $ref: '#/components/schemas/FeedMemberUpdatedEvent' + - $ref: '#/components/schemas/FeedUpdatedEvent' + - $ref: '#/components/schemas/FollowCreatedEvent' + - $ref: '#/components/schemas/FollowDeletedEvent' + - $ref: '#/components/schemas/FollowUpdatedEvent' + - $ref: '#/components/schemas/HealthCheckEvent' + - $ref: '#/components/schemas/NotificationFeedUpdatedEvent' + - $ref: '#/components/schemas/PollClosedFeedEvent' + - $ref: '#/components/schemas/PollDeletedFeedEvent' + - $ref: '#/components/schemas/PollUpdatedFeedEvent' + - $ref: '#/components/schemas/PollVoteCastedFeedEvent' + - $ref: '#/components/schemas/PollVoteChangedFeedEvent' + - $ref: '#/components/schemas/PollVoteRemovedFeedEvent' + - $ref: '#/components/schemas/UserUpdatedEvent' + WSEvent: + description: The discriminator object for all websocket events, it maps events' + payload to the final type + discriminator: + mapping: + app.updated: '#/components/schemas/AppUpdatedEvent' + feeds.activity.added: '#/components/schemas/ActivityAddedEvent' + feeds.activity.deleted: '#/components/schemas/ActivityDeletedEvent' + feeds.activity.marked: '#/components/schemas/ActivityMarkEvent' + feeds.activity.pinned: '#/components/schemas/ActivityPinnedEvent' + feeds.activity.reaction.added: '#/components/schemas/ActivityReactionAddedEvent' + feeds.activity.reaction.deleted: '#/components/schemas/ActivityReactionDeletedEvent' + feeds.activity.reaction.updated: '#/components/schemas/ActivityReactionUpdatedEvent' + feeds.activity.removed_from_feed: '#/components/schemas/ActivityRemovedFromFeedEvent' + feeds.activity.unpinned: '#/components/schemas/ActivityUnpinnedEvent' + feeds.activity.updated: '#/components/schemas/ActivityUpdatedEvent' + feeds.bookmark.added: '#/components/schemas/BookmarkAddedEvent' + feeds.bookmark.deleted: '#/components/schemas/BookmarkDeletedEvent' + feeds.bookmark.updated: '#/components/schemas/BookmarkUpdatedEvent' + feeds.bookmark_folder.deleted: '#/components/schemas/BookmarkFolderDeletedEvent' + feeds.bookmark_folder.updated: '#/components/schemas/BookmarkFolderUpdatedEvent' + feeds.comment.added: '#/components/schemas/CommentAddedEvent' + feeds.comment.deleted: '#/components/schemas/CommentDeletedEvent' + feeds.comment.reaction.added: '#/components/schemas/CommentReactionAddedEvent' + feeds.comment.reaction.deleted: '#/components/schemas/CommentReactionDeletedEvent' + feeds.comment.reaction.updated: '#/components/schemas/CommentReactionUpdatedEvent' + feeds.comment.updated: '#/components/schemas/CommentUpdatedEvent' + feeds.feed.created: '#/components/schemas/FeedCreatedEvent' + feeds.feed.deleted: '#/components/schemas/FeedDeletedEvent' + feeds.feed.updated: '#/components/schemas/FeedUpdatedEvent' + feeds.feed_group.changed: '#/components/schemas/FeedGroupChangedEvent' + feeds.feed_group.deleted: '#/components/schemas/FeedGroupDeletedEvent' + feeds.feed_member.added: '#/components/schemas/FeedMemberAddedEvent' + feeds.feed_member.removed: '#/components/schemas/FeedMemberRemovedEvent' + feeds.feed_member.updated: '#/components/schemas/FeedMemberUpdatedEvent' + feeds.follow.created: '#/components/schemas/FollowCreatedEvent' + feeds.follow.deleted: '#/components/schemas/FollowDeletedEvent' + feeds.follow.updated: '#/components/schemas/FollowUpdatedEvent' + feeds.notification_feed.updated: '#/components/schemas/NotificationFeedUpdatedEvent' + feeds.poll.closed: '#/components/schemas/PollClosedFeedEvent' + feeds.poll.deleted: '#/components/schemas/PollDeletedFeedEvent' + feeds.poll.updated: '#/components/schemas/PollUpdatedFeedEvent' + feeds.poll.vote_casted: '#/components/schemas/PollVoteCastedFeedEvent' + feeds.poll.vote_changed: '#/components/schemas/PollVoteChangedFeedEvent' + feeds.poll.vote_removed: '#/components/schemas/PollVoteRemovedFeedEvent' + health.check: '#/components/schemas/HealthCheckEvent' + moderation.custom_action: '#/components/schemas/ModerationCustomActionEvent' + moderation.flagged: '#/components/schemas/ModerationFlaggedEvent' + moderation.mark_reviewed: '#/components/schemas/ModerationMarkReviewedEvent' + user.banned: '#/components/schemas/UserBannedEvent' + user.deactivated: '#/components/schemas/UserDeactivatedEvent' + user.muted: '#/components/schemas/UserMutedEvent' + user.reactivated: '#/components/schemas/UserReactivatedEvent' + user.updated: '#/components/schemas/UserUpdatedEvent' + propertyName: type + oneOf: + - $ref: '#/components/schemas/ActivityAddedEvent' + - $ref: '#/components/schemas/ActivityDeletedEvent' + - $ref: '#/components/schemas/ActivityMarkEvent' + - $ref: '#/components/schemas/ActivityPinnedEvent' + - $ref: '#/components/schemas/ActivityReactionAddedEvent' + - $ref: '#/components/schemas/ActivityReactionDeletedEvent' + - $ref: '#/components/schemas/ActivityReactionUpdatedEvent' + - $ref: '#/components/schemas/ActivityRemovedFromFeedEvent' + - $ref: '#/components/schemas/ActivityUnpinnedEvent' + - $ref: '#/components/schemas/ActivityUpdatedEvent' + - $ref: '#/components/schemas/AppUpdatedEvent' + - $ref: '#/components/schemas/BookmarkAddedEvent' + - $ref: '#/components/schemas/BookmarkDeletedEvent' + - $ref: '#/components/schemas/BookmarkFolderDeletedEvent' + - $ref: '#/components/schemas/BookmarkFolderUpdatedEvent' + - $ref: '#/components/schemas/BookmarkUpdatedEvent' + - $ref: '#/components/schemas/CommentAddedEvent' + - $ref: '#/components/schemas/CommentDeletedEvent' + - $ref: '#/components/schemas/CommentReactionAddedEvent' + - $ref: '#/components/schemas/CommentReactionDeletedEvent' + - $ref: '#/components/schemas/CommentReactionUpdatedEvent' + - $ref: '#/components/schemas/CommentUpdatedEvent' + - $ref: '#/components/schemas/FeedCreatedEvent' + - $ref: '#/components/schemas/FeedDeletedEvent' + - $ref: '#/components/schemas/FeedGroupChangedEvent' + - $ref: '#/components/schemas/FeedGroupDeletedEvent' + - $ref: '#/components/schemas/FeedMemberAddedEvent' + - $ref: '#/components/schemas/FeedMemberRemovedEvent' + - $ref: '#/components/schemas/FeedMemberUpdatedEvent' + - $ref: '#/components/schemas/FeedUpdatedEvent' + - $ref: '#/components/schemas/FollowCreatedEvent' + - $ref: '#/components/schemas/FollowDeletedEvent' + - $ref: '#/components/schemas/FollowUpdatedEvent' + - $ref: '#/components/schemas/HealthCheckEvent' + - $ref: '#/components/schemas/ModerationCustomActionEvent' + - $ref: '#/components/schemas/ModerationFlaggedEvent' + - $ref: '#/components/schemas/ModerationMarkReviewedEvent' + - $ref: '#/components/schemas/NotificationFeedUpdatedEvent' + - $ref: '#/components/schemas/PollClosedFeedEvent' + - $ref: '#/components/schemas/PollDeletedFeedEvent' + - $ref: '#/components/schemas/PollUpdatedFeedEvent' + - $ref: '#/components/schemas/PollVoteCastedFeedEvent' + - $ref: '#/components/schemas/PollVoteChangedFeedEvent' + - $ref: '#/components/schemas/PollVoteRemovedFeedEvent' + - $ref: '#/components/schemas/UserBannedEvent' + - $ref: '#/components/schemas/UserDeactivatedEvent' + - $ref: '#/components/schemas/UserMutedEvent' + - $ref: '#/components/schemas/UserReactivatedEvent' + - $ref: '#/components/schemas/UserUpdatedEvent' + securitySchemes: + JWT: + description: | + JWT should be always provided when stream-auth-type=jwt. + + Using JWT auth request could be authenticated as user or as server-side. + + When using user authentication permission checking is going to be applied to requests based on the user that is + performing a request. + + The `authorization` header should be a JWT string signed using the secret attached to the API key used to perform + requests. + + **WARNING** all client-side official SDK do not ship with token generation; this is to make sure that the API secret is not + shared with an untrusted party such as a browser or a iOS/Android application. Tokens **must** be generated server-side. + If you wish, you can configure your application to ignore authentication (see `disable_auth_check`) + The JWT string must include only the user_id claim and can include any built-in JWT claim such as iat, exp as well. + in: header + name: Authorization + type: apiKey + api_key: + description: Application API key should be always set in order to authenticate + the request. + in: query + name: api_key + type: apiKey + stream-auth-type: + description: |- + Stream-Auth-Type should be always set in order to authenticate the request. Possible + values: `jwt` or `anonymous`. + + `jwt` allows you to authenticate as a user. With this auth type you should also provide valid JWT in Authorization + header. + + `anonymous` allows you to authenticate as anonymous user. Please note that most advanced features are not available + to anonymous users. + in: header + name: Stream-Auth-Type + type: apiKey +info: + title: Stream API + version: v191.1.0 +openapi: 3.0.3 +paths: + /api/v2/app: + get: + description: | + This Method returns the application settings + operationId: GetApp + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/GetApplicationResponse' + 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: Get App Settings + tags: + - product:common + /api/v2/blocklists: + get: + description: | + Returns all available block lists + operationId: ListBlockLists + parameters: + - in: query + name: team + schema: + type: string + writeOnly: true + x-stream-index: "001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/ListBlockListResponse' + 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: List block lists + tags: + - product:common + post: + description: | + Creates a new application blocklist, once created the blocklist can be used by any channel type + operationId: CreateBlockList + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateBlockListRequest' + description: Block list + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/CreateBlockListResponse' + 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: Create block list + tags: + - product:common + /api/v2/blocklists/{name}: + delete: + description: | + Deletes previously created application blocklist + operationId: DeleteBlockList + parameters: + - in: path + name: name + required: true + schema: + type: string + writeOnly: true + x-stream-index: "001" + - in: query + name: team + schema: + type: string + x-stream-index: "002" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/Response' + 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: Delete block list + tags: + - product:common + put: + description: | + Updates contents of the block list + operationId: UpdateBlockList + parameters: + - in: path + name: name + required: true + schema: + description: Block list name + title: Name + type: string + writeOnly: true + x-stream-index: "001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateBlockListRequest' + description: Update block list + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateBlockListResponse' + 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: Update block list + tags: + - product:common + /api/v2/devices: + delete: + description: | + Deletes one device + operationId: DeleteDevice + parameters: + - in: query + name: id + required: true + schema: + description: Device ID to delete + title: ID + type: string + writeOnly: true + x-stream-index: "001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/Response' + 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: Delete device + tags: + - product:common + get: + description: | + Returns all available devices + operationId: ListDevices + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/ListDevicesResponse' + description: ListDevicesResponse + "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: List devices + tags: + - product:common + post: + description: | + Adds a new device to a user, if the same device already exists the call will have no effect + operationId: CreateDevice + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateDeviceRequest' + description: CreateDeviceRequest + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/Response' + 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: Create device + tags: + - product:common + /api/v2/feeds/activities: + post: + description: | + Create a new activity or update an existing one + operationId: AddActivity + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AddActivityRequest' + description: Activity Request + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/AddActivityResponse' + description: Add Activity 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: Add a single activity + tags: + - product:feeds + /api/v2/feeds/activities/{activity_id}/bookmarks: + delete: + description: | + Deletes a bookmark from an activity + operationId: DeleteBookmark + parameters: + - in: path + name: activity_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + - in: query + name: folder_id + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "002" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteBookmarkResponse' + description: Delete Bookmark 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: Delete a bookmark + tags: + - product:feeds + patch: + description: | + Updates a bookmark for an activity + operationId: UpdateBookmark + parameters: + - in: path + name: activity_id + required: true + schema: + description: ID of the activity + maxLength: 255 + title: Activity ID + type: string + writeOnly: true + x-stream-index: "001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateBookmarkRequest' + description: Update Bookmark Request + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateBookmarkResponse' + description: Update Bookmark 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: Update bookmark + tags: + - product:feeds + post: + description: | + Adds a bookmark to an activity + operationId: AddBookmark + parameters: + - in: path + name: activity_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AddBookmarkRequest' + description: Add Bookmark Request + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/AddBookmarkResponse' + description: Add Bookmark 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: Add bookmark + tags: + - product:feeds + /api/v2/feeds/activities/{activity_id}/feedback: + post: + description: | + Submit feedback for an activity including options to show less, hide, report, or mute the user + operationId: ActivityFeedback + parameters: + - in: path + name: activity_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ActivityFeedbackRequest' + description: Activity Feedback Request + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/ActivityFeedbackResponse' + description: Activity Feedback 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: Provide feedback on an activity + tags: + - product:feeds + /api/v2/feeds/activities/{activity_id}/polls/{poll_id}/vote: + post: + description: | + Cast a vote on a poll + + Sends events: + - feeds.poll.vote_casted + - feeds.poll.vote_changed + - feeds.poll.vote_removed + - poll.vote_casted + - poll.vote_changed + - poll.vote_removed + operationId: CastPollVote + parameters: + - in: path + name: activity_id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "002" + - in: path + name: poll_id + required: true + schema: + description: Poll ID + maxLength: 255 + title: string + type: string + x-stream-index: "003" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CastPollVoteRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/PollVoteResponse' + description: Successful 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: Cast vote + tags: + - product:feeds + /api/v2/feeds/activities/{activity_id}/polls/{poll_id}/vote/{vote_id}: + delete: + description: | + Delete a vote from a poll + + Sends events: + - feeds.poll.vote_removed + - poll.vote_removed + operationId: DeletePollVote + parameters: + - in: path + name: activity_id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "003" + - in: path + name: poll_id + required: true + schema: + description: Poll ID + maxLength: 255 + title: string + type: string + x-stream-index: "004" + - in: path + name: vote_id + required: true + schema: + description: Vote ID + maxLength: 255 + title: string + type: string + x-stream-index: "005" + - in: query + name: user_id + schema: + type: string + writeOnly: true + x-stream-index: "001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/PollVoteResponse' + description: Successful 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: Delete vote + tags: + - product:feeds + /api/v2/feeds/activities/{activity_id}/reactions: + post: + description: | + Adds a reaction to an activity + operationId: AddReaction + parameters: + - in: path + name: activity_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AddReactionRequest' + description: Add Reaction Request + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/AddReactionResponse' + description: Add Reaction 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: Add reaction + tags: + - product:feeds + /api/v2/feeds/activities/{activity_id}/reactions/{type}: + delete: + description: | + Removes a reaction from an activity + operationId: DeleteActivityReaction + parameters: + - in: path + name: activity_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + - in: path + name: type + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "002" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteActivityReactionResponse' + description: Delete Activity Reaction 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: Remove reaction + tags: + - product:feeds + /api/v2/feeds/activities/{activity_id}/reactions/query: + post: + description: | + Query activity reactions + operationId: QueryActivityReactions + parameters: + - in: path + name: activity_id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueryActivityReactionsRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/QueryActivityReactionsResponse' + 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: Query activity reactions + tags: + - product:feeds + /api/v2/feeds/activities/{id}: + delete: + description: | + Delete a single activity by its ID + operationId: DeleteActivity + parameters: + - in: path + name: id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + - in: query + name: hard_delete + schema: + description: Whether to permanently delete the activity instead of soft + delete + title: boolean + type: boolean + writeOnly: true + x-stream-index: "002" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteActivityResponse' + description: Delete Activity 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: Delete a single activity + tags: + - product:feeds + get: + description: | + Returns activity by ID + operationId: GetActivity + parameters: + - in: path + name: id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/GetActivityResponse' + description: Get Activity 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: Get activity + tags: + - product:feeds + patch: + description: | + Updates certain fields of the activity + + Sends events: + - feeds.activity.updated + operationId: UpdateActivityPartial + parameters: + - in: path + name: id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateActivityPartialRequest' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateActivityPartialResponse' + description: Successful 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: Partially activity update + tags: + - product:feeds + put: + description: | + Replaces an activity with the provided data + + Sends events: + - feeds.activity.updated + operationId: UpdateActivity + parameters: + - in: path + name: id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateActivityRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateActivityResponse' + description: Successful 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: Full activity update + tags: + - product:feeds + /api/v2/feeds/activities/batch: + post: + description: | + Create new activities or update existing ones in a batch operation + operationId: UpsertActivities + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpsertActivitiesRequest' + description: Upsert Activities Request + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/UpsertActivitiesResponse' + description: Upsert Activities 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: Upsert multiple activities + tags: + - product:feeds + /api/v2/feeds/activities/delete: + post: + description: | + Delete one or more activities by their IDs + operationId: DeleteActivities + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteActivitiesRequest' + description: Delete Activities Request + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteActivitiesResponse' + description: Delete Activities 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: Remove multiple activities + tags: + - product:feeds + /api/v2/feeds/activities/query: + post: + description: | + Query activities based on filters with pagination and sorting options + operationId: QueryActivities + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueryActivitiesRequest' + description: Query Activities Request + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/QueryActivitiesResponse' + description: Query Activities 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: Query activities + tags: + - product:feeds + /api/v2/feeds/bookmark_folders/{folder_id}: + delete: + description: | + Delete a bookmark folder by its ID + operationId: DeleteBookmarkFolder + parameters: + - in: path + name: folder_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteBookmarkFolderResponse' + description: Delete Bookmark Folder 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: Delete a bookmark folder + tags: + - product:feeds + patch: + description: | + Update a bookmark folder by its ID + operationId: UpdateBookmarkFolder + parameters: + - in: path + name: folder_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateBookmarkFolderRequest' + description: Update Bookmark Folder Request + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateBookmarkFolderResponse' + description: Update Bookmark Folder 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: Update a bookmark folder + tags: + - product:feeds + /api/v2/feeds/bookmark_folders/query: + post: + description: | + Query bookmark folders with filter query + operationId: QueryBookmarkFolders + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueryBookmarkFoldersRequest' + description: Query Bookmark Folders Request + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/QueryBookmarkFoldersResponse' + description: Query Bookmark Folders 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: Query bookmark folders + tags: + - product:feeds + /api/v2/feeds/bookmarks/query: + post: + description: | + Query bookmarks with filter query + operationId: QueryBookmarks + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueryBookmarksRequest' + description: Query Bookmarks Request + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/QueryBookmarksResponse' + description: Query Bookmarks 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: Query bookmarks + tags: + - product:feeds + /api/v2/feeds/comments: + get: + description: | + Retrieve a threaded list of comments for a specific object (e.g., activity), with configurable depth, sorting, and pagination + operationId: GetComments + parameters: + - in: query + name: object_id + required: true + schema: + description: ID of the object to get comments for + title: Object ID + type: string + writeOnly: true + x-stream-index: "001" + - in: query + name: object_type + required: true + schema: + description: Type of the object to get comments for + title: Object Type + type: string + writeOnly: true + x-stream-index: "002" + - in: query + name: depth + schema: + description: Maximum nested depth to return (0 = only first level) + format: int32 + maximum: 5 + minimum: 0 + title: Max Depth + type: integer + writeOnly: true + x-stream-index: "003" + - in: query + name: sort + schema: + description: Sort order for the comments + enum: + - first + - last + - top + - best + - controversial + title: Sort Order + type: string + writeOnly: true + x-stream-index: "004" + - in: query + name: replies_limit + schema: + format: int32 + maximum: 20 + minimum: 0 + type: integer + writeOnly: true + x-stream-index: "005" + - in: query + name: limit + schema: + description: Max number of top‑level comments to return + format: int32 + maximum: 100 + minimum: 0 + title: Root Limit + type: integer + writeOnly: true + x-stream-index: "006.001" + - in: query + name: prev + schema: + type: string + writeOnly: true + x-stream-index: "006.002" + - in: query + name: next + schema: + type: string + writeOnly: true + x-stream-index: "006.003" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/GetCommentsResponse' + description: Get Comments 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: Get comments for an object + tags: + - product:feeds + post: + description: | + Adds a comment to an object (e.g., activity) or a reply to an existing comment, and broadcasts appropriate events + operationId: AddComment + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AddCommentRequest' + description: Add Comment Request + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/AddCommentResponse' + description: Add Comment 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: Add a comment or reply + tags: + - product:feeds + /api/v2/feeds/comments/{id}: + delete: + description: | + Deletes a comment from an object (e.g., activity) and broadcasts appropriate events + operationId: DeleteComment + parameters: + - in: path + name: id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "001" + - in: query + name: hard_delete + schema: + description: Whether to permanently delete the comment instead of soft delete + title: Hard Delete + type: boolean + writeOnly: true + x-stream-index: "002" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteCommentResponse' + description: Delete Comment 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: Delete a comment + tags: + - product:feeds + get: + description: | + Get a comment by ID + operationId: GetComment + parameters: + - in: path + name: id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/GetCommentResponse' + description: Get Comment 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: Get comment + tags: + - product:feeds + patch: + description: | + Updates a comment on an object (e.g., activity) and broadcasts appropriate events + operationId: UpdateComment + parameters: + - in: path + name: id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateCommentRequest' + description: Update Comment Request + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateCommentResponse' + description: Update Comment 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: Update a comment + tags: + - product:feeds + /api/v2/feeds/comments/{id}/reactions: + post: + description: | + Adds a reaction to a comment + operationId: AddCommentReaction + parameters: + - in: path + name: id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AddCommentReactionRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/AddCommentReactionResponse' + description: Successful 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: Add comment reaction + tags: + - product:feeds + /api/v2/feeds/comments/{id}/reactions/{type}: + delete: + description: | + Deletes a reaction from a comment + operationId: DeleteCommentReaction + parameters: + - in: path + name: id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + - in: path + name: type + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "002" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteCommentReactionResponse' + description: Delete Comment Reaction 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: Delete comment reaction + tags: + - product:feeds + /api/v2/feeds/comments/{id}/reactions/query: + post: + description: | + Query comment reactions + operationId: QueryCommentReactions + parameters: + - in: path + name: id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueryCommentReactionsRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/QueryCommentReactionsResponse' + 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: Query comment reactions + tags: + - product:feeds + /api/v2/feeds/comments/{id}/replies: + get: + description: | + Retrieve a threaded list of replies for a single comment, with configurable depth, sorting, and pagination + operationId: GetCommentReplies + parameters: + - in: path + name: id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "001" + - in: query + name: depth + schema: + description: Maximum nested depth to return (0 = unlimited) + format: int32 + maximum: 5 + minimum: 0 + title: Max Depth + type: integer + writeOnly: true + x-stream-index: "002" + - in: query + name: sort + schema: + description: first (oldest), last (newest) or top + enum: + - first + - last + - top + - best + - controversial + title: Sort Order + type: string + writeOnly: true + x-stream-index: "003" + - in: query + name: replies_limit + schema: + description: Max number of replies to return + format: int32 + minimum: 0 + title: Replies Limit + type: integer + writeOnly: true + x-stream-index: "004" + - in: query + name: limit + schema: + description: Max number of direct replies to return + format: int32 + maximum: 100 + minimum: 0 + title: Reply Limit + type: integer + writeOnly: true + x-stream-index: "005.001" + - in: query + name: prev + schema: + type: string + writeOnly: true + x-stream-index: "005.002" + - in: query + name: next + schema: + type: string + writeOnly: true + x-stream-index: "005.003" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/GetCommentRepliesResponse' + description: Get Comment Replies 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: Get replies for a comment + tags: + - product:feeds + /api/v2/feeds/comments/batch: + post: + description: | + Adds multiple comments in a single request. Each comment must specify the object type and ID. + operationId: AddCommentsBatch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AddCommentsBatchRequest' + description: Add Comments Batch Request + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/AddCommentsBatchResponse' + description: Add Comments Batch 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: Add multiple comments in a batch + tags: + - product:feeds + /api/v2/feeds/comments/query: + post: + description: | + Query comments using MongoDB-style filters with pagination and sorting options + operationId: QueryComments + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueryCommentsRequest' + description: Query Comments Request + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/QueryCommentsResponse' + description: Query Comments 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: Query comments + tags: + - product:feeds + /api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}: + delete: + description: | + Delete a single feed by its ID + operationId: DeleteFeed + parameters: + - in: path + name: feed_group_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + - in: path + name: feed_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "002" + - in: query + name: hard_delete + schema: + description: Whether to permanently delete the feed instead of soft delete + title: boolean + type: boolean + writeOnly: true + x-stream-index: "003" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteFeedResponse' + description: Delete Feed 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: Delete a single feed + tags: + - product:feeds + post: + description: | + Create a single feed for a given feed group + operationId: GetOrCreateFeed + parameters: + - in: path + name: feed_group_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + - in: path + name: feed_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "002" + - in: query + name: connection_id + schema: + description: Websocket connection ID to interact with. You can pass it as + Body or URL parameter + title: Connection ID + type: string + x-stream-index: "015.003" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GetOrCreateFeedRequest' + description: ClientRequest + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/GetOrCreateFeedResponse' + 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: Create a new feed + tags: + - product:feeds + put: + description: | + Update an existing feed + operationId: UpdateFeed + parameters: + - in: path + name: feed_group_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + - in: path + name: feed_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "002" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateFeedRequest' + description: Update Feed Request + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateFeedResponse' + description: Update Feed 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: Update a feed + tags: + - product:feeds + /api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/activities/{activity_id}/pin: + delete: + description: | + Unpin an activity from a feed. This removes the pin, so the activity will no longer be displayed at the top of the feed. + operationId: UnpinActivity + parameters: + - in: path + name: feed_group_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + - in: path + name: feed_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "002" + - in: path + name: activity_id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "003" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/UnpinActivityResponse' + description: Unpin Activity 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: Unpin an activity from a feed + tags: + - product:feeds + post: + description: | + Pin an activity to a feed. Pinned activities are typically displayed at the top of a feed. + operationId: PinActivity + parameters: + - in: path + name: feed_group_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + - in: path + name: feed_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "002" + - in: path + name: activity_id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "003" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PinActivityRequest' + description: Pin Activity Request + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/PinActivityResponse' + description: Pin Activity 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: Pin an activity to a feed + tags: + - product:feeds + /api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/activities/mark/batch: + post: + description: | + Mark activities as read/seen/watched. Can mark by timestamp (seen), activity IDs (read), or all as read. + operationId: MarkActivity + parameters: + - in: path + name: feed_group_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + - in: path + name: feed_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "002" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MarkActivityRequest' + description: Mark Activity Request + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/Response' + 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 activities as read/seen/watched + tags: + - product:feeds + /api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/members: + patch: + description: | + Add, remove, or set members for a feed + operationId: UpdateFeedMembers + parameters: + - in: path + name: feed_group_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + - in: path + name: feed_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "002" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateFeedMembersRequest' + description: Update Feed Members Request + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateFeedMembersResponse' + 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: Update feed members + tags: + - product:feeds + /api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/members/accept: + post: + description: | + Accepts a pending feed member request + operationId: AcceptFeedMemberInvite + parameters: + - in: path + name: feed_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + - in: path + name: feed_group_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "002" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AcceptFeedMemberInviteRequest' + description: Accept Feed Member Invite Request + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/AcceptFeedMemberInviteResponse' + description: Accept Feed Member Invite 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: Accept a feed member request + tags: + - product:feeds + /api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/members/query: + post: + description: | + Query feed members based on filters with pagination and sorting options + operationId: QueryFeedMembers + parameters: + - in: path + name: feed_group_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + - in: path + name: feed_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "002" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueryFeedMembersRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/QueryFeedMembersResponse' + description: Successful 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: Query feed members + tags: + - product:feeds + /api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/members/reject: + post: + description: | + Rejects a pending feed member request + operationId: RejectFeedMemberInvite + parameters: + - in: path + name: feed_group_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + - in: path + name: feed_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "002" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RejectFeedMemberInviteRequest' + description: Reject Feed Member Request + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/RejectFeedMemberInviteResponse' + description: Reject Feed Member 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: Reject an invite to become a feed member + tags: + - product:feeds + /api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/watch: + delete: + description: | + Call this Method to stop receiving feed events + operationId: StopWatchingFeed + parameters: + - in: path + name: feed_group_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "002" + - in: path + name: feed_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "003" + - in: query + name: connection_id + schema: + type: string + x-stream-index: "001.003" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/Response' + 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: Stop watching feed + tags: + - product:feeds + /api/v2/feeds/feed_groups/{feed_group_id}/follow_suggestions: + get: + description: | + Get follow suggestions for a feed group + operationId: GetFollowSuggestions + parameters: + - in: path + name: feed_group_id + required: true + schema: + description: The ID of the feed group to get suggestions for + maxLength: 255 + title: Feed Group ID + type: string + writeOnly: true + x-stream-index: "001" + - in: query + name: limit + schema: + description: Maximum number of suggestions to return + format: int32 + maximum: 100 + minimum: 1 + title: Limit + type: integer + writeOnly: true + x-stream-index: "002" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/GetFollowSuggestionsResponse' + description: Follow Suggestions 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: Get follow suggestions + tags: + - product:feeds + /api/v2/feeds/feeds/batch: + post: + description: | + Create multiple feeds at once for a given feed group + operationId: CreateFeedsBatch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateFeedsBatchRequest' + description: Create Feeds Batch Request + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/CreateFeedsBatchResponse' + description: Create Feeds Batch 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: Create multiple feeds at once + tags: + - product:feeds + /api/v2/feeds/feeds/query: + post: + description: | + Query feeds with filter query + operationId: QueryFeeds + parameters: + - in: query + name: connection_id + schema: + type: string + x-stream-index: "005.003" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueryFeedsRequest' + description: Query Feeds Request + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/QueryFeedsResponse' + description: Query Feeds 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: Query feeds + tags: + - product:feeds + /api/v2/feeds/follows: + patch: + description: | + Updates a follow's custom data, push preference, and follower role. Source owner can update custom data and push preference. Target owner can update follower role. + operationId: UpdateFollow + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateFollowRequest' + description: Update Follow Request + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateFollowResponse' + description: Update Follow 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: Update a follow + tags: + - product:feeds + post: + description: | + Creates a follow and broadcasts FollowAddedEvent + operationId: Follow + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/FollowRequest' + description: Follow Request + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/SingleFollowResponse' + description: Follow 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: Create a follow + tags: + - product:feeds + /api/v2/feeds/follows/{source}/{target}: + delete: + description: | + Removes a follow and broadcasts FollowRemovedEvent + operationId: Unfollow + parameters: + - in: path + name: source + required: true + schema: + description: Fully qualified ID of the source feed + maxLength: 255 + title: Source Feed + type: string + writeOnly: true + x-stream-index: "001" + - in: path + name: target + required: true + schema: + description: Fully qualified ID of the target feed + maxLength: 255 + title: Target Feed + type: string + writeOnly: true + x-stream-index: "002" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/UnfollowResponse' + description: Unfollow 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: Unfollow a feed + tags: + - product:feeds + /api/v2/feeds/follows/accept: + post: + description: | + Accepts a pending follow request + operationId: AcceptFollow + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AcceptFollowRequest' + description: Accept Follow Request + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/AcceptFollowResponse' + description: Accept Follow 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: Accept a follow request + tags: + - product:feeds + /api/v2/feeds/follows/batch: + post: + description: | + Creates multiple follows at once and broadcasts FollowAddedEvent for each follow + operationId: FollowBatch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/FollowBatchRequest' + description: Follow Batch Request + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/FollowBatchResponse' + description: Follow Batch 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: Create multiple follows at once + tags: + - product:feeds + /api/v2/feeds/follows/query: + post: + description: | + Query follows based on filters with pagination and sorting options + operationId: QueryFollows + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueryFollowsRequest' + description: Query Follows Request + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/QueryFollowsResponse' + description: Query Follows 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: Query follows + tags: + - product:feeds + /api/v2/feeds/follows/reject: + post: + description: | + Rejects a pending follow request + operationId: RejectFollow + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RejectFollowRequest' + description: Reject Follow Request + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/RejectFollowResponse' + description: Reject Follow 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: Reject a follow request + tags: + - product:feeds + /api/v2/guest: + post: + description: |2+ + + operationId: CreateGuest + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateGuestRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/CreateGuestResponse' + description: Successful 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: Create Guest + tags: + - product:common + /api/v2/longpoll: + get: + description: | + WebSocket fallback transport endpoint + + Sends events: + - user.updated + operationId: LongPoll + parameters: + - content: + application/json: + schema: + $ref: '#/components/schemas/WSAuthMessage' + x-stream-index: "001" + in: query + name: json + - in: query + name: connection_id + schema: + maxLength: 36 + type: string + writeOnly: true + x-stream-index: "002" + responses: + "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: Long Poll (Transport) + tags: + - product:common + /api/v2/moderation/ban: + post: + description: | + Ban a user from a channel or the entire app + operationId: ban + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BanRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/BanResponse' + description: Successful 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: Ban + tags: + - product:moderation + /api/v2/moderation/config: + post: + description: | + Create a new moderation configuration or update an existing one. Configure settings for content filtering, AI analysis, toxicity detection, and other moderation features. + operationId: upsert_config + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpsertConfigRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/UpsertConfigResponse' + description: Successful 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: Create or update moderation configuration + tags: + - product:moderation + /api/v2/moderation/config/{key}: + delete: + description: | + Delete a specific moderation policy by its name + operationId: delete_config + parameters: + - in: path + name: key + required: true + schema: + description: Key of the moderation configuration to delete + title: Key + type: string + x-stream-index: "001" + - in: query + name: team + schema: + description: Team associated with the configuration + title: Team + type: string + x-stream-index: "002" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteModerationConfigResponse' + description: Successful 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: Delete a moderation policy + tags: + - product:moderation + get: + description: | + Retrieve a specific moderation configuration by its key and team. This configuration contains settings for various moderation features like toxicity detection, AI analysis, and filtering rules. + operationId: get_config + parameters: + - in: path + name: key + required: true + schema: + description: Key of the moderation configuration to retrieve + title: Key + type: string + x-stream-index: "001" + - in: query + name: team + schema: + description: Team associated with the configuration + title: Team + type: string + x-stream-index: "002" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/GetConfigResponse' + description: Successful 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: Get moderation configuration + tags: + - product:moderation + /api/v2/moderation/configs: + post: + description: | + Search and filter moderation configurations across your application. This endpoint is designed for building moderation dashboards and managing multiple configuration sets. + operationId: query_moderation_configs + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueryModerationConfigsRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/QueryModerationConfigsResponse' + description: Successful 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: Query moderation configurations + tags: + - product:moderation + /api/v2/moderation/flag: + post: + description: | + Flag any type of content (messages, users, channels, activities) for moderation review. Supports custom content types and additional metadata for flagged content. + operationId: flag + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/FlagRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/FlagResponse' + description: Successful 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: Flag content for moderation + tags: + - product:moderation + /api/v2/moderation/mute: + post: + description: | + Mute a user. Mutes are generally not visible to the user you mute, while block is something you notice. + operationId: mute + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MuteRequest' + description: MuteRequest + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/MuteResponse' + description: MuteResponse + "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: Mute + tags: + - product:moderation + /api/v2/moderation/review_queue: + post: + description: | + Query review queue items allows you to filter the review queue items. This is used for building a moderation dashboard. + operationId: query_review_queue + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueryReviewQueueRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/QueryReviewQueueResponse' + description: Successful 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: Query review queue items + tags: + - product:moderation + /api/v2/moderation/submit_action: + post: + description: | + Take action on flagged content, such as marking content as safe, deleting content, banning users, or executing custom moderation actions. Supports various action types with configurable parameters. + operationId: submit_action + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SubmitActionRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/SubmitActionResponse' + description: Successful 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: Submit moderation action + tags: + - product:moderation + /api/v2/og: + get: + description: | + Get an OpenGraph attachment for a link + operationId: GetOG + parameters: + - in: query + name: url + required: true + schema: + description: URL to be scraped + title: URL + type: string + writeOnly: true + x-stream-index: "001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/GetOGResponse' + description: Get OG Attachment + "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: Get OG + tags: + - product:common + /api/v2/polls: + post: + description: | + Creates a new poll + operationId: CreatePoll + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePollRequest' + description: Create Poll Request + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/PollResponse' + description: Successful 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: Create poll + tags: + - product:common + put: + description: | + Updates a poll + + Sends events: + - feeds.poll.closed + - feeds.poll.updated + - poll.closed + - poll.updated + operationId: UpdatePoll + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdatePollRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/PollResponse' + description: Successful 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: Update poll + tags: + - product:common + /api/v2/polls/{poll_id}: + delete: + description: | + Deletes a poll + + Sends events: + - feeds.poll.deleted + - poll.deleted + operationId: DeletePoll + parameters: + - in: path + name: poll_id + required: true + schema: + description: Poll ID + maxLength: 255 + title: string + type: string + x-stream-index: "002" + - in: query + name: user_id + schema: + type: string + writeOnly: true + x-stream-index: "001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/Response' + 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: Delete poll + tags: + - product:common + get: + description: | + Retrieves a poll + operationId: GetPoll + parameters: + - in: path + name: poll_id + required: true + schema: + description: Poll ID + maxLength: 255 + title: string + type: string + x-stream-index: "002" + - in: query + name: user_id + schema: + type: string + writeOnly: true + x-stream-index: "001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/PollResponse' + description: Successful 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: Get poll + tags: + - product:common + patch: + description: | + Updates a poll partially + + Sends events: + - feeds.poll.closed + - feeds.poll.updated + - poll.closed + - poll.updated + operationId: UpdatePollPartial + parameters: + - in: path + name: poll_id + required: true + schema: + description: Poll ID + maxLength: 255 + title: string + type: string + x-stream-index: "001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdatePollPartialRequest' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/PollResponse' + description: Successful 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: Partial update poll + tags: + - product:common + /api/v2/polls/{poll_id}/options: + post: + description: | + Creates a poll option + + Sends events: + - feeds.poll.updated + - poll.updated + operationId: CreatePollOption + parameters: + - in: path + name: poll_id + required: true + schema: + description: Poll ID + maxLength: 255 + title: string + type: string + x-stream-index: "001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePollOptionRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/PollOptionResponse' + description: Successful 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: Create poll option + tags: + - product:common + put: + description: | + Updates a poll option + + Sends events: + - feeds.poll.updated + - poll.updated + operationId: UpdatePollOption + parameters: + - in: path + name: poll_id + required: true + schema: + description: Poll ID + maxLength: 255 + title: string + type: string + x-stream-index: "001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdatePollOptionRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/PollOptionResponse' + description: Successful 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: Update poll option + tags: + - product:common + /api/v2/polls/{poll_id}/options/{option_id}: + delete: + description: | + Deletes a poll option + + Sends events: + - feeds.poll.updated + - poll.updated + operationId: DeletePollOption + parameters: + - in: path + name: poll_id + required: true + schema: + description: Poll ID + maxLength: 255 + title: string + type: string + x-stream-index: "002" + - in: path + name: option_id + required: true + schema: + description: Option ID + maxLength: 255 + title: string + type: string + x-stream-index: "003" + - in: query + name: user_id + schema: + type: string + writeOnly: true + x-stream-index: "001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/Response' + 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: Delete poll option + tags: + - product:common + get: + description: | + Retrieves a poll option + operationId: GetPollOption + parameters: + - in: path + name: poll_id + required: true + schema: + description: Poll ID + maxLength: 255 + title: string + type: string + x-stream-index: "002" + - in: path + name: option_id + required: true + schema: + description: Option ID + maxLength: 255 + title: string + type: string + x-stream-index: "003" + - in: query + name: user_id + schema: + type: string + writeOnly: true + x-stream-index: "001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/PollOptionResponse' + description: Successful 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: Get poll option + tags: + - product:common + /api/v2/polls/{poll_id}/votes: + post: + description: | + Queries votes + operationId: QueryPollVotes + parameters: + - in: path + name: poll_id + required: true + schema: + description: Poll ID + maxLength: 255 + title: string + type: string + x-stream-index: "002" + - in: query + name: user_id + schema: + type: string + writeOnly: true + x-stream-index: "001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueryPollVotesRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/PollVotesResponse' + description: Successful 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: Query votes + tags: + - product:common + /api/v2/polls/query: + post: + description: | + Queries polls + operationId: QueryPolls + parameters: + - in: query + name: user_id + schema: + type: string + writeOnly: true + x-stream-index: "001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueryPollsRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/QueryPollsResponse' + description: Successful 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: Query polls + tags: + - product:common + /api/v2/uploads/file: + delete: + description: | + Deletes previously uploaded file + operationId: DeleteFileGlobal + parameters: + - in: query + name: url + schema: + description: File URL to delete + title: URL + type: string + writeOnly: true + x-stream-index: "001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/Response' + 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: Delete file + tags: + - product:common + x-stream-sdk-name: DeleteFile + post: + description: | + Uploads file + operationId: UploadFileGlobal + requestBody: + content: + multipart/form-data: + schema: + $ref: '#/components/schemas/FileUploadRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/FileUploadResponse' + description: Successful 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: Upload file + tags: + - product:common + x-stream-sdk-name: UploadFile + /api/v2/uploads/image: + delete: + description: | + Deletes previously uploaded image + operationId: DeleteImageGlobal + parameters: + - in: query + name: url + schema: + description: File URL to delete + title: URL + type: string + writeOnly: true + x-stream-index: "001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/Response' + 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: Delete image + tags: + - product:common + x-stream-sdk-name: DeleteImage + post: + description: | + Uploads image + operationId: UploadImageGlobal + requestBody: + content: + multipart/form-data: + schema: + $ref: '#/components/schemas/ImageUploadRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/ImageUploadResponse' + description: Successful 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: Upload image + tags: + - product:common + x-stream-sdk-name: UploadImage + /api/v2/users: + get: + description: | + Find and filter users + operationId: QueryUsers + parameters: + - content: + application/json: + schema: + $ref: '#/components/schemas/QueryUsersPayload' + x-stream-index: "001" + in: query + name: payload + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/QueryUsersResponse' + description: Successful 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: Query users + tags: + - product:common + patch: + description: | + Updates certain fields of the user + + Sends events: + - user.presence.changed + - user.updated + - user.presence.changed + operationId: UpdateUsersPartial + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateUsersPartialRequest' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateUsersResponse' + description: Successful 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: Partially update user + tags: + - product:common + post: + description: | + Update or create users in bulk + + Sends events: + - user.updated + operationId: UpdateUsers + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateUsersRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateUsersResponse' + description: Successful 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: Upsert users + tags: + - product:common + /api/v2/users/block: + get: + description: | + Get list of blocked Users + operationId: GetBlockedUsers + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/GetBlockedUsersResponse' + description: Successful 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: Get list of blocked Users + tags: + - product:common + post: + description: | + Block users + operationId: BlockUsers + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BlockUsersRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/BlockUsersResponse' + description: Successful 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: Block user + tags: + - product:common + /api/v2/users/live_locations: + get: + description: | + Retrieves all active live locations for a user + operationId: GetUserLiveLocations + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/SharedLocationsResponse' + description: Successful 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: Get user live locations + tags: + - product:common + put: + description: | + Updates an existing live location with new coordinates or expiration time + operationId: UpdateLiveLocation + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateLiveLocationRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/SharedLocationResponse' + description: Successful 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: Update live location + tags: + - product:common + /api/v2/users/unblock: + post: + description: | + Unblock users + operationId: UnblockUsers + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UnblockUsersRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/UnblockUsersResponse' + description: Successful 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: Unblock user + tags: + - product:common +security: +- JWT: [] + api_key: [] + stream-auth-type: [] +- api_key: [] + stream-auth-type: [] +servers: +- description: Stream API + url: https://chat.stream-io-api.com diff --git a/openapi/v2/feeds-serverside-api.json b/openapi/v2/feeds-serverside-api.json new file mode 100644 index 000000000..d1b6a7ceb --- /dev/null +++ b/openapi/v2/feeds-serverside-api.json @@ -0,0 +1 @@ +{"components":{"schemas":{"AIImageConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"ocr_rules":{"items":{"$ref":"#/components/schemas/OCRRule"},"type":"array","x-stream-index":"004"},"rules":{"items":{"$ref":"#/components/schemas/AWSRekognitionRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules","ocr_rules"],"type":"object"},"AITextConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"profile":{"type":"string","x-stream-index":"003"},"rules":{"items":{"$ref":"#/components/schemas/BodyguardRule"},"type":"array","x-stream-index":"004"},"severity_rules":{"items":{"$ref":"#/components/schemas/BodyguardSeverityRule"},"type":"array","x-stream-index":"005"}},"required":["enabled","profile","rules","severity_rules"],"type":"object"},"AIVideoConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AWSRekognitionRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"APIError":{"nullable":true,"properties":{"StatusCode":{"description":"Response HTTP status code","format":"int32","title":"Status code","type":"integer","x-stream-index":"004"},"code":{"description":"API error code","format":"int32","title":"Code","type":"integer","x-stream-index":"001"},"details":{"description":"Additional error-specific information","items":{"type":"integer"},"title":"Details","type":"array","x-stream-index":"007"},"duration":{"description":"Request duration","title":"Duration","type":"string","x-stream-index":"005"},"exception_fields":{"additionalProperties":{"type":"string"},"description":"Additional error info","title":"Exception fields","type":"object","x-stream-index":"003"},"message":{"description":"Message describing an error","title":"Message","type":"string","x-stream-index":"002"},"more_info":{"description":"URL with additional information","title":"More info","type":"string","x-stream-index":"006"},"unrecoverable":{"description":"Flag that indicates if the error is unrecoverable, requests that return unrecoverable errors should not be retried, this error only applies to the request that caused it","title":"Unrecoverable","type":"boolean","x-stream-index":"008"}},"required":["code","message","StatusCode","duration","more_info","details"],"title":"Error response","type":"object"},"APNConfig":{"properties":{"Disabled":{"type":"boolean","writeOnly":true,"x-stream-index":"005"},"auth_key":{"type":"string","x-stream-index":"006.001"},"auth_type":{"enum":["certificate","token"],"type":"string","x-stream-index":"001"},"bundle_id":{"type":"string","x-stream-index":"004"},"development":{"type":"boolean","x-stream-index":"002"},"host":{"type":"string","x-stream-index":"003"},"key_id":{"type":"string","x-stream-index":"006.002"},"notification_template":{"type":"string","x-stream-index":"008"},"p12_cert":{"type":"string","x-stream-index":"007.001"},"team_id":{"type":"string","x-stream-index":"006.003"}},"type":"object"},"APNConfigFields":{"properties":{"auth_key":{"type":"string","x-stream-index":"009"},"auth_type":{"type":"string","x-stream-index":"003"},"bundle_id":{"type":"string","x-stream-index":"006"},"development":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"host":{"type":"string","x-stream-index":"005"},"key_id":{"type":"string","x-stream-index":"008"},"notification_template":{"type":"string","x-stream-index":"004"},"p12_cert":{"type":"string","x-stream-index":"010"},"team_id":{"type":"string","x-stream-index":"007"}},"required":["enabled","development"],"type":"object"},"APNS":{"properties":{"body":{"type":"string","x-stream-index":"002"},"content-available":{"format":"int32","type":"integer","x-stream-index":"004"},"data":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"mutable-content":{"format":"int32","type":"integer","x-stream-index":"005"},"sound":{"type":"string","x-stream-index":"003"},"title":{"type":"string","x-stream-index":"001"}},"required":["title","body"],"type":"object"},"AWSRekognitionRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"},"min_confidence":{"format":"float","maximum":100,"minimum":0,"type":"number","x-stream-index":"003"}},"required":["label","action","min_confidence"],"type":"object"},"AcceptFeedMemberInviteRequest":{"nullable":true,"properties":{"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"title":"Accept Feed Member Invite Request","type":"object"},"AcceptFeedMemberInviteResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"member":{"$ref":"#/components/schemas/FeedMemberResponse","description":"The feed member after accepting the invite","title":"Feed Member","x-stream-index":"001"}},"required":["member","duration"],"title":"Accept Feed Member Invite Response","type":"object"},"AcceptFollowRequest":{"nullable":true,"properties":{"follower_role":{"description":"Optional role for the follower in the follow relationship","title":"Follower Role","type":"string","x-stream-index":"003"},"source":{"description":"Fully qualified ID of the source feed","maxLength":255,"title":"Source Feed ID","type":"string","x-stream-index":"001"},"target":{"description":"Fully qualified ID of the target feed","maxLength":255,"title":"Target Feed ID","type":"string","x-stream-index":"002"}},"required":["source","target"],"title":"Accept Follow Request","type":"object"},"AcceptFollowResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"follow":{"$ref":"#/components/schemas/FollowResponse","description":"The accepted follow relationship","title":"Follow","x-stream-index":"001"}},"required":["follow","duration"],"title":"Accept Follow Response","type":"object"},"Action":{"nullable":true,"properties":{"name":{"type":"string","x-stream-index":"001"},"style":{"type":"string","x-stream-index":"003"},"text":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"004"},"value":{"type":"string","x-stream-index":"005"}},"required":["name","text","type"],"type":"object"},"ActionLog":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"002"},"reason":{"type":"string","x-stream-index":"008"},"reporter_type":{"type":"string","x-stream-index":"009"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"014"},"review_queue_item_id":{"type":"string","x-stream-index":"012"},"target_user":{"$ref":"#/components/schemas/User","x-stream-index":"013"},"target_user_id":{"type":"string","x-stream-index":"011"},"type":{"type":"string","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007"}},"required":["id","created_at","type","reason","reporter_type","custom","target_user_id","review_queue_item_id"],"type":"object"},"ActionLogResponse":{"nullable":true,"properties":{"created_at":{"description":"Timestamp when the action was taken","format":"date-time","title":"Created At","type":"number","x-stream-index":"002"},"custom":{"additionalProperties":{},"description":"Additional metadata about the action","title":"Custom","type":"object","x-stream-index":"007"},"id":{"description":"Unique identifier of the action log","title":"ID","type":"string","x-stream-index":"001"},"reason":{"description":"Reason for the moderation action","title":"Reason","type":"string","x-stream-index":"006"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"Associated review queue item","title":"Review Queue Item","x-stream-index":"008"},"target_user":{"$ref":"#/components/schemas/UserResponse","description":"User who was the target of the action","title":"Target User","x-stream-index":"009"},"target_user_id":{"description":"ID of the user who was the target of the action","title":"Target User ID","type":"string","x-stream-index":"010"},"type":{"description":"Type of moderation action","title":"Type","type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who performed the action","title":"User","x-stream-index":"004"},"user_id":{"description":"ID of the user who performed the action","title":"User ID","type":"string","x-stream-index":"005"}},"required":["id","created_at","type","user_id","reason","custom","target_user_id"],"type":"object"},"ActionSequence":{"properties":{"action":{"type":"string","x-stream-index":"001"},"blur":{"type":"boolean","x-stream-index":"005"},"cooldown_period":{"format":"int32","type":"integer","x-stream-index":"004"},"threshold":{"format":"int32","type":"integer","x-stream-index":"002"},"time_window":{"format":"int32","type":"integer","x-stream-index":"003"},"warning":{"type":"boolean","x-stream-index":"006"},"warning_text":{"type":"string","x-stream-index":"007"}},"required":["action","threshold","time_window","cooldown_period","blur","warning","warning_text"],"type":"object"},"ActivityAddedEvent":{"description":"Emitted when an activity is added to a feed.","nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","description":"The activity that was added","title":"Activity","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"type":"string","x-stream-index":"002.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.activity.added","description":"The type of event: \"feeds.activity.added\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who added the activity","title":"User","x-stream-index":"003.001"}},"required":["activity","type","created_at","custom","fid"],"title":"ActivityAddedEvent","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"},"ActivityDeletedEvent":{"description":"Emitted when an activity is deleted.","nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","description":"The activity that was updated","title":"Activity","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"type":"string","x-stream-index":"002.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.activity.deleted","description":"The type of event: \"feeds.activity.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","x-stream-index":"003.001"}},"required":["activity","type","created_at","custom","fid"],"title":"ActivityDeletedEvent","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"},"ActivityFeedbackRequest":{"description":"Request to provide feedback on an activity","nullable":true,"properties":{"hide":{"description":"Whether to hide this activity","title":"bool","type":"boolean","x-stream-index":"003"},"mute_user":{"description":"Whether to mute the user who created this activity","title":"bool","type":"boolean","x-stream-index":"005"},"reason":{"description":"Reason for the feedback (optional)","maxLength":1000,"title":"string","type":"string","x-stream-index":"006"},"report":{"description":"Whether to report this activity","title":"bool","type":"boolean","x-stream-index":"004"},"show_less":{"description":"Whether to show less content like this","title":"bool","type":"boolean","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"008.002"},"user_id":{"type":"string","x-stream-index":"008.001"}},"title":"Activity Feedback Request","type":"object"},"ActivityFeedbackResponse":{"description":"Response for activity feedback submission","nullable":true,"properties":{"activity_id":{"description":"The ID of the activity that received feedback","title":"string","type":"string","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["activity_id","duration"],"title":"Activity Feedback Response","type":"object"},"ActivityLocation":{"properties":{"lat":{"description":"Latitude coordinate","format":"float","title":"Latitude","type":"number","x-stream-index":"001"},"lng":{"description":"Longitude coordinate","format":"float","title":"Longitude","type":"number","x-stream-index":"002"}},"required":["lat","lng"],"title":"Activity Location","type":"object"},"ActivityMarkEvent":{"description":"Emitted when activities are marked as read, seen, or watched.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"006.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006.001.007"},"feed_visibility":{"type":"string","x-stream-index":"006.003"},"fid":{"type":"string","x-stream-index":"006.002"},"mark_all_read":{"description":"Whether all activities were marked as read","title":"Mark All Read","type":"boolean","x-stream-index":"004"},"mark_all_seen":{"description":"Whether all activities were marked as seen","title":"Mark All Seen","type":"boolean","x-stream-index":"005"},"mark_read":{"description":"The IDs of activities marked as read","items":{"type":"string"},"title":"Mark Read","type":"array","x-stream-index":"001"},"mark_seen":{"description":"The IDs of activities marked as seen","items":{"type":"string"},"title":"Mark Seen","type":"array","x-stream-index":"002"},"mark_watched":{"description":"The IDs of activities marked as watched","items":{"type":"string"},"title":"Mark Watched","type":"array","x-stream-index":"003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"006.001.004"},"type":{"default":"feeds.activity.marked","description":"The type of event: \"feeds.activity.marked\" in this case","title":"Event Type","type":"string","x-stream-index":"006.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who marked the activities","title":"User","x-stream-index":"007.001"}},"required":["type","created_at","custom","fid"],"title":"ActivityMarkEvent","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"},"ActivityPinResponse":{"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","description":"The pinned activity","title":"Activity","x-stream-index":"002"},"created_at":{"description":"When the pin was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"004"},"feed":{"description":"ID of the feed where activity is pinned","title":"Feed ID","type":"string","x-stream-index":"003"},"updated_at":{"description":"When the pin was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who pinned the activity","title":"User","x-stream-index":"001"}},"required":["user","activity","feed","created_at","updated_at"],"title":"Activity Pin","type":"object"},"ActivityPinnedEvent":{"description":"Emitted when an activity is pinned.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"description":"The ID of the feed","title":"Feed ID","type":"string","x-stream-index":"002.002"},"pinned_activity":{"$ref":"#/components/schemas/PinActivityResponse","x-stream-index":"001"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.activity.pinned","description":"The type of event: \"feeds.activity.pinned\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who pinned the activity","title":"User","x-stream-index":"003.001"}},"required":["pinned_activity","type","created_at","custom","fid"],"title":"ActivityPinnedEvent","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"},"ActivityProcessorConfig":{"properties":{"type":{"description":"Type of activity processor (required)","title":"Type","type":"string","x-stream-index":"001"}},"required":["type"],"title":"Activity Processor Configuration","type":"object"},"ActivityReactionAddedEvent":{"description":"Emitted when a reaction is added to an activity.","nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"003.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.001.007"},"feed_visibility":{"type":"string","x-stream-index":"003.003"},"fid":{"type":"string","x-stream-index":"003.002"},"reaction":{"$ref":"#/components/schemas/FeedsReactionResponse","description":"The reaction that was added","title":"Reaction","x-stream-index":"002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.001.004"},"type":{"default":"feeds.activity.reaction.added","description":"The type of event: \"feeds.activity.reaction.added\" in this case","title":"Event Type","type":"string","x-stream-index":"003.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who added the reaction","title":"User","x-stream-index":"004.001"}},"required":["activity","reaction","type","created_at","custom","fid"],"title":"ActivityReactionAddedEvent","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"},"ActivityReactionDeletedEvent":{"description":"Emitted when a reaction is deleted from an activity.","nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"003.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.001.007"},"feed_visibility":{"type":"string","x-stream-index":"003.003"},"fid":{"type":"string","x-stream-index":"003.002"},"reaction":{"$ref":"#/components/schemas/FeedsReactionResponse","x-stream-index":"002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.001.004"},"type":{"default":"feeds.activity.reaction.deleted","description":"The type of the reaction that was removed","title":"Type","type":"string","x-stream-index":"003.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who removed the reaction","title":"User","x-stream-index":"004.001"}},"required":["activity","reaction","type","created_at","custom","fid"],"title":"ActivityReactionDeletedEvent","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"},"ActivityReactionUpdatedEvent":{"description":"Emitted when a reaction is updated on an activity.","nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"003.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.001.007"},"feed_visibility":{"type":"string","x-stream-index":"003.003"},"fid":{"type":"string","x-stream-index":"003.002"},"reaction":{"$ref":"#/components/schemas/FeedsReactionResponse","description":"The reaction that was updated","title":"Reaction","x-stream-index":"002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.001.004"},"type":{"default":"feeds.activity.reaction.updated","description":"The type of event: \"feeds.activity.reaction.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"003.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who updated the reaction","title":"User","x-stream-index":"004.001"}},"required":["activity","reaction","type","created_at","custom","fid"],"title":"ActivityReactionUpdatedEvent","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"},"ActivityRemovedFromFeedEvent":{"description":"Emitted when an activity is removed from a feed.","nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"type":"string","x-stream-index":"002.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.activity.removed_from_feed","description":"The type of event: \"feeds.activity.removed_from_feed\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who removed the activity","title":"User","x-stream-index":"003.001"}},"required":["activity","type","created_at","custom","fid"],"title":"ActivityRemovedFromFeedEvent","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"},"ActivityRequest":{"properties":{"attachments":{"description":"List of attachments for the activity","items":{"$ref":"#/components/schemas/Attachment"},"title":"Attachments","type":"array","x-stream-index":"006"},"custom":{"additionalProperties":{},"description":"Custom data for the activity","title":"Custom Data","type":"object","x-stream-index":"017"},"expires_at":{"description":"Expiration time for the activity","title":"Expires At","type":"string","x-stream-index":"010"},"feeds":{"description":"List of feed IDs to add the activity to","items":{"type":"string"},"maximum":255,"minimum":1,"title":"Feed IDs","type":"array","x-stream-index":"004"},"filter_tags":{"description":"Tags for filtering activities","items":{"type":"string"},"maximum":255,"title":"Filter Tags","type":"array","x-stream-index":"013"},"id":{"description":"Optional ID for the activity","maxLength":255,"title":"Activity ID","type":"string","x-stream-index":"001"},"interest_tags":{"description":"Tags for indicating user interests","items":{"type":"string"},"maximum":255,"title":"Interest Tags","type":"array","x-stream-index":"014"},"location":{"$ref":"#/components/schemas/ActivityLocation","description":"Geographic location related to the activity","title":"Location","x-stream-index":"009"},"mentioned_user_ids":{"description":"List of users mentioned in the activity","items":{"type":"string"},"maximum":255,"title":"Mentioned User IDs","type":"array","x-stream-index":"011"},"parent_id":{"description":"ID of parent activity for replies/comments","maxLength":255,"title":"Parent ID","type":"string","x-stream-index":"015"},"poll_id":{"description":"ID of a poll to attach to activity","title":"Poll ID","type":"string","x-stream-index":"016"},"search_data":{"additionalProperties":{},"description":"Additional data for search indexing","title":"Search Data","type":"object","x-stream-index":"012"},"text":{"description":"Text content of the activity","title":"Text","type":"string","x-stream-index":"005"},"type":{"description":"Type of activity","maxLength":255,"title":"Activity Type","type":"string","x-stream-index":"002"},"user_id":{"description":"ID of the user creating the activity","maxLength":255,"title":"User ID","type":"string","x-stream-index":"003"},"visibility":{"description":"Visibility setting for the activity","enum":["public","private","tag"],"title":"Visibility","type":"string","x-stream-index":"007"},"visibility_tag":{"description":"If visibility is 'tag', this is the tag name and is required","maxLength":32,"title":"Visibility Tag","type":"string","x-stream-index":"008"}},"required":["type","feeds"],"title":"Activity Request","type":"object"},"ActivityResponse":{"properties":{"attachments":{"description":"Media attachments for the activity","items":{"$ref":"#/components/schemas/Attachment"},"title":"Attachments","type":"array","x-stream-index":"009"},"bookmark_count":{"description":"Number of bookmarks on the activity","format":"int32","title":"Bookmark Count","type":"integer","x-stream-index":"028"},"comment_count":{"description":"Number of comments on the activity","format":"int32","title":"Comment Count","type":"integer","x-stream-index":"027"},"comments":{"description":"Comments on this activity","items":{"$ref":"#/components/schemas/CommentResponse"},"title":"Comments","type":"array","x-stream-index":"015"},"created_at":{"description":"When the activity was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"007"},"current_feed":{"$ref":"#/components/schemas/FeedResponse","description":"Feed context for this activity view. If an activity is added only to one feed, it's always set. If an activity is added to multiple feeds, it's only set when calling the GetOrCreateFeed endpoint.","title":"Current Feed","x-stream-index":"035"},"custom":{"additionalProperties":{},"description":"Custom data for the activity","title":"Custom Data","type":"object","x-stream-index":"011"},"deleted_at":{"description":"When the activity was deleted","format":"date-time","title":"Deleted At","type":"number","x-stream-index":"021"},"edited_at":{"description":"When the activity was last edited","format":"date-time","title":"Edited At","type":"number","x-stream-index":"020"},"expires_at":{"description":"When the activity will expire","format":"date-time","title":"Expires At","type":"number","x-stream-index":"022"},"feeds":{"description":"List of feed IDs containing this activity","items":{"type":"string"},"title":"Feeds","type":"array","x-stream-index":"004"},"filter_tags":{"description":"Tags for filtering","items":{"type":"string"},"title":"Filter Tags","type":"array","x-stream-index":"024"},"hidden":{"description":"If this activity is hidden for this user. For premium content where you want to show a preview","title":"Hidden","type":"boolean","x-stream-index":"036"},"id":{"description":"Unique identifier for the activity","title":"ID","type":"string","x-stream-index":"001"},"interest_tags":{"description":"Tags for user interests","items":{"type":"string"},"title":"Interest Tags","type":"array","x-stream-index":"025"},"latest_reactions":{"description":"Recent reactions to the activity","items":{"$ref":"#/components/schemas/FeedsReactionResponse"},"title":"Latest Reactions","type":"array","x-stream-index":"031"},"location":{"$ref":"#/components/schemas/ActivityLocation","description":"Geographic location related to the activity","title":"Location","x-stream-index":"017"},"mentioned_users":{"description":"Users mentioned in the activity","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Mentioned Users","type":"array","x-stream-index":"010"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","description":"Moderation information","title":"Moderation","x-stream-index":"026"},"notification_context":{"additionalProperties":{},"description":"Notification context data for the activity (if this is a reaction, comment, follow, etc.)","title":"Notification Context","type":"object","x-stream-index":"012"},"own_bookmarks":{"description":"Current user's bookmarks for this activity","items":{"$ref":"#/components/schemas/BookmarkResponse"},"title":"Own Bookmarks","type":"array","x-stream-index":"034"},"own_reactions":{"description":"Current user's reactions to this activity","items":{"$ref":"#/components/schemas/FeedsReactionResponse"},"title":"Own Reactions","type":"array","x-stream-index":"033"},"parent":{"$ref":"#/components/schemas/ActivityResponse","description":"Parent activity (if this is a reply/comment)","title":"Parent","x-stream-index":"018"},"poll":{"$ref":"#/components/schemas/PollResponseData","description":"Poll attached to this activity","title":"Poll","x-stream-index":"019"},"popularity":{"description":"Popularity score of the activity","format":"int32","title":"Popularity","type":"integer","x-stream-index":"013"},"reaction_count":{"description":"Number of reactions to the activity","format":"int32","title":"Reaction Count","type":"integer","x-stream-index":"030"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"description":"Grouped reactions by type","title":"Reaction Groups","type":"object","x-stream-index":"032"},"score":{"description":"Ranking score for this activity","format":"float","title":"Score","type":"number","x-stream-index":"014"},"search_data":{"additionalProperties":{},"description":"Data for search indexing","title":"Search Data","type":"object","x-stream-index":"023"},"share_count":{"description":"Number of times the activity was shared","format":"int32","title":"Share Count","type":"integer","x-stream-index":"029"},"text":{"description":"Text content of the activity","title":"Text","type":"string","x-stream-index":"016"},"type":{"description":"Type of activity","title":"Type","type":"string","x-stream-index":"002"},"updated_at":{"description":"When the activity was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"008"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who created the activity","title":"User","x-stream-index":"003"},"visibility":{"description":"Visibility setting for the activity","enum":["public","private","tag"],"title":"Visibility","type":"string","x-stream-index":"005"},"visibility_tag":{"description":"If visibility is 'tag', this is the tag name","title":"Visibility Tag","type":"string","x-stream-index":"006"}},"required":["id","type","user","feeds","visibility","created_at","updated_at","attachments","mentioned_users","custom","popularity","score","comments","search_data","filter_tags","interest_tags","comment_count","bookmark_count","share_count","reaction_count","latest_reactions","reaction_groups","own_reactions","own_bookmarks"],"title":"Base Activity","type":"object"},"ActivitySelectorConfig":{"properties":{"cutoff_time":{"description":"Time threshold for activity selection","format":"date-time","title":"Cutoff Time","type":"number","x-stream-index":"004"},"filter":{"additionalProperties":{},"description":"Filter for activity selection","title":"Filter","type":"object","x-stream-index":"002"},"min_popularity":{"description":"Minimum popularity threshold","format":"int32","title":"Minimum Popularity","type":"integer","x-stream-index":"005"},"sort":{"description":"Sort parameters for activity selection","items":{"$ref":"#/components/schemas/SortParam"},"title":"Sort","type":"array","x-stream-index":"003"},"type":{"description":"Type of selector","title":"Type","type":"string","x-stream-index":"001"}},"title":"Activity Selector Configuration","type":"object"},"ActivityUnpinnedEvent":{"description":"Emitted when an activity is unpinned.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"description":"The ID of the feed","title":"Feed ID","type":"string","x-stream-index":"002.002"},"pinned_activity":{"$ref":"#/components/schemas/PinActivityResponse","x-stream-index":"001"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.activity.unpinned","description":"The type of event: \"feeds.activity.unpinned\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who unpinned the activity","title":"User","x-stream-index":"003.001"}},"required":["pinned_activity","type","created_at","custom","fid"],"title":"ActivityUnpinnedEvent","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"},"ActivityUpdatedEvent":{"description":"Emitted when an activity is updated.","nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","description":"The activity that was updated","title":"Activity","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"type":"string","x-stream-index":"002.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.activity.updated","description":"The type of the event","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who updated the activity","title":"User","x-stream-index":"003.001"}},"required":["activity","type","created_at","custom","fid"],"title":"ActivityUpdatedEvent","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"},"AddActivityRequest":{"nullable":true,"properties":{"attachments":{"description":"List of attachments for the activity","items":{"$ref":"#/components/schemas/Attachment"},"title":"Attachments","type":"array","x-stream-index":"001.006"},"custom":{"additionalProperties":{},"description":"Custom data for the activity","title":"Custom Data","type":"object","x-stream-index":"001.017"},"expires_at":{"description":"Expiration time for the activity","title":"Expires At","type":"string","x-stream-index":"001.010"},"feeds":{"description":"List of feed IDs to add the activity to","items":{"type":"string"},"maximum":255,"minimum":1,"title":"Feed IDs","type":"array","x-stream-index":"001.004"},"filter_tags":{"description":"Tags for filtering activities","items":{"type":"string"},"maximum":255,"title":"Filter Tags","type":"array","x-stream-index":"001.013"},"id":{"description":"Optional ID for the activity","maxLength":255,"title":"Activity ID","type":"string","x-stream-index":"001.001"},"interest_tags":{"description":"Tags for indicating user interests","items":{"type":"string"},"maximum":255,"title":"Interest Tags","type":"array","x-stream-index":"001.014"},"location":{"$ref":"#/components/schemas/ActivityLocation","description":"Geographic location related to the activity","title":"Location","x-stream-index":"001.009"},"mentioned_user_ids":{"description":"List of users mentioned in the activity","items":{"type":"string"},"maximum":255,"title":"Mentioned User IDs","type":"array","x-stream-index":"001.011"},"parent_id":{"description":"ID of parent activity for replies/comments","maxLength":255,"title":"Parent ID","type":"string","x-stream-index":"001.015"},"poll_id":{"description":"ID of a poll to attach to activity","title":"Poll ID","type":"string","x-stream-index":"001.016"},"search_data":{"additionalProperties":{},"description":"Additional data for search indexing","title":"Search Data","type":"object","x-stream-index":"001.012"},"text":{"description":"Text content of the activity","title":"Text","type":"string","x-stream-index":"001.005"},"type":{"description":"Type of activity","maxLength":255,"title":"Activity Type","type":"string","x-stream-index":"001.002"},"user_id":{"description":"ID of the user creating the activity","maxLength":255,"title":"User ID","type":"string","x-stream-index":"001.003"},"visibility":{"description":"Visibility setting for the activity","enum":["public","private","tag"],"title":"Visibility","type":"string","x-stream-index":"001.007"},"visibility_tag":{"description":"If visibility is 'tag', this is the tag name and is required","maxLength":32,"title":"Visibility Tag","type":"string","x-stream-index":"001.008"}},"required":["type","feeds"],"title":"Activity Request","type":"object"},"AddActivityResponse":{"nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","description":"The created activity","title":"Activity","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["activity","duration"],"title":"Add Activity Response","type":"object"},"AddBookmarkRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"description":"Custom data for the bookmark","title":"Custom Data","type":"object","x-stream-index":"004"},"folder_id":{"description":"ID of the folder to add the bookmark to","maxLength":255,"title":"Folder ID","type":"string","x-stream-index":"002"},"new_folder":{"$ref":"#/components/schemas/AddFolderRequest","description":"Create a new folder for this bookmark","title":"New Folder","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"005.002"},"user_id":{"type":"string","x-stream-index":"005.001"}},"title":"Add Bookmark Request","type":"object"},"AddBookmarkResponse":{"nullable":true,"properties":{"bookmark":{"$ref":"#/components/schemas/BookmarkResponse","description":"The created bookmark","title":"Bookmark","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["bookmark","duration"],"title":"Add Bookmark Response","type":"object"},"AddCommentReactionRequest":{"nullable":true,"properties":{"create_notification_activity":{"description":"Whether to create a notification activity for this reaction","title":"boolean","type":"boolean","x-stream-index":"004"},"custom":{"additionalProperties":{},"description":"Optional custom data to add to the reaction","title":"object","type":"object","x-stream-index":"003"},"skip_push":{"type":"boolean","x-stream-index":"005"},"type":{"description":"The type of reaction, eg upvote, like, ...","maxLength":255,"title":"string","type":"string","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"007.002"},"user_id":{"type":"string","x-stream-index":"007.001"}},"required":["type"],"type":"object"},"AddCommentReactionResponse":{"nullable":true,"properties":{"comment":{"$ref":"#/components/schemas/CommentResponse","description":"The comment the reaction was added to","title":"object","x-stream-index":"001"},"duration":{"description":"Duration of the request","title":"string","type":"string","x-stream-index":"003.001"},"reaction":{"$ref":"#/components/schemas/FeedsReactionResponse","description":"The created or updated reaction","title":"object","x-stream-index":"002"}},"required":["comment","reaction","duration"],"type":"object"},"AddCommentRequest":{"nullable":true,"properties":{"attachments":{"description":"Media attachments for the reply","items":{"$ref":"#/components/schemas/Attachment"},"title":"Attachments","type":"array","x-stream-index":"004"},"comment":{"description":"Text content of the comment","title":"Comment","type":"string","x-stream-index":"003"},"create_notification_activity":{"description":"Whether to create a notification activity for this comment","title":"Create Notification Activity","type":"boolean","x-stream-index":"008"},"custom":{"additionalProperties":{},"description":"Custom data for the comment","title":"Custom Data","type":"object","x-stream-index":"007"},"mentioned_user_ids":{"description":"List of users mentioned in the reply","items":{"type":"string"},"maximum":255,"title":"Mentioned User IDs","type":"array","x-stream-index":"005"},"object_id":{"description":"ID of the object to comment on","title":"Object ID","type":"string","x-stream-index":"001"},"object_type":{"description":"Type of the object to comment on","title":"Object Type","type":"string","x-stream-index":"002"},"parent_id":{"description":"ID of parent comment for replies","title":"Parent ID","type":"string","x-stream-index":"006"},"skip_push":{"type":"boolean","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"010.002"},"user_id":{"type":"string","x-stream-index":"010.001"}},"required":["object_id","object_type","comment"],"title":"Add Comment Request","type":"object"},"AddCommentResponse":{"nullable":true,"properties":{"comment":{"$ref":"#/components/schemas/CommentResponse","description":"The created comment","title":"Comment","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["comment","duration"],"title":"Add Comment Response","type":"object"},"AddCommentsBatchRequest":{"nullable":true,"properties":{"comments":{"description":"List of comments to add","items":{"$ref":"#/components/schemas/AddCommentRequest"},"title":"Comments","type":"array","x-stream-index":"001"}},"required":["comments"],"title":"Add Comments Batch Request","type":"object"},"AddCommentsBatchResponse":{"nullable":true,"properties":{"comments":{"description":"List of comments added","items":{"$ref":"#/components/schemas/CommentResponse"},"title":"Comments","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["comments","duration"],"title":"Add Comments Batch Response","type":"object"},"AddFolderRequest":{"properties":{"custom":{"additionalProperties":{},"description":"Custom data for the folder","title":"Custom Data","type":"object","x-stream-index":"002"},"name":{"description":"Name of the folder","maxLength":255,"title":"Name","type":"string","x-stream-index":"001"}},"required":["name"],"title":"Add Folder Request","type":"object"},"AddReactionRequest":{"nullable":true,"properties":{"create_notification_activity":{"description":"Whether to create a notification activity for this reaction","title":"Create Notification Activity","type":"boolean","x-stream-index":"004"},"custom":{"additionalProperties":{},"description":"Custom data for the reaction","title":"Custom Data","type":"object","x-stream-index":"003"},"skip_push":{"type":"boolean","x-stream-index":"005"},"type":{"description":"Type of reaction","maxLength":255,"title":"Reaction Type","type":"string","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"006.002"},"user_id":{"type":"string","x-stream-index":"006.001"}},"required":["type"],"title":"Add Reaction Request","type":"object"},"AddReactionResponse":{"nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"reaction":{"$ref":"#/components/schemas/FeedsReactionResponse","description":"The created reaction","title":"Reaction","x-stream-index":"002"}},"required":["activity","reaction","duration"],"title":"Add Reaction Response","type":"object"},"AggregatedActivityResponse":{"properties":{"activities":{"description":"List of activities in this aggregation","items":{"$ref":"#/components/schemas/ActivityResponse"},"title":"Activities","type":"array","x-stream-index":"001"},"activity_count":{"description":"Number of activities in this aggregation","format":"int32","title":"Activity Count","type":"integer","x-stream-index":"002"},"created_at":{"description":"When the aggregation was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"006"},"group":{"description":"Grouping identifier","title":"Group","type":"string","x-stream-index":"004"},"score":{"description":"Ranking score for this aggregation","format":"float","title":"Score","type":"number","x-stream-index":"005"},"updated_at":{"description":"When the aggregation was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"007"},"user_count":{"description":"Number of unique users in this aggregation","format":"int32","title":"User Count","type":"integer","x-stream-index":"003"}},"required":["activities","activity_count","user_count","group","score","created_at","updated_at"],"title":"Aggregated Activity","type":"object"},"AggregationConfig":{"properties":{"format":{"description":"Format for activity aggregation","title":"Format","type":"string","x-stream-index":"001"}},"title":"Aggregation Configuration","type":"object"},"AppResponseFields":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"019"},"async_url_enrich_enabled":{"type":"boolean","x-stream-index":"017"},"auto_translation_enabled":{"type":"boolean","x-stream-index":"020"},"before_message_send_hook_url":{"type":"string","x-stream-index":"021"},"call_types":{"additionalProperties":{"$ref":"#/components/schemas/CallType"},"type":"object","x-stream-index":"007"},"campaign_enabled":{"type":"boolean","x-stream-index":"034"},"cdn_expiration_seconds":{"format":"int32","type":"integer","x-stream-index":"037"},"channel_configs":{"additionalProperties":{"$ref":"#/components/schemas/ChannelConfig"},"type":"object","x-stream-index":"006"},"custom_action_handler_url":{"type":"string","x-stream-index":"022"},"datadog_info":{"$ref":"#/components/schemas/DataDogInfo","x-stream-index":"040"},"disable_auth_checks":{"type":"boolean","x-stream-index":"011"},"disable_permissions_checks":{"type":"boolean","x-stream-index":"012"},"enforce_unique_usernames":{"type":"string","x-stream-index":"023"},"event_hooks":{"items":{"$ref":"#/components/schemas/EventHook"},"type":"array","x-stream-index":"045"},"file_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","x-stream-index":"030"},"geofences":{"items":{"$ref":"#/components/schemas/GeofenceResponse"},"type":"array","x-stream-index":"039"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"033"},"guest_user_creation_disabled":{"type":"boolean","x-stream-index":"043"},"image_moderation_enabled":{"type":"boolean","x-stream-index":"016"},"image_moderation_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"018"},"image_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","x-stream-index":"031"},"moderation_bulk_submit_action_enabled":{"type":"boolean","x-stream-index":"048"},"moderation_dashboard_preferences":{"$ref":"#/components/schemas/ModerationDashboardPreferences","x-stream-index":"044"},"moderation_enabled":{"type":"boolean","x-stream-index":"041"},"moderation_llm_configurability_enabled":{"type":"boolean","x-stream-index":"049"},"moderation_multitenant_blocklist_enabled":{"type":"boolean","x-stream-index":"042"},"moderation_webhook_url":{"type":"string","x-stream-index":"005"},"multi_tenant_enabled":{"type":"boolean","x-stream-index":"015"},"name":{"type":"string","x-stream-index":"001"},"organization":{"type":"string","x-stream-index":"002"},"permission_version":{"type":"string","x-stream-index":"013"},"policies":{"additionalProperties":{"items":{"$ref":"#/components/schemas/Policy"},"type":"array"},"type":"object","x-stream-index":"008"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationFields","x-stream-index":"003"},"reminders_interval":{"format":"int32","type":"integer","x-stream-index":"036"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"032"},"sns_key":{"type":"string","x-stream-index":"028"},"sns_secret":{"type":"string","x-stream-index":"029"},"sns_topic_arn":{"type":"string","x-stream-index":"027"},"sqs_key":{"type":"string","x-stream-index":"025"},"sqs_secret":{"type":"string","x-stream-index":"026"},"sqs_url":{"type":"string","x-stream-index":"024"},"suspended":{"type":"boolean","x-stream-index":"009"},"suspended_explanation":{"type":"string","x-stream-index":"010"},"use_hook_v2":{"type":"boolean","x-stream-index":"046"},"user_response_time_enabled":{"type":"boolean","x-stream-index":"047"},"user_search_disallowed_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"014"},"webhook_events":{"items":{"type":"string"},"type":"array","x-stream-index":"035"},"webhook_url":{"type":"string","x-stream-index":"004"}},"required":["name","organization","push_notifications","webhook_url","moderation_webhook_url","channel_configs","call_types","policies","suspended","suspended_explanation","disable_auth_checks","disable_permissions_checks","permission_version","user_search_disallowed_roles","multi_tenant_enabled","image_moderation_enabled","async_url_enrich_enabled","auto_translation_enabled","custom_action_handler_url","enforce_unique_usernames","sqs_url","sqs_key","sqs_secret","sns_topic_arn","sns_key","sns_secret","file_upload_config","image_upload_config","grants","campaign_enabled","webhook_events","reminders_interval","cdn_expiration_seconds","video_provider","moderation_enabled","moderation_multitenant_blocklist_enabled","guest_user_creation_disabled","event_hooks","use_hook_v2","user_response_time_enabled","moderation_bulk_submit_action_enabled","moderation_llm_configurability_enabled"],"type":"object"},"AsyncBulkImageModerationEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"003.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.007"},"finished_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.004"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"task_id":{"type":"string","x-stream-index":"002.001"},"type":{"default":"export.bulk_image_moderation.success","type":"string","x-stream-index":"003.002"},"url":{"type":"string","x-stream-index":"001"}},"required":["url","task_id","started_at","finished_at","type","created_at","custom"],"title":"AsyncBulkImageModerationEvent","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"},"AsyncExportErrorEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"003.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.007"},"error":{"type":"string","x-stream-index":"001"},"finished_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.004"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"task_id":{"type":"string","x-stream-index":"002.001"},"type":{"default":"export.bulk_image_moderation.error","type":"string","x-stream-index":"003.002"}},"required":["error","task_id","started_at","finished_at","type","created_at","custom"],"title":"AsyncExportErrorEvent","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"},"AsyncExportModerationLogsEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"003.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.007"},"finished_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.004"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"task_id":{"type":"string","x-stream-index":"002.001"},"type":{"default":"export.moderation_logs.success","type":"string","x-stream-index":"003.002"},"url":{"type":"string","x-stream-index":"001"}},"required":["url","task_id","started_at","finished_at","type","created_at","custom"],"title":"AsyncExportModerationLogsEvent","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"},"AsyncModerationCallbackConfig":{"properties":{"mode":{"enum":["CALLBACK_MODE_NONE","CALLBACK_MODE_REST","CALLBACK_MODE_TWIRP"],"type":"string","x-stream-index":"002"},"server_url":{"type":"string","x-stream-index":"001"}},"type":"object"},"AsyncModerationConfiguration":{"properties":{"callback":{"$ref":"#/components/schemas/AsyncModerationCallbackConfig","x-stream-index":"002"},"timeout_ms":{"format":"int32","type":"integer","x-stream-index":"001"}},"type":"object"},"Attachment":{"description":"An attachment is a message object that represents a file uploaded by a user.","nullable":true,"properties":{"actions":{"items":{"$ref":"#/components/schemas/Action"},"type":"array","x-stream-index":"015"},"asset_url":{"type":"string","x-stream-index":"017"},"author_icon":{"type":"string","x-stream-index":"007"},"author_link":{"type":"string","x-stream-index":"006"},"author_name":{"type":"string","x-stream-index":"005"},"color":{"type":"string","x-stream-index":"003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"018"},"fallback":{"type":"string","x-stream-index":"002"},"fields":{"items":{"$ref":"#/components/schemas/Field"},"type":"array","x-stream-index":"016"},"footer":{"type":"string","x-stream-index":"013"},"footer_icon":{"type":"string","x-stream-index":"014"},"giphy":{"$ref":"#/components/schemas/Images","x-stream-index":"019"},"image_url":{"type":"string","x-stream-index":"011"},"og_scrape_url":{"type":"string","x-stream-index":"020"},"original_height":{"format":"int32","type":"integer","x-stream-index":"022"},"original_width":{"format":"int32","type":"integer","x-stream-index":"021"},"pretext":{"type":"string","x-stream-index":"004"},"text":{"type":"string","x-stream-index":"010"},"thumb_url":{"type":"string","x-stream-index":"012"},"title":{"type":"string","x-stream-index":"008"},"title_link":{"type":"string","x-stream-index":"009"},"type":{"description":"Attachment type (e.g. image, video, url)","title":"Type","type":"string","x-stream-index":"001"}},"required":["custom"],"title":"Attachment","type":"object","x-stream-docs-page-id":"file_uploads"},"AudioSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"001"},"default_device":{"enum":["speaker","earpiece"],"type":"string","x-stream-index":"006"},"mic_default_on":{"type":"boolean","x-stream-index":"004"},"noise_cancellation":{"$ref":"#/components/schemas/NoiseCancellationSettings","x-stream-index":"007"},"opus_dtx_enabled":{"type":"boolean","x-stream-index":"002"},"redundant_coding_enabled":{"type":"boolean","x-stream-index":"003"},"speaker_default_on":{"type":"boolean","x-stream-index":"005"}},"required":["access_request_enabled","opus_dtx_enabled","redundant_coding_enabled","mic_default_on","speaker_default_on","default_device"],"type":"object"},"AudioSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"001"},"default_device":{"enum":["speaker","earpiece"],"type":"string","x-stream-index":"006"},"mic_default_on":{"type":"boolean","x-stream-index":"004"},"noise_cancellation":{"$ref":"#/components/schemas/NoiseCancellationSettings","x-stream-index":"007"},"opus_dtx_enabled":{"type":"boolean","x-stream-index":"002"},"redundant_coding_enabled":{"type":"boolean","x-stream-index":"003"},"speaker_default_on":{"type":"boolean","x-stream-index":"005"}},"required":["access_request_enabled","opus_dtx_enabled","redundant_coding_enabled","mic_default_on","speaker_default_on","default_device"],"type":"object"},"AutomodPlatformCircumventionConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AutomodRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"AutomodRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"003"},"label":{"type":"string","x-stream-index":"001"},"threshold":{"format":"float","maximum":1,"minimum":0,"type":"number","x-stream-index":"002"}},"required":["label","threshold","action"],"type":"object"},"AutomodSemanticFiltersConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AutomodSemanticFiltersRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"AutomodSemanticFiltersRule":{"properties":{"action":{"enum":["flag","shadow","remove"],"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"threshold":{"format":"float","maximum":1,"minimum":0,"type":"number","x-stream-index":"002"}},"required":["name","threshold","action"],"type":"object"},"AutomodToxicityConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AutomodRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"AzureRequest":{"description":"Config for creating Azure Blob Storage storage","properties":{"abs_account_name":{"description":"The account name","title":"AccountName","type":"string","x-stream-index":"001"},"abs_client_id":{"description":"The client id","title":"ClientID","type":"string","x-stream-index":"003"},"abs_client_secret":{"description":"The client secret","title":"ClientSecret","type":"string","x-stream-index":"004"},"abs_tenant_id":{"description":"The tenant id","title":"TenantID","type":"string","x-stream-index":"002"}},"required":["abs_account_name","abs_tenant_id","abs_client_id","abs_client_secret"],"title":"AzureRequest","type":"object"},"BackstageSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"BackstageSettingsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"Ban":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"012"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"011"},"expires":{"format":"date-time","type":"number","x-stream-index":"007"},"reason":{"type":"string","x-stream-index":"008"},"shadow":{"type":"boolean","x-stream-index":"009"},"target":{"$ref":"#/components/schemas/User","x-stream-index":"006"}},"required":["shadow","created_at"],"type":"object"},"BanActionRequest":{"properties":{"channel_ban_only":{"type":"boolean","x-stream-index":"003"},"delete_messages":{"enum":["soft","pruning","hard"],"type":"string","x-stream-index":"005"},"ip_ban":{"type":"boolean","x-stream-index":"004"},"reason":{"type":"string","x-stream-index":"002"},"shadow":{"type":"boolean","x-stream-index":"001"},"timeout":{"format":"int32","type":"integer","x-stream-index":"006"}},"type":"object"},"BanOptions":{"properties":{"duration":{"format":"int32","type":"integer","x-stream-index":"001"},"ip_ban":{"type":"boolean","x-stream-index":"004"},"reason":{"type":"string","x-stream-index":"002"},"shadow_ban":{"type":"boolean","x-stream-index":"003"}},"type":"object"},"BanRequest":{"nullable":true,"properties":{"banned_by":{"$ref":"#/components/schemas/UserRequest","description":"Details about the user performing the ban","title":"Banned By","x-stream-index":"008"},"banned_by_id":{"description":"ID of the user performing the ban","title":"Banned By ID","type":"string","x-stream-index":"007"},"channel_cid":{"description":"Channel where the ban applies","title":"Channel CID","type":"string","x-stream-index":"004"},"delete_messages":{"enum":["soft","pruning","hard"],"type":"string","x-stream-index":"009"},"ip_ban":{"description":"Whether to ban the user's IP address","title":"IP Ban","type":"boolean","x-stream-index":"006"},"reason":{"description":"Optional explanation for the ban","title":"Reason","type":"string","x-stream-index":"003"},"shadow":{"description":"Whether this is a shadow ban","title":"Shadow","type":"boolean","x-stream-index":"005"},"target_user_id":{"description":"ID of the user to ban","title":"Target User ID","type":"string","x-stream-index":"001"},"timeout":{"description":"Duration of the ban in minutes","minimum":0,"title":"Timeout","type":"integer","x-stream-index":"002"}},"required":["target_user_id"],"type":"object"},"BanResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"BlockContentOptions":{"properties":{"reason":{"type":"string","x-stream-index":"001"}},"type":"object"},"BlockListConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/BlockListRule"},"maximum":10,"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"BlockListOptions":{"properties":{"behavior":{"description":"Blocklist behavior","enum":["flag","block","shadow_block"],"title":"Behavior","type":"string","x-stream-index":"002"},"blocklist":{"description":"Blocklist name","title":"Blocklist","type":"string","x-stream-index":"001"}},"required":["blocklist","behavior"],"type":"object"},"BlockListResponse":{"description":"Block list contains restricted words","properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001"},"id":{"type":"string","x-stream-index":"003"},"name":{"description":"Block list name","title":"Name","type":"string","x-stream-index":"004"},"team":{"type":"string","x-stream-index":"007"},"type":{"description":"Block list type.","title":"Type","type":"string","x-stream-index":"005"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"002"},"words":{"description":"List of words to block","items":{"type":"string"},"title":"Words","type":"array","x-stream-index":"006"}},"required":["name","type","words"],"title":"Block list","type":"object","x-stream-docs-page-id":"block_lists"},"BlockListRule":{"properties":{"action":{"enum":["flag","mask_flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"002"}},"required":["name","team","action"],"type":"object"},"BlockUsersRequest":{"nullable":true,"properties":{"blocked_user_id":{"description":"User id to block","title":"BlockedUserID","type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"required":["blocked_user_id"],"type":"object"},"BlockUsersResponse":{"nullable":true,"properties":{"blocked_by_user_id":{"description":"User id who blocked another user","title":"BlockedByUserID","type":"string","x-stream-index":"002"},"blocked_user_id":{"description":"User id who got blocked","title":"BlockedUserID","type":"string","x-stream-index":"003"},"created_at":{"description":"Timestamp when the user was blocked","format":"date-time","title":"CreatedAt","type":"number","x-stream-index":"004"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration","blocked_by_user_id","blocked_user_id","created_at"],"type":"object"},"BlockedUserResponse":{"nullable":true,"properties":{"blocked_user":{"$ref":"#/components/schemas/UserResponse","description":"User who got blocked","title":"User","x-stream-index":"003"},"blocked_user_id":{"description":"ID of the user who got blocked","title":"UserID","type":"string","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who blocked another user","title":"User","x-stream-index":"001"},"user_id":{"description":"ID of the user who blocked another user","title":"UserID","type":"string","x-stream-index":"002"}},"required":["user","user_id","blocked_user","blocked_user_id","created_at"],"type":"object"},"BodyguardRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"},"severity_rules":{"items":{"$ref":"#/components/schemas/BodyguardSeverityRule"},"type":"array","x-stream-index":"003"}},"required":["label","action","severity_rules"],"type":"object"},"BodyguardSeverityRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"severity":{"enum":["low","medium","high","critical"],"type":"string","x-stream-index":"001"}},"required":["severity","action"],"type":"object"},"BookmarkAddedEvent":{"description":"Emitted when a user bookmarks an activity.","nullable":true,"properties":{"bookmark":{"$ref":"#/components/schemas/BookmarkResponse","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.bookmark.added","description":"The type of event: \"feeds.bookmark.added\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who added the bookmark","title":"User","x-stream-index":"003.001"}},"required":["bookmark","type","created_at","custom"],"title":"BookmarkAddedEvent","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"},"BookmarkDeletedEvent":{"description":"Emitted when a user deletes a bookmark from an activity.","nullable":true,"properties":{"bookmark":{"$ref":"#/components/schemas/BookmarkResponse","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.bookmark.deleted","description":"The type of event: \"feeds.bookmark.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who removed the bookmark","title":"User","x-stream-index":"003.001"}},"required":["bookmark","type","created_at","custom"],"title":"BookmarkDeletedEvent","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"},"BookmarkFolderDeletedEvent":{"description":"Emitted when a bookmark folder is deleted.","nullable":true,"properties":{"bookmark_folder":{"$ref":"#/components/schemas/BookmarkFolderResponse","description":"The bookmark folder that was deleted","title":"Bookmark Folder","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.bookmark_folder.deleted","description":"The type of event: \"feeds.bookmark_folder.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who deleted the bookmark folder","title":"User","x-stream-index":"003.001"}},"required":["bookmark_folder","type","created_at","custom"],"title":"BookmarkFolderDeletedEvent","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"},"BookmarkFolderResponse":{"properties":{"created_at":{"description":"When the folder was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"004"},"custom":{"additionalProperties":{},"description":"Custom data for the folder","title":"Custom Data","type":"object","x-stream-index":"003"},"id":{"description":"Unique identifier for the folder","title":"ID","type":"string","x-stream-index":"001"},"name":{"description":"Name of the folder","title":"Name","type":"string","x-stream-index":"002"},"updated_at":{"description":"When the folder was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"005"}},"required":["id","name","created_at","updated_at"],"title":"Bookmark Folder","type":"object"},"BookmarkFolderUpdatedEvent":{"description":"Emitted when a bookmark folder is updated.","nullable":true,"properties":{"bookmark_folder":{"$ref":"#/components/schemas/BookmarkFolderResponse","description":"The bookmark folder that was updated","title":"Bookmark Folder","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.bookmark_folder.updated","description":"The type of event: \"feeds.bookmark_folder.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who updated the bookmark folder","title":"User","x-stream-index":"003.001"}},"required":["bookmark_folder","type","created_at","custom"],"title":"BookmarkFolderUpdatedEvent","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"},"BookmarkResponse":{"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","description":"The bookmarked activity","title":"Activity","x-stream-index":"002"},"created_at":{"description":"When the bookmark was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"005"},"custom":{"additionalProperties":{},"description":"Custom data for the bookmark","title":"Custom Data","type":"object","x-stream-index":"004"},"folder":{"$ref":"#/components/schemas/BookmarkFolderResponse","description":"Folder containing this bookmark","title":"Folder","x-stream-index":"003"},"updated_at":{"description":"When the bookmark was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"006"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who created the bookmark","title":"User","x-stream-index":"001"}},"required":["user","activity","created_at","updated_at"],"title":"Bookmark","type":"object"},"BookmarkUpdatedEvent":{"description":"Emitted when a user updates a bookmark.","nullable":true,"properties":{"bookmark":{"$ref":"#/components/schemas/BookmarkResponse","description":"The updated bookmark","title":"Bookmark","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.bookmark.updated","description":"The type of event: \"feeds.bookmark.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who updated the bookmark","title":"User","x-stream-index":"003.001"}},"required":["bookmark","type","created_at","custom"],"title":"BookmarkUpdatedEvent","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"},"BroadcastSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettings","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettings","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"BroadcastSettingsResponse":{"description":"BroadcastSettingsResponse is the payload for broadcasting settings","properties":{"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettingsResponse","title":"HLS","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettingsResponse","title":"RTMP","x-stream-index":"003"}},"required":["enabled","hls","rtmp"],"title":"BroadcastSettingsResponse","type":"object"},"BulkImageModerationRequest":{"nullable":true,"properties":{"csv_file":{"description":"URL to CSV file containing image URLs to moderate","title":"string","type":"string","x-stream-index":"001"}},"required":["csv_file"],"type":"object"},"BulkImageModerationResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"task_id":{"description":"ID of the task for processing the bulk image moderation","title":"string","type":"string","x-stream-index":"001"}},"required":["task_id","duration"],"type":"object"},"Call":{"properties":{"AppPK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"002"},"Backstage":{"type":"boolean","writeOnly":true,"x-stream-index":"023"},"BlockedUserIDs":{"items":{"type":"string"},"type":"array","writeOnly":true,"x-stream-index":"018"},"BlockedUsers":{"items":{"$ref":"#/components/schemas/User"},"type":"array","writeOnly":true,"x-stream-index":"019"},"CID":{"type":"string","writeOnly":true,"x-stream-index":"005"},"CallType":{"$ref":"#/components/schemas/CallType","x-stream-index":"020"},"ChannelCID":{"type":"string","writeOnly":true,"x-stream-index":"032"},"CreatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"013"},"CreatedBy":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"CreatedByUserID":{"type":"string","writeOnly":true,"x-stream-index":"007"},"CurrentSessionID":{"type":"string","writeOnly":true,"x-stream-index":"024"},"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"012"},"DeletedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"028"},"EgressUpdatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"027"},"Egresses":{"items":{"$ref":"#/components/schemas/CallEgress"},"type":"array","writeOnly":true,"x-stream-index":"015"},"EndedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"017"},"ID":{"type":"string","writeOnly":true,"x-stream-index":"004"},"JoinAheadTimeSeconds":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"031"},"LastHeartbeatAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"030"},"LastSessionID":{"type":"string","writeOnly":true,"x-stream-index":"025"},"MemberCount":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"010"},"MemberLookup":{"$ref":"#/components/schemas/MemberLookup","x-stream-index":"011"},"Members":{"items":{"$ref":"#/components/schemas/CallMember"},"type":"array","writeOnly":true,"x-stream-index":"009"},"Session":{"$ref":"#/components/schemas/CallSession","x-stream-index":"026"},"Settings":{"$ref":"#/components/schemas/CallSettings","x-stream-index":"022"},"SettingsOverrides":{"$ref":"#/components/schemas/CallSettings","x-stream-index":"021"},"StartsAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"016"},"Team":{"type":"string","writeOnly":true,"x-stream-index":"006"},"ThumbnailURL":{"type":"string","writeOnly":true,"x-stream-index":"029"},"Type":{"type":"string","writeOnly":true,"x-stream-index":"003"},"UpdatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"014"}},"required":["AppPK","Type","ID","CID","Team","CreatedByUserID","Members","Custom","CreatedAt","UpdatedAt","Egresses","BlockedUserIDs","BlockedUsers","Backstage","CurrentSessionID","LastSessionID","ThumbnailURL","ChannelCID"],"type":"object"},"CallEgress":{"nullable":true,"properties":{"app_pk":{"format":"int32","type":"integer","x-stream-index":"002"},"call_id":{"type":"string","x-stream-index":"004"},"call_type":{"type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/EgressTaskConfig","x-stream-index":"007"},"egress_id":{"type":"string","x-stream-index":"005"},"egress_type":{"type":"string","x-stream-index":"006"},"instance_ip":{"type":"string","x-stream-index":"008"},"started_at":{"format":"date-time","type":"number","x-stream-index":"010"},"state":{"type":"string","x-stream-index":"009"},"stopped_at":{"format":"date-time","type":"number","x-stream-index":"011"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"012"}},"required":["app_pk","call_type","call_id","egress_id","egress_type","instance_ip","state","started_at","updated_at"],"type":"object"},"CallIngressResponse":{"description":"CallIngressResponse is the payload for ingress settings","properties":{"rtmp":{"$ref":"#/components/schemas/RTMPIngress","title":"RTMP","x-stream-index":"001"}},"required":["rtmp"],"title":"CallIngressResponse","type":"object"},"CallMember":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"010"},"role":{"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["user_id","role","custom","created_at","updated_at"],"type":"object"},"CallParticipant":{"nullable":true,"properties":{"JoinedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"004"},"Role":{"type":"string","writeOnly":true,"x-stream-index":"002"},"UserSessionID":{"type":"string","writeOnly":true,"x-stream-index":"003"},"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"001.046"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"001.017"},"banned":{"type":"boolean","x-stream-index":"001.016"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.013"},"id":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"001.023"},"language":{"type":"string","x-stream-index":"001.035"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"001.022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"001.026"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.042"},"role":{"type":"string","x-stream-index":"001.004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.005"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.009"}},"required":["id","role","teams_role","custom","banned","online","Role","UserSessionID","JoinedAt"],"type":"object"},"CallParticipantResponse":{"properties":{"joined_at":{"format":"date-time","type":"number","x-stream-index":"004"},"role":{"type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"},"user_session_id":{"type":"string","x-stream-index":"002"}},"required":["user","user_session_id","role","joined_at"],"type":"object"},"CallResponse":{"description":"Represents a call","properties":{"backstage":{"type":"boolean","x-stream-index":"016"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"018"},"captioning":{"type":"boolean","x-stream-index":"013"},"channel_cid":{"type":"string","x-stream-index":"024"},"cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"The user that created the call","title":"Created By","x-stream-index":"007"},"current_session_id":{"type":"string","x-stream-index":"005"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"008"},"egress":{"$ref":"#/components/schemas/EgressResponse","x-stream-index":"021"},"ended_at":{"description":"Date/time when the call ended","format":"date-time","title":"Ended At","type":"number","x-stream-index":"014"},"id":{"description":"Call ID","title":"ID","type":"string","x-stream-index":"003"},"ingress":{"$ref":"#/components/schemas/CallIngressResponse","x-stream-index":"019"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"023"},"recording":{"type":"boolean","x-stream-index":"011"},"session":{"$ref":"#/components/schemas/CallSessionResponse","x-stream-index":"020"},"settings":{"$ref":"#/components/schemas/CallSettingsResponse","x-stream-index":"017"},"starts_at":{"description":"Date/time when the call will start","format":"date-time","title":"Starts At","type":"number","x-stream-index":"015"},"team":{"type":"string","x-stream-index":"006"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailResponse","x-stream-index":"022"},"transcribing":{"type":"boolean","x-stream-index":"012"},"type":{"description":"The type of call","title":"Type","type":"string","x-stream-index":"002"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"}},"required":["type","id","cid","current_session_id","created_by","custom","created_at","updated_at","recording","transcribing","captioning","backstage","settings","blocked_user_ids","ingress","egress"],"title":"CallResponse","type":"object"},"CallSession":{"properties":{"AcceptedBy":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","writeOnly":true,"x-stream-index":"008"},"ActiveSFUs":{"items":{"$ref":"#/components/schemas/SFUIDLastSeen"},"type":"array","writeOnly":true,"x-stream-index":"016"},"AnonymousParticipantCount":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"019"},"AppPK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"002.001"},"CallID":{"type":"string","writeOnly":true,"x-stream-index":"002.003"},"CallType":{"type":"string","writeOnly":true,"x-stream-index":"002.002"},"CreatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"003"},"DeletedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"004"},"EndedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"006"},"LiveEndedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"013"},"LiveStartedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"012"},"MissedBy":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","writeOnly":true,"x-stream-index":"010"},"Participants":{"items":{"$ref":"#/components/schemas/CallParticipant"},"type":"array","writeOnly":true,"x-stream-index":"011"},"ParticipantsCountByRole":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","writeOnly":true,"x-stream-index":"018"},"RejectedBy":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","writeOnly":true,"x-stream-index":"009"},"RingAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"007"},"SFUIDs":{"items":{"type":"string"},"type":"array","writeOnly":true,"x-stream-index":"015"},"SessionID":{"type":"string","writeOnly":true,"x-stream-index":"002.004"},"StartedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"005"},"TimerEndsAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"014"},"UserPermissionOverrides":{"additionalProperties":{"additionalProperties":{"type":"boolean"},"type":"object"},"type":"object","writeOnly":true,"x-stream-index":"017"}},"required":["AppPK","CallType","CallID","SessionID","CreatedAt","AcceptedBy","RejectedBy","MissedBy","Participants","SFUIDs","ActiveSFUs","UserPermissionOverrides","ParticipantsCountByRole","AnonymousParticipantCount"],"type":"object"},"CallSessionResponse":{"properties":{"accepted_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"008"},"anonymous_participant_count":{"format":"int32","type":"integer","x-stream-index":"006"},"ended_at":{"format":"date-time","type":"number","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"live_ended_at":{"format":"date-time","type":"number","x-stream-index":"011"},"live_started_at":{"format":"date-time","type":"number","x-stream-index":"010"},"missed_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"009"},"participants":{"items":{"$ref":"#/components/schemas/CallParticipantResponse"},"type":"array","x-stream-index":"004"},"participants_count_by_role":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"005"},"rejected_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"007"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002"},"timer_ends_at":{"format":"date-time","type":"number","x-stream-index":"012"}},"required":["id","participants","participants_count_by_role","anonymous_participant_count","rejected_by","accepted_by","missed_by"],"type":"object"},"CallSettings":{"properties":{"audio":{"$ref":"#/components/schemas/AudioSettings","x-stream-index":"001"},"backstage":{"$ref":"#/components/schemas/BackstageSettings","x-stream-index":"002"},"broadcasting":{"$ref":"#/components/schemas/BroadcastSettings","x-stream-index":"007"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordSettings","x-stream-index":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettings","x-stream-index":"008"},"ingress":{"$ref":"#/components/schemas/IngressSettings","x-stream-index":"014"},"limits":{"$ref":"#/components/schemas/LimitsSettings","x-stream-index":"012"},"recording":{"$ref":"#/components/schemas/RecordSettings","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettings","x-stream-index":"010"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettings","x-stream-index":"004"},"session":{"$ref":"#/components/schemas/SessionSettings","x-stream-index":"013"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettings","x-stream-index":"011"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettings","x-stream-index":"009"},"video":{"$ref":"#/components/schemas/VideoSettings","x-stream-index":"003"}},"type":"object"},"CallSettingsResponse":{"properties":{"audio":{"$ref":"#/components/schemas/AudioSettingsResponse","x-stream-index":"001"},"backstage":{"$ref":"#/components/schemas/BackstageSettingsResponse","x-stream-index":"002"},"broadcasting":{"$ref":"#/components/schemas/BroadcastSettingsResponse","x-stream-index":"003"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordingSettingsResponse","x-stream-index":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettingsResponse","x-stream-index":"004"},"ingress":{"$ref":"#/components/schemas/IngressSettingsResponse","x-stream-index":"014"},"limits":{"$ref":"#/components/schemas/LimitsSettingsResponse","x-stream-index":"012"},"recording":{"$ref":"#/components/schemas/RecordSettingsResponse","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettingsResponse","x-stream-index":"007"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettingsResponse","x-stream-index":"008"},"session":{"$ref":"#/components/schemas/SessionSettingsResponse","x-stream-index":"013"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettingsResponse","x-stream-index":"011"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettingsResponse","x-stream-index":"009"},"video":{"$ref":"#/components/schemas/VideoSettingsResponse","x-stream-index":"010"}},"required":["audio","backstage","broadcasting","geofencing","recording","frame_recording","ring","screensharing","transcription","video","thumbnails","limits","session"],"type":"object"},"CallType":{"nullable":true,"properties":{"AppPK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"003"},"CreatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"005"},"ExternalStorage":{"type":"string","writeOnly":true,"x-stream-index":"009"},"Name":{"type":"string","writeOnly":true,"x-stream-index":"004"},"NotificationSettings":{"$ref":"#/components/schemas/NotificationSettings","x-stream-index":"008"},"PK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"002"},"Settings":{"$ref":"#/components/schemas/CallSettings","x-stream-index":"007"},"UpdatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"006"}},"required":["PK","AppPK","Name","CreatedAt","UpdatedAt","ExternalStorage"],"type":"object"},"CastPollVoteRequest":{"nullable":true,"properties":{"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"005.002"},"user_id":{"type":"string","x-stream-index":"005.001"},"vote":{"$ref":"#/components/schemas/VoteData","description":"Vote data","title":"VoteData","x-stream-index":"004"}},"type":"object"},"Channel":{"properties":{"active_live_locations":{"items":{"$ref":"#/components/schemas/SharedLocation"},"type":"array","x-stream-index":"034"},"auto_translation_enabled":{"type":"boolean","x-stream-index":"029"},"auto_translation_language":{"type":"string","x-stream-index":"030"},"cid":{"type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/ChannelConfig","x-stream-index":"026"},"config_overrides":{"$ref":"#/components/schemas/ConfigOverrides","x-stream-index":"027"},"cooldown":{"format":"int32","type":"integer","x-stream-index":"031"},"created_at":{"format":"date-time","type":"number","x-stream-index":"009"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"019"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"disabled":{"type":"boolean","x-stream-index":"017"},"frozen":{"type":"boolean","x-stream-index":"016"},"id":{"type":"string","x-stream-index":"004"},"invites":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"022"},"last_campaigns":{"type":"string","x-stream-index":"032"},"last_message_at":{"format":"date-time","type":"number","x-stream-index":"006"},"member_count":{"format":"int32","type":"integer","x-stream-index":"021"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"020"},"message_count":{"format":"int64","type":"integer","x-stream-index":"035"},"message_count_updated_at":{"format":"date-time","type":"number","x-stream-index":"036"},"team":{"type":"string","x-stream-index":"028"},"truncated_by":{"$ref":"#/components/schemas/User","x-stream-index":"015"},"type":{"type":"string","x-stream-index":"005"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"010"}},"required":["cid","id","type","created_at","updated_at","frozen","disabled","custom","auto_translation_language"],"type":"object"},"ChannelConfig":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.027"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.022"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.023"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.028"},"blocklist":{"type":"string","x-stream-index":"001.024"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.025"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.026"},"commands":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"connect_events":{"type":"boolean","x-stream-index":"001.004"},"count_messages":{"type":"boolean","x-stream-index":"001.019"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"custom_events":{"type":"boolean","x-stream-index":"001.012"},"mark_messages_pending":{"type":"boolean","x-stream-index":"001.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"001.021"},"mutes":{"type":"boolean","x-stream-index":"001.009"},"name":{"type":"string","x-stream-index":"001.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"001.029"},"partition_ttl":{"type":"integer","x-stream-index":"001.030"},"polls":{"type":"boolean","x-stream-index":"001.016"},"push_notifications":{"type":"boolean","x-stream-index":"001.013"},"quotes":{"type":"boolean","x-stream-index":"001.008"},"reactions":{"type":"boolean","x-stream-index":"001.006"},"read_events":{"type":"boolean","x-stream-index":"001.003"},"reminders":{"type":"boolean","x-stream-index":"001.014"},"replies":{"type":"boolean","x-stream-index":"001.007"},"search":{"type":"boolean","x-stream-index":"001.005"},"shared_locations":{"type":"boolean","x-stream-index":"001.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.031"},"typing_events":{"type":"boolean","x-stream-index":"001.002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"002.004"},"uploads":{"type":"boolean","x-stream-index":"001.010"},"url_enrichment":{"type":"boolean","x-stream-index":"001.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"001.017"}},"required":["name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","count_messages","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","created_at","updated_at","commands"],"type":"object"},"ChannelConfigWithInfo":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.002.027"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.002.022"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.023"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.002.028"},"blocklist":{"type":"string","x-stream-index":"001.002.024"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.025"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.002.026"},"commands":{"items":{"$ref":"#/components/schemas/Command"},"type":"array","x-stream-index":"001.003"},"connect_events":{"type":"boolean","x-stream-index":"001.002.004"},"count_messages":{"type":"boolean","x-stream-index":"001.002.019"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.001.003"},"custom_events":{"type":"boolean","x-stream-index":"001.002.012"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"002"},"mark_messages_pending":{"type":"boolean","x-stream-index":"001.002.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"001.002.021"},"mutes":{"type":"boolean","x-stream-index":"001.002.009"},"name":{"type":"string","x-stream-index":"001.002.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"001.002.029"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"001.002.030"},"polls":{"type":"boolean","x-stream-index":"001.002.016"},"push_notifications":{"type":"boolean","x-stream-index":"001.002.013"},"quotes":{"type":"boolean","x-stream-index":"001.002.008"},"reactions":{"type":"boolean","x-stream-index":"001.002.006"},"read_events":{"type":"boolean","x-stream-index":"001.002.003"},"reminders":{"type":"boolean","x-stream-index":"001.002.014"},"replies":{"type":"boolean","x-stream-index":"001.002.007"},"search":{"type":"boolean","x-stream-index":"001.002.005"},"shared_locations":{"type":"boolean","x-stream-index":"001.002.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.002.031"},"typing_events":{"type":"boolean","x-stream-index":"001.002.002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"uploads":{"type":"boolean","x-stream-index":"001.002.010"},"url_enrichment":{"type":"boolean","x-stream-index":"001.002.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"001.002.017"}},"required":["created_at","updated_at","name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","count_messages","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","commands"],"type":"object"},"ChannelMember":{"nullable":true,"properties":{"archived_at":{"format":"date-time","type":"number","x-stream-index":"015"},"ban_expires":{"description":"Expiration date of the ban","format":"date-time","title":"Ban expires","type":"number","x-stream-index":"013"},"banned":{"description":"Whether member is banned this channel or not","title":"Banned","type":"boolean","x-stream-index":"012"},"channel_role":{"description":"Role of the member in the channel","title":"Channel Role","type":"string","x-stream-index":"018"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"deleted_messages":{"items":{"type":"string"},"type":"array","x-stream-index":"020"},"invite_accepted_at":{"description":"Date when invite was accepted","format":"date-time","title":"Invited accepted at","type":"number","x-stream-index":"006"},"invite_rejected_at":{"description":"Date when invite was rejected","format":"date-time","title":"Invited rejected at","type":"number","x-stream-index":"007"},"invited":{"description":"Whether member was invited or not","title":"Invited","type":"boolean","x-stream-index":"005"},"is_moderator":{"description":"Whether member is channel moderator or not","title":"Is moderator","type":"boolean","x-stream-index":"003"},"notifications_muted":{"type":"boolean","x-stream-index":"019"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"016"},"role":{"description":"Permission level of the member in the channel (DEPRECATED: use channel_role instead)","enum":["member","moderator","admin","owner"],"title":"Role","type":"string","x-stream-index":"017"},"shadow_banned":{"description":"Whether member is shadow banned in this channel or not","title":"Shadow banned","type":"boolean","x-stream-index":"014"},"status":{"type":"string","x-stream-index":"008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"},"user_id":{"title":"User ID","type":"string","x-stream-index":"001"}},"required":["custom","created_at","updated_at","banned","shadow_banned","channel_role","notifications_muted"],"title":"Channel member","type":"object"},"ChannelMute":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel that is muted","title":"Channel","x-stream-index":"002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"004"},"expires":{"description":"Date/time of mute expiration","format":"date-time","title":"Expires","type":"number","x-stream-index":"003"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Owner of channel mute","title":"User","x-stream-index":"001"}},"required":["created_at","updated_at"],"type":"object"},"ChannelOwnCapability":{"description":"All possibility of string to use","enum":["ban-channel-members","cast-poll-vote","connect-events","create-attachment","delete-any-message","delete-channel","delete-own-message","flag-message","freeze-channel","join-channel","leave-channel","mute-channel","pin-message","query-poll-votes","quote-message","read-events","search-messages","send-custom-events","send-links","send-message","send-poll","send-reaction","send-reply","send-restricted-visibility-message","send-typing-events","set-channel-cooldown","share-location","skip-slow-mode","slow-mode","typing-events","update-any-message","update-channel","update-channel-members","update-own-message","update-thread","upload-file"],"title":"ChannelOwnCapability","type":"string"},"ChannelResponse":{"description":"Represents channel in chat","properties":{"auto_translation_enabled":{"description":"Whether auto translation is enabled or not","title":"Auto translation","type":"boolean","x-stream-index":"017"},"auto_translation_language":{"description":"Language to translate to when auto translation is active","title":"Auto translation language","type":"string","x-stream-index":"018"},"blocked":{"description":"Whether this channel is blocked by current user or not","title":"Blocked","type":"boolean","x-stream-index":"023"},"cid":{"description":"Channel CID (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/ChannelConfigWithInfo","description":"Channel configuration","title":"ChannelConfigWithInfo","x-stream-index":"013"},"cooldown":{"description":"Cooldown period after sending each message","format":"int32","title":"Cooldown","type":"integer","x-stream-index":"020"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"005"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"Creator of the channel","title":"UserResponse","x-stream-index":"008"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"026"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"007"},"disabled":{"type":"boolean","x-stream-index":"010"},"frozen":{"description":"Whether channel is frozen or not","title":"Frozen","type":"boolean","x-stream-index":"009"},"hidden":{"description":"Whether this channel is hidden by current user or not","title":"Hidden","type":"boolean","x-stream-index":"022"},"hide_messages_before":{"description":"Date since when the message history is accessible","format":"date-time","title":"Hide messages before","type":"number","x-stream-index":"019"},"id":{"description":"Channel unique ID","title":"ID","type":"string","x-stream-index":"001"},"last_message_at":{"description":"Date of the last message sent","format":"date-time","title":"Last message at","type":"number","x-stream-index":"004"},"member_count":{"description":"Number of members in the channel","format":"int32","title":"Member count","type":"integer","x-stream-index":"012"},"members":{"description":"List of channel members (max 100)","items":{"$ref":"#/components/schemas/ChannelMember"},"title":"ChannelMembers","type":"array","x-stream-index":"011"},"message_count":{"description":"Number of messages in the channel","format":"int64","title":"Message count","type":"integer","x-stream-index":"027"},"mute_expires_at":{"description":"Date of mute expiration","format":"date-time","title":"Mute expires at","type":"number","x-stream-index":"015"},"muted":{"description":"Whether this channel is muted or not","title":"Muted","type":"boolean","x-stream-index":"014"},"own_capabilities":{"description":"List of channel capabilities of authenticated user","items":{"$ref":"#/components/schemas/ChannelOwnCapability"},"title":"ChannelOwnCapability","type":"array","x-stream-index":"021"},"team":{"description":"Team the channel belongs to (multi-tenant only)","title":"Team","type":"string","x-stream-index":"016"},"truncated_at":{"description":"Date of the latest truncation of the channel","format":"date-time","title":"UserResponse","type":"number","x-stream-index":"024"},"truncated_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"025"},"type":{"description":"Type of the channel","title":"Type","type":"string","x-stream-docs-page-id":"channel_features","x-stream-index":"002"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"006"}},"required":["id","type","cid","created_at","updated_at","frozen","disabled","custom"],"title":"Channel","type":"object"},"CheckExternalStorageResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"file_url":{"type":"string","x-stream-index":"002"}},"required":["duration","file_url"],"title":"Response","type":"object"},"CheckPushRequest":{"description":"Check push request","nullable":true,"properties":{"apn_template":{"description":"Push message template for APN","title":"APN template","type":"string","x-stream-docs-page-id":"push_template","x-stream-index":"002"},"event_type":{"description":"Type of event for push templates (default: message.new)","enum":["message.new","message.updated","reaction.new","reaction.updated","notification.reminder_due"],"title":"Event type","type":"string","x-stream-index":"008"},"firebase_data_template":{"description":"Push message data template for Firebase","title":"Firebase data template","type":"string","x-stream-docs-page-id":"push_template","x-stream-index":"004"},"firebase_template":{"description":"Push message template for Firebase","title":"Firebase template","type":"string","x-stream-docs-page-id":"push_template","x-stream-index":"003"},"message_id":{"description":"Message ID to send push notification for","title":"Message ID","type":"string","x-stream-index":"001"},"push_provider_name":{"description":"Name of push provider","title":"Name of push provider","type":"string","x-stream-index":"007"},"push_provider_type":{"description":"Push provider type","enum":["firebase","apn","huawei","xiaomi"],"title":"Type of push provider","type":"string","x-stream-index":"006"},"skip_devices":{"description":"Don't require existing devices to render templates","title":"Skip devices","type":"boolean","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"009.002"},"user_id":{"type":"string","x-stream-index":"009.001"}},"title":"CheckPushRequest","type":"object"},"CheckPushResponse":{"nullable":true,"properties":{"device_errors":{"additionalProperties":{"$ref":"#/components/schemas/DeviceErrorInfo"},"description":"Object with device errors","title":"Device errors","type":"object","x-stream-index":"001","x-stream-map":{"key":"device_id"}},"duration":{"type":"string","x-stream-index":"008.001"},"event_type":{"description":"The event type that was tested","title":"Event type","type":"string","x-stream-index":"004"},"general_errors":{"description":"List of general errors","items":{"type":"string"},"title":"General errors","type":"array","x-stream-index":"002"},"rendered_apn_template":{"title":"Rendered APN template","type":"string","x-stream-index":"005"},"rendered_firebase_template":{"title":"Rendered Firebase template","type":"string","x-stream-index":"006"},"rendered_message":{"additionalProperties":{"type":"string"},"title":"Rendered message","type":"object","x-stream-index":"007"},"skip_devices":{"description":"Don't require existing devices to render templates","title":"Skip devices","type":"boolean","x-stream-index":"003"}},"required":["duration"],"type":"object"},"CheckRequest":{"nullable":true,"properties":{"config_key":{"description":"Key of the moderation configuration to use","title":"Config Key","type":"string","x-stream-index":"005"},"config_team":{"description":"Team associated with the configuration","title":"Config Team","type":"string","x-stream-index":"006"},"entity_creator_id":{"description":"ID of the user who created the entity","title":"Entity Creator ID","type":"string","x-stream-index":"003"},"entity_id":{"description":"Unique identifier of the entity to moderate","title":"Entity ID","type":"string","x-stream-index":"002"},"entity_type":{"description":"Type of entity to moderate","title":"Entity Type","type":"string","x-stream-index":"001"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content to be moderated","title":"Moderation Payload","x-stream-index":"004"},"options":{"additionalProperties":{},"description":"Additional moderation configuration options","title":"Options","type":"object","x-stream-index":"007"},"test_mode":{"description":"Whether to run moderation in test mode","title":"Test Mode","type":"boolean","x-stream-index":"008"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"009.002"},"user_id":{"type":"string","x-stream-index":"009.001"}},"required":["entity_type","entity_id","entity_creator_id"],"type":"object"},"CheckResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"005.001"},"item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"Review queue item (present if action != keep)","title":"Item","x-stream-index":"004"},"recommended_action":{"description":"Suggested action based on moderation results","title":"Recommended Action","type":"string","x-stream-index":"003"},"status":{"description":"Status of the moderation check (completed or pending)","title":"Status","type":"string","x-stream-index":"001"},"task_id":{"description":"ID of the running moderation task","title":"Task ID","type":"string","x-stream-index":"002"}},"required":["status","recommended_action","duration"],"type":"object"},"CheckSNSRequest":{"nullable":true,"properties":{"sns_key":{"description":"AWS SNS access key","title":"SNS key","type":"string","x-stream-index":"002"},"sns_secret":{"description":"AWS SNS key secret","title":"SNS secret","type":"string","x-stream-index":"003"},"sns_topic_arn":{"description":"AWS SNS topic ARN","title":"SNS Topic ARN","type":"string","x-stream-index":"001"}},"type":"object"},"CheckSNSResponse":{"nullable":true,"properties":{"data":{"additionalProperties":{},"description":"Error data","title":"ReadOnlyData","type":"object","x-stream-index":"003"},"duration":{"type":"string","x-stream-index":"004.001"},"error":{"description":"Error text","title":"Error","type":"string","x-stream-index":"002"},"status":{"description":"Validation result","enum":["ok","error"],"title":"Status","type":"string","x-stream-index":"001"}},"required":["status","duration"],"type":"object"},"CheckSQSRequest":{"nullable":true,"properties":{"sqs_key":{"description":"AWS SQS access key","title":"SQS key","type":"string","x-stream-index":"002"},"sqs_secret":{"description":"AWS SQS key secret","title":"SQS secret","type":"string","x-stream-index":"003"},"sqs_url":{"description":"AWS SQS endpoint URL","title":"SQS URL","type":"string","x-stream-index":"001"}},"type":"object"},"CheckSQSResponse":{"nullable":true,"properties":{"data":{"additionalProperties":{},"description":"Error data","title":"ReadOnlyData","type":"object","x-stream-index":"003"},"duration":{"type":"string","x-stream-index":"004.001"},"error":{"description":"Error text","title":"Error","type":"string","x-stream-index":"002"},"status":{"description":"Validation result","enum":["ok","error"],"title":"Status","type":"string","x-stream-index":"001"}},"required":["status","duration"],"type":"object"},"Command":{"description":"Represents custom chat command","nullable":true,"properties":{"args":{"description":"Arguments help text, shown in commands auto-completion","title":"Arguments","type":"string","x-stream-index":"006"},"created_at":{"description":"Date/time of creation","format":"date-time","readOnly":true,"title":"Created at","type":"number","x-stream-index":"001"},"description":{"description":"Description, shown in commands auto-completion","title":"Description","type":"string","x-stream-index":"005"},"name":{"description":"Unique command name","title":"Name","type":"string","x-stream-index":"004"},"set":{"description":"Set name used for grouping commands","title":"Set","type":"string","x-stream-index":"007"},"updated_at":{"description":"Date/time of the last update","format":"date-time","readOnly":true,"title":"Updated at","type":"number","x-stream-index":"002"}},"required":["name","description","args","set"],"title":"Command","type":"object"},"CommentAddedEvent":{"description":"Emitted when a comment is added to an activity.","nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","x-stream-index":"002"},"comment":{"$ref":"#/components/schemas/CommentResponse","description":"The comment that was added","title":"Text","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"003.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.001.007"},"feed_visibility":{"type":"string","x-stream-index":"003.003"},"fid":{"type":"string","x-stream-index":"003.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.001.004"},"type":{"default":"feeds.comment.added","description":"The type of event: \"feeds.comment.added\" in this case","title":"Event Type","type":"string","x-stream-index":"003.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who added the comment","title":"User","x-stream-index":"004.001"}},"required":["comment","activity","type","created_at","custom","fid"],"title":"CommentAddedEvent","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"},"CommentDeletedEvent":{"description":"Emitted when a comment is deleted.","nullable":true,"properties":{"comment":{"$ref":"#/components/schemas/CommentResponse","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"type":"string","x-stream-index":"002.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.comment.deleted","description":"The type of event: \"feeds.comment.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who deleted the comment","title":"User","x-stream-index":"003.001"}},"required":["comment","type","created_at","custom","fid"],"title":"CommentDeletedEvent","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"},"CommentReactionAddedEvent":{"description":"Emitted when a reaction is added to a comment.","nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","x-stream-index":"003"},"comment":{"$ref":"#/components/schemas/CommentResponse","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"004.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004.001.007"},"feed_visibility":{"type":"string","x-stream-index":"004.003"},"fid":{"type":"string","x-stream-index":"004.002"},"reaction":{"$ref":"#/components/schemas/FeedsReactionResponse","description":"The reaction that was added","title":"Reaction","x-stream-index":"002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"004.001.004"},"type":{"default":"feeds.comment.reaction.added","description":"The type of event: \"feeds.comment.reaction.added\" in this case","title":"Event Type","type":"string","x-stream-index":"004.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who added the reaction","title":"User","x-stream-index":"005.001"}},"required":["comment","reaction","activity","type","created_at","custom","fid"],"title":"CommentReactionAddedEvent","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"},"CommentReactionDeletedEvent":{"description":"Emitted when a reaction is deleted from a comment.","nullable":true,"properties":{"comment":{"$ref":"#/components/schemas/CommentResponse","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"003.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.001.007"},"feed_visibility":{"type":"string","x-stream-index":"003.003"},"fid":{"type":"string","x-stream-index":"003.002"},"reaction":{"$ref":"#/components/schemas/FeedsReactionResponse","x-stream-index":"002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.001.004"},"type":{"default":"feeds.comment.reaction.deleted","description":"The type of reaction that was removed","title":"Type","type":"string","x-stream-index":"003.001.002"}},"required":["comment","reaction","type","created_at","custom","fid"],"title":"CommentReactionDeletedEvent","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"},"CommentReactionUpdatedEvent":{"description":"Emitted when a reaction is updated on a comment.","nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","x-stream-index":"003"},"comment":{"$ref":"#/components/schemas/CommentResponse","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"004.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004.001.007"},"feed_visibility":{"type":"string","x-stream-index":"004.003"},"fid":{"type":"string","x-stream-index":"004.002"},"reaction":{"$ref":"#/components/schemas/FeedsReactionResponse","description":"The reaction that was updated","title":"Reaction","x-stream-index":"002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"004.001.004"},"type":{"default":"feeds.comment.reaction.updated","description":"The type of event: \"feeds.comment.reaction.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"004.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who updated the reaction","title":"User","x-stream-index":"005.001"}},"required":["comment","reaction","activity","type","created_at","custom","fid"],"title":"CommentReactionUpdatedEvent","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"},"CommentResponse":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"011"},"confidence_score":{"description":"Confidence score of the comment","format":"float","title":"Confidence Score","type":"number","x-stream-index":"022"},"controversy_score":{"description":"Controversy score of the comment","format":"float","title":"Controversy Score","type":"number","x-stream-index":"023"},"created_at":{"description":"When the comment was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"014"},"custom":{"additionalProperties":{},"description":"Custom data for the comment","title":"Custom Data","type":"object","x-stream-index":"006"},"deleted_at":{"description":"When the comment was deleted","format":"date-time","title":"Deleted At","type":"number","x-stream-index":"016"},"downvote_count":{"description":"Number of downvotes for this comment","format":"int32","title":"Downvote Count","type":"integer","x-stream-index":"020"},"id":{"description":"Unique identifier for the comment","title":"ID","type":"string","x-stream-index":"001"},"latest_reactions":{"description":"Recent reactions to the comment","items":{"$ref":"#/components/schemas/FeedsReactionResponse"},"title":"Latest Reactions","type":"array","x-stream-index":"009"},"mentioned_users":{"description":"Users mentioned in the comment","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Mention Users","type":"array","x-stream-index":"012"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"017"},"object_id":{"description":"ID of the object this comment is associated with","title":"Object ID","type":"string","x-stream-index":"002"},"object_type":{"description":"Type of the object this comment is associated with","title":"Object Type","type":"string","x-stream-index":"003"},"own_reactions":{"description":"Current user's reactions to this activity","items":{"$ref":"#/components/schemas/FeedsReactionResponse"},"title":"Own Reactions","type":"array","x-stream-index":"024"},"parent_id":{"description":"ID of parent comment for nested replies","title":"Parent ID","type":"string","x-stream-index":"007"},"reaction_count":{"description":"Number of reactions to this comment","format":"int32","title":"Reaction Count","type":"integer","x-stream-index":"008"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"description":"Grouped reactions by type","title":"Reaction Groups","type":"object","x-stream-index":"010"},"reply_count":{"description":"Number of replies to this comment","format":"int32","title":"Reply Count","type":"integer","x-stream-index":"018"},"score":{"description":"Score of the comment based on reactions","format":"int32","title":"Score","type":"integer","x-stream-index":"021"},"status":{"description":"Status of the comment (e.g., active, deleted)","title":"Status","type":"string","x-stream-index":"013"},"text":{"description":"Text content of the comment","title":"Text","type":"string","x-stream-index":"005"},"updated_at":{"description":"When the comment was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"015"},"upvote_count":{"description":"Number of upvotes for this comment","format":"int32","title":"Upvote Count","type":"integer","x-stream-index":"019"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who created the comment","title":"User","x-stream-index":"004"}},"required":["id","object_id","object_type","user","reaction_count","mentioned_users","status","created_at","updated_at","reply_count","upvote_count","downvote_count","score","confidence_score","own_reactions"],"title":"Comment","type":"object"},"CommentUpdatedEvent":{"description":"Emitted when a comment is updated.","nullable":true,"properties":{"comment":{"$ref":"#/components/schemas/CommentResponse","description":"The comment that was updated","title":"Text","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"type":"string","x-stream-index":"002.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.comment.updated","description":"The type of event: \"feeds.comment.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who updated the comment","title":"User","x-stream-index":"003.001"}},"required":["comment","type","created_at","custom","fid"],"title":"CommentUpdatedEvent","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"},"CompositeAppSettings":{"properties":{"json_encoded_settings":{"type":"string","x-stream-index":"005"},"url":{"type":"string","x-stream-index":"004"}},"type":"object"},"ConfigOverrides":{"properties":{"blocklist":{"type":"string","x-stream-index":"008"},"blocklist_behavior":{"enum":["flag","block"],"type":"string","x-stream-index":"009"},"commands":{"items":{"type":"string"},"type":"array","x-stream-index":"011"},"count_messages":{"type":"boolean","x-stream-index":"014"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"010"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"007"},"quotes":{"type":"boolean","x-stream-index":"004"},"reactions":{"type":"boolean","x-stream-index":"002"},"replies":{"type":"boolean","x-stream-index":"003"},"shared_locations":{"type":"boolean","x-stream-index":"013"},"typing_events":{"type":"boolean","x-stream-index":"001"},"uploads":{"type":"boolean","x-stream-index":"005"},"url_enrichment":{"type":"boolean","x-stream-index":"006"},"user_message_reminders":{"type":"boolean","x-stream-index":"012"}},"required":["grants","commands"],"type":"object"},"ConfigResponse":{"properties":{"ai_image_config":{"$ref":"#/components/schemas/AIImageConfig","description":"Configuration for AI image analysis","title":"AI Image Config","x-stream-index":"010"},"ai_text_config":{"$ref":"#/components/schemas/AITextConfig","description":"Configuration for AI text analysis","title":"AI Text Config","x-stream-index":"008"},"ai_video_config":{"$ref":"#/components/schemas/AIVideoConfig","description":"Configuration for AI video analysis","title":"AI Video Config","x-stream-index":"011"},"async":{"description":"Whether moderation should be performed asynchronously","title":"Async","type":"boolean","x-stream-index":"003"},"automod_platform_circumvention_config":{"$ref":"#/components/schemas/AutomodPlatformCircumventionConfig","description":"Configuration for platform circumvention detection","title":"Automod Platform Circumvention Config","x-stream-index":"005"},"automod_semantic_filters_config":{"$ref":"#/components/schemas/AutomodSemanticFiltersConfig","description":"Configuration for semantic filtering","title":"Automod Semantic Filters Config","x-stream-index":"006"},"automod_toxicity_config":{"$ref":"#/components/schemas/AutomodToxicityConfig","description":"Configuration for toxicity detection","title":"Automod Toxicity Config","x-stream-index":"004"},"block_list_config":{"$ref":"#/components/schemas/BlockListConfig","description":"Configuration for block list filtering","title":"Block List Config","x-stream-index":"007"},"created_at":{"description":"When the configuration was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"013"},"key":{"description":"Unique identifier for the moderation configuration","title":"Key","type":"string","x-stream-index":"001"},"llm_config":{"$ref":"#/components/schemas/LLMConfig","description":"Configuration for customer-configured LLM moderation","title":"LLM Config","x-stream-index":"009"},"team":{"description":"Team associated with the configuration","title":"Team","type":"string","x-stream-index":"002"},"updated_at":{"description":"When the configuration was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"014"},"velocity_filter_config":{"$ref":"#/components/schemas/VelocityFilterConfig","description":"Configuration for velocity-based filtering","title":"Velocity Filter Config","x-stream-index":"012"},"video_call_rule_config":{"$ref":"#/components/schemas/VideoCallRuleConfig","x-stream-index":"015"}},"required":["key","team","async","created_at","updated_at"],"type":"object"},"ContentCountRuleParameters":{"properties":{"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"type":"object"},"CreateBlockListRequest":{"description":"Block list contains restricted words","nullable":true,"properties":{"name":{"description":"Block list name","maxLength":255,"title":"Name","type":"string","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"004"},"type":{"description":"Block list type.","enum":["regex","domain","domain_allowlist","email","word"],"title":"Type","type":"string","x-stream-index":"003"},"words":{"description":"List of words to block","items":{"type":"string"},"minimum":1,"title":"Words","type":"array","x-stream-index":"002"}},"required":["name","words"],"title":"Block list","type":"object","x-stream-docs-page-id":"block_lists"},"CreateBlockListResponse":{"description":"Basic response information","nullable":true,"properties":{"blocklist":{"$ref":"#/components/schemas/BlockListResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["duration"],"title":"Response","type":"object"},"CreateDeviceRequest":{"description":"Create device request","nullable":true,"properties":{"id":{"description":"Device ID","maxLength":255,"minLength":1,"title":"ID","type":"string","x-stream-index":"001"},"push_provider":{"description":"Push provider","enum":["firebase","apn","huawei","xiaomi"],"title":"PushProvider","type":"string","x-stream-index":"002"},"push_provider_name":{"description":"Push provider name","title":"PushProviderName","type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"005.002"},"user_id":{"description":"**Server-side only**. User ID which server acts upon","title":"User ID","type":"string","x-stream-index":"005.001"},"voip_token":{"description":"When true the token is for Apple VoIP push notifications","title":"VoipToken","type":"boolean","x-stream-index":"004"}},"required":["id","push_provider"],"title":"CreateDeviceRequest","type":"object"},"CreateExternalStorageRequest":{"description":"Create external storage","nullable":true,"properties":{"aws_s3":{"$ref":"#/components/schemas/S3Request","description":"Only required if you want to create an Amazon S3 storage","title":"AwsS3","x-stream-index":"003.004"},"azure_blob":{"$ref":"#/components/schemas/AzureRequest","description":"Only required if you want to create an Azure Blob Storage","title":"AzureBlob","x-stream-index":"003.006"},"bucket":{"description":"The name of the bucket on the service provider","title":"Bucket","type":"string","x-stream-index":"003.002"},"gcs_credentials":{"type":"string","x-stream-index":"003.005"},"name":{"description":"The name of the provider, this must be unique","title":"Name","type":"string","x-stream-index":"001"},"path":{"description":"The path prefix to use for storing files","title":"Path","type":"string","x-stream-index":"003.003"},"storage_type":{"description":"The type of storage to use","enum":["s3","gcs","abs"],"title":"StorageType","type":"string","x-stream-index":"003.001"}},"required":["name","storage_type","bucket"],"title":"CreateExternalStorageRequest","type":"object"},"CreateExternalStorageResponse":{"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"},"CreateFeedGroupRequest":{"nullable":true,"properties":{"activity_processors":{"description":"Configuration for activity processors (max 10)","items":{"$ref":"#/components/schemas/ActivityProcessorConfig"},"maximum":10,"title":"Activity Processors","type":"array","x-stream-index":"006"},"activity_selectors":{"description":"Configuration for activity selectors (max 10)","items":{"$ref":"#/components/schemas/ActivitySelectorConfig"},"maximum":10,"title":"Activity Selectors","type":"array","x-stream-index":"007"},"aggregation":{"$ref":"#/components/schemas/AggregationConfig","description":"Configuration for activity aggregation","title":"Aggregation","x-stream-index":"009"},"custom":{"additionalProperties":{},"description":"Custom data for the feed group","title":"Custom Data","type":"object","x-stream-index":"004"},"default_visibility":{"description":"Default visibility for the feed group, can be 'public', 'visible', 'followers', 'members', or 'private'. Defaults to 'visible' if not provided. ","enum":["public","visible","followers","members","private"],"title":"Default Visibility","type":"string","x-stream-index":"005"},"id":{"description":"Unique identifier for the feed group","maxLength":255,"title":"Feed Group ID","type":"string","x-stream-index":"001"},"notification":{"$ref":"#/components/schemas/NotificationConfig","description":"Configuration for notifications","title":"Notification","x-stream-index":"002"},"push_notification":{"$ref":"#/components/schemas/PushNotificationConfig","x-stream-index":"003"},"ranking":{"$ref":"#/components/schemas/RankingConfig","description":"Configuration for activity ranking","title":"Ranking","x-stream-index":"008"}},"required":["id"],"title":"Create Feed Group Request","type":"object"},"CreateFeedGroupResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"feed_group":{"$ref":"#/components/schemas/FeedGroupResponse","description":"The upserted feed group","title":"Feed Group","x-stream-index":"001"}},"required":["feed_group","duration"],"title":"Upsert Feed Group Response","type":"object"},"CreateFeedViewRequest":{"nullable":true,"properties":{"activity_processors":{"description":"Configured activity Processors","items":{"$ref":"#/components/schemas/ActivityProcessorConfig"},"title":"Activity Processors","type":"array","x-stream-index":"002.002"},"activity_selectors":{"description":"Configuration for selecting activities","items":{"$ref":"#/components/schemas/ActivitySelectorConfig"},"title":"Activity Selectors","type":"array","x-stream-index":"002.001"},"aggregation":{"$ref":"#/components/schemas/AggregationConfig","description":"Configuration for aggregating activities","title":"Aggregation","x-stream-index":"002.004"},"id":{"description":"Unique identifier for the feed view","maxLength":255,"title":"View ID","type":"string","x-stream-index":"001"},"ranking":{"$ref":"#/components/schemas/RankingConfig","description":"Configuration for ranking activities","title":"Ranking","x-stream-index":"002.003"}},"required":["id"],"title":"Create Feed View Request","type":"object"},"CreateFeedViewResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"feed_view":{"$ref":"#/components/schemas/FeedViewResponse","description":"The created feed view","title":"Feed View","x-stream-index":"001"}},"required":["feed_view","duration"],"title":"Create Feed View Response","type":"object"},"CreateFeedsBatchRequest":{"nullable":true,"properties":{"feeds":{"description":"List of feeds to create","items":{"$ref":"#/components/schemas/FeedRequest"},"maximum":1000,"minimum":1,"title":"Feeds","type":"array","x-stream-index":"001"}},"required":["feeds"],"title":"Create Feeds Batch Request","type":"object"},"CreateFeedsBatchResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"feeds":{"description":"List of created feeds","items":{"$ref":"#/components/schemas/FeedResponse"},"title":"Feeds","type":"array","x-stream-index":"001"}},"required":["feeds","duration"],"title":"Create Feeds Batch Response","type":"object"},"CreateGuestRequest":{"nullable":true,"properties":{"user":{"$ref":"#/components/schemas/UserRequest","description":"User object which server acts upon","title":"User","x-stream-index":"001"}},"required":["user"],"type":"object"},"CreateGuestResponse":{"nullable":true,"properties":{"access_token":{"description":"the access token to authenticate the user","title":"Access token","type":"string","x-stream-index":"002"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User object which server acts upon","title":"User","x-stream-index":"001"}},"required":["user","access_token","duration"],"type":"object"},"CreateImportRequest":{"nullable":true,"properties":{"mode":{"enum":["insert","upsert"],"type":"string","x-stream-index":"002"},"path":{"type":"string","x-stream-index":"001"}},"required":["path","mode"],"type":"object"},"CreateImportResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"import_task":{"$ref":"#/components/schemas/ImportTask","x-stream-index":"001"}},"required":["duration"],"title":"Response","type":"object"},"CreateImportURLRequest":{"nullable":true,"properties":{"filename":{"type":"string","x-stream-index":"001"}},"type":"object"},"CreateImportURLResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"path":{"type":"string","x-stream-index":"001"},"upload_url":{"type":"string","x-stream-index":"002"}},"required":["path","upload_url","duration"],"title":"Response","type":"object"},"CreateMembershipLevelRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"description":"Custom data for the membership level","title":"Custom Data","type":"object","x-stream-index":"006"},"description":{"description":"Optional description of the membership level","maxLength":1000,"title":"Description","type":"string","x-stream-index":"003"},"id":{"description":"Unique identifier for the membership level","maxLength":255,"title":"ID","type":"string","x-stream-index":"001"},"name":{"description":"Display name for the membership level","maxLength":255,"title":"Name","type":"string","x-stream-index":"002"},"priority":{"description":"Priority level (higher numbers = higher priority)","format":"int32","minimum":0,"title":"Priority","type":"integer","x-stream-index":"004"},"tags":{"description":"Activity tags this membership level gives access to","items":{"type":"string"},"maximum":255,"title":"Tags","type":"array","x-stream-index":"005"}},"required":["id","name"],"title":"Create Membership Level Request","type":"object"},"CreateMembershipLevelResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"membership_level":{"$ref":"#/components/schemas/MembershipLevelResponse","description":"The created membership level","title":"Membership Level","x-stream-index":"001"}},"required":["membership_level","duration"],"title":"Create Membership Level Response","type":"object"},"CreatePollOptionRequest":{"nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"003"},"text":{"description":"Option text","title":"string","type":"string","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"required":["text"],"type":"object"},"CreatePollRequest":{"description":"Contains all information needed to create a new poll","nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"011"},"allow_answers":{"description":"Indicates whether users can suggest user defined answers","title":"Allow answers","type":"boolean","x-stream-index":"009"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"008"},"description":{"description":"A description of the poll","title":"Description","type":"string","x-stream-index":"003"},"enforce_unique_vote":{"description":"Indicates whether users can cast multiple votes","title":"Multiple choice","type":"boolean","x-stream-index":"006"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"is_closed":{"description":"Indicates whether the poll is open for voting","title":"Is closed","type":"boolean","x-stream-index":"010"},"max_votes_allowed":{"description":"Indicates the maximum amount of votes a user can cast","format":"int32","maximum":10,"title":"Maximum votes allowed","type":"integer","x-stream-index":"007"},"name":{"description":"The name of the poll","title":"Name","type":"string","x-stream-index":"002"},"options":{"items":{"$ref":"#/components/schemas/PollOptionInput"},"maximum":100,"type":"array","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"012.002"},"user_id":{"type":"string","x-stream-index":"012.001"},"voting_visibility":{"enum":["anonymous","public"],"type":"string","x-stream-index":"005"}},"required":["name"],"title":"Create Poll Request","type":"object"},"CreateRoleRequest":{"nullable":true,"properties":{"name":{"description":"Role name","maxLength":64,"title":"Name","type":"string","x-stream-index":"001"}},"required":["name"],"type":"object"},"CreateRoleResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"role":{"$ref":"#/components/schemas/Role","x-stream-index":"002"}},"required":["duration","role"],"title":"Response","type":"object"},"CustomActionRequest":{"properties":{"id":{"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"type":"object"},"CustomCheckFlag":{"properties":{"custom":{"additionalProperties":{},"description":"Additional metadata for the flag","title":"Custom","type":"object","x-stream-index":"003"},"labels":{"description":"Labels from various moderation sources","items":{"type":"string"},"title":"Labels","type":"array","x-stream-index":"004"},"reason":{"description":"Optional explanation for the flag","title":"Reason","type":"string","x-stream-index":"002"},"type":{"description":"Type of check (custom_check_text, custom_check_image, custom_check_video)","maxLength":255,"title":"Type","type":"string","x-stream-index":"001"}},"required":["type"],"type":"object"},"CustomCheckRequest":{"nullable":true,"properties":{"entity_creator_id":{"description":"ID of the user who created the entity (required for non-message entities)","title":"Entity Creator ID","type":"string","x-stream-index":"003"},"entity_id":{"description":"Unique identifier of the entity","title":"Entity ID","type":"string","x-stream-index":"002"},"entity_type":{"description":"Type of entity to perform custom check on","title":"Entity Type","type":"string","x-stream-index":"001"},"flags":{"description":"List of custom check flags (1-10 flags required)","items":{"$ref":"#/components/schemas/CustomCheckFlag"},"maximum":10,"minimum":1,"title":"Flags","type":"array","x-stream-index":"005"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content to be checked (required for non-message entities)","title":"Moderation Payload","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"006.002"},"user_id":{"type":"string","x-stream-index":"006.001"}},"required":["entity_type","entity_id","flags"],"type":"object"},"CustomCheckResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"004.001"},"id":{"description":"Unique identifier of the custom check","title":"ID","type":"string","x-stream-index":"001"},"item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"Review queue item details","title":"Item","x-stream-index":"002"},"status":{"description":"Status of the custom check","title":"Status","type":"string","x-stream-index":"003"}},"required":["id","status","duration"],"type":"object"},"Data":{"properties":{"id":{"type":"string","x-stream-index":"001"}},"required":["id"],"type":"object"},"DataDogInfo":{"properties":{"api_key":{"type":"string","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"003"},"site":{"type":"string","x-stream-index":"002"}},"type":"object"},"DeactivateUserRequest":{"nullable":true,"properties":{"created_by_id":{"description":"ID of the user who deactivated the user","title":"Created by ID","type":"string","x-stream-index":"003"},"mark_messages_deleted":{"description":"Makes messages appear to be deleted","title":"Mark messages deleted","type":"boolean","x-stream-index":"002"}},"type":"object"},"DeactivateUserResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Deactivated user object","title":"User","x-stream-index":"001"}},"required":["duration"],"type":"object"},"DeactivateUsersRequest":{"description":"Deactivate users request","nullable":true,"properties":{"created_by_id":{"description":"ID of the user who deactivated the users","title":"Created by ID","type":"string","x-stream-index":"003"},"mark_channels_deleted":{"type":"boolean","x-stream-index":"004"},"mark_messages_deleted":{"description":"Makes messages appear to be deleted","title":"Mark messages deleted","type":"boolean","x-stream-index":"002"},"user_ids":{"description":"User IDs to deactivate","items":{"type":"string"},"maximum":100,"minimum":1,"title":"User IDs","type":"array","x-stream-index":"001"}},"required":["user_ids"],"title":"DeactivateUsersRequest","type":"object"},"DeactivateUsersResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"task_id":{"type":"string","x-stream-index":"001"}},"required":["task_id","duration"],"title":"Response","type":"object"},"DecayFunctionConfig":{"properties":{"base":{"description":"Base value for decay function","title":"Base","type":"string","x-stream-index":"001"},"decay":{"description":"Decay rate","title":"Decay","type":"string","x-stream-index":"005"},"direction":{"description":"Direction of decay","title":"Direction","type":"string","x-stream-index":"006"},"offset":{"description":"Offset value for decay function","title":"Offset","type":"string","x-stream-index":"004"},"origin":{"description":"Origin value for decay function","title":"Origin","type":"string","x-stream-index":"002"},"scale":{"description":"Scale factor for decay function","title":"Scale","type":"string","x-stream-index":"003"}},"title":"Decay Function Configuration","type":"object"},"DeleteActivitiesRequest":{"nullable":true,"properties":{"hard_delete":{"description":"Whether to permanently delete the activities","title":"Hard Delete","type":"boolean","x-stream-index":"002"},"ids":{"description":"List of activity IDs to delete","items":{"type":"string"},"minimum":1,"title":"Activity IDs","type":"array","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"required":["ids"],"title":"Delete Activities Request","type":"object"},"DeleteActivitiesResponse":{"nullable":true,"properties":{"deleted_ids":{"description":"List of activity IDs that were successfully deleted","items":{"type":"string"},"title":"Deleted Activity IDs","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["deleted_ids","duration"],"title":"Delete Activities Response","type":"object"},"DeleteActivityReactionResponse":{"nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"reaction":{"$ref":"#/components/schemas/FeedsReactionResponse","x-stream-index":"002"}},"required":["activity","reaction","duration"],"title":"Delete Activity Reaction Response","type":"object"},"DeleteActivityRequest":{"properties":{"hard_delete":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"DeleteActivityResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"Delete Activity Response","type":"object"},"DeleteBookmarkFolderResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"Delete Bookmark Folder Response","type":"object"},"DeleteBookmarkResponse":{"nullable":true,"properties":{"bookmark":{"$ref":"#/components/schemas/BookmarkResponse","description":"The deleted bookmark","title":"Bookmark","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["bookmark","duration"],"title":"Delete Bookmark Response","type":"object"},"DeleteCommentReactionResponse":{"nullable":true,"properties":{"comment":{"$ref":"#/components/schemas/CommentResponse","description":"The comment after reaction removal","title":"Comment","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"reaction":{"$ref":"#/components/schemas/FeedsReactionResponse","description":"The removed reaction","title":"Reaction","x-stream-index":"002"}},"required":["comment","reaction","duration"],"title":"Delete Comment Reaction Response","type":"object"},"DeleteCommentResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"Delete Comment Response","type":"object"},"DeleteExternalStorageResponse":{"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"},"DeleteFeedGroupResponse":{"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"},"DeleteFeedResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"Delete Feed Response","type":"object"},"DeleteFeedUserDataResponse":{"description":"Response for deleting feed user data","nullable":true,"properties":{"deleted_activities":{"description":"Number of activities that were deleted","format":"int32","title":"Deleted Activities","type":"integer","x-stream-index":"001"},"deleted_bookmarks":{"description":"Number of bookmarks that were deleted","format":"int32","title":"Deleted Bookmarks","type":"integer","x-stream-index":"004"},"deleted_comments":{"description":"Number of comments that were deleted","format":"int32","title":"Deleted Comments","type":"integer","x-stream-index":"003"},"deleted_reactions":{"description":"Number of reactions that were deleted","format":"int32","title":"Deleted Reactions","type":"integer","x-stream-index":"002"},"duration":{"type":"string","x-stream-index":"005.001"}},"required":["deleted_activities","deleted_reactions","deleted_comments","deleted_bookmarks","duration"],"type":"object"},"DeleteFeedViewResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"Delete Feed View Response","type":"object"},"DeleteMessageRequest":{"properties":{"hard_delete":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"DeleteModerationConfigResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"DeleteModerationRuleResponse":{"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"},"DeleteModerationTemplateResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"DeleteReactionRequest":{"properties":{"hard_delete":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"DeleteUserRequest":{"properties":{"delete_conversation_channels":{"type":"boolean","x-stream-index":"003"},"delete_feeds_content":{"type":"boolean","x-stream-index":"004"},"hard_delete":{"type":"boolean","x-stream-index":"001"},"mark_messages_deleted":{"type":"boolean","x-stream-index":"002"}},"type":"object"},"DeleteUsersRequest":{"nullable":true,"properties":{"calls":{"description":"Calls delete mode.\nAffected calls are those that include exactly two members, one of whom is the user being deleted.\n\n* null or empty string - doesn't delete any calls\n* soft - marks user's calls and their related data as deleted (soft-delete)\n* hard - deletes user's calls and their data completely (hard-delete)\n","enum":["soft","hard"],"title":"Delete User's calls","type":"string","x-stream-index":"001.002.004"},"conversations":{"description":"Conversation channels delete mode.\nConversation channel is any channel which only has two members one of which is the user being deleted.\n\n* null or empty string - doesn't delete any conversation channels\n* soft - marks all conversation channels as deleted (same effect as Delete Channels with 'hard' option disabled)\n* hard - deletes channel and all its data completely including messages (same effect as Delete Channels with 'hard' option enabled)\n","enum":["soft","hard"],"title":"Delete Conversations","type":"string","x-stream-index":"001.002.003"},"files":{"description":"Delete user files.\n* false or empty string - doesn't delete any files\n* true - deletes all files uploaded by the user, including images and attachments.\n","title":"Delete User's files","type":"boolean","x-stream-index":"001.002.005"},"messages":{"description":"Message delete mode.\n\n* null or empty string - doesn't delete user messages\n* soft - marks all user messages as deleted without removing any related message data\n* pruning - marks all user messages as deleted, nullifies message information and removes some message data such as reactions and flags\n* hard - deletes messages completely with all related information\n","enum":["soft","pruning","hard"],"title":"Delete Messages","type":"string","x-stream-index":"001.002.002"},"new_call_owner_id":{"type":"string","x-stream-index":"001.002.007"},"new_channel_owner_id":{"type":"string","x-stream-index":"001.002.006"},"user":{"description":"User delete mode.\n\n* soft - marks user as deleted and retains all user data\n* pruning - marks user as deleted and nullifies user information\n* hard - deletes user completely. Requires 'hard' option for messages and conversations as well\n","enum":["soft","pruning","hard"],"title":"Delete User","type":"string","x-stream-index":"001.002.001"},"user_ids":{"description":"IDs of users to delete","items":{"type":"string"},"maximum":100,"minimum":1,"title":"User IDs","type":"array","x-stream-index":"001.001"}},"required":["user_ids"],"type":"object"},"DeleteUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"task_id":{"description":"ID of the task to delete users","title":"Task ID","type":"string","x-stream-index":"001"}},"required":["task_id","duration"],"type":"object"},"Device":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"disabled":{"type":"boolean","x-stream-index":"002.003"},"disabled_reason":{"type":"string","x-stream-index":"002.004"},"id":{"type":"string","x-stream-index":"002.001.004"},"push_provider":{"enum":["firebase","apn","huawei","xiaomi"],"type":"string","x-stream-index":"002.001.001"},"push_provider_name":{"type":"string","x-stream-index":"002.001.003"},"user_id":{"type":"string","x-stream-index":"004"},"voip":{"type":"boolean","x-stream-index":"002.001.005"}},"required":["push_provider","id","created_at","user_id"],"type":"object"},"DeviceErrorInfo":{"properties":{"error_message":{"type":"string","x-stream-index":"003"},"provider":{"type":"string","x-stream-index":"001"},"provider_name":{"type":"string","x-stream-index":"002"}},"required":["provider","provider_name","error_message"],"type":"object"},"DeviceResponse":{"description":"Response for Device","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"004"},"disabled":{"description":"Whether device is disabled or not","title":"Disabled","type":"boolean","x-stream-index":"005"},"disabled_reason":{"description":"Reason explaining why device had been disabled","title":"Reason","type":"string","x-stream-index":"006"},"id":{"description":"Device ID","title":"ID","type":"string","x-stream-index":"003"},"push_provider":{"description":"Push provider","title":"PushProvider","type":"string","x-stream-index":"001"},"push_provider_name":{"description":"Push provider name","title":"PushProviderName","type":"string","x-stream-index":"002"},"user_id":{"description":"User ID","title":"UserID","type":"string","x-stream-index":"008"},"voip":{"description":"When true the token is for Apple VoIP push notifications","title":"Voip","type":"boolean","x-stream-index":"007"}},"required":["push_provider","id","created_at","user_id"],"title":"DeviceResponse","type":"object"},"DraftPayloadResponse":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"html":{"type":"string","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"001"},"mentioned_users":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"008"},"mml":{"type":"string","x-stream-index":"003"},"parent_id":{"type":"string","x-stream-index":"005"},"poll_id":{"type":"string","x-stream-index":"013"},"quoted_message_id":{"type":"string","x-stream-index":"009"},"show_in_channel":{"type":"boolean","x-stream-index":"006"},"silent":{"type":"boolean","x-stream-index":"012"},"text":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"011"}},"required":["id","text","custom"],"type":"object"},"DraftResponse":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003"},"channel_cid":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"message":{"$ref":"#/components/schemas/DraftPayloadResponse","x-stream-index":"001"},"parent_id":{"type":"string","x-stream-index":"004"},"parent_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"005"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"006"}},"required":["message","channel_cid","created_at"],"type":"object"},"EgressHLSResponse":{"properties":{"playlist_url":{"type":"string","x-stream-index":"001"},"status":{"type":"string","x-stream-index":"002"}},"required":["playlist_url","status"],"type":"object"},"EgressRTMPResponse":{"properties":{"name":{"type":"string","x-stream-index":"001"},"started_at":{"format":"date-time","type":"number","x-stream-index":"004"},"stream_key":{"type":"string","x-stream-index":"003"},"stream_url":{"type":"string","x-stream-index":"002"}},"required":["name","started_at"],"type":"object"},"EgressResponse":{"properties":{"broadcasting":{"type":"boolean","x-stream-index":"001"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordingResponse","x-stream-index":"004"},"hls":{"$ref":"#/components/schemas/EgressHLSResponse","x-stream-index":"002"},"rtmps":{"items":{"$ref":"#/components/schemas/EgressRTMPResponse"},"type":"array","x-stream-index":"003"}},"required":["broadcasting","rtmps"],"type":"object"},"EgressTaskConfig":{"properties":{"egress_user":{"$ref":"#/components/schemas/EgressUser","x-stream-index":"008"},"frame_recording_egress_config":{"$ref":"#/components/schemas/FrameRecordingEgressConfig","x-stream-index":"009"},"hls_egress_config":{"$ref":"#/components/schemas/HLSEgressConfig","x-stream-index":"007"},"recording_egress_config":{"$ref":"#/components/schemas/RecordingEgressConfig","x-stream-index":"006"},"rtmp_egress_config":{"$ref":"#/components/schemas/RTMPEgressConfig","x-stream-index":"004"},"stt_egress_config":{"$ref":"#/components/schemas/STTEgressConfig","x-stream-index":"005"}},"type":"object"},"EgressUser":{"properties":{"token":{"type":"string","x-stream-index":"004"}},"type":"object"},"EnrichedActivity":{"properties":{"actor":{"$ref":"#/components/schemas/Data","x-stream-index":"002"},"foreign_id":{"type":"string","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"latest_reactions":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"013"},"object":{"$ref":"#/components/schemas/Data","x-stream-index":"004"},"origin":{"$ref":"#/components/schemas/Data","x-stream-index":"008"},"own_reactions":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"012"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"011"},"score":{"format":"float","type":"number","x-stream-index":"010"},"target":{"$ref":"#/components/schemas/Data","x-stream-index":"006"},"to":{"items":{"type":"string"},"type":"array","x-stream-index":"009"},"verb":{"type":"string","x-stream-index":"003"}},"type":"object"},"EnrichedReaction":{"nullable":true,"properties":{"activity_id":{"type":"string","x-stream-index":"003"},"children_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"010"},"created_at":{"$ref":"#/components/schemas/Time","x-stream-index":"012"},"data":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"kind":{"type":"string","x-stream-index":"002"},"latest_children":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"008"},"own_children":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"009"},"parent":{"type":"string","x-stream-index":"007"},"target_feeds":{"items":{"type":"string"},"type":"array","x-stream-index":"006"},"updated_at":{"$ref":"#/components/schemas/Time","x-stream-index":"013"},"user":{"$ref":"#/components/schemas/Data","x-stream-index":"011"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["kind","activity_id","user_id"],"type":"object"},"EntityCreator":{"properties":{"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"001.046"},"ban_count":{"format":"int32","type":"integer","x-stream-index":"002"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"001.017"},"banned":{"type":"boolean","x-stream-index":"001.016"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.013"},"deleted_content_count":{"format":"int32","type":"integer","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"001.023"},"language":{"type":"string","x-stream-index":"001.035"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"001.022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"001.026"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.042"},"role":{"type":"string","x-stream-index":"001.004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.005"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.009"}},"required":["id","role","teams_role","custom","banned","online","ban_count","deleted_content_count"],"type":"object"},"EntityCreatorResponse":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.001.018"},"ban_count":{"description":"Number of minor actions performed on the user","format":"int32","title":"Ban Count","type":"integer","x-stream-index":"002"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"001.003"},"banned":{"type":"boolean","x-stream-index":"001.001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.001.017"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.001.016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.001.011"},"deleted_content_count":{"description":"Number of major actions performed on the user","format":"int32","title":"Deleted Content Count","type":"integer","x-stream-index":"003"},"devices":{"items":{"$ref":"#/components/schemas/DeviceResponse"},"type":"array","x-stream-index":"001.006"},"flagged_count":{"description":"Number of flag actions performed on the user","format":"int32","title":"Flagged Count","type":"integer","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001.001.001"},"image":{"type":"string","x-stream-index":"001.001.003"},"invisible":{"type":"boolean","x-stream-index":"001.007"},"language":{"type":"string","x-stream-index":"001.001.005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"001.001.014"},"name":{"type":"string","x-stream-index":"001.001.002"},"online":{"type":"boolean","x-stream-index":"001.001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"001.005"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettingsResponse","x-stream-index":"001.004"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.001.015"},"role":{"type":"string","x-stream-index":"001.001.006"},"shadow_banned":{"type":"boolean","x-stream-index":"001.002"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.001.008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids","shadow_banned","invisible","ban_count","deleted_content_count","flagged_count"],"type":"object"},"ErrorResult":{"properties":{"stacktrace":{"type":"string","x-stream-index":"003"},"type":{"type":"string","x-stream-index":"001"},"version":{"type":"string","x-stream-index":"004"}},"required":["type","description"],"type":"object"},"EventHook":{"nullable":true,"properties":{"callback":{"$ref":"#/components/schemas/AsyncModerationCallbackConfig","x-stream-index":"019.001.002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"020"},"enabled":{"type":"boolean","x-stream-index":"003"},"event_types":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"hook_type":{"type":"string","x-stream-index":"002"},"id":{"type":"string","x-stream-index":"001"},"product":{"type":"string","x-stream-index":"018"},"sns_auth_type":{"type":"string","x-stream-index":"014"},"sns_key":{"type":"string","x-stream-index":"015"},"sns_region":{"type":"string","x-stream-index":"013"},"sns_role_arn":{"type":"string","x-stream-index":"017"},"sns_secret":{"type":"string","x-stream-index":"016"},"sns_topic_arn":{"type":"string","x-stream-index":"012"},"sqs_auth_type":{"type":"string","x-stream-index":"008"},"sqs_key":{"type":"string","x-stream-index":"009"},"sqs_queue_url":{"type":"string","x-stream-index":"006"},"sqs_region":{"type":"string","x-stream-index":"007"},"sqs_role_arn":{"type":"string","x-stream-index":"011"},"sqs_secret":{"type":"string","x-stream-index":"010"},"timeout_ms":{"format":"int32","type":"integer","x-stream-index":"019.001.001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"021"},"webhook_url":{"type":"string","x-stream-index":"005"}},"type":"object"},"EventNotificationSettings":{"properties":{"apns":{"$ref":"#/components/schemas/APNS","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"fcm":{"$ref":"#/components/schemas/FCM","x-stream-index":"003"}},"required":["enabled","apns","fcm"],"type":"object"},"ExportFeedUserDataRequest":{"description":"Request for exporting feed user data","nullable":true,"type":"object"},"ExportFeedUserDataResponse":{"description":"Response for exporting feed user data","nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"task_id":{"description":"The task ID for the export task","title":"Task ID","type":"string","x-stream-index":"001"}},"required":["task_id","duration"],"type":"object"},"ExportUserResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"004.001"},"messages":{"description":"List of exported messages","items":{"$ref":"#/components/schemas/MessageResponse"},"title":"Messages","type":"array","x-stream-index":"002"},"reactions":{"description":"List of exported reactions","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Reactions","type":"array","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Exported user object","title":"User","x-stream-index":"001"}},"required":["duration"],"type":"object"},"ExportUsersRequest":{"nullable":true,"properties":{"user_ids":{"items":{"type":"string"},"maximum":25,"minimum":1,"type":"array","x-stream-index":"001"}},"required":["user_ids"],"type":"object"},"ExportUsersResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"task_id":{"type":"string","x-stream-index":"001"}},"required":["task_id","duration"],"title":"Response","type":"object"},"ExternalStorage":{"properties":{"abs_account_name":{"type":"string","x-stream-index":"011"},"abs_client_id":{"type":"string","x-stream-index":"013"},"abs_client_secret":{"type":"string","x-stream-index":"014"},"abs_tenant_id":{"type":"string","x-stream-index":"012"},"bucket":{"type":"string","x-stream-index":"005"},"gcs_credentials":{"type":"string","x-stream-index":"010"},"path":{"type":"string","x-stream-index":"006"},"s3_api_key":{"type":"string","x-stream-index":"007"},"s3_custom_endpoint":{"type":"string","x-stream-index":"016"},"s3_region":{"type":"string","x-stream-index":"009"},"s3_secret_key":{"type":"string","x-stream-index":"008"},"storage_name":{"type":"string","x-stream-index":"015"},"storage_type":{"type":"integer","x-stream-index":"004"}},"type":"object"},"ExternalStorageResponse":{"properties":{"bucket":{"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"path":{"type":"string","x-stream-index":"004"},"type":{"enum":["s3","gcs","abs"],"type":"string","x-stream-index":"002"}},"required":["name","type","bucket","path"],"type":"object"},"FCM":{"properties":{"data":{"additionalProperties":{},"type":"object","x-stream-index":"001"}},"type":"object"},"FeedCreatedEvent":{"description":"Emitted when a feed is created.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"003.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.001.007"},"feed":{"$ref":"#/components/schemas/FeedResponse","description":"The feed that was created","title":"Feed","x-stream-index":"001"},"feed_visibility":{"type":"string","x-stream-index":"003.003"},"fid":{"type":"string","x-stream-index":"003.002"},"members":{"items":{"$ref":"#/components/schemas/FeedMemberResponse"},"type":"array","x-stream-index":"002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.001.004"},"type":{"default":"feeds.feed.created","description":"The type of event: \"feeds.feed.created\" in this case","title":"Event Type","type":"string","x-stream-index":"003.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who created the feed","title":"User","x-stream-index":"004.001"}},"required":["feed","members","type","created_at","custom","fid","user"],"title":"FeedCreatedEvent","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"},"FeedDeletedEvent":{"description":"Emitted when a feed is deleted.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.007"},"feed_visibility":{"type":"string","x-stream-index":"001.003"},"fid":{"type":"string","x-stream-index":"001.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"type":{"default":"feeds.feed.deleted","description":"The type of event: \"feeds.feed.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who deleted the feed","title":"User","x-stream-index":"002.001"}},"required":["type","created_at","custom","fid"],"title":"FeedDeletedEvent","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"},"FeedGroup":{"properties":{"ActivityProcessors":{"items":{"$ref":"#/components/schemas/ActivityProcessorConfig"},"type":"array","writeOnly":true,"x-stream-index":"012"},"ActivitySelectors":{"items":{"$ref":"#/components/schemas/ActivitySelectorConfig"},"type":"array","writeOnly":true,"x-stream-index":"013"},"Aggregation":{"$ref":"#/components/schemas/AggregationConfig","x-stream-index":"015"},"AggregationVersion":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"016"},"AppPK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"002"},"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"007"},"DefaultVisibility":{"type":"string","writeOnly":true,"x-stream-index":"006"},"DeletedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"010"},"ID":{"type":"string","writeOnly":true,"x-stream-index":"003"},"LastFeedGetAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"017"},"Notification":{"$ref":"#/components/schemas/NotificationConfig","x-stream-index":"004"},"PushNotification":{"$ref":"#/components/schemas/PushNotificationConfig","x-stream-index":"005"},"Ranking":{"$ref":"#/components/schemas/RankingConfig","x-stream-index":"014"},"Stories":{"$ref":"#/components/schemas/StoriesConfig","x-stream-index":"011"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"}},"required":["AppPK","ID","DefaultVisibility","Custom","created_at","updated_at","ActivityProcessors","ActivitySelectors","AggregationVersion"],"type":"object"},"FeedGroupChangedEvent":{"description":"Emitted when a feed group is changed.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.007"},"feed_group":{"$ref":"#/components/schemas/FeedGroup","description":"The feed group that was changed","title":"Feed Type","x-stream-index":"003"},"feed_visibility":{"type":"string","x-stream-index":"001.003"},"fid":{"type":"string","x-stream-index":"001.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"type":{"default":"feeds.feed_group.changed","description":"The type of event: \"feeds.feed_group.changed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who changed the feed group","title":"User","x-stream-index":"002.001"}},"required":["type","created_at","custom","fid"],"title":"FeedGroupChangedEvent","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"},"FeedGroupDeletedEvent":{"description":"Emitted when a feed group is deleted.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"type":"string","x-stream-index":"002.002"},"group_id":{"description":"The ID of the feed group that was deleted","title":"Group ID","type":"string","x-stream-index":"001"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.feed_group.deleted","description":"The type of event: \"feeds.feed_group.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"}},"required":["group_id","type","created_at","custom","fid"],"title":"FeedGroupDeletedEvent","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"},"FeedGroupResponse":{"properties":{"activity_processors":{"description":"Configuration for activity processors","items":{"$ref":"#/components/schemas/ActivityProcessorConfig"},"title":"Activity Processors","type":"array","x-stream-index":"009"},"activity_selectors":{"description":"Configuration for activity selectors","items":{"$ref":"#/components/schemas/ActivitySelectorConfig"},"title":"Activity Selectors","type":"array","x-stream-index":"010"},"aggregation":{"$ref":"#/components/schemas/AggregationConfig","description":"Configuration for activity aggregation","title":"Aggregation","x-stream-index":"012"},"created_at":{"description":"When the feed group was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"006"},"custom":{"additionalProperties":{},"description":"Custom data for the feed group","title":"Custom Data","type":"object","x-stream-index":"005"},"default_visibility":{"description":"Default visibility for activities","title":"Default Visibility","type":"string","x-stream-index":"004"},"id":{"description":"Identifier within the group","title":"Feed Group ID","type":"string","x-stream-index":"001"},"notification":{"$ref":"#/components/schemas/NotificationConfig","description":"Configuration for notifications","title":"Notification","x-stream-index":"002"},"push_notification":{"$ref":"#/components/schemas/PushNotificationConfig","x-stream-index":"003"},"ranking":{"$ref":"#/components/schemas/RankingConfig","description":"Configuration for activity ranking","title":"Ranking","x-stream-index":"011"},"stories":{"$ref":"#/components/schemas/StoriesConfig","description":"Configuration for stories feature","title":"Stories","x-stream-index":"008"},"updated_at":{"description":"When the feed group was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"007"}},"required":["id","created_at","updated_at"],"title":"Feed Group","type":"object"},"FeedInput":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"description":{"maxLength":1000,"type":"string","x-stream-index":"002"},"filter_tags":{"items":{"type":"string"},"maximum":255,"type":"array","x-stream-index":"005"},"members":{"items":{"$ref":"#/components/schemas/FeedMemberRequest"},"type":"array","x-stream-index":"006"},"name":{"maxLength":255,"type":"string","x-stream-index":"001"},"visibility":{"enum":["public","visible","followers","members","private"],"type":"string","x-stream-index":"003"}},"type":"object"},"FeedMemberAddedEvent":{"description":"Emitted when a feed member is added.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"003.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.001.007"},"feed_visibility":{"type":"string","x-stream-index":"003.003"},"fid":{"type":"string","x-stream-index":"003.002"},"member":{"$ref":"#/components/schemas/FeedMemberResponse","description":"The member that was added","title":"Member","x-stream-index":"001"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.001.004"},"type":{"default":"feeds.feed_member.added","description":"The type of event: \"feeds.feed_member.added\" in this case","title":"Event Type","type":"string","x-stream-index":"003.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who added the member","title":"User","x-stream-index":"002.001"}},"required":["member","type","created_at","custom","fid"],"title":"FeedMemberAddedEvent","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"},"FeedMemberRemovedEvent":{"description":"Emitted when a feed member is removed.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"003.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.001.007"},"feed_visibility":{"type":"string","x-stream-index":"003.003"},"fid":{"type":"string","x-stream-index":"003.002"},"member_id":{"type":"string","x-stream-index":"001"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.001.004"},"type":{"default":"feeds.feed_member.removed","description":"The type of event: \"feeds.feed_member.removed\" in this case","title":"Event Type","type":"string","x-stream-index":"003.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who removed the member","title":"User","x-stream-index":"002.001"}},"required":["member_id","type","created_at","custom","fid"],"title":"FeedMemberRemovedEvent","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"},"FeedMemberRequest":{"properties":{"custom":{"additionalProperties":{},"description":"Custom data for the member","title":"Custom Data","type":"object","x-stream-index":"004"},"invite":{"description":"Whether this is an invite to become a member","title":"Invite","type":"boolean","x-stream-index":"005"},"membership_level":{"description":"ID of the membership level to assign to the member","maxLength":255,"title":"Membership Level","type":"string","x-stream-index":"003"},"role":{"description":"Role of the member in the feed","maxLength":255,"title":"Role","type":"string","x-stream-index":"002"},"user_id":{"description":"ID of the user to add as a member","maxLength":255,"title":"User ID","type":"string","x-stream-index":"001"}},"required":["user_id"],"title":"Feed Member Payload","type":"object"},"FeedMemberResponse":{"properties":{"created_at":{"description":"When the membership was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"description":"Custom data for the membership","title":"Custom Data","type":"object","x-stream-index":"007"},"invite_accepted_at":{"description":"When the invite was accepted","format":"date-time","title":"Invite Accepted At","type":"number","x-stream-index":"005"},"invite_rejected_at":{"description":"When the invite was rejected","format":"date-time","title":"Invite Rejected At","type":"number","x-stream-index":"006"},"membership_level":{"$ref":"#/components/schemas/MembershipLevelResponse","description":"Membership level assigned to the member","title":"Membership Level","x-stream-index":"004"},"role":{"description":"Role of the member in the feed","title":"Role","type":"string","x-stream-index":"002"},"status":{"description":"Status of the membership","enum":["member","pending","rejected"],"title":"Status","type":"string","x-stream-index":"003"},"updated_at":{"description":"When the membership was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who is a member","title":"User","x-stream-index":"001"}},"required":["user","role","status","created_at","updated_at"],"title":"Feed Member","type":"object"},"FeedMemberUpdatedEvent":{"description":"Emitted when a feed member is updated.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"003.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.001.007"},"feed_visibility":{"type":"string","x-stream-index":"003.003"},"fid":{"type":"string","x-stream-index":"003.002"},"member":{"$ref":"#/components/schemas/FeedMemberResponse","description":"The member that was updated","title":"Member","x-stream-index":"001"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.001.004"},"type":{"default":"feeds.feed_member.updated","description":"The type of event: \"feeds.feed_member.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"003.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who updated the member","title":"User","x-stream-index":"002.001"}},"required":["member","type","created_at","custom","fid"],"title":"FeedMemberUpdatedEvent","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"},"FeedOwnCapability":{"description":"All possibility of string to use","enum":["add-activity","add-activity-reaction","add-comment","add-comment-reaction","bookmark-activity","create-feed","delete-bookmark","delete-comment","delete-feed","edit-bookmark","follow","invite-feed","join-feed","leave-feed","manage-feed-group","mark-activity","pin-activity","query-feed-members","query-follows","read-activities","read-feed","remove-activity","remove-activity-reaction","remove-comment-reaction","unfollow","update-activity","update-comment","update-feed","update-feed-followers","update-feed-members"],"title":"FeedOwnCapability","type":"string"},"FeedRequest":{"properties":{"created_by_id":{"description":"ID of the feed creator","title":"Created By ID","type":"string","x-stream-index":"003"},"custom":{"additionalProperties":{},"description":"Custom data for the feed","title":"Custom Data","type":"object","x-stream-index":"004.004"},"description":{"description":"Description of the feed","maxLength":1000,"title":"Description","type":"string","x-stream-index":"004.002"},"feed_group_id":{"description":"ID of the feed group","maxLength":255,"title":"Feed Group ID","type":"string","x-stream-index":"001"},"feed_id":{"description":"ID of the feed","maxLength":255,"title":"Feed ID","type":"string","x-stream-index":"002"},"filter_tags":{"description":"Tags used for filtering feeds","items":{"type":"string"},"maximum":255,"title":"Filter Tags","type":"array","x-stream-index":"004.005"},"members":{"description":"Initial members for the feed","items":{"$ref":"#/components/schemas/FeedMemberRequest"},"title":"Members","type":"array","x-stream-index":"004.006"},"name":{"description":"Name of the feed","maxLength":255,"title":"Name","type":"string","x-stream-index":"004.001"},"visibility":{"description":"Visibility setting for the feed","enum":["public","visible","followers","members","private"],"title":"Visibility","type":"string","x-stream-index":"004.003"}},"required":["feed_group_id","feed_id"],"title":"Feed Payload","type":"object"},"FeedResponse":{"properties":{"created_at":{"description":"When the feed was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"015"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"User who created the feed","title":"Created By","x-stream-index":"009"},"custom":{"additionalProperties":{},"description":"Custom data for the feed","title":"Custom Data","type":"object","x-stream-index":"006"},"deleted_at":{"description":"When the feed was deleted","format":"date-time","title":"Deleted At","type":"number","x-stream-index":"017"},"description":{"description":"Description of the feed","title":"Description","type":"string","x-stream-index":"005"},"feed":{"description":"Fully qualified feed ID (group_id:id)","title":"FID","type":"string","x-stream-index":"003"},"filter_tags":{"description":"Tags used for filtering feeds","items":{"type":"string"},"title":"Filter Tags","type":"array","x-stream-index":"007"},"follower_count":{"description":"Number of followers of this feed","format":"int32","title":"Follower Count","type":"integer","x-stream-index":"011"},"following_count":{"description":"Number of feeds this feed follows","format":"int32","title":"Following Count","type":"integer","x-stream-index":"012"},"group_id":{"description":"Group this feed belongs to","title":"Group ID","type":"string","x-stream-index":"001"},"id":{"description":"Unique identifier for the feed","title":"ID","type":"string","x-stream-index":"002"},"member_count":{"description":"Number of members in this feed","format":"int32","title":"Member Count","type":"integer","x-stream-index":"010"},"name":{"description":"Name of the feed","title":"Name","type":"string","x-stream-index":"004"},"own_follows":{"description":"Follow relationships where the current user's feeds are following this feed","items":{"$ref":"#/components/schemas/FollowResponse"},"title":"Own Follows","type":"array","x-stream-index":"014"},"pin_count":{"description":"Number of pinned activities in this feed","format":"int32","title":"Pin Count","type":"integer","x-stream-index":"013"},"updated_at":{"description":"When the feed was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"016"},"visibility":{"description":"Visibility setting for the feed","title":"Visibility","type":"string","x-stream-index":"008"}},"required":["group_id","id","feed","name","description","created_by","member_count","follower_count","following_count","pin_count","created_at","updated_at"],"title":"Feed","type":"object"},"FeedUpdatedEvent":{"description":"Emitted when a feed is created.","nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed":{"$ref":"#/components/schemas/FeedResponse","description":"The feed that was created","title":"Feed","x-stream-index":"001"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"type":"string","x-stream-index":"002.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.feed.updated","description":"The type of event: \"feeds.feed.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who created the feed","title":"User","x-stream-index":"003.001"}},"required":["feed","type","created_at","custom","fid"],"title":"FeedUpdatedEvent","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"},"FeedViewResponse":{"properties":{"activity_processors":{"description":"Configured activity processors","items":{"$ref":"#/components/schemas/ActivityProcessorConfig"},"title":"Activity Processors","type":"array","x-stream-index":"003"},"activity_selectors":{"description":"Configured activity selectors","items":{"$ref":"#/components/schemas/ActivitySelectorConfig"},"title":"Activity Selectors","type":"array","x-stream-index":"002"},"aggregation":{"$ref":"#/components/schemas/AggregationConfig","description":"Configuration for activity aggregation","title":"Aggregation","x-stream-index":"005"},"id":{"description":"Unique identifier for the custom feed view","title":"View ID","type":"string","x-stream-index":"001"},"last_used_at":{"description":"When the feed view was last used","format":"date-time","title":"Last Used At","type":"number","x-stream-index":"006"},"ranking":{"$ref":"#/components/schemas/RankingConfig","description":"Configuration for activity ranking","title":"Ranking","x-stream-index":"004"}},"required":["id"],"title":"Feed View","type":"object"},"FeedsEventPreferences":{"properties":{"comments":{"type":"string","x-stream-index":"002"},"mentions":{"type":"string","x-stream-index":"004"},"new_followers":{"type":"string","x-stream-index":"003"},"reactions":{"type":"string","x-stream-index":"001"}},"type":"object"},"FeedsModerationTemplateConfig":{"properties":{"config_key":{"type":"string","x-stream-index":"002"},"data_types":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001"}},"required":["data_types","config_key"],"type":"object"},"FeedsReactionResponse":{"properties":{"activity_id":{"description":"ID of the activity that was reacted to","title":"Activity ID","type":"string","x-stream-index":"002"},"comment_id":{"description":"ID of the comment that was reacted to","title":"Comment ID","type":"string","x-stream-index":"003"},"created_at":{"description":"When the reaction was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"006"},"custom":{"additionalProperties":{},"description":"Custom data for the reaction","title":"Custom Data","type":"object","x-stream-index":"005"},"type":{"description":"Type of reaction","title":"Type","type":"string","x-stream-index":"004"},"updated_at":{"description":"When the reaction was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"007"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who created the reaction","title":"User","x-stream-index":"001"}},"required":["user","activity_id","type","created_at","updated_at"],"title":"Activity Reaction","type":"object"},"Field":{"nullable":true,"properties":{"short":{"type":"boolean","x-stream-index":"003"},"title":{"type":"string","x-stream-index":"001"},"value":{"type":"string","x-stream-index":"002"}},"required":["title","value","short"],"type":"object"},"FileUploadConfig":{"properties":{"allowed_file_extensions":{"items":{"type":"string"},"type":"array","x-stream-index":"001"},"allowed_mime_types":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"blocked_file_extensions":{"items":{"type":"string"},"type":"array","x-stream-index":"002"},"blocked_mime_types":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"size_limit":{"format":"int32","maximum":104857600,"minimum":0,"type":"integer","x-stream-index":"005"}},"required":["size_limit"],"type":"object"},"FileUploadRequest":{"nullable":true,"properties":{"file":{"description":"file field","title":"File","type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/OnlyUserID","description":"user for the request **server side only**","title":"User","x-stream-index":"002"}},"type":"object"},"FileUploadResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"file":{"description":"URL to the uploaded asset. Should be used to put to `asset_url` attachment field","title":"File","type":"string","x-stream-index":"001"},"thumb_url":{"description":"URL of the file thumbnail for supported file formats. Should be put to `thumb_url` attachment field","title":"Thumbnail URL","type":"string","x-stream-index":"002"}},"required":["duration"],"type":"object"},"FirebaseConfig":{"properties":{"Disabled":{"type":"boolean","writeOnly":true,"x-stream-index":"001"},"apn_template":{"type":"string","x-stream-index":"005"},"credentials_json":{"type":"string","x-stream-index":"006"},"data_template":{"type":"string","x-stream-index":"004"},"notification_template":{"type":"string","x-stream-index":"003"},"server_key":{"type":"string","x-stream-index":"002"}},"type":"object"},"FirebaseConfigFields":{"properties":{"apn_template":{"type":"string","x-stream-index":"004"},"credentials_json":{"type":"string","x-stream-index":"006"},"data_template":{"type":"string","x-stream-index":"003"},"enabled":{"type":"boolean","x-stream-index":"001"},"notification_template":{"type":"string","x-stream-index":"002"},"server_key":{"type":"string","x-stream-index":"005"}},"required":["enabled"],"type":"object"},"Flag":{"description":"Contains information about flagged user or message","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"019"},"custom":{"additionalProperties":{},"description":"Additional metadata about the flag","title":"Custom","type":"object","x-stream-index":"014"},"entity_creator_id":{"description":"ID of the user who created the flagged entity","title":"Entity Creator ID","type":"string","x-stream-index":"009"},"entity_id":{"description":"Unique identifier of the entity being flagged","title":"Entity ID","type":"string","x-stream-index":"008"},"entity_type":{"description":"Type of entity being flagged (e.g., message, user)","title":"Entity Type","type":"string","x-stream-index":"007"},"is_streamed_content":{"type":"boolean","x-stream-index":"012"},"labels":{"description":"Labels from bodyguard, API calls, our own AI etc","items":{"type":"string"},"title":"Labels","type":"array","x-stream-index":"015"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content being flagged","title":"Moderation Payload","x-stream-index":"010"},"moderation_payload_hash":{"type":"string","x-stream-index":"011"},"reason":{"description":"Optional explanation for why the content is being flagged","title":"Reason","type":"string","x-stream-index":"013"},"result":{"description":"Result of bodyguard, API calls, our own AI etc","items":{"additionalProperties":{},"type":"object"},"title":"Result","type":"array","x-stream-index":"016"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"018"},"review_queue_item_id":{"description":"ID of the review queue item","title":"Review Queue Item ID","type":"string","x-stream-index":"017"},"type":{"type":"string","x-stream-index":"004"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"020"},"user":{"$ref":"#/components/schemas/User","description":"User who flagged a message or a user","title":"User","x-stream-index":"006"}},"required":["entity_type","entity_id","result","created_at","updated_at"],"title":"Flag","type":"object"},"FlagContentOptions":{"properties":{"reason":{"type":"string","x-stream-index":"001"}},"type":"object"},"FlagRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"description":"Additional metadata about the flag","title":"Custom","type":"object","x-stream-index":"006"},"entity_creator_id":{"description":"ID of the user who created the flagged entity","title":"Entity Creator ID","type":"string","x-stream-index":"003"},"entity_id":{"description":"Unique identifier of the entity being flagged","title":"Entity ID","type":"string","x-stream-index":"002"},"entity_type":{"description":"Type of entity being flagged (e.g., message, user)","title":"Entity Type","type":"string","x-stream-index":"001"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content being flagged","title":"Moderation Payload","x-stream-index":"005"},"reason":{"description":"Optional explanation for why the content is being flagged","maxLength":255,"title":"Reason","type":"string","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"007.002"},"user_id":{"type":"string","x-stream-index":"007.001"}},"required":["entity_type","entity_id"],"type":"object"},"FlagResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"item_id":{"description":"Unique identifier of the created moderation item","title":"Item ID","type":"string","x-stream-index":"001"}},"required":["item_id","duration"],"type":"object"},"FlagUserOptions":{"properties":{"reason":{"type":"string","x-stream-index":"001"}},"type":"object"},"FollowBatchRequest":{"nullable":true,"properties":{"follows":{"description":"List of follow relationships to create","items":{"$ref":"#/components/schemas/FollowRequest"},"maximum":1000,"minimum":1,"title":"Follows","type":"array","x-stream-index":"001"}},"required":["follows"],"title":"Follow Batch Request","type":"object"},"FollowBatchResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"follows":{"description":"List of created follow relationships","items":{"$ref":"#/components/schemas/FollowResponse"},"title":"Follows","type":"array","x-stream-index":"001"}},"required":["follows","duration"],"title":"Follow Batch Response","type":"object"},"FollowCreatedEvent":{"description":"Emitted when a feed follows another feed.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"type":"string","x-stream-index":"002.002"},"follow":{"$ref":"#/components/schemas/FollowResponse","x-stream-index":"001"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.follow.created","description":"The type of event: \"feeds.follow.created\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"}},"required":["follow","type","created_at","custom","fid"],"title":"FollowCreatedEvent","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"},"FollowDeletedEvent":{"description":"Emitted when a feed unfollows another feed.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"type":"string","x-stream-index":"002.002"},"follow":{"$ref":"#/components/schemas/FollowResponse","x-stream-index":"001"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.follow.deleted","description":"The type of event: \"feeds.follow.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"}},"required":["follow","type","created_at","custom","fid"],"title":"FollowDeletedEvent","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"},"FollowPair":{"properties":{"source":{"description":"Fully qualified ID of the source feed","maxLength":255,"title":"Source Feed","type":"string","x-stream-index":"001"},"target":{"description":"Fully qualified ID of the target feed","maxLength":255,"title":"Target Feed","type":"string","x-stream-index":"002"}},"required":["source","target"],"title":"FollowPair","type":"object"},"FollowRequest":{"nullable":true,"properties":{"create_notification_activity":{"description":"Whether to create a notification activity for this follow","title":"Create Notification Activity","type":"boolean","x-stream-index":"004"},"custom":{"additionalProperties":{},"description":"Custom data for the follow relationship","title":"Custom Data","type":"object","x-stream-index":"002"},"push_preference":{"description":"Push preference for the follow relationship","enum":["all","none"],"title":"Push Preference","type":"string","x-stream-index":"003"},"skip_push":{"type":"boolean","x-stream-index":"005"},"source":{"description":"Fully qualified ID of the source feed","maxLength":255,"title":"Source Feed","type":"string","x-stream-index":"001.001"},"target":{"description":"Fully qualified ID of the target feed","maxLength":255,"title":"Target Feed","type":"string","x-stream-index":"001.002"}},"required":["source","target"],"title":"Follow Request","type":"object"},"FollowResponse":{"properties":{"created_at":{"description":"When the follow relationship was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"009"},"custom":{"additionalProperties":{},"description":"Custom data for the follow relationship","title":"Custom Data","type":"object","x-stream-index":"004"},"follower_role":{"description":"Role of the follower (source user) in the follow relationship","title":"Follower Role","type":"string","x-stream-index":"008"},"push_preference":{"description":"Push preference for notifications","enum":["all","none"],"title":"Push Preference","type":"string","x-stream-index":"003"},"request_accepted_at":{"description":"When the follow request was accepted","format":"date-time","title":"Request Accepted At","type":"number","x-stream-index":"005"},"request_rejected_at":{"description":"When the follow request was rejected","format":"date-time","title":"Request Rejected At","type":"number","x-stream-index":"006"},"source_feed":{"$ref":"#/components/schemas/FeedResponse","description":"Source feed object","title":"Source Feed","x-stream-index":"001"},"status":{"description":"Status of the follow relationship","enum":["accepted","pending","rejected"],"title":"Status","type":"string","x-stream-index":"007"},"target_feed":{"$ref":"#/components/schemas/FeedResponse","description":"Target feed object","title":"Target Feed","x-stream-index":"002"},"updated_at":{"description":"When the follow relationship was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"010"}},"required":["source_feed","target_feed","push_preference","status","follower_role","created_at","updated_at"],"title":"Follow","type":"object"},"FollowUpdatedEvent":{"description":"Emitted when a follow relationship is updated.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"type":"string","x-stream-index":"002.002"},"follow":{"$ref":"#/components/schemas/FollowResponse","x-stream-index":"001"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.follow.updated","description":"The type of event: \"feeds.follow.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"}},"required":["follow","type","created_at","custom","fid"],"title":"FollowUpdatedEvent","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"},"FrameRecordSettings":{"properties":{"capture_interval_in_seconds":{"format":"int32","maximum":60,"minimum":2,"type":"integer","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"},"quality":{"type":"string","x-stream-index":"002"}},"required":["mode","capture_interval_in_seconds"],"type":"object"},"FrameRecordingEgressConfig":{"properties":{"capture_interval_in_seconds":{"format":"int32","type":"integer","x-stream-index":"007"},"external_storage":{"$ref":"#/components/schemas/ExternalStorage","x-stream-index":"006"},"quality":{"$ref":"#/components/schemas/Quality","x-stream-index":"004"},"storage_name":{"type":"string","x-stream-index":"005"}},"type":"object"},"FrameRecordingResponse":{"properties":{"status":{"type":"string","x-stream-index":"001"}},"required":["status"],"type":"object"},"FrameRecordingSettingsResponse":{"properties":{"capture_interval_in_seconds":{"format":"int32","maximum":60,"minimum":2,"type":"integer","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"},"quality":{"type":"string","x-stream-index":"002"}},"required":["mode","capture_interval_in_seconds"],"type":"object"},"FullUserResponse":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"015"},"banned":{"type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"014"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.011"},"devices":{"items":{"$ref":"#/components/schemas/DeviceResponse"},"type":"array","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001.001"},"image":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"005"},"language":{"type":"string","x-stream-index":"001.005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"001.014"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"012"},"mutes":{"items":{"$ref":"#/components/schemas/UserMuteResponse"},"type":"array","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"001.002"},"online":{"type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"003"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.015"},"role":{"type":"string","x-stream-index":"001.006"},"shadow_banned":{"type":"boolean","x-stream-index":"013"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"009"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"010"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"008"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"011"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","devices","invisible","mutes","channel_mutes","unread_count","total_unread_count","unread_channels","unread_threads","shadow_banned","blocked_user_ids"],"type":"object"},"GeofenceResponse":{"nullable":true,"properties":{"country_codes":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"description":{"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"type":{"type":"string","x-stream-index":"002"}},"required":["name"],"type":"object"},"GeofenceSettings":{"properties":{"names":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"required":["names"],"type":"object"},"GeofenceSettingsResponse":{"properties":{"names":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"required":["names"],"type":"object"},"GetActivityResponse":{"nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","description":"The requested activity","title":"Activity","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["activity","duration"],"title":"Get Activity Response","type":"object"},"GetApplicationResponse":{"description":"Basic response information","nullable":true,"properties":{"app":{"$ref":"#/components/schemas/AppResponseFields","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["app","duration"],"title":"Response","type":"object"},"GetBlockListResponse":{"description":"Response for get block list","nullable":true,"properties":{"blocklist":{"$ref":"#/components/schemas/BlockListResponse","description":"Block list object","title":"BlockListResponse","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["duration"],"title":"GetBlockListResponse","type":"object","x-stream-docs-page-id":"get_block_list"},"GetBlockedUsersResponse":{"nullable":true,"properties":{"blocks":{"description":"Array of blocked user object","items":{"$ref":"#/components/schemas/BlockedUserResponse"},"title":"Blocks","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["blocks","duration"],"type":"object"},"GetCommentRepliesResponse":{"nullable":true,"properties":{"comments":{"description":"Threaded listing of replies to the comment","items":{"$ref":"#/components/schemas/ThreadedCommentResponse"},"title":"Comments","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["comments","duration"],"title":"Get Comment Replies Response","type":"object"},"GetCommentResponse":{"nullable":true,"properties":{"comment":{"$ref":"#/components/schemas/CommentResponse","description":"Comment","title":"Comment","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["comment","duration"],"title":"Get Comment Response","type":"object"},"GetCommentsResponse":{"nullable":true,"properties":{"comments":{"description":"Threaded listing for the activity","items":{"$ref":"#/components/schemas/ThreadedCommentResponse"},"title":"Comments","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["comments","duration"],"title":"Get Comments Response","type":"object"},"GetConfigResponse":{"nullable":true,"properties":{"config":{"$ref":"#/components/schemas/ConfigResponse","description":"The retrieved moderation configuration","title":"Config","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["duration"],"type":"object"},"GetCustomPermissionResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"permission":{"$ref":"#/components/schemas/Permission","x-stream-index":"001"}},"required":["permission","duration"],"title":"Response","type":"object"},"GetFeedGroupResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"feed_group":{"$ref":"#/components/schemas/FeedGroupResponse","description":"The requested feed group","title":"Feed Group","x-stream-index":"001"}},"required":["feed_group","duration"],"title":"Get Feed Group Response","type":"object"},"GetFeedViewResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"feed_view":{"$ref":"#/components/schemas/FeedViewResponse","description":"The requested feed view","title":"Feed View","x-stream-index":"001"}},"required":["feed_view","duration"],"title":"Get Feed View Response","type":"object"},"GetFollowSuggestionsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"suggestions":{"description":"List of suggested feeds to follow","items":{"$ref":"#/components/schemas/FeedResponse"},"title":"Suggestions","type":"array","x-stream-index":"001"}},"required":["suggestions","duration"],"title":"Follow Suggestions Response","type":"object"},"GetImportResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"import_task":{"$ref":"#/components/schemas/ImportTask","x-stream-index":"001"}},"required":["duration"],"title":"Response","type":"object"},"GetModerationRuleResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"rule":{"$ref":"#/components/schemas/ModerationRuleV2Response","x-stream-index":"002"}},"required":["duration"],"title":"Response","type":"object"},"GetOGResponse":{"nullable":true,"properties":{"actions":{"items":{"$ref":"#/components/schemas/Action"},"type":"array","x-stream-index":"001.015"},"asset_url":{"description":"URL of detected video or audio","title":"Image URL","type":"string","x-stream-index":"001.017"},"author_icon":{"type":"string","x-stream-index":"001.007"},"author_link":{"description":"og:site","title":"Author Link","type":"string","x-stream-index":"001.006"},"author_name":{"description":"og:site_name","title":"Author Name","type":"string","x-stream-index":"001.005"},"color":{"type":"string","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.018"},"duration":{"type":"string","x-stream-index":"002.001"},"fallback":{"type":"string","x-stream-index":"001.002"},"fields":{"items":{"$ref":"#/components/schemas/Field"},"type":"array","x-stream-index":"001.016"},"footer":{"type":"string","x-stream-index":"001.013"},"footer_icon":{"type":"string","x-stream-index":"001.014"},"giphy":{"$ref":"#/components/schemas/Images","x-stream-index":"001.019"},"image_url":{"description":"URL of detected image","title":"Image URL","type":"string","x-stream-index":"001.011"},"og_scrape_url":{"description":"extracted url from the text","title":"OG Scrape URL","type":"string","x-stream-index":"001.020"},"original_height":{"format":"int32","type":"integer","x-stream-index":"001.022"},"original_width":{"format":"int32","type":"integer","x-stream-index":"001.021"},"pretext":{"type":"string","x-stream-index":"001.004"},"text":{"description":"og:description","title":"Text","type":"string","x-stream-index":"001.010"},"thumb_url":{"description":"URL of detected thumb image","title":"Image URL","type":"string","x-stream-index":"001.012"},"title":{"description":"og:title","title":"Title","type":"string","x-stream-index":"001.008"},"title_link":{"description":"og:url","title":"Title Link","type":"string","x-stream-index":"001.009"},"type":{"description":"Attachment type, could be empty, image, audio or video","title":"Type","type":"string","x-stream-index":"001.001"}},"required":["custom","duration"],"title":"Get OG Attachment","type":"object","x-stream-docs-page-id":"og"},"GetOrCreateFeedGroupRequest":{"nullable":true,"properties":{"activity_processors":{"description":"Configuration for activity processors (max 10)","items":{"$ref":"#/components/schemas/ActivityProcessorConfig"},"maximum":10,"title":"Activity Processors","type":"array","x-stream-index":"006"},"activity_selectors":{"description":"Configuration for activity selectors (max 10)","items":{"$ref":"#/components/schemas/ActivitySelectorConfig"},"maximum":10,"title":"Activity Selectors","type":"array","x-stream-index":"007"},"aggregation":{"$ref":"#/components/schemas/AggregationConfig","description":"Configuration for activity aggregation","title":"Aggregation","x-stream-index":"009"},"custom":{"additionalProperties":{},"description":"Custom data for the feed group","title":"Custom Data","type":"object","x-stream-index":"004"},"default_visibility":{"description":"Default visibility for the feed group, can be 'public', 'visible', 'followers', 'members', or 'private'. Defaults to 'visible' if not provided. ","enum":["public","visible","followers","members","private"],"title":"Default Visibility","type":"string","x-stream-index":"005"},"notification":{"$ref":"#/components/schemas/NotificationConfig","description":"Configuration for notifications","title":"Notification","x-stream-index":"002"},"push_notification":{"$ref":"#/components/schemas/PushNotificationConfig","x-stream-index":"003"},"ranking":{"$ref":"#/components/schemas/RankingConfig","description":"Configuration for activity ranking","title":"Ranking","x-stream-index":"008"}},"title":"Get Or Create Feed Group Request","type":"object"},"GetOrCreateFeedGroupResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"003.001"},"feed_group":{"$ref":"#/components/schemas/FeedGroupResponse","description":"The feed group that was retrieved or created","title":"Feed Group","x-stream-index":"001"},"was_created":{"description":"Indicates whether the feed group was created (true) or already existed (false)","title":"Was Created","type":"boolean","x-stream-index":"002"}},"required":["feed_group","was_created","duration"],"title":"Get Or Create Feed Group Response","type":"object"},"GetOrCreateFeedRequest":{"description":"Client request","nullable":true,"properties":{"activity_selector_options":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"data":{"$ref":"#/components/schemas/FeedInput","x-stream-index":"003"},"external_ranking":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"filter":{"additionalProperties":{},"type":"object","x-stream-index":"009"},"followers_pagination":{"$ref":"#/components/schemas/PagerRequest","x-stream-index":"011"},"following_pagination":{"$ref":"#/components/schemas/PagerRequest","x-stream-index":"012"},"interest_weights":{"additionalProperties":{"format":"float","type":"number"},"type":"object","x-stream-index":"008"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"013.001"},"member_pagination":{"$ref":"#/components/schemas/PagerRequest","x-stream-index":"010"},"next":{"type":"string","x-stream-index":"013.002"},"prev":{"type":"string","x-stream-index":"013.003"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"014.002"},"user_id":{"type":"string","x-stream-index":"014.001"},"view":{"type":"string","x-stream-index":"005"},"watch":{"type":"boolean","x-stream-index":"004"}},"title":"ClientRequest","type":"object"},"GetOrCreateFeedResponse":{"description":"Basic response information","nullable":true,"properties":{"activities":{"items":{"$ref":"#/components/schemas/ActivityResponse"},"type":"array","x-stream-index":"002"},"aggregated_activities":{"items":{"$ref":"#/components/schemas/AggregatedActivityResponse"},"type":"array","x-stream-index":"003"},"created":{"type":"boolean","x-stream-index":"015"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"017.001"},"feed":{"$ref":"#/components/schemas/FeedResponse","x-stream-index":"001"},"followers":{"items":{"$ref":"#/components/schemas/FollowResponse"},"type":"array","x-stream-index":"005"},"followers_pagination":{"$ref":"#/components/schemas/PagerResponse","x-stream-index":"012"},"following":{"items":{"$ref":"#/components/schemas/FollowResponse"},"type":"array","x-stream-index":"006"},"following_pagination":{"$ref":"#/components/schemas/PagerResponse","x-stream-index":"013"},"member_pagination":{"$ref":"#/components/schemas/PagerResponse","x-stream-index":"011"},"members":{"items":{"$ref":"#/components/schemas/FeedMemberResponse"},"type":"array","x-stream-index":"004"},"next":{"type":"string","x-stream-index":"016.001"},"notification_status":{"$ref":"#/components/schemas/NotificationStatusResponse","x-stream-index":"014"},"own_capabilities":{"items":{"$ref":"#/components/schemas/FeedOwnCapability"},"type":"array","x-stream-index":"008"},"own_follows":{"items":{"$ref":"#/components/schemas/FollowResponse"},"type":"array","x-stream-index":"009"},"own_membership":{"$ref":"#/components/schemas/FeedMemberResponse","x-stream-index":"010"},"pinned_activities":{"items":{"$ref":"#/components/schemas/ActivityPinResponse"},"type":"array","x-stream-index":"007"},"prev":{"type":"string","x-stream-index":"016.002"}},"required":["feed","activities","aggregated_activities","members","followers","following","pinned_activities","own_capabilities","created","duration"],"title":"Response","type":"object"},"GetOrCreateFeedViewRequest":{"nullable":true,"properties":{"activity_processors":{"description":"Configured activity Processors","items":{"$ref":"#/components/schemas/ActivityProcessorConfig"},"title":"Activity Processors","type":"array","x-stream-index":"002.002"},"activity_selectors":{"description":"Configuration for selecting activities","items":{"$ref":"#/components/schemas/ActivitySelectorConfig"},"title":"Activity Selectors","type":"array","x-stream-index":"002.001"},"aggregation":{"$ref":"#/components/schemas/AggregationConfig","description":"Configuration for aggregating activities","title":"Aggregation","x-stream-index":"002.004"},"ranking":{"$ref":"#/components/schemas/RankingConfig","description":"Configuration for ranking activities","title":"Ranking","x-stream-index":"002.003"}},"title":"Get Or Create Feed View Request","type":"object"},"GetOrCreateFeedViewResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"003.001"},"feed_view":{"$ref":"#/components/schemas/FeedViewResponse","description":"The feed view (either existing or newly created)","title":"Feed View","x-stream-index":"001"},"was_created":{"description":"Indicates whether the feed view was newly created (true) or already existed (false)","title":"Was Created","type":"boolean","x-stream-index":"002"}},"required":["feed_view","was_created","duration"],"title":"Get Or Create Feed View Response","type":"object"},"GetRateLimitsResponse":{"nullable":true,"properties":{"android":{"additionalProperties":{"$ref":"#/components/schemas/LimitInfo"},"description":"Map of endpoint rate limits for the Android platform","title":"Android","type":"object","x-stream-index":"002","x-stream-map":{"key":"endpoint","title":"Endpoint name","description":"The name of the endpoint for which the limits apply"}},"duration":{"type":"string","x-stream-index":"005.001"},"ios":{"additionalProperties":{"$ref":"#/components/schemas/LimitInfo"},"description":"Map of endpoint rate limits for the iOS platform","title":"iOS","type":"object","x-stream-index":"003","x-stream-map":{"key":"endpoint","title":"Endpoint name","description":"The name of the endpoint for which the limits apply"}},"server_side":{"additionalProperties":{"$ref":"#/components/schemas/LimitInfo"},"description":"Map of endpoint rate limits for the server-side platform","title":"Server-side","type":"object","x-stream-index":"001","x-stream-map":{"key":"endpoint","title":"Endpoint name","description":"The name of the endpoint for which the limits apply"}},"web":{"additionalProperties":{"$ref":"#/components/schemas/LimitInfo"},"description":"Map of endpoint rate limits for the web platform","title":"Web","type":"object","x-stream-index":"004","x-stream-map":{"key":"endpoint","title":"Endpoint name","description":"The name of the endpoint for which the limits apply"}}},"required":["duration"],"title":"Get Rate Limits Response","type":"object","x-stream-docs-page-id":"rate_limits"},"GetReviewQueueItemResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"Current state of the review queue item","title":"Item","x-stream-index":"001"}},"required":["duration"],"type":"object"},"GetTaskResponse":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.003"},"duration":{"type":"string","x-stream-index":"004.001"},"error":{"$ref":"#/components/schemas/ErrorResult","description":"Error produced by task","title":"Error","x-stream-index":"003"},"result":{"additionalProperties":{},"description":"Result produced by task after completion","title":"Result","type":"object","x-stream-index":"002"},"status":{"description":"Current status of task","title":"Status","type":"string","x-stream-index":"001.002"},"task_id":{"description":"ID of task","title":"Task ID","type":"string","x-stream-index":"001.001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.004"}},"required":["task_id","status","created_at","updated_at","duration"],"title":"Get Task Response","type":"object","x-stream-docs-page-id":"tasks"},"GoogleVisionConfig":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"HLSEgressConfig":{"properties":{"composite_app_settings":{"$ref":"#/components/schemas/CompositeAppSettings","x-stream-index":"005"},"playlist_url":{"type":"string","x-stream-index":"007"},"qualities":{"items":{"$ref":"#/components/schemas/Quality"},"type":"array","x-stream-index":"004"},"start_unix_nano":{"format":"int64","type":"integer","x-stream-index":"006"}},"type":"object"},"HLSSettings":{"properties":{"auto_on":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"004"},"quality_tracks":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"required":["auto_on","enabled","quality_tracks"],"type":"object"},"HLSSettingsResponse":{"description":"HLSSettings is the payload for HLS settings","properties":{"auto_on":{"title":"Auto On","type":"boolean","x-stream-index":"001"},"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"002"},"layout":{"$ref":"#/components/schemas/LayoutSettingsResponse","title":"Layout","x-stream-index":"004"},"quality_tracks":{"items":{"type":"string"},"title":"Quality Tracks","type":"array","x-stream-index":"003"}},"required":["auto_on","enabled","quality_tracks","layout"],"title":"HLSSettingsResponse","type":"object"},"HarmConfig":{"properties":{"action_sequences":{"items":{"$ref":"#/components/schemas/ActionSequence"},"type":"array","x-stream-index":"001"},"severity":{"type":"integer","x-stream-index":"002"}},"required":["action_sequences","severity"],"type":"object"},"HuaweiConfig":{"properties":{"Disabled":{"type":"boolean","writeOnly":true,"x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"secret":{"type":"string","x-stream-index":"002"}},"type":"object"},"HuaweiConfigFields":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"id":{"type":"string","x-stream-index":"002"},"secret":{"type":"string","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"ImageContentParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"type":"object"},"ImageData":{"properties":{"frames":{"type":"string","x-stream-index":"005"},"height":{"type":"string","x-stream-index":"003"},"size":{"type":"string","x-stream-index":"004"},"url":{"type":"string","x-stream-index":"001"},"width":{"type":"string","x-stream-index":"002"}},"required":["url","width","height","size","frames"],"type":"object"},"ImageRuleParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"type":"object"},"ImageSize":{"properties":{"crop":{"description":"Crop mode","enum":["top","bottom","left","right","center"],"title":"Crop","type":"string","x-stream-index":"001"},"height":{"description":"Target image height","format":"int32","title":"Height","type":"integer","x-stream-index":"003"},"resize":{"description":"Resize method","enum":["clip","crop","scale","fill"],"title":"Resize","type":"string","x-stream-index":"002"},"width":{"description":"Target image width","format":"int32","title":"Width","type":"integer","x-stream-index":"004"}},"title":"Image size configuration","type":"object"},"ImageUploadRequest":{"nullable":true,"properties":{"file":{"type":"string","x-stream-index":"001.001"},"upload_sizes":{"description":"field with JSON-encoded array of image size configurations","items":{"$ref":"#/components/schemas/ImageSize"},"title":"Upload sizes","type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/OnlyUserID","x-stream-index":"001.002"}},"type":"object"},"ImageUploadResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.003.001"},"file":{"type":"string","x-stream-index":"001.001"},"thumb_url":{"type":"string","x-stream-index":"001.002"},"upload_sizes":{"description":"Array of image size configurations","items":{"$ref":"#/components/schemas/ImageSize"},"title":"Upload sizes","type":"array","x-stream-index":"002"}},"required":["duration"],"type":"object"},"Images":{"properties":{"fixed_height":{"$ref":"#/components/schemas/ImageData","x-stream-index":"002"},"fixed_height_downsampled":{"$ref":"#/components/schemas/ImageData","x-stream-index":"004"},"fixed_height_still":{"$ref":"#/components/schemas/ImageData","x-stream-index":"003"},"fixed_width":{"$ref":"#/components/schemas/ImageData","x-stream-index":"005"},"fixed_width_downsampled":{"$ref":"#/components/schemas/ImageData","x-stream-index":"007"},"fixed_width_still":{"$ref":"#/components/schemas/ImageData","x-stream-index":"006"},"original":{"$ref":"#/components/schemas/ImageData","x-stream-index":"001"}},"required":["original","fixed_height","fixed_height_still","fixed_height_downsampled","fixed_width","fixed_width_still","fixed_width_downsampled"],"type":"object"},"ImportTask":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"011"},"history":{"items":{"$ref":"#/components/schemas/ImportTaskHistory"},"type":"array","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"003"},"mode":{"type":"string","x-stream-index":"006"},"path":{"type":"string","x-stream-index":"005"},"size":{"format":"int64","type":"integer","x-stream-index":"007"},"state":{"type":"string","x-stream-index":"008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"012"}},"required":["id","path","mode","state","history","created_at","updated_at"],"type":"object"},"ImportTaskHistory":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"next_state":{"type":"string","x-stream-index":"006"},"prev_state":{"type":"string","x-stream-index":"005"}},"required":["prev_state","next_state","created_at"],"type":"object"},"IngressAudioEncodingOptions":{"properties":{"bitrate":{"maximum":128000,"minimum":16000,"type":"integer","x-stream-index":"003"},"channels":{"enum":["1","2"],"format":"int32","type":"integer","x-stream-index":"001"},"enable_dtx":{"type":"boolean","x-stream-index":"002"}},"required":["channels","enable_dtx","bitrate"],"type":"object"},"IngressAudioEncodingResponse":{"properties":{"bitrate":{"format":"int32","type":"integer","x-stream-index":"003"},"channels":{"format":"int32","type":"integer","x-stream-index":"001"},"enable_dtx":{"type":"boolean","x-stream-index":"002"}},"required":["channels","enable_dtx","bitrate"],"type":"object"},"IngressSettings":{"properties":{"audio_encoding_options":{"$ref":"#/components/schemas/IngressAudioEncodingOptions","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"video_encoding_options":{"additionalProperties":{"$ref":"#/components/schemas/IngressVideoEncodingOptions"},"type":"object","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"IngressSettingsResponse":{"properties":{"audio_encoding_options":{"$ref":"#/components/schemas/IngressAudioEncodingResponse","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"video_encoding_options":{"additionalProperties":{"$ref":"#/components/schemas/IngressVideoEncodingResponse"},"type":"object","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"IngressVideoEncodingOptions":{"properties":{"layers":{"items":{"$ref":"#/components/schemas/IngressVideoLayer"},"minimum":1,"type":"array","x-stream-index":"001"}},"required":["layers"],"type":"object"},"IngressVideoEncodingResponse":{"properties":{"layers":{"items":{"$ref":"#/components/schemas/IngressVideoLayerResponse"},"type":"array","x-stream-index":"001"}},"required":["layers"],"type":"object"},"IngressVideoLayer":{"nullable":true,"properties":{"bitrate":{"minimum":1000,"type":"integer","x-stream-index":"002"},"codec":{"enum":["h264","vp8"],"type":"string","x-stream-index":"001"},"frame_rate":{"maximum":60,"minimum":1,"type":"integer","x-stream-index":"003"},"max_dimension":{"minimum":240,"type":"integer","x-stream-index":"005"},"min_dimension":{"minimum":240,"type":"integer","x-stream-index":"004"}},"required":["codec","bitrate","frame_rate","min_dimension","max_dimension"],"type":"object"},"IngressVideoLayerResponse":{"nullable":true,"properties":{"bitrate":{"type":"integer","x-stream-index":"002"},"codec":{"type":"string","x-stream-index":"001"},"frame_rate_limit":{"type":"integer","x-stream-index":"005"},"max_dimension":{"type":"integer","x-stream-index":"004"},"min_dimension":{"type":"integer","x-stream-index":"003"}},"required":["codec","bitrate","min_dimension","max_dimension","frame_rate_limit"],"type":"object"},"LLMConfig":{"properties":{"app_context":{"type":"string","x-stream-index":"005"},"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/LLMRule"},"type":"array","x-stream-index":"003"},"severity_descriptions":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"004"}},"required":["enabled","rules"],"type":"object"},"LLMRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove","keep"],"type":"string","x-stream-index":"003"},"description":{"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"},"severity_rules":{"items":{"$ref":"#/components/schemas/BodyguardSeverityRule"},"type":"array","x-stream-index":"004"}},"required":["label","description","action","severity_rules"],"type":"object"},"LabelThresholds":{"properties":{"block":{"description":"Threshold for automatic message block","format":"float","maximum":1,"minimum":0,"title":"Block","type":"number","x-stream-index":"002"},"flag":{"description":"Threshold for automatic message flag","format":"float","maximum":1,"minimum":0,"title":"Flag","type":"number","x-stream-index":"001"}},"type":"object"},"LayoutSettings":{"properties":{"detect_orientation":{"type":"boolean","x-stream-index":"005"},"external_app_url":{"type":"string","x-stream-index":"003"},"external_css_url":{"type":"string","x-stream-index":"004"},"name":{"enum":["spotlight","grid","single-participant","mobile","custom"],"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"required":["name","external_app_url","external_css_url"],"type":"object"},"LayoutSettingsResponse":{"properties":{"detect_orientation":{"type":"boolean","x-stream-index":"005"},"external_app_url":{"type":"string","x-stream-index":"003"},"external_css_url":{"type":"string","x-stream-index":"004"},"name":{"enum":["spotlight","grid","single-participant","mobile","custom"],"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"required":["name","external_app_url","external_css_url"],"type":"object"},"LimitInfo":{"properties":{"limit":{"description":"The maximum number of calls allowed for the time window","format":"int32","title":"Limit","type":"integer","x-stream-index":"001"},"remaining":{"description":"The number of remaining calls in the current window","format":"int64","title":"Remaining","type":"integer","x-stream-index":"002"},"reset":{"description":"The Unix timestamp of the next window","format":"int64","title":"Reset","type":"integer","x-stream-index":"003"}},"required":["limit","remaining","reset"],"title":"Rate Limit info","type":"object","x-stream-docs-page-id":"rate_limits"},"LimitsSettings":{"properties":{"max_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"004"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"},"max_participants_exclude_owner":{"type":"boolean","x-stream-index":"003"},"max_participants_exclude_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"002"}},"required":["max_participants_exclude_roles"],"type":"object"},"LimitsSettingsResponse":{"properties":{"max_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"004"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"},"max_participants_exclude_owner":{"type":"boolean","x-stream-index":"003"},"max_participants_exclude_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"002"}},"required":["max_participants_exclude_roles"],"type":"object"},"ListBlockListResponse":{"description":"Basic response information","nullable":true,"properties":{"blocklists":{"items":{"$ref":"#/components/schemas/BlockListResponse"},"type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["blocklists","duration"],"title":"Response","type":"object"},"ListDevicesResponse":{"description":"List devices response","nullable":true,"properties":{"devices":{"description":"List of devices","items":{"$ref":"#/components/schemas/DeviceResponse"},"title":"Devices","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["devices","duration"],"title":"ListDevicesResponse","type":"object"},"ListExternalStorageResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"external_storages":{"additionalProperties":{"$ref":"#/components/schemas/ExternalStorageResponse"},"type":"object","x-stream-index":"002"}},"required":["duration","external_storages"],"title":"Response","type":"object"},"ListFeedGroupsResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"groups":{"additionalProperties":{"$ref":"#/components/schemas/FeedGroupResponse"},"type":"object","x-stream-index":"001"}},"required":["groups","duration"],"title":"Response","type":"object"},"ListFeedViewsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"views":{"additionalProperties":{"$ref":"#/components/schemas/FeedViewResponse"},"description":"Map of feed view ID to feed view","title":"Views","type":"object","x-stream-index":"001"}},"required":["views","duration"],"title":"List Feed Views Response","type":"object"},"ListImportsResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"import_tasks":{"items":{"$ref":"#/components/schemas/ImportTask"},"type":"array","x-stream-index":"001"}},"required":["import_tasks","duration"],"title":"Response","type":"object"},"ListPermissionsResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"permissions":{"items":{"$ref":"#/components/schemas/Permission"},"type":"array","x-stream-index":"001"}},"required":["permissions","duration"],"title":"Response","type":"object"},"ListPushProvidersResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"push_providers":{"items":{"$ref":"#/components/schemas/PushProviderResponse"},"type":"array","x-stream-index":"001"}},"required":["push_providers","duration"],"title":"Response","type":"object"},"ListRolesResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"roles":{"items":{"$ref":"#/components/schemas/Role"},"type":"array","x-stream-index":"001"}},"required":["roles","duration"],"title":"Response","type":"object"},"MarkActivityRequest":{"nullable":true,"properties":{"mark_all_read":{"description":"Whether to mark all activities as read","title":"Mark All Read","type":"boolean","x-stream-index":"005"},"mark_all_seen":{"description":"Whether to mark all activities as seen","title":"Mark All Seen","type":"boolean","x-stream-index":"003"},"mark_read":{"description":"List of activity IDs to mark as read","items":{"type":"string"},"title":"Mark Read","type":"array","x-stream-index":"004"},"mark_seen":{"description":"List of activity IDs to mark as seen","items":{"type":"string"},"title":"Mark Seen","type":"array","x-stream-index":"006"},"mark_watched":{"description":"List of activity IDs to mark as watched (for stories)","items":{"type":"string"},"title":"Mark Watched","type":"array","x-stream-index":"007"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"009.002"},"user_id":{"type":"string","x-stream-index":"009.001"}},"title":"Mark Activity Request","type":"object"},"MarkReviewedRequest":{"properties":{"content_to_mark_as_reviewed_limit":{"format":"int32","maximum":2500,"type":"integer","x-stream-index":"002"},"disable_marking_content_as_reviewed":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"MemberLookup":{"properties":{"Limit":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"001"}},"required":["Limit"],"type":"object"},"MembershipLevelResponse":{"properties":{"created_at":{"description":"When the membership level was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"007"},"custom":{"additionalProperties":{},"description":"Custom data for the membership level","title":"Custom Data","type":"object","x-stream-index":"006"},"description":{"description":"Description of the membership level","title":"Description","type":"string","x-stream-index":"003"},"id":{"description":"Unique identifier for the membership level","title":"ID","type":"string","x-stream-index":"001"},"name":{"description":"Display name for the membership level","title":"Name","type":"string","x-stream-index":"002"},"priority":{"description":"Priority level","format":"int32","title":"Priority","type":"integer","x-stream-index":"004"},"tags":{"description":"Activity tags this membership level gives access to","items":{"type":"string"},"title":"Tags","type":"array","x-stream-index":"005"},"updated_at":{"description":"When the membership level was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"008"}},"required":["id","name","priority","tags","created_at","updated_at"],"title":"Membership Level Response","type":"object"},"Message":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"012"},"before_message_send_failed":{"type":"boolean","x-stream-index":"046"},"cid":{"type":"string","x-stream-index":"028"},"command":{"type":"string","x-stream-index":"006"},"created_at":{"format":"date-time","type":"number","x-stream-index":"030"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"034"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"033"},"deleted_for_me":{"type":"boolean","x-stream-index":"059"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"023"},"html":{"type":"string","x-stream-index":"007"},"i18n":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"044"},"id":{"type":"string","x-stream-index":"002"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"040"},"latest_reactions":{"items":{"$ref":"#/components/schemas/Reaction"},"type":"array","x-stream-index":"013"},"mentioned_users":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"043"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"052"},"mml":{"type":"string","x-stream-index":"005"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"056"},"own_reactions":{"items":{"$ref":"#/components/schemas/Reaction"},"type":"array","x-stream-index":"014"},"parent_id":{"type":"string","x-stream-index":"019"},"pin_expires":{"format":"date-time","type":"number","x-stream-index":"051"},"pinned":{"type":"boolean","x-stream-index":"047"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"048"},"pinned_by":{"$ref":"#/components/schemas/User","x-stream-index":"050"},"poll":{"$ref":"#/components/schemas/Poll","x-stream-index":"054"},"poll_id":{"type":"string","x-stream-index":"053"},"quoted_message":{"$ref":"#/components/schemas/Message","x-stream-index":"025"},"quoted_message_id":{"type":"string","x-stream-index":"024"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"015"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"017"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"016"},"reminder":{"$ref":"#/components/schemas/MessageReminder","x-stream-index":"058"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"022"},"restricted_visibility":{"items":{"type":"string"},"type":"array","x-stream-index":"011"},"shadowed":{"type":"boolean","x-stream-index":"036"},"shared_location":{"$ref":"#/components/schemas/SharedLocation","x-stream-index":"055"},"show_in_channel":{"type":"boolean","x-stream-index":"021"},"silent":{"type":"boolean","x-stream-index":"045"},"text":{"type":"string","x-stream-index":"004"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"027"},"type":{"type":"string","x-stream-index":"008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"031"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"010"}},"required":["id","text","html","type","restricted_visibility","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reaction_groups","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned"],"type":"object"},"MessageReminder":{"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"004"},"channel_cid":{"type":"string","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"011"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"006"},"message_id":{"type":"string","x-stream-index":"005"},"remind_at":{"format":"date-time","type":"number","x-stream-index":"009"},"task_id":{"type":"string","x-stream-index":"010"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"012"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"user_id":{"type":"string","x-stream-index":"007"}},"required":["channel_cid","message_id","user_id","task_id","created_at","updated_at"],"type":"object"},"MessageResponse":{"description":"Represents any chat message","properties":{"attachments":{"description":"Array of message attachments","items":{"$ref":"#/components/schemas/Attachment"},"title":"Message attachments","type":"array","x-stream-docs-page-id":"message_format#attachment-format","x-stream-index":"008"},"cid":{"description":"Channel unique identifier in \u003ctype\u003e:\u003cid\u003e format","title":"Channel CID","type":"string","x-stream-index":"022"},"command":{"description":"Contains provided slash command","title":"Command","type":"string","x-stream-docs-page-id":"custom_commands_webhook","x-stream-index":"004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"023"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"026"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"025"},"deleted_for_me":{"type":"boolean","x-stream-index":"044"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"018"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"041"},"html":{"description":"Contains HTML markup of the message. Can only be set when using server-side API","title":"HTML content","type":"string","x-stream-index":"005"},"i18n":{"additionalProperties":{"type":"string"},"description":"Object with translations. Key `language` contains the original language key. Other keys contain translations","title":"Internationalization info","type":"object","x-stream-docs-page-id":"translation","x-stream-index":"030"},"id":{"description":"Message ID is unique string identifier of the message","title":"ID","type":"string","x-stream-index":"001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"Contains image moderation information","title":"Image moderation labels","type":"object","x-stream-index":"028"},"latest_reactions":{"description":"List of 10 latest reactions to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Latest reactions","type":"array","x-stream-index":"009"},"mentioned_users":{"description":"List of mentioned users","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Mentioned Users","type":"array","x-stream-index":"029"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"036"},"mml":{"description":"Should be empty if `text` is provided. Can only be set when using server-side API","title":"Messaging Markup Language","type":"string","x-stream-docs-page-id":"mml_overview","x-stream-index":"003"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"039"},"own_reactions":{"description":"List of 10 latest reactions of authenticated user to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Own reactions","type":"array","x-stream-index":"010"},"parent_id":{"description":"ID of parent message (thread)","title":"Parent message ID","type":"string","x-stream-docs-page-id":"threads","x-stream-index":"015"},"pin_expires":{"description":"Date when pinned message expires","format":"date-time","title":"Pin expiration date","type":"number","x-stream-docs-page-id":"pinned_messages","x-stream-index":"035"},"pinned":{"description":"Whether message is pinned or not","title":"Pinned","type":"boolean","x-stream-docs-page-id":"pinned_messages","x-stream-index":"032"},"pinned_at":{"description":"Date when message got pinned","format":"date-time","title":"Pinned at","type":"number","x-stream-docs-page-id":"pinned_messages","x-stream-index":"033"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","description":"Contains user who pinned the message","title":"Pinned by","x-stream-docs-page-id":"pinned_messages","x-stream-index":"034"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"038"},"poll_id":{"description":"Identifier of the poll to include in the message","title":"Poll ID","type":"string","x-stream-index":"037"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","description":"Contains quoted message","title":"Quoted message","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"020"},"quoted_message_id":{"title":"ID of quoted message","type":"string","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"019"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing number of reactions of each type. Key: reaction type (string), value: number of reactions (int)","title":"Reaction counts","type":"object","x-stream-index":"011"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"014"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing scores of reactions of each type. Key: reaction type (string), value: total score of reactions (int)","title":"Reaction scores","type":"object","x-stream-index":"012"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"042"},"reply_count":{"description":"Number of replies to this message","format":"int32","title":"Reply count","type":"integer","x-stream-index":"017"},"restricted_visibility":{"description":"A list of user ids that have restricted visibility to the message, if the list is not empty, the message is only visible to the users in the list","items":{"type":"string"},"title":"Restricted visibility","type":"array","x-stream-index":"040"},"shadowed":{"description":"Whether the message was shadowed or not","title":"Shadowed","type":"boolean","x-stream-docs-page-id":"moderation#shadow-ban","x-stream-index":"027"},"shared_location":{"$ref":"#/components/schemas/SharedLocationResponseData","description":"Contains shared location data","title":"Shared Location","x-stream-index":"043"},"show_in_channel":{"description":"Whether thread reply should be shown in the channel as well","title":"Show in channel","type":"boolean","x-stream-docs-page-id":"threads","x-stream-index":"016"},"silent":{"description":"Whether message is silent or not","title":"Silent","type":"boolean","x-stream-index":"031"},"text":{"description":"Text of the message. Should be empty if `mml` is provided","title":"Text","type":"string","x-stream-index":"002"},"thread_participants":{"description":"List of users who participate in thread","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Thread participants","type":"array","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"021"},"type":{"description":"Contains type of the message","enum":["regular","ephemeral","error","reply","system","deleted"],"title":"Message Type","type":"string","x-stream-docs-page-id":"message_format#message-types","x-stream-index":"006"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"024"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Sender of the message. Required when using server-side API","title":"User object","x-stream-index":"007"}},"required":["id","text","html","type","user","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned","restricted_visibility"],"title":"Message","type":"object","x-stream-docs-page-id":"send_message"},"ModerationActionConfig":{"nullable":true,"properties":{"action":{"type":"string","x-stream-index":"006"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"009"},"description":{"type":"string","x-stream-index":"008"},"entity_type":{"type":"string","x-stream-index":"004"},"icon":{"type":"string","x-stream-index":"007"},"order":{"format":"int32","type":"integer","x-stream-index":"005"}},"required":["entity_type","order","action","icon","description","custom"],"type":"object"},"ModerationCheckCompletedEvent":{"description":"This event is sent when a moderation check is completed","nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"entity_id":{"description":"The ID of entity which was moderated","title":"EntityID","type":"string","x-stream-index":"002"},"entity_type":{"description":"The type of the entity which was moderated","title":"EntityType","type":"string","x-stream-index":"003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"recommended_action":{"description":"The recommended action","title":"RecommendedAction","type":"string","x-stream-index":"004"},"review_queue_item_id":{"description":"The review queue item ID","title":"ReviewQueueItemID","type":"string","x-stream-index":"005"},"type":{"default":"moderation_check.completed","type":"string","x-stream-index":"001.002"}},"required":["type","created_at","custom","entity_id","entity_type","recommended_action","review_queue_item_id"],"title":"ModerationCheckCompletedEvent","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"},"ModerationCustomActionEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"001"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"002"},"type":{"default":"moderation.custom_action","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationCustomActionEvent","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"},"ModerationDashboardPreferences":{"properties":{"flag_user_on_flagged_content":{"type":"boolean","x-stream-index":"002"},"media_queue_blur_enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"ModerationFlagResponse":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"015"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"entity_creator_id":{"type":"string","x-stream-index":"007"},"entity_id":{"type":"string","x-stream-index":"006"},"entity_type":{"type":"string","x-stream-index":"005"},"labels":{"items":{"type":"string"},"type":"array","x-stream-index":"011"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"008"},"reason":{"type":"string","x-stream-index":"009"},"result":{"items":{"additionalProperties":{},"type":"object"},"type":"array","x-stream-index":"012"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","x-stream-index":"014"},"review_queue_item_id":{"type":"string","x-stream-index":"013"},"type":{"type":"string","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"016"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"004"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["type","user_id","entity_type","entity_id","result","created_at","updated_at"],"type":"object"},"ModerationFlaggedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"item":{"type":"string","x-stream-index":"001"},"object_id":{"type":"string","x-stream-index":"002"},"type":{"default":"moderation.flagged","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationFlaggedEvent","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"},"ModerationMarkReviewedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"001"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"002"},"type":{"default":"moderation.mark_reviewed","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationMarkReviewedEvent","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"},"ModerationPayload":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"images":{"items":{"type":"string"},"maximum":30,"type":"array","x-stream-index":"002"},"texts":{"items":{"type":"string"},"type":"array","x-stream-index":"001"},"videos":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"type":"object"},"ModerationRuleV2Response":{"properties":{"action":{"$ref":"#/components/schemas/RuleBuilderAction","x-stream-index":"010"},"conditions":{"items":{"$ref":"#/components/schemas/RuleBuilderCondition"},"type":"array","x-stream-index":"007"},"config_keys":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"cooldown_period":{"type":"string","x-stream-index":"011"},"created_at":{"format":"date-time","type":"number","x-stream-index":"013"},"description":{"type":"string","x-stream-index":"003"},"enabled":{"type":"boolean","x-stream-index":"012"},"groups":{"items":{"$ref":"#/components/schemas/RuleBuilderConditionGroup"},"type":"array","x-stream-index":"009"},"id":{"type":"string","x-stream-index":"001"},"logic":{"type":"string","x-stream-index":"008"},"name":{"type":"string","x-stream-index":"002"},"rule_type":{"type":"string","x-stream-index":"006"},"team":{"type":"string","x-stream-index":"005"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"014"}},"required":["id","name","description","config_keys","team","rule_type","action","enabled","created_at","updated_at"],"type":"object"},"ModerationV2Response":{"properties":{"action":{"type":"string","x-stream-index":"001"},"blocklist_matched":{"type":"string","x-stream-index":"005"},"image_harms":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"original_text":{"type":"string","x-stream-index":"002"},"platform_circumvented":{"type":"boolean","x-stream-index":"007"},"semantic_filter_matched":{"type":"string","x-stream-index":"006"},"text_harms":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"required":["action","original_text"],"type":"object"},"MuteRequest":{"nullable":true,"properties":{"target_ids":{"description":"User IDs to mute (if multiple users)","items":{"type":"string"},"title":"Target IDs","type":"array","x-stream-index":"001"},"timeout":{"description":"Duration of mute in minutes","minimum":0,"title":"Timeout","type":"integer","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"required":["target_ids"],"title":"MuteRequest","type":"object"},"MuteResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"004.001"},"mutes":{"description":"Object with mutes (if multiple users were muted)","items":{"$ref":"#/components/schemas/UserMute"},"title":"Mutes","type":"array","x-stream-index":"001"},"non_existing_users":{"description":"A list of users that can't be found. Common cause for this is deleted users","items":{"type":"string"},"title":"Non Existing Users","type":"array","x-stream-index":"003"},"own_user":{"$ref":"#/components/schemas/OwnUser","description":"Authorized user object with fresh mutes information","title":"Own User","x-stream-index":"002"}},"required":["duration"],"title":"MuteResponse","type":"object"},"NoiseCancellationSettings":{"properties":{"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode"],"type":"object"},"NotificationConfig":{"properties":{"track_read":{"description":"Whether to track read status","title":"Track Read","type":"boolean","x-stream-index":"002"},"track_seen":{"description":"Whether to track seen status","title":"Track Seen","type":"boolean","x-stream-index":"001"}},"title":"Notification Configuration","type":"object"},"NotificationFeedUpdatedEvent":{"description":"Emitted when notification feed is updated.","nullable":true,"properties":{"aggregated_activities":{"description":"Aggregated activities for notification feeds","items":{"$ref":"#/components/schemas/AggregatedActivityResponse"},"title":"Aggregated Activities","type":"array","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"003.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.001.007"},"feed_visibility":{"type":"string","x-stream-index":"003.003"},"fid":{"description":"The ID of the feed","title":"Feed ID","type":"string","x-stream-index":"003.002"},"notification_status":{"$ref":"#/components/schemas/NotificationStatusResponse","description":"Notification status including unread/unseen counts","title":"Notification Status","x-stream-index":"002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.001.004"},"type":{"default":"feeds.notification_feed.updated","description":"The type of event: \"feeds.notification_feed.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"003.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who triggered the notification","title":"User","x-stream-index":"004.001"}},"required":["type","created_at","custom","fid"],"title":"NotificationFeedUpdatedEvent","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"},"NotificationSettings":{"properties":{"call_live_started":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"002"},"call_missed":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"006"},"call_notification":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"004"},"call_ring":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"session_started":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"003"}},"required":["enabled","call_live_started","session_started","call_notification","call_ring","call_missed"],"type":"object"},"NotificationStatusResponse":{"properties":{"last_read_at":{"format":"date-time","type":"number","x-stream-index":"006"},"last_seen_at":{"description":"When notifications were last seen","format":"date-time","title":"Last Seen At","type":"number","x-stream-index":"005"},"read_activities":{"description":"IDs of activities that have been read","items":{"type":"string"},"title":"Read Activities","type":"array","x-stream-index":"003"},"seen_activities":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"unread":{"description":"Number of unread notifications","format":"int32","title":"Unread","type":"integer","x-stream-index":"001"},"unseen":{"description":"Number of unseen notifications","format":"int32","title":"Unseen","type":"integer","x-stream-index":"002"}},"required":["unread","unseen"],"title":"Notification Status","type":"object"},"NullTime":{"type":"object"},"OCRRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"}},"required":["label","action"],"type":"object"},"OnlyUserID":{"properties":{"id":{"type":"string","x-stream-index":"001"}},"required":["id"],"type":"object"},"OwnUser":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"046"},"banned":{"type":"boolean","x-stream-index":"016"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"045"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"029"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"014"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"013"},"devices":{"items":{"$ref":"#/components/schemas/Device"},"type":"array","x-stream-index":"027"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"023"},"language":{"type":"string","x-stream-index":"035"},"last_active":{"format":"date-time","type":"number","x-stream-index":"011"},"last_engaged_at":{"format":"date-time","type":"number","x-stream-index":"012"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"037"},"mutes":{"items":{"$ref":"#/components/schemas/UserMute"},"type":"array","x-stream-index":"028"},"online":{"type":"boolean","x-stream-index":"022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"026"},"push_preferences":{"$ref":"#/components/schemas/PushPreferences","x-stream-index":"025"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"005"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"031"},"total_unread_count_by_team":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"032"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"033"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"030"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"034"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"}},"required":["id","role","custom","created_at","updated_at","banned","online","devices","mutes","channel_mutes","unread_count","total_unread_count","total_unread_count_by_team","unread_channels","unread_threads","language"],"type":"object"},"PagerRequest":{"properties":{"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"002"},"prev":{"type":"string","x-stream-index":"003"}},"type":"object"},"PagerResponse":{"properties":{"next":{"type":"string","x-stream-index":"001"},"prev":{"type":"string","x-stream-index":"002"}},"type":"object"},"Permission":{"properties":{"action":{"description":"Action name this permission is for (e.g. SendMessage)","title":"Action","type":"string","x-stream-index":"004"},"condition":{"additionalProperties":{},"description":"MongoDB style condition which decides whether or not the permission is granted","title":"Condition","type":"object","x-stream-index":"007"},"custom":{"description":"Whether this is a custom permission or built-in","title":"Custom","type":"boolean","x-stream-index":"009"},"description":{"description":"Description of the permission","title":"Description","type":"string","x-stream-index":"003"},"id":{"description":"Unique permission ID","title":"ID","type":"string","x-stream-index":"001"},"level":{"description":"Level at which permission could be applied (app or channel)","enum":["app","channel"],"title":"Level","type":"string","x-stream-index":"010"},"name":{"description":"Name of the permission","title":"Name","type":"string","x-stream-index":"002"},"owner":{"description":"Whether this permission applies to resource owner or not","title":"Owner","type":"boolean","x-stream-index":"005"},"same_team":{"description":"Whether this permission applies to teammates (multi-tenancy mode only)","title":"Same team","type":"boolean","x-stream-index":"006"},"tags":{"description":"List of tags of the permission","items":{"type":"string"},"title":"Tags","type":"array","x-stream-index":"011"}},"required":["id","name","description","action","owner","same_team","custom","level","tags"],"type":"object"},"PinActivityRequest":{"nullable":true,"properties":{"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"005.002"},"user_id":{"type":"string","x-stream-index":"005.001"}},"title":"Pin Activity Request","type":"object"},"PinActivityResponse":{"nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","description":"The pinned activity","title":"Activity","x-stream-index":"001"},"created_at":{"description":"When the activity was pinned","format":"date-time","title":"Created At","type":"number","x-stream-index":"004"},"duration":{"type":"string","x-stream-index":"005.001"},"feed":{"description":"Fully qualified ID of the feed the activity was pinned to","title":"Feed ID","type":"string","x-stream-index":"002"},"user_id":{"description":"ID of the user who pinned the activity","title":"User ID","type":"string","x-stream-index":"003"}},"required":["activity","feed","user_id","created_at","duration"],"title":"Pin Activity Response","type":"object"},"Policy":{"properties":{"action":{"type":"integer","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"010"},"name":{"type":"string","x-stream-index":"004"},"owner":{"type":"boolean","x-stream-index":"008"},"priority":{"format":"int32","type":"integer","x-stream-index":"009"},"resources":{"items":{"type":"string"},"type":"array","x-stream-index":"005"},"roles":{"items":{"type":"string"},"type":"array","x-stream-index":"006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"011"}},"required":["name","resources","roles","action","owner","priority","created_at","updated_at"],"type":"object"},"Poll":{"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"023"},"allow_answers":{"type":"boolean","x-stream-index":"010"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"009"},"answers_count":{"format":"int32","type":"integer","x-stream-index":"015"},"created_at":{"format":"date-time","type":"number","x-stream-index":"021"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"020"},"created_by_id":{"type":"string","x-stream-index":"019"},"description":{"type":"string","x-stream-index":"005"},"enforce_unique_vote":{"type":"boolean","x-stream-index":"007"},"id":{"type":"string","x-stream-index":"003"},"is_closed":{"type":"boolean","x-stream-index":"011"},"latest_answers":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array","x-stream-index":"017"},"latest_votes_by_option":{"additionalProperties":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array"},"type":"object","x-stream-index":"016"},"max_votes_allowed":{"format":"int32","type":"integer","x-stream-index":"008"},"name":{"type":"string","x-stream-index":"004"},"options":{"items":{"$ref":"#/components/schemas/PollOption"},"type":"array","x-stream-index":"013"},"own_votes":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array","x-stream-index":"018"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"022"},"vote_count":{"format":"int32","type":"integer","x-stream-index":"012"},"vote_counts_by_option":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"014"},"voting_visibility":{"type":"string","x-stream-index":"006"}},"required":["id","name","description","enforce_unique_vote","allow_user_suggested_options","allow_answers","vote_count","options","vote_counts_by_option","answers_count","latest_votes_by_option","latest_answers","own_votes","created_by_id","created_at","updated_at","Custom"],"type":"object"},"PollOption":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id","text","custom"],"type":"object"},"PollOptionInput":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"text":{"type":"string","x-stream-index":"002"}},"type":"object"},"PollOptionRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id"],"type":"object"},"PollOptionResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"poll_option":{"$ref":"#/components/schemas/PollOptionResponseData","description":"Poll option","title":"PollOptionResponseData","x-stream-index":"001"}},"required":["poll_option","duration"],"type":"object"},"PollOptionResponseData":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id","text","custom"],"type":"object"},"PollResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"poll":{"$ref":"#/components/schemas/PollResponseData","description":"Poll","title":"PollResponseData","x-stream-index":"001"}},"required":["poll","duration"],"type":"object"},"PollResponseData":{"properties":{"allow_answers":{"type":"boolean","x-stream-index":"008"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"007"},"answers_count":{"format":"int32","type":"integer","x-stream-index":"012"},"created_at":{"format":"date-time","type":"number","x-stream-index":"019"},"created_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"018"},"created_by_id":{"type":"string","x-stream-index":"017"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"021"},"description":{"type":"string","x-stream-index":"003"},"enforce_unique_vote":{"type":"boolean","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"is_closed":{"type":"boolean","x-stream-index":"009"},"latest_answers":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array","x-stream-index":"015"},"latest_votes_by_option":{"additionalProperties":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array"},"type":"object","x-stream-index":"014"},"max_votes_allowed":{"format":"int32","type":"integer","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"002"},"options":{"items":{"$ref":"#/components/schemas/PollOptionResponseData"},"type":"array","x-stream-index":"011"},"own_votes":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array","x-stream-index":"016"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"020"},"vote_count":{"format":"int32","type":"integer","x-stream-index":"010"},"vote_counts_by_option":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"013"},"voting_visibility":{"type":"string","x-stream-index":"004"}},"required":["id","name","description","voting_visibility","enforce_unique_vote","allow_user_suggested_options","allow_answers","vote_count","options","answers_count","vote_counts_by_option","latest_votes_by_option","latest_answers","own_votes","created_by_id","created_at","updated_at","custom"],"type":"object"},"PollVote":{"nullable":true,"properties":{"answer_text":{"type":"string","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"004"},"is_answer":{"type":"boolean","x-stream-index":"006"},"option_id":{"type":"string","x-stream-index":"005"},"poll_id":{"type":"string","x-stream-index":"003"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"011"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"009"},"user_id":{"type":"string","x-stream-index":"008"}},"required":["poll_id","id","option_id","created_at","updated_at"],"type":"object"},"PollVoteResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"vote":{"$ref":"#/components/schemas/PollVoteResponseData","description":"Poll vote","title":"PollVoteResponseData","x-stream-index":"001"}},"required":["duration"],"type":"object"},"PollVoteResponseData":{"nullable":true,"properties":{"answer_text":{"type":"string","x-stream-index":"005"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"id":{"type":"string","x-stream-index":"002"},"is_answer":{"type":"boolean","x-stream-index":"004"},"option_id":{"type":"string","x-stream-index":"003"},"poll_id":{"type":"string","x-stream-index":"001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"007"},"user_id":{"type":"string","x-stream-index":"006"}},"required":["poll_id","id","option_id","created_at","updated_at"],"type":"object"},"PollVotesResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"votes":{"description":"Poll votes","items":{"$ref":"#/components/schemas/PollVoteResponseData"},"title":"PollVoteResponseList","type":"array","x-stream-index":"001"}},"required":["votes","duration"],"type":"object"},"PrivacySettings":{"properties":{"read_receipts":{"$ref":"#/components/schemas/ReadReceipts","x-stream-index":"002"},"typing_indicators":{"$ref":"#/components/schemas/TypingIndicators","x-stream-index":"001"}},"type":"object"},"PrivacySettingsResponse":{"properties":{"read_receipts":{"$ref":"#/components/schemas/ReadReceiptsResponse","x-stream-index":"002"},"typing_indicators":{"$ref":"#/components/schemas/TypingIndicatorsResponse","x-stream-index":"001"}},"type":"object"},"PushConfig":{"properties":{"offline_only":{"type":"boolean","x-stream-index":"002"},"version":{"enum":["v1","v2","v3"],"type":"string","x-stream-index":"001"}},"required":["version"],"type":"object"},"PushNotificationConfig":{"properties":{"activity_types":{"enum":["follow","comment","reaction","comment_reaction"],"items":{"type":"string"},"type":"array","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"PushNotificationFields":{"properties":{"apn":{"$ref":"#/components/schemas/APNConfigFields","x-stream-index":"002"},"firebase":{"$ref":"#/components/schemas/FirebaseConfigFields","x-stream-index":"003"},"huawei":{"$ref":"#/components/schemas/HuaweiConfigFields","x-stream-index":"004"},"offline_only":{"type":"boolean","x-stream-index":"001.002"},"providers":{"items":{"$ref":"#/components/schemas/PushProvider"},"type":"array","x-stream-index":"006"},"version":{"type":"string","x-stream-index":"001.001"},"xiaomi":{"$ref":"#/components/schemas/XiaomiConfigFields","x-stream-index":"005"}},"required":["version","offline_only","apn","firebase","huawei","xiaomi"],"type":"object"},"PushNotificationSettingsResponse":{"properties":{"disabled":{"type":"boolean","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"number","x-stream-index":"002"}},"type":"object"},"PushPreferences":{"properties":{"call_level":{"type":"string","x-stream-index":"002"},"chat_level":{"type":"string","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"number","x-stream-index":"005"},"feeds_events":{"$ref":"#/components/schemas/FeedsEventPreferences","x-stream-index":"004"},"feeds_level":{"type":"string","x-stream-index":"003"}},"type":"object"},"PushProvider":{"nullable":true,"properties":{"apn_auth_key":{"type":"string","x-stream-index":"012"},"apn_auth_type":{"type":"string","x-stream-index":"017"},"apn_development":{"type":"boolean","x-stream-index":"018"},"apn_host":{"type":"string","x-stream-index":"019"},"apn_key_id":{"type":"string","x-stream-index":"013"},"apn_notification_template":{"type":"string","x-stream-index":"020"},"apn_p12_cert":{"type":"string","x-stream-index":"014"},"apn_team_id":{"type":"string","x-stream-index":"015"},"apn_topic":{"type":"string","x-stream-index":"016"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"description":{"maxLength":128,"type":"string","x-stream-index":"007"},"disabled_at":{"format":"date-time","type":"number","x-stream-index":"010"},"disabled_reason":{"maxLength":255,"type":"string","x-stream-index":"011"},"firebase_apn_template":{"type":"string","x-stream-index":"025"},"firebase_credentials":{"type":"string","x-stream-index":"022"},"firebase_data_template":{"type":"string","x-stream-index":"023"},"firebase_host":{"type":"string","x-stream-index":"026"},"firebase_notification_template":{"type":"string","x-stream-index":"024"},"firebase_server_key":{"type":"string","x-stream-index":"021"},"huawei_app_id":{"type":"string","x-stream-index":"027"},"huawei_app_secret":{"type":"string","x-stream-index":"028"},"name":{"maxLength":36,"minLength":1,"type":"string","x-stream-index":"005"},"push_templates":{"items":{"$ref":"#/components/schemas/PushTemplate"},"type":"array","x-stream-index":"031"},"type":{"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"xiaomi_app_secret":{"type":"string","x-stream-index":"030"},"xiaomi_package_name":{"type":"string","x-stream-index":"029"}},"required":["name","type","created_at","updated_at"],"type":"object"},"PushProviderResponse":{"properties":{"apn_auth_key":{"type":"string","x-stream-index":"008"},"apn_auth_type":{"type":"string","x-stream-index":"013"},"apn_development":{"type":"boolean","x-stream-index":"014"},"apn_host":{"type":"string","x-stream-index":"015"},"apn_key_id":{"type":"string","x-stream-index":"009"},"apn_p12_cert":{"type":"string","x-stream-index":"010"},"apn_sandbox_certificate":{"type":"boolean","x-stream-index":"016"},"apn_supports_remote_notifications":{"type":"boolean","x-stream-index":"018"},"apn_supports_voip_notifications":{"type":"boolean","x-stream-index":"017"},"apn_team_id":{"type":"string","x-stream-index":"011"},"apn_topic":{"type":"string","x-stream-index":"012"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"description":{"type":"string","x-stream-index":"003"},"disabled_at":{"format":"date-time","type":"number","x-stream-index":"006"},"disabled_reason":{"type":"string","x-stream-index":"007"},"firebase_apn_template":{"type":"string","x-stream-index":"023"},"firebase_credentials":{"type":"string","x-stream-index":"020"},"firebase_data_template":{"type":"string","x-stream-index":"021"},"firebase_host":{"type":"string","x-stream-index":"024"},"firebase_notification_template":{"type":"string","x-stream-index":"022"},"firebase_server_key":{"type":"string","x-stream-index":"019"},"huawei_app_id":{"type":"string","x-stream-index":"025"},"huawei_app_secret":{"type":"string","x-stream-index":"026"},"name":{"type":"string","x-stream-index":"001"},"type":{"type":"string","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"005"},"xiaomi_app_secret":{"type":"string","x-stream-index":"028"},"xiaomi_package_name":{"type":"string","x-stream-index":"027"}},"required":["name","type","created_at","updated_at"],"type":"object"},"PushTemplate":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"enable_push":{"type":"boolean","x-stream-index":"003"},"event_type":{"enum":["message.new","message.updated","reaction.new","notification.reminder_due","feeds.activity.added","feeds.comment.added","feeds.activity.reaction.added","feeds.comment.reaction.added","feeds.follow.created","feeds.notification_feed.updated"],"type":"string","x-stream-index":"005"},"template":{"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"008"}},"required":["enable_push","event_type","created_at","updated_at"],"type":"object"},"Quality":{"properties":{"bitdepth":{"format":"int32","type":"integer","x-stream-index":"007"},"framerate":{"format":"int32","type":"integer","x-stream-index":"008"},"height":{"format":"int32","type":"integer","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"004"},"video_bitrate":{"format":"int32","type":"integer","x-stream-index":"009"},"width":{"format":"int32","type":"integer","x-stream-index":"005"}},"type":"object"},"QueryActivitiesRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filters to apply to the query. Supports location-based queries with 'near' and 'within_bounds' operators.","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"Sorting parameters for the query","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"002"}},"title":"Query Activities Request","type":"object"},"QueryActivitiesResponse":{"nullable":true,"properties":{"activities":{"description":"List of activities matching the query","items":{"$ref":"#/components/schemas/ActivityResponse"},"title":"Activities","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"next":{"description":"Cursor for next page","title":"Next","type":"string","x-stream-index":"002.001"},"prev":{"description":"Cursor for previous page","title":"Previous","type":"string","x-stream-index":"002.002"}},"required":["activities","duration"],"title":"Query Activities Response","type":"object"},"QueryActivityReactionsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"type":"object","x-stream-index":"002"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"004.001"},"next":{"type":"string","x-stream-index":"004.002"},"prev":{"type":"string","x-stream-index":"004.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"type":"array","x-stream-index":"003"}},"type":"object"},"QueryActivityReactionsResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"reactions":{"items":{"$ref":"#/components/schemas/FeedsReactionResponse"},"type":"array","x-stream-index":"001"}},"required":["reactions","duration"],"title":"Response","type":"object"},"QueryBookmarkFoldersRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filters to apply to the query","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"Sorting parameters for the query","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"002"}},"title":"Query Bookmark Folders Request","type":"object"},"QueryBookmarkFoldersResponse":{"nullable":true,"properties":{"bookmark_folders":{"description":"List of bookmark folders matching the query","items":{"$ref":"#/components/schemas/BookmarkFolderResponse"},"title":"Bookmark Folders","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"next":{"description":"Cursor for next page","title":"Next","type":"string","x-stream-index":"002.001"},"prev":{"description":"Cursor for previous page","title":"Previous","type":"string","x-stream-index":"002.002"}},"required":["bookmark_folders","duration"],"title":"Query Bookmark Folders Response","type":"object"},"QueryBookmarksRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filters to apply to the query","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"Sorting parameters for the query","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"002"}},"title":"Query Bookmarks Request","type":"object"},"QueryBookmarksResponse":{"nullable":true,"properties":{"bookmarks":{"description":"List of bookmarks matching the query","items":{"$ref":"#/components/schemas/BookmarkResponse"},"title":"Bookmarks","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"next":{"description":"Cursor for next page","title":"Next","type":"string","x-stream-index":"002.001"},"prev":{"description":"Cursor for previous page","title":"Previous","type":"string","x-stream-index":"002.002"}},"required":["bookmarks","duration"],"title":"Query Bookmarks Response","type":"object"},"QueryCommentReactionsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"type":"object","x-stream-index":"002"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"004.001"},"next":{"type":"string","x-stream-index":"004.002"},"prev":{"type":"string","x-stream-index":"004.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"type":"array","x-stream-index":"003"}},"type":"object"},"QueryCommentReactionsResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"reactions":{"items":{"$ref":"#/components/schemas/FeedsReactionResponse"},"type":"array","x-stream-index":"001"}},"required":["reactions","duration"],"title":"Response","type":"object"},"QueryCommentsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"MongoDB-style filter for querying comments","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"description":"Maximum number of comments to return","format":"int32","maximum":100,"minimum":0,"title":"Limit","type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"first (oldest), last (newest) or top","enum":["first","last","top","best","controversial"],"title":"Sort Order","type":"string","x-stream-index":"002"}},"required":["filter"],"title":"Query Comments Request","type":"object"},"QueryCommentsResponse":{"nullable":true,"properties":{"comments":{"description":"List of comments matching the query","items":{"$ref":"#/components/schemas/CommentResponse"},"title":"Comments","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"next":{"description":"Cursor for next page","title":"Next","type":"string","x-stream-index":"002.001"},"prev":{"description":"Cursor for previous page","title":"Previous","type":"string","x-stream-index":"002.002"}},"required":["comments","duration"],"title":"Query Comments Response","type":"object"},"QueryFeedMembersRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter parameters for the query","title":"object","type":"object","x-stream-index":"003"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Sort parameters for the query","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"array","type":"array","x-stream-index":"004"}},"type":"object"},"QueryFeedMembersResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"003.001"},"members":{"description":"List of feed members","items":{"$ref":"#/components/schemas/FeedMemberResponse"},"title":"array","type":"array","x-stream-index":"001"},"next":{"description":"Cursor for next page","title":"Next","type":"string","x-stream-index":"002.001"},"prev":{"description":"Cursor for previous page","title":"Previous","type":"string","x-stream-index":"002.002"}},"required":["members","duration"],"type":"object"},"QueryFeedModerationTemplate":{"properties":{"config":{"$ref":"#/components/schemas/FeedsModerationTemplateConfig","description":"Configuration for the moderation template","title":"Config","x-stream-index":"002"},"created_at":{"description":"When the template was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"003"},"name":{"description":"Name of the moderation template","title":"Name","type":"string","x-stream-index":"001"},"updated_at":{"description":"When the template was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"004"}},"required":["name","created_at","updated_at"],"type":"object"},"QueryFeedModerationTemplatesResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"templates":{"description":"List of moderation templates","items":{"$ref":"#/components/schemas/QueryFeedModerationTemplate"},"title":"Templates","type":"array","x-stream-index":"001"}},"required":["templates","duration"],"type":"object"},"QueryFeedsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filters to apply to the query","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"004.001"},"next":{"type":"string","x-stream-index":"004.002"},"prev":{"type":"string","x-stream-index":"004.003"},"sort":{"description":"Sorting parameters for the query","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"003"},"watch":{"description":"Whether to subscribe to realtime updates","title":"Watch","type":"boolean","x-stream-index":"002"}},"title":"Query Feeds Request","type":"object"},"QueryFeedsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"003.001"},"feeds":{"description":"List of feeds matching the query","items":{"$ref":"#/components/schemas/FeedResponse"},"title":"Feeds","type":"array","x-stream-index":"001"},"next":{"description":"Cursor for next page","title":"Next","type":"string","x-stream-index":"002.001"},"prev":{"description":"Cursor for previous page","title":"Previous","type":"string","x-stream-index":"002.002"}},"required":["feeds","duration"],"title":"Query Feeds Response","type":"object"},"QueryFollowsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filters to apply to the query","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"Sorting parameters for the query","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"002"}},"title":"Query Follows Request","type":"object"},"QueryFollowsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"003.001"},"follows":{"description":"List of follow relationships matching the query","items":{"$ref":"#/components/schemas/FollowResponse"},"title":"Follows","type":"array","x-stream-index":"001"},"next":{"description":"Cursor for next page","title":"Next","type":"string","x-stream-index":"002.001"},"prev":{"description":"Cursor for previous page","title":"Previous","type":"string","x-stream-index":"002.002"}},"required":["follows","duration"],"title":"Query Follows Response","type":"object"},"QueryMembershipLevelsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filters to apply to the query","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"Sorting parameters for the query","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"002"}},"title":"Query Membership Levels Request","type":"object"},"QueryMembershipLevelsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"003.001"},"membership_levels":{"items":{"$ref":"#/components/schemas/MembershipLevelResponse"},"type":"array","x-stream-index":"001"},"next":{"description":"Cursor for next page","title":"Next","type":"string","x-stream-index":"002.001"},"prev":{"description":"Cursor for previous page","title":"Previous","type":"string","x-stream-index":"002.002"}},"required":["membership_levels","duration"],"title":"Query Membership Levels Response","type":"object"},"QueryModerationConfigsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter conditions for moderation configs","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"Sorting parameters for the results","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"type":"object"},"QueryModerationConfigsResponse":{"nullable":true,"properties":{"configs":{"description":"List of moderation configurations","items":{"$ref":"#/components/schemas/ConfigResponse"},"title":"Configs","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["configs","duration"],"type":"object"},"QueryModerationFlagsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParam"},"type":"array","x-stream-index":"002"}},"type":"object"},"QueryModerationFlagsResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"flags":{"items":{"$ref":"#/components/schemas/ModerationFlagResponse"},"type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["flags","duration"],"title":"Response","type":"object"},"QueryModerationLogsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter conditions for moderation logs","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"Sorting parameters for the results","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"type":"object"},"QueryModerationLogsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"003.001"},"logs":{"description":"List of moderation action logs","items":{"$ref":"#/components/schemas/ActionLogResponse"},"title":"Logs","type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["logs","duration"],"type":"object"},"QueryModerationRulesRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter conditions for moderation rules","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"Sorting parameters for the results","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"type":"object"},"QueryModerationRulesResponse":{"nullable":true,"properties":{"default_llm_labels":{"additionalProperties":{"type":"string"},"description":"Default LLM label descriptions","title":"DefaultLLMLabels","type":"object","x-stream-index":"002"},"duration":{"type":"string","x-stream-index":"004.001"},"next":{"type":"string","x-stream-index":"003.001"},"prev":{"type":"string","x-stream-index":"003.002"},"rules":{"description":"List of moderation rules","items":{"$ref":"#/components/schemas/ModerationRuleV2Response"},"title":"Rules","type":"array","x-stream-index":"001"}},"required":["rules","default_llm_labels","duration"],"type":"object"},"QueryPollVotesRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","title":"Filter","type":"object","x-stream-index":"003"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"004"}},"type":"object"},"QueryPollsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","title":"Filter","type":"object","x-stream-index":"002"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"003"}},"type":"object"},"QueryPollsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"polls":{"description":"Polls data returned by the query","items":{"$ref":"#/components/schemas/PollResponseData"},"title":"PollsResponseData","type":"array","x-stream-index":"001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["polls","duration"],"type":"object"},"QueryReviewQueueRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter conditions for review queue items","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"007.001"},"lock_count":{"description":"Number of items to lock (1-25)","format":"int32","maximum":25,"minimum":1,"title":"Lock Count","type":"integer","x-stream-index":"005"},"lock_duration":{"description":"Duration for which items should be locked","title":"Lock Duration","type":"integer","x-stream-index":"004"},"lock_items":{"description":"Whether to lock items for review (true), unlock items (false), or just fetch (nil)","title":"Lock Items","type":"boolean","x-stream-index":"003"},"next":{"type":"string","x-stream-index":"007.002"},"prev":{"type":"string","x-stream-index":"007.003"},"sort":{"description":"Sorting parameters for the results","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"002"},"stats_only":{"description":"Whether to return only statistics","title":"Stats Only","type":"boolean","x-stream-index":"006"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"008.002"},"user_id":{"type":"string","x-stream-index":"008.001"}},"type":"object"},"QueryReviewQueueResponse":{"nullable":true,"properties":{"action_config":{"additionalProperties":{"items":{"$ref":"#/components/schemas/ModerationActionConfig"},"type":"array"},"description":"Configuration for moderation actions","title":"Action Config","type":"object","x-stream-index":"002"},"duration":{"type":"string","x-stream-index":"005.001"},"items":{"description":"List of review queue items","items":{"$ref":"#/components/schemas/ReviewQueueItemResponse"},"title":"Items","type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"004.001"},"prev":{"type":"string","x-stream-index":"004.002"},"stats":{"additionalProperties":{},"description":"Statistics about the review queue","title":"Stats","type":"object","x-stream-index":"003"}},"required":["items","action_config","stats","duration"],"type":"object"},"QueryUsersPayload":{"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"include_deactivated_users":{"type":"boolean","x-stream-index":"004"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.003"},"offset":{"format":"int32","maximum":1000,"type":"integer","x-stream-index":"005.004"},"presence":{"type":"boolean","x-stream-index":"003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"006.002"},"user_id":{"type":"string","x-stream-index":"006.001"}},"required":["filter_conditions"],"type":"object"},"QueryUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"users":{"description":"Array of users as result of filters applied.","items":{"$ref":"#/components/schemas/FullUserResponse"},"title":"Users","type":"array","x-stream-index":"001"}},"required":["users","duration"],"type":"object"},"RTMPEgressConfig":{"properties":{"composite_app_settings":{"$ref":"#/components/schemas/CompositeAppSettings","x-stream-index":"005"},"quality":{"$ref":"#/components/schemas/Quality","x-stream-index":"004"},"rtmp_location":{"type":"string","x-stream-index":"006"}},"type":"object"},"RTMPIngress":{"description":"RTMP input settings","properties":{"address":{"title":"Address","type":"string","x-stream-index":"001"}},"required":["address"],"title":"RTMPIngress","type":"object"},"RTMPLocation":{"properties":{"name":{"type":"string","x-stream-index":"001"},"stream_key":{"type":"string","x-stream-index":"003"},"stream_url":{"type":"string","x-stream-index":"002"}},"required":["name","stream_url","stream_key"],"type":"object"},"RTMPSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"003"},"location":{"$ref":"#/components/schemas/RTMPLocation","x-stream-index":"004"},"quality_name":{"type":"string","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"RTMPSettingsResponse":{"description":"RTMPSettingsResponse is the payload for RTMP settings","properties":{"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettingsResponse","title":"Layout","x-stream-index":"003"},"quality":{"title":"Quality","type":"string","x-stream-index":"002"}},"required":["enabled","quality","layout"],"title":"RTMPSettingsResponse","type":"object"},"RankingConfig":{"properties":{"defaults":{"additionalProperties":{},"description":"Default values for ranking","title":"Defaults","type":"object","x-stream-index":"003"},"functions":{"additionalProperties":{"$ref":"#/components/schemas/DecayFunctionConfig"},"description":"Decay functions configuration","title":"Functions","type":"object","x-stream-index":"004"},"score":{"description":"Scoring formula","title":"Score","type":"string","x-stream-index":"002"},"type":{"description":"Type of ranking algorithm","title":"Type","type":"string","x-stream-index":"001"}},"title":"Ranking Configuration","type":"object"},"Reaction":{"nullable":true,"properties":{"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"message_id":{"type":"string","x-stream-index":"003"},"score":{"format":"int32","type":"integer","x-stream-index":"007"},"type":{"maxLength":30,"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["message_id","type","score","created_at","updated_at","custom"],"type":"object"},"ReactionGroupResponse":{"description":"ReactionGroupResponse contains all information about a reaction of the same type.","nullable":true,"properties":{"count":{"description":"Count is the number of reactions of this type.","format":"int32","title":"Count","type":"integer","x-stream-index":"001"},"first_reaction_at":{"description":"FirstReactionAt is the time of the first reaction of this type. This is the same also if all reaction of this type are deleted, because if someone will react again with the same type, will be preserved the sorting.","format":"date-time","title":"FirstReactionAt","type":"number","x-stream-index":"003"},"last_reaction_at":{"description":"LastReactionAt is the time of the last reaction of this type.","format":"date-time","title":"LastReactionAt","type":"number","x-stream-index":"004"},"sum_scores":{"description":"SumScores is the sum of all scores of reactions of this type. Medium allows you to clap articles more than once and shows the sum of all claps from all users. For example, you can send `clap` x5 using `score: 5`.","format":"int32","title":"SumScores","type":"integer","x-stream-index":"002"}},"required":["count","sum_scores","first_reaction_at","last_reaction_at"],"title":"ReactionGroupResponse","type":"object"},"ReactionResponse":{"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"006"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"008"},"message_id":{"description":"Message ID","title":"Message ID","type":"string","x-stream-index":"001"},"score":{"description":"Score of the reaction","format":"int32","title":"Score","type":"integer","x-stream-index":"005"},"type":{"description":"Type of reaction","title":"Type","type":"string","x-stream-index":"004"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"007"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User","title":"UserResponse","x-stream-index":"003"},"user_id":{"description":"User ID","title":"User ID","type":"string","x-stream-index":"002"}},"required":["message_id","user_id","user","type","score","created_at","updated_at","custom"],"type":"object"},"ReactivateUserRequest":{"nullable":true,"properties":{"created_by_id":{"description":"ID of the user who's reactivating the user","title":"Created by ID","type":"string","x-stream-index":"004"},"name":{"description":"Set this field to put new name for the user","title":"Name","type":"string","x-stream-index":"003"},"restore_messages":{"description":"Restore previously deleted messages","title":"Restore messages","type":"boolean","x-stream-index":"002"}},"type":"object"},"ReactivateUserResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.002.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Deactivated user object","title":"User","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"ReactivateUsersRequest":{"description":"Reactivate users in batches","nullable":true,"properties":{"created_by_id":{"description":"ID of the user who's reactivating the users","title":"Created by ID","type":"string","x-stream-index":"003"},"restore_channels":{"type":"boolean","x-stream-index":"004"},"restore_messages":{"description":"Restore previously deleted messages","title":"Restore messages","type":"boolean","x-stream-index":"002"},"user_ids":{"description":"User IDs to reactivate","items":{"type":"string"},"maximum":100,"minimum":1,"title":"User IDs","type":"array","x-stream-index":"001"}},"required":["user_ids"],"title":"ReactivateUsersRequest","type":"object"},"ReactivateUsersResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.002.001"},"task_id":{"type":"string","x-stream-index":"001.001"}},"required":["task_id","duration"],"title":"Response","type":"object"},"ReadReceipts":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"ReadReceiptsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"RecordSettings":{"properties":{"audio_only":{"type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"004"},"mode":{"type":"string","x-stream-index":"002"},"quality":{"type":"string","x-stream-index":"003"}},"required":["mode"],"type":"object"},"RecordSettingsResponse":{"description":"RecordSettings is the payload for recording settings","properties":{"audio_only":{"title":"Audio Only","type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettingsResponse","title":"Layout","x-stream-index":"004"},"mode":{"title":"Mode","type":"string","x-stream-index":"002"},"quality":{"title":"Quality","type":"string","x-stream-index":"003"}},"required":["audio_only","mode","quality","layout"],"title":"RecordSettingsResponse","type":"object"},"RecordingEgressConfig":{"properties":{"audio_only":{"type":"boolean","x-stream-index":"006"},"composite_app_settings":{"$ref":"#/components/schemas/CompositeAppSettings","x-stream-index":"005"},"external_storage":{"$ref":"#/components/schemas/ExternalStorage","x-stream-index":"008"},"quality":{"$ref":"#/components/schemas/Quality","x-stream-index":"004"},"storage_name":{"type":"string","x-stream-index":"007"},"video_orientation_hint":{"$ref":"#/components/schemas/VideoOrientation","x-stream-index":"009"}},"type":"object"},"RejectFeedMemberInviteRequest":{"nullable":true,"properties":{"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"title":"Reject Feed Member Request","type":"object"},"RejectFeedMemberInviteResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"member":{"$ref":"#/components/schemas/FeedMemberResponse","description":"The feed member after rejecting the invite","title":"Feed Member","x-stream-index":"001"}},"required":["member","duration"],"title":"Reject Feed Member Response","type":"object"},"RejectFollowRequest":{"nullable":true,"properties":{"source":{"description":"Fully qualified ID of the source feed","maxLength":255,"title":"Source Feed ID","type":"string","x-stream-index":"001"},"target":{"description":"Fully qualified ID of the target feed","maxLength":255,"title":"Target Feed ID","type":"string","x-stream-index":"002"}},"required":["source","target"],"title":"Reject Follow Request","type":"object"},"RejectFollowResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"follow":{"$ref":"#/components/schemas/FollowResponse","description":"The rejected follow relationship","title":"Follow","x-stream-index":"001"}},"required":["follow","duration"],"title":"Reject Follow Response","type":"object"},"ReminderResponseData":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003"},"channel_cid":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"005"},"message_id":{"type":"string","x-stream-index":"004"},"remind_at":{"format":"date-time","type":"number","x-stream-index":"001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007"},"user_id":{"type":"string","x-stream-index":"006"}},"required":["channel_cid","message_id","user_id","created_at","updated_at"],"type":"object"},"RepliesMeta":{"description":"Cursor \u0026 depth information for a comment's direct replies. Mirrors Reddit's 'load more replies' semantics.","properties":{"depth_truncated":{"description":"True if the subtree was cut because the requested depth was reached.","title":"Depth Truncated","type":"boolean","x-stream-index":"004"},"has_more":{"description":"True if more siblings exist in the database.","title":"Has More","type":"boolean","x-stream-index":"001"},"next_cursor":{"description":"Opaque cursor to request the next page of siblings.","title":"Next Cursor","type":"string","x-stream-index":"002"},"remaining":{"description":"Number of unread siblings that match current filters.","format":"int32","title":"Remaining","type":"integer","x-stream-index":"003"}},"required":["has_more","remaining","depth_truncated"],"title":"Replies Meta","type":"object"},"Response":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001"}},"required":["duration"],"title":"Response","type":"object"},"RestoreActionRequest":{"type":"object"},"RestoreUsersRequest":{"nullable":true,"properties":{"user_ids":{"items":{"type":"string"},"maximum":100,"minimum":1,"type":"array","x-stream-index":"001"}},"required":["user_ids"],"type":"object"},"ReviewQueueItem":{"properties":{"actions":{"items":{"$ref":"#/components/schemas/ActionLog"},"type":"array","x-stream-index":"035"},"activity":{"$ref":"#/components/schemas/EnrichedActivity","x-stream-index":"028"},"ai_text_severity":{"type":"string","x-stream-index":"021"},"archived_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"043"},"assigned_to":{"$ref":"#/components/schemas/User","x-stream-index":"032"},"bans":{"items":{"$ref":"#/components/schemas/Ban"},"type":"array","x-stream-index":"033"},"bounce_count":{"format":"int32","type":"integer","x-stream-index":"025"},"call":{"$ref":"#/components/schemas/Call","x-stream-index":"031"},"completed_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"018"},"config_key":{"type":"string","x-stream-index":"009"},"content_changed":{"type":"boolean","x-stream-index":"036"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"entity_creator":{"$ref":"#/components/schemas/EntityCreator","x-stream-index":"030"},"entity_id":{"type":"string","x-stream-index":"007"},"entity_type":{"type":"string","x-stream-index":"006"},"feeds_v2_activity":{"$ref":"#/components/schemas/EnrichedActivity","x-stream-index":"041"},"feeds_v2_reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"042"},"flag_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"045"},"flag_types":{"items":{"type":"string"},"type":"array","x-stream-index":"044"},"flags":{"items":{"$ref":"#/components/schemas/Flag"},"type":"array","x-stream-index":"034"},"flags_count":{"format":"int32","type":"integer","x-stream-index":"026"},"has_image":{"type":"boolean","x-stream-index":"012"},"has_text":{"type":"boolean","x-stream-index":"014"},"has_video":{"type":"boolean","x-stream-index":"013"},"id":{"type":"string","x-stream-index":"003"},"languages":{"items":{"type":"string"},"type":"array","x-stream-index":"019"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"027"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"010"},"moderation_payload_hash":{"type":"string","x-stream-index":"011"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"029"},"recommended_action":{"type":"string","x-stream-index":"017"},"reporter_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"046"},"reviewed_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"022"},"reviewed_by":{"type":"string","x-stream-index":"023"},"severity":{"format":"int32","type":"integer","x-stream-index":"020"},"status":{"type":"string","x-stream-index":"016"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"015"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"005"}},"required":["id","created_at","updated_at","entity_type","entity_id","config_key","moderation_payload_hash","has_image","has_video","has_text","teams","status","recommended_action","completed_at","languages","severity","ai_text_severity","reviewed_at","reviewed_by","bounce_count","flags_count","bans","flags","actions","content_changed","archived_at","flag_types","flag_labels","reporter_ids"],"type":"object"},"ReviewQueueItemNewEvent":{"description":"This event is sent when a new moderation review queue item is created","nullable":true,"properties":{"action":{"$ref":"#/components/schemas/ActionLogResponse","description":"The action log if any action was taken","title":"Action","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"flags":{"description":"The flags associated with this review queue item","items":{"$ref":"#/components/schemas/ModerationFlagResponse"},"title":"Flags","type":"array","x-stream-index":"003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"The review queue item that was created","title":"ReviewQueueItem","x-stream-index":"002"},"type":{"default":"review_queue_item.new","type":"string","x-stream-index":"001.002"}},"required":["type","created_at","custom"],"title":"ReviewQueueItemNewEvent","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"},"ReviewQueueItemResponse":{"properties":{"actions":{"description":"Moderation actions taken","items":{"$ref":"#/components/schemas/ActionLogResponse"},"title":"Actions","type":"array","x-stream-index":"024"},"activity":{"$ref":"#/components/schemas/EnrichedActivity","x-stream-index":"016"},"ai_text_severity":{"description":"AI-determined text severity","title":"AI Text Severity","type":"string","x-stream-index":"014"},"assigned_to":{"$ref":"#/components/schemas/UserResponse","description":"Moderator assigned to review this item","title":"Assigned To","x-stream-index":"021"},"bans":{"description":"Associated ban records","items":{"$ref":"#/components/schemas/Ban"},"title":"Bans","type":"array","x-stream-index":"022"},"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"018"},"completed_at":{"description":"When the review was completed","format":"date-time","title":"Completed At","type":"number","x-stream-index":"009"},"config_key":{"type":"string","x-stream-index":"028"},"created_at":{"description":"When the item was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"002"},"entity_creator":{"$ref":"#/components/schemas/EntityCreatorResponse","description":"Details about who created the entity","title":"Entity Creator","x-stream-index":"019"},"entity_creator_id":{"description":"ID of who created the entity","title":"Entity Creator ID","type":"string","x-stream-index":"020"},"entity_id":{"description":"ID of the entity being reviewed","title":"Entity ID","type":"string","x-stream-index":"005"},"entity_type":{"description":"Type of entity being reviewed","title":"Entity Type","type":"string","x-stream-index":"004"},"feeds_v2_activity":{"$ref":"#/components/schemas/EnrichedActivity","description":"Associated feed activity","title":"Feeds V2 Activity","x-stream-index":"025"},"feeds_v2_reaction":{"$ref":"#/components/schemas/Reaction","description":"Associated feed reaction","title":"Feeds V2 Reaction","x-stream-index":"026"},"flags":{"description":"Associated flag records","items":{"$ref":"#/components/schemas/ModerationFlagResponse"},"title":"Flags","type":"array","x-stream-index":"023"},"flags_count":{"format":"int32","type":"integer","x-stream-index":"029"},"id":{"description":"Unique identifier of the review queue item","title":"ID","type":"string","x-stream-index":"001"},"languages":{"description":"Detected languages in the content","items":{"type":"string"},"title":"Languages","type":"array","x-stream-index":"012"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Associated message details","title":"Message","x-stream-index":"015"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content being moderated","title":"Moderation Payload","x-stream-index":"006"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"017"},"recommended_action":{"description":"Suggested moderation action","title":"Recommended Action","type":"string","x-stream-index":"008"},"reviewed_at":{"description":"When the item was reviewed","format":"date-time","title":"Reviewed At","type":"number","x-stream-index":"010"},"reviewed_by":{"description":"ID of the moderator who reviewed the item","title":"Reviewed By","type":"string","x-stream-index":"011"},"severity":{"description":"Severity level of the content","format":"int32","title":"Severity","type":"integer","x-stream-index":"013"},"status":{"description":"Current status of the review","title":"Status","type":"string","x-stream-index":"007"},"teams":{"description":"Teams associated with this item","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"027"},"updated_at":{"description":"When the item was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"003"}},"required":["id","created_at","updated_at","entity_type","entity_id","status","recommended_action","reviewed_by","languages","severity","ai_text_severity","bans","flags","actions","flags_count"],"type":"object"},"ReviewQueueItemUpdatedEvent":{"description":"This event is sent when a moderation review queue item is updated","nullable":true,"properties":{"action":{"$ref":"#/components/schemas/ActionLogResponse","description":"The action log if any action was taken","title":"Action","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"flags":{"description":"The flags associated with this review queue item","items":{"$ref":"#/components/schemas/ModerationFlagResponse"},"title":"Flags","type":"array","x-stream-index":"003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"The review queue item that was updated","title":"ReviewQueueItem","x-stream-index":"002"},"type":{"default":"review_queue_item.updated","type":"string","x-stream-index":"001.002"}},"required":["type","created_at","custom"],"title":"ReviewQueueItemUpdatedEvent","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"},"RingSettings":{"properties":{"auto_cancel_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_timeout_ms","missed_call_timeout_ms"],"type":"object"},"RingSettingsResponse":{"properties":{"auto_cancel_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_timeout_ms","missed_call_timeout_ms"],"type":"object"},"Role":{"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"004"},"custom":{"description":"Whether this is a custom role or built-in","title":"Custom","type":"boolean","x-stream-index":"002"},"name":{"description":"Unique role name","title":"Name","type":"string","x-stream-index":"001"},"scopes":{"description":"List of scopes where this role is currently present. `.app` means that role is present in app-level grants","items":{"type":"string"},"title":"Scopes","type":"array","x-stream-index":"003"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"005"}},"required":["name","custom","scopes","created_at","updated_at"],"type":"object"},"RuleBuilderAction":{"properties":{"ban_options":{"$ref":"#/components/schemas/BanOptions","x-stream-index":"002"},"flag_content_options":{"$ref":"#/components/schemas/FlagContentOptions","x-stream-index":"004"},"flag_user_options":{"$ref":"#/components/schemas/FlagUserOptions","x-stream-index":"003"},"remove_content_options":{"$ref":"#/components/schemas/BlockContentOptions","x-stream-index":"005"},"type":{"type":"string","x-stream-index":"001"}},"type":"object"},"RuleBuilderCondition":{"properties":{"confidence":{"format":"float","type":"number","x-stream-index":"002"},"content_count_rule_params":{"$ref":"#/components/schemas/ContentCountRuleParameters","x-stream-index":"007"},"image_content_params":{"$ref":"#/components/schemas/ImageContentParameters","x-stream-index":"009"},"image_rule_params":{"$ref":"#/components/schemas/ImageRuleParameters","x-stream-index":"004"},"text_content_params":{"$ref":"#/components/schemas/TextContentParameters","x-stream-index":"008"},"text_rule_params":{"$ref":"#/components/schemas/TextRuleParameters","x-stream-index":"003"},"type":{"type":"string","x-stream-index":"001"},"user_created_within_params":{"$ref":"#/components/schemas/UserCreatedWithinParameters","x-stream-index":"011"},"user_custom_property_params":{"$ref":"#/components/schemas/UserCustomPropertyParameters","x-stream-index":"012"},"user_rule_params":{"$ref":"#/components/schemas/UserRuleParameters","x-stream-index":"006"},"video_content_params":{"$ref":"#/components/schemas/VideoContentParameters","x-stream-index":"010"},"video_rule_params":{"$ref":"#/components/schemas/VideoRuleParameters","x-stream-index":"005"}},"type":"object"},"RuleBuilderConditionGroup":{"properties":{"conditions":{"items":{"$ref":"#/components/schemas/RuleBuilderCondition"},"type":"array","x-stream-index":"002"},"logic":{"type":"string","x-stream-index":"001"}},"type":"object"},"RuleBuilderConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"rules":{"items":{"$ref":"#/components/schemas/RuleBuilderRule"},"type":"array","x-stream-index":"002"}},"type":"object"},"RuleBuilderRule":{"properties":{"action":{"$ref":"#/components/schemas/RuleBuilderAction","x-stream-index":"006"},"conditions":{"items":{"$ref":"#/components/schemas/RuleBuilderCondition"},"type":"array","x-stream-index":"003"},"cooldown_period":{"type":"string","x-stream-index":"007"},"groups":{"items":{"$ref":"#/components/schemas/RuleBuilderConditionGroup"},"type":"array","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"logic":{"type":"string","x-stream-index":"004"},"rule_type":{"type":"string","x-stream-index":"002"}},"required":["rule_type","action"],"type":"object"},"S3Request":{"description":"Config for creating Amazon S3 storage.","properties":{"s3_api_key":{"description":"The AWS API key. To use Amazon S3 as your storage provider, you have two authentication options: IAM role or API key. If you do not specify the `s3_api_key` parameter, Stream will use IAM role authentication. In that case make sure to have the correct IAM role configured for your application.","title":"S3ApiKey","type":"string","x-stream-index":"002"},"s3_custom_endpoint_url":{"description":"The custom endpoint for S3. If you want to use a custom endpoint, you must also provide the `s3_api_key` and `s3_secret` parameters.","title":"S3CustomEndpointURL","type":"string","x-stream-index":"004"},"s3_region":{"description":"The AWS region where the bucket is hosted","title":"S3Region","type":"string","x-stream-index":"001"},"s3_secret":{"description":"The AWS API Secret","title":"S3Secret","type":"string","x-stream-index":"003"}},"required":["s3_region"],"title":"S3Request","type":"object"},"SFUIDLastSeen":{"properties":{"id":{"type":"string","x-stream-index":"001.001"},"last_seen":{"format":"date-time","type":"number","x-stream-index":"002"},"process_start_time":{"format":"int64","type":"integer","x-stream-index":"001.002"}},"required":["id","process_start_time","last_seen"],"type":"object"},"STTEgressConfig":{"properties":{"closed_captions_enabled":{"type":"boolean","x-stream-index":"005"},"external_storage":{"$ref":"#/components/schemas/ExternalStorage","x-stream-index":"011"},"language":{"type":"string","x-stream-index":"008"},"storage_name":{"type":"string","x-stream-index":"010"},"translation_languages":{"items":{"type":"string"},"type":"array","x-stream-index":"009"},"translations_enabled":{"type":"boolean","x-stream-index":"006"},"upload_transcriptions":{"type":"boolean","x-stream-index":"004"},"whisper_server_base_url":{"type":"string","x-stream-index":"007"}},"type":"object"},"ScreensharingSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled"],"type":"object"},"ScreensharingSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled"],"type":"object"},"SessionSettings":{"properties":{"inactivity_timeout_seconds":{"format":"int32","maximum":900,"minimum":5,"type":"integer","x-stream-index":"001"}},"required":["inactivity_timeout_seconds"],"type":"object"},"SessionSettingsResponse":{"properties":{"inactivity_timeout_seconds":{"format":"int32","maximum":900,"minimum":5,"type":"integer","x-stream-index":"001"}},"required":["inactivity_timeout_seconds"],"type":"object"},"ShadowBlockActionRequest":{"type":"object"},"SharedLocation":{"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"013"},"channel_cid":{"type":"string","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"010"},"created_by_device_id":{"type":"string","x-stream-index":"008"},"end_at":{"format":"date-time","type":"number","x-stream-index":"009"},"latitude":{"format":"float","maximum":90,"minimum":18446744073709552000,"type":"number","x-stream-index":"006"},"longitude":{"format":"float","maximum":180,"minimum":18446744073709552000,"type":"number","x-stream-index":"007"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"012"},"message_id":{"type":"string","x-stream-index":"004"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"011"},"user_id":{"type":"string","x-stream-index":"005"}},"required":["channel_cid","message_id","user_id","created_by_device_id","created_at","updated_at"],"type":"object"},"SharedLocationResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001.011"},"channel_cid":{"description":"Channel CID","title":"string","type":"string","x-stream-index":"001.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.008"},"created_by_device_id":{"description":"Device ID that created the live location","title":"string","type":"string","x-stream-index":"001.006"},"duration":{"type":"string","x-stream-index":"002.001"},"end_at":{"description":"Time when the live location expires","format":"date-time","title":"string","type":"number","x-stream-index":"001.007"},"latitude":{"description":"Latitude coordinate","format":"float","title":"number","type":"number","x-stream-index":"001.004"},"longitude":{"description":"Longitude coordinate","format":"float","title":"number","type":"number","x-stream-index":"001.005"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001.010"},"message_id":{"description":"Message ID","title":"string","type":"string","x-stream-index":"001.002"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.009"},"user_id":{"description":"User ID","title":"string","type":"string","x-stream-index":"001.003"}},"required":["channel_cid","message_id","user_id","latitude","longitude","created_by_device_id","created_at","updated_at","duration"],"type":"object"},"SharedLocationResponseData":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"011"},"channel_cid":{"type":"string","x-stream-index":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"created_by_device_id":{"type":"string","x-stream-index":"006"},"end_at":{"format":"date-time","type":"number","x-stream-index":"007"},"latitude":{"format":"float","type":"number","x-stream-index":"004"},"longitude":{"format":"float","type":"number","x-stream-index":"005"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"010"},"message_id":{"type":"string","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["channel_cid","message_id","user_id","latitude","longitude","created_by_device_id","created_at","updated_at"],"type":"object"},"SharedLocationsResponse":{"nullable":true,"properties":{"active_live_locations":{"items":{"$ref":"#/components/schemas/SharedLocationResponseData"},"type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["active_live_locations","duration"],"type":"object"},"SingleFollowResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"follow":{"$ref":"#/components/schemas/FollowResponse","description":"The created follow relationship","title":"Follow","x-stream-index":"001"}},"required":["follow","duration"],"title":"Follow Response","type":"object"},"SortParam":{"nullable":true,"properties":{"direction":{"format":"int32","type":"integer","x-stream-index":"002"},"field":{"type":"string","x-stream-index":"001"}},"type":"object"},"SortParamRequest":{"nullable":true,"properties":{"direction":{"description":"Direction of sorting, 1 for Ascending, -1 for Descending, default is 1","format":"int32","title":"Direction","type":"integer","x-stream-index":"002"},"field":{"description":"Name of field to sort by","title":"Field","type":"string","x-stream-index":"001"}},"type":"object"},"StoriesConfig":{"properties":{"expiration_behaviour":{"description":"Behavior when stories expire","title":"Expiration Behavior","type":"string","x-stream-index":"001"},"skip_watched":{"description":"Whether to skip already watched stories","title":"Skip Watched","type":"boolean","x-stream-index":"002"}},"title":"Stories Configuration","type":"object"},"SubmitActionRequest":{"nullable":true,"properties":{"action_type":{"description":"Type of moderation action to perform (mark_reviewed, delete_message, etc.)","enum":["mark_reviewed","delete_message","delete_activity","delete_reaction","ban","custom","unban","restore","delete_user","unblock","shadow_block","unmask","kick_user","end_call"],"title":"Action Type","type":"string","x-stream-index":"002"},"ban":{"$ref":"#/components/schemas/BanActionRequest","description":"Configuration for ban action","title":"Ban","x-stream-index":"008"},"custom":{"$ref":"#/components/schemas/CustomActionRequest","description":"Configuration for custom action","title":"Custom","x-stream-index":"009"},"delete_activity":{"$ref":"#/components/schemas/DeleteActivityRequest","description":"Configuration for activity deletion action","title":"Delete Activity","x-stream-index":"004"},"delete_message":{"$ref":"#/components/schemas/DeleteMessageRequest","description":"Configuration for message deletion action","title":"Delete Message","x-stream-index":"003"},"delete_reaction":{"$ref":"#/components/schemas/DeleteReactionRequest","description":"Configuration for reaction deletion action","title":"Delete Reaction","x-stream-index":"005"},"delete_user":{"$ref":"#/components/schemas/DeleteUserRequest","description":"Configuration for user deletion action","title":"Delete User","x-stream-index":"006"},"item_id":{"description":"UUID of the review queue item to act on","title":"Item ID","type":"string","x-stream-index":"001"},"mark_reviewed":{"$ref":"#/components/schemas/MarkReviewedRequest","description":"Configuration for marking item as reviewed","title":"Mark Reviewed","x-stream-index":"007"},"unban":{"$ref":"#/components/schemas/UnbanActionRequest","description":"Configuration for unban action","title":"Unban","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"016.002"},"user_id":{"type":"string","x-stream-index":"016.001"}},"required":["item_id","action_type"],"type":"object"},"SubmitActionResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"Updated review queue item after action was performed","title":"Item","x-stream-index":"001"}},"required":["duration"],"type":"object"},"TargetResolution":{"properties":{"bitrate":{"format":"int32","maximum":6000000,"type":"integer","x-stream-index":"003"},"height":{"format":"int32","maximum":3840,"minimum":240,"type":"integer","x-stream-index":"002"},"width":{"format":"int32","maximum":3840,"minimum":240,"type":"integer","x-stream-index":"001"}},"required":["width","height","bitrate"],"type":"object"},"TextContentParameters":{"properties":{"blocklist_match":{"items":{"type":"string"},"type":"array","x-stream-index":"005"},"contains_url":{"type":"boolean","x-stream-index":"003"},"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001"},"llm_harm_labels":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"002"},"severity":{"type":"string","x-stream-index":"004"}},"type":"object"},"TextRuleParameters":{"properties":{"blocklist_match":{"items":{"type":"string"},"type":"array","x-stream-index":"007"},"contains_url":{"type":"boolean","x-stream-index":"005"},"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"llm_harm_labels":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"004"},"severity":{"type":"string","x-stream-index":"006"},"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"type":"object"},"ThreadedCommentResponse":{"description":"A comment with an optional, depth‑limited slice of nested replies.","properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"001.011"},"confidence_score":{"format":"float","type":"number","x-stream-index":"001.022"},"controversy_score":{"format":"float","type":"number","x-stream-index":"001.023"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.014"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.006"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.016"},"downvote_count":{"format":"int32","type":"integer","x-stream-index":"001.020"},"id":{"type":"string","x-stream-index":"001.001"},"latest_reactions":{"items":{"$ref":"#/components/schemas/FeedsReactionResponse"},"type":"array","x-stream-index":"001.009"},"mentioned_users":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"001.012"},"meta":{"$ref":"#/components/schemas/RepliesMeta","description":"Pagination \u0026 depth info for this node's direct replies.","title":"Replies Meta","x-stream-index":"002"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"001.017"},"object_id":{"type":"string","x-stream-index":"001.002"},"object_type":{"type":"string","x-stream-index":"001.003"},"own_reactions":{"items":{"$ref":"#/components/schemas/FeedsReactionResponse"},"type":"array","x-stream-index":"001.024"},"parent_id":{"type":"string","x-stream-index":"001.007"},"reaction_count":{"format":"int32","type":"integer","x-stream-index":"001.008"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"001.010"},"replies":{"description":"Slice of nested comments (may be empty).","items":{"$ref":"#/components/schemas/ThreadedCommentResponse"},"title":"Replies","type":"array","x-stream-index":"003"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"001.018"},"score":{"format":"int32","type":"integer","x-stream-index":"001.021"},"status":{"type":"string","x-stream-index":"001.013"},"text":{"type":"string","x-stream-index":"001.005"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.015"},"upvote_count":{"format":"int32","type":"integer","x-stream-index":"001.019"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001.004"}},"required":["id","object_id","object_type","user","reaction_count","mentioned_users","status","created_at","updated_at","reply_count","upvote_count","downvote_count","score","confidence_score","own_reactions"],"title":"Threaded Comment","type":"object"},"Thresholds":{"description":"Sets thresholds for AI moderation","properties":{"explicit":{"$ref":"#/components/schemas/LabelThresholds","description":"Thresholds for explicit messages","title":"LabelThresholds","x-stream-index":"001"},"spam":{"$ref":"#/components/schemas/LabelThresholds","description":"Thresholds for spam","title":"LabelThresholds","x-stream-index":"002"},"toxic":{"$ref":"#/components/schemas/LabelThresholds","description":"Thresholds for toxic messages","title":"LabelThresholds","x-stream-index":"003"}},"title":"Auto moderation thresholds","type":"object"},"ThumbnailResponse":{"properties":{"image_url":{"type":"string","x-stream-index":"001"}},"required":["image_url"],"type":"object"},"ThumbnailsSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"ThumbnailsSettingsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"Time":{"type":"object"},"TranscriptionSettings":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"title":"Mode","type":"string","x-stream-index":"002"},"language":{"description":"The language used in this call as a two letter code","enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"title":"Language","type":"string","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"title":"Mode","type":"string","x-stream-index":"001"}},"required":["mode","closed_caption_mode","languages","language"],"type":"object"},"TranscriptionSettingsResponse":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"002"},"language":{"enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"type":"string","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode","closed_caption_mode","languages","language"],"type":"object"},"TypingIndicators":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"TypingIndicatorsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"UnbanActionRequest":{"type":"object"},"UnbanRequest":{"nullable":true,"properties":{"unbanned_by":{"$ref":"#/components/schemas/UserRequest","description":"Details about the user performing the unban","title":"Unbanned By","x-stream-index":"005"},"unbanned_by_id":{"description":"ID of the user performing the unban","title":"Unbanned By ID","type":"string","x-stream-index":"004"}},"type":"object"},"UnbanResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"UnblockActionRequest":{"type":"object"},"UnblockUsersRequest":{"nullable":true,"properties":{"blocked_user_id":{"type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"required":["blocked_user_id"],"type":"object"},"UnblockUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"UnfollowBatchRequest":{"nullable":true,"properties":{"follows":{"description":"List of follow relationships to remove","items":{"$ref":"#/components/schemas/FollowPair"},"maximum":100,"minimum":1,"title":"Follows","type":"array","x-stream-index":"001"}},"required":["follows"],"title":"Unfollow Batch Request","type":"object"},"UnfollowBatchResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"follows":{"description":"List of follow relationships that were removed","items":{"$ref":"#/components/schemas/FollowResponse"},"title":"Follows","type":"array","x-stream-index":"001"}},"required":["follows","duration"],"title":"Unfollow Batch Response","type":"object"},"UnfollowResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"follow":{"$ref":"#/components/schemas/FollowResponse","description":"The deleted follow relationship","title":"Follow","x-stream-index":"001"}},"required":["follow","duration"],"title":"Unfollow Response","type":"object"},"UnmuteRequest":{"nullable":true,"properties":{"target_ids":{"description":"User IDs to unmute","items":{"type":"string"},"title":"Target IDs","type":"array","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"002.002"},"user_id":{"type":"string","x-stream-index":"002.001"}},"required":["target_ids"],"title":"UnmuteRequest","type":"object"},"UnmuteResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"non_existing_users":{"description":"A list of users that can't be found. Common cause for this is deleted users","items":{"type":"string"},"title":"Non Existing Users","type":"array","x-stream-index":"001"}},"required":["duration"],"title":"UnmuteResponse","type":"object"},"UnpinActivityResponse":{"nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","description":"The unpinned activity","title":"Activity","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"004.001"},"feed":{"description":"Fully qualified ID of the feed the activity was unpinned from","title":"Feed ID","type":"string","x-stream-index":"002"},"user_id":{"description":"ID of the user who unpinned the activity","title":"User ID","type":"string","x-stream-index":"003"}},"required":["activity","feed","user_id","duration"],"title":"Unpin Activity Response","type":"object"},"UpdateActivityPartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"description":"Map of dot-notation field paths to new values","title":"object","type":"object","x-stream-index":"002"},"unset":{"description":"List of dot-notation paths to remove","items":{"type":"string"},"title":"[]string","type":"array","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"005.002"},"user_id":{"type":"string","x-stream-index":"005.001"}},"type":"object"},"UpdateActivityPartialResponse":{"nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","description":"The updated activity","title":"ActivityResponse","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["activity","duration"],"type":"object"},"UpdateActivityRequest":{"nullable":true,"properties":{"attachments":{"description":"List of attachments for the activity","items":{"$ref":"#/components/schemas/Attachment"},"title":"[]ActivityAttachment","type":"array","x-stream-index":"003"},"custom":{"additionalProperties":{},"description":"Custom data for the activity","title":"object","type":"object","x-stream-index":"004"},"expires_at":{"description":"Time when the activity will expire","format":"date-time","title":"string","type":"number","x-stream-index":"007"},"filter_tags":{"description":"Tags used for filtering the activity","items":{"type":"string"},"title":"[]string","type":"array","x-stream-index":"008"},"interest_tags":{"description":"Tags indicating interest categories","items":{"type":"string"},"title":"[]string","type":"array","x-stream-index":"009"},"location":{"$ref":"#/components/schemas/ActivityLocation","description":"Geographic location for the activity","title":"ActivityLocation","x-stream-index":"006"},"poll_id":{"description":"Poll ID","title":"string","type":"string","x-stream-index":"010"},"text":{"description":"The text content of the activity","title":"string","type":"string","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"012.002"},"user_id":{"type":"string","x-stream-index":"012.001"},"visibility":{"description":"Visibility setting for the activity","title":"string","type":"string","x-stream-index":"005"}},"type":"object"},"UpdateActivityResponse":{"nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","description":"The updated activity","title":"ActivityResponse","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["activity","duration"],"type":"object"},"UpdateAppRequest":{"nullable":true,"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.017"},"apn_config":{"$ref":"#/components/schemas/APNConfig","x-stream-index":"001.003"},"async_moderation_config":{"$ref":"#/components/schemas/AsyncModerationConfiguration","x-stream-index":"001.039"},"async_url_enrich_enabled":{"type":"boolean","x-stream-index":"001.019"},"auto_translation_enabled":{"type":"boolean","x-stream-index":"001.018"},"before_message_send_hook_url":{"type":"string","x-stream-index":"001.020"},"cdn_expiration_seconds":{"format":"int32","maximum":1209600,"minimum":14400,"type":"integer","x-stream-index":"001.038"},"channel_hide_members_only":{"type":"boolean","x-stream-index":"001.033"},"custom_action_handler_url":{"type":"string","x-stream-index":"001.021"},"datadog_info":{"$ref":"#/components/schemas/DataDogInfo","x-stream-index":"001.040"},"disable_auth_checks":{"type":"boolean","x-stream-index":"001.001"},"disable_permissions_checks":{"type":"boolean","x-stream-index":"001.002"},"enforce_unique_usernames":{"enum":["no","app","team"],"type":"string","x-stream-index":"001.022"},"event_hooks":{"items":{"$ref":"#/components/schemas/EventHook"},"type":"array","x-stream-index":"001.046"},"feeds_moderation_enabled":{"type":"boolean","x-stream-index":"001.042"},"feeds_v2_region":{"type":"string","x-stream-index":"001.041"},"file_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","x-stream-index":"001.030"},"firebase_config":{"$ref":"#/components/schemas/FirebaseConfig","x-stream-index":"001.004"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"001.034"},"guest_user_creation_disabled":{"type":"boolean","x-stream-index":"001.043"},"huawei_config":{"$ref":"#/components/schemas/HuaweiConfig","x-stream-index":"001.005"},"image_moderation_block_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001.015"},"image_moderation_enabled":{"type":"boolean","x-stream-index":"001.016"},"image_moderation_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001.014"},"image_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","x-stream-index":"001.029"},"max_aggregated_activities_length":{"format":"int32","type":"integer","x-stream-index":"001.049"},"migrate_permissions_to_v2":{"type":"boolean","x-stream-index":"001.035"},"moderation_dashboard_preferences":{"$ref":"#/components/schemas/ModerationDashboardPreferences","x-stream-index":"001.044"},"moderation_enabled":{"type":"boolean","x-stream-index":"001.009"},"moderation_webhook_url":{"type":"string","x-stream-index":"001.010"},"multi_tenant_enabled":{"type":"boolean","x-stream-index":"001.013"},"permission_version":{"enum":["v1","v2"],"type":"string","x-stream-index":"001.011"},"push_config":{"$ref":"#/components/schemas/PushConfig","x-stream-index":"001.007"},"reminders_interval":{"format":"int32","maximum":86400,"minimum":60,"type":"integer","x-stream-index":"001.036"},"reminders_max_members":{"format":"int32","minimum":2,"type":"integer","x-stream-index":"001.037"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.031"},"sns_key":{"type":"string","x-stream-index":"001.027"},"sns_secret":{"type":"string","x-stream-index":"001.028"},"sns_topic_arn":{"type":"string","x-stream-index":"001.026"},"sqs_key":{"type":"string","x-stream-index":"001.024"},"sqs_secret":{"type":"string","x-stream-index":"001.025"},"sqs_url":{"type":"string","x-stream-index":"001.023"},"user_response_time_enabled":{"type":"boolean","x-stream-index":"001.048"},"user_search_disallowed_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"001.012"},"webhook_events":{"items":{"type":"string"},"type":"array","x-stream-index":"001.032"},"webhook_url":{"type":"string","x-stream-index":"001.008"},"xiaomi_config":{"$ref":"#/components/schemas/XiaomiConfig","x-stream-index":"001.006"}},"type":"object"},"UpdateBlockListRequest":{"nullable":true,"properties":{"team":{"type":"string","x-stream-index":"002"},"words":{"description":"List of words to block","items":{"type":"string"},"minimum":1,"title":"Words","type":"array","x-stream-index":"003"}},"title":"Update block list","type":"object","x-stream-docs-page-id":"update_block_list"},"UpdateBlockListResponse":{"description":"Basic response information","nullable":true,"properties":{"blocklist":{"$ref":"#/components/schemas/BlockListResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["duration"],"title":"Response","type":"object"},"UpdateBookmarkFolderRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"description":"Custom data for the folder","title":"Custom Data","type":"object","x-stream-index":"003"},"name":{"description":"Name of the folder","maxLength":255,"title":"Name","type":"string","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"title":"Update Bookmark Folder Request","type":"object"},"UpdateBookmarkFolderResponse":{"nullable":true,"properties":{"bookmark_folder":{"$ref":"#/components/schemas/BookmarkFolderResponse","description":"The updated bookmark folder","title":"Bookmark Folder","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["bookmark_folder","duration"],"title":"Update Bookmark Folder Response","type":"object"},"UpdateBookmarkRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"description":"Custom data for the bookmark","title":"Custom Data","type":"object","x-stream-index":"005"},"folder_id":{"description":"ID of the folder to move the bookmark to","maxLength":255,"title":"Folder ID","type":"string","x-stream-index":"002"},"new_folder":{"$ref":"#/components/schemas/AddFolderRequest","x-stream-index":"004"},"new_folder_id":{"maxLength":255,"type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"006.002"},"user_id":{"type":"string","x-stream-index":"006.001"}},"title":"Update Bookmark Request","type":"object"},"UpdateBookmarkResponse":{"nullable":true,"properties":{"bookmark":{"$ref":"#/components/schemas/BookmarkResponse","description":"The updated bookmark","title":"Bookmark","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["bookmark","duration"],"title":"Update Bookmark Response","type":"object"},"UpdateCommentRequest":{"nullable":true,"properties":{"comment":{"description":"Updated text content of the comment","title":"Comment","type":"string","x-stream-index":"002"},"custom":{"additionalProperties":{},"description":"Updated custom data for the comment","title":"Custom Data","type":"object","x-stream-index":"003"},"skip_push":{"type":"boolean","x-stream-index":"004"}},"title":"Update Comment Request","type":"object"},"UpdateCommentResponse":{"nullable":true,"properties":{"comment":{"$ref":"#/components/schemas/CommentResponse","description":"The updated comment","title":"Comment","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["comment","duration"],"title":"Update Comment Response","type":"object"},"UpdateExternalStorageRequest":{"description":"External storage","nullable":true,"properties":{"aws_s3":{"$ref":"#/components/schemas/S3Request","description":"Only required if you want to create an Amazon S3 storage","title":"AwsS3","x-stream-index":"003.004"},"azure_blob":{"$ref":"#/components/schemas/AzureRequest","description":"Only required if you want to create an Azure Blob Storage","title":"AzureBlob","x-stream-index":"003.006"},"bucket":{"description":"The name of the bucket on the service provider","title":"Bucket","type":"string","x-stream-index":"003.002"},"gcs_credentials":{"type":"string","x-stream-index":"003.005"},"path":{"description":"The path prefix to use for storing files","title":"Path","type":"string","x-stream-index":"003.003"},"storage_type":{"description":"The type of storage to use","enum":["s3","gcs","abs"],"title":"StorageType","type":"string","x-stream-index":"003.001"}},"required":["storage_type","bucket"],"title":"ExternalStorageRequest","type":"object"},"UpdateExternalStorageResponse":{"description":"Basic response information","nullable":true,"properties":{"bucket":{"type":"string","x-stream-index":"001.003"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"name":{"type":"string","x-stream-index":"001.001"},"path":{"type":"string","x-stream-index":"001.004"},"type":{"enum":["s3","gcs","abs"],"type":"string","x-stream-index":"001.002"}},"required":["name","type","bucket","path","duration"],"title":"Response","type":"object"},"UpdateFeedGroupRequest":{"nullable":true,"properties":{"activity_processors":{"description":"Configuration for activity processors (max 10)","items":{"$ref":"#/components/schemas/ActivityProcessorConfig"},"maximum":10,"title":"Activity Processors","type":"array","x-stream-index":"005"},"activity_selectors":{"description":"Configuration for activity selectors (max 10)","items":{"$ref":"#/components/schemas/ActivitySelectorConfig"},"maximum":10,"title":"Activity Selectors","type":"array","x-stream-index":"006"},"aggregation":{"$ref":"#/components/schemas/AggregationConfig","description":"Configuration for activity aggregation","title":"Aggregation","x-stream-index":"008"},"custom":{"additionalProperties":{},"description":"Custom data for the feed group","title":"Custom Data","type":"object","x-stream-index":"004"},"notification":{"$ref":"#/components/schemas/NotificationConfig","description":"Configuration for notifications","title":"Notification","x-stream-index":"002"},"push_notification":{"$ref":"#/components/schemas/PushNotificationConfig","x-stream-index":"003"},"ranking":{"$ref":"#/components/schemas/RankingConfig","description":"Configuration for activity ranking","title":"Ranking","x-stream-index":"007"}},"title":"Update Feed Group Request","type":"object"},"UpdateFeedGroupResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"feed_group":{"$ref":"#/components/schemas/FeedGroupResponse","description":"The updated feed group","title":"Feed Group","x-stream-index":"001"}},"required":["feed_group","duration"],"title":"Update Feed Group Response","type":"object"},"UpdateFeedMembersRequest":{"nullable":true,"properties":{"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"006.001"},"members":{"description":"List of members to upsert, remove, or set","items":{"$ref":"#/components/schemas/FeedMemberRequest"},"title":"Members","type":"array","x-stream-index":"004"},"next":{"type":"string","x-stream-index":"006.002"},"operation":{"description":"Type of update operation to perform","enum":["upsert","remove","set"],"title":"Operation","type":"string","x-stream-index":"003"},"prev":{"type":"string","x-stream-index":"006.003"}},"required":["operation"],"title":"Update Feed Members Request","type":"object"},"UpdateFeedMembersResponse":{"description":"Basic response information","nullable":true,"properties":{"added":{"items":{"$ref":"#/components/schemas/FeedMemberResponse"},"type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"004.001"},"removed_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"updated":{"items":{"$ref":"#/components/schemas/FeedMemberResponse"},"type":"array","x-stream-index":"002"}},"required":["added","updated","removed_ids","duration"],"title":"Response","type":"object"},"UpdateFeedRequest":{"nullable":true,"properties":{"created_by_id":{"description":"ID of the new feed creator (owner)","title":"Created By ID","type":"string","x-stream-index":"003"},"custom":{"additionalProperties":{},"description":"Custom data for the feed","title":"Custom Data","type":"object","x-stream-index":"004"}},"title":"Update Feed Request","type":"object"},"UpdateFeedResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"feed":{"$ref":"#/components/schemas/FeedResponse","description":"The updated feed","title":"Feed","x-stream-index":"001"}},"required":["feed","duration"],"title":"Update Feed Response","type":"object"},"UpdateFeedViewRequest":{"nullable":true,"properties":{"activity_processors":{"description":"Updated activity processors","items":{"$ref":"#/components/schemas/ActivityProcessorConfig"},"title":"Activity Processors","type":"array","x-stream-index":"002.002"},"activity_selectors":{"description":"Updated configuration for selecting activities","items":{"$ref":"#/components/schemas/ActivitySelectorConfig"},"title":"Activity Selectors","type":"array","x-stream-index":"002.001"},"aggregation":{"$ref":"#/components/schemas/AggregationConfig","description":"Updated configuration for aggregating activities","title":"Aggregation","x-stream-index":"002.004"},"ranking":{"$ref":"#/components/schemas/RankingConfig","description":"Updated configuration for ranking activities","title":"Ranking","x-stream-index":"002.003"}},"title":"Update Feed View Request","type":"object"},"UpdateFeedViewResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"feed_view":{"$ref":"#/components/schemas/FeedViewResponse","description":"The updated feed view","title":"Feed View","x-stream-index":"001"}},"required":["feed_view","duration"],"title":"Update Feed View Response","type":"object"},"UpdateFollowRequest":{"nullable":true,"properties":{"create_notification_activity":{"description":"Whether to create a notification activity for this follow","title":"Create Notification Activity","type":"boolean","x-stream-index":"001.004"},"custom":{"additionalProperties":{},"description":"Custom data for the follow relationship","title":"Custom Data","type":"object","x-stream-index":"001.002"},"follower_role":{"type":"string","x-stream-index":"002"},"push_preference":{"description":"Push preference for the follow relationship","enum":["all","none"],"title":"Push Preference","type":"string","x-stream-index":"001.003"},"skip_push":{"type":"boolean","x-stream-index":"001.005"},"source":{"description":"Fully qualified ID of the source feed","maxLength":255,"title":"Source Feed","type":"string","x-stream-index":"001.001.001"},"target":{"description":"Fully qualified ID of the target feed","maxLength":255,"title":"Target Feed","type":"string","x-stream-index":"001.001.002"}},"required":["source","target"],"title":"Update Follow Request","type":"object"},"UpdateFollowResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"follow":{"$ref":"#/components/schemas/FollowResponse","description":"Details of the updated follow relationship","title":"Follow","x-stream-index":"001"}},"required":["follow","duration"],"title":"Update Follow Response","type":"object"},"UpdateLiveLocationRequest":{"nullable":true,"properties":{"end_at":{"description":"Time when the live location expires","format":"date-time","title":"string","type":"number","x-stream-index":"004"},"latitude":{"description":"Latitude coordinate","format":"float","maximum":90,"minimum":18446744073709552000,"title":"number","type":"number","x-stream-index":"002"},"longitude":{"description":"Longitude coordinate","format":"float","maximum":180,"minimum":18446744073709552000,"title":"number","type":"number","x-stream-index":"003"},"message_id":{"description":"Live location ID","title":"string","type":"string","x-stream-index":"001"}},"required":["message_id"],"type":"object"},"UpdateMembershipLevelRequest":{"description":"Partial update request for membership level fields. Only specified fields will be updated.","nullable":true,"properties":{"custom":{"additionalProperties":{},"description":"Custom data for the membership level","title":"Custom Data","type":"object","x-stream-index":"006"},"description":{"description":"Optional description of the membership level","maxLength":1000,"title":"Description","type":"string","x-stream-index":"003"},"name":{"description":"Display name for the membership level","maxLength":255,"title":"Name","type":"string","x-stream-index":"002"},"priority":{"description":"Priority level (higher numbers = higher priority)","format":"int32","minimum":0,"title":"Priority","type":"integer","x-stream-index":"004"},"tags":{"description":"Activity tags this membership level gives access to","items":{"type":"string"},"maximum":255,"title":"Tags","type":"array","x-stream-index":"005"}},"title":"Update Membership Level Request","type":"object"},"UpdateMembershipLevelResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"membership_level":{"$ref":"#/components/schemas/MembershipLevelResponse","description":"The updated membership level","title":"Membership Level","x-stream-index":"001"}},"required":["membership_level","duration"],"title":"Update Membership Level Response","type":"object"},"UpdatePollOptionRequest":{"nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"004"},"id":{"description":"Option ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"},"text":{"description":"Option text","title":"string","type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"005.002"},"user_id":{"type":"string","x-stream-index":"005.001"}},"required":["id","text"],"type":"object"},"UpdatePollPartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"description":"Sets new field values","title":"Set","type":"object","x-stream-index":"002.001","x-stream-map":{"key":"field","title":"Value","description":"New value to set"}},"unset":{"description":"Array of field names to unset","items":{"type":"string"},"title":"Unset","type":"array","x-stream-index":"002.002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"type":"object"},"UpdatePollRequest":{"nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"011"},"allow_answers":{"description":"Allow answers","title":"boolean","type":"boolean","x-stream-index":"009"},"allow_user_suggested_options":{"description":"Allow user suggested options","title":"boolean","type":"boolean","x-stream-index":"008"},"description":{"description":"Poll description","title":"string","type":"string","x-stream-index":"003"},"enforce_unique_vote":{"description":"Enforce unique vote","title":"boolean","type":"boolean","x-stream-index":"005"},"id":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"},"is_closed":{"description":"Is closed","title":"boolean","type":"boolean","x-stream-index":"010"},"max_votes_allowed":{"description":"Max votes allowed","format":"int32","maximum":10,"title":"integer","type":"integer","x-stream-index":"007"},"name":{"description":"Poll name","title":"string","type":"string","x-stream-index":"002"},"options":{"description":"Poll options","items":{"$ref":"#/components/schemas/PollOptionRequest"},"maximum":100,"title":"PollOptions","type":"array","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"012.002"},"user_id":{"type":"string","x-stream-index":"012.001"},"voting_visibility":{"description":"Voting visibility","enum":["anonymous","public"],"title":"string","type":"string","x-stream-index":"006"}},"required":["id","name"],"type":"object"},"UpdateUserPartialRequest":{"properties":{"id":{"description":"User ID to update","title":"ID","type":"string","x-stream-index":"001"},"set":{"additionalProperties":{},"type":"object","x-stream-index":"002.001"},"unset":{"items":{"type":"string"},"type":"array","x-stream-index":"002.002"}},"required":["id"],"type":"object"},"UpdateUsersPartialRequest":{"nullable":true,"properties":{"users":{"items":{"$ref":"#/components/schemas/UpdateUserPartialRequest"},"maximum":100,"type":"array","x-stream-index":"001"}},"required":["users"],"type":"object"},"UpdateUsersRequest":{"nullable":true,"properties":{"users":{"additionalProperties":{"$ref":"#/components/schemas/UserRequest"},"description":"Object containing users","title":"Users","type":"object","x-stream-index":"001","x-stream-map":{"key":"user_id"}}},"required":["users"],"type":"object"},"UpdateUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"membership_deletion_task_id":{"type":"string","x-stream-index":"002"},"users":{"additionalProperties":{"$ref":"#/components/schemas/FullUserResponse"},"description":"Object containing users","title":"Users","type":"object","x-stream-index":"001","x-stream-map":{"key":"user_id"}}},"required":["users","membership_deletion_task_id","duration"],"type":"object"},"UpsertActivitiesRequest":{"nullable":true,"properties":{"activities":{"description":"List of activities to create or update","items":{"$ref":"#/components/schemas/ActivityRequest"},"maximum":100,"minimum":1,"title":"Activities","type":"array","x-stream-index":"001"}},"required":["activities"],"title":"Upsert Activities Request","type":"object"},"UpsertActivitiesResponse":{"nullable":true,"properties":{"activities":{"description":"List of created or updated activities","items":{"$ref":"#/components/schemas/ActivityResponse"},"title":"Activities","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["activities","duration"],"title":"Upsert Activities Response","type":"object"},"UpsertConfigRequest":{"nullable":true,"properties":{"ai_image_config":{"$ref":"#/components/schemas/AIImageConfig","description":"Configuration for AI image analysis","title":"AI Image Config","x-stream-index":"011"},"ai_text_config":{"$ref":"#/components/schemas/AITextConfig","description":"Configuration for AI text analysis","title":"AI Text Config","x-stream-index":"008"},"ai_video_config":{"$ref":"#/components/schemas/AIVideoConfig","description":"Configuration for AI video analysis","title":"AI Video Config","x-stream-index":"012"},"async":{"description":"Whether moderation should be performed asynchronously","title":"Async","type":"boolean","x-stream-index":"003"},"automod_platform_circumvention_config":{"$ref":"#/components/schemas/AutomodPlatformCircumventionConfig","description":"Configuration for platform circumvention detection","title":"Automod Platform Circumvention Config","x-stream-index":"005"},"automod_semantic_filters_config":{"$ref":"#/components/schemas/AutomodSemanticFiltersConfig","description":"Configuration for semantic filtering","title":"Automod Semantic Filters Config","x-stream-index":"006"},"automod_toxicity_config":{"$ref":"#/components/schemas/AutomodToxicityConfig","description":"Configuration for toxicity detection","title":"Automod Toxicity Config","x-stream-index":"004"},"aws_rekognition_config":{"$ref":"#/components/schemas/AIImageConfig","x-stream-index":"016"},"block_list_config":{"$ref":"#/components/schemas/BlockListConfig","description":"Configuration for block list filtering","title":"Block List Config","x-stream-index":"007"},"bodyguard_config":{"$ref":"#/components/schemas/AITextConfig","x-stream-index":"015"},"google_vision_config":{"$ref":"#/components/schemas/GoogleVisionConfig","description":"Configuration for Google Vision integration","title":"Google Vision Config","x-stream-index":"010"},"key":{"description":"Unique identifier for the moderation configuration","title":"Key","type":"string","x-stream-index":"001"},"llm_config":{"$ref":"#/components/schemas/LLMConfig","description":"Configuration for customer-configured LLM moderation","title":"LLM Config","x-stream-index":"009"},"rule_builder_config":{"$ref":"#/components/schemas/RuleBuilderConfig","description":"Configuration for custom rule builder (max 3 rules, max 5 conditions per rule)","title":"Rule Builder Config","x-stream-index":"014"},"team":{"description":"Team associated with the configuration","maxLength":128,"minLength":1,"title":"Team","type":"string","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"018.002"},"user_id":{"type":"string","x-stream-index":"018.001"},"velocity_filter_config":{"$ref":"#/components/schemas/VelocityFilterConfig","description":"Configuration for velocity-based filtering","title":"Velocity Filter Config","x-stream-index":"013"},"video_call_rule_config":{"$ref":"#/components/schemas/VideoCallRuleConfig","x-stream-index":"017"}},"required":["key"],"type":"object"},"UpsertConfigResponse":{"nullable":true,"properties":{"config":{"$ref":"#/components/schemas/ConfigResponse","description":"The created or updated moderation configuration","title":"Config","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["duration"],"type":"object"},"UpsertModerationRuleRequest":{"nullable":true,"properties":{"action":{"$ref":"#/components/schemas/RuleBuilderAction","x-stream-index":"009"},"conditions":{"items":{"$ref":"#/components/schemas/RuleBuilderCondition"},"type":"array","x-stream-index":"006"},"config_keys":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"cooldown_period":{"type":"string","x-stream-index":"010"},"description":{"type":"string","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"011"},"groups":{"items":{"$ref":"#/components/schemas/RuleBuilderConditionGroup"},"type":"array","x-stream-index":"008"},"logic":{"type":"string","x-stream-index":"007"},"name":{"type":"string","x-stream-index":"001"},"rule_type":{"type":"string","x-stream-index":"005"},"team":{"type":"string","x-stream-index":"004"}},"required":["name","rule_type","action"],"type":"object"},"UpsertModerationRuleResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"rule":{"$ref":"#/components/schemas/ModerationRuleV2Response","x-stream-index":"002"}},"required":["duration"],"title":"Response","type":"object"},"UpsertModerationTemplateRequest":{"nullable":true,"properties":{"config":{"$ref":"#/components/schemas/FeedsModerationTemplateConfig","description":"Configuration for the moderation template","title":"Config","x-stream-index":"002"},"name":{"description":"Name of the moderation template","title":"Name","type":"string","x-stream-index":"001"}},"required":["name","config"],"type":"object"},"UpsertModerationTemplateResponse":{"nullable":true,"properties":{"config":{"$ref":"#/components/schemas/FeedsModerationTemplateConfig","description":"Configuration for the moderation template","title":"Config","x-stream-index":"002"},"created_at":{"description":"When the template was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"003"},"duration":{"type":"string","x-stream-index":"005.001"},"name":{"description":"Name of the moderation template","title":"Name","type":"string","x-stream-index":"001"},"updated_at":{"description":"When the template was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"004"}},"required":["name","created_at","updated_at","duration"],"type":"object"},"UpsertPushProviderRequest":{"nullable":true,"properties":{"push_provider":{"$ref":"#/components/schemas/PushProvider","x-stream-index":"001"}},"type":"object"},"UpsertPushProviderResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"push_provider":{"$ref":"#/components/schemas/PushProviderResponse","x-stream-index":"001"}},"required":["push_provider","duration"],"title":"Response","type":"object"},"User":{"properties":{"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"046"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"017"},"banned":{"type":"boolean","x-stream-index":"016"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"013"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"023"},"language":{"type":"string","x-stream-index":"035"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"026"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"042"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"005"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"009"}},"required":["id","role","teams_role","custom","banned","online"],"type":"object"},"UserBannedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"006.002"},"channel_type":{"type":"string","x-stream-index":"006.003"},"cid":{"type":"string","x-stream-index":"006.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008.002"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"001"},"expiration":{"format":"date-time","type":"number","x-stream-index":"003"},"reason":{"type":"string","x-stream-index":"004"},"shadow":{"type":"boolean","x-stream-index":"002"},"team":{"type":"string","x-stream-index":"005.001"},"type":{"default":"user.banned","type":"string","x-stream-index":"008.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007.001"}},"required":["created_by","shadow","cid","channel_id","channel_type","type","created_at"],"title":"UserBannedEvent","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"},"UserCreatedWithinParameters":{"properties":{"max_age":{"type":"string","x-stream-index":"001"}},"type":"object"},"UserCustomPropertyParameters":{"properties":{"operator":{"type":"string","x-stream-index":"002"},"property_key":{"type":"string","x-stream-index":"001"}},"type":"object"},"UserDeactivatedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"001"},"type":{"default":"user.deactivated","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["created_by","type","created_at"],"title":"UserDeactivatedEvent","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"},"UserMute":{"nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"expires":{"description":"Date/time of mute expiration","format":"date-time","title":"Expires","type":"number","x-stream-index":"008"},"target":{"$ref":"#/components/schemas/User","description":"User who's muted","title":"Target","x-stream-index":"007"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/User","description":"Owner of channel mute","title":"User","x-stream-index":"005"}},"required":["created_at","updated_at"],"type":"object"},"UserMuteResponse":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"expires":{"format":"date-time","type":"number","x-stream-index":"003"},"target":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"}},"required":["created_at","updated_at"],"type":"object"},"UserMutedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"target_user":{"type":"string","x-stream-index":"001"},"target_users":{"items":{"type":"string"},"type":"array","x-stream-index":"002"},"type":{"default":"user.muted","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"UserMutedEvent","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"},"UserReactivatedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"type":{"default":"user.reactivated","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"001"}},"required":["type","created_at"],"title":"UserReactivatedEvent","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"},"UserRequest":{"description":"User request object","properties":{"custom":{"additionalProperties":{},"description":"Custom user data","title":"Custom","type":"object","x-stream-index":"004"},"id":{"description":"User ID","title":"ID","type":"string","x-stream-index":"001"},"image":{"description":"User's profile image URL","title":"Image","type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"006"},"language":{"type":"string","x-stream-index":"005"},"name":{"description":"Optional name of user","title":"Name","type":"string","x-stream-index":"002"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"007"},"role":{"description":"User's global role","title":"Role","type":"string","x-stream-index":"008"},"teams":{"description":"List of teams the user belongs to","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"010"},"teams_role":{"additionalProperties":{"type":"string"},"description":"Map of team-specific roles for the user","title":"TeamsRole","type":"object","x-stream-index":"009"}},"required":["id"],"title":"UserRequest","type":"object"},"UserResponse":{"description":"User response object","properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"ban_expires":{"description":"Date when ban expires","format":"date-time","title":"Ban expires","type":"number","x-stream-index":"003"},"banned":{"description":"Whether a user is banned or not","title":"Banned","type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.017"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"001.004"},"deactivated_at":{"description":"Date of deactivation","format":"date-time","title":"Deactivated at","type":"number","x-stream-index":"001.016"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"001.011"},"devices":{"description":"List of devices user is using","items":{"$ref":"#/components/schemas/DeviceResponse"},"title":"Devices","type":"array","x-stream-index":"006"},"id":{"description":"Unique user identifier","title":"ID","type":"string","x-stream-index":"001.001"},"image":{"title":"Image","type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"007"},"language":{"description":"Preferred language of a user","title":"Language","type":"string","x-stream-index":"001.005"},"last_active":{"description":"Date of last activity","format":"date-time","title":"Last active","type":"number","x-stream-index":"001.014"},"name":{"description":"Optional name of user","title":"Name","type":"string","x-stream-index":"001.002"},"online":{"description":"Whether a user online or not","title":"Online","type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","description":"User privacy settings","title":"Privacy settings","x-stream-index":"005"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettingsResponse","description":"User push notification settings","title":"Push notifications","x-stream-index":"004"},"revoke_tokens_issued_before":{"description":"Revocation date for tokens","format":"date-time","title":"Revoke tokens issued before","type":"number","x-stream-index":"001.015"},"role":{"description":"Determines the set of user permissions","title":"Role","type":"string","x-stream-index":"001.006"},"shadow_banned":{"description":"Whether a user is shadow banned","title":"Shadow banned","type":"boolean","x-stream-index":"002"},"teams":{"description":"List of teams user is a part of","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids","shadow_banned","invisible"],"title":"UserResponse","type":"object"},"UserResponseCommonFields":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"018"},"banned":{"type":"boolean","x-stream-index":"012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"017"},"created_at":{"format":"date-time","type":"number","x-stream-index":"009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"id":{"type":"string","x-stream-index":"001"},"image":{"type":"string","x-stream-index":"003"},"language":{"type":"string","x-stream-index":"005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"014"},"name":{"type":"string","x-stream-index":"002"},"online":{"type":"boolean","x-stream-index":"013"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"015"},"role":{"type":"string","x-stream-index":"006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids"],"type":"object"},"UserResponsePrivacyFields":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"banned":{"type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.017"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.011"},"id":{"type":"string","x-stream-index":"001.001"},"image":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"003"},"language":{"type":"string","x-stream-index":"001.005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"001.014"},"name":{"type":"string","x-stream-index":"001.002"},"online":{"type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"002"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.015"},"role":{"type":"string","x-stream-index":"001.006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids"],"type":"object"},"UserRuleParameters":{"properties":{"max_age":{"type":"string","x-stream-index":"001"}},"type":"object"},"UserUpdatedEvent":{"description":"This event is sent when a user gets updated. The event contains information about the updated user.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"type":{"default":"user.updated","description":"The type of event: \"user.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.002"},"user":{"$ref":"#/components/schemas/UserResponsePrivacyFields","description":"The updated user","title":"User","x-stream-index":"002.001"}},"required":["type","created_at","custom","user"],"title":"UserUpdatedEvent","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"},"VelocityFilterConfig":{"properties":{"advanced_filters":{"type":"boolean","x-stream-index":"007"},"async":{"type":"boolean","x-stream-index":"001"},"cascading_actions":{"type":"boolean","x-stream-index":"004"},"cids_per_user":{"format":"int32","type":"integer","x-stream-index":"006"},"enabled":{"type":"boolean","x-stream-index":"002"},"first_message_only":{"type":"boolean","x-stream-index":"005"},"rules":{"items":{"$ref":"#/components/schemas/VelocityFilterConfigRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules","cascading_actions","first_message_only","cids_per_user","advanced_filters"],"type":"object"},"VelocityFilterConfigRule":{"properties":{"action":{"enum":["flag","shadow","remove","ban"],"type":"string","x-stream-index":"001"},"ban_duration":{"format":"int32","type":"integer","x-stream-index":"002"},"cascading_action":{"enum":["flag","shadow","remove","ban"],"type":"string","x-stream-index":"006"},"cascading_threshold":{"format":"int64","type":"integer","x-stream-index":"005"},"check_message_context":{"type":"boolean","x-stream-index":"009"},"fast_spam_threshold":{"format":"int32","type":"integer","x-stream-index":"007"},"fast_spam_ttl":{"format":"int32","type":"integer","x-stream-index":"010"},"ip_ban":{"type":"boolean","x-stream-index":"004"},"probation_period":{"format":"int32","type":"integer","x-stream-index":"014"},"shadow_ban":{"type":"boolean","x-stream-index":"003"},"slow_spam_ban_duration":{"format":"int32","type":"integer","x-stream-index":"012"},"slow_spam_threshold":{"format":"int32","type":"integer","x-stream-index":"008"},"slow_spam_ttl":{"format":"int32","type":"integer","x-stream-index":"011"},"url_only":{"type":"boolean","x-stream-index":"013"}},"required":["action","ban_duration","shadow_ban","ip_ban","cascading_threshold","cascading_action","fast_spam_threshold","slow_spam_threshold","check_message_context","fast_spam_ttl","slow_spam_ttl","url_only","probation_period"],"type":"object"},"VideoCallRuleConfig":{"properties":{"rules":{"additionalProperties":{"$ref":"#/components/schemas/HarmConfig"},"type":"object","x-stream-index":"001"}},"required":["rules"],"type":"object"},"VideoContentParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"type":"object"},"VideoEndCallRequest":{"type":"object"},"VideoKickUserRequest":{"type":"object"},"VideoOrientation":{"properties":{"orientation":{"type":"integer","x-stream-index":"004"}},"type":"object"},"VideoRuleParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"type":"object"},"VideoSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"camera_default_on":{"type":"boolean","x-stream-index":"004"},"camera_facing":{"enum":["front","back","external"],"type":"string","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled","target_resolution","camera_default_on","camera_facing"],"type":"object"},"VideoSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"camera_default_on":{"type":"boolean","x-stream-index":"004"},"camera_facing":{"enum":["front","back","external"],"type":"string","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled","target_resolution","camera_default_on","camera_facing"],"type":"object"},"VoteData":{"properties":{"answer_text":{"type":"string","x-stream-index":"002"},"option_id":{"maxLength":255,"type":"string","x-stream-index":"001"}},"type":"object"},"WebhookEvent":{"description":"The discriminator object for all webhook events, it maps events' payload to the final type","discriminator":{"mapping":{"export.bulk_image_moderation.error":"#/components/schemas/AsyncExportErrorEvent","export.bulk_image_moderation.success":"#/components/schemas/AsyncBulkImageModerationEvent","export.moderation_logs.error":"#/components/schemas/AsyncExportErrorEvent","export.moderation_logs.success":"#/components/schemas/AsyncExportModerationLogsEvent","feeds.activity.added":"#/components/schemas/ActivityAddedEvent","feeds.activity.deleted":"#/components/schemas/ActivityDeletedEvent","feeds.activity.marked":"#/components/schemas/ActivityMarkEvent","feeds.activity.pinned":"#/components/schemas/ActivityPinnedEvent","feeds.activity.reaction.added":"#/components/schemas/ActivityReactionAddedEvent","feeds.activity.reaction.deleted":"#/components/schemas/ActivityReactionDeletedEvent","feeds.activity.reaction.updated":"#/components/schemas/ActivityReactionUpdatedEvent","feeds.activity.removed_from_feed":"#/components/schemas/ActivityRemovedFromFeedEvent","feeds.activity.unpinned":"#/components/schemas/ActivityUnpinnedEvent","feeds.activity.updated":"#/components/schemas/ActivityUpdatedEvent","feeds.bookmark.added":"#/components/schemas/BookmarkAddedEvent","feeds.bookmark.deleted":"#/components/schemas/BookmarkDeletedEvent","feeds.bookmark.updated":"#/components/schemas/BookmarkUpdatedEvent","feeds.bookmark_folder.deleted":"#/components/schemas/BookmarkFolderDeletedEvent","feeds.bookmark_folder.updated":"#/components/schemas/BookmarkFolderUpdatedEvent","feeds.comment.added":"#/components/schemas/CommentAddedEvent","feeds.comment.deleted":"#/components/schemas/CommentDeletedEvent","feeds.comment.reaction.added":"#/components/schemas/CommentReactionAddedEvent","feeds.comment.reaction.deleted":"#/components/schemas/CommentReactionDeletedEvent","feeds.comment.reaction.updated":"#/components/schemas/CommentReactionUpdatedEvent","feeds.comment.updated":"#/components/schemas/CommentUpdatedEvent","feeds.feed.created":"#/components/schemas/FeedCreatedEvent","feeds.feed.deleted":"#/components/schemas/FeedDeletedEvent","feeds.feed.updated":"#/components/schemas/FeedUpdatedEvent","feeds.feed_group.changed":"#/components/schemas/FeedGroupChangedEvent","feeds.feed_group.deleted":"#/components/schemas/FeedGroupDeletedEvent","feeds.feed_member.added":"#/components/schemas/FeedMemberAddedEvent","feeds.feed_member.removed":"#/components/schemas/FeedMemberRemovedEvent","feeds.feed_member.updated":"#/components/schemas/FeedMemberUpdatedEvent","feeds.follow.created":"#/components/schemas/FollowCreatedEvent","feeds.follow.deleted":"#/components/schemas/FollowDeletedEvent","feeds.follow.updated":"#/components/schemas/FollowUpdatedEvent","feeds.notification_feed.updated":"#/components/schemas/NotificationFeedUpdatedEvent","moderation.custom_action":"#/components/schemas/ModerationCustomActionEvent","moderation.flagged":"#/components/schemas/ModerationFlaggedEvent","moderation.mark_reviewed":"#/components/schemas/ModerationMarkReviewedEvent","moderation_check.completed":"#/components/schemas/ModerationCheckCompletedEvent","review_queue_item.new":"#/components/schemas/ReviewQueueItemNewEvent","review_queue_item.updated":"#/components/schemas/ReviewQueueItemUpdatedEvent","user.banned":"#/components/schemas/UserBannedEvent","user.deactivated":"#/components/schemas/UserDeactivatedEvent","user.muted":"#/components/schemas/UserMutedEvent","user.reactivated":"#/components/schemas/UserReactivatedEvent","user.updated":"#/components/schemas/UserUpdatedEvent"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/ActivityAddedEvent"},{"$ref":"#/components/schemas/ActivityDeletedEvent"},{"$ref":"#/components/schemas/ActivityMarkEvent"},{"$ref":"#/components/schemas/ActivityPinnedEvent"},{"$ref":"#/components/schemas/ActivityReactionAddedEvent"},{"$ref":"#/components/schemas/ActivityReactionDeletedEvent"},{"$ref":"#/components/schemas/ActivityReactionUpdatedEvent"},{"$ref":"#/components/schemas/ActivityRemovedFromFeedEvent"},{"$ref":"#/components/schemas/ActivityUnpinnedEvent"},{"$ref":"#/components/schemas/ActivityUpdatedEvent"},{"$ref":"#/components/schemas/AsyncBulkImageModerationEvent"},{"$ref":"#/components/schemas/AsyncExportErrorEvent"},{"$ref":"#/components/schemas/AsyncExportErrorEvent"},{"$ref":"#/components/schemas/AsyncExportModerationLogsEvent"},{"$ref":"#/components/schemas/BookmarkAddedEvent"},{"$ref":"#/components/schemas/BookmarkDeletedEvent"},{"$ref":"#/components/schemas/BookmarkFolderDeletedEvent"},{"$ref":"#/components/schemas/BookmarkFolderUpdatedEvent"},{"$ref":"#/components/schemas/BookmarkUpdatedEvent"},{"$ref":"#/components/schemas/CommentAddedEvent"},{"$ref":"#/components/schemas/CommentDeletedEvent"},{"$ref":"#/components/schemas/CommentReactionAddedEvent"},{"$ref":"#/components/schemas/CommentReactionDeletedEvent"},{"$ref":"#/components/schemas/CommentReactionUpdatedEvent"},{"$ref":"#/components/schemas/CommentUpdatedEvent"},{"$ref":"#/components/schemas/FeedCreatedEvent"},{"$ref":"#/components/schemas/FeedDeletedEvent"},{"$ref":"#/components/schemas/FeedGroupChangedEvent"},{"$ref":"#/components/schemas/FeedGroupDeletedEvent"},{"$ref":"#/components/schemas/FeedMemberAddedEvent"},{"$ref":"#/components/schemas/FeedMemberRemovedEvent"},{"$ref":"#/components/schemas/FeedMemberUpdatedEvent"},{"$ref":"#/components/schemas/FeedUpdatedEvent"},{"$ref":"#/components/schemas/FollowCreatedEvent"},{"$ref":"#/components/schemas/FollowDeletedEvent"},{"$ref":"#/components/schemas/FollowUpdatedEvent"},{"$ref":"#/components/schemas/ModerationCheckCompletedEvent"},{"$ref":"#/components/schemas/ModerationCustomActionEvent"},{"$ref":"#/components/schemas/ModerationFlaggedEvent"},{"$ref":"#/components/schemas/ModerationMarkReviewedEvent"},{"$ref":"#/components/schemas/NotificationFeedUpdatedEvent"},{"$ref":"#/components/schemas/ReviewQueueItemNewEvent"},{"$ref":"#/components/schemas/ReviewQueueItemUpdatedEvent"},{"$ref":"#/components/schemas/UserBannedEvent"},{"$ref":"#/components/schemas/UserDeactivatedEvent"},{"$ref":"#/components/schemas/UserMutedEvent"},{"$ref":"#/components/schemas/UserReactivatedEvent"},{"$ref":"#/components/schemas/UserUpdatedEvent"}]},"XiaomiConfig":{"properties":{"Disabled":{"type":"boolean","writeOnly":true,"x-stream-index":"003"},"package_name":{"type":"string","x-stream-index":"001"},"secret":{"type":"string","x-stream-index":"002"}},"type":"object"},"XiaomiConfigFields":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"package_name":{"type":"string","x-stream-index":"002"},"secret":{"type":"string","x-stream-index":"003"}},"required":["enabled"],"type":"object"}},"securitySchemes":{"JWT":{"description":"JWT should be always provided when stream-auth-type=jwt.\n\nUsing JWT auth request could be authenticated as user or as server-side.\n\nWhen using user authentication permission checking is going to be applied to requests based on the user that is\nperforming a request.\n\nThe `authorization` header should be a JWT string signed using the secret attached to the API key used to perform\nrequests.\n\n**WARNING** all client-side official SDK do not ship with token generation; this is to make sure that the API secret is not\nshared with an untrusted party such as a browser or a iOS/Android application. Tokens **must** be generated server-side.\nIf you wish, you can configure your application to ignore authentication (see `disable_auth_check`)\nThe JWT string must include only the user_id claim and can include any built-in JWT claim such as iat, exp as well.\n","in":"header","name":"Authorization","type":"apiKey"},"api_key":{"description":"Application API key should be always set in order to authenticate the request.","in":"query","name":"api_key","type":"apiKey"},"stream-auth-type":{"description":"Stream-Auth-Type should be always set in order to authenticate the request. Possible\nvalues: `jwt` or `anonymous`.\n\n`jwt` allows you to authenticate as a user. With this auth type you should also provide valid JWT in Authorization\nheader.\n\n`anonymous` allows you to authenticate as anonymous user. Please note that most advanced features are not available\nto anonymous users.","in":"header","name":"Stream-Auth-Type","type":"apiKey"}}},"info":{"title":"Stream API","version":"v191.1.0"},"openapi":"3.0.3","paths":{"/api/v2/app":{"get":{"description":"This Method returns the application settings\n","operationId":"GetApp","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetApplicationResponse"}}},"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":"Get App Settings","tags":["product:common"]},"patch":{"description":"This Method updates one or more application settings\n","operationId":"UpdateApp","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAppRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Update App Settings","tags":["product:common"]}},"/api/v2/blocklists":{"get":{"description":"Returns all available block lists\n","operationId":"ListBlockLists","parameters":[{"in":"query","name":"team","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListBlockListResponse"}}},"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":"List block lists","tags":["product:common"]},"post":{"description":"Creates a new application blocklist, once created the blocklist can be used by any channel type\n","operationId":"CreateBlockList","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBlockListRequest"}}},"description":"Block list","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBlockListResponse"}}},"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":"Create block list","tags":["product:common"]}},"/api/v2/blocklists/{name}":{"delete":{"description":"Deletes previously created application blocklist\n","operationId":"DeleteBlockList","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"team","schema":{"type":"string","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete block list","tags":["product:common"]},"get":{"description":"Returns block list by given name\n","operationId":"GetBlockList","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Block list name","title":"Name","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"team","schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBlockListResponse"}}},"description":"GetBlockListResponse"},"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":"Get block list","tags":["product:common"]},"put":{"description":"Updates contents of the block list\n","operationId":"UpdateBlockList","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Block list name","title":"Name","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBlockListRequest"}}},"description":"Update block list","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBlockListResponse"}}},"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":"Update block list","tags":["product:common"]}},"/api/v2/check_push":{"post":{"description":"Sends a test message via push, this is a test endpoint to verify your push settings\n","operationId":"CheckPush","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckPushRequest"}}},"description":"CheckPushRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckPushResponse"}}},"description":"Successful 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":"Check push","tags":["product:common"]}},"/api/v2/check_sns":{"post":{"description":"Validates Amazon SNS configuration\n","operationId":"CheckSNS","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSNSRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSNSResponse"}}},"description":"Successful 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":"Check SNS","tags":["product:common"]}},"/api/v2/check_sqs":{"post":{"description":"Validates Amazon SQS credentials\n","operationId":"CheckSQS","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSQSRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSQSResponse"}}},"description":"Successful 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":"Check SQS","tags":["product:common"]}},"/api/v2/devices":{"delete":{"description":"Deletes one device\n","operationId":"DeleteDevice","parameters":[{"in":"query","name":"id","required":true,"schema":{"description":"Device ID to delete","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"user_id","schema":{"description":"**Server-side only**. User ID which server acts upon","title":"User ID","type":"string","writeOnly":true,"x-stream-index":"002.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete device","tags":["product:common"]},"get":{"description":"Returns all available devices\n","operationId":"ListDevices","parameters":[{"in":"query","name":"user_id","schema":{"description":"**Server-side only**. User ID which server acts upon","title":"User ID","type":"string","writeOnly":true,"x-stream-index":"001.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDevicesResponse"}}},"description":"ListDevicesResponse"},"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":"List devices","tags":["product:common"]},"post":{"description":"Adds a new device to a user, if the same device already exists the call will have no effect\n","operationId":"CreateDevice","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDeviceRequest"}}},"description":"CreateDeviceRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Create device","tags":["product:common"]}},"/api/v2/export/users":{"post":{"description":"Exports user profile, reactions and messages for list of given users\n","operationId":"ExportUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportUsersResponse"}}},"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":"Export users","tags":["product:common"]}},"/api/v2/external_storage":{"get":{"description":"Lists external storage\n","operationId":"ListExternalStorage","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListExternalStorageResponse"}}},"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":"List external storage","tags":["product:common"]},"post":{"description":"Creates new external storage\n","operationId":"CreateExternalStorage","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateExternalStorageRequest"}}},"description":"CreateExternalStorageRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateExternalStorageResponse"}}},"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":"Create external storage","tags":["product:common"]}},"/api/v2/external_storage/{name}":{"delete":{"description":"Deletes external storage\n","operationId":"DeleteExternalStorage","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteExternalStorageResponse"}}},"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":"Delete external storage","tags":["product:common"]},"put":{"description":"\n","operationId":"UpdateExternalStorage","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateExternalStorageRequest"}}},"description":"ExternalStorageRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateExternalStorageResponse"}}},"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":"Update External Storage","tags":["product:common"]}},"/api/v2/external_storage/{name}/check":{"get":{"description":"\n","operationId":"CheckExternalStorage","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckExternalStorageResponse"}}},"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":"Check External Storage","tags":["product:common"]}},"/api/v2/feeds/activities":{"post":{"description":"Create a new activity or update an existing one\n","operationId":"AddActivity","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddActivityRequest"}}},"description":"Activity Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddActivityResponse"}}},"description":"Add Activity 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":"Add a single activity","tags":["product:feeds"]}},"/api/v2/feeds/activities/batch":{"post":{"description":"Create new activities or update existing ones in a batch operation\n","operationId":"UpsertActivities","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertActivitiesRequest"}}},"description":"Upsert Activities Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertActivitiesResponse"}}},"description":"Upsert Activities 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":"Upsert multiple activities","tags":["product:feeds"]}},"/api/v2/feeds/activities/delete":{"post":{"description":"Delete one or more activities by their IDs\n","operationId":"DeleteActivities","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteActivitiesRequest"}}},"description":"Delete Activities Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteActivitiesResponse"}}},"description":"Delete Activities 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":"Remove multiple activities","tags":["product:feeds"]}},"/api/v2/feeds/activities/query":{"post":{"description":"Query activities based on filters with pagination and sorting options\n","operationId":"QueryActivities","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryActivitiesRequest"}}},"description":"Query Activities Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryActivitiesResponse"}}},"description":"Query Activities 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":"Query activities","tags":["product:feeds"]}},"/api/v2/feeds/activities/{activity_id}/bookmarks":{"delete":{"description":"Deletes a bookmark from an activity\n","operationId":"DeleteBookmark","parameters":[{"in":"path","name":"activity_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"folder_id","schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"003.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteBookmarkResponse"}}},"description":"Delete Bookmark 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":"Delete a bookmark","tags":["product:feeds"]},"patch":{"description":"Updates a bookmark for an activity\n","operationId":"UpdateBookmark","parameters":[{"in":"path","name":"activity_id","required":true,"schema":{"description":"ID of the activity","maxLength":255,"title":"Activity ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBookmarkRequest"}}},"description":"Update Bookmark Request","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBookmarkResponse"}}},"description":"Update Bookmark 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":"Update bookmark","tags":["product:feeds"]},"post":{"description":"Adds a bookmark to an activity\n","operationId":"AddBookmark","parameters":[{"in":"path","name":"activity_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddBookmarkRequest"}}},"description":"Add Bookmark Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddBookmarkResponse"}}},"description":"Add Bookmark 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":"Add bookmark","tags":["product:feeds"]}},"/api/v2/feeds/activities/{activity_id}/feedback":{"post":{"description":"Submit feedback for an activity including options to show less, hide, report, or mute the user\n","operationId":"ActivityFeedback","parameters":[{"in":"path","name":"activity_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivityFeedbackRequest"}}},"description":"Activity Feedback Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivityFeedbackResponse"}}},"description":"Activity Feedback 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":"Provide feedback on an activity","tags":["product:feeds"]}},"/api/v2/feeds/activities/{activity_id}/polls/{poll_id}/vote":{"post":{"description":"Cast a vote on a poll\n\nSends events:\n- feeds.poll.vote_casted\n- feeds.poll.vote_changed\n- feeds.poll.vote_removed\n- poll.vote_casted\n- poll.vote_changed\n- poll.vote_removed\n","operationId":"CastPollVote","parameters":[{"in":"path","name":"activity_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CastPollVoteRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollVoteResponse"}}},"description":"Successful 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":"Cast vote","tags":["product:feeds"]}},"/api/v2/feeds/activities/{activity_id}/polls/{poll_id}/vote/{vote_id}":{"delete":{"description":"Delete a vote from a poll\n\nSends events:\n- feeds.poll.vote_removed\n- poll.vote_removed\n","operationId":"DeletePollVote","parameters":[{"in":"path","name":"activity_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003"}},{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"004"}},{"in":"path","name":"vote_id","required":true,"schema":{"description":"Vote ID","maxLength":255,"title":"string","type":"string","x-stream-index":"005"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollVoteResponse"}}},"description":"Successful 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":"Delete vote","tags":["product:feeds"]}},"/api/v2/feeds/activities/{activity_id}/reactions":{"post":{"description":"Adds a reaction to an activity\n","operationId":"AddReaction","parameters":[{"in":"path","name":"activity_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddReactionRequest"}}},"description":"Add Reaction Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddReactionResponse"}}},"description":"Add Reaction 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":"Add reaction","tags":["product:feeds"]}},"/api/v2/feeds/activities/{activity_id}/reactions/query":{"post":{"description":"Query activity reactions\n","operationId":"QueryActivityReactions","parameters":[{"in":"path","name":"activity_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryActivityReactionsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryActivityReactionsResponse"}}},"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":"Query activity reactions","tags":["product:feeds"]}},"/api/v2/feeds/activities/{activity_id}/reactions/{type}":{"delete":{"description":"Removes a reaction from an activity\n","operationId":"DeleteActivityReaction","parameters":[{"in":"path","name":"activity_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"type","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"003.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteActivityReactionResponse"}}},"description":"Delete Activity Reaction 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":"Remove reaction","tags":["product:feeds"]}},"/api/v2/feeds/activities/{id}":{"delete":{"description":"Delete a single activity by its ID\n","operationId":"DeleteActivity","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"hard_delete","schema":{"description":"Whether to permanently delete the activity instead of soft delete","title":"boolean","type":"boolean","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteActivityResponse"}}},"description":"Delete Activity 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":"Delete a single activity","tags":["product:feeds"]},"get":{"description":"Returns activity by ID\n","operationId":"GetActivity","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetActivityResponse"}}},"description":"Get Activity 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":"Get activity","tags":["product:feeds"]},"patch":{"description":"Updates certain fields of the activity\n\nSends events:\n- feeds.activity.updated\n","operationId":"UpdateActivityPartial","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateActivityPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateActivityPartialResponse"}}},"description":"Successful 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":"Partially activity update","tags":["product:feeds"]},"put":{"description":"Replaces an activity with the provided data\n\nSends events:\n- feeds.activity.updated\n","operationId":"UpdateActivity","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateActivityRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateActivityResponse"}}},"description":"Successful 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":"Full activity update","tags":["product:feeds"]}},"/api/v2/feeds/bookmark_folders/query":{"post":{"description":"Query bookmark folders with filter query\n","operationId":"QueryBookmarkFolders","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryBookmarkFoldersRequest"}}},"description":"Query Bookmark Folders Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryBookmarkFoldersResponse"}}},"description":"Query Bookmark Folders 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":"Query bookmark folders","tags":["product:feeds"]}},"/api/v2/feeds/bookmark_folders/{folder_id}":{"delete":{"description":"Delete a bookmark folder by its ID\n","operationId":"DeleteBookmarkFolder","parameters":[{"in":"path","name":"folder_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteBookmarkFolderResponse"}}},"description":"Delete Bookmark Folder 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":"Delete a bookmark folder","tags":["product:feeds"]},"patch":{"description":"Update a bookmark folder by its ID\n","operationId":"UpdateBookmarkFolder","parameters":[{"in":"path","name":"folder_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBookmarkFolderRequest"}}},"description":"Update Bookmark Folder Request","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBookmarkFolderResponse"}}},"description":"Update Bookmark Folder 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":"Update a bookmark folder","tags":["product:feeds"]}},"/api/v2/feeds/bookmarks/query":{"post":{"description":"Query bookmarks with filter query\n","operationId":"QueryBookmarks","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryBookmarksRequest"}}},"description":"Query Bookmarks Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryBookmarksResponse"}}},"description":"Query Bookmarks 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":"Query bookmarks","tags":["product:feeds"]}},"/api/v2/feeds/comments":{"get":{"description":"Retrieve a threaded list of comments for a specific object (e.g., activity), with configurable depth, sorting, and pagination\n","operationId":"GetComments","parameters":[{"in":"query","name":"object_id","required":true,"schema":{"description":"ID of the object to get comments for","title":"Object ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"object_type","required":true,"schema":{"description":"Type of the object to get comments for","title":"Object Type","type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"depth","schema":{"description":"Maximum nested depth to return (0 = only first level)","format":"int32","maximum":5,"minimum":0,"title":"Max Depth","type":"integer","writeOnly":true,"x-stream-index":"003"}},{"in":"query","name":"sort","schema":{"description":"Sort order for the comments","enum":["first","last","top","best","controversial"],"title":"Sort Order","type":"string","writeOnly":true,"x-stream-index":"004"}},{"in":"query","name":"replies_limit","schema":{"format":"int32","maximum":20,"minimum":0,"type":"integer","writeOnly":true,"x-stream-index":"005"}},{"in":"query","name":"limit","schema":{"description":"Max number of top‑level comments to return","format":"int32","maximum":100,"minimum":0,"title":"Root Limit","type":"integer","writeOnly":true,"x-stream-index":"006.001"}},{"in":"query","name":"prev","schema":{"type":"string","writeOnly":true,"x-stream-index":"006.002"}},{"in":"query","name":"next","schema":{"type":"string","writeOnly":true,"x-stream-index":"006.003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCommentsResponse"}}},"description":"Get Comments 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":"Get comments for an object","tags":["product:feeds"]},"post":{"description":"Adds a comment to an object (e.g., activity) or a reply to an existing comment, and broadcasts appropriate events\n","operationId":"AddComment","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddCommentRequest"}}},"description":"Add Comment Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddCommentResponse"}}},"description":"Add Comment 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":"Add a comment or reply","tags":["product:feeds"]}},"/api/v2/feeds/comments/batch":{"post":{"description":"Adds multiple comments in a single request. Each comment must specify the object type and ID.\n","operationId":"AddCommentsBatch","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddCommentsBatchRequest"}}},"description":"Add Comments Batch Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddCommentsBatchResponse"}}},"description":"Add Comments Batch 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":"Add multiple comments in a batch","tags":["product:feeds"]}},"/api/v2/feeds/comments/query":{"post":{"description":"Query comments using MongoDB-style filters with pagination and sorting options\n","operationId":"QueryComments","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCommentsRequest"}}},"description":"Query Comments Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCommentsResponse"}}},"description":"Query Comments 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":"Query comments","tags":["product:feeds"]}},"/api/v2/feeds/comments/{id}":{"delete":{"description":"Deletes a comment from an object (e.g., activity) and broadcasts appropriate events\n","operationId":"DeleteComment","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"hard_delete","schema":{"description":"Whether to permanently delete the comment instead of soft delete","title":"Hard Delete","type":"boolean","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCommentResponse"}}},"description":"Delete Comment 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":"Delete a comment","tags":["product:feeds"]},"get":{"description":"Get a comment by ID\n","operationId":"GetComment","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCommentResponse"}}},"description":"Get Comment 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":"Get comment","tags":["product:feeds"]},"patch":{"description":"Updates a comment on an object (e.g., activity) and broadcasts appropriate events\n","operationId":"UpdateComment","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCommentRequest"}}},"description":"Update Comment Request","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCommentResponse"}}},"description":"Update Comment 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":"Update a comment","tags":["product:feeds"]}},"/api/v2/feeds/comments/{id}/reactions":{"post":{"description":"Adds a reaction to a comment\n","operationId":"AddCommentReaction","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddCommentReactionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddCommentReactionResponse"}}},"description":"Successful 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":"Add comment reaction","tags":["product:feeds"]}},"/api/v2/feeds/comments/{id}/reactions/query":{"post":{"description":"Query comment reactions\n","operationId":"QueryCommentReactions","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCommentReactionsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCommentReactionsResponse"}}},"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":"Query comment reactions","tags":["product:feeds"]}},"/api/v2/feeds/comments/{id}/reactions/{type}":{"delete":{"description":"Deletes a reaction from a comment\n","operationId":"DeleteCommentReaction","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"type","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"003.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCommentReactionResponse"}}},"description":"Delete Comment Reaction 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":"Delete comment reaction","tags":["product:feeds"]}},"/api/v2/feeds/comments/{id}/replies":{"get":{"description":"Retrieve a threaded list of replies for a single comment, with configurable depth, sorting, and pagination\n","operationId":"GetCommentReplies","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"depth","schema":{"description":"Maximum nested depth to return (0 = unlimited)","format":"int32","maximum":5,"minimum":0,"title":"Max Depth","type":"integer","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"sort","schema":{"description":"first (oldest), last (newest) or top","enum":["first","last","top","best","controversial"],"title":"Sort Order","type":"string","writeOnly":true,"x-stream-index":"003"}},{"in":"query","name":"replies_limit","schema":{"description":"Max number of replies to return","format":"int32","minimum":0,"title":"Replies Limit","type":"integer","writeOnly":true,"x-stream-index":"004"}},{"in":"query","name":"limit","schema":{"description":"Max number of direct replies to return","format":"int32","maximum":100,"minimum":0,"title":"Reply Limit","type":"integer","writeOnly":true,"x-stream-index":"005.001"}},{"in":"query","name":"prev","schema":{"type":"string","writeOnly":true,"x-stream-index":"005.002"}},{"in":"query","name":"next","schema":{"type":"string","writeOnly":true,"x-stream-index":"005.003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCommentRepliesResponse"}}},"description":"Get Comment Replies 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":"Get replies for a comment","tags":["product:feeds"]}},"/api/v2/feeds/feed_groups":{"get":{"description":"List all feed groups for the application\n","operationId":"ListFeedGroups","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListFeedGroupsResponse"}}},"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":"List all feed groups","tags":["product:feeds"]},"post":{"description":"Creates a new feed group with the specified configuration\n","operationId":"CreateFeedGroup","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFeedGroupRequest"}}},"description":"Create Feed Group Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFeedGroupResponse"}}},"description":"Upsert Feed Group 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":"Create a new feed group","tags":["product:feeds"]}},"/api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}":{"delete":{"description":"Delete a single feed by its ID\n","operationId":"DeleteFeed","parameters":[{"in":"path","name":"feed_group_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"feed_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"hard_delete","schema":{"description":"Whether to permanently delete the feed instead of soft delete","title":"boolean","type":"boolean","writeOnly":true,"x-stream-index":"003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteFeedResponse"}}},"description":"Delete Feed 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":"Delete a single feed","tags":["product:feeds"]},"post":{"description":"Create a single feed for a given feed group\n","operationId":"GetOrCreateFeed","parameters":[{"in":"path","name":"feed_group_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"feed_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrCreateFeedRequest"}}},"description":"ClientRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrCreateFeedResponse"}}},"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":"Create a new feed","tags":["product:feeds"]},"put":{"description":"Update an existing feed\n","operationId":"UpdateFeed","parameters":[{"in":"path","name":"feed_group_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"feed_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFeedRequest"}}},"description":"Update Feed Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFeedResponse"}}},"description":"Update Feed 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":"Update a feed","tags":["product:feeds"]}},"/api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/activities/mark/batch":{"post":{"description":"Mark activities as read/seen/watched. Can mark by timestamp (seen), activity IDs (read), or all as read.\n","operationId":"MarkActivity","parameters":[{"in":"path","name":"feed_group_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"feed_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkActivityRequest"}}},"description":"Mark Activity Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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 activities as read/seen/watched","tags":["product:feeds"]}},"/api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/activities/{activity_id}/pin":{"delete":{"description":"Unpin an activity from a feed. This removes the pin, so the activity will no longer be displayed at the top of the feed.\n","operationId":"UnpinActivity","parameters":[{"in":"path","name":"feed_group_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"feed_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"path","name":"activity_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"004.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnpinActivityResponse"}}},"description":"Unpin Activity 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":"Unpin an activity from a feed","tags":["product:feeds"]},"post":{"description":"Pin an activity to a feed. Pinned activities are typically displayed at the top of a feed.\n","operationId":"PinActivity","parameters":[{"in":"path","name":"feed_group_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"feed_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"path","name":"activity_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PinActivityRequest"}}},"description":"Pin Activity Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PinActivityResponse"}}},"description":"Pin Activity 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":"Pin an activity to a feed","tags":["product:feeds"]}},"/api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/members":{"patch":{"description":"Add, remove, or set members for a feed\n","operationId":"UpdateFeedMembers","parameters":[{"in":"path","name":"feed_group_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"feed_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFeedMembersRequest"}}},"description":"Update Feed Members Request","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFeedMembersResponse"}}},"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":"Update feed members","tags":["product:feeds"]}},"/api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/members/accept":{"post":{"description":"Accepts a pending feed member request\n","operationId":"AcceptFeedMemberInvite","parameters":[{"in":"path","name":"feed_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"feed_group_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcceptFeedMemberInviteRequest"}}},"description":"Accept Feed Member Invite Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcceptFeedMemberInviteResponse"}}},"description":"Accept Feed Member Invite 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":"Accept a feed member request","tags":["product:feeds"]}},"/api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/members/query":{"post":{"description":"Query feed members based on filters with pagination and sorting options\n","operationId":"QueryFeedMembers","parameters":[{"in":"path","name":"feed_group_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"feed_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryFeedMembersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryFeedMembersResponse"}}},"description":"Successful 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":"Query feed members","tags":["product:feeds"]}},"/api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/members/reject":{"post":{"description":"Rejects a pending feed member request\n","operationId":"RejectFeedMemberInvite","parameters":[{"in":"path","name":"feed_group_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"feed_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RejectFeedMemberInviteRequest"}}},"description":"Reject Feed Member Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RejectFeedMemberInviteResponse"}}},"description":"Reject Feed Member 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":"Reject an invite to become a feed member","tags":["product:feeds"]}},"/api/v2/feeds/feed_groups/{feed_group_id}/follow_suggestions":{"get":{"description":"Get follow suggestions for a feed group\n","operationId":"GetFollowSuggestions","parameters":[{"in":"path","name":"feed_group_id","required":true,"schema":{"description":"The ID of the feed group to get suggestions for","maxLength":255,"title":"Feed Group ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"limit","schema":{"description":"Maximum number of suggestions to return","format":"int32","maximum":100,"minimum":1,"title":"Limit","type":"integer","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"description":"The ID of the user requesting suggestions (optional, defaults to current user)","title":"User ID","type":"string","writeOnly":true,"x-stream-index":"003.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetFollowSuggestionsResponse"}}},"description":"Follow Suggestions 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":"Get follow suggestions","tags":["product:feeds"]}},"/api/v2/feeds/feed_groups/{id}":{"delete":{"description":"Delete a feed group by its ID. Can perform a soft delete (default) or hard delete.\n","operationId":"DeleteFeedGroup","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"hard_delete","schema":{"description":"Whether to perform a hard delete (true) or soft delete (false, default)","title":"boolean","type":"boolean","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteFeedGroupResponse"}}},"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":"Delete a feed group","tags":["product:feeds"]},"get":{"description":"Get a feed group by ID\n","operationId":"GetFeedGroup","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetFeedGroupResponse"}}},"description":"Get Feed Group 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":"Get a feed group","tags":["product:feeds"]},"post":{"description":"Get an existing feed group or create a new one if it doesn't exist\n","operationId":"GetOrCreateFeedGroup","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Unique identifier for the feed group","maxLength":255,"title":"Feed Group ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrCreateFeedGroupRequest"}}},"description":"Get Or Create Feed Group Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrCreateFeedGroupResponse"}}},"description":"Get Or Create Feed Group 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":"Get or create a feed group","tags":["product:feeds"]},"put":{"description":"Update a feed group by ID\n","operationId":"UpdateFeedGroup","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFeedGroupRequest"}}},"description":"Update Feed Group Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFeedGroupResponse"}}},"description":"Update Feed Group 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":"Update a feed group","tags":["product:feeds"]}},"/api/v2/feeds/feed_views":{"get":{"description":"List all feed views for a feed group\n","operationId":"ListFeedViews","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListFeedViewsResponse"}}},"description":"List Feed Views 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":"List all feed views","tags":["product:feeds"]},"post":{"description":"Create a custom view for a feed group with specific selectors, ranking, or aggregation options\n","operationId":"CreateFeedView","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFeedViewRequest"}}},"description":"Create Feed View Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFeedViewResponse"}}},"description":"Create Feed View 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":"Create a new feed view","tags":["product:feeds"]}},"/api/v2/feeds/feed_views/{id}":{"delete":{"description":"Delete an existing custom feed view\n","operationId":"DeleteFeedView","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteFeedViewResponse"}}},"description":"Delete Feed View 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":"Delete a feed view","tags":["product:feeds"]},"get":{"description":"Get a feed view by its ID\n","operationId":"GetFeedView","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetFeedViewResponse"}}},"description":"Get Feed View 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":"Get a feed view","tags":["product:feeds"]},"post":{"description":"Get an existing feed view or create a new one if it doesn't exist\n","operationId":"GetOrCreateFeedView","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrCreateFeedViewRequest"}}},"description":"Get Or Create Feed View Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrCreateFeedViewResponse"}}},"description":"Get Or Create Feed View 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":"Get or create a feed view","tags":["product:feeds"]},"put":{"description":"Update an existing custom feed view with new selectors, ranking, or aggregation options\n","operationId":"UpdateFeedView","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFeedViewRequest"}}},"description":"Update Feed View Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFeedViewResponse"}}},"description":"Update Feed View 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":"Update a feed view","tags":["product:feeds"]}},"/api/v2/feeds/feeds/batch":{"post":{"description":"Create multiple feeds at once for a given feed group\n","operationId":"CreateFeedsBatch","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFeedsBatchRequest"}}},"description":"Create Feeds Batch Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFeedsBatchResponse"}}},"description":"Create Feeds Batch 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":"Create multiple feeds at once","tags":["product:feeds"]}},"/api/v2/feeds/feeds/query":{"post":{"description":"Query feeds with filter query\n","operationId":"QueryFeeds","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryFeedsRequest"}}},"description":"Query Feeds Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryFeedsResponse"}}},"description":"Query Feeds 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":"Query feeds","tags":["product:feeds"]}},"/api/v2/feeds/follows":{"patch":{"description":"Updates a follow's custom data, push preference, and follower role. Source owner can update custom data and push preference. Target owner can update follower role.\n","operationId":"UpdateFollow","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFollowRequest"}}},"description":"Update Follow Request","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFollowResponse"}}},"description":"Update Follow 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":"Update a follow","tags":["product:feeds"]},"post":{"description":"Creates a follow and broadcasts FollowAddedEvent\n","operationId":"Follow","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FollowRequest"}}},"description":"Follow Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SingleFollowResponse"}}},"description":"Follow 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":"Create a follow","tags":["product:feeds"]}},"/api/v2/feeds/follows/accept":{"post":{"description":"Accepts a pending follow request\n","operationId":"AcceptFollow","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcceptFollowRequest"}}},"description":"Accept Follow Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcceptFollowResponse"}}},"description":"Accept Follow 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":"Accept a follow request","tags":["product:feeds"]}},"/api/v2/feeds/follows/batch":{"post":{"description":"Creates multiple follows at once and broadcasts FollowAddedEvent for each follow\n","operationId":"FollowBatch","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FollowBatchRequest"}}},"description":"Follow Batch Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FollowBatchResponse"}}},"description":"Follow Batch 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":"Create multiple follows at once","tags":["product:feeds"]}},"/api/v2/feeds/follows/query":{"post":{"description":"Query follows based on filters with pagination and sorting options\n","operationId":"QueryFollows","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryFollowsRequest"}}},"description":"Query Follows Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryFollowsResponse"}}},"description":"Query Follows 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":"Query follows","tags":["product:feeds"]}},"/api/v2/feeds/follows/reject":{"post":{"description":"Rejects a pending follow request\n","operationId":"RejectFollow","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RejectFollowRequest"}}},"description":"Reject Follow Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RejectFollowResponse"}}},"description":"Reject Follow 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":"Reject a follow request","tags":["product:feeds"]}},"/api/v2/feeds/follows/{source}/{target}":{"delete":{"description":"Removes a follow and broadcasts FollowRemovedEvent\n","operationId":"Unfollow","parameters":[{"in":"path","name":"source","required":true,"schema":{"description":"Fully qualified ID of the source feed","maxLength":255,"title":"Source Feed","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"target","required":true,"schema":{"description":"Fully qualified ID of the target feed","maxLength":255,"title":"Target Feed","type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnfollowResponse"}}},"description":"Unfollow 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":"Unfollow a feed","tags":["product:feeds"]}},"/api/v2/feeds/membership_levels":{"post":{"description":"Create a new membership level with tag-based access controls\n","operationId":"CreateMembershipLevel","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateMembershipLevelRequest"}}},"description":"Create Membership Level Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateMembershipLevelResponse"}}},"description":"Create Membership Level 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":"Create membership level","tags":["product:feeds"]}},"/api/v2/feeds/membership_levels/query":{"post":{"description":"Query membership levels with filter query\n","operationId":"QueryMembershipLevels","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryMembershipLevelsRequest"}}},"description":"Query Membership Levels Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryMembershipLevelsResponse"}}},"description":"Query Membership Levels 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":"Query membership levels","tags":["product:feeds"]}},"/api/v2/feeds/membership_levels/{id}":{"delete":{"description":"Delete a membership level by its UUID. This operation is irreversible.\n","operationId":"DeleteMembershipLevel","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"The UUID of the membership level to delete","maxLength":255,"title":"string","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete membership level","tags":["product:feeds"]},"patch":{"description":"Update a membership level with partial updates. Only specified fields will be updated.\n","operationId":"UpdateMembershipLevel","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMembershipLevelRequest"}}},"description":"Update Membership Level Request","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMembershipLevelResponse"}}},"description":"Update Membership Level 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":"Update membership level","tags":["product:feeds"]}},"/api/v2/feeds/unfollow/batch":{"post":{"description":"Removes multiple follows at once and broadcasts FollowRemovedEvent for each one\n","operationId":"UnfollowBatch","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnfollowBatchRequest"}}},"description":"Unfollow Batch Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnfollowBatchResponse"}}},"description":"Unfollow Batch 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":"Unfollow multiple feeds at once","tags":["product:feeds"]}},"/api/v2/feeds/users/{user_id}/delete":{"delete":{"description":"Delete all activities, reactions, comments, and bookmarks for a user\n","operationId":"DeleteFeedUserData","parameters":[{"in":"path","name":"user_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteFeedUserDataResponse"}}},"description":"Successful 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":"Delete all feed data for a user","tags":["product:feeds"]}},"/api/v2/feeds/users/{user_id}/export":{"post":{"description":"Export all activities, reactions, comments, and bookmarks for a user\n","operationId":"ExportFeedUserData","parameters":[{"in":"path","name":"user_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportFeedUserDataResponse"}}},"description":"Successful 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":"Export all feed data for a user","tags":["product:feeds"]}},"/api/v2/guest":{"post":{"description":"\n","operationId":"CreateGuest","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGuestRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGuestResponse"}}},"description":"Successful 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":"Create Guest","tags":["product:common"]}},"/api/v2/import_urls":{"post":{"description":"Creates a new import URL\n","operationId":"CreateImportURL","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateImportURLRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateImportURLResponse"}}},"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":"Create import URL","tags":["product:common"]}},"/api/v2/imports":{"get":{"description":"Gets an import\n","operationId":"ListImports","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListImportsResponse"}}},"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":"Get import","tags":["product:common"]},"post":{"description":"Creates a new import\n","operationId":"CreateImport","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateImportRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateImportResponse"}}},"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":"Create import","tags":["product:common"]}},"/api/v2/imports/{id}":{"get":{"description":"Gets an import\n","operationId":"GetImport","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetImportResponse"}}},"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":"Get import","tags":["product:common"]}},"/api/v2/moderation/ban":{"post":{"description":"Ban a user from a channel or the entire app\n","operationId":"ban","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BanRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BanResponse"}}},"description":"Successful 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":"Ban","tags":["product:moderation"]}},"/api/v2/moderation/bulk_image_moderation":{"post":{"description":"Moderate multiple images in bulk using a CSV file\n","operationId":"bulk_image_moderation","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkImageModerationRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkImageModerationResponse"}}},"description":"Successful 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":"Bulk image moderation","tags":["product:moderation"]}},"/api/v2/moderation/check":{"post":{"description":"Run moderation checks on the provided content\n","operationId":"check","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckResponse"}}},"description":"Successful 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":"Check","tags":["product:moderation"]}},"/api/v2/moderation/config":{"post":{"description":"Create a new moderation configuration or update an existing one. Configure settings for content filtering, AI analysis, toxicity detection, and other moderation features.\n","operationId":"upsert_config","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertConfigRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertConfigResponse"}}},"description":"Successful 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":"Create or update moderation configuration","tags":["product:moderation"]}},"/api/v2/moderation/config/{key}":{"delete":{"description":"Delete a specific moderation policy by its name\n","operationId":"delete_config","parameters":[{"in":"path","name":"key","required":true,"schema":{"description":"Key of the moderation configuration to delete","title":"Key","type":"string","x-stream-index":"001"}},{"in":"query","name":"team","schema":{"description":"Team associated with the configuration","title":"Team","type":"string","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteModerationConfigResponse"}}},"description":"Successful 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":"Delete a moderation policy","tags":["product:moderation"]},"get":{"description":"Retrieve a specific moderation configuration by its key and team. This configuration contains settings for various moderation features like toxicity detection, AI analysis, and filtering rules.\n","operationId":"get_config","parameters":[{"in":"path","name":"key","required":true,"schema":{"description":"Key of the moderation configuration to retrieve","title":"Key","type":"string","x-stream-index":"001"}},{"in":"query","name":"team","schema":{"description":"Team associated with the configuration","title":"Team","type":"string","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetConfigResponse"}}},"description":"Successful 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":"Get moderation configuration","tags":["product:moderation"]}},"/api/v2/moderation/configs":{"post":{"description":"Search and filter moderation configurations across your application. This endpoint is designed for building moderation dashboards and managing multiple configuration sets.\n","operationId":"query_moderation_configs","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationConfigsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationConfigsResponse"}}},"description":"Successful 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":"Query moderation configurations","tags":["product:moderation"]}},"/api/v2/moderation/custom_check":{"post":{"description":"Custom check, add your own AI model reports to the review queue\n","operationId":"custom_check","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomCheckRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomCheckResponse"}}},"description":"Successful 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":"Custom check endpoint","tags":["product:moderation"]}},"/api/v2/moderation/feeds_moderation_template":{"delete":{"description":"Delete a specific moderation template by its name\n","operationId":"V2DeleteTemplate","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteModerationTemplateResponse"}}},"description":"Successful 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":"Delete a moderation template","tags":["product:moderation"]},"get":{"description":"Retrieve a list of feed moderation templates that define preset moderation rules and configurations. Limited to 100 templates per request.\n","operationId":"V2QueryTemplates","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryFeedModerationTemplatesResponse"}}},"description":"Successful 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":"Query feed moderation templates","tags":["product:moderation"]},"post":{"description":"Upsert feeds template for moderation\n","operationId":"V2UpsertTemplate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertModerationTemplateRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertModerationTemplateResponse"}}},"description":"Successful 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":"Upsert feeds template","tags":["product:moderation"]}},"/api/v2/moderation/flag":{"post":{"description":"Flag any type of content (messages, users, channels, activities) for moderation review. Supports custom content types and additional metadata for flagged content.\n","operationId":"flag","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlagRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlagResponse"}}},"description":"Successful 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":"Flag content for moderation","tags":["product:moderation"]}},"/api/v2/moderation/flags":{"post":{"description":"Query flags associated with moderation items. This is used for building a moderation dashboard.\n","operationId":"query_moderation_flags","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationFlagsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationFlagsResponse"}}},"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":"Query moderation flags","tags":["product:moderation"]}},"/api/v2/moderation/logs":{"post":{"description":"Search and filter moderation action logs with support for pagination. View the history of moderation actions taken, including who performed them and when.\n","operationId":"query_moderation_logs","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationLogsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationLogsResponse"}}},"description":"Successful 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":"Query moderation action logs","tags":["product:moderation"]}},"/api/v2/moderation/moderation_rule":{"post":{"description":"Create or update a moderation rule that can apply app-wide or to specific moderation configs\n","operationId":"upsert_moderation_rule","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertModerationRuleRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertModerationRuleResponse"}}},"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":"Upsert moderation rule","tags":["product:moderation"]}},"/api/v2/moderation/moderation_rule/{id}":{"delete":{"description":"Delete an existing moderation rule\n","operationId":"delete_moderation_rule","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteModerationRuleResponse"}}},"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":"Delete moderation rule","tags":["product:moderation"]},"get":{"description":"Get a specific moderation rule by ID\n","operationId":"get_moderation_rule","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetModerationRuleResponse"}}},"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":"Get moderation rule","tags":["product:moderation"]}},"/api/v2/moderation/moderation_rules":{"post":{"description":"Search and filter moderation rules across your application. This endpoint is designed for building moderation dashboards and managing multiple rule sets.\n","operationId":"query_moderation_rules","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationRulesRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationRulesResponse"}}},"description":"Successful 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":"Query moderation rules","tags":["product:moderation"]}},"/api/v2/moderation/mute":{"post":{"description":"Mute a user. Mutes are generally not visible to the user you mute, while block is something you notice.\n","operationId":"mute","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteRequest"}}},"description":"MuteRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteResponse"}}},"description":"MuteResponse"},"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":"Mute","tags":["product:moderation"]}},"/api/v2/moderation/review_queue":{"post":{"description":"Query review queue items allows you to filter the review queue items. This is used for building a moderation dashboard.\n","operationId":"query_review_queue","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryReviewQueueRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryReviewQueueResponse"}}},"description":"Successful 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":"Query review queue items","tags":["product:moderation"]}},"/api/v2/moderation/review_queue/{id}":{"get":{"description":"Retrieve a specific review queue item by its ID\n","operationId":"get_review_queue_item","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Unique identifier of the review queue item to retrieve","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetReviewQueueItemResponse"}}},"description":"Successful 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":"Get review queue item","tags":["product:moderation"]}},"/api/v2/moderation/submit_action":{"post":{"description":"Take action on flagged content, such as marking content as safe, deleting content, banning users, or executing custom moderation actions. Supports various action types with configurable parameters.\n","operationId":"submit_action","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitActionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitActionResponse"}}},"description":"Successful 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":"Submit moderation action","tags":["product:moderation"]}},"/api/v2/moderation/unban":{"post":{"description":"Unban a user from a channel or globally.\n","operationId":"unban","parameters":[{"in":"query","name":"target_user_id","required":true,"schema":{"description":"ID of the user to unban","title":"Target User ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"channel_cid","schema":{"description":"Channel where the unban applies","title":"Channel CID","type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"created_by","schema":{"description":"ID of the user who created the ban","title":"Created By","type":"string","writeOnly":true,"x-stream-index":"003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnbanRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnbanResponse"}}},"description":"Successful 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":"Unban","tags":["product:moderation"]}},"/api/v2/moderation/unmute":{"post":{"description":"Unmute a user\n","operationId":"unmute","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnmuteRequest"}}},"description":"UnmuteRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnmuteResponse"}}},"description":"UnmuteResponse"},"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":"Unmute a user","tags":["product:moderation"]}},"/api/v2/og":{"get":{"description":"Get an OpenGraph attachment for a link\n","operationId":"GetOG","parameters":[{"in":"query","name":"url","required":true,"schema":{"description":"URL to be scraped","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOGResponse"}}},"description":"Get OG Attachment"},"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":"Get OG","tags":["product:common"]}},"/api/v2/permissions":{"get":{"description":"Lists all available permissions\n","operationId":"ListPermissions","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPermissionsResponse"}}},"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":"List permissions","tags":["product:common"]}},"/api/v2/permissions/{id}":{"get":{"description":"Gets custom permission\n","operationId":"GetPermission","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Permission ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCustomPermissionResponse"}}},"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":"Get permission","tags":["product:common"]}},"/api/v2/polls":{"post":{"description":"Creates a new poll\n","operationId":"CreatePoll","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePollRequest"}}},"description":"Create Poll Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Create poll","tags":["product:common"]},"put":{"description":"Updates a poll\n\nSends events:\n- feeds.poll.closed\n- feeds.poll.updated\n- poll.closed\n- poll.updated\n","operationId":"UpdatePoll","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePollRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Update poll","tags":["product:common"]}},"/api/v2/polls/query":{"post":{"description":"Queries polls\n","operationId":"QueryPolls","parameters":[{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryPollsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryPollsResponse"}}},"description":"Successful 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":"Query polls","tags":["product:common"]}},"/api/v2/polls/{poll_id}":{"delete":{"description":"Deletes a poll\n\nSends events:\n- feeds.poll.deleted\n- poll.deleted\n","operationId":"DeletePoll","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete poll","tags":["product:common"]},"get":{"description":"Retrieves a poll\n","operationId":"GetPoll","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Get poll","tags":["product:common"]},"patch":{"description":"Updates a poll partially\n\nSends events:\n- feeds.poll.closed\n- feeds.poll.updated\n- poll.closed\n- poll.updated\n","operationId":"UpdatePollPartial","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePollPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Partial update poll","tags":["product:common"]}},"/api/v2/polls/{poll_id}/options":{"post":{"description":"Creates a poll option\n\nSends events:\n- feeds.poll.updated\n- poll.updated\n","operationId":"CreatePollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePollOptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollOptionResponse"}}},"description":"Successful 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":"Create poll option","tags":["product:common"]},"put":{"description":"Updates a poll option\n\nSends events:\n- feeds.poll.updated\n- poll.updated\n","operationId":"UpdatePollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePollOptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollOptionResponse"}}},"description":"Successful 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":"Update poll option","tags":["product:common"]}},"/api/v2/polls/{poll_id}/options/{option_id}":{"delete":{"description":"Deletes a poll option\n\nSends events:\n- feeds.poll.updated\n- poll.updated\n","operationId":"DeletePollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"path","name":"option_id","required":true,"schema":{"description":"Option ID","maxLength":255,"title":"string","type":"string","x-stream-index":"003"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete poll option","tags":["product:common"]},"get":{"description":"Retrieves a poll option\n","operationId":"GetPollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"path","name":"option_id","required":true,"schema":{"description":"Option ID","maxLength":255,"title":"string","type":"string","x-stream-index":"003"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollOptionResponse"}}},"description":"Successful 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":"Get poll option","tags":["product:common"]}},"/api/v2/polls/{poll_id}/votes":{"post":{"description":"Queries votes\n","operationId":"QueryPollVotes","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryPollVotesRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollVotesResponse"}}},"description":"Successful 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":"Query votes","tags":["product:common"]}},"/api/v2/push_providers":{"get":{"description":"List details of all push providers.\n","operationId":"ListPushProviders","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPushProvidersResponse"}}},"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":"List push providers","tags":["product:common"]},"post":{"description":"Upsert a push provider for v2 with multi bundle/package support\n","operationId":"UpsertPushProvider","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertPushProviderRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertPushProviderResponse"}}},"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":"Upsert a push provider","tags":["product:common"]}},"/api/v2/push_providers/{type}/{name}":{"delete":{"description":"Delete a push provider from v2 with multi bundle/package support. v1 isn't supported in this endpoint\n","operationId":"DeletePushProvider","parameters":[{"in":"path","name":"type","required":true,"schema":{"enum":["apn","firebase","huawei","xiaomi"],"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"name","required":true,"schema":{"maxLength":36,"minLength":1,"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete a push provider","tags":["product:common"]}},"/api/v2/rate_limits":{"get":{"description":"Get rate limits usage and quotas\n","operationId":"GetRateLimits","parameters":[{"in":"query","name":"server_side","schema":{"description":"Whether to include server-side platform limits or not","title":"Server-side","type":"boolean","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"android","schema":{"description":"Whether to include Android platform limits or not","title":"Android","type":"boolean","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"ios","schema":{"description":"Whether to include iOS platform limits or not","title":"iOS","type":"boolean","writeOnly":true,"x-stream-index":"003"}},{"in":"query","name":"web","schema":{"description":"Whether to include web platform limits or not","title":"Web","type":"boolean","writeOnly":true,"x-stream-index":"004"}},{"in":"query","name":"endpoints","schema":{"description":"Specific endpoints to show limits for, as a comma-separated list of values","title":"Endpoints","type":"string","writeOnly":true,"x-stream-index":"005"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRateLimitsResponse"}}},"description":"Get Rate Limits 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":"Get rate limits","tags":["product:common"]}},"/api/v2/roles":{"get":{"description":"Lists all available roles\n","operationId":"ListRoles","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListRolesResponse"}}},"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":"List roles","tags":["product:common"]},"post":{"description":"Creates custom role\n","operationId":"CreateRole","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRoleRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRoleResponse"}}},"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":"Create role","tags":["product:common"]}},"/api/v2/roles/{name}":{"delete":{"description":"Deletes custom role\n","operationId":"DeleteRole","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Role name","title":"Name","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete role","tags":["product:common"]}},"/api/v2/tasks/{id}":{"get":{"description":"Gets status of a task\n","operationId":"GetTask","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Task ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetTaskResponse"}}},"description":"Get Task 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":"Get status of a task","tags":["product:common"]}},"/api/v2/uploads/file":{"delete":{"description":"Deletes previously uploaded file\n","operationId":"DeleteFileGlobal","parameters":[{"in":"query","name":"url","schema":{"description":"File URL to delete","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete file","tags":["product:common"],"x-stream-sdk-name":"DeleteFile"},"post":{"description":"Uploads file\n","operationId":"UploadFileGlobal","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/FileUploadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileUploadResponse"}}},"description":"Successful 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":"Upload file","tags":["product:common"],"x-stream-sdk-name":"UploadFile"}},"/api/v2/uploads/image":{"delete":{"description":"Deletes previously uploaded image\n","operationId":"DeleteImageGlobal","parameters":[{"in":"query","name":"url","schema":{"description":"File URL to delete","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete image","tags":["product:common"],"x-stream-sdk-name":"DeleteImage"},"post":{"description":"Uploads image\n","operationId":"UploadImageGlobal","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/ImageUploadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageUploadResponse"}}},"description":"Successful 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":"Upload image","tags":["product:common"],"x-stream-sdk-name":"UploadImage"}},"/api/v2/users":{"get":{"description":"Find and filter users\n","operationId":"QueryUsers","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryUsersPayload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryUsersResponse"}}},"description":"Successful 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":"Query users","tags":["product:common"]},"patch":{"description":"Updates certain fields of the user\n\nSends events:\n- user.presence.changed\n- user.updated\n- user.presence.changed\n","operationId":"UpdateUsersPartial","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersResponse"}}},"description":"Successful 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":"Partially update user","tags":["product:common"]},"post":{"description":"Update or create users in bulk\n\nSends events:\n- user.updated\n","operationId":"UpdateUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersResponse"}}},"description":"Successful 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":"Upsert users","tags":["product:common"]}},"/api/v2/users/block":{"get":{"description":"Get list of blocked Users\n","operationId":"GetBlockedUsers","parameters":[{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBlockedUsersResponse"}}},"description":"Successful 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":"Get list of blocked Users","tags":["product:common"]},"post":{"description":"Block users\n","operationId":"BlockUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUsersResponse"}}},"description":"Successful 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":"Block user","tags":["product:common"]}},"/api/v2/users/deactivate":{"post":{"description":"Deactivate users in batches\n\nSends events:\n- user.deactivated\n","operationId":"DeactivateUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeactivateUsersRequest"}}},"description":"DeactivateUsersRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeactivateUsersResponse"}}},"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":"Deactivate users","tags":["product:common"]}},"/api/v2/users/delete":{"post":{"description":"Deletes users and optionally all their belongings asynchronously.\n\nSends events:\n- channel.deleted\n- user.deleted\n","operationId":"DeleteUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteUsersResponse"}}},"description":"Successful 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":"Delete Users","tags":["product:common"]}},"/api/v2/users/live_locations":{"get":{"description":"Retrieves all active live locations for a user\n","operationId":"GetUserLiveLocations","parameters":[{"in":"query","name":"user_id","schema":{"description":"User ID to get live locations for. If not provided, returns live locations for the authenticated user.","title":"string","type":"string","writeOnly":true,"x-stream-index":"001.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SharedLocationsResponse"}}},"description":"Successful 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":"Get user live locations","tags":["product:common"]},"put":{"description":"Updates an existing live location with new coordinates or expiration time\n","operationId":"UpdateLiveLocation","parameters":[{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"005.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateLiveLocationRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SharedLocationResponse"}}},"description":"Successful 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":"Update live location","tags":["product:common"]}},"/api/v2/users/reactivate":{"post":{"description":"Reactivate users in batches\n\nSends events:\n- user.reactivated\n- user.reactivated\n","operationId":"ReactivateUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReactivateUsersRequest"}}},"description":"ReactivateUsersRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReactivateUsersResponse"}}},"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":"Reactivate users","tags":["product:common"]}},"/api/v2/users/restore":{"post":{"description":"Restore soft deleted users\n","operationId":"RestoreUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestoreUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Restore users","tags":["product:common"]}},"/api/v2/users/unblock":{"post":{"description":"Unblock users\n","operationId":"UnblockUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUsersResponse"}}},"description":"Successful 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":"Unblock user","tags":["product:common"]}},"/api/v2/users/{user_id}/deactivate":{"post":{"description":"Deactivates user with possibility to activate it back\n\nSends events:\n- user.deactivated\n","operationId":"DeactivateUser","parameters":[{"in":"path","name":"user_id","required":true,"schema":{"title":"User ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeactivateUserRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeactivateUserResponse"}}},"description":"Successful 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":"Deactivate user","tags":["product:common"]}},"/api/v2/users/{user_id}/export":{"get":{"description":"Exports the user's profile, reactions and messages. Raises an error if a user has more than 10k messages or reactions\n","operationId":"ExportUser","parameters":[{"in":"path","name":"user_id","required":true,"schema":{"title":"User ID","type":"string","x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportUserResponse"}}},"description":"Successful 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":"Export user","tags":["product:common"]}},"/api/v2/users/{user_id}/reactivate":{"post":{"description":"Activates user who's been deactivated previously\n\nSends events:\n- user.reactivated\n","operationId":"ReactivateUser","parameters":[{"in":"path","name":"user_id","required":true,"schema":{"title":"User ID","type":"string","x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReactivateUserRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReactivateUserResponse"}}},"description":"Successful 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":"Reactivate user","tags":["product:common"]}}},"security":[{"JWT":[],"api_key":[],"stream-auth-type":[]},{"api_key":[],"stream-auth-type":[]}],"servers":[{"description":"Stream API","url":"https://chat.stream-io-api.com"}]} \ No newline at end of file diff --git a/openapi/v2/feeds-serverside-api.yaml b/openapi/v2/feeds-serverside-api.yaml new file mode 100644 index 000000000..376922baa --- /dev/null +++ b/openapi/v2/feeds-serverside-api.yaml @@ -0,0 +1,26098 @@ +components: + schemas: + AIImageConfig: + properties: + async: + type: boolean + x-stream-index: "001" + enabled: + type: boolean + x-stream-index: "002" + ocr_rules: + items: + $ref: '#/components/schemas/OCRRule' + type: array + x-stream-index: "004" + rules: + items: + $ref: '#/components/schemas/AWSRekognitionRule' + type: array + x-stream-index: "003" + required: + - enabled + - rules + - ocr_rules + type: object + AITextConfig: + properties: + async: + type: boolean + x-stream-index: "001" + enabled: + type: boolean + x-stream-index: "002" + profile: + type: string + x-stream-index: "003" + rules: + items: + $ref: '#/components/schemas/BodyguardRule' + type: array + x-stream-index: "004" + severity_rules: + items: + $ref: '#/components/schemas/BodyguardSeverityRule' + type: array + x-stream-index: "005" + required: + - enabled + - profile + - rules + - severity_rules + type: object + AIVideoConfig: + properties: + async: + type: boolean + x-stream-index: "001" + enabled: + type: boolean + x-stream-index: "002" + rules: + items: + $ref: '#/components/schemas/AWSRekognitionRule' + type: array + x-stream-index: "003" + required: + - enabled + - rules + type: object + APIError: + nullable: true + properties: + StatusCode: + description: Response HTTP status code + format: int32 + title: Status code + type: integer + x-stream-index: "004" + code: + description: API error code + format: int32 + title: Code + type: integer + x-stream-index: "001" + details: + description: Additional error-specific information + items: + type: integer + title: Details + type: array + x-stream-index: "007" + duration: + description: Request duration + title: Duration + type: string + x-stream-index: "005" + exception_fields: + additionalProperties: + type: string + description: Additional error info + title: Exception fields + type: object + x-stream-index: "003" + message: + description: Message describing an error + title: Message + type: string + x-stream-index: "002" + more_info: + description: URL with additional information + title: More info + type: string + x-stream-index: "006" + unrecoverable: + description: Flag that indicates if the error is unrecoverable, requests + that return unrecoverable errors should not be retried, this error only + applies to the request that caused it + title: Unrecoverable + type: boolean + x-stream-index: "008" + required: + - code + - message + - StatusCode + - duration + - more_info + - details + title: Error response + type: object + APNConfig: + properties: + Disabled: + type: boolean + writeOnly: true + x-stream-index: "005" + auth_key: + type: string + x-stream-index: "006.001" + auth_type: + enum: + - certificate + - token + type: string + x-stream-index: "001" + bundle_id: + type: string + x-stream-index: "004" + development: + type: boolean + x-stream-index: "002" + host: + type: string + x-stream-index: "003" + key_id: + type: string + x-stream-index: "006.002" + notification_template: + type: string + x-stream-index: "008" + p12_cert: + type: string + x-stream-index: "007.001" + team_id: + type: string + x-stream-index: "006.003" + type: object + APNConfigFields: + properties: + auth_key: + type: string + x-stream-index: "009" + auth_type: + type: string + x-stream-index: "003" + bundle_id: + type: string + x-stream-index: "006" + development: + type: boolean + x-stream-index: "002" + enabled: + type: boolean + x-stream-index: "001" + host: + type: string + x-stream-index: "005" + key_id: + type: string + x-stream-index: "008" + notification_template: + type: string + x-stream-index: "004" + p12_cert: + type: string + x-stream-index: "010" + team_id: + type: string + x-stream-index: "007" + required: + - enabled + - development + type: object + APNS: + properties: + body: + type: string + x-stream-index: "002" + content-available: + format: int32 + type: integer + x-stream-index: "004" + data: + additionalProperties: {} + type: object + x-stream-index: "006" + mutable-content: + format: int32 + type: integer + x-stream-index: "005" + sound: + type: string + x-stream-index: "003" + title: + type: string + x-stream-index: "001" + required: + - title + - body + type: object + AWSRekognitionRule: + properties: + action: + enum: + - flag + - shadow + - remove + - bounce + - bounce_flag + - bounce_remove + type: string + x-stream-index: "002" + label: + type: string + x-stream-index: "001" + min_confidence: + format: float + maximum: 100 + minimum: 0 + type: number + x-stream-index: "003" + required: + - label + - action + - min_confidence + type: object + AcceptFeedMemberInviteRequest: + nullable: true + properties: + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "003.002" + user_id: + type: string + x-stream-index: "003.001" + title: Accept Feed Member Invite Request + type: object + AcceptFeedMemberInviteResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + member: + $ref: '#/components/schemas/FeedMemberResponse' + description: The feed member after accepting the invite + title: Feed Member + x-stream-index: "001" + required: + - member + - duration + title: Accept Feed Member Invite Response + type: object + AcceptFollowRequest: + nullable: true + properties: + follower_role: + description: Optional role for the follower in the follow relationship + title: Follower Role + type: string + x-stream-index: "003" + source: + description: Fully qualified ID of the source feed + maxLength: 255 + title: Source Feed ID + type: string + x-stream-index: "001" + target: + description: Fully qualified ID of the target feed + maxLength: 255 + title: Target Feed ID + type: string + x-stream-index: "002" + required: + - source + - target + title: Accept Follow Request + type: object + AcceptFollowResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + follow: + $ref: '#/components/schemas/FollowResponse' + description: The accepted follow relationship + title: Follow + x-stream-index: "001" + required: + - follow + - duration + title: Accept Follow Response + type: object + Action: + nullable: true + properties: + name: + type: string + x-stream-index: "001" + style: + type: string + x-stream-index: "003" + text: + type: string + x-stream-index: "002" + type: + type: string + x-stream-index: "004" + value: + type: string + x-stream-index: "005" + required: + - name + - text + - type + type: object + ActionLog: + nullable: true + properties: + created_at: + format: date-time + type: number + x-stream-index: "004" + custom: + additionalProperties: {} + type: object + x-stream-index: "010" + id: + type: string + x-stream-index: "002" + reason: + type: string + x-stream-index: "008" + reporter_type: + type: string + x-stream-index: "009" + review_queue_item: + $ref: '#/components/schemas/ReviewQueueItem' + x-stream-index: "014" + review_queue_item_id: + type: string + x-stream-index: "012" + target_user: + $ref: '#/components/schemas/User' + x-stream-index: "013" + target_user_id: + type: string + x-stream-index: "011" + type: + type: string + x-stream-index: "005" + user: + $ref: '#/components/schemas/User' + x-stream-index: "007" + required: + - id + - created_at + - type + - reason + - reporter_type + - custom + - target_user_id + - review_queue_item_id + type: object + ActionLogResponse: + nullable: true + properties: + created_at: + description: Timestamp when the action was taken + format: date-time + title: Created At + type: number + x-stream-index: "002" + custom: + additionalProperties: {} + description: Additional metadata about the action + title: Custom + type: object + x-stream-index: "007" + id: + description: Unique identifier of the action log + title: ID + type: string + x-stream-index: "001" + reason: + description: Reason for the moderation action + title: Reason + type: string + x-stream-index: "006" + review_queue_item: + $ref: '#/components/schemas/ReviewQueueItemResponse' + description: Associated review queue item + title: Review Queue Item + x-stream-index: "008" + target_user: + $ref: '#/components/schemas/UserResponse' + description: User who was the target of the action + title: Target User + x-stream-index: "009" + target_user_id: + description: ID of the user who was the target of the action + title: Target User ID + type: string + x-stream-index: "010" + type: + description: Type of moderation action + title: Type + type: string + x-stream-index: "003" + user: + $ref: '#/components/schemas/UserResponse' + description: User who performed the action + title: User + x-stream-index: "004" + user_id: + description: ID of the user who performed the action + title: User ID + type: string + x-stream-index: "005" + required: + - id + - created_at + - type + - user_id + - reason + - custom + - target_user_id + type: object + ActionSequence: + properties: + action: + type: string + x-stream-index: "001" + blur: + type: boolean + x-stream-index: "005" + cooldown_period: + format: int32 + type: integer + x-stream-index: "004" + threshold: + format: int32 + type: integer + x-stream-index: "002" + time_window: + format: int32 + type: integer + x-stream-index: "003" + warning: + type: boolean + x-stream-index: "006" + warning_text: + type: string + x-stream-index: "007" + required: + - action + - threshold + - time_window + - cooldown_period + - blur + - warning + - warning_text + type: object + ActivityAddedEvent: + description: Emitted when an activity is added to a feed. + nullable: true + properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + description: The activity that was added + title: Activity + x-stream-index: "001" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + feed_visibility: + type: string + x-stream-index: "002.003" + fid: + type: string + x-stream-index: "002.002" + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 + type: + default: feeds.activity.added + description: 'The type of event: "feeds.activity.added" in this case' + title: Event Type + type: string + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who added the activity + title: User + x-stream-index: "003.001" + required: + - activity + - type + - created_at + - custom + - fid + title: ActivityAddedEvent + 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 + ActivityDeletedEvent: + description: Emitted when an activity is deleted. + nullable: true + properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + description: The activity that was updated + title: Activity + x-stream-index: "001" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + feed_visibility: + type: string + x-stream-index: "002.003" + fid: + type: string + x-stream-index: "002.002" + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 + type: + default: feeds.activity.deleted + description: 'The type of event: "feeds.activity.deleted" in this case' + title: Event Type + type: string + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + x-stream-index: "003.001" + required: + - activity + - type + - created_at + - custom + - fid + title: ActivityDeletedEvent + 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 + ActivityFeedbackRequest: + description: Request to provide feedback on an activity + nullable: true + properties: + hide: + description: Whether to hide this activity + title: bool + type: boolean + x-stream-index: "003" + mute_user: + description: Whether to mute the user who created this activity + title: bool + type: boolean + x-stream-index: "005" + reason: + description: Reason for the feedback (optional) + maxLength: 1000 + title: string + type: string + x-stream-index: "006" + report: + description: Whether to report this activity + title: bool + type: boolean + x-stream-index: "004" + show_less: + description: Whether to show less content like this + title: bool + type: boolean + x-stream-index: "002" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "008.002" + user_id: + type: string + x-stream-index: "008.001" + title: Activity Feedback Request + type: object + ActivityFeedbackResponse: + description: Response for activity feedback submission + nullable: true + properties: + activity_id: + description: The ID of the activity that received feedback + title: string + type: string + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - activity_id + - duration + title: Activity Feedback Response + type: object + ActivityLocation: + properties: + lat: + description: Latitude coordinate + format: float + title: Latitude + type: number + x-stream-index: "001" + lng: + description: Longitude coordinate + format: float + title: Longitude + type: number + x-stream-index: "002" + required: + - lat + - lng + title: Activity Location + type: object + ActivityMarkEvent: + description: Emitted when activities are marked as read, seen, or watched. + nullable: true + properties: + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 006.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 006.001.007 + feed_visibility: + type: string + x-stream-index: "006.003" + fid: + type: string + x-stream-index: "006.002" + mark_all_read: + description: Whether all activities were marked as read + title: Mark All Read + type: boolean + x-stream-index: "004" + mark_all_seen: + description: Whether all activities were marked as seen + title: Mark All Seen + type: boolean + x-stream-index: "005" + mark_read: + description: The IDs of activities marked as read + items: + type: string + title: Mark Read + type: array + x-stream-index: "001" + mark_seen: + description: The IDs of activities marked as seen + items: + type: string + title: Mark Seen + type: array + x-stream-index: "002" + mark_watched: + description: The IDs of activities marked as watched + items: + type: string + title: Mark Watched + type: array + x-stream-index: "003" + received_at: + format: date-time + type: number + x-stream-index: 006.001.004 + type: + default: feeds.activity.marked + description: 'The type of event: "feeds.activity.marked" in this case' + title: Event Type + type: string + x-stream-index: 006.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who marked the activities + title: User + x-stream-index: "007.001" + required: + - type + - created_at + - custom + - fid + title: ActivityMarkEvent + 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 + ActivityPinResponse: + properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + description: The pinned activity + title: Activity + x-stream-index: "002" + created_at: + description: When the pin was created + format: date-time + title: Created At + type: number + x-stream-index: "004" + feed: + description: ID of the feed where activity is pinned + title: Feed ID + type: string + x-stream-index: "003" + updated_at: + description: When the pin was last updated + format: date-time + title: Updated At + type: number + x-stream-index: "005" + user: + $ref: '#/components/schemas/UserResponse' + description: User who pinned the activity + title: User + x-stream-index: "001" + required: + - user + - activity + - feed + - created_at + - updated_at + title: Activity Pin + type: object + ActivityPinnedEvent: + description: Emitted when an activity is pinned. + nullable: true + properties: + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + feed_visibility: + type: string + x-stream-index: "002.003" + fid: + description: The ID of the feed + title: Feed ID + type: string + x-stream-index: "002.002" + pinned_activity: + $ref: '#/components/schemas/PinActivityResponse' + x-stream-index: "001" + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 + type: + default: feeds.activity.pinned + description: 'The type of event: "feeds.activity.pinned" in this case' + title: Event Type + type: string + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who pinned the activity + title: User + x-stream-index: "003.001" + required: + - pinned_activity + - type + - created_at + - custom + - fid + title: ActivityPinnedEvent + 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 + ActivityProcessorConfig: + properties: + type: + description: Type of activity processor (required) + title: Type + type: string + x-stream-index: "001" + required: + - type + title: Activity Processor Configuration + type: object + ActivityReactionAddedEvent: + description: Emitted when a reaction is added to an activity. + nullable: true + properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + x-stream-index: "001" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 003.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 003.001.007 + feed_visibility: + type: string + x-stream-index: "003.003" + fid: + type: string + x-stream-index: "003.002" + reaction: + $ref: '#/components/schemas/FeedsReactionResponse' + description: The reaction that was added + title: Reaction + x-stream-index: "002" + received_at: + format: date-time + type: number + x-stream-index: 003.001.004 + type: + default: feeds.activity.reaction.added + description: 'The type of event: "feeds.activity.reaction.added" in this + case' + title: Event Type + type: string + x-stream-index: 003.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who added the reaction + title: User + x-stream-index: "004.001" + required: + - activity + - reaction + - type + - created_at + - custom + - fid + title: ActivityReactionAddedEvent + 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 + ActivityReactionDeletedEvent: + description: Emitted when a reaction is deleted from an activity. + nullable: true + properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + x-stream-index: "001" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 003.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 003.001.007 + feed_visibility: + type: string + x-stream-index: "003.003" + fid: + type: string + x-stream-index: "003.002" + reaction: + $ref: '#/components/schemas/FeedsReactionResponse' + x-stream-index: "002" + received_at: + format: date-time + type: number + x-stream-index: 003.001.004 + type: + default: feeds.activity.reaction.deleted + description: The type of the reaction that was removed + title: Type + type: string + x-stream-index: 003.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who removed the reaction + title: User + x-stream-index: "004.001" + required: + - activity + - reaction + - type + - created_at + - custom + - fid + title: ActivityReactionDeletedEvent + 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 + ActivityReactionUpdatedEvent: + description: Emitted when a reaction is updated on an activity. + nullable: true + properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + x-stream-index: "001" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 003.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 003.001.007 + feed_visibility: + type: string + x-stream-index: "003.003" + fid: + type: string + x-stream-index: "003.002" + reaction: + $ref: '#/components/schemas/FeedsReactionResponse' + description: The reaction that was updated + title: Reaction + x-stream-index: "002" + received_at: + format: date-time + type: number + x-stream-index: 003.001.004 + type: + default: feeds.activity.reaction.updated + description: 'The type of event: "feeds.activity.reaction.updated" in this + case' + title: Event Type + type: string + x-stream-index: 003.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who updated the reaction + title: User + x-stream-index: "004.001" + required: + - activity + - reaction + - type + - created_at + - custom + - fid + title: ActivityReactionUpdatedEvent + 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 + ActivityRemovedFromFeedEvent: + description: Emitted when an activity is removed from a feed. + nullable: true + properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + x-stream-index: "001" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + feed_visibility: + type: string + x-stream-index: "002.003" + fid: + type: string + x-stream-index: "002.002" + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 + type: + default: feeds.activity.removed_from_feed + description: 'The type of event: "feeds.activity.removed_from_feed" in this + case' + title: Event Type + type: string + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who removed the activity + title: User + x-stream-index: "003.001" + required: + - activity + - type + - created_at + - custom + - fid + title: ActivityRemovedFromFeedEvent + 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 + ActivityRequest: + properties: + attachments: + description: List of attachments for the activity + items: + $ref: '#/components/schemas/Attachment' + title: Attachments + type: array + x-stream-index: "006" + custom: + additionalProperties: {} + description: Custom data for the activity + title: Custom Data + type: object + x-stream-index: "017" + expires_at: + description: Expiration time for the activity + title: Expires At + type: string + x-stream-index: "010" + feeds: + description: List of feed IDs to add the activity to + items: + type: string + maximum: 255 + minimum: 1 + title: Feed IDs + type: array + x-stream-index: "004" + filter_tags: + description: Tags for filtering activities + items: + type: string + maximum: 255 + title: Filter Tags + type: array + x-stream-index: "013" + id: + description: Optional ID for the activity + maxLength: 255 + title: Activity ID + type: string + x-stream-index: "001" + interest_tags: + description: Tags for indicating user interests + items: + type: string + maximum: 255 + title: Interest Tags + type: array + x-stream-index: "014" + location: + $ref: '#/components/schemas/ActivityLocation' + description: Geographic location related to the activity + title: Location + x-stream-index: "009" + mentioned_user_ids: + description: List of users mentioned in the activity + items: + type: string + maximum: 255 + title: Mentioned User IDs + type: array + x-stream-index: "011" + parent_id: + description: ID of parent activity for replies/comments + maxLength: 255 + title: Parent ID + type: string + x-stream-index: "015" + poll_id: + description: ID of a poll to attach to activity + title: Poll ID + type: string + x-stream-index: "016" + search_data: + additionalProperties: {} + description: Additional data for search indexing + title: Search Data + type: object + x-stream-index: "012" + text: + description: Text content of the activity + title: Text + type: string + x-stream-index: "005" + type: + description: Type of activity + maxLength: 255 + title: Activity Type + type: string + x-stream-index: "002" + user_id: + description: ID of the user creating the activity + maxLength: 255 + title: User ID + type: string + x-stream-index: "003" + visibility: + description: Visibility setting for the activity + enum: + - public + - private + - tag + title: Visibility + type: string + x-stream-index: "007" + visibility_tag: + description: If visibility is 'tag', this is the tag name and is required + maxLength: 32 + title: Visibility Tag + type: string + x-stream-index: "008" + required: + - type + - feeds + title: Activity Request + type: object + ActivityResponse: + properties: + attachments: + description: Media attachments for the activity + items: + $ref: '#/components/schemas/Attachment' + title: Attachments + type: array + x-stream-index: "009" + bookmark_count: + description: Number of bookmarks on the activity + format: int32 + title: Bookmark Count + type: integer + x-stream-index: "028" + comment_count: + description: Number of comments on the activity + format: int32 + title: Comment Count + type: integer + x-stream-index: "027" + comments: + description: Comments on this activity + items: + $ref: '#/components/schemas/CommentResponse' + title: Comments + type: array + x-stream-index: "015" + created_at: + description: When the activity was created + format: date-time + title: Created At + type: number + x-stream-index: "007" + current_feed: + $ref: '#/components/schemas/FeedResponse' + description: Feed context for this activity view. If an activity is added + only to one feed, it's always set. If an activity is added to multiple + feeds, it's only set when calling the GetOrCreateFeed endpoint. + title: Current Feed + x-stream-index: "035" + custom: + additionalProperties: {} + description: Custom data for the activity + title: Custom Data + type: object + x-stream-index: "011" + deleted_at: + description: When the activity was deleted + format: date-time + title: Deleted At + type: number + x-stream-index: "021" + edited_at: + description: When the activity was last edited + format: date-time + title: Edited At + type: number + x-stream-index: "020" + expires_at: + description: When the activity will expire + format: date-time + title: Expires At + type: number + x-stream-index: "022" + feeds: + description: List of feed IDs containing this activity + items: + type: string + title: Feeds + type: array + x-stream-index: "004" + filter_tags: + description: Tags for filtering + items: + type: string + title: Filter Tags + type: array + x-stream-index: "024" + hidden: + description: If this activity is hidden for this user. For premium content + where you want to show a preview + title: Hidden + type: boolean + x-stream-index: "036" + id: + description: Unique identifier for the activity + title: ID + type: string + x-stream-index: "001" + interest_tags: + description: Tags for user interests + items: + type: string + title: Interest Tags + type: array + x-stream-index: "025" + latest_reactions: + description: Recent reactions to the activity + items: + $ref: '#/components/schemas/FeedsReactionResponse' + title: Latest Reactions + type: array + x-stream-index: "031" + location: + $ref: '#/components/schemas/ActivityLocation' + description: Geographic location related to the activity + title: Location + x-stream-index: "017" + mentioned_users: + description: Users mentioned in the activity + items: + $ref: '#/components/schemas/UserResponse' + title: Mentioned Users + type: array + x-stream-index: "010" + moderation: + $ref: '#/components/schemas/ModerationV2Response' + description: Moderation information + title: Moderation + x-stream-index: "026" + notification_context: + additionalProperties: {} + description: Notification context data for the activity (if this is a reaction, + comment, follow, etc.) + title: Notification Context + type: object + x-stream-index: "012" + own_bookmarks: + description: Current user's bookmarks for this activity + items: + $ref: '#/components/schemas/BookmarkResponse' + title: Own Bookmarks + type: array + x-stream-index: "034" + own_reactions: + description: Current user's reactions to this activity + items: + $ref: '#/components/schemas/FeedsReactionResponse' + title: Own Reactions + type: array + x-stream-index: "033" + parent: + $ref: '#/components/schemas/ActivityResponse' + description: Parent activity (if this is a reply/comment) + title: Parent + x-stream-index: "018" + poll: + $ref: '#/components/schemas/PollResponseData' + description: Poll attached to this activity + title: Poll + x-stream-index: "019" + popularity: + description: Popularity score of the activity + format: int32 + title: Popularity + type: integer + x-stream-index: "013" + reaction_count: + description: Number of reactions to the activity + format: int32 + title: Reaction Count + type: integer + x-stream-index: "030" + reaction_groups: + additionalProperties: + $ref: '#/components/schemas/ReactionGroupResponse' + description: Grouped reactions by type + title: Reaction Groups + type: object + x-stream-index: "032" + score: + description: Ranking score for this activity + format: float + title: Score + type: number + x-stream-index: "014" + search_data: + additionalProperties: {} + description: Data for search indexing + title: Search Data + type: object + x-stream-index: "023" + share_count: + description: Number of times the activity was shared + format: int32 + title: Share Count + type: integer + x-stream-index: "029" + text: + description: Text content of the activity + title: Text + type: string + x-stream-index: "016" + type: + description: Type of activity + title: Type + type: string + x-stream-index: "002" + updated_at: + description: When the activity was last updated + format: date-time + title: Updated At + type: number + x-stream-index: "008" + user: + $ref: '#/components/schemas/UserResponse' + description: User who created the activity + title: User + x-stream-index: "003" + visibility: + description: Visibility setting for the activity + enum: + - public + - private + - tag + title: Visibility + type: string + x-stream-index: "005" + visibility_tag: + description: If visibility is 'tag', this is the tag name + title: Visibility Tag + type: string + x-stream-index: "006" + required: + - id + - type + - user + - feeds + - visibility + - created_at + - updated_at + - attachments + - mentioned_users + - custom + - popularity + - score + - comments + - search_data + - filter_tags + - interest_tags + - comment_count + - bookmark_count + - share_count + - reaction_count + - latest_reactions + - reaction_groups + - own_reactions + - own_bookmarks + title: Base Activity + type: object + ActivitySelectorConfig: + properties: + cutoff_time: + description: Time threshold for activity selection + format: date-time + title: Cutoff Time + type: number + x-stream-index: "004" + filter: + additionalProperties: {} + description: Filter for activity selection + title: Filter + type: object + x-stream-index: "002" + min_popularity: + description: Minimum popularity threshold + format: int32 + title: Minimum Popularity + type: integer + x-stream-index: "005" + sort: + description: Sort parameters for activity selection + items: + $ref: '#/components/schemas/SortParam' + title: Sort + type: array + x-stream-index: "003" + type: + description: Type of selector + title: Type + type: string + x-stream-index: "001" + title: Activity Selector Configuration + type: object + ActivityUnpinnedEvent: + description: Emitted when an activity is unpinned. + nullable: true + properties: + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + feed_visibility: + type: string + x-stream-index: "002.003" + fid: + description: The ID of the feed + title: Feed ID + type: string + x-stream-index: "002.002" + pinned_activity: + $ref: '#/components/schemas/PinActivityResponse' + x-stream-index: "001" + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 + type: + default: feeds.activity.unpinned + description: 'The type of event: "feeds.activity.unpinned" in this case' + title: Event Type + type: string + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who unpinned the activity + title: User + x-stream-index: "003.001" + required: + - pinned_activity + - type + - created_at + - custom + - fid + title: ActivityUnpinnedEvent + 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 + ActivityUpdatedEvent: + description: Emitted when an activity is updated. + nullable: true + properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + description: The activity that was updated + title: Activity + x-stream-index: "001" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + feed_visibility: + type: string + x-stream-index: "002.003" + fid: + type: string + x-stream-index: "002.002" + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 + type: + default: feeds.activity.updated + description: The type of the event + title: Event Type + type: string + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who updated the activity + title: User + x-stream-index: "003.001" + required: + - activity + - type + - created_at + - custom + - fid + title: ActivityUpdatedEvent + 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 + AddActivityRequest: + nullable: true + properties: + attachments: + description: List of attachments for the activity + items: + $ref: '#/components/schemas/Attachment' + title: Attachments + type: array + x-stream-index: "001.006" + custom: + additionalProperties: {} + description: Custom data for the activity + title: Custom Data + type: object + x-stream-index: "001.017" + expires_at: + description: Expiration time for the activity + title: Expires At + type: string + x-stream-index: "001.010" + feeds: + description: List of feed IDs to add the activity to + items: + type: string + maximum: 255 + minimum: 1 + title: Feed IDs + type: array + x-stream-index: "001.004" + filter_tags: + description: Tags for filtering activities + items: + type: string + maximum: 255 + title: Filter Tags + type: array + x-stream-index: "001.013" + id: + description: Optional ID for the activity + maxLength: 255 + title: Activity ID + type: string + x-stream-index: "001.001" + interest_tags: + description: Tags for indicating user interests + items: + type: string + maximum: 255 + title: Interest Tags + type: array + x-stream-index: "001.014" + location: + $ref: '#/components/schemas/ActivityLocation' + description: Geographic location related to the activity + title: Location + x-stream-index: "001.009" + mentioned_user_ids: + description: List of users mentioned in the activity + items: + type: string + maximum: 255 + title: Mentioned User IDs + type: array + x-stream-index: "001.011" + parent_id: + description: ID of parent activity for replies/comments + maxLength: 255 + title: Parent ID + type: string + x-stream-index: "001.015" + poll_id: + description: ID of a poll to attach to activity + title: Poll ID + type: string + x-stream-index: "001.016" + search_data: + additionalProperties: {} + description: Additional data for search indexing + title: Search Data + type: object + x-stream-index: "001.012" + text: + description: Text content of the activity + title: Text + type: string + x-stream-index: "001.005" + type: + description: Type of activity + maxLength: 255 + title: Activity Type + type: string + x-stream-index: "001.002" + user_id: + description: ID of the user creating the activity + maxLength: 255 + title: User ID + type: string + x-stream-index: "001.003" + visibility: + description: Visibility setting for the activity + enum: + - public + - private + - tag + title: Visibility + type: string + x-stream-index: "001.007" + visibility_tag: + description: If visibility is 'tag', this is the tag name and is required + maxLength: 32 + title: Visibility Tag + type: string + x-stream-index: "001.008" + required: + - type + - feeds + title: Activity Request + type: object + AddActivityResponse: + nullable: true + properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + description: The created activity + title: Activity + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - activity + - duration + title: Add Activity Response + type: object + AddBookmarkRequest: + nullable: true + properties: + custom: + additionalProperties: {} + description: Custom data for the bookmark + title: Custom Data + type: object + x-stream-index: "004" + folder_id: + description: ID of the folder to add the bookmark to + maxLength: 255 + title: Folder ID + type: string + x-stream-index: "002" + new_folder: + $ref: '#/components/schemas/AddFolderRequest' + description: Create a new folder for this bookmark + title: New Folder + x-stream-index: "003" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "005.002" + user_id: + type: string + x-stream-index: "005.001" + title: Add Bookmark Request + type: object + AddBookmarkResponse: + nullable: true + properties: + bookmark: + $ref: '#/components/schemas/BookmarkResponse' + description: The created bookmark + title: Bookmark + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - bookmark + - duration + title: Add Bookmark Response + type: object + AddCommentReactionRequest: + nullable: true + properties: + create_notification_activity: + description: Whether to create a notification activity for this reaction + title: boolean + type: boolean + x-stream-index: "004" + custom: + additionalProperties: {} + description: Optional custom data to add to the reaction + title: object + type: object + x-stream-index: "003" + skip_push: + type: boolean + x-stream-index: "005" + type: + description: The type of reaction, eg upvote, like, ... + maxLength: 255 + title: string + type: string + x-stream-index: "002" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "007.002" + user_id: + type: string + x-stream-index: "007.001" + required: + - type + type: object + AddCommentReactionResponse: + nullable: true + properties: + comment: + $ref: '#/components/schemas/CommentResponse' + description: The comment the reaction was added to + title: object + x-stream-index: "001" + duration: + description: Duration of the request + title: string + type: string + x-stream-index: "003.001" + reaction: + $ref: '#/components/schemas/FeedsReactionResponse' + description: The created or updated reaction + title: object + x-stream-index: "002" + required: + - comment + - reaction + - duration + type: object + AddCommentRequest: + nullable: true + properties: + attachments: + description: Media attachments for the reply + items: + $ref: '#/components/schemas/Attachment' + title: Attachments + type: array + x-stream-index: "004" + comment: + description: Text content of the comment + title: Comment + type: string + x-stream-index: "003" + create_notification_activity: + description: Whether to create a notification activity for this comment + title: Create Notification Activity + type: boolean + x-stream-index: "008" + custom: + additionalProperties: {} + description: Custom data for the comment + title: Custom Data + type: object + x-stream-index: "007" + mentioned_user_ids: + description: List of users mentioned in the reply + items: + type: string + maximum: 255 + title: Mentioned User IDs + type: array + x-stream-index: "005" + object_id: + description: ID of the object to comment on + title: Object ID + type: string + x-stream-index: "001" + object_type: + description: Type of the object to comment on + title: Object Type + type: string + x-stream-index: "002" + parent_id: + description: ID of parent comment for replies + title: Parent ID + type: string + x-stream-index: "006" + skip_push: + type: boolean + x-stream-index: "009" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "010.002" + user_id: + type: string + x-stream-index: "010.001" + required: + - object_id + - object_type + - comment + title: Add Comment Request + type: object + AddCommentResponse: + nullable: true + properties: + comment: + $ref: '#/components/schemas/CommentResponse' + description: The created comment + title: Comment + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - comment + - duration + title: Add Comment Response + type: object + AddCommentsBatchRequest: + nullable: true + properties: + comments: + description: List of comments to add + items: + $ref: '#/components/schemas/AddCommentRequest' + title: Comments + type: array + x-stream-index: "001" + required: + - comments + title: Add Comments Batch Request + type: object + AddCommentsBatchResponse: + nullable: true + properties: + comments: + description: List of comments added + items: + $ref: '#/components/schemas/CommentResponse' + title: Comments + type: array + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - comments + - duration + title: Add Comments Batch Response + type: object + AddFolderRequest: + properties: + custom: + additionalProperties: {} + description: Custom data for the folder + title: Custom Data + type: object + x-stream-index: "002" + name: + description: Name of the folder + maxLength: 255 + title: Name + type: string + x-stream-index: "001" + required: + - name + title: Add Folder Request + type: object + AddReactionRequest: + nullable: true + properties: + create_notification_activity: + description: Whether to create a notification activity for this reaction + title: Create Notification Activity + type: boolean + x-stream-index: "004" + custom: + additionalProperties: {} + description: Custom data for the reaction + title: Custom Data + type: object + x-stream-index: "003" + skip_push: + type: boolean + x-stream-index: "005" + type: + description: Type of reaction + maxLength: 255 + title: Reaction Type + type: string + x-stream-index: "002" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "006.002" + user_id: + type: string + x-stream-index: "006.001" + required: + - type + title: Add Reaction Request + type: object + AddReactionResponse: + nullable: true + properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + x-stream-index: "001" + duration: + type: string + x-stream-index: "003.001" + reaction: + $ref: '#/components/schemas/FeedsReactionResponse' + description: The created reaction + title: Reaction + x-stream-index: "002" + required: + - activity + - reaction + - duration + title: Add Reaction Response + type: object + AggregatedActivityResponse: + properties: + activities: + description: List of activities in this aggregation + items: + $ref: '#/components/schemas/ActivityResponse' + title: Activities + type: array + x-stream-index: "001" + activity_count: + description: Number of activities in this aggregation + format: int32 + title: Activity Count + type: integer + x-stream-index: "002" + created_at: + description: When the aggregation was created + format: date-time + title: Created At + type: number + x-stream-index: "006" + group: + description: Grouping identifier + title: Group + type: string + x-stream-index: "004" + score: + description: Ranking score for this aggregation + format: float + title: Score + type: number + x-stream-index: "005" + updated_at: + description: When the aggregation was last updated + format: date-time + title: Updated At + type: number + x-stream-index: "007" + user_count: + description: Number of unique users in this aggregation + format: int32 + title: User Count + type: integer + x-stream-index: "003" + required: + - activities + - activity_count + - user_count + - group + - score + - created_at + - updated_at + title: Aggregated Activity + type: object + AggregationConfig: + properties: + format: + description: Format for activity aggregation + title: Format + type: string + x-stream-index: "001" + title: Aggregation Configuration + type: object + AppResponseFields: + properties: + allowed_flag_reasons: + items: + type: string + type: array + x-stream-index: "019" + async_url_enrich_enabled: + type: boolean + x-stream-index: "017" + auto_translation_enabled: + type: boolean + x-stream-index: "020" + before_message_send_hook_url: + type: string + x-stream-index: "021" + call_types: + additionalProperties: + $ref: '#/components/schemas/CallType' + type: object + x-stream-index: "007" + campaign_enabled: + type: boolean + x-stream-index: "034" + cdn_expiration_seconds: + format: int32 + type: integer + x-stream-index: "037" + channel_configs: + additionalProperties: + $ref: '#/components/schemas/ChannelConfig' + type: object + x-stream-index: "006" + custom_action_handler_url: + type: string + x-stream-index: "022" + datadog_info: + $ref: '#/components/schemas/DataDogInfo' + x-stream-index: "040" + disable_auth_checks: + type: boolean + x-stream-index: "011" + disable_permissions_checks: + type: boolean + x-stream-index: "012" + enforce_unique_usernames: + type: string + x-stream-index: "023" + event_hooks: + items: + $ref: '#/components/schemas/EventHook' + type: array + x-stream-index: "045" + file_upload_config: + $ref: '#/components/schemas/FileUploadConfig' + x-stream-index: "030" + geofences: + items: + $ref: '#/components/schemas/GeofenceResponse' + type: array + x-stream-index: "039" + grants: + additionalProperties: + items: + type: string + type: array + type: object + x-stream-index: "033" + guest_user_creation_disabled: + type: boolean + x-stream-index: "043" + image_moderation_enabled: + type: boolean + x-stream-index: "016" + image_moderation_labels: + items: + type: string + type: array + x-stream-index: "018" + image_upload_config: + $ref: '#/components/schemas/FileUploadConfig' + x-stream-index: "031" + moderation_bulk_submit_action_enabled: + type: boolean + x-stream-index: "048" + moderation_dashboard_preferences: + $ref: '#/components/schemas/ModerationDashboardPreferences' + x-stream-index: "044" + moderation_enabled: + type: boolean + x-stream-index: "041" + moderation_llm_configurability_enabled: + type: boolean + x-stream-index: "049" + moderation_multitenant_blocklist_enabled: + type: boolean + x-stream-index: "042" + moderation_webhook_url: + type: string + x-stream-index: "005" + multi_tenant_enabled: + type: boolean + x-stream-index: "015" + name: + type: string + x-stream-index: "001" + organization: + type: string + x-stream-index: "002" + permission_version: + type: string + x-stream-index: "013" + policies: + additionalProperties: + items: + $ref: '#/components/schemas/Policy' + type: array + type: object + x-stream-index: "008" + push_notifications: + $ref: '#/components/schemas/PushNotificationFields' + x-stream-index: "003" + reminders_interval: + format: int32 + type: integer + x-stream-index: "036" + revoke_tokens_issued_before: + format: date-time + type: number + x-stream-index: "032" + sns_key: + type: string + x-stream-index: "028" + sns_secret: + type: string + x-stream-index: "029" + sns_topic_arn: + type: string + x-stream-index: "027" + sqs_key: + type: string + x-stream-index: "025" + sqs_secret: + type: string + x-stream-index: "026" + sqs_url: + type: string + x-stream-index: "024" + suspended: + type: boolean + x-stream-index: "009" + suspended_explanation: + type: string + x-stream-index: "010" + use_hook_v2: + type: boolean + x-stream-index: "046" + user_response_time_enabled: + type: boolean + x-stream-index: "047" + user_search_disallowed_roles: + items: + type: string + type: array + x-stream-index: "014" + webhook_events: + items: + type: string + type: array + x-stream-index: "035" + webhook_url: + type: string + x-stream-index: "004" + required: + - name + - organization + - push_notifications + - webhook_url + - moderation_webhook_url + - channel_configs + - call_types + - policies + - suspended + - suspended_explanation + - disable_auth_checks + - disable_permissions_checks + - permission_version + - user_search_disallowed_roles + - multi_tenant_enabled + - image_moderation_enabled + - async_url_enrich_enabled + - auto_translation_enabled + - custom_action_handler_url + - enforce_unique_usernames + - sqs_url + - sqs_key + - sqs_secret + - sns_topic_arn + - sns_key + - sns_secret + - file_upload_config + - image_upload_config + - grants + - campaign_enabled + - webhook_events + - reminders_interval + - cdn_expiration_seconds + - video_provider + - moderation_enabled + - moderation_multitenant_blocklist_enabled + - guest_user_creation_disabled + - event_hooks + - use_hook_v2 + - user_response_time_enabled + - moderation_bulk_submit_action_enabled + - moderation_llm_configurability_enabled + type: object + AsyncBulkImageModerationEvent: + nullable: true + properties: + created_at: + format: date-time + type: number + x-stream-index: "003.003" + custom: + additionalProperties: {} + type: object + x-stream-index: "003.007" + finished_at: + format: date-time + type: number + x-stream-index: "002.003" + received_at: + format: date-time + type: number + x-stream-index: "003.004" + started_at: + format: date-time + type: number + x-stream-index: "002.002" + task_id: + type: string + x-stream-index: "002.001" + type: + default: export.bulk_image_moderation.success + type: string + x-stream-index: "003.002" + url: + type: string + x-stream-index: "001" + required: + - url + - task_id + - started_at + - finished_at + - type + - created_at + - custom + title: AsyncBulkImageModerationEvent + 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 + AsyncExportErrorEvent: + nullable: true + properties: + created_at: + format: date-time + type: number + x-stream-index: "003.003" + custom: + additionalProperties: {} + type: object + x-stream-index: "003.007" + error: + type: string + x-stream-index: "001" + finished_at: + format: date-time + type: number + x-stream-index: "002.003" + received_at: + format: date-time + type: number + x-stream-index: "003.004" + started_at: + format: date-time + type: number + x-stream-index: "002.002" + task_id: + type: string + x-stream-index: "002.001" + type: + default: export.bulk_image_moderation.error + type: string + x-stream-index: "003.002" + required: + - error + - task_id + - started_at + - finished_at + - type + - created_at + - custom + title: AsyncExportErrorEvent + 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 + AsyncExportModerationLogsEvent: + nullable: true + properties: + created_at: + format: date-time + type: number + x-stream-index: "003.003" + custom: + additionalProperties: {} + type: object + x-stream-index: "003.007" + finished_at: + format: date-time + type: number + x-stream-index: "002.003" + received_at: + format: date-time + type: number + x-stream-index: "003.004" + started_at: + format: date-time + type: number + x-stream-index: "002.002" + task_id: + type: string + x-stream-index: "002.001" + type: + default: export.moderation_logs.success + type: string + x-stream-index: "003.002" + url: + type: string + x-stream-index: "001" + required: + - url + - task_id + - started_at + - finished_at + - type + - created_at + - custom + title: AsyncExportModerationLogsEvent + 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 + AsyncModerationCallbackConfig: + properties: + mode: + enum: + - CALLBACK_MODE_NONE + - CALLBACK_MODE_REST + - CALLBACK_MODE_TWIRP + type: string + x-stream-index: "002" + server_url: + type: string + x-stream-index: "001" + type: object + AsyncModerationConfiguration: + properties: + callback: + $ref: '#/components/schemas/AsyncModerationCallbackConfig' + x-stream-index: "002" + timeout_ms: + format: int32 + type: integer + x-stream-index: "001" + type: object + Attachment: + description: An attachment is a message object that represents a file uploaded + by a user. + nullable: true + properties: + actions: + items: + $ref: '#/components/schemas/Action' + type: array + x-stream-index: "015" + asset_url: + type: string + x-stream-index: "017" + author_icon: + type: string + x-stream-index: "007" + author_link: + type: string + x-stream-index: "006" + author_name: + type: string + x-stream-index: "005" + color: + type: string + x-stream-index: "003" + custom: + additionalProperties: {} + type: object + x-stream-index: "018" + fallback: + type: string + x-stream-index: "002" + fields: + items: + $ref: '#/components/schemas/Field' + type: array + x-stream-index: "016" + footer: + type: string + x-stream-index: "013" + footer_icon: + type: string + x-stream-index: "014" + giphy: + $ref: '#/components/schemas/Images' + x-stream-index: "019" + image_url: + type: string + x-stream-index: "011" + og_scrape_url: + type: string + x-stream-index: "020" + original_height: + format: int32 + type: integer + x-stream-index: "022" + original_width: + format: int32 + type: integer + x-stream-index: "021" + pretext: + type: string + x-stream-index: "004" + text: + type: string + x-stream-index: "010" + thumb_url: + type: string + x-stream-index: "012" + title: + type: string + x-stream-index: "008" + title_link: + type: string + x-stream-index: "009" + type: + description: Attachment type (e.g. image, video, url) + title: Type + type: string + x-stream-index: "001" + required: + - custom + title: Attachment + type: object + x-stream-docs-page-id: file_uploads + AudioSettings: + properties: + access_request_enabled: + type: boolean + x-stream-index: "001" + default_device: + enum: + - speaker + - earpiece + type: string + x-stream-index: "006" + mic_default_on: + type: boolean + x-stream-index: "004" + noise_cancellation: + $ref: '#/components/schemas/NoiseCancellationSettings' + x-stream-index: "007" + opus_dtx_enabled: + type: boolean + x-stream-index: "002" + redundant_coding_enabled: + type: boolean + x-stream-index: "003" + speaker_default_on: + type: boolean + x-stream-index: "005" + required: + - access_request_enabled + - opus_dtx_enabled + - redundant_coding_enabled + - mic_default_on + - speaker_default_on + - default_device + type: object + AudioSettingsResponse: + properties: + access_request_enabled: + type: boolean + x-stream-index: "001" + default_device: + enum: + - speaker + - earpiece + type: string + x-stream-index: "006" + mic_default_on: + type: boolean + x-stream-index: "004" + noise_cancellation: + $ref: '#/components/schemas/NoiseCancellationSettings' + x-stream-index: "007" + opus_dtx_enabled: + type: boolean + x-stream-index: "002" + redundant_coding_enabled: + type: boolean + x-stream-index: "003" + speaker_default_on: + type: boolean + x-stream-index: "005" + required: + - access_request_enabled + - opus_dtx_enabled + - redundant_coding_enabled + - mic_default_on + - speaker_default_on + - default_device + type: object + AutomodPlatformCircumventionConfig: + properties: + async: + type: boolean + x-stream-index: "001" + enabled: + type: boolean + x-stream-index: "002" + rules: + items: + $ref: '#/components/schemas/AutomodRule' + type: array + x-stream-index: "003" + required: + - enabled + - rules + type: object + AutomodRule: + properties: + action: + enum: + - flag + - shadow + - remove + - bounce + - bounce_flag + - bounce_remove + type: string + x-stream-index: "003" + label: + type: string + x-stream-index: "001" + threshold: + format: float + maximum: 1 + minimum: 0 + type: number + x-stream-index: "002" + required: + - label + - threshold + - action + type: object + AutomodSemanticFiltersConfig: + properties: + async: + type: boolean + x-stream-index: "001" + enabled: + type: boolean + x-stream-index: "002" + rules: + items: + $ref: '#/components/schemas/AutomodSemanticFiltersRule' + type: array + x-stream-index: "003" + required: + - enabled + - rules + type: object + AutomodSemanticFiltersRule: + properties: + action: + enum: + - flag + - shadow + - remove + type: string + x-stream-index: "003" + name: + type: string + x-stream-index: "001" + threshold: + format: float + maximum: 1 + minimum: 0 + type: number + x-stream-index: "002" + required: + - name + - threshold + - action + type: object + AutomodToxicityConfig: + properties: + async: + type: boolean + x-stream-index: "001" + enabled: + type: boolean + x-stream-index: "002" + rules: + items: + $ref: '#/components/schemas/AutomodRule' + type: array + x-stream-index: "003" + required: + - enabled + - rules + type: object + AzureRequest: + description: Config for creating Azure Blob Storage storage + properties: + abs_account_name: + description: The account name + title: AccountName + type: string + x-stream-index: "001" + abs_client_id: + description: The client id + title: ClientID + type: string + x-stream-index: "003" + abs_client_secret: + description: The client secret + title: ClientSecret + type: string + x-stream-index: "004" + abs_tenant_id: + description: The tenant id + title: TenantID + type: string + x-stream-index: "002" + required: + - abs_account_name + - abs_tenant_id + - abs_client_id + - abs_client_secret + title: AzureRequest + type: object + BackstageSettings: + properties: + enabled: + type: boolean + x-stream-index: "001" + join_ahead_time_seconds: + format: int32 + type: integer + x-stream-index: "002" + required: + - enabled + type: object + BackstageSettingsResponse: + properties: + enabled: + type: boolean + x-stream-index: "001" + join_ahead_time_seconds: + format: int32 + type: integer + x-stream-index: "002" + required: + - enabled + type: object + Ban: + nullable: true + properties: + channel: + $ref: '#/components/schemas/Channel' + x-stream-index: "004" + created_at: + format: date-time + type: number + x-stream-index: "012" + created_by: + $ref: '#/components/schemas/User' + x-stream-index: "011" + expires: + format: date-time + type: number + x-stream-index: "007" + reason: + type: string + x-stream-index: "008" + shadow: + type: boolean + x-stream-index: "009" + target: + $ref: '#/components/schemas/User' + x-stream-index: "006" + required: + - shadow + - created_at + type: object + BanActionRequest: + properties: + channel_ban_only: + type: boolean + x-stream-index: "003" + delete_messages: + enum: + - soft + - pruning + - hard + type: string + x-stream-index: "005" + ip_ban: + type: boolean + x-stream-index: "004" + reason: + type: string + x-stream-index: "002" + shadow: + type: boolean + x-stream-index: "001" + timeout: + format: int32 + type: integer + x-stream-index: "006" + type: object + BanOptions: + properties: + duration: + format: int32 + type: integer + x-stream-index: "001" + ip_ban: + type: boolean + x-stream-index: "004" + reason: + type: string + x-stream-index: "002" + shadow_ban: + type: boolean + x-stream-index: "003" + type: object + BanRequest: + nullable: true + properties: + banned_by: + $ref: '#/components/schemas/UserRequest' + description: Details about the user performing the ban + title: Banned By + x-stream-index: "008" + banned_by_id: + description: ID of the user performing the ban + title: Banned By ID + type: string + x-stream-index: "007" + channel_cid: + description: Channel where the ban applies + title: Channel CID + type: string + x-stream-index: "004" + delete_messages: + enum: + - soft + - pruning + - hard + type: string + x-stream-index: "009" + ip_ban: + description: Whether to ban the user's IP address + title: IP Ban + type: boolean + x-stream-index: "006" + reason: + description: Optional explanation for the ban + title: Reason + type: string + x-stream-index: "003" + shadow: + description: Whether this is a shadow ban + title: Shadow + type: boolean + x-stream-index: "005" + target_user_id: + description: ID of the user to ban + title: Target User ID + type: string + x-stream-index: "001" + timeout: + description: Duration of the ban in minutes + minimum: 0 + title: Timeout + type: integer + x-stream-index: "002" + required: + - target_user_id + type: object + BanResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "001.001" + required: + - duration + type: object + BlockContentOptions: + properties: + reason: + type: string + x-stream-index: "001" + type: object + BlockListConfig: + properties: + async: + type: boolean + x-stream-index: "001" + enabled: + type: boolean + x-stream-index: "002" + rules: + items: + $ref: '#/components/schemas/BlockListRule' + maximum: 10 + type: array + x-stream-index: "003" + required: + - enabled + - rules + type: object + BlockListOptions: + properties: + behavior: + description: Blocklist behavior + enum: + - flag + - block + - shadow_block + title: Behavior + type: string + x-stream-index: "002" + blocklist: + description: Blocklist name + title: Blocklist + type: string + x-stream-index: "001" + required: + - blocklist + - behavior + type: object + BlockListResponse: + description: Block list contains restricted words + properties: + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: "001" + id: + type: string + x-stream-index: "003" + name: + description: Block list name + title: Name + type: string + x-stream-index: "004" + team: + type: string + x-stream-index: "007" + type: + description: Block list type. + title: Type + type: string + x-stream-index: "005" + updated_at: + description: Date/time of the last update + format: date-time + title: Updated at + type: number + x-stream-index: "002" + words: + description: List of words to block + items: + type: string + title: Words + type: array + x-stream-index: "006" + required: + - name + - type + - words + title: Block list + type: object + x-stream-docs-page-id: block_lists + BlockListRule: + properties: + action: + enum: + - flag + - mask_flag + - shadow + - remove + - bounce + - bounce_flag + - bounce_remove + type: string + x-stream-index: "003" + name: + type: string + x-stream-index: "001" + team: + type: string + x-stream-index: "002" + required: + - name + - team + - action + type: object + BlockUsersRequest: + nullable: true + properties: + blocked_user_id: + description: User id to block + title: BlockedUserID + type: string + x-stream-index: "001" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "003.002" + user_id: + type: string + x-stream-index: "003.001" + required: + - blocked_user_id + type: object + BlockUsersResponse: + nullable: true + properties: + blocked_by_user_id: + description: User id who blocked another user + title: BlockedByUserID + type: string + x-stream-index: "002" + blocked_user_id: + description: User id who got blocked + title: BlockedUserID + type: string + x-stream-index: "003" + created_at: + description: Timestamp when the user was blocked + format: date-time + title: CreatedAt + type: number + x-stream-index: "004" + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "001.001" + required: + - duration + - blocked_by_user_id + - blocked_user_id + - created_at + type: object + BlockedUserResponse: + nullable: true + properties: + blocked_user: + $ref: '#/components/schemas/UserResponse' + description: User who got blocked + title: User + x-stream-index: "003" + blocked_user_id: + description: ID of the user who got blocked + title: UserID + type: string + x-stream-index: "004" + created_at: + format: date-time + type: number + x-stream-index: "005" + user: + $ref: '#/components/schemas/UserResponse' + description: User who blocked another user + title: User + x-stream-index: "001" + user_id: + description: ID of the user who blocked another user + title: UserID + type: string + x-stream-index: "002" + required: + - user + - user_id + - blocked_user + - blocked_user_id + - created_at + type: object + BodyguardRule: + properties: + action: + enum: + - flag + - shadow + - remove + - bounce + - bounce_flag + - bounce_remove + type: string + x-stream-index: "002" + label: + type: string + x-stream-index: "001" + severity_rules: + items: + $ref: '#/components/schemas/BodyguardSeverityRule' + type: array + x-stream-index: "003" + required: + - label + - action + - severity_rules + type: object + BodyguardSeverityRule: + properties: + action: + enum: + - flag + - shadow + - remove + - bounce + - bounce_flag + - bounce_remove + type: string + x-stream-index: "002" + severity: + enum: + - low + - medium + - high + - critical + type: string + x-stream-index: "001" + required: + - severity + - action + type: object + BookmarkAddedEvent: + description: Emitted when a user bookmarks an activity. + nullable: true + properties: + bookmark: + $ref: '#/components/schemas/BookmarkResponse' + x-stream-index: "001" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 + type: + default: feeds.bookmark.added + description: 'The type of event: "feeds.bookmark.added" in this case' + title: Event Type + type: string + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who added the bookmark + title: User + x-stream-index: "003.001" + required: + - bookmark + - type + - created_at + - custom + title: BookmarkAddedEvent + 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 + BookmarkDeletedEvent: + description: Emitted when a user deletes a bookmark from an activity. + nullable: true + properties: + bookmark: + $ref: '#/components/schemas/BookmarkResponse' + x-stream-index: "001" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 + type: + default: feeds.bookmark.deleted + description: 'The type of event: "feeds.bookmark.deleted" in this case' + title: Event Type + type: string + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who removed the bookmark + title: User + x-stream-index: "003.001" + required: + - bookmark + - type + - created_at + - custom + title: BookmarkDeletedEvent + 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 + BookmarkFolderDeletedEvent: + description: Emitted when a bookmark folder is deleted. + nullable: true + properties: + bookmark_folder: + $ref: '#/components/schemas/BookmarkFolderResponse' + description: The bookmark folder that was deleted + title: Bookmark Folder + x-stream-index: "001" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 + type: + default: feeds.bookmark_folder.deleted + description: 'The type of event: "feeds.bookmark_folder.deleted" in this + case' + title: Event Type + type: string + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who deleted the bookmark folder + title: User + x-stream-index: "003.001" + required: + - bookmark_folder + - type + - created_at + - custom + title: BookmarkFolderDeletedEvent + 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 + BookmarkFolderResponse: + properties: + created_at: + description: When the folder was created + format: date-time + title: Created At + type: number + x-stream-index: "004" + custom: + additionalProperties: {} + description: Custom data for the folder + title: Custom Data + type: object + x-stream-index: "003" + id: + description: Unique identifier for the folder + title: ID + type: string + x-stream-index: "001" + name: + description: Name of the folder + title: Name + type: string + x-stream-index: "002" + updated_at: + description: When the folder was last updated + format: date-time + title: Updated At + type: number + x-stream-index: "005" + required: + - id + - name + - created_at + - updated_at + title: Bookmark Folder + type: object + BookmarkFolderUpdatedEvent: + description: Emitted when a bookmark folder is updated. + nullable: true + properties: + bookmark_folder: + $ref: '#/components/schemas/BookmarkFolderResponse' + description: The bookmark folder that was updated + title: Bookmark Folder + x-stream-index: "001" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 + type: + default: feeds.bookmark_folder.updated + description: 'The type of event: "feeds.bookmark_folder.updated" in this + case' + title: Event Type + type: string + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who updated the bookmark folder + title: User + x-stream-index: "003.001" + required: + - bookmark_folder + - type + - created_at + - custom + title: BookmarkFolderUpdatedEvent + 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 + BookmarkResponse: + properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + description: The bookmarked activity + title: Activity + x-stream-index: "002" + created_at: + description: When the bookmark was created + format: date-time + title: Created At + type: number + x-stream-index: "005" + custom: + additionalProperties: {} + description: Custom data for the bookmark + title: Custom Data + type: object + x-stream-index: "004" + folder: + $ref: '#/components/schemas/BookmarkFolderResponse' + description: Folder containing this bookmark + title: Folder + x-stream-index: "003" + updated_at: + description: When the bookmark was last updated + format: date-time + title: Updated At + type: number + x-stream-index: "006" + user: + $ref: '#/components/schemas/UserResponse' + description: User who created the bookmark + title: User + x-stream-index: "001" + required: + - user + - activity + - created_at + - updated_at + title: Bookmark + type: object + BookmarkUpdatedEvent: + description: Emitted when a user updates a bookmark. + nullable: true + properties: + bookmark: + $ref: '#/components/schemas/BookmarkResponse' + description: The updated bookmark + title: Bookmark + x-stream-index: "001" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 + type: + default: feeds.bookmark.updated + description: 'The type of event: "feeds.bookmark.updated" in this case' + title: Event Type + type: string + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who updated the bookmark + title: User + x-stream-index: "003.001" + required: + - bookmark + - type + - created_at + - custom + title: BookmarkUpdatedEvent + 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 + BroadcastSettings: + properties: + enabled: + type: boolean + x-stream-index: "001" + hls: + $ref: '#/components/schemas/HLSSettings' + x-stream-index: "002" + rtmp: + $ref: '#/components/schemas/RTMPSettings' + x-stream-index: "003" + required: + - enabled + type: object + BroadcastSettingsResponse: + description: BroadcastSettingsResponse is the payload for broadcasting settings + properties: + enabled: + title: Enabled + type: boolean + x-stream-index: "001" + hls: + $ref: '#/components/schemas/HLSSettingsResponse' + title: HLS + x-stream-index: "002" + rtmp: + $ref: '#/components/schemas/RTMPSettingsResponse' + title: RTMP + x-stream-index: "003" + required: + - enabled + - hls + - rtmp + title: BroadcastSettingsResponse + type: object + BulkImageModerationRequest: + nullable: true + properties: + csv_file: + description: URL to CSV file containing image URLs to moderate + title: string + type: string + x-stream-index: "001" + required: + - csv_file + type: object + BulkImageModerationResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + task_id: + description: ID of the task for processing the bulk image moderation + title: string + type: string + x-stream-index: "001" + required: + - task_id + - duration + type: object + Call: + properties: + AppPK: + format: int32 + type: integer + writeOnly: true + x-stream-index: "002" + Backstage: + type: boolean + writeOnly: true + x-stream-index: "023" + BlockedUserIDs: + items: + type: string + type: array + writeOnly: true + x-stream-index: "018" + BlockedUsers: + items: + $ref: '#/components/schemas/User' + type: array + writeOnly: true + x-stream-index: "019" + CID: + type: string + writeOnly: true + x-stream-index: "005" + CallType: + $ref: '#/components/schemas/CallType' + x-stream-index: "020" + ChannelCID: + type: string + writeOnly: true + x-stream-index: "032" + CreatedAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "013" + CreatedBy: + $ref: '#/components/schemas/User' + x-stream-index: "008" + CreatedByUserID: + type: string + writeOnly: true + x-stream-index: "007" + CurrentSessionID: + type: string + writeOnly: true + x-stream-index: "024" + Custom: + additionalProperties: {} + type: object + writeOnly: true + x-stream-index: "012" + DeletedAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "028" + EgressUpdatedAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "027" + Egresses: + items: + $ref: '#/components/schemas/CallEgress' + type: array + writeOnly: true + x-stream-index: "015" + EndedAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "017" + ID: + type: string + writeOnly: true + x-stream-index: "004" + JoinAheadTimeSeconds: + format: int32 + type: integer + writeOnly: true + x-stream-index: "031" + LastHeartbeatAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "030" + LastSessionID: + type: string + writeOnly: true + x-stream-index: "025" + MemberCount: + format: int32 + type: integer + writeOnly: true + x-stream-index: "010" + MemberLookup: + $ref: '#/components/schemas/MemberLookup' + x-stream-index: "011" + Members: + items: + $ref: '#/components/schemas/CallMember' + type: array + writeOnly: true + x-stream-index: "009" + Session: + $ref: '#/components/schemas/CallSession' + x-stream-index: "026" + Settings: + $ref: '#/components/schemas/CallSettings' + x-stream-index: "022" + SettingsOverrides: + $ref: '#/components/schemas/CallSettings' + x-stream-index: "021" + StartsAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "016" + Team: + type: string + writeOnly: true + x-stream-index: "006" + ThumbnailURL: + type: string + writeOnly: true + x-stream-index: "029" + Type: + type: string + writeOnly: true + x-stream-index: "003" + UpdatedAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "014" + required: + - AppPK + - Type + - ID + - CID + - Team + - CreatedByUserID + - Members + - Custom + - CreatedAt + - UpdatedAt + - Egresses + - BlockedUserIDs + - BlockedUsers + - Backstage + - CurrentSessionID + - LastSessionID + - ThumbnailURL + - ChannelCID + type: object + CallEgress: + nullable: true + properties: + app_pk: + format: int32 + type: integer + x-stream-index: "002" + call_id: + type: string + x-stream-index: "004" + call_type: + type: string + x-stream-index: "003" + config: + $ref: '#/components/schemas/EgressTaskConfig' + x-stream-index: "007" + egress_id: + type: string + x-stream-index: "005" + egress_type: + type: string + x-stream-index: "006" + instance_ip: + type: string + x-stream-index: "008" + started_at: + format: date-time + type: number + x-stream-index: "010" + state: + type: string + x-stream-index: "009" + stopped_at: + format: date-time + type: number + x-stream-index: "011" + updated_at: + format: date-time + type: number + x-stream-index: "012" + required: + - app_pk + - call_type + - call_id + - egress_id + - egress_type + - instance_ip + - state + - started_at + - updated_at + type: object + CallIngressResponse: + description: CallIngressResponse is the payload for ingress settings + properties: + rtmp: + $ref: '#/components/schemas/RTMPIngress' + title: RTMP + x-stream-index: "001" + required: + - rtmp + title: CallIngressResponse + type: object + CallMember: + nullable: true + properties: + created_at: + format: date-time + type: number + x-stream-index: "008" + custom: + additionalProperties: {} + type: object + x-stream-index: "007" + deleted_at: + format: date-time + type: number + x-stream-index: "010" + role: + type: string + x-stream-index: "006" + updated_at: + format: date-time + type: number + x-stream-index: "009" + user: + $ref: '#/components/schemas/User' + x-stream-index: "005" + user_id: + type: string + x-stream-index: "004" + required: + - user_id + - role + - custom + - created_at + - updated_at + type: object + CallParticipant: + nullable: true + properties: + JoinedAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "004" + Role: + type: string + writeOnly: true + x-stream-index: "002" + UserSessionID: + type: string + writeOnly: true + x-stream-index: "003" + avg_response_time: + format: int32 + readOnly: true + type: integer + x-stream-index: "001.046" + ban_expires: + format: date-time + type: number + x-stream-index: "001.017" + banned: + type: boolean + x-stream-index: "001.016" + created_at: + format: date-time + readOnly: true + type: number + x-stream-index: "001.008" + custom: + additionalProperties: {} + type: object + x-stream-index: "001.006" + deactivated_at: + format: date-time + readOnly: true + type: number + x-stream-index: "001.014" + deleted_at: + format: date-time + readOnly: true + type: number + x-stream-index: "001.013" + id: + type: string + x-stream-index: "001.003" + invisible: + type: boolean + x-stream-index: "001.023" + language: + type: string + x-stream-index: "001.035" + last_active: + format: date-time + readOnly: true + type: number + x-stream-index: "001.011" + last_engaged_at: + format: date-time + readOnly: true + type: number + x-stream-index: "001.012" + online: + readOnly: true + type: boolean + x-stream-index: "001.022" + privacy_settings: + $ref: '#/components/schemas/PrivacySettings' + x-stream-index: "001.026" + revoke_tokens_issued_before: + format: date-time + type: number + x-stream-index: "001.042" + role: + type: string + x-stream-index: "001.004" + teams: + items: + type: string + type: array + x-stream-index: "001.036" + teams_role: + additionalProperties: + type: string + type: object + x-stream-index: "001.005" + updated_at: + format: date-time + readOnly: true + type: number + x-stream-index: "001.009" + required: + - id + - role + - teams_role + - custom + - banned + - online + - Role + - UserSessionID + - JoinedAt + type: object + CallParticipantResponse: + properties: + joined_at: + format: date-time + type: number + x-stream-index: "004" + role: + type: string + x-stream-index: "003" + user: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "001" + user_session_id: + type: string + x-stream-index: "002" + required: + - user + - user_session_id + - role + - joined_at + type: object + CallResponse: + description: Represents a call + properties: + backstage: + type: boolean + x-stream-index: "016" + blocked_user_ids: + items: + type: string + type: array + x-stream-index: "018" + captioning: + type: boolean + x-stream-index: "013" + channel_cid: + type: string + x-stream-index: "024" + cid: + description: The unique identifier for a call (:) + title: CID + type: string + x-stream-index: "004" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: "009" + created_by: + $ref: '#/components/schemas/UserResponse' + description: The user that created the call + title: Created By + x-stream-index: "007" + current_session_id: + type: string + x-stream-index: "005" + custom: + additionalProperties: {} + description: Custom data for this object + title: Custom data + type: object + x-stream-index: "008" + egress: + $ref: '#/components/schemas/EgressResponse' + x-stream-index: "021" + ended_at: + description: Date/time when the call ended + format: date-time + title: Ended At + type: number + x-stream-index: "014" + id: + description: Call ID + title: ID + type: string + x-stream-index: "003" + ingress: + $ref: '#/components/schemas/CallIngressResponse' + x-stream-index: "019" + join_ahead_time_seconds: + format: int32 + type: integer + x-stream-index: "023" + recording: + type: boolean + x-stream-index: "011" + session: + $ref: '#/components/schemas/CallSessionResponse' + x-stream-index: "020" + settings: + $ref: '#/components/schemas/CallSettingsResponse' + x-stream-index: "017" + starts_at: + description: Date/time when the call will start + format: date-time + title: Starts At + type: number + x-stream-index: "015" + team: + type: string + x-stream-index: "006" + thumbnails: + $ref: '#/components/schemas/ThumbnailResponse' + x-stream-index: "022" + transcribing: + type: boolean + x-stream-index: "012" + type: + description: The type of call + title: Type + type: string + x-stream-index: "002" + updated_at: + description: Date/time of the last update + format: date-time + title: Updated at + type: number + x-stream-index: "010" + required: + - type + - id + - cid + - current_session_id + - created_by + - custom + - created_at + - updated_at + - recording + - transcribing + - captioning + - backstage + - settings + - blocked_user_ids + - ingress + - egress + title: CallResponse + type: object + CallSession: + properties: + AcceptedBy: + additionalProperties: + format: date-time + type: number + type: object + writeOnly: true + x-stream-index: "008" + ActiveSFUs: + items: + $ref: '#/components/schemas/SFUIDLastSeen' + type: array + writeOnly: true + x-stream-index: "016" + AnonymousParticipantCount: + format: int32 + type: integer + writeOnly: true + x-stream-index: "019" + AppPK: + format: int32 + type: integer + writeOnly: true + x-stream-index: "002.001" + CallID: + type: string + writeOnly: true + x-stream-index: "002.003" + CallType: + type: string + writeOnly: true + x-stream-index: "002.002" + CreatedAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "003" + DeletedAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "004" + EndedAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "006" + LiveEndedAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "013" + LiveStartedAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "012" + MissedBy: + additionalProperties: + format: date-time + type: number + type: object + writeOnly: true + x-stream-index: "010" + Participants: + items: + $ref: '#/components/schemas/CallParticipant' + type: array + writeOnly: true + x-stream-index: "011" + ParticipantsCountByRole: + additionalProperties: + format: int32 + type: integer + type: object + writeOnly: true + x-stream-index: "018" + RejectedBy: + additionalProperties: + format: date-time + type: number + type: object + writeOnly: true + x-stream-index: "009" + RingAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "007" + SFUIDs: + items: + type: string + type: array + writeOnly: true + x-stream-index: "015" + SessionID: + type: string + writeOnly: true + x-stream-index: "002.004" + StartedAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "005" + TimerEndsAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "014" + UserPermissionOverrides: + additionalProperties: + additionalProperties: + type: boolean + type: object + type: object + writeOnly: true + x-stream-index: "017" + required: + - AppPK + - CallType + - CallID + - SessionID + - CreatedAt + - AcceptedBy + - RejectedBy + - MissedBy + - Participants + - SFUIDs + - ActiveSFUs + - UserPermissionOverrides + - ParticipantsCountByRole + - AnonymousParticipantCount + type: object + CallSessionResponse: + properties: + accepted_by: + additionalProperties: + format: date-time + type: number + type: object + x-stream-index: "008" + anonymous_participant_count: + format: int32 + type: integer + x-stream-index: "006" + ended_at: + format: date-time + type: number + x-stream-index: "003" + id: + type: string + x-stream-index: "001" + live_ended_at: + format: date-time + type: number + x-stream-index: "011" + live_started_at: + format: date-time + type: number + x-stream-index: "010" + missed_by: + additionalProperties: + format: date-time + type: number + type: object + x-stream-index: "009" + participants: + items: + $ref: '#/components/schemas/CallParticipantResponse' + type: array + x-stream-index: "004" + participants_count_by_role: + additionalProperties: + format: int32 + type: integer + type: object + x-stream-index: "005" + rejected_by: + additionalProperties: + format: date-time + type: number + type: object + x-stream-index: "007" + started_at: + format: date-time + type: number + x-stream-index: "002" + timer_ends_at: + format: date-time + type: number + x-stream-index: "012" + required: + - id + - participants + - participants_count_by_role + - anonymous_participant_count + - rejected_by + - accepted_by + - missed_by + type: object + CallSettings: + properties: + audio: + $ref: '#/components/schemas/AudioSettings' + x-stream-index: "001" + backstage: + $ref: '#/components/schemas/BackstageSettings' + x-stream-index: "002" + broadcasting: + $ref: '#/components/schemas/BroadcastSettings' + x-stream-index: "007" + frame_recording: + $ref: '#/components/schemas/FrameRecordSettings' + x-stream-index: "006" + geofencing: + $ref: '#/components/schemas/GeofenceSettings' + x-stream-index: "008" + ingress: + $ref: '#/components/schemas/IngressSettings' + x-stream-index: "014" + limits: + $ref: '#/components/schemas/LimitsSettings' + x-stream-index: "012" + recording: + $ref: '#/components/schemas/RecordSettings' + x-stream-index: "005" + ring: + $ref: '#/components/schemas/RingSettings' + x-stream-index: "010" + screensharing: + $ref: '#/components/schemas/ScreensharingSettings' + x-stream-index: "004" + session: + $ref: '#/components/schemas/SessionSettings' + x-stream-index: "013" + thumbnails: + $ref: '#/components/schemas/ThumbnailsSettings' + x-stream-index: "011" + transcription: + $ref: '#/components/schemas/TranscriptionSettings' + x-stream-index: "009" + video: + $ref: '#/components/schemas/VideoSettings' + x-stream-index: "003" + type: object + CallSettingsResponse: + properties: + audio: + $ref: '#/components/schemas/AudioSettingsResponse' + x-stream-index: "001" + backstage: + $ref: '#/components/schemas/BackstageSettingsResponse' + x-stream-index: "002" + broadcasting: + $ref: '#/components/schemas/BroadcastSettingsResponse' + x-stream-index: "003" + frame_recording: + $ref: '#/components/schemas/FrameRecordingSettingsResponse' + x-stream-index: "006" + geofencing: + $ref: '#/components/schemas/GeofenceSettingsResponse' + x-stream-index: "004" + ingress: + $ref: '#/components/schemas/IngressSettingsResponse' + x-stream-index: "014" + limits: + $ref: '#/components/schemas/LimitsSettingsResponse' + x-stream-index: "012" + recording: + $ref: '#/components/schemas/RecordSettingsResponse' + x-stream-index: "005" + ring: + $ref: '#/components/schemas/RingSettingsResponse' + x-stream-index: "007" + screensharing: + $ref: '#/components/schemas/ScreensharingSettingsResponse' + x-stream-index: "008" + session: + $ref: '#/components/schemas/SessionSettingsResponse' + x-stream-index: "013" + thumbnails: + $ref: '#/components/schemas/ThumbnailsSettingsResponse' + x-stream-index: "011" + transcription: + $ref: '#/components/schemas/TranscriptionSettingsResponse' + x-stream-index: "009" + video: + $ref: '#/components/schemas/VideoSettingsResponse' + x-stream-index: "010" + required: + - audio + - backstage + - broadcasting + - geofencing + - recording + - frame_recording + - ring + - screensharing + - transcription + - video + - thumbnails + - limits + - session + type: object + CallType: + nullable: true + properties: + AppPK: + format: int32 + type: integer + writeOnly: true + x-stream-index: "003" + CreatedAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "005" + ExternalStorage: + type: string + writeOnly: true + x-stream-index: "009" + Name: + type: string + writeOnly: true + x-stream-index: "004" + NotificationSettings: + $ref: '#/components/schemas/NotificationSettings' + x-stream-index: "008" + PK: + format: int32 + type: integer + writeOnly: true + x-stream-index: "002" + Settings: + $ref: '#/components/schemas/CallSettings' + x-stream-index: "007" + UpdatedAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "006" + required: + - PK + - AppPK + - Name + - CreatedAt + - UpdatedAt + - ExternalStorage + type: object + CastPollVoteRequest: + nullable: true + properties: + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "005.002" + user_id: + type: string + x-stream-index: "005.001" + vote: + $ref: '#/components/schemas/VoteData' + description: Vote data + title: VoteData + x-stream-index: "004" + type: object + Channel: + properties: + active_live_locations: + items: + $ref: '#/components/schemas/SharedLocation' + type: array + x-stream-index: "034" + auto_translation_enabled: + type: boolean + x-stream-index: "029" + auto_translation_language: + type: string + x-stream-index: "030" + cid: + type: string + x-stream-index: "003" + config: + $ref: '#/components/schemas/ChannelConfig' + x-stream-index: "026" + config_overrides: + $ref: '#/components/schemas/ConfigOverrides' + x-stream-index: "027" + cooldown: + format: int32 + type: integer + x-stream-index: "031" + created_at: + format: date-time + type: number + x-stream-index: "009" + created_by: + $ref: '#/components/schemas/User' + x-stream-index: "008" + custom: + additionalProperties: {} + type: object + x-stream-index: "019" + deleted_at: + format: date-time + type: number + x-stream-index: "011" + disabled: + type: boolean + x-stream-index: "017" + frozen: + type: boolean + x-stream-index: "016" + id: + type: string + x-stream-index: "004" + invites: + items: + $ref: '#/components/schemas/ChannelMember' + type: array + x-stream-index: "022" + last_campaigns: + type: string + x-stream-index: "032" + last_message_at: + format: date-time + type: number + x-stream-index: "006" + member_count: + format: int32 + type: integer + x-stream-index: "021" + members: + items: + $ref: '#/components/schemas/ChannelMember' + type: array + x-stream-index: "020" + message_count: + format: int64 + type: integer + x-stream-index: "035" + message_count_updated_at: + format: date-time + type: number + x-stream-index: "036" + team: + type: string + x-stream-index: "028" + truncated_by: + $ref: '#/components/schemas/User' + x-stream-index: "015" + type: + type: string + x-stream-index: "005" + updated_at: + format: date-time + type: number + x-stream-index: "010" + required: + - cid + - id + - type + - created_at + - updated_at + - frozen + - disabled + - custom + - auto_translation_language + type: object + ChannelConfig: + properties: + allowed_flag_reasons: + items: + type: string + type: array + x-stream-index: "001.027" + automod: + enum: + - disabled + - simple + - AI + type: string + x-stream-index: "001.022" + automod_behavior: + enum: + - flag + - block + - shadow_block + type: string + x-stream-index: "001.023" + automod_thresholds: + $ref: '#/components/schemas/Thresholds' + x-stream-index: "001.028" + blocklist: + type: string + x-stream-index: "001.024" + blocklist_behavior: + enum: + - flag + - block + - shadow_block + type: string + x-stream-index: "001.025" + blocklists: + items: + $ref: '#/components/schemas/BlockListOptions' + type: array + x-stream-index: "001.026" + commands: + items: + type: string + type: array + x-stream-index: "003" + connect_events: + type: boolean + x-stream-index: "001.004" + count_messages: + type: boolean + x-stream-index: "001.019" + created_at: + format: date-time + type: number + x-stream-index: "002.003" + custom_events: + type: boolean + x-stream-index: "001.012" + mark_messages_pending: + type: boolean + x-stream-index: "001.015" + max_message_length: + format: int32 + maximum: 20000 + type: integer + x-stream-index: "001.021" + mutes: + type: boolean + x-stream-index: "001.009" + name: + type: string + x-stream-index: "001.001" + partition_size: + format: int32 + type: integer + x-stream-index: "001.029" + partition_ttl: + type: integer + x-stream-index: "001.030" + polls: + type: boolean + x-stream-index: "001.016" + push_notifications: + type: boolean + x-stream-index: "001.013" + quotes: + type: boolean + x-stream-index: "001.008" + reactions: + type: boolean + x-stream-index: "001.006" + read_events: + type: boolean + x-stream-index: "001.003" + reminders: + type: boolean + x-stream-index: "001.014" + replies: + type: boolean + x-stream-index: "001.007" + search: + type: boolean + x-stream-index: "001.005" + shared_locations: + type: boolean + x-stream-index: "001.018" + skip_last_msg_update_for_system_msgs: + type: boolean + x-stream-index: "001.031" + typing_events: + type: boolean + x-stream-index: "001.002" + updated_at: + format: date-time + type: number + x-stream-index: "002.004" + uploads: + type: boolean + x-stream-index: "001.010" + url_enrichment: + type: boolean + x-stream-index: "001.011" + user_message_reminders: + type: boolean + x-stream-index: "001.017" + required: + - name + - typing_events + - read_events + - connect_events + - search + - reactions + - replies + - quotes + - mutes + - uploads + - url_enrichment + - custom_events + - push_notifications + - reminders + - mark_messages_pending + - polls + - user_message_reminders + - shared_locations + - count_messages + - message_retention + - max_message_length + - automod + - automod_behavior + - skip_last_msg_update_for_system_msgs + - created_at + - updated_at + - commands + type: object + ChannelConfigWithInfo: + properties: + allowed_flag_reasons: + items: + type: string + type: array + x-stream-index: 001.002.027 + automod: + enum: + - disabled + - simple + - AI + type: string + x-stream-index: 001.002.022 + automod_behavior: + enum: + - flag + - block + - shadow_block + type: string + x-stream-index: 001.002.023 + automod_thresholds: + $ref: '#/components/schemas/Thresholds' + x-stream-index: 001.002.028 + blocklist: + type: string + x-stream-index: 001.002.024 + blocklist_behavior: + enum: + - flag + - block + - shadow_block + type: string + x-stream-index: 001.002.025 + blocklists: + items: + $ref: '#/components/schemas/BlockListOptions' + type: array + x-stream-index: 001.002.026 + commands: + items: + $ref: '#/components/schemas/Command' + type: array + x-stream-index: "001.003" + connect_events: + type: boolean + x-stream-index: 001.002.004 + count_messages: + type: boolean + x-stream-index: 001.002.019 + created_at: + format: date-time + type: number + x-stream-index: 001.001.003 + custom_events: + type: boolean + x-stream-index: 001.002.012 + grants: + additionalProperties: + items: + type: string + type: array + type: object + x-stream-index: "002" + mark_messages_pending: + type: boolean + x-stream-index: 001.002.015 + max_message_length: + format: int32 + maximum: 20000 + type: integer + x-stream-index: 001.002.021 + mutes: + type: boolean + x-stream-index: 001.002.009 + name: + type: string + x-stream-index: 001.002.001 + partition_size: + format: int32 + type: integer + x-stream-index: 001.002.029 + partition_ttl: + example: 24h + format: duration + nullable: true + type: string + x-stream-index: 001.002.030 + polls: + type: boolean + x-stream-index: 001.002.016 + push_notifications: + type: boolean + x-stream-index: 001.002.013 + quotes: + type: boolean + x-stream-index: 001.002.008 + reactions: + type: boolean + x-stream-index: 001.002.006 + read_events: + type: boolean + x-stream-index: 001.002.003 + reminders: + type: boolean + x-stream-index: 001.002.014 + replies: + type: boolean + x-stream-index: 001.002.007 + search: + type: boolean + x-stream-index: 001.002.005 + shared_locations: + type: boolean + x-stream-index: 001.002.018 + skip_last_msg_update_for_system_msgs: + type: boolean + x-stream-index: 001.002.031 + typing_events: + type: boolean + x-stream-index: 001.002.002 + updated_at: + format: date-time + type: number + x-stream-index: 001.001.004 + uploads: + type: boolean + x-stream-index: 001.002.010 + url_enrichment: + type: boolean + x-stream-index: 001.002.011 + user_message_reminders: + type: boolean + x-stream-index: 001.002.017 + required: + - created_at + - updated_at + - name + - typing_events + - read_events + - connect_events + - search + - reactions + - replies + - quotes + - mutes + - uploads + - url_enrichment + - custom_events + - push_notifications + - reminders + - mark_messages_pending + - polls + - user_message_reminders + - shared_locations + - count_messages + - message_retention + - max_message_length + - automod + - automod_behavior + - skip_last_msg_update_for_system_msgs + - commands + type: object + ChannelMember: + nullable: true + properties: + archived_at: + format: date-time + type: number + x-stream-index: "015" + ban_expires: + description: Expiration date of the ban + format: date-time + title: Ban expires + type: number + x-stream-index: "013" + banned: + description: Whether member is banned this channel or not + title: Banned + type: boolean + x-stream-index: "012" + channel_role: + description: Role of the member in the channel + title: Channel Role + type: string + x-stream-index: "018" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: "009" + custom: + additionalProperties: {} + type: object + x-stream-index: "004" + deleted_at: + format: date-time + type: number + x-stream-index: "011" + deleted_messages: + items: + type: string + type: array + x-stream-index: "020" + invite_accepted_at: + description: Date when invite was accepted + format: date-time + title: Invited accepted at + type: number + x-stream-index: "006" + invite_rejected_at: + description: Date when invite was rejected + format: date-time + title: Invited rejected at + type: number + x-stream-index: "007" + invited: + description: Whether member was invited or not + title: Invited + type: boolean + x-stream-index: "005" + is_moderator: + description: Whether member is channel moderator or not + title: Is moderator + type: boolean + x-stream-index: "003" + notifications_muted: + type: boolean + x-stream-index: "019" + pinned_at: + format: date-time + type: number + x-stream-index: "016" + role: + description: 'Permission level of the member in the channel (DEPRECATED: + use channel_role instead)' + enum: + - member + - moderator + - admin + - owner + title: Role + type: string + x-stream-index: "017" + shadow_banned: + description: Whether member is shadow banned in this channel or not + title: Shadow banned + type: boolean + x-stream-index: "014" + status: + type: string + x-stream-index: "008" + updated_at: + description: Date/time of the last update + format: date-time + title: Updated at + type: number + x-stream-index: "010" + user: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "002" + user_id: + title: User ID + type: string + x-stream-index: "001" + required: + - custom + - created_at + - updated_at + - banned + - shadow_banned + - channel_role + - notifications_muted + title: Channel member + type: object + ChannelMute: + nullable: true + properties: + channel: + $ref: '#/components/schemas/ChannelResponse' + description: Channel that is muted + title: Channel + x-stream-index: "002" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: "004" + expires: + description: Date/time of mute expiration + format: date-time + title: Expires + type: number + x-stream-index: "003" + updated_at: + description: Date/time of the last update + format: date-time + title: Updated at + type: number + x-stream-index: "005" + user: + $ref: '#/components/schemas/UserResponse' + description: Owner of channel mute + title: User + x-stream-index: "001" + required: + - created_at + - updated_at + type: object + ChannelOwnCapability: + description: All possibility of string to use + enum: + - ban-channel-members + - cast-poll-vote + - connect-events + - create-attachment + - delete-any-message + - delete-channel + - delete-own-message + - flag-message + - freeze-channel + - join-channel + - leave-channel + - mute-channel + - pin-message + - query-poll-votes + - quote-message + - read-events + - search-messages + - send-custom-events + - send-links + - send-message + - send-poll + - send-reaction + - send-reply + - send-restricted-visibility-message + - send-typing-events + - set-channel-cooldown + - share-location + - skip-slow-mode + - slow-mode + - typing-events + - update-any-message + - update-channel + - update-channel-members + - update-own-message + - update-thread + - upload-file + title: ChannelOwnCapability + type: string + ChannelResponse: + description: Represents channel in chat + properties: + auto_translation_enabled: + description: Whether auto translation is enabled or not + title: Auto translation + type: boolean + x-stream-index: "017" + auto_translation_language: + description: Language to translate to when auto translation is active + title: Auto translation language + type: string + x-stream-index: "018" + blocked: + description: Whether this channel is blocked by current user or not + title: Blocked + type: boolean + x-stream-index: "023" + cid: + description: Channel CID (:) + title: CID + type: string + x-stream-index: "003" + config: + $ref: '#/components/schemas/ChannelConfigWithInfo' + description: Channel configuration + title: ChannelConfigWithInfo + x-stream-index: "013" + cooldown: + description: Cooldown period after sending each message + format: int32 + title: Cooldown + type: integer + x-stream-index: "020" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: "005" + created_by: + $ref: '#/components/schemas/UserResponse' + description: Creator of the channel + title: UserResponse + x-stream-index: "008" + custom: + additionalProperties: {} + description: Custom data for this object + title: Custom data + type: object + x-stream-index: "026" + deleted_at: + description: Date/time of deletion + format: date-time + title: Deleted at + type: number + x-stream-index: "007" + disabled: + type: boolean + x-stream-index: "010" + frozen: + description: Whether channel is frozen or not + title: Frozen + type: boolean + x-stream-index: "009" + hidden: + description: Whether this channel is hidden by current user or not + title: Hidden + type: boolean + x-stream-index: "022" + hide_messages_before: + description: Date since when the message history is accessible + format: date-time + title: Hide messages before + type: number + x-stream-index: "019" + id: + description: Channel unique ID + title: ID + type: string + x-stream-index: "001" + last_message_at: + description: Date of the last message sent + format: date-time + title: Last message at + type: number + x-stream-index: "004" + member_count: + description: Number of members in the channel + format: int32 + title: Member count + type: integer + x-stream-index: "012" + members: + description: List of channel members (max 100) + items: + $ref: '#/components/schemas/ChannelMember' + title: ChannelMembers + type: array + x-stream-index: "011" + message_count: + description: Number of messages in the channel + format: int64 + title: Message count + type: integer + x-stream-index: "027" + mute_expires_at: + description: Date of mute expiration + format: date-time + title: Mute expires at + type: number + x-stream-index: "015" + muted: + description: Whether this channel is muted or not + title: Muted + type: boolean + x-stream-index: "014" + own_capabilities: + description: List of channel capabilities of authenticated user + items: + $ref: '#/components/schemas/ChannelOwnCapability' + title: ChannelOwnCapability + type: array + x-stream-index: "021" + team: + description: Team the channel belongs to (multi-tenant only) + title: Team + type: string + x-stream-index: "016" + truncated_at: + description: Date of the latest truncation of the channel + format: date-time + title: UserResponse + type: number + x-stream-index: "024" + truncated_by: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "025" + type: + description: Type of the channel + title: Type + type: string + x-stream-docs-page-id: channel_features + x-stream-index: "002" + updated_at: + description: Date/time of the last update + format: date-time + title: Updated at + type: number + x-stream-index: "006" + required: + - id + - type + - cid + - created_at + - updated_at + - frozen + - disabled + - custom + title: Channel + type: object + CheckExternalStorageResponse: + description: Basic response information + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "001.001" + file_url: + type: string + x-stream-index: "002" + required: + - duration + - file_url + title: Response + type: object + CheckPushRequest: + description: Check push request + nullable: true + properties: + apn_template: + description: Push message template for APN + title: APN template + type: string + x-stream-docs-page-id: push_template + x-stream-index: "002" + event_type: + description: 'Type of event for push templates (default: message.new)' + enum: + - message.new + - message.updated + - reaction.new + - reaction.updated + - notification.reminder_due + title: Event type + type: string + x-stream-index: "008" + firebase_data_template: + description: Push message data template for Firebase + title: Firebase data template + type: string + x-stream-docs-page-id: push_template + x-stream-index: "004" + firebase_template: + description: Push message template for Firebase + title: Firebase template + type: string + x-stream-docs-page-id: push_template + x-stream-index: "003" + message_id: + description: Message ID to send push notification for + title: Message ID + type: string + x-stream-index: "001" + push_provider_name: + description: Name of push provider + title: Name of push provider + type: string + x-stream-index: "007" + push_provider_type: + description: Push provider type + enum: + - firebase + - apn + - huawei + - xiaomi + title: Type of push provider + type: string + x-stream-index: "006" + skip_devices: + description: Don't require existing devices to render templates + title: Skip devices + type: boolean + x-stream-index: "005" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "009.002" + user_id: + type: string + x-stream-index: "009.001" + title: CheckPushRequest + type: object + CheckPushResponse: + nullable: true + properties: + device_errors: + additionalProperties: + $ref: '#/components/schemas/DeviceErrorInfo' + description: Object with device errors + title: Device errors + type: object + x-stream-index: "001" + x-stream-map: + key: device_id + duration: + type: string + x-stream-index: "008.001" + event_type: + description: The event type that was tested + title: Event type + type: string + x-stream-index: "004" + general_errors: + description: List of general errors + items: + type: string + title: General errors + type: array + x-stream-index: "002" + rendered_apn_template: + title: Rendered APN template + type: string + x-stream-index: "005" + rendered_firebase_template: + title: Rendered Firebase template + type: string + x-stream-index: "006" + rendered_message: + additionalProperties: + type: string + title: Rendered message + type: object + x-stream-index: "007" + skip_devices: + description: Don't require existing devices to render templates + title: Skip devices + type: boolean + x-stream-index: "003" + required: + - duration + type: object + CheckRequest: + nullable: true + properties: + config_key: + description: Key of the moderation configuration to use + title: Config Key + type: string + x-stream-index: "005" + config_team: + description: Team associated with the configuration + title: Config Team + type: string + x-stream-index: "006" + entity_creator_id: + description: ID of the user who created the entity + title: Entity Creator ID + type: string + x-stream-index: "003" + entity_id: + description: Unique identifier of the entity to moderate + title: Entity ID + type: string + x-stream-index: "002" + entity_type: + description: Type of entity to moderate + title: Entity Type + type: string + x-stream-index: "001" + moderation_payload: + $ref: '#/components/schemas/ModerationPayload' + description: Content to be moderated + title: Moderation Payload + x-stream-index: "004" + options: + additionalProperties: {} + description: Additional moderation configuration options + title: Options + type: object + x-stream-index: "007" + test_mode: + description: Whether to run moderation in test mode + title: Test Mode + type: boolean + x-stream-index: "008" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "009.002" + user_id: + type: string + x-stream-index: "009.001" + required: + - entity_type + - entity_id + - entity_creator_id + type: object + CheckResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "005.001" + item: + $ref: '#/components/schemas/ReviewQueueItemResponse' + description: Review queue item (present if action != keep) + title: Item + x-stream-index: "004" + recommended_action: + description: Suggested action based on moderation results + title: Recommended Action + type: string + x-stream-index: "003" + status: + description: Status of the moderation check (completed or pending) + title: Status + type: string + x-stream-index: "001" + task_id: + description: ID of the running moderation task + title: Task ID + type: string + x-stream-index: "002" + required: + - status + - recommended_action + - duration + type: object + CheckSNSRequest: + nullable: true + properties: + sns_key: + description: AWS SNS access key + title: SNS key + type: string + x-stream-index: "002" + sns_secret: + description: AWS SNS key secret + title: SNS secret + type: string + x-stream-index: "003" + sns_topic_arn: + description: AWS SNS topic ARN + title: SNS Topic ARN + type: string + x-stream-index: "001" + type: object + CheckSNSResponse: + nullable: true + properties: + data: + additionalProperties: {} + description: Error data + title: ReadOnlyData + type: object + x-stream-index: "003" + duration: + type: string + x-stream-index: "004.001" + error: + description: Error text + title: Error + type: string + x-stream-index: "002" + status: + description: Validation result + enum: + - ok + - error + title: Status + type: string + x-stream-index: "001" + required: + - status + - duration + type: object + CheckSQSRequest: + nullable: true + properties: + sqs_key: + description: AWS SQS access key + title: SQS key + type: string + x-stream-index: "002" + sqs_secret: + description: AWS SQS key secret + title: SQS secret + type: string + x-stream-index: "003" + sqs_url: + description: AWS SQS endpoint URL + title: SQS URL + type: string + x-stream-index: "001" + type: object + CheckSQSResponse: + nullable: true + properties: + data: + additionalProperties: {} + description: Error data + title: ReadOnlyData + type: object + x-stream-index: "003" + duration: + type: string + x-stream-index: "004.001" + error: + description: Error text + title: Error + type: string + x-stream-index: "002" + status: + description: Validation result + enum: + - ok + - error + title: Status + type: string + x-stream-index: "001" + required: + - status + - duration + type: object + Command: + description: Represents custom chat command + nullable: true + properties: + args: + description: Arguments help text, shown in commands auto-completion + title: Arguments + type: string + x-stream-index: "006" + created_at: + description: Date/time of creation + format: date-time + readOnly: true + title: Created at + type: number + x-stream-index: "001" + description: + description: Description, shown in commands auto-completion + title: Description + type: string + x-stream-index: "005" + name: + description: Unique command name + title: Name + type: string + x-stream-index: "004" + set: + description: Set name used for grouping commands + title: Set + type: string + x-stream-index: "007" + updated_at: + description: Date/time of the last update + format: date-time + readOnly: true + title: Updated at + type: number + x-stream-index: "002" + required: + - name + - description + - args + - set + title: Command + type: object + CommentAddedEvent: + description: Emitted when a comment is added to an activity. + nullable: true + properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + x-stream-index: "002" + comment: + $ref: '#/components/schemas/CommentResponse' + description: The comment that was added + title: Text + x-stream-index: "001" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 003.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 003.001.007 + feed_visibility: + type: string + x-stream-index: "003.003" + fid: + type: string + x-stream-index: "003.002" + received_at: + format: date-time + type: number + x-stream-index: 003.001.004 + type: + default: feeds.comment.added + description: 'The type of event: "feeds.comment.added" in this case' + title: Event Type + type: string + x-stream-index: 003.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who added the comment + title: User + x-stream-index: "004.001" + required: + - comment + - activity + - type + - created_at + - custom + - fid + title: CommentAddedEvent + 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 + CommentDeletedEvent: + description: Emitted when a comment is deleted. + nullable: true + properties: + comment: + $ref: '#/components/schemas/CommentResponse' + x-stream-index: "001" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + feed_visibility: + type: string + x-stream-index: "002.003" + fid: + type: string + x-stream-index: "002.002" + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 + type: + default: feeds.comment.deleted + description: 'The type of event: "feeds.comment.deleted" in this case' + title: Event Type + type: string + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who deleted the comment + title: User + x-stream-index: "003.001" + required: + - comment + - type + - created_at + - custom + - fid + title: CommentDeletedEvent + 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 + CommentReactionAddedEvent: + description: Emitted when a reaction is added to a comment. + nullable: true + properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + x-stream-index: "003" + comment: + $ref: '#/components/schemas/CommentResponse' + x-stream-index: "001" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 004.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 004.001.007 + feed_visibility: + type: string + x-stream-index: "004.003" + fid: + type: string + x-stream-index: "004.002" + reaction: + $ref: '#/components/schemas/FeedsReactionResponse' + description: The reaction that was added + title: Reaction + x-stream-index: "002" + received_at: + format: date-time + type: number + x-stream-index: 004.001.004 + type: + default: feeds.comment.reaction.added + description: 'The type of event: "feeds.comment.reaction.added" in this + case' + title: Event Type + type: string + x-stream-index: 004.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who added the reaction + title: User + x-stream-index: "005.001" + required: + - comment + - reaction + - activity + - type + - created_at + - custom + - fid + title: CommentReactionAddedEvent + 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 + CommentReactionDeletedEvent: + description: Emitted when a reaction is deleted from a comment. + nullable: true + properties: + comment: + $ref: '#/components/schemas/CommentResponse' + x-stream-index: "001" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 003.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 003.001.007 + feed_visibility: + type: string + x-stream-index: "003.003" + fid: + type: string + x-stream-index: "003.002" + reaction: + $ref: '#/components/schemas/FeedsReactionResponse' + x-stream-index: "002" + received_at: + format: date-time + type: number + x-stream-index: 003.001.004 + type: + default: feeds.comment.reaction.deleted + description: The type of reaction that was removed + title: Type + type: string + x-stream-index: 003.001.002 + required: + - comment + - reaction + - type + - created_at + - custom + - fid + title: CommentReactionDeletedEvent + 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 + CommentReactionUpdatedEvent: + description: Emitted when a reaction is updated on a comment. + nullable: true + properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + x-stream-index: "003" + comment: + $ref: '#/components/schemas/CommentResponse' + x-stream-index: "001" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 004.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 004.001.007 + feed_visibility: + type: string + x-stream-index: "004.003" + fid: + type: string + x-stream-index: "004.002" + reaction: + $ref: '#/components/schemas/FeedsReactionResponse' + description: The reaction that was updated + title: Reaction + x-stream-index: "002" + received_at: + format: date-time + type: number + x-stream-index: 004.001.004 + type: + default: feeds.comment.reaction.updated + description: 'The type of event: "feeds.comment.reaction.updated" in this + case' + title: Event Type + type: string + x-stream-index: 004.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who updated the reaction + title: User + x-stream-index: "005.001" + required: + - comment + - reaction + - activity + - type + - created_at + - custom + - fid + title: CommentReactionUpdatedEvent + 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 + CommentResponse: + properties: + attachments: + items: + $ref: '#/components/schemas/Attachment' + type: array + x-stream-index: "011" + confidence_score: + description: Confidence score of the comment + format: float + title: Confidence Score + type: number + x-stream-index: "022" + controversy_score: + description: Controversy score of the comment + format: float + title: Controversy Score + type: number + x-stream-index: "023" + created_at: + description: When the comment was created + format: date-time + title: Created At + type: number + x-stream-index: "014" + custom: + additionalProperties: {} + description: Custom data for the comment + title: Custom Data + type: object + x-stream-index: "006" + deleted_at: + description: When the comment was deleted + format: date-time + title: Deleted At + type: number + x-stream-index: "016" + downvote_count: + description: Number of downvotes for this comment + format: int32 + title: Downvote Count + type: integer + x-stream-index: "020" + id: + description: Unique identifier for the comment + title: ID + type: string + x-stream-index: "001" + latest_reactions: + description: Recent reactions to the comment + items: + $ref: '#/components/schemas/FeedsReactionResponse' + title: Latest Reactions + type: array + x-stream-index: "009" + mentioned_users: + description: Users mentioned in the comment + items: + $ref: '#/components/schemas/UserResponse' + title: Mention Users + type: array + x-stream-index: "012" + moderation: + $ref: '#/components/schemas/ModerationV2Response' + x-stream-index: "017" + object_id: + description: ID of the object this comment is associated with + title: Object ID + type: string + x-stream-index: "002" + object_type: + description: Type of the object this comment is associated with + title: Object Type + type: string + x-stream-index: "003" + own_reactions: + description: Current user's reactions to this activity + items: + $ref: '#/components/schemas/FeedsReactionResponse' + title: Own Reactions + type: array + x-stream-index: "024" + parent_id: + description: ID of parent comment for nested replies + title: Parent ID + type: string + x-stream-index: "007" + reaction_count: + description: Number of reactions to this comment + format: int32 + title: Reaction Count + type: integer + x-stream-index: "008" + reaction_groups: + additionalProperties: + $ref: '#/components/schemas/ReactionGroupResponse' + description: Grouped reactions by type + title: Reaction Groups + type: object + x-stream-index: "010" + reply_count: + description: Number of replies to this comment + format: int32 + title: Reply Count + type: integer + x-stream-index: "018" + score: + description: Score of the comment based on reactions + format: int32 + title: Score + type: integer + x-stream-index: "021" + status: + description: Status of the comment (e.g., active, deleted) + title: Status + type: string + x-stream-index: "013" + text: + description: Text content of the comment + title: Text + type: string + x-stream-index: "005" + updated_at: + description: When the comment was last updated + format: date-time + title: Updated At + type: number + x-stream-index: "015" + upvote_count: + description: Number of upvotes for this comment + format: int32 + title: Upvote Count + type: integer + x-stream-index: "019" + user: + $ref: '#/components/schemas/UserResponse' + description: User who created the comment + title: User + x-stream-index: "004" + required: + - id + - object_id + - object_type + - user + - reaction_count + - mentioned_users + - status + - created_at + - updated_at + - reply_count + - upvote_count + - downvote_count + - score + - confidence_score + - own_reactions + title: Comment + type: object + CommentUpdatedEvent: + description: Emitted when a comment is updated. + nullable: true + properties: + comment: + $ref: '#/components/schemas/CommentResponse' + description: The comment that was updated + title: Text + x-stream-index: "001" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + feed_visibility: + type: string + x-stream-index: "002.003" + fid: + type: string + x-stream-index: "002.002" + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 + type: + default: feeds.comment.updated + description: 'The type of event: "feeds.comment.updated" in this case' + title: Event Type + type: string + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who updated the comment + title: User + x-stream-index: "003.001" + required: + - comment + - type + - created_at + - custom + - fid + title: CommentUpdatedEvent + 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 + CompositeAppSettings: + properties: + json_encoded_settings: + type: string + x-stream-index: "005" + url: + type: string + x-stream-index: "004" + type: object + ConfigOverrides: + properties: + blocklist: + type: string + x-stream-index: "008" + blocklist_behavior: + enum: + - flag + - block + type: string + x-stream-index: "009" + commands: + items: + type: string + type: array + x-stream-index: "011" + count_messages: + type: boolean + x-stream-index: "014" + grants: + additionalProperties: + items: + type: string + type: array + type: object + x-stream-index: "010" + max_message_length: + format: int32 + maximum: 20000 + type: integer + x-stream-index: "007" + quotes: + type: boolean + x-stream-index: "004" + reactions: + type: boolean + x-stream-index: "002" + replies: + type: boolean + x-stream-index: "003" + shared_locations: + type: boolean + x-stream-index: "013" + typing_events: + type: boolean + x-stream-index: "001" + uploads: + type: boolean + x-stream-index: "005" + url_enrichment: + type: boolean + x-stream-index: "006" + user_message_reminders: + type: boolean + x-stream-index: "012" + required: + - grants + - commands + type: object + ConfigResponse: + properties: + ai_image_config: + $ref: '#/components/schemas/AIImageConfig' + description: Configuration for AI image analysis + title: AI Image Config + x-stream-index: "010" + ai_text_config: + $ref: '#/components/schemas/AITextConfig' + description: Configuration for AI text analysis + title: AI Text Config + x-stream-index: "008" + ai_video_config: + $ref: '#/components/schemas/AIVideoConfig' + description: Configuration for AI video analysis + title: AI Video Config + x-stream-index: "011" + async: + description: Whether moderation should be performed asynchronously + title: Async + type: boolean + x-stream-index: "003" + automod_platform_circumvention_config: + $ref: '#/components/schemas/AutomodPlatformCircumventionConfig' + description: Configuration for platform circumvention detection + title: Automod Platform Circumvention Config + x-stream-index: "005" + automod_semantic_filters_config: + $ref: '#/components/schemas/AutomodSemanticFiltersConfig' + description: Configuration for semantic filtering + title: Automod Semantic Filters Config + x-stream-index: "006" + automod_toxicity_config: + $ref: '#/components/schemas/AutomodToxicityConfig' + description: Configuration for toxicity detection + title: Automod Toxicity Config + x-stream-index: "004" + block_list_config: + $ref: '#/components/schemas/BlockListConfig' + description: Configuration for block list filtering + title: Block List Config + x-stream-index: "007" + created_at: + description: When the configuration was created + format: date-time + title: Created At + type: number + x-stream-index: "013" + key: + description: Unique identifier for the moderation configuration + title: Key + type: string + x-stream-index: "001" + llm_config: + $ref: '#/components/schemas/LLMConfig' + description: Configuration for customer-configured LLM moderation + title: LLM Config + x-stream-index: "009" + team: + description: Team associated with the configuration + title: Team + type: string + x-stream-index: "002" + updated_at: + description: When the configuration was last updated + format: date-time + title: Updated At + type: number + x-stream-index: "014" + velocity_filter_config: + $ref: '#/components/schemas/VelocityFilterConfig' + description: Configuration for velocity-based filtering + title: Velocity Filter Config + x-stream-index: "012" + video_call_rule_config: + $ref: '#/components/schemas/VideoCallRuleConfig' + x-stream-index: "015" + required: + - key + - team + - async + - created_at + - updated_at + type: object + ContentCountRuleParameters: + properties: + threshold: + format: int32 + type: integer + x-stream-index: "001" + time_window: + type: string + x-stream-index: "002" + type: object + CreateBlockListRequest: + description: Block list contains restricted words + nullable: true + properties: + name: + description: Block list name + maxLength: 255 + title: Name + type: string + x-stream-index: "001" + team: + type: string + x-stream-index: "004" + type: + description: Block list type. + enum: + - regex + - domain + - domain_allowlist + - email + - word + title: Type + type: string + x-stream-index: "003" + words: + description: List of words to block + items: + type: string + minimum: 1 + title: Words + type: array + x-stream-index: "002" + required: + - name + - words + title: Block list + type: object + x-stream-docs-page-id: block_lists + CreateBlockListResponse: + description: Basic response information + nullable: true + properties: + blocklist: + $ref: '#/components/schemas/BlockListResponse' + x-stream-index: "001" + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "002.001" + required: + - duration + title: Response + type: object + CreateDeviceRequest: + description: Create device request + nullable: true + properties: + id: + description: Device ID + maxLength: 255 + minLength: 1 + title: ID + type: string + x-stream-index: "001" + push_provider: + description: Push provider + enum: + - firebase + - apn + - huawei + - xiaomi + title: PushProvider + type: string + x-stream-index: "002" + push_provider_name: + description: Push provider name + title: PushProviderName + type: string + x-stream-index: "003" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "005.002" + user_id: + description: '**Server-side only**. User ID which server acts upon' + title: User ID + type: string + x-stream-index: "005.001" + voip_token: + description: When true the token is for Apple VoIP push notifications + title: VoipToken + type: boolean + x-stream-index: "004" + required: + - id + - push_provider + title: CreateDeviceRequest + type: object + CreateExternalStorageRequest: + description: Create external storage + nullable: true + properties: + aws_s3: + $ref: '#/components/schemas/S3Request' + description: Only required if you want to create an Amazon S3 storage + title: AwsS3 + x-stream-index: "003.004" + azure_blob: + $ref: '#/components/schemas/AzureRequest' + description: Only required if you want to create an Azure Blob Storage + title: AzureBlob + x-stream-index: "003.006" + bucket: + description: The name of the bucket on the service provider + title: Bucket + type: string + x-stream-index: "003.002" + gcs_credentials: + type: string + x-stream-index: "003.005" + name: + description: The name of the provider, this must be unique + title: Name + type: string + x-stream-index: "001" + path: + description: The path prefix to use for storing files + title: Path + type: string + x-stream-index: "003.003" + storage_type: + description: The type of storage to use + enum: + - s3 + - gcs + - abs + title: StorageType + type: string + x-stream-index: "003.001" + required: + - name + - storage_type + - bucket + title: CreateExternalStorageRequest + type: object + CreateExternalStorageResponse: + 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 + CreateFeedGroupRequest: + nullable: true + properties: + activity_processors: + description: Configuration for activity processors (max 10) + items: + $ref: '#/components/schemas/ActivityProcessorConfig' + maximum: 10 + title: Activity Processors + type: array + x-stream-index: "006" + activity_selectors: + description: Configuration for activity selectors (max 10) + items: + $ref: '#/components/schemas/ActivitySelectorConfig' + maximum: 10 + title: Activity Selectors + type: array + x-stream-index: "007" + aggregation: + $ref: '#/components/schemas/AggregationConfig' + description: Configuration for activity aggregation + title: Aggregation + x-stream-index: "009" + custom: + additionalProperties: {} + description: Custom data for the feed group + title: Custom Data + type: object + x-stream-index: "004" + default_visibility: + description: 'Default visibility for the feed group, can be ''public'', + ''visible'', ''followers'', ''members'', or ''private''. Defaults to ''visible'' + if not provided. ' + enum: + - public + - visible + - followers + - members + - private + title: Default Visibility + type: string + x-stream-index: "005" + id: + description: Unique identifier for the feed group + maxLength: 255 + title: Feed Group ID + type: string + x-stream-index: "001" + notification: + $ref: '#/components/schemas/NotificationConfig' + description: Configuration for notifications + title: Notification + x-stream-index: "002" + push_notification: + $ref: '#/components/schemas/PushNotificationConfig' + x-stream-index: "003" + ranking: + $ref: '#/components/schemas/RankingConfig' + description: Configuration for activity ranking + title: Ranking + x-stream-index: "008" + required: + - id + title: Create Feed Group Request + type: object + CreateFeedGroupResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + feed_group: + $ref: '#/components/schemas/FeedGroupResponse' + description: The upserted feed group + title: Feed Group + x-stream-index: "001" + required: + - feed_group + - duration + title: Upsert Feed Group Response + type: object + CreateFeedViewRequest: + nullable: true + properties: + activity_processors: + description: Configured activity Processors + items: + $ref: '#/components/schemas/ActivityProcessorConfig' + title: Activity Processors + type: array + x-stream-index: "002.002" + activity_selectors: + description: Configuration for selecting activities + items: + $ref: '#/components/schemas/ActivitySelectorConfig' + title: Activity Selectors + type: array + x-stream-index: "002.001" + aggregation: + $ref: '#/components/schemas/AggregationConfig' + description: Configuration for aggregating activities + title: Aggregation + x-stream-index: "002.004" + id: + description: Unique identifier for the feed view + maxLength: 255 + title: View ID + type: string + x-stream-index: "001" + ranking: + $ref: '#/components/schemas/RankingConfig' + description: Configuration for ranking activities + title: Ranking + x-stream-index: "002.003" + required: + - id + title: Create Feed View Request + type: object + CreateFeedViewResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + feed_view: + $ref: '#/components/schemas/FeedViewResponse' + description: The created feed view + title: Feed View + x-stream-index: "001" + required: + - feed_view + - duration + title: Create Feed View Response + type: object + CreateFeedsBatchRequest: + nullable: true + properties: + feeds: + description: List of feeds to create + items: + $ref: '#/components/schemas/FeedRequest' + maximum: 1000 + minimum: 1 + title: Feeds + type: array + x-stream-index: "001" + required: + - feeds + title: Create Feeds Batch Request + type: object + CreateFeedsBatchResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + feeds: + description: List of created feeds + items: + $ref: '#/components/schemas/FeedResponse' + title: Feeds + type: array + x-stream-index: "001" + required: + - feeds + - duration + title: Create Feeds Batch Response + type: object + CreateGuestRequest: + nullable: true + properties: + user: + $ref: '#/components/schemas/UserRequest' + description: User object which server acts upon + title: User + x-stream-index: "001" + required: + - user + type: object + CreateGuestResponse: + nullable: true + properties: + access_token: + description: the access token to authenticate the user + title: Access token + type: string + x-stream-index: "002" + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "003.001" + user: + $ref: '#/components/schemas/UserResponse' + description: User object which server acts upon + title: User + x-stream-index: "001" + required: + - user + - access_token + - duration + type: object + CreateImportRequest: + nullable: true + properties: + mode: + enum: + - insert + - upsert + type: string + x-stream-index: "002" + path: + type: string + x-stream-index: "001" + required: + - path + - mode + type: object + CreateImportResponse: + description: Basic response information + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "002.001" + import_task: + $ref: '#/components/schemas/ImportTask' + x-stream-index: "001" + required: + - duration + title: Response + type: object + CreateImportURLRequest: + nullable: true + properties: + filename: + type: string + x-stream-index: "001" + type: object + CreateImportURLResponse: + description: Basic response information + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "003.001" + path: + type: string + x-stream-index: "001" + upload_url: + type: string + x-stream-index: "002" + required: + - path + - upload_url + - duration + title: Response + type: object + CreateMembershipLevelRequest: + nullable: true + properties: + custom: + additionalProperties: {} + description: Custom data for the membership level + title: Custom Data + type: object + x-stream-index: "006" + description: + description: Optional description of the membership level + maxLength: 1000 + title: Description + type: string + x-stream-index: "003" + id: + description: Unique identifier for the membership level + maxLength: 255 + title: ID + type: string + x-stream-index: "001" + name: + description: Display name for the membership level + maxLength: 255 + title: Name + type: string + x-stream-index: "002" + priority: + description: Priority level (higher numbers = higher priority) + format: int32 + minimum: 0 + title: Priority + type: integer + x-stream-index: "004" + tags: + description: Activity tags this membership level gives access to + items: + type: string + maximum: 255 + title: Tags + type: array + x-stream-index: "005" + required: + - id + - name + title: Create Membership Level Request + type: object + CreateMembershipLevelResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + membership_level: + $ref: '#/components/schemas/MembershipLevelResponse' + description: The created membership level + title: Membership Level + x-stream-index: "001" + required: + - membership_level + - duration + title: Create Membership Level Response + type: object + CreatePollOptionRequest: + nullable: true + properties: + Custom: + additionalProperties: {} + type: object + writeOnly: true + x-stream-index: "003" + text: + description: Option text + title: string + type: string + x-stream-index: "002" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "004.002" + user_id: + type: string + x-stream-index: "004.001" + required: + - text + type: object + CreatePollRequest: + description: Contains all information needed to create a new poll + nullable: true + properties: + Custom: + additionalProperties: {} + type: object + writeOnly: true + x-stream-index: "011" + allow_answers: + description: Indicates whether users can suggest user defined answers + title: Allow answers + type: boolean + x-stream-index: "009" + allow_user_suggested_options: + type: boolean + x-stream-index: "008" + description: + description: A description of the poll + title: Description + type: string + x-stream-index: "003" + enforce_unique_vote: + description: Indicates whether users can cast multiple votes + title: Multiple choice + type: boolean + x-stream-index: "006" + id: + maxLength: 255 + type: string + x-stream-index: "001" + is_closed: + description: Indicates whether the poll is open for voting + title: Is closed + type: boolean + x-stream-index: "010" + max_votes_allowed: + description: Indicates the maximum amount of votes a user can cast + format: int32 + maximum: 10 + title: Maximum votes allowed + type: integer + x-stream-index: "007" + name: + description: The name of the poll + title: Name + type: string + x-stream-index: "002" + options: + items: + $ref: '#/components/schemas/PollOptionInput' + maximum: 100 + type: array + x-stream-index: "004" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "012.002" + user_id: + type: string + x-stream-index: "012.001" + voting_visibility: + enum: + - anonymous + - public + type: string + x-stream-index: "005" + required: + - name + title: Create Poll Request + type: object + CreateRoleRequest: + nullable: true + properties: + name: + description: Role name + maxLength: 64 + title: Name + type: string + x-stream-index: "001" + required: + - name + type: object + CreateRoleResponse: + description: Basic response information + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "001.001" + role: + $ref: '#/components/schemas/Role' + x-stream-index: "002" + required: + - duration + - role + title: Response + type: object + CustomActionRequest: + properties: + id: + type: string + x-stream-index: "001" + options: + additionalProperties: {} + type: object + x-stream-index: "002" + type: object + CustomCheckFlag: + properties: + custom: + additionalProperties: {} + description: Additional metadata for the flag + title: Custom + type: object + x-stream-index: "003" + labels: + description: Labels from various moderation sources + items: + type: string + title: Labels + type: array + x-stream-index: "004" + reason: + description: Optional explanation for the flag + title: Reason + type: string + x-stream-index: "002" + type: + description: Type of check (custom_check_text, custom_check_image, custom_check_video) + maxLength: 255 + title: Type + type: string + x-stream-index: "001" + required: + - type + type: object + CustomCheckRequest: + nullable: true + properties: + entity_creator_id: + description: ID of the user who created the entity (required for non-message + entities) + title: Entity Creator ID + type: string + x-stream-index: "003" + entity_id: + description: Unique identifier of the entity + title: Entity ID + type: string + x-stream-index: "002" + entity_type: + description: Type of entity to perform custom check on + title: Entity Type + type: string + x-stream-index: "001" + flags: + description: List of custom check flags (1-10 flags required) + items: + $ref: '#/components/schemas/CustomCheckFlag' + maximum: 10 + minimum: 1 + title: Flags + type: array + x-stream-index: "005" + moderation_payload: + $ref: '#/components/schemas/ModerationPayload' + description: Content to be checked (required for non-message entities) + title: Moderation Payload + x-stream-index: "004" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "006.002" + user_id: + type: string + x-stream-index: "006.001" + required: + - entity_type + - entity_id + - flags + type: object + CustomCheckResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "004.001" + id: + description: Unique identifier of the custom check + title: ID + type: string + x-stream-index: "001" + item: + $ref: '#/components/schemas/ReviewQueueItemResponse' + description: Review queue item details + title: Item + x-stream-index: "002" + status: + description: Status of the custom check + title: Status + type: string + x-stream-index: "003" + required: + - id + - status + - duration + type: object + Data: + properties: + id: + type: string + x-stream-index: "001" + required: + - id + type: object + DataDogInfo: + properties: + api_key: + type: string + x-stream-index: "001" + enabled: + type: boolean + x-stream-index: "003" + site: + type: string + x-stream-index: "002" + type: object + DeactivateUserRequest: + nullable: true + properties: + created_by_id: + description: ID of the user who deactivated the user + title: Created by ID + type: string + x-stream-index: "003" + mark_messages_deleted: + description: Makes messages appear to be deleted + title: Mark messages deleted + type: boolean + x-stream-index: "002" + type: object + DeactivateUserResponse: + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "002.001" + user: + $ref: '#/components/schemas/UserResponse' + description: Deactivated user object + title: User + x-stream-index: "001" + required: + - duration + type: object + DeactivateUsersRequest: + description: Deactivate users request + nullable: true + properties: + created_by_id: + description: ID of the user who deactivated the users + title: Created by ID + type: string + x-stream-index: "003" + mark_channels_deleted: + type: boolean + x-stream-index: "004" + mark_messages_deleted: + description: Makes messages appear to be deleted + title: Mark messages deleted + type: boolean + x-stream-index: "002" + user_ids: + description: User IDs to deactivate + items: + type: string + maximum: 100 + minimum: 1 + title: User IDs + type: array + x-stream-index: "001" + required: + - user_ids + title: DeactivateUsersRequest + type: object + DeactivateUsersResponse: + description: Basic response information + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "002.001" + task_id: + type: string + x-stream-index: "001" + required: + - task_id + - duration + title: Response + type: object + DecayFunctionConfig: + properties: + base: + description: Base value for decay function + title: Base + type: string + x-stream-index: "001" + decay: + description: Decay rate + title: Decay + type: string + x-stream-index: "005" + direction: + description: Direction of decay + title: Direction + type: string + x-stream-index: "006" + offset: + description: Offset value for decay function + title: Offset + type: string + x-stream-index: "004" + origin: + description: Origin value for decay function + title: Origin + type: string + x-stream-index: "002" + scale: + description: Scale factor for decay function + title: Scale + type: string + x-stream-index: "003" + title: Decay Function Configuration + type: object + DeleteActivitiesRequest: + nullable: true + properties: + hard_delete: + description: Whether to permanently delete the activities + title: Hard Delete + type: boolean + x-stream-index: "002" + ids: + description: List of activity IDs to delete + items: + type: string + minimum: 1 + title: Activity IDs + type: array + x-stream-index: "001" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "004.002" + user_id: + type: string + x-stream-index: "004.001" + required: + - ids + title: Delete Activities Request + type: object + DeleteActivitiesResponse: + nullable: true + properties: + deleted_ids: + description: List of activity IDs that were successfully deleted + items: + type: string + title: Deleted Activity IDs + type: array + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - deleted_ids + - duration + title: Delete Activities Response + type: object + DeleteActivityReactionResponse: + nullable: true + properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + x-stream-index: "001" + duration: + type: string + x-stream-index: "003.001" + reaction: + $ref: '#/components/schemas/FeedsReactionResponse' + x-stream-index: "002" + required: + - activity + - reaction + - duration + title: Delete Activity Reaction Response + type: object + DeleteActivityRequest: + properties: + hard_delete: + type: boolean + x-stream-index: "001" + type: object + DeleteActivityResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "001.001" + required: + - duration + title: Delete Activity Response + type: object + DeleteBookmarkFolderResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "001.001" + required: + - duration + title: Delete Bookmark Folder Response + type: object + DeleteBookmarkResponse: + nullable: true + properties: + bookmark: + $ref: '#/components/schemas/BookmarkResponse' + description: The deleted bookmark + title: Bookmark + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - bookmark + - duration + title: Delete Bookmark Response + type: object + DeleteCommentReactionResponse: + nullable: true + properties: + comment: + $ref: '#/components/schemas/CommentResponse' + description: The comment after reaction removal + title: Comment + x-stream-index: "001" + duration: + type: string + x-stream-index: "003.001" + reaction: + $ref: '#/components/schemas/FeedsReactionResponse' + description: The removed reaction + title: Reaction + x-stream-index: "002" + required: + - comment + - reaction + - duration + title: Delete Comment Reaction Response + type: object + DeleteCommentResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "001.001" + required: + - duration + title: Delete Comment Response + type: object + DeleteExternalStorageResponse: + 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 + DeleteFeedGroupResponse: + 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 + DeleteFeedResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "001.001" + required: + - duration + title: Delete Feed Response + type: object + DeleteFeedUserDataResponse: + description: Response for deleting feed user data + nullable: true + properties: + deleted_activities: + description: Number of activities that were deleted + format: int32 + title: Deleted Activities + type: integer + x-stream-index: "001" + deleted_bookmarks: + description: Number of bookmarks that were deleted + format: int32 + title: Deleted Bookmarks + type: integer + x-stream-index: "004" + deleted_comments: + description: Number of comments that were deleted + format: int32 + title: Deleted Comments + type: integer + x-stream-index: "003" + deleted_reactions: + description: Number of reactions that were deleted + format: int32 + title: Deleted Reactions + type: integer + x-stream-index: "002" + duration: + type: string + x-stream-index: "005.001" + required: + - deleted_activities + - deleted_reactions + - deleted_comments + - deleted_bookmarks + - duration + type: object + DeleteFeedViewResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "001.001" + required: + - duration + title: Delete Feed View Response + type: object + DeleteMessageRequest: + properties: + hard_delete: + type: boolean + x-stream-index: "001" + type: object + DeleteModerationConfigResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "001.001" + required: + - duration + type: object + DeleteModerationRuleResponse: + 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 + DeleteModerationTemplateResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "001.001" + required: + - duration + type: object + DeleteReactionRequest: + properties: + hard_delete: + type: boolean + x-stream-index: "001" + type: object + DeleteUserRequest: + properties: + delete_conversation_channels: + type: boolean + x-stream-index: "003" + delete_feeds_content: + type: boolean + x-stream-index: "004" + hard_delete: + type: boolean + x-stream-index: "001" + mark_messages_deleted: + type: boolean + x-stream-index: "002" + type: object + DeleteUsersRequest: + nullable: true + properties: + calls: + description: | + Calls delete mode. + Affected calls are those that include exactly two members, one of whom is the user being deleted. + + * null or empty string - doesn't delete any calls + * soft - marks user's calls and their related data as deleted (soft-delete) + * hard - deletes user's calls and their data completely (hard-delete) + enum: + - soft + - hard + title: Delete User's calls + type: string + x-stream-index: 001.002.004 + conversations: + description: | + Conversation channels delete mode. + Conversation channel is any channel which only has two members one of which is the user being deleted. + + * null or empty string - doesn't delete any conversation channels + * soft - marks all conversation channels as deleted (same effect as Delete Channels with 'hard' option disabled) + * hard - deletes channel and all its data completely including messages (same effect as Delete Channels with 'hard' option enabled) + enum: + - soft + - hard + title: Delete Conversations + type: string + x-stream-index: 001.002.003 + files: + description: | + Delete user files. + * false or empty string - doesn't delete any files + * true - deletes all files uploaded by the user, including images and attachments. + title: Delete User's files + type: boolean + x-stream-index: 001.002.005 + messages: + description: | + Message delete mode. + + * null or empty string - doesn't delete user messages + * soft - marks all user messages as deleted without removing any related message data + * pruning - marks all user messages as deleted, nullifies message information and removes some message data such as reactions and flags + * hard - deletes messages completely with all related information + enum: + - soft + - pruning + - hard + title: Delete Messages + type: string + x-stream-index: 001.002.002 + new_call_owner_id: + type: string + x-stream-index: 001.002.007 + new_channel_owner_id: + type: string + x-stream-index: 001.002.006 + user: + description: | + User delete mode. + + * soft - marks user as deleted and retains all user data + * pruning - marks user as deleted and nullifies user information + * hard - deletes user completely. Requires 'hard' option for messages and conversations as well + enum: + - soft + - pruning + - hard + title: Delete User + type: string + x-stream-index: 001.002.001 + user_ids: + description: IDs of users to delete + items: + type: string + maximum: 100 + minimum: 1 + title: User IDs + type: array + x-stream-index: "001.001" + required: + - user_ids + type: object + DeleteUsersResponse: + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "002.001" + task_id: + description: ID of the task to delete users + title: Task ID + type: string + x-stream-index: "001" + required: + - task_id + - duration + type: object + Device: + nullable: true + properties: + created_at: + format: date-time + type: number + x-stream-index: "002.002" + disabled: + type: boolean + x-stream-index: "002.003" + disabled_reason: + type: string + x-stream-index: "002.004" + id: + type: string + x-stream-index: 002.001.004 + push_provider: + enum: + - firebase + - apn + - huawei + - xiaomi + type: string + x-stream-index: 002.001.001 + push_provider_name: + type: string + x-stream-index: 002.001.003 + user_id: + type: string + x-stream-index: "004" + voip: + type: boolean + x-stream-index: 002.001.005 + required: + - push_provider + - id + - created_at + - user_id + type: object + DeviceErrorInfo: + properties: + error_message: + type: string + x-stream-index: "003" + provider: + type: string + x-stream-index: "001" + provider_name: + type: string + x-stream-index: "002" + required: + - provider + - provider_name + - error_message + type: object + DeviceResponse: + description: Response for Device + nullable: true + properties: + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: "004" + disabled: + description: Whether device is disabled or not + title: Disabled + type: boolean + x-stream-index: "005" + disabled_reason: + description: Reason explaining why device had been disabled + title: Reason + type: string + x-stream-index: "006" + id: + description: Device ID + title: ID + type: string + x-stream-index: "003" + push_provider: + description: Push provider + title: PushProvider + type: string + x-stream-index: "001" + push_provider_name: + description: Push provider name + title: PushProviderName + type: string + x-stream-index: "002" + user_id: + description: User ID + title: UserID + type: string + x-stream-index: "008" + voip: + description: When true the token is for Apple VoIP push notifications + title: Voip + type: boolean + x-stream-index: "007" + required: + - push_provider + - id + - created_at + - user_id + title: DeviceResponse + type: object + DraftPayloadResponse: + properties: + attachments: + items: + $ref: '#/components/schemas/Attachment' + type: array + x-stream-index: "004" + custom: + additionalProperties: {} + type: object + x-stream-index: "007" + html: + type: string + x-stream-index: "010" + id: + type: string + x-stream-index: "001" + mentioned_users: + items: + $ref: '#/components/schemas/UserResponse' + type: array + x-stream-index: "008" + mml: + type: string + x-stream-index: "003" + parent_id: + type: string + x-stream-index: "005" + poll_id: + type: string + x-stream-index: "013" + quoted_message_id: + type: string + x-stream-index: "009" + show_in_channel: + type: boolean + x-stream-index: "006" + silent: + type: boolean + x-stream-index: "012" + text: + type: string + x-stream-index: "002" + type: + type: string + x-stream-index: "011" + required: + - id + - text + - custom + type: object + DraftResponse: + properties: + channel: + $ref: '#/components/schemas/ChannelResponse' + x-stream-index: "003" + channel_cid: + type: string + x-stream-index: "002" + created_at: + format: date-time + type: number + x-stream-index: "007" + message: + $ref: '#/components/schemas/DraftPayloadResponse' + x-stream-index: "001" + parent_id: + type: string + x-stream-index: "004" + parent_message: + $ref: '#/components/schemas/MessageResponse' + x-stream-index: "005" + quoted_message: + $ref: '#/components/schemas/MessageResponse' + x-stream-index: "006" + required: + - message + - channel_cid + - created_at + type: object + EgressHLSResponse: + properties: + playlist_url: + type: string + x-stream-index: "001" + status: + type: string + x-stream-index: "002" + required: + - playlist_url + - status + type: object + EgressRTMPResponse: + properties: + name: + type: string + x-stream-index: "001" + started_at: + format: date-time + type: number + x-stream-index: "004" + stream_key: + type: string + x-stream-index: "003" + stream_url: + type: string + x-stream-index: "002" + required: + - name + - started_at + type: object + EgressResponse: + properties: + broadcasting: + type: boolean + x-stream-index: "001" + frame_recording: + $ref: '#/components/schemas/FrameRecordingResponse' + x-stream-index: "004" + hls: + $ref: '#/components/schemas/EgressHLSResponse' + x-stream-index: "002" + rtmps: + items: + $ref: '#/components/schemas/EgressRTMPResponse' + type: array + x-stream-index: "003" + required: + - broadcasting + - rtmps + type: object + EgressTaskConfig: + properties: + egress_user: + $ref: '#/components/schemas/EgressUser' + x-stream-index: "008" + frame_recording_egress_config: + $ref: '#/components/schemas/FrameRecordingEgressConfig' + x-stream-index: "009" + hls_egress_config: + $ref: '#/components/schemas/HLSEgressConfig' + x-stream-index: "007" + recording_egress_config: + $ref: '#/components/schemas/RecordingEgressConfig' + x-stream-index: "006" + rtmp_egress_config: + $ref: '#/components/schemas/RTMPEgressConfig' + x-stream-index: "004" + stt_egress_config: + $ref: '#/components/schemas/STTEgressConfig' + x-stream-index: "005" + type: object + EgressUser: + properties: + token: + type: string + x-stream-index: "004" + type: object + EnrichedActivity: + properties: + actor: + $ref: '#/components/schemas/Data' + x-stream-index: "002" + foreign_id: + type: string + x-stream-index: "005" + id: + type: string + x-stream-index: "001" + latest_reactions: + additionalProperties: + items: + $ref: '#/components/schemas/EnrichedReaction' + type: array + type: object + x-stream-index: "013" + object: + $ref: '#/components/schemas/Data' + x-stream-index: "004" + origin: + $ref: '#/components/schemas/Data' + x-stream-index: "008" + own_reactions: + additionalProperties: + items: + $ref: '#/components/schemas/EnrichedReaction' + type: array + type: object + x-stream-index: "012" + reaction_counts: + additionalProperties: + format: int32 + type: integer + type: object + x-stream-index: "011" + score: + format: float + type: number + x-stream-index: "010" + target: + $ref: '#/components/schemas/Data' + x-stream-index: "006" + to: + items: + type: string + type: array + x-stream-index: "009" + verb: + type: string + x-stream-index: "003" + type: object + EnrichedReaction: + nullable: true + properties: + activity_id: + type: string + x-stream-index: "003" + children_counts: + additionalProperties: + format: int32 + type: integer + type: object + x-stream-index: "010" + created_at: + $ref: '#/components/schemas/Time' + x-stream-index: "012" + data: + additionalProperties: {} + type: object + x-stream-index: "005" + id: + type: string + x-stream-index: "001" + kind: + type: string + x-stream-index: "002" + latest_children: + additionalProperties: + items: + $ref: '#/components/schemas/EnrichedReaction' + type: array + type: object + x-stream-index: "008" + own_children: + additionalProperties: + items: + $ref: '#/components/schemas/EnrichedReaction' + type: array + type: object + x-stream-index: "009" + parent: + type: string + x-stream-index: "007" + target_feeds: + items: + type: string + type: array + x-stream-index: "006" + updated_at: + $ref: '#/components/schemas/Time' + x-stream-index: "013" + user: + $ref: '#/components/schemas/Data' + x-stream-index: "011" + user_id: + type: string + x-stream-index: "004" + required: + - kind + - activity_id + - user_id + type: object + EntityCreator: + properties: + avg_response_time: + format: int32 + readOnly: true + type: integer + x-stream-index: "001.046" + ban_count: + format: int32 + type: integer + x-stream-index: "002" + ban_expires: + format: date-time + type: number + x-stream-index: "001.017" + banned: + type: boolean + x-stream-index: "001.016" + created_at: + format: date-time + readOnly: true + type: number + x-stream-index: "001.008" + custom: + additionalProperties: {} + type: object + x-stream-index: "001.006" + deactivated_at: + format: date-time + readOnly: true + type: number + x-stream-index: "001.014" + deleted_at: + format: date-time + readOnly: true + type: number + x-stream-index: "001.013" + deleted_content_count: + format: int32 + type: integer + x-stream-index: "003" + id: + type: string + x-stream-index: "001.003" + invisible: + type: boolean + x-stream-index: "001.023" + language: + type: string + x-stream-index: "001.035" + last_active: + format: date-time + readOnly: true + type: number + x-stream-index: "001.011" + last_engaged_at: + format: date-time + readOnly: true + type: number + x-stream-index: "001.012" + online: + readOnly: true + type: boolean + x-stream-index: "001.022" + privacy_settings: + $ref: '#/components/schemas/PrivacySettings' + x-stream-index: "001.026" + revoke_tokens_issued_before: + format: date-time + type: number + x-stream-index: "001.042" + role: + type: string + x-stream-index: "001.004" + teams: + items: + type: string + type: array + x-stream-index: "001.036" + teams_role: + additionalProperties: + type: string + type: object + x-stream-index: "001.005" + updated_at: + format: date-time + readOnly: true + type: number + x-stream-index: "001.009" + required: + - id + - role + - teams_role + - custom + - banned + - online + - ban_count + - deleted_content_count + type: object + EntityCreatorResponse: + properties: + avg_response_time: + format: int32 + type: integer + x-stream-index: 001.001.018 + ban_count: + description: Number of minor actions performed on the user + format: int32 + title: Ban Count + type: integer + x-stream-index: "002" + ban_expires: + format: date-time + type: number + x-stream-index: "001.003" + banned: + type: boolean + x-stream-index: 001.001.012 + blocked_user_ids: + items: + type: string + type: array + x-stream-index: 001.001.017 + created_at: + format: date-time + type: number + x-stream-index: 001.001.009 + custom: + additionalProperties: {} + type: object + x-stream-index: 001.001.004 + deactivated_at: + format: date-time + type: number + x-stream-index: 001.001.016 + deleted_at: + format: date-time + type: number + x-stream-index: 001.001.011 + deleted_content_count: + description: Number of major actions performed on the user + format: int32 + title: Deleted Content Count + type: integer + x-stream-index: "003" + devices: + items: + $ref: '#/components/schemas/DeviceResponse' + type: array + x-stream-index: "001.006" + flagged_count: + description: Number of flag actions performed on the user + format: int32 + title: Flagged Count + type: integer + x-stream-index: "004" + id: + type: string + x-stream-index: 001.001.001 + image: + type: string + x-stream-index: 001.001.003 + invisible: + type: boolean + x-stream-index: "001.007" + language: + type: string + x-stream-index: 001.001.005 + last_active: + format: date-time + type: number + x-stream-index: 001.001.014 + name: + type: string + x-stream-index: 001.001.002 + online: + type: boolean + x-stream-index: 001.001.013 + privacy_settings: + $ref: '#/components/schemas/PrivacySettingsResponse' + x-stream-index: "001.005" + push_notifications: + $ref: '#/components/schemas/PushNotificationSettingsResponse' + x-stream-index: "001.004" + revoke_tokens_issued_before: + format: date-time + type: number + x-stream-index: 001.001.015 + role: + type: string + x-stream-index: 001.001.006 + shadow_banned: + type: boolean + x-stream-index: "001.002" + teams: + items: + type: string + type: array + x-stream-index: 001.001.007 + teams_role: + additionalProperties: + type: string + type: object + x-stream-index: 001.001.008 + updated_at: + format: date-time + type: number + x-stream-index: 001.001.010 + required: + - id + - custom + - language + - role + - teams + - created_at + - updated_at + - banned + - online + - blocked_user_ids + - shadow_banned + - invisible + - ban_count + - deleted_content_count + - flagged_count + type: object + ErrorResult: + properties: + stacktrace: + type: string + x-stream-index: "003" + type: + type: string + x-stream-index: "001" + version: + type: string + x-stream-index: "004" + required: + - type + - description + type: object + EventHook: + nullable: true + properties: + callback: + $ref: '#/components/schemas/AsyncModerationCallbackConfig' + x-stream-index: 019.001.002 + created_at: + format: date-time + type: number + x-stream-index: "020" + enabled: + type: boolean + x-stream-index: "003" + event_types: + items: + type: string + type: array + x-stream-index: "004" + hook_type: + type: string + x-stream-index: "002" + id: + type: string + x-stream-index: "001" + product: + type: string + x-stream-index: "018" + sns_auth_type: + type: string + x-stream-index: "014" + sns_key: + type: string + x-stream-index: "015" + sns_region: + type: string + x-stream-index: "013" + sns_role_arn: + type: string + x-stream-index: "017" + sns_secret: + type: string + x-stream-index: "016" + sns_topic_arn: + type: string + x-stream-index: "012" + sqs_auth_type: + type: string + x-stream-index: "008" + sqs_key: + type: string + x-stream-index: "009" + sqs_queue_url: + type: string + x-stream-index: "006" + sqs_region: + type: string + x-stream-index: "007" + sqs_role_arn: + type: string + x-stream-index: "011" + sqs_secret: + type: string + x-stream-index: "010" + timeout_ms: + format: int32 + type: integer + x-stream-index: 019.001.001 + updated_at: + format: date-time + type: number + x-stream-index: "021" + webhook_url: + type: string + x-stream-index: "005" + type: object + EventNotificationSettings: + properties: + apns: + $ref: '#/components/schemas/APNS' + x-stream-index: "002" + enabled: + type: boolean + x-stream-index: "001" + fcm: + $ref: '#/components/schemas/FCM' + x-stream-index: "003" + required: + - enabled + - apns + - fcm + type: object + ExportFeedUserDataRequest: + description: Request for exporting feed user data + nullable: true + type: object + ExportFeedUserDataResponse: + description: Response for exporting feed user data + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + task_id: + description: The task ID for the export task + title: Task ID + type: string + x-stream-index: "001" + required: + - task_id + - duration + type: object + ExportUserResponse: + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "004.001" + messages: + description: List of exported messages + items: + $ref: '#/components/schemas/MessageResponse' + title: Messages + type: array + x-stream-index: "002" + reactions: + description: List of exported reactions + items: + $ref: '#/components/schemas/ReactionResponse' + title: Reactions + type: array + x-stream-index: "003" + user: + $ref: '#/components/schemas/UserResponse' + description: Exported user object + title: User + x-stream-index: "001" + required: + - duration + type: object + ExportUsersRequest: + nullable: true + properties: + user_ids: + items: + type: string + maximum: 25 + minimum: 1 + type: array + x-stream-index: "001" + required: + - user_ids + type: object + ExportUsersResponse: + description: Basic response information + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "002.001" + task_id: + type: string + x-stream-index: "001" + required: + - task_id + - duration + title: Response + type: object + ExternalStorage: + properties: + abs_account_name: + type: string + x-stream-index: "011" + abs_client_id: + type: string + x-stream-index: "013" + abs_client_secret: + type: string + x-stream-index: "014" + abs_tenant_id: + type: string + x-stream-index: "012" + bucket: + type: string + x-stream-index: "005" + gcs_credentials: + type: string + x-stream-index: "010" + path: + type: string + x-stream-index: "006" + s3_api_key: + type: string + x-stream-index: "007" + s3_custom_endpoint: + type: string + x-stream-index: "016" + s3_region: + type: string + x-stream-index: "009" + s3_secret_key: + type: string + x-stream-index: "008" + storage_name: + type: string + x-stream-index: "015" + storage_type: + type: integer + x-stream-index: "004" + type: object + ExternalStorageResponse: + properties: + bucket: + type: string + x-stream-index: "003" + name: + type: string + x-stream-index: "001" + path: + type: string + x-stream-index: "004" + type: + enum: + - s3 + - gcs + - abs + type: string + x-stream-index: "002" + required: + - name + - type + - bucket + - path + type: object + FCM: + properties: + data: + additionalProperties: {} + type: object + x-stream-index: "001" + type: object + FeedCreatedEvent: + description: Emitted when a feed is created. + nullable: true + properties: + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 003.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 003.001.007 + feed: + $ref: '#/components/schemas/FeedResponse' + description: The feed that was created + title: Feed + x-stream-index: "001" + feed_visibility: + type: string + x-stream-index: "003.003" + fid: + type: string + x-stream-index: "003.002" + members: + items: + $ref: '#/components/schemas/FeedMemberResponse' + type: array + x-stream-index: "002" + received_at: + format: date-time + type: number + x-stream-index: 003.001.004 + type: + default: feeds.feed.created + description: 'The type of event: "feeds.feed.created" in this case' + title: Event Type + type: string + x-stream-index: 003.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who created the feed + title: User + x-stream-index: "004.001" + required: + - feed + - members + - type + - created_at + - custom + - fid + - user + title: FeedCreatedEvent + 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 + FeedDeletedEvent: + description: Emitted when a feed is deleted. + nullable: true + properties: + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 001.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 001.001.007 + feed_visibility: + type: string + x-stream-index: "001.003" + fid: + type: string + x-stream-index: "001.002" + received_at: + format: date-time + type: number + x-stream-index: 001.001.004 + type: + default: feeds.feed.deleted + description: 'The type of event: "feeds.feed.deleted" in this case' + title: Event Type + type: string + x-stream-index: 001.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who deleted the feed + title: User + x-stream-index: "002.001" + required: + - type + - created_at + - custom + - fid + title: FeedDeletedEvent + 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 + FeedGroup: + properties: + ActivityProcessors: + items: + $ref: '#/components/schemas/ActivityProcessorConfig' + type: array + writeOnly: true + x-stream-index: "012" + ActivitySelectors: + items: + $ref: '#/components/schemas/ActivitySelectorConfig' + type: array + writeOnly: true + x-stream-index: "013" + Aggregation: + $ref: '#/components/schemas/AggregationConfig' + x-stream-index: "015" + AggregationVersion: + format: int32 + type: integer + writeOnly: true + x-stream-index: "016" + AppPK: + format: int32 + type: integer + writeOnly: true + x-stream-index: "002" + Custom: + additionalProperties: {} + type: object + writeOnly: true + x-stream-index: "007" + DefaultVisibility: + type: string + writeOnly: true + x-stream-index: "006" + DeletedAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "010" + ID: + type: string + writeOnly: true + x-stream-index: "003" + LastFeedGetAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "017" + Notification: + $ref: '#/components/schemas/NotificationConfig' + x-stream-index: "004" + PushNotification: + $ref: '#/components/schemas/PushNotificationConfig' + x-stream-index: "005" + Ranking: + $ref: '#/components/schemas/RankingConfig' + x-stream-index: "014" + Stories: + $ref: '#/components/schemas/StoriesConfig' + x-stream-index: "011" + created_at: + format: date-time + type: number + x-stream-index: "008" + updated_at: + format: date-time + type: number + x-stream-index: "009" + required: + - AppPK + - ID + - DefaultVisibility + - Custom + - created_at + - updated_at + - ActivityProcessors + - ActivitySelectors + - AggregationVersion + type: object + FeedGroupChangedEvent: + description: Emitted when a feed group is changed. + nullable: true + properties: + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 001.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 001.001.007 + feed_group: + $ref: '#/components/schemas/FeedGroup' + description: The feed group that was changed + title: Feed Type + x-stream-index: "003" + feed_visibility: + type: string + x-stream-index: "001.003" + fid: + type: string + x-stream-index: "001.002" + received_at: + format: date-time + type: number + x-stream-index: 001.001.004 + type: + default: feeds.feed_group.changed + description: 'The type of event: "feeds.feed_group.changed" in this case' + title: Event Type + type: string + x-stream-index: 001.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who changed the feed group + title: User + x-stream-index: "002.001" + required: + - type + - created_at + - custom + - fid + title: FeedGroupChangedEvent + 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 + FeedGroupDeletedEvent: + description: Emitted when a feed group is deleted. + nullable: true + properties: + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + feed_visibility: + type: string + x-stream-index: "002.003" + fid: + type: string + x-stream-index: "002.002" + group_id: + description: The ID of the feed group that was deleted + title: Group ID + type: string + x-stream-index: "001" + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 + type: + default: feeds.feed_group.deleted + description: 'The type of event: "feeds.feed_group.deleted" in this case' + title: Event Type + type: string + x-stream-index: 002.001.002 + required: + - group_id + - type + - created_at + - custom + - fid + title: FeedGroupDeletedEvent + 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 + FeedGroupResponse: + properties: + activity_processors: + description: Configuration for activity processors + items: + $ref: '#/components/schemas/ActivityProcessorConfig' + title: Activity Processors + type: array + x-stream-index: "009" + activity_selectors: + description: Configuration for activity selectors + items: + $ref: '#/components/schemas/ActivitySelectorConfig' + title: Activity Selectors + type: array + x-stream-index: "010" + aggregation: + $ref: '#/components/schemas/AggregationConfig' + description: Configuration for activity aggregation + title: Aggregation + x-stream-index: "012" + created_at: + description: When the feed group was created + format: date-time + title: Created At + type: number + x-stream-index: "006" + custom: + additionalProperties: {} + description: Custom data for the feed group + title: Custom Data + type: object + x-stream-index: "005" + default_visibility: + description: Default visibility for activities + title: Default Visibility + type: string + x-stream-index: "004" + id: + description: Identifier within the group + title: Feed Group ID + type: string + x-stream-index: "001" + notification: + $ref: '#/components/schemas/NotificationConfig' + description: Configuration for notifications + title: Notification + x-stream-index: "002" + push_notification: + $ref: '#/components/schemas/PushNotificationConfig' + x-stream-index: "003" + ranking: + $ref: '#/components/schemas/RankingConfig' + description: Configuration for activity ranking + title: Ranking + x-stream-index: "011" + stories: + $ref: '#/components/schemas/StoriesConfig' + description: Configuration for stories feature + title: Stories + x-stream-index: "008" + updated_at: + description: When the feed group was last updated + format: date-time + title: Updated At + type: number + x-stream-index: "007" + required: + - id + - created_at + - updated_at + title: Feed Group + type: object + FeedInput: + properties: + custom: + additionalProperties: {} + type: object + x-stream-index: "004" + description: + maxLength: 1000 + type: string + x-stream-index: "002" + filter_tags: + items: + type: string + maximum: 255 + type: array + x-stream-index: "005" + members: + items: + $ref: '#/components/schemas/FeedMemberRequest' + type: array + x-stream-index: "006" + name: + maxLength: 255 + type: string + x-stream-index: "001" + visibility: + enum: + - public + - visible + - followers + - members + - private + type: string + x-stream-index: "003" + type: object + FeedMemberAddedEvent: + description: Emitted when a feed member is added. + nullable: true + properties: + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 003.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 003.001.007 + feed_visibility: + type: string + x-stream-index: "003.003" + fid: + type: string + x-stream-index: "003.002" + member: + $ref: '#/components/schemas/FeedMemberResponse' + description: The member that was added + title: Member + x-stream-index: "001" + received_at: + format: date-time + type: number + x-stream-index: 003.001.004 + type: + default: feeds.feed_member.added + description: 'The type of event: "feeds.feed_member.added" in this case' + title: Event Type + type: string + x-stream-index: 003.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who added the member + title: User + x-stream-index: "002.001" + required: + - member + - type + - created_at + - custom + - fid + title: FeedMemberAddedEvent + 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 + FeedMemberRemovedEvent: + description: Emitted when a feed member is removed. + nullable: true + properties: + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 003.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 003.001.007 + feed_visibility: + type: string + x-stream-index: "003.003" + fid: + type: string + x-stream-index: "003.002" + member_id: + type: string + x-stream-index: "001" + received_at: + format: date-time + type: number + x-stream-index: 003.001.004 + type: + default: feeds.feed_member.removed + description: 'The type of event: "feeds.feed_member.removed" in this case' + title: Event Type + type: string + x-stream-index: 003.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who removed the member + title: User + x-stream-index: "002.001" + required: + - member_id + - type + - created_at + - custom + - fid + title: FeedMemberRemovedEvent + 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 + FeedMemberRequest: + properties: + custom: + additionalProperties: {} + description: Custom data for the member + title: Custom Data + type: object + x-stream-index: "004" + invite: + description: Whether this is an invite to become a member + title: Invite + type: boolean + x-stream-index: "005" + membership_level: + description: ID of the membership level to assign to the member + maxLength: 255 + title: Membership Level + type: string + x-stream-index: "003" + role: + description: Role of the member in the feed + maxLength: 255 + title: Role + type: string + x-stream-index: "002" + user_id: + description: ID of the user to add as a member + maxLength: 255 + title: User ID + type: string + x-stream-index: "001" + required: + - user_id + title: Feed Member Payload + type: object + FeedMemberResponse: + properties: + created_at: + description: When the membership was created + format: date-time + title: Created At + type: number + x-stream-index: "008" + custom: + additionalProperties: {} + description: Custom data for the membership + title: Custom Data + type: object + x-stream-index: "007" + invite_accepted_at: + description: When the invite was accepted + format: date-time + title: Invite Accepted At + type: number + x-stream-index: "005" + invite_rejected_at: + description: When the invite was rejected + format: date-time + title: Invite Rejected At + type: number + x-stream-index: "006" + membership_level: + $ref: '#/components/schemas/MembershipLevelResponse' + description: Membership level assigned to the member + title: Membership Level + x-stream-index: "004" + role: + description: Role of the member in the feed + title: Role + type: string + x-stream-index: "002" + status: + description: Status of the membership + enum: + - member + - pending + - rejected + title: Status + type: string + x-stream-index: "003" + updated_at: + description: When the membership was last updated + format: date-time + title: Updated At + type: number + x-stream-index: "009" + user: + $ref: '#/components/schemas/UserResponse' + description: User who is a member + title: User + x-stream-index: "001" + required: + - user + - role + - status + - created_at + - updated_at + title: Feed Member + type: object + FeedMemberUpdatedEvent: + description: Emitted when a feed member is updated. + nullable: true + properties: + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 003.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 003.001.007 + feed_visibility: + type: string + x-stream-index: "003.003" + fid: + type: string + x-stream-index: "003.002" + member: + $ref: '#/components/schemas/FeedMemberResponse' + description: The member that was updated + title: Member + x-stream-index: "001" + received_at: + format: date-time + type: number + x-stream-index: 003.001.004 + type: + default: feeds.feed_member.updated + description: 'The type of event: "feeds.feed_member.updated" in this case' + title: Event Type + type: string + x-stream-index: 003.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who updated the member + title: User + x-stream-index: "002.001" + required: + - member + - type + - created_at + - custom + - fid + title: FeedMemberUpdatedEvent + 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 + FeedOwnCapability: + description: All possibility of string to use + enum: + - add-activity + - add-activity-reaction + - add-comment + - add-comment-reaction + - bookmark-activity + - create-feed + - delete-bookmark + - delete-comment + - delete-feed + - edit-bookmark + - follow + - invite-feed + - join-feed + - leave-feed + - manage-feed-group + - mark-activity + - pin-activity + - query-feed-members + - query-follows + - read-activities + - read-feed + - remove-activity + - remove-activity-reaction + - remove-comment-reaction + - unfollow + - update-activity + - update-comment + - update-feed + - update-feed-followers + - update-feed-members + title: FeedOwnCapability + type: string + FeedRequest: + properties: + created_by_id: + description: ID of the feed creator + title: Created By ID + type: string + x-stream-index: "003" + custom: + additionalProperties: {} + description: Custom data for the feed + title: Custom Data + type: object + x-stream-index: "004.004" + description: + description: Description of the feed + maxLength: 1000 + title: Description + type: string + x-stream-index: "004.002" + feed_group_id: + description: ID of the feed group + maxLength: 255 + title: Feed Group ID + type: string + x-stream-index: "001" + feed_id: + description: ID of the feed + maxLength: 255 + title: Feed ID + type: string + x-stream-index: "002" + filter_tags: + description: Tags used for filtering feeds + items: + type: string + maximum: 255 + title: Filter Tags + type: array + x-stream-index: "004.005" + members: + description: Initial members for the feed + items: + $ref: '#/components/schemas/FeedMemberRequest' + title: Members + type: array + x-stream-index: "004.006" + name: + description: Name of the feed + maxLength: 255 + title: Name + type: string + x-stream-index: "004.001" + visibility: + description: Visibility setting for the feed + enum: + - public + - visible + - followers + - members + - private + title: Visibility + type: string + x-stream-index: "004.003" + required: + - feed_group_id + - feed_id + title: Feed Payload + type: object + FeedResponse: + properties: + created_at: + description: When the feed was created + format: date-time + title: Created At + type: number + x-stream-index: "015" + created_by: + $ref: '#/components/schemas/UserResponse' + description: User who created the feed + title: Created By + x-stream-index: "009" + custom: + additionalProperties: {} + description: Custom data for the feed + title: Custom Data + type: object + x-stream-index: "006" + deleted_at: + description: When the feed was deleted + format: date-time + title: Deleted At + type: number + x-stream-index: "017" + description: + description: Description of the feed + title: Description + type: string + x-stream-index: "005" + feed: + description: Fully qualified feed ID (group_id:id) + title: FID + type: string + x-stream-index: "003" + filter_tags: + description: Tags used for filtering feeds + items: + type: string + title: Filter Tags + type: array + x-stream-index: "007" + follower_count: + description: Number of followers of this feed + format: int32 + title: Follower Count + type: integer + x-stream-index: "011" + following_count: + description: Number of feeds this feed follows + format: int32 + title: Following Count + type: integer + x-stream-index: "012" + group_id: + description: Group this feed belongs to + title: Group ID + type: string + x-stream-index: "001" + id: + description: Unique identifier for the feed + title: ID + type: string + x-stream-index: "002" + member_count: + description: Number of members in this feed + format: int32 + title: Member Count + type: integer + x-stream-index: "010" + name: + description: Name of the feed + title: Name + type: string + x-stream-index: "004" + own_follows: + description: Follow relationships where the current user's feeds are following + this feed + items: + $ref: '#/components/schemas/FollowResponse' + title: Own Follows + type: array + x-stream-index: "014" + pin_count: + description: Number of pinned activities in this feed + format: int32 + title: Pin Count + type: integer + x-stream-index: "013" + updated_at: + description: When the feed was last updated + format: date-time + title: Updated At + type: number + x-stream-index: "016" + visibility: + description: Visibility setting for the feed + title: Visibility + type: string + x-stream-index: "008" + required: + - group_id + - id + - feed + - name + - description + - created_by + - member_count + - follower_count + - following_count + - pin_count + - created_at + - updated_at + title: Feed + type: object + FeedUpdatedEvent: + description: Emitted when a feed is created. + nullable: true + properties: + created_at: + format: date-time + type: number + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + feed: + $ref: '#/components/schemas/FeedResponse' + description: The feed that was created + title: Feed + x-stream-index: "001" + feed_visibility: + type: string + x-stream-index: "002.003" + fid: + type: string + x-stream-index: "002.002" + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 + type: + default: feeds.feed.updated + description: 'The type of event: "feeds.feed.updated" in this case' + title: Event Type + type: string + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who created the feed + title: User + x-stream-index: "003.001" + required: + - feed + - type + - created_at + - custom + - fid + title: FeedUpdatedEvent + 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 + FeedViewResponse: + properties: + activity_processors: + description: Configured activity processors + items: + $ref: '#/components/schemas/ActivityProcessorConfig' + title: Activity Processors + type: array + x-stream-index: "003" + activity_selectors: + description: Configured activity selectors + items: + $ref: '#/components/schemas/ActivitySelectorConfig' + title: Activity Selectors + type: array + x-stream-index: "002" + aggregation: + $ref: '#/components/schemas/AggregationConfig' + description: Configuration for activity aggregation + title: Aggregation + x-stream-index: "005" + id: + description: Unique identifier for the custom feed view + title: View ID + type: string + x-stream-index: "001" + last_used_at: + description: When the feed view was last used + format: date-time + title: Last Used At + type: number + x-stream-index: "006" + ranking: + $ref: '#/components/schemas/RankingConfig' + description: Configuration for activity ranking + title: Ranking + x-stream-index: "004" + required: + - id + title: Feed View + type: object + FeedsEventPreferences: + properties: + comments: + type: string + x-stream-index: "002" + mentions: + type: string + x-stream-index: "004" + new_followers: + type: string + x-stream-index: "003" + reactions: + type: string + x-stream-index: "001" + type: object + FeedsModerationTemplateConfig: + properties: + config_key: + type: string + x-stream-index: "002" + data_types: + additionalProperties: + type: string + type: object + x-stream-index: "001" + required: + - data_types + - config_key + type: object + FeedsReactionResponse: + properties: + activity_id: + description: ID of the activity that was reacted to + title: Activity ID + type: string + x-stream-index: "002" + comment_id: + description: ID of the comment that was reacted to + title: Comment ID + type: string + x-stream-index: "003" + created_at: + description: When the reaction was created + format: date-time + title: Created At + type: number + x-stream-index: "006" + custom: + additionalProperties: {} + description: Custom data for the reaction + title: Custom Data + type: object + x-stream-index: "005" + type: + description: Type of reaction + title: Type + type: string + x-stream-index: "004" + updated_at: + description: When the reaction was last updated + format: date-time + title: Updated At + type: number + x-stream-index: "007" + user: + $ref: '#/components/schemas/UserResponse' + description: User who created the reaction + title: User + x-stream-index: "001" + required: + - user + - activity_id + - type + - created_at + - updated_at + title: Activity Reaction + type: object + Field: + nullable: true + properties: + short: + type: boolean + x-stream-index: "003" + title: + type: string + x-stream-index: "001" + value: + type: string + x-stream-index: "002" + required: + - title + - value + - short + type: object + FileUploadConfig: + properties: + allowed_file_extensions: + items: + type: string + type: array + x-stream-index: "001" + allowed_mime_types: + items: + type: string + type: array + x-stream-index: "003" + blocked_file_extensions: + items: + type: string + type: array + x-stream-index: "002" + blocked_mime_types: + items: + type: string + type: array + x-stream-index: "004" + size_limit: + format: int32 + maximum: 104857600 + minimum: 0 + type: integer + x-stream-index: "005" + required: + - size_limit + type: object + FileUploadRequest: + nullable: true + properties: + file: + description: file field + title: File + type: string + x-stream-index: "001" + user: + $ref: '#/components/schemas/OnlyUserID' + description: user for the request **server side only** + title: User + x-stream-index: "002" + type: object + FileUploadResponse: + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "003.001" + file: + description: URL to the uploaded asset. Should be used to put to `asset_url` + attachment field + title: File + type: string + x-stream-index: "001" + thumb_url: + description: URL of the file thumbnail for supported file formats. Should + be put to `thumb_url` attachment field + title: Thumbnail URL + type: string + x-stream-index: "002" + required: + - duration + type: object + FirebaseConfig: + properties: + Disabled: + type: boolean + writeOnly: true + x-stream-index: "001" + apn_template: + type: string + x-stream-index: "005" + credentials_json: + type: string + x-stream-index: "006" + data_template: + type: string + x-stream-index: "004" + notification_template: + type: string + x-stream-index: "003" + server_key: + type: string + x-stream-index: "002" + type: object + FirebaseConfigFields: + properties: + apn_template: + type: string + x-stream-index: "004" + credentials_json: + type: string + x-stream-index: "006" + data_template: + type: string + x-stream-index: "003" + enabled: + type: boolean + x-stream-index: "001" + notification_template: + type: string + x-stream-index: "002" + server_key: + type: string + x-stream-index: "005" + required: + - enabled + type: object + Flag: + description: Contains information about flagged user or message + nullable: true + properties: + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: "019" + custom: + additionalProperties: {} + description: Additional metadata about the flag + title: Custom + type: object + x-stream-index: "014" + entity_creator_id: + description: ID of the user who created the flagged entity + title: Entity Creator ID + type: string + x-stream-index: "009" + entity_id: + description: Unique identifier of the entity being flagged + title: Entity ID + type: string + x-stream-index: "008" + entity_type: + description: Type of entity being flagged (e.g., message, user) + title: Entity Type + type: string + x-stream-index: "007" + is_streamed_content: + type: boolean + x-stream-index: "012" + labels: + description: Labels from bodyguard, API calls, our own AI etc + items: + type: string + title: Labels + type: array + x-stream-index: "015" + moderation_payload: + $ref: '#/components/schemas/ModerationPayload' + description: Content being flagged + title: Moderation Payload + x-stream-index: "010" + moderation_payload_hash: + type: string + x-stream-index: "011" + reason: + description: Optional explanation for why the content is being flagged + title: Reason + type: string + x-stream-index: "013" + result: + description: Result of bodyguard, API calls, our own AI etc + items: + additionalProperties: {} + type: object + title: Result + type: array + x-stream-index: "016" + review_queue_item: + $ref: '#/components/schemas/ReviewQueueItem' + x-stream-index: "018" + review_queue_item_id: + description: ID of the review queue item + title: Review Queue Item ID + type: string + x-stream-index: "017" + type: + type: string + x-stream-index: "004" + updated_at: + description: Date/time of the last update + format: date-time + title: Updated at + type: number + x-stream-index: "020" + user: + $ref: '#/components/schemas/User' + description: User who flagged a message or a user + title: User + x-stream-index: "006" + required: + - entity_type + - entity_id + - result + - created_at + - updated_at + title: Flag + type: object + FlagContentOptions: + properties: + reason: + type: string + x-stream-index: "001" + type: object + FlagRequest: + nullable: true + properties: + custom: + additionalProperties: {} + description: Additional metadata about the flag + title: Custom + type: object + x-stream-index: "006" + entity_creator_id: + description: ID of the user who created the flagged entity + title: Entity Creator ID + type: string + x-stream-index: "003" + entity_id: + description: Unique identifier of the entity being flagged + title: Entity ID + type: string + x-stream-index: "002" + entity_type: + description: Type of entity being flagged (e.g., message, user) + title: Entity Type + type: string + x-stream-index: "001" + moderation_payload: + $ref: '#/components/schemas/ModerationPayload' + description: Content being flagged + title: Moderation Payload + x-stream-index: "005" + reason: + description: Optional explanation for why the content is being flagged + maxLength: 255 + title: Reason + type: string + x-stream-index: "004" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "007.002" + user_id: + type: string + x-stream-index: "007.001" + required: + - entity_type + - entity_id + type: object + FlagResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + item_id: + description: Unique identifier of the created moderation item + title: Item ID + type: string + x-stream-index: "001" + required: + - item_id + - duration + type: object + FlagUserOptions: + properties: + reason: + type: string + x-stream-index: "001" + type: object + FollowBatchRequest: + nullable: true + properties: + follows: + description: List of follow relationships to create + items: + $ref: '#/components/schemas/FollowRequest' + maximum: 1000 + minimum: 1 + title: Follows + type: array + x-stream-index: "001" + required: + - follows + title: Follow Batch Request + type: object + FollowBatchResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + follows: + description: List of created follow relationships + items: + $ref: '#/components/schemas/FollowResponse' + title: Follows + type: array + x-stream-index: "001" + required: + - follows + - duration + title: Follow Batch Response + type: object + FollowCreatedEvent: + description: Emitted when a feed follows another feed. + nullable: true + properties: + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + feed_visibility: + type: string + x-stream-index: "002.003" + fid: + type: string + x-stream-index: "002.002" + follow: + $ref: '#/components/schemas/FollowResponse' + x-stream-index: "001" + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 + type: + default: feeds.follow.created + description: 'The type of event: "feeds.follow.created" in this case' + title: Event Type + type: string + x-stream-index: 002.001.002 + required: + - follow + - type + - created_at + - custom + - fid + title: FollowCreatedEvent + 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 + FollowDeletedEvent: + description: Emitted when a feed unfollows another feed. + nullable: true + properties: + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + feed_visibility: + type: string + x-stream-index: "002.003" + fid: + type: string + x-stream-index: "002.002" + follow: + $ref: '#/components/schemas/FollowResponse' + x-stream-index: "001" + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 + type: + default: feeds.follow.deleted + description: 'The type of event: "feeds.follow.deleted" in this case' + title: Event Type + type: string + x-stream-index: 002.001.002 + required: + - follow + - type + - created_at + - custom + - fid + title: FollowDeletedEvent + 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 + FollowPair: + properties: + source: + description: Fully qualified ID of the source feed + maxLength: 255 + title: Source Feed + type: string + x-stream-index: "001" + target: + description: Fully qualified ID of the target feed + maxLength: 255 + title: Target Feed + type: string + x-stream-index: "002" + required: + - source + - target + title: FollowPair + type: object + FollowRequest: + nullable: true + properties: + create_notification_activity: + description: Whether to create a notification activity for this follow + title: Create Notification Activity + type: boolean + x-stream-index: "004" + custom: + additionalProperties: {} + description: Custom data for the follow relationship + title: Custom Data + type: object + x-stream-index: "002" + push_preference: + description: Push preference for the follow relationship + enum: + - all + - none + title: Push Preference + type: string + x-stream-index: "003" + skip_push: + type: boolean + x-stream-index: "005" + source: + description: Fully qualified ID of the source feed + maxLength: 255 + title: Source Feed + type: string + x-stream-index: "001.001" + target: + description: Fully qualified ID of the target feed + maxLength: 255 + title: Target Feed + type: string + x-stream-index: "001.002" + required: + - source + - target + title: Follow Request + type: object + FollowResponse: + properties: + created_at: + description: When the follow relationship was created + format: date-time + title: Created At + type: number + x-stream-index: "009" + custom: + additionalProperties: {} + description: Custom data for the follow relationship + title: Custom Data + type: object + x-stream-index: "004" + follower_role: + description: Role of the follower (source user) in the follow relationship + title: Follower Role + type: string + x-stream-index: "008" + push_preference: + description: Push preference for notifications + enum: + - all + - none + title: Push Preference + type: string + x-stream-index: "003" + request_accepted_at: + description: When the follow request was accepted + format: date-time + title: Request Accepted At + type: number + x-stream-index: "005" + request_rejected_at: + description: When the follow request was rejected + format: date-time + title: Request Rejected At + type: number + x-stream-index: "006" + source_feed: + $ref: '#/components/schemas/FeedResponse' + description: Source feed object + title: Source Feed + x-stream-index: "001" + status: + description: Status of the follow relationship + enum: + - accepted + - pending + - rejected + title: Status + type: string + x-stream-index: "007" + target_feed: + $ref: '#/components/schemas/FeedResponse' + description: Target feed object + title: Target Feed + x-stream-index: "002" + updated_at: + description: When the follow relationship was last updated + format: date-time + title: Updated At + type: number + x-stream-index: "010" + required: + - source_feed + - target_feed + - push_preference + - status + - follower_role + - created_at + - updated_at + title: Follow + type: object + FollowUpdatedEvent: + description: Emitted when a follow relationship is updated. + nullable: true + properties: + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + feed_visibility: + type: string + x-stream-index: "002.003" + fid: + type: string + x-stream-index: "002.002" + follow: + $ref: '#/components/schemas/FollowResponse' + x-stream-index: "001" + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 + type: + default: feeds.follow.updated + description: 'The type of event: "feeds.follow.updated" in this case' + title: Event Type + type: string + x-stream-index: 002.001.002 + required: + - follow + - type + - created_at + - custom + - fid + title: FollowUpdatedEvent + 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 + FrameRecordSettings: + properties: + capture_interval_in_seconds: + format: int32 + maximum: 60 + minimum: 2 + type: integer + x-stream-index: "003" + mode: + enum: + - available + - disabled + - auto-on + type: string + x-stream-index: "001" + quality: + type: string + x-stream-index: "002" + required: + - mode + - capture_interval_in_seconds + type: object + FrameRecordingEgressConfig: + properties: + capture_interval_in_seconds: + format: int32 + type: integer + x-stream-index: "007" + external_storage: + $ref: '#/components/schemas/ExternalStorage' + x-stream-index: "006" + quality: + $ref: '#/components/schemas/Quality' + x-stream-index: "004" + storage_name: + type: string + x-stream-index: "005" + type: object + FrameRecordingResponse: + properties: + status: + type: string + x-stream-index: "001" + required: + - status + type: object + FrameRecordingSettingsResponse: + properties: + capture_interval_in_seconds: + format: int32 + maximum: 60 + minimum: 2 + type: integer + x-stream-index: "003" + mode: + enum: + - available + - disabled + - auto-on + type: string + x-stream-index: "001" + quality: + type: string + x-stream-index: "002" + required: + - mode + - capture_interval_in_seconds + type: object + FullUserResponse: + properties: + avg_response_time: + format: int32 + type: integer + x-stream-index: "001.018" + ban_expires: + format: date-time + type: number + x-stream-index: "015" + banned: + type: boolean + x-stream-index: "001.012" + blocked_user_ids: + items: + type: string + type: array + x-stream-index: "014" + channel_mutes: + items: + $ref: '#/components/schemas/ChannelMute' + type: array + x-stream-index: "007" + created_at: + format: date-time + type: number + x-stream-index: "001.009" + custom: + additionalProperties: {} + type: object + x-stream-index: "001.004" + deactivated_at: + format: date-time + type: number + x-stream-index: "001.016" + deleted_at: + format: date-time + type: number + x-stream-index: "001.011" + devices: + items: + $ref: '#/components/schemas/DeviceResponse' + type: array + x-stream-index: "004" + id: + type: string + x-stream-index: "001.001" + image: + type: string + x-stream-index: "001.003" + invisible: + type: boolean + x-stream-index: "005" + language: + type: string + x-stream-index: "001.005" + last_active: + format: date-time + type: number + x-stream-index: "001.014" + latest_hidden_channels: + items: + type: string + type: array + x-stream-index: "012" + mutes: + items: + $ref: '#/components/schemas/UserMuteResponse' + type: array + x-stream-index: "006" + name: + type: string + x-stream-index: "001.002" + online: + type: boolean + x-stream-index: "001.013" + privacy_settings: + $ref: '#/components/schemas/PrivacySettingsResponse' + x-stream-index: "003" + revoke_tokens_issued_before: + format: date-time + type: number + x-stream-index: "001.015" + role: + type: string + x-stream-index: "001.006" + shadow_banned: + type: boolean + x-stream-index: "013" + teams: + items: + type: string + type: array + x-stream-index: "001.007" + teams_role: + additionalProperties: + type: string + type: object + x-stream-index: "001.008" + total_unread_count: + format: int32 + type: integer + x-stream-index: "009" + unread_channels: + format: int32 + type: integer + x-stream-index: "010" + unread_count: + format: int32 + type: integer + x-stream-index: "008" + unread_threads: + format: int32 + type: integer + x-stream-index: "011" + updated_at: + format: date-time + type: number + x-stream-index: "001.010" + required: + - id + - custom + - language + - role + - teams + - created_at + - updated_at + - banned + - online + - devices + - invisible + - mutes + - channel_mutes + - unread_count + - total_unread_count + - unread_channels + - unread_threads + - shadow_banned + - blocked_user_ids + type: object + GeofenceResponse: + nullable: true + properties: + country_codes: + items: + type: string + type: array + x-stream-index: "004" + description: + type: string + x-stream-index: "003" + name: + type: string + x-stream-index: "001" + type: + type: string + x-stream-index: "002" + required: + - name + type: object + GeofenceSettings: + properties: + names: + items: + type: string + type: array + x-stream-index: "001" + required: + - names + type: object + GeofenceSettingsResponse: + properties: + names: + items: + type: string + type: array + x-stream-index: "001" + required: + - names + type: object + GetActivityResponse: + nullable: true + properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + description: The requested activity + title: Activity + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - activity + - duration + title: Get Activity Response + type: object + GetApplicationResponse: + description: Basic response information + nullable: true + properties: + app: + $ref: '#/components/schemas/AppResponseFields' + x-stream-index: "001" + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "002.001" + required: + - app + - duration + title: Response + type: object + GetBlockListResponse: + description: Response for get block list + nullable: true + properties: + blocklist: + $ref: '#/components/schemas/BlockListResponse' + description: Block list object + title: BlockListResponse + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - duration + title: GetBlockListResponse + type: object + x-stream-docs-page-id: get_block_list + GetBlockedUsersResponse: + nullable: true + properties: + blocks: + description: Array of blocked user object + items: + $ref: '#/components/schemas/BlockedUserResponse' + title: Blocks + type: array + x-stream-index: "001" + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "002.001" + required: + - blocks + - duration + type: object + GetCommentRepliesResponse: + nullable: true + properties: + comments: + description: Threaded listing of replies to the comment + items: + $ref: '#/components/schemas/ThreadedCommentResponse' + title: Comments + type: array + x-stream-index: "001" + duration: + type: string + x-stream-index: "003.001" + next: + type: string + x-stream-index: "002.001" + prev: + type: string + x-stream-index: "002.002" + required: + - comments + - duration + title: Get Comment Replies Response + type: object + GetCommentResponse: + nullable: true + properties: + comment: + $ref: '#/components/schemas/CommentResponse' + description: Comment + title: Comment + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - comment + - duration + title: Get Comment Response + type: object + GetCommentsResponse: + nullable: true + properties: + comments: + description: Threaded listing for the activity + items: + $ref: '#/components/schemas/ThreadedCommentResponse' + title: Comments + type: array + x-stream-index: "001" + duration: + type: string + x-stream-index: "003.001" + next: + type: string + x-stream-index: "002.001" + prev: + type: string + x-stream-index: "002.002" + required: + - comments + - duration + title: Get Comments Response + type: object + GetConfigResponse: + nullable: true + properties: + config: + $ref: '#/components/schemas/ConfigResponse' + description: The retrieved moderation configuration + title: Config + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - duration + type: object + GetCustomPermissionResponse: + description: Basic response information + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "002.001" + permission: + $ref: '#/components/schemas/Permission' + x-stream-index: "001" + required: + - permission + - duration + title: Response + type: object + GetFeedGroupResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + feed_group: + $ref: '#/components/schemas/FeedGroupResponse' + description: The requested feed group + title: Feed Group + x-stream-index: "001" + required: + - feed_group + - duration + title: Get Feed Group Response + type: object + GetFeedViewResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + feed_view: + $ref: '#/components/schemas/FeedViewResponse' + description: The requested feed view + title: Feed View + x-stream-index: "001" + required: + - feed_view + - duration + title: Get Feed View Response + type: object + GetFollowSuggestionsResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + suggestions: + description: List of suggested feeds to follow + items: + $ref: '#/components/schemas/FeedResponse' + title: Suggestions + type: array + x-stream-index: "001" + required: + - suggestions + - duration + title: Follow Suggestions Response + type: object + GetImportResponse: + description: Basic response information + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "002.001" + import_task: + $ref: '#/components/schemas/ImportTask' + x-stream-index: "001" + required: + - duration + title: Response + type: object + GetModerationRuleResponse: + description: Basic response information + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "001.001" + rule: + $ref: '#/components/schemas/ModerationRuleV2Response' + x-stream-index: "002" + required: + - duration + title: Response + type: object + GetOGResponse: + nullable: true + properties: + actions: + items: + $ref: '#/components/schemas/Action' + type: array + x-stream-index: "001.015" + asset_url: + description: URL of detected video or audio + title: Image URL + type: string + x-stream-index: "001.017" + author_icon: + type: string + x-stream-index: "001.007" + author_link: + description: og:site + title: Author Link + type: string + x-stream-index: "001.006" + author_name: + description: og:site_name + title: Author Name + type: string + x-stream-index: "001.005" + color: + type: string + x-stream-index: "001.003" + custom: + additionalProperties: {} + type: object + x-stream-index: "001.018" + duration: + type: string + x-stream-index: "002.001" + fallback: + type: string + x-stream-index: "001.002" + fields: + items: + $ref: '#/components/schemas/Field' + type: array + x-stream-index: "001.016" + footer: + type: string + x-stream-index: "001.013" + footer_icon: + type: string + x-stream-index: "001.014" + giphy: + $ref: '#/components/schemas/Images' + x-stream-index: "001.019" + image_url: + description: URL of detected image + title: Image URL + type: string + x-stream-index: "001.011" + og_scrape_url: + description: extracted url from the text + title: OG Scrape URL + type: string + x-stream-index: "001.020" + original_height: + format: int32 + type: integer + x-stream-index: "001.022" + original_width: + format: int32 + type: integer + x-stream-index: "001.021" + pretext: + type: string + x-stream-index: "001.004" + text: + description: og:description + title: Text + type: string + x-stream-index: "001.010" + thumb_url: + description: URL of detected thumb image + title: Image URL + type: string + x-stream-index: "001.012" + title: + description: og:title + title: Title + type: string + x-stream-index: "001.008" + title_link: + description: og:url + title: Title Link + type: string + x-stream-index: "001.009" + type: + description: Attachment type, could be empty, image, audio or video + title: Type + type: string + x-stream-index: "001.001" + required: + - custom + - duration + title: Get OG Attachment + type: object + x-stream-docs-page-id: og + GetOrCreateFeedGroupRequest: + nullable: true + properties: + activity_processors: + description: Configuration for activity processors (max 10) + items: + $ref: '#/components/schemas/ActivityProcessorConfig' + maximum: 10 + title: Activity Processors + type: array + x-stream-index: "006" + activity_selectors: + description: Configuration for activity selectors (max 10) + items: + $ref: '#/components/schemas/ActivitySelectorConfig' + maximum: 10 + title: Activity Selectors + type: array + x-stream-index: "007" + aggregation: + $ref: '#/components/schemas/AggregationConfig' + description: Configuration for activity aggregation + title: Aggregation + x-stream-index: "009" + custom: + additionalProperties: {} + description: Custom data for the feed group + title: Custom Data + type: object + x-stream-index: "004" + default_visibility: + description: 'Default visibility for the feed group, can be ''public'', + ''visible'', ''followers'', ''members'', or ''private''. Defaults to ''visible'' + if not provided. ' + enum: + - public + - visible + - followers + - members + - private + title: Default Visibility + type: string + x-stream-index: "005" + notification: + $ref: '#/components/schemas/NotificationConfig' + description: Configuration for notifications + title: Notification + x-stream-index: "002" + push_notification: + $ref: '#/components/schemas/PushNotificationConfig' + x-stream-index: "003" + ranking: + $ref: '#/components/schemas/RankingConfig' + description: Configuration for activity ranking + title: Ranking + x-stream-index: "008" + title: Get Or Create Feed Group Request + type: object + GetOrCreateFeedGroupResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "003.001" + feed_group: + $ref: '#/components/schemas/FeedGroupResponse' + description: The feed group that was retrieved or created + title: Feed Group + x-stream-index: "001" + was_created: + description: Indicates whether the feed group was created (true) or already + existed (false) + title: Was Created + type: boolean + x-stream-index: "002" + required: + - feed_group + - was_created + - duration + title: Get Or Create Feed Group Response + type: object + GetOrCreateFeedRequest: + description: Client request + nullable: true + properties: + activity_selector_options: + additionalProperties: {} + type: object + x-stream-index: "006" + data: + $ref: '#/components/schemas/FeedInput' + x-stream-index: "003" + external_ranking: + additionalProperties: {} + type: object + x-stream-index: "007" + filter: + additionalProperties: {} + type: object + x-stream-index: "009" + followers_pagination: + $ref: '#/components/schemas/PagerRequest' + x-stream-index: "011" + following_pagination: + $ref: '#/components/schemas/PagerRequest' + x-stream-index: "012" + interest_weights: + additionalProperties: + format: float + type: number + type: object + x-stream-index: "008" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "013.001" + member_pagination: + $ref: '#/components/schemas/PagerRequest' + x-stream-index: "010" + next: + type: string + x-stream-index: "013.002" + prev: + type: string + x-stream-index: "013.003" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "014.002" + user_id: + type: string + x-stream-index: "014.001" + view: + type: string + x-stream-index: "005" + watch: + type: boolean + x-stream-index: "004" + title: ClientRequest + type: object + GetOrCreateFeedResponse: + description: Basic response information + nullable: true + properties: + activities: + items: + $ref: '#/components/schemas/ActivityResponse' + type: array + x-stream-index: "002" + aggregated_activities: + items: + $ref: '#/components/schemas/AggregatedActivityResponse' + type: array + x-stream-index: "003" + created: + type: boolean + x-stream-index: "015" + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "017.001" + feed: + $ref: '#/components/schemas/FeedResponse' + x-stream-index: "001" + followers: + items: + $ref: '#/components/schemas/FollowResponse' + type: array + x-stream-index: "005" + followers_pagination: + $ref: '#/components/schemas/PagerResponse' + x-stream-index: "012" + following: + items: + $ref: '#/components/schemas/FollowResponse' + type: array + x-stream-index: "006" + following_pagination: + $ref: '#/components/schemas/PagerResponse' + x-stream-index: "013" + member_pagination: + $ref: '#/components/schemas/PagerResponse' + x-stream-index: "011" + members: + items: + $ref: '#/components/schemas/FeedMemberResponse' + type: array + x-stream-index: "004" + next: + type: string + x-stream-index: "016.001" + notification_status: + $ref: '#/components/schemas/NotificationStatusResponse' + x-stream-index: "014" + own_capabilities: + items: + $ref: '#/components/schemas/FeedOwnCapability' + type: array + x-stream-index: "008" + own_follows: + items: + $ref: '#/components/schemas/FollowResponse' + type: array + x-stream-index: "009" + own_membership: + $ref: '#/components/schemas/FeedMemberResponse' + x-stream-index: "010" + pinned_activities: + items: + $ref: '#/components/schemas/ActivityPinResponse' + type: array + x-stream-index: "007" + prev: + type: string + x-stream-index: "016.002" + required: + - feed + - activities + - aggregated_activities + - members + - followers + - following + - pinned_activities + - own_capabilities + - created + - duration + title: Response + type: object + GetOrCreateFeedViewRequest: + nullable: true + properties: + activity_processors: + description: Configured activity Processors + items: + $ref: '#/components/schemas/ActivityProcessorConfig' + title: Activity Processors + type: array + x-stream-index: "002.002" + activity_selectors: + description: Configuration for selecting activities + items: + $ref: '#/components/schemas/ActivitySelectorConfig' + title: Activity Selectors + type: array + x-stream-index: "002.001" + aggregation: + $ref: '#/components/schemas/AggregationConfig' + description: Configuration for aggregating activities + title: Aggregation + x-stream-index: "002.004" + ranking: + $ref: '#/components/schemas/RankingConfig' + description: Configuration for ranking activities + title: Ranking + x-stream-index: "002.003" + title: Get Or Create Feed View Request + type: object + GetOrCreateFeedViewResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "003.001" + feed_view: + $ref: '#/components/schemas/FeedViewResponse' + description: The feed view (either existing or newly created) + title: Feed View + x-stream-index: "001" + was_created: + description: Indicates whether the feed view was newly created (true) or + already existed (false) + title: Was Created + type: boolean + x-stream-index: "002" + required: + - feed_view + - was_created + - duration + title: Get Or Create Feed View Response + type: object + GetRateLimitsResponse: + nullable: true + properties: + android: + additionalProperties: + $ref: '#/components/schemas/LimitInfo' + description: Map of endpoint rate limits for the Android platform + title: Android + type: object + x-stream-index: "002" + x-stream-map: + description: The name of the endpoint for which the limits apply + key: endpoint + title: Endpoint name + duration: + type: string + x-stream-index: "005.001" + ios: + additionalProperties: + $ref: '#/components/schemas/LimitInfo' + description: Map of endpoint rate limits for the iOS platform + title: iOS + type: object + x-stream-index: "003" + x-stream-map: + description: The name of the endpoint for which the limits apply + key: endpoint + title: Endpoint name + server_side: + additionalProperties: + $ref: '#/components/schemas/LimitInfo' + description: Map of endpoint rate limits for the server-side platform + title: Server-side + type: object + x-stream-index: "001" + x-stream-map: + description: The name of the endpoint for which the limits apply + key: endpoint + title: Endpoint name + web: + additionalProperties: + $ref: '#/components/schemas/LimitInfo' + description: Map of endpoint rate limits for the web platform + title: Web + type: object + x-stream-index: "004" + x-stream-map: + description: The name of the endpoint for which the limits apply + key: endpoint + title: Endpoint name + required: + - duration + title: Get Rate Limits Response + type: object + x-stream-docs-page-id: rate_limits + GetReviewQueueItemResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + item: + $ref: '#/components/schemas/ReviewQueueItemResponse' + description: Current state of the review queue item + title: Item + x-stream-index: "001" + required: + - duration + type: object + GetTaskResponse: + nullable: true + properties: + created_at: + format: date-time + type: number + x-stream-index: "001.003" + duration: + type: string + x-stream-index: "004.001" + error: + $ref: '#/components/schemas/ErrorResult' + description: Error produced by task + title: Error + x-stream-index: "003" + result: + additionalProperties: {} + description: Result produced by task after completion + title: Result + type: object + x-stream-index: "002" + status: + description: Current status of task + title: Status + type: string + x-stream-index: "001.002" + task_id: + description: ID of task + title: Task ID + type: string + x-stream-index: "001.001" + updated_at: + format: date-time + type: number + x-stream-index: "001.004" + required: + - task_id + - status + - created_at + - updated_at + - duration + title: Get Task Response + type: object + x-stream-docs-page-id: tasks + GoogleVisionConfig: + properties: + enabled: + type: boolean + x-stream-index: "001" + type: object + HLSEgressConfig: + properties: + composite_app_settings: + $ref: '#/components/schemas/CompositeAppSettings' + x-stream-index: "005" + playlist_url: + type: string + x-stream-index: "007" + qualities: + items: + $ref: '#/components/schemas/Quality' + type: array + x-stream-index: "004" + start_unix_nano: + format: int64 + type: integer + x-stream-index: "006" + type: object + HLSSettings: + properties: + auto_on: + type: boolean + x-stream-index: "001" + enabled: + type: boolean + x-stream-index: "002" + layout: + $ref: '#/components/schemas/LayoutSettings' + x-stream-index: "004" + quality_tracks: + items: + type: string + type: array + x-stream-index: "003" + required: + - auto_on + - enabled + - quality_tracks + type: object + HLSSettingsResponse: + description: HLSSettings is the payload for HLS settings + properties: + auto_on: + title: Auto On + type: boolean + x-stream-index: "001" + enabled: + title: Enabled + type: boolean + x-stream-index: "002" + layout: + $ref: '#/components/schemas/LayoutSettingsResponse' + title: Layout + x-stream-index: "004" + quality_tracks: + items: + type: string + title: Quality Tracks + type: array + x-stream-index: "003" + required: + - auto_on + - enabled + - quality_tracks + - layout + title: HLSSettingsResponse + type: object + HarmConfig: + properties: + action_sequences: + items: + $ref: '#/components/schemas/ActionSequence' + type: array + x-stream-index: "001" + severity: + type: integer + x-stream-index: "002" + required: + - action_sequences + - severity + type: object + HuaweiConfig: + properties: + Disabled: + type: boolean + writeOnly: true + x-stream-index: "003" + id: + type: string + x-stream-index: "001" + secret: + type: string + x-stream-index: "002" + type: object + HuaweiConfigFields: + properties: + enabled: + type: boolean + x-stream-index: "001" + id: + type: string + x-stream-index: "002" + secret: + type: string + x-stream-index: "003" + required: + - enabled + type: object + ImageContentParameters: + properties: + harm_labels: + items: + type: string + type: array + x-stream-index: "001" + type: object + ImageData: + properties: + frames: + type: string + x-stream-index: "005" + height: + type: string + x-stream-index: "003" + size: + type: string + x-stream-index: "004" + url: + type: string + x-stream-index: "001" + width: + type: string + x-stream-index: "002" + required: + - url + - width + - height + - size + - frames + type: object + ImageRuleParameters: + properties: + harm_labels: + items: + type: string + type: array + x-stream-index: "003" + threshold: + format: int32 + type: integer + x-stream-index: "001" + time_window: + type: string + x-stream-index: "002" + type: object + ImageSize: + properties: + crop: + description: Crop mode + enum: + - top + - bottom + - left + - right + - center + title: Crop + type: string + x-stream-index: "001" + height: + description: Target image height + format: int32 + title: Height + type: integer + x-stream-index: "003" + resize: + description: Resize method + enum: + - clip + - crop + - scale + - fill + title: Resize + type: string + x-stream-index: "002" + width: + description: Target image width + format: int32 + title: Width + type: integer + x-stream-index: "004" + title: Image size configuration + type: object + ImageUploadRequest: + nullable: true + properties: + file: + type: string + x-stream-index: "001.001" + upload_sizes: + description: field with JSON-encoded array of image size configurations + items: + $ref: '#/components/schemas/ImageSize' + title: Upload sizes + type: array + x-stream-index: "002" + user: + $ref: '#/components/schemas/OnlyUserID' + x-stream-index: "001.002" + type: object + ImageUploadResponse: + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: 001.003.001 + file: + type: string + x-stream-index: "001.001" + thumb_url: + type: string + x-stream-index: "001.002" + upload_sizes: + description: Array of image size configurations + items: + $ref: '#/components/schemas/ImageSize' + title: Upload sizes + type: array + x-stream-index: "002" + required: + - duration + type: object + Images: + properties: + fixed_height: + $ref: '#/components/schemas/ImageData' + x-stream-index: "002" + fixed_height_downsampled: + $ref: '#/components/schemas/ImageData' + x-stream-index: "004" + fixed_height_still: + $ref: '#/components/schemas/ImageData' + x-stream-index: "003" + fixed_width: + $ref: '#/components/schemas/ImageData' + x-stream-index: "005" + fixed_width_downsampled: + $ref: '#/components/schemas/ImageData' + x-stream-index: "007" + fixed_width_still: + $ref: '#/components/schemas/ImageData' + x-stream-index: "006" + original: + $ref: '#/components/schemas/ImageData' + x-stream-index: "001" + required: + - original + - fixed_height + - fixed_height_still + - fixed_height_downsampled + - fixed_width + - fixed_width_still + - fixed_width_downsampled + type: object + ImportTask: + properties: + created_at: + format: date-time + type: number + x-stream-index: "011" + history: + items: + $ref: '#/components/schemas/ImportTaskHistory' + type: array + x-stream-index: "010" + id: + type: string + x-stream-index: "003" + mode: + type: string + x-stream-index: "006" + path: + type: string + x-stream-index: "005" + size: + format: int64 + type: integer + x-stream-index: "007" + state: + type: string + x-stream-index: "008" + updated_at: + format: date-time + type: number + x-stream-index: "012" + required: + - id + - path + - mode + - state + - history + - created_at + - updated_at + type: object + ImportTaskHistory: + nullable: true + properties: + created_at: + format: date-time + type: number + x-stream-index: "007" + next_state: + type: string + x-stream-index: "006" + prev_state: + type: string + x-stream-index: "005" + required: + - prev_state + - next_state + - created_at + type: object + IngressAudioEncodingOptions: + properties: + bitrate: + maximum: 128000 + minimum: 16000 + type: integer + x-stream-index: "003" + channels: + enum: + - "1" + - "2" + format: int32 + type: integer + x-stream-index: "001" + enable_dtx: + type: boolean + x-stream-index: "002" + required: + - channels + - enable_dtx + - bitrate + type: object + IngressAudioEncodingResponse: + properties: + bitrate: + format: int32 + type: integer + x-stream-index: "003" + channels: + format: int32 + type: integer + x-stream-index: "001" + enable_dtx: + type: boolean + x-stream-index: "002" + required: + - channels + - enable_dtx + - bitrate + type: object + IngressSettings: + properties: + audio_encoding_options: + $ref: '#/components/schemas/IngressAudioEncodingOptions' + x-stream-index: "002" + enabled: + type: boolean + x-stream-index: "001" + video_encoding_options: + additionalProperties: + $ref: '#/components/schemas/IngressVideoEncodingOptions' + type: object + x-stream-index: "003" + required: + - enabled + type: object + IngressSettingsResponse: + properties: + audio_encoding_options: + $ref: '#/components/schemas/IngressAudioEncodingResponse' + x-stream-index: "002" + enabled: + type: boolean + x-stream-index: "001" + video_encoding_options: + additionalProperties: + $ref: '#/components/schemas/IngressVideoEncodingResponse' + type: object + x-stream-index: "003" + required: + - enabled + type: object + IngressVideoEncodingOptions: + properties: + layers: + items: + $ref: '#/components/schemas/IngressVideoLayer' + minimum: 1 + type: array + x-stream-index: "001" + required: + - layers + type: object + IngressVideoEncodingResponse: + properties: + layers: + items: + $ref: '#/components/schemas/IngressVideoLayerResponse' + type: array + x-stream-index: "001" + required: + - layers + type: object + IngressVideoLayer: + nullable: true + properties: + bitrate: + minimum: 1000 + type: integer + x-stream-index: "002" + codec: + enum: + - h264 + - vp8 + type: string + x-stream-index: "001" + frame_rate: + maximum: 60 + minimum: 1 + type: integer + x-stream-index: "003" + max_dimension: + minimum: 240 + type: integer + x-stream-index: "005" + min_dimension: + minimum: 240 + type: integer + x-stream-index: "004" + required: + - codec + - bitrate + - frame_rate + - min_dimension + - max_dimension + type: object + IngressVideoLayerResponse: + nullable: true + properties: + bitrate: + type: integer + x-stream-index: "002" + codec: + type: string + x-stream-index: "001" + frame_rate_limit: + type: integer + x-stream-index: "005" + max_dimension: + type: integer + x-stream-index: "004" + min_dimension: + type: integer + x-stream-index: "003" + required: + - codec + - bitrate + - min_dimension + - max_dimension + - frame_rate_limit + type: object + LLMConfig: + properties: + app_context: + type: string + x-stream-index: "005" + async: + type: boolean + x-stream-index: "001" + enabled: + type: boolean + x-stream-index: "002" + rules: + items: + $ref: '#/components/schemas/LLMRule' + type: array + x-stream-index: "003" + severity_descriptions: + additionalProperties: + type: string + type: object + x-stream-index: "004" + required: + - enabled + - rules + type: object + LLMRule: + properties: + action: + enum: + - flag + - shadow + - remove + - bounce + - bounce_flag + - bounce_remove + - keep + type: string + x-stream-index: "003" + description: + type: string + x-stream-index: "002" + label: + type: string + x-stream-index: "001" + severity_rules: + items: + $ref: '#/components/schemas/BodyguardSeverityRule' + type: array + x-stream-index: "004" + required: + - label + - description + - action + - severity_rules + type: object + LabelThresholds: + properties: + block: + description: Threshold for automatic message block + format: float + maximum: 1 + minimum: 0 + title: Block + type: number + x-stream-index: "002" + flag: + description: Threshold for automatic message flag + format: float + maximum: 1 + minimum: 0 + title: Flag + type: number + x-stream-index: "001" + type: object + LayoutSettings: + properties: + detect_orientation: + type: boolean + x-stream-index: "005" + external_app_url: + type: string + x-stream-index: "003" + external_css_url: + type: string + x-stream-index: "004" + name: + enum: + - spotlight + - grid + - single-participant + - mobile + - custom + type: string + x-stream-index: "001" + options: + additionalProperties: {} + type: object + x-stream-index: "002" + required: + - name + - external_app_url + - external_css_url + type: object + LayoutSettingsResponse: + properties: + detect_orientation: + type: boolean + x-stream-index: "005" + external_app_url: + type: string + x-stream-index: "003" + external_css_url: + type: string + x-stream-index: "004" + name: + enum: + - spotlight + - grid + - single-participant + - mobile + - custom + type: string + x-stream-index: "001" + options: + additionalProperties: {} + type: object + x-stream-index: "002" + required: + - name + - external_app_url + - external_css_url + type: object + LimitInfo: + properties: + limit: + description: The maximum number of calls allowed for the time window + format: int32 + title: Limit + type: integer + x-stream-index: "001" + remaining: + description: The number of remaining calls in the current window + format: int64 + title: Remaining + type: integer + x-stream-index: "002" + reset: + description: The Unix timestamp of the next window + format: int64 + title: Reset + type: integer + x-stream-index: "003" + required: + - limit + - remaining + - reset + title: Rate Limit info + type: object + x-stream-docs-page-id: rate_limits + LimitsSettings: + properties: + max_duration_seconds: + format: int32 + type: integer + x-stream-index: "004" + max_participants: + format: int32 + type: integer + x-stream-index: "001" + max_participants_exclude_owner: + type: boolean + x-stream-index: "003" + max_participants_exclude_roles: + items: + type: string + type: array + x-stream-index: "002" + required: + - max_participants_exclude_roles + type: object + LimitsSettingsResponse: + properties: + max_duration_seconds: + format: int32 + type: integer + x-stream-index: "004" + max_participants: + format: int32 + type: integer + x-stream-index: "001" + max_participants_exclude_owner: + type: boolean + x-stream-index: "003" + max_participants_exclude_roles: + items: + type: string + type: array + x-stream-index: "002" + required: + - max_participants_exclude_roles + type: object + ListBlockListResponse: + description: Basic response information + nullable: true + properties: + blocklists: + items: + $ref: '#/components/schemas/BlockListResponse' + type: array + x-stream-index: "001" + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "002.001" + required: + - blocklists + - duration + title: Response + type: object + ListDevicesResponse: + description: List devices response + nullable: true + properties: + devices: + description: List of devices + items: + $ref: '#/components/schemas/DeviceResponse' + title: Devices + type: array + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - devices + - duration + title: ListDevicesResponse + type: object + ListExternalStorageResponse: + description: Basic response information + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "001.001" + external_storages: + additionalProperties: + $ref: '#/components/schemas/ExternalStorageResponse' + type: object + x-stream-index: "002" + required: + - duration + - external_storages + title: Response + type: object + ListFeedGroupsResponse: + description: Basic response information + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "002.001" + groups: + additionalProperties: + $ref: '#/components/schemas/FeedGroupResponse' + type: object + x-stream-index: "001" + required: + - groups + - duration + title: Response + type: object + ListFeedViewsResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + views: + additionalProperties: + $ref: '#/components/schemas/FeedViewResponse' + description: Map of feed view ID to feed view + title: Views + type: object + x-stream-index: "001" + required: + - views + - duration + title: List Feed Views Response + type: object + ListImportsResponse: + description: Basic response information + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "002.001" + import_tasks: + items: + $ref: '#/components/schemas/ImportTask' + type: array + x-stream-index: "001" + required: + - import_tasks + - duration + title: Response + type: object + ListPermissionsResponse: + description: Basic response information + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "002.001" + permissions: + items: + $ref: '#/components/schemas/Permission' + type: array + x-stream-index: "001" + required: + - permissions + - duration + title: Response + type: object + ListPushProvidersResponse: + description: Basic response information + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "002.001" + push_providers: + items: + $ref: '#/components/schemas/PushProviderResponse' + type: array + x-stream-index: "001" + required: + - push_providers + - duration + title: Response + type: object + ListRolesResponse: + description: Basic response information + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "002.001" + roles: + items: + $ref: '#/components/schemas/Role' + type: array + x-stream-index: "001" + required: + - roles + - duration + title: Response + type: object + MarkActivityRequest: + nullable: true + properties: + mark_all_read: + description: Whether to mark all activities as read + title: Mark All Read + type: boolean + x-stream-index: "005" + mark_all_seen: + description: Whether to mark all activities as seen + title: Mark All Seen + type: boolean + x-stream-index: "003" + mark_read: + description: List of activity IDs to mark as read + items: + type: string + title: Mark Read + type: array + x-stream-index: "004" + mark_seen: + description: List of activity IDs to mark as seen + items: + type: string + title: Mark Seen + type: array + x-stream-index: "006" + mark_watched: + description: List of activity IDs to mark as watched (for stories) + items: + type: string + title: Mark Watched + type: array + x-stream-index: "007" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "009.002" + user_id: + type: string + x-stream-index: "009.001" + title: Mark Activity Request + type: object + MarkReviewedRequest: + properties: + content_to_mark_as_reviewed_limit: + format: int32 + maximum: 2500 + type: integer + x-stream-index: "002" + disable_marking_content_as_reviewed: + type: boolean + x-stream-index: "001" + type: object + MemberLookup: + properties: + Limit: + format: int32 + type: integer + writeOnly: true + x-stream-index: "001" + required: + - Limit + type: object + MembershipLevelResponse: + properties: + created_at: + description: When the membership level was created + format: date-time + title: Created At + type: number + x-stream-index: "007" + custom: + additionalProperties: {} + description: Custom data for the membership level + title: Custom Data + type: object + x-stream-index: "006" + description: + description: Description of the membership level + title: Description + type: string + x-stream-index: "003" + id: + description: Unique identifier for the membership level + title: ID + type: string + x-stream-index: "001" + name: + description: Display name for the membership level + title: Name + type: string + x-stream-index: "002" + priority: + description: Priority level + format: int32 + title: Priority + type: integer + x-stream-index: "004" + tags: + description: Activity tags this membership level gives access to + items: + type: string + title: Tags + type: array + x-stream-index: "005" + updated_at: + description: When the membership level was last updated + format: date-time + title: Updated At + type: number + x-stream-index: "008" + required: + - id + - name + - priority + - tags + - created_at + - updated_at + title: Membership Level Response + type: object + Message: + properties: + attachments: + items: + $ref: '#/components/schemas/Attachment' + type: array + x-stream-index: "012" + before_message_send_failed: + type: boolean + x-stream-index: "046" + cid: + type: string + x-stream-index: "028" + command: + type: string + x-stream-index: "006" + created_at: + format: date-time + type: number + x-stream-index: "030" + custom: + additionalProperties: {} + type: object + x-stream-index: "034" + deleted_at: + format: date-time + type: number + x-stream-index: "033" + deleted_for_me: + type: boolean + x-stream-index: "059" + deleted_reply_count: + format: int32 + type: integer + x-stream-index: "023" + html: + type: string + x-stream-index: "007" + i18n: + additionalProperties: + type: string + type: object + x-stream-index: "044" + id: + type: string + x-stream-index: "002" + image_labels: + additionalProperties: + items: + type: string + type: array + type: object + x-stream-index: "040" + latest_reactions: + items: + $ref: '#/components/schemas/Reaction' + type: array + x-stream-index: "013" + mentioned_users: + items: + $ref: '#/components/schemas/User' + type: array + x-stream-index: "043" + message_text_updated_at: + format: date-time + type: number + x-stream-index: "052" + mml: + type: string + x-stream-index: "005" + moderation: + $ref: '#/components/schemas/ModerationV2Response' + x-stream-index: "056" + own_reactions: + items: + $ref: '#/components/schemas/Reaction' + type: array + x-stream-index: "014" + parent_id: + type: string + x-stream-index: "019" + pin_expires: + format: date-time + type: number + x-stream-index: "051" + pinned: + type: boolean + x-stream-index: "047" + pinned_at: + format: date-time + type: number + x-stream-index: "048" + pinned_by: + $ref: '#/components/schemas/User' + x-stream-index: "050" + poll: + $ref: '#/components/schemas/Poll' + x-stream-index: "054" + poll_id: + type: string + x-stream-index: "053" + quoted_message: + $ref: '#/components/schemas/Message' + x-stream-index: "025" + quoted_message_id: + type: string + x-stream-index: "024" + reaction_counts: + additionalProperties: + format: int32 + type: integer + type: object + x-stream-index: "015" + reaction_groups: + additionalProperties: + $ref: '#/components/schemas/ReactionGroupResponse' + type: object + x-stream-index: "017" + reaction_scores: + additionalProperties: + format: int32 + type: integer + type: object + x-stream-index: "016" + reminder: + $ref: '#/components/schemas/MessageReminder' + x-stream-index: "058" + reply_count: + format: int32 + type: integer + x-stream-index: "022" + restricted_visibility: + items: + type: string + type: array + x-stream-index: "011" + shadowed: + type: boolean + x-stream-index: "036" + shared_location: + $ref: '#/components/schemas/SharedLocation' + x-stream-index: "055" + show_in_channel: + type: boolean + x-stream-index: "021" + silent: + type: boolean + x-stream-index: "045" + text: + type: string + x-stream-index: "004" + thread_participants: + items: + $ref: '#/components/schemas/User' + type: array + x-stream-index: "027" + type: + type: string + x-stream-index: "008" + updated_at: + format: date-time + type: number + x-stream-index: "031" + user: + $ref: '#/components/schemas/User' + x-stream-index: "010" + required: + - id + - text + - html + - type + - restricted_visibility + - attachments + - latest_reactions + - own_reactions + - reaction_counts + - reaction_scores + - reaction_groups + - reply_count + - deleted_reply_count + - cid + - created_at + - updated_at + - custom + - shadowed + - mentioned_users + - silent + - pinned + type: object + MessageReminder: + properties: + channel: + $ref: '#/components/schemas/Channel' + x-stream-index: "004" + channel_cid: + type: string + x-stream-index: "003" + created_at: + format: date-time + type: number + x-stream-index: "011" + message: + $ref: '#/components/schemas/Message' + x-stream-index: "006" + message_id: + type: string + x-stream-index: "005" + remind_at: + format: date-time + type: number + x-stream-index: "009" + task_id: + type: string + x-stream-index: "010" + updated_at: + format: date-time + type: number + x-stream-index: "012" + user: + $ref: '#/components/schemas/User' + x-stream-index: "008" + user_id: + type: string + x-stream-index: "007" + required: + - channel_cid + - message_id + - user_id + - task_id + - created_at + - updated_at + type: object + MessageResponse: + description: Represents any chat message + properties: + attachments: + description: Array of message attachments + items: + $ref: '#/components/schemas/Attachment' + title: Message attachments + type: array + x-stream-docs-page-id: message_format#attachment-format + x-stream-index: "008" + cid: + description: Channel unique identifier in : format + title: Channel CID + type: string + x-stream-index: "022" + command: + description: Contains provided slash command + title: Command + type: string + x-stream-docs-page-id: custom_commands_webhook + x-stream-index: "004" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: "023" + custom: + additionalProperties: {} + type: object + x-stream-index: "026" + deleted_at: + description: Date/time of deletion + format: date-time + title: Deleted at + type: number + x-stream-index: "025" + deleted_for_me: + type: boolean + x-stream-index: "044" + deleted_reply_count: + format: int32 + type: integer + x-stream-index: "018" + draft: + $ref: '#/components/schemas/DraftResponse' + x-stream-index: "041" + html: + description: Contains HTML markup of the message. Can only be set when using + server-side API + title: HTML content + type: string + x-stream-index: "005" + i18n: + additionalProperties: + type: string + description: Object with translations. Key `language` contains the original + language key. Other keys contain translations + title: Internationalization info + type: object + x-stream-docs-page-id: translation + x-stream-index: "030" + id: + description: Message ID is unique string identifier of the message + title: ID + type: string + x-stream-index: "001" + image_labels: + additionalProperties: + items: + type: string + type: array + description: Contains image moderation information + title: Image moderation labels + type: object + x-stream-index: "028" + latest_reactions: + description: List of 10 latest reactions to this message + items: + $ref: '#/components/schemas/ReactionResponse' + title: Latest reactions + type: array + x-stream-index: "009" + mentioned_users: + description: List of mentioned users + items: + $ref: '#/components/schemas/UserResponse' + title: Mentioned Users + type: array + x-stream-index: "029" + message_text_updated_at: + format: date-time + type: number + x-stream-index: "036" + mml: + description: Should be empty if `text` is provided. Can only be set when + using server-side API + title: Messaging Markup Language + type: string + x-stream-docs-page-id: mml_overview + x-stream-index: "003" + moderation: + $ref: '#/components/schemas/ModerationV2Response' + x-stream-index: "039" + own_reactions: + description: List of 10 latest reactions of authenticated user to this message + items: + $ref: '#/components/schemas/ReactionResponse' + title: Own reactions + type: array + x-stream-index: "010" + parent_id: + description: ID of parent message (thread) + title: Parent message ID + type: string + x-stream-docs-page-id: threads + x-stream-index: "015" + pin_expires: + description: Date when pinned message expires + format: date-time + title: Pin expiration date + type: number + x-stream-docs-page-id: pinned_messages + x-stream-index: "035" + pinned: + description: Whether message is pinned or not + title: Pinned + type: boolean + x-stream-docs-page-id: pinned_messages + x-stream-index: "032" + pinned_at: + description: Date when message got pinned + format: date-time + title: Pinned at + type: number + x-stream-docs-page-id: pinned_messages + x-stream-index: "033" + pinned_by: + $ref: '#/components/schemas/UserResponse' + description: Contains user who pinned the message + title: Pinned by + x-stream-docs-page-id: pinned_messages + x-stream-index: "034" + poll: + $ref: '#/components/schemas/PollResponseData' + x-stream-index: "038" + poll_id: + description: Identifier of the poll to include in the message + title: Poll ID + type: string + x-stream-index: "037" + quoted_message: + $ref: '#/components/schemas/MessageResponse' + description: Contains quoted message + title: Quoted message + x-stream-docs-page-id: threads#quote-message + x-stream-index: "020" + quoted_message_id: + title: ID of quoted message + type: string + x-stream-docs-page-id: threads#quote-message + x-stream-index: "019" + reaction_counts: + additionalProperties: + format: int32 + type: integer + description: 'An object containing number of reactions of each type. Key: + reaction type (string), value: number of reactions (int)' + title: Reaction counts + type: object + x-stream-index: "011" + reaction_groups: + additionalProperties: + $ref: '#/components/schemas/ReactionGroupResponse' + type: object + x-stream-index: "014" + reaction_scores: + additionalProperties: + format: int32 + type: integer + description: 'An object containing scores of reactions of each type. Key: + reaction type (string), value: total score of reactions (int)' + title: Reaction scores + type: object + x-stream-index: "012" + reminder: + $ref: '#/components/schemas/ReminderResponseData' + x-stream-index: "042" + reply_count: + description: Number of replies to this message + format: int32 + title: Reply count + type: integer + x-stream-index: "017" + restricted_visibility: + description: A list of user ids that have restricted visibility to the message, + if the list is not empty, the message is only visible to the users in + the list + items: + type: string + title: Restricted visibility + type: array + x-stream-index: "040" + shadowed: + description: Whether the message was shadowed or not + title: Shadowed + type: boolean + x-stream-docs-page-id: moderation#shadow-ban + x-stream-index: "027" + shared_location: + $ref: '#/components/schemas/SharedLocationResponseData' + description: Contains shared location data + title: Shared Location + x-stream-index: "043" + show_in_channel: + description: Whether thread reply should be shown in the channel as well + title: Show in channel + type: boolean + x-stream-docs-page-id: threads + x-stream-index: "016" + silent: + description: Whether message is silent or not + title: Silent + type: boolean + x-stream-index: "031" + text: + description: Text of the message. Should be empty if `mml` is provided + title: Text + type: string + x-stream-index: "002" + thread_participants: + description: List of users who participate in thread + items: + $ref: '#/components/schemas/UserResponse' + title: Thread participants + type: array + x-stream-docs-page-id: threads#quote-message + x-stream-index: "021" + type: + description: Contains type of the message + enum: + - regular + - ephemeral + - error + - reply + - system + - deleted + title: Message Type + type: string + x-stream-docs-page-id: message_format#message-types + x-stream-index: "006" + updated_at: + description: Date/time of the last update + format: date-time + title: Updated at + type: number + x-stream-index: "024" + user: + $ref: '#/components/schemas/UserResponse' + description: Sender of the message. Required when using server-side API + title: User object + x-stream-index: "007" + required: + - id + - text + - html + - type + - user + - attachments + - latest_reactions + - own_reactions + - reaction_counts + - reaction_scores + - reply_count + - deleted_reply_count + - cid + - created_at + - updated_at + - custom + - shadowed + - mentioned_users + - silent + - pinned + - restricted_visibility + title: Message + type: object + x-stream-docs-page-id: send_message + ModerationActionConfig: + nullable: true + properties: + action: + type: string + x-stream-index: "006" + custom: + additionalProperties: {} + type: object + x-stream-index: "009" + description: + type: string + x-stream-index: "008" + entity_type: + type: string + x-stream-index: "004" + icon: + type: string + x-stream-index: "007" + order: + format: int32 + type: integer + x-stream-index: "005" + required: + - entity_type + - order + - action + - icon + - description + - custom + type: object + ModerationCheckCompletedEvent: + description: This event is sent when a moderation check is completed + nullable: true + properties: + created_at: + format: date-time + type: number + x-stream-index: "001.003" + custom: + additionalProperties: {} + type: object + x-stream-index: "001.007" + entity_id: + description: The ID of entity which was moderated + title: EntityID + type: string + x-stream-index: "002" + entity_type: + description: The type of the entity which was moderated + title: EntityType + type: string + x-stream-index: "003" + received_at: + format: date-time + type: number + x-stream-index: "001.004" + recommended_action: + description: The recommended action + title: RecommendedAction + type: string + x-stream-index: "004" + review_queue_item_id: + description: The review queue item ID + title: ReviewQueueItemID + type: string + x-stream-index: "005" + type: + default: moderation_check.completed + type: string + x-stream-index: "001.002" + required: + - type + - created_at + - custom + - entity_id + - entity_type + - recommended_action + - review_queue_item_id + title: ModerationCheckCompletedEvent + 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 + ModerationCustomActionEvent: + properties: + created_at: + format: date-time + type: number + x-stream-index: "004.002" + item: + $ref: '#/components/schemas/ReviewQueueItem' + x-stream-index: "001" + message: + $ref: '#/components/schemas/Message' + x-stream-index: "002" + type: + default: moderation.custom_action + type: string + x-stream-index: "004.001" + user: + $ref: '#/components/schemas/User' + x-stream-index: "003.001" + required: + - type + - created_at + title: ModerationCustomActionEvent + 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 + ModerationDashboardPreferences: + properties: + flag_user_on_flagged_content: + type: boolean + x-stream-index: "002" + media_queue_blur_enabled: + type: boolean + x-stream-index: "001" + type: object + ModerationFlagResponse: + nullable: true + properties: + created_at: + format: date-time + type: number + x-stream-index: "015" + custom: + additionalProperties: {} + type: object + x-stream-index: "010" + entity_creator_id: + type: string + x-stream-index: "007" + entity_id: + type: string + x-stream-index: "006" + entity_type: + type: string + x-stream-index: "005" + labels: + items: + type: string + type: array + x-stream-index: "011" + moderation_payload: + $ref: '#/components/schemas/ModerationPayload' + x-stream-index: "008" + reason: + type: string + x-stream-index: "009" + result: + items: + additionalProperties: {} + type: object + type: array + x-stream-index: "012" + review_queue_item: + $ref: '#/components/schemas/ReviewQueueItemResponse' + x-stream-index: "014" + review_queue_item_id: + type: string + x-stream-index: "013" + type: + type: string + x-stream-index: "002" + updated_at: + format: date-time + type: number + x-stream-index: "016" + user: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "004" + user_id: + type: string + x-stream-index: "003" + required: + - type + - user_id + - entity_type + - entity_id + - result + - created_at + - updated_at + type: object + ModerationFlaggedEvent: + properties: + created_at: + format: date-time + type: number + x-stream-index: "004.002" + item: + type: string + x-stream-index: "001" + object_id: + type: string + x-stream-index: "002" + type: + default: moderation.flagged + type: string + x-stream-index: "004.001" + user: + $ref: '#/components/schemas/User' + x-stream-index: "003.001" + required: + - type + - created_at + title: ModerationFlaggedEvent + 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 + ModerationMarkReviewedEvent: + properties: + created_at: + format: date-time + type: number + x-stream-index: "004.002" + item: + $ref: '#/components/schemas/ReviewQueueItem' + x-stream-index: "001" + message: + $ref: '#/components/schemas/Message' + x-stream-index: "002" + type: + default: moderation.mark_reviewed + type: string + x-stream-index: "004.001" + user: + $ref: '#/components/schemas/User' + x-stream-index: "003.001" + required: + - type + - created_at + title: ModerationMarkReviewedEvent + 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 + ModerationPayload: + properties: + custom: + additionalProperties: {} + type: object + x-stream-index: "004" + images: + items: + type: string + maximum: 30 + type: array + x-stream-index: "002" + texts: + items: + type: string + type: array + x-stream-index: "001" + videos: + items: + type: string + type: array + x-stream-index: "003" + type: object + ModerationRuleV2Response: + properties: + action: + $ref: '#/components/schemas/RuleBuilderAction' + x-stream-index: "010" + conditions: + items: + $ref: '#/components/schemas/RuleBuilderCondition' + type: array + x-stream-index: "007" + config_keys: + items: + type: string + type: array + x-stream-index: "004" + cooldown_period: + type: string + x-stream-index: "011" + created_at: + format: date-time + type: number + x-stream-index: "013" + description: + type: string + x-stream-index: "003" + enabled: + type: boolean + x-stream-index: "012" + groups: + items: + $ref: '#/components/schemas/RuleBuilderConditionGroup' + type: array + x-stream-index: "009" + id: + type: string + x-stream-index: "001" + logic: + type: string + x-stream-index: "008" + name: + type: string + x-stream-index: "002" + rule_type: + type: string + x-stream-index: "006" + team: + type: string + x-stream-index: "005" + updated_at: + format: date-time + type: number + x-stream-index: "014" + required: + - id + - name + - description + - config_keys + - team + - rule_type + - action + - enabled + - created_at + - updated_at + type: object + ModerationV2Response: + properties: + action: + type: string + x-stream-index: "001" + blocklist_matched: + type: string + x-stream-index: "005" + image_harms: + items: + type: string + type: array + x-stream-index: "004" + original_text: + type: string + x-stream-index: "002" + platform_circumvented: + type: boolean + x-stream-index: "007" + semantic_filter_matched: + type: string + x-stream-index: "006" + text_harms: + items: + type: string + type: array + x-stream-index: "003" + required: + - action + - original_text + type: object + MuteRequest: + nullable: true + properties: + target_ids: + description: User IDs to mute (if multiple users) + items: + type: string + title: Target IDs + type: array + x-stream-index: "001" + timeout: + description: Duration of mute in minutes + minimum: 0 + title: Timeout + type: integer + x-stream-index: "002" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "003.002" + user_id: + type: string + x-stream-index: "003.001" + required: + - target_ids + title: MuteRequest + type: object + MuteResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "004.001" + mutes: + description: Object with mutes (if multiple users were muted) + items: + $ref: '#/components/schemas/UserMute' + title: Mutes + type: array + x-stream-index: "001" + non_existing_users: + description: A list of users that can't be found. Common cause for this + is deleted users + items: + type: string + title: Non Existing Users + type: array + x-stream-index: "003" + own_user: + $ref: '#/components/schemas/OwnUser' + description: Authorized user object with fresh mutes information + title: Own User + x-stream-index: "002" + required: + - duration + title: MuteResponse + type: object + NoiseCancellationSettings: + properties: + mode: + enum: + - available + - disabled + - auto-on + type: string + x-stream-index: "001" + required: + - mode + type: object + NotificationConfig: + properties: + track_read: + description: Whether to track read status + title: Track Read + type: boolean + x-stream-index: "002" + track_seen: + description: Whether to track seen status + title: Track Seen + type: boolean + x-stream-index: "001" + title: Notification Configuration + type: object + NotificationFeedUpdatedEvent: + description: Emitted when notification feed is updated. + nullable: true + properties: + aggregated_activities: + description: Aggregated activities for notification feeds + items: + $ref: '#/components/schemas/AggregatedActivityResponse' + title: Aggregated Activities + type: array + x-stream-index: "001" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 003.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 003.001.007 + feed_visibility: + type: string + x-stream-index: "003.003" + fid: + description: The ID of the feed + title: Feed ID + type: string + x-stream-index: "003.002" + notification_status: + $ref: '#/components/schemas/NotificationStatusResponse' + description: Notification status including unread/unseen counts + title: Notification Status + x-stream-index: "002" + received_at: + format: date-time + type: number + x-stream-index: 003.001.004 + type: + default: feeds.notification_feed.updated + description: 'The type of event: "feeds.notification_feed.updated" in this + case' + title: Event Type + type: string + x-stream-index: 003.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who triggered the notification + title: User + x-stream-index: "004.001" + required: + - type + - created_at + - custom + - fid + title: NotificationFeedUpdatedEvent + 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 + NotificationSettings: + properties: + call_live_started: + $ref: '#/components/schemas/EventNotificationSettings' + x-stream-index: "002" + call_missed: + $ref: '#/components/schemas/EventNotificationSettings' + x-stream-index: "006" + call_notification: + $ref: '#/components/schemas/EventNotificationSettings' + x-stream-index: "004" + call_ring: + $ref: '#/components/schemas/EventNotificationSettings' + x-stream-index: "005" + enabled: + type: boolean + x-stream-index: "001" + session_started: + $ref: '#/components/schemas/EventNotificationSettings' + x-stream-index: "003" + required: + - enabled + - call_live_started + - session_started + - call_notification + - call_ring + - call_missed + type: object + NotificationStatusResponse: + properties: + last_read_at: + format: date-time + type: number + x-stream-index: "006" + last_seen_at: + description: When notifications were last seen + format: date-time + title: Last Seen At + type: number + x-stream-index: "005" + read_activities: + description: IDs of activities that have been read + items: + type: string + title: Read Activities + type: array + x-stream-index: "003" + seen_activities: + items: + type: string + type: array + x-stream-index: "004" + unread: + description: Number of unread notifications + format: int32 + title: Unread + type: integer + x-stream-index: "001" + unseen: + description: Number of unseen notifications + format: int32 + title: Unseen + type: integer + x-stream-index: "002" + required: + - unread + - unseen + title: Notification Status + type: object + NullTime: + type: object + OCRRule: + properties: + action: + enum: + - flag + - shadow + - remove + - bounce + - bounce_flag + - bounce_remove + type: string + x-stream-index: "002" + label: + type: string + x-stream-index: "001" + required: + - label + - action + type: object + OnlyUserID: + properties: + id: + type: string + x-stream-index: "001" + required: + - id + type: object + OwnUser: + properties: + avg_response_time: + format: int32 + type: integer + x-stream-index: "046" + banned: + type: boolean + x-stream-index: "016" + blocked_user_ids: + items: + type: string + type: array + x-stream-index: "045" + channel_mutes: + items: + $ref: '#/components/schemas/ChannelMute' + type: array + x-stream-index: "029" + created_at: + format: date-time + type: number + x-stream-index: "008" + custom: + additionalProperties: {} + type: object + x-stream-index: "006" + deactivated_at: + format: date-time + type: number + x-stream-index: "014" + deleted_at: + format: date-time + type: number + x-stream-index: "013" + devices: + items: + $ref: '#/components/schemas/Device' + type: array + x-stream-index: "027" + id: + type: string + x-stream-index: "003" + invisible: + type: boolean + x-stream-index: "023" + language: + type: string + x-stream-index: "035" + last_active: + format: date-time + type: number + x-stream-index: "011" + last_engaged_at: + format: date-time + type: number + x-stream-index: "012" + latest_hidden_channels: + items: + type: string + type: array + x-stream-index: "037" + mutes: + items: + $ref: '#/components/schemas/UserMute' + type: array + x-stream-index: "028" + online: + type: boolean + x-stream-index: "022" + privacy_settings: + $ref: '#/components/schemas/PrivacySettings' + x-stream-index: "026" + push_preferences: + $ref: '#/components/schemas/PushPreferences' + x-stream-index: "025" + role: + type: string + x-stream-index: "004" + teams: + items: + type: string + type: array + x-stream-index: "036" + teams_role: + additionalProperties: + type: string + type: object + x-stream-index: "005" + total_unread_count: + format: int32 + type: integer + x-stream-index: "031" + total_unread_count_by_team: + additionalProperties: + format: int32 + type: integer + type: object + x-stream-index: "032" + unread_channels: + format: int32 + type: integer + x-stream-index: "033" + unread_count: + format: int32 + type: integer + x-stream-index: "030" + unread_threads: + format: int32 + type: integer + x-stream-index: "034" + updated_at: + format: date-time + type: number + x-stream-index: "009" + required: + - id + - role + - custom + - created_at + - updated_at + - banned + - online + - devices + - mutes + - channel_mutes + - unread_count + - total_unread_count + - total_unread_count_by_team + - unread_channels + - unread_threads + - language + type: object + PagerRequest: + properties: + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "001" + next: + type: string + x-stream-index: "002" + prev: + type: string + x-stream-index: "003" + type: object + PagerResponse: + properties: + next: + type: string + x-stream-index: "001" + prev: + type: string + x-stream-index: "002" + type: object + Permission: + properties: + action: + description: Action name this permission is for (e.g. SendMessage) + title: Action + type: string + x-stream-index: "004" + condition: + additionalProperties: {} + description: MongoDB style condition which decides whether or not the permission + is granted + title: Condition + type: object + x-stream-index: "007" + custom: + description: Whether this is a custom permission or built-in + title: Custom + type: boolean + x-stream-index: "009" + description: + description: Description of the permission + title: Description + type: string + x-stream-index: "003" + id: + description: Unique permission ID + title: ID + type: string + x-stream-index: "001" + level: + description: Level at which permission could be applied (app or channel) + enum: + - app + - channel + title: Level + type: string + x-stream-index: "010" + name: + description: Name of the permission + title: Name + type: string + x-stream-index: "002" + owner: + description: Whether this permission applies to resource owner or not + title: Owner + type: boolean + x-stream-index: "005" + same_team: + description: Whether this permission applies to teammates (multi-tenancy + mode only) + title: Same team + type: boolean + x-stream-index: "006" + tags: + description: List of tags of the permission + items: + type: string + title: Tags + type: array + x-stream-index: "011" + required: + - id + - name + - description + - action + - owner + - same_team + - custom + - level + - tags + type: object + PinActivityRequest: + nullable: true + properties: + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "005.002" + user_id: + type: string + x-stream-index: "005.001" + title: Pin Activity Request + type: object + PinActivityResponse: + nullable: true + properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + description: The pinned activity + title: Activity + x-stream-index: "001" + created_at: + description: When the activity was pinned + format: date-time + title: Created At + type: number + x-stream-index: "004" + duration: + type: string + x-stream-index: "005.001" + feed: + description: Fully qualified ID of the feed the activity was pinned to + title: Feed ID + type: string + x-stream-index: "002" + user_id: + description: ID of the user who pinned the activity + title: User ID + type: string + x-stream-index: "003" + required: + - activity + - feed + - user_id + - created_at + - duration + title: Pin Activity Response + type: object + Policy: + properties: + action: + type: integer + x-stream-index: "007" + created_at: + format: date-time + type: number + x-stream-index: "010" + name: + type: string + x-stream-index: "004" + owner: + type: boolean + x-stream-index: "008" + priority: + format: int32 + type: integer + x-stream-index: "009" + resources: + items: + type: string + type: array + x-stream-index: "005" + roles: + items: + type: string + type: array + x-stream-index: "006" + updated_at: + format: date-time + type: number + x-stream-index: "011" + required: + - name + - resources + - roles + - action + - owner + - priority + - created_at + - updated_at + type: object + Poll: + properties: + Custom: + additionalProperties: {} + type: object + writeOnly: true + x-stream-index: "023" + allow_answers: + type: boolean + x-stream-index: "010" + allow_user_suggested_options: + type: boolean + x-stream-index: "009" + answers_count: + format: int32 + type: integer + x-stream-index: "015" + created_at: + format: date-time + type: number + x-stream-index: "021" + created_by: + $ref: '#/components/schemas/User' + x-stream-index: "020" + created_by_id: + type: string + x-stream-index: "019" + description: + type: string + x-stream-index: "005" + enforce_unique_vote: + type: boolean + x-stream-index: "007" + id: + type: string + x-stream-index: "003" + is_closed: + type: boolean + x-stream-index: "011" + latest_answers: + items: + $ref: '#/components/schemas/PollVote' + type: array + x-stream-index: "017" + latest_votes_by_option: + additionalProperties: + items: + $ref: '#/components/schemas/PollVote' + type: array + type: object + x-stream-index: "016" + max_votes_allowed: + format: int32 + type: integer + x-stream-index: "008" + name: + type: string + x-stream-index: "004" + options: + items: + $ref: '#/components/schemas/PollOption' + type: array + x-stream-index: "013" + own_votes: + items: + $ref: '#/components/schemas/PollVote' + type: array + x-stream-index: "018" + updated_at: + format: date-time + type: number + x-stream-index: "022" + vote_count: + format: int32 + type: integer + x-stream-index: "012" + vote_counts_by_option: + additionalProperties: + format: int32 + type: integer + type: object + x-stream-index: "014" + voting_visibility: + type: string + x-stream-index: "006" + required: + - id + - name + - description + - enforce_unique_vote + - allow_user_suggested_options + - allow_answers + - vote_count + - options + - vote_counts_by_option + - answers_count + - latest_votes_by_option + - latest_answers + - own_votes + - created_by_id + - created_at + - updated_at + - Custom + type: object + PollOption: + nullable: true + properties: + custom: + additionalProperties: {} + type: object + x-stream-index: "003" + id: + maxLength: 255 + type: string + x-stream-index: "001" + text: + type: string + x-stream-index: "002" + required: + - id + - text + - custom + type: object + PollOptionInput: + nullable: true + properties: + custom: + additionalProperties: {} + type: object + x-stream-index: "003" + text: + type: string + x-stream-index: "002" + type: object + PollOptionRequest: + nullable: true + properties: + custom: + additionalProperties: {} + type: object + x-stream-index: "003" + id: + maxLength: 255 + type: string + x-stream-index: "001" + text: + type: string + x-stream-index: "002" + required: + - id + type: object + PollOptionResponse: + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "002.001" + poll_option: + $ref: '#/components/schemas/PollOptionResponseData' + description: Poll option + title: PollOptionResponseData + x-stream-index: "001" + required: + - poll_option + - duration + type: object + PollOptionResponseData: + nullable: true + properties: + custom: + additionalProperties: {} + type: object + x-stream-index: "003" + id: + type: string + x-stream-index: "001" + text: + type: string + x-stream-index: "002" + required: + - id + - text + - custom + type: object + PollResponse: + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "002.001" + poll: + $ref: '#/components/schemas/PollResponseData' + description: Poll + title: PollResponseData + x-stream-index: "001" + required: + - poll + - duration + type: object + PollResponseData: + properties: + allow_answers: + type: boolean + x-stream-index: "008" + allow_user_suggested_options: + type: boolean + x-stream-index: "007" + answers_count: + format: int32 + type: integer + x-stream-index: "012" + created_at: + format: date-time + type: number + x-stream-index: "019" + created_by: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "018" + created_by_id: + type: string + x-stream-index: "017" + custom: + additionalProperties: {} + type: object + x-stream-index: "021" + description: + type: string + x-stream-index: "003" + enforce_unique_vote: + type: boolean + x-stream-index: "005" + id: + type: string + x-stream-index: "001" + is_closed: + type: boolean + x-stream-index: "009" + latest_answers: + items: + $ref: '#/components/schemas/PollVoteResponseData' + type: array + x-stream-index: "015" + latest_votes_by_option: + additionalProperties: + items: + $ref: '#/components/schemas/PollVoteResponseData' + type: array + type: object + x-stream-index: "014" + max_votes_allowed: + format: int32 + type: integer + x-stream-index: "006" + name: + type: string + x-stream-index: "002" + options: + items: + $ref: '#/components/schemas/PollOptionResponseData' + type: array + x-stream-index: "011" + own_votes: + items: + $ref: '#/components/schemas/PollVoteResponseData' + type: array + x-stream-index: "016" + updated_at: + format: date-time + type: number + x-stream-index: "020" + vote_count: + format: int32 + type: integer + x-stream-index: "010" + vote_counts_by_option: + additionalProperties: + format: int32 + type: integer + type: object + x-stream-index: "013" + voting_visibility: + type: string + x-stream-index: "004" + required: + - id + - name + - description + - voting_visibility + - enforce_unique_vote + - allow_user_suggested_options + - allow_answers + - vote_count + - options + - answers_count + - vote_counts_by_option + - latest_votes_by_option + - latest_answers + - own_votes + - created_by_id + - created_at + - updated_at + - custom + type: object + PollVote: + nullable: true + properties: + answer_text: + type: string + x-stream-index: "007" + created_at: + format: date-time + type: number + x-stream-index: "010" + id: + type: string + x-stream-index: "004" + is_answer: + type: boolean + x-stream-index: "006" + option_id: + type: string + x-stream-index: "005" + poll_id: + type: string + x-stream-index: "003" + updated_at: + format: date-time + type: number + x-stream-index: "011" + user: + $ref: '#/components/schemas/User' + x-stream-index: "009" + user_id: + type: string + x-stream-index: "008" + required: + - poll_id + - id + - option_id + - created_at + - updated_at + type: object + PollVoteResponse: + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "002.001" + vote: + $ref: '#/components/schemas/PollVoteResponseData' + description: Poll vote + title: PollVoteResponseData + x-stream-index: "001" + required: + - duration + type: object + PollVoteResponseData: + nullable: true + properties: + answer_text: + type: string + x-stream-index: "005" + created_at: + format: date-time + type: number + x-stream-index: "008" + id: + type: string + x-stream-index: "002" + is_answer: + type: boolean + x-stream-index: "004" + option_id: + type: string + x-stream-index: "003" + poll_id: + type: string + x-stream-index: "001" + updated_at: + format: date-time + type: number + x-stream-index: "009" + user: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "007" + user_id: + type: string + x-stream-index: "006" + required: + - poll_id + - id + - option_id + - created_at + - updated_at + type: object + PollVotesResponse: + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "003.001" + next: + type: string + x-stream-index: "002.001" + prev: + type: string + x-stream-index: "002.002" + votes: + description: Poll votes + items: + $ref: '#/components/schemas/PollVoteResponseData' + title: PollVoteResponseList + type: array + x-stream-index: "001" + required: + - votes + - duration + type: object + PrivacySettings: + properties: + read_receipts: + $ref: '#/components/schemas/ReadReceipts' + x-stream-index: "002" + typing_indicators: + $ref: '#/components/schemas/TypingIndicators' + x-stream-index: "001" + type: object + PrivacySettingsResponse: + properties: + read_receipts: + $ref: '#/components/schemas/ReadReceiptsResponse' + x-stream-index: "002" + typing_indicators: + $ref: '#/components/schemas/TypingIndicatorsResponse' + x-stream-index: "001" + type: object + PushConfig: + properties: + offline_only: + type: boolean + x-stream-index: "002" + version: + enum: + - v1 + - v2 + - v3 + type: string + x-stream-index: "001" + required: + - version + type: object + PushNotificationConfig: + properties: + activity_types: + enum: + - follow + - comment + - reaction + - comment_reaction + items: + type: string + type: array + x-stream-index: "002" + enabled: + type: boolean + x-stream-index: "001" + type: object + PushNotificationFields: + properties: + apn: + $ref: '#/components/schemas/APNConfigFields' + x-stream-index: "002" + firebase: + $ref: '#/components/schemas/FirebaseConfigFields' + x-stream-index: "003" + huawei: + $ref: '#/components/schemas/HuaweiConfigFields' + x-stream-index: "004" + offline_only: + type: boolean + x-stream-index: "001.002" + providers: + items: + $ref: '#/components/schemas/PushProvider' + type: array + x-stream-index: "006" + version: + type: string + x-stream-index: "001.001" + xiaomi: + $ref: '#/components/schemas/XiaomiConfigFields' + x-stream-index: "005" + required: + - version + - offline_only + - apn + - firebase + - huawei + - xiaomi + type: object + PushNotificationSettingsResponse: + properties: + disabled: + type: boolean + x-stream-index: "001" + disabled_until: + format: date-time + type: number + x-stream-index: "002" + type: object + PushPreferences: + properties: + call_level: + type: string + x-stream-index: "002" + chat_level: + type: string + x-stream-index: "001" + disabled_until: + format: date-time + type: number + x-stream-index: "005" + feeds_events: + $ref: '#/components/schemas/FeedsEventPreferences' + x-stream-index: "004" + feeds_level: + type: string + x-stream-index: "003" + type: object + PushProvider: + nullable: true + properties: + apn_auth_key: + type: string + x-stream-index: "012" + apn_auth_type: + type: string + x-stream-index: "017" + apn_development: + type: boolean + x-stream-index: "018" + apn_host: + type: string + x-stream-index: "019" + apn_key_id: + type: string + x-stream-index: "013" + apn_notification_template: + type: string + x-stream-index: "020" + apn_p12_cert: + type: string + x-stream-index: "014" + apn_team_id: + type: string + x-stream-index: "015" + apn_topic: + type: string + x-stream-index: "016" + created_at: + format: date-time + type: number + x-stream-index: "008" + description: + maxLength: 128 + type: string + x-stream-index: "007" + disabled_at: + format: date-time + type: number + x-stream-index: "010" + disabled_reason: + maxLength: 255 + type: string + x-stream-index: "011" + firebase_apn_template: + type: string + x-stream-index: "025" + firebase_credentials: + type: string + x-stream-index: "022" + firebase_data_template: + type: string + x-stream-index: "023" + firebase_host: + type: string + x-stream-index: "026" + firebase_notification_template: + type: string + x-stream-index: "024" + firebase_server_key: + type: string + x-stream-index: "021" + huawei_app_id: + type: string + x-stream-index: "027" + huawei_app_secret: + type: string + x-stream-index: "028" + name: + maxLength: 36 + minLength: 1 + type: string + x-stream-index: "005" + push_templates: + items: + $ref: '#/components/schemas/PushTemplate' + type: array + x-stream-index: "031" + type: + type: string + x-stream-index: "006" + updated_at: + format: date-time + type: number + x-stream-index: "009" + xiaomi_app_secret: + type: string + x-stream-index: "030" + xiaomi_package_name: + type: string + x-stream-index: "029" + required: + - name + - type + - created_at + - updated_at + type: object + PushProviderResponse: + properties: + apn_auth_key: + type: string + x-stream-index: "008" + apn_auth_type: + type: string + x-stream-index: "013" + apn_development: + type: boolean + x-stream-index: "014" + apn_host: + type: string + x-stream-index: "015" + apn_key_id: + type: string + x-stream-index: "009" + apn_p12_cert: + type: string + x-stream-index: "010" + apn_sandbox_certificate: + type: boolean + x-stream-index: "016" + apn_supports_remote_notifications: + type: boolean + x-stream-index: "018" + apn_supports_voip_notifications: + type: boolean + x-stream-index: "017" + apn_team_id: + type: string + x-stream-index: "011" + apn_topic: + type: string + x-stream-index: "012" + created_at: + format: date-time + type: number + x-stream-index: "004" + description: + type: string + x-stream-index: "003" + disabled_at: + format: date-time + type: number + x-stream-index: "006" + disabled_reason: + type: string + x-stream-index: "007" + firebase_apn_template: + type: string + x-stream-index: "023" + firebase_credentials: + type: string + x-stream-index: "020" + firebase_data_template: + type: string + x-stream-index: "021" + firebase_host: + type: string + x-stream-index: "024" + firebase_notification_template: + type: string + x-stream-index: "022" + firebase_server_key: + type: string + x-stream-index: "019" + huawei_app_id: + type: string + x-stream-index: "025" + huawei_app_secret: + type: string + x-stream-index: "026" + name: + type: string + x-stream-index: "001" + type: + type: string + x-stream-index: "002" + updated_at: + format: date-time + type: number + x-stream-index: "005" + xiaomi_app_secret: + type: string + x-stream-index: "028" + xiaomi_package_name: + type: string + x-stream-index: "027" + required: + - name + - type + - created_at + - updated_at + type: object + PushTemplate: + nullable: true + properties: + created_at: + format: date-time + type: number + x-stream-index: "007" + enable_push: + type: boolean + x-stream-index: "003" + event_type: + enum: + - message.new + - message.updated + - reaction.new + - notification.reminder_due + - feeds.activity.added + - feeds.comment.added + - feeds.activity.reaction.added + - feeds.comment.reaction.added + - feeds.follow.created + - feeds.notification_feed.updated + type: string + x-stream-index: "005" + template: + type: string + x-stream-index: "006" + updated_at: + format: date-time + type: number + x-stream-index: "008" + required: + - enable_push + - event_type + - created_at + - updated_at + type: object + Quality: + properties: + bitdepth: + format: int32 + type: integer + x-stream-index: "007" + framerate: + format: int32 + type: integer + x-stream-index: "008" + height: + format: int32 + type: integer + x-stream-index: "006" + name: + type: string + x-stream-index: "004" + video_bitrate: + format: int32 + type: integer + x-stream-index: "009" + width: + format: int32 + type: integer + x-stream-index: "005" + type: object + QueryActivitiesRequest: + nullable: true + properties: + filter: + additionalProperties: {} + description: Filters to apply to the query. Supports location-based queries + with 'near' and 'within_bounds' operators. + title: Filter + type: object + x-stream-index: "001" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "003.001" + next: + type: string + x-stream-index: "003.002" + prev: + type: string + x-stream-index: "003.003" + sort: + description: Sorting parameters for the query + items: + $ref: '#/components/schemas/SortParamRequest' + maximum: 5 + title: Sort + type: array + x-stream-index: "002" + title: Query Activities Request + type: object + QueryActivitiesResponse: + nullable: true + properties: + activities: + description: List of activities matching the query + items: + $ref: '#/components/schemas/ActivityResponse' + title: Activities + type: array + x-stream-index: "001" + duration: + type: string + x-stream-index: "003.001" + next: + description: Cursor for next page + title: Next + type: string + x-stream-index: "002.001" + prev: + description: Cursor for previous page + title: Previous + type: string + x-stream-index: "002.002" + required: + - activities + - duration + title: Query Activities Response + type: object + QueryActivityReactionsRequest: + nullable: true + properties: + filter: + additionalProperties: {} + type: object + x-stream-index: "002" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "004.001" + next: + type: string + x-stream-index: "004.002" + prev: + type: string + x-stream-index: "004.003" + sort: + items: + $ref: '#/components/schemas/SortParamRequest' + maximum: 5 + type: array + x-stream-index: "003" + type: object + QueryActivityReactionsResponse: + description: Basic response information + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "003.001" + next: + type: string + x-stream-index: "002.001" + prev: + type: string + x-stream-index: "002.002" + reactions: + items: + $ref: '#/components/schemas/FeedsReactionResponse' + type: array + x-stream-index: "001" + required: + - reactions + - duration + title: Response + type: object + QueryBookmarkFoldersRequest: + nullable: true + properties: + filter: + additionalProperties: {} + description: Filters to apply to the query + title: Filter + type: object + x-stream-index: "001" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "003.001" + next: + type: string + x-stream-index: "003.002" + prev: + type: string + x-stream-index: "003.003" + sort: + description: Sorting parameters for the query + items: + $ref: '#/components/schemas/SortParamRequest' + title: Sort + type: array + x-stream-index: "002" + title: Query Bookmark Folders Request + type: object + QueryBookmarkFoldersResponse: + nullable: true + properties: + bookmark_folders: + description: List of bookmark folders matching the query + items: + $ref: '#/components/schemas/BookmarkFolderResponse' + title: Bookmark Folders + type: array + x-stream-index: "001" + duration: + type: string + x-stream-index: "003.001" + next: + description: Cursor for next page + title: Next + type: string + x-stream-index: "002.001" + prev: + description: Cursor for previous page + title: Previous + type: string + x-stream-index: "002.002" + required: + - bookmark_folders + - duration + title: Query Bookmark Folders Response + type: object + QueryBookmarksRequest: + nullable: true + properties: + filter: + additionalProperties: {} + description: Filters to apply to the query + title: Filter + type: object + x-stream-index: "001" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "003.001" + next: + type: string + x-stream-index: "003.002" + prev: + type: string + x-stream-index: "003.003" + sort: + description: Sorting parameters for the query + items: + $ref: '#/components/schemas/SortParamRequest' + maximum: 5 + title: Sort + type: array + x-stream-index: "002" + title: Query Bookmarks Request + type: object + QueryBookmarksResponse: + nullable: true + properties: + bookmarks: + description: List of bookmarks matching the query + items: + $ref: '#/components/schemas/BookmarkResponse' + title: Bookmarks + type: array + x-stream-index: "001" + duration: + type: string + x-stream-index: "003.001" + next: + description: Cursor for next page + title: Next + type: string + x-stream-index: "002.001" + prev: + description: Cursor for previous page + title: Previous + type: string + x-stream-index: "002.002" + required: + - bookmarks + - duration + title: Query Bookmarks Response + type: object + QueryCommentReactionsRequest: + nullable: true + properties: + filter: + additionalProperties: {} + type: object + x-stream-index: "002" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "004.001" + next: + type: string + x-stream-index: "004.002" + prev: + type: string + x-stream-index: "004.003" + sort: + items: + $ref: '#/components/schemas/SortParamRequest' + maximum: 5 + type: array + x-stream-index: "003" + type: object + QueryCommentReactionsResponse: + description: Basic response information + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "003.001" + next: + type: string + x-stream-index: "002.001" + prev: + type: string + x-stream-index: "002.002" + reactions: + items: + $ref: '#/components/schemas/FeedsReactionResponse' + type: array + x-stream-index: "001" + required: + - reactions + - duration + title: Response + type: object + QueryCommentsRequest: + nullable: true + properties: + filter: + additionalProperties: {} + description: MongoDB-style filter for querying comments + title: Filter + type: object + x-stream-index: "001" + limit: + description: Maximum number of comments to return + format: int32 + maximum: 100 + minimum: 0 + title: Limit + type: integer + x-stream-index: "003.001" + next: + type: string + x-stream-index: "003.002" + prev: + type: string + x-stream-index: "003.003" + sort: + description: first (oldest), last (newest) or top + enum: + - first + - last + - top + - best + - controversial + title: Sort Order + type: string + x-stream-index: "002" + required: + - filter + title: Query Comments Request + type: object + QueryCommentsResponse: + nullable: true + properties: + comments: + description: List of comments matching the query + items: + $ref: '#/components/schemas/CommentResponse' + title: Comments + type: array + x-stream-index: "001" + duration: + type: string + x-stream-index: "003.001" + next: + description: Cursor for next page + title: Next + type: string + x-stream-index: "002.001" + prev: + description: Cursor for previous page + title: Previous + type: string + x-stream-index: "002.002" + required: + - comments + - duration + title: Query Comments Response + type: object + QueryFeedMembersRequest: + nullable: true + properties: + filter: + additionalProperties: {} + description: Filter parameters for the query + title: object + type: object + x-stream-index: "003" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "005.001" + next: + type: string + x-stream-index: "005.002" + prev: + type: string + x-stream-index: "005.003" + sort: + description: Sort parameters for the query + items: + $ref: '#/components/schemas/SortParamRequest' + maximum: 5 + title: array + type: array + x-stream-index: "004" + type: object + QueryFeedMembersResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "003.001" + members: + description: List of feed members + items: + $ref: '#/components/schemas/FeedMemberResponse' + title: array + type: array + x-stream-index: "001" + next: + description: Cursor for next page + title: Next + type: string + x-stream-index: "002.001" + prev: + description: Cursor for previous page + title: Previous + type: string + x-stream-index: "002.002" + required: + - members + - duration + type: object + QueryFeedModerationTemplate: + properties: + config: + $ref: '#/components/schemas/FeedsModerationTemplateConfig' + description: Configuration for the moderation template + title: Config + x-stream-index: "002" + created_at: + description: When the template was created + format: date-time + title: Created At + type: number + x-stream-index: "003" + name: + description: Name of the moderation template + title: Name + type: string + x-stream-index: "001" + updated_at: + description: When the template was last updated + format: date-time + title: Updated At + type: number + x-stream-index: "004" + required: + - name + - created_at + - updated_at + type: object + QueryFeedModerationTemplatesResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + templates: + description: List of moderation templates + items: + $ref: '#/components/schemas/QueryFeedModerationTemplate' + title: Templates + type: array + x-stream-index: "001" + required: + - templates + - duration + type: object + QueryFeedsRequest: + nullable: true + properties: + filter: + additionalProperties: {} + description: Filters to apply to the query + title: Filter + type: object + x-stream-index: "001" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "004.001" + next: + type: string + x-stream-index: "004.002" + prev: + type: string + x-stream-index: "004.003" + sort: + description: Sorting parameters for the query + items: + $ref: '#/components/schemas/SortParamRequest' + maximum: 5 + title: Sort + type: array + x-stream-index: "003" + watch: + description: Whether to subscribe to realtime updates + title: Watch + type: boolean + x-stream-index: "002" + title: Query Feeds Request + type: object + QueryFeedsResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "003.001" + feeds: + description: List of feeds matching the query + items: + $ref: '#/components/schemas/FeedResponse' + title: Feeds + type: array + x-stream-index: "001" + next: + description: Cursor for next page + title: Next + type: string + x-stream-index: "002.001" + prev: + description: Cursor for previous page + title: Previous + type: string + x-stream-index: "002.002" + required: + - feeds + - duration + title: Query Feeds Response + type: object + QueryFollowsRequest: + nullable: true + properties: + filter: + additionalProperties: {} + description: Filters to apply to the query + title: Filter + type: object + x-stream-index: "001" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "003.001" + next: + type: string + x-stream-index: "003.002" + prev: + type: string + x-stream-index: "003.003" + sort: + description: Sorting parameters for the query + items: + $ref: '#/components/schemas/SortParamRequest' + maximum: 5 + title: Sort + type: array + x-stream-index: "002" + title: Query Follows Request + type: object + QueryFollowsResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "003.001" + follows: + description: List of follow relationships matching the query + items: + $ref: '#/components/schemas/FollowResponse' + title: Follows + type: array + x-stream-index: "001" + next: + description: Cursor for next page + title: Next + type: string + x-stream-index: "002.001" + prev: + description: Cursor for previous page + title: Previous + type: string + x-stream-index: "002.002" + required: + - follows + - duration + title: Query Follows Response + type: object + QueryMembershipLevelsRequest: + nullable: true + properties: + filter: + additionalProperties: {} + description: Filters to apply to the query + title: Filter + type: object + x-stream-index: "001" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "003.001" + next: + type: string + x-stream-index: "003.002" + prev: + type: string + x-stream-index: "003.003" + sort: + description: Sorting parameters for the query + items: + $ref: '#/components/schemas/SortParamRequest' + maximum: 5 + title: Sort + type: array + x-stream-index: "002" + title: Query Membership Levels Request + type: object + QueryMembershipLevelsResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "003.001" + membership_levels: + items: + $ref: '#/components/schemas/MembershipLevelResponse' + type: array + x-stream-index: "001" + next: + description: Cursor for next page + title: Next + type: string + x-stream-index: "002.001" + prev: + description: Cursor for previous page + title: Previous + type: string + x-stream-index: "002.002" + required: + - membership_levels + - duration + title: Query Membership Levels Response + type: object + QueryModerationConfigsRequest: + nullable: true + properties: + filter: + additionalProperties: {} + description: Filter conditions for moderation configs + title: Filter + type: object + x-stream-index: "001" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "003.001" + next: + type: string + x-stream-index: "003.002" + prev: + type: string + x-stream-index: "003.003" + sort: + description: Sorting parameters for the results + items: + $ref: '#/components/schemas/SortParamRequest' + title: Sort + type: array + x-stream-index: "002" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "004.002" + user_id: + type: string + x-stream-index: "004.001" + type: object + QueryModerationConfigsResponse: + nullable: true + properties: + configs: + description: List of moderation configurations + items: + $ref: '#/components/schemas/ConfigResponse' + title: Configs + type: array + x-stream-index: "001" + duration: + type: string + x-stream-index: "003.001" + next: + type: string + x-stream-index: "002.001" + prev: + type: string + x-stream-index: "002.002" + required: + - configs + - duration + type: object + QueryModerationFlagsRequest: + nullable: true + properties: + filter: + additionalProperties: {} + type: object + x-stream-index: "001" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "003.001" + next: + type: string + x-stream-index: "003.002" + prev: + type: string + x-stream-index: "003.003" + sort: + items: + $ref: '#/components/schemas/SortParam' + type: array + x-stream-index: "002" + type: object + QueryModerationFlagsResponse: + description: Basic response information + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "003.001" + flags: + items: + $ref: '#/components/schemas/ModerationFlagResponse' + type: array + x-stream-index: "001" + next: + type: string + x-stream-index: "002.001" + prev: + type: string + x-stream-index: "002.002" + required: + - flags + - duration + title: Response + type: object + QueryModerationLogsRequest: + nullable: true + properties: + filter: + additionalProperties: {} + description: Filter conditions for moderation logs + title: Filter + type: object + x-stream-index: "001" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "003.001" + next: + type: string + x-stream-index: "003.002" + prev: + type: string + x-stream-index: "003.003" + sort: + description: Sorting parameters for the results + items: + $ref: '#/components/schemas/SortParamRequest' + title: Sort + type: array + x-stream-index: "002" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "004.002" + user_id: + type: string + x-stream-index: "004.001" + type: object + QueryModerationLogsResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "003.001" + logs: + description: List of moderation action logs + items: + $ref: '#/components/schemas/ActionLogResponse' + title: Logs + type: array + x-stream-index: "001" + next: + type: string + x-stream-index: "002.001" + prev: + type: string + x-stream-index: "002.002" + required: + - logs + - duration + type: object + QueryModerationRulesRequest: + nullable: true + properties: + filter: + additionalProperties: {} + description: Filter conditions for moderation rules + title: Filter + type: object + x-stream-index: "001" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "003.001" + next: + type: string + x-stream-index: "003.002" + prev: + type: string + x-stream-index: "003.003" + sort: + description: Sorting parameters for the results + items: + $ref: '#/components/schemas/SortParamRequest' + title: Sort + type: array + x-stream-index: "002" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "004.002" + user_id: + type: string + x-stream-index: "004.001" + type: object + QueryModerationRulesResponse: + nullable: true + properties: + default_llm_labels: + additionalProperties: + type: string + description: Default LLM label descriptions + title: DefaultLLMLabels + type: object + x-stream-index: "002" + duration: + type: string + x-stream-index: "004.001" + next: + type: string + x-stream-index: "003.001" + prev: + type: string + x-stream-index: "003.002" + rules: + description: List of moderation rules + items: + $ref: '#/components/schemas/ModerationRuleV2Response' + title: Rules + type: array + x-stream-index: "001" + required: + - rules + - default_llm_labels + - duration + type: object + QueryPollVotesRequest: + nullable: true + properties: + filter: + additionalProperties: {} + description: Filter to apply to the query + title: Filter + type: object + x-stream-index: "003" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "005.001" + next: + type: string + x-stream-index: "005.002" + prev: + type: string + x-stream-index: "005.003" + sort: + description: Array of sort parameters + items: + $ref: '#/components/schemas/SortParamRequest' + maximum: 5 + title: Sort + type: array + x-stream-index: "004" + type: object + QueryPollsRequest: + nullable: true + properties: + filter: + additionalProperties: {} + description: Filter to apply to the query + title: Filter + type: object + x-stream-index: "002" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "005.001" + next: + type: string + x-stream-index: "005.002" + prev: + type: string + x-stream-index: "005.003" + sort: + description: Array of sort parameters + items: + $ref: '#/components/schemas/SortParamRequest' + maximum: 5 + title: Sort + type: array + x-stream-index: "003" + type: object + QueryPollsResponse: + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "003.001" + next: + type: string + x-stream-index: "002.001" + polls: + description: Polls data returned by the query + items: + $ref: '#/components/schemas/PollResponseData' + title: PollsResponseData + type: array + x-stream-index: "001" + prev: + type: string + x-stream-index: "002.002" + required: + - polls + - duration + type: object + QueryReviewQueueRequest: + nullable: true + properties: + filter: + additionalProperties: {} + description: Filter conditions for review queue items + title: Filter + type: object + x-stream-index: "001" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "007.001" + lock_count: + description: Number of items to lock (1-25) + format: int32 + maximum: 25 + minimum: 1 + title: Lock Count + type: integer + x-stream-index: "005" + lock_duration: + description: Duration for which items should be locked + title: Lock Duration + type: integer + x-stream-index: "004" + lock_items: + description: Whether to lock items for review (true), unlock items (false), + or just fetch (nil) + title: Lock Items + type: boolean + x-stream-index: "003" + next: + type: string + x-stream-index: "007.002" + prev: + type: string + x-stream-index: "007.003" + sort: + description: Sorting parameters for the results + items: + $ref: '#/components/schemas/SortParamRequest' + title: Sort + type: array + x-stream-index: "002" + stats_only: + description: Whether to return only statistics + title: Stats Only + type: boolean + x-stream-index: "006" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "008.002" + user_id: + type: string + x-stream-index: "008.001" + type: object + QueryReviewQueueResponse: + nullable: true + properties: + action_config: + additionalProperties: + items: + $ref: '#/components/schemas/ModerationActionConfig' + type: array + description: Configuration for moderation actions + title: Action Config + type: object + x-stream-index: "002" + duration: + type: string + x-stream-index: "005.001" + items: + description: List of review queue items + items: + $ref: '#/components/schemas/ReviewQueueItemResponse' + title: Items + type: array + x-stream-index: "001" + next: + type: string + x-stream-index: "004.001" + prev: + type: string + x-stream-index: "004.002" + stats: + additionalProperties: {} + description: Statistics about the review queue + title: Stats + type: object + x-stream-index: "003" + required: + - items + - action_config + - stats + - duration + type: object + QueryUsersPayload: + properties: + filter_conditions: + additionalProperties: {} + type: object + x-stream-index: "001" + include_deactivated_users: + type: boolean + x-stream-index: "004" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "005.003" + offset: + format: int32 + maximum: 1000 + type: integer + x-stream-index: "005.004" + presence: + type: boolean + x-stream-index: "003" + sort: + items: + $ref: '#/components/schemas/SortParamRequest' + maximum: 5 + type: array + x-stream-index: "002" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "006.002" + user_id: + type: string + x-stream-index: "006.001" + required: + - filter_conditions + type: object + QueryUsersResponse: + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "002.001" + users: + description: Array of users as result of filters applied. + items: + $ref: '#/components/schemas/FullUserResponse' + title: Users + type: array + x-stream-index: "001" + required: + - users + - duration + type: object + RTMPEgressConfig: + properties: + composite_app_settings: + $ref: '#/components/schemas/CompositeAppSettings' + x-stream-index: "005" + quality: + $ref: '#/components/schemas/Quality' + x-stream-index: "004" + rtmp_location: + type: string + x-stream-index: "006" + type: object + RTMPIngress: + description: RTMP input settings + properties: + address: + title: Address + type: string + x-stream-index: "001" + required: + - address + title: RTMPIngress + type: object + RTMPLocation: + properties: + name: + type: string + x-stream-index: "001" + stream_key: + type: string + x-stream-index: "003" + stream_url: + type: string + x-stream-index: "002" + required: + - name + - stream_url + - stream_key + type: object + RTMPSettings: + properties: + enabled: + type: boolean + x-stream-index: "001" + layout: + $ref: '#/components/schemas/LayoutSettings' + x-stream-index: "003" + location: + $ref: '#/components/schemas/RTMPLocation' + x-stream-index: "004" + quality_name: + type: string + x-stream-index: "002" + required: + - enabled + type: object + RTMPSettingsResponse: + description: RTMPSettingsResponse is the payload for RTMP settings + properties: + enabled: + title: Enabled + type: boolean + x-stream-index: "001" + layout: + $ref: '#/components/schemas/LayoutSettingsResponse' + title: Layout + x-stream-index: "003" + quality: + title: Quality + type: string + x-stream-index: "002" + required: + - enabled + - quality + - layout + title: RTMPSettingsResponse + type: object + RankingConfig: + properties: + defaults: + additionalProperties: {} + description: Default values for ranking + title: Defaults + type: object + x-stream-index: "003" + functions: + additionalProperties: + $ref: '#/components/schemas/DecayFunctionConfig' + description: Decay functions configuration + title: Functions + type: object + x-stream-index: "004" + score: + description: Scoring formula + title: Score + type: string + x-stream-index: "002" + type: + description: Type of ranking algorithm + title: Type + type: string + x-stream-index: "001" + title: Ranking Configuration + type: object + Reaction: + nullable: true + properties: + created_at: + format: date-time + readOnly: true + type: number + x-stream-index: "008" + custom: + additionalProperties: {} + type: object + x-stream-index: "010" + message_id: + type: string + x-stream-index: "003" + score: + format: int32 + type: integer + x-stream-index: "007" + type: + maxLength: 30 + type: string + x-stream-index: "006" + updated_at: + format: date-time + readOnly: true + type: number + x-stream-index: "009" + user: + $ref: '#/components/schemas/User' + x-stream-index: "005" + user_id: + type: string + x-stream-index: "004" + required: + - message_id + - type + - score + - created_at + - updated_at + - custom + type: object + ReactionGroupResponse: + description: ReactionGroupResponse contains all information about a reaction + of the same type. + nullable: true + properties: + count: + description: Count is the number of reactions of this type. + format: int32 + title: Count + type: integer + x-stream-index: "001" + first_reaction_at: + description: FirstReactionAt is the time of the first reaction of this type. + This is the same also if all reaction of this type are deleted, because + if someone will react again with the same type, will be preserved the + sorting. + format: date-time + title: FirstReactionAt + type: number + x-stream-index: "003" + last_reaction_at: + description: LastReactionAt is the time of the last reaction of this type. + format: date-time + title: LastReactionAt + type: number + x-stream-index: "004" + sum_scores: + description: 'SumScores is the sum of all scores of reactions of this type. + Medium allows you to clap articles more than once and shows the sum of + all claps from all users. For example, you can send `clap` x5 using `score: + 5`.' + format: int32 + title: SumScores + type: integer + x-stream-index: "002" + required: + - count + - sum_scores + - first_reaction_at + - last_reaction_at + title: ReactionGroupResponse + type: object + ReactionResponse: + properties: + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: "006" + custom: + additionalProperties: {} + description: Custom data for this object + title: Custom data + type: object + x-stream-index: "008" + message_id: + description: Message ID + title: Message ID + type: string + x-stream-index: "001" + score: + description: Score of the reaction + format: int32 + title: Score + type: integer + x-stream-index: "005" + type: + description: Type of reaction + title: Type + type: string + x-stream-index: "004" + updated_at: + description: Date/time of the last update + format: date-time + title: Updated at + type: number + x-stream-index: "007" + user: + $ref: '#/components/schemas/UserResponse' + description: User + title: UserResponse + x-stream-index: "003" + user_id: + description: User ID + title: User ID + type: string + x-stream-index: "002" + required: + - message_id + - user_id + - user + - type + - score + - created_at + - updated_at + - custom + type: object + ReactivateUserRequest: + nullable: true + properties: + created_by_id: + description: ID of the user who's reactivating the user + title: Created by ID + type: string + x-stream-index: "004" + name: + description: Set this field to put new name for the user + title: Name + type: string + x-stream-index: "003" + restore_messages: + description: Restore previously deleted messages + title: Restore messages + type: boolean + x-stream-index: "002" + type: object + ReactivateUserResponse: + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: 001.002.001 + user: + $ref: '#/components/schemas/UserResponse' + description: Deactivated user object + title: User + x-stream-index: "001.001" + required: + - duration + type: object + ReactivateUsersRequest: + description: Reactivate users in batches + nullable: true + properties: + created_by_id: + description: ID of the user who's reactivating the users + title: Created by ID + type: string + x-stream-index: "003" + restore_channels: + type: boolean + x-stream-index: "004" + restore_messages: + description: Restore previously deleted messages + title: Restore messages + type: boolean + x-stream-index: "002" + user_ids: + description: User IDs to reactivate + items: + type: string + maximum: 100 + minimum: 1 + title: User IDs + type: array + x-stream-index: "001" + required: + - user_ids + title: ReactivateUsersRequest + type: object + ReactivateUsersResponse: + description: Basic response information + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: 001.002.001 + task_id: + type: string + x-stream-index: "001.001" + required: + - task_id + - duration + title: Response + type: object + ReadReceipts: + properties: + enabled: + type: boolean + x-stream-index: "001" + required: + - enabled + type: object + ReadReceiptsResponse: + properties: + enabled: + type: boolean + x-stream-index: "001" + type: object + RecordSettings: + properties: + audio_only: + type: boolean + x-stream-index: "001" + layout: + $ref: '#/components/schemas/LayoutSettings' + x-stream-index: "004" + mode: + type: string + x-stream-index: "002" + quality: + type: string + x-stream-index: "003" + required: + - mode + type: object + RecordSettingsResponse: + description: RecordSettings is the payload for recording settings + properties: + audio_only: + title: Audio Only + type: boolean + x-stream-index: "001" + layout: + $ref: '#/components/schemas/LayoutSettingsResponse' + title: Layout + x-stream-index: "004" + mode: + title: Mode + type: string + x-stream-index: "002" + quality: + title: Quality + type: string + x-stream-index: "003" + required: + - audio_only + - mode + - quality + - layout + title: RecordSettingsResponse + type: object + RecordingEgressConfig: + properties: + audio_only: + type: boolean + x-stream-index: "006" + composite_app_settings: + $ref: '#/components/schemas/CompositeAppSettings' + x-stream-index: "005" + external_storage: + $ref: '#/components/schemas/ExternalStorage' + x-stream-index: "008" + quality: + $ref: '#/components/schemas/Quality' + x-stream-index: "004" + storage_name: + type: string + x-stream-index: "007" + video_orientation_hint: + $ref: '#/components/schemas/VideoOrientation' + x-stream-index: "009" + type: object + RejectFeedMemberInviteRequest: + nullable: true + properties: + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "003.002" + user_id: + type: string + x-stream-index: "003.001" + title: Reject Feed Member Request + type: object + RejectFeedMemberInviteResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + member: + $ref: '#/components/schemas/FeedMemberResponse' + description: The feed member after rejecting the invite + title: Feed Member + x-stream-index: "001" + required: + - member + - duration + title: Reject Feed Member Response + type: object + RejectFollowRequest: + nullable: true + properties: + source: + description: Fully qualified ID of the source feed + maxLength: 255 + title: Source Feed ID + type: string + x-stream-index: "001" + target: + description: Fully qualified ID of the target feed + maxLength: 255 + title: Target Feed ID + type: string + x-stream-index: "002" + required: + - source + - target + title: Reject Follow Request + type: object + RejectFollowResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + follow: + $ref: '#/components/schemas/FollowResponse' + description: The rejected follow relationship + title: Follow + x-stream-index: "001" + required: + - follow + - duration + title: Reject Follow Response + type: object + ReminderResponseData: + properties: + channel: + $ref: '#/components/schemas/ChannelResponse' + x-stream-index: "003" + channel_cid: + type: string + x-stream-index: "002" + created_at: + format: date-time + type: number + x-stream-index: "008" + message: + $ref: '#/components/schemas/Message' + x-stream-index: "005" + message_id: + type: string + x-stream-index: "004" + remind_at: + format: date-time + type: number + x-stream-index: "001" + updated_at: + format: date-time + type: number + x-stream-index: "009" + user: + $ref: '#/components/schemas/User' + x-stream-index: "007" + user_id: + type: string + x-stream-index: "006" + required: + - channel_cid + - message_id + - user_id + - created_at + - updated_at + type: object + RepliesMeta: + description: Cursor & depth information for a comment's direct replies. Mirrors + Reddit's 'load more replies' semantics. + properties: + depth_truncated: + description: True if the subtree was cut because the requested depth was + reached. + title: Depth Truncated + type: boolean + x-stream-index: "004" + has_more: + description: True if more siblings exist in the database. + title: Has More + type: boolean + x-stream-index: "001" + next_cursor: + description: Opaque cursor to request the next page of siblings. + title: Next Cursor + type: string + x-stream-index: "002" + remaining: + description: Number of unread siblings that match current filters. + format: int32 + title: Remaining + type: integer + x-stream-index: "003" + required: + - has_more + - remaining + - depth_truncated + title: Replies Meta + type: object + Response: + description: Basic response information + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "001" + required: + - duration + title: Response + type: object + RestoreActionRequest: + type: object + RestoreUsersRequest: + nullable: true + properties: + user_ids: + items: + type: string + maximum: 100 + minimum: 1 + type: array + x-stream-index: "001" + required: + - user_ids + type: object + ReviewQueueItem: + properties: + actions: + items: + $ref: '#/components/schemas/ActionLog' + type: array + x-stream-index: "035" + activity: + $ref: '#/components/schemas/EnrichedActivity' + x-stream-index: "028" + ai_text_severity: + type: string + x-stream-index: "021" + archived_at: + $ref: '#/components/schemas/NullTime' + x-stream-index: "043" + assigned_to: + $ref: '#/components/schemas/User' + x-stream-index: "032" + bans: + items: + $ref: '#/components/schemas/Ban' + type: array + x-stream-index: "033" + bounce_count: + format: int32 + type: integer + x-stream-index: "025" + call: + $ref: '#/components/schemas/Call' + x-stream-index: "031" + completed_at: + $ref: '#/components/schemas/NullTime' + x-stream-index: "018" + config_key: + type: string + x-stream-index: "009" + content_changed: + type: boolean + x-stream-index: "036" + created_at: + format: date-time + type: number + x-stream-index: "004" + entity_creator: + $ref: '#/components/schemas/EntityCreator' + x-stream-index: "030" + entity_id: + type: string + x-stream-index: "007" + entity_type: + type: string + x-stream-index: "006" + feeds_v2_activity: + $ref: '#/components/schemas/EnrichedActivity' + x-stream-index: "041" + feeds_v2_reaction: + $ref: '#/components/schemas/Reaction' + x-stream-index: "042" + flag_labels: + items: + type: string + type: array + x-stream-index: "045" + flag_types: + items: + type: string + type: array + x-stream-index: "044" + flags: + items: + $ref: '#/components/schemas/Flag' + type: array + x-stream-index: "034" + flags_count: + format: int32 + type: integer + x-stream-index: "026" + has_image: + type: boolean + x-stream-index: "012" + has_text: + type: boolean + x-stream-index: "014" + has_video: + type: boolean + x-stream-index: "013" + id: + type: string + x-stream-index: "003" + languages: + items: + type: string + type: array + x-stream-index: "019" + message: + $ref: '#/components/schemas/Message' + x-stream-index: "027" + moderation_payload: + $ref: '#/components/schemas/ModerationPayload' + x-stream-index: "010" + moderation_payload_hash: + type: string + x-stream-index: "011" + reaction: + $ref: '#/components/schemas/Reaction' + x-stream-index: "029" + recommended_action: + type: string + x-stream-index: "017" + reporter_ids: + items: + type: string + type: array + x-stream-index: "046" + reviewed_at: + $ref: '#/components/schemas/NullTime' + x-stream-index: "022" + reviewed_by: + type: string + x-stream-index: "023" + severity: + format: int32 + type: integer + x-stream-index: "020" + status: + type: string + x-stream-index: "016" + teams: + items: + type: string + type: array + x-stream-index: "015" + updated_at: + format: date-time + type: number + x-stream-index: "005" + required: + - id + - created_at + - updated_at + - entity_type + - entity_id + - config_key + - moderation_payload_hash + - has_image + - has_video + - has_text + - teams + - status + - recommended_action + - completed_at + - languages + - severity + - ai_text_severity + - reviewed_at + - reviewed_by + - bounce_count + - flags_count + - bans + - flags + - actions + - content_changed + - archived_at + - flag_types + - flag_labels + - reporter_ids + type: object + ReviewQueueItemNewEvent: + description: This event is sent when a new moderation review queue item is created + nullable: true + properties: + action: + $ref: '#/components/schemas/ActionLogResponse' + description: The action log if any action was taken + title: Action + x-stream-index: "004" + created_at: + format: date-time + type: number + x-stream-index: "001.003" + custom: + additionalProperties: {} + type: object + x-stream-index: "001.007" + flags: + description: The flags associated with this review queue item + items: + $ref: '#/components/schemas/ModerationFlagResponse' + title: Flags + type: array + x-stream-index: "003" + received_at: + format: date-time + type: number + x-stream-index: "001.004" + review_queue_item: + $ref: '#/components/schemas/ReviewQueueItemResponse' + description: The review queue item that was created + title: ReviewQueueItem + x-stream-index: "002" + type: + default: review_queue_item.new + type: string + x-stream-index: "001.002" + required: + - type + - created_at + - custom + title: ReviewQueueItemNewEvent + 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 + ReviewQueueItemResponse: + properties: + actions: + description: Moderation actions taken + items: + $ref: '#/components/schemas/ActionLogResponse' + title: Actions + type: array + x-stream-index: "024" + activity: + $ref: '#/components/schemas/EnrichedActivity' + x-stream-index: "016" + ai_text_severity: + description: AI-determined text severity + title: AI Text Severity + type: string + x-stream-index: "014" + assigned_to: + $ref: '#/components/schemas/UserResponse' + description: Moderator assigned to review this item + title: Assigned To + x-stream-index: "021" + bans: + description: Associated ban records + items: + $ref: '#/components/schemas/Ban' + title: Bans + type: array + x-stream-index: "022" + call: + $ref: '#/components/schemas/CallResponse' + x-stream-index: "018" + completed_at: + description: When the review was completed + format: date-time + title: Completed At + type: number + x-stream-index: "009" + config_key: + type: string + x-stream-index: "028" + created_at: + description: When the item was created + format: date-time + title: Created At + type: number + x-stream-index: "002" + entity_creator: + $ref: '#/components/schemas/EntityCreatorResponse' + description: Details about who created the entity + title: Entity Creator + x-stream-index: "019" + entity_creator_id: + description: ID of who created the entity + title: Entity Creator ID + type: string + x-stream-index: "020" + entity_id: + description: ID of the entity being reviewed + title: Entity ID + type: string + x-stream-index: "005" + entity_type: + description: Type of entity being reviewed + title: Entity Type + type: string + x-stream-index: "004" + feeds_v2_activity: + $ref: '#/components/schemas/EnrichedActivity' + description: Associated feed activity + title: Feeds V2 Activity + x-stream-index: "025" + feeds_v2_reaction: + $ref: '#/components/schemas/Reaction' + description: Associated feed reaction + title: Feeds V2 Reaction + x-stream-index: "026" + flags: + description: Associated flag records + items: + $ref: '#/components/schemas/ModerationFlagResponse' + title: Flags + type: array + x-stream-index: "023" + flags_count: + format: int32 + type: integer + x-stream-index: "029" + id: + description: Unique identifier of the review queue item + title: ID + type: string + x-stream-index: "001" + languages: + description: Detected languages in the content + items: + type: string + title: Languages + type: array + x-stream-index: "012" + message: + $ref: '#/components/schemas/MessageResponse' + description: Associated message details + title: Message + x-stream-index: "015" + moderation_payload: + $ref: '#/components/schemas/ModerationPayload' + description: Content being moderated + title: Moderation Payload + x-stream-index: "006" + reaction: + $ref: '#/components/schemas/Reaction' + x-stream-index: "017" + recommended_action: + description: Suggested moderation action + title: Recommended Action + type: string + x-stream-index: "008" + reviewed_at: + description: When the item was reviewed + format: date-time + title: Reviewed At + type: number + x-stream-index: "010" + reviewed_by: + description: ID of the moderator who reviewed the item + title: Reviewed By + type: string + x-stream-index: "011" + severity: + description: Severity level of the content + format: int32 + title: Severity + type: integer + x-stream-index: "013" + status: + description: Current status of the review + title: Status + type: string + x-stream-index: "007" + teams: + description: Teams associated with this item + items: + type: string + title: Teams + type: array + x-stream-index: "027" + updated_at: + description: When the item was last updated + format: date-time + title: Updated At + type: number + x-stream-index: "003" + required: + - id + - created_at + - updated_at + - entity_type + - entity_id + - status + - recommended_action + - reviewed_by + - languages + - severity + - ai_text_severity + - bans + - flags + - actions + - flags_count + type: object + ReviewQueueItemUpdatedEvent: + description: This event is sent when a moderation review queue item is updated + nullable: true + properties: + action: + $ref: '#/components/schemas/ActionLogResponse' + description: The action log if any action was taken + title: Action + x-stream-index: "004" + created_at: + format: date-time + type: number + x-stream-index: "001.003" + custom: + additionalProperties: {} + type: object + x-stream-index: "001.007" + flags: + description: The flags associated with this review queue item + items: + $ref: '#/components/schemas/ModerationFlagResponse' + title: Flags + type: array + x-stream-index: "003" + received_at: + format: date-time + type: number + x-stream-index: "001.004" + review_queue_item: + $ref: '#/components/schemas/ReviewQueueItemResponse' + description: The review queue item that was updated + title: ReviewQueueItem + x-stream-index: "002" + type: + default: review_queue_item.updated + type: string + x-stream-index: "001.002" + required: + - type + - created_at + - custom + title: ReviewQueueItemUpdatedEvent + 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 + RingSettings: + properties: + auto_cancel_timeout_ms: + format: int32 + type: integer + x-stream-index: "002" + incoming_call_timeout_ms: + format: int32 + type: integer + x-stream-index: "001" + missed_call_timeout_ms: + format: int32 + type: integer + x-stream-index: "003" + required: + - incoming_call_timeout_ms + - auto_cancel_timeout_ms + - missed_call_timeout_ms + type: object + RingSettingsResponse: + properties: + auto_cancel_timeout_ms: + format: int32 + type: integer + x-stream-index: "002" + incoming_call_timeout_ms: + format: int32 + type: integer + x-stream-index: "001" + missed_call_timeout_ms: + format: int32 + type: integer + x-stream-index: "003" + required: + - incoming_call_timeout_ms + - auto_cancel_timeout_ms + - missed_call_timeout_ms + type: object + Role: + properties: + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: "004" + custom: + description: Whether this is a custom role or built-in + title: Custom + type: boolean + x-stream-index: "002" + name: + description: Unique role name + title: Name + type: string + x-stream-index: "001" + scopes: + description: List of scopes where this role is currently present. `.app` + means that role is present in app-level grants + items: + type: string + title: Scopes + type: array + x-stream-index: "003" + updated_at: + description: Date/time of the last update + format: date-time + title: Updated at + type: number + x-stream-index: "005" + required: + - name + - custom + - scopes + - created_at + - updated_at + type: object + RuleBuilderAction: + properties: + ban_options: + $ref: '#/components/schemas/BanOptions' + x-stream-index: "002" + flag_content_options: + $ref: '#/components/schemas/FlagContentOptions' + x-stream-index: "004" + flag_user_options: + $ref: '#/components/schemas/FlagUserOptions' + x-stream-index: "003" + remove_content_options: + $ref: '#/components/schemas/BlockContentOptions' + x-stream-index: "005" + type: + type: string + x-stream-index: "001" + type: object + RuleBuilderCondition: + properties: + confidence: + format: float + type: number + x-stream-index: "002" + content_count_rule_params: + $ref: '#/components/schemas/ContentCountRuleParameters' + x-stream-index: "007" + image_content_params: + $ref: '#/components/schemas/ImageContentParameters' + x-stream-index: "009" + image_rule_params: + $ref: '#/components/schemas/ImageRuleParameters' + x-stream-index: "004" + text_content_params: + $ref: '#/components/schemas/TextContentParameters' + x-stream-index: "008" + text_rule_params: + $ref: '#/components/schemas/TextRuleParameters' + x-stream-index: "003" + type: + type: string + x-stream-index: "001" + user_created_within_params: + $ref: '#/components/schemas/UserCreatedWithinParameters' + x-stream-index: "011" + user_custom_property_params: + $ref: '#/components/schemas/UserCustomPropertyParameters' + x-stream-index: "012" + user_rule_params: + $ref: '#/components/schemas/UserRuleParameters' + x-stream-index: "006" + video_content_params: + $ref: '#/components/schemas/VideoContentParameters' + x-stream-index: "010" + video_rule_params: + $ref: '#/components/schemas/VideoRuleParameters' + x-stream-index: "005" + type: object + RuleBuilderConditionGroup: + properties: + conditions: + items: + $ref: '#/components/schemas/RuleBuilderCondition' + type: array + x-stream-index: "002" + logic: + type: string + x-stream-index: "001" + type: object + RuleBuilderConfig: + properties: + async: + type: boolean + x-stream-index: "001" + rules: + items: + $ref: '#/components/schemas/RuleBuilderRule' + type: array + x-stream-index: "002" + type: object + RuleBuilderRule: + properties: + action: + $ref: '#/components/schemas/RuleBuilderAction' + x-stream-index: "006" + conditions: + items: + $ref: '#/components/schemas/RuleBuilderCondition' + type: array + x-stream-index: "003" + cooldown_period: + type: string + x-stream-index: "007" + groups: + items: + $ref: '#/components/schemas/RuleBuilderConditionGroup' + type: array + x-stream-index: "005" + id: + type: string + x-stream-index: "001" + logic: + type: string + x-stream-index: "004" + rule_type: + type: string + x-stream-index: "002" + required: + - rule_type + - action + type: object + S3Request: + description: Config for creating Amazon S3 storage. + properties: + s3_api_key: + description: 'The AWS API key. To use Amazon S3 as your storage provider, + you have two authentication options: IAM role or API key. If you do not + specify the `s3_api_key` parameter, Stream will use IAM role authentication. + In that case make sure to have the correct IAM role configured for your + application.' + title: S3ApiKey + type: string + x-stream-index: "002" + s3_custom_endpoint_url: + description: The custom endpoint for S3. If you want to use a custom endpoint, + you must also provide the `s3_api_key` and `s3_secret` parameters. + title: S3CustomEndpointURL + type: string + x-stream-index: "004" + s3_region: + description: The AWS region where the bucket is hosted + title: S3Region + type: string + x-stream-index: "001" + s3_secret: + description: The AWS API Secret + title: S3Secret + type: string + x-stream-index: "003" + required: + - s3_region + title: S3Request + type: object + SFUIDLastSeen: + properties: + id: + type: string + x-stream-index: "001.001" + last_seen: + format: date-time + type: number + x-stream-index: "002" + process_start_time: + format: int64 + type: integer + x-stream-index: "001.002" + required: + - id + - process_start_time + - last_seen + type: object + STTEgressConfig: + properties: + closed_captions_enabled: + type: boolean + x-stream-index: "005" + external_storage: + $ref: '#/components/schemas/ExternalStorage' + x-stream-index: "011" + language: + type: string + x-stream-index: "008" + storage_name: + type: string + x-stream-index: "010" + translation_languages: + items: + type: string + type: array + x-stream-index: "009" + translations_enabled: + type: boolean + x-stream-index: "006" + upload_transcriptions: + type: boolean + x-stream-index: "004" + whisper_server_base_url: + type: string + x-stream-index: "007" + type: object + ScreensharingSettings: + properties: + access_request_enabled: + type: boolean + x-stream-index: "002" + enabled: + type: boolean + x-stream-index: "001" + target_resolution: + $ref: '#/components/schemas/TargetResolution' + x-stream-index: "003" + required: + - enabled + - access_request_enabled + type: object + ScreensharingSettingsResponse: + properties: + access_request_enabled: + type: boolean + x-stream-index: "002" + enabled: + type: boolean + x-stream-index: "001" + target_resolution: + $ref: '#/components/schemas/TargetResolution' + x-stream-index: "003" + required: + - enabled + - access_request_enabled + type: object + SessionSettings: + properties: + inactivity_timeout_seconds: + format: int32 + maximum: 900 + minimum: 5 + type: integer + x-stream-index: "001" + required: + - inactivity_timeout_seconds + type: object + SessionSettingsResponse: + properties: + inactivity_timeout_seconds: + format: int32 + maximum: 900 + minimum: 5 + type: integer + x-stream-index: "001" + required: + - inactivity_timeout_seconds + type: object + ShadowBlockActionRequest: + type: object + SharedLocation: + properties: + channel: + $ref: '#/components/schemas/Channel' + x-stream-index: "013" + channel_cid: + type: string + x-stream-index: "003" + created_at: + format: date-time + type: number + x-stream-index: "010" + created_by_device_id: + type: string + x-stream-index: "008" + end_at: + format: date-time + type: number + x-stream-index: "009" + latitude: + format: float + maximum: 90 + minimum: 1.8446744073709552e+19 + type: number + x-stream-index: "006" + longitude: + format: float + maximum: 180 + minimum: 1.8446744073709552e+19 + type: number + x-stream-index: "007" + message: + $ref: '#/components/schemas/Message' + x-stream-index: "012" + message_id: + type: string + x-stream-index: "004" + updated_at: + format: date-time + type: number + x-stream-index: "011" + user_id: + type: string + x-stream-index: "005" + required: + - channel_cid + - message_id + - user_id + - created_by_device_id + - created_at + - updated_at + type: object + SharedLocationResponse: + nullable: true + properties: + channel: + $ref: '#/components/schemas/ChannelResponse' + x-stream-index: "001.011" + channel_cid: + description: Channel CID + title: string + type: string + x-stream-index: "001.001" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: "001.008" + created_by_device_id: + description: Device ID that created the live location + title: string + type: string + x-stream-index: "001.006" + duration: + type: string + x-stream-index: "002.001" + end_at: + description: Time when the live location expires + format: date-time + title: string + type: number + x-stream-index: "001.007" + latitude: + description: Latitude coordinate + format: float + title: number + type: number + x-stream-index: "001.004" + longitude: + description: Longitude coordinate + format: float + title: number + type: number + x-stream-index: "001.005" + message: + $ref: '#/components/schemas/MessageResponse' + x-stream-index: "001.010" + message_id: + description: Message ID + title: string + type: string + x-stream-index: "001.002" + updated_at: + description: Date/time of the last update + format: date-time + title: Updated at + type: number + x-stream-index: "001.009" + user_id: + description: User ID + title: string + type: string + x-stream-index: "001.003" + required: + - channel_cid + - message_id + - user_id + - latitude + - longitude + - created_by_device_id + - created_at + - updated_at + - duration + type: object + SharedLocationResponseData: + properties: + channel: + $ref: '#/components/schemas/ChannelResponse' + x-stream-index: "011" + channel_cid: + type: string + x-stream-index: "001" + created_at: + format: date-time + type: number + x-stream-index: "008" + created_by_device_id: + type: string + x-stream-index: "006" + end_at: + format: date-time + type: number + x-stream-index: "007" + latitude: + format: float + type: number + x-stream-index: "004" + longitude: + format: float + type: number + x-stream-index: "005" + message: + $ref: '#/components/schemas/MessageResponse' + x-stream-index: "010" + message_id: + type: string + x-stream-index: "002" + updated_at: + format: date-time + type: number + x-stream-index: "009" + user_id: + type: string + x-stream-index: "003" + required: + - channel_cid + - message_id + - user_id + - latitude + - longitude + - created_by_device_id + - created_at + - updated_at + type: object + SharedLocationsResponse: + nullable: true + properties: + active_live_locations: + items: + $ref: '#/components/schemas/SharedLocationResponseData' + type: array + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - active_live_locations + - duration + type: object + SingleFollowResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + follow: + $ref: '#/components/schemas/FollowResponse' + description: The created follow relationship + title: Follow + x-stream-index: "001" + required: + - follow + - duration + title: Follow Response + type: object + SortParam: + nullable: true + properties: + direction: + format: int32 + type: integer + x-stream-index: "002" + field: + type: string + x-stream-index: "001" + type: object + SortParamRequest: + nullable: true + properties: + direction: + description: Direction of sorting, 1 for Ascending, -1 for Descending, default + is 1 + format: int32 + title: Direction + type: integer + x-stream-index: "002" + field: + description: Name of field to sort by + title: Field + type: string + x-stream-index: "001" + type: object + StoriesConfig: + properties: + expiration_behaviour: + description: Behavior when stories expire + title: Expiration Behavior + type: string + x-stream-index: "001" + skip_watched: + description: Whether to skip already watched stories + title: Skip Watched + type: boolean + x-stream-index: "002" + title: Stories Configuration + type: object + SubmitActionRequest: + nullable: true + properties: + action_type: + description: Type of moderation action to perform (mark_reviewed, delete_message, + etc.) + enum: + - mark_reviewed + - delete_message + - delete_activity + - delete_reaction + - ban + - custom + - unban + - restore + - delete_user + - unblock + - shadow_block + - unmask + - kick_user + - end_call + title: Action Type + type: string + x-stream-index: "002" + ban: + $ref: '#/components/schemas/BanActionRequest' + description: Configuration for ban action + title: Ban + x-stream-index: "008" + custom: + $ref: '#/components/schemas/CustomActionRequest' + description: Configuration for custom action + title: Custom + x-stream-index: "009" + delete_activity: + $ref: '#/components/schemas/DeleteActivityRequest' + description: Configuration for activity deletion action + title: Delete Activity + x-stream-index: "004" + delete_message: + $ref: '#/components/schemas/DeleteMessageRequest' + description: Configuration for message deletion action + title: Delete Message + x-stream-index: "003" + delete_reaction: + $ref: '#/components/schemas/DeleteReactionRequest' + description: Configuration for reaction deletion action + title: Delete Reaction + x-stream-index: "005" + delete_user: + $ref: '#/components/schemas/DeleteUserRequest' + description: Configuration for user deletion action + title: Delete User + x-stream-index: "006" + item_id: + description: UUID of the review queue item to act on + title: Item ID + type: string + x-stream-index: "001" + mark_reviewed: + $ref: '#/components/schemas/MarkReviewedRequest' + description: Configuration for marking item as reviewed + title: Mark Reviewed + x-stream-index: "007" + unban: + $ref: '#/components/schemas/UnbanActionRequest' + description: Configuration for unban action + title: Unban + x-stream-index: "010" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "016.002" + user_id: + type: string + x-stream-index: "016.001" + required: + - item_id + - action_type + type: object + SubmitActionResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + item: + $ref: '#/components/schemas/ReviewQueueItemResponse' + description: Updated review queue item after action was performed + title: Item + x-stream-index: "001" + required: + - duration + type: object + TargetResolution: + properties: + bitrate: + format: int32 + maximum: 6000000 + type: integer + x-stream-index: "003" + height: + format: int32 + maximum: 3840 + minimum: 240 + type: integer + x-stream-index: "002" + width: + format: int32 + maximum: 3840 + minimum: 240 + type: integer + x-stream-index: "001" + required: + - width + - height + - bitrate + type: object + TextContentParameters: + properties: + blocklist_match: + items: + type: string + type: array + x-stream-index: "005" + contains_url: + type: boolean + x-stream-index: "003" + harm_labels: + items: + type: string + type: array + x-stream-index: "001" + llm_harm_labels: + additionalProperties: + type: string + type: object + x-stream-index: "002" + severity: + type: string + x-stream-index: "004" + type: object + TextRuleParameters: + properties: + blocklist_match: + items: + type: string + type: array + x-stream-index: "007" + contains_url: + type: boolean + x-stream-index: "005" + harm_labels: + items: + type: string + type: array + x-stream-index: "003" + llm_harm_labels: + additionalProperties: + type: string + type: object + x-stream-index: "004" + severity: + type: string + x-stream-index: "006" + threshold: + format: int32 + type: integer + x-stream-index: "001" + time_window: + type: string + x-stream-index: "002" + type: object + ThreadedCommentResponse: + description: A comment with an optional, depth‑limited slice of nested replies. + properties: + attachments: + items: + $ref: '#/components/schemas/Attachment' + type: array + x-stream-index: "001.011" + confidence_score: + format: float + type: number + x-stream-index: "001.022" + controversy_score: + format: float + type: number + x-stream-index: "001.023" + created_at: + format: date-time + type: number + x-stream-index: "001.014" + custom: + additionalProperties: {} + type: object + x-stream-index: "001.006" + deleted_at: + format: date-time + type: number + x-stream-index: "001.016" + downvote_count: + format: int32 + type: integer + x-stream-index: "001.020" + id: + type: string + x-stream-index: "001.001" + latest_reactions: + items: + $ref: '#/components/schemas/FeedsReactionResponse' + type: array + x-stream-index: "001.009" + mentioned_users: + items: + $ref: '#/components/schemas/UserResponse' + type: array + x-stream-index: "001.012" + meta: + $ref: '#/components/schemas/RepliesMeta' + description: Pagination & depth info for this node's direct replies. + title: Replies Meta + x-stream-index: "002" + moderation: + $ref: '#/components/schemas/ModerationV2Response' + x-stream-index: "001.017" + object_id: + type: string + x-stream-index: "001.002" + object_type: + type: string + x-stream-index: "001.003" + own_reactions: + items: + $ref: '#/components/schemas/FeedsReactionResponse' + type: array + x-stream-index: "001.024" + parent_id: + type: string + x-stream-index: "001.007" + reaction_count: + format: int32 + type: integer + x-stream-index: "001.008" + reaction_groups: + additionalProperties: + $ref: '#/components/schemas/ReactionGroupResponse' + type: object + x-stream-index: "001.010" + replies: + description: Slice of nested comments (may be empty). + items: + $ref: '#/components/schemas/ThreadedCommentResponse' + title: Replies + type: array + x-stream-index: "003" + reply_count: + format: int32 + type: integer + x-stream-index: "001.018" + score: + format: int32 + type: integer + x-stream-index: "001.021" + status: + type: string + x-stream-index: "001.013" + text: + type: string + x-stream-index: "001.005" + updated_at: + format: date-time + type: number + x-stream-index: "001.015" + upvote_count: + format: int32 + type: integer + x-stream-index: "001.019" + user: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "001.004" + required: + - id + - object_id + - object_type + - user + - reaction_count + - mentioned_users + - status + - created_at + - updated_at + - reply_count + - upvote_count + - downvote_count + - score + - confidence_score + - own_reactions + title: Threaded Comment + type: object + Thresholds: + description: Sets thresholds for AI moderation + properties: + explicit: + $ref: '#/components/schemas/LabelThresholds' + description: Thresholds for explicit messages + title: LabelThresholds + x-stream-index: "001" + spam: + $ref: '#/components/schemas/LabelThresholds' + description: Thresholds for spam + title: LabelThresholds + x-stream-index: "002" + toxic: + $ref: '#/components/schemas/LabelThresholds' + description: Thresholds for toxic messages + title: LabelThresholds + x-stream-index: "003" + title: Auto moderation thresholds + type: object + ThumbnailResponse: + properties: + image_url: + type: string + x-stream-index: "001" + required: + - image_url + type: object + ThumbnailsSettings: + properties: + enabled: + type: boolean + x-stream-index: "001" + required: + - enabled + type: object + ThumbnailsSettingsResponse: + properties: + enabled: + type: boolean + x-stream-index: "001" + required: + - enabled + type: object + Time: + type: object + TranscriptionSettings: + properties: + closed_caption_mode: + enum: + - available + - disabled + - auto-on + title: Mode + type: string + x-stream-index: "002" + language: + description: The language used in this call as a two letter code + enum: + - auto + - en + - fr + - es + - de + - it + - nl + - pt + - pl + - ca + - cs + - da + - el + - fi + - id + - ja + - ru + - sv + - ta + - th + - tr + - hu + - ro + - zh + - ar + - tl + - he + - hi + - hr + - ko + - ms + - "no" + - uk + - bg + - et + - sl + - sk + title: Language + type: string + x-stream-index: "004" + mode: + enum: + - available + - disabled + - auto-on + title: Mode + type: string + x-stream-index: "001" + required: + - mode + - closed_caption_mode + - languages + - language + type: object + TranscriptionSettingsResponse: + properties: + closed_caption_mode: + enum: + - available + - disabled + - auto-on + type: string + x-stream-index: "002" + language: + enum: + - auto + - en + - fr + - es + - de + - it + - nl + - pt + - pl + - ca + - cs + - da + - el + - fi + - id + - ja + - ru + - sv + - ta + - th + - tr + - hu + - ro + - zh + - ar + - tl + - he + - hi + - hr + - ko + - ms + - "no" + - uk + - bg + - et + - sl + - sk + type: string + x-stream-index: "004" + mode: + enum: + - available + - disabled + - auto-on + type: string + x-stream-index: "001" + required: + - mode + - closed_caption_mode + - languages + - language + type: object + TypingIndicators: + properties: + enabled: + type: boolean + x-stream-index: "001" + required: + - enabled + type: object + TypingIndicatorsResponse: + properties: + enabled: + type: boolean + x-stream-index: "001" + type: object + UnbanActionRequest: + type: object + UnbanRequest: + nullable: true + properties: + unbanned_by: + $ref: '#/components/schemas/UserRequest' + description: Details about the user performing the unban + title: Unbanned By + x-stream-index: "005" + unbanned_by_id: + description: ID of the user performing the unban + title: Unbanned By ID + type: string + x-stream-index: "004" + type: object + UnbanResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "001.001" + required: + - duration + type: object + UnblockActionRequest: + type: object + UnblockUsersRequest: + nullable: true + properties: + blocked_user_id: + type: string + x-stream-index: "001" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "003.002" + user_id: + type: string + x-stream-index: "003.001" + required: + - blocked_user_id + type: object + UnblockUsersResponse: + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "001.001" + required: + - duration + type: object + UnfollowBatchRequest: + nullable: true + properties: + follows: + description: List of follow relationships to remove + items: + $ref: '#/components/schemas/FollowPair' + maximum: 100 + minimum: 1 + title: Follows + type: array + x-stream-index: "001" + required: + - follows + title: Unfollow Batch Request + type: object + UnfollowBatchResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + follows: + description: List of follow relationships that were removed + items: + $ref: '#/components/schemas/FollowResponse' + title: Follows + type: array + x-stream-index: "001" + required: + - follows + - duration + title: Unfollow Batch Response + type: object + UnfollowResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + follow: + $ref: '#/components/schemas/FollowResponse' + description: The deleted follow relationship + title: Follow + x-stream-index: "001" + required: + - follow + - duration + title: Unfollow Response + type: object + UnmuteRequest: + nullable: true + properties: + target_ids: + description: User IDs to unmute + items: + type: string + title: Target IDs + type: array + x-stream-index: "001" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "002.002" + user_id: + type: string + x-stream-index: "002.001" + required: + - target_ids + title: UnmuteRequest + type: object + UnmuteResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + non_existing_users: + description: A list of users that can't be found. Common cause for this + is deleted users + items: + type: string + title: Non Existing Users + type: array + x-stream-index: "001" + required: + - duration + title: UnmuteResponse + type: object + UnpinActivityResponse: + nullable: true + properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + description: The unpinned activity + title: Activity + x-stream-index: "001" + duration: + type: string + x-stream-index: "004.001" + feed: + description: Fully qualified ID of the feed the activity was unpinned from + title: Feed ID + type: string + x-stream-index: "002" + user_id: + description: ID of the user who unpinned the activity + title: User ID + type: string + x-stream-index: "003" + required: + - activity + - feed + - user_id + - duration + title: Unpin Activity Response + type: object + UpdateActivityPartialRequest: + nullable: true + properties: + set: + additionalProperties: {} + description: Map of dot-notation field paths to new values + title: object + type: object + x-stream-index: "002" + unset: + description: List of dot-notation paths to remove + items: + type: string + title: '[]string' + type: array + x-stream-index: "003" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "005.002" + user_id: + type: string + x-stream-index: "005.001" + type: object + UpdateActivityPartialResponse: + nullable: true + properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + description: The updated activity + title: ActivityResponse + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - activity + - duration + type: object + UpdateActivityRequest: + nullable: true + properties: + attachments: + description: List of attachments for the activity + items: + $ref: '#/components/schemas/Attachment' + title: '[]ActivityAttachment' + type: array + x-stream-index: "003" + custom: + additionalProperties: {} + description: Custom data for the activity + title: object + type: object + x-stream-index: "004" + expires_at: + description: Time when the activity will expire + format: date-time + title: string + type: number + x-stream-index: "007" + filter_tags: + description: Tags used for filtering the activity + items: + type: string + title: '[]string' + type: array + x-stream-index: "008" + interest_tags: + description: Tags indicating interest categories + items: + type: string + title: '[]string' + type: array + x-stream-index: "009" + location: + $ref: '#/components/schemas/ActivityLocation' + description: Geographic location for the activity + title: ActivityLocation + x-stream-index: "006" + poll_id: + description: Poll ID + title: string + type: string + x-stream-index: "010" + text: + description: The text content of the activity + title: string + type: string + x-stream-index: "002" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "012.002" + user_id: + type: string + x-stream-index: "012.001" + visibility: + description: Visibility setting for the activity + title: string + type: string + x-stream-index: "005" + type: object + UpdateActivityResponse: + nullable: true + properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + description: The updated activity + title: ActivityResponse + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - activity + - duration + type: object + UpdateAppRequest: + nullable: true + properties: + allowed_flag_reasons: + items: + type: string + type: array + x-stream-index: "001.017" + apn_config: + $ref: '#/components/schemas/APNConfig' + x-stream-index: "001.003" + async_moderation_config: + $ref: '#/components/schemas/AsyncModerationConfiguration' + x-stream-index: "001.039" + async_url_enrich_enabled: + type: boolean + x-stream-index: "001.019" + auto_translation_enabled: + type: boolean + x-stream-index: "001.018" + before_message_send_hook_url: + type: string + x-stream-index: "001.020" + cdn_expiration_seconds: + format: int32 + maximum: 1209600 + minimum: 14400 + type: integer + x-stream-index: "001.038" + channel_hide_members_only: + type: boolean + x-stream-index: "001.033" + custom_action_handler_url: + type: string + x-stream-index: "001.021" + datadog_info: + $ref: '#/components/schemas/DataDogInfo' + x-stream-index: "001.040" + disable_auth_checks: + type: boolean + x-stream-index: "001.001" + disable_permissions_checks: + type: boolean + x-stream-index: "001.002" + enforce_unique_usernames: + enum: + - "no" + - app + - team + type: string + x-stream-index: "001.022" + event_hooks: + items: + $ref: '#/components/schemas/EventHook' + type: array + x-stream-index: "001.046" + feeds_moderation_enabled: + type: boolean + x-stream-index: "001.042" + feeds_v2_region: + type: string + x-stream-index: "001.041" + file_upload_config: + $ref: '#/components/schemas/FileUploadConfig' + x-stream-index: "001.030" + firebase_config: + $ref: '#/components/schemas/FirebaseConfig' + x-stream-index: "001.004" + grants: + additionalProperties: + items: + type: string + type: array + type: object + x-stream-index: "001.034" + guest_user_creation_disabled: + type: boolean + x-stream-index: "001.043" + huawei_config: + $ref: '#/components/schemas/HuaweiConfig' + x-stream-index: "001.005" + image_moderation_block_labels: + items: + type: string + type: array + x-stream-index: "001.015" + image_moderation_enabled: + type: boolean + x-stream-index: "001.016" + image_moderation_labels: + items: + type: string + type: array + x-stream-index: "001.014" + image_upload_config: + $ref: '#/components/schemas/FileUploadConfig' + x-stream-index: "001.029" + max_aggregated_activities_length: + format: int32 + type: integer + x-stream-index: "001.049" + migrate_permissions_to_v2: + type: boolean + x-stream-index: "001.035" + moderation_dashboard_preferences: + $ref: '#/components/schemas/ModerationDashboardPreferences' + x-stream-index: "001.044" + moderation_enabled: + type: boolean + x-stream-index: "001.009" + moderation_webhook_url: + type: string + x-stream-index: "001.010" + multi_tenant_enabled: + type: boolean + x-stream-index: "001.013" + permission_version: + enum: + - v1 + - v2 + type: string + x-stream-index: "001.011" + push_config: + $ref: '#/components/schemas/PushConfig' + x-stream-index: "001.007" + reminders_interval: + format: int32 + maximum: 86400 + minimum: 60 + type: integer + x-stream-index: "001.036" + reminders_max_members: + format: int32 + minimum: 2 + type: integer + x-stream-index: "001.037" + revoke_tokens_issued_before: + format: date-time + type: number + x-stream-index: "001.031" + sns_key: + type: string + x-stream-index: "001.027" + sns_secret: + type: string + x-stream-index: "001.028" + sns_topic_arn: + type: string + x-stream-index: "001.026" + sqs_key: + type: string + x-stream-index: "001.024" + sqs_secret: + type: string + x-stream-index: "001.025" + sqs_url: + type: string + x-stream-index: "001.023" + user_response_time_enabled: + type: boolean + x-stream-index: "001.048" + user_search_disallowed_roles: + items: + type: string + type: array + x-stream-index: "001.012" + webhook_events: + items: + type: string + type: array + x-stream-index: "001.032" + webhook_url: + type: string + x-stream-index: "001.008" + xiaomi_config: + $ref: '#/components/schemas/XiaomiConfig' + x-stream-index: "001.006" + type: object + UpdateBlockListRequest: + nullable: true + properties: + team: + type: string + x-stream-index: "002" + words: + description: List of words to block + items: + type: string + minimum: 1 + title: Words + type: array + x-stream-index: "003" + title: Update block list + type: object + x-stream-docs-page-id: update_block_list + UpdateBlockListResponse: + description: Basic response information + nullable: true + properties: + blocklist: + $ref: '#/components/schemas/BlockListResponse' + x-stream-index: "001" + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "002.001" + required: + - duration + title: Response + type: object + UpdateBookmarkFolderRequest: + nullable: true + properties: + custom: + additionalProperties: {} + description: Custom data for the folder + title: Custom Data + type: object + x-stream-index: "003" + name: + description: Name of the folder + maxLength: 255 + title: Name + type: string + x-stream-index: "002" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "004.002" + user_id: + type: string + x-stream-index: "004.001" + title: Update Bookmark Folder Request + type: object + UpdateBookmarkFolderResponse: + nullable: true + properties: + bookmark_folder: + $ref: '#/components/schemas/BookmarkFolderResponse' + description: The updated bookmark folder + title: Bookmark Folder + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - bookmark_folder + - duration + title: Update Bookmark Folder Response + type: object + UpdateBookmarkRequest: + nullable: true + properties: + custom: + additionalProperties: {} + description: Custom data for the bookmark + title: Custom Data + type: object + x-stream-index: "005" + folder_id: + description: ID of the folder to move the bookmark to + maxLength: 255 + title: Folder ID + type: string + x-stream-index: "002" + new_folder: + $ref: '#/components/schemas/AddFolderRequest' + x-stream-index: "004" + new_folder_id: + maxLength: 255 + type: string + x-stream-index: "003" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "006.002" + user_id: + type: string + x-stream-index: "006.001" + title: Update Bookmark Request + type: object + UpdateBookmarkResponse: + nullable: true + properties: + bookmark: + $ref: '#/components/schemas/BookmarkResponse' + description: The updated bookmark + title: Bookmark + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - bookmark + - duration + title: Update Bookmark Response + type: object + UpdateCommentRequest: + nullable: true + properties: + comment: + description: Updated text content of the comment + title: Comment + type: string + x-stream-index: "002" + custom: + additionalProperties: {} + description: Updated custom data for the comment + title: Custom Data + type: object + x-stream-index: "003" + skip_push: + type: boolean + x-stream-index: "004" + title: Update Comment Request + type: object + UpdateCommentResponse: + nullable: true + properties: + comment: + $ref: '#/components/schemas/CommentResponse' + description: The updated comment + title: Comment + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - comment + - duration + title: Update Comment Response + type: object + UpdateExternalStorageRequest: + description: External storage + nullable: true + properties: + aws_s3: + $ref: '#/components/schemas/S3Request' + description: Only required if you want to create an Amazon S3 storage + title: AwsS3 + x-stream-index: "003.004" + azure_blob: + $ref: '#/components/schemas/AzureRequest' + description: Only required if you want to create an Azure Blob Storage + title: AzureBlob + x-stream-index: "003.006" + bucket: + description: The name of the bucket on the service provider + title: Bucket + type: string + x-stream-index: "003.002" + gcs_credentials: + type: string + x-stream-index: "003.005" + path: + description: The path prefix to use for storing files + title: Path + type: string + x-stream-index: "003.003" + storage_type: + description: The type of storage to use + enum: + - s3 + - gcs + - abs + title: StorageType + type: string + x-stream-index: "003.001" + required: + - storage_type + - bucket + title: ExternalStorageRequest + type: object + UpdateExternalStorageResponse: + description: Basic response information + nullable: true + properties: + bucket: + type: string + x-stream-index: "001.003" + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "002.001" + name: + type: string + x-stream-index: "001.001" + path: + type: string + x-stream-index: "001.004" + type: + enum: + - s3 + - gcs + - abs + type: string + x-stream-index: "001.002" + required: + - name + - type + - bucket + - path + - duration + title: Response + type: object + UpdateFeedGroupRequest: + nullable: true + properties: + activity_processors: + description: Configuration for activity processors (max 10) + items: + $ref: '#/components/schemas/ActivityProcessorConfig' + maximum: 10 + title: Activity Processors + type: array + x-stream-index: "005" + activity_selectors: + description: Configuration for activity selectors (max 10) + items: + $ref: '#/components/schemas/ActivitySelectorConfig' + maximum: 10 + title: Activity Selectors + type: array + x-stream-index: "006" + aggregation: + $ref: '#/components/schemas/AggregationConfig' + description: Configuration for activity aggregation + title: Aggregation + x-stream-index: "008" + custom: + additionalProperties: {} + description: Custom data for the feed group + title: Custom Data + type: object + x-stream-index: "004" + notification: + $ref: '#/components/schemas/NotificationConfig' + description: Configuration for notifications + title: Notification + x-stream-index: "002" + push_notification: + $ref: '#/components/schemas/PushNotificationConfig' + x-stream-index: "003" + ranking: + $ref: '#/components/schemas/RankingConfig' + description: Configuration for activity ranking + title: Ranking + x-stream-index: "007" + title: Update Feed Group Request + type: object + UpdateFeedGroupResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + feed_group: + $ref: '#/components/schemas/FeedGroupResponse' + description: The updated feed group + title: Feed Group + x-stream-index: "001" + required: + - feed_group + - duration + title: Update Feed Group Response + type: object + UpdateFeedMembersRequest: + nullable: true + properties: + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "006.001" + members: + description: List of members to upsert, remove, or set + items: + $ref: '#/components/schemas/FeedMemberRequest' + title: Members + type: array + x-stream-index: "004" + next: + type: string + x-stream-index: "006.002" + operation: + description: Type of update operation to perform + enum: + - upsert + - remove + - set + title: Operation + type: string + x-stream-index: "003" + prev: + type: string + x-stream-index: "006.003" + required: + - operation + title: Update Feed Members Request + type: object + UpdateFeedMembersResponse: + description: Basic response information + nullable: true + properties: + added: + items: + $ref: '#/components/schemas/FeedMemberResponse' + type: array + x-stream-index: "001" + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "004.001" + removed_ids: + items: + type: string + type: array + x-stream-index: "003" + updated: + items: + $ref: '#/components/schemas/FeedMemberResponse' + type: array + x-stream-index: "002" + required: + - added + - updated + - removed_ids + - duration + title: Response + type: object + UpdateFeedRequest: + nullable: true + properties: + created_by_id: + description: ID of the new feed creator (owner) + title: Created By ID + type: string + x-stream-index: "003" + custom: + additionalProperties: {} + description: Custom data for the feed + title: Custom Data + type: object + x-stream-index: "004" + title: Update Feed Request + type: object + UpdateFeedResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + feed: + $ref: '#/components/schemas/FeedResponse' + description: The updated feed + title: Feed + x-stream-index: "001" + required: + - feed + - duration + title: Update Feed Response + type: object + UpdateFeedViewRequest: + nullable: true + properties: + activity_processors: + description: Updated activity processors + items: + $ref: '#/components/schemas/ActivityProcessorConfig' + title: Activity Processors + type: array + x-stream-index: "002.002" + activity_selectors: + description: Updated configuration for selecting activities + items: + $ref: '#/components/schemas/ActivitySelectorConfig' + title: Activity Selectors + type: array + x-stream-index: "002.001" + aggregation: + $ref: '#/components/schemas/AggregationConfig' + description: Updated configuration for aggregating activities + title: Aggregation + x-stream-index: "002.004" + ranking: + $ref: '#/components/schemas/RankingConfig' + description: Updated configuration for ranking activities + title: Ranking + x-stream-index: "002.003" + title: Update Feed View Request + type: object + UpdateFeedViewResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + feed_view: + $ref: '#/components/schemas/FeedViewResponse' + description: The updated feed view + title: Feed View + x-stream-index: "001" + required: + - feed_view + - duration + title: Update Feed View Response + type: object + UpdateFollowRequest: + nullable: true + properties: + create_notification_activity: + description: Whether to create a notification activity for this follow + title: Create Notification Activity + type: boolean + x-stream-index: "001.004" + custom: + additionalProperties: {} + description: Custom data for the follow relationship + title: Custom Data + type: object + x-stream-index: "001.002" + follower_role: + type: string + x-stream-index: "002" + push_preference: + description: Push preference for the follow relationship + enum: + - all + - none + title: Push Preference + type: string + x-stream-index: "001.003" + skip_push: + type: boolean + x-stream-index: "001.005" + source: + description: Fully qualified ID of the source feed + maxLength: 255 + title: Source Feed + type: string + x-stream-index: 001.001.001 + target: + description: Fully qualified ID of the target feed + maxLength: 255 + title: Target Feed + type: string + x-stream-index: 001.001.002 + required: + - source + - target + title: Update Follow Request + type: object + UpdateFollowResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + follow: + $ref: '#/components/schemas/FollowResponse' + description: Details of the updated follow relationship + title: Follow + x-stream-index: "001" + required: + - follow + - duration + title: Update Follow Response + type: object + UpdateLiveLocationRequest: + nullable: true + properties: + end_at: + description: Time when the live location expires + format: date-time + title: string + type: number + x-stream-index: "004" + latitude: + description: Latitude coordinate + format: float + maximum: 90 + minimum: 1.8446744073709552e+19 + title: number + type: number + x-stream-index: "002" + longitude: + description: Longitude coordinate + format: float + maximum: 180 + minimum: 1.8446744073709552e+19 + title: number + type: number + x-stream-index: "003" + message_id: + description: Live location ID + title: string + type: string + x-stream-index: "001" + required: + - message_id + type: object + UpdateMembershipLevelRequest: + description: Partial update request for membership level fields. Only specified + fields will be updated. + nullable: true + properties: + custom: + additionalProperties: {} + description: Custom data for the membership level + title: Custom Data + type: object + x-stream-index: "006" + description: + description: Optional description of the membership level + maxLength: 1000 + title: Description + type: string + x-stream-index: "003" + name: + description: Display name for the membership level + maxLength: 255 + title: Name + type: string + x-stream-index: "002" + priority: + description: Priority level (higher numbers = higher priority) + format: int32 + minimum: 0 + title: Priority + type: integer + x-stream-index: "004" + tags: + description: Activity tags this membership level gives access to + items: + type: string + maximum: 255 + title: Tags + type: array + x-stream-index: "005" + title: Update Membership Level Request + type: object + UpdateMembershipLevelResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + membership_level: + $ref: '#/components/schemas/MembershipLevelResponse' + description: The updated membership level + title: Membership Level + x-stream-index: "001" + required: + - membership_level + - duration + title: Update Membership Level Response + type: object + UpdatePollOptionRequest: + nullable: true + properties: + Custom: + additionalProperties: {} + type: object + writeOnly: true + x-stream-index: "004" + id: + description: Option ID + maxLength: 255 + title: string + type: string + x-stream-index: "002" + text: + description: Option text + title: string + type: string + x-stream-index: "003" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "005.002" + user_id: + type: string + x-stream-index: "005.001" + required: + - id + - text + type: object + UpdatePollPartialRequest: + nullable: true + properties: + set: + additionalProperties: {} + description: Sets new field values + title: Set + type: object + x-stream-index: "002.001" + x-stream-map: + description: New value to set + key: field + title: Value + unset: + description: Array of field names to unset + items: + type: string + title: Unset + type: array + x-stream-index: "002.002" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "003.002" + user_id: + type: string + x-stream-index: "003.001" + type: object + UpdatePollRequest: + nullable: true + properties: + Custom: + additionalProperties: {} + type: object + writeOnly: true + x-stream-index: "011" + allow_answers: + description: Allow answers + title: boolean + type: boolean + x-stream-index: "009" + allow_user_suggested_options: + description: Allow user suggested options + title: boolean + type: boolean + x-stream-index: "008" + description: + description: Poll description + title: string + type: string + x-stream-index: "003" + enforce_unique_vote: + description: Enforce unique vote + title: boolean + type: boolean + x-stream-index: "005" + id: + description: Poll ID + maxLength: 255 + title: string + type: string + x-stream-index: "001" + is_closed: + description: Is closed + title: boolean + type: boolean + x-stream-index: "010" + max_votes_allowed: + description: Max votes allowed + format: int32 + maximum: 10 + title: integer + type: integer + x-stream-index: "007" + name: + description: Poll name + title: string + type: string + x-stream-index: "002" + options: + description: Poll options + items: + $ref: '#/components/schemas/PollOptionRequest' + maximum: 100 + title: PollOptions + type: array + x-stream-index: "004" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "012.002" + user_id: + type: string + x-stream-index: "012.001" + voting_visibility: + description: Voting visibility + enum: + - anonymous + - public + title: string + type: string + x-stream-index: "006" + required: + - id + - name + type: object + UpdateUserPartialRequest: + properties: + id: + description: User ID to update + title: ID + type: string + x-stream-index: "001" + set: + additionalProperties: {} + type: object + x-stream-index: "002.001" + unset: + items: + type: string + type: array + x-stream-index: "002.002" + required: + - id + type: object + UpdateUsersPartialRequest: + nullable: true + properties: + users: + items: + $ref: '#/components/schemas/UpdateUserPartialRequest' + maximum: 100 + type: array + x-stream-index: "001" + required: + - users + type: object + UpdateUsersRequest: + nullable: true + properties: + users: + additionalProperties: + $ref: '#/components/schemas/UserRequest' + description: Object containing users + title: Users + type: object + x-stream-index: "001" + x-stream-map: + key: user_id + required: + - users + type: object + UpdateUsersResponse: + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "003.001" + membership_deletion_task_id: + type: string + x-stream-index: "002" + users: + additionalProperties: + $ref: '#/components/schemas/FullUserResponse' + description: Object containing users + title: Users + type: object + x-stream-index: "001" + x-stream-map: + key: user_id + required: + - users + - membership_deletion_task_id + - duration + type: object + UpsertActivitiesRequest: + nullable: true + properties: + activities: + description: List of activities to create or update + items: + $ref: '#/components/schemas/ActivityRequest' + maximum: 100 + minimum: 1 + title: Activities + type: array + x-stream-index: "001" + required: + - activities + title: Upsert Activities Request + type: object + UpsertActivitiesResponse: + nullable: true + properties: + activities: + description: List of created or updated activities + items: + $ref: '#/components/schemas/ActivityResponse' + title: Activities + type: array + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - activities + - duration + title: Upsert Activities Response + type: object + UpsertConfigRequest: + nullable: true + properties: + ai_image_config: + $ref: '#/components/schemas/AIImageConfig' + description: Configuration for AI image analysis + title: AI Image Config + x-stream-index: "011" + ai_text_config: + $ref: '#/components/schemas/AITextConfig' + description: Configuration for AI text analysis + title: AI Text Config + x-stream-index: "008" + ai_video_config: + $ref: '#/components/schemas/AIVideoConfig' + description: Configuration for AI video analysis + title: AI Video Config + x-stream-index: "012" + async: + description: Whether moderation should be performed asynchronously + title: Async + type: boolean + x-stream-index: "003" + automod_platform_circumvention_config: + $ref: '#/components/schemas/AutomodPlatformCircumventionConfig' + description: Configuration for platform circumvention detection + title: Automod Platform Circumvention Config + x-stream-index: "005" + automod_semantic_filters_config: + $ref: '#/components/schemas/AutomodSemanticFiltersConfig' + description: Configuration for semantic filtering + title: Automod Semantic Filters Config + x-stream-index: "006" + automod_toxicity_config: + $ref: '#/components/schemas/AutomodToxicityConfig' + description: Configuration for toxicity detection + title: Automod Toxicity Config + x-stream-index: "004" + aws_rekognition_config: + $ref: '#/components/schemas/AIImageConfig' + x-stream-index: "016" + block_list_config: + $ref: '#/components/schemas/BlockListConfig' + description: Configuration for block list filtering + title: Block List Config + x-stream-index: "007" + bodyguard_config: + $ref: '#/components/schemas/AITextConfig' + x-stream-index: "015" + google_vision_config: + $ref: '#/components/schemas/GoogleVisionConfig' + description: Configuration for Google Vision integration + title: Google Vision Config + x-stream-index: "010" + key: + description: Unique identifier for the moderation configuration + title: Key + type: string + x-stream-index: "001" + llm_config: + $ref: '#/components/schemas/LLMConfig' + description: Configuration for customer-configured LLM moderation + title: LLM Config + x-stream-index: "009" + rule_builder_config: + $ref: '#/components/schemas/RuleBuilderConfig' + description: Configuration for custom rule builder (max 3 rules, max 5 conditions + per rule) + title: Rule Builder Config + x-stream-index: "014" + team: + description: Team associated with the configuration + maxLength: 128 + minLength: 1 + title: Team + type: string + x-stream-index: "002" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "018.002" + user_id: + type: string + x-stream-index: "018.001" + velocity_filter_config: + $ref: '#/components/schemas/VelocityFilterConfig' + description: Configuration for velocity-based filtering + title: Velocity Filter Config + x-stream-index: "013" + video_call_rule_config: + $ref: '#/components/schemas/VideoCallRuleConfig' + x-stream-index: "017" + required: + - key + type: object + UpsertConfigResponse: + nullable: true + properties: + config: + $ref: '#/components/schemas/ConfigResponse' + description: The created or updated moderation configuration + title: Config + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - duration + type: object + UpsertModerationRuleRequest: + nullable: true + properties: + action: + $ref: '#/components/schemas/RuleBuilderAction' + x-stream-index: "009" + conditions: + items: + $ref: '#/components/schemas/RuleBuilderCondition' + type: array + x-stream-index: "006" + config_keys: + items: + type: string + type: array + x-stream-index: "003" + cooldown_period: + type: string + x-stream-index: "010" + description: + type: string + x-stream-index: "002" + enabled: + type: boolean + x-stream-index: "011" + groups: + items: + $ref: '#/components/schemas/RuleBuilderConditionGroup' + type: array + x-stream-index: "008" + logic: + type: string + x-stream-index: "007" + name: + type: string + x-stream-index: "001" + rule_type: + type: string + x-stream-index: "005" + team: + type: string + x-stream-index: "004" + required: + - name + - rule_type + - action + type: object + UpsertModerationRuleResponse: + description: Basic response information + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "001.001" + rule: + $ref: '#/components/schemas/ModerationRuleV2Response' + x-stream-index: "002" + required: + - duration + title: Response + type: object + UpsertModerationTemplateRequest: + nullable: true + properties: + config: + $ref: '#/components/schemas/FeedsModerationTemplateConfig' + description: Configuration for the moderation template + title: Config + x-stream-index: "002" + name: + description: Name of the moderation template + title: Name + type: string + x-stream-index: "001" + required: + - name + - config + type: object + UpsertModerationTemplateResponse: + nullable: true + properties: + config: + $ref: '#/components/schemas/FeedsModerationTemplateConfig' + description: Configuration for the moderation template + title: Config + x-stream-index: "002" + created_at: + description: When the template was created + format: date-time + title: Created At + type: number + x-stream-index: "003" + duration: + type: string + x-stream-index: "005.001" + name: + description: Name of the moderation template + title: Name + type: string + x-stream-index: "001" + updated_at: + description: When the template was last updated + format: date-time + title: Updated At + type: number + x-stream-index: "004" + required: + - name + - created_at + - updated_at + - duration + type: object + UpsertPushProviderRequest: + nullable: true + properties: + push_provider: + $ref: '#/components/schemas/PushProvider' + x-stream-index: "001" + type: object + UpsertPushProviderResponse: + description: Basic response information + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "002.001" + push_provider: + $ref: '#/components/schemas/PushProviderResponse' + x-stream-index: "001" + required: + - push_provider + - duration + title: Response + type: object + User: + properties: + avg_response_time: + format: int32 + readOnly: true + type: integer + x-stream-index: "046" + ban_expires: + format: date-time + type: number + x-stream-index: "017" + banned: + type: boolean + x-stream-index: "016" + created_at: + format: date-time + readOnly: true + type: number + x-stream-index: "008" + custom: + additionalProperties: {} + type: object + x-stream-index: "006" + deactivated_at: + format: date-time + readOnly: true + type: number + x-stream-index: "014" + deleted_at: + format: date-time + readOnly: true + type: number + x-stream-index: "013" + id: + type: string + x-stream-index: "003" + invisible: + type: boolean + x-stream-index: "023" + language: + type: string + x-stream-index: "035" + last_active: + format: date-time + readOnly: true + type: number + x-stream-index: "011" + last_engaged_at: + format: date-time + readOnly: true + type: number + x-stream-index: "012" + online: + readOnly: true + type: boolean + x-stream-index: "022" + privacy_settings: + $ref: '#/components/schemas/PrivacySettings' + x-stream-index: "026" + revoke_tokens_issued_before: + format: date-time + type: number + x-stream-index: "042" + role: + type: string + x-stream-index: "004" + teams: + items: + type: string + type: array + x-stream-index: "036" + teams_role: + additionalProperties: + type: string + type: object + x-stream-index: "005" + updated_at: + format: date-time + readOnly: true + type: number + x-stream-index: "009" + required: + - id + - role + - teams_role + - custom + - banned + - online + type: object + UserBannedEvent: + properties: + channel_id: + type: string + x-stream-index: "006.002" + channel_type: + type: string + x-stream-index: "006.003" + cid: + type: string + x-stream-index: "006.001" + created_at: + format: date-time + type: number + x-stream-index: "008.002" + created_by: + $ref: '#/components/schemas/User' + x-stream-index: "001" + expiration: + format: date-time + type: number + x-stream-index: "003" + reason: + type: string + x-stream-index: "004" + shadow: + type: boolean + x-stream-index: "002" + team: + type: string + x-stream-index: "005.001" + type: + default: user.banned + type: string + x-stream-index: "008.001" + user: + $ref: '#/components/schemas/User' + x-stream-index: "007.001" + required: + - created_by + - shadow + - cid + - channel_id + - channel_type + - type + - created_at + title: UserBannedEvent + 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 + UserCreatedWithinParameters: + properties: + max_age: + type: string + x-stream-index: "001" + type: object + UserCustomPropertyParameters: + properties: + operator: + type: string + x-stream-index: "002" + property_key: + type: string + x-stream-index: "001" + type: object + UserDeactivatedEvent: + properties: + created_at: + format: date-time + type: number + x-stream-index: "003.002" + created_by: + $ref: '#/components/schemas/User' + x-stream-index: "001" + type: + default: user.deactivated + type: string + x-stream-index: "003.001" + user: + $ref: '#/components/schemas/User' + x-stream-index: "002.001" + required: + - created_by + - type + - created_at + title: UserDeactivatedEvent + 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 + UserMute: + nullable: true + properties: + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: "009" + expires: + description: Date/time of mute expiration + format: date-time + title: Expires + type: number + x-stream-index: "008" + target: + $ref: '#/components/schemas/User' + description: User who's muted + title: Target + x-stream-index: "007" + updated_at: + description: Date/time of the last update + format: date-time + title: Updated at + type: number + x-stream-index: "010" + user: + $ref: '#/components/schemas/User' + description: Owner of channel mute + title: User + x-stream-index: "005" + required: + - created_at + - updated_at + type: object + UserMuteResponse: + nullable: true + properties: + created_at: + format: date-time + type: number + x-stream-index: "004" + expires: + format: date-time + type: number + x-stream-index: "003" + target: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "002" + updated_at: + format: date-time + type: number + x-stream-index: "005" + user: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "001" + required: + - created_at + - updated_at + type: object + UserMutedEvent: + properties: + created_at: + format: date-time + type: number + x-stream-index: "004.002" + target_user: + type: string + x-stream-index: "001" + target_users: + items: + type: string + type: array + x-stream-index: "002" + type: + default: user.muted + type: string + x-stream-index: "004.001" + user: + $ref: '#/components/schemas/User' + x-stream-index: "003.001" + required: + - type + - created_at + title: UserMutedEvent + 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 + UserReactivatedEvent: + properties: + created_at: + format: date-time + type: number + x-stream-index: "002.002" + type: + default: user.reactivated + type: string + x-stream-index: "002.001" + user: + $ref: '#/components/schemas/User' + x-stream-index: "001" + required: + - type + - created_at + title: UserReactivatedEvent + 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 + UserRequest: + description: User request object + properties: + custom: + additionalProperties: {} + description: Custom user data + title: Custom + type: object + x-stream-index: "004" + id: + description: User ID + title: ID + type: string + x-stream-index: "001" + image: + description: User's profile image URL + title: Image + type: string + x-stream-index: "003" + invisible: + type: boolean + x-stream-index: "006" + language: + type: string + x-stream-index: "005" + name: + description: Optional name of user + title: Name + type: string + x-stream-index: "002" + privacy_settings: + $ref: '#/components/schemas/PrivacySettingsResponse' + x-stream-index: "007" + role: + description: User's global role + title: Role + type: string + x-stream-index: "008" + teams: + description: List of teams the user belongs to + items: + type: string + title: Teams + type: array + x-stream-index: "010" + teams_role: + additionalProperties: + type: string + description: Map of team-specific roles for the user + title: TeamsRole + type: object + x-stream-index: "009" + required: + - id + title: UserRequest + type: object + UserResponse: + description: User response object + properties: + avg_response_time: + format: int32 + type: integer + x-stream-index: "001.018" + ban_expires: + description: Date when ban expires + format: date-time + title: Ban expires + type: number + x-stream-index: "003" + banned: + description: Whether a user is banned or not + title: Banned + type: boolean + x-stream-index: "001.012" + blocked_user_ids: + items: + type: string + type: array + x-stream-index: "001.017" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: "001.009" + custom: + additionalProperties: {} + description: Custom data for this object + title: Custom data + type: object + x-stream-index: "001.004" + deactivated_at: + description: Date of deactivation + format: date-time + title: Deactivated at + type: number + x-stream-index: "001.016" + deleted_at: + description: Date/time of deletion + format: date-time + title: Deleted at + type: number + x-stream-index: "001.011" + devices: + description: List of devices user is using + items: + $ref: '#/components/schemas/DeviceResponse' + title: Devices + type: array + x-stream-index: "006" + id: + description: Unique user identifier + title: ID + type: string + x-stream-index: "001.001" + image: + title: Image + type: string + x-stream-index: "001.003" + invisible: + type: boolean + x-stream-index: "007" + language: + description: Preferred language of a user + title: Language + type: string + x-stream-index: "001.005" + last_active: + description: Date of last activity + format: date-time + title: Last active + type: number + x-stream-index: "001.014" + name: + description: Optional name of user + title: Name + type: string + x-stream-index: "001.002" + online: + description: Whether a user online or not + title: Online + type: boolean + x-stream-index: "001.013" + privacy_settings: + $ref: '#/components/schemas/PrivacySettingsResponse' + description: User privacy settings + title: Privacy settings + x-stream-index: "005" + push_notifications: + $ref: '#/components/schemas/PushNotificationSettingsResponse' + description: User push notification settings + title: Push notifications + x-stream-index: "004" + revoke_tokens_issued_before: + description: Revocation date for tokens + format: date-time + title: Revoke tokens issued before + type: number + x-stream-index: "001.015" + role: + description: Determines the set of user permissions + title: Role + type: string + x-stream-index: "001.006" + shadow_banned: + description: Whether a user is shadow banned + title: Shadow banned + type: boolean + x-stream-index: "002" + teams: + description: List of teams user is a part of + items: + type: string + title: Teams + type: array + x-stream-index: "001.007" + teams_role: + additionalProperties: + type: string + type: object + x-stream-index: "001.008" + updated_at: + description: Date/time of the last update + format: date-time + title: Updated at + type: number + x-stream-index: "001.010" + required: + - id + - custom + - language + - role + - teams + - created_at + - updated_at + - banned + - online + - blocked_user_ids + - shadow_banned + - invisible + title: UserResponse + type: object + UserResponseCommonFields: + properties: + avg_response_time: + format: int32 + type: integer + x-stream-index: "018" + banned: + type: boolean + x-stream-index: "012" + blocked_user_ids: + items: + type: string + type: array + x-stream-index: "017" + created_at: + format: date-time + type: number + x-stream-index: "009" + custom: + additionalProperties: {} + type: object + x-stream-index: "004" + deactivated_at: + format: date-time + type: number + x-stream-index: "016" + deleted_at: + format: date-time + type: number + x-stream-index: "011" + id: + type: string + x-stream-index: "001" + image: + type: string + x-stream-index: "003" + language: + type: string + x-stream-index: "005" + last_active: + format: date-time + type: number + x-stream-index: "014" + name: + type: string + x-stream-index: "002" + online: + type: boolean + x-stream-index: "013" + revoke_tokens_issued_before: + format: date-time + type: number + x-stream-index: "015" + role: + type: string + x-stream-index: "006" + teams: + items: + type: string + type: array + x-stream-index: "007" + teams_role: + additionalProperties: + type: string + type: object + x-stream-index: "008" + updated_at: + format: date-time + type: number + x-stream-index: "010" + required: + - id + - custom + - language + - role + - teams + - created_at + - updated_at + - banned + - online + - blocked_user_ids + type: object + UserResponsePrivacyFields: + properties: + avg_response_time: + format: int32 + type: integer + x-stream-index: "001.018" + banned: + type: boolean + x-stream-index: "001.012" + blocked_user_ids: + items: + type: string + type: array + x-stream-index: "001.017" + created_at: + format: date-time + type: number + x-stream-index: "001.009" + custom: + additionalProperties: {} + type: object + x-stream-index: "001.004" + deactivated_at: + format: date-time + type: number + x-stream-index: "001.016" + deleted_at: + format: date-time + type: number + x-stream-index: "001.011" + id: + type: string + x-stream-index: "001.001" + image: + type: string + x-stream-index: "001.003" + invisible: + type: boolean + x-stream-index: "003" + language: + type: string + x-stream-index: "001.005" + last_active: + format: date-time + type: number + x-stream-index: "001.014" + name: + type: string + x-stream-index: "001.002" + online: + type: boolean + x-stream-index: "001.013" + privacy_settings: + $ref: '#/components/schemas/PrivacySettingsResponse' + x-stream-index: "002" + revoke_tokens_issued_before: + format: date-time + type: number + x-stream-index: "001.015" + role: + type: string + x-stream-index: "001.006" + teams: + items: + type: string + type: array + x-stream-index: "001.007" + teams_role: + additionalProperties: + type: string + type: object + x-stream-index: "001.008" + updated_at: + format: date-time + type: number + x-stream-index: "001.010" + required: + - id + - custom + - language + - role + - teams + - created_at + - updated_at + - banned + - online + - blocked_user_ids + type: object + UserRuleParameters: + properties: + max_age: + type: string + x-stream-index: "001" + type: object + UserUpdatedEvent: + description: This event is sent when a user gets updated. The event contains + information about the updated user. + nullable: true + properties: + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: "001.003" + custom: + additionalProperties: {} + type: object + x-stream-index: "001.007" + received_at: + format: date-time + type: number + x-stream-index: "001.004" + type: + default: user.updated + description: 'The type of event: "user.updated" in this case' + title: Event Type + type: string + x-stream-index: "001.002" + user: + $ref: '#/components/schemas/UserResponsePrivacyFields' + description: The updated user + title: User + x-stream-index: "002.001" + required: + - type + - created_at + - custom + - user + title: UserUpdatedEvent + 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 + VelocityFilterConfig: + properties: + advanced_filters: + type: boolean + x-stream-index: "007" + async: + type: boolean + x-stream-index: "001" + cascading_actions: + type: boolean + x-stream-index: "004" + cids_per_user: + format: int32 + type: integer + x-stream-index: "006" + enabled: + type: boolean + x-stream-index: "002" + first_message_only: + type: boolean + x-stream-index: "005" + rules: + items: + $ref: '#/components/schemas/VelocityFilterConfigRule' + type: array + x-stream-index: "003" + required: + - enabled + - rules + - cascading_actions + - first_message_only + - cids_per_user + - advanced_filters + type: object + VelocityFilterConfigRule: + properties: + action: + enum: + - flag + - shadow + - remove + - ban + type: string + x-stream-index: "001" + ban_duration: + format: int32 + type: integer + x-stream-index: "002" + cascading_action: + enum: + - flag + - shadow + - remove + - ban + type: string + x-stream-index: "006" + cascading_threshold: + format: int64 + type: integer + x-stream-index: "005" + check_message_context: + type: boolean + x-stream-index: "009" + fast_spam_threshold: + format: int32 + type: integer + x-stream-index: "007" + fast_spam_ttl: + format: int32 + type: integer + x-stream-index: "010" + ip_ban: + type: boolean + x-stream-index: "004" + probation_period: + format: int32 + type: integer + x-stream-index: "014" + shadow_ban: + type: boolean + x-stream-index: "003" + slow_spam_ban_duration: + format: int32 + type: integer + x-stream-index: "012" + slow_spam_threshold: + format: int32 + type: integer + x-stream-index: "008" + slow_spam_ttl: + format: int32 + type: integer + x-stream-index: "011" + url_only: + type: boolean + x-stream-index: "013" + required: + - action + - ban_duration + - shadow_ban + - ip_ban + - cascading_threshold + - cascading_action + - fast_spam_threshold + - slow_spam_threshold + - check_message_context + - fast_spam_ttl + - slow_spam_ttl + - url_only + - probation_period + type: object + VideoCallRuleConfig: + properties: + rules: + additionalProperties: + $ref: '#/components/schemas/HarmConfig' + type: object + x-stream-index: "001" + required: + - rules + type: object + VideoContentParameters: + properties: + harm_labels: + items: + type: string + type: array + x-stream-index: "001" + type: object + VideoEndCallRequest: + type: object + VideoKickUserRequest: + type: object + VideoOrientation: + properties: + orientation: + type: integer + x-stream-index: "004" + type: object + VideoRuleParameters: + properties: + harm_labels: + items: + type: string + type: array + x-stream-index: "003" + threshold: + format: int32 + type: integer + x-stream-index: "001" + time_window: + type: string + x-stream-index: "002" + type: object + VideoSettings: + properties: + access_request_enabled: + type: boolean + x-stream-index: "002" + camera_default_on: + type: boolean + x-stream-index: "004" + camera_facing: + enum: + - front + - back + - external + type: string + x-stream-index: "005" + enabled: + type: boolean + x-stream-index: "001" + target_resolution: + $ref: '#/components/schemas/TargetResolution' + x-stream-index: "003" + required: + - enabled + - access_request_enabled + - target_resolution + - camera_default_on + - camera_facing + type: object + VideoSettingsResponse: + properties: + access_request_enabled: + type: boolean + x-stream-index: "002" + camera_default_on: + type: boolean + x-stream-index: "004" + camera_facing: + enum: + - front + - back + - external + type: string + x-stream-index: "005" + enabled: + type: boolean + x-stream-index: "001" + target_resolution: + $ref: '#/components/schemas/TargetResolution' + x-stream-index: "003" + required: + - enabled + - access_request_enabled + - target_resolution + - camera_default_on + - camera_facing + type: object + VoteData: + properties: + answer_text: + type: string + x-stream-index: "002" + option_id: + maxLength: 255 + type: string + x-stream-index: "001" + type: object + WebhookEvent: + description: The discriminator object for all webhook events, it maps events' + payload to the final type + discriminator: + mapping: + export.bulk_image_moderation.error: '#/components/schemas/AsyncExportErrorEvent' + export.bulk_image_moderation.success: '#/components/schemas/AsyncBulkImageModerationEvent' + export.moderation_logs.error: '#/components/schemas/AsyncExportErrorEvent' + export.moderation_logs.success: '#/components/schemas/AsyncExportModerationLogsEvent' + feeds.activity.added: '#/components/schemas/ActivityAddedEvent' + feeds.activity.deleted: '#/components/schemas/ActivityDeletedEvent' + feeds.activity.marked: '#/components/schemas/ActivityMarkEvent' + feeds.activity.pinned: '#/components/schemas/ActivityPinnedEvent' + feeds.activity.reaction.added: '#/components/schemas/ActivityReactionAddedEvent' + feeds.activity.reaction.deleted: '#/components/schemas/ActivityReactionDeletedEvent' + feeds.activity.reaction.updated: '#/components/schemas/ActivityReactionUpdatedEvent' + feeds.activity.removed_from_feed: '#/components/schemas/ActivityRemovedFromFeedEvent' + feeds.activity.unpinned: '#/components/schemas/ActivityUnpinnedEvent' + feeds.activity.updated: '#/components/schemas/ActivityUpdatedEvent' + feeds.bookmark.added: '#/components/schemas/BookmarkAddedEvent' + feeds.bookmark.deleted: '#/components/schemas/BookmarkDeletedEvent' + feeds.bookmark.updated: '#/components/schemas/BookmarkUpdatedEvent' + feeds.bookmark_folder.deleted: '#/components/schemas/BookmarkFolderDeletedEvent' + feeds.bookmark_folder.updated: '#/components/schemas/BookmarkFolderUpdatedEvent' + feeds.comment.added: '#/components/schemas/CommentAddedEvent' + feeds.comment.deleted: '#/components/schemas/CommentDeletedEvent' + feeds.comment.reaction.added: '#/components/schemas/CommentReactionAddedEvent' + feeds.comment.reaction.deleted: '#/components/schemas/CommentReactionDeletedEvent' + feeds.comment.reaction.updated: '#/components/schemas/CommentReactionUpdatedEvent' + feeds.comment.updated: '#/components/schemas/CommentUpdatedEvent' + feeds.feed.created: '#/components/schemas/FeedCreatedEvent' + feeds.feed.deleted: '#/components/schemas/FeedDeletedEvent' + feeds.feed.updated: '#/components/schemas/FeedUpdatedEvent' + feeds.feed_group.changed: '#/components/schemas/FeedGroupChangedEvent' + feeds.feed_group.deleted: '#/components/schemas/FeedGroupDeletedEvent' + feeds.feed_member.added: '#/components/schemas/FeedMemberAddedEvent' + feeds.feed_member.removed: '#/components/schemas/FeedMemberRemovedEvent' + feeds.feed_member.updated: '#/components/schemas/FeedMemberUpdatedEvent' + feeds.follow.created: '#/components/schemas/FollowCreatedEvent' + feeds.follow.deleted: '#/components/schemas/FollowDeletedEvent' + feeds.follow.updated: '#/components/schemas/FollowUpdatedEvent' + feeds.notification_feed.updated: '#/components/schemas/NotificationFeedUpdatedEvent' + moderation.custom_action: '#/components/schemas/ModerationCustomActionEvent' + moderation.flagged: '#/components/schemas/ModerationFlaggedEvent' + moderation.mark_reviewed: '#/components/schemas/ModerationMarkReviewedEvent' + moderation_check.completed: '#/components/schemas/ModerationCheckCompletedEvent' + review_queue_item.new: '#/components/schemas/ReviewQueueItemNewEvent' + review_queue_item.updated: '#/components/schemas/ReviewQueueItemUpdatedEvent' + user.banned: '#/components/schemas/UserBannedEvent' + user.deactivated: '#/components/schemas/UserDeactivatedEvent' + user.muted: '#/components/schemas/UserMutedEvent' + user.reactivated: '#/components/schemas/UserReactivatedEvent' + user.updated: '#/components/schemas/UserUpdatedEvent' + propertyName: type + oneOf: + - $ref: '#/components/schemas/ActivityAddedEvent' + - $ref: '#/components/schemas/ActivityDeletedEvent' + - $ref: '#/components/schemas/ActivityMarkEvent' + - $ref: '#/components/schemas/ActivityPinnedEvent' + - $ref: '#/components/schemas/ActivityReactionAddedEvent' + - $ref: '#/components/schemas/ActivityReactionDeletedEvent' + - $ref: '#/components/schemas/ActivityReactionUpdatedEvent' + - $ref: '#/components/schemas/ActivityRemovedFromFeedEvent' + - $ref: '#/components/schemas/ActivityUnpinnedEvent' + - $ref: '#/components/schemas/ActivityUpdatedEvent' + - $ref: '#/components/schemas/AsyncBulkImageModerationEvent' + - $ref: '#/components/schemas/AsyncExportErrorEvent' + - $ref: '#/components/schemas/AsyncExportErrorEvent' + - $ref: '#/components/schemas/AsyncExportModerationLogsEvent' + - $ref: '#/components/schemas/BookmarkAddedEvent' + - $ref: '#/components/schemas/BookmarkDeletedEvent' + - $ref: '#/components/schemas/BookmarkFolderDeletedEvent' + - $ref: '#/components/schemas/BookmarkFolderUpdatedEvent' + - $ref: '#/components/schemas/BookmarkUpdatedEvent' + - $ref: '#/components/schemas/CommentAddedEvent' + - $ref: '#/components/schemas/CommentDeletedEvent' + - $ref: '#/components/schemas/CommentReactionAddedEvent' + - $ref: '#/components/schemas/CommentReactionDeletedEvent' + - $ref: '#/components/schemas/CommentReactionUpdatedEvent' + - $ref: '#/components/schemas/CommentUpdatedEvent' + - $ref: '#/components/schemas/FeedCreatedEvent' + - $ref: '#/components/schemas/FeedDeletedEvent' + - $ref: '#/components/schemas/FeedGroupChangedEvent' + - $ref: '#/components/schemas/FeedGroupDeletedEvent' + - $ref: '#/components/schemas/FeedMemberAddedEvent' + - $ref: '#/components/schemas/FeedMemberRemovedEvent' + - $ref: '#/components/schemas/FeedMemberUpdatedEvent' + - $ref: '#/components/schemas/FeedUpdatedEvent' + - $ref: '#/components/schemas/FollowCreatedEvent' + - $ref: '#/components/schemas/FollowDeletedEvent' + - $ref: '#/components/schemas/FollowUpdatedEvent' + - $ref: '#/components/schemas/ModerationCheckCompletedEvent' + - $ref: '#/components/schemas/ModerationCustomActionEvent' + - $ref: '#/components/schemas/ModerationFlaggedEvent' + - $ref: '#/components/schemas/ModerationMarkReviewedEvent' + - $ref: '#/components/schemas/NotificationFeedUpdatedEvent' + - $ref: '#/components/schemas/ReviewQueueItemNewEvent' + - $ref: '#/components/schemas/ReviewQueueItemUpdatedEvent' + - $ref: '#/components/schemas/UserBannedEvent' + - $ref: '#/components/schemas/UserDeactivatedEvent' + - $ref: '#/components/schemas/UserMutedEvent' + - $ref: '#/components/schemas/UserReactivatedEvent' + - $ref: '#/components/schemas/UserUpdatedEvent' + XiaomiConfig: + properties: + Disabled: + type: boolean + writeOnly: true + x-stream-index: "003" + package_name: + type: string + x-stream-index: "001" + secret: + type: string + x-stream-index: "002" + type: object + XiaomiConfigFields: + properties: + enabled: + type: boolean + x-stream-index: "001" + package_name: + type: string + x-stream-index: "002" + secret: + type: string + x-stream-index: "003" + required: + - enabled + type: object + securitySchemes: + JWT: + description: | + JWT should be always provided when stream-auth-type=jwt. + + Using JWT auth request could be authenticated as user or as server-side. + + When using user authentication permission checking is going to be applied to requests based on the user that is + performing a request. + + The `authorization` header should be a JWT string signed using the secret attached to the API key used to perform + requests. + + **WARNING** all client-side official SDK do not ship with token generation; this is to make sure that the API secret is not + shared with an untrusted party such as a browser or a iOS/Android application. Tokens **must** be generated server-side. + If you wish, you can configure your application to ignore authentication (see `disable_auth_check`) + The JWT string must include only the user_id claim and can include any built-in JWT claim such as iat, exp as well. + in: header + name: Authorization + type: apiKey + api_key: + description: Application API key should be always set in order to authenticate + the request. + in: query + name: api_key + type: apiKey + stream-auth-type: + description: |- + Stream-Auth-Type should be always set in order to authenticate the request. Possible + values: `jwt` or `anonymous`. + + `jwt` allows you to authenticate as a user. With this auth type you should also provide valid JWT in Authorization + header. + + `anonymous` allows you to authenticate as anonymous user. Please note that most advanced features are not available + to anonymous users. + in: header + name: Stream-Auth-Type + type: apiKey +info: + title: Stream API + version: v191.1.0 +openapi: 3.0.3 +paths: + /api/v2/app: + get: + description: | + This Method returns the application settings + operationId: GetApp + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/GetApplicationResponse' + 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: Get App Settings + tags: + - product:common + patch: + description: | + This Method updates one or more application settings + operationId: UpdateApp + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateAppRequest' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/Response' + 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: Update App Settings + tags: + - product:common + /api/v2/blocklists: + get: + description: | + Returns all available block lists + operationId: ListBlockLists + parameters: + - in: query + name: team + schema: + type: string + writeOnly: true + x-stream-index: "001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/ListBlockListResponse' + 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: List block lists + tags: + - product:common + post: + description: | + Creates a new application blocklist, once created the blocklist can be used by any channel type + operationId: CreateBlockList + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateBlockListRequest' + description: Block list + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/CreateBlockListResponse' + 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: Create block list + tags: + - product:common + /api/v2/blocklists/{name}: + delete: + description: | + Deletes previously created application blocklist + operationId: DeleteBlockList + parameters: + - in: path + name: name + required: true + schema: + type: string + writeOnly: true + x-stream-index: "001" + - in: query + name: team + schema: + type: string + x-stream-index: "002" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/Response' + 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: Delete block list + tags: + - product:common + get: + description: | + Returns block list by given name + operationId: GetBlockList + parameters: + - in: path + name: name + required: true + schema: + description: Block list name + title: Name + type: string + writeOnly: true + x-stream-index: "001" + - in: query + name: team + schema: + type: string + writeOnly: true + x-stream-index: "002" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/GetBlockListResponse' + description: GetBlockListResponse + "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: Get block list + tags: + - product:common + put: + description: | + Updates contents of the block list + operationId: UpdateBlockList + parameters: + - in: path + name: name + required: true + schema: + description: Block list name + title: Name + type: string + writeOnly: true + x-stream-index: "001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateBlockListRequest' + description: Update block list + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateBlockListResponse' + 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: Update block list + tags: + - product:common + /api/v2/check_push: + post: + description: | + Sends a test message via push, this is a test endpoint to verify your push settings + operationId: CheckPush + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CheckPushRequest' + description: CheckPushRequest + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/CheckPushResponse' + description: Successful 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: Check push + tags: + - product:common + /api/v2/check_sns: + post: + description: | + Validates Amazon SNS configuration + operationId: CheckSNS + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CheckSNSRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/CheckSNSResponse' + description: Successful 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: Check SNS + tags: + - product:common + /api/v2/check_sqs: + post: + description: | + Validates Amazon SQS credentials + operationId: CheckSQS + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CheckSQSRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/CheckSQSResponse' + description: Successful 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: Check SQS + tags: + - product:common + /api/v2/devices: + delete: + description: | + Deletes one device + operationId: DeleteDevice + parameters: + - in: query + name: id + required: true + schema: + description: Device ID to delete + title: ID + type: string + writeOnly: true + x-stream-index: "001" + - in: query + name: user_id + schema: + description: '**Server-side only**. User ID which server acts upon' + title: User ID + type: string + writeOnly: true + x-stream-index: "002.001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/Response' + 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: Delete device + tags: + - product:common + get: + description: | + Returns all available devices + operationId: ListDevices + parameters: + - in: query + name: user_id + schema: + description: '**Server-side only**. User ID which server acts upon' + title: User ID + type: string + writeOnly: true + x-stream-index: "001.001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/ListDevicesResponse' + description: ListDevicesResponse + "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: List devices + tags: + - product:common + post: + description: | + Adds a new device to a user, if the same device already exists the call will have no effect + operationId: CreateDevice + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateDeviceRequest' + description: CreateDeviceRequest + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/Response' + 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: Create device + tags: + - product:common + /api/v2/export/users: + post: + description: | + Exports user profile, reactions and messages for list of given users + operationId: ExportUsers + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ExportUsersRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/ExportUsersResponse' + 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: Export users + tags: + - product:common + /api/v2/external_storage: + get: + description: | + Lists external storage + operationId: ListExternalStorage + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/ListExternalStorageResponse' + 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: List external storage + tags: + - product:common + post: + description: | + Creates new external storage + operationId: CreateExternalStorage + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateExternalStorageRequest' + description: CreateExternalStorageRequest + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/CreateExternalStorageResponse' + 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: Create external storage + tags: + - product:common + /api/v2/external_storage/{name}: + delete: + description: | + Deletes external storage + operationId: DeleteExternalStorage + parameters: + - in: path + name: name + required: true + schema: + type: string + writeOnly: true + x-stream-index: "002" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteExternalStorageResponse' + 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: Delete external storage + tags: + - product:common + put: + description: |2+ + + operationId: UpdateExternalStorage + parameters: + - in: path + name: name + required: true + schema: + type: string + writeOnly: true + x-stream-index: "001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateExternalStorageRequest' + description: ExternalStorageRequest + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateExternalStorageResponse' + 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: Update External Storage + tags: + - product:common + /api/v2/external_storage/{name}/check: + get: + description: |2+ + + operationId: CheckExternalStorage + parameters: + - in: path + name: name + required: true + schema: + type: string + writeOnly: true + x-stream-index: "002" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/CheckExternalStorageResponse' + 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: Check External Storage + tags: + - product:common + /api/v2/feeds/activities: + post: + description: | + Create a new activity or update an existing one + operationId: AddActivity + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AddActivityRequest' + description: Activity Request + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/AddActivityResponse' + description: Add Activity 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: Add a single activity + tags: + - product:feeds + /api/v2/feeds/activities/{activity_id}/bookmarks: + delete: + description: | + Deletes a bookmark from an activity + operationId: DeleteBookmark + parameters: + - in: path + name: activity_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + - in: query + name: folder_id + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "002" + - in: query + name: user_id + schema: + type: string + writeOnly: true + x-stream-index: "003.001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteBookmarkResponse' + description: Delete Bookmark 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: Delete a bookmark + tags: + - product:feeds + patch: + description: | + Updates a bookmark for an activity + operationId: UpdateBookmark + parameters: + - in: path + name: activity_id + required: true + schema: + description: ID of the activity + maxLength: 255 + title: Activity ID + type: string + writeOnly: true + x-stream-index: "001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateBookmarkRequest' + description: Update Bookmark Request + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateBookmarkResponse' + description: Update Bookmark 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: Update bookmark + tags: + - product:feeds + post: + description: | + Adds a bookmark to an activity + operationId: AddBookmark + parameters: + - in: path + name: activity_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AddBookmarkRequest' + description: Add Bookmark Request + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/AddBookmarkResponse' + description: Add Bookmark 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: Add bookmark + tags: + - product:feeds + /api/v2/feeds/activities/{activity_id}/feedback: + post: + description: | + Submit feedback for an activity including options to show less, hide, report, or mute the user + operationId: ActivityFeedback + parameters: + - in: path + name: activity_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ActivityFeedbackRequest' + description: Activity Feedback Request + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/ActivityFeedbackResponse' + description: Activity Feedback 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: Provide feedback on an activity + tags: + - product:feeds + /api/v2/feeds/activities/{activity_id}/polls/{poll_id}/vote: + post: + description: | + Cast a vote on a poll + + Sends events: + - feeds.poll.vote_casted + - feeds.poll.vote_changed + - feeds.poll.vote_removed + - poll.vote_casted + - poll.vote_changed + - poll.vote_removed + operationId: CastPollVote + parameters: + - in: path + name: activity_id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "002" + - in: path + name: poll_id + required: true + schema: + description: Poll ID + maxLength: 255 + title: string + type: string + x-stream-index: "003" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CastPollVoteRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/PollVoteResponse' + description: Successful 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: Cast vote + tags: + - product:feeds + /api/v2/feeds/activities/{activity_id}/polls/{poll_id}/vote/{vote_id}: + delete: + description: | + Delete a vote from a poll + + Sends events: + - feeds.poll.vote_removed + - poll.vote_removed + operationId: DeletePollVote + parameters: + - in: path + name: activity_id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "003" + - in: path + name: poll_id + required: true + schema: + description: Poll ID + maxLength: 255 + title: string + type: string + x-stream-index: "004" + - in: path + name: vote_id + required: true + schema: + description: Vote ID + maxLength: 255 + title: string + type: string + x-stream-index: "005" + - in: query + name: user_id + schema: + type: string + writeOnly: true + x-stream-index: "001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/PollVoteResponse' + description: Successful 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: Delete vote + tags: + - product:feeds + /api/v2/feeds/activities/{activity_id}/reactions: + post: + description: | + Adds a reaction to an activity + operationId: AddReaction + parameters: + - in: path + name: activity_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AddReactionRequest' + description: Add Reaction Request + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/AddReactionResponse' + description: Add Reaction 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: Add reaction + tags: + - product:feeds + /api/v2/feeds/activities/{activity_id}/reactions/{type}: + delete: + description: | + Removes a reaction from an activity + operationId: DeleteActivityReaction + parameters: + - in: path + name: activity_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + - in: path + name: type + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "002" + - in: query + name: user_id + schema: + type: string + writeOnly: true + x-stream-index: "003.001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteActivityReactionResponse' + description: Delete Activity Reaction 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: Remove reaction + tags: + - product:feeds + /api/v2/feeds/activities/{activity_id}/reactions/query: + post: + description: | + Query activity reactions + operationId: QueryActivityReactions + parameters: + - in: path + name: activity_id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueryActivityReactionsRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/QueryActivityReactionsResponse' + 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: Query activity reactions + tags: + - product:feeds + /api/v2/feeds/activities/{id}: + delete: + description: | + Delete a single activity by its ID + operationId: DeleteActivity + parameters: + - in: path + name: id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + - in: query + name: hard_delete + schema: + description: Whether to permanently delete the activity instead of soft + delete + title: boolean + type: boolean + writeOnly: true + x-stream-index: "002" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteActivityResponse' + description: Delete Activity 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: Delete a single activity + tags: + - product:feeds + get: + description: | + Returns activity by ID + operationId: GetActivity + parameters: + - in: path + name: id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/GetActivityResponse' + description: Get Activity 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: Get activity + tags: + - product:feeds + patch: + description: | + Updates certain fields of the activity + + Sends events: + - feeds.activity.updated + operationId: UpdateActivityPartial + parameters: + - in: path + name: id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateActivityPartialRequest' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateActivityPartialResponse' + description: Successful 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: Partially activity update + tags: + - product:feeds + put: + description: | + Replaces an activity with the provided data + + Sends events: + - feeds.activity.updated + operationId: UpdateActivity + parameters: + - in: path + name: id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateActivityRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateActivityResponse' + description: Successful 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: Full activity update + tags: + - product:feeds + /api/v2/feeds/activities/batch: + post: + description: | + Create new activities or update existing ones in a batch operation + operationId: UpsertActivities + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpsertActivitiesRequest' + description: Upsert Activities Request + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/UpsertActivitiesResponse' + description: Upsert Activities 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: Upsert multiple activities + tags: + - product:feeds + /api/v2/feeds/activities/delete: + post: + description: | + Delete one or more activities by their IDs + operationId: DeleteActivities + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteActivitiesRequest' + description: Delete Activities Request + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteActivitiesResponse' + description: Delete Activities 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: Remove multiple activities + tags: + - product:feeds + /api/v2/feeds/activities/query: + post: + description: | + Query activities based on filters with pagination and sorting options + operationId: QueryActivities + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueryActivitiesRequest' + description: Query Activities Request + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/QueryActivitiesResponse' + description: Query Activities 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: Query activities + tags: + - product:feeds + /api/v2/feeds/bookmark_folders/{folder_id}: + delete: + description: | + Delete a bookmark folder by its ID + operationId: DeleteBookmarkFolder + parameters: + - in: path + name: folder_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteBookmarkFolderResponse' + description: Delete Bookmark Folder 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: Delete a bookmark folder + tags: + - product:feeds + patch: + description: | + Update a bookmark folder by its ID + operationId: UpdateBookmarkFolder + parameters: + - in: path + name: folder_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateBookmarkFolderRequest' + description: Update Bookmark Folder Request + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateBookmarkFolderResponse' + description: Update Bookmark Folder 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: Update a bookmark folder + tags: + - product:feeds + /api/v2/feeds/bookmark_folders/query: + post: + description: | + Query bookmark folders with filter query + operationId: QueryBookmarkFolders + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueryBookmarkFoldersRequest' + description: Query Bookmark Folders Request + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/QueryBookmarkFoldersResponse' + description: Query Bookmark Folders 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: Query bookmark folders + tags: + - product:feeds + /api/v2/feeds/bookmarks/query: + post: + description: | + Query bookmarks with filter query + operationId: QueryBookmarks + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueryBookmarksRequest' + description: Query Bookmarks Request + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/QueryBookmarksResponse' + description: Query Bookmarks 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: Query bookmarks + tags: + - product:feeds + /api/v2/feeds/comments: + get: + description: | + Retrieve a threaded list of comments for a specific object (e.g., activity), with configurable depth, sorting, and pagination + operationId: GetComments + parameters: + - in: query + name: object_id + required: true + schema: + description: ID of the object to get comments for + title: Object ID + type: string + writeOnly: true + x-stream-index: "001" + - in: query + name: object_type + required: true + schema: + description: Type of the object to get comments for + title: Object Type + type: string + writeOnly: true + x-stream-index: "002" + - in: query + name: depth + schema: + description: Maximum nested depth to return (0 = only first level) + format: int32 + maximum: 5 + minimum: 0 + title: Max Depth + type: integer + writeOnly: true + x-stream-index: "003" + - in: query + name: sort + schema: + description: Sort order for the comments + enum: + - first + - last + - top + - best + - controversial + title: Sort Order + type: string + writeOnly: true + x-stream-index: "004" + - in: query + name: replies_limit + schema: + format: int32 + maximum: 20 + minimum: 0 + type: integer + writeOnly: true + x-stream-index: "005" + - in: query + name: limit + schema: + description: Max number of top‑level comments to return + format: int32 + maximum: 100 + minimum: 0 + title: Root Limit + type: integer + writeOnly: true + x-stream-index: "006.001" + - in: query + name: prev + schema: + type: string + writeOnly: true + x-stream-index: "006.002" + - in: query + name: next + schema: + type: string + writeOnly: true + x-stream-index: "006.003" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/GetCommentsResponse' + description: Get Comments 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: Get comments for an object + tags: + - product:feeds + post: + description: | + Adds a comment to an object (e.g., activity) or a reply to an existing comment, and broadcasts appropriate events + operationId: AddComment + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AddCommentRequest' + description: Add Comment Request + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/AddCommentResponse' + description: Add Comment 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: Add a comment or reply + tags: + - product:feeds + /api/v2/feeds/comments/{id}: + delete: + description: | + Deletes a comment from an object (e.g., activity) and broadcasts appropriate events + operationId: DeleteComment + parameters: + - in: path + name: id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "001" + - in: query + name: hard_delete + schema: + description: Whether to permanently delete the comment instead of soft delete + title: Hard Delete + type: boolean + writeOnly: true + x-stream-index: "002" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteCommentResponse' + description: Delete Comment 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: Delete a comment + tags: + - product:feeds + get: + description: | + Get a comment by ID + operationId: GetComment + parameters: + - in: path + name: id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/GetCommentResponse' + description: Get Comment 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: Get comment + tags: + - product:feeds + patch: + description: | + Updates a comment on an object (e.g., activity) and broadcasts appropriate events + operationId: UpdateComment + parameters: + - in: path + name: id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateCommentRequest' + description: Update Comment Request + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateCommentResponse' + description: Update Comment 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: Update a comment + tags: + - product:feeds + /api/v2/feeds/comments/{id}/reactions: + post: + description: | + Adds a reaction to a comment + operationId: AddCommentReaction + parameters: + - in: path + name: id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AddCommentReactionRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/AddCommentReactionResponse' + description: Successful 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: Add comment reaction + tags: + - product:feeds + /api/v2/feeds/comments/{id}/reactions/{type}: + delete: + description: | + Deletes a reaction from a comment + operationId: DeleteCommentReaction + parameters: + - in: path + name: id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + - in: path + name: type + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "002" + - in: query + name: user_id + schema: + type: string + writeOnly: true + x-stream-index: "003.001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteCommentReactionResponse' + description: Delete Comment Reaction 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: Delete comment reaction + tags: + - product:feeds + /api/v2/feeds/comments/{id}/reactions/query: + post: + description: | + Query comment reactions + operationId: QueryCommentReactions + parameters: + - in: path + name: id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueryCommentReactionsRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/QueryCommentReactionsResponse' + 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: Query comment reactions + tags: + - product:feeds + /api/v2/feeds/comments/{id}/replies: + get: + description: | + Retrieve a threaded list of replies for a single comment, with configurable depth, sorting, and pagination + operationId: GetCommentReplies + parameters: + - in: path + name: id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "001" + - in: query + name: depth + schema: + description: Maximum nested depth to return (0 = unlimited) + format: int32 + maximum: 5 + minimum: 0 + title: Max Depth + type: integer + writeOnly: true + x-stream-index: "002" + - in: query + name: sort + schema: + description: first (oldest), last (newest) or top + enum: + - first + - last + - top + - best + - controversial + title: Sort Order + type: string + writeOnly: true + x-stream-index: "003" + - in: query + name: replies_limit + schema: + description: Max number of replies to return + format: int32 + minimum: 0 + title: Replies Limit + type: integer + writeOnly: true + x-stream-index: "004" + - in: query + name: limit + schema: + description: Max number of direct replies to return + format: int32 + maximum: 100 + minimum: 0 + title: Reply Limit + type: integer + writeOnly: true + x-stream-index: "005.001" + - in: query + name: prev + schema: + type: string + writeOnly: true + x-stream-index: "005.002" + - in: query + name: next + schema: + type: string + writeOnly: true + x-stream-index: "005.003" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/GetCommentRepliesResponse' + description: Get Comment Replies 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: Get replies for a comment + tags: + - product:feeds + /api/v2/feeds/comments/batch: + post: + description: | + Adds multiple comments in a single request. Each comment must specify the object type and ID. + operationId: AddCommentsBatch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AddCommentsBatchRequest' + description: Add Comments Batch Request + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/AddCommentsBatchResponse' + description: Add Comments Batch 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: Add multiple comments in a batch + tags: + - product:feeds + /api/v2/feeds/comments/query: + post: + description: | + Query comments using MongoDB-style filters with pagination and sorting options + operationId: QueryComments + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueryCommentsRequest' + description: Query Comments Request + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/QueryCommentsResponse' + description: Query Comments 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: Query comments + tags: + - product:feeds + /api/v2/feeds/feed_groups: + get: + description: | + List all feed groups for the application + operationId: ListFeedGroups + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/ListFeedGroupsResponse' + 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: List all feed groups + tags: + - product:feeds + post: + description: | + Creates a new feed group with the specified configuration + operationId: CreateFeedGroup + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateFeedGroupRequest' + description: Create Feed Group Request + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/CreateFeedGroupResponse' + description: Upsert Feed Group 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: Create a new feed group + tags: + - product:feeds + /api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}: + delete: + description: | + Delete a single feed by its ID + operationId: DeleteFeed + parameters: + - in: path + name: feed_group_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + - in: path + name: feed_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "002" + - in: query + name: hard_delete + schema: + description: Whether to permanently delete the feed instead of soft delete + title: boolean + type: boolean + writeOnly: true + x-stream-index: "003" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteFeedResponse' + description: Delete Feed 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: Delete a single feed + tags: + - product:feeds + post: + description: | + Create a single feed for a given feed group + operationId: GetOrCreateFeed + parameters: + - in: path + name: feed_group_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + - in: path + name: feed_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "002" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GetOrCreateFeedRequest' + description: ClientRequest + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/GetOrCreateFeedResponse' + 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: Create a new feed + tags: + - product:feeds + put: + description: | + Update an existing feed + operationId: UpdateFeed + parameters: + - in: path + name: feed_group_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + - in: path + name: feed_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "002" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateFeedRequest' + description: Update Feed Request + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateFeedResponse' + description: Update Feed 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: Update a feed + tags: + - product:feeds + /api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/activities/{activity_id}/pin: + delete: + description: | + Unpin an activity from a feed. This removes the pin, so the activity will no longer be displayed at the top of the feed. + operationId: UnpinActivity + parameters: + - in: path + name: feed_group_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + - in: path + name: feed_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "002" + - in: path + name: activity_id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "003" + - in: query + name: user_id + schema: + type: string + writeOnly: true + x-stream-index: "004.001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/UnpinActivityResponse' + description: Unpin Activity 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: Unpin an activity from a feed + tags: + - product:feeds + post: + description: | + Pin an activity to a feed. Pinned activities are typically displayed at the top of a feed. + operationId: PinActivity + parameters: + - in: path + name: feed_group_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + - in: path + name: feed_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "002" + - in: path + name: activity_id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "003" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PinActivityRequest' + description: Pin Activity Request + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/PinActivityResponse' + description: Pin Activity 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: Pin an activity to a feed + tags: + - product:feeds + /api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/activities/mark/batch: + post: + description: | + Mark activities as read/seen/watched. Can mark by timestamp (seen), activity IDs (read), or all as read. + operationId: MarkActivity + parameters: + - in: path + name: feed_group_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + - in: path + name: feed_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "002" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MarkActivityRequest' + description: Mark Activity Request + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/Response' + 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 activities as read/seen/watched + tags: + - product:feeds + /api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/members: + patch: + description: | + Add, remove, or set members for a feed + operationId: UpdateFeedMembers + parameters: + - in: path + name: feed_group_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + - in: path + name: feed_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "002" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateFeedMembersRequest' + description: Update Feed Members Request + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateFeedMembersResponse' + 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: Update feed members + tags: + - product:feeds + /api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/members/accept: + post: + description: | + Accepts a pending feed member request + operationId: AcceptFeedMemberInvite + parameters: + - in: path + name: feed_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + - in: path + name: feed_group_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "002" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AcceptFeedMemberInviteRequest' + description: Accept Feed Member Invite Request + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/AcceptFeedMemberInviteResponse' + description: Accept Feed Member Invite 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: Accept a feed member request + tags: + - product:feeds + /api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/members/query: + post: + description: | + Query feed members based on filters with pagination and sorting options + operationId: QueryFeedMembers + parameters: + - in: path + name: feed_group_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + - in: path + name: feed_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "002" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueryFeedMembersRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/QueryFeedMembersResponse' + description: Successful 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: Query feed members + tags: + - product:feeds + /api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/members/reject: + post: + description: | + Rejects a pending feed member request + operationId: RejectFeedMemberInvite + parameters: + - in: path + name: feed_group_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + - in: path + name: feed_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "002" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RejectFeedMemberInviteRequest' + description: Reject Feed Member Request + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/RejectFeedMemberInviteResponse' + description: Reject Feed Member 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: Reject an invite to become a feed member + tags: + - product:feeds + /api/v2/feeds/feed_groups/{feed_group_id}/follow_suggestions: + get: + description: | + Get follow suggestions for a feed group + operationId: GetFollowSuggestions + parameters: + - in: path + name: feed_group_id + required: true + schema: + description: The ID of the feed group to get suggestions for + maxLength: 255 + title: Feed Group ID + type: string + writeOnly: true + x-stream-index: "001" + - in: query + name: limit + schema: + description: Maximum number of suggestions to return + format: int32 + maximum: 100 + minimum: 1 + title: Limit + type: integer + writeOnly: true + x-stream-index: "002" + - in: query + name: user_id + schema: + description: The ID of the user requesting suggestions (optional, defaults + to current user) + title: User ID + type: string + writeOnly: true + x-stream-index: "003.001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/GetFollowSuggestionsResponse' + description: Follow Suggestions 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: Get follow suggestions + tags: + - product:feeds + /api/v2/feeds/feed_groups/{id}: + delete: + description: | + Delete a feed group by its ID. Can perform a soft delete (default) or hard delete. + operationId: DeleteFeedGroup + parameters: + - in: path + name: id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + - in: query + name: hard_delete + schema: + description: Whether to perform a hard delete (true) or soft delete (false, + default) + title: boolean + type: boolean + writeOnly: true + x-stream-index: "002" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteFeedGroupResponse' + 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: Delete a feed group + tags: + - product:feeds + get: + description: | + Get a feed group by ID + operationId: GetFeedGroup + parameters: + - in: path + name: id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/GetFeedGroupResponse' + description: Get Feed Group 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: Get a feed group + tags: + - product:feeds + post: + description: | + Get an existing feed group or create a new one if it doesn't exist + operationId: GetOrCreateFeedGroup + parameters: + - in: path + name: id + required: true + schema: + description: Unique identifier for the feed group + maxLength: 255 + title: Feed Group ID + type: string + writeOnly: true + x-stream-index: "001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GetOrCreateFeedGroupRequest' + description: Get Or Create Feed Group Request + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/GetOrCreateFeedGroupResponse' + description: Get Or Create Feed Group 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: Get or create a feed group + tags: + - product:feeds + put: + description: | + Update a feed group by ID + operationId: UpdateFeedGroup + parameters: + - in: path + name: id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateFeedGroupRequest' + description: Update Feed Group Request + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateFeedGroupResponse' + description: Update Feed Group 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: Update a feed group + tags: + - product:feeds + /api/v2/feeds/feed_views: + get: + description: | + List all feed views for a feed group + operationId: ListFeedViews + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/ListFeedViewsResponse' + description: List Feed Views 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: List all feed views + tags: + - product:feeds + post: + description: | + Create a custom view for a feed group with specific selectors, ranking, or aggregation options + operationId: CreateFeedView + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateFeedViewRequest' + description: Create Feed View Request + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/CreateFeedViewResponse' + description: Create Feed View 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: Create a new feed view + tags: + - product:feeds + /api/v2/feeds/feed_views/{id}: + delete: + description: | + Delete an existing custom feed view + operationId: DeleteFeedView + parameters: + - in: path + name: id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteFeedViewResponse' + description: Delete Feed View 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: Delete a feed view + tags: + - product:feeds + get: + description: | + Get a feed view by its ID + operationId: GetFeedView + parameters: + - in: path + name: id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/GetFeedViewResponse' + description: Get Feed View 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: Get a feed view + tags: + - product:feeds + post: + description: | + Get an existing feed view or create a new one if it doesn't exist + operationId: GetOrCreateFeedView + parameters: + - in: path + name: id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GetOrCreateFeedViewRequest' + description: Get Or Create Feed View Request + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/GetOrCreateFeedViewResponse' + description: Get Or Create Feed View 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: Get or create a feed view + tags: + - product:feeds + put: + description: | + Update an existing custom feed view with new selectors, ranking, or aggregation options + operationId: UpdateFeedView + parameters: + - in: path + name: id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateFeedViewRequest' + description: Update Feed View Request + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateFeedViewResponse' + description: Update Feed View 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: Update a feed view + tags: + - product:feeds + /api/v2/feeds/feeds/batch: + post: + description: | + Create multiple feeds at once for a given feed group + operationId: CreateFeedsBatch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateFeedsBatchRequest' + description: Create Feeds Batch Request + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/CreateFeedsBatchResponse' + description: Create Feeds Batch 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: Create multiple feeds at once + tags: + - product:feeds + /api/v2/feeds/feeds/query: + post: + description: | + Query feeds with filter query + operationId: QueryFeeds + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueryFeedsRequest' + description: Query Feeds Request + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/QueryFeedsResponse' + description: Query Feeds 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: Query feeds + tags: + - product:feeds + /api/v2/feeds/follows: + patch: + description: | + Updates a follow's custom data, push preference, and follower role. Source owner can update custom data and push preference. Target owner can update follower role. + operationId: UpdateFollow + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateFollowRequest' + description: Update Follow Request + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateFollowResponse' + description: Update Follow 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: Update a follow + tags: + - product:feeds + post: + description: | + Creates a follow and broadcasts FollowAddedEvent + operationId: Follow + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/FollowRequest' + description: Follow Request + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/SingleFollowResponse' + description: Follow 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: Create a follow + tags: + - product:feeds + /api/v2/feeds/follows/{source}/{target}: + delete: + description: | + Removes a follow and broadcasts FollowRemovedEvent + operationId: Unfollow + parameters: + - in: path + name: source + required: true + schema: + description: Fully qualified ID of the source feed + maxLength: 255 + title: Source Feed + type: string + writeOnly: true + x-stream-index: "001" + - in: path + name: target + required: true + schema: + description: Fully qualified ID of the target feed + maxLength: 255 + title: Target Feed + type: string + writeOnly: true + x-stream-index: "002" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/UnfollowResponse' + description: Unfollow 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: Unfollow a feed + tags: + - product:feeds + /api/v2/feeds/follows/accept: + post: + description: | + Accepts a pending follow request + operationId: AcceptFollow + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AcceptFollowRequest' + description: Accept Follow Request + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/AcceptFollowResponse' + description: Accept Follow 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: Accept a follow request + tags: + - product:feeds + /api/v2/feeds/follows/batch: + post: + description: | + Creates multiple follows at once and broadcasts FollowAddedEvent for each follow + operationId: FollowBatch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/FollowBatchRequest' + description: Follow Batch Request + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/FollowBatchResponse' + description: Follow Batch 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: Create multiple follows at once + tags: + - product:feeds + /api/v2/feeds/follows/query: + post: + description: | + Query follows based on filters with pagination and sorting options + operationId: QueryFollows + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueryFollowsRequest' + description: Query Follows Request + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/QueryFollowsResponse' + description: Query Follows 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: Query follows + tags: + - product:feeds + /api/v2/feeds/follows/reject: + post: + description: | + Rejects a pending follow request + operationId: RejectFollow + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RejectFollowRequest' + description: Reject Follow Request + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/RejectFollowResponse' + description: Reject Follow 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: Reject a follow request + tags: + - product:feeds + /api/v2/feeds/membership_levels: + post: + description: | + Create a new membership level with tag-based access controls + operationId: CreateMembershipLevel + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateMembershipLevelRequest' + description: Create Membership Level Request + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/CreateMembershipLevelResponse' + description: Create Membership Level 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: Create membership level + tags: + - product:feeds + /api/v2/feeds/membership_levels/{id}: + delete: + description: | + Delete a membership level by its UUID. This operation is irreversible. + operationId: DeleteMembershipLevel + parameters: + - in: path + name: id + required: true + schema: + description: The UUID of the membership level to delete + maxLength: 255 + title: string + type: string + writeOnly: true + x-stream-index: "001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/Response' + 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: Delete membership level + tags: + - product:feeds + patch: + description: | + Update a membership level with partial updates. Only specified fields will be updated. + operationId: UpdateMembershipLevel + parameters: + - in: path + name: id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateMembershipLevelRequest' + description: Update Membership Level Request + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateMembershipLevelResponse' + description: Update Membership Level 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: Update membership level + tags: + - product:feeds + /api/v2/feeds/membership_levels/query: + post: + description: | + Query membership levels with filter query + operationId: QueryMembershipLevels + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueryMembershipLevelsRequest' + description: Query Membership Levels Request + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/QueryMembershipLevelsResponse' + description: Query Membership Levels 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: Query membership levels + tags: + - product:feeds + /api/v2/feeds/unfollow/batch: + post: + description: | + Removes multiple follows at once and broadcasts FollowRemovedEvent for each one + operationId: UnfollowBatch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UnfollowBatchRequest' + description: Unfollow Batch Request + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/UnfollowBatchResponse' + description: Unfollow Batch 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: Unfollow multiple feeds at once + tags: + - product:feeds + /api/v2/feeds/users/{user_id}/delete: + delete: + description: | + Delete all activities, reactions, comments, and bookmarks for a user + operationId: DeleteFeedUserData + parameters: + - in: path + name: user_id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteFeedUserDataResponse' + description: Successful 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: Delete all feed data for a user + tags: + - product:feeds + /api/v2/feeds/users/{user_id}/export: + post: + description: | + Export all activities, reactions, comments, and bookmarks for a user + operationId: ExportFeedUserData + parameters: + - in: path + name: user_id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "001" + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/ExportFeedUserDataResponse' + description: Successful 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: Export all feed data for a user + tags: + - product:feeds + /api/v2/guest: + post: + description: |2+ + + operationId: CreateGuest + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateGuestRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/CreateGuestResponse' + description: Successful 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: Create Guest + tags: + - product:common + /api/v2/import_urls: + post: + description: | + Creates a new import URL + operationId: CreateImportURL + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateImportURLRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/CreateImportURLResponse' + 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: Create import URL + tags: + - product:common + /api/v2/imports: + get: + description: | + Gets an import + operationId: ListImports + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/ListImportsResponse' + 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: Get import + tags: + - product:common + post: + description: | + Creates a new import + operationId: CreateImport + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateImportRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/CreateImportResponse' + 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: Create import + tags: + - product:common + /api/v2/imports/{id}: + get: + description: | + Gets an import + operationId: GetImport + parameters: + - in: path + name: id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/GetImportResponse' + 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: Get import + tags: + - product:common + /api/v2/moderation/ban: + post: + description: | + Ban a user from a channel or the entire app + operationId: ban + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BanRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/BanResponse' + description: Successful 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: Ban + tags: + - product:moderation + /api/v2/moderation/bulk_image_moderation: + post: + description: | + Moderate multiple images in bulk using a CSV file + operationId: bulk_image_moderation + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BulkImageModerationRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/BulkImageModerationResponse' + description: Successful 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: Bulk image moderation + tags: + - product:moderation + /api/v2/moderation/check: + post: + description: | + Run moderation checks on the provided content + operationId: check + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CheckRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/CheckResponse' + description: Successful 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: Check + tags: + - product:moderation + /api/v2/moderation/config: + post: + description: | + Create a new moderation configuration or update an existing one. Configure settings for content filtering, AI analysis, toxicity detection, and other moderation features. + operationId: upsert_config + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpsertConfigRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/UpsertConfigResponse' + description: Successful 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: Create or update moderation configuration + tags: + - product:moderation + /api/v2/moderation/config/{key}: + delete: + description: | + Delete a specific moderation policy by its name + operationId: delete_config + parameters: + - in: path + name: key + required: true + schema: + description: Key of the moderation configuration to delete + title: Key + type: string + x-stream-index: "001" + - in: query + name: team + schema: + description: Team associated with the configuration + title: Team + type: string + x-stream-index: "002" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteModerationConfigResponse' + description: Successful 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: Delete a moderation policy + tags: + - product:moderation + get: + description: | + Retrieve a specific moderation configuration by its key and team. This configuration contains settings for various moderation features like toxicity detection, AI analysis, and filtering rules. + operationId: get_config + parameters: + - in: path + name: key + required: true + schema: + description: Key of the moderation configuration to retrieve + title: Key + type: string + x-stream-index: "001" + - in: query + name: team + schema: + description: Team associated with the configuration + title: Team + type: string + x-stream-index: "002" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/GetConfigResponse' + description: Successful 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: Get moderation configuration + tags: + - product:moderation + /api/v2/moderation/configs: + post: + description: | + Search and filter moderation configurations across your application. This endpoint is designed for building moderation dashboards and managing multiple configuration sets. + operationId: query_moderation_configs + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueryModerationConfigsRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/QueryModerationConfigsResponse' + description: Successful 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: Query moderation configurations + tags: + - product:moderation + /api/v2/moderation/custom_check: + post: + description: | + Custom check, add your own AI model reports to the review queue + operationId: custom_check + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CustomCheckRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/CustomCheckResponse' + description: Successful 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: Custom check endpoint + tags: + - product:moderation + /api/v2/moderation/feeds_moderation_template: + delete: + description: | + Delete a specific moderation template by its name + operationId: V2DeleteTemplate + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteModerationTemplateResponse' + description: Successful 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: Delete a moderation template + tags: + - product:moderation + get: + description: | + Retrieve a list of feed moderation templates that define preset moderation rules and configurations. Limited to 100 templates per request. + operationId: V2QueryTemplates + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/QueryFeedModerationTemplatesResponse' + description: Successful 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: Query feed moderation templates + tags: + - product:moderation + post: + description: | + Upsert feeds template for moderation + operationId: V2UpsertTemplate + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpsertModerationTemplateRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/UpsertModerationTemplateResponse' + description: Successful 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: Upsert feeds template + tags: + - product:moderation + /api/v2/moderation/flag: + post: + description: | + Flag any type of content (messages, users, channels, activities) for moderation review. Supports custom content types and additional metadata for flagged content. + operationId: flag + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/FlagRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/FlagResponse' + description: Successful 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: Flag content for moderation + tags: + - product:moderation + /api/v2/moderation/flags: + post: + description: | + Query flags associated with moderation items. This is used for building a moderation dashboard. + operationId: query_moderation_flags + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueryModerationFlagsRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/QueryModerationFlagsResponse' + 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: Query moderation flags + tags: + - product:moderation + /api/v2/moderation/logs: + post: + description: | + Search and filter moderation action logs with support for pagination. View the history of moderation actions taken, including who performed them and when. + operationId: query_moderation_logs + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueryModerationLogsRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/QueryModerationLogsResponse' + description: Successful 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: Query moderation action logs + tags: + - product:moderation + /api/v2/moderation/moderation_rule: + post: + description: | + Create or update a moderation rule that can apply app-wide or to specific moderation configs + operationId: upsert_moderation_rule + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpsertModerationRuleRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/UpsertModerationRuleResponse' + 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: Upsert moderation rule + tags: + - product:moderation + /api/v2/moderation/moderation_rule/{id}: + delete: + description: | + Delete an existing moderation rule + operationId: delete_moderation_rule + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteModerationRuleResponse' + 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: Delete moderation rule + tags: + - product:moderation + get: + description: | + Get a specific moderation rule by ID + operationId: get_moderation_rule + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/GetModerationRuleResponse' + 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: Get moderation rule + tags: + - product:moderation + /api/v2/moderation/moderation_rules: + post: + description: | + Search and filter moderation rules across your application. This endpoint is designed for building moderation dashboards and managing multiple rule sets. + operationId: query_moderation_rules + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueryModerationRulesRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/QueryModerationRulesResponse' + description: Successful 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: Query moderation rules + tags: + - product:moderation + /api/v2/moderation/mute: + post: + description: | + Mute a user. Mutes are generally not visible to the user you mute, while block is something you notice. + operationId: mute + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MuteRequest' + description: MuteRequest + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/MuteResponse' + description: MuteResponse + "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: Mute + tags: + - product:moderation + /api/v2/moderation/review_queue: + post: + description: | + Query review queue items allows you to filter the review queue items. This is used for building a moderation dashboard. + operationId: query_review_queue + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueryReviewQueueRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/QueryReviewQueueResponse' + description: Successful 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: Query review queue items + tags: + - product:moderation + /api/v2/moderation/review_queue/{id}: + get: + description: | + Retrieve a specific review queue item by its ID + operationId: get_review_queue_item + parameters: + - in: path + name: id + required: true + schema: + description: Unique identifier of the review queue item to retrieve + title: ID + type: string + writeOnly: true + x-stream-index: "001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/GetReviewQueueItemResponse' + description: Successful 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: Get review queue item + tags: + - product:moderation + /api/v2/moderation/submit_action: + post: + description: | + Take action on flagged content, such as marking content as safe, deleting content, banning users, or executing custom moderation actions. Supports various action types with configurable parameters. + operationId: submit_action + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SubmitActionRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/SubmitActionResponse' + description: Successful 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: Submit moderation action + tags: + - product:moderation + /api/v2/moderation/unban: + post: + description: | + Unban a user from a channel or globally. + operationId: unban + parameters: + - in: query + name: target_user_id + required: true + schema: + description: ID of the user to unban + title: Target User ID + type: string + writeOnly: true + x-stream-index: "001" + - in: query + name: channel_cid + schema: + description: Channel where the unban applies + title: Channel CID + type: string + writeOnly: true + x-stream-index: "002" + - in: query + name: created_by + schema: + description: ID of the user who created the ban + title: Created By + type: string + writeOnly: true + x-stream-index: "003" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UnbanRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/UnbanResponse' + description: Successful 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: Unban + tags: + - product:moderation + /api/v2/moderation/unmute: + post: + description: | + Unmute a user + operationId: unmute + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UnmuteRequest' + description: UnmuteRequest + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/UnmuteResponse' + description: UnmuteResponse + "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: Unmute a user + tags: + - product:moderation + /api/v2/og: + get: + description: | + Get an OpenGraph attachment for a link + operationId: GetOG + parameters: + - in: query + name: url + required: true + schema: + description: URL to be scraped + title: URL + type: string + writeOnly: true + x-stream-index: "001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/GetOGResponse' + description: Get OG Attachment + "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: Get OG + tags: + - product:common + /api/v2/permissions: + get: + description: | + Lists all available permissions + operationId: ListPermissions + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/ListPermissionsResponse' + 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: List permissions + tags: + - product:common + /api/v2/permissions/{id}: + get: + description: | + Gets custom permission + operationId: GetPermission + parameters: + - in: path + name: id + required: true + schema: + description: Permission ID + title: ID + type: string + writeOnly: true + x-stream-index: "001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/GetCustomPermissionResponse' + 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: Get permission + tags: + - product:common + /api/v2/polls: + post: + description: | + Creates a new poll + operationId: CreatePoll + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePollRequest' + description: Create Poll Request + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/PollResponse' + description: Successful 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: Create poll + tags: + - product:common + put: + description: | + Updates a poll + + Sends events: + - feeds.poll.closed + - feeds.poll.updated + - poll.closed + - poll.updated + operationId: UpdatePoll + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdatePollRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/PollResponse' + description: Successful 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: Update poll + tags: + - product:common + /api/v2/polls/{poll_id}: + delete: + description: | + Deletes a poll + + Sends events: + - feeds.poll.deleted + - poll.deleted + operationId: DeletePoll + parameters: + - in: path + name: poll_id + required: true + schema: + description: Poll ID + maxLength: 255 + title: string + type: string + x-stream-index: "002" + - in: query + name: user_id + schema: + type: string + writeOnly: true + x-stream-index: "001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/Response' + 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: Delete poll + tags: + - product:common + get: + description: | + Retrieves a poll + operationId: GetPoll + parameters: + - in: path + name: poll_id + required: true + schema: + description: Poll ID + maxLength: 255 + title: string + type: string + x-stream-index: "002" + - in: query + name: user_id + schema: + type: string + writeOnly: true + x-stream-index: "001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/PollResponse' + description: Successful 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: Get poll + tags: + - product:common + patch: + description: | + Updates a poll partially + + Sends events: + - feeds.poll.closed + - feeds.poll.updated + - poll.closed + - poll.updated + operationId: UpdatePollPartial + parameters: + - in: path + name: poll_id + required: true + schema: + description: Poll ID + maxLength: 255 + title: string + type: string + x-stream-index: "001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdatePollPartialRequest' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/PollResponse' + description: Successful 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: Partial update poll + tags: + - product:common + /api/v2/polls/{poll_id}/options: + post: + description: | + Creates a poll option + + Sends events: + - feeds.poll.updated + - poll.updated + operationId: CreatePollOption + parameters: + - in: path + name: poll_id + required: true + schema: + description: Poll ID + maxLength: 255 + title: string + type: string + x-stream-index: "001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreatePollOptionRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/PollOptionResponse' + description: Successful 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: Create poll option + tags: + - product:common + put: + description: | + Updates a poll option + + Sends events: + - feeds.poll.updated + - poll.updated + operationId: UpdatePollOption + parameters: + - in: path + name: poll_id + required: true + schema: + description: Poll ID + maxLength: 255 + title: string + type: string + x-stream-index: "001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdatePollOptionRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/PollOptionResponse' + description: Successful 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: Update poll option + tags: + - product:common + /api/v2/polls/{poll_id}/options/{option_id}: + delete: + description: | + Deletes a poll option + + Sends events: + - feeds.poll.updated + - poll.updated + operationId: DeletePollOption + parameters: + - in: path + name: poll_id + required: true + schema: + description: Poll ID + maxLength: 255 + title: string + type: string + x-stream-index: "002" + - in: path + name: option_id + required: true + schema: + description: Option ID + maxLength: 255 + title: string + type: string + x-stream-index: "003" + - in: query + name: user_id + schema: + type: string + writeOnly: true + x-stream-index: "001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/Response' + 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: Delete poll option + tags: + - product:common + get: + description: | + Retrieves a poll option + operationId: GetPollOption + parameters: + - in: path + name: poll_id + required: true + schema: + description: Poll ID + maxLength: 255 + title: string + type: string + x-stream-index: "002" + - in: path + name: option_id + required: true + schema: + description: Option ID + maxLength: 255 + title: string + type: string + x-stream-index: "003" + - in: query + name: user_id + schema: + type: string + writeOnly: true + x-stream-index: "001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/PollOptionResponse' + description: Successful 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: Get poll option + tags: + - product:common + /api/v2/polls/{poll_id}/votes: + post: + description: | + Queries votes + operationId: QueryPollVotes + parameters: + - in: path + name: poll_id + required: true + schema: + description: Poll ID + maxLength: 255 + title: string + type: string + x-stream-index: "002" + - in: query + name: user_id + schema: + type: string + writeOnly: true + x-stream-index: "001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueryPollVotesRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/PollVotesResponse' + description: Successful 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: Query votes + tags: + - product:common + /api/v2/polls/query: + post: + description: | + Queries polls + operationId: QueryPolls + parameters: + - in: query + name: user_id + schema: + type: string + writeOnly: true + x-stream-index: "001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueryPollsRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/QueryPollsResponse' + description: Successful 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: Query polls + tags: + - product:common + /api/v2/push_providers: + get: + description: | + List details of all push providers. + operationId: ListPushProviders + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/ListPushProvidersResponse' + 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: List push providers + tags: + - product:common + post: + description: | + Upsert a push provider for v2 with multi bundle/package support + operationId: UpsertPushProvider + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpsertPushProviderRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/UpsertPushProviderResponse' + 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: Upsert a push provider + tags: + - product:common + /api/v2/push_providers/{type}/{name}: + delete: + description: | + Delete a push provider from v2 with multi bundle/package support. v1 isn't supported in this endpoint + operationId: DeletePushProvider + parameters: + - in: path + name: type + required: true + schema: + enum: + - apn + - firebase + - huawei + - xiaomi + type: string + writeOnly: true + x-stream-index: "001" + - in: path + name: name + required: true + schema: + maxLength: 36 + minLength: 1 + type: string + writeOnly: true + x-stream-index: "002" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/Response' + 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: Delete a push provider + tags: + - product:common + /api/v2/rate_limits: + get: + description: | + Get rate limits usage and quotas + operationId: GetRateLimits + parameters: + - in: query + name: server_side + schema: + description: Whether to include server-side platform limits or not + title: Server-side + type: boolean + writeOnly: true + x-stream-index: "001" + - in: query + name: android + schema: + description: Whether to include Android platform limits or not + title: Android + type: boolean + writeOnly: true + x-stream-index: "002" + - in: query + name: ios + schema: + description: Whether to include iOS platform limits or not + title: iOS + type: boolean + writeOnly: true + x-stream-index: "003" + - in: query + name: web + schema: + description: Whether to include web platform limits or not + title: Web + type: boolean + writeOnly: true + x-stream-index: "004" + - in: query + name: endpoints + schema: + description: Specific endpoints to show limits for, as a comma-separated + list of values + title: Endpoints + type: string + writeOnly: true + x-stream-index: "005" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/GetRateLimitsResponse' + description: Get Rate Limits 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: Get rate limits + tags: + - product:common + /api/v2/roles: + get: + description: | + Lists all available roles + operationId: ListRoles + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/ListRolesResponse' + 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: List roles + tags: + - product:common + post: + description: | + Creates custom role + operationId: CreateRole + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateRoleRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/CreateRoleResponse' + 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: Create role + tags: + - product:common + /api/v2/roles/{name}: + delete: + description: | + Deletes custom role + operationId: DeleteRole + parameters: + - in: path + name: name + required: true + schema: + description: Role name + title: Name + type: string + writeOnly: true + x-stream-index: "001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/Response' + 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: Delete role + tags: + - product:common + /api/v2/tasks/{id}: + get: + description: | + Gets status of a task + operationId: GetTask + parameters: + - in: path + name: id + required: true + schema: + description: Task ID + title: ID + type: string + writeOnly: true + x-stream-index: "001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/GetTaskResponse' + description: Get Task 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: Get status of a task + tags: + - product:common + /api/v2/uploads/file: + delete: + description: | + Deletes previously uploaded file + operationId: DeleteFileGlobal + parameters: + - in: query + name: url + schema: + description: File URL to delete + title: URL + type: string + writeOnly: true + x-stream-index: "001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/Response' + 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: Delete file + tags: + - product:common + x-stream-sdk-name: DeleteFile + post: + description: | + Uploads file + operationId: UploadFileGlobal + requestBody: + content: + multipart/form-data: + schema: + $ref: '#/components/schemas/FileUploadRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/FileUploadResponse' + description: Successful 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: Upload file + tags: + - product:common + x-stream-sdk-name: UploadFile + /api/v2/uploads/image: + delete: + description: | + Deletes previously uploaded image + operationId: DeleteImageGlobal + parameters: + - in: query + name: url + schema: + description: File URL to delete + title: URL + type: string + writeOnly: true + x-stream-index: "001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/Response' + 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: Delete image + tags: + - product:common + x-stream-sdk-name: DeleteImage + post: + description: | + Uploads image + operationId: UploadImageGlobal + requestBody: + content: + multipart/form-data: + schema: + $ref: '#/components/schemas/ImageUploadRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/ImageUploadResponse' + description: Successful 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: Upload image + tags: + - product:common + x-stream-sdk-name: UploadImage + /api/v2/users: + get: + description: | + Find and filter users + operationId: QueryUsers + parameters: + - content: + application/json: + schema: + $ref: '#/components/schemas/QueryUsersPayload' + x-stream-index: "001" + in: query + name: payload + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/QueryUsersResponse' + description: Successful 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: Query users + tags: + - product:common + patch: + description: | + Updates certain fields of the user + + Sends events: + - user.presence.changed + - user.updated + - user.presence.changed + operationId: UpdateUsersPartial + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateUsersPartialRequest' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateUsersResponse' + description: Successful 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: Partially update user + tags: + - product:common + post: + description: | + Update or create users in bulk + + Sends events: + - user.updated + operationId: UpdateUsers + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateUsersRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateUsersResponse' + description: Successful 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: Upsert users + tags: + - product:common + /api/v2/users/{user_id}/deactivate: + post: + description: | + Deactivates user with possibility to activate it back + + Sends events: + - user.deactivated + operationId: DeactivateUser + parameters: + - in: path + name: user_id + required: true + schema: + title: User ID + type: string + writeOnly: true + x-stream-index: "001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeactivateUserRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/DeactivateUserResponse' + description: Successful 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: Deactivate user + tags: + - product:common + /api/v2/users/{user_id}/export: + get: + description: | + Exports the user's profile, reactions and messages. Raises an error if a user has more than 10k messages or reactions + operationId: ExportUser + parameters: + - in: path + name: user_id + required: true + schema: + title: User ID + type: string + x-stream-index: "001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/ExportUserResponse' + description: Successful 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: Export user + tags: + - product:common + /api/v2/users/{user_id}/reactivate: + post: + description: | + Activates user who's been deactivated previously + + Sends events: + - user.reactivated + operationId: ReactivateUser + parameters: + - in: path + name: user_id + required: true + schema: + title: User ID + type: string + x-stream-index: "001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ReactivateUserRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/ReactivateUserResponse' + description: Successful 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: Reactivate user + tags: + - product:common + /api/v2/users/block: + get: + description: | + Get list of blocked Users + operationId: GetBlockedUsers + parameters: + - in: query + name: user_id + schema: + type: string + writeOnly: true + x-stream-index: "002.001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/GetBlockedUsersResponse' + description: Successful 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: Get list of blocked Users + tags: + - product:common + post: + description: | + Block users + operationId: BlockUsers + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BlockUsersRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/BlockUsersResponse' + description: Successful 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: Block user + tags: + - product:common + /api/v2/users/deactivate: + post: + description: | + Deactivate users in batches + + Sends events: + - user.deactivated + operationId: DeactivateUsers + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeactivateUsersRequest' + description: DeactivateUsersRequest + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/DeactivateUsersResponse' + 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: Deactivate users + tags: + - product:common + /api/v2/users/delete: + post: + description: | + Deletes users and optionally all their belongings asynchronously. + + Sends events: + - channel.deleted + - user.deleted + operationId: DeleteUsers + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteUsersRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteUsersResponse' + description: Successful 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: Delete Users + tags: + - product:common + /api/v2/users/live_locations: + get: + description: | + Retrieves all active live locations for a user + operationId: GetUserLiveLocations + parameters: + - in: query + name: user_id + schema: + description: User ID to get live locations for. If not provided, returns + live locations for the authenticated user. + title: string + type: string + writeOnly: true + x-stream-index: "001.001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/SharedLocationsResponse' + description: Successful 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: Get user live locations + tags: + - product:common + put: + description: | + Updates an existing live location with new coordinates or expiration time + operationId: UpdateLiveLocation + parameters: + - in: query + name: user_id + schema: + type: string + writeOnly: true + x-stream-index: "005.001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateLiveLocationRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/SharedLocationResponse' + description: Successful 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: Update live location + tags: + - product:common + /api/v2/users/reactivate: + post: + description: | + Reactivate users in batches + + Sends events: + - user.reactivated + - user.reactivated + operationId: ReactivateUsers + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ReactivateUsersRequest' + description: ReactivateUsersRequest + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/ReactivateUsersResponse' + 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: Reactivate users + tags: + - product:common + /api/v2/users/restore: + post: + description: | + Restore soft deleted users + operationId: RestoreUsers + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RestoreUsersRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/Response' + 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: Restore users + tags: + - product:common + /api/v2/users/unblock: + post: + description: | + Unblock users + operationId: UnblockUsers + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UnblockUsersRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/UnblockUsersResponse' + description: Successful 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: Unblock user + tags: + - product:common +security: +- JWT: [] + api_key: [] + stream-auth-type: [] +- api_key: [] + stream-auth-type: [] +servers: +- description: Stream API + url: https://chat.stream-io-api.com diff --git a/openapi/v2/moderation-clientside-api.json b/openapi/v2/moderation-clientside-api.json index 3b8a9eab5..4859b368e 100644 --- a/openapi/v2/moderation-clientside-api.json +++ b/openapi/v2/moderation-clientside-api.json @@ -1 +1 @@ -{"components":{"schemas":{"AIImageConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"ocr_rules":{"items":{"$ref":"#/components/schemas/OCRRule"},"type":"array","x-stream-index":"004"},"rules":{"items":{"$ref":"#/components/schemas/AWSRekognitionRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules","ocr_rules"],"type":"object"},"AITextConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"profile":{"type":"string","x-stream-index":"003"},"rules":{"items":{"$ref":"#/components/schemas/BodyguardRule"},"type":"array","x-stream-index":"004"},"severity_rules":{"items":{"$ref":"#/components/schemas/BodyguardSeverityRule"},"type":"array","x-stream-index":"005"}},"required":["enabled","profile","rules","severity_rules"],"type":"object"},"AIVideoConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AWSRekognitionRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"APIError":{"nullable":true,"properties":{"StatusCode":{"description":"Response HTTP status code","format":"int32","title":"Status code","type":"integer","x-stream-index":"004"},"code":{"description":"API error code","format":"int32","title":"Code","type":"integer","x-stream-index":"001"},"details":{"description":"Additional error-specific information","items":{"type":"integer"},"title":"Details","type":"array","x-stream-index":"007"},"duration":{"description":"Request duration","title":"Duration","type":"string","x-stream-index":"005"},"exception_fields":{"additionalProperties":{"type":"string"},"description":"Additional error info","title":"Exception fields","type":"object","x-stream-index":"003"},"message":{"description":"Message describing an error","title":"Message","type":"string","x-stream-index":"002"},"more_info":{"description":"URL with additional information","title":"More info","type":"string","x-stream-index":"006"},"unrecoverable":{"description":"Flag that indicates if the error is unrecoverable, requests that return unrecoverable errors should not be retried, this error only applies to the request that caused it","title":"Unrecoverable","type":"boolean","x-stream-index":"008"}},"required":["code","message","StatusCode","duration","more_info","details"],"title":"Error response","type":"object"},"APNS":{"properties":{"body":{"type":"string","x-stream-index":"002"},"content-available":{"format":"int32","type":"integer","x-stream-index":"004"},"data":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"mutable-content":{"format":"int32","type":"integer","x-stream-index":"005"},"sound":{"type":"string","x-stream-index":"003"},"title":{"type":"string","x-stream-index":"001"}},"required":["title","body"],"type":"object"},"AWSRekognitionRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"},"min_confidence":{"format":"float","maximum":100,"minimum":0,"type":"number","x-stream-index":"003"}},"required":["label","action","min_confidence"],"type":"object"},"Action":{"nullable":true,"properties":{"name":{"type":"string","x-stream-index":"001"},"style":{"type":"string","x-stream-index":"003"},"text":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"004"},"value":{"type":"string","x-stream-index":"005"}},"required":["name","text","type"],"type":"object"},"ActionLog":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"002"},"reason":{"type":"string","x-stream-index":"008"},"reporter_type":{"type":"string","x-stream-index":"009"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"014"},"review_queue_item_id":{"type":"string","x-stream-index":"012"},"target_user":{"$ref":"#/components/schemas/User","x-stream-index":"013"},"target_user_id":{"type":"string","x-stream-index":"011"},"type":{"type":"string","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007"}},"required":["id","created_at","type","reason","reporter_type","custom","target_user_id","review_queue_item_id"],"type":"object"},"ActionLogResponse":{"nullable":true,"properties":{"created_at":{"description":"Timestamp when the action was taken","format":"date-time","title":"Created At","type":"number","x-stream-index":"002"},"custom":{"additionalProperties":{},"description":"Additional metadata about the action","title":"Custom","type":"object","x-stream-index":"007"},"id":{"description":"Unique identifier of the action log","title":"ID","type":"string","x-stream-index":"001"},"reason":{"description":"Reason for the moderation action","title":"Reason","type":"string","x-stream-index":"006"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"Associated review queue item","title":"Review Queue Item","x-stream-index":"008"},"target_user":{"$ref":"#/components/schemas/UserResponse","description":"User who was the target of the action","title":"Target User","x-stream-index":"009"},"target_user_id":{"description":"ID of the user who was the target of the action","title":"Target User ID","type":"string","x-stream-index":"010"},"type":{"description":"Type of moderation action","title":"Type","type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who performed the action","title":"User","x-stream-index":"004"},"user_id":{"description":"ID of the user who performed the action","title":"User ID","type":"string","x-stream-index":"005"}},"required":["id","created_at","type","user_id","reason","custom","target_user_id"],"type":"object"},"ActionSequence":{"properties":{"action":{"type":"string","x-stream-index":"001"},"blur":{"type":"boolean","x-stream-index":"005"},"cooldown_period":{"format":"int32","type":"integer","x-stream-index":"004"},"threshold":{"format":"int32","type":"integer","x-stream-index":"002"},"time_window":{"format":"int32","type":"integer","x-stream-index":"003"},"warning":{"type":"boolean","x-stream-index":"006"},"warning_text":{"type":"string","x-stream-index":"007"}},"required":["action","threshold","time_window","cooldown_period","blur","warning","warning_text"],"type":"object"},"Attachment":{"description":"An attachment is a message object that represents a file uploaded by a user.","nullable":true,"properties":{"actions":{"items":{"$ref":"#/components/schemas/Action"},"type":"array","x-stream-index":"015"},"asset_url":{"type":"string","x-stream-index":"017"},"author_icon":{"type":"string","x-stream-index":"007"},"author_link":{"type":"string","x-stream-index":"006"},"author_name":{"type":"string","x-stream-index":"005"},"color":{"type":"string","x-stream-index":"003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"018"},"fallback":{"type":"string","x-stream-index":"002"},"fields":{"items":{"$ref":"#/components/schemas/Field"},"type":"array","x-stream-index":"016"},"footer":{"type":"string","x-stream-index":"013"},"footer_icon":{"type":"string","x-stream-index":"014"},"giphy":{"$ref":"#/components/schemas/Images","x-stream-index":"019"},"image_url":{"type":"string","x-stream-index":"011"},"og_scrape_url":{"type":"string","x-stream-index":"020"},"original_height":{"format":"int32","type":"integer","x-stream-index":"022"},"original_width":{"format":"int32","type":"integer","x-stream-index":"021"},"pretext":{"type":"string","x-stream-index":"004"},"text":{"type":"string","x-stream-index":"010"},"thumb_url":{"type":"string","x-stream-index":"012"},"title":{"type":"string","x-stream-index":"008"},"title_link":{"type":"string","x-stream-index":"009"},"type":{"description":"Attachment type (e.g. image, video, url)","title":"Type","type":"string","x-stream-index":"001"}},"required":["custom"],"title":"Attachment","type":"object","x-stream-docs-page-id":"file_uploads"},"AudioSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"001"},"default_device":{"enum":["speaker","earpiece"],"type":"string","x-stream-index":"006"},"mic_default_on":{"type":"boolean","x-stream-index":"004"},"noise_cancellation":{"$ref":"#/components/schemas/NoiseCancellationSettings","x-stream-index":"007"},"opus_dtx_enabled":{"type":"boolean","x-stream-index":"002"},"redundant_coding_enabled":{"type":"boolean","x-stream-index":"003"},"speaker_default_on":{"type":"boolean","x-stream-index":"005"}},"required":["access_request_enabled","opus_dtx_enabled","redundant_coding_enabled","mic_default_on","speaker_default_on","default_device"],"type":"object"},"AudioSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"001"},"default_device":{"enum":["speaker","earpiece"],"type":"string","x-stream-index":"006"},"mic_default_on":{"type":"boolean","x-stream-index":"004"},"noise_cancellation":{"$ref":"#/components/schemas/NoiseCancellationSettings","x-stream-index":"007"},"opus_dtx_enabled":{"type":"boolean","x-stream-index":"002"},"redundant_coding_enabled":{"type":"boolean","x-stream-index":"003"},"speaker_default_on":{"type":"boolean","x-stream-index":"005"}},"required":["access_request_enabled","opus_dtx_enabled","redundant_coding_enabled","mic_default_on","speaker_default_on","default_device"],"type":"object"},"AutomodPlatformCircumventionConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AutomodRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"AutomodRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"003"},"label":{"type":"string","x-stream-index":"001"},"threshold":{"format":"float","maximum":1,"minimum":0,"type":"number","x-stream-index":"002"}},"required":["label","threshold","action"],"type":"object"},"AutomodSemanticFiltersConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AutomodSemanticFiltersRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"AutomodSemanticFiltersRule":{"properties":{"action":{"enum":["flag","shadow","remove"],"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"threshold":{"format":"float","maximum":1,"minimum":0,"type":"number","x-stream-index":"002"}},"required":["name","threshold","action"],"type":"object"},"AutomodToxicityConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AutomodRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"BackstageSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"BackstageSettingsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"Ban":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"012"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"011"},"expires":{"format":"date-time","type":"number","x-stream-index":"007"},"reason":{"type":"string","x-stream-index":"008"},"shadow":{"type":"boolean","x-stream-index":"009"},"target":{"$ref":"#/components/schemas/User","x-stream-index":"006"}},"required":["shadow","created_at"],"type":"object"},"BanActionRequest":{"properties":{"channel_ban_only":{"type":"boolean","x-stream-index":"003"},"delete_messages":{"enum":["soft","pruning","hard"],"type":"string","x-stream-index":"005"},"ip_ban":{"type":"boolean","x-stream-index":"004"},"reason":{"type":"string","x-stream-index":"002"},"shadow":{"type":"boolean","x-stream-index":"001"},"timeout":{"format":"int32","type":"integer","x-stream-index":"006"}},"type":"object"},"BanOptions":{"properties":{"duration":{"format":"int32","type":"integer","x-stream-index":"001"},"ip_ban":{"type":"boolean","x-stream-index":"004"},"reason":{"type":"string","x-stream-index":"002"},"shadow_ban":{"type":"boolean","x-stream-index":"003"}},"required":["duration","reason","shadow_ban","ip_ban"],"type":"object"},"BanRequest":{"nullable":true,"properties":{"banned_by":{"$ref":"#/components/schemas/UserRequest","description":"Details about the user performing the ban","title":"Banned By","x-stream-index":"008"},"banned_by_id":{"description":"ID of the user performing the ban","title":"Banned By ID","type":"string","x-stream-index":"007"},"channel_cid":{"description":"Channel where the ban applies","title":"Channel CID","type":"string","x-stream-index":"004"},"delete_messages":{"enum":["soft","pruning","hard"],"type":"string","x-stream-index":"009"},"ip_ban":{"description":"Whether to ban the user's IP address","title":"IP Ban","type":"boolean","x-stream-index":"006"},"reason":{"description":"Optional explanation for the ban","title":"Reason","type":"string","x-stream-index":"003"},"shadow":{"description":"Whether this is a shadow ban","title":"Shadow","type":"boolean","x-stream-index":"005"},"target_user_id":{"description":"ID of the user to ban","title":"Target User ID","type":"string","x-stream-index":"001"},"timeout":{"description":"Duration of the ban in minutes","minimum":0,"title":"Timeout","type":"integer","x-stream-index":"002"}},"required":["target_user_id"],"type":"object"},"BanResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"BlockContentOptions":{"properties":{"reason":{"type":"string","x-stream-index":"001"}},"required":["reason"],"type":"object"},"BlockListConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/BlockListRule"},"maximum":10,"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"BlockListOptions":{"properties":{"behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"002"},"blocklist":{"type":"string","x-stream-index":"001"}},"required":["blocklist","behavior"],"type":"object"},"BlockListRule":{"properties":{"action":{"enum":["flag","mask_flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"002"}},"required":["name","team","action"],"type":"object"},"BodyguardRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"},"severity_rules":{"items":{"$ref":"#/components/schemas/BodyguardSeverityRule"},"type":"array","x-stream-index":"003"}},"required":["label","action","severity_rules"],"type":"object"},"BodyguardSeverityRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"severity":{"enum":["low","medium","high","critical"],"type":"string","x-stream-index":"001"}},"required":["severity","action"],"type":"object"},"BroadcastSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettings","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettings","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"BroadcastSettingsResponse":{"description":"BroadcastSettingsResponse is the payload for broadcasting settings","properties":{"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettingsResponse","title":"HLS","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettingsResponse","title":"RTMP","x-stream-index":"003"}},"required":["enabled","hls","rtmp"],"title":"BroadcastSettingsResponse","type":"object"},"Call":{"properties":{"AppPK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"002"},"Backstage":{"type":"boolean","writeOnly":true,"x-stream-index":"023"},"BlockedUserIDs":{"items":{"type":"string"},"type":"array","writeOnly":true,"x-stream-index":"018"},"BlockedUsers":{"items":{"$ref":"#/components/schemas/User"},"type":"array","writeOnly":true,"x-stream-index":"019"},"CID":{"type":"string","writeOnly":true,"x-stream-index":"005"},"CallType":{"$ref":"#/components/schemas/CallType","x-stream-index":"020"},"ChannelCID":{"type":"string","writeOnly":true,"x-stream-index":"032"},"CreatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"013"},"CreatedBy":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"CreatedByUserID":{"type":"string","writeOnly":true,"x-stream-index":"007"},"CurrentSessionID":{"type":"string","writeOnly":true,"x-stream-index":"024"},"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"012"},"DeletedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"028"},"EgressUpdatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"027"},"Egresses":{"items":{"$ref":"#/components/schemas/CallEgress"},"type":"array","writeOnly":true,"x-stream-index":"015"},"EndedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"017"},"ID":{"type":"string","writeOnly":true,"x-stream-index":"004"},"JoinAheadTimeSeconds":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"031"},"LastHeartbeatAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"030"},"LastSessionID":{"type":"string","writeOnly":true,"x-stream-index":"025"},"MemberCount":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"010"},"MemberLookup":{"$ref":"#/components/schemas/MemberLookup","x-stream-index":"011"},"Members":{"items":{"$ref":"#/components/schemas/CallMember"},"type":"array","writeOnly":true,"x-stream-index":"009"},"Session":{"$ref":"#/components/schemas/CallSession","x-stream-index":"026"},"Settings":{"$ref":"#/components/schemas/CallSettings","x-stream-index":"022"},"SettingsOverrides":{"$ref":"#/components/schemas/CallSettings","x-stream-index":"021"},"StartsAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"016"},"Team":{"type":"string","writeOnly":true,"x-stream-index":"006"},"ThumbnailURL":{"type":"string","writeOnly":true,"x-stream-index":"029"},"Type":{"type":"string","writeOnly":true,"x-stream-index":"003"},"UpdatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"014"}},"required":["AppPK","Type","ID","CID","Team","CreatedByUserID","Members","Custom","CreatedAt","UpdatedAt","Egresses","BlockedUserIDs","BlockedUsers","Backstage","CurrentSessionID","LastSessionID","ThumbnailURL","ChannelCID"],"type":"object"},"CallEgress":{"nullable":true,"properties":{"app_pk":{"format":"int32","type":"integer","x-stream-index":"002"},"call_id":{"type":"string","x-stream-index":"004"},"call_type":{"type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/EgressTaskConfig","x-stream-index":"007"},"egress_id":{"type":"string","x-stream-index":"005"},"egress_type":{"type":"string","x-stream-index":"006"},"instance_ip":{"type":"string","x-stream-index":"008"},"started_at":{"format":"date-time","type":"number","x-stream-index":"010"},"state":{"type":"string","x-stream-index":"009"},"stopped_at":{"format":"date-time","type":"number","x-stream-index":"011"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"012"}},"required":["app_pk","call_type","call_id","egress_id","egress_type","instance_ip","state","started_at","updated_at"],"type":"object"},"CallIngressResponse":{"description":"CallIngressResponse is the payload for ingress settings","properties":{"rtmp":{"$ref":"#/components/schemas/RTMPIngress","title":"RTMP","x-stream-index":"001"}},"required":["rtmp"],"title":"CallIngressResponse","type":"object"},"CallMember":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"010"},"role":{"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["user_id","role","custom","created_at","updated_at"],"type":"object"},"CallParticipant":{"nullable":true,"properties":{"JoinedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"004"},"Role":{"type":"string","writeOnly":true,"x-stream-index":"002"},"UserSessionID":{"type":"string","writeOnly":true,"x-stream-index":"003"},"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"001.046"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"001.017"},"banned":{"type":"boolean","x-stream-index":"001.016"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.013"},"id":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"001.023"},"language":{"type":"string","x-stream-index":"001.035"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"001.022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"001.026"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.042"},"role":{"type":"string","x-stream-index":"001.004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.005"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.009"}},"required":["id","role","teams_role","custom","banned","online","Role","UserSessionID","JoinedAt"],"type":"object"},"CallParticipantResponse":{"properties":{"joined_at":{"format":"date-time","type":"number","x-stream-index":"004"},"role":{"type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"},"user_session_id":{"type":"string","x-stream-index":"002"}},"required":["user","user_session_id","role","joined_at"],"type":"object"},"CallResponse":{"description":"Represents a call","properties":{"backstage":{"type":"boolean","x-stream-index":"016"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"018"},"captioning":{"type":"boolean","x-stream-index":"013"},"channel_cid":{"type":"string","x-stream-index":"024"},"cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"The user that created the call","title":"Created By","x-stream-index":"007"},"current_session_id":{"type":"string","x-stream-index":"005"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"008"},"egress":{"$ref":"#/components/schemas/EgressResponse","x-stream-index":"021"},"ended_at":{"description":"Date/time when the call ended","format":"date-time","title":"Ended At","type":"number","x-stream-index":"014"},"id":{"description":"Call ID","title":"ID","type":"string","x-stream-index":"003"},"ingress":{"$ref":"#/components/schemas/CallIngressResponse","x-stream-index":"019"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"023"},"recording":{"type":"boolean","x-stream-index":"011"},"session":{"$ref":"#/components/schemas/CallSessionResponse","x-stream-index":"020"},"settings":{"$ref":"#/components/schemas/CallSettingsResponse","x-stream-index":"017"},"starts_at":{"description":"Date/time when the call will start","format":"date-time","title":"Starts At","type":"number","x-stream-index":"015"},"team":{"type":"string","x-stream-index":"006"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailResponse","x-stream-index":"022"},"transcribing":{"type":"boolean","x-stream-index":"012"},"type":{"description":"The type of call","title":"Type","type":"string","x-stream-index":"002"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"}},"required":["type","id","cid","current_session_id","created_by","custom","created_at","updated_at","recording","transcribing","captioning","backstage","settings","blocked_user_ids","ingress","egress"],"title":"CallResponse","type":"object"},"CallSession":{"properties":{"AcceptedBy":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","writeOnly":true,"x-stream-index":"008"},"ActiveSFUs":{"items":{"$ref":"#/components/schemas/SFUIDLastSeen"},"type":"array","writeOnly":true,"x-stream-index":"016"},"AnonymousParticipantCount":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"019"},"AppPK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"002.001"},"CallID":{"type":"string","writeOnly":true,"x-stream-index":"002.003"},"CallType":{"type":"string","writeOnly":true,"x-stream-index":"002.002"},"CreatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"003"},"DeletedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"004"},"EndedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"006"},"LiveEndedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"013"},"LiveStartedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"012"},"MissedBy":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","writeOnly":true,"x-stream-index":"010"},"Participants":{"items":{"$ref":"#/components/schemas/CallParticipant"},"type":"array","writeOnly":true,"x-stream-index":"011"},"ParticipantsCountByRole":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","writeOnly":true,"x-stream-index":"018"},"RejectedBy":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","writeOnly":true,"x-stream-index":"009"},"RingAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"007"},"SFUIDs":{"items":{"type":"string"},"type":"array","writeOnly":true,"x-stream-index":"015"},"SessionID":{"type":"string","writeOnly":true,"x-stream-index":"002.004"},"StartedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"005"},"TimerEndsAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"014"},"UserPermissionOverrides":{"additionalProperties":{"additionalProperties":{"type":"boolean"},"type":"object"},"type":"object","writeOnly":true,"x-stream-index":"017"}},"required":["AppPK","CallType","CallID","SessionID","CreatedAt","AcceptedBy","RejectedBy","MissedBy","Participants","SFUIDs","ActiveSFUs","UserPermissionOverrides","ParticipantsCountByRole","AnonymousParticipantCount"],"type":"object"},"CallSessionResponse":{"properties":{"accepted_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"008"},"anonymous_participant_count":{"format":"int32","type":"integer","x-stream-index":"006"},"ended_at":{"format":"date-time","type":"number","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"live_ended_at":{"format":"date-time","type":"number","x-stream-index":"011"},"live_started_at":{"format":"date-time","type":"number","x-stream-index":"010"},"missed_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"009"},"participants":{"items":{"$ref":"#/components/schemas/CallParticipantResponse"},"type":"array","x-stream-index":"004"},"participants_count_by_role":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"005"},"rejected_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"007"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002"},"timer_ends_at":{"format":"date-time","type":"number","x-stream-index":"012"}},"required":["id","participants","participants_count_by_role","anonymous_participant_count","rejected_by","accepted_by","missed_by"],"type":"object"},"CallSettings":{"properties":{"audio":{"$ref":"#/components/schemas/AudioSettings","x-stream-index":"001"},"backstage":{"$ref":"#/components/schemas/BackstageSettings","x-stream-index":"002"},"broadcasting":{"$ref":"#/components/schemas/BroadcastSettings","x-stream-index":"007"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordSettings","x-stream-index":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettings","x-stream-index":"008"},"ingress":{"$ref":"#/components/schemas/IngressSettings","x-stream-index":"014"},"limits":{"$ref":"#/components/schemas/LimitsSettings","x-stream-index":"012"},"recording":{"$ref":"#/components/schemas/RecordSettings","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettings","x-stream-index":"010"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettings","x-stream-index":"004"},"session":{"$ref":"#/components/schemas/SessionSettings","x-stream-index":"013"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettings","x-stream-index":"011"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettings","x-stream-index":"009"},"video":{"$ref":"#/components/schemas/VideoSettings","x-stream-index":"003"}},"type":"object"},"CallSettingsResponse":{"properties":{"audio":{"$ref":"#/components/schemas/AudioSettingsResponse","x-stream-index":"001"},"backstage":{"$ref":"#/components/schemas/BackstageSettingsResponse","x-stream-index":"002"},"broadcasting":{"$ref":"#/components/schemas/BroadcastSettingsResponse","x-stream-index":"003"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordingSettingsResponse","x-stream-index":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettingsResponse","x-stream-index":"004"},"ingress":{"$ref":"#/components/schemas/IngressSettingsResponse","x-stream-index":"014"},"limits":{"$ref":"#/components/schemas/LimitsSettingsResponse","x-stream-index":"012"},"recording":{"$ref":"#/components/schemas/RecordSettingsResponse","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettingsResponse","x-stream-index":"007"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettingsResponse","x-stream-index":"008"},"session":{"$ref":"#/components/schemas/SessionSettingsResponse","x-stream-index":"013"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettingsResponse","x-stream-index":"011"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettingsResponse","x-stream-index":"009"},"video":{"$ref":"#/components/schemas/VideoSettingsResponse","x-stream-index":"010"}},"required":["audio","backstage","broadcasting","geofencing","recording","frame_recording","ring","screensharing","transcription","video","thumbnails","limits","session"],"type":"object"},"CallType":{"properties":{"AppPK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"003"},"CreatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"005"},"ExternalStorage":{"type":"string","writeOnly":true,"x-stream-index":"009"},"Name":{"type":"string","writeOnly":true,"x-stream-index":"004"},"NotificationSettings":{"$ref":"#/components/schemas/NotificationSettings","x-stream-index":"008"},"PK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"002"},"Settings":{"$ref":"#/components/schemas/CallSettings","x-stream-index":"007"},"UpdatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"006"}},"required":["PK","AppPK","Name","CreatedAt","UpdatedAt","ExternalStorage"],"type":"object"},"Channel":{"properties":{"active_live_locations":{"items":{"$ref":"#/components/schemas/SharedLocation"},"type":"array","x-stream-index":"034"},"auto_translation_enabled":{"type":"boolean","x-stream-index":"029"},"auto_translation_language":{"type":"string","x-stream-index":"030"},"cid":{"type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/ChannelConfig","x-stream-index":"026"},"config_overrides":{"$ref":"#/components/schemas/ConfigOverrides","x-stream-index":"027"},"cooldown":{"format":"int32","type":"integer","x-stream-index":"031"},"created_at":{"format":"date-time","type":"number","x-stream-index":"009"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"019"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"disabled":{"type":"boolean","x-stream-index":"017"},"frozen":{"type":"boolean","x-stream-index":"016"},"id":{"type":"string","x-stream-index":"004"},"invites":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"022"},"last_campaigns":{"type":"string","x-stream-index":"032"},"last_message_at":{"format":"date-time","type":"number","x-stream-index":"006"},"member_count":{"format":"int32","type":"integer","x-stream-index":"021"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"020"},"team":{"type":"string","x-stream-index":"028"},"truncated_by":{"$ref":"#/components/schemas/User","x-stream-index":"015"},"type":{"type":"string","x-stream-index":"005"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"010"}},"required":["cid","id","type","created_at","updated_at","frozen","disabled","custom","auto_translation_language"],"type":"object"},"ChannelConfig":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.026"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.021"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.022"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.027"},"blocklist":{"type":"string","x-stream-index":"001.023"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.024"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.025"},"commands":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"connect_events":{"type":"boolean","x-stream-index":"001.004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"custom_events":{"type":"boolean","x-stream-index":"001.012"},"mark_messages_pending":{"type":"boolean","x-stream-index":"001.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"001.020"},"mutes":{"type":"boolean","x-stream-index":"001.009"},"name":{"type":"string","x-stream-index":"001.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"001.028"},"partition_ttl":{"type":"integer","x-stream-index":"001.029"},"polls":{"type":"boolean","x-stream-index":"001.016"},"push_notifications":{"type":"boolean","x-stream-index":"001.013"},"quotes":{"type":"boolean","x-stream-index":"001.008"},"reactions":{"type":"boolean","x-stream-index":"001.006"},"read_events":{"type":"boolean","x-stream-index":"001.003"},"reminders":{"type":"boolean","x-stream-index":"001.014"},"replies":{"type":"boolean","x-stream-index":"001.007"},"search":{"type":"boolean","x-stream-index":"001.005"},"shared_locations":{"type":"boolean","x-stream-index":"001.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.030"},"typing_events":{"type":"boolean","x-stream-index":"001.002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"002.004"},"uploads":{"type":"boolean","x-stream-index":"001.010"},"url_enrichment":{"type":"boolean","x-stream-index":"001.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"001.017"}},"required":["name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","created_at","updated_at","commands"],"type":"object"},"ChannelConfigWithInfo":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.002.026"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.002.021"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.022"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.002.027"},"blocklist":{"type":"string","x-stream-index":"001.002.023"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.024"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.002.025"},"commands":{"items":{"$ref":"#/components/schemas/Command"},"type":"array","x-stream-index":"001.003"},"connect_events":{"type":"boolean","x-stream-index":"001.002.004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.001.003"},"custom_events":{"type":"boolean","x-stream-index":"001.002.012"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"002"},"mark_messages_pending":{"type":"boolean","x-stream-index":"001.002.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"001.002.020"},"mutes":{"type":"boolean","x-stream-index":"001.002.009"},"name":{"type":"string","x-stream-index":"001.002.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"001.002.028"},"partition_ttl":{"type":"integer","x-stream-index":"001.002.029"},"polls":{"type":"boolean","x-stream-index":"001.002.016"},"push_notifications":{"type":"boolean","x-stream-index":"001.002.013"},"quotes":{"type":"boolean","x-stream-index":"001.002.008"},"reactions":{"type":"boolean","x-stream-index":"001.002.006"},"read_events":{"type":"boolean","x-stream-index":"001.002.003"},"reminders":{"type":"boolean","x-stream-index":"001.002.014"},"replies":{"type":"boolean","x-stream-index":"001.002.007"},"search":{"type":"boolean","x-stream-index":"001.002.005"},"shared_locations":{"type":"boolean","x-stream-index":"001.002.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.002.030"},"typing_events":{"type":"boolean","x-stream-index":"001.002.002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"uploads":{"type":"boolean","x-stream-index":"001.002.010"},"url_enrichment":{"type":"boolean","x-stream-index":"001.002.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"001.002.017"}},"required":["created_at","updated_at","name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","commands"],"type":"object"},"ChannelMember":{"nullable":true,"properties":{"archived_at":{"format":"date-time","type":"number","x-stream-index":"021"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"017"},"banned":{"type":"boolean","x-stream-index":"016"},"channel_role":{"type":"string","x-stream-index":"024"},"created_at":{"format":"date-time","type":"number","x-stream-index":"012"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"014"},"invite_accepted_at":{"format":"date-time","type":"number","x-stream-index":"009"},"invite_rejected_at":{"format":"date-time","type":"number","x-stream-index":"010"},"invited":{"type":"boolean","x-stream-index":"008"},"is_global_banned":{"type":"boolean","x-stream-index":"020"},"is_moderator":{"type":"boolean","x-stream-index":"007"},"notifications_muted":{"type":"boolean","x-stream-index":"026"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"022"},"shadow_banned":{"type":"boolean","x-stream-index":"019"},"status":{"type":"string","x-stream-index":"011"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"013"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["custom","created_at","updated_at","banned","shadow_banned","is_global_banned","channel_role","notifications_muted"],"type":"object"},"ChannelMute":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"007"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"expires":{"description":"Date/time of mute expiration","format":"date-time","title":"Expires","type":"number","x-stream-index":"008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/User","description":"Owner of channel mute","title":"User","x-stream-index":"005"}},"required":["created_at","updated_at"],"type":"object"},"ChannelResponse":{"properties":{"auto_translation_enabled":{"type":"boolean","x-stream-index":"021"},"auto_translation_language":{"type":"string","x-stream-index":"022"},"blocked":{"type":"boolean","x-stream-index":"027"},"cid":{"type":"string","x-stream-index":"005"},"config":{"$ref":"#/components/schemas/ChannelConfigWithInfo","x-stream-index":"017"},"cooldown":{"format":"int32","type":"integer","x-stream-index":"024"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"011"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"030"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"010"},"disabled":{"type":"boolean","x-stream-index":"013"},"frozen":{"type":"boolean","x-stream-index":"012"},"hidden":{"type":"boolean","x-stream-index":"026"},"hide_messages_before":{"format":"date-time","type":"number","x-stream-index":"023"},"id":{"type":"string","x-stream-index":"003"},"last_message_at":{"format":"date-time","type":"number","x-stream-index":"006"},"member_count":{"format":"int32","type":"integer","x-stream-index":"015"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"014"},"mute_expires_at":{"format":"date-time","type":"number","x-stream-index":"019"},"muted":{"type":"boolean","x-stream-index":"018"},"own_capabilities":{"items":{"type":"string"},"type":"array","x-stream-index":"025"},"team":{"type":"string","x-stream-index":"020"},"truncated_at":{"format":"date-time","type":"number","x-stream-index":"028"},"truncated_by":{"$ref":"#/components/schemas/User","x-stream-index":"029"},"type":{"type":"string","x-stream-index":"004"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"}},"required":["id","type","cid","created_at","updated_at","frozen","disabled","custom"],"type":"object"},"Command":{"description":"Represents custom chat command","nullable":true,"properties":{"args":{"description":"Arguments help text, shown in commands auto-completion","title":"Arguments","type":"string","x-stream-index":"006"},"created_at":{"description":"Date/time of creation","format":"date-time","readOnly":true,"title":"Created at","type":"number","x-stream-index":"001"},"description":{"description":"Description, shown in commands auto-completion","title":"Description","type":"string","x-stream-index":"005"},"name":{"description":"Unique command name","title":"Name","type":"string","x-stream-index":"004"},"set":{"description":"Set name used for grouping commands","title":"Set","type":"string","x-stream-index":"007"},"updated_at":{"description":"Date/time of the last update","format":"date-time","readOnly":true,"title":"Updated at","type":"number","x-stream-index":"002"}},"required":["name","description","args","set"],"title":"Command","type":"object"},"CompositeAppSettings":{"properties":{"json_encoded_settings":{"type":"string","x-stream-index":"005"},"url":{"type":"string","x-stream-index":"004"}},"type":"object"},"ConfigOverrides":{"properties":{"blocklist":{"type":"string","x-stream-index":"008"},"blocklist_behavior":{"enum":["flag","block"],"type":"string","x-stream-index":"009"},"commands":{"items":{"type":"string"},"type":"array","x-stream-index":"011"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"010"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"007"},"quotes":{"type":"boolean","x-stream-index":"004"},"reactions":{"type":"boolean","x-stream-index":"002"},"replies":{"type":"boolean","x-stream-index":"003"},"shared_locations":{"type":"boolean","x-stream-index":"013"},"typing_events":{"type":"boolean","x-stream-index":"001"},"uploads":{"type":"boolean","x-stream-index":"005"},"url_enrichment":{"type":"boolean","x-stream-index":"006"},"user_message_reminders":{"type":"boolean","x-stream-index":"012"}},"required":["grants","commands"],"type":"object"},"ConfigResponse":{"properties":{"ai_image_config":{"$ref":"#/components/schemas/AIImageConfig","description":"Configuration for AI image analysis","title":"AI Image Config","x-stream-index":"009"},"ai_text_config":{"$ref":"#/components/schemas/AITextConfig","description":"Configuration for AI text analysis","title":"AI Text Config","x-stream-index":"008"},"ai_video_config":{"$ref":"#/components/schemas/AIVideoConfig","description":"Configuration for AI video analysis","title":"AI Video Config","x-stream-index":"010"},"async":{"description":"Whether moderation should be performed asynchronously","title":"Async","type":"boolean","x-stream-index":"003"},"automod_platform_circumvention_config":{"$ref":"#/components/schemas/AutomodPlatformCircumventionConfig","description":"Configuration for platform circumvention detection","title":"Automod Platform Circumvention Config","x-stream-index":"005"},"automod_semantic_filters_config":{"$ref":"#/components/schemas/AutomodSemanticFiltersConfig","description":"Configuration for semantic filtering","title":"Automod Semantic Filters Config","x-stream-index":"006"},"automod_toxicity_config":{"$ref":"#/components/schemas/AutomodToxicityConfig","description":"Configuration for toxicity detection","title":"Automod Toxicity Config","x-stream-index":"004"},"block_list_config":{"$ref":"#/components/schemas/BlockListConfig","description":"Configuration for block list filtering","title":"Block List Config","x-stream-index":"007"},"created_at":{"description":"When the configuration was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"012"},"key":{"description":"Unique identifier for the moderation configuration","title":"Key","type":"string","x-stream-index":"001"},"rule_builder_config":{"$ref":"#/components/schemas/RuleBuilderConfig","x-stream-index":"015"},"team":{"description":"Team associated with the configuration","title":"Team","type":"string","x-stream-index":"002"},"updated_at":{"description":"When the configuration was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"013"},"velocity_filter_config":{"$ref":"#/components/schemas/VelocityFilterConfig","description":"Configuration for velocity-based filtering","title":"Velocity Filter Config","x-stream-index":"011"},"video_call_rule_config":{"$ref":"#/components/schemas/VideoCallRuleConfig","x-stream-index":"014"}},"required":["key","team","async","created_at","updated_at"],"type":"object"},"ContentCountRuleParameters":{"properties":{"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"required":["threshold","time_window"],"type":"object"},"CustomActionRequest":{"properties":{"id":{"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"type":"object"},"Data":{"properties":{"id":{"type":"string","x-stream-index":"001"}},"required":["id"],"type":"object"},"DeleteActivityRequest":{"properties":{"hard_delete":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"DeleteMessageRequest":{"properties":{"hard_delete":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"DeleteModerationConfigResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"DeleteReactionRequest":{"properties":{"hard_delete":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"DeleteUserRequest":{"properties":{"delete_conversation_channels":{"type":"boolean","x-stream-index":"003"},"delete_feeds_content":{"type":"boolean","x-stream-index":"004"},"hard_delete":{"type":"boolean","x-stream-index":"001"},"mark_messages_deleted":{"type":"boolean","x-stream-index":"002"}},"type":"object"},"Device":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"disabled":{"type":"boolean","x-stream-index":"002.003"},"disabled_reason":{"type":"string","x-stream-index":"002.004"},"id":{"type":"string","x-stream-index":"002.001.004"},"push_provider":{"enum":["firebase","apn","huawei","xiaomi"],"type":"string","x-stream-index":"002.001.001"},"push_provider_name":{"type":"string","x-stream-index":"002.001.003"},"user_id":{"type":"string","x-stream-index":"004"},"voip":{"type":"boolean","x-stream-index":"002.001.005"}},"required":["push_provider","id","created_at","user_id"],"type":"object"},"DraftPayloadResponse":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"html":{"type":"string","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"001"},"mentioned_users":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"008"},"mml":{"type":"string","x-stream-index":"003"},"parent_id":{"type":"string","x-stream-index":"005"},"poll_id":{"type":"string","x-stream-index":"013"},"quoted_message_id":{"type":"string","x-stream-index":"009"},"show_in_channel":{"type":"boolean","x-stream-index":"006"},"silent":{"type":"boolean","x-stream-index":"012"},"text":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"011"}},"required":["id","text","custom"],"type":"object"},"DraftResponse":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003"},"channel_cid":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"message":{"$ref":"#/components/schemas/DraftPayloadResponse","x-stream-index":"001"},"parent_id":{"type":"string","x-stream-index":"004"},"parent_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"005"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"006"}},"required":["message","channel_cid","created_at"],"type":"object"},"EgressHLSResponse":{"properties":{"playlist_url":{"type":"string","x-stream-index":"001"},"status":{"type":"string","x-stream-index":"002"}},"required":["playlist_url","status"],"type":"object"},"EgressRTMPResponse":{"properties":{"name":{"type":"string","x-stream-index":"001"},"started_at":{"format":"date-time","type":"number","x-stream-index":"004"},"stream_key":{"type":"string","x-stream-index":"003"},"stream_url":{"type":"string","x-stream-index":"002"}},"required":["name","started_at"],"type":"object"},"EgressResponse":{"properties":{"broadcasting":{"type":"boolean","x-stream-index":"001"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordingResponse","x-stream-index":"004"},"hls":{"$ref":"#/components/schemas/EgressHLSResponse","x-stream-index":"002"},"rtmps":{"items":{"$ref":"#/components/schemas/EgressRTMPResponse"},"type":"array","x-stream-index":"003"}},"required":["broadcasting","rtmps"],"type":"object"},"EgressTaskConfig":{"properties":{"egress_user":{"$ref":"#/components/schemas/EgressUser","x-stream-index":"008"},"frame_recording_egress_config":{"$ref":"#/components/schemas/FrameRecordingEgressConfig","x-stream-index":"009"},"hls_egress_config":{"$ref":"#/components/schemas/HLSEgressConfig","x-stream-index":"007"},"recording_egress_config":{"$ref":"#/components/schemas/RecordingEgressConfig","x-stream-index":"006"},"rtmp_egress_config":{"$ref":"#/components/schemas/RTMPEgressConfig","x-stream-index":"004"},"stt_egress_config":{"$ref":"#/components/schemas/STTEgressConfig","x-stream-index":"005"}},"type":"object"},"EgressUser":{"properties":{"token":{"type":"string","x-stream-index":"004"}},"type":"object"},"EnrichedActivity":{"properties":{"actor":{"$ref":"#/components/schemas/Data","x-stream-index":"002"},"foreign_id":{"type":"string","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"latest_reactions":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"013"},"object":{"$ref":"#/components/schemas/Data","x-stream-index":"004"},"origin":{"$ref":"#/components/schemas/Data","x-stream-index":"008"},"own_reactions":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"012"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"011"},"score":{"format":"float","type":"number","x-stream-index":"010"},"target":{"$ref":"#/components/schemas/Data","x-stream-index":"006"},"to":{"items":{"type":"string"},"type":"array","x-stream-index":"009"},"verb":{"type":"string","x-stream-index":"003"}},"type":"object"},"EnrichedReaction":{"nullable":true,"properties":{"activity_id":{"type":"string","x-stream-index":"003"},"children_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"010"},"created_at":{"$ref":"#/components/schemas/Time","x-stream-index":"012"},"data":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"kind":{"type":"string","x-stream-index":"002"},"latest_children":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"008"},"own_children":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"009"},"parent":{"type":"string","x-stream-index":"007"},"target_feeds":{"items":{"type":"string"},"type":"array","x-stream-index":"006"},"updated_at":{"$ref":"#/components/schemas/Time","x-stream-index":"013"},"user":{"$ref":"#/components/schemas/Data","x-stream-index":"011"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["kind","activity_id","user_id"],"type":"object"},"EntityCreator":{"properties":{"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"001.046"},"ban_count":{"format":"int32","type":"integer","x-stream-index":"002"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"001.017"},"banned":{"type":"boolean","x-stream-index":"001.016"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.013"},"deleted_content_count":{"format":"int32","type":"integer","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"001.023"},"language":{"type":"string","x-stream-index":"001.035"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"001.022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"001.026"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.042"},"role":{"type":"string","x-stream-index":"001.004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.005"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.009"}},"required":["id","role","teams_role","custom","banned","online","ban_count","deleted_content_count"],"type":"object"},"EntityCreatorResponse":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.001.018"},"ban_count":{"description":"Number of minor actions performed on the user","format":"int32","title":"Ban Count","type":"integer","x-stream-index":"002"},"banned":{"type":"boolean","x-stream-index":"001.001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.001.017"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.001.016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.001.011"},"deleted_content_count":{"description":"Number of major actions performed on the user","format":"int32","title":"Deleted Content Count","type":"integer","x-stream-index":"003"},"flagged_count":{"description":"Number of flag actions performed on the user","format":"int32","title":"Flagged Count","type":"integer","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001.001.001"},"image":{"type":"string","x-stream-index":"001.001.003"},"language":{"type":"string","x-stream-index":"001.001.005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"001.001.014"},"name":{"type":"string","x-stream-index":"001.001.002"},"online":{"type":"boolean","x-stream-index":"001.001.013"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.001.015"},"role":{"type":"string","x-stream-index":"001.001.006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.001.008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids","shadow_banned","invisible","ban_count","deleted_content_count","flagged_count"],"type":"object"},"EventNotificationSettings":{"properties":{"apns":{"$ref":"#/components/schemas/APNS","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"fcm":{"$ref":"#/components/schemas/FCM","x-stream-index":"003"}},"required":["enabled","apns","fcm"],"type":"object"},"ExternalStorage":{"properties":{"abs_account_name":{"type":"string","x-stream-index":"011"},"abs_client_id":{"type":"string","x-stream-index":"013"},"abs_client_secret":{"type":"string","x-stream-index":"014"},"abs_tenant_id":{"type":"string","x-stream-index":"012"},"bucket":{"type":"string","x-stream-index":"005"},"gcs_credentials":{"type":"string","x-stream-index":"010"},"path":{"type":"string","x-stream-index":"006"},"s3_api_key":{"type":"string","x-stream-index":"007"},"s3_custom_endpoint":{"type":"string","x-stream-index":"016"},"s3_region":{"type":"string","x-stream-index":"009"},"s3_secret_key":{"type":"string","x-stream-index":"008"},"storage_name":{"type":"string","x-stream-index":"015"},"storage_type":{"type":"integer","x-stream-index":"004"}},"type":"object"},"FCM":{"properties":{"data":{"additionalProperties":{},"type":"object","x-stream-index":"001"}},"type":"object"},"Field":{"nullable":true,"properties":{"short":{"type":"boolean","x-stream-index":"003"},"title":{"type":"string","x-stream-index":"001"},"value":{"type":"string","x-stream-index":"002"}},"required":["title","value","short"],"type":"object"},"Flag":{"description":"Contains information about flagged user or message","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"019"},"custom":{"additionalProperties":{},"description":"Additional metadata about the flag","title":"Custom","type":"object","x-stream-index":"014"},"entity_creator_id":{"description":"ID of the user who created the flagged entity","title":"Entity Creator ID","type":"string","x-stream-index":"009"},"entity_id":{"description":"Unique identifier of the entity being flagged","title":"Entity ID","type":"string","x-stream-index":"008"},"entity_type":{"description":"Type of entity being flagged (e.g., message, user)","title":"Entity Type","type":"string","x-stream-index":"007"},"is_streamed_content":{"type":"boolean","x-stream-index":"012"},"labels":{"description":"Labels from bodyguard, API calls, our own AI etc","items":{"type":"string"},"title":"Labels","type":"array","x-stream-index":"015"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content being flagged","title":"Moderation Payload","x-stream-index":"010"},"moderation_payload_hash":{"type":"string","x-stream-index":"011"},"reason":{"description":"Optional explanation for why the content is being flagged","title":"Reason","type":"string","x-stream-index":"013"},"result":{"description":"Result of bodyguard, API calls, our own AI etc","items":{"additionalProperties":{},"type":"object"},"title":"Result","type":"array","x-stream-index":"016"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"018"},"review_queue_item_id":{"description":"ID of the review queue item","title":"Review Queue Item ID","type":"string","x-stream-index":"017"},"type":{"type":"string","x-stream-index":"004"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"020"},"user":{"$ref":"#/components/schemas/User","description":"User who flagged a message or a user","title":"User","x-stream-index":"006"}},"required":["entity_type","entity_id","result","created_at","updated_at"],"title":"Flag","type":"object"},"FlagContentOptions":{"properties":{"reason":{"type":"string","x-stream-index":"001"}},"required":["reason"],"type":"object"},"FlagRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"description":"Additional metadata about the flag","title":"Custom","type":"object","x-stream-index":"006"},"entity_creator_id":{"description":"ID of the user who created the flagged entity","title":"Entity Creator ID","type":"string","x-stream-index":"003"},"entity_id":{"description":"Unique identifier of the entity being flagged","title":"Entity ID","type":"string","x-stream-index":"002"},"entity_type":{"description":"Type of entity being flagged (e.g., message, user)","title":"Entity Type","type":"string","x-stream-index":"001"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content being flagged","title":"Moderation Payload","x-stream-index":"005"},"reason":{"description":"Optional explanation for why the content is being flagged","maxLength":255,"title":"Reason","type":"string","x-stream-index":"004"}},"required":["entity_type","entity_id"],"type":"object"},"FlagResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"item_id":{"description":"Unique identifier of the created moderation item","title":"Item ID","type":"string","x-stream-index":"001"}},"required":["item_id","duration"],"type":"object"},"FlagUserOptions":{"properties":{"reason":{"type":"string","x-stream-index":"001"}},"required":["reason"],"type":"object"},"FrameRecordSettings":{"properties":{"capture_interval_in_seconds":{"format":"int32","maximum":60,"minimum":2,"type":"integer","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"},"quality":{"type":"string","x-stream-index":"002"}},"required":["mode","capture_interval_in_seconds"],"type":"object"},"FrameRecordingEgressConfig":{"properties":{"capture_interval_in_seconds":{"format":"int32","type":"integer","x-stream-index":"007"},"external_storage":{"$ref":"#/components/schemas/ExternalStorage","x-stream-index":"006"},"quality":{"$ref":"#/components/schemas/Quality","x-stream-index":"004"},"storage_name":{"type":"string","x-stream-index":"005"}},"type":"object"},"FrameRecordingResponse":{"properties":{"status":{"type":"string","x-stream-index":"001"}},"required":["status"],"type":"object"},"FrameRecordingSettingsResponse":{"properties":{"capture_interval_in_seconds":{"format":"int32","maximum":60,"minimum":2,"type":"integer","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"},"quality":{"type":"string","x-stream-index":"002"}},"required":["mode","capture_interval_in_seconds"],"type":"object"},"GeofenceSettings":{"properties":{"names":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"required":["names"],"type":"object"},"GeofenceSettingsResponse":{"properties":{"names":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"required":["names"],"type":"object"},"GetConfigResponse":{"nullable":true,"properties":{"config":{"$ref":"#/components/schemas/ConfigResponse","description":"The retrieved moderation configuration","title":"Config","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["duration"],"type":"object"},"GoogleVisionConfig":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"HLSEgressConfig":{"properties":{"composite_app_settings":{"$ref":"#/components/schemas/CompositeAppSettings","x-stream-index":"005"},"playlist_url":{"type":"string","x-stream-index":"007"},"qualities":{"items":{"$ref":"#/components/schemas/Quality"},"type":"array","x-stream-index":"004"},"start_unix_nano":{"format":"int64","type":"integer","x-stream-index":"006"}},"type":"object"},"HLSSettings":{"properties":{"auto_on":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"004"},"quality_tracks":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"required":["auto_on","enabled","quality_tracks"],"type":"object"},"HLSSettingsResponse":{"description":"HLSSettings is the payload for HLS settings","properties":{"auto_on":{"title":"Auto On","type":"boolean","x-stream-index":"001"},"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"002"},"quality_tracks":{"items":{"type":"string"},"title":"Quality Tracks","type":"array","x-stream-index":"003"}},"required":["auto_on","enabled","quality_tracks","layout"],"title":"HLSSettingsResponse","type":"object"},"HarmConfig":{"properties":{"action_sequences":{"items":{"$ref":"#/components/schemas/ActionSequence"},"type":"array","x-stream-index":"001"},"severity":{"type":"integer","x-stream-index":"002"}},"required":["action_sequences","severity"],"type":"object"},"ImageContentParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"type":"object"},"ImageData":{"properties":{"frames":{"type":"string","x-stream-index":"005"},"height":{"type":"string","x-stream-index":"003"},"size":{"type":"string","x-stream-index":"004"},"url":{"type":"string","x-stream-index":"001"},"width":{"type":"string","x-stream-index":"002"}},"required":["url","width","height","size","frames"],"type":"object"},"ImageRuleParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"required":["threshold","time_window"],"type":"object"},"Images":{"properties":{"fixed_height":{"$ref":"#/components/schemas/ImageData","x-stream-index":"002"},"fixed_height_downsampled":{"$ref":"#/components/schemas/ImageData","x-stream-index":"004"},"fixed_height_still":{"$ref":"#/components/schemas/ImageData","x-stream-index":"003"},"fixed_width":{"$ref":"#/components/schemas/ImageData","x-stream-index":"005"},"fixed_width_downsampled":{"$ref":"#/components/schemas/ImageData","x-stream-index":"007"},"fixed_width_still":{"$ref":"#/components/schemas/ImageData","x-stream-index":"006"},"original":{"$ref":"#/components/schemas/ImageData","x-stream-index":"001"}},"required":["original","fixed_height","fixed_height_still","fixed_height_downsampled","fixed_width","fixed_width_still","fixed_width_downsampled"],"type":"object"},"IngressAudioEncodingOptions":{"properties":{"bitrate":{"maximum":128000,"minimum":16000,"type":"integer","x-stream-index":"003"},"channels":{"enum":["1","2"],"format":"int32","type":"integer","x-stream-index":"001"},"enable_dtx":{"type":"boolean","x-stream-index":"002"}},"required":["channels","enable_dtx","bitrate"],"type":"object"},"IngressAudioEncodingResponse":{"properties":{"bitrate":{"format":"int32","type":"integer","x-stream-index":"003"},"channels":{"format":"int32","type":"integer","x-stream-index":"001"},"enable_dtx":{"type":"boolean","x-stream-index":"002"}},"required":["channels","enable_dtx","bitrate"],"type":"object"},"IngressSettings":{"properties":{"audio_encoding_options":{"$ref":"#/components/schemas/IngressAudioEncodingOptions","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"video_encoding_options":{"additionalProperties":{"$ref":"#/components/schemas/IngressVideoEncodingOptions"},"type":"object","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"IngressSettingsResponse":{"properties":{"audio_encoding_options":{"$ref":"#/components/schemas/IngressAudioEncodingResponse","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"video_encoding_options":{"additionalProperties":{"$ref":"#/components/schemas/IngressVideoEncodingResponse"},"type":"object","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"IngressVideoEncodingOptions":{"properties":{"layers":{"items":{"$ref":"#/components/schemas/IngressVideoLayer"},"minimum":1,"type":"array","x-stream-index":"001"}},"required":["layers"],"type":"object"},"IngressVideoEncodingResponse":{"properties":{"layers":{"items":{"$ref":"#/components/schemas/IngressVideoLayerResponse"},"type":"array","x-stream-index":"001"}},"required":["layers"],"type":"object"},"IngressVideoLayer":{"nullable":true,"properties":{"bitrate":{"minimum":1000,"type":"integer","x-stream-index":"002"},"codec":{"enum":["h264","vp8"],"type":"string","x-stream-index":"001"},"frame_rate":{"maximum":60,"minimum":1,"type":"integer","x-stream-index":"003"},"max_dimension":{"minimum":240,"type":"integer","x-stream-index":"005"},"min_dimension":{"minimum":240,"type":"integer","x-stream-index":"004"}},"required":["codec","bitrate","frame_rate","min_dimension","max_dimension"],"type":"object"},"IngressVideoLayerResponse":{"nullable":true,"properties":{"bitrate":{"type":"integer","x-stream-index":"002"},"codec":{"type":"string","x-stream-index":"001"},"frame_rate_limit":{"type":"integer","x-stream-index":"005"},"max_dimension":{"type":"integer","x-stream-index":"004"},"min_dimension":{"type":"integer","x-stream-index":"003"}},"required":["codec","bitrate","min_dimension","max_dimension","frame_rate_limit"],"type":"object"},"LabelThresholds":{"properties":{"block":{"format":"float","maximum":1,"minimum":0,"type":"number","x-stream-index":"002"},"flag":{"format":"float","maximum":1,"minimum":0,"type":"number","x-stream-index":"001"}},"type":"object"},"LayoutSettings":{"properties":{"detect_orientation":{"type":"boolean","x-stream-index":"005"},"external_app_url":{"type":"string","x-stream-index":"003"},"external_css_url":{"type":"string","x-stream-index":"004"},"name":{"enum":["spotlight","grid","single-participant","mobile","custom"],"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"required":["name","external_app_url","external_css_url"],"type":"object"},"LimitsSettings":{"properties":{"max_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"004"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"},"max_participants_exclude_owner":{"type":"boolean","x-stream-index":"003"},"max_participants_exclude_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"002"}},"required":["max_participants_exclude_roles"],"type":"object"},"LimitsSettingsResponse":{"properties":{"max_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"004"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"},"max_participants_exclude_owner":{"type":"boolean","x-stream-index":"003"},"max_participants_exclude_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"002"}},"required":["max_participants_exclude_roles"],"type":"object"},"MarkReviewedRequest":{"properties":{"content_to_mark_as_reviewed_limit":{"format":"int32","maximum":2500,"type":"integer","x-stream-index":"002"},"disable_marking_content_as_reviewed":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"MemberLookup":{"properties":{"Limit":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"001"}},"required":["Limit"],"type":"object"},"Message":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"012"},"before_message_send_failed":{"type":"boolean","x-stream-index":"046"},"cid":{"type":"string","x-stream-index":"028"},"command":{"type":"string","x-stream-index":"006"},"created_at":{"format":"date-time","type":"number","x-stream-index":"030"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"034"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"033"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"023"},"html":{"type":"string","x-stream-index":"007"},"i18n":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"044"},"id":{"type":"string","x-stream-index":"002"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"040"},"latest_reactions":{"items":{"$ref":"#/components/schemas/Reaction"},"type":"array","x-stream-index":"013"},"mentioned_users":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"043"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"052"},"mml":{"type":"string","x-stream-index":"005"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"056"},"own_reactions":{"items":{"$ref":"#/components/schemas/Reaction"},"type":"array","x-stream-index":"014"},"parent_id":{"type":"string","x-stream-index":"019"},"pin_expires":{"format":"date-time","type":"number","x-stream-index":"051"},"pinned":{"type":"boolean","x-stream-index":"047"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"048"},"pinned_by":{"$ref":"#/components/schemas/User","x-stream-index":"050"},"poll":{"$ref":"#/components/schemas/Poll","x-stream-index":"054"},"poll_id":{"type":"string","x-stream-index":"053"},"quoted_message":{"$ref":"#/components/schemas/Message","x-stream-index":"025"},"quoted_message_id":{"type":"string","x-stream-index":"024"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"015"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"017"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"016"},"reminder":{"$ref":"#/components/schemas/MessageReminder","x-stream-index":"058"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"022"},"restricted_visibility":{"items":{"type":"string"},"type":"array","x-stream-index":"011"},"shadowed":{"type":"boolean","x-stream-index":"036"},"shared_location":{"$ref":"#/components/schemas/SharedLocation","x-stream-index":"055"},"show_in_channel":{"type":"boolean","x-stream-index":"021"},"silent":{"type":"boolean","x-stream-index":"045"},"text":{"type":"string","x-stream-index":"004"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"027"},"type":{"type":"string","x-stream-index":"008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"031"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"010"}},"required":["id","text","html","type","restricted_visibility","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reaction_groups","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned"],"type":"object"},"MessageReminder":{"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"004"},"channel_cid":{"type":"string","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"011"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"006"},"message_id":{"type":"string","x-stream-index":"005"},"remind_at":{"format":"date-time","type":"number","x-stream-index":"009"},"task_id":{"type":"string","x-stream-index":"010"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"012"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"user_id":{"type":"string","x-stream-index":"007"}},"required":["channel_cid","message_id","user_id","task_id","created_at","updated_at"],"type":"object"},"MessageResponse":{"description":"Represents any chat message","properties":{"attachments":{"description":"Array of message attachments","items":{"$ref":"#/components/schemas/Attachment"},"title":"Message attachments","type":"array","x-stream-docs-page-id":"message_format#attachment-format","x-stream-index":"008"},"cid":{"description":"Channel unique identifier in \u003ctype\u003e:\u003cid\u003e format","title":"Channel CID","type":"string","x-stream-index":"022"},"command":{"description":"Contains provided slash command","title":"Command","type":"string","x-stream-docs-page-id":"custom_commands_webhook","x-stream-index":"004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"023"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"026"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"025"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"018"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"041"},"html":{"description":"Contains HTML markup of the message. Can only be set when using server-side API","title":"HTML content","type":"string","x-stream-index":"005"},"i18n":{"additionalProperties":{"type":"string"},"description":"Object with translations. Key `language` contains the original language key. Other keys contain translations","title":"Internationalization info","type":"object","x-stream-docs-page-id":"translation","x-stream-index":"030"},"id":{"description":"Message ID is unique string identifier of the message","title":"ID","type":"string","x-stream-index":"001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"Contains image moderation information","title":"Image moderation labels","type":"object","x-stream-index":"028"},"latest_reactions":{"description":"List of 10 latest reactions to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Latest reactions","type":"array","x-stream-index":"009"},"mentioned_users":{"description":"List of mentioned users","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Mentioned Users","type":"array","x-stream-index":"029"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"036"},"mml":{"description":"Should be empty if `text` is provided. Can only be set when using server-side API","title":"Messaging Markup Language","type":"string","x-stream-docs-page-id":"mml_overview","x-stream-index":"003"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"039"},"own_reactions":{"description":"List of 10 latest reactions of authenticated user to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Own reactions","type":"array","x-stream-index":"010"},"parent_id":{"description":"ID of parent message (thread)","title":"Parent message ID","type":"string","x-stream-docs-page-id":"threads","x-stream-index":"015"},"pin_expires":{"description":"Date when pinned message expires","format":"date-time","title":"Pin expiration date","type":"number","x-stream-docs-page-id":"pinned_messages","x-stream-index":"035"},"pinned":{"description":"Whether message is pinned or not","title":"Pinned","type":"boolean","x-stream-docs-page-id":"pinned_messages","x-stream-index":"032"},"pinned_at":{"description":"Date when message got pinned","format":"date-time","title":"Pinned at","type":"number","x-stream-docs-page-id":"pinned_messages","x-stream-index":"033"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","description":"Contains user who pinned the message","title":"Pinned by","x-stream-docs-page-id":"pinned_messages","x-stream-index":"034"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"038"},"poll_id":{"description":"Identifier of the poll to include in the message","title":"Poll ID","type":"string","x-stream-index":"037"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","description":"Contains quoted message","title":"Quoted message","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"020"},"quoted_message_id":{"title":"ID of quoted message","type":"string","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"019"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing number of reactions of each type. Key: reaction type (string), value: number of reactions (int)","title":"Reaction counts","type":"object","x-stream-index":"011"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"014"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing scores of reactions of each type. Key: reaction type (string), value: total score of reactions (int)","title":"Reaction scores","type":"object","x-stream-index":"012"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"042"},"reply_count":{"description":"Number of replies to this message","format":"int32","title":"Reply count","type":"integer","x-stream-index":"017"},"restricted_visibility":{"description":"A list of user ids that have restricted visibility to the message, if the list is not empty, the message is only visible to the users in the list","items":{"type":"string"},"title":"Restricted visibility","type":"array","x-stream-index":"040"},"shadowed":{"description":"Whether the message was shadowed or not","title":"Shadowed","type":"boolean","x-stream-docs-page-id":"moderation#shadow-ban","x-stream-index":"027"},"shared_location":{"$ref":"#/components/schemas/SharedLocationResponseData","description":"Contains shared location data","title":"Shared Location","x-stream-index":"043"},"show_in_channel":{"description":"Whether thread reply should be shown in the channel as well","title":"Show in channel","type":"boolean","x-stream-docs-page-id":"threads","x-stream-index":"016"},"silent":{"description":"Whether message is silent or not","title":"Silent","type":"boolean","x-stream-index":"031"},"text":{"description":"Text of the message. Should be empty if `mml` is provided","title":"Text","type":"string","x-stream-index":"002"},"thread_participants":{"description":"List of users who participate in thread","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Thread participants","type":"array","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"021"},"type":{"description":"Contains type of the message","enum":["regular","ephemeral","error","reply","system","deleted"],"title":"Message Type","type":"string","x-stream-docs-page-id":"message_format#message-types","x-stream-index":"006"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"024"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Sender of the message. Required when using server-side API","title":"User object","x-stream-index":"007"}},"required":["id","text","html","type","user","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned","restricted_visibility"],"title":"Message","type":"object","x-stream-docs-page-id":"send_message"},"ModerationActionConfig":{"nullable":true,"properties":{"action":{"type":"string","x-stream-index":"006"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"009"},"description":{"type":"string","x-stream-index":"008"},"entity_type":{"type":"string","x-stream-index":"004"},"icon":{"type":"string","x-stream-index":"007"},"order":{"format":"int32","type":"integer","x-stream-index":"005"}},"required":["entity_type","order","action","icon","description","custom"],"type":"object"},"ModerationCustomActionEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"001"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"002"},"type":{"default":"moderation.custom_action","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationCustomActionEvent","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"},"ModerationFlaggedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"item":{"type":"string","x-stream-index":"001"},"object_id":{"type":"string","x-stream-index":"002"},"type":{"default":"moderation.flagged","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationFlaggedEvent","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"},"ModerationMarkReviewedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"001"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"002"},"type":{"default":"moderation.mark_reviewed","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationMarkReviewedEvent","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"},"ModerationPayload":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"images":{"items":{"type":"string"},"maximum":30,"type":"array","x-stream-index":"002"},"texts":{"items":{"type":"string"},"type":"array","x-stream-index":"001"},"videos":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"type":"object"},"ModerationV2Response":{"properties":{"action":{"type":"string","x-stream-index":"001"},"blocklist_matched":{"type":"string","x-stream-index":"005"},"image_harms":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"original_text":{"type":"string","x-stream-index":"002"},"platform_circumvented":{"type":"boolean","x-stream-index":"007"},"semantic_filter_matched":{"type":"string","x-stream-index":"006"},"text_harms":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"required":["action","original_text"],"type":"object"},"MuteRequest":{"nullable":true,"properties":{"target_ids":{"description":"User IDs to mute (if multiple users)","items":{"type":"string"},"title":"Target IDs","type":"array","x-stream-index":"001"},"timeout":{"description":"Duration of mute in minutes","minimum":0,"title":"Timeout","type":"integer","x-stream-index":"002"}},"required":["target_ids"],"title":"MuteRequest","type":"object"},"MuteResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"004.001"},"mutes":{"description":"Object with mutes (if multiple users were muted)","items":{"$ref":"#/components/schemas/UserMute"},"title":"Mutes","type":"array","x-stream-index":"001"},"non_existing_users":{"description":"A list of users that can't be found. Common cause for this is deleted users","items":{"type":"string"},"title":"Non Existing Users","type":"array","x-stream-index":"003"},"own_user":{"$ref":"#/components/schemas/OwnUser","description":"Authorized user object with fresh mutes information","title":"Own User","x-stream-index":"002"}},"required":["duration"],"title":"MuteResponse","type":"object"},"NoiseCancellationSettings":{"properties":{"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode"],"type":"object"},"NotificationSettings":{"properties":{"call_live_started":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"002"},"call_missed":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"006"},"call_notification":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"004"},"call_ring":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"session_started":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"003"}},"required":["enabled","call_live_started","session_started","call_notification","call_ring","call_missed"],"type":"object"},"NullTime":{"type":"object"},"OCRRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"}},"required":["label","action"],"type":"object"},"OwnUser":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"046"},"banned":{"type":"boolean","x-stream-index":"016"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"045"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"029"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"014"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"013"},"devices":{"items":{"$ref":"#/components/schemas/Device"},"type":"array","x-stream-index":"027"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"023"},"language":{"type":"string","x-stream-index":"035"},"last_active":{"format":"date-time","type":"number","x-stream-index":"011"},"last_engaged_at":{"format":"date-time","type":"number","x-stream-index":"012"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"037"},"mutes":{"items":{"$ref":"#/components/schemas/UserMute"},"type":"array","x-stream-index":"028"},"online":{"type":"boolean","x-stream-index":"022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"026"},"push_preferences":{"$ref":"#/components/schemas/PushPreferences","x-stream-index":"025"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"005"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"031"},"total_unread_count_by_team":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"032"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"033"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"030"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"034"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"}},"required":["id","role","custom","created_at","updated_at","banned","online","devices","mutes","channel_mutes","unread_count","total_unread_count","total_unread_count_by_team","unread_channels","unread_threads","language"],"type":"object"},"Poll":{"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"023"},"allow_answers":{"type":"boolean","x-stream-index":"010"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"009"},"answers_count":{"format":"int32","type":"integer","x-stream-index":"015"},"created_at":{"format":"date-time","type":"number","x-stream-index":"021"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"020"},"created_by_id":{"type":"string","x-stream-index":"019"},"description":{"type":"string","x-stream-index":"005"},"enforce_unique_vote":{"type":"boolean","x-stream-index":"007"},"id":{"type":"string","x-stream-index":"003"},"is_closed":{"type":"boolean","x-stream-index":"011"},"latest_answers":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array","x-stream-index":"017"},"latest_votes_by_option":{"additionalProperties":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array"},"type":"object","x-stream-index":"016"},"max_votes_allowed":{"format":"int32","type":"integer","x-stream-index":"008"},"name":{"type":"string","x-stream-index":"004"},"options":{"items":{"$ref":"#/components/schemas/PollOption"},"type":"array","x-stream-index":"013"},"own_votes":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array","x-stream-index":"018"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"022"},"vote_count":{"format":"int32","type":"integer","x-stream-index":"012"},"vote_counts_by_option":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"014"},"voting_visibility":{"type":"string","x-stream-index":"006"}},"required":["id","name","description","enforce_unique_vote","allow_user_suggested_options","allow_answers","vote_count","options","vote_counts_by_option","answers_count","latest_votes_by_option","latest_answers","own_votes","created_by_id","created_at","updated_at","Custom"],"type":"object"},"PollOption":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id","text","custom"],"type":"object"},"PollOptionResponseData":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id","text","custom"],"type":"object"},"PollResponseData":{"properties":{"allow_answers":{"type":"boolean","x-stream-index":"008"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"007"},"answers_count":{"format":"int32","type":"integer","x-stream-index":"012"},"created_at":{"format":"date-time","type":"number","x-stream-index":"019"},"created_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"018"},"created_by_id":{"type":"string","x-stream-index":"017"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"021"},"description":{"type":"string","x-stream-index":"003"},"enforce_unique_vote":{"type":"boolean","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"is_closed":{"type":"boolean","x-stream-index":"009"},"latest_answers":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array","x-stream-index":"015"},"latest_votes_by_option":{"additionalProperties":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array"},"type":"object","x-stream-index":"014"},"max_votes_allowed":{"format":"int32","type":"integer","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"002"},"options":{"items":{"$ref":"#/components/schemas/PollOptionResponseData"},"type":"array","x-stream-index":"011"},"own_votes":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array","x-stream-index":"016"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"020"},"vote_count":{"format":"int32","type":"integer","x-stream-index":"010"},"vote_counts_by_option":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"013"},"voting_visibility":{"type":"string","x-stream-index":"004"}},"required":["id","name","description","voting_visibility","enforce_unique_vote","allow_user_suggested_options","allow_answers","vote_count","options","answers_count","vote_counts_by_option","latest_votes_by_option","latest_answers","own_votes","created_by_id","created_at","updated_at","custom"],"type":"object"},"PollVote":{"nullable":true,"properties":{"answer_text":{"type":"string","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"004"},"is_answer":{"type":"boolean","x-stream-index":"006"},"option_id":{"type":"string","x-stream-index":"005"},"poll_id":{"type":"string","x-stream-index":"003"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"011"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"009"},"user_id":{"type":"string","x-stream-index":"008"}},"required":["poll_id","id","option_id","created_at","updated_at"],"type":"object"},"PollVoteResponseData":{"nullable":true,"properties":{"answer_text":{"type":"string","x-stream-index":"005"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"id":{"type":"string","x-stream-index":"002"},"is_answer":{"type":"boolean","x-stream-index":"004"},"option_id":{"type":"string","x-stream-index":"003"},"poll_id":{"type":"string","x-stream-index":"001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"007"},"user_id":{"type":"string","x-stream-index":"006"}},"required":["poll_id","id","option_id","created_at","updated_at"],"type":"object"},"PrivacySettings":{"properties":{"read_receipts":{"$ref":"#/components/schemas/ReadReceipts","x-stream-index":"002"},"typing_indicators":{"$ref":"#/components/schemas/TypingIndicators","x-stream-index":"001"}},"type":"object"},"PrivacySettingsResponse":{"properties":{"read_receipts":{"$ref":"#/components/schemas/ReadReceiptsResponse","x-stream-index":"002"},"typing_indicators":{"$ref":"#/components/schemas/TypingIndicatorsResponse","x-stream-index":"001"}},"type":"object"},"PushPreferences":{"properties":{"call_level":{"type":"string","x-stream-index":"002"},"chat_level":{"type":"string","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"number","x-stream-index":"003"}},"type":"object"},"Quality":{"properties":{"bitdepth":{"format":"int32","type":"integer","x-stream-index":"007"},"framerate":{"format":"int32","type":"integer","x-stream-index":"008"},"height":{"format":"int32","type":"integer","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"004"},"video_bitrate":{"format":"int32","type":"integer","x-stream-index":"009"},"width":{"format":"int32","type":"integer","x-stream-index":"005"}},"type":"object"},"QueryModerationConfigsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter conditions for moderation configs","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"Sorting parameters for the results","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"002"}},"type":"object"},"QueryModerationConfigsResponse":{"nullable":true,"properties":{"configs":{"description":"List of moderation configurations","items":{"$ref":"#/components/schemas/ConfigResponse"},"title":"Configs","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["configs","duration"],"type":"object"},"QueryReviewQueueRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter conditions for review queue items","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"007.001"},"lock_count":{"description":"Number of items to lock (1-25)","format":"int32","maximum":25,"minimum":1,"title":"Lock Count","type":"integer","x-stream-index":"005"},"lock_duration":{"description":"Duration for which items should be locked","title":"Lock Duration","type":"integer","x-stream-index":"004"},"lock_items":{"description":"Whether to lock items for review (true), unlock items (false), or just fetch (nil)","title":"Lock Items","type":"boolean","x-stream-index":"003"},"next":{"type":"string","x-stream-index":"007.002"},"prev":{"type":"string","x-stream-index":"007.003"},"sort":{"description":"Sorting parameters for the results","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"002"},"stats_only":{"description":"Whether to return only statistics","title":"Stats Only","type":"boolean","x-stream-index":"006"}},"type":"object"},"QueryReviewQueueResponse":{"nullable":true,"properties":{"action_config":{"additionalProperties":{"items":{"$ref":"#/components/schemas/ModerationActionConfig"},"type":"array"},"description":"Configuration for moderation actions","title":"Action Config","type":"object","x-stream-index":"002"},"duration":{"type":"string","x-stream-index":"005.001"},"items":{"description":"List of review queue items","items":{"$ref":"#/components/schemas/ReviewQueueItemResponse"},"title":"Items","type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"004.001"},"prev":{"type":"string","x-stream-index":"004.002"},"stats":{"additionalProperties":{},"description":"Statistics about the review queue","title":"Stats","type":"object","x-stream-index":"003"}},"required":["items","action_config","stats","duration"],"type":"object"},"RTMPEgressConfig":{"properties":{"composite_app_settings":{"$ref":"#/components/schemas/CompositeAppSettings","x-stream-index":"005"},"quality":{"$ref":"#/components/schemas/Quality","x-stream-index":"004"},"rtmp_location":{"type":"string","x-stream-index":"006"}},"type":"object"},"RTMPIngress":{"description":"RTMP input settings","properties":{"address":{"title":"Address","type":"string","x-stream-index":"001"}},"required":["address"],"title":"RTMPIngress","type":"object"},"RTMPLocation":{"properties":{"name":{"type":"string","x-stream-index":"001"},"stream_key":{"type":"string","x-stream-index":"003"},"stream_url":{"type":"string","x-stream-index":"002"}},"required":["name","stream_url","stream_key"],"type":"object"},"RTMPSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"003"},"location":{"$ref":"#/components/schemas/RTMPLocation","x-stream-index":"004"},"quality_name":{"type":"string","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"RTMPSettingsResponse":{"description":"RTMPSettingsResponse is the payload for RTMP settings","properties":{"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"001"},"quality":{"title":"Quality","type":"string","x-stream-index":"002"}},"required":["enabled","quality","layout"],"title":"RTMPSettingsResponse","type":"object"},"Reaction":{"nullable":true,"properties":{"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"message_id":{"type":"string","x-stream-index":"003"},"score":{"format":"int32","type":"integer","x-stream-index":"007"},"type":{"maxLength":30,"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["message_id","type","score","created_at","updated_at","custom"],"type":"object"},"ReactionGroupResponse":{"description":"ReactionGroupResponse contains all information about a reaction of the same type.","nullable":true,"properties":{"count":{"description":"Count is the number of reactions of this type.","format":"int32","title":"Count","type":"integer","x-stream-index":"001"},"first_reaction_at":{"description":"FirstReactionAt is the time of the first reaction of this type. This is the same also if all reaction of this type are deleted, because if someone will react again with the same type, will be preserved the sorting.","format":"date-time","title":"FirstReactionAt","type":"number","x-stream-index":"003"},"last_reaction_at":{"description":"LastReactionAt is the time of the last reaction of this type.","format":"date-time","title":"LastReactionAt","type":"number","x-stream-index":"004"},"sum_scores":{"description":"SumScores is the sum of all scores of reactions of this type. Medium allows you to clap articles more than once and shows the sum of all claps from all users. For example, you can send `clap` x5 using `score: 5`.","format":"int32","title":"SumScores","type":"integer","x-stream-index":"002"}},"required":["count","sum_scores","first_reaction_at","last_reaction_at"],"title":"ReactionGroupResponse","type":"object"},"ReactionResponse":{"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"006"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"008"},"message_id":{"description":"Message ID","title":"Message ID","type":"string","x-stream-index":"001"},"score":{"description":"Score of the reaction","format":"int32","title":"Score","type":"integer","x-stream-index":"005"},"type":{"description":"Type of reaction","title":"Type","type":"string","x-stream-index":"004"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"007"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User","title":"UserResponse","x-stream-index":"003"},"user_id":{"description":"User ID","title":"User ID","type":"string","x-stream-index":"002"}},"required":["message_id","user_id","user","type","score","created_at","updated_at","custom"],"type":"object"},"ReadReceipts":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"ReadReceiptsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"RecordSettings":{"properties":{"audio_only":{"type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"004"},"mode":{"type":"string","x-stream-index":"002"},"quality":{"type":"string","x-stream-index":"003"}},"required":["mode"],"type":"object"},"RecordSettingsResponse":{"description":"RecordSettings is the payload for recording settings","properties":{"audio_only":{"title":"Audio Only","type":"boolean","x-stream-index":"001"},"mode":{"title":"Mode","type":"string","x-stream-index":"002"},"quality":{"title":"Quality","type":"string","x-stream-index":"003"}},"required":["audio_only","mode","quality","layout"],"title":"RecordSettingsResponse","type":"object"},"RecordingEgressConfig":{"properties":{"audio_only":{"type":"boolean","x-stream-index":"006"},"composite_app_settings":{"$ref":"#/components/schemas/CompositeAppSettings","x-stream-index":"005"},"external_storage":{"$ref":"#/components/schemas/ExternalStorage","x-stream-index":"008"},"quality":{"$ref":"#/components/schemas/Quality","x-stream-index":"004"},"storage_name":{"type":"string","x-stream-index":"007"},"video_orientation_hint":{"$ref":"#/components/schemas/VideoOrientation","x-stream-index":"009"}},"type":"object"},"ReminderResponseData":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003"},"channel_cid":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"005"},"message_id":{"type":"string","x-stream-index":"004"},"remind_at":{"format":"date-time","type":"number","x-stream-index":"001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007"},"user_id":{"type":"string","x-stream-index":"006"}},"required":["channel_cid","message_id","user_id","created_at","updated_at"],"type":"object"},"RestoreActionRequest":{"type":"object"},"ReviewQueueItem":{"properties":{"actions":{"items":{"$ref":"#/components/schemas/ActionLog"},"type":"array","x-stream-index":"035"},"activity":{"$ref":"#/components/schemas/EnrichedActivity","x-stream-index":"028"},"ai_text_severity":{"type":"string","x-stream-index":"021"},"archived_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"043"},"assigned_to":{"$ref":"#/components/schemas/User","x-stream-index":"032"},"bans":{"items":{"$ref":"#/components/schemas/Ban"},"type":"array","x-stream-index":"033"},"bounce_count":{"format":"int32","type":"integer","x-stream-index":"025"},"call":{"$ref":"#/components/schemas/Call","x-stream-index":"031"},"completed_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"018"},"config_key":{"type":"string","x-stream-index":"009"},"content_changed":{"type":"boolean","x-stream-index":"036"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"entity_creator":{"$ref":"#/components/schemas/EntityCreator","x-stream-index":"030"},"entity_id":{"type":"string","x-stream-index":"007"},"entity_type":{"type":"string","x-stream-index":"006"},"feeds_v2_activity":{"$ref":"#/components/schemas/EnrichedActivity","x-stream-index":"041"},"feeds_v2_reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"042"},"flag_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"045"},"flag_types":{"items":{"type":"string"},"type":"array","x-stream-index":"044"},"flags":{"items":{"$ref":"#/components/schemas/Flag"},"type":"array","x-stream-index":"034"},"flags_count":{"format":"int32","type":"integer","x-stream-index":"026"},"has_image":{"type":"boolean","x-stream-index":"012"},"has_text":{"type":"boolean","x-stream-index":"014"},"has_video":{"type":"boolean","x-stream-index":"013"},"id":{"type":"string","x-stream-index":"003"},"languages":{"items":{"type":"string"},"type":"array","x-stream-index":"019"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"027"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"010"},"moderation_payload_hash":{"type":"string","x-stream-index":"011"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"029"},"recommended_action":{"type":"string","x-stream-index":"017"},"reporter_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"046"},"reviewed_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"022"},"reviewed_by":{"type":"string","x-stream-index":"023"},"severity":{"format":"int32","type":"integer","x-stream-index":"020"},"status":{"type":"string","x-stream-index":"016"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"015"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"005"}},"required":["id","created_at","updated_at","entity_type","entity_id","config_key","moderation_payload_hash","has_image","has_video","has_text","teams","status","recommended_action","completed_at","languages","severity","ai_text_severity","reviewed_at","reviewed_by","bounce_count","flags_count","bans","flags","actions","content_changed","archived_at","flag_types","flag_labels","reporter_ids"],"type":"object"},"ReviewQueueItemResponse":{"nullable":true,"properties":{"actions":{"description":"Moderation actions taken","items":{"$ref":"#/components/schemas/ActionLogResponse"},"title":"Actions","type":"array","x-stream-index":"024"},"activity":{"$ref":"#/components/schemas/EnrichedActivity","x-stream-index":"016"},"ai_text_severity":{"description":"AI-determined text severity","title":"AI Text Severity","type":"string","x-stream-index":"014"},"assigned_to":{"$ref":"#/components/schemas/UserResponse","description":"Moderator assigned to review this item","title":"Assigned To","x-stream-index":"021"},"bans":{"description":"Associated ban records","items":{"$ref":"#/components/schemas/Ban"},"title":"Bans","type":"array","x-stream-index":"022"},"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"018"},"completed_at":{"description":"When the review was completed","format":"date-time","title":"Completed At","type":"number","x-stream-index":"009"},"config_key":{"type":"string","x-stream-index":"028"},"created_at":{"description":"When the item was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"002"},"entity_creator":{"$ref":"#/components/schemas/EntityCreatorResponse","description":"Details about who created the entity","title":"Entity Creator","x-stream-index":"019"},"entity_creator_id":{"description":"ID of who created the entity","title":"Entity Creator ID","type":"string","x-stream-index":"020"},"entity_id":{"description":"ID of the entity being reviewed","title":"Entity ID","type":"string","x-stream-index":"005"},"entity_type":{"description":"Type of entity being reviewed","title":"Entity Type","type":"string","x-stream-index":"004"},"feeds_v2_activity":{"$ref":"#/components/schemas/EnrichedActivity","description":"Associated feed activity","title":"Feeds V2 Activity","x-stream-index":"025"},"feeds_v2_reaction":{"$ref":"#/components/schemas/Reaction","description":"Associated feed reaction","title":"Feeds V2 Reaction","x-stream-index":"026"},"flags":{"description":"Associated flag records","items":{"$ref":"#/components/schemas/FlagResponse"},"title":"Flags","type":"array","x-stream-index":"023"},"flags_count":{"format":"int32","type":"integer","x-stream-index":"029"},"id":{"description":"Unique identifier of the review queue item","title":"ID","type":"string","x-stream-index":"001"},"languages":{"description":"Detected languages in the content","items":{"type":"string"},"title":"Languages","type":"array","x-stream-index":"012"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Associated message details","title":"Message","x-stream-index":"015"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content being moderated","title":"Moderation Payload","x-stream-index":"006"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"017"},"recommended_action":{"description":"Suggested moderation action","title":"Recommended Action","type":"string","x-stream-index":"008"},"reviewed_at":{"description":"When the item was reviewed","format":"date-time","title":"Reviewed At","type":"number","x-stream-index":"010"},"reviewed_by":{"description":"ID of the moderator who reviewed the item","title":"Reviewed By","type":"string","x-stream-index":"011"},"severity":{"description":"Severity level of the content","format":"int32","title":"Severity","type":"integer","x-stream-index":"013"},"status":{"description":"Current status of the review","title":"Status","type":"string","x-stream-index":"007"},"teams":{"description":"Teams associated with this item","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"027"},"updated_at":{"description":"When the item was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"003"}},"required":["id","created_at","updated_at","entity_type","entity_id","status","recommended_action","reviewed_by","languages","severity","ai_text_severity","bans","flags","actions","flags_count"],"type":"object"},"RingSettings":{"properties":{"auto_cancel_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_timeout_ms","missed_call_timeout_ms"],"type":"object"},"RingSettingsResponse":{"properties":{"auto_cancel_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_timeout_ms","missed_call_timeout_ms"],"type":"object"},"RuleBuilderAction":{"properties":{"ban_options":{"$ref":"#/components/schemas/BanOptions","x-stream-index":"002"},"flag_content_options":{"$ref":"#/components/schemas/FlagContentOptions","x-stream-index":"004"},"flag_user_options":{"$ref":"#/components/schemas/FlagUserOptions","x-stream-index":"003"},"remove_content_options":{"$ref":"#/components/schemas/BlockContentOptions","x-stream-index":"005"},"type":{"type":"string","x-stream-index":"001"}},"required":["type"],"type":"object"},"RuleBuilderCondition":{"properties":{"confidence":{"format":"float","type":"number","x-stream-index":"002"},"content_count_rule_params":{"$ref":"#/components/schemas/ContentCountRuleParameters","x-stream-index":"007"},"image_content_params":{"$ref":"#/components/schemas/ImageContentParameters","x-stream-index":"009"},"image_rule_params":{"$ref":"#/components/schemas/ImageRuleParameters","x-stream-index":"004"},"text_content_params":{"$ref":"#/components/schemas/TextContentParameters","x-stream-index":"008"},"text_rule_params":{"$ref":"#/components/schemas/TextRuleParameters","x-stream-index":"003"},"type":{"type":"string","x-stream-index":"001"},"user_created_within_params":{"$ref":"#/components/schemas/UserCreatedWithinParameters","x-stream-index":"011"},"user_rule_params":{"$ref":"#/components/schemas/UserRuleParameters","x-stream-index":"006"},"video_content_params":{"$ref":"#/components/schemas/VideoContentParameters","x-stream-index":"010"},"video_rule_params":{"$ref":"#/components/schemas/VideoRuleParameters","x-stream-index":"005"}},"required":["type"],"type":"object"},"RuleBuilderConditionGroup":{"properties":{"conditions":{"items":{"$ref":"#/components/schemas/RuleBuilderCondition"},"type":"array","x-stream-index":"002"},"logic":{"type":"string","x-stream-index":"001"}},"required":["logic","conditions"],"type":"object"},"RuleBuilderConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"rules":{"items":{"$ref":"#/components/schemas/RuleBuilderRule"},"type":"array","x-stream-index":"002"}},"required":["rules"],"type":"object"},"RuleBuilderRule":{"properties":{"action":{"$ref":"#/components/schemas/RuleBuilderAction","x-stream-index":"007"},"conditions":{"items":{"$ref":"#/components/schemas/RuleBuilderCondition"},"type":"array","x-stream-index":"004"},"cooldown_period":{"type":"string","x-stream-index":"009"},"enabled":{"type":"boolean","x-stream-index":"008"},"groups":{"items":{"$ref":"#/components/schemas/RuleBuilderConditionGroup"},"type":"array","x-stream-index":"006"},"id":{"type":"string","x-stream-index":"001"},"logic":{"type":"string","x-stream-index":"005"},"name":{"type":"string","x-stream-index":"002"},"rule_type":{"type":"string","x-stream-index":"003"}},"required":["id","name","rule_type","action","enabled"],"type":"object"},"SFUIDLastSeen":{"properties":{"id":{"type":"string","x-stream-index":"001.001"},"last_seen":{"format":"date-time","type":"number","x-stream-index":"002"},"process_start_time":{"format":"int64","type":"integer","x-stream-index":"001.002"}},"required":["id","process_start_time","last_seen"],"type":"object"},"STTEgressConfig":{"properties":{"closed_captions_enabled":{"type":"boolean","x-stream-index":"005"},"external_storage":{"$ref":"#/components/schemas/ExternalStorage","x-stream-index":"011"},"language":{"type":"string","x-stream-index":"008"},"storage_name":{"type":"string","x-stream-index":"010"},"translation_languages":{"items":{"type":"string"},"type":"array","x-stream-index":"009"},"translations_enabled":{"type":"boolean","x-stream-index":"006"},"upload_transcriptions":{"type":"boolean","x-stream-index":"004"},"whisper_server_base_url":{"type":"string","x-stream-index":"007"}},"type":"object"},"ScreensharingSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled"],"type":"object"},"ScreensharingSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled"],"type":"object"},"SessionSettings":{"properties":{"inactivity_timeout_seconds":{"format":"int32","maximum":900,"minimum":5,"type":"integer","x-stream-index":"001"}},"required":["inactivity_timeout_seconds"],"type":"object"},"SessionSettingsResponse":{"properties":{"inactivity_timeout_seconds":{"format":"int32","maximum":900,"minimum":5,"type":"integer","x-stream-index":"001"}},"required":["inactivity_timeout_seconds"],"type":"object"},"ShadowBlockActionRequest":{"type":"object"},"SharedLocation":{"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"013"},"channel_cid":{"type":"string","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"010"},"created_by_device_id":{"type":"string","x-stream-index":"008"},"end_at":{"format":"date-time","type":"number","x-stream-index":"009"},"latitude":{"format":"float","maximum":90,"minimum":18446744073709552000,"type":"number","x-stream-index":"006"},"longitude":{"format":"float","maximum":180,"minimum":18446744073709552000,"type":"number","x-stream-index":"007"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"012"},"message_id":{"type":"string","x-stream-index":"004"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"011"},"user_id":{"type":"string","x-stream-index":"005"}},"required":["channel_cid","message_id","user_id","created_by_device_id","created_at","updated_at"],"type":"object"},"SharedLocationResponseData":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"011"},"channel_cid":{"type":"string","x-stream-index":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"created_by_device_id":{"type":"string","x-stream-index":"006"},"end_at":{"format":"date-time","type":"number","x-stream-index":"007"},"latitude":{"format":"float","type":"number","x-stream-index":"004"},"longitude":{"format":"float","type":"number","x-stream-index":"005"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"010"},"message_id":{"type":"string","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["channel_cid","message_id","user_id","latitude","longitude","created_by_device_id","created_at","updated_at"],"type":"object"},"SortParamRequest":{"nullable":true,"properties":{"direction":{"description":"Direction of sorting, 1 for Ascending, -1 for Descending, default is 1","format":"int32","title":"Direction","type":"integer","x-stream-index":"002"},"field":{"description":"Name of field to sort by","title":"Field","type":"string","x-stream-index":"001"}},"type":"object"},"SubmitActionRequest":{"nullable":true,"properties":{"action_type":{"description":"Type of moderation action to perform (mark_reviewed, delete_message, etc.)","enum":["mark_reviewed","delete_message","delete_activity","delete_reaction","ban","custom","unban","restore","delete_user","unblock","shadow_block","unmask","kick_user","end_call"],"title":"Action Type","type":"string","x-stream-index":"002"},"ban":{"$ref":"#/components/schemas/BanActionRequest","description":"Configuration for ban action","title":"Ban","x-stream-index":"008"},"custom":{"$ref":"#/components/schemas/CustomActionRequest","description":"Configuration for custom action","title":"Custom","x-stream-index":"009"},"delete_activity":{"$ref":"#/components/schemas/DeleteActivityRequest","description":"Configuration for activity deletion action","title":"Delete Activity","x-stream-index":"004"},"delete_message":{"$ref":"#/components/schemas/DeleteMessageRequest","description":"Configuration for message deletion action","title":"Delete Message","x-stream-index":"003"},"delete_reaction":{"$ref":"#/components/schemas/DeleteReactionRequest","description":"Configuration for reaction deletion action","title":"Delete Reaction","x-stream-index":"005"},"delete_user":{"$ref":"#/components/schemas/DeleteUserRequest","description":"Configuration for user deletion action","title":"Delete User","x-stream-index":"006"},"item_id":{"description":"UUID of the review queue item to act on","title":"Item ID","type":"string","x-stream-index":"001"},"mark_reviewed":{"$ref":"#/components/schemas/MarkReviewedRequest","description":"Configuration for marking item as reviewed","title":"Mark Reviewed","x-stream-index":"007"},"unban":{"$ref":"#/components/schemas/UnbanActionRequest","description":"Configuration for unban action","title":"Unban","x-stream-index":"010"}},"required":["item_id","action_type"],"type":"object"},"SubmitActionResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"Updated review queue item after action was performed","title":"Item","x-stream-index":"001"}},"required":["duration"],"type":"object"},"TargetResolution":{"properties":{"bitrate":{"format":"int32","maximum":6000000,"type":"integer","x-stream-index":"003"},"height":{"format":"int32","maximum":3840,"minimum":240,"type":"integer","x-stream-index":"002"},"width":{"format":"int32","maximum":3840,"minimum":240,"type":"integer","x-stream-index":"001"}},"required":["width","height","bitrate"],"type":"object"},"TextContentParameters":{"properties":{"blocklist_match":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"contains_url":{"type":"boolean","x-stream-index":"002"},"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001"},"severity":{"type":"string","x-stream-index":"003"}},"type":"object"},"TextRuleParameters":{"properties":{"blocklist_match":{"items":{"type":"string"},"type":"array","x-stream-index":"006"},"contains_url":{"type":"boolean","x-stream-index":"004"},"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"severity":{"type":"string","x-stream-index":"005"},"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"required":["threshold","time_window"],"type":"object"},"Thresholds":{"properties":{"explicit":{"$ref":"#/components/schemas/LabelThresholds","x-stream-index":"001"},"spam":{"$ref":"#/components/schemas/LabelThresholds","x-stream-index":"002"},"toxic":{"$ref":"#/components/schemas/LabelThresholds","x-stream-index":"003"}},"type":"object"},"ThumbnailResponse":{"properties":{"image_url":{"type":"string","x-stream-index":"001"}},"required":["image_url"],"type":"object"},"ThumbnailsSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"ThumbnailsSettingsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"Time":{"type":"object"},"TranscriptionSettings":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"title":"Mode","type":"string","x-stream-index":"002"},"language":{"description":"The language used in this call as a two letter code","enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"title":"Language","type":"string","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"title":"Mode","type":"string","x-stream-index":"001"}},"required":["mode","closed_caption_mode","languages","language"],"type":"object"},"TranscriptionSettingsResponse":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"002"},"language":{"enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"type":"string","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode","closed_caption_mode","languages","language"],"type":"object"},"TypingIndicators":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"TypingIndicatorsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"UnbanActionRequest":{"type":"object"},"UnblockActionRequest":{"type":"object"},"UpsertConfigRequest":{"nullable":true,"properties":{"ai_image_config":{"$ref":"#/components/schemas/AIImageConfig","description":"Configuration for AI image analysis","title":"AI Image Config","x-stream-index":"010"},"ai_text_config":{"$ref":"#/components/schemas/AITextConfig","description":"Configuration for AI text analysis","title":"AI Text Config","x-stream-index":"008"},"ai_video_config":{"$ref":"#/components/schemas/AIVideoConfig","description":"Configuration for AI video analysis","title":"AI Video Config","x-stream-index":"011"},"async":{"description":"Whether moderation should be performed asynchronously","title":"Async","type":"boolean","x-stream-index":"003"},"automod_platform_circumvention_config":{"$ref":"#/components/schemas/AutomodPlatformCircumventionConfig","description":"Configuration for platform circumvention detection","title":"Automod Platform Circumvention Config","x-stream-index":"005"},"automod_semantic_filters_config":{"$ref":"#/components/schemas/AutomodSemanticFiltersConfig","description":"Configuration for semantic filtering","title":"Automod Semantic Filters Config","x-stream-index":"006"},"automod_toxicity_config":{"$ref":"#/components/schemas/AutomodToxicityConfig","description":"Configuration for toxicity detection","title":"Automod Toxicity Config","x-stream-index":"004"},"aws_rekognition_config":{"$ref":"#/components/schemas/AIImageConfig","x-stream-index":"015"},"block_list_config":{"$ref":"#/components/schemas/BlockListConfig","description":"Configuration for block list filtering","title":"Block List Config","x-stream-index":"007"},"bodyguard_config":{"$ref":"#/components/schemas/AITextConfig","x-stream-index":"014"},"google_vision_config":{"$ref":"#/components/schemas/GoogleVisionConfig","description":"Configuration for Google Vision integration","title":"Google Vision Config","x-stream-index":"009"},"key":{"description":"Unique identifier for the moderation configuration","title":"Key","type":"string","x-stream-index":"001"},"rule_builder_config":{"$ref":"#/components/schemas/RuleBuilderConfig","description":"Configuration for custom rule builder (max 3 rules, max 5 conditions per rule)","title":"Rule Builder Config","x-stream-index":"013"},"team":{"description":"Team associated with the configuration","maxLength":128,"minLength":1,"title":"Team","type":"string","x-stream-index":"002"},"velocity_filter_config":{"$ref":"#/components/schemas/VelocityFilterConfig","description":"Configuration for velocity-based filtering","title":"Velocity Filter Config","x-stream-index":"012"},"video_call_rule_config":{"$ref":"#/components/schemas/VideoCallRuleConfig","x-stream-index":"016"}},"required":["key"],"type":"object"},"UpsertConfigResponse":{"nullable":true,"properties":{"config":{"$ref":"#/components/schemas/ConfigResponse","description":"The created or updated moderation configuration","title":"Config","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["duration"],"type":"object"},"User":{"properties":{"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"046"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"017"},"banned":{"type":"boolean","x-stream-index":"016"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"013"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"023"},"language":{"type":"string","x-stream-index":"035"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"026"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"042"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"005"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"009"}},"required":["id","role","teams_role","custom","banned","online"],"type":"object"},"UserCreatedWithinParameters":{"properties":{"max_age":{"type":"string","x-stream-index":"001"}},"type":"object"},"UserMute":{"nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"expires":{"description":"Date/time of mute expiration","format":"date-time","title":"Expires","type":"number","x-stream-index":"008"},"target":{"$ref":"#/components/schemas/User","description":"User who's muted","title":"Target","x-stream-index":"007"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/User","description":"Owner of channel mute","title":"User","x-stream-index":"005"}},"required":["created_at","updated_at"],"type":"object"},"UserRequest":{"description":"User request object","properties":{"custom":{"additionalProperties":{},"description":"Custom user data","title":"Custom","type":"object","x-stream-index":"004"},"id":{"description":"User ID","title":"ID","type":"string","x-stream-index":"001"},"image":{"description":"User's profile image URL","title":"Image","type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"006"},"language":{"type":"string","x-stream-index":"005"},"name":{"description":"Optional name of user","title":"Name","type":"string","x-stream-index":"002"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"007"}},"required":["id"],"title":"UserRequest","type":"object"},"UserResponse":{"description":"User response object","properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"banned":{"description":"Whether a user is banned or not","title":"Banned","type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.017"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"001.004"},"deactivated_at":{"description":"Date of deactivation","format":"date-time","title":"Deactivated at","type":"number","x-stream-index":"001.016"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"001.011"},"id":{"description":"Unique user identifier","title":"ID","type":"string","x-stream-index":"001.001"},"image":{"title":"Image","type":"string","x-stream-index":"001.003"},"language":{"description":"Preferred language of a user","title":"Language","type":"string","x-stream-index":"001.005"},"last_active":{"description":"Date of last activity","format":"date-time","title":"Last active","type":"number","x-stream-index":"001.014"},"name":{"description":"Optional name of user","title":"Name","type":"string","x-stream-index":"001.002"},"online":{"description":"Whether a user online or not","title":"Online","type":"boolean","x-stream-index":"001.013"},"revoke_tokens_issued_before":{"description":"Revocation date for tokens","format":"date-time","title":"Revoke tokens issued before","type":"number","x-stream-index":"001.015"},"role":{"description":"Determines the set of user permissions","title":"Role","type":"string","x-stream-index":"001.006"},"teams":{"description":"List of teams user is a part of","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids","shadow_banned","invisible"],"title":"UserResponse","type":"object"},"UserRuleParameters":{"properties":{"max_age":{"type":"string","x-stream-index":"001"}},"type":"object"},"VelocityFilterConfig":{"properties":{"advanced_filters":{"type":"boolean","x-stream-index":"007"},"async":{"type":"boolean","x-stream-index":"001"},"cascading_actions":{"type":"boolean","x-stream-index":"004"},"cids_per_user":{"format":"int32","type":"integer","x-stream-index":"006"},"enabled":{"type":"boolean","x-stream-index":"002"},"first_message_only":{"type":"boolean","x-stream-index":"005"},"rules":{"items":{"$ref":"#/components/schemas/VelocityFilterConfigRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules","cascading_actions","first_message_only","cids_per_user","advanced_filters"],"type":"object"},"VelocityFilterConfigRule":{"properties":{"action":{"enum":["flag","shadow","remove","ban"],"type":"string","x-stream-index":"001"},"ban_duration":{"format":"int32","type":"integer","x-stream-index":"002"},"cascading_action":{"enum":["flag","shadow","remove","ban"],"type":"string","x-stream-index":"006"},"cascading_threshold":{"format":"int64","type":"integer","x-stream-index":"005"},"check_message_context":{"type":"boolean","x-stream-index":"009"},"fast_spam_threshold":{"format":"int32","type":"integer","x-stream-index":"007"},"fast_spam_ttl":{"format":"int32","type":"integer","x-stream-index":"010"},"ip_ban":{"type":"boolean","x-stream-index":"004"},"probation_period":{"format":"int32","type":"integer","x-stream-index":"014"},"shadow_ban":{"type":"boolean","x-stream-index":"003"},"slow_spam_ban_duration":{"format":"int32","type":"integer","x-stream-index":"012"},"slow_spam_threshold":{"format":"int32","type":"integer","x-stream-index":"008"},"slow_spam_ttl":{"format":"int32","type":"integer","x-stream-index":"011"},"url_only":{"type":"boolean","x-stream-index":"013"}},"required":["action","ban_duration","shadow_ban","ip_ban","cascading_threshold","cascading_action","fast_spam_threshold","slow_spam_threshold","check_message_context","fast_spam_ttl","slow_spam_ttl","url_only","probation_period"],"type":"object"},"VideoCallRuleConfig":{"properties":{"rules":{"additionalProperties":{"$ref":"#/components/schemas/HarmConfig"},"type":"object","x-stream-index":"001"}},"required":["rules"],"type":"object"},"VideoContentParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"type":"object"},"VideoEndCallRequest":{"type":"object"},"VideoKickUserRequest":{"type":"object"},"VideoOrientation":{"properties":{"orientation":{"type":"integer","x-stream-index":"004"}},"type":"object"},"VideoRuleParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"required":["threshold","time_window"],"type":"object"},"VideoSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"camera_default_on":{"type":"boolean","x-stream-index":"004"},"camera_facing":{"enum":["front","back","external"],"type":"string","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled","target_resolution","camera_default_on","camera_facing"],"type":"object"},"VideoSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"camera_default_on":{"type":"boolean","x-stream-index":"004"},"camera_facing":{"enum":["front","back","external"],"type":"string","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled","target_resolution","camera_default_on","camera_facing"],"type":"object"},"WSEvent":{"description":"The discriminator object for all websocket events, it maps events' payload to the final type","discriminator":{"mapping":{"moderation.custom_action":"#/components/schemas/ModerationCustomActionEvent","moderation.flagged":"#/components/schemas/ModerationFlaggedEvent","moderation.mark_reviewed":"#/components/schemas/ModerationMarkReviewedEvent"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/ModerationCustomActionEvent"},{"$ref":"#/components/schemas/ModerationFlaggedEvent"},{"$ref":"#/components/schemas/ModerationMarkReviewedEvent"}]}},"securitySchemes":{"JWT":{"description":"JWT should be always provided when stream-auth-type=jwt.\n\nUsing JWT auth request could be authenticated as user or as server-side.\n\nWhen using user authentication permission checking is going to be applied to requests based on the user that is\nperforming a request.\n\nThe `authorization` header should be a JWT string signed using the secret attached to the API key used to perform\nrequests.\n\n**WARNING** all client-side official SDK do not ship with token generation; this is to make sure that the API secret is not\nshared with an untrusted party such as a browser or a iOS/Android application. Tokens **must** be generated server-side.\nIf you wish, you can configure your application to ignore authentication (see `disable_auth_check`)\nThe JWT string must include only the user_id claim and can include any built-in JWT claim such as iat, exp as well.\n","in":"header","name":"Authorization","type":"apiKey"},"api_key":{"description":"Application API key should be always set in order to authenticate the request.","in":"query","name":"api_key","type":"apiKey"},"stream-auth-type":{"description":"Stream-Auth-Type should be always set in order to authenticate the request. Possible\nvalues: `jwt` or `anonymous`.\n\n`jwt` allows you to authenticate as a user. With this auth type you should also provide valid JWT in Authorization\nheader.\n\n`anonymous` allows you to authenticate as anonymous user. Please note that most advanced features are not available\nto anonymous users.","in":"header","name":"Stream-Auth-Type","type":"apiKey"}}},"info":{"title":"Stream API","version":"v187.13.0"},"openapi":"3.0.3","paths":{"/api/v2/moderation/ban":{"post":{"description":"Ban a user from a channel or the entire app\n","operationId":"ban","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BanRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BanResponse"}}},"description":"Successful 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":"Ban","tags":["product:moderation"]}},"/api/v2/moderation/config":{"post":{"description":"Create a new moderation configuration or update an existing one. Configure settings for content filtering, AI analysis, toxicity detection, and other moderation features.\n","operationId":"upsert_config","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertConfigRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertConfigResponse"}}},"description":"Successful 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":"Create or update moderation configuration","tags":["product:moderation"]}},"/api/v2/moderation/config/{key}":{"delete":{"description":"Delete a specific moderation policy by its name\n","operationId":"delete_config","parameters":[{"in":"path","name":"key","required":true,"schema":{"description":"Key of the moderation configuration to delete","title":"Key","type":"string","x-stream-index":"001"}},{"in":"query","name":"team","schema":{"description":"Team associated with the configuration","title":"Team","type":"string","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteModerationConfigResponse"}}},"description":"Successful 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":"Delete a moderation policy","tags":["product:moderation"]},"get":{"description":"Retrieve a specific moderation configuration by its key and team. This configuration contains settings for various moderation features like toxicity detection, AI analysis, and filtering rules.\n","operationId":"get_config","parameters":[{"in":"path","name":"key","required":true,"schema":{"description":"Key of the moderation configuration to retrieve","title":"Key","type":"string","x-stream-index":"001"}},{"in":"query","name":"team","schema":{"description":"Team associated with the configuration","title":"Team","type":"string","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetConfigResponse"}}},"description":"Successful 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":"Get moderation configuration","tags":["product:moderation"]}},"/api/v2/moderation/configs":{"post":{"description":"Search and filter moderation configurations across your application. This endpoint is designed for building moderation dashboards and managing multiple configuration sets.\n","operationId":"query_moderation_configs","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationConfigsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationConfigsResponse"}}},"description":"Successful 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":"Query moderation configurations","tags":["product:moderation"]}},"/api/v2/moderation/flag":{"post":{"description":"Flag any type of content (messages, users, channels, activities) for moderation review. Supports custom content types and additional metadata for flagged content.\n","operationId":"flag","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlagRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlagResponse"}}},"description":"Successful 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":"Flag content for moderation","tags":["product:moderation"]}},"/api/v2/moderation/mute":{"post":{"description":"Mute a user. Mutes are generally not visible to the user you mute, while block is something you notice.\n","operationId":"mute","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteRequest"}}},"description":"MuteRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteResponse"}}},"description":"MuteResponse"},"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":"Mute","tags":["product:moderation"]}},"/api/v2/moderation/review_queue":{"post":{"description":"Query review queue items allows you to filter the review queue items. This is used for building a moderation dashboard.\n","operationId":"query_review_queue","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryReviewQueueRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryReviewQueueResponse"}}},"description":"Successful 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":"Query review queue items","tags":["product:moderation"]}},"/api/v2/moderation/submit_action":{"post":{"description":"Take action on flagged content, such as marking content as safe, deleting content, banning users, or executing custom moderation actions. Supports various action types with configurable parameters.\n","operationId":"submit_action","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitActionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitActionResponse"}}},"description":"Successful 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":"Submit moderation action","tags":["product:moderation"]}}},"security":[{"JWT":[],"api_key":[],"stream-auth-type":[]},{"api_key":[],"stream-auth-type":[]}],"servers":[{"description":"Stream API","url":"https://chat.stream-io-api.com"}]} \ No newline at end of file +{"components":{"schemas":{"AIImageConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"ocr_rules":{"items":{"$ref":"#/components/schemas/OCRRule"},"type":"array","x-stream-index":"004"},"rules":{"items":{"$ref":"#/components/schemas/AWSRekognitionRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules","ocr_rules"],"type":"object"},"AITextConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"profile":{"type":"string","x-stream-index":"003"},"rules":{"items":{"$ref":"#/components/schemas/BodyguardRule"},"type":"array","x-stream-index":"004"},"severity_rules":{"items":{"$ref":"#/components/schemas/BodyguardSeverityRule"},"type":"array","x-stream-index":"005"}},"required":["enabled","profile","rules","severity_rules"],"type":"object"},"AIVideoConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AWSRekognitionRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"APIError":{"nullable":true,"properties":{"StatusCode":{"description":"Response HTTP status code","format":"int32","title":"Status code","type":"integer","x-stream-index":"004"},"code":{"description":"API error code","format":"int32","title":"Code","type":"integer","x-stream-index":"001"},"details":{"description":"Additional error-specific information","items":{"type":"integer"},"title":"Details","type":"array","x-stream-index":"007"},"duration":{"description":"Request duration","title":"Duration","type":"string","x-stream-index":"005"},"exception_fields":{"additionalProperties":{"type":"string"},"description":"Additional error info","title":"Exception fields","type":"object","x-stream-index":"003"},"message":{"description":"Message describing an error","title":"Message","type":"string","x-stream-index":"002"},"more_info":{"description":"URL with additional information","title":"More info","type":"string","x-stream-index":"006"},"unrecoverable":{"description":"Flag that indicates if the error is unrecoverable, requests that return unrecoverable errors should not be retried, this error only applies to the request that caused it","title":"Unrecoverable","type":"boolean","x-stream-index":"008"}},"required":["code","message","StatusCode","duration","more_info","details"],"title":"Error response","type":"object"},"APNS":{"properties":{"body":{"type":"string","x-stream-index":"002"},"content-available":{"format":"int32","type":"integer","x-stream-index":"004"},"data":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"mutable-content":{"format":"int32","type":"integer","x-stream-index":"005"},"sound":{"type":"string","x-stream-index":"003"},"title":{"type":"string","x-stream-index":"001"}},"required":["title","body"],"type":"object"},"AWSRekognitionRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"},"min_confidence":{"format":"float","maximum":100,"minimum":0,"type":"number","x-stream-index":"003"}},"required":["label","action","min_confidence"],"type":"object"},"Action":{"nullable":true,"properties":{"name":{"type":"string","x-stream-index":"001"},"style":{"type":"string","x-stream-index":"003"},"text":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"004"},"value":{"type":"string","x-stream-index":"005"}},"required":["name","text","type"],"type":"object"},"ActionLog":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"002"},"reason":{"type":"string","x-stream-index":"008"},"reporter_type":{"type":"string","x-stream-index":"009"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"014"},"review_queue_item_id":{"type":"string","x-stream-index":"012"},"target_user":{"$ref":"#/components/schemas/User","x-stream-index":"013"},"target_user_id":{"type":"string","x-stream-index":"011"},"type":{"type":"string","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007"}},"required":["id","created_at","type","reason","reporter_type","custom","target_user_id","review_queue_item_id"],"type":"object"},"ActionLogResponse":{"nullable":true,"properties":{"created_at":{"description":"Timestamp when the action was taken","format":"date-time","title":"Created At","type":"number","x-stream-index":"002"},"custom":{"additionalProperties":{},"description":"Additional metadata about the action","title":"Custom","type":"object","x-stream-index":"007"},"id":{"description":"Unique identifier of the action log","title":"ID","type":"string","x-stream-index":"001"},"reason":{"description":"Reason for the moderation action","title":"Reason","type":"string","x-stream-index":"006"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"Associated review queue item","title":"Review Queue Item","x-stream-index":"008"},"target_user":{"$ref":"#/components/schemas/UserResponse","description":"User who was the target of the action","title":"Target User","x-stream-index":"009"},"target_user_id":{"description":"ID of the user who was the target of the action","title":"Target User ID","type":"string","x-stream-index":"010"},"type":{"description":"Type of moderation action","title":"Type","type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who performed the action","title":"User","x-stream-index":"004"},"user_id":{"description":"ID of the user who performed the action","title":"User ID","type":"string","x-stream-index":"005"}},"required":["id","created_at","type","user_id","reason","custom","target_user_id"],"type":"object"},"ActionSequence":{"properties":{"action":{"type":"string","x-stream-index":"001"},"blur":{"type":"boolean","x-stream-index":"005"},"cooldown_period":{"format":"int32","type":"integer","x-stream-index":"004"},"threshold":{"format":"int32","type":"integer","x-stream-index":"002"},"time_window":{"format":"int32","type":"integer","x-stream-index":"003"},"warning":{"type":"boolean","x-stream-index":"006"},"warning_text":{"type":"string","x-stream-index":"007"}},"required":["action","threshold","time_window","cooldown_period","blur","warning","warning_text"],"type":"object"},"Attachment":{"description":"An attachment is a message object that represents a file uploaded by a user.","nullable":true,"properties":{"actions":{"items":{"$ref":"#/components/schemas/Action"},"type":"array","x-stream-index":"015"},"asset_url":{"type":"string","x-stream-index":"017"},"author_icon":{"type":"string","x-stream-index":"007"},"author_link":{"type":"string","x-stream-index":"006"},"author_name":{"type":"string","x-stream-index":"005"},"color":{"type":"string","x-stream-index":"003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"018"},"fallback":{"type":"string","x-stream-index":"002"},"fields":{"items":{"$ref":"#/components/schemas/Field"},"type":"array","x-stream-index":"016"},"footer":{"type":"string","x-stream-index":"013"},"footer_icon":{"type":"string","x-stream-index":"014"},"giphy":{"$ref":"#/components/schemas/Images","x-stream-index":"019"},"image_url":{"type":"string","x-stream-index":"011"},"og_scrape_url":{"type":"string","x-stream-index":"020"},"original_height":{"format":"int32","type":"integer","x-stream-index":"022"},"original_width":{"format":"int32","type":"integer","x-stream-index":"021"},"pretext":{"type":"string","x-stream-index":"004"},"text":{"type":"string","x-stream-index":"010"},"thumb_url":{"type":"string","x-stream-index":"012"},"title":{"type":"string","x-stream-index":"008"},"title_link":{"type":"string","x-stream-index":"009"},"type":{"description":"Attachment type (e.g. image, video, url)","title":"Type","type":"string","x-stream-index":"001"}},"required":["custom"],"title":"Attachment","type":"object","x-stream-docs-page-id":"file_uploads"},"AudioSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"001"},"default_device":{"enum":["speaker","earpiece"],"type":"string","x-stream-index":"006"},"mic_default_on":{"type":"boolean","x-stream-index":"004"},"noise_cancellation":{"$ref":"#/components/schemas/NoiseCancellationSettings","x-stream-index":"007"},"opus_dtx_enabled":{"type":"boolean","x-stream-index":"002"},"redundant_coding_enabled":{"type":"boolean","x-stream-index":"003"},"speaker_default_on":{"type":"boolean","x-stream-index":"005"}},"required":["access_request_enabled","opus_dtx_enabled","redundant_coding_enabled","mic_default_on","speaker_default_on","default_device"],"type":"object"},"AudioSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"001"},"default_device":{"enum":["speaker","earpiece"],"type":"string","x-stream-index":"006"},"mic_default_on":{"type":"boolean","x-stream-index":"004"},"noise_cancellation":{"$ref":"#/components/schemas/NoiseCancellationSettings","x-stream-index":"007"},"opus_dtx_enabled":{"type":"boolean","x-stream-index":"002"},"redundant_coding_enabled":{"type":"boolean","x-stream-index":"003"},"speaker_default_on":{"type":"boolean","x-stream-index":"005"}},"required":["access_request_enabled","opus_dtx_enabled","redundant_coding_enabled","mic_default_on","speaker_default_on","default_device"],"type":"object"},"AutomodPlatformCircumventionConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AutomodRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"AutomodRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"003"},"label":{"type":"string","x-stream-index":"001"},"threshold":{"format":"float","maximum":1,"minimum":0,"type":"number","x-stream-index":"002"}},"required":["label","threshold","action"],"type":"object"},"AutomodSemanticFiltersConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AutomodSemanticFiltersRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"AutomodSemanticFiltersRule":{"properties":{"action":{"enum":["flag","shadow","remove"],"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"threshold":{"format":"float","maximum":1,"minimum":0,"type":"number","x-stream-index":"002"}},"required":["name","threshold","action"],"type":"object"},"AutomodToxicityConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AutomodRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"BackstageSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"BackstageSettingsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"Ban":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"012"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"011"},"expires":{"format":"date-time","type":"number","x-stream-index":"007"},"reason":{"type":"string","x-stream-index":"008"},"shadow":{"type":"boolean","x-stream-index":"009"},"target":{"$ref":"#/components/schemas/User","x-stream-index":"006"}},"required":["shadow","created_at"],"type":"object"},"BanActionRequest":{"properties":{"channel_ban_only":{"type":"boolean","x-stream-index":"003"},"delete_messages":{"enum":["soft","pruning","hard"],"type":"string","x-stream-index":"005"},"ip_ban":{"type":"boolean","x-stream-index":"004"},"reason":{"type":"string","x-stream-index":"002"},"shadow":{"type":"boolean","x-stream-index":"001"},"timeout":{"format":"int32","type":"integer","x-stream-index":"006"}},"type":"object"},"BanOptions":{"properties":{"duration":{"format":"int32","type":"integer","x-stream-index":"001"},"ip_ban":{"type":"boolean","x-stream-index":"004"},"reason":{"type":"string","x-stream-index":"002"},"shadow_ban":{"type":"boolean","x-stream-index":"003"}},"type":"object"},"BanRequest":{"nullable":true,"properties":{"banned_by":{"$ref":"#/components/schemas/UserRequest","description":"Details about the user performing the ban","title":"Banned By","x-stream-index":"008"},"banned_by_id":{"description":"ID of the user performing the ban","title":"Banned By ID","type":"string","x-stream-index":"007"},"channel_cid":{"description":"Channel where the ban applies","title":"Channel CID","type":"string","x-stream-index":"004"},"delete_messages":{"enum":["soft","pruning","hard"],"type":"string","x-stream-index":"009"},"ip_ban":{"description":"Whether to ban the user's IP address","title":"IP Ban","type":"boolean","x-stream-index":"006"},"reason":{"description":"Optional explanation for the ban","title":"Reason","type":"string","x-stream-index":"003"},"shadow":{"description":"Whether this is a shadow ban","title":"Shadow","type":"boolean","x-stream-index":"005"},"target_user_id":{"description":"ID of the user to ban","title":"Target User ID","type":"string","x-stream-index":"001"},"timeout":{"description":"Duration of the ban in minutes","minimum":0,"title":"Timeout","type":"integer","x-stream-index":"002"}},"required":["target_user_id"],"type":"object"},"BanResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"BlockContentOptions":{"properties":{"reason":{"type":"string","x-stream-index":"001"}},"type":"object"},"BlockListConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/BlockListRule"},"maximum":10,"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"BlockListOptions":{"properties":{"behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"002"},"blocklist":{"type":"string","x-stream-index":"001"}},"required":["blocklist","behavior"],"type":"object"},"BlockListRule":{"properties":{"action":{"enum":["flag","mask_flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"002"}},"required":["name","team","action"],"type":"object"},"BodyguardRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"},"severity_rules":{"items":{"$ref":"#/components/schemas/BodyguardSeverityRule"},"type":"array","x-stream-index":"003"}},"required":["label","action","severity_rules"],"type":"object"},"BodyguardSeverityRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"severity":{"enum":["low","medium","high","critical"],"type":"string","x-stream-index":"001"}},"required":["severity","action"],"type":"object"},"BroadcastSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettings","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettings","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"BroadcastSettingsResponse":{"description":"BroadcastSettingsResponse is the payload for broadcasting settings","properties":{"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettingsResponse","title":"HLS","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettingsResponse","title":"RTMP","x-stream-index":"003"}},"required":["enabled","hls","rtmp"],"title":"BroadcastSettingsResponse","type":"object"},"Call":{"properties":{"AppPK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"002"},"Backstage":{"type":"boolean","writeOnly":true,"x-stream-index":"023"},"BlockedUserIDs":{"items":{"type":"string"},"type":"array","writeOnly":true,"x-stream-index":"018"},"BlockedUsers":{"items":{"$ref":"#/components/schemas/User"},"type":"array","writeOnly":true,"x-stream-index":"019"},"CID":{"type":"string","writeOnly":true,"x-stream-index":"005"},"CallType":{"$ref":"#/components/schemas/CallType","x-stream-index":"020"},"ChannelCID":{"type":"string","writeOnly":true,"x-stream-index":"032"},"CreatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"013"},"CreatedBy":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"CreatedByUserID":{"type":"string","writeOnly":true,"x-stream-index":"007"},"CurrentSessionID":{"type":"string","writeOnly":true,"x-stream-index":"024"},"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"012"},"DeletedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"028"},"EgressUpdatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"027"},"Egresses":{"items":{"$ref":"#/components/schemas/CallEgress"},"type":"array","writeOnly":true,"x-stream-index":"015"},"EndedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"017"},"ID":{"type":"string","writeOnly":true,"x-stream-index":"004"},"JoinAheadTimeSeconds":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"031"},"LastHeartbeatAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"030"},"LastSessionID":{"type":"string","writeOnly":true,"x-stream-index":"025"},"MemberCount":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"010"},"MemberLookup":{"$ref":"#/components/schemas/MemberLookup","x-stream-index":"011"},"Members":{"items":{"$ref":"#/components/schemas/CallMember"},"type":"array","writeOnly":true,"x-stream-index":"009"},"Session":{"$ref":"#/components/schemas/CallSession","x-stream-index":"026"},"Settings":{"$ref":"#/components/schemas/CallSettings","x-stream-index":"022"},"SettingsOverrides":{"$ref":"#/components/schemas/CallSettings","x-stream-index":"021"},"StartsAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"016"},"Team":{"type":"string","writeOnly":true,"x-stream-index":"006"},"ThumbnailURL":{"type":"string","writeOnly":true,"x-stream-index":"029"},"Type":{"type":"string","writeOnly":true,"x-stream-index":"003"},"UpdatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"014"}},"required":["AppPK","Type","ID","CID","Team","CreatedByUserID","Members","Custom","CreatedAt","UpdatedAt","Egresses","BlockedUserIDs","BlockedUsers","Backstage","CurrentSessionID","LastSessionID","ThumbnailURL","ChannelCID"],"type":"object"},"CallEgress":{"nullable":true,"properties":{"app_pk":{"format":"int32","type":"integer","x-stream-index":"002"},"call_id":{"type":"string","x-stream-index":"004"},"call_type":{"type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/EgressTaskConfig","x-stream-index":"007"},"egress_id":{"type":"string","x-stream-index":"005"},"egress_type":{"type":"string","x-stream-index":"006"},"instance_ip":{"type":"string","x-stream-index":"008"},"started_at":{"format":"date-time","type":"number","x-stream-index":"010"},"state":{"type":"string","x-stream-index":"009"},"stopped_at":{"format":"date-time","type":"number","x-stream-index":"011"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"012"}},"required":["app_pk","call_type","call_id","egress_id","egress_type","instance_ip","state","started_at","updated_at"],"type":"object"},"CallIngressResponse":{"description":"CallIngressResponse is the payload for ingress settings","properties":{"rtmp":{"$ref":"#/components/schemas/RTMPIngress","title":"RTMP","x-stream-index":"001"}},"required":["rtmp"],"title":"CallIngressResponse","type":"object"},"CallMember":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"010"},"role":{"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["user_id","role","custom","created_at","updated_at"],"type":"object"},"CallParticipant":{"nullable":true,"properties":{"JoinedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"004"},"Role":{"type":"string","writeOnly":true,"x-stream-index":"002"},"UserSessionID":{"type":"string","writeOnly":true,"x-stream-index":"003"},"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"001.046"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"001.017"},"banned":{"type":"boolean","x-stream-index":"001.016"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.013"},"id":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"001.023"},"language":{"type":"string","x-stream-index":"001.035"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"001.022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"001.026"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.042"},"role":{"type":"string","x-stream-index":"001.004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.005"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.009"}},"required":["id","role","teams_role","custom","banned","online","Role","UserSessionID","JoinedAt"],"type":"object"},"CallParticipantResponse":{"properties":{"joined_at":{"format":"date-time","type":"number","x-stream-index":"004"},"role":{"type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"},"user_session_id":{"type":"string","x-stream-index":"002"}},"required":["user","user_session_id","role","joined_at"],"type":"object"},"CallResponse":{"description":"Represents a call","properties":{"backstage":{"type":"boolean","x-stream-index":"016"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"018"},"captioning":{"type":"boolean","x-stream-index":"013"},"channel_cid":{"type":"string","x-stream-index":"024"},"cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"The user that created the call","title":"Created By","x-stream-index":"007"},"current_session_id":{"type":"string","x-stream-index":"005"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"008"},"egress":{"$ref":"#/components/schemas/EgressResponse","x-stream-index":"021"},"ended_at":{"description":"Date/time when the call ended","format":"date-time","title":"Ended At","type":"number","x-stream-index":"014"},"id":{"description":"Call ID","title":"ID","type":"string","x-stream-index":"003"},"ingress":{"$ref":"#/components/schemas/CallIngressResponse","x-stream-index":"019"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"023"},"recording":{"type":"boolean","x-stream-index":"011"},"session":{"$ref":"#/components/schemas/CallSessionResponse","x-stream-index":"020"},"settings":{"$ref":"#/components/schemas/CallSettingsResponse","x-stream-index":"017"},"starts_at":{"description":"Date/time when the call will start","format":"date-time","title":"Starts At","type":"number","x-stream-index":"015"},"team":{"type":"string","x-stream-index":"006"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailResponse","x-stream-index":"022"},"transcribing":{"type":"boolean","x-stream-index":"012"},"type":{"description":"The type of call","title":"Type","type":"string","x-stream-index":"002"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"}},"required":["type","id","cid","current_session_id","created_by","custom","created_at","updated_at","recording","transcribing","captioning","backstage","settings","blocked_user_ids","ingress","egress"],"title":"CallResponse","type":"object"},"CallSession":{"properties":{"AcceptedBy":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","writeOnly":true,"x-stream-index":"008"},"ActiveSFUs":{"items":{"$ref":"#/components/schemas/SFUIDLastSeen"},"type":"array","writeOnly":true,"x-stream-index":"016"},"AnonymousParticipantCount":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"019"},"AppPK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"002.001"},"CallID":{"type":"string","writeOnly":true,"x-stream-index":"002.003"},"CallType":{"type":"string","writeOnly":true,"x-stream-index":"002.002"},"CreatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"003"},"DeletedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"004"},"EndedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"006"},"LiveEndedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"013"},"LiveStartedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"012"},"MissedBy":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","writeOnly":true,"x-stream-index":"010"},"Participants":{"items":{"$ref":"#/components/schemas/CallParticipant"},"type":"array","writeOnly":true,"x-stream-index":"011"},"ParticipantsCountByRole":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","writeOnly":true,"x-stream-index":"018"},"RejectedBy":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","writeOnly":true,"x-stream-index":"009"},"RingAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"007"},"SFUIDs":{"items":{"type":"string"},"type":"array","writeOnly":true,"x-stream-index":"015"},"SessionID":{"type":"string","writeOnly":true,"x-stream-index":"002.004"},"StartedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"005"},"TimerEndsAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"014"},"UserPermissionOverrides":{"additionalProperties":{"additionalProperties":{"type":"boolean"},"type":"object"},"type":"object","writeOnly":true,"x-stream-index":"017"}},"required":["AppPK","CallType","CallID","SessionID","CreatedAt","AcceptedBy","RejectedBy","MissedBy","Participants","SFUIDs","ActiveSFUs","UserPermissionOverrides","ParticipantsCountByRole","AnonymousParticipantCount"],"type":"object"},"CallSessionResponse":{"properties":{"accepted_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"008"},"anonymous_participant_count":{"format":"int32","type":"integer","x-stream-index":"006"},"ended_at":{"format":"date-time","type":"number","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"live_ended_at":{"format":"date-time","type":"number","x-stream-index":"011"},"live_started_at":{"format":"date-time","type":"number","x-stream-index":"010"},"missed_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"009"},"participants":{"items":{"$ref":"#/components/schemas/CallParticipantResponse"},"type":"array","x-stream-index":"004"},"participants_count_by_role":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"005"},"rejected_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"007"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002"},"timer_ends_at":{"format":"date-time","type":"number","x-stream-index":"012"}},"required":["id","participants","participants_count_by_role","anonymous_participant_count","rejected_by","accepted_by","missed_by"],"type":"object"},"CallSettings":{"properties":{"audio":{"$ref":"#/components/schemas/AudioSettings","x-stream-index":"001"},"backstage":{"$ref":"#/components/schemas/BackstageSettings","x-stream-index":"002"},"broadcasting":{"$ref":"#/components/schemas/BroadcastSettings","x-stream-index":"007"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordSettings","x-stream-index":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettings","x-stream-index":"008"},"ingress":{"$ref":"#/components/schemas/IngressSettings","x-stream-index":"014"},"limits":{"$ref":"#/components/schemas/LimitsSettings","x-stream-index":"012"},"recording":{"$ref":"#/components/schemas/RecordSettings","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettings","x-stream-index":"010"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettings","x-stream-index":"004"},"session":{"$ref":"#/components/schemas/SessionSettings","x-stream-index":"013"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettings","x-stream-index":"011"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettings","x-stream-index":"009"},"video":{"$ref":"#/components/schemas/VideoSettings","x-stream-index":"003"}},"type":"object"},"CallSettingsResponse":{"properties":{"audio":{"$ref":"#/components/schemas/AudioSettingsResponse","x-stream-index":"001"},"backstage":{"$ref":"#/components/schemas/BackstageSettingsResponse","x-stream-index":"002"},"broadcasting":{"$ref":"#/components/schemas/BroadcastSettingsResponse","x-stream-index":"003"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordingSettingsResponse","x-stream-index":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettingsResponse","x-stream-index":"004"},"ingress":{"$ref":"#/components/schemas/IngressSettingsResponse","x-stream-index":"014"},"limits":{"$ref":"#/components/schemas/LimitsSettingsResponse","x-stream-index":"012"},"recording":{"$ref":"#/components/schemas/RecordSettingsResponse","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettingsResponse","x-stream-index":"007"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettingsResponse","x-stream-index":"008"},"session":{"$ref":"#/components/schemas/SessionSettingsResponse","x-stream-index":"013"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettingsResponse","x-stream-index":"011"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettingsResponse","x-stream-index":"009"},"video":{"$ref":"#/components/schemas/VideoSettingsResponse","x-stream-index":"010"}},"required":["audio","backstage","broadcasting","geofencing","recording","frame_recording","ring","screensharing","transcription","video","thumbnails","limits","session"],"type":"object"},"CallType":{"properties":{"AppPK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"003"},"CreatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"005"},"ExternalStorage":{"type":"string","writeOnly":true,"x-stream-index":"009"},"Name":{"type":"string","writeOnly":true,"x-stream-index":"004"},"NotificationSettings":{"$ref":"#/components/schemas/NotificationSettings","x-stream-index":"008"},"PK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"002"},"Settings":{"$ref":"#/components/schemas/CallSettings","x-stream-index":"007"},"UpdatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"006"}},"required":["PK","AppPK","Name","CreatedAt","UpdatedAt","ExternalStorage"],"type":"object"},"Channel":{"properties":{"active_live_locations":{"items":{"$ref":"#/components/schemas/SharedLocation"},"type":"array","x-stream-index":"034"},"auto_translation_enabled":{"type":"boolean","x-stream-index":"029"},"auto_translation_language":{"type":"string","x-stream-index":"030"},"cid":{"type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/ChannelConfig","x-stream-index":"026"},"config_overrides":{"$ref":"#/components/schemas/ConfigOverrides","x-stream-index":"027"},"cooldown":{"format":"int32","type":"integer","x-stream-index":"031"},"created_at":{"format":"date-time","type":"number","x-stream-index":"009"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"019"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"disabled":{"type":"boolean","x-stream-index":"017"},"frozen":{"type":"boolean","x-stream-index":"016"},"id":{"type":"string","x-stream-index":"004"},"invites":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"022"},"last_campaigns":{"type":"string","x-stream-index":"032"},"last_message_at":{"format":"date-time","type":"number","x-stream-index":"006"},"member_count":{"format":"int32","type":"integer","x-stream-index":"021"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"020"},"message_count":{"format":"int64","type":"integer","x-stream-index":"035"},"message_count_updated_at":{"format":"date-time","type":"number","x-stream-index":"036"},"team":{"type":"string","x-stream-index":"028"},"truncated_by":{"$ref":"#/components/schemas/User","x-stream-index":"015"},"type":{"type":"string","x-stream-index":"005"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"010"}},"required":["cid","id","type","created_at","updated_at","frozen","disabled","custom","auto_translation_language"],"type":"object"},"ChannelConfig":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.027"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.022"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.023"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.028"},"blocklist":{"type":"string","x-stream-index":"001.024"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.025"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.026"},"commands":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"connect_events":{"type":"boolean","x-stream-index":"001.004"},"count_messages":{"type":"boolean","x-stream-index":"001.019"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"custom_events":{"type":"boolean","x-stream-index":"001.012"},"mark_messages_pending":{"type":"boolean","x-stream-index":"001.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"001.021"},"mutes":{"type":"boolean","x-stream-index":"001.009"},"name":{"type":"string","x-stream-index":"001.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"001.029"},"partition_ttl":{"type":"integer","x-stream-index":"001.030"},"polls":{"type":"boolean","x-stream-index":"001.016"},"push_notifications":{"type":"boolean","x-stream-index":"001.013"},"quotes":{"type":"boolean","x-stream-index":"001.008"},"reactions":{"type":"boolean","x-stream-index":"001.006"},"read_events":{"type":"boolean","x-stream-index":"001.003"},"reminders":{"type":"boolean","x-stream-index":"001.014"},"replies":{"type":"boolean","x-stream-index":"001.007"},"search":{"type":"boolean","x-stream-index":"001.005"},"shared_locations":{"type":"boolean","x-stream-index":"001.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.031"},"typing_events":{"type":"boolean","x-stream-index":"001.002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"002.004"},"uploads":{"type":"boolean","x-stream-index":"001.010"},"url_enrichment":{"type":"boolean","x-stream-index":"001.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"001.017"}},"required":["name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","count_messages","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","created_at","updated_at","commands"],"type":"object"},"ChannelConfigWithInfo":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.002.027"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.002.022"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.023"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.002.028"},"blocklist":{"type":"string","x-stream-index":"001.002.024"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.025"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.002.026"},"commands":{"items":{"$ref":"#/components/schemas/Command"},"type":"array","x-stream-index":"001.003"},"connect_events":{"type":"boolean","x-stream-index":"001.002.004"},"count_messages":{"type":"boolean","x-stream-index":"001.002.019"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.001.003"},"custom_events":{"type":"boolean","x-stream-index":"001.002.012"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"002"},"mark_messages_pending":{"type":"boolean","x-stream-index":"001.002.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"001.002.021"},"mutes":{"type":"boolean","x-stream-index":"001.002.009"},"name":{"type":"string","x-stream-index":"001.002.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"001.002.029"},"partition_ttl":{"type":"integer","x-stream-index":"001.002.030"},"polls":{"type":"boolean","x-stream-index":"001.002.016"},"push_notifications":{"type":"boolean","x-stream-index":"001.002.013"},"quotes":{"type":"boolean","x-stream-index":"001.002.008"},"reactions":{"type":"boolean","x-stream-index":"001.002.006"},"read_events":{"type":"boolean","x-stream-index":"001.002.003"},"reminders":{"type":"boolean","x-stream-index":"001.002.014"},"replies":{"type":"boolean","x-stream-index":"001.002.007"},"search":{"type":"boolean","x-stream-index":"001.002.005"},"shared_locations":{"type":"boolean","x-stream-index":"001.002.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.002.031"},"typing_events":{"type":"boolean","x-stream-index":"001.002.002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"uploads":{"type":"boolean","x-stream-index":"001.002.010"},"url_enrichment":{"type":"boolean","x-stream-index":"001.002.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"001.002.017"}},"required":["created_at","updated_at","name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","count_messages","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","commands"],"type":"object"},"ChannelMember":{"nullable":true,"properties":{"archived_at":{"format":"date-time","type":"number","x-stream-index":"021"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"017"},"banned":{"type":"boolean","x-stream-index":"016"},"channel_role":{"type":"string","x-stream-index":"024"},"created_at":{"format":"date-time","type":"number","x-stream-index":"012"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"014"},"deleted_messages":{"items":{"type":"string"},"type":"array","x-stream-index":"027"},"invite_accepted_at":{"format":"date-time","type":"number","x-stream-index":"009"},"invite_rejected_at":{"format":"date-time","type":"number","x-stream-index":"010"},"invited":{"type":"boolean","x-stream-index":"008"},"is_global_banned":{"type":"boolean","x-stream-index":"020"},"is_moderator":{"type":"boolean","x-stream-index":"007"},"notifications_muted":{"type":"boolean","x-stream-index":"026"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"022"},"shadow_banned":{"type":"boolean","x-stream-index":"019"},"status":{"type":"string","x-stream-index":"011"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"013"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["custom","created_at","updated_at","banned","shadow_banned","is_global_banned","channel_role","notifications_muted"],"type":"object"},"ChannelMute":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"007"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"expires":{"description":"Date/time of mute expiration","format":"date-time","title":"Expires","type":"number","x-stream-index":"008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/User","description":"Owner of channel mute","title":"User","x-stream-index":"005"}},"required":["created_at","updated_at"],"type":"object"},"ChannelResponse":{"properties":{"auto_translation_enabled":{"type":"boolean","x-stream-index":"021"},"auto_translation_language":{"type":"string","x-stream-index":"022"},"blocked":{"type":"boolean","x-stream-index":"027"},"cid":{"type":"string","x-stream-index":"005"},"config":{"$ref":"#/components/schemas/ChannelConfigWithInfo","x-stream-index":"017"},"cooldown":{"format":"int32","type":"integer","x-stream-index":"024"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"011"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"030"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"010"},"disabled":{"type":"boolean","x-stream-index":"013"},"frozen":{"type":"boolean","x-stream-index":"012"},"hidden":{"type":"boolean","x-stream-index":"026"},"hide_messages_before":{"format":"date-time","type":"number","x-stream-index":"023"},"id":{"type":"string","x-stream-index":"003"},"last_message_at":{"format":"date-time","type":"number","x-stream-index":"006"},"member_count":{"format":"int32","type":"integer","x-stream-index":"015"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"014"},"message_count":{"format":"int64","type":"integer","x-stream-index":"031"},"mute_expires_at":{"format":"date-time","type":"number","x-stream-index":"019"},"muted":{"type":"boolean","x-stream-index":"018"},"own_capabilities":{"items":{"type":"string"},"type":"array","x-stream-index":"025"},"team":{"type":"string","x-stream-index":"020"},"truncated_at":{"format":"date-time","type":"number","x-stream-index":"028"},"truncated_by":{"$ref":"#/components/schemas/User","x-stream-index":"029"},"type":{"type":"string","x-stream-index":"004"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"}},"required":["id","type","cid","created_at","updated_at","frozen","disabled","custom"],"type":"object"},"Command":{"description":"Represents custom chat command","nullable":true,"properties":{"args":{"description":"Arguments help text, shown in commands auto-completion","title":"Arguments","type":"string","x-stream-index":"006"},"created_at":{"description":"Date/time of creation","format":"date-time","readOnly":true,"title":"Created at","type":"number","x-stream-index":"001"},"description":{"description":"Description, shown in commands auto-completion","title":"Description","type":"string","x-stream-index":"005"},"name":{"description":"Unique command name","title":"Name","type":"string","x-stream-index":"004"},"set":{"description":"Set name used for grouping commands","title":"Set","type":"string","x-stream-index":"007"},"updated_at":{"description":"Date/time of the last update","format":"date-time","readOnly":true,"title":"Updated at","type":"number","x-stream-index":"002"}},"required":["name","description","args","set"],"title":"Command","type":"object"},"CompositeAppSettings":{"properties":{"json_encoded_settings":{"type":"string","x-stream-index":"005"},"url":{"type":"string","x-stream-index":"004"}},"type":"object"},"ConfigOverrides":{"properties":{"blocklist":{"type":"string","x-stream-index":"008"},"blocklist_behavior":{"enum":["flag","block"],"type":"string","x-stream-index":"009"},"commands":{"items":{"type":"string"},"type":"array","x-stream-index":"011"},"count_messages":{"type":"boolean","x-stream-index":"014"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"010"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"007"},"quotes":{"type":"boolean","x-stream-index":"004"},"reactions":{"type":"boolean","x-stream-index":"002"},"replies":{"type":"boolean","x-stream-index":"003"},"shared_locations":{"type":"boolean","x-stream-index":"013"},"typing_events":{"type":"boolean","x-stream-index":"001"},"uploads":{"type":"boolean","x-stream-index":"005"},"url_enrichment":{"type":"boolean","x-stream-index":"006"},"user_message_reminders":{"type":"boolean","x-stream-index":"012"}},"required":["grants","commands"],"type":"object"},"ConfigResponse":{"properties":{"ai_image_config":{"$ref":"#/components/schemas/AIImageConfig","description":"Configuration for AI image analysis","title":"AI Image Config","x-stream-index":"010"},"ai_text_config":{"$ref":"#/components/schemas/AITextConfig","description":"Configuration for AI text analysis","title":"AI Text Config","x-stream-index":"008"},"ai_video_config":{"$ref":"#/components/schemas/AIVideoConfig","description":"Configuration for AI video analysis","title":"AI Video Config","x-stream-index":"011"},"async":{"description":"Whether moderation should be performed asynchronously","title":"Async","type":"boolean","x-stream-index":"003"},"automod_platform_circumvention_config":{"$ref":"#/components/schemas/AutomodPlatformCircumventionConfig","description":"Configuration for platform circumvention detection","title":"Automod Platform Circumvention Config","x-stream-index":"005"},"automod_semantic_filters_config":{"$ref":"#/components/schemas/AutomodSemanticFiltersConfig","description":"Configuration for semantic filtering","title":"Automod Semantic Filters Config","x-stream-index":"006"},"automod_toxicity_config":{"$ref":"#/components/schemas/AutomodToxicityConfig","description":"Configuration for toxicity detection","title":"Automod Toxicity Config","x-stream-index":"004"},"block_list_config":{"$ref":"#/components/schemas/BlockListConfig","description":"Configuration for block list filtering","title":"Block List Config","x-stream-index":"007"},"created_at":{"description":"When the configuration was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"013"},"key":{"description":"Unique identifier for the moderation configuration","title":"Key","type":"string","x-stream-index":"001"},"llm_config":{"$ref":"#/components/schemas/LLMConfig","description":"Configuration for customer-configured LLM moderation","title":"LLM Config","x-stream-index":"009"},"team":{"description":"Team associated with the configuration","title":"Team","type":"string","x-stream-index":"002"},"updated_at":{"description":"When the configuration was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"014"},"velocity_filter_config":{"$ref":"#/components/schemas/VelocityFilterConfig","description":"Configuration for velocity-based filtering","title":"Velocity Filter Config","x-stream-index":"012"},"video_call_rule_config":{"$ref":"#/components/schemas/VideoCallRuleConfig","x-stream-index":"015"}},"required":["key","team","async","created_at","updated_at"],"type":"object"},"ContentCountRuleParameters":{"properties":{"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"type":"object"},"CustomActionRequest":{"properties":{"id":{"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"type":"object"},"Data":{"properties":{"id":{"type":"string","x-stream-index":"001"}},"required":["id"],"type":"object"},"DeleteActivityRequest":{"properties":{"hard_delete":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"DeleteMessageRequest":{"properties":{"hard_delete":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"DeleteModerationConfigResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"DeleteReactionRequest":{"properties":{"hard_delete":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"DeleteUserRequest":{"properties":{"delete_conversation_channels":{"type":"boolean","x-stream-index":"003"},"delete_feeds_content":{"type":"boolean","x-stream-index":"004"},"hard_delete":{"type":"boolean","x-stream-index":"001"},"mark_messages_deleted":{"type":"boolean","x-stream-index":"002"}},"type":"object"},"Device":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"disabled":{"type":"boolean","x-stream-index":"002.003"},"disabled_reason":{"type":"string","x-stream-index":"002.004"},"id":{"type":"string","x-stream-index":"002.001.004"},"push_provider":{"enum":["firebase","apn","huawei","xiaomi"],"type":"string","x-stream-index":"002.001.001"},"push_provider_name":{"type":"string","x-stream-index":"002.001.003"},"user_id":{"type":"string","x-stream-index":"004"},"voip":{"type":"boolean","x-stream-index":"002.001.005"}},"required":["push_provider","id","created_at","user_id"],"type":"object"},"DraftPayloadResponse":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"html":{"type":"string","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"001"},"mentioned_users":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"008"},"mml":{"type":"string","x-stream-index":"003"},"parent_id":{"type":"string","x-stream-index":"005"},"poll_id":{"type":"string","x-stream-index":"013"},"quoted_message_id":{"type":"string","x-stream-index":"009"},"show_in_channel":{"type":"boolean","x-stream-index":"006"},"silent":{"type":"boolean","x-stream-index":"012"},"text":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"011"}},"required":["id","text","custom"],"type":"object"},"DraftResponse":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003"},"channel_cid":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"message":{"$ref":"#/components/schemas/DraftPayloadResponse","x-stream-index":"001"},"parent_id":{"type":"string","x-stream-index":"004"},"parent_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"005"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"006"}},"required":["message","channel_cid","created_at"],"type":"object"},"EgressHLSResponse":{"properties":{"playlist_url":{"type":"string","x-stream-index":"001"},"status":{"type":"string","x-stream-index":"002"}},"required":["playlist_url","status"],"type":"object"},"EgressRTMPResponse":{"properties":{"name":{"type":"string","x-stream-index":"001"},"started_at":{"format":"date-time","type":"number","x-stream-index":"004"},"stream_key":{"type":"string","x-stream-index":"003"},"stream_url":{"type":"string","x-stream-index":"002"}},"required":["name","started_at"],"type":"object"},"EgressResponse":{"properties":{"broadcasting":{"type":"boolean","x-stream-index":"001"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordingResponse","x-stream-index":"004"},"hls":{"$ref":"#/components/schemas/EgressHLSResponse","x-stream-index":"002"},"rtmps":{"items":{"$ref":"#/components/schemas/EgressRTMPResponse"},"type":"array","x-stream-index":"003"}},"required":["broadcasting","rtmps"],"type":"object"},"EgressTaskConfig":{"properties":{"egress_user":{"$ref":"#/components/schemas/EgressUser","x-stream-index":"008"},"frame_recording_egress_config":{"$ref":"#/components/schemas/FrameRecordingEgressConfig","x-stream-index":"009"},"hls_egress_config":{"$ref":"#/components/schemas/HLSEgressConfig","x-stream-index":"007"},"recording_egress_config":{"$ref":"#/components/schemas/RecordingEgressConfig","x-stream-index":"006"},"rtmp_egress_config":{"$ref":"#/components/schemas/RTMPEgressConfig","x-stream-index":"004"},"stt_egress_config":{"$ref":"#/components/schemas/STTEgressConfig","x-stream-index":"005"}},"type":"object"},"EgressUser":{"properties":{"token":{"type":"string","x-stream-index":"004"}},"type":"object"},"EnrichedActivity":{"properties":{"actor":{"$ref":"#/components/schemas/Data","x-stream-index":"002"},"foreign_id":{"type":"string","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"latest_reactions":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"013"},"object":{"$ref":"#/components/schemas/Data","x-stream-index":"004"},"origin":{"$ref":"#/components/schemas/Data","x-stream-index":"008"},"own_reactions":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"012"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"011"},"score":{"format":"float","type":"number","x-stream-index":"010"},"target":{"$ref":"#/components/schemas/Data","x-stream-index":"006"},"to":{"items":{"type":"string"},"type":"array","x-stream-index":"009"},"verb":{"type":"string","x-stream-index":"003"}},"type":"object"},"EnrichedReaction":{"nullable":true,"properties":{"activity_id":{"type":"string","x-stream-index":"003"},"children_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"010"},"created_at":{"$ref":"#/components/schemas/Time","x-stream-index":"012"},"data":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"kind":{"type":"string","x-stream-index":"002"},"latest_children":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"008"},"own_children":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"009"},"parent":{"type":"string","x-stream-index":"007"},"target_feeds":{"items":{"type":"string"},"type":"array","x-stream-index":"006"},"updated_at":{"$ref":"#/components/schemas/Time","x-stream-index":"013"},"user":{"$ref":"#/components/schemas/Data","x-stream-index":"011"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["kind","activity_id","user_id"],"type":"object"},"EntityCreator":{"properties":{"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"001.046"},"ban_count":{"format":"int32","type":"integer","x-stream-index":"002"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"001.017"},"banned":{"type":"boolean","x-stream-index":"001.016"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.013"},"deleted_content_count":{"format":"int32","type":"integer","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"001.023"},"language":{"type":"string","x-stream-index":"001.035"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"001.022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"001.026"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.042"},"role":{"type":"string","x-stream-index":"001.004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.005"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.009"}},"required":["id","role","teams_role","custom","banned","online","ban_count","deleted_content_count"],"type":"object"},"EntityCreatorResponse":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.001.018"},"ban_count":{"description":"Number of minor actions performed on the user","format":"int32","title":"Ban Count","type":"integer","x-stream-index":"002"},"banned":{"type":"boolean","x-stream-index":"001.001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.001.017"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.001.016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.001.011"},"deleted_content_count":{"description":"Number of major actions performed on the user","format":"int32","title":"Deleted Content Count","type":"integer","x-stream-index":"003"},"flagged_count":{"description":"Number of flag actions performed on the user","format":"int32","title":"Flagged Count","type":"integer","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001.001.001"},"image":{"type":"string","x-stream-index":"001.001.003"},"language":{"type":"string","x-stream-index":"001.001.005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"001.001.014"},"name":{"type":"string","x-stream-index":"001.001.002"},"online":{"type":"boolean","x-stream-index":"001.001.013"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.001.015"},"role":{"type":"string","x-stream-index":"001.001.006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.001.008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids","shadow_banned","invisible","ban_count","deleted_content_count","flagged_count"],"type":"object"},"EventNotificationSettings":{"properties":{"apns":{"$ref":"#/components/schemas/APNS","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"fcm":{"$ref":"#/components/schemas/FCM","x-stream-index":"003"}},"required":["enabled","apns","fcm"],"type":"object"},"ExternalStorage":{"properties":{"abs_account_name":{"type":"string","x-stream-index":"011"},"abs_client_id":{"type":"string","x-stream-index":"013"},"abs_client_secret":{"type":"string","x-stream-index":"014"},"abs_tenant_id":{"type":"string","x-stream-index":"012"},"bucket":{"type":"string","x-stream-index":"005"},"gcs_credentials":{"type":"string","x-stream-index":"010"},"path":{"type":"string","x-stream-index":"006"},"s3_api_key":{"type":"string","x-stream-index":"007"},"s3_custom_endpoint":{"type":"string","x-stream-index":"016"},"s3_region":{"type":"string","x-stream-index":"009"},"s3_secret_key":{"type":"string","x-stream-index":"008"},"storage_name":{"type":"string","x-stream-index":"015"},"storage_type":{"type":"integer","x-stream-index":"004"}},"type":"object"},"FCM":{"properties":{"data":{"additionalProperties":{},"type":"object","x-stream-index":"001"}},"type":"object"},"FeedsEventPreferences":{"properties":{"comments":{"type":"string","x-stream-index":"002"},"mentions":{"type":"string","x-stream-index":"004"},"new_followers":{"type":"string","x-stream-index":"003"},"reactions":{"type":"string","x-stream-index":"001"}},"type":"object"},"Field":{"nullable":true,"properties":{"short":{"type":"boolean","x-stream-index":"003"},"title":{"type":"string","x-stream-index":"001"},"value":{"type":"string","x-stream-index":"002"}},"required":["title","value","short"],"type":"object"},"Flag":{"description":"Contains information about flagged user or message","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"019"},"custom":{"additionalProperties":{},"description":"Additional metadata about the flag","title":"Custom","type":"object","x-stream-index":"014"},"entity_creator_id":{"description":"ID of the user who created the flagged entity","title":"Entity Creator ID","type":"string","x-stream-index":"009"},"entity_id":{"description":"Unique identifier of the entity being flagged","title":"Entity ID","type":"string","x-stream-index":"008"},"entity_type":{"description":"Type of entity being flagged (e.g., message, user)","title":"Entity Type","type":"string","x-stream-index":"007"},"is_streamed_content":{"type":"boolean","x-stream-index":"012"},"labels":{"description":"Labels from bodyguard, API calls, our own AI etc","items":{"type":"string"},"title":"Labels","type":"array","x-stream-index":"015"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content being flagged","title":"Moderation Payload","x-stream-index":"010"},"moderation_payload_hash":{"type":"string","x-stream-index":"011"},"reason":{"description":"Optional explanation for why the content is being flagged","title":"Reason","type":"string","x-stream-index":"013"},"result":{"description":"Result of bodyguard, API calls, our own AI etc","items":{"additionalProperties":{},"type":"object"},"title":"Result","type":"array","x-stream-index":"016"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"018"},"review_queue_item_id":{"description":"ID of the review queue item","title":"Review Queue Item ID","type":"string","x-stream-index":"017"},"type":{"type":"string","x-stream-index":"004"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"020"},"user":{"$ref":"#/components/schemas/User","description":"User who flagged a message or a user","title":"User","x-stream-index":"006"}},"required":["entity_type","entity_id","result","created_at","updated_at"],"title":"Flag","type":"object"},"FlagContentOptions":{"properties":{"reason":{"type":"string","x-stream-index":"001"}},"type":"object"},"FlagRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"description":"Additional metadata about the flag","title":"Custom","type":"object","x-stream-index":"006"},"entity_creator_id":{"description":"ID of the user who created the flagged entity","title":"Entity Creator ID","type":"string","x-stream-index":"003"},"entity_id":{"description":"Unique identifier of the entity being flagged","title":"Entity ID","type":"string","x-stream-index":"002"},"entity_type":{"description":"Type of entity being flagged (e.g., message, user)","title":"Entity Type","type":"string","x-stream-index":"001"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content being flagged","title":"Moderation Payload","x-stream-index":"005"},"reason":{"description":"Optional explanation for why the content is being flagged","maxLength":255,"title":"Reason","type":"string","x-stream-index":"004"}},"required":["entity_type","entity_id"],"type":"object"},"FlagResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"item_id":{"description":"Unique identifier of the created moderation item","title":"Item ID","type":"string","x-stream-index":"001"}},"required":["item_id","duration"],"type":"object"},"FlagUserOptions":{"properties":{"reason":{"type":"string","x-stream-index":"001"}},"type":"object"},"FrameRecordSettings":{"properties":{"capture_interval_in_seconds":{"format":"int32","maximum":60,"minimum":2,"type":"integer","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"},"quality":{"type":"string","x-stream-index":"002"}},"required":["mode","capture_interval_in_seconds"],"type":"object"},"FrameRecordingEgressConfig":{"properties":{"capture_interval_in_seconds":{"format":"int32","type":"integer","x-stream-index":"007"},"external_storage":{"$ref":"#/components/schemas/ExternalStorage","x-stream-index":"006"},"quality":{"$ref":"#/components/schemas/Quality","x-stream-index":"004"},"storage_name":{"type":"string","x-stream-index":"005"}},"type":"object"},"FrameRecordingResponse":{"properties":{"status":{"type":"string","x-stream-index":"001"}},"required":["status"],"type":"object"},"FrameRecordingSettingsResponse":{"properties":{"capture_interval_in_seconds":{"format":"int32","maximum":60,"minimum":2,"type":"integer","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"},"quality":{"type":"string","x-stream-index":"002"}},"required":["mode","capture_interval_in_seconds"],"type":"object"},"GeofenceSettings":{"properties":{"names":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"required":["names"],"type":"object"},"GeofenceSettingsResponse":{"properties":{"names":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"required":["names"],"type":"object"},"GetConfigResponse":{"nullable":true,"properties":{"config":{"$ref":"#/components/schemas/ConfigResponse","description":"The retrieved moderation configuration","title":"Config","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["duration"],"type":"object"},"GoogleVisionConfig":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"HLSEgressConfig":{"properties":{"composite_app_settings":{"$ref":"#/components/schemas/CompositeAppSettings","x-stream-index":"005"},"playlist_url":{"type":"string","x-stream-index":"007"},"qualities":{"items":{"$ref":"#/components/schemas/Quality"},"type":"array","x-stream-index":"004"},"start_unix_nano":{"format":"int64","type":"integer","x-stream-index":"006"}},"type":"object"},"HLSSettings":{"properties":{"auto_on":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"004"},"quality_tracks":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"required":["auto_on","enabled","quality_tracks"],"type":"object"},"HLSSettingsResponse":{"description":"HLSSettings is the payload for HLS settings","properties":{"auto_on":{"title":"Auto On","type":"boolean","x-stream-index":"001"},"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"002"},"quality_tracks":{"items":{"type":"string"},"title":"Quality Tracks","type":"array","x-stream-index":"003"}},"required":["auto_on","enabled","quality_tracks","layout"],"title":"HLSSettingsResponse","type":"object"},"HarmConfig":{"properties":{"action_sequences":{"items":{"$ref":"#/components/schemas/ActionSequence"},"type":"array","x-stream-index":"001"},"severity":{"type":"integer","x-stream-index":"002"}},"required":["action_sequences","severity"],"type":"object"},"ImageContentParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"type":"object"},"ImageData":{"properties":{"frames":{"type":"string","x-stream-index":"005"},"height":{"type":"string","x-stream-index":"003"},"size":{"type":"string","x-stream-index":"004"},"url":{"type":"string","x-stream-index":"001"},"width":{"type":"string","x-stream-index":"002"}},"required":["url","width","height","size","frames"],"type":"object"},"ImageRuleParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"type":"object"},"Images":{"properties":{"fixed_height":{"$ref":"#/components/schemas/ImageData","x-stream-index":"002"},"fixed_height_downsampled":{"$ref":"#/components/schemas/ImageData","x-stream-index":"004"},"fixed_height_still":{"$ref":"#/components/schemas/ImageData","x-stream-index":"003"},"fixed_width":{"$ref":"#/components/schemas/ImageData","x-stream-index":"005"},"fixed_width_downsampled":{"$ref":"#/components/schemas/ImageData","x-stream-index":"007"},"fixed_width_still":{"$ref":"#/components/schemas/ImageData","x-stream-index":"006"},"original":{"$ref":"#/components/schemas/ImageData","x-stream-index":"001"}},"required":["original","fixed_height","fixed_height_still","fixed_height_downsampled","fixed_width","fixed_width_still","fixed_width_downsampled"],"type":"object"},"IngressAudioEncodingOptions":{"properties":{"bitrate":{"maximum":128000,"minimum":16000,"type":"integer","x-stream-index":"003"},"channels":{"enum":["1","2"],"format":"int32","type":"integer","x-stream-index":"001"},"enable_dtx":{"type":"boolean","x-stream-index":"002"}},"required":["channels","enable_dtx","bitrate"],"type":"object"},"IngressAudioEncodingResponse":{"properties":{"bitrate":{"format":"int32","type":"integer","x-stream-index":"003"},"channels":{"format":"int32","type":"integer","x-stream-index":"001"},"enable_dtx":{"type":"boolean","x-stream-index":"002"}},"required":["channels","enable_dtx","bitrate"],"type":"object"},"IngressSettings":{"properties":{"audio_encoding_options":{"$ref":"#/components/schemas/IngressAudioEncodingOptions","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"video_encoding_options":{"additionalProperties":{"$ref":"#/components/schemas/IngressVideoEncodingOptions"},"type":"object","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"IngressSettingsResponse":{"properties":{"audio_encoding_options":{"$ref":"#/components/schemas/IngressAudioEncodingResponse","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"video_encoding_options":{"additionalProperties":{"$ref":"#/components/schemas/IngressVideoEncodingResponse"},"type":"object","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"IngressVideoEncodingOptions":{"properties":{"layers":{"items":{"$ref":"#/components/schemas/IngressVideoLayer"},"minimum":1,"type":"array","x-stream-index":"001"}},"required":["layers"],"type":"object"},"IngressVideoEncodingResponse":{"properties":{"layers":{"items":{"$ref":"#/components/schemas/IngressVideoLayerResponse"},"type":"array","x-stream-index":"001"}},"required":["layers"],"type":"object"},"IngressVideoLayer":{"nullable":true,"properties":{"bitrate":{"minimum":1000,"type":"integer","x-stream-index":"002"},"codec":{"enum":["h264","vp8"],"type":"string","x-stream-index":"001"},"frame_rate":{"maximum":60,"minimum":1,"type":"integer","x-stream-index":"003"},"max_dimension":{"minimum":240,"type":"integer","x-stream-index":"005"},"min_dimension":{"minimum":240,"type":"integer","x-stream-index":"004"}},"required":["codec","bitrate","frame_rate","min_dimension","max_dimension"],"type":"object"},"IngressVideoLayerResponse":{"nullable":true,"properties":{"bitrate":{"type":"integer","x-stream-index":"002"},"codec":{"type":"string","x-stream-index":"001"},"frame_rate_limit":{"type":"integer","x-stream-index":"005"},"max_dimension":{"type":"integer","x-stream-index":"004"},"min_dimension":{"type":"integer","x-stream-index":"003"}},"required":["codec","bitrate","min_dimension","max_dimension","frame_rate_limit"],"type":"object"},"LLMConfig":{"properties":{"app_context":{"type":"string","x-stream-index":"005"},"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/LLMRule"},"type":"array","x-stream-index":"003"},"severity_descriptions":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"004"}},"required":["enabled","rules"],"type":"object"},"LLMRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove","keep"],"type":"string","x-stream-index":"003"},"description":{"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"},"severity_rules":{"items":{"$ref":"#/components/schemas/BodyguardSeverityRule"},"type":"array","x-stream-index":"004"}},"required":["label","description","action","severity_rules"],"type":"object"},"LabelThresholds":{"properties":{"block":{"format":"float","maximum":1,"minimum":0,"type":"number","x-stream-index":"002"},"flag":{"format":"float","maximum":1,"minimum":0,"type":"number","x-stream-index":"001"}},"type":"object"},"LayoutSettings":{"properties":{"detect_orientation":{"type":"boolean","x-stream-index":"005"},"external_app_url":{"type":"string","x-stream-index":"003"},"external_css_url":{"type":"string","x-stream-index":"004"},"name":{"enum":["spotlight","grid","single-participant","mobile","custom"],"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"required":["name","external_app_url","external_css_url"],"type":"object"},"LimitsSettings":{"properties":{"max_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"004"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"},"max_participants_exclude_owner":{"type":"boolean","x-stream-index":"003"},"max_participants_exclude_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"002"}},"required":["max_participants_exclude_roles"],"type":"object"},"LimitsSettingsResponse":{"properties":{"max_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"004"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"},"max_participants_exclude_owner":{"type":"boolean","x-stream-index":"003"},"max_participants_exclude_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"002"}},"required":["max_participants_exclude_roles"],"type":"object"},"MarkReviewedRequest":{"properties":{"content_to_mark_as_reviewed_limit":{"format":"int32","maximum":2500,"type":"integer","x-stream-index":"002"},"disable_marking_content_as_reviewed":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"MemberLookup":{"properties":{"Limit":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"001"}},"required":["Limit"],"type":"object"},"Message":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"012"},"before_message_send_failed":{"type":"boolean","x-stream-index":"046"},"cid":{"type":"string","x-stream-index":"028"},"command":{"type":"string","x-stream-index":"006"},"created_at":{"format":"date-time","type":"number","x-stream-index":"030"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"034"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"033"},"deleted_for_me":{"type":"boolean","x-stream-index":"059"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"023"},"html":{"type":"string","x-stream-index":"007"},"i18n":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"044"},"id":{"type":"string","x-stream-index":"002"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"040"},"latest_reactions":{"items":{"$ref":"#/components/schemas/Reaction"},"type":"array","x-stream-index":"013"},"mentioned_users":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"043"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"052"},"mml":{"type":"string","x-stream-index":"005"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"056"},"own_reactions":{"items":{"$ref":"#/components/schemas/Reaction"},"type":"array","x-stream-index":"014"},"parent_id":{"type":"string","x-stream-index":"019"},"pin_expires":{"format":"date-time","type":"number","x-stream-index":"051"},"pinned":{"type":"boolean","x-stream-index":"047"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"048"},"pinned_by":{"$ref":"#/components/schemas/User","x-stream-index":"050"},"poll":{"$ref":"#/components/schemas/Poll","x-stream-index":"054"},"poll_id":{"type":"string","x-stream-index":"053"},"quoted_message":{"$ref":"#/components/schemas/Message","x-stream-index":"025"},"quoted_message_id":{"type":"string","x-stream-index":"024"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"015"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"017"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"016"},"reminder":{"$ref":"#/components/schemas/MessageReminder","x-stream-index":"058"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"022"},"restricted_visibility":{"items":{"type":"string"},"type":"array","x-stream-index":"011"},"shadowed":{"type":"boolean","x-stream-index":"036"},"shared_location":{"$ref":"#/components/schemas/SharedLocation","x-stream-index":"055"},"show_in_channel":{"type":"boolean","x-stream-index":"021"},"silent":{"type":"boolean","x-stream-index":"045"},"text":{"type":"string","x-stream-index":"004"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"027"},"type":{"type":"string","x-stream-index":"008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"031"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"010"}},"required":["id","text","html","type","restricted_visibility","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reaction_groups","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned"],"type":"object"},"MessageReminder":{"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"004"},"channel_cid":{"type":"string","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"011"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"006"},"message_id":{"type":"string","x-stream-index":"005"},"remind_at":{"format":"date-time","type":"number","x-stream-index":"009"},"task_id":{"type":"string","x-stream-index":"010"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"012"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"user_id":{"type":"string","x-stream-index":"007"}},"required":["channel_cid","message_id","user_id","task_id","created_at","updated_at"],"type":"object"},"MessageResponse":{"description":"Represents any chat message","properties":{"attachments":{"description":"Array of message attachments","items":{"$ref":"#/components/schemas/Attachment"},"title":"Message attachments","type":"array","x-stream-docs-page-id":"message_format#attachment-format","x-stream-index":"008"},"cid":{"description":"Channel unique identifier in \u003ctype\u003e:\u003cid\u003e format","title":"Channel CID","type":"string","x-stream-index":"022"},"command":{"description":"Contains provided slash command","title":"Command","type":"string","x-stream-docs-page-id":"custom_commands_webhook","x-stream-index":"004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"023"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"026"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"025"},"deleted_for_me":{"type":"boolean","x-stream-index":"044"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"018"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"041"},"html":{"description":"Contains HTML markup of the message. Can only be set when using server-side API","title":"HTML content","type":"string","x-stream-index":"005"},"i18n":{"additionalProperties":{"type":"string"},"description":"Object with translations. Key `language` contains the original language key. Other keys contain translations","title":"Internationalization info","type":"object","x-stream-docs-page-id":"translation","x-stream-index":"030"},"id":{"description":"Message ID is unique string identifier of the message","title":"ID","type":"string","x-stream-index":"001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"Contains image moderation information","title":"Image moderation labels","type":"object","x-stream-index":"028"},"latest_reactions":{"description":"List of 10 latest reactions to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Latest reactions","type":"array","x-stream-index":"009"},"mentioned_users":{"description":"List of mentioned users","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Mentioned Users","type":"array","x-stream-index":"029"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"036"},"mml":{"description":"Should be empty if `text` is provided. Can only be set when using server-side API","title":"Messaging Markup Language","type":"string","x-stream-docs-page-id":"mml_overview","x-stream-index":"003"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"039"},"own_reactions":{"description":"List of 10 latest reactions of authenticated user to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Own reactions","type":"array","x-stream-index":"010"},"parent_id":{"description":"ID of parent message (thread)","title":"Parent message ID","type":"string","x-stream-docs-page-id":"threads","x-stream-index":"015"},"pin_expires":{"description":"Date when pinned message expires","format":"date-time","title":"Pin expiration date","type":"number","x-stream-docs-page-id":"pinned_messages","x-stream-index":"035"},"pinned":{"description":"Whether message is pinned or not","title":"Pinned","type":"boolean","x-stream-docs-page-id":"pinned_messages","x-stream-index":"032"},"pinned_at":{"description":"Date when message got pinned","format":"date-time","title":"Pinned at","type":"number","x-stream-docs-page-id":"pinned_messages","x-stream-index":"033"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","description":"Contains user who pinned the message","title":"Pinned by","x-stream-docs-page-id":"pinned_messages","x-stream-index":"034"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"038"},"poll_id":{"description":"Identifier of the poll to include in the message","title":"Poll ID","type":"string","x-stream-index":"037"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","description":"Contains quoted message","title":"Quoted message","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"020"},"quoted_message_id":{"title":"ID of quoted message","type":"string","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"019"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing number of reactions of each type. Key: reaction type (string), value: number of reactions (int)","title":"Reaction counts","type":"object","x-stream-index":"011"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"014"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing scores of reactions of each type. Key: reaction type (string), value: total score of reactions (int)","title":"Reaction scores","type":"object","x-stream-index":"012"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"042"},"reply_count":{"description":"Number of replies to this message","format":"int32","title":"Reply count","type":"integer","x-stream-index":"017"},"restricted_visibility":{"description":"A list of user ids that have restricted visibility to the message, if the list is not empty, the message is only visible to the users in the list","items":{"type":"string"},"title":"Restricted visibility","type":"array","x-stream-index":"040"},"shadowed":{"description":"Whether the message was shadowed or not","title":"Shadowed","type":"boolean","x-stream-docs-page-id":"moderation#shadow-ban","x-stream-index":"027"},"shared_location":{"$ref":"#/components/schemas/SharedLocationResponseData","description":"Contains shared location data","title":"Shared Location","x-stream-index":"043"},"show_in_channel":{"description":"Whether thread reply should be shown in the channel as well","title":"Show in channel","type":"boolean","x-stream-docs-page-id":"threads","x-stream-index":"016"},"silent":{"description":"Whether message is silent or not","title":"Silent","type":"boolean","x-stream-index":"031"},"text":{"description":"Text of the message. Should be empty if `mml` is provided","title":"Text","type":"string","x-stream-index":"002"},"thread_participants":{"description":"List of users who participate in thread","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Thread participants","type":"array","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"021"},"type":{"description":"Contains type of the message","enum":["regular","ephemeral","error","reply","system","deleted"],"title":"Message Type","type":"string","x-stream-docs-page-id":"message_format#message-types","x-stream-index":"006"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"024"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Sender of the message. Required when using server-side API","title":"User object","x-stream-index":"007"}},"required":["id","text","html","type","user","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned","restricted_visibility"],"title":"Message","type":"object","x-stream-docs-page-id":"send_message"},"ModerationActionConfig":{"nullable":true,"properties":{"action":{"type":"string","x-stream-index":"006"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"009"},"description":{"type":"string","x-stream-index":"008"},"entity_type":{"type":"string","x-stream-index":"004"},"icon":{"type":"string","x-stream-index":"007"},"order":{"format":"int32","type":"integer","x-stream-index":"005"}},"required":["entity_type","order","action","icon","description","custom"],"type":"object"},"ModerationCustomActionEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"001"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"002"},"type":{"default":"moderation.custom_action","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationCustomActionEvent","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"},"ModerationFlagResponse":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"015"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"entity_creator_id":{"type":"string","x-stream-index":"007"},"entity_id":{"type":"string","x-stream-index":"006"},"entity_type":{"type":"string","x-stream-index":"005"},"labels":{"items":{"type":"string"},"type":"array","x-stream-index":"011"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"008"},"reason":{"type":"string","x-stream-index":"009"},"result":{"items":{"additionalProperties":{},"type":"object"},"type":"array","x-stream-index":"012"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","x-stream-index":"014"},"review_queue_item_id":{"type":"string","x-stream-index":"013"},"type":{"type":"string","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"016"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"004"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["type","user_id","entity_type","entity_id","result","created_at","updated_at"],"type":"object"},"ModerationFlaggedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"item":{"type":"string","x-stream-index":"001"},"object_id":{"type":"string","x-stream-index":"002"},"type":{"default":"moderation.flagged","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationFlaggedEvent","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"},"ModerationMarkReviewedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"001"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"002"},"type":{"default":"moderation.mark_reviewed","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationMarkReviewedEvent","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"},"ModerationPayload":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"images":{"items":{"type":"string"},"maximum":30,"type":"array","x-stream-index":"002"},"texts":{"items":{"type":"string"},"type":"array","x-stream-index":"001"},"videos":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"type":"object"},"ModerationV2Response":{"properties":{"action":{"type":"string","x-stream-index":"001"},"blocklist_matched":{"type":"string","x-stream-index":"005"},"image_harms":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"original_text":{"type":"string","x-stream-index":"002"},"platform_circumvented":{"type":"boolean","x-stream-index":"007"},"semantic_filter_matched":{"type":"string","x-stream-index":"006"},"text_harms":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"required":["action","original_text"],"type":"object"},"MuteRequest":{"nullable":true,"properties":{"target_ids":{"description":"User IDs to mute (if multiple users)","items":{"type":"string"},"title":"Target IDs","type":"array","x-stream-index":"001"},"timeout":{"description":"Duration of mute in minutes","minimum":0,"title":"Timeout","type":"integer","x-stream-index":"002"}},"required":["target_ids"],"title":"MuteRequest","type":"object"},"MuteResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"004.001"},"mutes":{"description":"Object with mutes (if multiple users were muted)","items":{"$ref":"#/components/schemas/UserMute"},"title":"Mutes","type":"array","x-stream-index":"001"},"non_existing_users":{"description":"A list of users that can't be found. Common cause for this is deleted users","items":{"type":"string"},"title":"Non Existing Users","type":"array","x-stream-index":"003"},"own_user":{"$ref":"#/components/schemas/OwnUser","description":"Authorized user object with fresh mutes information","title":"Own User","x-stream-index":"002"}},"required":["duration"],"title":"MuteResponse","type":"object"},"NoiseCancellationSettings":{"properties":{"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode"],"type":"object"},"NotificationSettings":{"properties":{"call_live_started":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"002"},"call_missed":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"006"},"call_notification":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"004"},"call_ring":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"session_started":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"003"}},"required":["enabled","call_live_started","session_started","call_notification","call_ring","call_missed"],"type":"object"},"NullTime":{"type":"object"},"OCRRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"}},"required":["label","action"],"type":"object"},"OwnUser":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"046"},"banned":{"type":"boolean","x-stream-index":"016"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"045"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"029"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"014"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"013"},"devices":{"items":{"$ref":"#/components/schemas/Device"},"type":"array","x-stream-index":"027"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"023"},"language":{"type":"string","x-stream-index":"035"},"last_active":{"format":"date-time","type":"number","x-stream-index":"011"},"last_engaged_at":{"format":"date-time","type":"number","x-stream-index":"012"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"037"},"mutes":{"items":{"$ref":"#/components/schemas/UserMute"},"type":"array","x-stream-index":"028"},"online":{"type":"boolean","x-stream-index":"022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"026"},"push_preferences":{"$ref":"#/components/schemas/PushPreferences","x-stream-index":"025"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"005"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"031"},"total_unread_count_by_team":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"032"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"033"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"030"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"034"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"}},"required":["id","role","custom","created_at","updated_at","banned","online","devices","mutes","channel_mutes","unread_count","total_unread_count","total_unread_count_by_team","unread_channels","unread_threads","language"],"type":"object"},"Poll":{"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"023"},"allow_answers":{"type":"boolean","x-stream-index":"010"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"009"},"answers_count":{"format":"int32","type":"integer","x-stream-index":"015"},"created_at":{"format":"date-time","type":"number","x-stream-index":"021"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"020"},"created_by_id":{"type":"string","x-stream-index":"019"},"description":{"type":"string","x-stream-index":"005"},"enforce_unique_vote":{"type":"boolean","x-stream-index":"007"},"id":{"type":"string","x-stream-index":"003"},"is_closed":{"type":"boolean","x-stream-index":"011"},"latest_answers":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array","x-stream-index":"017"},"latest_votes_by_option":{"additionalProperties":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array"},"type":"object","x-stream-index":"016"},"max_votes_allowed":{"format":"int32","type":"integer","x-stream-index":"008"},"name":{"type":"string","x-stream-index":"004"},"options":{"items":{"$ref":"#/components/schemas/PollOption"},"type":"array","x-stream-index":"013"},"own_votes":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array","x-stream-index":"018"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"022"},"vote_count":{"format":"int32","type":"integer","x-stream-index":"012"},"vote_counts_by_option":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"014"},"voting_visibility":{"type":"string","x-stream-index":"006"}},"required":["id","name","description","enforce_unique_vote","allow_user_suggested_options","allow_answers","vote_count","options","vote_counts_by_option","answers_count","latest_votes_by_option","latest_answers","own_votes","created_by_id","created_at","updated_at","Custom"],"type":"object"},"PollOption":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id","text","custom"],"type":"object"},"PollOptionResponseData":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id","text","custom"],"type":"object"},"PollResponseData":{"properties":{"allow_answers":{"type":"boolean","x-stream-index":"008"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"007"},"answers_count":{"format":"int32","type":"integer","x-stream-index":"012"},"created_at":{"format":"date-time","type":"number","x-stream-index":"019"},"created_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"018"},"created_by_id":{"type":"string","x-stream-index":"017"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"021"},"description":{"type":"string","x-stream-index":"003"},"enforce_unique_vote":{"type":"boolean","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"is_closed":{"type":"boolean","x-stream-index":"009"},"latest_answers":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array","x-stream-index":"015"},"latest_votes_by_option":{"additionalProperties":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array"},"type":"object","x-stream-index":"014"},"max_votes_allowed":{"format":"int32","type":"integer","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"002"},"options":{"items":{"$ref":"#/components/schemas/PollOptionResponseData"},"type":"array","x-stream-index":"011"},"own_votes":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array","x-stream-index":"016"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"020"},"vote_count":{"format":"int32","type":"integer","x-stream-index":"010"},"vote_counts_by_option":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"013"},"voting_visibility":{"type":"string","x-stream-index":"004"}},"required":["id","name","description","voting_visibility","enforce_unique_vote","allow_user_suggested_options","allow_answers","vote_count","options","answers_count","vote_counts_by_option","latest_votes_by_option","latest_answers","own_votes","created_by_id","created_at","updated_at","custom"],"type":"object"},"PollVote":{"nullable":true,"properties":{"answer_text":{"type":"string","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"004"},"is_answer":{"type":"boolean","x-stream-index":"006"},"option_id":{"type":"string","x-stream-index":"005"},"poll_id":{"type":"string","x-stream-index":"003"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"011"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"009"},"user_id":{"type":"string","x-stream-index":"008"}},"required":["poll_id","id","option_id","created_at","updated_at"],"type":"object"},"PollVoteResponseData":{"nullable":true,"properties":{"answer_text":{"type":"string","x-stream-index":"005"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"id":{"type":"string","x-stream-index":"002"},"is_answer":{"type":"boolean","x-stream-index":"004"},"option_id":{"type":"string","x-stream-index":"003"},"poll_id":{"type":"string","x-stream-index":"001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"007"},"user_id":{"type":"string","x-stream-index":"006"}},"required":["poll_id","id","option_id","created_at","updated_at"],"type":"object"},"PrivacySettings":{"properties":{"read_receipts":{"$ref":"#/components/schemas/ReadReceipts","x-stream-index":"002"},"typing_indicators":{"$ref":"#/components/schemas/TypingIndicators","x-stream-index":"001"}},"type":"object"},"PrivacySettingsResponse":{"properties":{"read_receipts":{"$ref":"#/components/schemas/ReadReceiptsResponse","x-stream-index":"002"},"typing_indicators":{"$ref":"#/components/schemas/TypingIndicatorsResponse","x-stream-index":"001"}},"type":"object"},"PushPreferences":{"properties":{"call_level":{"type":"string","x-stream-index":"002"},"chat_level":{"type":"string","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"number","x-stream-index":"005"},"feeds_events":{"$ref":"#/components/schemas/FeedsEventPreferences","x-stream-index":"004"},"feeds_level":{"type":"string","x-stream-index":"003"}},"type":"object"},"Quality":{"properties":{"bitdepth":{"format":"int32","type":"integer","x-stream-index":"007"},"framerate":{"format":"int32","type":"integer","x-stream-index":"008"},"height":{"format":"int32","type":"integer","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"004"},"video_bitrate":{"format":"int32","type":"integer","x-stream-index":"009"},"width":{"format":"int32","type":"integer","x-stream-index":"005"}},"type":"object"},"QueryModerationConfigsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter conditions for moderation configs","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"Sorting parameters for the results","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"002"}},"type":"object"},"QueryModerationConfigsResponse":{"nullable":true,"properties":{"configs":{"description":"List of moderation configurations","items":{"$ref":"#/components/schemas/ConfigResponse"},"title":"Configs","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["configs","duration"],"type":"object"},"QueryReviewQueueRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter conditions for review queue items","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"007.001"},"lock_count":{"description":"Number of items to lock (1-25)","format":"int32","maximum":25,"minimum":1,"title":"Lock Count","type":"integer","x-stream-index":"005"},"lock_duration":{"description":"Duration for which items should be locked","title":"Lock Duration","type":"integer","x-stream-index":"004"},"lock_items":{"description":"Whether to lock items for review (true), unlock items (false), or just fetch (nil)","title":"Lock Items","type":"boolean","x-stream-index":"003"},"next":{"type":"string","x-stream-index":"007.002"},"prev":{"type":"string","x-stream-index":"007.003"},"sort":{"description":"Sorting parameters for the results","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"002"},"stats_only":{"description":"Whether to return only statistics","title":"Stats Only","type":"boolean","x-stream-index":"006"}},"type":"object"},"QueryReviewQueueResponse":{"nullable":true,"properties":{"action_config":{"additionalProperties":{"items":{"$ref":"#/components/schemas/ModerationActionConfig"},"type":"array"},"description":"Configuration for moderation actions","title":"Action Config","type":"object","x-stream-index":"002"},"duration":{"type":"string","x-stream-index":"005.001"},"items":{"description":"List of review queue items","items":{"$ref":"#/components/schemas/ReviewQueueItemResponse"},"title":"Items","type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"004.001"},"prev":{"type":"string","x-stream-index":"004.002"},"stats":{"additionalProperties":{},"description":"Statistics about the review queue","title":"Stats","type":"object","x-stream-index":"003"}},"required":["items","action_config","stats","duration"],"type":"object"},"RTMPEgressConfig":{"properties":{"composite_app_settings":{"$ref":"#/components/schemas/CompositeAppSettings","x-stream-index":"005"},"quality":{"$ref":"#/components/schemas/Quality","x-stream-index":"004"},"rtmp_location":{"type":"string","x-stream-index":"006"}},"type":"object"},"RTMPIngress":{"description":"RTMP input settings","properties":{"address":{"title":"Address","type":"string","x-stream-index":"001"}},"required":["address"],"title":"RTMPIngress","type":"object"},"RTMPLocation":{"properties":{"name":{"type":"string","x-stream-index":"001"},"stream_key":{"type":"string","x-stream-index":"003"},"stream_url":{"type":"string","x-stream-index":"002"}},"required":["name","stream_url","stream_key"],"type":"object"},"RTMPSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"003"},"location":{"$ref":"#/components/schemas/RTMPLocation","x-stream-index":"004"},"quality_name":{"type":"string","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"RTMPSettingsResponse":{"description":"RTMPSettingsResponse is the payload for RTMP settings","properties":{"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"001"},"quality":{"title":"Quality","type":"string","x-stream-index":"002"}},"required":["enabled","quality","layout"],"title":"RTMPSettingsResponse","type":"object"},"Reaction":{"nullable":true,"properties":{"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"message_id":{"type":"string","x-stream-index":"003"},"score":{"format":"int32","type":"integer","x-stream-index":"007"},"type":{"maxLength":30,"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["message_id","type","score","created_at","updated_at","custom"],"type":"object"},"ReactionGroupResponse":{"description":"ReactionGroupResponse contains all information about a reaction of the same type.","nullable":true,"properties":{"count":{"description":"Count is the number of reactions of this type.","format":"int32","title":"Count","type":"integer","x-stream-index":"001"},"first_reaction_at":{"description":"FirstReactionAt is the time of the first reaction of this type. This is the same also if all reaction of this type are deleted, because if someone will react again with the same type, will be preserved the sorting.","format":"date-time","title":"FirstReactionAt","type":"number","x-stream-index":"003"},"last_reaction_at":{"description":"LastReactionAt is the time of the last reaction of this type.","format":"date-time","title":"LastReactionAt","type":"number","x-stream-index":"004"},"sum_scores":{"description":"SumScores is the sum of all scores of reactions of this type. Medium allows you to clap articles more than once and shows the sum of all claps from all users. For example, you can send `clap` x5 using `score: 5`.","format":"int32","title":"SumScores","type":"integer","x-stream-index":"002"}},"required":["count","sum_scores","first_reaction_at","last_reaction_at"],"title":"ReactionGroupResponse","type":"object"},"ReactionResponse":{"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"006"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"008"},"message_id":{"description":"Message ID","title":"Message ID","type":"string","x-stream-index":"001"},"score":{"description":"Score of the reaction","format":"int32","title":"Score","type":"integer","x-stream-index":"005"},"type":{"description":"Type of reaction","title":"Type","type":"string","x-stream-index":"004"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"007"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User","title":"UserResponse","x-stream-index":"003"},"user_id":{"description":"User ID","title":"User ID","type":"string","x-stream-index":"002"}},"required":["message_id","user_id","user","type","score","created_at","updated_at","custom"],"type":"object"},"ReadReceipts":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"ReadReceiptsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"RecordSettings":{"properties":{"audio_only":{"type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"004"},"mode":{"type":"string","x-stream-index":"002"},"quality":{"type":"string","x-stream-index":"003"}},"required":["mode"],"type":"object"},"RecordSettingsResponse":{"description":"RecordSettings is the payload for recording settings","properties":{"audio_only":{"title":"Audio Only","type":"boolean","x-stream-index":"001"},"mode":{"title":"Mode","type":"string","x-stream-index":"002"},"quality":{"title":"Quality","type":"string","x-stream-index":"003"}},"required":["audio_only","mode","quality","layout"],"title":"RecordSettingsResponse","type":"object"},"RecordingEgressConfig":{"properties":{"audio_only":{"type":"boolean","x-stream-index":"006"},"composite_app_settings":{"$ref":"#/components/schemas/CompositeAppSettings","x-stream-index":"005"},"external_storage":{"$ref":"#/components/schemas/ExternalStorage","x-stream-index":"008"},"quality":{"$ref":"#/components/schemas/Quality","x-stream-index":"004"},"storage_name":{"type":"string","x-stream-index":"007"},"video_orientation_hint":{"$ref":"#/components/schemas/VideoOrientation","x-stream-index":"009"}},"type":"object"},"ReminderResponseData":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003"},"channel_cid":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"005"},"message_id":{"type":"string","x-stream-index":"004"},"remind_at":{"format":"date-time","type":"number","x-stream-index":"001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007"},"user_id":{"type":"string","x-stream-index":"006"}},"required":["channel_cid","message_id","user_id","created_at","updated_at"],"type":"object"},"RestoreActionRequest":{"type":"object"},"ReviewQueueItem":{"properties":{"actions":{"items":{"$ref":"#/components/schemas/ActionLog"},"type":"array","x-stream-index":"035"},"activity":{"$ref":"#/components/schemas/EnrichedActivity","x-stream-index":"028"},"ai_text_severity":{"type":"string","x-stream-index":"021"},"archived_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"043"},"assigned_to":{"$ref":"#/components/schemas/User","x-stream-index":"032"},"bans":{"items":{"$ref":"#/components/schemas/Ban"},"type":"array","x-stream-index":"033"},"bounce_count":{"format":"int32","type":"integer","x-stream-index":"025"},"call":{"$ref":"#/components/schemas/Call","x-stream-index":"031"},"completed_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"018"},"config_key":{"type":"string","x-stream-index":"009"},"content_changed":{"type":"boolean","x-stream-index":"036"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"entity_creator":{"$ref":"#/components/schemas/EntityCreator","x-stream-index":"030"},"entity_id":{"type":"string","x-stream-index":"007"},"entity_type":{"type":"string","x-stream-index":"006"},"feeds_v2_activity":{"$ref":"#/components/schemas/EnrichedActivity","x-stream-index":"041"},"feeds_v2_reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"042"},"flag_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"045"},"flag_types":{"items":{"type":"string"},"type":"array","x-stream-index":"044"},"flags":{"items":{"$ref":"#/components/schemas/Flag"},"type":"array","x-stream-index":"034"},"flags_count":{"format":"int32","type":"integer","x-stream-index":"026"},"has_image":{"type":"boolean","x-stream-index":"012"},"has_text":{"type":"boolean","x-stream-index":"014"},"has_video":{"type":"boolean","x-stream-index":"013"},"id":{"type":"string","x-stream-index":"003"},"languages":{"items":{"type":"string"},"type":"array","x-stream-index":"019"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"027"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"010"},"moderation_payload_hash":{"type":"string","x-stream-index":"011"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"029"},"recommended_action":{"type":"string","x-stream-index":"017"},"reporter_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"046"},"reviewed_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"022"},"reviewed_by":{"type":"string","x-stream-index":"023"},"severity":{"format":"int32","type":"integer","x-stream-index":"020"},"status":{"type":"string","x-stream-index":"016"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"015"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"005"}},"required":["id","created_at","updated_at","entity_type","entity_id","config_key","moderation_payload_hash","has_image","has_video","has_text","teams","status","recommended_action","completed_at","languages","severity","ai_text_severity","reviewed_at","reviewed_by","bounce_count","flags_count","bans","flags","actions","content_changed","archived_at","flag_types","flag_labels","reporter_ids"],"type":"object"},"ReviewQueueItemResponse":{"nullable":true,"properties":{"actions":{"description":"Moderation actions taken","items":{"$ref":"#/components/schemas/ActionLogResponse"},"title":"Actions","type":"array","x-stream-index":"024"},"activity":{"$ref":"#/components/schemas/EnrichedActivity","x-stream-index":"016"},"ai_text_severity":{"description":"AI-determined text severity","title":"AI Text Severity","type":"string","x-stream-index":"014"},"assigned_to":{"$ref":"#/components/schemas/UserResponse","description":"Moderator assigned to review this item","title":"Assigned To","x-stream-index":"021"},"bans":{"description":"Associated ban records","items":{"$ref":"#/components/schemas/Ban"},"title":"Bans","type":"array","x-stream-index":"022"},"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"018"},"completed_at":{"description":"When the review was completed","format":"date-time","title":"Completed At","type":"number","x-stream-index":"009"},"config_key":{"type":"string","x-stream-index":"028"},"created_at":{"description":"When the item was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"002"},"entity_creator":{"$ref":"#/components/schemas/EntityCreatorResponse","description":"Details about who created the entity","title":"Entity Creator","x-stream-index":"019"},"entity_creator_id":{"description":"ID of who created the entity","title":"Entity Creator ID","type":"string","x-stream-index":"020"},"entity_id":{"description":"ID of the entity being reviewed","title":"Entity ID","type":"string","x-stream-index":"005"},"entity_type":{"description":"Type of entity being reviewed","title":"Entity Type","type":"string","x-stream-index":"004"},"feeds_v2_activity":{"$ref":"#/components/schemas/EnrichedActivity","description":"Associated feed activity","title":"Feeds V2 Activity","x-stream-index":"025"},"feeds_v2_reaction":{"$ref":"#/components/schemas/Reaction","description":"Associated feed reaction","title":"Feeds V2 Reaction","x-stream-index":"026"},"flags":{"description":"Associated flag records","items":{"$ref":"#/components/schemas/ModerationFlagResponse"},"title":"Flags","type":"array","x-stream-index":"023"},"flags_count":{"format":"int32","type":"integer","x-stream-index":"029"},"id":{"description":"Unique identifier of the review queue item","title":"ID","type":"string","x-stream-index":"001"},"languages":{"description":"Detected languages in the content","items":{"type":"string"},"title":"Languages","type":"array","x-stream-index":"012"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Associated message details","title":"Message","x-stream-index":"015"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content being moderated","title":"Moderation Payload","x-stream-index":"006"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"017"},"recommended_action":{"description":"Suggested moderation action","title":"Recommended Action","type":"string","x-stream-index":"008"},"reviewed_at":{"description":"When the item was reviewed","format":"date-time","title":"Reviewed At","type":"number","x-stream-index":"010"},"reviewed_by":{"description":"ID of the moderator who reviewed the item","title":"Reviewed By","type":"string","x-stream-index":"011"},"severity":{"description":"Severity level of the content","format":"int32","title":"Severity","type":"integer","x-stream-index":"013"},"status":{"description":"Current status of the review","title":"Status","type":"string","x-stream-index":"007"},"teams":{"description":"Teams associated with this item","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"027"},"updated_at":{"description":"When the item was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"003"}},"required":["id","created_at","updated_at","entity_type","entity_id","status","recommended_action","reviewed_by","languages","severity","ai_text_severity","bans","flags","actions","flags_count"],"type":"object"},"RingSettings":{"properties":{"auto_cancel_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_timeout_ms","missed_call_timeout_ms"],"type":"object"},"RingSettingsResponse":{"properties":{"auto_cancel_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_timeout_ms","missed_call_timeout_ms"],"type":"object"},"RuleBuilderAction":{"properties":{"ban_options":{"$ref":"#/components/schemas/BanOptions","x-stream-index":"002"},"flag_content_options":{"$ref":"#/components/schemas/FlagContentOptions","x-stream-index":"004"},"flag_user_options":{"$ref":"#/components/schemas/FlagUserOptions","x-stream-index":"003"},"remove_content_options":{"$ref":"#/components/schemas/BlockContentOptions","x-stream-index":"005"},"type":{"type":"string","x-stream-index":"001"}},"type":"object"},"RuleBuilderCondition":{"properties":{"confidence":{"format":"float","type":"number","x-stream-index":"002"},"content_count_rule_params":{"$ref":"#/components/schemas/ContentCountRuleParameters","x-stream-index":"007"},"image_content_params":{"$ref":"#/components/schemas/ImageContentParameters","x-stream-index":"009"},"image_rule_params":{"$ref":"#/components/schemas/ImageRuleParameters","x-stream-index":"004"},"text_content_params":{"$ref":"#/components/schemas/TextContentParameters","x-stream-index":"008"},"text_rule_params":{"$ref":"#/components/schemas/TextRuleParameters","x-stream-index":"003"},"type":{"type":"string","x-stream-index":"001"},"user_created_within_params":{"$ref":"#/components/schemas/UserCreatedWithinParameters","x-stream-index":"011"},"user_custom_property_params":{"$ref":"#/components/schemas/UserCustomPropertyParameters","x-stream-index":"012"},"user_rule_params":{"$ref":"#/components/schemas/UserRuleParameters","x-stream-index":"006"},"video_content_params":{"$ref":"#/components/schemas/VideoContentParameters","x-stream-index":"010"},"video_rule_params":{"$ref":"#/components/schemas/VideoRuleParameters","x-stream-index":"005"}},"type":"object"},"RuleBuilderConditionGroup":{"properties":{"conditions":{"items":{"$ref":"#/components/schemas/RuleBuilderCondition"},"type":"array","x-stream-index":"002"},"logic":{"type":"string","x-stream-index":"001"}},"type":"object"},"RuleBuilderConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"rules":{"items":{"$ref":"#/components/schemas/RuleBuilderRule"},"type":"array","x-stream-index":"002"}},"type":"object"},"RuleBuilderRule":{"properties":{"action":{"$ref":"#/components/schemas/RuleBuilderAction","x-stream-index":"006"},"conditions":{"items":{"$ref":"#/components/schemas/RuleBuilderCondition"},"type":"array","x-stream-index":"003"},"cooldown_period":{"type":"string","x-stream-index":"007"},"groups":{"items":{"$ref":"#/components/schemas/RuleBuilderConditionGroup"},"type":"array","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"logic":{"type":"string","x-stream-index":"004"},"rule_type":{"type":"string","x-stream-index":"002"}},"required":["rule_type","action"],"type":"object"},"SFUIDLastSeen":{"properties":{"id":{"type":"string","x-stream-index":"001.001"},"last_seen":{"format":"date-time","type":"number","x-stream-index":"002"},"process_start_time":{"format":"int64","type":"integer","x-stream-index":"001.002"}},"required":["id","process_start_time","last_seen"],"type":"object"},"STTEgressConfig":{"properties":{"closed_captions_enabled":{"type":"boolean","x-stream-index":"005"},"external_storage":{"$ref":"#/components/schemas/ExternalStorage","x-stream-index":"011"},"language":{"type":"string","x-stream-index":"008"},"storage_name":{"type":"string","x-stream-index":"010"},"translation_languages":{"items":{"type":"string"},"type":"array","x-stream-index":"009"},"translations_enabled":{"type":"boolean","x-stream-index":"006"},"upload_transcriptions":{"type":"boolean","x-stream-index":"004"},"whisper_server_base_url":{"type":"string","x-stream-index":"007"}},"type":"object"},"ScreensharingSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled"],"type":"object"},"ScreensharingSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled"],"type":"object"},"SessionSettings":{"properties":{"inactivity_timeout_seconds":{"format":"int32","maximum":900,"minimum":5,"type":"integer","x-stream-index":"001"}},"required":["inactivity_timeout_seconds"],"type":"object"},"SessionSettingsResponse":{"properties":{"inactivity_timeout_seconds":{"format":"int32","maximum":900,"minimum":5,"type":"integer","x-stream-index":"001"}},"required":["inactivity_timeout_seconds"],"type":"object"},"ShadowBlockActionRequest":{"type":"object"},"SharedLocation":{"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"013"},"channel_cid":{"type":"string","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"010"},"created_by_device_id":{"type":"string","x-stream-index":"008"},"end_at":{"format":"date-time","type":"number","x-stream-index":"009"},"latitude":{"format":"float","maximum":90,"minimum":18446744073709552000,"type":"number","x-stream-index":"006"},"longitude":{"format":"float","maximum":180,"minimum":18446744073709552000,"type":"number","x-stream-index":"007"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"012"},"message_id":{"type":"string","x-stream-index":"004"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"011"},"user_id":{"type":"string","x-stream-index":"005"}},"required":["channel_cid","message_id","user_id","created_by_device_id","created_at","updated_at"],"type":"object"},"SharedLocationResponseData":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"011"},"channel_cid":{"type":"string","x-stream-index":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"created_by_device_id":{"type":"string","x-stream-index":"006"},"end_at":{"format":"date-time","type":"number","x-stream-index":"007"},"latitude":{"format":"float","type":"number","x-stream-index":"004"},"longitude":{"format":"float","type":"number","x-stream-index":"005"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"010"},"message_id":{"type":"string","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["channel_cid","message_id","user_id","latitude","longitude","created_by_device_id","created_at","updated_at"],"type":"object"},"SortParamRequest":{"nullable":true,"properties":{"direction":{"description":"Direction of sorting, 1 for Ascending, -1 for Descending, default is 1","format":"int32","title":"Direction","type":"integer","x-stream-index":"002"},"field":{"description":"Name of field to sort by","title":"Field","type":"string","x-stream-index":"001"}},"type":"object"},"SubmitActionRequest":{"nullable":true,"properties":{"action_type":{"description":"Type of moderation action to perform (mark_reviewed, delete_message, etc.)","enum":["mark_reviewed","delete_message","delete_activity","delete_reaction","ban","custom","unban","restore","delete_user","unblock","shadow_block","unmask","kick_user","end_call"],"title":"Action Type","type":"string","x-stream-index":"002"},"ban":{"$ref":"#/components/schemas/BanActionRequest","description":"Configuration for ban action","title":"Ban","x-stream-index":"008"},"custom":{"$ref":"#/components/schemas/CustomActionRequest","description":"Configuration for custom action","title":"Custom","x-stream-index":"009"},"delete_activity":{"$ref":"#/components/schemas/DeleteActivityRequest","description":"Configuration for activity deletion action","title":"Delete Activity","x-stream-index":"004"},"delete_message":{"$ref":"#/components/schemas/DeleteMessageRequest","description":"Configuration for message deletion action","title":"Delete Message","x-stream-index":"003"},"delete_reaction":{"$ref":"#/components/schemas/DeleteReactionRequest","description":"Configuration for reaction deletion action","title":"Delete Reaction","x-stream-index":"005"},"delete_user":{"$ref":"#/components/schemas/DeleteUserRequest","description":"Configuration for user deletion action","title":"Delete User","x-stream-index":"006"},"item_id":{"description":"UUID of the review queue item to act on","title":"Item ID","type":"string","x-stream-index":"001"},"mark_reviewed":{"$ref":"#/components/schemas/MarkReviewedRequest","description":"Configuration for marking item as reviewed","title":"Mark Reviewed","x-stream-index":"007"},"unban":{"$ref":"#/components/schemas/UnbanActionRequest","description":"Configuration for unban action","title":"Unban","x-stream-index":"010"}},"required":["item_id","action_type"],"type":"object"},"SubmitActionResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"Updated review queue item after action was performed","title":"Item","x-stream-index":"001"}},"required":["duration"],"type":"object"},"TargetResolution":{"properties":{"bitrate":{"format":"int32","maximum":6000000,"type":"integer","x-stream-index":"003"},"height":{"format":"int32","maximum":3840,"minimum":240,"type":"integer","x-stream-index":"002"},"width":{"format":"int32","maximum":3840,"minimum":240,"type":"integer","x-stream-index":"001"}},"required":["width","height","bitrate"],"type":"object"},"TextContentParameters":{"properties":{"blocklist_match":{"items":{"type":"string"},"type":"array","x-stream-index":"005"},"contains_url":{"type":"boolean","x-stream-index":"003"},"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001"},"llm_harm_labels":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"002"},"severity":{"type":"string","x-stream-index":"004"}},"type":"object"},"TextRuleParameters":{"properties":{"blocklist_match":{"items":{"type":"string"},"type":"array","x-stream-index":"007"},"contains_url":{"type":"boolean","x-stream-index":"005"},"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"llm_harm_labels":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"004"},"severity":{"type":"string","x-stream-index":"006"},"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"type":"object"},"Thresholds":{"properties":{"explicit":{"$ref":"#/components/schemas/LabelThresholds","x-stream-index":"001"},"spam":{"$ref":"#/components/schemas/LabelThresholds","x-stream-index":"002"},"toxic":{"$ref":"#/components/schemas/LabelThresholds","x-stream-index":"003"}},"type":"object"},"ThumbnailResponse":{"properties":{"image_url":{"type":"string","x-stream-index":"001"}},"required":["image_url"],"type":"object"},"ThumbnailsSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"ThumbnailsSettingsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"Time":{"type":"object"},"TranscriptionSettings":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"title":"Mode","type":"string","x-stream-index":"002"},"language":{"description":"The language used in this call as a two letter code","enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"title":"Language","type":"string","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"title":"Mode","type":"string","x-stream-index":"001"}},"required":["mode","closed_caption_mode","languages","language"],"type":"object"},"TranscriptionSettingsResponse":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"002"},"language":{"enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"type":"string","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode","closed_caption_mode","languages","language"],"type":"object"},"TypingIndicators":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"TypingIndicatorsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"UnbanActionRequest":{"type":"object"},"UnblockActionRequest":{"type":"object"},"UpsertConfigRequest":{"nullable":true,"properties":{"ai_image_config":{"$ref":"#/components/schemas/AIImageConfig","description":"Configuration for AI image analysis","title":"AI Image Config","x-stream-index":"011"},"ai_text_config":{"$ref":"#/components/schemas/AITextConfig","description":"Configuration for AI text analysis","title":"AI Text Config","x-stream-index":"008"},"ai_video_config":{"$ref":"#/components/schemas/AIVideoConfig","description":"Configuration for AI video analysis","title":"AI Video Config","x-stream-index":"012"},"async":{"description":"Whether moderation should be performed asynchronously","title":"Async","type":"boolean","x-stream-index":"003"},"automod_platform_circumvention_config":{"$ref":"#/components/schemas/AutomodPlatformCircumventionConfig","description":"Configuration for platform circumvention detection","title":"Automod Platform Circumvention Config","x-stream-index":"005"},"automod_semantic_filters_config":{"$ref":"#/components/schemas/AutomodSemanticFiltersConfig","description":"Configuration for semantic filtering","title":"Automod Semantic Filters Config","x-stream-index":"006"},"automod_toxicity_config":{"$ref":"#/components/schemas/AutomodToxicityConfig","description":"Configuration for toxicity detection","title":"Automod Toxicity Config","x-stream-index":"004"},"aws_rekognition_config":{"$ref":"#/components/schemas/AIImageConfig","x-stream-index":"016"},"block_list_config":{"$ref":"#/components/schemas/BlockListConfig","description":"Configuration for block list filtering","title":"Block List Config","x-stream-index":"007"},"bodyguard_config":{"$ref":"#/components/schemas/AITextConfig","x-stream-index":"015"},"google_vision_config":{"$ref":"#/components/schemas/GoogleVisionConfig","description":"Configuration for Google Vision integration","title":"Google Vision Config","x-stream-index":"010"},"key":{"description":"Unique identifier for the moderation configuration","title":"Key","type":"string","x-stream-index":"001"},"llm_config":{"$ref":"#/components/schemas/LLMConfig","description":"Configuration for customer-configured LLM moderation","title":"LLM Config","x-stream-index":"009"},"rule_builder_config":{"$ref":"#/components/schemas/RuleBuilderConfig","description":"Configuration for custom rule builder (max 3 rules, max 5 conditions per rule)","title":"Rule Builder Config","x-stream-index":"014"},"team":{"description":"Team associated with the configuration","maxLength":128,"minLength":1,"title":"Team","type":"string","x-stream-index":"002"},"velocity_filter_config":{"$ref":"#/components/schemas/VelocityFilterConfig","description":"Configuration for velocity-based filtering","title":"Velocity Filter Config","x-stream-index":"013"},"video_call_rule_config":{"$ref":"#/components/schemas/VideoCallRuleConfig","x-stream-index":"017"}},"required":["key"],"type":"object"},"UpsertConfigResponse":{"nullable":true,"properties":{"config":{"$ref":"#/components/schemas/ConfigResponse","description":"The created or updated moderation configuration","title":"Config","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["duration"],"type":"object"},"User":{"properties":{"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"046"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"017"},"banned":{"type":"boolean","x-stream-index":"016"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"013"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"023"},"language":{"type":"string","x-stream-index":"035"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"026"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"042"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"005"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"009"}},"required":["id","role","teams_role","custom","banned","online"],"type":"object"},"UserCreatedWithinParameters":{"properties":{"max_age":{"type":"string","x-stream-index":"001"}},"type":"object"},"UserCustomPropertyParameters":{"properties":{"operator":{"type":"string","x-stream-index":"002"},"property_key":{"type":"string","x-stream-index":"001"}},"type":"object"},"UserMute":{"nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"expires":{"description":"Date/time of mute expiration","format":"date-time","title":"Expires","type":"number","x-stream-index":"008"},"target":{"$ref":"#/components/schemas/User","description":"User who's muted","title":"Target","x-stream-index":"007"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/User","description":"Owner of channel mute","title":"User","x-stream-index":"005"}},"required":["created_at","updated_at"],"type":"object"},"UserRequest":{"description":"User request object","properties":{"custom":{"additionalProperties":{},"description":"Custom user data","title":"Custom","type":"object","x-stream-index":"004"},"id":{"description":"User ID","title":"ID","type":"string","x-stream-index":"001"},"image":{"description":"User's profile image URL","title":"Image","type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"006"},"language":{"type":"string","x-stream-index":"005"},"name":{"description":"Optional name of user","title":"Name","type":"string","x-stream-index":"002"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"007"}},"required":["id"],"title":"UserRequest","type":"object"},"UserResponse":{"description":"User response object","properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"banned":{"description":"Whether a user is banned or not","title":"Banned","type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.017"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"001.004"},"deactivated_at":{"description":"Date of deactivation","format":"date-time","title":"Deactivated at","type":"number","x-stream-index":"001.016"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"001.011"},"id":{"description":"Unique user identifier","title":"ID","type":"string","x-stream-index":"001.001"},"image":{"title":"Image","type":"string","x-stream-index":"001.003"},"language":{"description":"Preferred language of a user","title":"Language","type":"string","x-stream-index":"001.005"},"last_active":{"description":"Date of last activity","format":"date-time","title":"Last active","type":"number","x-stream-index":"001.014"},"name":{"description":"Optional name of user","title":"Name","type":"string","x-stream-index":"001.002"},"online":{"description":"Whether a user online or not","title":"Online","type":"boolean","x-stream-index":"001.013"},"revoke_tokens_issued_before":{"description":"Revocation date for tokens","format":"date-time","title":"Revoke tokens issued before","type":"number","x-stream-index":"001.015"},"role":{"description":"Determines the set of user permissions","title":"Role","type":"string","x-stream-index":"001.006"},"teams":{"description":"List of teams user is a part of","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids","shadow_banned","invisible"],"title":"UserResponse","type":"object"},"UserRuleParameters":{"properties":{"max_age":{"type":"string","x-stream-index":"001"}},"type":"object"},"VelocityFilterConfig":{"properties":{"advanced_filters":{"type":"boolean","x-stream-index":"007"},"async":{"type":"boolean","x-stream-index":"001"},"cascading_actions":{"type":"boolean","x-stream-index":"004"},"cids_per_user":{"format":"int32","type":"integer","x-stream-index":"006"},"enabled":{"type":"boolean","x-stream-index":"002"},"first_message_only":{"type":"boolean","x-stream-index":"005"},"rules":{"items":{"$ref":"#/components/schemas/VelocityFilterConfigRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules","cascading_actions","first_message_only","cids_per_user","advanced_filters"],"type":"object"},"VelocityFilterConfigRule":{"properties":{"action":{"enum":["flag","shadow","remove","ban"],"type":"string","x-stream-index":"001"},"ban_duration":{"format":"int32","type":"integer","x-stream-index":"002"},"cascading_action":{"enum":["flag","shadow","remove","ban"],"type":"string","x-stream-index":"006"},"cascading_threshold":{"format":"int64","type":"integer","x-stream-index":"005"},"check_message_context":{"type":"boolean","x-stream-index":"009"},"fast_spam_threshold":{"format":"int32","type":"integer","x-stream-index":"007"},"fast_spam_ttl":{"format":"int32","type":"integer","x-stream-index":"010"},"ip_ban":{"type":"boolean","x-stream-index":"004"},"probation_period":{"format":"int32","type":"integer","x-stream-index":"014"},"shadow_ban":{"type":"boolean","x-stream-index":"003"},"slow_spam_ban_duration":{"format":"int32","type":"integer","x-stream-index":"012"},"slow_spam_threshold":{"format":"int32","type":"integer","x-stream-index":"008"},"slow_spam_ttl":{"format":"int32","type":"integer","x-stream-index":"011"},"url_only":{"type":"boolean","x-stream-index":"013"}},"required":["action","ban_duration","shadow_ban","ip_ban","cascading_threshold","cascading_action","fast_spam_threshold","slow_spam_threshold","check_message_context","fast_spam_ttl","slow_spam_ttl","url_only","probation_period"],"type":"object"},"VideoCallRuleConfig":{"properties":{"rules":{"additionalProperties":{"$ref":"#/components/schemas/HarmConfig"},"type":"object","x-stream-index":"001"}},"required":["rules"],"type":"object"},"VideoContentParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"type":"object"},"VideoEndCallRequest":{"type":"object"},"VideoKickUserRequest":{"type":"object"},"VideoOrientation":{"properties":{"orientation":{"type":"integer","x-stream-index":"004"}},"type":"object"},"VideoRuleParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"type":"object"},"VideoSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"camera_default_on":{"type":"boolean","x-stream-index":"004"},"camera_facing":{"enum":["front","back","external"],"type":"string","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled","target_resolution","camera_default_on","camera_facing"],"type":"object"},"VideoSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"camera_default_on":{"type":"boolean","x-stream-index":"004"},"camera_facing":{"enum":["front","back","external"],"type":"string","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled","target_resolution","camera_default_on","camera_facing"],"type":"object"},"WSEvent":{"description":"The discriminator object for all websocket events, it maps events' payload to the final type","discriminator":{"mapping":{"moderation.custom_action":"#/components/schemas/ModerationCustomActionEvent","moderation.flagged":"#/components/schemas/ModerationFlaggedEvent","moderation.mark_reviewed":"#/components/schemas/ModerationMarkReviewedEvent"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/ModerationCustomActionEvent"},{"$ref":"#/components/schemas/ModerationFlaggedEvent"},{"$ref":"#/components/schemas/ModerationMarkReviewedEvent"}]}},"securitySchemes":{"JWT":{"description":"JWT should be always provided when stream-auth-type=jwt.\n\nUsing JWT auth request could be authenticated as user or as server-side.\n\nWhen using user authentication permission checking is going to be applied to requests based on the user that is\nperforming a request.\n\nThe `authorization` header should be a JWT string signed using the secret attached to the API key used to perform\nrequests.\n\n**WARNING** all client-side official SDK do not ship with token generation; this is to make sure that the API secret is not\nshared with an untrusted party such as a browser or a iOS/Android application. Tokens **must** be generated server-side.\nIf you wish, you can configure your application to ignore authentication (see `disable_auth_check`)\nThe JWT string must include only the user_id claim and can include any built-in JWT claim such as iat, exp as well.\n","in":"header","name":"Authorization","type":"apiKey"},"api_key":{"description":"Application API key should be always set in order to authenticate the request.","in":"query","name":"api_key","type":"apiKey"},"stream-auth-type":{"description":"Stream-Auth-Type should be always set in order to authenticate the request. Possible\nvalues: `jwt` or `anonymous`.\n\n`jwt` allows you to authenticate as a user. With this auth type you should also provide valid JWT in Authorization\nheader.\n\n`anonymous` allows you to authenticate as anonymous user. Please note that most advanced features are not available\nto anonymous users.","in":"header","name":"Stream-Auth-Type","type":"apiKey"}}},"info":{"title":"Stream API","version":"v191.1.0"},"openapi":"3.0.3","paths":{"/api/v2/moderation/ban":{"post":{"description":"Ban a user from a channel or the entire app\n","operationId":"ban","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BanRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BanResponse"}}},"description":"Successful 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":"Ban","tags":["product:moderation"]}},"/api/v2/moderation/config":{"post":{"description":"Create a new moderation configuration or update an existing one. Configure settings for content filtering, AI analysis, toxicity detection, and other moderation features.\n","operationId":"upsert_config","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertConfigRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertConfigResponse"}}},"description":"Successful 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":"Create or update moderation configuration","tags":["product:moderation"]}},"/api/v2/moderation/config/{key}":{"delete":{"description":"Delete a specific moderation policy by its name\n","operationId":"delete_config","parameters":[{"in":"path","name":"key","required":true,"schema":{"description":"Key of the moderation configuration to delete","title":"Key","type":"string","x-stream-index":"001"}},{"in":"query","name":"team","schema":{"description":"Team associated with the configuration","title":"Team","type":"string","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteModerationConfigResponse"}}},"description":"Successful 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":"Delete a moderation policy","tags":["product:moderation"]},"get":{"description":"Retrieve a specific moderation configuration by its key and team. This configuration contains settings for various moderation features like toxicity detection, AI analysis, and filtering rules.\n","operationId":"get_config","parameters":[{"in":"path","name":"key","required":true,"schema":{"description":"Key of the moderation configuration to retrieve","title":"Key","type":"string","x-stream-index":"001"}},{"in":"query","name":"team","schema":{"description":"Team associated with the configuration","title":"Team","type":"string","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetConfigResponse"}}},"description":"Successful 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":"Get moderation configuration","tags":["product:moderation"]}},"/api/v2/moderation/configs":{"post":{"description":"Search and filter moderation configurations across your application. This endpoint is designed for building moderation dashboards and managing multiple configuration sets.\n","operationId":"query_moderation_configs","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationConfigsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationConfigsResponse"}}},"description":"Successful 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":"Query moderation configurations","tags":["product:moderation"]}},"/api/v2/moderation/flag":{"post":{"description":"Flag any type of content (messages, users, channels, activities) for moderation review. Supports custom content types and additional metadata for flagged content.\n","operationId":"flag","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlagRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlagResponse"}}},"description":"Successful 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":"Flag content for moderation","tags":["product:moderation"]}},"/api/v2/moderation/mute":{"post":{"description":"Mute a user. Mutes are generally not visible to the user you mute, while block is something you notice.\n","operationId":"mute","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteRequest"}}},"description":"MuteRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteResponse"}}},"description":"MuteResponse"},"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":"Mute","tags":["product:moderation"]}},"/api/v2/moderation/review_queue":{"post":{"description":"Query review queue items allows you to filter the review queue items. This is used for building a moderation dashboard.\n","operationId":"query_review_queue","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryReviewQueueRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryReviewQueueResponse"}}},"description":"Successful 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":"Query review queue items","tags":["product:moderation"]}},"/api/v2/moderation/submit_action":{"post":{"description":"Take action on flagged content, such as marking content as safe, deleting content, banning users, or executing custom moderation actions. Supports various action types with configurable parameters.\n","operationId":"submit_action","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitActionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitActionResponse"}}},"description":"Successful 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":"Submit moderation action","tags":["product:moderation"]}}},"security":[{"JWT":[],"api_key":[],"stream-auth-type":[]},{"api_key":[],"stream-auth-type":[]}],"servers":[{"description":"Stream API","url":"https://chat.stream-io-api.com"}]} \ No newline at end of file diff --git a/openapi/v2/moderation-clientside-api.yaml b/openapi/v2/moderation-clientside-api.yaml index 3a49ddd72..545e40ecc 100644 --- a/openapi/v2/moderation-clientside-api.yaml +++ b/openapi/v2/moderation-clientside-api.yaml @@ -698,11 +698,6 @@ components: shadow_ban: type: boolean x-stream-index: "003" - required: - - duration - - reason - - shadow_ban - - ip_ban type: object BanRequest: nullable: true @@ -772,8 +767,6 @@ components: reason: type: string x-stream-index: "001" - required: - - reason type: object BlockListConfig: properties: @@ -1837,6 +1830,14 @@ components: $ref: '#/components/schemas/ChannelMember' type: array x-stream-index: "020" + message_count: + format: int64 + type: integer + x-stream-index: "035" + message_count_updated_at: + format: date-time + type: number + x-stream-index: "036" team: type: string x-stream-index: "028" @@ -1867,39 +1868,39 @@ components: items: type: string type: array - x-stream-index: "001.026" + x-stream-index: "001.027" automod: enum: - disabled - simple - AI type: string - x-stream-index: "001.021" + x-stream-index: "001.022" automod_behavior: enum: - flag - block - shadow_block type: string - x-stream-index: "001.022" + x-stream-index: "001.023" automod_thresholds: $ref: '#/components/schemas/Thresholds' - x-stream-index: "001.027" + x-stream-index: "001.028" blocklist: type: string - x-stream-index: "001.023" + x-stream-index: "001.024" blocklist_behavior: enum: - flag - block - shadow_block type: string - x-stream-index: "001.024" + x-stream-index: "001.025" blocklists: items: $ref: '#/components/schemas/BlockListOptions' type: array - x-stream-index: "001.025" + x-stream-index: "001.026" commands: items: type: string @@ -1908,6 +1909,9 @@ components: connect_events: type: boolean x-stream-index: "001.004" + count_messages: + type: boolean + x-stream-index: "001.019" created_at: format: date-time type: number @@ -1922,7 +1926,7 @@ components: format: int32 maximum: 20000 type: integer - x-stream-index: "001.020" + x-stream-index: "001.021" mutes: type: boolean x-stream-index: "001.009" @@ -1932,10 +1936,10 @@ components: partition_size: format: int32 type: integer - x-stream-index: "001.028" + x-stream-index: "001.029" partition_ttl: type: integer - x-stream-index: "001.029" + x-stream-index: "001.030" polls: type: boolean x-stream-index: "001.016" @@ -1965,7 +1969,7 @@ components: x-stream-index: "001.018" skip_last_msg_update_for_system_msgs: type: boolean - x-stream-index: "001.030" + x-stream-index: "001.031" typing_events: type: boolean x-stream-index: "001.002" @@ -2001,6 +2005,7 @@ components: - polls - user_message_reminders - shared_locations + - count_messages - message_retention - max_message_length - automod @@ -2016,39 +2021,39 @@ components: items: type: string type: array - x-stream-index: 001.002.026 + x-stream-index: 001.002.027 automod: enum: - disabled - simple - AI type: string - x-stream-index: 001.002.021 + x-stream-index: 001.002.022 automod_behavior: enum: - flag - block - shadow_block type: string - x-stream-index: 001.002.022 + x-stream-index: 001.002.023 automod_thresholds: $ref: '#/components/schemas/Thresholds' - x-stream-index: 001.002.027 + x-stream-index: 001.002.028 blocklist: type: string - x-stream-index: 001.002.023 + x-stream-index: 001.002.024 blocklist_behavior: enum: - flag - block - shadow_block type: string - x-stream-index: 001.002.024 + x-stream-index: 001.002.025 blocklists: items: $ref: '#/components/schemas/BlockListOptions' type: array - x-stream-index: 001.002.025 + x-stream-index: 001.002.026 commands: items: $ref: '#/components/schemas/Command' @@ -2057,6 +2062,9 @@ components: connect_events: type: boolean x-stream-index: 001.002.004 + count_messages: + type: boolean + x-stream-index: 001.002.019 created_at: format: date-time type: number @@ -2078,7 +2086,7 @@ components: format: int32 maximum: 20000 type: integer - x-stream-index: 001.002.020 + x-stream-index: 001.002.021 mutes: type: boolean x-stream-index: 001.002.009 @@ -2088,10 +2096,10 @@ components: partition_size: format: int32 type: integer - x-stream-index: 001.002.028 + x-stream-index: 001.002.029 partition_ttl: type: integer - x-stream-index: 001.002.029 + x-stream-index: 001.002.030 polls: type: boolean x-stream-index: 001.002.016 @@ -2121,7 +2129,7 @@ components: x-stream-index: 001.002.018 skip_last_msg_update_for_system_msgs: type: boolean - x-stream-index: 001.002.030 + x-stream-index: 001.002.031 typing_events: type: boolean x-stream-index: 001.002.002 @@ -2159,6 +2167,7 @@ components: - polls - user_message_reminders - shared_locations + - count_messages - message_retention - max_message_length - automod @@ -2195,6 +2204,11 @@ components: format: date-time type: number x-stream-index: "014" + deleted_messages: + items: + type: string + type: array + x-stream-index: "027" invite_accepted_at: format: date-time type: number @@ -2343,6 +2357,10 @@ components: $ref: '#/components/schemas/ChannelMember' type: array x-stream-index: "014" + message_count: + format: int64 + type: integer + x-stream-index: "031" mute_expires_at: format: date-time type: number @@ -2452,6 +2470,9 @@ components: type: string type: array x-stream-index: "011" + count_messages: + type: boolean + x-stream-index: "014" grants: additionalProperties: items: @@ -2498,7 +2519,7 @@ components: $ref: '#/components/schemas/AIImageConfig' description: Configuration for AI image analysis title: AI Image Config - x-stream-index: "009" + x-stream-index: "010" ai_text_config: $ref: '#/components/schemas/AITextConfig' description: Configuration for AI text analysis @@ -2508,7 +2529,7 @@ components: $ref: '#/components/schemas/AIVideoConfig' description: Configuration for AI video analysis title: AI Video Config - x-stream-index: "010" + x-stream-index: "011" async: description: Whether moderation should be performed asynchronously title: Async @@ -2539,15 +2560,17 @@ components: format: date-time title: Created At type: number - x-stream-index: "012" + x-stream-index: "013" key: description: Unique identifier for the moderation configuration title: Key type: string x-stream-index: "001" - rule_builder_config: - $ref: '#/components/schemas/RuleBuilderConfig' - x-stream-index: "015" + llm_config: + $ref: '#/components/schemas/LLMConfig' + description: Configuration for customer-configured LLM moderation + title: LLM Config + x-stream-index: "009" team: description: Team associated with the configuration title: Team @@ -2558,15 +2581,15 @@ components: format: date-time title: Updated At type: number - x-stream-index: "013" + x-stream-index: "014" velocity_filter_config: $ref: '#/components/schemas/VelocityFilterConfig' description: Configuration for velocity-based filtering title: Velocity Filter Config - x-stream-index: "011" + x-stream-index: "012" video_call_rule_config: $ref: '#/components/schemas/VideoCallRuleConfig' - x-stream-index: "014" + x-stream-index: "015" required: - key - team @@ -2583,9 +2606,6 @@ components: time_window: type: string x-stream-index: "002" - required: - - threshold - - time_window type: object CustomActionRequest: properties: @@ -3227,6 +3247,21 @@ components: type: object x-stream-index: "001" type: object + FeedsEventPreferences: + properties: + comments: + type: string + x-stream-index: "002" + mentions: + type: string + x-stream-index: "004" + new_followers: + type: string + x-stream-index: "003" + reactions: + type: string + x-stream-index: "001" + type: object Field: nullable: true properties: @@ -3341,8 +3376,6 @@ components: reason: type: string x-stream-index: "001" - required: - - reason type: object FlagRequest: nullable: true @@ -3403,8 +3436,6 @@ components: reason: type: string x-stream-index: "001" - required: - - reason type: object FrameRecordSettings: properties: @@ -3637,9 +3668,6 @@ components: time_window: type: string x-stream-index: "002" - required: - - threshold - - time_window type: object Images: properties: @@ -3824,6 +3852,61 @@ components: - max_dimension - frame_rate_limit type: object + LLMConfig: + properties: + app_context: + type: string + x-stream-index: "005" + async: + type: boolean + x-stream-index: "001" + enabled: + type: boolean + x-stream-index: "002" + rules: + items: + $ref: '#/components/schemas/LLMRule' + type: array + x-stream-index: "003" + severity_descriptions: + additionalProperties: + type: string + type: object + x-stream-index: "004" + required: + - enabled + - rules + type: object + LLMRule: + properties: + action: + enum: + - flag + - shadow + - remove + - bounce + - bounce_flag + - bounce_remove + - keep + type: string + x-stream-index: "003" + description: + type: string + x-stream-index: "002" + label: + type: string + x-stream-index: "001" + severity_rules: + items: + $ref: '#/components/schemas/BodyguardSeverityRule' + type: array + x-stream-index: "004" + required: + - label + - description + - action + - severity_rules + type: object LabelThresholds: properties: block: @@ -3959,6 +4042,9 @@ components: format: date-time type: number x-stream-index: "033" + deleted_for_me: + type: boolean + x-stream-index: "059" deleted_reply_count: format: int32 type: integer @@ -4198,6 +4284,9 @@ components: title: Deleted at type: number x-stream-index: "025" + deleted_for_me: + type: boolean + x-stream-index: "044" deleted_reply_count: format: int32 type: integer @@ -4504,6 +4593,71 @@ components: x-stream-event-doc-group: other x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent + ModerationFlagResponse: + nullable: true + properties: + created_at: + format: date-time + type: number + x-stream-index: "015" + custom: + additionalProperties: {} + type: object + x-stream-index: "010" + entity_creator_id: + type: string + x-stream-index: "007" + entity_id: + type: string + x-stream-index: "006" + entity_type: + type: string + x-stream-index: "005" + labels: + items: + type: string + type: array + x-stream-index: "011" + moderation_payload: + $ref: '#/components/schemas/ModerationPayload' + x-stream-index: "008" + reason: + type: string + x-stream-index: "009" + result: + items: + additionalProperties: {} + type: object + type: array + x-stream-index: "012" + review_queue_item: + $ref: '#/components/schemas/ReviewQueueItemResponse' + x-stream-index: "014" + review_queue_item_id: + type: string + x-stream-index: "013" + type: + type: string + x-stream-index: "002" + updated_at: + format: date-time + type: number + x-stream-index: "016" + user: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "004" + user_id: + type: string + x-stream-index: "003" + required: + - type + - user_id + - entity_type + - entity_id + - result + - created_at + - updated_at + type: object ModerationFlaggedEvent: properties: created_at: @@ -5210,6 +5364,12 @@ components: disabled_until: format: date-time type: number + x-stream-index: "005" + feeds_events: + $ref: '#/components/schemas/FeedsEventPreferences' + x-stream-index: "004" + feeds_level: + type: string x-stream-index: "003" type: object Quality: @@ -5960,7 +6120,7 @@ components: flags: description: Associated flag records items: - $ref: '#/components/schemas/FlagResponse' + $ref: '#/components/schemas/ModerationFlagResponse' title: Flags type: array x-stream-index: "023" @@ -6105,8 +6265,6 @@ components: type: type: string x-stream-index: "001" - required: - - type type: object RuleBuilderCondition: properties: @@ -6135,6 +6293,9 @@ components: user_created_within_params: $ref: '#/components/schemas/UserCreatedWithinParameters' x-stream-index: "011" + user_custom_property_params: + $ref: '#/components/schemas/UserCustomPropertyParameters' + x-stream-index: "012" user_rule_params: $ref: '#/components/schemas/UserRuleParameters' x-stream-index: "006" @@ -6144,8 +6305,6 @@ components: video_rule_params: $ref: '#/components/schemas/VideoRuleParameters' x-stream-index: "005" - required: - - type type: object RuleBuilderConditionGroup: properties: @@ -6157,9 +6316,6 @@ components: logic: type: string x-stream-index: "001" - required: - - logic - - conditions type: object RuleBuilderConfig: properties: @@ -6171,48 +6327,37 @@ components: $ref: '#/components/schemas/RuleBuilderRule' type: array x-stream-index: "002" - required: - - rules type: object RuleBuilderRule: properties: action: $ref: '#/components/schemas/RuleBuilderAction' - x-stream-index: "007" + x-stream-index: "006" conditions: items: $ref: '#/components/schemas/RuleBuilderCondition' type: array - x-stream-index: "004" + x-stream-index: "003" cooldown_period: type: string - x-stream-index: "009" - enabled: - type: boolean - x-stream-index: "008" + x-stream-index: "007" groups: items: $ref: '#/components/schemas/RuleBuilderConditionGroup' type: array - x-stream-index: "006" + x-stream-index: "005" id: type: string x-stream-index: "001" logic: type: string - x-stream-index: "005" - name: - type: string - x-stream-index: "002" + x-stream-index: "004" rule_type: type: string - x-stream-index: "003" + x-stream-index: "002" required: - - id - - name - rule_type - action - - enabled type: object SFUIDLastSeen: properties: @@ -6550,18 +6695,23 @@ components: items: type: string type: array - x-stream-index: "004" + x-stream-index: "005" contains_url: type: boolean - x-stream-index: "002" + x-stream-index: "003" harm_labels: items: type: string type: array x-stream-index: "001" + llm_harm_labels: + additionalProperties: + type: string + type: object + x-stream-index: "002" severity: type: string - x-stream-index: "003" + x-stream-index: "004" type: object TextRuleParameters: properties: @@ -6569,18 +6719,23 @@ components: items: type: string type: array - x-stream-index: "006" + x-stream-index: "007" contains_url: type: boolean - x-stream-index: "004" + x-stream-index: "005" harm_labels: items: type: string type: array x-stream-index: "003" + llm_harm_labels: + additionalProperties: + type: string + type: object + x-stream-index: "004" severity: type: string - x-stream-index: "005" + x-stream-index: "006" threshold: format: int32 type: integer @@ -6588,9 +6743,6 @@ components: time_window: type: string x-stream-index: "002" - required: - - threshold - - time_window type: object Thresholds: properties: @@ -6785,7 +6937,7 @@ components: $ref: '#/components/schemas/AIImageConfig' description: Configuration for AI image analysis title: AI Image Config - x-stream-index: "010" + x-stream-index: "011" ai_text_config: $ref: '#/components/schemas/AITextConfig' description: Configuration for AI text analysis @@ -6795,7 +6947,7 @@ components: $ref: '#/components/schemas/AIVideoConfig' description: Configuration for AI video analysis title: AI Video Config - x-stream-index: "011" + x-stream-index: "012" async: description: Whether moderation should be performed asynchronously title: Async @@ -6818,7 +6970,7 @@ components: x-stream-index: "004" aws_rekognition_config: $ref: '#/components/schemas/AIImageConfig' - x-stream-index: "015" + x-stream-index: "016" block_list_config: $ref: '#/components/schemas/BlockListConfig' description: Configuration for block list filtering @@ -6826,23 +6978,28 @@ components: x-stream-index: "007" bodyguard_config: $ref: '#/components/schemas/AITextConfig' - x-stream-index: "014" + x-stream-index: "015" google_vision_config: $ref: '#/components/schemas/GoogleVisionConfig' description: Configuration for Google Vision integration title: Google Vision Config - x-stream-index: "009" + x-stream-index: "010" key: description: Unique identifier for the moderation configuration title: Key type: string x-stream-index: "001" + llm_config: + $ref: '#/components/schemas/LLMConfig' + description: Configuration for customer-configured LLM moderation + title: LLM Config + x-stream-index: "009" rule_builder_config: $ref: '#/components/schemas/RuleBuilderConfig' description: Configuration for custom rule builder (max 3 rules, max 5 conditions per rule) title: Rule Builder Config - x-stream-index: "013" + x-stream-index: "014" team: description: Team associated with the configuration maxLength: 128 @@ -6854,10 +7011,10 @@ components: $ref: '#/components/schemas/VelocityFilterConfig' description: Configuration for velocity-based filtering title: Velocity Filter Config - x-stream-index: "012" + x-stream-index: "013" video_call_rule_config: $ref: '#/components/schemas/VideoCallRuleConfig' - x-stream-index: "016" + x-stream-index: "017" required: - key type: object @@ -6970,6 +7127,15 @@ components: type: string x-stream-index: "001" type: object + UserCustomPropertyParameters: + properties: + operator: + type: string + x-stream-index: "002" + property_key: + type: string + x-stream-index: "001" + type: object UserMute: nullable: true properties: @@ -7316,9 +7482,6 @@ components: time_window: type: string x-stream-index: "002" - required: - - threshold - - time_window type: object VideoSettings: properties: @@ -7430,7 +7593,7 @@ components: type: apiKey info: title: Stream API - version: v187.13.0 + version: v191.1.0 openapi: 3.0.3 paths: /api/v2/moderation/ban: diff --git a/openapi/v2/moderation-serverside-api.json b/openapi/v2/moderation-serverside-api.json index 20e6787f4..c5fbcd47b 100644 --- a/openapi/v2/moderation-serverside-api.json +++ b/openapi/v2/moderation-serverside-api.json @@ -1 +1 @@ -{"components":{"schemas":{"AIImageConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"ocr_rules":{"items":{"$ref":"#/components/schemas/OCRRule"},"type":"array","x-stream-index":"004"},"rules":{"items":{"$ref":"#/components/schemas/AWSRekognitionRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules","ocr_rules"],"type":"object"},"AITextConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"profile":{"type":"string","x-stream-index":"003"},"rules":{"items":{"$ref":"#/components/schemas/BodyguardRule"},"type":"array","x-stream-index":"004"},"severity_rules":{"items":{"$ref":"#/components/schemas/BodyguardSeverityRule"},"type":"array","x-stream-index":"005"}},"required":["enabled","profile","rules","severity_rules"],"type":"object"},"AIVideoConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AWSRekognitionRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"APIError":{"nullable":true,"properties":{"StatusCode":{"description":"Response HTTP status code","format":"int32","title":"Status code","type":"integer","x-stream-index":"004"},"code":{"description":"API error code","format":"int32","title":"Code","type":"integer","x-stream-index":"001"},"details":{"description":"Additional error-specific information","items":{"type":"integer"},"title":"Details","type":"array","x-stream-index":"007"},"duration":{"description":"Request duration","title":"Duration","type":"string","x-stream-index":"005"},"exception_fields":{"additionalProperties":{"type":"string"},"description":"Additional error info","title":"Exception fields","type":"object","x-stream-index":"003"},"message":{"description":"Message describing an error","title":"Message","type":"string","x-stream-index":"002"},"more_info":{"description":"URL with additional information","title":"More info","type":"string","x-stream-index":"006"},"unrecoverable":{"description":"Flag that indicates if the error is unrecoverable, requests that return unrecoverable errors should not be retried, this error only applies to the request that caused it","title":"Unrecoverable","type":"boolean","x-stream-index":"008"}},"required":["code","message","StatusCode","duration","more_info","details"],"title":"Error response","type":"object"},"APNS":{"properties":{"body":{"type":"string","x-stream-index":"002"},"content-available":{"format":"int32","type":"integer","x-stream-index":"004"},"data":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"mutable-content":{"format":"int32","type":"integer","x-stream-index":"005"},"sound":{"type":"string","x-stream-index":"003"},"title":{"type":"string","x-stream-index":"001"}},"required":["title","body"],"type":"object"},"AWSRekognitionRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"},"min_confidence":{"format":"float","maximum":100,"minimum":0,"type":"number","x-stream-index":"003"}},"required":["label","action","min_confidence"],"type":"object"},"Action":{"nullable":true,"properties":{"name":{"type":"string","x-stream-index":"001"},"style":{"type":"string","x-stream-index":"003"},"text":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"004"},"value":{"type":"string","x-stream-index":"005"}},"required":["name","text","type"],"type":"object"},"ActionLog":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"002"},"reason":{"type":"string","x-stream-index":"008"},"reporter_type":{"type":"string","x-stream-index":"009"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"014"},"review_queue_item_id":{"type":"string","x-stream-index":"012"},"target_user":{"$ref":"#/components/schemas/User","x-stream-index":"013"},"target_user_id":{"type":"string","x-stream-index":"011"},"type":{"type":"string","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007"}},"required":["id","created_at","type","reason","reporter_type","custom","target_user_id","review_queue_item_id"],"type":"object"},"ActionLogResponse":{"nullable":true,"properties":{"created_at":{"description":"Timestamp when the action was taken","format":"date-time","title":"Created At","type":"number","x-stream-index":"002"},"custom":{"additionalProperties":{},"description":"Additional metadata about the action","title":"Custom","type":"object","x-stream-index":"007"},"id":{"description":"Unique identifier of the action log","title":"ID","type":"string","x-stream-index":"001"},"reason":{"description":"Reason for the moderation action","title":"Reason","type":"string","x-stream-index":"006"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"Associated review queue item","title":"Review Queue Item","x-stream-index":"008"},"target_user":{"$ref":"#/components/schemas/UserResponse","description":"User who was the target of the action","title":"Target User","x-stream-index":"009"},"target_user_id":{"description":"ID of the user who was the target of the action","title":"Target User ID","type":"string","x-stream-index":"010"},"type":{"description":"Type of moderation action","title":"Type","type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who performed the action","title":"User","x-stream-index":"004"},"user_id":{"description":"ID of the user who performed the action","title":"User ID","type":"string","x-stream-index":"005"}},"required":["id","created_at","type","user_id","reason","custom","target_user_id"],"type":"object"},"ActionSequence":{"properties":{"action":{"type":"string","x-stream-index":"001"},"blur":{"type":"boolean","x-stream-index":"005"},"cooldown_period":{"format":"int32","type":"integer","x-stream-index":"004"},"threshold":{"format":"int32","type":"integer","x-stream-index":"002"},"time_window":{"format":"int32","type":"integer","x-stream-index":"003"},"warning":{"type":"boolean","x-stream-index":"006"},"warning_text":{"type":"string","x-stream-index":"007"}},"required":["action","threshold","time_window","cooldown_period","blur","warning","warning_text"],"type":"object"},"AsyncBulkImageModerationEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"003.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.007"},"finished_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.004"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"task_id":{"type":"string","x-stream-index":"002.001"},"type":{"default":"export.bulk_image_moderation.success","type":"string","x-stream-index":"003.002"},"url":{"type":"string","x-stream-index":"001"}},"required":["url","task_id","started_at","finished_at","type","created_at","custom"],"title":"AsyncBulkImageModerationEvent","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"},"AsyncExportErrorEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"003.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.007"},"error":{"type":"string","x-stream-index":"001"},"finished_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.004"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"task_id":{"type":"string","x-stream-index":"002.001"},"type":{"default":"export.moderation_logs.error","type":"string","x-stream-index":"003.002"}},"required":["error","task_id","started_at","finished_at","type","created_at","custom"],"title":"AsyncExportErrorEvent","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"},"AsyncExportModerationLogsEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"003.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.007"},"finished_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.004"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"task_id":{"type":"string","x-stream-index":"002.001"},"type":{"default":"export.moderation_logs.success","type":"string","x-stream-index":"003.002"},"url":{"type":"string","x-stream-index":"001"}},"required":["url","task_id","started_at","finished_at","type","created_at","custom"],"title":"AsyncExportModerationLogsEvent","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"},"Attachment":{"description":"An attachment is a message object that represents a file uploaded by a user.","nullable":true,"properties":{"actions":{"items":{"$ref":"#/components/schemas/Action"},"type":"array","x-stream-index":"015"},"asset_url":{"type":"string","x-stream-index":"017"},"author_icon":{"type":"string","x-stream-index":"007"},"author_link":{"type":"string","x-stream-index":"006"},"author_name":{"type":"string","x-stream-index":"005"},"color":{"type":"string","x-stream-index":"003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"018"},"fallback":{"type":"string","x-stream-index":"002"},"fields":{"items":{"$ref":"#/components/schemas/Field"},"type":"array","x-stream-index":"016"},"footer":{"type":"string","x-stream-index":"013"},"footer_icon":{"type":"string","x-stream-index":"014"},"giphy":{"$ref":"#/components/schemas/Images","x-stream-index":"019"},"image_url":{"type":"string","x-stream-index":"011"},"og_scrape_url":{"type":"string","x-stream-index":"020"},"original_height":{"format":"int32","type":"integer","x-stream-index":"022"},"original_width":{"format":"int32","type":"integer","x-stream-index":"021"},"pretext":{"type":"string","x-stream-index":"004"},"text":{"type":"string","x-stream-index":"010"},"thumb_url":{"type":"string","x-stream-index":"012"},"title":{"type":"string","x-stream-index":"008"},"title_link":{"type":"string","x-stream-index":"009"},"type":{"description":"Attachment type (e.g. image, video, url)","title":"Type","type":"string","x-stream-index":"001"}},"required":["custom"],"title":"Attachment","type":"object","x-stream-docs-page-id":"file_uploads"},"AudioSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"001"},"default_device":{"enum":["speaker","earpiece"],"type":"string","x-stream-index":"006"},"mic_default_on":{"type":"boolean","x-stream-index":"004"},"noise_cancellation":{"$ref":"#/components/schemas/NoiseCancellationSettings","x-stream-index":"007"},"opus_dtx_enabled":{"type":"boolean","x-stream-index":"002"},"redundant_coding_enabled":{"type":"boolean","x-stream-index":"003"},"speaker_default_on":{"type":"boolean","x-stream-index":"005"}},"required":["access_request_enabled","opus_dtx_enabled","redundant_coding_enabled","mic_default_on","speaker_default_on","default_device"],"type":"object"},"AudioSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"001"},"default_device":{"enum":["speaker","earpiece"],"type":"string","x-stream-index":"006"},"mic_default_on":{"type":"boolean","x-stream-index":"004"},"noise_cancellation":{"$ref":"#/components/schemas/NoiseCancellationSettings","x-stream-index":"007"},"opus_dtx_enabled":{"type":"boolean","x-stream-index":"002"},"redundant_coding_enabled":{"type":"boolean","x-stream-index":"003"},"speaker_default_on":{"type":"boolean","x-stream-index":"005"}},"required":["access_request_enabled","opus_dtx_enabled","redundant_coding_enabled","mic_default_on","speaker_default_on","default_device"],"type":"object"},"AutomodPlatformCircumventionConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AutomodRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"AutomodRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"003"},"label":{"type":"string","x-stream-index":"001"},"threshold":{"format":"float","maximum":1,"minimum":0,"type":"number","x-stream-index":"002"}},"required":["label","threshold","action"],"type":"object"},"AutomodSemanticFiltersConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AutomodSemanticFiltersRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"AutomodSemanticFiltersRule":{"properties":{"action":{"enum":["flag","shadow","remove"],"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"threshold":{"format":"float","maximum":1,"minimum":0,"type":"number","x-stream-index":"002"}},"required":["name","threshold","action"],"type":"object"},"AutomodToxicityConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AutomodRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"BackstageSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"BackstageSettingsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"Ban":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"012"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"011"},"expires":{"format":"date-time","type":"number","x-stream-index":"007"},"reason":{"type":"string","x-stream-index":"008"},"shadow":{"type":"boolean","x-stream-index":"009"},"target":{"$ref":"#/components/schemas/User","x-stream-index":"006"}},"required":["shadow","created_at"],"type":"object"},"BanActionRequest":{"properties":{"channel_ban_only":{"type":"boolean","x-stream-index":"003"},"delete_messages":{"enum":["soft","pruning","hard"],"type":"string","x-stream-index":"005"},"ip_ban":{"type":"boolean","x-stream-index":"004"},"reason":{"type":"string","x-stream-index":"002"},"shadow":{"type":"boolean","x-stream-index":"001"},"timeout":{"format":"int32","type":"integer","x-stream-index":"006"}},"type":"object"},"BanOptions":{"properties":{"duration":{"format":"int32","type":"integer","x-stream-index":"001"},"ip_ban":{"type":"boolean","x-stream-index":"004"},"reason":{"type":"string","x-stream-index":"002"},"shadow_ban":{"type":"boolean","x-stream-index":"003"}},"required":["duration","reason","shadow_ban","ip_ban"],"type":"object"},"BanRequest":{"nullable":true,"properties":{"banned_by":{"$ref":"#/components/schemas/UserRequest","description":"Details about the user performing the ban","title":"Banned By","x-stream-index":"008"},"banned_by_id":{"description":"ID of the user performing the ban","title":"Banned By ID","type":"string","x-stream-index":"007"},"channel_cid":{"description":"Channel where the ban applies","title":"Channel CID","type":"string","x-stream-index":"004"},"delete_messages":{"enum":["soft","pruning","hard"],"type":"string","x-stream-index":"009"},"ip_ban":{"description":"Whether to ban the user's IP address","title":"IP Ban","type":"boolean","x-stream-index":"006"},"reason":{"description":"Optional explanation for the ban","title":"Reason","type":"string","x-stream-index":"003"},"shadow":{"description":"Whether this is a shadow ban","title":"Shadow","type":"boolean","x-stream-index":"005"},"target_user_id":{"description":"ID of the user to ban","title":"Target User ID","type":"string","x-stream-index":"001"},"timeout":{"description":"Duration of the ban in minutes","minimum":0,"title":"Timeout","type":"integer","x-stream-index":"002"}},"required":["target_user_id"],"type":"object"},"BanResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"BlockContentOptions":{"properties":{"reason":{"type":"string","x-stream-index":"001"}},"required":["reason"],"type":"object"},"BlockListConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/BlockListRule"},"maximum":10,"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"BlockListOptions":{"properties":{"behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"002"},"blocklist":{"type":"string","x-stream-index":"001"}},"required":["blocklist","behavior"],"type":"object"},"BlockListRule":{"properties":{"action":{"enum":["flag","mask_flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"002"}},"required":["name","team","action"],"type":"object"},"BodyguardRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"},"severity_rules":{"items":{"$ref":"#/components/schemas/BodyguardSeverityRule"},"type":"array","x-stream-index":"003"}},"required":["label","action","severity_rules"],"type":"object"},"BodyguardSeverityRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"severity":{"enum":["low","medium","high","critical"],"type":"string","x-stream-index":"001"}},"required":["severity","action"],"type":"object"},"BroadcastSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettings","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettings","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"BroadcastSettingsResponse":{"description":"BroadcastSettingsResponse is the payload for broadcasting settings","properties":{"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettingsResponse","title":"HLS","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettingsResponse","title":"RTMP","x-stream-index":"003"}},"required":["enabled","hls","rtmp"],"title":"BroadcastSettingsResponse","type":"object"},"BulkImageModerationRequest":{"nullable":true,"properties":{"csv_file":{"description":"URL to CSV file containing image URLs to moderate","title":"string","type":"string","x-stream-index":"001"}},"required":["csv_file"],"type":"object"},"BulkImageModerationResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"task_id":{"description":"ID of the task for processing the bulk image moderation","title":"string","type":"string","x-stream-index":"001"}},"required":["task_id","duration"],"type":"object"},"Call":{"properties":{"AppPK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"002"},"Backstage":{"type":"boolean","writeOnly":true,"x-stream-index":"023"},"BlockedUserIDs":{"items":{"type":"string"},"type":"array","writeOnly":true,"x-stream-index":"018"},"BlockedUsers":{"items":{"$ref":"#/components/schemas/User"},"type":"array","writeOnly":true,"x-stream-index":"019"},"CID":{"type":"string","writeOnly":true,"x-stream-index":"005"},"CallType":{"$ref":"#/components/schemas/CallType","x-stream-index":"020"},"ChannelCID":{"type":"string","writeOnly":true,"x-stream-index":"032"},"CreatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"013"},"CreatedBy":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"CreatedByUserID":{"type":"string","writeOnly":true,"x-stream-index":"007"},"CurrentSessionID":{"type":"string","writeOnly":true,"x-stream-index":"024"},"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"012"},"DeletedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"028"},"EgressUpdatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"027"},"Egresses":{"items":{"$ref":"#/components/schemas/CallEgress"},"type":"array","writeOnly":true,"x-stream-index":"015"},"EndedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"017"},"ID":{"type":"string","writeOnly":true,"x-stream-index":"004"},"JoinAheadTimeSeconds":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"031"},"LastHeartbeatAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"030"},"LastSessionID":{"type":"string","writeOnly":true,"x-stream-index":"025"},"MemberCount":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"010"},"MemberLookup":{"$ref":"#/components/schemas/MemberLookup","x-stream-index":"011"},"Members":{"items":{"$ref":"#/components/schemas/CallMember"},"type":"array","writeOnly":true,"x-stream-index":"009"},"Session":{"$ref":"#/components/schemas/CallSession","x-stream-index":"026"},"Settings":{"$ref":"#/components/schemas/CallSettings","x-stream-index":"022"},"SettingsOverrides":{"$ref":"#/components/schemas/CallSettings","x-stream-index":"021"},"StartsAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"016"},"Team":{"type":"string","writeOnly":true,"x-stream-index":"006"},"ThumbnailURL":{"type":"string","writeOnly":true,"x-stream-index":"029"},"Type":{"type":"string","writeOnly":true,"x-stream-index":"003"},"UpdatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"014"}},"required":["AppPK","Type","ID","CID","Team","CreatedByUserID","Members","Custom","CreatedAt","UpdatedAt","Egresses","BlockedUserIDs","BlockedUsers","Backstage","CurrentSessionID","LastSessionID","ThumbnailURL","ChannelCID"],"type":"object"},"CallEgress":{"nullable":true,"properties":{"app_pk":{"format":"int32","type":"integer","x-stream-index":"002"},"call_id":{"type":"string","x-stream-index":"004"},"call_type":{"type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/EgressTaskConfig","x-stream-index":"007"},"egress_id":{"type":"string","x-stream-index":"005"},"egress_type":{"type":"string","x-stream-index":"006"},"instance_ip":{"type":"string","x-stream-index":"008"},"started_at":{"format":"date-time","type":"number","x-stream-index":"010"},"state":{"type":"string","x-stream-index":"009"},"stopped_at":{"format":"date-time","type":"number","x-stream-index":"011"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"012"}},"required":["app_pk","call_type","call_id","egress_id","egress_type","instance_ip","state","started_at","updated_at"],"type":"object"},"CallIngressResponse":{"description":"CallIngressResponse is the payload for ingress settings","properties":{"rtmp":{"$ref":"#/components/schemas/RTMPIngress","title":"RTMP","x-stream-index":"001"}},"required":["rtmp"],"title":"CallIngressResponse","type":"object"},"CallMember":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"010"},"role":{"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["user_id","role","custom","created_at","updated_at"],"type":"object"},"CallParticipant":{"nullable":true,"properties":{"JoinedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"004"},"Role":{"type":"string","writeOnly":true,"x-stream-index":"002"},"UserSessionID":{"type":"string","writeOnly":true,"x-stream-index":"003"},"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"001.046"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"001.017"},"banned":{"type":"boolean","x-stream-index":"001.016"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.013"},"id":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"001.023"},"language":{"type":"string","x-stream-index":"001.035"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"001.022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"001.026"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.042"},"role":{"type":"string","x-stream-index":"001.004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.005"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.009"}},"required":["id","role","teams_role","custom","banned","online","Role","UserSessionID","JoinedAt"],"type":"object"},"CallParticipantResponse":{"properties":{"joined_at":{"format":"date-time","type":"number","x-stream-index":"004"},"role":{"type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"},"user_session_id":{"type":"string","x-stream-index":"002"}},"required":["user","user_session_id","role","joined_at"],"type":"object"},"CallResponse":{"description":"Represents a call","properties":{"backstage":{"type":"boolean","x-stream-index":"016"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"018"},"captioning":{"type":"boolean","x-stream-index":"013"},"channel_cid":{"type":"string","x-stream-index":"024"},"cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"The user that created the call","title":"Created By","x-stream-index":"007"},"current_session_id":{"type":"string","x-stream-index":"005"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"008"},"egress":{"$ref":"#/components/schemas/EgressResponse","x-stream-index":"021"},"ended_at":{"description":"Date/time when the call ended","format":"date-time","title":"Ended At","type":"number","x-stream-index":"014"},"id":{"description":"Call ID","title":"ID","type":"string","x-stream-index":"003"},"ingress":{"$ref":"#/components/schemas/CallIngressResponse","x-stream-index":"019"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"023"},"recording":{"type":"boolean","x-stream-index":"011"},"session":{"$ref":"#/components/schemas/CallSessionResponse","x-stream-index":"020"},"settings":{"$ref":"#/components/schemas/CallSettingsResponse","x-stream-index":"017"},"starts_at":{"description":"Date/time when the call will start","format":"date-time","title":"Starts At","type":"number","x-stream-index":"015"},"team":{"type":"string","x-stream-index":"006"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailResponse","x-stream-index":"022"},"transcribing":{"type":"boolean","x-stream-index":"012"},"type":{"description":"The type of call","title":"Type","type":"string","x-stream-index":"002"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"}},"required":["type","id","cid","current_session_id","created_by","custom","created_at","updated_at","recording","transcribing","captioning","backstage","settings","blocked_user_ids","ingress","egress"],"title":"CallResponse","type":"object"},"CallSession":{"properties":{"AcceptedBy":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","writeOnly":true,"x-stream-index":"008"},"ActiveSFUs":{"items":{"$ref":"#/components/schemas/SFUIDLastSeen"},"type":"array","writeOnly":true,"x-stream-index":"016"},"AnonymousParticipantCount":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"019"},"AppPK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"002.001"},"CallID":{"type":"string","writeOnly":true,"x-stream-index":"002.003"},"CallType":{"type":"string","writeOnly":true,"x-stream-index":"002.002"},"CreatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"003"},"DeletedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"004"},"EndedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"006"},"LiveEndedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"013"},"LiveStartedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"012"},"MissedBy":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","writeOnly":true,"x-stream-index":"010"},"Participants":{"items":{"$ref":"#/components/schemas/CallParticipant"},"type":"array","writeOnly":true,"x-stream-index":"011"},"ParticipantsCountByRole":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","writeOnly":true,"x-stream-index":"018"},"RejectedBy":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","writeOnly":true,"x-stream-index":"009"},"RingAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"007"},"SFUIDs":{"items":{"type":"string"},"type":"array","writeOnly":true,"x-stream-index":"015"},"SessionID":{"type":"string","writeOnly":true,"x-stream-index":"002.004"},"StartedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"005"},"TimerEndsAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"014"},"UserPermissionOverrides":{"additionalProperties":{"additionalProperties":{"type":"boolean"},"type":"object"},"type":"object","writeOnly":true,"x-stream-index":"017"}},"required":["AppPK","CallType","CallID","SessionID","CreatedAt","AcceptedBy","RejectedBy","MissedBy","Participants","SFUIDs","ActiveSFUs","UserPermissionOverrides","ParticipantsCountByRole","AnonymousParticipantCount"],"type":"object"},"CallSessionResponse":{"properties":{"accepted_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"008"},"anonymous_participant_count":{"format":"int32","type":"integer","x-stream-index":"006"},"ended_at":{"format":"date-time","type":"number","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"live_ended_at":{"format":"date-time","type":"number","x-stream-index":"011"},"live_started_at":{"format":"date-time","type":"number","x-stream-index":"010"},"missed_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"009"},"participants":{"items":{"$ref":"#/components/schemas/CallParticipantResponse"},"type":"array","x-stream-index":"004"},"participants_count_by_role":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"005"},"rejected_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"007"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002"},"timer_ends_at":{"format":"date-time","type":"number","x-stream-index":"012"}},"required":["id","participants","participants_count_by_role","anonymous_participant_count","rejected_by","accepted_by","missed_by"],"type":"object"},"CallSettings":{"properties":{"audio":{"$ref":"#/components/schemas/AudioSettings","x-stream-index":"001"},"backstage":{"$ref":"#/components/schemas/BackstageSettings","x-stream-index":"002"},"broadcasting":{"$ref":"#/components/schemas/BroadcastSettings","x-stream-index":"007"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordSettings","x-stream-index":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettings","x-stream-index":"008"},"ingress":{"$ref":"#/components/schemas/IngressSettings","x-stream-index":"014"},"limits":{"$ref":"#/components/schemas/LimitsSettings","x-stream-index":"012"},"recording":{"$ref":"#/components/schemas/RecordSettings","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettings","x-stream-index":"010"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettings","x-stream-index":"004"},"session":{"$ref":"#/components/schemas/SessionSettings","x-stream-index":"013"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettings","x-stream-index":"011"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettings","x-stream-index":"009"},"video":{"$ref":"#/components/schemas/VideoSettings","x-stream-index":"003"}},"type":"object"},"CallSettingsResponse":{"properties":{"audio":{"$ref":"#/components/schemas/AudioSettingsResponse","x-stream-index":"001"},"backstage":{"$ref":"#/components/schemas/BackstageSettingsResponse","x-stream-index":"002"},"broadcasting":{"$ref":"#/components/schemas/BroadcastSettingsResponse","x-stream-index":"003"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordingSettingsResponse","x-stream-index":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettingsResponse","x-stream-index":"004"},"ingress":{"$ref":"#/components/schemas/IngressSettingsResponse","x-stream-index":"014"},"limits":{"$ref":"#/components/schemas/LimitsSettingsResponse","x-stream-index":"012"},"recording":{"$ref":"#/components/schemas/RecordSettingsResponse","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettingsResponse","x-stream-index":"007"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettingsResponse","x-stream-index":"008"},"session":{"$ref":"#/components/schemas/SessionSettingsResponse","x-stream-index":"013"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettingsResponse","x-stream-index":"011"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettingsResponse","x-stream-index":"009"},"video":{"$ref":"#/components/schemas/VideoSettingsResponse","x-stream-index":"010"}},"required":["audio","backstage","broadcasting","geofencing","recording","frame_recording","ring","screensharing","transcription","video","thumbnails","limits","session"],"type":"object"},"CallType":{"properties":{"AppPK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"003"},"CreatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"005"},"ExternalStorage":{"type":"string","writeOnly":true,"x-stream-index":"009"},"Name":{"type":"string","writeOnly":true,"x-stream-index":"004"},"NotificationSettings":{"$ref":"#/components/schemas/NotificationSettings","x-stream-index":"008"},"PK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"002"},"Settings":{"$ref":"#/components/schemas/CallSettings","x-stream-index":"007"},"UpdatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"006"}},"required":["PK","AppPK","Name","CreatedAt","UpdatedAt","ExternalStorage"],"type":"object"},"Channel":{"properties":{"active_live_locations":{"items":{"$ref":"#/components/schemas/SharedLocation"},"type":"array","x-stream-index":"034"},"auto_translation_enabled":{"type":"boolean","x-stream-index":"029"},"auto_translation_language":{"type":"string","x-stream-index":"030"},"cid":{"type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/ChannelConfig","x-stream-index":"026"},"config_overrides":{"$ref":"#/components/schemas/ConfigOverrides","x-stream-index":"027"},"cooldown":{"format":"int32","type":"integer","x-stream-index":"031"},"created_at":{"format":"date-time","type":"number","x-stream-index":"009"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"019"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"disabled":{"type":"boolean","x-stream-index":"017"},"frozen":{"type":"boolean","x-stream-index":"016"},"id":{"type":"string","x-stream-index":"004"},"invites":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"022"},"last_campaigns":{"type":"string","x-stream-index":"032"},"last_message_at":{"format":"date-time","type":"number","x-stream-index":"006"},"member_count":{"format":"int32","type":"integer","x-stream-index":"021"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"020"},"team":{"type":"string","x-stream-index":"028"},"truncated_by":{"$ref":"#/components/schemas/User","x-stream-index":"015"},"type":{"type":"string","x-stream-index":"005"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"010"}},"required":["cid","id","type","created_at","updated_at","frozen","disabled","custom","auto_translation_language"],"type":"object"},"ChannelConfig":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.026"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.021"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.022"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.027"},"blocklist":{"type":"string","x-stream-index":"001.023"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.024"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.025"},"commands":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"connect_events":{"type":"boolean","x-stream-index":"001.004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"custom_events":{"type":"boolean","x-stream-index":"001.012"},"mark_messages_pending":{"type":"boolean","x-stream-index":"001.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"001.020"},"mutes":{"type":"boolean","x-stream-index":"001.009"},"name":{"type":"string","x-stream-index":"001.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"001.028"},"partition_ttl":{"type":"integer","x-stream-index":"001.029"},"polls":{"type":"boolean","x-stream-index":"001.016"},"push_notifications":{"type":"boolean","x-stream-index":"001.013"},"quotes":{"type":"boolean","x-stream-index":"001.008"},"reactions":{"type":"boolean","x-stream-index":"001.006"},"read_events":{"type":"boolean","x-stream-index":"001.003"},"reminders":{"type":"boolean","x-stream-index":"001.014"},"replies":{"type":"boolean","x-stream-index":"001.007"},"search":{"type":"boolean","x-stream-index":"001.005"},"shared_locations":{"type":"boolean","x-stream-index":"001.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.030"},"typing_events":{"type":"boolean","x-stream-index":"001.002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"002.004"},"uploads":{"type":"boolean","x-stream-index":"001.010"},"url_enrichment":{"type":"boolean","x-stream-index":"001.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"001.017"}},"required":["name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","created_at","updated_at","commands"],"type":"object"},"ChannelConfigWithInfo":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.002.026"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.002.021"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.022"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.002.027"},"blocklist":{"type":"string","x-stream-index":"001.002.023"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.024"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.002.025"},"commands":{"items":{"$ref":"#/components/schemas/Command"},"type":"array","x-stream-index":"001.003"},"connect_events":{"type":"boolean","x-stream-index":"001.002.004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.001.003"},"custom_events":{"type":"boolean","x-stream-index":"001.002.012"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"002"},"mark_messages_pending":{"type":"boolean","x-stream-index":"001.002.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"001.002.020"},"mutes":{"type":"boolean","x-stream-index":"001.002.009"},"name":{"type":"string","x-stream-index":"001.002.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"001.002.028"},"partition_ttl":{"type":"integer","x-stream-index":"001.002.029"},"polls":{"type":"boolean","x-stream-index":"001.002.016"},"push_notifications":{"type":"boolean","x-stream-index":"001.002.013"},"quotes":{"type":"boolean","x-stream-index":"001.002.008"},"reactions":{"type":"boolean","x-stream-index":"001.002.006"},"read_events":{"type":"boolean","x-stream-index":"001.002.003"},"reminders":{"type":"boolean","x-stream-index":"001.002.014"},"replies":{"type":"boolean","x-stream-index":"001.002.007"},"search":{"type":"boolean","x-stream-index":"001.002.005"},"shared_locations":{"type":"boolean","x-stream-index":"001.002.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.002.030"},"typing_events":{"type":"boolean","x-stream-index":"001.002.002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"uploads":{"type":"boolean","x-stream-index":"001.002.010"},"url_enrichment":{"type":"boolean","x-stream-index":"001.002.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"001.002.017"}},"required":["created_at","updated_at","name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","commands"],"type":"object"},"ChannelMember":{"nullable":true,"properties":{"archived_at":{"format":"date-time","type":"number","x-stream-index":"021"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"017"},"banned":{"type":"boolean","x-stream-index":"016"},"channel_role":{"type":"string","x-stream-index":"024"},"created_at":{"format":"date-time","type":"number","x-stream-index":"012"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"014"},"invite_accepted_at":{"format":"date-time","type":"number","x-stream-index":"009"},"invite_rejected_at":{"format":"date-time","type":"number","x-stream-index":"010"},"invited":{"type":"boolean","x-stream-index":"008"},"is_global_banned":{"type":"boolean","x-stream-index":"020"},"is_moderator":{"type":"boolean","x-stream-index":"007"},"notifications_muted":{"type":"boolean","x-stream-index":"026"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"022"},"shadow_banned":{"type":"boolean","x-stream-index":"019"},"status":{"type":"string","x-stream-index":"011"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"013"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["custom","created_at","updated_at","banned","shadow_banned","is_global_banned","channel_role","notifications_muted"],"type":"object"},"ChannelMute":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"007"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"expires":{"description":"Date/time of mute expiration","format":"date-time","title":"Expires","type":"number","x-stream-index":"008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/User","description":"Owner of channel mute","title":"User","x-stream-index":"005"}},"required":["created_at","updated_at"],"type":"object"},"ChannelResponse":{"properties":{"auto_translation_enabled":{"type":"boolean","x-stream-index":"021"},"auto_translation_language":{"type":"string","x-stream-index":"022"},"blocked":{"type":"boolean","x-stream-index":"027"},"cid":{"type":"string","x-stream-index":"005"},"config":{"$ref":"#/components/schemas/ChannelConfigWithInfo","x-stream-index":"017"},"cooldown":{"format":"int32","type":"integer","x-stream-index":"024"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"011"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"030"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"010"},"disabled":{"type":"boolean","x-stream-index":"013"},"frozen":{"type":"boolean","x-stream-index":"012"},"hidden":{"type":"boolean","x-stream-index":"026"},"hide_messages_before":{"format":"date-time","type":"number","x-stream-index":"023"},"id":{"type":"string","x-stream-index":"003"},"last_message_at":{"format":"date-time","type":"number","x-stream-index":"006"},"member_count":{"format":"int32","type":"integer","x-stream-index":"015"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"014"},"mute_expires_at":{"format":"date-time","type":"number","x-stream-index":"019"},"muted":{"type":"boolean","x-stream-index":"018"},"own_capabilities":{"items":{"type":"string"},"type":"array","x-stream-index":"025"},"team":{"type":"string","x-stream-index":"020"},"truncated_at":{"format":"date-time","type":"number","x-stream-index":"028"},"truncated_by":{"$ref":"#/components/schemas/User","x-stream-index":"029"},"type":{"type":"string","x-stream-index":"004"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"}},"required":["id","type","cid","created_at","updated_at","frozen","disabled","custom"],"type":"object"},"CheckRequest":{"nullable":true,"properties":{"config_key":{"description":"Key of the moderation configuration to use","title":"Config Key","type":"string","x-stream-index":"005"},"config_team":{"description":"Team associated with the configuration","title":"Config Team","type":"string","x-stream-index":"006"},"entity_creator_id":{"description":"ID of the user who created the entity","title":"Entity Creator ID","type":"string","x-stream-index":"003"},"entity_id":{"description":"Unique identifier of the entity to moderate","title":"Entity ID","type":"string","x-stream-index":"002"},"entity_type":{"description":"Type of entity to moderate","title":"Entity Type","type":"string","x-stream-index":"001"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content to be moderated","title":"Moderation Payload","x-stream-index":"004"},"options":{"additionalProperties":{},"description":"Additional moderation configuration options","title":"Options","type":"object","x-stream-index":"007"},"test_mode":{"description":"Whether to run moderation in test mode","title":"Test Mode","type":"boolean","x-stream-index":"008"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"009.002"},"user_id":{"type":"string","x-stream-index":"009.001"}},"required":["entity_type","entity_id","entity_creator_id","config_key"],"type":"object"},"CheckResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"005.001"},"item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"Review queue item (present if action != keep)","title":"Item","x-stream-index":"004"},"recommended_action":{"description":"Suggested action based on moderation results","title":"Recommended Action","type":"string","x-stream-index":"003"},"status":{"description":"Status of the moderation check (completed or pending)","title":"Status","type":"string","x-stream-index":"001"},"task_id":{"description":"ID of the running moderation task","title":"Task ID","type":"string","x-stream-index":"002"}},"required":["status","recommended_action","duration"],"type":"object"},"Command":{"description":"Represents custom chat command","nullable":true,"properties":{"args":{"description":"Arguments help text, shown in commands auto-completion","title":"Arguments","type":"string","x-stream-index":"006"},"created_at":{"description":"Date/time of creation","format":"date-time","readOnly":true,"title":"Created at","type":"number","x-stream-index":"001"},"description":{"description":"Description, shown in commands auto-completion","title":"Description","type":"string","x-stream-index":"005"},"name":{"description":"Unique command name","title":"Name","type":"string","x-stream-index":"004"},"set":{"description":"Set name used for grouping commands","title":"Set","type":"string","x-stream-index":"007"},"updated_at":{"description":"Date/time of the last update","format":"date-time","readOnly":true,"title":"Updated at","type":"number","x-stream-index":"002"}},"required":["name","description","args","set"],"title":"Command","type":"object"},"CompositeAppSettings":{"properties":{"json_encoded_settings":{"type":"string","x-stream-index":"005"},"url":{"type":"string","x-stream-index":"004"}},"type":"object"},"ConfigOverrides":{"properties":{"blocklist":{"type":"string","x-stream-index":"008"},"blocklist_behavior":{"enum":["flag","block"],"type":"string","x-stream-index":"009"},"commands":{"items":{"type":"string"},"type":"array","x-stream-index":"011"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"010"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"007"},"quotes":{"type":"boolean","x-stream-index":"004"},"reactions":{"type":"boolean","x-stream-index":"002"},"replies":{"type":"boolean","x-stream-index":"003"},"shared_locations":{"type":"boolean","x-stream-index":"013"},"typing_events":{"type":"boolean","x-stream-index":"001"},"uploads":{"type":"boolean","x-stream-index":"005"},"url_enrichment":{"type":"boolean","x-stream-index":"006"},"user_message_reminders":{"type":"boolean","x-stream-index":"012"}},"required":["grants","commands"],"type":"object"},"ConfigResponse":{"properties":{"ai_image_config":{"$ref":"#/components/schemas/AIImageConfig","description":"Configuration for AI image analysis","title":"AI Image Config","x-stream-index":"009"},"ai_text_config":{"$ref":"#/components/schemas/AITextConfig","description":"Configuration for AI text analysis","title":"AI Text Config","x-stream-index":"008"},"ai_video_config":{"$ref":"#/components/schemas/AIVideoConfig","description":"Configuration for AI video analysis","title":"AI Video Config","x-stream-index":"010"},"async":{"description":"Whether moderation should be performed asynchronously","title":"Async","type":"boolean","x-stream-index":"003"},"automod_platform_circumvention_config":{"$ref":"#/components/schemas/AutomodPlatformCircumventionConfig","description":"Configuration for platform circumvention detection","title":"Automod Platform Circumvention Config","x-stream-index":"005"},"automod_semantic_filters_config":{"$ref":"#/components/schemas/AutomodSemanticFiltersConfig","description":"Configuration for semantic filtering","title":"Automod Semantic Filters Config","x-stream-index":"006"},"automod_toxicity_config":{"$ref":"#/components/schemas/AutomodToxicityConfig","description":"Configuration for toxicity detection","title":"Automod Toxicity Config","x-stream-index":"004"},"block_list_config":{"$ref":"#/components/schemas/BlockListConfig","description":"Configuration for block list filtering","title":"Block List Config","x-stream-index":"007"},"created_at":{"description":"When the configuration was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"012"},"key":{"description":"Unique identifier for the moderation configuration","title":"Key","type":"string","x-stream-index":"001"},"rule_builder_config":{"$ref":"#/components/schemas/RuleBuilderConfig","x-stream-index":"015"},"team":{"description":"Team associated with the configuration","title":"Team","type":"string","x-stream-index":"002"},"updated_at":{"description":"When the configuration was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"013"},"velocity_filter_config":{"$ref":"#/components/schemas/VelocityFilterConfig","description":"Configuration for velocity-based filtering","title":"Velocity Filter Config","x-stream-index":"011"},"video_call_rule_config":{"$ref":"#/components/schemas/VideoCallRuleConfig","x-stream-index":"014"}},"required":["key","team","async","created_at","updated_at"],"type":"object"},"ContentCountRuleParameters":{"properties":{"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"required":["threshold","time_window"],"type":"object"},"CustomActionRequest":{"properties":{"id":{"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"type":"object"},"CustomCheckFlag":{"properties":{"custom":{"additionalProperties":{},"description":"Additional metadata for the flag","title":"Custom","type":"object","x-stream-index":"003"},"labels":{"description":"Labels from various moderation sources","items":{"type":"string"},"title":"Labels","type":"array","x-stream-index":"004"},"reason":{"description":"Optional explanation for the flag","title":"Reason","type":"string","x-stream-index":"002"},"type":{"description":"Type of check (custom_check_text, custom_check_image, custom_check_video)","maxLength":255,"title":"Type","type":"string","x-stream-index":"001"}},"required":["type"],"type":"object"},"CustomCheckRequest":{"nullable":true,"properties":{"entity_creator_id":{"description":"ID of the user who created the entity (required for non-message entities)","title":"Entity Creator ID","type":"string","x-stream-index":"003"},"entity_id":{"description":"Unique identifier of the entity","title":"Entity ID","type":"string","x-stream-index":"002"},"entity_type":{"description":"Type of entity to perform custom check on","title":"Entity Type","type":"string","x-stream-index":"001"},"flags":{"description":"List of custom check flags (1-10 flags required)","items":{"$ref":"#/components/schemas/CustomCheckFlag"},"maximum":10,"minimum":1,"title":"Flags","type":"array","x-stream-index":"005"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content to be checked (required for non-message entities)","title":"Moderation Payload","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"006.002"},"user_id":{"type":"string","x-stream-index":"006.001"}},"required":["entity_type","entity_id","flags"],"type":"object"},"CustomCheckResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"004.001"},"id":{"description":"Unique identifier of the custom check","title":"ID","type":"string","x-stream-index":"001"},"item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"Review queue item details","title":"Item","x-stream-index":"002"},"status":{"description":"Status of the custom check","title":"Status","type":"string","x-stream-index":"003"}},"required":["id","status","duration"],"type":"object"},"Data":{"properties":{"id":{"type":"string","x-stream-index":"001"}},"required":["id"],"type":"object"},"DeleteActivityRequest":{"properties":{"hard_delete":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"DeleteMessageRequest":{"properties":{"hard_delete":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"DeleteModerationConfigResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"DeleteModerationTemplateResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"DeleteReactionRequest":{"properties":{"hard_delete":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"DeleteUserRequest":{"properties":{"delete_conversation_channels":{"type":"boolean","x-stream-index":"003"},"delete_feeds_content":{"type":"boolean","x-stream-index":"004"},"hard_delete":{"type":"boolean","x-stream-index":"001"},"mark_messages_deleted":{"type":"boolean","x-stream-index":"002"}},"type":"object"},"Device":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"disabled":{"type":"boolean","x-stream-index":"002.003"},"disabled_reason":{"type":"string","x-stream-index":"002.004"},"id":{"type":"string","x-stream-index":"002.001.004"},"push_provider":{"enum":["firebase","apn","huawei","xiaomi"],"type":"string","x-stream-index":"002.001.001"},"push_provider_name":{"type":"string","x-stream-index":"002.001.003"},"user_id":{"type":"string","x-stream-index":"004"},"voip":{"type":"boolean","x-stream-index":"002.001.005"}},"required":["push_provider","id","created_at","user_id"],"type":"object"},"DeviceResponse":{"description":"Response for Device","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"004"},"disabled":{"description":"Whether device is disabled or not","title":"Disabled","type":"boolean","x-stream-index":"005"},"disabled_reason":{"description":"Reason explaining why device had been disabled","title":"Reason","type":"string","x-stream-index":"006"},"id":{"description":"Device ID","title":"ID","type":"string","x-stream-index":"003"},"push_provider":{"description":"Push provider","title":"PushProvider","type":"string","x-stream-index":"001"},"push_provider_name":{"description":"Push provider name","title":"PushProviderName","type":"string","x-stream-index":"002"},"user_id":{"description":"User ID","title":"UserID","type":"string","x-stream-index":"008"},"voip":{"description":"When true the token is for Apple VoIP push notifications","title":"Voip","type":"boolean","x-stream-index":"007"}},"required":["push_provider","id","created_at","user_id"],"title":"DeviceResponse","type":"object"},"DraftPayloadResponse":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"html":{"type":"string","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"001"},"mentioned_users":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"008"},"mml":{"type":"string","x-stream-index":"003"},"parent_id":{"type":"string","x-stream-index":"005"},"poll_id":{"type":"string","x-stream-index":"013"},"quoted_message_id":{"type":"string","x-stream-index":"009"},"show_in_channel":{"type":"boolean","x-stream-index":"006"},"silent":{"type":"boolean","x-stream-index":"012"},"text":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"011"}},"required":["id","text","custom"],"type":"object"},"DraftResponse":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003"},"channel_cid":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"message":{"$ref":"#/components/schemas/DraftPayloadResponse","x-stream-index":"001"},"parent_id":{"type":"string","x-stream-index":"004"},"parent_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"005"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"006"}},"required":["message","channel_cid","created_at"],"type":"object"},"EgressHLSResponse":{"properties":{"playlist_url":{"type":"string","x-stream-index":"001"},"status":{"type":"string","x-stream-index":"002"}},"required":["playlist_url","status"],"type":"object"},"EgressRTMPResponse":{"properties":{"name":{"type":"string","x-stream-index":"001"},"started_at":{"format":"date-time","type":"number","x-stream-index":"004"},"stream_key":{"type":"string","x-stream-index":"003"},"stream_url":{"type":"string","x-stream-index":"002"}},"required":["name","started_at"],"type":"object"},"EgressResponse":{"properties":{"broadcasting":{"type":"boolean","x-stream-index":"001"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordingResponse","x-stream-index":"004"},"hls":{"$ref":"#/components/schemas/EgressHLSResponse","x-stream-index":"002"},"rtmps":{"items":{"$ref":"#/components/schemas/EgressRTMPResponse"},"type":"array","x-stream-index":"003"}},"required":["broadcasting","rtmps"],"type":"object"},"EgressTaskConfig":{"properties":{"egress_user":{"$ref":"#/components/schemas/EgressUser","x-stream-index":"008"},"frame_recording_egress_config":{"$ref":"#/components/schemas/FrameRecordingEgressConfig","x-stream-index":"009"},"hls_egress_config":{"$ref":"#/components/schemas/HLSEgressConfig","x-stream-index":"007"},"recording_egress_config":{"$ref":"#/components/schemas/RecordingEgressConfig","x-stream-index":"006"},"rtmp_egress_config":{"$ref":"#/components/schemas/RTMPEgressConfig","x-stream-index":"004"},"stt_egress_config":{"$ref":"#/components/schemas/STTEgressConfig","x-stream-index":"005"}},"type":"object"},"EgressUser":{"properties":{"token":{"type":"string","x-stream-index":"004"}},"type":"object"},"EnrichedActivity":{"properties":{"actor":{"$ref":"#/components/schemas/Data","x-stream-index":"002"},"foreign_id":{"type":"string","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"latest_reactions":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"013"},"object":{"$ref":"#/components/schemas/Data","x-stream-index":"004"},"origin":{"$ref":"#/components/schemas/Data","x-stream-index":"008"},"own_reactions":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"012"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"011"},"score":{"format":"float","type":"number","x-stream-index":"010"},"target":{"$ref":"#/components/schemas/Data","x-stream-index":"006"},"to":{"items":{"type":"string"},"type":"array","x-stream-index":"009"},"verb":{"type":"string","x-stream-index":"003"}},"type":"object"},"EnrichedReaction":{"nullable":true,"properties":{"activity_id":{"type":"string","x-stream-index":"003"},"children_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"010"},"created_at":{"$ref":"#/components/schemas/Time","x-stream-index":"012"},"data":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"kind":{"type":"string","x-stream-index":"002"},"latest_children":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"008"},"own_children":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"009"},"parent":{"type":"string","x-stream-index":"007"},"target_feeds":{"items":{"type":"string"},"type":"array","x-stream-index":"006"},"updated_at":{"$ref":"#/components/schemas/Time","x-stream-index":"013"},"user":{"$ref":"#/components/schemas/Data","x-stream-index":"011"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["kind","activity_id","user_id"],"type":"object"},"EntityCreator":{"properties":{"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"001.046"},"ban_count":{"format":"int32","type":"integer","x-stream-index":"002"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"001.017"},"banned":{"type":"boolean","x-stream-index":"001.016"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.013"},"deleted_content_count":{"format":"int32","type":"integer","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"001.023"},"language":{"type":"string","x-stream-index":"001.035"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"001.022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"001.026"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.042"},"role":{"type":"string","x-stream-index":"001.004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.005"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.009"}},"required":["id","role","teams_role","custom","banned","online","ban_count","deleted_content_count"],"type":"object"},"EntityCreatorResponse":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.001.018"},"ban_count":{"description":"Number of minor actions performed on the user","format":"int32","title":"Ban Count","type":"integer","x-stream-index":"002"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"001.003"},"banned":{"type":"boolean","x-stream-index":"001.001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.001.017"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.001.016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.001.011"},"deleted_content_count":{"description":"Number of major actions performed on the user","format":"int32","title":"Deleted Content Count","type":"integer","x-stream-index":"003"},"devices":{"items":{"$ref":"#/components/schemas/DeviceResponse"},"type":"array","x-stream-index":"001.006"},"flagged_count":{"description":"Number of flag actions performed on the user","format":"int32","title":"Flagged Count","type":"integer","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001.001.001"},"image":{"type":"string","x-stream-index":"001.001.003"},"invisible":{"type":"boolean","x-stream-index":"001.007"},"language":{"type":"string","x-stream-index":"001.001.005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"001.001.014"},"name":{"type":"string","x-stream-index":"001.001.002"},"online":{"type":"boolean","x-stream-index":"001.001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"001.005"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettingsResponse","x-stream-index":"001.004"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.001.015"},"role":{"type":"string","x-stream-index":"001.001.006"},"shadow_banned":{"type":"boolean","x-stream-index":"001.002"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.001.008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids","shadow_banned","invisible","ban_count","deleted_content_count","flagged_count"],"type":"object"},"EventNotificationSettings":{"properties":{"apns":{"$ref":"#/components/schemas/APNS","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"fcm":{"$ref":"#/components/schemas/FCM","x-stream-index":"003"}},"required":["enabled","apns","fcm"],"type":"object"},"ExternalStorage":{"properties":{"abs_account_name":{"type":"string","x-stream-index":"011"},"abs_client_id":{"type":"string","x-stream-index":"013"},"abs_client_secret":{"type":"string","x-stream-index":"014"},"abs_tenant_id":{"type":"string","x-stream-index":"012"},"bucket":{"type":"string","x-stream-index":"005"},"gcs_credentials":{"type":"string","x-stream-index":"010"},"path":{"type":"string","x-stream-index":"006"},"s3_api_key":{"type":"string","x-stream-index":"007"},"s3_custom_endpoint":{"type":"string","x-stream-index":"016"},"s3_region":{"type":"string","x-stream-index":"009"},"s3_secret_key":{"type":"string","x-stream-index":"008"},"storage_name":{"type":"string","x-stream-index":"015"},"storage_type":{"type":"integer","x-stream-index":"004"}},"type":"object"},"FCM":{"properties":{"data":{"additionalProperties":{},"type":"object","x-stream-index":"001"}},"type":"object"},"FeedsModerationTemplateConfig":{"properties":{"config_key":{"type":"string","x-stream-index":"002"},"data_types":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001"}},"required":["data_types","config_key"],"type":"object"},"Field":{"nullable":true,"properties":{"short":{"type":"boolean","x-stream-index":"003"},"title":{"type":"string","x-stream-index":"001"},"value":{"type":"string","x-stream-index":"002"}},"required":["title","value","short"],"type":"object"},"Flag":{"description":"Contains information about flagged user or message","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"019"},"custom":{"additionalProperties":{},"description":"Additional metadata about the flag","title":"Custom","type":"object","x-stream-index":"014"},"entity_creator_id":{"description":"ID of the user who created the flagged entity","title":"Entity Creator ID","type":"string","x-stream-index":"009"},"entity_id":{"description":"Unique identifier of the entity being flagged","title":"Entity ID","type":"string","x-stream-index":"008"},"entity_type":{"description":"Type of entity being flagged (e.g., message, user)","title":"Entity Type","type":"string","x-stream-index":"007"},"is_streamed_content":{"type":"boolean","x-stream-index":"012"},"labels":{"description":"Labels from bodyguard, API calls, our own AI etc","items":{"type":"string"},"title":"Labels","type":"array","x-stream-index":"015"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content being flagged","title":"Moderation Payload","x-stream-index":"010"},"moderation_payload_hash":{"type":"string","x-stream-index":"011"},"reason":{"description":"Optional explanation for why the content is being flagged","title":"Reason","type":"string","x-stream-index":"013"},"result":{"description":"Result of bodyguard, API calls, our own AI etc","items":{"additionalProperties":{},"type":"object"},"title":"Result","type":"array","x-stream-index":"016"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"018"},"review_queue_item_id":{"description":"ID of the review queue item","title":"Review Queue Item ID","type":"string","x-stream-index":"017"},"type":{"type":"string","x-stream-index":"004"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"020"},"user":{"$ref":"#/components/schemas/User","description":"User who flagged a message or a user","title":"User","x-stream-index":"006"}},"required":["entity_type","entity_id","result","created_at","updated_at"],"title":"Flag","type":"object"},"FlagContentOptions":{"properties":{"reason":{"type":"string","x-stream-index":"001"}},"required":["reason"],"type":"object"},"FlagRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"description":"Additional metadata about the flag","title":"Custom","type":"object","x-stream-index":"006"},"entity_creator_id":{"description":"ID of the user who created the flagged entity","title":"Entity Creator ID","type":"string","x-stream-index":"003"},"entity_id":{"description":"Unique identifier of the entity being flagged","title":"Entity ID","type":"string","x-stream-index":"002"},"entity_type":{"description":"Type of entity being flagged (e.g., message, user)","title":"Entity Type","type":"string","x-stream-index":"001"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content being flagged","title":"Moderation Payload","x-stream-index":"005"},"reason":{"description":"Optional explanation for why the content is being flagged","maxLength":255,"title":"Reason","type":"string","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"007.002"},"user_id":{"type":"string","x-stream-index":"007.001"}},"required":["entity_type","entity_id"],"type":"object"},"FlagResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"item_id":{"description":"Unique identifier of the created moderation item","title":"Item ID","type":"string","x-stream-index":"001"}},"required":["item_id","duration"],"type":"object"},"FlagUserOptions":{"properties":{"reason":{"type":"string","x-stream-index":"001"}},"required":["reason"],"type":"object"},"FrameRecordSettings":{"properties":{"capture_interval_in_seconds":{"format":"int32","maximum":60,"minimum":2,"type":"integer","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"},"quality":{"type":"string","x-stream-index":"002"}},"required":["mode","capture_interval_in_seconds"],"type":"object"},"FrameRecordingEgressConfig":{"properties":{"capture_interval_in_seconds":{"format":"int32","type":"integer","x-stream-index":"007"},"external_storage":{"$ref":"#/components/schemas/ExternalStorage","x-stream-index":"006"},"quality":{"$ref":"#/components/schemas/Quality","x-stream-index":"004"},"storage_name":{"type":"string","x-stream-index":"005"}},"type":"object"},"FrameRecordingResponse":{"properties":{"status":{"type":"string","x-stream-index":"001"}},"required":["status"],"type":"object"},"FrameRecordingSettingsResponse":{"properties":{"capture_interval_in_seconds":{"format":"int32","maximum":60,"minimum":2,"type":"integer","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"},"quality":{"type":"string","x-stream-index":"002"}},"required":["mode","capture_interval_in_seconds"],"type":"object"},"GeofenceSettings":{"properties":{"names":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"required":["names"],"type":"object"},"GeofenceSettingsResponse":{"properties":{"names":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"required":["names"],"type":"object"},"GetConfigResponse":{"nullable":true,"properties":{"config":{"$ref":"#/components/schemas/ConfigResponse","description":"The retrieved moderation configuration","title":"Config","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["duration"],"type":"object"},"GetReviewQueueItemResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"Current state of the review queue item","title":"Item","x-stream-index":"001"}},"required":["duration"],"type":"object"},"GoogleVisionConfig":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"HLSEgressConfig":{"properties":{"composite_app_settings":{"$ref":"#/components/schemas/CompositeAppSettings","x-stream-index":"005"},"playlist_url":{"type":"string","x-stream-index":"007"},"qualities":{"items":{"$ref":"#/components/schemas/Quality"},"type":"array","x-stream-index":"004"},"start_unix_nano":{"format":"int64","type":"integer","x-stream-index":"006"}},"type":"object"},"HLSSettings":{"properties":{"auto_on":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"004"},"quality_tracks":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"required":["auto_on","enabled","quality_tracks"],"type":"object"},"HLSSettingsResponse":{"description":"HLSSettings is the payload for HLS settings","properties":{"auto_on":{"title":"Auto On","type":"boolean","x-stream-index":"001"},"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"002"},"layout":{"$ref":"#/components/schemas/LayoutSettingsResponse","title":"Layout","x-stream-index":"004"},"quality_tracks":{"items":{"type":"string"},"title":"Quality Tracks","type":"array","x-stream-index":"003"}},"required":["auto_on","enabled","quality_tracks","layout"],"title":"HLSSettingsResponse","type":"object"},"HarmConfig":{"properties":{"action_sequences":{"items":{"$ref":"#/components/schemas/ActionSequence"},"type":"array","x-stream-index":"001"},"severity":{"type":"integer","x-stream-index":"002"}},"required":["action_sequences","severity"],"type":"object"},"ImageContentParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"type":"object"},"ImageData":{"properties":{"frames":{"type":"string","x-stream-index":"005"},"height":{"type":"string","x-stream-index":"003"},"size":{"type":"string","x-stream-index":"004"},"url":{"type":"string","x-stream-index":"001"},"width":{"type":"string","x-stream-index":"002"}},"required":["url","width","height","size","frames"],"type":"object"},"ImageRuleParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"required":["threshold","time_window"],"type":"object"},"Images":{"properties":{"fixed_height":{"$ref":"#/components/schemas/ImageData","x-stream-index":"002"},"fixed_height_downsampled":{"$ref":"#/components/schemas/ImageData","x-stream-index":"004"},"fixed_height_still":{"$ref":"#/components/schemas/ImageData","x-stream-index":"003"},"fixed_width":{"$ref":"#/components/schemas/ImageData","x-stream-index":"005"},"fixed_width_downsampled":{"$ref":"#/components/schemas/ImageData","x-stream-index":"007"},"fixed_width_still":{"$ref":"#/components/schemas/ImageData","x-stream-index":"006"},"original":{"$ref":"#/components/schemas/ImageData","x-stream-index":"001"}},"required":["original","fixed_height","fixed_height_still","fixed_height_downsampled","fixed_width","fixed_width_still","fixed_width_downsampled"],"type":"object"},"IngressAudioEncodingOptions":{"properties":{"bitrate":{"maximum":128000,"minimum":16000,"type":"integer","x-stream-index":"003"},"channels":{"enum":["1","2"],"format":"int32","type":"integer","x-stream-index":"001"},"enable_dtx":{"type":"boolean","x-stream-index":"002"}},"required":["channels","enable_dtx","bitrate"],"type":"object"},"IngressAudioEncodingResponse":{"properties":{"bitrate":{"format":"int32","type":"integer","x-stream-index":"003"},"channels":{"format":"int32","type":"integer","x-stream-index":"001"},"enable_dtx":{"type":"boolean","x-stream-index":"002"}},"required":["channels","enable_dtx","bitrate"],"type":"object"},"IngressSettings":{"properties":{"audio_encoding_options":{"$ref":"#/components/schemas/IngressAudioEncodingOptions","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"video_encoding_options":{"additionalProperties":{"$ref":"#/components/schemas/IngressVideoEncodingOptions"},"type":"object","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"IngressSettingsResponse":{"properties":{"audio_encoding_options":{"$ref":"#/components/schemas/IngressAudioEncodingResponse","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"video_encoding_options":{"additionalProperties":{"$ref":"#/components/schemas/IngressVideoEncodingResponse"},"type":"object","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"IngressVideoEncodingOptions":{"properties":{"layers":{"items":{"$ref":"#/components/schemas/IngressVideoLayer"},"minimum":1,"type":"array","x-stream-index":"001"}},"required":["layers"],"type":"object"},"IngressVideoEncodingResponse":{"properties":{"layers":{"items":{"$ref":"#/components/schemas/IngressVideoLayerResponse"},"type":"array","x-stream-index":"001"}},"required":["layers"],"type":"object"},"IngressVideoLayer":{"nullable":true,"properties":{"bitrate":{"minimum":1000,"type":"integer","x-stream-index":"002"},"codec":{"enum":["h264","vp8"],"type":"string","x-stream-index":"001"},"frame_rate":{"maximum":60,"minimum":1,"type":"integer","x-stream-index":"003"},"max_dimension":{"minimum":240,"type":"integer","x-stream-index":"005"},"min_dimension":{"minimum":240,"type":"integer","x-stream-index":"004"}},"required":["codec","bitrate","frame_rate","min_dimension","max_dimension"],"type":"object"},"IngressVideoLayerResponse":{"nullable":true,"properties":{"bitrate":{"type":"integer","x-stream-index":"002"},"codec":{"type":"string","x-stream-index":"001"},"frame_rate_limit":{"type":"integer","x-stream-index":"005"},"max_dimension":{"type":"integer","x-stream-index":"004"},"min_dimension":{"type":"integer","x-stream-index":"003"}},"required":["codec","bitrate","min_dimension","max_dimension","frame_rate_limit"],"type":"object"},"LabelThresholds":{"properties":{"block":{"format":"float","maximum":1,"minimum":0,"type":"number","x-stream-index":"002"},"flag":{"format":"float","maximum":1,"minimum":0,"type":"number","x-stream-index":"001"}},"type":"object"},"LayoutSettings":{"properties":{"detect_orientation":{"type":"boolean","x-stream-index":"005"},"external_app_url":{"type":"string","x-stream-index":"003"},"external_css_url":{"type":"string","x-stream-index":"004"},"name":{"enum":["spotlight","grid","single-participant","mobile","custom"],"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"required":["name","external_app_url","external_css_url"],"type":"object"},"LayoutSettingsResponse":{"properties":{"detect_orientation":{"type":"boolean","x-stream-index":"005"},"external_app_url":{"type":"string","x-stream-index":"003"},"external_css_url":{"type":"string","x-stream-index":"004"},"name":{"enum":["spotlight","grid","single-participant","mobile","custom"],"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"required":["name","external_app_url","external_css_url"],"type":"object"},"LimitsSettings":{"properties":{"max_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"004"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"},"max_participants_exclude_owner":{"type":"boolean","x-stream-index":"003"},"max_participants_exclude_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"002"}},"required":["max_participants_exclude_roles"],"type":"object"},"LimitsSettingsResponse":{"properties":{"max_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"004"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"},"max_participants_exclude_owner":{"type":"boolean","x-stream-index":"003"},"max_participants_exclude_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"002"}},"required":["max_participants_exclude_roles"],"type":"object"},"MarkReviewedRequest":{"properties":{"content_to_mark_as_reviewed_limit":{"format":"int32","maximum":2500,"type":"integer","x-stream-index":"002"},"disable_marking_content_as_reviewed":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"MemberLookup":{"properties":{"Limit":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"001"}},"required":["Limit"],"type":"object"},"Message":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"012"},"before_message_send_failed":{"type":"boolean","x-stream-index":"046"},"cid":{"type":"string","x-stream-index":"028"},"command":{"type":"string","x-stream-index":"006"},"created_at":{"format":"date-time","type":"number","x-stream-index":"030"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"034"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"033"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"023"},"html":{"type":"string","x-stream-index":"007"},"i18n":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"044"},"id":{"type":"string","x-stream-index":"002"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"040"},"latest_reactions":{"items":{"$ref":"#/components/schemas/Reaction"},"type":"array","x-stream-index":"013"},"mentioned_users":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"043"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"052"},"mml":{"type":"string","x-stream-index":"005"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"056"},"own_reactions":{"items":{"$ref":"#/components/schemas/Reaction"},"type":"array","x-stream-index":"014"},"parent_id":{"type":"string","x-stream-index":"019"},"pin_expires":{"format":"date-time","type":"number","x-stream-index":"051"},"pinned":{"type":"boolean","x-stream-index":"047"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"048"},"pinned_by":{"$ref":"#/components/schemas/User","x-stream-index":"050"},"poll":{"$ref":"#/components/schemas/Poll","x-stream-index":"054"},"poll_id":{"type":"string","x-stream-index":"053"},"quoted_message":{"$ref":"#/components/schemas/Message","x-stream-index":"025"},"quoted_message_id":{"type":"string","x-stream-index":"024"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"015"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"017"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"016"},"reminder":{"$ref":"#/components/schemas/MessageReminder","x-stream-index":"058"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"022"},"restricted_visibility":{"items":{"type":"string"},"type":"array","x-stream-index":"011"},"shadowed":{"type":"boolean","x-stream-index":"036"},"shared_location":{"$ref":"#/components/schemas/SharedLocation","x-stream-index":"055"},"show_in_channel":{"type":"boolean","x-stream-index":"021"},"silent":{"type":"boolean","x-stream-index":"045"},"text":{"type":"string","x-stream-index":"004"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"027"},"type":{"type":"string","x-stream-index":"008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"031"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"010"}},"required":["id","text","html","type","restricted_visibility","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reaction_groups","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned"],"type":"object"},"MessageReminder":{"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"004"},"channel_cid":{"type":"string","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"011"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"006"},"message_id":{"type":"string","x-stream-index":"005"},"remind_at":{"format":"date-time","type":"number","x-stream-index":"009"},"task_id":{"type":"string","x-stream-index":"010"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"012"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"user_id":{"type":"string","x-stream-index":"007"}},"required":["channel_cid","message_id","user_id","task_id","created_at","updated_at"],"type":"object"},"MessageResponse":{"description":"Represents any chat message","properties":{"attachments":{"description":"Array of message attachments","items":{"$ref":"#/components/schemas/Attachment"},"title":"Message attachments","type":"array","x-stream-docs-page-id":"message_format#attachment-format","x-stream-index":"008"},"cid":{"description":"Channel unique identifier in \u003ctype\u003e:\u003cid\u003e format","title":"Channel CID","type":"string","x-stream-index":"022"},"command":{"description":"Contains provided slash command","title":"Command","type":"string","x-stream-docs-page-id":"custom_commands_webhook","x-stream-index":"004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"023"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"026"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"025"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"018"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"041"},"html":{"description":"Contains HTML markup of the message. Can only be set when using server-side API","title":"HTML content","type":"string","x-stream-index":"005"},"i18n":{"additionalProperties":{"type":"string"},"description":"Object with translations. Key `language` contains the original language key. Other keys contain translations","title":"Internationalization info","type":"object","x-stream-docs-page-id":"translation","x-stream-index":"030"},"id":{"description":"Message ID is unique string identifier of the message","title":"ID","type":"string","x-stream-index":"001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"Contains image moderation information","title":"Image moderation labels","type":"object","x-stream-index":"028"},"latest_reactions":{"description":"List of 10 latest reactions to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Latest reactions","type":"array","x-stream-index":"009"},"mentioned_users":{"description":"List of mentioned users","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Mentioned Users","type":"array","x-stream-index":"029"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"036"},"mml":{"description":"Should be empty if `text` is provided. Can only be set when using server-side API","title":"Messaging Markup Language","type":"string","x-stream-docs-page-id":"mml_overview","x-stream-index":"003"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"039"},"own_reactions":{"description":"List of 10 latest reactions of authenticated user to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Own reactions","type":"array","x-stream-index":"010"},"parent_id":{"description":"ID of parent message (thread)","title":"Parent message ID","type":"string","x-stream-docs-page-id":"threads","x-stream-index":"015"},"pin_expires":{"description":"Date when pinned message expires","format":"date-time","title":"Pin expiration date","type":"number","x-stream-docs-page-id":"pinned_messages","x-stream-index":"035"},"pinned":{"description":"Whether message is pinned or not","title":"Pinned","type":"boolean","x-stream-docs-page-id":"pinned_messages","x-stream-index":"032"},"pinned_at":{"description":"Date when message got pinned","format":"date-time","title":"Pinned at","type":"number","x-stream-docs-page-id":"pinned_messages","x-stream-index":"033"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","description":"Contains user who pinned the message","title":"Pinned by","x-stream-docs-page-id":"pinned_messages","x-stream-index":"034"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"038"},"poll_id":{"description":"Identifier of the poll to include in the message","title":"Poll ID","type":"string","x-stream-index":"037"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","description":"Contains quoted message","title":"Quoted message","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"020"},"quoted_message_id":{"title":"ID of quoted message","type":"string","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"019"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing number of reactions of each type. Key: reaction type (string), value: number of reactions (int)","title":"Reaction counts","type":"object","x-stream-index":"011"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"014"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing scores of reactions of each type. Key: reaction type (string), value: total score of reactions (int)","title":"Reaction scores","type":"object","x-stream-index":"012"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"042"},"reply_count":{"description":"Number of replies to this message","format":"int32","title":"Reply count","type":"integer","x-stream-index":"017"},"restricted_visibility":{"description":"A list of user ids that have restricted visibility to the message, if the list is not empty, the message is only visible to the users in the list","items":{"type":"string"},"title":"Restricted visibility","type":"array","x-stream-index":"040"},"shadowed":{"description":"Whether the message was shadowed or not","title":"Shadowed","type":"boolean","x-stream-docs-page-id":"moderation#shadow-ban","x-stream-index":"027"},"shared_location":{"$ref":"#/components/schemas/SharedLocationResponseData","description":"Contains shared location data","title":"Shared Location","x-stream-index":"043"},"show_in_channel":{"description":"Whether thread reply should be shown in the channel as well","title":"Show in channel","type":"boolean","x-stream-docs-page-id":"threads","x-stream-index":"016"},"silent":{"description":"Whether message is silent or not","title":"Silent","type":"boolean","x-stream-index":"031"},"text":{"description":"Text of the message. Should be empty if `mml` is provided","title":"Text","type":"string","x-stream-index":"002"},"thread_participants":{"description":"List of users who participate in thread","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Thread participants","type":"array","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"021"},"type":{"description":"Contains type of the message","enum":["regular","ephemeral","error","reply","system","deleted"],"title":"Message Type","type":"string","x-stream-docs-page-id":"message_format#message-types","x-stream-index":"006"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"024"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Sender of the message. Required when using server-side API","title":"User object","x-stream-index":"007"}},"required":["id","text","html","type","user","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned","restricted_visibility"],"title":"Message","type":"object","x-stream-docs-page-id":"send_message"},"ModerationActionConfig":{"nullable":true,"properties":{"action":{"type":"string","x-stream-index":"006"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"009"},"description":{"type":"string","x-stream-index":"008"},"entity_type":{"type":"string","x-stream-index":"004"},"icon":{"type":"string","x-stream-index":"007"},"order":{"format":"int32","type":"integer","x-stream-index":"005"}},"required":["entity_type","order","action","icon","description","custom"],"type":"object"},"ModerationCheckCompletedEvent":{"description":"This event is sent when a moderation check is completed","nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"entity_id":{"description":"The ID of entity which was moderated","title":"EntityID","type":"string","x-stream-index":"002"},"entity_type":{"description":"The type of the entity which was moderated","title":"EntityType","type":"string","x-stream-index":"003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"recommended_action":{"description":"The recommended action","title":"RecommendedAction","type":"string","x-stream-index":"004"},"review_queue_item_id":{"description":"The review queue item ID","title":"ReviewQueueItemID","type":"string","x-stream-index":"005"},"type":{"default":"moderation_check.completed","type":"string","x-stream-index":"001.002"}},"required":["type","created_at","custom","entity_id","entity_type","recommended_action","review_queue_item_id"],"title":"ModerationCheckCompletedEvent","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"},"ModerationCustomActionEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"001"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"002"},"type":{"default":"moderation.custom_action","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationCustomActionEvent","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"},"ModerationFlagResponse":{"nullable":true,"properties":{"created_at":{"type":"string","x-stream-index":"014"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"009"},"entity_creator_id":{"type":"string","x-stream-index":"006"},"entity_id":{"type":"string","x-stream-index":"005"},"entity_type":{"type":"string","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001"},"labels":{"items":{"type":"string"},"type":"array","x-stream-index":"010"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"007"},"reason":{"type":"string","x-stream-index":"008"},"result":{"items":{"additionalProperties":{},"type":"object"},"type":"array","x-stream-index":"011"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","x-stream-index":"013"},"review_queue_item_id":{"type":"string","x-stream-index":"012"},"type":{"type":"string","x-stream-index":"002"},"updated_at":{"type":"string","x-stream-index":"015"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"003"}},"required":["id","type","entity_type","entity_id","created_at","updated_at"],"type":"object"},"ModerationFlaggedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"item":{"type":"string","x-stream-index":"001"},"object_id":{"type":"string","x-stream-index":"002"},"type":{"default":"moderation.flagged","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationFlaggedEvent","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"},"ModerationMarkReviewedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"001"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"002"},"type":{"default":"moderation.mark_reviewed","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationMarkReviewedEvent","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"},"ModerationPayload":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"images":{"items":{"type":"string"},"maximum":30,"type":"array","x-stream-index":"002"},"texts":{"items":{"type":"string"},"type":"array","x-stream-index":"001"},"videos":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"type":"object"},"ModerationV2Response":{"properties":{"action":{"type":"string","x-stream-index":"001"},"blocklist_matched":{"type":"string","x-stream-index":"005"},"image_harms":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"original_text":{"type":"string","x-stream-index":"002"},"platform_circumvented":{"type":"boolean","x-stream-index":"007"},"semantic_filter_matched":{"type":"string","x-stream-index":"006"},"text_harms":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"required":["action","original_text"],"type":"object"},"MuteRequest":{"nullable":true,"properties":{"target_ids":{"description":"User IDs to mute (if multiple users)","items":{"type":"string"},"title":"Target IDs","type":"array","x-stream-index":"001"},"timeout":{"description":"Duration of mute in minutes","minimum":0,"title":"Timeout","type":"integer","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"required":["target_ids"],"title":"MuteRequest","type":"object"},"MuteResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"004.001"},"mutes":{"description":"Object with mutes (if multiple users were muted)","items":{"$ref":"#/components/schemas/UserMute"},"title":"Mutes","type":"array","x-stream-index":"001"},"non_existing_users":{"description":"A list of users that can't be found. Common cause for this is deleted users","items":{"type":"string"},"title":"Non Existing Users","type":"array","x-stream-index":"003"},"own_user":{"$ref":"#/components/schemas/OwnUser","description":"Authorized user object with fresh mutes information","title":"Own User","x-stream-index":"002"}},"required":["duration"],"title":"MuteResponse","type":"object"},"NoiseCancellationSettings":{"properties":{"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode"],"type":"object"},"NotificationSettings":{"properties":{"call_live_started":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"002"},"call_missed":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"006"},"call_notification":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"004"},"call_ring":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"session_started":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"003"}},"required":["enabled","call_live_started","session_started","call_notification","call_ring","call_missed"],"type":"object"},"NullTime":{"type":"object"},"OCRRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"}},"required":["label","action"],"type":"object"},"OwnUser":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"046"},"banned":{"type":"boolean","x-stream-index":"016"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"045"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"029"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"014"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"013"},"devices":{"items":{"$ref":"#/components/schemas/Device"},"type":"array","x-stream-index":"027"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"023"},"language":{"type":"string","x-stream-index":"035"},"last_active":{"format":"date-time","type":"number","x-stream-index":"011"},"last_engaged_at":{"format":"date-time","type":"number","x-stream-index":"012"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"037"},"mutes":{"items":{"$ref":"#/components/schemas/UserMute"},"type":"array","x-stream-index":"028"},"online":{"type":"boolean","x-stream-index":"022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"026"},"push_preferences":{"$ref":"#/components/schemas/PushPreferences","x-stream-index":"025"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"005"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"031"},"total_unread_count_by_team":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"032"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"033"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"030"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"034"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"}},"required":["id","role","custom","created_at","updated_at","banned","online","devices","mutes","channel_mutes","unread_count","total_unread_count","total_unread_count_by_team","unread_channels","unread_threads","language"],"type":"object"},"Poll":{"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"023"},"allow_answers":{"type":"boolean","x-stream-index":"010"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"009"},"answers_count":{"format":"int32","type":"integer","x-stream-index":"015"},"created_at":{"format":"date-time","type":"number","x-stream-index":"021"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"020"},"created_by_id":{"type":"string","x-stream-index":"019"},"description":{"type":"string","x-stream-index":"005"},"enforce_unique_vote":{"type":"boolean","x-stream-index":"007"},"id":{"type":"string","x-stream-index":"003"},"is_closed":{"type":"boolean","x-stream-index":"011"},"latest_answers":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array","x-stream-index":"017"},"latest_votes_by_option":{"additionalProperties":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array"},"type":"object","x-stream-index":"016"},"max_votes_allowed":{"format":"int32","type":"integer","x-stream-index":"008"},"name":{"type":"string","x-stream-index":"004"},"options":{"items":{"$ref":"#/components/schemas/PollOption"},"type":"array","x-stream-index":"013"},"own_votes":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array","x-stream-index":"018"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"022"},"vote_count":{"format":"int32","type":"integer","x-stream-index":"012"},"vote_counts_by_option":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"014"},"voting_visibility":{"type":"string","x-stream-index":"006"}},"required":["id","name","description","enforce_unique_vote","allow_user_suggested_options","allow_answers","vote_count","options","vote_counts_by_option","answers_count","latest_votes_by_option","latest_answers","own_votes","created_by_id","created_at","updated_at","Custom"],"type":"object"},"PollOption":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id","text","custom"],"type":"object"},"PollOptionResponseData":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id","text","custom"],"type":"object"},"PollResponseData":{"properties":{"allow_answers":{"type":"boolean","x-stream-index":"008"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"007"},"answers_count":{"format":"int32","type":"integer","x-stream-index":"012"},"created_at":{"format":"date-time","type":"number","x-stream-index":"019"},"created_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"018"},"created_by_id":{"type":"string","x-stream-index":"017"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"021"},"description":{"type":"string","x-stream-index":"003"},"enforce_unique_vote":{"type":"boolean","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"is_closed":{"type":"boolean","x-stream-index":"009"},"latest_answers":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array","x-stream-index":"015"},"latest_votes_by_option":{"additionalProperties":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array"},"type":"object","x-stream-index":"014"},"max_votes_allowed":{"format":"int32","type":"integer","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"002"},"options":{"items":{"$ref":"#/components/schemas/PollOptionResponseData"},"type":"array","x-stream-index":"011"},"own_votes":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array","x-stream-index":"016"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"020"},"vote_count":{"format":"int32","type":"integer","x-stream-index":"010"},"vote_counts_by_option":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"013"},"voting_visibility":{"type":"string","x-stream-index":"004"}},"required":["id","name","description","voting_visibility","enforce_unique_vote","allow_user_suggested_options","allow_answers","vote_count","options","answers_count","vote_counts_by_option","latest_votes_by_option","latest_answers","own_votes","created_by_id","created_at","updated_at","custom"],"type":"object"},"PollVote":{"nullable":true,"properties":{"answer_text":{"type":"string","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"004"},"is_answer":{"type":"boolean","x-stream-index":"006"},"option_id":{"type":"string","x-stream-index":"005"},"poll_id":{"type":"string","x-stream-index":"003"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"011"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"009"},"user_id":{"type":"string","x-stream-index":"008"}},"required":["poll_id","id","option_id","created_at","updated_at"],"type":"object"},"PollVoteResponseData":{"nullable":true,"properties":{"answer_text":{"type":"string","x-stream-index":"005"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"id":{"type":"string","x-stream-index":"002"},"is_answer":{"type":"boolean","x-stream-index":"004"},"option_id":{"type":"string","x-stream-index":"003"},"poll_id":{"type":"string","x-stream-index":"001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"007"},"user_id":{"type":"string","x-stream-index":"006"}},"required":["poll_id","id","option_id","created_at","updated_at"],"type":"object"},"PrivacySettings":{"properties":{"read_receipts":{"$ref":"#/components/schemas/ReadReceipts","x-stream-index":"002"},"typing_indicators":{"$ref":"#/components/schemas/TypingIndicators","x-stream-index":"001"}},"type":"object"},"PrivacySettingsResponse":{"properties":{"read_receipts":{"$ref":"#/components/schemas/ReadReceiptsResponse","x-stream-index":"002"},"typing_indicators":{"$ref":"#/components/schemas/TypingIndicatorsResponse","x-stream-index":"001"}},"type":"object"},"PushNotificationSettingsResponse":{"properties":{"disabled":{"type":"boolean","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"number","x-stream-index":"002"}},"type":"object"},"PushPreferences":{"properties":{"call_level":{"type":"string","x-stream-index":"002"},"chat_level":{"type":"string","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"number","x-stream-index":"003"}},"type":"object"},"Quality":{"properties":{"bitdepth":{"format":"int32","type":"integer","x-stream-index":"007"},"framerate":{"format":"int32","type":"integer","x-stream-index":"008"},"height":{"format":"int32","type":"integer","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"004"},"video_bitrate":{"format":"int32","type":"integer","x-stream-index":"009"},"width":{"format":"int32","type":"integer","x-stream-index":"005"}},"type":"object"},"QueryFeedModerationTemplate":{"properties":{"config":{"$ref":"#/components/schemas/FeedsModerationTemplateConfig","description":"Configuration for the moderation template","title":"Config","x-stream-index":"002"},"created_at":{"description":"When the template was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"003"},"name":{"description":"Name of the moderation template","title":"Name","type":"string","x-stream-index":"001"},"updated_at":{"description":"When the template was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"004"}},"required":["name","created_at","updated_at"],"type":"object"},"QueryFeedModerationTemplatesResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"templates":{"description":"List of moderation templates","items":{"$ref":"#/components/schemas/QueryFeedModerationTemplate"},"title":"Templates","type":"array","x-stream-index":"001"}},"required":["templates","duration"],"type":"object"},"QueryModerationConfigsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter conditions for moderation configs","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"Sorting parameters for the results","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"type":"object"},"QueryModerationConfigsResponse":{"nullable":true,"properties":{"configs":{"description":"List of moderation configurations","items":{"$ref":"#/components/schemas/ConfigResponse"},"title":"Configs","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["configs","duration"],"type":"object"},"QueryModerationFlagsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParam"},"type":"array","x-stream-index":"002"}},"type":"object"},"QueryModerationFlagsResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"flags":{"items":{"$ref":"#/components/schemas/ModerationFlagResponse"},"type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["flags","duration"],"title":"Response","type":"object"},"QueryModerationLogsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter conditions for moderation logs","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"Sorting parameters for the results","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"type":"object"},"QueryModerationLogsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"003.001"},"logs":{"description":"List of moderation action logs","items":{"$ref":"#/components/schemas/ActionLogResponse"},"title":"Logs","type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["logs","duration"],"type":"object"},"QueryReviewQueueRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter conditions for review queue items","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"007.001"},"lock_count":{"description":"Number of items to lock (1-25)","format":"int32","maximum":25,"minimum":1,"title":"Lock Count","type":"integer","x-stream-index":"005"},"lock_duration":{"description":"Duration for which items should be locked","title":"Lock Duration","type":"integer","x-stream-index":"004"},"lock_items":{"description":"Whether to lock items for review (true), unlock items (false), or just fetch (nil)","title":"Lock Items","type":"boolean","x-stream-index":"003"},"next":{"type":"string","x-stream-index":"007.002"},"prev":{"type":"string","x-stream-index":"007.003"},"sort":{"description":"Sorting parameters for the results","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"002"},"stats_only":{"description":"Whether to return only statistics","title":"Stats Only","type":"boolean","x-stream-index":"006"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"008.002"},"user_id":{"type":"string","x-stream-index":"008.001"}},"type":"object"},"QueryReviewQueueResponse":{"nullable":true,"properties":{"action_config":{"additionalProperties":{"items":{"$ref":"#/components/schemas/ModerationActionConfig"},"type":"array"},"description":"Configuration for moderation actions","title":"Action Config","type":"object","x-stream-index":"002"},"duration":{"type":"string","x-stream-index":"005.001"},"items":{"description":"List of review queue items","items":{"$ref":"#/components/schemas/ReviewQueueItemResponse"},"title":"Items","type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"004.001"},"prev":{"type":"string","x-stream-index":"004.002"},"stats":{"additionalProperties":{},"description":"Statistics about the review queue","title":"Stats","type":"object","x-stream-index":"003"}},"required":["items","action_config","stats","duration"],"type":"object"},"RTMPEgressConfig":{"properties":{"composite_app_settings":{"$ref":"#/components/schemas/CompositeAppSettings","x-stream-index":"005"},"quality":{"$ref":"#/components/schemas/Quality","x-stream-index":"004"},"rtmp_location":{"type":"string","x-stream-index":"006"}},"type":"object"},"RTMPIngress":{"description":"RTMP input settings","properties":{"address":{"title":"Address","type":"string","x-stream-index":"001"}},"required":["address"],"title":"RTMPIngress","type":"object"},"RTMPLocation":{"properties":{"name":{"type":"string","x-stream-index":"001"},"stream_key":{"type":"string","x-stream-index":"003"},"stream_url":{"type":"string","x-stream-index":"002"}},"required":["name","stream_url","stream_key"],"type":"object"},"RTMPSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"003"},"location":{"$ref":"#/components/schemas/RTMPLocation","x-stream-index":"004"},"quality_name":{"type":"string","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"RTMPSettingsResponse":{"description":"RTMPSettingsResponse is the payload for RTMP settings","properties":{"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettingsResponse","title":"Layout","x-stream-index":"003"},"quality":{"title":"Quality","type":"string","x-stream-index":"002"}},"required":["enabled","quality","layout"],"title":"RTMPSettingsResponse","type":"object"},"Reaction":{"nullable":true,"properties":{"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"message_id":{"type":"string","x-stream-index":"003"},"score":{"format":"int32","type":"integer","x-stream-index":"007"},"type":{"maxLength":30,"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["message_id","type","score","created_at","updated_at","custom"],"type":"object"},"ReactionGroupResponse":{"description":"ReactionGroupResponse contains all information about a reaction of the same type.","nullable":true,"properties":{"count":{"description":"Count is the number of reactions of this type.","format":"int32","title":"Count","type":"integer","x-stream-index":"001"},"first_reaction_at":{"description":"FirstReactionAt is the time of the first reaction of this type. This is the same also if all reaction of this type are deleted, because if someone will react again with the same type, will be preserved the sorting.","format":"date-time","title":"FirstReactionAt","type":"number","x-stream-index":"003"},"last_reaction_at":{"description":"LastReactionAt is the time of the last reaction of this type.","format":"date-time","title":"LastReactionAt","type":"number","x-stream-index":"004"},"sum_scores":{"description":"SumScores is the sum of all scores of reactions of this type. Medium allows you to clap articles more than once and shows the sum of all claps from all users. For example, you can send `clap` x5 using `score: 5`.","format":"int32","title":"SumScores","type":"integer","x-stream-index":"002"}},"required":["count","sum_scores","first_reaction_at","last_reaction_at"],"title":"ReactionGroupResponse","type":"object"},"ReactionResponse":{"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"006"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"008"},"message_id":{"description":"Message ID","title":"Message ID","type":"string","x-stream-index":"001"},"score":{"description":"Score of the reaction","format":"int32","title":"Score","type":"integer","x-stream-index":"005"},"type":{"description":"Type of reaction","title":"Type","type":"string","x-stream-index":"004"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"007"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User","title":"UserResponse","x-stream-index":"003"},"user_id":{"description":"User ID","title":"User ID","type":"string","x-stream-index":"002"}},"required":["message_id","user_id","user","type","score","created_at","updated_at","custom"],"type":"object"},"ReadReceipts":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"ReadReceiptsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"RecordSettings":{"properties":{"audio_only":{"type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"004"},"mode":{"type":"string","x-stream-index":"002"},"quality":{"type":"string","x-stream-index":"003"}},"required":["mode"],"type":"object"},"RecordSettingsResponse":{"description":"RecordSettings is the payload for recording settings","properties":{"audio_only":{"title":"Audio Only","type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettingsResponse","title":"Layout","x-stream-index":"004"},"mode":{"title":"Mode","type":"string","x-stream-index":"002"},"quality":{"title":"Quality","type":"string","x-stream-index":"003"}},"required":["audio_only","mode","quality","layout"],"title":"RecordSettingsResponse","type":"object"},"RecordingEgressConfig":{"properties":{"audio_only":{"type":"boolean","x-stream-index":"006"},"composite_app_settings":{"$ref":"#/components/schemas/CompositeAppSettings","x-stream-index":"005"},"external_storage":{"$ref":"#/components/schemas/ExternalStorage","x-stream-index":"008"},"quality":{"$ref":"#/components/schemas/Quality","x-stream-index":"004"},"storage_name":{"type":"string","x-stream-index":"007"},"video_orientation_hint":{"$ref":"#/components/schemas/VideoOrientation","x-stream-index":"009"}},"type":"object"},"ReminderResponseData":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003"},"channel_cid":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"005"},"message_id":{"type":"string","x-stream-index":"004"},"remind_at":{"format":"date-time","type":"number","x-stream-index":"001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007"},"user_id":{"type":"string","x-stream-index":"006"}},"required":["channel_cid","message_id","user_id","created_at","updated_at"],"type":"object"},"RestoreActionRequest":{"type":"object"},"ReviewQueueItem":{"properties":{"actions":{"items":{"$ref":"#/components/schemas/ActionLog"},"type":"array","x-stream-index":"035"},"activity":{"$ref":"#/components/schemas/EnrichedActivity","x-stream-index":"028"},"ai_text_severity":{"type":"string","x-stream-index":"021"},"archived_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"043"},"assigned_to":{"$ref":"#/components/schemas/User","x-stream-index":"032"},"bans":{"items":{"$ref":"#/components/schemas/Ban"},"type":"array","x-stream-index":"033"},"bounce_count":{"format":"int32","type":"integer","x-stream-index":"025"},"call":{"$ref":"#/components/schemas/Call","x-stream-index":"031"},"completed_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"018"},"config_key":{"type":"string","x-stream-index":"009"},"content_changed":{"type":"boolean","x-stream-index":"036"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"entity_creator":{"$ref":"#/components/schemas/EntityCreator","x-stream-index":"030"},"entity_id":{"type":"string","x-stream-index":"007"},"entity_type":{"type":"string","x-stream-index":"006"},"feeds_v2_activity":{"$ref":"#/components/schemas/EnrichedActivity","x-stream-index":"041"},"feeds_v2_reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"042"},"flag_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"045"},"flag_types":{"items":{"type":"string"},"type":"array","x-stream-index":"044"},"flags":{"items":{"$ref":"#/components/schemas/Flag"},"type":"array","x-stream-index":"034"},"flags_count":{"format":"int32","type":"integer","x-stream-index":"026"},"has_image":{"type":"boolean","x-stream-index":"012"},"has_text":{"type":"boolean","x-stream-index":"014"},"has_video":{"type":"boolean","x-stream-index":"013"},"id":{"type":"string","x-stream-index":"003"},"languages":{"items":{"type":"string"},"type":"array","x-stream-index":"019"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"027"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"010"},"moderation_payload_hash":{"type":"string","x-stream-index":"011"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"029"},"recommended_action":{"type":"string","x-stream-index":"017"},"reporter_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"046"},"reviewed_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"022"},"reviewed_by":{"type":"string","x-stream-index":"023"},"severity":{"format":"int32","type":"integer","x-stream-index":"020"},"status":{"type":"string","x-stream-index":"016"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"015"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"005"}},"required":["id","created_at","updated_at","entity_type","entity_id","config_key","moderation_payload_hash","has_image","has_video","has_text","teams","status","recommended_action","completed_at","languages","severity","ai_text_severity","reviewed_at","reviewed_by","bounce_count","flags_count","bans","flags","actions","content_changed","archived_at","flag_types","flag_labels","reporter_ids"],"type":"object"},"ReviewQueueItemNewEvent":{"description":"This event is sent when a new moderation review queue item is created","nullable":true,"properties":{"action":{"$ref":"#/components/schemas/ActionLogResponse","description":"The action log if any action was taken","title":"Action","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"flags":{"description":"The flags associated with this review queue item","items":{"$ref":"#/components/schemas/FlagResponse"},"title":"Flags","type":"array","x-stream-index":"003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"The review queue item that was created","title":"ReviewQueueItem","x-stream-index":"002"},"type":{"default":"review_queue_item.new","type":"string","x-stream-index":"001.002"}},"required":["type","created_at","custom"],"title":"ReviewQueueItemNewEvent","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"},"ReviewQueueItemResponse":{"properties":{"actions":{"description":"Moderation actions taken","items":{"$ref":"#/components/schemas/ActionLogResponse"},"title":"Actions","type":"array","x-stream-index":"024"},"activity":{"$ref":"#/components/schemas/EnrichedActivity","x-stream-index":"016"},"ai_text_severity":{"description":"AI-determined text severity","title":"AI Text Severity","type":"string","x-stream-index":"014"},"assigned_to":{"$ref":"#/components/schemas/UserResponse","description":"Moderator assigned to review this item","title":"Assigned To","x-stream-index":"021"},"bans":{"description":"Associated ban records","items":{"$ref":"#/components/schemas/Ban"},"title":"Bans","type":"array","x-stream-index":"022"},"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"018"},"completed_at":{"description":"When the review was completed","format":"date-time","title":"Completed At","type":"number","x-stream-index":"009"},"config_key":{"type":"string","x-stream-index":"028"},"created_at":{"description":"When the item was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"002"},"entity_creator":{"$ref":"#/components/schemas/EntityCreatorResponse","description":"Details about who created the entity","title":"Entity Creator","x-stream-index":"019"},"entity_creator_id":{"description":"ID of who created the entity","title":"Entity Creator ID","type":"string","x-stream-index":"020"},"entity_id":{"description":"ID of the entity being reviewed","title":"Entity ID","type":"string","x-stream-index":"005"},"entity_type":{"description":"Type of entity being reviewed","title":"Entity Type","type":"string","x-stream-index":"004"},"feeds_v2_activity":{"$ref":"#/components/schemas/EnrichedActivity","description":"Associated feed activity","title":"Feeds V2 Activity","x-stream-index":"025"},"feeds_v2_reaction":{"$ref":"#/components/schemas/Reaction","description":"Associated feed reaction","title":"Feeds V2 Reaction","x-stream-index":"026"},"flags":{"description":"Associated flag records","items":{"$ref":"#/components/schemas/FlagResponse"},"title":"Flags","type":"array","x-stream-index":"023"},"flags_count":{"format":"int32","type":"integer","x-stream-index":"029"},"id":{"description":"Unique identifier of the review queue item","title":"ID","type":"string","x-stream-index":"001"},"languages":{"description":"Detected languages in the content","items":{"type":"string"},"title":"Languages","type":"array","x-stream-index":"012"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Associated message details","title":"Message","x-stream-index":"015"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content being moderated","title":"Moderation Payload","x-stream-index":"006"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"017"},"recommended_action":{"description":"Suggested moderation action","title":"Recommended Action","type":"string","x-stream-index":"008"},"reviewed_at":{"description":"When the item was reviewed","format":"date-time","title":"Reviewed At","type":"number","x-stream-index":"010"},"reviewed_by":{"description":"ID of the moderator who reviewed the item","title":"Reviewed By","type":"string","x-stream-index":"011"},"severity":{"description":"Severity level of the content","format":"int32","title":"Severity","type":"integer","x-stream-index":"013"},"status":{"description":"Current status of the review","title":"Status","type":"string","x-stream-index":"007"},"teams":{"description":"Teams associated with this item","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"027"},"updated_at":{"description":"When the item was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"003"}},"required":["id","created_at","updated_at","entity_type","entity_id","status","recommended_action","reviewed_by","languages","severity","ai_text_severity","bans","flags","actions","flags_count"],"type":"object"},"ReviewQueueItemUpdatedEvent":{"description":"This event is sent when a moderation review queue item is updated","nullable":true,"properties":{"action":{"$ref":"#/components/schemas/ActionLogResponse","description":"The action log if any action was taken","title":"Action","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"flags":{"description":"The flags associated with this review queue item","items":{"$ref":"#/components/schemas/FlagResponse"},"title":"Flags","type":"array","x-stream-index":"003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"The review queue item that was updated","title":"ReviewQueueItem","x-stream-index":"002"},"type":{"default":"review_queue_item.updated","type":"string","x-stream-index":"001.002"}},"required":["type","created_at","custom"],"title":"ReviewQueueItemUpdatedEvent","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"},"RingSettings":{"properties":{"auto_cancel_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_timeout_ms","missed_call_timeout_ms"],"type":"object"},"RingSettingsResponse":{"properties":{"auto_cancel_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_timeout_ms","missed_call_timeout_ms"],"type":"object"},"RuleBuilderAction":{"properties":{"ban_options":{"$ref":"#/components/schemas/BanOptions","x-stream-index":"002"},"flag_content_options":{"$ref":"#/components/schemas/FlagContentOptions","x-stream-index":"004"},"flag_user_options":{"$ref":"#/components/schemas/FlagUserOptions","x-stream-index":"003"},"remove_content_options":{"$ref":"#/components/schemas/BlockContentOptions","x-stream-index":"005"},"type":{"type":"string","x-stream-index":"001"}},"required":["type"],"type":"object"},"RuleBuilderCondition":{"properties":{"confidence":{"format":"float","type":"number","x-stream-index":"002"},"content_count_rule_params":{"$ref":"#/components/schemas/ContentCountRuleParameters","x-stream-index":"007"},"image_content_params":{"$ref":"#/components/schemas/ImageContentParameters","x-stream-index":"009"},"image_rule_params":{"$ref":"#/components/schemas/ImageRuleParameters","x-stream-index":"004"},"text_content_params":{"$ref":"#/components/schemas/TextContentParameters","x-stream-index":"008"},"text_rule_params":{"$ref":"#/components/schemas/TextRuleParameters","x-stream-index":"003"},"type":{"type":"string","x-stream-index":"001"},"user_created_within_params":{"$ref":"#/components/schemas/UserCreatedWithinParameters","x-stream-index":"011"},"user_rule_params":{"$ref":"#/components/schemas/UserRuleParameters","x-stream-index":"006"},"video_content_params":{"$ref":"#/components/schemas/VideoContentParameters","x-stream-index":"010"},"video_rule_params":{"$ref":"#/components/schemas/VideoRuleParameters","x-stream-index":"005"}},"required":["type"],"type":"object"},"RuleBuilderConditionGroup":{"properties":{"conditions":{"items":{"$ref":"#/components/schemas/RuleBuilderCondition"},"type":"array","x-stream-index":"002"},"logic":{"type":"string","x-stream-index":"001"}},"required":["logic","conditions"],"type":"object"},"RuleBuilderConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"rules":{"items":{"$ref":"#/components/schemas/RuleBuilderRule"},"type":"array","x-stream-index":"002"}},"required":["rules"],"type":"object"},"RuleBuilderRule":{"properties":{"action":{"$ref":"#/components/schemas/RuleBuilderAction","x-stream-index":"007"},"conditions":{"items":{"$ref":"#/components/schemas/RuleBuilderCondition"},"type":"array","x-stream-index":"004"},"cooldown_period":{"type":"string","x-stream-index":"009"},"enabled":{"type":"boolean","x-stream-index":"008"},"groups":{"items":{"$ref":"#/components/schemas/RuleBuilderConditionGroup"},"type":"array","x-stream-index":"006"},"id":{"type":"string","x-stream-index":"001"},"logic":{"type":"string","x-stream-index":"005"},"name":{"type":"string","x-stream-index":"002"},"rule_type":{"type":"string","x-stream-index":"003"}},"required":["id","name","rule_type","action","enabled"],"type":"object"},"SFUIDLastSeen":{"properties":{"id":{"type":"string","x-stream-index":"001.001"},"last_seen":{"format":"date-time","type":"number","x-stream-index":"002"},"process_start_time":{"format":"int64","type":"integer","x-stream-index":"001.002"}},"required":["id","process_start_time","last_seen"],"type":"object"},"STTEgressConfig":{"properties":{"closed_captions_enabled":{"type":"boolean","x-stream-index":"005"},"external_storage":{"$ref":"#/components/schemas/ExternalStorage","x-stream-index":"011"},"language":{"type":"string","x-stream-index":"008"},"storage_name":{"type":"string","x-stream-index":"010"},"translation_languages":{"items":{"type":"string"},"type":"array","x-stream-index":"009"},"translations_enabled":{"type":"boolean","x-stream-index":"006"},"upload_transcriptions":{"type":"boolean","x-stream-index":"004"},"whisper_server_base_url":{"type":"string","x-stream-index":"007"}},"type":"object"},"ScreensharingSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled"],"type":"object"},"ScreensharingSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled"],"type":"object"},"SessionSettings":{"properties":{"inactivity_timeout_seconds":{"format":"int32","maximum":900,"minimum":5,"type":"integer","x-stream-index":"001"}},"required":["inactivity_timeout_seconds"],"type":"object"},"SessionSettingsResponse":{"properties":{"inactivity_timeout_seconds":{"format":"int32","maximum":900,"minimum":5,"type":"integer","x-stream-index":"001"}},"required":["inactivity_timeout_seconds"],"type":"object"},"ShadowBlockActionRequest":{"type":"object"},"SharedLocation":{"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"013"},"channel_cid":{"type":"string","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"010"},"created_by_device_id":{"type":"string","x-stream-index":"008"},"end_at":{"format":"date-time","type":"number","x-stream-index":"009"},"latitude":{"format":"float","maximum":90,"minimum":18446744073709552000,"type":"number","x-stream-index":"006"},"longitude":{"format":"float","maximum":180,"minimum":18446744073709552000,"type":"number","x-stream-index":"007"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"012"},"message_id":{"type":"string","x-stream-index":"004"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"011"},"user_id":{"type":"string","x-stream-index":"005"}},"required":["channel_cid","message_id","user_id","created_by_device_id","created_at","updated_at"],"type":"object"},"SharedLocationResponseData":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"011"},"channel_cid":{"type":"string","x-stream-index":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"created_by_device_id":{"type":"string","x-stream-index":"006"},"end_at":{"format":"date-time","type":"number","x-stream-index":"007"},"latitude":{"format":"float","type":"number","x-stream-index":"004"},"longitude":{"format":"float","type":"number","x-stream-index":"005"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"010"},"message_id":{"type":"string","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["channel_cid","message_id","user_id","latitude","longitude","created_by_device_id","created_at","updated_at"],"type":"object"},"SortParam":{"nullable":true,"properties":{"direction":{"format":"int32","type":"integer","x-stream-index":"002"},"field":{"type":"string","x-stream-index":"001"}},"type":"object"},"SortParamRequest":{"nullable":true,"properties":{"direction":{"description":"Direction of sorting, 1 for Ascending, -1 for Descending, default is 1","format":"int32","title":"Direction","type":"integer","x-stream-index":"002"},"field":{"description":"Name of field to sort by","title":"Field","type":"string","x-stream-index":"001"}},"type":"object"},"SubmitActionRequest":{"nullable":true,"properties":{"action_type":{"description":"Type of moderation action to perform (mark_reviewed, delete_message, etc.)","enum":["mark_reviewed","delete_message","delete_activity","delete_reaction","ban","custom","unban","restore","delete_user","unblock","shadow_block","unmask","kick_user","end_call"],"title":"Action Type","type":"string","x-stream-index":"002"},"ban":{"$ref":"#/components/schemas/BanActionRequest","description":"Configuration for ban action","title":"Ban","x-stream-index":"008"},"custom":{"$ref":"#/components/schemas/CustomActionRequest","description":"Configuration for custom action","title":"Custom","x-stream-index":"009"},"delete_activity":{"$ref":"#/components/schemas/DeleteActivityRequest","description":"Configuration for activity deletion action","title":"Delete Activity","x-stream-index":"004"},"delete_message":{"$ref":"#/components/schemas/DeleteMessageRequest","description":"Configuration for message deletion action","title":"Delete Message","x-stream-index":"003"},"delete_reaction":{"$ref":"#/components/schemas/DeleteReactionRequest","description":"Configuration for reaction deletion action","title":"Delete Reaction","x-stream-index":"005"},"delete_user":{"$ref":"#/components/schemas/DeleteUserRequest","description":"Configuration for user deletion action","title":"Delete User","x-stream-index":"006"},"item_id":{"description":"UUID of the review queue item to act on","title":"Item ID","type":"string","x-stream-index":"001"},"mark_reviewed":{"$ref":"#/components/schemas/MarkReviewedRequest","description":"Configuration for marking item as reviewed","title":"Mark Reviewed","x-stream-index":"007"},"unban":{"$ref":"#/components/schemas/UnbanActionRequest","description":"Configuration for unban action","title":"Unban","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"016.002"},"user_id":{"type":"string","x-stream-index":"016.001"}},"required":["item_id","action_type"],"type":"object"},"SubmitActionResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"Updated review queue item after action was performed","title":"Item","x-stream-index":"001"}},"required":["duration"],"type":"object"},"TargetResolution":{"properties":{"bitrate":{"format":"int32","maximum":6000000,"type":"integer","x-stream-index":"003"},"height":{"format":"int32","maximum":3840,"minimum":240,"type":"integer","x-stream-index":"002"},"width":{"format":"int32","maximum":3840,"minimum":240,"type":"integer","x-stream-index":"001"}},"required":["width","height","bitrate"],"type":"object"},"TextContentParameters":{"properties":{"blocklist_match":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"contains_url":{"type":"boolean","x-stream-index":"002"},"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001"},"severity":{"type":"string","x-stream-index":"003"}},"type":"object"},"TextRuleParameters":{"properties":{"blocklist_match":{"items":{"type":"string"},"type":"array","x-stream-index":"006"},"contains_url":{"type":"boolean","x-stream-index":"004"},"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"severity":{"type":"string","x-stream-index":"005"},"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"required":["threshold","time_window"],"type":"object"},"Thresholds":{"properties":{"explicit":{"$ref":"#/components/schemas/LabelThresholds","x-stream-index":"001"},"spam":{"$ref":"#/components/schemas/LabelThresholds","x-stream-index":"002"},"toxic":{"$ref":"#/components/schemas/LabelThresholds","x-stream-index":"003"}},"type":"object"},"ThumbnailResponse":{"properties":{"image_url":{"type":"string","x-stream-index":"001"}},"required":["image_url"],"type":"object"},"ThumbnailsSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"ThumbnailsSettingsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"Time":{"type":"object"},"TranscriptionSettings":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"title":"Mode","type":"string","x-stream-index":"002"},"language":{"description":"The language used in this call as a two letter code","enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"title":"Language","type":"string","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"title":"Mode","type":"string","x-stream-index":"001"}},"required":["mode","closed_caption_mode","languages","language"],"type":"object"},"TranscriptionSettingsResponse":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"002"},"language":{"enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"type":"string","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode","closed_caption_mode","languages","language"],"type":"object"},"TypingIndicators":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"TypingIndicatorsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"UnbanActionRequest":{"type":"object"},"UnbanRequest":{"nullable":true,"properties":{"unbanned_by":{"$ref":"#/components/schemas/UserRequest","description":"Details about the user performing the unban","title":"Unbanned By","x-stream-index":"005"},"unbanned_by_id":{"description":"ID of the user performing the unban","title":"Unbanned By ID","type":"string","x-stream-index":"004"}},"type":"object"},"UnbanResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"UnblockActionRequest":{"type":"object"},"UnmuteRequest":{"nullable":true,"properties":{"target_ids":{"description":"User IDs to unmute","items":{"type":"string"},"title":"Target IDs","type":"array","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"002.002"},"user_id":{"type":"string","x-stream-index":"002.001"}},"required":["target_ids"],"title":"UnmuteRequest","type":"object"},"UnmuteResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"non_existing_users":{"description":"A list of users that can't be found. Common cause for this is deleted users","items":{"type":"string"},"title":"Non Existing Users","type":"array","x-stream-index":"001"}},"required":["duration"],"title":"UnmuteResponse","type":"object"},"UpsertConfigRequest":{"nullable":true,"properties":{"ai_image_config":{"$ref":"#/components/schemas/AIImageConfig","description":"Configuration for AI image analysis","title":"AI Image Config","x-stream-index":"010"},"ai_text_config":{"$ref":"#/components/schemas/AITextConfig","description":"Configuration for AI text analysis","title":"AI Text Config","x-stream-index":"008"},"ai_video_config":{"$ref":"#/components/schemas/AIVideoConfig","description":"Configuration for AI video analysis","title":"AI Video Config","x-stream-index":"011"},"async":{"description":"Whether moderation should be performed asynchronously","title":"Async","type":"boolean","x-stream-index":"003"},"automod_platform_circumvention_config":{"$ref":"#/components/schemas/AutomodPlatformCircumventionConfig","description":"Configuration for platform circumvention detection","title":"Automod Platform Circumvention Config","x-stream-index":"005"},"automod_semantic_filters_config":{"$ref":"#/components/schemas/AutomodSemanticFiltersConfig","description":"Configuration for semantic filtering","title":"Automod Semantic Filters Config","x-stream-index":"006"},"automod_toxicity_config":{"$ref":"#/components/schemas/AutomodToxicityConfig","description":"Configuration for toxicity detection","title":"Automod Toxicity Config","x-stream-index":"004"},"aws_rekognition_config":{"$ref":"#/components/schemas/AIImageConfig","x-stream-index":"015"},"block_list_config":{"$ref":"#/components/schemas/BlockListConfig","description":"Configuration for block list filtering","title":"Block List Config","x-stream-index":"007"},"bodyguard_config":{"$ref":"#/components/schemas/AITextConfig","x-stream-index":"014"},"google_vision_config":{"$ref":"#/components/schemas/GoogleVisionConfig","description":"Configuration for Google Vision integration","title":"Google Vision Config","x-stream-index":"009"},"key":{"description":"Unique identifier for the moderation configuration","title":"Key","type":"string","x-stream-index":"001"},"rule_builder_config":{"$ref":"#/components/schemas/RuleBuilderConfig","description":"Configuration for custom rule builder (max 3 rules, max 5 conditions per rule)","title":"Rule Builder Config","x-stream-index":"013"},"team":{"description":"Team associated with the configuration","maxLength":128,"minLength":1,"title":"Team","type":"string","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"017.002"},"user_id":{"type":"string","x-stream-index":"017.001"},"velocity_filter_config":{"$ref":"#/components/schemas/VelocityFilterConfig","description":"Configuration for velocity-based filtering","title":"Velocity Filter Config","x-stream-index":"012"},"video_call_rule_config":{"$ref":"#/components/schemas/VideoCallRuleConfig","x-stream-index":"016"}},"required":["key"],"type":"object"},"UpsertConfigResponse":{"nullable":true,"properties":{"config":{"$ref":"#/components/schemas/ConfigResponse","description":"The created or updated moderation configuration","title":"Config","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["duration"],"type":"object"},"UpsertModerationTemplateRequest":{"nullable":true,"properties":{"config":{"$ref":"#/components/schemas/FeedsModerationTemplateConfig","description":"Configuration for the moderation template","title":"Config","x-stream-index":"002"},"name":{"description":"Name of the moderation template","title":"Name","type":"string","x-stream-index":"001"}},"required":["name","config"],"type":"object"},"UpsertModerationTemplateResponse":{"nullable":true,"properties":{"config":{"$ref":"#/components/schemas/FeedsModerationTemplateConfig","description":"Configuration for the moderation template","title":"Config","x-stream-index":"002"},"created_at":{"description":"When the template was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"003"},"duration":{"type":"string","x-stream-index":"005.001"},"name":{"description":"Name of the moderation template","title":"Name","type":"string","x-stream-index":"001"},"updated_at":{"description":"When the template was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"004"}},"required":["name","created_at","updated_at","duration"],"type":"object"},"User":{"properties":{"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"046"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"017"},"banned":{"type":"boolean","x-stream-index":"016"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"013"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"023"},"language":{"type":"string","x-stream-index":"035"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"026"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"042"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"005"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"009"}},"required":["id","role","teams_role","custom","banned","online"],"type":"object"},"UserCreatedWithinParameters":{"properties":{"max_age":{"type":"string","x-stream-index":"001"}},"type":"object"},"UserMute":{"nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"expires":{"description":"Date/time of mute expiration","format":"date-time","title":"Expires","type":"number","x-stream-index":"008"},"target":{"$ref":"#/components/schemas/User","description":"User who's muted","title":"Target","x-stream-index":"007"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/User","description":"Owner of channel mute","title":"User","x-stream-index":"005"}},"required":["created_at","updated_at"],"type":"object"},"UserRequest":{"description":"User request object","properties":{"custom":{"additionalProperties":{},"description":"Custom user data","title":"Custom","type":"object","x-stream-index":"004"},"id":{"description":"User ID","title":"ID","type":"string","x-stream-index":"001"},"image":{"description":"User's profile image URL","title":"Image","type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"006"},"language":{"type":"string","x-stream-index":"005"},"name":{"description":"Optional name of user","title":"Name","type":"string","x-stream-index":"002"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"007"},"role":{"description":"User's global role","title":"Role","type":"string","x-stream-index":"008"},"teams":{"description":"List of teams the user belongs to","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"010"},"teams_role":{"additionalProperties":{"type":"string"},"description":"Map of team-specific roles for the user","title":"TeamsRole","type":"object","x-stream-index":"009"}},"required":["id"],"title":"UserRequest","type":"object"},"UserResponse":{"description":"User response object","properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"ban_expires":{"description":"Date when ban expires","format":"date-time","title":"Ban expires","type":"number","x-stream-index":"003"},"banned":{"description":"Whether a user is banned or not","title":"Banned","type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.017"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"001.004"},"deactivated_at":{"description":"Date of deactivation","format":"date-time","title":"Deactivated at","type":"number","x-stream-index":"001.016"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"001.011"},"devices":{"description":"List of devices user is using","items":{"$ref":"#/components/schemas/DeviceResponse"},"title":"Devices","type":"array","x-stream-index":"006"},"id":{"description":"Unique user identifier","title":"ID","type":"string","x-stream-index":"001.001"},"image":{"title":"Image","type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"007"},"language":{"description":"Preferred language of a user","title":"Language","type":"string","x-stream-index":"001.005"},"last_active":{"description":"Date of last activity","format":"date-time","title":"Last active","type":"number","x-stream-index":"001.014"},"name":{"description":"Optional name of user","title":"Name","type":"string","x-stream-index":"001.002"},"online":{"description":"Whether a user online or not","title":"Online","type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","description":"User privacy settings","title":"Privacy settings","x-stream-index":"005"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettingsResponse","description":"User push notification settings","title":"Push notifications","x-stream-index":"004"},"revoke_tokens_issued_before":{"description":"Revocation date for tokens","format":"date-time","title":"Revoke tokens issued before","type":"number","x-stream-index":"001.015"},"role":{"description":"Determines the set of user permissions","title":"Role","type":"string","x-stream-index":"001.006"},"shadow_banned":{"description":"Whether a user is shadow banned","title":"Shadow banned","type":"boolean","x-stream-index":"002"},"teams":{"description":"List of teams user is a part of","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids","shadow_banned","invisible"],"title":"UserResponse","type":"object"},"UserRuleParameters":{"properties":{"max_age":{"type":"string","x-stream-index":"001"}},"type":"object"},"VelocityFilterConfig":{"properties":{"advanced_filters":{"type":"boolean","x-stream-index":"007"},"async":{"type":"boolean","x-stream-index":"001"},"cascading_actions":{"type":"boolean","x-stream-index":"004"},"cids_per_user":{"format":"int32","type":"integer","x-stream-index":"006"},"enabled":{"type":"boolean","x-stream-index":"002"},"first_message_only":{"type":"boolean","x-stream-index":"005"},"rules":{"items":{"$ref":"#/components/schemas/VelocityFilterConfigRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules","cascading_actions","first_message_only","cids_per_user","advanced_filters"],"type":"object"},"VelocityFilterConfigRule":{"properties":{"action":{"enum":["flag","shadow","remove","ban"],"type":"string","x-stream-index":"001"},"ban_duration":{"format":"int32","type":"integer","x-stream-index":"002"},"cascading_action":{"enum":["flag","shadow","remove","ban"],"type":"string","x-stream-index":"006"},"cascading_threshold":{"format":"int64","type":"integer","x-stream-index":"005"},"check_message_context":{"type":"boolean","x-stream-index":"009"},"fast_spam_threshold":{"format":"int32","type":"integer","x-stream-index":"007"},"fast_spam_ttl":{"format":"int32","type":"integer","x-stream-index":"010"},"ip_ban":{"type":"boolean","x-stream-index":"004"},"probation_period":{"format":"int32","type":"integer","x-stream-index":"014"},"shadow_ban":{"type":"boolean","x-stream-index":"003"},"slow_spam_ban_duration":{"format":"int32","type":"integer","x-stream-index":"012"},"slow_spam_threshold":{"format":"int32","type":"integer","x-stream-index":"008"},"slow_spam_ttl":{"format":"int32","type":"integer","x-stream-index":"011"},"url_only":{"type":"boolean","x-stream-index":"013"}},"required":["action","ban_duration","shadow_ban","ip_ban","cascading_threshold","cascading_action","fast_spam_threshold","slow_spam_threshold","check_message_context","fast_spam_ttl","slow_spam_ttl","url_only","probation_period"],"type":"object"},"VideoCallRuleConfig":{"properties":{"rules":{"additionalProperties":{"$ref":"#/components/schemas/HarmConfig"},"type":"object","x-stream-index":"001"}},"required":["rules"],"type":"object"},"VideoContentParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"type":"object"},"VideoEndCallRequest":{"type":"object"},"VideoKickUserRequest":{"type":"object"},"VideoOrientation":{"properties":{"orientation":{"type":"integer","x-stream-index":"004"}},"type":"object"},"VideoRuleParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"required":["threshold","time_window"],"type":"object"},"VideoSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"camera_default_on":{"type":"boolean","x-stream-index":"004"},"camera_facing":{"enum":["front","back","external"],"type":"string","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled","target_resolution","camera_default_on","camera_facing"],"type":"object"},"VideoSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"camera_default_on":{"type":"boolean","x-stream-index":"004"},"camera_facing":{"enum":["front","back","external"],"type":"string","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled","target_resolution","camera_default_on","camera_facing"],"type":"object"},"WebhookEvent":{"description":"The discriminator object for all webhook events, it maps events' payload to the final type","discriminator":{"mapping":{"export.bulk_image_moderation.error":"#/components/schemas/AsyncExportErrorEvent","export.bulk_image_moderation.success":"#/components/schemas/AsyncBulkImageModerationEvent","export.moderation_logs.error":"#/components/schemas/AsyncExportErrorEvent","export.moderation_logs.success":"#/components/schemas/AsyncExportModerationLogsEvent","moderation.custom_action":"#/components/schemas/ModerationCustomActionEvent","moderation.flagged":"#/components/schemas/ModerationFlaggedEvent","moderation.mark_reviewed":"#/components/schemas/ModerationMarkReviewedEvent","moderation_check.completed":"#/components/schemas/ModerationCheckCompletedEvent","review_queue_item.new":"#/components/schemas/ReviewQueueItemNewEvent","review_queue_item.updated":"#/components/schemas/ReviewQueueItemUpdatedEvent"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/AsyncBulkImageModerationEvent"},{"$ref":"#/components/schemas/AsyncExportErrorEvent"},{"$ref":"#/components/schemas/AsyncExportErrorEvent"},{"$ref":"#/components/schemas/AsyncExportModerationLogsEvent"},{"$ref":"#/components/schemas/ModerationCheckCompletedEvent"},{"$ref":"#/components/schemas/ModerationCustomActionEvent"},{"$ref":"#/components/schemas/ModerationFlaggedEvent"},{"$ref":"#/components/schemas/ModerationMarkReviewedEvent"},{"$ref":"#/components/schemas/ReviewQueueItemNewEvent"},{"$ref":"#/components/schemas/ReviewQueueItemUpdatedEvent"}]}},"securitySchemes":{"JWT":{"description":"JWT should be always provided when stream-auth-type=jwt.\n\nUsing JWT auth request could be authenticated as user or as server-side.\n\nWhen using user authentication permission checking is going to be applied to requests based on the user that is\nperforming a request.\n\nThe `authorization` header should be a JWT string signed using the secret attached to the API key used to perform\nrequests.\n\n**WARNING** all client-side official SDK do not ship with token generation; this is to make sure that the API secret is not\nshared with an untrusted party such as a browser or a iOS/Android application. Tokens **must** be generated server-side.\nIf you wish, you can configure your application to ignore authentication (see `disable_auth_check`)\nThe JWT string must include only the user_id claim and can include any built-in JWT claim such as iat, exp as well.\n","in":"header","name":"Authorization","type":"apiKey"},"api_key":{"description":"Application API key should be always set in order to authenticate the request.","in":"query","name":"api_key","type":"apiKey"},"stream-auth-type":{"description":"Stream-Auth-Type should be always set in order to authenticate the request. Possible\nvalues: `jwt` or `anonymous`.\n\n`jwt` allows you to authenticate as a user. With this auth type you should also provide valid JWT in Authorization\nheader.\n\n`anonymous` allows you to authenticate as anonymous user. Please note that most advanced features are not available\nto anonymous users.","in":"header","name":"Stream-Auth-Type","type":"apiKey"}}},"info":{"title":"Stream API","version":"v187.13.0"},"openapi":"3.0.3","paths":{"/api/v2/moderation/ban":{"post":{"description":"Ban a user from a channel or the entire app\n","operationId":"ban","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BanRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BanResponse"}}},"description":"Successful 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":"Ban","tags":["product:moderation"]}},"/api/v2/moderation/bulk_image_moderation":{"post":{"description":"Moderate multiple images in bulk using a CSV file\n","operationId":"bulk_image_moderation","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkImageModerationRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkImageModerationResponse"}}},"description":"Successful 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":"Bulk image moderation","tags":["product:moderation"]}},"/api/v2/moderation/check":{"post":{"description":"Run moderation checks on the provided content\n","operationId":"check","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckResponse"}}},"description":"Successful 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":"Check","tags":["product:moderation"]}},"/api/v2/moderation/config":{"post":{"description":"Create a new moderation configuration or update an existing one. Configure settings for content filtering, AI analysis, toxicity detection, and other moderation features.\n","operationId":"upsert_config","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertConfigRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertConfigResponse"}}},"description":"Successful 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":"Create or update moderation configuration","tags":["product:moderation"]}},"/api/v2/moderation/config/{key}":{"delete":{"description":"Delete a specific moderation policy by its name\n","operationId":"delete_config","parameters":[{"in":"path","name":"key","required":true,"schema":{"description":"Key of the moderation configuration to delete","title":"Key","type":"string","x-stream-index":"001"}},{"in":"query","name":"team","schema":{"description":"Team associated with the configuration","title":"Team","type":"string","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteModerationConfigResponse"}}},"description":"Successful 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":"Delete a moderation policy","tags":["product:moderation"]},"get":{"description":"Retrieve a specific moderation configuration by its key and team. This configuration contains settings for various moderation features like toxicity detection, AI analysis, and filtering rules.\n","operationId":"get_config","parameters":[{"in":"path","name":"key","required":true,"schema":{"description":"Key of the moderation configuration to retrieve","title":"Key","type":"string","x-stream-index":"001"}},{"in":"query","name":"team","schema":{"description":"Team associated with the configuration","title":"Team","type":"string","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetConfigResponse"}}},"description":"Successful 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":"Get moderation configuration","tags":["product:moderation"]}},"/api/v2/moderation/configs":{"post":{"description":"Search and filter moderation configurations across your application. This endpoint is designed for building moderation dashboards and managing multiple configuration sets.\n","operationId":"query_moderation_configs","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationConfigsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationConfigsResponse"}}},"description":"Successful 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":"Query moderation configurations","tags":["product:moderation"]}},"/api/v2/moderation/custom_check":{"post":{"description":"Custom check, add your own AI model reports to the review queue\n","operationId":"custom_check","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomCheckRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomCheckResponse"}}},"description":"Successful 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":"Custom check endpoint","tags":["product:moderation"]}},"/api/v2/moderation/feeds_moderation_template":{"delete":{"description":"Delete a specific moderation template by its name\n","operationId":"V2DeleteTemplate","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteModerationTemplateResponse"}}},"description":"Successful 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":"Delete a moderation template","tags":["product:moderation"]},"get":{"description":"Retrieve a list of feed moderation templates that define preset moderation rules and configurations. Limited to 100 templates per request.\n","operationId":"V2QueryTemplates","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryFeedModerationTemplatesResponse"}}},"description":"Successful 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":"Query feed moderation templates","tags":["product:moderation"]},"post":{"description":"Upsert feeds template for moderation\n","operationId":"V2UpsertTemplate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertModerationTemplateRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertModerationTemplateResponse"}}},"description":"Successful 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":"Upsert feeds template","tags":["product:moderation"]}},"/api/v2/moderation/flag":{"post":{"description":"Flag any type of content (messages, users, channels, activities) for moderation review. Supports custom content types and additional metadata for flagged content.\n","operationId":"flag","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlagRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlagResponse"}}},"description":"Successful 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":"Flag content for moderation","tags":["product:moderation"]}},"/api/v2/moderation/flags":{"post":{"description":"Query flags associated with moderation items. This is used for building a moderation dashboard.\n","operationId":"query_moderation_flags","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationFlagsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationFlagsResponse"}}},"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":"Query moderation flags","tags":["product:moderation"]}},"/api/v2/moderation/logs":{"post":{"description":"Search and filter moderation action logs with support for pagination. View the history of moderation actions taken, including who performed them and when.\n","operationId":"query_moderation_logs","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationLogsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationLogsResponse"}}},"description":"Successful 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":"Query moderation action logs","tags":["product:moderation"]}},"/api/v2/moderation/mute":{"post":{"description":"Mute a user. Mutes are generally not visible to the user you mute, while block is something you notice.\n","operationId":"mute","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteRequest"}}},"description":"MuteRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteResponse"}}},"description":"MuteResponse"},"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":"Mute","tags":["product:moderation"]}},"/api/v2/moderation/review_queue":{"post":{"description":"Query review queue items allows you to filter the review queue items. This is used for building a moderation dashboard.\n","operationId":"query_review_queue","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryReviewQueueRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryReviewQueueResponse"}}},"description":"Successful 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":"Query review queue items","tags":["product:moderation"]}},"/api/v2/moderation/review_queue/{id}":{"get":{"description":"Retrieve a specific review queue item by its ID\n","operationId":"get_review_queue_item","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Unique identifier of the review queue item to retrieve","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetReviewQueueItemResponse"}}},"description":"Successful 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":"Get review queue item","tags":["product:moderation"]}},"/api/v2/moderation/submit_action":{"post":{"description":"Take action on flagged content, such as marking content as safe, deleting content, banning users, or executing custom moderation actions. Supports various action types with configurable parameters.\n","operationId":"submit_action","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitActionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitActionResponse"}}},"description":"Successful 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":"Submit moderation action","tags":["product:moderation"]}},"/api/v2/moderation/unban":{"post":{"description":"Unban a user from a channel or globally.\n","operationId":"unban","parameters":[{"in":"query","name":"target_user_id","required":true,"schema":{"description":"ID of the user to unban","title":"Target User ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"channel_cid","schema":{"description":"Channel where the unban applies","title":"Channel CID","type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"created_by","schema":{"description":"ID of the user who created the ban","title":"Created By","type":"string","writeOnly":true,"x-stream-index":"003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnbanRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnbanResponse"}}},"description":"Successful 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":"Unban","tags":["product:moderation"]}},"/api/v2/moderation/unmute":{"post":{"description":"Unmute a user\n","operationId":"unmute","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnmuteRequest"}}},"description":"UnmuteRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnmuteResponse"}}},"description":"UnmuteResponse"},"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":"Unmute a user","tags":["product:moderation"]}}},"security":[{"JWT":[],"api_key":[],"stream-auth-type":[]},{"api_key":[],"stream-auth-type":[]}],"servers":[{"description":"Stream API","url":"https://chat.stream-io-api.com"}]} \ No newline at end of file +{"components":{"schemas":{"AIImageConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"ocr_rules":{"items":{"$ref":"#/components/schemas/OCRRule"},"type":"array","x-stream-index":"004"},"rules":{"items":{"$ref":"#/components/schemas/AWSRekognitionRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules","ocr_rules"],"type":"object"},"AITextConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"profile":{"type":"string","x-stream-index":"003"},"rules":{"items":{"$ref":"#/components/schemas/BodyguardRule"},"type":"array","x-stream-index":"004"},"severity_rules":{"items":{"$ref":"#/components/schemas/BodyguardSeverityRule"},"type":"array","x-stream-index":"005"}},"required":["enabled","profile","rules","severity_rules"],"type":"object"},"AIVideoConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AWSRekognitionRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"APIError":{"nullable":true,"properties":{"StatusCode":{"description":"Response HTTP status code","format":"int32","title":"Status code","type":"integer","x-stream-index":"004"},"code":{"description":"API error code","format":"int32","title":"Code","type":"integer","x-stream-index":"001"},"details":{"description":"Additional error-specific information","items":{"type":"integer"},"title":"Details","type":"array","x-stream-index":"007"},"duration":{"description":"Request duration","title":"Duration","type":"string","x-stream-index":"005"},"exception_fields":{"additionalProperties":{"type":"string"},"description":"Additional error info","title":"Exception fields","type":"object","x-stream-index":"003"},"message":{"description":"Message describing an error","title":"Message","type":"string","x-stream-index":"002"},"more_info":{"description":"URL with additional information","title":"More info","type":"string","x-stream-index":"006"},"unrecoverable":{"description":"Flag that indicates if the error is unrecoverable, requests that return unrecoverable errors should not be retried, this error only applies to the request that caused it","title":"Unrecoverable","type":"boolean","x-stream-index":"008"}},"required":["code","message","StatusCode","duration","more_info","details"],"title":"Error response","type":"object"},"APNS":{"properties":{"body":{"type":"string","x-stream-index":"002"},"content-available":{"format":"int32","type":"integer","x-stream-index":"004"},"data":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"mutable-content":{"format":"int32","type":"integer","x-stream-index":"005"},"sound":{"type":"string","x-stream-index":"003"},"title":{"type":"string","x-stream-index":"001"}},"required":["title","body"],"type":"object"},"AWSRekognitionRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"},"min_confidence":{"format":"float","maximum":100,"minimum":0,"type":"number","x-stream-index":"003"}},"required":["label","action","min_confidence"],"type":"object"},"Action":{"nullable":true,"properties":{"name":{"type":"string","x-stream-index":"001"},"style":{"type":"string","x-stream-index":"003"},"text":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"004"},"value":{"type":"string","x-stream-index":"005"}},"required":["name","text","type"],"type":"object"},"ActionLog":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"002"},"reason":{"type":"string","x-stream-index":"008"},"reporter_type":{"type":"string","x-stream-index":"009"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"014"},"review_queue_item_id":{"type":"string","x-stream-index":"012"},"target_user":{"$ref":"#/components/schemas/User","x-stream-index":"013"},"target_user_id":{"type":"string","x-stream-index":"011"},"type":{"type":"string","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007"}},"required":["id","created_at","type","reason","reporter_type","custom","target_user_id","review_queue_item_id"],"type":"object"},"ActionLogResponse":{"nullable":true,"properties":{"created_at":{"description":"Timestamp when the action was taken","format":"date-time","title":"Created At","type":"number","x-stream-index":"002"},"custom":{"additionalProperties":{},"description":"Additional metadata about the action","title":"Custom","type":"object","x-stream-index":"007"},"id":{"description":"Unique identifier of the action log","title":"ID","type":"string","x-stream-index":"001"},"reason":{"description":"Reason for the moderation action","title":"Reason","type":"string","x-stream-index":"006"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"Associated review queue item","title":"Review Queue Item","x-stream-index":"008"},"target_user":{"$ref":"#/components/schemas/UserResponse","description":"User who was the target of the action","title":"Target User","x-stream-index":"009"},"target_user_id":{"description":"ID of the user who was the target of the action","title":"Target User ID","type":"string","x-stream-index":"010"},"type":{"description":"Type of moderation action","title":"Type","type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who performed the action","title":"User","x-stream-index":"004"},"user_id":{"description":"ID of the user who performed the action","title":"User ID","type":"string","x-stream-index":"005"}},"required":["id","created_at","type","user_id","reason","custom","target_user_id"],"type":"object"},"ActionSequence":{"properties":{"action":{"type":"string","x-stream-index":"001"},"blur":{"type":"boolean","x-stream-index":"005"},"cooldown_period":{"format":"int32","type":"integer","x-stream-index":"004"},"threshold":{"format":"int32","type":"integer","x-stream-index":"002"},"time_window":{"format":"int32","type":"integer","x-stream-index":"003"},"warning":{"type":"boolean","x-stream-index":"006"},"warning_text":{"type":"string","x-stream-index":"007"}},"required":["action","threshold","time_window","cooldown_period","blur","warning","warning_text"],"type":"object"},"AsyncBulkImageModerationEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"003.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.007"},"finished_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.004"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"task_id":{"type":"string","x-stream-index":"002.001"},"type":{"default":"export.bulk_image_moderation.success","type":"string","x-stream-index":"003.002"},"url":{"type":"string","x-stream-index":"001"}},"required":["url","task_id","started_at","finished_at","type","created_at","custom"],"title":"AsyncBulkImageModerationEvent","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"},"AsyncExportErrorEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"003.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.007"},"error":{"type":"string","x-stream-index":"001"},"finished_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.004"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"task_id":{"type":"string","x-stream-index":"002.001"},"type":{"default":"export.moderation_logs.error","type":"string","x-stream-index":"003.002"}},"required":["error","task_id","started_at","finished_at","type","created_at","custom"],"title":"AsyncExportErrorEvent","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"},"AsyncExportModerationLogsEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"003.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.007"},"finished_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.004"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"task_id":{"type":"string","x-stream-index":"002.001"},"type":{"default":"export.moderation_logs.success","type":"string","x-stream-index":"003.002"},"url":{"type":"string","x-stream-index":"001"}},"required":["url","task_id","started_at","finished_at","type","created_at","custom"],"title":"AsyncExportModerationLogsEvent","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"},"Attachment":{"description":"An attachment is a message object that represents a file uploaded by a user.","nullable":true,"properties":{"actions":{"items":{"$ref":"#/components/schemas/Action"},"type":"array","x-stream-index":"015"},"asset_url":{"type":"string","x-stream-index":"017"},"author_icon":{"type":"string","x-stream-index":"007"},"author_link":{"type":"string","x-stream-index":"006"},"author_name":{"type":"string","x-stream-index":"005"},"color":{"type":"string","x-stream-index":"003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"018"},"fallback":{"type":"string","x-stream-index":"002"},"fields":{"items":{"$ref":"#/components/schemas/Field"},"type":"array","x-stream-index":"016"},"footer":{"type":"string","x-stream-index":"013"},"footer_icon":{"type":"string","x-stream-index":"014"},"giphy":{"$ref":"#/components/schemas/Images","x-stream-index":"019"},"image_url":{"type":"string","x-stream-index":"011"},"og_scrape_url":{"type":"string","x-stream-index":"020"},"original_height":{"format":"int32","type":"integer","x-stream-index":"022"},"original_width":{"format":"int32","type":"integer","x-stream-index":"021"},"pretext":{"type":"string","x-stream-index":"004"},"text":{"type":"string","x-stream-index":"010"},"thumb_url":{"type":"string","x-stream-index":"012"},"title":{"type":"string","x-stream-index":"008"},"title_link":{"type":"string","x-stream-index":"009"},"type":{"description":"Attachment type (e.g. image, video, url)","title":"Type","type":"string","x-stream-index":"001"}},"required":["custom"],"title":"Attachment","type":"object","x-stream-docs-page-id":"file_uploads"},"AudioSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"001"},"default_device":{"enum":["speaker","earpiece"],"type":"string","x-stream-index":"006"},"mic_default_on":{"type":"boolean","x-stream-index":"004"},"noise_cancellation":{"$ref":"#/components/schemas/NoiseCancellationSettings","x-stream-index":"007"},"opus_dtx_enabled":{"type":"boolean","x-stream-index":"002"},"redundant_coding_enabled":{"type":"boolean","x-stream-index":"003"},"speaker_default_on":{"type":"boolean","x-stream-index":"005"}},"required":["access_request_enabled","opus_dtx_enabled","redundant_coding_enabled","mic_default_on","speaker_default_on","default_device"],"type":"object"},"AudioSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"001"},"default_device":{"enum":["speaker","earpiece"],"type":"string","x-stream-index":"006"},"mic_default_on":{"type":"boolean","x-stream-index":"004"},"noise_cancellation":{"$ref":"#/components/schemas/NoiseCancellationSettings","x-stream-index":"007"},"opus_dtx_enabled":{"type":"boolean","x-stream-index":"002"},"redundant_coding_enabled":{"type":"boolean","x-stream-index":"003"},"speaker_default_on":{"type":"boolean","x-stream-index":"005"}},"required":["access_request_enabled","opus_dtx_enabled","redundant_coding_enabled","mic_default_on","speaker_default_on","default_device"],"type":"object"},"AutomodPlatformCircumventionConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AutomodRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"AutomodRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"003"},"label":{"type":"string","x-stream-index":"001"},"threshold":{"format":"float","maximum":1,"minimum":0,"type":"number","x-stream-index":"002"}},"required":["label","threshold","action"],"type":"object"},"AutomodSemanticFiltersConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AutomodSemanticFiltersRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"AutomodSemanticFiltersRule":{"properties":{"action":{"enum":["flag","shadow","remove"],"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"threshold":{"format":"float","maximum":1,"minimum":0,"type":"number","x-stream-index":"002"}},"required":["name","threshold","action"],"type":"object"},"AutomodToxicityConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AutomodRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"BackstageSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"BackstageSettingsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"Ban":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"012"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"011"},"expires":{"format":"date-time","type":"number","x-stream-index":"007"},"reason":{"type":"string","x-stream-index":"008"},"shadow":{"type":"boolean","x-stream-index":"009"},"target":{"$ref":"#/components/schemas/User","x-stream-index":"006"}},"required":["shadow","created_at"],"type":"object"},"BanActionRequest":{"properties":{"channel_ban_only":{"type":"boolean","x-stream-index":"003"},"delete_messages":{"enum":["soft","pruning","hard"],"type":"string","x-stream-index":"005"},"ip_ban":{"type":"boolean","x-stream-index":"004"},"reason":{"type":"string","x-stream-index":"002"},"shadow":{"type":"boolean","x-stream-index":"001"},"timeout":{"format":"int32","type":"integer","x-stream-index":"006"}},"type":"object"},"BanOptions":{"properties":{"duration":{"format":"int32","type":"integer","x-stream-index":"001"},"ip_ban":{"type":"boolean","x-stream-index":"004"},"reason":{"type":"string","x-stream-index":"002"},"shadow_ban":{"type":"boolean","x-stream-index":"003"}},"type":"object"},"BanRequest":{"nullable":true,"properties":{"banned_by":{"$ref":"#/components/schemas/UserRequest","description":"Details about the user performing the ban","title":"Banned By","x-stream-index":"008"},"banned_by_id":{"description":"ID of the user performing the ban","title":"Banned By ID","type":"string","x-stream-index":"007"},"channel_cid":{"description":"Channel where the ban applies","title":"Channel CID","type":"string","x-stream-index":"004"},"delete_messages":{"enum":["soft","pruning","hard"],"type":"string","x-stream-index":"009"},"ip_ban":{"description":"Whether to ban the user's IP address","title":"IP Ban","type":"boolean","x-stream-index":"006"},"reason":{"description":"Optional explanation for the ban","title":"Reason","type":"string","x-stream-index":"003"},"shadow":{"description":"Whether this is a shadow ban","title":"Shadow","type":"boolean","x-stream-index":"005"},"target_user_id":{"description":"ID of the user to ban","title":"Target User ID","type":"string","x-stream-index":"001"},"timeout":{"description":"Duration of the ban in minutes","minimum":0,"title":"Timeout","type":"integer","x-stream-index":"002"}},"required":["target_user_id"],"type":"object"},"BanResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"BlockContentOptions":{"properties":{"reason":{"type":"string","x-stream-index":"001"}},"type":"object"},"BlockListConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/BlockListRule"},"maximum":10,"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"BlockListOptions":{"properties":{"behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"002"},"blocklist":{"type":"string","x-stream-index":"001"}},"required":["blocklist","behavior"],"type":"object"},"BlockListRule":{"properties":{"action":{"enum":["flag","mask_flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"002"}},"required":["name","team","action"],"type":"object"},"BodyguardRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"},"severity_rules":{"items":{"$ref":"#/components/schemas/BodyguardSeverityRule"},"type":"array","x-stream-index":"003"}},"required":["label","action","severity_rules"],"type":"object"},"BodyguardSeverityRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"severity":{"enum":["low","medium","high","critical"],"type":"string","x-stream-index":"001"}},"required":["severity","action"],"type":"object"},"BroadcastSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettings","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettings","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"BroadcastSettingsResponse":{"description":"BroadcastSettingsResponse is the payload for broadcasting settings","properties":{"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettingsResponse","title":"HLS","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettingsResponse","title":"RTMP","x-stream-index":"003"}},"required":["enabled","hls","rtmp"],"title":"BroadcastSettingsResponse","type":"object"},"BulkImageModerationRequest":{"nullable":true,"properties":{"csv_file":{"description":"URL to CSV file containing image URLs to moderate","title":"string","type":"string","x-stream-index":"001"}},"required":["csv_file"],"type":"object"},"BulkImageModerationResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"task_id":{"description":"ID of the task for processing the bulk image moderation","title":"string","type":"string","x-stream-index":"001"}},"required":["task_id","duration"],"type":"object"},"Call":{"properties":{"AppPK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"002"},"Backstage":{"type":"boolean","writeOnly":true,"x-stream-index":"023"},"BlockedUserIDs":{"items":{"type":"string"},"type":"array","writeOnly":true,"x-stream-index":"018"},"BlockedUsers":{"items":{"$ref":"#/components/schemas/User"},"type":"array","writeOnly":true,"x-stream-index":"019"},"CID":{"type":"string","writeOnly":true,"x-stream-index":"005"},"CallType":{"$ref":"#/components/schemas/CallType","x-stream-index":"020"},"ChannelCID":{"type":"string","writeOnly":true,"x-stream-index":"032"},"CreatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"013"},"CreatedBy":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"CreatedByUserID":{"type":"string","writeOnly":true,"x-stream-index":"007"},"CurrentSessionID":{"type":"string","writeOnly":true,"x-stream-index":"024"},"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"012"},"DeletedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"028"},"EgressUpdatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"027"},"Egresses":{"items":{"$ref":"#/components/schemas/CallEgress"},"type":"array","writeOnly":true,"x-stream-index":"015"},"EndedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"017"},"ID":{"type":"string","writeOnly":true,"x-stream-index":"004"},"JoinAheadTimeSeconds":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"031"},"LastHeartbeatAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"030"},"LastSessionID":{"type":"string","writeOnly":true,"x-stream-index":"025"},"MemberCount":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"010"},"MemberLookup":{"$ref":"#/components/schemas/MemberLookup","x-stream-index":"011"},"Members":{"items":{"$ref":"#/components/schemas/CallMember"},"type":"array","writeOnly":true,"x-stream-index":"009"},"Session":{"$ref":"#/components/schemas/CallSession","x-stream-index":"026"},"Settings":{"$ref":"#/components/schemas/CallSettings","x-stream-index":"022"},"SettingsOverrides":{"$ref":"#/components/schemas/CallSettings","x-stream-index":"021"},"StartsAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"016"},"Team":{"type":"string","writeOnly":true,"x-stream-index":"006"},"ThumbnailURL":{"type":"string","writeOnly":true,"x-stream-index":"029"},"Type":{"type":"string","writeOnly":true,"x-stream-index":"003"},"UpdatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"014"}},"required":["AppPK","Type","ID","CID","Team","CreatedByUserID","Members","Custom","CreatedAt","UpdatedAt","Egresses","BlockedUserIDs","BlockedUsers","Backstage","CurrentSessionID","LastSessionID","ThumbnailURL","ChannelCID"],"type":"object"},"CallEgress":{"nullable":true,"properties":{"app_pk":{"format":"int32","type":"integer","x-stream-index":"002"},"call_id":{"type":"string","x-stream-index":"004"},"call_type":{"type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/EgressTaskConfig","x-stream-index":"007"},"egress_id":{"type":"string","x-stream-index":"005"},"egress_type":{"type":"string","x-stream-index":"006"},"instance_ip":{"type":"string","x-stream-index":"008"},"started_at":{"format":"date-time","type":"number","x-stream-index":"010"},"state":{"type":"string","x-stream-index":"009"},"stopped_at":{"format":"date-time","type":"number","x-stream-index":"011"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"012"}},"required":["app_pk","call_type","call_id","egress_id","egress_type","instance_ip","state","started_at","updated_at"],"type":"object"},"CallIngressResponse":{"description":"CallIngressResponse is the payload for ingress settings","properties":{"rtmp":{"$ref":"#/components/schemas/RTMPIngress","title":"RTMP","x-stream-index":"001"}},"required":["rtmp"],"title":"CallIngressResponse","type":"object"},"CallMember":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"010"},"role":{"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["user_id","role","custom","created_at","updated_at"],"type":"object"},"CallParticipant":{"nullable":true,"properties":{"JoinedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"004"},"Role":{"type":"string","writeOnly":true,"x-stream-index":"002"},"UserSessionID":{"type":"string","writeOnly":true,"x-stream-index":"003"},"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"001.046"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"001.017"},"banned":{"type":"boolean","x-stream-index":"001.016"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.013"},"id":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"001.023"},"language":{"type":"string","x-stream-index":"001.035"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"001.022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"001.026"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.042"},"role":{"type":"string","x-stream-index":"001.004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.005"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.009"}},"required":["id","role","teams_role","custom","banned","online","Role","UserSessionID","JoinedAt"],"type":"object"},"CallParticipantResponse":{"properties":{"joined_at":{"format":"date-time","type":"number","x-stream-index":"004"},"role":{"type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"},"user_session_id":{"type":"string","x-stream-index":"002"}},"required":["user","user_session_id","role","joined_at"],"type":"object"},"CallResponse":{"description":"Represents a call","properties":{"backstage":{"type":"boolean","x-stream-index":"016"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"018"},"captioning":{"type":"boolean","x-stream-index":"013"},"channel_cid":{"type":"string","x-stream-index":"024"},"cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"The user that created the call","title":"Created By","x-stream-index":"007"},"current_session_id":{"type":"string","x-stream-index":"005"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"008"},"egress":{"$ref":"#/components/schemas/EgressResponse","x-stream-index":"021"},"ended_at":{"description":"Date/time when the call ended","format":"date-time","title":"Ended At","type":"number","x-stream-index":"014"},"id":{"description":"Call ID","title":"ID","type":"string","x-stream-index":"003"},"ingress":{"$ref":"#/components/schemas/CallIngressResponse","x-stream-index":"019"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"023"},"recording":{"type":"boolean","x-stream-index":"011"},"session":{"$ref":"#/components/schemas/CallSessionResponse","x-stream-index":"020"},"settings":{"$ref":"#/components/schemas/CallSettingsResponse","x-stream-index":"017"},"starts_at":{"description":"Date/time when the call will start","format":"date-time","title":"Starts At","type":"number","x-stream-index":"015"},"team":{"type":"string","x-stream-index":"006"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailResponse","x-stream-index":"022"},"transcribing":{"type":"boolean","x-stream-index":"012"},"type":{"description":"The type of call","title":"Type","type":"string","x-stream-index":"002"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"}},"required":["type","id","cid","current_session_id","created_by","custom","created_at","updated_at","recording","transcribing","captioning","backstage","settings","blocked_user_ids","ingress","egress"],"title":"CallResponse","type":"object"},"CallSession":{"properties":{"AcceptedBy":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","writeOnly":true,"x-stream-index":"008"},"ActiveSFUs":{"items":{"$ref":"#/components/schemas/SFUIDLastSeen"},"type":"array","writeOnly":true,"x-stream-index":"016"},"AnonymousParticipantCount":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"019"},"AppPK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"002.001"},"CallID":{"type":"string","writeOnly":true,"x-stream-index":"002.003"},"CallType":{"type":"string","writeOnly":true,"x-stream-index":"002.002"},"CreatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"003"},"DeletedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"004"},"EndedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"006"},"LiveEndedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"013"},"LiveStartedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"012"},"MissedBy":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","writeOnly":true,"x-stream-index":"010"},"Participants":{"items":{"$ref":"#/components/schemas/CallParticipant"},"type":"array","writeOnly":true,"x-stream-index":"011"},"ParticipantsCountByRole":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","writeOnly":true,"x-stream-index":"018"},"RejectedBy":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","writeOnly":true,"x-stream-index":"009"},"RingAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"007"},"SFUIDs":{"items":{"type":"string"},"type":"array","writeOnly":true,"x-stream-index":"015"},"SessionID":{"type":"string","writeOnly":true,"x-stream-index":"002.004"},"StartedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"005"},"TimerEndsAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"014"},"UserPermissionOverrides":{"additionalProperties":{"additionalProperties":{"type":"boolean"},"type":"object"},"type":"object","writeOnly":true,"x-stream-index":"017"}},"required":["AppPK","CallType","CallID","SessionID","CreatedAt","AcceptedBy","RejectedBy","MissedBy","Participants","SFUIDs","ActiveSFUs","UserPermissionOverrides","ParticipantsCountByRole","AnonymousParticipantCount"],"type":"object"},"CallSessionResponse":{"properties":{"accepted_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"008"},"anonymous_participant_count":{"format":"int32","type":"integer","x-stream-index":"006"},"ended_at":{"format":"date-time","type":"number","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"live_ended_at":{"format":"date-time","type":"number","x-stream-index":"011"},"live_started_at":{"format":"date-time","type":"number","x-stream-index":"010"},"missed_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"009"},"participants":{"items":{"$ref":"#/components/schemas/CallParticipantResponse"},"type":"array","x-stream-index":"004"},"participants_count_by_role":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"005"},"rejected_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"007"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002"},"timer_ends_at":{"format":"date-time","type":"number","x-stream-index":"012"}},"required":["id","participants","participants_count_by_role","anonymous_participant_count","rejected_by","accepted_by","missed_by"],"type":"object"},"CallSettings":{"properties":{"audio":{"$ref":"#/components/schemas/AudioSettings","x-stream-index":"001"},"backstage":{"$ref":"#/components/schemas/BackstageSettings","x-stream-index":"002"},"broadcasting":{"$ref":"#/components/schemas/BroadcastSettings","x-stream-index":"007"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordSettings","x-stream-index":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettings","x-stream-index":"008"},"ingress":{"$ref":"#/components/schemas/IngressSettings","x-stream-index":"014"},"limits":{"$ref":"#/components/schemas/LimitsSettings","x-stream-index":"012"},"recording":{"$ref":"#/components/schemas/RecordSettings","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettings","x-stream-index":"010"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettings","x-stream-index":"004"},"session":{"$ref":"#/components/schemas/SessionSettings","x-stream-index":"013"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettings","x-stream-index":"011"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettings","x-stream-index":"009"},"video":{"$ref":"#/components/schemas/VideoSettings","x-stream-index":"003"}},"type":"object"},"CallSettingsResponse":{"properties":{"audio":{"$ref":"#/components/schemas/AudioSettingsResponse","x-stream-index":"001"},"backstage":{"$ref":"#/components/schemas/BackstageSettingsResponse","x-stream-index":"002"},"broadcasting":{"$ref":"#/components/schemas/BroadcastSettingsResponse","x-stream-index":"003"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordingSettingsResponse","x-stream-index":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettingsResponse","x-stream-index":"004"},"ingress":{"$ref":"#/components/schemas/IngressSettingsResponse","x-stream-index":"014"},"limits":{"$ref":"#/components/schemas/LimitsSettingsResponse","x-stream-index":"012"},"recording":{"$ref":"#/components/schemas/RecordSettingsResponse","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettingsResponse","x-stream-index":"007"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettingsResponse","x-stream-index":"008"},"session":{"$ref":"#/components/schemas/SessionSettingsResponse","x-stream-index":"013"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettingsResponse","x-stream-index":"011"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettingsResponse","x-stream-index":"009"},"video":{"$ref":"#/components/schemas/VideoSettingsResponse","x-stream-index":"010"}},"required":["audio","backstage","broadcasting","geofencing","recording","frame_recording","ring","screensharing","transcription","video","thumbnails","limits","session"],"type":"object"},"CallType":{"properties":{"AppPK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"003"},"CreatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"005"},"ExternalStorage":{"type":"string","writeOnly":true,"x-stream-index":"009"},"Name":{"type":"string","writeOnly":true,"x-stream-index":"004"},"NotificationSettings":{"$ref":"#/components/schemas/NotificationSettings","x-stream-index":"008"},"PK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"002"},"Settings":{"$ref":"#/components/schemas/CallSettings","x-stream-index":"007"},"UpdatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"006"}},"required":["PK","AppPK","Name","CreatedAt","UpdatedAt","ExternalStorage"],"type":"object"},"Channel":{"properties":{"active_live_locations":{"items":{"$ref":"#/components/schemas/SharedLocation"},"type":"array","x-stream-index":"034"},"auto_translation_enabled":{"type":"boolean","x-stream-index":"029"},"auto_translation_language":{"type":"string","x-stream-index":"030"},"cid":{"type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/ChannelConfig","x-stream-index":"026"},"config_overrides":{"$ref":"#/components/schemas/ConfigOverrides","x-stream-index":"027"},"cooldown":{"format":"int32","type":"integer","x-stream-index":"031"},"created_at":{"format":"date-time","type":"number","x-stream-index":"009"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"019"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"disabled":{"type":"boolean","x-stream-index":"017"},"frozen":{"type":"boolean","x-stream-index":"016"},"id":{"type":"string","x-stream-index":"004"},"invites":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"022"},"last_campaigns":{"type":"string","x-stream-index":"032"},"last_message_at":{"format":"date-time","type":"number","x-stream-index":"006"},"member_count":{"format":"int32","type":"integer","x-stream-index":"021"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"020"},"message_count":{"format":"int64","type":"integer","x-stream-index":"035"},"message_count_updated_at":{"format":"date-time","type":"number","x-stream-index":"036"},"team":{"type":"string","x-stream-index":"028"},"truncated_by":{"$ref":"#/components/schemas/User","x-stream-index":"015"},"type":{"type":"string","x-stream-index":"005"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"010"}},"required":["cid","id","type","created_at","updated_at","frozen","disabled","custom","auto_translation_language"],"type":"object"},"ChannelConfig":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.027"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.022"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.023"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.028"},"blocklist":{"type":"string","x-stream-index":"001.024"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.025"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.026"},"commands":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"connect_events":{"type":"boolean","x-stream-index":"001.004"},"count_messages":{"type":"boolean","x-stream-index":"001.019"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"custom_events":{"type":"boolean","x-stream-index":"001.012"},"mark_messages_pending":{"type":"boolean","x-stream-index":"001.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"001.021"},"mutes":{"type":"boolean","x-stream-index":"001.009"},"name":{"type":"string","x-stream-index":"001.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"001.029"},"partition_ttl":{"type":"integer","x-stream-index":"001.030"},"polls":{"type":"boolean","x-stream-index":"001.016"},"push_notifications":{"type":"boolean","x-stream-index":"001.013"},"quotes":{"type":"boolean","x-stream-index":"001.008"},"reactions":{"type":"boolean","x-stream-index":"001.006"},"read_events":{"type":"boolean","x-stream-index":"001.003"},"reminders":{"type":"boolean","x-stream-index":"001.014"},"replies":{"type":"boolean","x-stream-index":"001.007"},"search":{"type":"boolean","x-stream-index":"001.005"},"shared_locations":{"type":"boolean","x-stream-index":"001.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.031"},"typing_events":{"type":"boolean","x-stream-index":"001.002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"002.004"},"uploads":{"type":"boolean","x-stream-index":"001.010"},"url_enrichment":{"type":"boolean","x-stream-index":"001.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"001.017"}},"required":["name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","count_messages","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","created_at","updated_at","commands"],"type":"object"},"ChannelConfigWithInfo":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.002.027"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.002.022"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.023"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.002.028"},"blocklist":{"type":"string","x-stream-index":"001.002.024"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.025"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.002.026"},"commands":{"items":{"$ref":"#/components/schemas/Command"},"type":"array","x-stream-index":"001.003"},"connect_events":{"type":"boolean","x-stream-index":"001.002.004"},"count_messages":{"type":"boolean","x-stream-index":"001.002.019"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.001.003"},"custom_events":{"type":"boolean","x-stream-index":"001.002.012"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"002"},"mark_messages_pending":{"type":"boolean","x-stream-index":"001.002.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"001.002.021"},"mutes":{"type":"boolean","x-stream-index":"001.002.009"},"name":{"type":"string","x-stream-index":"001.002.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"001.002.029"},"partition_ttl":{"type":"integer","x-stream-index":"001.002.030"},"polls":{"type":"boolean","x-stream-index":"001.002.016"},"push_notifications":{"type":"boolean","x-stream-index":"001.002.013"},"quotes":{"type":"boolean","x-stream-index":"001.002.008"},"reactions":{"type":"boolean","x-stream-index":"001.002.006"},"read_events":{"type":"boolean","x-stream-index":"001.002.003"},"reminders":{"type":"boolean","x-stream-index":"001.002.014"},"replies":{"type":"boolean","x-stream-index":"001.002.007"},"search":{"type":"boolean","x-stream-index":"001.002.005"},"shared_locations":{"type":"boolean","x-stream-index":"001.002.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.002.031"},"typing_events":{"type":"boolean","x-stream-index":"001.002.002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"uploads":{"type":"boolean","x-stream-index":"001.002.010"},"url_enrichment":{"type":"boolean","x-stream-index":"001.002.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"001.002.017"}},"required":["created_at","updated_at","name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","count_messages","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","commands"],"type":"object"},"ChannelMember":{"nullable":true,"properties":{"archived_at":{"format":"date-time","type":"number","x-stream-index":"021"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"017"},"banned":{"type":"boolean","x-stream-index":"016"},"channel_role":{"type":"string","x-stream-index":"024"},"created_at":{"format":"date-time","type":"number","x-stream-index":"012"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"014"},"deleted_messages":{"items":{"type":"string"},"type":"array","x-stream-index":"027"},"invite_accepted_at":{"format":"date-time","type":"number","x-stream-index":"009"},"invite_rejected_at":{"format":"date-time","type":"number","x-stream-index":"010"},"invited":{"type":"boolean","x-stream-index":"008"},"is_global_banned":{"type":"boolean","x-stream-index":"020"},"is_moderator":{"type":"boolean","x-stream-index":"007"},"notifications_muted":{"type":"boolean","x-stream-index":"026"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"022"},"shadow_banned":{"type":"boolean","x-stream-index":"019"},"status":{"type":"string","x-stream-index":"011"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"013"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["custom","created_at","updated_at","banned","shadow_banned","is_global_banned","channel_role","notifications_muted"],"type":"object"},"ChannelMute":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"007"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"expires":{"description":"Date/time of mute expiration","format":"date-time","title":"Expires","type":"number","x-stream-index":"008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/User","description":"Owner of channel mute","title":"User","x-stream-index":"005"}},"required":["created_at","updated_at"],"type":"object"},"ChannelResponse":{"properties":{"auto_translation_enabled":{"type":"boolean","x-stream-index":"021"},"auto_translation_language":{"type":"string","x-stream-index":"022"},"blocked":{"type":"boolean","x-stream-index":"027"},"cid":{"type":"string","x-stream-index":"005"},"config":{"$ref":"#/components/schemas/ChannelConfigWithInfo","x-stream-index":"017"},"cooldown":{"format":"int32","type":"integer","x-stream-index":"024"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"011"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"030"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"010"},"disabled":{"type":"boolean","x-stream-index":"013"},"frozen":{"type":"boolean","x-stream-index":"012"},"hidden":{"type":"boolean","x-stream-index":"026"},"hide_messages_before":{"format":"date-time","type":"number","x-stream-index":"023"},"id":{"type":"string","x-stream-index":"003"},"last_message_at":{"format":"date-time","type":"number","x-stream-index":"006"},"member_count":{"format":"int32","type":"integer","x-stream-index":"015"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"014"},"message_count":{"format":"int64","type":"integer","x-stream-index":"031"},"mute_expires_at":{"format":"date-time","type":"number","x-stream-index":"019"},"muted":{"type":"boolean","x-stream-index":"018"},"own_capabilities":{"items":{"type":"string"},"type":"array","x-stream-index":"025"},"team":{"type":"string","x-stream-index":"020"},"truncated_at":{"format":"date-time","type":"number","x-stream-index":"028"},"truncated_by":{"$ref":"#/components/schemas/User","x-stream-index":"029"},"type":{"type":"string","x-stream-index":"004"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"}},"required":["id","type","cid","created_at","updated_at","frozen","disabled","custom"],"type":"object"},"CheckRequest":{"nullable":true,"properties":{"config_key":{"description":"Key of the moderation configuration to use","title":"Config Key","type":"string","x-stream-index":"005"},"config_team":{"description":"Team associated with the configuration","title":"Config Team","type":"string","x-stream-index":"006"},"entity_creator_id":{"description":"ID of the user who created the entity","title":"Entity Creator ID","type":"string","x-stream-index":"003"},"entity_id":{"description":"Unique identifier of the entity to moderate","title":"Entity ID","type":"string","x-stream-index":"002"},"entity_type":{"description":"Type of entity to moderate","title":"Entity Type","type":"string","x-stream-index":"001"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content to be moderated","title":"Moderation Payload","x-stream-index":"004"},"options":{"additionalProperties":{},"description":"Additional moderation configuration options","title":"Options","type":"object","x-stream-index":"007"},"test_mode":{"description":"Whether to run moderation in test mode","title":"Test Mode","type":"boolean","x-stream-index":"008"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"009.002"},"user_id":{"type":"string","x-stream-index":"009.001"}},"required":["entity_type","entity_id","entity_creator_id"],"type":"object"},"CheckResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"005.001"},"item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"Review queue item (present if action != keep)","title":"Item","x-stream-index":"004"},"recommended_action":{"description":"Suggested action based on moderation results","title":"Recommended Action","type":"string","x-stream-index":"003"},"status":{"description":"Status of the moderation check (completed or pending)","title":"Status","type":"string","x-stream-index":"001"},"task_id":{"description":"ID of the running moderation task","title":"Task ID","type":"string","x-stream-index":"002"}},"required":["status","recommended_action","duration"],"type":"object"},"Command":{"description":"Represents custom chat command","nullable":true,"properties":{"args":{"description":"Arguments help text, shown in commands auto-completion","title":"Arguments","type":"string","x-stream-index":"006"},"created_at":{"description":"Date/time of creation","format":"date-time","readOnly":true,"title":"Created at","type":"number","x-stream-index":"001"},"description":{"description":"Description, shown in commands auto-completion","title":"Description","type":"string","x-stream-index":"005"},"name":{"description":"Unique command name","title":"Name","type":"string","x-stream-index":"004"},"set":{"description":"Set name used for grouping commands","title":"Set","type":"string","x-stream-index":"007"},"updated_at":{"description":"Date/time of the last update","format":"date-time","readOnly":true,"title":"Updated at","type":"number","x-stream-index":"002"}},"required":["name","description","args","set"],"title":"Command","type":"object"},"CompositeAppSettings":{"properties":{"json_encoded_settings":{"type":"string","x-stream-index":"005"},"url":{"type":"string","x-stream-index":"004"}},"type":"object"},"ConfigOverrides":{"properties":{"blocklist":{"type":"string","x-stream-index":"008"},"blocklist_behavior":{"enum":["flag","block"],"type":"string","x-stream-index":"009"},"commands":{"items":{"type":"string"},"type":"array","x-stream-index":"011"},"count_messages":{"type":"boolean","x-stream-index":"014"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"010"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"007"},"quotes":{"type":"boolean","x-stream-index":"004"},"reactions":{"type":"boolean","x-stream-index":"002"},"replies":{"type":"boolean","x-stream-index":"003"},"shared_locations":{"type":"boolean","x-stream-index":"013"},"typing_events":{"type":"boolean","x-stream-index":"001"},"uploads":{"type":"boolean","x-stream-index":"005"},"url_enrichment":{"type":"boolean","x-stream-index":"006"},"user_message_reminders":{"type":"boolean","x-stream-index":"012"}},"required":["grants","commands"],"type":"object"},"ConfigResponse":{"properties":{"ai_image_config":{"$ref":"#/components/schemas/AIImageConfig","description":"Configuration for AI image analysis","title":"AI Image Config","x-stream-index":"010"},"ai_text_config":{"$ref":"#/components/schemas/AITextConfig","description":"Configuration for AI text analysis","title":"AI Text Config","x-stream-index":"008"},"ai_video_config":{"$ref":"#/components/schemas/AIVideoConfig","description":"Configuration for AI video analysis","title":"AI Video Config","x-stream-index":"011"},"async":{"description":"Whether moderation should be performed asynchronously","title":"Async","type":"boolean","x-stream-index":"003"},"automod_platform_circumvention_config":{"$ref":"#/components/schemas/AutomodPlatformCircumventionConfig","description":"Configuration for platform circumvention detection","title":"Automod Platform Circumvention Config","x-stream-index":"005"},"automod_semantic_filters_config":{"$ref":"#/components/schemas/AutomodSemanticFiltersConfig","description":"Configuration for semantic filtering","title":"Automod Semantic Filters Config","x-stream-index":"006"},"automod_toxicity_config":{"$ref":"#/components/schemas/AutomodToxicityConfig","description":"Configuration for toxicity detection","title":"Automod Toxicity Config","x-stream-index":"004"},"block_list_config":{"$ref":"#/components/schemas/BlockListConfig","description":"Configuration for block list filtering","title":"Block List Config","x-stream-index":"007"},"created_at":{"description":"When the configuration was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"013"},"key":{"description":"Unique identifier for the moderation configuration","title":"Key","type":"string","x-stream-index":"001"},"llm_config":{"$ref":"#/components/schemas/LLMConfig","description":"Configuration for customer-configured LLM moderation","title":"LLM Config","x-stream-index":"009"},"team":{"description":"Team associated with the configuration","title":"Team","type":"string","x-stream-index":"002"},"updated_at":{"description":"When the configuration was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"014"},"velocity_filter_config":{"$ref":"#/components/schemas/VelocityFilterConfig","description":"Configuration for velocity-based filtering","title":"Velocity Filter Config","x-stream-index":"012"},"video_call_rule_config":{"$ref":"#/components/schemas/VideoCallRuleConfig","x-stream-index":"015"}},"required":["key","team","async","created_at","updated_at"],"type":"object"},"ContentCountRuleParameters":{"properties":{"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"type":"object"},"CustomActionRequest":{"properties":{"id":{"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"type":"object"},"CustomCheckFlag":{"properties":{"custom":{"additionalProperties":{},"description":"Additional metadata for the flag","title":"Custom","type":"object","x-stream-index":"003"},"labels":{"description":"Labels from various moderation sources","items":{"type":"string"},"title":"Labels","type":"array","x-stream-index":"004"},"reason":{"description":"Optional explanation for the flag","title":"Reason","type":"string","x-stream-index":"002"},"type":{"description":"Type of check (custom_check_text, custom_check_image, custom_check_video)","maxLength":255,"title":"Type","type":"string","x-stream-index":"001"}},"required":["type"],"type":"object"},"CustomCheckRequest":{"nullable":true,"properties":{"entity_creator_id":{"description":"ID of the user who created the entity (required for non-message entities)","title":"Entity Creator ID","type":"string","x-stream-index":"003"},"entity_id":{"description":"Unique identifier of the entity","title":"Entity ID","type":"string","x-stream-index":"002"},"entity_type":{"description":"Type of entity to perform custom check on","title":"Entity Type","type":"string","x-stream-index":"001"},"flags":{"description":"List of custom check flags (1-10 flags required)","items":{"$ref":"#/components/schemas/CustomCheckFlag"},"maximum":10,"minimum":1,"title":"Flags","type":"array","x-stream-index":"005"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content to be checked (required for non-message entities)","title":"Moderation Payload","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"006.002"},"user_id":{"type":"string","x-stream-index":"006.001"}},"required":["entity_type","entity_id","flags"],"type":"object"},"CustomCheckResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"004.001"},"id":{"description":"Unique identifier of the custom check","title":"ID","type":"string","x-stream-index":"001"},"item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"Review queue item details","title":"Item","x-stream-index":"002"},"status":{"description":"Status of the custom check","title":"Status","type":"string","x-stream-index":"003"}},"required":["id","status","duration"],"type":"object"},"Data":{"properties":{"id":{"type":"string","x-stream-index":"001"}},"required":["id"],"type":"object"},"DeleteActivityRequest":{"properties":{"hard_delete":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"DeleteMessageRequest":{"properties":{"hard_delete":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"DeleteModerationConfigResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"DeleteModerationRuleResponse":{"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"},"DeleteModerationTemplateResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"DeleteReactionRequest":{"properties":{"hard_delete":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"DeleteUserRequest":{"properties":{"delete_conversation_channels":{"type":"boolean","x-stream-index":"003"},"delete_feeds_content":{"type":"boolean","x-stream-index":"004"},"hard_delete":{"type":"boolean","x-stream-index":"001"},"mark_messages_deleted":{"type":"boolean","x-stream-index":"002"}},"type":"object"},"Device":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"disabled":{"type":"boolean","x-stream-index":"002.003"},"disabled_reason":{"type":"string","x-stream-index":"002.004"},"id":{"type":"string","x-stream-index":"002.001.004"},"push_provider":{"enum":["firebase","apn","huawei","xiaomi"],"type":"string","x-stream-index":"002.001.001"},"push_provider_name":{"type":"string","x-stream-index":"002.001.003"},"user_id":{"type":"string","x-stream-index":"004"},"voip":{"type":"boolean","x-stream-index":"002.001.005"}},"required":["push_provider","id","created_at","user_id"],"type":"object"},"DeviceResponse":{"description":"Response for Device","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"004"},"disabled":{"description":"Whether device is disabled or not","title":"Disabled","type":"boolean","x-stream-index":"005"},"disabled_reason":{"description":"Reason explaining why device had been disabled","title":"Reason","type":"string","x-stream-index":"006"},"id":{"description":"Device ID","title":"ID","type":"string","x-stream-index":"003"},"push_provider":{"description":"Push provider","title":"PushProvider","type":"string","x-stream-index":"001"},"push_provider_name":{"description":"Push provider name","title":"PushProviderName","type":"string","x-stream-index":"002"},"user_id":{"description":"User ID","title":"UserID","type":"string","x-stream-index":"008"},"voip":{"description":"When true the token is for Apple VoIP push notifications","title":"Voip","type":"boolean","x-stream-index":"007"}},"required":["push_provider","id","created_at","user_id"],"title":"DeviceResponse","type":"object"},"DraftPayloadResponse":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"html":{"type":"string","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"001"},"mentioned_users":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"008"},"mml":{"type":"string","x-stream-index":"003"},"parent_id":{"type":"string","x-stream-index":"005"},"poll_id":{"type":"string","x-stream-index":"013"},"quoted_message_id":{"type":"string","x-stream-index":"009"},"show_in_channel":{"type":"boolean","x-stream-index":"006"},"silent":{"type":"boolean","x-stream-index":"012"},"text":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"011"}},"required":["id","text","custom"],"type":"object"},"DraftResponse":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003"},"channel_cid":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"message":{"$ref":"#/components/schemas/DraftPayloadResponse","x-stream-index":"001"},"parent_id":{"type":"string","x-stream-index":"004"},"parent_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"005"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"006"}},"required":["message","channel_cid","created_at"],"type":"object"},"EgressHLSResponse":{"properties":{"playlist_url":{"type":"string","x-stream-index":"001"},"status":{"type":"string","x-stream-index":"002"}},"required":["playlist_url","status"],"type":"object"},"EgressRTMPResponse":{"properties":{"name":{"type":"string","x-stream-index":"001"},"started_at":{"format":"date-time","type":"number","x-stream-index":"004"},"stream_key":{"type":"string","x-stream-index":"003"},"stream_url":{"type":"string","x-stream-index":"002"}},"required":["name","started_at"],"type":"object"},"EgressResponse":{"properties":{"broadcasting":{"type":"boolean","x-stream-index":"001"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordingResponse","x-stream-index":"004"},"hls":{"$ref":"#/components/schemas/EgressHLSResponse","x-stream-index":"002"},"rtmps":{"items":{"$ref":"#/components/schemas/EgressRTMPResponse"},"type":"array","x-stream-index":"003"}},"required":["broadcasting","rtmps"],"type":"object"},"EgressTaskConfig":{"properties":{"egress_user":{"$ref":"#/components/schemas/EgressUser","x-stream-index":"008"},"frame_recording_egress_config":{"$ref":"#/components/schemas/FrameRecordingEgressConfig","x-stream-index":"009"},"hls_egress_config":{"$ref":"#/components/schemas/HLSEgressConfig","x-stream-index":"007"},"recording_egress_config":{"$ref":"#/components/schemas/RecordingEgressConfig","x-stream-index":"006"},"rtmp_egress_config":{"$ref":"#/components/schemas/RTMPEgressConfig","x-stream-index":"004"},"stt_egress_config":{"$ref":"#/components/schemas/STTEgressConfig","x-stream-index":"005"}},"type":"object"},"EgressUser":{"properties":{"token":{"type":"string","x-stream-index":"004"}},"type":"object"},"EnrichedActivity":{"properties":{"actor":{"$ref":"#/components/schemas/Data","x-stream-index":"002"},"foreign_id":{"type":"string","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"latest_reactions":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"013"},"object":{"$ref":"#/components/schemas/Data","x-stream-index":"004"},"origin":{"$ref":"#/components/schemas/Data","x-stream-index":"008"},"own_reactions":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"012"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"011"},"score":{"format":"float","type":"number","x-stream-index":"010"},"target":{"$ref":"#/components/schemas/Data","x-stream-index":"006"},"to":{"items":{"type":"string"},"type":"array","x-stream-index":"009"},"verb":{"type":"string","x-stream-index":"003"}},"type":"object"},"EnrichedReaction":{"nullable":true,"properties":{"activity_id":{"type":"string","x-stream-index":"003"},"children_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"010"},"created_at":{"$ref":"#/components/schemas/Time","x-stream-index":"012"},"data":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"kind":{"type":"string","x-stream-index":"002"},"latest_children":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"008"},"own_children":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"009"},"parent":{"type":"string","x-stream-index":"007"},"target_feeds":{"items":{"type":"string"},"type":"array","x-stream-index":"006"},"updated_at":{"$ref":"#/components/schemas/Time","x-stream-index":"013"},"user":{"$ref":"#/components/schemas/Data","x-stream-index":"011"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["kind","activity_id","user_id"],"type":"object"},"EntityCreator":{"properties":{"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"001.046"},"ban_count":{"format":"int32","type":"integer","x-stream-index":"002"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"001.017"},"banned":{"type":"boolean","x-stream-index":"001.016"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.013"},"deleted_content_count":{"format":"int32","type":"integer","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"001.023"},"language":{"type":"string","x-stream-index":"001.035"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"001.022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"001.026"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.042"},"role":{"type":"string","x-stream-index":"001.004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.005"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.009"}},"required":["id","role","teams_role","custom","banned","online","ban_count","deleted_content_count"],"type":"object"},"EntityCreatorResponse":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.001.018"},"ban_count":{"description":"Number of minor actions performed on the user","format":"int32","title":"Ban Count","type":"integer","x-stream-index":"002"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"001.003"},"banned":{"type":"boolean","x-stream-index":"001.001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.001.017"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.001.016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.001.011"},"deleted_content_count":{"description":"Number of major actions performed on the user","format":"int32","title":"Deleted Content Count","type":"integer","x-stream-index":"003"},"devices":{"items":{"$ref":"#/components/schemas/DeviceResponse"},"type":"array","x-stream-index":"001.006"},"flagged_count":{"description":"Number of flag actions performed on the user","format":"int32","title":"Flagged Count","type":"integer","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001.001.001"},"image":{"type":"string","x-stream-index":"001.001.003"},"invisible":{"type":"boolean","x-stream-index":"001.007"},"language":{"type":"string","x-stream-index":"001.001.005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"001.001.014"},"name":{"type":"string","x-stream-index":"001.001.002"},"online":{"type":"boolean","x-stream-index":"001.001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"001.005"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettingsResponse","x-stream-index":"001.004"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.001.015"},"role":{"type":"string","x-stream-index":"001.001.006"},"shadow_banned":{"type":"boolean","x-stream-index":"001.002"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.001.008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids","shadow_banned","invisible","ban_count","deleted_content_count","flagged_count"],"type":"object"},"EventNotificationSettings":{"properties":{"apns":{"$ref":"#/components/schemas/APNS","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"fcm":{"$ref":"#/components/schemas/FCM","x-stream-index":"003"}},"required":["enabled","apns","fcm"],"type":"object"},"ExternalStorage":{"properties":{"abs_account_name":{"type":"string","x-stream-index":"011"},"abs_client_id":{"type":"string","x-stream-index":"013"},"abs_client_secret":{"type":"string","x-stream-index":"014"},"abs_tenant_id":{"type":"string","x-stream-index":"012"},"bucket":{"type":"string","x-stream-index":"005"},"gcs_credentials":{"type":"string","x-stream-index":"010"},"path":{"type":"string","x-stream-index":"006"},"s3_api_key":{"type":"string","x-stream-index":"007"},"s3_custom_endpoint":{"type":"string","x-stream-index":"016"},"s3_region":{"type":"string","x-stream-index":"009"},"s3_secret_key":{"type":"string","x-stream-index":"008"},"storage_name":{"type":"string","x-stream-index":"015"},"storage_type":{"type":"integer","x-stream-index":"004"}},"type":"object"},"FCM":{"properties":{"data":{"additionalProperties":{},"type":"object","x-stream-index":"001"}},"type":"object"},"FeedsEventPreferences":{"properties":{"comments":{"type":"string","x-stream-index":"002"},"mentions":{"type":"string","x-stream-index":"004"},"new_followers":{"type":"string","x-stream-index":"003"},"reactions":{"type":"string","x-stream-index":"001"}},"type":"object"},"FeedsModerationTemplateConfig":{"properties":{"config_key":{"type":"string","x-stream-index":"002"},"data_types":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001"}},"required":["data_types","config_key"],"type":"object"},"Field":{"nullable":true,"properties":{"short":{"type":"boolean","x-stream-index":"003"},"title":{"type":"string","x-stream-index":"001"},"value":{"type":"string","x-stream-index":"002"}},"required":["title","value","short"],"type":"object"},"Flag":{"description":"Contains information about flagged user or message","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"019"},"custom":{"additionalProperties":{},"description":"Additional metadata about the flag","title":"Custom","type":"object","x-stream-index":"014"},"entity_creator_id":{"description":"ID of the user who created the flagged entity","title":"Entity Creator ID","type":"string","x-stream-index":"009"},"entity_id":{"description":"Unique identifier of the entity being flagged","title":"Entity ID","type":"string","x-stream-index":"008"},"entity_type":{"description":"Type of entity being flagged (e.g., message, user)","title":"Entity Type","type":"string","x-stream-index":"007"},"is_streamed_content":{"type":"boolean","x-stream-index":"012"},"labels":{"description":"Labels from bodyguard, API calls, our own AI etc","items":{"type":"string"},"title":"Labels","type":"array","x-stream-index":"015"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content being flagged","title":"Moderation Payload","x-stream-index":"010"},"moderation_payload_hash":{"type":"string","x-stream-index":"011"},"reason":{"description":"Optional explanation for why the content is being flagged","title":"Reason","type":"string","x-stream-index":"013"},"result":{"description":"Result of bodyguard, API calls, our own AI etc","items":{"additionalProperties":{},"type":"object"},"title":"Result","type":"array","x-stream-index":"016"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"018"},"review_queue_item_id":{"description":"ID of the review queue item","title":"Review Queue Item ID","type":"string","x-stream-index":"017"},"type":{"type":"string","x-stream-index":"004"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"020"},"user":{"$ref":"#/components/schemas/User","description":"User who flagged a message or a user","title":"User","x-stream-index":"006"}},"required":["entity_type","entity_id","result","created_at","updated_at"],"title":"Flag","type":"object"},"FlagContentOptions":{"properties":{"reason":{"type":"string","x-stream-index":"001"}},"type":"object"},"FlagRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"description":"Additional metadata about the flag","title":"Custom","type":"object","x-stream-index":"006"},"entity_creator_id":{"description":"ID of the user who created the flagged entity","title":"Entity Creator ID","type":"string","x-stream-index":"003"},"entity_id":{"description":"Unique identifier of the entity being flagged","title":"Entity ID","type":"string","x-stream-index":"002"},"entity_type":{"description":"Type of entity being flagged (e.g., message, user)","title":"Entity Type","type":"string","x-stream-index":"001"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content being flagged","title":"Moderation Payload","x-stream-index":"005"},"reason":{"description":"Optional explanation for why the content is being flagged","maxLength":255,"title":"Reason","type":"string","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"007.002"},"user_id":{"type":"string","x-stream-index":"007.001"}},"required":["entity_type","entity_id"],"type":"object"},"FlagResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"item_id":{"description":"Unique identifier of the created moderation item","title":"Item ID","type":"string","x-stream-index":"001"}},"required":["item_id","duration"],"type":"object"},"FlagUserOptions":{"properties":{"reason":{"type":"string","x-stream-index":"001"}},"type":"object"},"FrameRecordSettings":{"properties":{"capture_interval_in_seconds":{"format":"int32","maximum":60,"minimum":2,"type":"integer","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"},"quality":{"type":"string","x-stream-index":"002"}},"required":["mode","capture_interval_in_seconds"],"type":"object"},"FrameRecordingEgressConfig":{"properties":{"capture_interval_in_seconds":{"format":"int32","type":"integer","x-stream-index":"007"},"external_storage":{"$ref":"#/components/schemas/ExternalStorage","x-stream-index":"006"},"quality":{"$ref":"#/components/schemas/Quality","x-stream-index":"004"},"storage_name":{"type":"string","x-stream-index":"005"}},"type":"object"},"FrameRecordingResponse":{"properties":{"status":{"type":"string","x-stream-index":"001"}},"required":["status"],"type":"object"},"FrameRecordingSettingsResponse":{"properties":{"capture_interval_in_seconds":{"format":"int32","maximum":60,"minimum":2,"type":"integer","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"},"quality":{"type":"string","x-stream-index":"002"}},"required":["mode","capture_interval_in_seconds"],"type":"object"},"GeofenceSettings":{"properties":{"names":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"required":["names"],"type":"object"},"GeofenceSettingsResponse":{"properties":{"names":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"required":["names"],"type":"object"},"GetConfigResponse":{"nullable":true,"properties":{"config":{"$ref":"#/components/schemas/ConfigResponse","description":"The retrieved moderation configuration","title":"Config","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["duration"],"type":"object"},"GetModerationRuleResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"rule":{"$ref":"#/components/schemas/ModerationRuleV2Response","x-stream-index":"002"}},"required":["duration"],"title":"Response","type":"object"},"GetReviewQueueItemResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"Current state of the review queue item","title":"Item","x-stream-index":"001"}},"required":["duration"],"type":"object"},"GoogleVisionConfig":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"HLSEgressConfig":{"properties":{"composite_app_settings":{"$ref":"#/components/schemas/CompositeAppSettings","x-stream-index":"005"},"playlist_url":{"type":"string","x-stream-index":"007"},"qualities":{"items":{"$ref":"#/components/schemas/Quality"},"type":"array","x-stream-index":"004"},"start_unix_nano":{"format":"int64","type":"integer","x-stream-index":"006"}},"type":"object"},"HLSSettings":{"properties":{"auto_on":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"004"},"quality_tracks":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"required":["auto_on","enabled","quality_tracks"],"type":"object"},"HLSSettingsResponse":{"description":"HLSSettings is the payload for HLS settings","properties":{"auto_on":{"title":"Auto On","type":"boolean","x-stream-index":"001"},"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"002"},"layout":{"$ref":"#/components/schemas/LayoutSettingsResponse","title":"Layout","x-stream-index":"004"},"quality_tracks":{"items":{"type":"string"},"title":"Quality Tracks","type":"array","x-stream-index":"003"}},"required":["auto_on","enabled","quality_tracks","layout"],"title":"HLSSettingsResponse","type":"object"},"HarmConfig":{"properties":{"action_sequences":{"items":{"$ref":"#/components/schemas/ActionSequence"},"type":"array","x-stream-index":"001"},"severity":{"type":"integer","x-stream-index":"002"}},"required":["action_sequences","severity"],"type":"object"},"ImageContentParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"type":"object"},"ImageData":{"properties":{"frames":{"type":"string","x-stream-index":"005"},"height":{"type":"string","x-stream-index":"003"},"size":{"type":"string","x-stream-index":"004"},"url":{"type":"string","x-stream-index":"001"},"width":{"type":"string","x-stream-index":"002"}},"required":["url","width","height","size","frames"],"type":"object"},"ImageRuleParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"type":"object"},"Images":{"properties":{"fixed_height":{"$ref":"#/components/schemas/ImageData","x-stream-index":"002"},"fixed_height_downsampled":{"$ref":"#/components/schemas/ImageData","x-stream-index":"004"},"fixed_height_still":{"$ref":"#/components/schemas/ImageData","x-stream-index":"003"},"fixed_width":{"$ref":"#/components/schemas/ImageData","x-stream-index":"005"},"fixed_width_downsampled":{"$ref":"#/components/schemas/ImageData","x-stream-index":"007"},"fixed_width_still":{"$ref":"#/components/schemas/ImageData","x-stream-index":"006"},"original":{"$ref":"#/components/schemas/ImageData","x-stream-index":"001"}},"required":["original","fixed_height","fixed_height_still","fixed_height_downsampled","fixed_width","fixed_width_still","fixed_width_downsampled"],"type":"object"},"IngressAudioEncodingOptions":{"properties":{"bitrate":{"maximum":128000,"minimum":16000,"type":"integer","x-stream-index":"003"},"channels":{"enum":["1","2"],"format":"int32","type":"integer","x-stream-index":"001"},"enable_dtx":{"type":"boolean","x-stream-index":"002"}},"required":["channels","enable_dtx","bitrate"],"type":"object"},"IngressAudioEncodingResponse":{"properties":{"bitrate":{"format":"int32","type":"integer","x-stream-index":"003"},"channels":{"format":"int32","type":"integer","x-stream-index":"001"},"enable_dtx":{"type":"boolean","x-stream-index":"002"}},"required":["channels","enable_dtx","bitrate"],"type":"object"},"IngressSettings":{"properties":{"audio_encoding_options":{"$ref":"#/components/schemas/IngressAudioEncodingOptions","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"video_encoding_options":{"additionalProperties":{"$ref":"#/components/schemas/IngressVideoEncodingOptions"},"type":"object","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"IngressSettingsResponse":{"properties":{"audio_encoding_options":{"$ref":"#/components/schemas/IngressAudioEncodingResponse","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"video_encoding_options":{"additionalProperties":{"$ref":"#/components/schemas/IngressVideoEncodingResponse"},"type":"object","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"IngressVideoEncodingOptions":{"properties":{"layers":{"items":{"$ref":"#/components/schemas/IngressVideoLayer"},"minimum":1,"type":"array","x-stream-index":"001"}},"required":["layers"],"type":"object"},"IngressVideoEncodingResponse":{"properties":{"layers":{"items":{"$ref":"#/components/schemas/IngressVideoLayerResponse"},"type":"array","x-stream-index":"001"}},"required":["layers"],"type":"object"},"IngressVideoLayer":{"nullable":true,"properties":{"bitrate":{"minimum":1000,"type":"integer","x-stream-index":"002"},"codec":{"enum":["h264","vp8"],"type":"string","x-stream-index":"001"},"frame_rate":{"maximum":60,"minimum":1,"type":"integer","x-stream-index":"003"},"max_dimension":{"minimum":240,"type":"integer","x-stream-index":"005"},"min_dimension":{"minimum":240,"type":"integer","x-stream-index":"004"}},"required":["codec","bitrate","frame_rate","min_dimension","max_dimension"],"type":"object"},"IngressVideoLayerResponse":{"nullable":true,"properties":{"bitrate":{"type":"integer","x-stream-index":"002"},"codec":{"type":"string","x-stream-index":"001"},"frame_rate_limit":{"type":"integer","x-stream-index":"005"},"max_dimension":{"type":"integer","x-stream-index":"004"},"min_dimension":{"type":"integer","x-stream-index":"003"}},"required":["codec","bitrate","min_dimension","max_dimension","frame_rate_limit"],"type":"object"},"LLMConfig":{"properties":{"app_context":{"type":"string","x-stream-index":"005"},"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/LLMRule"},"type":"array","x-stream-index":"003"},"severity_descriptions":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"004"}},"required":["enabled","rules"],"type":"object"},"LLMRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove","keep"],"type":"string","x-stream-index":"003"},"description":{"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"},"severity_rules":{"items":{"$ref":"#/components/schemas/BodyguardSeverityRule"},"type":"array","x-stream-index":"004"}},"required":["label","description","action","severity_rules"],"type":"object"},"LabelThresholds":{"properties":{"block":{"format":"float","maximum":1,"minimum":0,"type":"number","x-stream-index":"002"},"flag":{"format":"float","maximum":1,"minimum":0,"type":"number","x-stream-index":"001"}},"type":"object"},"LayoutSettings":{"properties":{"detect_orientation":{"type":"boolean","x-stream-index":"005"},"external_app_url":{"type":"string","x-stream-index":"003"},"external_css_url":{"type":"string","x-stream-index":"004"},"name":{"enum":["spotlight","grid","single-participant","mobile","custom"],"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"required":["name","external_app_url","external_css_url"],"type":"object"},"LayoutSettingsResponse":{"properties":{"detect_orientation":{"type":"boolean","x-stream-index":"005"},"external_app_url":{"type":"string","x-stream-index":"003"},"external_css_url":{"type":"string","x-stream-index":"004"},"name":{"enum":["spotlight","grid","single-participant","mobile","custom"],"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"required":["name","external_app_url","external_css_url"],"type":"object"},"LimitsSettings":{"properties":{"max_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"004"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"},"max_participants_exclude_owner":{"type":"boolean","x-stream-index":"003"},"max_participants_exclude_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"002"}},"required":["max_participants_exclude_roles"],"type":"object"},"LimitsSettingsResponse":{"properties":{"max_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"004"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"},"max_participants_exclude_owner":{"type":"boolean","x-stream-index":"003"},"max_participants_exclude_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"002"}},"required":["max_participants_exclude_roles"],"type":"object"},"MarkReviewedRequest":{"properties":{"content_to_mark_as_reviewed_limit":{"format":"int32","maximum":2500,"type":"integer","x-stream-index":"002"},"disable_marking_content_as_reviewed":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"MemberLookup":{"properties":{"Limit":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"001"}},"required":["Limit"],"type":"object"},"Message":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"012"},"before_message_send_failed":{"type":"boolean","x-stream-index":"046"},"cid":{"type":"string","x-stream-index":"028"},"command":{"type":"string","x-stream-index":"006"},"created_at":{"format":"date-time","type":"number","x-stream-index":"030"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"034"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"033"},"deleted_for_me":{"type":"boolean","x-stream-index":"059"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"023"},"html":{"type":"string","x-stream-index":"007"},"i18n":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"044"},"id":{"type":"string","x-stream-index":"002"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"040"},"latest_reactions":{"items":{"$ref":"#/components/schemas/Reaction"},"type":"array","x-stream-index":"013"},"mentioned_users":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"043"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"052"},"mml":{"type":"string","x-stream-index":"005"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"056"},"own_reactions":{"items":{"$ref":"#/components/schemas/Reaction"},"type":"array","x-stream-index":"014"},"parent_id":{"type":"string","x-stream-index":"019"},"pin_expires":{"format":"date-time","type":"number","x-stream-index":"051"},"pinned":{"type":"boolean","x-stream-index":"047"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"048"},"pinned_by":{"$ref":"#/components/schemas/User","x-stream-index":"050"},"poll":{"$ref":"#/components/schemas/Poll","x-stream-index":"054"},"poll_id":{"type":"string","x-stream-index":"053"},"quoted_message":{"$ref":"#/components/schemas/Message","x-stream-index":"025"},"quoted_message_id":{"type":"string","x-stream-index":"024"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"015"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"017"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"016"},"reminder":{"$ref":"#/components/schemas/MessageReminder","x-stream-index":"058"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"022"},"restricted_visibility":{"items":{"type":"string"},"type":"array","x-stream-index":"011"},"shadowed":{"type":"boolean","x-stream-index":"036"},"shared_location":{"$ref":"#/components/schemas/SharedLocation","x-stream-index":"055"},"show_in_channel":{"type":"boolean","x-stream-index":"021"},"silent":{"type":"boolean","x-stream-index":"045"},"text":{"type":"string","x-stream-index":"004"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"027"},"type":{"type":"string","x-stream-index":"008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"031"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"010"}},"required":["id","text","html","type","restricted_visibility","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reaction_groups","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned"],"type":"object"},"MessageReminder":{"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"004"},"channel_cid":{"type":"string","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"011"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"006"},"message_id":{"type":"string","x-stream-index":"005"},"remind_at":{"format":"date-time","type":"number","x-stream-index":"009"},"task_id":{"type":"string","x-stream-index":"010"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"012"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"user_id":{"type":"string","x-stream-index":"007"}},"required":["channel_cid","message_id","user_id","task_id","created_at","updated_at"],"type":"object"},"MessageResponse":{"description":"Represents any chat message","properties":{"attachments":{"description":"Array of message attachments","items":{"$ref":"#/components/schemas/Attachment"},"title":"Message attachments","type":"array","x-stream-docs-page-id":"message_format#attachment-format","x-stream-index":"008"},"cid":{"description":"Channel unique identifier in \u003ctype\u003e:\u003cid\u003e format","title":"Channel CID","type":"string","x-stream-index":"022"},"command":{"description":"Contains provided slash command","title":"Command","type":"string","x-stream-docs-page-id":"custom_commands_webhook","x-stream-index":"004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"023"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"026"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"025"},"deleted_for_me":{"type":"boolean","x-stream-index":"044"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"018"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"041"},"html":{"description":"Contains HTML markup of the message. Can only be set when using server-side API","title":"HTML content","type":"string","x-stream-index":"005"},"i18n":{"additionalProperties":{"type":"string"},"description":"Object with translations. Key `language` contains the original language key. Other keys contain translations","title":"Internationalization info","type":"object","x-stream-docs-page-id":"translation","x-stream-index":"030"},"id":{"description":"Message ID is unique string identifier of the message","title":"ID","type":"string","x-stream-index":"001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"Contains image moderation information","title":"Image moderation labels","type":"object","x-stream-index":"028"},"latest_reactions":{"description":"List of 10 latest reactions to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Latest reactions","type":"array","x-stream-index":"009"},"mentioned_users":{"description":"List of mentioned users","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Mentioned Users","type":"array","x-stream-index":"029"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"036"},"mml":{"description":"Should be empty if `text` is provided. Can only be set when using server-side API","title":"Messaging Markup Language","type":"string","x-stream-docs-page-id":"mml_overview","x-stream-index":"003"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"039"},"own_reactions":{"description":"List of 10 latest reactions of authenticated user to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Own reactions","type":"array","x-stream-index":"010"},"parent_id":{"description":"ID of parent message (thread)","title":"Parent message ID","type":"string","x-stream-docs-page-id":"threads","x-stream-index":"015"},"pin_expires":{"description":"Date when pinned message expires","format":"date-time","title":"Pin expiration date","type":"number","x-stream-docs-page-id":"pinned_messages","x-stream-index":"035"},"pinned":{"description":"Whether message is pinned or not","title":"Pinned","type":"boolean","x-stream-docs-page-id":"pinned_messages","x-stream-index":"032"},"pinned_at":{"description":"Date when message got pinned","format":"date-time","title":"Pinned at","type":"number","x-stream-docs-page-id":"pinned_messages","x-stream-index":"033"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","description":"Contains user who pinned the message","title":"Pinned by","x-stream-docs-page-id":"pinned_messages","x-stream-index":"034"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"038"},"poll_id":{"description":"Identifier of the poll to include in the message","title":"Poll ID","type":"string","x-stream-index":"037"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","description":"Contains quoted message","title":"Quoted message","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"020"},"quoted_message_id":{"title":"ID of quoted message","type":"string","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"019"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing number of reactions of each type. Key: reaction type (string), value: number of reactions (int)","title":"Reaction counts","type":"object","x-stream-index":"011"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"014"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing scores of reactions of each type. Key: reaction type (string), value: total score of reactions (int)","title":"Reaction scores","type":"object","x-stream-index":"012"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"042"},"reply_count":{"description":"Number of replies to this message","format":"int32","title":"Reply count","type":"integer","x-stream-index":"017"},"restricted_visibility":{"description":"A list of user ids that have restricted visibility to the message, if the list is not empty, the message is only visible to the users in the list","items":{"type":"string"},"title":"Restricted visibility","type":"array","x-stream-index":"040"},"shadowed":{"description":"Whether the message was shadowed or not","title":"Shadowed","type":"boolean","x-stream-docs-page-id":"moderation#shadow-ban","x-stream-index":"027"},"shared_location":{"$ref":"#/components/schemas/SharedLocationResponseData","description":"Contains shared location data","title":"Shared Location","x-stream-index":"043"},"show_in_channel":{"description":"Whether thread reply should be shown in the channel as well","title":"Show in channel","type":"boolean","x-stream-docs-page-id":"threads","x-stream-index":"016"},"silent":{"description":"Whether message is silent or not","title":"Silent","type":"boolean","x-stream-index":"031"},"text":{"description":"Text of the message. Should be empty if `mml` is provided","title":"Text","type":"string","x-stream-index":"002"},"thread_participants":{"description":"List of users who participate in thread","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Thread participants","type":"array","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"021"},"type":{"description":"Contains type of the message","enum":["regular","ephemeral","error","reply","system","deleted"],"title":"Message Type","type":"string","x-stream-docs-page-id":"message_format#message-types","x-stream-index":"006"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"024"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Sender of the message. Required when using server-side API","title":"User object","x-stream-index":"007"}},"required":["id","text","html","type","user","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned","restricted_visibility"],"title":"Message","type":"object","x-stream-docs-page-id":"send_message"},"ModerationActionConfig":{"nullable":true,"properties":{"action":{"type":"string","x-stream-index":"006"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"009"},"description":{"type":"string","x-stream-index":"008"},"entity_type":{"type":"string","x-stream-index":"004"},"icon":{"type":"string","x-stream-index":"007"},"order":{"format":"int32","type":"integer","x-stream-index":"005"}},"required":["entity_type","order","action","icon","description","custom"],"type":"object"},"ModerationCheckCompletedEvent":{"description":"This event is sent when a moderation check is completed","nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"entity_id":{"description":"The ID of entity which was moderated","title":"EntityID","type":"string","x-stream-index":"002"},"entity_type":{"description":"The type of the entity which was moderated","title":"EntityType","type":"string","x-stream-index":"003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"recommended_action":{"description":"The recommended action","title":"RecommendedAction","type":"string","x-stream-index":"004"},"review_queue_item_id":{"description":"The review queue item ID","title":"ReviewQueueItemID","type":"string","x-stream-index":"005"},"type":{"default":"moderation_check.completed","type":"string","x-stream-index":"001.002"}},"required":["type","created_at","custom","entity_id","entity_type","recommended_action","review_queue_item_id"],"title":"ModerationCheckCompletedEvent","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"},"ModerationCustomActionEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"001"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"002"},"type":{"default":"moderation.custom_action","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationCustomActionEvent","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"},"ModerationFlagResponse":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"015"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"entity_creator_id":{"type":"string","x-stream-index":"007"},"entity_id":{"type":"string","x-stream-index":"006"},"entity_type":{"type":"string","x-stream-index":"005"},"labels":{"items":{"type":"string"},"type":"array","x-stream-index":"011"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"008"},"reason":{"type":"string","x-stream-index":"009"},"result":{"items":{"additionalProperties":{},"type":"object"},"type":"array","x-stream-index":"012"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","x-stream-index":"014"},"review_queue_item_id":{"type":"string","x-stream-index":"013"},"type":{"type":"string","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"016"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"004"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["type","user_id","entity_type","entity_id","result","created_at","updated_at"],"type":"object"},"ModerationFlaggedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"item":{"type":"string","x-stream-index":"001"},"object_id":{"type":"string","x-stream-index":"002"},"type":{"default":"moderation.flagged","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationFlaggedEvent","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"},"ModerationMarkReviewedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"001"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"002"},"type":{"default":"moderation.mark_reviewed","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationMarkReviewedEvent","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"},"ModerationPayload":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"images":{"items":{"type":"string"},"maximum":30,"type":"array","x-stream-index":"002"},"texts":{"items":{"type":"string"},"type":"array","x-stream-index":"001"},"videos":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"type":"object"},"ModerationRuleV2Response":{"properties":{"action":{"$ref":"#/components/schemas/RuleBuilderAction","x-stream-index":"010"},"conditions":{"items":{"$ref":"#/components/schemas/RuleBuilderCondition"},"type":"array","x-stream-index":"007"},"config_keys":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"cooldown_period":{"type":"string","x-stream-index":"011"},"created_at":{"format":"date-time","type":"number","x-stream-index":"013"},"description":{"type":"string","x-stream-index":"003"},"enabled":{"type":"boolean","x-stream-index":"012"},"groups":{"items":{"$ref":"#/components/schemas/RuleBuilderConditionGroup"},"type":"array","x-stream-index":"009"},"id":{"type":"string","x-stream-index":"001"},"logic":{"type":"string","x-stream-index":"008"},"name":{"type":"string","x-stream-index":"002"},"rule_type":{"type":"string","x-stream-index":"006"},"team":{"type":"string","x-stream-index":"005"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"014"}},"required":["id","name","description","config_keys","team","rule_type","action","enabled","created_at","updated_at"],"type":"object"},"ModerationV2Response":{"properties":{"action":{"type":"string","x-stream-index":"001"},"blocklist_matched":{"type":"string","x-stream-index":"005"},"image_harms":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"original_text":{"type":"string","x-stream-index":"002"},"platform_circumvented":{"type":"boolean","x-stream-index":"007"},"semantic_filter_matched":{"type":"string","x-stream-index":"006"},"text_harms":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"required":["action","original_text"],"type":"object"},"MuteRequest":{"nullable":true,"properties":{"target_ids":{"description":"User IDs to mute (if multiple users)","items":{"type":"string"},"title":"Target IDs","type":"array","x-stream-index":"001"},"timeout":{"description":"Duration of mute in minutes","minimum":0,"title":"Timeout","type":"integer","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"required":["target_ids"],"title":"MuteRequest","type":"object"},"MuteResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"004.001"},"mutes":{"description":"Object with mutes (if multiple users were muted)","items":{"$ref":"#/components/schemas/UserMute"},"title":"Mutes","type":"array","x-stream-index":"001"},"non_existing_users":{"description":"A list of users that can't be found. Common cause for this is deleted users","items":{"type":"string"},"title":"Non Existing Users","type":"array","x-stream-index":"003"},"own_user":{"$ref":"#/components/schemas/OwnUser","description":"Authorized user object with fresh mutes information","title":"Own User","x-stream-index":"002"}},"required":["duration"],"title":"MuteResponse","type":"object"},"NoiseCancellationSettings":{"properties":{"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode"],"type":"object"},"NotificationSettings":{"properties":{"call_live_started":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"002"},"call_missed":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"006"},"call_notification":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"004"},"call_ring":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"session_started":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"003"}},"required":["enabled","call_live_started","session_started","call_notification","call_ring","call_missed"],"type":"object"},"NullTime":{"type":"object"},"OCRRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"}},"required":["label","action"],"type":"object"},"OwnUser":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"046"},"banned":{"type":"boolean","x-stream-index":"016"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"045"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"029"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"014"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"013"},"devices":{"items":{"$ref":"#/components/schemas/Device"},"type":"array","x-stream-index":"027"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"023"},"language":{"type":"string","x-stream-index":"035"},"last_active":{"format":"date-time","type":"number","x-stream-index":"011"},"last_engaged_at":{"format":"date-time","type":"number","x-stream-index":"012"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"037"},"mutes":{"items":{"$ref":"#/components/schemas/UserMute"},"type":"array","x-stream-index":"028"},"online":{"type":"boolean","x-stream-index":"022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"026"},"push_preferences":{"$ref":"#/components/schemas/PushPreferences","x-stream-index":"025"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"005"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"031"},"total_unread_count_by_team":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"032"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"033"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"030"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"034"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"}},"required":["id","role","custom","created_at","updated_at","banned","online","devices","mutes","channel_mutes","unread_count","total_unread_count","total_unread_count_by_team","unread_channels","unread_threads","language"],"type":"object"},"Poll":{"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"023"},"allow_answers":{"type":"boolean","x-stream-index":"010"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"009"},"answers_count":{"format":"int32","type":"integer","x-stream-index":"015"},"created_at":{"format":"date-time","type":"number","x-stream-index":"021"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"020"},"created_by_id":{"type":"string","x-stream-index":"019"},"description":{"type":"string","x-stream-index":"005"},"enforce_unique_vote":{"type":"boolean","x-stream-index":"007"},"id":{"type":"string","x-stream-index":"003"},"is_closed":{"type":"boolean","x-stream-index":"011"},"latest_answers":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array","x-stream-index":"017"},"latest_votes_by_option":{"additionalProperties":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array"},"type":"object","x-stream-index":"016"},"max_votes_allowed":{"format":"int32","type":"integer","x-stream-index":"008"},"name":{"type":"string","x-stream-index":"004"},"options":{"items":{"$ref":"#/components/schemas/PollOption"},"type":"array","x-stream-index":"013"},"own_votes":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array","x-stream-index":"018"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"022"},"vote_count":{"format":"int32","type":"integer","x-stream-index":"012"},"vote_counts_by_option":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"014"},"voting_visibility":{"type":"string","x-stream-index":"006"}},"required":["id","name","description","enforce_unique_vote","allow_user_suggested_options","allow_answers","vote_count","options","vote_counts_by_option","answers_count","latest_votes_by_option","latest_answers","own_votes","created_by_id","created_at","updated_at","Custom"],"type":"object"},"PollOption":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id","text","custom"],"type":"object"},"PollOptionResponseData":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id","text","custom"],"type":"object"},"PollResponseData":{"properties":{"allow_answers":{"type":"boolean","x-stream-index":"008"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"007"},"answers_count":{"format":"int32","type":"integer","x-stream-index":"012"},"created_at":{"format":"date-time","type":"number","x-stream-index":"019"},"created_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"018"},"created_by_id":{"type":"string","x-stream-index":"017"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"021"},"description":{"type":"string","x-stream-index":"003"},"enforce_unique_vote":{"type":"boolean","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"is_closed":{"type":"boolean","x-stream-index":"009"},"latest_answers":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array","x-stream-index":"015"},"latest_votes_by_option":{"additionalProperties":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array"},"type":"object","x-stream-index":"014"},"max_votes_allowed":{"format":"int32","type":"integer","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"002"},"options":{"items":{"$ref":"#/components/schemas/PollOptionResponseData"},"type":"array","x-stream-index":"011"},"own_votes":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array","x-stream-index":"016"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"020"},"vote_count":{"format":"int32","type":"integer","x-stream-index":"010"},"vote_counts_by_option":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"013"},"voting_visibility":{"type":"string","x-stream-index":"004"}},"required":["id","name","description","voting_visibility","enforce_unique_vote","allow_user_suggested_options","allow_answers","vote_count","options","answers_count","vote_counts_by_option","latest_votes_by_option","latest_answers","own_votes","created_by_id","created_at","updated_at","custom"],"type":"object"},"PollVote":{"nullable":true,"properties":{"answer_text":{"type":"string","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"004"},"is_answer":{"type":"boolean","x-stream-index":"006"},"option_id":{"type":"string","x-stream-index":"005"},"poll_id":{"type":"string","x-stream-index":"003"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"011"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"009"},"user_id":{"type":"string","x-stream-index":"008"}},"required":["poll_id","id","option_id","created_at","updated_at"],"type":"object"},"PollVoteResponseData":{"nullable":true,"properties":{"answer_text":{"type":"string","x-stream-index":"005"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"id":{"type":"string","x-stream-index":"002"},"is_answer":{"type":"boolean","x-stream-index":"004"},"option_id":{"type":"string","x-stream-index":"003"},"poll_id":{"type":"string","x-stream-index":"001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"007"},"user_id":{"type":"string","x-stream-index":"006"}},"required":["poll_id","id","option_id","created_at","updated_at"],"type":"object"},"PrivacySettings":{"properties":{"read_receipts":{"$ref":"#/components/schemas/ReadReceipts","x-stream-index":"002"},"typing_indicators":{"$ref":"#/components/schemas/TypingIndicators","x-stream-index":"001"}},"type":"object"},"PrivacySettingsResponse":{"properties":{"read_receipts":{"$ref":"#/components/schemas/ReadReceiptsResponse","x-stream-index":"002"},"typing_indicators":{"$ref":"#/components/schemas/TypingIndicatorsResponse","x-stream-index":"001"}},"type":"object"},"PushNotificationSettingsResponse":{"properties":{"disabled":{"type":"boolean","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"number","x-stream-index":"002"}},"type":"object"},"PushPreferences":{"properties":{"call_level":{"type":"string","x-stream-index":"002"},"chat_level":{"type":"string","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"number","x-stream-index":"005"},"feeds_events":{"$ref":"#/components/schemas/FeedsEventPreferences","x-stream-index":"004"},"feeds_level":{"type":"string","x-stream-index":"003"}},"type":"object"},"Quality":{"properties":{"bitdepth":{"format":"int32","type":"integer","x-stream-index":"007"},"framerate":{"format":"int32","type":"integer","x-stream-index":"008"},"height":{"format":"int32","type":"integer","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"004"},"video_bitrate":{"format":"int32","type":"integer","x-stream-index":"009"},"width":{"format":"int32","type":"integer","x-stream-index":"005"}},"type":"object"},"QueryFeedModerationTemplate":{"properties":{"config":{"$ref":"#/components/schemas/FeedsModerationTemplateConfig","description":"Configuration for the moderation template","title":"Config","x-stream-index":"002"},"created_at":{"description":"When the template was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"003"},"name":{"description":"Name of the moderation template","title":"Name","type":"string","x-stream-index":"001"},"updated_at":{"description":"When the template was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"004"}},"required":["name","created_at","updated_at"],"type":"object"},"QueryFeedModerationTemplatesResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"templates":{"description":"List of moderation templates","items":{"$ref":"#/components/schemas/QueryFeedModerationTemplate"},"title":"Templates","type":"array","x-stream-index":"001"}},"required":["templates","duration"],"type":"object"},"QueryModerationConfigsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter conditions for moderation configs","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"Sorting parameters for the results","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"type":"object"},"QueryModerationConfigsResponse":{"nullable":true,"properties":{"configs":{"description":"List of moderation configurations","items":{"$ref":"#/components/schemas/ConfigResponse"},"title":"Configs","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["configs","duration"],"type":"object"},"QueryModerationFlagsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParam"},"type":"array","x-stream-index":"002"}},"type":"object"},"QueryModerationFlagsResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"flags":{"items":{"$ref":"#/components/schemas/ModerationFlagResponse"},"type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["flags","duration"],"title":"Response","type":"object"},"QueryModerationLogsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter conditions for moderation logs","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"Sorting parameters for the results","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"type":"object"},"QueryModerationLogsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"003.001"},"logs":{"description":"List of moderation action logs","items":{"$ref":"#/components/schemas/ActionLogResponse"},"title":"Logs","type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["logs","duration"],"type":"object"},"QueryModerationRulesRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter conditions for moderation rules","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"Sorting parameters for the results","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"type":"object"},"QueryModerationRulesResponse":{"nullable":true,"properties":{"default_llm_labels":{"additionalProperties":{"type":"string"},"description":"Default LLM label descriptions","title":"DefaultLLMLabels","type":"object","x-stream-index":"002"},"duration":{"type":"string","x-stream-index":"004.001"},"next":{"type":"string","x-stream-index":"003.001"},"prev":{"type":"string","x-stream-index":"003.002"},"rules":{"description":"List of moderation rules","items":{"$ref":"#/components/schemas/ModerationRuleV2Response"},"title":"Rules","type":"array","x-stream-index":"001"}},"required":["rules","default_llm_labels","duration"],"type":"object"},"QueryReviewQueueRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter conditions for review queue items","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"007.001"},"lock_count":{"description":"Number of items to lock (1-25)","format":"int32","maximum":25,"minimum":1,"title":"Lock Count","type":"integer","x-stream-index":"005"},"lock_duration":{"description":"Duration for which items should be locked","title":"Lock Duration","type":"integer","x-stream-index":"004"},"lock_items":{"description":"Whether to lock items for review (true), unlock items (false), or just fetch (nil)","title":"Lock Items","type":"boolean","x-stream-index":"003"},"next":{"type":"string","x-stream-index":"007.002"},"prev":{"type":"string","x-stream-index":"007.003"},"sort":{"description":"Sorting parameters for the results","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"002"},"stats_only":{"description":"Whether to return only statistics","title":"Stats Only","type":"boolean","x-stream-index":"006"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"008.002"},"user_id":{"type":"string","x-stream-index":"008.001"}},"type":"object"},"QueryReviewQueueResponse":{"nullable":true,"properties":{"action_config":{"additionalProperties":{"items":{"$ref":"#/components/schemas/ModerationActionConfig"},"type":"array"},"description":"Configuration for moderation actions","title":"Action Config","type":"object","x-stream-index":"002"},"duration":{"type":"string","x-stream-index":"005.001"},"items":{"description":"List of review queue items","items":{"$ref":"#/components/schemas/ReviewQueueItemResponse"},"title":"Items","type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"004.001"},"prev":{"type":"string","x-stream-index":"004.002"},"stats":{"additionalProperties":{},"description":"Statistics about the review queue","title":"Stats","type":"object","x-stream-index":"003"}},"required":["items","action_config","stats","duration"],"type":"object"},"RTMPEgressConfig":{"properties":{"composite_app_settings":{"$ref":"#/components/schemas/CompositeAppSettings","x-stream-index":"005"},"quality":{"$ref":"#/components/schemas/Quality","x-stream-index":"004"},"rtmp_location":{"type":"string","x-stream-index":"006"}},"type":"object"},"RTMPIngress":{"description":"RTMP input settings","properties":{"address":{"title":"Address","type":"string","x-stream-index":"001"}},"required":["address"],"title":"RTMPIngress","type":"object"},"RTMPLocation":{"properties":{"name":{"type":"string","x-stream-index":"001"},"stream_key":{"type":"string","x-stream-index":"003"},"stream_url":{"type":"string","x-stream-index":"002"}},"required":["name","stream_url","stream_key"],"type":"object"},"RTMPSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"003"},"location":{"$ref":"#/components/schemas/RTMPLocation","x-stream-index":"004"},"quality_name":{"type":"string","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"RTMPSettingsResponse":{"description":"RTMPSettingsResponse is the payload for RTMP settings","properties":{"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettingsResponse","title":"Layout","x-stream-index":"003"},"quality":{"title":"Quality","type":"string","x-stream-index":"002"}},"required":["enabled","quality","layout"],"title":"RTMPSettingsResponse","type":"object"},"Reaction":{"nullable":true,"properties":{"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"message_id":{"type":"string","x-stream-index":"003"},"score":{"format":"int32","type":"integer","x-stream-index":"007"},"type":{"maxLength":30,"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["message_id","type","score","created_at","updated_at","custom"],"type":"object"},"ReactionGroupResponse":{"description":"ReactionGroupResponse contains all information about a reaction of the same type.","nullable":true,"properties":{"count":{"description":"Count is the number of reactions of this type.","format":"int32","title":"Count","type":"integer","x-stream-index":"001"},"first_reaction_at":{"description":"FirstReactionAt is the time of the first reaction of this type. This is the same also if all reaction of this type are deleted, because if someone will react again with the same type, will be preserved the sorting.","format":"date-time","title":"FirstReactionAt","type":"number","x-stream-index":"003"},"last_reaction_at":{"description":"LastReactionAt is the time of the last reaction of this type.","format":"date-time","title":"LastReactionAt","type":"number","x-stream-index":"004"},"sum_scores":{"description":"SumScores is the sum of all scores of reactions of this type. Medium allows you to clap articles more than once and shows the sum of all claps from all users. For example, you can send `clap` x5 using `score: 5`.","format":"int32","title":"SumScores","type":"integer","x-stream-index":"002"}},"required":["count","sum_scores","first_reaction_at","last_reaction_at"],"title":"ReactionGroupResponse","type":"object"},"ReactionResponse":{"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"006"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"008"},"message_id":{"description":"Message ID","title":"Message ID","type":"string","x-stream-index":"001"},"score":{"description":"Score of the reaction","format":"int32","title":"Score","type":"integer","x-stream-index":"005"},"type":{"description":"Type of reaction","title":"Type","type":"string","x-stream-index":"004"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"007"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User","title":"UserResponse","x-stream-index":"003"},"user_id":{"description":"User ID","title":"User ID","type":"string","x-stream-index":"002"}},"required":["message_id","user_id","user","type","score","created_at","updated_at","custom"],"type":"object"},"ReadReceipts":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"ReadReceiptsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"RecordSettings":{"properties":{"audio_only":{"type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"004"},"mode":{"type":"string","x-stream-index":"002"},"quality":{"type":"string","x-stream-index":"003"}},"required":["mode"],"type":"object"},"RecordSettingsResponse":{"description":"RecordSettings is the payload for recording settings","properties":{"audio_only":{"title":"Audio Only","type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettingsResponse","title":"Layout","x-stream-index":"004"},"mode":{"title":"Mode","type":"string","x-stream-index":"002"},"quality":{"title":"Quality","type":"string","x-stream-index":"003"}},"required":["audio_only","mode","quality","layout"],"title":"RecordSettingsResponse","type":"object"},"RecordingEgressConfig":{"properties":{"audio_only":{"type":"boolean","x-stream-index":"006"},"composite_app_settings":{"$ref":"#/components/schemas/CompositeAppSettings","x-stream-index":"005"},"external_storage":{"$ref":"#/components/schemas/ExternalStorage","x-stream-index":"008"},"quality":{"$ref":"#/components/schemas/Quality","x-stream-index":"004"},"storage_name":{"type":"string","x-stream-index":"007"},"video_orientation_hint":{"$ref":"#/components/schemas/VideoOrientation","x-stream-index":"009"}},"type":"object"},"ReminderResponseData":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003"},"channel_cid":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"005"},"message_id":{"type":"string","x-stream-index":"004"},"remind_at":{"format":"date-time","type":"number","x-stream-index":"001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007"},"user_id":{"type":"string","x-stream-index":"006"}},"required":["channel_cid","message_id","user_id","created_at","updated_at"],"type":"object"},"RestoreActionRequest":{"type":"object"},"ReviewQueueItem":{"properties":{"actions":{"items":{"$ref":"#/components/schemas/ActionLog"},"type":"array","x-stream-index":"035"},"activity":{"$ref":"#/components/schemas/EnrichedActivity","x-stream-index":"028"},"ai_text_severity":{"type":"string","x-stream-index":"021"},"archived_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"043"},"assigned_to":{"$ref":"#/components/schemas/User","x-stream-index":"032"},"bans":{"items":{"$ref":"#/components/schemas/Ban"},"type":"array","x-stream-index":"033"},"bounce_count":{"format":"int32","type":"integer","x-stream-index":"025"},"call":{"$ref":"#/components/schemas/Call","x-stream-index":"031"},"completed_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"018"},"config_key":{"type":"string","x-stream-index":"009"},"content_changed":{"type":"boolean","x-stream-index":"036"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"entity_creator":{"$ref":"#/components/schemas/EntityCreator","x-stream-index":"030"},"entity_id":{"type":"string","x-stream-index":"007"},"entity_type":{"type":"string","x-stream-index":"006"},"feeds_v2_activity":{"$ref":"#/components/schemas/EnrichedActivity","x-stream-index":"041"},"feeds_v2_reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"042"},"flag_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"045"},"flag_types":{"items":{"type":"string"},"type":"array","x-stream-index":"044"},"flags":{"items":{"$ref":"#/components/schemas/Flag"},"type":"array","x-stream-index":"034"},"flags_count":{"format":"int32","type":"integer","x-stream-index":"026"},"has_image":{"type":"boolean","x-stream-index":"012"},"has_text":{"type":"boolean","x-stream-index":"014"},"has_video":{"type":"boolean","x-stream-index":"013"},"id":{"type":"string","x-stream-index":"003"},"languages":{"items":{"type":"string"},"type":"array","x-stream-index":"019"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"027"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"010"},"moderation_payload_hash":{"type":"string","x-stream-index":"011"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"029"},"recommended_action":{"type":"string","x-stream-index":"017"},"reporter_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"046"},"reviewed_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"022"},"reviewed_by":{"type":"string","x-stream-index":"023"},"severity":{"format":"int32","type":"integer","x-stream-index":"020"},"status":{"type":"string","x-stream-index":"016"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"015"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"005"}},"required":["id","created_at","updated_at","entity_type","entity_id","config_key","moderation_payload_hash","has_image","has_video","has_text","teams","status","recommended_action","completed_at","languages","severity","ai_text_severity","reviewed_at","reviewed_by","bounce_count","flags_count","bans","flags","actions","content_changed","archived_at","flag_types","flag_labels","reporter_ids"],"type":"object"},"ReviewQueueItemNewEvent":{"description":"This event is sent when a new moderation review queue item is created","nullable":true,"properties":{"action":{"$ref":"#/components/schemas/ActionLogResponse","description":"The action log if any action was taken","title":"Action","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"flags":{"description":"The flags associated with this review queue item","items":{"$ref":"#/components/schemas/ModerationFlagResponse"},"title":"Flags","type":"array","x-stream-index":"003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"The review queue item that was created","title":"ReviewQueueItem","x-stream-index":"002"},"type":{"default":"review_queue_item.new","type":"string","x-stream-index":"001.002"}},"required":["type","created_at","custom"],"title":"ReviewQueueItemNewEvent","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"},"ReviewQueueItemResponse":{"properties":{"actions":{"description":"Moderation actions taken","items":{"$ref":"#/components/schemas/ActionLogResponse"},"title":"Actions","type":"array","x-stream-index":"024"},"activity":{"$ref":"#/components/schemas/EnrichedActivity","x-stream-index":"016"},"ai_text_severity":{"description":"AI-determined text severity","title":"AI Text Severity","type":"string","x-stream-index":"014"},"assigned_to":{"$ref":"#/components/schemas/UserResponse","description":"Moderator assigned to review this item","title":"Assigned To","x-stream-index":"021"},"bans":{"description":"Associated ban records","items":{"$ref":"#/components/schemas/Ban"},"title":"Bans","type":"array","x-stream-index":"022"},"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"018"},"completed_at":{"description":"When the review was completed","format":"date-time","title":"Completed At","type":"number","x-stream-index":"009"},"config_key":{"type":"string","x-stream-index":"028"},"created_at":{"description":"When the item was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"002"},"entity_creator":{"$ref":"#/components/schemas/EntityCreatorResponse","description":"Details about who created the entity","title":"Entity Creator","x-stream-index":"019"},"entity_creator_id":{"description":"ID of who created the entity","title":"Entity Creator ID","type":"string","x-stream-index":"020"},"entity_id":{"description":"ID of the entity being reviewed","title":"Entity ID","type":"string","x-stream-index":"005"},"entity_type":{"description":"Type of entity being reviewed","title":"Entity Type","type":"string","x-stream-index":"004"},"feeds_v2_activity":{"$ref":"#/components/schemas/EnrichedActivity","description":"Associated feed activity","title":"Feeds V2 Activity","x-stream-index":"025"},"feeds_v2_reaction":{"$ref":"#/components/schemas/Reaction","description":"Associated feed reaction","title":"Feeds V2 Reaction","x-stream-index":"026"},"flags":{"description":"Associated flag records","items":{"$ref":"#/components/schemas/ModerationFlagResponse"},"title":"Flags","type":"array","x-stream-index":"023"},"flags_count":{"format":"int32","type":"integer","x-stream-index":"029"},"id":{"description":"Unique identifier of the review queue item","title":"ID","type":"string","x-stream-index":"001"},"languages":{"description":"Detected languages in the content","items":{"type":"string"},"title":"Languages","type":"array","x-stream-index":"012"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Associated message details","title":"Message","x-stream-index":"015"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content being moderated","title":"Moderation Payload","x-stream-index":"006"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"017"},"recommended_action":{"description":"Suggested moderation action","title":"Recommended Action","type":"string","x-stream-index":"008"},"reviewed_at":{"description":"When the item was reviewed","format":"date-time","title":"Reviewed At","type":"number","x-stream-index":"010"},"reviewed_by":{"description":"ID of the moderator who reviewed the item","title":"Reviewed By","type":"string","x-stream-index":"011"},"severity":{"description":"Severity level of the content","format":"int32","title":"Severity","type":"integer","x-stream-index":"013"},"status":{"description":"Current status of the review","title":"Status","type":"string","x-stream-index":"007"},"teams":{"description":"Teams associated with this item","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"027"},"updated_at":{"description":"When the item was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"003"}},"required":["id","created_at","updated_at","entity_type","entity_id","status","recommended_action","reviewed_by","languages","severity","ai_text_severity","bans","flags","actions","flags_count"],"type":"object"},"ReviewQueueItemUpdatedEvent":{"description":"This event is sent when a moderation review queue item is updated","nullable":true,"properties":{"action":{"$ref":"#/components/schemas/ActionLogResponse","description":"The action log if any action was taken","title":"Action","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"flags":{"description":"The flags associated with this review queue item","items":{"$ref":"#/components/schemas/ModerationFlagResponse"},"title":"Flags","type":"array","x-stream-index":"003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"The review queue item that was updated","title":"ReviewQueueItem","x-stream-index":"002"},"type":{"default":"review_queue_item.updated","type":"string","x-stream-index":"001.002"}},"required":["type","created_at","custom"],"title":"ReviewQueueItemUpdatedEvent","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"},"RingSettings":{"properties":{"auto_cancel_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_timeout_ms","missed_call_timeout_ms"],"type":"object"},"RingSettingsResponse":{"properties":{"auto_cancel_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_timeout_ms","missed_call_timeout_ms"],"type":"object"},"RuleBuilderAction":{"properties":{"ban_options":{"$ref":"#/components/schemas/BanOptions","x-stream-index":"002"},"flag_content_options":{"$ref":"#/components/schemas/FlagContentOptions","x-stream-index":"004"},"flag_user_options":{"$ref":"#/components/schemas/FlagUserOptions","x-stream-index":"003"},"remove_content_options":{"$ref":"#/components/schemas/BlockContentOptions","x-stream-index":"005"},"type":{"type":"string","x-stream-index":"001"}},"type":"object"},"RuleBuilderCondition":{"properties":{"confidence":{"format":"float","type":"number","x-stream-index":"002"},"content_count_rule_params":{"$ref":"#/components/schemas/ContentCountRuleParameters","x-stream-index":"007"},"image_content_params":{"$ref":"#/components/schemas/ImageContentParameters","x-stream-index":"009"},"image_rule_params":{"$ref":"#/components/schemas/ImageRuleParameters","x-stream-index":"004"},"text_content_params":{"$ref":"#/components/schemas/TextContentParameters","x-stream-index":"008"},"text_rule_params":{"$ref":"#/components/schemas/TextRuleParameters","x-stream-index":"003"},"type":{"type":"string","x-stream-index":"001"},"user_created_within_params":{"$ref":"#/components/schemas/UserCreatedWithinParameters","x-stream-index":"011"},"user_custom_property_params":{"$ref":"#/components/schemas/UserCustomPropertyParameters","x-stream-index":"012"},"user_rule_params":{"$ref":"#/components/schemas/UserRuleParameters","x-stream-index":"006"},"video_content_params":{"$ref":"#/components/schemas/VideoContentParameters","x-stream-index":"010"},"video_rule_params":{"$ref":"#/components/schemas/VideoRuleParameters","x-stream-index":"005"}},"type":"object"},"RuleBuilderConditionGroup":{"properties":{"conditions":{"items":{"$ref":"#/components/schemas/RuleBuilderCondition"},"type":"array","x-stream-index":"002"},"logic":{"type":"string","x-stream-index":"001"}},"type":"object"},"RuleBuilderConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"rules":{"items":{"$ref":"#/components/schemas/RuleBuilderRule"},"type":"array","x-stream-index":"002"}},"type":"object"},"RuleBuilderRule":{"properties":{"action":{"$ref":"#/components/schemas/RuleBuilderAction","x-stream-index":"006"},"conditions":{"items":{"$ref":"#/components/schemas/RuleBuilderCondition"},"type":"array","x-stream-index":"003"},"cooldown_period":{"type":"string","x-stream-index":"007"},"groups":{"items":{"$ref":"#/components/schemas/RuleBuilderConditionGroup"},"type":"array","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"logic":{"type":"string","x-stream-index":"004"},"rule_type":{"type":"string","x-stream-index":"002"}},"required":["rule_type","action"],"type":"object"},"SFUIDLastSeen":{"properties":{"id":{"type":"string","x-stream-index":"001.001"},"last_seen":{"format":"date-time","type":"number","x-stream-index":"002"},"process_start_time":{"format":"int64","type":"integer","x-stream-index":"001.002"}},"required":["id","process_start_time","last_seen"],"type":"object"},"STTEgressConfig":{"properties":{"closed_captions_enabled":{"type":"boolean","x-stream-index":"005"},"external_storage":{"$ref":"#/components/schemas/ExternalStorage","x-stream-index":"011"},"language":{"type":"string","x-stream-index":"008"},"storage_name":{"type":"string","x-stream-index":"010"},"translation_languages":{"items":{"type":"string"},"type":"array","x-stream-index":"009"},"translations_enabled":{"type":"boolean","x-stream-index":"006"},"upload_transcriptions":{"type":"boolean","x-stream-index":"004"},"whisper_server_base_url":{"type":"string","x-stream-index":"007"}},"type":"object"},"ScreensharingSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled"],"type":"object"},"ScreensharingSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled"],"type":"object"},"SessionSettings":{"properties":{"inactivity_timeout_seconds":{"format":"int32","maximum":900,"minimum":5,"type":"integer","x-stream-index":"001"}},"required":["inactivity_timeout_seconds"],"type":"object"},"SessionSettingsResponse":{"properties":{"inactivity_timeout_seconds":{"format":"int32","maximum":900,"minimum":5,"type":"integer","x-stream-index":"001"}},"required":["inactivity_timeout_seconds"],"type":"object"},"ShadowBlockActionRequest":{"type":"object"},"SharedLocation":{"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"013"},"channel_cid":{"type":"string","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"010"},"created_by_device_id":{"type":"string","x-stream-index":"008"},"end_at":{"format":"date-time","type":"number","x-stream-index":"009"},"latitude":{"format":"float","maximum":90,"minimum":18446744073709552000,"type":"number","x-stream-index":"006"},"longitude":{"format":"float","maximum":180,"minimum":18446744073709552000,"type":"number","x-stream-index":"007"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"012"},"message_id":{"type":"string","x-stream-index":"004"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"011"},"user_id":{"type":"string","x-stream-index":"005"}},"required":["channel_cid","message_id","user_id","created_by_device_id","created_at","updated_at"],"type":"object"},"SharedLocationResponseData":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"011"},"channel_cid":{"type":"string","x-stream-index":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"created_by_device_id":{"type":"string","x-stream-index":"006"},"end_at":{"format":"date-time","type":"number","x-stream-index":"007"},"latitude":{"format":"float","type":"number","x-stream-index":"004"},"longitude":{"format":"float","type":"number","x-stream-index":"005"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"010"},"message_id":{"type":"string","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["channel_cid","message_id","user_id","latitude","longitude","created_by_device_id","created_at","updated_at"],"type":"object"},"SortParam":{"nullable":true,"properties":{"direction":{"format":"int32","type":"integer","x-stream-index":"002"},"field":{"type":"string","x-stream-index":"001"}},"type":"object"},"SortParamRequest":{"nullable":true,"properties":{"direction":{"description":"Direction of sorting, 1 for Ascending, -1 for Descending, default is 1","format":"int32","title":"Direction","type":"integer","x-stream-index":"002"},"field":{"description":"Name of field to sort by","title":"Field","type":"string","x-stream-index":"001"}},"type":"object"},"SubmitActionRequest":{"nullable":true,"properties":{"action_type":{"description":"Type of moderation action to perform (mark_reviewed, delete_message, etc.)","enum":["mark_reviewed","delete_message","delete_activity","delete_reaction","ban","custom","unban","restore","delete_user","unblock","shadow_block","unmask","kick_user","end_call"],"title":"Action Type","type":"string","x-stream-index":"002"},"ban":{"$ref":"#/components/schemas/BanActionRequest","description":"Configuration for ban action","title":"Ban","x-stream-index":"008"},"custom":{"$ref":"#/components/schemas/CustomActionRequest","description":"Configuration for custom action","title":"Custom","x-stream-index":"009"},"delete_activity":{"$ref":"#/components/schemas/DeleteActivityRequest","description":"Configuration for activity deletion action","title":"Delete Activity","x-stream-index":"004"},"delete_message":{"$ref":"#/components/schemas/DeleteMessageRequest","description":"Configuration for message deletion action","title":"Delete Message","x-stream-index":"003"},"delete_reaction":{"$ref":"#/components/schemas/DeleteReactionRequest","description":"Configuration for reaction deletion action","title":"Delete Reaction","x-stream-index":"005"},"delete_user":{"$ref":"#/components/schemas/DeleteUserRequest","description":"Configuration for user deletion action","title":"Delete User","x-stream-index":"006"},"item_id":{"description":"UUID of the review queue item to act on","title":"Item ID","type":"string","x-stream-index":"001"},"mark_reviewed":{"$ref":"#/components/schemas/MarkReviewedRequest","description":"Configuration for marking item as reviewed","title":"Mark Reviewed","x-stream-index":"007"},"unban":{"$ref":"#/components/schemas/UnbanActionRequest","description":"Configuration for unban action","title":"Unban","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"016.002"},"user_id":{"type":"string","x-stream-index":"016.001"}},"required":["item_id","action_type"],"type":"object"},"SubmitActionResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"Updated review queue item after action was performed","title":"Item","x-stream-index":"001"}},"required":["duration"],"type":"object"},"TargetResolution":{"properties":{"bitrate":{"format":"int32","maximum":6000000,"type":"integer","x-stream-index":"003"},"height":{"format":"int32","maximum":3840,"minimum":240,"type":"integer","x-stream-index":"002"},"width":{"format":"int32","maximum":3840,"minimum":240,"type":"integer","x-stream-index":"001"}},"required":["width","height","bitrate"],"type":"object"},"TextContentParameters":{"properties":{"blocklist_match":{"items":{"type":"string"},"type":"array","x-stream-index":"005"},"contains_url":{"type":"boolean","x-stream-index":"003"},"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001"},"llm_harm_labels":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"002"},"severity":{"type":"string","x-stream-index":"004"}},"type":"object"},"TextRuleParameters":{"properties":{"blocklist_match":{"items":{"type":"string"},"type":"array","x-stream-index":"007"},"contains_url":{"type":"boolean","x-stream-index":"005"},"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"llm_harm_labels":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"004"},"severity":{"type":"string","x-stream-index":"006"},"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"type":"object"},"Thresholds":{"properties":{"explicit":{"$ref":"#/components/schemas/LabelThresholds","x-stream-index":"001"},"spam":{"$ref":"#/components/schemas/LabelThresholds","x-stream-index":"002"},"toxic":{"$ref":"#/components/schemas/LabelThresholds","x-stream-index":"003"}},"type":"object"},"ThumbnailResponse":{"properties":{"image_url":{"type":"string","x-stream-index":"001"}},"required":["image_url"],"type":"object"},"ThumbnailsSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"ThumbnailsSettingsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"Time":{"type":"object"},"TranscriptionSettings":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"title":"Mode","type":"string","x-stream-index":"002"},"language":{"description":"The language used in this call as a two letter code","enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"title":"Language","type":"string","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"title":"Mode","type":"string","x-stream-index":"001"}},"required":["mode","closed_caption_mode","languages","language"],"type":"object"},"TranscriptionSettingsResponse":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"002"},"language":{"enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"type":"string","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode","closed_caption_mode","languages","language"],"type":"object"},"TypingIndicators":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"TypingIndicatorsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"UnbanActionRequest":{"type":"object"},"UnbanRequest":{"nullable":true,"properties":{"unbanned_by":{"$ref":"#/components/schemas/UserRequest","description":"Details about the user performing the unban","title":"Unbanned By","x-stream-index":"005"},"unbanned_by_id":{"description":"ID of the user performing the unban","title":"Unbanned By ID","type":"string","x-stream-index":"004"}},"type":"object"},"UnbanResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"UnblockActionRequest":{"type":"object"},"UnmuteRequest":{"nullable":true,"properties":{"target_ids":{"description":"User IDs to unmute","items":{"type":"string"},"title":"Target IDs","type":"array","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"002.002"},"user_id":{"type":"string","x-stream-index":"002.001"}},"required":["target_ids"],"title":"UnmuteRequest","type":"object"},"UnmuteResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"non_existing_users":{"description":"A list of users that can't be found. Common cause for this is deleted users","items":{"type":"string"},"title":"Non Existing Users","type":"array","x-stream-index":"001"}},"required":["duration"],"title":"UnmuteResponse","type":"object"},"UpsertConfigRequest":{"nullable":true,"properties":{"ai_image_config":{"$ref":"#/components/schemas/AIImageConfig","description":"Configuration for AI image analysis","title":"AI Image Config","x-stream-index":"011"},"ai_text_config":{"$ref":"#/components/schemas/AITextConfig","description":"Configuration for AI text analysis","title":"AI Text Config","x-stream-index":"008"},"ai_video_config":{"$ref":"#/components/schemas/AIVideoConfig","description":"Configuration for AI video analysis","title":"AI Video Config","x-stream-index":"012"},"async":{"description":"Whether moderation should be performed asynchronously","title":"Async","type":"boolean","x-stream-index":"003"},"automod_platform_circumvention_config":{"$ref":"#/components/schemas/AutomodPlatformCircumventionConfig","description":"Configuration for platform circumvention detection","title":"Automod Platform Circumvention Config","x-stream-index":"005"},"automod_semantic_filters_config":{"$ref":"#/components/schemas/AutomodSemanticFiltersConfig","description":"Configuration for semantic filtering","title":"Automod Semantic Filters Config","x-stream-index":"006"},"automod_toxicity_config":{"$ref":"#/components/schemas/AutomodToxicityConfig","description":"Configuration for toxicity detection","title":"Automod Toxicity Config","x-stream-index":"004"},"aws_rekognition_config":{"$ref":"#/components/schemas/AIImageConfig","x-stream-index":"016"},"block_list_config":{"$ref":"#/components/schemas/BlockListConfig","description":"Configuration for block list filtering","title":"Block List Config","x-stream-index":"007"},"bodyguard_config":{"$ref":"#/components/schemas/AITextConfig","x-stream-index":"015"},"google_vision_config":{"$ref":"#/components/schemas/GoogleVisionConfig","description":"Configuration for Google Vision integration","title":"Google Vision Config","x-stream-index":"010"},"key":{"description":"Unique identifier for the moderation configuration","title":"Key","type":"string","x-stream-index":"001"},"llm_config":{"$ref":"#/components/schemas/LLMConfig","description":"Configuration for customer-configured LLM moderation","title":"LLM Config","x-stream-index":"009"},"rule_builder_config":{"$ref":"#/components/schemas/RuleBuilderConfig","description":"Configuration for custom rule builder (max 3 rules, max 5 conditions per rule)","title":"Rule Builder Config","x-stream-index":"014"},"team":{"description":"Team associated with the configuration","maxLength":128,"minLength":1,"title":"Team","type":"string","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"018.002"},"user_id":{"type":"string","x-stream-index":"018.001"},"velocity_filter_config":{"$ref":"#/components/schemas/VelocityFilterConfig","description":"Configuration for velocity-based filtering","title":"Velocity Filter Config","x-stream-index":"013"},"video_call_rule_config":{"$ref":"#/components/schemas/VideoCallRuleConfig","x-stream-index":"017"}},"required":["key"],"type":"object"},"UpsertConfigResponse":{"nullable":true,"properties":{"config":{"$ref":"#/components/schemas/ConfigResponse","description":"The created or updated moderation configuration","title":"Config","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["duration"],"type":"object"},"UpsertModerationRuleRequest":{"nullable":true,"properties":{"action":{"$ref":"#/components/schemas/RuleBuilderAction","x-stream-index":"009"},"conditions":{"items":{"$ref":"#/components/schemas/RuleBuilderCondition"},"type":"array","x-stream-index":"006"},"config_keys":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"cooldown_period":{"type":"string","x-stream-index":"010"},"description":{"type":"string","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"011"},"groups":{"items":{"$ref":"#/components/schemas/RuleBuilderConditionGroup"},"type":"array","x-stream-index":"008"},"logic":{"type":"string","x-stream-index":"007"},"name":{"type":"string","x-stream-index":"001"},"rule_type":{"type":"string","x-stream-index":"005"},"team":{"type":"string","x-stream-index":"004"}},"required":["name","rule_type","action"],"type":"object"},"UpsertModerationRuleResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"rule":{"$ref":"#/components/schemas/ModerationRuleV2Response","x-stream-index":"002"}},"required":["duration"],"title":"Response","type":"object"},"UpsertModerationTemplateRequest":{"nullable":true,"properties":{"config":{"$ref":"#/components/schemas/FeedsModerationTemplateConfig","description":"Configuration for the moderation template","title":"Config","x-stream-index":"002"},"name":{"description":"Name of the moderation template","title":"Name","type":"string","x-stream-index":"001"}},"required":["name","config"],"type":"object"},"UpsertModerationTemplateResponse":{"nullable":true,"properties":{"config":{"$ref":"#/components/schemas/FeedsModerationTemplateConfig","description":"Configuration for the moderation template","title":"Config","x-stream-index":"002"},"created_at":{"description":"When the template was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"003"},"duration":{"type":"string","x-stream-index":"005.001"},"name":{"description":"Name of the moderation template","title":"Name","type":"string","x-stream-index":"001"},"updated_at":{"description":"When the template was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"004"}},"required":["name","created_at","updated_at","duration"],"type":"object"},"User":{"properties":{"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"046"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"017"},"banned":{"type":"boolean","x-stream-index":"016"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"013"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"023"},"language":{"type":"string","x-stream-index":"035"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"026"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"042"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"005"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"009"}},"required":["id","role","teams_role","custom","banned","online"],"type":"object"},"UserCreatedWithinParameters":{"properties":{"max_age":{"type":"string","x-stream-index":"001"}},"type":"object"},"UserCustomPropertyParameters":{"properties":{"operator":{"type":"string","x-stream-index":"002"},"property_key":{"type":"string","x-stream-index":"001"}},"type":"object"},"UserMute":{"nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"expires":{"description":"Date/time of mute expiration","format":"date-time","title":"Expires","type":"number","x-stream-index":"008"},"target":{"$ref":"#/components/schemas/User","description":"User who's muted","title":"Target","x-stream-index":"007"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/User","description":"Owner of channel mute","title":"User","x-stream-index":"005"}},"required":["created_at","updated_at"],"type":"object"},"UserRequest":{"description":"User request object","properties":{"custom":{"additionalProperties":{},"description":"Custom user data","title":"Custom","type":"object","x-stream-index":"004"},"id":{"description":"User ID","title":"ID","type":"string","x-stream-index":"001"},"image":{"description":"User's profile image URL","title":"Image","type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"006"},"language":{"type":"string","x-stream-index":"005"},"name":{"description":"Optional name of user","title":"Name","type":"string","x-stream-index":"002"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"007"},"role":{"description":"User's global role","title":"Role","type":"string","x-stream-index":"008"},"teams":{"description":"List of teams the user belongs to","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"010"},"teams_role":{"additionalProperties":{"type":"string"},"description":"Map of team-specific roles for the user","title":"TeamsRole","type":"object","x-stream-index":"009"}},"required":["id"],"title":"UserRequest","type":"object"},"UserResponse":{"description":"User response object","properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"ban_expires":{"description":"Date when ban expires","format":"date-time","title":"Ban expires","type":"number","x-stream-index":"003"},"banned":{"description":"Whether a user is banned or not","title":"Banned","type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.017"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"001.004"},"deactivated_at":{"description":"Date of deactivation","format":"date-time","title":"Deactivated at","type":"number","x-stream-index":"001.016"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"001.011"},"devices":{"description":"List of devices user is using","items":{"$ref":"#/components/schemas/DeviceResponse"},"title":"Devices","type":"array","x-stream-index":"006"},"id":{"description":"Unique user identifier","title":"ID","type":"string","x-stream-index":"001.001"},"image":{"title":"Image","type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"007"},"language":{"description":"Preferred language of a user","title":"Language","type":"string","x-stream-index":"001.005"},"last_active":{"description":"Date of last activity","format":"date-time","title":"Last active","type":"number","x-stream-index":"001.014"},"name":{"description":"Optional name of user","title":"Name","type":"string","x-stream-index":"001.002"},"online":{"description":"Whether a user online or not","title":"Online","type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","description":"User privacy settings","title":"Privacy settings","x-stream-index":"005"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettingsResponse","description":"User push notification settings","title":"Push notifications","x-stream-index":"004"},"revoke_tokens_issued_before":{"description":"Revocation date for tokens","format":"date-time","title":"Revoke tokens issued before","type":"number","x-stream-index":"001.015"},"role":{"description":"Determines the set of user permissions","title":"Role","type":"string","x-stream-index":"001.006"},"shadow_banned":{"description":"Whether a user is shadow banned","title":"Shadow banned","type":"boolean","x-stream-index":"002"},"teams":{"description":"List of teams user is a part of","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids","shadow_banned","invisible"],"title":"UserResponse","type":"object"},"UserRuleParameters":{"properties":{"max_age":{"type":"string","x-stream-index":"001"}},"type":"object"},"VelocityFilterConfig":{"properties":{"advanced_filters":{"type":"boolean","x-stream-index":"007"},"async":{"type":"boolean","x-stream-index":"001"},"cascading_actions":{"type":"boolean","x-stream-index":"004"},"cids_per_user":{"format":"int32","type":"integer","x-stream-index":"006"},"enabled":{"type":"boolean","x-stream-index":"002"},"first_message_only":{"type":"boolean","x-stream-index":"005"},"rules":{"items":{"$ref":"#/components/schemas/VelocityFilterConfigRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules","cascading_actions","first_message_only","cids_per_user","advanced_filters"],"type":"object"},"VelocityFilterConfigRule":{"properties":{"action":{"enum":["flag","shadow","remove","ban"],"type":"string","x-stream-index":"001"},"ban_duration":{"format":"int32","type":"integer","x-stream-index":"002"},"cascading_action":{"enum":["flag","shadow","remove","ban"],"type":"string","x-stream-index":"006"},"cascading_threshold":{"format":"int64","type":"integer","x-stream-index":"005"},"check_message_context":{"type":"boolean","x-stream-index":"009"},"fast_spam_threshold":{"format":"int32","type":"integer","x-stream-index":"007"},"fast_spam_ttl":{"format":"int32","type":"integer","x-stream-index":"010"},"ip_ban":{"type":"boolean","x-stream-index":"004"},"probation_period":{"format":"int32","type":"integer","x-stream-index":"014"},"shadow_ban":{"type":"boolean","x-stream-index":"003"},"slow_spam_ban_duration":{"format":"int32","type":"integer","x-stream-index":"012"},"slow_spam_threshold":{"format":"int32","type":"integer","x-stream-index":"008"},"slow_spam_ttl":{"format":"int32","type":"integer","x-stream-index":"011"},"url_only":{"type":"boolean","x-stream-index":"013"}},"required":["action","ban_duration","shadow_ban","ip_ban","cascading_threshold","cascading_action","fast_spam_threshold","slow_spam_threshold","check_message_context","fast_spam_ttl","slow_spam_ttl","url_only","probation_period"],"type":"object"},"VideoCallRuleConfig":{"properties":{"rules":{"additionalProperties":{"$ref":"#/components/schemas/HarmConfig"},"type":"object","x-stream-index":"001"}},"required":["rules"],"type":"object"},"VideoContentParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"type":"object"},"VideoEndCallRequest":{"type":"object"},"VideoKickUserRequest":{"type":"object"},"VideoOrientation":{"properties":{"orientation":{"type":"integer","x-stream-index":"004"}},"type":"object"},"VideoRuleParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"type":"object"},"VideoSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"camera_default_on":{"type":"boolean","x-stream-index":"004"},"camera_facing":{"enum":["front","back","external"],"type":"string","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled","target_resolution","camera_default_on","camera_facing"],"type":"object"},"VideoSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"camera_default_on":{"type":"boolean","x-stream-index":"004"},"camera_facing":{"enum":["front","back","external"],"type":"string","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled","target_resolution","camera_default_on","camera_facing"],"type":"object"},"WebhookEvent":{"description":"The discriminator object for all webhook events, it maps events' payload to the final type","discriminator":{"mapping":{"export.bulk_image_moderation.error":"#/components/schemas/AsyncExportErrorEvent","export.bulk_image_moderation.success":"#/components/schemas/AsyncBulkImageModerationEvent","export.moderation_logs.error":"#/components/schemas/AsyncExportErrorEvent","export.moderation_logs.success":"#/components/schemas/AsyncExportModerationLogsEvent","moderation.custom_action":"#/components/schemas/ModerationCustomActionEvent","moderation.flagged":"#/components/schemas/ModerationFlaggedEvent","moderation.mark_reviewed":"#/components/schemas/ModerationMarkReviewedEvent","moderation_check.completed":"#/components/schemas/ModerationCheckCompletedEvent","review_queue_item.new":"#/components/schemas/ReviewQueueItemNewEvent","review_queue_item.updated":"#/components/schemas/ReviewQueueItemUpdatedEvent"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/AsyncBulkImageModerationEvent"},{"$ref":"#/components/schemas/AsyncExportErrorEvent"},{"$ref":"#/components/schemas/AsyncExportErrorEvent"},{"$ref":"#/components/schemas/AsyncExportModerationLogsEvent"},{"$ref":"#/components/schemas/ModerationCheckCompletedEvent"},{"$ref":"#/components/schemas/ModerationCustomActionEvent"},{"$ref":"#/components/schemas/ModerationFlaggedEvent"},{"$ref":"#/components/schemas/ModerationMarkReviewedEvent"},{"$ref":"#/components/schemas/ReviewQueueItemNewEvent"},{"$ref":"#/components/schemas/ReviewQueueItemUpdatedEvent"}]}},"securitySchemes":{"JWT":{"description":"JWT should be always provided when stream-auth-type=jwt.\n\nUsing JWT auth request could be authenticated as user or as server-side.\n\nWhen using user authentication permission checking is going to be applied to requests based on the user that is\nperforming a request.\n\nThe `authorization` header should be a JWT string signed using the secret attached to the API key used to perform\nrequests.\n\n**WARNING** all client-side official SDK do not ship with token generation; this is to make sure that the API secret is not\nshared with an untrusted party such as a browser or a iOS/Android application. Tokens **must** be generated server-side.\nIf you wish, you can configure your application to ignore authentication (see `disable_auth_check`)\nThe JWT string must include only the user_id claim and can include any built-in JWT claim such as iat, exp as well.\n","in":"header","name":"Authorization","type":"apiKey"},"api_key":{"description":"Application API key should be always set in order to authenticate the request.","in":"query","name":"api_key","type":"apiKey"},"stream-auth-type":{"description":"Stream-Auth-Type should be always set in order to authenticate the request. Possible\nvalues: `jwt` or `anonymous`.\n\n`jwt` allows you to authenticate as a user. With this auth type you should also provide valid JWT in Authorization\nheader.\n\n`anonymous` allows you to authenticate as anonymous user. Please note that most advanced features are not available\nto anonymous users.","in":"header","name":"Stream-Auth-Type","type":"apiKey"}}},"info":{"title":"Stream API","version":"v191.1.0"},"openapi":"3.0.3","paths":{"/api/v2/moderation/ban":{"post":{"description":"Ban a user from a channel or the entire app\n","operationId":"ban","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BanRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BanResponse"}}},"description":"Successful 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":"Ban","tags":["product:moderation"]}},"/api/v2/moderation/bulk_image_moderation":{"post":{"description":"Moderate multiple images in bulk using a CSV file\n","operationId":"bulk_image_moderation","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkImageModerationRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkImageModerationResponse"}}},"description":"Successful 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":"Bulk image moderation","tags":["product:moderation"]}},"/api/v2/moderation/check":{"post":{"description":"Run moderation checks on the provided content\n","operationId":"check","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckResponse"}}},"description":"Successful 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":"Check","tags":["product:moderation"]}},"/api/v2/moderation/config":{"post":{"description":"Create a new moderation configuration or update an existing one. Configure settings for content filtering, AI analysis, toxicity detection, and other moderation features.\n","operationId":"upsert_config","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertConfigRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertConfigResponse"}}},"description":"Successful 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":"Create or update moderation configuration","tags":["product:moderation"]}},"/api/v2/moderation/config/{key}":{"delete":{"description":"Delete a specific moderation policy by its name\n","operationId":"delete_config","parameters":[{"in":"path","name":"key","required":true,"schema":{"description":"Key of the moderation configuration to delete","title":"Key","type":"string","x-stream-index":"001"}},{"in":"query","name":"team","schema":{"description":"Team associated with the configuration","title":"Team","type":"string","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteModerationConfigResponse"}}},"description":"Successful 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":"Delete a moderation policy","tags":["product:moderation"]},"get":{"description":"Retrieve a specific moderation configuration by its key and team. This configuration contains settings for various moderation features like toxicity detection, AI analysis, and filtering rules.\n","operationId":"get_config","parameters":[{"in":"path","name":"key","required":true,"schema":{"description":"Key of the moderation configuration to retrieve","title":"Key","type":"string","x-stream-index":"001"}},{"in":"query","name":"team","schema":{"description":"Team associated with the configuration","title":"Team","type":"string","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetConfigResponse"}}},"description":"Successful 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":"Get moderation configuration","tags":["product:moderation"]}},"/api/v2/moderation/configs":{"post":{"description":"Search and filter moderation configurations across your application. This endpoint is designed for building moderation dashboards and managing multiple configuration sets.\n","operationId":"query_moderation_configs","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationConfigsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationConfigsResponse"}}},"description":"Successful 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":"Query moderation configurations","tags":["product:moderation"]}},"/api/v2/moderation/custom_check":{"post":{"description":"Custom check, add your own AI model reports to the review queue\n","operationId":"custom_check","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomCheckRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomCheckResponse"}}},"description":"Successful 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":"Custom check endpoint","tags":["product:moderation"]}},"/api/v2/moderation/feeds_moderation_template":{"delete":{"description":"Delete a specific moderation template by its name\n","operationId":"V2DeleteTemplate","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteModerationTemplateResponse"}}},"description":"Successful 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":"Delete a moderation template","tags":["product:moderation"]},"get":{"description":"Retrieve a list of feed moderation templates that define preset moderation rules and configurations. Limited to 100 templates per request.\n","operationId":"V2QueryTemplates","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryFeedModerationTemplatesResponse"}}},"description":"Successful 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":"Query feed moderation templates","tags":["product:moderation"]},"post":{"description":"Upsert feeds template for moderation\n","operationId":"V2UpsertTemplate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertModerationTemplateRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertModerationTemplateResponse"}}},"description":"Successful 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":"Upsert feeds template","tags":["product:moderation"]}},"/api/v2/moderation/flag":{"post":{"description":"Flag any type of content (messages, users, channels, activities) for moderation review. Supports custom content types and additional metadata for flagged content.\n","operationId":"flag","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlagRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlagResponse"}}},"description":"Successful 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":"Flag content for moderation","tags":["product:moderation"]}},"/api/v2/moderation/flags":{"post":{"description":"Query flags associated with moderation items. This is used for building a moderation dashboard.\n","operationId":"query_moderation_flags","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationFlagsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationFlagsResponse"}}},"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":"Query moderation flags","tags":["product:moderation"]}},"/api/v2/moderation/logs":{"post":{"description":"Search and filter moderation action logs with support for pagination. View the history of moderation actions taken, including who performed them and when.\n","operationId":"query_moderation_logs","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationLogsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationLogsResponse"}}},"description":"Successful 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":"Query moderation action logs","tags":["product:moderation"]}},"/api/v2/moderation/moderation_rule":{"post":{"description":"Create or update a moderation rule that can apply app-wide or to specific moderation configs\n","operationId":"upsert_moderation_rule","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertModerationRuleRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertModerationRuleResponse"}}},"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":"Upsert moderation rule","tags":["product:moderation"]}},"/api/v2/moderation/moderation_rule/{id}":{"delete":{"description":"Delete an existing moderation rule\n","operationId":"delete_moderation_rule","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteModerationRuleResponse"}}},"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":"Delete moderation rule","tags":["product:moderation"]},"get":{"description":"Get a specific moderation rule by ID\n","operationId":"get_moderation_rule","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetModerationRuleResponse"}}},"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":"Get moderation rule","tags":["product:moderation"]}},"/api/v2/moderation/moderation_rules":{"post":{"description":"Search and filter moderation rules across your application. This endpoint is designed for building moderation dashboards and managing multiple rule sets.\n","operationId":"query_moderation_rules","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationRulesRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationRulesResponse"}}},"description":"Successful 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":"Query moderation rules","tags":["product:moderation"]}},"/api/v2/moderation/mute":{"post":{"description":"Mute a user. Mutes are generally not visible to the user you mute, while block is something you notice.\n","operationId":"mute","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteRequest"}}},"description":"MuteRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteResponse"}}},"description":"MuteResponse"},"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":"Mute","tags":["product:moderation"]}},"/api/v2/moderation/review_queue":{"post":{"description":"Query review queue items allows you to filter the review queue items. This is used for building a moderation dashboard.\n","operationId":"query_review_queue","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryReviewQueueRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryReviewQueueResponse"}}},"description":"Successful 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":"Query review queue items","tags":["product:moderation"]}},"/api/v2/moderation/review_queue/{id}":{"get":{"description":"Retrieve a specific review queue item by its ID\n","operationId":"get_review_queue_item","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Unique identifier of the review queue item to retrieve","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetReviewQueueItemResponse"}}},"description":"Successful 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":"Get review queue item","tags":["product:moderation"]}},"/api/v2/moderation/submit_action":{"post":{"description":"Take action on flagged content, such as marking content as safe, deleting content, banning users, or executing custom moderation actions. Supports various action types with configurable parameters.\n","operationId":"submit_action","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitActionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitActionResponse"}}},"description":"Successful 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":"Submit moderation action","tags":["product:moderation"]}},"/api/v2/moderation/unban":{"post":{"description":"Unban a user from a channel or globally.\n","operationId":"unban","parameters":[{"in":"query","name":"target_user_id","required":true,"schema":{"description":"ID of the user to unban","title":"Target User ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"channel_cid","schema":{"description":"Channel where the unban applies","title":"Channel CID","type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"created_by","schema":{"description":"ID of the user who created the ban","title":"Created By","type":"string","writeOnly":true,"x-stream-index":"003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnbanRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnbanResponse"}}},"description":"Successful 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":"Unban","tags":["product:moderation"]}},"/api/v2/moderation/unmute":{"post":{"description":"Unmute a user\n","operationId":"unmute","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnmuteRequest"}}},"description":"UnmuteRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnmuteResponse"}}},"description":"UnmuteResponse"},"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":"Unmute a user","tags":["product:moderation"]}}},"security":[{"JWT":[],"api_key":[],"stream-auth-type":[]},{"api_key":[],"stream-auth-type":[]}],"servers":[{"description":"Stream API","url":"https://chat.stream-io-api.com"}]} \ No newline at end of file diff --git a/openapi/v2/moderation-serverside-api.yaml b/openapi/v2/moderation-serverside-api.yaml index 06ccd6563..13b4896c5 100644 --- a/openapi/v2/moderation-serverside-api.yaml +++ b/openapi/v2/moderation-serverside-api.yaml @@ -839,11 +839,6 @@ components: shadow_ban: type: boolean x-stream-index: "003" - required: - - duration - - reason - - shadow_ban - - ip_ban type: object BanRequest: nullable: true @@ -913,8 +908,6 @@ components: reason: type: string x-stream-index: "001" - required: - - reason type: object BlockListConfig: properties: @@ -2004,6 +1997,14 @@ components: $ref: '#/components/schemas/ChannelMember' type: array x-stream-index: "020" + message_count: + format: int64 + type: integer + x-stream-index: "035" + message_count_updated_at: + format: date-time + type: number + x-stream-index: "036" team: type: string x-stream-index: "028" @@ -2034,39 +2035,39 @@ components: items: type: string type: array - x-stream-index: "001.026" + x-stream-index: "001.027" automod: enum: - disabled - simple - AI type: string - x-stream-index: "001.021" + x-stream-index: "001.022" automod_behavior: enum: - flag - block - shadow_block type: string - x-stream-index: "001.022" + x-stream-index: "001.023" automod_thresholds: $ref: '#/components/schemas/Thresholds' - x-stream-index: "001.027" + x-stream-index: "001.028" blocklist: type: string - x-stream-index: "001.023" + x-stream-index: "001.024" blocklist_behavior: enum: - flag - block - shadow_block type: string - x-stream-index: "001.024" + x-stream-index: "001.025" blocklists: items: $ref: '#/components/schemas/BlockListOptions' type: array - x-stream-index: "001.025" + x-stream-index: "001.026" commands: items: type: string @@ -2075,6 +2076,9 @@ components: connect_events: type: boolean x-stream-index: "001.004" + count_messages: + type: boolean + x-stream-index: "001.019" created_at: format: date-time type: number @@ -2089,7 +2093,7 @@ components: format: int32 maximum: 20000 type: integer - x-stream-index: "001.020" + x-stream-index: "001.021" mutes: type: boolean x-stream-index: "001.009" @@ -2099,10 +2103,10 @@ components: partition_size: format: int32 type: integer - x-stream-index: "001.028" + x-stream-index: "001.029" partition_ttl: type: integer - x-stream-index: "001.029" + x-stream-index: "001.030" polls: type: boolean x-stream-index: "001.016" @@ -2132,7 +2136,7 @@ components: x-stream-index: "001.018" skip_last_msg_update_for_system_msgs: type: boolean - x-stream-index: "001.030" + x-stream-index: "001.031" typing_events: type: boolean x-stream-index: "001.002" @@ -2168,6 +2172,7 @@ components: - polls - user_message_reminders - shared_locations + - count_messages - message_retention - max_message_length - automod @@ -2183,39 +2188,39 @@ components: items: type: string type: array - x-stream-index: 001.002.026 + x-stream-index: 001.002.027 automod: enum: - disabled - simple - AI type: string - x-stream-index: 001.002.021 + x-stream-index: 001.002.022 automod_behavior: enum: - flag - block - shadow_block type: string - x-stream-index: 001.002.022 + x-stream-index: 001.002.023 automod_thresholds: $ref: '#/components/schemas/Thresholds' - x-stream-index: 001.002.027 + x-stream-index: 001.002.028 blocklist: type: string - x-stream-index: 001.002.023 + x-stream-index: 001.002.024 blocklist_behavior: enum: - flag - block - shadow_block type: string - x-stream-index: 001.002.024 + x-stream-index: 001.002.025 blocklists: items: $ref: '#/components/schemas/BlockListOptions' type: array - x-stream-index: 001.002.025 + x-stream-index: 001.002.026 commands: items: $ref: '#/components/schemas/Command' @@ -2224,6 +2229,9 @@ components: connect_events: type: boolean x-stream-index: 001.002.004 + count_messages: + type: boolean + x-stream-index: 001.002.019 created_at: format: date-time type: number @@ -2245,7 +2253,7 @@ components: format: int32 maximum: 20000 type: integer - x-stream-index: 001.002.020 + x-stream-index: 001.002.021 mutes: type: boolean x-stream-index: 001.002.009 @@ -2255,10 +2263,10 @@ components: partition_size: format: int32 type: integer - x-stream-index: 001.002.028 + x-stream-index: 001.002.029 partition_ttl: type: integer - x-stream-index: 001.002.029 + x-stream-index: 001.002.030 polls: type: boolean x-stream-index: 001.002.016 @@ -2288,7 +2296,7 @@ components: x-stream-index: 001.002.018 skip_last_msg_update_for_system_msgs: type: boolean - x-stream-index: 001.002.030 + x-stream-index: 001.002.031 typing_events: type: boolean x-stream-index: 001.002.002 @@ -2326,6 +2334,7 @@ components: - polls - user_message_reminders - shared_locations + - count_messages - message_retention - max_message_length - automod @@ -2362,6 +2371,11 @@ components: format: date-time type: number x-stream-index: "014" + deleted_messages: + items: + type: string + type: array + x-stream-index: "027" invite_accepted_at: format: date-time type: number @@ -2510,6 +2524,10 @@ components: $ref: '#/components/schemas/ChannelMember' type: array x-stream-index: "014" + message_count: + format: int64 + type: integer + x-stream-index: "031" mute_expires_at: format: date-time type: number @@ -2603,7 +2621,6 @@ components: - entity_type - entity_id - entity_creator_id - - config_key type: object CheckResponse: nullable: true @@ -2706,6 +2723,9 @@ components: type: string type: array x-stream-index: "011" + count_messages: + type: boolean + x-stream-index: "014" grants: additionalProperties: items: @@ -2752,7 +2772,7 @@ components: $ref: '#/components/schemas/AIImageConfig' description: Configuration for AI image analysis title: AI Image Config - x-stream-index: "009" + x-stream-index: "010" ai_text_config: $ref: '#/components/schemas/AITextConfig' description: Configuration for AI text analysis @@ -2762,7 +2782,7 @@ components: $ref: '#/components/schemas/AIVideoConfig' description: Configuration for AI video analysis title: AI Video Config - x-stream-index: "010" + x-stream-index: "011" async: description: Whether moderation should be performed asynchronously title: Async @@ -2793,15 +2813,17 @@ components: format: date-time title: Created At type: number - x-stream-index: "012" + x-stream-index: "013" key: description: Unique identifier for the moderation configuration title: Key type: string x-stream-index: "001" - rule_builder_config: - $ref: '#/components/schemas/RuleBuilderConfig' - x-stream-index: "015" + llm_config: + $ref: '#/components/schemas/LLMConfig' + description: Configuration for customer-configured LLM moderation + title: LLM Config + x-stream-index: "009" team: description: Team associated with the configuration title: Team @@ -2812,15 +2834,15 @@ components: format: date-time title: Updated At type: number - x-stream-index: "013" + x-stream-index: "014" velocity_filter_config: $ref: '#/components/schemas/VelocityFilterConfig' description: Configuration for velocity-based filtering title: Velocity Filter Config - x-stream-index: "011" + x-stream-index: "012" video_call_rule_config: $ref: '#/components/schemas/VideoCallRuleConfig' - x-stream-index: "014" + x-stream-index: "015" required: - key - team @@ -2837,9 +2859,6 @@ components: time_window: type: string x-stream-index: "002" - required: - - threshold - - time_window type: object CustomActionRequest: properties: @@ -2979,6 +2998,19 @@ components: required: - duration type: object + DeleteModerationRuleResponse: + 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 DeleteModerationTemplateResponse: nullable: true properties: @@ -3662,6 +3694,21 @@ components: type: object x-stream-index: "001" type: object + FeedsEventPreferences: + properties: + comments: + type: string + x-stream-index: "002" + mentions: + type: string + x-stream-index: "004" + new_followers: + type: string + x-stream-index: "003" + reactions: + type: string + x-stream-index: "001" + type: object FeedsModerationTemplateConfig: properties: config_key: @@ -3790,8 +3837,6 @@ components: reason: type: string x-stream-index: "001" - required: - - reason type: object FlagRequest: nullable: true @@ -3858,8 +3903,6 @@ components: reason: type: string x-stream-index: "001" - required: - - reason type: object FrameRecordSettings: properties: @@ -3963,6 +4006,22 @@ components: required: - duration type: object + GetModerationRuleResponse: + description: Basic response information + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "001.001" + rule: + $ref: '#/components/schemas/ModerationRuleV2Response' + x-stream-index: "002" + required: + - duration + title: Response + type: object GetReviewQueueItemResponse: nullable: true properties: @@ -4110,9 +4169,6 @@ components: time_window: type: string x-stream-index: "002" - required: - - threshold - - time_window type: object Images: properties: @@ -4297,6 +4353,61 @@ components: - max_dimension - frame_rate_limit type: object + LLMConfig: + properties: + app_context: + type: string + x-stream-index: "005" + async: + type: boolean + x-stream-index: "001" + enabled: + type: boolean + x-stream-index: "002" + rules: + items: + $ref: '#/components/schemas/LLMRule' + type: array + x-stream-index: "003" + severity_descriptions: + additionalProperties: + type: string + type: object + x-stream-index: "004" + required: + - enabled + - rules + type: object + LLMRule: + properties: + action: + enum: + - flag + - shadow + - remove + - bounce + - bounce_flag + - bounce_remove + - keep + type: string + x-stream-index: "003" + description: + type: string + x-stream-index: "002" + label: + type: string + x-stream-index: "001" + severity_rules: + items: + $ref: '#/components/schemas/BodyguardSeverityRule' + type: array + x-stream-index: "004" + required: + - label + - description + - action + - severity_rules + type: object LabelThresholds: properties: block: @@ -4461,6 +4572,9 @@ components: format: date-time type: number x-stream-index: "033" + deleted_for_me: + type: boolean + x-stream-index: "059" deleted_reply_count: format: int32 type: integer @@ -4700,6 +4814,9 @@ components: title: Deleted at type: number x-stream-index: "025" + deleted_for_me: + type: boolean + x-stream-index: "044" deleted_reply_count: format: int32 type: integer @@ -5064,61 +5181,64 @@ components: nullable: true properties: created_at: - type: string - x-stream-index: "014" + format: date-time + type: number + x-stream-index: "015" custom: additionalProperties: {} type: object - x-stream-index: "009" + x-stream-index: "010" entity_creator_id: type: string - x-stream-index: "006" + x-stream-index: "007" entity_id: type: string - x-stream-index: "005" + x-stream-index: "006" entity_type: type: string - x-stream-index: "004" - id: - type: string - x-stream-index: "001" + x-stream-index: "005" labels: items: type: string type: array - x-stream-index: "010" + x-stream-index: "011" moderation_payload: $ref: '#/components/schemas/ModerationPayload' - x-stream-index: "007" + x-stream-index: "008" reason: type: string - x-stream-index: "008" + x-stream-index: "009" result: items: additionalProperties: {} type: object type: array - x-stream-index: "011" + x-stream-index: "012" review_queue_item: $ref: '#/components/schemas/ReviewQueueItemResponse' - x-stream-index: "013" + x-stream-index: "014" review_queue_item_id: type: string - x-stream-index: "012" + x-stream-index: "013" type: type: string x-stream-index: "002" updated_at: - type: string - x-stream-index: "015" + format: date-time + type: number + x-stream-index: "016" user: $ref: '#/components/schemas/UserResponse' + x-stream-index: "004" + user_id: + type: string x-stream-index: "003" required: - - id - type + - user_id - entity_type - entity_id + - result - created_at - updated_at type: object @@ -5201,34 +5321,98 @@ components: type: array x-stream-index: "003" type: object - ModerationV2Response: + ModerationRuleV2Response: properties: action: - type: string - x-stream-index: "001" - blocklist_matched: - type: string - x-stream-index: "005" - image_harms: + $ref: '#/components/schemas/RuleBuilderAction' + x-stream-index: "010" + conditions: + items: + $ref: '#/components/schemas/RuleBuilderCondition' + type: array + x-stream-index: "007" + config_keys: items: type: string type: array x-stream-index: "004" - original_text: + cooldown_period: type: string - x-stream-index: "002" - platform_circumvented: - type: boolean - x-stream-index: "007" - semantic_filter_matched: + x-stream-index: "011" + created_at: + format: date-time + type: number + x-stream-index: "013" + description: type: string - x-stream-index: "006" - text_harms: + x-stream-index: "003" + enabled: + type: boolean + x-stream-index: "012" + groups: items: - type: string + $ref: '#/components/schemas/RuleBuilderConditionGroup' type: array - x-stream-index: "003" - required: + x-stream-index: "009" + id: + type: string + x-stream-index: "001" + logic: + type: string + x-stream-index: "008" + name: + type: string + x-stream-index: "002" + rule_type: + type: string + x-stream-index: "006" + team: + type: string + x-stream-index: "005" + updated_at: + format: date-time + type: number + x-stream-index: "014" + required: + - id + - name + - description + - config_keys + - team + - rule_type + - action + - enabled + - created_at + - updated_at + type: object + ModerationV2Response: + properties: + action: + type: string + x-stream-index: "001" + blocklist_matched: + type: string + x-stream-index: "005" + image_harms: + items: + type: string + type: array + x-stream-index: "004" + original_text: + type: string + x-stream-index: "002" + platform_circumvented: + type: boolean + x-stream-index: "007" + semantic_filter_matched: + type: string + x-stream-index: "006" + text_harms: + items: + type: string + type: array + x-stream-index: "003" + required: - action - original_text type: object @@ -5844,6 +6028,12 @@ components: disabled_until: format: date-time type: number + x-stream-index: "005" + feeds_events: + $ref: '#/components/schemas/FeedsEventPreferences' + x-stream-index: "004" + feeds_level: + type: string x-stream-index: "003" type: object Quality: @@ -6084,6 +6274,72 @@ components: - logs - duration type: object + QueryModerationRulesRequest: + nullable: true + properties: + filter: + additionalProperties: {} + description: Filter conditions for moderation rules + title: Filter + type: object + x-stream-index: "001" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "003.001" + next: + type: string + x-stream-index: "003.002" + prev: + type: string + x-stream-index: "003.003" + sort: + description: Sorting parameters for the results + items: + $ref: '#/components/schemas/SortParamRequest' + title: Sort + type: array + x-stream-index: "002" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "004.002" + user_id: + type: string + x-stream-index: "004.001" + type: object + QueryModerationRulesResponse: + nullable: true + properties: + default_llm_labels: + additionalProperties: + type: string + description: Default LLM label descriptions + title: DefaultLLMLabels + type: object + x-stream-index: "002" + duration: + type: string + x-stream-index: "004.001" + next: + type: string + x-stream-index: "003.001" + prev: + type: string + x-stream-index: "003.002" + rules: + description: List of moderation rules + items: + $ref: '#/components/schemas/ModerationRuleV2Response' + title: Rules + type: array + x-stream-index: "001" + required: + - rules + - default_llm_labels + - duration + type: object QueryReviewQueueRequest: nullable: true properties: @@ -6707,7 +6963,7 @@ components: flags: description: The flags associated with this review queue item items: - $ref: '#/components/schemas/FlagResponse' + $ref: '#/components/schemas/ModerationFlagResponse' title: Flags type: array x-stream-index: "003" @@ -6814,7 +7070,7 @@ components: flags: description: Associated flag records items: - $ref: '#/components/schemas/FlagResponse' + $ref: '#/components/schemas/ModerationFlagResponse' title: Flags type: array x-stream-index: "023" @@ -6924,7 +7180,7 @@ components: flags: description: The flags associated with this review queue item items: - $ref: '#/components/schemas/FlagResponse' + $ref: '#/components/schemas/ModerationFlagResponse' title: Flags type: array x-stream-index: "003" @@ -7006,8 +7262,6 @@ components: type: type: string x-stream-index: "001" - required: - - type type: object RuleBuilderCondition: properties: @@ -7036,6 +7290,9 @@ components: user_created_within_params: $ref: '#/components/schemas/UserCreatedWithinParameters' x-stream-index: "011" + user_custom_property_params: + $ref: '#/components/schemas/UserCustomPropertyParameters' + x-stream-index: "012" user_rule_params: $ref: '#/components/schemas/UserRuleParameters' x-stream-index: "006" @@ -7045,8 +7302,6 @@ components: video_rule_params: $ref: '#/components/schemas/VideoRuleParameters' x-stream-index: "005" - required: - - type type: object RuleBuilderConditionGroup: properties: @@ -7058,9 +7313,6 @@ components: logic: type: string x-stream-index: "001" - required: - - logic - - conditions type: object RuleBuilderConfig: properties: @@ -7072,48 +7324,37 @@ components: $ref: '#/components/schemas/RuleBuilderRule' type: array x-stream-index: "002" - required: - - rules type: object RuleBuilderRule: properties: action: $ref: '#/components/schemas/RuleBuilderAction' - x-stream-index: "007" + x-stream-index: "006" conditions: items: $ref: '#/components/schemas/RuleBuilderCondition' type: array - x-stream-index: "004" + x-stream-index: "003" cooldown_period: type: string - x-stream-index: "009" - enabled: - type: boolean - x-stream-index: "008" + x-stream-index: "007" groups: items: $ref: '#/components/schemas/RuleBuilderConditionGroup' type: array - x-stream-index: "006" + x-stream-index: "005" id: type: string x-stream-index: "001" logic: type: string - x-stream-index: "005" - name: - type: string - x-stream-index: "002" + x-stream-index: "004" rule_type: type: string - x-stream-index: "003" + x-stream-index: "002" required: - - id - - name - rule_type - action - - enabled type: object SFUIDLastSeen: properties: @@ -7468,18 +7709,23 @@ components: items: type: string type: array - x-stream-index: "004" + x-stream-index: "005" contains_url: type: boolean - x-stream-index: "002" + x-stream-index: "003" harm_labels: items: type: string type: array x-stream-index: "001" + llm_harm_labels: + additionalProperties: + type: string + type: object + x-stream-index: "002" severity: type: string - x-stream-index: "003" + x-stream-index: "004" type: object TextRuleParameters: properties: @@ -7487,18 +7733,23 @@ components: items: type: string type: array - x-stream-index: "006" + x-stream-index: "007" contains_url: type: boolean - x-stream-index: "004" + x-stream-index: "005" harm_labels: items: type: string type: array x-stream-index: "003" + llm_harm_labels: + additionalProperties: + type: string + type: object + x-stream-index: "004" severity: type: string - x-stream-index: "005" + x-stream-index: "006" threshold: format: int32 type: integer @@ -7506,9 +7757,6 @@ components: time_window: type: string x-stream-index: "002" - required: - - threshold - - time_window type: object Thresholds: properties: @@ -7764,7 +8012,7 @@ components: $ref: '#/components/schemas/AIImageConfig' description: Configuration for AI image analysis title: AI Image Config - x-stream-index: "010" + x-stream-index: "011" ai_text_config: $ref: '#/components/schemas/AITextConfig' description: Configuration for AI text analysis @@ -7774,7 +8022,7 @@ components: $ref: '#/components/schemas/AIVideoConfig' description: Configuration for AI video analysis title: AI Video Config - x-stream-index: "011" + x-stream-index: "012" async: description: Whether moderation should be performed asynchronously title: Async @@ -7797,7 +8045,7 @@ components: x-stream-index: "004" aws_rekognition_config: $ref: '#/components/schemas/AIImageConfig' - x-stream-index: "015" + x-stream-index: "016" block_list_config: $ref: '#/components/schemas/BlockListConfig' description: Configuration for block list filtering @@ -7805,23 +8053,28 @@ components: x-stream-index: "007" bodyguard_config: $ref: '#/components/schemas/AITextConfig' - x-stream-index: "014" + x-stream-index: "015" google_vision_config: $ref: '#/components/schemas/GoogleVisionConfig' description: Configuration for Google Vision integration title: Google Vision Config - x-stream-index: "009" + x-stream-index: "010" key: description: Unique identifier for the moderation configuration title: Key type: string x-stream-index: "001" + llm_config: + $ref: '#/components/schemas/LLMConfig' + description: Configuration for customer-configured LLM moderation + title: LLM Config + x-stream-index: "009" rule_builder_config: $ref: '#/components/schemas/RuleBuilderConfig' description: Configuration for custom rule builder (max 3 rules, max 5 conditions per rule) title: Rule Builder Config - x-stream-index: "013" + x-stream-index: "014" team: description: Team associated with the configuration maxLength: 128 @@ -7831,18 +8084,18 @@ components: x-stream-index: "002" user: $ref: '#/components/schemas/UserRequest' - x-stream-index: "017.002" + x-stream-index: "018.002" user_id: type: string - x-stream-index: "017.001" + x-stream-index: "018.001" velocity_filter_config: $ref: '#/components/schemas/VelocityFilterConfig' description: Configuration for velocity-based filtering title: Velocity Filter Config - x-stream-index: "012" + x-stream-index: "013" video_call_rule_config: $ref: '#/components/schemas/VideoCallRuleConfig' - x-stream-index: "016" + x-stream-index: "017" required: - key type: object @@ -7860,6 +8113,69 @@ components: required: - duration type: object + UpsertModerationRuleRequest: + nullable: true + properties: + action: + $ref: '#/components/schemas/RuleBuilderAction' + x-stream-index: "009" + conditions: + items: + $ref: '#/components/schemas/RuleBuilderCondition' + type: array + x-stream-index: "006" + config_keys: + items: + type: string + type: array + x-stream-index: "003" + cooldown_period: + type: string + x-stream-index: "010" + description: + type: string + x-stream-index: "002" + enabled: + type: boolean + x-stream-index: "011" + groups: + items: + $ref: '#/components/schemas/RuleBuilderConditionGroup' + type: array + x-stream-index: "008" + logic: + type: string + x-stream-index: "007" + name: + type: string + x-stream-index: "001" + rule_type: + type: string + x-stream-index: "005" + team: + type: string + x-stream-index: "004" + required: + - name + - rule_type + - action + type: object + UpsertModerationRuleResponse: + description: Basic response information + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "001.001" + rule: + $ref: '#/components/schemas/ModerationRuleV2Response' + x-stream-index: "002" + required: + - duration + title: Response + type: object UpsertModerationTemplateRequest: nullable: true properties: @@ -8006,6 +8322,15 @@ components: type: string x-stream-index: "001" type: object + UserCustomPropertyParameters: + properties: + operator: + type: string + x-stream-index: "002" + property_key: + type: string + x-stream-index: "001" + type: object UserMute: nullable: true properties: @@ -8402,9 +8727,6 @@ components: time_window: type: string x-stream-index: "002" - required: - - threshold - - time_window type: object VideoSettings: properties: @@ -8530,7 +8852,7 @@ components: type: apiKey info: title: Stream API - version: v187.13.0 + version: v191.1.0 openapi: 3.0.3 paths: /api/v2/moderation/ban: @@ -9000,6 +9322,125 @@ paths: summary: Query moderation action logs tags: - product:moderation + /api/v2/moderation/moderation_rule: + post: + description: | + Create or update a moderation rule that can apply app-wide or to specific moderation configs + operationId: upsert_moderation_rule + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpsertModerationRuleRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/UpsertModerationRuleResponse' + 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: Upsert moderation rule + tags: + - product:moderation + /api/v2/moderation/moderation_rule/{id}: + delete: + description: | + Delete an existing moderation rule + operationId: delete_moderation_rule + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteModerationRuleResponse' + 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: Delete moderation rule + tags: + - product:moderation + get: + description: | + Get a specific moderation rule by ID + operationId: get_moderation_rule + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/GetModerationRuleResponse' + 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: Get moderation rule + tags: + - product:moderation + /api/v2/moderation/moderation_rules: + post: + description: | + Search and filter moderation rules across your application. This endpoint is designed for building moderation dashboards and managing multiple rule sets. + operationId: query_moderation_rules + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueryModerationRulesRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/QueryModerationRulesResponse' + description: Successful 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: Query moderation rules + tags: + - product:moderation /api/v2/moderation/mute: post: description: | diff --git a/openapi/v2/serverside-api.json b/openapi/v2/serverside-api.json index f1237f610..abc380bc4 100644 --- a/openapi/v2/serverside-api.json +++ b/openapi/v2/serverside-api.json @@ -1 +1 @@ -{"components":{"schemas":{"AIImageConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"ocr_rules":{"items":{"$ref":"#/components/schemas/OCRRule"},"type":"array","x-stream-index":"004"},"rules":{"items":{"$ref":"#/components/schemas/AWSRekognitionRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules","ocr_rules"],"type":"object"},"AITextConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"profile":{"type":"string","x-stream-index":"003"},"rules":{"items":{"$ref":"#/components/schemas/BodyguardRule"},"type":"array","x-stream-index":"004"},"severity_rules":{"items":{"$ref":"#/components/schemas/BodyguardSeverityRule"},"type":"array","x-stream-index":"005"}},"required":["enabled","profile","rules","severity_rules"],"type":"object"},"AIVideoConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AWSRekognitionRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"APIError":{"nullable":true,"properties":{"StatusCode":{"description":"Response HTTP status code","format":"int32","title":"Status code","type":"integer","x-stream-index":"004"},"code":{"description":"API error code","format":"int32","title":"Code","type":"integer","x-stream-index":"001"},"details":{"description":"Additional error-specific information","items":{"type":"integer"},"title":"Details","type":"array","x-stream-index":"007"},"duration":{"description":"Request duration","title":"Duration","type":"string","x-stream-index":"005"},"exception_fields":{"additionalProperties":{"type":"string"},"description":"Additional error info","title":"Exception fields","type":"object","x-stream-index":"003"},"message":{"description":"Message describing an error","title":"Message","type":"string","x-stream-index":"002"},"more_info":{"description":"URL with additional information","title":"More info","type":"string","x-stream-index":"006"},"unrecoverable":{"description":"Flag that indicates if the error is unrecoverable, requests that return unrecoverable errors should not be retried, this error only applies to the request that caused it","title":"Unrecoverable","type":"boolean","x-stream-index":"008"}},"required":["code","message","StatusCode","duration","more_info","details"],"title":"Error response","type":"object"},"APNConfig":{"properties":{"Disabled":{"type":"boolean","writeOnly":true,"x-stream-index":"005"},"auth_key":{"type":"string","x-stream-index":"006.001"},"auth_type":{"enum":["certificate","token"],"type":"string","x-stream-index":"001"},"bundle_id":{"type":"string","x-stream-index":"004"},"development":{"type":"boolean","x-stream-index":"002"},"host":{"type":"string","x-stream-index":"003"},"key_id":{"type":"string","x-stream-index":"006.002"},"notification_template":{"type":"string","x-stream-index":"008"},"p12_cert":{"type":"string","x-stream-index":"007.001"},"team_id":{"type":"string","x-stream-index":"006.003"}},"type":"object"},"APNConfigFields":{"properties":{"auth_key":{"type":"string","x-stream-index":"009"},"auth_type":{"type":"string","x-stream-index":"003"},"bundle_id":{"type":"string","x-stream-index":"006"},"development":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"host":{"type":"string","x-stream-index":"005"},"key_id":{"type":"string","x-stream-index":"008"},"notification_template":{"type":"string","x-stream-index":"004"},"p12_cert":{"type":"string","x-stream-index":"010"},"team_id":{"type":"string","x-stream-index":"007"}},"required":["enabled","development"],"type":"object"},"APNS":{"properties":{"body":{"type":"string","x-stream-index":"002"},"content-available":{"format":"int32","type":"integer","x-stream-index":"004"},"data":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"mutable-content":{"format":"int32","type":"integer","x-stream-index":"005"},"sound":{"type":"string","x-stream-index":"003"},"title":{"type":"string","x-stream-index":"001"}},"required":["title","body"],"type":"object"},"AWSRekognitionRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"},"min_confidence":{"format":"float","maximum":100,"minimum":0,"type":"number","x-stream-index":"003"}},"required":["label","action","min_confidence"],"type":"object"},"Action":{"nullable":true,"properties":{"name":{"type":"string","x-stream-index":"001"},"style":{"type":"string","x-stream-index":"003"},"text":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"004"},"value":{"type":"string","x-stream-index":"005"}},"required":["name","text","type"],"type":"object"},"ActionLog":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"002"},"reason":{"type":"string","x-stream-index":"008"},"reporter_type":{"type":"string","x-stream-index":"009"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"014"},"review_queue_item_id":{"type":"string","x-stream-index":"012"},"target_user":{"$ref":"#/components/schemas/User","x-stream-index":"013"},"target_user_id":{"type":"string","x-stream-index":"011"},"type":{"type":"string","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007"}},"required":["id","created_at","type","reason","reporter_type","custom","target_user_id","review_queue_item_id"],"type":"object"},"ActionLogResponse":{"nullable":true,"properties":{"created_at":{"description":"Timestamp when the action was taken","format":"date-time","title":"Created At","type":"number","x-stream-index":"002"},"custom":{"additionalProperties":{},"description":"Additional metadata about the action","title":"Custom","type":"object","x-stream-index":"007"},"id":{"description":"Unique identifier of the action log","title":"ID","type":"string","x-stream-index":"001"},"reason":{"description":"Reason for the moderation action","title":"Reason","type":"string","x-stream-index":"006"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"Associated review queue item","title":"Review Queue Item","x-stream-index":"008"},"target_user":{"$ref":"#/components/schemas/UserResponse","description":"User who was the target of the action","title":"Target User","x-stream-index":"009"},"target_user_id":{"description":"ID of the user who was the target of the action","title":"Target User ID","type":"string","x-stream-index":"010"},"type":{"description":"Type of moderation action","title":"Type","type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who performed the action","title":"User","x-stream-index":"004"},"user_id":{"description":"ID of the user who performed the action","title":"User ID","type":"string","x-stream-index":"005"}},"required":["id","created_at","type","user_id","reason","custom","target_user_id"],"type":"object"},"ActionSequence":{"properties":{"action":{"type":"string","x-stream-index":"001"},"blur":{"type":"boolean","x-stream-index":"005"},"cooldown_period":{"format":"int32","type":"integer","x-stream-index":"004"},"threshold":{"format":"int32","type":"integer","x-stream-index":"002"},"time_window":{"format":"int32","type":"integer","x-stream-index":"003"},"warning":{"type":"boolean","x-stream-index":"006"},"warning_text":{"type":"string","x-stream-index":"007"}},"required":["action","threshold","time_window","cooldown_period","blur","warning","warning_text"],"type":"object"},"ActiveCallsFPSStats":{"properties":{"p05":{"format":"float","type":"number","x-stream-index":"001"},"p10":{"format":"float","type":"number","x-stream-index":"002"},"p50":{"format":"float","type":"number","x-stream-index":"003"},"p90":{"format":"float","type":"number","x-stream-index":"004"}},"required":["p05","p10","p50","p90"],"type":"object"},"ActiveCallsLatencyStats":{"properties":{"p50":{"format":"float","type":"number","x-stream-index":"001"},"p90":{"format":"float","type":"number","x-stream-index":"002"}},"required":["p50","p90"],"type":"object"},"ActiveCallsMetrics":{"properties":{"join_call_api":{"$ref":"#/components/schemas/JoinCallAPIMetrics","x-stream-index":"001"},"publishers":{"$ref":"#/components/schemas/PublishersMetrics","x-stream-index":"002"},"subscribers":{"$ref":"#/components/schemas/SubscribersMetrics","x-stream-index":"003"}},"type":"object"},"ActiveCallsSummary":{"properties":{"active_calls":{"format":"int32","type":"integer","x-stream-index":"001"},"active_publishers":{"format":"int32","type":"integer","x-stream-index":"002"},"active_subscribers":{"format":"int32","type":"integer","x-stream-index":"003"},"participants":{"format":"int32","type":"integer","x-stream-index":"004"}},"required":["active_calls","active_publishers","active_subscribers","participants"],"type":"object"},"ActivityMarkedEvent":{"properties":{"all_read":{"type":"boolean","x-stream-index":"006"},"all_seen":{"type":"boolean","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"feed_id":{"type":"string","x-stream-index":"003"},"marked_read":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"marked_watched":{"items":{"type":"string"},"type":"array","x-stream-index":"005"},"type":{"default":"activity.marked","type":"string","x-stream-index":"001.001"},"user_id":{"type":"string","x-stream-index":"002"}},"required":["type","created_at","user_id","feed_id","all_read","all_seen"],"title":"ActivityMarkedEvent","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"},"AnyEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"*","type":"string","x-stream-index":"001.001"}},"required":["type","created_at"],"title":"AnyEvent","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"},"AppResponseFields":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"019"},"async_url_enrich_enabled":{"type":"boolean","x-stream-index":"017"},"auto_translation_enabled":{"type":"boolean","x-stream-index":"020"},"before_message_send_hook_url":{"type":"string","x-stream-index":"021"},"call_types":{"additionalProperties":{"$ref":"#/components/schemas/CallType"},"type":"object","x-stream-index":"007"},"campaign_enabled":{"type":"boolean","x-stream-index":"034"},"cdn_expiration_seconds":{"format":"int32","type":"integer","x-stream-index":"037"},"channel_configs":{"additionalProperties":{"$ref":"#/components/schemas/ChannelConfig"},"type":"object","x-stream-index":"006"},"custom_action_handler_url":{"type":"string","x-stream-index":"022"},"datadog_info":{"$ref":"#/components/schemas/DataDogInfo","x-stream-index":"040"},"disable_auth_checks":{"type":"boolean","x-stream-index":"011"},"disable_permissions_checks":{"type":"boolean","x-stream-index":"012"},"enforce_unique_usernames":{"type":"string","x-stream-index":"023"},"event_hooks":{"items":{"$ref":"#/components/schemas/EventHook"},"type":"array","x-stream-index":"045"},"file_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","x-stream-index":"030"},"geofences":{"items":{"$ref":"#/components/schemas/GeofenceResponse"},"type":"array","x-stream-index":"039"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"033"},"guest_user_creation_disabled":{"type":"boolean","x-stream-index":"043"},"image_moderation_enabled":{"type":"boolean","x-stream-index":"016"},"image_moderation_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"018"},"image_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","x-stream-index":"031"},"moderation_bulk_submit_action_enabled":{"type":"boolean","x-stream-index":"048"},"moderation_dashboard_preferences":{"$ref":"#/components/schemas/ModerationDashboardPreferences","x-stream-index":"044"},"moderation_enabled":{"type":"boolean","x-stream-index":"041"},"moderation_multitenant_blocklist_enabled":{"type":"boolean","x-stream-index":"042"},"moderation_webhook_url":{"type":"string","x-stream-index":"005"},"multi_tenant_enabled":{"type":"boolean","x-stream-index":"015"},"name":{"type":"string","x-stream-index":"001"},"organization":{"type":"string","x-stream-index":"002"},"permission_version":{"type":"string","x-stream-index":"013"},"policies":{"additionalProperties":{"items":{"$ref":"#/components/schemas/Policy"},"type":"array"},"type":"object","x-stream-index":"008"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationFields","x-stream-index":"003"},"reminders_interval":{"format":"int32","type":"integer","x-stream-index":"036"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"032"},"sns_key":{"type":"string","x-stream-index":"028"},"sns_secret":{"type":"string","x-stream-index":"029"},"sns_topic_arn":{"type":"string","x-stream-index":"027"},"sqs_key":{"type":"string","x-stream-index":"025"},"sqs_secret":{"type":"string","x-stream-index":"026"},"sqs_url":{"type":"string","x-stream-index":"024"},"suspended":{"type":"boolean","x-stream-index":"009"},"suspended_explanation":{"type":"string","x-stream-index":"010"},"use_hook_v2":{"type":"boolean","x-stream-index":"046"},"user_response_time_enabled":{"type":"boolean","x-stream-index":"047"},"user_search_disallowed_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"014"},"webhook_events":{"items":{"type":"string"},"type":"array","x-stream-index":"035"},"webhook_url":{"type":"string","x-stream-index":"004"}},"required":["name","organization","push_notifications","webhook_url","moderation_webhook_url","channel_configs","call_types","policies","suspended","suspended_explanation","disable_auth_checks","disable_permissions_checks","permission_version","user_search_disallowed_roles","multi_tenant_enabled","image_moderation_enabled","async_url_enrich_enabled","auto_translation_enabled","custom_action_handler_url","enforce_unique_usernames","sqs_url","sqs_key","sqs_secret","sns_topic_arn","sns_key","sns_secret","file_upload_config","image_upload_config","grants","campaign_enabled","webhook_events","reminders_interval","cdn_expiration_seconds","video_provider","moderation_enabled","moderation_multitenant_blocklist_enabled","guest_user_creation_disabled","event_hooks","use_hook_v2","user_response_time_enabled","moderation_bulk_submit_action_enabled"],"type":"object"},"AsyncBulkImageModerationEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"003.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.007"},"finished_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.004"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"task_id":{"type":"string","x-stream-index":"002.001"},"type":{"default":"export.bulk_image_moderation.success","type":"string","x-stream-index":"003.002"},"url":{"type":"string","x-stream-index":"001"}},"required":["url","task_id","started_at","finished_at","type","created_at","custom"],"title":"AsyncBulkImageModerationEvent","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"},"AsyncExportChannelsEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"003.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.007"},"finished_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.004"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"task_id":{"type":"string","x-stream-index":"002.001"},"type":{"default":"export.channels.success","type":"string","x-stream-index":"003.002"},"url":{"type":"string","x-stream-index":"001"}},"required":["url","task_id","started_at","finished_at","type","created_at","custom"],"title":"AsyncExportChannelsEvent","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"},"AsyncExportErrorEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"003.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.007"},"error":{"type":"string","x-stream-index":"001"},"finished_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.004"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"task_id":{"type":"string","x-stream-index":"002.001"},"type":{"default":"export.users.error","type":"string","x-stream-index":"003.002"}},"required":["error","task_id","started_at","finished_at","type","created_at","custom"],"title":"AsyncExportErrorEvent","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"},"AsyncExportModerationLogsEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"003.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.007"},"finished_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.004"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"task_id":{"type":"string","x-stream-index":"002.001"},"type":{"default":"export.moderation_logs.success","type":"string","x-stream-index":"003.002"},"url":{"type":"string","x-stream-index":"001"}},"required":["url","task_id","started_at","finished_at","type","created_at","custom"],"title":"AsyncExportModerationLogsEvent","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"},"AsyncExportUsersEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"003.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.007"},"finished_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.004"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"task_id":{"type":"string","x-stream-index":"002.001"},"type":{"default":"export.users.success","type":"string","x-stream-index":"003.002"},"url":{"type":"string","x-stream-index":"001"}},"required":["url","task_id","started_at","finished_at","type","created_at","custom"],"title":"AsyncExportUsersEvent","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"},"AsyncModerationCallbackConfig":{"properties":{"mode":{"enum":["CALLBACK_MODE_NONE","CALLBACK_MODE_REST","CALLBACK_MODE_TWIRP"],"type":"string","x-stream-index":"002"},"server_url":{"type":"string","x-stream-index":"001"}},"type":"object"},"AsyncModerationConfiguration":{"properties":{"callback":{"$ref":"#/components/schemas/AsyncModerationCallbackConfig","x-stream-index":"002"},"timeout_ms":{"format":"int32","type":"integer","x-stream-index":"001"}},"type":"object"},"Attachment":{"description":"An attachment is a message object that represents a file uploaded by a user.","nullable":true,"properties":{"actions":{"items":{"$ref":"#/components/schemas/Action"},"type":"array","x-stream-index":"015"},"asset_url":{"type":"string","x-stream-index":"017"},"author_icon":{"type":"string","x-stream-index":"007"},"author_link":{"type":"string","x-stream-index":"006"},"author_name":{"type":"string","x-stream-index":"005"},"color":{"type":"string","x-stream-index":"003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"018"},"fallback":{"type":"string","x-stream-index":"002"},"fields":{"items":{"$ref":"#/components/schemas/Field"},"type":"array","x-stream-index":"016"},"footer":{"type":"string","x-stream-index":"013"},"footer_icon":{"type":"string","x-stream-index":"014"},"giphy":{"$ref":"#/components/schemas/Images","x-stream-index":"019"},"image_url":{"type":"string","x-stream-index":"011"},"og_scrape_url":{"type":"string","x-stream-index":"020"},"original_height":{"format":"int32","type":"integer","x-stream-index":"022"},"original_width":{"format":"int32","type":"integer","x-stream-index":"021"},"pretext":{"type":"string","x-stream-index":"004"},"text":{"type":"string","x-stream-index":"010"},"thumb_url":{"type":"string","x-stream-index":"012"},"title":{"type":"string","x-stream-index":"008"},"title_link":{"type":"string","x-stream-index":"009"},"type":{"description":"Attachment type (e.g. image, video, url)","title":"Type","type":"string","x-stream-index":"001"}},"required":["custom"],"title":"Attachment","type":"object","x-stream-docs-page-id":"file_uploads"},"AudioSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"001"},"default_device":{"enum":["speaker","earpiece"],"type":"string","x-stream-index":"006"},"mic_default_on":{"type":"boolean","x-stream-index":"004"},"noise_cancellation":{"$ref":"#/components/schemas/NoiseCancellationSettings","x-stream-index":"007"},"opus_dtx_enabled":{"type":"boolean","x-stream-index":"002"},"redundant_coding_enabled":{"type":"boolean","x-stream-index":"003"},"speaker_default_on":{"type":"boolean","x-stream-index":"005"}},"required":["access_request_enabled","opus_dtx_enabled","redundant_coding_enabled","mic_default_on","speaker_default_on","default_device"],"type":"object"},"AudioSettingsRequest":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"001"},"default_device":{"enum":["speaker","earpiece"],"type":"string","x-stream-index":"006"},"mic_default_on":{"type":"boolean","x-stream-index":"004"},"noise_cancellation":{"$ref":"#/components/schemas/NoiseCancellationSettings","x-stream-index":"007"},"opus_dtx_enabled":{"type":"boolean","x-stream-index":"002"},"redundant_coding_enabled":{"type":"boolean","x-stream-index":"003"},"speaker_default_on":{"type":"boolean","x-stream-index":"005"}},"required":["default_device"],"type":"object"},"AudioSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"001"},"default_device":{"enum":["speaker","earpiece"],"type":"string","x-stream-index":"006"},"mic_default_on":{"type":"boolean","x-stream-index":"004"},"noise_cancellation":{"$ref":"#/components/schemas/NoiseCancellationSettings","x-stream-index":"007"},"opus_dtx_enabled":{"type":"boolean","x-stream-index":"002"},"redundant_coding_enabled":{"type":"boolean","x-stream-index":"003"},"speaker_default_on":{"type":"boolean","x-stream-index":"005"}},"required":["access_request_enabled","opus_dtx_enabled","redundant_coding_enabled","mic_default_on","speaker_default_on","default_device"],"type":"object"},"AutomodDetails":{"properties":{"action":{"type":"string","x-stream-index":"001"},"image_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"005"},"message_details":{"$ref":"#/components/schemas/FlagMessageDetails","x-stream-index":"004"},"original_message_type":{"type":"string","x-stream-index":"002"},"result":{"$ref":"#/components/schemas/MessageModerationResult","x-stream-index":"003"}},"type":"object"},"AutomodPlatformCircumventionConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AutomodRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"AutomodRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"003"},"label":{"type":"string","x-stream-index":"001"},"threshold":{"format":"float","maximum":1,"minimum":0,"type":"number","x-stream-index":"002"}},"required":["label","threshold","action"],"type":"object"},"AutomodSemanticFiltersConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AutomodSemanticFiltersRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"AutomodSemanticFiltersRule":{"properties":{"action":{"enum":["flag","shadow","remove"],"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"threshold":{"format":"float","maximum":1,"minimum":0,"type":"number","x-stream-index":"002"}},"required":["name","threshold","action"],"type":"object"},"AutomodToxicityConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AutomodRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"AzureRequest":{"description":"Config for creating Azure Blob Storage storage","properties":{"abs_account_name":{"description":"The account name","title":"AccountName","type":"string","x-stream-index":"001"},"abs_client_id":{"description":"The client id","title":"ClientID","type":"string","x-stream-index":"003"},"abs_client_secret":{"description":"The client secret","title":"ClientSecret","type":"string","x-stream-index":"004"},"abs_tenant_id":{"description":"The tenant id","title":"TenantID","type":"string","x-stream-index":"002"}},"required":["abs_account_name","abs_tenant_id","abs_client_id","abs_client_secret"],"title":"AzureRequest","type":"object"},"BackstageSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"BackstageSettingsRequest":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"002"}},"type":"object"},"BackstageSettingsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"Ban":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"012"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"011"},"expires":{"format":"date-time","type":"number","x-stream-index":"007"},"reason":{"type":"string","x-stream-index":"008"},"shadow":{"type":"boolean","x-stream-index":"009"},"target":{"$ref":"#/components/schemas/User","x-stream-index":"006"}},"required":["shadow","created_at"],"type":"object"},"BanActionRequest":{"properties":{"channel_ban_only":{"type":"boolean","x-stream-index":"003"},"delete_messages":{"enum":["soft","pruning","hard"],"type":"string","x-stream-index":"005"},"ip_ban":{"type":"boolean","x-stream-index":"004"},"reason":{"type":"string","x-stream-index":"002"},"shadow":{"type":"boolean","x-stream-index":"001"},"timeout":{"format":"int32","type":"integer","x-stream-index":"006"}},"type":"object"},"BanOptions":{"properties":{"duration":{"format":"int32","type":"integer","x-stream-index":"001"},"ip_ban":{"type":"boolean","x-stream-index":"004"},"reason":{"type":"string","x-stream-index":"002"},"shadow_ban":{"type":"boolean","x-stream-index":"003"}},"required":["duration","reason","shadow_ban","ip_ban"],"type":"object"},"BanRequest":{"nullable":true,"properties":{"banned_by":{"$ref":"#/components/schemas/UserRequest","description":"Details about the user performing the ban","title":"Banned By","x-stream-index":"008"},"banned_by_id":{"description":"ID of the user performing the ban","title":"Banned By ID","type":"string","x-stream-index":"007"},"channel_cid":{"description":"Channel where the ban applies","title":"Channel CID","type":"string","x-stream-index":"004"},"delete_messages":{"enum":["soft","pruning","hard"],"type":"string","x-stream-index":"009"},"ip_ban":{"description":"Whether to ban the user's IP address","title":"IP Ban","type":"boolean","x-stream-index":"006"},"reason":{"description":"Optional explanation for the ban","title":"Reason","type":"string","x-stream-index":"003"},"shadow":{"description":"Whether this is a shadow ban","title":"Shadow","type":"boolean","x-stream-index":"005"},"target_user_id":{"description":"ID of the user to ban","title":"Target User ID","type":"string","x-stream-index":"001"},"timeout":{"description":"Duration of the ban in minutes","minimum":0,"title":"Timeout","type":"integer","x-stream-index":"002"}},"required":["target_user_id"],"type":"object"},"BanResponse":{"nullable":true,"properties":{"banned_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"006"},"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"expires":{"format":"date-time","type":"number","x-stream-index":"003"},"reason":{"type":"string","x-stream-index":"004"},"shadow":{"type":"boolean","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"}},"required":["created_at"],"type":"object"},"BlockContentOptions":{"properties":{"reason":{"type":"string","x-stream-index":"001"}},"required":["reason"],"type":"object"},"BlockListConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/BlockListRule"},"maximum":10,"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"BlockListOptions":{"properties":{"behavior":{"description":"Blocklist behavior","enum":["flag","block","shadow_block"],"title":"Behavior","type":"string","x-stream-index":"002"},"blocklist":{"description":"Blocklist name","title":"Blocklist","type":"string","x-stream-index":"001"}},"required":["blocklist","behavior"],"type":"object"},"BlockListResponse":{"description":"Block list contains restricted words","properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001"},"id":{"type":"string","x-stream-index":"003"},"name":{"description":"Block list name","title":"Name","type":"string","x-stream-index":"004"},"team":{"type":"string","x-stream-index":"007"},"type":{"description":"Block list type.","title":"Type","type":"string","x-stream-index":"005"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"002"},"words":{"description":"List of words to block","items":{"type":"string"},"title":"Words","type":"array","x-stream-index":"006"}},"required":["name","type","words"],"title":"Block list","type":"object","x-stream-docs-page-id":"block_lists"},"BlockListRule":{"properties":{"action":{"enum":["flag","mask_flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"002"}},"required":["name","team","action"],"type":"object"},"BlockUserRequest":{"description":"BlockUserRequest is the payload for blocking a user.","nullable":true,"properties":{"user_id":{"description":"the user to block","title":"UserID","type":"string","x-stream-index":"003"}},"required":["user_id"],"title":"BlockUserRequest","type":"object"},"BlockUserResponse":{"description":"BlockUserResponse is the payload for blocking a user.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"BlockUserResponse","type":"object"},"BlockUsersRequest":{"nullable":true,"properties":{"blocked_user_id":{"description":"User id to block","title":"BlockedUserID","type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"required":["blocked_user_id"],"type":"object"},"BlockUsersResponse":{"nullable":true,"properties":{"blocked_by_user_id":{"description":"User id who blocked another user","title":"BlockedByUserID","type":"string","x-stream-index":"002"},"blocked_user_id":{"description":"User id who got blocked","title":"BlockedUserID","type":"string","x-stream-index":"003"},"created_at":{"description":"Timestamp when the user was blocked","format":"date-time","title":"CreatedAt","type":"number","x-stream-index":"004"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration","blocked_by_user_id","blocked_user_id","created_at"],"type":"object"},"BlockedUserEvent":{"description":"This event is sent to call participants to notify when a user is blocked on a call, clients can use this event to show a notification.\nIf the user is the current user, the client should leave the call screen as well","properties":{"blocked_by_user":{"$ref":"#/components/schemas/UserResponse","description":"The user that blocked the user, null if the user was blocked by server-side","title":"Blocked by","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.blocked_user","description":"The type of event: \"call.blocked_user\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user that was blocked","title":"User","x-stream-index":"003"}},"required":["type","created_at","call_cid","user"],"title":"BlockedUserEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"BlockedUserResponse":{"nullable":true,"properties":{"blocked_user":{"$ref":"#/components/schemas/UserResponse","description":"User who got blocked","title":"User","x-stream-index":"003"},"blocked_user_id":{"description":"ID of the user who got blocked","title":"UserID","type":"string","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who blocked another user","title":"User","x-stream-index":"001"},"user_id":{"description":"ID of the user who blocked another user","title":"UserID","type":"string","x-stream-index":"002"}},"required":["user","user_id","blocked_user","blocked_user_id","created_at"],"type":"object"},"BodyguardRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"},"severity_rules":{"items":{"$ref":"#/components/schemas/BodyguardSeverityRule"},"type":"array","x-stream-index":"003"}},"required":["label","action","severity_rules"],"type":"object"},"BodyguardSeverityRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"severity":{"enum":["low","medium","high","critical"],"type":"string","x-stream-index":"001"}},"required":["severity","action"],"type":"object"},"Bound":{"properties":{"inclusive":{"type":"boolean","x-stream-index":"002"},"value":{"format":"float","type":"number","x-stream-index":"001"}},"required":["value","inclusive"],"type":"object"},"BroadcastSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettings","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettings","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"BroadcastSettingsRequest":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettingsRequest","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettingsRequest","x-stream-index":"003"}},"type":"object"},"BroadcastSettingsResponse":{"description":"BroadcastSettingsResponse is the payload for broadcasting settings","properties":{"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettingsResponse","title":"HLS","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettingsResponse","title":"RTMP","x-stream-index":"003"}},"required":["enabled","hls","rtmp"],"title":"BroadcastSettingsResponse","type":"object"},"BrowserDataResponse":{"properties":{"name":{"type":"string","x-stream-index":"001"},"version":{"type":"string","x-stream-index":"002"}},"type":"object"},"BulkImageModerationRequest":{"nullable":true,"properties":{"csv_file":{"description":"URL to CSV file containing image URLs to moderate","title":"string","type":"string","x-stream-index":"001"}},"required":["csv_file"],"type":"object"},"BulkImageModerationResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"task_id":{"description":"ID of the task for processing the bulk image moderation","title":"string","type":"string","x-stream-index":"001"}},"required":["task_id","duration"],"type":"object"},"Call":{"properties":{"AppPK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"002"},"Backstage":{"type":"boolean","writeOnly":true,"x-stream-index":"023"},"BlockedUserIDs":{"items":{"type":"string"},"type":"array","writeOnly":true,"x-stream-index":"018"},"BlockedUsers":{"items":{"$ref":"#/components/schemas/User"},"type":"array","writeOnly":true,"x-stream-index":"019"},"CID":{"type":"string","writeOnly":true,"x-stream-index":"005"},"CallType":{"$ref":"#/components/schemas/CallType","x-stream-index":"020"},"ChannelCID":{"type":"string","writeOnly":true,"x-stream-index":"032"},"CreatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"013"},"CreatedBy":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"CreatedByUserID":{"type":"string","writeOnly":true,"x-stream-index":"007"},"CurrentSessionID":{"type":"string","writeOnly":true,"x-stream-index":"024"},"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"012"},"DeletedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"028"},"EgressUpdatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"027"},"Egresses":{"items":{"$ref":"#/components/schemas/CallEgress"},"type":"array","writeOnly":true,"x-stream-index":"015"},"EndedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"017"},"ID":{"type":"string","writeOnly":true,"x-stream-index":"004"},"JoinAheadTimeSeconds":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"031"},"LastHeartbeatAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"030"},"LastSessionID":{"type":"string","writeOnly":true,"x-stream-index":"025"},"MemberCount":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"010"},"MemberLookup":{"$ref":"#/components/schemas/MemberLookup","x-stream-index":"011"},"Members":{"items":{"$ref":"#/components/schemas/CallMember"},"type":"array","writeOnly":true,"x-stream-index":"009"},"Session":{"$ref":"#/components/schemas/CallSession","x-stream-index":"026"},"Settings":{"$ref":"#/components/schemas/CallSettings","x-stream-index":"022"},"SettingsOverrides":{"$ref":"#/components/schemas/CallSettings","x-stream-index":"021"},"StartsAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"016"},"Team":{"type":"string","writeOnly":true,"x-stream-index":"006"},"ThumbnailURL":{"type":"string","writeOnly":true,"x-stream-index":"029"},"Type":{"type":"string","writeOnly":true,"x-stream-index":"003"},"UpdatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"014"}},"required":["AppPK","Type","ID","CID","Team","CreatedByUserID","Members","Custom","CreatedAt","UpdatedAt","Egresses","BlockedUserIDs","BlockedUsers","Backstage","CurrentSessionID","LastSessionID","ThumbnailURL","ChannelCID"],"type":"object"},"CallAcceptedEvent":{"description":"This event is sent when a user accepts a notification to join a call.","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.accepted","description":"The type of event: \"call.accepted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who accepted the call","title":"User","x-stream-index":"004"}},"required":["type","created_at","call_cid","call","user"],"title":"CallAcceptedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallClosedCaption":{"description":"CallClosedCaption represents a closed caption of a call.","properties":{"end_time":{"format":"date-time","title":"The end time of the closed caption.","type":"number","x-stream-index":"003"},"speaker_id":{"title":"The speaker ID of the closed caption.","type":"string","x-stream-index":"004"},"start_time":{"format":"date-time","title":"The start time of the closed caption.","type":"number","x-stream-index":"002"},"text":{"title":"The text of the closed caption.","type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserResponse","title":"The full user for the closed caption.","x-stream-index":"005"}},"required":["text","start_time","end_time","speaker_id","user"],"title":"CallClosedCaption","type":"object"},"CallClosedCaptionsFailedEvent":{"description":"This event is sent when call closed captions has failed","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.closed_captions_failed","description":"The type of event: \"call.closed_captions_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallClosedCaptionsFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallClosedCaptionsStartedEvent":{"description":"This event is sent when call closed caption has started","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.closed_captions_started","description":"The type of event: \"call.closed_captions_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallClosedCaptionsStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallClosedCaptionsStoppedEvent":{"description":"This event is sent when call closed captions has stopped","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.closed_captions_stopped","description":"The type of event: \"call.transcription_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallClosedCaptionsStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallCreatedEvent":{"description":"This event is sent when a call is created. Clients receiving this event should check if the ringing\nfield is set to true and if so, show the call screen","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"the members added to this call","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"004"},"type":{"default":"call.created","description":"The type of event: \"call.created\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","members"],"title":"CallCreatedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallDeletedEvent":{"description":"This event is sent when a call is deleted. Clients receiving this event should leave the call screen","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.deleted","description":"The type of event: \"call.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call"],"title":"CallDeletedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallDurationReport":{"properties":{"histogram":{"items":{"$ref":"#/components/schemas/ReportByHistogramBucket"},"type":"array","x-stream-index":"001"}},"required":["histogram"],"type":"object"},"CallDurationReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateCallDurationReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"CallEgress":{"nullable":true,"properties":{"app_pk":{"format":"int32","type":"integer","x-stream-index":"002"},"call_id":{"type":"string","x-stream-index":"004"},"call_type":{"type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/EgressTaskConfig","x-stream-index":"007"},"egress_id":{"type":"string","x-stream-index":"005"},"egress_type":{"type":"string","x-stream-index":"006"},"instance_ip":{"type":"string","x-stream-index":"008"},"started_at":{"format":"date-time","type":"number","x-stream-index":"010"},"state":{"type":"string","x-stream-index":"009"},"stopped_at":{"format":"date-time","type":"number","x-stream-index":"011"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"012"}},"required":["app_pk","call_type","call_id","egress_id","egress_type","instance_ip","state","started_at","updated_at"],"type":"object"},"CallEndedEvent":{"description":"This event is sent when a call is mark as ended for all its participants. Clients receiving this event should leave the call screen","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"reason":{"description":"The reason why the call ended, if available","title":"CallEndedReason","type":"string","x-stream-index":"005"},"type":{"default":"call.ended","description":"The type of event: \"call.ended\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who ended the call, null if the call was ended by the server","title":"User","x-stream-index":"004"}},"required":["type","created_at","call_cid","call"],"title":"CallEndedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallFrameRecordingFailedEvent":{"description":"This event is sent when frame recording has failed","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.frame_recording_failed","description":"The type of event: \"call.frame_recording_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","egress_id"],"title":"CallFrameRecordingFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallFrameRecordingFrameReadyEvent":{"description":"This event is sent when a frame is captured from a call","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"captured_at":{"description":"The time the frame was captured","format":"date-time","title":"CapturedAt","type":"number","x-stream-index":"006"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"008"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"track_type":{"description":"The type of the track frame was captured from (TRACK_TYPE_VIDEO|TRACK_TYPE_SCREEN_SHARE)","title":"TrackType","type":"string","x-stream-index":"004"},"type":{"default":"call.frame_recording_ready","description":"The type of event: \"call.frame_recording_ready\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"url":{"description":"The URL of the frame","title":"URL","type":"string","x-stream-index":"005"},"users":{"additionalProperties":{"$ref":"#/components/schemas/UserResponse"},"description":"The users in the frame","title":"Users","type":"object","x-stream-index":"007"}},"required":["type","created_at","call_cid","session_id","track_type","url","captured_at","users","egress_id"],"title":"CallFrameRecordingFrameReadyEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallFrameRecordingStartedEvent":{"description":"This event is sent when frame recording has started","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.frame_recording_started","description":"The type of event: \"call.frame_recording_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","egress_id"],"title":"CallFrameRecordingStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallFrameRecordingStoppedEvent":{"description":"This event is sent when frame recording has stopped","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.frame_recording_stopped","description":"The type of event: \"call.frame_recording_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","egress_id"],"title":"CallFrameRecordingStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallHLSBroadcastingFailedEvent":{"description":"This event is sent when HLS broadcasting has failed","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.hls_broadcasting_failed","description":"The type of event: \"call.hls_broadcasting_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallHLSBroadcastingFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallHLSBroadcastingStartedEvent":{"description":"This event is sent when HLS broadcasting has started","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"hls_playlist_url":{"type":"string","x-stream-index":"004"},"type":{"default":"call.hls_broadcasting_started","description":"The type of event: \"call.hls_broadcasting_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","hls_playlist_url"],"title":"CallHLSBroadcastingStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallHLSBroadcastingStoppedEvent":{"description":"This event is sent when HLS broadcasting has stopped","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.hls_broadcasting_stopped","description":"The type of event: \"call.hls_broadcasting_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallHLSBroadcastingStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallIngressResponse":{"description":"CallIngressResponse is the payload for ingress settings","properties":{"rtmp":{"$ref":"#/components/schemas/RTMPIngress","title":"RTMP","x-stream-index":"001"}},"required":["rtmp"],"title":"CallIngressResponse","type":"object"},"CallLiveStartedEvent":{"description":"This event is sent when a call is started. Clients receiving this event should start the call.","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.live_started","description":"The type of event: \"call.live_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call"],"title":"CallLiveStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMember":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"010"},"role":{"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["user_id","role","custom","created_at","updated_at"],"type":"object"},"CallMemberAddedEvent":{"description":"This event is sent when one or more members are added to a call","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"the members added to this call","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"004"},"type":{"default":"call.member_added","description":"The type of event: \"call.member_added\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","members"],"title":"CallMemberAddedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMemberRemovedEvent":{"description":"This event is sent when one or more members are removed from a call","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"the list of member IDs removed from the call","items":{"type":"string"},"title":"Members","type":"array","x-stream-index":"004"},"type":{"default":"call.member_removed","description":"The type of event: \"call.member_removed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","members"],"title":"CallMemberRemovedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMemberUpdatedEvent":{"description":"This event is sent when one or more members are updated","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"The list of members that were updated","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"004"},"type":{"default":"call.member_updated","description":"The type of event: \"call.member_updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","members"],"title":"CallMemberUpdatedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMemberUpdatedPermissionEvent":{"description":"This event is sent when one or more members get its role updated","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"capabilities_by_role":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"The capabilities by role for this call","title":"CapabilitiesByRole","type":"object","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"The list of members that were updated","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"005"},"type":{"default":"call.member_updated_permission","description":"The type of event: \"call.member_added\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","capabilities_by_role","members"],"title":"CallMemberUpdatedPermissionEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMissedEvent":{"description":"This event is sent to call members who did not accept/reject/join the call to notify they missed the call","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"List of members who missed the call","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"005"},"notify_user":{"type":"boolean","x-stream-index":"007"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.missed","description":"The type of event: \"call.notification\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The caller from whom the call was missed","title":"User","x-stream-index":"006"}},"required":["type","created_at","call_cid","session_id","call","members","user","notify_user"],"title":"CallMissedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallModerationBlurEvent":{"properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"type":{"default":"call.moderation_blur","type":"string","x-stream-index":"001.001"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["type","created_at","call_cid","user_id","custom"],"title":"CallModerationBlurEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallModerationWarningEvent":{"properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"message":{"type":"string","x-stream-index":"004"},"type":{"default":"call.moderation_warning","type":"string","x-stream-index":"001.001"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["type","created_at","call_cid","user_id","message","custom"],"title":"CallModerationWarningEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallNotificationEvent":{"description":"This event is sent to all call members to notify they are getting called","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"Call members","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"005"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.notification","description":"The type of event: \"call.notification\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user that sent the call notification","title":"User","x-stream-index":"006"}},"required":["type","created_at","call_cid","session_id","call","members","user"],"title":"CallNotificationEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallParticipant":{"nullable":true,"properties":{"JoinedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"004"},"Role":{"type":"string","writeOnly":true,"x-stream-index":"002"},"UserSessionID":{"type":"string","writeOnly":true,"x-stream-index":"003"},"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"001.046"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"001.017"},"banned":{"type":"boolean","x-stream-index":"001.016"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.013"},"id":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"001.023"},"language":{"type":"string","x-stream-index":"001.035"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"001.022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"001.026"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.042"},"role":{"type":"string","x-stream-index":"001.004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.005"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.009"}},"required":["id","role","teams_role","custom","banned","online","Role","UserSessionID","JoinedAt"],"type":"object"},"CallParticipantCountReport":{"properties":{"histogram":{"items":{"$ref":"#/components/schemas/ReportByHistogramBucket"},"type":"array","x-stream-index":"001"}},"required":["histogram"],"type":"object"},"CallParticipantCountReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateCallParticipantCountReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"CallParticipantResponse":{"properties":{"joined_at":{"format":"date-time","type":"number","x-stream-index":"004"},"role":{"type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"},"user_session_id":{"type":"string","x-stream-index":"002"}},"required":["user","user_session_id","role","joined_at"],"type":"object"},"CallReactionEvent":{"description":"This event is sent when a reaction is sent in a call, clients should use this to show the reaction in the call screen","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"reaction":{"$ref":"#/components/schemas/ReactionResponse","description":"the reaction object sent by the user on the call","title":"reaction","x-stream-index":"003"},"type":{"default":"call.reaction_new","description":"The type of event: \"call.reaction_new\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","reaction"],"title":"CallReactionEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRecording":{"description":"CallRecording represents a recording of a call.","properties":{"end_time":{"format":"date-time","title":"The end time of the recording.","type":"number","x-stream-index":"004"},"filename":{"title":"The filename of the recording.","type":"string","x-stream-index":"001"},"session_id":{"title":"The session ID of the recording.","type":"string","x-stream-index":"005"},"start_time":{"format":"date-time","title":"The start time of the recording.","type":"number","x-stream-index":"003"},"url":{"title":"The URL of the recording.","type":"string","x-stream-index":"002"}},"required":["filename","url","start_time","end_time","session_id"],"title":"CallRecording","type":"object"},"CallRecordingFailedEvent":{"description":"This event is sent when call recording has failed","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"003"},"type":{"default":"call.recording_failed","description":"The type of event: \"call.recording_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","egress_id"],"title":"CallRecordingFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRecordingReadyEvent":{"description":"This event is sent when call recording is ready","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"call_recording":{"$ref":"#/components/schemas/CallRecording","description":"The call recording object","title":"CallRecording","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.recording_ready","description":"The type of event: \"call.recording_ready\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call_recording","egress_id"],"title":"CallRecordingReadyEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRecordingStartedEvent":{"description":"This event is sent when call recording has started","properties":{"call_cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"egress_id":{"type":"string","x-stream-index":"001"},"type":{"default":"call.recording_started","description":"The type of event: \"call.recording_started\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001"}},"required":["egress_id","type","created_at","call_cid"],"title":"CallRecordingStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRecordingStoppedEvent":{"description":"This event is sent when call recording has stopped","properties":{"call_cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"egress_id":{"type":"string","x-stream-index":"001"},"type":{"default":"call.recording_stopped","description":"The type of event: \"call.recording_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001"}},"required":["egress_id","type","created_at","call_cid"],"title":"CallRecordingStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRejectedEvent":{"description":"This event is sent when a user rejects a notification to join a call.","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"reason":{"description":"Provides information about why the call was rejected. You can provide any value, but the Stream API and SDKs use these default values: rejected, cancel, timeout and busy","title":"Reason","type":"string","x-stream-index":"005"},"type":{"default":"call.rejected","description":"The type of event: \"call.rejected\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who rejected the call","title":"User","x-stream-index":"004"}},"required":["type","created_at","call_cid","call","user"],"title":"CallRejectedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallReportResponse":{"properties":{"ended_at":{"format":"date-time","type":"number","x-stream-index":"003"},"score":{"format":"float","type":"number","x-stream-index":"001"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002"}},"required":["score"],"type":"object"},"CallRequest":{"description":"CallRequest is the payload for creating a call.","properties":{"channel_cid":{"type":"string","x-stream-index":"009"},"created_by":{"$ref":"#/components/schemas/UserRequest","title":"The user that create this call","x-stream-index":"002"},"created_by_id":{"title":"The id of the user that create this call","type":"string","x-stream-index":"003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"members":{"items":{"$ref":"#/components/schemas/MemberRequest"},"maximum":100,"type":"array","x-stream-index":"005"},"settings_override":{"$ref":"#/components/schemas/CallSettingsRequest","x-stream-index":"006"},"starts_at":{"format":"date-time","type":"number","x-stream-index":"007"},"team":{"type":"string","x-stream-index":"001"},"video":{"type":"boolean","x-stream-index":"008"}},"title":"CallRequest","type":"object"},"CallResponse":{"description":"Represents a call","properties":{"backstage":{"type":"boolean","x-stream-index":"016"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"018"},"captioning":{"type":"boolean","x-stream-index":"013"},"channel_cid":{"type":"string","x-stream-index":"024"},"cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"The user that created the call","title":"Created By","x-stream-index":"007"},"current_session_id":{"type":"string","x-stream-index":"005"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"008"},"egress":{"$ref":"#/components/schemas/EgressResponse","x-stream-index":"021"},"ended_at":{"description":"Date/time when the call ended","format":"date-time","title":"Ended At","type":"number","x-stream-index":"014"},"id":{"description":"Call ID","title":"ID","type":"string","x-stream-index":"003"},"ingress":{"$ref":"#/components/schemas/CallIngressResponse","x-stream-index":"019"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"023"},"recording":{"type":"boolean","x-stream-index":"011"},"session":{"$ref":"#/components/schemas/CallSessionResponse","x-stream-index":"020"},"settings":{"$ref":"#/components/schemas/CallSettingsResponse","x-stream-index":"017"},"starts_at":{"description":"Date/time when the call will start","format":"date-time","title":"Starts At","type":"number","x-stream-index":"015"},"team":{"type":"string","x-stream-index":"006"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailResponse","x-stream-index":"022"},"transcribing":{"type":"boolean","x-stream-index":"012"},"type":{"description":"The type of call","title":"Type","type":"string","x-stream-index":"002"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"}},"required":["type","id","cid","current_session_id","created_by","custom","created_at","updated_at","recording","transcribing","captioning","backstage","settings","blocked_user_ids","ingress","egress"],"title":"CallResponse","type":"object"},"CallRingEvent":{"description":"This event is sent to all call members to notify they are getting called","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"005"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"Call members","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"006"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.ring","description":"The type of event: \"call.notification\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user that sent the call notification","title":"User","x-stream-index":"007"},"video":{"type":"boolean","x-stream-index":"008"}},"required":["type","created_at","call_cid","session_id","call","members","user","video"],"title":"CallRingEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRtmpBroadcastFailedEvent":{"description":"This event is sent when a call RTMP broadcast has failed","properties":{"call_cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"002.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.002"},"name":{"description":"Name of the given RTMP broadcast","title":"Name","type":"string","x-stream-index":"003"},"type":{"default":"call.rtmp_broadcast_failed","description":"The type of event: \"call.rtmp_broadcast_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","name"],"title":"CallRtmpBroadcastFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRtmpBroadcastStartedEvent":{"description":"This event is sent when RTMP broadcast has started","properties":{"call_cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"002.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.002"},"name":{"description":"Name of the given RTMP broadcast","title":"Name","type":"string","x-stream-index":"003"},"type":{"default":"call.rtmp_broadcast_started","description":"The type of event: \"call.rtmp_broadcast_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","name"],"title":"CallRtmpBroadcastStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRtmpBroadcastStoppedEvent":{"description":"This event is sent when RTMP broadcast has stopped","properties":{"call_cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"002.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.002"},"name":{"description":"Name of the given RTMP broadcast","title":"Name","type":"string","x-stream-index":"003"},"type":{"default":"call.rtmp_broadcast_stopped","description":"The type of event: \"call.rtmp_broadcast_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","name"],"title":"CallRtmpBroadcastStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSession":{"properties":{"AcceptedBy":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","writeOnly":true,"x-stream-index":"008"},"ActiveSFUs":{"items":{"$ref":"#/components/schemas/SFUIDLastSeen"},"type":"array","writeOnly":true,"x-stream-index":"016"},"AnonymousParticipantCount":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"019"},"AppPK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"002.001"},"CallID":{"type":"string","writeOnly":true,"x-stream-index":"002.003"},"CallType":{"type":"string","writeOnly":true,"x-stream-index":"002.002"},"CreatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"003"},"DeletedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"004"},"EndedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"006"},"LiveEndedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"013"},"LiveStartedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"012"},"MissedBy":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","writeOnly":true,"x-stream-index":"010"},"Participants":{"items":{"$ref":"#/components/schemas/CallParticipant"},"type":"array","writeOnly":true,"x-stream-index":"011"},"ParticipantsCountByRole":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","writeOnly":true,"x-stream-index":"018"},"RejectedBy":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","writeOnly":true,"x-stream-index":"009"},"RingAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"007"},"SFUIDs":{"items":{"type":"string"},"type":"array","writeOnly":true,"x-stream-index":"015"},"SessionID":{"type":"string","writeOnly":true,"x-stream-index":"002.004"},"StartedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"005"},"TimerEndsAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"014"},"UserPermissionOverrides":{"additionalProperties":{"additionalProperties":{"type":"boolean"},"type":"object"},"type":"object","writeOnly":true,"x-stream-index":"017"}},"required":["AppPK","CallType","CallID","SessionID","CreatedAt","AcceptedBy","RejectedBy","MissedBy","Participants","SFUIDs","ActiveSFUs","UserPermissionOverrides","ParticipantsCountByRole","AnonymousParticipantCount"],"type":"object"},"CallSessionEndedEvent":{"description":"This event is sent when a call session ends","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_ended","description":"The type of event: \"call.session_ended\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","call"],"title":"CallSessionEndedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSessionParticipantCountsUpdatedEvent":{"description":"This event is sent when the participant counts in a call session are updated","properties":{"anonymous_participant_count":{"format":"int32","type":"integer","x-stream-index":"005"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"participants_count_by_role":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"004"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_participant_count_updated","description":"The type of event: \"call.session_participant_count_updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","participants_count_by_role","anonymous_participant_count"],"title":"CallSessionParticipantCountsUpdatedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSessionParticipantJoinedEvent":{"description":"This event is sent when a participant joins a call session","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"participant":{"$ref":"#/components/schemas/CallParticipantResponse","description":"The participant that joined the session","title":"Participant","x-stream-index":"004"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_participant_joined","description":"The type of event: \"call.session_participant_joined\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","participant"],"title":"CallSessionParticipantJoinedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSessionParticipantLeftEvent":{"description":"This event is sent when a participant leaves a call session","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"duration_seconds":{"description":"The duration participant was in the session in seconds","format":"int32","title":"Duration","type":"integer","x-stream-index":"005"},"participant":{"$ref":"#/components/schemas/CallParticipantResponse","description":"The participant that left the session","title":"Participant","x-stream-index":"004"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_participant_left","description":"The type of event: \"call.session_participant_left\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","participant","duration_seconds"],"title":"CallSessionParticipantLeftEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSessionResponse":{"properties":{"accepted_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"008"},"anonymous_participant_count":{"format":"int32","type":"integer","x-stream-index":"006"},"ended_at":{"format":"date-time","type":"number","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"live_ended_at":{"format":"date-time","type":"number","x-stream-index":"011"},"live_started_at":{"format":"date-time","type":"number","x-stream-index":"010"},"missed_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"009"},"participants":{"items":{"$ref":"#/components/schemas/CallParticipantResponse"},"type":"array","x-stream-index":"004"},"participants_count_by_role":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"005"},"rejected_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"007"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002"},"timer_ends_at":{"format":"date-time","type":"number","x-stream-index":"012"}},"required":["id","participants","participants_count_by_role","anonymous_participant_count","rejected_by","accepted_by","missed_by"],"type":"object"},"CallSessionStartedEvent":{"description":"This event is sent when a call session starts","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_started","description":"The type of event: \"call.session_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","call"],"title":"CallSessionStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSettings":{"properties":{"audio":{"$ref":"#/components/schemas/AudioSettings","x-stream-index":"001"},"backstage":{"$ref":"#/components/schemas/BackstageSettings","x-stream-index":"002"},"broadcasting":{"$ref":"#/components/schemas/BroadcastSettings","x-stream-index":"007"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordSettings","x-stream-index":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettings","x-stream-index":"008"},"ingress":{"$ref":"#/components/schemas/IngressSettings","x-stream-index":"014"},"limits":{"$ref":"#/components/schemas/LimitsSettings","x-stream-index":"012"},"recording":{"$ref":"#/components/schemas/RecordSettings","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettings","x-stream-index":"010"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettings","x-stream-index":"004"},"session":{"$ref":"#/components/schemas/SessionSettings","x-stream-index":"013"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettings","x-stream-index":"011"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettings","x-stream-index":"009"},"video":{"$ref":"#/components/schemas/VideoSettings","x-stream-index":"003"}},"type":"object"},"CallSettingsRequest":{"properties":{"audio":{"$ref":"#/components/schemas/AudioSettingsRequest","x-stream-index":"001"},"backstage":{"$ref":"#/components/schemas/BackstageSettingsRequest","x-stream-index":"002"},"broadcasting":{"$ref":"#/components/schemas/BroadcastSettingsRequest","x-stream-index":"010"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordingSettingsRequest","x-stream-index":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettingsRequest","x-stream-index":"003"},"ingress":{"$ref":"#/components/schemas/IngressSettingsRequest","x-stream-index":"014"},"limits":{"$ref":"#/components/schemas/LimitsSettingsRequest","x-stream-index":"012"},"recording":{"$ref":"#/components/schemas/RecordSettingsRequest","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettingsRequest","x-stream-index":"007"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettingsRequest","x-stream-index":"008"},"session":{"$ref":"#/components/schemas/SessionSettingsRequest","x-stream-index":"013"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettingsRequest","x-stream-index":"011"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettingsRequest","x-stream-index":"009"},"video":{"$ref":"#/components/schemas/VideoSettingsRequest","x-stream-index":"004"}},"type":"object"},"CallSettingsResponse":{"properties":{"audio":{"$ref":"#/components/schemas/AudioSettingsResponse","x-stream-index":"001"},"backstage":{"$ref":"#/components/schemas/BackstageSettingsResponse","x-stream-index":"002"},"broadcasting":{"$ref":"#/components/schemas/BroadcastSettingsResponse","x-stream-index":"003"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordingSettingsResponse","x-stream-index":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettingsResponse","x-stream-index":"004"},"ingress":{"$ref":"#/components/schemas/IngressSettingsResponse","x-stream-index":"014"},"limits":{"$ref":"#/components/schemas/LimitsSettingsResponse","x-stream-index":"012"},"recording":{"$ref":"#/components/schemas/RecordSettingsResponse","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettingsResponse","x-stream-index":"007"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettingsResponse","x-stream-index":"008"},"session":{"$ref":"#/components/schemas/SessionSettingsResponse","x-stream-index":"013"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettingsResponse","x-stream-index":"011"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettingsResponse","x-stream-index":"009"},"video":{"$ref":"#/components/schemas/VideoSettingsResponse","x-stream-index":"010"}},"required":["audio","backstage","broadcasting","geofencing","recording","frame_recording","ring","screensharing","transcription","video","thumbnails","limits","session"],"type":"object"},"CallStateResponseFields":{"description":"CallStateResponseFields is the payload for call state response","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001"},"members":{"description":"List of call members","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"002"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"004"}},"required":["call","members","own_capabilities","blocked_users"],"title":"CallStateResponseFields","type":"object"},"CallStatsReportReadyEvent":{"description":"This event is sent when the insights report is ready","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.stats_report_ready","description":"The type of event, \"call.report_ready\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id"],"title":"CallStatsReportReadyEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallStatsReportSummaryResponse":{"properties":{"call_cid":{"type":"string","x-stream-index":"001"},"call_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"008"},"call_session_id":{"type":"string","x-stream-index":"002"},"call_status":{"type":"string","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"first_stats_time":{"format":"date-time","type":"number","x-stream-index":"003"},"min_user_rating":{"format":"int32","type":"integer","x-stream-index":"006"},"quality_score":{"format":"int32","type":"integer","x-stream-index":"005"}},"required":["call_cid","call_session_id","first_stats_time","call_status","call_duration_seconds"],"type":"object"},"CallTranscription":{"description":"CallTranscription represents a transcription of a call.","properties":{"end_time":{"format":"date-time","title":"The end time of the transcription.","type":"number","x-stream-index":"004"},"filename":{"title":"The filename of the transcription.","type":"string","x-stream-index":"001"},"session_id":{"title":"The session ID of the transcription.","type":"string","x-stream-index":"005"},"start_time":{"format":"date-time","title":"The start time of the transcription.","type":"number","x-stream-index":"003"},"url":{"title":"The URL of the transcription.","type":"string","x-stream-index":"002"}},"required":["filename","url","start_time","end_time","session_id"],"title":"CallTranscription","type":"object"},"CallTranscriptionFailedEvent":{"description":"This event is sent when call transcription has failed","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"003"},"error":{"description":"The error message detailing why transcription failed.","title":"string","type":"string","x-stream-index":"004"},"type":{"default":"call.transcription_failed","description":"The type of event: \"call.transcription_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","egress_id"],"title":"CallTranscriptionFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallTranscriptionReadyEvent":{"description":"This event is sent when call transcription is ready","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"call_transcription":{"$ref":"#/components/schemas/CallTranscription","description":"The call transcription object","title":"CallTranscription","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.transcription_ready","description":"The type of event: \"call.transcription_ready\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call_transcription","egress_id"],"title":"CallTranscriptionReadyEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallTranscriptionStartedEvent":{"description":"This event is sent when call transcription has started","properties":{"call_cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"egress_id":{"type":"string","x-stream-index":"001"},"type":{"default":"call.transcription_started","description":"The type of event: \"call.transcription_started\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001"}},"required":["egress_id","type","created_at","call_cid"],"title":"CallTranscriptionStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallTranscriptionStoppedEvent":{"description":"This event is sent when call transcription has stopped","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"003"},"type":{"default":"call.transcription_stopped","description":"The type of event: \"call.transcription_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","egress_id"],"title":"CallTranscriptionStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallType":{"nullable":true,"properties":{"AppPK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"003"},"CreatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"005"},"ExternalStorage":{"type":"string","writeOnly":true,"x-stream-index":"009"},"Name":{"type":"string","writeOnly":true,"x-stream-index":"004"},"NotificationSettings":{"$ref":"#/components/schemas/NotificationSettings","x-stream-index":"008"},"PK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"002"},"Settings":{"$ref":"#/components/schemas/CallSettings","x-stream-index":"007"},"UpdatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"006"}},"required":["PK","AppPK","Name","CreatedAt","UpdatedAt","ExternalStorage"],"type":"object"},"CallTypeResponse":{"description":"CallTypeResponse is the payload for a call type.","properties":{"created_at":{"description":"the time the call type was created","format":"date-time","title":"CreatedAt","type":"number","x-stream-index":"005"},"external_storage":{"description":"the external storage for the call type","title":"ExternalStorage","type":"string","x-stream-index":"007"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"the permissions granted to each role","title":"Grants","type":"object","x-stream-index":"002"},"name":{"description":"the name of the call type","title":"Name","type":"string","x-stream-index":"001"},"notification_settings":{"$ref":"#/components/schemas/NotificationSettings","description":"the notification settings for the call type","title":"NotificationSettings","x-stream-index":"004"},"settings":{"$ref":"#/components/schemas/CallSettingsResponse","description":"the settings for the call type","title":"Settings","x-stream-index":"003"},"updated_at":{"description":"the time the call type was last updated","format":"date-time","title":"UpdatedAt","type":"number","x-stream-index":"006"}},"required":["name","grants","settings","notification_settings","created_at","updated_at"],"title":"CallTypeResponse","type":"object"},"CallUpdatedEvent":{"description":"This event is sent when a call is updated, clients should use this update the local state of the call.\nThis event also contains the capabilities by role for the call, clients should update the own_capability for the current.","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"capabilities_by_role":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"The capabilities by role for this call","title":"CapabilitiesByRole","type":"object","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.updated","description":"The type of event: \"call.ended\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","capabilities_by_role"],"title":"CallUpdatedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallUserFeedbackSubmittedEvent":{"description":"This event is sent when a user submits feedback for a call.","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"custom":{"additionalProperties":{},"description":"Custom data provided by the user","title":"Custom","type":"object","x-stream-index":"007"},"rating":{"description":"The rating given by the user (1-5)","format":"int32","title":"Rating","type":"integer","x-stream-index":"005"},"reason":{"description":"The reason provided by the user for the rating","title":"Reason","type":"string","x-stream-index":"006"},"sdk":{"type":"string","x-stream-index":"008"},"sdk_version":{"type":"string","x-stream-index":"009"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.user_feedback_submitted","description":"The type of event, \"call.user_feedback\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who submitted the feedback","title":"User","x-stream-index":"004"}},"required":["type","created_at","call_cid","session_id","user","rating"],"title":"CallUserFeedbackSubmittedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallUserMutedEvent":{"description":"This event is sent when a call member is muted","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"from_user_id":{"type":"string","x-stream-index":"003"},"muted_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"type":{"default":"call.user_muted","description":"The type of event: \"call.user_muted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","from_user_id","muted_user_ids"],"title":"CallUserMutedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallsPerDayReport":{"properties":{"count":{"format":"int64","type":"integer","x-stream-index":"001"}},"required":["count"],"type":"object"},"CallsPerDayReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateCallsPerDayReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"CampaignChannelTemplate":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"002"},"members":{"items":{"type":"string"},"maximum":1000,"type":"array","x-stream-index":"003"},"team":{"maxLength":1000,"type":"string","x-stream-index":"004"},"type":{"maxLength":64,"type":"string","x-stream-index":"001"}},"required":["type","custom"],"type":"object"},"CampaignCompletedEvent":{"nullable":true,"properties":{"campaign":{"$ref":"#/components/schemas/CampaignResponse","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"type":{"default":"campaign.completed","type":"string","x-stream-index":"001.002"}},"required":["type","created_at","custom"],"title":"CampaignCompletedEvent","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"},"CampaignMessageTemplate":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"maximum":30,"type":"array","x-stream-index":"002"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"poll_id":{"type":"string","x-stream-index":"003"},"text":{"type":"string","x-stream-index":"001"}},"required":["text","attachments","poll_id","custom"],"type":"object"},"CampaignResponse":{"properties":{"channel_template":{"$ref":"#/components/schemas/CampaignChannelTemplate","x-stream-index":"016"},"create_channels":{"type":"boolean","x-stream-index":"008"},"created_at":{"format":"date-time","type":"number","x-stream-index":"020"},"description":{"type":"string","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"001"},"message_template":{"$ref":"#/components/schemas/CampaignMessageTemplate","x-stream-index":"015"},"name":{"type":"string","x-stream-index":"007"},"scheduled_for":{"format":"date-time","type":"number","x-stream-index":"013"},"segment_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"002"},"segments":{"items":{"$ref":"#/components/schemas/Segment"},"type":"array","x-stream-index":"003"},"sender":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"005"},"sender_id":{"type":"string","x-stream-index":"004"},"sender_mode":{"type":"string","x-stream-index":"006"},"show_channels":{"type":"boolean","x-stream-index":"009"},"skip_push":{"type":"boolean","x-stream-index":"011"},"skip_webhook":{"type":"boolean","x-stream-index":"012"},"stats":{"$ref":"#/components/schemas/CampaignStatsResponse","x-stream-index":"022"},"status":{"type":"string","x-stream-index":"019"},"stop_at":{"format":"date-time","type":"number","x-stream-index":"014"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"021"},"user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"017"},"users":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"018"}},"required":["id","segment_ids","segments","sender_id","sender_mode","name","create_channels","show_channels","description","skip_push","skip_webhook","user_ids","users","status","created_at","updated_at","stats"],"type":"object"},"CampaignStartedEvent":{"nullable":true,"properties":{"campaign":{"$ref":"#/components/schemas/CampaignResponse","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"type":{"default":"campaign.started","type":"string","x-stream-index":"001.002"}},"required":["type","created_at","custom"],"title":"CampaignStartedEvent","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"},"CampaignStatsResponse":{"properties":{"progress":{"format":"float","type":"number","x-stream-index":"005"},"stats_channels_created":{"format":"int32","type":"integer","x-stream-index":"004"},"stats_completed_at":{"format":"date-time","type":"number","x-stream-index":"002"},"stats_messages_sent":{"format":"int32","type":"integer","x-stream-index":"003"},"stats_started_at":{"format":"date-time","type":"number","x-stream-index":"001"},"stats_users_read":{"format":"int32","type":"integer","x-stream-index":"007"},"stats_users_sent":{"format":"int32","type":"integer","x-stream-index":"006"}},"required":["stats_started_at","stats_completed_at","stats_messages_sent","stats_channels_created","progress","stats_users_sent","stats_users_read"],"type":"object"},"CastPollVoteRequest":{"nullable":true,"properties":{"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"005.002"},"user_id":{"type":"string","x-stream-index":"005.001"},"vote":{"$ref":"#/components/schemas/VoteData","description":"Vote data","title":"VoteData","x-stream-index":"004"}},"type":"object"},"Channel":{"properties":{"active_live_locations":{"items":{"$ref":"#/components/schemas/SharedLocation"},"type":"array","x-stream-index":"034"},"auto_translation_enabled":{"type":"boolean","x-stream-index":"029"},"auto_translation_language":{"type":"string","x-stream-index":"030"},"cid":{"type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/ChannelConfig","x-stream-index":"026"},"config_overrides":{"$ref":"#/components/schemas/ConfigOverrides","x-stream-index":"027"},"cooldown":{"format":"int32","type":"integer","x-stream-index":"031"},"created_at":{"format":"date-time","type":"number","x-stream-index":"009"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"019"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"disabled":{"type":"boolean","x-stream-index":"017"},"frozen":{"type":"boolean","x-stream-index":"016"},"id":{"type":"string","x-stream-index":"004"},"invites":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"022"},"last_campaigns":{"type":"string","x-stream-index":"032"},"last_message_at":{"format":"date-time","type":"number","x-stream-index":"006"},"member_count":{"format":"int32","type":"integer","x-stream-index":"021"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"020"},"team":{"type":"string","x-stream-index":"028"},"truncated_by":{"$ref":"#/components/schemas/User","x-stream-index":"015"},"type":{"type":"string","x-stream-index":"005"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"010"}},"required":["cid","id","type","created_at","updated_at","frozen","disabled","custom","auto_translation_language"],"type":"object"},"ChannelConfig":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.026"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.021"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.022"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.027"},"blocklist":{"type":"string","x-stream-index":"001.023"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.024"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.025"},"commands":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"connect_events":{"type":"boolean","x-stream-index":"001.004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"custom_events":{"type":"boolean","x-stream-index":"001.012"},"mark_messages_pending":{"type":"boolean","x-stream-index":"001.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"001.020"},"mutes":{"type":"boolean","x-stream-index":"001.009"},"name":{"type":"string","x-stream-index":"001.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"001.028"},"partition_ttl":{"type":"integer","x-stream-index":"001.029"},"polls":{"type":"boolean","x-stream-index":"001.016"},"push_notifications":{"type":"boolean","x-stream-index":"001.013"},"quotes":{"type":"boolean","x-stream-index":"001.008"},"reactions":{"type":"boolean","x-stream-index":"001.006"},"read_events":{"type":"boolean","x-stream-index":"001.003"},"reminders":{"type":"boolean","x-stream-index":"001.014"},"replies":{"type":"boolean","x-stream-index":"001.007"},"search":{"type":"boolean","x-stream-index":"001.005"},"shared_locations":{"type":"boolean","x-stream-index":"001.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.030"},"typing_events":{"type":"boolean","x-stream-index":"001.002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"002.004"},"uploads":{"type":"boolean","x-stream-index":"001.010"},"url_enrichment":{"type":"boolean","x-stream-index":"001.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"001.017"}},"required":["name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","created_at","updated_at","commands"],"type":"object"},"ChannelConfigWithInfo":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.002.026"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.002.021"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.022"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.002.027"},"blocklist":{"type":"string","x-stream-index":"001.002.023"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.024"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.002.025"},"commands":{"items":{"$ref":"#/components/schemas/Command"},"type":"array","x-stream-index":"001.003"},"connect_events":{"type":"boolean","x-stream-index":"001.002.004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.001.003"},"custom_events":{"type":"boolean","x-stream-index":"001.002.012"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"002"},"mark_messages_pending":{"type":"boolean","x-stream-index":"001.002.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"001.002.020"},"mutes":{"type":"boolean","x-stream-index":"001.002.009"},"name":{"type":"string","x-stream-index":"001.002.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"001.002.028"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"001.002.029"},"polls":{"type":"boolean","x-stream-index":"001.002.016"},"push_notifications":{"type":"boolean","x-stream-index":"001.002.013"},"quotes":{"type":"boolean","x-stream-index":"001.002.008"},"reactions":{"type":"boolean","x-stream-index":"001.002.006"},"read_events":{"type":"boolean","x-stream-index":"001.002.003"},"reminders":{"type":"boolean","x-stream-index":"001.002.014"},"replies":{"type":"boolean","x-stream-index":"001.002.007"},"search":{"type":"boolean","x-stream-index":"001.002.005"},"shared_locations":{"type":"boolean","x-stream-index":"001.002.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.002.030"},"typing_events":{"type":"boolean","x-stream-index":"001.002.002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"uploads":{"type":"boolean","x-stream-index":"001.002.010"},"url_enrichment":{"type":"boolean","x-stream-index":"001.002.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"001.002.017"}},"required":["created_at","updated_at","name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","commands"],"type":"object"},"ChannelCreatedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"channel.created","type":"string","x-stream-index":"001.001"}},"required":["type","created_at"],"title":"ChannelCreatedEvent","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"},"ChannelDeletedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003.004"},"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"003.005"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"team":{"type":"string","x-stream-index":"001.001"},"type":{"default":"channel.deleted","type":"string","x-stream-index":"002.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"ChannelDeletedEvent","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"},"ChannelExport":{"properties":{"cid":{"type":"string","x-stream-index":"003"},"id":{"description":"Channel ID","title":"ID","type":"string","x-stream-index":"002"},"messages_since":{"description":"Date to export messages since","format":"date-time","title":"Messages since","type":"number","x-stream-index":"004"},"messages_until":{"description":"Date to export messages until","format":"date-time","title":"Messages until","type":"number","x-stream-index":"005"},"type":{"description":"Channel type","title":"Type","type":"string","x-stream-index":"001"}},"title":"Channel Export","type":"object"},"ChannelFrozenEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"channel.frozen","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"ChannelFrozenEvent","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"},"ChannelGetOrCreateRequest":{"nullable":true,"properties":{"data":{"$ref":"#/components/schemas/ChannelInput","x-stream-index":"003"},"hide_for_creator":{"description":"Whether this channel will be hidden for the user who created the channel or not","title":"Hide for creator","type":"boolean","x-stream-index":"007"},"members":{"$ref":"#/components/schemas/PaginationParams","x-stream-index":"010"},"messages":{"$ref":"#/components/schemas/MessagePaginationParams","x-stream-index":"009"},"state":{"description":"Refresh channel state","title":"State","type":"boolean","x-stream-index":"005"},"thread_unread_counts":{"type":"boolean","x-stream-index":"008"},"watchers":{"$ref":"#/components/schemas/PaginationParams","x-stream-index":"011"}},"type":"object"},"ChannelHiddenEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003.004"},"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"003.005"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"clear_history":{"type":"boolean","x-stream-index":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"type":{"default":"channel.hidden","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["clear_history","cid","channel_id","channel_type","channel_member_count","type","created_at"],"title":"ChannelHiddenEvent","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"},"ChannelInput":{"properties":{"auto_translation_enabled":{"description":"Enable or disable auto translation","title":"Auto translation","type":"boolean","x-stream-index":"005"},"auto_translation_language":{"description":"Switch auto translation language","title":"Auto translation language","type":"string","x-stream-index":"006"},"config_overrides":{"$ref":"#/components/schemas/ChannelConfig","x-stream-index":"024"},"created_by":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"009"},"created_by_id":{"type":"string","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"015"},"disabled":{"type":"boolean","x-stream-index":"014"},"frozen":{"description":"Freeze or unfreeze the channel","title":"Frozen","type":"boolean","x-stream-index":"013"},"invites":{"items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"type":"array","x-stream-index":"016"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"type":"array","x-stream-index":"018"},"team":{"description":"Team the channel belongs to (if multi-tenant mode is enabled)","title":"Team","type":"string","x-stream-index":"004"},"truncated_by_id":{"type":"string","x-stream-index":"010"}},"type":"object"},"ChannelMember":{"nullable":true,"properties":{"archived_at":{"format":"date-time","type":"number","x-stream-index":"015"},"ban_expires":{"description":"Expiration date of the ban","format":"date-time","title":"Ban expires","type":"number","x-stream-index":"013"},"banned":{"description":"Whether member is banned this channel or not","title":"Banned","type":"boolean","x-stream-index":"012"},"channel_role":{"description":"Role of the member in the channel","title":"Channel Role","type":"string","x-stream-index":"018"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"invite_accepted_at":{"description":"Date when invite was accepted","format":"date-time","title":"Invited accepted at","type":"number","x-stream-index":"006"},"invite_rejected_at":{"description":"Date when invite was rejected","format":"date-time","title":"Invited rejected at","type":"number","x-stream-index":"007"},"invited":{"description":"Whether member was invited or not","title":"Invited","type":"boolean","x-stream-index":"005"},"is_moderator":{"description":"Whether member is channel moderator or not","title":"Is moderator","type":"boolean","x-stream-index":"003"},"notifications_muted":{"type":"boolean","x-stream-index":"019"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"016"},"role":{"description":"Permission level of the member in the channel (DEPRECATED: use channel_role instead)","enum":["member","moderator","admin","owner"],"title":"Role","type":"string","x-stream-index":"017"},"shadow_banned":{"description":"Whether member is shadow banned in this channel or not","title":"Shadow banned","type":"boolean","x-stream-index":"014"},"status":{"type":"string","x-stream-index":"008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"},"user_id":{"title":"User ID","type":"string","x-stream-index":"001"}},"required":["custom","created_at","updated_at","banned","shadow_banned","channel_role","notifications_muted"],"title":"Channel member","type":"object"},"ChannelMemberResponse":{"nullable":true,"properties":{"archived_at":{"format":"date-time","type":"number","x-stream-index":"016"},"ban_expires":{"description":"Expiration date of the ban","format":"date-time","title":"Ban expires","type":"number","x-stream-index":"013"},"banned":{"description":"Whether member is banned this channel or not","title":"Banned","type":"boolean","x-stream-index":"012"},"channel_role":{"description":"Role of the member in the channel","title":"Channel Role","type":"string","x-stream-index":"018"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"invite_accepted_at":{"description":"Date when invite was accepted","format":"date-time","title":"Invited accepted at","type":"number","x-stream-index":"006"},"invite_rejected_at":{"description":"Date when invite was rejected","format":"date-time","title":"Invited rejected at","type":"number","x-stream-index":"007"},"invited":{"description":"Whether member was invited or not","title":"Invited","type":"boolean","x-stream-index":"005"},"is_moderator":{"description":"Whether member is channel moderator or not","title":"Is moderator","type":"boolean","x-stream-index":"003"},"notifications_muted":{"type":"boolean","x-stream-index":"019"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"015"},"role":{"description":"Permission level of the member in the channel (DEPRECATED: use channel_role instead)","enum":["member","moderator","admin","owner"],"title":"Role","type":"string","x-stream-index":"017"},"shadow_banned":{"description":"Whether member is shadow banned in this channel or not","title":"Shadow banned","type":"boolean","x-stream-index":"014"},"status":{"type":"string","x-stream-index":"008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"},"user_id":{"title":"User ID","type":"string","x-stream-index":"001"}},"required":["custom","created_at","updated_at","banned","shadow_banned","channel_role","notifications_muted"],"title":"Channel member","type":"object"},"ChannelMessages":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001"},"messages":{"items":{"$ref":"#/components/schemas/Message"},"type":"array","x-stream-index":"002"}},"required":["messages"],"type":"object"},"ChannelMute":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel that is muted","title":"Channel","x-stream-index":"002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"004"},"expires":{"description":"Date/time of mute expiration","format":"date-time","title":"Expires","type":"number","x-stream-index":"003"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Owner of channel mute","title":"User","x-stream-index":"001"}},"required":["created_at","updated_at"],"type":"object"},"ChannelMutedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"channel.muted","type":"string","x-stream-index":"001.001"}},"required":["type","created_at"],"title":"ChannelMutedEvent","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"},"ChannelOwnCapability":{"description":"All possibility of string to use","enum":["ban-channel-members","cast-poll-vote","connect-events","create-attachment","delete-any-message","delete-channel","delete-own-message","flag-message","freeze-channel","join-channel","leave-channel","mute-channel","pin-message","query-poll-votes","quote-message","read-events","search-messages","send-custom-events","send-links","send-message","send-poll","send-reaction","send-reply","send-restricted-visibility-message","send-typing-events","set-channel-cooldown","share-location","skip-slow-mode","slow-mode","typing-events","update-any-message","update-channel","update-channel-members","update-own-message","update-thread","upload-file"],"title":"ChannelOwnCapability","type":"string"},"ChannelPushPreferences":{"properties":{"chat_level":{"type":"string","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"number","x-stream-index":"002"}},"type":"object"},"ChannelResponse":{"description":"Represents channel in chat","properties":{"auto_translation_enabled":{"description":"Whether auto translation is enabled or not","title":"Auto translation","type":"boolean","x-stream-index":"017"},"auto_translation_language":{"description":"Language to translate to when auto translation is active","title":"Auto translation language","type":"string","x-stream-index":"018"},"blocked":{"description":"Whether this channel is blocked by current user or not","title":"Blocked","type":"boolean","x-stream-index":"023"},"cid":{"description":"Channel CID (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/ChannelConfigWithInfo","description":"Channel configuration","title":"ChannelConfigWithInfo","x-stream-index":"013"},"cooldown":{"description":"Cooldown period after sending each message","format":"int32","title":"Cooldown","type":"integer","x-stream-index":"020"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"005"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"Creator of the channel","title":"UserResponse","x-stream-index":"008"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"026"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"007"},"disabled":{"type":"boolean","x-stream-index":"010"},"frozen":{"description":"Whether channel is frozen or not","title":"Frozen","type":"boolean","x-stream-index":"009"},"hidden":{"description":"Whether this channel is hidden by current user or not","title":"Hidden","type":"boolean","x-stream-index":"022"},"hide_messages_before":{"description":"Date since when the message history is accessible","format":"date-time","title":"Hide messages before","type":"number","x-stream-index":"019"},"id":{"description":"Channel unique ID","title":"ID","type":"string","x-stream-index":"001"},"last_message_at":{"description":"Date of the last message sent","format":"date-time","title":"Last message at","type":"number","x-stream-index":"004"},"member_count":{"description":"Number of members in the channel","format":"int32","title":"Member count","type":"integer","x-stream-index":"012"},"members":{"description":"List of channel members (max 100)","items":{"$ref":"#/components/schemas/ChannelMember"},"title":"ChannelMembers","type":"array","x-stream-index":"011"},"mute_expires_at":{"description":"Date of mute expiration","format":"date-time","title":"Mute expires at","type":"number","x-stream-index":"015"},"muted":{"description":"Whether this channel is muted or not","title":"Muted","type":"boolean","x-stream-index":"014"},"own_capabilities":{"description":"List of channel capabilities of authenticated user","items":{"$ref":"#/components/schemas/ChannelOwnCapability"},"title":"ChannelOwnCapability","type":"array","x-stream-index":"021"},"team":{"description":"Team the channel belongs to (multi-tenant only)","title":"Team","type":"string","x-stream-index":"016"},"truncated_at":{"description":"Date of the latest truncation of the channel","format":"date-time","title":"UserResponse","type":"number","x-stream-index":"024"},"truncated_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"025"},"type":{"description":"Type of the channel","title":"Type","type":"string","x-stream-docs-page-id":"channel_features","x-stream-index":"002"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"006"}},"required":["id","type","cid","created_at","updated_at","frozen","disabled","custom"],"title":"Channel","type":"object"},"ChannelStateResponse":{"nullable":true,"properties":{"active_live_locations":{"items":{"$ref":"#/components/schemas/SharedLocationResponseData"},"type":"array","x-stream-index":"001.015"},"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001.001"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001.014"},"duration":{"type":"string","x-stream-index":"002.001"},"hidden":{"type":"boolean","x-stream-index":"001.011"},"hide_messages_before":{"format":"date-time","type":"number","x-stream-index":"001.012"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"001.007"},"membership":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"001.008"},"messages":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","x-stream-index":"001.002"},"pending_messages":{"items":{"$ref":"#/components/schemas/PendingMessageResponse"},"type":"array","x-stream-index":"001.013"},"pinned_messages":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","x-stream-index":"001.003"},"push_preferences":{"$ref":"#/components/schemas/ChannelPushPreferences","x-stream-index":"001.009"},"read":{"items":{"$ref":"#/components/schemas/ReadStateResponse"},"type":"array","x-stream-index":"001.006"},"threads":{"items":{"$ref":"#/components/schemas/ThreadStateResponse"},"type":"array","x-stream-index":"001.010"},"watcher_count":{"format":"int32","type":"integer","x-stream-index":"001.004"},"watchers":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"001.005"}},"required":["messages","pinned_messages","members","threads","duration"],"type":"object"},"ChannelStateResponseFields":{"properties":{"active_live_locations":{"description":"Active live locations in the channel","items":{"$ref":"#/components/schemas/SharedLocationResponseData"},"title":"Active Live Locations","type":"array","x-stream-index":"015"},"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"014"},"hidden":{"description":"Whether this channel is hidden or not","title":"Hidden","type":"boolean","x-stream-index":"011"},"hide_messages_before":{"description":"Messages before this date are hidden from the user","format":"date-time","title":"Hide messages before","type":"number","x-stream-index":"012"},"members":{"description":"List of channel members","items":{"$ref":"#/components/schemas/ChannelMember"},"title":"Members","type":"array","x-stream-index":"007"},"membership":{"$ref":"#/components/schemas/ChannelMember","description":"Current user membership object","title":"Membership","x-stream-index":"008"},"messages":{"description":"List of channel messages","items":{"$ref":"#/components/schemas/MessageResponse"},"title":"Message","type":"array","x-stream-index":"002"},"pending_messages":{"description":"Pending messages that this user has sent","items":{"$ref":"#/components/schemas/PendingMessageResponse"},"title":"Pending messages","type":"array","x-stream-index":"013"},"pinned_messages":{"description":"List of pinned messages in the channel","items":{"$ref":"#/components/schemas/MessageResponse"},"title":"Pinned messages","type":"array","x-stream-docs-page-id":"pinned_messages","x-stream-index":"003"},"push_preferences":{"$ref":"#/components/schemas/ChannelPushPreferences","x-stream-index":"009"},"read":{"description":"List of read states","items":{"$ref":"#/components/schemas/ReadStateResponse"},"title":"Read","type":"array","x-stream-index":"006"},"threads":{"items":{"$ref":"#/components/schemas/ThreadStateResponse"},"type":"array","x-stream-index":"010"},"watcher_count":{"description":"Number of channel watchers","format":"int32","title":"Watcher count","type":"integer","x-stream-index":"004"},"watchers":{"description":"List of user who is watching the channel","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Watchers","type":"array","x-stream-index":"005"}},"required":["messages","pinned_messages","members","threads"],"type":"object"},"ChannelTruncatedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001.004"},"channel_id":{"type":"string","x-stream-index":"001.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"001.005"},"channel_type":{"type":"string","x-stream-index":"001.003"},"cid":{"type":"string","x-stream-index":"001.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"type":{"default":"channel.truncated","type":"string","x-stream-index":"002.001"}},"required":["cid","channel_id","channel_type","channel_member_count","type","created_at"],"title":"ChannelTruncatedEvent","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"},"ChannelTypeConfig":{"nullable":true,"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"003.002.026"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"003.002.021"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.002.022"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"003.002.027"},"blocklist":{"type":"string","x-stream-index":"003.002.023"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.002.024"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"003.002.025"},"commands":{"items":{"$ref":"#/components/schemas/Command"},"type":"array","x-stream-index":"003.003"},"connect_events":{"type":"boolean","x-stream-index":"003.002.004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.001.003"},"custom_events":{"type":"boolean","x-stream-index":"003.002.012"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"002"},"mark_messages_pending":{"type":"boolean","x-stream-index":"003.002.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"003.002.020"},"mutes":{"type":"boolean","x-stream-index":"003.002.009"},"name":{"type":"string","x-stream-index":"003.002.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"003.002.028"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"003.002.029"},"permissions":{"items":{"$ref":"#/components/schemas/PolicyRequest"},"type":"array","x-stream-index":"001"},"polls":{"type":"boolean","x-stream-index":"003.002.016"},"push_notifications":{"type":"boolean","x-stream-index":"003.002.013"},"quotes":{"type":"boolean","x-stream-index":"003.002.008"},"reactions":{"type":"boolean","x-stream-index":"003.002.006"},"read_events":{"type":"boolean","x-stream-index":"003.002.003"},"reminders":{"type":"boolean","x-stream-index":"003.002.014"},"replies":{"type":"boolean","x-stream-index":"003.002.007"},"search":{"type":"boolean","x-stream-index":"003.002.005"},"shared_locations":{"type":"boolean","x-stream-index":"003.002.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"003.002.030"},"typing_events":{"type":"boolean","x-stream-index":"003.002.002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"003.001.004"},"uploads":{"type":"boolean","x-stream-index":"003.002.010"},"url_enrichment":{"type":"boolean","x-stream-index":"003.002.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"003.002.017"}},"required":["permissions","grants","created_at","updated_at","name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","commands"],"type":"object"},"ChannelUnFrozenEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"channel.unfrozen","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"ChannelUnFrozenEvent","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"},"ChannelUnmutedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"channel.unmuted","type":"string","x-stream-index":"001.001"}},"required":["type","created_at"],"title":"ChannelUnmutedEvent","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"},"ChannelUpdatedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"004.004"},"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"004.005"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"002.001"},"type":{"default":"channel.updated","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"ChannelUpdatedEvent","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"},"ChannelVisibleEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"001.002"},"channel_type":{"type":"string","x-stream-index":"001.003"},"cid":{"type":"string","x-stream-index":"001.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"type":{"default":"channel.visible","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"ChannelVisibleEvent","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"},"ChatActivityStatsResponse":{"properties":{"Messages":{"$ref":"#/components/schemas/MessageStatsResponse","x-stream-index":"001"}},"type":"object"},"CheckExternalStorageResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"file_url":{"type":"string","x-stream-index":"002"}},"required":["duration","file_url"],"title":"Response","type":"object"},"CheckPushRequest":{"description":"Check push request","nullable":true,"properties":{"apn_template":{"description":"Push message template for APN","title":"APN template","type":"string","x-stream-docs-page-id":"push_template","x-stream-index":"002"},"event_type":{"description":"Type of event for push templates (default: message.new)","enum":["message.new","message.updated","reaction.new","reaction.updated","notification.reminder_due"],"title":"Event type","type":"string","x-stream-index":"008"},"firebase_data_template":{"description":"Push message data template for Firebase","title":"Firebase data template","type":"string","x-stream-docs-page-id":"push_template","x-stream-index":"004"},"firebase_template":{"description":"Push message template for Firebase","title":"Firebase template","type":"string","x-stream-docs-page-id":"push_template","x-stream-index":"003"},"message_id":{"description":"Message ID to send push notification for","title":"Message ID","type":"string","x-stream-index":"001"},"push_provider_name":{"description":"Name of push provider","title":"Name of push provider","type":"string","x-stream-index":"007"},"push_provider_type":{"description":"Push provider type","enum":["firebase","apn","huawei","xiaomi"],"title":"Type of push provider","type":"string","x-stream-index":"006"},"skip_devices":{"description":"Don't require existing devices to render templates","title":"Skip devices","type":"boolean","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"009.002"},"user_id":{"type":"string","x-stream-index":"009.001"}},"title":"CheckPushRequest","type":"object"},"CheckPushResponse":{"nullable":true,"properties":{"device_errors":{"additionalProperties":{"$ref":"#/components/schemas/DeviceErrorInfo"},"description":"Object with device errors","title":"Device errors","type":"object","x-stream-index":"001","x-stream-map":{"key":"device_id"}},"duration":{"type":"string","x-stream-index":"008.001"},"event_type":{"description":"The event type that was tested","title":"Event type","type":"string","x-stream-index":"004"},"general_errors":{"description":"List of general errors","items":{"type":"string"},"title":"General errors","type":"array","x-stream-index":"002"},"rendered_apn_template":{"title":"Rendered APN template","type":"string","x-stream-index":"005"},"rendered_firebase_template":{"title":"Rendered Firebase template","type":"string","x-stream-index":"006"},"rendered_message":{"additionalProperties":{"type":"string"},"title":"Rendered message","type":"object","x-stream-index":"007"},"skip_devices":{"description":"Don't require existing devices to render templates","title":"Skip devices","type":"boolean","x-stream-index":"003"}},"required":["duration"],"type":"object"},"CheckRequest":{"nullable":true,"properties":{"config_key":{"description":"Key of the moderation configuration to use","title":"Config Key","type":"string","x-stream-index":"005"},"config_team":{"description":"Team associated with the configuration","title":"Config Team","type":"string","x-stream-index":"006"},"entity_creator_id":{"description":"ID of the user who created the entity","title":"Entity Creator ID","type":"string","x-stream-index":"003"},"entity_id":{"description":"Unique identifier of the entity to moderate","title":"Entity ID","type":"string","x-stream-index":"002"},"entity_type":{"description":"Type of entity to moderate","title":"Entity Type","type":"string","x-stream-index":"001"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content to be moderated","title":"Moderation Payload","x-stream-index":"004"},"options":{"additionalProperties":{},"description":"Additional moderation configuration options","title":"Options","type":"object","x-stream-index":"007"},"test_mode":{"description":"Whether to run moderation in test mode","title":"Test Mode","type":"boolean","x-stream-index":"008"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"009.002"},"user_id":{"type":"string","x-stream-index":"009.001"}},"required":["entity_type","entity_id","entity_creator_id","config_key"],"type":"object"},"CheckResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"005.001"},"item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"Review queue item (present if action != keep)","title":"Item","x-stream-index":"004"},"recommended_action":{"description":"Suggested action based on moderation results","title":"Recommended Action","type":"string","x-stream-index":"003"},"status":{"description":"Status of the moderation check (completed or pending)","title":"Status","type":"string","x-stream-index":"001"},"task_id":{"description":"ID of the running moderation task","title":"Task ID","type":"string","x-stream-index":"002"}},"required":["status","recommended_action","duration"],"type":"object"},"CheckSNSRequest":{"nullable":true,"properties":{"sns_key":{"description":"AWS SNS access key","title":"SNS key","type":"string","x-stream-index":"002"},"sns_secret":{"description":"AWS SNS key secret","title":"SNS secret","type":"string","x-stream-index":"003"},"sns_topic_arn":{"description":"AWS SNS topic ARN","title":"SNS Topic ARN","type":"string","x-stream-index":"001"}},"type":"object"},"CheckSNSResponse":{"nullable":true,"properties":{"data":{"additionalProperties":{},"description":"Error data","title":"ReadOnlyData","type":"object","x-stream-index":"003"},"duration":{"type":"string","x-stream-index":"004.001"},"error":{"description":"Error text","title":"Error","type":"string","x-stream-index":"002"},"status":{"description":"Validation result","enum":["ok","error"],"title":"Status","type":"string","x-stream-index":"001"}},"required":["status","duration"],"type":"object"},"CheckSQSRequest":{"nullable":true,"properties":{"sqs_key":{"description":"AWS SQS access key","title":"SQS key","type":"string","x-stream-index":"002"},"sqs_secret":{"description":"AWS SQS key secret","title":"SQS secret","type":"string","x-stream-index":"003"},"sqs_url":{"description":"AWS SQS endpoint URL","title":"SQS URL","type":"string","x-stream-index":"001"}},"type":"object"},"CheckSQSResponse":{"nullable":true,"properties":{"data":{"additionalProperties":{},"description":"Error data","title":"ReadOnlyData","type":"object","x-stream-index":"003"},"duration":{"type":"string","x-stream-index":"004.001"},"error":{"description":"Error text","title":"Error","type":"string","x-stream-index":"002"},"status":{"description":"Validation result","enum":["ok","error"],"title":"Status","type":"string","x-stream-index":"001"}},"required":["status","duration"],"type":"object"},"ClientOSDataResponse":{"properties":{"architecture":{"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"version":{"type":"string","x-stream-index":"002"}},"type":"object"},"ClosedCaptionEvent":{"description":"This event is sent when closed captions are being sent in a call, clients should use this to show the closed captions in the call screen","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"closed_caption":{"$ref":"#/components/schemas/CallClosedCaption","description":"The closed caption object","title":"CallClosedCaption","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.closed_caption","description":"The type of event: \"call.closed_caption\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","closed_caption"],"title":"ClosedCaptionEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CollectUserFeedbackRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"009"},"rating":{"format":"int32","maximum":5,"minimum":1,"type":"integer","x-stream-index":"007"},"reason":{"maxLength":1000,"type":"string","x-stream-index":"008"},"sdk":{"maxLength":50,"type":"string","x-stream-index":"005"},"sdk_version":{"maxLength":50,"type":"string","x-stream-index":"006"},"user_session_id":{"maxLength":50,"type":"string","x-stream-index":"004"}},"required":["sdk","sdk_version","rating"],"type":"object"},"CollectUserFeedbackResponse":{"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"},"Command":{"description":"Represents custom chat command","nullable":true,"properties":{"args":{"description":"Arguments help text, shown in commands auto-completion","title":"Arguments","type":"string","x-stream-index":"006"},"created_at":{"description":"Date/time of creation","format":"date-time","readOnly":true,"title":"Created at","type":"number","x-stream-index":"001"},"description":{"description":"Description, shown in commands auto-completion","title":"Description","type":"string","x-stream-index":"005"},"name":{"description":"Unique command name","title":"Name","type":"string","x-stream-index":"004"},"set":{"description":"Set name used for grouping commands","title":"Set","type":"string","x-stream-index":"007"},"updated_at":{"description":"Date/time of the last update","format":"date-time","readOnly":true,"title":"Updated at","type":"number","x-stream-index":"002"}},"required":["name","description","args","set"],"title":"Command","type":"object"},"CommitMessageRequest":{"nullable":true,"type":"object"},"CompositeAppSettings":{"properties":{"json_encoded_settings":{"type":"string","x-stream-index":"005"},"url":{"type":"string","x-stream-index":"004"}},"type":"object"},"ConfigOverrides":{"properties":{"blocklist":{"type":"string","x-stream-index":"008"},"blocklist_behavior":{"enum":["flag","block"],"type":"string","x-stream-index":"009"},"commands":{"items":{"type":"string"},"type":"array","x-stream-index":"011"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"010"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"007"},"quotes":{"type":"boolean","x-stream-index":"004"},"reactions":{"type":"boolean","x-stream-index":"002"},"replies":{"type":"boolean","x-stream-index":"003"},"shared_locations":{"type":"boolean","x-stream-index":"013"},"typing_events":{"type":"boolean","x-stream-index":"001"},"uploads":{"type":"boolean","x-stream-index":"005"},"url_enrichment":{"type":"boolean","x-stream-index":"006"},"user_message_reminders":{"type":"boolean","x-stream-index":"012"}},"required":["grants","commands"],"type":"object"},"ConfigResponse":{"properties":{"ai_image_config":{"$ref":"#/components/schemas/AIImageConfig","description":"Configuration for AI image analysis","title":"AI Image Config","x-stream-index":"009"},"ai_text_config":{"$ref":"#/components/schemas/AITextConfig","description":"Configuration for AI text analysis","title":"AI Text Config","x-stream-index":"008"},"ai_video_config":{"$ref":"#/components/schemas/AIVideoConfig","description":"Configuration for AI video analysis","title":"AI Video Config","x-stream-index":"010"},"async":{"description":"Whether moderation should be performed asynchronously","title":"Async","type":"boolean","x-stream-index":"003"},"automod_platform_circumvention_config":{"$ref":"#/components/schemas/AutomodPlatformCircumventionConfig","description":"Configuration for platform circumvention detection","title":"Automod Platform Circumvention Config","x-stream-index":"005"},"automod_semantic_filters_config":{"$ref":"#/components/schemas/AutomodSemanticFiltersConfig","description":"Configuration for semantic filtering","title":"Automod Semantic Filters Config","x-stream-index":"006"},"automod_toxicity_config":{"$ref":"#/components/schemas/AutomodToxicityConfig","description":"Configuration for toxicity detection","title":"Automod Toxicity Config","x-stream-index":"004"},"block_list_config":{"$ref":"#/components/schemas/BlockListConfig","description":"Configuration for block list filtering","title":"Block List Config","x-stream-index":"007"},"created_at":{"description":"When the configuration was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"012"},"key":{"description":"Unique identifier for the moderation configuration","title":"Key","type":"string","x-stream-index":"001"},"rule_builder_config":{"$ref":"#/components/schemas/RuleBuilderConfig","x-stream-index":"015"},"team":{"description":"Team associated with the configuration","title":"Team","type":"string","x-stream-index":"002"},"updated_at":{"description":"When the configuration was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"013"},"velocity_filter_config":{"$ref":"#/components/schemas/VelocityFilterConfig","description":"Configuration for velocity-based filtering","title":"Velocity Filter Config","x-stream-index":"011"},"video_call_rule_config":{"$ref":"#/components/schemas/VideoCallRuleConfig","x-stream-index":"014"}},"required":["key","team","async","created_at","updated_at"],"type":"object"},"ContentCountRuleParameters":{"properties":{"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"required":["threshold","time_window"],"type":"object"},"CountByMinuteResponse":{"nullable":true,"properties":{"count":{"format":"int32","type":"integer","x-stream-index":"002"},"start_ts":{"format":"date-time","type":"number","x-stream-index":"001"}},"required":["start_ts","count"],"type":"object"},"CreateBlockListRequest":{"description":"Block list contains restricted words","nullable":true,"properties":{"name":{"description":"Block list name","maxLength":255,"title":"Name","type":"string","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"004"},"type":{"description":"Block list type.","enum":["regex","domain","domain_allowlist","email","word"],"title":"Type","type":"string","x-stream-index":"003"},"words":{"description":"List of words to block","items":{"type":"string"},"minimum":1,"title":"Words","type":"array","x-stream-index":"002"}},"required":["name","words"],"title":"Block list","type":"object","x-stream-docs-page-id":"block_lists"},"CreateBlockListResponse":{"description":"Basic response information","nullable":true,"properties":{"blocklist":{"$ref":"#/components/schemas/BlockListResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["duration"],"title":"Response","type":"object"},"CreateCallTypeRequest":{"description":"Request for creating a call type","nullable":true,"properties":{"external_storage":{"description":"the external storage for the call type","title":"ExternalStorage","type":"string","x-stream-index":"002.004"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"the permissions granted to each role","title":"Grants","type":"object","x-stream-index":"002.001"},"name":{"type":"string","x-stream-index":"001"},"notification_settings":{"$ref":"#/components/schemas/NotificationSettings","description":"the notification settings for the call type","title":"NotificationSettings","x-stream-index":"002.002"},"settings":{"$ref":"#/components/schemas/CallSettingsRequest","description":"the settings for the call type","title":"Settings","x-stream-index":"002.003"}},"required":["name"],"title":"CreateCallTypeRequest","type":"object"},"CreateCallTypeResponse":{"description":"Response for creating a call type","nullable":true,"properties":{"created_at":{"description":"the time the call type was created","format":"date-time","title":"CreatedAt","type":"number","x-stream-index":"001.005"},"duration":{"type":"string","x-stream-index":"002.001"},"external_storage":{"description":"the external storage for the call type","title":"ExternalStorage","type":"string","x-stream-index":"001.007"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"the permissions granted to each role","title":"Grants","type":"object","x-stream-index":"001.002"},"name":{"description":"the name of the call type","title":"Name","type":"string","x-stream-index":"001.001"},"notification_settings":{"$ref":"#/components/schemas/NotificationSettings","description":"the notification settings for the call type","title":"NotificationSettings","x-stream-index":"001.004"},"settings":{"$ref":"#/components/schemas/CallSettingsResponse","description":"the settings for the call type","title":"Settings","x-stream-index":"001.003"},"updated_at":{"description":"the time the call type was last updated","format":"date-time","title":"UpdatedAt","type":"number","x-stream-index":"001.006"}},"required":["name","grants","settings","notification_settings","created_at","updated_at","duration"],"title":"CreateCallTypeResponse","type":"object"},"CreateChannelTypeRequest":{"nullable":true,"properties":{"automod":{"description":"Automod","enum":["disabled","simple","AI"],"title":"Automod","type":"string","x-stream-index":"019"},"automod_behavior":{"description":"Automod behavior","enum":["flag","block"],"title":"Automod behavior","type":"string","x-stream-index":"020"},"blocklist":{"description":"Blocklist","title":"Blocklist","type":"string","x-stream-index":"024"},"blocklist_behavior":{"description":"Blocklist behavior","enum":["flag","block","shadow_block"],"title":"Blocklist behavior","type":"string","x-stream-index":"025"},"blocklists":{"description":"Blocklists","items":{"$ref":"#/components/schemas/BlockListOptions"},"title":"Blocklists","type":"array","x-stream-index":"026"},"commands":{"description":"List of commands that channel supports","items":{"type":"string"},"title":"Commands","type":"array","x-stream-index":"021"},"connect_events":{"description":"Connect events","title":"Connect events","type":"boolean","x-stream-index":"004"},"custom_events":{"description":"Custom events","title":"Custom events","type":"boolean","x-stream-index":"011"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"List of grants for the channel type","title":"Grants","type":"object","x-stream-index":"023"},"mark_messages_pending":{"description":"Mark messages pending","title":"Mark messages pending","type":"boolean","x-stream-index":"013"},"max_message_length":{"description":"Max message length","format":"int32","title":"Max message length","type":"integer","x-stream-index":"018"},"message_retention":{"description":"Message retention","enum":["infinite","numeric"],"title":"Message retention","type":"string","x-stream-index":"017"},"mutes":{"description":"Mutes","title":"Mutes","type":"boolean","x-stream-index":"008"},"name":{"description":"Channel type name","title":"Name","type":"string","x-stream-index":"001"},"partition_size":{"description":"Partition size","format":"int32","minimum":10,"title":"Partition size","type":"integer","x-stream-index":"027"},"partition_ttl":{"description":"Partition TTL","example":"24h","format":"duration","nullable":true,"title":"Partition TTL","type":"string","x-stream-index":"028"},"permissions":{"description":"List of permissions for the channel type","items":{"$ref":"#/components/schemas/PolicyRequest"},"title":"Permissions","type":"array","x-stream-index":"022"},"polls":{"description":"Polls","title":"Polls","type":"boolean","x-stream-index":"014"},"push_notifications":{"description":"Push notifications","title":"Push notifications","type":"boolean","x-stream-index":"012"},"reactions":{"description":"Reactions","title":"Reactions","type":"boolean","x-stream-index":"005"},"read_events":{"description":"Read events","title":"Read events","type":"boolean","x-stream-index":"003"},"replies":{"description":"Replies","title":"Replies","type":"boolean","x-stream-index":"006"},"search":{"description":"Search","title":"Search","type":"boolean","x-stream-index":"007"},"shared_locations":{"description":"Enables shared location messages","title":"Shared locations","type":"boolean","x-stream-index":"016"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"029"},"typing_events":{"description":"Typing events","title":"Typing events","type":"boolean","x-stream-index":"002"},"uploads":{"description":"Uploads","title":"Uploads","type":"boolean","x-stream-index":"009"},"url_enrichment":{"description":"URL enrichment","title":"URL enrichment","type":"boolean","x-stream-index":"010"},"user_message_reminders":{"type":"boolean","x-stream-index":"015"}},"required":["name","max_message_length","automod","automod_behavior"],"title":"CreateChannelTypeRequest","type":"object"},"CreateChannelTypeResponse":{"nullable":true,"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.001.026"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.001.021"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.001.022"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.001.027"},"blocklist":{"type":"string","x-stream-index":"001.001.023"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.001.024"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.001.025"},"commands":{"items":{"type":"string"},"type":"array","x-stream-index":"001.003"},"connect_events":{"type":"boolean","x-stream-index":"001.001.004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002.003"},"custom_events":{"type":"boolean","x-stream-index":"001.001.012"},"duration":{"type":"string","x-stream-index":"004.001"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"003"},"mark_messages_pending":{"type":"boolean","x-stream-index":"001.001.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"001.001.020"},"mutes":{"type":"boolean","x-stream-index":"001.001.009"},"name":{"type":"string","x-stream-index":"001.001.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"001.001.028"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"001.001.029"},"permissions":{"items":{"$ref":"#/components/schemas/PolicyRequest"},"type":"array","x-stream-index":"002"},"polls":{"type":"boolean","x-stream-index":"001.001.016"},"push_notifications":{"type":"boolean","x-stream-index":"001.001.013"},"quotes":{"type":"boolean","x-stream-index":"001.001.008"},"reactions":{"type":"boolean","x-stream-index":"001.001.006"},"read_events":{"type":"boolean","x-stream-index":"001.001.003"},"reminders":{"type":"boolean","x-stream-index":"001.001.014"},"replies":{"type":"boolean","x-stream-index":"001.001.007"},"search":{"type":"boolean","x-stream-index":"001.001.005"},"shared_locations":{"type":"boolean","x-stream-index":"001.001.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.001.030"},"typing_events":{"type":"boolean","x-stream-index":"001.001.002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.002.004"},"uploads":{"type":"boolean","x-stream-index":"001.001.010"},"url_enrichment":{"type":"boolean","x-stream-index":"001.001.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"001.001.017"}},"required":["name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","created_at","updated_at","commands","permissions","grants","duration"],"type":"object"},"CreateCommandRequest":{"description":"Create a new command","nullable":true,"properties":{"args":{"description":"Arguments help text, shown in commands auto-completion","maxLength":255,"title":"Arguments","type":"string","x-stream-index":"003"},"description":{"description":"Description, shown in commands auto-completion","maxLength":255,"title":"Description","type":"string","x-stream-index":"002"},"name":{"description":"Unique command name","maxLength":255,"minLength":1,"title":"Name","type":"string","x-stream-index":"001"},"set":{"description":"Set name used for grouping commands","maxLength":255,"title":"Set","type":"string","x-stream-index":"004"}},"required":["name","description"],"title":"CreateCommandRequest","type":"object"},"CreateCommandResponse":{"nullable":true,"properties":{"command":{"$ref":"#/components/schemas/Command","description":"Command object","title":"Command","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["duration"],"title":"CreateCommandResponse","type":"object"},"CreateDeviceRequest":{"description":"Create device request","nullable":true,"properties":{"id":{"description":"Device ID","maxLength":255,"minLength":1,"title":"ID","type":"string","x-stream-index":"001"},"push_provider":{"description":"Push provider","enum":["firebase","apn","huawei","xiaomi"],"title":"PushProvider","type":"string","x-stream-index":"002"},"push_provider_name":{"description":"Push provider name","title":"PushProviderName","type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"005.002"},"user_id":{"description":"**Server-side only**. User ID which server acts upon","title":"User ID","type":"string","x-stream-index":"005.001"},"voip_token":{"description":"When true the token is for Apple VoIP push notifications","title":"VoipToken","type":"boolean","x-stream-index":"004"}},"required":["id","push_provider"],"title":"CreateDeviceRequest","type":"object"},"CreateExternalStorageRequest":{"description":"Create external storage","nullable":true,"properties":{"aws_s3":{"$ref":"#/components/schemas/S3Request","description":"Only required if you want to create an Amazon S3 storage","title":"AwsS3","x-stream-index":"003.004"},"azure_blob":{"$ref":"#/components/schemas/AzureRequest","description":"Only required if you want to create an Azure Blob Storage","title":"AzureBlob","x-stream-index":"003.006"},"bucket":{"description":"The name of the bucket on the service provider","title":"Bucket","type":"string","x-stream-index":"003.002"},"gcs_credentials":{"type":"string","x-stream-index":"003.005"},"name":{"description":"The name of the provider, this must be unique","title":"Name","type":"string","x-stream-index":"001"},"path":{"description":"The path prefix to use for storing files","title":"Path","type":"string","x-stream-index":"003.003"},"storage_type":{"description":"The type of storage to use","enum":["s3","gcs","abs"],"title":"StorageType","type":"string","x-stream-index":"003.001"}},"required":["name","storage_type","bucket"],"title":"CreateExternalStorageRequest","type":"object"},"CreateExternalStorageResponse":{"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"},"CreateGuestRequest":{"nullable":true,"properties":{"user":{"$ref":"#/components/schemas/UserRequest","description":"User object which server acts upon","title":"User","x-stream-index":"001"}},"required":["user"],"type":"object"},"CreateGuestResponse":{"nullable":true,"properties":{"access_token":{"description":"the access token to authenticate the user","title":"Access token","type":"string","x-stream-index":"002"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User object which server acts upon","title":"User","x-stream-index":"001"}},"required":["user","access_token","duration"],"type":"object"},"CreateImportRequest":{"nullable":true,"properties":{"mode":{"enum":["insert","upsert"],"type":"string","x-stream-index":"002"},"path":{"type":"string","x-stream-index":"001"}},"required":["path","mode"],"type":"object"},"CreateImportResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"import_task":{"$ref":"#/components/schemas/ImportTask","x-stream-index":"001"}},"required":["duration"],"title":"Response","type":"object"},"CreateImportURLRequest":{"nullable":true,"properties":{"filename":{"type":"string","x-stream-index":"001"}},"type":"object"},"CreateImportURLResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"path":{"type":"string","x-stream-index":"001"},"upload_url":{"type":"string","x-stream-index":"002"}},"required":["path","upload_url","duration"],"title":"Response","type":"object"},"CreatePollOptionRequest":{"nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"003"},"text":{"description":"Option text","title":"string","type":"string","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"required":["text"],"type":"object"},"CreatePollRequest":{"description":"Contains all information needed to create a new poll","nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"011"},"allow_answers":{"description":"Indicates whether users can suggest user defined answers","title":"Allow answers","type":"boolean","x-stream-index":"009"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"008"},"description":{"description":"A description of the poll","title":"Description","type":"string","x-stream-index":"003"},"enforce_unique_vote":{"description":"Indicates whether users can cast multiple votes","title":"Multiple choice","type":"boolean","x-stream-index":"006"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"is_closed":{"description":"Indicates whether the poll is open for voting","title":"Is closed","type":"boolean","x-stream-index":"010"},"max_votes_allowed":{"description":"Indicates the maximum amount of votes a user can cast","format":"int32","maximum":10,"title":"Maximum votes allowed","type":"integer","x-stream-index":"007"},"name":{"description":"The name of the poll","title":"Name","type":"string","x-stream-index":"002"},"options":{"items":{"$ref":"#/components/schemas/PollOptionInput"},"maximum":100,"type":"array","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"012.002"},"user_id":{"type":"string","x-stream-index":"012.001"},"voting_visibility":{"enum":["anonymous","public"],"type":"string","x-stream-index":"005"}},"required":["name"],"title":"Create Poll Request","type":"object"},"CreateReminderRequest":{"nullable":true,"properties":{"remind_at":{"format":"date-time","type":"number","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"type":"object"},"CreateRoleRequest":{"nullable":true,"properties":{"name":{"description":"Role name","maxLength":64,"title":"Name","type":"string","x-stream-index":"001"}},"required":["name"],"type":"object"},"CreateRoleResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"role":{"$ref":"#/components/schemas/Role","x-stream-index":"002"}},"required":["duration","role"],"title":"Response","type":"object"},"CustomActionRequest":{"properties":{"id":{"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"type":"object"},"CustomCheckFlag":{"properties":{"custom":{"additionalProperties":{},"description":"Additional metadata for the flag","title":"Custom","type":"object","x-stream-index":"003"},"labels":{"description":"Labels from various moderation sources","items":{"type":"string"},"title":"Labels","type":"array","x-stream-index":"004"},"reason":{"description":"Optional explanation for the flag","title":"Reason","type":"string","x-stream-index":"002"},"type":{"description":"Type of check (custom_check_text, custom_check_image, custom_check_video)","maxLength":255,"title":"Type","type":"string","x-stream-index":"001"}},"required":["type"],"type":"object"},"CustomCheckRequest":{"nullable":true,"properties":{"entity_creator_id":{"description":"ID of the user who created the entity (required for non-message entities)","title":"Entity Creator ID","type":"string","x-stream-index":"003"},"entity_id":{"description":"Unique identifier of the entity","title":"Entity ID","type":"string","x-stream-index":"002"},"entity_type":{"description":"Type of entity to perform custom check on","title":"Entity Type","type":"string","x-stream-index":"001"},"flags":{"description":"List of custom check flags (1-10 flags required)","items":{"$ref":"#/components/schemas/CustomCheckFlag"},"maximum":10,"minimum":1,"title":"Flags","type":"array","x-stream-index":"005"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content to be checked (required for non-message entities)","title":"Moderation Payload","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"006.002"},"user_id":{"type":"string","x-stream-index":"006.001"}},"required":["entity_type","entity_id","flags"],"type":"object"},"CustomCheckResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"004.001"},"id":{"description":"Unique identifier of the custom check","title":"ID","type":"string","x-stream-index":"001"},"item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"Review queue item details","title":"Item","x-stream-index":"002"},"status":{"description":"Status of the custom check","title":"Status","type":"string","x-stream-index":"003"}},"required":["id","status","duration"],"type":"object"},"CustomVideoEvent":{"description":"A custom event, this event is used to send custom events to other participants in the call.","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"003"},"type":{"default":"custom","description":"The type of event, \"custom\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"004"}},"required":["type","created_at","call_cid","custom","user"],"title":"CustomVideoEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"DailyAggregateCallDurationReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/CallDurationReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateCallParticipantCountReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/CallParticipantCountReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateCallsPerDayReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/CallsPerDayReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateQualityScoreReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/QualityScoreReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateSDKUsageReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/SDKUsageReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateUserFeedbackReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/UserFeedbackReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"Data":{"properties":{"id":{"type":"string","x-stream-index":"001"}},"required":["id"],"type":"object"},"DataDogInfo":{"properties":{"api_key":{"type":"string","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"003"},"site":{"type":"string","x-stream-index":"002"}},"type":"object"},"DeactivateUserRequest":{"nullable":true,"properties":{"created_by_id":{"description":"ID of the user who deactivated the user","title":"Created by ID","type":"string","x-stream-index":"003"},"mark_messages_deleted":{"description":"Makes messages appear to be deleted","title":"Mark messages deleted","type":"boolean","x-stream-index":"002"}},"type":"object"},"DeactivateUserResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Deactivated user object","title":"User","x-stream-index":"001"}},"required":["duration"],"type":"object"},"DeactivateUsersRequest":{"description":"Deactivate users request","nullable":true,"properties":{"created_by_id":{"description":"ID of the user who deactivated the users","title":"Created by ID","type":"string","x-stream-index":"003"},"mark_channels_deleted":{"type":"boolean","x-stream-index":"004"},"mark_messages_deleted":{"description":"Makes messages appear to be deleted","title":"Mark messages deleted","type":"boolean","x-stream-index":"002"},"user_ids":{"description":"User IDs to deactivate","items":{"type":"string"},"maximum":100,"minimum":1,"title":"User IDs","type":"array","x-stream-index":"001"}},"required":["user_ids"],"title":"DeactivateUsersRequest","type":"object"},"DeactivateUsersResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"task_id":{"type":"string","x-stream-index":"001"}},"required":["task_id","duration"],"title":"Response","type":"object"},"DeleteActivityRequest":{"properties":{"hard_delete":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"DeleteCallRequest":{"description":"DeleteCallRequest is the payload for deleting a call.","nullable":true,"properties":{"hard":{"description":"if true the call will be hard deleted along with all related data","title":"Hard","type":"boolean","x-stream-index":"001"}},"title":"DeleteCallRequest","type":"object"},"DeleteCallResponse":{"description":"DeleteCallResponse is the payload for deleting a call.","nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","title":"Call","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"task_id":{"title":"TaskID","type":"string","x-stream-index":"002"}},"required":["call","duration"],"title":"DeleteCallResponse","type":"object"},"DeleteChannelResponse":{"description":"Basic response information","nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"Response","type":"object"},"DeleteChannelsRequest":{"nullable":true,"properties":{"cids":{"description":"All channels that should be deleted","items":{"type":"string"},"maximum":100,"minimum":1,"title":"Channels CID","type":"array","x-stream-index":"001"},"hard_delete":{"description":"Specify if channels and all ressources should be hard deleted","title":"Hard delete","type":"boolean","x-stream-index":"002"}},"required":["cids"],"type":"object"},"DeleteChannelsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"result":{"additionalProperties":{"$ref":"#/components/schemas/DeleteChannelsResultResponse"},"description":"Map of channel IDs and their deletion results","title":"Result","type":"object","x-stream-index":"001"},"task_id":{"type":"string","x-stream-index":"002"}},"required":["duration"],"type":"object"},"DeleteChannelsResultResponse":{"nullable":true,"properties":{"error":{"type":"string","x-stream-index":"002"},"status":{"type":"string","x-stream-index":"001"}},"required":["status"],"type":"object"},"DeleteCommandResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"name":{"description":"Command name","title":"Name","type":"string","x-stream-index":"001"}},"required":["name","duration"],"title":"DeleteCommandResponse","type":"object"},"DeleteExternalStorageResponse":{"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"},"DeleteMessageRequest":{"properties":{"hard_delete":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"DeleteMessageResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001"}},"required":["message","duration"],"title":"Response","type":"object"},"DeleteModerationConfigResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"DeleteModerationTemplateResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"DeleteReactionRequest":{"properties":{"hard_delete":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"DeleteReactionResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001"},"reaction":{"$ref":"#/components/schemas/ReactionResponse","x-stream-index":"002"}},"required":["message","reaction","duration"],"title":"Response","type":"object"},"DeleteRecordingResponse":{"description":"Response for DeleteRecording","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"DeleteRecordingResponse","type":"object"},"DeleteReminderResponse":{"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"},"DeleteSegmentTargetsRequest":{"nullable":true,"properties":{"target_ids":{"description":"Target IDs","items":{"type":"string"},"maximum":100,"minimum":1,"title":"[]string","type":"array","x-stream-index":"002"}},"required":["target_ids"],"type":"object"},"DeleteTranscriptionResponse":{"description":"DeleteTranscriptionResponse is the payload for deleting a transcription.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"DeleteTranscriptionResponse","type":"object"},"DeleteUserRequest":{"properties":{"delete_conversation_channels":{"type":"boolean","x-stream-index":"003"},"delete_feeds_content":{"type":"boolean","x-stream-index":"004"},"hard_delete":{"type":"boolean","x-stream-index":"001"},"mark_messages_deleted":{"type":"boolean","x-stream-index":"002"}},"type":"object"},"DeleteUsersRequest":{"nullable":true,"properties":{"calls":{"description":"Calls delete mode.\nAffected calls are those that include exactly two members, one of whom is the user being deleted.\n\n* null or empty string - doesn't delete any calls\n* soft - marks user's calls and their related data as deleted (soft-delete)\n* hard - deletes user's calls and their data completely (hard-delete)\n","enum":["soft","hard"],"title":"Delete User's calls","type":"string","x-stream-index":"001.002.004"},"conversations":{"description":"Conversation channels delete mode.\nConversation channel is any channel which only has two members one of which is the user being deleted.\n\n* null or empty string - doesn't delete any conversation channels\n* soft - marks all conversation channels as deleted (same effect as Delete Channels with 'hard' option disabled)\n* hard - deletes channel and all its data completely including messages (same effect as Delete Channels with 'hard' option enabled)\n","enum":["soft","hard"],"title":"Delete Conversations","type":"string","x-stream-index":"001.002.003"},"files":{"description":"Delete user files.\n* false or empty string - doesn't delete any files\n* true - deletes all files uploaded by the user, including images and attachments.\n","title":"Delete User's files","type":"boolean","x-stream-index":"001.002.005"},"messages":{"description":"Message delete mode.\n\n* null or empty string - doesn't delete user messages\n* soft - marks all user messages as deleted without removing any related message data\n* pruning - marks all user messages as deleted, nullifies message information and removes some message data such as reactions and flags\n* hard - deletes messages completely with all related information\n","enum":["soft","pruning","hard"],"title":"Delete Messages","type":"string","x-stream-index":"001.002.002"},"new_call_owner_id":{"type":"string","x-stream-index":"001.002.007"},"new_channel_owner_id":{"type":"string","x-stream-index":"001.002.006"},"user":{"description":"User delete mode.\n\n* soft - marks user as deleted and retains all user data\n* pruning - marks user as deleted and nullifies user information\n* hard - deletes user completely. Requires 'hard' option for messages and conversations as well\n","enum":["soft","pruning","hard"],"title":"Delete User","type":"string","x-stream-index":"001.002.001"},"user_ids":{"description":"IDs of users to delete","items":{"type":"string"},"maximum":100,"minimum":1,"title":"User IDs","type":"array","x-stream-index":"001.001"}},"required":["user_ids"],"type":"object"},"DeleteUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"task_id":{"description":"ID of the task to delete users","title":"Task ID","type":"string","x-stream-index":"001"}},"required":["task_id","duration"],"type":"object"},"Device":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"disabled":{"type":"boolean","x-stream-index":"002.003"},"disabled_reason":{"type":"string","x-stream-index":"002.004"},"id":{"type":"string","x-stream-index":"002.001.004"},"push_provider":{"enum":["firebase","apn","huawei","xiaomi"],"type":"string","x-stream-index":"002.001.001"},"push_provider_name":{"type":"string","x-stream-index":"002.001.003"},"user_id":{"type":"string","x-stream-index":"004"},"voip":{"type":"boolean","x-stream-index":"002.001.005"}},"required":["push_provider","id","created_at","user_id"],"type":"object"},"DeviceDataResponse":{"properties":{"name":{"type":"string","x-stream-index":"001"},"version":{"type":"string","x-stream-index":"002"}},"type":"object"},"DeviceErrorInfo":{"properties":{"error_message":{"type":"string","x-stream-index":"003"},"provider":{"type":"string","x-stream-index":"001"},"provider_name":{"type":"string","x-stream-index":"002"}},"required":["provider","provider_name","error_message"],"type":"object"},"DeviceResponse":{"description":"Response for Device","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"004"},"disabled":{"description":"Whether device is disabled or not","title":"Disabled","type":"boolean","x-stream-index":"005"},"disabled_reason":{"description":"Reason explaining why device had been disabled","title":"Reason","type":"string","x-stream-index":"006"},"id":{"description":"Device ID","title":"ID","type":"string","x-stream-index":"003"},"push_provider":{"description":"Push provider","title":"PushProvider","type":"string","x-stream-index":"001"},"push_provider_name":{"description":"Push provider name","title":"PushProviderName","type":"string","x-stream-index":"002"},"user_id":{"description":"User ID","title":"UserID","type":"string","x-stream-index":"008"},"voip":{"description":"When true the token is for Apple VoIP push notifications","title":"Voip","type":"boolean","x-stream-index":"007"}},"required":["push_provider","id","created_at","user_id"],"title":"DeviceResponse","type":"object"},"DraftPayloadResponse":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"html":{"type":"string","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"001"},"mentioned_users":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"008"},"mml":{"type":"string","x-stream-index":"003"},"parent_id":{"type":"string","x-stream-index":"005"},"poll_id":{"type":"string","x-stream-index":"013"},"quoted_message_id":{"type":"string","x-stream-index":"009"},"show_in_channel":{"type":"boolean","x-stream-index":"006"},"silent":{"type":"boolean","x-stream-index":"012"},"text":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"011"}},"required":["id","text","custom"],"type":"object"},"DraftResponse":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003"},"channel_cid":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"message":{"$ref":"#/components/schemas/DraftPayloadResponse","x-stream-index":"001"},"parent_id":{"type":"string","x-stream-index":"004"},"parent_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"005"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"006"}},"required":["message","channel_cid","created_at"],"type":"object"},"EdgeResponse":{"properties":{"continent_code":{"type":"string","x-stream-index":"007.003"},"country_iso_code":{"type":"string","x-stream-index":"007.002"},"green":{"format":"int32","type":"integer","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"latency_test_url":{"type":"string","x-stream-index":"002"},"latitude":{"format":"float","type":"number","x-stream-index":"006.001"},"longitude":{"format":"float","type":"number","x-stream-index":"006.002"},"red":{"format":"int32","type":"integer","x-stream-index":"005"},"subdivision_iso_code":{"type":"string","x-stream-index":"007.001"},"yellow":{"format":"int32","type":"integer","x-stream-index":"004"}},"required":["id","latency_test_url","green","yellow","red","latitude","longitude","subdivision_iso_code","country_iso_code","continent_code"],"type":"object"},"EgressHLSResponse":{"properties":{"playlist_url":{"type":"string","x-stream-index":"001"},"status":{"type":"string","x-stream-index":"002"}},"required":["playlist_url","status"],"type":"object"},"EgressRTMPResponse":{"properties":{"name":{"type":"string","x-stream-index":"001"},"started_at":{"format":"date-time","type":"number","x-stream-index":"004"},"stream_key":{"type":"string","x-stream-index":"003"},"stream_url":{"type":"string","x-stream-index":"002"}},"required":["name","started_at"],"type":"object"},"EgressResponse":{"properties":{"broadcasting":{"type":"boolean","x-stream-index":"001"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordingResponse","x-stream-index":"004"},"hls":{"$ref":"#/components/schemas/EgressHLSResponse","x-stream-index":"002"},"rtmps":{"items":{"$ref":"#/components/schemas/EgressRTMPResponse"},"type":"array","x-stream-index":"003"}},"required":["broadcasting","rtmps"],"type":"object"},"EgressTaskConfig":{"properties":{"egress_user":{"$ref":"#/components/schemas/EgressUser","x-stream-index":"008"},"frame_recording_egress_config":{"$ref":"#/components/schemas/FrameRecordingEgressConfig","x-stream-index":"009"},"hls_egress_config":{"$ref":"#/components/schemas/HLSEgressConfig","x-stream-index":"007"},"recording_egress_config":{"$ref":"#/components/schemas/RecordingEgressConfig","x-stream-index":"006"},"rtmp_egress_config":{"$ref":"#/components/schemas/RTMPEgressConfig","x-stream-index":"004"},"stt_egress_config":{"$ref":"#/components/schemas/STTEgressConfig","x-stream-index":"005"}},"type":"object"},"EgressUser":{"properties":{"token":{"type":"string","x-stream-index":"004"}},"type":"object"},"EndCallRequest":{"description":"Request for ending a call","nullable":true,"title":"EndCallRequest","type":"object"},"EndCallResponse":{"description":"Response for ending a call","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"EndCallResponse","type":"object"},"EnrichedActivity":{"properties":{"actor":{"$ref":"#/components/schemas/Data","x-stream-index":"002"},"foreign_id":{"type":"string","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"latest_reactions":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"013"},"object":{"$ref":"#/components/schemas/Data","x-stream-index":"004"},"origin":{"$ref":"#/components/schemas/Data","x-stream-index":"008"},"own_reactions":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"012"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"011"},"score":{"format":"float","type":"number","x-stream-index":"010"},"target":{"$ref":"#/components/schemas/Data","x-stream-index":"006"},"to":{"items":{"type":"string"},"type":"array","x-stream-index":"009"},"verb":{"type":"string","x-stream-index":"003"}},"type":"object"},"EnrichedReaction":{"nullable":true,"properties":{"activity_id":{"type":"string","x-stream-index":"003"},"children_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"010"},"created_at":{"$ref":"#/components/schemas/Time","x-stream-index":"012"},"data":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"kind":{"type":"string","x-stream-index":"002"},"latest_children":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"008"},"own_children":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"009"},"parent":{"type":"string","x-stream-index":"007"},"target_feeds":{"items":{"type":"string"},"type":"array","x-stream-index":"006"},"updated_at":{"$ref":"#/components/schemas/Time","x-stream-index":"013"},"user":{"$ref":"#/components/schemas/Data","x-stream-index":"011"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["kind","activity_id","user_id"],"type":"object"},"EntityCreator":{"properties":{"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"001.046"},"ban_count":{"format":"int32","type":"integer","x-stream-index":"002"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"001.017"},"banned":{"type":"boolean","x-stream-index":"001.016"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.013"},"deleted_content_count":{"format":"int32","type":"integer","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"001.023"},"language":{"type":"string","x-stream-index":"001.035"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"001.022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"001.026"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.042"},"role":{"type":"string","x-stream-index":"001.004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.005"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.009"}},"required":["id","role","teams_role","custom","banned","online","ban_count","deleted_content_count"],"type":"object"},"EntityCreatorResponse":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.001.018"},"ban_count":{"description":"Number of minor actions performed on the user","format":"int32","title":"Ban Count","type":"integer","x-stream-index":"002"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"001.003"},"banned":{"type":"boolean","x-stream-index":"001.001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.001.017"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.001.016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.001.011"},"deleted_content_count":{"description":"Number of major actions performed on the user","format":"int32","title":"Deleted Content Count","type":"integer","x-stream-index":"003"},"devices":{"items":{"$ref":"#/components/schemas/DeviceResponse"},"type":"array","x-stream-index":"001.006"},"flagged_count":{"description":"Number of flag actions performed on the user","format":"int32","title":"Flagged Count","type":"integer","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001.001.001"},"image":{"type":"string","x-stream-index":"001.001.003"},"invisible":{"type":"boolean","x-stream-index":"001.007"},"language":{"type":"string","x-stream-index":"001.001.005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"001.001.014"},"name":{"type":"string","x-stream-index":"001.001.002"},"online":{"type":"boolean","x-stream-index":"001.001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"001.005"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettingsResponse","x-stream-index":"001.004"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.001.015"},"role":{"type":"string","x-stream-index":"001.001.006"},"shadow_banned":{"type":"boolean","x-stream-index":"001.002"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.001.008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids","shadow_banned","invisible","ban_count","deleted_content_count","flagged_count"],"type":"object"},"ErrorResult":{"properties":{"stacktrace":{"type":"string","x-stream-index":"003"},"type":{"type":"string","x-stream-index":"001"},"version":{"type":"string","x-stream-index":"004"}},"required":["type","description"],"type":"object"},"EventHook":{"nullable":true,"properties":{"callback":{"$ref":"#/components/schemas/AsyncModerationCallbackConfig","x-stream-index":"018.001.002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"019"},"enabled":{"type":"boolean","x-stream-index":"003"},"event_types":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"hook_type":{"type":"string","x-stream-index":"002"},"id":{"type":"string","x-stream-index":"001"},"sns_auth_type":{"type":"string","x-stream-index":"014"},"sns_key":{"type":"string","x-stream-index":"015"},"sns_region":{"type":"string","x-stream-index":"013"},"sns_role_arn":{"type":"string","x-stream-index":"017"},"sns_secret":{"type":"string","x-stream-index":"016"},"sns_topic_arn":{"type":"string","x-stream-index":"012"},"sqs_auth_type":{"type":"string","x-stream-index":"008"},"sqs_key":{"type":"string","x-stream-index":"009"},"sqs_queue_url":{"type":"string","x-stream-index":"006"},"sqs_region":{"type":"string","x-stream-index":"007"},"sqs_role_arn":{"type":"string","x-stream-index":"011"},"sqs_secret":{"type":"string","x-stream-index":"010"},"timeout_ms":{"format":"int32","type":"integer","x-stream-index":"018.001.001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"020"},"webhook_url":{"type":"string","x-stream-index":"005"}},"type":"object"},"EventNotificationSettings":{"properties":{"apns":{"$ref":"#/components/schemas/APNS","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"fcm":{"$ref":"#/components/schemas/FCM","x-stream-index":"003"}},"required":["enabled","apns","fcm"],"type":"object"},"EventRequest":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"parent_id":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"required":["type"],"type":"object"},"EventResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"event":{"$ref":"#/components/schemas/WSEvent","x-stream-index":"001"}},"required":["event","duration"],"title":"Response","type":"object"},"ExportChannelsRequest":{"nullable":true,"properties":{"channels":{"description":"Export options for channels","items":{"$ref":"#/components/schemas/ChannelExport"},"maximum":100,"minimum":1,"title":"Channels","type":"array","x-stream-index":"002.001"},"clear_deleted_message_text":{"description":"Set if deleted message text should be cleared","title":"Clear deleted message text","type":"boolean","x-stream-index":"002.002"},"export_users":{"type":"boolean","x-stream-index":"002.005"},"include_soft_deleted_channels":{"description":"Set if you want to include deleted channels","title":"Include soft deleted channels","type":"boolean","x-stream-index":"002.004"},"include_truncated_messages":{"description":"Set if you want to include truncated messages","title":"Include truncated messages","type":"boolean","x-stream-index":"002.003"},"version":{"description":"Export version","title":"Version","type":"string","x-stream-index":"001"}},"required":["channels"],"type":"object"},"ExportChannelsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"task_id":{"description":"ID of the task to export channels","title":"Task ID","type":"string","x-stream-index":"001"}},"required":["task_id","duration"],"type":"object"},"ExportUserResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"004.001"},"messages":{"description":"List of exported messages","items":{"$ref":"#/components/schemas/MessageResponse"},"title":"Messages","type":"array","x-stream-index":"002"},"reactions":{"description":"List of exported reactions","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Reactions","type":"array","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Exported user object","title":"User","x-stream-index":"001"}},"required":["duration"],"type":"object"},"ExportUsersRequest":{"nullable":true,"properties":{"user_ids":{"items":{"type":"string"},"maximum":25,"minimum":1,"type":"array","x-stream-index":"001"}},"required":["user_ids"],"type":"object"},"ExportUsersResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"task_id":{"type":"string","x-stream-index":"001"}},"required":["task_id","duration"],"title":"Response","type":"object"},"ExternalStorage":{"properties":{"abs_account_name":{"type":"string","x-stream-index":"011"},"abs_client_id":{"type":"string","x-stream-index":"013"},"abs_client_secret":{"type":"string","x-stream-index":"014"},"abs_tenant_id":{"type":"string","x-stream-index":"012"},"bucket":{"type":"string","x-stream-index":"005"},"gcs_credentials":{"type":"string","x-stream-index":"010"},"path":{"type":"string","x-stream-index":"006"},"s3_api_key":{"type":"string","x-stream-index":"007"},"s3_custom_endpoint":{"type":"string","x-stream-index":"016"},"s3_region":{"type":"string","x-stream-index":"009"},"s3_secret_key":{"type":"string","x-stream-index":"008"},"storage_name":{"type":"string","x-stream-index":"015"},"storage_type":{"type":"integer","x-stream-index":"004"}},"type":"object"},"ExternalStorageResponse":{"properties":{"bucket":{"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"path":{"type":"string","x-stream-index":"004"},"type":{"enum":["s3","gcs","abs"],"type":"string","x-stream-index":"002"}},"required":["name","type","bucket","path"],"type":"object"},"FCM":{"properties":{"data":{"additionalProperties":{},"type":"object","x-stream-index":"001"}},"type":"object"},"FeedsModerationTemplateConfig":{"properties":{"config_key":{"type":"string","x-stream-index":"002"},"data_types":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001"}},"required":["data_types","config_key"],"type":"object"},"Field":{"nullable":true,"properties":{"short":{"type":"boolean","x-stream-index":"003"},"title":{"type":"string","x-stream-index":"001"},"value":{"type":"string","x-stream-index":"002"}},"required":["title","value","short"],"type":"object"},"FileUploadConfig":{"properties":{"allowed_file_extensions":{"items":{"type":"string"},"type":"array","x-stream-index":"001"},"allowed_mime_types":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"blocked_file_extensions":{"items":{"type":"string"},"type":"array","x-stream-index":"002"},"blocked_mime_types":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"size_limit":{"format":"int32","maximum":104857600,"minimum":0,"type":"integer","x-stream-index":"005"}},"required":["size_limit"],"type":"object"},"FileUploadRequest":{"nullable":true,"properties":{"file":{"description":"file field","title":"File","type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/OnlyUserID","description":"user for the request **server side only**","title":"User","x-stream-index":"002"}},"type":"object"},"FileUploadResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"file":{"description":"URL to the uploaded asset. Should be used to put to `asset_url` attachment field","title":"File","type":"string","x-stream-index":"001"},"thumb_url":{"description":"URL of the file thumbnail for supported file formats. Should be put to `thumb_url` attachment field","title":"Thumbnail URL","type":"string","x-stream-index":"002"}},"required":["duration"],"type":"object"},"FirebaseConfig":{"properties":{"Disabled":{"type":"boolean","writeOnly":true,"x-stream-index":"001"},"apn_template":{"type":"string","x-stream-index":"005"},"credentials_json":{"type":"string","x-stream-index":"006"},"data_template":{"type":"string","x-stream-index":"004"},"notification_template":{"type":"string","x-stream-index":"003"},"server_key":{"type":"string","x-stream-index":"002"}},"type":"object"},"FirebaseConfigFields":{"properties":{"apn_template":{"type":"string","x-stream-index":"004"},"credentials_json":{"type":"string","x-stream-index":"006"},"data_template":{"type":"string","x-stream-index":"003"},"enabled":{"type":"boolean","x-stream-index":"001"},"notification_template":{"type":"string","x-stream-index":"002"},"server_key":{"type":"string","x-stream-index":"005"}},"required":["enabled"],"type":"object"},"Flag":{"description":"Contains information about flagged user or message","properties":{"approved_at":{"description":"Date of the approval","format":"date-time","title":"Approved at","type":"number","x-stream-index":"015"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"011"},"created_by_automod":{"type":"boolean","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"022"},"details":{"$ref":"#/components/schemas/FlagDetails","x-stream-index":"021"},"reason":{"type":"string","x-stream-index":"020"},"rejected_at":{"description":"Date of the rejection","format":"date-time","title":"Rejected at","type":"number","x-stream-index":"016"},"reviewed_at":{"description":"Date of the review","format":"date-time","title":"Reviewed at","type":"number","x-stream-index":"013"},"reviewed_by":{"type":"string","x-stream-index":"014"},"target_message":{"$ref":"#/components/schemas/Message","x-stream-index":"008"},"target_message_id":{"description":"ID of flagged message","title":"Target Message ID","type":"string","x-stream-index":"007"},"target_user":{"$ref":"#/components/schemas/User","description":"Flagged user","title":"User","x-stream-index":"010"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"012"},"user":{"$ref":"#/components/schemas/User","description":"User who flagged a message or a user","title":"User","x-stream-index":"006"}},"required":["created_by_automod","created_at","updated_at"],"title":"Flag","type":"object"},"FlagContentOptions":{"properties":{"reason":{"type":"string","x-stream-index":"001"}},"required":["reason"],"type":"object"},"FlagDetails":{"properties":{"Extra":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"002"},"automod":{"$ref":"#/components/schemas/AutomodDetails","x-stream-index":"001"},"original_text":{"type":"string","x-stream-index":"003"}},"required":["Extra","original_text"],"type":"object"},"FlagFeedback":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"005"},"labels":{"items":{"$ref":"#/components/schemas/Label"},"type":"array","x-stream-index":"006"},"message_id":{"type":"string","x-stream-index":"004"}},"required":["message_id","created_at","labels"],"type":"object"},"FlagMessageDetails":{"properties":{"pin_changed":{"type":"boolean","x-stream-index":"002"},"should_enrich":{"type":"boolean","x-stream-index":"003"},"skip_push":{"type":"boolean","x-stream-index":"004"},"updated_by_id":{"type":"string","x-stream-index":"001"}},"type":"object"},"FlagRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"description":"Additional metadata about the flag","title":"Custom","type":"object","x-stream-index":"006"},"entity_creator_id":{"description":"ID of the user who created the flagged entity","title":"Entity Creator ID","type":"string","x-stream-index":"003"},"entity_id":{"description":"Unique identifier of the entity being flagged","title":"Entity ID","type":"string","x-stream-index":"002"},"entity_type":{"description":"Type of entity being flagged (e.g., message, user)","title":"Entity Type","type":"string","x-stream-index":"001"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content being flagged","title":"Moderation Payload","x-stream-index":"005"},"reason":{"description":"Optional explanation for why the content is being flagged","maxLength":255,"title":"Reason","type":"string","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"007.002"},"user_id":{"type":"string","x-stream-index":"007.001"}},"required":["entity_type","entity_id"],"type":"object"},"FlagResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"item_id":{"description":"Unique identifier of the created moderation item","title":"Item ID","type":"string","x-stream-index":"001"}},"required":["item_id","duration"],"type":"object"},"FlagUpdatedEvent":{"nullable":true,"properties":{"CreatedBy":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"004"},"Message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"002"},"User":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"type":{"default":"flag.updated","type":"string","x-stream-index":"001.002"}},"required":["type","created_at","custom"],"title":"FlagUpdatedEvent","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"},"FlagUserOptions":{"properties":{"reason":{"type":"string","x-stream-index":"001"}},"required":["reason"],"type":"object"},"FrameRecordSettings":{"properties":{"capture_interval_in_seconds":{"format":"int32","maximum":60,"minimum":2,"type":"integer","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"},"quality":{"type":"string","x-stream-index":"002"}},"required":["mode","capture_interval_in_seconds"],"type":"object"},"FrameRecordingEgressConfig":{"properties":{"capture_interval_in_seconds":{"format":"int32","type":"integer","x-stream-index":"007"},"external_storage":{"$ref":"#/components/schemas/ExternalStorage","x-stream-index":"006"},"quality":{"$ref":"#/components/schemas/Quality","x-stream-index":"004"},"storage_name":{"type":"string","x-stream-index":"005"}},"type":"object"},"FrameRecordingResponse":{"properties":{"status":{"type":"string","x-stream-index":"001"}},"required":["status"],"type":"object"},"FrameRecordingSettingsRequest":{"properties":{"capture_interval_in_seconds":{"format":"int32","maximum":60,"minimum":2,"type":"integer","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"},"quality":{"enum":["360p","480p","720p","1080p","1440p"],"type":"string","x-stream-index":"002"}},"required":["mode","capture_interval_in_seconds"],"type":"object"},"FrameRecordingSettingsResponse":{"properties":{"capture_interval_in_seconds":{"format":"int32","maximum":60,"minimum":2,"type":"integer","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"},"quality":{"type":"string","x-stream-index":"002"}},"required":["mode","capture_interval_in_seconds"],"type":"object"},"FullUserResponse":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"015"},"banned":{"type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"014"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.011"},"devices":{"items":{"$ref":"#/components/schemas/DeviceResponse"},"type":"array","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001.001"},"image":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"005"},"language":{"type":"string","x-stream-index":"001.005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"001.014"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"012"},"mutes":{"items":{"$ref":"#/components/schemas/UserMuteResponse"},"type":"array","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"001.002"},"online":{"type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"003"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.015"},"role":{"type":"string","x-stream-index":"001.006"},"shadow_banned":{"type":"boolean","x-stream-index":"013"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"009"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"010"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"008"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"011"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","devices","invisible","mutes","channel_mutes","unread_count","total_unread_count","unread_channels","unread_threads","shadow_banned","blocked_user_ids"],"type":"object"},"GeofenceResponse":{"nullable":true,"properties":{"country_codes":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"description":{"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"type":{"type":"string","x-stream-index":"002"}},"required":["name"],"type":"object"},"GeofenceSettings":{"properties":{"names":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"required":["names"],"type":"object"},"GeofenceSettingsRequest":{"properties":{"names":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"type":"object"},"GeofenceSettingsResponse":{"properties":{"names":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"required":["names"],"type":"object"},"GetActiveCallsStatusResponse":{"description":"Response containing active calls status information","nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"},"end_time":{"description":"End time of the status period","format":"date-time","title":"time.Time","type":"number","x-stream-index":"003"},"metrics":{"$ref":"#/components/schemas/ActiveCallsMetrics","description":"Detailed metrics","title":"*ActiveCallsMetrics","x-stream-index":"005"},"start_time":{"description":"Start time of the status period","format":"date-time","title":"time.Time","type":"number","x-stream-index":"002"},"summary":{"$ref":"#/components/schemas/ActiveCallsSummary","description":"Summary of active calls","title":"*ActiveCallsSummary","x-stream-index":"004"}},"required":["duration","start_time","end_time"],"title":"GetActiveCallsStatusResponse","type":"object"},"GetApplicationResponse":{"description":"Basic response information","nullable":true,"properties":{"app":{"$ref":"#/components/schemas/AppResponseFields","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["app","duration"],"title":"Response","type":"object"},"GetBlockListResponse":{"description":"Response for get block list","nullable":true,"properties":{"blocklist":{"$ref":"#/components/schemas/BlockListResponse","description":"Block list object","title":"BlockListResponse","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["duration"],"title":"GetBlockListResponse","type":"object","x-stream-docs-page-id":"get_block_list"},"GetBlockedUsersResponse":{"nullable":true,"properties":{"blocks":{"description":"Array of blocked user object","items":{"$ref":"#/components/schemas/BlockedUserResponse"},"title":"Blocks","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["blocks","duration"],"type":"object"},"GetCallReportResponse":{"description":"Basic response information","nullable":true,"properties":{"chat_activity":{"$ref":"#/components/schemas/ChatActivityStatsResponse","x-stream-index":"004"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"report":{"$ref":"#/components/schemas/ReportResponse","x-stream-index":"003"},"session_id":{"type":"string","x-stream-index":"002"},"video_reactions":{"items":{"$ref":"#/components/schemas/VideoReactionsResponse"},"type":"array","x-stream-index":"005"}},"required":["duration","session_id","report"],"title":"Response","type":"object"},"GetCallResponse":{"nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001.001"},"duration":{"type":"string","x-stream-index":"002.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001.002"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"001.004"}},"required":["call","members","own_capabilities","blocked_users","duration"],"title":"GetCallResponse","type":"object"},"GetCallTypeResponse":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.005"},"duration":{"type":"string","x-stream-index":"002.001"},"external_storage":{"type":"string","x-stream-index":"001.007"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"001.002"},"name":{"type":"string","x-stream-index":"001.001"},"notification_settings":{"$ref":"#/components/schemas/NotificationSettings","x-stream-index":"001.004"},"settings":{"$ref":"#/components/schemas/CallSettingsResponse","x-stream-index":"001.003"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.006"}},"required":["name","grants","settings","notification_settings","created_at","updated_at","duration"],"title":"GetCallTypeResponse","type":"object"},"GetCampaignResponse":{"description":"Basic response information","nullable":true,"properties":{"campaign":{"$ref":"#/components/schemas/CampaignResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"users":{"$ref":"#/components/schemas/PagerResponse","x-stream-index":"002"}},"required":["duration"],"title":"Response","type":"object"},"GetChannelTypeResponse":{"description":"Basic response information","nullable":true,"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"003.002.026"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"003.002.021"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.002.022"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"003.002.027"},"blocklist":{"type":"string","x-stream-index":"003.002.023"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.002.024"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"003.002.025"},"commands":{"items":{"$ref":"#/components/schemas/Command"},"type":"array","x-stream-index":"003.003"},"connect_events":{"type":"boolean","x-stream-index":"003.002.004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.001.003"},"custom_events":{"type":"boolean","x-stream-index":"003.002.012"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"004.001"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"002"},"mark_messages_pending":{"type":"boolean","x-stream-index":"003.002.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"003.002.020"},"mutes":{"type":"boolean","x-stream-index":"003.002.009"},"name":{"type":"string","x-stream-index":"003.002.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"003.002.028"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"003.002.029"},"permissions":{"items":{"$ref":"#/components/schemas/PolicyRequest"},"type":"array","x-stream-index":"001"},"polls":{"type":"boolean","x-stream-index":"003.002.016"},"push_notifications":{"type":"boolean","x-stream-index":"003.002.013"},"quotes":{"type":"boolean","x-stream-index":"003.002.008"},"reactions":{"type":"boolean","x-stream-index":"003.002.006"},"read_events":{"type":"boolean","x-stream-index":"003.002.003"},"reminders":{"type":"boolean","x-stream-index":"003.002.014"},"replies":{"type":"boolean","x-stream-index":"003.002.007"},"search":{"type":"boolean","x-stream-index":"003.002.005"},"shared_locations":{"type":"boolean","x-stream-index":"003.002.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"003.002.030"},"typing_events":{"type":"boolean","x-stream-index":"003.002.002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"003.001.004"},"uploads":{"type":"boolean","x-stream-index":"003.002.010"},"url_enrichment":{"type":"boolean","x-stream-index":"003.002.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"003.002.017"}},"required":["permissions","grants","created_at","updated_at","name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","commands","duration"],"title":"Response","type":"object"},"GetCommandResponse":{"nullable":true,"properties":{"args":{"type":"string","x-stream-index":"001.006"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.001"},"description":{"type":"string","x-stream-index":"001.005"},"duration":{"type":"string","x-stream-index":"002.001"},"name":{"type":"string","x-stream-index":"001.004"},"set":{"type":"string","x-stream-index":"001.007"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.002"}},"required":["name","description","args","set","duration"],"title":"GetCommandResponse","type":"object"},"GetConfigResponse":{"nullable":true,"properties":{"config":{"$ref":"#/components/schemas/ConfigResponse","description":"The retrieved moderation configuration","title":"Config","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["duration"],"type":"object"},"GetCustomPermissionResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"permission":{"$ref":"#/components/schemas/Permission","x-stream-index":"001"}},"required":["permission","duration"],"title":"Response","type":"object"},"GetDraftResponse":{"description":"Basic response information","nullable":true,"properties":{"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["draft","duration"],"title":"Response","type":"object"},"GetEdgesResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"edges":{"items":{"$ref":"#/components/schemas/EdgeResponse"},"type":"array","x-stream-index":"001"}},"required":["edges","duration"],"title":"Response","type":"object"},"GetImportResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"import_task":{"$ref":"#/components/schemas/ImportTask","x-stream-index":"001"}},"required":["duration"],"title":"Response","type":"object"},"GetManyMessagesResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.002.001"},"messages":{"description":"List of messages","items":{"$ref":"#/components/schemas/MessageResponse"},"title":"Messages","type":"array","x-stream-index":"001.001"}},"required":["messages","duration"],"type":"object"},"GetMessageResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageWithChannelResponse","x-stream-index":"001"},"pending_message_metadata":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"002"}},"required":["message","duration"],"title":"Response","type":"object"},"GetOGResponse":{"nullable":true,"properties":{"actions":{"items":{"$ref":"#/components/schemas/Action"},"type":"array","x-stream-index":"001.015"},"asset_url":{"description":"URL of detected video or audio","title":"Image URL","type":"string","x-stream-index":"001.017"},"author_icon":{"type":"string","x-stream-index":"001.007"},"author_link":{"description":"og:site","title":"Author Link","type":"string","x-stream-index":"001.006"},"author_name":{"description":"og:site_name","title":"Author Name","type":"string","x-stream-index":"001.005"},"color":{"type":"string","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.018"},"duration":{"type":"string","x-stream-index":"002.001"},"fallback":{"type":"string","x-stream-index":"001.002"},"fields":{"items":{"$ref":"#/components/schemas/Field"},"type":"array","x-stream-index":"001.016"},"footer":{"type":"string","x-stream-index":"001.013"},"footer_icon":{"type":"string","x-stream-index":"001.014"},"giphy":{"$ref":"#/components/schemas/Images","x-stream-index":"001.019"},"image_url":{"description":"URL of detected image","title":"Image URL","type":"string","x-stream-index":"001.011"},"og_scrape_url":{"description":"extracted url from the text","title":"OG Scrape URL","type":"string","x-stream-index":"001.020"},"original_height":{"format":"int32","type":"integer","x-stream-index":"001.022"},"original_width":{"format":"int32","type":"integer","x-stream-index":"001.021"},"pretext":{"type":"string","x-stream-index":"001.004"},"text":{"description":"og:description","title":"Text","type":"string","x-stream-index":"001.010"},"thumb_url":{"description":"URL of detected thumb image","title":"Image URL","type":"string","x-stream-index":"001.012"},"title":{"description":"og:title","title":"Title","type":"string","x-stream-index":"001.008"},"title_link":{"description":"og:url","title":"Title Link","type":"string","x-stream-index":"001.009"},"type":{"description":"Attachment type, could be empty, image, audio or video","title":"Type","type":"string","x-stream-index":"001.001"}},"required":["custom","duration"],"title":"Get OG Attachment","type":"object","x-stream-docs-page-id":"og"},"GetOrCreateCallRequest":{"nullable":true,"properties":{"data":{"$ref":"#/components/schemas/CallRequest","title":"ReadOnlyData","x-stream-index":"003"},"members_limit":{"format":"int32","maximum":100,"type":"integer","x-stream-index":"007"},"notify":{"description":"if provided it sends a notification event to the members for this call","title":"Notify","type":"boolean","x-stream-index":"005"},"ring":{"description":"if provided it sends a ring event to the members for this call","title":"Ring","type":"boolean","x-stream-index":"004"},"video":{"type":"boolean","x-stream-index":"006"}},"title":"GetOrCreateCallRequest","type":"object"},"GetOrCreateCallResponse":{"nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001.001"},"created":{"type":"boolean","x-stream-index":"002"},"duration":{"type":"string","x-stream-index":"003.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001.002"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"001.004"}},"required":["call","members","own_capabilities","blocked_users","created","duration"],"title":"GetOrCreateCallResponse","type":"object"},"GetPushTemplatesResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"templates":{"items":{"$ref":"#/components/schemas/PushTemplate"},"type":"array","x-stream-index":"002"}},"required":["duration","templates"],"title":"Response","type":"object"},"GetRateLimitsResponse":{"nullable":true,"properties":{"android":{"additionalProperties":{"$ref":"#/components/schemas/LimitInfo"},"description":"Map of endpoint rate limits for the Android platform","title":"Android","type":"object","x-stream-index":"002","x-stream-map":{"key":"endpoint","title":"Endpoint name","description":"The name of the endpoint for which the limits apply"}},"duration":{"type":"string","x-stream-index":"005.001"},"ios":{"additionalProperties":{"$ref":"#/components/schemas/LimitInfo"},"description":"Map of endpoint rate limits for the iOS platform","title":"iOS","type":"object","x-stream-index":"003","x-stream-map":{"key":"endpoint","title":"Endpoint name","description":"The name of the endpoint for which the limits apply"}},"server_side":{"additionalProperties":{"$ref":"#/components/schemas/LimitInfo"},"description":"Map of endpoint rate limits for the server-side platform","title":"Server-side","type":"object","x-stream-index":"001","x-stream-map":{"key":"endpoint","title":"Endpoint name","description":"The name of the endpoint for which the limits apply"}},"web":{"additionalProperties":{"$ref":"#/components/schemas/LimitInfo"},"description":"Map of endpoint rate limits for the web platform","title":"Web","type":"object","x-stream-index":"004","x-stream-map":{"key":"endpoint","title":"Endpoint name","description":"The name of the endpoint for which the limits apply"}}},"required":["duration"],"title":"Get Rate Limits Response","type":"object","x-stream-docs-page-id":"rate_limits"},"GetReactionsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"reactions":{"description":"List of reactions","items":{"$ref":"#/components/schemas/Reaction"},"title":"Reactions","type":"array","x-stream-index":"001"}},"required":["reactions","duration"],"type":"object"},"GetRepliesResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"messages":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","x-stream-index":"001"}},"required":["messages","duration"],"title":"Response","type":"object"},"GetReviewQueueItemResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"Current state of the review queue item","title":"Item","x-stream-index":"001"}},"required":["duration"],"type":"object"},"GetSegmentResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"segment":{"$ref":"#/components/schemas/SegmentResponse","description":"Segment","title":"SegmentResponse","x-stream-index":"001"}},"required":["duration"],"type":"object"},"GetTaskResponse":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.003"},"duration":{"type":"string","x-stream-index":"004.001"},"error":{"$ref":"#/components/schemas/ErrorResult","description":"Error produced by task","title":"Error","x-stream-index":"003"},"result":{"additionalProperties":{},"description":"Result produced by task after completion","title":"Result","type":"object","x-stream-index":"002"},"status":{"description":"Current status of task","title":"Status","type":"string","x-stream-index":"001.002"},"task_id":{"description":"ID of task","title":"Task ID","type":"string","x-stream-index":"001.001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.004"}},"required":["task_id","status","created_at","updated_at","duration"],"title":"Get Task Response","type":"object","x-stream-docs-page-id":"tasks"},"GetThreadResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"thread":{"$ref":"#/components/schemas/ThreadStateResponse","description":"Enriched thread state","title":"Thread","x-stream-index":"001"}},"required":["thread","duration"],"type":"object"},"GoLiveRequest":{"nullable":true,"properties":{"recording_storage_name":{"type":"string","x-stream-index":"005"},"start_closed_caption":{"type":"boolean","x-stream-index":"008"},"start_hls":{"type":"boolean","x-stream-index":"003"},"start_recording":{"type":"boolean","x-stream-index":"004"},"start_transcription":{"type":"boolean","x-stream-index":"007"},"transcription_storage_name":{"type":"string","x-stream-index":"006"}},"title":"GoLiveRequest","type":"object"},"GoLiveResponse":{"description":"Basic response information","nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["call","duration"],"title":"Response","type":"object"},"GoogleVisionConfig":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"GroupedStatsResponse":{"nullable":true,"properties":{"name":{"type":"string","x-stream-index":"001"},"unique":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["name","unique"],"type":"object"},"HLSEgressConfig":{"properties":{"composite_app_settings":{"$ref":"#/components/schemas/CompositeAppSettings","x-stream-index":"005"},"playlist_url":{"type":"string","x-stream-index":"007"},"qualities":{"items":{"$ref":"#/components/schemas/Quality"},"type":"array","x-stream-index":"004"},"start_unix_nano":{"format":"int64","type":"integer","x-stream-index":"006"}},"type":"object"},"HLSSettings":{"properties":{"auto_on":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"004"},"quality_tracks":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"required":["auto_on","enabled","quality_tracks"],"type":"object"},"HLSSettingsRequest":{"properties":{"auto_on":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"layout":{"$ref":"#/components/schemas/LayoutSettingsRequest","title":"LayoutSettings","x-stream-index":"004"},"quality_tracks":{"items":{"type":"string"},"maximum":3,"minimum":1,"type":"array","x-stream-index":"003"}},"required":["quality_tracks"],"title":"HLSSettingsRequest","type":"object"},"HLSSettingsResponse":{"description":"HLSSettings is the payload for HLS settings","properties":{"auto_on":{"title":"Auto On","type":"boolean","x-stream-index":"001"},"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"002"},"layout":{"$ref":"#/components/schemas/LayoutSettingsResponse","title":"Layout","x-stream-index":"004"},"quality_tracks":{"items":{"type":"string"},"title":"Quality Tracks","type":"array","x-stream-index":"003"}},"required":["auto_on","enabled","quality_tracks","layout"],"title":"HLSSettingsResponse","type":"object"},"HarmConfig":{"properties":{"action_sequences":{"items":{"$ref":"#/components/schemas/ActionSequence"},"type":"array","x-stream-index":"001"},"severity":{"type":"integer","x-stream-index":"002"}},"required":["action_sequences","severity"],"type":"object"},"HideChannelRequest":{"nullable":true,"properties":{"clear_history":{"description":"Whether to clear message history of the channel or not","title":"Clear history","type":"boolean","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"type":"object"},"HideChannelResponse":{"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"},"HuaweiConfig":{"properties":{"Disabled":{"type":"boolean","writeOnly":true,"x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"secret":{"type":"string","x-stream-index":"002"}},"type":"object"},"HuaweiConfigFields":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"id":{"type":"string","x-stream-index":"002"},"secret":{"type":"string","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"ImageContentParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"type":"object"},"ImageData":{"properties":{"frames":{"type":"string","x-stream-index":"005"},"height":{"type":"string","x-stream-index":"003"},"size":{"type":"string","x-stream-index":"004"},"url":{"type":"string","x-stream-index":"001"},"width":{"type":"string","x-stream-index":"002"}},"required":["url","width","height","size","frames"],"type":"object"},"ImageRuleParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"required":["threshold","time_window"],"type":"object"},"ImageSize":{"properties":{"crop":{"description":"Crop mode","enum":["top","bottom","left","right","center"],"title":"Crop","type":"string","x-stream-index":"001"},"height":{"description":"Target image height","format":"int32","title":"Height","type":"integer","x-stream-index":"003"},"resize":{"description":"Resize method","enum":["clip","crop","scale","fill"],"title":"Resize","type":"string","x-stream-index":"002"},"width":{"description":"Target image width","format":"int32","title":"Width","type":"integer","x-stream-index":"004"}},"title":"Image size configuration","type":"object"},"ImageUploadRequest":{"nullable":true,"properties":{"file":{"type":"string","x-stream-index":"001.001"},"upload_sizes":{"description":"field with JSON-encoded array of image size configurations","items":{"$ref":"#/components/schemas/ImageSize"},"title":"Upload sizes","type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/OnlyUserID","x-stream-index":"001.002"}},"type":"object"},"ImageUploadResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.003.001"},"file":{"type":"string","x-stream-index":"001.001"},"thumb_url":{"type":"string","x-stream-index":"001.002"},"upload_sizes":{"description":"Array of image size configurations","items":{"$ref":"#/components/schemas/ImageSize"},"title":"Upload sizes","type":"array","x-stream-index":"002"}},"required":["duration"],"type":"object"},"Images":{"properties":{"fixed_height":{"$ref":"#/components/schemas/ImageData","x-stream-index":"002"},"fixed_height_downsampled":{"$ref":"#/components/schemas/ImageData","x-stream-index":"004"},"fixed_height_still":{"$ref":"#/components/schemas/ImageData","x-stream-index":"003"},"fixed_width":{"$ref":"#/components/schemas/ImageData","x-stream-index":"005"},"fixed_width_downsampled":{"$ref":"#/components/schemas/ImageData","x-stream-index":"007"},"fixed_width_still":{"$ref":"#/components/schemas/ImageData","x-stream-index":"006"},"original":{"$ref":"#/components/schemas/ImageData","x-stream-index":"001"}},"required":["original","fixed_height","fixed_height_still","fixed_height_downsampled","fixed_width","fixed_width_still","fixed_width_downsampled"],"type":"object"},"ImportTask":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"011"},"history":{"items":{"$ref":"#/components/schemas/ImportTaskHistory"},"type":"array","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"003"},"mode":{"type":"string","x-stream-index":"006"},"path":{"type":"string","x-stream-index":"005"},"size":{"format":"int64","type":"integer","x-stream-index":"007"},"state":{"type":"string","x-stream-index":"008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"012"}},"required":["id","path","mode","state","history","created_at","updated_at"],"type":"object"},"ImportTaskHistory":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"next_state":{"type":"string","x-stream-index":"006"},"prev_state":{"type":"string","x-stream-index":"005"}},"required":["prev_state","next_state","created_at"],"type":"object"},"IngressAudioEncodingOptions":{"properties":{"bitrate":{"maximum":128000,"minimum":16000,"type":"integer","x-stream-index":"003"},"channels":{"enum":["1","2"],"format":"int32","type":"integer","x-stream-index":"001"},"enable_dtx":{"type":"boolean","x-stream-index":"002"}},"required":["channels","enable_dtx","bitrate"],"type":"object"},"IngressAudioEncodingOptionsRequest":{"properties":{"bitrate":{"maximum":128000,"minimum":16000,"type":"integer","x-stream-index":"003"},"channels":{"enum":["1","2"],"format":"int32","type":"integer","x-stream-index":"001"},"enable_dtx":{"type":"boolean","x-stream-index":"002"}},"required":["channels","bitrate"],"type":"object"},"IngressAudioEncodingResponse":{"properties":{"bitrate":{"format":"int32","type":"integer","x-stream-index":"003"},"channels":{"format":"int32","type":"integer","x-stream-index":"001"},"enable_dtx":{"type":"boolean","x-stream-index":"002"}},"required":["channels","enable_dtx","bitrate"],"type":"object"},"IngressSettings":{"properties":{"audio_encoding_options":{"$ref":"#/components/schemas/IngressAudioEncodingOptions","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"video_encoding_options":{"additionalProperties":{"$ref":"#/components/schemas/IngressVideoEncodingOptions"},"type":"object","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"IngressSettingsRequest":{"properties":{"audio_encoding_options":{"$ref":"#/components/schemas/IngressAudioEncodingOptionsRequest","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"video_encoding_options":{"additionalProperties":{"$ref":"#/components/schemas/IngressVideoEncodingOptionsRequest"},"type":"object","x-stream-index":"003"}},"type":"object"},"IngressSettingsResponse":{"properties":{"audio_encoding_options":{"$ref":"#/components/schemas/IngressAudioEncodingResponse","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"video_encoding_options":{"additionalProperties":{"$ref":"#/components/schemas/IngressVideoEncodingResponse"},"type":"object","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"IngressVideoEncodingOptions":{"properties":{"layers":{"items":{"$ref":"#/components/schemas/IngressVideoLayer"},"minimum":1,"type":"array","x-stream-index":"001"}},"required":["layers"],"type":"object"},"IngressVideoEncodingOptionsRequest":{"properties":{"layers":{"items":{"$ref":"#/components/schemas/IngressVideoLayerRequest"},"minimum":1,"type":"array","x-stream-index":"001"}},"required":["layers"],"type":"object"},"IngressVideoEncodingResponse":{"properties":{"layers":{"items":{"$ref":"#/components/schemas/IngressVideoLayerResponse"},"type":"array","x-stream-index":"001"}},"required":["layers"],"type":"object"},"IngressVideoLayer":{"nullable":true,"properties":{"bitrate":{"minimum":1000,"type":"integer","x-stream-index":"002"},"codec":{"enum":["h264","vp8"],"type":"string","x-stream-index":"001"},"frame_rate":{"maximum":60,"minimum":1,"type":"integer","x-stream-index":"003"},"max_dimension":{"minimum":240,"type":"integer","x-stream-index":"005"},"min_dimension":{"minimum":240,"type":"integer","x-stream-index":"004"}},"required":["codec","bitrate","frame_rate","min_dimension","max_dimension"],"type":"object"},"IngressVideoLayerRequest":{"nullable":true,"properties":{"bitrate":{"format":"int32","minimum":1000,"type":"integer","x-stream-index":"002"},"codec":{"enum":["h264","vp8"],"type":"string","x-stream-index":"001"},"frame_rate_limit":{"maximum":60,"minimum":1,"type":"integer","x-stream-index":"005"},"max_dimension":{"minimum":240,"type":"integer","x-stream-index":"004"},"min_dimension":{"minimum":240,"type":"integer","x-stream-index":"003"}},"required":["codec","bitrate","min_dimension","max_dimension","frame_rate_limit"],"type":"object"},"IngressVideoLayerResponse":{"nullable":true,"properties":{"bitrate":{"type":"integer","x-stream-index":"002"},"codec":{"type":"string","x-stream-index":"001"},"frame_rate_limit":{"type":"integer","x-stream-index":"005"},"max_dimension":{"type":"integer","x-stream-index":"004"},"min_dimension":{"type":"integer","x-stream-index":"003"}},"required":["codec","bitrate","min_dimension","max_dimension","frame_rate_limit"],"type":"object"},"JoinCallAPIMetrics":{"properties":{"failures":{"format":"float","type":"number","x-stream-index":"002"},"latency":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"003"},"total":{"format":"float","type":"number","x-stream-index":"001"}},"required":["total","failures"],"type":"object"},"Label":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"phrase_list_ids":{"items":{"format":"int32","type":"integer"},"type":"array","x-stream-index":"002"}},"required":["name"],"type":"object"},"LabelThresholds":{"properties":{"block":{"description":"Threshold for automatic message block","format":"float","maximum":1,"minimum":0,"title":"Block","type":"number","x-stream-index":"002"},"flag":{"description":"Threshold for automatic message flag","format":"float","maximum":1,"minimum":0,"title":"Flag","type":"number","x-stream-index":"001"}},"type":"object"},"LayoutSettings":{"properties":{"detect_orientation":{"type":"boolean","x-stream-index":"005"},"external_app_url":{"type":"string","x-stream-index":"003"},"external_css_url":{"type":"string","x-stream-index":"004"},"name":{"enum":["spotlight","grid","single-participant","mobile","custom"],"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"required":["name","external_app_url","external_css_url"],"type":"object"},"LayoutSettingsRequest":{"properties":{"detect_orientation":{"type":"boolean","x-stream-index":"005"},"external_app_url":{"type":"string","x-stream-index":"003"},"external_css_url":{"type":"string","x-stream-index":"004"},"name":{"enum":["spotlight","grid","single-participant","mobile","custom"],"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"required":["name"],"type":"object"},"LayoutSettingsResponse":{"properties":{"detect_orientation":{"type":"boolean","x-stream-index":"005"},"external_app_url":{"type":"string","x-stream-index":"003"},"external_css_url":{"type":"string","x-stream-index":"004"},"name":{"enum":["spotlight","grid","single-participant","mobile","custom"],"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"required":["name","external_app_url","external_css_url"],"type":"object"},"LimitInfo":{"properties":{"limit":{"description":"The maximum number of calls allowed for the time window","format":"int32","title":"Limit","type":"integer","x-stream-index":"001"},"remaining":{"description":"The number of remaining calls in the current window","format":"int64","title":"Remaining","type":"integer","x-stream-index":"002"},"reset":{"description":"The Unix timestamp of the next window","format":"int64","title":"Reset","type":"integer","x-stream-index":"003"}},"required":["limit","remaining","reset"],"title":"Rate Limit info","type":"object","x-stream-docs-page-id":"rate_limits"},"LimitsSettings":{"properties":{"max_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"004"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"},"max_participants_exclude_owner":{"type":"boolean","x-stream-index":"003"},"max_participants_exclude_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"002"}},"required":["max_participants_exclude_roles"],"type":"object"},"LimitsSettingsRequest":{"properties":{"max_duration_seconds":{"format":"int32","minimum":0,"type":"integer","x-stream-index":"004"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"},"max_participants_exclude_owner":{"type":"boolean","x-stream-index":"003"},"max_participants_exclude_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"002"}},"type":"object"},"LimitsSettingsResponse":{"properties":{"max_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"004"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"},"max_participants_exclude_owner":{"type":"boolean","x-stream-index":"003"},"max_participants_exclude_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"002"}},"required":["max_participants_exclude_roles"],"type":"object"},"ListBlockListResponse":{"description":"Basic response information","nullable":true,"properties":{"blocklists":{"items":{"$ref":"#/components/schemas/BlockListResponse"},"type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["blocklists","duration"],"title":"Response","type":"object"},"ListCallTypeResponse":{"description":"Response for ListCallType","nullable":true,"properties":{"call_types":{"additionalProperties":{"$ref":"#/components/schemas/CallTypeResponse"},"type":"object","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["call_types","duration"],"title":"ListCallTypeResponse","type":"object"},"ListChannelTypesResponse":{"nullable":true,"properties":{"channel_types":{"additionalProperties":{"$ref":"#/components/schemas/ChannelTypeConfig"},"description":"Object with all channel types","title":"Channel types","type":"object","x-stream-index":"001","x-stream-map":{"key":"channel_type","title":"Channel type","description":"Channel type config object"}},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["channel_types","duration"],"title":"ListChannelTypesResponse","type":"object"},"ListCommandsResponse":{"nullable":true,"properties":{"commands":{"description":"List of commands","items":{"$ref":"#/components/schemas/Command"},"title":"Commands","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["commands","duration"],"title":"ListCommandsResponse","type":"object"},"ListDevicesResponse":{"description":"List devices response","nullable":true,"properties":{"devices":{"description":"List of devices","items":{"$ref":"#/components/schemas/DeviceResponse"},"title":"Devices","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["devices","duration"],"title":"ListDevicesResponse","type":"object"},"ListExternalStorageResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"external_storages":{"additionalProperties":{"$ref":"#/components/schemas/ExternalStorageResponse"},"type":"object","x-stream-index":"002"}},"required":["duration","external_storages"],"title":"Response","type":"object"},"ListImportsResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"import_tasks":{"items":{"$ref":"#/components/schemas/ImportTask"},"type":"array","x-stream-index":"001"}},"required":["import_tasks","duration"],"title":"Response","type":"object"},"ListPermissionsResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"permissions":{"items":{"$ref":"#/components/schemas/Permission"},"type":"array","x-stream-index":"001"}},"required":["permissions","duration"],"title":"Response","type":"object"},"ListPushProvidersResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"push_providers":{"items":{"$ref":"#/components/schemas/PushProviderResponse"},"type":"array","x-stream-index":"001"}},"required":["push_providers","duration"],"title":"Response","type":"object"},"ListRecordingsResponse":{"description":"Response for listing recordings","nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"},"recordings":{"items":{"$ref":"#/components/schemas/CallRecording"},"title":"The list of recordings.","type":"array","x-stream-index":"002"}},"required":["duration","recordings"],"title":"ListRecordingsResponse","type":"object"},"ListRolesResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"roles":{"items":{"$ref":"#/components/schemas/Role"},"type":"array","x-stream-index":"001"}},"required":["roles","duration"],"title":"Response","type":"object"},"ListTranscriptionsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"},"transcriptions":{"description":"List of transcriptions for the call","items":{"$ref":"#/components/schemas/CallTranscription"},"title":"Transcriptions","type":"array","x-stream-index":"002"}},"required":["duration","transcriptions"],"title":"ListTranscriptionsResponse","type":"object"},"MarkChannelsReadRequest":{"nullable":true,"properties":{"read_by_channel":{"additionalProperties":{"type":"string"},"description":"Map of channel ID to last read message ID","maximum":30,"title":"Read by channel","type":"object","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"002.002"},"user_id":{"type":"string","x-stream-index":"002.001"}},"type":"object"},"MarkReadRequest":{"nullable":true,"properties":{"message_id":{"description":"ID of the message that is considered last read by client","title":"Message ID","type":"string","x-stream-index":"001"},"thread_id":{"description":"Optional Thread ID to specifically mark a given thread as read","title":"Thread ID","type":"string","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"type":"object"},"MarkReadResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"event":{"$ref":"#/components/schemas/MessageReadEvent","description":"Mark read event","title":"Event","x-stream-index":"001"}},"required":["duration"],"type":"object"},"MarkReviewedRequest":{"properties":{"content_to_mark_as_reviewed_limit":{"format":"int32","maximum":2500,"type":"integer","x-stream-index":"002"},"disable_marking_content_as_reviewed":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"MarkUnreadRequest":{"nullable":true,"properties":{"message_id":{"description":"ID of the message from where the channel is marked unread","title":"Message ID","type":"string","x-stream-index":"001"},"thread_id":{"description":"Mark a thread unread, specify both the thread and message id","title":"Thread ID","type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"type":"object"},"MemberAddedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"002.001"},"type":{"default":"member.added","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MemberAddedEvent","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"},"MemberLookup":{"properties":{"Limit":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"001"}},"required":["Limit"],"type":"object"},"MemberRemovedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"001.001"},"type":{"default":"member.removed","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MemberRemovedEvent","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"},"MemberRequest":{"description":"MemberRequest is the payload for adding a member to a call.","properties":{"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"003"},"role":{"title":"Role","type":"string","x-stream-index":"002"},"user_id":{"minLength":1,"title":"User ID","type":"string","x-stream-index":"001"}},"required":["user_id"],"title":"MemberRequest","type":"object"},"MemberResponse":{"description":"MemberResponse is the payload for a member of a call.","properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"005"},"custom":{"additionalProperties":{},"description":"Custom member response data","title":"Custom","type":"object","x-stream-index":"004"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"007"},"role":{"title":"Role","type":"string","x-stream-index":"003"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"006"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"},"user_id":{"type":"string","x-stream-index":"002"}},"required":["user","user_id","custom","created_at","updated_at"],"title":"MemberResponse","type":"object"},"MemberUpdatedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"005.002"},"channel_type":{"type":"string","x-stream-index":"005.003"},"cid":{"type":"string","x-stream-index":"005.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"002.001"},"type":{"default":"member.updated","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MemberUpdatedEvent","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"},"MembersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"members":{"description":"List of found members","items":{"$ref":"#/components/schemas/ChannelMember"},"title":"Members","type":"array","x-stream-index":"001"}},"required":["members","duration"],"type":"object"},"Message":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"012"},"before_message_send_failed":{"type":"boolean","x-stream-index":"046"},"cid":{"type":"string","x-stream-index":"028"},"command":{"type":"string","x-stream-index":"006"},"created_at":{"format":"date-time","type":"number","x-stream-index":"030"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"034"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"033"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"023"},"html":{"type":"string","x-stream-index":"007"},"i18n":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"044"},"id":{"type":"string","x-stream-index":"002"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"040"},"latest_reactions":{"items":{"$ref":"#/components/schemas/Reaction"},"type":"array","x-stream-index":"013"},"mentioned_users":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"043"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"052"},"mml":{"type":"string","x-stream-index":"005"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"056"},"own_reactions":{"items":{"$ref":"#/components/schemas/Reaction"},"type":"array","x-stream-index":"014"},"parent_id":{"type":"string","x-stream-index":"019"},"pin_expires":{"format":"date-time","type":"number","x-stream-index":"051"},"pinned":{"type":"boolean","x-stream-index":"047"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"048"},"pinned_by":{"$ref":"#/components/schemas/User","x-stream-index":"050"},"poll":{"$ref":"#/components/schemas/Poll","x-stream-index":"054"},"poll_id":{"type":"string","x-stream-index":"053"},"quoted_message":{"$ref":"#/components/schemas/Message","x-stream-index":"025"},"quoted_message_id":{"type":"string","x-stream-index":"024"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"015"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"017"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"016"},"reminder":{"$ref":"#/components/schemas/MessageReminder","x-stream-index":"058"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"022"},"restricted_visibility":{"items":{"type":"string"},"type":"array","x-stream-index":"011"},"shadowed":{"type":"boolean","x-stream-index":"036"},"shared_location":{"$ref":"#/components/schemas/SharedLocation","x-stream-index":"055"},"show_in_channel":{"type":"boolean","x-stream-index":"021"},"silent":{"type":"boolean","x-stream-index":"045"},"text":{"type":"string","x-stream-index":"004"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"027"},"type":{"type":"string","x-stream-index":"008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"031"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"010"}},"required":["id","text","html","type","restricted_visibility","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reaction_groups","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned"],"type":"object"},"MessageActionRequest":{"nullable":true,"properties":{"form_data":{"additionalProperties":{"type":"string"},"description":"ReadOnlyData to execute command with","title":"Form data","type":"object","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"required":["form_data"],"type":"object"},"MessageChangeSet":{"properties":{"attachments":{"type":"boolean","x-stream-index":"005"},"custom":{"type":"boolean","x-stream-index":"001"},"html":{"type":"boolean","x-stream-index":"004"},"mentioned_user_ids":{"type":"boolean","x-stream-index":"006"},"mml":{"type":"boolean","x-stream-index":"003"},"pin":{"type":"boolean","x-stream-index":"009"},"quoted_message_id":{"type":"boolean","x-stream-index":"007"},"silent":{"type":"boolean","x-stream-index":"008"},"text":{"type":"boolean","x-stream-index":"002"}},"required":["custom","text","mml","html","attachments","mentioned_user_ids","quoted_message_id","silent","pin"],"type":"object"},"MessageDeletedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"006.002"},"hard_delete":{"type":"boolean","x-stream-index":"002.001"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"005.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"message.deleted","type":"string","x-stream-index":"006.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["hard_delete","cid","channel_id","channel_type","type","created_at"],"title":"MessageDeletedEvent","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":{"approved_at":{"format":"date-time","type":"number","x-stream-index":"013"},"created_at":{"format":"date-time","type":"number","x-stream-index":"009"},"created_by_automod":{"type":"boolean","x-stream-index":"001"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"008"},"details":{"$ref":"#/components/schemas/FlagDetails","x-stream-index":"006"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"005"},"moderation_feedback":{"$ref":"#/components/schemas/FlagFeedback","x-stream-index":"003"},"moderation_result":{"$ref":"#/components/schemas/MessageModerationResult","x-stream-index":"002"},"reason":{"type":"string","x-stream-index":"007"},"rejected_at":{"format":"date-time","type":"number","x-stream-index":"014"},"reviewed_at":{"format":"date-time","type":"number","x-stream-index":"011"},"reviewed_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"012"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"004"}},"required":["created_by_automod","created_at","updated_at"],"type":"object"},"MessageFlaggedEvent":{"properties":{"cid":{"type":"string","x-stream-index":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"005.002"},"flag":{"$ref":"#/components/schemas/Flag","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"002.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"002.002"},"type":{"default":"message.flagged","type":"string","x-stream-index":"005.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004"}},"required":["cid","type","created_at"],"title":"MessageFlaggedEvent","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"},"MessageHistoryEntryResponse":{"nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"007"},"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"006"},"is_deleted":{"type":"boolean","x-stream-index":"004"},"message_id":{"type":"string","x-stream-index":"001"},"message_updated_at":{"format":"date-time","type":"number","x-stream-index":"003"},"message_updated_by_id":{"type":"string","x-stream-index":"002"},"text":{"type":"string","x-stream-index":"005"}},"required":["message_id","message_updated_by_id","message_updated_at","is_deleted","text","attachments","Custom"],"type":"object"},"MessageModerationResult":{"description":"Result of the message moderation","properties":{"action":{"description":"Action taken by automod","title":"Action","type":"string","x-stream-index":"002"},"ai_moderation_response":{"$ref":"#/components/schemas/ModerationResponse","description":"Response from AI moderation","title":"ModerationResponse","x-stream-index":"007"},"blocked_word":{"description":"Word that was blocked","title":"Blocked word","type":"string","x-stream-index":"004"},"blocklist_name":{"description":"Name of the blocklist","title":"Blocklist name","type":"string","x-stream-index":"005"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"010"},"message_id":{"description":"ID of the message","title":"Message ID","type":"string","x-stream-index":"001"},"moderated_by":{"description":"User who moderated the message","title":"Moderated by","type":"string","x-stream-index":"003"},"moderation_thresholds":{"$ref":"#/components/schemas/Thresholds","description":"Thresholds for AI moderation","title":"Thresholds","x-stream-index":"006"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"011"},"user_bad_karma":{"description":"Whether user has bad karma","title":"User bad karma","type":"boolean","x-stream-index":"009"},"user_karma":{"description":"Karma of the user","format":"float","title":"User karma","type":"number","x-stream-index":"008"}},"required":["message_id","action","user_karma","user_bad_karma","created_at","updated_at"],"title":"Message moderation result","type":"object"},"MessageNewEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"005.002"},"channel_type":{"type":"string","x-stream-index":"005.003"},"cid":{"type":"string","x-stream-index":"005.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"006.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"notification.thread_message_new","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"},"watcher_count":{"format":"int32","type":"integer","x-stream-index":"002.001"}},"required":["watcher_count","type","created_at","cid","channel_id","channel_type"],"title":"MessageNewEvent","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"},"MessageOptions":{"properties":{"include_thread_participants":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"MessagePaginationParams":{"type":"object"},"MessageReadEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"003"},"channel_last_message_at":{"format":"date-time","type":"number","x-stream-index":"005"},"channel_type":{"type":"string","x-stream-index":"004"},"cid":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"009"},"last_read_message_id":{"type":"string","x-stream-index":"010"},"team":{"type":"string","x-stream-index":"006"},"thread":{"$ref":"#/components/schemas/ThreadResponse","x-stream-index":"008"},"type":{"default":"message.read","type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","x-stream-index":"007"}},"required":["type","cid","channel_id","channel_type","created_at"],"type":"object"},"MessageReminder":{"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"004"},"channel_cid":{"type":"string","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"011"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"006"},"message_id":{"type":"string","x-stream-index":"005"},"remind_at":{"format":"date-time","type":"number","x-stream-index":"009"},"task_id":{"type":"string","x-stream-index":"010"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"012"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"user_id":{"type":"string","x-stream-index":"007"}},"required":["channel_cid","message_id","user_id","task_id","created_at","updated_at"],"type":"object"},"MessageRequest":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"maximum":30,"type":"array","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"html":{"type":"string","x-stream-index":"010"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"mentioned_users":{"items":{"type":"string"},"maximum":100,"type":"array","x-stream-index":"008"},"mml":{"type":"string","x-stream-index":"003"},"parent_id":{"type":"string","x-stream-index":"005"},"pin_expires":{"format":"date-time","type":"number","x-stream-index":"015"},"pinned":{"type":"boolean","x-stream-index":"013"},"pinned_at":{"format":"date-time","nullable":true,"type":"string","x-stream-index":"014"},"poll_id":{"type":"string","x-stream-index":"039"},"quoted_message_id":{"type":"string","x-stream-index":"009"},"restricted_visibility":{"items":{"type":"string"},"maximum":10,"type":"array","x-stream-index":"016"},"shared_location":{"$ref":"#/components/schemas/SharedLocation","x-stream-index":"040"},"show_in_channel":{"type":"boolean","x-stream-index":"006"},"silent":{"type":"boolean","x-stream-index":"012"},"text":{"type":"string","x-stream-index":"002"},"type":{"enum":["''","regular","system"],"type":"string","x-stream-index":"011"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"021.002"},"user_id":{"type":"string","x-stream-index":"021.001"}},"type":"object"},"MessageResponse":{"description":"Represents any chat message","properties":{"attachments":{"description":"Array of message attachments","items":{"$ref":"#/components/schemas/Attachment"},"title":"Message attachments","type":"array","x-stream-docs-page-id":"message_format#attachment-format","x-stream-index":"008"},"cid":{"description":"Channel unique identifier in \u003ctype\u003e:\u003cid\u003e format","title":"Channel CID","type":"string","x-stream-index":"022"},"command":{"description":"Contains provided slash command","title":"Command","type":"string","x-stream-docs-page-id":"custom_commands_webhook","x-stream-index":"004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"023"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"026"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"025"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"018"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"041"},"html":{"description":"Contains HTML markup of the message. Can only be set when using server-side API","title":"HTML content","type":"string","x-stream-index":"005"},"i18n":{"additionalProperties":{"type":"string"},"description":"Object with translations. Key `language` contains the original language key. Other keys contain translations","title":"Internationalization info","type":"object","x-stream-docs-page-id":"translation","x-stream-index":"030"},"id":{"description":"Message ID is unique string identifier of the message","title":"ID","type":"string","x-stream-index":"001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"Contains image moderation information","title":"Image moderation labels","type":"object","x-stream-index":"028"},"latest_reactions":{"description":"List of 10 latest reactions to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Latest reactions","type":"array","x-stream-index":"009"},"mentioned_users":{"description":"List of mentioned users","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Mentioned Users","type":"array","x-stream-index":"029"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"036"},"mml":{"description":"Should be empty if `text` is provided. Can only be set when using server-side API","title":"Messaging Markup Language","type":"string","x-stream-docs-page-id":"mml_overview","x-stream-index":"003"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"039"},"own_reactions":{"description":"List of 10 latest reactions of authenticated user to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Own reactions","type":"array","x-stream-index":"010"},"parent_id":{"description":"ID of parent message (thread)","title":"Parent message ID","type":"string","x-stream-docs-page-id":"threads","x-stream-index":"015"},"pin_expires":{"description":"Date when pinned message expires","format":"date-time","title":"Pin expiration date","type":"number","x-stream-docs-page-id":"pinned_messages","x-stream-index":"035"},"pinned":{"description":"Whether message is pinned or not","title":"Pinned","type":"boolean","x-stream-docs-page-id":"pinned_messages","x-stream-index":"032"},"pinned_at":{"description":"Date when message got pinned","format":"date-time","title":"Pinned at","type":"number","x-stream-docs-page-id":"pinned_messages","x-stream-index":"033"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","description":"Contains user who pinned the message","title":"Pinned by","x-stream-docs-page-id":"pinned_messages","x-stream-index":"034"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"038"},"poll_id":{"description":"Identifier of the poll to include in the message","title":"Poll ID","type":"string","x-stream-index":"037"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","description":"Contains quoted message","title":"Quoted message","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"020"},"quoted_message_id":{"title":"ID of quoted message","type":"string","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"019"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing number of reactions of each type. Key: reaction type (string), value: number of reactions (int)","title":"Reaction counts","type":"object","x-stream-index":"011"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"014"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing scores of reactions of each type. Key: reaction type (string), value: total score of reactions (int)","title":"Reaction scores","type":"object","x-stream-index":"012"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"042"},"reply_count":{"description":"Number of replies to this message","format":"int32","title":"Reply count","type":"integer","x-stream-index":"017"},"restricted_visibility":{"description":"A list of user ids that have restricted visibility to the message, if the list is not empty, the message is only visible to the users in the list","items":{"type":"string"},"title":"Restricted visibility","type":"array","x-stream-index":"040"},"shadowed":{"description":"Whether the message was shadowed or not","title":"Shadowed","type":"boolean","x-stream-docs-page-id":"moderation#shadow-ban","x-stream-index":"027"},"shared_location":{"$ref":"#/components/schemas/SharedLocationResponseData","description":"Contains shared location data","title":"Shared Location","x-stream-index":"043"},"show_in_channel":{"description":"Whether thread reply should be shown in the channel as well","title":"Show in channel","type":"boolean","x-stream-docs-page-id":"threads","x-stream-index":"016"},"silent":{"description":"Whether message is silent or not","title":"Silent","type":"boolean","x-stream-index":"031"},"text":{"description":"Text of the message. Should be empty if `mml` is provided","title":"Text","type":"string","x-stream-index":"002"},"thread_participants":{"description":"List of users who participate in thread","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Thread participants","type":"array","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"021"},"type":{"description":"Contains type of the message","enum":["regular","ephemeral","error","reply","system","deleted"],"title":"Message Type","type":"string","x-stream-docs-page-id":"message_format#message-types","x-stream-index":"006"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"024"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Sender of the message. Required when using server-side API","title":"User object","x-stream-index":"007"}},"required":["id","text","html","type","user","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned","restricted_visibility"],"title":"Message","type":"object","x-stream-docs-page-id":"send_message"},"MessageStatsResponse":{"properties":{"count_over_time":{"items":{"$ref":"#/components/schemas/CountByMinuteResponse"},"type":"array","x-stream-index":"001"}},"type":"object"},"MessageUnblockedEvent":{"properties":{"cid":{"type":"string","x-stream-index":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"002.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"002.002"},"type":{"default":"message.unblocked","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["cid","type","created_at"],"title":"MessageUnblockedEvent","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"},"MessageUndeletedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"005.002"},"channel_type":{"type":"string","x-stream-index":"005.003"},"cid":{"type":"string","x-stream-index":"005.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"002.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"message.undeleted","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MessageUndeletedEvent","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"},"MessageUpdate":{"properties":{"change_set":{"$ref":"#/components/schemas/MessageChangeSet","x-stream-index":"002"},"old_text":{"type":"string","x-stream-index":"001"}},"type":"object"},"MessageUpdatedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"005.002"},"channel_type":{"type":"string","x-stream-index":"005.003"},"cid":{"type":"string","x-stream-index":"005.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"002.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"message.updated","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MessageUpdatedEvent","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"},"MessageWithChannelResponse":{"description":"Represents any chat message","properties":{"attachments":{"description":"Array of message attachments","items":{"$ref":"#/components/schemas/Attachment"},"title":"Message attachments","type":"array","x-stream-docs-page-id":"message_format#attachment-format","x-stream-index":"001.008"},"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel object","title":"Channel","x-stream-index":"002"},"cid":{"description":"Channel unique identifier in \u003ctype\u003e:\u003cid\u003e format","title":"Channel CID","type":"string","x-stream-index":"001.022"},"command":{"description":"Contains provided slash command","title":"Command","type":"string","x-stream-docs-page-id":"custom_commands_webhook","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.023"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.026"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"001.025"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"001.018"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001.041"},"html":{"description":"Contains HTML markup of the message. Can only be set when using server-side API","title":"HTML content","type":"string","x-stream-index":"001.005"},"i18n":{"additionalProperties":{"type":"string"},"description":"Object with translations. Key `language` contains the original language key. Other keys contain translations","title":"Internationalization info","type":"object","x-stream-docs-page-id":"translation","x-stream-index":"001.030"},"id":{"description":"Message ID is unique string identifier of the message","title":"ID","type":"string","x-stream-index":"001.001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"Contains image moderation information","title":"Image moderation labels","type":"object","x-stream-index":"001.028"},"latest_reactions":{"description":"List of 10 latest reactions to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Latest reactions","type":"array","x-stream-index":"001.009"},"mentioned_users":{"description":"List of mentioned users","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Mentioned Users","type":"array","x-stream-index":"001.029"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"001.036"},"mml":{"description":"Should be empty if `text` is provided. Can only be set when using server-side API","title":"Messaging Markup Language","type":"string","x-stream-docs-page-id":"mml_overview","x-stream-index":"001.003"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"001.039"},"own_reactions":{"description":"List of 10 latest reactions of authenticated user to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Own reactions","type":"array","x-stream-index":"001.010"},"parent_id":{"description":"ID of parent message (thread)","title":"Parent message ID","type":"string","x-stream-docs-page-id":"threads","x-stream-index":"001.015"},"pin_expires":{"description":"Date when pinned message expires","format":"date-time","title":"Pin expiration date","type":"number","x-stream-docs-page-id":"pinned_messages","x-stream-index":"001.035"},"pinned":{"description":"Whether message is pinned or not","title":"Pinned","type":"boolean","x-stream-docs-page-id":"pinned_messages","x-stream-index":"001.032"},"pinned_at":{"description":"Date when message got pinned","format":"date-time","title":"Pinned at","type":"number","x-stream-docs-page-id":"pinned_messages","x-stream-index":"001.033"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","description":"Contains user who pinned the message","title":"Pinned by","x-stream-docs-page-id":"pinned_messages","x-stream-index":"001.034"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001.038"},"poll_id":{"description":"Identifier of the poll to include in the message","title":"Poll ID","type":"string","x-stream-index":"001.037"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","description":"Contains quoted message","title":"Quoted message","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"001.020"},"quoted_message_id":{"title":"ID of quoted message","type":"string","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"001.019"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing number of reactions of each type. Key: reaction type (string), value: number of reactions (int)","title":"Reaction counts","type":"object","x-stream-index":"001.011"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"001.014"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing scores of reactions of each type. Key: reaction type (string), value: total score of reactions (int)","title":"Reaction scores","type":"object","x-stream-index":"001.012"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"001.042"},"reply_count":{"description":"Number of replies to this message","format":"int32","title":"Reply count","type":"integer","x-stream-index":"001.017"},"restricted_visibility":{"description":"A list of user ids that have restricted visibility to the message, if the list is not empty, the message is only visible to the users in the list","items":{"type":"string"},"title":"Restricted visibility","type":"array","x-stream-index":"001.040"},"shadowed":{"description":"Whether the message was shadowed or not","title":"Shadowed","type":"boolean","x-stream-docs-page-id":"moderation#shadow-ban","x-stream-index":"001.027"},"shared_location":{"$ref":"#/components/schemas/SharedLocationResponseData","description":"Contains shared location data","title":"Shared Location","x-stream-index":"001.043"},"show_in_channel":{"description":"Whether thread reply should be shown in the channel as well","title":"Show in channel","type":"boolean","x-stream-docs-page-id":"threads","x-stream-index":"001.016"},"silent":{"description":"Whether message is silent or not","title":"Silent","type":"boolean","x-stream-index":"001.031"},"text":{"description":"Text of the message. Should be empty if `mml` is provided","title":"Text","type":"string","x-stream-index":"001.002"},"thread_participants":{"description":"List of users who participate in thread","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Thread participants","type":"array","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"001.021"},"type":{"description":"Contains type of the message","enum":["regular","ephemeral","error","reply","system","deleted"],"title":"Message Type","type":"string","x-stream-docs-page-id":"message_format#message-types","x-stream-index":"001.006"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.024"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Sender of the message. Required when using server-side API","title":"User object","x-stream-index":"001.007"}},"required":["id","text","html","type","user","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned","restricted_visibility","channel"],"title":"Message","type":"object","x-stream-docs-page-id":"send_message"},"ModerationActionConfig":{"nullable":true,"properties":{"action":{"type":"string","x-stream-index":"006"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"009"},"description":{"type":"string","x-stream-index":"008"},"entity_type":{"type":"string","x-stream-index":"004"},"icon":{"type":"string","x-stream-index":"007"},"order":{"format":"int32","type":"integer","x-stream-index":"005"}},"required":["entity_type","order","action","icon","description","custom"],"type":"object"},"ModerationCheckCompletedEvent":{"description":"This event is sent when a moderation check is completed","nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"entity_id":{"description":"The ID of entity which was moderated","title":"EntityID","type":"string","x-stream-index":"002"},"entity_type":{"description":"The type of the entity which was moderated","title":"EntityType","type":"string","x-stream-index":"003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"recommended_action":{"description":"The recommended action","title":"RecommendedAction","type":"string","x-stream-index":"004"},"review_queue_item_id":{"description":"The review queue item ID","title":"ReviewQueueItemID","type":"string","x-stream-index":"005"},"type":{"default":"moderation_check.completed","type":"string","x-stream-index":"001.002"}},"required":["type","created_at","custom","entity_id","entity_type","recommended_action","review_queue_item_id"],"title":"ModerationCheckCompletedEvent","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"},"ModerationCustomActionEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"001"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"002"},"type":{"default":"moderation.custom_action","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationCustomActionEvent","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"},"ModerationDashboardPreferences":{"properties":{"flag_user_on_flagged_content":{"type":"boolean","x-stream-index":"002"},"media_queue_blur_enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"ModerationFlagResponse":{"nullable":true,"properties":{"created_at":{"type":"string","x-stream-index":"014"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"009"},"entity_creator_id":{"type":"string","x-stream-index":"006"},"entity_id":{"type":"string","x-stream-index":"005"},"entity_type":{"type":"string","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001"},"labels":{"items":{"type":"string"},"type":"array","x-stream-index":"010"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"007"},"reason":{"type":"string","x-stream-index":"008"},"result":{"items":{"additionalProperties":{},"type":"object"},"type":"array","x-stream-index":"011"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","x-stream-index":"013"},"review_queue_item_id":{"type":"string","x-stream-index":"012"},"type":{"type":"string","x-stream-index":"002"},"updated_at":{"type":"string","x-stream-index":"015"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"003"}},"required":["id","type","entity_type","entity_id","created_at","updated_at"],"type":"object"},"ModerationFlaggedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"item":{"type":"string","x-stream-index":"001"},"object_id":{"type":"string","x-stream-index":"002"},"type":{"default":"moderation.flagged","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationFlaggedEvent","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"},"ModerationMarkReviewedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"001"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"002"},"type":{"default":"moderation.mark_reviewed","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationMarkReviewedEvent","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"},"ModerationPayload":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"images":{"items":{"type":"string"},"maximum":30,"type":"array","x-stream-index":"002"},"texts":{"items":{"type":"string"},"type":"array","x-stream-index":"001"},"videos":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"type":"object"},"ModerationResponse":{"properties":{"action":{"type":"string","x-stream-index":"004"},"explicit":{"format":"float","type":"number","x-stream-index":"002"},"spam":{"format":"float","type":"number","x-stream-index":"003"},"toxic":{"format":"float","type":"number","x-stream-index":"001"}},"required":["toxic","explicit","spam","action","automod_response"],"type":"object"},"ModerationV2Response":{"properties":{"action":{"type":"string","x-stream-index":"001"},"blocklist_matched":{"type":"string","x-stream-index":"005"},"image_harms":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"original_text":{"type":"string","x-stream-index":"002"},"platform_circumvented":{"type":"boolean","x-stream-index":"007"},"semantic_filter_matched":{"type":"string","x-stream-index":"006"},"text_harms":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"required":["action","original_text"],"type":"object"},"MuteChannelRequest":{"nullable":true,"properties":{"channel_cids":{"description":"Channel CIDs to mute (if multiple channels)","items":{"type":"string"},"maximum":25,"title":"Channel CIDs","type":"array","x-stream-index":"002"},"expiration":{"description":"Duration of mute in milliseconds","title":"Expiration","type":"integer","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"type":"object"},"MuteChannelResponse":{"nullable":true,"properties":{"channel_mute":{"$ref":"#/components/schemas/ChannelMute","description":"Object with channel mute (if one channel was muted)","title":"Channel mute","x-stream-index":"001"},"channel_mutes":{"description":"Object with mutes (if multiple channels were muted)","items":{"$ref":"#/components/schemas/ChannelMute"},"title":"Channel mutes","type":"array","x-stream-index":"002"},"duration":{"type":"string","x-stream-index":"004.001"},"own_user":{"$ref":"#/components/schemas/OwnUser","description":"Authorized user object with fresh mutes information","title":"Own user","x-stream-index":"003"}},"required":["duration"],"type":"object"},"MuteRequest":{"nullable":true,"properties":{"target_ids":{"description":"User IDs to mute (if multiple users)","items":{"type":"string"},"title":"Target IDs","type":"array","x-stream-index":"001"},"timeout":{"description":"Duration of mute in minutes","minimum":0,"title":"Timeout","type":"integer","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"required":["target_ids"],"title":"MuteRequest","type":"object"},"MuteResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"004.001"},"mutes":{"description":"Object with mutes (if multiple users were muted)","items":{"$ref":"#/components/schemas/UserMute"},"title":"Mutes","type":"array","x-stream-index":"001"},"non_existing_users":{"description":"A list of users that can't be found. Common cause for this is deleted users","items":{"type":"string"},"title":"Non Existing Users","type":"array","x-stream-index":"003"},"own_user":{"$ref":"#/components/schemas/OwnUser","description":"Authorized user object with fresh mutes information","title":"Own User","x-stream-index":"002"}},"required":["duration"],"title":"MuteResponse","type":"object"},"MuteUsersRequest":{"nullable":true,"properties":{"audio":{"title":"Audio","type":"boolean","x-stream-index":"005"},"mute_all_users":{"type":"boolean","x-stream-index":"003"},"muted_by":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"010"},"muted_by_id":{"type":"string","x-stream-index":"009"},"screenshare":{"title":"Screenshare","type":"boolean","x-stream-index":"007"},"screenshare_audio":{"title":"ScreenshareAudio","type":"boolean","x-stream-index":"008"},"user_ids":{"items":{"type":"string"},"title":"UserIDs","type":"array","x-stream-index":"004"},"video":{"title":"Video","type":"boolean","x-stream-index":"006"}},"title":"MuteUsersRequest","type":"object"},"MuteUsersResponse":{"description":"MuteUsersResponse is the response payload for the mute users endpoint.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"MuteUsersResponse","type":"object"},"NetworkMetricsReportResponse":{"properties":{"average_connection_time":{"format":"float","type":"number","x-stream-index":"003"},"average_jitter":{"format":"float","type":"number","x-stream-index":"002"},"average_latency":{"format":"float","type":"number","x-stream-index":"001"},"average_time_to_reconnect":{"format":"float","type":"number","x-stream-index":"004"}},"type":"object"},"NoiseCancellationSettings":{"properties":{"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode"],"type":"object"},"NotificationMarkUnreadEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003.004"},"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"003.005"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"first_unread_message_id":{"type":"string","x-stream-index":"005"},"last_read_at":{"format":"date-time","type":"number","x-stream-index":"006"},"last_read_message_id":{"type":"string","x-stream-index":"012"},"team":{"type":"string","x-stream-index":"002.001"},"thread_id":{"type":"string","x-stream-index":"013"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"009"},"type":{"default":"notification.mark_unread","type":"string","x-stream-index":"001.001"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"010"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"008"},"unread_messages":{"format":"int32","type":"integer","x-stream-index":"007"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"011"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count","first_unread_message_id","last_read_at","unread_messages","unread_count","total_unread_count","unread_channels","unread_threads"],"title":"NotificationMarkUnreadEvent","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"},"NotificationSettings":{"properties":{"call_live_started":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"002"},"call_missed":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"006"},"call_notification":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"004"},"call_ring":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"session_started":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"003"}},"required":["enabled","call_live_started","session_started","call_notification","call_ring","call_missed"],"type":"object"},"NullTime":{"type":"object"},"OCRRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"}},"required":["label","action"],"type":"object"},"OnlyUserID":{"properties":{"id":{"type":"string","x-stream-index":"001"}},"required":["id"],"type":"object"},"OwnCapability":{"description":"All possibility of string to use","enum":["block-users","change-max-duration","create-call","create-reaction","enable-noise-cancellation","end-call","join-backstage","join-call","join-ended-call","mute-users","pin-for-everyone","read-call","remove-call-member","screenshare","send-audio","send-video","start-broadcast-call","start-closed-captions-call","start-frame-record-call","start-record-call","start-transcription-call","stop-broadcast-call","stop-closed-captions-call","stop-frame-record-call","stop-record-call","stop-transcription-call","update-call","update-call-member","update-call-permissions","update-call-settings"],"title":"OwnCapability","type":"string"},"OwnUser":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"046"},"banned":{"type":"boolean","x-stream-index":"016"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"045"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"029"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"014"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"013"},"devices":{"items":{"$ref":"#/components/schemas/Device"},"type":"array","x-stream-index":"027"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"023"},"language":{"type":"string","x-stream-index":"035"},"last_active":{"format":"date-time","type":"number","x-stream-index":"011"},"last_engaged_at":{"format":"date-time","type":"number","x-stream-index":"012"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"037"},"mutes":{"items":{"$ref":"#/components/schemas/UserMute"},"type":"array","x-stream-index":"028"},"online":{"type":"boolean","x-stream-index":"022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"026"},"push_preferences":{"$ref":"#/components/schemas/PushPreferences","x-stream-index":"025"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"005"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"031"},"total_unread_count_by_team":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"032"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"033"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"030"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"034"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"}},"required":["id","role","custom","created_at","updated_at","banned","online","devices","mutes","channel_mutes","unread_count","total_unread_count","total_unread_count_by_team","unread_channels","unread_threads","language"],"type":"object"},"OwnUserResponse":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"banned":{"type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"015"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.011"},"devices":{"items":{"$ref":"#/components/schemas/DeviceResponse"},"title":"Devices","type":"array","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001.001"},"image":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"005"},"language":{"type":"string","x-stream-index":"001.005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"001.014"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"013"},"mutes":{"items":{"$ref":"#/components/schemas/UserMuteResponse"},"type":"array","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"001.002"},"online":{"type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"003"},"push_preferences":{"$ref":"#/components/schemas/PushPreferences","x-stream-index":"002"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.015"},"role":{"type":"string","x-stream-index":"001.006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"009"},"total_unread_count_by_team":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"010"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"011"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"008"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"012"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","devices","invisible","mutes","channel_mutes","unread_count","total_unread_count","unread_channels","unread_threads"],"type":"object"},"PagerResponse":{"properties":{"next":{"type":"string","x-stream-index":"001"},"prev":{"type":"string","x-stream-index":"002"}},"type":"object"},"PaginationParams":{"properties":{"limit":{"format":"int32","minimum":0,"type":"integer","x-stream-index":"001"},"offset":{"format":"int32","type":"integer","x-stream-index":"002"}},"type":"object"},"ParticipantCountByMinuteResponse":{"nullable":true,"properties":{"first":{"format":"int32","type":"integer","x-stream-index":"002"},"last":{"format":"int32","type":"integer","x-stream-index":"003"},"max":{"format":"int32","type":"integer","x-stream-index":"004"},"min":{"format":"int32","type":"integer","x-stream-index":"005"},"start_ts":{"format":"date-time","type":"number","x-stream-index":"001"}},"required":["start_ts","first","last","max","min"],"type":"object"},"ParticipantCountOverTimeResponse":{"properties":{"by_minute":{"items":{"$ref":"#/components/schemas/ParticipantCountByMinuteResponse"},"type":"array","x-stream-index":"001"}},"type":"object"},"ParticipantReportResponse":{"properties":{"by_browser":{"items":{"$ref":"#/components/schemas/GroupedStatsResponse"},"type":"array","x-stream-index":"008"},"by_country":{"items":{"$ref":"#/components/schemas/GroupedStatsResponse"},"type":"array","x-stream-index":"005"},"by_device":{"items":{"$ref":"#/components/schemas/GroupedStatsResponse"},"type":"array","x-stream-index":"006"},"by_operating_system":{"items":{"$ref":"#/components/schemas/GroupedStatsResponse"},"type":"array","x-stream-index":"007"},"count_over_time":{"$ref":"#/components/schemas/ParticipantCountOverTimeResponse","x-stream-index":"004"},"max_concurrent":{"format":"int32","type":"integer","x-stream-index":"003"},"publishers":{"$ref":"#/components/schemas/PublisherStatsResponse","x-stream-index":"009"},"subscribers":{"$ref":"#/components/schemas/SubscriberStatsResponse","x-stream-index":"010"},"sum":{"format":"int32","type":"integer","x-stream-index":"001"},"unique":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["sum","unique"],"type":"object"},"PendingMessageEvent":{"description":"Pending message event for async moderation","nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"002.007"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"message":{"$ref":"#/components/schemas/Message","description":"The pending message","title":"Message","x-stream-index":"002.009"},"metadata":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"002.010"},"method":{"description":"The method used for the pending message","title":"Method","type":"string","x-stream-index":"003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"type":{"default":"message.pending","description":"The type of event: \"message.pending\" in this case","title":"Event Type","type":"string","x-stream-index":"001.002"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.002"}},"required":["type","custom","method","created_at"],"title":"PendingMessageEvent","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"},"PendingMessageResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"003"},"metadata":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"}},"type":"object"},"PerSDKUsageReport":{"nullable":true,"properties":{"by_version":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"002"},"total":{"format":"int32","type":"integer","x-stream-index":"001"}},"required":["total","by_version"],"type":"object"},"Permission":{"properties":{"action":{"description":"Action name this permission is for (e.g. SendMessage)","title":"Action","type":"string","x-stream-index":"004"},"condition":{"additionalProperties":{},"description":"MongoDB style condition which decides whether or not the permission is granted","title":"Condition","type":"object","x-stream-index":"007"},"custom":{"description":"Whether this is a custom permission or built-in","title":"Custom","type":"boolean","x-stream-index":"009"},"description":{"description":"Description of the permission","title":"Description","type":"string","x-stream-index":"003"},"id":{"description":"Unique permission ID","title":"ID","type":"string","x-stream-index":"001"},"level":{"description":"Level at which permission could be applied (app or channel)","enum":["app","channel"],"title":"Level","type":"string","x-stream-index":"010"},"name":{"description":"Name of the permission","title":"Name","type":"string","x-stream-index":"002"},"owner":{"description":"Whether this permission applies to resource owner or not","title":"Owner","type":"boolean","x-stream-index":"005"},"same_team":{"description":"Whether this permission applies to teammates (multi-tenancy mode only)","title":"Same team","type":"boolean","x-stream-index":"006"},"tags":{"description":"List of tags of the permission","items":{"type":"string"},"title":"Tags","type":"array","x-stream-index":"011"}},"required":["id","name","description","action","owner","same_team","custom","level","tags"],"type":"object"},"PermissionRequestEvent":{"description":"This event is sent when a user requests access to a feature on a call,\nclients receiving this event should display a permission request to the user","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"permissions":{"description":"The list of permissions requested by the user","items":{"type":"string"},"title":"Permissions","type":"array","x-stream-index":"004"},"type":{"default":"call.permission_request","description":"The type of event: \"call.permission_request\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who sent the permission request","title":"User","x-stream-index":"003"}},"required":["type","created_at","call_cid","user","permissions"],"title":"PermissionRequestEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"PinRequest":{"description":"PinRequest is the payload for pinning a message.","nullable":true,"properties":{"session_id":{"description":"the session ID of the user who pinned the message","title":"SessionID","type":"string","x-stream-index":"003"},"user_id":{"description":"the user ID of the user who pinned the message","title":"UserID","type":"string","x-stream-index":"002"}},"required":["user_id","session_id"],"title":"PinRequest","type":"object"},"PinResponse":{"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"},"PlatformDataResponse":{"properties":{"browser":{"$ref":"#/components/schemas/BrowserDataResponse","x-stream-index":"003"},"device":{"$ref":"#/components/schemas/DeviceDataResponse","x-stream-index":"002"},"os":{"$ref":"#/components/schemas/ClientOSDataResponse","x-stream-index":"001"}},"required":["os","device","browser"],"type":"object"},"Policy":{"properties":{"action":{"type":"integer","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"010"},"name":{"type":"string","x-stream-index":"004"},"owner":{"type":"boolean","x-stream-index":"008"},"priority":{"format":"int32","type":"integer","x-stream-index":"009"},"resources":{"items":{"type":"string"},"type":"array","x-stream-index":"005"},"roles":{"items":{"type":"string"},"type":"array","x-stream-index":"006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"011"}},"required":["name","resources","roles","action","owner","priority","created_at","updated_at"],"type":"object"},"PolicyRequest":{"description":"Policy request","properties":{"action":{"enum":["Deny","Allow"],"title":"Action","type":"string","x-stream-index":"001"},"name":{"description":"User-friendly policy name","title":"Name","type":"string","x-stream-index":"002"},"owner":{"description":"Whether policy applies to resource owner or not","title":"Owner","type":"boolean","x-stream-index":"005"},"priority":{"description":"Policy priority","format":"int32","maximum":999,"minimum":1,"title":"Priority","type":"integer","x-stream-index":"006"},"resources":{"description":"List of resources to apply policy to","items":{"type":"string"},"minimum":1,"title":"Resources","type":"array","x-stream-index":"003"},"roles":{"description":"List of roles to apply policy to","items":{"type":"string"},"title":"Roles","type":"array","x-stream-index":"004"}},"required":["action","name","resources","roles","owner","priority"],"title":"PolicyRequest","type":"object"},"Poll":{"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"023"},"allow_answers":{"type":"boolean","x-stream-index":"010"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"009"},"answers_count":{"format":"int32","type":"integer","x-stream-index":"015"},"created_at":{"format":"date-time","type":"number","x-stream-index":"021"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"020"},"created_by_id":{"type":"string","x-stream-index":"019"},"description":{"type":"string","x-stream-index":"005"},"enforce_unique_vote":{"type":"boolean","x-stream-index":"007"},"id":{"type":"string","x-stream-index":"003"},"is_closed":{"type":"boolean","x-stream-index":"011"},"latest_answers":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array","x-stream-index":"017"},"latest_votes_by_option":{"additionalProperties":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array"},"type":"object","x-stream-index":"016"},"max_votes_allowed":{"format":"int32","type":"integer","x-stream-index":"008"},"name":{"type":"string","x-stream-index":"004"},"options":{"items":{"$ref":"#/components/schemas/PollOption"},"type":"array","x-stream-index":"013"},"own_votes":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array","x-stream-index":"018"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"022"},"vote_count":{"format":"int32","type":"integer","x-stream-index":"012"},"vote_counts_by_option":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"014"},"voting_visibility":{"type":"string","x-stream-index":"006"}},"required":["id","name","description","enforce_unique_vote","allow_user_suggested_options","allow_answers","vote_count","options","vote_counts_by_option","answers_count","latest_votes_by_option","latest_answers","own_votes","created_by_id","created_at","updated_at","Custom"],"type":"object"},"PollOption":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id","text","custom"],"type":"object"},"PollOptionInput":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"text":{"type":"string","x-stream-index":"002"}},"type":"object"},"PollOptionRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id"],"type":"object"},"PollOptionResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"poll_option":{"$ref":"#/components/schemas/PollOptionResponseData","description":"Poll option","title":"PollOptionResponseData","x-stream-index":"001"}},"required":["poll_option","duration"],"type":"object"},"PollOptionResponseData":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id","text","custom"],"type":"object"},"PollResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"poll":{"$ref":"#/components/schemas/PollResponseData","description":"Poll","title":"PollResponseData","x-stream-index":"001"}},"required":["poll","duration"],"type":"object"},"PollResponseData":{"properties":{"allow_answers":{"type":"boolean","x-stream-index":"008"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"007"},"answers_count":{"format":"int32","type":"integer","x-stream-index":"012"},"created_at":{"format":"date-time","type":"number","x-stream-index":"019"},"created_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"018"},"created_by_id":{"type":"string","x-stream-index":"017"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"021"},"description":{"type":"string","x-stream-index":"003"},"enforce_unique_vote":{"type":"boolean","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"is_closed":{"type":"boolean","x-stream-index":"009"},"latest_answers":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array","x-stream-index":"015"},"latest_votes_by_option":{"additionalProperties":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array"},"type":"object","x-stream-index":"014"},"max_votes_allowed":{"format":"int32","type":"integer","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"002"},"options":{"items":{"$ref":"#/components/schemas/PollOptionResponseData"},"type":"array","x-stream-index":"011"},"own_votes":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array","x-stream-index":"016"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"020"},"vote_count":{"format":"int32","type":"integer","x-stream-index":"010"},"vote_counts_by_option":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"013"},"voting_visibility":{"type":"string","x-stream-index":"004"}},"required":["id","name","description","voting_visibility","enforce_unique_vote","allow_user_suggested_options","allow_answers","vote_count","options","answers_count","vote_counts_by_option","latest_votes_by_option","latest_answers","own_votes","created_by_id","created_at","updated_at","custom"],"type":"object"},"PollVote":{"nullable":true,"properties":{"answer_text":{"type":"string","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"004"},"is_answer":{"type":"boolean","x-stream-index":"006"},"option_id":{"type":"string","x-stream-index":"005"},"poll_id":{"type":"string","x-stream-index":"003"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"011"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"009"},"user_id":{"type":"string","x-stream-index":"008"}},"required":["poll_id","id","option_id","created_at","updated_at"],"type":"object"},"PollVoteResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"vote":{"$ref":"#/components/schemas/PollVoteResponseData","description":"Poll vote","title":"PollVoteResponseData","x-stream-index":"001"}},"required":["duration"],"type":"object"},"PollVoteResponseData":{"nullable":true,"properties":{"answer_text":{"type":"string","x-stream-index":"005"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"id":{"type":"string","x-stream-index":"002"},"is_answer":{"type":"boolean","x-stream-index":"004"},"option_id":{"type":"string","x-stream-index":"003"},"poll_id":{"type":"string","x-stream-index":"001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"007"},"user_id":{"type":"string","x-stream-index":"006"}},"required":["poll_id","id","option_id","created_at","updated_at"],"type":"object"},"PollVotesResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"votes":{"description":"Poll votes","items":{"$ref":"#/components/schemas/PollVoteResponseData"},"title":"PollVoteResponseList","type":"array","x-stream-index":"001"}},"required":["votes","duration"],"type":"object"},"PrivacySettings":{"properties":{"read_receipts":{"$ref":"#/components/schemas/ReadReceipts","x-stream-index":"002"},"typing_indicators":{"$ref":"#/components/schemas/TypingIndicators","x-stream-index":"001"}},"type":"object"},"PrivacySettingsResponse":{"properties":{"read_receipts":{"$ref":"#/components/schemas/ReadReceiptsResponse","x-stream-index":"002"},"typing_indicators":{"$ref":"#/components/schemas/TypingIndicatorsResponse","x-stream-index":"001"}},"type":"object"},"PublisherAllMetrics":{"properties":{"audio":{"$ref":"#/components/schemas/PublisherAudioMetrics","x-stream-index":"001"},"rtt_ms":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"003"},"video":{"$ref":"#/components/schemas/PublisherVideoMetrics","x-stream-index":"002"}},"type":"object"},"PublisherAudioMetrics":{"properties":{"jitter_ms":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"001"}},"type":"object"},"PublisherStatsResponse":{"properties":{"by_track":{"items":{"$ref":"#/components/schemas/TrackStatsResponse"},"type":"array","x-stream-index":"003"},"total":{"format":"int32","type":"integer","x-stream-index":"001"},"unique":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["total","unique"],"type":"object"},"PublisherVideoMetrics":{"properties":{"fps_30":{"$ref":"#/components/schemas/ActiveCallsFPSStats","x-stream-index":"002"},"frame_encoding_time_ms":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"003"},"jitter_ms":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"001"}},"type":"object"},"PublishersMetrics":{"properties":{"all":{"$ref":"#/components/schemas/PublisherAllMetrics","x-stream-index":"001"}},"type":"object"},"PushConfig":{"properties":{"offline_only":{"type":"boolean","x-stream-index":"002"},"version":{"enum":["v1","v2","v3"],"type":"string","x-stream-index":"001"}},"required":["version"],"type":"object"},"PushNotificationFields":{"properties":{"apn":{"$ref":"#/components/schemas/APNConfigFields","x-stream-index":"002"},"firebase":{"$ref":"#/components/schemas/FirebaseConfigFields","x-stream-index":"003"},"huawei":{"$ref":"#/components/schemas/HuaweiConfigFields","x-stream-index":"004"},"offline_only":{"type":"boolean","x-stream-index":"001.002"},"providers":{"items":{"$ref":"#/components/schemas/PushProvider"},"type":"array","x-stream-index":"006"},"version":{"type":"string","x-stream-index":"001.001"},"xiaomi":{"$ref":"#/components/schemas/XiaomiConfigFields","x-stream-index":"005"}},"required":["version","offline_only","apn","firebase","huawei","xiaomi"],"type":"object"},"PushNotificationSettingsResponse":{"properties":{"disabled":{"type":"boolean","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"number","x-stream-index":"002"}},"type":"object"},"PushPreferenceInput":{"nullable":true,"properties":{"call_level":{"description":"Set the level of call push notifications for the user. One of all, none, default","enum":["all","none","default"],"type":"string","x-stream-index":"004"},"channel_cid":{"description":"Set the push preferences for a specific channel. If empty it sets the default for the user","type":"string","x-stream-index":"002"},"chat_level":{"description":"Set the level of chat push notifications for the user. One of all, mentions, none, default","enum":["all","mentions","none","default"],"type":"string","x-stream-index":"003"},"disabled_until":{"description":"Disable push notifications till a certain time","format":"date-time","type":"number","x-stream-index":"005"},"remove_disable":{"description":"Remove the disabled until time. (IE stop snoozing notifications)","type":"boolean","x-stream-index":"006"},"user_id":{"description":"The user id for which to set the push preferences. Required when using server side auths, defaults to current user with client side auth.","type":"string","x-stream-index":"001"}},"type":"object"},"PushPreferences":{"properties":{"call_level":{"type":"string","x-stream-index":"002"},"chat_level":{"type":"string","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"number","x-stream-index":"003"}},"type":"object"},"PushProvider":{"nullable":true,"properties":{"apn_auth_key":{"type":"string","x-stream-index":"012"},"apn_auth_type":{"type":"string","x-stream-index":"017"},"apn_development":{"type":"boolean","x-stream-index":"018"},"apn_host":{"type":"string","x-stream-index":"019"},"apn_key_id":{"type":"string","x-stream-index":"013"},"apn_notification_template":{"type":"string","x-stream-index":"020"},"apn_p12_cert":{"type":"string","x-stream-index":"014"},"apn_team_id":{"type":"string","x-stream-index":"015"},"apn_topic":{"type":"string","x-stream-index":"016"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"description":{"maxLength":128,"type":"string","x-stream-index":"007"},"disabled_at":{"format":"date-time","type":"number","x-stream-index":"010"},"disabled_reason":{"maxLength":255,"type":"string","x-stream-index":"011"},"firebase_apn_template":{"type":"string","x-stream-index":"025"},"firebase_credentials":{"type":"string","x-stream-index":"022"},"firebase_data_template":{"type":"string","x-stream-index":"023"},"firebase_host":{"type":"string","x-stream-index":"026"},"firebase_notification_template":{"type":"string","x-stream-index":"024"},"firebase_server_key":{"type":"string","x-stream-index":"021"},"huawei_app_id":{"type":"string","x-stream-index":"027"},"huawei_app_secret":{"type":"string","x-stream-index":"028"},"name":{"maxLength":36,"minLength":1,"type":"string","x-stream-index":"005"},"push_templates":{"items":{"$ref":"#/components/schemas/PushTemplate"},"type":"array","x-stream-index":"031"},"type":{"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"xiaomi_app_secret":{"type":"string","x-stream-index":"030"},"xiaomi_package_name":{"type":"string","x-stream-index":"029"}},"required":["name","type","created_at","updated_at"],"type":"object"},"PushProviderResponse":{"properties":{"apn_auth_key":{"type":"string","x-stream-index":"008"},"apn_auth_type":{"type":"string","x-stream-index":"013"},"apn_development":{"type":"boolean","x-stream-index":"014"},"apn_host":{"type":"string","x-stream-index":"015"},"apn_key_id":{"type":"string","x-stream-index":"009"},"apn_p12_cert":{"type":"string","x-stream-index":"010"},"apn_sandbox_certificate":{"type":"boolean","x-stream-index":"016"},"apn_supports_remote_notifications":{"type":"boolean","x-stream-index":"018"},"apn_supports_voip_notifications":{"type":"boolean","x-stream-index":"017"},"apn_team_id":{"type":"string","x-stream-index":"011"},"apn_topic":{"type":"string","x-stream-index":"012"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"description":{"type":"string","x-stream-index":"003"},"disabled_at":{"format":"date-time","type":"number","x-stream-index":"006"},"disabled_reason":{"type":"string","x-stream-index":"007"},"firebase_apn_template":{"type":"string","x-stream-index":"023"},"firebase_credentials":{"type":"string","x-stream-index":"020"},"firebase_data_template":{"type":"string","x-stream-index":"021"},"firebase_host":{"type":"string","x-stream-index":"024"},"firebase_notification_template":{"type":"string","x-stream-index":"022"},"firebase_server_key":{"type":"string","x-stream-index":"019"},"huawei_app_id":{"type":"string","x-stream-index":"025"},"huawei_app_secret":{"type":"string","x-stream-index":"026"},"name":{"type":"string","x-stream-index":"001"},"type":{"type":"string","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"005"},"xiaomi_app_secret":{"type":"string","x-stream-index":"028"},"xiaomi_package_name":{"type":"string","x-stream-index":"027"}},"required":["name","type","created_at","updated_at"],"type":"object"},"PushTemplate":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"enable_push":{"type":"boolean","x-stream-index":"003"},"event_type":{"enum":["message.new","message.updated","reaction.new","notification.reminder_due"],"type":"string","x-stream-index":"005"},"template":{"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"008"}},"required":["enable_push","event_type","created_at","updated_at"],"type":"object"},"Quality":{"properties":{"bitdepth":{"format":"int32","type":"integer","x-stream-index":"007"},"framerate":{"format":"int32","type":"integer","x-stream-index":"008"},"height":{"format":"int32","type":"integer","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"004"},"video_bitrate":{"format":"int32","type":"integer","x-stream-index":"009"},"width":{"format":"int32","type":"integer","x-stream-index":"005"}},"type":"object"},"QualityScoreReport":{"properties":{"histogram":{"items":{"$ref":"#/components/schemas/ReportByHistogramBucket"},"type":"array","x-stream-index":"001"}},"required":["histogram"],"type":"object"},"QualityScoreReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateQualityScoreReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"QueryAggregateCallStatsRequest":{"nullable":true,"properties":{"from":{"type":"string","x-stream-index":"002"},"report_types":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"to":{"type":"string","x-stream-index":"003"}},"type":"object"},"QueryAggregateCallStatsResponse":{"description":"Basic response information","nullable":true,"properties":{"call_duration_report":{"$ref":"#/components/schemas/CallDurationReportResponse","x-stream-index":"002"},"call_participant_count_report":{"$ref":"#/components/schemas/CallParticipantCountReportResponse","x-stream-index":"004"},"calls_per_day_report":{"$ref":"#/components/schemas/CallsPerDayReportResponse","x-stream-index":"003"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"network_metrics_report":{"$ref":"#/components/schemas/NetworkMetricsReportResponse","x-stream-index":"008"},"quality_score_report":{"$ref":"#/components/schemas/QualityScoreReportResponse","x-stream-index":"005"},"sdk_usage_report":{"$ref":"#/components/schemas/SDKUsageReportResponse","x-stream-index":"006"},"user_feedback_report":{"$ref":"#/components/schemas/UserFeedbackReportResponse","x-stream-index":"007"}},"required":["duration"],"title":"Response","type":"object"},"QueryBannedUsersPayload":{"properties":{"exclude_expired_bans":{"description":"Whether to exclude expired bans or not","title":"Exclude expired bans","type":"boolean","x-stream-index":"004"},"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"description":"Number of records to return","format":"int32","maximum":300,"minimum":0,"title":"Limit","type":"integer","x-stream-index":"003.003"},"offset":{"description":"Number of records to offset","format":"int32","maximum":10000,"title":"Offset","type":"integer","x-stream-index":"003.004"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":1,"title":"Sort","type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"005.002"},"user_id":{"type":"string","x-stream-index":"005.001"}},"required":["filter_conditions"],"type":"object"},"QueryBannedUsersResponse":{"nullable":true,"properties":{"bans":{"description":"List of found bans","items":{"$ref":"#/components/schemas/BanResponse"},"title":"BanResponse","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["bans","duration"],"type":"object"},"QueryCallMembersRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"002"},"id":{"maxLength":64,"type":"string","x-stream-index":"001.002"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"004.001"},"next":{"type":"string","x-stream-index":"004.002"},"prev":{"type":"string","x-stream-index":"004.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":1,"type":"array","x-stream-index":"003"},"type":{"maxLength":64,"type":"string","x-stream-index":"001.001"}},"required":["type","id"],"type":"object"},"QueryCallMembersResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["members","duration"],"title":"Response","type":"object"},"QueryCallParticipantsRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"003"}},"type":"object"},"QueryCallParticipantsResponse":{"nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001.001"},"duration":{"type":"string","x-stream-index":"004.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001.002"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"001.004"},"participants":{"description":"List of call participants","items":{"$ref":"#/components/schemas/CallParticipantResponse"},"title":"[]CallParticipantResponse","type":"array","x-stream-index":"002"},"total_participants":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["call","members","own_capabilities","blocked_users","participants","total_participants","duration"],"type":"object"},"QueryCallStatsRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"004.001"},"next":{"type":"string","x-stream-index":"004.002"},"prev":{"type":"string","x-stream-index":"004.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":2,"type":"array","x-stream-index":"002"}},"type":"object"},"QueryCallStatsResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"next":{"type":"string","x-stream-index":"003.001"},"prev":{"type":"string","x-stream-index":"003.002"},"reports":{"items":{"$ref":"#/components/schemas/CallStatsReportSummaryResponse"},"type":"array","x-stream-index":"001"}},"required":["reports","duration"],"title":"Response","type":"object"},"QueryCallsRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"title":"Filters","type":"object","x-stream-index":"003"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"006.001"},"next":{"type":"string","x-stream-index":"006.002"},"prev":{"type":"string","x-stream-index":"006.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":2,"title":"Sort","type":"array","x-stream-index":"004"}},"title":"QueryCallsRequest","type":"object"},"QueryCallsResponse":{"nullable":true,"properties":{"calls":{"items":{"$ref":"#/components/schemas/CallStateResponseFields"},"title":"Calls","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["calls","duration"],"title":"QueryCallsResponse","type":"object"},"QueryCampaignsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"004.001"},"next":{"type":"string","x-stream-index":"004.002"},"prev":{"type":"string","x-stream-index":"004.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"type":"array","x-stream-index":"002"},"user_limit":{"format":"int32","maximum":1000,"minimum":0,"type":"integer","x-stream-index":"003"}},"type":"object"},"QueryCampaignsResponse":{"description":"Basic response information","nullable":true,"properties":{"campaigns":{"items":{"$ref":"#/components/schemas/CampaignResponse"},"type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["campaigns","duration"],"title":"Response","type":"object"},"QueryChannelsRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"description":"Number of channels to limit","format":"int32","title":"Limit","type":"integer","x-stream-index":"008"},"member_limit":{"description":"Number of members to limit","format":"int32","maximum":100,"minimum":0,"title":"Member limit","type":"integer","x-stream-index":"007"},"message_limit":{"description":"Number of messages to limit","format":"int32","minimum":0,"title":"Message limit","type":"integer","x-stream-index":"006"},"offset":{"description":"Channel pagination offset","format":"int32","title":"Offset","type":"integer","x-stream-index":"009"},"sort":{"description":"List of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"002"},"state":{"description":"Whether to update channel state or not","title":"State","type":"boolean","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"010.002"},"user_id":{"type":"string","x-stream-index":"010.001"}},"title":"Query Channels Request","type":"object","x-stream-docs-page-id":"query_channels"},"QueryChannelsResponse":{"nullable":true,"properties":{"channels":{"description":"List of channels","items":{"$ref":"#/components/schemas/ChannelStateResponseFields"},"title":"Channels","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["channels","duration"],"title":"Channels list","type":"object"},"QueryDraftsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","maximum":3,"title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"type":"object"},"QueryDraftsResponse":{"nullable":true,"properties":{"drafts":{"description":"Drafts","items":{"$ref":"#/components/schemas/DraftResponse"},"title":"DraftsResponseList","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["drafts","duration"],"type":"object"},"QueryFeedModerationTemplate":{"properties":{"config":{"$ref":"#/components/schemas/FeedsModerationTemplateConfig","description":"Configuration for the moderation template","title":"Config","x-stream-index":"002"},"created_at":{"description":"When the template was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"003"},"name":{"description":"Name of the moderation template","title":"Name","type":"string","x-stream-index":"001"},"updated_at":{"description":"When the template was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"004"}},"required":["name","created_at","updated_at"],"type":"object"},"QueryFeedModerationTemplatesResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"templates":{"description":"List of moderation templates","items":{"$ref":"#/components/schemas/QueryFeedModerationTemplate"},"title":"Templates","type":"array","x-stream-index":"001"}},"required":["templates","duration"],"type":"object"},"QueryMembersPayload":{"description":"Client request","properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"002"},"limit":{"format":"int32","maximum":300,"minimum":0,"type":"integer","x-stream-index":"006.003"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"type":"array","x-stream-index":"003"},"offset":{"format":"int32","maximum":10000,"type":"integer","x-stream-index":"006.004"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":1,"type":"array","x-stream-index":"005"},"type":{"maxLength":64,"type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"007.002"},"user_id":{"type":"string","x-stream-index":"007.001"}},"required":["type","filter_conditions"],"title":"ClientRequest","type":"object"},"QueryMessageFlagsPayload":{"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":300,"minimum":0,"type":"integer","x-stream-index":"003.003"},"offset":{"format":"int32","maximum":10000,"type":"integer","x-stream-index":"003.004"},"show_deleted_messages":{"description":"Whether to include deleted messages in the results","title":"ShowDeletedMessages","type":"boolean","x-stream-index":"002"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"type":"array","x-stream-index":"003.005"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"type":"object"},"QueryMessageFlagsResponse":{"description":"Query message flags response","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"flags":{"description":"The flags that match the query","items":{"$ref":"#/components/schemas/MessageFlagResponse"},"title":"MessageFlagResponseList","type":"array","x-stream-index":"001"}},"required":["flags","duration"],"title":"QueryMessageFlagsResponse","type":"object"},"QueryMessageHistoryRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","maximum":3,"minimum":1,"title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"004.001"},"next":{"type":"string","x-stream-index":"004.002"},"prev":{"type":"string","x-stream-index":"004.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"002"}},"required":["filter"],"type":"object"},"QueryMessageHistoryResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message_history":{"description":"Message history entries","items":{"$ref":"#/components/schemas/MessageHistoryEntryResponse"},"title":"MessageHistoryEntryResponseList","type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["message_history","duration"],"type":"object"},"QueryModerationConfigsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter conditions for moderation configs","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"Sorting parameters for the results","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"type":"object"},"QueryModerationConfigsResponse":{"nullable":true,"properties":{"configs":{"description":"List of moderation configurations","items":{"$ref":"#/components/schemas/ConfigResponse"},"title":"Configs","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["configs","duration"],"type":"object"},"QueryModerationFlagsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParam"},"type":"array","x-stream-index":"002"}},"type":"object"},"QueryModerationFlagsResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"flags":{"items":{"$ref":"#/components/schemas/ModerationFlagResponse"},"type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["flags","duration"],"title":"Response","type":"object"},"QueryModerationLogsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter conditions for moderation logs","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"Sorting parameters for the results","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"type":"object"},"QueryModerationLogsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"003.001"},"logs":{"description":"List of moderation action logs","items":{"$ref":"#/components/schemas/ActionLogResponse"},"title":"Logs","type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["logs","duration"],"type":"object"},"QueryPollVotesRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","title":"Filter","type":"object","x-stream-index":"003"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"004"}},"type":"object"},"QueryPollsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","title":"Filter","type":"object","x-stream-index":"002"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"003"}},"type":"object"},"QueryPollsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"polls":{"description":"Polls data returned by the query","items":{"$ref":"#/components/schemas/PollResponseData"},"title":"PollsResponseData","type":"array","x-stream-index":"001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["polls","duration"],"type":"object"},"QueryReactionsRequest":{"properties":{"filter":{"additionalProperties":{},"type":"object","x-stream-index":"002"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"006.001"},"next":{"type":"string","x-stream-index":"006.002"},"prev":{"type":"string","x-stream-index":"006.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":2,"type":"array","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"type":"object"},"QueryReactionsResponse":{"description":"Basic response information","properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"next":{"type":"string","x-stream-index":"003.001"},"prev":{"type":"string","x-stream-index":"003.002"},"reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"001"}},"required":["reactions","duration"],"title":"Response","type":"object"},"QueryRemindersRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"type":"object"},"QueryRemindersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"reminders":{"description":"MessageReminders data returned by the query","items":{"$ref":"#/components/schemas/ReminderResponseData"},"title":"RemindersResponseData","type":"array","x-stream-index":"001"}},"required":["reminders","duration"],"type":"object"},"QueryReviewQueueRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter conditions for review queue items","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"007.001"},"lock_count":{"description":"Number of items to lock (1-25)","format":"int32","maximum":25,"minimum":1,"title":"Lock Count","type":"integer","x-stream-index":"005"},"lock_duration":{"description":"Duration for which items should be locked","title":"Lock Duration","type":"integer","x-stream-index":"004"},"lock_items":{"description":"Whether to lock items for review (true), unlock items (false), or just fetch (nil)","title":"Lock Items","type":"boolean","x-stream-index":"003"},"next":{"type":"string","x-stream-index":"007.002"},"prev":{"type":"string","x-stream-index":"007.003"},"sort":{"description":"Sorting parameters for the results","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"002"},"stats_only":{"description":"Whether to return only statistics","title":"Stats Only","type":"boolean","x-stream-index":"006"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"008.002"},"user_id":{"type":"string","x-stream-index":"008.001"}},"type":"object"},"QueryReviewQueueResponse":{"nullable":true,"properties":{"action_config":{"additionalProperties":{"items":{"$ref":"#/components/schemas/ModerationActionConfig"},"type":"array"},"description":"Configuration for moderation actions","title":"Action Config","type":"object","x-stream-index":"002"},"duration":{"type":"string","x-stream-index":"005.001"},"items":{"description":"List of review queue items","items":{"$ref":"#/components/schemas/ReviewQueueItemResponse"},"title":"Items","type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"004.001"},"prev":{"type":"string","x-stream-index":"004.002"},"stats":{"additionalProperties":{},"description":"Statistics about the review queue","title":"Stats","type":"object","x-stream-index":"003"}},"required":["items","action_config","stats","duration"],"type":"object"},"QuerySegmentTargetsRequest":{"nullable":true,"properties":{"Filter":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"005"},"Sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"type":"array","writeOnly":true,"x-stream-index":"006"},"limit":{"description":"Limit","format":"int32","maximum":10000,"minimum":0,"title":"int","type":"integer","x-stream-index":"002"},"next":{"description":"Next","title":"string","type":"string","x-stream-index":"003"},"prev":{"description":"Prev","title":"string","type":"string","x-stream-index":"004"}},"type":"object"},"QuerySegmentTargetsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"targets":{"description":"Targets","items":{"$ref":"#/components/schemas/SegmentTargetResponse"},"title":"SegmentTargetResponseList","type":"array","x-stream-index":"001"}},"required":["targets","duration"],"type":"object"},"QuerySegmentsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"002"}},"required":["filter"],"type":"object"},"QuerySegmentsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"segments":{"description":"Segments","items":{"$ref":"#/components/schemas/SegmentResponse"},"title":"SegmentResponses","type":"array","x-stream-index":"001"}},"required":["segments","duration"],"type":"object"},"QueryThreadsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter conditions to apply to threads","title":"Filter","type":"object","x-stream-index":"006"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"008.001"},"member_limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005"},"next":{"type":"string","x-stream-index":"008.002"},"participant_limit":{"description":"Limit the number of participants returned per each thread","format":"int32","maximum":100,"minimum":0,"title":"Participant limit","type":"integer","x-stream-index":"004"},"prev":{"type":"string","x-stream-index":"008.003"},"reply_limit":{"description":"Limit the number of replies returned per each thread","format":"int32","maximum":10,"minimum":0,"title":"Reply limit","type":"integer","x-stream-index":"003"},"sort":{"description":"Sort conditions to apply to threads","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"007"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"010.002"},"user_id":{"type":"string","x-stream-index":"010.001"}},"type":"object"},"QueryThreadsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"threads":{"description":"List of enriched thread states","items":{"$ref":"#/components/schemas/ThreadStateResponse"},"title":"Threads","type":"array","x-stream-index":"001"}},"required":["threads","duration"],"type":"object"},"QueryUserFeedbackRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":2,"type":"array","x-stream-index":"002"}},"type":"object"},"QueryUserFeedbackResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"next":{"type":"string","x-stream-index":"003.001"},"prev":{"type":"string","x-stream-index":"003.002"},"user_feedback":{"items":{"$ref":"#/components/schemas/UserFeedbackResponse"},"type":"array","x-stream-index":"001"}},"required":["user_feedback","duration"],"title":"Response","type":"object"},"QueryUsersPayload":{"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"include_deactivated_users":{"type":"boolean","x-stream-index":"004"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.003"},"offset":{"format":"int32","maximum":1000,"type":"integer","x-stream-index":"005.004"},"presence":{"type":"boolean","x-stream-index":"003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"006.002"},"user_id":{"type":"string","x-stream-index":"006.001"}},"required":["filter_conditions"],"type":"object"},"QueryUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"users":{"description":"Array of users as result of filters applied.","items":{"$ref":"#/components/schemas/FullUserResponse"},"title":"Users","type":"array","x-stream-index":"001"}},"required":["users","duration"],"type":"object"},"RTMPBroadcastRequest":{"description":"RTMPBroadcastRequest is the payload for starting an RTMP broadcast.","properties":{"layout":{"$ref":"#/components/schemas/LayoutSettingsRequest","description":"If provided, will override the call's RTMP settings layout","title":"Layout","x-stream-index":"005"},"name":{"description":"Name identifier for RTMP broadcast, must be unique in call","maxLength":255,"title":"Name","type":"string","x-stream-index":"001"},"quality":{"description":"If provided, will override the call's RTMP settings quality","enum":["360p","480p","720p","1080p","1440p","portrait-360x640","portrait-480x854","portrait-720x1280","portrait-1080x1920","portrait-1440x2560"],"title":"Quality","type":"string","x-stream-index":"004"},"stream_key":{"description":"If provided, will be appended at the end of stream_url","title":"Stream Key","type":"string","x-stream-index":"003"},"stream_url":{"description":"URL for the RTMP server to send the call to","maxLength":255,"title":"Stream URL","type":"string","x-stream-index":"002"}},"required":["name","stream_url"],"title":"RTMPBroadcastRequest","type":"object"},"RTMPEgressConfig":{"properties":{"composite_app_settings":{"$ref":"#/components/schemas/CompositeAppSettings","x-stream-index":"005"},"quality":{"$ref":"#/components/schemas/Quality","x-stream-index":"004"},"rtmp_location":{"type":"string","x-stream-index":"006"}},"type":"object"},"RTMPIngress":{"description":"RTMP input settings","properties":{"address":{"title":"Address","type":"string","x-stream-index":"001"}},"required":["address"],"title":"RTMPIngress","type":"object"},"RTMPLocation":{"properties":{"name":{"type":"string","x-stream-index":"001"},"stream_key":{"type":"string","x-stream-index":"003"},"stream_url":{"type":"string","x-stream-index":"002"}},"required":["name","stream_url","stream_key"],"type":"object"},"RTMPSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"003"},"location":{"$ref":"#/components/schemas/RTMPLocation","x-stream-index":"004"},"quality_name":{"type":"string","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"RTMPSettingsRequest":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettingsRequest","description":"Layout for the composed RTMP stream","title":"LayoutSettings","x-stream-index":"003"},"quality":{"description":"Resolution to set for the RTMP stream","enum":["360p","480p","720p","1080p","1440p","portrait-360x640","portrait-480x854","portrait-720x1280","portrait-1080x1920","portrait-1440x2560"],"title":"Quality","type":"string","x-stream-index":"002"}},"title":"RTMPSettingsRequest","type":"object"},"RTMPSettingsResponse":{"description":"RTMPSettingsResponse is the payload for RTMP settings","properties":{"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettingsResponse","title":"Layout","x-stream-index":"003"},"quality":{"title":"Quality","type":"string","x-stream-index":"002"}},"required":["enabled","quality","layout"],"title":"RTMPSettingsResponse","type":"object"},"Reaction":{"nullable":true,"properties":{"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"message_id":{"type":"string","x-stream-index":"003"},"score":{"format":"int32","type":"integer","x-stream-index":"007"},"type":{"maxLength":30,"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["message_id","type","score","created_at","updated_at","custom"],"type":"object"},"ReactionDeletedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"006.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"002"},"team":{"type":"string","x-stream-index":"005.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"reaction.deleted","type":"string","x-stream-index":"006.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"ReactionDeletedEvent","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"},"ReactionGroupResponse":{"description":"ReactionGroupResponse contains all information about a reaction of the same type.","nullable":true,"properties":{"count":{"description":"Count is the number of reactions of this type.","format":"int32","title":"Count","type":"integer","x-stream-index":"001"},"first_reaction_at":{"description":"FirstReactionAt is the time of the first reaction of this type. This is the same also if all reaction of this type are deleted, because if someone will react again with the same type, will be preserved the sorting.","format":"date-time","title":"FirstReactionAt","type":"number","x-stream-index":"003"},"last_reaction_at":{"description":"LastReactionAt is the time of the last reaction of this type.","format":"date-time","title":"LastReactionAt","type":"number","x-stream-index":"004"},"sum_scores":{"description":"SumScores is the sum of all scores of reactions of this type. Medium allows you to clap articles more than once and shows the sum of all claps from all users. For example, you can send `clap` x5 using `score: 5`.","format":"int32","title":"SumScores","type":"integer","x-stream-index":"002"}},"required":["count","sum_scores","first_reaction_at","last_reaction_at"],"title":"ReactionGroupResponse","type":"object"},"ReactionNewEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"006.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"002"},"team":{"type":"string","x-stream-index":"005.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"reaction.new","type":"string","x-stream-index":"006.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"ReactionNewEvent","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"},"ReactionRequest":{"description":"Represents user reaction to a message","properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"score":{"description":"Reaction score. If not specified reaction has score of 1","format":"int32","title":"Score","type":"integer","x-stream-index":"002"},"type":{"description":"The type of reaction (e.g. 'like', 'laugh', 'wow')","maxLength":30,"title":"Type","type":"string","x-stream-index":"001"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"006.002"},"user_id":{"type":"string","x-stream-index":"006.001"}},"required":["type"],"title":"Reaction","type":"object","x-stream-docs-page-id":"send_reaction"},"ReactionResponse":{"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"006"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"008"},"message_id":{"description":"Message ID","title":"Message ID","type":"string","x-stream-index":"001"},"score":{"description":"Score of the reaction","format":"int32","title":"Score","type":"integer","x-stream-index":"005"},"type":{"description":"Type of reaction","title":"Type","type":"string","x-stream-index":"004"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"007"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User","title":"UserResponse","x-stream-index":"003"},"user_id":{"description":"User ID","title":"User ID","type":"string","x-stream-index":"002"}},"required":["message_id","user_id","user","type","score","created_at","updated_at","custom"],"type":"object"},"ReactionUpdatedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"006.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"002"},"team":{"type":"string","x-stream-index":"005.001"},"type":{"default":"reaction.updated","type":"string","x-stream-index":"006.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["message","reaction","cid","channel_id","channel_type","type","created_at"],"title":"ReactionUpdatedEvent","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"},"ReactivateUserRequest":{"nullable":true,"properties":{"created_by_id":{"description":"ID of the user who's reactivating the user","title":"Created by ID","type":"string","x-stream-index":"004"},"name":{"description":"Set this field to put new name for the user","title":"Name","type":"string","x-stream-index":"003"},"restore_messages":{"description":"Restore previously deleted messages","title":"Restore messages","type":"boolean","x-stream-index":"002"}},"type":"object"},"ReactivateUserResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.002.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Deactivated user object","title":"User","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"ReactivateUsersRequest":{"description":"Reactivate users in batches","nullable":true,"properties":{"created_by_id":{"description":"ID of the user who's reactivating the users","title":"Created by ID","type":"string","x-stream-index":"003"},"restore_channels":{"type":"boolean","x-stream-index":"004"},"restore_messages":{"description":"Restore previously deleted messages","title":"Restore messages","type":"boolean","x-stream-index":"002"},"user_ids":{"description":"User IDs to reactivate","items":{"type":"string"},"maximum":100,"minimum":1,"title":"User IDs","type":"array","x-stream-index":"001"}},"required":["user_ids"],"title":"ReactivateUsersRequest","type":"object"},"ReactivateUsersResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.002.001"},"task_id":{"type":"string","x-stream-index":"001.001"}},"required":["task_id","duration"],"title":"Response","type":"object"},"ReadReceipts":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"ReadReceiptsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"ReadStateResponse":{"properties":{"last_read":{"format":"date-time","type":"number","x-stream-index":"002"},"last_read_message_id":{"type":"string","x-stream-index":"004"},"unread_messages":{"format":"int32","type":"integer","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"}},"required":["user","last_read","unread_messages"],"type":"object"},"RecordSettings":{"properties":{"audio_only":{"type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"004"},"mode":{"type":"string","x-stream-index":"002"},"quality":{"type":"string","x-stream-index":"003"}},"required":["mode"],"type":"object"},"RecordSettingsRequest":{"properties":{"audio_only":{"type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettingsRequest","title":"LayoutSettings","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"title":"Mode","type":"string","x-stream-index":"002"},"quality":{"enum":["360p","480p","720p","1080p","1440p","portrait-360x640","portrait-480x854","portrait-720x1280","portrait-1080x1920","portrait-1440x2560"],"type":"string","x-stream-index":"003"}},"required":["mode"],"title":"RecordSettingsRequest","type":"object"},"RecordSettingsResponse":{"description":"RecordSettings is the payload for recording settings","properties":{"audio_only":{"title":"Audio Only","type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettingsResponse","title":"Layout","x-stream-index":"004"},"mode":{"title":"Mode","type":"string","x-stream-index":"002"},"quality":{"title":"Quality","type":"string","x-stream-index":"003"}},"required":["audio_only","mode","quality","layout"],"title":"RecordSettingsResponse","type":"object"},"RecordingEgressConfig":{"properties":{"audio_only":{"type":"boolean","x-stream-index":"006"},"composite_app_settings":{"$ref":"#/components/schemas/CompositeAppSettings","x-stream-index":"005"},"external_storage":{"$ref":"#/components/schemas/ExternalStorage","x-stream-index":"008"},"quality":{"$ref":"#/components/schemas/Quality","x-stream-index":"004"},"storage_name":{"type":"string","x-stream-index":"007"},"video_orientation_hint":{"$ref":"#/components/schemas/VideoOrientation","x-stream-index":"009"}},"type":"object"},"ReminderCreatedEvent":{"description":"Emitted when a reminder is created.","nullable":true,"properties":{"cid":{"description":"The CID of the Channel for which the reminder was created","title":"Channel CID","type":"string","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.007"},"message_id":{"description":"The ID of the message for which the reminder was created","title":"Message ID","type":"string","x-stream-index":"001.002"},"parent_id":{"description":"The ID of the parent message, if the reminder is for a thread message","title":"Parent ID","type":"string","x-stream-index":"001.005"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","description":"The reminder object which was created","title":"MessageReminder","x-stream-index":"001.006"},"type":{"default":"reminder.created","description":"The type of event: \"reminder.created\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.002"},"user_id":{"description":"The ID of the user for whom the reminder was created","title":"User ID","type":"string","x-stream-index":"001.003"}},"required":["type","created_at","custom","message_id","user_id","cid"],"title":"ReminderCreatedEvent","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"},"ReminderDeletedEvent":{"description":"Emitted when a reminder is deleted.","nullable":true,"properties":{"cid":{"description":"The CID of the Channel for which the reminder was created","title":"Channel CID","type":"string","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.007"},"message_id":{"description":"The ID of the message for which the reminder was created","title":"Message ID","type":"string","x-stream-index":"001.002"},"parent_id":{"description":"The ID of the parent message, if the reminder is for a thread message","title":"Parent ID","type":"string","x-stream-index":"001.005"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","description":"The reminder object which was created","title":"MessageReminder","x-stream-index":"001.006"},"type":{"default":"reminder.deleted","description":"The type of event: \"reminder.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.002"},"user_id":{"description":"The ID of the user for whom the reminder was created","title":"User ID","type":"string","x-stream-index":"001.003"}},"required":["type","created_at","custom","message_id","user_id","cid"],"title":"ReminderDeletedEvent","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"},"ReminderNotificationEvent":{"description":"Emitted when a reminder becomes due, triggering a notification for the user.","nullable":true,"properties":{"cid":{"description":"The CID of the Channel for which the reminder was created","title":"Channel CID","type":"string","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.007"},"message_id":{"description":"The ID of the message for which the reminder was created","title":"Message ID","type":"string","x-stream-index":"001.002"},"parent_id":{"type":"string","x-stream-index":"001.005"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","description":"The reminder object which was created","title":"MessageReminder","x-stream-index":"001.006"},"type":{"default":"notification.reminder_due","description":"The type of event: \"notification.reminder_due\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.002"},"user_id":{"description":"The ID of the user for whom the reminder was created","title":"User ID","type":"string","x-stream-index":"001.003"}},"required":["type","created_at","custom","message_id","user_id","cid"],"title":"ReminderNotificationEvent","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"},"ReminderResponseData":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003"},"channel_cid":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"005"},"message_id":{"type":"string","x-stream-index":"004"},"remind_at":{"format":"date-time","type":"number","x-stream-index":"001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007"},"user_id":{"type":"string","x-stream-index":"006"}},"required":["channel_cid","message_id","user_id","created_at","updated_at"],"type":"object"},"ReminderUpdatedEvent":{"description":"Emitted when a reminder is updated.","nullable":true,"properties":{"cid":{"description":"The CID of the Channel for which the reminder was created","title":"Channel CID","type":"string","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.007"},"message_id":{"description":"The ID of the message for which the reminder was created","title":"Message ID","type":"string","x-stream-index":"001.002"},"parent_id":{"description":"The ID of the parent message, if the reminder is for a thread message","title":"Parent ID","type":"string","x-stream-index":"001.005"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","description":"The reminder object which was created","title":"MessageReminder","x-stream-index":"001.006"},"type":{"default":"reminder.updated","description":"The type of event: \"reminder.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.002"},"user_id":{"description":"The ID of the user for whom the reminder was created","title":"User ID","type":"string","x-stream-index":"001.003"}},"required":["type","created_at","custom","message_id","user_id","cid"],"title":"ReminderUpdatedEvent","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"},"ReportByHistogramBucket":{"properties":{"category":{"type":"string","x-stream-index":"001"},"count":{"format":"int32","type":"integer","x-stream-index":"005"},"lower_bound":{"$ref":"#/components/schemas/Bound","x-stream-index":"002"},"sum":{"format":"float","type":"number","x-stream-index":"004"},"upper_bound":{"$ref":"#/components/schemas/Bound","x-stream-index":"003"}},"required":["category","sum","count"],"type":"object"},"ReportResponse":{"properties":{"call":{"$ref":"#/components/schemas/CallReportResponse","x-stream-index":"003"},"participants":{"$ref":"#/components/schemas/ParticipantReportResponse","x-stream-index":"001"},"user_ratings":{"$ref":"#/components/schemas/UserRatingReportResponse","x-stream-index":"002"}},"required":["participants","user_ratings","call"],"type":"object"},"Response":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001"}},"required":["duration"],"title":"Response","type":"object"},"RestoreActionRequest":{"type":"object"},"RestoreUsersRequest":{"nullable":true,"properties":{"user_ids":{"items":{"type":"string"},"maximum":100,"minimum":1,"type":"array","x-stream-index":"001"}},"required":["user_ids"],"type":"object"},"ReviewQueueItem":{"properties":{"actions":{"items":{"$ref":"#/components/schemas/ActionLog"},"type":"array","x-stream-index":"035"},"activity":{"$ref":"#/components/schemas/EnrichedActivity","x-stream-index":"028"},"ai_text_severity":{"type":"string","x-stream-index":"021"},"archived_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"043"},"assigned_to":{"$ref":"#/components/schemas/User","x-stream-index":"032"},"bans":{"items":{"$ref":"#/components/schemas/Ban"},"type":"array","x-stream-index":"033"},"bounce_count":{"format":"int32","type":"integer","x-stream-index":"025"},"call":{"$ref":"#/components/schemas/Call","x-stream-index":"031"},"completed_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"018"},"config_key":{"type":"string","x-stream-index":"009"},"content_changed":{"type":"boolean","x-stream-index":"036"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"entity_creator":{"$ref":"#/components/schemas/EntityCreator","x-stream-index":"030"},"entity_id":{"type":"string","x-stream-index":"007"},"entity_type":{"type":"string","x-stream-index":"006"},"feeds_v2_activity":{"$ref":"#/components/schemas/EnrichedActivity","x-stream-index":"041"},"feeds_v2_reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"042"},"flag_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"045"},"flag_types":{"items":{"type":"string"},"type":"array","x-stream-index":"044"},"flags":{"items":{"$ref":"#/components/schemas/Flag"},"type":"array","x-stream-index":"034"},"flags_count":{"format":"int32","type":"integer","x-stream-index":"026"},"has_image":{"type":"boolean","x-stream-index":"012"},"has_text":{"type":"boolean","x-stream-index":"014"},"has_video":{"type":"boolean","x-stream-index":"013"},"id":{"type":"string","x-stream-index":"003"},"languages":{"items":{"type":"string"},"type":"array","x-stream-index":"019"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"027"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"010"},"moderation_payload_hash":{"type":"string","x-stream-index":"011"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"029"},"recommended_action":{"type":"string","x-stream-index":"017"},"reporter_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"046"},"reviewed_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"022"},"reviewed_by":{"type":"string","x-stream-index":"023"},"severity":{"format":"int32","type":"integer","x-stream-index":"020"},"status":{"type":"string","x-stream-index":"016"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"015"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"005"}},"required":["id","created_at","updated_at","entity_type","entity_id","config_key","moderation_payload_hash","has_image","has_video","has_text","teams","status","recommended_action","completed_at","languages","severity","ai_text_severity","reviewed_at","reviewed_by","bounce_count","flags_count","bans","flags","actions","content_changed","archived_at","flag_types","flag_labels","reporter_ids"],"type":"object"},"ReviewQueueItemNewEvent":{"description":"This event is sent when a new moderation review queue item is created","nullable":true,"properties":{"action":{"$ref":"#/components/schemas/ActionLogResponse","description":"The action log if any action was taken","title":"Action","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"flags":{"description":"The flags associated with this review queue item","items":{"$ref":"#/components/schemas/FlagResponse"},"title":"Flags","type":"array","x-stream-index":"003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"The review queue item that was created","title":"ReviewQueueItem","x-stream-index":"002"},"type":{"default":"review_queue_item.new","type":"string","x-stream-index":"001.002"}},"required":["type","created_at","custom"],"title":"ReviewQueueItemNewEvent","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"},"ReviewQueueItemResponse":{"properties":{"actions":{"description":"Moderation actions taken","items":{"$ref":"#/components/schemas/ActionLogResponse"},"title":"Actions","type":"array","x-stream-index":"024"},"activity":{"$ref":"#/components/schemas/EnrichedActivity","x-stream-index":"016"},"ai_text_severity":{"description":"AI-determined text severity","title":"AI Text Severity","type":"string","x-stream-index":"014"},"assigned_to":{"$ref":"#/components/schemas/UserResponse","description":"Moderator assigned to review this item","title":"Assigned To","x-stream-index":"021"},"bans":{"description":"Associated ban records","items":{"$ref":"#/components/schemas/Ban"},"title":"Bans","type":"array","x-stream-index":"022"},"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"018"},"completed_at":{"description":"When the review was completed","format":"date-time","title":"Completed At","type":"number","x-stream-index":"009"},"config_key":{"type":"string","x-stream-index":"028"},"created_at":{"description":"When the item was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"002"},"entity_creator":{"$ref":"#/components/schemas/EntityCreatorResponse","description":"Details about who created the entity","title":"Entity Creator","x-stream-index":"019"},"entity_creator_id":{"description":"ID of who created the entity","title":"Entity Creator ID","type":"string","x-stream-index":"020"},"entity_id":{"description":"ID of the entity being reviewed","title":"Entity ID","type":"string","x-stream-index":"005"},"entity_type":{"description":"Type of entity being reviewed","title":"Entity Type","type":"string","x-stream-index":"004"},"feeds_v2_activity":{"$ref":"#/components/schemas/EnrichedActivity","description":"Associated feed activity","title":"Feeds V2 Activity","x-stream-index":"025"},"feeds_v2_reaction":{"$ref":"#/components/schemas/Reaction","description":"Associated feed reaction","title":"Feeds V2 Reaction","x-stream-index":"026"},"flags":{"description":"Associated flag records","items":{"$ref":"#/components/schemas/FlagResponse"},"title":"Flags","type":"array","x-stream-index":"023"},"flags_count":{"format":"int32","type":"integer","x-stream-index":"029"},"id":{"description":"Unique identifier of the review queue item","title":"ID","type":"string","x-stream-index":"001"},"languages":{"description":"Detected languages in the content","items":{"type":"string"},"title":"Languages","type":"array","x-stream-index":"012"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Associated message details","title":"Message","x-stream-index":"015"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content being moderated","title":"Moderation Payload","x-stream-index":"006"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"017"},"recommended_action":{"description":"Suggested moderation action","title":"Recommended Action","type":"string","x-stream-index":"008"},"reviewed_at":{"description":"When the item was reviewed","format":"date-time","title":"Reviewed At","type":"number","x-stream-index":"010"},"reviewed_by":{"description":"ID of the moderator who reviewed the item","title":"Reviewed By","type":"string","x-stream-index":"011"},"severity":{"description":"Severity level of the content","format":"int32","title":"Severity","type":"integer","x-stream-index":"013"},"status":{"description":"Current status of the review","title":"Status","type":"string","x-stream-index":"007"},"teams":{"description":"Teams associated with this item","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"027"},"updated_at":{"description":"When the item was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"003"}},"required":["id","created_at","updated_at","entity_type","entity_id","status","recommended_action","reviewed_by","languages","severity","ai_text_severity","bans","flags","actions","flags_count"],"type":"object"},"ReviewQueueItemUpdatedEvent":{"description":"This event is sent when a moderation review queue item is updated","nullable":true,"properties":{"action":{"$ref":"#/components/schemas/ActionLogResponse","description":"The action log if any action was taken","title":"Action","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"flags":{"description":"The flags associated with this review queue item","items":{"$ref":"#/components/schemas/FlagResponse"},"title":"Flags","type":"array","x-stream-index":"003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"The review queue item that was updated","title":"ReviewQueueItem","x-stream-index":"002"},"type":{"default":"review_queue_item.updated","type":"string","x-stream-index":"001.002"}},"required":["type","created_at","custom"],"title":"ReviewQueueItemUpdatedEvent","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"},"RingSettings":{"properties":{"auto_cancel_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_timeout_ms","missed_call_timeout_ms"],"type":"object"},"RingSettingsRequest":{"properties":{"auto_cancel_timeout_ms":{"description":"When none of the callees accept a ring call in this time a rejection will be sent by the caller with reason 'timeout' by the SDKs","format":"int32","maximum":180000,"minimum":5000,"title":"AutoCancelTimeoutMs","type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"description":"When a callee is online but doesn't answer a ring call in this time a rejection will be sent with reason 'timeout' by the SDKs","format":"int32","maximum":180000,"minimum":5000,"title":"IncomingCallTimeoutMs","type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"description":"When a callee doesn't accept or reject a ring call in this time a missed call event will be sent","format":"int32","maximum":180000,"minimum":5000,"title":"MissedCallTimeoutMs","type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_timeout_ms"],"title":"RingSettingsRequest","type":"object"},"RingSettingsResponse":{"properties":{"auto_cancel_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_timeout_ms","missed_call_timeout_ms"],"type":"object"},"Role":{"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"004"},"custom":{"description":"Whether this is a custom role or built-in","title":"Custom","type":"boolean","x-stream-index":"002"},"name":{"description":"Unique role name","title":"Name","type":"string","x-stream-index":"001"},"scopes":{"description":"List of scopes where this role is currently present. `.app` means that role is present in app-level grants","items":{"type":"string"},"title":"Scopes","type":"array","x-stream-index":"003"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"005"}},"required":["name","custom","scopes","created_at","updated_at"],"type":"object"},"RuleBuilderAction":{"properties":{"ban_options":{"$ref":"#/components/schemas/BanOptions","x-stream-index":"002"},"flag_content_options":{"$ref":"#/components/schemas/FlagContentOptions","x-stream-index":"004"},"flag_user_options":{"$ref":"#/components/schemas/FlagUserOptions","x-stream-index":"003"},"remove_content_options":{"$ref":"#/components/schemas/BlockContentOptions","x-stream-index":"005"},"type":{"type":"string","x-stream-index":"001"}},"required":["type"],"type":"object"},"RuleBuilderCondition":{"properties":{"confidence":{"format":"float","type":"number","x-stream-index":"002"},"content_count_rule_params":{"$ref":"#/components/schemas/ContentCountRuleParameters","x-stream-index":"007"},"image_content_params":{"$ref":"#/components/schemas/ImageContentParameters","x-stream-index":"009"},"image_rule_params":{"$ref":"#/components/schemas/ImageRuleParameters","x-stream-index":"004"},"text_content_params":{"$ref":"#/components/schemas/TextContentParameters","x-stream-index":"008"},"text_rule_params":{"$ref":"#/components/schemas/TextRuleParameters","x-stream-index":"003"},"type":{"type":"string","x-stream-index":"001"},"user_created_within_params":{"$ref":"#/components/schemas/UserCreatedWithinParameters","x-stream-index":"011"},"user_rule_params":{"$ref":"#/components/schemas/UserRuleParameters","x-stream-index":"006"},"video_content_params":{"$ref":"#/components/schemas/VideoContentParameters","x-stream-index":"010"},"video_rule_params":{"$ref":"#/components/schemas/VideoRuleParameters","x-stream-index":"005"}},"required":["type"],"type":"object"},"RuleBuilderConditionGroup":{"properties":{"conditions":{"items":{"$ref":"#/components/schemas/RuleBuilderCondition"},"type":"array","x-stream-index":"002"},"logic":{"type":"string","x-stream-index":"001"}},"required":["logic","conditions"],"type":"object"},"RuleBuilderConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"rules":{"items":{"$ref":"#/components/schemas/RuleBuilderRule"},"type":"array","x-stream-index":"002"}},"required":["rules"],"type":"object"},"RuleBuilderRule":{"properties":{"action":{"$ref":"#/components/schemas/RuleBuilderAction","x-stream-index":"007"},"conditions":{"items":{"$ref":"#/components/schemas/RuleBuilderCondition"},"type":"array","x-stream-index":"004"},"cooldown_period":{"type":"string","x-stream-index":"009"},"enabled":{"type":"boolean","x-stream-index":"008"},"groups":{"items":{"$ref":"#/components/schemas/RuleBuilderConditionGroup"},"type":"array","x-stream-index":"006"},"id":{"type":"string","x-stream-index":"001"},"logic":{"type":"string","x-stream-index":"005"},"name":{"type":"string","x-stream-index":"002"},"rule_type":{"type":"string","x-stream-index":"003"}},"required":["id","name","rule_type","action","enabled"],"type":"object"},"S3Request":{"description":"Config for creating Amazon S3 storage.","properties":{"s3_api_key":{"description":"The AWS API key. To use Amazon S3 as your storage provider, you have two authentication options: IAM role or API key. If you do not specify the `s3_api_key` parameter, Stream will use IAM role authentication. In that case make sure to have the correct IAM role configured for your application.","title":"S3ApiKey","type":"string","x-stream-index":"002"},"s3_custom_endpoint_url":{"description":"The custom endpoint for S3. If you want to use a custom endpoint, you must also provide the `s3_api_key` and `s3_secret` parameters.","title":"S3CustomEndpointURL","type":"string","x-stream-index":"004"},"s3_region":{"description":"The AWS region where the bucket is hosted","title":"S3Region","type":"string","x-stream-index":"001"},"s3_secret":{"description":"The AWS API Secret","title":"S3Secret","type":"string","x-stream-index":"003"}},"required":["s3_region"],"title":"S3Request","type":"object"},"SDKUsageReport":{"properties":{"per_sdk_usage":{"additionalProperties":{"$ref":"#/components/schemas/PerSDKUsageReport"},"type":"object","x-stream-index":"001"}},"required":["per_sdk_usage"],"type":"object"},"SDKUsageReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateSDKUsageReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"SFUIDLastSeen":{"properties":{"id":{"type":"string","x-stream-index":"001.001"},"last_seen":{"format":"date-time","type":"number","x-stream-index":"002"},"process_start_time":{"format":"int64","type":"integer","x-stream-index":"001.002"}},"required":["id","process_start_time","last_seen"],"type":"object"},"STTEgressConfig":{"properties":{"closed_captions_enabled":{"type":"boolean","x-stream-index":"005"},"external_storage":{"$ref":"#/components/schemas/ExternalStorage","x-stream-index":"011"},"language":{"type":"string","x-stream-index":"008"},"storage_name":{"type":"string","x-stream-index":"010"},"translation_languages":{"items":{"type":"string"},"type":"array","x-stream-index":"009"},"translations_enabled":{"type":"boolean","x-stream-index":"006"},"upload_transcriptions":{"type":"boolean","x-stream-index":"004"},"whisper_server_base_url":{"type":"string","x-stream-index":"007"}},"type":"object"},"ScreensharingSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled"],"type":"object"},"ScreensharingSettingsRequest":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"type":"object"},"ScreensharingSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled"],"type":"object"},"SearchPayload":{"properties":{"filter_conditions":{"additionalProperties":{},"description":"Channel filter conditions","maximum":100,"minimum":1,"title":"Channel filter","type":"object","x-stream-docs-page-id":"query_channels","x-stream-index":"002"},"limit":{"description":"Number of messages to return","format":"int32","title":"Limit","type":"integer","x-stream-index":"005"},"message_filter_conditions":{"additionalProperties":{},"description":"Message filter conditions","title":"Message filter","type":"object","x-stream-index":"003"},"message_options":{"$ref":"#/components/schemas/MessageOptions","x-stream-index":"004"},"next":{"description":"Pagination parameter. Cannot be used with non-zero offset.","title":"Next","type":"string","x-stream-index":"008"},"offset":{"description":"Pagination offset. Cannot be used with sort or next.","format":"int32","title":"Offset","type":"integer","x-stream-index":"006"},"query":{"description":"Search phrase","title":"Query","type":"string","x-stream-index":"001"},"sort":{"description":"Sort parameters. Cannot be used with non-zero offset","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"007"}},"required":["filter_conditions"],"type":"object"},"SearchResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"005.001"},"next":{"description":"Value to pass to the next search query in order to paginate","title":"Next","type":"string","x-stream-index":"003"},"previous":{"description":"Value that points to the previous page. Pass as the next value in a search query to paginate backwards","title":"Previous","type":"string","x-stream-index":"004"},"results":{"description":"Search results","items":{"$ref":"#/components/schemas/SearchResult"},"title":"Results","type":"array","x-stream-index":"001"},"results_warning":{"$ref":"#/components/schemas/SearchWarning","description":"Warning about the search results","title":"Results Warning","x-stream-index":"002"}},"required":["results","duration"],"type":"object"},"SearchResult":{"properties":{"message":{"$ref":"#/components/schemas/SearchResultMessage","description":"Found message","title":"Message","x-stream-index":"001"}},"type":"object"},"SearchResultMessage":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"001.008"},"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel object","title":"Channel","x-stream-index":"002"},"cid":{"type":"string","x-stream-index":"001.022"},"command":{"type":"string","x-stream-index":"001.004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.023"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.026"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.025"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"001.018"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001.041"},"html":{"type":"string","x-stream-index":"001.005"},"i18n":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.030"},"id":{"type":"string","x-stream-index":"001.001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"001.028"},"latest_reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"001.009"},"mentioned_users":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"001.029"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"001.036"},"mml":{"type":"string","x-stream-index":"001.003"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"001.039"},"own_reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"001.010"},"parent_id":{"type":"string","x-stream-index":"001.015"},"pin_expires":{"format":"date-time","type":"number","x-stream-index":"001.035"},"pinned":{"type":"boolean","x-stream-index":"001.032"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"001.033"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001.034"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001.038"},"poll_id":{"type":"string","x-stream-index":"001.037"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001.020"},"quoted_message_id":{"type":"string","x-stream-index":"001.019"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001.011"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"001.014"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001.012"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"001.042"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"001.017"},"restricted_visibility":{"items":{"type":"string"},"type":"array","x-stream-index":"001.040"},"shadowed":{"type":"boolean","x-stream-index":"001.027"},"shared_location":{"$ref":"#/components/schemas/SharedLocationResponseData","x-stream-index":"001.043"},"show_in_channel":{"type":"boolean","x-stream-index":"001.016"},"silent":{"type":"boolean","x-stream-index":"001.031"},"text":{"type":"string","x-stream-index":"001.002"},"thread_participants":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"001.021"},"type":{"type":"string","x-stream-index":"001.006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.024"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001.007"}},"required":["id","text","html","type","user","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned","restricted_visibility"],"type":"object"},"SearchWarning":{"properties":{"channel_search_cids":{"description":"Channel CIDs for the searched channels","items":{"type":"string"},"title":"Channel Search CIDs","type":"array","x-stream-index":"004"},"channel_search_count":{"description":"Number of channels searched","format":"int32","title":"Channel Search Count","type":"integer","x-stream-index":"003"},"warning_code":{"description":"Code corresponding to the warning","format":"int32","title":"Warning Code","type":"integer","x-stream-index":"002"},"warning_description":{"description":"Description of the warning","title":"Warning Description","type":"string","x-stream-index":"001"}},"required":["warning_description","warning_code"],"type":"object"},"Segment":{"nullable":true,"properties":{"all_sender_channels":{"type":"boolean","x-stream-index":"007"},"all_users":{"type":"boolean","x-stream-index":"006"},"created_at":{"format":"date-time","type":"number","x-stream-index":"010"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"012"},"description":{"type":"string","x-stream-index":"004"},"filter":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"name":{"type":"string","x-stream-index":"003"},"size":{"format":"int32","type":"integer","x-stream-index":"009"},"task_id":{"type":"string","x-stream-index":"008"},"type":{"type":"string","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"011"}},"required":["id","type","name","all_users","all_sender_channels","size","created_at","updated_at"],"type":"object"},"SegmentResponse":{"properties":{"all_sender_channels":{"type":"boolean","x-stream-index":"007"},"all_users":{"type":"boolean","x-stream-index":"006"},"created_at":{"format":"date-time","type":"number","x-stream-index":"009"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"description":{"type":"string","x-stream-index":"004"},"filter":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"name":{"type":"string","x-stream-index":"003"},"size":{"format":"int32","type":"integer","x-stream-index":"008"},"type":{"type":"string","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"010"}},"required":["id","type","name","description","filter","all_users","all_sender_channels","size","created_at","updated_at","deleted_at"],"type":"object"},"SegmentTargetResponse":{"nullable":true,"properties":{"app_pk":{"format":"int32","type":"integer","x-stream-index":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"segment_id":{"type":"string","x-stream-index":"002"},"target_id":{"type":"string","x-stream-index":"003"}},"required":["app_pk","segment_id","target_id","created_at"],"type":"object"},"SendCallEventRequest":{"description":"Send a call event to the other user","nullable":true,"properties":{"custom":{"additionalProperties":{},"title":"Custom","type":"object","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"title":"SendCallEventRequest","type":"object"},"SendCallEventResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"SendCallEventResponse","type":"object"},"SendEventRequest":{"nullable":true,"properties":{"event":{"$ref":"#/components/schemas/EventRequest","x-stream-index":"001"}},"required":["event"],"type":"object"},"SendMessageRequest":{"nullable":true,"properties":{"force_moderation":{"type":"boolean","x-stream-index":"007"},"keep_channel_hidden":{"type":"boolean","x-stream-index":"008"},"message":{"$ref":"#/components/schemas/MessageRequest","x-stream-index":"001"},"pending":{"type":"boolean","x-stream-index":"006"},"pending_message_metadata":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"005"},"skip_enrich_url":{"type":"boolean","x-stream-index":"003"},"skip_push":{"type":"boolean","x-stream-index":"002"}},"required":["message"],"type":"object"},"SendMessageResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Message response","title":"Message","x-stream-index":"001"},"pending_message_metadata":{"additionalProperties":{"type":"string"},"description":"Pending message metadata","title":"Pending message metadata","type":"object","x-stream-index":"002"}},"required":["message","duration"],"type":"object"},"SendReactionRequest":{"nullable":true,"properties":{"enforce_unique":{"description":"Whether to replace all existing user reactions","title":"Enforce unique","type":"boolean","x-stream-index":"003"},"reaction":{"$ref":"#/components/schemas/ReactionRequest","x-stream-index":"002"},"skip_push":{"description":"Skips any mobile push notifications","title":"Skip push","type":"boolean","x-stream-index":"004"}},"required":["reaction"],"type":"object"},"SendReactionResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001"},"reaction":{"$ref":"#/components/schemas/ReactionResponse","x-stream-index":"002"}},"required":["message","reaction","duration"],"title":"Response","type":"object"},"SendUserCustomEventRequest":{"nullable":true,"properties":{"event":{"$ref":"#/components/schemas/UserCustomEventRequest","x-stream-index":"001"}},"required":["event"],"type":"object"},"SessionSettings":{"properties":{"inactivity_timeout_seconds":{"format":"int32","maximum":900,"minimum":5,"type":"integer","x-stream-index":"001"}},"required":["inactivity_timeout_seconds"],"type":"object"},"SessionSettingsRequest":{"properties":{"inactivity_timeout_seconds":{"format":"int32","maximum":900,"minimum":5,"type":"integer","x-stream-index":"001"}},"required":["inactivity_timeout_seconds"],"type":"object"},"SessionSettingsResponse":{"properties":{"inactivity_timeout_seconds":{"format":"int32","maximum":900,"minimum":5,"type":"integer","x-stream-index":"001"}},"required":["inactivity_timeout_seconds"],"type":"object"},"ShadowBlockActionRequest":{"type":"object"},"SharedLocation":{"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"013"},"channel_cid":{"type":"string","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"010"},"created_by_device_id":{"type":"string","x-stream-index":"008"},"end_at":{"format":"date-time","type":"number","x-stream-index":"009"},"latitude":{"format":"float","maximum":90,"minimum":18446744073709552000,"type":"number","x-stream-index":"006"},"longitude":{"format":"float","maximum":180,"minimum":18446744073709552000,"type":"number","x-stream-index":"007"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"012"},"message_id":{"type":"string","x-stream-index":"004"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"011"},"user_id":{"type":"string","x-stream-index":"005"}},"required":["channel_cid","message_id","user_id","created_by_device_id","created_at","updated_at"],"type":"object"},"SharedLocationResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001.011"},"channel_cid":{"description":"Channel CID","title":"string","type":"string","x-stream-index":"001.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.008"},"created_by_device_id":{"description":"Device ID that created the live location","title":"string","type":"string","x-stream-index":"001.006"},"duration":{"type":"string","x-stream-index":"002.001"},"end_at":{"description":"Time when the live location expires","format":"date-time","title":"string","type":"number","x-stream-index":"001.007"},"latitude":{"description":"Latitude coordinate","format":"float","title":"number","type":"number","x-stream-index":"001.004"},"longitude":{"description":"Longitude coordinate","format":"float","title":"number","type":"number","x-stream-index":"001.005"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001.010"},"message_id":{"description":"Message ID","title":"string","type":"string","x-stream-index":"001.002"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.009"},"user_id":{"description":"User ID","title":"string","type":"string","x-stream-index":"001.003"}},"required":["channel_cid","message_id","user_id","latitude","longitude","created_by_device_id","created_at","updated_at","duration"],"type":"object"},"SharedLocationResponseData":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"011"},"channel_cid":{"type":"string","x-stream-index":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"created_by_device_id":{"type":"string","x-stream-index":"006"},"end_at":{"format":"date-time","type":"number","x-stream-index":"007"},"latitude":{"format":"float","type":"number","x-stream-index":"004"},"longitude":{"format":"float","type":"number","x-stream-index":"005"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"010"},"message_id":{"type":"string","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["channel_cid","message_id","user_id","latitude","longitude","created_by_device_id","created_at","updated_at"],"type":"object"},"SharedLocationsResponse":{"nullable":true,"properties":{"active_live_locations":{"items":{"$ref":"#/components/schemas/SharedLocationResponseData"},"type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["active_live_locations","duration"],"type":"object"},"ShowChannelRequest":{"nullable":true,"properties":{"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"002.002"},"user_id":{"type":"string","x-stream-index":"002.001"}},"type":"object"},"ShowChannelResponse":{"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"},"SortParam":{"nullable":true,"properties":{"direction":{"format":"int32","type":"integer","x-stream-index":"002"},"field":{"type":"string","x-stream-index":"001"}},"type":"object"},"SortParamRequest":{"nullable":true,"properties":{"direction":{"description":"Direction of sorting, 1 for Ascending, -1 for Descending, default is 1","format":"int32","title":"Direction","type":"integer","x-stream-index":"002"},"field":{"description":"Name of field to sort by","title":"Field","type":"string","x-stream-index":"001"}},"type":"object"},"StartCampaignRequest":{"nullable":true,"properties":{"scheduled_for":{"format":"date-time","type":"number","x-stream-index":"002"},"stop_at":{"format":"date-time","type":"number","x-stream-index":"003"}},"type":"object"},"StartCampaignResponse":{"description":"Basic response information","nullable":true,"properties":{"campaign":{"$ref":"#/components/schemas/CampaignResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"users":{"$ref":"#/components/schemas/PagerResponse","x-stream-index":"002"}},"required":["duration"],"title":"Response","type":"object"},"StartClosedCaptionsRequest":{"nullable":true,"properties":{"enable_transcription":{"description":"Enable transcriptions along with closed captions","title":"Enable Transcription","type":"boolean","x-stream-index":"002"},"external_storage":{"description":"Which external storage to use for transcriptions (only applicable if enable_transcription is true)","title":"External Storage","type":"string","x-stream-index":"003"},"language":{"description":"The spoken language in the call, if not provided the language defined in the transcription settings will be used","enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"title":"Language","type":"string","x-stream-index":"004"}},"type":"object"},"StartClosedCaptionsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"StartFrameRecordingRequest":{"nullable":true,"properties":{"recording_external_storage":{"type":"string","x-stream-index":"002"}},"title":"StartFrameRecordingRequest","type":"object"},"StartFrameRecordingResponse":{"description":"StartFrameRecordingResponse is the response payload for the start frame recording endpoint.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StartFrameRecordingResponse","type":"object"},"StartHLSBroadcastingRequest":{"description":"StartHLSBroadcastingRequest is the payload for starting an HLS broadcasting.","nullable":true,"title":"StartHLSBroadcastingRequest","type":"object"},"StartHLSBroadcastingResponse":{"description":"StartHLSBroadcastingResponse is the payload for starting an HLS broadcasting.","nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"},"playlist_url":{"description":"the URL of the HLS playlist","title":"PlaylistURL","type":"string","x-stream-index":"002"}},"required":["duration","playlist_url"],"title":"StartHLSBroadcastingResponse","type":"object"},"StartRTMPBroadcastsRequest":{"description":"StartRTMPBroadcastsRequest is the payload for starting RTMP broadcasts.","nullable":true,"properties":{"broadcasts":{"description":"List of broadcasts to start","items":{"$ref":"#/components/schemas/RTMPBroadcastRequest"},"maximum":1,"minimum":1,"title":"Broadcasts","type":"array","x-stream-index":"002"}},"required":["broadcasts"],"title":"StartRTMPBroadcastsRequest","type":"object"},"StartRTMPBroadcastsResponse":{"description":"StartRTMPBroadcastsResponse is the payload for starting an RTMP broadcast.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StartRTMPBroadcastsResponse","type":"object"},"StartRecordingRequest":{"nullable":true,"properties":{"recording_external_storage":{"type":"string","x-stream-index":"002"}},"title":"StartRecordingRequest","type":"object"},"StartRecordingResponse":{"description":"StartRecordingResponse is the response payload for the start recording endpoint.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StartRecordingResponse","type":"object"},"StartTranscriptionRequest":{"nullable":true,"properties":{"enable_closed_captions":{"description":"Enable closed captions along with transcriptions","title":"Enable Closed Captions","type":"boolean","x-stream-index":"003"},"language":{"description":"The spoken language in the call, if not provided the language defined in the transcription settings will be used","enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"title":"Language","type":"string","x-stream-index":"004"},"transcription_external_storage":{"description":"Store transcriptions in this external storage","title":"External Storage","type":"string","x-stream-index":"002"}},"type":"object"},"StartTranscriptionResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StartTranscriptionResponse","type":"object"},"StopAllRTMPBroadcastsRequest":{"nullable":true,"title":"StopAllRTMPBroadcastsRequest","type":"object"},"StopAllRTMPBroadcastsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StopAllRTMPBroadcastsResponse","type":"object"},"StopCampaignRequest":{"nullable":true,"type":"object"},"StopClosedCaptionsRequest":{"nullable":true,"properties":{"stop_transcription":{"type":"boolean","x-stream-index":"003"}},"type":"object"},"StopClosedCaptionsResponse":{"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"},"StopFrameRecordingRequest":{"nullable":true,"type":"object"},"StopFrameRecordingResponse":{"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"},"StopHLSBroadcastingRequest":{"nullable":true,"type":"object"},"StopHLSBroadcastingResponse":{"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"},"StopLiveRequest":{"nullable":true,"properties":{"continue_closed_caption":{"type":"boolean","x-stream-index":"006"},"continue_hls":{"type":"boolean","x-stream-index":"003"},"continue_recording":{"type":"boolean","x-stream-index":"004"},"continue_rtmp_broadcasts":{"type":"boolean","x-stream-index":"007"},"continue_transcription":{"type":"boolean","x-stream-index":"005"}},"title":"StopLiveRequest","type":"object"},"StopLiveResponse":{"nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"The call that was stopped","title":"Call","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["call","duration"],"title":"StopLiveResponse","type":"object"},"StopRTMPBroadcastsRequest":{"description":"Request for stopping RTMP broadcasts","nullable":true,"title":"StopRTMPBroadcastsRequest","type":"object"},"StopRTMPBroadcastsResponse":{"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"},"StopRecordingRequest":{"nullable":true,"type":"object"},"StopRecordingResponse":{"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"},"StopTranscriptionRequest":{"nullable":true,"properties":{"stop_closed_captions":{"type":"boolean","x-stream-index":"003"}},"type":"object"},"StopTranscriptionResponse":{"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"},"SubmitActionRequest":{"nullable":true,"properties":{"action_type":{"description":"Type of moderation action to perform (mark_reviewed, delete_message, etc.)","enum":["mark_reviewed","delete_message","delete_activity","delete_reaction","ban","custom","unban","restore","delete_user","unblock","shadow_block","unmask","kick_user","end_call"],"title":"Action Type","type":"string","x-stream-index":"002"},"ban":{"$ref":"#/components/schemas/BanActionRequest","description":"Configuration for ban action","title":"Ban","x-stream-index":"008"},"custom":{"$ref":"#/components/schemas/CustomActionRequest","description":"Configuration for custom action","title":"Custom","x-stream-index":"009"},"delete_activity":{"$ref":"#/components/schemas/DeleteActivityRequest","description":"Configuration for activity deletion action","title":"Delete Activity","x-stream-index":"004"},"delete_message":{"$ref":"#/components/schemas/DeleteMessageRequest","description":"Configuration for message deletion action","title":"Delete Message","x-stream-index":"003"},"delete_reaction":{"$ref":"#/components/schemas/DeleteReactionRequest","description":"Configuration for reaction deletion action","title":"Delete Reaction","x-stream-index":"005"},"delete_user":{"$ref":"#/components/schemas/DeleteUserRequest","description":"Configuration for user deletion action","title":"Delete User","x-stream-index":"006"},"item_id":{"description":"UUID of the review queue item to act on","title":"Item ID","type":"string","x-stream-index":"001"},"mark_reviewed":{"$ref":"#/components/schemas/MarkReviewedRequest","description":"Configuration for marking item as reviewed","title":"Mark Reviewed","x-stream-index":"007"},"unban":{"$ref":"#/components/schemas/UnbanActionRequest","description":"Configuration for unban action","title":"Unban","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"016.002"},"user_id":{"type":"string","x-stream-index":"016.001"}},"required":["item_id","action_type"],"type":"object"},"SubmitActionResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"Updated review queue item after action was performed","title":"Item","x-stream-index":"001"}},"required":["duration"],"type":"object"},"SubscriberAllMetrics":{"properties":{"audio":{"$ref":"#/components/schemas/SubscriberAudioMetrics","x-stream-index":"001"},"rtt_ms":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"003"},"video":{"$ref":"#/components/schemas/SubscriberVideoMetrics","x-stream-index":"002"}},"type":"object"},"SubscriberAudioMetrics":{"properties":{"concealment_pct":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"003"},"jitter_ms":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"001"},"packets_lost_pct":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"002"}},"type":"object"},"SubscriberStatsResponse":{"properties":{"total":{"format":"int32","type":"integer","x-stream-index":"001"},"total_subscribed_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"003"},"unique":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["total","unique","total_subscribed_duration_seconds"],"type":"object"},"SubscriberVideoMetrics":{"properties":{"fps_30":{"$ref":"#/components/schemas/ActiveCallsFPSStats","x-stream-index":"002"},"jitter_ms":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"001"},"packets_lost_pct":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"003"}},"type":"object"},"SubscribersMetrics":{"properties":{"all":{"$ref":"#/components/schemas/SubscriberAllMetrics","x-stream-index":"001"}},"type":"object"},"TargetResolution":{"properties":{"bitrate":{"format":"int32","maximum":6000000,"type":"integer","x-stream-index":"003"},"height":{"format":"int32","maximum":3840,"minimum":240,"type":"integer","x-stream-index":"002"},"width":{"format":"int32","maximum":3840,"minimum":240,"type":"integer","x-stream-index":"001"}},"required":["width","height","bitrate"],"type":"object"},"TextContentParameters":{"properties":{"blocklist_match":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"contains_url":{"type":"boolean","x-stream-index":"002"},"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001"},"severity":{"type":"string","x-stream-index":"003"}},"type":"object"},"TextRuleParameters":{"properties":{"blocklist_match":{"items":{"type":"string"},"type":"array","x-stream-index":"006"},"contains_url":{"type":"boolean","x-stream-index":"004"},"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"severity":{"type":"string","x-stream-index":"005"},"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"required":["threshold","time_window"],"type":"object"},"ThreadParticipant":{"description":"Represents a user that is participating in a thread.","nullable":true,"properties":{"app_pk":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"001"},"channel_cid":{"type":"string","x-stream-index":"002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"007"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"last_read_at":{"format":"date-time","type":"number","x-stream-index":"009"},"last_thread_message_at":{"format":"date-time","type":"number","x-stream-index":"003"},"left_thread_at":{"description":"Left Thread At is the time when the user left the thread","format":"date-time","title":"Left Thread At","type":"number","x-stream-index":"008"},"thread_id":{"description":"Thead ID is unique string identifier of the thread","title":"ID","type":"string","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User is the user object","title":"User","x-stream-index":"006"},"user_id":{"description":"User ID is unique string identifier of the user","title":"User ID","type":"string","x-stream-index":"005"}},"required":["app_pk","channel_cid","created_at","last_read_at","custom"],"title":"ThreadParticipant","type":"object"},"ThreadResponse":{"properties":{"active_participant_count":{"description":"Active Participant Count","format":"int32","title":"Active Participant Count","type":"integer","x-stream-index":"009"},"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel","title":"ChannelResponse","x-stream-index":"002"},"channel_cid":{"description":"Channel CID","title":"Channel CID","type":"string","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"012"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"Created By User","title":"User","x-stream-index":"006"},"created_by_user_id":{"description":"Created By User ID","title":"Created By User ID","type":"string","x-stream-index":"005"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"016"},"deleted_at":{"description":"Deleted At","format":"date-time","title":"Deleted At","type":"number","x-stream-index":"014"},"last_message_at":{"description":"Last Message At","format":"date-time","title":"Last Message At","type":"number","x-stream-index":"011"},"parent_message":{"$ref":"#/components/schemas/MessageResponse","description":"Parent Message","title":"Message","x-stream-index":"004"},"parent_message_id":{"description":"Parent Message ID","title":"Parent Message ID","type":"string","x-stream-index":"003"},"participant_count":{"description":"Participant Count","format":"int32","title":"Participant Count","type":"integer","x-stream-index":"008"},"reply_count":{"description":"Reply Count","format":"int32","title":"Reply Count","type":"integer","x-stream-index":"007"},"thread_participants":{"description":"Thread Participants","items":{"$ref":"#/components/schemas/ThreadParticipant"},"title":"ThreadParticipants","type":"array","x-stream-index":"010"},"title":{"description":"Title","title":"Title","type":"string","x-stream-index":"015"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"013"}},"required":["channel_cid","parent_message_id","created_by_user_id","created_at","updated_at","title","custom"],"type":"object"},"ThreadStateResponse":{"nullable":true,"properties":{"active_participant_count":{"description":"Active Participant Count","format":"int32","title":"Active Participant Count","type":"integer","x-stream-index":"001.009"},"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel","title":"ChannelResponse","x-stream-index":"001.002"},"channel_cid":{"description":"Channel CID","title":"Channel CID","type":"string","x-stream-index":"001.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.012"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"Created By User","title":"User","x-stream-index":"001.006"},"created_by_user_id":{"description":"Created By User ID","title":"Created By User ID","type":"string","x-stream-index":"001.005"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"001.016"},"deleted_at":{"description":"Deleted At","format":"date-time","title":"Deleted At","type":"number","x-stream-index":"001.014"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"004"},"last_message_at":{"description":"Last Message At","format":"date-time","title":"Last Message At","type":"number","x-stream-index":"001.011"},"latest_replies":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","x-stream-index":"002"},"parent_message":{"$ref":"#/components/schemas/MessageResponse","description":"Parent Message","title":"Message","x-stream-index":"001.004"},"parent_message_id":{"description":"Parent Message ID","title":"Parent Message ID","type":"string","x-stream-index":"001.003"},"participant_count":{"description":"Participant Count","format":"int32","title":"Participant Count","type":"integer","x-stream-index":"001.008"},"read":{"items":{"$ref":"#/components/schemas/ReadStateResponse"},"type":"array","x-stream-index":"003"},"reply_count":{"description":"Reply Count","format":"int32","title":"Reply Count","type":"integer","x-stream-index":"001.007"},"thread_participants":{"description":"Thread Participants","items":{"$ref":"#/components/schemas/ThreadParticipant"},"title":"ThreadParticipants","type":"array","x-stream-index":"001.010"},"title":{"description":"Title","title":"Title","type":"string","x-stream-index":"001.015"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.013"}},"required":["channel_cid","parent_message_id","created_by_user_id","created_at","updated_at","title","custom","latest_replies"],"type":"object"},"ThreadUpdatedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"001.002"},"channel_type":{"type":"string","x-stream-index":"001.003"},"cid":{"type":"string","x-stream-index":"001.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"thread":{"$ref":"#/components/schemas/ThreadResponse","x-stream-index":"003.001"},"type":{"default":"thread.updated","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"ThreadUpdatedEvent","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"},"Thresholds":{"description":"Sets thresholds for AI moderation","properties":{"explicit":{"$ref":"#/components/schemas/LabelThresholds","description":"Thresholds for explicit messages","title":"LabelThresholds","x-stream-index":"001"},"spam":{"$ref":"#/components/schemas/LabelThresholds","description":"Thresholds for spam","title":"LabelThresholds","x-stream-index":"002"},"toxic":{"$ref":"#/components/schemas/LabelThresholds","description":"Thresholds for toxic messages","title":"LabelThresholds","x-stream-index":"003"}},"title":"Auto moderation thresholds","type":"object"},"ThumbnailResponse":{"properties":{"image_url":{"type":"string","x-stream-index":"001"}},"required":["image_url"],"type":"object"},"ThumbnailsSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"ThumbnailsSettingsRequest":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"ThumbnailsSettingsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"Time":{"type":"object"},"TrackStatsResponse":{"nullable":true,"properties":{"duration_seconds":{"format":"int32","type":"integer","x-stream-index":"002"},"track_type":{"type":"string","x-stream-index":"001"}},"required":["track_type","duration_seconds"],"type":"object"},"TranscriptionSettings":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"title":"Mode","type":"string","x-stream-index":"002"},"language":{"description":"The language used in this call as a two letter code","enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"title":"Language","type":"string","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"title":"Mode","type":"string","x-stream-index":"001"}},"required":["mode","closed_caption_mode","languages","language"],"type":"object"},"TranscriptionSettingsRequest":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"002"},"language":{"enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"type":"string","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode"],"type":"object"},"TranscriptionSettingsResponse":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"002"},"language":{"enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"type":"string","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode","closed_caption_mode","languages","language"],"type":"object"},"TranslateMessageRequest":{"nullable":true,"properties":{"language":{"description":"Language to translate message to","enum":["af","sq","am","ar","az","bn","bs","bg","zh","zh-TW","hr","cs","da","fa-AF","nl","en","et","fi","fr","fr-CA","ka","de","el","ha","he","hi","hu","id","it","ja","ko","lv","ms","no","fa","ps","pl","pt","ro","ru","sr","sk","sl","so","es","es-MX","sw","sv","tl","ta","th","tr","uk","ur","vi","lt","ht"],"title":"Language","type":"string","x-stream-index":"001"}},"required":["language"],"type":"object"},"TruncateChannelRequest":{"nullable":true,"properties":{"hard_delete":{"description":"Permanently delete channel data (messages, reactions, etc.)","title":"Hard delete","type":"boolean","x-stream-index":"002"},"member_ids":{"description":"List of member IDs to hide message history for. If empty, truncates the channel for all members","items":{"type":"string"},"maximum":100,"title":"Member IDs","type":"array","x-stream-index":"007"},"message":{"$ref":"#/components/schemas/MessageRequest","x-stream-index":"004"},"skip_push":{"description":"When `message` is set disables all push notifications for it","title":"Skip push","type":"boolean","x-stream-index":"005"},"truncated_at":{"description":"Truncate channel data up to `truncated_at`. The system message (if provided) creation time is always greater than `truncated_at`","format":"date-time","title":"Truncated at","type":"number","x-stream-index":"006"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"008.002"},"user_id":{"type":"string","x-stream-index":"008.001"}},"type":"object"},"TruncateChannelResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Truncated channel object","title":"Channel","x-stream-index":"002"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Truncated message object","title":"Message","x-stream-index":"003"}},"required":["duration"],"type":"object"},"TypingIndicators":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"TypingIndicatorsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"UnbanActionRequest":{"type":"object"},"UnbanRequest":{"nullable":true,"properties":{"unbanned_by":{"$ref":"#/components/schemas/UserRequest","description":"Details about the user performing the unban","title":"Unbanned By","x-stream-index":"005"},"unbanned_by_id":{"description":"ID of the user performing the unban","title":"Unbanned By ID","type":"string","x-stream-index":"004"}},"type":"object"},"UnbanResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"UnblockActionRequest":{"type":"object"},"UnblockUserRequest":{"description":"UnblockUserRequest is the payload for unblocking a user.","nullable":true,"properties":{"user_id":{"description":"the user to unblock","title":"UserID","type":"string","x-stream-index":"003"}},"required":["user_id"],"title":"UnblockUserRequest","type":"object"},"UnblockUserResponse":{"description":"UnblockUserResponse is the payload for unblocking a user.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"UnblockUserResponse","type":"object"},"UnblockUsersRequest":{"nullable":true,"properties":{"blocked_user_id":{"type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"required":["blocked_user_id"],"type":"object"},"UnblockUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"UnblockedUserEvent":{"description":"This event is sent when a user is unblocked on a call,\nthis can be useful to notify the user that they can now join the call again","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.unblocked_user","description":"The type of event: \"call.unblocked_user\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user that was unblocked","title":"User","x-stream-index":"003"}},"required":["type","created_at","call_cid","user"],"title":"UnblockedUserEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"UnmuteChannelRequest":{"nullable":true,"properties":{"channel_cids":{"description":"Channel CIDs to mute (if multiple channels)","items":{"type":"string"},"maximum":25,"title":"Channel CIDs","type":"array","x-stream-index":"001.002"},"expiration":{"description":"Duration of mute in milliseconds","title":"Expiration","type":"integer","x-stream-index":"001.003"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"002.002"},"user_id":{"type":"string","x-stream-index":"002.001"}},"type":"object"},"UnmuteRequest":{"nullable":true,"properties":{"target_ids":{"description":"User IDs to unmute","items":{"type":"string"},"title":"Target IDs","type":"array","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"002.002"},"user_id":{"type":"string","x-stream-index":"002.001"}},"required":["target_ids"],"title":"UnmuteRequest","type":"object"},"UnmuteResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"non_existing_users":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"required":["duration"],"title":"Response","type":"object"},"UnpinRequest":{"description":"UnpinRequest is the payload for unpinning a message.","nullable":true,"properties":{"session_id":{"description":"the session ID of the user who pinned the message","title":"SessionID","type":"string","x-stream-index":"003"},"user_id":{"description":"the user ID of the user who pinned the message","title":"UserID","type":"string","x-stream-index":"002"}},"required":["user_id","session_id"],"title":"UnpinRequest","type":"object"},"UnpinResponse":{"description":"UnpinResponse is the payload for unpinning a message.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"UnpinResponse","type":"object"},"UnreadCountsBatchRequest":{"nullable":true,"properties":{"user_ids":{"items":{"type":"string"},"maximum":100,"type":"array","x-stream-index":"001"}},"required":["user_ids"],"type":"object"},"UnreadCountsBatchResponse":{"description":"Basic response information","nullable":true,"properties":{"counts_by_user":{"additionalProperties":{"$ref":"#/components/schemas/UnreadCountsResponse"},"type":"object","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["counts_by_user","duration"],"title":"Response","type":"object"},"UnreadCountsChannel":{"properties":{"channel_id":{"type":"string","x-stream-index":"001"},"last_read":{"format":"date-time","type":"number","x-stream-index":"003"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["channel_id","unread_count","last_read"],"type":"object"},"UnreadCountsChannelType":{"properties":{"channel_count":{"format":"int32","type":"integer","x-stream-index":"002"},"channel_type":{"type":"string","x-stream-index":"001"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["channel_type","channel_count","unread_count"],"type":"object"},"UnreadCountsResponse":{"nullable":true,"properties":{"channel_type":{"items":{"$ref":"#/components/schemas/UnreadCountsChannelType"},"type":"array","x-stream-index":"005"},"channels":{"items":{"$ref":"#/components/schemas/UnreadCountsChannel"},"type":"array","x-stream-index":"004"},"threads":{"items":{"$ref":"#/components/schemas/UnreadCountsThread"},"type":"array","x-stream-index":"006"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"001"},"total_unread_count_by_team":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"003"},"total_unread_threads_count":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["total_unread_count","total_unread_threads_count","channels","channel_type","threads"],"type":"object"},"UnreadCountsThread":{"properties":{"last_read":{"format":"date-time","type":"number","x-stream-index":"002"},"last_read_message_id":{"type":"string","x-stream-index":"003"},"parent_message_id":{"type":"string","x-stream-index":"004"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"001"}},"required":["unread_count","last_read","last_read_message_id","parent_message_id"],"type":"object"},"UpdateAppRequest":{"nullable":true,"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.017"},"apn_config":{"$ref":"#/components/schemas/APNConfig","x-stream-index":"001.003"},"async_moderation_config":{"$ref":"#/components/schemas/AsyncModerationConfiguration","x-stream-index":"001.039"},"async_url_enrich_enabled":{"type":"boolean","x-stream-index":"001.019"},"auto_translation_enabled":{"type":"boolean","x-stream-index":"001.018"},"before_message_send_hook_url":{"type":"string","x-stream-index":"001.020"},"cdn_expiration_seconds":{"format":"int32","maximum":1209600,"minimum":14400,"type":"integer","x-stream-index":"001.038"},"channel_hide_members_only":{"type":"boolean","x-stream-index":"001.033"},"custom_action_handler_url":{"type":"string","x-stream-index":"001.021"},"datadog_info":{"$ref":"#/components/schemas/DataDogInfo","x-stream-index":"001.040"},"disable_auth_checks":{"type":"boolean","x-stream-index":"001.001"},"disable_permissions_checks":{"type":"boolean","x-stream-index":"001.002"},"enforce_unique_usernames":{"enum":["no","app","team"],"type":"string","x-stream-index":"001.022"},"event_hooks":{"items":{"$ref":"#/components/schemas/EventHook"},"type":"array","x-stream-index":"001.046"},"feeds_moderation_enabled":{"type":"boolean","x-stream-index":"001.042"},"feeds_v2_region":{"type":"string","x-stream-index":"001.041"},"file_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","x-stream-index":"001.030"},"firebase_config":{"$ref":"#/components/schemas/FirebaseConfig","x-stream-index":"001.004"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"001.034"},"guest_user_creation_disabled":{"type":"boolean","x-stream-index":"001.043"},"huawei_config":{"$ref":"#/components/schemas/HuaweiConfig","x-stream-index":"001.005"},"image_moderation_block_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001.015"},"image_moderation_enabled":{"type":"boolean","x-stream-index":"001.016"},"image_moderation_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001.014"},"image_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","x-stream-index":"001.029"},"migrate_permissions_to_v2":{"type":"boolean","x-stream-index":"001.035"},"moderation_dashboard_preferences":{"$ref":"#/components/schemas/ModerationDashboardPreferences","x-stream-index":"001.044"},"moderation_enabled":{"type":"boolean","x-stream-index":"001.009"},"moderation_webhook_url":{"type":"string","x-stream-index":"001.010"},"multi_tenant_enabled":{"type":"boolean","x-stream-index":"001.013"},"permission_version":{"enum":["v1","v2"],"type":"string","x-stream-index":"001.011"},"push_config":{"$ref":"#/components/schemas/PushConfig","x-stream-index":"001.007"},"reminders_interval":{"format":"int32","maximum":86400,"minimum":60,"type":"integer","x-stream-index":"001.036"},"reminders_max_members":{"format":"int32","minimum":2,"type":"integer","x-stream-index":"001.037"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.031"},"sns_key":{"type":"string","x-stream-index":"001.027"},"sns_secret":{"type":"string","x-stream-index":"001.028"},"sns_topic_arn":{"type":"string","x-stream-index":"001.026"},"sqs_key":{"type":"string","x-stream-index":"001.024"},"sqs_secret":{"type":"string","x-stream-index":"001.025"},"sqs_url":{"type":"string","x-stream-index":"001.023"},"user_response_time_enabled":{"type":"boolean","x-stream-index":"001.048"},"user_search_disallowed_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"001.012"},"webhook_events":{"items":{"type":"string"},"type":"array","x-stream-index":"001.032"},"webhook_url":{"type":"string","x-stream-index":"001.008"},"xiaomi_config":{"$ref":"#/components/schemas/XiaomiConfig","x-stream-index":"001.006"}},"type":"object"},"UpdateBlockListRequest":{"nullable":true,"properties":{"team":{"type":"string","x-stream-index":"002"},"words":{"description":"List of words to block","items":{"type":"string"},"minimum":1,"title":"Words","type":"array","x-stream-index":"003"}},"title":"Update block list","type":"object","x-stream-docs-page-id":"update_block_list"},"UpdateBlockListResponse":{"description":"Basic response information","nullable":true,"properties":{"blocklist":{"$ref":"#/components/schemas/BlockListResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["duration"],"title":"Response","type":"object"},"UpdateCallMembersRequest":{"description":"Update call members","nullable":true,"properties":{"remove_members":{"description":"List of userID to remove","items":{"type":"string"},"maximum":100,"title":"Remove Members","type":"array","x-stream-index":"003"},"update_members":{"description":"List of members to update or insert","items":{"$ref":"#/components/schemas/MemberRequest"},"maximum":100,"title":"Update Members","type":"array","x-stream-index":"004"}},"title":"UpdateCallMembersRequest","type":"object"},"UpdateCallMembersResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"002"}},"required":["duration","members"],"title":"Response","type":"object"},"UpdateCallRequest":{"description":"Request for updating a call","nullable":true,"properties":{"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"003"},"settings_override":{"$ref":"#/components/schemas/CallSettingsRequest","description":"the settings to change for this call","title":"Settings Override","x-stream-index":"004"},"starts_at":{"description":"the time the call is scheduled to start","format":"date-time","title":"Starts At","type":"number","x-stream-index":"005"}},"title":"UpdateCallRequest","type":"object"},"UpdateCallResponse":{"description":"Response for updating a call","nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001.001"},"duration":{"type":"string","x-stream-index":"002.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001.002"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"001.004"}},"required":["call","members","own_capabilities","blocked_users","duration"],"title":"UpdateCallResponse","type":"object"},"UpdateCallTypeRequest":{"description":"UpdateCallTypeRequest is the payload for updating a call type.","nullable":true,"properties":{"external_storage":{"type":"string","x-stream-index":"002.004"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"002.001"},"notification_settings":{"$ref":"#/components/schemas/NotificationSettings","x-stream-index":"002.002"},"settings":{"$ref":"#/components/schemas/CallSettingsRequest","x-stream-index":"002.003"}},"title":"UpdateCallTypeRequest","type":"object"},"UpdateCallTypeResponse":{"description":"UpdateCallTypeResponse is the payload for updating a call type.","nullable":true,"properties":{"created_at":{"description":"the time the call type was created","format":"date-time","title":"CreatedAt","type":"number","x-stream-index":"001.005"},"duration":{"type":"string","x-stream-index":"002.001"},"external_storage":{"description":"the external storage for the call type","title":"ExternalStorage","type":"string","x-stream-index":"001.007"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"the permissions granted to each role","title":"Grants","type":"object","x-stream-index":"001.002"},"name":{"description":"the name of the call type","title":"Name","type":"string","x-stream-index":"001.001"},"notification_settings":{"$ref":"#/components/schemas/NotificationSettings","description":"the notification settings for the call type","title":"NotificationSettings","x-stream-index":"001.004"},"settings":{"$ref":"#/components/schemas/CallSettingsResponse","description":"the settings for the call type","title":"Settings","x-stream-index":"001.003"},"updated_at":{"description":"the time the call type was last updated","format":"date-time","title":"UpdatedAt","type":"number","x-stream-index":"001.006"}},"required":["name","grants","settings","notification_settings","created_at","updated_at","duration"],"title":"UpdateCallTypeResponse","type":"object"},"UpdateChannelPartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"type":"object","x-stream-index":"002.001"},"unset":{"items":{"type":"string"},"type":"array","x-stream-index":"002.002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"title":"UpdateChannelPartialRequest","type":"object"},"UpdateChannelPartialResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Updated channel object","title":"Channel","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"members":{"description":"List of updated members","items":{"$ref":"#/components/schemas/ChannelMemberResponse"},"title":"ChannelMemberResponse","type":"array","x-stream-index":"002"}},"required":["members","duration"],"type":"object"},"UpdateChannelRequest":{"nullable":true,"properties":{"accept_invite":{"description":"Set to `true` to accept the invite","title":"Accept invite","type":"boolean","x-stream-index":"008"},"add_members":{"description":"List of user IDs to add to the channel","items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"title":"Add members","type":"array","x-stream-index":"001"},"add_moderators":{"description":"List of user IDs to make channel moderators","items":{"type":"string"},"maximum":100,"title":"Add moderators","type":"array","x-stream-index":"003"},"assign_roles":{"description":"List of channel member role assignments. If any specified user is not part of the channel, the request will fail","items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"title":"Assign roles","type":"array","x-stream-index":"006"},"cooldown":{"description":"Sets cool down period for the channel in seconds","format":"int32","maximum":120,"minimum":0,"title":"Cool down","type":"integer","x-stream-index":"007"},"data":{"$ref":"#/components/schemas/ChannelInput","x-stream-index":"013.001"},"demote_moderators":{"description":"List of user IDs to take away moderators status from","items":{"type":"string"},"maximum":100,"title":"Demote moderators","type":"array","x-stream-index":"004"},"hide_history":{"description":"Set to `true` to hide channel's history when adding new members","title":"Hide history","type":"boolean","x-stream-index":"012"},"invites":{"description":"List of user IDs to invite to the channel","items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"title":"Invites","type":"array","x-stream-index":"005"},"message":{"$ref":"#/components/schemas/MessageRequest","description":"Message to send to the chat when channel is successfully updated","title":"Message","x-stream-index":"010"},"reject_invite":{"description":"Set to `true` to reject the invite","title":"Reject invite","type":"boolean","x-stream-index":"009"},"remove_members":{"description":"List of user IDs to remove from the channel","items":{"type":"string"},"maximum":100,"title":"Remove members","type":"array","x-stream-index":"002"},"skip_push":{"description":"When `message` is set disables all push notifications for it","title":"Skip push","type":"boolean","x-stream-index":"011"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"014.002"},"user_id":{"type":"string","x-stream-index":"014.001"}},"title":"Channel update request","type":"object","x-stream-docs-page-id":"channel_update"},"UpdateChannelResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Updated channel","title":"Channel","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"004.001"},"members":{"description":"List of channel members","items":{"$ref":"#/components/schemas/ChannelMember"},"title":"Members","type":"array","x-stream-index":"003"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Message sent to the chat","title":"Message","x-stream-index":"002"}},"required":["members","duration"],"type":"object"},"UpdateChannelTypeRequest":{"nullable":true,"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"009.001.026"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"009.001.021"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"009.001.022"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"009.001.027"},"blocklist":{"type":"string","x-stream-index":"009.001.023"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"009.001.024"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"009.001.025"},"commands":{"description":"List of commands that channel supports","items":{"type":"string"},"title":"Commands","type":"array","x-stream-index":"009.003"},"connect_events":{"type":"boolean","x-stream-index":"009.001.004"},"custom_events":{"type":"boolean","x-stream-index":"009.001.012"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"004"},"mark_messages_pending":{"type":"boolean","x-stream-index":"009.001.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"009.001.020"},"mutes":{"type":"boolean","x-stream-index":"009.001.009"},"partition_size":{"format":"int32","minimum":0,"type":"integer","x-stream-index":"007"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"008"},"permissions":{"items":{"$ref":"#/components/schemas/PolicyRequest"},"type":"array","x-stream-index":"003"},"polls":{"type":"boolean","x-stream-index":"009.001.016"},"push_notifications":{"type":"boolean","x-stream-index":"009.001.013"},"quotes":{"type":"boolean","x-stream-index":"009.001.008"},"reactions":{"type":"boolean","x-stream-index":"009.001.006"},"read_events":{"type":"boolean","x-stream-index":"009.001.003"},"reminders":{"type":"boolean","x-stream-index":"009.001.014"},"replies":{"type":"boolean","x-stream-index":"009.001.007"},"search":{"type":"boolean","x-stream-index":"009.001.005"},"shared_locations":{"type":"boolean","x-stream-index":"009.001.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"009.001.030"},"typing_events":{"type":"boolean","x-stream-index":"009.001.002"},"uploads":{"type":"boolean","x-stream-index":"009.001.010"},"url_enrichment":{"type":"boolean","x-stream-index":"009.001.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"009.001.017"}},"required":["max_message_length","automod","automod_behavior"],"type":"object"},"UpdateChannelTypeResponse":{"nullable":true,"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"003.001.026"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"003.001.021"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.001.022"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"003.001.027"},"blocklist":{"type":"string","x-stream-index":"003.001.023"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.001.024"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"003.001.025"},"commands":{"items":{"type":"string"},"type":"array","x-stream-index":"003.003"},"connect_events":{"type":"boolean","x-stream-index":"003.001.004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002.003"},"custom_events":{"type":"boolean","x-stream-index":"003.001.012"},"duration":{"type":"string","x-stream-index":"004.001"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"002"},"mark_messages_pending":{"type":"boolean","x-stream-index":"003.001.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"003.001.020"},"mutes":{"type":"boolean","x-stream-index":"003.001.009"},"name":{"type":"string","x-stream-index":"003.001.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"003.001.028"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"003.001.029"},"permissions":{"items":{"$ref":"#/components/schemas/PolicyRequest"},"type":"array","x-stream-index":"001"},"polls":{"type":"boolean","x-stream-index":"003.001.016"},"push_notifications":{"type":"boolean","x-stream-index":"003.001.013"},"quotes":{"type":"boolean","x-stream-index":"003.001.008"},"reactions":{"type":"boolean","x-stream-index":"003.001.006"},"read_events":{"type":"boolean","x-stream-index":"003.001.003"},"reminders":{"type":"boolean","x-stream-index":"003.001.014"},"replies":{"type":"boolean","x-stream-index":"003.001.007"},"search":{"type":"boolean","x-stream-index":"003.001.005"},"shared_locations":{"type":"boolean","x-stream-index":"003.001.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"003.001.030"},"typing_events":{"type":"boolean","x-stream-index":"003.001.002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"003.002.004"},"uploads":{"type":"boolean","x-stream-index":"003.001.010"},"url_enrichment":{"type":"boolean","x-stream-index":"003.001.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"003.001.017"}},"required":["permissions","grants","name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","created_at","updated_at","commands","duration"],"type":"object"},"UpdateCommandRequest":{"nullable":true,"properties":{"args":{"description":"Arguments help text, shown in commands auto-completion","maxLength":255,"title":"Arguments","type":"string","x-stream-index":"003"},"description":{"description":"Description, shown in commands auto-completion","maxLength":255,"title":"Description","type":"string","x-stream-index":"002"},"set":{"description":"Set name used for grouping commands","maxLength":255,"title":"Set","type":"string","x-stream-index":"004"}},"required":["description"],"title":"UpdateCommandRequest","type":"object"},"UpdateCommandResponse":{"nullable":true,"properties":{"command":{"$ref":"#/components/schemas/Command","description":"Command object","title":"Command","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["duration"],"title":"UpdateCommandResponse","type":"object"},"UpdateExternalStorageRequest":{"description":"External storage","nullable":true,"properties":{"aws_s3":{"$ref":"#/components/schemas/S3Request","description":"Only required if you want to create an Amazon S3 storage","title":"AwsS3","x-stream-index":"003.004"},"azure_blob":{"$ref":"#/components/schemas/AzureRequest","description":"Only required if you want to create an Azure Blob Storage","title":"AzureBlob","x-stream-index":"003.006"},"bucket":{"description":"The name of the bucket on the service provider","title":"Bucket","type":"string","x-stream-index":"003.002"},"gcs_credentials":{"type":"string","x-stream-index":"003.005"},"path":{"description":"The path prefix to use for storing files","title":"Path","type":"string","x-stream-index":"003.003"},"storage_type":{"description":"The type of storage to use","enum":["s3","gcs","abs"],"title":"StorageType","type":"string","x-stream-index":"003.001"}},"required":["storage_type","bucket"],"title":"ExternalStorageRequest","type":"object"},"UpdateExternalStorageResponse":{"description":"Basic response information","nullable":true,"properties":{"bucket":{"type":"string","x-stream-index":"001.003"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"name":{"type":"string","x-stream-index":"001.001"},"path":{"type":"string","x-stream-index":"001.004"},"type":{"enum":["s3","gcs","abs"],"type":"string","x-stream-index":"001.002"}},"required":["name","type","bucket","path","duration"],"title":"Response","type":"object"},"UpdateLiveLocationRequest":{"nullable":true,"properties":{"end_at":{"description":"Time when the live location expires","format":"date-time","title":"string","type":"number","x-stream-index":"004"},"latitude":{"description":"Latitude coordinate","format":"float","maximum":90,"minimum":18446744073709552000,"title":"number","type":"number","x-stream-index":"002"},"longitude":{"description":"Longitude coordinate","format":"float","maximum":180,"minimum":18446744073709552000,"title":"number","type":"number","x-stream-index":"003"},"message_id":{"description":"Live location ID","title":"string","type":"string","x-stream-index":"001"}},"required":["message_id"],"type":"object"},"UpdateMemberPartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"type":"object","x-stream-index":"002.001"},"unset":{"items":{"type":"string"},"type":"array","x-stream-index":"002.002"}},"type":"object"},"UpdateMemberPartialResponse":{"nullable":true,"properties":{"channel_member":{"$ref":"#/components/schemas/ChannelMemberResponse","description":"Updated channel member","title":"Channel member","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["duration"],"type":"object"},"UpdateMessagePartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"description":"Sets new field values","title":"Set","type":"object","x-stream-index":"002.001","x-stream-map":{"key":"field","title":"Value","description":"New value to set"}},"skip_enrich_url":{"description":"Skip enriching the URL in the message","title":"SkipEnrichURL","type":"boolean","x-stream-index":"001"},"unset":{"description":"Array of field names to unset","items":{"type":"string"},"title":"Unset","type":"array","x-stream-index":"002.002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"type":"object"},"UpdateMessagePartialResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Updated message","title":"Message","x-stream-index":"001"},"pending_message_metadata":{"additionalProperties":{"type":"string"},"description":"Pending message metadata","title":"PendingMessageMetadata","type":"object","x-stream-index":"002"}},"required":["duration"],"type":"object"},"UpdateMessageRequest":{"nullable":true,"properties":{"message":{"$ref":"#/components/schemas/MessageRequest","description":"Message","title":"MessageRequest","x-stream-index":"001"},"skip_enrich_url":{"description":"Skip enrich URL","title":"boolean","type":"boolean","x-stream-index":"003"},"skip_push":{"type":"boolean","x-stream-index":"002"}},"required":["message"],"type":"object"},"UpdateMessageResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001"},"pending_message_metadata":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"002"}},"required":["message","duration"],"title":"Response","type":"object"},"UpdatePollOptionRequest":{"nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"004"},"id":{"description":"Option ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"},"text":{"description":"Option text","title":"string","type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"005.002"},"user_id":{"type":"string","x-stream-index":"005.001"}},"required":["id","text"],"type":"object"},"UpdatePollPartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"description":"Sets new field values","title":"Set","type":"object","x-stream-index":"002.001","x-stream-map":{"key":"field","title":"Value","description":"New value to set"}},"unset":{"description":"Array of field names to unset","items":{"type":"string"},"title":"Unset","type":"array","x-stream-index":"002.002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"type":"object"},"UpdatePollRequest":{"nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"011"},"allow_answers":{"description":"Allow answers","title":"boolean","type":"boolean","x-stream-index":"009"},"allow_user_suggested_options":{"description":"Allow user suggested options","title":"boolean","type":"boolean","x-stream-index":"008"},"description":{"description":"Poll description","title":"string","type":"string","x-stream-index":"003"},"enforce_unique_vote":{"description":"Enforce unique vote","title":"boolean","type":"boolean","x-stream-index":"005"},"id":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"},"is_closed":{"description":"Is closed","title":"boolean","type":"boolean","x-stream-index":"010"},"max_votes_allowed":{"description":"Max votes allowed","format":"int32","maximum":10,"title":"integer","type":"integer","x-stream-index":"007"},"name":{"description":"Poll name","title":"string","type":"string","x-stream-index":"002"},"options":{"description":"Poll options","items":{"$ref":"#/components/schemas/PollOptionRequest"},"maximum":100,"title":"PollOptions","type":"array","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"012.002"},"user_id":{"type":"string","x-stream-index":"012.001"},"voting_visibility":{"description":"Voting visibility","enum":["anonymous","public"],"title":"string","type":"string","x-stream-index":"006"}},"required":["id","name"],"type":"object"},"UpdateReminderRequest":{"nullable":true,"properties":{"remind_at":{"format":"date-time","type":"number","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"type":"object"},"UpdateReminderResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"001"}},"required":["reminder","duration"],"title":"Response","type":"object"},"UpdateThreadPartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"description":"Sets new field values","title":"Set","type":"object","x-stream-index":"004.001","x-stream-map":{"key":"field","title":"Value","description":"New value to set"}},"unset":{"description":"Array of field names to unset","items":{"type":"string"},"title":"Unset","type":"array","x-stream-index":"004.002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"type":"object"},"UpdateThreadPartialResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"thread":{"$ref":"#/components/schemas/ThreadResponse","description":"Updated thread (not enriched)","title":"Thread","x-stream-index":"001"}},"required":["thread","duration"],"type":"object"},"UpdateUserPartialRequest":{"properties":{"id":{"description":"User ID to update","title":"ID","type":"string","x-stream-index":"001"},"set":{"additionalProperties":{},"type":"object","x-stream-index":"002.001"},"unset":{"items":{"type":"string"},"type":"array","x-stream-index":"002.002"}},"required":["id"],"type":"object"},"UpdateUserPermissionsRequest":{"nullable":true,"properties":{"grant_permissions":{"items":{"type":"string"},"type":"array","x-stream-index":"002"},"revoke_permissions":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"user_id":{"type":"string","x-stream-index":"001"}},"required":["user_id"],"type":"object"},"UpdateUserPermissionsResponse":{"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"},"UpdateUsersPartialRequest":{"nullable":true,"properties":{"users":{"items":{"$ref":"#/components/schemas/UpdateUserPartialRequest"},"maximum":100,"type":"array","x-stream-index":"001"}},"required":["users"],"type":"object"},"UpdateUsersRequest":{"nullable":true,"properties":{"users":{"additionalProperties":{"$ref":"#/components/schemas/UserRequest"},"description":"Object containing users","title":"Users","type":"object","x-stream-index":"001","x-stream-map":{"key":"user_id"}}},"required":["users"],"type":"object"},"UpdateUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"membership_deletion_task_id":{"type":"string","x-stream-index":"002"},"users":{"additionalProperties":{"$ref":"#/components/schemas/FullUserResponse"},"description":"Object containing users","title":"Users","type":"object","x-stream-index":"001","x-stream-map":{"key":"user_id"}}},"required":["users","membership_deletion_task_id","duration"],"type":"object"},"UpdatedCallPermissionsEvent":{"description":"This event is sent to notify about permission changes for a user, clients receiving this event should update their UI accordingly","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"own_capabilities":{"description":"The capabilities of the current user","items":{"$ref":"#/components/schemas/OwnCapability"},"title":"Own capabilities","type":"array","x-stream-index":"004"},"type":{"default":"call.permissions_updated","description":"The type of event: \"call.permissions_updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who received the new permissions","title":"User","x-stream-index":"003"}},"required":["type","created_at","call_cid","user","own_capabilities"],"title":"UpdatedCallPermissionsEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"UpsertConfigRequest":{"nullable":true,"properties":{"ai_image_config":{"$ref":"#/components/schemas/AIImageConfig","description":"Configuration for AI image analysis","title":"AI Image Config","x-stream-index":"010"},"ai_text_config":{"$ref":"#/components/schemas/AITextConfig","description":"Configuration for AI text analysis","title":"AI Text Config","x-stream-index":"008"},"ai_video_config":{"$ref":"#/components/schemas/AIVideoConfig","description":"Configuration for AI video analysis","title":"AI Video Config","x-stream-index":"011"},"async":{"description":"Whether moderation should be performed asynchronously","title":"Async","type":"boolean","x-stream-index":"003"},"automod_platform_circumvention_config":{"$ref":"#/components/schemas/AutomodPlatformCircumventionConfig","description":"Configuration for platform circumvention detection","title":"Automod Platform Circumvention Config","x-stream-index":"005"},"automod_semantic_filters_config":{"$ref":"#/components/schemas/AutomodSemanticFiltersConfig","description":"Configuration for semantic filtering","title":"Automod Semantic Filters Config","x-stream-index":"006"},"automod_toxicity_config":{"$ref":"#/components/schemas/AutomodToxicityConfig","description":"Configuration for toxicity detection","title":"Automod Toxicity Config","x-stream-index":"004"},"aws_rekognition_config":{"$ref":"#/components/schemas/AIImageConfig","x-stream-index":"015"},"block_list_config":{"$ref":"#/components/schemas/BlockListConfig","description":"Configuration for block list filtering","title":"Block List Config","x-stream-index":"007"},"bodyguard_config":{"$ref":"#/components/schemas/AITextConfig","x-stream-index":"014"},"google_vision_config":{"$ref":"#/components/schemas/GoogleVisionConfig","description":"Configuration for Google Vision integration","title":"Google Vision Config","x-stream-index":"009"},"key":{"description":"Unique identifier for the moderation configuration","title":"Key","type":"string","x-stream-index":"001"},"rule_builder_config":{"$ref":"#/components/schemas/RuleBuilderConfig","description":"Configuration for custom rule builder (max 3 rules, max 5 conditions per rule)","title":"Rule Builder Config","x-stream-index":"013"},"team":{"description":"Team associated with the configuration","maxLength":128,"minLength":1,"title":"Team","type":"string","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"017.002"},"user_id":{"type":"string","x-stream-index":"017.001"},"velocity_filter_config":{"$ref":"#/components/schemas/VelocityFilterConfig","description":"Configuration for velocity-based filtering","title":"Velocity Filter Config","x-stream-index":"012"},"video_call_rule_config":{"$ref":"#/components/schemas/VideoCallRuleConfig","x-stream-index":"016"}},"required":["key"],"type":"object"},"UpsertConfigResponse":{"nullable":true,"properties":{"config":{"$ref":"#/components/schemas/ConfigResponse","description":"The created or updated moderation configuration","title":"Config","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["duration"],"type":"object"},"UpsertModerationTemplateRequest":{"nullable":true,"properties":{"config":{"$ref":"#/components/schemas/FeedsModerationTemplateConfig","description":"Configuration for the moderation template","title":"Config","x-stream-index":"002"},"name":{"description":"Name of the moderation template","title":"Name","type":"string","x-stream-index":"001"}},"required":["name","config"],"type":"object"},"UpsertModerationTemplateResponse":{"nullable":true,"properties":{"config":{"$ref":"#/components/schemas/FeedsModerationTemplateConfig","description":"Configuration for the moderation template","title":"Config","x-stream-index":"002"},"created_at":{"description":"When the template was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"003"},"duration":{"type":"string","x-stream-index":"005.001"},"name":{"description":"Name of the moderation template","title":"Name","type":"string","x-stream-index":"001"},"updated_at":{"description":"When the template was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"004"}},"required":["name","created_at","updated_at","duration"],"type":"object"},"UpsertPushPreferencesRequest":{"nullable":true,"properties":{"preferences":{"description":"A list of push preferences for channels, calls, or the user.","items":{"$ref":"#/components/schemas/PushPreferenceInput"},"type":"array","x-stream-index":"001"}},"required":["preferences"],"type":"object"},"UpsertPushPreferencesResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"user_channel_preferences":{"additionalProperties":{"additionalProperties":{"$ref":"#/components/schemas/ChannelPushPreferences"},"type":"object"},"description":"The channel specific push notification preferences, only returned for channels you've edited.","title":"User Channel Notification Preferences","type":"object","x-stream-index":"002"},"user_preferences":{"additionalProperties":{"$ref":"#/components/schemas/PushPreferences"},"description":"The user preferences, always returned regardless if you edited it","title":"User Preferences","type":"object","x-stream-index":"001"}},"required":["user_preferences","user_channel_preferences","duration"],"type":"object"},"UpsertPushProviderRequest":{"nullable":true,"properties":{"push_provider":{"$ref":"#/components/schemas/PushProvider","x-stream-index":"001"}},"type":"object"},"UpsertPushProviderResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"push_provider":{"$ref":"#/components/schemas/PushProviderResponse","x-stream-index":"001"}},"required":["push_provider","duration"],"title":"Response","type":"object"},"UpsertPushTemplateRequest":{"nullable":true,"properties":{"enable_push":{"description":"Whether to send push notification for this event","title":"boolean","type":"boolean","x-stream-index":"002"},"event_type":{"description":"Event type (message.new, message.updated, reaction.new)","enum":["message.new","message.updated","reaction.new","notification.reminder_due"],"title":"string","type":"string","x-stream-index":"003"},"push_provider_name":{"description":"Push provider name","title":"string","type":"string","x-stream-index":"004"},"push_provider_type":{"description":"Push provider type (firebase, apn)","enum":["firebase","apn"],"title":"string","type":"string","x-stream-index":"005"},"template":{"description":"Push template","title":"string","type":"string","x-stream-index":"006"}},"required":["event_type","push_provider_type"],"type":"object"},"UpsertPushTemplateResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"template":{"$ref":"#/components/schemas/PushTemplate","x-stream-index":"002"}},"required":["duration"],"title":"Response","type":"object"},"User":{"properties":{"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"046"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"017"},"banned":{"type":"boolean","x-stream-index":"016"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"013"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"023"},"language":{"type":"string","x-stream-index":"035"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"026"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"042"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"005"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"009"}},"required":["id","role","teams_role","custom","banned","online"],"type":"object"},"UserBannedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"006.002"},"channel_type":{"type":"string","x-stream-index":"006.003"},"cid":{"type":"string","x-stream-index":"006.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008.002"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"001"},"expiration":{"format":"date-time","type":"number","x-stream-index":"003"},"reason":{"type":"string","x-stream-index":"004"},"shadow":{"type":"boolean","x-stream-index":"002"},"team":{"type":"string","x-stream-index":"005.001"},"type":{"default":"user.banned","type":"string","x-stream-index":"008.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007.001"}},"required":["created_by","shadow","cid","channel_id","channel_type","type","created_at"],"title":"UserBannedEvent","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"},"UserCreatedWithinParameters":{"properties":{"max_age":{"type":"string","x-stream-index":"001"}},"type":"object"},"UserCustomEventRequest":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"001"}},"required":["type"],"type":"object"},"UserDeactivatedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"001"},"type":{"default":"user.deactivated","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["created_by","type","created_at"],"title":"UserDeactivatedEvent","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"},"UserDeletedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"delete_conversation_channels":{"type":"boolean","x-stream-index":"005"},"hard_delete":{"type":"boolean","x-stream-index":"003.001"},"mark_messages_deleted":{"type":"boolean","x-stream-index":"004"},"type":{"default":"user.deleted","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"001.001"}},"required":["type","created_at","hard_delete","mark_messages_deleted","delete_conversation_channels"],"title":"UserDeletedEvent","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"},"UserFeedbackReport":{"properties":{"count_by_rating":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001"},"unreported_count":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["count_by_rating","unreported_count"],"type":"object"},"UserFeedbackReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateUserFeedbackReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"UserFeedbackResponse":{"properties":{"cid":{"type":"string","x-stream-index":"001"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"009"},"platform":{"$ref":"#/components/schemas/PlatformDataResponse","x-stream-index":"008"},"rating":{"format":"int32","type":"integer","x-stream-index":"004"},"reason":{"type":"string","x-stream-index":"005"},"sdk":{"type":"string","x-stream-index":"006"},"sdk_version":{"type":"string","x-stream-index":"007"},"session_id":{"type":"string","x-stream-index":"002"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["cid","session_id","user_id","rating","reason","sdk","sdk_version","platform"],"type":"object"},"UserFlaggedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"target_user":{"type":"string","x-stream-index":"002"},"target_users":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"type":{"default":"user.flagged","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"001"}},"required":["type","created_at"],"title":"UserFlaggedEvent","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"},"UserMute":{"nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"expires":{"description":"Date/time of mute expiration","format":"date-time","title":"Expires","type":"number","x-stream-index":"008"},"target":{"$ref":"#/components/schemas/User","description":"User who's muted","title":"Target","x-stream-index":"007"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/User","description":"Owner of channel mute","title":"User","x-stream-index":"005"}},"required":["created_at","updated_at"],"type":"object"},"UserMuteResponse":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"expires":{"format":"date-time","type":"number","x-stream-index":"003"},"target":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"}},"required":["created_at","updated_at"],"type":"object"},"UserMutedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"target_user":{"type":"string","x-stream-index":"001"},"target_users":{"items":{"type":"string"},"type":"array","x-stream-index":"002"},"type":{"default":"user.muted","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"UserMutedEvent","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"},"UserRatingReportResponse":{"properties":{"average":{"format":"float","type":"number","x-stream-index":"002"},"count":{"format":"int32","type":"integer","x-stream-index":"001"}},"required":["count","average"],"type":"object"},"UserReactivatedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"type":{"default":"user.reactivated","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"001"}},"required":["type","created_at"],"title":"UserReactivatedEvent","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"},"UserRequest":{"description":"User request object","properties":{"custom":{"additionalProperties":{},"description":"Custom user data","title":"Custom","type":"object","x-stream-index":"004"},"id":{"description":"User ID","title":"ID","type":"string","x-stream-index":"001"},"image":{"description":"User's profile image URL","title":"Image","type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"006"},"language":{"type":"string","x-stream-index":"005"},"name":{"description":"Optional name of user","title":"Name","type":"string","x-stream-index":"002"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"007"},"role":{"description":"User's global role","title":"Role","type":"string","x-stream-index":"008"},"teams":{"description":"List of teams the user belongs to","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"010"},"teams_role":{"additionalProperties":{"type":"string"},"description":"Map of team-specific roles for the user","title":"TeamsRole","type":"object","x-stream-index":"009"}},"required":["id"],"title":"UserRequest","type":"object"},"UserResponse":{"description":"User response object","properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"ban_expires":{"description":"Date when ban expires","format":"date-time","title":"Ban expires","type":"number","x-stream-index":"003"},"banned":{"description":"Whether a user is banned or not","title":"Banned","type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.017"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"001.004"},"deactivated_at":{"description":"Date of deactivation","format":"date-time","title":"Deactivated at","type":"number","x-stream-index":"001.016"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"001.011"},"devices":{"description":"List of devices user is using","items":{"$ref":"#/components/schemas/DeviceResponse"},"title":"Devices","type":"array","x-stream-index":"006"},"id":{"description":"Unique user identifier","title":"ID","type":"string","x-stream-index":"001.001"},"image":{"title":"Image","type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"007"},"language":{"description":"Preferred language of a user","title":"Language","type":"string","x-stream-index":"001.005"},"last_active":{"description":"Date of last activity","format":"date-time","title":"Last active","type":"number","x-stream-index":"001.014"},"name":{"description":"Optional name of user","title":"Name","type":"string","x-stream-index":"001.002"},"online":{"description":"Whether a user online or not","title":"Online","type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","description":"User privacy settings","title":"Privacy settings","x-stream-index":"005"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettingsResponse","description":"User push notification settings","title":"Push notifications","x-stream-index":"004"},"revoke_tokens_issued_before":{"description":"Revocation date for tokens","format":"date-time","title":"Revoke tokens issued before","type":"number","x-stream-index":"001.015"},"role":{"description":"Determines the set of user permissions","title":"Role","type":"string","x-stream-index":"001.006"},"shadow_banned":{"description":"Whether a user is shadow banned","title":"Shadow banned","type":"boolean","x-stream-index":"002"},"teams":{"description":"List of teams user is a part of","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids","shadow_banned","invisible"],"title":"UserResponse","type":"object"},"UserResponseCommonFields":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"018"},"banned":{"type":"boolean","x-stream-index":"012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"017"},"created_at":{"format":"date-time","type":"number","x-stream-index":"009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"id":{"type":"string","x-stream-index":"001"},"image":{"type":"string","x-stream-index":"003"},"language":{"type":"string","x-stream-index":"005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"014"},"name":{"type":"string","x-stream-index":"002"},"online":{"type":"boolean","x-stream-index":"013"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"015"},"role":{"type":"string","x-stream-index":"006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids"],"type":"object"},"UserResponsePrivacyFields":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"banned":{"type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.017"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.011"},"id":{"type":"string","x-stream-index":"001.001"},"image":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"003"},"language":{"type":"string","x-stream-index":"001.005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"001.014"},"name":{"type":"string","x-stream-index":"001.002"},"online":{"type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"002"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.015"},"role":{"type":"string","x-stream-index":"001.006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids"],"type":"object"},"UserRuleParameters":{"properties":{"max_age":{"type":"string","x-stream-index":"001"}},"type":"object"},"UserUnbannedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"005.002"},"shadow":{"type":"boolean","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"004.001"},"type":{"default":"user.unbanned","type":"string","x-stream-index":"005.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["shadow","cid","channel_id","channel_type","type","created_at"],"title":"UserUnbannedEvent","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"},"UserUnmutedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"target_user":{"type":"string","x-stream-index":"002"},"target_users":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"type":{"default":"user.unmuted","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"001"}},"required":["type","created_at"],"title":"UserUnmutedEvent","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"},"UserUnreadReminderEvent":{"properties":{"channels":{"additionalProperties":{"$ref":"#/components/schemas/ChannelMessages"},"type":"object","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"user.unread_message_reminder","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002"}},"required":["type","created_at","channels"],"title":"UserUnreadReminderEvent","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"},"UserUpdatedEvent":{"description":"This event is sent when a user gets updated. The event contains information about the updated user.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"type":{"default":"user.updated","description":"The type of event: \"user.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.002"},"user":{"$ref":"#/components/schemas/UserResponsePrivacyFields","description":"The updated user","title":"User","x-stream-index":"002.001"}},"required":["type","created_at","custom","user"],"title":"UserUpdatedEvent","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"},"VelocityFilterConfig":{"properties":{"advanced_filters":{"type":"boolean","x-stream-index":"007"},"async":{"type":"boolean","x-stream-index":"001"},"cascading_actions":{"type":"boolean","x-stream-index":"004"},"cids_per_user":{"format":"int32","type":"integer","x-stream-index":"006"},"enabled":{"type":"boolean","x-stream-index":"002"},"first_message_only":{"type":"boolean","x-stream-index":"005"},"rules":{"items":{"$ref":"#/components/schemas/VelocityFilterConfigRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules","cascading_actions","first_message_only","cids_per_user","advanced_filters"],"type":"object"},"VelocityFilterConfigRule":{"properties":{"action":{"enum":["flag","shadow","remove","ban"],"type":"string","x-stream-index":"001"},"ban_duration":{"format":"int32","type":"integer","x-stream-index":"002"},"cascading_action":{"enum":["flag","shadow","remove","ban"],"type":"string","x-stream-index":"006"},"cascading_threshold":{"format":"int64","type":"integer","x-stream-index":"005"},"check_message_context":{"type":"boolean","x-stream-index":"009"},"fast_spam_threshold":{"format":"int32","type":"integer","x-stream-index":"007"},"fast_spam_ttl":{"format":"int32","type":"integer","x-stream-index":"010"},"ip_ban":{"type":"boolean","x-stream-index":"004"},"probation_period":{"format":"int32","type":"integer","x-stream-index":"014"},"shadow_ban":{"type":"boolean","x-stream-index":"003"},"slow_spam_ban_duration":{"format":"int32","type":"integer","x-stream-index":"012"},"slow_spam_threshold":{"format":"int32","type":"integer","x-stream-index":"008"},"slow_spam_ttl":{"format":"int32","type":"integer","x-stream-index":"011"},"url_only":{"type":"boolean","x-stream-index":"013"}},"required":["action","ban_duration","shadow_ban","ip_ban","cascading_threshold","cascading_action","fast_spam_threshold","slow_spam_threshold","check_message_context","fast_spam_ttl","slow_spam_ttl","url_only","probation_period"],"type":"object"},"VideoCallRuleConfig":{"properties":{"rules":{"additionalProperties":{"$ref":"#/components/schemas/HarmConfig"},"type":"object","x-stream-index":"001"}},"required":["rules"],"type":"object"},"VideoContentParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"type":"object"},"VideoEndCallRequest":{"type":"object"},"VideoKickUserRequest":{"type":"object"},"VideoOrientation":{"properties":{"orientation":{"type":"integer","x-stream-index":"004"}},"type":"object"},"VideoReactionOverTimeResponse":{"properties":{"by_minute":{"items":{"$ref":"#/components/schemas/CountByMinuteResponse"},"type":"array","x-stream-index":"001"}},"type":"object"},"VideoReactionsResponse":{"nullable":true,"properties":{"count_over_time":{"$ref":"#/components/schemas/VideoReactionOverTimeResponse","x-stream-index":"002"},"reaction":{"type":"string","x-stream-index":"001"}},"required":["reaction"],"type":"object"},"VideoRuleParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"required":["threshold","time_window"],"type":"object"},"VideoSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"camera_default_on":{"type":"boolean","x-stream-index":"004"},"camera_facing":{"enum":["front","back","external"],"type":"string","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled","target_resolution","camera_default_on","camera_facing"],"type":"object"},"VideoSettingsRequest":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"camera_default_on":{"type":"boolean","x-stream-index":"004"},"camera_facing":{"enum":["front","back","external"],"type":"string","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"type":"object"},"VideoSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"camera_default_on":{"type":"boolean","x-stream-index":"004"},"camera_facing":{"enum":["front","back","external"],"type":"string","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled","target_resolution","camera_default_on","camera_facing"],"type":"object"},"VoteData":{"properties":{"answer_text":{"type":"string","x-stream-index":"002"},"option_id":{"maxLength":255,"type":"string","x-stream-index":"001"}},"type":"object"},"WSEvent":{"description":"Represents an BaseEvent that happened in Stream Chat","properties":{"automoderation":{"type":"boolean","x-stream-index":"023"},"automoderation_scores":{"$ref":"#/components/schemas/ModerationResponse","x-stream-index":"024"},"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"011"},"channel_id":{"type":"string","x-stream-index":"004"},"channel_last_message_at":{"format":"date-time","type":"number","x-stream-index":"007"},"channel_type":{"type":"string","x-stream-index":"005"},"cid":{"type":"string","x-stream-index":"003"},"connection_id":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"028"},"created_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"022"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"027"},"me":{"$ref":"#/components/schemas/OwnUserResponse","x-stream-index":"019"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"014"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"008"},"message_update":{"$ref":"#/components/schemas/MessageUpdate","x-stream-index":"009"},"parent_id":{"type":"string","x-stream-index":"025"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"015"},"poll_vote":{"$ref":"#/components/schemas/PollVoteResponseData","x-stream-index":"016"},"reaction":{"$ref":"#/components/schemas/ReactionResponse","x-stream-index":"010"},"reason":{"type":"string","x-stream-index":"021"},"team":{"type":"string","x-stream-index":"026"},"thread":{"$ref":"#/components/schemas/ThreadResponse","x-stream-index":"013"},"thread_id":{"type":"string","x-stream-index":"012"},"type":{"type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"017"},"user_id":{"type":"string","x-stream-index":"018"},"watcher_count":{"format":"int32","type":"integer","x-stream-index":"020"}},"required":["type","custom","created_at"],"title":"Event","type":"object","x-stream-docs-page-id":"event_object"},"WebhookEvent":{"description":"The discriminator object for all webhook events, it maps events' payload to the final type","discriminator":{"mapping":{"*":"#/components/schemas/AnyEvent","activity.marked":"#/components/schemas/ActivityMarkedEvent","call.accepted":"#/components/schemas/CallAcceptedEvent","call.blocked_user":"#/components/schemas/BlockedUserEvent","call.closed_caption":"#/components/schemas/ClosedCaptionEvent","call.closed_captions_failed":"#/components/schemas/CallClosedCaptionsFailedEvent","call.closed_captions_started":"#/components/schemas/CallClosedCaptionsStartedEvent","call.closed_captions_stopped":"#/components/schemas/CallClosedCaptionsStoppedEvent","call.created":"#/components/schemas/CallCreatedEvent","call.deleted":"#/components/schemas/CallDeletedEvent","call.ended":"#/components/schemas/CallEndedEvent","call.frame_recording_failed":"#/components/schemas/CallFrameRecordingFailedEvent","call.frame_recording_ready":"#/components/schemas/CallFrameRecordingFrameReadyEvent","call.frame_recording_started":"#/components/schemas/CallFrameRecordingStartedEvent","call.frame_recording_stopped":"#/components/schemas/CallFrameRecordingStoppedEvent","call.hls_broadcasting_failed":"#/components/schemas/CallHLSBroadcastingFailedEvent","call.hls_broadcasting_started":"#/components/schemas/CallHLSBroadcastingStartedEvent","call.hls_broadcasting_stopped":"#/components/schemas/CallHLSBroadcastingStoppedEvent","call.live_started":"#/components/schemas/CallLiveStartedEvent","call.member_added":"#/components/schemas/CallMemberAddedEvent","call.member_removed":"#/components/schemas/CallMemberRemovedEvent","call.member_updated":"#/components/schemas/CallMemberUpdatedEvent","call.member_updated_permission":"#/components/schemas/CallMemberUpdatedPermissionEvent","call.missed":"#/components/schemas/CallMissedEvent","call.moderation_blur":"#/components/schemas/CallModerationBlurEvent","call.moderation_warning":"#/components/schemas/CallModerationWarningEvent","call.notification":"#/components/schemas/CallNotificationEvent","call.permission_request":"#/components/schemas/PermissionRequestEvent","call.permissions_updated":"#/components/schemas/UpdatedCallPermissionsEvent","call.reaction_new":"#/components/schemas/CallReactionEvent","call.recording_failed":"#/components/schemas/CallRecordingFailedEvent","call.recording_ready":"#/components/schemas/CallRecordingReadyEvent","call.recording_started":"#/components/schemas/CallRecordingStartedEvent","call.recording_stopped":"#/components/schemas/CallRecordingStoppedEvent","call.rejected":"#/components/schemas/CallRejectedEvent","call.ring":"#/components/schemas/CallRingEvent","call.rtmp_broadcast_failed":"#/components/schemas/CallRtmpBroadcastFailedEvent","call.rtmp_broadcast_started":"#/components/schemas/CallRtmpBroadcastStartedEvent","call.rtmp_broadcast_stopped":"#/components/schemas/CallRtmpBroadcastStoppedEvent","call.session_ended":"#/components/schemas/CallSessionEndedEvent","call.session_participant_count_updated":"#/components/schemas/CallSessionParticipantCountsUpdatedEvent","call.session_participant_joined":"#/components/schemas/CallSessionParticipantJoinedEvent","call.session_participant_left":"#/components/schemas/CallSessionParticipantLeftEvent","call.session_started":"#/components/schemas/CallSessionStartedEvent","call.stats_report_ready":"#/components/schemas/CallStatsReportReadyEvent","call.transcription_failed":"#/components/schemas/CallTranscriptionFailedEvent","call.transcription_ready":"#/components/schemas/CallTranscriptionReadyEvent","call.transcription_started":"#/components/schemas/CallTranscriptionStartedEvent","call.transcription_stopped":"#/components/schemas/CallTranscriptionStoppedEvent","call.unblocked_user":"#/components/schemas/UnblockedUserEvent","call.updated":"#/components/schemas/CallUpdatedEvent","call.user_feedback_submitted":"#/components/schemas/CallUserFeedbackSubmittedEvent","call.user_muted":"#/components/schemas/CallUserMutedEvent","campaign.completed":"#/components/schemas/CampaignCompletedEvent","campaign.started":"#/components/schemas/CampaignStartedEvent","channel.created":"#/components/schemas/ChannelCreatedEvent","channel.deleted":"#/components/schemas/ChannelDeletedEvent","channel.frozen":"#/components/schemas/ChannelFrozenEvent","channel.hidden":"#/components/schemas/ChannelHiddenEvent","channel.muted":"#/components/schemas/ChannelMutedEvent","channel.truncated":"#/components/schemas/ChannelTruncatedEvent","channel.unfrozen":"#/components/schemas/ChannelUnFrozenEvent","channel.unmuted":"#/components/schemas/ChannelUnmutedEvent","channel.updated":"#/components/schemas/ChannelUpdatedEvent","channel.visible":"#/components/schemas/ChannelVisibleEvent","custom":"#/components/schemas/CustomVideoEvent","export.bulk_image_moderation.error":"#/components/schemas/AsyncExportErrorEvent","export.bulk_image_moderation.success":"#/components/schemas/AsyncBulkImageModerationEvent","export.channels.error":"#/components/schemas/AsyncExportErrorEvent","export.channels.success":"#/components/schemas/AsyncExportChannelsEvent","export.moderation_logs.error":"#/components/schemas/AsyncExportErrorEvent","export.moderation_logs.success":"#/components/schemas/AsyncExportModerationLogsEvent","export.users.error":"#/components/schemas/AsyncExportErrorEvent","export.users.success":"#/components/schemas/AsyncExportUsersEvent","flag.updated":"#/components/schemas/FlagUpdatedEvent","member.added":"#/components/schemas/MemberAddedEvent","member.removed":"#/components/schemas/MemberRemovedEvent","member.updated":"#/components/schemas/MemberUpdatedEvent","message.deleted":"#/components/schemas/MessageDeletedEvent","message.flagged":"#/components/schemas/MessageFlaggedEvent","message.new":"#/components/schemas/MessageNewEvent","message.pending":"#/components/schemas/PendingMessageEvent","message.read":"#/components/schemas/MessageReadEvent","message.unblocked":"#/components/schemas/MessageUnblockedEvent","message.undeleted":"#/components/schemas/MessageUndeletedEvent","message.updated":"#/components/schemas/MessageUpdatedEvent","moderation.custom_action":"#/components/schemas/ModerationCustomActionEvent","moderation.flagged":"#/components/schemas/ModerationFlaggedEvent","moderation.mark_reviewed":"#/components/schemas/ModerationMarkReviewedEvent","moderation_check.completed":"#/components/schemas/ModerationCheckCompletedEvent","notification.mark_unread":"#/components/schemas/NotificationMarkUnreadEvent","notification.reminder_due":"#/components/schemas/ReminderNotificationEvent","notification.thread_message_new":"#/components/schemas/MessageNewEvent","reaction.deleted":"#/components/schemas/ReactionDeletedEvent","reaction.new":"#/components/schemas/ReactionNewEvent","reaction.updated":"#/components/schemas/ReactionUpdatedEvent","reminder.created":"#/components/schemas/ReminderCreatedEvent","reminder.deleted":"#/components/schemas/ReminderDeletedEvent","reminder.updated":"#/components/schemas/ReminderUpdatedEvent","review_queue_item.new":"#/components/schemas/ReviewQueueItemNewEvent","review_queue_item.updated":"#/components/schemas/ReviewQueueItemUpdatedEvent","thread.updated":"#/components/schemas/ThreadUpdatedEvent","user.banned":"#/components/schemas/UserBannedEvent","user.deactivated":"#/components/schemas/UserDeactivatedEvent","user.deleted":"#/components/schemas/UserDeletedEvent","user.flagged":"#/components/schemas/UserFlaggedEvent","user.muted":"#/components/schemas/UserMutedEvent","user.reactivated":"#/components/schemas/UserReactivatedEvent","user.unbanned":"#/components/schemas/UserUnbannedEvent","user.unmuted":"#/components/schemas/UserUnmutedEvent","user.unread_message_reminder":"#/components/schemas/UserUnreadReminderEvent","user.updated":"#/components/schemas/UserUpdatedEvent"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/ActivityMarkedEvent"},{"$ref":"#/components/schemas/AnyEvent"},{"$ref":"#/components/schemas/AsyncBulkImageModerationEvent"},{"$ref":"#/components/schemas/AsyncExportChannelsEvent"},{"$ref":"#/components/schemas/AsyncExportErrorEvent"},{"$ref":"#/components/schemas/AsyncExportErrorEvent"},{"$ref":"#/components/schemas/AsyncExportErrorEvent"},{"$ref":"#/components/schemas/AsyncExportErrorEvent"},{"$ref":"#/components/schemas/AsyncExportModerationLogsEvent"},{"$ref":"#/components/schemas/AsyncExportUsersEvent"},{"$ref":"#/components/schemas/BlockedUserEvent"},{"$ref":"#/components/schemas/CallAcceptedEvent"},{"$ref":"#/components/schemas/CallClosedCaptionsFailedEvent"},{"$ref":"#/components/schemas/CallClosedCaptionsStartedEvent"},{"$ref":"#/components/schemas/CallClosedCaptionsStoppedEvent"},{"$ref":"#/components/schemas/CallCreatedEvent"},{"$ref":"#/components/schemas/CallDeletedEvent"},{"$ref":"#/components/schemas/CallEndedEvent"},{"$ref":"#/components/schemas/CallFrameRecordingFailedEvent"},{"$ref":"#/components/schemas/CallFrameRecordingFrameReadyEvent"},{"$ref":"#/components/schemas/CallFrameRecordingStartedEvent"},{"$ref":"#/components/schemas/CallFrameRecordingStoppedEvent"},{"$ref":"#/components/schemas/CallHLSBroadcastingFailedEvent"},{"$ref":"#/components/schemas/CallHLSBroadcastingStartedEvent"},{"$ref":"#/components/schemas/CallHLSBroadcastingStoppedEvent"},{"$ref":"#/components/schemas/CallLiveStartedEvent"},{"$ref":"#/components/schemas/CallMemberAddedEvent"},{"$ref":"#/components/schemas/CallMemberRemovedEvent"},{"$ref":"#/components/schemas/CallMemberUpdatedEvent"},{"$ref":"#/components/schemas/CallMemberUpdatedPermissionEvent"},{"$ref":"#/components/schemas/CallMissedEvent"},{"$ref":"#/components/schemas/CallModerationBlurEvent"},{"$ref":"#/components/schemas/CallModerationWarningEvent"},{"$ref":"#/components/schemas/CallNotificationEvent"},{"$ref":"#/components/schemas/CallReactionEvent"},{"$ref":"#/components/schemas/CallRecordingFailedEvent"},{"$ref":"#/components/schemas/CallRecordingReadyEvent"},{"$ref":"#/components/schemas/CallRecordingStartedEvent"},{"$ref":"#/components/schemas/CallRecordingStoppedEvent"},{"$ref":"#/components/schemas/CallRejectedEvent"},{"$ref":"#/components/schemas/CallRingEvent"},{"$ref":"#/components/schemas/CallRtmpBroadcastFailedEvent"},{"$ref":"#/components/schemas/CallRtmpBroadcastStartedEvent"},{"$ref":"#/components/schemas/CallRtmpBroadcastStoppedEvent"},{"$ref":"#/components/schemas/CallSessionEndedEvent"},{"$ref":"#/components/schemas/CallSessionParticipantCountsUpdatedEvent"},{"$ref":"#/components/schemas/CallSessionParticipantJoinedEvent"},{"$ref":"#/components/schemas/CallSessionParticipantLeftEvent"},{"$ref":"#/components/schemas/CallSessionStartedEvent"},{"$ref":"#/components/schemas/CallStatsReportReadyEvent"},{"$ref":"#/components/schemas/CallTranscriptionFailedEvent"},{"$ref":"#/components/schemas/CallTranscriptionReadyEvent"},{"$ref":"#/components/schemas/CallTranscriptionStartedEvent"},{"$ref":"#/components/schemas/CallTranscriptionStoppedEvent"},{"$ref":"#/components/schemas/CallUpdatedEvent"},{"$ref":"#/components/schemas/CallUserFeedbackSubmittedEvent"},{"$ref":"#/components/schemas/CallUserMutedEvent"},{"$ref":"#/components/schemas/CampaignCompletedEvent"},{"$ref":"#/components/schemas/CampaignStartedEvent"},{"$ref":"#/components/schemas/ChannelCreatedEvent"},{"$ref":"#/components/schemas/ChannelDeletedEvent"},{"$ref":"#/components/schemas/ChannelFrozenEvent"},{"$ref":"#/components/schemas/ChannelHiddenEvent"},{"$ref":"#/components/schemas/ChannelMutedEvent"},{"$ref":"#/components/schemas/ChannelTruncatedEvent"},{"$ref":"#/components/schemas/ChannelUnFrozenEvent"},{"$ref":"#/components/schemas/ChannelUnmutedEvent"},{"$ref":"#/components/schemas/ChannelUpdatedEvent"},{"$ref":"#/components/schemas/ChannelVisibleEvent"},{"$ref":"#/components/schemas/ClosedCaptionEvent"},{"$ref":"#/components/schemas/CustomVideoEvent"},{"$ref":"#/components/schemas/FlagUpdatedEvent"},{"$ref":"#/components/schemas/MemberAddedEvent"},{"$ref":"#/components/schemas/MemberRemovedEvent"},{"$ref":"#/components/schemas/MemberUpdatedEvent"},{"$ref":"#/components/schemas/MessageDeletedEvent"},{"$ref":"#/components/schemas/MessageFlaggedEvent"},{"$ref":"#/components/schemas/MessageNewEvent"},{"$ref":"#/components/schemas/MessageNewEvent"},{"$ref":"#/components/schemas/MessageReadEvent"},{"$ref":"#/components/schemas/MessageUnblockedEvent"},{"$ref":"#/components/schemas/MessageUndeletedEvent"},{"$ref":"#/components/schemas/MessageUpdatedEvent"},{"$ref":"#/components/schemas/ModerationCheckCompletedEvent"},{"$ref":"#/components/schemas/ModerationCustomActionEvent"},{"$ref":"#/components/schemas/ModerationFlaggedEvent"},{"$ref":"#/components/schemas/ModerationMarkReviewedEvent"},{"$ref":"#/components/schemas/NotificationMarkUnreadEvent"},{"$ref":"#/components/schemas/PendingMessageEvent"},{"$ref":"#/components/schemas/PermissionRequestEvent"},{"$ref":"#/components/schemas/ReactionDeletedEvent"},{"$ref":"#/components/schemas/ReactionNewEvent"},{"$ref":"#/components/schemas/ReactionUpdatedEvent"},{"$ref":"#/components/schemas/ReminderCreatedEvent"},{"$ref":"#/components/schemas/ReminderDeletedEvent"},{"$ref":"#/components/schemas/ReminderNotificationEvent"},{"$ref":"#/components/schemas/ReminderUpdatedEvent"},{"$ref":"#/components/schemas/ReviewQueueItemNewEvent"},{"$ref":"#/components/schemas/ReviewQueueItemUpdatedEvent"},{"$ref":"#/components/schemas/ThreadUpdatedEvent"},{"$ref":"#/components/schemas/UnblockedUserEvent"},{"$ref":"#/components/schemas/UpdatedCallPermissionsEvent"},{"$ref":"#/components/schemas/UserBannedEvent"},{"$ref":"#/components/schemas/UserDeactivatedEvent"},{"$ref":"#/components/schemas/UserDeletedEvent"},{"$ref":"#/components/schemas/UserFlaggedEvent"},{"$ref":"#/components/schemas/UserMutedEvent"},{"$ref":"#/components/schemas/UserReactivatedEvent"},{"$ref":"#/components/schemas/UserUnbannedEvent"},{"$ref":"#/components/schemas/UserUnmutedEvent"},{"$ref":"#/components/schemas/UserUnreadReminderEvent"},{"$ref":"#/components/schemas/UserUpdatedEvent"}]},"WrappedUnreadCountsResponse":{"description":"Basic response information","nullable":true,"properties":{"channel_type":{"items":{"$ref":"#/components/schemas/UnreadCountsChannelType"},"type":"array","x-stream-index":"001.005"},"channels":{"items":{"$ref":"#/components/schemas/UnreadCountsChannel"},"type":"array","x-stream-index":"001.004"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"threads":{"items":{"$ref":"#/components/schemas/UnreadCountsThread"},"type":"array","x-stream-index":"001.006"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"001.001"},"total_unread_count_by_team":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001.003"},"total_unread_threads_count":{"format":"int32","type":"integer","x-stream-index":"001.002"}},"required":["total_unread_count","total_unread_threads_count","channels","channel_type","threads","duration"],"title":"Response","type":"object"},"XiaomiConfig":{"properties":{"Disabled":{"type":"boolean","writeOnly":true,"x-stream-index":"003"},"package_name":{"type":"string","x-stream-index":"001"},"secret":{"type":"string","x-stream-index":"002"}},"type":"object"},"XiaomiConfigFields":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"package_name":{"type":"string","x-stream-index":"002"},"secret":{"type":"string","x-stream-index":"003"}},"required":["enabled"],"type":"object"}},"securitySchemes":{"JWT":{"description":"JWT should be always provided when stream-auth-type=jwt.\n\nUsing JWT auth request could be authenticated as user or as server-side.\n\nWhen using user authentication permission checking is going to be applied to requests based on the user that is\nperforming a request.\n\nThe `authorization` header should be a JWT string signed using the secret attached to the API key used to perform\nrequests.\n\n**WARNING** all client-side official SDK do not ship with token generation; this is to make sure that the API secret is not\nshared with an untrusted party such as a browser or a iOS/Android application. Tokens **must** be generated server-side.\nIf you wish, you can configure your application to ignore authentication (see `disable_auth_check`)\nThe JWT string must include only the user_id claim and can include any built-in JWT claim such as iat, exp as well.\n","in":"header","name":"Authorization","type":"apiKey"},"api_key":{"description":"Application API key should be always set in order to authenticate the request.","in":"query","name":"api_key","type":"apiKey"},"stream-auth-type":{"description":"Stream-Auth-Type should be always set in order to authenticate the request. Possible\nvalues: `jwt` or `anonymous`.\n\n`jwt` allows you to authenticate as a user. With this auth type you should also provide valid JWT in Authorization\nheader.\n\n`anonymous` allows you to authenticate as anonymous user. Please note that most advanced features are not available\nto anonymous users.","in":"header","name":"Stream-Auth-Type","type":"apiKey"}}},"info":{"title":"Stream API","version":"v187.13.0"},"openapi":"3.0.3","paths":{"/api/v2/app":{"get":{"description":"This Method returns the application settings\n","operationId":"GetApp","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetApplicationResponse"}}},"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":"Get App Settings","tags":["product:common"]},"patch":{"description":"This Method updates one or more application settings\n","operationId":"UpdateApp","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAppRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Update App Settings","tags":["product:common"]}},"/api/v2/blocklists":{"get":{"description":"Returns all available block lists\n","operationId":"ListBlockLists","parameters":[{"in":"query","name":"team","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListBlockListResponse"}}},"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":"List block lists","tags":["product:common"]},"post":{"description":"Creates a new application blocklist, once created the blocklist can be used by any channel type\n","operationId":"CreateBlockList","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBlockListRequest"}}},"description":"Block list","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBlockListResponse"}}},"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":"Create block list","tags":["product:common"]}},"/api/v2/blocklists/{name}":{"delete":{"description":"Deletes previously created application blocklist\n","operationId":"DeleteBlockList","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"team","schema":{"type":"string","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete block list","tags":["product:common"]},"get":{"description":"Returns block list by given name\n","operationId":"GetBlockList","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Block list name","title":"Name","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"team","schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBlockListResponse"}}},"description":"GetBlockListResponse"},"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":"Get block list","tags":["product:common"]},"put":{"description":"Updates contents of the block list\n","operationId":"UpdateBlockList","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Block list name","title":"Name","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBlockListRequest"}}},"description":"Update block list","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBlockListResponse"}}},"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":"Update block list","tags":["product:common"]}},"/api/v2/chat/campaigns/query":{"post":{"description":"Query campaigns with filter query\n","operationId":"QueryCampaigns","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCampaignsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCampaignsResponse"}}},"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":"Query campaigns","tags":["product:chat"]}},"/api/v2/chat/campaigns/{id}":{"get":{"description":"Get campaign by ID.\n","operationId":"GetCampaign","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"The ID of the campaign (uuid)","maxLength":255,"title":"Campaign ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"prev","schema":{"description":"Token for the previous page of campaign users","title":"Previous Users Page","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"query","name":"next","schema":{"description":"Token for the next page of campaign users","title":"Next Users Page","type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"limit","schema":{"description":"Maximum number of campaign users to return in a single request (max: 1000)","format":"int32","maximum":1000,"minimum":0,"title":"Users Limit","type":"integer","writeOnly":true,"x-stream-index":"002.003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCampaignResponse"}}},"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":"Get campaign","tags":["product:chat"]}},"/api/v2/chat/campaigns/{id}/start":{"post":{"description":"Starts or schedules a campaign\n","operationId":"StartCampaign","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartCampaignRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartCampaignResponse"}}},"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":"Start/schedule campaign","tags":["product:chat"]}},"/api/v2/chat/campaigns/{id}/stop":{"post":{"description":"Stops a campaign\n","operationId":"ScheduleCampaign","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopCampaignRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignResponse"}}},"description":"Successful 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":"Stop campaign","tags":["product:chat"]}},"/api/v2/chat/channels":{"post":{"description":"Query channels with filter query\n","operationId":"QueryChannels","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryChannelsRequest"}}},"description":"Query Channels Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryChannelsResponse"}}},"description":"Channels list"},"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":"Query channels","tags":["product:chat"]}},"/api/v2/chat/channels/delete":{"post":{"description":"Allows to delete several channels at once asynchronously\n\nSends events:\n- channel.deleted\n- channel.deleted\n","operationId":"DeleteChannels","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteChannelsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteChannelsResponse"}}},"description":"Successful 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":"Deletes channels asynchronously","tags":["product:chat"]}},"/api/v2/chat/channels/read":{"post":{"description":"Marks channels as read up to the specific message. If no channels is given, mark all channel as read\n\nSends events:\n- message.read\n- message.read\n","operationId":"MarkChannelsRead","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkChannelsReadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkReadResponse"}}},"description":"Successful 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 channels as read","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/query":{"post":{"description":"This Method creates a channel or returns an existing one with matching attributes\n\nSends events:\n- channel.created\n- member.added\n- member.removed\n- member.updated\n- user.watching.start\n","operationId":"GetOrCreateDistinctChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelGetOrCreateRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelStateResponse"}}},"description":"Successful 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":"Get or create channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}":{"delete":{"description":"Deletes channel\n\nSends events:\n- channel.deleted\n- channel.deleted\n","operationId":"DeleteChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"query","name":"hard_delete","schema":{"type":"boolean","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteChannelResponse"}}},"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":"Delete channel","tags":["product:chat"]},"patch":{"description":"Updates certain fields of the channel\n\nSends events:\n- channel.updated\n- channel.updated\n","operationId":"UpdateChannelPartial","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelPartialRequest"}}},"description":"UpdateChannelPartialRequest","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelPartialResponse"}}},"description":"Successful 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":"Partially update channel","tags":["product:chat"]},"post":{"description":"Change channel data\n\nSends events:\n- channel.updated\n- member.added\n- member.removed\n- member.updated\n- message.new\n- channel.updated\n- member.added\n- member.removed\n- member.updated\n- message.new\n","operationId":"UpdateChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"013.002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"013.002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelRequest"}}},"description":"Channel update request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelResponse"}}},"description":"Successful 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":"Update channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/draft":{"delete":{"description":"Deletes a draft\n\nSends events:\n- draft.deleted\n","operationId":"DeleteDraft","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"parent_id","schema":{"description":"Parent message ID","title":"string","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"003.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete draft","tags":["product:chat"]},"get":{"description":"Get a draft\n","operationId":"GetDraft","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"parent_id","schema":{"description":"Parent message ID","title":"string","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"003.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetDraftResponse"}}},"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":"Get draft","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/event":{"post":{"description":"Sends event to the channel\n","operationId":"SendEvent","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendEventRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventResponse"}}},"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":"Send event","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/file":{"delete":{"description":"Deletes previously uploaded file\n","operationId":"DeleteFile","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of file","title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"File ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"url","schema":{"description":"File URL to delete","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete file","tags":["product:chat"]},"post":{"description":"Uploads file\n","operationId":"UploadFile","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/FileUploadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileUploadResponse"}}},"description":"Successful 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":"Upload file","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/hide":{"post":{"description":"Marks channel as hidden for current user\n\nSends events:\n- channel.hidden\n- channel.hidden\n","operationId":"HideChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HideChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HideChannelResponse"}}},"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":"Hide channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/image":{"delete":{"description":"Deletes previously uploaded image\n","operationId":"DeleteImage","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of file","title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"File ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"url","schema":{"description":"File URL to delete","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete image","tags":["product:chat"]},"post":{"description":"Uploads image\n","operationId":"UploadImage","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.001.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.001.002"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/ImageUploadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageUploadResponse"}}},"description":"Successful 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":"Upload image","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/member":{"patch":{"description":"\n","operationId":"UpdateMemberPartial","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"005.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMemberPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMemberPartialResponse"}}},"description":"Successful 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":"Partially channel member update","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/message":{"post":{"description":"Sends new message to the specified channel\n\nSends events:\n- message.new\n- message.updated\n- message.new\n- message.updated\n","operationId":"SendMessage","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"009.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"009.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendMessageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendMessageResponse"}}},"description":"Successful 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":"Send new message","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/messages":{"get":{"description":"Returns list messages found by IDs\n","operationId":"GetManyMessages","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"ids","required":true,"schema":{"description":"List of comma-separated IDs","items":{"type":"string"},"maximum":50,"minimum":1,"title":"IDs","type":"array","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetManyMessagesResponse"}}},"description":"Successful 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":"Get many messages","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/query":{"post":{"description":"This Method creates a channel or returns an existing one with matching attributes\n\nSends events:\n- channel.created\n- member.added\n- member.removed\n- member.updated\n- user.watching.start\n","operationId":"GetOrCreateChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID (maximum length of 64 characters)","title":"ID","type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelGetOrCreateRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelStateResponse"}}},"description":"Successful 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":"Get or create channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/read":{"post":{"description":"Marks channel as read up to the specific message\n\nSends events:\n- message.read\n- message.read\n","operationId":"MarkRead","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkReadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkReadResponse"}}},"description":"Successful 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 read","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/show":{"post":{"description":"Shows previously hidden channel\n\nSends events:\n- channel.visible\n- channel.visible\n","operationId":"ShowChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShowChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShowChannelResponse"}}},"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":"Show channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/truncate":{"post":{"description":"Truncates messages from a channel. Can be applied to the entire channel or scoped to specific members.\n\nSends events:\n- channel.truncated\n- channel.truncated\n","operationId":"TruncateChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TruncateChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TruncateChannelResponse"}}},"description":"Successful 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":"Truncate channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/unread":{"post":{"description":"Marks channel as unread from a specific message\n","operationId":"MarkUnread","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkUnreadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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 unread","tags":["product:chat"]}},"/api/v2/chat/channeltypes":{"get":{"description":"Lists all available channel types\n","operationId":"ListChannelTypes","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListChannelTypesResponse"}}},"description":"ListChannelTypesResponse"},"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":"List channel types","tags":["product:chat"]},"post":{"description":"Creates new channel type\n","operationId":"CreateChannelType","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateChannelTypeRequest"}}},"description":"CreateChannelTypeRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateChannelTypeResponse"}}},"description":"Successful 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":"Create channel type","tags":["product:chat"]}},"/api/v2/chat/channeltypes/{name}":{"delete":{"description":"Deletes channel type\n","operationId":"DeleteChannelType","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Channel type name","title":"Name","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete channel type","tags":["product:chat"]},"get":{"description":"Gets channel type\n","operationId":"GetChannelType","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Channel type name","title":"Name","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetChannelTypeResponse"}}},"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":"Get channel type","tags":["product:chat"]},"put":{"description":"Updates channel type\n","operationId":"UpdateChannelType","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelTypeRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelTypeResponse"}}},"description":"Successful 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":"Update channel type","tags":["product:chat"]}},"/api/v2/chat/commands":{"get":{"description":"Returns all custom commands\n","operationId":"ListCommands","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListCommandsResponse"}}},"description":"ListCommandsResponse"},"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":"List commands","tags":["product:chat"]},"post":{"description":"Creates custom chat command\n","operationId":"CreateCommand","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCommandRequest"}}},"description":"CreateCommandRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCommandResponse"}}},"description":"CreateCommandResponse"},"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":"Create command","tags":["product:chat"]}},"/api/v2/chat/commands/{name}":{"delete":{"description":"Deletes custom chat command\n","operationId":"DeleteCommand","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Command name","title":"Name","type":"string","x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCommandResponse"}}},"description":"DeleteCommandResponse"},"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":"Delete command","tags":["product:chat"]},"get":{"description":"Returns custom command by its name\n","operationId":"GetCommand","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Command name","title":"Name","type":"string","x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCommandResponse"}}},"description":"GetCommandResponse"},"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":"Get command","tags":["product:chat"]},"put":{"description":"Updates custom chat command\n","operationId":"UpdateCommand","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Unique command name","title":"Name","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCommandRequest"}}},"description":"UpdateCommandRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCommandResponse"}}},"description":"UpdateCommandResponse"},"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":"Update command","tags":["product:chat"]}},"/api/v2/chat/drafts/query":{"post":{"description":"Queries draft messages for a user\n","operationId":"QueryDrafts","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryDraftsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryDraftsResponse"}}},"description":"Successful 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":"Query draft messages","tags":["product:chat"]}},"/api/v2/chat/export_channels":{"post":{"description":"Exports channel data to JSON file\n","operationId":"ExportChannels","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportChannelsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportChannelsResponse"}}},"description":"Successful 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":"Export channels","tags":["product:chat"]}},"/api/v2/chat/members":{"get":{"description":"Find and filter channel members\n","operationId":"QueryMembers","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryMembersPayload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MembersResponse"}}},"description":"Successful 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":"Query members","tags":["product:chat"]}},"/api/v2/chat/messages/history":{"post":{"description":"Queries history for one message\n","operationId":"QueryMessageHistory","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryMessageHistoryRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryMessageHistoryResponse"}}},"description":"Successful 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":"Query message history","tags":["product:chat"]}},"/api/v2/chat/messages/{id}":{"delete":{"description":"Deletes message\n\nSends events:\n- message.deleted\n- message.deleted\n","operationId":"DeleteMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID to delete","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"hard","schema":{"description":"Delete all message reactions and replies as well","title":"Hard","type":"boolean","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"deleted_by","schema":{"type":"string","writeOnly":true,"x-stream-index":"003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteMessageResponse"}}},"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":"Delete message","tags":["product:chat"]},"get":{"description":"Returns message by ID\n","operationId":"GetMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"ID of the message","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"show_deleted_message","schema":{"description":"Whether to show deleted message","title":"Show deleted message","type":"boolean","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetMessageResponse"}}},"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":"Get message","tags":["product:chat"]},"post":{"description":"Updates message with new data\n\nSends events:\n- message.updated\n- message.updated\n","operationId":"UpdateMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"004.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessageResponse"}}},"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":"Update message","tags":["product:chat"]},"put":{"description":"Updates certain fields of the message\n\nSends events:\n- message.updated\n- message.updated\n","operationId":"UpdateMessagePartial","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessagePartialRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessagePartialResponse"}}},"description":"Successful 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":"Partially message update","tags":["product:chat"]}},"/api/v2/chat/messages/{id}/action":{"post":{"description":"Executes message command action with given parameters\n\nSends events:\n- message.new\n- message.new\n","operationId":"RunMessageAction","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageActionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}},"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":"Run message command action","tags":["product:chat"]}},"/api/v2/chat/messages/{id}/commit":{"post":{"description":"Commits a pending message, which will make it visible in the channel\n\nSends events:\n- message.new\n- message.updated\n- message.new\n- message.updated\n","operationId":"CommitMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommitMessageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}},"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":"Commit message","tags":["product:chat"]}},"/api/v2/chat/messages/{id}/reaction":{"post":{"description":"Sends reaction to specified message\n\nSends events:\n- reaction.new\n- reaction.updated\n","operationId":"SendReaction","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID to send reaction for","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendReactionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendReactionResponse"}}},"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":"Send reaction","tags":["product:chat"]}},"/api/v2/chat/messages/{id}/reaction/{type}":{"delete":{"description":"Removes user reaction from the message\n\nSends events:\n- reaction.deleted\n","operationId":"DeleteReaction","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID to remove reaction from","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"type","required":true,"schema":{"description":"Reaction type to remove","title":"Type","type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"description":"**Server-side only**. User ID which server acts upon","title":"User ID","type":"string","writeOnly":true,"x-stream-index":"003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteReactionResponse"}}},"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":"Delete reaction","tags":["product:chat"]}},"/api/v2/chat/messages/{id}/reactions":{"get":{"description":"Returns list of reactions of specific message\n","operationId":"GetReactions","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"limit","schema":{"description":"Number of records to return","format":"int32","title":"Limit","type":"integer","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"offset","schema":{"description":"Number of records to offset","format":"int32","title":"Offset","type":"integer","writeOnly":true,"x-stream-index":"003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetReactionsResponse"}}},"description":"Successful 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":"Get reactions","tags":["product:chat"]},"post":{"description":"Get reactions on a message\n","operationId":"QueryReactions","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryReactionsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryReactionsResponse"}}},"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"}},"tags":["product:chat"]}},"/api/v2/chat/messages/{id}/translate":{"post":{"description":"Translates message to a given language using automated translation software\n\nSends events:\n- message.updated\n- message.updated\n","operationId":"TranslateMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TranslateMessageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}},"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":"Translate message","tags":["product:chat"]}},"/api/v2/chat/messages/{id}/undelete":{"post":{"description":"Undelete a message that was previously soft-deleted\n\nSends events:\n- message.undeleted\n- message.undeleted\n","operationId":"UndeleteMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"004.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessageResponse"}}},"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":"Undelete message","tags":["product:chat"]}},"/api/v2/chat/messages/{message_id}/polls/{poll_id}/vote":{"post":{"description":"Cast a vote on a poll\n\nSends events:\n- feeds.poll.vote_casted\n- feeds.poll.vote_changed\n- feeds.poll.vote_removed\n- poll.vote_casted\n- poll.vote_changed\n- poll.vote_removed\n","operationId":"CastPollVote","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CastPollVoteRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollVoteResponse"}}},"description":"Successful 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":"Cast vote","tags":["product:chat"]}},"/api/v2/chat/messages/{message_id}/polls/{poll_id}/vote/{vote_id}":{"delete":{"description":"Delete a vote from a poll\n\nSends events:\n- feeds.poll.vote_removed\n- poll.vote_removed\n","operationId":"DeletePollVote","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"004"}},{"in":"path","name":"vote_id","required":true,"schema":{"description":"Vote ID","maxLength":255,"title":"string","type":"string","x-stream-index":"005"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollVoteResponse"}}},"description":"Successful 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":"Delete vote","tags":["product:chat"]}},"/api/v2/chat/messages/{message_id}/reminders":{"delete":{"description":"Deletes a user's created reminder\n\nSends events:\n- reminder.deleted\n","operationId":"DeleteReminder","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteReminderResponse"}}},"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":"Delete reminder","tags":["product:chat"]},"patch":{"description":"Updates an existing reminder\n\nSends events:\n- reminder.updated\n","operationId":"UpdateReminder","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateReminderRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateReminderResponse"}}},"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":"Updates Reminder","tags":["product:chat"]},"post":{"description":"Creates a new reminder\n\nSends events:\n- reminder.created\n","operationId":"CreateReminder","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateReminderRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReminderResponseData"}}},"description":"Successful 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":"Create reminder","tags":["product:chat"]}},"/api/v2/chat/messages/{parent_id}/replies":{"get":{"description":"Returns replies (thread) of the message\n","operationId":"GetReplies","parameters":[{"in":"path","name":"parent_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"sort","schema":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":1,"type":"array","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"limit","schema":{"description":"The maximum number of messages to return (max limit ","format":"int32","minimum":0,"title":"Limit","type":"integer","x-stream-index":"003.001"}},{"in":"query","name":"offset","schema":{"description":"The offset to start from","format":"int32","title":"Offset","type":"integer","x-stream-index":"003.002"}},{"in":"query","name":"id_gte","schema":{"description":"The ID of the message to get messages with a timestamp greater than or equal to","title":"IDGTE","type":"string","x-stream-index":"003.003"}},{"in":"query","name":"id_gt","schema":{"description":"The ID of the message to get messages with a timestamp greater than","title":"IDGT","type":"string","x-stream-index":"003.004"}},{"in":"query","name":"id_lte","schema":{"description":"The ID of the message to get messages with a timestamp smaller than or equal to","title":"IDLTE","type":"string","x-stream-index":"003.005"}},{"in":"query","name":"id_lt","schema":{"description":"The ID of the message to get messages with a timestamp smaller than","title":"IDLT","type":"string","x-stream-index":"003.006"}},{"in":"query","name":"created_at_after_or_equal","schema":{"description":"The timestamp to get messages with a created_at timestamp greater than or equal to","format":"date-time","title":"Created_at after or equal","type":"number","x-stream-index":"003.007"}},{"in":"query","name":"created_at_after","schema":{"description":"The timestamp to get messages with a created_at timestamp greater than","format":"date-time","title":"Created_at after","type":"number","x-stream-index":"003.008"}},{"in":"query","name":"created_at_before_or_equal","schema":{"description":"The timestamp to get messages with a created_at timestamp smaller than or equal to","format":"date-time","title":"Created_at after before or equal","type":"number","x-stream-index":"003.009"}},{"in":"query","name":"created_at_before","schema":{"description":"The timestamp to get messages with a created_at timestamp smaller than","format":"date-time","title":"Created_at after before","type":"number","x-stream-index":"003.010"}},{"in":"query","name":"id_around","schema":{"description":"The result will be a set of messages, that are both older and newer than the message with the provided ID, and the message with the ID provided will be in the middle of the set","title":"Id around","type":"string","x-stream-index":"003.011"}},{"in":"query","name":"created_at_around","schema":{"description":"The result will be a set of messages, that are both older and newer than the created_at timestamp provided, distributed evenly around the timestamp","format":"date-time","title":"Created_at around","type":"number","x-stream-index":"003.012"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRepliesResponse"}}},"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":"Get replies","tags":["product:chat"]}},"/api/v2/chat/moderation/flags/message":{"get":{"description":"Find and filter message flags\n","operationId":"QueryMessageFlags","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryMessageFlagsPayload","description":"JSON object with query message flags payload","title":"Payload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryMessageFlagsResponse"}}},"description":"QueryMessageFlagsResponse"},"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":"Query Message Flags","tags":["product:chat"]}},"/api/v2/chat/moderation/mute/channel":{"post":{"description":"Mutes channel for user\n\nSends events:\n- channel.muted\n- channel.muted\n","operationId":"MuteChannel","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteChannelResponse"}}},"description":"Successful 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":"Mute channel","tags":["product:chat"]}},"/api/v2/chat/moderation/unmute/channel":{"post":{"description":"Unmutes channel for user\n\nSends events:\n- channel.unmuted\n- channel.unmuted\n","operationId":"UnmuteChannel","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnmuteChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnmuteResponse"}}},"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":"Unmute channel","tags":["product:chat"]}},"/api/v2/chat/push_preferences":{"post":{"description":"Update the push preferences for a user and or channel member. Set to all, mentions or none\n","operationId":"UpdatePushNotificationPreferences","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertPushPreferencesRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertPushPreferencesResponse"}}},"description":"Successful 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":"Push notification preferences","tags":["product:chat"]}},"/api/v2/chat/push_templates":{"get":{"description":"Retrieve push notification templates for Chat.\n","operationId":"GetPushTemplates","parameters":[{"in":"query","name":"push_provider_name","schema":{"description":"Push provider name to filter templates","title":"string","type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"push_provider_type","required":true,"schema":{"description":"Push provider type (firebase, apn) to filter templates","enum":["firebase","apn"],"title":"string","type":"string","writeOnly":true,"x-stream-index":"003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPushTemplatesResponse"}}},"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":"Get push notification templates","tags":["product:chat"]},"post":{"description":"Create or update a push notification template for a specific event type and push provider\n","operationId":"UpsertPushTemplate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertPushTemplateRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertPushTemplateResponse"}}},"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":"Upsert a push notification template","tags":["product:chat"]}},"/api/v2/chat/query_banned_users":{"get":{"description":"Find and filter channel scoped or global user bans\n","operationId":"QueryBannedUsers","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryBannedUsersPayload","description":"JSON object with query user bans payload","title":"Payload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryBannedUsersResponse"}}},"description":"Successful 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":"Query Banned Users","tags":["product:chat"]}},"/api/v2/chat/reminders/query":{"post":{"description":"Queries reminders\n","operationId":"QueryReminders","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryRemindersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryRemindersResponse"}}},"description":"Successful 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":"Query reminders","tags":["product:chat"]}},"/api/v2/chat/search":{"get":{"description":"Search messages across channels\n","operationId":"Search","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchPayload","description":"JSON object with search payload","title":"Payload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchResponse"}}},"description":"Successful 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":"Search messages","tags":["product:chat"]}},"/api/v2/chat/segments/query":{"post":{"description":"Query segments\n","operationId":"QuerySegments","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuerySegmentsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuerySegmentsResponse"}}},"description":"Successful 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":"Query segments","tags":["product:chat"]}},"/api/v2/chat/segments/{id}":{"delete":{"description":"Delete a segment\n","operationId":"DeleteSegment","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete segment","tags":["product:chat"]},"get":{"description":"Get segment\n","operationId":"GetSegment","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetSegmentResponse"}}},"description":"Successful 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":"Get segment","tags":["product:chat"]}},"/api/v2/chat/segments/{id}/deletetargets":{"post":{"description":"Delete targets from a segment\n","operationId":"DeleteSegmentTargets","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteSegmentTargetsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete targets from a segment","tags":["product:chat"]}},"/api/v2/chat/segments/{id}/target/{target_id}":{"get":{"description":"Check whether a target exists in a segment. Returns 200 if the target exists, 404 otherwise\n","operationId":"SegmentTargetExists","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"target_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Check whether a target exists in a segment","tags":["product:chat"]}},"/api/v2/chat/segments/{id}/targets/query":{"post":{"description":"Query segment targets\n","operationId":"QuerySegmentTargets","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuerySegmentTargetsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuerySegmentTargetsResponse"}}},"description":"Successful 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":"Query segment targets","tags":["product:chat"]}},"/api/v2/chat/threads":{"post":{"description":"Returns the list of threads for specific user\n","operationId":"QueryThreads","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryThreadsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryThreadsResponse"}}},"description":"Successful 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":"Query Threads","tags":["product:chat"]}},"/api/v2/chat/threads/{message_id}":{"get":{"description":"Return a specific thread\n","operationId":"GetThread","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"reply_limit","schema":{"description":"Limit the number of replies returned","format":"int32","minimum":0,"title":"Reply limit","type":"integer","writeOnly":true,"x-stream-index":"004"}},{"in":"query","name":"participant_limit","schema":{"description":"Limit the number of participants returned","format":"int32","maximum":100,"minimum":0,"title":"Participant limit","type":"integer","writeOnly":true,"x-stream-index":"005"}},{"in":"query","name":"member_limit","schema":{"description":"Limit the number of members returned per thread channel","format":"int32","maximum":100,"minimum":0,"title":"Member limit","type":"integer","writeOnly":true,"x-stream-index":"006"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetThreadResponse"}}},"description":"Successful 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":"Get Thread","tags":["product:chat"]},"patch":{"description":"Updates certain fields of the thread\n\nSends events:\n- thread.updated\n- thread.updated\n","operationId":"UpdateThreadPartial","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateThreadPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateThreadPartialResponse"}}},"description":"Successful 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":"Partially update thread","tags":["product:chat"]}},"/api/v2/chat/unread":{"get":{"description":"Fetch unread counts for a single user\n","operationId":"UnreadCounts","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WrappedUnreadCountsResponse"}}},"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":"Unread counts","tags":["product:chat"]}},"/api/v2/chat/unread_batch":{"post":{"description":"Fetch unread counts in batch for multiple users in one call\n","operationId":"UnreadCountsBatch","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnreadCountsBatchRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnreadCountsBatchResponse"}}},"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":"Batch unread counts","tags":["product:chat"]}},"/api/v2/chat/users/{user_id}/event":{"post":{"description":"Sends a custom event to a user\n\nSends events:\n- *\n","operationId":"SendUserCustomEvent","parameters":[{"in":"path","name":"user_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendUserCustomEventRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Send user event","tags":["product:chat"]}},"/api/v2/check_push":{"post":{"description":"Sends a test message via push, this is a test endpoint to verify your push settings\n","operationId":"CheckPush","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckPushRequest"}}},"description":"CheckPushRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckPushResponse"}}},"description":"Successful 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":"Check push","tags":["product:common"]}},"/api/v2/check_sns":{"post":{"description":"Validates Amazon SNS configuration\n","operationId":"CheckSNS","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSNSRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSNSResponse"}}},"description":"Successful 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":"Check SNS","tags":["product:common"]}},"/api/v2/check_sqs":{"post":{"description":"Validates Amazon SQS credentials\n","operationId":"CheckSQS","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSQSRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSQSResponse"}}},"description":"Successful 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":"Check SQS","tags":["product:common"]}},"/api/v2/devices":{"delete":{"description":"Deletes one device\n","operationId":"DeleteDevice","parameters":[{"in":"query","name":"id","required":true,"schema":{"description":"Device ID to delete","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"user_id","schema":{"description":"**Server-side only**. User ID which server acts upon","title":"User ID","type":"string","writeOnly":true,"x-stream-index":"002.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete device","tags":["product:common"]},"get":{"description":"Returns all available devices\n","operationId":"ListDevices","parameters":[{"in":"query","name":"user_id","schema":{"description":"**Server-side only**. User ID which server acts upon","title":"User ID","type":"string","writeOnly":true,"x-stream-index":"001.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDevicesResponse"}}},"description":"ListDevicesResponse"},"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":"List devices","tags":["product:common"]},"post":{"description":"Adds a new device to a user, if the same device already exists the call will have no effect\n","operationId":"CreateDevice","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDeviceRequest"}}},"description":"CreateDeviceRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Create device","tags":["product:common"]}},"/api/v2/export/users":{"post":{"description":"Exports user profile, reactions and messages for list of given users\n","operationId":"ExportUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportUsersResponse"}}},"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":"Export users","tags":["product:common"]}},"/api/v2/external_storage":{"get":{"description":"Lists external storage\n","operationId":"ListExternalStorage","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListExternalStorageResponse"}}},"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":"List external storage","tags":["product:common"]},"post":{"description":"Creates new external storage\n","operationId":"CreateExternalStorage","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateExternalStorageRequest"}}},"description":"CreateExternalStorageRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateExternalStorageResponse"}}},"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":"Create external storage","tags":["product:common"]}},"/api/v2/external_storage/{name}":{"delete":{"description":"Deletes external storage\n","operationId":"DeleteExternalStorage","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteExternalStorageResponse"}}},"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":"Delete external storage","tags":["product:common"]},"put":{"description":"\n","operationId":"UpdateExternalStorage","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateExternalStorageRequest"}}},"description":"ExternalStorageRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateExternalStorageResponse"}}},"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":"Update External Storage","tags":["product:common"]}},"/api/v2/external_storage/{name}/check":{"get":{"description":"\n","operationId":"CheckExternalStorage","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckExternalStorageResponse"}}},"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":"Check External Storage","tags":["product:common"]}},"/api/v2/guest":{"post":{"description":"\n","operationId":"CreateGuest","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGuestRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGuestResponse"}}},"description":"Successful 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":"Create Guest","tags":["product:common"]}},"/api/v2/import_urls":{"post":{"description":"Creates a new import URL\n","operationId":"CreateImportURL","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateImportURLRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateImportURLResponse"}}},"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":"Create import URL","tags":["product:common"]}},"/api/v2/imports":{"get":{"description":"Gets an import\n","operationId":"ListImports","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListImportsResponse"}}},"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":"Get import","tags":["product:common"]},"post":{"description":"Creates a new import\n","operationId":"CreateImport","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateImportRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateImportResponse"}}},"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":"Create import","tags":["product:common"]}},"/api/v2/imports/{id}":{"get":{"description":"Gets an import\n","operationId":"GetImport","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetImportResponse"}}},"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":"Get import","tags":["product:common"]}},"/api/v2/moderation/ban":{"post":{"description":"Ban a user from a channel or the entire app\n","operationId":"ban","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BanRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BanResponse"}}},"description":"Successful 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":"Ban","tags":["product:moderation"]}},"/api/v2/moderation/bulk_image_moderation":{"post":{"description":"Moderate multiple images in bulk using a CSV file\n","operationId":"bulk_image_moderation","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkImageModerationRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkImageModerationResponse"}}},"description":"Successful 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":"Bulk image moderation","tags":["product:moderation"]}},"/api/v2/moderation/check":{"post":{"description":"Run moderation checks on the provided content\n","operationId":"check","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckResponse"}}},"description":"Successful 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":"Check","tags":["product:moderation"]}},"/api/v2/moderation/config":{"post":{"description":"Create a new moderation configuration or update an existing one. Configure settings for content filtering, AI analysis, toxicity detection, and other moderation features.\n","operationId":"upsert_config","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertConfigRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertConfigResponse"}}},"description":"Successful 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":"Create or update moderation configuration","tags":["product:moderation"]}},"/api/v2/moderation/config/{key}":{"delete":{"description":"Delete a specific moderation policy by its name\n","operationId":"delete_config","parameters":[{"in":"path","name":"key","required":true,"schema":{"description":"Key of the moderation configuration to delete","title":"Key","type":"string","x-stream-index":"001"}},{"in":"query","name":"team","schema":{"description":"Team associated with the configuration","title":"Team","type":"string","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteModerationConfigResponse"}}},"description":"Successful 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":"Delete a moderation policy","tags":["product:moderation"]},"get":{"description":"Retrieve a specific moderation configuration by its key and team. This configuration contains settings for various moderation features like toxicity detection, AI analysis, and filtering rules.\n","operationId":"get_config","parameters":[{"in":"path","name":"key","required":true,"schema":{"description":"Key of the moderation configuration to retrieve","title":"Key","type":"string","x-stream-index":"001"}},{"in":"query","name":"team","schema":{"description":"Team associated with the configuration","title":"Team","type":"string","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetConfigResponse"}}},"description":"Successful 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":"Get moderation configuration","tags":["product:moderation"]}},"/api/v2/moderation/configs":{"post":{"description":"Search and filter moderation configurations across your application. This endpoint is designed for building moderation dashboards and managing multiple configuration sets.\n","operationId":"query_moderation_configs","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationConfigsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationConfigsResponse"}}},"description":"Successful 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":"Query moderation configurations","tags":["product:moderation"]}},"/api/v2/moderation/custom_check":{"post":{"description":"Custom check, add your own AI model reports to the review queue\n","operationId":"custom_check","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomCheckRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomCheckResponse"}}},"description":"Successful 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":"Custom check endpoint","tags":["product:moderation"]}},"/api/v2/moderation/feeds_moderation_template":{"delete":{"description":"Delete a specific moderation template by its name\n","operationId":"V2DeleteTemplate","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteModerationTemplateResponse"}}},"description":"Successful 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":"Delete a moderation template","tags":["product:moderation"]},"get":{"description":"Retrieve a list of feed moderation templates that define preset moderation rules and configurations. Limited to 100 templates per request.\n","operationId":"V2QueryTemplates","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryFeedModerationTemplatesResponse"}}},"description":"Successful 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":"Query feed moderation templates","tags":["product:moderation"]},"post":{"description":"Upsert feeds template for moderation\n","operationId":"V2UpsertTemplate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertModerationTemplateRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertModerationTemplateResponse"}}},"description":"Successful 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":"Upsert feeds template","tags":["product:moderation"]}},"/api/v2/moderation/flag":{"post":{"description":"Flag any type of content (messages, users, channels, activities) for moderation review. Supports custom content types and additional metadata for flagged content.\n","operationId":"flag","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlagRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlagResponse"}}},"description":"Successful 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":"Flag content for moderation","tags":["product:moderation"]}},"/api/v2/moderation/flags":{"post":{"description":"Query flags associated with moderation items. This is used for building a moderation dashboard.\n","operationId":"query_moderation_flags","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationFlagsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationFlagsResponse"}}},"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":"Query moderation flags","tags":["product:moderation"]}},"/api/v2/moderation/logs":{"post":{"description":"Search and filter moderation action logs with support for pagination. View the history of moderation actions taken, including who performed them and when.\n","operationId":"query_moderation_logs","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationLogsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationLogsResponse"}}},"description":"Successful 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":"Query moderation action logs","tags":["product:moderation"]}},"/api/v2/moderation/mute":{"post":{"description":"Mute a user. Mutes are generally not visible to the user you mute, while block is something you notice.\n","operationId":"mute","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteRequest"}}},"description":"MuteRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteResponse"}}},"description":"MuteResponse"},"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":"Mute","tags":["product:moderation"]}},"/api/v2/moderation/review_queue":{"post":{"description":"Query review queue items allows you to filter the review queue items. This is used for building a moderation dashboard.\n","operationId":"query_review_queue","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryReviewQueueRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryReviewQueueResponse"}}},"description":"Successful 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":"Query review queue items","tags":["product:moderation"]}},"/api/v2/moderation/review_queue/{id}":{"get":{"description":"Retrieve a specific review queue item by its ID\n","operationId":"get_review_queue_item","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Unique identifier of the review queue item to retrieve","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetReviewQueueItemResponse"}}},"description":"Successful 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":"Get review queue item","tags":["product:moderation"]}},"/api/v2/moderation/submit_action":{"post":{"description":"Take action on flagged content, such as marking content as safe, deleting content, banning users, or executing custom moderation actions. Supports various action types with configurable parameters.\n","operationId":"submit_action","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitActionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitActionResponse"}}},"description":"Successful 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":"Submit moderation action","tags":["product:moderation"]}},"/api/v2/moderation/unban":{"post":{"description":"Unban a user from a channel or globally.\n","operationId":"unban","parameters":[{"in":"query","name":"target_user_id","required":true,"schema":{"description":"ID of the user to unban","title":"Target User ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"channel_cid","schema":{"description":"Channel where the unban applies","title":"Channel CID","type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"created_by","schema":{"description":"ID of the user who created the ban","title":"Created By","type":"string","writeOnly":true,"x-stream-index":"003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnbanRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnbanResponse"}}},"description":"Successful 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":"Unban","tags":["product:moderation"]}},"/api/v2/moderation/unmute":{"post":{"description":"Unmute a user\n","operationId":"unmute","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnmuteRequest"}}},"description":"UnmuteRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnmuteResponse"}}},"description":"UnmuteResponse"},"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":"Unmute a user","tags":["product:moderation"]}},"/api/v2/og":{"get":{"description":"Get an OpenGraph attachment for a link\n","operationId":"GetOG","parameters":[{"in":"query","name":"url","required":true,"schema":{"description":"URL to be scraped","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOGResponse"}}},"description":"Get OG Attachment"},"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":"Get OG","tags":["product:common"]}},"/api/v2/permissions":{"get":{"description":"Lists all available permissions\n","operationId":"ListPermissions","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPermissionsResponse"}}},"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":"List permissions","tags":["product:common"]}},"/api/v2/permissions/{id}":{"get":{"description":"Gets custom permission\n","operationId":"GetPermission","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Permission ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCustomPermissionResponse"}}},"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":"Get permission","tags":["product:common"]}},"/api/v2/polls":{"post":{"description":"Creates a new poll\n","operationId":"CreatePoll","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePollRequest"}}},"description":"Create Poll Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Create poll","tags":["product:common"]},"put":{"description":"Updates a poll\n\nSends events:\n- feeds.poll.closed\n- feeds.poll.updated\n- poll.closed\n- poll.updated\n","operationId":"UpdatePoll","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePollRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Update poll","tags":["product:common"]}},"/api/v2/polls/query":{"post":{"description":"Queries polls\n","operationId":"QueryPolls","parameters":[{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryPollsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryPollsResponse"}}},"description":"Successful 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":"Query polls","tags":["product:common"]}},"/api/v2/polls/{poll_id}":{"delete":{"description":"Deletes a poll\n\nSends events:\n- feeds.poll.deleted\n- poll.deleted\n","operationId":"DeletePoll","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete poll","tags":["product:common"]},"get":{"description":"Retrieves a poll\n","operationId":"GetPoll","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Get poll","tags":["product:common"]},"patch":{"description":"Updates a poll partially\n\nSends events:\n- feeds.poll.closed\n- feeds.poll.updated\n- poll.closed\n- poll.updated\n","operationId":"UpdatePollPartial","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePollPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Partial update poll","tags":["product:common"]}},"/api/v2/polls/{poll_id}/options":{"post":{"description":"Creates a poll option\n\nSends events:\n- feeds.poll.updated\n- poll.updated\n","operationId":"CreatePollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePollOptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollOptionResponse"}}},"description":"Successful 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":"Create poll option","tags":["product:common"]},"put":{"description":"Updates a poll option\n\nSends events:\n- feeds.poll.updated\n- poll.updated\n","operationId":"UpdatePollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePollOptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollOptionResponse"}}},"description":"Successful 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":"Update poll option","tags":["product:common"]}},"/api/v2/polls/{poll_id}/options/{option_id}":{"delete":{"description":"Deletes a poll option\n\nSends events:\n- feeds.poll.updated\n- poll.updated\n","operationId":"DeletePollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"path","name":"option_id","required":true,"schema":{"description":"Option ID","maxLength":255,"title":"string","type":"string","x-stream-index":"003"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete poll option","tags":["product:common"]},"get":{"description":"Retrieves a poll option\n","operationId":"GetPollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"path","name":"option_id","required":true,"schema":{"description":"Option ID","maxLength":255,"title":"string","type":"string","x-stream-index":"003"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollOptionResponse"}}},"description":"Successful 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":"Get poll option","tags":["product:common"]}},"/api/v2/polls/{poll_id}/votes":{"post":{"description":"Queries votes\n","operationId":"QueryPollVotes","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryPollVotesRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollVotesResponse"}}},"description":"Successful 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":"Query votes","tags":["product:common"]}},"/api/v2/push_providers":{"get":{"description":"List details of all push providers.\n","operationId":"ListPushProviders","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPushProvidersResponse"}}},"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":"List push providers","tags":["product:common"]},"post":{"description":"Upsert a push provider for v2 with multi bundle/package support\n","operationId":"UpsertPushProvider","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertPushProviderRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertPushProviderResponse"}}},"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":"Upsert a push provider","tags":["product:common"]}},"/api/v2/push_providers/{type}/{name}":{"delete":{"description":"Delete a push provider from v2 with multi bundle/package support. v1 isn't supported in this endpoint\n","operationId":"DeletePushProvider","parameters":[{"in":"path","name":"type","required":true,"schema":{"enum":["apn","firebase","huawei","xiaomi"],"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"name","required":true,"schema":{"maxLength":36,"minLength":1,"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete a push provider","tags":["product:common"]}},"/api/v2/rate_limits":{"get":{"description":"Get rate limits usage and quotas\n","operationId":"GetRateLimits","parameters":[{"in":"query","name":"server_side","schema":{"description":"Whether to include server-side platform limits or not","title":"Server-side","type":"boolean","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"android","schema":{"description":"Whether to include Android platform limits or not","title":"Android","type":"boolean","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"ios","schema":{"description":"Whether to include iOS platform limits or not","title":"iOS","type":"boolean","writeOnly":true,"x-stream-index":"003"}},{"in":"query","name":"web","schema":{"description":"Whether to include web platform limits or not","title":"Web","type":"boolean","writeOnly":true,"x-stream-index":"004"}},{"in":"query","name":"endpoints","schema":{"description":"Specific endpoints to show limits for, as a comma-separated list of values","title":"Endpoints","type":"string","writeOnly":true,"x-stream-index":"005"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRateLimitsResponse"}}},"description":"Get Rate Limits 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":"Get rate limits","tags":["product:common"]}},"/api/v2/roles":{"get":{"description":"Lists all available roles\n","operationId":"ListRoles","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListRolesResponse"}}},"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":"List roles","tags":["product:common"]},"post":{"description":"Creates custom role\n","operationId":"CreateRole","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRoleRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRoleResponse"}}},"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":"Create role","tags":["product:common"]}},"/api/v2/roles/{name}":{"delete":{"description":"Deletes custom role\n","operationId":"DeleteRole","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Role name","title":"Name","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete role","tags":["product:common"]}},"/api/v2/tasks/{id}":{"get":{"description":"Gets status of a task\n","operationId":"GetTask","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Task ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetTaskResponse"}}},"description":"Get Task 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":"Get status of a task","tags":["product:common"]}},"/api/v2/uploads/file":{"delete":{"description":"Deletes previously uploaded file\n","operationId":"DeleteFileGlobal","parameters":[{"in":"query","name":"url","schema":{"description":"File URL to delete","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete file","tags":["product:common"],"x-stream-sdk-name":"DeleteFile"},"post":{"description":"Uploads file\n","operationId":"UploadFileGlobal","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/FileUploadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileUploadResponse"}}},"description":"Successful 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":"Upload file","tags":["product:common"],"x-stream-sdk-name":"UploadFile"}},"/api/v2/uploads/image":{"delete":{"description":"Deletes previously uploaded image\n","operationId":"DeleteImageGlobal","parameters":[{"in":"query","name":"url","schema":{"description":"File URL to delete","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete image","tags":["product:common"],"x-stream-sdk-name":"DeleteImage"},"post":{"description":"Uploads image\n","operationId":"UploadImageGlobal","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/ImageUploadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageUploadResponse"}}},"description":"Successful 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":"Upload image","tags":["product:common"],"x-stream-sdk-name":"UploadImage"}},"/api/v2/users":{"get":{"description":"Find and filter users\n","operationId":"QueryUsers","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryUsersPayload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryUsersResponse"}}},"description":"Successful 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":"Query users","tags":["product:common"]},"patch":{"description":"Updates certain fields of the user\n\nSends events:\n- user.presence.changed\n- user.updated\n- user.presence.changed\n","operationId":"UpdateUsersPartial","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersResponse"}}},"description":"Successful 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":"Partially update user","tags":["product:common"]},"post":{"description":"Update or create users in bulk\n\nSends events:\n- user.updated\n","operationId":"UpdateUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersResponse"}}},"description":"Successful 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":"Upsert users","tags":["product:common"]}},"/api/v2/users/block":{"get":{"description":"Get list of blocked Users\n","operationId":"GetBlockedUsers","parameters":[{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBlockedUsersResponse"}}},"description":"Successful 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":"Get list of blocked Users","tags":["product:common"]},"post":{"description":"Block users\n","operationId":"BlockUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUsersResponse"}}},"description":"Successful 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":"Block user","tags":["product:common"]}},"/api/v2/users/deactivate":{"post":{"description":"Deactivate users in batches\n\nSends events:\n- user.deactivated\n","operationId":"DeactivateUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeactivateUsersRequest"}}},"description":"DeactivateUsersRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeactivateUsersResponse"}}},"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":"Deactivate users","tags":["product:common"]}},"/api/v2/users/delete":{"post":{"description":"Deletes users and optionally all their belongings asynchronously.\n\nSends events:\n- channel.deleted\n- user.deleted\n","operationId":"DeleteUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteUsersResponse"}}},"description":"Successful 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":"Delete Users","tags":["product:common"]}},"/api/v2/users/live_locations":{"get":{"description":"Retrieves all active live locations for a user\n","operationId":"GetUserLiveLocations","parameters":[{"in":"query","name":"user_id","schema":{"description":"User ID to get live locations for. If not provided, returns live locations for the authenticated user.","title":"string","type":"string","writeOnly":true,"x-stream-index":"001.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SharedLocationsResponse"}}},"description":"Successful 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":"Get user live locations","tags":["product:common"]},"put":{"description":"Updates an existing live location with new coordinates or expiration time\n","operationId":"UpdateLiveLocation","parameters":[{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"005.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateLiveLocationRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SharedLocationResponse"}}},"description":"Successful 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":"Update live location","tags":["product:common"]}},"/api/v2/users/reactivate":{"post":{"description":"Reactivate users in batches\n\nSends events:\n- user.reactivated\n- user.reactivated\n","operationId":"ReactivateUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReactivateUsersRequest"}}},"description":"ReactivateUsersRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReactivateUsersResponse"}}},"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":"Reactivate users","tags":["product:common"]}},"/api/v2/users/restore":{"post":{"description":"Restore soft deleted users\n","operationId":"RestoreUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestoreUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Restore users","tags":["product:common"]}},"/api/v2/users/unblock":{"post":{"description":"Unblock users\n","operationId":"UnblockUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUsersResponse"}}},"description":"Successful 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":"Unblock user","tags":["product:common"]}},"/api/v2/users/{user_id}/deactivate":{"post":{"description":"Deactivates user with possibility to activate it back\n\nSends events:\n- user.deactivated\n","operationId":"DeactivateUser","parameters":[{"in":"path","name":"user_id","required":true,"schema":{"title":"User ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeactivateUserRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeactivateUserResponse"}}},"description":"Successful 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":"Deactivate user","tags":["product:common"]}},"/api/v2/users/{user_id}/export":{"get":{"description":"Exports the user's profile, reactions and messages. Raises an error if a user has more than 10k messages or reactions\n","operationId":"ExportUser","parameters":[{"in":"path","name":"user_id","required":true,"schema":{"title":"User ID","type":"string","x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportUserResponse"}}},"description":"Successful 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":"Export user","tags":["product:common"]}},"/api/v2/users/{user_id}/reactivate":{"post":{"description":"Activates user who's been deactivated previously\n\nSends events:\n- user.reactivated\n","operationId":"ReactivateUser","parameters":[{"in":"path","name":"user_id","required":true,"schema":{"title":"User ID","type":"string","x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReactivateUserRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReactivateUserResponse"}}},"description":"Successful 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":"Reactivate user","tags":["product:common"]}},"/api/v2/video/active_calls_status":{"get":{"description":"Get the current status of all active calls including metrics and summary information\n","operationId":"GetActiveCallsStatus","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetActiveCallsStatusResponse"}}},"description":"GetActiveCallsStatusResponse"},"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":"Get active calls status","tags":["product:video"]}},"/api/v2/video/call/feedback":{"post":{"description":"\n","operationId":"QueryUserFeedback","parameters":[{"in":"query","name":"full","schema":{"type":"boolean","writeOnly":true,"x-stream-index":"003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryUserFeedbackRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryUserFeedbackResponse"}}},"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":"Query user reported feedback for the calls","tags":["product:video"]}},"/api/v2/video/call/members":{"post":{"description":"Query call members with filter query\n","operationId":"QueryCallMembers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallMembersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallMembersResponse"}}},"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":"Query call members","tags":["product:video"]}},"/api/v2/video/call/stats":{"post":{"description":"\n","operationId":"QueryCallStats","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallStatsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallStatsResponse"}}},"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":"Query Call Stats","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}":{"get":{"description":"\n","operationId":"GetCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"query","name":"members_limit","schema":{"format":"int32","maximum":100,"minimum":0,"type":"integer","writeOnly":true,"x-stream-index":"004"}},{"in":"query","name":"ring","schema":{"type":"boolean","writeOnly":true,"x-stream-index":"005"}},{"in":"query","name":"notify","schema":{"type":"boolean","writeOnly":true,"x-stream-index":"006"}},{"in":"query","name":"video","schema":{"type":"boolean","writeOnly":true,"x-stream-index":"007"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCallResponse"}}},"description":"GetCallResponse"},"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":"Get Call","tags":["product:video"]},"patch":{"description":"\n\nSends events:\n- call.updated\n","operationId":"UpdateCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallRequest"}}},"description":"UpdateCallRequest","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallResponse"}}},"description":"UpdateCallResponse"},"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":"Update Call","tags":["product:video"]},"post":{"description":"Gets or creates a new call\n\nSends events:\n- call.created\n- call.notification\n- call.ring\n","operationId":"GetOrCreateCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrCreateCallRequest"}}},"description":"GetOrCreateCallRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrCreateCallResponse"}}},"description":"GetOrCreateCallResponse"},"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":"Get or create a call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/block":{"post":{"description":"Block a user, preventing them from joining the call until they are unblocked.\n\nSends events:\n- call.blocked_user\n","operationId":"BlockUser","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUserRequest"}}},"description":"BlockUserRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUserResponse"}}},"description":"BlockUserResponse"},"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":"Block user on a call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/delete":{"post":{"description":"\n\nSends events:\n- call.deleted\n","operationId":"DeleteCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCallRequest"}}},"description":"DeleteCallRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCallResponse"}}},"description":"DeleteCallResponse"},"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":"Delete Call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/event":{"post":{"description":"Sends custom event to the call\n\nSends events:\n- custom\n","operationId":"SendCallEvent","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendCallEventRequest"}}},"description":"SendCallEventRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendCallEventResponse"}}},"description":"SendCallEventResponse"},"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":"Send custom event","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/feedback":{"post":{"description":"\n\nSends events:\n- call.user_feedback_submitted\n","operationId":"CollectUserFeedback","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectUserFeedbackRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectUserFeedbackResponse"}}},"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":"Collect user feedback","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/go_live":{"post":{"description":"\n\nSends events:\n- call.live_started\n","operationId":"GoLive","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoLiveRequest"}}},"description":"GoLiveRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoLiveResponse"}}},"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":"Set call as live","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/mark_ended":{"post":{"description":"\n\nSends events:\n- call.ended\n","operationId":"EndCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EndCallResponse"}}},"description":"EndCallResponse"},"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":"End call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/members":{"post":{"description":"\n\nSends events:\n- call.member_added\n- call.member_removed\n- call.member_updated\n","operationId":"UpdateCallMembers","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallMembersRequest"}}},"description":"UpdateCallMembersRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallMembersResponse"}}},"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":"Update Call Member","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/mute_users":{"post":{"description":"Mutes users in a call\n","operationId":"MuteUsers","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteUsersRequest"}}},"description":"MuteUsersRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteUsersResponse"}}},"description":"MuteUsersResponse"},"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":"Mute users","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/participants":{"post":{"description":"Returns a list of participants connected to the call\n","operationId":"QueryCallParticipants","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"type","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"limit","schema":{"format":"int32","maximum":100,"type":"integer","x-stream-index":"004"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallParticipantsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallParticipantsResponse"}}},"description":"Successful 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":"Query call participants","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/pin":{"post":{"description":"Pins a track for all users in the call.\n","operationId":"VideoPin","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PinRequest"}}},"description":"PinRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PinResponse"}}},"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":"Pin","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/recordings":{"get":{"description":"Lists recordings\n","operationId":"ListRecordings","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListRecordingsResponse"}}},"description":"ListRecordingsResponse"},"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":"List recordings","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/report":{"get":{"description":"\n","operationId":"GetCallReport","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"query","name":"session_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCallReportResponse"}}},"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":"Get call report","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/rtmp_broadcasts":{"post":{"description":"Starts RTMP broadcasts for the provided RTMP destinations\n","operationId":"StartRTMPBroadcasts","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRTMPBroadcastsRequest"}}},"description":"StartRTMPBroadcastsRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRTMPBroadcastsResponse"}}},"description":"StartRTMPBroadcastsResponse"},"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":"Start RTMP broadcasts","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/rtmp_broadcasts/stop":{"post":{"description":"Stop all RTMP broadcasts for the provided call\n","operationId":"StopAllRTMPBroadcasts","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopAllRTMPBroadcastsResponse"}}},"description":"StopAllRTMPBroadcastsResponse"},"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":"Stop all RTMP broadcasts for a call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/rtmp_broadcasts/{name}/stop":{"post":{"description":"Stop RTMP broadcasts for the provided RTMP destinations\n","operationId":"StopRTMPBroadcast","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopRTMPBroadcastsRequest"}}},"description":"StopRTMPBroadcastsRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopRTMPBroadcastsResponse"}}},"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":"Stop RTMP broadcasts","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/start_broadcasting":{"post":{"description":"Starts HLS broadcasting\n","operationId":"StartHLSBroadcasting","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartHLSBroadcastingResponse"}}},"description":"StartHLSBroadcastingResponse"},"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":"Start HLS broadcasting","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/start_closed_captions":{"post":{"description":"Starts closed captions\n","operationId":"StartClosedCaptions","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartClosedCaptionsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartClosedCaptionsResponse"}}},"description":"Successful 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":"Start closed captions","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/start_frame_recording":{"post":{"description":"Starts frame by frame recording\n\nSends events:\n- call.frame_recording_started\n","operationId":"StartFrameRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartFrameRecordingRequest"}}},"description":"StartFrameRecordingRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartFrameRecordingResponse"}}},"description":"StartFrameRecordingResponse"},"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":"Start frame recording","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/start_recording":{"post":{"description":"Starts recording\n\nSends events:\n- call.recording_started\n","operationId":"StartRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRecordingRequest"}}},"description":"StartRecordingRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRecordingResponse"}}},"description":"StartRecordingResponse"},"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":"Start recording","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/start_transcription":{"post":{"description":"Starts transcription\n","operationId":"StartTranscription","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartTranscriptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartTranscriptionResponse"}}},"description":"StartTranscriptionResponse"},"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":"Start transcription","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_broadcasting":{"post":{"description":"Stops HLS broadcasting\n","operationId":"StopHLSBroadcasting","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopHLSBroadcastingResponse"}}},"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":"Stop HLS broadcasting","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_closed_captions":{"post":{"description":"Stops closed captions\n\nSends events:\n- call.transcription_stopped\n","operationId":"StopClosedCaptions","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopClosedCaptionsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopClosedCaptionsResponse"}}},"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":"Stop closed captions","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_frame_recording":{"post":{"description":"Stops frame recording\n\nSends events:\n- call.frame_recording_stopped\n","operationId":"StopFrameRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopFrameRecordingResponse"}}},"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":"Stop frame recording","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_live":{"post":{"description":"\n\nSends events:\n- call.updated\n","operationId":"StopLive","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopLiveRequest"}}},"description":"StopLiveRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopLiveResponse"}}},"description":"StopLiveResponse"},"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":"Set call as not live","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_recording":{"post":{"description":"Stops recording\n\nSends events:\n- call.recording_stopped\n","operationId":"StopRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopRecordingResponse"}}},"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":"Stop recording","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_transcription":{"post":{"description":"Stops transcription\n\nSends events:\n- call.transcription_stopped\n","operationId":"StopTranscription","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopTranscriptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopTranscriptionResponse"}}},"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":"Stop transcription","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/transcriptions":{"get":{"description":"Lists transcriptions\n","operationId":"ListTranscriptions","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTranscriptionsResponse"}}},"description":"ListTranscriptionsResponse"},"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":"List transcriptions","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/unblock":{"post":{"description":"Removes the block for a user on a call. The user will be able to join the call again.\n\nSends events:\n- call.unblocked_user\n","operationId":"UnblockUser","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUserRequest"}}},"description":"UnblockUserRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUserResponse"}}},"description":"UnblockUserResponse"},"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":"Unblocks user on a call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/unpin":{"post":{"description":"Unpins a track for all users in the call.\n","operationId":"VideoUnpin","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnpinRequest"}}},"description":"UnpinRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnpinResponse"}}},"description":"UnpinResponse"},"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":"Unpin","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/user_permissions":{"post":{"description":"Updates user permissions\n\nSends events:\n- call.permissions_updated\n","operationId":"UpdateUserPermissions","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"005.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"005.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUserPermissionsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUserPermissionsResponse"}}},"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":"Update user permissions","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/{session}/recordings/{filename}":{"delete":{"description":"Deletes recording\n","operationId":"DeleteRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"path","name":"session","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"003"}},{"in":"path","name":"filename","required":true,"schema":{"maxLength":256,"type":"string","writeOnly":true,"x-stream-index":"004"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteRecordingResponse"}}},"description":"DeleteRecordingResponse"},"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":"Delete recording","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/{session}/transcriptions/{filename}":{"delete":{"description":"Deletes transcription\n","operationId":"DeleteTranscription","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"path","name":"session","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"003"}},{"in":"path","name":"filename","required":true,"schema":{"maxLength":256,"type":"string","writeOnly":true,"x-stream-index":"004"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteTranscriptionResponse"}}},"description":"DeleteTranscriptionResponse"},"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":"Delete transcription","tags":["product:video"]}},"/api/v2/video/calls":{"post":{"description":"Query calls with filter query\n","operationId":"QueryCalls","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallsRequest"}}},"description":"QueryCallsRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallsResponse"}}},"description":"QueryCallsResponse"},"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":"Query call","tags":["product:video"]}},"/api/v2/video/calltypes":{"get":{"description":"\n","operationId":"ListCallTypes","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListCallTypeResponse"}}},"description":"ListCallTypeResponse"},"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":"List Call Type","tags":["product:video"]},"post":{"description":"\n","operationId":"CreateCallType","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCallTypeRequest"}}},"description":"CreateCallTypeRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCallTypeResponse"}}},"description":"CreateCallTypeResponse"},"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":"Create Call Type","tags":["product:video"]}},"/api/v2/video/calltypes/{name}":{"delete":{"description":"\n","operationId":"DeleteCallType","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete Call Type","tags":["product:video"]},"get":{"description":"\n","operationId":"GetCallType","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCallTypeResponse"}}},"description":"GetCallTypeResponse"},"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":"Get Call Type","tags":["product:video"]},"put":{"description":"\n","operationId":"UpdateCallType","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallTypeRequest"}}},"description":"UpdateCallTypeRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallTypeResponse"}}},"description":"UpdateCallTypeResponse"},"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":"Update Call Type","tags":["product:video"]}},"/api/v2/video/edges":{"get":{"description":"Returns the list of all edges available for video calls.\n","operationId":"GetEdges","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetEdgesResponse"}}},"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":"Get Edges","tags":["product:video"]}},"/api/v2/video/stats":{"post":{"description":"\n","operationId":"QueryAggregateCallStats","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryAggregateCallStatsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryAggregateCallStatsResponse"}}},"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":"Query Aggregate call Stats","tags":["product:video"]}}},"security":[{"JWT":[],"api_key":[],"stream-auth-type":[]},{"api_key":[],"stream-auth-type":[]}],"servers":[{"description":"Stream API","url":"https://chat.stream-io-api.com"}]} \ No newline at end of file +{"components":{"schemas":{"AIImageConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"ocr_rules":{"items":{"$ref":"#/components/schemas/OCRRule"},"type":"array","x-stream-index":"004"},"rules":{"items":{"$ref":"#/components/schemas/AWSRekognitionRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules","ocr_rules"],"type":"object"},"AITextConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"profile":{"type":"string","x-stream-index":"003"},"rules":{"items":{"$ref":"#/components/schemas/BodyguardRule"},"type":"array","x-stream-index":"004"},"severity_rules":{"items":{"$ref":"#/components/schemas/BodyguardSeverityRule"},"type":"array","x-stream-index":"005"}},"required":["enabled","profile","rules","severity_rules"],"type":"object"},"AIVideoConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AWSRekognitionRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"APIError":{"nullable":true,"properties":{"StatusCode":{"description":"Response HTTP status code","format":"int32","title":"Status code","type":"integer","x-stream-index":"004"},"code":{"description":"API error code","format":"int32","title":"Code","type":"integer","x-stream-index":"001"},"details":{"description":"Additional error-specific information","items":{"type":"integer"},"title":"Details","type":"array","x-stream-index":"007"},"duration":{"description":"Request duration","title":"Duration","type":"string","x-stream-index":"005"},"exception_fields":{"additionalProperties":{"type":"string"},"description":"Additional error info","title":"Exception fields","type":"object","x-stream-index":"003"},"message":{"description":"Message describing an error","title":"Message","type":"string","x-stream-index":"002"},"more_info":{"description":"URL with additional information","title":"More info","type":"string","x-stream-index":"006"},"unrecoverable":{"description":"Flag that indicates if the error is unrecoverable, requests that return unrecoverable errors should not be retried, this error only applies to the request that caused it","title":"Unrecoverable","type":"boolean","x-stream-index":"008"}},"required":["code","message","StatusCode","duration","more_info","details"],"title":"Error response","type":"object"},"APNConfig":{"properties":{"Disabled":{"type":"boolean","writeOnly":true,"x-stream-index":"005"},"auth_key":{"type":"string","x-stream-index":"006.001"},"auth_type":{"enum":["certificate","token"],"type":"string","x-stream-index":"001"},"bundle_id":{"type":"string","x-stream-index":"004"},"development":{"type":"boolean","x-stream-index":"002"},"host":{"type":"string","x-stream-index":"003"},"key_id":{"type":"string","x-stream-index":"006.002"},"notification_template":{"type":"string","x-stream-index":"008"},"p12_cert":{"type":"string","x-stream-index":"007.001"},"team_id":{"type":"string","x-stream-index":"006.003"}},"type":"object"},"APNConfigFields":{"properties":{"auth_key":{"type":"string","x-stream-index":"009"},"auth_type":{"type":"string","x-stream-index":"003"},"bundle_id":{"type":"string","x-stream-index":"006"},"development":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"host":{"type":"string","x-stream-index":"005"},"key_id":{"type":"string","x-stream-index":"008"},"notification_template":{"type":"string","x-stream-index":"004"},"p12_cert":{"type":"string","x-stream-index":"010"},"team_id":{"type":"string","x-stream-index":"007"}},"required":["enabled","development"],"type":"object"},"APNS":{"properties":{"body":{"type":"string","x-stream-index":"002"},"content-available":{"format":"int32","type":"integer","x-stream-index":"004"},"data":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"mutable-content":{"format":"int32","type":"integer","x-stream-index":"005"},"sound":{"type":"string","x-stream-index":"003"},"title":{"type":"string","x-stream-index":"001"}},"required":["title","body"],"type":"object"},"AWSRekognitionRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"},"min_confidence":{"format":"float","maximum":100,"minimum":0,"type":"number","x-stream-index":"003"}},"required":["label","action","min_confidence"],"type":"object"},"AcceptFeedMemberInviteRequest":{"nullable":true,"properties":{"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"title":"Accept Feed Member Invite Request","type":"object"},"AcceptFeedMemberInviteResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"member":{"$ref":"#/components/schemas/FeedMemberResponse","description":"The feed member after accepting the invite","title":"Feed Member","x-stream-index":"001"}},"required":["member","duration"],"title":"Accept Feed Member Invite Response","type":"object"},"AcceptFollowRequest":{"nullable":true,"properties":{"follower_role":{"description":"Optional role for the follower in the follow relationship","title":"Follower Role","type":"string","x-stream-index":"003"},"source":{"description":"Fully qualified ID of the source feed","maxLength":255,"title":"Source Feed ID","type":"string","x-stream-index":"001"},"target":{"description":"Fully qualified ID of the target feed","maxLength":255,"title":"Target Feed ID","type":"string","x-stream-index":"002"}},"required":["source","target"],"title":"Accept Follow Request","type":"object"},"AcceptFollowResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"follow":{"$ref":"#/components/schemas/FollowResponse","description":"The accepted follow relationship","title":"Follow","x-stream-index":"001"}},"required":["follow","duration"],"title":"Accept Follow Response","type":"object"},"Action":{"nullable":true,"properties":{"name":{"type":"string","x-stream-index":"001"},"style":{"type":"string","x-stream-index":"003"},"text":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"004"},"value":{"type":"string","x-stream-index":"005"}},"required":["name","text","type"],"type":"object"},"ActionLog":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"002"},"reason":{"type":"string","x-stream-index":"008"},"reporter_type":{"type":"string","x-stream-index":"009"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"014"},"review_queue_item_id":{"type":"string","x-stream-index":"012"},"target_user":{"$ref":"#/components/schemas/User","x-stream-index":"013"},"target_user_id":{"type":"string","x-stream-index":"011"},"type":{"type":"string","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007"}},"required":["id","created_at","type","reason","reporter_type","custom","target_user_id","review_queue_item_id"],"type":"object"},"ActionLogResponse":{"nullable":true,"properties":{"created_at":{"description":"Timestamp when the action was taken","format":"date-time","title":"Created At","type":"number","x-stream-index":"002"},"custom":{"additionalProperties":{},"description":"Additional metadata about the action","title":"Custom","type":"object","x-stream-index":"007"},"id":{"description":"Unique identifier of the action log","title":"ID","type":"string","x-stream-index":"001"},"reason":{"description":"Reason for the moderation action","title":"Reason","type":"string","x-stream-index":"006"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"Associated review queue item","title":"Review Queue Item","x-stream-index":"008"},"target_user":{"$ref":"#/components/schemas/UserResponse","description":"User who was the target of the action","title":"Target User","x-stream-index":"009"},"target_user_id":{"description":"ID of the user who was the target of the action","title":"Target User ID","type":"string","x-stream-index":"010"},"type":{"description":"Type of moderation action","title":"Type","type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who performed the action","title":"User","x-stream-index":"004"},"user_id":{"description":"ID of the user who performed the action","title":"User ID","type":"string","x-stream-index":"005"}},"required":["id","created_at","type","user_id","reason","custom","target_user_id"],"type":"object"},"ActionSequence":{"properties":{"action":{"type":"string","x-stream-index":"001"},"blur":{"type":"boolean","x-stream-index":"005"},"cooldown_period":{"format":"int32","type":"integer","x-stream-index":"004"},"threshold":{"format":"int32","type":"integer","x-stream-index":"002"},"time_window":{"format":"int32","type":"integer","x-stream-index":"003"},"warning":{"type":"boolean","x-stream-index":"006"},"warning_text":{"type":"string","x-stream-index":"007"}},"required":["action","threshold","time_window","cooldown_period","blur","warning","warning_text"],"type":"object"},"ActiveCallsBitrateStats":{"properties":{"p10":{"format":"float","type":"number","x-stream-index":"001"},"p50":{"format":"float","type":"number","x-stream-index":"002"}},"required":["p10","p50"],"type":"object"},"ActiveCallsFPSStats":{"properties":{"p05":{"format":"float","type":"number","x-stream-index":"001"},"p10":{"format":"float","type":"number","x-stream-index":"002"},"p50":{"format":"float","type":"number","x-stream-index":"003"},"p90":{"format":"float","type":"number","x-stream-index":"004"}},"required":["p05","p10","p50","p90"],"type":"object"},"ActiveCallsLatencyStats":{"properties":{"p50":{"format":"float","type":"number","x-stream-index":"001"},"p90":{"format":"float","type":"number","x-stream-index":"002"}},"required":["p50","p90"],"type":"object"},"ActiveCallsMetrics":{"properties":{"join_call_api":{"$ref":"#/components/schemas/JoinCallAPIMetrics","x-stream-index":"001"},"publishers":{"$ref":"#/components/schemas/PublishersMetrics","x-stream-index":"002"},"subscribers":{"$ref":"#/components/schemas/SubscribersMetrics","x-stream-index":"003"}},"type":"object"},"ActiveCallsResolutionStats":{"properties":{"p10":{"format":"float","type":"number","x-stream-index":"001"},"p50":{"format":"float","type":"number","x-stream-index":"002"}},"required":["p10","p50"],"type":"object"},"ActiveCallsSummary":{"properties":{"active_calls":{"format":"int32","type":"integer","x-stream-index":"001"},"active_publishers":{"format":"int32","type":"integer","x-stream-index":"002"},"active_subscribers":{"format":"int32","type":"integer","x-stream-index":"003"},"participants":{"format":"int32","type":"integer","x-stream-index":"004"}},"required":["active_calls","active_publishers","active_subscribers","participants"],"type":"object"},"ActivityAddedEvent":{"description":"Emitted when an activity is added to a feed.","nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","description":"The activity that was added","title":"Activity","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"type":"string","x-stream-index":"002.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.activity.added","description":"The type of event: \"feeds.activity.added\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who added the activity","title":"User","x-stream-index":"003.001"}},"required":["activity","type","created_at","custom","fid"],"title":"ActivityAddedEvent","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"},"ActivityDeletedEvent":{"description":"Emitted when an activity is deleted.","nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","description":"The activity that was updated","title":"Activity","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"type":"string","x-stream-index":"002.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.activity.deleted","description":"The type of event: \"feeds.activity.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","x-stream-index":"003.001"}},"required":["activity","type","created_at","custom","fid"],"title":"ActivityDeletedEvent","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"},"ActivityFeedbackRequest":{"description":"Request to provide feedback on an activity","nullable":true,"properties":{"hide":{"description":"Whether to hide this activity","title":"bool","type":"boolean","x-stream-index":"003"},"mute_user":{"description":"Whether to mute the user who created this activity","title":"bool","type":"boolean","x-stream-index":"005"},"reason":{"description":"Reason for the feedback (optional)","maxLength":1000,"title":"string","type":"string","x-stream-index":"006"},"report":{"description":"Whether to report this activity","title":"bool","type":"boolean","x-stream-index":"004"},"show_less":{"description":"Whether to show less content like this","title":"bool","type":"boolean","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"008.002"},"user_id":{"type":"string","x-stream-index":"008.001"}},"title":"Activity Feedback Request","type":"object"},"ActivityFeedbackResponse":{"description":"Response for activity feedback submission","nullable":true,"properties":{"activity_id":{"description":"The ID of the activity that received feedback","title":"string","type":"string","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["activity_id","duration"],"title":"Activity Feedback Response","type":"object"},"ActivityLocation":{"properties":{"lat":{"description":"Latitude coordinate","format":"float","title":"Latitude","type":"number","x-stream-index":"001"},"lng":{"description":"Longitude coordinate","format":"float","title":"Longitude","type":"number","x-stream-index":"002"}},"required":["lat","lng"],"title":"Activity Location","type":"object"},"ActivityMarkEvent":{"description":"Emitted when activities are marked as read, seen, or watched.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"006.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006.001.007"},"feed_visibility":{"type":"string","x-stream-index":"006.003"},"fid":{"type":"string","x-stream-index":"006.002"},"mark_all_read":{"description":"Whether all activities were marked as read","title":"Mark All Read","type":"boolean","x-stream-index":"004"},"mark_all_seen":{"description":"Whether all activities were marked as seen","title":"Mark All Seen","type":"boolean","x-stream-index":"005"},"mark_read":{"description":"The IDs of activities marked as read","items":{"type":"string"},"title":"Mark Read","type":"array","x-stream-index":"001"},"mark_seen":{"description":"The IDs of activities marked as seen","items":{"type":"string"},"title":"Mark Seen","type":"array","x-stream-index":"002"},"mark_watched":{"description":"The IDs of activities marked as watched","items":{"type":"string"},"title":"Mark Watched","type":"array","x-stream-index":"003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"006.001.004"},"type":{"default":"feeds.activity.marked","description":"The type of event: \"feeds.activity.marked\" in this case","title":"Event Type","type":"string","x-stream-index":"006.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who marked the activities","title":"User","x-stream-index":"007.001"}},"required":["type","created_at","custom","fid"],"title":"ActivityMarkEvent","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"},"ActivityMarkedEvent":{"properties":{"all_read":{"type":"boolean","x-stream-index":"006"},"all_seen":{"type":"boolean","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"feed_id":{"type":"string","x-stream-index":"003"},"marked_read":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"marked_watched":{"items":{"type":"string"},"type":"array","x-stream-index":"005"},"type":{"default":"activity.marked","type":"string","x-stream-index":"001.001"},"user_id":{"type":"string","x-stream-index":"002"}},"required":["type","created_at","user_id","feed_id","all_read","all_seen"],"title":"ActivityMarkedEvent","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"},"ActivityPinResponse":{"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","description":"The pinned activity","title":"Activity","x-stream-index":"002"},"created_at":{"description":"When the pin was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"004"},"feed":{"description":"ID of the feed where activity is pinned","title":"Feed ID","type":"string","x-stream-index":"003"},"updated_at":{"description":"When the pin was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who pinned the activity","title":"User","x-stream-index":"001"}},"required":["user","activity","feed","created_at","updated_at"],"title":"Activity Pin","type":"object"},"ActivityPinnedEvent":{"description":"Emitted when an activity is pinned.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"description":"The ID of the feed","title":"Feed ID","type":"string","x-stream-index":"002.002"},"pinned_activity":{"$ref":"#/components/schemas/PinActivityResponse","x-stream-index":"001"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.activity.pinned","description":"The type of event: \"feeds.activity.pinned\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who pinned the activity","title":"User","x-stream-index":"003.001"}},"required":["pinned_activity","type","created_at","custom","fid"],"title":"ActivityPinnedEvent","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"},"ActivityProcessorConfig":{"properties":{"type":{"description":"Type of activity processor (required)","title":"Type","type":"string","x-stream-index":"001"}},"required":["type"],"title":"Activity Processor Configuration","type":"object"},"ActivityReactionAddedEvent":{"description":"Emitted when a reaction is added to an activity.","nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"003.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.001.007"},"feed_visibility":{"type":"string","x-stream-index":"003.003"},"fid":{"type":"string","x-stream-index":"003.002"},"reaction":{"$ref":"#/components/schemas/FeedsReactionResponse","description":"The reaction that was added","title":"Reaction","x-stream-index":"002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.001.004"},"type":{"default":"feeds.activity.reaction.added","description":"The type of event: \"feeds.activity.reaction.added\" in this case","title":"Event Type","type":"string","x-stream-index":"003.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who added the reaction","title":"User","x-stream-index":"004.001"}},"required":["activity","reaction","type","created_at","custom","fid"],"title":"ActivityReactionAddedEvent","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"},"ActivityReactionDeletedEvent":{"description":"Emitted when a reaction is deleted from an activity.","nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"003.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.001.007"},"feed_visibility":{"type":"string","x-stream-index":"003.003"},"fid":{"type":"string","x-stream-index":"003.002"},"reaction":{"$ref":"#/components/schemas/FeedsReactionResponse","x-stream-index":"002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.001.004"},"type":{"default":"feeds.activity.reaction.deleted","description":"The type of the reaction that was removed","title":"Type","type":"string","x-stream-index":"003.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who removed the reaction","title":"User","x-stream-index":"004.001"}},"required":["activity","reaction","type","created_at","custom","fid"],"title":"ActivityReactionDeletedEvent","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"},"ActivityReactionUpdatedEvent":{"description":"Emitted when a reaction is updated on an activity.","nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"003.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.001.007"},"feed_visibility":{"type":"string","x-stream-index":"003.003"},"fid":{"type":"string","x-stream-index":"003.002"},"reaction":{"$ref":"#/components/schemas/FeedsReactionResponse","description":"The reaction that was updated","title":"Reaction","x-stream-index":"002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.001.004"},"type":{"default":"feeds.activity.reaction.updated","description":"The type of event: \"feeds.activity.reaction.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"003.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who updated the reaction","title":"User","x-stream-index":"004.001"}},"required":["activity","reaction","type","created_at","custom","fid"],"title":"ActivityReactionUpdatedEvent","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"},"ActivityRemovedFromFeedEvent":{"description":"Emitted when an activity is removed from a feed.","nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"type":"string","x-stream-index":"002.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.activity.removed_from_feed","description":"The type of event: \"feeds.activity.removed_from_feed\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who removed the activity","title":"User","x-stream-index":"003.001"}},"required":["activity","type","created_at","custom","fid"],"title":"ActivityRemovedFromFeedEvent","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"},"ActivityRequest":{"properties":{"attachments":{"description":"List of attachments for the activity","items":{"$ref":"#/components/schemas/Attachment"},"title":"Attachments","type":"array","x-stream-index":"006"},"custom":{"additionalProperties":{},"description":"Custom data for the activity","title":"Custom Data","type":"object","x-stream-index":"017"},"expires_at":{"description":"Expiration time for the activity","title":"Expires At","type":"string","x-stream-index":"010"},"feeds":{"description":"List of feed IDs to add the activity to","items":{"type":"string"},"maximum":255,"minimum":1,"title":"Feed IDs","type":"array","x-stream-index":"004"},"filter_tags":{"description":"Tags for filtering activities","items":{"type":"string"},"maximum":255,"title":"Filter Tags","type":"array","x-stream-index":"013"},"id":{"description":"Optional ID for the activity","maxLength":255,"title":"Activity ID","type":"string","x-stream-index":"001"},"interest_tags":{"description":"Tags for indicating user interests","items":{"type":"string"},"maximum":255,"title":"Interest Tags","type":"array","x-stream-index":"014"},"location":{"$ref":"#/components/schemas/ActivityLocation","description":"Geographic location related to the activity","title":"Location","x-stream-index":"009"},"mentioned_user_ids":{"description":"List of users mentioned in the activity","items":{"type":"string"},"maximum":255,"title":"Mentioned User IDs","type":"array","x-stream-index":"011"},"parent_id":{"description":"ID of parent activity for replies/comments","maxLength":255,"title":"Parent ID","type":"string","x-stream-index":"015"},"poll_id":{"description":"ID of a poll to attach to activity","title":"Poll ID","type":"string","x-stream-index":"016"},"search_data":{"additionalProperties":{},"description":"Additional data for search indexing","title":"Search Data","type":"object","x-stream-index":"012"},"text":{"description":"Text content of the activity","title":"Text","type":"string","x-stream-index":"005"},"type":{"description":"Type of activity","maxLength":255,"title":"Activity Type","type":"string","x-stream-index":"002"},"user_id":{"description":"ID of the user creating the activity","maxLength":255,"title":"User ID","type":"string","x-stream-index":"003"},"visibility":{"description":"Visibility setting for the activity","enum":["public","private","tag"],"title":"Visibility","type":"string","x-stream-index":"007"},"visibility_tag":{"description":"If visibility is 'tag', this is the tag name and is required","maxLength":32,"title":"Visibility Tag","type":"string","x-stream-index":"008"}},"required":["type","feeds"],"title":"Activity Request","type":"object"},"ActivityResponse":{"properties":{"attachments":{"description":"Media attachments for the activity","items":{"$ref":"#/components/schemas/Attachment"},"title":"Attachments","type":"array","x-stream-index":"009"},"bookmark_count":{"description":"Number of bookmarks on the activity","format":"int32","title":"Bookmark Count","type":"integer","x-stream-index":"028"},"comment_count":{"description":"Number of comments on the activity","format":"int32","title":"Comment Count","type":"integer","x-stream-index":"027"},"comments":{"description":"Comments on this activity","items":{"$ref":"#/components/schemas/CommentResponse"},"title":"Comments","type":"array","x-stream-index":"015"},"created_at":{"description":"When the activity was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"007"},"current_feed":{"$ref":"#/components/schemas/FeedResponse","description":"Feed context for this activity view. If an activity is added only to one feed, it's always set. If an activity is added to multiple feeds, it's only set when calling the GetOrCreateFeed endpoint.","title":"Current Feed","x-stream-index":"035"},"custom":{"additionalProperties":{},"description":"Custom data for the activity","title":"Custom Data","type":"object","x-stream-index":"011"},"deleted_at":{"description":"When the activity was deleted","format":"date-time","title":"Deleted At","type":"number","x-stream-index":"021"},"edited_at":{"description":"When the activity was last edited","format":"date-time","title":"Edited At","type":"number","x-stream-index":"020"},"expires_at":{"description":"When the activity will expire","format":"date-time","title":"Expires At","type":"number","x-stream-index":"022"},"feeds":{"description":"List of feed IDs containing this activity","items":{"type":"string"},"title":"Feeds","type":"array","x-stream-index":"004"},"filter_tags":{"description":"Tags for filtering","items":{"type":"string"},"title":"Filter Tags","type":"array","x-stream-index":"024"},"hidden":{"description":"If this activity is hidden for this user. For premium content where you want to show a preview","title":"Hidden","type":"boolean","x-stream-index":"036"},"id":{"description":"Unique identifier for the activity","title":"ID","type":"string","x-stream-index":"001"},"interest_tags":{"description":"Tags for user interests","items":{"type":"string"},"title":"Interest Tags","type":"array","x-stream-index":"025"},"latest_reactions":{"description":"Recent reactions to the activity","items":{"$ref":"#/components/schemas/FeedsReactionResponse"},"title":"Latest Reactions","type":"array","x-stream-index":"031"},"location":{"$ref":"#/components/schemas/ActivityLocation","description":"Geographic location related to the activity","title":"Location","x-stream-index":"017"},"mentioned_users":{"description":"Users mentioned in the activity","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Mentioned Users","type":"array","x-stream-index":"010"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","description":"Moderation information","title":"Moderation","x-stream-index":"026"},"notification_context":{"additionalProperties":{},"description":"Notification context data for the activity (if this is a reaction, comment, follow, etc.)","title":"Notification Context","type":"object","x-stream-index":"012"},"own_bookmarks":{"description":"Current user's bookmarks for this activity","items":{"$ref":"#/components/schemas/BookmarkResponse"},"title":"Own Bookmarks","type":"array","x-stream-index":"034"},"own_reactions":{"description":"Current user's reactions to this activity","items":{"$ref":"#/components/schemas/FeedsReactionResponse"},"title":"Own Reactions","type":"array","x-stream-index":"033"},"parent":{"$ref":"#/components/schemas/ActivityResponse","description":"Parent activity (if this is a reply/comment)","title":"Parent","x-stream-index":"018"},"poll":{"$ref":"#/components/schemas/PollResponseData","description":"Poll attached to this activity","title":"Poll","x-stream-index":"019"},"popularity":{"description":"Popularity score of the activity","format":"int32","title":"Popularity","type":"integer","x-stream-index":"013"},"reaction_count":{"description":"Number of reactions to the activity","format":"int32","title":"Reaction Count","type":"integer","x-stream-index":"030"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"description":"Grouped reactions by type","title":"Reaction Groups","type":"object","x-stream-index":"032"},"score":{"description":"Ranking score for this activity","format":"float","title":"Score","type":"number","x-stream-index":"014"},"search_data":{"additionalProperties":{},"description":"Data for search indexing","title":"Search Data","type":"object","x-stream-index":"023"},"share_count":{"description":"Number of times the activity was shared","format":"int32","title":"Share Count","type":"integer","x-stream-index":"029"},"text":{"description":"Text content of the activity","title":"Text","type":"string","x-stream-index":"016"},"type":{"description":"Type of activity","title":"Type","type":"string","x-stream-index":"002"},"updated_at":{"description":"When the activity was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"008"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who created the activity","title":"User","x-stream-index":"003"},"visibility":{"description":"Visibility setting for the activity","enum":["public","private","tag"],"title":"Visibility","type":"string","x-stream-index":"005"},"visibility_tag":{"description":"If visibility is 'tag', this is the tag name","title":"Visibility Tag","type":"string","x-stream-index":"006"}},"required":["id","type","user","feeds","visibility","created_at","updated_at","attachments","mentioned_users","custom","popularity","score","comments","search_data","filter_tags","interest_tags","comment_count","bookmark_count","share_count","reaction_count","latest_reactions","reaction_groups","own_reactions","own_bookmarks"],"title":"Base Activity","type":"object"},"ActivitySelectorConfig":{"properties":{"cutoff_time":{"description":"Time threshold for activity selection","format":"date-time","title":"Cutoff Time","type":"number","x-stream-index":"004"},"filter":{"additionalProperties":{},"description":"Filter for activity selection","title":"Filter","type":"object","x-stream-index":"002"},"min_popularity":{"description":"Minimum popularity threshold","format":"int32","title":"Minimum Popularity","type":"integer","x-stream-index":"005"},"sort":{"description":"Sort parameters for activity selection","items":{"$ref":"#/components/schemas/SortParam"},"title":"Sort","type":"array","x-stream-index":"003"},"type":{"description":"Type of selector","title":"Type","type":"string","x-stream-index":"001"}},"title":"Activity Selector Configuration","type":"object"},"ActivityUnpinnedEvent":{"description":"Emitted when an activity is unpinned.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"description":"The ID of the feed","title":"Feed ID","type":"string","x-stream-index":"002.002"},"pinned_activity":{"$ref":"#/components/schemas/PinActivityResponse","x-stream-index":"001"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.activity.unpinned","description":"The type of event: \"feeds.activity.unpinned\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who unpinned the activity","title":"User","x-stream-index":"003.001"}},"required":["pinned_activity","type","created_at","custom","fid"],"title":"ActivityUnpinnedEvent","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"},"ActivityUpdatedEvent":{"description":"Emitted when an activity is updated.","nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","description":"The activity that was updated","title":"Activity","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"type":"string","x-stream-index":"002.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.activity.updated","description":"The type of the event","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who updated the activity","title":"User","x-stream-index":"003.001"}},"required":["activity","type","created_at","custom","fid"],"title":"ActivityUpdatedEvent","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"},"AddActivityRequest":{"nullable":true,"properties":{"attachments":{"description":"List of attachments for the activity","items":{"$ref":"#/components/schemas/Attachment"},"title":"Attachments","type":"array","x-stream-index":"001.006"},"custom":{"additionalProperties":{},"description":"Custom data for the activity","title":"Custom Data","type":"object","x-stream-index":"001.017"},"expires_at":{"description":"Expiration time for the activity","title":"Expires At","type":"string","x-stream-index":"001.010"},"feeds":{"description":"List of feed IDs to add the activity to","items":{"type":"string"},"maximum":255,"minimum":1,"title":"Feed IDs","type":"array","x-stream-index":"001.004"},"filter_tags":{"description":"Tags for filtering activities","items":{"type":"string"},"maximum":255,"title":"Filter Tags","type":"array","x-stream-index":"001.013"},"id":{"description":"Optional ID for the activity","maxLength":255,"title":"Activity ID","type":"string","x-stream-index":"001.001"},"interest_tags":{"description":"Tags for indicating user interests","items":{"type":"string"},"maximum":255,"title":"Interest Tags","type":"array","x-stream-index":"001.014"},"location":{"$ref":"#/components/schemas/ActivityLocation","description":"Geographic location related to the activity","title":"Location","x-stream-index":"001.009"},"mentioned_user_ids":{"description":"List of users mentioned in the activity","items":{"type":"string"},"maximum":255,"title":"Mentioned User IDs","type":"array","x-stream-index":"001.011"},"parent_id":{"description":"ID of parent activity for replies/comments","maxLength":255,"title":"Parent ID","type":"string","x-stream-index":"001.015"},"poll_id":{"description":"ID of a poll to attach to activity","title":"Poll ID","type":"string","x-stream-index":"001.016"},"search_data":{"additionalProperties":{},"description":"Additional data for search indexing","title":"Search Data","type":"object","x-stream-index":"001.012"},"text":{"description":"Text content of the activity","title":"Text","type":"string","x-stream-index":"001.005"},"type":{"description":"Type of activity","maxLength":255,"title":"Activity Type","type":"string","x-stream-index":"001.002"},"user_id":{"description":"ID of the user creating the activity","maxLength":255,"title":"User ID","type":"string","x-stream-index":"001.003"},"visibility":{"description":"Visibility setting for the activity","enum":["public","private","tag"],"title":"Visibility","type":"string","x-stream-index":"001.007"},"visibility_tag":{"description":"If visibility is 'tag', this is the tag name and is required","maxLength":32,"title":"Visibility Tag","type":"string","x-stream-index":"001.008"}},"required":["type","feeds"],"title":"Activity Request","type":"object"},"AddActivityResponse":{"nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","description":"The created activity","title":"Activity","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["activity","duration"],"title":"Add Activity Response","type":"object"},"AddBookmarkRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"description":"Custom data for the bookmark","title":"Custom Data","type":"object","x-stream-index":"004"},"folder_id":{"description":"ID of the folder to add the bookmark to","maxLength":255,"title":"Folder ID","type":"string","x-stream-index":"002"},"new_folder":{"$ref":"#/components/schemas/AddFolderRequest","description":"Create a new folder for this bookmark","title":"New Folder","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"005.002"},"user_id":{"type":"string","x-stream-index":"005.001"}},"title":"Add Bookmark Request","type":"object"},"AddBookmarkResponse":{"nullable":true,"properties":{"bookmark":{"$ref":"#/components/schemas/BookmarkResponse","description":"The created bookmark","title":"Bookmark","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["bookmark","duration"],"title":"Add Bookmark Response","type":"object"},"AddCommentReactionRequest":{"nullable":true,"properties":{"create_notification_activity":{"description":"Whether to create a notification activity for this reaction","title":"boolean","type":"boolean","x-stream-index":"004"},"custom":{"additionalProperties":{},"description":"Optional custom data to add to the reaction","title":"object","type":"object","x-stream-index":"003"},"skip_push":{"type":"boolean","x-stream-index":"005"},"type":{"description":"The type of reaction, eg upvote, like, ...","maxLength":255,"title":"string","type":"string","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"007.002"},"user_id":{"type":"string","x-stream-index":"007.001"}},"required":["type"],"type":"object"},"AddCommentReactionResponse":{"nullable":true,"properties":{"comment":{"$ref":"#/components/schemas/CommentResponse","description":"The comment the reaction was added to","title":"object","x-stream-index":"001"},"duration":{"description":"Duration of the request","title":"string","type":"string","x-stream-index":"003.001"},"reaction":{"$ref":"#/components/schemas/FeedsReactionResponse","description":"The created or updated reaction","title":"object","x-stream-index":"002"}},"required":["comment","reaction","duration"],"type":"object"},"AddCommentRequest":{"nullable":true,"properties":{"attachments":{"description":"Media attachments for the reply","items":{"$ref":"#/components/schemas/Attachment"},"title":"Attachments","type":"array","x-stream-index":"004"},"comment":{"description":"Text content of the comment","title":"Comment","type":"string","x-stream-index":"003"},"create_notification_activity":{"description":"Whether to create a notification activity for this comment","title":"Create Notification Activity","type":"boolean","x-stream-index":"008"},"custom":{"additionalProperties":{},"description":"Custom data for the comment","title":"Custom Data","type":"object","x-stream-index":"007"},"mentioned_user_ids":{"description":"List of users mentioned in the reply","items":{"type":"string"},"maximum":255,"title":"Mentioned User IDs","type":"array","x-stream-index":"005"},"object_id":{"description":"ID of the object to comment on","title":"Object ID","type":"string","x-stream-index":"001"},"object_type":{"description":"Type of the object to comment on","title":"Object Type","type":"string","x-stream-index":"002"},"parent_id":{"description":"ID of parent comment for replies","title":"Parent ID","type":"string","x-stream-index":"006"},"skip_push":{"type":"boolean","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"010.002"},"user_id":{"type":"string","x-stream-index":"010.001"}},"required":["object_id","object_type","comment"],"title":"Add Comment Request","type":"object"},"AddCommentResponse":{"nullable":true,"properties":{"comment":{"$ref":"#/components/schemas/CommentResponse","description":"The created comment","title":"Comment","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["comment","duration"],"title":"Add Comment Response","type":"object"},"AddCommentsBatchRequest":{"nullable":true,"properties":{"comments":{"description":"List of comments to add","items":{"$ref":"#/components/schemas/AddCommentRequest"},"title":"Comments","type":"array","x-stream-index":"001"}},"required":["comments"],"title":"Add Comments Batch Request","type":"object"},"AddCommentsBatchResponse":{"nullable":true,"properties":{"comments":{"description":"List of comments added","items":{"$ref":"#/components/schemas/CommentResponse"},"title":"Comments","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["comments","duration"],"title":"Add Comments Batch Response","type":"object"},"AddFolderRequest":{"properties":{"custom":{"additionalProperties":{},"description":"Custom data for the folder","title":"Custom Data","type":"object","x-stream-index":"002"},"name":{"description":"Name of the folder","maxLength":255,"title":"Name","type":"string","x-stream-index":"001"}},"required":["name"],"title":"Add Folder Request","type":"object"},"AddReactionRequest":{"nullable":true,"properties":{"create_notification_activity":{"description":"Whether to create a notification activity for this reaction","title":"Create Notification Activity","type":"boolean","x-stream-index":"004"},"custom":{"additionalProperties":{},"description":"Custom data for the reaction","title":"Custom Data","type":"object","x-stream-index":"003"},"skip_push":{"type":"boolean","x-stream-index":"005"},"type":{"description":"Type of reaction","maxLength":255,"title":"Reaction Type","type":"string","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"006.002"},"user_id":{"type":"string","x-stream-index":"006.001"}},"required":["type"],"title":"Add Reaction Request","type":"object"},"AddReactionResponse":{"nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"reaction":{"$ref":"#/components/schemas/FeedsReactionResponse","description":"The created reaction","title":"Reaction","x-stream-index":"002"}},"required":["activity","reaction","duration"],"title":"Add Reaction Response","type":"object"},"AggregatedActivityResponse":{"properties":{"activities":{"description":"List of activities in this aggregation","items":{"$ref":"#/components/schemas/ActivityResponse"},"title":"Activities","type":"array","x-stream-index":"001"},"activity_count":{"description":"Number of activities in this aggregation","format":"int32","title":"Activity Count","type":"integer","x-stream-index":"002"},"created_at":{"description":"When the aggregation was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"006"},"group":{"description":"Grouping identifier","title":"Group","type":"string","x-stream-index":"004"},"score":{"description":"Ranking score for this aggregation","format":"float","title":"Score","type":"number","x-stream-index":"005"},"updated_at":{"description":"When the aggregation was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"007"},"user_count":{"description":"Number of unique users in this aggregation","format":"int32","title":"User Count","type":"integer","x-stream-index":"003"}},"required":["activities","activity_count","user_count","group","score","created_at","updated_at"],"title":"Aggregated Activity","type":"object"},"AggregationConfig":{"properties":{"format":{"description":"Format for activity aggregation","title":"Format","type":"string","x-stream-index":"001"}},"title":"Aggregation Configuration","type":"object"},"AnyEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"*","type":"string","x-stream-index":"001.001"}},"required":["type","created_at"],"title":"AnyEvent","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"},"AppResponseFields":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"019"},"async_url_enrich_enabled":{"type":"boolean","x-stream-index":"017"},"auto_translation_enabled":{"type":"boolean","x-stream-index":"020"},"before_message_send_hook_url":{"type":"string","x-stream-index":"021"},"call_types":{"additionalProperties":{"$ref":"#/components/schemas/CallType"},"type":"object","x-stream-index":"007"},"campaign_enabled":{"type":"boolean","x-stream-index":"034"},"cdn_expiration_seconds":{"format":"int32","type":"integer","x-stream-index":"037"},"channel_configs":{"additionalProperties":{"$ref":"#/components/schemas/ChannelConfig"},"type":"object","x-stream-index":"006"},"custom_action_handler_url":{"type":"string","x-stream-index":"022"},"datadog_info":{"$ref":"#/components/schemas/DataDogInfo","x-stream-index":"040"},"disable_auth_checks":{"type":"boolean","x-stream-index":"011"},"disable_permissions_checks":{"type":"boolean","x-stream-index":"012"},"enforce_unique_usernames":{"type":"string","x-stream-index":"023"},"event_hooks":{"items":{"$ref":"#/components/schemas/EventHook"},"type":"array","x-stream-index":"045"},"file_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","x-stream-index":"030"},"geofences":{"items":{"$ref":"#/components/schemas/GeofenceResponse"},"type":"array","x-stream-index":"039"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"033"},"guest_user_creation_disabled":{"type":"boolean","x-stream-index":"043"},"image_moderation_enabled":{"type":"boolean","x-stream-index":"016"},"image_moderation_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"018"},"image_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","x-stream-index":"031"},"moderation_bulk_submit_action_enabled":{"type":"boolean","x-stream-index":"048"},"moderation_dashboard_preferences":{"$ref":"#/components/schemas/ModerationDashboardPreferences","x-stream-index":"044"},"moderation_enabled":{"type":"boolean","x-stream-index":"041"},"moderation_llm_configurability_enabled":{"type":"boolean","x-stream-index":"049"},"moderation_multitenant_blocklist_enabled":{"type":"boolean","x-stream-index":"042"},"moderation_webhook_url":{"type":"string","x-stream-index":"005"},"multi_tenant_enabled":{"type":"boolean","x-stream-index":"015"},"name":{"type":"string","x-stream-index":"001"},"organization":{"type":"string","x-stream-index":"002"},"permission_version":{"type":"string","x-stream-index":"013"},"policies":{"additionalProperties":{"items":{"$ref":"#/components/schemas/Policy"},"type":"array"},"type":"object","x-stream-index":"008"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationFields","x-stream-index":"003"},"reminders_interval":{"format":"int32","type":"integer","x-stream-index":"036"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"032"},"sns_key":{"type":"string","x-stream-index":"028"},"sns_secret":{"type":"string","x-stream-index":"029"},"sns_topic_arn":{"type":"string","x-stream-index":"027"},"sqs_key":{"type":"string","x-stream-index":"025"},"sqs_secret":{"type":"string","x-stream-index":"026"},"sqs_url":{"type":"string","x-stream-index":"024"},"suspended":{"type":"boolean","x-stream-index":"009"},"suspended_explanation":{"type":"string","x-stream-index":"010"},"use_hook_v2":{"type":"boolean","x-stream-index":"046"},"user_response_time_enabled":{"type":"boolean","x-stream-index":"047"},"user_search_disallowed_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"014"},"webhook_events":{"items":{"type":"string"},"type":"array","x-stream-index":"035"},"webhook_url":{"type":"string","x-stream-index":"004"}},"required":["name","organization","push_notifications","webhook_url","moderation_webhook_url","channel_configs","call_types","policies","suspended","suspended_explanation","disable_auth_checks","disable_permissions_checks","permission_version","user_search_disallowed_roles","multi_tenant_enabled","image_moderation_enabled","async_url_enrich_enabled","auto_translation_enabled","custom_action_handler_url","enforce_unique_usernames","sqs_url","sqs_key","sqs_secret","sns_topic_arn","sns_key","sns_secret","file_upload_config","image_upload_config","grants","campaign_enabled","webhook_events","reminders_interval","cdn_expiration_seconds","video_provider","moderation_enabled","moderation_multitenant_blocklist_enabled","guest_user_creation_disabled","event_hooks","use_hook_v2","user_response_time_enabled","moderation_bulk_submit_action_enabled","moderation_llm_configurability_enabled"],"type":"object"},"AsyncBulkImageModerationEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"003.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.007"},"finished_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.004"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"task_id":{"type":"string","x-stream-index":"002.001"},"type":{"default":"export.bulk_image_moderation.success","type":"string","x-stream-index":"003.002"},"url":{"type":"string","x-stream-index":"001"}},"required":["url","task_id","started_at","finished_at","type","created_at","custom"],"title":"AsyncBulkImageModerationEvent","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"},"AsyncExportChannelsEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"003.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.007"},"finished_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.004"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"task_id":{"type":"string","x-stream-index":"002.001"},"type":{"default":"export.channels.success","type":"string","x-stream-index":"003.002"},"url":{"type":"string","x-stream-index":"001"}},"required":["url","task_id","started_at","finished_at","type","created_at","custom"],"title":"AsyncExportChannelsEvent","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"},"AsyncExportErrorEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"003.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.007"},"error":{"type":"string","x-stream-index":"001"},"finished_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.004"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"task_id":{"type":"string","x-stream-index":"002.001"},"type":{"default":"export.users.error","type":"string","x-stream-index":"003.002"}},"required":["error","task_id","started_at","finished_at","type","created_at","custom"],"title":"AsyncExportErrorEvent","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"},"AsyncExportModerationLogsEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"003.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.007"},"finished_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.004"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"task_id":{"type":"string","x-stream-index":"002.001"},"type":{"default":"export.moderation_logs.success","type":"string","x-stream-index":"003.002"},"url":{"type":"string","x-stream-index":"001"}},"required":["url","task_id","started_at","finished_at","type","created_at","custom"],"title":"AsyncExportModerationLogsEvent","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"},"AsyncExportUsersEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"003.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.007"},"finished_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.004"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"task_id":{"type":"string","x-stream-index":"002.001"},"type":{"default":"export.users.success","type":"string","x-stream-index":"003.002"},"url":{"type":"string","x-stream-index":"001"}},"required":["url","task_id","started_at","finished_at","type","created_at","custom"],"title":"AsyncExportUsersEvent","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"},"AsyncModerationCallbackConfig":{"properties":{"mode":{"enum":["CALLBACK_MODE_NONE","CALLBACK_MODE_REST","CALLBACK_MODE_TWIRP"],"type":"string","x-stream-index":"002"},"server_url":{"type":"string","x-stream-index":"001"}},"type":"object"},"AsyncModerationConfiguration":{"properties":{"callback":{"$ref":"#/components/schemas/AsyncModerationCallbackConfig","x-stream-index":"002"},"timeout_ms":{"format":"int32","type":"integer","x-stream-index":"001"}},"type":"object"},"Attachment":{"description":"An attachment is a message object that represents a file uploaded by a user.","nullable":true,"properties":{"actions":{"items":{"$ref":"#/components/schemas/Action"},"type":"array","x-stream-index":"015"},"asset_url":{"type":"string","x-stream-index":"017"},"author_icon":{"type":"string","x-stream-index":"007"},"author_link":{"type":"string","x-stream-index":"006"},"author_name":{"type":"string","x-stream-index":"005"},"color":{"type":"string","x-stream-index":"003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"018"},"fallback":{"type":"string","x-stream-index":"002"},"fields":{"items":{"$ref":"#/components/schemas/Field"},"type":"array","x-stream-index":"016"},"footer":{"type":"string","x-stream-index":"013"},"footer_icon":{"type":"string","x-stream-index":"014"},"giphy":{"$ref":"#/components/schemas/Images","x-stream-index":"019"},"image_url":{"type":"string","x-stream-index":"011"},"og_scrape_url":{"type":"string","x-stream-index":"020"},"original_height":{"format":"int32","type":"integer","x-stream-index":"022"},"original_width":{"format":"int32","type":"integer","x-stream-index":"021"},"pretext":{"type":"string","x-stream-index":"004"},"text":{"type":"string","x-stream-index":"010"},"thumb_url":{"type":"string","x-stream-index":"012"},"title":{"type":"string","x-stream-index":"008"},"title_link":{"type":"string","x-stream-index":"009"},"type":{"description":"Attachment type (e.g. image, video, url)","title":"Type","type":"string","x-stream-index":"001"}},"required":["custom"],"title":"Attachment","type":"object","x-stream-docs-page-id":"file_uploads"},"AudioSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"001"},"default_device":{"enum":["speaker","earpiece"],"type":"string","x-stream-index":"006"},"mic_default_on":{"type":"boolean","x-stream-index":"004"},"noise_cancellation":{"$ref":"#/components/schemas/NoiseCancellationSettings","x-stream-index":"007"},"opus_dtx_enabled":{"type":"boolean","x-stream-index":"002"},"redundant_coding_enabled":{"type":"boolean","x-stream-index":"003"},"speaker_default_on":{"type":"boolean","x-stream-index":"005"}},"required":["access_request_enabled","opus_dtx_enabled","redundant_coding_enabled","mic_default_on","speaker_default_on","default_device"],"type":"object"},"AudioSettingsRequest":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"001"},"default_device":{"enum":["speaker","earpiece"],"type":"string","x-stream-index":"006"},"mic_default_on":{"type":"boolean","x-stream-index":"004"},"noise_cancellation":{"$ref":"#/components/schemas/NoiseCancellationSettings","x-stream-index":"007"},"opus_dtx_enabled":{"type":"boolean","x-stream-index":"002"},"redundant_coding_enabled":{"type":"boolean","x-stream-index":"003"},"speaker_default_on":{"type":"boolean","x-stream-index":"005"}},"required":["default_device"],"type":"object"},"AudioSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"001"},"default_device":{"enum":["speaker","earpiece"],"type":"string","x-stream-index":"006"},"mic_default_on":{"type":"boolean","x-stream-index":"004"},"noise_cancellation":{"$ref":"#/components/schemas/NoiseCancellationSettings","x-stream-index":"007"},"opus_dtx_enabled":{"type":"boolean","x-stream-index":"002"},"redundant_coding_enabled":{"type":"boolean","x-stream-index":"003"},"speaker_default_on":{"type":"boolean","x-stream-index":"005"}},"required":["access_request_enabled","opus_dtx_enabled","redundant_coding_enabled","mic_default_on","speaker_default_on","default_device"],"type":"object"},"AutomodDetails":{"properties":{"action":{"type":"string","x-stream-index":"001"},"image_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"005"},"message_details":{"$ref":"#/components/schemas/FlagMessageDetails","x-stream-index":"004"},"original_message_type":{"type":"string","x-stream-index":"002"},"result":{"$ref":"#/components/schemas/MessageModerationResult","x-stream-index":"003"}},"type":"object"},"AutomodPlatformCircumventionConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AutomodRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"AutomodRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"003"},"label":{"type":"string","x-stream-index":"001"},"threshold":{"format":"float","maximum":1,"minimum":0,"type":"number","x-stream-index":"002"}},"required":["label","threshold","action"],"type":"object"},"AutomodSemanticFiltersConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AutomodSemanticFiltersRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"AutomodSemanticFiltersRule":{"properties":{"action":{"enum":["flag","shadow","remove"],"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"threshold":{"format":"float","maximum":1,"minimum":0,"type":"number","x-stream-index":"002"}},"required":["name","threshold","action"],"type":"object"},"AutomodToxicityConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/AutomodRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"AzureRequest":{"description":"Config for creating Azure Blob Storage storage","properties":{"abs_account_name":{"description":"The account name","title":"AccountName","type":"string","x-stream-index":"001"},"abs_client_id":{"description":"The client id","title":"ClientID","type":"string","x-stream-index":"003"},"abs_client_secret":{"description":"The client secret","title":"ClientSecret","type":"string","x-stream-index":"004"},"abs_tenant_id":{"description":"The tenant id","title":"TenantID","type":"string","x-stream-index":"002"}},"required":["abs_account_name","abs_tenant_id","abs_client_id","abs_client_secret"],"title":"AzureRequest","type":"object"},"BackstageSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"BackstageSettingsRequest":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"002"}},"type":"object"},"BackstageSettingsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"Ban":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"012"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"011"},"expires":{"format":"date-time","type":"number","x-stream-index":"007"},"reason":{"type":"string","x-stream-index":"008"},"shadow":{"type":"boolean","x-stream-index":"009"},"target":{"$ref":"#/components/schemas/User","x-stream-index":"006"}},"required":["shadow","created_at"],"type":"object"},"BanActionRequest":{"properties":{"channel_ban_only":{"type":"boolean","x-stream-index":"003"},"delete_messages":{"enum":["soft","pruning","hard"],"type":"string","x-stream-index":"005"},"ip_ban":{"type":"boolean","x-stream-index":"004"},"reason":{"type":"string","x-stream-index":"002"},"shadow":{"type":"boolean","x-stream-index":"001"},"timeout":{"format":"int32","type":"integer","x-stream-index":"006"}},"type":"object"},"BanOptions":{"properties":{"duration":{"format":"int32","type":"integer","x-stream-index":"001"},"ip_ban":{"type":"boolean","x-stream-index":"004"},"reason":{"type":"string","x-stream-index":"002"},"shadow_ban":{"type":"boolean","x-stream-index":"003"}},"type":"object"},"BanRequest":{"nullable":true,"properties":{"banned_by":{"$ref":"#/components/schemas/UserRequest","description":"Details about the user performing the ban","title":"Banned By","x-stream-index":"008"},"banned_by_id":{"description":"ID of the user performing the ban","title":"Banned By ID","type":"string","x-stream-index":"007"},"channel_cid":{"description":"Channel where the ban applies","title":"Channel CID","type":"string","x-stream-index":"004"},"delete_messages":{"enum":["soft","pruning","hard"],"type":"string","x-stream-index":"009"},"ip_ban":{"description":"Whether to ban the user's IP address","title":"IP Ban","type":"boolean","x-stream-index":"006"},"reason":{"description":"Optional explanation for the ban","title":"Reason","type":"string","x-stream-index":"003"},"shadow":{"description":"Whether this is a shadow ban","title":"Shadow","type":"boolean","x-stream-index":"005"},"target_user_id":{"description":"ID of the user to ban","title":"Target User ID","type":"string","x-stream-index":"001"},"timeout":{"description":"Duration of the ban in minutes","minimum":0,"title":"Timeout","type":"integer","x-stream-index":"002"}},"required":["target_user_id"],"type":"object"},"BanResponse":{"nullable":true,"properties":{"banned_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"006"},"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"expires":{"format":"date-time","type":"number","x-stream-index":"003"},"reason":{"type":"string","x-stream-index":"004"},"shadow":{"type":"boolean","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"}},"required":["created_at"],"type":"object"},"BlockContentOptions":{"properties":{"reason":{"type":"string","x-stream-index":"001"}},"type":"object"},"BlockListConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/BlockListRule"},"maximum":10,"type":"array","x-stream-index":"003"}},"required":["enabled","rules"],"type":"object"},"BlockListOptions":{"properties":{"behavior":{"description":"Blocklist behavior","enum":["flag","block","shadow_block"],"title":"Behavior","type":"string","x-stream-index":"002"},"blocklist":{"description":"Blocklist name","title":"Blocklist","type":"string","x-stream-index":"001"}},"required":["blocklist","behavior"],"type":"object"},"BlockListResponse":{"description":"Block list contains restricted words","properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001"},"id":{"type":"string","x-stream-index":"003"},"name":{"description":"Block list name","title":"Name","type":"string","x-stream-index":"004"},"team":{"type":"string","x-stream-index":"007"},"type":{"description":"Block list type.","title":"Type","type":"string","x-stream-index":"005"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"002"},"words":{"description":"List of words to block","items":{"type":"string"},"title":"Words","type":"array","x-stream-index":"006"}},"required":["name","type","words"],"title":"Block list","type":"object","x-stream-docs-page-id":"block_lists"},"BlockListRule":{"properties":{"action":{"enum":["flag","mask_flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"002"}},"required":["name","team","action"],"type":"object"},"BlockUserRequest":{"description":"BlockUserRequest is the payload for blocking a user.","nullable":true,"properties":{"user_id":{"description":"the user to block","title":"UserID","type":"string","x-stream-index":"003"}},"required":["user_id"],"title":"BlockUserRequest","type":"object"},"BlockUserResponse":{"description":"BlockUserResponse is the payload for blocking a user.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"BlockUserResponse","type":"object"},"BlockUsersRequest":{"nullable":true,"properties":{"blocked_user_id":{"description":"User id to block","title":"BlockedUserID","type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"required":["blocked_user_id"],"type":"object"},"BlockUsersResponse":{"nullable":true,"properties":{"blocked_by_user_id":{"description":"User id who blocked another user","title":"BlockedByUserID","type":"string","x-stream-index":"002"},"blocked_user_id":{"description":"User id who got blocked","title":"BlockedUserID","type":"string","x-stream-index":"003"},"created_at":{"description":"Timestamp when the user was blocked","format":"date-time","title":"CreatedAt","type":"number","x-stream-index":"004"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration","blocked_by_user_id","blocked_user_id","created_at"],"type":"object"},"BlockedUserEvent":{"description":"This event is sent to call participants to notify when a user is blocked on a call, clients can use this event to show a notification.\nIf the user is the current user, the client should leave the call screen as well","properties":{"blocked_by_user":{"$ref":"#/components/schemas/UserResponse","description":"The user that blocked the user, null if the user was blocked by server-side","title":"Blocked by","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.blocked_user","description":"The type of event: \"call.blocked_user\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user that was blocked","title":"User","x-stream-index":"003"}},"required":["type","created_at","call_cid","user"],"title":"BlockedUserEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"BlockedUserResponse":{"nullable":true,"properties":{"blocked_user":{"$ref":"#/components/schemas/UserResponse","description":"User who got blocked","title":"User","x-stream-index":"003"},"blocked_user_id":{"description":"ID of the user who got blocked","title":"UserID","type":"string","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who blocked another user","title":"User","x-stream-index":"001"},"user_id":{"description":"ID of the user who blocked another user","title":"UserID","type":"string","x-stream-index":"002"}},"required":["user","user_id","blocked_user","blocked_user_id","created_at"],"type":"object"},"BodyguardRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"},"severity_rules":{"items":{"$ref":"#/components/schemas/BodyguardSeverityRule"},"type":"array","x-stream-index":"003"}},"required":["label","action","severity_rules"],"type":"object"},"BodyguardSeverityRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"severity":{"enum":["low","medium","high","critical"],"type":"string","x-stream-index":"001"}},"required":["severity","action"],"type":"object"},"BookmarkAddedEvent":{"description":"Emitted when a user bookmarks an activity.","nullable":true,"properties":{"bookmark":{"$ref":"#/components/schemas/BookmarkResponse","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.bookmark.added","description":"The type of event: \"feeds.bookmark.added\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who added the bookmark","title":"User","x-stream-index":"003.001"}},"required":["bookmark","type","created_at","custom"],"title":"BookmarkAddedEvent","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"},"BookmarkDeletedEvent":{"description":"Emitted when a user deletes a bookmark from an activity.","nullable":true,"properties":{"bookmark":{"$ref":"#/components/schemas/BookmarkResponse","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.bookmark.deleted","description":"The type of event: \"feeds.bookmark.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who removed the bookmark","title":"User","x-stream-index":"003.001"}},"required":["bookmark","type","created_at","custom"],"title":"BookmarkDeletedEvent","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"},"BookmarkFolderDeletedEvent":{"description":"Emitted when a bookmark folder is deleted.","nullable":true,"properties":{"bookmark_folder":{"$ref":"#/components/schemas/BookmarkFolderResponse","description":"The bookmark folder that was deleted","title":"Bookmark Folder","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.bookmark_folder.deleted","description":"The type of event: \"feeds.bookmark_folder.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who deleted the bookmark folder","title":"User","x-stream-index":"003.001"}},"required":["bookmark_folder","type","created_at","custom"],"title":"BookmarkFolderDeletedEvent","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"},"BookmarkFolderResponse":{"properties":{"created_at":{"description":"When the folder was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"004"},"custom":{"additionalProperties":{},"description":"Custom data for the folder","title":"Custom Data","type":"object","x-stream-index":"003"},"id":{"description":"Unique identifier for the folder","title":"ID","type":"string","x-stream-index":"001"},"name":{"description":"Name of the folder","title":"Name","type":"string","x-stream-index":"002"},"updated_at":{"description":"When the folder was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"005"}},"required":["id","name","created_at","updated_at"],"title":"Bookmark Folder","type":"object"},"BookmarkFolderUpdatedEvent":{"description":"Emitted when a bookmark folder is updated.","nullable":true,"properties":{"bookmark_folder":{"$ref":"#/components/schemas/BookmarkFolderResponse","description":"The bookmark folder that was updated","title":"Bookmark Folder","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.bookmark_folder.updated","description":"The type of event: \"feeds.bookmark_folder.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who updated the bookmark folder","title":"User","x-stream-index":"003.001"}},"required":["bookmark_folder","type","created_at","custom"],"title":"BookmarkFolderUpdatedEvent","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"},"BookmarkResponse":{"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","description":"The bookmarked activity","title":"Activity","x-stream-index":"002"},"created_at":{"description":"When the bookmark was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"005"},"custom":{"additionalProperties":{},"description":"Custom data for the bookmark","title":"Custom Data","type":"object","x-stream-index":"004"},"folder":{"$ref":"#/components/schemas/BookmarkFolderResponse","description":"Folder containing this bookmark","title":"Folder","x-stream-index":"003"},"updated_at":{"description":"When the bookmark was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"006"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who created the bookmark","title":"User","x-stream-index":"001"}},"required":["user","activity","created_at","updated_at"],"title":"Bookmark","type":"object"},"BookmarkUpdatedEvent":{"description":"Emitted when a user updates a bookmark.","nullable":true,"properties":{"bookmark":{"$ref":"#/components/schemas/BookmarkResponse","description":"The updated bookmark","title":"Bookmark","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.bookmark.updated","description":"The type of event: \"feeds.bookmark.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who updated the bookmark","title":"User","x-stream-index":"003.001"}},"required":["bookmark","type","created_at","custom"],"title":"BookmarkUpdatedEvent","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"},"Bound":{"properties":{"inclusive":{"type":"boolean","x-stream-index":"002"},"value":{"format":"float","type":"number","x-stream-index":"001"}},"required":["value","inclusive"],"type":"object"},"BroadcastSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettings","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettings","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"BroadcastSettingsRequest":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettingsRequest","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettingsRequest","x-stream-index":"003"}},"type":"object"},"BroadcastSettingsResponse":{"description":"BroadcastSettingsResponse is the payload for broadcasting settings","properties":{"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettingsResponse","title":"HLS","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettingsResponse","title":"RTMP","x-stream-index":"003"}},"required":["enabled","hls","rtmp"],"title":"BroadcastSettingsResponse","type":"object"},"BrowserDataResponse":{"properties":{"name":{"type":"string","x-stream-index":"001"},"version":{"type":"string","x-stream-index":"002"}},"type":"object"},"BulkImageModerationRequest":{"nullable":true,"properties":{"csv_file":{"description":"URL to CSV file containing image URLs to moderate","title":"string","type":"string","x-stream-index":"001"}},"required":["csv_file"],"type":"object"},"BulkImageModerationResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"task_id":{"description":"ID of the task for processing the bulk image moderation","title":"string","type":"string","x-stream-index":"001"}},"required":["task_id","duration"],"type":"object"},"Call":{"properties":{"AppPK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"002"},"Backstage":{"type":"boolean","writeOnly":true,"x-stream-index":"023"},"BlockedUserIDs":{"items":{"type":"string"},"type":"array","writeOnly":true,"x-stream-index":"018"},"BlockedUsers":{"items":{"$ref":"#/components/schemas/User"},"type":"array","writeOnly":true,"x-stream-index":"019"},"CID":{"type":"string","writeOnly":true,"x-stream-index":"005"},"CallType":{"$ref":"#/components/schemas/CallType","x-stream-index":"020"},"ChannelCID":{"type":"string","writeOnly":true,"x-stream-index":"032"},"CreatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"013"},"CreatedBy":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"CreatedByUserID":{"type":"string","writeOnly":true,"x-stream-index":"007"},"CurrentSessionID":{"type":"string","writeOnly":true,"x-stream-index":"024"},"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"012"},"DeletedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"028"},"EgressUpdatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"027"},"Egresses":{"items":{"$ref":"#/components/schemas/CallEgress"},"type":"array","writeOnly":true,"x-stream-index":"015"},"EndedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"017"},"ID":{"type":"string","writeOnly":true,"x-stream-index":"004"},"JoinAheadTimeSeconds":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"031"},"LastHeartbeatAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"030"},"LastSessionID":{"type":"string","writeOnly":true,"x-stream-index":"025"},"MemberCount":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"010"},"MemberLookup":{"$ref":"#/components/schemas/MemberLookup","x-stream-index":"011"},"Members":{"items":{"$ref":"#/components/schemas/CallMember"},"type":"array","writeOnly":true,"x-stream-index":"009"},"Session":{"$ref":"#/components/schemas/CallSession","x-stream-index":"026"},"Settings":{"$ref":"#/components/schemas/CallSettings","x-stream-index":"022"},"SettingsOverrides":{"$ref":"#/components/schemas/CallSettings","x-stream-index":"021"},"StartsAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"016"},"Team":{"type":"string","writeOnly":true,"x-stream-index":"006"},"ThumbnailURL":{"type":"string","writeOnly":true,"x-stream-index":"029"},"Type":{"type":"string","writeOnly":true,"x-stream-index":"003"},"UpdatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"014"}},"required":["AppPK","Type","ID","CID","Team","CreatedByUserID","Members","Custom","CreatedAt","UpdatedAt","Egresses","BlockedUserIDs","BlockedUsers","Backstage","CurrentSessionID","LastSessionID","ThumbnailURL","ChannelCID"],"type":"object"},"CallAcceptedEvent":{"description":"This event is sent when a user accepts a notification to join a call.","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.accepted","description":"The type of event: \"call.accepted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who accepted the call","title":"User","x-stream-index":"004"}},"required":["type","created_at","call_cid","call","user"],"title":"CallAcceptedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallClosedCaption":{"description":"CallClosedCaption represents a closed caption of a call.","properties":{"end_time":{"format":"date-time","title":"The end time of the closed caption.","type":"number","x-stream-index":"003"},"speaker_id":{"title":"The speaker ID of the closed caption.","type":"string","x-stream-index":"004"},"start_time":{"format":"date-time","title":"The start time of the closed caption.","type":"number","x-stream-index":"002"},"text":{"title":"The text of the closed caption.","type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserResponse","title":"The full user for the closed caption.","x-stream-index":"005"}},"required":["text","start_time","end_time","speaker_id","user"],"title":"CallClosedCaption","type":"object"},"CallClosedCaptionsFailedEvent":{"description":"This event is sent when call closed captions has failed","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.closed_captions_failed","description":"The type of event: \"call.closed_captions_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallClosedCaptionsFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallClosedCaptionsStartedEvent":{"description":"This event is sent when call closed caption has started","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.closed_captions_started","description":"The type of event: \"call.closed_captions_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallClosedCaptionsStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallClosedCaptionsStoppedEvent":{"description":"This event is sent when call closed captions has stopped","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.closed_captions_stopped","description":"The type of event: \"call.transcription_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallClosedCaptionsStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallCreatedEvent":{"description":"This event is sent when a call is created. Clients receiving this event should check if the ringing\nfield is set to true and if so, show the call screen","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"the members added to this call","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"004"},"type":{"default":"call.created","description":"The type of event: \"call.created\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","members"],"title":"CallCreatedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallDeletedEvent":{"description":"This event is sent when a call is deleted. Clients receiving this event should leave the call screen","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.deleted","description":"The type of event: \"call.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call"],"title":"CallDeletedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallDurationReport":{"properties":{"histogram":{"items":{"$ref":"#/components/schemas/ReportByHistogramBucket"},"type":"array","x-stream-index":"001"}},"required":["histogram"],"type":"object"},"CallDurationReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateCallDurationReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"CallEgress":{"nullable":true,"properties":{"app_pk":{"format":"int32","type":"integer","x-stream-index":"002"},"call_id":{"type":"string","x-stream-index":"004"},"call_type":{"type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/EgressTaskConfig","x-stream-index":"007"},"egress_id":{"type":"string","x-stream-index":"005"},"egress_type":{"type":"string","x-stream-index":"006"},"instance_ip":{"type":"string","x-stream-index":"008"},"started_at":{"format":"date-time","type":"number","x-stream-index":"010"},"state":{"type":"string","x-stream-index":"009"},"stopped_at":{"format":"date-time","type":"number","x-stream-index":"011"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"012"}},"required":["app_pk","call_type","call_id","egress_id","egress_type","instance_ip","state","started_at","updated_at"],"type":"object"},"CallEndedEvent":{"description":"This event is sent when a call is mark as ended for all its participants. Clients receiving this event should leave the call screen","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"reason":{"description":"The reason why the call ended, if available","title":"CallEndedReason","type":"string","x-stream-index":"005"},"type":{"default":"call.ended","description":"The type of event: \"call.ended\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who ended the call, null if the call was ended by the server","title":"User","x-stream-index":"004"}},"required":["type","created_at","call_cid","call"],"title":"CallEndedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallFrameRecordingFailedEvent":{"description":"This event is sent when frame recording has failed","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.frame_recording_failed","description":"The type of event: \"call.frame_recording_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","egress_id"],"title":"CallFrameRecordingFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallFrameRecordingFrameReadyEvent":{"description":"This event is sent when a frame is captured from a call","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"captured_at":{"description":"The time the frame was captured","format":"date-time","title":"CapturedAt","type":"number","x-stream-index":"006"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"008"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"track_type":{"description":"The type of the track frame was captured from (TRACK_TYPE_VIDEO|TRACK_TYPE_SCREEN_SHARE)","title":"TrackType","type":"string","x-stream-index":"004"},"type":{"default":"call.frame_recording_ready","description":"The type of event: \"call.frame_recording_ready\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"url":{"description":"The URL of the frame","title":"URL","type":"string","x-stream-index":"005"},"users":{"additionalProperties":{"$ref":"#/components/schemas/UserResponse"},"description":"The users in the frame","title":"Users","type":"object","x-stream-index":"007"}},"required":["type","created_at","call_cid","session_id","track_type","url","captured_at","users","egress_id"],"title":"CallFrameRecordingFrameReadyEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallFrameRecordingStartedEvent":{"description":"This event is sent when frame recording has started","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.frame_recording_started","description":"The type of event: \"call.frame_recording_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","egress_id"],"title":"CallFrameRecordingStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallFrameRecordingStoppedEvent":{"description":"This event is sent when frame recording has stopped","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.frame_recording_stopped","description":"The type of event: \"call.frame_recording_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","egress_id"],"title":"CallFrameRecordingStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallHLSBroadcastingFailedEvent":{"description":"This event is sent when HLS broadcasting has failed","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.hls_broadcasting_failed","description":"The type of event: \"call.hls_broadcasting_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallHLSBroadcastingFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallHLSBroadcastingStartedEvent":{"description":"This event is sent when HLS broadcasting has started","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"hls_playlist_url":{"type":"string","x-stream-index":"004"},"type":{"default":"call.hls_broadcasting_started","description":"The type of event: \"call.hls_broadcasting_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","hls_playlist_url"],"title":"CallHLSBroadcastingStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallHLSBroadcastingStoppedEvent":{"description":"This event is sent when HLS broadcasting has stopped","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.hls_broadcasting_stopped","description":"The type of event: \"call.hls_broadcasting_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallHLSBroadcastingStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallIngressResponse":{"description":"CallIngressResponse is the payload for ingress settings","properties":{"rtmp":{"$ref":"#/components/schemas/RTMPIngress","title":"RTMP","x-stream-index":"001"}},"required":["rtmp"],"title":"CallIngressResponse","type":"object"},"CallLiveStartedEvent":{"description":"This event is sent when a call is started. Clients receiving this event should start the call.","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.live_started","description":"The type of event: \"call.live_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call"],"title":"CallLiveStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMember":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"010"},"role":{"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["user_id","role","custom","created_at","updated_at"],"type":"object"},"CallMemberAddedEvent":{"description":"This event is sent when one or more members are added to a call","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"the members added to this call","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"004"},"type":{"default":"call.member_added","description":"The type of event: \"call.member_added\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","members"],"title":"CallMemberAddedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMemberRemovedEvent":{"description":"This event is sent when one or more members are removed from a call","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"the list of member IDs removed from the call","items":{"type":"string"},"title":"Members","type":"array","x-stream-index":"004"},"type":{"default":"call.member_removed","description":"The type of event: \"call.member_removed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","members"],"title":"CallMemberRemovedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMemberUpdatedEvent":{"description":"This event is sent when one or more members are updated","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"The list of members that were updated","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"004"},"type":{"default":"call.member_updated","description":"The type of event: \"call.member_updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","members"],"title":"CallMemberUpdatedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMemberUpdatedPermissionEvent":{"description":"This event is sent when one or more members get its role updated","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"capabilities_by_role":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"The capabilities by role for this call","title":"CapabilitiesByRole","type":"object","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"The list of members that were updated","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"005"},"type":{"default":"call.member_updated_permission","description":"The type of event: \"call.member_added\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","capabilities_by_role","members"],"title":"CallMemberUpdatedPermissionEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMissedEvent":{"description":"This event is sent to call members who did not accept/reject/join the call to notify they missed the call","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"List of members who missed the call","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"005"},"notify_user":{"type":"boolean","x-stream-index":"007"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.missed","description":"The type of event: \"call.notification\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The caller from whom the call was missed","title":"User","x-stream-index":"006"}},"required":["type","created_at","call_cid","session_id","call","members","user","notify_user"],"title":"CallMissedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallModerationBlurEvent":{"properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"type":{"default":"call.moderation_blur","type":"string","x-stream-index":"001.001"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["type","created_at","call_cid","user_id","custom"],"title":"CallModerationBlurEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallModerationWarningEvent":{"properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"message":{"type":"string","x-stream-index":"004"},"type":{"default":"call.moderation_warning","type":"string","x-stream-index":"001.001"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["type","created_at","call_cid","user_id","message","custom"],"title":"CallModerationWarningEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallNotificationEvent":{"description":"This event is sent to all call members to notify they are getting called","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"Call members","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"005"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.notification","description":"The type of event: \"call.notification\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user that sent the call notification","title":"User","x-stream-index":"006"}},"required":["type","created_at","call_cid","session_id","call","members","user"],"title":"CallNotificationEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallParticipant":{"nullable":true,"properties":{"JoinedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"004"},"Role":{"type":"string","writeOnly":true,"x-stream-index":"002"},"UserSessionID":{"type":"string","writeOnly":true,"x-stream-index":"003"},"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"001.046"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"001.017"},"banned":{"type":"boolean","x-stream-index":"001.016"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.013"},"id":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"001.023"},"language":{"type":"string","x-stream-index":"001.035"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"001.022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"001.026"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.042"},"role":{"type":"string","x-stream-index":"001.004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.005"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.009"}},"required":["id","role","teams_role","custom","banned","online","Role","UserSessionID","JoinedAt"],"type":"object"},"CallParticipantCountReport":{"properties":{"histogram":{"items":{"$ref":"#/components/schemas/ReportByHistogramBucket"},"type":"array","x-stream-index":"001"}},"required":["histogram"],"type":"object"},"CallParticipantCountReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateCallParticipantCountReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"CallParticipantResponse":{"properties":{"joined_at":{"format":"date-time","type":"number","x-stream-index":"004"},"role":{"type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"},"user_session_id":{"type":"string","x-stream-index":"002"}},"required":["user","user_session_id","role","joined_at"],"type":"object"},"CallReactionEvent":{"description":"This event is sent when a reaction is sent in a call, clients should use this to show the reaction in the call screen","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"reaction":{"$ref":"#/components/schemas/ReactionResponse","description":"the reaction object sent by the user on the call","title":"reaction","x-stream-index":"003"},"type":{"default":"call.reaction_new","description":"The type of event: \"call.reaction_new\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","reaction"],"title":"CallReactionEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRecording":{"description":"CallRecording represents a recording of a call.","properties":{"end_time":{"format":"date-time","title":"The end time of the recording.","type":"number","x-stream-index":"004"},"filename":{"title":"The filename of the recording.","type":"string","x-stream-index":"001"},"session_id":{"title":"The session ID of the recording.","type":"string","x-stream-index":"005"},"start_time":{"format":"date-time","title":"The start time of the recording.","type":"number","x-stream-index":"003"},"url":{"title":"The URL of the recording.","type":"string","x-stream-index":"002"}},"required":["filename","url","start_time","end_time","session_id"],"title":"CallRecording","type":"object"},"CallRecordingFailedEvent":{"description":"This event is sent when call recording has failed","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"003"},"type":{"default":"call.recording_failed","description":"The type of event: \"call.recording_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","egress_id"],"title":"CallRecordingFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRecordingReadyEvent":{"description":"This event is sent when call recording is ready","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"call_recording":{"$ref":"#/components/schemas/CallRecording","description":"The call recording object","title":"CallRecording","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.recording_ready","description":"The type of event: \"call.recording_ready\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call_recording","egress_id"],"title":"CallRecordingReadyEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRecordingStartedEvent":{"description":"This event is sent when call recording has started","properties":{"call_cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"egress_id":{"type":"string","x-stream-index":"001"},"type":{"default":"call.recording_started","description":"The type of event: \"call.recording_started\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001"}},"required":["egress_id","type","created_at","call_cid"],"title":"CallRecordingStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRecordingStoppedEvent":{"description":"This event is sent when call recording has stopped","properties":{"call_cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"egress_id":{"type":"string","x-stream-index":"001"},"type":{"default":"call.recording_stopped","description":"The type of event: \"call.recording_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001"}},"required":["egress_id","type","created_at","call_cid"],"title":"CallRecordingStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRejectedEvent":{"description":"This event is sent when a user rejects a notification to join a call.","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"reason":{"description":"Provides information about why the call was rejected. You can provide any value, but the Stream API and SDKs use these default values: rejected, cancel, timeout and busy","title":"Reason","type":"string","x-stream-index":"005"},"type":{"default":"call.rejected","description":"The type of event: \"call.rejected\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who rejected the call","title":"User","x-stream-index":"004"}},"required":["type","created_at","call_cid","call","user"],"title":"CallRejectedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallReportResponse":{"properties":{"ended_at":{"format":"date-time","type":"number","x-stream-index":"003"},"score":{"format":"float","type":"number","x-stream-index":"001"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002"}},"required":["score"],"type":"object"},"CallRequest":{"description":"CallRequest is the payload for creating a call.","properties":{"channel_cid":{"type":"string","x-stream-index":"009"},"created_by":{"$ref":"#/components/schemas/UserRequest","title":"The user that create this call","x-stream-index":"002"},"created_by_id":{"title":"The id of the user that create this call","type":"string","x-stream-index":"003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"members":{"items":{"$ref":"#/components/schemas/MemberRequest"},"maximum":100,"type":"array","x-stream-index":"005"},"settings_override":{"$ref":"#/components/schemas/CallSettingsRequest","x-stream-index":"006"},"starts_at":{"format":"date-time","type":"number","x-stream-index":"007"},"team":{"type":"string","x-stream-index":"001"},"video":{"type":"boolean","x-stream-index":"008"}},"title":"CallRequest","type":"object"},"CallResponse":{"description":"Represents a call","properties":{"backstage":{"type":"boolean","x-stream-index":"016"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"018"},"captioning":{"type":"boolean","x-stream-index":"013"},"channel_cid":{"type":"string","x-stream-index":"024"},"cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"The user that created the call","title":"Created By","x-stream-index":"007"},"current_session_id":{"type":"string","x-stream-index":"005"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"008"},"egress":{"$ref":"#/components/schemas/EgressResponse","x-stream-index":"021"},"ended_at":{"description":"Date/time when the call ended","format":"date-time","title":"Ended At","type":"number","x-stream-index":"014"},"id":{"description":"Call ID","title":"ID","type":"string","x-stream-index":"003"},"ingress":{"$ref":"#/components/schemas/CallIngressResponse","x-stream-index":"019"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"023"},"recording":{"type":"boolean","x-stream-index":"011"},"session":{"$ref":"#/components/schemas/CallSessionResponse","x-stream-index":"020"},"settings":{"$ref":"#/components/schemas/CallSettingsResponse","x-stream-index":"017"},"starts_at":{"description":"Date/time when the call will start","format":"date-time","title":"Starts At","type":"number","x-stream-index":"015"},"team":{"type":"string","x-stream-index":"006"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailResponse","x-stream-index":"022"},"transcribing":{"type":"boolean","x-stream-index":"012"},"type":{"description":"The type of call","title":"Type","type":"string","x-stream-index":"002"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"}},"required":["type","id","cid","current_session_id","created_by","custom","created_at","updated_at","recording","transcribing","captioning","backstage","settings","blocked_user_ids","ingress","egress"],"title":"CallResponse","type":"object"},"CallRingEvent":{"description":"This event is sent to all call members to notify they are getting called","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"005"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"Call members","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"006"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.ring","description":"The type of event: \"call.notification\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user that sent the call notification","title":"User","x-stream-index":"007"},"video":{"type":"boolean","x-stream-index":"008"}},"required":["type","created_at","call_cid","session_id","call","members","user","video"],"title":"CallRingEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRtmpBroadcastFailedEvent":{"description":"This event is sent when a call RTMP broadcast has failed","properties":{"call_cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"002.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.002"},"name":{"description":"Name of the given RTMP broadcast","title":"Name","type":"string","x-stream-index":"003"},"type":{"default":"call.rtmp_broadcast_failed","description":"The type of event: \"call.rtmp_broadcast_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","name"],"title":"CallRtmpBroadcastFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRtmpBroadcastStartedEvent":{"description":"This event is sent when RTMP broadcast has started","properties":{"call_cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"002.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.002"},"name":{"description":"Name of the given RTMP broadcast","title":"Name","type":"string","x-stream-index":"003"},"type":{"default":"call.rtmp_broadcast_started","description":"The type of event: \"call.rtmp_broadcast_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","name"],"title":"CallRtmpBroadcastStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRtmpBroadcastStoppedEvent":{"description":"This event is sent when RTMP broadcast has stopped","properties":{"call_cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"002.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.002"},"name":{"description":"Name of the given RTMP broadcast","title":"Name","type":"string","x-stream-index":"003"},"type":{"default":"call.rtmp_broadcast_stopped","description":"The type of event: \"call.rtmp_broadcast_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","name"],"title":"CallRtmpBroadcastStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSession":{"properties":{"AcceptedBy":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","writeOnly":true,"x-stream-index":"008"},"ActiveSFUs":{"items":{"$ref":"#/components/schemas/SFUIDLastSeen"},"type":"array","writeOnly":true,"x-stream-index":"016"},"AnonymousParticipantCount":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"019"},"AppPK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"002.001"},"CallID":{"type":"string","writeOnly":true,"x-stream-index":"002.003"},"CallType":{"type":"string","writeOnly":true,"x-stream-index":"002.002"},"CreatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"003"},"DeletedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"004"},"EndedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"006"},"LiveEndedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"013"},"LiveStartedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"012"},"MissedBy":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","writeOnly":true,"x-stream-index":"010"},"Participants":{"items":{"$ref":"#/components/schemas/CallParticipant"},"type":"array","writeOnly":true,"x-stream-index":"011"},"ParticipantsCountByRole":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","writeOnly":true,"x-stream-index":"018"},"RejectedBy":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","writeOnly":true,"x-stream-index":"009"},"RingAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"007"},"SFUIDs":{"items":{"type":"string"},"type":"array","writeOnly":true,"x-stream-index":"015"},"SessionID":{"type":"string","writeOnly":true,"x-stream-index":"002.004"},"StartedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"005"},"TimerEndsAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"014"},"UserPermissionOverrides":{"additionalProperties":{"additionalProperties":{"type":"boolean"},"type":"object"},"type":"object","writeOnly":true,"x-stream-index":"017"}},"required":["AppPK","CallType","CallID","SessionID","CreatedAt","AcceptedBy","RejectedBy","MissedBy","Participants","SFUIDs","ActiveSFUs","UserPermissionOverrides","ParticipantsCountByRole","AnonymousParticipantCount"],"type":"object"},"CallSessionEndedEvent":{"description":"This event is sent when a call session ends","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_ended","description":"The type of event: \"call.session_ended\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","call"],"title":"CallSessionEndedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSessionParticipantCountsUpdatedEvent":{"description":"This event is sent when the participant counts in a call session are updated","properties":{"anonymous_participant_count":{"format":"int32","type":"integer","x-stream-index":"005"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"participants_count_by_role":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"004"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_participant_count_updated","description":"The type of event: \"call.session_participant_count_updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","participants_count_by_role","anonymous_participant_count"],"title":"CallSessionParticipantCountsUpdatedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSessionParticipantJoinedEvent":{"description":"This event is sent when a participant joins a call session","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"participant":{"$ref":"#/components/schemas/CallParticipantResponse","description":"The participant that joined the session","title":"Participant","x-stream-index":"004"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_participant_joined","description":"The type of event: \"call.session_participant_joined\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","participant"],"title":"CallSessionParticipantJoinedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSessionParticipantLeftEvent":{"description":"This event is sent when a participant leaves a call session","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"duration_seconds":{"description":"The duration participant was in the session in seconds","format":"int32","title":"Duration","type":"integer","x-stream-index":"005"},"participant":{"$ref":"#/components/schemas/CallParticipantResponse","description":"The participant that left the session","title":"Participant","x-stream-index":"004"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_participant_left","description":"The type of event: \"call.session_participant_left\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","participant","duration_seconds"],"title":"CallSessionParticipantLeftEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSessionResponse":{"properties":{"accepted_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"008"},"anonymous_participant_count":{"format":"int32","type":"integer","x-stream-index":"006"},"ended_at":{"format":"date-time","type":"number","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"live_ended_at":{"format":"date-time","type":"number","x-stream-index":"011"},"live_started_at":{"format":"date-time","type":"number","x-stream-index":"010"},"missed_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"009"},"participants":{"items":{"$ref":"#/components/schemas/CallParticipantResponse"},"type":"array","x-stream-index":"004"},"participants_count_by_role":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"005"},"rejected_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"007"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002"},"timer_ends_at":{"format":"date-time","type":"number","x-stream-index":"012"}},"required":["id","participants","participants_count_by_role","anonymous_participant_count","rejected_by","accepted_by","missed_by"],"type":"object"},"CallSessionStartedEvent":{"description":"This event is sent when a call session starts","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_started","description":"The type of event: \"call.session_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","call"],"title":"CallSessionStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSettings":{"properties":{"audio":{"$ref":"#/components/schemas/AudioSettings","x-stream-index":"001"},"backstage":{"$ref":"#/components/schemas/BackstageSettings","x-stream-index":"002"},"broadcasting":{"$ref":"#/components/schemas/BroadcastSettings","x-stream-index":"007"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordSettings","x-stream-index":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettings","x-stream-index":"008"},"ingress":{"$ref":"#/components/schemas/IngressSettings","x-stream-index":"014"},"limits":{"$ref":"#/components/schemas/LimitsSettings","x-stream-index":"012"},"recording":{"$ref":"#/components/schemas/RecordSettings","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettings","x-stream-index":"010"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettings","x-stream-index":"004"},"session":{"$ref":"#/components/schemas/SessionSettings","x-stream-index":"013"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettings","x-stream-index":"011"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettings","x-stream-index":"009"},"video":{"$ref":"#/components/schemas/VideoSettings","x-stream-index":"003"}},"type":"object"},"CallSettingsRequest":{"properties":{"audio":{"$ref":"#/components/schemas/AudioSettingsRequest","x-stream-index":"001"},"backstage":{"$ref":"#/components/schemas/BackstageSettingsRequest","x-stream-index":"002"},"broadcasting":{"$ref":"#/components/schemas/BroadcastSettingsRequest","x-stream-index":"010"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordingSettingsRequest","x-stream-index":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettingsRequest","x-stream-index":"003"},"ingress":{"$ref":"#/components/schemas/IngressSettingsRequest","x-stream-index":"014"},"limits":{"$ref":"#/components/schemas/LimitsSettingsRequest","x-stream-index":"012"},"recording":{"$ref":"#/components/schemas/RecordSettingsRequest","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettingsRequest","x-stream-index":"007"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettingsRequest","x-stream-index":"008"},"session":{"$ref":"#/components/schemas/SessionSettingsRequest","x-stream-index":"013"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettingsRequest","x-stream-index":"011"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettingsRequest","x-stream-index":"009"},"video":{"$ref":"#/components/schemas/VideoSettingsRequest","x-stream-index":"004"}},"type":"object"},"CallSettingsResponse":{"properties":{"audio":{"$ref":"#/components/schemas/AudioSettingsResponse","x-stream-index":"001"},"backstage":{"$ref":"#/components/schemas/BackstageSettingsResponse","x-stream-index":"002"},"broadcasting":{"$ref":"#/components/schemas/BroadcastSettingsResponse","x-stream-index":"003"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordingSettingsResponse","x-stream-index":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettingsResponse","x-stream-index":"004"},"ingress":{"$ref":"#/components/schemas/IngressSettingsResponse","x-stream-index":"014"},"limits":{"$ref":"#/components/schemas/LimitsSettingsResponse","x-stream-index":"012"},"recording":{"$ref":"#/components/schemas/RecordSettingsResponse","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettingsResponse","x-stream-index":"007"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettingsResponse","x-stream-index":"008"},"session":{"$ref":"#/components/schemas/SessionSettingsResponse","x-stream-index":"013"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettingsResponse","x-stream-index":"011"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettingsResponse","x-stream-index":"009"},"video":{"$ref":"#/components/schemas/VideoSettingsResponse","x-stream-index":"010"}},"required":["audio","backstage","broadcasting","geofencing","recording","frame_recording","ring","screensharing","transcription","video","thumbnails","limits","session"],"type":"object"},"CallStateResponseFields":{"description":"CallStateResponseFields is the payload for call state response","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001"},"members":{"description":"List of call members","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"002"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"004"}},"required":["call","members","own_capabilities","blocked_users"],"title":"CallStateResponseFields","type":"object"},"CallStatsReportReadyEvent":{"description":"This event is sent when the insights report is ready","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.stats_report_ready","description":"The type of event, \"call.report_ready\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id"],"title":"CallStatsReportReadyEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallStatsReportSummaryResponse":{"properties":{"call_cid":{"type":"string","x-stream-index":"001"},"call_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"008"},"call_session_id":{"type":"string","x-stream-index":"002"},"call_status":{"type":"string","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"first_stats_time":{"format":"date-time","type":"number","x-stream-index":"003"},"min_user_rating":{"format":"int32","type":"integer","x-stream-index":"006"},"quality_score":{"format":"int32","type":"integer","x-stream-index":"005"}},"required":["call_cid","call_session_id","first_stats_time","call_status","call_duration_seconds"],"type":"object"},"CallTranscription":{"description":"CallTranscription represents a transcription of a call.","properties":{"end_time":{"format":"date-time","title":"The end time of the transcription.","type":"number","x-stream-index":"004"},"filename":{"title":"The filename of the transcription.","type":"string","x-stream-index":"001"},"session_id":{"title":"The session ID of the transcription.","type":"string","x-stream-index":"005"},"start_time":{"format":"date-time","title":"The start time of the transcription.","type":"number","x-stream-index":"003"},"url":{"title":"The URL of the transcription.","type":"string","x-stream-index":"002"}},"required":["filename","url","start_time","end_time","session_id"],"title":"CallTranscription","type":"object"},"CallTranscriptionFailedEvent":{"description":"This event is sent when call transcription has failed","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"003"},"error":{"description":"The error message detailing why transcription failed.","title":"string","type":"string","x-stream-index":"004"},"type":{"default":"call.transcription_failed","description":"The type of event: \"call.transcription_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","egress_id"],"title":"CallTranscriptionFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallTranscriptionReadyEvent":{"description":"This event is sent when call transcription is ready","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"call_transcription":{"$ref":"#/components/schemas/CallTranscription","description":"The call transcription object","title":"CallTranscription","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.transcription_ready","description":"The type of event: \"call.transcription_ready\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call_transcription","egress_id"],"title":"CallTranscriptionReadyEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallTranscriptionStartedEvent":{"description":"This event is sent when call transcription has started","properties":{"call_cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"egress_id":{"type":"string","x-stream-index":"001"},"type":{"default":"call.transcription_started","description":"The type of event: \"call.transcription_started\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001"}},"required":["egress_id","type","created_at","call_cid"],"title":"CallTranscriptionStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallTranscriptionStoppedEvent":{"description":"This event is sent when call transcription has stopped","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"003"},"type":{"default":"call.transcription_stopped","description":"The type of event: \"call.transcription_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","egress_id"],"title":"CallTranscriptionStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallType":{"nullable":true,"properties":{"AppPK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"003"},"CreatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"005"},"ExternalStorage":{"type":"string","writeOnly":true,"x-stream-index":"009"},"Name":{"type":"string","writeOnly":true,"x-stream-index":"004"},"NotificationSettings":{"$ref":"#/components/schemas/NotificationSettings","x-stream-index":"008"},"PK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"002"},"Settings":{"$ref":"#/components/schemas/CallSettings","x-stream-index":"007"},"UpdatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"006"}},"required":["PK","AppPK","Name","CreatedAt","UpdatedAt","ExternalStorage"],"type":"object"},"CallTypeResponse":{"description":"CallTypeResponse is the payload for a call type.","properties":{"created_at":{"description":"the time the call type was created","format":"date-time","title":"CreatedAt","type":"number","x-stream-index":"005"},"external_storage":{"description":"the external storage for the call type","title":"ExternalStorage","type":"string","x-stream-index":"007"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"the permissions granted to each role","title":"Grants","type":"object","x-stream-index":"002"},"name":{"description":"the name of the call type","title":"Name","type":"string","x-stream-index":"001"},"notification_settings":{"$ref":"#/components/schemas/NotificationSettings","description":"the notification settings for the call type","title":"NotificationSettings","x-stream-index":"004"},"settings":{"$ref":"#/components/schemas/CallSettingsResponse","description":"the settings for the call type","title":"Settings","x-stream-index":"003"},"updated_at":{"description":"the time the call type was last updated","format":"date-time","title":"UpdatedAt","type":"number","x-stream-index":"006"}},"required":["name","grants","settings","notification_settings","created_at","updated_at"],"title":"CallTypeResponse","type":"object"},"CallUpdatedEvent":{"description":"This event is sent when a call is updated, clients should use this update the local state of the call.\nThis event also contains the capabilities by role for the call, clients should update the own_capability for the current.","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"capabilities_by_role":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"The capabilities by role for this call","title":"CapabilitiesByRole","type":"object","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.updated","description":"The type of event: \"call.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","capabilities_by_role"],"title":"CallUpdatedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallUserFeedbackSubmittedEvent":{"description":"This event is sent when a user submits feedback for a call.","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"custom":{"additionalProperties":{},"description":"Custom data provided by the user","title":"Custom","type":"object","x-stream-index":"007"},"rating":{"description":"The rating given by the user (1-5)","format":"int32","title":"Rating","type":"integer","x-stream-index":"005"},"reason":{"description":"The reason provided by the user for the rating","title":"Reason","type":"string","x-stream-index":"006"},"sdk":{"type":"string","x-stream-index":"008"},"sdk_version":{"type":"string","x-stream-index":"009"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.user_feedback_submitted","description":"The type of event, \"call.user_feedback\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who submitted the feedback","title":"User","x-stream-index":"004"}},"required":["type","created_at","call_cid","session_id","user","rating"],"title":"CallUserFeedbackSubmittedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallUserMutedEvent":{"description":"This event is sent when a call member is muted","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"from_user_id":{"type":"string","x-stream-index":"003"},"muted_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"type":{"default":"call.user_muted","description":"The type of event: \"call.user_muted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","from_user_id","muted_user_ids"],"title":"CallUserMutedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallsPerDayReport":{"properties":{"count":{"format":"int64","type":"integer","x-stream-index":"001"}},"required":["count"],"type":"object"},"CallsPerDayReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateCallsPerDayReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"CampaignChannelTemplate":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"002"},"members":{"items":{"type":"string"},"maximum":1000,"type":"array","x-stream-index":"003"},"team":{"maxLength":1000,"type":"string","x-stream-index":"004"},"type":{"maxLength":64,"type":"string","x-stream-index":"001"}},"required":["type","custom"],"type":"object"},"CampaignCompletedEvent":{"nullable":true,"properties":{"campaign":{"$ref":"#/components/schemas/CampaignResponse","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"type":{"default":"campaign.completed","type":"string","x-stream-index":"001.002"}},"required":["type","created_at","custom"],"title":"CampaignCompletedEvent","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"},"CampaignMessageTemplate":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"maximum":30,"type":"array","x-stream-index":"002"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"poll_id":{"type":"string","x-stream-index":"003"},"text":{"type":"string","x-stream-index":"001"}},"required":["text","attachments","poll_id","custom"],"type":"object"},"CampaignResponse":{"properties":{"channel_template":{"$ref":"#/components/schemas/CampaignChannelTemplate","x-stream-index":"016"},"create_channels":{"type":"boolean","x-stream-index":"008"},"created_at":{"format":"date-time","type":"number","x-stream-index":"020"},"description":{"type":"string","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"001"},"message_template":{"$ref":"#/components/schemas/CampaignMessageTemplate","x-stream-index":"015"},"name":{"type":"string","x-stream-index":"007"},"scheduled_for":{"format":"date-time","type":"number","x-stream-index":"013"},"segment_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"002"},"segments":{"items":{"$ref":"#/components/schemas/Segment"},"type":"array","x-stream-index":"003"},"sender":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"005"},"sender_id":{"type":"string","x-stream-index":"004"},"sender_mode":{"type":"string","x-stream-index":"006"},"show_channels":{"type":"boolean","x-stream-index":"009"},"skip_push":{"type":"boolean","x-stream-index":"011"},"skip_webhook":{"type":"boolean","x-stream-index":"012"},"stats":{"$ref":"#/components/schemas/CampaignStatsResponse","x-stream-index":"022"},"status":{"type":"string","x-stream-index":"019"},"stop_at":{"format":"date-time","type":"number","x-stream-index":"014"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"021"},"user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"017"},"users":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"018"}},"required":["id","segment_ids","segments","sender_id","sender_mode","name","create_channels","show_channels","description","skip_push","skip_webhook","user_ids","users","status","created_at","updated_at","stats"],"type":"object"},"CampaignStartedEvent":{"nullable":true,"properties":{"campaign":{"$ref":"#/components/schemas/CampaignResponse","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"type":{"default":"campaign.started","type":"string","x-stream-index":"001.002"}},"required":["type","created_at","custom"],"title":"CampaignStartedEvent","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"},"CampaignStatsResponse":{"properties":{"progress":{"format":"float","type":"number","x-stream-index":"005"},"stats_channels_created":{"format":"int32","type":"integer","x-stream-index":"004"},"stats_completed_at":{"format":"date-time","type":"number","x-stream-index":"002"},"stats_messages_sent":{"format":"int32","type":"integer","x-stream-index":"003"},"stats_started_at":{"format":"date-time","type":"number","x-stream-index":"001"},"stats_users_read":{"format":"int32","type":"integer","x-stream-index":"007"},"stats_users_sent":{"format":"int32","type":"integer","x-stream-index":"006"}},"required":["stats_started_at","stats_completed_at","stats_messages_sent","stats_channels_created","progress","stats_users_sent","stats_users_read"],"type":"object"},"CastPollVoteRequest":{"nullable":true,"properties":{"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"005.002"},"user_id":{"type":"string","x-stream-index":"005.001"},"vote":{"$ref":"#/components/schemas/VoteData","description":"Vote data","title":"VoteData","x-stream-index":"004"}},"type":"object"},"Channel":{"properties":{"active_live_locations":{"items":{"$ref":"#/components/schemas/SharedLocation"},"type":"array","x-stream-index":"034"},"auto_translation_enabled":{"type":"boolean","x-stream-index":"029"},"auto_translation_language":{"type":"string","x-stream-index":"030"},"cid":{"type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/ChannelConfig","x-stream-index":"026"},"config_overrides":{"$ref":"#/components/schemas/ConfigOverrides","x-stream-index":"027"},"cooldown":{"format":"int32","type":"integer","x-stream-index":"031"},"created_at":{"format":"date-time","type":"number","x-stream-index":"009"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"019"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"disabled":{"type":"boolean","x-stream-index":"017"},"frozen":{"type":"boolean","x-stream-index":"016"},"id":{"type":"string","x-stream-index":"004"},"invites":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"022"},"last_campaigns":{"type":"string","x-stream-index":"032"},"last_message_at":{"format":"date-time","type":"number","x-stream-index":"006"},"member_count":{"format":"int32","type":"integer","x-stream-index":"021"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"020"},"message_count":{"format":"int64","type":"integer","x-stream-index":"035"},"message_count_updated_at":{"format":"date-time","type":"number","x-stream-index":"036"},"team":{"type":"string","x-stream-index":"028"},"truncated_by":{"$ref":"#/components/schemas/User","x-stream-index":"015"},"type":{"type":"string","x-stream-index":"005"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"010"}},"required":["cid","id","type","created_at","updated_at","frozen","disabled","custom","auto_translation_language"],"type":"object"},"ChannelConfig":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.027"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.022"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.023"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.028"},"blocklist":{"type":"string","x-stream-index":"001.024"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.025"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.026"},"commands":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"connect_events":{"type":"boolean","x-stream-index":"001.004"},"count_messages":{"type":"boolean","x-stream-index":"001.019"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"custom_events":{"type":"boolean","x-stream-index":"001.012"},"mark_messages_pending":{"type":"boolean","x-stream-index":"001.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"001.021"},"mutes":{"type":"boolean","x-stream-index":"001.009"},"name":{"type":"string","x-stream-index":"001.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"001.029"},"partition_ttl":{"type":"integer","x-stream-index":"001.030"},"polls":{"type":"boolean","x-stream-index":"001.016"},"push_notifications":{"type":"boolean","x-stream-index":"001.013"},"quotes":{"type":"boolean","x-stream-index":"001.008"},"reactions":{"type":"boolean","x-stream-index":"001.006"},"read_events":{"type":"boolean","x-stream-index":"001.003"},"reminders":{"type":"boolean","x-stream-index":"001.014"},"replies":{"type":"boolean","x-stream-index":"001.007"},"search":{"type":"boolean","x-stream-index":"001.005"},"shared_locations":{"type":"boolean","x-stream-index":"001.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.031"},"typing_events":{"type":"boolean","x-stream-index":"001.002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"002.004"},"uploads":{"type":"boolean","x-stream-index":"001.010"},"url_enrichment":{"type":"boolean","x-stream-index":"001.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"001.017"}},"required":["name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","count_messages","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","created_at","updated_at","commands"],"type":"object"},"ChannelConfigWithInfo":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.002.027"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.002.022"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.023"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.002.028"},"blocklist":{"type":"string","x-stream-index":"001.002.024"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.025"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.002.026"},"commands":{"items":{"$ref":"#/components/schemas/Command"},"type":"array","x-stream-index":"001.003"},"connect_events":{"type":"boolean","x-stream-index":"001.002.004"},"count_messages":{"type":"boolean","x-stream-index":"001.002.019"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.001.003"},"custom_events":{"type":"boolean","x-stream-index":"001.002.012"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"002"},"mark_messages_pending":{"type":"boolean","x-stream-index":"001.002.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"001.002.021"},"mutes":{"type":"boolean","x-stream-index":"001.002.009"},"name":{"type":"string","x-stream-index":"001.002.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"001.002.029"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"001.002.030"},"polls":{"type":"boolean","x-stream-index":"001.002.016"},"push_notifications":{"type":"boolean","x-stream-index":"001.002.013"},"quotes":{"type":"boolean","x-stream-index":"001.002.008"},"reactions":{"type":"boolean","x-stream-index":"001.002.006"},"read_events":{"type":"boolean","x-stream-index":"001.002.003"},"reminders":{"type":"boolean","x-stream-index":"001.002.014"},"replies":{"type":"boolean","x-stream-index":"001.002.007"},"search":{"type":"boolean","x-stream-index":"001.002.005"},"shared_locations":{"type":"boolean","x-stream-index":"001.002.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.002.031"},"typing_events":{"type":"boolean","x-stream-index":"001.002.002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"uploads":{"type":"boolean","x-stream-index":"001.002.010"},"url_enrichment":{"type":"boolean","x-stream-index":"001.002.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"001.002.017"}},"required":["created_at","updated_at","name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","count_messages","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","commands"],"type":"object"},"ChannelCreatedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"channel.created","type":"string","x-stream-index":"001.001"}},"required":["type","created_at"],"title":"ChannelCreatedEvent","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"},"ChannelDeletedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003.004"},"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"003.005"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"team":{"type":"string","x-stream-index":"001.001"},"type":{"default":"channel.deleted","type":"string","x-stream-index":"002.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"ChannelDeletedEvent","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"},"ChannelExport":{"properties":{"cid":{"type":"string","x-stream-index":"003"},"id":{"description":"Channel ID","title":"ID","type":"string","x-stream-index":"002"},"messages_since":{"description":"Date to export messages since","format":"date-time","title":"Messages since","type":"number","x-stream-index":"004"},"messages_until":{"description":"Date to export messages until","format":"date-time","title":"Messages until","type":"number","x-stream-index":"005"},"type":{"description":"Channel type","title":"Type","type":"string","x-stream-index":"001"}},"title":"Channel Export","type":"object"},"ChannelFrozenEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"channel.frozen","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"ChannelFrozenEvent","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"},"ChannelGetOrCreateRequest":{"nullable":true,"properties":{"data":{"$ref":"#/components/schemas/ChannelInput","x-stream-index":"003"},"hide_for_creator":{"description":"Whether this channel will be hidden for the user who created the channel or not","title":"Hide for creator","type":"boolean","x-stream-index":"007"},"members":{"$ref":"#/components/schemas/PaginationParams","x-stream-index":"010"},"messages":{"$ref":"#/components/schemas/MessagePaginationParams","x-stream-index":"009"},"state":{"description":"Refresh channel state","title":"State","type":"boolean","x-stream-index":"005"},"thread_unread_counts":{"type":"boolean","x-stream-index":"008"},"watchers":{"$ref":"#/components/schemas/PaginationParams","x-stream-index":"011"}},"type":"object"},"ChannelHiddenEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003.004"},"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"003.005"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"clear_history":{"type":"boolean","x-stream-index":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"type":{"default":"channel.hidden","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["clear_history","cid","channel_id","channel_type","channel_member_count","type","created_at"],"title":"ChannelHiddenEvent","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"},"ChannelInput":{"properties":{"auto_translation_enabled":{"description":"Enable or disable auto translation","title":"Auto translation","type":"boolean","x-stream-index":"005"},"auto_translation_language":{"description":"Switch auto translation language","title":"Auto translation language","type":"string","x-stream-index":"006"},"config_overrides":{"$ref":"#/components/schemas/ChannelConfig","x-stream-index":"024"},"created_by":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"009"},"created_by_id":{"type":"string","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"015"},"disabled":{"type":"boolean","x-stream-index":"014"},"frozen":{"description":"Freeze or unfreeze the channel","title":"Frozen","type":"boolean","x-stream-index":"013"},"invites":{"items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"type":"array","x-stream-index":"016"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"type":"array","x-stream-index":"018"},"team":{"description":"Team the channel belongs to (if multi-tenant mode is enabled)","title":"Team","type":"string","x-stream-index":"004"},"truncated_by_id":{"type":"string","x-stream-index":"010"}},"type":"object"},"ChannelMember":{"nullable":true,"properties":{"archived_at":{"format":"date-time","type":"number","x-stream-index":"015"},"ban_expires":{"description":"Expiration date of the ban","format":"date-time","title":"Ban expires","type":"number","x-stream-index":"013"},"banned":{"description":"Whether member is banned this channel or not","title":"Banned","type":"boolean","x-stream-index":"012"},"channel_role":{"description":"Role of the member in the channel","title":"Channel Role","type":"string","x-stream-index":"018"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"deleted_messages":{"items":{"type":"string"},"type":"array","x-stream-index":"020"},"invite_accepted_at":{"description":"Date when invite was accepted","format":"date-time","title":"Invited accepted at","type":"number","x-stream-index":"006"},"invite_rejected_at":{"description":"Date when invite was rejected","format":"date-time","title":"Invited rejected at","type":"number","x-stream-index":"007"},"invited":{"description":"Whether member was invited or not","title":"Invited","type":"boolean","x-stream-index":"005"},"is_moderator":{"description":"Whether member is channel moderator or not","title":"Is moderator","type":"boolean","x-stream-index":"003"},"notifications_muted":{"type":"boolean","x-stream-index":"019"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"016"},"role":{"description":"Permission level of the member in the channel (DEPRECATED: use channel_role instead)","enum":["member","moderator","admin","owner"],"title":"Role","type":"string","x-stream-index":"017"},"shadow_banned":{"description":"Whether member is shadow banned in this channel or not","title":"Shadow banned","type":"boolean","x-stream-index":"014"},"status":{"type":"string","x-stream-index":"008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"},"user_id":{"title":"User ID","type":"string","x-stream-index":"001"}},"required":["custom","created_at","updated_at","banned","shadow_banned","channel_role","notifications_muted"],"title":"Channel member","type":"object"},"ChannelMemberResponse":{"nullable":true,"properties":{"archived_at":{"format":"date-time","type":"number","x-stream-index":"016"},"ban_expires":{"description":"Expiration date of the ban","format":"date-time","title":"Ban expires","type":"number","x-stream-index":"013"},"banned":{"description":"Whether member is banned this channel or not","title":"Banned","type":"boolean","x-stream-index":"012"},"channel_role":{"description":"Role of the member in the channel","title":"Channel Role","type":"string","x-stream-index":"018"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"invite_accepted_at":{"description":"Date when invite was accepted","format":"date-time","title":"Invited accepted at","type":"number","x-stream-index":"006"},"invite_rejected_at":{"description":"Date when invite was rejected","format":"date-time","title":"Invited rejected at","type":"number","x-stream-index":"007"},"invited":{"description":"Whether member was invited or not","title":"Invited","type":"boolean","x-stream-index":"005"},"is_moderator":{"description":"Whether member is channel moderator or not","title":"Is moderator","type":"boolean","x-stream-index":"003"},"notifications_muted":{"type":"boolean","x-stream-index":"019"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"015"},"role":{"description":"Permission level of the member in the channel (DEPRECATED: use channel_role instead)","enum":["member","moderator","admin","owner"],"title":"Role","type":"string","x-stream-index":"017"},"shadow_banned":{"description":"Whether member is shadow banned in this channel or not","title":"Shadow banned","type":"boolean","x-stream-index":"014"},"status":{"type":"string","x-stream-index":"008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"},"user_id":{"title":"User ID","type":"string","x-stream-index":"001"}},"required":["custom","created_at","updated_at","banned","shadow_banned","channel_role","notifications_muted"],"title":"Channel member","type":"object"},"ChannelMessages":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001"},"messages":{"items":{"$ref":"#/components/schemas/Message"},"type":"array","x-stream-index":"002"}},"required":["messages"],"type":"object"},"ChannelMute":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel that is muted","title":"Channel","x-stream-index":"002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"004"},"expires":{"description":"Date/time of mute expiration","format":"date-time","title":"Expires","type":"number","x-stream-index":"003"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Owner of channel mute","title":"User","x-stream-index":"001"}},"required":["created_at","updated_at"],"type":"object"},"ChannelMutedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"channel.muted","type":"string","x-stream-index":"001.001"}},"required":["type","created_at"],"title":"ChannelMutedEvent","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"},"ChannelOwnCapability":{"description":"All possibility of string to use","enum":["ban-channel-members","cast-poll-vote","connect-events","create-attachment","delete-any-message","delete-channel","delete-own-message","flag-message","freeze-channel","join-channel","leave-channel","mute-channel","pin-message","query-poll-votes","quote-message","read-events","search-messages","send-custom-events","send-links","send-message","send-poll","send-reaction","send-reply","send-restricted-visibility-message","send-typing-events","set-channel-cooldown","share-location","skip-slow-mode","slow-mode","typing-events","update-any-message","update-channel","update-channel-members","update-own-message","update-thread","upload-file"],"title":"ChannelOwnCapability","type":"string"},"ChannelPushPreferences":{"properties":{"chat_level":{"type":"string","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"number","x-stream-index":"002"}},"type":"object"},"ChannelResponse":{"description":"Represents channel in chat","properties":{"auto_translation_enabled":{"description":"Whether auto translation is enabled or not","title":"Auto translation","type":"boolean","x-stream-index":"017"},"auto_translation_language":{"description":"Language to translate to when auto translation is active","title":"Auto translation language","type":"string","x-stream-index":"018"},"blocked":{"description":"Whether this channel is blocked by current user or not","title":"Blocked","type":"boolean","x-stream-index":"023"},"cid":{"description":"Channel CID (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/ChannelConfigWithInfo","description":"Channel configuration","title":"ChannelConfigWithInfo","x-stream-index":"013"},"cooldown":{"description":"Cooldown period after sending each message","format":"int32","title":"Cooldown","type":"integer","x-stream-index":"020"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"005"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"Creator of the channel","title":"UserResponse","x-stream-index":"008"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"026"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"007"},"disabled":{"type":"boolean","x-stream-index":"010"},"frozen":{"description":"Whether channel is frozen or not","title":"Frozen","type":"boolean","x-stream-index":"009"},"hidden":{"description":"Whether this channel is hidden by current user or not","title":"Hidden","type":"boolean","x-stream-index":"022"},"hide_messages_before":{"description":"Date since when the message history is accessible","format":"date-time","title":"Hide messages before","type":"number","x-stream-index":"019"},"id":{"description":"Channel unique ID","title":"ID","type":"string","x-stream-index":"001"},"last_message_at":{"description":"Date of the last message sent","format":"date-time","title":"Last message at","type":"number","x-stream-index":"004"},"member_count":{"description":"Number of members in the channel","format":"int32","title":"Member count","type":"integer","x-stream-index":"012"},"members":{"description":"List of channel members (max 100)","items":{"$ref":"#/components/schemas/ChannelMember"},"title":"ChannelMembers","type":"array","x-stream-index":"011"},"message_count":{"description":"Number of messages in the channel","format":"int64","title":"Message count","type":"integer","x-stream-index":"027"},"mute_expires_at":{"description":"Date of mute expiration","format":"date-time","title":"Mute expires at","type":"number","x-stream-index":"015"},"muted":{"description":"Whether this channel is muted or not","title":"Muted","type":"boolean","x-stream-index":"014"},"own_capabilities":{"description":"List of channel capabilities of authenticated user","items":{"$ref":"#/components/schemas/ChannelOwnCapability"},"title":"ChannelOwnCapability","type":"array","x-stream-index":"021"},"team":{"description":"Team the channel belongs to (multi-tenant only)","title":"Team","type":"string","x-stream-index":"016"},"truncated_at":{"description":"Date of the latest truncation of the channel","format":"date-time","title":"UserResponse","type":"number","x-stream-index":"024"},"truncated_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"025"},"type":{"description":"Type of the channel","title":"Type","type":"string","x-stream-docs-page-id":"channel_features","x-stream-index":"002"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"006"}},"required":["id","type","cid","created_at","updated_at","frozen","disabled","custom"],"title":"Channel","type":"object"},"ChannelStateResponse":{"nullable":true,"properties":{"active_live_locations":{"items":{"$ref":"#/components/schemas/SharedLocationResponseData"},"type":"array","x-stream-index":"001.015"},"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001.001"},"deleted_messages":{"items":{"type":"string"},"type":"array","x-stream-index":"001.016"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001.014"},"duration":{"type":"string","x-stream-index":"002.001"},"hidden":{"type":"boolean","x-stream-index":"001.011"},"hide_messages_before":{"format":"date-time","type":"number","x-stream-index":"001.012"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"001.007"},"membership":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"001.008"},"messages":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","x-stream-index":"001.002"},"pending_messages":{"items":{"$ref":"#/components/schemas/PendingMessageResponse"},"type":"array","x-stream-index":"001.013"},"pinned_messages":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","x-stream-index":"001.003"},"push_preferences":{"$ref":"#/components/schemas/ChannelPushPreferences","x-stream-index":"001.009"},"read":{"items":{"$ref":"#/components/schemas/ReadStateResponse"},"type":"array","x-stream-index":"001.006"},"threads":{"items":{"$ref":"#/components/schemas/ThreadStateResponse"},"type":"array","x-stream-index":"001.010"},"watcher_count":{"format":"int32","type":"integer","x-stream-index":"001.004"},"watchers":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"001.005"}},"required":["messages","pinned_messages","members","threads","duration"],"type":"object"},"ChannelStateResponseFields":{"properties":{"active_live_locations":{"description":"Active live locations in the channel","items":{"$ref":"#/components/schemas/SharedLocationResponseData"},"title":"Active Live Locations","type":"array","x-stream-index":"015"},"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001"},"deleted_messages":{"items":{"type":"string"},"type":"array","x-stream-index":"016"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"014"},"hidden":{"description":"Whether this channel is hidden or not","title":"Hidden","type":"boolean","x-stream-index":"011"},"hide_messages_before":{"description":"Messages before this date are hidden from the user","format":"date-time","title":"Hide messages before","type":"number","x-stream-index":"012"},"members":{"description":"List of channel members","items":{"$ref":"#/components/schemas/ChannelMember"},"title":"Members","type":"array","x-stream-index":"007"},"membership":{"$ref":"#/components/schemas/ChannelMember","description":"Current user membership object","title":"Membership","x-stream-index":"008"},"messages":{"description":"List of channel messages","items":{"$ref":"#/components/schemas/MessageResponse"},"title":"Message","type":"array","x-stream-index":"002"},"pending_messages":{"description":"Pending messages that this user has sent","items":{"$ref":"#/components/schemas/PendingMessageResponse"},"title":"Pending messages","type":"array","x-stream-index":"013"},"pinned_messages":{"description":"List of pinned messages in the channel","items":{"$ref":"#/components/schemas/MessageResponse"},"title":"Pinned messages","type":"array","x-stream-docs-page-id":"pinned_messages","x-stream-index":"003"},"push_preferences":{"$ref":"#/components/schemas/ChannelPushPreferences","x-stream-index":"009"},"read":{"description":"List of read states","items":{"$ref":"#/components/schemas/ReadStateResponse"},"title":"Read","type":"array","x-stream-index":"006"},"threads":{"items":{"$ref":"#/components/schemas/ThreadStateResponse"},"type":"array","x-stream-index":"010"},"watcher_count":{"description":"Number of channel watchers","format":"int32","title":"Watcher count","type":"integer","x-stream-index":"004"},"watchers":{"description":"List of user who is watching the channel","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Watchers","type":"array","x-stream-index":"005"}},"required":["messages","pinned_messages","members","threads"],"type":"object"},"ChannelTruncatedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001.004"},"channel_id":{"type":"string","x-stream-index":"001.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"001.005"},"channel_type":{"type":"string","x-stream-index":"001.003"},"cid":{"type":"string","x-stream-index":"001.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"type":{"default":"channel.truncated","type":"string","x-stream-index":"002.001"}},"required":["cid","channel_id","channel_type","channel_member_count","type","created_at"],"title":"ChannelTruncatedEvent","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"},"ChannelTypeConfig":{"nullable":true,"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"003.002.027"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"003.002.022"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.002.023"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"003.002.028"},"blocklist":{"type":"string","x-stream-index":"003.002.024"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.002.025"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"003.002.026"},"commands":{"items":{"$ref":"#/components/schemas/Command"},"type":"array","x-stream-index":"003.003"},"connect_events":{"type":"boolean","x-stream-index":"003.002.004"},"count_messages":{"type":"boolean","x-stream-index":"003.002.019"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.001.003"},"custom_events":{"type":"boolean","x-stream-index":"003.002.012"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"002"},"mark_messages_pending":{"type":"boolean","x-stream-index":"003.002.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"003.002.021"},"mutes":{"type":"boolean","x-stream-index":"003.002.009"},"name":{"type":"string","x-stream-index":"003.002.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"003.002.029"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"003.002.030"},"permissions":{"items":{"$ref":"#/components/schemas/PolicyRequest"},"type":"array","x-stream-index":"001"},"polls":{"type":"boolean","x-stream-index":"003.002.016"},"push_notifications":{"type":"boolean","x-stream-index":"003.002.013"},"quotes":{"type":"boolean","x-stream-index":"003.002.008"},"reactions":{"type":"boolean","x-stream-index":"003.002.006"},"read_events":{"type":"boolean","x-stream-index":"003.002.003"},"reminders":{"type":"boolean","x-stream-index":"003.002.014"},"replies":{"type":"boolean","x-stream-index":"003.002.007"},"search":{"type":"boolean","x-stream-index":"003.002.005"},"shared_locations":{"type":"boolean","x-stream-index":"003.002.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"003.002.031"},"typing_events":{"type":"boolean","x-stream-index":"003.002.002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"003.001.004"},"uploads":{"type":"boolean","x-stream-index":"003.002.010"},"url_enrichment":{"type":"boolean","x-stream-index":"003.002.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"003.002.017"}},"required":["permissions","grants","created_at","updated_at","name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","count_messages","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","commands"],"type":"object"},"ChannelUnFrozenEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"channel.unfrozen","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"ChannelUnFrozenEvent","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"},"ChannelUnmutedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"channel.unmuted","type":"string","x-stream-index":"001.001"}},"required":["type","created_at"],"title":"ChannelUnmutedEvent","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"},"ChannelUpdatedEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"004.004"},"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"004.005"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"002.001"},"type":{"default":"channel.updated","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count"],"title":"ChannelUpdatedEvent","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"},"ChannelVisibleEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"001.002"},"channel_type":{"type":"string","x-stream-index":"001.003"},"cid":{"type":"string","x-stream-index":"001.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"type":{"default":"channel.visible","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"ChannelVisibleEvent","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"},"ChatActivityStatsResponse":{"properties":{"Messages":{"$ref":"#/components/schemas/MessageStatsResponse","x-stream-index":"001"}},"type":"object"},"CheckExternalStorageResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"file_url":{"type":"string","x-stream-index":"002"}},"required":["duration","file_url"],"title":"Response","type":"object"},"CheckPushRequest":{"description":"Check push request","nullable":true,"properties":{"apn_template":{"description":"Push message template for APN","title":"APN template","type":"string","x-stream-docs-page-id":"push_template","x-stream-index":"002"},"event_type":{"description":"Type of event for push templates (default: message.new)","enum":["message.new","message.updated","reaction.new","reaction.updated","notification.reminder_due"],"title":"Event type","type":"string","x-stream-index":"008"},"firebase_data_template":{"description":"Push message data template for Firebase","title":"Firebase data template","type":"string","x-stream-docs-page-id":"push_template","x-stream-index":"004"},"firebase_template":{"description":"Push message template for Firebase","title":"Firebase template","type":"string","x-stream-docs-page-id":"push_template","x-stream-index":"003"},"message_id":{"description":"Message ID to send push notification for","title":"Message ID","type":"string","x-stream-index":"001"},"push_provider_name":{"description":"Name of push provider","title":"Name of push provider","type":"string","x-stream-index":"007"},"push_provider_type":{"description":"Push provider type","enum":["firebase","apn","huawei","xiaomi"],"title":"Type of push provider","type":"string","x-stream-index":"006"},"skip_devices":{"description":"Don't require existing devices to render templates","title":"Skip devices","type":"boolean","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"009.002"},"user_id":{"type":"string","x-stream-index":"009.001"}},"title":"CheckPushRequest","type":"object"},"CheckPushResponse":{"nullable":true,"properties":{"device_errors":{"additionalProperties":{"$ref":"#/components/schemas/DeviceErrorInfo"},"description":"Object with device errors","title":"Device errors","type":"object","x-stream-index":"001","x-stream-map":{"key":"device_id"}},"duration":{"type":"string","x-stream-index":"008.001"},"event_type":{"description":"The event type that was tested","title":"Event type","type":"string","x-stream-index":"004"},"general_errors":{"description":"List of general errors","items":{"type":"string"},"title":"General errors","type":"array","x-stream-index":"002"},"rendered_apn_template":{"title":"Rendered APN template","type":"string","x-stream-index":"005"},"rendered_firebase_template":{"title":"Rendered Firebase template","type":"string","x-stream-index":"006"},"rendered_message":{"additionalProperties":{"type":"string"},"title":"Rendered message","type":"object","x-stream-index":"007"},"skip_devices":{"description":"Don't require existing devices to render templates","title":"Skip devices","type":"boolean","x-stream-index":"003"}},"required":["duration"],"type":"object"},"CheckRequest":{"nullable":true,"properties":{"config_key":{"description":"Key of the moderation configuration to use","title":"Config Key","type":"string","x-stream-index":"005"},"config_team":{"description":"Team associated with the configuration","title":"Config Team","type":"string","x-stream-index":"006"},"entity_creator_id":{"description":"ID of the user who created the entity","title":"Entity Creator ID","type":"string","x-stream-index":"003"},"entity_id":{"description":"Unique identifier of the entity to moderate","title":"Entity ID","type":"string","x-stream-index":"002"},"entity_type":{"description":"Type of entity to moderate","title":"Entity Type","type":"string","x-stream-index":"001"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content to be moderated","title":"Moderation Payload","x-stream-index":"004"},"options":{"additionalProperties":{},"description":"Additional moderation configuration options","title":"Options","type":"object","x-stream-index":"007"},"test_mode":{"description":"Whether to run moderation in test mode","title":"Test Mode","type":"boolean","x-stream-index":"008"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"009.002"},"user_id":{"type":"string","x-stream-index":"009.001"}},"required":["entity_type","entity_id","entity_creator_id"],"type":"object"},"CheckResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"005.001"},"item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"Review queue item (present if action != keep)","title":"Item","x-stream-index":"004"},"recommended_action":{"description":"Suggested action based on moderation results","title":"Recommended Action","type":"string","x-stream-index":"003"},"status":{"description":"Status of the moderation check (completed or pending)","title":"Status","type":"string","x-stream-index":"001"},"task_id":{"description":"ID of the running moderation task","title":"Task ID","type":"string","x-stream-index":"002"}},"required":["status","recommended_action","duration"],"type":"object"},"CheckSNSRequest":{"nullable":true,"properties":{"sns_key":{"description":"AWS SNS access key","title":"SNS key","type":"string","x-stream-index":"002"},"sns_secret":{"description":"AWS SNS key secret","title":"SNS secret","type":"string","x-stream-index":"003"},"sns_topic_arn":{"description":"AWS SNS topic ARN","title":"SNS Topic ARN","type":"string","x-stream-index":"001"}},"type":"object"},"CheckSNSResponse":{"nullable":true,"properties":{"data":{"additionalProperties":{},"description":"Error data","title":"ReadOnlyData","type":"object","x-stream-index":"003"},"duration":{"type":"string","x-stream-index":"004.001"},"error":{"description":"Error text","title":"Error","type":"string","x-stream-index":"002"},"status":{"description":"Validation result","enum":["ok","error"],"title":"Status","type":"string","x-stream-index":"001"}},"required":["status","duration"],"type":"object"},"CheckSQSRequest":{"nullable":true,"properties":{"sqs_key":{"description":"AWS SQS access key","title":"SQS key","type":"string","x-stream-index":"002"},"sqs_secret":{"description":"AWS SQS key secret","title":"SQS secret","type":"string","x-stream-index":"003"},"sqs_url":{"description":"AWS SQS endpoint URL","title":"SQS URL","type":"string","x-stream-index":"001"}},"type":"object"},"CheckSQSResponse":{"nullable":true,"properties":{"data":{"additionalProperties":{},"description":"Error data","title":"ReadOnlyData","type":"object","x-stream-index":"003"},"duration":{"type":"string","x-stream-index":"004.001"},"error":{"description":"Error text","title":"Error","type":"string","x-stream-index":"002"},"status":{"description":"Validation result","enum":["ok","error"],"title":"Status","type":"string","x-stream-index":"001"}},"required":["status","duration"],"type":"object"},"ClientOSDataResponse":{"properties":{"architecture":{"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"version":{"type":"string","x-stream-index":"002"}},"type":"object"},"ClosedCaptionEvent":{"description":"This event is sent when closed captions are being sent in a call, clients should use this to show the closed captions in the call screen","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"closed_caption":{"$ref":"#/components/schemas/CallClosedCaption","description":"The closed caption object","title":"CallClosedCaption","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.closed_caption","description":"The type of event: \"call.closed_caption\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","closed_caption"],"title":"ClosedCaptionEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CollectUserFeedbackRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"009"},"rating":{"format":"int32","maximum":5,"minimum":1,"type":"integer","x-stream-index":"007"},"reason":{"maxLength":1000,"type":"string","x-stream-index":"008"},"sdk":{"maxLength":50,"type":"string","x-stream-index":"005"},"sdk_version":{"maxLength":50,"type":"string","x-stream-index":"006"},"user_session_id":{"maxLength":50,"type":"string","x-stream-index":"004"}},"required":["sdk","sdk_version","rating"],"type":"object"},"CollectUserFeedbackResponse":{"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"},"Command":{"description":"Represents custom chat command","nullable":true,"properties":{"args":{"description":"Arguments help text, shown in commands auto-completion","title":"Arguments","type":"string","x-stream-index":"006"},"created_at":{"description":"Date/time of creation","format":"date-time","readOnly":true,"title":"Created at","type":"number","x-stream-index":"001"},"description":{"description":"Description, shown in commands auto-completion","title":"Description","type":"string","x-stream-index":"005"},"name":{"description":"Unique command name","title":"Name","type":"string","x-stream-index":"004"},"set":{"description":"Set name used for grouping commands","title":"Set","type":"string","x-stream-index":"007"},"updated_at":{"description":"Date/time of the last update","format":"date-time","readOnly":true,"title":"Updated at","type":"number","x-stream-index":"002"}},"required":["name","description","args","set"],"title":"Command","type":"object"},"CommentAddedEvent":{"description":"Emitted when a comment is added to an activity.","nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","x-stream-index":"002"},"comment":{"$ref":"#/components/schemas/CommentResponse","description":"The comment that was added","title":"Text","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"003.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.001.007"},"feed_visibility":{"type":"string","x-stream-index":"003.003"},"fid":{"type":"string","x-stream-index":"003.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.001.004"},"type":{"default":"feeds.comment.added","description":"The type of event: \"feeds.comment.added\" in this case","title":"Event Type","type":"string","x-stream-index":"003.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who added the comment","title":"User","x-stream-index":"004.001"}},"required":["comment","activity","type","created_at","custom","fid"],"title":"CommentAddedEvent","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"},"CommentDeletedEvent":{"description":"Emitted when a comment is deleted.","nullable":true,"properties":{"comment":{"$ref":"#/components/schemas/CommentResponse","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"type":"string","x-stream-index":"002.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.comment.deleted","description":"The type of event: \"feeds.comment.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who deleted the comment","title":"User","x-stream-index":"003.001"}},"required":["comment","type","created_at","custom","fid"],"title":"CommentDeletedEvent","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"},"CommentReactionAddedEvent":{"description":"Emitted when a reaction is added to a comment.","nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","x-stream-index":"003"},"comment":{"$ref":"#/components/schemas/CommentResponse","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"004.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004.001.007"},"feed_visibility":{"type":"string","x-stream-index":"004.003"},"fid":{"type":"string","x-stream-index":"004.002"},"reaction":{"$ref":"#/components/schemas/FeedsReactionResponse","description":"The reaction that was added","title":"Reaction","x-stream-index":"002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"004.001.004"},"type":{"default":"feeds.comment.reaction.added","description":"The type of event: \"feeds.comment.reaction.added\" in this case","title":"Event Type","type":"string","x-stream-index":"004.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who added the reaction","title":"User","x-stream-index":"005.001"}},"required":["comment","reaction","activity","type","created_at","custom","fid"],"title":"CommentReactionAddedEvent","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"},"CommentReactionDeletedEvent":{"description":"Emitted when a reaction is deleted from a comment.","nullable":true,"properties":{"comment":{"$ref":"#/components/schemas/CommentResponse","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"003.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.001.007"},"feed_visibility":{"type":"string","x-stream-index":"003.003"},"fid":{"type":"string","x-stream-index":"003.002"},"reaction":{"$ref":"#/components/schemas/FeedsReactionResponse","x-stream-index":"002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.001.004"},"type":{"default":"feeds.comment.reaction.deleted","description":"The type of reaction that was removed","title":"Type","type":"string","x-stream-index":"003.001.002"}},"required":["comment","reaction","type","created_at","custom","fid"],"title":"CommentReactionDeletedEvent","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"},"CommentReactionUpdatedEvent":{"description":"Emitted when a reaction is updated on a comment.","nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","x-stream-index":"003"},"comment":{"$ref":"#/components/schemas/CommentResponse","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"004.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004.001.007"},"feed_visibility":{"type":"string","x-stream-index":"004.003"},"fid":{"type":"string","x-stream-index":"004.002"},"reaction":{"$ref":"#/components/schemas/FeedsReactionResponse","description":"The reaction that was updated","title":"Reaction","x-stream-index":"002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"004.001.004"},"type":{"default":"feeds.comment.reaction.updated","description":"The type of event: \"feeds.comment.reaction.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"004.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who updated the reaction","title":"User","x-stream-index":"005.001"}},"required":["comment","reaction","activity","type","created_at","custom","fid"],"title":"CommentReactionUpdatedEvent","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"},"CommentResponse":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"011"},"confidence_score":{"description":"Confidence score of the comment","format":"float","title":"Confidence Score","type":"number","x-stream-index":"022"},"controversy_score":{"description":"Controversy score of the comment","format":"float","title":"Controversy Score","type":"number","x-stream-index":"023"},"created_at":{"description":"When the comment was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"014"},"custom":{"additionalProperties":{},"description":"Custom data for the comment","title":"Custom Data","type":"object","x-stream-index":"006"},"deleted_at":{"description":"When the comment was deleted","format":"date-time","title":"Deleted At","type":"number","x-stream-index":"016"},"downvote_count":{"description":"Number of downvotes for this comment","format":"int32","title":"Downvote Count","type":"integer","x-stream-index":"020"},"id":{"description":"Unique identifier for the comment","title":"ID","type":"string","x-stream-index":"001"},"latest_reactions":{"description":"Recent reactions to the comment","items":{"$ref":"#/components/schemas/FeedsReactionResponse"},"title":"Latest Reactions","type":"array","x-stream-index":"009"},"mentioned_users":{"description":"Users mentioned in the comment","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Mention Users","type":"array","x-stream-index":"012"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"017"},"object_id":{"description":"ID of the object this comment is associated with","title":"Object ID","type":"string","x-stream-index":"002"},"object_type":{"description":"Type of the object this comment is associated with","title":"Object Type","type":"string","x-stream-index":"003"},"own_reactions":{"description":"Current user's reactions to this activity","items":{"$ref":"#/components/schemas/FeedsReactionResponse"},"title":"Own Reactions","type":"array","x-stream-index":"024"},"parent_id":{"description":"ID of parent comment for nested replies","title":"Parent ID","type":"string","x-stream-index":"007"},"reaction_count":{"description":"Number of reactions to this comment","format":"int32","title":"Reaction Count","type":"integer","x-stream-index":"008"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"description":"Grouped reactions by type","title":"Reaction Groups","type":"object","x-stream-index":"010"},"reply_count":{"description":"Number of replies to this comment","format":"int32","title":"Reply Count","type":"integer","x-stream-index":"018"},"score":{"description":"Score of the comment based on reactions","format":"int32","title":"Score","type":"integer","x-stream-index":"021"},"status":{"description":"Status of the comment (e.g., active, deleted)","title":"Status","type":"string","x-stream-index":"013"},"text":{"description":"Text content of the comment","title":"Text","type":"string","x-stream-index":"005"},"updated_at":{"description":"When the comment was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"015"},"upvote_count":{"description":"Number of upvotes for this comment","format":"int32","title":"Upvote Count","type":"integer","x-stream-index":"019"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who created the comment","title":"User","x-stream-index":"004"}},"required":["id","object_id","object_type","user","reaction_count","mentioned_users","status","created_at","updated_at","reply_count","upvote_count","downvote_count","score","confidence_score","own_reactions"],"title":"Comment","type":"object"},"CommentUpdatedEvent":{"description":"Emitted when a comment is updated.","nullable":true,"properties":{"comment":{"$ref":"#/components/schemas/CommentResponse","description":"The comment that was updated","title":"Text","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"type":"string","x-stream-index":"002.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.comment.updated","description":"The type of event: \"feeds.comment.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who updated the comment","title":"User","x-stream-index":"003.001"}},"required":["comment","type","created_at","custom","fid"],"title":"CommentUpdatedEvent","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"},"CommitMessageRequest":{"nullable":true,"type":"object"},"CompositeAppSettings":{"properties":{"json_encoded_settings":{"type":"string","x-stream-index":"005"},"url":{"type":"string","x-stream-index":"004"}},"type":"object"},"ConfigOverrides":{"properties":{"blocklist":{"type":"string","x-stream-index":"008"},"blocklist_behavior":{"enum":["flag","block"],"type":"string","x-stream-index":"009"},"commands":{"items":{"type":"string"},"type":"array","x-stream-index":"011"},"count_messages":{"type":"boolean","x-stream-index":"014"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"010"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"007"},"quotes":{"type":"boolean","x-stream-index":"004"},"reactions":{"type":"boolean","x-stream-index":"002"},"replies":{"type":"boolean","x-stream-index":"003"},"shared_locations":{"type":"boolean","x-stream-index":"013"},"typing_events":{"type":"boolean","x-stream-index":"001"},"uploads":{"type":"boolean","x-stream-index":"005"},"url_enrichment":{"type":"boolean","x-stream-index":"006"},"user_message_reminders":{"type":"boolean","x-stream-index":"012"}},"required":["grants","commands"],"type":"object"},"ConfigResponse":{"properties":{"ai_image_config":{"$ref":"#/components/schemas/AIImageConfig","description":"Configuration for AI image analysis","title":"AI Image Config","x-stream-index":"010"},"ai_text_config":{"$ref":"#/components/schemas/AITextConfig","description":"Configuration for AI text analysis","title":"AI Text Config","x-stream-index":"008"},"ai_video_config":{"$ref":"#/components/schemas/AIVideoConfig","description":"Configuration for AI video analysis","title":"AI Video Config","x-stream-index":"011"},"async":{"description":"Whether moderation should be performed asynchronously","title":"Async","type":"boolean","x-stream-index":"003"},"automod_platform_circumvention_config":{"$ref":"#/components/schemas/AutomodPlatformCircumventionConfig","description":"Configuration for platform circumvention detection","title":"Automod Platform Circumvention Config","x-stream-index":"005"},"automod_semantic_filters_config":{"$ref":"#/components/schemas/AutomodSemanticFiltersConfig","description":"Configuration for semantic filtering","title":"Automod Semantic Filters Config","x-stream-index":"006"},"automod_toxicity_config":{"$ref":"#/components/schemas/AutomodToxicityConfig","description":"Configuration for toxicity detection","title":"Automod Toxicity Config","x-stream-index":"004"},"block_list_config":{"$ref":"#/components/schemas/BlockListConfig","description":"Configuration for block list filtering","title":"Block List Config","x-stream-index":"007"},"created_at":{"description":"When the configuration was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"013"},"key":{"description":"Unique identifier for the moderation configuration","title":"Key","type":"string","x-stream-index":"001"},"llm_config":{"$ref":"#/components/schemas/LLMConfig","description":"Configuration for customer-configured LLM moderation","title":"LLM Config","x-stream-index":"009"},"team":{"description":"Team associated with the configuration","title":"Team","type":"string","x-stream-index":"002"},"updated_at":{"description":"When the configuration was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"014"},"velocity_filter_config":{"$ref":"#/components/schemas/VelocityFilterConfig","description":"Configuration for velocity-based filtering","title":"Velocity Filter Config","x-stream-index":"012"},"video_call_rule_config":{"$ref":"#/components/schemas/VideoCallRuleConfig","x-stream-index":"015"}},"required":["key","team","async","created_at","updated_at"],"type":"object"},"ContentCountRuleParameters":{"properties":{"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"type":"object"},"CountByMinuteResponse":{"nullable":true,"properties":{"count":{"format":"int32","type":"integer","x-stream-index":"002"},"start_ts":{"format":"date-time","type":"number","x-stream-index":"001"}},"required":["start_ts","count"],"type":"object"},"CreateBlockListRequest":{"description":"Block list contains restricted words","nullable":true,"properties":{"name":{"description":"Block list name","maxLength":255,"title":"Name","type":"string","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"004"},"type":{"description":"Block list type.","enum":["regex","domain","domain_allowlist","email","word"],"title":"Type","type":"string","x-stream-index":"003"},"words":{"description":"List of words to block","items":{"type":"string"},"minimum":1,"title":"Words","type":"array","x-stream-index":"002"}},"required":["name","words"],"title":"Block list","type":"object","x-stream-docs-page-id":"block_lists"},"CreateBlockListResponse":{"description":"Basic response information","nullable":true,"properties":{"blocklist":{"$ref":"#/components/schemas/BlockListResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["duration"],"title":"Response","type":"object"},"CreateCallTypeRequest":{"description":"Request for creating a call type","nullable":true,"properties":{"external_storage":{"description":"the external storage for the call type","title":"ExternalStorage","type":"string","x-stream-index":"002.004"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"the permissions granted to each role","title":"Grants","type":"object","x-stream-index":"002.001"},"name":{"type":"string","x-stream-index":"001"},"notification_settings":{"$ref":"#/components/schemas/NotificationSettings","description":"the notification settings for the call type","title":"NotificationSettings","x-stream-index":"002.002"},"settings":{"$ref":"#/components/schemas/CallSettingsRequest","description":"the settings for the call type","title":"Settings","x-stream-index":"002.003"}},"required":["name"],"title":"CreateCallTypeRequest","type":"object"},"CreateCallTypeResponse":{"description":"Response for creating a call type","nullable":true,"properties":{"created_at":{"description":"the time the call type was created","format":"date-time","title":"CreatedAt","type":"number","x-stream-index":"001.005"},"duration":{"type":"string","x-stream-index":"002.001"},"external_storage":{"description":"the external storage for the call type","title":"ExternalStorage","type":"string","x-stream-index":"001.007"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"the permissions granted to each role","title":"Grants","type":"object","x-stream-index":"001.002"},"name":{"description":"the name of the call type","title":"Name","type":"string","x-stream-index":"001.001"},"notification_settings":{"$ref":"#/components/schemas/NotificationSettings","description":"the notification settings for the call type","title":"NotificationSettings","x-stream-index":"001.004"},"settings":{"$ref":"#/components/schemas/CallSettingsResponse","description":"the settings for the call type","title":"Settings","x-stream-index":"001.003"},"updated_at":{"description":"the time the call type was last updated","format":"date-time","title":"UpdatedAt","type":"number","x-stream-index":"001.006"}},"required":["name","grants","settings","notification_settings","created_at","updated_at","duration"],"title":"CreateCallTypeResponse","type":"object"},"CreateChannelTypeRequest":{"nullable":true,"properties":{"automod":{"description":"Automod","enum":["disabled","simple","AI"],"title":"Automod","type":"string","x-stream-index":"019"},"automod_behavior":{"description":"Automod behavior","enum":["flag","block"],"title":"Automod behavior","type":"string","x-stream-index":"020"},"blocklist":{"description":"Blocklist","title":"Blocklist","type":"string","x-stream-index":"024"},"blocklist_behavior":{"description":"Blocklist behavior","enum":["flag","block","shadow_block"],"title":"Blocklist behavior","type":"string","x-stream-index":"025"},"blocklists":{"description":"Blocklists","items":{"$ref":"#/components/schemas/BlockListOptions"},"title":"Blocklists","type":"array","x-stream-index":"026"},"commands":{"description":"List of commands that channel supports","items":{"type":"string"},"title":"Commands","type":"array","x-stream-index":"021"},"connect_events":{"description":"Connect events","title":"Connect events","type":"boolean","x-stream-index":"004"},"custom_events":{"description":"Custom events","title":"Custom events","type":"boolean","x-stream-index":"011"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"List of grants for the channel type","title":"Grants","type":"object","x-stream-index":"023"},"mark_messages_pending":{"description":"Mark messages pending","title":"Mark messages pending","type":"boolean","x-stream-index":"013"},"max_message_length":{"description":"Max message length","format":"int32","title":"Max message length","type":"integer","x-stream-index":"018"},"message_retention":{"description":"Message retention","enum":["infinite","numeric"],"title":"Message retention","type":"string","x-stream-index":"017"},"mutes":{"description":"Mutes","title":"Mutes","type":"boolean","x-stream-index":"008"},"name":{"description":"Channel type name","title":"Name","type":"string","x-stream-index":"001"},"partition_size":{"description":"Partition size","format":"int32","minimum":10,"title":"Partition size","type":"integer","x-stream-index":"027"},"partition_ttl":{"description":"Partition TTL","example":"24h","format":"duration","nullable":true,"title":"Partition TTL","type":"string","x-stream-index":"028"},"permissions":{"description":"List of permissions for the channel type","items":{"$ref":"#/components/schemas/PolicyRequest"},"title":"Permissions","type":"array","x-stream-index":"022"},"polls":{"description":"Polls","title":"Polls","type":"boolean","x-stream-index":"014"},"push_notifications":{"description":"Push notifications","title":"Push notifications","type":"boolean","x-stream-index":"012"},"reactions":{"description":"Reactions","title":"Reactions","type":"boolean","x-stream-index":"005"},"read_events":{"description":"Read events","title":"Read events","type":"boolean","x-stream-index":"003"},"replies":{"description":"Replies","title":"Replies","type":"boolean","x-stream-index":"006"},"search":{"description":"Search","title":"Search","type":"boolean","x-stream-index":"007"},"shared_locations":{"description":"Enables shared location messages","title":"Shared locations","type":"boolean","x-stream-index":"016"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"029"},"typing_events":{"description":"Typing events","title":"Typing events","type":"boolean","x-stream-index":"002"},"uploads":{"description":"Uploads","title":"Uploads","type":"boolean","x-stream-index":"009"},"url_enrichment":{"description":"URL enrichment","title":"URL enrichment","type":"boolean","x-stream-index":"010"},"user_message_reminders":{"type":"boolean","x-stream-index":"015"}},"required":["name","max_message_length","automod","automod_behavior"],"title":"CreateChannelTypeRequest","type":"object"},"CreateChannelTypeResponse":{"nullable":true,"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.001.027"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.001.022"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.001.023"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.001.028"},"blocklist":{"type":"string","x-stream-index":"001.001.024"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.001.025"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.001.026"},"commands":{"items":{"type":"string"},"type":"array","x-stream-index":"001.003"},"connect_events":{"type":"boolean","x-stream-index":"001.001.004"},"count_messages":{"type":"boolean","x-stream-index":"001.001.019"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002.003"},"custom_events":{"type":"boolean","x-stream-index":"001.001.012"},"duration":{"type":"string","x-stream-index":"004.001"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"003"},"mark_messages_pending":{"type":"boolean","x-stream-index":"001.001.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"001.001.021"},"mutes":{"type":"boolean","x-stream-index":"001.001.009"},"name":{"type":"string","x-stream-index":"001.001.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"001.001.029"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"001.001.030"},"permissions":{"items":{"$ref":"#/components/schemas/PolicyRequest"},"type":"array","x-stream-index":"002"},"polls":{"type":"boolean","x-stream-index":"001.001.016"},"push_notifications":{"type":"boolean","x-stream-index":"001.001.013"},"quotes":{"type":"boolean","x-stream-index":"001.001.008"},"reactions":{"type":"boolean","x-stream-index":"001.001.006"},"read_events":{"type":"boolean","x-stream-index":"001.001.003"},"reminders":{"type":"boolean","x-stream-index":"001.001.014"},"replies":{"type":"boolean","x-stream-index":"001.001.007"},"search":{"type":"boolean","x-stream-index":"001.001.005"},"shared_locations":{"type":"boolean","x-stream-index":"001.001.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.001.031"},"typing_events":{"type":"boolean","x-stream-index":"001.001.002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.002.004"},"uploads":{"type":"boolean","x-stream-index":"001.001.010"},"url_enrichment":{"type":"boolean","x-stream-index":"001.001.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"001.001.017"}},"required":["name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","count_messages","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","created_at","updated_at","commands","permissions","grants","duration"],"type":"object"},"CreateCommandRequest":{"description":"Create a new command","nullable":true,"properties":{"args":{"description":"Arguments help text, shown in commands auto-completion","maxLength":255,"title":"Arguments","type":"string","x-stream-index":"003"},"description":{"description":"Description, shown in commands auto-completion","maxLength":255,"title":"Description","type":"string","x-stream-index":"002"},"name":{"description":"Unique command name","maxLength":255,"minLength":1,"title":"Name","type":"string","x-stream-index":"001"},"set":{"description":"Set name used for grouping commands","maxLength":255,"title":"Set","type":"string","x-stream-index":"004"}},"required":["name","description"],"title":"CreateCommandRequest","type":"object"},"CreateCommandResponse":{"nullable":true,"properties":{"command":{"$ref":"#/components/schemas/Command","description":"Command object","title":"Command","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["duration"],"title":"CreateCommandResponse","type":"object"},"CreateDeviceRequest":{"description":"Create device request","nullable":true,"properties":{"id":{"description":"Device ID","maxLength":255,"minLength":1,"title":"ID","type":"string","x-stream-index":"001"},"push_provider":{"description":"Push provider","enum":["firebase","apn","huawei","xiaomi"],"title":"PushProvider","type":"string","x-stream-index":"002"},"push_provider_name":{"description":"Push provider name","title":"PushProviderName","type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"005.002"},"user_id":{"description":"**Server-side only**. User ID which server acts upon","title":"User ID","type":"string","x-stream-index":"005.001"},"voip_token":{"description":"When true the token is for Apple VoIP push notifications","title":"VoipToken","type":"boolean","x-stream-index":"004"}},"required":["id","push_provider"],"title":"CreateDeviceRequest","type":"object"},"CreateExternalStorageRequest":{"description":"Create external storage","nullable":true,"properties":{"aws_s3":{"$ref":"#/components/schemas/S3Request","description":"Only required if you want to create an Amazon S3 storage","title":"AwsS3","x-stream-index":"003.004"},"azure_blob":{"$ref":"#/components/schemas/AzureRequest","description":"Only required if you want to create an Azure Blob Storage","title":"AzureBlob","x-stream-index":"003.006"},"bucket":{"description":"The name of the bucket on the service provider","title":"Bucket","type":"string","x-stream-index":"003.002"},"gcs_credentials":{"type":"string","x-stream-index":"003.005"},"name":{"description":"The name of the provider, this must be unique","title":"Name","type":"string","x-stream-index":"001"},"path":{"description":"The path prefix to use for storing files","title":"Path","type":"string","x-stream-index":"003.003"},"storage_type":{"description":"The type of storage to use","enum":["s3","gcs","abs"],"title":"StorageType","type":"string","x-stream-index":"003.001"}},"required":["name","storage_type","bucket"],"title":"CreateExternalStorageRequest","type":"object"},"CreateExternalStorageResponse":{"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"},"CreateFeedGroupRequest":{"nullable":true,"properties":{"activity_processors":{"description":"Configuration for activity processors (max 10)","items":{"$ref":"#/components/schemas/ActivityProcessorConfig"},"maximum":10,"title":"Activity Processors","type":"array","x-stream-index":"006"},"activity_selectors":{"description":"Configuration for activity selectors (max 10)","items":{"$ref":"#/components/schemas/ActivitySelectorConfig"},"maximum":10,"title":"Activity Selectors","type":"array","x-stream-index":"007"},"aggregation":{"$ref":"#/components/schemas/AggregationConfig","description":"Configuration for activity aggregation","title":"Aggregation","x-stream-index":"009"},"custom":{"additionalProperties":{},"description":"Custom data for the feed group","title":"Custom Data","type":"object","x-stream-index":"004"},"default_visibility":{"description":"Default visibility for the feed group, can be 'public', 'visible', 'followers', 'members', or 'private'. Defaults to 'visible' if not provided. ","enum":["public","visible","followers","members","private"],"title":"Default Visibility","type":"string","x-stream-index":"005"},"id":{"description":"Unique identifier for the feed group","maxLength":255,"title":"Feed Group ID","type":"string","x-stream-index":"001"},"notification":{"$ref":"#/components/schemas/NotificationConfig","description":"Configuration for notifications","title":"Notification","x-stream-index":"002"},"push_notification":{"$ref":"#/components/schemas/PushNotificationConfig","x-stream-index":"003"},"ranking":{"$ref":"#/components/schemas/RankingConfig","description":"Configuration for activity ranking","title":"Ranking","x-stream-index":"008"}},"required":["id"],"title":"Create Feed Group Request","type":"object"},"CreateFeedGroupResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"feed_group":{"$ref":"#/components/schemas/FeedGroupResponse","description":"The upserted feed group","title":"Feed Group","x-stream-index":"001"}},"required":["feed_group","duration"],"title":"Upsert Feed Group Response","type":"object"},"CreateFeedViewRequest":{"nullable":true,"properties":{"activity_processors":{"description":"Configured activity Processors","items":{"$ref":"#/components/schemas/ActivityProcessorConfig"},"title":"Activity Processors","type":"array","x-stream-index":"002.002"},"activity_selectors":{"description":"Configuration for selecting activities","items":{"$ref":"#/components/schemas/ActivitySelectorConfig"},"title":"Activity Selectors","type":"array","x-stream-index":"002.001"},"aggregation":{"$ref":"#/components/schemas/AggregationConfig","description":"Configuration for aggregating activities","title":"Aggregation","x-stream-index":"002.004"},"id":{"description":"Unique identifier for the feed view","maxLength":255,"title":"View ID","type":"string","x-stream-index":"001"},"ranking":{"$ref":"#/components/schemas/RankingConfig","description":"Configuration for ranking activities","title":"Ranking","x-stream-index":"002.003"}},"required":["id"],"title":"Create Feed View Request","type":"object"},"CreateFeedViewResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"feed_view":{"$ref":"#/components/schemas/FeedViewResponse","description":"The created feed view","title":"Feed View","x-stream-index":"001"}},"required":["feed_view","duration"],"title":"Create Feed View Response","type":"object"},"CreateFeedsBatchRequest":{"nullable":true,"properties":{"feeds":{"description":"List of feeds to create","items":{"$ref":"#/components/schemas/FeedRequest"},"maximum":1000,"minimum":1,"title":"Feeds","type":"array","x-stream-index":"001"}},"required":["feeds"],"title":"Create Feeds Batch Request","type":"object"},"CreateFeedsBatchResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"feeds":{"description":"List of created feeds","items":{"$ref":"#/components/schemas/FeedResponse"},"title":"Feeds","type":"array","x-stream-index":"001"}},"required":["feeds","duration"],"title":"Create Feeds Batch Response","type":"object"},"CreateGuestRequest":{"nullable":true,"properties":{"user":{"$ref":"#/components/schemas/UserRequest","description":"User object which server acts upon","title":"User","x-stream-index":"001"}},"required":["user"],"type":"object"},"CreateGuestResponse":{"nullable":true,"properties":{"access_token":{"description":"the access token to authenticate the user","title":"Access token","type":"string","x-stream-index":"002"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User object which server acts upon","title":"User","x-stream-index":"001"}},"required":["user","access_token","duration"],"type":"object"},"CreateImportRequest":{"nullable":true,"properties":{"mode":{"enum":["insert","upsert"],"type":"string","x-stream-index":"002"},"path":{"type":"string","x-stream-index":"001"}},"required":["path","mode"],"type":"object"},"CreateImportResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"import_task":{"$ref":"#/components/schemas/ImportTask","x-stream-index":"001"}},"required":["duration"],"title":"Response","type":"object"},"CreateImportURLRequest":{"nullable":true,"properties":{"filename":{"type":"string","x-stream-index":"001"}},"type":"object"},"CreateImportURLResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"path":{"type":"string","x-stream-index":"001"},"upload_url":{"type":"string","x-stream-index":"002"}},"required":["path","upload_url","duration"],"title":"Response","type":"object"},"CreateMembershipLevelRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"description":"Custom data for the membership level","title":"Custom Data","type":"object","x-stream-index":"006"},"description":{"description":"Optional description of the membership level","maxLength":1000,"title":"Description","type":"string","x-stream-index":"003"},"id":{"description":"Unique identifier for the membership level","maxLength":255,"title":"ID","type":"string","x-stream-index":"001"},"name":{"description":"Display name for the membership level","maxLength":255,"title":"Name","type":"string","x-stream-index":"002"},"priority":{"description":"Priority level (higher numbers = higher priority)","format":"int32","minimum":0,"title":"Priority","type":"integer","x-stream-index":"004"},"tags":{"description":"Activity tags this membership level gives access to","items":{"type":"string"},"maximum":255,"title":"Tags","type":"array","x-stream-index":"005"}},"required":["id","name"],"title":"Create Membership Level Request","type":"object"},"CreateMembershipLevelResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"membership_level":{"$ref":"#/components/schemas/MembershipLevelResponse","description":"The created membership level","title":"Membership Level","x-stream-index":"001"}},"required":["membership_level","duration"],"title":"Create Membership Level Response","type":"object"},"CreatePollOptionRequest":{"nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"003"},"text":{"description":"Option text","title":"string","type":"string","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"required":["text"],"type":"object"},"CreatePollRequest":{"description":"Contains all information needed to create a new poll","nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"011"},"allow_answers":{"description":"Indicates whether users can suggest user defined answers","title":"Allow answers","type":"boolean","x-stream-index":"009"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"008"},"description":{"description":"A description of the poll","title":"Description","type":"string","x-stream-index":"003"},"enforce_unique_vote":{"description":"Indicates whether users can cast multiple votes","title":"Multiple choice","type":"boolean","x-stream-index":"006"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"is_closed":{"description":"Indicates whether the poll is open for voting","title":"Is closed","type":"boolean","x-stream-index":"010"},"max_votes_allowed":{"description":"Indicates the maximum amount of votes a user can cast","format":"int32","maximum":10,"title":"Maximum votes allowed","type":"integer","x-stream-index":"007"},"name":{"description":"The name of the poll","title":"Name","type":"string","x-stream-index":"002"},"options":{"items":{"$ref":"#/components/schemas/PollOptionInput"},"maximum":100,"type":"array","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"012.002"},"user_id":{"type":"string","x-stream-index":"012.001"},"voting_visibility":{"enum":["anonymous","public"],"type":"string","x-stream-index":"005"}},"required":["name"],"title":"Create Poll Request","type":"object"},"CreateReminderRequest":{"nullable":true,"properties":{"remind_at":{"format":"date-time","type":"number","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"type":"object"},"CreateRoleRequest":{"nullable":true,"properties":{"name":{"description":"Role name","maxLength":64,"title":"Name","type":"string","x-stream-index":"001"}},"required":["name"],"type":"object"},"CreateRoleResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"role":{"$ref":"#/components/schemas/Role","x-stream-index":"002"}},"required":["duration","role"],"title":"Response","type":"object"},"CustomActionRequest":{"properties":{"id":{"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"type":"object"},"CustomCheckFlag":{"properties":{"custom":{"additionalProperties":{},"description":"Additional metadata for the flag","title":"Custom","type":"object","x-stream-index":"003"},"labels":{"description":"Labels from various moderation sources","items":{"type":"string"},"title":"Labels","type":"array","x-stream-index":"004"},"reason":{"description":"Optional explanation for the flag","title":"Reason","type":"string","x-stream-index":"002"},"type":{"description":"Type of check (custom_check_text, custom_check_image, custom_check_video)","maxLength":255,"title":"Type","type":"string","x-stream-index":"001"}},"required":["type"],"type":"object"},"CustomCheckRequest":{"nullable":true,"properties":{"entity_creator_id":{"description":"ID of the user who created the entity (required for non-message entities)","title":"Entity Creator ID","type":"string","x-stream-index":"003"},"entity_id":{"description":"Unique identifier of the entity","title":"Entity ID","type":"string","x-stream-index":"002"},"entity_type":{"description":"Type of entity to perform custom check on","title":"Entity Type","type":"string","x-stream-index":"001"},"flags":{"description":"List of custom check flags (1-10 flags required)","items":{"$ref":"#/components/schemas/CustomCheckFlag"},"maximum":10,"minimum":1,"title":"Flags","type":"array","x-stream-index":"005"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content to be checked (required for non-message entities)","title":"Moderation Payload","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"006.002"},"user_id":{"type":"string","x-stream-index":"006.001"}},"required":["entity_type","entity_id","flags"],"type":"object"},"CustomCheckResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"004.001"},"id":{"description":"Unique identifier of the custom check","title":"ID","type":"string","x-stream-index":"001"},"item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"Review queue item details","title":"Item","x-stream-index":"002"},"status":{"description":"Status of the custom check","title":"Status","type":"string","x-stream-index":"003"}},"required":["id","status","duration"],"type":"object"},"CustomVideoEvent":{"description":"A custom event, this event is used to send custom events to other participants in the call.","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"003"},"type":{"default":"custom","description":"The type of event, \"custom\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"004"}},"required":["type","created_at","call_cid","custom","user"],"title":"CustomVideoEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"DailyAggregateCallDurationReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/CallDurationReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateCallParticipantCountReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/CallParticipantCountReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateCallsPerDayReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/CallsPerDayReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateQualityScoreReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/QualityScoreReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateSDKUsageReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/SDKUsageReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateUserFeedbackReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/UserFeedbackReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"Data":{"properties":{"id":{"type":"string","x-stream-index":"001"}},"required":["id"],"type":"object"},"DataDogInfo":{"properties":{"api_key":{"type":"string","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"003"},"site":{"type":"string","x-stream-index":"002"}},"type":"object"},"DeactivateUserRequest":{"nullable":true,"properties":{"created_by_id":{"description":"ID of the user who deactivated the user","title":"Created by ID","type":"string","x-stream-index":"003"},"mark_messages_deleted":{"description":"Makes messages appear to be deleted","title":"Mark messages deleted","type":"boolean","x-stream-index":"002"}},"type":"object"},"DeactivateUserResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Deactivated user object","title":"User","x-stream-index":"001"}},"required":["duration"],"type":"object"},"DeactivateUsersRequest":{"description":"Deactivate users request","nullable":true,"properties":{"created_by_id":{"description":"ID of the user who deactivated the users","title":"Created by ID","type":"string","x-stream-index":"003"},"mark_channels_deleted":{"type":"boolean","x-stream-index":"004"},"mark_messages_deleted":{"description":"Makes messages appear to be deleted","title":"Mark messages deleted","type":"boolean","x-stream-index":"002"},"user_ids":{"description":"User IDs to deactivate","items":{"type":"string"},"maximum":100,"minimum":1,"title":"User IDs","type":"array","x-stream-index":"001"}},"required":["user_ids"],"title":"DeactivateUsersRequest","type":"object"},"DeactivateUsersResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"task_id":{"type":"string","x-stream-index":"001"}},"required":["task_id","duration"],"title":"Response","type":"object"},"DecayFunctionConfig":{"properties":{"base":{"description":"Base value for decay function","title":"Base","type":"string","x-stream-index":"001"},"decay":{"description":"Decay rate","title":"Decay","type":"string","x-stream-index":"005"},"direction":{"description":"Direction of decay","title":"Direction","type":"string","x-stream-index":"006"},"offset":{"description":"Offset value for decay function","title":"Offset","type":"string","x-stream-index":"004"},"origin":{"description":"Origin value for decay function","title":"Origin","type":"string","x-stream-index":"002"},"scale":{"description":"Scale factor for decay function","title":"Scale","type":"string","x-stream-index":"003"}},"title":"Decay Function Configuration","type":"object"},"DeleteActivitiesRequest":{"nullable":true,"properties":{"hard_delete":{"description":"Whether to permanently delete the activities","title":"Hard Delete","type":"boolean","x-stream-index":"002"},"ids":{"description":"List of activity IDs to delete","items":{"type":"string"},"minimum":1,"title":"Activity IDs","type":"array","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"required":["ids"],"title":"Delete Activities Request","type":"object"},"DeleteActivitiesResponse":{"nullable":true,"properties":{"deleted_ids":{"description":"List of activity IDs that were successfully deleted","items":{"type":"string"},"title":"Deleted Activity IDs","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["deleted_ids","duration"],"title":"Delete Activities Response","type":"object"},"DeleteActivityReactionResponse":{"nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"reaction":{"$ref":"#/components/schemas/FeedsReactionResponse","x-stream-index":"002"}},"required":["activity","reaction","duration"],"title":"Delete Activity Reaction Response","type":"object"},"DeleteActivityRequest":{"properties":{"hard_delete":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"DeleteActivityResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"Delete Activity Response","type":"object"},"DeleteBookmarkFolderResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"Delete Bookmark Folder Response","type":"object"},"DeleteBookmarkResponse":{"nullable":true,"properties":{"bookmark":{"$ref":"#/components/schemas/BookmarkResponse","description":"The deleted bookmark","title":"Bookmark","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["bookmark","duration"],"title":"Delete Bookmark Response","type":"object"},"DeleteCallRequest":{"description":"DeleteCallRequest is the payload for deleting a call.","nullable":true,"properties":{"hard":{"description":"if true the call will be hard deleted along with all related data","title":"Hard","type":"boolean","x-stream-index":"001"}},"title":"DeleteCallRequest","type":"object"},"DeleteCallResponse":{"description":"DeleteCallResponse is the payload for deleting a call.","nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","title":"Call","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"task_id":{"title":"TaskID","type":"string","x-stream-index":"002"}},"required":["call","duration"],"title":"DeleteCallResponse","type":"object"},"DeleteChannelResponse":{"description":"Basic response information","nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"Response","type":"object"},"DeleteChannelsRequest":{"nullable":true,"properties":{"cids":{"description":"All channels that should be deleted","items":{"type":"string"},"maximum":100,"minimum":1,"title":"Channels CID","type":"array","x-stream-index":"001"},"hard_delete":{"description":"Specify if channels and all ressources should be hard deleted","title":"Hard delete","type":"boolean","x-stream-index":"002"}},"required":["cids"],"type":"object"},"DeleteChannelsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"result":{"additionalProperties":{"$ref":"#/components/schemas/DeleteChannelsResultResponse"},"description":"Map of channel IDs and their deletion results","title":"Result","type":"object","x-stream-index":"001"},"task_id":{"type":"string","x-stream-index":"002"}},"required":["duration"],"type":"object"},"DeleteChannelsResultResponse":{"nullable":true,"properties":{"error":{"type":"string","x-stream-index":"002"},"status":{"type":"string","x-stream-index":"001"}},"required":["status"],"type":"object"},"DeleteCommandResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"name":{"description":"Command name","title":"Name","type":"string","x-stream-index":"001"}},"required":["name","duration"],"title":"DeleteCommandResponse","type":"object"},"DeleteCommentReactionResponse":{"nullable":true,"properties":{"comment":{"$ref":"#/components/schemas/CommentResponse","description":"The comment after reaction removal","title":"Comment","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"reaction":{"$ref":"#/components/schemas/FeedsReactionResponse","description":"The removed reaction","title":"Reaction","x-stream-index":"002"}},"required":["comment","reaction","duration"],"title":"Delete Comment Reaction Response","type":"object"},"DeleteCommentResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"Delete Comment Response","type":"object"},"DeleteExternalStorageResponse":{"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"},"DeleteFeedGroupResponse":{"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"},"DeleteFeedResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"Delete Feed Response","type":"object"},"DeleteFeedUserDataResponse":{"description":"Response for deleting feed user data","nullable":true,"properties":{"deleted_activities":{"description":"Number of activities that were deleted","format":"int32","title":"Deleted Activities","type":"integer","x-stream-index":"001"},"deleted_bookmarks":{"description":"Number of bookmarks that were deleted","format":"int32","title":"Deleted Bookmarks","type":"integer","x-stream-index":"004"},"deleted_comments":{"description":"Number of comments that were deleted","format":"int32","title":"Deleted Comments","type":"integer","x-stream-index":"003"},"deleted_reactions":{"description":"Number of reactions that were deleted","format":"int32","title":"Deleted Reactions","type":"integer","x-stream-index":"002"},"duration":{"type":"string","x-stream-index":"005.001"}},"required":["deleted_activities","deleted_reactions","deleted_comments","deleted_bookmarks","duration"],"type":"object"},"DeleteFeedViewResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"Delete Feed View Response","type":"object"},"DeleteMessageRequest":{"properties":{"hard_delete":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"DeleteMessageResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001"}},"required":["message","duration"],"title":"Response","type":"object"},"DeleteModerationConfigResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"DeleteModerationRuleResponse":{"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"},"DeleteModerationTemplateResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"DeleteReactionRequest":{"properties":{"hard_delete":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"DeleteReactionResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001"},"reaction":{"$ref":"#/components/schemas/ReactionResponse","x-stream-index":"002"}},"required":["message","reaction","duration"],"title":"Response","type":"object"},"DeleteRecordingResponse":{"description":"Response for DeleteRecording","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"DeleteRecordingResponse","type":"object"},"DeleteReminderResponse":{"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"},"DeleteSegmentTargetsRequest":{"nullable":true,"properties":{"target_ids":{"description":"Target IDs","items":{"type":"string"},"maximum":100,"minimum":1,"title":"[]string","type":"array","x-stream-index":"002"}},"required":["target_ids"],"type":"object"},"DeleteTranscriptionResponse":{"description":"DeleteTranscriptionResponse is the payload for deleting a transcription.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"DeleteTranscriptionResponse","type":"object"},"DeleteUserRequest":{"properties":{"delete_conversation_channels":{"type":"boolean","x-stream-index":"003"},"delete_feeds_content":{"type":"boolean","x-stream-index":"004"},"hard_delete":{"type":"boolean","x-stream-index":"001"},"mark_messages_deleted":{"type":"boolean","x-stream-index":"002"}},"type":"object"},"DeleteUsersRequest":{"nullable":true,"properties":{"calls":{"description":"Calls delete mode.\nAffected calls are those that include exactly two members, one of whom is the user being deleted.\n\n* null or empty string - doesn't delete any calls\n* soft - marks user's calls and their related data as deleted (soft-delete)\n* hard - deletes user's calls and their data completely (hard-delete)\n","enum":["soft","hard"],"title":"Delete User's calls","type":"string","x-stream-index":"001.002.004"},"conversations":{"description":"Conversation channels delete mode.\nConversation channel is any channel which only has two members one of which is the user being deleted.\n\n* null or empty string - doesn't delete any conversation channels\n* soft - marks all conversation channels as deleted (same effect as Delete Channels with 'hard' option disabled)\n* hard - deletes channel and all its data completely including messages (same effect as Delete Channels with 'hard' option enabled)\n","enum":["soft","hard"],"title":"Delete Conversations","type":"string","x-stream-index":"001.002.003"},"files":{"description":"Delete user files.\n* false or empty string - doesn't delete any files\n* true - deletes all files uploaded by the user, including images and attachments.\n","title":"Delete User's files","type":"boolean","x-stream-index":"001.002.005"},"messages":{"description":"Message delete mode.\n\n* null or empty string - doesn't delete user messages\n* soft - marks all user messages as deleted without removing any related message data\n* pruning - marks all user messages as deleted, nullifies message information and removes some message data such as reactions and flags\n* hard - deletes messages completely with all related information\n","enum":["soft","pruning","hard"],"title":"Delete Messages","type":"string","x-stream-index":"001.002.002"},"new_call_owner_id":{"type":"string","x-stream-index":"001.002.007"},"new_channel_owner_id":{"type":"string","x-stream-index":"001.002.006"},"user":{"description":"User delete mode.\n\n* soft - marks user as deleted and retains all user data\n* pruning - marks user as deleted and nullifies user information\n* hard - deletes user completely. Requires 'hard' option for messages and conversations as well\n","enum":["soft","pruning","hard"],"title":"Delete User","type":"string","x-stream-index":"001.002.001"},"user_ids":{"description":"IDs of users to delete","items":{"type":"string"},"maximum":100,"minimum":1,"title":"User IDs","type":"array","x-stream-index":"001.001"}},"required":["user_ids"],"type":"object"},"DeleteUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"task_id":{"description":"ID of the task to delete users","title":"Task ID","type":"string","x-stream-index":"001"}},"required":["task_id","duration"],"type":"object"},"Device":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"disabled":{"type":"boolean","x-stream-index":"002.003"},"disabled_reason":{"type":"string","x-stream-index":"002.004"},"id":{"type":"string","x-stream-index":"002.001.004"},"push_provider":{"enum":["firebase","apn","huawei","xiaomi"],"type":"string","x-stream-index":"002.001.001"},"push_provider_name":{"type":"string","x-stream-index":"002.001.003"},"user_id":{"type":"string","x-stream-index":"004"},"voip":{"type":"boolean","x-stream-index":"002.001.005"}},"required":["push_provider","id","created_at","user_id"],"type":"object"},"DeviceDataResponse":{"properties":{"name":{"type":"string","x-stream-index":"001"},"version":{"type":"string","x-stream-index":"002"}},"type":"object"},"DeviceErrorInfo":{"properties":{"error_message":{"type":"string","x-stream-index":"003"},"provider":{"type":"string","x-stream-index":"001"},"provider_name":{"type":"string","x-stream-index":"002"}},"required":["provider","provider_name","error_message"],"type":"object"},"DeviceResponse":{"description":"Response for Device","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"004"},"disabled":{"description":"Whether device is disabled or not","title":"Disabled","type":"boolean","x-stream-index":"005"},"disabled_reason":{"description":"Reason explaining why device had been disabled","title":"Reason","type":"string","x-stream-index":"006"},"id":{"description":"Device ID","title":"ID","type":"string","x-stream-index":"003"},"push_provider":{"description":"Push provider","title":"PushProvider","type":"string","x-stream-index":"001"},"push_provider_name":{"description":"Push provider name","title":"PushProviderName","type":"string","x-stream-index":"002"},"user_id":{"description":"User ID","title":"UserID","type":"string","x-stream-index":"008"},"voip":{"description":"When true the token is for Apple VoIP push notifications","title":"Voip","type":"boolean","x-stream-index":"007"}},"required":["push_provider","id","created_at","user_id"],"title":"DeviceResponse","type":"object"},"DraftPayloadResponse":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"html":{"type":"string","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"001"},"mentioned_users":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"008"},"mml":{"type":"string","x-stream-index":"003"},"parent_id":{"type":"string","x-stream-index":"005"},"poll_id":{"type":"string","x-stream-index":"013"},"quoted_message_id":{"type":"string","x-stream-index":"009"},"show_in_channel":{"type":"boolean","x-stream-index":"006"},"silent":{"type":"boolean","x-stream-index":"012"},"text":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"011"}},"required":["id","text","custom"],"type":"object"},"DraftResponse":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003"},"channel_cid":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"message":{"$ref":"#/components/schemas/DraftPayloadResponse","x-stream-index":"001"},"parent_id":{"type":"string","x-stream-index":"004"},"parent_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"005"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"006"}},"required":["message","channel_cid","created_at"],"type":"object"},"EdgeResponse":{"properties":{"continent_code":{"type":"string","x-stream-index":"007.003"},"country_iso_code":{"type":"string","x-stream-index":"007.002"},"green":{"format":"int32","type":"integer","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"latency_test_url":{"type":"string","x-stream-index":"002"},"latitude":{"format":"float","type":"number","x-stream-index":"006.001"},"longitude":{"format":"float","type":"number","x-stream-index":"006.002"},"red":{"format":"int32","type":"integer","x-stream-index":"005"},"subdivision_iso_code":{"type":"string","x-stream-index":"007.001"},"yellow":{"format":"int32","type":"integer","x-stream-index":"004"}},"required":["id","latency_test_url","green","yellow","red","latitude","longitude","subdivision_iso_code","country_iso_code","continent_code"],"type":"object"},"EgressHLSResponse":{"properties":{"playlist_url":{"type":"string","x-stream-index":"001"},"status":{"type":"string","x-stream-index":"002"}},"required":["playlist_url","status"],"type":"object"},"EgressRTMPResponse":{"properties":{"name":{"type":"string","x-stream-index":"001"},"started_at":{"format":"date-time","type":"number","x-stream-index":"004"},"stream_key":{"type":"string","x-stream-index":"003"},"stream_url":{"type":"string","x-stream-index":"002"}},"required":["name","started_at"],"type":"object"},"EgressResponse":{"properties":{"broadcasting":{"type":"boolean","x-stream-index":"001"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordingResponse","x-stream-index":"004"},"hls":{"$ref":"#/components/schemas/EgressHLSResponse","x-stream-index":"002"},"rtmps":{"items":{"$ref":"#/components/schemas/EgressRTMPResponse"},"type":"array","x-stream-index":"003"}},"required":["broadcasting","rtmps"],"type":"object"},"EgressTaskConfig":{"properties":{"egress_user":{"$ref":"#/components/schemas/EgressUser","x-stream-index":"008"},"frame_recording_egress_config":{"$ref":"#/components/schemas/FrameRecordingEgressConfig","x-stream-index":"009"},"hls_egress_config":{"$ref":"#/components/schemas/HLSEgressConfig","x-stream-index":"007"},"recording_egress_config":{"$ref":"#/components/schemas/RecordingEgressConfig","x-stream-index":"006"},"rtmp_egress_config":{"$ref":"#/components/schemas/RTMPEgressConfig","x-stream-index":"004"},"stt_egress_config":{"$ref":"#/components/schemas/STTEgressConfig","x-stream-index":"005"}},"type":"object"},"EgressUser":{"properties":{"token":{"type":"string","x-stream-index":"004"}},"type":"object"},"EndCallRequest":{"description":"Request for ending a call","nullable":true,"title":"EndCallRequest","type":"object"},"EndCallResponse":{"description":"Response for ending a call","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"EndCallResponse","type":"object"},"EnrichedActivity":{"properties":{"actor":{"$ref":"#/components/schemas/Data","x-stream-index":"002"},"foreign_id":{"type":"string","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"latest_reactions":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"013"},"object":{"$ref":"#/components/schemas/Data","x-stream-index":"004"},"origin":{"$ref":"#/components/schemas/Data","x-stream-index":"008"},"own_reactions":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"012"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"011"},"score":{"format":"float","type":"number","x-stream-index":"010"},"target":{"$ref":"#/components/schemas/Data","x-stream-index":"006"},"to":{"items":{"type":"string"},"type":"array","x-stream-index":"009"},"verb":{"type":"string","x-stream-index":"003"}},"type":"object"},"EnrichedReaction":{"nullable":true,"properties":{"activity_id":{"type":"string","x-stream-index":"003"},"children_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"010"},"created_at":{"$ref":"#/components/schemas/Time","x-stream-index":"012"},"data":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"kind":{"type":"string","x-stream-index":"002"},"latest_children":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"008"},"own_children":{"additionalProperties":{"items":{"$ref":"#/components/schemas/EnrichedReaction"},"type":"array"},"type":"object","x-stream-index":"009"},"parent":{"type":"string","x-stream-index":"007"},"target_feeds":{"items":{"type":"string"},"type":"array","x-stream-index":"006"},"updated_at":{"$ref":"#/components/schemas/Time","x-stream-index":"013"},"user":{"$ref":"#/components/schemas/Data","x-stream-index":"011"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["kind","activity_id","user_id"],"type":"object"},"EntityCreator":{"properties":{"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"001.046"},"ban_count":{"format":"int32","type":"integer","x-stream-index":"002"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"001.017"},"banned":{"type":"boolean","x-stream-index":"001.016"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.013"},"deleted_content_count":{"format":"int32","type":"integer","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"001.023"},"language":{"type":"string","x-stream-index":"001.035"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"001.022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"001.026"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.042"},"role":{"type":"string","x-stream-index":"001.004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.005"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.009"}},"required":["id","role","teams_role","custom","banned","online","ban_count","deleted_content_count"],"type":"object"},"EntityCreatorResponse":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.001.018"},"ban_count":{"description":"Number of minor actions performed on the user","format":"int32","title":"Ban Count","type":"integer","x-stream-index":"002"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"001.003"},"banned":{"type":"boolean","x-stream-index":"001.001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.001.017"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.001.016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.001.011"},"deleted_content_count":{"description":"Number of major actions performed on the user","format":"int32","title":"Deleted Content Count","type":"integer","x-stream-index":"003"},"devices":{"items":{"$ref":"#/components/schemas/DeviceResponse"},"type":"array","x-stream-index":"001.006"},"flagged_count":{"description":"Number of flag actions performed on the user","format":"int32","title":"Flagged Count","type":"integer","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001.001.001"},"image":{"type":"string","x-stream-index":"001.001.003"},"invisible":{"type":"boolean","x-stream-index":"001.007"},"language":{"type":"string","x-stream-index":"001.001.005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"001.001.014"},"name":{"type":"string","x-stream-index":"001.001.002"},"online":{"type":"boolean","x-stream-index":"001.001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"001.005"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettingsResponse","x-stream-index":"001.004"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.001.015"},"role":{"type":"string","x-stream-index":"001.001.006"},"shadow_banned":{"type":"boolean","x-stream-index":"001.002"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.001.008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids","shadow_banned","invisible","ban_count","deleted_content_count","flagged_count"],"type":"object"},"ErrorResult":{"properties":{"stacktrace":{"type":"string","x-stream-index":"003"},"type":{"type":"string","x-stream-index":"001"},"version":{"type":"string","x-stream-index":"004"}},"required":["type","description"],"type":"object"},"EventHook":{"nullable":true,"properties":{"callback":{"$ref":"#/components/schemas/AsyncModerationCallbackConfig","x-stream-index":"019.001.002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"020"},"enabled":{"type":"boolean","x-stream-index":"003"},"event_types":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"hook_type":{"type":"string","x-stream-index":"002"},"id":{"type":"string","x-stream-index":"001"},"product":{"type":"string","x-stream-index":"018"},"sns_auth_type":{"type":"string","x-stream-index":"014"},"sns_key":{"type":"string","x-stream-index":"015"},"sns_region":{"type":"string","x-stream-index":"013"},"sns_role_arn":{"type":"string","x-stream-index":"017"},"sns_secret":{"type":"string","x-stream-index":"016"},"sns_topic_arn":{"type":"string","x-stream-index":"012"},"sqs_auth_type":{"type":"string","x-stream-index":"008"},"sqs_key":{"type":"string","x-stream-index":"009"},"sqs_queue_url":{"type":"string","x-stream-index":"006"},"sqs_region":{"type":"string","x-stream-index":"007"},"sqs_role_arn":{"type":"string","x-stream-index":"011"},"sqs_secret":{"type":"string","x-stream-index":"010"},"timeout_ms":{"format":"int32","type":"integer","x-stream-index":"019.001.001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"021"},"webhook_url":{"type":"string","x-stream-index":"005"}},"type":"object"},"EventNotificationSettings":{"properties":{"apns":{"$ref":"#/components/schemas/APNS","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"fcm":{"$ref":"#/components/schemas/FCM","x-stream-index":"003"}},"required":["enabled","apns","fcm"],"type":"object"},"EventRequest":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"parent_id":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"required":["type"],"type":"object"},"EventResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"event":{"$ref":"#/components/schemas/WSEvent","x-stream-index":"001"}},"required":["event","duration"],"title":"Response","type":"object"},"ExportChannelsRequest":{"nullable":true,"properties":{"channels":{"description":"Export options for channels","items":{"$ref":"#/components/schemas/ChannelExport"},"maximum":100,"minimum":1,"title":"Channels","type":"array","x-stream-index":"002.001"},"clear_deleted_message_text":{"description":"Set if deleted message text should be cleared","title":"Clear deleted message text","type":"boolean","x-stream-index":"002.002"},"export_users":{"type":"boolean","x-stream-index":"002.005"},"include_soft_deleted_channels":{"description":"Set if you want to include deleted channels","title":"Include soft deleted channels","type":"boolean","x-stream-index":"002.004"},"include_truncated_messages":{"description":"Set if you want to include truncated messages","title":"Include truncated messages","type":"boolean","x-stream-index":"002.003"},"version":{"description":"Export version","title":"Version","type":"string","x-stream-index":"001"}},"required":["channels"],"type":"object"},"ExportChannelsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"task_id":{"description":"ID of the task to export channels","title":"Task ID","type":"string","x-stream-index":"001"}},"required":["task_id","duration"],"type":"object"},"ExportFeedUserDataRequest":{"description":"Request for exporting feed user data","nullable":true,"type":"object"},"ExportFeedUserDataResponse":{"description":"Response for exporting feed user data","nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"task_id":{"description":"The task ID for the export task","title":"Task ID","type":"string","x-stream-index":"001"}},"required":["task_id","duration"],"type":"object"},"ExportUserResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"004.001"},"messages":{"description":"List of exported messages","items":{"$ref":"#/components/schemas/MessageResponse"},"title":"Messages","type":"array","x-stream-index":"002"},"reactions":{"description":"List of exported reactions","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Reactions","type":"array","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Exported user object","title":"User","x-stream-index":"001"}},"required":["duration"],"type":"object"},"ExportUsersRequest":{"nullable":true,"properties":{"user_ids":{"items":{"type":"string"},"maximum":25,"minimum":1,"type":"array","x-stream-index":"001"}},"required":["user_ids"],"type":"object"},"ExportUsersResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"task_id":{"type":"string","x-stream-index":"001"}},"required":["task_id","duration"],"title":"Response","type":"object"},"ExternalStorage":{"properties":{"abs_account_name":{"type":"string","x-stream-index":"011"},"abs_client_id":{"type":"string","x-stream-index":"013"},"abs_client_secret":{"type":"string","x-stream-index":"014"},"abs_tenant_id":{"type":"string","x-stream-index":"012"},"bucket":{"type":"string","x-stream-index":"005"},"gcs_credentials":{"type":"string","x-stream-index":"010"},"path":{"type":"string","x-stream-index":"006"},"s3_api_key":{"type":"string","x-stream-index":"007"},"s3_custom_endpoint":{"type":"string","x-stream-index":"016"},"s3_region":{"type":"string","x-stream-index":"009"},"s3_secret_key":{"type":"string","x-stream-index":"008"},"storage_name":{"type":"string","x-stream-index":"015"},"storage_type":{"type":"integer","x-stream-index":"004"}},"type":"object"},"ExternalStorageResponse":{"properties":{"bucket":{"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"path":{"type":"string","x-stream-index":"004"},"type":{"enum":["s3","gcs","abs"],"type":"string","x-stream-index":"002"}},"required":["name","type","bucket","path"],"type":"object"},"FCM":{"properties":{"data":{"additionalProperties":{},"type":"object","x-stream-index":"001"}},"type":"object"},"FeedCreatedEvent":{"description":"Emitted when a feed is created.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"003.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.001.007"},"feed":{"$ref":"#/components/schemas/FeedResponse","description":"The feed that was created","title":"Feed","x-stream-index":"001"},"feed_visibility":{"type":"string","x-stream-index":"003.003"},"fid":{"type":"string","x-stream-index":"003.002"},"members":{"items":{"$ref":"#/components/schemas/FeedMemberResponse"},"type":"array","x-stream-index":"002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.001.004"},"type":{"default":"feeds.feed.created","description":"The type of event: \"feeds.feed.created\" in this case","title":"Event Type","type":"string","x-stream-index":"003.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who created the feed","title":"User","x-stream-index":"004.001"}},"required":["feed","members","type","created_at","custom","fid","user"],"title":"FeedCreatedEvent","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"},"FeedDeletedEvent":{"description":"Emitted when a feed is deleted.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.007"},"feed_visibility":{"type":"string","x-stream-index":"001.003"},"fid":{"type":"string","x-stream-index":"001.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"type":{"default":"feeds.feed.deleted","description":"The type of event: \"feeds.feed.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who deleted the feed","title":"User","x-stream-index":"002.001"}},"required":["type","created_at","custom","fid"],"title":"FeedDeletedEvent","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"},"FeedGroup":{"properties":{"ActivityProcessors":{"items":{"$ref":"#/components/schemas/ActivityProcessorConfig"},"type":"array","writeOnly":true,"x-stream-index":"012"},"ActivitySelectors":{"items":{"$ref":"#/components/schemas/ActivitySelectorConfig"},"type":"array","writeOnly":true,"x-stream-index":"013"},"Aggregation":{"$ref":"#/components/schemas/AggregationConfig","x-stream-index":"015"},"AggregationVersion":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"016"},"AppPK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"002"},"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"007"},"DefaultVisibility":{"type":"string","writeOnly":true,"x-stream-index":"006"},"DeletedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"010"},"ID":{"type":"string","writeOnly":true,"x-stream-index":"003"},"LastFeedGetAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"017"},"Notification":{"$ref":"#/components/schemas/NotificationConfig","x-stream-index":"004"},"PushNotification":{"$ref":"#/components/schemas/PushNotificationConfig","x-stream-index":"005"},"Ranking":{"$ref":"#/components/schemas/RankingConfig","x-stream-index":"014"},"Stories":{"$ref":"#/components/schemas/StoriesConfig","x-stream-index":"011"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"}},"required":["AppPK","ID","DefaultVisibility","Custom","created_at","updated_at","ActivityProcessors","ActivitySelectors","AggregationVersion"],"type":"object"},"FeedGroupChangedEvent":{"description":"Emitted when a feed group is changed.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.007"},"feed_group":{"$ref":"#/components/schemas/FeedGroup","description":"The feed group that was changed","title":"Feed Type","x-stream-index":"003"},"feed_visibility":{"type":"string","x-stream-index":"001.003"},"fid":{"type":"string","x-stream-index":"001.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"type":{"default":"feeds.feed_group.changed","description":"The type of event: \"feeds.feed_group.changed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who changed the feed group","title":"User","x-stream-index":"002.001"}},"required":["type","created_at","custom","fid"],"title":"FeedGroupChangedEvent","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"},"FeedGroupDeletedEvent":{"description":"Emitted when a feed group is deleted.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"type":"string","x-stream-index":"002.002"},"group_id":{"description":"The ID of the feed group that was deleted","title":"Group ID","type":"string","x-stream-index":"001"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.feed_group.deleted","description":"The type of event: \"feeds.feed_group.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"}},"required":["group_id","type","created_at","custom","fid"],"title":"FeedGroupDeletedEvent","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"},"FeedGroupResponse":{"properties":{"activity_processors":{"description":"Configuration for activity processors","items":{"$ref":"#/components/schemas/ActivityProcessorConfig"},"title":"Activity Processors","type":"array","x-stream-index":"009"},"activity_selectors":{"description":"Configuration for activity selectors","items":{"$ref":"#/components/schemas/ActivitySelectorConfig"},"title":"Activity Selectors","type":"array","x-stream-index":"010"},"aggregation":{"$ref":"#/components/schemas/AggregationConfig","description":"Configuration for activity aggregation","title":"Aggregation","x-stream-index":"012"},"created_at":{"description":"When the feed group was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"006"},"custom":{"additionalProperties":{},"description":"Custom data for the feed group","title":"Custom Data","type":"object","x-stream-index":"005"},"default_visibility":{"description":"Default visibility for activities","title":"Default Visibility","type":"string","x-stream-index":"004"},"id":{"description":"Identifier within the group","title":"Feed Group ID","type":"string","x-stream-index":"001"},"notification":{"$ref":"#/components/schemas/NotificationConfig","description":"Configuration for notifications","title":"Notification","x-stream-index":"002"},"push_notification":{"$ref":"#/components/schemas/PushNotificationConfig","x-stream-index":"003"},"ranking":{"$ref":"#/components/schemas/RankingConfig","description":"Configuration for activity ranking","title":"Ranking","x-stream-index":"011"},"stories":{"$ref":"#/components/schemas/StoriesConfig","description":"Configuration for stories feature","title":"Stories","x-stream-index":"008"},"updated_at":{"description":"When the feed group was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"007"}},"required":["id","created_at","updated_at"],"title":"Feed Group","type":"object"},"FeedInput":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"description":{"maxLength":1000,"type":"string","x-stream-index":"002"},"filter_tags":{"items":{"type":"string"},"maximum":255,"type":"array","x-stream-index":"005"},"members":{"items":{"$ref":"#/components/schemas/FeedMemberRequest"},"type":"array","x-stream-index":"006"},"name":{"maxLength":255,"type":"string","x-stream-index":"001"},"visibility":{"enum":["public","visible","followers","members","private"],"type":"string","x-stream-index":"003"}},"type":"object"},"FeedMemberAddedEvent":{"description":"Emitted when a feed member is added.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"003.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.001.007"},"feed_visibility":{"type":"string","x-stream-index":"003.003"},"fid":{"type":"string","x-stream-index":"003.002"},"member":{"$ref":"#/components/schemas/FeedMemberResponse","description":"The member that was added","title":"Member","x-stream-index":"001"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.001.004"},"type":{"default":"feeds.feed_member.added","description":"The type of event: \"feeds.feed_member.added\" in this case","title":"Event Type","type":"string","x-stream-index":"003.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who added the member","title":"User","x-stream-index":"002.001"}},"required":["member","type","created_at","custom","fid"],"title":"FeedMemberAddedEvent","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"},"FeedMemberRemovedEvent":{"description":"Emitted when a feed member is removed.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"003.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.001.007"},"feed_visibility":{"type":"string","x-stream-index":"003.003"},"fid":{"type":"string","x-stream-index":"003.002"},"member_id":{"type":"string","x-stream-index":"001"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.001.004"},"type":{"default":"feeds.feed_member.removed","description":"The type of event: \"feeds.feed_member.removed\" in this case","title":"Event Type","type":"string","x-stream-index":"003.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who removed the member","title":"User","x-stream-index":"002.001"}},"required":["member_id","type","created_at","custom","fid"],"title":"FeedMemberRemovedEvent","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"},"FeedMemberRequest":{"properties":{"custom":{"additionalProperties":{},"description":"Custom data for the member","title":"Custom Data","type":"object","x-stream-index":"004"},"invite":{"description":"Whether this is an invite to become a member","title":"Invite","type":"boolean","x-stream-index":"005"},"membership_level":{"description":"ID of the membership level to assign to the member","maxLength":255,"title":"Membership Level","type":"string","x-stream-index":"003"},"role":{"description":"Role of the member in the feed","maxLength":255,"title":"Role","type":"string","x-stream-index":"002"},"user_id":{"description":"ID of the user to add as a member","maxLength":255,"title":"User ID","type":"string","x-stream-index":"001"}},"required":["user_id"],"title":"Feed Member Payload","type":"object"},"FeedMemberResponse":{"properties":{"created_at":{"description":"When the membership was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"description":"Custom data for the membership","title":"Custom Data","type":"object","x-stream-index":"007"},"invite_accepted_at":{"description":"When the invite was accepted","format":"date-time","title":"Invite Accepted At","type":"number","x-stream-index":"005"},"invite_rejected_at":{"description":"When the invite was rejected","format":"date-time","title":"Invite Rejected At","type":"number","x-stream-index":"006"},"membership_level":{"$ref":"#/components/schemas/MembershipLevelResponse","description":"Membership level assigned to the member","title":"Membership Level","x-stream-index":"004"},"role":{"description":"Role of the member in the feed","title":"Role","type":"string","x-stream-index":"002"},"status":{"description":"Status of the membership","enum":["member","pending","rejected"],"title":"Status","type":"string","x-stream-index":"003"},"updated_at":{"description":"When the membership was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who is a member","title":"User","x-stream-index":"001"}},"required":["user","role","status","created_at","updated_at"],"title":"Feed Member","type":"object"},"FeedMemberUpdatedEvent":{"description":"Emitted when a feed member is updated.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"003.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.001.007"},"feed_visibility":{"type":"string","x-stream-index":"003.003"},"fid":{"type":"string","x-stream-index":"003.002"},"member":{"$ref":"#/components/schemas/FeedMemberResponse","description":"The member that was updated","title":"Member","x-stream-index":"001"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.001.004"},"type":{"default":"feeds.feed_member.updated","description":"The type of event: \"feeds.feed_member.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"003.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who updated the member","title":"User","x-stream-index":"002.001"}},"required":["member","type","created_at","custom","fid"],"title":"FeedMemberUpdatedEvent","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"},"FeedOwnCapability":{"description":"All possibility of string to use","enum":["add-activity","add-activity-reaction","add-comment","add-comment-reaction","bookmark-activity","create-feed","delete-bookmark","delete-comment","delete-feed","edit-bookmark","follow","invite-feed","join-feed","leave-feed","manage-feed-group","mark-activity","pin-activity","query-feed-members","query-follows","read-activities","read-feed","remove-activity","remove-activity-reaction","remove-comment-reaction","unfollow","update-activity","update-comment","update-feed","update-feed-followers","update-feed-members"],"title":"FeedOwnCapability","type":"string"},"FeedRequest":{"properties":{"created_by_id":{"description":"ID of the feed creator","title":"Created By ID","type":"string","x-stream-index":"003"},"custom":{"additionalProperties":{},"description":"Custom data for the feed","title":"Custom Data","type":"object","x-stream-index":"004.004"},"description":{"description":"Description of the feed","maxLength":1000,"title":"Description","type":"string","x-stream-index":"004.002"},"feed_group_id":{"description":"ID of the feed group","maxLength":255,"title":"Feed Group ID","type":"string","x-stream-index":"001"},"feed_id":{"description":"ID of the feed","maxLength":255,"title":"Feed ID","type":"string","x-stream-index":"002"},"filter_tags":{"description":"Tags used for filtering feeds","items":{"type":"string"},"maximum":255,"title":"Filter Tags","type":"array","x-stream-index":"004.005"},"members":{"description":"Initial members for the feed","items":{"$ref":"#/components/schemas/FeedMemberRequest"},"title":"Members","type":"array","x-stream-index":"004.006"},"name":{"description":"Name of the feed","maxLength":255,"title":"Name","type":"string","x-stream-index":"004.001"},"visibility":{"description":"Visibility setting for the feed","enum":["public","visible","followers","members","private"],"title":"Visibility","type":"string","x-stream-index":"004.003"}},"required":["feed_group_id","feed_id"],"title":"Feed Payload","type":"object"},"FeedResponse":{"properties":{"created_at":{"description":"When the feed was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"015"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"User who created the feed","title":"Created By","x-stream-index":"009"},"custom":{"additionalProperties":{},"description":"Custom data for the feed","title":"Custom Data","type":"object","x-stream-index":"006"},"deleted_at":{"description":"When the feed was deleted","format":"date-time","title":"Deleted At","type":"number","x-stream-index":"017"},"description":{"description":"Description of the feed","title":"Description","type":"string","x-stream-index":"005"},"feed":{"description":"Fully qualified feed ID (group_id:id)","title":"FID","type":"string","x-stream-index":"003"},"filter_tags":{"description":"Tags used for filtering feeds","items":{"type":"string"},"title":"Filter Tags","type":"array","x-stream-index":"007"},"follower_count":{"description":"Number of followers of this feed","format":"int32","title":"Follower Count","type":"integer","x-stream-index":"011"},"following_count":{"description":"Number of feeds this feed follows","format":"int32","title":"Following Count","type":"integer","x-stream-index":"012"},"group_id":{"description":"Group this feed belongs to","title":"Group ID","type":"string","x-stream-index":"001"},"id":{"description":"Unique identifier for the feed","title":"ID","type":"string","x-stream-index":"002"},"member_count":{"description":"Number of members in this feed","format":"int32","title":"Member Count","type":"integer","x-stream-index":"010"},"name":{"description":"Name of the feed","title":"Name","type":"string","x-stream-index":"004"},"own_follows":{"description":"Follow relationships where the current user's feeds are following this feed","items":{"$ref":"#/components/schemas/FollowResponse"},"title":"Own Follows","type":"array","x-stream-index":"014"},"pin_count":{"description":"Number of pinned activities in this feed","format":"int32","title":"Pin Count","type":"integer","x-stream-index":"013"},"updated_at":{"description":"When the feed was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"016"},"visibility":{"description":"Visibility setting for the feed","title":"Visibility","type":"string","x-stream-index":"008"}},"required":["group_id","id","feed","name","description","created_by","member_count","follower_count","following_count","pin_count","created_at","updated_at"],"title":"Feed","type":"object"},"FeedUpdatedEvent":{"description":"Emitted when a feed is created.","nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed":{"$ref":"#/components/schemas/FeedResponse","description":"The feed that was created","title":"Feed","x-stream-index":"001"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"type":"string","x-stream-index":"002.002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.feed.updated","description":"The type of event: \"feeds.feed.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who created the feed","title":"User","x-stream-index":"003.001"}},"required":["feed","type","created_at","custom","fid"],"title":"FeedUpdatedEvent","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"},"FeedViewResponse":{"properties":{"activity_processors":{"description":"Configured activity processors","items":{"$ref":"#/components/schemas/ActivityProcessorConfig"},"title":"Activity Processors","type":"array","x-stream-index":"003"},"activity_selectors":{"description":"Configured activity selectors","items":{"$ref":"#/components/schemas/ActivitySelectorConfig"},"title":"Activity Selectors","type":"array","x-stream-index":"002"},"aggregation":{"$ref":"#/components/schemas/AggregationConfig","description":"Configuration for activity aggregation","title":"Aggregation","x-stream-index":"005"},"id":{"description":"Unique identifier for the custom feed view","title":"View ID","type":"string","x-stream-index":"001"},"last_used_at":{"description":"When the feed view was last used","format":"date-time","title":"Last Used At","type":"number","x-stream-index":"006"},"ranking":{"$ref":"#/components/schemas/RankingConfig","description":"Configuration for activity ranking","title":"Ranking","x-stream-index":"004"}},"required":["id"],"title":"Feed View","type":"object"},"FeedsEventPreferences":{"properties":{"comments":{"type":"string","x-stream-index":"002"},"mentions":{"type":"string","x-stream-index":"004"},"new_followers":{"type":"string","x-stream-index":"003"},"reactions":{"type":"string","x-stream-index":"001"}},"type":"object"},"FeedsEventPreferencesInput":{"properties":{"comments":{"enum":["all","none"],"type":"string","x-stream-index":"002"},"mentions":{"enum":["all","none"],"type":"string","x-stream-index":"004"},"new_followers":{"enum":["all","none"],"type":"string","x-stream-index":"003"},"reactions":{"enum":["all","none"],"type":"string","x-stream-index":"001"}},"type":"object"},"FeedsModerationTemplateConfig":{"properties":{"config_key":{"type":"string","x-stream-index":"002"},"data_types":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001"}},"required":["data_types","config_key"],"type":"object"},"FeedsReactionResponse":{"properties":{"activity_id":{"description":"ID of the activity that was reacted to","title":"Activity ID","type":"string","x-stream-index":"002"},"comment_id":{"description":"ID of the comment that was reacted to","title":"Comment ID","type":"string","x-stream-index":"003"},"created_at":{"description":"When the reaction was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"006"},"custom":{"additionalProperties":{},"description":"Custom data for the reaction","title":"Custom Data","type":"object","x-stream-index":"005"},"type":{"description":"Type of reaction","title":"Type","type":"string","x-stream-index":"004"},"updated_at":{"description":"When the reaction was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"007"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who created the reaction","title":"User","x-stream-index":"001"}},"required":["user","activity_id","type","created_at","updated_at"],"title":"Activity Reaction","type":"object"},"Field":{"nullable":true,"properties":{"short":{"type":"boolean","x-stream-index":"003"},"title":{"type":"string","x-stream-index":"001"},"value":{"type":"string","x-stream-index":"002"}},"required":["title","value","short"],"type":"object"},"FileUploadConfig":{"properties":{"allowed_file_extensions":{"items":{"type":"string"},"type":"array","x-stream-index":"001"},"allowed_mime_types":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"blocked_file_extensions":{"items":{"type":"string"},"type":"array","x-stream-index":"002"},"blocked_mime_types":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"size_limit":{"format":"int32","maximum":104857600,"minimum":0,"type":"integer","x-stream-index":"005"}},"required":["size_limit"],"type":"object"},"FileUploadRequest":{"nullable":true,"properties":{"file":{"description":"file field","title":"File","type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/OnlyUserID","description":"user for the request **server side only**","title":"User","x-stream-index":"002"}},"type":"object"},"FileUploadResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"file":{"description":"URL to the uploaded asset. Should be used to put to `asset_url` attachment field","title":"File","type":"string","x-stream-index":"001"},"thumb_url":{"description":"URL of the file thumbnail for supported file formats. Should be put to `thumb_url` attachment field","title":"Thumbnail URL","type":"string","x-stream-index":"002"}},"required":["duration"],"type":"object"},"FirebaseConfig":{"properties":{"Disabled":{"type":"boolean","writeOnly":true,"x-stream-index":"001"},"apn_template":{"type":"string","x-stream-index":"005"},"credentials_json":{"type":"string","x-stream-index":"006"},"data_template":{"type":"string","x-stream-index":"004"},"notification_template":{"type":"string","x-stream-index":"003"},"server_key":{"type":"string","x-stream-index":"002"}},"type":"object"},"FirebaseConfigFields":{"properties":{"apn_template":{"type":"string","x-stream-index":"004"},"credentials_json":{"type":"string","x-stream-index":"006"},"data_template":{"type":"string","x-stream-index":"003"},"enabled":{"type":"boolean","x-stream-index":"001"},"notification_template":{"type":"string","x-stream-index":"002"},"server_key":{"type":"string","x-stream-index":"005"}},"required":["enabled"],"type":"object"},"Flag":{"description":"Contains information about flagged user or message","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"019"},"custom":{"additionalProperties":{},"description":"Additional metadata about the flag","title":"Custom","type":"object","x-stream-index":"014"},"entity_creator_id":{"description":"ID of the user who created the flagged entity","title":"Entity Creator ID","type":"string","x-stream-index":"009"},"entity_id":{"description":"Unique identifier of the entity being flagged","title":"Entity ID","type":"string","x-stream-index":"008"},"entity_type":{"description":"Type of entity being flagged (e.g., message, user)","title":"Entity Type","type":"string","x-stream-index":"007"},"is_streamed_content":{"type":"boolean","x-stream-index":"012"},"labels":{"description":"Labels from bodyguard, API calls, our own AI etc","items":{"type":"string"},"title":"Labels","type":"array","x-stream-index":"015"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content being flagged","title":"Moderation Payload","x-stream-index":"010"},"moderation_payload_hash":{"type":"string","x-stream-index":"011"},"reason":{"description":"Optional explanation for why the content is being flagged","title":"Reason","type":"string","x-stream-index":"013"},"result":{"description":"Result of bodyguard, API calls, our own AI etc","items":{"additionalProperties":{},"type":"object"},"title":"Result","type":"array","x-stream-index":"016"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"018"},"review_queue_item_id":{"description":"ID of the review queue item","title":"Review Queue Item ID","type":"string","x-stream-index":"017"},"type":{"type":"string","x-stream-index":"004"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"020"},"user":{"$ref":"#/components/schemas/User","description":"User who flagged a message or a user","title":"User","x-stream-index":"006"}},"required":["entity_type","entity_id","result","created_at","updated_at"],"title":"Flag","type":"object"},"FlagContentOptions":{"properties":{"reason":{"type":"string","x-stream-index":"001"}},"type":"object"},"FlagDetails":{"properties":{"Extra":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"002"},"automod":{"$ref":"#/components/schemas/AutomodDetails","x-stream-index":"001"},"original_text":{"type":"string","x-stream-index":"003"}},"required":["Extra","original_text"],"type":"object"},"FlagFeedback":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"005"},"labels":{"items":{"$ref":"#/components/schemas/Label"},"type":"array","x-stream-index":"006"},"message_id":{"type":"string","x-stream-index":"004"}},"required":["message_id","created_at","labels"],"type":"object"},"FlagMessageDetails":{"properties":{"pin_changed":{"type":"boolean","x-stream-index":"002"},"should_enrich":{"type":"boolean","x-stream-index":"003"},"skip_push":{"type":"boolean","x-stream-index":"004"},"updated_by_id":{"type":"string","x-stream-index":"001"}},"type":"object"},"FlagRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"description":"Additional metadata about the flag","title":"Custom","type":"object","x-stream-index":"006"},"entity_creator_id":{"description":"ID of the user who created the flagged entity","title":"Entity Creator ID","type":"string","x-stream-index":"003"},"entity_id":{"description":"Unique identifier of the entity being flagged","title":"Entity ID","type":"string","x-stream-index":"002"},"entity_type":{"description":"Type of entity being flagged (e.g., message, user)","title":"Entity Type","type":"string","x-stream-index":"001"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content being flagged","title":"Moderation Payload","x-stream-index":"005"},"reason":{"description":"Optional explanation for why the content is being flagged","maxLength":255,"title":"Reason","type":"string","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"007.002"},"user_id":{"type":"string","x-stream-index":"007.001"}},"required":["entity_type","entity_id"],"type":"object"},"FlagResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"item_id":{"description":"Unique identifier of the created moderation item","title":"Item ID","type":"string","x-stream-index":"001"}},"required":["item_id","duration"],"type":"object"},"FlagUpdatedEvent":{"nullable":true,"properties":{"CreatedBy":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"004"},"Message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"002"},"User":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"type":{"default":"flag.updated","type":"string","x-stream-index":"001.002"}},"required":["type","created_at","custom"],"title":"FlagUpdatedEvent","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"},"FlagUserOptions":{"properties":{"reason":{"type":"string","x-stream-index":"001"}},"type":"object"},"FollowBatchRequest":{"nullable":true,"properties":{"follows":{"description":"List of follow relationships to create","items":{"$ref":"#/components/schemas/FollowRequest"},"maximum":1000,"minimum":1,"title":"Follows","type":"array","x-stream-index":"001"}},"required":["follows"],"title":"Follow Batch Request","type":"object"},"FollowBatchResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"follows":{"description":"List of created follow relationships","items":{"$ref":"#/components/schemas/FollowResponse"},"title":"Follows","type":"array","x-stream-index":"001"}},"required":["follows","duration"],"title":"Follow Batch Response","type":"object"},"FollowCreatedEvent":{"description":"Emitted when a feed follows another feed.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"type":"string","x-stream-index":"002.002"},"follow":{"$ref":"#/components/schemas/FollowResponse","x-stream-index":"001"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.follow.created","description":"The type of event: \"feeds.follow.created\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"}},"required":["follow","type","created_at","custom","fid"],"title":"FollowCreatedEvent","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"},"FollowDeletedEvent":{"description":"Emitted when a feed unfollows another feed.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"type":"string","x-stream-index":"002.002"},"follow":{"$ref":"#/components/schemas/FollowResponse","x-stream-index":"001"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.follow.deleted","description":"The type of event: \"feeds.follow.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"}},"required":["follow","type","created_at","custom","fid"],"title":"FollowDeletedEvent","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"},"FollowPair":{"properties":{"source":{"description":"Fully qualified ID of the source feed","maxLength":255,"title":"Source Feed","type":"string","x-stream-index":"001"},"target":{"description":"Fully qualified ID of the target feed","maxLength":255,"title":"Target Feed","type":"string","x-stream-index":"002"}},"required":["source","target"],"title":"FollowPair","type":"object"},"FollowRequest":{"nullable":true,"properties":{"create_notification_activity":{"description":"Whether to create a notification activity for this follow","title":"Create Notification Activity","type":"boolean","x-stream-index":"004"},"custom":{"additionalProperties":{},"description":"Custom data for the follow relationship","title":"Custom Data","type":"object","x-stream-index":"002"},"push_preference":{"description":"Push preference for the follow relationship","enum":["all","none"],"title":"Push Preference","type":"string","x-stream-index":"003"},"skip_push":{"type":"boolean","x-stream-index":"005"},"source":{"description":"Fully qualified ID of the source feed","maxLength":255,"title":"Source Feed","type":"string","x-stream-index":"001.001"},"target":{"description":"Fully qualified ID of the target feed","maxLength":255,"title":"Target Feed","type":"string","x-stream-index":"001.002"}},"required":["source","target"],"title":"Follow Request","type":"object"},"FollowResponse":{"properties":{"created_at":{"description":"When the follow relationship was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"009"},"custom":{"additionalProperties":{},"description":"Custom data for the follow relationship","title":"Custom Data","type":"object","x-stream-index":"004"},"follower_role":{"description":"Role of the follower (source user) in the follow relationship","title":"Follower Role","type":"string","x-stream-index":"008"},"push_preference":{"description":"Push preference for notifications","enum":["all","none"],"title":"Push Preference","type":"string","x-stream-index":"003"},"request_accepted_at":{"description":"When the follow request was accepted","format":"date-time","title":"Request Accepted At","type":"number","x-stream-index":"005"},"request_rejected_at":{"description":"When the follow request was rejected","format":"date-time","title":"Request Rejected At","type":"number","x-stream-index":"006"},"source_feed":{"$ref":"#/components/schemas/FeedResponse","description":"Source feed object","title":"Source Feed","x-stream-index":"001"},"status":{"description":"Status of the follow relationship","enum":["accepted","pending","rejected"],"title":"Status","type":"string","x-stream-index":"007"},"target_feed":{"$ref":"#/components/schemas/FeedResponse","description":"Target feed object","title":"Target Feed","x-stream-index":"002"},"updated_at":{"description":"When the follow relationship was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"010"}},"required":["source_feed","target_feed","push_preference","status","follower_role","created_at","updated_at"],"title":"Follow","type":"object"},"FollowUpdatedEvent":{"description":"Emitted when a follow relationship is updated.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"002.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002.001.007"},"feed_visibility":{"type":"string","x-stream-index":"002.003"},"fid":{"type":"string","x-stream-index":"002.002"},"follow":{"$ref":"#/components/schemas/FollowResponse","x-stream-index":"001"},"received_at":{"format":"date-time","type":"number","x-stream-index":"002.001.004"},"type":{"default":"feeds.follow.updated","description":"The type of event: \"feeds.follow.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001.002"}},"required":["follow","type","created_at","custom","fid"],"title":"FollowUpdatedEvent","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"},"FrameRecordSettings":{"properties":{"capture_interval_in_seconds":{"format":"int32","maximum":60,"minimum":2,"type":"integer","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"},"quality":{"type":"string","x-stream-index":"002"}},"required":["mode","capture_interval_in_seconds"],"type":"object"},"FrameRecordingEgressConfig":{"properties":{"capture_interval_in_seconds":{"format":"int32","type":"integer","x-stream-index":"007"},"external_storage":{"$ref":"#/components/schemas/ExternalStorage","x-stream-index":"006"},"quality":{"$ref":"#/components/schemas/Quality","x-stream-index":"004"},"storage_name":{"type":"string","x-stream-index":"005"}},"type":"object"},"FrameRecordingResponse":{"properties":{"status":{"type":"string","x-stream-index":"001"}},"required":["status"],"type":"object"},"FrameRecordingSettingsRequest":{"properties":{"capture_interval_in_seconds":{"format":"int32","maximum":60,"minimum":2,"type":"integer","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"},"quality":{"enum":["360p","480p","720p","1080p","1440p"],"type":"string","x-stream-index":"002"}},"required":["mode","capture_interval_in_seconds"],"type":"object"},"FrameRecordingSettingsResponse":{"properties":{"capture_interval_in_seconds":{"format":"int32","maximum":60,"minimum":2,"type":"integer","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"},"quality":{"type":"string","x-stream-index":"002"}},"required":["mode","capture_interval_in_seconds"],"type":"object"},"FullUserResponse":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"015"},"banned":{"type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"014"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.011"},"devices":{"items":{"$ref":"#/components/schemas/DeviceResponse"},"type":"array","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001.001"},"image":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"005"},"language":{"type":"string","x-stream-index":"001.005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"001.014"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"012"},"mutes":{"items":{"$ref":"#/components/schemas/UserMuteResponse"},"type":"array","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"001.002"},"online":{"type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"003"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.015"},"role":{"type":"string","x-stream-index":"001.006"},"shadow_banned":{"type":"boolean","x-stream-index":"013"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"009"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"010"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"008"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"011"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","devices","invisible","mutes","channel_mutes","unread_count","total_unread_count","unread_channels","unread_threads","shadow_banned","blocked_user_ids"],"type":"object"},"GeofenceResponse":{"nullable":true,"properties":{"country_codes":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"description":{"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"type":{"type":"string","x-stream-index":"002"}},"required":["name"],"type":"object"},"GeofenceSettings":{"properties":{"names":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"required":["names"],"type":"object"},"GeofenceSettingsRequest":{"properties":{"names":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"type":"object"},"GeofenceSettingsResponse":{"properties":{"names":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"required":["names"],"type":"object"},"GetActiveCallsStatusResponse":{"description":"Response containing active calls status information","nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"},"end_time":{"description":"End time of the status period","format":"date-time","title":"time.Time","type":"number","x-stream-index":"003"},"metrics":{"$ref":"#/components/schemas/ActiveCallsMetrics","description":"Detailed metrics","title":"*ActiveCallsMetrics","x-stream-index":"005"},"start_time":{"description":"Start time of the status period","format":"date-time","title":"time.Time","type":"number","x-stream-index":"002"},"summary":{"$ref":"#/components/schemas/ActiveCallsSummary","description":"Summary of active calls","title":"*ActiveCallsSummary","x-stream-index":"004"}},"required":["duration","start_time","end_time"],"title":"GetActiveCallsStatusResponse","type":"object"},"GetActivityResponse":{"nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","description":"The requested activity","title":"Activity","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["activity","duration"],"title":"Get Activity Response","type":"object"},"GetApplicationResponse":{"description":"Basic response information","nullable":true,"properties":{"app":{"$ref":"#/components/schemas/AppResponseFields","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["app","duration"],"title":"Response","type":"object"},"GetBlockListResponse":{"description":"Response for get block list","nullable":true,"properties":{"blocklist":{"$ref":"#/components/schemas/BlockListResponse","description":"Block list object","title":"BlockListResponse","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["duration"],"title":"GetBlockListResponse","type":"object","x-stream-docs-page-id":"get_block_list"},"GetBlockedUsersResponse":{"nullable":true,"properties":{"blocks":{"description":"Array of blocked user object","items":{"$ref":"#/components/schemas/BlockedUserResponse"},"title":"Blocks","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["blocks","duration"],"type":"object"},"GetCallReportResponse":{"description":"Basic response information","nullable":true,"properties":{"chat_activity":{"$ref":"#/components/schemas/ChatActivityStatsResponse","x-stream-index":"004"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"report":{"$ref":"#/components/schemas/ReportResponse","x-stream-index":"003"},"session_id":{"type":"string","x-stream-index":"002"},"video_reactions":{"items":{"$ref":"#/components/schemas/VideoReactionsResponse"},"type":"array","x-stream-index":"005"}},"required":["duration","session_id","report"],"title":"Response","type":"object"},"GetCallResponse":{"nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001.001"},"duration":{"type":"string","x-stream-index":"002.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001.002"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"001.004"}},"required":["call","members","own_capabilities","blocked_users","duration"],"title":"GetCallResponse","type":"object"},"GetCallTypeResponse":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.005"},"duration":{"type":"string","x-stream-index":"002.001"},"external_storage":{"type":"string","x-stream-index":"001.007"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"001.002"},"name":{"type":"string","x-stream-index":"001.001"},"notification_settings":{"$ref":"#/components/schemas/NotificationSettings","x-stream-index":"001.004"},"settings":{"$ref":"#/components/schemas/CallSettingsResponse","x-stream-index":"001.003"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.006"}},"required":["name","grants","settings","notification_settings","created_at","updated_at","duration"],"title":"GetCallTypeResponse","type":"object"},"GetCampaignResponse":{"description":"Basic response information","nullable":true,"properties":{"campaign":{"$ref":"#/components/schemas/CampaignResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"users":{"$ref":"#/components/schemas/PagerResponse","x-stream-index":"002"}},"required":["duration"],"title":"Response","type":"object"},"GetChannelTypeResponse":{"description":"Basic response information","nullable":true,"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"003.002.027"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"003.002.022"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.002.023"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"003.002.028"},"blocklist":{"type":"string","x-stream-index":"003.002.024"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.002.025"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"003.002.026"},"commands":{"items":{"$ref":"#/components/schemas/Command"},"type":"array","x-stream-index":"003.003"},"connect_events":{"type":"boolean","x-stream-index":"003.002.004"},"count_messages":{"type":"boolean","x-stream-index":"003.002.019"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.001.003"},"custom_events":{"type":"boolean","x-stream-index":"003.002.012"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"004.001"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"002"},"mark_messages_pending":{"type":"boolean","x-stream-index":"003.002.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"003.002.021"},"mutes":{"type":"boolean","x-stream-index":"003.002.009"},"name":{"type":"string","x-stream-index":"003.002.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"003.002.029"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"003.002.030"},"permissions":{"items":{"$ref":"#/components/schemas/PolicyRequest"},"type":"array","x-stream-index":"001"},"polls":{"type":"boolean","x-stream-index":"003.002.016"},"push_notifications":{"type":"boolean","x-stream-index":"003.002.013"},"quotes":{"type":"boolean","x-stream-index":"003.002.008"},"reactions":{"type":"boolean","x-stream-index":"003.002.006"},"read_events":{"type":"boolean","x-stream-index":"003.002.003"},"reminders":{"type":"boolean","x-stream-index":"003.002.014"},"replies":{"type":"boolean","x-stream-index":"003.002.007"},"search":{"type":"boolean","x-stream-index":"003.002.005"},"shared_locations":{"type":"boolean","x-stream-index":"003.002.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"003.002.031"},"typing_events":{"type":"boolean","x-stream-index":"003.002.002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"003.001.004"},"uploads":{"type":"boolean","x-stream-index":"003.002.010"},"url_enrichment":{"type":"boolean","x-stream-index":"003.002.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"003.002.017"}},"required":["permissions","grants","created_at","updated_at","name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","count_messages","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","commands","duration"],"title":"Response","type":"object"},"GetCommandResponse":{"nullable":true,"properties":{"args":{"type":"string","x-stream-index":"001.006"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.001"},"description":{"type":"string","x-stream-index":"001.005"},"duration":{"type":"string","x-stream-index":"002.001"},"name":{"type":"string","x-stream-index":"001.004"},"set":{"type":"string","x-stream-index":"001.007"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"001.002"}},"required":["name","description","args","set","duration"],"title":"GetCommandResponse","type":"object"},"GetCommentRepliesResponse":{"nullable":true,"properties":{"comments":{"description":"Threaded listing of replies to the comment","items":{"$ref":"#/components/schemas/ThreadedCommentResponse"},"title":"Comments","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["comments","duration"],"title":"Get Comment Replies Response","type":"object"},"GetCommentResponse":{"nullable":true,"properties":{"comment":{"$ref":"#/components/schemas/CommentResponse","description":"Comment","title":"Comment","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["comment","duration"],"title":"Get Comment Response","type":"object"},"GetCommentsResponse":{"nullable":true,"properties":{"comments":{"description":"Threaded listing for the activity","items":{"$ref":"#/components/schemas/ThreadedCommentResponse"},"title":"Comments","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["comments","duration"],"title":"Get Comments Response","type":"object"},"GetConfigResponse":{"nullable":true,"properties":{"config":{"$ref":"#/components/schemas/ConfigResponse","description":"The retrieved moderation configuration","title":"Config","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["duration"],"type":"object"},"GetCustomPermissionResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"permission":{"$ref":"#/components/schemas/Permission","x-stream-index":"001"}},"required":["permission","duration"],"title":"Response","type":"object"},"GetDraftResponse":{"description":"Basic response information","nullable":true,"properties":{"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["draft","duration"],"title":"Response","type":"object"},"GetEdgesResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"edges":{"items":{"$ref":"#/components/schemas/EdgeResponse"},"type":"array","x-stream-index":"001"}},"required":["edges","duration"],"title":"Response","type":"object"},"GetFeedGroupResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"feed_group":{"$ref":"#/components/schemas/FeedGroupResponse","description":"The requested feed group","title":"Feed Group","x-stream-index":"001"}},"required":["feed_group","duration"],"title":"Get Feed Group Response","type":"object"},"GetFeedViewResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"feed_view":{"$ref":"#/components/schemas/FeedViewResponse","description":"The requested feed view","title":"Feed View","x-stream-index":"001"}},"required":["feed_view","duration"],"title":"Get Feed View Response","type":"object"},"GetFollowSuggestionsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"suggestions":{"description":"List of suggested feeds to follow","items":{"$ref":"#/components/schemas/FeedResponse"},"title":"Suggestions","type":"array","x-stream-index":"001"}},"required":["suggestions","duration"],"title":"Follow Suggestions Response","type":"object"},"GetImportResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"import_task":{"$ref":"#/components/schemas/ImportTask","x-stream-index":"001"}},"required":["duration"],"title":"Response","type":"object"},"GetManyMessagesResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.002.001"},"messages":{"description":"List of messages","items":{"$ref":"#/components/schemas/MessageResponse"},"title":"Messages","type":"array","x-stream-index":"001.001"}},"required":["messages","duration"],"type":"object"},"GetMessageResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageWithChannelResponse","x-stream-index":"001"},"pending_message_metadata":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"002"}},"required":["message","duration"],"title":"Response","type":"object"},"GetModerationRuleResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"rule":{"$ref":"#/components/schemas/ModerationRuleV2Response","x-stream-index":"002"}},"required":["duration"],"title":"Response","type":"object"},"GetOGResponse":{"nullable":true,"properties":{"actions":{"items":{"$ref":"#/components/schemas/Action"},"type":"array","x-stream-index":"001.015"},"asset_url":{"description":"URL of detected video or audio","title":"Image URL","type":"string","x-stream-index":"001.017"},"author_icon":{"type":"string","x-stream-index":"001.007"},"author_link":{"description":"og:site","title":"Author Link","type":"string","x-stream-index":"001.006"},"author_name":{"description":"og:site_name","title":"Author Name","type":"string","x-stream-index":"001.005"},"color":{"type":"string","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.018"},"duration":{"type":"string","x-stream-index":"002.001"},"fallback":{"type":"string","x-stream-index":"001.002"},"fields":{"items":{"$ref":"#/components/schemas/Field"},"type":"array","x-stream-index":"001.016"},"footer":{"type":"string","x-stream-index":"001.013"},"footer_icon":{"type":"string","x-stream-index":"001.014"},"giphy":{"$ref":"#/components/schemas/Images","x-stream-index":"001.019"},"image_url":{"description":"URL of detected image","title":"Image URL","type":"string","x-stream-index":"001.011"},"og_scrape_url":{"description":"extracted url from the text","title":"OG Scrape URL","type":"string","x-stream-index":"001.020"},"original_height":{"format":"int32","type":"integer","x-stream-index":"001.022"},"original_width":{"format":"int32","type":"integer","x-stream-index":"001.021"},"pretext":{"type":"string","x-stream-index":"001.004"},"text":{"description":"og:description","title":"Text","type":"string","x-stream-index":"001.010"},"thumb_url":{"description":"URL of detected thumb image","title":"Image URL","type":"string","x-stream-index":"001.012"},"title":{"description":"og:title","title":"Title","type":"string","x-stream-index":"001.008"},"title_link":{"description":"og:url","title":"Title Link","type":"string","x-stream-index":"001.009"},"type":{"description":"Attachment type, could be empty, image, audio or video","title":"Type","type":"string","x-stream-index":"001.001"}},"required":["custom","duration"],"title":"Get OG Attachment","type":"object","x-stream-docs-page-id":"og"},"GetOrCreateCallRequest":{"nullable":true,"properties":{"data":{"$ref":"#/components/schemas/CallRequest","title":"ReadOnlyData","x-stream-index":"003"},"members_limit":{"format":"int32","maximum":100,"type":"integer","x-stream-index":"007"},"notify":{"description":"if provided it sends a notification event to the members for this call","title":"Notify","type":"boolean","x-stream-index":"005"},"ring":{"description":"if provided it sends a ring event to the members for this call","title":"Ring","type":"boolean","x-stream-index":"004"},"video":{"type":"boolean","x-stream-index":"006"}},"title":"GetOrCreateCallRequest","type":"object"},"GetOrCreateCallResponse":{"nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001.001"},"created":{"type":"boolean","x-stream-index":"002"},"duration":{"type":"string","x-stream-index":"003.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001.002"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"001.004"}},"required":["call","members","own_capabilities","blocked_users","created","duration"],"title":"GetOrCreateCallResponse","type":"object"},"GetOrCreateFeedGroupRequest":{"nullable":true,"properties":{"activity_processors":{"description":"Configuration for activity processors (max 10)","items":{"$ref":"#/components/schemas/ActivityProcessorConfig"},"maximum":10,"title":"Activity Processors","type":"array","x-stream-index":"006"},"activity_selectors":{"description":"Configuration for activity selectors (max 10)","items":{"$ref":"#/components/schemas/ActivitySelectorConfig"},"maximum":10,"title":"Activity Selectors","type":"array","x-stream-index":"007"},"aggregation":{"$ref":"#/components/schemas/AggregationConfig","description":"Configuration for activity aggregation","title":"Aggregation","x-stream-index":"009"},"custom":{"additionalProperties":{},"description":"Custom data for the feed group","title":"Custom Data","type":"object","x-stream-index":"004"},"default_visibility":{"description":"Default visibility for the feed group, can be 'public', 'visible', 'followers', 'members', or 'private'. Defaults to 'visible' if not provided. ","enum":["public","visible","followers","members","private"],"title":"Default Visibility","type":"string","x-stream-index":"005"},"notification":{"$ref":"#/components/schemas/NotificationConfig","description":"Configuration for notifications","title":"Notification","x-stream-index":"002"},"push_notification":{"$ref":"#/components/schemas/PushNotificationConfig","x-stream-index":"003"},"ranking":{"$ref":"#/components/schemas/RankingConfig","description":"Configuration for activity ranking","title":"Ranking","x-stream-index":"008"}},"title":"Get Or Create Feed Group Request","type":"object"},"GetOrCreateFeedGroupResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"003.001"},"feed_group":{"$ref":"#/components/schemas/FeedGroupResponse","description":"The feed group that was retrieved or created","title":"Feed Group","x-stream-index":"001"},"was_created":{"description":"Indicates whether the feed group was created (true) or already existed (false)","title":"Was Created","type":"boolean","x-stream-index":"002"}},"required":["feed_group","was_created","duration"],"title":"Get Or Create Feed Group Response","type":"object"},"GetOrCreateFeedRequest":{"description":"Client request","nullable":true,"properties":{"activity_selector_options":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"data":{"$ref":"#/components/schemas/FeedInput","x-stream-index":"003"},"external_ranking":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"filter":{"additionalProperties":{},"type":"object","x-stream-index":"009"},"followers_pagination":{"$ref":"#/components/schemas/PagerRequest","x-stream-index":"011"},"following_pagination":{"$ref":"#/components/schemas/PagerRequest","x-stream-index":"012"},"interest_weights":{"additionalProperties":{"format":"float","type":"number"},"type":"object","x-stream-index":"008"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"013.001"},"member_pagination":{"$ref":"#/components/schemas/PagerRequest","x-stream-index":"010"},"next":{"type":"string","x-stream-index":"013.002"},"prev":{"type":"string","x-stream-index":"013.003"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"014.002"},"user_id":{"type":"string","x-stream-index":"014.001"},"view":{"type":"string","x-stream-index":"005"},"watch":{"type":"boolean","x-stream-index":"004"}},"title":"ClientRequest","type":"object"},"GetOrCreateFeedResponse":{"description":"Basic response information","nullable":true,"properties":{"activities":{"items":{"$ref":"#/components/schemas/ActivityResponse"},"type":"array","x-stream-index":"002"},"aggregated_activities":{"items":{"$ref":"#/components/schemas/AggregatedActivityResponse"},"type":"array","x-stream-index":"003"},"created":{"type":"boolean","x-stream-index":"015"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"017.001"},"feed":{"$ref":"#/components/schemas/FeedResponse","x-stream-index":"001"},"followers":{"items":{"$ref":"#/components/schemas/FollowResponse"},"type":"array","x-stream-index":"005"},"followers_pagination":{"$ref":"#/components/schemas/PagerResponse","x-stream-index":"012"},"following":{"items":{"$ref":"#/components/schemas/FollowResponse"},"type":"array","x-stream-index":"006"},"following_pagination":{"$ref":"#/components/schemas/PagerResponse","x-stream-index":"013"},"member_pagination":{"$ref":"#/components/schemas/PagerResponse","x-stream-index":"011"},"members":{"items":{"$ref":"#/components/schemas/FeedMemberResponse"},"type":"array","x-stream-index":"004"},"next":{"type":"string","x-stream-index":"016.001"},"notification_status":{"$ref":"#/components/schemas/NotificationStatusResponse","x-stream-index":"014"},"own_capabilities":{"items":{"$ref":"#/components/schemas/FeedOwnCapability"},"type":"array","x-stream-index":"008"},"own_follows":{"items":{"$ref":"#/components/schemas/FollowResponse"},"type":"array","x-stream-index":"009"},"own_membership":{"$ref":"#/components/schemas/FeedMemberResponse","x-stream-index":"010"},"pinned_activities":{"items":{"$ref":"#/components/schemas/ActivityPinResponse"},"type":"array","x-stream-index":"007"},"prev":{"type":"string","x-stream-index":"016.002"}},"required":["feed","activities","aggregated_activities","members","followers","following","pinned_activities","own_capabilities","created","duration"],"title":"Response","type":"object"},"GetOrCreateFeedViewRequest":{"nullable":true,"properties":{"activity_processors":{"description":"Configured activity Processors","items":{"$ref":"#/components/schemas/ActivityProcessorConfig"},"title":"Activity Processors","type":"array","x-stream-index":"002.002"},"activity_selectors":{"description":"Configuration for selecting activities","items":{"$ref":"#/components/schemas/ActivitySelectorConfig"},"title":"Activity Selectors","type":"array","x-stream-index":"002.001"},"aggregation":{"$ref":"#/components/schemas/AggregationConfig","description":"Configuration for aggregating activities","title":"Aggregation","x-stream-index":"002.004"},"ranking":{"$ref":"#/components/schemas/RankingConfig","description":"Configuration for ranking activities","title":"Ranking","x-stream-index":"002.003"}},"title":"Get Or Create Feed View Request","type":"object"},"GetOrCreateFeedViewResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"003.001"},"feed_view":{"$ref":"#/components/schemas/FeedViewResponse","description":"The feed view (either existing or newly created)","title":"Feed View","x-stream-index":"001"},"was_created":{"description":"Indicates whether the feed view was newly created (true) or already existed (false)","title":"Was Created","type":"boolean","x-stream-index":"002"}},"required":["feed_view","was_created","duration"],"title":"Get Or Create Feed View Response","type":"object"},"GetPushTemplatesResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"templates":{"items":{"$ref":"#/components/schemas/PushTemplate"},"type":"array","x-stream-index":"002"}},"required":["duration","templates"],"title":"Response","type":"object"},"GetRateLimitsResponse":{"nullable":true,"properties":{"android":{"additionalProperties":{"$ref":"#/components/schemas/LimitInfo"},"description":"Map of endpoint rate limits for the Android platform","title":"Android","type":"object","x-stream-index":"002","x-stream-map":{"key":"endpoint","title":"Endpoint name","description":"The name of the endpoint for which the limits apply"}},"duration":{"type":"string","x-stream-index":"005.001"},"ios":{"additionalProperties":{"$ref":"#/components/schemas/LimitInfo"},"description":"Map of endpoint rate limits for the iOS platform","title":"iOS","type":"object","x-stream-index":"003","x-stream-map":{"key":"endpoint","title":"Endpoint name","description":"The name of the endpoint for which the limits apply"}},"server_side":{"additionalProperties":{"$ref":"#/components/schemas/LimitInfo"},"description":"Map of endpoint rate limits for the server-side platform","title":"Server-side","type":"object","x-stream-index":"001","x-stream-map":{"key":"endpoint","title":"Endpoint name","description":"The name of the endpoint for which the limits apply"}},"web":{"additionalProperties":{"$ref":"#/components/schemas/LimitInfo"},"description":"Map of endpoint rate limits for the web platform","title":"Web","type":"object","x-stream-index":"004","x-stream-map":{"key":"endpoint","title":"Endpoint name","description":"The name of the endpoint for which the limits apply"}}},"required":["duration"],"title":"Get Rate Limits Response","type":"object","x-stream-docs-page-id":"rate_limits"},"GetReactionsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"reactions":{"description":"List of reactions","items":{"$ref":"#/components/schemas/Reaction"},"title":"Reactions","type":"array","x-stream-index":"001"}},"required":["reactions","duration"],"type":"object"},"GetRepliesResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"messages":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","x-stream-index":"001"}},"required":["messages","duration"],"title":"Response","type":"object"},"GetReviewQueueItemResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"Current state of the review queue item","title":"Item","x-stream-index":"001"}},"required":["duration"],"type":"object"},"GetSegmentResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"segment":{"$ref":"#/components/schemas/SegmentResponse","description":"Segment","title":"SegmentResponse","x-stream-index":"001"}},"required":["duration"],"type":"object"},"GetTaskResponse":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.003"},"duration":{"type":"string","x-stream-index":"004.001"},"error":{"$ref":"#/components/schemas/ErrorResult","description":"Error produced by task","title":"Error","x-stream-index":"003"},"result":{"additionalProperties":{},"description":"Result produced by task after completion","title":"Result","type":"object","x-stream-index":"002"},"status":{"description":"Current status of task","title":"Status","type":"string","x-stream-index":"001.002"},"task_id":{"description":"ID of task","title":"Task ID","type":"string","x-stream-index":"001.001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.004"}},"required":["task_id","status","created_at","updated_at","duration"],"title":"Get Task Response","type":"object","x-stream-docs-page-id":"tasks"},"GetThreadResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"thread":{"$ref":"#/components/schemas/ThreadStateResponse","description":"Enriched thread state","title":"Thread","x-stream-index":"001"}},"required":["thread","duration"],"type":"object"},"GoLiveRequest":{"nullable":true,"properties":{"recording_storage_name":{"type":"string","x-stream-index":"005"},"start_closed_caption":{"type":"boolean","x-stream-index":"008"},"start_hls":{"type":"boolean","x-stream-index":"003"},"start_recording":{"type":"boolean","x-stream-index":"004"},"start_transcription":{"type":"boolean","x-stream-index":"007"},"transcription_storage_name":{"type":"string","x-stream-index":"006"}},"title":"GoLiveRequest","type":"object"},"GoLiveResponse":{"description":"Basic response information","nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["call","duration"],"title":"Response","type":"object"},"GoogleVisionConfig":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"GroupedStatsResponse":{"nullable":true,"properties":{"name":{"type":"string","x-stream-index":"001"},"unique":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["name","unique"],"type":"object"},"HLSEgressConfig":{"properties":{"composite_app_settings":{"$ref":"#/components/schemas/CompositeAppSettings","x-stream-index":"005"},"playlist_url":{"type":"string","x-stream-index":"007"},"qualities":{"items":{"$ref":"#/components/schemas/Quality"},"type":"array","x-stream-index":"004"},"start_unix_nano":{"format":"int64","type":"integer","x-stream-index":"006"}},"type":"object"},"HLSSettings":{"properties":{"auto_on":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"004"},"quality_tracks":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"required":["auto_on","enabled","quality_tracks"],"type":"object"},"HLSSettingsRequest":{"properties":{"auto_on":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"layout":{"$ref":"#/components/schemas/LayoutSettingsRequest","title":"LayoutSettings","x-stream-index":"004"},"quality_tracks":{"items":{"type":"string"},"maximum":3,"minimum":1,"type":"array","x-stream-index":"003"}},"required":["quality_tracks"],"title":"HLSSettingsRequest","type":"object"},"HLSSettingsResponse":{"description":"HLSSettings is the payload for HLS settings","properties":{"auto_on":{"title":"Auto On","type":"boolean","x-stream-index":"001"},"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"002"},"layout":{"$ref":"#/components/schemas/LayoutSettingsResponse","title":"Layout","x-stream-index":"004"},"quality_tracks":{"items":{"type":"string"},"title":"Quality Tracks","type":"array","x-stream-index":"003"}},"required":["auto_on","enabled","quality_tracks","layout"],"title":"HLSSettingsResponse","type":"object"},"HarmConfig":{"properties":{"action_sequences":{"items":{"$ref":"#/components/schemas/ActionSequence"},"type":"array","x-stream-index":"001"},"severity":{"type":"integer","x-stream-index":"002"}},"required":["action_sequences","severity"],"type":"object"},"HideChannelRequest":{"nullable":true,"properties":{"clear_history":{"description":"Whether to clear message history of the channel or not","title":"Clear history","type":"boolean","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"type":"object"},"HideChannelResponse":{"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"},"HuaweiConfig":{"properties":{"Disabled":{"type":"boolean","writeOnly":true,"x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"secret":{"type":"string","x-stream-index":"002"}},"type":"object"},"HuaweiConfigFields":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"id":{"type":"string","x-stream-index":"002"},"secret":{"type":"string","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"ImageContentParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"type":"object"},"ImageData":{"properties":{"frames":{"type":"string","x-stream-index":"005"},"height":{"type":"string","x-stream-index":"003"},"size":{"type":"string","x-stream-index":"004"},"url":{"type":"string","x-stream-index":"001"},"width":{"type":"string","x-stream-index":"002"}},"required":["url","width","height","size","frames"],"type":"object"},"ImageRuleParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"type":"object"},"ImageSize":{"properties":{"crop":{"description":"Crop mode","enum":["top","bottom","left","right","center"],"title":"Crop","type":"string","x-stream-index":"001"},"height":{"description":"Target image height","format":"int32","title":"Height","type":"integer","x-stream-index":"003"},"resize":{"description":"Resize method","enum":["clip","crop","scale","fill"],"title":"Resize","type":"string","x-stream-index":"002"},"width":{"description":"Target image width","format":"int32","title":"Width","type":"integer","x-stream-index":"004"}},"title":"Image size configuration","type":"object"},"ImageUploadRequest":{"nullable":true,"properties":{"file":{"type":"string","x-stream-index":"001.001"},"upload_sizes":{"description":"field with JSON-encoded array of image size configurations","items":{"$ref":"#/components/schemas/ImageSize"},"title":"Upload sizes","type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/OnlyUserID","x-stream-index":"001.002"}},"type":"object"},"ImageUploadResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.003.001"},"file":{"type":"string","x-stream-index":"001.001"},"thumb_url":{"type":"string","x-stream-index":"001.002"},"upload_sizes":{"description":"Array of image size configurations","items":{"$ref":"#/components/schemas/ImageSize"},"title":"Upload sizes","type":"array","x-stream-index":"002"}},"required":["duration"],"type":"object"},"Images":{"properties":{"fixed_height":{"$ref":"#/components/schemas/ImageData","x-stream-index":"002"},"fixed_height_downsampled":{"$ref":"#/components/schemas/ImageData","x-stream-index":"004"},"fixed_height_still":{"$ref":"#/components/schemas/ImageData","x-stream-index":"003"},"fixed_width":{"$ref":"#/components/schemas/ImageData","x-stream-index":"005"},"fixed_width_downsampled":{"$ref":"#/components/schemas/ImageData","x-stream-index":"007"},"fixed_width_still":{"$ref":"#/components/schemas/ImageData","x-stream-index":"006"},"original":{"$ref":"#/components/schemas/ImageData","x-stream-index":"001"}},"required":["original","fixed_height","fixed_height_still","fixed_height_downsampled","fixed_width","fixed_width_still","fixed_width_downsampled"],"type":"object"},"ImportTask":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"011"},"history":{"items":{"$ref":"#/components/schemas/ImportTaskHistory"},"type":"array","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"003"},"mode":{"type":"string","x-stream-index":"006"},"path":{"type":"string","x-stream-index":"005"},"size":{"format":"int64","type":"integer","x-stream-index":"007"},"state":{"type":"string","x-stream-index":"008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"012"}},"required":["id","path","mode","state","history","created_at","updated_at"],"type":"object"},"ImportTaskHistory":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"next_state":{"type":"string","x-stream-index":"006"},"prev_state":{"type":"string","x-stream-index":"005"}},"required":["prev_state","next_state","created_at"],"type":"object"},"IngressAudioEncodingOptions":{"properties":{"bitrate":{"maximum":128000,"minimum":16000,"type":"integer","x-stream-index":"003"},"channels":{"enum":["1","2"],"format":"int32","type":"integer","x-stream-index":"001"},"enable_dtx":{"type":"boolean","x-stream-index":"002"}},"required":["channels","enable_dtx","bitrate"],"type":"object"},"IngressAudioEncodingOptionsRequest":{"properties":{"bitrate":{"maximum":128000,"minimum":16000,"type":"integer","x-stream-index":"003"},"channels":{"enum":["1","2"],"format":"int32","type":"integer","x-stream-index":"001"},"enable_dtx":{"type":"boolean","x-stream-index":"002"}},"required":["channels","bitrate"],"type":"object"},"IngressAudioEncodingResponse":{"properties":{"bitrate":{"format":"int32","type":"integer","x-stream-index":"003"},"channels":{"format":"int32","type":"integer","x-stream-index":"001"},"enable_dtx":{"type":"boolean","x-stream-index":"002"}},"required":["channels","enable_dtx","bitrate"],"type":"object"},"IngressSettings":{"properties":{"audio_encoding_options":{"$ref":"#/components/schemas/IngressAudioEncodingOptions","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"video_encoding_options":{"additionalProperties":{"$ref":"#/components/schemas/IngressVideoEncodingOptions"},"type":"object","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"IngressSettingsRequest":{"properties":{"audio_encoding_options":{"$ref":"#/components/schemas/IngressAudioEncodingOptionsRequest","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"video_encoding_options":{"additionalProperties":{"$ref":"#/components/schemas/IngressVideoEncodingOptionsRequest"},"type":"object","x-stream-index":"003"}},"type":"object"},"IngressSettingsResponse":{"properties":{"audio_encoding_options":{"$ref":"#/components/schemas/IngressAudioEncodingResponse","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"video_encoding_options":{"additionalProperties":{"$ref":"#/components/schemas/IngressVideoEncodingResponse"},"type":"object","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"IngressVideoEncodingOptions":{"properties":{"layers":{"items":{"$ref":"#/components/schemas/IngressVideoLayer"},"minimum":1,"type":"array","x-stream-index":"001"}},"required":["layers"],"type":"object"},"IngressVideoEncodingOptionsRequest":{"properties":{"layers":{"items":{"$ref":"#/components/schemas/IngressVideoLayerRequest"},"minimum":1,"type":"array","x-stream-index":"001"}},"required":["layers"],"type":"object"},"IngressVideoEncodingResponse":{"properties":{"layers":{"items":{"$ref":"#/components/schemas/IngressVideoLayerResponse"},"type":"array","x-stream-index":"001"}},"required":["layers"],"type":"object"},"IngressVideoLayer":{"nullable":true,"properties":{"bitrate":{"minimum":1000,"type":"integer","x-stream-index":"002"},"codec":{"enum":["h264","vp8"],"type":"string","x-stream-index":"001"},"frame_rate":{"maximum":60,"minimum":1,"type":"integer","x-stream-index":"003"},"max_dimension":{"minimum":240,"type":"integer","x-stream-index":"005"},"min_dimension":{"minimum":240,"type":"integer","x-stream-index":"004"}},"required":["codec","bitrate","frame_rate","min_dimension","max_dimension"],"type":"object"},"IngressVideoLayerRequest":{"nullable":true,"properties":{"bitrate":{"format":"int32","minimum":1000,"type":"integer","x-stream-index":"002"},"codec":{"enum":["h264","vp8"],"type":"string","x-stream-index":"001"},"frame_rate_limit":{"maximum":60,"minimum":1,"type":"integer","x-stream-index":"005"},"max_dimension":{"minimum":240,"type":"integer","x-stream-index":"004"},"min_dimension":{"minimum":240,"type":"integer","x-stream-index":"003"}},"required":["codec","bitrate","min_dimension","max_dimension","frame_rate_limit"],"type":"object"},"IngressVideoLayerResponse":{"nullable":true,"properties":{"bitrate":{"type":"integer","x-stream-index":"002"},"codec":{"type":"string","x-stream-index":"001"},"frame_rate_limit":{"type":"integer","x-stream-index":"005"},"max_dimension":{"type":"integer","x-stream-index":"004"},"min_dimension":{"type":"integer","x-stream-index":"003"}},"required":["codec","bitrate","min_dimension","max_dimension","frame_rate_limit"],"type":"object"},"JoinCallAPIMetrics":{"properties":{"failures":{"format":"float","type":"number","x-stream-index":"002"},"latency":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"003"},"total":{"format":"float","type":"number","x-stream-index":"001"}},"required":["total","failures"],"type":"object"},"KickUserRequest":{"description":"KickUserRequest is the payload for kicking a user from a call. Optionally block the user as well.","nullable":true,"properties":{"block":{"description":"If true, also block the user from rejoining the call","title":"Block","type":"boolean","x-stream-index":"004"},"kicked_by":{"$ref":"#/components/schemas/UserRequest","description":"Server-side: user performing the action","title":"KickedBy","x-stream-index":"006"},"kicked_by_id":{"description":"Server-side: ID of the user performing the action","title":"KickedByID","type":"string","x-stream-index":"005"},"user_id":{"description":"The user to kick","title":"UserID","type":"string","x-stream-index":"003"}},"required":["user_id"],"title":"KickUserRequest","type":"object"},"KickUserResponse":{"description":"KickUserResponse is the payload for kicking a user from a call.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"KickUserResponse","type":"object"},"KickedUserEvent":{"description":"This event is sent to call participants to notify when a user is kicked from a call. Clients should make the kicked user leave the call UI.","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"kicked_by_user":{"$ref":"#/components/schemas/UserResponse","description":"The user that kicked the participant, null if server-side","title":"Kicked by","x-stream-index":"004"},"type":{"default":"call.kicked_user","description":"The type of event: \"call.kicked_user\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user that was kicked","title":"User","x-stream-index":"003"}},"required":["type","created_at","call_cid","user"],"title":"KickedUserEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"LLMConfig":{"properties":{"app_context":{"type":"string","x-stream-index":"005"},"async":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"rules":{"items":{"$ref":"#/components/schemas/LLMRule"},"type":"array","x-stream-index":"003"},"severity_descriptions":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"004"}},"required":["enabled","rules"],"type":"object"},"LLMRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove","keep"],"type":"string","x-stream-index":"003"},"description":{"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"},"severity_rules":{"items":{"$ref":"#/components/schemas/BodyguardSeverityRule"},"type":"array","x-stream-index":"004"}},"required":["label","description","action","severity_rules"],"type":"object"},"Label":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"phrase_list_ids":{"items":{"format":"int32","type":"integer"},"type":"array","x-stream-index":"002"}},"required":["name"],"type":"object"},"LabelThresholds":{"properties":{"block":{"description":"Threshold for automatic message block","format":"float","maximum":1,"minimum":0,"title":"Block","type":"number","x-stream-index":"002"},"flag":{"description":"Threshold for automatic message flag","format":"float","maximum":1,"minimum":0,"title":"Flag","type":"number","x-stream-index":"001"}},"type":"object"},"LayoutSettings":{"properties":{"detect_orientation":{"type":"boolean","x-stream-index":"005"},"external_app_url":{"type":"string","x-stream-index":"003"},"external_css_url":{"type":"string","x-stream-index":"004"},"name":{"enum":["spotlight","grid","single-participant","mobile","custom"],"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"required":["name","external_app_url","external_css_url"],"type":"object"},"LayoutSettingsRequest":{"properties":{"detect_orientation":{"type":"boolean","x-stream-index":"005"},"external_app_url":{"type":"string","x-stream-index":"003"},"external_css_url":{"type":"string","x-stream-index":"004"},"name":{"enum":["spotlight","grid","single-participant","mobile","custom"],"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"required":["name"],"type":"object"},"LayoutSettingsResponse":{"properties":{"detect_orientation":{"type":"boolean","x-stream-index":"005"},"external_app_url":{"type":"string","x-stream-index":"003"},"external_css_url":{"type":"string","x-stream-index":"004"},"name":{"enum":["spotlight","grid","single-participant","mobile","custom"],"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"required":["name","external_app_url","external_css_url"],"type":"object"},"LimitInfo":{"properties":{"limit":{"description":"The maximum number of calls allowed for the time window","format":"int32","title":"Limit","type":"integer","x-stream-index":"001"},"remaining":{"description":"The number of remaining calls in the current window","format":"int64","title":"Remaining","type":"integer","x-stream-index":"002"},"reset":{"description":"The Unix timestamp of the next window","format":"int64","title":"Reset","type":"integer","x-stream-index":"003"}},"required":["limit","remaining","reset"],"title":"Rate Limit info","type":"object","x-stream-docs-page-id":"rate_limits"},"LimitsSettings":{"properties":{"max_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"004"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"},"max_participants_exclude_owner":{"type":"boolean","x-stream-index":"003"},"max_participants_exclude_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"002"}},"required":["max_participants_exclude_roles"],"type":"object"},"LimitsSettingsRequest":{"properties":{"max_duration_seconds":{"format":"int32","minimum":0,"type":"integer","x-stream-index":"004"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"},"max_participants_exclude_owner":{"type":"boolean","x-stream-index":"003"},"max_participants_exclude_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"002"}},"type":"object"},"LimitsSettingsResponse":{"properties":{"max_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"004"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"},"max_participants_exclude_owner":{"type":"boolean","x-stream-index":"003"},"max_participants_exclude_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"002"}},"required":["max_participants_exclude_roles"],"type":"object"},"ListBlockListResponse":{"description":"Basic response information","nullable":true,"properties":{"blocklists":{"items":{"$ref":"#/components/schemas/BlockListResponse"},"type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["blocklists","duration"],"title":"Response","type":"object"},"ListCallTypeResponse":{"description":"Response for ListCallType","nullable":true,"properties":{"call_types":{"additionalProperties":{"$ref":"#/components/schemas/CallTypeResponse"},"type":"object","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["call_types","duration"],"title":"ListCallTypeResponse","type":"object"},"ListChannelTypesResponse":{"nullable":true,"properties":{"channel_types":{"additionalProperties":{"$ref":"#/components/schemas/ChannelTypeConfig"},"description":"Object with all channel types","title":"Channel types","type":"object","x-stream-index":"001","x-stream-map":{"key":"channel_type","title":"Channel type","description":"Channel type config object"}},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["channel_types","duration"],"title":"ListChannelTypesResponse","type":"object"},"ListCommandsResponse":{"nullable":true,"properties":{"commands":{"description":"List of commands","items":{"$ref":"#/components/schemas/Command"},"title":"Commands","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["commands","duration"],"title":"ListCommandsResponse","type":"object"},"ListDevicesResponse":{"description":"List devices response","nullable":true,"properties":{"devices":{"description":"List of devices","items":{"$ref":"#/components/schemas/DeviceResponse"},"title":"Devices","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["devices","duration"],"title":"ListDevicesResponse","type":"object"},"ListExternalStorageResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"external_storages":{"additionalProperties":{"$ref":"#/components/schemas/ExternalStorageResponse"},"type":"object","x-stream-index":"002"}},"required":["duration","external_storages"],"title":"Response","type":"object"},"ListFeedGroupsResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"groups":{"additionalProperties":{"$ref":"#/components/schemas/FeedGroupResponse"},"type":"object","x-stream-index":"001"}},"required":["groups","duration"],"title":"Response","type":"object"},"ListFeedViewsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"views":{"additionalProperties":{"$ref":"#/components/schemas/FeedViewResponse"},"description":"Map of feed view ID to feed view","title":"Views","type":"object","x-stream-index":"001"}},"required":["views","duration"],"title":"List Feed Views Response","type":"object"},"ListImportsResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"import_tasks":{"items":{"$ref":"#/components/schemas/ImportTask"},"type":"array","x-stream-index":"001"}},"required":["import_tasks","duration"],"title":"Response","type":"object"},"ListPermissionsResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"permissions":{"items":{"$ref":"#/components/schemas/Permission"},"type":"array","x-stream-index":"001"}},"required":["permissions","duration"],"title":"Response","type":"object"},"ListPushProvidersResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"push_providers":{"items":{"$ref":"#/components/schemas/PushProviderResponse"},"type":"array","x-stream-index":"001"}},"required":["push_providers","duration"],"title":"Response","type":"object"},"ListRecordingsResponse":{"description":"Response for listing recordings","nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"},"recordings":{"items":{"$ref":"#/components/schemas/CallRecording"},"title":"The list of recordings.","type":"array","x-stream-index":"002"}},"required":["duration","recordings"],"title":"ListRecordingsResponse","type":"object"},"ListRolesResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"roles":{"items":{"$ref":"#/components/schemas/Role"},"type":"array","x-stream-index":"001"}},"required":["roles","duration"],"title":"Response","type":"object"},"ListTranscriptionsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"},"transcriptions":{"description":"List of transcriptions for the call","items":{"$ref":"#/components/schemas/CallTranscription"},"title":"Transcriptions","type":"array","x-stream-index":"002"}},"required":["duration","transcriptions"],"title":"ListTranscriptionsResponse","type":"object"},"MarkActivityRequest":{"nullable":true,"properties":{"mark_all_read":{"description":"Whether to mark all activities as read","title":"Mark All Read","type":"boolean","x-stream-index":"005"},"mark_all_seen":{"description":"Whether to mark all activities as seen","title":"Mark All Seen","type":"boolean","x-stream-index":"003"},"mark_read":{"description":"List of activity IDs to mark as read","items":{"type":"string"},"title":"Mark Read","type":"array","x-stream-index":"004"},"mark_seen":{"description":"List of activity IDs to mark as seen","items":{"type":"string"},"title":"Mark Seen","type":"array","x-stream-index":"006"},"mark_watched":{"description":"List of activity IDs to mark as watched (for stories)","items":{"type":"string"},"title":"Mark Watched","type":"array","x-stream-index":"007"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"009.002"},"user_id":{"type":"string","x-stream-index":"009.001"}},"title":"Mark Activity Request","type":"object"},"MarkChannelsReadRequest":{"nullable":true,"properties":{"read_by_channel":{"additionalProperties":{"type":"string"},"description":"Map of channel ID to last read message ID","maximum":30,"title":"Read by channel","type":"object","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"002.002"},"user_id":{"type":"string","x-stream-index":"002.001"}},"type":"object"},"MarkReadRequest":{"nullable":true,"properties":{"message_id":{"description":"ID of the message that is considered last read by client","title":"Message ID","type":"string","x-stream-index":"001"},"thread_id":{"description":"Optional Thread ID to specifically mark a given thread as read","title":"Thread ID","type":"string","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"type":"object"},"MarkReadResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"event":{"$ref":"#/components/schemas/MessageReadEvent","description":"Mark read event","title":"Event","x-stream-index":"001"}},"required":["duration"],"type":"object"},"MarkReviewedRequest":{"properties":{"content_to_mark_as_reviewed_limit":{"format":"int32","maximum":2500,"type":"integer","x-stream-index":"002"},"disable_marking_content_as_reviewed":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"MarkUnreadRequest":{"nullable":true,"properties":{"message_id":{"description":"ID of the message from where the channel is marked unread","title":"Message ID","type":"string","x-stream-index":"001"},"thread_id":{"description":"Mark a thread unread, specify both the thread and message id","title":"Thread ID","type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"type":"object"},"MemberAddedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"002.001"},"type":{"default":"member.added","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MemberAddedEvent","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"},"MemberLookup":{"properties":{"Limit":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"001"}},"required":["Limit"],"type":"object"},"MemberRemovedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"001.001"},"type":{"default":"member.removed","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MemberRemovedEvent","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"},"MemberRequest":{"description":"MemberRequest is the payload for adding a member to a call.","properties":{"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"003"},"role":{"title":"Role","type":"string","x-stream-index":"002"},"user_id":{"minLength":1,"title":"User ID","type":"string","x-stream-index":"001"}},"required":["user_id"],"title":"MemberRequest","type":"object"},"MemberResponse":{"description":"MemberResponse is the payload for a member of a call.","properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"005"},"custom":{"additionalProperties":{},"description":"Custom member response data","title":"Custom","type":"object","x-stream-index":"004"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"007"},"role":{"title":"Role","type":"string","x-stream-index":"003"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"006"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"},"user_id":{"type":"string","x-stream-index":"002"}},"required":["user","user_id","custom","created_at","updated_at"],"title":"MemberResponse","type":"object"},"MemberUpdatedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"005.002"},"channel_type":{"type":"string","x-stream-index":"005.003"},"cid":{"type":"string","x-stream-index":"005.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"002.001"},"type":{"default":"member.updated","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MemberUpdatedEvent","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"},"MembersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"members":{"description":"List of found members","items":{"$ref":"#/components/schemas/ChannelMember"},"title":"Members","type":"array","x-stream-index":"001"}},"required":["members","duration"],"type":"object"},"MembershipLevelResponse":{"properties":{"created_at":{"description":"When the membership level was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"007"},"custom":{"additionalProperties":{},"description":"Custom data for the membership level","title":"Custom Data","type":"object","x-stream-index":"006"},"description":{"description":"Description of the membership level","title":"Description","type":"string","x-stream-index":"003"},"id":{"description":"Unique identifier for the membership level","title":"ID","type":"string","x-stream-index":"001"},"name":{"description":"Display name for the membership level","title":"Name","type":"string","x-stream-index":"002"},"priority":{"description":"Priority level","format":"int32","title":"Priority","type":"integer","x-stream-index":"004"},"tags":{"description":"Activity tags this membership level gives access to","items":{"type":"string"},"title":"Tags","type":"array","x-stream-index":"005"},"updated_at":{"description":"When the membership level was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"008"}},"required":["id","name","priority","tags","created_at","updated_at"],"title":"Membership Level Response","type":"object"},"Message":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"012"},"before_message_send_failed":{"type":"boolean","x-stream-index":"046"},"cid":{"type":"string","x-stream-index":"028"},"command":{"type":"string","x-stream-index":"006"},"created_at":{"format":"date-time","type":"number","x-stream-index":"030"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"034"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"033"},"deleted_for_me":{"type":"boolean","x-stream-index":"059"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"023"},"html":{"type":"string","x-stream-index":"007"},"i18n":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"044"},"id":{"type":"string","x-stream-index":"002"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"040"},"latest_reactions":{"items":{"$ref":"#/components/schemas/Reaction"},"type":"array","x-stream-index":"013"},"mentioned_users":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"043"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"052"},"mml":{"type":"string","x-stream-index":"005"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"056"},"own_reactions":{"items":{"$ref":"#/components/schemas/Reaction"},"type":"array","x-stream-index":"014"},"parent_id":{"type":"string","x-stream-index":"019"},"pin_expires":{"format":"date-time","type":"number","x-stream-index":"051"},"pinned":{"type":"boolean","x-stream-index":"047"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"048"},"pinned_by":{"$ref":"#/components/schemas/User","x-stream-index":"050"},"poll":{"$ref":"#/components/schemas/Poll","x-stream-index":"054"},"poll_id":{"type":"string","x-stream-index":"053"},"quoted_message":{"$ref":"#/components/schemas/Message","x-stream-index":"025"},"quoted_message_id":{"type":"string","x-stream-index":"024"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"015"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"017"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"016"},"reminder":{"$ref":"#/components/schemas/MessageReminder","x-stream-index":"058"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"022"},"restricted_visibility":{"items":{"type":"string"},"type":"array","x-stream-index":"011"},"shadowed":{"type":"boolean","x-stream-index":"036"},"shared_location":{"$ref":"#/components/schemas/SharedLocation","x-stream-index":"055"},"show_in_channel":{"type":"boolean","x-stream-index":"021"},"silent":{"type":"boolean","x-stream-index":"045"},"text":{"type":"string","x-stream-index":"004"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"027"},"type":{"type":"string","x-stream-index":"008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"031"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"010"}},"required":["id","text","html","type","restricted_visibility","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reaction_groups","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned"],"type":"object"},"MessageActionRequest":{"nullable":true,"properties":{"form_data":{"additionalProperties":{"type":"string"},"description":"ReadOnlyData to execute command with","title":"Form data","type":"object","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"required":["form_data"],"type":"object"},"MessageChangeSet":{"properties":{"attachments":{"type":"boolean","x-stream-index":"005"},"custom":{"type":"boolean","x-stream-index":"001"},"html":{"type":"boolean","x-stream-index":"004"},"mentioned_user_ids":{"type":"boolean","x-stream-index":"006"},"mml":{"type":"boolean","x-stream-index":"003"},"pin":{"type":"boolean","x-stream-index":"009"},"quoted_message_id":{"type":"boolean","x-stream-index":"007"},"silent":{"type":"boolean","x-stream-index":"008"},"text":{"type":"boolean","x-stream-index":"002"}},"required":["custom","text","mml","html","attachments","mentioned_user_ids","quoted_message_id","silent","pin"],"type":"object"},"MessageDeletedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"007.002"},"deleted_for_me":{"type":"boolean","x-stream-index":"003"},"hard_delete":{"type":"boolean","x-stream-index":"002.001"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"006.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"message.deleted","type":"string","x-stream-index":"007.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005.001"}},"required":["hard_delete","cid","channel_id","channel_type","type","created_at"],"title":"MessageDeletedEvent","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":{"approved_at":{"format":"date-time","type":"number","x-stream-index":"013"},"created_at":{"format":"date-time","type":"number","x-stream-index":"009"},"created_by_automod":{"type":"boolean","x-stream-index":"001"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"008"},"details":{"$ref":"#/components/schemas/FlagDetails","x-stream-index":"006"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"005"},"moderation_feedback":{"$ref":"#/components/schemas/FlagFeedback","x-stream-index":"003"},"moderation_result":{"$ref":"#/components/schemas/MessageModerationResult","x-stream-index":"002"},"reason":{"type":"string","x-stream-index":"007"},"rejected_at":{"format":"date-time","type":"number","x-stream-index":"014"},"reviewed_at":{"format":"date-time","type":"number","x-stream-index":"011"},"reviewed_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"012"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"004"}},"required":["created_by_automod","created_at","updated_at"],"type":"object"},"MessageFlaggedEvent":{"properties":{"cid":{"type":"string","x-stream-index":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"005.002"},"flag":{"$ref":"#/components/schemas/Flag","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"002.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"002.002"},"type":{"default":"message.flagged","type":"string","x-stream-index":"005.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004"}},"required":["cid","type","created_at"],"title":"MessageFlaggedEvent","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"},"MessageHistoryEntryResponse":{"nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"007"},"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"006"},"is_deleted":{"type":"boolean","x-stream-index":"004"},"message_id":{"type":"string","x-stream-index":"001"},"message_updated_at":{"format":"date-time","type":"number","x-stream-index":"003"},"message_updated_by_id":{"type":"string","x-stream-index":"002"},"text":{"type":"string","x-stream-index":"005"}},"required":["message_id","message_updated_by_id","message_updated_at","is_deleted","text","attachments","Custom"],"type":"object"},"MessageModerationResult":{"description":"Result of the message moderation","properties":{"action":{"description":"Action taken by automod","title":"Action","type":"string","x-stream-index":"002"},"ai_moderation_response":{"$ref":"#/components/schemas/ModerationResponse","description":"Response from AI moderation","title":"ModerationResponse","x-stream-index":"007"},"blocked_word":{"description":"Word that was blocked","title":"Blocked word","type":"string","x-stream-index":"004"},"blocklist_name":{"description":"Name of the blocklist","title":"Blocklist name","type":"string","x-stream-index":"005"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"010"},"message_id":{"description":"ID of the message","title":"Message ID","type":"string","x-stream-index":"001"},"moderated_by":{"description":"User who moderated the message","title":"Moderated by","type":"string","x-stream-index":"003"},"moderation_thresholds":{"$ref":"#/components/schemas/Thresholds","description":"Thresholds for AI moderation","title":"Thresholds","x-stream-index":"006"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"011"},"user_bad_karma":{"description":"Whether user has bad karma","title":"User bad karma","type":"boolean","x-stream-index":"009"},"user_karma":{"description":"Karma of the user","format":"float","title":"User karma","type":"number","x-stream-index":"008"}},"required":["message_id","action","user_karma","user_bad_karma","created_at","updated_at"],"title":"Message moderation result","type":"object"},"MessageNewEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"005.002"},"channel_type":{"type":"string","x-stream-index":"005.003"},"cid":{"type":"string","x-stream-index":"005.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"006.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"message.new","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"},"watcher_count":{"format":"int32","type":"integer","x-stream-index":"002.001"}},"required":["watcher_count","type","created_at","cid","channel_id","channel_type"],"title":"MessageNewEvent","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"},"MessageOptions":{"properties":{"include_thread_participants":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"MessagePaginationParams":{"type":"object"},"MessageReadEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"003"},"channel_last_message_at":{"format":"date-time","type":"number","x-stream-index":"005"},"channel_type":{"type":"string","x-stream-index":"004"},"cid":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"009"},"last_read_message_id":{"type":"string","x-stream-index":"010"},"team":{"type":"string","x-stream-index":"006"},"thread":{"$ref":"#/components/schemas/ThreadResponse","x-stream-index":"008"},"type":{"default":"message.read","type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","x-stream-index":"007"}},"required":["type","cid","channel_id","channel_type","created_at"],"type":"object"},"MessageReminder":{"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"004"},"channel_cid":{"type":"string","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"011"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"006"},"message_id":{"type":"string","x-stream-index":"005"},"remind_at":{"format":"date-time","type":"number","x-stream-index":"009"},"task_id":{"type":"string","x-stream-index":"010"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"012"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"user_id":{"type":"string","x-stream-index":"007"}},"required":["channel_cid","message_id","user_id","task_id","created_at","updated_at"],"type":"object"},"MessageRequest":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"maximum":30,"type":"array","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"html":{"type":"string","x-stream-index":"010"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"mentioned_users":{"items":{"type":"string"},"maximum":100,"type":"array","x-stream-index":"008"},"mml":{"type":"string","x-stream-index":"003"},"parent_id":{"type":"string","x-stream-index":"005"},"pin_expires":{"format":"date-time","type":"number","x-stream-index":"015"},"pinned":{"type":"boolean","x-stream-index":"013"},"pinned_at":{"format":"date-time","nullable":true,"type":"string","x-stream-index":"014"},"poll_id":{"type":"string","x-stream-index":"039"},"quoted_message_id":{"type":"string","x-stream-index":"009"},"restricted_visibility":{"items":{"type":"string"},"maximum":10,"type":"array","x-stream-index":"016"},"shared_location":{"$ref":"#/components/schemas/SharedLocation","x-stream-index":"040"},"show_in_channel":{"type":"boolean","x-stream-index":"006"},"silent":{"type":"boolean","x-stream-index":"012"},"text":{"type":"string","x-stream-index":"002"},"type":{"enum":["''","regular","system"],"type":"string","x-stream-index":"011"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"021.002"},"user_id":{"type":"string","x-stream-index":"021.001"}},"type":"object"},"MessageResponse":{"description":"Represents any chat message","properties":{"attachments":{"description":"Array of message attachments","items":{"$ref":"#/components/schemas/Attachment"},"title":"Message attachments","type":"array","x-stream-docs-page-id":"message_format#attachment-format","x-stream-index":"008"},"cid":{"description":"Channel unique identifier in \u003ctype\u003e:\u003cid\u003e format","title":"Channel CID","type":"string","x-stream-index":"022"},"command":{"description":"Contains provided slash command","title":"Command","type":"string","x-stream-docs-page-id":"custom_commands_webhook","x-stream-index":"004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"023"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"026"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"025"},"deleted_for_me":{"type":"boolean","x-stream-index":"044"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"018"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"041"},"html":{"description":"Contains HTML markup of the message. Can only be set when using server-side API","title":"HTML content","type":"string","x-stream-index":"005"},"i18n":{"additionalProperties":{"type":"string"},"description":"Object with translations. Key `language` contains the original language key. Other keys contain translations","title":"Internationalization info","type":"object","x-stream-docs-page-id":"translation","x-stream-index":"030"},"id":{"description":"Message ID is unique string identifier of the message","title":"ID","type":"string","x-stream-index":"001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"Contains image moderation information","title":"Image moderation labels","type":"object","x-stream-index":"028"},"latest_reactions":{"description":"List of 10 latest reactions to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Latest reactions","type":"array","x-stream-index":"009"},"mentioned_users":{"description":"List of mentioned users","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Mentioned Users","type":"array","x-stream-index":"029"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"036"},"mml":{"description":"Should be empty if `text` is provided. Can only be set when using server-side API","title":"Messaging Markup Language","type":"string","x-stream-docs-page-id":"mml_overview","x-stream-index":"003"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"039"},"own_reactions":{"description":"List of 10 latest reactions of authenticated user to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Own reactions","type":"array","x-stream-index":"010"},"parent_id":{"description":"ID of parent message (thread)","title":"Parent message ID","type":"string","x-stream-docs-page-id":"threads","x-stream-index":"015"},"pin_expires":{"description":"Date when pinned message expires","format":"date-time","title":"Pin expiration date","type":"number","x-stream-docs-page-id":"pinned_messages","x-stream-index":"035"},"pinned":{"description":"Whether message is pinned or not","title":"Pinned","type":"boolean","x-stream-docs-page-id":"pinned_messages","x-stream-index":"032"},"pinned_at":{"description":"Date when message got pinned","format":"date-time","title":"Pinned at","type":"number","x-stream-docs-page-id":"pinned_messages","x-stream-index":"033"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","description":"Contains user who pinned the message","title":"Pinned by","x-stream-docs-page-id":"pinned_messages","x-stream-index":"034"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"038"},"poll_id":{"description":"Identifier of the poll to include in the message","title":"Poll ID","type":"string","x-stream-index":"037"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","description":"Contains quoted message","title":"Quoted message","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"020"},"quoted_message_id":{"title":"ID of quoted message","type":"string","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"019"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing number of reactions of each type. Key: reaction type (string), value: number of reactions (int)","title":"Reaction counts","type":"object","x-stream-index":"011"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"014"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing scores of reactions of each type. Key: reaction type (string), value: total score of reactions (int)","title":"Reaction scores","type":"object","x-stream-index":"012"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"042"},"reply_count":{"description":"Number of replies to this message","format":"int32","title":"Reply count","type":"integer","x-stream-index":"017"},"restricted_visibility":{"description":"A list of user ids that have restricted visibility to the message, if the list is not empty, the message is only visible to the users in the list","items":{"type":"string"},"title":"Restricted visibility","type":"array","x-stream-index":"040"},"shadowed":{"description":"Whether the message was shadowed or not","title":"Shadowed","type":"boolean","x-stream-docs-page-id":"moderation#shadow-ban","x-stream-index":"027"},"shared_location":{"$ref":"#/components/schemas/SharedLocationResponseData","description":"Contains shared location data","title":"Shared Location","x-stream-index":"043"},"show_in_channel":{"description":"Whether thread reply should be shown in the channel as well","title":"Show in channel","type":"boolean","x-stream-docs-page-id":"threads","x-stream-index":"016"},"silent":{"description":"Whether message is silent or not","title":"Silent","type":"boolean","x-stream-index":"031"},"text":{"description":"Text of the message. Should be empty if `mml` is provided","title":"Text","type":"string","x-stream-index":"002"},"thread_participants":{"description":"List of users who participate in thread","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Thread participants","type":"array","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"021"},"type":{"description":"Contains type of the message","enum":["regular","ephemeral","error","reply","system","deleted"],"title":"Message Type","type":"string","x-stream-docs-page-id":"message_format#message-types","x-stream-index":"006"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"024"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Sender of the message. Required when using server-side API","title":"User object","x-stream-index":"007"}},"required":["id","text","html","type","user","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned","restricted_visibility"],"title":"Message","type":"object","x-stream-docs-page-id":"send_message"},"MessageStatsResponse":{"properties":{"count_over_time":{"items":{"$ref":"#/components/schemas/CountByMinuteResponse"},"type":"array","x-stream-index":"001"}},"type":"object"},"MessageUnblockedEvent":{"properties":{"cid":{"type":"string","x-stream-index":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"002.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"002.002"},"type":{"default":"message.unblocked","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["cid","type","created_at"],"title":"MessageUnblockedEvent","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"},"MessageUndeletedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"005.002"},"channel_type":{"type":"string","x-stream-index":"005.003"},"cid":{"type":"string","x-stream-index":"005.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"002.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"message.undeleted","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MessageUndeletedEvent","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"},"MessageUpdate":{"properties":{"change_set":{"$ref":"#/components/schemas/MessageChangeSet","x-stream-index":"002"},"old_text":{"type":"string","x-stream-index":"001"}},"type":"object"},"MessageUpdatedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"005.002"},"channel_type":{"type":"string","x-stream-index":"005.003"},"cid":{"type":"string","x-stream-index":"005.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"team":{"type":"string","x-stream-index":"002.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"message.updated","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at","cid","channel_id","channel_type"],"title":"MessageUpdatedEvent","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"},"MessageWithChannelResponse":{"description":"Represents any chat message","properties":{"attachments":{"description":"Array of message attachments","items":{"$ref":"#/components/schemas/Attachment"},"title":"Message attachments","type":"array","x-stream-docs-page-id":"message_format#attachment-format","x-stream-index":"001.008"},"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel object","title":"Channel","x-stream-index":"002"},"cid":{"description":"Channel unique identifier in \u003ctype\u003e:\u003cid\u003e format","title":"Channel CID","type":"string","x-stream-index":"001.022"},"command":{"description":"Contains provided slash command","title":"Command","type":"string","x-stream-docs-page-id":"custom_commands_webhook","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.023"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.026"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"001.025"},"deleted_for_me":{"type":"boolean","x-stream-index":"001.044"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"001.018"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001.041"},"html":{"description":"Contains HTML markup of the message. Can only be set when using server-side API","title":"HTML content","type":"string","x-stream-index":"001.005"},"i18n":{"additionalProperties":{"type":"string"},"description":"Object with translations. Key `language` contains the original language key. Other keys contain translations","title":"Internationalization info","type":"object","x-stream-docs-page-id":"translation","x-stream-index":"001.030"},"id":{"description":"Message ID is unique string identifier of the message","title":"ID","type":"string","x-stream-index":"001.001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"Contains image moderation information","title":"Image moderation labels","type":"object","x-stream-index":"001.028"},"latest_reactions":{"description":"List of 10 latest reactions to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Latest reactions","type":"array","x-stream-index":"001.009"},"mentioned_users":{"description":"List of mentioned users","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Mentioned Users","type":"array","x-stream-index":"001.029"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"001.036"},"mml":{"description":"Should be empty if `text` is provided. Can only be set when using server-side API","title":"Messaging Markup Language","type":"string","x-stream-docs-page-id":"mml_overview","x-stream-index":"001.003"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"001.039"},"own_reactions":{"description":"List of 10 latest reactions of authenticated user to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Own reactions","type":"array","x-stream-index":"001.010"},"parent_id":{"description":"ID of parent message (thread)","title":"Parent message ID","type":"string","x-stream-docs-page-id":"threads","x-stream-index":"001.015"},"pin_expires":{"description":"Date when pinned message expires","format":"date-time","title":"Pin expiration date","type":"number","x-stream-docs-page-id":"pinned_messages","x-stream-index":"001.035"},"pinned":{"description":"Whether message is pinned or not","title":"Pinned","type":"boolean","x-stream-docs-page-id":"pinned_messages","x-stream-index":"001.032"},"pinned_at":{"description":"Date when message got pinned","format":"date-time","title":"Pinned at","type":"number","x-stream-docs-page-id":"pinned_messages","x-stream-index":"001.033"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","description":"Contains user who pinned the message","title":"Pinned by","x-stream-docs-page-id":"pinned_messages","x-stream-index":"001.034"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001.038"},"poll_id":{"description":"Identifier of the poll to include in the message","title":"Poll ID","type":"string","x-stream-index":"001.037"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","description":"Contains quoted message","title":"Quoted message","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"001.020"},"quoted_message_id":{"title":"ID of quoted message","type":"string","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"001.019"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing number of reactions of each type. Key: reaction type (string), value: number of reactions (int)","title":"Reaction counts","type":"object","x-stream-index":"001.011"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"001.014"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing scores of reactions of each type. Key: reaction type (string), value: total score of reactions (int)","title":"Reaction scores","type":"object","x-stream-index":"001.012"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"001.042"},"reply_count":{"description":"Number of replies to this message","format":"int32","title":"Reply count","type":"integer","x-stream-index":"001.017"},"restricted_visibility":{"description":"A list of user ids that have restricted visibility to the message, if the list is not empty, the message is only visible to the users in the list","items":{"type":"string"},"title":"Restricted visibility","type":"array","x-stream-index":"001.040"},"shadowed":{"description":"Whether the message was shadowed or not","title":"Shadowed","type":"boolean","x-stream-docs-page-id":"moderation#shadow-ban","x-stream-index":"001.027"},"shared_location":{"$ref":"#/components/schemas/SharedLocationResponseData","description":"Contains shared location data","title":"Shared Location","x-stream-index":"001.043"},"show_in_channel":{"description":"Whether thread reply should be shown in the channel as well","title":"Show in channel","type":"boolean","x-stream-docs-page-id":"threads","x-stream-index":"001.016"},"silent":{"description":"Whether message is silent or not","title":"Silent","type":"boolean","x-stream-index":"001.031"},"text":{"description":"Text of the message. Should be empty if `mml` is provided","title":"Text","type":"string","x-stream-index":"001.002"},"thread_participants":{"description":"List of users who participate in thread","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Thread participants","type":"array","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"001.021"},"type":{"description":"Contains type of the message","enum":["regular","ephemeral","error","reply","system","deleted"],"title":"Message Type","type":"string","x-stream-docs-page-id":"message_format#message-types","x-stream-index":"001.006"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.024"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Sender of the message. Required when using server-side API","title":"User object","x-stream-index":"001.007"}},"required":["id","text","html","type","user","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned","restricted_visibility","channel"],"title":"Message","type":"object","x-stream-docs-page-id":"send_message"},"ModerationActionConfig":{"nullable":true,"properties":{"action":{"type":"string","x-stream-index":"006"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"009"},"description":{"type":"string","x-stream-index":"008"},"entity_type":{"type":"string","x-stream-index":"004"},"icon":{"type":"string","x-stream-index":"007"},"order":{"format":"int32","type":"integer","x-stream-index":"005"}},"required":["entity_type","order","action","icon","description","custom"],"type":"object"},"ModerationCheckCompletedEvent":{"description":"This event is sent when a moderation check is completed","nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"entity_id":{"description":"The ID of entity which was moderated","title":"EntityID","type":"string","x-stream-index":"002"},"entity_type":{"description":"The type of the entity which was moderated","title":"EntityType","type":"string","x-stream-index":"003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"recommended_action":{"description":"The recommended action","title":"RecommendedAction","type":"string","x-stream-index":"004"},"review_queue_item_id":{"description":"The review queue item ID","title":"ReviewQueueItemID","type":"string","x-stream-index":"005"},"type":{"default":"moderation_check.completed","type":"string","x-stream-index":"001.002"}},"required":["type","created_at","custom","entity_id","entity_type","recommended_action","review_queue_item_id"],"title":"ModerationCheckCompletedEvent","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"},"ModerationCustomActionEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"001"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"002"},"type":{"default":"moderation.custom_action","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationCustomActionEvent","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"},"ModerationDashboardPreferences":{"properties":{"flag_user_on_flagged_content":{"type":"boolean","x-stream-index":"002"},"media_queue_blur_enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"ModerationFlagResponse":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"015"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"entity_creator_id":{"type":"string","x-stream-index":"007"},"entity_id":{"type":"string","x-stream-index":"006"},"entity_type":{"type":"string","x-stream-index":"005"},"labels":{"items":{"type":"string"},"type":"array","x-stream-index":"011"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"008"},"reason":{"type":"string","x-stream-index":"009"},"result":{"items":{"additionalProperties":{},"type":"object"},"type":"array","x-stream-index":"012"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","x-stream-index":"014"},"review_queue_item_id":{"type":"string","x-stream-index":"013"},"type":{"type":"string","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"016"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"004"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["type","user_id","entity_type","entity_id","result","created_at","updated_at"],"type":"object"},"ModerationFlaggedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"item":{"type":"string","x-stream-index":"001"},"object_id":{"type":"string","x-stream-index":"002"},"type":{"default":"moderation.flagged","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationFlaggedEvent","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"},"ModerationMarkReviewedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"item":{"$ref":"#/components/schemas/ReviewQueueItem","x-stream-index":"001"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"002"},"type":{"default":"moderation.mark_reviewed","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"ModerationMarkReviewedEvent","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"},"ModerationPayload":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"images":{"items":{"type":"string"},"maximum":30,"type":"array","x-stream-index":"002"},"texts":{"items":{"type":"string"},"type":"array","x-stream-index":"001"},"videos":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"type":"object"},"ModerationResponse":{"properties":{"action":{"type":"string","x-stream-index":"004"},"explicit":{"format":"float","type":"number","x-stream-index":"002"},"spam":{"format":"float","type":"number","x-stream-index":"003"},"toxic":{"format":"float","type":"number","x-stream-index":"001"}},"required":["toxic","explicit","spam","action","automod_response"],"type":"object"},"ModerationRuleV2Response":{"properties":{"action":{"$ref":"#/components/schemas/RuleBuilderAction","x-stream-index":"010"},"conditions":{"items":{"$ref":"#/components/schemas/RuleBuilderCondition"},"type":"array","x-stream-index":"007"},"config_keys":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"cooldown_period":{"type":"string","x-stream-index":"011"},"created_at":{"format":"date-time","type":"number","x-stream-index":"013"},"description":{"type":"string","x-stream-index":"003"},"enabled":{"type":"boolean","x-stream-index":"012"},"groups":{"items":{"$ref":"#/components/schemas/RuleBuilderConditionGroup"},"type":"array","x-stream-index":"009"},"id":{"type":"string","x-stream-index":"001"},"logic":{"type":"string","x-stream-index":"008"},"name":{"type":"string","x-stream-index":"002"},"rule_type":{"type":"string","x-stream-index":"006"},"team":{"type":"string","x-stream-index":"005"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"014"}},"required":["id","name","description","config_keys","team","rule_type","action","enabled","created_at","updated_at"],"type":"object"},"ModerationV2Response":{"properties":{"action":{"type":"string","x-stream-index":"001"},"blocklist_matched":{"type":"string","x-stream-index":"005"},"image_harms":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"original_text":{"type":"string","x-stream-index":"002"},"platform_circumvented":{"type":"boolean","x-stream-index":"007"},"semantic_filter_matched":{"type":"string","x-stream-index":"006"},"text_harms":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"required":["action","original_text"],"type":"object"},"MuteChannelRequest":{"nullable":true,"properties":{"channel_cids":{"description":"Channel CIDs to mute (if multiple channels)","items":{"type":"string"},"maximum":25,"title":"Channel CIDs","type":"array","x-stream-index":"002"},"expiration":{"description":"Duration of mute in milliseconds","title":"Expiration","type":"integer","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"type":"object"},"MuteChannelResponse":{"nullable":true,"properties":{"channel_mute":{"$ref":"#/components/schemas/ChannelMute","description":"Object with channel mute (if one channel was muted)","title":"Channel mute","x-stream-index":"001"},"channel_mutes":{"description":"Object with mutes (if multiple channels were muted)","items":{"$ref":"#/components/schemas/ChannelMute"},"title":"Channel mutes","type":"array","x-stream-index":"002"},"duration":{"type":"string","x-stream-index":"004.001"},"own_user":{"$ref":"#/components/schemas/OwnUser","description":"Authorized user object with fresh mutes information","title":"Own user","x-stream-index":"003"}},"required":["duration"],"type":"object"},"MuteRequest":{"nullable":true,"properties":{"target_ids":{"description":"User IDs to mute (if multiple users)","items":{"type":"string"},"title":"Target IDs","type":"array","x-stream-index":"001"},"timeout":{"description":"Duration of mute in minutes","minimum":0,"title":"Timeout","type":"integer","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"required":["target_ids"],"title":"MuteRequest","type":"object"},"MuteResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"004.001"},"mutes":{"description":"Object with mutes (if multiple users were muted)","items":{"$ref":"#/components/schemas/UserMute"},"title":"Mutes","type":"array","x-stream-index":"001"},"non_existing_users":{"description":"A list of users that can't be found. Common cause for this is deleted users","items":{"type":"string"},"title":"Non Existing Users","type":"array","x-stream-index":"003"},"own_user":{"$ref":"#/components/schemas/OwnUser","description":"Authorized user object with fresh mutes information","title":"Own User","x-stream-index":"002"}},"required":["duration"],"title":"MuteResponse","type":"object"},"MuteUsersRequest":{"nullable":true,"properties":{"audio":{"title":"Audio","type":"boolean","x-stream-index":"005"},"mute_all_users":{"type":"boolean","x-stream-index":"003"},"muted_by":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"010"},"muted_by_id":{"type":"string","x-stream-index":"009"},"screenshare":{"title":"Screenshare","type":"boolean","x-stream-index":"007"},"screenshare_audio":{"title":"ScreenshareAudio","type":"boolean","x-stream-index":"008"},"user_ids":{"items":{"type":"string"},"title":"UserIDs","type":"array","x-stream-index":"004"},"video":{"title":"Video","type":"boolean","x-stream-index":"006"}},"title":"MuteUsersRequest","type":"object"},"MuteUsersResponse":{"description":"MuteUsersResponse is the response payload for the mute users endpoint.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"MuteUsersResponse","type":"object"},"NetworkMetricsReportResponse":{"properties":{"average_connection_time":{"format":"float","type":"number","x-stream-index":"003"},"average_jitter":{"format":"float","type":"number","x-stream-index":"002"},"average_latency":{"format":"float","type":"number","x-stream-index":"001"},"average_time_to_reconnect":{"format":"float","type":"number","x-stream-index":"004"}},"type":"object"},"NoiseCancellationSettings":{"properties":{"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode"],"type":"object"},"NotificationConfig":{"properties":{"track_read":{"description":"Whether to track read status","title":"Track Read","type":"boolean","x-stream-index":"002"},"track_seen":{"description":"Whether to track seen status","title":"Track Seen","type":"boolean","x-stream-index":"001"}},"title":"Notification Configuration","type":"object"},"NotificationFeedUpdatedEvent":{"description":"Emitted when notification feed is updated.","nullable":true,"properties":{"aggregated_activities":{"description":"Aggregated activities for notification feeds","items":{"$ref":"#/components/schemas/AggregatedActivityResponse"},"title":"Aggregated Activities","type":"array","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"003.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.001.007"},"feed_visibility":{"type":"string","x-stream-index":"003.003"},"fid":{"description":"The ID of the feed","title":"Feed ID","type":"string","x-stream-index":"003.002"},"notification_status":{"$ref":"#/components/schemas/NotificationStatusResponse","description":"Notification status including unread/unseen counts","title":"Notification Status","x-stream-index":"002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.001.004"},"type":{"default":"feeds.notification_feed.updated","description":"The type of event: \"feeds.notification_feed.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"003.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The user who triggered the notification","title":"User","x-stream-index":"004.001"}},"required":["type","created_at","custom","fid"],"title":"NotificationFeedUpdatedEvent","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"},"NotificationMarkUnreadEvent":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003.004"},"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"003.005"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"first_unread_message_id":{"type":"string","x-stream-index":"005"},"last_read_at":{"format":"date-time","type":"number","x-stream-index":"006"},"last_read_message_id":{"type":"string","x-stream-index":"012"},"team":{"type":"string","x-stream-index":"002.001"},"thread_id":{"type":"string","x-stream-index":"013"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"009"},"type":{"default":"notification.mark_unread","type":"string","x-stream-index":"001.001"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"010"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"008"},"unread_messages":{"format":"int32","type":"integer","x-stream-index":"007"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"011"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["type","created_at","cid","channel_id","channel_type","channel_member_count","first_unread_message_id","last_read_at","unread_messages","unread_count","total_unread_count","unread_channels","unread_threads"],"title":"NotificationMarkUnreadEvent","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"},"NotificationSettings":{"properties":{"call_live_started":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"002"},"call_missed":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"006"},"call_notification":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"004"},"call_ring":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"session_started":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"003"}},"required":["enabled","call_live_started","session_started","call_notification","call_ring","call_missed"],"type":"object"},"NotificationStatusResponse":{"properties":{"last_read_at":{"format":"date-time","type":"number","x-stream-index":"006"},"last_seen_at":{"description":"When notifications were last seen","format":"date-time","title":"Last Seen At","type":"number","x-stream-index":"005"},"read_activities":{"description":"IDs of activities that have been read","items":{"type":"string"},"title":"Read Activities","type":"array","x-stream-index":"003"},"seen_activities":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"unread":{"description":"Number of unread notifications","format":"int32","title":"Unread","type":"integer","x-stream-index":"001"},"unseen":{"description":"Number of unseen notifications","format":"int32","title":"Unseen","type":"integer","x-stream-index":"002"}},"required":["unread","unseen"],"title":"Notification Status","type":"object"},"NullTime":{"type":"object"},"OCRRule":{"properties":{"action":{"enum":["flag","shadow","remove","bounce","bounce_flag","bounce_remove"],"type":"string","x-stream-index":"002"},"label":{"type":"string","x-stream-index":"001"}},"required":["label","action"],"type":"object"},"OnlyUserID":{"properties":{"id":{"type":"string","x-stream-index":"001"}},"required":["id"],"type":"object"},"OwnCapability":{"description":"All possibility of string to use","enum":["block-users","change-max-duration","create-call","create-reaction","enable-noise-cancellation","end-call","join-backstage","join-call","join-ended-call","kick-user","mute-users","pin-for-everyone","read-call","remove-call-member","screenshare","send-audio","send-video","start-broadcast-call","start-closed-captions-call","start-frame-record-call","start-record-call","start-transcription-call","stop-broadcast-call","stop-closed-captions-call","stop-frame-record-call","stop-record-call","stop-transcription-call","update-call","update-call-member","update-call-permissions","update-call-settings"],"title":"OwnCapability","type":"string"},"OwnUser":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"046"},"banned":{"type":"boolean","x-stream-index":"016"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"045"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"029"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"014"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"013"},"devices":{"items":{"$ref":"#/components/schemas/Device"},"type":"array","x-stream-index":"027"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"023"},"language":{"type":"string","x-stream-index":"035"},"last_active":{"format":"date-time","type":"number","x-stream-index":"011"},"last_engaged_at":{"format":"date-time","type":"number","x-stream-index":"012"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"037"},"mutes":{"items":{"$ref":"#/components/schemas/UserMute"},"type":"array","x-stream-index":"028"},"online":{"type":"boolean","x-stream-index":"022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"026"},"push_preferences":{"$ref":"#/components/schemas/PushPreferences","x-stream-index":"025"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"005"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"031"},"total_unread_count_by_team":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"032"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"033"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"030"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"034"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"}},"required":["id","role","custom","created_at","updated_at","banned","online","devices","mutes","channel_mutes","unread_count","total_unread_count","total_unread_count_by_team","unread_channels","unread_threads","language"],"type":"object"},"OwnUserResponse":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"banned":{"type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"015"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.011"},"devices":{"items":{"$ref":"#/components/schemas/DeviceResponse"},"title":"Devices","type":"array","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001.001"},"image":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"005"},"language":{"type":"string","x-stream-index":"001.005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"001.014"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"013"},"mutes":{"items":{"$ref":"#/components/schemas/UserMuteResponse"},"type":"array","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"001.002"},"online":{"type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"003"},"push_preferences":{"$ref":"#/components/schemas/PushPreferences","x-stream-index":"002"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.015"},"role":{"type":"string","x-stream-index":"001.006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"009"},"total_unread_count_by_team":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"010"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"011"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"008"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"012"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","devices","invisible","mutes","channel_mutes","unread_count","total_unread_count","unread_channels","unread_threads"],"type":"object"},"PagerRequest":{"properties":{"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"002"},"prev":{"type":"string","x-stream-index":"003"}},"type":"object"},"PagerResponse":{"properties":{"next":{"type":"string","x-stream-index":"001"},"prev":{"type":"string","x-stream-index":"002"}},"type":"object"},"PaginationParams":{"properties":{"limit":{"format":"int32","minimum":0,"type":"integer","x-stream-index":"001"},"offset":{"format":"int32","type":"integer","x-stream-index":"002"}},"type":"object"},"ParticipantCountByMinuteResponse":{"nullable":true,"properties":{"first":{"format":"int32","type":"integer","x-stream-index":"002"},"last":{"format":"int32","type":"integer","x-stream-index":"003"},"max":{"format":"int32","type":"integer","x-stream-index":"004"},"min":{"format":"int32","type":"integer","x-stream-index":"005"},"start_ts":{"format":"date-time","type":"number","x-stream-index":"001"}},"required":["start_ts","first","last","max","min"],"type":"object"},"ParticipantCountOverTimeResponse":{"properties":{"by_minute":{"items":{"$ref":"#/components/schemas/ParticipantCountByMinuteResponse"},"type":"array","x-stream-index":"001"}},"type":"object"},"ParticipantReportResponse":{"properties":{"by_browser":{"items":{"$ref":"#/components/schemas/GroupedStatsResponse"},"type":"array","x-stream-index":"008"},"by_country":{"items":{"$ref":"#/components/schemas/GroupedStatsResponse"},"type":"array","x-stream-index":"005"},"by_device":{"items":{"$ref":"#/components/schemas/GroupedStatsResponse"},"type":"array","x-stream-index":"006"},"by_operating_system":{"items":{"$ref":"#/components/schemas/GroupedStatsResponse"},"type":"array","x-stream-index":"007"},"count_over_time":{"$ref":"#/components/schemas/ParticipantCountOverTimeResponse","x-stream-index":"004"},"max_concurrent":{"format":"int32","type":"integer","x-stream-index":"003"},"publishers":{"$ref":"#/components/schemas/PublisherStatsResponse","x-stream-index":"009"},"subscribers":{"$ref":"#/components/schemas/SubscriberStatsResponse","x-stream-index":"010"},"sum":{"format":"int32","type":"integer","x-stream-index":"001"},"unique":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["sum","unique"],"type":"object"},"PendingMessageEvent":{"description":"Pending message event for async moderation","nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"002.007"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"message":{"$ref":"#/components/schemas/Message","description":"The pending message","title":"Message","x-stream-index":"002.009"},"metadata":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"002.010"},"method":{"description":"The method used for the pending message","title":"Method","type":"string","x-stream-index":"003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"type":{"default":"message.pending","description":"The type of event: \"message.pending\" in this case","title":"Event Type","type":"string","x-stream-index":"001.002"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.002"}},"required":["type","custom","method","created_at"],"title":"PendingMessageEvent","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"},"PendingMessageResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"002"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"003"},"metadata":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"}},"type":"object"},"PerSDKUsageReport":{"nullable":true,"properties":{"by_version":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"002"},"total":{"format":"int32","type":"integer","x-stream-index":"001"}},"required":["total","by_version"],"type":"object"},"Permission":{"properties":{"action":{"description":"Action name this permission is for (e.g. SendMessage)","title":"Action","type":"string","x-stream-index":"004"},"condition":{"additionalProperties":{},"description":"MongoDB style condition which decides whether or not the permission is granted","title":"Condition","type":"object","x-stream-index":"007"},"custom":{"description":"Whether this is a custom permission or built-in","title":"Custom","type":"boolean","x-stream-index":"009"},"description":{"description":"Description of the permission","title":"Description","type":"string","x-stream-index":"003"},"id":{"description":"Unique permission ID","title":"ID","type":"string","x-stream-index":"001"},"level":{"description":"Level at which permission could be applied (app or channel)","enum":["app","channel"],"title":"Level","type":"string","x-stream-index":"010"},"name":{"description":"Name of the permission","title":"Name","type":"string","x-stream-index":"002"},"owner":{"description":"Whether this permission applies to resource owner or not","title":"Owner","type":"boolean","x-stream-index":"005"},"same_team":{"description":"Whether this permission applies to teammates (multi-tenancy mode only)","title":"Same team","type":"boolean","x-stream-index":"006"},"tags":{"description":"List of tags of the permission","items":{"type":"string"},"title":"Tags","type":"array","x-stream-index":"011"}},"required":["id","name","description","action","owner","same_team","custom","level","tags"],"type":"object"},"PermissionRequestEvent":{"description":"This event is sent when a user requests access to a feature on a call,\nclients receiving this event should display a permission request to the user","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"permissions":{"description":"The list of permissions requested by the user","items":{"type":"string"},"title":"Permissions","type":"array","x-stream-index":"004"},"type":{"default":"call.permission_request","description":"The type of event: \"call.permission_request\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who sent the permission request","title":"User","x-stream-index":"003"}},"required":["type","created_at","call_cid","user","permissions"],"title":"PermissionRequestEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"PinActivityRequest":{"nullable":true,"properties":{"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"005.002"},"user_id":{"type":"string","x-stream-index":"005.001"}},"title":"Pin Activity Request","type":"object"},"PinActivityResponse":{"nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","description":"The pinned activity","title":"Activity","x-stream-index":"001"},"created_at":{"description":"When the activity was pinned","format":"date-time","title":"Created At","type":"number","x-stream-index":"004"},"duration":{"type":"string","x-stream-index":"005.001"},"feed":{"description":"Fully qualified ID of the feed the activity was pinned to","title":"Feed ID","type":"string","x-stream-index":"002"},"user_id":{"description":"ID of the user who pinned the activity","title":"User ID","type":"string","x-stream-index":"003"}},"required":["activity","feed","user_id","created_at","duration"],"title":"Pin Activity Response","type":"object"},"PinRequest":{"description":"PinRequest is the payload for pinning a message.","nullable":true,"properties":{"session_id":{"description":"the session ID of the user who pinned the message","title":"SessionID","type":"string","x-stream-index":"003"},"user_id":{"description":"the user ID of the user who pinned the message","title":"UserID","type":"string","x-stream-index":"002"}},"required":["user_id","session_id"],"title":"PinRequest","type":"object"},"PinResponse":{"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"},"PlatformDataResponse":{"properties":{"browser":{"$ref":"#/components/schemas/BrowserDataResponse","x-stream-index":"003"},"device":{"$ref":"#/components/schemas/DeviceDataResponse","x-stream-index":"002"},"os":{"$ref":"#/components/schemas/ClientOSDataResponse","x-stream-index":"001"}},"required":["os","device","browser"],"type":"object"},"Policy":{"properties":{"action":{"type":"integer","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"010"},"name":{"type":"string","x-stream-index":"004"},"owner":{"type":"boolean","x-stream-index":"008"},"priority":{"format":"int32","type":"integer","x-stream-index":"009"},"resources":{"items":{"type":"string"},"type":"array","x-stream-index":"005"},"roles":{"items":{"type":"string"},"type":"array","x-stream-index":"006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"011"}},"required":["name","resources","roles","action","owner","priority","created_at","updated_at"],"type":"object"},"PolicyRequest":{"description":"Policy request","properties":{"action":{"enum":["Deny","Allow"],"title":"Action","type":"string","x-stream-index":"001"},"name":{"description":"User-friendly policy name","title":"Name","type":"string","x-stream-index":"002"},"owner":{"description":"Whether policy applies to resource owner or not","title":"Owner","type":"boolean","x-stream-index":"005"},"priority":{"description":"Policy priority","format":"int32","maximum":999,"minimum":1,"title":"Priority","type":"integer","x-stream-index":"006"},"resources":{"description":"List of resources to apply policy to","items":{"type":"string"},"minimum":1,"title":"Resources","type":"array","x-stream-index":"003"},"roles":{"description":"List of roles to apply policy to","items":{"type":"string"},"title":"Roles","type":"array","x-stream-index":"004"}},"required":["action","name","resources","roles","owner","priority"],"title":"PolicyRequest","type":"object"},"Poll":{"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"023"},"allow_answers":{"type":"boolean","x-stream-index":"010"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"009"},"answers_count":{"format":"int32","type":"integer","x-stream-index":"015"},"created_at":{"format":"date-time","type":"number","x-stream-index":"021"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"020"},"created_by_id":{"type":"string","x-stream-index":"019"},"description":{"type":"string","x-stream-index":"005"},"enforce_unique_vote":{"type":"boolean","x-stream-index":"007"},"id":{"type":"string","x-stream-index":"003"},"is_closed":{"type":"boolean","x-stream-index":"011"},"latest_answers":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array","x-stream-index":"017"},"latest_votes_by_option":{"additionalProperties":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array"},"type":"object","x-stream-index":"016"},"max_votes_allowed":{"format":"int32","type":"integer","x-stream-index":"008"},"name":{"type":"string","x-stream-index":"004"},"options":{"items":{"$ref":"#/components/schemas/PollOption"},"type":"array","x-stream-index":"013"},"own_votes":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array","x-stream-index":"018"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"022"},"vote_count":{"format":"int32","type":"integer","x-stream-index":"012"},"vote_counts_by_option":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"014"},"voting_visibility":{"type":"string","x-stream-index":"006"}},"required":["id","name","description","enforce_unique_vote","allow_user_suggested_options","allow_answers","vote_count","options","vote_counts_by_option","answers_count","latest_votes_by_option","latest_answers","own_votes","created_by_id","created_at","updated_at","Custom"],"type":"object"},"PollOption":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id","text","custom"],"type":"object"},"PollOptionInput":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"text":{"type":"string","x-stream-index":"002"}},"type":"object"},"PollOptionRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id"],"type":"object"},"PollOptionResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"poll_option":{"$ref":"#/components/schemas/PollOptionResponseData","description":"Poll option","title":"PollOptionResponseData","x-stream-index":"001"}},"required":["poll_option","duration"],"type":"object"},"PollOptionResponseData":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id","text","custom"],"type":"object"},"PollResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"poll":{"$ref":"#/components/schemas/PollResponseData","description":"Poll","title":"PollResponseData","x-stream-index":"001"}},"required":["poll","duration"],"type":"object"},"PollResponseData":{"properties":{"allow_answers":{"type":"boolean","x-stream-index":"008"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"007"},"answers_count":{"format":"int32","type":"integer","x-stream-index":"012"},"created_at":{"format":"date-time","type":"number","x-stream-index":"019"},"created_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"018"},"created_by_id":{"type":"string","x-stream-index":"017"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"021"},"description":{"type":"string","x-stream-index":"003"},"enforce_unique_vote":{"type":"boolean","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"is_closed":{"type":"boolean","x-stream-index":"009"},"latest_answers":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array","x-stream-index":"015"},"latest_votes_by_option":{"additionalProperties":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array"},"type":"object","x-stream-index":"014"},"max_votes_allowed":{"format":"int32","type":"integer","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"002"},"options":{"items":{"$ref":"#/components/schemas/PollOptionResponseData"},"type":"array","x-stream-index":"011"},"own_votes":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array","x-stream-index":"016"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"020"},"vote_count":{"format":"int32","type":"integer","x-stream-index":"010"},"vote_counts_by_option":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"013"},"voting_visibility":{"type":"string","x-stream-index":"004"}},"required":["id","name","description","voting_visibility","enforce_unique_vote","allow_user_suggested_options","allow_answers","vote_count","options","answers_count","vote_counts_by_option","latest_votes_by_option","latest_answers","own_votes","created_by_id","created_at","updated_at","custom"],"type":"object"},"PollVote":{"nullable":true,"properties":{"answer_text":{"type":"string","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"004"},"is_answer":{"type":"boolean","x-stream-index":"006"},"option_id":{"type":"string","x-stream-index":"005"},"poll_id":{"type":"string","x-stream-index":"003"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"011"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"009"},"user_id":{"type":"string","x-stream-index":"008"}},"required":["poll_id","id","option_id","created_at","updated_at"],"type":"object"},"PollVoteResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"vote":{"$ref":"#/components/schemas/PollVoteResponseData","description":"Poll vote","title":"PollVoteResponseData","x-stream-index":"001"}},"required":["duration"],"type":"object"},"PollVoteResponseData":{"nullable":true,"properties":{"answer_text":{"type":"string","x-stream-index":"005"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"id":{"type":"string","x-stream-index":"002"},"is_answer":{"type":"boolean","x-stream-index":"004"},"option_id":{"type":"string","x-stream-index":"003"},"poll_id":{"type":"string","x-stream-index":"001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"007"},"user_id":{"type":"string","x-stream-index":"006"}},"required":["poll_id","id","option_id","created_at","updated_at"],"type":"object"},"PollVotesResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"votes":{"description":"Poll votes","items":{"$ref":"#/components/schemas/PollVoteResponseData"},"title":"PollVoteResponseList","type":"array","x-stream-index":"001"}},"required":["votes","duration"],"type":"object"},"PrivacySettings":{"properties":{"read_receipts":{"$ref":"#/components/schemas/ReadReceipts","x-stream-index":"002"},"typing_indicators":{"$ref":"#/components/schemas/TypingIndicators","x-stream-index":"001"}},"type":"object"},"PrivacySettingsResponse":{"properties":{"read_receipts":{"$ref":"#/components/schemas/ReadReceiptsResponse","x-stream-index":"002"},"typing_indicators":{"$ref":"#/components/schemas/TypingIndicatorsResponse","x-stream-index":"001"}},"type":"object"},"PublisherAllMetrics":{"properties":{"audio":{"$ref":"#/components/schemas/PublisherAudioMetrics","x-stream-index":"001"},"rtt_ms":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"003"},"video":{"$ref":"#/components/schemas/PublisherVideoMetrics","x-stream-index":"002"}},"type":"object"},"PublisherAudioMetrics":{"properties":{"jitter_ms":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"001"}},"type":"object"},"PublisherStatsResponse":{"properties":{"by_track":{"items":{"$ref":"#/components/schemas/TrackStatsResponse"},"type":"array","x-stream-index":"003"},"total":{"format":"int32","type":"integer","x-stream-index":"001"},"unique":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["total","unique"],"type":"object"},"PublisherVideoMetrics":{"properties":{"bitrate":{"$ref":"#/components/schemas/ActiveCallsBitrateStats","x-stream-index":"005"},"fps_30":{"$ref":"#/components/schemas/ActiveCallsFPSStats","x-stream-index":"002"},"frame_encoding_time_ms":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"003"},"jitter_ms":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"001"},"resolution":{"$ref":"#/components/schemas/ActiveCallsResolutionStats","x-stream-index":"004"}},"type":"object"},"PublishersMetrics":{"properties":{"all":{"$ref":"#/components/schemas/PublisherAllMetrics","x-stream-index":"001"}},"type":"object"},"PushConfig":{"properties":{"offline_only":{"type":"boolean","x-stream-index":"002"},"version":{"enum":["v1","v2","v3"],"type":"string","x-stream-index":"001"}},"required":["version"],"type":"object"},"PushNotificationConfig":{"properties":{"activity_types":{"enum":["follow","comment","reaction","comment_reaction"],"items":{"type":"string"},"type":"array","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"PushNotificationFields":{"properties":{"apn":{"$ref":"#/components/schemas/APNConfigFields","x-stream-index":"002"},"firebase":{"$ref":"#/components/schemas/FirebaseConfigFields","x-stream-index":"003"},"huawei":{"$ref":"#/components/schemas/HuaweiConfigFields","x-stream-index":"004"},"offline_only":{"type":"boolean","x-stream-index":"001.002"},"providers":{"items":{"$ref":"#/components/schemas/PushProvider"},"type":"array","x-stream-index":"006"},"version":{"type":"string","x-stream-index":"001.001"},"xiaomi":{"$ref":"#/components/schemas/XiaomiConfigFields","x-stream-index":"005"}},"required":["version","offline_only","apn","firebase","huawei","xiaomi"],"type":"object"},"PushNotificationSettingsResponse":{"properties":{"disabled":{"type":"boolean","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"number","x-stream-index":"002"}},"type":"object"},"PushPreferenceInput":{"nullable":true,"properties":{"call_level":{"description":"Set the level of call push notifications for the user. One of all, none, default","enum":["all","none","default"],"type":"string","x-stream-index":"004"},"channel_cid":{"description":"Set the push preferences for a specific channel. If empty it sets the default for the user","type":"string","x-stream-index":"002"},"chat_level":{"description":"Set the level of chat push notifications for the user. One of all, mentions, none, default","enum":["all","mentions","none","default"],"type":"string","x-stream-index":"003"},"disabled_until":{"description":"Disable push notifications till a certain time","format":"date-time","type":"number","x-stream-index":"007"},"feeds_events":{"$ref":"#/components/schemas/FeedsEventPreferencesInput","description":"Set granular feeds event preferences for reactions, comments, new followers, and mentions","x-stream-index":"006"},"feeds_level":{"description":"Set the level of feeds push notifications for the user. One of all, none, default","enum":["all","none","default"],"type":"string","x-stream-index":"005"},"remove_disable":{"description":"Remove the disabled until time. (IE stop snoozing notifications)","type":"boolean","x-stream-index":"008"},"user_id":{"description":"The user id for which to set the push preferences. Required when using server side auths, defaults to current user with client side auth.","type":"string","x-stream-index":"001"}},"type":"object"},"PushPreferences":{"properties":{"call_level":{"type":"string","x-stream-index":"002"},"chat_level":{"type":"string","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"number","x-stream-index":"005"},"feeds_events":{"$ref":"#/components/schemas/FeedsEventPreferences","x-stream-index":"004"},"feeds_level":{"type":"string","x-stream-index":"003"}},"type":"object"},"PushProvider":{"nullable":true,"properties":{"apn_auth_key":{"type":"string","x-stream-index":"012"},"apn_auth_type":{"type":"string","x-stream-index":"017"},"apn_development":{"type":"boolean","x-stream-index":"018"},"apn_host":{"type":"string","x-stream-index":"019"},"apn_key_id":{"type":"string","x-stream-index":"013"},"apn_notification_template":{"type":"string","x-stream-index":"020"},"apn_p12_cert":{"type":"string","x-stream-index":"014"},"apn_team_id":{"type":"string","x-stream-index":"015"},"apn_topic":{"type":"string","x-stream-index":"016"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"description":{"maxLength":128,"type":"string","x-stream-index":"007"},"disabled_at":{"format":"date-time","type":"number","x-stream-index":"010"},"disabled_reason":{"maxLength":255,"type":"string","x-stream-index":"011"},"firebase_apn_template":{"type":"string","x-stream-index":"025"},"firebase_credentials":{"type":"string","x-stream-index":"022"},"firebase_data_template":{"type":"string","x-stream-index":"023"},"firebase_host":{"type":"string","x-stream-index":"026"},"firebase_notification_template":{"type":"string","x-stream-index":"024"},"firebase_server_key":{"type":"string","x-stream-index":"021"},"huawei_app_id":{"type":"string","x-stream-index":"027"},"huawei_app_secret":{"type":"string","x-stream-index":"028"},"name":{"maxLength":36,"minLength":1,"type":"string","x-stream-index":"005"},"push_templates":{"items":{"$ref":"#/components/schemas/PushTemplate"},"type":"array","x-stream-index":"031"},"type":{"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"xiaomi_app_secret":{"type":"string","x-stream-index":"030"},"xiaomi_package_name":{"type":"string","x-stream-index":"029"}},"required":["name","type","created_at","updated_at"],"type":"object"},"PushProviderResponse":{"properties":{"apn_auth_key":{"type":"string","x-stream-index":"008"},"apn_auth_type":{"type":"string","x-stream-index":"013"},"apn_development":{"type":"boolean","x-stream-index":"014"},"apn_host":{"type":"string","x-stream-index":"015"},"apn_key_id":{"type":"string","x-stream-index":"009"},"apn_p12_cert":{"type":"string","x-stream-index":"010"},"apn_sandbox_certificate":{"type":"boolean","x-stream-index":"016"},"apn_supports_remote_notifications":{"type":"boolean","x-stream-index":"018"},"apn_supports_voip_notifications":{"type":"boolean","x-stream-index":"017"},"apn_team_id":{"type":"string","x-stream-index":"011"},"apn_topic":{"type":"string","x-stream-index":"012"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"description":{"type":"string","x-stream-index":"003"},"disabled_at":{"format":"date-time","type":"number","x-stream-index":"006"},"disabled_reason":{"type":"string","x-stream-index":"007"},"firebase_apn_template":{"type":"string","x-stream-index":"023"},"firebase_credentials":{"type":"string","x-stream-index":"020"},"firebase_data_template":{"type":"string","x-stream-index":"021"},"firebase_host":{"type":"string","x-stream-index":"024"},"firebase_notification_template":{"type":"string","x-stream-index":"022"},"firebase_server_key":{"type":"string","x-stream-index":"019"},"huawei_app_id":{"type":"string","x-stream-index":"025"},"huawei_app_secret":{"type":"string","x-stream-index":"026"},"name":{"type":"string","x-stream-index":"001"},"type":{"type":"string","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"005"},"xiaomi_app_secret":{"type":"string","x-stream-index":"028"},"xiaomi_package_name":{"type":"string","x-stream-index":"027"}},"required":["name","type","created_at","updated_at"],"type":"object"},"PushTemplate":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"enable_push":{"type":"boolean","x-stream-index":"003"},"event_type":{"enum":["message.new","message.updated","reaction.new","notification.reminder_due","feeds.activity.added","feeds.comment.added","feeds.activity.reaction.added","feeds.comment.reaction.added","feeds.follow.created","feeds.notification_feed.updated"],"type":"string","x-stream-index":"005"},"template":{"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"008"}},"required":["enable_push","event_type","created_at","updated_at"],"type":"object"},"Quality":{"properties":{"bitdepth":{"format":"int32","type":"integer","x-stream-index":"007"},"framerate":{"format":"int32","type":"integer","x-stream-index":"008"},"height":{"format":"int32","type":"integer","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"004"},"video_bitrate":{"format":"int32","type":"integer","x-stream-index":"009"},"width":{"format":"int32","type":"integer","x-stream-index":"005"}},"type":"object"},"QualityScoreReport":{"properties":{"histogram":{"items":{"$ref":"#/components/schemas/ReportByHistogramBucket"},"type":"array","x-stream-index":"001"}},"required":["histogram"],"type":"object"},"QualityScoreReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateQualityScoreReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"QueryActivitiesRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filters to apply to the query. Supports location-based queries with 'near' and 'within_bounds' operators.","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"Sorting parameters for the query","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"002"}},"title":"Query Activities Request","type":"object"},"QueryActivitiesResponse":{"nullable":true,"properties":{"activities":{"description":"List of activities matching the query","items":{"$ref":"#/components/schemas/ActivityResponse"},"title":"Activities","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"next":{"description":"Cursor for next page","title":"Next","type":"string","x-stream-index":"002.001"},"prev":{"description":"Cursor for previous page","title":"Previous","type":"string","x-stream-index":"002.002"}},"required":["activities","duration"],"title":"Query Activities Response","type":"object"},"QueryActivityReactionsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"type":"object","x-stream-index":"002"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"004.001"},"next":{"type":"string","x-stream-index":"004.002"},"prev":{"type":"string","x-stream-index":"004.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"type":"array","x-stream-index":"003"}},"type":"object"},"QueryActivityReactionsResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"reactions":{"items":{"$ref":"#/components/schemas/FeedsReactionResponse"},"type":"array","x-stream-index":"001"}},"required":["reactions","duration"],"title":"Response","type":"object"},"QueryAggregateCallStatsRequest":{"nullable":true,"properties":{"from":{"type":"string","x-stream-index":"002"},"report_types":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"to":{"type":"string","x-stream-index":"003"}},"type":"object"},"QueryAggregateCallStatsResponse":{"description":"Basic response information","nullable":true,"properties":{"call_duration_report":{"$ref":"#/components/schemas/CallDurationReportResponse","x-stream-index":"002"},"call_participant_count_report":{"$ref":"#/components/schemas/CallParticipantCountReportResponse","x-stream-index":"004"},"calls_per_day_report":{"$ref":"#/components/schemas/CallsPerDayReportResponse","x-stream-index":"003"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"network_metrics_report":{"$ref":"#/components/schemas/NetworkMetricsReportResponse","x-stream-index":"008"},"quality_score_report":{"$ref":"#/components/schemas/QualityScoreReportResponse","x-stream-index":"005"},"sdk_usage_report":{"$ref":"#/components/schemas/SDKUsageReportResponse","x-stream-index":"006"},"user_feedback_report":{"$ref":"#/components/schemas/UserFeedbackReportResponse","x-stream-index":"007"}},"required":["duration"],"title":"Response","type":"object"},"QueryBannedUsersPayload":{"properties":{"exclude_expired_bans":{"description":"Whether to exclude expired bans or not","title":"Exclude expired bans","type":"boolean","x-stream-index":"004"},"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"description":"Number of records to return","format":"int32","maximum":300,"minimum":0,"title":"Limit","type":"integer","x-stream-index":"003.003"},"offset":{"description":"Number of records to offset","format":"int32","maximum":10000,"title":"Offset","type":"integer","x-stream-index":"003.004"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":1,"title":"Sort","type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"005.002"},"user_id":{"type":"string","x-stream-index":"005.001"}},"required":["filter_conditions"],"type":"object"},"QueryBannedUsersResponse":{"nullable":true,"properties":{"bans":{"description":"List of found bans","items":{"$ref":"#/components/schemas/BanResponse"},"title":"BanResponse","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["bans","duration"],"type":"object"},"QueryBookmarkFoldersRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filters to apply to the query","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"Sorting parameters for the query","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"002"}},"title":"Query Bookmark Folders Request","type":"object"},"QueryBookmarkFoldersResponse":{"nullable":true,"properties":{"bookmark_folders":{"description":"List of bookmark folders matching the query","items":{"$ref":"#/components/schemas/BookmarkFolderResponse"},"title":"Bookmark Folders","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"next":{"description":"Cursor for next page","title":"Next","type":"string","x-stream-index":"002.001"},"prev":{"description":"Cursor for previous page","title":"Previous","type":"string","x-stream-index":"002.002"}},"required":["bookmark_folders","duration"],"title":"Query Bookmark Folders Response","type":"object"},"QueryBookmarksRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filters to apply to the query","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"Sorting parameters for the query","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"002"}},"title":"Query Bookmarks Request","type":"object"},"QueryBookmarksResponse":{"nullable":true,"properties":{"bookmarks":{"description":"List of bookmarks matching the query","items":{"$ref":"#/components/schemas/BookmarkResponse"},"title":"Bookmarks","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"next":{"description":"Cursor for next page","title":"Next","type":"string","x-stream-index":"002.001"},"prev":{"description":"Cursor for previous page","title":"Previous","type":"string","x-stream-index":"002.002"}},"required":["bookmarks","duration"],"title":"Query Bookmarks Response","type":"object"},"QueryCallMembersRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"002"},"id":{"maxLength":64,"type":"string","x-stream-index":"001.002"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"004.001"},"next":{"type":"string","x-stream-index":"004.002"},"prev":{"type":"string","x-stream-index":"004.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":1,"type":"array","x-stream-index":"003"},"type":{"maxLength":64,"type":"string","x-stream-index":"001.001"}},"required":["type","id"],"type":"object"},"QueryCallMembersResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["members","duration"],"title":"Response","type":"object"},"QueryCallParticipantsRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"003"}},"type":"object"},"QueryCallParticipantsResponse":{"nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001.001"},"duration":{"type":"string","x-stream-index":"004.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001.002"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"001.004"},"participants":{"description":"List of call participants","items":{"$ref":"#/components/schemas/CallParticipantResponse"},"title":"[]CallParticipantResponse","type":"array","x-stream-index":"002"},"total_participants":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["call","members","own_capabilities","blocked_users","participants","total_participants","duration"],"type":"object"},"QueryCallStatsRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"004.001"},"next":{"type":"string","x-stream-index":"004.002"},"prev":{"type":"string","x-stream-index":"004.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":2,"type":"array","x-stream-index":"002"}},"type":"object"},"QueryCallStatsResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"next":{"type":"string","x-stream-index":"003.001"},"prev":{"type":"string","x-stream-index":"003.002"},"reports":{"items":{"$ref":"#/components/schemas/CallStatsReportSummaryResponse"},"type":"array","x-stream-index":"001"}},"required":["reports","duration"],"title":"Response","type":"object"},"QueryCallsRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"title":"Filters","type":"object","x-stream-index":"003"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"006.001"},"next":{"type":"string","x-stream-index":"006.002"},"prev":{"type":"string","x-stream-index":"006.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":2,"title":"Sort","type":"array","x-stream-index":"004"}},"title":"QueryCallsRequest","type":"object"},"QueryCallsResponse":{"nullable":true,"properties":{"calls":{"items":{"$ref":"#/components/schemas/CallStateResponseFields"},"title":"Calls","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["calls","duration"],"title":"QueryCallsResponse","type":"object"},"QueryCampaignsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"004.001"},"next":{"type":"string","x-stream-index":"004.002"},"prev":{"type":"string","x-stream-index":"004.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"type":"array","x-stream-index":"002"},"user_limit":{"format":"int32","maximum":1000,"minimum":0,"type":"integer","x-stream-index":"003"}},"type":"object"},"QueryCampaignsResponse":{"description":"Basic response information","nullable":true,"properties":{"campaigns":{"items":{"$ref":"#/components/schemas/CampaignResponse"},"type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["campaigns","duration"],"title":"Response","type":"object"},"QueryChannelsRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"description":"Number of channels to limit","format":"int32","title":"Limit","type":"integer","x-stream-index":"008"},"member_limit":{"description":"Number of members to limit","format":"int32","maximum":100,"minimum":0,"title":"Member limit","type":"integer","x-stream-index":"007"},"message_limit":{"description":"Number of messages to limit","format":"int32","minimum":0,"title":"Message limit","type":"integer","x-stream-index":"006"},"offset":{"description":"Channel pagination offset","format":"int32","title":"Offset","type":"integer","x-stream-index":"009"},"sort":{"description":"List of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"002"},"state":{"description":"Whether to update channel state or not","title":"State","type":"boolean","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"010.002"},"user_id":{"type":"string","x-stream-index":"010.001"}},"title":"Query Channels Request","type":"object","x-stream-docs-page-id":"query_channels"},"QueryChannelsResponse":{"nullable":true,"properties":{"channels":{"description":"List of channels","items":{"$ref":"#/components/schemas/ChannelStateResponseFields"},"title":"Channels","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["channels","duration"],"title":"Channels list","type":"object"},"QueryCommentReactionsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"type":"object","x-stream-index":"002"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"004.001"},"next":{"type":"string","x-stream-index":"004.002"},"prev":{"type":"string","x-stream-index":"004.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"type":"array","x-stream-index":"003"}},"type":"object"},"QueryCommentReactionsResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"reactions":{"items":{"$ref":"#/components/schemas/FeedsReactionResponse"},"type":"array","x-stream-index":"001"}},"required":["reactions","duration"],"title":"Response","type":"object"},"QueryCommentsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"MongoDB-style filter for querying comments","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"description":"Maximum number of comments to return","format":"int32","maximum":100,"minimum":0,"title":"Limit","type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"first (oldest), last (newest) or top","enum":["first","last","top","best","controversial"],"title":"Sort Order","type":"string","x-stream-index":"002"}},"required":["filter"],"title":"Query Comments Request","type":"object"},"QueryCommentsResponse":{"nullable":true,"properties":{"comments":{"description":"List of comments matching the query","items":{"$ref":"#/components/schemas/CommentResponse"},"title":"Comments","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"next":{"description":"Cursor for next page","title":"Next","type":"string","x-stream-index":"002.001"},"prev":{"description":"Cursor for previous page","title":"Previous","type":"string","x-stream-index":"002.002"}},"required":["comments","duration"],"title":"Query Comments Response","type":"object"},"QueryDraftsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","maximum":3,"title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"type":"object"},"QueryDraftsResponse":{"nullable":true,"properties":{"drafts":{"description":"Drafts","items":{"$ref":"#/components/schemas/DraftResponse"},"title":"DraftsResponseList","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["drafts","duration"],"type":"object"},"QueryFeedMembersRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter parameters for the query","title":"object","type":"object","x-stream-index":"003"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Sort parameters for the query","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"array","type":"array","x-stream-index":"004"}},"type":"object"},"QueryFeedMembersResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"003.001"},"members":{"description":"List of feed members","items":{"$ref":"#/components/schemas/FeedMemberResponse"},"title":"array","type":"array","x-stream-index":"001"},"next":{"description":"Cursor for next page","title":"Next","type":"string","x-stream-index":"002.001"},"prev":{"description":"Cursor for previous page","title":"Previous","type":"string","x-stream-index":"002.002"}},"required":["members","duration"],"type":"object"},"QueryFeedModerationTemplate":{"properties":{"config":{"$ref":"#/components/schemas/FeedsModerationTemplateConfig","description":"Configuration for the moderation template","title":"Config","x-stream-index":"002"},"created_at":{"description":"When the template was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"003"},"name":{"description":"Name of the moderation template","title":"Name","type":"string","x-stream-index":"001"},"updated_at":{"description":"When the template was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"004"}},"required":["name","created_at","updated_at"],"type":"object"},"QueryFeedModerationTemplatesResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"templates":{"description":"List of moderation templates","items":{"$ref":"#/components/schemas/QueryFeedModerationTemplate"},"title":"Templates","type":"array","x-stream-index":"001"}},"required":["templates","duration"],"type":"object"},"QueryFeedsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filters to apply to the query","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"004.001"},"next":{"type":"string","x-stream-index":"004.002"},"prev":{"type":"string","x-stream-index":"004.003"},"sort":{"description":"Sorting parameters for the query","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"003"},"watch":{"description":"Whether to subscribe to realtime updates","title":"Watch","type":"boolean","x-stream-index":"002"}},"title":"Query Feeds Request","type":"object"},"QueryFeedsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"003.001"},"feeds":{"description":"List of feeds matching the query","items":{"$ref":"#/components/schemas/FeedResponse"},"title":"Feeds","type":"array","x-stream-index":"001"},"next":{"description":"Cursor for next page","title":"Next","type":"string","x-stream-index":"002.001"},"prev":{"description":"Cursor for previous page","title":"Previous","type":"string","x-stream-index":"002.002"}},"required":["feeds","duration"],"title":"Query Feeds Response","type":"object"},"QueryFollowsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filters to apply to the query","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"Sorting parameters for the query","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"002"}},"title":"Query Follows Request","type":"object"},"QueryFollowsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"003.001"},"follows":{"description":"List of follow relationships matching the query","items":{"$ref":"#/components/schemas/FollowResponse"},"title":"Follows","type":"array","x-stream-index":"001"},"next":{"description":"Cursor for next page","title":"Next","type":"string","x-stream-index":"002.001"},"prev":{"description":"Cursor for previous page","title":"Previous","type":"string","x-stream-index":"002.002"}},"required":["follows","duration"],"title":"Query Follows Response","type":"object"},"QueryMembersPayload":{"description":"Client request","properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"002"},"limit":{"format":"int32","maximum":300,"minimum":0,"type":"integer","x-stream-index":"006.003"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"type":"array","x-stream-index":"003"},"offset":{"format":"int32","maximum":10000,"type":"integer","x-stream-index":"006.004"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":1,"type":"array","x-stream-index":"005"},"type":{"maxLength":64,"type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"007.002"},"user_id":{"type":"string","x-stream-index":"007.001"}},"required":["type","filter_conditions"],"title":"ClientRequest","type":"object"},"QueryMembershipLevelsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filters to apply to the query","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"Sorting parameters for the query","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"002"}},"title":"Query Membership Levels Request","type":"object"},"QueryMembershipLevelsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"003.001"},"membership_levels":{"items":{"$ref":"#/components/schemas/MembershipLevelResponse"},"type":"array","x-stream-index":"001"},"next":{"description":"Cursor for next page","title":"Next","type":"string","x-stream-index":"002.001"},"prev":{"description":"Cursor for previous page","title":"Previous","type":"string","x-stream-index":"002.002"}},"required":["membership_levels","duration"],"title":"Query Membership Levels Response","type":"object"},"QueryMessageFlagsPayload":{"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":300,"minimum":0,"type":"integer","x-stream-index":"003.003"},"offset":{"format":"int32","maximum":10000,"type":"integer","x-stream-index":"003.004"},"show_deleted_messages":{"description":"Whether to include deleted messages in the results","title":"ShowDeletedMessages","type":"boolean","x-stream-index":"002"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"type":"array","x-stream-index":"003.005"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"type":"object"},"QueryMessageFlagsResponse":{"description":"Query message flags response","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"flags":{"description":"The flags that match the query","items":{"$ref":"#/components/schemas/MessageFlagResponse"},"title":"MessageFlagResponseList","type":"array","x-stream-index":"001"}},"required":["flags","duration"],"title":"QueryMessageFlagsResponse","type":"object"},"QueryMessageHistoryRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","maximum":3,"minimum":1,"title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"004.001"},"next":{"type":"string","x-stream-index":"004.002"},"prev":{"type":"string","x-stream-index":"004.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"002"}},"required":["filter"],"type":"object"},"QueryMessageHistoryResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message_history":{"description":"Message history entries","items":{"$ref":"#/components/schemas/MessageHistoryEntryResponse"},"title":"MessageHistoryEntryResponseList","type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["message_history","duration"],"type":"object"},"QueryModerationConfigsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter conditions for moderation configs","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"Sorting parameters for the results","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"type":"object"},"QueryModerationConfigsResponse":{"nullable":true,"properties":{"configs":{"description":"List of moderation configurations","items":{"$ref":"#/components/schemas/ConfigResponse"},"title":"Configs","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["configs","duration"],"type":"object"},"QueryModerationFlagsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParam"},"type":"array","x-stream-index":"002"}},"type":"object"},"QueryModerationFlagsResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"flags":{"items":{"$ref":"#/components/schemas/ModerationFlagResponse"},"type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["flags","duration"],"title":"Response","type":"object"},"QueryModerationLogsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter conditions for moderation logs","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"Sorting parameters for the results","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"type":"object"},"QueryModerationLogsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"003.001"},"logs":{"description":"List of moderation action logs","items":{"$ref":"#/components/schemas/ActionLogResponse"},"title":"Logs","type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["logs","duration"],"type":"object"},"QueryModerationRulesRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter conditions for moderation rules","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"Sorting parameters for the results","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"type":"object"},"QueryModerationRulesResponse":{"nullable":true,"properties":{"default_llm_labels":{"additionalProperties":{"type":"string"},"description":"Default LLM label descriptions","title":"DefaultLLMLabels","type":"object","x-stream-index":"002"},"duration":{"type":"string","x-stream-index":"004.001"},"next":{"type":"string","x-stream-index":"003.001"},"prev":{"type":"string","x-stream-index":"003.002"},"rules":{"description":"List of moderation rules","items":{"$ref":"#/components/schemas/ModerationRuleV2Response"},"title":"Rules","type":"array","x-stream-index":"001"}},"required":["rules","default_llm_labels","duration"],"type":"object"},"QueryPollVotesRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","title":"Filter","type":"object","x-stream-index":"003"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"004"}},"type":"object"},"QueryPollsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","title":"Filter","type":"object","x-stream-index":"002"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"003"}},"type":"object"},"QueryPollsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"polls":{"description":"Polls data returned by the query","items":{"$ref":"#/components/schemas/PollResponseData"},"title":"PollsResponseData","type":"array","x-stream-index":"001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["polls","duration"],"type":"object"},"QueryReactionsRequest":{"properties":{"filter":{"additionalProperties":{},"type":"object","x-stream-index":"002"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"006.001"},"next":{"type":"string","x-stream-index":"006.002"},"prev":{"type":"string","x-stream-index":"006.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":2,"type":"array","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"type":"object"},"QueryReactionsResponse":{"description":"Basic response information","properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"next":{"type":"string","x-stream-index":"003.001"},"prev":{"type":"string","x-stream-index":"003.002"},"reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"001"}},"required":["reactions","duration"],"title":"Response","type":"object"},"QueryRemindersRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"type":"object"},"QueryRemindersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"reminders":{"description":"MessageReminders data returned by the query","items":{"$ref":"#/components/schemas/ReminderResponseData"},"title":"RemindersResponseData","type":"array","x-stream-index":"001"}},"required":["reminders","duration"],"type":"object"},"QueryReviewQueueRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter conditions for review queue items","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"007.001"},"lock_count":{"description":"Number of items to lock (1-25)","format":"int32","maximum":25,"minimum":1,"title":"Lock Count","type":"integer","x-stream-index":"005"},"lock_duration":{"description":"Duration for which items should be locked","title":"Lock Duration","type":"integer","x-stream-index":"004"},"lock_items":{"description":"Whether to lock items for review (true), unlock items (false), or just fetch (nil)","title":"Lock Items","type":"boolean","x-stream-index":"003"},"next":{"type":"string","x-stream-index":"007.002"},"prev":{"type":"string","x-stream-index":"007.003"},"sort":{"description":"Sorting parameters for the results","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"002"},"stats_only":{"description":"Whether to return only statistics","title":"Stats Only","type":"boolean","x-stream-index":"006"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"008.002"},"user_id":{"type":"string","x-stream-index":"008.001"}},"type":"object"},"QueryReviewQueueResponse":{"nullable":true,"properties":{"action_config":{"additionalProperties":{"items":{"$ref":"#/components/schemas/ModerationActionConfig"},"type":"array"},"description":"Configuration for moderation actions","title":"Action Config","type":"object","x-stream-index":"002"},"duration":{"type":"string","x-stream-index":"005.001"},"items":{"description":"List of review queue items","items":{"$ref":"#/components/schemas/ReviewQueueItemResponse"},"title":"Items","type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"004.001"},"prev":{"type":"string","x-stream-index":"004.002"},"stats":{"additionalProperties":{},"description":"Statistics about the review queue","title":"Stats","type":"object","x-stream-index":"003"}},"required":["items","action_config","stats","duration"],"type":"object"},"QuerySegmentTargetsRequest":{"nullable":true,"properties":{"Filter":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"005"},"Sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"type":"array","writeOnly":true,"x-stream-index":"006"},"limit":{"description":"Limit","format":"int32","maximum":10000,"minimum":0,"title":"int","type":"integer","x-stream-index":"002"},"next":{"description":"Next","title":"string","type":"string","x-stream-index":"003"},"prev":{"description":"Prev","title":"string","type":"string","x-stream-index":"004"}},"type":"object"},"QuerySegmentTargetsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"targets":{"description":"Targets","items":{"$ref":"#/components/schemas/SegmentTargetResponse"},"title":"SegmentTargetResponseList","type":"array","x-stream-index":"001"}},"required":["targets","duration"],"type":"object"},"QuerySegmentsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","title":"Filter","type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"003.002"},"prev":{"type":"string","x-stream-index":"003.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"002"}},"required":["filter"],"type":"object"},"QuerySegmentsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"segments":{"description":"Segments","items":{"$ref":"#/components/schemas/SegmentResponse"},"title":"SegmentResponses","type":"array","x-stream-index":"001"}},"required":["segments","duration"],"type":"object"},"QueryThreadsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter conditions to apply to threads","title":"Filter","type":"object","x-stream-index":"006"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"008.001"},"member_limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005"},"next":{"type":"string","x-stream-index":"008.002"},"participant_limit":{"description":"Limit the number of participants returned per each thread","format":"int32","maximum":100,"minimum":0,"title":"Participant limit","type":"integer","x-stream-index":"004"},"prev":{"type":"string","x-stream-index":"008.003"},"reply_limit":{"description":"Limit the number of replies returned per each thread","format":"int32","maximum":10,"minimum":0,"title":"Reply limit","type":"integer","x-stream-index":"003"},"sort":{"description":"Sort conditions to apply to threads","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"007"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"010.002"},"user_id":{"type":"string","x-stream-index":"010.001"}},"type":"object"},"QueryThreadsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"threads":{"description":"List of enriched thread states","items":{"$ref":"#/components/schemas/ThreadStateResponse"},"title":"Threads","type":"array","x-stream-index":"001"}},"required":["threads","duration"],"type":"object"},"QueryUserFeedbackRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":2,"type":"array","x-stream-index":"002"}},"type":"object"},"QueryUserFeedbackResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"next":{"type":"string","x-stream-index":"003.001"},"prev":{"type":"string","x-stream-index":"003.002"},"user_feedback":{"items":{"$ref":"#/components/schemas/UserFeedbackResponse"},"type":"array","x-stream-index":"001"}},"required":["user_feedback","duration"],"title":"Response","type":"object"},"QueryUsersPayload":{"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"include_deactivated_users":{"type":"boolean","x-stream-index":"004"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.003"},"offset":{"format":"int32","maximum":1000,"type":"integer","x-stream-index":"005.004"},"presence":{"type":"boolean","x-stream-index":"003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"006.002"},"user_id":{"type":"string","x-stream-index":"006.001"}},"required":["filter_conditions"],"type":"object"},"QueryUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"users":{"description":"Array of users as result of filters applied.","items":{"$ref":"#/components/schemas/FullUserResponse"},"title":"Users","type":"array","x-stream-index":"001"}},"required":["users","duration"],"type":"object"},"RTMPBroadcastRequest":{"description":"RTMPBroadcastRequest is the payload for starting an RTMP broadcast.","properties":{"layout":{"$ref":"#/components/schemas/LayoutSettingsRequest","description":"If provided, will override the call's RTMP settings layout","title":"Layout","x-stream-index":"005"},"name":{"description":"Name identifier for RTMP broadcast, must be unique in call","maxLength":255,"title":"Name","type":"string","x-stream-index":"001"},"quality":{"description":"If provided, will override the call's RTMP settings quality","enum":["360p","480p","720p","1080p","1440p","portrait-360x640","portrait-480x854","portrait-720x1280","portrait-1080x1920","portrait-1440x2560"],"title":"Quality","type":"string","x-stream-index":"004"},"stream_key":{"description":"If provided, will be appended at the end of stream_url","title":"Stream Key","type":"string","x-stream-index":"003"},"stream_url":{"description":"URL for the RTMP server to send the call to","maxLength":255,"title":"Stream URL","type":"string","x-stream-index":"002"}},"required":["name","stream_url"],"title":"RTMPBroadcastRequest","type":"object"},"RTMPEgressConfig":{"properties":{"composite_app_settings":{"$ref":"#/components/schemas/CompositeAppSettings","x-stream-index":"005"},"quality":{"$ref":"#/components/schemas/Quality","x-stream-index":"004"},"rtmp_location":{"type":"string","x-stream-index":"006"}},"type":"object"},"RTMPIngress":{"description":"RTMP input settings","properties":{"address":{"title":"Address","type":"string","x-stream-index":"001"}},"required":["address"],"title":"RTMPIngress","type":"object"},"RTMPLocation":{"properties":{"name":{"type":"string","x-stream-index":"001"},"stream_key":{"type":"string","x-stream-index":"003"},"stream_url":{"type":"string","x-stream-index":"002"}},"required":["name","stream_url","stream_key"],"type":"object"},"RTMPSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"003"},"location":{"$ref":"#/components/schemas/RTMPLocation","x-stream-index":"004"},"quality_name":{"type":"string","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"RTMPSettingsRequest":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettingsRequest","description":"Layout for the composed RTMP stream","title":"LayoutSettings","x-stream-index":"003"},"quality":{"description":"Resolution to set for the RTMP stream","enum":["360p","480p","720p","1080p","1440p","portrait-360x640","portrait-480x854","portrait-720x1280","portrait-1080x1920","portrait-1440x2560"],"title":"Quality","type":"string","x-stream-index":"002"}},"title":"RTMPSettingsRequest","type":"object"},"RTMPSettingsResponse":{"description":"RTMPSettingsResponse is the payload for RTMP settings","properties":{"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettingsResponse","title":"Layout","x-stream-index":"003"},"quality":{"title":"Quality","type":"string","x-stream-index":"002"}},"required":["enabled","quality","layout"],"title":"RTMPSettingsResponse","type":"object"},"RankingConfig":{"properties":{"defaults":{"additionalProperties":{},"description":"Default values for ranking","title":"Defaults","type":"object","x-stream-index":"003"},"functions":{"additionalProperties":{"$ref":"#/components/schemas/DecayFunctionConfig"},"description":"Decay functions configuration","title":"Functions","type":"object","x-stream-index":"004"},"score":{"description":"Scoring formula","title":"Score","type":"string","x-stream-index":"002"},"type":{"description":"Type of ranking algorithm","title":"Type","type":"string","x-stream-index":"001"}},"title":"Ranking Configuration","type":"object"},"Reaction":{"nullable":true,"properties":{"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"message_id":{"type":"string","x-stream-index":"003"},"score":{"format":"int32","type":"integer","x-stream-index":"007"},"type":{"maxLength":30,"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["message_id","type","score","created_at","updated_at","custom"],"type":"object"},"ReactionDeletedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"003.002"},"channel_type":{"type":"string","x-stream-index":"003.003"},"cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"006.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"002"},"team":{"type":"string","x-stream-index":"005.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"reaction.deleted","type":"string","x-stream-index":"006.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"004.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"ReactionDeletedEvent","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"},"ReactionGroupResponse":{"description":"ReactionGroupResponse contains all information about a reaction of the same type.","nullable":true,"properties":{"count":{"description":"Count is the number of reactions of this type.","format":"int32","title":"Count","type":"integer","x-stream-index":"001"},"first_reaction_at":{"description":"FirstReactionAt is the time of the first reaction of this type. This is the same also if all reaction of this type are deleted, because if someone will react again with the same type, will be preserved the sorting.","format":"date-time","title":"FirstReactionAt","type":"number","x-stream-index":"003"},"last_reaction_at":{"description":"LastReactionAt is the time of the last reaction of this type.","format":"date-time","title":"LastReactionAt","type":"number","x-stream-index":"004"},"sum_scores":{"description":"SumScores is the sum of all scores of reactions of this type. Medium allows you to clap articles more than once and shows the sum of all claps from all users. For example, you can send `clap` x5 using `score: 5`.","format":"int32","title":"SumScores","type":"integer","x-stream-index":"002"}},"required":["count","sum_scores","first_reaction_at","last_reaction_at"],"title":"ReactionGroupResponse","type":"object"},"ReactionNewEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"006.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001.001"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"002"},"team":{"type":"string","x-stream-index":"005.001"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"001.002"},"type":{"default":"reaction.new","type":"string","x-stream-index":"006.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"ReactionNewEvent","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"},"ReactionRequest":{"description":"Represents user reaction to a message","properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"score":{"description":"Reaction score. If not specified reaction has score of 1","format":"int32","title":"Score","type":"integer","x-stream-index":"002"},"type":{"description":"The type of reaction (e.g. 'like', 'laugh', 'wow')","maxLength":30,"title":"Type","type":"string","x-stream-index":"001"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"006.002"},"user_id":{"type":"string","x-stream-index":"006.001"}},"required":["type"],"title":"Reaction","type":"object","x-stream-docs-page-id":"send_reaction"},"ReactionResponse":{"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"006"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"008"},"message_id":{"description":"Message ID","title":"Message ID","type":"string","x-stream-index":"001"},"score":{"description":"Score of the reaction","format":"int32","title":"Score","type":"integer","x-stream-index":"005"},"type":{"description":"Type of reaction","title":"Type","type":"string","x-stream-index":"004"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"007"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User","title":"UserResponse","x-stream-index":"003"},"user_id":{"description":"User ID","title":"User ID","type":"string","x-stream-index":"002"}},"required":["message_id","user_id","user","type","score","created_at","updated_at","custom"],"type":"object"},"ReactionUpdatedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"004.002"},"channel_type":{"type":"string","x-stream-index":"004.003"},"cid":{"type":"string","x-stream-index":"004.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"006.002"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"001"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"002"},"team":{"type":"string","x-stream-index":"005.001"},"type":{"default":"reaction.updated","type":"string","x-stream-index":"006.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["message","reaction","cid","channel_id","channel_type","type","created_at"],"title":"ReactionUpdatedEvent","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"},"ReactivateUserRequest":{"nullable":true,"properties":{"created_by_id":{"description":"ID of the user who's reactivating the user","title":"Created by ID","type":"string","x-stream-index":"004"},"name":{"description":"Set this field to put new name for the user","title":"Name","type":"string","x-stream-index":"003"},"restore_messages":{"description":"Restore previously deleted messages","title":"Restore messages","type":"boolean","x-stream-index":"002"}},"type":"object"},"ReactivateUserResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.002.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Deactivated user object","title":"User","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"ReactivateUsersRequest":{"description":"Reactivate users in batches","nullable":true,"properties":{"created_by_id":{"description":"ID of the user who's reactivating the users","title":"Created by ID","type":"string","x-stream-index":"003"},"restore_channels":{"type":"boolean","x-stream-index":"004"},"restore_messages":{"description":"Restore previously deleted messages","title":"Restore messages","type":"boolean","x-stream-index":"002"},"user_ids":{"description":"User IDs to reactivate","items":{"type":"string"},"maximum":100,"minimum":1,"title":"User IDs","type":"array","x-stream-index":"001"}},"required":["user_ids"],"title":"ReactivateUsersRequest","type":"object"},"ReactivateUsersResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.002.001"},"task_id":{"type":"string","x-stream-index":"001.001"}},"required":["task_id","duration"],"title":"Response","type":"object"},"ReadReceipts":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"ReadReceiptsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"ReadStateResponse":{"properties":{"last_read":{"format":"date-time","type":"number","x-stream-index":"002"},"last_read_message_id":{"type":"string","x-stream-index":"004"},"unread_messages":{"format":"int32","type":"integer","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"}},"required":["user","last_read","unread_messages"],"type":"object"},"RecordSettings":{"properties":{"audio_only":{"type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"004"},"mode":{"type":"string","x-stream-index":"002"},"quality":{"type":"string","x-stream-index":"003"}},"required":["mode"],"type":"object"},"RecordSettingsRequest":{"properties":{"audio_only":{"type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettingsRequest","title":"LayoutSettings","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"title":"Mode","type":"string","x-stream-index":"002"},"quality":{"enum":["360p","480p","720p","1080p","1440p","portrait-360x640","portrait-480x854","portrait-720x1280","portrait-1080x1920","portrait-1440x2560"],"type":"string","x-stream-index":"003"}},"required":["mode"],"title":"RecordSettingsRequest","type":"object"},"RecordSettingsResponse":{"description":"RecordSettings is the payload for recording settings","properties":{"audio_only":{"title":"Audio Only","type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettingsResponse","title":"Layout","x-stream-index":"004"},"mode":{"title":"Mode","type":"string","x-stream-index":"002"},"quality":{"title":"Quality","type":"string","x-stream-index":"003"}},"required":["audio_only","mode","quality","layout"],"title":"RecordSettingsResponse","type":"object"},"RecordingEgressConfig":{"properties":{"audio_only":{"type":"boolean","x-stream-index":"006"},"composite_app_settings":{"$ref":"#/components/schemas/CompositeAppSettings","x-stream-index":"005"},"external_storage":{"$ref":"#/components/schemas/ExternalStorage","x-stream-index":"008"},"quality":{"$ref":"#/components/schemas/Quality","x-stream-index":"004"},"storage_name":{"type":"string","x-stream-index":"007"},"video_orientation_hint":{"$ref":"#/components/schemas/VideoOrientation","x-stream-index":"009"}},"type":"object"},"RejectFeedMemberInviteRequest":{"nullable":true,"properties":{"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"title":"Reject Feed Member Request","type":"object"},"RejectFeedMemberInviteResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"member":{"$ref":"#/components/schemas/FeedMemberResponse","description":"The feed member after rejecting the invite","title":"Feed Member","x-stream-index":"001"}},"required":["member","duration"],"title":"Reject Feed Member Response","type":"object"},"RejectFollowRequest":{"nullable":true,"properties":{"source":{"description":"Fully qualified ID of the source feed","maxLength":255,"title":"Source Feed ID","type":"string","x-stream-index":"001"},"target":{"description":"Fully qualified ID of the target feed","maxLength":255,"title":"Target Feed ID","type":"string","x-stream-index":"002"}},"required":["source","target"],"title":"Reject Follow Request","type":"object"},"RejectFollowResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"follow":{"$ref":"#/components/schemas/FollowResponse","description":"The rejected follow relationship","title":"Follow","x-stream-index":"001"}},"required":["follow","duration"],"title":"Reject Follow Response","type":"object"},"ReminderCreatedEvent":{"description":"Emitted when a reminder is created.","nullable":true,"properties":{"cid":{"description":"The CID of the Channel for which the reminder was created","title":"Channel CID","type":"string","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.007"},"message_id":{"description":"The ID of the message for which the reminder was created","title":"Message ID","type":"string","x-stream-index":"001.002"},"parent_id":{"description":"The ID of the parent message, if the reminder is for a thread message","title":"Parent ID","type":"string","x-stream-index":"001.005"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","description":"The reminder object which was created","title":"MessageReminder","x-stream-index":"001.006"},"type":{"default":"reminder.created","description":"The type of event: \"reminder.created\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.002"},"user_id":{"description":"The ID of the user for whom the reminder was created","title":"User ID","type":"string","x-stream-index":"001.003"}},"required":["type","created_at","custom","message_id","user_id","cid"],"title":"ReminderCreatedEvent","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"},"ReminderDeletedEvent":{"description":"Emitted when a reminder is deleted.","nullable":true,"properties":{"cid":{"description":"The CID of the Channel for which the reminder was created","title":"Channel CID","type":"string","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.007"},"message_id":{"description":"The ID of the message for which the reminder was created","title":"Message ID","type":"string","x-stream-index":"001.002"},"parent_id":{"description":"The ID of the parent message, if the reminder is for a thread message","title":"Parent ID","type":"string","x-stream-index":"001.005"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","description":"The reminder object which was created","title":"MessageReminder","x-stream-index":"001.006"},"type":{"default":"reminder.deleted","description":"The type of event: \"reminder.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.002"},"user_id":{"description":"The ID of the user for whom the reminder was created","title":"User ID","type":"string","x-stream-index":"001.003"}},"required":["type","created_at","custom","message_id","user_id","cid"],"title":"ReminderDeletedEvent","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"},"ReminderNotificationEvent":{"description":"Emitted when a reminder becomes due, triggering a notification for the user.","nullable":true,"properties":{"cid":{"description":"The CID of the Channel for which the reminder was created","title":"Channel CID","type":"string","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.007"},"message_id":{"description":"The ID of the message for which the reminder was created","title":"Message ID","type":"string","x-stream-index":"001.002"},"parent_id":{"type":"string","x-stream-index":"001.005"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","description":"The reminder object which was created","title":"MessageReminder","x-stream-index":"001.006"},"type":{"default":"notification.reminder_due","description":"The type of event: \"notification.reminder_due\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.002"},"user_id":{"description":"The ID of the user for whom the reminder was created","title":"User ID","type":"string","x-stream-index":"001.003"}},"required":["type","created_at","custom","message_id","user_id","cid"],"title":"ReminderNotificationEvent","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"},"ReminderResponseData":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003"},"channel_cid":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"005"},"message_id":{"type":"string","x-stream-index":"004"},"remind_at":{"format":"date-time","type":"number","x-stream-index":"001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007"},"user_id":{"type":"string","x-stream-index":"006"}},"required":["channel_cid","message_id","user_id","created_at","updated_at"],"type":"object"},"ReminderUpdatedEvent":{"description":"Emitted when a reminder is updated.","nullable":true,"properties":{"cid":{"description":"The CID of the Channel for which the reminder was created","title":"Channel CID","type":"string","x-stream-index":"001.004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.007"},"message_id":{"description":"The ID of the message for which the reminder was created","title":"Message ID","type":"string","x-stream-index":"001.002"},"parent_id":{"description":"The ID of the parent message, if the reminder is for a thread message","title":"Parent ID","type":"string","x-stream-index":"001.005"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","description":"The reminder object which was created","title":"MessageReminder","x-stream-index":"001.006"},"type":{"default":"reminder.updated","description":"The type of event: \"reminder.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.002"},"user_id":{"description":"The ID of the user for whom the reminder was created","title":"User ID","type":"string","x-stream-index":"001.003"}},"required":["type","created_at","custom","message_id","user_id","cid"],"title":"ReminderUpdatedEvent","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"},"RepliesMeta":{"description":"Cursor \u0026 depth information for a comment's direct replies. Mirrors Reddit's 'load more replies' semantics.","properties":{"depth_truncated":{"description":"True if the subtree was cut because the requested depth was reached.","title":"Depth Truncated","type":"boolean","x-stream-index":"004"},"has_more":{"description":"True if more siblings exist in the database.","title":"Has More","type":"boolean","x-stream-index":"001"},"next_cursor":{"description":"Opaque cursor to request the next page of siblings.","title":"Next Cursor","type":"string","x-stream-index":"002"},"remaining":{"description":"Number of unread siblings that match current filters.","format":"int32","title":"Remaining","type":"integer","x-stream-index":"003"}},"required":["has_more","remaining","depth_truncated"],"title":"Replies Meta","type":"object"},"ReportByHistogramBucket":{"properties":{"category":{"type":"string","x-stream-index":"001"},"count":{"format":"int32","type":"integer","x-stream-index":"005"},"lower_bound":{"$ref":"#/components/schemas/Bound","x-stream-index":"002"},"sum":{"format":"float","type":"number","x-stream-index":"004"},"upper_bound":{"$ref":"#/components/schemas/Bound","x-stream-index":"003"}},"required":["category","sum","count"],"type":"object"},"ReportResponse":{"properties":{"call":{"$ref":"#/components/schemas/CallReportResponse","x-stream-index":"003"},"participants":{"$ref":"#/components/schemas/ParticipantReportResponse","x-stream-index":"001"},"user_ratings":{"$ref":"#/components/schemas/UserRatingReportResponse","x-stream-index":"002"}},"required":["participants","user_ratings","call"],"type":"object"},"Response":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001"}},"required":["duration"],"title":"Response","type":"object"},"RestoreActionRequest":{"type":"object"},"RestoreUsersRequest":{"nullable":true,"properties":{"user_ids":{"items":{"type":"string"},"maximum":100,"minimum":1,"type":"array","x-stream-index":"001"}},"required":["user_ids"],"type":"object"},"ReviewQueueItem":{"properties":{"actions":{"items":{"$ref":"#/components/schemas/ActionLog"},"type":"array","x-stream-index":"035"},"activity":{"$ref":"#/components/schemas/EnrichedActivity","x-stream-index":"028"},"ai_text_severity":{"type":"string","x-stream-index":"021"},"archived_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"043"},"assigned_to":{"$ref":"#/components/schemas/User","x-stream-index":"032"},"bans":{"items":{"$ref":"#/components/schemas/Ban"},"type":"array","x-stream-index":"033"},"bounce_count":{"format":"int32","type":"integer","x-stream-index":"025"},"call":{"$ref":"#/components/schemas/Call","x-stream-index":"031"},"completed_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"018"},"config_key":{"type":"string","x-stream-index":"009"},"content_changed":{"type":"boolean","x-stream-index":"036"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"entity_creator":{"$ref":"#/components/schemas/EntityCreator","x-stream-index":"030"},"entity_id":{"type":"string","x-stream-index":"007"},"entity_type":{"type":"string","x-stream-index":"006"},"feeds_v2_activity":{"$ref":"#/components/schemas/EnrichedActivity","x-stream-index":"041"},"feeds_v2_reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"042"},"flag_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"045"},"flag_types":{"items":{"type":"string"},"type":"array","x-stream-index":"044"},"flags":{"items":{"$ref":"#/components/schemas/Flag"},"type":"array","x-stream-index":"034"},"flags_count":{"format":"int32","type":"integer","x-stream-index":"026"},"has_image":{"type":"boolean","x-stream-index":"012"},"has_text":{"type":"boolean","x-stream-index":"014"},"has_video":{"type":"boolean","x-stream-index":"013"},"id":{"type":"string","x-stream-index":"003"},"languages":{"items":{"type":"string"},"type":"array","x-stream-index":"019"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"027"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","x-stream-index":"010"},"moderation_payload_hash":{"type":"string","x-stream-index":"011"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"029"},"recommended_action":{"type":"string","x-stream-index":"017"},"reporter_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"046"},"reviewed_at":{"$ref":"#/components/schemas/NullTime","x-stream-index":"022"},"reviewed_by":{"type":"string","x-stream-index":"023"},"severity":{"format":"int32","type":"integer","x-stream-index":"020"},"status":{"type":"string","x-stream-index":"016"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"015"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"005"}},"required":["id","created_at","updated_at","entity_type","entity_id","config_key","moderation_payload_hash","has_image","has_video","has_text","teams","status","recommended_action","completed_at","languages","severity","ai_text_severity","reviewed_at","reviewed_by","bounce_count","flags_count","bans","flags","actions","content_changed","archived_at","flag_types","flag_labels","reporter_ids"],"type":"object"},"ReviewQueueItemNewEvent":{"description":"This event is sent when a new moderation review queue item is created","nullable":true,"properties":{"action":{"$ref":"#/components/schemas/ActionLogResponse","description":"The action log if any action was taken","title":"Action","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"flags":{"description":"The flags associated with this review queue item","items":{"$ref":"#/components/schemas/ModerationFlagResponse"},"title":"Flags","type":"array","x-stream-index":"003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"The review queue item that was created","title":"ReviewQueueItem","x-stream-index":"002"},"type":{"default":"review_queue_item.new","type":"string","x-stream-index":"001.002"}},"required":["type","created_at","custom"],"title":"ReviewQueueItemNewEvent","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"},"ReviewQueueItemResponse":{"properties":{"actions":{"description":"Moderation actions taken","items":{"$ref":"#/components/schemas/ActionLogResponse"},"title":"Actions","type":"array","x-stream-index":"024"},"activity":{"$ref":"#/components/schemas/EnrichedActivity","x-stream-index":"016"},"ai_text_severity":{"description":"AI-determined text severity","title":"AI Text Severity","type":"string","x-stream-index":"014"},"assigned_to":{"$ref":"#/components/schemas/UserResponse","description":"Moderator assigned to review this item","title":"Assigned To","x-stream-index":"021"},"bans":{"description":"Associated ban records","items":{"$ref":"#/components/schemas/Ban"},"title":"Bans","type":"array","x-stream-index":"022"},"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"018"},"completed_at":{"description":"When the review was completed","format":"date-time","title":"Completed At","type":"number","x-stream-index":"009"},"config_key":{"type":"string","x-stream-index":"028"},"created_at":{"description":"When the item was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"002"},"entity_creator":{"$ref":"#/components/schemas/EntityCreatorResponse","description":"Details about who created the entity","title":"Entity Creator","x-stream-index":"019"},"entity_creator_id":{"description":"ID of who created the entity","title":"Entity Creator ID","type":"string","x-stream-index":"020"},"entity_id":{"description":"ID of the entity being reviewed","title":"Entity ID","type":"string","x-stream-index":"005"},"entity_type":{"description":"Type of entity being reviewed","title":"Entity Type","type":"string","x-stream-index":"004"},"feeds_v2_activity":{"$ref":"#/components/schemas/EnrichedActivity","description":"Associated feed activity","title":"Feeds V2 Activity","x-stream-index":"025"},"feeds_v2_reaction":{"$ref":"#/components/schemas/Reaction","description":"Associated feed reaction","title":"Feeds V2 Reaction","x-stream-index":"026"},"flags":{"description":"Associated flag records","items":{"$ref":"#/components/schemas/ModerationFlagResponse"},"title":"Flags","type":"array","x-stream-index":"023"},"flags_count":{"format":"int32","type":"integer","x-stream-index":"029"},"id":{"description":"Unique identifier of the review queue item","title":"ID","type":"string","x-stream-index":"001"},"languages":{"description":"Detected languages in the content","items":{"type":"string"},"title":"Languages","type":"array","x-stream-index":"012"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Associated message details","title":"Message","x-stream-index":"015"},"moderation_payload":{"$ref":"#/components/schemas/ModerationPayload","description":"Content being moderated","title":"Moderation Payload","x-stream-index":"006"},"reaction":{"$ref":"#/components/schemas/Reaction","x-stream-index":"017"},"recommended_action":{"description":"Suggested moderation action","title":"Recommended Action","type":"string","x-stream-index":"008"},"reviewed_at":{"description":"When the item was reviewed","format":"date-time","title":"Reviewed At","type":"number","x-stream-index":"010"},"reviewed_by":{"description":"ID of the moderator who reviewed the item","title":"Reviewed By","type":"string","x-stream-index":"011"},"severity":{"description":"Severity level of the content","format":"int32","title":"Severity","type":"integer","x-stream-index":"013"},"status":{"description":"Current status of the review","title":"Status","type":"string","x-stream-index":"007"},"teams":{"description":"Teams associated with this item","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"027"},"updated_at":{"description":"When the item was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"003"}},"required":["id","created_at","updated_at","entity_type","entity_id","status","recommended_action","reviewed_by","languages","severity","ai_text_severity","bans","flags","actions","flags_count"],"type":"object"},"ReviewQueueItemUpdatedEvent":{"description":"This event is sent when a moderation review queue item is updated","nullable":true,"properties":{"action":{"$ref":"#/components/schemas/ActionLogResponse","description":"The action log if any action was taken","title":"Action","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"flags":{"description":"The flags associated with this review queue item","items":{"$ref":"#/components/schemas/ModerationFlagResponse"},"title":"Flags","type":"array","x-stream-index":"003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"review_queue_item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"The review queue item that was updated","title":"ReviewQueueItem","x-stream-index":"002"},"type":{"default":"review_queue_item.updated","type":"string","x-stream-index":"001.002"}},"required":["type","created_at","custom"],"title":"ReviewQueueItemUpdatedEvent","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"},"RingSettings":{"properties":{"auto_cancel_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_timeout_ms","missed_call_timeout_ms"],"type":"object"},"RingSettingsRequest":{"properties":{"auto_cancel_timeout_ms":{"description":"When none of the callees accept a ring call in this time a rejection will be sent by the caller with reason 'timeout' by the SDKs","format":"int32","maximum":180000,"minimum":5000,"title":"AutoCancelTimeoutMs","type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"description":"When a callee is online but doesn't answer a ring call in this time a rejection will be sent with reason 'timeout' by the SDKs","format":"int32","maximum":180000,"minimum":5000,"title":"IncomingCallTimeoutMs","type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"description":"When a callee doesn't accept or reject a ring call in this time a missed call event will be sent","format":"int32","maximum":180000,"minimum":5000,"title":"MissedCallTimeoutMs","type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_timeout_ms"],"title":"RingSettingsRequest","type":"object"},"RingSettingsResponse":{"properties":{"auto_cancel_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_timeout_ms","missed_call_timeout_ms"],"type":"object"},"Role":{"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"004"},"custom":{"description":"Whether this is a custom role or built-in","title":"Custom","type":"boolean","x-stream-index":"002"},"name":{"description":"Unique role name","title":"Name","type":"string","x-stream-index":"001"},"scopes":{"description":"List of scopes where this role is currently present. `.app` means that role is present in app-level grants","items":{"type":"string"},"title":"Scopes","type":"array","x-stream-index":"003"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"005"}},"required":["name","custom","scopes","created_at","updated_at"],"type":"object"},"RuleBuilderAction":{"properties":{"ban_options":{"$ref":"#/components/schemas/BanOptions","x-stream-index":"002"},"flag_content_options":{"$ref":"#/components/schemas/FlagContentOptions","x-stream-index":"004"},"flag_user_options":{"$ref":"#/components/schemas/FlagUserOptions","x-stream-index":"003"},"remove_content_options":{"$ref":"#/components/schemas/BlockContentOptions","x-stream-index":"005"},"type":{"type":"string","x-stream-index":"001"}},"type":"object"},"RuleBuilderCondition":{"properties":{"confidence":{"format":"float","type":"number","x-stream-index":"002"},"content_count_rule_params":{"$ref":"#/components/schemas/ContentCountRuleParameters","x-stream-index":"007"},"image_content_params":{"$ref":"#/components/schemas/ImageContentParameters","x-stream-index":"009"},"image_rule_params":{"$ref":"#/components/schemas/ImageRuleParameters","x-stream-index":"004"},"text_content_params":{"$ref":"#/components/schemas/TextContentParameters","x-stream-index":"008"},"text_rule_params":{"$ref":"#/components/schemas/TextRuleParameters","x-stream-index":"003"},"type":{"type":"string","x-stream-index":"001"},"user_created_within_params":{"$ref":"#/components/schemas/UserCreatedWithinParameters","x-stream-index":"011"},"user_custom_property_params":{"$ref":"#/components/schemas/UserCustomPropertyParameters","x-stream-index":"012"},"user_rule_params":{"$ref":"#/components/schemas/UserRuleParameters","x-stream-index":"006"},"video_content_params":{"$ref":"#/components/schemas/VideoContentParameters","x-stream-index":"010"},"video_rule_params":{"$ref":"#/components/schemas/VideoRuleParameters","x-stream-index":"005"}},"type":"object"},"RuleBuilderConditionGroup":{"properties":{"conditions":{"items":{"$ref":"#/components/schemas/RuleBuilderCondition"},"type":"array","x-stream-index":"002"},"logic":{"type":"string","x-stream-index":"001"}},"type":"object"},"RuleBuilderConfig":{"properties":{"async":{"type":"boolean","x-stream-index":"001"},"rules":{"items":{"$ref":"#/components/schemas/RuleBuilderRule"},"type":"array","x-stream-index":"002"}},"type":"object"},"RuleBuilderRule":{"properties":{"action":{"$ref":"#/components/schemas/RuleBuilderAction","x-stream-index":"006"},"conditions":{"items":{"$ref":"#/components/schemas/RuleBuilderCondition"},"type":"array","x-stream-index":"003"},"cooldown_period":{"type":"string","x-stream-index":"007"},"groups":{"items":{"$ref":"#/components/schemas/RuleBuilderConditionGroup"},"type":"array","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"logic":{"type":"string","x-stream-index":"004"},"rule_type":{"type":"string","x-stream-index":"002"}},"required":["rule_type","action"],"type":"object"},"S3Request":{"description":"Config for creating Amazon S3 storage.","properties":{"s3_api_key":{"description":"The AWS API key. To use Amazon S3 as your storage provider, you have two authentication options: IAM role or API key. If you do not specify the `s3_api_key` parameter, Stream will use IAM role authentication. In that case make sure to have the correct IAM role configured for your application.","title":"S3ApiKey","type":"string","x-stream-index":"002"},"s3_custom_endpoint_url":{"description":"The custom endpoint for S3. If you want to use a custom endpoint, you must also provide the `s3_api_key` and `s3_secret` parameters.","title":"S3CustomEndpointURL","type":"string","x-stream-index":"004"},"s3_region":{"description":"The AWS region where the bucket is hosted","title":"S3Region","type":"string","x-stream-index":"001"},"s3_secret":{"description":"The AWS API Secret","title":"S3Secret","type":"string","x-stream-index":"003"}},"required":["s3_region"],"title":"S3Request","type":"object"},"SDKUsageReport":{"properties":{"per_sdk_usage":{"additionalProperties":{"$ref":"#/components/schemas/PerSDKUsageReport"},"type":"object","x-stream-index":"001"}},"required":["per_sdk_usage"],"type":"object"},"SDKUsageReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateSDKUsageReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"SFUIDLastSeen":{"properties":{"id":{"type":"string","x-stream-index":"001.001"},"last_seen":{"format":"date-time","type":"number","x-stream-index":"002"},"process_start_time":{"format":"int64","type":"integer","x-stream-index":"001.002"}},"required":["id","process_start_time","last_seen"],"type":"object"},"STTEgressConfig":{"properties":{"closed_captions_enabled":{"type":"boolean","x-stream-index":"005"},"external_storage":{"$ref":"#/components/schemas/ExternalStorage","x-stream-index":"011"},"language":{"type":"string","x-stream-index":"008"},"storage_name":{"type":"string","x-stream-index":"010"},"translation_languages":{"items":{"type":"string"},"type":"array","x-stream-index":"009"},"translations_enabled":{"type":"boolean","x-stream-index":"006"},"upload_transcriptions":{"type":"boolean","x-stream-index":"004"},"whisper_server_base_url":{"type":"string","x-stream-index":"007"}},"type":"object"},"ScreensharingSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled"],"type":"object"},"ScreensharingSettingsRequest":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"type":"object"},"ScreensharingSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled"],"type":"object"},"SearchPayload":{"properties":{"filter_conditions":{"additionalProperties":{},"description":"Channel filter conditions","maximum":100,"minimum":1,"title":"Channel filter","type":"object","x-stream-docs-page-id":"query_channels","x-stream-index":"002"},"limit":{"description":"Number of messages to return","format":"int32","title":"Limit","type":"integer","x-stream-index":"005"},"message_filter_conditions":{"additionalProperties":{},"description":"Message filter conditions","title":"Message filter","type":"object","x-stream-index":"003"},"message_options":{"$ref":"#/components/schemas/MessageOptions","x-stream-index":"004"},"next":{"description":"Pagination parameter. Cannot be used with non-zero offset.","title":"Next","type":"string","x-stream-index":"008"},"offset":{"description":"Pagination offset. Cannot be used with sort or next.","format":"int32","title":"Offset","type":"integer","x-stream-index":"006"},"query":{"description":"Search phrase","title":"Query","type":"string","x-stream-index":"001"},"sort":{"description":"Sort parameters. Cannot be used with non-zero offset","items":{"$ref":"#/components/schemas/SortParamRequest"},"title":"Sort","type":"array","x-stream-index":"007"}},"required":["filter_conditions"],"type":"object"},"SearchResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"005.001"},"next":{"description":"Value to pass to the next search query in order to paginate","title":"Next","type":"string","x-stream-index":"003"},"previous":{"description":"Value that points to the previous page. Pass as the next value in a search query to paginate backwards","title":"Previous","type":"string","x-stream-index":"004"},"results":{"description":"Search results","items":{"$ref":"#/components/schemas/SearchResult"},"title":"Results","type":"array","x-stream-index":"001"},"results_warning":{"$ref":"#/components/schemas/SearchWarning","description":"Warning about the search results","title":"Results Warning","x-stream-index":"002"}},"required":["results","duration"],"type":"object"},"SearchResult":{"properties":{"message":{"$ref":"#/components/schemas/SearchResultMessage","description":"Found message","title":"Message","x-stream-index":"001"}},"type":"object"},"SearchResultMessage":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"001.008"},"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel object","title":"Channel","x-stream-index":"002"},"cid":{"type":"string","x-stream-index":"001.022"},"command":{"type":"string","x-stream-index":"001.004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.023"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.026"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.025"},"deleted_for_me":{"type":"boolean","x-stream-index":"001.044"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"001.018"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"001.041"},"html":{"type":"string","x-stream-index":"001.005"},"i18n":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.030"},"id":{"type":"string","x-stream-index":"001.001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"001.028"},"latest_reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"001.009"},"mentioned_users":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"001.029"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"001.036"},"mml":{"type":"string","x-stream-index":"001.003"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"001.039"},"own_reactions":{"items":{"$ref":"#/components/schemas/ReactionResponse"},"type":"array","x-stream-index":"001.010"},"parent_id":{"type":"string","x-stream-index":"001.015"},"pin_expires":{"format":"date-time","type":"number","x-stream-index":"001.035"},"pinned":{"type":"boolean","x-stream-index":"001.032"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"001.033"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001.034"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"001.038"},"poll_id":{"type":"string","x-stream-index":"001.037"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001.020"},"quoted_message_id":{"type":"string","x-stream-index":"001.019"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001.011"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"001.014"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001.012"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"001.042"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"001.017"},"restricted_visibility":{"items":{"type":"string"},"type":"array","x-stream-index":"001.040"},"shadowed":{"type":"boolean","x-stream-index":"001.027"},"shared_location":{"$ref":"#/components/schemas/SharedLocationResponseData","x-stream-index":"001.043"},"show_in_channel":{"type":"boolean","x-stream-index":"001.016"},"silent":{"type":"boolean","x-stream-index":"001.031"},"text":{"type":"string","x-stream-index":"001.002"},"thread_participants":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"001.021"},"type":{"type":"string","x-stream-index":"001.006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.024"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001.007"}},"required":["id","text","html","type","user","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned","restricted_visibility"],"type":"object"},"SearchWarning":{"properties":{"channel_search_cids":{"description":"Channel CIDs for the searched channels","items":{"type":"string"},"title":"Channel Search CIDs","type":"array","x-stream-index":"004"},"channel_search_count":{"description":"Number of channels searched","format":"int32","title":"Channel Search Count","type":"integer","x-stream-index":"003"},"warning_code":{"description":"Code corresponding to the warning","format":"int32","title":"Warning Code","type":"integer","x-stream-index":"002"},"warning_description":{"description":"Description of the warning","title":"Warning Description","type":"string","x-stream-index":"001"}},"required":["warning_description","warning_code"],"type":"object"},"Segment":{"nullable":true,"properties":{"all_sender_channels":{"type":"boolean","x-stream-index":"007"},"all_users":{"type":"boolean","x-stream-index":"006"},"created_at":{"format":"date-time","type":"number","x-stream-index":"010"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"012"},"description":{"type":"string","x-stream-index":"004"},"filter":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"name":{"type":"string","x-stream-index":"003"},"size":{"format":"int32","type":"integer","x-stream-index":"009"},"task_id":{"type":"string","x-stream-index":"008"},"type":{"type":"string","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"011"}},"required":["id","type","name","all_users","all_sender_channels","size","created_at","updated_at"],"type":"object"},"SegmentResponse":{"properties":{"all_sender_channels":{"type":"boolean","x-stream-index":"007"},"all_users":{"type":"boolean","x-stream-index":"006"},"created_at":{"format":"date-time","type":"number","x-stream-index":"009"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"description":{"type":"string","x-stream-index":"004"},"filter":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"name":{"type":"string","x-stream-index":"003"},"size":{"format":"int32","type":"integer","x-stream-index":"008"},"type":{"type":"string","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"010"}},"required":["id","type","name","description","filter","all_users","all_sender_channels","size","created_at","updated_at","deleted_at"],"type":"object"},"SegmentTargetResponse":{"nullable":true,"properties":{"app_pk":{"format":"int32","type":"integer","x-stream-index":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"segment_id":{"type":"string","x-stream-index":"002"},"target_id":{"type":"string","x-stream-index":"003"}},"required":["app_pk","segment_id","target_id","created_at"],"type":"object"},"SendCallEventRequest":{"description":"Send a call event to the other user","nullable":true,"properties":{"custom":{"additionalProperties":{},"title":"Custom","type":"object","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"title":"SendCallEventRequest","type":"object"},"SendCallEventResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"SendCallEventResponse","type":"object"},"SendEventRequest":{"nullable":true,"properties":{"event":{"$ref":"#/components/schemas/EventRequest","x-stream-index":"001"}},"required":["event"],"type":"object"},"SendMessageRequest":{"nullable":true,"properties":{"force_moderation":{"type":"boolean","x-stream-index":"007"},"keep_channel_hidden":{"type":"boolean","x-stream-index":"008"},"message":{"$ref":"#/components/schemas/MessageRequest","x-stream-index":"001"},"pending":{"type":"boolean","x-stream-index":"006"},"pending_message_metadata":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"005"},"skip_enrich_url":{"type":"boolean","x-stream-index":"003"},"skip_push":{"type":"boolean","x-stream-index":"002"}},"required":["message"],"type":"object"},"SendMessageResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Message response","title":"Message","x-stream-index":"001"},"pending_message_metadata":{"additionalProperties":{"type":"string"},"description":"Pending message metadata","title":"Pending message metadata","type":"object","x-stream-index":"002"}},"required":["message","duration"],"type":"object"},"SendReactionRequest":{"nullable":true,"properties":{"enforce_unique":{"description":"Whether to replace all existing user reactions","title":"Enforce unique","type":"boolean","x-stream-index":"003"},"reaction":{"$ref":"#/components/schemas/ReactionRequest","x-stream-index":"002"},"skip_push":{"description":"Skips any mobile push notifications","title":"Skip push","type":"boolean","x-stream-index":"004"}},"required":["reaction"],"type":"object"},"SendReactionResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001"},"reaction":{"$ref":"#/components/schemas/ReactionResponse","x-stream-index":"002"}},"required":["message","reaction","duration"],"title":"Response","type":"object"},"SendUserCustomEventRequest":{"nullable":true,"properties":{"event":{"$ref":"#/components/schemas/UserCustomEventRequest","x-stream-index":"001"}},"required":["event"],"type":"object"},"SessionSettings":{"properties":{"inactivity_timeout_seconds":{"format":"int32","maximum":900,"minimum":5,"type":"integer","x-stream-index":"001"}},"required":["inactivity_timeout_seconds"],"type":"object"},"SessionSettingsRequest":{"properties":{"inactivity_timeout_seconds":{"format":"int32","maximum":900,"minimum":5,"type":"integer","x-stream-index":"001"}},"required":["inactivity_timeout_seconds"],"type":"object"},"SessionSettingsResponse":{"properties":{"inactivity_timeout_seconds":{"format":"int32","maximum":900,"minimum":5,"type":"integer","x-stream-index":"001"}},"required":["inactivity_timeout_seconds"],"type":"object"},"ShadowBlockActionRequest":{"type":"object"},"SharedLocation":{"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"013"},"channel_cid":{"type":"string","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"010"},"created_by_device_id":{"type":"string","x-stream-index":"008"},"end_at":{"format":"date-time","type":"number","x-stream-index":"009"},"latitude":{"format":"float","maximum":90,"minimum":18446744073709552000,"type":"number","x-stream-index":"006"},"longitude":{"format":"float","maximum":180,"minimum":18446744073709552000,"type":"number","x-stream-index":"007"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"012"},"message_id":{"type":"string","x-stream-index":"004"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"011"},"user_id":{"type":"string","x-stream-index":"005"}},"required":["channel_cid","message_id","user_id","created_by_device_id","created_at","updated_at"],"type":"object"},"SharedLocationResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001.011"},"channel_cid":{"description":"Channel CID","title":"string","type":"string","x-stream-index":"001.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.008"},"created_by_device_id":{"description":"Device ID that created the live location","title":"string","type":"string","x-stream-index":"001.006"},"duration":{"type":"string","x-stream-index":"002.001"},"end_at":{"description":"Time when the live location expires","format":"date-time","title":"string","type":"number","x-stream-index":"001.007"},"latitude":{"description":"Latitude coordinate","format":"float","title":"number","type":"number","x-stream-index":"001.004"},"longitude":{"description":"Longitude coordinate","format":"float","title":"number","type":"number","x-stream-index":"001.005"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001.010"},"message_id":{"description":"Message ID","title":"string","type":"string","x-stream-index":"001.002"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.009"},"user_id":{"description":"User ID","title":"string","type":"string","x-stream-index":"001.003"}},"required":["channel_cid","message_id","user_id","latitude","longitude","created_by_device_id","created_at","updated_at","duration"],"type":"object"},"SharedLocationResponseData":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"011"},"channel_cid":{"type":"string","x-stream-index":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"created_by_device_id":{"type":"string","x-stream-index":"006"},"end_at":{"format":"date-time","type":"number","x-stream-index":"007"},"latitude":{"format":"float","type":"number","x-stream-index":"004"},"longitude":{"format":"float","type":"number","x-stream-index":"005"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"010"},"message_id":{"type":"string","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["channel_cid","message_id","user_id","latitude","longitude","created_by_device_id","created_at","updated_at"],"type":"object"},"SharedLocationsResponse":{"nullable":true,"properties":{"active_live_locations":{"items":{"$ref":"#/components/schemas/SharedLocationResponseData"},"type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["active_live_locations","duration"],"type":"object"},"ShowChannelRequest":{"nullable":true,"properties":{"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"002.002"},"user_id":{"type":"string","x-stream-index":"002.001"}},"type":"object"},"ShowChannelResponse":{"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"},"SingleFollowResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"follow":{"$ref":"#/components/schemas/FollowResponse","description":"The created follow relationship","title":"Follow","x-stream-index":"001"}},"required":["follow","duration"],"title":"Follow Response","type":"object"},"SortParam":{"nullable":true,"properties":{"direction":{"format":"int32","type":"integer","x-stream-index":"002"},"field":{"type":"string","x-stream-index":"001"}},"type":"object"},"SortParamRequest":{"nullable":true,"properties":{"direction":{"description":"Direction of sorting, 1 for Ascending, -1 for Descending, default is 1","format":"int32","title":"Direction","type":"integer","x-stream-index":"002"},"field":{"description":"Name of field to sort by","title":"Field","type":"string","x-stream-index":"001"}},"type":"object"},"StartCampaignRequest":{"nullable":true,"properties":{"scheduled_for":{"format":"date-time","type":"number","x-stream-index":"002"},"stop_at":{"format":"date-time","type":"number","x-stream-index":"003"}},"type":"object"},"StartCampaignResponse":{"description":"Basic response information","nullable":true,"properties":{"campaign":{"$ref":"#/components/schemas/CampaignResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"users":{"$ref":"#/components/schemas/PagerResponse","x-stream-index":"002"}},"required":["duration"],"title":"Response","type":"object"},"StartClosedCaptionsRequest":{"nullable":true,"properties":{"enable_transcription":{"description":"Enable transcriptions along with closed captions","title":"Enable Transcription","type":"boolean","x-stream-index":"002"},"external_storage":{"description":"Which external storage to use for transcriptions (only applicable if enable_transcription is true)","title":"External Storage","type":"string","x-stream-index":"003"},"language":{"description":"The spoken language in the call, if not provided the language defined in the transcription settings will be used","enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"title":"Language","type":"string","x-stream-index":"004"}},"type":"object"},"StartClosedCaptionsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"StartFrameRecordingRequest":{"nullable":true,"properties":{"recording_external_storage":{"type":"string","x-stream-index":"002"}},"title":"StartFrameRecordingRequest","type":"object"},"StartFrameRecordingResponse":{"description":"StartFrameRecordingResponse is the response payload for the start frame recording endpoint.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StartFrameRecordingResponse","type":"object"},"StartHLSBroadcastingRequest":{"description":"StartHLSBroadcastingRequest is the payload for starting an HLS broadcasting.","nullable":true,"title":"StartHLSBroadcastingRequest","type":"object"},"StartHLSBroadcastingResponse":{"description":"StartHLSBroadcastingResponse is the payload for starting an HLS broadcasting.","nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"},"playlist_url":{"description":"the URL of the HLS playlist","title":"PlaylistURL","type":"string","x-stream-index":"002"}},"required":["duration","playlist_url"],"title":"StartHLSBroadcastingResponse","type":"object"},"StartRTMPBroadcastsRequest":{"description":"StartRTMPBroadcastsRequest is the payload for starting RTMP broadcasts.","nullable":true,"properties":{"broadcasts":{"description":"List of broadcasts to start","items":{"$ref":"#/components/schemas/RTMPBroadcastRequest"},"maximum":1,"minimum":1,"title":"Broadcasts","type":"array","x-stream-index":"002"}},"required":["broadcasts"],"title":"StartRTMPBroadcastsRequest","type":"object"},"StartRTMPBroadcastsResponse":{"description":"StartRTMPBroadcastsResponse is the payload for starting an RTMP broadcast.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StartRTMPBroadcastsResponse","type":"object"},"StartRecordingRequest":{"nullable":true,"properties":{"recording_external_storage":{"type":"string","x-stream-index":"002"}},"title":"StartRecordingRequest","type":"object"},"StartRecordingResponse":{"description":"StartRecordingResponse is the response payload for the start recording endpoint.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StartRecordingResponse","type":"object"},"StartTranscriptionRequest":{"nullable":true,"properties":{"enable_closed_captions":{"description":"Enable closed captions along with transcriptions","title":"Enable Closed Captions","type":"boolean","x-stream-index":"003"},"language":{"description":"The spoken language in the call, if not provided the language defined in the transcription settings will be used","enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"title":"Language","type":"string","x-stream-index":"004"},"transcription_external_storage":{"description":"Store transcriptions in this external storage","title":"External Storage","type":"string","x-stream-index":"002"}},"type":"object"},"StartTranscriptionResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StartTranscriptionResponse","type":"object"},"StopAllRTMPBroadcastsRequest":{"nullable":true,"title":"StopAllRTMPBroadcastsRequest","type":"object"},"StopAllRTMPBroadcastsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StopAllRTMPBroadcastsResponse","type":"object"},"StopCampaignRequest":{"nullable":true,"type":"object"},"StopClosedCaptionsRequest":{"nullable":true,"properties":{"stop_transcription":{"type":"boolean","x-stream-index":"003"}},"type":"object"},"StopClosedCaptionsResponse":{"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"},"StopFrameRecordingRequest":{"nullable":true,"type":"object"},"StopFrameRecordingResponse":{"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"},"StopHLSBroadcastingRequest":{"nullable":true,"type":"object"},"StopHLSBroadcastingResponse":{"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"},"StopLiveRequest":{"nullable":true,"properties":{"continue_closed_caption":{"type":"boolean","x-stream-index":"006"},"continue_hls":{"type":"boolean","x-stream-index":"003"},"continue_recording":{"type":"boolean","x-stream-index":"004"},"continue_rtmp_broadcasts":{"type":"boolean","x-stream-index":"007"},"continue_transcription":{"type":"boolean","x-stream-index":"005"}},"title":"StopLiveRequest","type":"object"},"StopLiveResponse":{"nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"The call that was stopped","title":"Call","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["call","duration"],"title":"StopLiveResponse","type":"object"},"StopRTMPBroadcastsRequest":{"description":"Request for stopping RTMP broadcasts","nullable":true,"title":"StopRTMPBroadcastsRequest","type":"object"},"StopRTMPBroadcastsResponse":{"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"},"StopRecordingRequest":{"nullable":true,"type":"object"},"StopRecordingResponse":{"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"},"StopTranscriptionRequest":{"nullable":true,"properties":{"stop_closed_captions":{"type":"boolean","x-stream-index":"003"}},"type":"object"},"StopTranscriptionResponse":{"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"},"StoriesConfig":{"properties":{"expiration_behaviour":{"description":"Behavior when stories expire","title":"Expiration Behavior","type":"string","x-stream-index":"001"},"skip_watched":{"description":"Whether to skip already watched stories","title":"Skip Watched","type":"boolean","x-stream-index":"002"}},"title":"Stories Configuration","type":"object"},"SubmitActionRequest":{"nullable":true,"properties":{"action_type":{"description":"Type of moderation action to perform (mark_reviewed, delete_message, etc.)","enum":["mark_reviewed","delete_message","delete_activity","delete_reaction","ban","custom","unban","restore","delete_user","unblock","shadow_block","unmask","kick_user","end_call"],"title":"Action Type","type":"string","x-stream-index":"002"},"ban":{"$ref":"#/components/schemas/BanActionRequest","description":"Configuration for ban action","title":"Ban","x-stream-index":"008"},"custom":{"$ref":"#/components/schemas/CustomActionRequest","description":"Configuration for custom action","title":"Custom","x-stream-index":"009"},"delete_activity":{"$ref":"#/components/schemas/DeleteActivityRequest","description":"Configuration for activity deletion action","title":"Delete Activity","x-stream-index":"004"},"delete_message":{"$ref":"#/components/schemas/DeleteMessageRequest","description":"Configuration for message deletion action","title":"Delete Message","x-stream-index":"003"},"delete_reaction":{"$ref":"#/components/schemas/DeleteReactionRequest","description":"Configuration for reaction deletion action","title":"Delete Reaction","x-stream-index":"005"},"delete_user":{"$ref":"#/components/schemas/DeleteUserRequest","description":"Configuration for user deletion action","title":"Delete User","x-stream-index":"006"},"item_id":{"description":"UUID of the review queue item to act on","title":"Item ID","type":"string","x-stream-index":"001"},"mark_reviewed":{"$ref":"#/components/schemas/MarkReviewedRequest","description":"Configuration for marking item as reviewed","title":"Mark Reviewed","x-stream-index":"007"},"unban":{"$ref":"#/components/schemas/UnbanActionRequest","description":"Configuration for unban action","title":"Unban","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"016.002"},"user_id":{"type":"string","x-stream-index":"016.001"}},"required":["item_id","action_type"],"type":"object"},"SubmitActionResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"item":{"$ref":"#/components/schemas/ReviewQueueItemResponse","description":"Updated review queue item after action was performed","title":"Item","x-stream-index":"001"}},"required":["duration"],"type":"object"},"SubscriberAllMetrics":{"properties":{"audio":{"$ref":"#/components/schemas/SubscriberAudioMetrics","x-stream-index":"001"},"rtt_ms":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"003"},"video":{"$ref":"#/components/schemas/SubscriberVideoMetrics","x-stream-index":"002"}},"type":"object"},"SubscriberAudioMetrics":{"properties":{"concealment_pct":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"003"},"jitter_ms":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"001"},"packets_lost_pct":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"002"}},"type":"object"},"SubscriberStatsResponse":{"properties":{"total":{"format":"int32","type":"integer","x-stream-index":"001"},"total_subscribed_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"003"},"unique":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["total","unique","total_subscribed_duration_seconds"],"type":"object"},"SubscriberVideoMetrics":{"properties":{"fps_30":{"$ref":"#/components/schemas/ActiveCallsFPSStats","x-stream-index":"002"},"jitter_ms":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"001"},"packets_lost_pct":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"003"}},"type":"object"},"SubscribersMetrics":{"properties":{"all":{"$ref":"#/components/schemas/SubscriberAllMetrics","x-stream-index":"001"}},"type":"object"},"TargetResolution":{"properties":{"bitrate":{"format":"int32","maximum":6000000,"type":"integer","x-stream-index":"003"},"height":{"format":"int32","maximum":3840,"minimum":240,"type":"integer","x-stream-index":"002"},"width":{"format":"int32","maximum":3840,"minimum":240,"type":"integer","x-stream-index":"001"}},"required":["width","height","bitrate"],"type":"object"},"TextContentParameters":{"properties":{"blocklist_match":{"items":{"type":"string"},"type":"array","x-stream-index":"005"},"contains_url":{"type":"boolean","x-stream-index":"003"},"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001"},"llm_harm_labels":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"002"},"severity":{"type":"string","x-stream-index":"004"}},"type":"object"},"TextRuleParameters":{"properties":{"blocklist_match":{"items":{"type":"string"},"type":"array","x-stream-index":"007"},"contains_url":{"type":"boolean","x-stream-index":"005"},"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"llm_harm_labels":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"004"},"severity":{"type":"string","x-stream-index":"006"},"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"type":"object"},"ThreadParticipant":{"description":"Represents a user that is participating in a thread.","nullable":true,"properties":{"app_pk":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"001"},"channel_cid":{"type":"string","x-stream-index":"002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"007"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"last_read_at":{"format":"date-time","type":"number","x-stream-index":"009"},"last_thread_message_at":{"format":"date-time","type":"number","x-stream-index":"003"},"left_thread_at":{"description":"Left Thread At is the time when the user left the thread","format":"date-time","title":"Left Thread At","type":"number","x-stream-index":"008"},"thread_id":{"description":"Thead ID is unique string identifier of the thread","title":"ID","type":"string","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User is the user object","title":"User","x-stream-index":"006"},"user_id":{"description":"User ID is unique string identifier of the user","title":"User ID","type":"string","x-stream-index":"005"}},"required":["app_pk","channel_cid","created_at","last_read_at","custom"],"title":"ThreadParticipant","type":"object"},"ThreadResponse":{"properties":{"active_participant_count":{"description":"Active Participant Count","format":"int32","title":"Active Participant Count","type":"integer","x-stream-index":"009"},"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel","title":"ChannelResponse","x-stream-index":"002"},"channel_cid":{"description":"Channel CID","title":"Channel CID","type":"string","x-stream-index":"001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"012"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"Created By User","title":"User","x-stream-index":"006"},"created_by_user_id":{"description":"Created By User ID","title":"Created By User ID","type":"string","x-stream-index":"005"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"016"},"deleted_at":{"description":"Deleted At","format":"date-time","title":"Deleted At","type":"number","x-stream-index":"014"},"last_message_at":{"description":"Last Message At","format":"date-time","title":"Last Message At","type":"number","x-stream-index":"011"},"parent_message":{"$ref":"#/components/schemas/MessageResponse","description":"Parent Message","title":"Message","x-stream-index":"004"},"parent_message_id":{"description":"Parent Message ID","title":"Parent Message ID","type":"string","x-stream-index":"003"},"participant_count":{"description":"Participant Count","format":"int32","title":"Participant Count","type":"integer","x-stream-index":"008"},"reply_count":{"description":"Reply Count","format":"int32","title":"Reply Count","type":"integer","x-stream-index":"007"},"thread_participants":{"description":"Thread Participants","items":{"$ref":"#/components/schemas/ThreadParticipant"},"title":"ThreadParticipants","type":"array","x-stream-index":"010"},"title":{"description":"Title","title":"Title","type":"string","x-stream-index":"015"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"013"}},"required":["channel_cid","parent_message_id","created_by_user_id","created_at","updated_at","title","custom"],"type":"object"},"ThreadStateResponse":{"nullable":true,"properties":{"active_participant_count":{"description":"Active Participant Count","format":"int32","title":"Active Participant Count","type":"integer","x-stream-index":"001.009"},"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel","title":"ChannelResponse","x-stream-index":"001.002"},"channel_cid":{"description":"Channel CID","title":"Channel CID","type":"string","x-stream-index":"001.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.012"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"Created By User","title":"User","x-stream-index":"001.006"},"created_by_user_id":{"description":"Created By User ID","title":"Created By User ID","type":"string","x-stream-index":"001.005"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"001.016"},"deleted_at":{"description":"Deleted At","format":"date-time","title":"Deleted At","type":"number","x-stream-index":"001.014"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"004"},"last_message_at":{"description":"Last Message At","format":"date-time","title":"Last Message At","type":"number","x-stream-index":"001.011"},"latest_replies":{"items":{"$ref":"#/components/schemas/MessageResponse"},"type":"array","x-stream-index":"002"},"parent_message":{"$ref":"#/components/schemas/MessageResponse","description":"Parent Message","title":"Message","x-stream-index":"001.004"},"parent_message_id":{"description":"Parent Message ID","title":"Parent Message ID","type":"string","x-stream-index":"001.003"},"participant_count":{"description":"Participant Count","format":"int32","title":"Participant Count","type":"integer","x-stream-index":"001.008"},"read":{"items":{"$ref":"#/components/schemas/ReadStateResponse"},"type":"array","x-stream-index":"003"},"reply_count":{"description":"Reply Count","format":"int32","title":"Reply Count","type":"integer","x-stream-index":"001.007"},"thread_participants":{"description":"Thread Participants","items":{"$ref":"#/components/schemas/ThreadParticipant"},"title":"ThreadParticipants","type":"array","x-stream-index":"001.010"},"title":{"description":"Title","title":"Title","type":"string","x-stream-index":"001.015"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.013"}},"required":["channel_cid","parent_message_id","created_by_user_id","created_at","updated_at","title","custom","latest_replies"],"type":"object"},"ThreadUpdatedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"001.002"},"channel_type":{"type":"string","x-stream-index":"001.003"},"cid":{"type":"string","x-stream-index":"001.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"thread":{"$ref":"#/components/schemas/ThreadResponse","x-stream-index":"003.001"},"type":{"default":"thread.updated","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["cid","channel_id","channel_type","type","created_at"],"title":"ThreadUpdatedEvent","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"},"ThreadedCommentResponse":{"description":"A comment with an optional, depth‑limited slice of nested replies.","properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"001.011"},"confidence_score":{"format":"float","type":"number","x-stream-index":"001.022"},"controversy_score":{"format":"float","type":"number","x-stream-index":"001.023"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.014"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.006"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.016"},"downvote_count":{"format":"int32","type":"integer","x-stream-index":"001.020"},"id":{"type":"string","x-stream-index":"001.001"},"latest_reactions":{"items":{"$ref":"#/components/schemas/FeedsReactionResponse"},"type":"array","x-stream-index":"001.009"},"mentioned_users":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"001.012"},"meta":{"$ref":"#/components/schemas/RepliesMeta","description":"Pagination \u0026 depth info for this node's direct replies.","title":"Replies Meta","x-stream-index":"002"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"001.017"},"object_id":{"type":"string","x-stream-index":"001.002"},"object_type":{"type":"string","x-stream-index":"001.003"},"own_reactions":{"items":{"$ref":"#/components/schemas/FeedsReactionResponse"},"type":"array","x-stream-index":"001.024"},"parent_id":{"type":"string","x-stream-index":"001.007"},"reaction_count":{"format":"int32","type":"integer","x-stream-index":"001.008"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"001.010"},"replies":{"description":"Slice of nested comments (may be empty).","items":{"$ref":"#/components/schemas/ThreadedCommentResponse"},"title":"Replies","type":"array","x-stream-index":"003"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"001.018"},"score":{"format":"int32","type":"integer","x-stream-index":"001.021"},"status":{"type":"string","x-stream-index":"001.013"},"text":{"type":"string","x-stream-index":"001.005"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.015"},"upvote_count":{"format":"int32","type":"integer","x-stream-index":"001.019"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001.004"}},"required":["id","object_id","object_type","user","reaction_count","mentioned_users","status","created_at","updated_at","reply_count","upvote_count","downvote_count","score","confidence_score","own_reactions"],"title":"Threaded Comment","type":"object"},"Thresholds":{"description":"Sets thresholds for AI moderation","properties":{"explicit":{"$ref":"#/components/schemas/LabelThresholds","description":"Thresholds for explicit messages","title":"LabelThresholds","x-stream-index":"001"},"spam":{"$ref":"#/components/schemas/LabelThresholds","description":"Thresholds for spam","title":"LabelThresholds","x-stream-index":"002"},"toxic":{"$ref":"#/components/schemas/LabelThresholds","description":"Thresholds for toxic messages","title":"LabelThresholds","x-stream-index":"003"}},"title":"Auto moderation thresholds","type":"object"},"ThumbnailResponse":{"properties":{"image_url":{"type":"string","x-stream-index":"001"}},"required":["image_url"],"type":"object"},"ThumbnailsSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"ThumbnailsSettingsRequest":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"ThumbnailsSettingsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"Time":{"type":"object"},"TrackStatsResponse":{"nullable":true,"properties":{"duration_seconds":{"format":"int32","type":"integer","x-stream-index":"002"},"track_type":{"type":"string","x-stream-index":"001"}},"required":["track_type","duration_seconds"],"type":"object"},"TranscriptionSettings":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"title":"Mode","type":"string","x-stream-index":"002"},"language":{"description":"The language used in this call as a two letter code","enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"title":"Language","type":"string","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"title":"Mode","type":"string","x-stream-index":"001"}},"required":["mode","closed_caption_mode","languages","language"],"type":"object"},"TranscriptionSettingsRequest":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"002"},"language":{"enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"type":"string","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode"],"type":"object"},"TranscriptionSettingsResponse":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"002"},"language":{"enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"type":"string","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode","closed_caption_mode","languages","language"],"type":"object"},"TranslateMessageRequest":{"nullable":true,"properties":{"language":{"description":"Language to translate message to","enum":["af","sq","am","ar","az","bn","bs","bg","zh","zh-TW","hr","cs","da","fa-AF","nl","en","et","fi","fr","fr-CA","ka","de","el","ha","he","hi","hu","id","it","ja","ko","lv","ms","no","fa","ps","pl","pt","ro","ru","sr","sk","sl","so","es","es-MX","sw","sv","tl","ta","th","tr","uk","ur","vi","lt","ht"],"title":"Language","type":"string","x-stream-index":"001"}},"required":["language"],"type":"object"},"TruncateChannelRequest":{"nullable":true,"properties":{"hard_delete":{"description":"Permanently delete channel data (messages, reactions, etc.)","title":"Hard delete","type":"boolean","x-stream-index":"002"},"member_ids":{"description":"List of member IDs to hide message history for. If empty, truncates the channel for all members","items":{"type":"string"},"maximum":100,"title":"Member IDs","type":"array","x-stream-index":"007"},"message":{"$ref":"#/components/schemas/MessageRequest","x-stream-index":"004"},"skip_push":{"description":"When `message` is set disables all push notifications for it","title":"Skip push","type":"boolean","x-stream-index":"005"},"truncated_at":{"description":"Truncate channel data up to `truncated_at`. The system message (if provided) creation time is always greater than `truncated_at`","format":"date-time","title":"Truncated at","type":"number","x-stream-index":"006"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"008.002"},"user_id":{"type":"string","x-stream-index":"008.001"}},"type":"object"},"TruncateChannelResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Truncated channel object","title":"Channel","x-stream-index":"002"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Truncated message object","title":"Message","x-stream-index":"003"}},"required":["duration"],"type":"object"},"TypingIndicators":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"TypingIndicatorsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"UnbanActionRequest":{"type":"object"},"UnbanRequest":{"nullable":true,"properties":{"unbanned_by":{"$ref":"#/components/schemas/UserRequest","description":"Details about the user performing the unban","title":"Unbanned By","x-stream-index":"005"},"unbanned_by_id":{"description":"ID of the user performing the unban","title":"Unbanned By ID","type":"string","x-stream-index":"004"}},"type":"object"},"UnbanResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"UnblockActionRequest":{"type":"object"},"UnblockUserRequest":{"description":"UnblockUserRequest is the payload for unblocking a user.","nullable":true,"properties":{"user_id":{"description":"the user to unblock","title":"UserID","type":"string","x-stream-index":"003"}},"required":["user_id"],"title":"UnblockUserRequest","type":"object"},"UnblockUserResponse":{"description":"UnblockUserResponse is the payload for unblocking a user.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"UnblockUserResponse","type":"object"},"UnblockUsersRequest":{"nullable":true,"properties":{"blocked_user_id":{"type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"required":["blocked_user_id"],"type":"object"},"UnblockUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"UnblockedUserEvent":{"description":"This event is sent when a user is unblocked on a call,\nthis can be useful to notify the user that they can now join the call again","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.unblocked_user","description":"The type of event: \"call.unblocked_user\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user that was unblocked","title":"User","x-stream-index":"003"}},"required":["type","created_at","call_cid","user"],"title":"UnblockedUserEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"UnfollowBatchRequest":{"nullable":true,"properties":{"follows":{"description":"List of follow relationships to remove","items":{"$ref":"#/components/schemas/FollowPair"},"maximum":100,"minimum":1,"title":"Follows","type":"array","x-stream-index":"001"}},"required":["follows"],"title":"Unfollow Batch Request","type":"object"},"UnfollowBatchResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"follows":{"description":"List of follow relationships that were removed","items":{"$ref":"#/components/schemas/FollowResponse"},"title":"Follows","type":"array","x-stream-index":"001"}},"required":["follows","duration"],"title":"Unfollow Batch Response","type":"object"},"UnfollowResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"follow":{"$ref":"#/components/schemas/FollowResponse","description":"The deleted follow relationship","title":"Follow","x-stream-index":"001"}},"required":["follow","duration"],"title":"Unfollow Response","type":"object"},"UnmuteChannelRequest":{"nullable":true,"properties":{"channel_cids":{"description":"Channel CIDs to mute (if multiple channels)","items":{"type":"string"},"maximum":25,"title":"Channel CIDs","type":"array","x-stream-index":"001.002"},"expiration":{"description":"Duration of mute in milliseconds","title":"Expiration","type":"integer","x-stream-index":"001.003"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"002.002"},"user_id":{"type":"string","x-stream-index":"002.001"}},"type":"object"},"UnmuteRequest":{"nullable":true,"properties":{"target_ids":{"description":"User IDs to unmute","items":{"type":"string"},"title":"Target IDs","type":"array","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"002.002"},"user_id":{"type":"string","x-stream-index":"002.001"}},"required":["target_ids"],"title":"UnmuteRequest","type":"object"},"UnmuteResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"non_existing_users":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"required":["duration"],"title":"Response","type":"object"},"UnpinActivityResponse":{"nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","description":"The unpinned activity","title":"Activity","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"004.001"},"feed":{"description":"Fully qualified ID of the feed the activity was unpinned from","title":"Feed ID","type":"string","x-stream-index":"002"},"user_id":{"description":"ID of the user who unpinned the activity","title":"User ID","type":"string","x-stream-index":"003"}},"required":["activity","feed","user_id","duration"],"title":"Unpin Activity Response","type":"object"},"UnpinRequest":{"description":"UnpinRequest is the payload for unpinning a message.","nullable":true,"properties":{"session_id":{"description":"the session ID of the user who pinned the message","title":"SessionID","type":"string","x-stream-index":"003"},"user_id":{"description":"the user ID of the user who pinned the message","title":"UserID","type":"string","x-stream-index":"002"}},"required":["user_id","session_id"],"title":"UnpinRequest","type":"object"},"UnpinResponse":{"description":"UnpinResponse is the payload for unpinning a message.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"UnpinResponse","type":"object"},"UnreadCountsBatchRequest":{"nullable":true,"properties":{"user_ids":{"items":{"type":"string"},"maximum":100,"type":"array","x-stream-index":"001"}},"required":["user_ids"],"type":"object"},"UnreadCountsBatchResponse":{"description":"Basic response information","nullable":true,"properties":{"counts_by_user":{"additionalProperties":{"$ref":"#/components/schemas/UnreadCountsResponse"},"type":"object","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["counts_by_user","duration"],"title":"Response","type":"object"},"UnreadCountsChannel":{"properties":{"channel_id":{"type":"string","x-stream-index":"001"},"last_read":{"format":"date-time","type":"number","x-stream-index":"003"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["channel_id","unread_count","last_read"],"type":"object"},"UnreadCountsChannelType":{"properties":{"channel_count":{"format":"int32","type":"integer","x-stream-index":"002"},"channel_type":{"type":"string","x-stream-index":"001"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["channel_type","channel_count","unread_count"],"type":"object"},"UnreadCountsResponse":{"nullable":true,"properties":{"channel_type":{"items":{"$ref":"#/components/schemas/UnreadCountsChannelType"},"type":"array","x-stream-index":"005"},"channels":{"items":{"$ref":"#/components/schemas/UnreadCountsChannel"},"type":"array","x-stream-index":"004"},"threads":{"items":{"$ref":"#/components/schemas/UnreadCountsThread"},"type":"array","x-stream-index":"006"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"001"},"total_unread_count_by_team":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"003"},"total_unread_threads_count":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["total_unread_count","total_unread_threads_count","channels","channel_type","threads"],"type":"object"},"UnreadCountsThread":{"properties":{"last_read":{"format":"date-time","type":"number","x-stream-index":"002"},"last_read_message_id":{"type":"string","x-stream-index":"003"},"parent_message_id":{"type":"string","x-stream-index":"004"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"001"}},"required":["unread_count","last_read","last_read_message_id","parent_message_id"],"type":"object"},"UpdateActivityPartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"description":"Map of dot-notation field paths to new values","title":"object","type":"object","x-stream-index":"002"},"unset":{"description":"List of dot-notation paths to remove","items":{"type":"string"},"title":"[]string","type":"array","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"005.002"},"user_id":{"type":"string","x-stream-index":"005.001"}},"type":"object"},"UpdateActivityPartialResponse":{"nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","description":"The updated activity","title":"ActivityResponse","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["activity","duration"],"type":"object"},"UpdateActivityRequest":{"nullable":true,"properties":{"attachments":{"description":"List of attachments for the activity","items":{"$ref":"#/components/schemas/Attachment"},"title":"[]ActivityAttachment","type":"array","x-stream-index":"003"},"custom":{"additionalProperties":{},"description":"Custom data for the activity","title":"object","type":"object","x-stream-index":"004"},"expires_at":{"description":"Time when the activity will expire","format":"date-time","title":"string","type":"number","x-stream-index":"007"},"filter_tags":{"description":"Tags used for filtering the activity","items":{"type":"string"},"title":"[]string","type":"array","x-stream-index":"008"},"interest_tags":{"description":"Tags indicating interest categories","items":{"type":"string"},"title":"[]string","type":"array","x-stream-index":"009"},"location":{"$ref":"#/components/schemas/ActivityLocation","description":"Geographic location for the activity","title":"ActivityLocation","x-stream-index":"006"},"poll_id":{"description":"Poll ID","title":"string","type":"string","x-stream-index":"010"},"text":{"description":"The text content of the activity","title":"string","type":"string","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"012.002"},"user_id":{"type":"string","x-stream-index":"012.001"},"visibility":{"description":"Visibility setting for the activity","title":"string","type":"string","x-stream-index":"005"}},"type":"object"},"UpdateActivityResponse":{"nullable":true,"properties":{"activity":{"$ref":"#/components/schemas/ActivityResponse","description":"The updated activity","title":"ActivityResponse","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["activity","duration"],"type":"object"},"UpdateAppRequest":{"nullable":true,"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.017"},"apn_config":{"$ref":"#/components/schemas/APNConfig","x-stream-index":"001.003"},"async_moderation_config":{"$ref":"#/components/schemas/AsyncModerationConfiguration","x-stream-index":"001.039"},"async_url_enrich_enabled":{"type":"boolean","x-stream-index":"001.019"},"auto_translation_enabled":{"type":"boolean","x-stream-index":"001.018"},"before_message_send_hook_url":{"type":"string","x-stream-index":"001.020"},"cdn_expiration_seconds":{"format":"int32","maximum":1209600,"minimum":14400,"type":"integer","x-stream-index":"001.038"},"channel_hide_members_only":{"type":"boolean","x-stream-index":"001.033"},"custom_action_handler_url":{"type":"string","x-stream-index":"001.021"},"datadog_info":{"$ref":"#/components/schemas/DataDogInfo","x-stream-index":"001.040"},"disable_auth_checks":{"type":"boolean","x-stream-index":"001.001"},"disable_permissions_checks":{"type":"boolean","x-stream-index":"001.002"},"enforce_unique_usernames":{"enum":["no","app","team"],"type":"string","x-stream-index":"001.022"},"event_hooks":{"items":{"$ref":"#/components/schemas/EventHook"},"type":"array","x-stream-index":"001.046"},"feeds_moderation_enabled":{"type":"boolean","x-stream-index":"001.042"},"feeds_v2_region":{"type":"string","x-stream-index":"001.041"},"file_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","x-stream-index":"001.030"},"firebase_config":{"$ref":"#/components/schemas/FirebaseConfig","x-stream-index":"001.004"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"001.034"},"guest_user_creation_disabled":{"type":"boolean","x-stream-index":"001.043"},"huawei_config":{"$ref":"#/components/schemas/HuaweiConfig","x-stream-index":"001.005"},"image_moderation_block_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001.015"},"image_moderation_enabled":{"type":"boolean","x-stream-index":"001.016"},"image_moderation_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001.014"},"image_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","x-stream-index":"001.029"},"max_aggregated_activities_length":{"format":"int32","type":"integer","x-stream-index":"001.049"},"migrate_permissions_to_v2":{"type":"boolean","x-stream-index":"001.035"},"moderation_dashboard_preferences":{"$ref":"#/components/schemas/ModerationDashboardPreferences","x-stream-index":"001.044"},"moderation_enabled":{"type":"boolean","x-stream-index":"001.009"},"moderation_webhook_url":{"type":"string","x-stream-index":"001.010"},"multi_tenant_enabled":{"type":"boolean","x-stream-index":"001.013"},"permission_version":{"enum":["v1","v2"],"type":"string","x-stream-index":"001.011"},"push_config":{"$ref":"#/components/schemas/PushConfig","x-stream-index":"001.007"},"reminders_interval":{"format":"int32","maximum":86400,"minimum":60,"type":"integer","x-stream-index":"001.036"},"reminders_max_members":{"format":"int32","minimum":2,"type":"integer","x-stream-index":"001.037"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.031"},"sns_key":{"type":"string","x-stream-index":"001.027"},"sns_secret":{"type":"string","x-stream-index":"001.028"},"sns_topic_arn":{"type":"string","x-stream-index":"001.026"},"sqs_key":{"type":"string","x-stream-index":"001.024"},"sqs_secret":{"type":"string","x-stream-index":"001.025"},"sqs_url":{"type":"string","x-stream-index":"001.023"},"user_response_time_enabled":{"type":"boolean","x-stream-index":"001.048"},"user_search_disallowed_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"001.012"},"webhook_events":{"items":{"type":"string"},"type":"array","x-stream-index":"001.032"},"webhook_url":{"type":"string","x-stream-index":"001.008"},"xiaomi_config":{"$ref":"#/components/schemas/XiaomiConfig","x-stream-index":"001.006"}},"type":"object"},"UpdateBlockListRequest":{"nullable":true,"properties":{"team":{"type":"string","x-stream-index":"002"},"words":{"description":"List of words to block","items":{"type":"string"},"minimum":1,"title":"Words","type":"array","x-stream-index":"003"}},"title":"Update block list","type":"object","x-stream-docs-page-id":"update_block_list"},"UpdateBlockListResponse":{"description":"Basic response information","nullable":true,"properties":{"blocklist":{"$ref":"#/components/schemas/BlockListResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["duration"],"title":"Response","type":"object"},"UpdateBookmarkFolderRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"description":"Custom data for the folder","title":"Custom Data","type":"object","x-stream-index":"003"},"name":{"description":"Name of the folder","maxLength":255,"title":"Name","type":"string","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"title":"Update Bookmark Folder Request","type":"object"},"UpdateBookmarkFolderResponse":{"nullable":true,"properties":{"bookmark_folder":{"$ref":"#/components/schemas/BookmarkFolderResponse","description":"The updated bookmark folder","title":"Bookmark Folder","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["bookmark_folder","duration"],"title":"Update Bookmark Folder Response","type":"object"},"UpdateBookmarkRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"description":"Custom data for the bookmark","title":"Custom Data","type":"object","x-stream-index":"005"},"folder_id":{"description":"ID of the folder to move the bookmark to","maxLength":255,"title":"Folder ID","type":"string","x-stream-index":"002"},"new_folder":{"$ref":"#/components/schemas/AddFolderRequest","x-stream-index":"004"},"new_folder_id":{"maxLength":255,"type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"006.002"},"user_id":{"type":"string","x-stream-index":"006.001"}},"title":"Update Bookmark Request","type":"object"},"UpdateBookmarkResponse":{"nullable":true,"properties":{"bookmark":{"$ref":"#/components/schemas/BookmarkResponse","description":"The updated bookmark","title":"Bookmark","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["bookmark","duration"],"title":"Update Bookmark Response","type":"object"},"UpdateCallMembersRequest":{"description":"Update call members","nullable":true,"properties":{"remove_members":{"description":"List of userID to remove","items":{"type":"string"},"maximum":100,"title":"Remove Members","type":"array","x-stream-index":"003"},"update_members":{"description":"List of members to update or insert","items":{"$ref":"#/components/schemas/MemberRequest"},"maximum":100,"title":"Update Members","type":"array","x-stream-index":"004"}},"title":"UpdateCallMembersRequest","type":"object"},"UpdateCallMembersResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"002"}},"required":["duration","members"],"title":"Response","type":"object"},"UpdateCallRequest":{"description":"Request for updating a call","nullable":true,"properties":{"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"003"},"settings_override":{"$ref":"#/components/schemas/CallSettingsRequest","description":"the settings to change for this call","title":"Settings Override","x-stream-index":"004"},"starts_at":{"description":"the time the call is scheduled to start","format":"date-time","title":"Starts At","type":"number","x-stream-index":"005"}},"title":"UpdateCallRequest","type":"object"},"UpdateCallResponse":{"description":"Response for updating a call","nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001.001"},"duration":{"type":"string","x-stream-index":"002.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001.002"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"001.004"}},"required":["call","members","own_capabilities","blocked_users","duration"],"title":"UpdateCallResponse","type":"object"},"UpdateCallTypeRequest":{"description":"UpdateCallTypeRequest is the payload for updating a call type.","nullable":true,"properties":{"external_storage":{"type":"string","x-stream-index":"002.004"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"002.001"},"notification_settings":{"$ref":"#/components/schemas/NotificationSettings","x-stream-index":"002.002"},"settings":{"$ref":"#/components/schemas/CallSettingsRequest","x-stream-index":"002.003"}},"title":"UpdateCallTypeRequest","type":"object"},"UpdateCallTypeResponse":{"description":"UpdateCallTypeResponse is the payload for updating a call type.","nullable":true,"properties":{"created_at":{"description":"the time the call type was created","format":"date-time","title":"CreatedAt","type":"number","x-stream-index":"001.005"},"duration":{"type":"string","x-stream-index":"002.001"},"external_storage":{"description":"the external storage for the call type","title":"ExternalStorage","type":"string","x-stream-index":"001.007"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"the permissions granted to each role","title":"Grants","type":"object","x-stream-index":"001.002"},"name":{"description":"the name of the call type","title":"Name","type":"string","x-stream-index":"001.001"},"notification_settings":{"$ref":"#/components/schemas/NotificationSettings","description":"the notification settings for the call type","title":"NotificationSettings","x-stream-index":"001.004"},"settings":{"$ref":"#/components/schemas/CallSettingsResponse","description":"the settings for the call type","title":"Settings","x-stream-index":"001.003"},"updated_at":{"description":"the time the call type was last updated","format":"date-time","title":"UpdatedAt","type":"number","x-stream-index":"001.006"}},"required":["name","grants","settings","notification_settings","created_at","updated_at","duration"],"title":"UpdateCallTypeResponse","type":"object"},"UpdateChannelPartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"type":"object","x-stream-index":"002.001"},"unset":{"items":{"type":"string"},"type":"array","x-stream-index":"002.002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"title":"UpdateChannelPartialRequest","type":"object"},"UpdateChannelPartialResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Updated channel object","title":"Channel","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"members":{"description":"List of updated members","items":{"$ref":"#/components/schemas/ChannelMemberResponse"},"title":"ChannelMemberResponse","type":"array","x-stream-index":"002"}},"required":["members","duration"],"type":"object"},"UpdateChannelRequest":{"nullable":true,"properties":{"accept_invite":{"description":"Set to `true` to accept the invite","title":"Accept invite","type":"boolean","x-stream-index":"008"},"add_members":{"description":"List of user IDs to add to the channel","items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"title":"Add members","type":"array","x-stream-index":"001"},"add_moderators":{"description":"List of user IDs to make channel moderators","items":{"type":"string"},"maximum":100,"title":"Add moderators","type":"array","x-stream-index":"003"},"assign_roles":{"description":"List of channel member role assignments. If any specified user is not part of the channel, the request will fail","items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"title":"Assign roles","type":"array","x-stream-index":"006"},"cooldown":{"description":"Sets cool down period for the channel in seconds","format":"int32","maximum":120,"minimum":0,"title":"Cool down","type":"integer","x-stream-index":"007"},"data":{"$ref":"#/components/schemas/ChannelInput","x-stream-index":"013.001"},"demote_moderators":{"description":"List of user IDs to take away moderators status from","items":{"type":"string"},"maximum":100,"title":"Demote moderators","type":"array","x-stream-index":"004"},"hide_history":{"description":"Set to `true` to hide channel's history when adding new members","title":"Hide history","type":"boolean","x-stream-index":"012"},"invites":{"description":"List of user IDs to invite to the channel","items":{"$ref":"#/components/schemas/ChannelMember"},"maximum":100,"title":"Invites","type":"array","x-stream-index":"005"},"message":{"$ref":"#/components/schemas/MessageRequest","description":"Message to send to the chat when channel is successfully updated","title":"Message","x-stream-index":"010"},"reject_invite":{"description":"Set to `true` to reject the invite","title":"Reject invite","type":"boolean","x-stream-index":"009"},"remove_members":{"description":"List of user IDs to remove from the channel","items":{"type":"string"},"maximum":100,"title":"Remove members","type":"array","x-stream-index":"002"},"skip_push":{"description":"When `message` is set disables all push notifications for it","title":"Skip push","type":"boolean","x-stream-index":"011"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"014.002"},"user_id":{"type":"string","x-stream-index":"014.001"}},"title":"Channel update request","type":"object","x-stream-docs-page-id":"channel_update"},"UpdateChannelResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Updated channel","title":"Channel","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"004.001"},"members":{"description":"List of channel members","items":{"$ref":"#/components/schemas/ChannelMember"},"title":"Members","type":"array","x-stream-index":"003"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Message sent to the chat","title":"Message","x-stream-index":"002"}},"required":["members","duration"],"type":"object"},"UpdateChannelTypeRequest":{"nullable":true,"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"009.001.027"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"009.001.022"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"009.001.023"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"009.001.028"},"blocklist":{"type":"string","x-stream-index":"009.001.024"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"009.001.025"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"009.001.026"},"commands":{"description":"List of commands that channel supports","items":{"type":"string"},"title":"Commands","type":"array","x-stream-index":"009.003"},"connect_events":{"type":"boolean","x-stream-index":"009.001.004"},"count_messages":{"type":"boolean","x-stream-index":"009.001.019"},"custom_events":{"type":"boolean","x-stream-index":"009.001.012"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"004"},"mark_messages_pending":{"type":"boolean","x-stream-index":"009.001.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"009.001.021"},"mutes":{"type":"boolean","x-stream-index":"009.001.009"},"partition_size":{"format":"int32","minimum":0,"type":"integer","x-stream-index":"007"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"008"},"permissions":{"items":{"$ref":"#/components/schemas/PolicyRequest"},"type":"array","x-stream-index":"003"},"polls":{"type":"boolean","x-stream-index":"009.001.016"},"push_notifications":{"type":"boolean","x-stream-index":"009.001.013"},"quotes":{"type":"boolean","x-stream-index":"009.001.008"},"reactions":{"type":"boolean","x-stream-index":"009.001.006"},"read_events":{"type":"boolean","x-stream-index":"009.001.003"},"reminders":{"type":"boolean","x-stream-index":"009.001.014"},"replies":{"type":"boolean","x-stream-index":"009.001.007"},"search":{"type":"boolean","x-stream-index":"009.001.005"},"shared_locations":{"type":"boolean","x-stream-index":"009.001.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"009.001.031"},"typing_events":{"type":"boolean","x-stream-index":"009.001.002"},"uploads":{"type":"boolean","x-stream-index":"009.001.010"},"url_enrichment":{"type":"boolean","x-stream-index":"009.001.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"009.001.017"}},"required":["max_message_length","automod","automod_behavior"],"type":"object"},"UpdateChannelTypeResponse":{"nullable":true,"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"003.001.027"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"003.001.022"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.001.023"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"003.001.028"},"blocklist":{"type":"string","x-stream-index":"003.001.024"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"003.001.025"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"003.001.026"},"commands":{"items":{"type":"string"},"type":"array","x-stream-index":"003.003"},"connect_events":{"type":"boolean","x-stream-index":"003.001.004"},"count_messages":{"type":"boolean","x-stream-index":"003.001.019"},"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002.003"},"custom_events":{"type":"boolean","x-stream-index":"003.001.012"},"duration":{"type":"string","x-stream-index":"004.001"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"002"},"mark_messages_pending":{"type":"boolean","x-stream-index":"003.001.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"003.001.021"},"mutes":{"type":"boolean","x-stream-index":"003.001.009"},"name":{"type":"string","x-stream-index":"003.001.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"003.001.029"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"003.001.030"},"permissions":{"items":{"$ref":"#/components/schemas/PolicyRequest"},"type":"array","x-stream-index":"001"},"polls":{"type":"boolean","x-stream-index":"003.001.016"},"push_notifications":{"type":"boolean","x-stream-index":"003.001.013"},"quotes":{"type":"boolean","x-stream-index":"003.001.008"},"reactions":{"type":"boolean","x-stream-index":"003.001.006"},"read_events":{"type":"boolean","x-stream-index":"003.001.003"},"reminders":{"type":"boolean","x-stream-index":"003.001.014"},"replies":{"type":"boolean","x-stream-index":"003.001.007"},"search":{"type":"boolean","x-stream-index":"003.001.005"},"shared_locations":{"type":"boolean","x-stream-index":"003.001.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"003.001.031"},"typing_events":{"type":"boolean","x-stream-index":"003.001.002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"003.002.004"},"uploads":{"type":"boolean","x-stream-index":"003.001.010"},"url_enrichment":{"type":"boolean","x-stream-index":"003.001.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"003.001.017"}},"required":["permissions","grants","name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","count_messages","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","created_at","updated_at","commands","duration"],"type":"object"},"UpdateCommandRequest":{"nullable":true,"properties":{"args":{"description":"Arguments help text, shown in commands auto-completion","maxLength":255,"title":"Arguments","type":"string","x-stream-index":"003"},"description":{"description":"Description, shown in commands auto-completion","maxLength":255,"title":"Description","type":"string","x-stream-index":"002"},"set":{"description":"Set name used for grouping commands","maxLength":255,"title":"Set","type":"string","x-stream-index":"004"}},"required":["description"],"title":"UpdateCommandRequest","type":"object"},"UpdateCommandResponse":{"nullable":true,"properties":{"command":{"$ref":"#/components/schemas/Command","description":"Command object","title":"Command","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["duration"],"title":"UpdateCommandResponse","type":"object"},"UpdateCommentRequest":{"nullable":true,"properties":{"comment":{"description":"Updated text content of the comment","title":"Comment","type":"string","x-stream-index":"002"},"custom":{"additionalProperties":{},"description":"Updated custom data for the comment","title":"Custom Data","type":"object","x-stream-index":"003"},"skip_push":{"type":"boolean","x-stream-index":"004"}},"title":"Update Comment Request","type":"object"},"UpdateCommentResponse":{"nullable":true,"properties":{"comment":{"$ref":"#/components/schemas/CommentResponse","description":"The updated comment","title":"Comment","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["comment","duration"],"title":"Update Comment Response","type":"object"},"UpdateExternalStorageRequest":{"description":"External storage","nullable":true,"properties":{"aws_s3":{"$ref":"#/components/schemas/S3Request","description":"Only required if you want to create an Amazon S3 storage","title":"AwsS3","x-stream-index":"003.004"},"azure_blob":{"$ref":"#/components/schemas/AzureRequest","description":"Only required if you want to create an Azure Blob Storage","title":"AzureBlob","x-stream-index":"003.006"},"bucket":{"description":"The name of the bucket on the service provider","title":"Bucket","type":"string","x-stream-index":"003.002"},"gcs_credentials":{"type":"string","x-stream-index":"003.005"},"path":{"description":"The path prefix to use for storing files","title":"Path","type":"string","x-stream-index":"003.003"},"storage_type":{"description":"The type of storage to use","enum":["s3","gcs","abs"],"title":"StorageType","type":"string","x-stream-index":"003.001"}},"required":["storage_type","bucket"],"title":"ExternalStorageRequest","type":"object"},"UpdateExternalStorageResponse":{"description":"Basic response information","nullable":true,"properties":{"bucket":{"type":"string","x-stream-index":"001.003"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"name":{"type":"string","x-stream-index":"001.001"},"path":{"type":"string","x-stream-index":"001.004"},"type":{"enum":["s3","gcs","abs"],"type":"string","x-stream-index":"001.002"}},"required":["name","type","bucket","path","duration"],"title":"Response","type":"object"},"UpdateFeedGroupRequest":{"nullable":true,"properties":{"activity_processors":{"description":"Configuration for activity processors (max 10)","items":{"$ref":"#/components/schemas/ActivityProcessorConfig"},"maximum":10,"title":"Activity Processors","type":"array","x-stream-index":"005"},"activity_selectors":{"description":"Configuration for activity selectors (max 10)","items":{"$ref":"#/components/schemas/ActivitySelectorConfig"},"maximum":10,"title":"Activity Selectors","type":"array","x-stream-index":"006"},"aggregation":{"$ref":"#/components/schemas/AggregationConfig","description":"Configuration for activity aggregation","title":"Aggregation","x-stream-index":"008"},"custom":{"additionalProperties":{},"description":"Custom data for the feed group","title":"Custom Data","type":"object","x-stream-index":"004"},"notification":{"$ref":"#/components/schemas/NotificationConfig","description":"Configuration for notifications","title":"Notification","x-stream-index":"002"},"push_notification":{"$ref":"#/components/schemas/PushNotificationConfig","x-stream-index":"003"},"ranking":{"$ref":"#/components/schemas/RankingConfig","description":"Configuration for activity ranking","title":"Ranking","x-stream-index":"007"}},"title":"Update Feed Group Request","type":"object"},"UpdateFeedGroupResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"feed_group":{"$ref":"#/components/schemas/FeedGroupResponse","description":"The updated feed group","title":"Feed Group","x-stream-index":"001"}},"required":["feed_group","duration"],"title":"Update Feed Group Response","type":"object"},"UpdateFeedMembersRequest":{"nullable":true,"properties":{"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"006.001"},"members":{"description":"List of members to upsert, remove, or set","items":{"$ref":"#/components/schemas/FeedMemberRequest"},"title":"Members","type":"array","x-stream-index":"004"},"next":{"type":"string","x-stream-index":"006.002"},"operation":{"description":"Type of update operation to perform","enum":["upsert","remove","set"],"title":"Operation","type":"string","x-stream-index":"003"},"prev":{"type":"string","x-stream-index":"006.003"}},"required":["operation"],"title":"Update Feed Members Request","type":"object"},"UpdateFeedMembersResponse":{"description":"Basic response information","nullable":true,"properties":{"added":{"items":{"$ref":"#/components/schemas/FeedMemberResponse"},"type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"004.001"},"removed_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"updated":{"items":{"$ref":"#/components/schemas/FeedMemberResponse"},"type":"array","x-stream-index":"002"}},"required":["added","updated","removed_ids","duration"],"title":"Response","type":"object"},"UpdateFeedRequest":{"nullable":true,"properties":{"created_by_id":{"description":"ID of the new feed creator (owner)","title":"Created By ID","type":"string","x-stream-index":"003"},"custom":{"additionalProperties":{},"description":"Custom data for the feed","title":"Custom Data","type":"object","x-stream-index":"004"}},"title":"Update Feed Request","type":"object"},"UpdateFeedResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"feed":{"$ref":"#/components/schemas/FeedResponse","description":"The updated feed","title":"Feed","x-stream-index":"001"}},"required":["feed","duration"],"title":"Update Feed Response","type":"object"},"UpdateFeedViewRequest":{"nullable":true,"properties":{"activity_processors":{"description":"Updated activity processors","items":{"$ref":"#/components/schemas/ActivityProcessorConfig"},"title":"Activity Processors","type":"array","x-stream-index":"002.002"},"activity_selectors":{"description":"Updated configuration for selecting activities","items":{"$ref":"#/components/schemas/ActivitySelectorConfig"},"title":"Activity Selectors","type":"array","x-stream-index":"002.001"},"aggregation":{"$ref":"#/components/schemas/AggregationConfig","description":"Updated configuration for aggregating activities","title":"Aggregation","x-stream-index":"002.004"},"ranking":{"$ref":"#/components/schemas/RankingConfig","description":"Updated configuration for ranking activities","title":"Ranking","x-stream-index":"002.003"}},"title":"Update Feed View Request","type":"object"},"UpdateFeedViewResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"feed_view":{"$ref":"#/components/schemas/FeedViewResponse","description":"The updated feed view","title":"Feed View","x-stream-index":"001"}},"required":["feed_view","duration"],"title":"Update Feed View Response","type":"object"},"UpdateFollowRequest":{"nullable":true,"properties":{"create_notification_activity":{"description":"Whether to create a notification activity for this follow","title":"Create Notification Activity","type":"boolean","x-stream-index":"001.004"},"custom":{"additionalProperties":{},"description":"Custom data for the follow relationship","title":"Custom Data","type":"object","x-stream-index":"001.002"},"follower_role":{"type":"string","x-stream-index":"002"},"push_preference":{"description":"Push preference for the follow relationship","enum":["all","none"],"title":"Push Preference","type":"string","x-stream-index":"001.003"},"skip_push":{"type":"boolean","x-stream-index":"001.005"},"source":{"description":"Fully qualified ID of the source feed","maxLength":255,"title":"Source Feed","type":"string","x-stream-index":"001.001.001"},"target":{"description":"Fully qualified ID of the target feed","maxLength":255,"title":"Target Feed","type":"string","x-stream-index":"001.001.002"}},"required":["source","target"],"title":"Update Follow Request","type":"object"},"UpdateFollowResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"follow":{"$ref":"#/components/schemas/FollowResponse","description":"Details of the updated follow relationship","title":"Follow","x-stream-index":"001"}},"required":["follow","duration"],"title":"Update Follow Response","type":"object"},"UpdateLiveLocationRequest":{"nullable":true,"properties":{"end_at":{"description":"Time when the live location expires","format":"date-time","title":"string","type":"number","x-stream-index":"004"},"latitude":{"description":"Latitude coordinate","format":"float","maximum":90,"minimum":18446744073709552000,"title":"number","type":"number","x-stream-index":"002"},"longitude":{"description":"Longitude coordinate","format":"float","maximum":180,"minimum":18446744073709552000,"title":"number","type":"number","x-stream-index":"003"},"message_id":{"description":"Live location ID","title":"string","type":"string","x-stream-index":"001"}},"required":["message_id"],"type":"object"},"UpdateMemberPartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"type":"object","x-stream-index":"002.001"},"unset":{"items":{"type":"string"},"type":"array","x-stream-index":"002.002"}},"type":"object"},"UpdateMemberPartialResponse":{"nullable":true,"properties":{"channel_member":{"$ref":"#/components/schemas/ChannelMemberResponse","description":"Updated channel member","title":"Channel member","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["duration"],"type":"object"},"UpdateMembershipLevelRequest":{"description":"Partial update request for membership level fields. Only specified fields will be updated.","nullable":true,"properties":{"custom":{"additionalProperties":{},"description":"Custom data for the membership level","title":"Custom Data","type":"object","x-stream-index":"006"},"description":{"description":"Optional description of the membership level","maxLength":1000,"title":"Description","type":"string","x-stream-index":"003"},"name":{"description":"Display name for the membership level","maxLength":255,"title":"Name","type":"string","x-stream-index":"002"},"priority":{"description":"Priority level (higher numbers = higher priority)","format":"int32","minimum":0,"title":"Priority","type":"integer","x-stream-index":"004"},"tags":{"description":"Activity tags this membership level gives access to","items":{"type":"string"},"maximum":255,"title":"Tags","type":"array","x-stream-index":"005"}},"title":"Update Membership Level Request","type":"object"},"UpdateMembershipLevelResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"002.001"},"membership_level":{"$ref":"#/components/schemas/MembershipLevelResponse","description":"The updated membership level","title":"Membership Level","x-stream-index":"001"}},"required":["membership_level","duration"],"title":"Update Membership Level Response","type":"object"},"UpdateMessagePartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"description":"Sets new field values","title":"Set","type":"object","x-stream-index":"002.001","x-stream-map":{"key":"field","title":"Value","description":"New value to set"}},"skip_enrich_url":{"description":"Skip enriching the URL in the message","title":"SkipEnrichURL","type":"boolean","x-stream-index":"001"},"unset":{"description":"Array of field names to unset","items":{"type":"string"},"title":"Unset","type":"array","x-stream-index":"002.002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"type":"object"},"UpdateMessagePartialResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","description":"Updated message","title":"Message","x-stream-index":"001"},"pending_message_metadata":{"additionalProperties":{"type":"string"},"description":"Pending message metadata","title":"PendingMessageMetadata","type":"object","x-stream-index":"002"}},"required":["duration"],"type":"object"},"UpdateMessageRequest":{"nullable":true,"properties":{"message":{"$ref":"#/components/schemas/MessageRequest","description":"Message","title":"MessageRequest","x-stream-index":"001"},"skip_enrich_url":{"description":"Skip enrich URL","title":"boolean","type":"boolean","x-stream-index":"003"},"skip_push":{"type":"boolean","x-stream-index":"002"}},"required":["message"],"type":"object"},"UpdateMessageResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001"},"pending_message_metadata":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"002"}},"required":["message","duration"],"title":"Response","type":"object"},"UpdatePollOptionRequest":{"nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"004"},"id":{"description":"Option ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"},"text":{"description":"Option text","title":"string","type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"005.002"},"user_id":{"type":"string","x-stream-index":"005.001"}},"required":["id","text"],"type":"object"},"UpdatePollPartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"description":"Sets new field values","title":"Set","type":"object","x-stream-index":"002.001","x-stream-map":{"key":"field","title":"Value","description":"New value to set"}},"unset":{"description":"Array of field names to unset","items":{"type":"string"},"title":"Unset","type":"array","x-stream-index":"002.002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"type":"object"},"UpdatePollRequest":{"nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"011"},"allow_answers":{"description":"Allow answers","title":"boolean","type":"boolean","x-stream-index":"009"},"allow_user_suggested_options":{"description":"Allow user suggested options","title":"boolean","type":"boolean","x-stream-index":"008"},"description":{"description":"Poll description","title":"string","type":"string","x-stream-index":"003"},"enforce_unique_vote":{"description":"Enforce unique vote","title":"boolean","type":"boolean","x-stream-index":"005"},"id":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"},"is_closed":{"description":"Is closed","title":"boolean","type":"boolean","x-stream-index":"010"},"max_votes_allowed":{"description":"Max votes allowed","format":"int32","maximum":10,"title":"integer","type":"integer","x-stream-index":"007"},"name":{"description":"Poll name","title":"string","type":"string","x-stream-index":"002"},"options":{"description":"Poll options","items":{"$ref":"#/components/schemas/PollOptionRequest"},"maximum":100,"title":"PollOptions","type":"array","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"012.002"},"user_id":{"type":"string","x-stream-index":"012.001"},"voting_visibility":{"description":"Voting visibility","enum":["anonymous","public"],"title":"string","type":"string","x-stream-index":"006"}},"required":["id","name"],"type":"object"},"UpdateReminderRequest":{"nullable":true,"properties":{"remind_at":{"format":"date-time","type":"number","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"type":"object"},"UpdateReminderResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"001"}},"required":["reminder","duration"],"title":"Response","type":"object"},"UpdateThreadPartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"description":"Sets new field values","title":"Set","type":"object","x-stream-index":"004.001","x-stream-map":{"key":"field","title":"Value","description":"New value to set"}},"unset":{"description":"Array of field names to unset","items":{"type":"string"},"title":"Unset","type":"array","x-stream-index":"004.002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"type":"object"},"UpdateThreadPartialResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"thread":{"$ref":"#/components/schemas/ThreadResponse","description":"Updated thread (not enriched)","title":"Thread","x-stream-index":"001"}},"required":["thread","duration"],"type":"object"},"UpdateUserPartialRequest":{"properties":{"id":{"description":"User ID to update","title":"ID","type":"string","x-stream-index":"001"},"set":{"additionalProperties":{},"type":"object","x-stream-index":"002.001"},"unset":{"items":{"type":"string"},"type":"array","x-stream-index":"002.002"}},"required":["id"],"type":"object"},"UpdateUserPermissionsRequest":{"nullable":true,"properties":{"grant_permissions":{"items":{"type":"string"},"type":"array","x-stream-index":"002"},"revoke_permissions":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"user_id":{"type":"string","x-stream-index":"001"}},"required":["user_id"],"type":"object"},"UpdateUserPermissionsResponse":{"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"},"UpdateUsersPartialRequest":{"nullable":true,"properties":{"users":{"items":{"$ref":"#/components/schemas/UpdateUserPartialRequest"},"maximum":100,"type":"array","x-stream-index":"001"}},"required":["users"],"type":"object"},"UpdateUsersRequest":{"nullable":true,"properties":{"users":{"additionalProperties":{"$ref":"#/components/schemas/UserRequest"},"description":"Object containing users","title":"Users","type":"object","x-stream-index":"001","x-stream-map":{"key":"user_id"}}},"required":["users"],"type":"object"},"UpdateUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"membership_deletion_task_id":{"type":"string","x-stream-index":"002"},"users":{"additionalProperties":{"$ref":"#/components/schemas/FullUserResponse"},"description":"Object containing users","title":"Users","type":"object","x-stream-index":"001","x-stream-map":{"key":"user_id"}}},"required":["users","membership_deletion_task_id","duration"],"type":"object"},"UpdatedCallPermissionsEvent":{"description":"This event is sent to notify about permission changes for a user, clients receiving this event should update their UI accordingly","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"own_capabilities":{"description":"The capabilities of the current user","items":{"$ref":"#/components/schemas/OwnCapability"},"title":"Own capabilities","type":"array","x-stream-index":"004"},"type":{"default":"call.permissions_updated","description":"The type of event: \"call.permissions_updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who received the new permissions","title":"User","x-stream-index":"003"}},"required":["type","created_at","call_cid","user","own_capabilities"],"title":"UpdatedCallPermissionsEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"UpsertActivitiesRequest":{"nullable":true,"properties":{"activities":{"description":"List of activities to create or update","items":{"$ref":"#/components/schemas/ActivityRequest"},"maximum":100,"minimum":1,"title":"Activities","type":"array","x-stream-index":"001"}},"required":["activities"],"title":"Upsert Activities Request","type":"object"},"UpsertActivitiesResponse":{"nullable":true,"properties":{"activities":{"description":"List of created or updated activities","items":{"$ref":"#/components/schemas/ActivityResponse"},"title":"Activities","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["activities","duration"],"title":"Upsert Activities Response","type":"object"},"UpsertConfigRequest":{"nullable":true,"properties":{"ai_image_config":{"$ref":"#/components/schemas/AIImageConfig","description":"Configuration for AI image analysis","title":"AI Image Config","x-stream-index":"011"},"ai_text_config":{"$ref":"#/components/schemas/AITextConfig","description":"Configuration for AI text analysis","title":"AI Text Config","x-stream-index":"008"},"ai_video_config":{"$ref":"#/components/schemas/AIVideoConfig","description":"Configuration for AI video analysis","title":"AI Video Config","x-stream-index":"012"},"async":{"description":"Whether moderation should be performed asynchronously","title":"Async","type":"boolean","x-stream-index":"003"},"automod_platform_circumvention_config":{"$ref":"#/components/schemas/AutomodPlatformCircumventionConfig","description":"Configuration for platform circumvention detection","title":"Automod Platform Circumvention Config","x-stream-index":"005"},"automod_semantic_filters_config":{"$ref":"#/components/schemas/AutomodSemanticFiltersConfig","description":"Configuration for semantic filtering","title":"Automod Semantic Filters Config","x-stream-index":"006"},"automod_toxicity_config":{"$ref":"#/components/schemas/AutomodToxicityConfig","description":"Configuration for toxicity detection","title":"Automod Toxicity Config","x-stream-index":"004"},"aws_rekognition_config":{"$ref":"#/components/schemas/AIImageConfig","x-stream-index":"016"},"block_list_config":{"$ref":"#/components/schemas/BlockListConfig","description":"Configuration for block list filtering","title":"Block List Config","x-stream-index":"007"},"bodyguard_config":{"$ref":"#/components/schemas/AITextConfig","x-stream-index":"015"},"google_vision_config":{"$ref":"#/components/schemas/GoogleVisionConfig","description":"Configuration for Google Vision integration","title":"Google Vision Config","x-stream-index":"010"},"key":{"description":"Unique identifier for the moderation configuration","title":"Key","type":"string","x-stream-index":"001"},"llm_config":{"$ref":"#/components/schemas/LLMConfig","description":"Configuration for customer-configured LLM moderation","title":"LLM Config","x-stream-index":"009"},"rule_builder_config":{"$ref":"#/components/schemas/RuleBuilderConfig","description":"Configuration for custom rule builder (max 3 rules, max 5 conditions per rule)","title":"Rule Builder Config","x-stream-index":"014"},"team":{"description":"Team associated with the configuration","maxLength":128,"minLength":1,"title":"Team","type":"string","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"018.002"},"user_id":{"type":"string","x-stream-index":"018.001"},"velocity_filter_config":{"$ref":"#/components/schemas/VelocityFilterConfig","description":"Configuration for velocity-based filtering","title":"Velocity Filter Config","x-stream-index":"013"},"video_call_rule_config":{"$ref":"#/components/schemas/VideoCallRuleConfig","x-stream-index":"017"}},"required":["key"],"type":"object"},"UpsertConfigResponse":{"nullable":true,"properties":{"config":{"$ref":"#/components/schemas/ConfigResponse","description":"The created or updated moderation configuration","title":"Config","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["duration"],"type":"object"},"UpsertModerationRuleRequest":{"nullable":true,"properties":{"action":{"$ref":"#/components/schemas/RuleBuilderAction","x-stream-index":"009"},"conditions":{"items":{"$ref":"#/components/schemas/RuleBuilderCondition"},"type":"array","x-stream-index":"006"},"config_keys":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"cooldown_period":{"type":"string","x-stream-index":"010"},"description":{"type":"string","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"011"},"groups":{"items":{"$ref":"#/components/schemas/RuleBuilderConditionGroup"},"type":"array","x-stream-index":"008"},"logic":{"type":"string","x-stream-index":"007"},"name":{"type":"string","x-stream-index":"001"},"rule_type":{"type":"string","x-stream-index":"005"},"team":{"type":"string","x-stream-index":"004"}},"required":["name","rule_type","action"],"type":"object"},"UpsertModerationRuleResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"rule":{"$ref":"#/components/schemas/ModerationRuleV2Response","x-stream-index":"002"}},"required":["duration"],"title":"Response","type":"object"},"UpsertModerationTemplateRequest":{"nullable":true,"properties":{"config":{"$ref":"#/components/schemas/FeedsModerationTemplateConfig","description":"Configuration for the moderation template","title":"Config","x-stream-index":"002"},"name":{"description":"Name of the moderation template","title":"Name","type":"string","x-stream-index":"001"}},"required":["name","config"],"type":"object"},"UpsertModerationTemplateResponse":{"nullable":true,"properties":{"config":{"$ref":"#/components/schemas/FeedsModerationTemplateConfig","description":"Configuration for the moderation template","title":"Config","x-stream-index":"002"},"created_at":{"description":"When the template was created","format":"date-time","title":"Created At","type":"number","x-stream-index":"003"},"duration":{"type":"string","x-stream-index":"005.001"},"name":{"description":"Name of the moderation template","title":"Name","type":"string","x-stream-index":"001"},"updated_at":{"description":"When the template was last updated","format":"date-time","title":"Updated At","type":"number","x-stream-index":"004"}},"required":["name","created_at","updated_at","duration"],"type":"object"},"UpsertPushPreferencesRequest":{"nullable":true,"properties":{"preferences":{"description":"A list of push preferences for channels, calls, or the user.","items":{"$ref":"#/components/schemas/PushPreferenceInput"},"type":"array","x-stream-index":"001"}},"required":["preferences"],"type":"object"},"UpsertPushPreferencesResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"user_channel_preferences":{"additionalProperties":{"additionalProperties":{"$ref":"#/components/schemas/ChannelPushPreferences"},"type":"object"},"description":"The channel specific push notification preferences, only returned for channels you've edited.","title":"User Channel Notification Preferences","type":"object","x-stream-index":"002"},"user_preferences":{"additionalProperties":{"$ref":"#/components/schemas/PushPreferences"},"description":"The user preferences, always returned regardless if you edited it","title":"User Preferences","type":"object","x-stream-index":"001"}},"required":["user_preferences","user_channel_preferences","duration"],"type":"object"},"UpsertPushProviderRequest":{"nullable":true,"properties":{"push_provider":{"$ref":"#/components/schemas/PushProvider","x-stream-index":"001"}},"type":"object"},"UpsertPushProviderResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"push_provider":{"$ref":"#/components/schemas/PushProviderResponse","x-stream-index":"001"}},"required":["push_provider","duration"],"title":"Response","type":"object"},"UpsertPushTemplateRequest":{"nullable":true,"properties":{"enable_push":{"description":"Whether to send push notification for this event","title":"boolean","type":"boolean","x-stream-index":"002"},"event_type":{"description":"Event type (message.new, message.updated, reaction.new)","enum":["message.new","message.updated","reaction.new","notification.reminder_due","feeds.activity.added","feeds.comment.added","feeds.activity.reaction.added","feeds.comment.reaction.added","feeds.follow.created","feeds.notification_feed.updated"],"title":"string","type":"string","x-stream-index":"003"},"push_provider_name":{"description":"Push provider name","title":"string","type":"string","x-stream-index":"004"},"push_provider_type":{"description":"Push provider type (firebase, apn)","enum":["firebase","apn"],"title":"string","type":"string","x-stream-index":"005"},"template":{"description":"Push template","title":"string","type":"string","x-stream-index":"006"}},"required":["event_type","push_provider_type"],"type":"object"},"UpsertPushTemplateResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"template":{"$ref":"#/components/schemas/PushTemplate","x-stream-index":"002"}},"required":["duration"],"title":"Response","type":"object"},"User":{"properties":{"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"046"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"017"},"banned":{"type":"boolean","x-stream-index":"016"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"013"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"023"},"language":{"type":"string","x-stream-index":"035"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"026"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"042"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"005"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"009"}},"required":["id","role","teams_role","custom","banned","online"],"type":"object"},"UserBannedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"006.002"},"channel_type":{"type":"string","x-stream-index":"006.003"},"cid":{"type":"string","x-stream-index":"006.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008.002"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"001"},"expiration":{"format":"date-time","type":"number","x-stream-index":"003"},"reason":{"type":"string","x-stream-index":"004"},"shadow":{"type":"boolean","x-stream-index":"002"},"team":{"type":"string","x-stream-index":"005.001"},"type":{"default":"user.banned","type":"string","x-stream-index":"008.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007.001"}},"required":["created_by","shadow","cid","channel_id","channel_type","type","created_at"],"title":"UserBannedEvent","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"},"UserCreatedWithinParameters":{"properties":{"max_age":{"type":"string","x-stream-index":"001"}},"type":"object"},"UserCustomEventRequest":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"001"}},"required":["type"],"type":"object"},"UserCustomPropertyParameters":{"properties":{"operator":{"type":"string","x-stream-index":"002"},"property_key":{"type":"string","x-stream-index":"001"}},"type":"object"},"UserDeactivatedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"001"},"type":{"default":"user.deactivated","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["created_by","type","created_at"],"title":"UserDeactivatedEvent","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"},"UserDeletedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"delete_conversation_channels":{"type":"boolean","x-stream-index":"005"},"hard_delete":{"type":"boolean","x-stream-index":"003.001"},"mark_messages_deleted":{"type":"boolean","x-stream-index":"004"},"type":{"default":"user.deleted","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"001.001"}},"required":["type","created_at","hard_delete","mark_messages_deleted","delete_conversation_channels"],"title":"UserDeletedEvent","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"},"UserFeedbackReport":{"properties":{"count_by_rating":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001"},"unreported_count":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["count_by_rating","unreported_count"],"type":"object"},"UserFeedbackReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateUserFeedbackReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"UserFeedbackResponse":{"properties":{"cid":{"type":"string","x-stream-index":"001"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"009"},"platform":{"$ref":"#/components/schemas/PlatformDataResponse","x-stream-index":"008"},"rating":{"format":"int32","type":"integer","x-stream-index":"004"},"reason":{"type":"string","x-stream-index":"005"},"sdk":{"type":"string","x-stream-index":"006"},"sdk_version":{"type":"string","x-stream-index":"007"},"session_id":{"type":"string","x-stream-index":"002"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["cid","session_id","user_id","rating","reason","sdk","sdk_version","platform"],"type":"object"},"UserFlaggedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"target_user":{"type":"string","x-stream-index":"002"},"target_users":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"type":{"default":"user.flagged","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"001"}},"required":["type","created_at"],"title":"UserFlaggedEvent","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"},"UserMessagesDeletedEvent":{"description":"This event is sent when a user's message get deleted. The event contains information about the user whose messages got deleted.","nullable":true,"properties":{"channel_custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.005"},"channel_id":{"description":"The ID of the channel where the target user's messages were deleted","title":"Channel ID","type":"string","x-stream-index":"001.002.002"},"channel_member_count":{"format":"int32","type":"integer","x-stream-index":"001.001.004"},"channel_type":{"description":"The type of the channel where the target user's messages were deleted","title":"Channel Type","type":"string","x-stream-index":"001.002.001"},"cid":{"description":"The CID of the channel where the target user's messages were deleted","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":"number","x-stream-index":"001.001.001.001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.001.001.001.007"},"hard_delete":{"description":"Whether Messages were hard deleted","title":"Hard Delete","type":"boolean","x-stream-index":"003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.001.001.001.004"},"team":{"description":"The team of the channel where the target user's messages were deleted","title":"Team","type":"string","x-stream-index":"001.001.003"},"type":{"default":"user.messages.deleted","description":"The type of event: \"user.messages.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001.001.001.002"},"user":{"$ref":"#/components/schemas/UserResponseCommonFields","description":"The target user whose messages got deleted","title":"User","x-stream-index":"002.001"}},"required":["type","created_at","custom","user"],"title":"UserMessagesDeletedEvent","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"},"UserMute":{"nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"expires":{"description":"Date/time of mute expiration","format":"date-time","title":"Expires","type":"number","x-stream-index":"008"},"target":{"$ref":"#/components/schemas/User","description":"User who's muted","title":"Target","x-stream-index":"007"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/User","description":"Owner of channel mute","title":"User","x-stream-index":"005"}},"required":["created_at","updated_at"],"type":"object"},"UserMuteResponse":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"expires":{"format":"date-time","type":"number","x-stream-index":"003"},"target":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"}},"required":["created_at","updated_at"],"type":"object"},"UserMutedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"target_user":{"type":"string","x-stream-index":"001"},"target_users":{"items":{"type":"string"},"type":"array","x-stream-index":"002"},"type":{"default":"user.muted","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"UserMutedEvent","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"},"UserRatingReportResponse":{"properties":{"average":{"format":"float","type":"number","x-stream-index":"002"},"count":{"format":"int32","type":"integer","x-stream-index":"001"}},"required":["count","average"],"type":"object"},"UserReactivatedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"type":{"default":"user.reactivated","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"001"}},"required":["type","created_at"],"title":"UserReactivatedEvent","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"},"UserRequest":{"description":"User request object","properties":{"custom":{"additionalProperties":{},"description":"Custom user data","title":"Custom","type":"object","x-stream-index":"004"},"id":{"description":"User ID","title":"ID","type":"string","x-stream-index":"001"},"image":{"description":"User's profile image URL","title":"Image","type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"006"},"language":{"type":"string","x-stream-index":"005"},"name":{"description":"Optional name of user","title":"Name","type":"string","x-stream-index":"002"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"007"},"role":{"description":"User's global role","title":"Role","type":"string","x-stream-index":"008"},"teams":{"description":"List of teams the user belongs to","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"010"},"teams_role":{"additionalProperties":{"type":"string"},"description":"Map of team-specific roles for the user","title":"TeamsRole","type":"object","x-stream-index":"009"}},"required":["id"],"title":"UserRequest","type":"object"},"UserResponse":{"description":"User response object","properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"ban_expires":{"description":"Date when ban expires","format":"date-time","title":"Ban expires","type":"number","x-stream-index":"003"},"banned":{"description":"Whether a user is banned or not","title":"Banned","type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.017"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"001.004"},"deactivated_at":{"description":"Date of deactivation","format":"date-time","title":"Deactivated at","type":"number","x-stream-index":"001.016"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"001.011"},"devices":{"description":"List of devices user is using","items":{"$ref":"#/components/schemas/DeviceResponse"},"title":"Devices","type":"array","x-stream-index":"006"},"id":{"description":"Unique user identifier","title":"ID","type":"string","x-stream-index":"001.001"},"image":{"title":"Image","type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"007"},"language":{"description":"Preferred language of a user","title":"Language","type":"string","x-stream-index":"001.005"},"last_active":{"description":"Date of last activity","format":"date-time","title":"Last active","type":"number","x-stream-index":"001.014"},"name":{"description":"Optional name of user","title":"Name","type":"string","x-stream-index":"001.002"},"online":{"description":"Whether a user online or not","title":"Online","type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","description":"User privacy settings","title":"Privacy settings","x-stream-index":"005"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettingsResponse","description":"User push notification settings","title":"Push notifications","x-stream-index":"004"},"revoke_tokens_issued_before":{"description":"Revocation date for tokens","format":"date-time","title":"Revoke tokens issued before","type":"number","x-stream-index":"001.015"},"role":{"description":"Determines the set of user permissions","title":"Role","type":"string","x-stream-index":"001.006"},"shadow_banned":{"description":"Whether a user is shadow banned","title":"Shadow banned","type":"boolean","x-stream-index":"002"},"teams":{"description":"List of teams user is a part of","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids","shadow_banned","invisible"],"title":"UserResponse","type":"object"},"UserResponseCommonFields":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"018"},"banned":{"type":"boolean","x-stream-index":"012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"017"},"created_at":{"format":"date-time","type":"number","x-stream-index":"009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"id":{"type":"string","x-stream-index":"001"},"image":{"type":"string","x-stream-index":"003"},"language":{"type":"string","x-stream-index":"005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"014"},"name":{"type":"string","x-stream-index":"002"},"online":{"type":"boolean","x-stream-index":"013"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"015"},"role":{"type":"string","x-stream-index":"006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids"],"type":"object"},"UserResponsePrivacyFields":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"banned":{"type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.017"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.011"},"id":{"type":"string","x-stream-index":"001.001"},"image":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"003"},"language":{"type":"string","x-stream-index":"001.005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"001.014"},"name":{"type":"string","x-stream-index":"001.002"},"online":{"type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"002"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.015"},"role":{"type":"string","x-stream-index":"001.006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids"],"type":"object"},"UserRuleParameters":{"properties":{"max_age":{"type":"string","x-stream-index":"001"}},"type":"object"},"UserUnbannedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"002.002"},"channel_type":{"type":"string","x-stream-index":"002.003"},"cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"005.002"},"shadow":{"type":"boolean","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"004.001"},"type":{"default":"user.unbanned","type":"string","x-stream-index":"005.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["shadow","cid","channel_id","channel_type","type","created_at"],"title":"UserUnbannedEvent","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"},"UserUnmutedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"target_user":{"type":"string","x-stream-index":"002"},"target_users":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"type":{"default":"user.unmuted","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"001"}},"required":["type","created_at"],"title":"UserUnmutedEvent","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"},"UserUnreadReminderEvent":{"properties":{"channels":{"additionalProperties":{"$ref":"#/components/schemas/ChannelMessages"},"type":"object","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"user.unread_message_reminder","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002"}},"required":["type","created_at","channels"],"title":"UserUnreadReminderEvent","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"},"UserUpdatedEvent":{"description":"This event is sent when a user gets updated. The event contains information about the updated user.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"type":{"default":"user.updated","description":"The type of event: \"user.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.002"},"user":{"$ref":"#/components/schemas/UserResponsePrivacyFields","description":"The updated user","title":"User","x-stream-index":"002.001"}},"required":["type","created_at","custom","user"],"title":"UserUpdatedEvent","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"},"VelocityFilterConfig":{"properties":{"advanced_filters":{"type":"boolean","x-stream-index":"007"},"async":{"type":"boolean","x-stream-index":"001"},"cascading_actions":{"type":"boolean","x-stream-index":"004"},"cids_per_user":{"format":"int32","type":"integer","x-stream-index":"006"},"enabled":{"type":"boolean","x-stream-index":"002"},"first_message_only":{"type":"boolean","x-stream-index":"005"},"rules":{"items":{"$ref":"#/components/schemas/VelocityFilterConfigRule"},"type":"array","x-stream-index":"003"}},"required":["enabled","rules","cascading_actions","first_message_only","cids_per_user","advanced_filters"],"type":"object"},"VelocityFilterConfigRule":{"properties":{"action":{"enum":["flag","shadow","remove","ban"],"type":"string","x-stream-index":"001"},"ban_duration":{"format":"int32","type":"integer","x-stream-index":"002"},"cascading_action":{"enum":["flag","shadow","remove","ban"],"type":"string","x-stream-index":"006"},"cascading_threshold":{"format":"int64","type":"integer","x-stream-index":"005"},"check_message_context":{"type":"boolean","x-stream-index":"009"},"fast_spam_threshold":{"format":"int32","type":"integer","x-stream-index":"007"},"fast_spam_ttl":{"format":"int32","type":"integer","x-stream-index":"010"},"ip_ban":{"type":"boolean","x-stream-index":"004"},"probation_period":{"format":"int32","type":"integer","x-stream-index":"014"},"shadow_ban":{"type":"boolean","x-stream-index":"003"},"slow_spam_ban_duration":{"format":"int32","type":"integer","x-stream-index":"012"},"slow_spam_threshold":{"format":"int32","type":"integer","x-stream-index":"008"},"slow_spam_ttl":{"format":"int32","type":"integer","x-stream-index":"011"},"url_only":{"type":"boolean","x-stream-index":"013"}},"required":["action","ban_duration","shadow_ban","ip_ban","cascading_threshold","cascading_action","fast_spam_threshold","slow_spam_threshold","check_message_context","fast_spam_ttl","slow_spam_ttl","url_only","probation_period"],"type":"object"},"VideoCallRuleConfig":{"properties":{"rules":{"additionalProperties":{"$ref":"#/components/schemas/HarmConfig"},"type":"object","x-stream-index":"001"}},"required":["rules"],"type":"object"},"VideoContentParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"type":"object"},"VideoEndCallRequest":{"type":"object"},"VideoKickUserRequest":{"type":"object"},"VideoOrientation":{"properties":{"orientation":{"type":"integer","x-stream-index":"004"}},"type":"object"},"VideoReactionOverTimeResponse":{"properties":{"by_minute":{"items":{"$ref":"#/components/schemas/CountByMinuteResponse"},"type":"array","x-stream-index":"001"}},"type":"object"},"VideoReactionsResponse":{"nullable":true,"properties":{"count_over_time":{"$ref":"#/components/schemas/VideoReactionOverTimeResponse","x-stream-index":"002"},"reaction":{"type":"string","x-stream-index":"001"}},"required":["reaction"],"type":"object"},"VideoRuleParameters":{"properties":{"harm_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"threshold":{"format":"int32","type":"integer","x-stream-index":"001"},"time_window":{"type":"string","x-stream-index":"002"}},"type":"object"},"VideoSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"camera_default_on":{"type":"boolean","x-stream-index":"004"},"camera_facing":{"enum":["front","back","external"],"type":"string","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled","target_resolution","camera_default_on","camera_facing"],"type":"object"},"VideoSettingsRequest":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"camera_default_on":{"type":"boolean","x-stream-index":"004"},"camera_facing":{"enum":["front","back","external"],"type":"string","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"type":"object"},"VideoSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"camera_default_on":{"type":"boolean","x-stream-index":"004"},"camera_facing":{"enum":["front","back","external"],"type":"string","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled","target_resolution","camera_default_on","camera_facing"],"type":"object"},"VoteData":{"properties":{"answer_text":{"type":"string","x-stream-index":"002"},"option_id":{"maxLength":255,"type":"string","x-stream-index":"001"}},"type":"object"},"WSEvent":{"description":"Represents an BaseEvent that happened in Stream Chat","properties":{"automoderation":{"type":"boolean","x-stream-index":"023"},"automoderation_scores":{"$ref":"#/components/schemas/ModerationResponse","x-stream-index":"024"},"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"011"},"channel_id":{"type":"string","x-stream-index":"004"},"channel_last_message_at":{"format":"date-time","type":"number","x-stream-index":"007"},"channel_type":{"type":"string","x-stream-index":"005"},"cid":{"type":"string","x-stream-index":"003"},"connection_id":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"028"},"created_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"022"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"027"},"me":{"$ref":"#/components/schemas/OwnUserResponse","x-stream-index":"019"},"member":{"$ref":"#/components/schemas/ChannelMember","x-stream-index":"014"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"008"},"message_update":{"$ref":"#/components/schemas/MessageUpdate","x-stream-index":"009"},"parent_id":{"type":"string","x-stream-index":"025"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"015"},"poll_vote":{"$ref":"#/components/schemas/PollVoteResponseData","x-stream-index":"016"},"reaction":{"$ref":"#/components/schemas/ReactionResponse","x-stream-index":"010"},"reason":{"type":"string","x-stream-index":"021"},"team":{"type":"string","x-stream-index":"026"},"thread":{"$ref":"#/components/schemas/ThreadResponse","x-stream-index":"013"},"thread_id":{"type":"string","x-stream-index":"012"},"type":{"type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"017"},"user_id":{"type":"string","x-stream-index":"018"},"watcher_count":{"format":"int32","type":"integer","x-stream-index":"020"}},"required":["type","custom","created_at"],"title":"Event","type":"object","x-stream-docs-page-id":"event_object"},"WebhookEvent":{"description":"The discriminator object for all webhook events, it maps events' payload to the final type","discriminator":{"mapping":{"*":"#/components/schemas/AnyEvent","activity.marked":"#/components/schemas/ActivityMarkedEvent","call.accepted":"#/components/schemas/CallAcceptedEvent","call.blocked_user":"#/components/schemas/BlockedUserEvent","call.closed_caption":"#/components/schemas/ClosedCaptionEvent","call.closed_captions_failed":"#/components/schemas/CallClosedCaptionsFailedEvent","call.closed_captions_started":"#/components/schemas/CallClosedCaptionsStartedEvent","call.closed_captions_stopped":"#/components/schemas/CallClosedCaptionsStoppedEvent","call.created":"#/components/schemas/CallCreatedEvent","call.deleted":"#/components/schemas/CallDeletedEvent","call.ended":"#/components/schemas/CallEndedEvent","call.frame_recording_failed":"#/components/schemas/CallFrameRecordingFailedEvent","call.frame_recording_ready":"#/components/schemas/CallFrameRecordingFrameReadyEvent","call.frame_recording_started":"#/components/schemas/CallFrameRecordingStartedEvent","call.frame_recording_stopped":"#/components/schemas/CallFrameRecordingStoppedEvent","call.hls_broadcasting_failed":"#/components/schemas/CallHLSBroadcastingFailedEvent","call.hls_broadcasting_started":"#/components/schemas/CallHLSBroadcastingStartedEvent","call.hls_broadcasting_stopped":"#/components/schemas/CallHLSBroadcastingStoppedEvent","call.kicked_user":"#/components/schemas/KickedUserEvent","call.live_started":"#/components/schemas/CallLiveStartedEvent","call.member_added":"#/components/schemas/CallMemberAddedEvent","call.member_removed":"#/components/schemas/CallMemberRemovedEvent","call.member_updated":"#/components/schemas/CallMemberUpdatedEvent","call.member_updated_permission":"#/components/schemas/CallMemberUpdatedPermissionEvent","call.missed":"#/components/schemas/CallMissedEvent","call.moderation_blur":"#/components/schemas/CallModerationBlurEvent","call.moderation_warning":"#/components/schemas/CallModerationWarningEvent","call.notification":"#/components/schemas/CallNotificationEvent","call.permission_request":"#/components/schemas/PermissionRequestEvent","call.permissions_updated":"#/components/schemas/UpdatedCallPermissionsEvent","call.reaction_new":"#/components/schemas/CallReactionEvent","call.recording_failed":"#/components/schemas/CallRecordingFailedEvent","call.recording_ready":"#/components/schemas/CallRecordingReadyEvent","call.recording_started":"#/components/schemas/CallRecordingStartedEvent","call.recording_stopped":"#/components/schemas/CallRecordingStoppedEvent","call.rejected":"#/components/schemas/CallRejectedEvent","call.ring":"#/components/schemas/CallRingEvent","call.rtmp_broadcast_failed":"#/components/schemas/CallRtmpBroadcastFailedEvent","call.rtmp_broadcast_started":"#/components/schemas/CallRtmpBroadcastStartedEvent","call.rtmp_broadcast_stopped":"#/components/schemas/CallRtmpBroadcastStoppedEvent","call.session_ended":"#/components/schemas/CallSessionEndedEvent","call.session_participant_count_updated":"#/components/schemas/CallSessionParticipantCountsUpdatedEvent","call.session_participant_joined":"#/components/schemas/CallSessionParticipantJoinedEvent","call.session_participant_left":"#/components/schemas/CallSessionParticipantLeftEvent","call.session_started":"#/components/schemas/CallSessionStartedEvent","call.stats_report_ready":"#/components/schemas/CallStatsReportReadyEvent","call.transcription_failed":"#/components/schemas/CallTranscriptionFailedEvent","call.transcription_ready":"#/components/schemas/CallTranscriptionReadyEvent","call.transcription_started":"#/components/schemas/CallTranscriptionStartedEvent","call.transcription_stopped":"#/components/schemas/CallTranscriptionStoppedEvent","call.unblocked_user":"#/components/schemas/UnblockedUserEvent","call.updated":"#/components/schemas/CallUpdatedEvent","call.user_feedback_submitted":"#/components/schemas/CallUserFeedbackSubmittedEvent","call.user_muted":"#/components/schemas/CallUserMutedEvent","campaign.completed":"#/components/schemas/CampaignCompletedEvent","campaign.started":"#/components/schemas/CampaignStartedEvent","channel.created":"#/components/schemas/ChannelCreatedEvent","channel.deleted":"#/components/schemas/ChannelDeletedEvent","channel.frozen":"#/components/schemas/ChannelFrozenEvent","channel.hidden":"#/components/schemas/ChannelHiddenEvent","channel.muted":"#/components/schemas/ChannelMutedEvent","channel.truncated":"#/components/schemas/ChannelTruncatedEvent","channel.unfrozen":"#/components/schemas/ChannelUnFrozenEvent","channel.unmuted":"#/components/schemas/ChannelUnmutedEvent","channel.updated":"#/components/schemas/ChannelUpdatedEvent","channel.visible":"#/components/schemas/ChannelVisibleEvent","custom":"#/components/schemas/CustomVideoEvent","export.bulk_image_moderation.error":"#/components/schemas/AsyncExportErrorEvent","export.bulk_image_moderation.success":"#/components/schemas/AsyncBulkImageModerationEvent","export.channels.error":"#/components/schemas/AsyncExportErrorEvent","export.channels.success":"#/components/schemas/AsyncExportChannelsEvent","export.moderation_logs.error":"#/components/schemas/AsyncExportErrorEvent","export.moderation_logs.success":"#/components/schemas/AsyncExportModerationLogsEvent","export.users.error":"#/components/schemas/AsyncExportErrorEvent","export.users.success":"#/components/schemas/AsyncExportUsersEvent","feeds.activity.added":"#/components/schemas/ActivityAddedEvent","feeds.activity.deleted":"#/components/schemas/ActivityDeletedEvent","feeds.activity.marked":"#/components/schemas/ActivityMarkEvent","feeds.activity.pinned":"#/components/schemas/ActivityPinnedEvent","feeds.activity.reaction.added":"#/components/schemas/ActivityReactionAddedEvent","feeds.activity.reaction.deleted":"#/components/schemas/ActivityReactionDeletedEvent","feeds.activity.reaction.updated":"#/components/schemas/ActivityReactionUpdatedEvent","feeds.activity.removed_from_feed":"#/components/schemas/ActivityRemovedFromFeedEvent","feeds.activity.unpinned":"#/components/schemas/ActivityUnpinnedEvent","feeds.activity.updated":"#/components/schemas/ActivityUpdatedEvent","feeds.bookmark.added":"#/components/schemas/BookmarkAddedEvent","feeds.bookmark.deleted":"#/components/schemas/BookmarkDeletedEvent","feeds.bookmark.updated":"#/components/schemas/BookmarkUpdatedEvent","feeds.bookmark_folder.deleted":"#/components/schemas/BookmarkFolderDeletedEvent","feeds.bookmark_folder.updated":"#/components/schemas/BookmarkFolderUpdatedEvent","feeds.comment.added":"#/components/schemas/CommentAddedEvent","feeds.comment.deleted":"#/components/schemas/CommentDeletedEvent","feeds.comment.reaction.added":"#/components/schemas/CommentReactionAddedEvent","feeds.comment.reaction.deleted":"#/components/schemas/CommentReactionDeletedEvent","feeds.comment.reaction.updated":"#/components/schemas/CommentReactionUpdatedEvent","feeds.comment.updated":"#/components/schemas/CommentUpdatedEvent","feeds.feed.created":"#/components/schemas/FeedCreatedEvent","feeds.feed.deleted":"#/components/schemas/FeedDeletedEvent","feeds.feed.updated":"#/components/schemas/FeedUpdatedEvent","feeds.feed_group.changed":"#/components/schemas/FeedGroupChangedEvent","feeds.feed_group.deleted":"#/components/schemas/FeedGroupDeletedEvent","feeds.feed_member.added":"#/components/schemas/FeedMemberAddedEvent","feeds.feed_member.removed":"#/components/schemas/FeedMemberRemovedEvent","feeds.feed_member.updated":"#/components/schemas/FeedMemberUpdatedEvent","feeds.follow.created":"#/components/schemas/FollowCreatedEvent","feeds.follow.deleted":"#/components/schemas/FollowDeletedEvent","feeds.follow.updated":"#/components/schemas/FollowUpdatedEvent","feeds.notification_feed.updated":"#/components/schemas/NotificationFeedUpdatedEvent","flag.updated":"#/components/schemas/FlagUpdatedEvent","member.added":"#/components/schemas/MemberAddedEvent","member.removed":"#/components/schemas/MemberRemovedEvent","member.updated":"#/components/schemas/MemberUpdatedEvent","message.deleted":"#/components/schemas/MessageDeletedEvent","message.flagged":"#/components/schemas/MessageFlaggedEvent","message.new":"#/components/schemas/MessageNewEvent","message.pending":"#/components/schemas/PendingMessageEvent","message.read":"#/components/schemas/MessageReadEvent","message.unblocked":"#/components/schemas/MessageUnblockedEvent","message.undeleted":"#/components/schemas/MessageUndeletedEvent","message.updated":"#/components/schemas/MessageUpdatedEvent","moderation.custom_action":"#/components/schemas/ModerationCustomActionEvent","moderation.flagged":"#/components/schemas/ModerationFlaggedEvent","moderation.mark_reviewed":"#/components/schemas/ModerationMarkReviewedEvent","moderation_check.completed":"#/components/schemas/ModerationCheckCompletedEvent","notification.mark_unread":"#/components/schemas/NotificationMarkUnreadEvent","notification.reminder_due":"#/components/schemas/ReminderNotificationEvent","notification.thread_message_new":"#/components/schemas/MessageNewEvent","reaction.deleted":"#/components/schemas/ReactionDeletedEvent","reaction.new":"#/components/schemas/ReactionNewEvent","reaction.updated":"#/components/schemas/ReactionUpdatedEvent","reminder.created":"#/components/schemas/ReminderCreatedEvent","reminder.deleted":"#/components/schemas/ReminderDeletedEvent","reminder.updated":"#/components/schemas/ReminderUpdatedEvent","review_queue_item.new":"#/components/schemas/ReviewQueueItemNewEvent","review_queue_item.updated":"#/components/schemas/ReviewQueueItemUpdatedEvent","thread.updated":"#/components/schemas/ThreadUpdatedEvent","user.banned":"#/components/schemas/UserBannedEvent","user.deactivated":"#/components/schemas/UserDeactivatedEvent","user.deleted":"#/components/schemas/UserDeletedEvent","user.flagged":"#/components/schemas/UserFlaggedEvent","user.messages.deleted":"#/components/schemas/UserMessagesDeletedEvent","user.muted":"#/components/schemas/UserMutedEvent","user.reactivated":"#/components/schemas/UserReactivatedEvent","user.unbanned":"#/components/schemas/UserUnbannedEvent","user.unmuted":"#/components/schemas/UserUnmutedEvent","user.unread_message_reminder":"#/components/schemas/UserUnreadReminderEvent","user.updated":"#/components/schemas/UserUpdatedEvent"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/ActivityAddedEvent"},{"$ref":"#/components/schemas/ActivityDeletedEvent"},{"$ref":"#/components/schemas/ActivityMarkEvent"},{"$ref":"#/components/schemas/ActivityMarkedEvent"},{"$ref":"#/components/schemas/ActivityPinnedEvent"},{"$ref":"#/components/schemas/ActivityReactionAddedEvent"},{"$ref":"#/components/schemas/ActivityReactionDeletedEvent"},{"$ref":"#/components/schemas/ActivityReactionUpdatedEvent"},{"$ref":"#/components/schemas/ActivityRemovedFromFeedEvent"},{"$ref":"#/components/schemas/ActivityUnpinnedEvent"},{"$ref":"#/components/schemas/ActivityUpdatedEvent"},{"$ref":"#/components/schemas/AnyEvent"},{"$ref":"#/components/schemas/AsyncBulkImageModerationEvent"},{"$ref":"#/components/schemas/AsyncExportChannelsEvent"},{"$ref":"#/components/schemas/AsyncExportErrorEvent"},{"$ref":"#/components/schemas/AsyncExportErrorEvent"},{"$ref":"#/components/schemas/AsyncExportErrorEvent"},{"$ref":"#/components/schemas/AsyncExportErrorEvent"},{"$ref":"#/components/schemas/AsyncExportModerationLogsEvent"},{"$ref":"#/components/schemas/AsyncExportUsersEvent"},{"$ref":"#/components/schemas/BlockedUserEvent"},{"$ref":"#/components/schemas/BookmarkAddedEvent"},{"$ref":"#/components/schemas/BookmarkDeletedEvent"},{"$ref":"#/components/schemas/BookmarkFolderDeletedEvent"},{"$ref":"#/components/schemas/BookmarkFolderUpdatedEvent"},{"$ref":"#/components/schemas/BookmarkUpdatedEvent"},{"$ref":"#/components/schemas/CallAcceptedEvent"},{"$ref":"#/components/schemas/CallClosedCaptionsFailedEvent"},{"$ref":"#/components/schemas/CallClosedCaptionsStartedEvent"},{"$ref":"#/components/schemas/CallClosedCaptionsStoppedEvent"},{"$ref":"#/components/schemas/CallCreatedEvent"},{"$ref":"#/components/schemas/CallDeletedEvent"},{"$ref":"#/components/schemas/CallEndedEvent"},{"$ref":"#/components/schemas/CallFrameRecordingFailedEvent"},{"$ref":"#/components/schemas/CallFrameRecordingFrameReadyEvent"},{"$ref":"#/components/schemas/CallFrameRecordingStartedEvent"},{"$ref":"#/components/schemas/CallFrameRecordingStoppedEvent"},{"$ref":"#/components/schemas/CallHLSBroadcastingFailedEvent"},{"$ref":"#/components/schemas/CallHLSBroadcastingStartedEvent"},{"$ref":"#/components/schemas/CallHLSBroadcastingStoppedEvent"},{"$ref":"#/components/schemas/CallLiveStartedEvent"},{"$ref":"#/components/schemas/CallMemberAddedEvent"},{"$ref":"#/components/schemas/CallMemberRemovedEvent"},{"$ref":"#/components/schemas/CallMemberUpdatedEvent"},{"$ref":"#/components/schemas/CallMemberUpdatedPermissionEvent"},{"$ref":"#/components/schemas/CallMissedEvent"},{"$ref":"#/components/schemas/CallModerationBlurEvent"},{"$ref":"#/components/schemas/CallModerationWarningEvent"},{"$ref":"#/components/schemas/CallNotificationEvent"},{"$ref":"#/components/schemas/CallReactionEvent"},{"$ref":"#/components/schemas/CallRecordingFailedEvent"},{"$ref":"#/components/schemas/CallRecordingReadyEvent"},{"$ref":"#/components/schemas/CallRecordingStartedEvent"},{"$ref":"#/components/schemas/CallRecordingStoppedEvent"},{"$ref":"#/components/schemas/CallRejectedEvent"},{"$ref":"#/components/schemas/CallRingEvent"},{"$ref":"#/components/schemas/CallRtmpBroadcastFailedEvent"},{"$ref":"#/components/schemas/CallRtmpBroadcastStartedEvent"},{"$ref":"#/components/schemas/CallRtmpBroadcastStoppedEvent"},{"$ref":"#/components/schemas/CallSessionEndedEvent"},{"$ref":"#/components/schemas/CallSessionParticipantCountsUpdatedEvent"},{"$ref":"#/components/schemas/CallSessionParticipantJoinedEvent"},{"$ref":"#/components/schemas/CallSessionParticipantLeftEvent"},{"$ref":"#/components/schemas/CallSessionStartedEvent"},{"$ref":"#/components/schemas/CallStatsReportReadyEvent"},{"$ref":"#/components/schemas/CallTranscriptionFailedEvent"},{"$ref":"#/components/schemas/CallTranscriptionReadyEvent"},{"$ref":"#/components/schemas/CallTranscriptionStartedEvent"},{"$ref":"#/components/schemas/CallTranscriptionStoppedEvent"},{"$ref":"#/components/schemas/CallUpdatedEvent"},{"$ref":"#/components/schemas/CallUserFeedbackSubmittedEvent"},{"$ref":"#/components/schemas/CallUserMutedEvent"},{"$ref":"#/components/schemas/CampaignCompletedEvent"},{"$ref":"#/components/schemas/CampaignStartedEvent"},{"$ref":"#/components/schemas/ChannelCreatedEvent"},{"$ref":"#/components/schemas/ChannelDeletedEvent"},{"$ref":"#/components/schemas/ChannelFrozenEvent"},{"$ref":"#/components/schemas/ChannelHiddenEvent"},{"$ref":"#/components/schemas/ChannelMutedEvent"},{"$ref":"#/components/schemas/ChannelTruncatedEvent"},{"$ref":"#/components/schemas/ChannelUnFrozenEvent"},{"$ref":"#/components/schemas/ChannelUnmutedEvent"},{"$ref":"#/components/schemas/ChannelUpdatedEvent"},{"$ref":"#/components/schemas/ChannelVisibleEvent"},{"$ref":"#/components/schemas/ClosedCaptionEvent"},{"$ref":"#/components/schemas/CommentAddedEvent"},{"$ref":"#/components/schemas/CommentDeletedEvent"},{"$ref":"#/components/schemas/CommentReactionAddedEvent"},{"$ref":"#/components/schemas/CommentReactionDeletedEvent"},{"$ref":"#/components/schemas/CommentReactionUpdatedEvent"},{"$ref":"#/components/schemas/CommentUpdatedEvent"},{"$ref":"#/components/schemas/CustomVideoEvent"},{"$ref":"#/components/schemas/FeedCreatedEvent"},{"$ref":"#/components/schemas/FeedDeletedEvent"},{"$ref":"#/components/schemas/FeedGroupChangedEvent"},{"$ref":"#/components/schemas/FeedGroupDeletedEvent"},{"$ref":"#/components/schemas/FeedMemberAddedEvent"},{"$ref":"#/components/schemas/FeedMemberRemovedEvent"},{"$ref":"#/components/schemas/FeedMemberUpdatedEvent"},{"$ref":"#/components/schemas/FeedUpdatedEvent"},{"$ref":"#/components/schemas/FlagUpdatedEvent"},{"$ref":"#/components/schemas/FollowCreatedEvent"},{"$ref":"#/components/schemas/FollowDeletedEvent"},{"$ref":"#/components/schemas/FollowUpdatedEvent"},{"$ref":"#/components/schemas/KickedUserEvent"},{"$ref":"#/components/schemas/MemberAddedEvent"},{"$ref":"#/components/schemas/MemberRemovedEvent"},{"$ref":"#/components/schemas/MemberUpdatedEvent"},{"$ref":"#/components/schemas/MessageDeletedEvent"},{"$ref":"#/components/schemas/MessageFlaggedEvent"},{"$ref":"#/components/schemas/MessageNewEvent"},{"$ref":"#/components/schemas/MessageNewEvent"},{"$ref":"#/components/schemas/MessageReadEvent"},{"$ref":"#/components/schemas/MessageUnblockedEvent"},{"$ref":"#/components/schemas/MessageUndeletedEvent"},{"$ref":"#/components/schemas/MessageUpdatedEvent"},{"$ref":"#/components/schemas/ModerationCheckCompletedEvent"},{"$ref":"#/components/schemas/ModerationCustomActionEvent"},{"$ref":"#/components/schemas/ModerationFlaggedEvent"},{"$ref":"#/components/schemas/ModerationMarkReviewedEvent"},{"$ref":"#/components/schemas/NotificationFeedUpdatedEvent"},{"$ref":"#/components/schemas/NotificationMarkUnreadEvent"},{"$ref":"#/components/schemas/PendingMessageEvent"},{"$ref":"#/components/schemas/PermissionRequestEvent"},{"$ref":"#/components/schemas/ReactionDeletedEvent"},{"$ref":"#/components/schemas/ReactionNewEvent"},{"$ref":"#/components/schemas/ReactionUpdatedEvent"},{"$ref":"#/components/schemas/ReminderCreatedEvent"},{"$ref":"#/components/schemas/ReminderDeletedEvent"},{"$ref":"#/components/schemas/ReminderNotificationEvent"},{"$ref":"#/components/schemas/ReminderUpdatedEvent"},{"$ref":"#/components/schemas/ReviewQueueItemNewEvent"},{"$ref":"#/components/schemas/ReviewQueueItemUpdatedEvent"},{"$ref":"#/components/schemas/ThreadUpdatedEvent"},{"$ref":"#/components/schemas/UnblockedUserEvent"},{"$ref":"#/components/schemas/UpdatedCallPermissionsEvent"},{"$ref":"#/components/schemas/UserBannedEvent"},{"$ref":"#/components/schemas/UserDeactivatedEvent"},{"$ref":"#/components/schemas/UserDeletedEvent"},{"$ref":"#/components/schemas/UserFlaggedEvent"},{"$ref":"#/components/schemas/UserMessagesDeletedEvent"},{"$ref":"#/components/schemas/UserMutedEvent"},{"$ref":"#/components/schemas/UserReactivatedEvent"},{"$ref":"#/components/schemas/UserUnbannedEvent"},{"$ref":"#/components/schemas/UserUnmutedEvent"},{"$ref":"#/components/schemas/UserUnreadReminderEvent"},{"$ref":"#/components/schemas/UserUpdatedEvent"}]},"WrappedUnreadCountsResponse":{"description":"Basic response information","nullable":true,"properties":{"channel_type":{"items":{"$ref":"#/components/schemas/UnreadCountsChannelType"},"type":"array","x-stream-index":"001.005"},"channels":{"items":{"$ref":"#/components/schemas/UnreadCountsChannel"},"type":"array","x-stream-index":"001.004"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"threads":{"items":{"$ref":"#/components/schemas/UnreadCountsThread"},"type":"array","x-stream-index":"001.006"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"001.001"},"total_unread_count_by_team":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001.003"},"total_unread_threads_count":{"format":"int32","type":"integer","x-stream-index":"001.002"}},"required":["total_unread_count","total_unread_threads_count","channels","channel_type","threads","duration"],"title":"Response","type":"object"},"XiaomiConfig":{"properties":{"Disabled":{"type":"boolean","writeOnly":true,"x-stream-index":"003"},"package_name":{"type":"string","x-stream-index":"001"},"secret":{"type":"string","x-stream-index":"002"}},"type":"object"},"XiaomiConfigFields":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"package_name":{"type":"string","x-stream-index":"002"},"secret":{"type":"string","x-stream-index":"003"}},"required":["enabled"],"type":"object"}},"securitySchemes":{"JWT":{"description":"JWT should be always provided when stream-auth-type=jwt.\n\nUsing JWT auth request could be authenticated as user or as server-side.\n\nWhen using user authentication permission checking is going to be applied to requests based on the user that is\nperforming a request.\n\nThe `authorization` header should be a JWT string signed using the secret attached to the API key used to perform\nrequests.\n\n**WARNING** all client-side official SDK do not ship with token generation; this is to make sure that the API secret is not\nshared with an untrusted party such as a browser or a iOS/Android application. Tokens **must** be generated server-side.\nIf you wish, you can configure your application to ignore authentication (see `disable_auth_check`)\nThe JWT string must include only the user_id claim and can include any built-in JWT claim such as iat, exp as well.\n","in":"header","name":"Authorization","type":"apiKey"},"api_key":{"description":"Application API key should be always set in order to authenticate the request.","in":"query","name":"api_key","type":"apiKey"},"stream-auth-type":{"description":"Stream-Auth-Type should be always set in order to authenticate the request. Possible\nvalues: `jwt` or `anonymous`.\n\n`jwt` allows you to authenticate as a user. With this auth type you should also provide valid JWT in Authorization\nheader.\n\n`anonymous` allows you to authenticate as anonymous user. Please note that most advanced features are not available\nto anonymous users.","in":"header","name":"Stream-Auth-Type","type":"apiKey"}}},"info":{"title":"Stream API","version":"v191.1.0"},"openapi":"3.0.3","paths":{"/api/v2/app":{"get":{"description":"This Method returns the application settings\n","operationId":"GetApp","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetApplicationResponse"}}},"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":"Get App Settings","tags":["product:common"]},"patch":{"description":"This Method updates one or more application settings\n","operationId":"UpdateApp","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAppRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Update App Settings","tags":["product:common"]}},"/api/v2/blocklists":{"get":{"description":"Returns all available block lists\n","operationId":"ListBlockLists","parameters":[{"in":"query","name":"team","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListBlockListResponse"}}},"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":"List block lists","tags":["product:common"]},"post":{"description":"Creates a new application blocklist, once created the blocklist can be used by any channel type\n","operationId":"CreateBlockList","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBlockListRequest"}}},"description":"Block list","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBlockListResponse"}}},"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":"Create block list","tags":["product:common"]}},"/api/v2/blocklists/{name}":{"delete":{"description":"Deletes previously created application blocklist\n","operationId":"DeleteBlockList","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"team","schema":{"type":"string","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete block list","tags":["product:common"]},"get":{"description":"Returns block list by given name\n","operationId":"GetBlockList","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Block list name","title":"Name","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"team","schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBlockListResponse"}}},"description":"GetBlockListResponse"},"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":"Get block list","tags":["product:common"]},"put":{"description":"Updates contents of the block list\n","operationId":"UpdateBlockList","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Block list name","title":"Name","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBlockListRequest"}}},"description":"Update block list","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBlockListResponse"}}},"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":"Update block list","tags":["product:common"]}},"/api/v2/chat/campaigns/query":{"post":{"description":"Query campaigns with filter query\n","operationId":"QueryCampaigns","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCampaignsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCampaignsResponse"}}},"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":"Query campaigns","tags":["product:chat"]}},"/api/v2/chat/campaigns/{id}":{"get":{"description":"Get campaign by ID.\n","operationId":"GetCampaign","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"The ID of the campaign (uuid)","maxLength":255,"title":"Campaign ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"prev","schema":{"description":"Token for the previous page of campaign users","title":"Previous Users Page","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"query","name":"next","schema":{"description":"Token for the next page of campaign users","title":"Next Users Page","type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"limit","schema":{"description":"Maximum number of campaign users to return in a single request (max: 1000)","format":"int32","maximum":1000,"minimum":0,"title":"Users Limit","type":"integer","writeOnly":true,"x-stream-index":"002.003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCampaignResponse"}}},"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":"Get campaign","tags":["product:chat"]}},"/api/v2/chat/campaigns/{id}/start":{"post":{"description":"Starts or schedules a campaign\n","operationId":"StartCampaign","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartCampaignRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartCampaignResponse"}}},"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":"Start/schedule campaign","tags":["product:chat"]}},"/api/v2/chat/campaigns/{id}/stop":{"post":{"description":"Stops a campaign\n","operationId":"ScheduleCampaign","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopCampaignRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignResponse"}}},"description":"Successful 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":"Stop campaign","tags":["product:chat"]}},"/api/v2/chat/channels":{"post":{"description":"Query channels with filter query\n","operationId":"QueryChannels","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryChannelsRequest"}}},"description":"Query Channels Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryChannelsResponse"}}},"description":"Channels list"},"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":"Query channels","tags":["product:chat"]}},"/api/v2/chat/channels/delete":{"post":{"description":"Allows to delete several channels at once asynchronously\n\nSends events:\n- channel.deleted\n- channel.deleted\n","operationId":"DeleteChannels","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteChannelsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteChannelsResponse"}}},"description":"Successful 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":"Deletes channels asynchronously","tags":["product:chat"]}},"/api/v2/chat/channels/read":{"post":{"description":"Marks channels as read up to the specific message. If no channels is given, mark all channel as read\n\nSends events:\n- message.read\n- message.read\n","operationId":"MarkChannelsRead","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkChannelsReadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkReadResponse"}}},"description":"Successful 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 channels as read","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/query":{"post":{"description":"This Method creates a channel or returns an existing one with matching attributes\n\nSends events:\n- channel.created\n- member.added\n- member.removed\n- member.updated\n- user.watching.start\n","operationId":"GetOrCreateDistinctChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelGetOrCreateRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelStateResponse"}}},"description":"Successful 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":"Get or create channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}":{"delete":{"description":"Deletes channel\n\nSends events:\n- channel.deleted\n- channel.deleted\n","operationId":"DeleteChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"query","name":"hard_delete","schema":{"type":"boolean","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteChannelResponse"}}},"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":"Delete channel","tags":["product:chat"]},"patch":{"description":"Updates certain fields of the channel\n\nSends events:\n- channel.updated\n- channel.updated\n","operationId":"UpdateChannelPartial","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelPartialRequest"}}},"description":"UpdateChannelPartialRequest","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelPartialResponse"}}},"description":"Successful 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":"Partially update channel","tags":["product:chat"]},"post":{"description":"Change channel data\n\nSends events:\n- channel.updated\n- member.added\n- member.removed\n- member.updated\n- message.new\n- channel.updated\n- member.added\n- member.removed\n- member.updated\n- message.new\n","operationId":"UpdateChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"013.002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"013.002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelRequest"}}},"description":"Channel update request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelResponse"}}},"description":"Successful 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":"Update channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/draft":{"delete":{"description":"Deletes a draft\n\nSends events:\n- draft.deleted\n","operationId":"DeleteDraft","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"parent_id","schema":{"description":"Parent message ID","title":"string","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"003.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete draft","tags":["product:chat"]},"get":{"description":"Get a draft\n","operationId":"GetDraft","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"parent_id","schema":{"description":"Parent message ID","title":"string","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"003.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetDraftResponse"}}},"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":"Get draft","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/event":{"post":{"description":"Sends event to the channel\n","operationId":"SendEvent","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendEventRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventResponse"}}},"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":"Send event","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/file":{"delete":{"description":"Deletes previously uploaded file\n","operationId":"DeleteFile","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of file","title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"File ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"url","schema":{"description":"File URL to delete","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete file","tags":["product:chat"]},"post":{"description":"Uploads file\n","operationId":"UploadFile","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/FileUploadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileUploadResponse"}}},"description":"Successful 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":"Upload file","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/hide":{"post":{"description":"Marks channel as hidden for current user\n\nSends events:\n- channel.hidden\n- channel.hidden\n","operationId":"HideChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HideChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HideChannelResponse"}}},"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":"Hide channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/image":{"delete":{"description":"Deletes previously uploaded image\n","operationId":"DeleteImage","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of file","title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"File ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"url","schema":{"description":"File URL to delete","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete image","tags":["product:chat"]},"post":{"description":"Uploads image\n","operationId":"UploadImage","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.001.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.001.002"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/ImageUploadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageUploadResponse"}}},"description":"Successful 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":"Upload image","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/member":{"patch":{"description":"\n","operationId":"UpdateMemberPartial","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"005.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMemberPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMemberPartialResponse"}}},"description":"Successful 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":"Partially channel member update","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/message":{"post":{"description":"Sends new message to the specified channel\n\nSends events:\n- message.new\n- message.updated\n- message.new\n- message.updated\n","operationId":"SendMessage","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"009.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"009.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendMessageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendMessageResponse"}}},"description":"Successful 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":"Send new message","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/messages":{"get":{"description":"Returns list messages found by IDs\n","operationId":"GetManyMessages","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"ids","required":true,"schema":{"description":"List of comma-separated IDs","items":{"type":"string"},"maximum":50,"minimum":1,"title":"IDs","type":"array","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetManyMessagesResponse"}}},"description":"Successful 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":"Get many messages","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/query":{"post":{"description":"This Method creates a channel or returns an existing one with matching attributes\n\nSends events:\n- channel.created\n- member.added\n- member.removed\n- member.updated\n- user.watching.start\n","operationId":"GetOrCreateChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID (maximum length of 64 characters)","title":"ID","type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelGetOrCreateRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelStateResponse"}}},"description":"Successful 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":"Get or create channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/read":{"post":{"description":"Marks channel as read up to the specific message\n\nSends events:\n- message.read\n- message.read\n","operationId":"MarkRead","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkReadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkReadResponse"}}},"description":"Successful 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 read","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/show":{"post":{"description":"Shows previously hidden channel\n\nSends events:\n- channel.visible\n- channel.visible\n","operationId":"ShowChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"Channel type to interact with","title":"Channel type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Channel ID to interact with","title":"Channel ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShowChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShowChannelResponse"}}},"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":"Show channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/truncate":{"post":{"description":"Truncates messages from a channel. Can be applied to the entire channel or scoped to specific members.\n\nSends events:\n- channel.truncated\n- channel.truncated\n","operationId":"TruncateChannel","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TruncateChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TruncateChannelResponse"}}},"description":"Successful 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":"Truncate channel","tags":["product:chat"]}},"/api/v2/chat/channels/{type}/{id}/unread":{"post":{"description":"Marks channel as unread from a specific message\n","operationId":"MarkUnread","parameters":[{"in":"path","name":"type","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkUnreadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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 unread","tags":["product:chat"]}},"/api/v2/chat/channeltypes":{"get":{"description":"Lists all available channel types\n","operationId":"ListChannelTypes","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListChannelTypesResponse"}}},"description":"ListChannelTypesResponse"},"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":"List channel types","tags":["product:chat"]},"post":{"description":"Creates new channel type\n","operationId":"CreateChannelType","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateChannelTypeRequest"}}},"description":"CreateChannelTypeRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateChannelTypeResponse"}}},"description":"Successful 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":"Create channel type","tags":["product:chat"]}},"/api/v2/chat/channeltypes/{name}":{"delete":{"description":"Deletes channel type\n","operationId":"DeleteChannelType","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Channel type name","title":"Name","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete channel type","tags":["product:chat"]},"get":{"description":"Gets channel type\n","operationId":"GetChannelType","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Channel type name","title":"Name","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetChannelTypeResponse"}}},"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":"Get channel type","tags":["product:chat"]},"put":{"description":"Updates channel type\n","operationId":"UpdateChannelType","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelTypeRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelTypeResponse"}}},"description":"Successful 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":"Update channel type","tags":["product:chat"]}},"/api/v2/chat/commands":{"get":{"description":"Returns all custom commands\n","operationId":"ListCommands","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListCommandsResponse"}}},"description":"ListCommandsResponse"},"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":"List commands","tags":["product:chat"]},"post":{"description":"Creates custom chat command\n","operationId":"CreateCommand","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCommandRequest"}}},"description":"CreateCommandRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCommandResponse"}}},"description":"CreateCommandResponse"},"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":"Create command","tags":["product:chat"]}},"/api/v2/chat/commands/{name}":{"delete":{"description":"Deletes custom chat command\n","operationId":"DeleteCommand","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Command name","title":"Name","type":"string","x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCommandResponse"}}},"description":"DeleteCommandResponse"},"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":"Delete command","tags":["product:chat"]},"get":{"description":"Returns custom command by its name\n","operationId":"GetCommand","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Command name","title":"Name","type":"string","x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCommandResponse"}}},"description":"GetCommandResponse"},"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":"Get command","tags":["product:chat"]},"put":{"description":"Updates custom chat command\n","operationId":"UpdateCommand","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Unique command name","title":"Name","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCommandRequest"}}},"description":"UpdateCommandRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCommandResponse"}}},"description":"UpdateCommandResponse"},"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":"Update command","tags":["product:chat"]}},"/api/v2/chat/drafts/query":{"post":{"description":"Queries draft messages for a user\n","operationId":"QueryDrafts","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryDraftsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryDraftsResponse"}}},"description":"Successful 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":"Query draft messages","tags":["product:chat"]}},"/api/v2/chat/export_channels":{"post":{"description":"Exports channel data to JSON file\n","operationId":"ExportChannels","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportChannelsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportChannelsResponse"}}},"description":"Successful 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":"Export channels","tags":["product:chat"]}},"/api/v2/chat/members":{"get":{"description":"Find and filter channel members\n","operationId":"QueryMembers","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryMembersPayload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MembersResponse"}}},"description":"Successful 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":"Query members","tags":["product:chat"]}},"/api/v2/chat/messages/history":{"post":{"description":"Queries history for one message\n","operationId":"QueryMessageHistory","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryMessageHistoryRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryMessageHistoryResponse"}}},"description":"Successful 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":"Query message history","tags":["product:chat"]}},"/api/v2/chat/messages/{id}":{"delete":{"description":"Deletes message\n\nSends events:\n- message.deleted\n- message.deleted\n","operationId":"DeleteMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID to delete","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"hard","schema":{"description":"Delete all message reactions and replies as well","title":"Hard","type":"boolean","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"deleted_by","schema":{"type":"string","writeOnly":true,"x-stream-index":"003"}},{"in":"query","name":"delete_for_me","schema":{"description":"Delete the message only for the user making the request","title":"Delete for me","type":"boolean","writeOnly":true,"x-stream-index":"004"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteMessageResponse"}}},"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":"Delete message","tags":["product:chat"]},"get":{"description":"Returns message by ID\n","operationId":"GetMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"ID of the message","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"show_deleted_message","schema":{"description":"Whether to show deleted message","title":"Show deleted message","type":"boolean","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetMessageResponse"}}},"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":"Get message","tags":["product:chat"]},"post":{"description":"Updates message with new data\n\nSends events:\n- message.updated\n- message.updated\n","operationId":"UpdateMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"004.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessageResponse"}}},"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":"Update message","tags":["product:chat"]},"put":{"description":"Updates certain fields of the message\n\nSends events:\n- message.updated\n- message.updated\n","operationId":"UpdateMessagePartial","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessagePartialRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessagePartialResponse"}}},"description":"Successful 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":"Partially message update","tags":["product:chat"]}},"/api/v2/chat/messages/{id}/action":{"post":{"description":"Executes message command action with given parameters\n\nSends events:\n- message.new\n- message.new\n","operationId":"RunMessageAction","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageActionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}},"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":"Run message command action","tags":["product:chat"]}},"/api/v2/chat/messages/{id}/commit":{"post":{"description":"Commits a pending message, which will make it visible in the channel\n\nSends events:\n- message.new\n- message.updated\n- message.new\n- message.updated\n","operationId":"CommitMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommitMessageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}},"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":"Commit message","tags":["product:chat"]}},"/api/v2/chat/messages/{id}/reaction":{"post":{"description":"Sends reaction to specified message\n\nSends events:\n- reaction.new\n- reaction.updated\n","operationId":"SendReaction","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID to send reaction for","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendReactionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendReactionResponse"}}},"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":"Send reaction","tags":["product:chat"]}},"/api/v2/chat/messages/{id}/reaction/{type}":{"delete":{"description":"Removes user reaction from the message\n\nSends events:\n- reaction.deleted\n","operationId":"DeleteReaction","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID to remove reaction from","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"type","required":true,"schema":{"description":"Reaction type to remove","title":"Type","type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"description":"**Server-side only**. User ID which server acts upon","title":"User ID","type":"string","writeOnly":true,"x-stream-index":"003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteReactionResponse"}}},"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":"Delete reaction","tags":["product:chat"]}},"/api/v2/chat/messages/{id}/reactions":{"get":{"description":"Returns list of reactions of specific message\n","operationId":"GetReactions","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"limit","schema":{"description":"Number of records to return","format":"int32","title":"Limit","type":"integer","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"offset","schema":{"description":"Number of records to offset","format":"int32","title":"Offset","type":"integer","writeOnly":true,"x-stream-index":"003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetReactionsResponse"}}},"description":"Successful 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":"Get reactions","tags":["product:chat"]},"post":{"description":"Get reactions on a message\n","operationId":"QueryReactions","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryReactionsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryReactionsResponse"}}},"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"}},"tags":["product:chat"]}},"/api/v2/chat/messages/{id}/translate":{"post":{"description":"Translates message to a given language using automated translation software\n\nSends events:\n- message.updated\n- message.updated\n","operationId":"TranslateMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TranslateMessageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}},"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":"Translate message","tags":["product:chat"]}},"/api/v2/chat/messages/{id}/undelete":{"post":{"description":"Undelete a message that was previously soft-deleted\n\nSends events:\n- message.undeleted\n- message.undeleted\n","operationId":"UndeleteMessage","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Message ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"004.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMessageResponse"}}},"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":"Undelete message","tags":["product:chat"]}},"/api/v2/chat/messages/{message_id}/polls/{poll_id}/vote":{"post":{"description":"Cast a vote on a poll\n\nSends events:\n- feeds.poll.vote_casted\n- feeds.poll.vote_changed\n- feeds.poll.vote_removed\n- poll.vote_casted\n- poll.vote_changed\n- poll.vote_removed\n","operationId":"CastPollVote","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CastPollVoteRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollVoteResponse"}}},"description":"Successful 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":"Cast vote","tags":["product:chat"]}},"/api/v2/chat/messages/{message_id}/polls/{poll_id}/vote/{vote_id}":{"delete":{"description":"Delete a vote from a poll\n\nSends events:\n- feeds.poll.vote_removed\n- poll.vote_removed\n","operationId":"DeletePollVote","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"004"}},{"in":"path","name":"vote_id","required":true,"schema":{"description":"Vote ID","maxLength":255,"title":"string","type":"string","x-stream-index":"005"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollVoteResponse"}}},"description":"Successful 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":"Delete vote","tags":["product:chat"]}},"/api/v2/chat/messages/{message_id}/reminders":{"delete":{"description":"Deletes a user's created reminder\n\nSends events:\n- reminder.deleted\n","operationId":"DeleteReminder","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteReminderResponse"}}},"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":"Delete reminder","tags":["product:chat"]},"patch":{"description":"Updates an existing reminder\n\nSends events:\n- reminder.updated\n","operationId":"UpdateReminder","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateReminderRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateReminderResponse"}}},"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":"Updates Reminder","tags":["product:chat"]},"post":{"description":"Creates a new reminder\n\nSends events:\n- reminder.created\n","operationId":"CreateReminder","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateReminderRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReminderResponseData"}}},"description":"Successful 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":"Create reminder","tags":["product:chat"]}},"/api/v2/chat/messages/{parent_id}/replies":{"get":{"description":"Returns replies (thread) of the message\n","operationId":"GetReplies","parameters":[{"in":"path","name":"parent_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"sort","schema":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":1,"type":"array","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"limit","schema":{"description":"The maximum number of messages to return (max limit ","format":"int32","minimum":0,"title":"Limit","type":"integer","x-stream-index":"003.001"}},{"in":"query","name":"offset","schema":{"description":"The offset to start from","format":"int32","title":"Offset","type":"integer","x-stream-index":"003.002"}},{"in":"query","name":"id_gte","schema":{"description":"The ID of the message to get messages with a timestamp greater than or equal to","title":"IDGTE","type":"string","x-stream-index":"003.003"}},{"in":"query","name":"id_gt","schema":{"description":"The ID of the message to get messages with a timestamp greater than","title":"IDGT","type":"string","x-stream-index":"003.004"}},{"in":"query","name":"id_lte","schema":{"description":"The ID of the message to get messages with a timestamp smaller than or equal to","title":"IDLTE","type":"string","x-stream-index":"003.005"}},{"in":"query","name":"id_lt","schema":{"description":"The ID of the message to get messages with a timestamp smaller than","title":"IDLT","type":"string","x-stream-index":"003.006"}},{"in":"query","name":"created_at_after_or_equal","schema":{"description":"The timestamp to get messages with a created_at timestamp greater than or equal to","format":"date-time","title":"Created_at after or equal","type":"number","x-stream-index":"003.007"}},{"in":"query","name":"created_at_after","schema":{"description":"The timestamp to get messages with a created_at timestamp greater than","format":"date-time","title":"Created_at after","type":"number","x-stream-index":"003.008"}},{"in":"query","name":"created_at_before_or_equal","schema":{"description":"The timestamp to get messages with a created_at timestamp smaller than or equal to","format":"date-time","title":"Created_at after before or equal","type":"number","x-stream-index":"003.009"}},{"in":"query","name":"created_at_before","schema":{"description":"The timestamp to get messages with a created_at timestamp smaller than","format":"date-time","title":"Created_at after before","type":"number","x-stream-index":"003.010"}},{"in":"query","name":"id_around","schema":{"description":"The result will be a set of messages, that are both older and newer than the message with the provided ID, and the message with the ID provided will be in the middle of the set","title":"Id around","type":"string","x-stream-index":"003.011"}},{"in":"query","name":"created_at_around","schema":{"description":"The result will be a set of messages, that are both older and newer than the created_at timestamp provided, distributed evenly around the timestamp","format":"date-time","title":"Created_at around","type":"number","x-stream-index":"003.012"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRepliesResponse"}}},"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":"Get replies","tags":["product:chat"]}},"/api/v2/chat/moderation/flags/message":{"get":{"description":"Find and filter message flags\n","operationId":"QueryMessageFlags","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryMessageFlagsPayload","description":"JSON object with query message flags payload","title":"Payload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryMessageFlagsResponse"}}},"description":"QueryMessageFlagsResponse"},"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":"Query Message Flags","tags":["product:chat"]}},"/api/v2/chat/moderation/mute/channel":{"post":{"description":"Mutes channel for user\n\nSends events:\n- channel.muted\n- channel.muted\n","operationId":"MuteChannel","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteChannelResponse"}}},"description":"Successful 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":"Mute channel","tags":["product:chat"]}},"/api/v2/chat/moderation/unmute/channel":{"post":{"description":"Unmutes channel for user\n\nSends events:\n- channel.unmuted\n- channel.unmuted\n","operationId":"UnmuteChannel","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnmuteChannelRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnmuteResponse"}}},"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":"Unmute channel","tags":["product:chat"]}},"/api/v2/chat/push_preferences":{"post":{"description":"Update the push preferences for a user and or channel member. Set to all, mentions or none\n","operationId":"UpdatePushNotificationPreferences","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertPushPreferencesRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertPushPreferencesResponse"}}},"description":"Successful 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":"Push notification preferences","tags":["product:chat"]}},"/api/v2/chat/push_templates":{"get":{"description":"Retrieve push notification templates for Chat.\n","operationId":"GetPushTemplates","parameters":[{"in":"query","name":"push_provider_name","schema":{"description":"Push provider name to filter templates","title":"string","type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"push_provider_type","required":true,"schema":{"description":"Push provider type (firebase, apn) to filter templates","enum":["firebase","apn"],"title":"string","type":"string","writeOnly":true,"x-stream-index":"003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPushTemplatesResponse"}}},"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":"Get push notification templates","tags":["product:chat"]},"post":{"description":"Create or update a push notification template for a specific event type and push provider\n","operationId":"UpsertPushTemplate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertPushTemplateRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertPushTemplateResponse"}}},"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":"Upsert a push notification template","tags":["product:chat"]}},"/api/v2/chat/query_banned_users":{"get":{"description":"Find and filter channel scoped or global user bans\n","operationId":"QueryBannedUsers","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryBannedUsersPayload","description":"JSON object with query user bans payload","title":"Payload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryBannedUsersResponse"}}},"description":"Successful 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":"Query Banned Users","tags":["product:chat"]}},"/api/v2/chat/reminders/query":{"post":{"description":"Queries reminders\n","operationId":"QueryReminders","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryRemindersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryRemindersResponse"}}},"description":"Successful 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":"Query reminders","tags":["product:chat"]}},"/api/v2/chat/search":{"get":{"description":"Search messages across channels\n","operationId":"Search","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchPayload","description":"JSON object with search payload","title":"Payload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchResponse"}}},"description":"Successful 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":"Search messages","tags":["product:chat"]}},"/api/v2/chat/segments/query":{"post":{"description":"Query segments\n","operationId":"QuerySegments","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuerySegmentsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuerySegmentsResponse"}}},"description":"Successful 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":"Query segments","tags":["product:chat"]}},"/api/v2/chat/segments/{id}":{"delete":{"description":"Delete a segment\n","operationId":"DeleteSegment","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete segment","tags":["product:chat"]},"get":{"description":"Get segment\n","operationId":"GetSegment","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetSegmentResponse"}}},"description":"Successful 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":"Get segment","tags":["product:chat"]}},"/api/v2/chat/segments/{id}/deletetargets":{"post":{"description":"Delete targets from a segment\n","operationId":"DeleteSegmentTargets","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteSegmentTargetsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete targets from a segment","tags":["product:chat"]}},"/api/v2/chat/segments/{id}/target/{target_id}":{"get":{"description":"Check whether a target exists in a segment. Returns 200 if the target exists, 404 otherwise\n","operationId":"SegmentTargetExists","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"target_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Check whether a target exists in a segment","tags":["product:chat"]}},"/api/v2/chat/segments/{id}/targets/query":{"post":{"description":"Query segment targets\n","operationId":"QuerySegmentTargets","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuerySegmentTargetsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuerySegmentTargetsResponse"}}},"description":"Successful 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":"Query segment targets","tags":["product:chat"]}},"/api/v2/chat/threads":{"post":{"description":"Returns the list of threads for specific user\n","operationId":"QueryThreads","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryThreadsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryThreadsResponse"}}},"description":"Successful 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":"Query Threads","tags":["product:chat"]}},"/api/v2/chat/threads/{message_id}":{"get":{"description":"Return a specific thread\n","operationId":"GetThread","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"reply_limit","schema":{"description":"Limit the number of replies returned","format":"int32","minimum":0,"title":"Reply limit","type":"integer","writeOnly":true,"x-stream-index":"004"}},{"in":"query","name":"participant_limit","schema":{"description":"Limit the number of participants returned","format":"int32","maximum":100,"minimum":0,"title":"Participant limit","type":"integer","writeOnly":true,"x-stream-index":"005"}},{"in":"query","name":"member_limit","schema":{"description":"Limit the number of members returned per thread channel","format":"int32","maximum":100,"minimum":0,"title":"Member limit","type":"integer","writeOnly":true,"x-stream-index":"006"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetThreadResponse"}}},"description":"Successful 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":"Get Thread","tags":["product:chat"]},"patch":{"description":"Updates certain fields of the thread\n\nSends events:\n- thread.updated\n- thread.updated\n","operationId":"UpdateThreadPartial","parameters":[{"in":"path","name":"message_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateThreadPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateThreadPartialResponse"}}},"description":"Successful 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":"Partially update thread","tags":["product:chat"]}},"/api/v2/chat/unread":{"get":{"description":"Fetch unread counts for a single user\n","operationId":"UnreadCounts","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WrappedUnreadCountsResponse"}}},"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":"Unread counts","tags":["product:chat"]}},"/api/v2/chat/unread_batch":{"post":{"description":"Fetch unread counts in batch for multiple users in one call\n","operationId":"UnreadCountsBatch","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnreadCountsBatchRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnreadCountsBatchResponse"}}},"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":"Batch unread counts","tags":["product:chat"]}},"/api/v2/chat/users/{user_id}/event":{"post":{"description":"Sends a custom event to a user\n\nSends events:\n- *\n","operationId":"SendUserCustomEvent","parameters":[{"in":"path","name":"user_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendUserCustomEventRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Send user event","tags":["product:chat"]}},"/api/v2/check_push":{"post":{"description":"Sends a test message via push, this is a test endpoint to verify your push settings\n","operationId":"CheckPush","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckPushRequest"}}},"description":"CheckPushRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckPushResponse"}}},"description":"Successful 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":"Check push","tags":["product:common"]}},"/api/v2/check_sns":{"post":{"description":"Validates Amazon SNS configuration\n","operationId":"CheckSNS","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSNSRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSNSResponse"}}},"description":"Successful 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":"Check SNS","tags":["product:common"]}},"/api/v2/check_sqs":{"post":{"description":"Validates Amazon SQS credentials\n","operationId":"CheckSQS","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSQSRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSQSResponse"}}},"description":"Successful 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":"Check SQS","tags":["product:common"]}},"/api/v2/devices":{"delete":{"description":"Deletes one device\n","operationId":"DeleteDevice","parameters":[{"in":"query","name":"id","required":true,"schema":{"description":"Device ID to delete","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"user_id","schema":{"description":"**Server-side only**. User ID which server acts upon","title":"User ID","type":"string","writeOnly":true,"x-stream-index":"002.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete device","tags":["product:common"]},"get":{"description":"Returns all available devices\n","operationId":"ListDevices","parameters":[{"in":"query","name":"user_id","schema":{"description":"**Server-side only**. User ID which server acts upon","title":"User ID","type":"string","writeOnly":true,"x-stream-index":"001.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDevicesResponse"}}},"description":"ListDevicesResponse"},"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":"List devices","tags":["product:common"]},"post":{"description":"Adds a new device to a user, if the same device already exists the call will have no effect\n","operationId":"CreateDevice","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDeviceRequest"}}},"description":"CreateDeviceRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Create device","tags":["product:common"]}},"/api/v2/export/users":{"post":{"description":"Exports user profile, reactions and messages for list of given users\n","operationId":"ExportUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportUsersResponse"}}},"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":"Export users","tags":["product:common"]}},"/api/v2/external_storage":{"get":{"description":"Lists external storage\n","operationId":"ListExternalStorage","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListExternalStorageResponse"}}},"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":"List external storage","tags":["product:common"]},"post":{"description":"Creates new external storage\n","operationId":"CreateExternalStorage","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateExternalStorageRequest"}}},"description":"CreateExternalStorageRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateExternalStorageResponse"}}},"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":"Create external storage","tags":["product:common"]}},"/api/v2/external_storage/{name}":{"delete":{"description":"Deletes external storage\n","operationId":"DeleteExternalStorage","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteExternalStorageResponse"}}},"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":"Delete external storage","tags":["product:common"]},"put":{"description":"\n","operationId":"UpdateExternalStorage","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateExternalStorageRequest"}}},"description":"ExternalStorageRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateExternalStorageResponse"}}},"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":"Update External Storage","tags":["product:common"]}},"/api/v2/external_storage/{name}/check":{"get":{"description":"\n","operationId":"CheckExternalStorage","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckExternalStorageResponse"}}},"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":"Check External Storage","tags":["product:common"]}},"/api/v2/feeds/activities":{"post":{"description":"Create a new activity or update an existing one\n","operationId":"AddActivity","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddActivityRequest"}}},"description":"Activity Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddActivityResponse"}}},"description":"Add Activity 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":"Add a single activity","tags":["product:feeds"]}},"/api/v2/feeds/activities/batch":{"post":{"description":"Create new activities or update existing ones in a batch operation\n","operationId":"UpsertActivities","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertActivitiesRequest"}}},"description":"Upsert Activities Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertActivitiesResponse"}}},"description":"Upsert Activities 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":"Upsert multiple activities","tags":["product:feeds"]}},"/api/v2/feeds/activities/delete":{"post":{"description":"Delete one or more activities by their IDs\n","operationId":"DeleteActivities","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteActivitiesRequest"}}},"description":"Delete Activities Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteActivitiesResponse"}}},"description":"Delete Activities 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":"Remove multiple activities","tags":["product:feeds"]}},"/api/v2/feeds/activities/query":{"post":{"description":"Query activities based on filters with pagination and sorting options\n","operationId":"QueryActivities","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryActivitiesRequest"}}},"description":"Query Activities Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryActivitiesResponse"}}},"description":"Query Activities 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":"Query activities","tags":["product:feeds"]}},"/api/v2/feeds/activities/{activity_id}/bookmarks":{"delete":{"description":"Deletes a bookmark from an activity\n","operationId":"DeleteBookmark","parameters":[{"in":"path","name":"activity_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"folder_id","schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"003.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteBookmarkResponse"}}},"description":"Delete Bookmark 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":"Delete a bookmark","tags":["product:feeds"]},"patch":{"description":"Updates a bookmark for an activity\n","operationId":"UpdateBookmark","parameters":[{"in":"path","name":"activity_id","required":true,"schema":{"description":"ID of the activity","maxLength":255,"title":"Activity ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBookmarkRequest"}}},"description":"Update Bookmark Request","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBookmarkResponse"}}},"description":"Update Bookmark 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":"Update bookmark","tags":["product:feeds"]},"post":{"description":"Adds a bookmark to an activity\n","operationId":"AddBookmark","parameters":[{"in":"path","name":"activity_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddBookmarkRequest"}}},"description":"Add Bookmark Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddBookmarkResponse"}}},"description":"Add Bookmark 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":"Add bookmark","tags":["product:feeds"]}},"/api/v2/feeds/activities/{activity_id}/feedback":{"post":{"description":"Submit feedback for an activity including options to show less, hide, report, or mute the user\n","operationId":"ActivityFeedback","parameters":[{"in":"path","name":"activity_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivityFeedbackRequest"}}},"description":"Activity Feedback Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivityFeedbackResponse"}}},"description":"Activity Feedback 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":"Provide feedback on an activity","tags":["product:feeds"]}},"/api/v2/feeds/activities/{activity_id}/polls/{poll_id}/vote":{"post":{"description":"Cast a vote on a poll\n\nSends events:\n- feeds.poll.vote_casted\n- feeds.poll.vote_changed\n- feeds.poll.vote_removed\n- poll.vote_casted\n- poll.vote_changed\n- poll.vote_removed\n","operationId":"CastPollVote","parameters":[{"in":"path","name":"activity_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CastPollVoteRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollVoteResponse"}}},"description":"Successful 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":"Cast vote","tags":["product:feeds"]}},"/api/v2/feeds/activities/{activity_id}/polls/{poll_id}/vote/{vote_id}":{"delete":{"description":"Delete a vote from a poll\n\nSends events:\n- feeds.poll.vote_removed\n- poll.vote_removed\n","operationId":"DeletePollVote","parameters":[{"in":"path","name":"activity_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003"}},{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"004"}},{"in":"path","name":"vote_id","required":true,"schema":{"description":"Vote ID","maxLength":255,"title":"string","type":"string","x-stream-index":"005"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollVoteResponse"}}},"description":"Successful 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":"Delete vote","tags":["product:feeds"]}},"/api/v2/feeds/activities/{activity_id}/reactions":{"post":{"description":"Adds a reaction to an activity\n","operationId":"AddReaction","parameters":[{"in":"path","name":"activity_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddReactionRequest"}}},"description":"Add Reaction Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddReactionResponse"}}},"description":"Add Reaction 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":"Add reaction","tags":["product:feeds"]}},"/api/v2/feeds/activities/{activity_id}/reactions/query":{"post":{"description":"Query activity reactions\n","operationId":"QueryActivityReactions","parameters":[{"in":"path","name":"activity_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryActivityReactionsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryActivityReactionsResponse"}}},"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":"Query activity reactions","tags":["product:feeds"]}},"/api/v2/feeds/activities/{activity_id}/reactions/{type}":{"delete":{"description":"Removes a reaction from an activity\n","operationId":"DeleteActivityReaction","parameters":[{"in":"path","name":"activity_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"type","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"003.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteActivityReactionResponse"}}},"description":"Delete Activity Reaction 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":"Remove reaction","tags":["product:feeds"]}},"/api/v2/feeds/activities/{id}":{"delete":{"description":"Delete a single activity by its ID\n","operationId":"DeleteActivity","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"hard_delete","schema":{"description":"Whether to permanently delete the activity instead of soft delete","title":"boolean","type":"boolean","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteActivityResponse"}}},"description":"Delete Activity 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":"Delete a single activity","tags":["product:feeds"]},"get":{"description":"Returns activity by ID\n","operationId":"GetActivity","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetActivityResponse"}}},"description":"Get Activity 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":"Get activity","tags":["product:feeds"]},"patch":{"description":"Updates certain fields of the activity\n\nSends events:\n- feeds.activity.updated\n","operationId":"UpdateActivityPartial","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateActivityPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateActivityPartialResponse"}}},"description":"Successful 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":"Partially activity update","tags":["product:feeds"]},"put":{"description":"Replaces an activity with the provided data\n\nSends events:\n- feeds.activity.updated\n","operationId":"UpdateActivity","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateActivityRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateActivityResponse"}}},"description":"Successful 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":"Full activity update","tags":["product:feeds"]}},"/api/v2/feeds/bookmark_folders/query":{"post":{"description":"Query bookmark folders with filter query\n","operationId":"QueryBookmarkFolders","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryBookmarkFoldersRequest"}}},"description":"Query Bookmark Folders Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryBookmarkFoldersResponse"}}},"description":"Query Bookmark Folders 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":"Query bookmark folders","tags":["product:feeds"]}},"/api/v2/feeds/bookmark_folders/{folder_id}":{"delete":{"description":"Delete a bookmark folder by its ID\n","operationId":"DeleteBookmarkFolder","parameters":[{"in":"path","name":"folder_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteBookmarkFolderResponse"}}},"description":"Delete Bookmark Folder 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":"Delete a bookmark folder","tags":["product:feeds"]},"patch":{"description":"Update a bookmark folder by its ID\n","operationId":"UpdateBookmarkFolder","parameters":[{"in":"path","name":"folder_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBookmarkFolderRequest"}}},"description":"Update Bookmark Folder Request","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBookmarkFolderResponse"}}},"description":"Update Bookmark Folder 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":"Update a bookmark folder","tags":["product:feeds"]}},"/api/v2/feeds/bookmarks/query":{"post":{"description":"Query bookmarks with filter query\n","operationId":"QueryBookmarks","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryBookmarksRequest"}}},"description":"Query Bookmarks Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryBookmarksResponse"}}},"description":"Query Bookmarks 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":"Query bookmarks","tags":["product:feeds"]}},"/api/v2/feeds/comments":{"get":{"description":"Retrieve a threaded list of comments for a specific object (e.g., activity), with configurable depth, sorting, and pagination\n","operationId":"GetComments","parameters":[{"in":"query","name":"object_id","required":true,"schema":{"description":"ID of the object to get comments for","title":"Object ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"object_type","required":true,"schema":{"description":"Type of the object to get comments for","title":"Object Type","type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"depth","schema":{"description":"Maximum nested depth to return (0 = only first level)","format":"int32","maximum":5,"minimum":0,"title":"Max Depth","type":"integer","writeOnly":true,"x-stream-index":"003"}},{"in":"query","name":"sort","schema":{"description":"Sort order for the comments","enum":["first","last","top","best","controversial"],"title":"Sort Order","type":"string","writeOnly":true,"x-stream-index":"004"}},{"in":"query","name":"replies_limit","schema":{"format":"int32","maximum":20,"minimum":0,"type":"integer","writeOnly":true,"x-stream-index":"005"}},{"in":"query","name":"limit","schema":{"description":"Max number of top‑level comments to return","format":"int32","maximum":100,"minimum":0,"title":"Root Limit","type":"integer","writeOnly":true,"x-stream-index":"006.001"}},{"in":"query","name":"prev","schema":{"type":"string","writeOnly":true,"x-stream-index":"006.002"}},{"in":"query","name":"next","schema":{"type":"string","writeOnly":true,"x-stream-index":"006.003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCommentsResponse"}}},"description":"Get Comments 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":"Get comments for an object","tags":["product:feeds"]},"post":{"description":"Adds a comment to an object (e.g., activity) or a reply to an existing comment, and broadcasts appropriate events\n","operationId":"AddComment","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddCommentRequest"}}},"description":"Add Comment Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddCommentResponse"}}},"description":"Add Comment 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":"Add a comment or reply","tags":["product:feeds"]}},"/api/v2/feeds/comments/batch":{"post":{"description":"Adds multiple comments in a single request. Each comment must specify the object type and ID.\n","operationId":"AddCommentsBatch","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddCommentsBatchRequest"}}},"description":"Add Comments Batch Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddCommentsBatchResponse"}}},"description":"Add Comments Batch 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":"Add multiple comments in a batch","tags":["product:feeds"]}},"/api/v2/feeds/comments/query":{"post":{"description":"Query comments using MongoDB-style filters with pagination and sorting options\n","operationId":"QueryComments","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCommentsRequest"}}},"description":"Query Comments Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCommentsResponse"}}},"description":"Query Comments 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":"Query comments","tags":["product:feeds"]}},"/api/v2/feeds/comments/{id}":{"delete":{"description":"Deletes a comment from an object (e.g., activity) and broadcasts appropriate events\n","operationId":"DeleteComment","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"hard_delete","schema":{"description":"Whether to permanently delete the comment instead of soft delete","title":"Hard Delete","type":"boolean","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCommentResponse"}}},"description":"Delete Comment 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":"Delete a comment","tags":["product:feeds"]},"get":{"description":"Get a comment by ID\n","operationId":"GetComment","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCommentResponse"}}},"description":"Get Comment 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":"Get comment","tags":["product:feeds"]},"patch":{"description":"Updates a comment on an object (e.g., activity) and broadcasts appropriate events\n","operationId":"UpdateComment","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCommentRequest"}}},"description":"Update Comment Request","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCommentResponse"}}},"description":"Update Comment 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":"Update a comment","tags":["product:feeds"]}},"/api/v2/feeds/comments/{id}/reactions":{"post":{"description":"Adds a reaction to a comment\n","operationId":"AddCommentReaction","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddCommentReactionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddCommentReactionResponse"}}},"description":"Successful 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":"Add comment reaction","tags":["product:feeds"]}},"/api/v2/feeds/comments/{id}/reactions/query":{"post":{"description":"Query comment reactions\n","operationId":"QueryCommentReactions","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCommentReactionsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCommentReactionsResponse"}}},"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":"Query comment reactions","tags":["product:feeds"]}},"/api/v2/feeds/comments/{id}/reactions/{type}":{"delete":{"description":"Deletes a reaction from a comment\n","operationId":"DeleteCommentReaction","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"type","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"003.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCommentReactionResponse"}}},"description":"Delete Comment Reaction 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":"Delete comment reaction","tags":["product:feeds"]}},"/api/v2/feeds/comments/{id}/replies":{"get":{"description":"Retrieve a threaded list of replies for a single comment, with configurable depth, sorting, and pagination\n","operationId":"GetCommentReplies","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"depth","schema":{"description":"Maximum nested depth to return (0 = unlimited)","format":"int32","maximum":5,"minimum":0,"title":"Max Depth","type":"integer","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"sort","schema":{"description":"first (oldest), last (newest) or top","enum":["first","last","top","best","controversial"],"title":"Sort Order","type":"string","writeOnly":true,"x-stream-index":"003"}},{"in":"query","name":"replies_limit","schema":{"description":"Max number of replies to return","format":"int32","minimum":0,"title":"Replies Limit","type":"integer","writeOnly":true,"x-stream-index":"004"}},{"in":"query","name":"limit","schema":{"description":"Max number of direct replies to return","format":"int32","maximum":100,"minimum":0,"title":"Reply Limit","type":"integer","writeOnly":true,"x-stream-index":"005.001"}},{"in":"query","name":"prev","schema":{"type":"string","writeOnly":true,"x-stream-index":"005.002"}},{"in":"query","name":"next","schema":{"type":"string","writeOnly":true,"x-stream-index":"005.003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCommentRepliesResponse"}}},"description":"Get Comment Replies 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":"Get replies for a comment","tags":["product:feeds"]}},"/api/v2/feeds/feed_groups":{"get":{"description":"List all feed groups for the application\n","operationId":"ListFeedGroups","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListFeedGroupsResponse"}}},"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":"List all feed groups","tags":["product:feeds"]},"post":{"description":"Creates a new feed group with the specified configuration\n","operationId":"CreateFeedGroup","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFeedGroupRequest"}}},"description":"Create Feed Group Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFeedGroupResponse"}}},"description":"Upsert Feed Group 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":"Create a new feed group","tags":["product:feeds"]}},"/api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}":{"delete":{"description":"Delete a single feed by its ID\n","operationId":"DeleteFeed","parameters":[{"in":"path","name":"feed_group_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"feed_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"hard_delete","schema":{"description":"Whether to permanently delete the feed instead of soft delete","title":"boolean","type":"boolean","writeOnly":true,"x-stream-index":"003"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteFeedResponse"}}},"description":"Delete Feed 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":"Delete a single feed","tags":["product:feeds"]},"post":{"description":"Create a single feed for a given feed group\n","operationId":"GetOrCreateFeed","parameters":[{"in":"path","name":"feed_group_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"feed_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrCreateFeedRequest"}}},"description":"ClientRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrCreateFeedResponse"}}},"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":"Create a new feed","tags":["product:feeds"]},"put":{"description":"Update an existing feed\n","operationId":"UpdateFeed","parameters":[{"in":"path","name":"feed_group_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"feed_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFeedRequest"}}},"description":"Update Feed Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFeedResponse"}}},"description":"Update Feed 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":"Update a feed","tags":["product:feeds"]}},"/api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/activities/mark/batch":{"post":{"description":"Mark activities as read/seen/watched. Can mark by timestamp (seen), activity IDs (read), or all as read.\n","operationId":"MarkActivity","parameters":[{"in":"path","name":"feed_group_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"feed_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkActivityRequest"}}},"description":"Mark Activity Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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 activities as read/seen/watched","tags":["product:feeds"]}},"/api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/activities/{activity_id}/pin":{"delete":{"description":"Unpin an activity from a feed. This removes the pin, so the activity will no longer be displayed at the top of the feed.\n","operationId":"UnpinActivity","parameters":[{"in":"path","name":"feed_group_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"feed_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"path","name":"activity_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"004.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnpinActivityResponse"}}},"description":"Unpin Activity 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":"Unpin an activity from a feed","tags":["product:feeds"]},"post":{"description":"Pin an activity to a feed. Pinned activities are typically displayed at the top of a feed.\n","operationId":"PinActivity","parameters":[{"in":"path","name":"feed_group_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"feed_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"path","name":"activity_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PinActivityRequest"}}},"description":"Pin Activity Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PinActivityResponse"}}},"description":"Pin Activity 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":"Pin an activity to a feed","tags":["product:feeds"]}},"/api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/members":{"patch":{"description":"Add, remove, or set members for a feed\n","operationId":"UpdateFeedMembers","parameters":[{"in":"path","name":"feed_group_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"feed_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFeedMembersRequest"}}},"description":"Update Feed Members Request","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFeedMembersResponse"}}},"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":"Update feed members","tags":["product:feeds"]}},"/api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/members/accept":{"post":{"description":"Accepts a pending feed member request\n","operationId":"AcceptFeedMemberInvite","parameters":[{"in":"path","name":"feed_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"feed_group_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcceptFeedMemberInviteRequest"}}},"description":"Accept Feed Member Invite Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcceptFeedMemberInviteResponse"}}},"description":"Accept Feed Member Invite 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":"Accept a feed member request","tags":["product:feeds"]}},"/api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/members/query":{"post":{"description":"Query feed members based on filters with pagination and sorting options\n","operationId":"QueryFeedMembers","parameters":[{"in":"path","name":"feed_group_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"feed_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryFeedMembersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryFeedMembersResponse"}}},"description":"Successful 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":"Query feed members","tags":["product:feeds"]}},"/api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/members/reject":{"post":{"description":"Rejects a pending feed member request\n","operationId":"RejectFeedMemberInvite","parameters":[{"in":"path","name":"feed_group_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"feed_id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RejectFeedMemberInviteRequest"}}},"description":"Reject Feed Member Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RejectFeedMemberInviteResponse"}}},"description":"Reject Feed Member 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":"Reject an invite to become a feed member","tags":["product:feeds"]}},"/api/v2/feeds/feed_groups/{feed_group_id}/follow_suggestions":{"get":{"description":"Get follow suggestions for a feed group\n","operationId":"GetFollowSuggestions","parameters":[{"in":"path","name":"feed_group_id","required":true,"schema":{"description":"The ID of the feed group to get suggestions for","maxLength":255,"title":"Feed Group ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"limit","schema":{"description":"Maximum number of suggestions to return","format":"int32","maximum":100,"minimum":1,"title":"Limit","type":"integer","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"description":"The ID of the user requesting suggestions (optional, defaults to current user)","title":"User ID","type":"string","writeOnly":true,"x-stream-index":"003.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetFollowSuggestionsResponse"}}},"description":"Follow Suggestions 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":"Get follow suggestions","tags":["product:feeds"]}},"/api/v2/feeds/feed_groups/{id}":{"delete":{"description":"Delete a feed group by its ID. Can perform a soft delete (default) or hard delete.\n","operationId":"DeleteFeedGroup","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"hard_delete","schema":{"description":"Whether to perform a hard delete (true) or soft delete (false, default)","title":"boolean","type":"boolean","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteFeedGroupResponse"}}},"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":"Delete a feed group","tags":["product:feeds"]},"get":{"description":"Get a feed group by ID\n","operationId":"GetFeedGroup","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetFeedGroupResponse"}}},"description":"Get Feed Group 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":"Get a feed group","tags":["product:feeds"]},"post":{"description":"Get an existing feed group or create a new one if it doesn't exist\n","operationId":"GetOrCreateFeedGroup","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Unique identifier for the feed group","maxLength":255,"title":"Feed Group ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrCreateFeedGroupRequest"}}},"description":"Get Or Create Feed Group Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrCreateFeedGroupResponse"}}},"description":"Get Or Create Feed Group 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":"Get or create a feed group","tags":["product:feeds"]},"put":{"description":"Update a feed group by ID\n","operationId":"UpdateFeedGroup","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFeedGroupRequest"}}},"description":"Update Feed Group Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFeedGroupResponse"}}},"description":"Update Feed Group 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":"Update a feed group","tags":["product:feeds"]}},"/api/v2/feeds/feed_views":{"get":{"description":"List all feed views for a feed group\n","operationId":"ListFeedViews","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListFeedViewsResponse"}}},"description":"List Feed Views 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":"List all feed views","tags":["product:feeds"]},"post":{"description":"Create a custom view for a feed group with specific selectors, ranking, or aggregation options\n","operationId":"CreateFeedView","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFeedViewRequest"}}},"description":"Create Feed View Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFeedViewResponse"}}},"description":"Create Feed View 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":"Create a new feed view","tags":["product:feeds"]}},"/api/v2/feeds/feed_views/{id}":{"delete":{"description":"Delete an existing custom feed view\n","operationId":"DeleteFeedView","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteFeedViewResponse"}}},"description":"Delete Feed View 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":"Delete a feed view","tags":["product:feeds"]},"get":{"description":"Get a feed view by its ID\n","operationId":"GetFeedView","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetFeedViewResponse"}}},"description":"Get Feed View 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":"Get a feed view","tags":["product:feeds"]},"post":{"description":"Get an existing feed view or create a new one if it doesn't exist\n","operationId":"GetOrCreateFeedView","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrCreateFeedViewRequest"}}},"description":"Get Or Create Feed View Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrCreateFeedViewResponse"}}},"description":"Get Or Create Feed View 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":"Get or create a feed view","tags":["product:feeds"]},"put":{"description":"Update an existing custom feed view with new selectors, ranking, or aggregation options\n","operationId":"UpdateFeedView","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFeedViewRequest"}}},"description":"Update Feed View Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFeedViewResponse"}}},"description":"Update Feed View 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":"Update a feed view","tags":["product:feeds"]}},"/api/v2/feeds/feeds/batch":{"post":{"description":"Create multiple feeds at once for a given feed group\n","operationId":"CreateFeedsBatch","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFeedsBatchRequest"}}},"description":"Create Feeds Batch Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFeedsBatchResponse"}}},"description":"Create Feeds Batch 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":"Create multiple feeds at once","tags":["product:feeds"]}},"/api/v2/feeds/feeds/query":{"post":{"description":"Query feeds with filter query\n","operationId":"QueryFeeds","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryFeedsRequest"}}},"description":"Query Feeds Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryFeedsResponse"}}},"description":"Query Feeds 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":"Query feeds","tags":["product:feeds"]}},"/api/v2/feeds/follows":{"patch":{"description":"Updates a follow's custom data, push preference, and follower role. Source owner can update custom data and push preference. Target owner can update follower role.\n","operationId":"UpdateFollow","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFollowRequest"}}},"description":"Update Follow Request","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFollowResponse"}}},"description":"Update Follow 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":"Update a follow","tags":["product:feeds"]},"post":{"description":"Creates a follow and broadcasts FollowAddedEvent\n","operationId":"Follow","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FollowRequest"}}},"description":"Follow Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SingleFollowResponse"}}},"description":"Follow 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":"Create a follow","tags":["product:feeds"]}},"/api/v2/feeds/follows/accept":{"post":{"description":"Accepts a pending follow request\n","operationId":"AcceptFollow","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcceptFollowRequest"}}},"description":"Accept Follow Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcceptFollowResponse"}}},"description":"Accept Follow 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":"Accept a follow request","tags":["product:feeds"]}},"/api/v2/feeds/follows/batch":{"post":{"description":"Creates multiple follows at once and broadcasts FollowAddedEvent for each follow\n","operationId":"FollowBatch","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FollowBatchRequest"}}},"description":"Follow Batch Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FollowBatchResponse"}}},"description":"Follow Batch 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":"Create multiple follows at once","tags":["product:feeds"]}},"/api/v2/feeds/follows/query":{"post":{"description":"Query follows based on filters with pagination and sorting options\n","operationId":"QueryFollows","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryFollowsRequest"}}},"description":"Query Follows Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryFollowsResponse"}}},"description":"Query Follows 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":"Query follows","tags":["product:feeds"]}},"/api/v2/feeds/follows/reject":{"post":{"description":"Rejects a pending follow request\n","operationId":"RejectFollow","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RejectFollowRequest"}}},"description":"Reject Follow Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RejectFollowResponse"}}},"description":"Reject Follow 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":"Reject a follow request","tags":["product:feeds"]}},"/api/v2/feeds/follows/{source}/{target}":{"delete":{"description":"Removes a follow and broadcasts FollowRemovedEvent\n","operationId":"Unfollow","parameters":[{"in":"path","name":"source","required":true,"schema":{"description":"Fully qualified ID of the source feed","maxLength":255,"title":"Source Feed","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"target","required":true,"schema":{"description":"Fully qualified ID of the target feed","maxLength":255,"title":"Target Feed","type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnfollowResponse"}}},"description":"Unfollow 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":"Unfollow a feed","tags":["product:feeds"]}},"/api/v2/feeds/membership_levels":{"post":{"description":"Create a new membership level with tag-based access controls\n","operationId":"CreateMembershipLevel","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateMembershipLevelRequest"}}},"description":"Create Membership Level Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateMembershipLevelResponse"}}},"description":"Create Membership Level 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":"Create membership level","tags":["product:feeds"]}},"/api/v2/feeds/membership_levels/query":{"post":{"description":"Query membership levels with filter query\n","operationId":"QueryMembershipLevels","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryMembershipLevelsRequest"}}},"description":"Query Membership Levels Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryMembershipLevelsResponse"}}},"description":"Query Membership Levels 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":"Query membership levels","tags":["product:feeds"]}},"/api/v2/feeds/membership_levels/{id}":{"delete":{"description":"Delete a membership level by its UUID. This operation is irreversible.\n","operationId":"DeleteMembershipLevel","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"The UUID of the membership level to delete","maxLength":255,"title":"string","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete membership level","tags":["product:feeds"]},"patch":{"description":"Update a membership level with partial updates. Only specified fields will be updated.\n","operationId":"UpdateMembershipLevel","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMembershipLevelRequest"}}},"description":"Update Membership Level Request","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMembershipLevelResponse"}}},"description":"Update Membership Level 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":"Update membership level","tags":["product:feeds"]}},"/api/v2/feeds/unfollow/batch":{"post":{"description":"Removes multiple follows at once and broadcasts FollowRemovedEvent for each one\n","operationId":"UnfollowBatch","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnfollowBatchRequest"}}},"description":"Unfollow Batch Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnfollowBatchResponse"}}},"description":"Unfollow Batch 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":"Unfollow multiple feeds at once","tags":["product:feeds"]}},"/api/v2/feeds/users/{user_id}/delete":{"delete":{"description":"Delete all activities, reactions, comments, and bookmarks for a user\n","operationId":"DeleteFeedUserData","parameters":[{"in":"path","name":"user_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteFeedUserDataResponse"}}},"description":"Successful 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":"Delete all feed data for a user","tags":["product:feeds"]}},"/api/v2/feeds/users/{user_id}/export":{"post":{"description":"Export all activities, reactions, comments, and bookmarks for a user\n","operationId":"ExportFeedUserData","parameters":[{"in":"path","name":"user_id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportFeedUserDataResponse"}}},"description":"Successful 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":"Export all feed data for a user","tags":["product:feeds"]}},"/api/v2/guest":{"post":{"description":"\n","operationId":"CreateGuest","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGuestRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGuestResponse"}}},"description":"Successful 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":"Create Guest","tags":["product:common"]}},"/api/v2/import_urls":{"post":{"description":"Creates a new import URL\n","operationId":"CreateImportURL","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateImportURLRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateImportURLResponse"}}},"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":"Create import URL","tags":["product:common"]}},"/api/v2/imports":{"get":{"description":"Gets an import\n","operationId":"ListImports","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListImportsResponse"}}},"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":"Get import","tags":["product:common"]},"post":{"description":"Creates a new import\n","operationId":"CreateImport","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateImportRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateImportResponse"}}},"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":"Create import","tags":["product:common"]}},"/api/v2/imports/{id}":{"get":{"description":"Gets an import\n","operationId":"GetImport","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetImportResponse"}}},"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":"Get import","tags":["product:common"]}},"/api/v2/moderation/ban":{"post":{"description":"Ban a user from a channel or the entire app\n","operationId":"ban","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BanRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BanResponse"}}},"description":"Successful 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":"Ban","tags":["product:moderation"]}},"/api/v2/moderation/bulk_image_moderation":{"post":{"description":"Moderate multiple images in bulk using a CSV file\n","operationId":"bulk_image_moderation","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkImageModerationRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkImageModerationResponse"}}},"description":"Successful 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":"Bulk image moderation","tags":["product:moderation"]}},"/api/v2/moderation/check":{"post":{"description":"Run moderation checks on the provided content\n","operationId":"check","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckResponse"}}},"description":"Successful 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":"Check","tags":["product:moderation"]}},"/api/v2/moderation/config":{"post":{"description":"Create a new moderation configuration or update an existing one. Configure settings for content filtering, AI analysis, toxicity detection, and other moderation features.\n","operationId":"upsert_config","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertConfigRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertConfigResponse"}}},"description":"Successful 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":"Create or update moderation configuration","tags":["product:moderation"]}},"/api/v2/moderation/config/{key}":{"delete":{"description":"Delete a specific moderation policy by its name\n","operationId":"delete_config","parameters":[{"in":"path","name":"key","required":true,"schema":{"description":"Key of the moderation configuration to delete","title":"Key","type":"string","x-stream-index":"001"}},{"in":"query","name":"team","schema":{"description":"Team associated with the configuration","title":"Team","type":"string","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteModerationConfigResponse"}}},"description":"Successful 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":"Delete a moderation policy","tags":["product:moderation"]},"get":{"description":"Retrieve a specific moderation configuration by its key and team. This configuration contains settings for various moderation features like toxicity detection, AI analysis, and filtering rules.\n","operationId":"get_config","parameters":[{"in":"path","name":"key","required":true,"schema":{"description":"Key of the moderation configuration to retrieve","title":"Key","type":"string","x-stream-index":"001"}},{"in":"query","name":"team","schema":{"description":"Team associated with the configuration","title":"Team","type":"string","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetConfigResponse"}}},"description":"Successful 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":"Get moderation configuration","tags":["product:moderation"]}},"/api/v2/moderation/configs":{"post":{"description":"Search and filter moderation configurations across your application. This endpoint is designed for building moderation dashboards and managing multiple configuration sets.\n","operationId":"query_moderation_configs","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationConfigsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationConfigsResponse"}}},"description":"Successful 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":"Query moderation configurations","tags":["product:moderation"]}},"/api/v2/moderation/custom_check":{"post":{"description":"Custom check, add your own AI model reports to the review queue\n","operationId":"custom_check","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomCheckRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomCheckResponse"}}},"description":"Successful 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":"Custom check endpoint","tags":["product:moderation"]}},"/api/v2/moderation/feeds_moderation_template":{"delete":{"description":"Delete a specific moderation template by its name\n","operationId":"V2DeleteTemplate","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteModerationTemplateResponse"}}},"description":"Successful 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":"Delete a moderation template","tags":["product:moderation"]},"get":{"description":"Retrieve a list of feed moderation templates that define preset moderation rules and configurations. Limited to 100 templates per request.\n","operationId":"V2QueryTemplates","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryFeedModerationTemplatesResponse"}}},"description":"Successful 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":"Query feed moderation templates","tags":["product:moderation"]},"post":{"description":"Upsert feeds template for moderation\n","operationId":"V2UpsertTemplate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertModerationTemplateRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertModerationTemplateResponse"}}},"description":"Successful 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":"Upsert feeds template","tags":["product:moderation"]}},"/api/v2/moderation/flag":{"post":{"description":"Flag any type of content (messages, users, channels, activities) for moderation review. Supports custom content types and additional metadata for flagged content.\n","operationId":"flag","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlagRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlagResponse"}}},"description":"Successful 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":"Flag content for moderation","tags":["product:moderation"]}},"/api/v2/moderation/flags":{"post":{"description":"Query flags associated with moderation items. This is used for building a moderation dashboard.\n","operationId":"query_moderation_flags","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationFlagsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationFlagsResponse"}}},"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":"Query moderation flags","tags":["product:moderation"]}},"/api/v2/moderation/logs":{"post":{"description":"Search and filter moderation action logs with support for pagination. View the history of moderation actions taken, including who performed them and when.\n","operationId":"query_moderation_logs","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationLogsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationLogsResponse"}}},"description":"Successful 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":"Query moderation action logs","tags":["product:moderation"]}},"/api/v2/moderation/moderation_rule":{"post":{"description":"Create or update a moderation rule that can apply app-wide or to specific moderation configs\n","operationId":"upsert_moderation_rule","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertModerationRuleRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertModerationRuleResponse"}}},"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":"Upsert moderation rule","tags":["product:moderation"]}},"/api/v2/moderation/moderation_rule/{id}":{"delete":{"description":"Delete an existing moderation rule\n","operationId":"delete_moderation_rule","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteModerationRuleResponse"}}},"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":"Delete moderation rule","tags":["product:moderation"]},"get":{"description":"Get a specific moderation rule by ID\n","operationId":"get_moderation_rule","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetModerationRuleResponse"}}},"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":"Get moderation rule","tags":["product:moderation"]}},"/api/v2/moderation/moderation_rules":{"post":{"description":"Search and filter moderation rules across your application. This endpoint is designed for building moderation dashboards and managing multiple rule sets.\n","operationId":"query_moderation_rules","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationRulesRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryModerationRulesResponse"}}},"description":"Successful 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":"Query moderation rules","tags":["product:moderation"]}},"/api/v2/moderation/mute":{"post":{"description":"Mute a user. Mutes are generally not visible to the user you mute, while block is something you notice.\n","operationId":"mute","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteRequest"}}},"description":"MuteRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteResponse"}}},"description":"MuteResponse"},"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":"Mute","tags":["product:moderation"]}},"/api/v2/moderation/review_queue":{"post":{"description":"Query review queue items allows you to filter the review queue items. This is used for building a moderation dashboard.\n","operationId":"query_review_queue","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryReviewQueueRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryReviewQueueResponse"}}},"description":"Successful 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":"Query review queue items","tags":["product:moderation"]}},"/api/v2/moderation/review_queue/{id}":{"get":{"description":"Retrieve a specific review queue item by its ID\n","operationId":"get_review_queue_item","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Unique identifier of the review queue item to retrieve","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetReviewQueueItemResponse"}}},"description":"Successful 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":"Get review queue item","tags":["product:moderation"]}},"/api/v2/moderation/submit_action":{"post":{"description":"Take action on flagged content, such as marking content as safe, deleting content, banning users, or executing custom moderation actions. Supports various action types with configurable parameters.\n","operationId":"submit_action","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitActionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitActionResponse"}}},"description":"Successful 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":"Submit moderation action","tags":["product:moderation"]}},"/api/v2/moderation/unban":{"post":{"description":"Unban a user from a channel or globally.\n","operationId":"unban","parameters":[{"in":"query","name":"target_user_id","required":true,"schema":{"description":"ID of the user to unban","title":"Target User ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"channel_cid","schema":{"description":"Channel where the unban applies","title":"Channel CID","type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"created_by","schema":{"description":"ID of the user who created the ban","title":"Created By","type":"string","writeOnly":true,"x-stream-index":"003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnbanRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnbanResponse"}}},"description":"Successful 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":"Unban","tags":["product:moderation"]}},"/api/v2/moderation/unmute":{"post":{"description":"Unmute a user\n","operationId":"unmute","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnmuteRequest"}}},"description":"UnmuteRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnmuteResponse"}}},"description":"UnmuteResponse"},"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":"Unmute a user","tags":["product:moderation"]}},"/api/v2/og":{"get":{"description":"Get an OpenGraph attachment for a link\n","operationId":"GetOG","parameters":[{"in":"query","name":"url","required":true,"schema":{"description":"URL to be scraped","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOGResponse"}}},"description":"Get OG Attachment"},"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":"Get OG","tags":["product:common"]}},"/api/v2/permissions":{"get":{"description":"Lists all available permissions\n","operationId":"ListPermissions","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPermissionsResponse"}}},"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":"List permissions","tags":["product:common"]}},"/api/v2/permissions/{id}":{"get":{"description":"Gets custom permission\n","operationId":"GetPermission","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Permission ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCustomPermissionResponse"}}},"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":"Get permission","tags":["product:common"]}},"/api/v2/polls":{"post":{"description":"Creates a new poll\n","operationId":"CreatePoll","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePollRequest"}}},"description":"Create Poll Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Create poll","tags":["product:common"]},"put":{"description":"Updates a poll\n\nSends events:\n- feeds.poll.closed\n- feeds.poll.updated\n- poll.closed\n- poll.updated\n","operationId":"UpdatePoll","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePollRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Update poll","tags":["product:common"]}},"/api/v2/polls/query":{"post":{"description":"Queries polls\n","operationId":"QueryPolls","parameters":[{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryPollsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryPollsResponse"}}},"description":"Successful 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":"Query polls","tags":["product:common"]}},"/api/v2/polls/{poll_id}":{"delete":{"description":"Deletes a poll\n\nSends events:\n- feeds.poll.deleted\n- poll.deleted\n","operationId":"DeletePoll","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete poll","tags":["product:common"]},"get":{"description":"Retrieves a poll\n","operationId":"GetPoll","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Get poll","tags":["product:common"]},"patch":{"description":"Updates a poll partially\n\nSends events:\n- feeds.poll.closed\n- feeds.poll.updated\n- poll.closed\n- poll.updated\n","operationId":"UpdatePollPartial","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePollPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Partial update poll","tags":["product:common"]}},"/api/v2/polls/{poll_id}/options":{"post":{"description":"Creates a poll option\n\nSends events:\n- feeds.poll.updated\n- poll.updated\n","operationId":"CreatePollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePollOptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollOptionResponse"}}},"description":"Successful 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":"Create poll option","tags":["product:common"]},"put":{"description":"Updates a poll option\n\nSends events:\n- feeds.poll.updated\n- poll.updated\n","operationId":"UpdatePollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePollOptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollOptionResponse"}}},"description":"Successful 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":"Update poll option","tags":["product:common"]}},"/api/v2/polls/{poll_id}/options/{option_id}":{"delete":{"description":"Deletes a poll option\n\nSends events:\n- feeds.poll.updated\n- poll.updated\n","operationId":"DeletePollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"path","name":"option_id","required":true,"schema":{"description":"Option ID","maxLength":255,"title":"string","type":"string","x-stream-index":"003"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete poll option","tags":["product:common"]},"get":{"description":"Retrieves a poll option\n","operationId":"GetPollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"path","name":"option_id","required":true,"schema":{"description":"Option ID","maxLength":255,"title":"string","type":"string","x-stream-index":"003"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollOptionResponse"}}},"description":"Successful 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":"Get poll option","tags":["product:common"]}},"/api/v2/polls/{poll_id}/votes":{"post":{"description":"Queries votes\n","operationId":"QueryPollVotes","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryPollVotesRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollVotesResponse"}}},"description":"Successful 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":"Query votes","tags":["product:common"]}},"/api/v2/push_providers":{"get":{"description":"List details of all push providers.\n","operationId":"ListPushProviders","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPushProvidersResponse"}}},"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":"List push providers","tags":["product:common"]},"post":{"description":"Upsert a push provider for v2 with multi bundle/package support\n","operationId":"UpsertPushProvider","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertPushProviderRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertPushProviderResponse"}}},"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":"Upsert a push provider","tags":["product:common"]}},"/api/v2/push_providers/{type}/{name}":{"delete":{"description":"Delete a push provider from v2 with multi bundle/package support. v1 isn't supported in this endpoint\n","operationId":"DeletePushProvider","parameters":[{"in":"path","name":"type","required":true,"schema":{"enum":["apn","firebase","huawei","xiaomi"],"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"name","required":true,"schema":{"maxLength":36,"minLength":1,"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete a push provider","tags":["product:common"]}},"/api/v2/rate_limits":{"get":{"description":"Get rate limits usage and quotas\n","operationId":"GetRateLimits","parameters":[{"in":"query","name":"server_side","schema":{"description":"Whether to include server-side platform limits or not","title":"Server-side","type":"boolean","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"android","schema":{"description":"Whether to include Android platform limits or not","title":"Android","type":"boolean","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"ios","schema":{"description":"Whether to include iOS platform limits or not","title":"iOS","type":"boolean","writeOnly":true,"x-stream-index":"003"}},{"in":"query","name":"web","schema":{"description":"Whether to include web platform limits or not","title":"Web","type":"boolean","writeOnly":true,"x-stream-index":"004"}},{"in":"query","name":"endpoints","schema":{"description":"Specific endpoints to show limits for, as a comma-separated list of values","title":"Endpoints","type":"string","writeOnly":true,"x-stream-index":"005"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRateLimitsResponse"}}},"description":"Get Rate Limits 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":"Get rate limits","tags":["product:common"]}},"/api/v2/roles":{"get":{"description":"Lists all available roles\n","operationId":"ListRoles","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListRolesResponse"}}},"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":"List roles","tags":["product:common"]},"post":{"description":"Creates custom role\n","operationId":"CreateRole","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRoleRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRoleResponse"}}},"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":"Create role","tags":["product:common"]}},"/api/v2/roles/{name}":{"delete":{"description":"Deletes custom role\n","operationId":"DeleteRole","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Role name","title":"Name","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete role","tags":["product:common"]}},"/api/v2/tasks/{id}":{"get":{"description":"Gets status of a task\n","operationId":"GetTask","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Task ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetTaskResponse"}}},"description":"Get Task 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":"Get status of a task","tags":["product:common"]}},"/api/v2/uploads/file":{"delete":{"description":"Deletes previously uploaded file\n","operationId":"DeleteFileGlobal","parameters":[{"in":"query","name":"url","schema":{"description":"File URL to delete","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete file","tags":["product:common"],"x-stream-sdk-name":"DeleteFile"},"post":{"description":"Uploads file\n","operationId":"UploadFileGlobal","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/FileUploadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileUploadResponse"}}},"description":"Successful 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":"Upload file","tags":["product:common"],"x-stream-sdk-name":"UploadFile"}},"/api/v2/uploads/image":{"delete":{"description":"Deletes previously uploaded image\n","operationId":"DeleteImageGlobal","parameters":[{"in":"query","name":"url","schema":{"description":"File URL to delete","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete image","tags":["product:common"],"x-stream-sdk-name":"DeleteImage"},"post":{"description":"Uploads image\n","operationId":"UploadImageGlobal","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/ImageUploadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageUploadResponse"}}},"description":"Successful 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":"Upload image","tags":["product:common"],"x-stream-sdk-name":"UploadImage"}},"/api/v2/users":{"get":{"description":"Find and filter users\n","operationId":"QueryUsers","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryUsersPayload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryUsersResponse"}}},"description":"Successful 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":"Query users","tags":["product:common"]},"patch":{"description":"Updates certain fields of the user\n\nSends events:\n- user.presence.changed\n- user.updated\n- user.presence.changed\n","operationId":"UpdateUsersPartial","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersResponse"}}},"description":"Successful 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":"Partially update user","tags":["product:common"]},"post":{"description":"Update or create users in bulk\n\nSends events:\n- user.updated\n","operationId":"UpdateUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersResponse"}}},"description":"Successful 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":"Upsert users","tags":["product:common"]}},"/api/v2/users/block":{"get":{"description":"Get list of blocked Users\n","operationId":"GetBlockedUsers","parameters":[{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBlockedUsersResponse"}}},"description":"Successful 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":"Get list of blocked Users","tags":["product:common"]},"post":{"description":"Block users\n","operationId":"BlockUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUsersResponse"}}},"description":"Successful 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":"Block user","tags":["product:common"]}},"/api/v2/users/deactivate":{"post":{"description":"Deactivate users in batches\n\nSends events:\n- user.deactivated\n","operationId":"DeactivateUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeactivateUsersRequest"}}},"description":"DeactivateUsersRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeactivateUsersResponse"}}},"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":"Deactivate users","tags":["product:common"]}},"/api/v2/users/delete":{"post":{"description":"Deletes users and optionally all their belongings asynchronously.\n\nSends events:\n- channel.deleted\n- user.deleted\n","operationId":"DeleteUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteUsersResponse"}}},"description":"Successful 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":"Delete Users","tags":["product:common"]}},"/api/v2/users/live_locations":{"get":{"description":"Retrieves all active live locations for a user\n","operationId":"GetUserLiveLocations","parameters":[{"in":"query","name":"user_id","schema":{"description":"User ID to get live locations for. If not provided, returns live locations for the authenticated user.","title":"string","type":"string","writeOnly":true,"x-stream-index":"001.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SharedLocationsResponse"}}},"description":"Successful 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":"Get user live locations","tags":["product:common"]},"put":{"description":"Updates an existing live location with new coordinates or expiration time\n","operationId":"UpdateLiveLocation","parameters":[{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"005.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateLiveLocationRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SharedLocationResponse"}}},"description":"Successful 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":"Update live location","tags":["product:common"]}},"/api/v2/users/reactivate":{"post":{"description":"Reactivate users in batches\n\nSends events:\n- user.reactivated\n- user.reactivated\n","operationId":"ReactivateUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReactivateUsersRequest"}}},"description":"ReactivateUsersRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReactivateUsersResponse"}}},"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":"Reactivate users","tags":["product:common"]}},"/api/v2/users/restore":{"post":{"description":"Restore soft deleted users\n","operationId":"RestoreUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestoreUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Restore users","tags":["product:common"]}},"/api/v2/users/unblock":{"post":{"description":"Unblock users\n","operationId":"UnblockUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUsersResponse"}}},"description":"Successful 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":"Unblock user","tags":["product:common"]}},"/api/v2/users/{user_id}/deactivate":{"post":{"description":"Deactivates user with possibility to activate it back\n\nSends events:\n- user.deactivated\n","operationId":"DeactivateUser","parameters":[{"in":"path","name":"user_id","required":true,"schema":{"title":"User ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeactivateUserRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeactivateUserResponse"}}},"description":"Successful 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":"Deactivate user","tags":["product:common"]}},"/api/v2/users/{user_id}/export":{"get":{"description":"Exports the user's profile, reactions and messages. Raises an error if a user has more than 10k messages or reactions\n","operationId":"ExportUser","parameters":[{"in":"path","name":"user_id","required":true,"schema":{"title":"User ID","type":"string","x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportUserResponse"}}},"description":"Successful 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":"Export user","tags":["product:common"]}},"/api/v2/users/{user_id}/reactivate":{"post":{"description":"Activates user who's been deactivated previously\n\nSends events:\n- user.reactivated\n","operationId":"ReactivateUser","parameters":[{"in":"path","name":"user_id","required":true,"schema":{"title":"User ID","type":"string","x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReactivateUserRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReactivateUserResponse"}}},"description":"Successful 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":"Reactivate user","tags":["product:common"]}},"/api/v2/video/active_calls_status":{"get":{"description":"Get the current status of all active calls including metrics and summary information\n","operationId":"GetActiveCallsStatus","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetActiveCallsStatusResponse"}}},"description":"GetActiveCallsStatusResponse"},"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":"Get active calls status","tags":["product:video"]}},"/api/v2/video/call/feedback":{"post":{"description":"\n","operationId":"QueryUserFeedback","parameters":[{"in":"query","name":"full","schema":{"type":"boolean","writeOnly":true,"x-stream-index":"003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryUserFeedbackRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryUserFeedbackResponse"}}},"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":"Query user reported feedback for the calls","tags":["product:video"]}},"/api/v2/video/call/members":{"post":{"description":"Query call members with filter query\n","operationId":"QueryCallMembers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallMembersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallMembersResponse"}}},"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":"Query call members","tags":["product:video"]}},"/api/v2/video/call/stats":{"post":{"description":"\n","operationId":"QueryCallStats","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallStatsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallStatsResponse"}}},"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":"Query Call Stats","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}":{"get":{"description":"\n","operationId":"GetCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"query","name":"members_limit","schema":{"format":"int32","maximum":100,"minimum":0,"type":"integer","writeOnly":true,"x-stream-index":"004"}},{"in":"query","name":"ring","schema":{"type":"boolean","writeOnly":true,"x-stream-index":"005"}},{"in":"query","name":"notify","schema":{"type":"boolean","writeOnly":true,"x-stream-index":"006"}},{"in":"query","name":"video","schema":{"type":"boolean","writeOnly":true,"x-stream-index":"007"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCallResponse"}}},"description":"GetCallResponse"},"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":"Get Call","tags":["product:video"]},"patch":{"description":"\n\nSends events:\n- call.updated\n","operationId":"UpdateCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallRequest"}}},"description":"UpdateCallRequest","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallResponse"}}},"description":"UpdateCallResponse"},"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":"Update Call","tags":["product:video"]},"post":{"description":"Gets or creates a new call\n\nSends events:\n- call.created\n- call.notification\n- call.ring\n","operationId":"GetOrCreateCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrCreateCallRequest"}}},"description":"GetOrCreateCallRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrCreateCallResponse"}}},"description":"GetOrCreateCallResponse"},"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":"Get or create a call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/block":{"post":{"description":"Block a user, preventing them from joining the call until they are unblocked.\n\nSends events:\n- call.blocked_user\n","operationId":"BlockUser","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUserRequest"}}},"description":"BlockUserRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUserResponse"}}},"description":"BlockUserResponse"},"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":"Block user on a call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/delete":{"post":{"description":"\n\nSends events:\n- call.deleted\n","operationId":"DeleteCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCallRequest"}}},"description":"DeleteCallRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCallResponse"}}},"description":"DeleteCallResponse"},"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":"Delete Call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/event":{"post":{"description":"Sends custom event to the call\n\nSends events:\n- custom\n","operationId":"SendCallEvent","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendCallEventRequest"}}},"description":"SendCallEventRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendCallEventResponse"}}},"description":"SendCallEventResponse"},"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":"Send custom event","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/feedback":{"post":{"description":"\n\nSends events:\n- call.user_feedback_submitted\n","operationId":"CollectUserFeedback","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectUserFeedbackRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectUserFeedbackResponse"}}},"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":"Collect user feedback","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/go_live":{"post":{"description":"\n\nSends events:\n- call.live_started\n","operationId":"GoLive","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoLiveRequest"}}},"description":"GoLiveRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoLiveResponse"}}},"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":"Set call as live","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/kick":{"post":{"description":"Kicks a user from the call. Optionally block the user from rejoining by setting block=true.\n\nSends events:\n- call.blocked_user\n- call.kicked_user\n","operationId":"KickUser","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KickUserRequest"}}},"description":"KickUserRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KickUserResponse"}}},"description":"KickUserResponse"},"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":"Kick user from a call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/mark_ended":{"post":{"description":"\n\nSends events:\n- call.ended\n","operationId":"EndCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EndCallResponse"}}},"description":"EndCallResponse"},"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":"End call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/members":{"post":{"description":"\n\nSends events:\n- call.member_added\n- call.member_removed\n- call.member_updated\n","operationId":"UpdateCallMembers","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallMembersRequest"}}},"description":"UpdateCallMembersRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallMembersResponse"}}},"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":"Update Call Member","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/mute_users":{"post":{"description":"Mutes users in a call\n","operationId":"MuteUsers","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteUsersRequest"}}},"description":"MuteUsersRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteUsersResponse"}}},"description":"MuteUsersResponse"},"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":"Mute users","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/participants":{"post":{"description":"Returns a list of participants connected to the call\n","operationId":"QueryCallParticipants","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"type","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"limit","schema":{"format":"int32","maximum":100,"type":"integer","x-stream-index":"004"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallParticipantsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallParticipantsResponse"}}},"description":"Successful 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":"Query call participants","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/pin":{"post":{"description":"Pins a track for all users in the call.\n","operationId":"VideoPin","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PinRequest"}}},"description":"PinRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PinResponse"}}},"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":"Pin","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/recordings":{"get":{"description":"Lists recordings\n","operationId":"ListRecordings","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListRecordingsResponse"}}},"description":"ListRecordingsResponse"},"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":"List recordings","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/report":{"get":{"description":"\n","operationId":"GetCallReport","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"query","name":"session_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCallReportResponse"}}},"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":"Get call report","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/rtmp_broadcasts":{"post":{"description":"Starts RTMP broadcasts for the provided RTMP destinations\n","operationId":"StartRTMPBroadcasts","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRTMPBroadcastsRequest"}}},"description":"StartRTMPBroadcastsRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRTMPBroadcastsResponse"}}},"description":"StartRTMPBroadcastsResponse"},"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":"Start RTMP broadcasts","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/rtmp_broadcasts/stop":{"post":{"description":"Stop all RTMP broadcasts for the provided call\n","operationId":"StopAllRTMPBroadcasts","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopAllRTMPBroadcastsResponse"}}},"description":"StopAllRTMPBroadcastsResponse"},"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":"Stop all RTMP broadcasts for a call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/rtmp_broadcasts/{name}/stop":{"post":{"description":"Stop RTMP broadcasts for the provided RTMP destinations\n","operationId":"StopRTMPBroadcast","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopRTMPBroadcastsRequest"}}},"description":"StopRTMPBroadcastsRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopRTMPBroadcastsResponse"}}},"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":"Stop RTMP broadcasts","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/start_broadcasting":{"post":{"description":"Starts HLS broadcasting\n","operationId":"StartHLSBroadcasting","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartHLSBroadcastingResponse"}}},"description":"StartHLSBroadcastingResponse"},"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":"Start HLS broadcasting","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/start_closed_captions":{"post":{"description":"Starts closed captions\n","operationId":"StartClosedCaptions","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartClosedCaptionsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartClosedCaptionsResponse"}}},"description":"Successful 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":"Start closed captions","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/start_frame_recording":{"post":{"description":"Starts frame by frame recording\n\nSends events:\n- call.frame_recording_started\n","operationId":"StartFrameRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartFrameRecordingRequest"}}},"description":"StartFrameRecordingRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartFrameRecordingResponse"}}},"description":"StartFrameRecordingResponse"},"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":"Start frame recording","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/start_recording":{"post":{"description":"Starts recording\n\nSends events:\n- call.recording_started\n","operationId":"StartRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRecordingRequest"}}},"description":"StartRecordingRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRecordingResponse"}}},"description":"StartRecordingResponse"},"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":"Start recording","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/start_transcription":{"post":{"description":"Starts transcription\n","operationId":"StartTranscription","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartTranscriptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartTranscriptionResponse"}}},"description":"StartTranscriptionResponse"},"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":"Start transcription","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_broadcasting":{"post":{"description":"Stops HLS broadcasting\n","operationId":"StopHLSBroadcasting","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopHLSBroadcastingResponse"}}},"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":"Stop HLS broadcasting","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_closed_captions":{"post":{"description":"Stops closed captions\n\nSends events:\n- call.transcription_stopped\n","operationId":"StopClosedCaptions","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopClosedCaptionsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopClosedCaptionsResponse"}}},"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":"Stop closed captions","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_frame_recording":{"post":{"description":"Stops frame recording\n\nSends events:\n- call.frame_recording_stopped\n","operationId":"StopFrameRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopFrameRecordingResponse"}}},"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":"Stop frame recording","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_live":{"post":{"description":"\n\nSends events:\n- call.updated\n","operationId":"StopLive","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopLiveRequest"}}},"description":"StopLiveRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopLiveResponse"}}},"description":"StopLiveResponse"},"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":"Set call as not live","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_recording":{"post":{"description":"Stops recording\n\nSends events:\n- call.recording_stopped\n","operationId":"StopRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopRecordingResponse"}}},"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":"Stop recording","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_transcription":{"post":{"description":"Stops transcription\n\nSends events:\n- call.transcription_stopped\n","operationId":"StopTranscription","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopTranscriptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopTranscriptionResponse"}}},"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":"Stop transcription","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/transcriptions":{"get":{"description":"Lists transcriptions\n","operationId":"ListTranscriptions","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTranscriptionsResponse"}}},"description":"ListTranscriptionsResponse"},"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":"List transcriptions","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/unblock":{"post":{"description":"Removes the block for a user on a call. The user will be able to join the call again.\n\nSends events:\n- call.unblocked_user\n","operationId":"UnblockUser","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUserRequest"}}},"description":"UnblockUserRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUserResponse"}}},"description":"UnblockUserResponse"},"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":"Unblocks user on a call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/unpin":{"post":{"description":"Unpins a track for all users in the call.\n","operationId":"VideoUnpin","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnpinRequest"}}},"description":"UnpinRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnpinResponse"}}},"description":"UnpinResponse"},"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":"Unpin","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/user_permissions":{"post":{"description":"Updates user permissions\n\nSends events:\n- call.permissions_updated\n","operationId":"UpdateUserPermissions","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"005.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"005.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUserPermissionsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUserPermissionsResponse"}}},"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":"Update user permissions","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/{session}/recordings/{filename}":{"delete":{"description":"Deletes recording\n","operationId":"DeleteRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"path","name":"session","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"003"}},{"in":"path","name":"filename","required":true,"schema":{"maxLength":256,"type":"string","writeOnly":true,"x-stream-index":"004"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteRecordingResponse"}}},"description":"DeleteRecordingResponse"},"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":"Delete recording","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/{session}/transcriptions/{filename}":{"delete":{"description":"Deletes transcription\n","operationId":"DeleteTranscription","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"path","name":"session","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"003"}},{"in":"path","name":"filename","required":true,"schema":{"maxLength":256,"type":"string","writeOnly":true,"x-stream-index":"004"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteTranscriptionResponse"}}},"description":"DeleteTranscriptionResponse"},"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":"Delete transcription","tags":["product:video"]}},"/api/v2/video/calls":{"post":{"description":"Query calls with filter query\n","operationId":"QueryCalls","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallsRequest"}}},"description":"QueryCallsRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallsResponse"}}},"description":"QueryCallsResponse"},"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":"Query call","tags":["product:video"]}},"/api/v2/video/calltypes":{"get":{"description":"\n","operationId":"ListCallTypes","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListCallTypeResponse"}}},"description":"ListCallTypeResponse"},"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":"List Call Type","tags":["product:video"]},"post":{"description":"\n","operationId":"CreateCallType","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCallTypeRequest"}}},"description":"CreateCallTypeRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCallTypeResponse"}}},"description":"CreateCallTypeResponse"},"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":"Create Call Type","tags":["product:video"]}},"/api/v2/video/calltypes/{name}":{"delete":{"description":"\n","operationId":"DeleteCallType","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete Call Type","tags":["product:video"]},"get":{"description":"\n","operationId":"GetCallType","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCallTypeResponse"}}},"description":"GetCallTypeResponse"},"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":"Get Call Type","tags":["product:video"]},"put":{"description":"\n","operationId":"UpdateCallType","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallTypeRequest"}}},"description":"UpdateCallTypeRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallTypeResponse"}}},"description":"UpdateCallTypeResponse"},"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":"Update Call Type","tags":["product:video"]}},"/api/v2/video/edges":{"get":{"description":"Returns the list of all edges available for video calls.\n","operationId":"GetEdges","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetEdgesResponse"}}},"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":"Get Edges","tags":["product:video"]}},"/api/v2/video/stats":{"post":{"description":"\n","operationId":"QueryAggregateCallStats","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryAggregateCallStatsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryAggregateCallStatsResponse"}}},"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":"Query Aggregate call Stats","tags":["product:video"]}}},"security":[{"JWT":[],"api_key":[],"stream-auth-type":[]},{"api_key":[],"stream-auth-type":[]}],"servers":[{"description":"Stream API","url":"https://chat.stream-io-api.com"}]} \ No newline at end of file diff --git a/openapi/v2/serverside-api.yaml b/openapi/v2/serverside-api.yaml index 420dd0f99..2ac236428 100644 --- a/openapi/v2/serverside-api.yaml +++ b/openapi/v2/serverside-api.yaml @@ -253,6 +253,74 @@ components: - action - min_confidence type: object + AcceptFeedMemberInviteRequest: + nullable: true + properties: + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "003.002" + user_id: + type: string + x-stream-index: "003.001" + title: Accept Feed Member Invite Request + type: object + AcceptFeedMemberInviteResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + member: + $ref: '#/components/schemas/FeedMemberResponse' + description: The feed member after accepting the invite + title: Feed Member + x-stream-index: "001" + required: + - member + - duration + title: Accept Feed Member Invite Response + type: object + AcceptFollowRequest: + nullable: true + properties: + follower_role: + description: Optional role for the follower in the follow relationship + title: Follower Role + type: string + x-stream-index: "003" + source: + description: Fully qualified ID of the source feed + maxLength: 255 + title: Source Feed ID + type: string + x-stream-index: "001" + target: + description: Fully qualified ID of the target feed + maxLength: 255 + title: Target Feed ID + type: string + x-stream-index: "002" + required: + - source + - target + title: Accept Follow Request + type: object + AcceptFollowResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + follow: + $ref: '#/components/schemas/FollowResponse' + description: The accepted follow relationship + title: Follow + x-stream-index: "001" + required: + - follow + - duration + title: Accept Follow Response + type: object Action: nullable: true properties: @@ -423,6 +491,20 @@ components: - warning - warning_text type: object + ActiveCallsBitrateStats: + properties: + p10: + format: float + type: number + x-stream-index: "001" + p50: + format: float + type: number + x-stream-index: "002" + required: + - p10 + - p50 + type: object ActiveCallsFPSStats: properties: p05: @@ -473,6 +555,20 @@ components: $ref: '#/components/schemas/SubscribersMetrics' x-stream-index: "003" type: object + ActiveCallsResolutionStats: + properties: + p10: + format: float + type: number + x-stream-index: "001" + p50: + format: float + type: number + x-stream-index: "002" + required: + - p10 + - p50 + type: object ActiveCallsSummary: properties: active_calls: @@ -497,1355 +593,2324 @@ components: - active_subscribers - participants type: object - ActivityMarkedEvent: + ActivityAddedEvent: + description: Emitted when an activity is added to a feed. + nullable: true properties: - all_read: - type: boolean - x-stream-index: "006" - all_seen: - type: boolean - x-stream-index: "007" + activity: + $ref: '#/components/schemas/ActivityResponse' + description: The activity that was added + title: Activity + x-stream-index: "001" created_at: + description: Date/time of creation format: date-time + title: Created at type: number - x-stream-index: "001.002" - feed_id: + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + feed_visibility: type: string - x-stream-index: "003" - marked_read: - items: - type: string - type: array - x-stream-index: "004" - marked_watched: - items: - type: string - type: array - x-stream-index: "005" - type: - default: activity.marked + x-stream-index: "002.003" + fid: type: string - x-stream-index: "001.001" - user_id: + x-stream-index: "002.002" + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 + type: + default: feeds.activity.added + description: 'The type of event: "feeds.activity.added" in this case' + title: Event Type type: string - x-stream-index: "002" + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who added the activity + title: User + x-stream-index: "003.001" required: + - activity - type - created_at - - user_id - - feed_id - - all_read - - all_seen - title: ActivityMarkedEvent + - custom + - fid + title: ActivityAddedEvent 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 - AnyEvent: + ActivityDeletedEvent: + description: Emitted when an activity is deleted. + nullable: true properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + description: The activity that was updated + title: Activity + x-stream-index: "001" created_at: + description: Date/time of creation format: date-time + title: Created at type: number - x-stream-index: "001.002" + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + feed_visibility: + type: string + x-stream-index: "002.003" + fid: + type: string + x-stream-index: "002.002" + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 type: - default: '*' + default: feeds.activity.deleted + description: 'The type of event: "feeds.activity.deleted" in this case' + title: Event Type type: string - x-stream-index: "001.001" + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + x-stream-index: "003.001" required: + - activity - type - created_at - title: AnyEvent + - custom + - fid + title: ActivityDeletedEvent 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 - AppResponseFields: + ActivityFeedbackRequest: + description: Request to provide feedback on an activity + nullable: true properties: - allowed_flag_reasons: - items: - type: string - type: array - x-stream-index: "019" - async_url_enrich_enabled: + hide: + description: Whether to hide this activity + title: bool type: boolean - x-stream-index: "017" - auto_translation_enabled: + x-stream-index: "003" + mute_user: + description: Whether to mute the user who created this activity + title: bool type: boolean - x-stream-index: "020" - before_message_send_hook_url: + x-stream-index: "005" + reason: + description: Reason for the feedback (optional) + maxLength: 1000 + title: string type: string - x-stream-index: "021" - call_types: - additionalProperties: - $ref: '#/components/schemas/CallType' - type: object - x-stream-index: "007" - campaign_enabled: - type: boolean - x-stream-index: "034" - cdn_expiration_seconds: - format: int32 - type: integer - x-stream-index: "037" - channel_configs: - additionalProperties: - $ref: '#/components/schemas/ChannelConfig' - type: object x-stream-index: "006" - custom_action_handler_url: - type: string - x-stream-index: "022" - datadog_info: - $ref: '#/components/schemas/DataDogInfo' - x-stream-index: "040" - disable_auth_checks: + report: + description: Whether to report this activity + title: bool type: boolean - x-stream-index: "011" - disable_permissions_checks: + x-stream-index: "004" + show_less: + description: Whether to show less content like this + title: bool type: boolean - x-stream-index: "012" - enforce_unique_usernames: + x-stream-index: "002" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "008.002" + user_id: type: string - x-stream-index: "023" - event_hooks: - items: - $ref: '#/components/schemas/EventHook' - type: array - x-stream-index: "045" - file_upload_config: - $ref: '#/components/schemas/FileUploadConfig' - x-stream-index: "030" - geofences: - items: - $ref: '#/components/schemas/GeofenceResponse' - type: array - x-stream-index: "039" - grants: - additionalProperties: - items: - type: string - type: array + x-stream-index: "008.001" + title: Activity Feedback Request + type: object + ActivityFeedbackResponse: + description: Response for activity feedback submission + nullable: true + properties: + activity_id: + description: The ID of the activity that received feedback + title: string + type: string + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - activity_id + - duration + title: Activity Feedback Response + type: object + ActivityLocation: + properties: + lat: + description: Latitude coordinate + format: float + title: Latitude + type: number + x-stream-index: "001" + lng: + description: Longitude coordinate + format: float + title: Longitude + type: number + x-stream-index: "002" + required: + - lat + - lng + title: Activity Location + type: object + ActivityMarkEvent: + description: Emitted when activities are marked as read, seen, or watched. + nullable: true + properties: + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 006.001.003 + custom: + additionalProperties: {} type: object - x-stream-index: "033" - guest_user_creation_disabled: + x-stream-index: 006.001.007 + feed_visibility: + type: string + x-stream-index: "006.003" + fid: + type: string + x-stream-index: "006.002" + mark_all_read: + description: Whether all activities were marked as read + title: Mark All Read type: boolean - x-stream-index: "043" - image_moderation_enabled: + x-stream-index: "004" + mark_all_seen: + description: Whether all activities were marked as seen + title: Mark All Seen type: boolean - x-stream-index: "016" - image_moderation_labels: + x-stream-index: "005" + mark_read: + description: The IDs of activities marked as read items: type: string + title: Mark Read type: array - x-stream-index: "018" - image_upload_config: - $ref: '#/components/schemas/FileUploadConfig' - x-stream-index: "031" - moderation_bulk_submit_action_enabled: - type: boolean - x-stream-index: "048" - moderation_dashboard_preferences: - $ref: '#/components/schemas/ModerationDashboardPreferences' - x-stream-index: "044" - moderation_enabled: - type: boolean - x-stream-index: "041" - moderation_multitenant_blocklist_enabled: - type: boolean - x-stream-index: "042" - moderation_webhook_url: - type: string - x-stream-index: "005" - multi_tenant_enabled: - type: boolean - x-stream-index: "015" - name: - type: string x-stream-index: "001" - organization: - type: string + mark_seen: + description: The IDs of activities marked as seen + items: + type: string + title: Mark Seen + type: array x-stream-index: "002" - permission_version: - type: string - x-stream-index: "013" - policies: - additionalProperties: - items: - $ref: '#/components/schemas/Policy' - type: array - type: object - x-stream-index: "008" - push_notifications: - $ref: '#/components/schemas/PushNotificationFields' + mark_watched: + description: The IDs of activities marked as watched + items: + type: string + title: Mark Watched + type: array x-stream-index: "003" - reminders_interval: - format: int32 - type: integer - x-stream-index: "036" - revoke_tokens_issued_before: + received_at: format: date-time type: number - x-stream-index: "032" - sns_key: - type: string - x-stream-index: "028" - sns_secret: - type: string - x-stream-index: "029" - sns_topic_arn: - type: string - x-stream-index: "027" - sqs_key: - type: string - x-stream-index: "025" - sqs_secret: - type: string - x-stream-index: "026" - sqs_url: - type: string - x-stream-index: "024" - suspended: - type: boolean - x-stream-index: "009" - suspended_explanation: + x-stream-index: 006.001.004 + type: + default: feeds.activity.marked + description: 'The type of event: "feeds.activity.marked" in this case' + title: Event Type type: string - x-stream-index: "010" - use_hook_v2: + x-stream-index: 006.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who marked the activities + title: User + x-stream-index: "007.001" + required: + - type + - created_at + - custom + - fid + title: ActivityMarkEvent + 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 + ActivityMarkedEvent: + properties: + all_read: type: boolean - x-stream-index: "046" - user_response_time_enabled: + x-stream-index: "006" + all_seen: type: boolean - x-stream-index: "047" - user_search_disallowed_roles: + x-stream-index: "007" + created_at: + format: date-time + type: number + x-stream-index: "001.002" + feed_id: + type: string + x-stream-index: "003" + marked_read: items: type: string type: array - x-stream-index: "014" - webhook_events: + x-stream-index: "004" + marked_watched: items: type: string type: array - x-stream-index: "035" - webhook_url: + x-stream-index: "005" + type: + default: activity.marked + type: string + x-stream-index: "001.001" + user_id: type: string + x-stream-index: "002" + required: + - type + - created_at + - user_id + - feed_id + - all_read + - all_seen + title: ActivityMarkedEvent + 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 + ActivityPinResponse: + properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + description: The pinned activity + title: Activity + x-stream-index: "002" + created_at: + description: When the pin was created + format: date-time + title: Created At + type: number x-stream-index: "004" + feed: + description: ID of the feed where activity is pinned + title: Feed ID + type: string + x-stream-index: "003" + updated_at: + description: When the pin was last updated + format: date-time + title: Updated At + type: number + x-stream-index: "005" + user: + $ref: '#/components/schemas/UserResponse' + description: User who pinned the activity + title: User + x-stream-index: "001" required: - - name - - organization - - push_notifications - - webhook_url - - moderation_webhook_url - - channel_configs - - call_types - - policies - - suspended - - suspended_explanation - - disable_auth_checks - - disable_permissions_checks - - permission_version - - user_search_disallowed_roles - - multi_tenant_enabled - - image_moderation_enabled - - async_url_enrich_enabled - - auto_translation_enabled - - custom_action_handler_url - - enforce_unique_usernames - - sqs_url - - sqs_key - - sqs_secret - - sns_topic_arn - - sns_key - - sns_secret - - file_upload_config - - image_upload_config - - grants - - campaign_enabled - - webhook_events - - reminders_interval - - cdn_expiration_seconds - - video_provider - - moderation_enabled - - moderation_multitenant_blocklist_enabled - - guest_user_creation_disabled - - event_hooks - - use_hook_v2 - - user_response_time_enabled - - moderation_bulk_submit_action_enabled + - user + - activity + - feed + - created_at + - updated_at + title: Activity Pin type: object - AsyncBulkImageModerationEvent: + ActivityPinnedEvent: + description: Emitted when an activity is pinned. nullable: true properties: created_at: + description: Date/time of creation format: date-time + title: Created at type: number - x-stream-index: "003.003" + x-stream-index: 002.001.003 custom: additionalProperties: {} type: object - x-stream-index: "003.007" - finished_at: - format: date-time - type: number + x-stream-index: 002.001.007 + feed_visibility: + type: string x-stream-index: "002.003" + fid: + description: The ID of the feed + title: Feed ID + type: string + x-stream-index: "002.002" + pinned_activity: + $ref: '#/components/schemas/PinActivityResponse' + x-stream-index: "001" received_at: format: date-time type: number - x-stream-index: "003.004" - started_at: - format: date-time - type: number - x-stream-index: "002.002" - task_id: - type: string - x-stream-index: "002.001" + x-stream-index: 002.001.004 type: - default: export.bulk_image_moderation.success - type: string - x-stream-index: "003.002" - url: + default: feeds.activity.pinned + description: 'The type of event: "feeds.activity.pinned" in this case' + title: Event Type type: string - x-stream-index: "001" + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who pinned the activity + title: User + x-stream-index: "003.001" required: - - url - - task_id - - started_at - - finished_at + - pinned_activity - type - created_at - custom - title: AsyncBulkImageModerationEvent + - fid + title: ActivityPinnedEvent 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 - AsyncExportChannelsEvent: + ActivityProcessorConfig: + properties: + type: + description: Type of activity processor (required) + title: Type + type: string + x-stream-index: "001" + required: + - type + title: Activity Processor Configuration + type: object + ActivityReactionAddedEvent: + description: Emitted when a reaction is added to an activity. nullable: true properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + x-stream-index: "001" created_at: + description: Date/time of creation format: date-time + title: Created at type: number - x-stream-index: "003.003" + x-stream-index: 003.001.003 custom: additionalProperties: {} type: object - x-stream-index: "003.007" - finished_at: - format: date-time - type: number - x-stream-index: "002.003" + x-stream-index: 003.001.007 + feed_visibility: + type: string + x-stream-index: "003.003" + fid: + type: string + x-stream-index: "003.002" + reaction: + $ref: '#/components/schemas/FeedsReactionResponse' + description: The reaction that was added + title: Reaction + x-stream-index: "002" received_at: format: date-time type: number - x-stream-index: "003.004" - started_at: - format: date-time - type: number - x-stream-index: "002.002" - task_id: - type: string - x-stream-index: "002.001" + x-stream-index: 003.001.004 type: - default: export.channels.success - type: string - x-stream-index: "003.002" - url: + default: feeds.activity.reaction.added + description: 'The type of event: "feeds.activity.reaction.added" in this + case' + title: Event Type type: string - x-stream-index: "001" + x-stream-index: 003.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who added the reaction + title: User + x-stream-index: "004.001" required: - - url - - task_id - - started_at - - finished_at + - activity + - reaction - type - created_at - custom - title: AsyncExportChannelsEvent + - fid + title: ActivityReactionAddedEvent 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 - AsyncExportErrorEvent: + ActivityReactionDeletedEvent: + description: Emitted when a reaction is deleted from an activity. nullable: true properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + x-stream-index: "001" created_at: + description: Date/time of creation format: date-time + title: Created at type: number - x-stream-index: "003.003" + x-stream-index: 003.001.003 custom: additionalProperties: {} type: object - x-stream-index: "003.007" - error: + x-stream-index: 003.001.007 + feed_visibility: type: string - x-stream-index: "001" - finished_at: - format: date-time - type: number - x-stream-index: "002.003" + x-stream-index: "003.003" + fid: + type: string + x-stream-index: "003.002" + reaction: + $ref: '#/components/schemas/FeedsReactionResponse' + x-stream-index: "002" received_at: format: date-time type: number - x-stream-index: "003.004" - started_at: - format: date-time - type: number - x-stream-index: "002.002" - task_id: - type: string - x-stream-index: "002.001" + x-stream-index: 003.001.004 type: - default: export.users.error + default: feeds.activity.reaction.deleted + description: The type of the reaction that was removed + title: Type type: string - x-stream-index: "003.002" + x-stream-index: 003.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who removed the reaction + title: User + x-stream-index: "004.001" required: - - error - - task_id - - started_at - - finished_at + - activity + - reaction - type - created_at - custom - title: AsyncExportErrorEvent + - fid + title: ActivityReactionDeletedEvent 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 - AsyncExportModerationLogsEvent: + ActivityReactionUpdatedEvent: + description: Emitted when a reaction is updated on an activity. nullable: true properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + x-stream-index: "001" created_at: + description: Date/time of creation format: date-time + title: Created at type: number - x-stream-index: "003.003" + x-stream-index: 003.001.003 custom: additionalProperties: {} type: object - x-stream-index: "003.007" - finished_at: - format: date-time - type: number - x-stream-index: "002.003" + x-stream-index: 003.001.007 + feed_visibility: + type: string + x-stream-index: "003.003" + fid: + type: string + x-stream-index: "003.002" + reaction: + $ref: '#/components/schemas/FeedsReactionResponse' + description: The reaction that was updated + title: Reaction + x-stream-index: "002" received_at: format: date-time type: number - x-stream-index: "003.004" - started_at: - format: date-time - type: number - x-stream-index: "002.002" - task_id: - type: string - x-stream-index: "002.001" + x-stream-index: 003.001.004 type: - default: export.moderation_logs.success - type: string - x-stream-index: "003.002" - url: + default: feeds.activity.reaction.updated + description: 'The type of event: "feeds.activity.reaction.updated" in this + case' + title: Event Type type: string - x-stream-index: "001" + x-stream-index: 003.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who updated the reaction + title: User + x-stream-index: "004.001" required: - - url - - task_id - - started_at - - finished_at + - activity + - reaction - type - created_at - custom - title: AsyncExportModerationLogsEvent + - fid + title: ActivityReactionUpdatedEvent 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 - AsyncExportUsersEvent: + ActivityRemovedFromFeedEvent: + description: Emitted when an activity is removed from a feed. nullable: true properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + x-stream-index: "001" created_at: + description: Date/time of creation format: date-time + title: Created at type: number - x-stream-index: "003.003" + x-stream-index: 002.001.003 custom: additionalProperties: {} type: object - x-stream-index: "003.007" - finished_at: - format: date-time - type: number + x-stream-index: 002.001.007 + feed_visibility: + type: string x-stream-index: "002.003" + fid: + type: string + x-stream-index: "002.002" received_at: format: date-time type: number - x-stream-index: "003.004" - started_at: - format: date-time - type: number - x-stream-index: "002.002" - task_id: - type: string - x-stream-index: "002.001" + x-stream-index: 002.001.004 type: - default: export.users.success - type: string - x-stream-index: "003.002" - url: + default: feeds.activity.removed_from_feed + description: 'The type of event: "feeds.activity.removed_from_feed" in this + case' + title: Event Type type: string - x-stream-index: "001" + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who removed the activity + title: User + x-stream-index: "003.001" required: - - url - - task_id - - started_at - - finished_at + - activity - type - created_at - custom - title: AsyncExportUsersEvent + - fid + title: ActivityRemovedFromFeedEvent 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 - AsyncModerationCallbackConfig: + ActivityRequest: properties: - mode: - enum: - - CALLBACK_MODE_NONE - - CALLBACK_MODE_REST - - CALLBACK_MODE_TWIRP + attachments: + description: List of attachments for the activity + items: + $ref: '#/components/schemas/Attachment' + title: Attachments + type: array + x-stream-index: "006" + custom: + additionalProperties: {} + description: Custom data for the activity + title: Custom Data + type: object + x-stream-index: "017" + expires_at: + description: Expiration time for the activity + title: Expires At type: string - x-stream-index: "002" - server_url: + x-stream-index: "010" + feeds: + description: List of feed IDs to add the activity to + items: + type: string + maximum: 255 + minimum: 1 + title: Feed IDs + type: array + x-stream-index: "004" + filter_tags: + description: Tags for filtering activities + items: + type: string + maximum: 255 + title: Filter Tags + type: array + x-stream-index: "013" + id: + description: Optional ID for the activity + maxLength: 255 + title: Activity ID type: string x-stream-index: "001" - type: object - AsyncModerationConfiguration: - properties: - callback: - $ref: '#/components/schemas/AsyncModerationCallbackConfig' - x-stream-index: "002" - timeout_ms: - format: int32 - type: integer - x-stream-index: "001" - type: object - Attachment: - description: An attachment is a message object that represents a file uploaded - by a user. - nullable: true - properties: - actions: + interest_tags: + description: Tags for indicating user interests items: - $ref: '#/components/schemas/Action' + type: string + maximum: 255 + title: Interest Tags type: array - x-stream-index: "015" - asset_url: - type: string - x-stream-index: "017" - author_icon: + x-stream-index: "014" + location: + $ref: '#/components/schemas/ActivityLocation' + description: Geographic location related to the activity + title: Location + x-stream-index: "009" + mentioned_user_ids: + description: List of users mentioned in the activity + items: + type: string + maximum: 255 + title: Mentioned User IDs + type: array + x-stream-index: "011" + parent_id: + description: ID of parent activity for replies/comments + maxLength: 255 + title: Parent ID type: string - x-stream-index: "007" - author_link: + x-stream-index: "015" + poll_id: + description: ID of a poll to attach to activity + title: Poll ID type: string - x-stream-index: "006" - author_name: + x-stream-index: "016" + search_data: + additionalProperties: {} + description: Additional data for search indexing + title: Search Data + type: object + x-stream-index: "012" + text: + description: Text content of the activity + title: Text type: string x-stream-index: "005" - color: + type: + description: Type of activity + maxLength: 255 + title: Activity Type + type: string + x-stream-index: "002" + user_id: + description: ID of the user creating the activity + maxLength: 255 + title: User ID type: string x-stream-index: "003" + visibility: + description: Visibility setting for the activity + enum: + - public + - private + - tag + title: Visibility + type: string + x-stream-index: "007" + visibility_tag: + description: If visibility is 'tag', this is the tag name and is required + maxLength: 32 + title: Visibility Tag + type: string + x-stream-index: "008" + required: + - type + - feeds + title: Activity Request + type: object + ActivityResponse: + properties: + attachments: + description: Media attachments for the activity + items: + $ref: '#/components/schemas/Attachment' + title: Attachments + type: array + x-stream-index: "009" + bookmark_count: + description: Number of bookmarks on the activity + format: int32 + title: Bookmark Count + type: integer + x-stream-index: "028" + comment_count: + description: Number of comments on the activity + format: int32 + title: Comment Count + type: integer + x-stream-index: "027" + comments: + description: Comments on this activity + items: + $ref: '#/components/schemas/CommentResponse' + title: Comments + type: array + x-stream-index: "015" + created_at: + description: When the activity was created + format: date-time + title: Created At + type: number + x-stream-index: "007" + current_feed: + $ref: '#/components/schemas/FeedResponse' + description: Feed context for this activity view. If an activity is added + only to one feed, it's always set. If an activity is added to multiple + feeds, it's only set when calling the GetOrCreateFeed endpoint. + title: Current Feed + x-stream-index: "035" custom: additionalProperties: {} + description: Custom data for the activity + title: Custom Data type: object - x-stream-index: "018" - fallback: - type: string - x-stream-index: "002" - fields: + x-stream-index: "011" + deleted_at: + description: When the activity was deleted + format: date-time + title: Deleted At + type: number + x-stream-index: "021" + edited_at: + description: When the activity was last edited + format: date-time + title: Edited At + type: number + x-stream-index: "020" + expires_at: + description: When the activity will expire + format: date-time + title: Expires At + type: number + x-stream-index: "022" + feeds: + description: List of feed IDs containing this activity items: - $ref: '#/components/schemas/Field' + type: string + title: Feeds type: array - x-stream-index: "016" - footer: - type: string - x-stream-index: "013" - footer_icon: + x-stream-index: "004" + filter_tags: + description: Tags for filtering + items: + type: string + title: Filter Tags + type: array + x-stream-index: "024" + hidden: + description: If this activity is hidden for this user. For premium content + where you want to show a preview + title: Hidden + type: boolean + x-stream-index: "036" + id: + description: Unique identifier for the activity + title: ID type: string - x-stream-index: "014" - giphy: - $ref: '#/components/schemas/Images' + x-stream-index: "001" + interest_tags: + description: Tags for user interests + items: + type: string + title: Interest Tags + type: array + x-stream-index: "025" + latest_reactions: + description: Recent reactions to the activity + items: + $ref: '#/components/schemas/FeedsReactionResponse' + title: Latest Reactions + type: array + x-stream-index: "031" + location: + $ref: '#/components/schemas/ActivityLocation' + description: Geographic location related to the activity + title: Location + x-stream-index: "017" + mentioned_users: + description: Users mentioned in the activity + items: + $ref: '#/components/schemas/UserResponse' + title: Mentioned Users + type: array + x-stream-index: "010" + moderation: + $ref: '#/components/schemas/ModerationV2Response' + description: Moderation information + title: Moderation + x-stream-index: "026" + notification_context: + additionalProperties: {} + description: Notification context data for the activity (if this is a reaction, + comment, follow, etc.) + title: Notification Context + type: object + x-stream-index: "012" + own_bookmarks: + description: Current user's bookmarks for this activity + items: + $ref: '#/components/schemas/BookmarkResponse' + title: Own Bookmarks + type: array + x-stream-index: "034" + own_reactions: + description: Current user's reactions to this activity + items: + $ref: '#/components/schemas/FeedsReactionResponse' + title: Own Reactions + type: array + x-stream-index: "033" + parent: + $ref: '#/components/schemas/ActivityResponse' + description: Parent activity (if this is a reply/comment) + title: Parent + x-stream-index: "018" + poll: + $ref: '#/components/schemas/PollResponseData' + description: Poll attached to this activity + title: Poll x-stream-index: "019" - image_url: - type: string - x-stream-index: "011" - og_scrape_url: - type: string - x-stream-index: "020" - original_height: + popularity: + description: Popularity score of the activity format: int32 + title: Popularity type: integer - x-stream-index: "022" - original_width: + x-stream-index: "013" + reaction_count: + description: Number of reactions to the activity format: int32 + title: Reaction Count type: integer - x-stream-index: "021" - pretext: - type: string - x-stream-index: "004" + x-stream-index: "030" + reaction_groups: + additionalProperties: + $ref: '#/components/schemas/ReactionGroupResponse' + description: Grouped reactions by type + title: Reaction Groups + type: object + x-stream-index: "032" + score: + description: Ranking score for this activity + format: float + title: Score + type: number + x-stream-index: "014" + search_data: + additionalProperties: {} + description: Data for search indexing + title: Search Data + type: object + x-stream-index: "023" + share_count: + description: Number of times the activity was shared + format: int32 + title: Share Count + type: integer + x-stream-index: "029" text: + description: Text content of the activity + title: Text type: string - x-stream-index: "010" - thumb_url: - type: string - x-stream-index: "012" - title: + x-stream-index: "016" + type: + description: Type of activity + title: Type type: string + x-stream-index: "002" + updated_at: + description: When the activity was last updated + format: date-time + title: Updated At + type: number x-stream-index: "008" - title_link: + user: + $ref: '#/components/schemas/UserResponse' + description: User who created the activity + title: User + x-stream-index: "003" + visibility: + description: Visibility setting for the activity + enum: + - public + - private + - tag + title: Visibility type: string - x-stream-index: "009" - type: - description: Attachment type (e.g. image, video, url) - title: Type + x-stream-index: "005" + visibility_tag: + description: If visibility is 'tag', this is the tag name + title: Visibility Tag type: string - x-stream-index: "001" + x-stream-index: "006" required: + - id + - type + - user + - feeds + - visibility + - created_at + - updated_at + - attachments + - mentioned_users - custom - title: Attachment + - popularity + - score + - comments + - search_data + - filter_tags + - interest_tags + - comment_count + - bookmark_count + - share_count + - reaction_count + - latest_reactions + - reaction_groups + - own_reactions + - own_bookmarks + title: Base Activity type: object - x-stream-docs-page-id: file_uploads - AudioSettings: + ActivitySelectorConfig: properties: - access_request_enabled: - type: boolean - x-stream-index: "001" - default_device: - enum: - - speaker - - earpiece - type: string - x-stream-index: "006" - mic_default_on: - type: boolean + cutoff_time: + description: Time threshold for activity selection + format: date-time + title: Cutoff Time + type: number x-stream-index: "004" - noise_cancellation: - $ref: '#/components/schemas/NoiseCancellationSettings' - x-stream-index: "007" - opus_dtx_enabled: - type: boolean + filter: + additionalProperties: {} + description: Filter for activity selection + title: Filter + type: object x-stream-index: "002" - redundant_coding_enabled: - type: boolean - x-stream-index: "003" - speaker_default_on: - type: boolean + min_popularity: + description: Minimum popularity threshold + format: int32 + title: Minimum Popularity + type: integer x-stream-index: "005" - required: - - access_request_enabled - - opus_dtx_enabled - - redundant_coding_enabled - - mic_default_on - - speaker_default_on - - default_device + sort: + description: Sort parameters for activity selection + items: + $ref: '#/components/schemas/SortParam' + title: Sort + type: array + x-stream-index: "003" + type: + description: Type of selector + title: Type + type: string + x-stream-index: "001" + title: Activity Selector Configuration type: object - AudioSettingsRequest: + ActivityUnpinnedEvent: + description: Emitted when an activity is unpinned. + nullable: true properties: - access_request_enabled: - type: boolean + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + feed_visibility: + type: string + x-stream-index: "002.003" + fid: + description: The ID of the feed + title: Feed ID + type: string + x-stream-index: "002.002" + pinned_activity: + $ref: '#/components/schemas/PinActivityResponse' x-stream-index: "001" - default_device: - enum: - - speaker - - earpiece + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 + type: + default: feeds.activity.unpinned + description: 'The type of event: "feeds.activity.unpinned" in this case' + title: Event Type type: string - x-stream-index: "006" - mic_default_on: - type: boolean - x-stream-index: "004" - noise_cancellation: - $ref: '#/components/schemas/NoiseCancellationSettings' - x-stream-index: "007" - opus_dtx_enabled: - type: boolean - x-stream-index: "002" - redundant_coding_enabled: - type: boolean - x-stream-index: "003" - speaker_default_on: - type: boolean - x-stream-index: "005" + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who unpinned the activity + title: User + x-stream-index: "003.001" required: - - default_device + - pinned_activity + - type + - created_at + - custom + - fid + title: ActivityUnpinnedEvent type: object - AudioSettingsResponse: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + ActivityUpdatedEvent: + description: Emitted when an activity is updated. + nullable: true properties: - access_request_enabled: - type: boolean + activity: + $ref: '#/components/schemas/ActivityResponse' + description: The activity that was updated + title: Activity x-stream-index: "001" - default_device: - enum: - - speaker - - earpiece + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + feed_visibility: type: string - x-stream-index: "006" - mic_default_on: - type: boolean - x-stream-index: "004" - noise_cancellation: - $ref: '#/components/schemas/NoiseCancellationSettings' - x-stream-index: "007" - opus_dtx_enabled: - type: boolean - x-stream-index: "002" - redundant_coding_enabled: - type: boolean - x-stream-index: "003" - speaker_default_on: - type: boolean - x-stream-index: "005" + x-stream-index: "002.003" + fid: + type: string + x-stream-index: "002.002" + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 + type: + default: feeds.activity.updated + description: The type of the event + title: Event Type + type: string + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who updated the activity + title: User + x-stream-index: "003.001" required: - - access_request_enabled - - opus_dtx_enabled - - redundant_coding_enabled - - mic_default_on - - speaker_default_on - - default_device + - activity + - type + - created_at + - custom + - fid + title: ActivityUpdatedEvent type: object - AutomodDetails: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + AddActivityRequest: + nullable: true properties: - action: + attachments: + description: List of attachments for the activity + items: + $ref: '#/components/schemas/Attachment' + title: Attachments + type: array + x-stream-index: "001.006" + custom: + additionalProperties: {} + description: Custom data for the activity + title: Custom Data + type: object + x-stream-index: "001.017" + expires_at: + description: Expiration time for the activity + title: Expires At type: string - x-stream-index: "001" - image_labels: + x-stream-index: "001.010" + feeds: + description: List of feed IDs to add the activity to items: type: string + maximum: 255 + minimum: 1 + title: Feed IDs type: array - x-stream-index: "005" - message_details: - $ref: '#/components/schemas/FlagMessageDetails' + x-stream-index: "001.004" + filter_tags: + description: Tags for filtering activities + items: + type: string + maximum: 255 + title: Filter Tags + type: array + x-stream-index: "001.013" + id: + description: Optional ID for the activity + maxLength: 255 + title: Activity ID + type: string + x-stream-index: "001.001" + interest_tags: + description: Tags for indicating user interests + items: + type: string + maximum: 255 + title: Interest Tags + type: array + x-stream-index: "001.014" + location: + $ref: '#/components/schemas/ActivityLocation' + description: Geographic location related to the activity + title: Location + x-stream-index: "001.009" + mentioned_user_ids: + description: List of users mentioned in the activity + items: + type: string + maximum: 255 + title: Mentioned User IDs + type: array + x-stream-index: "001.011" + parent_id: + description: ID of parent activity for replies/comments + maxLength: 255 + title: Parent ID + type: string + x-stream-index: "001.015" + poll_id: + description: ID of a poll to attach to activity + title: Poll ID + type: string + x-stream-index: "001.016" + search_data: + additionalProperties: {} + description: Additional data for search indexing + title: Search Data + type: object + x-stream-index: "001.012" + text: + description: Text content of the activity + title: Text + type: string + x-stream-index: "001.005" + type: + description: Type of activity + maxLength: 255 + title: Activity Type + type: string + x-stream-index: "001.002" + user_id: + description: ID of the user creating the activity + maxLength: 255 + title: User ID + type: string + x-stream-index: "001.003" + visibility: + description: Visibility setting for the activity + enum: + - public + - private + - tag + title: Visibility + type: string + x-stream-index: "001.007" + visibility_tag: + description: If visibility is 'tag', this is the tag name and is required + maxLength: 32 + title: Visibility Tag + type: string + x-stream-index: "001.008" + required: + - type + - feeds + title: Activity Request + type: object + AddActivityResponse: + nullable: true + properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + description: The created activity + title: Activity + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - activity + - duration + title: Add Activity Response + type: object + AddBookmarkRequest: + nullable: true + properties: + custom: + additionalProperties: {} + description: Custom data for the bookmark + title: Custom Data + type: object x-stream-index: "004" - original_message_type: + folder_id: + description: ID of the folder to add the bookmark to + maxLength: 255 + title: Folder ID type: string x-stream-index: "002" - result: - $ref: '#/components/schemas/MessageModerationResult' + new_folder: + $ref: '#/components/schemas/AddFolderRequest' + description: Create a new folder for this bookmark + title: New Folder x-stream-index: "003" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "005.002" + user_id: + type: string + x-stream-index: "005.001" + title: Add Bookmark Request type: object - AutomodPlatformCircumventionConfig: + AddBookmarkResponse: + nullable: true properties: - async: - type: boolean + bookmark: + $ref: '#/components/schemas/BookmarkResponse' + description: The created bookmark + title: Bookmark x-stream-index: "001" - enabled: - type: boolean - x-stream-index: "002" - rules: - items: - $ref: '#/components/schemas/AutomodRule' - type: array - x-stream-index: "003" + duration: + type: string + x-stream-index: "002.001" required: - - enabled - - rules + - bookmark + - duration + title: Add Bookmark Response type: object - AutomodRule: + AddCommentReactionRequest: + nullable: true properties: - action: - enum: - - flag - - shadow - - remove - - bounce - - bounce_flag - - bounce_remove - type: string + create_notification_activity: + description: Whether to create a notification activity for this reaction + title: boolean + type: boolean + x-stream-index: "004" + custom: + additionalProperties: {} + description: Optional custom data to add to the reaction + title: object + type: object x-stream-index: "003" - label: + skip_push: + type: boolean + x-stream-index: "005" + type: + description: The type of reaction, eg upvote, like, ... + maxLength: 255 + title: string type: string - x-stream-index: "001" - threshold: - format: float - maximum: 1 - minimum: 0 - type: number x-stream-index: "002" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "007.002" + user_id: + type: string + x-stream-index: "007.001" required: - - label - - threshold - - action + - type type: object - AutomodSemanticFiltersConfig: + AddCommentReactionResponse: + nullable: true properties: - async: - type: boolean + comment: + $ref: '#/components/schemas/CommentResponse' + description: The comment the reaction was added to + title: object x-stream-index: "001" - enabled: - type: boolean + duration: + description: Duration of the request + title: string + type: string + x-stream-index: "003.001" + reaction: + $ref: '#/components/schemas/FeedsReactionResponse' + description: The created or updated reaction + title: object x-stream-index: "002" - rules: - items: - $ref: '#/components/schemas/AutomodSemanticFiltersRule' - type: array - x-stream-index: "003" required: - - enabled - - rules + - comment + - reaction + - duration type: object - AutomodSemanticFiltersRule: + AddCommentRequest: + nullable: true properties: - action: - enum: - - flag - - shadow - - remove + attachments: + description: Media attachments for the reply + items: + $ref: '#/components/schemas/Attachment' + title: Attachments + type: array + x-stream-index: "004" + comment: + description: Text content of the comment + title: Comment type: string x-stream-index: "003" - name: + create_notification_activity: + description: Whether to create a notification activity for this comment + title: Create Notification Activity + type: boolean + x-stream-index: "008" + custom: + additionalProperties: {} + description: Custom data for the comment + title: Custom Data + type: object + x-stream-index: "007" + mentioned_user_ids: + description: List of users mentioned in the reply + items: + type: string + maximum: 255 + title: Mentioned User IDs + type: array + x-stream-index: "005" + object_id: + description: ID of the object to comment on + title: Object ID type: string x-stream-index: "001" - threshold: - format: float - maximum: 1 - minimum: 0 - type: number + object_type: + description: Type of the object to comment on + title: Object Type + type: string x-stream-index: "002" + parent_id: + description: ID of parent comment for replies + title: Parent ID + type: string + x-stream-index: "006" + skip_push: + type: boolean + x-stream-index: "009" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "010.002" + user_id: + type: string + x-stream-index: "010.001" required: - - name - - threshold - - action + - object_id + - object_type + - comment + title: Add Comment Request type: object - AutomodToxicityConfig: + AddCommentResponse: + nullable: true properties: - async: - type: boolean + comment: + $ref: '#/components/schemas/CommentResponse' + description: The created comment + title: Comment x-stream-index: "001" - enabled: - type: boolean - x-stream-index: "002" - rules: + duration: + type: string + x-stream-index: "002.001" + required: + - comment + - duration + title: Add Comment Response + type: object + AddCommentsBatchRequest: + nullable: true + properties: + comments: + description: List of comments to add items: - $ref: '#/components/schemas/AutomodRule' + $ref: '#/components/schemas/AddCommentRequest' + title: Comments type: array - x-stream-index: "003" + x-stream-index: "001" required: - - enabled - - rules + - comments + title: Add Comments Batch Request type: object - AzureRequest: - description: Config for creating Azure Blob Storage storage + AddCommentsBatchResponse: + nullable: true properties: - abs_account_name: - description: The account name - title: AccountName - type: string + comments: + description: List of comments added + items: + $ref: '#/components/schemas/CommentResponse' + title: Comments + type: array x-stream-index: "001" - abs_client_id: - description: The client id - title: ClientID + duration: type: string - x-stream-index: "003" - abs_client_secret: - description: The client secret - title: ClientSecret + x-stream-index: "002.001" + required: + - comments + - duration + title: Add Comments Batch Response + type: object + AddFolderRequest: + properties: + custom: + additionalProperties: {} + description: Custom data for the folder + title: Custom Data + type: object + x-stream-index: "002" + name: + description: Name of the folder + maxLength: 255 + title: Name type: string + x-stream-index: "001" + required: + - name + title: Add Folder Request + type: object + AddReactionRequest: + nullable: true + properties: + create_notification_activity: + description: Whether to create a notification activity for this reaction + title: Create Notification Activity + type: boolean x-stream-index: "004" - abs_tenant_id: - description: The tenant id - title: TenantID + custom: + additionalProperties: {} + description: Custom data for the reaction + title: Custom Data + type: object + x-stream-index: "003" + skip_push: + type: boolean + x-stream-index: "005" + type: + description: Type of reaction + maxLength: 255 + title: Reaction Type type: string x-stream-index: "002" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "006.002" + user_id: + type: string + x-stream-index: "006.001" required: - - abs_account_name - - abs_tenant_id - - abs_client_id - - abs_client_secret - title: AzureRequest + - type + title: Add Reaction Request type: object - BackstageSettings: + AddReactionResponse: + nullable: true properties: - enabled: - type: boolean + activity: + $ref: '#/components/schemas/ActivityResponse' x-stream-index: "001" - join_ahead_time_seconds: - format: int32 - type: integer + duration: + type: string + x-stream-index: "003.001" + reaction: + $ref: '#/components/schemas/FeedsReactionResponse' + description: The created reaction + title: Reaction x-stream-index: "002" required: - - enabled + - activity + - reaction + - duration + title: Add Reaction Response type: object - BackstageSettingsRequest: + AggregatedActivityResponse: properties: - enabled: - type: boolean + activities: + description: List of activities in this aggregation + items: + $ref: '#/components/schemas/ActivityResponse' + title: Activities + type: array x-stream-index: "001" - join_ahead_time_seconds: + activity_count: + description: Number of activities in this aggregation format: int32 + title: Activity Count type: integer x-stream-index: "002" - type: object - BackstageSettingsResponse: - properties: - enabled: - type: boolean - x-stream-index: "001" - join_ahead_time_seconds: + created_at: + description: When the aggregation was created + format: date-time + title: Created At + type: number + x-stream-index: "006" + group: + description: Grouping identifier + title: Group + type: string + x-stream-index: "004" + score: + description: Ranking score for this aggregation + format: float + title: Score + type: number + x-stream-index: "005" + updated_at: + description: When the aggregation was last updated + format: date-time + title: Updated At + type: number + x-stream-index: "007" + user_count: + description: Number of unique users in this aggregation format: int32 + title: User Count type: integer - x-stream-index: "002" + x-stream-index: "003" required: - - enabled + - activities + - activity_count + - user_count + - group + - score + - created_at + - updated_at + title: Aggregated Activity type: object - Ban: - nullable: true + AggregationConfig: + properties: + format: + description: Format for activity aggregation + title: Format + type: string + x-stream-index: "001" + title: Aggregation Configuration + type: object + AnyEvent: properties: - channel: - $ref: '#/components/schemas/Channel' - x-stream-index: "004" created_at: format: date-time type: number - x-stream-index: "012" - created_by: - $ref: '#/components/schemas/User' - x-stream-index: "011" - expires: - format: date-time - type: number - x-stream-index: "007" - reason: + x-stream-index: "001.002" + type: + default: '*' type: string - x-stream-index: "008" - shadow: - type: boolean - x-stream-index: "009" - target: - $ref: '#/components/schemas/User' - x-stream-index: "006" + x-stream-index: "001.001" required: - - shadow + - type - created_at + title: AnyEvent type: object - BanActionRequest: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + AppResponseFields: properties: - channel_ban_only: + allowed_flag_reasons: + items: + type: string + type: array + x-stream-index: "019" + async_url_enrich_enabled: type: boolean - x-stream-index: "003" - delete_messages: - enum: - - soft - - pruning - - hard - type: string - x-stream-index: "005" - ip_ban: + x-stream-index: "017" + auto_translation_enabled: type: boolean - x-stream-index: "004" - reason: + x-stream-index: "020" + before_message_send_hook_url: type: string - x-stream-index: "002" - shadow: + x-stream-index: "021" + call_types: + additionalProperties: + $ref: '#/components/schemas/CallType' + type: object + x-stream-index: "007" + campaign_enabled: type: boolean - x-stream-index: "001" - timeout: + x-stream-index: "034" + cdn_expiration_seconds: format: int32 type: integer + x-stream-index: "037" + channel_configs: + additionalProperties: + $ref: '#/components/schemas/ChannelConfig' + type: object x-stream-index: "006" - type: object - BanOptions: - properties: - duration: - format: int32 - type: integer - x-stream-index: "001" - ip_ban: - type: boolean - x-stream-index: "004" - reason: + custom_action_handler_url: type: string - x-stream-index: "002" - shadow_ban: + x-stream-index: "022" + datadog_info: + $ref: '#/components/schemas/DataDogInfo' + x-stream-index: "040" + disable_auth_checks: type: boolean - x-stream-index: "003" - required: - - duration - - reason - - shadow_ban - - ip_ban - type: object - BanRequest: - nullable: true - properties: - banned_by: - $ref: '#/components/schemas/UserRequest' - description: Details about the user performing the ban - title: Banned By - x-stream-index: "008" - banned_by_id: - description: ID of the user performing the ban - title: Banned By ID - type: string - x-stream-index: "007" - channel_cid: - description: Channel where the ban applies - title: Channel CID - type: string - x-stream-index: "004" - delete_messages: - enum: - - soft - - pruning - - hard - type: string - x-stream-index: "009" - ip_ban: - description: Whether to ban the user's IP address - title: IP Ban + x-stream-index: "011" + disable_permissions_checks: type: boolean - x-stream-index: "006" - reason: - description: Optional explanation for the ban - title: Reason + x-stream-index: "012" + enforce_unique_usernames: type: string - x-stream-index: "003" - shadow: - description: Whether this is a shadow ban - title: Shadow + x-stream-index: "023" + event_hooks: + items: + $ref: '#/components/schemas/EventHook' + type: array + x-stream-index: "045" + file_upload_config: + $ref: '#/components/schemas/FileUploadConfig' + x-stream-index: "030" + geofences: + items: + $ref: '#/components/schemas/GeofenceResponse' + type: array + x-stream-index: "039" + grants: + additionalProperties: + items: + type: string + type: array + type: object + x-stream-index: "033" + guest_user_creation_disabled: + type: boolean + x-stream-index: "043" + image_moderation_enabled: + type: boolean + x-stream-index: "016" + image_moderation_labels: + items: + type: string + type: array + x-stream-index: "018" + image_upload_config: + $ref: '#/components/schemas/FileUploadConfig' + x-stream-index: "031" + moderation_bulk_submit_action_enabled: + type: boolean + x-stream-index: "048" + moderation_dashboard_preferences: + $ref: '#/components/schemas/ModerationDashboardPreferences' + x-stream-index: "044" + moderation_enabled: + type: boolean + x-stream-index: "041" + moderation_llm_configurability_enabled: + type: boolean + x-stream-index: "049" + moderation_multitenant_blocklist_enabled: type: boolean + x-stream-index: "042" + moderation_webhook_url: + type: string x-stream-index: "005" - target_user_id: - description: ID of the user to ban - title: Target User ID + multi_tenant_enabled: + type: boolean + x-stream-index: "015" + name: type: string x-stream-index: "001" - timeout: - description: Duration of the ban in minutes - minimum: 0 - title: Timeout - type: integer + organization: + type: string x-stream-index: "002" - required: - - target_user_id - type: object - BanResponse: - nullable: true - properties: - banned_by: - $ref: '#/components/schemas/UserResponse' - x-stream-index: "006" - channel: - $ref: '#/components/schemas/ChannelResponse' - x-stream-index: "001" - created_at: - format: date-time - type: number - x-stream-index: "007" - expires: + permission_version: + type: string + x-stream-index: "013" + policies: + additionalProperties: + items: + $ref: '#/components/schemas/Policy' + type: array + type: object + x-stream-index: "008" + push_notifications: + $ref: '#/components/schemas/PushNotificationFields' + x-stream-index: "003" + reminders_interval: + format: int32 + type: integer + x-stream-index: "036" + revoke_tokens_issued_before: format: date-time type: number - x-stream-index: "003" - reason: + x-stream-index: "032" + sns_key: type: string - x-stream-index: "004" - shadow: + x-stream-index: "028" + sns_secret: + type: string + x-stream-index: "029" + sns_topic_arn: + type: string + x-stream-index: "027" + sqs_key: + type: string + x-stream-index: "025" + sqs_secret: + type: string + x-stream-index: "026" + sqs_url: + type: string + x-stream-index: "024" + suspended: type: boolean - x-stream-index: "005" - user: - $ref: '#/components/schemas/UserResponse' - x-stream-index: "002" - required: - - created_at - type: object - BlockContentOptions: - properties: - reason: + x-stream-index: "009" + suspended_explanation: type: string - x-stream-index: "001" - required: - - reason - type: object - BlockListConfig: - properties: - async: + x-stream-index: "010" + use_hook_v2: type: boolean - x-stream-index: "001" - enabled: + x-stream-index: "046" + user_response_time_enabled: type: boolean - x-stream-index: "002" - rules: + x-stream-index: "047" + user_search_disallowed_roles: items: - $ref: '#/components/schemas/BlockListRule' - maximum: 10 + type: string type: array - x-stream-index: "003" - required: - - enabled - - rules - type: object - BlockListOptions: - properties: - behavior: - description: Blocklist behavior - enum: - - flag - - block - - shadow_block - title: Behavior - type: string - x-stream-index: "002" - blocklist: - description: Blocklist name - title: Blocklist + x-stream-index: "014" + webhook_events: + items: + type: string + type: array + x-stream-index: "035" + webhook_url: type: string - x-stream-index: "001" + x-stream-index: "004" required: - - blocklist - - behavior + - name + - organization + - push_notifications + - webhook_url + - moderation_webhook_url + - channel_configs + - call_types + - policies + - suspended + - suspended_explanation + - disable_auth_checks + - disable_permissions_checks + - permission_version + - user_search_disallowed_roles + - multi_tenant_enabled + - image_moderation_enabled + - async_url_enrich_enabled + - auto_translation_enabled + - custom_action_handler_url + - enforce_unique_usernames + - sqs_url + - sqs_key + - sqs_secret + - sns_topic_arn + - sns_key + - sns_secret + - file_upload_config + - image_upload_config + - grants + - campaign_enabled + - webhook_events + - reminders_interval + - cdn_expiration_seconds + - video_provider + - moderation_enabled + - moderation_multitenant_blocklist_enabled + - guest_user_creation_disabled + - event_hooks + - use_hook_v2 + - user_response_time_enabled + - moderation_bulk_submit_action_enabled + - moderation_llm_configurability_enabled type: object - BlockListResponse: - description: Block list contains restricted words + AsyncBulkImageModerationEvent: + nullable: true properties: created_at: - description: Date/time of creation format: date-time - title: Created at type: number - x-stream-index: "001" - id: - type: string - x-stream-index: "003" - name: - description: Block list name - title: Name - type: string - x-stream-index: "004" - team: - type: string - x-stream-index: "007" - type: - description: Block list type. - title: Type - type: string - x-stream-index: "005" - updated_at: - description: Date/time of the last update + x-stream-index: "003.003" + custom: + additionalProperties: {} + type: object + x-stream-index: "003.007" + finished_at: format: date-time - title: Updated at type: number - x-stream-index: "002" - words: - description: List of words to block - items: - type: string - title: Words - type: array - x-stream-index: "006" - required: - - name - - type - - words - title: Block list - type: object - x-stream-docs-page-id: block_lists - BlockListRule: - properties: - action: - enum: - - flag - - mask_flag - - shadow - - remove - - bounce - - bounce_flag - - bounce_remove + x-stream-index: "002.003" + received_at: + format: date-time + type: number + x-stream-index: "003.004" + started_at: + format: date-time + type: number + x-stream-index: "002.002" + task_id: type: string - x-stream-index: "003" - name: + x-stream-index: "002.001" + type: + default: export.bulk_image_moderation.success type: string - x-stream-index: "001" - team: + x-stream-index: "003.002" + url: type: string - x-stream-index: "002" + x-stream-index: "001" required: - - name - - team - - action + - url + - task_id + - started_at + - finished_at + - type + - created_at + - custom + title: AsyncBulkImageModerationEvent type: object - BlockUserRequest: - description: BlockUserRequest is the payload for blocking a user. + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + AsyncExportChannelsEvent: nullable: true properties: - user_id: - description: the user to block - title: UserID + created_at: + format: date-time + type: number + x-stream-index: "003.003" + custom: + additionalProperties: {} + type: object + x-stream-index: "003.007" + finished_at: + format: date-time + type: number + x-stream-index: "002.003" + received_at: + format: date-time + type: number + x-stream-index: "003.004" + started_at: + format: date-time + type: number + x-stream-index: "002.002" + task_id: type: string - x-stream-index: "003" - required: - - user_id - title: BlockUserRequest - type: object - BlockUserResponse: - description: BlockUserResponse is the payload for blocking a user. - nullable: true - properties: - duration: - description: Duration of the request in milliseconds - title: Duration + x-stream-index: "002.001" + type: + default: export.channels.success type: string - x-stream-index: "001.001" + x-stream-index: "003.002" + url: + type: string + x-stream-index: "001" required: - - duration - title: BlockUserResponse + - url + - task_id + - started_at + - finished_at + - type + - created_at + - custom + title: AsyncExportChannelsEvent type: object - BlockUsersRequest: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + AsyncExportErrorEvent: nullable: true properties: - blocked_user_id: - description: User id to block - title: BlockedUserID + created_at: + format: date-time + type: number + x-stream-index: "003.003" + custom: + additionalProperties: {} + type: object + x-stream-index: "003.007" + error: type: string x-stream-index: "001" - user: - $ref: '#/components/schemas/UserRequest' - x-stream-index: "003.002" - user_id: + finished_at: + format: date-time + type: number + x-stream-index: "002.003" + received_at: + format: date-time + type: number + x-stream-index: "003.004" + started_at: + format: date-time + type: number + x-stream-index: "002.002" + task_id: type: string - x-stream-index: "003.001" + x-stream-index: "002.001" + type: + default: export.users.error + type: string + x-stream-index: "003.002" required: - - blocked_user_id + - error + - task_id + - started_at + - finished_at + - type + - created_at + - custom + title: AsyncExportErrorEvent type: object - BlockUsersResponse: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + AsyncExportModerationLogsEvent: nullable: true properties: - blocked_by_user_id: - description: User id who blocked another user - title: BlockedByUserID - type: string - x-stream-index: "002" - blocked_user_id: - description: User id who got blocked - title: BlockedUserID - type: string - x-stream-index: "003" created_at: - description: Timestamp when the user was blocked format: date-time - title: CreatedAt type: number - x-stream-index: "004" - duration: - description: Duration of the request in milliseconds - title: Duration + x-stream-index: "003.003" + custom: + additionalProperties: {} + type: object + x-stream-index: "003.007" + finished_at: + format: date-time + type: number + x-stream-index: "002.003" + received_at: + format: date-time + type: number + x-stream-index: "003.004" + started_at: + format: date-time + type: number + x-stream-index: "002.002" + task_id: type: string - x-stream-index: "001.001" + x-stream-index: "002.001" + type: + default: export.moderation_logs.success + type: string + x-stream-index: "003.002" + url: + type: string + x-stream-index: "001" required: - - duration - - blocked_by_user_id - - blocked_user_id + - url + - task_id + - started_at + - finished_at + - type - created_at + - custom + title: AsyncExportModerationLogsEvent type: object - BlockedUserEvent: - description: |- - This event is sent to call participants to notify when a user is blocked on a call, clients can use this event to show a notification. - If the user is the current user, the client should leave the call screen as well + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + AsyncExportUsersEvent: + nullable: true properties: - blocked_by_user: - $ref: '#/components/schemas/UserResponse' - description: The user that blocked the user, null if the user was blocked - by server-side - title: Blocked by - x-stream-index: "004" - call_cid: - type: string - x-stream-index: "002.001" created_at: format: date-time type: number - x-stream-index: "001.002" + x-stream-index: "003.003" + custom: + additionalProperties: {} + type: object + x-stream-index: "003.007" + finished_at: + format: date-time + type: number + x-stream-index: "002.003" + received_at: + format: date-time + type: number + x-stream-index: "003.004" + started_at: + format: date-time + type: number + x-stream-index: "002.002" + task_id: + type: string + x-stream-index: "002.001" type: - default: call.blocked_user - description: 'The type of event: "call.blocked_user" in this case' - title: Event Type + default: export.users.success type: string - x-stream-index: "001.001" - user: - $ref: '#/components/schemas/UserResponse' - description: The user that was blocked - title: User - x-stream-index: "003" + x-stream-index: "003.002" + url: + type: string + x-stream-index: "001" required: + - url + - task_id + - started_at + - finished_at - type - created_at - - call_cid - - user - title: BlockedUserEvent + - custom + title: AsyncExportUsersEvent type: object - x-stream-event-call-type: true - x-stream-event-doc-group: call + x-stream-event-client-type: true + x-stream-event-doc-group: other x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - BlockedUserResponse: + AsyncModerationCallbackConfig: + properties: + mode: + enum: + - CALLBACK_MODE_NONE + - CALLBACK_MODE_REST + - CALLBACK_MODE_TWIRP + type: string + x-stream-index: "002" + server_url: + type: string + x-stream-index: "001" + type: object + AsyncModerationConfiguration: + properties: + callback: + $ref: '#/components/schemas/AsyncModerationCallbackConfig' + x-stream-index: "002" + timeout_ms: + format: int32 + type: integer + x-stream-index: "001" + type: object + Attachment: + description: An attachment is a message object that represents a file uploaded + by a user. nullable: true properties: - blocked_user: - $ref: '#/components/schemas/UserResponse' - description: User who got blocked - title: User + actions: + items: + $ref: '#/components/schemas/Action' + type: array + x-stream-index: "015" + asset_url: + type: string + x-stream-index: "017" + author_icon: + type: string + x-stream-index: "007" + author_link: + type: string + x-stream-index: "006" + author_name: + type: string + x-stream-index: "005" + color: + type: string x-stream-index: "003" - blocked_user_id: - description: ID of the user who got blocked - title: UserID + custom: + additionalProperties: {} + type: object + x-stream-index: "018" + fallback: + type: string + x-stream-index: "002" + fields: + items: + $ref: '#/components/schemas/Field' + type: array + x-stream-index: "016" + footer: + type: string + x-stream-index: "013" + footer_icon: + type: string + x-stream-index: "014" + giphy: + $ref: '#/components/schemas/Images' + x-stream-index: "019" + image_url: + type: string + x-stream-index: "011" + og_scrape_url: + type: string + x-stream-index: "020" + original_height: + format: int32 + type: integer + x-stream-index: "022" + original_width: + format: int32 + type: integer + x-stream-index: "021" + pretext: type: string x-stream-index: "004" - created_at: - format: date-time - type: number + text: + type: string + x-stream-index: "010" + thumb_url: + type: string + x-stream-index: "012" + title: + type: string + x-stream-index: "008" + title_link: + type: string + x-stream-index: "009" + type: + description: Attachment type (e.g. image, video, url) + title: Type + type: string + x-stream-index: "001" + required: + - custom + title: Attachment + type: object + x-stream-docs-page-id: file_uploads + AudioSettings: + properties: + access_request_enabled: + type: boolean + x-stream-index: "001" + default_device: + enum: + - speaker + - earpiece + type: string + x-stream-index: "006" + mic_default_on: + type: boolean + x-stream-index: "004" + noise_cancellation: + $ref: '#/components/schemas/NoiseCancellationSettings' + x-stream-index: "007" + opus_dtx_enabled: + type: boolean + x-stream-index: "002" + redundant_coding_enabled: + type: boolean + x-stream-index: "003" + speaker_default_on: + type: boolean x-stream-index: "005" - user: - $ref: '#/components/schemas/UserResponse' - description: User who blocked another user - title: User + required: + - access_request_enabled + - opus_dtx_enabled + - redundant_coding_enabled + - mic_default_on + - speaker_default_on + - default_device + type: object + AudioSettingsRequest: + properties: + access_request_enabled: + type: boolean x-stream-index: "001" - user_id: - description: ID of the user who blocked another user - title: UserID + default_device: + enum: + - speaker + - earpiece type: string + x-stream-index: "006" + mic_default_on: + type: boolean + x-stream-index: "004" + noise_cancellation: + $ref: '#/components/schemas/NoiseCancellationSettings' + x-stream-index: "007" + opus_dtx_enabled: + type: boolean x-stream-index: "002" + redundant_coding_enabled: + type: boolean + x-stream-index: "003" + speaker_default_on: + type: boolean + x-stream-index: "005" required: - - user - - user_id - - blocked_user - - blocked_user_id - - created_at + - default_device type: object - BodyguardRule: + AudioSettingsResponse: properties: - action: + access_request_enabled: + type: boolean + x-stream-index: "001" + default_device: enum: - - flag - - shadow - - remove - - bounce - - bounce_flag - - bounce_remove + - speaker + - earpiece type: string + x-stream-index: "006" + mic_default_on: + type: boolean + x-stream-index: "004" + noise_cancellation: + $ref: '#/components/schemas/NoiseCancellationSettings' + x-stream-index: "007" + opus_dtx_enabled: + type: boolean x-stream-index: "002" - label: + redundant_coding_enabled: + type: boolean + x-stream-index: "003" + speaker_default_on: + type: boolean + x-stream-index: "005" + required: + - access_request_enabled + - opus_dtx_enabled + - redundant_coding_enabled + - mic_default_on + - speaker_default_on + - default_device + type: object + AutomodDetails: + properties: + action: type: string x-stream-index: "001" - severity_rules: + image_labels: items: - $ref: '#/components/schemas/BodyguardSeverityRule' + type: string + type: array + x-stream-index: "005" + message_details: + $ref: '#/components/schemas/FlagMessageDetails' + x-stream-index: "004" + original_message_type: + type: string + x-stream-index: "002" + result: + $ref: '#/components/schemas/MessageModerationResult' + x-stream-index: "003" + type: object + AutomodPlatformCircumventionConfig: + properties: + async: + type: boolean + x-stream-index: "001" + enabled: + type: boolean + x-stream-index: "002" + rules: + items: + $ref: '#/components/schemas/AutomodRule' type: array x-stream-index: "003" required: - - label - - action - - severity_rules + - enabled + - rules type: object - BodyguardSeverityRule: + AutomodRule: properties: action: enum: @@ -1856,280 +2921,494 @@ components: - bounce_flag - bounce_remove type: string - x-stream-index: "002" - severity: - enum: - - low - - medium - - high - - critical + x-stream-index: "003" + label: type: string x-stream-index: "001" + threshold: + format: float + maximum: 1 + minimum: 0 + type: number + x-stream-index: "002" required: - - severity + - label + - threshold - action type: object - Bound: + AutomodSemanticFiltersConfig: properties: - inclusive: + async: type: boolean - x-stream-index: "002" - value: - format: float - type: number x-stream-index: "001" - required: - - value - - inclusive - type: object - BroadcastSettings: - properties: enabled: type: boolean - x-stream-index: "001" - hls: - $ref: '#/components/schemas/HLSSettings' x-stream-index: "002" - rtmp: - $ref: '#/components/schemas/RTMPSettings' + rules: + items: + $ref: '#/components/schemas/AutomodSemanticFiltersRule' + type: array x-stream-index: "003" required: - enabled + - rules type: object - BroadcastSettingsRequest: + AutomodSemanticFiltersRule: properties: - enabled: - type: boolean + action: + enum: + - flag + - shadow + - remove + type: string + x-stream-index: "003" + name: + type: string x-stream-index: "001" - hls: - $ref: '#/components/schemas/HLSSettingsRequest' + threshold: + format: float + maximum: 1 + minimum: 0 + type: number x-stream-index: "002" - rtmp: - $ref: '#/components/schemas/RTMPSettingsRequest' - x-stream-index: "003" + required: + - name + - threshold + - action type: object - BroadcastSettingsResponse: - description: BroadcastSettingsResponse is the payload for broadcasting settings + AutomodToxicityConfig: properties: - enabled: - title: Enabled + async: type: boolean x-stream-index: "001" - hls: - $ref: '#/components/schemas/HLSSettingsResponse' - title: HLS + enabled: + type: boolean x-stream-index: "002" - rtmp: - $ref: '#/components/schemas/RTMPSettingsResponse' - title: RTMP + rules: + items: + $ref: '#/components/schemas/AutomodRule' + type: array x-stream-index: "003" required: - enabled - - hls - - rtmp - title: BroadcastSettingsResponse + - rules type: object - BrowserDataResponse: + AzureRequest: + description: Config for creating Azure Blob Storage storage properties: - name: + abs_account_name: + description: The account name + title: AccountName type: string x-stream-index: "001" - version: - type: string - x-stream-index: "002" - type: object - BulkImageModerationRequest: - nullable: true - properties: - csv_file: - description: URL to CSV file containing image URLs to moderate - title: string + abs_client_id: + description: The client id + title: ClientID type: string - x-stream-index: "001" - required: - - csv_file - type: object - BulkImageModerationResponse: - nullable: true - properties: - duration: + x-stream-index: "003" + abs_client_secret: + description: The client secret + title: ClientSecret type: string - x-stream-index: "002.001" - task_id: - description: ID of the task for processing the bulk image moderation - title: string + x-stream-index: "004" + abs_tenant_id: + description: The tenant id + title: TenantID type: string - x-stream-index: "001" + x-stream-index: "002" required: - - task_id - - duration + - abs_account_name + - abs_tenant_id + - abs_client_id + - abs_client_secret + title: AzureRequest type: object - Call: + BackstageSettings: properties: - AppPK: + enabled: + type: boolean + x-stream-index: "001" + join_ahead_time_seconds: format: int32 type: integer - writeOnly: true x-stream-index: "002" - Backstage: + required: + - enabled + type: object + BackstageSettingsRequest: + properties: + enabled: type: boolean - writeOnly: true - x-stream-index: "023" - BlockedUserIDs: - items: - type: string - type: array - writeOnly: true - x-stream-index: "018" - BlockedUsers: - items: - $ref: '#/components/schemas/User' - type: array - writeOnly: true - x-stream-index: "019" - CID: - type: string - writeOnly: true - x-stream-index: "005" - CallType: - $ref: '#/components/schemas/CallType' - x-stream-index: "020" - ChannelCID: - type: string - writeOnly: true - x-stream-index: "032" - CreatedAt: + x-stream-index: "001" + join_ahead_time_seconds: + format: int32 + type: integer + x-stream-index: "002" + type: object + BackstageSettingsResponse: + properties: + enabled: + type: boolean + x-stream-index: "001" + join_ahead_time_seconds: + format: int32 + type: integer + x-stream-index: "002" + required: + - enabled + type: object + Ban: + nullable: true + properties: + channel: + $ref: '#/components/schemas/Channel' + x-stream-index: "004" + created_at: format: date-time type: number - writeOnly: true - x-stream-index: "013" - CreatedBy: + x-stream-index: "012" + created_by: $ref: '#/components/schemas/User' + x-stream-index: "011" + expires: + format: date-time + type: number + x-stream-index: "007" + reason: + type: string x-stream-index: "008" - CreatedByUserID: + shadow: + type: boolean + x-stream-index: "009" + target: + $ref: '#/components/schemas/User' + x-stream-index: "006" + required: + - shadow + - created_at + type: object + BanActionRequest: + properties: + channel_ban_only: + type: boolean + x-stream-index: "003" + delete_messages: + enum: + - soft + - pruning + - hard + type: string + x-stream-index: "005" + ip_ban: + type: boolean + x-stream-index: "004" + reason: + type: string + x-stream-index: "002" + shadow: + type: boolean + x-stream-index: "001" + timeout: + format: int32 + type: integer + x-stream-index: "006" + type: object + BanOptions: + properties: + duration: + format: int32 + type: integer + x-stream-index: "001" + ip_ban: + type: boolean + x-stream-index: "004" + reason: + type: string + x-stream-index: "002" + shadow_ban: + type: boolean + x-stream-index: "003" + type: object + BanRequest: + nullable: true + properties: + banned_by: + $ref: '#/components/schemas/UserRequest' + description: Details about the user performing the ban + title: Banned By + x-stream-index: "008" + banned_by_id: + description: ID of the user performing the ban + title: Banned By ID type: string - writeOnly: true x-stream-index: "007" - CurrentSessionID: + channel_cid: + description: Channel where the ban applies + title: Channel CID type: string - writeOnly: true - x-stream-index: "024" - Custom: - additionalProperties: {} - type: object - writeOnly: true - x-stream-index: "012" - DeletedAt: + x-stream-index: "004" + delete_messages: + enum: + - soft + - pruning + - hard + type: string + x-stream-index: "009" + ip_ban: + description: Whether to ban the user's IP address + title: IP Ban + type: boolean + x-stream-index: "006" + reason: + description: Optional explanation for the ban + title: Reason + type: string + x-stream-index: "003" + shadow: + description: Whether this is a shadow ban + title: Shadow + type: boolean + x-stream-index: "005" + target_user_id: + description: ID of the user to ban + title: Target User ID + type: string + x-stream-index: "001" + timeout: + description: Duration of the ban in minutes + minimum: 0 + title: Timeout + type: integer + x-stream-index: "002" + required: + - target_user_id + type: object + BanResponse: + nullable: true + properties: + banned_by: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "006" + channel: + $ref: '#/components/schemas/ChannelResponse' + x-stream-index: "001" + created_at: format: date-time type: number - writeOnly: true - x-stream-index: "028" - EgressUpdatedAt: + x-stream-index: "007" + expires: format: date-time type: number - writeOnly: true - x-stream-index: "027" - Egresses: + x-stream-index: "003" + reason: + type: string + x-stream-index: "004" + shadow: + type: boolean + x-stream-index: "005" + user: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "002" + required: + - created_at + type: object + BlockContentOptions: + properties: + reason: + type: string + x-stream-index: "001" + type: object + BlockListConfig: + properties: + async: + type: boolean + x-stream-index: "001" + enabled: + type: boolean + x-stream-index: "002" + rules: items: - $ref: '#/components/schemas/CallEgress' + $ref: '#/components/schemas/BlockListRule' + maximum: 10 type: array - writeOnly: true - x-stream-index: "015" - EndedAt: + x-stream-index: "003" + required: + - enabled + - rules + type: object + BlockListOptions: + properties: + behavior: + description: Blocklist behavior + enum: + - flag + - block + - shadow_block + title: Behavior + type: string + x-stream-index: "002" + blocklist: + description: Blocklist name + title: Blocklist + type: string + x-stream-index: "001" + required: + - blocklist + - behavior + type: object + BlockListResponse: + description: Block list contains restricted words + properties: + created_at: + description: Date/time of creation format: date-time + title: Created at type: number - writeOnly: true - x-stream-index: "017" - ID: + x-stream-index: "001" + id: + type: string + x-stream-index: "003" + name: + description: Block list name + title: Name type: string - writeOnly: true x-stream-index: "004" - JoinAheadTimeSeconds: - format: int32 - type: integer - writeOnly: true - x-stream-index: "031" - LastHeartbeatAt: + team: + type: string + x-stream-index: "007" + type: + description: Block list type. + title: Type + type: string + x-stream-index: "005" + updated_at: + description: Date/time of the last update format: date-time + title: Updated at type: number - writeOnly: true - x-stream-index: "030" - LastSessionID: - type: string - writeOnly: true - x-stream-index: "025" - MemberCount: - format: int32 - type: integer - writeOnly: true - x-stream-index: "010" - MemberLookup: - $ref: '#/components/schemas/MemberLookup' - x-stream-index: "011" - Members: + x-stream-index: "002" + words: + description: List of words to block items: - $ref: '#/components/schemas/CallMember' + type: string + title: Words type: array - writeOnly: true - x-stream-index: "009" - Session: - $ref: '#/components/schemas/CallSession' - x-stream-index: "026" - Settings: - $ref: '#/components/schemas/CallSettings' - x-stream-index: "022" - SettingsOverrides: - $ref: '#/components/schemas/CallSettings' - x-stream-index: "021" - StartsAt: - format: date-time - type: number - writeOnly: true - x-stream-index: "016" - Team: - type: string - writeOnly: true x-stream-index: "006" - ThumbnailURL: + required: + - name + - type + - words + title: Block list + type: object + x-stream-docs-page-id: block_lists + BlockListRule: + properties: + action: + enum: + - flag + - mask_flag + - shadow + - remove + - bounce + - bounce_flag + - bounce_remove type: string - writeOnly: true - x-stream-index: "029" - Type: + x-stream-index: "003" + name: + type: string + x-stream-index: "001" + team: + type: string + x-stream-index: "002" + required: + - name + - team + - action + type: object + BlockUserRequest: + description: BlockUserRequest is the payload for blocking a user. + nullable: true + properties: + user_id: + description: the user to block + title: UserID type: string - writeOnly: true x-stream-index: "003" - UpdatedAt: + required: + - user_id + title: BlockUserRequest + type: object + BlockUserResponse: + description: BlockUserResponse is the payload for blocking a user. + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "001.001" + required: + - duration + title: BlockUserResponse + type: object + BlockUsersRequest: + nullable: true + properties: + blocked_user_id: + description: User id to block + title: BlockedUserID + type: string + x-stream-index: "001" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "003.002" + user_id: + type: string + x-stream-index: "003.001" + required: + - blocked_user_id + type: object + BlockUsersResponse: + nullable: true + properties: + blocked_by_user_id: + description: User id who blocked another user + title: BlockedByUserID + type: string + x-stream-index: "002" + blocked_user_id: + description: User id who got blocked + title: BlockedUserID + type: string + x-stream-index: "003" + created_at: + description: Timestamp when the user was blocked format: date-time + title: CreatedAt type: number - writeOnly: true - x-stream-index: "014" + x-stream-index: "004" + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "001.001" required: - - AppPK - - Type - - ID - - CID - - Team - - CreatedByUserID - - Members - - Custom - - CreatedAt - - UpdatedAt - - Egresses - - BlockedUserIDs - - BlockedUsers - - Backstage - - CurrentSessionID - - LastSessionID - - ThumbnailURL - - ChannelCID + - duration + - blocked_by_user_id + - blocked_user_id + - created_at type: object - CallAcceptedEvent: - description: This event is sent when a user accepts a notification to join a - call. + BlockedUserEvent: + description: |- + This event is sent to call participants to notify when a user is blocked on a call, clients can use this event to show a notification. + If the user is the current user, the client should leave the call screen as well properties: - call: - $ref: '#/components/schemas/CallResponse' - x-stream-index: "003" + blocked_by_user: + $ref: '#/components/schemas/UserResponse' + description: The user that blocked the user, null if the user was blocked + by server-side + title: Blocked by + x-stream-index: "004" call_cid: type: string x-stream-index: "002.001" @@ -2138,524 +3417,669 @@ components: type: number x-stream-index: "001.002" type: - default: call.accepted - description: 'The type of event: "call.accepted" in this case' + default: call.blocked_user + description: 'The type of event: "call.blocked_user" in this case' title: Event Type type: string x-stream-index: "001.001" user: $ref: '#/components/schemas/UserResponse' - description: The user who accepted the call + description: The user that was blocked title: User - x-stream-index: "004" + x-stream-index: "003" required: - type - created_at - call_cid - - call - user - title: CallAcceptedEvent + title: BlockedUserEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: ring + x-stream-event-doc-group: call x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallClosedCaption: - description: CallClosedCaption represents a closed caption of a call. + BlockedUserResponse: + nullable: true properties: - end_time: - format: date-time - title: The end time of the closed caption. - type: number + blocked_user: + $ref: '#/components/schemas/UserResponse' + description: User who got blocked + title: User x-stream-index: "003" - speaker_id: - title: The speaker ID of the closed caption. + blocked_user_id: + description: ID of the user who got blocked + title: UserID type: string x-stream-index: "004" - start_time: + created_at: format: date-time - title: The start time of the closed caption. type: number - x-stream-index: "002" - text: - title: The text of the closed caption. - type: string - x-stream-index: "001" + x-stream-index: "005" user: $ref: '#/components/schemas/UserResponse' - title: The full user for the closed caption. - x-stream-index: "005" + description: User who blocked another user + title: User + x-stream-index: "001" + user_id: + description: ID of the user who blocked another user + title: UserID + type: string + x-stream-index: "002" required: - - text - - start_time - - end_time - - speaker_id - user - title: CallClosedCaption + - user_id + - blocked_user + - blocked_user_id + - created_at type: object - CallClosedCaptionsFailedEvent: - description: This event is sent when call closed captions has failed + BodyguardRule: properties: - call_cid: + action: + enum: + - flag + - shadow + - remove + - bounce + - bounce_flag + - bounce_remove type: string - x-stream-index: "002.001" - created_at: - format: date-time - type: number - x-stream-index: "001.002" - type: - default: call.closed_captions_failed - description: 'The type of event: "call.closed_captions_failed" in this case' - title: Event Type + x-stream-index: "002" + label: type: string - x-stream-index: "001.001" + x-stream-index: "001" + severity_rules: + items: + $ref: '#/components/schemas/BodyguardSeverityRule' + type: array + x-stream-index: "003" required: - - type - - created_at - - call_cid - title: CallClosedCaptionsFailedEvent + - label + - action + - severity_rules type: object - x-stream-event-call-type: true - x-stream-event-doc-group: transcription - x-stream-is-event: true - x-stream-ws-base-event-name: VideoEvent - CallClosedCaptionsStartedEvent: - description: This event is sent when call closed caption has started + BodyguardSeverityRule: properties: - call_cid: + action: + enum: + - flag + - shadow + - remove + - bounce + - bounce_flag + - bounce_remove type: string - x-stream-index: "002.001" - created_at: - format: date-time - type: number - x-stream-index: "001.002" - type: - default: call.closed_captions_started - description: 'The type of event: "call.closed_captions_started" in this - case' - title: Event Type + x-stream-index: "002" + severity: + enum: + - low + - medium + - high + - critical type: string - x-stream-index: "001.001" + x-stream-index: "001" required: - - type - - created_at - - call_cid - title: CallClosedCaptionsStartedEvent + - severity + - action type: object - x-stream-event-call-type: true - x-stream-event-doc-group: transcription - x-stream-is-event: true - x-stream-ws-base-event-name: VideoEvent - CallClosedCaptionsStoppedEvent: - description: This event is sent when call closed captions has stopped + BookmarkAddedEvent: + description: Emitted when a user bookmarks an activity. + nullable: true properties: - call_cid: - type: string - x-stream-index: "002.001" + bookmark: + $ref: '#/components/schemas/BookmarkResponse' + x-stream-index: "001" created_at: + description: Date/time of creation format: date-time + title: Created at type: number - x-stream-index: "001.002" + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 type: - default: call.closed_captions_stopped - description: 'The type of event: "call.transcription_stopped" in this case' + default: feeds.bookmark.added + description: 'The type of event: "feeds.bookmark.added" in this case' title: Event Type type: string - x-stream-index: "001.001" + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who added the bookmark + title: User + x-stream-index: "003.001" required: + - bookmark - type - created_at - - call_cid - title: CallClosedCaptionsStoppedEvent + - custom + title: BookmarkAddedEvent type: object - x-stream-event-call-type: true - x-stream-event-doc-group: transcription + x-stream-event-client-type: true + x-stream-event-doc-group: other x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallCreatedEvent: - description: |- - This event is sent when a call is created. Clients receiving this event should check if the ringing - field is set to true and if so, show the call screen + BookmarkDeletedEvent: + description: Emitted when a user deletes a bookmark from an activity. + nullable: true properties: - call: - $ref: '#/components/schemas/CallResponse' - description: Call object - title: Call - x-stream-index: "003" - call_cid: - type: string - x-stream-index: "002.001" + bookmark: + $ref: '#/components/schemas/BookmarkResponse' + x-stream-index: "001" created_at: + description: Date/time of creation format: date-time + title: Created at type: number - x-stream-index: "001.002" - members: - description: the members added to this call - items: - $ref: '#/components/schemas/MemberResponse' - title: Members - type: array - x-stream-index: "004" + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 type: - default: call.created - description: 'The type of event: "call.created" in this case' + default: feeds.bookmark.deleted + description: 'The type of event: "feeds.bookmark.deleted" in this case' title: Event Type type: string - x-stream-index: "001.001" + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who removed the bookmark + title: User + x-stream-index: "003.001" required: + - bookmark - type - created_at - - call_cid - - call - - members - title: CallCreatedEvent + - custom + title: BookmarkDeletedEvent type: object - x-stream-event-call-type: true - x-stream-event-doc-group: call + x-stream-event-client-type: true + x-stream-event-doc-group: other x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallDeletedEvent: - description: This event is sent when a call is deleted. Clients receiving this - event should leave the call screen + BookmarkFolderDeletedEvent: + description: Emitted when a bookmark folder is deleted. + nullable: true properties: - call: - $ref: '#/components/schemas/CallResponse' - description: Call object - title: Call - x-stream-index: "003" - call_cid: - type: string - x-stream-index: "002.001" + bookmark_folder: + $ref: '#/components/schemas/BookmarkFolderResponse' + description: The bookmark folder that was deleted + title: Bookmark Folder + x-stream-index: "001" created_at: + description: Date/time of creation format: date-time + title: Created at type: number - x-stream-index: "001.002" + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 type: - default: call.deleted - description: 'The type of event: "call.deleted" in this case' + default: feeds.bookmark_folder.deleted + description: 'The type of event: "feeds.bookmark_folder.deleted" in this + case' title: Event Type type: string - x-stream-index: "001.001" + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who deleted the bookmark folder + title: User + x-stream-index: "003.001" required: + - bookmark_folder - type - created_at - - call_cid - - call - title: CallDeletedEvent + - custom + title: BookmarkFolderDeletedEvent type: object - x-stream-event-call-type: true - x-stream-event-doc-group: call + x-stream-event-client-type: true + x-stream-event-doc-group: other x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallDurationReport: - properties: - histogram: - items: - $ref: '#/components/schemas/ReportByHistogramBucket' - type: array - x-stream-index: "001" - required: - - histogram - type: object - CallDurationReportResponse: - properties: - daily: - items: - $ref: '#/components/schemas/DailyAggregateCallDurationReportResponse' - type: array - x-stream-index: "001" - required: - - daily - type: object - CallEgress: - nullable: true + BookmarkFolderResponse: properties: - app_pk: - format: int32 - type: integer - x-stream-index: "002" - call_id: - type: string + created_at: + description: When the folder was created + format: date-time + title: Created At + type: number x-stream-index: "004" - call_type: - type: string + custom: + additionalProperties: {} + description: Custom data for the folder + title: Custom Data + type: object x-stream-index: "003" - config: - $ref: '#/components/schemas/EgressTaskConfig' - x-stream-index: "007" - egress_id: - type: string - x-stream-index: "005" - egress_type: - type: string - x-stream-index: "006" - instance_ip: + id: + description: Unique identifier for the folder + title: ID type: string - x-stream-index: "008" - started_at: - format: date-time - type: number - x-stream-index: "010" - state: + x-stream-index: "001" + name: + description: Name of the folder + title: Name type: string - x-stream-index: "009" - stopped_at: - format: date-time - type: number - x-stream-index: "011" + x-stream-index: "002" updated_at: + description: When the folder was last updated format: date-time + title: Updated At type: number - x-stream-index: "012" + x-stream-index: "005" required: - - app_pk - - call_type - - call_id - - egress_id - - egress_type - - instance_ip - - state - - started_at + - id + - name + - created_at - updated_at + title: Bookmark Folder type: object - CallEndedEvent: - description: This event is sent when a call is mark as ended for all its participants. - Clients receiving this event should leave the call screen + BookmarkFolderUpdatedEvent: + description: Emitted when a bookmark folder is updated. + nullable: true properties: - call: - $ref: '#/components/schemas/CallResponse' - x-stream-index: "003" - call_cid: - type: string - x-stream-index: "002.001" + bookmark_folder: + $ref: '#/components/schemas/BookmarkFolderResponse' + description: The bookmark folder that was updated + title: Bookmark Folder + x-stream-index: "001" created_at: + description: Date/time of creation format: date-time + title: Created at type: number - x-stream-index: "001.002" - reason: - description: The reason why the call ended, if available - title: CallEndedReason - type: string - x-stream-index: "005" + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 type: - default: call.ended - description: 'The type of event: "call.ended" in this case' + default: feeds.bookmark_folder.updated + description: 'The type of event: "feeds.bookmark_folder.updated" in this + case' title: Event Type type: string - x-stream-index: "001.001" + x-stream-index: 002.001.002 user: - $ref: '#/components/schemas/UserResponse' - description: The user who ended the call, null if the call was ended by - the server + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who updated the bookmark folder title: User - x-stream-index: "004" + x-stream-index: "003.001" required: + - bookmark_folder - type - created_at - - call_cid - - call - title: CallEndedEvent + - custom + title: BookmarkFolderUpdatedEvent type: object - x-stream-event-call-type: true - x-stream-event-doc-group: call + x-stream-event-client-type: true + x-stream-event-doc-group: other x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallFrameRecordingFailedEvent: - description: This event is sent when frame recording has failed + BookmarkResponse: properties: - call: - $ref: '#/components/schemas/CallResponse' - x-stream-index: "003" - call_cid: - type: string - x-stream-index: "002.001" + activity: + $ref: '#/components/schemas/ActivityResponse' + description: The bookmarked activity + title: Activity + x-stream-index: "002" created_at: + description: When the bookmark was created format: date-time + title: Created At type: number - x-stream-index: "001.002" - egress_id: - type: string + x-stream-index: "005" + custom: + additionalProperties: {} + description: Custom data for the bookmark + title: Custom Data + type: object x-stream-index: "004" - type: - default: call.frame_recording_failed - description: 'The type of event: "call.frame_recording_failed" in this case' - title: Event Type - type: string - x-stream-index: "001.001" + folder: + $ref: '#/components/schemas/BookmarkFolderResponse' + description: Folder containing this bookmark + title: Folder + x-stream-index: "003" + updated_at: + description: When the bookmark was last updated + format: date-time + title: Updated At + type: number + x-stream-index: "006" + user: + $ref: '#/components/schemas/UserResponse' + description: User who created the bookmark + title: User + x-stream-index: "001" required: - - type + - user + - activity - created_at - - call_cid - - call - - egress_id - title: CallFrameRecordingFailedEvent + - updated_at + title: Bookmark type: object - x-stream-event-call-type: true - x-stream-event-doc-group: recording - x-stream-is-event: true - x-stream-ws-base-event-name: VideoEvent - CallFrameRecordingFrameReadyEvent: - description: This event is sent when a frame is captured from a call + BookmarkUpdatedEvent: + description: Emitted when a user updates a bookmark. + nullable: true properties: - call_cid: - type: string - x-stream-index: "002.001" - captured_at: - description: The time the frame was captured + bookmark: + $ref: '#/components/schemas/BookmarkResponse' + description: The updated bookmark + title: Bookmark + x-stream-index: "001" + created_at: + description: Date/time of creation format: date-time - title: CapturedAt + title: Created at type: number - x-stream-index: "006" - created_at: + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + received_at: format: date-time type: number - x-stream-index: "001.002" - egress_id: - type: string - x-stream-index: "008" - session_id: - description: Call session ID - title: Session ID - type: string - x-stream-index: "003.001" - track_type: - description: The type of the track frame was captured from (TRACK_TYPE_VIDEO|TRACK_TYPE_SCREEN_SHARE) - title: TrackType - type: string - x-stream-index: "004" + x-stream-index: 002.001.004 type: - default: call.frame_recording_ready - description: 'The type of event: "call.frame_recording_ready" in this case' + default: feeds.bookmark.updated + description: 'The type of event: "feeds.bookmark.updated" in this case' title: Event Type type: string - x-stream-index: "001.001" - url: - description: The URL of the frame - title: URL - type: string - x-stream-index: "005" - users: - additionalProperties: - $ref: '#/components/schemas/UserResponse' - description: The users in the frame - title: Users - type: object - x-stream-index: "007" + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who updated the bookmark + title: User + x-stream-index: "003.001" required: + - bookmark - type - created_at - - call_cid - - session_id - - track_type - - url - - captured_at - - users - - egress_id - title: CallFrameRecordingFrameReadyEvent + - custom + title: BookmarkUpdatedEvent type: object - x-stream-event-call-type: true - x-stream-event-doc-group: recording + x-stream-event-client-type: true + x-stream-event-doc-group: other x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallFrameRecordingStartedEvent: - description: This event is sent when frame recording has started + Bound: properties: - call: - $ref: '#/components/schemas/CallResponse' - x-stream-index: "003" - call_cid: - type: string - x-stream-index: "002.001" - created_at: - format: date-time + inclusive: + type: boolean + x-stream-index: "002" + value: + format: float type: number - x-stream-index: "001.002" - egress_id: - type: string - x-stream-index: "004" - type: - default: call.frame_recording_started - description: 'The type of event: "call.frame_recording_started" in this - case' - title: Event Type - type: string - x-stream-index: "001.001" + x-stream-index: "001" required: - - type - - created_at - - call_cid - - call - - egress_id - title: CallFrameRecordingStartedEvent + - value + - inclusive type: object - x-stream-event-call-type: true - x-stream-event-doc-group: recording - x-stream-is-event: true - x-stream-ws-base-event-name: VideoEvent - CallFrameRecordingStoppedEvent: - description: This event is sent when frame recording has stopped + BroadcastSettings: properties: - call: - $ref: '#/components/schemas/CallResponse' + enabled: + type: boolean + x-stream-index: "001" + hls: + $ref: '#/components/schemas/HLSSettings' + x-stream-index: "002" + rtmp: + $ref: '#/components/schemas/RTMPSettings' x-stream-index: "003" - call_cid: - type: string - x-stream-index: "002.001" - created_at: - format: date-time - type: number - x-stream-index: "001.002" - egress_id: + required: + - enabled + type: object + BroadcastSettingsRequest: + properties: + enabled: + type: boolean + x-stream-index: "001" + hls: + $ref: '#/components/schemas/HLSSettingsRequest' + x-stream-index: "002" + rtmp: + $ref: '#/components/schemas/RTMPSettingsRequest' + x-stream-index: "003" + type: object + BroadcastSettingsResponse: + description: BroadcastSettingsResponse is the payload for broadcasting settings + properties: + enabled: + title: Enabled + type: boolean + x-stream-index: "001" + hls: + $ref: '#/components/schemas/HLSSettingsResponse' + title: HLS + x-stream-index: "002" + rtmp: + $ref: '#/components/schemas/RTMPSettingsResponse' + title: RTMP + x-stream-index: "003" + required: + - enabled + - hls + - rtmp + title: BroadcastSettingsResponse + type: object + BrowserDataResponse: + properties: + name: type: string - x-stream-index: "004" - type: - default: call.frame_recording_stopped - description: 'The type of event: "call.frame_recording_stopped" in this - case' - title: Event Type + x-stream-index: "001" + version: type: string - x-stream-index: "001.001" + x-stream-index: "002" + type: object + BulkImageModerationRequest: + nullable: true + properties: + csv_file: + description: URL to CSV file containing image URLs to moderate + title: string + type: string + x-stream-index: "001" required: - - type - - created_at - - call_cid - - call - - egress_id - title: CallFrameRecordingStoppedEvent + - csv_file type: object - x-stream-event-call-type: true - x-stream-event-doc-group: recording - x-stream-is-event: true - x-stream-ws-base-event-name: VideoEvent - CallHLSBroadcastingFailedEvent: - description: This event is sent when HLS broadcasting has failed + BulkImageModerationResponse: + nullable: true properties: - call_cid: + duration: type: string x-stream-index: "002.001" - created_at: + task_id: + description: ID of the task for processing the bulk image moderation + title: string + type: string + x-stream-index: "001" + required: + - task_id + - duration + type: object + Call: + properties: + AppPK: + format: int32 + type: integer + writeOnly: true + x-stream-index: "002" + Backstage: + type: boolean + writeOnly: true + x-stream-index: "023" + BlockedUserIDs: + items: + type: string + type: array + writeOnly: true + x-stream-index: "018" + BlockedUsers: + items: + $ref: '#/components/schemas/User' + type: array + writeOnly: true + x-stream-index: "019" + CID: + type: string + writeOnly: true + x-stream-index: "005" + CallType: + $ref: '#/components/schemas/CallType' + x-stream-index: "020" + ChannelCID: + type: string + writeOnly: true + x-stream-index: "032" + CreatedAt: format: date-time type: number - x-stream-index: "001.002" - type: - default: call.hls_broadcasting_failed - description: 'The type of event: "call.hls_broadcasting_failed" in this - case' - title: Event Type + writeOnly: true + x-stream-index: "013" + CreatedBy: + $ref: '#/components/schemas/User' + x-stream-index: "008" + CreatedByUserID: type: string - x-stream-index: "001.001" + writeOnly: true + x-stream-index: "007" + CurrentSessionID: + type: string + writeOnly: true + x-stream-index: "024" + Custom: + additionalProperties: {} + type: object + writeOnly: true + x-stream-index: "012" + DeletedAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "028" + EgressUpdatedAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "027" + Egresses: + items: + $ref: '#/components/schemas/CallEgress' + type: array + writeOnly: true + x-stream-index: "015" + EndedAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "017" + ID: + type: string + writeOnly: true + x-stream-index: "004" + JoinAheadTimeSeconds: + format: int32 + type: integer + writeOnly: true + x-stream-index: "031" + LastHeartbeatAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "030" + LastSessionID: + type: string + writeOnly: true + x-stream-index: "025" + MemberCount: + format: int32 + type: integer + writeOnly: true + x-stream-index: "010" + MemberLookup: + $ref: '#/components/schemas/MemberLookup' + x-stream-index: "011" + Members: + items: + $ref: '#/components/schemas/CallMember' + type: array + writeOnly: true + x-stream-index: "009" + Session: + $ref: '#/components/schemas/CallSession' + x-stream-index: "026" + Settings: + $ref: '#/components/schemas/CallSettings' + x-stream-index: "022" + SettingsOverrides: + $ref: '#/components/schemas/CallSettings' + x-stream-index: "021" + StartsAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "016" + Team: + type: string + writeOnly: true + x-stream-index: "006" + ThumbnailURL: + type: string + writeOnly: true + x-stream-index: "029" + Type: + type: string + writeOnly: true + x-stream-index: "003" + UpdatedAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "014" required: - - type - - created_at - - call_cid - title: CallHLSBroadcastingFailedEvent + - AppPK + - Type + - ID + - CID + - Team + - CreatedByUserID + - Members + - Custom + - CreatedAt + - UpdatedAt + - Egresses + - BlockedUserIDs + - BlockedUsers + - Backstage + - CurrentSessionID + - LastSessionID + - ThumbnailURL + - ChannelCID type: object - x-stream-event-call-type: true - x-stream-event-doc-group: streaming - x-stream-is-event: true - x-stream-ws-base-event-name: VideoEvent - CallHLSBroadcastingStartedEvent: - description: This event is sent when HLS broadcasting has started + CallAcceptedEvent: + description: This event is sent when a user accepts a notification to join a + call. properties: call: $ref: '#/components/schemas/CallResponse' @@ -2667,75 +4091,65 @@ components: format: date-time type: number x-stream-index: "001.002" - hls_playlist_url: - type: string - x-stream-index: "004" type: - default: call.hls_broadcasting_started - description: 'The type of event: "call.hls_broadcasting_started" in this - case' + default: call.accepted + description: 'The type of event: "call.accepted" in this case' title: Event Type type: string x-stream-index: "001.001" + user: + $ref: '#/components/schemas/UserResponse' + description: The user who accepted the call + title: User + x-stream-index: "004" required: - type - created_at - call_cid - call - - hls_playlist_url - title: CallHLSBroadcastingStartedEvent + - user + title: CallAcceptedEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: streaming + x-stream-event-doc-group: ring x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallHLSBroadcastingStoppedEvent: - description: This event is sent when HLS broadcasting has stopped + CallClosedCaption: + description: CallClosedCaption represents a closed caption of a call. properties: - call_cid: + end_time: + format: date-time + title: The end time of the closed caption. + type: number + x-stream-index: "003" + speaker_id: + title: The speaker ID of the closed caption. type: string - x-stream-index: "002.001" - created_at: + x-stream-index: "004" + start_time: format: date-time + title: The start time of the closed caption. type: number - x-stream-index: "001.002" - type: - default: call.hls_broadcasting_stopped - description: 'The type of event: "call.hls_broadcasting_stopped" in this - case' - title: Event Type + x-stream-index: "002" + text: + title: The text of the closed caption. type: string - x-stream-index: "001.001" - required: - - type - - created_at - - call_cid - title: CallHLSBroadcastingStoppedEvent - type: object - x-stream-event-call-type: true - x-stream-event-doc-group: streaming - x-stream-is-event: true - x-stream-ws-base-event-name: VideoEvent - CallIngressResponse: - description: CallIngressResponse is the payload for ingress settings - properties: - rtmp: - $ref: '#/components/schemas/RTMPIngress' - title: RTMP x-stream-index: "001" + user: + $ref: '#/components/schemas/UserResponse' + title: The full user for the closed caption. + x-stream-index: "005" required: - - rtmp - title: CallIngressResponse + - text + - start_time + - end_time + - speaker_id + - user + title: CallClosedCaption type: object - CallLiveStartedEvent: - description: This event is sent when a call is started. Clients receiving this - event should start the call. + CallClosedCaptionsFailedEvent: + description: This event is sent when call closed captions has failed properties: - call: - $ref: '#/components/schemas/CallResponse' - description: Call object - title: Call - x-stream-index: "003" call_cid: type: string x-stream-index: "002.001" @@ -2744,8 +4158,8 @@ components: type: number x-stream-index: "001.002" type: - default: call.live_started - description: 'The type of event: "call.live_started" in this case' + default: call.closed_captions_failed + description: 'The type of event: "call.closed_captions_failed" in this case' title: Event Type type: string x-stream-index: "001.001" @@ -2753,56 +4167,15 @@ components: - type - created_at - call_cid - - call - title: CallLiveStartedEvent + title: CallClosedCaptionsFailedEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: streaming + x-stream-event-doc-group: transcription x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallMember: - nullable: true - properties: - created_at: - format: date-time - type: number - x-stream-index: "008" - custom: - additionalProperties: {} - type: object - x-stream-index: "007" - deleted_at: - format: date-time - type: number - x-stream-index: "010" - role: - type: string - x-stream-index: "006" - updated_at: - format: date-time - type: number - x-stream-index: "009" - user: - $ref: '#/components/schemas/User' - x-stream-index: "005" - user_id: - type: string - x-stream-index: "004" - required: - - user_id - - role - - custom - - created_at - - updated_at - type: object - CallMemberAddedEvent: - description: This event is sent when one or more members are added to a call + CallClosedCaptionsStartedEvent: + description: This event is sent when call closed caption has started properties: - call: - $ref: '#/components/schemas/CallResponse' - description: Call object - title: Call - x-stream-index: "003" call_cid: type: string x-stream-index: "002.001" @@ -2810,16 +4183,10 @@ components: format: date-time type: number x-stream-index: "001.002" - members: - description: the members added to this call - items: - $ref: '#/components/schemas/MemberResponse' - title: Members - type: array - x-stream-index: "004" type: - default: call.member_added - description: 'The type of event: "call.member_added" in this case' + default: call.closed_captions_started + description: 'The type of event: "call.closed_captions_started" in this + case' title: Event Type type: string x-stream-index: "001.001" @@ -2827,23 +4194,15 @@ components: - type - created_at - call_cid - - call - - members - title: CallMemberAddedEvent + title: CallClosedCaptionsStartedEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: call + x-stream-event-doc-group: transcription x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallMemberRemovedEvent: - description: This event is sent when one or more members are removed from a - call + CallClosedCaptionsStoppedEvent: + description: This event is sent when call closed captions has stopped properties: - call: - $ref: '#/components/schemas/CallResponse' - description: Call object - title: Call - x-stream-index: "003" call_cid: type: string x-stream-index: "002.001" @@ -2851,16 +4210,9 @@ components: format: date-time type: number x-stream-index: "001.002" - members: - description: the list of member IDs removed from the call - items: - type: string - title: Members - type: array - x-stream-index: "004" type: - default: call.member_removed - description: 'The type of event: "call.member_removed" in this case' + default: call.closed_captions_stopped + description: 'The type of event: "call.transcription_stopped" in this case' title: Event Type type: string x-stream-index: "001.001" @@ -2868,16 +4220,16 @@ components: - type - created_at - call_cid - - call - - members - title: CallMemberRemovedEvent + title: CallClosedCaptionsStoppedEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: call + x-stream-event-doc-group: transcription x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallMemberUpdatedEvent: - description: This event is sent when one or more members are updated + CallCreatedEvent: + description: |- + This event is sent when a call is created. Clients receiving this event should check if the ringing + field is set to true and if so, show the call screen properties: call: $ref: '#/components/schemas/CallResponse' @@ -2892,15 +4244,15 @@ components: type: number x-stream-index: "001.002" members: - description: The list of members that were updated + description: the members added to this call items: $ref: '#/components/schemas/MemberResponse' title: Members type: array x-stream-index: "004" type: - default: call.member_updated - description: 'The type of event: "call.member_updated" in this case' + default: call.created + description: 'The type of event: "call.created" in this case' title: Event Type type: string x-stream-index: "001.001" @@ -2910,14 +4262,15 @@ components: - call_cid - call - members - title: CallMemberUpdatedEvent + title: CallCreatedEvent type: object x-stream-event-call-type: true x-stream-event-doc-group: call x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallMemberUpdatedPermissionEvent: - description: This event is sent when one or more members get its role updated + CallDeletedEvent: + description: This event is sent when a call is deleted. Clients receiving this + event should leave the call screen properties: call: $ref: '#/components/schemas/CallResponse' @@ -2927,29 +4280,13 @@ components: call_cid: type: string x-stream-index: "002.001" - capabilities_by_role: - additionalProperties: - items: - type: string - type: array - description: The capabilities by role for this call - title: CapabilitiesByRole - type: object - x-stream-index: "004" created_at: format: date-time type: number x-stream-index: "001.002" - members: - description: The list of members that were updated - items: - $ref: '#/components/schemas/MemberResponse' - title: Members - type: array - x-stream-index: "005" type: - default: call.member_updated_permission - description: 'The type of event: "call.member_added" in this case' + default: call.deleted + description: 'The type of event: "call.deleted" in this case' title: Event Type type: string x-stream-index: "001.001" @@ -2958,73 +4295,90 @@ components: - created_at - call_cid - call - - capabilities_by_role - - members - title: CallMemberUpdatedPermissionEvent + title: CallDeletedEvent type: object x-stream-event-call-type: true x-stream-event-doc-group: call x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallMissedEvent: - description: This event is sent to call members who did not accept/reject/join - the call to notify they missed the call + CallDurationReport: properties: - call: - $ref: '#/components/schemas/CallResponse' - description: Call object - title: Call - x-stream-index: "004" - call_cid: - type: string - x-stream-index: "002.001" - created_at: - format: date-time - type: number - x-stream-index: "001.002" - members: - description: List of members who missed the call + histogram: items: - $ref: '#/components/schemas/MemberResponse' - title: Members + $ref: '#/components/schemas/ReportByHistogramBucket' type: array - x-stream-index: "005" - notify_user: - type: boolean + x-stream-index: "001" + required: + - histogram + type: object + CallDurationReportResponse: + properties: + daily: + items: + $ref: '#/components/schemas/DailyAggregateCallDurationReportResponse' + type: array + x-stream-index: "001" + required: + - daily + type: object + CallEgress: + nullable: true + properties: + app_pk: + format: int32 + type: integer + x-stream-index: "002" + call_id: + type: string + x-stream-index: "004" + call_type: + type: string + x-stream-index: "003" + config: + $ref: '#/components/schemas/EgressTaskConfig' x-stream-index: "007" - session_id: - description: Call session ID - title: Session ID + egress_id: type: string - x-stream-index: "003.001" - type: - default: call.missed - description: 'The type of event: "call.notification" in this case' - title: Event Type + x-stream-index: "005" + egress_type: type: string - x-stream-index: "001.001" - user: - $ref: '#/components/schemas/UserResponse' - description: The caller from whom the call was missed - title: User x-stream-index: "006" + instance_ip: + type: string + x-stream-index: "008" + started_at: + format: date-time + type: number + x-stream-index: "010" + state: + type: string + x-stream-index: "009" + stopped_at: + format: date-time + type: number + x-stream-index: "011" + updated_at: + format: date-time + type: number + x-stream-index: "012" required: - - type - - created_at - - call_cid - - session_id - - call - - members - - user - - notify_user - title: CallMissedEvent + - app_pk + - call_type + - call_id + - egress_id + - egress_type + - instance_ip + - state + - started_at + - updated_at type: object - x-stream-event-call-type: true - x-stream-event-doc-group: ring - x-stream-is-event: true - x-stream-ws-base-event-name: VideoEvent - CallModerationBlurEvent: + CallEndedEvent: + description: This event is sent when a call is mark as ended for all its participants. + Clients receiving this event should leave the call screen properties: + call: + $ref: '#/components/schemas/CallResponse' + x-stream-index: "003" call_cid: type: string x-stream-index: "002.001" @@ -3032,31 +4386,40 @@ components: format: date-time type: number x-stream-index: "001.002" - custom: - additionalProperties: {} - type: object - x-stream-index: "004" + reason: + description: The reason why the call ended, if available + title: CallEndedReason + type: string + x-stream-index: "005" type: - default: call.moderation_blur + default: call.ended + description: 'The type of event: "call.ended" in this case' + title: Event Type type: string x-stream-index: "001.001" - user_id: - type: string - x-stream-index: "003" + user: + $ref: '#/components/schemas/UserResponse' + description: The user who ended the call, null if the call was ended by + the server + title: User + x-stream-index: "004" required: - type - created_at - call_cid - - user_id - - custom - title: CallModerationBlurEvent + - call + title: CallEndedEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: other + x-stream-event-doc-group: call x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallModerationWarningEvent: + CallFrameRecordingFailedEvent: + description: This event is sent when frame recording has failed properties: + call: + $ref: '#/components/schemas/CallResponse' + x-stream-index: "003" call_cid: type: string x-stream-index: "002.001" @@ -3064,237 +4427,96 @@ components: format: date-time type: number x-stream-index: "001.002" - custom: - additionalProperties: {} - type: object - x-stream-index: "005" - message: + egress_id: type: string x-stream-index: "004" type: - default: call.moderation_warning + default: call.frame_recording_failed + description: 'The type of event: "call.frame_recording_failed" in this case' + title: Event Type type: string x-stream-index: "001.001" - user_id: - type: string - x-stream-index: "003" required: - type - created_at - call_cid - - user_id - - message - - custom - title: CallModerationWarningEvent + - call + - egress_id + title: CallFrameRecordingFailedEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: other + x-stream-event-doc-group: recording x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallNotificationEvent: - description: This event is sent to all call members to notify they are getting - called + CallFrameRecordingFrameReadyEvent: + description: This event is sent when a frame is captured from a call properties: - call: - $ref: '#/components/schemas/CallResponse' - description: Call object - title: Call - x-stream-index: "004" call_cid: type: string x-stream-index: "002.001" + captured_at: + description: The time the frame was captured + format: date-time + title: CapturedAt + type: number + x-stream-index: "006" created_at: format: date-time type: number x-stream-index: "001.002" - members: - description: Call members - items: - $ref: '#/components/schemas/MemberResponse' - title: Members - type: array - x-stream-index: "005" + egress_id: + type: string + x-stream-index: "008" session_id: description: Call session ID title: Session ID type: string x-stream-index: "003.001" + track_type: + description: The type of the track frame was captured from (TRACK_TYPE_VIDEO|TRACK_TYPE_SCREEN_SHARE) + title: TrackType + type: string + x-stream-index: "004" type: - default: call.notification - description: 'The type of event: "call.notification" in this case' + default: call.frame_recording_ready + description: 'The type of event: "call.frame_recording_ready" in this case' title: Event Type type: string x-stream-index: "001.001" - user: - $ref: '#/components/schemas/UserResponse' - description: The user that sent the call notification - title: User - x-stream-index: "006" + url: + description: The URL of the frame + title: URL + type: string + x-stream-index: "005" + users: + additionalProperties: + $ref: '#/components/schemas/UserResponse' + description: The users in the frame + title: Users + type: object + x-stream-index: "007" required: - type - created_at - call_cid - session_id - - call - - members - - user - title: CallNotificationEvent + - track_type + - url + - captured_at + - users + - egress_id + title: CallFrameRecordingFrameReadyEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: ring + x-stream-event-doc-group: recording x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallParticipant: - nullable: true - properties: - JoinedAt: - format: date-time - type: number - writeOnly: true - x-stream-index: "004" - Role: - type: string - writeOnly: true - x-stream-index: "002" - UserSessionID: - type: string - writeOnly: true - x-stream-index: "003" - avg_response_time: - format: int32 - readOnly: true - type: integer - x-stream-index: "001.046" - ban_expires: - format: date-time - type: number - x-stream-index: "001.017" - banned: - type: boolean - x-stream-index: "001.016" - created_at: - format: date-time - readOnly: true - type: number - x-stream-index: "001.008" - custom: - additionalProperties: {} - type: object - x-stream-index: "001.006" - deactivated_at: - format: date-time - readOnly: true - type: number - x-stream-index: "001.014" - deleted_at: - format: date-time - readOnly: true - type: number - x-stream-index: "001.013" - id: - type: string - x-stream-index: "001.003" - invisible: - type: boolean - x-stream-index: "001.023" - language: - type: string - x-stream-index: "001.035" - last_active: - format: date-time - readOnly: true - type: number - x-stream-index: "001.011" - last_engaged_at: - format: date-time - readOnly: true - type: number - x-stream-index: "001.012" - online: - readOnly: true - type: boolean - x-stream-index: "001.022" - privacy_settings: - $ref: '#/components/schemas/PrivacySettings' - x-stream-index: "001.026" - revoke_tokens_issued_before: - format: date-time - type: number - x-stream-index: "001.042" - role: - type: string - x-stream-index: "001.004" - teams: - items: - type: string - type: array - x-stream-index: "001.036" - teams_role: - additionalProperties: - type: string - type: object - x-stream-index: "001.005" - updated_at: - format: date-time - readOnly: true - type: number - x-stream-index: "001.009" - required: - - id - - role - - teams_role - - custom - - banned - - online - - Role - - UserSessionID - - JoinedAt - type: object - CallParticipantCountReport: - properties: - histogram: - items: - $ref: '#/components/schemas/ReportByHistogramBucket' - type: array - x-stream-index: "001" - required: - - histogram - type: object - CallParticipantCountReportResponse: - properties: - daily: - items: - $ref: '#/components/schemas/DailyAggregateCallParticipantCountReportResponse' - type: array - x-stream-index: "001" - required: - - daily - type: object - CallParticipantResponse: + CallFrameRecordingStartedEvent: + description: This event is sent when frame recording has started properties: - joined_at: - format: date-time - type: number - x-stream-index: "004" - role: - type: string + call: + $ref: '#/components/schemas/CallResponse' x-stream-index: "003" - user: - $ref: '#/components/schemas/UserResponse' - x-stream-index: "001" - user_session_id: - type: string - x-stream-index: "002" - required: - - user - - user_session_id - - role - - joined_at - type: object - CallReactionEvent: - description: This event is sent when a reaction is sent in a call, clients should - use this to show the reaction in the call screen - properties: call_cid: type: string x-stream-index: "002.001" @@ -3302,14 +4524,13 @@ components: format: date-time type: number x-stream-index: "001.002" - reaction: - $ref: '#/components/schemas/ReactionResponse' - description: the reaction object sent by the user on the call - title: reaction - x-stream-index: "003" + egress_id: + type: string + x-stream-index: "004" type: - default: call.reaction_new - description: 'The type of event: "call.reaction_new" in this case' + default: call.frame_recording_started + description: 'The type of event: "call.frame_recording_started" in this + case' title: Event Type type: string x-stream-index: "001.001" @@ -3317,49 +4538,20 @@ components: - type - created_at - call_cid - - reaction - title: CallReactionEvent + - call + - egress_id + title: CallFrameRecordingStartedEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: call + x-stream-event-doc-group: recording x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallRecording: - description: CallRecording represents a recording of a call. + CallFrameRecordingStoppedEvent: + description: This event is sent when frame recording has stopped properties: - end_time: - format: date-time - title: The end time of the recording. - type: number - x-stream-index: "004" - filename: - title: The filename of the recording. - type: string - x-stream-index: "001" - session_id: - title: The session ID of the recording. - type: string - x-stream-index: "005" - start_time: - format: date-time - title: The start time of the recording. - type: number + call: + $ref: '#/components/schemas/CallResponse' x-stream-index: "003" - url: - title: The URL of the recording. - type: string - x-stream-index: "002" - required: - - filename - - url - - start_time - - end_time - - session_id - title: CallRecording - type: object - CallRecordingFailedEvent: - description: This event is sent when call recording has failed - properties: call_cid: type: string x-stream-index: "002.001" @@ -3369,10 +4561,11 @@ components: x-stream-index: "001.002" egress_id: type: string - x-stream-index: "003" + x-stream-index: "004" type: - default: call.recording_failed - description: 'The type of event: "call.recording_failed" in this case' + default: call.frame_recording_stopped + description: 'The type of event: "call.frame_recording_stopped" in this + case' title: Event Type type: string x-stream-index: "001.001" @@ -3380,34 +4573,28 @@ components: - type - created_at - call_cid + - call - egress_id - title: CallRecordingFailedEvent + title: CallFrameRecordingStoppedEvent type: object x-stream-event-call-type: true x-stream-event-doc-group: recording x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallRecordingReadyEvent: - description: This event is sent when call recording is ready + CallHLSBroadcastingFailedEvent: + description: This event is sent when HLS broadcasting has failed properties: call_cid: type: string x-stream-index: "002.001" - call_recording: - $ref: '#/components/schemas/CallRecording' - description: The call recording object - title: CallRecording - x-stream-index: "003" created_at: format: date-time type: number x-stream-index: "001.002" - egress_id: - type: string - x-stream-index: "004" type: - default: call.recording_ready - description: 'The type of event: "call.recording_ready" in this case' + default: call.hls_broadcasting_failed + description: 'The type of event: "call.hls_broadcasting_failed" in this + case' title: Event Type type: string x-stream-index: "001.001" @@ -3415,80 +4602,93 @@ components: - type - created_at - call_cid - - call_recording - - egress_id - title: CallRecordingReadyEvent + title: CallHLSBroadcastingFailedEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: recording + x-stream-event-doc-group: streaming x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallRecordingStartedEvent: - description: This event is sent when call recording has started + CallHLSBroadcastingStartedEvent: + description: This event is sent when HLS broadcasting has started properties: + call: + $ref: '#/components/schemas/CallResponse' + x-stream-index: "003" call_cid: type: string - x-stream-index: "003.001" + x-stream-index: "002.001" created_at: format: date-time type: number - x-stream-index: "002.002" - egress_id: + x-stream-index: "001.002" + hls_playlist_url: type: string - x-stream-index: "001" + x-stream-index: "004" type: - default: call.recording_started - description: 'The type of event: "call.recording_started" in this case' + default: call.hls_broadcasting_started + description: 'The type of event: "call.hls_broadcasting_started" in this + case' title: Event Type type: string - x-stream-index: "002.001" + x-stream-index: "001.001" required: - - egress_id - type - created_at - call_cid - title: CallRecordingStartedEvent + - call + - hls_playlist_url + title: CallHLSBroadcastingStartedEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: recording + x-stream-event-doc-group: streaming x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallRecordingStoppedEvent: - description: This event is sent when call recording has stopped + CallHLSBroadcastingStoppedEvent: + description: This event is sent when HLS broadcasting has stopped properties: call_cid: type: string - x-stream-index: "003.001" + x-stream-index: "002.001" created_at: format: date-time type: number - x-stream-index: "002.002" - egress_id: - type: string - x-stream-index: "001" + x-stream-index: "001.002" type: - default: call.recording_stopped - description: 'The type of event: "call.recording_stopped" in this case' + default: call.hls_broadcasting_stopped + description: 'The type of event: "call.hls_broadcasting_stopped" in this + case' title: Event Type type: string - x-stream-index: "002.001" + x-stream-index: "001.001" required: - - egress_id - type - created_at - call_cid - title: CallRecordingStoppedEvent + title: CallHLSBroadcastingStoppedEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: recording + x-stream-event-doc-group: streaming x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallRejectedEvent: - description: This event is sent when a user rejects a notification to join a - call. + CallIngressResponse: + description: CallIngressResponse is the payload for ingress settings + properties: + rtmp: + $ref: '#/components/schemas/RTMPIngress' + title: RTMP + x-stream-index: "001" + required: + - rtmp + title: CallIngressResponse + type: object + CallLiveStartedEvent: + description: This event is sent when a call is started. Clients receiving this + event should start the call. properties: call: $ref: '#/components/schemas/CallResponse' + description: Call object + title: Call x-stream-index: "003" call_cid: type: string @@ -3497,218 +4697,238 @@ components: format: date-time type: number x-stream-index: "001.002" - reason: - description: 'Provides information about why the call was rejected. You - can provide any value, but the Stream API and SDKs use these default values: - rejected, cancel, timeout and busy' - title: Reason - type: string - x-stream-index: "005" type: - default: call.rejected - description: 'The type of event: "call.rejected" in this case' + default: call.live_started + description: 'The type of event: "call.live_started" in this case' title: Event Type type: string x-stream-index: "001.001" - user: - $ref: '#/components/schemas/UserResponse' - description: The user who rejected the call - title: User - x-stream-index: "004" required: - type - created_at - call_cid - call - - user - title: CallRejectedEvent + title: CallLiveStartedEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: ring + x-stream-event-doc-group: streaming x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallReportResponse: + CallMember: + nullable: true properties: - ended_at: + created_at: format: date-time type: number - x-stream-index: "003" - score: - format: float + x-stream-index: "008" + custom: + additionalProperties: {} + type: object + x-stream-index: "007" + deleted_at: + format: date-time type: number - x-stream-index: "001" - started_at: + x-stream-index: "010" + role: + type: string + x-stream-index: "006" + updated_at: format: date-time type: number - x-stream-index: "002" + x-stream-index: "009" + user: + $ref: '#/components/schemas/User' + x-stream-index: "005" + user_id: + type: string + x-stream-index: "004" required: - - score + - user_id + - role + - custom + - created_at + - updated_at type: object - CallRequest: - description: CallRequest is the payload for creating a call. + CallMemberAddedEvent: + description: This event is sent when one or more members are added to a call properties: - channel_cid: - type: string - x-stream-index: "009" - created_by: - $ref: '#/components/schemas/UserRequest' - title: The user that create this call - x-stream-index: "002" - created_by_id: - title: The id of the user that create this call - type: string + call: + $ref: '#/components/schemas/CallResponse' + description: Call object + title: Call x-stream-index: "003" - custom: - additionalProperties: {} - type: object - x-stream-index: "004" + call_cid: + type: string + x-stream-index: "002.001" + created_at: + format: date-time + type: number + x-stream-index: "001.002" members: + description: the members added to this call items: - $ref: '#/components/schemas/MemberRequest' - maximum: 100 + $ref: '#/components/schemas/MemberResponse' + title: Members type: array - x-stream-index: "005" - settings_override: - $ref: '#/components/schemas/CallSettingsRequest' - x-stream-index: "006" - starts_at: - format: date-time - type: number - x-stream-index: "007" - team: + x-stream-index: "004" + type: + default: call.member_added + description: 'The type of event: "call.member_added" in this case' + title: Event Type type: string - x-stream-index: "001" - video: - type: boolean - x-stream-index: "008" - title: CallRequest + x-stream-index: "001.001" + required: + - type + - created_at + - call_cid + - call + - members + title: CallMemberAddedEvent type: object - CallResponse: - description: Represents a call + x-stream-event-call-type: true + x-stream-event-doc-group: call + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + CallMemberRemovedEvent: + description: This event is sent when one or more members are removed from a + call properties: - backstage: - type: boolean - x-stream-index: "016" - blocked_user_ids: + call: + $ref: '#/components/schemas/CallResponse' + description: Call object + title: Call + x-stream-index: "003" + call_cid: + type: string + x-stream-index: "002.001" + created_at: + format: date-time + type: number + x-stream-index: "001.002" + members: + description: the list of member IDs removed from the call items: type: string + title: Members type: array - x-stream-index: "018" - captioning: - type: boolean - x-stream-index: "013" - channel_cid: + x-stream-index: "004" + type: + default: call.member_removed + description: 'The type of event: "call.member_removed" in this case' + title: Event Type type: string - x-stream-index: "024" - cid: - description: The unique identifier for a call (:) - title: CID + x-stream-index: "001.001" + required: + - type + - created_at + - call_cid + - call + - members + title: CallMemberRemovedEvent + type: object + x-stream-event-call-type: true + x-stream-event-doc-group: call + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + CallMemberUpdatedEvent: + description: This event is sent when one or more members are updated + properties: + call: + $ref: '#/components/schemas/CallResponse' + description: Call object + title: Call + x-stream-index: "003" + call_cid: type: string - x-stream-index: "004" + x-stream-index: "002.001" created_at: - description: Date/time of creation - format: date-time - title: Created at - type: number - x-stream-index: "009" - created_by: - $ref: '#/components/schemas/UserResponse' - description: The user that created the call - title: Created By - x-stream-index: "007" - current_session_id: - type: string - x-stream-index: "005" - custom: - additionalProperties: {} - description: Custom data for this object - title: Custom data - type: object - x-stream-index: "008" - egress: - $ref: '#/components/schemas/EgressResponse' - x-stream-index: "021" - ended_at: - description: Date/time when the call ended format: date-time - title: Ended At type: number - x-stream-index: "014" - id: - description: Call ID - title: ID + x-stream-index: "001.002" + members: + description: The list of members that were updated + items: + $ref: '#/components/schemas/MemberResponse' + title: Members + type: array + x-stream-index: "004" + type: + default: call.member_updated + description: 'The type of event: "call.member_updated" in this case' + title: Event Type type: string + x-stream-index: "001.001" + required: + - type + - created_at + - call_cid + - call + - members + title: CallMemberUpdatedEvent + type: object + x-stream-event-call-type: true + x-stream-event-doc-group: call + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + CallMemberUpdatedPermissionEvent: + description: This event is sent when one or more members get its role updated + properties: + call: + $ref: '#/components/schemas/CallResponse' + description: Call object + title: Call x-stream-index: "003" - ingress: - $ref: '#/components/schemas/CallIngressResponse' - x-stream-index: "019" - join_ahead_time_seconds: - format: int32 - type: integer - x-stream-index: "023" - recording: - type: boolean - x-stream-index: "011" - session: - $ref: '#/components/schemas/CallSessionResponse' - x-stream-index: "020" - settings: - $ref: '#/components/schemas/CallSettingsResponse' - x-stream-index: "017" - starts_at: - description: Date/time when the call will start + call_cid: + type: string + x-stream-index: "002.001" + capabilities_by_role: + additionalProperties: + items: + type: string + type: array + description: The capabilities by role for this call + title: CapabilitiesByRole + type: object + x-stream-index: "004" + created_at: format: date-time - title: Starts At type: number - x-stream-index: "015" - team: - type: string - x-stream-index: "006" - thumbnails: - $ref: '#/components/schemas/ThumbnailResponse' - x-stream-index: "022" - transcribing: - type: boolean - x-stream-index: "012" + x-stream-index: "001.002" + members: + description: The list of members that were updated + items: + $ref: '#/components/schemas/MemberResponse' + title: Members + type: array + x-stream-index: "005" type: - description: The type of call - title: Type + default: call.member_updated_permission + description: 'The type of event: "call.member_added" in this case' + title: Event Type type: string - x-stream-index: "002" - updated_at: - description: Date/time of the last update - format: date-time - title: Updated at - type: number - x-stream-index: "010" + x-stream-index: "001.001" required: - type - - id - - cid - - current_session_id - - created_by - - custom - created_at - - updated_at - - recording - - transcribing - - captioning - - backstage - - settings - - blocked_user_ids - - ingress - - egress - title: CallResponse + - call_cid + - call + - capabilities_by_role + - members + title: CallMemberUpdatedPermissionEvent type: object - CallRingEvent: - description: This event is sent to all call members to notify they are getting - called + x-stream-event-call-type: true + x-stream-event-doc-group: call + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + CallMissedEvent: + description: This event is sent to call members who did not accept/reject/join + the call to notify they missed the call properties: call: $ref: '#/components/schemas/CallResponse' description: Call object title: Call - x-stream-index: "005" + x-stream-index: "004" call_cid: type: string x-stream-index: "002.001" @@ -3717,31 +4937,31 @@ components: type: number x-stream-index: "001.002" members: - description: Call members + description: List of members who missed the call items: $ref: '#/components/schemas/MemberResponse' title: Members type: array - x-stream-index: "006" + x-stream-index: "005" + notify_user: + type: boolean + x-stream-index: "007" session_id: description: Call session ID title: Session ID type: string x-stream-index: "003.001" type: - default: call.ring + default: call.missed description: 'The type of event: "call.notification" in this case' title: Event Type type: string x-stream-index: "001.001" user: $ref: '#/components/schemas/UserResponse' - description: The user that sent the call notification + description: The caller from whom the call was missed title: User - x-stream-index: "007" - video: - type: boolean - x-stream-index: "008" + x-stream-index: "006" required: - type - created_at @@ -3750,263 +4970,285 @@ components: - call - members - user - - video - title: CallRingEvent + - notify_user + title: CallMissedEvent type: object x-stream-event-call-type: true x-stream-event-doc-group: ring x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallRtmpBroadcastFailedEvent: - description: This event is sent when a call RTMP broadcast has failed + CallModerationBlurEvent: properties: call_cid: - description: The unique identifier for a call (:) - title: CID type: string x-stream-index: "002.001" created_at: - description: Date/time of creation format: date-time - title: Created at type: number x-stream-index: "001.002" - name: - description: Name of the given RTMP broadcast - title: Name - type: string - x-stream-index: "003" + custom: + additionalProperties: {} + type: object + x-stream-index: "004" type: - default: call.rtmp_broadcast_failed - description: 'The type of event: "call.rtmp_broadcast_failed" in this case' - title: Event Type + default: call.moderation_blur type: string x-stream-index: "001.001" + user_id: + type: string + x-stream-index: "003" required: - type - created_at - call_cid - - name - title: CallRtmpBroadcastFailedEvent + - user_id + - custom + title: CallModerationBlurEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: streaming + x-stream-event-doc-group: other x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallRtmpBroadcastStartedEvent: - description: This event is sent when RTMP broadcast has started + CallModerationWarningEvent: properties: call_cid: - description: The unique identifier for a call (:) - title: CID type: string x-stream-index: "002.001" created_at: - description: Date/time of creation format: date-time - title: Created at type: number x-stream-index: "001.002" - name: - description: Name of the given RTMP broadcast - title: Name + custom: + additionalProperties: {} + type: object + x-stream-index: "005" + message: type: string - x-stream-index: "003" + x-stream-index: "004" type: - default: call.rtmp_broadcast_started - description: 'The type of event: "call.rtmp_broadcast_started" in this case' - title: Event Type + default: call.moderation_warning type: string x-stream-index: "001.001" + user_id: + type: string + x-stream-index: "003" required: - type - created_at - call_cid - - name - title: CallRtmpBroadcastStartedEvent + - user_id + - message + - custom + title: CallModerationWarningEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: streaming + x-stream-event-doc-group: other x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallRtmpBroadcastStoppedEvent: - description: This event is sent when RTMP broadcast has stopped + CallNotificationEvent: + description: This event is sent to all call members to notify they are getting + called properties: + call: + $ref: '#/components/schemas/CallResponse' + description: Call object + title: Call + x-stream-index: "004" call_cid: - description: The unique identifier for a call (:) - title: CID type: string x-stream-index: "002.001" created_at: - description: Date/time of creation format: date-time - title: Created at type: number x-stream-index: "001.002" - name: - description: Name of the given RTMP broadcast - title: Name + members: + description: Call members + items: + $ref: '#/components/schemas/MemberResponse' + title: Members + type: array + x-stream-index: "005" + session_id: + description: Call session ID + title: Session ID type: string - x-stream-index: "003" + x-stream-index: "003.001" type: - default: call.rtmp_broadcast_stopped - description: 'The type of event: "call.rtmp_broadcast_stopped" in this case' + default: call.notification + description: 'The type of event: "call.notification" in this case' title: Event Type type: string x-stream-index: "001.001" + user: + $ref: '#/components/schemas/UserResponse' + description: The user that sent the call notification + title: User + x-stream-index: "006" required: - type - created_at - call_cid - - name - title: CallRtmpBroadcastStoppedEvent + - session_id + - call + - members + - user + title: CallNotificationEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: streaming + x-stream-event-doc-group: ring x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallSession: + CallParticipant: + nullable: true properties: - AcceptedBy: - additionalProperties: - format: date-time - type: number - type: object - writeOnly: true - x-stream-index: "008" - ActiveSFUs: - items: - $ref: '#/components/schemas/SFUIDLastSeen' - type: array + JoinedAt: + format: date-time + type: number writeOnly: true - x-stream-index: "016" - AnonymousParticipantCount: - format: int32 - type: integer + x-stream-index: "004" + Role: + type: string writeOnly: true - x-stream-index: "019" - AppPK: - format: int32 - type: integer - writeOnly: true - x-stream-index: "002.001" - CallID: - type: string - writeOnly: true - x-stream-index: "002.003" - CallType: + x-stream-index: "002" + UserSessionID: type: string writeOnly: true - x-stream-index: "002.002" - CreatedAt: + x-stream-index: "003" + avg_response_time: + format: int32 + readOnly: true + type: integer + x-stream-index: "001.046" + ban_expires: format: date-time type: number - writeOnly: true - x-stream-index: "003" - DeletedAt: + x-stream-index: "001.017" + banned: + type: boolean + x-stream-index: "001.016" + created_at: format: date-time + readOnly: true type: number - writeOnly: true - x-stream-index: "004" - EndedAt: + x-stream-index: "001.008" + custom: + additionalProperties: {} + type: object + x-stream-index: "001.006" + deactivated_at: format: date-time + readOnly: true type: number - writeOnly: true - x-stream-index: "006" - LiveEndedAt: + x-stream-index: "001.014" + deleted_at: format: date-time + readOnly: true type: number - writeOnly: true - x-stream-index: "013" - LiveStartedAt: + x-stream-index: "001.013" + id: + type: string + x-stream-index: "001.003" + invisible: + type: boolean + x-stream-index: "001.023" + language: + type: string + x-stream-index: "001.035" + last_active: format: date-time + readOnly: true type: number - writeOnly: true - x-stream-index: "012" - MissedBy: - additionalProperties: - format: date-time - type: number - type: object - writeOnly: true - x-stream-index: "010" - Participants: + x-stream-index: "001.011" + last_engaged_at: + format: date-time + readOnly: true + type: number + x-stream-index: "001.012" + online: + readOnly: true + type: boolean + x-stream-index: "001.022" + privacy_settings: + $ref: '#/components/schemas/PrivacySettings' + x-stream-index: "001.026" + revoke_tokens_issued_before: + format: date-time + type: number + x-stream-index: "001.042" + role: + type: string + x-stream-index: "001.004" + teams: items: - $ref: '#/components/schemas/CallParticipant' + type: string type: array - writeOnly: true - x-stream-index: "011" - ParticipantsCountByRole: - additionalProperties: - format: int32 - type: integer - type: object - writeOnly: true - x-stream-index: "018" - RejectedBy: + x-stream-index: "001.036" + teams_role: additionalProperties: - format: date-time - type: number + type: string type: object - writeOnly: true - x-stream-index: "009" - RingAt: + x-stream-index: "001.005" + updated_at: format: date-time + readOnly: true type: number - writeOnly: true - x-stream-index: "007" - SFUIDs: + x-stream-index: "001.009" + required: + - id + - role + - teams_role + - custom + - banned + - online + - Role + - UserSessionID + - JoinedAt + type: object + CallParticipantCountReport: + properties: + histogram: items: - type: string + $ref: '#/components/schemas/ReportByHistogramBucket' type: array - writeOnly: true - x-stream-index: "015" - SessionID: - type: string - writeOnly: true - x-stream-index: "002.004" - StartedAt: - format: date-time - type: number - writeOnly: true - x-stream-index: "005" - TimerEndsAt: + x-stream-index: "001" + required: + - histogram + type: object + CallParticipantCountReportResponse: + properties: + daily: + items: + $ref: '#/components/schemas/DailyAggregateCallParticipantCountReportResponse' + type: array + x-stream-index: "001" + required: + - daily + type: object + CallParticipantResponse: + properties: + joined_at: format: date-time type: number - writeOnly: true - x-stream-index: "014" - UserPermissionOverrides: - additionalProperties: - additionalProperties: - type: boolean - type: object - type: object - writeOnly: true - x-stream-index: "017" + x-stream-index: "004" + role: + type: string + x-stream-index: "003" + user: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "001" + user_session_id: + type: string + x-stream-index: "002" required: - - AppPK - - CallType - - CallID - - SessionID - - CreatedAt - - AcceptedBy - - RejectedBy - - MissedBy - - Participants - - SFUIDs - - ActiveSFUs - - UserPermissionOverrides - - ParticipantsCountByRole - - AnonymousParticipantCount + - user + - user_session_id + - role + - joined_at type: object - CallSessionEndedEvent: - description: This event is sent when a call session ends + CallReactionEvent: + description: This event is sent when a reaction is sent in a call, clients should + use this to show the reaction in the call screen properties: - call: - $ref: '#/components/schemas/CallResponse' - description: Call object - title: Call - x-stream-index: "004" call_cid: type: string x-stream-index: "002.001" @@ -4014,14 +5256,14 @@ components: format: date-time type: number x-stream-index: "001.002" - session_id: - description: Call session ID - title: Session ID - type: string - x-stream-index: "003.001" + reaction: + $ref: '#/components/schemas/ReactionResponse' + description: the reaction object sent by the user on the call + title: reaction + x-stream-index: "003" type: - default: call.session_ended - description: 'The type of event: "call.session_ended" in this case' + default: call.reaction_new + description: 'The type of event: "call.reaction_new" in this case' title: Event Type type: string x-stream-index: "001.001" @@ -4029,22 +5271,49 @@ components: - type - created_at - call_cid - - session_id - - call - title: CallSessionEndedEvent + - reaction + title: CallReactionEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: session + x-stream-event-doc-group: call x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallSessionParticipantCountsUpdatedEvent: - description: This event is sent when the participant counts in a call session - are updated + CallRecording: + description: CallRecording represents a recording of a call. properties: - anonymous_participant_count: - format: int32 - type: integer + end_time: + format: date-time + title: The end time of the recording. + type: number + x-stream-index: "004" + filename: + title: The filename of the recording. + type: string + x-stream-index: "001" + session_id: + title: The session ID of the recording. + type: string x-stream-index: "005" + start_time: + format: date-time + title: The start time of the recording. + type: number + x-stream-index: "003" + url: + title: The URL of the recording. + type: string + x-stream-index: "002" + required: + - filename + - url + - start_time + - end_time + - session_id + title: CallRecording + type: object + CallRecordingFailedEvent: + description: This event is sent when call recording has failed + properties: call_cid: type: string x-stream-index: "002.001" @@ -4052,21 +5321,12 @@ components: format: date-time type: number x-stream-index: "001.002" - participants_count_by_role: - additionalProperties: - format: int32 - type: integer - type: object - x-stream-index: "004" - session_id: - description: Call session ID - title: Session ID + egress_id: type: string - x-stream-index: "003.001" + x-stream-index: "003" type: - default: call.session_participant_count_updated - description: 'The type of event: "call.session_participant_count_updated" - in this case' + default: call.recording_failed + description: 'The type of event: "call.recording_failed" in this case' title: Event Type type: string x-stream-index: "001.001" @@ -4074,39 +5334,34 @@ components: - type - created_at - call_cid - - session_id - - participants_count_by_role - - anonymous_participant_count - title: CallSessionParticipantCountsUpdatedEvent + - egress_id + title: CallRecordingFailedEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: session + x-stream-event-doc-group: recording x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallSessionParticipantJoinedEvent: - description: This event is sent when a participant joins a call session + CallRecordingReadyEvent: + description: This event is sent when call recording is ready properties: call_cid: type: string x-stream-index: "002.001" + call_recording: + $ref: '#/components/schemas/CallRecording' + description: The call recording object + title: CallRecording + x-stream-index: "003" created_at: format: date-time type: number x-stream-index: "001.002" - participant: - $ref: '#/components/schemas/CallParticipantResponse' - description: The participant that joined the session - title: Participant - x-stream-index: "004" - session_id: - description: Call session ID - title: Session ID + egress_id: type: string - x-stream-index: "003.001" + x-stream-index: "004" type: - default: call.session_participant_joined - description: 'The type of event: "call.session_participant_joined" in this - case' + default: call.recording_ready + description: 'The type of event: "call.recording_ready" in this case' title: Event Type type: string x-stream-index: "001.001" @@ -4114,135 +5369,81 @@ components: - type - created_at - call_cid - - session_id - - participant - title: CallSessionParticipantJoinedEvent + - call_recording + - egress_id + title: CallRecordingReadyEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: session + x-stream-event-doc-group: recording x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallSessionParticipantLeftEvent: - description: This event is sent when a participant leaves a call session + CallRecordingStartedEvent: + description: This event is sent when call recording has started properties: call_cid: type: string - x-stream-index: "002.001" + x-stream-index: "003.001" created_at: format: date-time type: number - x-stream-index: "001.002" - duration_seconds: - description: The duration participant was in the session in seconds - format: int32 - title: Duration - type: integer - x-stream-index: "005" - participant: - $ref: '#/components/schemas/CallParticipantResponse' - description: The participant that left the session - title: Participant - x-stream-index: "004" - session_id: - description: Call session ID - title: Session ID + x-stream-index: "002.002" + egress_id: type: string - x-stream-index: "003.001" + x-stream-index: "001" type: - default: call.session_participant_left - description: 'The type of event: "call.session_participant_left" in this - case' + default: call.recording_started + description: 'The type of event: "call.recording_started" in this case' title: Event Type type: string - x-stream-index: "001.001" + x-stream-index: "002.001" required: + - egress_id - type - created_at - call_cid - - session_id - - participant - - duration_seconds - title: CallSessionParticipantLeftEvent + title: CallRecordingStartedEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: session + x-stream-event-doc-group: recording x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallSessionResponse: + CallRecordingStoppedEvent: + description: This event is sent when call recording has stopped properties: - accepted_by: - additionalProperties: - format: date-time - type: number - type: object - x-stream-index: "008" - anonymous_participant_count: - format: int32 - type: integer - x-stream-index: "006" - ended_at: + call_cid: + type: string + x-stream-index: "003.001" + created_at: format: date-time type: number - x-stream-index: "003" - id: + x-stream-index: "002.002" + egress_id: type: string x-stream-index: "001" - live_ended_at: - format: date-time - type: number - x-stream-index: "011" - live_started_at: - format: date-time - type: number - x-stream-index: "010" - missed_by: - additionalProperties: - format: date-time - type: number - type: object - x-stream-index: "009" - participants: - items: - $ref: '#/components/schemas/CallParticipantResponse' - type: array - x-stream-index: "004" - participants_count_by_role: - additionalProperties: - format: int32 - type: integer - type: object - x-stream-index: "005" - rejected_by: - additionalProperties: - format: date-time - type: number - type: object - x-stream-index: "007" - started_at: - format: date-time - type: number - x-stream-index: "002" - timer_ends_at: - format: date-time - type: number - x-stream-index: "012" + type: + default: call.recording_stopped + description: 'The type of event: "call.recording_stopped" in this case' + title: Event Type + type: string + x-stream-index: "002.001" required: - - id - - participants - - participants_count_by_role - - anonymous_participant_count - - rejected_by - - accepted_by - - missed_by + - egress_id + - type + - created_at + - call_cid + title: CallRecordingStoppedEvent type: object - CallSessionStartedEvent: - description: This event is sent when a call session starts + x-stream-event-call-type: true + x-stream-event-doc-group: recording + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + CallRejectedEvent: + description: This event is sent when a user rejects a notification to join a + call. properties: call: $ref: '#/components/schemas/CallResponse' - description: Call object - title: Call - x-stream-index: "004" + x-stream-index: "003" call_cid: type: string x-stream-index: "002.001" @@ -4250,309 +5451,218 @@ components: format: date-time type: number x-stream-index: "001.002" - session_id: - description: Call session ID - title: Session ID + reason: + description: 'Provides information about why the call was rejected. You + can provide any value, but the Stream API and SDKs use these default values: + rejected, cancel, timeout and busy' + title: Reason type: string - x-stream-index: "003.001" + x-stream-index: "005" type: - default: call.session_started - description: 'The type of event: "call.session_started" in this case' + default: call.rejected + description: 'The type of event: "call.rejected" in this case' title: Event Type type: string x-stream-index: "001.001" + user: + $ref: '#/components/schemas/UserResponse' + description: The user who rejected the call + title: User + x-stream-index: "004" required: - type - created_at - call_cid - - session_id - call - title: CallSessionStartedEvent + - user + title: CallRejectedEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: session + x-stream-event-doc-group: ring x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallSettings: + CallReportResponse: properties: - audio: - $ref: '#/components/schemas/AudioSettings' + ended_at: + format: date-time + type: number + x-stream-index: "003" + score: + format: float + type: number x-stream-index: "001" - backstage: - $ref: '#/components/schemas/BackstageSettings' + started_at: + format: date-time + type: number x-stream-index: "002" - broadcasting: - $ref: '#/components/schemas/BroadcastSettings' - x-stream-index: "007" - frame_recording: - $ref: '#/components/schemas/FrameRecordSettings' - x-stream-index: "006" - geofencing: - $ref: '#/components/schemas/GeofenceSettings' - x-stream-index: "008" - ingress: - $ref: '#/components/schemas/IngressSettings' - x-stream-index: "014" - limits: - $ref: '#/components/schemas/LimitsSettings' - x-stream-index: "012" - recording: - $ref: '#/components/schemas/RecordSettings' - x-stream-index: "005" - ring: - $ref: '#/components/schemas/RingSettings' - x-stream-index: "010" - screensharing: - $ref: '#/components/schemas/ScreensharingSettings' - x-stream-index: "004" - session: - $ref: '#/components/schemas/SessionSettings' - x-stream-index: "013" - thumbnails: - $ref: '#/components/schemas/ThumbnailsSettings' - x-stream-index: "011" - transcription: - $ref: '#/components/schemas/TranscriptionSettings' - x-stream-index: "009" - video: - $ref: '#/components/schemas/VideoSettings' - x-stream-index: "003" + required: + - score type: object - CallSettingsRequest: + CallRequest: + description: CallRequest is the payload for creating a call. properties: - audio: - $ref: '#/components/schemas/AudioSettingsRequest' - x-stream-index: "001" - backstage: - $ref: '#/components/schemas/BackstageSettingsRequest' - x-stream-index: "002" - broadcasting: - $ref: '#/components/schemas/BroadcastSettingsRequest' - x-stream-index: "010" - frame_recording: - $ref: '#/components/schemas/FrameRecordingSettingsRequest' - x-stream-index: "006" - geofencing: - $ref: '#/components/schemas/GeofenceSettingsRequest' - x-stream-index: "003" - ingress: - $ref: '#/components/schemas/IngressSettingsRequest' - x-stream-index: "014" - limits: - $ref: '#/components/schemas/LimitsSettingsRequest' - x-stream-index: "012" - recording: - $ref: '#/components/schemas/RecordSettingsRequest' - x-stream-index: "005" - ring: - $ref: '#/components/schemas/RingSettingsRequest' - x-stream-index: "007" - screensharing: - $ref: '#/components/schemas/ScreensharingSettingsRequest' - x-stream-index: "008" - session: - $ref: '#/components/schemas/SessionSettingsRequest' - x-stream-index: "013" - thumbnails: - $ref: '#/components/schemas/ThumbnailsSettingsRequest' - x-stream-index: "011" - transcription: - $ref: '#/components/schemas/TranscriptionSettingsRequest' + channel_cid: + type: string x-stream-index: "009" - video: - $ref: '#/components/schemas/VideoSettingsRequest' - x-stream-index: "004" - type: object - CallSettingsResponse: - properties: - audio: - $ref: '#/components/schemas/AudioSettingsResponse' - x-stream-index: "001" - backstage: - $ref: '#/components/schemas/BackstageSettingsResponse' + created_by: + $ref: '#/components/schemas/UserRequest' + title: The user that create this call x-stream-index: "002" - broadcasting: - $ref: '#/components/schemas/BroadcastSettingsResponse' + created_by_id: + title: The id of the user that create this call + type: string x-stream-index: "003" - frame_recording: - $ref: '#/components/schemas/FrameRecordingSettingsResponse' - x-stream-index: "006" - geofencing: - $ref: '#/components/schemas/GeofenceSettingsResponse' + custom: + additionalProperties: {} + type: object x-stream-index: "004" - ingress: - $ref: '#/components/schemas/IngressSettingsResponse' - x-stream-index: "014" - limits: - $ref: '#/components/schemas/LimitsSettingsResponse' - x-stream-index: "012" - recording: - $ref: '#/components/schemas/RecordSettingsResponse' - x-stream-index: "005" - ring: - $ref: '#/components/schemas/RingSettingsResponse' - x-stream-index: "007" - screensharing: - $ref: '#/components/schemas/ScreensharingSettingsResponse' - x-stream-index: "008" - session: - $ref: '#/components/schemas/SessionSettingsResponse' - x-stream-index: "013" - thumbnails: - $ref: '#/components/schemas/ThumbnailsSettingsResponse' - x-stream-index: "011" - transcription: - $ref: '#/components/schemas/TranscriptionSettingsResponse' - x-stream-index: "009" - video: - $ref: '#/components/schemas/VideoSettingsResponse' - x-stream-index: "010" - required: - - audio - - backstage - - broadcasting - - geofencing - - recording - - frame_recording - - ring - - screensharing - - transcription - - video - - thumbnails - - limits - - session - type: object - CallStateResponseFields: - description: CallStateResponseFields is the payload for call state response - properties: - call: - $ref: '#/components/schemas/CallResponse' - x-stream-index: "001" members: - description: List of call members - items: - $ref: '#/components/schemas/MemberResponse' - title: Members - type: array - x-stream-index: "002" - own_capabilities: items: - $ref: '#/components/schemas/OwnCapability' + $ref: '#/components/schemas/MemberRequest' + maximum: 100 type: array - x-stream-index: "004" - required: - - call - - members - - own_capabilities - - blocked_users - title: CallStateResponseFields - type: object - CallStatsReportReadyEvent: - description: This event is sent when the insights report is ready - properties: - call_cid: - type: string - x-stream-index: "002.001" - created_at: + x-stream-index: "005" + settings_override: + $ref: '#/components/schemas/CallSettingsRequest' + x-stream-index: "006" + starts_at: format: date-time type: number - x-stream-index: "001.002" - session_id: - description: Call session ID - title: Session ID - type: string - x-stream-index: "003.001" - type: - default: call.stats_report_ready - description: The type of event, "call.report_ready" in this case - title: Event Type - type: string - x-stream-index: "001.001" - required: - - type - - created_at - - call_cid - - session_id - title: CallStatsReportReadyEvent - type: object - x-stream-event-call-type: true - x-stream-event-doc-group: other - x-stream-is-event: true - x-stream-ws-base-event-name: VideoEvent - CallStatsReportSummaryResponse: - properties: - call_cid: + x-stream-index: "007" + team: type: string x-stream-index: "001" - call_duration_seconds: - format: int32 - type: integer + video: + type: boolean x-stream-index: "008" - call_session_id: + title: CallRequest + type: object + CallResponse: + description: Represents a call + properties: + backstage: + type: boolean + x-stream-index: "016" + blocked_user_ids: + items: + type: string + type: array + x-stream-index: "018" + captioning: + type: boolean + x-stream-index: "013" + channel_cid: type: string - x-stream-index: "002" - call_status: + x-stream-index: "024" + cid: + description: The unique identifier for a call (:) + title: CID type: string x-stream-index: "004" created_at: + description: Date/time of creation format: date-time + title: Created at type: number + x-stream-index: "009" + created_by: + $ref: '#/components/schemas/UserResponse' + description: The user that created the call + title: Created By x-stream-index: "007" - first_stats_time: + current_session_id: + type: string + x-stream-index: "005" + custom: + additionalProperties: {} + description: Custom data for this object + title: Custom data + type: object + x-stream-index: "008" + egress: + $ref: '#/components/schemas/EgressResponse' + x-stream-index: "021" + ended_at: + description: Date/time when the call ended format: date-time + title: Ended At type: number + x-stream-index: "014" + id: + description: Call ID + title: ID + type: string x-stream-index: "003" - min_user_rating: - format: int32 - type: integer - x-stream-index: "006" - quality_score: + ingress: + $ref: '#/components/schemas/CallIngressResponse' + x-stream-index: "019" + join_ahead_time_seconds: format: int32 type: integer - x-stream-index: "005" - required: - - call_cid - - call_session_id - - first_stats_time - - call_status - - call_duration_seconds - type: object - CallTranscription: - description: CallTranscription represents a transcription of a call. - properties: - end_time: + x-stream-index: "023" + recording: + type: boolean + x-stream-index: "011" + session: + $ref: '#/components/schemas/CallSessionResponse' + x-stream-index: "020" + settings: + $ref: '#/components/schemas/CallSettingsResponse' + x-stream-index: "017" + starts_at: + description: Date/time when the call will start format: date-time - title: The end time of the transcription. + title: Starts At type: number - x-stream-index: "004" - filename: - title: The filename of the transcription. + x-stream-index: "015" + team: type: string - x-stream-index: "001" - session_id: - title: The session ID of the transcription. + x-stream-index: "006" + thumbnails: + $ref: '#/components/schemas/ThumbnailResponse' + x-stream-index: "022" + transcribing: + type: boolean + x-stream-index: "012" + type: + description: The type of call + title: Type type: string - x-stream-index: "005" - start_time: + x-stream-index: "002" + updated_at: + description: Date/time of the last update format: date-time - title: The start time of the transcription. + title: Updated at type: number - x-stream-index: "003" - url: - title: The URL of the transcription. - type: string - x-stream-index: "002" + x-stream-index: "010" required: - - filename - - url - - start_time - - end_time - - session_id - title: CallTranscription + - type + - id + - cid + - current_session_id + - created_by + - custom + - created_at + - updated_at + - recording + - transcribing + - captioning + - backstage + - settings + - blocked_user_ids + - ingress + - egress + title: CallResponse type: object - CallTranscriptionFailedEvent: - description: This event is sent when call transcription has failed + CallRingEvent: + description: This event is sent to all call members to notify they are getting + called properties: + call: + $ref: '#/components/schemas/CallResponse' + description: Call object + title: Call + x-stream-index: "005" call_cid: type: string x-stream-index: "002.001" @@ -4560,52 +5670,69 @@ components: format: date-time type: number x-stream-index: "001.002" - egress_id: - type: string - x-stream-index: "003" - error: - description: The error message detailing why transcription failed. - title: string + members: + description: Call members + items: + $ref: '#/components/schemas/MemberResponse' + title: Members + type: array + x-stream-index: "006" + session_id: + description: Call session ID + title: Session ID type: string - x-stream-index: "004" + x-stream-index: "003.001" type: - default: call.transcription_failed - description: 'The type of event: "call.transcription_failed" in this case' + default: call.ring + description: 'The type of event: "call.notification" in this case' title: Event Type type: string x-stream-index: "001.001" + user: + $ref: '#/components/schemas/UserResponse' + description: The user that sent the call notification + title: User + x-stream-index: "007" + video: + type: boolean + x-stream-index: "008" required: - type - created_at - call_cid - - egress_id - title: CallTranscriptionFailedEvent + - session_id + - call + - members + - user + - video + title: CallRingEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: transcription + x-stream-event-doc-group: ring x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallTranscriptionReadyEvent: - description: This event is sent when call transcription is ready + CallRtmpBroadcastFailedEvent: + description: This event is sent when a call RTMP broadcast has failed properties: call_cid: + description: The unique identifier for a call (:) + title: CID type: string x-stream-index: "002.001" - call_transcription: - $ref: '#/components/schemas/CallTranscription' - description: The call transcription object - title: CallTranscription - x-stream-index: "003" created_at: + description: Date/time of creation format: date-time + title: Created at type: number x-stream-index: "001.002" - egress_id: + name: + description: Name of the given RTMP broadcast + title: Name type: string - x-stream-index: "004" + x-stream-index: "003" type: - default: call.transcription_ready - description: 'The type of event: "call.transcription_ready" in this case' + default: call.rtmp_broadcast_failed + description: 'The type of event: "call.rtmp_broadcast_failed" in this case' title: Event Type type: string x-stream-index: "001.001" @@ -4613,60 +5740,71 @@ components: - type - created_at - call_cid - - call_transcription - - egress_id - title: CallTranscriptionReadyEvent + - name + title: CallRtmpBroadcastFailedEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: transcription + x-stream-event-doc-group: streaming x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallTranscriptionStartedEvent: - description: This event is sent when call transcription has started + CallRtmpBroadcastStartedEvent: + description: This event is sent when RTMP broadcast has started properties: call_cid: + description: The unique identifier for a call (:) + title: CID type: string - x-stream-index: "003.001" + x-stream-index: "002.001" created_at: + description: Date/time of creation format: date-time + title: Created at type: number - x-stream-index: "002.002" - egress_id: + x-stream-index: "001.002" + name: + description: Name of the given RTMP broadcast + title: Name type: string - x-stream-index: "001" + x-stream-index: "003" type: - default: call.transcription_started - description: 'The type of event: "call.transcription_started" in this case' + default: call.rtmp_broadcast_started + description: 'The type of event: "call.rtmp_broadcast_started" in this case' title: Event Type type: string - x-stream-index: "002.001" + x-stream-index: "001.001" required: - - egress_id - type - created_at - call_cid - title: CallTranscriptionStartedEvent + - name + title: CallRtmpBroadcastStartedEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: transcription + x-stream-event-doc-group: streaming x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallTranscriptionStoppedEvent: - description: This event is sent when call transcription has stopped + CallRtmpBroadcastStoppedEvent: + description: This event is sent when RTMP broadcast has stopped properties: call_cid: + description: The unique identifier for a call (:) + title: CID type: string x-stream-index: "002.001" created_at: + description: Date/time of creation format: date-time + title: Created at type: number x-stream-index: "001.002" - egress_id: + name: + description: Name of the given RTMP broadcast + title: Name type: string x-stream-index: "003" type: - default: call.transcription_stopped - description: 'The type of event: "call.transcription_stopped" in this case' + default: call.rtmp_broadcast_stopped + description: 'The type of event: "call.rtmp_broadcast_stopped" in this case' title: Event Type type: string x-stream-index: "001.001" @@ -4674,140 +5812,170 @@ components: - type - created_at - call_cid - - egress_id - title: CallTranscriptionStoppedEvent + - name + title: CallRtmpBroadcastStoppedEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: transcription + x-stream-event-doc-group: streaming x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallType: - nullable: true + CallSession: properties: - AppPK: + AcceptedBy: + additionalProperties: + format: date-time + type: number + type: object + writeOnly: true + x-stream-index: "008" + ActiveSFUs: + items: + $ref: '#/components/schemas/SFUIDLastSeen' + type: array + writeOnly: true + x-stream-index: "016" + AnonymousParticipantCount: format: int32 type: integer writeOnly: true - x-stream-index: "003" - CreatedAt: - format: date-time - type: number + x-stream-index: "019" + AppPK: + format: int32 + type: integer writeOnly: true - x-stream-index: "005" - ExternalStorage: + x-stream-index: "002.001" + CallID: type: string writeOnly: true - x-stream-index: "009" - Name: + x-stream-index: "002.003" + CallType: type: string writeOnly: true - x-stream-index: "004" - NotificationSettings: - $ref: '#/components/schemas/NotificationSettings' - x-stream-index: "008" - PK: - format: int32 - type: integer + x-stream-index: "002.002" + CreatedAt: + format: date-time + type: number writeOnly: true - x-stream-index: "002" - Settings: - $ref: '#/components/schemas/CallSettings' - x-stream-index: "007" - UpdatedAt: + x-stream-index: "003" + DeletedAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "004" + EndedAt: format: date-time type: number writeOnly: true x-stream-index: "006" - required: - - PK - - AppPK - - Name - - CreatedAt - - UpdatedAt - - ExternalStorage - type: object - CallTypeResponse: - description: CallTypeResponse is the payload for a call type. - properties: - created_at: - description: the time the call type was created + LiveEndedAt: format: date-time - title: CreatedAt type: number - x-stream-index: "005" - external_storage: - description: the external storage for the call type - title: ExternalStorage - type: string - x-stream-index: "007" - grants: + writeOnly: true + x-stream-index: "013" + LiveStartedAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "012" + MissedBy: additionalProperties: - items: - type: string - type: array - description: the permissions granted to each role - title: Grants + format: date-time + type: number type: object - x-stream-index: "002" - name: - description: the name of the call type - title: Name + writeOnly: true + x-stream-index: "010" + Participants: + items: + $ref: '#/components/schemas/CallParticipant' + type: array + writeOnly: true + x-stream-index: "011" + ParticipantsCountByRole: + additionalProperties: + format: int32 + type: integer + type: object + writeOnly: true + x-stream-index: "018" + RejectedBy: + additionalProperties: + format: date-time + type: number + type: object + writeOnly: true + x-stream-index: "009" + RingAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "007" + SFUIDs: + items: + type: string + type: array + writeOnly: true + x-stream-index: "015" + SessionID: type: string - x-stream-index: "001" - notification_settings: - $ref: '#/components/schemas/NotificationSettings' - description: the notification settings for the call type - title: NotificationSettings - x-stream-index: "004" - settings: - $ref: '#/components/schemas/CallSettingsResponse' - description: the settings for the call type - title: Settings - x-stream-index: "003" - updated_at: - description: the time the call type was last updated + writeOnly: true + x-stream-index: "002.004" + StartedAt: format: date-time - title: UpdatedAt type: number - x-stream-index: "006" + writeOnly: true + x-stream-index: "005" + TimerEndsAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "014" + UserPermissionOverrides: + additionalProperties: + additionalProperties: + type: boolean + type: object + type: object + writeOnly: true + x-stream-index: "017" required: - - name - - grants - - settings - - notification_settings - - created_at - - updated_at - title: CallTypeResponse + - AppPK + - CallType + - CallID + - SessionID + - CreatedAt + - AcceptedBy + - RejectedBy + - MissedBy + - Participants + - SFUIDs + - ActiveSFUs + - UserPermissionOverrides + - ParticipantsCountByRole + - AnonymousParticipantCount type: object - CallUpdatedEvent: - description: |- - This event is sent when a call is updated, clients should use this update the local state of the call. - This event also contains the capabilities by role for the call, clients should update the own_capability for the current. + CallSessionEndedEvent: + description: This event is sent when a call session ends properties: call: $ref: '#/components/schemas/CallResponse' description: Call object title: Call - x-stream-index: "003" + x-stream-index: "004" call_cid: type: string x-stream-index: "002.001" - capabilities_by_role: - additionalProperties: - items: - type: string - type: array - description: The capabilities by role for this call - title: CapabilitiesByRole - type: object - x-stream-index: "004" created_at: format: date-time type: number x-stream-index: "001.002" + session_id: + description: Call session ID + title: Session ID + type: string + x-stream-index: "003.001" type: - default: call.updated - description: 'The type of event: "call.ended" in this case' + default: call.session_ended + description: 'The type of event: "call.session_ended" in this case' title: Event Type type: string x-stream-index: "001.001" @@ -4815,17 +5983,22 @@ components: - type - created_at - call_cid + - session_id - call - - capabilities_by_role - title: CallUpdatedEvent + title: CallSessionEndedEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: call + x-stream-event-doc-group: session x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallUserFeedbackSubmittedEvent: - description: This event is sent when a user submits feedback for a call. + CallSessionParticipantCountsUpdatedEvent: + description: This event is sent when the participant counts in a call session + are updated properties: + anonymous_participant_count: + format: int32 + type: integer + x-stream-index: "005" call_cid: type: string x-stream-index: "002.001" @@ -4833,60 +6006,39 @@ components: format: date-time type: number x-stream-index: "001.002" - custom: - additionalProperties: {} - description: Custom data provided by the user - title: Custom + participants_count_by_role: + additionalProperties: + format: int32 + type: integer type: object - x-stream-index: "007" - rating: - description: The rating given by the user (1-5) - format: int32 - title: Rating - type: integer - x-stream-index: "005" - reason: - description: The reason provided by the user for the rating - title: Reason - type: string - x-stream-index: "006" - sdk: - type: string - x-stream-index: "008" - sdk_version: - type: string - x-stream-index: "009" + x-stream-index: "004" session_id: description: Call session ID title: Session ID type: string x-stream-index: "003.001" type: - default: call.user_feedback_submitted - description: The type of event, "call.user_feedback" in this case + default: call.session_participant_count_updated + description: 'The type of event: "call.session_participant_count_updated" + in this case' title: Event Type type: string x-stream-index: "001.001" - user: - $ref: '#/components/schemas/UserResponse' - description: The user who submitted the feedback - title: User - x-stream-index: "004" required: - type - created_at - call_cid - session_id - - user - - rating - title: CallUserFeedbackSubmittedEvent + - participants_count_by_role + - anonymous_participant_count + title: CallSessionParticipantCountsUpdatedEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: other + x-stream-event-doc-group: session x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallUserMutedEvent: - description: This event is sent when a call member is muted + CallSessionParticipantJoinedEvent: + description: This event is sent when a participant joins a call session properties: call_cid: type: string @@ -4895,17 +6047,20 @@ components: format: date-time type: number x-stream-index: "001.002" - from_user_id: - type: string - x-stream-index: "003" - muted_user_ids: - items: - type: string - type: array + participant: + $ref: '#/components/schemas/CallParticipantResponse' + description: The participant that joined the session + title: Participant x-stream-index: "004" + session_id: + description: Call session ID + title: Session ID + type: string + x-stream-index: "003.001" type: - default: call.user_muted - description: 'The type of event: "call.user_muted" in this case' + default: call.session_participant_joined + description: 'The type of event: "call.session_participant_joined" in this + case' title: Event Type type: string x-stream-index: "001.001" @@ -4913,2354 +6068,2800 @@ components: - type - created_at - call_cid - - from_user_id - - muted_user_ids - title: CallUserMutedEvent + - session_id + - participant + title: CallSessionParticipantJoinedEvent type: object x-stream-event-call-type: true - x-stream-event-doc-group: call + x-stream-event-doc-group: session x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CallsPerDayReport: - properties: - count: - format: int64 - type: integer - x-stream-index: "001" - required: - - count - type: object - CallsPerDayReportResponse: - properties: - daily: - items: - $ref: '#/components/schemas/DailyAggregateCallsPerDayReportResponse' - type: array - x-stream-index: "001" - required: - - daily - type: object - CampaignChannelTemplate: + CallSessionParticipantLeftEvent: + description: This event is sent when a participant leaves a call session properties: - custom: - additionalProperties: {} - type: object - x-stream-index: "005" - id: - type: string - x-stream-index: "002" - members: - items: - type: string - maximum: 1000 - type: array - x-stream-index: "003" - team: - maxLength: 1000 - type: string - x-stream-index: "004" - type: - maxLength: 64 + call_cid: type: string - x-stream-index: "001" - required: - - type - - custom - type: object - CampaignCompletedEvent: - nullable: true - properties: - campaign: - $ref: '#/components/schemas/CampaignResponse' - x-stream-index: "002" + x-stream-index: "002.001" created_at: format: date-time type: number - x-stream-index: "001.003" - custom: - additionalProperties: {} - type: object - x-stream-index: "001.007" - received_at: - format: date-time - type: number - x-stream-index: "001.004" + x-stream-index: "001.002" + duration_seconds: + description: The duration participant was in the session in seconds + format: int32 + title: Duration + type: integer + x-stream-index: "005" + participant: + $ref: '#/components/schemas/CallParticipantResponse' + description: The participant that left the session + title: Participant + x-stream-index: "004" + session_id: + description: Call session ID + title: Session ID + type: string + x-stream-index: "003.001" type: - default: campaign.completed + default: call.session_participant_left + description: 'The type of event: "call.session_participant_left" in this + case' + title: Event Type type: string - x-stream-index: "001.002" + x-stream-index: "001.001" required: - type - created_at - - custom - title: CampaignCompletedEvent + - call_cid + - session_id + - participant + - duration_seconds + title: CallSessionParticipantLeftEvent type: object - x-stream-event-client-type: true - x-stream-event-doc-group: other + x-stream-event-call-type: true + x-stream-event-doc-group: session x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CampaignMessageTemplate: + CallSessionResponse: properties: - attachments: - items: - $ref: '#/components/schemas/Attachment' - maximum: 30 - type: array - x-stream-index: "002" - custom: - additionalProperties: {} + accepted_by: + additionalProperties: + format: date-time + type: number type: object - x-stream-index: "004" - poll_id: - type: string - x-stream-index: "003" - text: - type: string - x-stream-index: "001" - required: - - text - - attachments - - poll_id - - custom - type: object - CampaignResponse: - properties: - channel_template: - $ref: '#/components/schemas/CampaignChannelTemplate' - x-stream-index: "016" - create_channels: - type: boolean x-stream-index: "008" - created_at: + anonymous_participant_count: + format: int32 + type: integer + x-stream-index: "006" + ended_at: format: date-time type: number - x-stream-index: "020" - description: - type: string - x-stream-index: "010" + x-stream-index: "003" id: type: string x-stream-index: "001" - message_template: - $ref: '#/components/schemas/CampaignMessageTemplate' - x-stream-index: "015" - name: - type: string - x-stream-index: "007" - scheduled_for: + live_ended_at: format: date-time type: number - x-stream-index: "013" - segment_ids: - items: - type: string - type: array - x-stream-index: "002" - segments: + x-stream-index: "011" + live_started_at: + format: date-time + type: number + x-stream-index: "010" + missed_by: + additionalProperties: + format: date-time + type: number + type: object + x-stream-index: "009" + participants: items: - $ref: '#/components/schemas/Segment' + $ref: '#/components/schemas/CallParticipantResponse' type: array - x-stream-index: "003" - sender: - $ref: '#/components/schemas/UserResponse' - x-stream-index: "005" - sender_id: - type: string x-stream-index: "004" - sender_mode: - type: string - x-stream-index: "006" - show_channels: - type: boolean - x-stream-index: "009" - skip_push: - type: boolean - x-stream-index: "011" - skip_webhook: - type: boolean - x-stream-index: "012" - stats: - $ref: '#/components/schemas/CampaignStatsResponse' - x-stream-index: "022" - status: - type: string - x-stream-index: "019" - stop_at: + participants_count_by_role: + additionalProperties: + format: int32 + type: integer + type: object + x-stream-index: "005" + rejected_by: + additionalProperties: + format: date-time + type: number + type: object + x-stream-index: "007" + started_at: format: date-time type: number - x-stream-index: "014" - updated_at: + x-stream-index: "002" + timer_ends_at: format: date-time type: number - x-stream-index: "021" - user_ids: - items: - type: string - type: array - x-stream-index: "017" - users: - items: - $ref: '#/components/schemas/UserResponse' - type: array - x-stream-index: "018" + x-stream-index: "012" required: - id - - segment_ids - - segments - - sender_id - - sender_mode - - name - - create_channels - - show_channels - - description - - skip_push - - skip_webhook - - user_ids - - users - - status - - created_at - - updated_at - - stats + - participants + - participants_count_by_role + - anonymous_participant_count + - rejected_by + - accepted_by + - missed_by type: object - CampaignStartedEvent: - nullable: true + CallSessionStartedEvent: + description: This event is sent when a call session starts properties: - campaign: - $ref: '#/components/schemas/CampaignResponse' - x-stream-index: "002" + call: + $ref: '#/components/schemas/CallResponse' + description: Call object + title: Call + x-stream-index: "004" + call_cid: + type: string + x-stream-index: "002.001" created_at: format: date-time type: number - x-stream-index: "001.003" - custom: - additionalProperties: {} - type: object - x-stream-index: "001.007" - received_at: - format: date-time - type: number - x-stream-index: "001.004" + x-stream-index: "001.002" + session_id: + description: Call session ID + title: Session ID + type: string + x-stream-index: "003.001" type: - default: campaign.started + default: call.session_started + description: 'The type of event: "call.session_started" in this case' + title: Event Type type: string - x-stream-index: "001.002" + x-stream-index: "001.001" required: - type - created_at - - custom - title: CampaignStartedEvent + - call_cid + - session_id + - call + title: CallSessionStartedEvent type: object - x-stream-event-client-type: true - x-stream-event-doc-group: other + x-stream-event-call-type: true + x-stream-event-doc-group: session x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CampaignStatsResponse: + CallSettings: properties: - progress: - format: float - type: number + audio: + $ref: '#/components/schemas/AudioSettings' + x-stream-index: "001" + backstage: + $ref: '#/components/schemas/BackstageSettings' + x-stream-index: "002" + broadcasting: + $ref: '#/components/schemas/BroadcastSettings' + x-stream-index: "007" + frame_recording: + $ref: '#/components/schemas/FrameRecordSettings' + x-stream-index: "006" + geofencing: + $ref: '#/components/schemas/GeofenceSettings' + x-stream-index: "008" + ingress: + $ref: '#/components/schemas/IngressSettings' + x-stream-index: "014" + limits: + $ref: '#/components/schemas/LimitsSettings' + x-stream-index: "012" + recording: + $ref: '#/components/schemas/RecordSettings' x-stream-index: "005" - stats_channels_created: - format: int32 - type: integer + ring: + $ref: '#/components/schemas/RingSettings' + x-stream-index: "010" + screensharing: + $ref: '#/components/schemas/ScreensharingSettings' x-stream-index: "004" - stats_completed_at: - format: date-time - type: number - x-stream-index: "002" - stats_messages_sent: - format: int32 - type: integer + session: + $ref: '#/components/schemas/SessionSettings' + x-stream-index: "013" + thumbnails: + $ref: '#/components/schemas/ThumbnailsSettings' + x-stream-index: "011" + transcription: + $ref: '#/components/schemas/TranscriptionSettings' + x-stream-index: "009" + video: + $ref: '#/components/schemas/VideoSettings' x-stream-index: "003" - stats_started_at: - format: date-time - type: number + type: object + CallSettingsRequest: + properties: + audio: + $ref: '#/components/schemas/AudioSettingsRequest' x-stream-index: "001" - stats_users_read: - format: int32 - type: integer - x-stream-index: "007" - stats_users_sent: - format: int32 - type: integer + backstage: + $ref: '#/components/schemas/BackstageSettingsRequest' + x-stream-index: "002" + broadcasting: + $ref: '#/components/schemas/BroadcastSettingsRequest' + x-stream-index: "010" + frame_recording: + $ref: '#/components/schemas/FrameRecordingSettingsRequest' x-stream-index: "006" - required: - - stats_started_at - - stats_completed_at - - stats_messages_sent - - stats_channels_created - - progress - - stats_users_sent - - stats_users_read + geofencing: + $ref: '#/components/schemas/GeofenceSettingsRequest' + x-stream-index: "003" + ingress: + $ref: '#/components/schemas/IngressSettingsRequest' + x-stream-index: "014" + limits: + $ref: '#/components/schemas/LimitsSettingsRequest' + x-stream-index: "012" + recording: + $ref: '#/components/schemas/RecordSettingsRequest' + x-stream-index: "005" + ring: + $ref: '#/components/schemas/RingSettingsRequest' + x-stream-index: "007" + screensharing: + $ref: '#/components/schemas/ScreensharingSettingsRequest' + x-stream-index: "008" + session: + $ref: '#/components/schemas/SessionSettingsRequest' + x-stream-index: "013" + thumbnails: + $ref: '#/components/schemas/ThumbnailsSettingsRequest' + x-stream-index: "011" + transcription: + $ref: '#/components/schemas/TranscriptionSettingsRequest' + x-stream-index: "009" + video: + $ref: '#/components/schemas/VideoSettingsRequest' + x-stream-index: "004" type: object - CastPollVoteRequest: - nullable: true + CallSettingsResponse: properties: - user: - $ref: '#/components/schemas/UserRequest' - x-stream-index: "005.002" - user_id: - type: string - x-stream-index: "005.001" - vote: - $ref: '#/components/schemas/VoteData' - description: Vote data - title: VoteData + audio: + $ref: '#/components/schemas/AudioSettingsResponse' + x-stream-index: "001" + backstage: + $ref: '#/components/schemas/BackstageSettingsResponse' + x-stream-index: "002" + broadcasting: + $ref: '#/components/schemas/BroadcastSettingsResponse' + x-stream-index: "003" + frame_recording: + $ref: '#/components/schemas/FrameRecordingSettingsResponse' + x-stream-index: "006" + geofencing: + $ref: '#/components/schemas/GeofenceSettingsResponse' x-stream-index: "004" + ingress: + $ref: '#/components/schemas/IngressSettingsResponse' + x-stream-index: "014" + limits: + $ref: '#/components/schemas/LimitsSettingsResponse' + x-stream-index: "012" + recording: + $ref: '#/components/schemas/RecordSettingsResponse' + x-stream-index: "005" + ring: + $ref: '#/components/schemas/RingSettingsResponse' + x-stream-index: "007" + screensharing: + $ref: '#/components/schemas/ScreensharingSettingsResponse' + x-stream-index: "008" + session: + $ref: '#/components/schemas/SessionSettingsResponse' + x-stream-index: "013" + thumbnails: + $ref: '#/components/schemas/ThumbnailsSettingsResponse' + x-stream-index: "011" + transcription: + $ref: '#/components/schemas/TranscriptionSettingsResponse' + x-stream-index: "009" + video: + $ref: '#/components/schemas/VideoSettingsResponse' + x-stream-index: "010" + required: + - audio + - backstage + - broadcasting + - geofencing + - recording + - frame_recording + - ring + - screensharing + - transcription + - video + - thumbnails + - limits + - session type: object - Channel: + CallStateResponseFields: + description: CallStateResponseFields is the payload for call state response properties: - active_live_locations: + call: + $ref: '#/components/schemas/CallResponse' + x-stream-index: "001" + members: + description: List of call members items: - $ref: '#/components/schemas/SharedLocation' + $ref: '#/components/schemas/MemberResponse' + title: Members type: array - x-stream-index: "034" - auto_translation_enabled: - type: boolean - x-stream-index: "029" - auto_translation_language: - type: string - x-stream-index: "030" - cid: + x-stream-index: "002" + own_capabilities: + items: + $ref: '#/components/schemas/OwnCapability' + type: array + x-stream-index: "004" + required: + - call + - members + - own_capabilities + - blocked_users + title: CallStateResponseFields + type: object + CallStatsReportReadyEvent: + description: This event is sent when the insights report is ready + properties: + call_cid: type: string - x-stream-index: "003" - config: - $ref: '#/components/schemas/ChannelConfig' - x-stream-index: "026" - config_overrides: - $ref: '#/components/schemas/ConfigOverrides' - x-stream-index: "027" - cooldown: - format: int32 - type: integer - x-stream-index: "031" + x-stream-index: "002.001" created_at: format: date-time type: number - x-stream-index: "009" - created_by: - $ref: '#/components/schemas/User' + x-stream-index: "001.002" + session_id: + description: Call session ID + title: Session ID + type: string + x-stream-index: "003.001" + type: + default: call.stats_report_ready + description: The type of event, "call.report_ready" in this case + title: Event Type + type: string + x-stream-index: "001.001" + required: + - type + - created_at + - call_cid + - session_id + title: CallStatsReportReadyEvent + type: object + x-stream-event-call-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + CallStatsReportSummaryResponse: + properties: + call_cid: + type: string + x-stream-index: "001" + call_duration_seconds: + format: int32 + type: integer x-stream-index: "008" - custom: - additionalProperties: {} - type: object - x-stream-index: "019" - deleted_at: - format: date-time - type: number - x-stream-index: "011" - disabled: - type: boolean - x-stream-index: "017" - frozen: - type: boolean - x-stream-index: "016" - id: + call_session_id: type: string - x-stream-index: "004" - invites: - items: - $ref: '#/components/schemas/ChannelMember' - type: array - x-stream-index: "022" - last_campaigns: + x-stream-index: "002" + call_status: type: string - x-stream-index: "032" - last_message_at: + x-stream-index: "004" + created_at: + format: date-time + type: number + x-stream-index: "007" + first_stats_time: format: date-time type: number + x-stream-index: "003" + min_user_rating: + format: int32 + type: integer x-stream-index: "006" - member_count: + quality_score: format: int32 type: integer - x-stream-index: "021" - members: - items: - $ref: '#/components/schemas/ChannelMember' - type: array - x-stream-index: "020" - team: + x-stream-index: "005" + required: + - call_cid + - call_session_id + - first_stats_time + - call_status + - call_duration_seconds + type: object + CallTranscription: + description: CallTranscription represents a transcription of a call. + properties: + end_time: + format: date-time + title: The end time of the transcription. + type: number + x-stream-index: "004" + filename: + title: The filename of the transcription. type: string - x-stream-index: "028" - truncated_by: - $ref: '#/components/schemas/User' - x-stream-index: "015" - type: + x-stream-index: "001" + session_id: + title: The session ID of the transcription. type: string x-stream-index: "005" - updated_at: + start_time: format: date-time + title: The start time of the transcription. type: number - x-stream-index: "010" + x-stream-index: "003" + url: + title: The URL of the transcription. + type: string + x-stream-index: "002" required: - - cid - - id - - type - - created_at - - updated_at - - frozen - - disabled - - custom - - auto_translation_language + - filename + - url + - start_time + - end_time + - session_id + title: CallTranscription type: object - ChannelConfig: + CallTranscriptionFailedEvent: + description: This event is sent when call transcription has failed properties: - allowed_flag_reasons: - items: - type: string - type: array - x-stream-index: "001.026" - automod: - enum: - - disabled - - simple - - AI + call_cid: type: string - x-stream-index: "001.021" - automod_behavior: - enum: - - flag - - block - - shadow_block + x-stream-index: "002.001" + created_at: + format: date-time + type: number + x-stream-index: "001.002" + egress_id: type: string - x-stream-index: "001.022" - automod_thresholds: - $ref: '#/components/schemas/Thresholds' - x-stream-index: "001.027" - blocklist: + x-stream-index: "003" + error: + description: The error message detailing why transcription failed. + title: string type: string - x-stream-index: "001.023" - blocklist_behavior: - enum: - - flag - - block - - shadow_block + x-stream-index: "004" + type: + default: call.transcription_failed + description: 'The type of event: "call.transcription_failed" in this case' + title: Event Type type: string - x-stream-index: "001.024" - blocklists: - items: - $ref: '#/components/schemas/BlockListOptions' - type: array - x-stream-index: "001.025" - commands: - items: - type: string - type: array + x-stream-index: "001.001" + required: + - type + - created_at + - call_cid + - egress_id + title: CallTranscriptionFailedEvent + type: object + x-stream-event-call-type: true + x-stream-event-doc-group: transcription + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + CallTranscriptionReadyEvent: + description: This event is sent when call transcription is ready + properties: + call_cid: + type: string + x-stream-index: "002.001" + call_transcription: + $ref: '#/components/schemas/CallTranscription' + description: The call transcription object + title: CallTranscription x-stream-index: "003" - connect_events: - type: boolean - x-stream-index: "001.004" created_at: format: date-time type: number - x-stream-index: "002.003" - custom_events: - type: boolean - x-stream-index: "001.012" - mark_messages_pending: - type: boolean - x-stream-index: "001.015" - max_message_length: - format: int32 - maximum: 20000 - type: integer - x-stream-index: "001.020" - mutes: - type: boolean - x-stream-index: "001.009" - name: + x-stream-index: "001.002" + egress_id: + type: string + x-stream-index: "004" + type: + default: call.transcription_ready + description: 'The type of event: "call.transcription_ready" in this case' + title: Event Type type: string x-stream-index: "001.001" - partition_size: - format: int32 - type: integer - x-stream-index: "001.028" - partition_ttl: - type: integer - x-stream-index: "001.029" - polls: - type: boolean - x-stream-index: "001.016" - push_notifications: - type: boolean - x-stream-index: "001.013" - quotes: - type: boolean - x-stream-index: "001.008" - reactions: - type: boolean - x-stream-index: "001.006" - read_events: - type: boolean - x-stream-index: "001.003" - reminders: - type: boolean - x-stream-index: "001.014" - replies: - type: boolean - x-stream-index: "001.007" - search: - type: boolean - x-stream-index: "001.005" - shared_locations: - type: boolean - x-stream-index: "001.018" - skip_last_msg_update_for_system_msgs: - type: boolean - x-stream-index: "001.030" - typing_events: - type: boolean - x-stream-index: "001.002" - updated_at: + required: + - type + - created_at + - call_cid + - call_transcription + - egress_id + title: CallTranscriptionReadyEvent + type: object + x-stream-event-call-type: true + x-stream-event-doc-group: transcription + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + CallTranscriptionStartedEvent: + description: This event is sent when call transcription has started + properties: + call_cid: + type: string + x-stream-index: "003.001" + created_at: format: date-time type: number - x-stream-index: "002.004" - uploads: - type: boolean - x-stream-index: "001.010" - url_enrichment: - type: boolean - x-stream-index: "001.011" - user_message_reminders: - type: boolean - x-stream-index: "001.017" + x-stream-index: "002.002" + egress_id: + type: string + x-stream-index: "001" + type: + default: call.transcription_started + description: 'The type of event: "call.transcription_started" in this case' + title: Event Type + type: string + x-stream-index: "002.001" required: - - name - - typing_events - - read_events - - connect_events - - search - - reactions - - replies - - quotes - - mutes - - uploads - - url_enrichment - - custom_events - - push_notifications - - reminders - - mark_messages_pending - - polls - - user_message_reminders - - shared_locations - - message_retention - - max_message_length - - automod - - automod_behavior - - skip_last_msg_update_for_system_msgs + - egress_id + - type - created_at - - updated_at - - commands + - call_cid + title: CallTranscriptionStartedEvent type: object - ChannelConfigWithInfo: + x-stream-event-call-type: true + x-stream-event-doc-group: transcription + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + CallTranscriptionStoppedEvent: + description: This event is sent when call transcription has stopped properties: - allowed_flag_reasons: - items: - type: string - type: array - x-stream-index: 001.002.026 - automod: - enum: - - disabled - - simple - - AI + call_cid: type: string - x-stream-index: 001.002.021 - automod_behavior: - enum: - - flag - - block - - shadow_block + x-stream-index: "002.001" + created_at: + format: date-time + type: number + x-stream-index: "001.002" + egress_id: type: string - x-stream-index: 001.002.022 - automod_thresholds: - $ref: '#/components/schemas/Thresholds' - x-stream-index: 001.002.027 - blocklist: + x-stream-index: "003" + type: + default: call.transcription_stopped + description: 'The type of event: "call.transcription_stopped" in this case' + title: Event Type type: string - x-stream-index: 001.002.023 - blocklist_behavior: - enum: - - flag - - block - - shadow_block + x-stream-index: "001.001" + required: + - type + - created_at + - call_cid + - egress_id + title: CallTranscriptionStoppedEvent + type: object + x-stream-event-call-type: true + x-stream-event-doc-group: transcription + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + CallType: + nullable: true + properties: + AppPK: + format: int32 + type: integer + writeOnly: true + x-stream-index: "003" + CreatedAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "005" + ExternalStorage: type: string - x-stream-index: 001.002.024 - blocklists: - items: - $ref: '#/components/schemas/BlockListOptions' - type: array - x-stream-index: 001.002.025 - commands: - items: - $ref: '#/components/schemas/Command' - type: array - x-stream-index: "001.003" - connect_events: - type: boolean - x-stream-index: 001.002.004 + writeOnly: true + x-stream-index: "009" + Name: + type: string + writeOnly: true + x-stream-index: "004" + NotificationSettings: + $ref: '#/components/schemas/NotificationSettings' + x-stream-index: "008" + PK: + format: int32 + type: integer + writeOnly: true + x-stream-index: "002" + Settings: + $ref: '#/components/schemas/CallSettings' + x-stream-index: "007" + UpdatedAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "006" + required: + - PK + - AppPK + - Name + - CreatedAt + - UpdatedAt + - ExternalStorage + type: object + CallTypeResponse: + description: CallTypeResponse is the payload for a call type. + properties: created_at: + description: the time the call type was created format: date-time + title: CreatedAt type: number - x-stream-index: 001.001.003 - custom_events: - type: boolean - x-stream-index: 001.002.012 + x-stream-index: "005" + external_storage: + description: the external storage for the call type + title: ExternalStorage + type: string + x-stream-index: "007" grants: additionalProperties: items: type: string type: array + description: the permissions granted to each role + title: Grants type: object x-stream-index: "002" - mark_messages_pending: - type: boolean - x-stream-index: 001.002.015 - max_message_length: - format: int32 - maximum: 20000 - type: integer - x-stream-index: 001.002.020 - mutes: - type: boolean - x-stream-index: 001.002.009 name: + description: the name of the call type + title: Name type: string - x-stream-index: 001.002.001 - partition_size: - format: int32 - type: integer - x-stream-index: 001.002.028 - partition_ttl: - example: 24h - format: duration - nullable: true - type: string - x-stream-index: 001.002.029 - polls: - type: boolean - x-stream-index: 001.002.016 - push_notifications: - type: boolean - x-stream-index: 001.002.013 - quotes: - type: boolean - x-stream-index: 001.002.008 - reactions: - type: boolean - x-stream-index: 001.002.006 - read_events: - type: boolean - x-stream-index: 001.002.003 - reminders: - type: boolean - x-stream-index: 001.002.014 - replies: - type: boolean - x-stream-index: 001.002.007 - search: - type: boolean - x-stream-index: 001.002.005 - shared_locations: - type: boolean - x-stream-index: 001.002.018 - skip_last_msg_update_for_system_msgs: - type: boolean - x-stream-index: 001.002.030 - typing_events: - type: boolean - x-stream-index: 001.002.002 + x-stream-index: "001" + notification_settings: + $ref: '#/components/schemas/NotificationSettings' + description: the notification settings for the call type + title: NotificationSettings + x-stream-index: "004" + settings: + $ref: '#/components/schemas/CallSettingsResponse' + description: the settings for the call type + title: Settings + x-stream-index: "003" updated_at: + description: the time the call type was last updated format: date-time + title: UpdatedAt type: number - x-stream-index: 001.001.004 - uploads: - type: boolean - x-stream-index: 001.002.010 - url_enrichment: - type: boolean - x-stream-index: 001.002.011 - user_message_reminders: - type: boolean - x-stream-index: 001.002.017 + x-stream-index: "006" required: + - name + - grants + - settings + - notification_settings - created_at - updated_at - - name - - typing_events - - read_events - - connect_events - - search - - reactions - - replies - - quotes - - mutes - - uploads - - url_enrichment - - custom_events - - push_notifications - - reminders - - mark_messages_pending - - polls - - user_message_reminders - - shared_locations - - message_retention - - max_message_length - - automod - - automod_behavior - - skip_last_msg_update_for_system_msgs - - commands + title: CallTypeResponse type: object - ChannelCreatedEvent: + CallUpdatedEvent: + description: |- + This event is sent when a call is updated, clients should use this update the local state of the call. + This event also contains the capabilities by role for the call, clients should update the own_capability for the current. properties: + call: + $ref: '#/components/schemas/CallResponse' + description: Call object + title: Call + x-stream-index: "003" + call_cid: + type: string + x-stream-index: "002.001" + capabilities_by_role: + additionalProperties: + items: + type: string + type: array + description: The capabilities by role for this call + title: CapabilitiesByRole + type: object + x-stream-index: "004" created_at: format: date-time type: number x-stream-index: "001.002" type: - default: channel.created + default: call.updated + description: 'The type of event: "call.updated" in this case' + title: Event Type type: string x-stream-index: "001.001" required: - type - created_at - title: ChannelCreatedEvent + - call_cid + - call + - capabilities_by_role + title: CallUpdatedEvent type: object - x-stream-event-client-type: true - x-stream-event-doc-group: other + x-stream-event-call-type: true + x-stream-event-doc-group: call x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - ChannelDeletedEvent: + CallUserFeedbackSubmittedEvent: + description: This event is sent when a user submits feedback for a call. properties: - channel: - $ref: '#/components/schemas/ChannelResponse' - x-stream-index: "003.004" - channel_id: + call_cid: type: string - x-stream-index: "003.002" - channel_member_count: + x-stream-index: "002.001" + created_at: + format: date-time + type: number + x-stream-index: "001.002" + custom: + additionalProperties: {} + description: Custom data provided by the user + title: Custom + type: object + x-stream-index: "007" + rating: + description: The rating given by the user (1-5) format: int32 + title: Rating type: integer - x-stream-index: "003.005" - channel_type: + x-stream-index: "005" + reason: + description: The reason provided by the user for the rating + title: Reason type: string - x-stream-index: "003.003" - cid: + x-stream-index: "006" + sdk: type: string - x-stream-index: "003.001" - created_at: - format: date-time - type: number - x-stream-index: "002.002" - team: + x-stream-index: "008" + sdk_version: type: string - x-stream-index: "001.001" + x-stream-index: "009" + session_id: + description: Call session ID + title: Session ID + type: string + x-stream-index: "003.001" type: - default: channel.deleted + default: call.user_feedback_submitted + description: The type of event, "call.user_feedback" in this case + title: Event Type type: string - x-stream-index: "002.001" + x-stream-index: "001.001" + user: + $ref: '#/components/schemas/UserResponse' + description: The user who submitted the feedback + title: User + x-stream-index: "004" required: - type - created_at - - cid - - channel_id - - channel_type - - channel_member_count - title: ChannelDeletedEvent + - call_cid + - session_id + - user + - rating + title: CallUserFeedbackSubmittedEvent type: object - x-stream-event-client-type: true + x-stream-event-call-type: true x-stream-event-doc-group: other x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - ChannelExport: - properties: - cid: - type: string - x-stream-index: "003" - id: - description: Channel ID - title: ID - type: string - x-stream-index: "002" - messages_since: - description: Date to export messages since - format: date-time - title: Messages since - type: number - x-stream-index: "004" - messages_until: - description: Date to export messages until - format: date-time - title: Messages until - type: number - x-stream-index: "005" - type: - description: Channel type - title: Type - type: string - x-stream-index: "001" - title: Channel Export - type: object - ChannelFrozenEvent: + CallUserMutedEvent: + description: This event is sent when a call member is muted properties: - channel_id: - type: string - x-stream-index: "002.002" - channel_type: - type: string - x-stream-index: "002.003" - cid: + call_cid: type: string x-stream-index: "002.001" created_at: format: date-time type: number x-stream-index: "001.002" + from_user_id: + type: string + x-stream-index: "003" + muted_user_ids: + items: + type: string + type: array + x-stream-index: "004" type: - default: channel.frozen + default: call.user_muted + description: 'The type of event: "call.user_muted" in this case' + title: Event Type type: string x-stream-index: "001.001" required: - type - created_at - - cid - - channel_id - - channel_type - title: ChannelFrozenEvent + - call_cid + - from_user_id + - muted_user_ids + title: CallUserMutedEvent type: object - x-stream-event-client-type: true - x-stream-event-doc-group: other + x-stream-event-call-type: true + x-stream-event-doc-group: call x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - ChannelGetOrCreateRequest: - nullable: true + CallsPerDayReport: properties: - data: - $ref: '#/components/schemas/ChannelInput' - x-stream-index: "003" - hide_for_creator: - description: Whether this channel will be hidden for the user who created - the channel or not - title: Hide for creator - type: boolean - x-stream-index: "007" - members: - $ref: '#/components/schemas/PaginationParams' - x-stream-index: "010" - messages: - $ref: '#/components/schemas/MessagePaginationParams' - x-stream-index: "009" - state: - description: Refresh channel state - title: State - type: boolean - x-stream-index: "005" - thread_unread_counts: - type: boolean - x-stream-index: "008" - watchers: - $ref: '#/components/schemas/PaginationParams' - x-stream-index: "011" + count: + format: int64 + type: integer + x-stream-index: "001" + required: + - count type: object - ChannelHiddenEvent: + CallsPerDayReportResponse: properties: - channel: - $ref: '#/components/schemas/ChannelResponse' - x-stream-index: "003.004" - channel_id: + daily: + items: + $ref: '#/components/schemas/DailyAggregateCallsPerDayReportResponse' + type: array + x-stream-index: "001" + required: + - daily + type: object + CampaignChannelTemplate: + properties: + custom: + additionalProperties: {} + type: object + x-stream-index: "005" + id: type: string - x-stream-index: "003.002" - channel_member_count: - format: int32 - type: integer - x-stream-index: "003.005" - channel_type: + x-stream-index: "002" + members: + items: + type: string + maximum: 1000 + type: array + x-stream-index: "003" + team: + maxLength: 1000 type: string - x-stream-index: "003.003" - cid: + x-stream-index: "004" + type: + maxLength: 64 type: string - x-stream-index: "003.001" - clear_history: - type: boolean x-stream-index: "001" + required: + - type + - custom + type: object + CampaignCompletedEvent: + nullable: true + properties: + campaign: + $ref: '#/components/schemas/CampaignResponse' + x-stream-index: "002" created_at: format: date-time type: number - x-stream-index: "004.002" + x-stream-index: "001.003" + custom: + additionalProperties: {} + type: object + x-stream-index: "001.007" + received_at: + format: date-time + type: number + x-stream-index: "001.004" type: - default: channel.hidden + default: campaign.completed type: string - x-stream-index: "004.001" - user: - $ref: '#/components/schemas/User' - x-stream-index: "002.001" + x-stream-index: "001.002" required: - - clear_history - - cid - - channel_id - - channel_type - - channel_member_count - type - created_at - title: ChannelHiddenEvent + - custom + title: CampaignCompletedEvent 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 - ChannelInput: + CampaignMessageTemplate: properties: - auto_translation_enabled: - description: Enable or disable auto translation - title: Auto translation - type: boolean - x-stream-index: "005" - auto_translation_language: - description: Switch auto translation language - title: Auto translation language - type: string - x-stream-index: "006" - config_overrides: - $ref: '#/components/schemas/ChannelConfig' - x-stream-index: "024" - created_by: - $ref: '#/components/schemas/UserRequest' - x-stream-index: "009" - created_by_id: - type: string - x-stream-index: "008" + attachments: + items: + $ref: '#/components/schemas/Attachment' + maximum: 30 + type: array + x-stream-index: "002" custom: additionalProperties: {} type: object - x-stream-index: "015" - disabled: - type: boolean - x-stream-index: "014" - frozen: - description: Freeze or unfreeze the channel - title: Frozen - type: boolean - x-stream-index: "013" - invites: - items: - $ref: '#/components/schemas/ChannelMember' - maximum: 100 - type: array - x-stream-index: "016" - members: - items: - $ref: '#/components/schemas/ChannelMember' - maximum: 100 - type: array - x-stream-index: "018" - team: - description: Team the channel belongs to (if multi-tenant mode is enabled) - title: Team - type: string x-stream-index: "004" - truncated_by_id: + poll_id: type: string - x-stream-index: "010" + x-stream-index: "003" + text: + type: string + x-stream-index: "001" + required: + - text + - attachments + - poll_id + - custom type: object - ChannelMember: - nullable: true + CampaignResponse: properties: - archived_at: + channel_template: + $ref: '#/components/schemas/CampaignChannelTemplate' + x-stream-index: "016" + create_channels: + type: boolean + x-stream-index: "008" + created_at: format: date-time type: number + x-stream-index: "020" + description: + type: string + x-stream-index: "010" + id: + type: string + x-stream-index: "001" + message_template: + $ref: '#/components/schemas/CampaignMessageTemplate' x-stream-index: "015" - ban_expires: - description: Expiration date of the ban + name: + type: string + x-stream-index: "007" + scheduled_for: format: date-time - title: Ban expires type: number x-stream-index: "013" - banned: - description: Whether member is banned this channel or not - title: Banned - type: boolean - x-stream-index: "012" - channel_role: - description: Role of the member in the channel - title: Channel Role + segment_ids: + items: + type: string + type: array + x-stream-index: "002" + segments: + items: + $ref: '#/components/schemas/Segment' + type: array + x-stream-index: "003" + sender: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "005" + sender_id: type: string - x-stream-index: "018" - created_at: - description: Date/time of creation - format: date-time - title: Created at - type: number - x-stream-index: "009" - custom: - additionalProperties: {} - type: object x-stream-index: "004" - deleted_at: - format: date-time - type: number - x-stream-index: "011" - invite_accepted_at: - description: Date when invite was accepted - format: date-time - title: Invited accepted at - type: number + sender_mode: + type: string x-stream-index: "006" - invite_rejected_at: - description: Date when invite was rejected - format: date-time - title: Invited rejected at - type: number - x-stream-index: "007" - invited: - description: Whether member was invited or not - title: Invited + show_channels: type: boolean - x-stream-index: "005" - is_moderator: - description: Whether member is channel moderator or not - title: Is moderator + x-stream-index: "009" + skip_push: type: boolean - x-stream-index: "003" - notifications_muted: + x-stream-index: "011" + skip_webhook: type: boolean + x-stream-index: "012" + stats: + $ref: '#/components/schemas/CampaignStatsResponse' + x-stream-index: "022" + status: + type: string x-stream-index: "019" - pinned_at: + stop_at: format: date-time type: number - x-stream-index: "016" - role: - description: 'Permission level of the member in the channel (DEPRECATED: - use channel_role instead)' - enum: - - member - - moderator - - admin - - owner - title: Role - type: string - x-stream-index: "017" - shadow_banned: - description: Whether member is shadow banned in this channel or not - title: Shadow banned - type: boolean x-stream-index: "014" - status: - type: string - x-stream-index: "008" updated_at: - description: Date/time of the last update format: date-time - title: Updated at type: number - x-stream-index: "010" - user: - $ref: '#/components/schemas/UserResponse' - x-stream-index: "002" - user_id: - title: User ID - type: string - x-stream-index: "001" + x-stream-index: "021" + user_ids: + items: + type: string + type: array + x-stream-index: "017" + users: + items: + $ref: '#/components/schemas/UserResponse' + type: array + x-stream-index: "018" required: - - custom + - id + - segment_ids + - segments + - sender_id + - sender_mode + - name + - create_channels + - show_channels + - description + - skip_push + - skip_webhook + - user_ids + - users + - status - created_at - updated_at - - banned - - shadow_banned - - channel_role - - notifications_muted - title: Channel member + - stats type: object - ChannelMemberResponse: + CampaignStartedEvent: nullable: true properties: - archived_at: + campaign: + $ref: '#/components/schemas/CampaignResponse' + x-stream-index: "002" + created_at: format: date-time type: number - x-stream-index: "016" - ban_expires: - description: Expiration date of the ban + x-stream-index: "001.003" + custom: + additionalProperties: {} + type: object + x-stream-index: "001.007" + received_at: format: date-time - title: Ban expires type: number - x-stream-index: "013" - banned: - description: Whether member is banned this channel or not - title: Banned + x-stream-index: "001.004" + type: + default: campaign.started + type: string + x-stream-index: "001.002" + required: + - type + - created_at + - custom + title: CampaignStartedEvent + 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 + CampaignStatsResponse: + properties: + progress: + format: float + type: number + x-stream-index: "005" + stats_channels_created: + format: int32 + type: integer + x-stream-index: "004" + stats_completed_at: + format: date-time + type: number + x-stream-index: "002" + stats_messages_sent: + format: int32 + type: integer + x-stream-index: "003" + stats_started_at: + format: date-time + type: number + x-stream-index: "001" + stats_users_read: + format: int32 + type: integer + x-stream-index: "007" + stats_users_sent: + format: int32 + type: integer + x-stream-index: "006" + required: + - stats_started_at + - stats_completed_at + - stats_messages_sent + - stats_channels_created + - progress + - stats_users_sent + - stats_users_read + type: object + CastPollVoteRequest: + nullable: true + properties: + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "005.002" + user_id: + type: string + x-stream-index: "005.001" + vote: + $ref: '#/components/schemas/VoteData' + description: Vote data + title: VoteData + x-stream-index: "004" + type: object + Channel: + properties: + active_live_locations: + items: + $ref: '#/components/schemas/SharedLocation' + type: array + x-stream-index: "034" + auto_translation_enabled: type: boolean - x-stream-index: "012" - channel_role: - description: Role of the member in the channel - title: Channel Role + x-stream-index: "029" + auto_translation_language: type: string - x-stream-index: "018" + x-stream-index: "030" + cid: + type: string + x-stream-index: "003" + config: + $ref: '#/components/schemas/ChannelConfig' + x-stream-index: "026" + config_overrides: + $ref: '#/components/schemas/ConfigOverrides' + x-stream-index: "027" + cooldown: + format: int32 + type: integer + x-stream-index: "031" created_at: - description: Date/time of creation format: date-time - title: Created at type: number x-stream-index: "009" + created_by: + $ref: '#/components/schemas/User' + x-stream-index: "008" custom: additionalProperties: {} type: object - x-stream-index: "004" + x-stream-index: "019" deleted_at: format: date-time type: number x-stream-index: "011" - invite_accepted_at: - description: Date when invite was accepted + disabled: + type: boolean + x-stream-index: "017" + frozen: + type: boolean + x-stream-index: "016" + id: + type: string + x-stream-index: "004" + invites: + items: + $ref: '#/components/schemas/ChannelMember' + type: array + x-stream-index: "022" + last_campaigns: + type: string + x-stream-index: "032" + last_message_at: format: date-time - title: Invited accepted at type: number x-stream-index: "006" - invite_rejected_at: - description: Date when invite was rejected - format: date-time - title: Invited rejected at - type: number - x-stream-index: "007" - invited: - description: Whether member was invited or not - title: Invited - type: boolean - x-stream-index: "005" - is_moderator: - description: Whether member is channel moderator or not - title: Is moderator - type: boolean - x-stream-index: "003" - notifications_muted: - type: boolean - x-stream-index: "019" - pinned_at: + member_count: + format: int32 + type: integer + x-stream-index: "021" + members: + items: + $ref: '#/components/schemas/ChannelMember' + type: array + x-stream-index: "020" + message_count: + format: int64 + type: integer + x-stream-index: "035" + message_count_updated_at: format: date-time type: number - x-stream-index: "015" - role: - description: 'Permission level of the member in the channel (DEPRECATED: - use channel_role instead)' - enum: - - member - - moderator - - admin - - owner - title: Role + x-stream-index: "036" + team: type: string - x-stream-index: "017" - shadow_banned: - description: Whether member is shadow banned in this channel or not - title: Shadow banned - type: boolean - x-stream-index: "014" - status: + x-stream-index: "028" + truncated_by: + $ref: '#/components/schemas/User' + x-stream-index: "015" + type: type: string - x-stream-index: "008" + x-stream-index: "005" updated_at: - description: Date/time of the last update format: date-time - title: Updated at type: number x-stream-index: "010" - user: - $ref: '#/components/schemas/UserResponse' - x-stream-index: "002" - user_id: - title: User ID - type: string - x-stream-index: "001" required: - - custom + - cid + - id + - type - created_at - updated_at - - banned - - shadow_banned - - channel_role - - notifications_muted - title: Channel member + - frozen + - disabled + - custom + - auto_translation_language type: object - ChannelMessages: - nullable: true + ChannelConfig: properties: - channel: - $ref: '#/components/schemas/ChannelResponse' - x-stream-index: "001" - messages: + allowed_flag_reasons: items: - $ref: '#/components/schemas/Message' + type: string type: array - x-stream-index: "002" + x-stream-index: "001.027" + automod: + enum: + - disabled + - simple + - AI + type: string + x-stream-index: "001.022" + automod_behavior: + enum: + - flag + - block + - shadow_block + type: string + x-stream-index: "001.023" + automod_thresholds: + $ref: '#/components/schemas/Thresholds' + x-stream-index: "001.028" + blocklist: + type: string + x-stream-index: "001.024" + blocklist_behavior: + enum: + - flag + - block + - shadow_block + type: string + x-stream-index: "001.025" + blocklists: + items: + $ref: '#/components/schemas/BlockListOptions' + type: array + x-stream-index: "001.026" + commands: + items: + type: string + type: array + x-stream-index: "003" + connect_events: + type: boolean + x-stream-index: "001.004" + count_messages: + type: boolean + x-stream-index: "001.019" + created_at: + format: date-time + type: number + x-stream-index: "002.003" + custom_events: + type: boolean + x-stream-index: "001.012" + mark_messages_pending: + type: boolean + x-stream-index: "001.015" + max_message_length: + format: int32 + maximum: 20000 + type: integer + x-stream-index: "001.021" + mutes: + type: boolean + x-stream-index: "001.009" + name: + type: string + x-stream-index: "001.001" + partition_size: + format: int32 + type: integer + x-stream-index: "001.029" + partition_ttl: + type: integer + x-stream-index: "001.030" + polls: + type: boolean + x-stream-index: "001.016" + push_notifications: + type: boolean + x-stream-index: "001.013" + quotes: + type: boolean + x-stream-index: "001.008" + reactions: + type: boolean + x-stream-index: "001.006" + read_events: + type: boolean + x-stream-index: "001.003" + reminders: + type: boolean + x-stream-index: "001.014" + replies: + type: boolean + x-stream-index: "001.007" + search: + type: boolean + x-stream-index: "001.005" + shared_locations: + type: boolean + x-stream-index: "001.018" + skip_last_msg_update_for_system_msgs: + type: boolean + x-stream-index: "001.031" + typing_events: + type: boolean + x-stream-index: "001.002" + updated_at: + format: date-time + type: number + x-stream-index: "002.004" + uploads: + type: boolean + x-stream-index: "001.010" + url_enrichment: + type: boolean + x-stream-index: "001.011" + user_message_reminders: + type: boolean + x-stream-index: "001.017" required: - - messages + - name + - typing_events + - read_events + - connect_events + - search + - reactions + - replies + - quotes + - mutes + - uploads + - url_enrichment + - custom_events + - push_notifications + - reminders + - mark_messages_pending + - polls + - user_message_reminders + - shared_locations + - count_messages + - message_retention + - max_message_length + - automod + - automod_behavior + - skip_last_msg_update_for_system_msgs + - created_at + - updated_at + - commands type: object - ChannelMute: - nullable: true + ChannelConfigWithInfo: properties: - channel: - $ref: '#/components/schemas/ChannelResponse' - description: Channel that is muted - title: Channel - x-stream-index: "002" + allowed_flag_reasons: + items: + type: string + type: array + x-stream-index: 001.002.027 + automod: + enum: + - disabled + - simple + - AI + type: string + x-stream-index: 001.002.022 + automod_behavior: + enum: + - flag + - block + - shadow_block + type: string + x-stream-index: 001.002.023 + automod_thresholds: + $ref: '#/components/schemas/Thresholds' + x-stream-index: 001.002.028 + blocklist: + type: string + x-stream-index: 001.002.024 + blocklist_behavior: + enum: + - flag + - block + - shadow_block + type: string + x-stream-index: 001.002.025 + blocklists: + items: + $ref: '#/components/schemas/BlockListOptions' + type: array + x-stream-index: 001.002.026 + commands: + items: + $ref: '#/components/schemas/Command' + type: array + x-stream-index: "001.003" + connect_events: + type: boolean + x-stream-index: 001.002.004 + count_messages: + type: boolean + x-stream-index: 001.002.019 created_at: - description: Date/time of creation - format: date-time - title: Created at - type: number - x-stream-index: "004" - expires: - description: Date/time of mute expiration format: date-time - title: Expires type: number - x-stream-index: "003" + x-stream-index: 001.001.003 + custom_events: + type: boolean + x-stream-index: 001.002.012 + grants: + additionalProperties: + items: + type: string + type: array + type: object + x-stream-index: "002" + mark_messages_pending: + type: boolean + x-stream-index: 001.002.015 + max_message_length: + format: int32 + maximum: 20000 + type: integer + x-stream-index: 001.002.021 + mutes: + type: boolean + x-stream-index: 001.002.009 + name: + type: string + x-stream-index: 001.002.001 + partition_size: + format: int32 + type: integer + x-stream-index: 001.002.029 + partition_ttl: + example: 24h + format: duration + nullable: true + type: string + x-stream-index: 001.002.030 + polls: + type: boolean + x-stream-index: 001.002.016 + push_notifications: + type: boolean + x-stream-index: 001.002.013 + quotes: + type: boolean + x-stream-index: 001.002.008 + reactions: + type: boolean + x-stream-index: 001.002.006 + read_events: + type: boolean + x-stream-index: 001.002.003 + reminders: + type: boolean + x-stream-index: 001.002.014 + replies: + type: boolean + x-stream-index: 001.002.007 + search: + type: boolean + x-stream-index: 001.002.005 + shared_locations: + type: boolean + x-stream-index: 001.002.018 + skip_last_msg_update_for_system_msgs: + type: boolean + x-stream-index: 001.002.031 + typing_events: + type: boolean + x-stream-index: 001.002.002 updated_at: - description: Date/time of the last update format: date-time - title: Updated at type: number - x-stream-index: "005" - user: - $ref: '#/components/schemas/UserResponse' - description: Owner of channel mute - title: User - x-stream-index: "001" + x-stream-index: 001.001.004 + uploads: + type: boolean + x-stream-index: 001.002.010 + url_enrichment: + type: boolean + x-stream-index: 001.002.011 + user_message_reminders: + type: boolean + x-stream-index: 001.002.017 required: - created_at - updated_at + - name + - typing_events + - read_events + - connect_events + - search + - reactions + - replies + - quotes + - mutes + - uploads + - url_enrichment + - custom_events + - push_notifications + - reminders + - mark_messages_pending + - polls + - user_message_reminders + - shared_locations + - count_messages + - message_retention + - max_message_length + - automod + - automod_behavior + - skip_last_msg_update_for_system_msgs + - commands type: object - ChannelMutedEvent: + ChannelCreatedEvent: properties: created_at: format: date-time type: number x-stream-index: "001.002" type: - default: channel.muted + default: channel.created type: string x-stream-index: "001.001" required: - type - created_at - title: ChannelMutedEvent + title: ChannelCreatedEvent 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 - ChannelOwnCapability: - description: All possibility of string to use - enum: - - ban-channel-members - - cast-poll-vote - - connect-events - - create-attachment - - delete-any-message - - delete-channel - - delete-own-message - - flag-message - - freeze-channel - - join-channel - - leave-channel - - mute-channel - - pin-message - - query-poll-votes - - quote-message - - read-events - - search-messages - - send-custom-events - - send-links - - send-message - - send-poll - - send-reaction - - send-reply - - send-restricted-visibility-message - - send-typing-events - - set-channel-cooldown - - share-location - - skip-slow-mode - - slow-mode - - typing-events - - update-any-message - - update-channel - - update-channel-members - - update-own-message - - update-thread - - upload-file - title: ChannelOwnCapability - type: string - ChannelPushPreferences: + ChannelDeletedEvent: properties: - chat_level: + channel: + $ref: '#/components/schemas/ChannelResponse' + x-stream-index: "003.004" + channel_id: type: string - x-stream-index: "001" - disabled_until: + x-stream-index: "003.002" + channel_member_count: + format: int32 + type: integer + x-stream-index: "003.005" + channel_type: + type: string + x-stream-index: "003.003" + cid: + type: string + x-stream-index: "003.001" + created_at: format: date-time type: number - x-stream-index: "002" + x-stream-index: "002.002" + team: + type: string + x-stream-index: "001.001" + type: + default: channel.deleted + type: string + x-stream-index: "002.001" + required: + - type + - created_at + - cid + - channel_id + - channel_type + - channel_member_count + title: ChannelDeletedEvent type: object - ChannelResponse: - description: Represents channel in chat + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + ChannelExport: properties: - auto_translation_enabled: - description: Whether auto translation is enabled or not - title: Auto translation - type: boolean - x-stream-index: "017" - auto_translation_language: - description: Language to translate to when auto translation is active - title: Auto translation language - type: string - x-stream-index: "018" - blocked: - description: Whether this channel is blocked by current user or not - title: Blocked - type: boolean - x-stream-index: "023" cid: - description: Channel CID (:) - title: CID type: string x-stream-index: "003" - config: - $ref: '#/components/schemas/ChannelConfigWithInfo' - description: Channel configuration - title: ChannelConfigWithInfo - x-stream-index: "013" - cooldown: - description: Cooldown period after sending each message - format: int32 - title: Cooldown - type: integer - x-stream-index: "020" - created_at: - description: Date/time of creation - format: date-time - title: Created at - type: number - x-stream-index: "005" - created_by: - $ref: '#/components/schemas/UserResponse' - description: Creator of the channel - title: UserResponse - x-stream-index: "008" - custom: - additionalProperties: {} - description: Custom data for this object - title: Custom data - type: object - x-stream-index: "026" - deleted_at: - description: Date/time of deletion - format: date-time - title: Deleted at - type: number - x-stream-index: "007" - disabled: - type: boolean - x-stream-index: "010" - frozen: - description: Whether channel is frozen or not - title: Frozen - type: boolean - x-stream-index: "009" - hidden: - description: Whether this channel is hidden by current user or not - title: Hidden - type: boolean - x-stream-index: "022" - hide_messages_before: - description: Date since when the message history is accessible - format: date-time - title: Hide messages before - type: number - x-stream-index: "019" id: - description: Channel unique ID + description: Channel ID title: ID type: string - x-stream-index: "001" - last_message_at: - description: Date of the last message sent + x-stream-index: "002" + messages_since: + description: Date to export messages since format: date-time - title: Last message at + title: Messages since type: number x-stream-index: "004" - member_count: - description: Number of members in the channel - format: int32 - title: Member count - type: integer - x-stream-index: "012" - members: - description: List of channel members (max 100) - items: - $ref: '#/components/schemas/ChannelMember' - title: ChannelMembers - type: array - x-stream-index: "011" - mute_expires_at: - description: Date of mute expiration - format: date-time - title: Mute expires at - type: number - x-stream-index: "015" - muted: - description: Whether this channel is muted or not - title: Muted - type: boolean - x-stream-index: "014" - own_capabilities: - description: List of channel capabilities of authenticated user - items: - $ref: '#/components/schemas/ChannelOwnCapability' - title: ChannelOwnCapability - type: array - x-stream-index: "021" - team: - description: Team the channel belongs to (multi-tenant only) - title: Team - type: string - x-stream-index: "016" - truncated_at: - description: Date of the latest truncation of the channel + messages_until: + description: Date to export messages until format: date-time - title: UserResponse + title: Messages until type: number - x-stream-index: "024" - truncated_by: - $ref: '#/components/schemas/UserResponse' - x-stream-index: "025" + x-stream-index: "005" type: - description: Type of the channel + description: Channel type title: Type type: string - x-stream-docs-page-id: channel_features - x-stream-index: "002" - updated_at: - description: Date/time of the last update - format: date-time - title: Updated at - type: number - x-stream-index: "006" - required: - - id - - type - - cid - - created_at - - updated_at - - frozen - - disabled - - custom - title: Channel + x-stream-index: "001" + title: Channel Export type: object - ChannelStateResponse: - nullable: true + ChannelFrozenEvent: properties: - active_live_locations: - items: - $ref: '#/components/schemas/SharedLocationResponseData' - type: array - x-stream-index: "001.015" - channel: - $ref: '#/components/schemas/ChannelResponse' - x-stream-index: "001.001" - draft: - $ref: '#/components/schemas/DraftResponse' - x-stream-index: "001.014" - duration: + channel_id: + type: string + x-stream-index: "002.002" + channel_type: + type: string + x-stream-index: "002.003" + cid: type: string x-stream-index: "002.001" - hidden: - type: boolean - x-stream-index: "001.011" - hide_messages_before: + created_at: format: date-time type: number - x-stream-index: "001.012" - members: - items: - $ref: '#/components/schemas/ChannelMember' - type: array - x-stream-index: "001.007" - membership: - $ref: '#/components/schemas/ChannelMember' - x-stream-index: "001.008" - messages: - items: - $ref: '#/components/schemas/MessageResponse' - type: array x-stream-index: "001.002" - pending_messages: - items: - $ref: '#/components/schemas/PendingMessageResponse' - type: array - x-stream-index: "001.013" - pinned_messages: - items: - $ref: '#/components/schemas/MessageResponse' - type: array - x-stream-index: "001.003" - push_preferences: - $ref: '#/components/schemas/ChannelPushPreferences' - x-stream-index: "001.009" - read: - items: - $ref: '#/components/schemas/ReadStateResponse' - type: array - x-stream-index: "001.006" - threads: - items: - $ref: '#/components/schemas/ThreadStateResponse' - type: array - x-stream-index: "001.010" - watcher_count: - format: int32 - type: integer - x-stream-index: "001.004" - watchers: - items: - $ref: '#/components/schemas/UserResponse' - type: array - x-stream-index: "001.005" + type: + default: channel.frozen + type: string + x-stream-index: "001.001" required: - - messages - - pinned_messages - - members - - threads - - duration + - type + - created_at + - cid + - channel_id + - channel_type + title: ChannelFrozenEvent type: object - ChannelStateResponseFields: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + ChannelGetOrCreateRequest: + nullable: true properties: - active_live_locations: - description: Active live locations in the channel - items: - $ref: '#/components/schemas/SharedLocationResponseData' - title: Active Live Locations - type: array - x-stream-index: "015" - channel: - $ref: '#/components/schemas/ChannelResponse' - x-stream-index: "001" - draft: - $ref: '#/components/schemas/DraftResponse' - x-stream-index: "014" - hidden: - description: Whether this channel is hidden or not - title: Hidden + data: + $ref: '#/components/schemas/ChannelInput' + x-stream-index: "003" + hide_for_creator: + description: Whether this channel will be hidden for the user who created + the channel or not + title: Hide for creator type: boolean - x-stream-index: "011" - hide_messages_before: - description: Messages before this date are hidden from the user - format: date-time - title: Hide messages before - type: number - x-stream-index: "012" - members: - description: List of channel members - items: - $ref: '#/components/schemas/ChannelMember' - title: Members - type: array x-stream-index: "007" - membership: - $ref: '#/components/schemas/ChannelMember' - description: Current user membership object - title: Membership - x-stream-index: "008" + members: + $ref: '#/components/schemas/PaginationParams' + x-stream-index: "010" messages: - description: List of channel messages - items: - $ref: '#/components/schemas/MessageResponse' - title: Message - type: array - x-stream-index: "002" - pending_messages: - description: Pending messages that this user has sent - items: - $ref: '#/components/schemas/PendingMessageResponse' - title: Pending messages - type: array - x-stream-index: "013" - pinned_messages: - description: List of pinned messages in the channel - items: - $ref: '#/components/schemas/MessageResponse' - title: Pinned messages - type: array - x-stream-docs-page-id: pinned_messages - x-stream-index: "003" - push_preferences: - $ref: '#/components/schemas/ChannelPushPreferences' + $ref: '#/components/schemas/MessagePaginationParams' x-stream-index: "009" - read: - description: List of read states - items: - $ref: '#/components/schemas/ReadStateResponse' - title: Read - type: array - x-stream-index: "006" - threads: - items: - $ref: '#/components/schemas/ThreadStateResponse' - type: array - x-stream-index: "010" - watcher_count: - description: Number of channel watchers - format: int32 - title: Watcher count - type: integer - x-stream-index: "004" - watchers: - description: List of user who is watching the channel - items: - $ref: '#/components/schemas/UserResponse' - title: Watchers - type: array + state: + description: Refresh channel state + title: State + type: boolean x-stream-index: "005" - required: - - messages - - pinned_messages - - members - - threads + thread_unread_counts: + type: boolean + x-stream-index: "008" + watchers: + $ref: '#/components/schemas/PaginationParams' + x-stream-index: "011" type: object - ChannelTruncatedEvent: + ChannelHiddenEvent: properties: channel: $ref: '#/components/schemas/ChannelResponse' - x-stream-index: "001.004" + x-stream-index: "003.004" channel_id: type: string - x-stream-index: "001.002" + x-stream-index: "003.002" channel_member_count: format: int32 type: integer - x-stream-index: "001.005" + x-stream-index: "003.005" channel_type: type: string - x-stream-index: "001.003" + x-stream-index: "003.003" cid: type: string - x-stream-index: "001.001" + x-stream-index: "003.001" + clear_history: + type: boolean + x-stream-index: "001" created_at: format: date-time type: number - x-stream-index: "002.002" + x-stream-index: "004.002" type: - default: channel.truncated + default: channel.hidden type: string + x-stream-index: "004.001" + user: + $ref: '#/components/schemas/User' x-stream-index: "002.001" required: + - clear_history - cid - channel_id - channel_type - channel_member_count - type - created_at - title: ChannelTruncatedEvent + title: ChannelHiddenEvent 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 - ChannelTypeConfig: - nullable: true + ChannelInput: properties: - allowed_flag_reasons: - items: - type: string - type: array - x-stream-index: 003.002.026 - automod: - enum: - - disabled - - simple - - AI - type: string - x-stream-index: 003.002.021 - automod_behavior: - enum: - - flag - - block - - shadow_block - type: string - x-stream-index: 003.002.022 - automod_thresholds: - $ref: '#/components/schemas/Thresholds' - x-stream-index: 003.002.027 - blocklist: + auto_translation_enabled: + description: Enable or disable auto translation + title: Auto translation + type: boolean + x-stream-index: "005" + auto_translation_language: + description: Switch auto translation language + title: Auto translation language type: string - x-stream-index: 003.002.023 - blocklist_behavior: - enum: - - flag - - block - - shadow_block + x-stream-index: "006" + config_overrides: + $ref: '#/components/schemas/ChannelConfig' + x-stream-index: "024" + created_by: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "009" + created_by_id: type: string - x-stream-index: 003.002.024 - blocklists: + x-stream-index: "008" + custom: + additionalProperties: {} + type: object + x-stream-index: "015" + disabled: + type: boolean + x-stream-index: "014" + frozen: + description: Freeze or unfreeze the channel + title: Frozen + type: boolean + x-stream-index: "013" + invites: items: - $ref: '#/components/schemas/BlockListOptions' + $ref: '#/components/schemas/ChannelMember' + maximum: 100 type: array - x-stream-index: 003.002.025 - commands: + x-stream-index: "016" + members: items: - $ref: '#/components/schemas/Command' + $ref: '#/components/schemas/ChannelMember' + maximum: 100 type: array - x-stream-index: "003.003" - connect_events: + x-stream-index: "018" + team: + description: Team the channel belongs to (if multi-tenant mode is enabled) + title: Team + type: string + x-stream-index: "004" + truncated_by_id: + type: string + x-stream-index: "010" + type: object + ChannelMember: + nullable: true + properties: + archived_at: + format: date-time + type: number + x-stream-index: "015" + ban_expires: + description: Expiration date of the ban + format: date-time + title: Ban expires + type: number + x-stream-index: "013" + banned: + description: Whether member is banned this channel or not + title: Banned type: boolean - x-stream-index: 003.002.004 + x-stream-index: "012" + channel_role: + description: Role of the member in the channel + title: Channel Role + type: string + x-stream-index: "018" created_at: + description: Date/time of creation format: date-time + title: Created at type: number - x-stream-index: 003.001.003 - custom_events: - type: boolean - x-stream-index: 003.002.012 - grants: - additionalProperties: - items: - type: string - type: array + x-stream-index: "009" + custom: + additionalProperties: {} type: object - x-stream-index: "002" - mark_messages_pending: - type: boolean - x-stream-index: 003.002.015 - max_message_length: - format: int32 - maximum: 20000 - type: integer - x-stream-index: 003.002.020 - mutes: - type: boolean - x-stream-index: 003.002.009 - name: - type: string - x-stream-index: 003.002.001 - partition_size: - format: int32 - type: integer - x-stream-index: 003.002.028 - partition_ttl: - example: 24h - format: duration - nullable: true - type: string - x-stream-index: 003.002.029 - permissions: + x-stream-index: "004" + deleted_at: + format: date-time + type: number + x-stream-index: "011" + deleted_messages: items: - $ref: '#/components/schemas/PolicyRequest' + type: string type: array - x-stream-index: "001" - polls: - type: boolean - x-stream-index: 003.002.016 - push_notifications: - type: boolean - x-stream-index: 003.002.013 - quotes: - type: boolean - x-stream-index: 003.002.008 - reactions: - type: boolean - x-stream-index: 003.002.006 - read_events: - type: boolean - x-stream-index: 003.002.003 - reminders: - type: boolean - x-stream-index: 003.002.014 - replies: - type: boolean - x-stream-index: 003.002.007 - search: + x-stream-index: "020" + invite_accepted_at: + description: Date when invite was accepted + format: date-time + title: Invited accepted at + type: number + x-stream-index: "006" + invite_rejected_at: + description: Date when invite was rejected + format: date-time + title: Invited rejected at + type: number + x-stream-index: "007" + invited: + description: Whether member was invited or not + title: Invited type: boolean - x-stream-index: 003.002.005 - shared_locations: + x-stream-index: "005" + is_moderator: + description: Whether member is channel moderator or not + title: Is moderator type: boolean - x-stream-index: 003.002.018 - skip_last_msg_update_for_system_msgs: + x-stream-index: "003" + notifications_muted: type: boolean - x-stream-index: 003.002.030 - typing_events: + x-stream-index: "019" + pinned_at: + format: date-time + type: number + x-stream-index: "016" + role: + description: 'Permission level of the member in the channel (DEPRECATED: + use channel_role instead)' + enum: + - member + - moderator + - admin + - owner + title: Role + type: string + x-stream-index: "017" + shadow_banned: + description: Whether member is shadow banned in this channel or not + title: Shadow banned type: boolean - x-stream-index: 003.002.002 + x-stream-index: "014" + status: + type: string + x-stream-index: "008" updated_at: + description: Date/time of the last update format: date-time + title: Updated at type: number - x-stream-index: 003.001.004 - uploads: - type: boolean - x-stream-index: 003.002.010 - url_enrichment: - type: boolean - x-stream-index: 003.002.011 - user_message_reminders: - type: boolean - x-stream-index: 003.002.017 + x-stream-index: "010" + user: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "002" + user_id: + title: User ID + type: string + x-stream-index: "001" required: - - permissions - - grants + - custom - created_at - updated_at - - name - - typing_events - - read_events - - connect_events - - search - - reactions - - replies - - quotes - - mutes - - uploads - - url_enrichment - - custom_events - - push_notifications - - reminders - - mark_messages_pending - - polls - - user_message_reminders - - shared_locations - - message_retention - - max_message_length - - automod - - automod_behavior - - skip_last_msg_update_for_system_msgs - - commands + - banned + - shadow_banned + - channel_role + - notifications_muted + title: Channel member type: object - ChannelUnFrozenEvent: + ChannelMemberResponse: + nullable: true properties: - channel_id: + archived_at: + format: date-time + type: number + x-stream-index: "016" + ban_expires: + description: Expiration date of the ban + format: date-time + title: Ban expires + type: number + x-stream-index: "013" + banned: + description: Whether member is banned this channel or not + title: Banned + type: boolean + x-stream-index: "012" + channel_role: + description: Role of the member in the channel + title: Channel Role type: string - x-stream-index: "002.002" - channel_type: + x-stream-index: "018" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: "009" + custom: + additionalProperties: {} + type: object + x-stream-index: "004" + deleted_at: + format: date-time + type: number + x-stream-index: "011" + invite_accepted_at: + description: Date when invite was accepted + format: date-time + title: Invited accepted at + type: number + x-stream-index: "006" + invite_rejected_at: + description: Date when invite was rejected + format: date-time + title: Invited rejected at + type: number + x-stream-index: "007" + invited: + description: Whether member was invited or not + title: Invited + type: boolean + x-stream-index: "005" + is_moderator: + description: Whether member is channel moderator or not + title: Is moderator + type: boolean + x-stream-index: "003" + notifications_muted: + type: boolean + x-stream-index: "019" + pinned_at: + format: date-time + type: number + x-stream-index: "015" + role: + description: 'Permission level of the member in the channel (DEPRECATED: + use channel_role instead)' + enum: + - member + - moderator + - admin + - owner + title: Role type: string - x-stream-index: "002.003" - cid: + x-stream-index: "017" + shadow_banned: + description: Whether member is shadow banned in this channel or not + title: Shadow banned + type: boolean + x-stream-index: "014" + status: type: string - x-stream-index: "002.001" - created_at: + x-stream-index: "008" + updated_at: + description: Date/time of the last update format: date-time + title: Updated at type: number - x-stream-index: "001.002" - type: - default: channel.unfrozen + x-stream-index: "010" + user: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "002" + user_id: + title: User ID type: string - x-stream-index: "001.001" + x-stream-index: "001" required: - - type + - custom - created_at - - cid - - channel_id - - channel_type - title: ChannelUnFrozenEvent + - updated_at + - banned + - shadow_banned + - channel_role + - notifications_muted + title: Channel member 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 - ChannelUnmutedEvent: + ChannelMessages: + nullable: true properties: - created_at: - format: date-time - type: number - x-stream-index: "001.002" - type: - default: channel.unmuted - type: string - x-stream-index: "001.001" + channel: + $ref: '#/components/schemas/ChannelResponse' + x-stream-index: "001" + messages: + items: + $ref: '#/components/schemas/Message' + type: array + x-stream-index: "002" required: - - type - - created_at - title: ChannelUnmutedEvent + - messages 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 - ChannelUpdatedEvent: + ChannelMute: + nullable: true properties: channel: $ref: '#/components/schemas/ChannelResponse' - x-stream-index: "004.004" - channel_id: - type: string - x-stream-index: "004.002" - channel_member_count: - format: int32 - type: integer - x-stream-index: "004.005" - channel_type: - type: string - x-stream-index: "004.003" - cid: - type: string - x-stream-index: "004.001" + description: Channel that is muted + title: Channel + x-stream-index: "002" created_at: + description: Date/time of creation format: date-time + title: Created at type: number - x-stream-index: "003.002" - message: - $ref: '#/components/schemas/Message' - x-stream-index: "001" - team: - type: string - x-stream-index: "002.001" - type: - default: channel.updated - type: string - x-stream-index: "003.001" + x-stream-index: "004" + expires: + description: Date/time of mute expiration + format: date-time + title: Expires + type: number + x-stream-index: "003" + updated_at: + description: Date/time of the last update + format: date-time + title: Updated at + type: number + x-stream-index: "005" user: - $ref: '#/components/schemas/User' - x-stream-index: "005.001" + $ref: '#/components/schemas/UserResponse' + description: Owner of channel mute + title: User + x-stream-index: "001" required: - - type - created_at - - cid - - channel_id - - channel_type - - channel_member_count - title: ChannelUpdatedEvent + - updated_at 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 - ChannelVisibleEvent: + ChannelMutedEvent: properties: - channel_id: - type: string - x-stream-index: "001.002" - channel_type: - type: string - x-stream-index: "001.003" - cid: - type: string - x-stream-index: "001.001" created_at: format: date-time type: number - x-stream-index: "003.002" + x-stream-index: "001.002" type: - default: channel.visible + default: channel.muted type: string - x-stream-index: "003.001" - user: - $ref: '#/components/schemas/User' - x-stream-index: "002.001" + x-stream-index: "001.001" required: - - cid - - channel_id - - channel_type - type - created_at - title: ChannelVisibleEvent + title: ChannelMutedEvent 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 - ChatActivityStatsResponse: - properties: - Messages: - $ref: '#/components/schemas/MessageStatsResponse' - x-stream-index: "001" - type: object - CheckExternalStorageResponse: - description: Basic response information - nullable: true + ChannelOwnCapability: + description: All possibility of string to use + enum: + - ban-channel-members + - cast-poll-vote + - connect-events + - create-attachment + - delete-any-message + - delete-channel + - delete-own-message + - flag-message + - freeze-channel + - join-channel + - leave-channel + - mute-channel + - pin-message + - query-poll-votes + - quote-message + - read-events + - search-messages + - send-custom-events + - send-links + - send-message + - send-poll + - send-reaction + - send-reply + - send-restricted-visibility-message + - send-typing-events + - set-channel-cooldown + - share-location + - skip-slow-mode + - slow-mode + - typing-events + - update-any-message + - update-channel + - update-channel-members + - update-own-message + - update-thread + - upload-file + title: ChannelOwnCapability + type: string + ChannelPushPreferences: properties: - duration: - description: Duration of the request in milliseconds - title: Duration - type: string - x-stream-index: "001.001" - file_url: + chat_level: type: string + x-stream-index: "001" + disabled_until: + format: date-time + type: number x-stream-index: "002" - required: - - duration - - file_url - title: Response type: object - CheckPushRequest: - description: Check push request - nullable: true + ChannelResponse: + description: Represents channel in chat properties: - apn_template: - description: Push message template for APN - title: APN template - type: string - x-stream-docs-page-id: push_template - x-stream-index: "002" - event_type: - description: 'Type of event for push templates (default: message.new)' - enum: - - message.new - - message.updated - - reaction.new - - reaction.updated - - notification.reminder_due - title: Event type - type: string - x-stream-index: "008" - firebase_data_template: - description: Push message data template for Firebase - title: Firebase data template - type: string - x-stream-docs-page-id: push_template - x-stream-index: "004" - firebase_template: - description: Push message template for Firebase - title: Firebase template - type: string - x-stream-docs-page-id: push_template - x-stream-index: "003" - message_id: - description: Message ID to send push notification for - title: Message ID - type: string - x-stream-index: "001" - push_provider_name: - description: Name of push provider - title: Name of push provider - type: string - x-stream-index: "007" - push_provider_type: - description: Push provider type - enum: - - firebase - - apn - - huawei - - xiaomi - title: Type of push provider + auto_translation_enabled: + description: Whether auto translation is enabled or not + title: Auto translation + type: boolean + x-stream-index: "017" + auto_translation_language: + description: Language to translate to when auto translation is active + title: Auto translation language type: string - x-stream-index: "006" - skip_devices: - description: Don't require existing devices to render templates - title: Skip devices + x-stream-index: "018" + blocked: + description: Whether this channel is blocked by current user or not + title: Blocked type: boolean - x-stream-index: "005" - user: - $ref: '#/components/schemas/UserRequest' - x-stream-index: "009.002" - user_id: - type: string - x-stream-index: "009.001" - title: CheckPushRequest - type: object - CheckPushResponse: - nullable: true - properties: - device_errors: - additionalProperties: - $ref: '#/components/schemas/DeviceErrorInfo' - description: Object with device errors - title: Device errors - type: object - x-stream-index: "001" - x-stream-map: - key: device_id - duration: - type: string - x-stream-index: "008.001" - event_type: - description: The event type that was tested - title: Event type - type: string - x-stream-index: "004" - general_errors: - description: List of general errors - items: - type: string - title: General errors - type: array - x-stream-index: "002" - rendered_apn_template: - title: Rendered APN template + x-stream-index: "023" + cid: + description: Channel CID (:) + title: CID type: string + x-stream-index: "003" + config: + $ref: '#/components/schemas/ChannelConfigWithInfo' + description: Channel configuration + title: ChannelConfigWithInfo + x-stream-index: "013" + cooldown: + description: Cooldown period after sending each message + format: int32 + title: Cooldown + type: integer + x-stream-index: "020" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number x-stream-index: "005" - rendered_firebase_template: - title: Rendered Firebase template - type: string - x-stream-index: "006" - rendered_message: - additionalProperties: - type: string - title: Rendered message + created_by: + $ref: '#/components/schemas/UserResponse' + description: Creator of the channel + title: UserResponse + x-stream-index: "008" + custom: + additionalProperties: {} + description: Custom data for this object + title: Custom data type: object + x-stream-index: "026" + deleted_at: + description: Date/time of deletion + format: date-time + title: Deleted at + type: number x-stream-index: "007" - skip_devices: - description: Don't require existing devices to render templates - title: Skip devices + disabled: type: boolean - x-stream-index: "003" - required: - - duration - type: object - CheckRequest: - nullable: true - properties: - config_key: - description: Key of the moderation configuration to use - title: Config Key - type: string - x-stream-index: "005" - config_team: - description: Team associated with the configuration - title: Config Team - type: string - x-stream-index: "006" - entity_creator_id: - description: ID of the user who created the entity - title: Entity Creator ID - type: string - x-stream-index: "003" - entity_id: - description: Unique identifier of the entity to moderate - title: Entity ID - type: string - x-stream-index: "002" - entity_type: - description: Type of entity to moderate - title: Entity Type + x-stream-index: "010" + frozen: + description: Whether channel is frozen or not + title: Frozen + type: boolean + x-stream-index: "009" + hidden: + description: Whether this channel is hidden by current user or not + title: Hidden + type: boolean + x-stream-index: "022" + hide_messages_before: + description: Date since when the message history is accessible + format: date-time + title: Hide messages before + type: number + x-stream-index: "019" + id: + description: Channel unique ID + title: ID type: string x-stream-index: "001" - moderation_payload: - $ref: '#/components/schemas/ModerationPayload' - description: Content to be moderated - title: Moderation Payload + last_message_at: + description: Date of the last message sent + format: date-time + title: Last message at + type: number x-stream-index: "004" - options: - additionalProperties: {} - description: Additional moderation configuration options - title: Options - type: object - x-stream-index: "007" - test_mode: - description: Whether to run moderation in test mode - title: Test Mode + member_count: + description: Number of members in the channel + format: int32 + title: Member count + type: integer + x-stream-index: "012" + members: + description: List of channel members (max 100) + items: + $ref: '#/components/schemas/ChannelMember' + title: ChannelMembers + type: array + x-stream-index: "011" + message_count: + description: Number of messages in the channel + format: int64 + title: Message count + type: integer + x-stream-index: "027" + mute_expires_at: + description: Date of mute expiration + format: date-time + title: Mute expires at + type: number + x-stream-index: "015" + muted: + description: Whether this channel is muted or not + title: Muted type: boolean - x-stream-index: "008" - user: - $ref: '#/components/schemas/UserRequest' - x-stream-index: "009.002" - user_id: + x-stream-index: "014" + own_capabilities: + description: List of channel capabilities of authenticated user + items: + $ref: '#/components/schemas/ChannelOwnCapability' + title: ChannelOwnCapability + type: array + x-stream-index: "021" + team: + description: Team the channel belongs to (multi-tenant only) + title: Team type: string - x-stream-index: "009.001" + x-stream-index: "016" + truncated_at: + description: Date of the latest truncation of the channel + format: date-time + title: UserResponse + type: number + x-stream-index: "024" + truncated_by: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "025" + type: + description: Type of the channel + title: Type + type: string + x-stream-docs-page-id: channel_features + x-stream-index: "002" + updated_at: + description: Date/time of the last update + format: date-time + title: Updated at + type: number + x-stream-index: "006" required: - - entity_type - - entity_id - - entity_creator_id - - config_key + - id + - type + - cid + - created_at + - updated_at + - frozen + - disabled + - custom + title: Channel type: object - CheckResponse: + ChannelStateResponse: nullable: true properties: + active_live_locations: + items: + $ref: '#/components/schemas/SharedLocationResponseData' + type: array + x-stream-index: "001.015" + channel: + $ref: '#/components/schemas/ChannelResponse' + x-stream-index: "001.001" + deleted_messages: + items: + type: string + type: array + x-stream-index: "001.016" + draft: + $ref: '#/components/schemas/DraftResponse' + x-stream-index: "001.014" duration: type: string - x-stream-index: "005.001" - item: - $ref: '#/components/schemas/ReviewQueueItemResponse' - description: Review queue item (present if action != keep) - title: Item - x-stream-index: "004" - recommended_action: - description: Suggested action based on moderation results - title: Recommended Action - type: string - x-stream-index: "003" - status: - description: Status of the moderation check (completed or pending) - title: Status - type: string - x-stream-index: "001" - task_id: - description: ID of the running moderation task - title: Task ID - type: string - x-stream-index: "002" + x-stream-index: "002.001" + hidden: + type: boolean + x-stream-index: "001.011" + hide_messages_before: + format: date-time + type: number + x-stream-index: "001.012" + members: + items: + $ref: '#/components/schemas/ChannelMember' + type: array + x-stream-index: "001.007" + membership: + $ref: '#/components/schemas/ChannelMember' + x-stream-index: "001.008" + messages: + items: + $ref: '#/components/schemas/MessageResponse' + type: array + x-stream-index: "001.002" + pending_messages: + items: + $ref: '#/components/schemas/PendingMessageResponse' + type: array + x-stream-index: "001.013" + pinned_messages: + items: + $ref: '#/components/schemas/MessageResponse' + type: array + x-stream-index: "001.003" + push_preferences: + $ref: '#/components/schemas/ChannelPushPreferences' + x-stream-index: "001.009" + read: + items: + $ref: '#/components/schemas/ReadStateResponse' + type: array + x-stream-index: "001.006" + threads: + items: + $ref: '#/components/schemas/ThreadStateResponse' + type: array + x-stream-index: "001.010" + watcher_count: + format: int32 + type: integer + x-stream-index: "001.004" + watchers: + items: + $ref: '#/components/schemas/UserResponse' + type: array + x-stream-index: "001.005" required: - - status - - recommended_action + - messages + - pinned_messages + - members + - threads - duration type: object - CheckSNSRequest: - nullable: true + ChannelStateResponseFields: properties: - sns_key: - description: AWS SNS access key - title: SNS key - type: string + active_live_locations: + description: Active live locations in the channel + items: + $ref: '#/components/schemas/SharedLocationResponseData' + title: Active Live Locations + type: array + x-stream-index: "015" + channel: + $ref: '#/components/schemas/ChannelResponse' + x-stream-index: "001" + deleted_messages: + items: + type: string + type: array + x-stream-index: "016" + draft: + $ref: '#/components/schemas/DraftResponse' + x-stream-index: "014" + hidden: + description: Whether this channel is hidden or not + title: Hidden + type: boolean + x-stream-index: "011" + hide_messages_before: + description: Messages before this date are hidden from the user + format: date-time + title: Hide messages before + type: number + x-stream-index: "012" + members: + description: List of channel members + items: + $ref: '#/components/schemas/ChannelMember' + title: Members + type: array + x-stream-index: "007" + membership: + $ref: '#/components/schemas/ChannelMember' + description: Current user membership object + title: Membership + x-stream-index: "008" + messages: + description: List of channel messages + items: + $ref: '#/components/schemas/MessageResponse' + title: Message + type: array x-stream-index: "002" - sns_secret: - description: AWS SNS key secret - title: SNS secret - type: string + pending_messages: + description: Pending messages that this user has sent + items: + $ref: '#/components/schemas/PendingMessageResponse' + title: Pending messages + type: array + x-stream-index: "013" + pinned_messages: + description: List of pinned messages in the channel + items: + $ref: '#/components/schemas/MessageResponse' + title: Pinned messages + type: array + x-stream-docs-page-id: pinned_messages x-stream-index: "003" - sns_topic_arn: - description: AWS SNS topic ARN - title: SNS Topic ARN - type: string - x-stream-index: "001" + push_preferences: + $ref: '#/components/schemas/ChannelPushPreferences' + x-stream-index: "009" + read: + description: List of read states + items: + $ref: '#/components/schemas/ReadStateResponse' + title: Read + type: array + x-stream-index: "006" + threads: + items: + $ref: '#/components/schemas/ThreadStateResponse' + type: array + x-stream-index: "010" + watcher_count: + description: Number of channel watchers + format: int32 + title: Watcher count + type: integer + x-stream-index: "004" + watchers: + description: List of user who is watching the channel + items: + $ref: '#/components/schemas/UserResponse' + title: Watchers + type: array + x-stream-index: "005" + required: + - messages + - pinned_messages + - members + - threads type: object - CheckSNSResponse: - nullable: true + ChannelTruncatedEvent: properties: - data: - additionalProperties: {} - description: Error data - title: ReadOnlyData - type: object - x-stream-index: "003" - duration: + channel: + $ref: '#/components/schemas/ChannelResponse' + x-stream-index: "001.004" + channel_id: type: string - x-stream-index: "004.001" - error: - description: Error text - title: Error + x-stream-index: "001.002" + channel_member_count: + format: int32 + type: integer + x-stream-index: "001.005" + channel_type: type: string - x-stream-index: "002" - status: - description: Validation result - enum: - - ok - - error - title: Status + x-stream-index: "001.003" + cid: type: string - x-stream-index: "001" + x-stream-index: "001.001" + created_at: + format: date-time + type: number + x-stream-index: "002.002" + type: + default: channel.truncated + type: string + x-stream-index: "002.001" required: - - status - - duration + - cid + - channel_id + - channel_type + - channel_member_count + - type + - created_at + title: ChannelTruncatedEvent type: object - CheckSQSRequest: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + ChannelTypeConfig: nullable: true properties: - sqs_key: - description: AWS SQS access key - title: SQS key + allowed_flag_reasons: + items: + type: string + type: array + x-stream-index: 003.002.027 + automod: + enum: + - disabled + - simple + - AI type: string - x-stream-index: "002" - sqs_secret: - description: AWS SQS key secret - title: SQS secret + x-stream-index: 003.002.022 + automod_behavior: + enum: + - flag + - block + - shadow_block type: string - x-stream-index: "003" - sqs_url: - description: AWS SQS endpoint URL - title: SQS URL + x-stream-index: 003.002.023 + automod_thresholds: + $ref: '#/components/schemas/Thresholds' + x-stream-index: 003.002.028 + blocklist: type: string - x-stream-index: "001" - type: object - CheckSQSResponse: - nullable: true - properties: - data: - additionalProperties: {} - description: Error data - title: ReadOnlyData - type: object - x-stream-index: "003" - duration: - type: string - x-stream-index: "004.001" - error: - description: Error text - title: Error + x-stream-index: 003.002.024 + blocklist_behavior: + enum: + - flag + - block + - shadow_block type: string + x-stream-index: 003.002.025 + blocklists: + items: + $ref: '#/components/schemas/BlockListOptions' + type: array + x-stream-index: 003.002.026 + commands: + items: + $ref: '#/components/schemas/Command' + type: array + x-stream-index: "003.003" + connect_events: + type: boolean + x-stream-index: 003.002.004 + count_messages: + type: boolean + x-stream-index: 003.002.019 + created_at: + format: date-time + type: number + x-stream-index: 003.001.003 + custom_events: + type: boolean + x-stream-index: 003.002.012 + grants: + additionalProperties: + items: + type: string + type: array + type: object x-stream-index: "002" - status: - description: Validation result - enum: - - ok - - error - title: Status + mark_messages_pending: + type: boolean + x-stream-index: 003.002.015 + max_message_length: + format: int32 + maximum: 20000 + type: integer + x-stream-index: 003.002.021 + mutes: + type: boolean + x-stream-index: 003.002.009 + name: + type: string + x-stream-index: 003.002.001 + partition_size: + format: int32 + type: integer + x-stream-index: 003.002.029 + partition_ttl: + example: 24h + format: duration + nullable: true type: string + x-stream-index: 003.002.030 + permissions: + items: + $ref: '#/components/schemas/PolicyRequest' + type: array x-stream-index: "001" + polls: + type: boolean + x-stream-index: 003.002.016 + push_notifications: + type: boolean + x-stream-index: 003.002.013 + quotes: + type: boolean + x-stream-index: 003.002.008 + reactions: + type: boolean + x-stream-index: 003.002.006 + read_events: + type: boolean + x-stream-index: 003.002.003 + reminders: + type: boolean + x-stream-index: 003.002.014 + replies: + type: boolean + x-stream-index: 003.002.007 + search: + type: boolean + x-stream-index: 003.002.005 + shared_locations: + type: boolean + x-stream-index: 003.002.018 + skip_last_msg_update_for_system_msgs: + type: boolean + x-stream-index: 003.002.031 + typing_events: + type: boolean + x-stream-index: 003.002.002 + updated_at: + format: date-time + type: number + x-stream-index: 003.001.004 + uploads: + type: boolean + x-stream-index: 003.002.010 + url_enrichment: + type: boolean + x-stream-index: 003.002.011 + user_message_reminders: + type: boolean + x-stream-index: 003.002.017 required: - - status - - duration + - permissions + - grants + - created_at + - updated_at + - name + - typing_events + - read_events + - connect_events + - search + - reactions + - replies + - quotes + - mutes + - uploads + - url_enrichment + - custom_events + - push_notifications + - reminders + - mark_messages_pending + - polls + - user_message_reminders + - shared_locations + - count_messages + - message_retention + - max_message_length + - automod + - automod_behavior + - skip_last_msg_update_for_system_msgs + - commands type: object - ClientOSDataResponse: + ChannelUnFrozenEvent: properties: - architecture: + channel_id: type: string - x-stream-index: "003" - name: + x-stream-index: "002.002" + channel_type: type: string - x-stream-index: "001" - version: + x-stream-index: "002.003" + cid: type: string - x-stream-index: "002" + x-stream-index: "002.001" + created_at: + format: date-time + type: number + x-stream-index: "001.002" + type: + default: channel.unfrozen + type: string + x-stream-index: "001.001" + required: + - type + - created_at + - cid + - channel_id + - channel_type + title: ChannelUnFrozenEvent type: object - ClosedCaptionEvent: - description: This event is sent when closed captions are being sent in a call, - clients should use this to show the closed captions in the call screen + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + ChannelUnmutedEvent: properties: - call_cid: - type: string - x-stream-index: "002.001" - closed_caption: - $ref: '#/components/schemas/CallClosedCaption' - description: The closed caption object - title: CallClosedCaption - x-stream-index: "003" created_at: format: date-time type: number x-stream-index: "001.002" type: - default: call.closed_caption - description: 'The type of event: "call.closed_caption" in this case' - title: Event Type + default: channel.unmuted type: string x-stream-index: "001.001" required: - type - created_at - - call_cid - - closed_caption - title: ClosedCaptionEvent + title: ChannelUnmutedEvent type: object - x-stream-event-call-type: true - x-stream-event-doc-group: transcription + x-stream-event-client-type: true + x-stream-event-doc-group: other x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - CollectUserFeedbackRequest: - nullable: true + ChannelUpdatedEvent: properties: - custom: - additionalProperties: {} - type: object - x-stream-index: "009" - rating: + channel: + $ref: '#/components/schemas/ChannelResponse' + x-stream-index: "004.004" + channel_id: + type: string + x-stream-index: "004.002" + channel_member_count: format: int32 - maximum: 5 - minimum: 1 type: integer - x-stream-index: "007" - reason: - maxLength: 1000 + x-stream-index: "004.005" + channel_type: type: string - x-stream-index: "008" - sdk: - maxLength: 50 + x-stream-index: "004.003" + cid: type: string - x-stream-index: "005" - sdk_version: - maxLength: 50 + x-stream-index: "004.001" + created_at: + format: date-time + type: number + x-stream-index: "003.002" + message: + $ref: '#/components/schemas/Message' + x-stream-index: "001" + team: type: string - x-stream-index: "006" - user_session_id: - maxLength: 50 + x-stream-index: "002.001" + type: + default: channel.updated type: string - x-stream-index: "004" + x-stream-index: "003.001" + user: + $ref: '#/components/schemas/User' + x-stream-index: "005.001" required: - - sdk - - sdk_version - - rating + - type + - created_at + - cid + - channel_id + - channel_type + - channel_member_count + title: ChannelUpdatedEvent type: object - CollectUserFeedbackResponse: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + ChannelVisibleEvent: + properties: + channel_id: + type: string + x-stream-index: "001.002" + channel_type: + type: string + x-stream-index: "001.003" + cid: + type: string + x-stream-index: "001.001" + created_at: + format: date-time + type: number + x-stream-index: "003.002" + type: + default: channel.visible + type: string + x-stream-index: "003.001" + user: + $ref: '#/components/schemas/User' + x-stream-index: "002.001" + required: + - cid + - channel_id + - channel_type + - type + - created_at + title: ChannelVisibleEvent + 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 + ChatActivityStatsResponse: + properties: + Messages: + $ref: '#/components/schemas/MessageStatsResponse' + x-stream-index: "001" + type: object + CheckExternalStorageResponse: description: Basic response information nullable: true properties: @@ -7269,1098 +8870,1758 @@ components: title: Duration type: string x-stream-index: "001.001" + file_url: + type: string + x-stream-index: "002" required: - duration + - file_url title: Response type: object - Command: - description: Represents custom chat command + CheckPushRequest: + description: Check push request nullable: true properties: - args: - description: Arguments help text, shown in commands auto-completion - title: Arguments + apn_template: + description: Push message template for APN + title: APN template type: string - x-stream-index: "006" - created_at: - description: Date/time of creation - format: date-time - readOnly: true - title: Created at - type: number - x-stream-index: "001" - description: - description: Description, shown in commands auto-completion - title: Description + x-stream-docs-page-id: push_template + x-stream-index: "002" + event_type: + description: 'Type of event for push templates (default: message.new)' + enum: + - message.new + - message.updated + - reaction.new + - reaction.updated + - notification.reminder_due + title: Event type type: string - x-stream-index: "005" - name: - description: Unique command name - title: Name + x-stream-index: "008" + firebase_data_template: + description: Push message data template for Firebase + title: Firebase data template type: string + x-stream-docs-page-id: push_template x-stream-index: "004" - set: - description: Set name used for grouping commands - title: Set + firebase_template: + description: Push message template for Firebase + title: Firebase template + type: string + x-stream-docs-page-id: push_template + x-stream-index: "003" + message_id: + description: Message ID to send push notification for + title: Message ID + type: string + x-stream-index: "001" + push_provider_name: + description: Name of push provider + title: Name of push provider type: string x-stream-index: "007" - updated_at: - description: Date/time of the last update - format: date-time - readOnly: true - title: Updated at - type: number - x-stream-index: "002" - required: - - name - - description - - args - - set - title: Command - type: object - CommitMessageRequest: - nullable: true - type: object - CompositeAppSettings: - properties: - json_encoded_settings: + push_provider_type: + description: Push provider type + enum: + - firebase + - apn + - huawei + - xiaomi + title: Type of push provider type: string + x-stream-index: "006" + skip_devices: + description: Don't require existing devices to render templates + title: Skip devices + type: boolean x-stream-index: "005" - url: + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "009.002" + user_id: type: string - x-stream-index: "004" + x-stream-index: "009.001" + title: CheckPushRequest type: object - ConfigOverrides: + CheckPushResponse: + nullable: true properties: - blocklist: + device_errors: + additionalProperties: + $ref: '#/components/schemas/DeviceErrorInfo' + description: Object with device errors + title: Device errors + type: object + x-stream-index: "001" + x-stream-map: + key: device_id + duration: type: string - x-stream-index: "008" - blocklist_behavior: - enum: - - flag - - block + x-stream-index: "008.001" + event_type: + description: The event type that was tested + title: Event type type: string - x-stream-index: "009" - commands: + x-stream-index: "004" + general_errors: + description: List of general errors items: type: string + title: General errors type: array - x-stream-index: "011" - grants: + x-stream-index: "002" + rendered_apn_template: + title: Rendered APN template + type: string + x-stream-index: "005" + rendered_firebase_template: + title: Rendered Firebase template + type: string + x-stream-index: "006" + rendered_message: additionalProperties: - items: - type: string - type: array + type: string + title: Rendered message type: object - x-stream-index: "010" - max_message_length: - format: int32 - maximum: 20000 - type: integer x-stream-index: "007" - quotes: - type: boolean - x-stream-index: "004" - reactions: - type: boolean - x-stream-index: "002" - replies: + skip_devices: + description: Don't require existing devices to render templates + title: Skip devices type: boolean x-stream-index: "003" - shared_locations: - type: boolean - x-stream-index: "013" - typing_events: - type: boolean - x-stream-index: "001" - uploads: - type: boolean - x-stream-index: "005" - url_enrichment: - type: boolean - x-stream-index: "006" - user_message_reminders: - type: boolean - x-stream-index: "012" required: - - grants - - commands + - duration type: object - ConfigResponse: + CheckRequest: + nullable: true properties: - ai_image_config: - $ref: '#/components/schemas/AIImageConfig' - description: Configuration for AI image analysis - title: AI Image Config - x-stream-index: "009" - ai_text_config: - $ref: '#/components/schemas/AITextConfig' - description: Configuration for AI text analysis - title: AI Text Config - x-stream-index: "008" - ai_video_config: - $ref: '#/components/schemas/AIVideoConfig' - description: Configuration for AI video analysis - title: AI Video Config - x-stream-index: "010" - async: - description: Whether moderation should be performed asynchronously - title: Async - type: boolean - x-stream-index: "003" - automod_platform_circumvention_config: - $ref: '#/components/schemas/AutomodPlatformCircumventionConfig' - description: Configuration for platform circumvention detection - title: Automod Platform Circumvention Config + config_key: + description: Key of the moderation configuration to use + title: Config Key + type: string x-stream-index: "005" - automod_semantic_filters_config: - $ref: '#/components/schemas/AutomodSemanticFiltersConfig' - description: Configuration for semantic filtering - title: Automod Semantic Filters Config + config_team: + description: Team associated with the configuration + title: Config Team + type: string x-stream-index: "006" - automod_toxicity_config: - $ref: '#/components/schemas/AutomodToxicityConfig' - description: Configuration for toxicity detection - title: Automod Toxicity Config + entity_creator_id: + description: ID of the user who created the entity + title: Entity Creator ID + type: string + x-stream-index: "003" + entity_id: + description: Unique identifier of the entity to moderate + title: Entity ID + type: string + x-stream-index: "002" + entity_type: + description: Type of entity to moderate + title: Entity Type + type: string + x-stream-index: "001" + moderation_payload: + $ref: '#/components/schemas/ModerationPayload' + description: Content to be moderated + title: Moderation Payload x-stream-index: "004" - block_list_config: - $ref: '#/components/schemas/BlockListConfig' - description: Configuration for block list filtering - title: Block List Config + options: + additionalProperties: {} + description: Additional moderation configuration options + title: Options + type: object x-stream-index: "007" - created_at: - description: When the configuration was created - format: date-time - title: Created At - type: number - x-stream-index: "012" - key: - description: Unique identifier for the moderation configuration - title: Key + test_mode: + description: Whether to run moderation in test mode + title: Test Mode + type: boolean + x-stream-index: "008" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "009.002" + user_id: + type: string + x-stream-index: "009.001" + required: + - entity_type + - entity_id + - entity_creator_id + type: object + CheckResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "005.001" + item: + $ref: '#/components/schemas/ReviewQueueItemResponse' + description: Review queue item (present if action != keep) + title: Item + x-stream-index: "004" + recommended_action: + description: Suggested action based on moderation results + title: Recommended Action + type: string + x-stream-index: "003" + status: + description: Status of the moderation check (completed or pending) + title: Status type: string x-stream-index: "001" - rule_builder_config: - $ref: '#/components/schemas/RuleBuilderConfig' - x-stream-index: "015" - team: - description: Team associated with the configuration - title: Team + task_id: + description: ID of the running moderation task + title: Task ID type: string x-stream-index: "002" - updated_at: - description: When the configuration was last updated - format: date-time - title: Updated At - type: number - x-stream-index: "013" - velocity_filter_config: - $ref: '#/components/schemas/VelocityFilterConfig' - description: Configuration for velocity-based filtering - title: Velocity Filter Config - x-stream-index: "011" - video_call_rule_config: - $ref: '#/components/schemas/VideoCallRuleConfig' - x-stream-index: "014" required: - - key - - team - - async - - created_at - - updated_at + - status + - recommended_action + - duration type: object - ContentCountRuleParameters: + CheckSNSRequest: + nullable: true properties: - threshold: - format: int32 - type: integer + sns_key: + description: AWS SNS access key + title: SNS key + type: string + x-stream-index: "002" + sns_secret: + description: AWS SNS key secret + title: SNS secret + type: string + x-stream-index: "003" + sns_topic_arn: + description: AWS SNS topic ARN + title: SNS Topic ARN + type: string x-stream-index: "001" - time_window: + type: object + CheckSNSResponse: + nullable: true + properties: + data: + additionalProperties: {} + description: Error data + title: ReadOnlyData + type: object + x-stream-index: "003" + duration: + type: string + x-stream-index: "004.001" + error: + description: Error text + title: Error type: string x-stream-index: "002" + status: + description: Validation result + enum: + - ok + - error + title: Status + type: string + x-stream-index: "001" required: - - threshold - - time_window + - status + - duration type: object - CountByMinuteResponse: + CheckSQSRequest: nullable: true properties: - count: - format: int32 - type: integer + sqs_key: + description: AWS SQS access key + title: SQS key + type: string x-stream-index: "002" - start_ts: - format: date-time - type: number + sqs_secret: + description: AWS SQS key secret + title: SQS secret + type: string + x-stream-index: "003" + sqs_url: + description: AWS SQS endpoint URL + title: SQS URL + type: string x-stream-index: "001" - required: - - start_ts - - count type: object - CreateBlockListRequest: - description: Block list contains restricted words + CheckSQSResponse: nullable: true properties: + data: + additionalProperties: {} + description: Error data + title: ReadOnlyData + type: object + x-stream-index: "003" + duration: + type: string + x-stream-index: "004.001" + error: + description: Error text + title: Error + type: string + x-stream-index: "002" + status: + description: Validation result + enum: + - ok + - error + title: Status + type: string + x-stream-index: "001" + required: + - status + - duration + type: object + ClientOSDataResponse: + properties: + architecture: + type: string + x-stream-index: "003" name: - description: Block list name - maxLength: 255 - title: Name type: string x-stream-index: "001" - team: + version: type: string - x-stream-index: "004" - type: - description: Block list type. - enum: - - regex - - domain - - domain_allowlist - - email - - word - title: Type + x-stream-index: "002" + type: object + ClosedCaptionEvent: + description: This event is sent when closed captions are being sent in a call, + clients should use this to show the closed captions in the call screen + properties: + call_cid: type: string + x-stream-index: "002.001" + closed_caption: + $ref: '#/components/schemas/CallClosedCaption' + description: The closed caption object + title: CallClosedCaption x-stream-index: "003" - words: - description: List of words to block - items: - type: string + created_at: + format: date-time + type: number + x-stream-index: "001.002" + type: + default: call.closed_caption + description: 'The type of event: "call.closed_caption" in this case' + title: Event Type + type: string + x-stream-index: "001.001" + required: + - type + - created_at + - call_cid + - closed_caption + title: ClosedCaptionEvent + type: object + x-stream-event-call-type: true + x-stream-event-doc-group: transcription + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + CollectUserFeedbackRequest: + nullable: true + properties: + custom: + additionalProperties: {} + type: object + x-stream-index: "009" + rating: + format: int32 + maximum: 5 minimum: 1 - title: Words - type: array - x-stream-index: "002" + type: integer + x-stream-index: "007" + reason: + maxLength: 1000 + type: string + x-stream-index: "008" + sdk: + maxLength: 50 + type: string + x-stream-index: "005" + sdk_version: + maxLength: 50 + type: string + x-stream-index: "006" + user_session_id: + maxLength: 50 + type: string + x-stream-index: "004" required: - - name - - words - title: Block list + - sdk + - sdk_version + - rating type: object - x-stream-docs-page-id: block_lists - CreateBlockListResponse: + CollectUserFeedbackResponse: description: Basic response information nullable: true properties: - blocklist: - $ref: '#/components/schemas/BlockListResponse' - x-stream-index: "001" duration: description: Duration of the request in milliseconds title: Duration type: string - x-stream-index: "002.001" + x-stream-index: "001.001" required: - duration title: Response type: object - CreateCallTypeRequest: - description: Request for creating a call type + Command: + description: Represents custom chat command nullable: true properties: - external_storage: - description: the external storage for the call type - title: ExternalStorage + args: + description: Arguments help text, shown in commands auto-completion + title: Arguments type: string - x-stream-index: "002.004" - grants: - additionalProperties: - items: - type: string - type: array - description: the permissions granted to each role - title: Grants - type: object - x-stream-index: "002.001" + x-stream-index: "006" + created_at: + description: Date/time of creation + format: date-time + readOnly: true + title: Created at + type: number + x-stream-index: "001" + description: + description: Description, shown in commands auto-completion + title: Description + type: string + x-stream-index: "005" name: + description: Unique command name + title: Name type: string - x-stream-index: "001" - notification_settings: - $ref: '#/components/schemas/NotificationSettings' - description: the notification settings for the call type - title: NotificationSettings - x-stream-index: "002.002" - settings: - $ref: '#/components/schemas/CallSettingsRequest' - description: the settings for the call type - title: Settings - x-stream-index: "002.003" + x-stream-index: "004" + set: + description: Set name used for grouping commands + title: Set + type: string + x-stream-index: "007" + updated_at: + description: Date/time of the last update + format: date-time + readOnly: true + title: Updated at + type: number + x-stream-index: "002" required: - name - title: CreateCallTypeRequest + - description + - args + - set + title: Command type: object - CreateCallTypeResponse: - description: Response for creating a call type + CommentAddedEvent: + description: Emitted when a comment is added to an activity. nullable: true properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + x-stream-index: "002" + comment: + $ref: '#/components/schemas/CommentResponse' + description: The comment that was added + title: Text + x-stream-index: "001" created_at: - description: the time the call type was created + description: Date/time of creation format: date-time - title: CreatedAt + title: Created at type: number - x-stream-index: "001.005" - duration: - type: string - x-stream-index: "002.001" - external_storage: - description: the external storage for the call type - title: ExternalStorage - type: string - x-stream-index: "001.007" - grants: - additionalProperties: - items: - type: string - type: array - description: the permissions granted to each role - title: Grants + x-stream-index: 003.001.003 + custom: + additionalProperties: {} type: object - x-stream-index: "001.002" - name: - description: the name of the call type - title: Name + x-stream-index: 003.001.007 + feed_visibility: type: string - x-stream-index: "001.001" - notification_settings: - $ref: '#/components/schemas/NotificationSettings' - description: the notification settings for the call type - title: NotificationSettings - x-stream-index: "001.004" - settings: - $ref: '#/components/schemas/CallSettingsResponse' - description: the settings for the call type - title: Settings - x-stream-index: "001.003" - updated_at: - description: the time the call type was last updated + x-stream-index: "003.003" + fid: + type: string + x-stream-index: "003.002" + received_at: format: date-time - title: UpdatedAt type: number - x-stream-index: "001.006" + x-stream-index: 003.001.004 + type: + default: feeds.comment.added + description: 'The type of event: "feeds.comment.added" in this case' + title: Event Type + type: string + x-stream-index: 003.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who added the comment + title: User + x-stream-index: "004.001" required: - - name - - grants - - settings - - notification_settings + - comment + - activity + - type - created_at - - updated_at - - duration - title: CreateCallTypeResponse + - custom + - fid + title: CommentAddedEvent type: object - CreateChannelTypeRequest: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + CommentDeletedEvent: + description: Emitted when a comment is deleted. nullable: true properties: - automod: - description: Automod - enum: - - disabled - - simple - - AI - title: Automod - type: string - x-stream-index: "019" - automod_behavior: - description: Automod behavior - enum: - - flag - - block - title: Automod behavior + comment: + $ref: '#/components/schemas/CommentResponse' + x-stream-index: "001" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + feed_visibility: type: string - x-stream-index: "020" - blocklist: - description: Blocklist - title: Blocklist + x-stream-index: "002.003" + fid: type: string - x-stream-index: "024" - blocklist_behavior: - description: Blocklist behavior - enum: - - flag - - block - - shadow_block - title: Blocklist behavior + x-stream-index: "002.002" + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 + type: + default: feeds.comment.deleted + description: 'The type of event: "feeds.comment.deleted" in this case' + title: Event Type type: string - x-stream-index: "025" - blocklists: - description: Blocklists - items: - $ref: '#/components/schemas/BlockListOptions' - title: Blocklists - type: array - x-stream-index: "026" - commands: - description: List of commands that channel supports + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who deleted the comment + title: User + x-stream-index: "003.001" + required: + - comment + - type + - created_at + - custom + - fid + title: CommentDeletedEvent + 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 + CommentReactionAddedEvent: + description: Emitted when a reaction is added to a comment. + nullable: true + properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + x-stream-index: "003" + comment: + $ref: '#/components/schemas/CommentResponse' + x-stream-index: "001" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 004.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 004.001.007 + feed_visibility: + type: string + x-stream-index: "004.003" + fid: + type: string + x-stream-index: "004.002" + reaction: + $ref: '#/components/schemas/FeedsReactionResponse' + description: The reaction that was added + title: Reaction + x-stream-index: "002" + received_at: + format: date-time + type: number + x-stream-index: 004.001.004 + type: + default: feeds.comment.reaction.added + description: 'The type of event: "feeds.comment.reaction.added" in this + case' + title: Event Type + type: string + x-stream-index: 004.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who added the reaction + title: User + x-stream-index: "005.001" + required: + - comment + - reaction + - activity + - type + - created_at + - custom + - fid + title: CommentReactionAddedEvent + 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 + CommentReactionDeletedEvent: + description: Emitted when a reaction is deleted from a comment. + nullable: true + properties: + comment: + $ref: '#/components/schemas/CommentResponse' + x-stream-index: "001" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 003.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 003.001.007 + feed_visibility: + type: string + x-stream-index: "003.003" + fid: + type: string + x-stream-index: "003.002" + reaction: + $ref: '#/components/schemas/FeedsReactionResponse' + x-stream-index: "002" + received_at: + format: date-time + type: number + x-stream-index: 003.001.004 + type: + default: feeds.comment.reaction.deleted + description: The type of reaction that was removed + title: Type + type: string + x-stream-index: 003.001.002 + required: + - comment + - reaction + - type + - created_at + - custom + - fid + title: CommentReactionDeletedEvent + 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 + CommentReactionUpdatedEvent: + description: Emitted when a reaction is updated on a comment. + nullable: true + properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + x-stream-index: "003" + comment: + $ref: '#/components/schemas/CommentResponse' + x-stream-index: "001" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 004.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 004.001.007 + feed_visibility: + type: string + x-stream-index: "004.003" + fid: + type: string + x-stream-index: "004.002" + reaction: + $ref: '#/components/schemas/FeedsReactionResponse' + description: The reaction that was updated + title: Reaction + x-stream-index: "002" + received_at: + format: date-time + type: number + x-stream-index: 004.001.004 + type: + default: feeds.comment.reaction.updated + description: 'The type of event: "feeds.comment.reaction.updated" in this + case' + title: Event Type + type: string + x-stream-index: 004.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who updated the reaction + title: User + x-stream-index: "005.001" + required: + - comment + - reaction + - activity + - type + - created_at + - custom + - fid + title: CommentReactionUpdatedEvent + 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 + CommentResponse: + properties: + attachments: items: - type: string - title: Commands + $ref: '#/components/schemas/Attachment' type: array - x-stream-index: "021" - connect_events: - description: Connect events - title: Connect events - type: boolean - x-stream-index: "004" - custom_events: - description: Custom events - title: Custom events - type: boolean x-stream-index: "011" - grants: - additionalProperties: - items: - type: string - type: array - description: List of grants for the channel type - title: Grants - type: object + confidence_score: + description: Confidence score of the comment + format: float + title: Confidence Score + type: number + x-stream-index: "022" + controversy_score: + description: Controversy score of the comment + format: float + title: Controversy Score + type: number x-stream-index: "023" - mark_messages_pending: - description: Mark messages pending - title: Mark messages pending - type: boolean - x-stream-index: "013" - max_message_length: - description: Max message length + created_at: + description: When the comment was created + format: date-time + title: Created At + type: number + x-stream-index: "014" + custom: + additionalProperties: {} + description: Custom data for the comment + title: Custom Data + type: object + x-stream-index: "006" + deleted_at: + description: When the comment was deleted + format: date-time + title: Deleted At + type: number + x-stream-index: "016" + downvote_count: + description: Number of downvotes for this comment format: int32 - title: Max message length + title: Downvote Count type: integer - x-stream-index: "018" - message_retention: - description: Message retention - enum: - - infinite - - numeric - title: Message retention - type: string - x-stream-index: "017" - mutes: - description: Mutes - title: Mutes - type: boolean - x-stream-index: "008" - name: - description: Channel type name - title: Name + x-stream-index: "020" + id: + description: Unique identifier for the comment + title: ID type: string x-stream-index: "001" - partition_size: - description: Partition size - format: int32 - minimum: 10 - title: Partition size - type: integer - x-stream-index: "027" - partition_ttl: - description: Partition TTL - example: 24h - format: duration - nullable: true - title: Partition TTL - type: string - x-stream-index: "028" - permissions: - description: List of permissions for the channel type + latest_reactions: + description: Recent reactions to the comment items: - $ref: '#/components/schemas/PolicyRequest' - title: Permissions + $ref: '#/components/schemas/FeedsReactionResponse' + title: Latest Reactions + type: array + x-stream-index: "009" + mentioned_users: + description: Users mentioned in the comment + items: + $ref: '#/components/schemas/UserResponse' + title: Mention Users type: array - x-stream-index: "022" - polls: - description: Polls - title: Polls - type: boolean - x-stream-index: "014" - push_notifications: - description: Push notifications - title: Push notifications - type: boolean x-stream-index: "012" - reactions: - description: Reactions - title: Reactions - type: boolean - x-stream-index: "005" - read_events: - description: Read events - title: Read events - type: boolean + moderation: + $ref: '#/components/schemas/ModerationV2Response' + x-stream-index: "017" + object_id: + description: ID of the object this comment is associated with + title: Object ID + type: string + x-stream-index: "002" + object_type: + description: Type of the object this comment is associated with + title: Object Type + type: string x-stream-index: "003" - replies: - description: Replies - title: Replies - type: boolean - x-stream-index: "006" - search: - description: Search - title: Search - type: boolean + own_reactions: + description: Current user's reactions to this activity + items: + $ref: '#/components/schemas/FeedsReactionResponse' + title: Own Reactions + type: array + x-stream-index: "024" + parent_id: + description: ID of parent comment for nested replies + title: Parent ID + type: string x-stream-index: "007" - shared_locations: - description: Enables shared location messages - title: Shared locations - type: boolean - x-stream-index: "016" - skip_last_msg_update_for_system_msgs: - type: boolean - x-stream-index: "029" - typing_events: - description: Typing events - title: Typing events - type: boolean - x-stream-index: "002" - uploads: - description: Uploads - title: Uploads - type: boolean - x-stream-index: "009" - url_enrichment: - description: URL enrichment - title: URL enrichment - type: boolean + reaction_count: + description: Number of reactions to this comment + format: int32 + title: Reaction Count + type: integer + x-stream-index: "008" + reaction_groups: + additionalProperties: + $ref: '#/components/schemas/ReactionGroupResponse' + description: Grouped reactions by type + title: Reaction Groups + type: object x-stream-index: "010" - user_message_reminders: - type: boolean + reply_count: + description: Number of replies to this comment + format: int32 + title: Reply Count + type: integer + x-stream-index: "018" + score: + description: Score of the comment based on reactions + format: int32 + title: Score + type: integer + x-stream-index: "021" + status: + description: Status of the comment (e.g., active, deleted) + title: Status + type: string + x-stream-index: "013" + text: + description: Text content of the comment + title: Text + type: string + x-stream-index: "005" + updated_at: + description: When the comment was last updated + format: date-time + title: Updated At + type: number x-stream-index: "015" + upvote_count: + description: Number of upvotes for this comment + format: int32 + title: Upvote Count + type: integer + x-stream-index: "019" + user: + $ref: '#/components/schemas/UserResponse' + description: User who created the comment + title: User + x-stream-index: "004" required: - - name - - max_message_length - - automod - - automod_behavior - title: CreateChannelTypeRequest + - id + - object_id + - object_type + - user + - reaction_count + - mentioned_users + - status + - created_at + - updated_at + - reply_count + - upvote_count + - downvote_count + - score + - confidence_score + - own_reactions + title: Comment type: object - CreateChannelTypeResponse: + CommentUpdatedEvent: + description: Emitted when a comment is updated. nullable: true properties: - allowed_flag_reasons: - items: - type: string - type: array - x-stream-index: 001.001.026 - automod: - enum: - - disabled - - simple - - AI + comment: + $ref: '#/components/schemas/CommentResponse' + description: The comment that was updated + title: Text + x-stream-index: "001" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + feed_visibility: type: string - x-stream-index: 001.001.021 - automod_behavior: - enum: - - flag - - block - - shadow_block + x-stream-index: "002.003" + fid: type: string - x-stream-index: 001.001.022 - automod_thresholds: - $ref: '#/components/schemas/Thresholds' - x-stream-index: 001.001.027 + x-stream-index: "002.002" + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 + type: + default: feeds.comment.updated + description: 'The type of event: "feeds.comment.updated" in this case' + title: Event Type + type: string + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who updated the comment + title: User + x-stream-index: "003.001" + required: + - comment + - type + - created_at + - custom + - fid + title: CommentUpdatedEvent + 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 + CommitMessageRequest: + nullable: true + type: object + CompositeAppSettings: + properties: + json_encoded_settings: + type: string + x-stream-index: "005" + url: + type: string + x-stream-index: "004" + type: object + ConfigOverrides: + properties: blocklist: type: string - x-stream-index: 001.001.023 + x-stream-index: "008" blocklist_behavior: enum: - flag - block - - shadow_block type: string - x-stream-index: 001.001.024 - blocklists: - items: - $ref: '#/components/schemas/BlockListOptions' - type: array - x-stream-index: 001.001.025 + x-stream-index: "009" commands: items: type: string type: array - x-stream-index: "001.003" - connect_events: - type: boolean - x-stream-index: 001.001.004 - created_at: - format: date-time - type: number - x-stream-index: 001.002.003 - custom_events: + x-stream-index: "011" + count_messages: type: boolean - x-stream-index: 001.001.012 - duration: - type: string - x-stream-index: "004.001" + x-stream-index: "014" grants: additionalProperties: items: type: string type: array type: object - x-stream-index: "003" - mark_messages_pending: - type: boolean - x-stream-index: 001.001.015 + x-stream-index: "010" max_message_length: format: int32 maximum: 20000 type: integer - x-stream-index: 001.001.020 - mutes: - type: boolean - x-stream-index: 001.001.009 - name: - type: string - x-stream-index: 001.001.001 - partition_size: - format: int32 - type: integer - x-stream-index: 001.001.028 - partition_ttl: - example: 24h - format: duration - nullable: true - type: string - x-stream-index: 001.001.029 - permissions: - items: - $ref: '#/components/schemas/PolicyRequest' - type: array - x-stream-index: "002" - polls: - type: boolean - x-stream-index: 001.001.016 - push_notifications: - type: boolean - x-stream-index: 001.001.013 + x-stream-index: "007" quotes: type: boolean - x-stream-index: 001.001.008 + x-stream-index: "004" reactions: type: boolean - x-stream-index: 001.001.006 - read_events: - type: boolean - x-stream-index: 001.001.003 - reminders: - type: boolean - x-stream-index: 001.001.014 + x-stream-index: "002" replies: type: boolean - x-stream-index: 001.001.007 - search: - type: boolean - x-stream-index: 001.001.005 + x-stream-index: "003" shared_locations: type: boolean - x-stream-index: 001.001.018 - skip_last_msg_update_for_system_msgs: - type: boolean - x-stream-index: 001.001.030 + x-stream-index: "013" typing_events: type: boolean - x-stream-index: 001.001.002 - updated_at: - format: date-time - type: number - x-stream-index: 001.002.004 + x-stream-index: "001" uploads: type: boolean - x-stream-index: 001.001.010 + x-stream-index: "005" url_enrichment: type: boolean - x-stream-index: 001.001.011 + x-stream-index: "006" user_message_reminders: type: boolean - x-stream-index: 001.001.017 + x-stream-index: "012" required: - - name - - typing_events - - read_events - - connect_events - - search - - reactions - - replies - - quotes - - mutes - - uploads - - url_enrichment - - custom_events - - push_notifications - - reminders - - mark_messages_pending - - polls - - user_message_reminders - - shared_locations - - message_retention - - max_message_length - - automod - - automod_behavior - - skip_last_msg_update_for_system_msgs - - created_at - - updated_at - - commands - - permissions - grants - - duration + - commands type: object - CreateCommandRequest: - description: Create a new command - nullable: true + ConfigResponse: properties: - args: - description: Arguments help text, shown in commands auto-completion - maxLength: 255 - title: Arguments - type: string + ai_image_config: + $ref: '#/components/schemas/AIImageConfig' + description: Configuration for AI image analysis + title: AI Image Config + x-stream-index: "010" + ai_text_config: + $ref: '#/components/schemas/AITextConfig' + description: Configuration for AI text analysis + title: AI Text Config + x-stream-index: "008" + ai_video_config: + $ref: '#/components/schemas/AIVideoConfig' + description: Configuration for AI video analysis + title: AI Video Config + x-stream-index: "011" + async: + description: Whether moderation should be performed asynchronously + title: Async + type: boolean x-stream-index: "003" - description: - description: Description, shown in commands auto-completion - maxLength: 255 - title: Description - type: string - x-stream-index: "002" - name: - description: Unique command name - maxLength: 255 - minLength: 1 - title: Name + automod_platform_circumvention_config: + $ref: '#/components/schemas/AutomodPlatformCircumventionConfig' + description: Configuration for platform circumvention detection + title: Automod Platform Circumvention Config + x-stream-index: "005" + automod_semantic_filters_config: + $ref: '#/components/schemas/AutomodSemanticFiltersConfig' + description: Configuration for semantic filtering + title: Automod Semantic Filters Config + x-stream-index: "006" + automod_toxicity_config: + $ref: '#/components/schemas/AutomodToxicityConfig' + description: Configuration for toxicity detection + title: Automod Toxicity Config + x-stream-index: "004" + block_list_config: + $ref: '#/components/schemas/BlockListConfig' + description: Configuration for block list filtering + title: Block List Config + x-stream-index: "007" + created_at: + description: When the configuration was created + format: date-time + title: Created At + type: number + x-stream-index: "013" + key: + description: Unique identifier for the moderation configuration + title: Key type: string x-stream-index: "001" - set: - description: Set name used for grouping commands - maxLength: 255 - title: Set + llm_config: + $ref: '#/components/schemas/LLMConfig' + description: Configuration for customer-configured LLM moderation + title: LLM Config + x-stream-index: "009" + team: + description: Team associated with the configuration + title: Team type: string - x-stream-index: "004" + x-stream-index: "002" + updated_at: + description: When the configuration was last updated + format: date-time + title: Updated At + type: number + x-stream-index: "014" + velocity_filter_config: + $ref: '#/components/schemas/VelocityFilterConfig' + description: Configuration for velocity-based filtering + title: Velocity Filter Config + x-stream-index: "012" + video_call_rule_config: + $ref: '#/components/schemas/VideoCallRuleConfig' + x-stream-index: "015" required: - - name - - description - title: CreateCommandRequest + - key + - team + - async + - created_at + - updated_at type: object - CreateCommandResponse: - nullable: true + ContentCountRuleParameters: properties: - command: - $ref: '#/components/schemas/Command' - description: Command object - title: Command + threshold: + format: int32 + type: integer x-stream-index: "001" - duration: + time_window: type: string - x-stream-index: "002.001" - required: - - duration - title: CreateCommandResponse + x-stream-index: "002" type: object - CreateDeviceRequest: - description: Create device request + CountByMinuteResponse: nullable: true properties: - id: - description: Device ID - maxLength: 255 - minLength: 1 - title: ID - type: string - x-stream-index: "001" - push_provider: - description: Push provider - enum: - - firebase - - apn - - huawei - - xiaomi - title: PushProvider - type: string + count: + format: int32 + type: integer x-stream-index: "002" - push_provider_name: - description: Push provider name - title: PushProviderName - type: string - x-stream-index: "003" - user: - $ref: '#/components/schemas/UserRequest' - x-stream-index: "005.002" - user_id: - description: '**Server-side only**. User ID which server acts upon' - title: User ID - type: string - x-stream-index: "005.001" - voip_token: - description: When true the token is for Apple VoIP push notifications - title: VoipToken - type: boolean - x-stream-index: "004" + start_ts: + format: date-time + type: number + x-stream-index: "001" required: - - id - - push_provider - title: CreateDeviceRequest + - start_ts + - count type: object - CreateExternalStorageRequest: - description: Create external storage + CreateBlockListRequest: + description: Block list contains restricted words nullable: true properties: - aws_s3: - $ref: '#/components/schemas/S3Request' - description: Only required if you want to create an Amazon S3 storage - title: AwsS3 - x-stream-index: "003.004" - azure_blob: - $ref: '#/components/schemas/AzureRequest' - description: Only required if you want to create an Azure Blob Storage - title: AzureBlob - x-stream-index: "003.006" - bucket: - description: The name of the bucket on the service provider - title: Bucket - type: string - x-stream-index: "003.002" - gcs_credentials: - type: string - x-stream-index: "003.005" name: - description: The name of the provider, this must be unique + description: Block list name + maxLength: 255 title: Name type: string x-stream-index: "001" - path: - description: The path prefix to use for storing files - title: Path + team: type: string - x-stream-index: "003.003" - storage_type: - description: The type of storage to use + x-stream-index: "004" + type: + description: Block list type. enum: - - s3 - - gcs - - abs - title: StorageType + - regex + - domain + - domain_allowlist + - email + - word + title: Type type: string - x-stream-index: "003.001" + x-stream-index: "003" + words: + description: List of words to block + items: + type: string + minimum: 1 + title: Words + type: array + x-stream-index: "002" required: - name - - storage_type - - bucket - title: CreateExternalStorageRequest + - words + title: Block list type: object - CreateExternalStorageResponse: + x-stream-docs-page-id: block_lists + CreateBlockListResponse: 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 - CreateGuestRequest: - nullable: true - properties: - user: - $ref: '#/components/schemas/UserRequest' - description: User object which server acts upon - title: User + blocklist: + $ref: '#/components/schemas/BlockListResponse' x-stream-index: "001" - required: - - user - type: object - CreateGuestResponse: - nullable: true - properties: - access_token: - description: the access token to authenticate the user - title: Access token - type: string - x-stream-index: "002" duration: description: Duration of the request in milliseconds title: Duration type: string - x-stream-index: "003.001" - user: - $ref: '#/components/schemas/UserResponse' - description: User object which server acts upon - title: User - x-stream-index: "001" + x-stream-index: "002.001" required: - - user - - access_token - duration + title: Response type: object - CreateImportRequest: + CreateCallTypeRequest: + description: Request for creating a call type nullable: true properties: - mode: - enum: - - insert - - upsert + external_storage: + description: the external storage for the call type + title: ExternalStorage type: string - x-stream-index: "002" - path: + x-stream-index: "002.004" + grants: + additionalProperties: + items: + type: string + type: array + description: the permissions granted to each role + title: Grants + type: object + x-stream-index: "002.001" + name: type: string x-stream-index: "001" + notification_settings: + $ref: '#/components/schemas/NotificationSettings' + description: the notification settings for the call type + title: NotificationSettings + x-stream-index: "002.002" + settings: + $ref: '#/components/schemas/CallSettingsRequest' + description: the settings for the call type + title: Settings + x-stream-index: "002.003" required: - - path - - mode + - name + title: CreateCallTypeRequest type: object - CreateImportResponse: - description: Basic response information + CreateCallTypeResponse: + description: Response for creating a call type nullable: true properties: + created_at: + description: the time the call type was created + format: date-time + title: CreatedAt + type: number + x-stream-index: "001.005" duration: - description: Duration of the request in milliseconds - title: Duration type: string x-stream-index: "002.001" - import_task: - $ref: '#/components/schemas/ImportTask' - x-stream-index: "001" - required: - - duration - title: Response - type: object - CreateImportURLRequest: - nullable: true - properties: - filename: - type: string - x-stream-index: "001" - type: object - CreateImportURLResponse: - description: Basic response information - nullable: true - properties: - duration: - description: Duration of the request in milliseconds - title: Duration - type: string - x-stream-index: "003.001" - path: + external_storage: + description: the external storage for the call type + title: ExternalStorage type: string - x-stream-index: "001" - upload_url: + x-stream-index: "001.007" + grants: + additionalProperties: + items: + type: string + type: array + description: the permissions granted to each role + title: Grants + type: object + x-stream-index: "001.002" + name: + description: the name of the call type + title: Name type: string - x-stream-index: "002" + x-stream-index: "001.001" + notification_settings: + $ref: '#/components/schemas/NotificationSettings' + description: the notification settings for the call type + title: NotificationSettings + x-stream-index: "001.004" + settings: + $ref: '#/components/schemas/CallSettingsResponse' + description: the settings for the call type + title: Settings + x-stream-index: "001.003" + updated_at: + description: the time the call type was last updated + format: date-time + title: UpdatedAt + type: number + x-stream-index: "001.006" required: - - path - - upload_url + - name + - grants + - settings + - notification_settings + - created_at + - updated_at - duration - title: Response + title: CreateCallTypeResponse type: object - CreatePollOptionRequest: + CreateChannelTypeRequest: nullable: true properties: - Custom: - additionalProperties: {} - type: object - writeOnly: true - x-stream-index: "003" - text: - description: Option text - title: string + automod: + description: Automod + enum: + - disabled + - simple + - AI + title: Automod type: string - x-stream-index: "002" - user: - $ref: '#/components/schemas/UserRequest' - x-stream-index: "004.002" - user_id: + x-stream-index: "019" + automod_behavior: + description: Automod behavior + enum: + - flag + - block + title: Automod behavior type: string - x-stream-index: "004.001" - required: - - text - type: object - CreatePollRequest: - description: Contains all information needed to create a new poll - nullable: true - properties: - Custom: - additionalProperties: {} - type: object - writeOnly: true - x-stream-index: "011" - allow_answers: - description: Indicates whether users can suggest user defined answers - title: Allow answers - type: boolean - x-stream-index: "009" - allow_user_suggested_options: - type: boolean - x-stream-index: "008" - description: - description: A description of the poll - title: Description + x-stream-index: "020" + blocklist: + description: Blocklist + title: Blocklist type: string - x-stream-index: "003" - enforce_unique_vote: - description: Indicates whether users can cast multiple votes - title: Multiple choice - type: boolean - x-stream-index: "006" - id: - maxLength: 255 + x-stream-index: "024" + blocklist_behavior: + description: Blocklist behavior + enum: + - flag + - block + - shadow_block + title: Blocklist behavior type: string - x-stream-index: "001" - is_closed: - description: Indicates whether the poll is open for voting - title: Is closed - type: boolean - x-stream-index: "010" - max_votes_allowed: - description: Indicates the maximum amount of votes a user can cast - format: int32 - maximum: 10 - title: Maximum votes allowed - type: integer - x-stream-index: "007" + x-stream-index: "025" + blocklists: + description: Blocklists + items: + $ref: '#/components/schemas/BlockListOptions' + title: Blocklists + type: array + x-stream-index: "026" + commands: + description: List of commands that channel supports + items: + type: string + title: Commands + type: array + x-stream-index: "021" + connect_events: + description: Connect events + title: Connect events + type: boolean + x-stream-index: "004" + custom_events: + description: Custom events + title: Custom events + type: boolean + x-stream-index: "011" + grants: + additionalProperties: + items: + type: string + type: array + description: List of grants for the channel type + title: Grants + type: object + x-stream-index: "023" + mark_messages_pending: + description: Mark messages pending + title: Mark messages pending + type: boolean + x-stream-index: "013" + max_message_length: + description: Max message length + format: int32 + title: Max message length + type: integer + x-stream-index: "018" + message_retention: + description: Message retention + enum: + - infinite + - numeric + title: Message retention + type: string + x-stream-index: "017" + mutes: + description: Mutes + title: Mutes + type: boolean + x-stream-index: "008" name: - description: The name of the poll + description: Channel type name title: Name type: string + x-stream-index: "001" + partition_size: + description: Partition size + format: int32 + minimum: 10 + title: Partition size + type: integer + x-stream-index: "027" + partition_ttl: + description: Partition TTL + example: 24h + format: duration + nullable: true + title: Partition TTL + type: string + x-stream-index: "028" + permissions: + description: List of permissions for the channel type + items: + $ref: '#/components/schemas/PolicyRequest' + title: Permissions + type: array + x-stream-index: "022" + polls: + description: Polls + title: Polls + type: boolean + x-stream-index: "014" + push_notifications: + description: Push notifications + title: Push notifications + type: boolean + x-stream-index: "012" + reactions: + description: Reactions + title: Reactions + type: boolean + x-stream-index: "005" + read_events: + description: Read events + title: Read events + type: boolean + x-stream-index: "003" + replies: + description: Replies + title: Replies + type: boolean + x-stream-index: "006" + search: + description: Search + title: Search + type: boolean + x-stream-index: "007" + shared_locations: + description: Enables shared location messages + title: Shared locations + type: boolean + x-stream-index: "016" + skip_last_msg_update_for_system_msgs: + type: boolean + x-stream-index: "029" + typing_events: + description: Typing events + title: Typing events + type: boolean x-stream-index: "002" - options: + uploads: + description: Uploads + title: Uploads + type: boolean + x-stream-index: "009" + url_enrichment: + description: URL enrichment + title: URL enrichment + type: boolean + x-stream-index: "010" + user_message_reminders: + type: boolean + x-stream-index: "015" + required: + - name + - max_message_length + - automod + - automod_behavior + title: CreateChannelTypeRequest + type: object + CreateChannelTypeResponse: + nullable: true + properties: + allowed_flag_reasons: items: - $ref: '#/components/schemas/PollOptionInput' - maximum: 100 + type: string type: array - x-stream-index: "004" - user: - $ref: '#/components/schemas/UserRequest' - x-stream-index: "012.002" - user_id: + x-stream-index: 001.001.027 + automod: + enum: + - disabled + - simple + - AI type: string - x-stream-index: "012.001" - voting_visibility: + x-stream-index: 001.001.022 + automod_behavior: enum: - - anonymous - - public + - flag + - block + - shadow_block type: string - x-stream-index: "005" + x-stream-index: 001.001.023 + automod_thresholds: + $ref: '#/components/schemas/Thresholds' + x-stream-index: 001.001.028 + blocklist: + type: string + x-stream-index: 001.001.024 + blocklist_behavior: + enum: + - flag + - block + - shadow_block + type: string + x-stream-index: 001.001.025 + blocklists: + items: + $ref: '#/components/schemas/BlockListOptions' + type: array + x-stream-index: 001.001.026 + commands: + items: + type: string + type: array + x-stream-index: "001.003" + connect_events: + type: boolean + x-stream-index: 001.001.004 + count_messages: + type: boolean + x-stream-index: 001.001.019 + created_at: + format: date-time + type: number + x-stream-index: 001.002.003 + custom_events: + type: boolean + x-stream-index: 001.001.012 + duration: + type: string + x-stream-index: "004.001" + grants: + additionalProperties: + items: + type: string + type: array + type: object + x-stream-index: "003" + mark_messages_pending: + type: boolean + x-stream-index: 001.001.015 + max_message_length: + format: int32 + maximum: 20000 + type: integer + x-stream-index: 001.001.021 + mutes: + type: boolean + x-stream-index: 001.001.009 + name: + type: string + x-stream-index: 001.001.001 + partition_size: + format: int32 + type: integer + x-stream-index: 001.001.029 + partition_ttl: + example: 24h + format: duration + nullable: true + type: string + x-stream-index: 001.001.030 + permissions: + items: + $ref: '#/components/schemas/PolicyRequest' + type: array + x-stream-index: "002" + polls: + type: boolean + x-stream-index: 001.001.016 + push_notifications: + type: boolean + x-stream-index: 001.001.013 + quotes: + type: boolean + x-stream-index: 001.001.008 + reactions: + type: boolean + x-stream-index: 001.001.006 + read_events: + type: boolean + x-stream-index: 001.001.003 + reminders: + type: boolean + x-stream-index: 001.001.014 + replies: + type: boolean + x-stream-index: 001.001.007 + search: + type: boolean + x-stream-index: 001.001.005 + shared_locations: + type: boolean + x-stream-index: 001.001.018 + skip_last_msg_update_for_system_msgs: + type: boolean + x-stream-index: 001.001.031 + typing_events: + type: boolean + x-stream-index: 001.001.002 + updated_at: + format: date-time + type: number + x-stream-index: 001.002.004 + uploads: + type: boolean + x-stream-index: 001.001.010 + url_enrichment: + type: boolean + x-stream-index: 001.001.011 + user_message_reminders: + type: boolean + x-stream-index: 001.001.017 required: - name - title: Create Poll Request + - typing_events + - read_events + - connect_events + - search + - reactions + - replies + - quotes + - mutes + - uploads + - url_enrichment + - custom_events + - push_notifications + - reminders + - mark_messages_pending + - polls + - user_message_reminders + - shared_locations + - count_messages + - message_retention + - max_message_length + - automod + - automod_behavior + - skip_last_msg_update_for_system_msgs + - created_at + - updated_at + - commands + - permissions + - grants + - duration type: object - CreateReminderRequest: + CreateCommandRequest: + description: Create a new command nullable: true properties: - remind_at: - format: date-time - type: number + args: + description: Arguments help text, shown in commands auto-completion + maxLength: 255 + title: Arguments + type: string + x-stream-index: "003" + description: + description: Description, shown in commands auto-completion + maxLength: 255 + title: Description + type: string + x-stream-index: "002" + name: + description: Unique command name + maxLength: 255 + minLength: 1 + title: Name + type: string + x-stream-index: "001" + set: + description: Set name used for grouping commands + maxLength: 255 + title: Set + type: string + x-stream-index: "004" + required: + - name + - description + title: CreateCommandRequest + type: object + CreateCommandResponse: + nullable: true + properties: + command: + $ref: '#/components/schemas/Command' + description: Command object + title: Command + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - duration + title: CreateCommandResponse + type: object + CreateDeviceRequest: + description: Create device request + nullable: true + properties: + id: + description: Device ID + maxLength: 255 + minLength: 1 + title: ID + type: string x-stream-index: "001" + push_provider: + description: Push provider + enum: + - firebase + - apn + - huawei + - xiaomi + title: PushProvider + type: string + x-stream-index: "002" + push_provider_name: + description: Push provider name + title: PushProviderName + type: string + x-stream-index: "003" user: $ref: '#/components/schemas/UserRequest' - x-stream-index: "003.002" + x-stream-index: "005.002" user_id: + description: '**Server-side only**. User ID which server acts upon' + title: User ID type: string - x-stream-index: "003.001" + x-stream-index: "005.001" + voip_token: + description: When true the token is for Apple VoIP push notifications + title: VoipToken + type: boolean + x-stream-index: "004" + required: + - id + - push_provider + title: CreateDeviceRequest type: object - CreateRoleRequest: + CreateExternalStorageRequest: + description: Create external storage nullable: true properties: + aws_s3: + $ref: '#/components/schemas/S3Request' + description: Only required if you want to create an Amazon S3 storage + title: AwsS3 + x-stream-index: "003.004" + azure_blob: + $ref: '#/components/schemas/AzureRequest' + description: Only required if you want to create an Azure Blob Storage + title: AzureBlob + x-stream-index: "003.006" + bucket: + description: The name of the bucket on the service provider + title: Bucket + type: string + x-stream-index: "003.002" + gcs_credentials: + type: string + x-stream-index: "003.005" name: - description: Role name - maxLength: 64 + description: The name of the provider, this must be unique title: Name type: string x-stream-index: "001" + path: + description: The path prefix to use for storing files + title: Path + type: string + x-stream-index: "003.003" + storage_type: + description: The type of storage to use + enum: + - s3 + - gcs + - abs + title: StorageType + type: string + x-stream-index: "003.001" required: - name + - storage_type + - bucket + title: CreateExternalStorageRequest type: object - CreateRoleResponse: + CreateExternalStorageResponse: description: Basic response information nullable: true properties: @@ -8369,60 +10630,517 @@ components: title: Duration type: string x-stream-index: "001.001" - role: - $ref: '#/components/schemas/Role' - x-stream-index: "002" required: - duration - - role title: Response type: object - CustomActionRequest: - properties: - id: - type: string - x-stream-index: "001" - options: - additionalProperties: {} - type: object - x-stream-index: "002" - type: object - CustomCheckFlag: + CreateFeedGroupRequest: + nullable: true properties: + activity_processors: + description: Configuration for activity processors (max 10) + items: + $ref: '#/components/schemas/ActivityProcessorConfig' + maximum: 10 + title: Activity Processors + type: array + x-stream-index: "006" + activity_selectors: + description: Configuration for activity selectors (max 10) + items: + $ref: '#/components/schemas/ActivitySelectorConfig' + maximum: 10 + title: Activity Selectors + type: array + x-stream-index: "007" + aggregation: + $ref: '#/components/schemas/AggregationConfig' + description: Configuration for activity aggregation + title: Aggregation + x-stream-index: "009" custom: additionalProperties: {} - description: Additional metadata for the flag - title: Custom + description: Custom data for the feed group + title: Custom Data type: object - x-stream-index: "003" - labels: - description: Labels from various moderation sources - items: - type: string - title: Labels - type: array x-stream-index: "004" - reason: - description: Optional explanation for the flag - title: Reason + default_visibility: + description: 'Default visibility for the feed group, can be ''public'', + ''visible'', ''followers'', ''members'', or ''private''. Defaults to ''visible'' + if not provided. ' + enum: + - public + - visible + - followers + - members + - private + title: Default Visibility type: string - x-stream-index: "002" - type: - description: Type of check (custom_check_text, custom_check_image, custom_check_video) + x-stream-index: "005" + id: + description: Unique identifier for the feed group maxLength: 255 - title: Type + title: Feed Group ID type: string x-stream-index: "001" + notification: + $ref: '#/components/schemas/NotificationConfig' + description: Configuration for notifications + title: Notification + x-stream-index: "002" + push_notification: + $ref: '#/components/schemas/PushNotificationConfig' + x-stream-index: "003" + ranking: + $ref: '#/components/schemas/RankingConfig' + description: Configuration for activity ranking + title: Ranking + x-stream-index: "008" required: - - type + - id + title: Create Feed Group Request type: object - CustomCheckRequest: + CreateFeedGroupResponse: nullable: true properties: - entity_creator_id: - description: ID of the user who created the entity (required for non-message - entities) - title: Entity Creator ID + duration: + type: string + x-stream-index: "002.001" + feed_group: + $ref: '#/components/schemas/FeedGroupResponse' + description: The upserted feed group + title: Feed Group + x-stream-index: "001" + required: + - feed_group + - duration + title: Upsert Feed Group Response + type: object + CreateFeedViewRequest: + nullable: true + properties: + activity_processors: + description: Configured activity Processors + items: + $ref: '#/components/schemas/ActivityProcessorConfig' + title: Activity Processors + type: array + x-stream-index: "002.002" + activity_selectors: + description: Configuration for selecting activities + items: + $ref: '#/components/schemas/ActivitySelectorConfig' + title: Activity Selectors + type: array + x-stream-index: "002.001" + aggregation: + $ref: '#/components/schemas/AggregationConfig' + description: Configuration for aggregating activities + title: Aggregation + x-stream-index: "002.004" + id: + description: Unique identifier for the feed view + maxLength: 255 + title: View ID + type: string + x-stream-index: "001" + ranking: + $ref: '#/components/schemas/RankingConfig' + description: Configuration for ranking activities + title: Ranking + x-stream-index: "002.003" + required: + - id + title: Create Feed View Request + type: object + CreateFeedViewResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + feed_view: + $ref: '#/components/schemas/FeedViewResponse' + description: The created feed view + title: Feed View + x-stream-index: "001" + required: + - feed_view + - duration + title: Create Feed View Response + type: object + CreateFeedsBatchRequest: + nullable: true + properties: + feeds: + description: List of feeds to create + items: + $ref: '#/components/schemas/FeedRequest' + maximum: 1000 + minimum: 1 + title: Feeds + type: array + x-stream-index: "001" + required: + - feeds + title: Create Feeds Batch Request + type: object + CreateFeedsBatchResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + feeds: + description: List of created feeds + items: + $ref: '#/components/schemas/FeedResponse' + title: Feeds + type: array + x-stream-index: "001" + required: + - feeds + - duration + title: Create Feeds Batch Response + type: object + CreateGuestRequest: + nullable: true + properties: + user: + $ref: '#/components/schemas/UserRequest' + description: User object which server acts upon + title: User + x-stream-index: "001" + required: + - user + type: object + CreateGuestResponse: + nullable: true + properties: + access_token: + description: the access token to authenticate the user + title: Access token + type: string + x-stream-index: "002" + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "003.001" + user: + $ref: '#/components/schemas/UserResponse' + description: User object which server acts upon + title: User + x-stream-index: "001" + required: + - user + - access_token + - duration + type: object + CreateImportRequest: + nullable: true + properties: + mode: + enum: + - insert + - upsert + type: string + x-stream-index: "002" + path: + type: string + x-stream-index: "001" + required: + - path + - mode + type: object + CreateImportResponse: + description: Basic response information + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "002.001" + import_task: + $ref: '#/components/schemas/ImportTask' + x-stream-index: "001" + required: + - duration + title: Response + type: object + CreateImportURLRequest: + nullable: true + properties: + filename: + type: string + x-stream-index: "001" + type: object + CreateImportURLResponse: + description: Basic response information + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "003.001" + path: + type: string + x-stream-index: "001" + upload_url: + type: string + x-stream-index: "002" + required: + - path + - upload_url + - duration + title: Response + type: object + CreateMembershipLevelRequest: + nullable: true + properties: + custom: + additionalProperties: {} + description: Custom data for the membership level + title: Custom Data + type: object + x-stream-index: "006" + description: + description: Optional description of the membership level + maxLength: 1000 + title: Description + type: string + x-stream-index: "003" + id: + description: Unique identifier for the membership level + maxLength: 255 + title: ID + type: string + x-stream-index: "001" + name: + description: Display name for the membership level + maxLength: 255 + title: Name + type: string + x-stream-index: "002" + priority: + description: Priority level (higher numbers = higher priority) + format: int32 + minimum: 0 + title: Priority + type: integer + x-stream-index: "004" + tags: + description: Activity tags this membership level gives access to + items: + type: string + maximum: 255 + title: Tags + type: array + x-stream-index: "005" + required: + - id + - name + title: Create Membership Level Request + type: object + CreateMembershipLevelResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + membership_level: + $ref: '#/components/schemas/MembershipLevelResponse' + description: The created membership level + title: Membership Level + x-stream-index: "001" + required: + - membership_level + - duration + title: Create Membership Level Response + type: object + CreatePollOptionRequest: + nullable: true + properties: + Custom: + additionalProperties: {} + type: object + writeOnly: true + x-stream-index: "003" + text: + description: Option text + title: string + type: string + x-stream-index: "002" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "004.002" + user_id: + type: string + x-stream-index: "004.001" + required: + - text + type: object + CreatePollRequest: + description: Contains all information needed to create a new poll + nullable: true + properties: + Custom: + additionalProperties: {} + type: object + writeOnly: true + x-stream-index: "011" + allow_answers: + description: Indicates whether users can suggest user defined answers + title: Allow answers + type: boolean + x-stream-index: "009" + allow_user_suggested_options: + type: boolean + x-stream-index: "008" + description: + description: A description of the poll + title: Description + type: string + x-stream-index: "003" + enforce_unique_vote: + description: Indicates whether users can cast multiple votes + title: Multiple choice + type: boolean + x-stream-index: "006" + id: + maxLength: 255 + type: string + x-stream-index: "001" + is_closed: + description: Indicates whether the poll is open for voting + title: Is closed + type: boolean + x-stream-index: "010" + max_votes_allowed: + description: Indicates the maximum amount of votes a user can cast + format: int32 + maximum: 10 + title: Maximum votes allowed + type: integer + x-stream-index: "007" + name: + description: The name of the poll + title: Name + type: string + x-stream-index: "002" + options: + items: + $ref: '#/components/schemas/PollOptionInput' + maximum: 100 + type: array + x-stream-index: "004" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "012.002" + user_id: + type: string + x-stream-index: "012.001" + voting_visibility: + enum: + - anonymous + - public + type: string + x-stream-index: "005" + required: + - name + title: Create Poll Request + type: object + CreateReminderRequest: + nullable: true + properties: + remind_at: + format: date-time + type: number + x-stream-index: "001" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "003.002" + user_id: + type: string + x-stream-index: "003.001" + type: object + CreateRoleRequest: + nullable: true + properties: + name: + description: Role name + maxLength: 64 + title: Name + type: string + x-stream-index: "001" + required: + - name + type: object + CreateRoleResponse: + description: Basic response information + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "001.001" + role: + $ref: '#/components/schemas/Role' + x-stream-index: "002" + required: + - duration + - role + title: Response + type: object + CustomActionRequest: + properties: + id: + type: string + x-stream-index: "001" + options: + additionalProperties: {} + type: object + x-stream-index: "002" + type: object + CustomCheckFlag: + properties: + custom: + additionalProperties: {} + description: Additional metadata for the flag + title: Custom + type: object + x-stream-index: "003" + labels: + description: Labels from various moderation sources + items: + type: string + title: Labels + type: array + x-stream-index: "004" + reason: + description: Optional explanation for the flag + title: Reason + type: string + x-stream-index: "002" + type: + description: Type of check (custom_check_text, custom_check_image, custom_check_video) + maxLength: 255 + title: Type + type: string + x-stream-index: "001" + required: + - type + type: object + CustomCheckRequest: + nullable: true + properties: + entity_creator_id: + description: ID of the user who created the entity (required for non-message + entities) + title: Entity Creator ID type: string x-stream-index: "003" entity_id: @@ -8693,12 +11411,144 @@ components: - duration title: Response type: object + DecayFunctionConfig: + properties: + base: + description: Base value for decay function + title: Base + type: string + x-stream-index: "001" + decay: + description: Decay rate + title: Decay + type: string + x-stream-index: "005" + direction: + description: Direction of decay + title: Direction + type: string + x-stream-index: "006" + offset: + description: Offset value for decay function + title: Offset + type: string + x-stream-index: "004" + origin: + description: Origin value for decay function + title: Origin + type: string + x-stream-index: "002" + scale: + description: Scale factor for decay function + title: Scale + type: string + x-stream-index: "003" + title: Decay Function Configuration + type: object + DeleteActivitiesRequest: + nullable: true + properties: + hard_delete: + description: Whether to permanently delete the activities + title: Hard Delete + type: boolean + x-stream-index: "002" + ids: + description: List of activity IDs to delete + items: + type: string + minimum: 1 + title: Activity IDs + type: array + x-stream-index: "001" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "004.002" + user_id: + type: string + x-stream-index: "004.001" + required: + - ids + title: Delete Activities Request + type: object + DeleteActivitiesResponse: + nullable: true + properties: + deleted_ids: + description: List of activity IDs that were successfully deleted + items: + type: string + title: Deleted Activity IDs + type: array + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - deleted_ids + - duration + title: Delete Activities Response + type: object + DeleteActivityReactionResponse: + nullable: true + properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + x-stream-index: "001" + duration: + type: string + x-stream-index: "003.001" + reaction: + $ref: '#/components/schemas/FeedsReactionResponse' + x-stream-index: "002" + required: + - activity + - reaction + - duration + title: Delete Activity Reaction Response + type: object DeleteActivityRequest: properties: hard_delete: type: boolean x-stream-index: "001" type: object + DeleteActivityResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "001.001" + required: + - duration + title: Delete Activity Response + type: object + DeleteBookmarkFolderResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "001.001" + required: + - duration + title: Delete Bookmark Folder Response + type: object + DeleteBookmarkResponse: + nullable: true + properties: + bookmark: + $ref: '#/components/schemas/BookmarkResponse' + description: The deleted bookmark + title: Bookmark + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - bookmark + - duration + title: Delete Bookmark Response + type: object DeleteCallRequest: description: DeleteCallRequest is the payload for deleting a call. nullable: true @@ -8816,6 +11666,38 @@ components: - duration title: DeleteCommandResponse type: object + DeleteCommentReactionResponse: + nullable: true + properties: + comment: + $ref: '#/components/schemas/CommentResponse' + description: The comment after reaction removal + title: Comment + x-stream-index: "001" + duration: + type: string + x-stream-index: "003.001" + reaction: + $ref: '#/components/schemas/FeedsReactionResponse' + description: The removed reaction + title: Reaction + x-stream-index: "002" + required: + - comment + - reaction + - duration + title: Delete Comment Reaction Response + type: object + DeleteCommentResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "001.001" + required: + - duration + title: Delete Comment Response + type: object DeleteExternalStorageResponse: description: Basic response information nullable: true @@ -8829,13 +11711,7 @@ components: - duration title: Response type: object - DeleteMessageRequest: - properties: - hard_delete: - type: boolean - x-stream-index: "001" - type: object - DeleteMessageResponse: + DeleteFeedGroupResponse: description: Basic response information nullable: true properties: @@ -8843,16 +11719,12 @@ components: description: Duration of the request in milliseconds title: Duration type: string - x-stream-index: "002.001" - message: - $ref: '#/components/schemas/MessageResponse' - x-stream-index: "001" + x-stream-index: "001.001" required: - - message - duration title: Response type: object - DeleteModerationConfigResponse: + DeleteFeedResponse: nullable: true properties: duration: @@ -8860,17 +11732,111 @@ components: x-stream-index: "001.001" required: - duration + title: Delete Feed Response type: object - DeleteModerationTemplateResponse: + DeleteFeedUserDataResponse: + description: Response for deleting feed user data nullable: true properties: + deleted_activities: + description: Number of activities that were deleted + format: int32 + title: Deleted Activities + type: integer + x-stream-index: "001" + deleted_bookmarks: + description: Number of bookmarks that were deleted + format: int32 + title: Deleted Bookmarks + type: integer + x-stream-index: "004" + deleted_comments: + description: Number of comments that were deleted + format: int32 + title: Deleted Comments + type: integer + x-stream-index: "003" + deleted_reactions: + description: Number of reactions that were deleted + format: int32 + title: Deleted Reactions + type: integer + x-stream-index: "002" duration: type: string - x-stream-index: "001.001" + x-stream-index: "005.001" required: + - deleted_activities + - deleted_reactions + - deleted_comments + - deleted_bookmarks - duration type: object - DeleteReactionRequest: + DeleteFeedViewResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "001.001" + required: + - duration + title: Delete Feed View Response + type: object + DeleteMessageRequest: + properties: + hard_delete: + type: boolean + x-stream-index: "001" + type: object + DeleteMessageResponse: + description: Basic response information + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "002.001" + message: + $ref: '#/components/schemas/MessageResponse' + x-stream-index: "001" + required: + - message + - duration + title: Response + type: object + DeleteModerationConfigResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "001.001" + required: + - duration + type: object + DeleteModerationRuleResponse: + 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 + DeleteModerationTemplateResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "001.001" + required: + - duration + type: object + DeleteReactionRequest: properties: hard_delete: type: boolean @@ -9769,11 +12735,11 @@ components: properties: callback: $ref: '#/components/schemas/AsyncModerationCallbackConfig' - x-stream-index: 018.001.002 + x-stream-index: 019.001.002 created_at: format: date-time type: number - x-stream-index: "019" + x-stream-index: "020" enabled: type: boolean x-stream-index: "003" @@ -9788,6 +12754,9 @@ components: id: type: string x-stream-index: "001" + product: + type: string + x-stream-index: "018" sns_auth_type: type: string x-stream-index: "014" @@ -9827,11 +12796,11 @@ components: timeout_ms: format: int32 type: integer - x-stream-index: 018.001.001 + x-stream-index: 019.001.001 updated_at: format: date-time type: number - x-stream-index: "020" + x-stream-index: "021" webhook_url: type: string x-stream-index: "005" @@ -9945,6 +12914,26 @@ components: - task_id - duration type: object + ExportFeedUserDataRequest: + description: Request for exporting feed user data + nullable: true + type: object + ExportFeedUserDataResponse: + description: Response for exporting feed user data + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + task_id: + description: The task ID for the export task + title: Task ID + type: string + x-stream-index: "001" + required: + - task_id + - duration + type: object ExportUserResponse: nullable: true properties: @@ -10078,1754 +13067,2585 @@ components: type: object x-stream-index: "001" type: object - FeedsModerationTemplateConfig: + FeedCreatedEvent: + description: Emitted when a feed is created. + nullable: true properties: - config_key: - type: string - x-stream-index: "002" - data_types: - additionalProperties: - type: string + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 003.001.003 + custom: + additionalProperties: {} type: object + x-stream-index: 003.001.007 + feed: + $ref: '#/components/schemas/FeedResponse' + description: The feed that was created + title: Feed x-stream-index: "001" - required: - - data_types - - config_key - type: object - Field: - nullable: true - properties: - short: - type: boolean - x-stream-index: "003" - title: + feed_visibility: type: string - x-stream-index: "001" - value: + x-stream-index: "003.003" + fid: type: string - x-stream-index: "002" - required: - - title - - value - - short - type: object - FileUploadConfig: - properties: - allowed_file_extensions: - items: - type: string - type: array - x-stream-index: "001" - allowed_mime_types: - items: - type: string - type: array - x-stream-index: "003" - blocked_file_extensions: + x-stream-index: "003.002" + members: items: - type: string + $ref: '#/components/schemas/FeedMemberResponse' type: array x-stream-index: "002" - blocked_mime_types: - items: - type: string - type: array - x-stream-index: "004" - size_limit: - format: int32 - maximum: 104857600 - minimum: 0 - type: integer - x-stream-index: "005" - required: - - size_limit - type: object - FileUploadRequest: - nullable: true - properties: - file: - description: file field - title: File + received_at: + format: date-time + type: number + x-stream-index: 003.001.004 + type: + default: feeds.feed.created + description: 'The type of event: "feeds.feed.created" in this case' + title: Event Type type: string - x-stream-index: "001" + x-stream-index: 003.001.002 user: - $ref: '#/components/schemas/OnlyUserID' - description: user for the request **server side only** + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who created the feed title: User - x-stream-index: "002" - type: object - FileUploadResponse: - nullable: true - properties: - duration: - description: Duration of the request in milliseconds - title: Duration - type: string - x-stream-index: "003.001" - file: - description: URL to the uploaded asset. Should be used to put to `asset_url` - attachment field - title: File - type: string - x-stream-index: "001" - thumb_url: - description: URL of the file thumbnail for supported file formats. Should - be put to `thumb_url` attachment field - title: Thumbnail URL - type: string - x-stream-index: "002" - required: - - duration - type: object - FirebaseConfig: - properties: - Disabled: - type: boolean - writeOnly: true - x-stream-index: "001" - apn_template: - type: string - x-stream-index: "005" - credentials_json: - type: string - x-stream-index: "006" - data_template: - type: string - x-stream-index: "004" - notification_template: - type: string - x-stream-index: "003" - server_key: - type: string - x-stream-index: "002" - type: object - FirebaseConfigFields: - properties: - apn_template: - type: string - x-stream-index: "004" - credentials_json: - type: string - x-stream-index: "006" - data_template: - type: string - x-stream-index: "003" - enabled: - type: boolean - x-stream-index: "001" - notification_template: - type: string - x-stream-index: "002" - server_key: - type: string - x-stream-index: "005" + x-stream-index: "004.001" required: - - enabled + - feed + - members + - type + - created_at + - custom + - fid + - user + title: FeedCreatedEvent type: object - Flag: - description: Contains information about flagged user or message + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + FeedDeletedEvent: + description: Emitted when a feed is deleted. + nullable: true properties: - approved_at: - description: Date of the approval - format: date-time - title: Approved at - type: number - x-stream-index: "015" created_at: description: Date/time of creation format: date-time title: Created at type: number - x-stream-index: "011" - created_by_automod: - type: boolean - x-stream-index: "004" + x-stream-index: 001.001.003 custom: additionalProperties: {} type: object - x-stream-index: "022" - details: - $ref: '#/components/schemas/FlagDetails' - x-stream-index: "021" - reason: - type: string - x-stream-index: "020" - rejected_at: - description: Date of the rejection - format: date-time - title: Rejected at - type: number - x-stream-index: "016" - reviewed_at: - description: Date of the review - format: date-time - title: Reviewed at - type: number - x-stream-index: "013" - reviewed_by: + x-stream-index: 001.001.007 + feed_visibility: type: string - x-stream-index: "014" - target_message: - $ref: '#/components/schemas/Message' - x-stream-index: "008" - target_message_id: - description: ID of flagged message - title: Target Message ID + x-stream-index: "001.003" + fid: type: string - x-stream-index: "007" - target_user: - $ref: '#/components/schemas/User' - description: Flagged user - title: User - x-stream-index: "010" - updated_at: - description: Date/time of the last update + x-stream-index: "001.002" + received_at: format: date-time - title: Updated at type: number - x-stream-index: "012" + x-stream-index: 001.001.004 + type: + default: feeds.feed.deleted + description: 'The type of event: "feeds.feed.deleted" in this case' + title: Event Type + type: string + x-stream-index: 001.001.002 user: - $ref: '#/components/schemas/User' - description: User who flagged a message or a user + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who deleted the feed title: User - x-stream-index: "006" + x-stream-index: "002.001" required: - - created_by_automod + - type - created_at - - updated_at - title: Flag - type: object - FlagContentOptions: - properties: - reason: - type: string - x-stream-index: "001" - required: - - reason + - custom + - fid + title: FeedDeletedEvent type: object - FlagDetails: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + FeedGroup: properties: - Extra: + ActivityProcessors: + items: + $ref: '#/components/schemas/ActivityProcessorConfig' + type: array + writeOnly: true + x-stream-index: "012" + ActivitySelectors: + items: + $ref: '#/components/schemas/ActivitySelectorConfig' + type: array + writeOnly: true + x-stream-index: "013" + Aggregation: + $ref: '#/components/schemas/AggregationConfig' + x-stream-index: "015" + AggregationVersion: + format: int32 + type: integer + writeOnly: true + x-stream-index: "016" + AppPK: + format: int32 + type: integer + writeOnly: true + x-stream-index: "002" + Custom: additionalProperties: {} type: object writeOnly: true - x-stream-index: "002" - automod: - $ref: '#/components/schemas/AutomodDetails' - x-stream-index: "001" - original_text: + x-stream-index: "007" + DefaultVisibility: type: string - x-stream-index: "003" - required: - - Extra - - original_text - type: object - FlagFeedback: - properties: - created_at: + writeOnly: true + x-stream-index: "006" + DeletedAt: format: date-time type: number - x-stream-index: "005" - labels: - items: - $ref: '#/components/schemas/Label' - type: array - x-stream-index: "006" - message_id: + writeOnly: true + x-stream-index: "010" + ID: type: string + writeOnly: true + x-stream-index: "003" + LastFeedGetAt: + format: date-time + type: number + writeOnly: true + x-stream-index: "017" + Notification: + $ref: '#/components/schemas/NotificationConfig' x-stream-index: "004" + PushNotification: + $ref: '#/components/schemas/PushNotificationConfig' + x-stream-index: "005" + Ranking: + $ref: '#/components/schemas/RankingConfig' + x-stream-index: "014" + Stories: + $ref: '#/components/schemas/StoriesConfig' + x-stream-index: "011" + created_at: + format: date-time + type: number + x-stream-index: "008" + updated_at: + format: date-time + type: number + x-stream-index: "009" required: - - message_id + - AppPK + - ID + - DefaultVisibility + - Custom - created_at - - labels - type: object - FlagMessageDetails: - properties: - pin_changed: - type: boolean - x-stream-index: "002" - should_enrich: - type: boolean - x-stream-index: "003" - skip_push: - type: boolean - x-stream-index: "004" - updated_by_id: - type: string - x-stream-index: "001" + - updated_at + - ActivityProcessors + - ActivitySelectors + - AggregationVersion type: object - FlagRequest: + FeedGroupChangedEvent: + description: Emitted when a feed group is changed. nullable: true properties: + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 001.001.003 custom: additionalProperties: {} - description: Additional metadata about the flag - title: Custom type: object - x-stream-index: "006" - entity_creator_id: - description: ID of the user who created the flagged entity - title: Entity Creator ID - type: string + x-stream-index: 001.001.007 + feed_group: + $ref: '#/components/schemas/FeedGroup' + description: The feed group that was changed + title: Feed Type x-stream-index: "003" - entity_id: - description: Unique identifier of the entity being flagged - title: Entity ID + feed_visibility: type: string - x-stream-index: "002" - entity_type: - description: Type of entity being flagged (e.g., message, user) - title: Entity Type + x-stream-index: "001.003" + fid: type: string - x-stream-index: "001" - moderation_payload: - $ref: '#/components/schemas/ModerationPayload' - description: Content being flagged - title: Moderation Payload - x-stream-index: "005" - reason: - description: Optional explanation for why the content is being flagged - maxLength: 255 - title: Reason + x-stream-index: "001.002" + received_at: + format: date-time + type: number + x-stream-index: 001.001.004 + type: + default: feeds.feed_group.changed + description: 'The type of event: "feeds.feed_group.changed" in this case' + title: Event Type type: string - x-stream-index: "004" + x-stream-index: 001.001.002 user: - $ref: '#/components/schemas/UserRequest' - x-stream-index: "007.002" - user_id: - type: string - x-stream-index: "007.001" - required: - - entity_type - - entity_id - type: object - FlagResponse: - nullable: true - properties: - duration: - type: string + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who changed the feed group + title: User x-stream-index: "002.001" - item_id: - description: Unique identifier of the created moderation item - title: Item ID - type: string - x-stream-index: "001" required: - - item_id - - duration + - type + - created_at + - custom + - fid + title: FeedGroupChangedEvent type: object - FlagUpdatedEvent: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + FeedGroupDeletedEvent: + description: Emitted when a feed group is deleted. nullable: true properties: - CreatedBy: - $ref: '#/components/schemas/UserResponse' - x-stream-index: "004" - Message: - $ref: '#/components/schemas/MessageResponse' - x-stream-index: "002" - User: - $ref: '#/components/schemas/UserResponse' - x-stream-index: "003" created_at: + description: Date/time of creation format: date-time + title: Created at type: number - x-stream-index: "001.003" + x-stream-index: 002.001.003 custom: additionalProperties: {} type: object - x-stream-index: "001.007" + x-stream-index: 002.001.007 + feed_visibility: + type: string + x-stream-index: "002.003" + fid: + type: string + x-stream-index: "002.002" + group_id: + description: The ID of the feed group that was deleted + title: Group ID + type: string + x-stream-index: "001" received_at: format: date-time type: number - x-stream-index: "001.004" + x-stream-index: 002.001.004 type: - default: flag.updated + default: feeds.feed_group.deleted + description: 'The type of event: "feeds.feed_group.deleted" in this case' + title: Event Type type: string - x-stream-index: "001.002" + x-stream-index: 002.001.002 required: + - group_id - type - created_at - custom - title: FlagUpdatedEvent + - fid + title: FeedGroupDeletedEvent 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 - FlagUserOptions: - properties: - reason: - type: string - x-stream-index: "001" - required: - - reason - type: object - FrameRecordSettings: + FeedGroupResponse: properties: - capture_interval_in_seconds: - format: int32 - maximum: 60 - minimum: 2 - type: integer - x-stream-index: "003" - mode: - enum: - - available - - disabled - - auto-on + activity_processors: + description: Configuration for activity processors + items: + $ref: '#/components/schemas/ActivityProcessorConfig' + title: Activity Processors + type: array + x-stream-index: "009" + activity_selectors: + description: Configuration for activity selectors + items: + $ref: '#/components/schemas/ActivitySelectorConfig' + title: Activity Selectors + type: array + x-stream-index: "010" + aggregation: + $ref: '#/components/schemas/AggregationConfig' + description: Configuration for activity aggregation + title: Aggregation + x-stream-index: "012" + created_at: + description: When the feed group was created + format: date-time + title: Created At + type: number + x-stream-index: "006" + custom: + additionalProperties: {} + description: Custom data for the feed group + title: Custom Data + type: object + x-stream-index: "005" + default_visibility: + description: Default visibility for activities + title: Default Visibility type: string - x-stream-index: "001" - quality: + x-stream-index: "004" + id: + description: Identifier within the group + title: Feed Group ID type: string + x-stream-index: "001" + notification: + $ref: '#/components/schemas/NotificationConfig' + description: Configuration for notifications + title: Notification x-stream-index: "002" + push_notification: + $ref: '#/components/schemas/PushNotificationConfig' + x-stream-index: "003" + ranking: + $ref: '#/components/schemas/RankingConfig' + description: Configuration for activity ranking + title: Ranking + x-stream-index: "011" + stories: + $ref: '#/components/schemas/StoriesConfig' + description: Configuration for stories feature + title: Stories + x-stream-index: "008" + updated_at: + description: When the feed group was last updated + format: date-time + title: Updated At + type: number + x-stream-index: "007" required: - - mode - - capture_interval_in_seconds + - id + - created_at + - updated_at + title: Feed Group type: object - FrameRecordingEgressConfig: + FeedInput: properties: - capture_interval_in_seconds: - format: int32 - type: integer - x-stream-index: "007" - external_storage: - $ref: '#/components/schemas/ExternalStorage' - x-stream-index: "006" - quality: - $ref: '#/components/schemas/Quality' + custom: + additionalProperties: {} + type: object x-stream-index: "004" - storage_name: + description: + maxLength: 1000 type: string + x-stream-index: "002" + filter_tags: + items: + type: string + maximum: 255 + type: array x-stream-index: "005" + members: + items: + $ref: '#/components/schemas/FeedMemberRequest' + type: array + x-stream-index: "006" + name: + maxLength: 255 + type: string + x-stream-index: "001" + visibility: + enum: + - public + - visible + - followers + - members + - private + type: string + x-stream-index: "003" type: object - FrameRecordingResponse: + FeedMemberAddedEvent: + description: Emitted when a feed member is added. + nullable: true properties: - status: + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 003.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 003.001.007 + feed_visibility: + type: string + x-stream-index: "003.003" + fid: type: string + x-stream-index: "003.002" + member: + $ref: '#/components/schemas/FeedMemberResponse' + description: The member that was added + title: Member x-stream-index: "001" + received_at: + format: date-time + type: number + x-stream-index: 003.001.004 + type: + default: feeds.feed_member.added + description: 'The type of event: "feeds.feed_member.added" in this case' + title: Event Type + type: string + x-stream-index: 003.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who added the member + title: User + x-stream-index: "002.001" required: - - status + - member + - type + - created_at + - custom + - fid + title: FeedMemberAddedEvent type: object - FrameRecordingSettingsRequest: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + FeedMemberRemovedEvent: + description: Emitted when a feed member is removed. + nullable: true properties: - capture_interval_in_seconds: - format: int32 - maximum: 60 - minimum: 2 - type: integer - x-stream-index: "003" - mode: - enum: - - available - - disabled - - auto-on + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 003.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 003.001.007 + feed_visibility: + type: string + x-stream-index: "003.003" + fid: + type: string + x-stream-index: "003.002" + member_id: type: string x-stream-index: "001" - quality: - enum: - - 360p - - 480p - - 720p - - 1080p - - 1440p + received_at: + format: date-time + type: number + x-stream-index: 003.001.004 + type: + default: feeds.feed_member.removed + description: 'The type of event: "feeds.feed_member.removed" in this case' + title: Event Type type: string - x-stream-index: "002" + x-stream-index: 003.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who removed the member + title: User + x-stream-index: "002.001" required: - - mode - - capture_interval_in_seconds + - member_id + - type + - created_at + - custom + - fid + title: FeedMemberRemovedEvent type: object - FrameRecordingSettingsResponse: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + FeedMemberRequest: properties: - capture_interval_in_seconds: - format: int32 - maximum: 60 - minimum: 2 - type: integer - x-stream-index: "003" - mode: - enum: - - available - - disabled - - auto-on + custom: + additionalProperties: {} + description: Custom data for the member + title: Custom Data + type: object + x-stream-index: "004" + invite: + description: Whether this is an invite to become a member + title: Invite + type: boolean + x-stream-index: "005" + membership_level: + description: ID of the membership level to assign to the member + maxLength: 255 + title: Membership Level type: string - x-stream-index: "001" - quality: + x-stream-index: "003" + role: + description: Role of the member in the feed + maxLength: 255 + title: Role type: string x-stream-index: "002" + user_id: + description: ID of the user to add as a member + maxLength: 255 + title: User ID + type: string + x-stream-index: "001" required: - - mode - - capture_interval_in_seconds + - user_id + title: Feed Member Payload type: object - FullUserResponse: + FeedMemberResponse: properties: - avg_response_time: - format: int32 - type: integer - x-stream-index: "001.018" - ban_expires: - format: date-time - type: number - x-stream-index: "015" - banned: - type: boolean - x-stream-index: "001.012" - blocked_user_ids: - items: - type: string - type: array - x-stream-index: "014" - channel_mutes: - items: - $ref: '#/components/schemas/ChannelMute' - type: array - x-stream-index: "007" created_at: + description: When the membership was created format: date-time + title: Created At type: number - x-stream-index: "001.009" + x-stream-index: "008" custom: additionalProperties: {} + description: Custom data for the membership + title: Custom Data type: object - x-stream-index: "001.004" - deactivated_at: + x-stream-index: "007" + invite_accepted_at: + description: When the invite was accepted format: date-time + title: Invite Accepted At type: number - x-stream-index: "001.016" - deleted_at: + x-stream-index: "005" + invite_rejected_at: + description: When the invite was rejected format: date-time + title: Invite Rejected At type: number - x-stream-index: "001.011" - devices: - items: - $ref: '#/components/schemas/DeviceResponse' - type: array + x-stream-index: "006" + membership_level: + $ref: '#/components/schemas/MembershipLevelResponse' + description: Membership level assigned to the member + title: Membership Level x-stream-index: "004" - id: + role: + description: Role of the member in the feed + title: Role type: string - x-stream-index: "001.001" - image: + x-stream-index: "002" + status: + description: Status of the membership + enum: + - member + - pending + - rejected + title: Status type: string - x-stream-index: "001.003" - invisible: - type: boolean - x-stream-index: "005" - language: + x-stream-index: "003" + updated_at: + description: When the membership was last updated + format: date-time + title: Updated At + type: number + x-stream-index: "009" + user: + $ref: '#/components/schemas/UserResponse' + description: User who is a member + title: User + x-stream-index: "001" + required: + - user + - role + - status + - created_at + - updated_at + title: Feed Member + type: object + FeedMemberUpdatedEvent: + description: Emitted when a feed member is updated. + nullable: true + properties: + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 003.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 003.001.007 + feed_visibility: type: string - x-stream-index: "001.005" - last_active: + x-stream-index: "003.003" + fid: + type: string + x-stream-index: "003.002" + member: + $ref: '#/components/schemas/FeedMemberResponse' + description: The member that was updated + title: Member + x-stream-index: "001" + received_at: format: date-time type: number - x-stream-index: "001.014" - latest_hidden_channels: + x-stream-index: 003.001.004 + type: + default: feeds.feed_member.updated + description: 'The type of event: "feeds.feed_member.updated" in this case' + title: Event Type + type: string + x-stream-index: 003.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who updated the member + title: User + x-stream-index: "002.001" + required: + - member + - type + - created_at + - custom + - fid + title: FeedMemberUpdatedEvent + 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 + FeedOwnCapability: + description: All possibility of string to use + enum: + - add-activity + - add-activity-reaction + - add-comment + - add-comment-reaction + - bookmark-activity + - create-feed + - delete-bookmark + - delete-comment + - delete-feed + - edit-bookmark + - follow + - invite-feed + - join-feed + - leave-feed + - manage-feed-group + - mark-activity + - pin-activity + - query-feed-members + - query-follows + - read-activities + - read-feed + - remove-activity + - remove-activity-reaction + - remove-comment-reaction + - unfollow + - update-activity + - update-comment + - update-feed + - update-feed-followers + - update-feed-members + title: FeedOwnCapability + type: string + FeedRequest: + properties: + created_by_id: + description: ID of the feed creator + title: Created By ID + type: string + x-stream-index: "003" + custom: + additionalProperties: {} + description: Custom data for the feed + title: Custom Data + type: object + x-stream-index: "004.004" + description: + description: Description of the feed + maxLength: 1000 + title: Description + type: string + x-stream-index: "004.002" + feed_group_id: + description: ID of the feed group + maxLength: 255 + title: Feed Group ID + type: string + x-stream-index: "001" + feed_id: + description: ID of the feed + maxLength: 255 + title: Feed ID + type: string + x-stream-index: "002" + filter_tags: + description: Tags used for filtering feeds items: type: string + maximum: 255 + title: Filter Tags type: array - x-stream-index: "012" - mutes: + x-stream-index: "004.005" + members: + description: Initial members for the feed items: - $ref: '#/components/schemas/UserMuteResponse' + $ref: '#/components/schemas/FeedMemberRequest' + title: Members type: array - x-stream-index: "006" + x-stream-index: "004.006" name: + description: Name of the feed + maxLength: 255 + title: Name type: string - x-stream-index: "001.002" - online: - type: boolean - x-stream-index: "001.013" - privacy_settings: - $ref: '#/components/schemas/PrivacySettingsResponse' - x-stream-index: "003" - revoke_tokens_issued_before: + x-stream-index: "004.001" + visibility: + description: Visibility setting for the feed + enum: + - public + - visible + - followers + - members + - private + title: Visibility + type: string + x-stream-index: "004.003" + required: + - feed_group_id + - feed_id + title: Feed Payload + type: object + FeedResponse: + properties: + created_at: + description: When the feed was created format: date-time + title: Created At type: number - x-stream-index: "001.015" - role: + x-stream-index: "015" + created_by: + $ref: '#/components/schemas/UserResponse' + description: User who created the feed + title: Created By + x-stream-index: "009" + custom: + additionalProperties: {} + description: Custom data for the feed + title: Custom Data + type: object + x-stream-index: "006" + deleted_at: + description: When the feed was deleted + format: date-time + title: Deleted At + type: number + x-stream-index: "017" + description: + description: Description of the feed + title: Description type: string - x-stream-index: "001.006" - shadow_banned: - type: boolean - x-stream-index: "013" - teams: + x-stream-index: "005" + feed: + description: Fully qualified feed ID (group_id:id) + title: FID + type: string + x-stream-index: "003" + filter_tags: + description: Tags used for filtering feeds items: type: string + title: Filter Tags type: array - x-stream-index: "001.007" - teams_role: - additionalProperties: - type: string - type: object - x-stream-index: "001.008" - total_unread_count: + x-stream-index: "007" + follower_count: + description: Number of followers of this feed format: int32 + title: Follower Count type: integer - x-stream-index: "009" - unread_channels: + x-stream-index: "011" + following_count: + description: Number of feeds this feed follows format: int32 + title: Following Count type: integer - x-stream-index: "010" - unread_count: + x-stream-index: "012" + group_id: + description: Group this feed belongs to + title: Group ID + type: string + x-stream-index: "001" + id: + description: Unique identifier for the feed + title: ID + type: string + x-stream-index: "002" + member_count: + description: Number of members in this feed format: int32 + title: Member Count type: integer - x-stream-index: "008" - unread_threads: + x-stream-index: "010" + name: + description: Name of the feed + title: Name + type: string + x-stream-index: "004" + own_follows: + description: Follow relationships where the current user's feeds are following + this feed + items: + $ref: '#/components/schemas/FollowResponse' + title: Own Follows + type: array + x-stream-index: "014" + pin_count: + description: Number of pinned activities in this feed format: int32 + title: Pin Count type: integer - x-stream-index: "011" + x-stream-index: "013" updated_at: + description: When the feed was last updated format: date-time + title: Updated At type: number - x-stream-index: "001.010" + x-stream-index: "016" + visibility: + description: Visibility setting for the feed + title: Visibility + type: string + x-stream-index: "008" required: + - group_id - id - - custom - - language - - role - - teams + - feed + - name + - description + - created_by + - member_count + - follower_count + - following_count + - pin_count - created_at - updated_at - - banned - - online - - devices - - invisible - - mutes - - channel_mutes - - unread_count - - total_unread_count - - unread_channels - - unread_threads - - shadow_banned - - blocked_user_ids + title: Feed type: object - GeofenceResponse: + FeedUpdatedEvent: + description: Emitted when a feed is created. nullable: true properties: - country_codes: - items: - type: string - type: array - x-stream-index: "004" - description: + created_at: + format: date-time + type: number + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + feed: + $ref: '#/components/schemas/FeedResponse' + description: The feed that was created + title: Feed + x-stream-index: "001" + feed_visibility: type: string - x-stream-index: "003" - name: + x-stream-index: "002.003" + fid: type: string - x-stream-index: "001" + x-stream-index: "002.002" + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 type: + default: feeds.feed.updated + description: 'The type of event: "feeds.feed.updated" in this case' + title: Event Type type: string - x-stream-index: "002" + x-stream-index: 002.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who created the feed + title: User + x-stream-index: "003.001" required: - - name + - feed + - type + - created_at + - custom + - fid + title: FeedUpdatedEvent type: object - GeofenceSettings: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + FeedViewResponse: properties: - names: + activity_processors: + description: Configured activity processors items: - type: string + $ref: '#/components/schemas/ActivityProcessorConfig' + title: Activity Processors + type: array + x-stream-index: "003" + activity_selectors: + description: Configured activity selectors + items: + $ref: '#/components/schemas/ActivitySelectorConfig' + title: Activity Selectors type: array + x-stream-index: "002" + aggregation: + $ref: '#/components/schemas/AggregationConfig' + description: Configuration for activity aggregation + title: Aggregation + x-stream-index: "005" + id: + description: Unique identifier for the custom feed view + title: View ID + type: string x-stream-index: "001" + last_used_at: + description: When the feed view was last used + format: date-time + title: Last Used At + type: number + x-stream-index: "006" + ranking: + $ref: '#/components/schemas/RankingConfig' + description: Configuration for activity ranking + title: Ranking + x-stream-index: "004" required: - - names + - id + title: Feed View type: object - GeofenceSettingsRequest: + FeedsEventPreferences: properties: - names: - items: - type: string - type: array + comments: + type: string + x-stream-index: "002" + mentions: + type: string + x-stream-index: "004" + new_followers: + type: string + x-stream-index: "003" + reactions: + type: string x-stream-index: "001" type: object - GeofenceSettingsResponse: + FeedsEventPreferencesInput: properties: - names: - items: + comments: + enum: + - all + - none + type: string + x-stream-index: "002" + mentions: + enum: + - all + - none + type: string + x-stream-index: "004" + new_followers: + enum: + - all + - none + type: string + x-stream-index: "003" + reactions: + enum: + - all + - none + type: string + x-stream-index: "001" + type: object + FeedsModerationTemplateConfig: + properties: + config_key: + type: string + x-stream-index: "002" + data_types: + additionalProperties: type: string - type: array + type: object x-stream-index: "001" required: - - names + - data_types + - config_key type: object - GetActiveCallsStatusResponse: - description: Response containing active calls status information - nullable: true + FeedsReactionResponse: properties: - duration: + activity_id: + description: ID of the activity that was reacted to + title: Activity ID type: string - x-stream-index: "001.001" - end_time: - description: End time of the status period + x-stream-index: "002" + comment_id: + description: ID of the comment that was reacted to + title: Comment ID + type: string + x-stream-index: "003" + created_at: + description: When the reaction was created format: date-time - title: time.Time + title: Created At type: number - x-stream-index: "003" - metrics: - $ref: '#/components/schemas/ActiveCallsMetrics' - description: Detailed metrics - title: '*ActiveCallsMetrics' + x-stream-index: "006" + custom: + additionalProperties: {} + description: Custom data for the reaction + title: Custom Data + type: object x-stream-index: "005" - start_time: - description: Start time of the status period + type: + description: Type of reaction + title: Type + type: string + x-stream-index: "004" + updated_at: + description: When the reaction was last updated format: date-time - title: time.Time + title: Updated At type: number - x-stream-index: "002" - summary: - $ref: '#/components/schemas/ActiveCallsSummary' - description: Summary of active calls - title: '*ActiveCallsSummary' - x-stream-index: "004" + x-stream-index: "007" + user: + $ref: '#/components/schemas/UserResponse' + description: User who created the reaction + title: User + x-stream-index: "001" required: - - duration - - start_time - - end_time - title: GetActiveCallsStatusResponse + - user + - activity_id + - type + - created_at + - updated_at + title: Activity Reaction type: object - GetApplicationResponse: - description: Basic response information + Field: nullable: true properties: - app: - $ref: '#/components/schemas/AppResponseFields' + short: + type: boolean + x-stream-index: "003" + title: + type: string x-stream-index: "001" - duration: - description: Duration of the request in milliseconds - title: Duration + value: type: string - x-stream-index: "002.001" + x-stream-index: "002" required: - - app - - duration - title: Response + - title + - value + - short type: object - GetBlockListResponse: - description: Response for get block list - nullable: true + FileUploadConfig: properties: - blocklist: - $ref: '#/components/schemas/BlockListResponse' - description: Block list object - title: BlockListResponse + allowed_file_extensions: + items: + type: string + type: array x-stream-index: "001" - duration: - type: string - x-stream-index: "002.001" + allowed_mime_types: + items: + type: string + type: array + x-stream-index: "003" + blocked_file_extensions: + items: + type: string + type: array + x-stream-index: "002" + blocked_mime_types: + items: + type: string + type: array + x-stream-index: "004" + size_limit: + format: int32 + maximum: 104857600 + minimum: 0 + type: integer + x-stream-index: "005" required: - - duration - title: GetBlockListResponse + - size_limit type: object - x-stream-docs-page-id: get_block_list - GetBlockedUsersResponse: + FileUploadRequest: nullable: true properties: - blocks: - description: Array of blocked user object - items: - $ref: '#/components/schemas/BlockedUserResponse' - title: Blocks - type: array + file: + description: file field + title: File + type: string x-stream-index: "001" + user: + $ref: '#/components/schemas/OnlyUserID' + description: user for the request **server side only** + title: User + x-stream-index: "002" + type: object + FileUploadResponse: + nullable: true + properties: duration: description: Duration of the request in milliseconds title: Duration type: string - x-stream-index: "002.001" + x-stream-index: "003.001" + file: + description: URL to the uploaded asset. Should be used to put to `asset_url` + attachment field + title: File + type: string + x-stream-index: "001" + thumb_url: + description: URL of the file thumbnail for supported file formats. Should + be put to `thumb_url` attachment field + title: Thumbnail URL + type: string + x-stream-index: "002" required: - - blocks - duration type: object - GetCallReportResponse: - description: Basic response information - nullable: true + FirebaseConfig: properties: - chat_activity: - $ref: '#/components/schemas/ChatActivityStatsResponse' + Disabled: + type: boolean + writeOnly: true + x-stream-index: "001" + apn_template: + type: string + x-stream-index: "005" + credentials_json: + type: string + x-stream-index: "006" + data_template: + type: string x-stream-index: "004" - duration: - description: Duration of the request in milliseconds - title: Duration + notification_template: type: string - x-stream-index: "001.001" - report: - $ref: '#/components/schemas/ReportResponse' x-stream-index: "003" - session_id: + server_key: type: string x-stream-index: "002" - video_reactions: - items: - $ref: '#/components/schemas/VideoReactionsResponse' - type: array - x-stream-index: "005" - required: - - duration - - session_id - - report - title: Response type: object - GetCallResponse: - nullable: true + FirebaseConfigFields: properties: - call: - $ref: '#/components/schemas/CallResponse' - x-stream-index: "001.001" - duration: + apn_template: type: string - x-stream-index: "002.001" - members: - items: - $ref: '#/components/schemas/MemberResponse' - type: array - x-stream-index: "001.002" - own_capabilities: - items: - $ref: '#/components/schemas/OwnCapability' - type: array - x-stream-index: "001.004" + x-stream-index: "004" + credentials_json: + type: string + x-stream-index: "006" + data_template: + type: string + x-stream-index: "003" + enabled: + type: boolean + x-stream-index: "001" + notification_template: + type: string + x-stream-index: "002" + server_key: + type: string + x-stream-index: "005" required: - - call - - members - - own_capabilities - - blocked_users - - duration - title: GetCallResponse + - enabled type: object - GetCallTypeResponse: + Flag: + description: Contains information about flagged user or message nullable: true properties: created_at: + description: Date/time of creation format: date-time + title: Created at type: number - x-stream-index: "001.005" - duration: + x-stream-index: "019" + custom: + additionalProperties: {} + description: Additional metadata about the flag + title: Custom + type: object + x-stream-index: "014" + entity_creator_id: + description: ID of the user who created the flagged entity + title: Entity Creator ID type: string - x-stream-index: "002.001" - external_storage: + x-stream-index: "009" + entity_id: + description: Unique identifier of the entity being flagged + title: Entity ID type: string - x-stream-index: "001.007" - grants: - additionalProperties: - items: - type: string - type: array - type: object - x-stream-index: "001.002" - name: + x-stream-index: "008" + entity_type: + description: Type of entity being flagged (e.g., message, user) + title: Entity Type type: string - x-stream-index: "001.001" - notification_settings: - $ref: '#/components/schemas/NotificationSettings' - x-stream-index: "001.004" - settings: - $ref: '#/components/schemas/CallSettingsResponse' - x-stream-index: "001.003" + x-stream-index: "007" + is_streamed_content: + type: boolean + x-stream-index: "012" + labels: + description: Labels from bodyguard, API calls, our own AI etc + items: + type: string + title: Labels + type: array + x-stream-index: "015" + moderation_payload: + $ref: '#/components/schemas/ModerationPayload' + description: Content being flagged + title: Moderation Payload + x-stream-index: "010" + moderation_payload_hash: + type: string + x-stream-index: "011" + reason: + description: Optional explanation for why the content is being flagged + title: Reason + type: string + x-stream-index: "013" + result: + description: Result of bodyguard, API calls, our own AI etc + items: + additionalProperties: {} + type: object + title: Result + type: array + x-stream-index: "016" + review_queue_item: + $ref: '#/components/schemas/ReviewQueueItem' + x-stream-index: "018" + review_queue_item_id: + description: ID of the review queue item + title: Review Queue Item ID + type: string + x-stream-index: "017" + type: + type: string + x-stream-index: "004" updated_at: + description: Date/time of the last update format: date-time + title: Updated at type: number - x-stream-index: "001.006" + x-stream-index: "020" + user: + $ref: '#/components/schemas/User' + description: User who flagged a message or a user + title: User + x-stream-index: "006" required: - - name - - grants - - settings - - notification_settings + - entity_type + - entity_id + - result - created_at - updated_at - - duration - title: GetCallTypeResponse + title: Flag type: object - GetCampaignResponse: - description: Basic response information - nullable: true + FlagContentOptions: properties: - campaign: - $ref: '#/components/schemas/CampaignResponse' - x-stream-index: "001" - duration: - description: Duration of the request in milliseconds - title: Duration + reason: type: string - x-stream-index: "003.001" - users: - $ref: '#/components/schemas/PagerResponse' - x-stream-index: "002" - required: - - duration - title: Response + x-stream-index: "001" type: object - GetChannelTypeResponse: - description: Basic response information - nullable: true + FlagDetails: properties: - allowed_flag_reasons: - items: - type: string - type: array - x-stream-index: 003.002.026 + Extra: + additionalProperties: {} + type: object + writeOnly: true + x-stream-index: "002" automod: - enum: - - disabled - - simple - - AI - type: string - x-stream-index: 003.002.021 - automod_behavior: - enum: - - flag - - block - - shadow_block - type: string - x-stream-index: 003.002.022 - automod_thresholds: - $ref: '#/components/schemas/Thresholds' - x-stream-index: 003.002.027 - blocklist: - type: string - x-stream-index: 003.002.023 - blocklist_behavior: - enum: - - flag - - block - - shadow_block + $ref: '#/components/schemas/AutomodDetails' + x-stream-index: "001" + original_text: type: string - x-stream-index: 003.002.024 - blocklists: - items: - $ref: '#/components/schemas/BlockListOptions' - type: array - x-stream-index: 003.002.025 - commands: - items: - $ref: '#/components/schemas/Command' - type: array - x-stream-index: "003.003" - connect_events: - type: boolean - x-stream-index: 003.002.004 + x-stream-index: "003" + required: + - Extra + - original_text + type: object + FlagFeedback: + properties: created_at: format: date-time type: number - x-stream-index: 003.001.003 - custom_events: - type: boolean - x-stream-index: 003.002.012 - duration: - description: Duration of the request in milliseconds - title: Duration + x-stream-index: "005" + labels: + items: + $ref: '#/components/schemas/Label' + type: array + x-stream-index: "006" + message_id: type: string - x-stream-index: "004.001" - grants: - additionalProperties: - items: - type: string - type: array - type: object + x-stream-index: "004" + required: + - message_id + - created_at + - labels + type: object + FlagMessageDetails: + properties: + pin_changed: + type: boolean x-stream-index: "002" - mark_messages_pending: + should_enrich: type: boolean - x-stream-index: 003.002.015 - max_message_length: - format: int32 - maximum: 20000 - type: integer - x-stream-index: 003.002.020 - mutes: + x-stream-index: "003" + skip_push: type: boolean - x-stream-index: 003.002.009 - name: - type: string - x-stream-index: 003.002.001 - partition_size: - format: int32 - type: integer - x-stream-index: 003.002.028 - partition_ttl: - example: 24h - format: duration - nullable: true + x-stream-index: "004" + updated_by_id: type: string - x-stream-index: 003.002.029 - permissions: - items: - $ref: '#/components/schemas/PolicyRequest' - type: array x-stream-index: "001" - polls: - type: boolean - x-stream-index: 003.002.016 - push_notifications: - type: boolean - x-stream-index: 003.002.013 - quotes: - type: boolean - x-stream-index: 003.002.008 - reactions: - type: boolean - x-stream-index: 003.002.006 - read_events: - type: boolean - x-stream-index: 003.002.003 - reminders: - type: boolean - x-stream-index: 003.002.014 - replies: - type: boolean - x-stream-index: 003.002.007 - search: - type: boolean - x-stream-index: 003.002.005 - shared_locations: - type: boolean - x-stream-index: 003.002.018 - skip_last_msg_update_for_system_msgs: - type: boolean - x-stream-index: 003.002.030 - typing_events: - type: boolean - x-stream-index: 003.002.002 - updated_at: - format: date-time - type: number - x-stream-index: 003.001.004 - uploads: - type: boolean - x-stream-index: 003.002.010 - url_enrichment: - type: boolean - x-stream-index: 003.002.011 - user_message_reminders: - type: boolean - x-stream-index: 003.002.017 - required: - - permissions - - grants - - created_at - - updated_at - - name - - typing_events - - read_events - - connect_events - - search - - reactions - - replies - - quotes - - mutes - - uploads - - url_enrichment - - custom_events - - push_notifications - - reminders - - mark_messages_pending - - polls - - user_message_reminders - - shared_locations - - message_retention - - max_message_length - - automod - - automod_behavior - - skip_last_msg_update_for_system_msgs - - commands - - duration - title: Response type: object - GetCommandResponse: + FlagRequest: nullable: true properties: - args: + custom: + additionalProperties: {} + description: Additional metadata about the flag + title: Custom + type: object + x-stream-index: "006" + entity_creator_id: + description: ID of the user who created the flagged entity + title: Entity Creator ID type: string - x-stream-index: "001.006" - created_at: - format: date-time - readOnly: true - type: number - x-stream-index: "001.001" - description: + x-stream-index: "003" + entity_id: + description: Unique identifier of the entity being flagged + title: Entity ID type: string - x-stream-index: "001.005" - duration: + x-stream-index: "002" + entity_type: + description: Type of entity being flagged (e.g., message, user) + title: Entity Type type: string - x-stream-index: "002.001" - name: + x-stream-index: "001" + moderation_payload: + $ref: '#/components/schemas/ModerationPayload' + description: Content being flagged + title: Moderation Payload + x-stream-index: "005" + reason: + description: Optional explanation for why the content is being flagged + maxLength: 255 + title: Reason type: string - x-stream-index: "001.004" - set: + x-stream-index: "004" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "007.002" + user_id: type: string - x-stream-index: "001.007" - updated_at: - format: date-time - readOnly: true - type: number - x-stream-index: "001.002" + x-stream-index: "007.001" required: - - name - - description - - args - - set - - duration - title: GetCommandResponse + - entity_type + - entity_id type: object - GetConfigResponse: + FlagResponse: nullable: true properties: - config: - $ref: '#/components/schemas/ConfigResponse' - description: The retrieved moderation configuration - title: Config - x-stream-index: "001" duration: type: string x-stream-index: "002.001" + item_id: + description: Unique identifier of the created moderation item + title: Item ID + type: string + x-stream-index: "001" required: + - item_id - duration type: object - GetCustomPermissionResponse: - description: Basic response information + FlagUpdatedEvent: nullable: true properties: - duration: - description: Duration of the request in milliseconds - title: Duration + CreatedBy: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "004" + Message: + $ref: '#/components/schemas/MessageResponse' + x-stream-index: "002" + User: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "003" + created_at: + format: date-time + type: number + x-stream-index: "001.003" + custom: + additionalProperties: {} + type: object + x-stream-index: "001.007" + received_at: + format: date-time + type: number + x-stream-index: "001.004" + type: + default: flag.updated type: string - x-stream-index: "002.001" - permission: - $ref: '#/components/schemas/Permission' - x-stream-index: "001" + x-stream-index: "001.002" required: - - permission - - duration - title: Response + - type + - created_at + - custom + title: FlagUpdatedEvent type: object - GetDraftResponse: - description: Basic response information + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + FlagUserOptions: + properties: + reason: + type: string + x-stream-index: "001" + type: object + FollowBatchRequest: nullable: true properties: - draft: - $ref: '#/components/schemas/DraftResponse' + follows: + description: List of follow relationships to create + items: + $ref: '#/components/schemas/FollowRequest' + maximum: 1000 + minimum: 1 + title: Follows + type: array x-stream-index: "001" - duration: - description: Duration of the request in milliseconds - title: Duration - type: string - x-stream-index: "002.001" required: - - draft - - duration - title: Response + - follows + title: Follow Batch Request type: object - GetEdgesResponse: - description: Basic response information + FollowBatchResponse: nullable: true properties: duration: - description: Duration of the request in milliseconds - title: Duration type: string x-stream-index: "002.001" - edges: + follows: + description: List of created follow relationships items: - $ref: '#/components/schemas/EdgeResponse' + $ref: '#/components/schemas/FollowResponse' + title: Follows type: array x-stream-index: "001" required: - - edges + - follows - duration - title: Response + title: Follow Batch Response type: object - GetImportResponse: - description: Basic response information + FollowCreatedEvent: + description: Emitted when a feed follows another feed. nullable: true properties: - duration: - description: Duration of the request in milliseconds - title: Duration + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + feed_visibility: type: string - x-stream-index: "002.001" - import_task: - $ref: '#/components/schemas/ImportTask' + x-stream-index: "002.003" + fid: + type: string + x-stream-index: "002.002" + follow: + $ref: '#/components/schemas/FollowResponse' x-stream-index: "001" + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 + type: + default: feeds.follow.created + description: 'The type of event: "feeds.follow.created" in this case' + title: Event Type + type: string + x-stream-index: 002.001.002 required: - - duration - title: Response + - follow + - type + - created_at + - custom + - fid + title: FollowCreatedEvent type: object - GetManyMessagesResponse: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + FollowDeletedEvent: + description: Emitted when a feed unfollows another feed. nullable: true properties: - duration: + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + feed_visibility: type: string - x-stream-index: 001.002.001 - messages: - description: List of messages - items: - $ref: '#/components/schemas/MessageResponse' - title: Messages - type: array - x-stream-index: "001.001" + x-stream-index: "002.003" + fid: + type: string + x-stream-index: "002.002" + follow: + $ref: '#/components/schemas/FollowResponse' + x-stream-index: "001" + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 + type: + default: feeds.follow.deleted + description: 'The type of event: "feeds.follow.deleted" in this case' + title: Event Type + type: string + x-stream-index: 002.001.002 required: - - messages - - duration + - follow + - type + - created_at + - custom + - fid + title: FollowDeletedEvent type: object - GetMessageResponse: - description: Basic response information - nullable: true + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + FollowPair: properties: - duration: - description: Duration of the request in milliseconds - title: Duration + source: + description: Fully qualified ID of the source feed + maxLength: 255 + title: Source Feed type: string - x-stream-index: "003.001" - message: - $ref: '#/components/schemas/MessageWithChannelResponse' x-stream-index: "001" - pending_message_metadata: - additionalProperties: - type: string - type: object + target: + description: Fully qualified ID of the target feed + maxLength: 255 + title: Target Feed + type: string x-stream-index: "002" required: - - message - - duration - title: Response + - source + - target + title: FollowPair type: object - GetOGResponse: + FollowRequest: nullable: true properties: - actions: - items: - $ref: '#/components/schemas/Action' - type: array - x-stream-index: "001.015" - asset_url: - description: URL of detected video or audio - title: Image URL - type: string - x-stream-index: "001.017" - author_icon: - type: string - x-stream-index: "001.007" - author_link: - description: og:site - title: Author Link + create_notification_activity: + description: Whether to create a notification activity for this follow + title: Create Notification Activity + type: boolean + x-stream-index: "004" + custom: + additionalProperties: {} + description: Custom data for the follow relationship + title: Custom Data + type: object + x-stream-index: "002" + push_preference: + description: Push preference for the follow relationship + enum: + - all + - none + title: Push Preference type: string - x-stream-index: "001.006" - author_name: - description: og:site_name - title: Author Name + x-stream-index: "003" + skip_push: + type: boolean + x-stream-index: "005" + source: + description: Fully qualified ID of the source feed + maxLength: 255 + title: Source Feed type: string - x-stream-index: "001.005" - color: + x-stream-index: "001.001" + target: + description: Fully qualified ID of the target feed + maxLength: 255 + title: Target Feed type: string - x-stream-index: "001.003" + x-stream-index: "001.002" + required: + - source + - target + title: Follow Request + type: object + FollowResponse: + properties: + created_at: + description: When the follow relationship was created + format: date-time + title: Created At + type: number + x-stream-index: "009" custom: additionalProperties: {} + description: Custom data for the follow relationship + title: Custom Data type: object - x-stream-index: "001.018" - duration: + x-stream-index: "004" + follower_role: + description: Role of the follower (source user) in the follow relationship + title: Follower Role type: string - x-stream-index: "002.001" - fallback: + x-stream-index: "008" + push_preference: + description: Push preference for notifications + enum: + - all + - none + title: Push Preference type: string - x-stream-index: "001.002" - fields: - items: - $ref: '#/components/schemas/Field' - type: array - x-stream-index: "001.016" - footer: + x-stream-index: "003" + request_accepted_at: + description: When the follow request was accepted + format: date-time + title: Request Accepted At + type: number + x-stream-index: "005" + request_rejected_at: + description: When the follow request was rejected + format: date-time + title: Request Rejected At + type: number + x-stream-index: "006" + source_feed: + $ref: '#/components/schemas/FeedResponse' + description: Source feed object + title: Source Feed + x-stream-index: "001" + status: + description: Status of the follow relationship + enum: + - accepted + - pending + - rejected + title: Status type: string - x-stream-index: "001.013" - footer_icon: + x-stream-index: "007" + target_feed: + $ref: '#/components/schemas/FeedResponse' + description: Target feed object + title: Target Feed + x-stream-index: "002" + updated_at: + description: When the follow relationship was last updated + format: date-time + title: Updated At + type: number + x-stream-index: "010" + required: + - source_feed + - target_feed + - push_preference + - status + - follower_role + - created_at + - updated_at + title: Follow + type: object + FollowUpdatedEvent: + description: Emitted when a follow relationship is updated. + nullable: true + properties: + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 002.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 002.001.007 + feed_visibility: type: string - x-stream-index: "001.014" - giphy: - $ref: '#/components/schemas/Images' - x-stream-index: "001.019" - image_url: - description: URL of detected image - title: Image URL + x-stream-index: "002.003" + fid: type: string - x-stream-index: "001.011" - og_scrape_url: - description: extracted url from the text - title: OG Scrape URL + x-stream-index: "002.002" + follow: + $ref: '#/components/schemas/FollowResponse' + x-stream-index: "001" + received_at: + format: date-time + type: number + x-stream-index: 002.001.004 + type: + default: feeds.follow.updated + description: 'The type of event: "feeds.follow.updated" in this case' + title: Event Type type: string - x-stream-index: "001.020" - original_height: - format: int32 - type: integer - x-stream-index: "001.022" - original_width: + x-stream-index: 002.001.002 + required: + - follow + - type + - created_at + - custom + - fid + title: FollowUpdatedEvent + 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 + FrameRecordSettings: + properties: + capture_interval_in_seconds: format: int32 + maximum: 60 + minimum: 2 type: integer - x-stream-index: "001.021" - pretext: - type: string - x-stream-index: "001.004" - text: - description: og:description - title: Text - type: string - x-stream-index: "001.010" - thumb_url: - description: URL of detected thumb image - title: Image URL - type: string - x-stream-index: "001.012" - title: - description: og:title - title: Title - type: string - x-stream-index: "001.008" - title_link: - description: og:url - title: Title Link + x-stream-index: "003" + mode: + enum: + - available + - disabled + - auto-on type: string - x-stream-index: "001.009" - type: - description: Attachment type, could be empty, image, audio or video - title: Type + x-stream-index: "001" + quality: type: string - x-stream-index: "001.001" + x-stream-index: "002" required: - - custom - - duration - title: Get OG Attachment + - mode + - capture_interval_in_seconds type: object - x-stream-docs-page-id: og - GetOrCreateCallRequest: - nullable: true + FrameRecordingEgressConfig: properties: - data: - $ref: '#/components/schemas/CallRequest' - title: ReadOnlyData - x-stream-index: "003" - members_limit: + capture_interval_in_seconds: format: int32 - maximum: 100 type: integer x-stream-index: "007" - notify: - description: if provided it sends a notification event to the members for - this call - title: Notify - type: boolean - x-stream-index: "005" - ring: - description: if provided it sends a ring event to the members for this call - title: Ring - type: boolean - x-stream-index: "004" - video: - type: boolean + external_storage: + $ref: '#/components/schemas/ExternalStorage' x-stream-index: "006" - title: GetOrCreateCallRequest + quality: + $ref: '#/components/schemas/Quality' + x-stream-index: "004" + storage_name: + type: string + x-stream-index: "005" type: object - GetOrCreateCallResponse: - nullable: true + FrameRecordingResponse: properties: - call: - $ref: '#/components/schemas/CallResponse' + status: + type: string + x-stream-index: "001" + required: + - status + type: object + FrameRecordingSettingsRequest: + properties: + capture_interval_in_seconds: + format: int32 + maximum: 60 + minimum: 2 + type: integer + x-stream-index: "003" + mode: + enum: + - available + - disabled + - auto-on + type: string + x-stream-index: "001" + quality: + enum: + - 360p + - 480p + - 720p + - 1080p + - 1440p + type: string + x-stream-index: "002" + required: + - mode + - capture_interval_in_seconds + type: object + FrameRecordingSettingsResponse: + properties: + capture_interval_in_seconds: + format: int32 + maximum: 60 + minimum: 2 + type: integer + x-stream-index: "003" + mode: + enum: + - available + - disabled + - auto-on + type: string + x-stream-index: "001" + quality: + type: string + x-stream-index: "002" + required: + - mode + - capture_interval_in_seconds + type: object + FullUserResponse: + properties: + avg_response_time: + format: int32 + type: integer + x-stream-index: "001.018" + ban_expires: + format: date-time + type: number + x-stream-index: "015" + banned: + type: boolean + x-stream-index: "001.012" + blocked_user_ids: + items: + type: string + type: array + x-stream-index: "014" + channel_mutes: + items: + $ref: '#/components/schemas/ChannelMute' + type: array + x-stream-index: "007" + created_at: + format: date-time + type: number + x-stream-index: "001.009" + custom: + additionalProperties: {} + type: object + x-stream-index: "001.004" + deactivated_at: + format: date-time + type: number + x-stream-index: "001.016" + deleted_at: + format: date-time + type: number + x-stream-index: "001.011" + devices: + items: + $ref: '#/components/schemas/DeviceResponse' + type: array + x-stream-index: "004" + id: + type: string x-stream-index: "001.001" - created: + image: + type: string + x-stream-index: "001.003" + invisible: type: boolean - x-stream-index: "002" - duration: + x-stream-index: "005" + language: type: string - x-stream-index: "003.001" - members: + x-stream-index: "001.005" + last_active: + format: date-time + type: number + x-stream-index: "001.014" + latest_hidden_channels: items: - $ref: '#/components/schemas/MemberResponse' + type: string + type: array + x-stream-index: "012" + mutes: + items: + $ref: '#/components/schemas/UserMuteResponse' type: array + x-stream-index: "006" + name: + type: string x-stream-index: "001.002" - own_capabilities: + online: + type: boolean + x-stream-index: "001.013" + privacy_settings: + $ref: '#/components/schemas/PrivacySettingsResponse' + x-stream-index: "003" + revoke_tokens_issued_before: + format: date-time + type: number + x-stream-index: "001.015" + role: + type: string + x-stream-index: "001.006" + shadow_banned: + type: boolean + x-stream-index: "013" + teams: items: - $ref: '#/components/schemas/OwnCapability' + type: string type: array - x-stream-index: "001.004" + x-stream-index: "001.007" + teams_role: + additionalProperties: + type: string + type: object + x-stream-index: "001.008" + total_unread_count: + format: int32 + type: integer + x-stream-index: "009" + unread_channels: + format: int32 + type: integer + x-stream-index: "010" + unread_count: + format: int32 + type: integer + x-stream-index: "008" + unread_threads: + format: int32 + type: integer + x-stream-index: "011" + updated_at: + format: date-time + type: number + x-stream-index: "001.010" required: - - call - - members - - own_capabilities - - blocked_users - - created - - duration - title: GetOrCreateCallResponse + - id + - custom + - language + - role + - teams + - created_at + - updated_at + - banned + - online + - devices + - invisible + - mutes + - channel_mutes + - unread_count + - total_unread_count + - unread_channels + - unread_threads + - shadow_banned + - blocked_user_ids type: object - GetPushTemplatesResponse: - description: Basic response information + GeofenceResponse: nullable: true properties: - duration: - description: Duration of the request in milliseconds - title: Duration - type: string - x-stream-index: "001.001" - templates: + country_codes: items: - $ref: '#/components/schemas/PushTemplate' + type: string type: array + x-stream-index: "004" + description: + type: string + x-stream-index: "003" + name: + type: string + x-stream-index: "001" + type: + type: string x-stream-index: "002" required: - - duration - - templates - title: Response + - name type: object - GetRateLimitsResponse: + GeofenceSettings: + properties: + names: + items: + type: string + type: array + x-stream-index: "001" + required: + - names + type: object + GeofenceSettingsRequest: + properties: + names: + items: + type: string + type: array + x-stream-index: "001" + type: object + GeofenceSettingsResponse: + properties: + names: + items: + type: string + type: array + x-stream-index: "001" + required: + - names + type: object + GetActiveCallsStatusResponse: + description: Response containing active calls status information nullable: true properties: - android: - additionalProperties: - $ref: '#/components/schemas/LimitInfo' - description: Map of endpoint rate limits for the Android platform - title: Android - type: object - x-stream-index: "002" - x-stream-map: - description: The name of the endpoint for which the limits apply - key: endpoint - title: Endpoint name duration: type: string - x-stream-index: "005.001" - ios: - additionalProperties: - $ref: '#/components/schemas/LimitInfo' - description: Map of endpoint rate limits for the iOS platform - title: iOS - type: object + x-stream-index: "001.001" + end_time: + description: End time of the status period + format: date-time + title: time.Time + type: number x-stream-index: "003" - x-stream-map: - description: The name of the endpoint for which the limits apply - key: endpoint - title: Endpoint name - server_side: - additionalProperties: - $ref: '#/components/schemas/LimitInfo' - description: Map of endpoint rate limits for the server-side platform - title: Server-side - type: object - x-stream-index: "001" - x-stream-map: - description: The name of the endpoint for which the limits apply - key: endpoint - title: Endpoint name - web: - additionalProperties: - $ref: '#/components/schemas/LimitInfo' - description: Map of endpoint rate limits for the web platform - title: Web - type: object + metrics: + $ref: '#/components/schemas/ActiveCallsMetrics' + description: Detailed metrics + title: '*ActiveCallsMetrics' + x-stream-index: "005" + start_time: + description: Start time of the status period + format: date-time + title: time.Time + type: number + x-stream-index: "002" + summary: + $ref: '#/components/schemas/ActiveCallsSummary' + description: Summary of active calls + title: '*ActiveCallsSummary' x-stream-index: "004" - x-stream-map: - description: The name of the endpoint for which the limits apply - key: endpoint - title: Endpoint name required: - duration - title: Get Rate Limits Response + - start_time + - end_time + title: GetActiveCallsStatusResponse type: object - x-stream-docs-page-id: rate_limits - GetReactionsResponse: + GetActivityResponse: nullable: true properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + description: The requested activity + title: Activity + x-stream-index: "001" duration: type: string x-stream-index: "002.001" - reactions: - description: List of reactions - items: - $ref: '#/components/schemas/Reaction' - title: Reactions - type: array - x-stream-index: "001" required: - - reactions + - activity - duration + title: Get Activity Response type: object - GetRepliesResponse: + GetApplicationResponse: description: Basic response information nullable: true properties: + app: + $ref: '#/components/schemas/AppResponseFields' + x-stream-index: "001" duration: description: Duration of the request in milliseconds title: Duration type: string x-stream-index: "002.001" - messages: - items: - $ref: '#/components/schemas/MessageResponse' - type: array - x-stream-index: "001" required: - - messages + - app - duration title: Response type: object - GetReviewQueueItemResponse: + GetBlockListResponse: + description: Response for get block list nullable: true properties: + blocklist: + $ref: '#/components/schemas/BlockListResponse' + description: Block list object + title: BlockListResponse + x-stream-index: "001" duration: type: string x-stream-index: "002.001" - item: - $ref: '#/components/schemas/ReviewQueueItemResponse' - description: Current state of the review queue item - title: Item + required: + - duration + title: GetBlockListResponse + type: object + x-stream-docs-page-id: get_block_list + GetBlockedUsersResponse: + nullable: true + properties: + blocks: + description: Array of blocked user object + items: + $ref: '#/components/schemas/BlockedUserResponse' + title: Blocks + type: array x-stream-index: "001" + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "002.001" required: + - blocks - duration type: object - GetSegmentResponse: + GetCallReportResponse: + description: Basic response information nullable: true properties: + chat_activity: + $ref: '#/components/schemas/ChatActivityStatsResponse' + x-stream-index: "004" duration: description: Duration of the request in milliseconds title: Duration + type: string + x-stream-index: "001.001" + report: + $ref: '#/components/schemas/ReportResponse' + x-stream-index: "003" + session_id: + type: string + x-stream-index: "002" + video_reactions: + items: + $ref: '#/components/schemas/VideoReactionsResponse' + type: array + x-stream-index: "005" + required: + - duration + - session_id + - report + title: Response + type: object + GetCallResponse: + nullable: true + properties: + call: + $ref: '#/components/schemas/CallResponse' + x-stream-index: "001.001" + duration: type: string x-stream-index: "002.001" - segment: - $ref: '#/components/schemas/SegmentResponse' - description: Segment - title: SegmentResponse - x-stream-index: "001" + members: + items: + $ref: '#/components/schemas/MemberResponse' + type: array + x-stream-index: "001.002" + own_capabilities: + items: + $ref: '#/components/schemas/OwnCapability' + type: array + x-stream-index: "001.004" required: + - call + - members + - own_capabilities + - blocked_users - duration + title: GetCallResponse type: object - GetTaskResponse: + GetCallTypeResponse: nullable: true properties: created_at: format: date-time type: number - x-stream-index: "001.003" + x-stream-index: "001.005" duration: type: string - x-stream-index: "004.001" - error: - $ref: '#/components/schemas/ErrorResult' - description: Error produced by task - title: Error - x-stream-index: "003" - result: - additionalProperties: {} - description: Result produced by task after completion - title: Result - type: object - x-stream-index: "002" - status: - description: Current status of task - title: Status + x-stream-index: "002.001" + external_storage: type: string + x-stream-index: "001.007" + grants: + additionalProperties: + items: + type: string + type: array + type: object x-stream-index: "001.002" - task_id: - description: ID of task - title: Task ID + name: type: string x-stream-index: "001.001" + notification_settings: + $ref: '#/components/schemas/NotificationSettings' + x-stream-index: "001.004" + settings: + $ref: '#/components/schemas/CallSettingsResponse' + x-stream-index: "001.003" updated_at: format: date-time type: number - x-stream-index: "001.004" + x-stream-index: "001.006" required: - - task_id - - status + - name + - grants + - settings + - notification_settings - created_at - updated_at - duration - title: Get Task Response + title: GetCallTypeResponse type: object - x-stream-docs-page-id: tasks - GetThreadResponse: + GetCampaignResponse: + description: Basic response information nullable: true properties: + campaign: + $ref: '#/components/schemas/CampaignResponse' + x-stream-index: "001" duration: + description: Duration of the request in milliseconds + title: Duration type: string - x-stream-index: "002.001" - thread: - $ref: '#/components/schemas/ThreadStateResponse' - description: Enriched thread state - title: Thread - x-stream-index: "001" + x-stream-index: "003.001" + users: + $ref: '#/components/schemas/PagerResponse' + x-stream-index: "002" required: - - thread - duration + title: Response type: object - GoLiveRequest: + GetChannelTypeResponse: + description: Basic response information nullable: true properties: - recording_storage_name: + allowed_flag_reasons: + items: + type: string + type: array + x-stream-index: 003.002.027 + automod: + enum: + - disabled + - simple + - AI type: string - x-stream-index: "005" - start_closed_caption: - type: boolean - x-stream-index: "008" - start_hls: + x-stream-index: 003.002.022 + automod_behavior: + enum: + - flag + - block + - shadow_block + type: string + x-stream-index: 003.002.023 + automod_thresholds: + $ref: '#/components/schemas/Thresholds' + x-stream-index: 003.002.028 + blocklist: + type: string + x-stream-index: 003.002.024 + blocklist_behavior: + enum: + - flag + - block + - shadow_block + type: string + x-stream-index: 003.002.025 + blocklists: + items: + $ref: '#/components/schemas/BlockListOptions' + type: array + x-stream-index: 003.002.026 + commands: + items: + $ref: '#/components/schemas/Command' + type: array + x-stream-index: "003.003" + connect_events: type: boolean - x-stream-index: "003" - start_recording: + x-stream-index: 003.002.004 + count_messages: type: boolean - x-stream-index: "004" - start_transcription: + x-stream-index: 003.002.019 + created_at: + format: date-time + type: number + x-stream-index: 003.001.003 + custom_events: type: boolean - x-stream-index: "007" - transcription_storage_name: - type: string - x-stream-index: "006" - title: GoLiveRequest - type: object - GoLiveResponse: - description: Basic response information - nullable: true - properties: - call: - $ref: '#/components/schemas/CallResponse' - x-stream-index: "001" + x-stream-index: 003.002.012 duration: description: Duration of the request in milliseconds title: Duration type: string - x-stream-index: "002.001" + x-stream-index: "004.001" + grants: + additionalProperties: + items: + type: string + type: array + type: object + x-stream-index: "002" + mark_messages_pending: + type: boolean + x-stream-index: 003.002.015 + max_message_length: + format: int32 + maximum: 20000 + type: integer + x-stream-index: 003.002.021 + mutes: + type: boolean + x-stream-index: 003.002.009 + name: + type: string + x-stream-index: 003.002.001 + partition_size: + format: int32 + type: integer + x-stream-index: 003.002.029 + partition_ttl: + example: 24h + format: duration + nullable: true + type: string + x-stream-index: 003.002.030 + permissions: + items: + $ref: '#/components/schemas/PolicyRequest' + type: array + x-stream-index: "001" + polls: + type: boolean + x-stream-index: 003.002.016 + push_notifications: + type: boolean + x-stream-index: 003.002.013 + quotes: + type: boolean + x-stream-index: 003.002.008 + reactions: + type: boolean + x-stream-index: 003.002.006 + read_events: + type: boolean + x-stream-index: 003.002.003 + reminders: + type: boolean + x-stream-index: 003.002.014 + replies: + type: boolean + x-stream-index: 003.002.007 + search: + type: boolean + x-stream-index: 003.002.005 + shared_locations: + type: boolean + x-stream-index: 003.002.018 + skip_last_msg_update_for_system_msgs: + type: boolean + x-stream-index: 003.002.031 + typing_events: + type: boolean + x-stream-index: 003.002.002 + updated_at: + format: date-time + type: number + x-stream-index: 003.001.004 + uploads: + type: boolean + x-stream-index: 003.002.010 + url_enrichment: + type: boolean + x-stream-index: 003.002.011 + user_message_reminders: + type: boolean + x-stream-index: 003.002.017 required: - - call + - permissions + - grants + - created_at + - updated_at + - name + - typing_events + - read_events + - connect_events + - search + - reactions + - replies + - quotes + - mutes + - uploads + - url_enrichment + - custom_events + - push_notifications + - reminders + - mark_messages_pending + - polls + - user_message_reminders + - shared_locations + - count_messages + - message_retention + - max_message_length + - automod + - automod_behavior + - skip_last_msg_update_for_system_msgs + - commands - duration title: Response type: object - GoogleVisionConfig: - properties: - enabled: - type: boolean - x-stream-index: "001" - type: object - GroupedStatsResponse: + GetCommandResponse: nullable: true properties: + args: + type: string + x-stream-index: "001.006" + created_at: + format: date-time + readOnly: true + type: number + x-stream-index: "001.001" + description: + type: string + x-stream-index: "001.005" + duration: + type: string + x-stream-index: "002.001" name: type: string - x-stream-index: "001" - unique: - format: int32 - type: integer - x-stream-index: "002" + x-stream-index: "001.004" + set: + type: string + x-stream-index: "001.007" + updated_at: + format: date-time + readOnly: true + type: number + x-stream-index: "001.002" required: - name - - unique + - description + - args + - set + - duration + title: GetCommandResponse type: object - HLSEgressConfig: + GetCommentRepliesResponse: + nullable: true properties: - composite_app_settings: - $ref: '#/components/schemas/CompositeAppSettings' - x-stream-index: "005" - playlist_url: - type: string - x-stream-index: "007" - qualities: + comments: + description: Threaded listing of replies to the comment items: - $ref: '#/components/schemas/Quality' + $ref: '#/components/schemas/ThreadedCommentResponse' + title: Comments type: array - x-stream-index: "004" - start_unix_nano: - format: int64 - type: integer - x-stream-index: "006" + x-stream-index: "001" + duration: + type: string + x-stream-index: "003.001" + next: + type: string + x-stream-index: "002.001" + prev: + type: string + x-stream-index: "002.002" + required: + - comments + - duration + title: Get Comment Replies Response type: object - HLSSettings: + GetCommentResponse: + nullable: true properties: - auto_on: - type: boolean + comment: + $ref: '#/components/schemas/CommentResponse' + description: Comment + title: Comment x-stream-index: "001" - enabled: - type: boolean - x-stream-index: "002" - layout: - $ref: '#/components/schemas/LayoutSettings' - x-stream-index: "004" - quality_tracks: - items: - type: string - type: array - x-stream-index: "003" + duration: + type: string + x-stream-index: "002.001" required: - - auto_on - - enabled - - quality_tracks + - comment + - duration + title: Get Comment Response type: object - HLSSettingsRequest: + GetCommentsResponse: + nullable: true properties: - auto_on: - type: boolean - x-stream-index: "001" - enabled: - type: boolean - x-stream-index: "002" - layout: - $ref: '#/components/schemas/LayoutSettingsRequest' - title: LayoutSettings - x-stream-index: "004" - quality_tracks: + comments: + description: Threaded listing for the activity items: - type: string - maximum: 3 - minimum: 1 + $ref: '#/components/schemas/ThreadedCommentResponse' + title: Comments type: array - x-stream-index: "003" + x-stream-index: "001" + duration: + type: string + x-stream-index: "003.001" + next: + type: string + x-stream-index: "002.001" + prev: + type: string + x-stream-index: "002.002" required: - - quality_tracks - title: HLSSettingsRequest + - comments + - duration + title: Get Comments Response type: object - HLSSettingsResponse: - description: HLSSettings is the payload for HLS settings + GetConfigResponse: + nullable: true properties: - auto_on: - title: Auto On - type: boolean + config: + $ref: '#/components/schemas/ConfigResponse' + description: The retrieved moderation configuration + title: Config x-stream-index: "001" - enabled: - title: Enabled - type: boolean - x-stream-index: "002" - layout: - $ref: '#/components/schemas/LayoutSettingsResponse' - title: Layout - x-stream-index: "004" - quality_tracks: - items: - type: string - title: Quality Tracks - type: array - x-stream-index: "003" + duration: + type: string + x-stream-index: "002.001" required: - - auto_on - - enabled - - quality_tracks - - layout - title: HLSSettingsResponse + - duration type: object - HarmConfig: + GetCustomPermissionResponse: + description: Basic response information + nullable: true properties: - action_sequences: - items: - $ref: '#/components/schemas/ActionSequence' - type: array + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "002.001" + permission: + $ref: '#/components/schemas/Permission' x-stream-index: "001" - severity: - type: integer - x-stream-index: "002" required: - - action_sequences - - severity + - permission + - duration + title: Response type: object - HideChannelRequest: + GetDraftResponse: + description: Basic response information nullable: true properties: - clear_history: - description: Whether to clear message history of the channel or not - title: Clear history - type: boolean + draft: + $ref: '#/components/schemas/DraftResponse' x-stream-index: "001" - user: - $ref: '#/components/schemas/UserRequest' - x-stream-index: "003.002" - user_id: + duration: + description: Duration of the request in milliseconds + title: Duration type: string - x-stream-index: "003.001" + x-stream-index: "002.001" + required: + - draft + - duration + title: Response type: object - HideChannelResponse: + GetEdgesResponse: description: Basic response information nullable: true properties: @@ -11833,2230 +15653,2650 @@ components: description: Duration of the request in milliseconds title: Duration type: string - x-stream-index: "001.001" + x-stream-index: "002.001" + edges: + items: + $ref: '#/components/schemas/EdgeResponse' + type: array + x-stream-index: "001" required: + - edges - duration title: Response type: object - HuaweiConfig: + GetFeedGroupResponse: + nullable: true properties: - Disabled: - type: boolean - writeOnly: true - x-stream-index: "003" - id: + duration: type: string + x-stream-index: "002.001" + feed_group: + $ref: '#/components/schemas/FeedGroupResponse' + description: The requested feed group + title: Feed Group x-stream-index: "001" - secret: - type: string - x-stream-index: "002" + required: + - feed_group + - duration + title: Get Feed Group Response type: object - HuaweiConfigFields: + GetFeedViewResponse: + nullable: true properties: - enabled: - type: boolean - x-stream-index: "001" - id: - type: string - x-stream-index: "002" - secret: + duration: type: string - x-stream-index: "003" + x-stream-index: "002.001" + feed_view: + $ref: '#/components/schemas/FeedViewResponse' + description: The requested feed view + title: Feed View + x-stream-index: "001" required: - - enabled + - feed_view + - duration + title: Get Feed View Response type: object - ImageContentParameters: + GetFollowSuggestionsResponse: + nullable: true properties: - harm_labels: + duration: + type: string + x-stream-index: "002.001" + suggestions: + description: List of suggested feeds to follow items: - type: string + $ref: '#/components/schemas/FeedResponse' + title: Suggestions type: array x-stream-index: "001" + required: + - suggestions + - duration + title: Follow Suggestions Response type: object - ImageData: + GetImportResponse: + description: Basic response information + nullable: true properties: - frames: - type: string - x-stream-index: "005" - height: - type: string - x-stream-index: "003" - size: - type: string - x-stream-index: "004" - url: + duration: + description: Duration of the request in milliseconds + title: Duration type: string + x-stream-index: "002.001" + import_task: + $ref: '#/components/schemas/ImportTask' x-stream-index: "001" - width: - type: string - x-stream-index: "002" required: - - url - - width - - height - - size - - frames + - duration + title: Response type: object - ImageRuleParameters: + GetManyMessagesResponse: + nullable: true properties: - harm_labels: + duration: + type: string + x-stream-index: 001.002.001 + messages: + description: List of messages items: - type: string + $ref: '#/components/schemas/MessageResponse' + title: Messages type: array - x-stream-index: "003" - threshold: - format: int32 - type: integer - x-stream-index: "001" - time_window: - type: string - x-stream-index: "002" + x-stream-index: "001.001" required: - - threshold - - time_window + - messages + - duration type: object - ImageSize: + GetMessageResponse: + description: Basic response information + nullable: true properties: - crop: - description: Crop mode - enum: - - top - - bottom - - left - - right - - center - title: Crop + duration: + description: Duration of the request in milliseconds + title: Duration type: string + x-stream-index: "003.001" + message: + $ref: '#/components/schemas/MessageWithChannelResponse' x-stream-index: "001" - height: - description: Target image height - format: int32 - title: Height - type: integer - x-stream-index: "003" - resize: - description: Resize method - enum: - - clip - - crop - - scale - - fill - title: Resize - type: string + pending_message_metadata: + additionalProperties: + type: string + type: object x-stream-index: "002" - width: - description: Target image width - format: int32 - title: Width - type: integer - x-stream-index: "004" - title: Image size configuration + required: + - message + - duration + title: Response type: object - ImageUploadRequest: + GetModerationRuleResponse: + description: Basic response information nullable: true properties: - file: + duration: + description: Duration of the request in milliseconds + title: Duration type: string x-stream-index: "001.001" - upload_sizes: - description: field with JSON-encoded array of image size configurations - items: - $ref: '#/components/schemas/ImageSize' - title: Upload sizes - type: array + rule: + $ref: '#/components/schemas/ModerationRuleV2Response' x-stream-index: "002" - user: - $ref: '#/components/schemas/OnlyUserID' - x-stream-index: "001.002" + required: + - duration + title: Response type: object - ImageUploadResponse: + GetOGResponse: nullable: true properties: - duration: - description: Duration of the request in milliseconds - title: Duration + actions: + items: + $ref: '#/components/schemas/Action' + type: array + x-stream-index: "001.015" + asset_url: + description: URL of detected video or audio + title: Image URL type: string - x-stream-index: 001.003.001 - file: + x-stream-index: "001.017" + author_icon: type: string - x-stream-index: "001.001" - thumb_url: + x-stream-index: "001.007" + author_link: + description: og:site + title: Author Link + type: string + x-stream-index: "001.006" + author_name: + description: og:site_name + title: Author Name + type: string + x-stream-index: "001.005" + color: + type: string + x-stream-index: "001.003" + custom: + additionalProperties: {} + type: object + x-stream-index: "001.018" + duration: + type: string + x-stream-index: "002.001" + fallback: type: string x-stream-index: "001.002" - upload_sizes: - description: Array of image size configurations + fields: items: - $ref: '#/components/schemas/ImageSize' - title: Upload sizes + $ref: '#/components/schemas/Field' type: array - x-stream-index: "002" + x-stream-index: "001.016" + footer: + type: string + x-stream-index: "001.013" + footer_icon: + type: string + x-stream-index: "001.014" + giphy: + $ref: '#/components/schemas/Images' + x-stream-index: "001.019" + image_url: + description: URL of detected image + title: Image URL + type: string + x-stream-index: "001.011" + og_scrape_url: + description: extracted url from the text + title: OG Scrape URL + type: string + x-stream-index: "001.020" + original_height: + format: int32 + type: integer + x-stream-index: "001.022" + original_width: + format: int32 + type: integer + x-stream-index: "001.021" + pretext: + type: string + x-stream-index: "001.004" + text: + description: og:description + title: Text + type: string + x-stream-index: "001.010" + thumb_url: + description: URL of detected thumb image + title: Image URL + type: string + x-stream-index: "001.012" + title: + description: og:title + title: Title + type: string + x-stream-index: "001.008" + title_link: + description: og:url + title: Title Link + type: string + x-stream-index: "001.009" + type: + description: Attachment type, could be empty, image, audio or video + title: Type + type: string + x-stream-index: "001.001" required: + - custom - duration + title: Get OG Attachment type: object - Images: + x-stream-docs-page-id: og + GetOrCreateCallRequest: + nullable: true properties: - fixed_height: - $ref: '#/components/schemas/ImageData' - x-stream-index: "002" - fixed_height_downsampled: - $ref: '#/components/schemas/ImageData' - x-stream-index: "004" - fixed_height_still: - $ref: '#/components/schemas/ImageData' + data: + $ref: '#/components/schemas/CallRequest' + title: ReadOnlyData x-stream-index: "003" - fixed_width: - $ref: '#/components/schemas/ImageData' - x-stream-index: "005" - fixed_width_downsampled: - $ref: '#/components/schemas/ImageData' + members_limit: + format: int32 + maximum: 100 + type: integer x-stream-index: "007" - fixed_width_still: - $ref: '#/components/schemas/ImageData' + notify: + description: if provided it sends a notification event to the members for + this call + title: Notify + type: boolean + x-stream-index: "005" + ring: + description: if provided it sends a ring event to the members for this call + title: Ring + type: boolean + x-stream-index: "004" + video: + type: boolean x-stream-index: "006" - original: - $ref: '#/components/schemas/ImageData' - x-stream-index: "001" - required: - - original - - fixed_height - - fixed_height_still - - fixed_height_downsampled - - fixed_width - - fixed_width_still - - fixed_width_downsampled + title: GetOrCreateCallRequest type: object - ImportTask: + GetOrCreateCallResponse: + nullable: true properties: - created_at: - format: date-time - type: number - x-stream-index: "011" - history: + call: + $ref: '#/components/schemas/CallResponse' + x-stream-index: "001.001" + created: + type: boolean + x-stream-index: "002" + duration: + type: string + x-stream-index: "003.001" + members: items: - $ref: '#/components/schemas/ImportTaskHistory' + $ref: '#/components/schemas/MemberResponse' type: array - x-stream-index: "010" - id: - type: string - x-stream-index: "003" - mode: - type: string - x-stream-index: "006" - path: - type: string - x-stream-index: "005" - size: - format: int64 - type: integer - x-stream-index: "007" - state: - type: string - x-stream-index: "008" - updated_at: - format: date-time - type: number - x-stream-index: "012" + x-stream-index: "001.002" + own_capabilities: + items: + $ref: '#/components/schemas/OwnCapability' + type: array + x-stream-index: "001.004" required: - - id - - path - - mode - - state - - history - - created_at - - updated_at + - call + - members + - own_capabilities + - blocked_users + - created + - duration + title: GetOrCreateCallResponse type: object - ImportTaskHistory: + GetOrCreateFeedGroupRequest: nullable: true properties: - created_at: - format: date-time - type: number - x-stream-index: "007" - next_state: - type: string + activity_processors: + description: Configuration for activity processors (max 10) + items: + $ref: '#/components/schemas/ActivityProcessorConfig' + maximum: 10 + title: Activity Processors + type: array x-stream-index: "006" - prev_state: + activity_selectors: + description: Configuration for activity selectors (max 10) + items: + $ref: '#/components/schemas/ActivitySelectorConfig' + maximum: 10 + title: Activity Selectors + type: array + x-stream-index: "007" + aggregation: + $ref: '#/components/schemas/AggregationConfig' + description: Configuration for activity aggregation + title: Aggregation + x-stream-index: "009" + custom: + additionalProperties: {} + description: Custom data for the feed group + title: Custom Data + type: object + x-stream-index: "004" + default_visibility: + description: 'Default visibility for the feed group, can be ''public'', + ''visible'', ''followers'', ''members'', or ''private''. Defaults to ''visible'' + if not provided. ' + enum: + - public + - visible + - followers + - members + - private + title: Default Visibility type: string x-stream-index: "005" - required: - - prev_state - - next_state - - created_at + notification: + $ref: '#/components/schemas/NotificationConfig' + description: Configuration for notifications + title: Notification + x-stream-index: "002" + push_notification: + $ref: '#/components/schemas/PushNotificationConfig' + x-stream-index: "003" + ranking: + $ref: '#/components/schemas/RankingConfig' + description: Configuration for activity ranking + title: Ranking + x-stream-index: "008" + title: Get Or Create Feed Group Request type: object - IngressAudioEncodingOptions: + GetOrCreateFeedGroupResponse: + nullable: true properties: - bitrate: - maximum: 128000 - minimum: 16000 - type: integer - x-stream-index: "003" - channels: - enum: - - "1" - - "2" - format: int32 - type: integer + duration: + type: string + x-stream-index: "003.001" + feed_group: + $ref: '#/components/schemas/FeedGroupResponse' + description: The feed group that was retrieved or created + title: Feed Group x-stream-index: "001" - enable_dtx: + was_created: + description: Indicates whether the feed group was created (true) or already + existed (false) + title: Was Created type: boolean x-stream-index: "002" required: - - channels - - enable_dtx - - bitrate + - feed_group + - was_created + - duration + title: Get Or Create Feed Group Response type: object - IngressAudioEncodingOptionsRequest: + GetOrCreateFeedRequest: + description: Client request + nullable: true properties: - bitrate: - maximum: 128000 - minimum: 16000 - type: integer + activity_selector_options: + additionalProperties: {} + type: object + x-stream-index: "006" + data: + $ref: '#/components/schemas/FeedInput' x-stream-index: "003" - channels: - enum: - - "1" - - "2" + external_ranking: + additionalProperties: {} + type: object + x-stream-index: "007" + filter: + additionalProperties: {} + type: object + x-stream-index: "009" + followers_pagination: + $ref: '#/components/schemas/PagerRequest' + x-stream-index: "011" + following_pagination: + $ref: '#/components/schemas/PagerRequest' + x-stream-index: "012" + interest_weights: + additionalProperties: + format: float + type: number + type: object + x-stream-index: "008" + limit: format: int32 + maximum: 100 + minimum: 0 type: integer - x-stream-index: "001" - enable_dtx: + x-stream-index: "013.001" + member_pagination: + $ref: '#/components/schemas/PagerRequest' + x-stream-index: "010" + next: + type: string + x-stream-index: "013.002" + prev: + type: string + x-stream-index: "013.003" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "014.002" + user_id: + type: string + x-stream-index: "014.001" + view: + type: string + x-stream-index: "005" + watch: type: boolean + x-stream-index: "004" + title: ClientRequest + type: object + GetOrCreateFeedResponse: + description: Basic response information + nullable: true + properties: + activities: + items: + $ref: '#/components/schemas/ActivityResponse' + type: array x-stream-index: "002" + aggregated_activities: + items: + $ref: '#/components/schemas/AggregatedActivityResponse' + type: array + x-stream-index: "003" + created: + type: boolean + x-stream-index: "015" + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "017.001" + feed: + $ref: '#/components/schemas/FeedResponse' + x-stream-index: "001" + followers: + items: + $ref: '#/components/schemas/FollowResponse' + type: array + x-stream-index: "005" + followers_pagination: + $ref: '#/components/schemas/PagerResponse' + x-stream-index: "012" + following: + items: + $ref: '#/components/schemas/FollowResponse' + type: array + x-stream-index: "006" + following_pagination: + $ref: '#/components/schemas/PagerResponse' + x-stream-index: "013" + member_pagination: + $ref: '#/components/schemas/PagerResponse' + x-stream-index: "011" + members: + items: + $ref: '#/components/schemas/FeedMemberResponse' + type: array + x-stream-index: "004" + next: + type: string + x-stream-index: "016.001" + notification_status: + $ref: '#/components/schemas/NotificationStatusResponse' + x-stream-index: "014" + own_capabilities: + items: + $ref: '#/components/schemas/FeedOwnCapability' + type: array + x-stream-index: "008" + own_follows: + items: + $ref: '#/components/schemas/FollowResponse' + type: array + x-stream-index: "009" + own_membership: + $ref: '#/components/schemas/FeedMemberResponse' + x-stream-index: "010" + pinned_activities: + items: + $ref: '#/components/schemas/ActivityPinResponse' + type: array + x-stream-index: "007" + prev: + type: string + x-stream-index: "016.002" required: - - channels - - bitrate + - feed + - activities + - aggregated_activities + - members + - followers + - following + - pinned_activities + - own_capabilities + - created + - duration + title: Response type: object - IngressAudioEncodingResponse: + GetOrCreateFeedViewRequest: + nullable: true properties: - bitrate: - format: int32 - type: integer - x-stream-index: "003" - channels: - format: int32 - type: integer + activity_processors: + description: Configured activity Processors + items: + $ref: '#/components/schemas/ActivityProcessorConfig' + title: Activity Processors + type: array + x-stream-index: "002.002" + activity_selectors: + description: Configuration for selecting activities + items: + $ref: '#/components/schemas/ActivitySelectorConfig' + title: Activity Selectors + type: array + x-stream-index: "002.001" + aggregation: + $ref: '#/components/schemas/AggregationConfig' + description: Configuration for aggregating activities + title: Aggregation + x-stream-index: "002.004" + ranking: + $ref: '#/components/schemas/RankingConfig' + description: Configuration for ranking activities + title: Ranking + x-stream-index: "002.003" + title: Get Or Create Feed View Request + type: object + GetOrCreateFeedViewResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "003.001" + feed_view: + $ref: '#/components/schemas/FeedViewResponse' + description: The feed view (either existing or newly created) + title: Feed View x-stream-index: "001" - enable_dtx: + was_created: + description: Indicates whether the feed view was newly created (true) or + already existed (false) + title: Was Created type: boolean x-stream-index: "002" required: - - channels - - enable_dtx - - bitrate + - feed_view + - was_created + - duration + title: Get Or Create Feed View Response type: object - IngressSettings: + GetPushTemplatesResponse: + description: Basic response information + nullable: true properties: - audio_encoding_options: - $ref: '#/components/schemas/IngressAudioEncodingOptions' + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "001.001" + templates: + items: + $ref: '#/components/schemas/PushTemplate' + type: array x-stream-index: "002" - enabled: - type: boolean - x-stream-index: "001" - video_encoding_options: - additionalProperties: - $ref: '#/components/schemas/IngressVideoEncodingOptions' - type: object - x-stream-index: "003" required: - - enabled + - duration + - templates + title: Response type: object - IngressSettingsRequest: + GetRateLimitsResponse: + nullable: true properties: - audio_encoding_options: - $ref: '#/components/schemas/IngressAudioEncodingOptionsRequest' - x-stream-index: "002" - enabled: - type: boolean - x-stream-index: "001" - video_encoding_options: + android: additionalProperties: - $ref: '#/components/schemas/IngressVideoEncodingOptionsRequest' + $ref: '#/components/schemas/LimitInfo' + description: Map of endpoint rate limits for the Android platform + title: Android type: object - x-stream-index: "003" - type: object - IngressSettingsResponse: - properties: - audio_encoding_options: - $ref: '#/components/schemas/IngressAudioEncodingResponse' x-stream-index: "002" - enabled: - type: boolean - x-stream-index: "001" - video_encoding_options: + x-stream-map: + description: The name of the endpoint for which the limits apply + key: endpoint + title: Endpoint name + duration: + type: string + x-stream-index: "005.001" + ios: additionalProperties: - $ref: '#/components/schemas/IngressVideoEncodingResponse' + $ref: '#/components/schemas/LimitInfo' + description: Map of endpoint rate limits for the iOS platform + title: iOS type: object x-stream-index: "003" - required: - - enabled - type: object - IngressVideoEncodingOptions: - properties: - layers: - items: - $ref: '#/components/schemas/IngressVideoLayer' - minimum: 1 - type: array + x-stream-map: + description: The name of the endpoint for which the limits apply + key: endpoint + title: Endpoint name + server_side: + additionalProperties: + $ref: '#/components/schemas/LimitInfo' + description: Map of endpoint rate limits for the server-side platform + title: Server-side + type: object x-stream-index: "001" + x-stream-map: + description: The name of the endpoint for which the limits apply + key: endpoint + title: Endpoint name + web: + additionalProperties: + $ref: '#/components/schemas/LimitInfo' + description: Map of endpoint rate limits for the web platform + title: Web + type: object + x-stream-index: "004" + x-stream-map: + description: The name of the endpoint for which the limits apply + key: endpoint + title: Endpoint name required: - - layers + - duration + title: Get Rate Limits Response type: object - IngressVideoEncodingOptionsRequest: + x-stream-docs-page-id: rate_limits + GetReactionsResponse: + nullable: true properties: - layers: + duration: + type: string + x-stream-index: "002.001" + reactions: + description: List of reactions items: - $ref: '#/components/schemas/IngressVideoLayerRequest' - minimum: 1 + $ref: '#/components/schemas/Reaction' + title: Reactions type: array x-stream-index: "001" required: - - layers + - reactions + - duration type: object - IngressVideoEncodingResponse: + GetRepliesResponse: + description: Basic response information + nullable: true properties: - layers: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "002.001" + messages: items: - $ref: '#/components/schemas/IngressVideoLayerResponse' + $ref: '#/components/schemas/MessageResponse' type: array x-stream-index: "001" required: - - layers + - messages + - duration + title: Response type: object - IngressVideoLayer: + GetReviewQueueItemResponse: nullable: true properties: - bitrate: - minimum: 1000 - type: integer - x-stream-index: "002" - codec: - enum: - - h264 - - vp8 + duration: type: string + x-stream-index: "002.001" + item: + $ref: '#/components/schemas/ReviewQueueItemResponse' + description: Current state of the review queue item + title: Item x-stream-index: "001" - frame_rate: - maximum: 60 - minimum: 1 - type: integer - x-stream-index: "003" - max_dimension: - minimum: 240 - type: integer - x-stream-index: "005" - min_dimension: - minimum: 240 - type: integer - x-stream-index: "004" required: - - codec - - bitrate - - frame_rate - - min_dimension - - max_dimension + - duration type: object - IngressVideoLayerRequest: + GetSegmentResponse: nullable: true properties: - bitrate: - format: int32 - minimum: 1000 - type: integer - x-stream-index: "002" - codec: - enum: - - h264 - - vp8 + duration: + description: Duration of the request in milliseconds + title: Duration type: string + x-stream-index: "002.001" + segment: + $ref: '#/components/schemas/SegmentResponse' + description: Segment + title: SegmentResponse x-stream-index: "001" - frame_rate_limit: - maximum: 60 - minimum: 1 - type: integer - x-stream-index: "005" - max_dimension: - minimum: 240 - type: integer - x-stream-index: "004" - min_dimension: - minimum: 240 - type: integer - x-stream-index: "003" required: - - codec - - bitrate - - min_dimension - - max_dimension - - frame_rate_limit + - duration type: object - IngressVideoLayerResponse: + GetTaskResponse: nullable: true properties: - bitrate: - type: integer - x-stream-index: "002" - codec: + created_at: + format: date-time + type: number + x-stream-index: "001.003" + duration: type: string - x-stream-index: "001" - frame_rate_limit: - type: integer - x-stream-index: "005" - max_dimension: - type: integer - x-stream-index: "004" - min_dimension: - type: integer + x-stream-index: "004.001" + error: + $ref: '#/components/schemas/ErrorResult' + description: Error produced by task + title: Error x-stream-index: "003" - required: - - codec - - bitrate - - min_dimension - - max_dimension - - frame_rate_limit - type: object - JoinCallAPIMetrics: - properties: - failures: - format: float - type: number + result: + additionalProperties: {} + description: Result produced by task after completion + title: Result + type: object x-stream-index: "002" - latency: - $ref: '#/components/schemas/ActiveCallsLatencyStats' - x-stream-index: "003" - total: - format: float + status: + description: Current status of task + title: Status + type: string + x-stream-index: "001.002" + task_id: + description: ID of task + title: Task ID + type: string + x-stream-index: "001.001" + updated_at: + format: date-time type: number - x-stream-index: "001" + x-stream-index: "001.004" required: - - total - - failures + - task_id + - status + - created_at + - updated_at + - duration + title: Get Task Response type: object - Label: + x-stream-docs-page-id: tasks + GetThreadResponse: + nullable: true properties: - harm_labels: - items: - type: string - type: array - x-stream-index: "003" - name: + duration: type: string + x-stream-index: "002.001" + thread: + $ref: '#/components/schemas/ThreadStateResponse' + description: Enriched thread state + title: Thread x-stream-index: "001" - phrase_list_ids: - items: - format: int32 - type: integer - type: array - x-stream-index: "002" required: - - name - type: object - LabelThresholds: - properties: - block: - description: Threshold for automatic message block - format: float - maximum: 1 - minimum: 0 - title: Block - type: number - x-stream-index: "002" - flag: - description: Threshold for automatic message flag - format: float - maximum: 1 - minimum: 0 - title: Flag - type: number - x-stream-index: "001" + - thread + - duration type: object - LayoutSettings: + GoLiveRequest: + nullable: true properties: - detect_orientation: - type: boolean - x-stream-index: "005" - external_app_url: + recording_storage_name: type: string + x-stream-index: "005" + start_closed_caption: + type: boolean + x-stream-index: "008" + start_hls: + type: boolean x-stream-index: "003" - external_css_url: - type: string + start_recording: + type: boolean x-stream-index: "004" - name: - enum: - - spotlight - - grid - - single-participant - - mobile - - custom + start_transcription: + type: boolean + x-stream-index: "007" + transcription_storage_name: type: string + x-stream-index: "006" + title: GoLiveRequest + type: object + GoLiveResponse: + description: Basic response information + nullable: true + properties: + call: + $ref: '#/components/schemas/CallResponse' x-stream-index: "001" - options: - additionalProperties: {} - type: object - x-stream-index: "002" + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "002.001" required: - - name - - external_app_url - - external_css_url + - call + - duration + title: Response type: object - LayoutSettingsRequest: + GoogleVisionConfig: properties: - detect_orientation: + enabled: type: boolean - x-stream-index: "005" - external_app_url: - type: string - x-stream-index: "003" - external_css_url: - type: string - x-stream-index: "004" - name: - enum: - - spotlight - - grid - - single-participant - - mobile - - custom - type: string x-stream-index: "001" - options: - additionalProperties: {} - type: object - x-stream-index: "002" - required: - - name type: object - LayoutSettingsResponse: + GroupedStatsResponse: + nullable: true properties: - detect_orientation: - type: boolean - x-stream-index: "005" - external_app_url: - type: string - x-stream-index: "003" - external_css_url: - type: string - x-stream-index: "004" name: - enum: - - spotlight - - grid - - single-participant - - mobile - - custom type: string x-stream-index: "001" - options: - additionalProperties: {} - type: object + unique: + format: int32 + type: integer x-stream-index: "002" required: - name - - external_app_url - - external_css_url + - unique type: object - LimitInfo: + HLSEgressConfig: properties: - limit: - description: The maximum number of calls allowed for the time window - format: int32 - title: Limit - type: integer - x-stream-index: "001" - remaining: - description: The number of remaining calls in the current window - format: int64 - title: Remaining - type: integer - x-stream-index: "002" - reset: - description: The Unix timestamp of the next window + composite_app_settings: + $ref: '#/components/schemas/CompositeAppSettings' + x-stream-index: "005" + playlist_url: + type: string + x-stream-index: "007" + qualities: + items: + $ref: '#/components/schemas/Quality' + type: array + x-stream-index: "004" + start_unix_nano: format: int64 - title: Reset type: integer - x-stream-index: "003" - required: - - limit - - remaining - - reset - title: Rate Limit info + x-stream-index: "006" type: object - x-stream-docs-page-id: rate_limits - LimitsSettings: + HLSSettings: properties: - max_duration_seconds: - format: int32 - type: integer - x-stream-index: "004" - max_participants: - format: int32 - type: integer + auto_on: + type: boolean x-stream-index: "001" - max_participants_exclude_owner: + enabled: type: boolean - x-stream-index: "003" - max_participants_exclude_roles: + x-stream-index: "002" + layout: + $ref: '#/components/schemas/LayoutSettings' + x-stream-index: "004" + quality_tracks: items: type: string type: array - x-stream-index: "002" + x-stream-index: "003" required: - - max_participants_exclude_roles + - auto_on + - enabled + - quality_tracks type: object - LimitsSettingsRequest: + HLSSettingsRequest: properties: - max_duration_seconds: - format: int32 - minimum: 0 - type: integer - x-stream-index: "004" - max_participants: - format: int32 - type: integer + auto_on: + type: boolean x-stream-index: "001" - max_participants_exclude_owner: + enabled: type: boolean - x-stream-index: "003" - max_participants_exclude_roles: + x-stream-index: "002" + layout: + $ref: '#/components/schemas/LayoutSettingsRequest' + title: LayoutSettings + x-stream-index: "004" + quality_tracks: items: type: string + maximum: 3 + minimum: 1 type: array - x-stream-index: "002" + x-stream-index: "003" + required: + - quality_tracks + title: HLSSettingsRequest type: object - LimitsSettingsResponse: + HLSSettingsResponse: + description: HLSSettings is the payload for HLS settings properties: - max_duration_seconds: - format: int32 - type: integer - x-stream-index: "004" - max_participants: - format: int32 - type: integer + auto_on: + title: Auto On + type: boolean x-stream-index: "001" - max_participants_exclude_owner: + enabled: + title: Enabled type: boolean - x-stream-index: "003" - max_participants_exclude_roles: + x-stream-index: "002" + layout: + $ref: '#/components/schemas/LayoutSettingsResponse' + title: Layout + x-stream-index: "004" + quality_tracks: items: type: string + title: Quality Tracks type: array - x-stream-index: "002" + x-stream-index: "003" required: - - max_participants_exclude_roles + - auto_on + - enabled + - quality_tracks + - layout + title: HLSSettingsResponse type: object - ListBlockListResponse: - description: Basic response information - nullable: true + HarmConfig: properties: - blocklists: + action_sequences: items: - $ref: '#/components/schemas/BlockListResponse' + $ref: '#/components/schemas/ActionSequence' type: array x-stream-index: "001" + severity: + type: integer + x-stream-index: "002" + required: + - action_sequences + - severity + type: object + HideChannelRequest: + nullable: true + properties: + clear_history: + description: Whether to clear message history of the channel or not + title: Clear history + type: boolean + x-stream-index: "001" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "003.002" + user_id: + type: string + x-stream-index: "003.001" + type: object + HideChannelResponse: + description: Basic response information + nullable: true + properties: duration: description: Duration of the request in milliseconds title: Duration type: string - x-stream-index: "002.001" + x-stream-index: "001.001" required: - - blocklists - duration title: Response type: object - ListCallTypeResponse: - description: Response for ListCallType - nullable: true + HuaweiConfig: properties: - call_types: - additionalProperties: - $ref: '#/components/schemas/CallTypeResponse' - type: object + Disabled: + type: boolean + writeOnly: true + x-stream-index: "003" + id: + type: string x-stream-index: "001" - duration: + secret: type: string - x-stream-index: "002.001" - required: - - call_types - - duration - title: ListCallTypeResponse + x-stream-index: "002" type: object - ListChannelTypesResponse: - nullable: true + HuaweiConfigFields: properties: - channel_types: - additionalProperties: - $ref: '#/components/schemas/ChannelTypeConfig' - description: Object with all channel types - title: Channel types - type: object + enabled: + type: boolean x-stream-index: "001" - x-stream-map: - description: Channel type config object - key: channel_type - title: Channel type - duration: + id: type: string - x-stream-index: "002.001" + x-stream-index: "002" + secret: + type: string + x-stream-index: "003" required: - - channel_types - - duration - title: ListChannelTypesResponse + - enabled type: object - ListCommandsResponse: - nullable: true + ImageContentParameters: properties: - commands: - description: List of commands + harm_labels: items: - $ref: '#/components/schemas/Command' - title: Commands + type: string type: array x-stream-index: "001" - duration: + type: object + ImageData: + properties: + frames: type: string - x-stream-index: "002.001" + x-stream-index: "005" + height: + type: string + x-stream-index: "003" + size: + type: string + x-stream-index: "004" + url: + type: string + x-stream-index: "001" + width: + type: string + x-stream-index: "002" required: - - commands - - duration - title: ListCommandsResponse + - url + - width + - height + - size + - frames type: object - ListDevicesResponse: - description: List devices response - nullable: true + ImageRuleParameters: properties: - devices: - description: List of devices + harm_labels: items: - $ref: '#/components/schemas/DeviceResponse' - title: Devices + type: string type: array + x-stream-index: "003" + threshold: + format: int32 + type: integer x-stream-index: "001" - duration: + time_window: type: string - x-stream-index: "002.001" - required: - - devices - - duration - title: ListDevicesResponse + x-stream-index: "002" type: object - ListExternalStorageResponse: - description: Basic response information - nullable: true + ImageSize: properties: - duration: - description: Duration of the request in milliseconds - title: Duration + crop: + description: Crop mode + enum: + - top + - bottom + - left + - right + - center + title: Crop + type: string + x-stream-index: "001" + height: + description: Target image height + format: int32 + title: Height + type: integer + x-stream-index: "003" + resize: + description: Resize method + enum: + - clip + - crop + - scale + - fill + title: Resize type: string - x-stream-index: "001.001" - external_storages: - additionalProperties: - $ref: '#/components/schemas/ExternalStorageResponse' - type: object x-stream-index: "002" - required: - - duration - - external_storages - title: Response + width: + description: Target image width + format: int32 + title: Width + type: integer + x-stream-index: "004" + title: Image size configuration type: object - ListImportsResponse: - description: Basic response information + ImageUploadRequest: nullable: true properties: - duration: - description: Duration of the request in milliseconds - title: Duration + file: type: string - x-stream-index: "002.001" - import_tasks: + x-stream-index: "001.001" + upload_sizes: + description: field with JSON-encoded array of image size configurations items: - $ref: '#/components/schemas/ImportTask' + $ref: '#/components/schemas/ImageSize' + title: Upload sizes type: array - x-stream-index: "001" - required: - - import_tasks - - duration - title: Response + x-stream-index: "002" + user: + $ref: '#/components/schemas/OnlyUserID' + x-stream-index: "001.002" type: object - ListPermissionsResponse: - description: Basic response information + ImageUploadResponse: nullable: true properties: duration: description: Duration of the request in milliseconds title: Duration type: string - x-stream-index: "002.001" - permissions: + x-stream-index: 001.003.001 + file: + type: string + x-stream-index: "001.001" + thumb_url: + type: string + x-stream-index: "001.002" + upload_sizes: + description: Array of image size configurations items: - $ref: '#/components/schemas/Permission' + $ref: '#/components/schemas/ImageSize' + title: Upload sizes type: array - x-stream-index: "001" + x-stream-index: "002" required: - - permissions - duration - title: Response type: object - ListPushProvidersResponse: - description: Basic response information - nullable: true + Images: properties: - duration: - description: Duration of the request in milliseconds - title: Duration - type: string - x-stream-index: "002.001" - push_providers: - items: - $ref: '#/components/schemas/PushProviderResponse' - type: array + fixed_height: + $ref: '#/components/schemas/ImageData' + x-stream-index: "002" + fixed_height_downsampled: + $ref: '#/components/schemas/ImageData' + x-stream-index: "004" + fixed_height_still: + $ref: '#/components/schemas/ImageData' + x-stream-index: "003" + fixed_width: + $ref: '#/components/schemas/ImageData' + x-stream-index: "005" + fixed_width_downsampled: + $ref: '#/components/schemas/ImageData' + x-stream-index: "007" + fixed_width_still: + $ref: '#/components/schemas/ImageData' + x-stream-index: "006" + original: + $ref: '#/components/schemas/ImageData' x-stream-index: "001" required: - - push_providers - - duration - title: Response + - original + - fixed_height + - fixed_height_still + - fixed_height_downsampled + - fixed_width + - fixed_width_still + - fixed_width_downsampled type: object - ListRecordingsResponse: - description: Response for listing recordings - nullable: true + ImportTask: properties: - duration: - type: string - x-stream-index: "001.001" - recordings: + created_at: + format: date-time + type: number + x-stream-index: "011" + history: items: - $ref: '#/components/schemas/CallRecording' - title: The list of recordings. + $ref: '#/components/schemas/ImportTaskHistory' type: array - x-stream-index: "002" + x-stream-index: "010" + id: + type: string + x-stream-index: "003" + mode: + type: string + x-stream-index: "006" + path: + type: string + x-stream-index: "005" + size: + format: int64 + type: integer + x-stream-index: "007" + state: + type: string + x-stream-index: "008" + updated_at: + format: date-time + type: number + x-stream-index: "012" required: - - duration - - recordings - title: ListRecordingsResponse + - id + - path + - mode + - state + - history + - created_at + - updated_at type: object - ListRolesResponse: - description: Basic response information + ImportTaskHistory: nullable: true properties: - duration: - description: Duration of the request in milliseconds - title: Duration + created_at: + format: date-time + type: number + x-stream-index: "007" + next_state: type: string - x-stream-index: "002.001" - roles: - items: - $ref: '#/components/schemas/Role' - type: array - x-stream-index: "001" + x-stream-index: "006" + prev_state: + type: string + x-stream-index: "005" required: - - roles - - duration - title: Response + - prev_state + - next_state + - created_at type: object - ListTranscriptionsResponse: - nullable: true + IngressAudioEncodingOptions: properties: - duration: - type: string - x-stream-index: "001.001" - transcriptions: - description: List of transcriptions for the call - items: - $ref: '#/components/schemas/CallTranscription' - title: Transcriptions - type: array + bitrate: + maximum: 128000 + minimum: 16000 + type: integer + x-stream-index: "003" + channels: + enum: + - "1" + - "2" + format: int32 + type: integer + x-stream-index: "001" + enable_dtx: + type: boolean x-stream-index: "002" required: - - duration - - transcriptions - title: ListTranscriptionsResponse + - channels + - enable_dtx + - bitrate type: object - MarkChannelsReadRequest: - nullable: true + IngressAudioEncodingOptionsRequest: properties: - read_by_channel: - additionalProperties: - type: string - description: Map of channel ID to last read message ID - maximum: 30 - title: Read by channel - type: object + bitrate: + maximum: 128000 + minimum: 16000 + type: integer + x-stream-index: "003" + channels: + enum: + - "1" + - "2" + format: int32 + type: integer x-stream-index: "001" - user: - $ref: '#/components/schemas/UserRequest' - x-stream-index: "002.002" - user_id: - type: string - x-stream-index: "002.001" + enable_dtx: + type: boolean + x-stream-index: "002" + required: + - channels + - bitrate type: object - MarkReadRequest: - nullable: true + IngressAudioEncodingResponse: properties: - message_id: - description: ID of the message that is considered last read by client - title: Message ID - type: string + bitrate: + format: int32 + type: integer + x-stream-index: "003" + channels: + format: int32 + type: integer x-stream-index: "001" - thread_id: - description: Optional Thread ID to specifically mark a given thread as read - title: Thread ID - type: string + enable_dtx: + type: boolean x-stream-index: "002" - user: - $ref: '#/components/schemas/UserRequest' - x-stream-index: "004.002" - user_id: - type: string - x-stream-index: "004.001" + required: + - channels + - enable_dtx + - bitrate type: object - MarkReadResponse: - nullable: true + IngressSettings: properties: - duration: - description: Duration of the request in milliseconds - title: Duration - type: string - x-stream-index: "002.001" - event: - $ref: '#/components/schemas/MessageReadEvent' - description: Mark read event - title: Event + audio_encoding_options: + $ref: '#/components/schemas/IngressAudioEncodingOptions' + x-stream-index: "002" + enabled: + type: boolean x-stream-index: "001" + video_encoding_options: + additionalProperties: + $ref: '#/components/schemas/IngressVideoEncodingOptions' + type: object + x-stream-index: "003" required: - - duration + - enabled type: object - MarkReviewedRequest: + IngressSettingsRequest: properties: - content_to_mark_as_reviewed_limit: - format: int32 - maximum: 2500 - type: integer + audio_encoding_options: + $ref: '#/components/schemas/IngressAudioEncodingOptionsRequest' x-stream-index: "002" - disable_marking_content_as_reviewed: + enabled: type: boolean x-stream-index: "001" + video_encoding_options: + additionalProperties: + $ref: '#/components/schemas/IngressVideoEncodingOptionsRequest' + type: object + x-stream-index: "003" type: object - MarkUnreadRequest: - nullable: true + IngressSettingsResponse: properties: - message_id: - description: ID of the message from where the channel is marked unread - title: Message ID - type: string + audio_encoding_options: + $ref: '#/components/schemas/IngressAudioEncodingResponse' + x-stream-index: "002" + enabled: + type: boolean x-stream-index: "001" - thread_id: - description: Mark a thread unread, specify both the thread and message id - title: Thread ID - type: string + video_encoding_options: + additionalProperties: + $ref: '#/components/schemas/IngressVideoEncodingResponse' + type: object x-stream-index: "003" - user: - $ref: '#/components/schemas/UserRequest' - x-stream-index: "004.002" - user_id: - type: string - x-stream-index: "004.001" + required: + - enabled type: object - MemberAddedEvent: + IngressVideoEncodingOptions: properties: - channel_id: - type: string - x-stream-index: "004.002" - channel_type: - type: string - x-stream-index: "004.003" - cid: - type: string - x-stream-index: "004.001" - created_at: - format: date-time - type: number - x-stream-index: "003.002" - member: - $ref: '#/components/schemas/ChannelMember' - x-stream-index: "001.001" - team: - type: string - x-stream-index: "002.001" - type: - default: member.added - type: string - x-stream-index: "003.001" - user: - $ref: '#/components/schemas/User' - x-stream-index: "005.001" + layers: + items: + $ref: '#/components/schemas/IngressVideoLayer' + minimum: 1 + type: array + x-stream-index: "001" required: - - type - - created_at - - cid - - channel_id - - channel_type - title: MemberAddedEvent + - layers 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 - MemberLookup: + IngressVideoEncodingOptionsRequest: properties: - Limit: - format: int32 - type: integer - writeOnly: true + layers: + items: + $ref: '#/components/schemas/IngressVideoLayerRequest' + minimum: 1 + type: array x-stream-index: "001" required: - - Limit + - layers type: object - MemberRemovedEvent: + IngressVideoEncodingResponse: properties: - channel_id: - type: string - x-stream-index: "003.002" - channel_type: - type: string - x-stream-index: "003.003" - cid: - type: string - x-stream-index: "003.001" - created_at: - format: date-time - type: number - x-stream-index: "002.002" - member: - $ref: '#/components/schemas/ChannelMember' - x-stream-index: "001.001" - type: - default: member.removed - type: string - x-stream-index: "002.001" - user: - $ref: '#/components/schemas/User' - x-stream-index: "004.001" + layers: + items: + $ref: '#/components/schemas/IngressVideoLayerResponse' + type: array + x-stream-index: "001" required: - - type - - created_at - - cid - - channel_id - - channel_type - title: MemberRemovedEvent + - layers 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 - MemberRequest: - description: MemberRequest is the payload for adding a member to a call. + IngressVideoLayer: + nullable: true properties: - custom: - additionalProperties: {} - description: Custom data for this object - title: Custom data - type: object - x-stream-index: "003" - role: - title: Role + bitrate: + minimum: 1000 + type: integer + x-stream-index: "002" + codec: + enum: + - h264 + - vp8 type: string + x-stream-index: "001" + frame_rate: + maximum: 60 + minimum: 1 + type: integer + x-stream-index: "003" + max_dimension: + minimum: 240 + type: integer + x-stream-index: "005" + min_dimension: + minimum: 240 + type: integer + x-stream-index: "004" + required: + - codec + - bitrate + - frame_rate + - min_dimension + - max_dimension + type: object + IngressVideoLayerRequest: + nullable: true + properties: + bitrate: + format: int32 + minimum: 1000 + type: integer x-stream-index: "002" - user_id: - minLength: 1 - title: User ID + codec: + enum: + - h264 + - vp8 type: string x-stream-index: "001" + frame_rate_limit: + maximum: 60 + minimum: 1 + type: integer + x-stream-index: "005" + max_dimension: + minimum: 240 + type: integer + x-stream-index: "004" + min_dimension: + minimum: 240 + type: integer + x-stream-index: "003" required: - - user_id - title: MemberRequest + - codec + - bitrate + - min_dimension + - max_dimension + - frame_rate_limit type: object - MemberResponse: - description: MemberResponse is the payload for a member of a call. + IngressVideoLayerResponse: + nullable: true properties: - created_at: - description: Date/time of creation - format: date-time - title: Created at - type: number + bitrate: + type: integer + x-stream-index: "002" + codec: + type: string + x-stream-index: "001" + frame_rate_limit: + type: integer x-stream-index: "005" - custom: - additionalProperties: {} - description: Custom member response data - title: Custom - type: object + max_dimension: + type: integer x-stream-index: "004" - deleted_at: - description: Date/time of deletion - format: date-time - title: Deleted at + min_dimension: + type: integer + x-stream-index: "003" + required: + - codec + - bitrate + - min_dimension + - max_dimension + - frame_rate_limit + type: object + JoinCallAPIMetrics: + properties: + failures: + format: float type: number - x-stream-index: "007" - role: - title: Role - type: string + x-stream-index: "002" + latency: + $ref: '#/components/schemas/ActiveCallsLatencyStats' x-stream-index: "003" - updated_at: - description: Date/time of the last update - format: date-time - title: Updated at + total: + format: float type: number - x-stream-index: "006" - user: - $ref: '#/components/schemas/UserResponse' x-stream-index: "001" + required: + - total + - failures + type: object + KickUserRequest: + description: KickUserRequest is the payload for kicking a user from a call. + Optionally block the user as well. + nullable: true + properties: + block: + description: If true, also block the user from rejoining the call + title: Block + type: boolean + x-stream-index: "004" + kicked_by: + $ref: '#/components/schemas/UserRequest' + description: 'Server-side: user performing the action' + title: KickedBy + x-stream-index: "006" + kicked_by_id: + description: 'Server-side: ID of the user performing the action' + title: KickedByID + type: string + x-stream-index: "005" user_id: + description: The user to kick + title: UserID type: string - x-stream-index: "002" + x-stream-index: "003" required: - - user - user_id - - custom - - created_at - - updated_at - title: MemberResponse + title: KickUserRequest type: object - MemberUpdatedEvent: + KickUserResponse: + description: KickUserResponse is the payload for kicking a user from a call. + nullable: true properties: - channel_id: - type: string - x-stream-index: "005.002" - channel_type: + duration: + description: Duration of the request in milliseconds + title: Duration type: string - x-stream-index: "005.003" - cid: + x-stream-index: "001.001" + required: + - duration + title: KickUserResponse + type: object + KickedUserEvent: + description: This event is sent to call participants to notify when a user is + kicked from a call. Clients should make the kicked user leave the call UI. + properties: + call_cid: type: string - x-stream-index: "005.001" + x-stream-index: "002.001" created_at: format: date-time type: number - x-stream-index: "003.002" - member: - $ref: '#/components/schemas/ChannelMember' - x-stream-index: "001.001" - team: - type: string - x-stream-index: "002.001" + x-stream-index: "001.002" + kicked_by_user: + $ref: '#/components/schemas/UserResponse' + description: The user that kicked the participant, null if server-side + title: Kicked by + x-stream-index: "004" type: - default: member.updated + default: call.kicked_user + description: 'The type of event: "call.kicked_user" in this case' + title: Event Type type: string - x-stream-index: "003.001" + x-stream-index: "001.001" user: - $ref: '#/components/schemas/User' - x-stream-index: "004.001" + $ref: '#/components/schemas/UserResponse' + description: The user that was kicked + title: User + x-stream-index: "003" required: - type - created_at - - cid - - channel_id - - channel_type - title: MemberUpdatedEvent + - call_cid + - user + title: KickedUserEvent type: object - x-stream-event-client-type: true - x-stream-event-doc-group: other + x-stream-event-call-type: true + x-stream-event-doc-group: call x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent - MembersResponse: - nullable: true + LLMConfig: properties: - duration: - description: Duration of the request in milliseconds - title: Duration + app_context: type: string - x-stream-index: "002.001" - members: - description: List of found members - items: - $ref: '#/components/schemas/ChannelMember' - title: Members - type: array + x-stream-index: "005" + async: + type: boolean x-stream-index: "001" - required: - - members - - duration - type: object - Message: - properties: - attachments: + enabled: + type: boolean + x-stream-index: "002" + rules: items: - $ref: '#/components/schemas/Attachment' + $ref: '#/components/schemas/LLMRule' type: array - x-stream-index: "012" - before_message_send_failed: - type: boolean - x-stream-index: "046" - cid: - type: string - x-stream-index: "028" - command: - type: string - x-stream-index: "006" - created_at: - format: date-time - type: number - x-stream-index: "030" - custom: - additionalProperties: {} - type: object - x-stream-index: "034" - deleted_at: - format: date-time - type: number - x-stream-index: "033" - deleted_reply_count: - format: int32 - type: integer - x-stream-index: "023" - html: - type: string - x-stream-index: "007" - i18n: + x-stream-index: "003" + severity_descriptions: additionalProperties: type: string type: object - x-stream-index: "044" - id: + x-stream-index: "004" + required: + - enabled + - rules + type: object + LLMRule: + properties: + action: + enum: + - flag + - shadow + - remove + - bounce + - bounce_flag + - bounce_remove + - keep + type: string + x-stream-index: "003" + description: type: string x-stream-index: "002" - image_labels: - additionalProperties: - items: - type: string - type: array - type: object - x-stream-index: "040" - latest_reactions: + label: + type: string + x-stream-index: "001" + severity_rules: items: - $ref: '#/components/schemas/Reaction' + $ref: '#/components/schemas/BodyguardSeverityRule' type: array - x-stream-index: "013" - mentioned_users: + x-stream-index: "004" + required: + - label + - description + - action + - severity_rules + type: object + Label: + properties: + harm_labels: items: - $ref: '#/components/schemas/User' + type: string type: array - x-stream-index: "043" - message_text_updated_at: - format: date-time - type: number - x-stream-index: "052" - mml: + x-stream-index: "003" + name: type: string - x-stream-index: "005" - moderation: - $ref: '#/components/schemas/ModerationV2Response' - x-stream-index: "056" - own_reactions: + x-stream-index: "001" + phrase_list_ids: items: - $ref: '#/components/schemas/Reaction' + format: int32 + type: integer type: array - x-stream-index: "014" - parent_id: - type: string - x-stream-index: "019" - pin_expires: - format: date-time + x-stream-index: "002" + required: + - name + type: object + LabelThresholds: + properties: + block: + description: Threshold for automatic message block + format: float + maximum: 1 + minimum: 0 + title: Block type: number - x-stream-index: "051" - pinned: - type: boolean - x-stream-index: "047" - pinned_at: - format: date-time + x-stream-index: "002" + flag: + description: Threshold for automatic message flag + format: float + maximum: 1 + minimum: 0 + title: Flag type: number - x-stream-index: "048" - pinned_by: - $ref: '#/components/schemas/User' - x-stream-index: "050" - poll: - $ref: '#/components/schemas/Poll' - x-stream-index: "054" - poll_id: + x-stream-index: "001" + type: object + LayoutSettings: + properties: + detect_orientation: + type: boolean + x-stream-index: "005" + external_app_url: type: string - x-stream-index: "053" - quoted_message: - $ref: '#/components/schemas/Message' - x-stream-index: "025" - quoted_message_id: + x-stream-index: "003" + external_css_url: type: string - x-stream-index: "024" - reaction_counts: - additionalProperties: - format: int32 - type: integer - type: object - x-stream-index: "015" - reaction_groups: - additionalProperties: - $ref: '#/components/schemas/ReactionGroupResponse' - type: object - x-stream-index: "017" - reaction_scores: - additionalProperties: - format: int32 - type: integer + x-stream-index: "004" + name: + enum: + - spotlight + - grid + - single-participant + - mobile + - custom + type: string + x-stream-index: "001" + options: + additionalProperties: {} type: object - x-stream-index: "016" - reminder: - $ref: '#/components/schemas/MessageReminder' - x-stream-index: "058" - reply_count: - format: int32 - type: integer - x-stream-index: "022" - restricted_visibility: - items: - type: string - type: array - x-stream-index: "011" - shadowed: - type: boolean - x-stream-index: "036" - shared_location: - $ref: '#/components/schemas/SharedLocation' - x-stream-index: "055" - show_in_channel: - type: boolean - x-stream-index: "021" - silent: + x-stream-index: "002" + required: + - name + - external_app_url + - external_css_url + type: object + LayoutSettingsRequest: + properties: + detect_orientation: type: boolean - x-stream-index: "045" - text: + x-stream-index: "005" + external_app_url: + type: string + x-stream-index: "003" + external_css_url: type: string x-stream-index: "004" - thread_participants: - items: - $ref: '#/components/schemas/User' - type: array - x-stream-index: "027" - type: + name: + enum: + - spotlight + - grid + - single-participant + - mobile + - custom type: string - x-stream-index: "008" - updated_at: - format: date-time - type: number - x-stream-index: "031" - user: - $ref: '#/components/schemas/User' - x-stream-index: "010" + x-stream-index: "001" + options: + additionalProperties: {} + type: object + x-stream-index: "002" required: - - id - - text - - html - - type - - restricted_visibility - - attachments - - latest_reactions - - own_reactions - - reaction_counts - - reaction_scores - - reaction_groups - - reply_count - - deleted_reply_count - - cid - - created_at - - updated_at - - custom - - shadowed - - mentioned_users - - silent - - pinned + - name type: object - MessageActionRequest: - nullable: true + LayoutSettingsResponse: properties: - form_data: - additionalProperties: - type: string - description: ReadOnlyData to execute command with - title: Form data + detect_orientation: + type: boolean + x-stream-index: "005" + external_app_url: + type: string + x-stream-index: "003" + external_css_url: + type: string + x-stream-index: "004" + name: + enum: + - spotlight + - grid + - single-participant + - mobile + - custom + type: string + x-stream-index: "001" + options: + additionalProperties: {} type: object x-stream-index: "002" - user: - $ref: '#/components/schemas/UserRequest' - x-stream-index: "003.002" - user_id: - type: string - x-stream-index: "003.001" required: - - form_data + - name + - external_app_url + - external_css_url type: object - MessageChangeSet: + LimitInfo: properties: - attachments: - type: boolean - x-stream-index: "005" - custom: - type: boolean + limit: + description: The maximum number of calls allowed for the time window + format: int32 + title: Limit + type: integer x-stream-index: "001" - html: - type: boolean + remaining: + description: The number of remaining calls in the current window + format: int64 + title: Remaining + type: integer + x-stream-index: "002" + reset: + description: The Unix timestamp of the next window + format: int64 + title: Reset + type: integer + x-stream-index: "003" + required: + - limit + - remaining + - reset + title: Rate Limit info + type: object + x-stream-docs-page-id: rate_limits + LimitsSettings: + properties: + max_duration_seconds: + format: int32 + type: integer x-stream-index: "004" - mentioned_user_ids: - type: boolean - x-stream-index: "006" - mml: + max_participants: + format: int32 + type: integer + x-stream-index: "001" + max_participants_exclude_owner: type: boolean x-stream-index: "003" - pin: - type: boolean - x-stream-index: "009" - quoted_message_id: - type: boolean - x-stream-index: "007" - silent: + max_participants_exclude_roles: + items: + type: string + type: array + x-stream-index: "002" + required: + - max_participants_exclude_roles + type: object + LimitsSettingsRequest: + properties: + max_duration_seconds: + format: int32 + minimum: 0 + type: integer + x-stream-index: "004" + max_participants: + format: int32 + type: integer + x-stream-index: "001" + max_participants_exclude_owner: type: boolean - x-stream-index: "008" - text: + x-stream-index: "003" + max_participants_exclude_roles: + items: + type: string + type: array + x-stream-index: "002" + type: object + LimitsSettingsResponse: + properties: + max_duration_seconds: + format: int32 + type: integer + x-stream-index: "004" + max_participants: + format: int32 + type: integer + x-stream-index: "001" + max_participants_exclude_owner: type: boolean + x-stream-index: "003" + max_participants_exclude_roles: + items: + type: string + type: array x-stream-index: "002" required: - - custom - - text - - mml - - html - - attachments - - mentioned_user_ids - - quoted_message_id - - silent - - pin + - max_participants_exclude_roles type: object - MessageDeletedEvent: + ListBlockListResponse: + description: Basic response information + nullable: true properties: - channel_id: - type: string - x-stream-index: "003.002" - channel_type: - type: string - x-stream-index: "003.003" - cid: - type: string - x-stream-index: "003.001" - created_at: - format: date-time - type: number - x-stream-index: "006.002" - hard_delete: - type: boolean - x-stream-index: "002.001" - message: - $ref: '#/components/schemas/Message' - x-stream-index: "001.001" - team: - type: string - x-stream-index: "005.001" - thread_participants: + blocklists: items: - $ref: '#/components/schemas/User' + $ref: '#/components/schemas/BlockListResponse' type: array - x-stream-index: "001.002" - type: - default: message.deleted + x-stream-index: "001" + duration: + description: Duration of the request in milliseconds + title: Duration type: string - x-stream-index: "006.001" - user: - $ref: '#/components/schemas/User' - x-stream-index: "004.001" + x-stream-index: "002.001" required: - - hard_delete - - cid - - channel_id - - channel_type - - type - - created_at - title: MessageDeletedEvent + - blocklists + - duration + title: Response 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: + ListCallTypeResponse: + description: Response for ListCallType nullable: true properties: - approved_at: - format: date-time - type: number - x-stream-index: "013" - created_at: - format: date-time - type: number - x-stream-index: "009" - created_by_automod: - type: boolean - x-stream-index: "001" - custom: - additionalProperties: {} + call_types: + additionalProperties: + $ref: '#/components/schemas/CallTypeResponse' type: object - x-stream-index: "008" - details: - $ref: '#/components/schemas/FlagDetails' - x-stream-index: "006" - message: - $ref: '#/components/schemas/Message' - x-stream-index: "005" - moderation_feedback: - $ref: '#/components/schemas/FlagFeedback' - x-stream-index: "003" - moderation_result: - $ref: '#/components/schemas/MessageModerationResult' - x-stream-index: "002" - reason: + x-stream-index: "001" + duration: type: string - x-stream-index: "007" - rejected_at: - format: date-time - type: number - x-stream-index: "014" - reviewed_at: - format: date-time - type: number - x-stream-index: "011" - reviewed_by: - $ref: '#/components/schemas/UserResponse' - x-stream-index: "012" - updated_at: - format: date-time - type: number - x-stream-index: "010" - user: - $ref: '#/components/schemas/UserResponse' - x-stream-index: "004" + x-stream-index: "002.001" required: - - created_by_automod - - created_at - - updated_at + - call_types + - duration + title: ListCallTypeResponse type: object - MessageFlaggedEvent: + ListChannelTypesResponse: + nullable: true properties: - cid: - type: string + channel_types: + additionalProperties: + $ref: '#/components/schemas/ChannelTypeConfig' + description: Object with all channel types + title: Channel types + type: object x-stream-index: "001" - created_at: - format: date-time - type: number - x-stream-index: "005.002" - flag: - $ref: '#/components/schemas/Flag' - x-stream-index: "003.001" - message: - $ref: '#/components/schemas/Message' + x-stream-map: + description: Channel type config object + key: channel_type + title: Channel type + duration: + type: string x-stream-index: "002.001" - thread_participants: + required: + - channel_types + - duration + title: ListChannelTypesResponse + type: object + ListCommandsResponse: + nullable: true + properties: + commands: + description: List of commands items: - $ref: '#/components/schemas/User' + $ref: '#/components/schemas/Command' + title: Commands type: array - x-stream-index: "002.002" - type: - default: message.flagged + x-stream-index: "001" + duration: type: string - x-stream-index: "005.001" - user: - $ref: '#/components/schemas/User' - x-stream-index: "004" + x-stream-index: "002.001" required: - - cid - - type - - created_at - title: MessageFlaggedEvent + - commands + - duration + title: ListCommandsResponse 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 - MessageHistoryEntryResponse: + ListDevicesResponse: + description: List devices response nullable: true properties: - Custom: - additionalProperties: {} - type: object - writeOnly: true - x-stream-index: "007" - attachments: + devices: + description: List of devices items: - $ref: '#/components/schemas/Attachment' + $ref: '#/components/schemas/DeviceResponse' + title: Devices type: array - x-stream-index: "006" - is_deleted: - type: boolean - x-stream-index: "004" - message_id: - type: string x-stream-index: "001" - message_updated_at: - format: date-time - type: number - x-stream-index: "003" - message_updated_by_id: - type: string - x-stream-index: "002" - text: + duration: type: string - x-stream-index: "005" + x-stream-index: "002.001" required: - - message_id - - message_updated_by_id - - message_updated_at - - is_deleted - - text - - attachments - - Custom + - devices + - duration + title: ListDevicesResponse type: object - MessageModerationResult: - description: Result of the message moderation + ListExternalStorageResponse: + description: Basic response information + nullable: true properties: - action: - description: Action taken by automod - title: Action + duration: + description: Duration of the request in milliseconds + title: Duration type: string + x-stream-index: "001.001" + external_storages: + additionalProperties: + $ref: '#/components/schemas/ExternalStorageResponse' + type: object x-stream-index: "002" - ai_moderation_response: - $ref: '#/components/schemas/ModerationResponse' - description: Response from AI moderation - title: ModerationResponse - x-stream-index: "007" - blocked_word: - description: Word that was blocked - title: Blocked word - type: string - x-stream-index: "004" - blocklist_name: - description: Name of the blocklist - title: Blocklist name - type: string - x-stream-index: "005" - created_at: - description: Date/time of creation - format: date-time - title: Created at - type: number - x-stream-index: "010" - message_id: - description: ID of the message - title: Message ID + required: + - duration + - external_storages + title: Response + type: object + ListFeedGroupsResponse: + description: Basic response information + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration type: string + x-stream-index: "002.001" + groups: + additionalProperties: + $ref: '#/components/schemas/FeedGroupResponse' + type: object x-stream-index: "001" - moderated_by: - description: User who moderated the message - title: Moderated by + required: + - groups + - duration + title: Response + type: object + ListFeedViewsResponse: + nullable: true + properties: + duration: type: string - x-stream-index: "003" - moderation_thresholds: - $ref: '#/components/schemas/Thresholds' - description: Thresholds for AI moderation - title: Thresholds - x-stream-index: "006" - updated_at: - description: Date/time of the last update - format: date-time - title: Updated at - type: number - x-stream-index: "011" - user_bad_karma: - description: Whether user has bad karma - title: User bad karma + x-stream-index: "002.001" + views: + additionalProperties: + $ref: '#/components/schemas/FeedViewResponse' + description: Map of feed view ID to feed view + title: Views + type: object + x-stream-index: "001" + required: + - views + - duration + title: List Feed Views Response + type: object + ListImportsResponse: + description: Basic response information + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "002.001" + import_tasks: + items: + $ref: '#/components/schemas/ImportTask' + type: array + x-stream-index: "001" + required: + - import_tasks + - duration + title: Response + type: object + ListPermissionsResponse: + description: Basic response information + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "002.001" + permissions: + items: + $ref: '#/components/schemas/Permission' + type: array + x-stream-index: "001" + required: + - permissions + - duration + title: Response + type: object + ListPushProvidersResponse: + description: Basic response information + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "002.001" + push_providers: + items: + $ref: '#/components/schemas/PushProviderResponse' + type: array + x-stream-index: "001" + required: + - push_providers + - duration + title: Response + type: object + ListRecordingsResponse: + description: Response for listing recordings + nullable: true + properties: + duration: + type: string + x-stream-index: "001.001" + recordings: + items: + $ref: '#/components/schemas/CallRecording' + title: The list of recordings. + type: array + x-stream-index: "002" + required: + - duration + - recordings + title: ListRecordingsResponse + type: object + ListRolesResponse: + description: Basic response information + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "002.001" + roles: + items: + $ref: '#/components/schemas/Role' + type: array + x-stream-index: "001" + required: + - roles + - duration + title: Response + type: object + ListTranscriptionsResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "001.001" + transcriptions: + description: List of transcriptions for the call + items: + $ref: '#/components/schemas/CallTranscription' + title: Transcriptions + type: array + x-stream-index: "002" + required: + - duration + - transcriptions + title: ListTranscriptionsResponse + type: object + MarkActivityRequest: + nullable: true + properties: + mark_all_read: + description: Whether to mark all activities as read + title: Mark All Read type: boolean - x-stream-index: "009" - user_karma: - description: Karma of the user - format: float - title: User karma - type: number - x-stream-index: "008" + x-stream-index: "005" + mark_all_seen: + description: Whether to mark all activities as seen + title: Mark All Seen + type: boolean + x-stream-index: "003" + mark_read: + description: List of activity IDs to mark as read + items: + type: string + title: Mark Read + type: array + x-stream-index: "004" + mark_seen: + description: List of activity IDs to mark as seen + items: + type: string + title: Mark Seen + type: array + x-stream-index: "006" + mark_watched: + description: List of activity IDs to mark as watched (for stories) + items: + type: string + title: Mark Watched + type: array + x-stream-index: "007" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "009.002" + user_id: + type: string + x-stream-index: "009.001" + title: Mark Activity Request + type: object + MarkChannelsReadRequest: + nullable: true + properties: + read_by_channel: + additionalProperties: + type: string + description: Map of channel ID to last read message ID + maximum: 30 + title: Read by channel + type: object + x-stream-index: "001" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "002.002" + user_id: + type: string + x-stream-index: "002.001" + type: object + MarkReadRequest: + nullable: true + properties: + message_id: + description: ID of the message that is considered last read by client + title: Message ID + type: string + x-stream-index: "001" + thread_id: + description: Optional Thread ID to specifically mark a given thread as read + title: Thread ID + type: string + x-stream-index: "002" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "004.002" + user_id: + type: string + x-stream-index: "004.001" + type: object + MarkReadResponse: + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "002.001" + event: + $ref: '#/components/schemas/MessageReadEvent' + description: Mark read event + title: Event + x-stream-index: "001" required: - - message_id - - action - - user_karma - - user_bad_karma - - created_at - - updated_at - title: Message moderation result + - duration type: object - MessageNewEvent: + MarkReviewedRequest: + properties: + content_to_mark_as_reviewed_limit: + format: int32 + maximum: 2500 + type: integer + x-stream-index: "002" + disable_marking_content_as_reviewed: + type: boolean + x-stream-index: "001" + type: object + MarkUnreadRequest: + nullable: true + properties: + message_id: + description: ID of the message from where the channel is marked unread + title: Message ID + type: string + x-stream-index: "001" + thread_id: + description: Mark a thread unread, specify both the thread and message id + title: Thread ID + type: string + x-stream-index: "003" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "004.002" + user_id: + type: string + x-stream-index: "004.001" + type: object + MemberAddedEvent: properties: channel_id: type: string - x-stream-index: "005.002" + x-stream-index: "004.002" channel_type: type: string - x-stream-index: "005.003" + x-stream-index: "004.003" cid: type: string - x-stream-index: "005.001" + x-stream-index: "004.001" created_at: format: date-time type: number - x-stream-index: "004.002" - message: - $ref: '#/components/schemas/Message' + x-stream-index: "003.002" + member: + $ref: '#/components/schemas/ChannelMember' x-stream-index: "001.001" team: type: string - x-stream-index: "006.001" - thread_participants: - items: - $ref: '#/components/schemas/User' - type: array - x-stream-index: "001.002" + x-stream-index: "002.001" type: - default: notification.thread_message_new + default: member.added type: string - x-stream-index: "004.001" + x-stream-index: "003.001" user: $ref: '#/components/schemas/User' - x-stream-index: "003.001" - watcher_count: - format: int32 - type: integer - x-stream-index: "002.001" + x-stream-index: "005.001" required: - - watcher_count - type - created_at - cid - channel_id - channel_type - title: MessageNewEvent + title: MemberAddedEvent 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 - MessageOptions: + MemberLookup: properties: - include_thread_participants: - type: boolean + Limit: + format: int32 + type: integer + writeOnly: true x-stream-index: "001" + required: + - Limit type: object - MessagePaginationParams: - type: object - MessageReadEvent: + MemberRemovedEvent: properties: channel_id: type: string - x-stream-index: "003" - channel_last_message_at: - format: date-time - type: number - x-stream-index: "005" + x-stream-index: "003.002" channel_type: type: string - x-stream-index: "004" + x-stream-index: "003.003" cid: type: string - x-stream-index: "002" + x-stream-index: "003.001" created_at: format: date-time type: number - x-stream-index: "009" - last_read_message_id: - type: string - x-stream-index: "010" - team: - type: string - x-stream-index: "006" - thread: - $ref: '#/components/schemas/ThreadResponse' - x-stream-index: "008" + x-stream-index: "002.002" + member: + $ref: '#/components/schemas/ChannelMember' + x-stream-index: "001.001" type: - default: message.read + default: member.removed type: string - x-stream-index: "001" + x-stream-index: "002.001" user: - $ref: '#/components/schemas/UserResponseCommonFields' - x-stream-index: "007" + $ref: '#/components/schemas/User' + x-stream-index: "004.001" required: - type + - created_at - cid - channel_id - channel_type - - created_at + title: MemberRemovedEvent type: object - MessageReminder: + x-stream-event-client-type: true + x-stream-event-doc-group: other + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent + MemberRequest: + description: MemberRequest is the payload for adding a member to a call. properties: - channel: - $ref: '#/components/schemas/Channel' - x-stream-index: "004" - channel_cid: - type: string + custom: + additionalProperties: {} + description: Custom data for this object + title: Custom data + type: object x-stream-index: "003" + role: + title: Role + type: string + x-stream-index: "002" + user_id: + minLength: 1 + title: User ID + type: string + x-stream-index: "001" + required: + - user_id + title: MemberRequest + type: object + MemberResponse: + description: MemberResponse is the payload for a member of a call. + properties: created_at: + description: Date/time of creation format: date-time + title: Created at type: number - x-stream-index: "011" - message: - $ref: '#/components/schemas/Message' - x-stream-index: "006" - message_id: - type: string x-stream-index: "005" - remind_at: + custom: + additionalProperties: {} + description: Custom member response data + title: Custom + type: object + x-stream-index: "004" + deleted_at: + description: Date/time of deletion format: date-time + title: Deleted at type: number - x-stream-index: "009" - task_id: + x-stream-index: "007" + role: + title: Role type: string - x-stream-index: "010" + x-stream-index: "003" updated_at: + description: Date/time of the last update format: date-time + title: Updated at type: number - x-stream-index: "012" + x-stream-index: "006" user: - $ref: '#/components/schemas/User' - x-stream-index: "008" + $ref: '#/components/schemas/UserResponse' + x-stream-index: "001" user_id: type: string - x-stream-index: "007" + x-stream-index: "002" required: - - channel_cid - - message_id + - user - user_id - - task_id + - custom - created_at - updated_at + title: MemberResponse type: object - MessageRequest: + MemberUpdatedEvent: properties: - attachments: + channel_id: + type: string + x-stream-index: "005.002" + channel_type: + type: string + x-stream-index: "005.003" + cid: + type: string + x-stream-index: "005.001" + created_at: + format: date-time + type: number + x-stream-index: "003.002" + member: + $ref: '#/components/schemas/ChannelMember' + x-stream-index: "001.001" + team: + type: string + x-stream-index: "002.001" + type: + default: member.updated + type: string + x-stream-index: "003.001" + user: + $ref: '#/components/schemas/User' + x-stream-index: "004.001" + required: + - type + - created_at + - cid + - channel_id + - channel_type + title: MemberUpdatedEvent + 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 + MembersResponse: + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "002.001" + members: + description: List of found members items: - $ref: '#/components/schemas/Attachment' - maximum: 30 + $ref: '#/components/schemas/ChannelMember' + title: Members type: array - x-stream-index: "004" + x-stream-index: "001" + required: + - members + - duration + type: object + MembershipLevelResponse: + properties: + created_at: + description: When the membership level was created + format: date-time + title: Created At + type: number + x-stream-index: "007" custom: additionalProperties: {} + description: Custom data for the membership level + title: Custom Data type: object - x-stream-index: "007" - html: + x-stream-index: "006" + description: + description: Description of the membership level + title: Description type: string - x-stream-index: "010" + x-stream-index: "003" id: - maxLength: 255 + description: Unique identifier for the membership level + title: ID type: string x-stream-index: "001" - mentioned_users: + name: + description: Display name for the membership level + title: Name + type: string + x-stream-index: "002" + priority: + description: Priority level + format: int32 + title: Priority + type: integer + x-stream-index: "004" + tags: + description: Activity tags this membership level gives access to items: type: string - maximum: 100 + title: Tags type: array - x-stream-index: "008" - mml: - type: string - x-stream-index: "003" - parent_id: - type: string x-stream-index: "005" - pin_expires: + updated_at: + description: When the membership level was last updated format: date-time + title: Updated At type: number - x-stream-index: "015" - pinned: - type: boolean - x-stream-index: "013" - pinned_at: - format: date-time - nullable: true - type: string - x-stream-index: "014" - poll_id: - type: string - x-stream-index: "039" - quoted_message_id: - type: string - x-stream-index: "009" - restricted_visibility: - items: - type: string - maximum: 10 - type: array - x-stream-index: "016" - shared_location: - $ref: '#/components/schemas/SharedLocation' - x-stream-index: "040" - show_in_channel: - type: boolean - x-stream-index: "006" - silent: - type: boolean - x-stream-index: "012" - text: - type: string - x-stream-index: "002" - type: - enum: - - '''''' - - regular - - system - type: string - x-stream-index: "011" - user: - $ref: '#/components/schemas/UserRequest' - x-stream-index: "021.002" - user_id: - type: string - x-stream-index: "021.001" + x-stream-index: "008" + required: + - id + - name + - priority + - tags + - created_at + - updated_at + title: Membership Level Response type: object - MessageResponse: - description: Represents any chat message + Message: properties: attachments: - description: Array of message attachments items: $ref: '#/components/schemas/Attachment' - title: Message attachments type: array - x-stream-docs-page-id: message_format#attachment-format - x-stream-index: "008" + x-stream-index: "012" + before_message_send_failed: + type: boolean + x-stream-index: "046" cid: - description: Channel unique identifier in : format - title: Channel CID type: string - x-stream-index: "022" + x-stream-index: "028" command: - description: Contains provided slash command - title: Command type: string - x-stream-docs-page-id: custom_commands_webhook - x-stream-index: "004" + x-stream-index: "006" created_at: - description: Date/time of creation format: date-time - title: Created at type: number - x-stream-index: "023" + x-stream-index: "030" custom: additionalProperties: {} type: object - x-stream-index: "026" + x-stream-index: "034" deleted_at: - description: Date/time of deletion format: date-time - title: Deleted at type: number - x-stream-index: "025" + x-stream-index: "033" + deleted_for_me: + type: boolean + x-stream-index: "059" deleted_reply_count: format: int32 type: integer - x-stream-index: "018" - draft: - $ref: '#/components/schemas/DraftResponse' - x-stream-index: "041" + x-stream-index: "023" html: - description: Contains HTML markup of the message. Can only be set when using - server-side API - title: HTML content type: string - x-stream-index: "005" + x-stream-index: "007" i18n: additionalProperties: type: string - description: Object with translations. Key `language` contains the original - language key. Other keys contain translations - title: Internationalization info type: object - x-stream-docs-page-id: translation - x-stream-index: "030" + x-stream-index: "044" id: - description: Message ID is unique string identifier of the message - title: ID type: string - x-stream-index: "001" + x-stream-index: "002" image_labels: additionalProperties: items: type: string type: array - description: Contains image moderation information - title: Image moderation labels type: object - x-stream-index: "028" + x-stream-index: "040" latest_reactions: - description: List of 10 latest reactions to this message items: - $ref: '#/components/schemas/ReactionResponse' - title: Latest reactions + $ref: '#/components/schemas/Reaction' type: array - x-stream-index: "009" + x-stream-index: "013" mentioned_users: - description: List of mentioned users items: - $ref: '#/components/schemas/UserResponse' - title: Mentioned Users + $ref: '#/components/schemas/User' type: array - x-stream-index: "029" + x-stream-index: "043" message_text_updated_at: format: date-time type: number - x-stream-index: "036" + x-stream-index: "052" mml: - description: Should be empty if `text` is provided. Can only be set when - using server-side API - title: Messaging Markup Language type: string - x-stream-docs-page-id: mml_overview - x-stream-index: "003" + x-stream-index: "005" moderation: $ref: '#/components/schemas/ModerationV2Response' - x-stream-index: "039" + x-stream-index: "056" own_reactions: - description: List of 10 latest reactions of authenticated user to this message items: - $ref: '#/components/schemas/ReactionResponse' - title: Own reactions + $ref: '#/components/schemas/Reaction' type: array - x-stream-index: "010" + x-stream-index: "014" parent_id: - description: ID of parent message (thread) - title: Parent message ID type: string - x-stream-docs-page-id: threads - x-stream-index: "015" + x-stream-index: "019" pin_expires: - description: Date when pinned message expires format: date-time - title: Pin expiration date type: number - x-stream-docs-page-id: pinned_messages - x-stream-index: "035" + x-stream-index: "051" pinned: - description: Whether message is pinned or not - title: Pinned type: boolean - x-stream-docs-page-id: pinned_messages - x-stream-index: "032" + x-stream-index: "047" pinned_at: - description: Date when message got pinned format: date-time - title: Pinned at type: number - x-stream-docs-page-id: pinned_messages - x-stream-index: "033" + x-stream-index: "048" pinned_by: - $ref: '#/components/schemas/UserResponse' - description: Contains user who pinned the message - title: Pinned by - x-stream-docs-page-id: pinned_messages - x-stream-index: "034" + $ref: '#/components/schemas/User' + x-stream-index: "050" poll: - $ref: '#/components/schemas/PollResponseData' - x-stream-index: "038" + $ref: '#/components/schemas/Poll' + x-stream-index: "054" poll_id: - description: Identifier of the poll to include in the message - title: Poll ID type: string - x-stream-index: "037" + x-stream-index: "053" quoted_message: - $ref: '#/components/schemas/MessageResponse' - description: Contains quoted message - title: Quoted message - x-stream-docs-page-id: threads#quote-message - x-stream-index: "020" + $ref: '#/components/schemas/Message' + x-stream-index: "025" quoted_message_id: - title: ID of quoted message type: string - x-stream-docs-page-id: threads#quote-message - x-stream-index: "019" + x-stream-index: "024" reaction_counts: additionalProperties: format: int32 type: integer - description: 'An object containing number of reactions of each type. Key: - reaction type (string), value: number of reactions (int)' - title: Reaction counts type: object - x-stream-index: "011" + x-stream-index: "015" reaction_groups: additionalProperties: $ref: '#/components/schemas/ReactionGroupResponse' type: object - x-stream-index: "014" + x-stream-index: "017" reaction_scores: additionalProperties: format: int32 type: integer - description: 'An object containing scores of reactions of each type. Key: - reaction type (string), value: total score of reactions (int)' - title: Reaction scores type: object - x-stream-index: "012" + x-stream-index: "016" reminder: - $ref: '#/components/schemas/ReminderResponseData' - x-stream-index: "042" + $ref: '#/components/schemas/MessageReminder' + x-stream-index: "058" reply_count: - description: Number of replies to this message format: int32 - title: Reply count type: integer - x-stream-index: "017" + x-stream-index: "022" restricted_visibility: - description: A list of user ids that have restricted visibility to the message, - if the list is not empty, the message is only visible to the users in - the list items: type: string - title: Restricted visibility type: array - x-stream-index: "040" + x-stream-index: "011" shadowed: - description: Whether the message was shadowed or not - title: Shadowed type: boolean - x-stream-docs-page-id: moderation#shadow-ban - x-stream-index: "027" + x-stream-index: "036" shared_location: - $ref: '#/components/schemas/SharedLocationResponseData' - description: Contains shared location data - title: Shared Location - x-stream-index: "043" + $ref: '#/components/schemas/SharedLocation' + x-stream-index: "055" show_in_channel: - description: Whether thread reply should be shown in the channel as well - title: Show in channel type: boolean - x-stream-docs-page-id: threads - x-stream-index: "016" + x-stream-index: "021" silent: - description: Whether message is silent or not - title: Silent type: boolean - x-stream-index: "031" + x-stream-index: "045" text: - description: Text of the message. Should be empty if `mml` is provided - title: Text type: string - x-stream-index: "002" + x-stream-index: "004" thread_participants: - description: List of users who participate in thread items: - $ref: '#/components/schemas/UserResponse' - title: Thread participants + $ref: '#/components/schemas/User' type: array - x-stream-docs-page-id: threads#quote-message - x-stream-index: "021" + x-stream-index: "027" type: - description: Contains type of the message - enum: - - regular - - ephemeral - - error - - reply - - system - - deleted - title: Message Type type: string - x-stream-docs-page-id: message_format#message-types - x-stream-index: "006" + x-stream-index: "008" updated_at: - description: Date/time of the last update format: date-time - title: Updated at type: number - x-stream-index: "024" + x-stream-index: "031" user: - $ref: '#/components/schemas/UserResponse' - description: Sender of the message. Required when using server-side API - title: User object - x-stream-index: "007" + $ref: '#/components/schemas/User' + x-stream-index: "010" required: - id - text - html - type - - user + - restricted_visibility - attachments - latest_reactions - own_reactions - reaction_counts - reaction_scores + - reaction_groups - reply_count - deleted_reply_count - cid @@ -14067,207 +18307,597 @@ components: - mentioned_users - silent - pinned - - restricted_visibility - title: Message type: object - x-stream-docs-page-id: send_message - MessageStatsResponse: + MessageActionRequest: + nullable: true properties: - count_over_time: - items: - $ref: '#/components/schemas/CountByMinuteResponse' - type: array - x-stream-index: "001" + form_data: + additionalProperties: + type: string + description: ReadOnlyData to execute command with + title: Form data + type: object + x-stream-index: "002" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "003.002" + user_id: + type: string + x-stream-index: "003.001" + required: + - form_data type: object - MessageUnblockedEvent: + MessageChangeSet: properties: - cid: - type: string + attachments: + type: boolean + x-stream-index: "005" + custom: + type: boolean x-stream-index: "001" - created_at: - format: date-time - type: number - x-stream-index: "004.002" - message: - $ref: '#/components/schemas/Message' - x-stream-index: "002.001" - thread_participants: - items: - $ref: '#/components/schemas/User' - type: array - x-stream-index: "002.002" - type: - default: message.unblocked - type: string - x-stream-index: "004.001" - user: - $ref: '#/components/schemas/User' - x-stream-index: "003.001" + html: + type: boolean + x-stream-index: "004" + mentioned_user_ids: + type: boolean + x-stream-index: "006" + mml: + type: boolean + x-stream-index: "003" + pin: + type: boolean + x-stream-index: "009" + quoted_message_id: + type: boolean + x-stream-index: "007" + silent: + type: boolean + x-stream-index: "008" + text: + type: boolean + x-stream-index: "002" required: - - cid - - type - - created_at - title: MessageUnblockedEvent + - custom + - text + - mml + - html + - attachments + - mentioned_user_ids + - quoted_message_id + - silent + - pin 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 - MessageUndeletedEvent: + MessageDeletedEvent: properties: channel_id: type: string - x-stream-index: "005.002" + x-stream-index: "004.002" channel_type: type: string - x-stream-index: "005.003" + x-stream-index: "004.003" cid: type: string - x-stream-index: "005.001" + x-stream-index: "004.001" created_at: format: date-time type: number - x-stream-index: "004.002" + x-stream-index: "007.002" + deleted_for_me: + type: boolean + x-stream-index: "003" + hard_delete: + type: boolean + x-stream-index: "002.001" message: $ref: '#/components/schemas/Message' x-stream-index: "001.001" team: type: string - x-stream-index: "002.001" + x-stream-index: "006.001" thread_participants: items: $ref: '#/components/schemas/User' type: array x-stream-index: "001.002" type: - default: message.undeleted + default: message.deleted type: string - x-stream-index: "004.001" + x-stream-index: "007.001" user: $ref: '#/components/schemas/User' - x-stream-index: "003.001" + x-stream-index: "005.001" required: - - type - - created_at + - hard_delete - cid - channel_id - channel_type - title: MessageUndeletedEvent + - type + - created_at + title: MessageDeletedEvent 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 - MessageUpdate: + MessageFlagResponse: + nullable: true properties: - change_set: - $ref: '#/components/schemas/MessageChangeSet' + approved_at: + format: date-time + type: number + x-stream-index: "013" + created_at: + format: date-time + type: number + x-stream-index: "009" + created_by_automod: + type: boolean + x-stream-index: "001" + custom: + additionalProperties: {} + type: object + x-stream-index: "008" + details: + $ref: '#/components/schemas/FlagDetails' + x-stream-index: "006" + message: + $ref: '#/components/schemas/Message' + x-stream-index: "005" + moderation_feedback: + $ref: '#/components/schemas/FlagFeedback' + x-stream-index: "003" + moderation_result: + $ref: '#/components/schemas/MessageModerationResult' x-stream-index: "002" - old_text: + reason: type: string - x-stream-index: "001" + x-stream-index: "007" + rejected_at: + format: date-time + type: number + x-stream-index: "014" + reviewed_at: + format: date-time + type: number + x-stream-index: "011" + reviewed_by: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "012" + updated_at: + format: date-time + type: number + x-stream-index: "010" + user: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "004" + required: + - created_by_automod + - created_at + - updated_at type: object - MessageUpdatedEvent: + MessageFlaggedEvent: properties: - channel_id: - type: string - x-stream-index: "005.002" - channel_type: - type: string - x-stream-index: "005.003" cid: type: string - x-stream-index: "005.001" + x-stream-index: "001" created_at: format: date-time type: number - x-stream-index: "004.002" + x-stream-index: "005.002" + flag: + $ref: '#/components/schemas/Flag' + x-stream-index: "003.001" message: $ref: '#/components/schemas/Message' - x-stream-index: "001.001" - team: - type: string x-stream-index: "002.001" thread_participants: items: $ref: '#/components/schemas/User' type: array - x-stream-index: "001.002" + x-stream-index: "002.002" type: - default: message.updated + default: message.flagged type: string - x-stream-index: "004.001" + x-stream-index: "005.001" user: $ref: '#/components/schemas/User' - x-stream-index: "003.001" + x-stream-index: "004" required: + - cid - type - created_at - - cid - - channel_id - - channel_type - title: MessageUpdatedEvent + title: MessageFlaggedEvent 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 - MessageWithChannelResponse: - description: Represents any chat message + MessageHistoryEntryResponse: + nullable: true properties: + Custom: + additionalProperties: {} + type: object + writeOnly: true + x-stream-index: "007" attachments: - description: Array of message attachments items: $ref: '#/components/schemas/Attachment' - title: Message attachments type: array - x-stream-docs-page-id: message_format#attachment-format - x-stream-index: "001.008" - channel: - $ref: '#/components/schemas/ChannelResponse' - description: Channel object - title: Channel - x-stream-index: "002" - cid: - description: Channel unique identifier in : format - title: Channel CID - type: string - x-stream-index: "001.022" - command: - description: Contains provided slash command - title: Command + x-stream-index: "006" + is_deleted: + type: boolean + x-stream-index: "004" + message_id: type: string - x-stream-docs-page-id: custom_commands_webhook - x-stream-index: "001.004" - created_at: - description: Date/time of creation + x-stream-index: "001" + message_updated_at: format: date-time - title: Created at type: number - x-stream-index: "001.023" - custom: - additionalProperties: {} - type: object - x-stream-index: "001.026" + x-stream-index: "003" + message_updated_by_id: + type: string + x-stream-index: "002" + text: + type: string + x-stream-index: "005" + required: + - message_id + - message_updated_by_id + - message_updated_at + - is_deleted + - text + - attachments + - Custom + type: object + MessageModerationResult: + description: Result of the message moderation + properties: + action: + description: Action taken by automod + title: Action + type: string + x-stream-index: "002" + ai_moderation_response: + $ref: '#/components/schemas/ModerationResponse' + description: Response from AI moderation + title: ModerationResponse + x-stream-index: "007" + blocked_word: + description: Word that was blocked + title: Blocked word + type: string + x-stream-index: "004" + blocklist_name: + description: Name of the blocklist + title: Blocklist name + type: string + x-stream-index: "005" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: "010" + message_id: + description: ID of the message + title: Message ID + type: string + x-stream-index: "001" + moderated_by: + description: User who moderated the message + title: Moderated by + type: string + x-stream-index: "003" + moderation_thresholds: + $ref: '#/components/schemas/Thresholds' + description: Thresholds for AI moderation + title: Thresholds + x-stream-index: "006" + updated_at: + description: Date/time of the last update + format: date-time + title: Updated at + type: number + x-stream-index: "011" + user_bad_karma: + description: Whether user has bad karma + title: User bad karma + type: boolean + x-stream-index: "009" + user_karma: + description: Karma of the user + format: float + title: User karma + type: number + x-stream-index: "008" + required: + - message_id + - action + - user_karma + - user_bad_karma + - created_at + - updated_at + title: Message moderation result + type: object + MessageNewEvent: + properties: + channel_id: + type: string + x-stream-index: "005.002" + channel_type: + type: string + x-stream-index: "005.003" + cid: + type: string + x-stream-index: "005.001" + created_at: + format: date-time + type: number + x-stream-index: "004.002" + message: + $ref: '#/components/schemas/Message' + x-stream-index: "001.001" + team: + type: string + x-stream-index: "006.001" + thread_participants: + items: + $ref: '#/components/schemas/User' + type: array + x-stream-index: "001.002" + type: + default: message.new + type: string + x-stream-index: "004.001" + user: + $ref: '#/components/schemas/User' + x-stream-index: "003.001" + watcher_count: + format: int32 + type: integer + x-stream-index: "002.001" + required: + - watcher_count + - type + - created_at + - cid + - channel_id + - channel_type + title: MessageNewEvent + 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 + MessageOptions: + properties: + include_thread_participants: + type: boolean + x-stream-index: "001" + type: object + MessagePaginationParams: + type: object + MessageReadEvent: + properties: + channel_id: + type: string + x-stream-index: "003" + channel_last_message_at: + format: date-time + type: number + x-stream-index: "005" + channel_type: + type: string + x-stream-index: "004" + cid: + type: string + x-stream-index: "002" + created_at: + format: date-time + type: number + x-stream-index: "009" + last_read_message_id: + type: string + x-stream-index: "010" + team: + type: string + x-stream-index: "006" + thread: + $ref: '#/components/schemas/ThreadResponse' + x-stream-index: "008" + type: + default: message.read + type: string + x-stream-index: "001" + user: + $ref: '#/components/schemas/UserResponseCommonFields' + x-stream-index: "007" + required: + - type + - cid + - channel_id + - channel_type + - created_at + type: object + MessageReminder: + properties: + channel: + $ref: '#/components/schemas/Channel' + x-stream-index: "004" + channel_cid: + type: string + x-stream-index: "003" + created_at: + format: date-time + type: number + x-stream-index: "011" + message: + $ref: '#/components/schemas/Message' + x-stream-index: "006" + message_id: + type: string + x-stream-index: "005" + remind_at: + format: date-time + type: number + x-stream-index: "009" + task_id: + type: string + x-stream-index: "010" + updated_at: + format: date-time + type: number + x-stream-index: "012" + user: + $ref: '#/components/schemas/User' + x-stream-index: "008" + user_id: + type: string + x-stream-index: "007" + required: + - channel_cid + - message_id + - user_id + - task_id + - created_at + - updated_at + type: object + MessageRequest: + properties: + attachments: + items: + $ref: '#/components/schemas/Attachment' + maximum: 30 + type: array + x-stream-index: "004" + custom: + additionalProperties: {} + type: object + x-stream-index: "007" + html: + type: string + x-stream-index: "010" + id: + maxLength: 255 + type: string + x-stream-index: "001" + mentioned_users: + items: + type: string + maximum: 100 + type: array + x-stream-index: "008" + mml: + type: string + x-stream-index: "003" + parent_id: + type: string + x-stream-index: "005" + pin_expires: + format: date-time + type: number + x-stream-index: "015" + pinned: + type: boolean + x-stream-index: "013" + pinned_at: + format: date-time + nullable: true + type: string + x-stream-index: "014" + poll_id: + type: string + x-stream-index: "039" + quoted_message_id: + type: string + x-stream-index: "009" + restricted_visibility: + items: + type: string + maximum: 10 + type: array + x-stream-index: "016" + shared_location: + $ref: '#/components/schemas/SharedLocation' + x-stream-index: "040" + show_in_channel: + type: boolean + x-stream-index: "006" + silent: + type: boolean + x-stream-index: "012" + text: + type: string + x-stream-index: "002" + type: + enum: + - '''''' + - regular + - system + type: string + x-stream-index: "011" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "021.002" + user_id: + type: string + x-stream-index: "021.001" + type: object + MessageResponse: + description: Represents any chat message + properties: + attachments: + description: Array of message attachments + items: + $ref: '#/components/schemas/Attachment' + title: Message attachments + type: array + x-stream-docs-page-id: message_format#attachment-format + x-stream-index: "008" + cid: + description: Channel unique identifier in : format + title: Channel CID + type: string + x-stream-index: "022" + command: + description: Contains provided slash command + title: Command + type: string + x-stream-docs-page-id: custom_commands_webhook + x-stream-index: "004" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: "023" + custom: + additionalProperties: {} + type: object + x-stream-index: "026" deleted_at: description: Date/time of deletion format: date-time title: Deleted at type: number - x-stream-index: "001.025" + x-stream-index: "025" + deleted_for_me: + type: boolean + x-stream-index: "044" deleted_reply_count: format: int32 type: integer - x-stream-index: "001.018" + x-stream-index: "018" draft: $ref: '#/components/schemas/DraftResponse' - x-stream-index: "001.041" + x-stream-index: "041" html: description: Contains HTML markup of the message. Can only be set when using server-side API title: HTML content type: string - x-stream-index: "001.005" + x-stream-index: "005" i18n: additionalProperties: type: string @@ -14276,12 +18906,12 @@ components: title: Internationalization info type: object x-stream-docs-page-id: translation - x-stream-index: "001.030" + x-stream-index: "030" id: description: Message ID is unique string identifier of the message title: ID type: string - x-stream-index: "001.001" + x-stream-index: "001" image_labels: additionalProperties: items: @@ -14290,93 +18920,93 @@ components: description: Contains image moderation information title: Image moderation labels type: object - x-stream-index: "001.028" + x-stream-index: "028" latest_reactions: description: List of 10 latest reactions to this message items: $ref: '#/components/schemas/ReactionResponse' title: Latest reactions type: array - x-stream-index: "001.009" + x-stream-index: "009" mentioned_users: description: List of mentioned users items: $ref: '#/components/schemas/UserResponse' title: Mentioned Users type: array - x-stream-index: "001.029" + x-stream-index: "029" message_text_updated_at: format: date-time type: number - x-stream-index: "001.036" + x-stream-index: "036" mml: description: Should be empty if `text` is provided. Can only be set when using server-side API title: Messaging Markup Language type: string x-stream-docs-page-id: mml_overview - x-stream-index: "001.003" + x-stream-index: "003" moderation: $ref: '#/components/schemas/ModerationV2Response' - x-stream-index: "001.039" + x-stream-index: "039" own_reactions: description: List of 10 latest reactions of authenticated user to this message items: $ref: '#/components/schemas/ReactionResponse' title: Own reactions type: array - x-stream-index: "001.010" + x-stream-index: "010" parent_id: description: ID of parent message (thread) title: Parent message ID type: string x-stream-docs-page-id: threads - x-stream-index: "001.015" + x-stream-index: "015" pin_expires: description: Date when pinned message expires format: date-time title: Pin expiration date type: number x-stream-docs-page-id: pinned_messages - x-stream-index: "001.035" + x-stream-index: "035" pinned: description: Whether message is pinned or not title: Pinned type: boolean x-stream-docs-page-id: pinned_messages - x-stream-index: "001.032" + x-stream-index: "032" pinned_at: description: Date when message got pinned format: date-time title: Pinned at type: number x-stream-docs-page-id: pinned_messages - x-stream-index: "001.033" + x-stream-index: "033" pinned_by: $ref: '#/components/schemas/UserResponse' description: Contains user who pinned the message title: Pinned by x-stream-docs-page-id: pinned_messages - x-stream-index: "001.034" + x-stream-index: "034" poll: $ref: '#/components/schemas/PollResponseData' - x-stream-index: "001.038" + x-stream-index: "038" poll_id: description: Identifier of the poll to include in the message title: Poll ID type: string - x-stream-index: "001.037" + x-stream-index: "037" quoted_message: $ref: '#/components/schemas/MessageResponse' description: Contains quoted message title: Quoted message x-stream-docs-page-id: threads#quote-message - x-stream-index: "001.020" + x-stream-index: "020" quoted_message_id: title: ID of quoted message type: string x-stream-docs-page-id: threads#quote-message - x-stream-index: "001.019" + x-stream-index: "019" reaction_counts: additionalProperties: format: int32 @@ -14385,12 +19015,12 @@ components: reaction type (string), value: number of reactions (int)' title: Reaction counts type: object - x-stream-index: "001.011" + x-stream-index: "011" reaction_groups: additionalProperties: $ref: '#/components/schemas/ReactionGroupResponse' type: object - x-stream-index: "001.014" + x-stream-index: "014" reaction_scores: additionalProperties: format: int32 @@ -14399,16 +19029,16 @@ components: reaction type (string), value: total score of reactions (int)' title: Reaction scores type: object - x-stream-index: "001.012" + x-stream-index: "012" reminder: $ref: '#/components/schemas/ReminderResponseData' - x-stream-index: "001.042" + x-stream-index: "042" reply_count: description: Number of replies to this message format: int32 title: Reply count type: integer - x-stream-index: "001.017" + x-stream-index: "017" restricted_visibility: description: A list of user ids that have restricted visibility to the message, if the list is not empty, the message is only visible to the users in @@ -14417,34 +19047,34 @@ components: type: string title: Restricted visibility type: array - x-stream-index: "001.040" + x-stream-index: "040" shadowed: description: Whether the message was shadowed or not title: Shadowed type: boolean x-stream-docs-page-id: moderation#shadow-ban - x-stream-index: "001.027" + x-stream-index: "027" shared_location: $ref: '#/components/schemas/SharedLocationResponseData' description: Contains shared location data title: Shared Location - x-stream-index: "001.043" + x-stream-index: "043" show_in_channel: description: Whether thread reply should be shown in the channel as well title: Show in channel type: boolean x-stream-docs-page-id: threads - x-stream-index: "001.016" + x-stream-index: "016" silent: description: Whether message is silent or not title: Silent type: boolean - x-stream-index: "001.031" + x-stream-index: "031" text: description: Text of the message. Should be empty if `mml` is provided title: Text type: string - x-stream-index: "001.002" + x-stream-index: "002" thread_participants: description: List of users who participate in thread items: @@ -14452,7 +19082,7 @@ components: title: Thread participants type: array x-stream-docs-page-id: threads#quote-message - x-stream-index: "001.021" + x-stream-index: "021" type: description: Contains type of the message enum: @@ -14465,18 +19095,18 @@ components: title: Message Type type: string x-stream-docs-page-id: message_format#message-types - x-stream-index: "001.006" + x-stream-index: "006" updated_at: description: Date/time of the last update format: date-time title: Updated at type: number - x-stream-index: "001.024" + x-stream-index: "024" user: $ref: '#/components/schemas/UserResponse' description: Sender of the message. Required when using server-side API title: User object - x-stream-index: "001.007" + x-stream-index: "007" required: - id - text @@ -14499,109 +19129,79 @@ components: - silent - pinned - restricted_visibility - - channel title: Message type: object x-stream-docs-page-id: send_message - ModerationActionConfig: - nullable: true + MessageStatsResponse: properties: - action: - type: string - x-stream-index: "006" - custom: - additionalProperties: {} - type: object - x-stream-index: "009" - description: - type: string - x-stream-index: "008" - entity_type: - type: string - x-stream-index: "004" - icon: - type: string - x-stream-index: "007" - order: - format: int32 - type: integer - x-stream-index: "005" - required: - - entity_type - - order - - action - - icon - - description - - custom + count_over_time: + items: + $ref: '#/components/schemas/CountByMinuteResponse' + type: array + x-stream-index: "001" type: object - ModerationCheckCompletedEvent: - description: This event is sent when a moderation check is completed - nullable: true + MessageUnblockedEvent: properties: - created_at: - format: date-time - type: number - x-stream-index: "001.003" - custom: - additionalProperties: {} - type: object - x-stream-index: "001.007" - entity_id: - description: The ID of entity which was moderated - title: EntityID - type: string - x-stream-index: "002" - entity_type: - description: The type of the entity which was moderated - title: EntityType + cid: type: string - x-stream-index: "003" - received_at: + x-stream-index: "001" + created_at: format: date-time type: number - x-stream-index: "001.004" - recommended_action: - description: The recommended action - title: RecommendedAction - type: string - x-stream-index: "004" - review_queue_item_id: - description: The review queue item ID - title: ReviewQueueItemID - type: string - x-stream-index: "005" + x-stream-index: "004.002" + message: + $ref: '#/components/schemas/Message' + x-stream-index: "002.001" + thread_participants: + items: + $ref: '#/components/schemas/User' + type: array + x-stream-index: "002.002" type: - default: moderation_check.completed + default: message.unblocked type: string - x-stream-index: "001.002" + x-stream-index: "004.001" + user: + $ref: '#/components/schemas/User' + x-stream-index: "003.001" required: + - cid - type - created_at - - custom - - entity_id - - entity_type - - recommended_action - - review_queue_item_id - title: ModerationCheckCompletedEvent + title: MessageUnblockedEvent 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 - ModerationCustomActionEvent: + MessageUndeletedEvent: properties: + channel_id: + type: string + x-stream-index: "005.002" + channel_type: + type: string + x-stream-index: "005.003" + cid: + type: string + x-stream-index: "005.001" created_at: format: date-time type: number x-stream-index: "004.002" - item: - $ref: '#/components/schemas/ReviewQueueItem' - x-stream-index: "001" message: $ref: '#/components/schemas/Message' - x-stream-index: "002" + x-stream-index: "001.001" + team: + type: string + x-stream-index: "002.001" + thread_participants: + items: + $ref: '#/components/schemas/User' + type: array + x-stream-index: "001.002" type: - default: moderation.custom_action + default: message.undeleted type: string x-stream-index: "004.001" user: @@ -14610,112 +19210,449 @@ components: required: - type - created_at - title: ModerationCustomActionEvent + - cid + - channel_id + - channel_type + title: MessageUndeletedEvent 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 - ModerationDashboardPreferences: + MessageUpdate: properties: - flag_user_on_flagged_content: - type: boolean + change_set: + $ref: '#/components/schemas/MessageChangeSet' x-stream-index: "002" - media_queue_blur_enabled: - type: boolean + old_text: + type: string x-stream-index: "001" type: object - ModerationFlagResponse: - nullable: true + MessageUpdatedEvent: properties: + channel_id: + type: string + x-stream-index: "005.002" + channel_type: + type: string + x-stream-index: "005.003" + cid: + type: string + x-stream-index: "005.001" created_at: + format: date-time + type: number + x-stream-index: "004.002" + message: + $ref: '#/components/schemas/Message' + x-stream-index: "001.001" + team: type: string - x-stream-index: "014" + x-stream-index: "002.001" + thread_participants: + items: + $ref: '#/components/schemas/User' + type: array + x-stream-index: "001.002" + type: + default: message.updated + type: string + x-stream-index: "004.001" + user: + $ref: '#/components/schemas/User' + x-stream-index: "003.001" + required: + - type + - created_at + - cid + - channel_id + - channel_type + title: MessageUpdatedEvent + 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 + MessageWithChannelResponse: + description: Represents any chat message + properties: + attachments: + description: Array of message attachments + items: + $ref: '#/components/schemas/Attachment' + title: Message attachments + type: array + x-stream-docs-page-id: message_format#attachment-format + x-stream-index: "001.008" + channel: + $ref: '#/components/schemas/ChannelResponse' + description: Channel object + title: Channel + x-stream-index: "002" + cid: + description: Channel unique identifier in : format + title: Channel CID + type: string + x-stream-index: "001.022" + command: + description: Contains provided slash command + title: Command + type: string + x-stream-docs-page-id: custom_commands_webhook + x-stream-index: "001.004" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: "001.023" custom: additionalProperties: {} type: object - x-stream-index: "009" - entity_creator_id: + x-stream-index: "001.026" + deleted_at: + description: Date/time of deletion + format: date-time + title: Deleted at + type: number + x-stream-index: "001.025" + deleted_for_me: + type: boolean + x-stream-index: "001.044" + deleted_reply_count: + format: int32 + type: integer + x-stream-index: "001.018" + draft: + $ref: '#/components/schemas/DraftResponse' + x-stream-index: "001.041" + html: + description: Contains HTML markup of the message. Can only be set when using + server-side API + title: HTML content type: string - x-stream-index: "006" - entity_id: + x-stream-index: "001.005" + i18n: + additionalProperties: + type: string + description: Object with translations. Key `language` contains the original + language key. Other keys contain translations + title: Internationalization info + type: object + x-stream-docs-page-id: translation + x-stream-index: "001.030" + id: + description: Message ID is unique string identifier of the message + title: ID type: string - x-stream-index: "005" - entity_type: + x-stream-index: "001.001" + image_labels: + additionalProperties: + items: + type: string + type: array + description: Contains image moderation information + title: Image moderation labels + type: object + x-stream-index: "001.028" + latest_reactions: + description: List of 10 latest reactions to this message + items: + $ref: '#/components/schemas/ReactionResponse' + title: Latest reactions + type: array + x-stream-index: "001.009" + mentioned_users: + description: List of mentioned users + items: + $ref: '#/components/schemas/UserResponse' + title: Mentioned Users + type: array + x-stream-index: "001.029" + message_text_updated_at: + format: date-time + type: number + x-stream-index: "001.036" + mml: + description: Should be empty if `text` is provided. Can only be set when + using server-side API + title: Messaging Markup Language type: string - x-stream-index: "004" - id: + x-stream-docs-page-id: mml_overview + x-stream-index: "001.003" + moderation: + $ref: '#/components/schemas/ModerationV2Response' + x-stream-index: "001.039" + own_reactions: + description: List of 10 latest reactions of authenticated user to this message + items: + $ref: '#/components/schemas/ReactionResponse' + title: Own reactions + type: array + x-stream-index: "001.010" + parent_id: + description: ID of parent message (thread) + title: Parent message ID type: string - x-stream-index: "001" - labels: + x-stream-docs-page-id: threads + x-stream-index: "001.015" + pin_expires: + description: Date when pinned message expires + format: date-time + title: Pin expiration date + type: number + x-stream-docs-page-id: pinned_messages + x-stream-index: "001.035" + pinned: + description: Whether message is pinned or not + title: Pinned + type: boolean + x-stream-docs-page-id: pinned_messages + x-stream-index: "001.032" + pinned_at: + description: Date when message got pinned + format: date-time + title: Pinned at + type: number + x-stream-docs-page-id: pinned_messages + x-stream-index: "001.033" + pinned_by: + $ref: '#/components/schemas/UserResponse' + description: Contains user who pinned the message + title: Pinned by + x-stream-docs-page-id: pinned_messages + x-stream-index: "001.034" + poll: + $ref: '#/components/schemas/PollResponseData' + x-stream-index: "001.038" + poll_id: + description: Identifier of the poll to include in the message + title: Poll ID + type: string + x-stream-index: "001.037" + quoted_message: + $ref: '#/components/schemas/MessageResponse' + description: Contains quoted message + title: Quoted message + x-stream-docs-page-id: threads#quote-message + x-stream-index: "001.020" + quoted_message_id: + title: ID of quoted message + type: string + x-stream-docs-page-id: threads#quote-message + x-stream-index: "001.019" + reaction_counts: + additionalProperties: + format: int32 + type: integer + description: 'An object containing number of reactions of each type. Key: + reaction type (string), value: number of reactions (int)' + title: Reaction counts + type: object + x-stream-index: "001.011" + reaction_groups: + additionalProperties: + $ref: '#/components/schemas/ReactionGroupResponse' + type: object + x-stream-index: "001.014" + reaction_scores: + additionalProperties: + format: int32 + type: integer + description: 'An object containing scores of reactions of each type. Key: + reaction type (string), value: total score of reactions (int)' + title: Reaction scores + type: object + x-stream-index: "001.012" + reminder: + $ref: '#/components/schemas/ReminderResponseData' + x-stream-index: "001.042" + reply_count: + description: Number of replies to this message + format: int32 + title: Reply count + type: integer + x-stream-index: "001.017" + restricted_visibility: + description: A list of user ids that have restricted visibility to the message, + if the list is not empty, the message is only visible to the users in + the list items: type: string + title: Restricted visibility type: array - x-stream-index: "010" - moderation_payload: - $ref: '#/components/schemas/ModerationPayload' - x-stream-index: "007" - reason: + x-stream-index: "001.040" + shadowed: + description: Whether the message was shadowed or not + title: Shadowed + type: boolean + x-stream-docs-page-id: moderation#shadow-ban + x-stream-index: "001.027" + shared_location: + $ref: '#/components/schemas/SharedLocationResponseData' + description: Contains shared location data + title: Shared Location + x-stream-index: "001.043" + show_in_channel: + description: Whether thread reply should be shown in the channel as well + title: Show in channel + type: boolean + x-stream-docs-page-id: threads + x-stream-index: "001.016" + silent: + description: Whether message is silent or not + title: Silent + type: boolean + x-stream-index: "001.031" + text: + description: Text of the message. Should be empty if `mml` is provided + title: Text type: string - x-stream-index: "008" - result: + x-stream-index: "001.002" + thread_participants: + description: List of users who participate in thread items: - additionalProperties: {} - type: object + $ref: '#/components/schemas/UserResponse' + title: Thread participants type: array - x-stream-index: "011" - review_queue_item: - $ref: '#/components/schemas/ReviewQueueItemResponse' - x-stream-index: "013" - review_queue_item_id: - type: string - x-stream-index: "012" + x-stream-docs-page-id: threads#quote-message + x-stream-index: "001.021" type: + description: Contains type of the message + enum: + - regular + - ephemeral + - error + - reply + - system + - deleted + title: Message Type type: string - x-stream-index: "002" + x-stream-docs-page-id: message_format#message-types + x-stream-index: "001.006" updated_at: - type: string - x-stream-index: "015" + description: Date/time of the last update + format: date-time + title: Updated at + type: number + x-stream-index: "001.024" user: $ref: '#/components/schemas/UserResponse' - x-stream-index: "003" + description: Sender of the message. Required when using server-side API + title: User object + x-stream-index: "001.007" required: - id + - text + - html - type - - entity_type - - entity_id + - user + - attachments + - latest_reactions + - own_reactions + - reaction_counts + - reaction_scores + - reply_count + - deleted_reply_count + - cid - created_at - updated_at + - custom + - shadowed + - mentioned_users + - silent + - pinned + - restricted_visibility + - channel + title: Message type: object - ModerationFlaggedEvent: + x-stream-docs-page-id: send_message + ModerationActionConfig: + nullable: true + properties: + action: + type: string + x-stream-index: "006" + custom: + additionalProperties: {} + type: object + x-stream-index: "009" + description: + type: string + x-stream-index: "008" + entity_type: + type: string + x-stream-index: "004" + icon: + type: string + x-stream-index: "007" + order: + format: int32 + type: integer + x-stream-index: "005" + required: + - entity_type + - order + - action + - icon + - description + - custom + type: object + ModerationCheckCompletedEvent: + description: This event is sent when a moderation check is completed + nullable: true properties: created_at: format: date-time type: number - x-stream-index: "004.002" - item: - type: string - x-stream-index: "001" - object_id: + x-stream-index: "001.003" + custom: + additionalProperties: {} + type: object + x-stream-index: "001.007" + entity_id: + description: The ID of entity which was moderated + title: EntityID type: string x-stream-index: "002" + entity_type: + description: The type of the entity which was moderated + title: EntityType + type: string + x-stream-index: "003" + received_at: + format: date-time + type: number + x-stream-index: "001.004" + recommended_action: + description: The recommended action + title: RecommendedAction + type: string + x-stream-index: "004" + review_queue_item_id: + description: The review queue item ID + title: ReviewQueueItemID + type: string + x-stream-index: "005" type: - default: moderation.flagged + default: moderation_check.completed type: string - x-stream-index: "004.001" - user: - $ref: '#/components/schemas/User' - x-stream-index: "003.001" + x-stream-index: "001.002" required: - type - created_at - title: ModerationFlaggedEvent + - custom + - entity_id + - entity_type + - recommended_action + - review_queue_item_id + title: ModerationCheckCompletedEvent 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 - ModerationMarkReviewedEvent: + ModerationCustomActionEvent: properties: created_at: format: date-time @@ -14728,7 +19665,7 @@ components: $ref: '#/components/schemas/Message' x-stream-index: "002" type: - default: moderation.mark_reviewed + default: moderation.custom_action type: string x-stream-index: "004.001" user: @@ -14737,29 +19674,159 @@ components: required: - type - created_at - title: ModerationMarkReviewedEvent + title: ModerationCustomActionEvent 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 - ModerationPayload: + ModerationDashboardPreferences: + properties: + flag_user_on_flagged_content: + type: boolean + x-stream-index: "002" + media_queue_blur_enabled: + type: boolean + x-stream-index: "001" + type: object + ModerationFlagResponse: + nullable: true properties: + created_at: + format: date-time + type: number + x-stream-index: "015" custom: additionalProperties: {} type: object - x-stream-index: "004" - images: - items: - type: string - maximum: 30 - type: array - x-stream-index: "002" - texts: + x-stream-index: "010" + entity_creator_id: + type: string + x-stream-index: "007" + entity_id: + type: string + x-stream-index: "006" + entity_type: + type: string + x-stream-index: "005" + labels: items: type: string type: array - x-stream-index: "001" + x-stream-index: "011" + moderation_payload: + $ref: '#/components/schemas/ModerationPayload' + x-stream-index: "008" + reason: + type: string + x-stream-index: "009" + result: + items: + additionalProperties: {} + type: object + type: array + x-stream-index: "012" + review_queue_item: + $ref: '#/components/schemas/ReviewQueueItemResponse' + x-stream-index: "014" + review_queue_item_id: + type: string + x-stream-index: "013" + type: + type: string + x-stream-index: "002" + updated_at: + format: date-time + type: number + x-stream-index: "016" + user: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "004" + user_id: + type: string + x-stream-index: "003" + required: + - type + - user_id + - entity_type + - entity_id + - result + - created_at + - updated_at + type: object + ModerationFlaggedEvent: + properties: + created_at: + format: date-time + type: number + x-stream-index: "004.002" + item: + type: string + x-stream-index: "001" + object_id: + type: string + x-stream-index: "002" + type: + default: moderation.flagged + type: string + x-stream-index: "004.001" + user: + $ref: '#/components/schemas/User' + x-stream-index: "003.001" + required: + - type + - created_at + title: ModerationFlaggedEvent + 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 + ModerationMarkReviewedEvent: + properties: + created_at: + format: date-time + type: number + x-stream-index: "004.002" + item: + $ref: '#/components/schemas/ReviewQueueItem' + x-stream-index: "001" + message: + $ref: '#/components/schemas/Message' + x-stream-index: "002" + type: + default: moderation.mark_reviewed + type: string + x-stream-index: "004.001" + user: + $ref: '#/components/schemas/User' + x-stream-index: "003.001" + required: + - type + - created_at + title: ModerationMarkReviewedEvent + 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 + ModerationPayload: + properties: + custom: + additionalProperties: {} + type: object + x-stream-index: "004" + images: + items: + type: string + maximum: 30 + type: array + x-stream-index: "002" + texts: + items: + type: string + type: array + x-stream-index: "001" videos: items: type: string @@ -14790,6 +19857,70 @@ components: - action - automod_response type: object + ModerationRuleV2Response: + properties: + action: + $ref: '#/components/schemas/RuleBuilderAction' + x-stream-index: "010" + conditions: + items: + $ref: '#/components/schemas/RuleBuilderCondition' + type: array + x-stream-index: "007" + config_keys: + items: + type: string + type: array + x-stream-index: "004" + cooldown_period: + type: string + x-stream-index: "011" + created_at: + format: date-time + type: number + x-stream-index: "013" + description: + type: string + x-stream-index: "003" + enabled: + type: boolean + x-stream-index: "012" + groups: + items: + $ref: '#/components/schemas/RuleBuilderConditionGroup' + type: array + x-stream-index: "009" + id: + type: string + x-stream-index: "001" + logic: + type: string + x-stream-index: "008" + name: + type: string + x-stream-index: "002" + rule_type: + type: string + x-stream-index: "006" + team: + type: string + x-stream-index: "005" + updated_at: + format: date-time + type: number + x-stream-index: "014" + required: + - id + - name + - description + - config_keys + - team + - rule_type + - action + - enabled + - created_at + - updated_at + type: object ModerationV2Response: properties: action: @@ -15006,6 +20137,81 @@ components: required: - mode type: object + NotificationConfig: + properties: + track_read: + description: Whether to track read status + title: Track Read + type: boolean + x-stream-index: "002" + track_seen: + description: Whether to track seen status + title: Track Seen + type: boolean + x-stream-index: "001" + title: Notification Configuration + type: object + NotificationFeedUpdatedEvent: + description: Emitted when notification feed is updated. + nullable: true + properties: + aggregated_activities: + description: Aggregated activities for notification feeds + items: + $ref: '#/components/schemas/AggregatedActivityResponse' + title: Aggregated Activities + type: array + x-stream-index: "001" + created_at: + description: Date/time of creation + format: date-time + title: Created at + type: number + x-stream-index: 003.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 003.001.007 + feed_visibility: + type: string + x-stream-index: "003.003" + fid: + description: The ID of the feed + title: Feed ID + type: string + x-stream-index: "003.002" + notification_status: + $ref: '#/components/schemas/NotificationStatusResponse' + description: Notification status including unread/unseen counts + title: Notification Status + x-stream-index: "002" + received_at: + format: date-time + type: number + x-stream-index: 003.001.004 + type: + default: feeds.notification_feed.updated + description: 'The type of event: "feeds.notification_feed.updated" in this + case' + title: Event Type + type: string + x-stream-index: 003.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The user who triggered the notification + title: User + x-stream-index: "004.001" + required: + - type + - created_at + - custom + - fid + title: NotificationFeedUpdatedEvent + 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 NotificationMarkUnreadEvent: properties: channel: @@ -15119,6 +20325,47 @@ components: - call_ring - call_missed type: object + NotificationStatusResponse: + properties: + last_read_at: + format: date-time + type: number + x-stream-index: "006" + last_seen_at: + description: When notifications were last seen + format: date-time + title: Last Seen At + type: number + x-stream-index: "005" + read_activities: + description: IDs of activities that have been read + items: + type: string + title: Read Activities + type: array + x-stream-index: "003" + seen_activities: + items: + type: string + type: array + x-stream-index: "004" + unread: + description: Number of unread notifications + format: int32 + title: Unread + type: integer + x-stream-index: "001" + unseen: + description: Number of unseen notifications + format: int32 + title: Unseen + type: integer + x-stream-index: "002" + required: + - unread + - unseen + title: Notification Status + type: object NullTime: type: object OCRRule: @@ -15160,6 +20407,7 @@ components: - join-backstage - join-call - join-ended-call + - kick-user - mute-users - pin-for-everyone - read-call @@ -15457,6 +20705,21 @@ components: - unread_channels - unread_threads type: object + PagerRequest: + properties: + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "001" + next: + type: string + x-stream-index: "002" + prev: + type: string + x-stream-index: "003" + type: object PagerResponse: properties: next: @@ -15767,6 +21030,52 @@ components: x-stream-event-doc-group: call x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent + PinActivityRequest: + nullable: true + properties: + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "005.002" + user_id: + type: string + x-stream-index: "005.001" + title: Pin Activity Request + type: object + PinActivityResponse: + nullable: true + properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + description: The pinned activity + title: Activity + x-stream-index: "001" + created_at: + description: When the activity was pinned + format: date-time + title: Created At + type: number + x-stream-index: "004" + duration: + type: string + x-stream-index: "005.001" + feed: + description: Fully qualified ID of the feed the activity was pinned to + title: Feed ID + type: string + x-stream-index: "002" + user_id: + description: ID of the user who pinned the activity + title: User ID + type: string + x-stream-index: "003" + required: + - activity + - feed + - user_id + - created_at + - duration + title: Pin Activity Response + type: object PinRequest: description: PinRequest is the payload for pinning a message. nullable: true @@ -16393,6 +21702,9 @@ components: type: object PublisherVideoMetrics: properties: + bitrate: + $ref: '#/components/schemas/ActiveCallsBitrateStats' + x-stream-index: "005" fps_30: $ref: '#/components/schemas/ActiveCallsFPSStats' x-stream-index: "002" @@ -16402,6 +21714,9 @@ components: jitter_ms: $ref: '#/components/schemas/ActiveCallsLatencyStats' x-stream-index: "001" + resolution: + $ref: '#/components/schemas/ActiveCallsResolutionStats' + x-stream-index: "004" type: object PublishersMetrics: properties: @@ -16424,6 +21739,22 @@ components: required: - version type: object + PushNotificationConfig: + properties: + activity_types: + enum: + - follow + - comment + - reaction + - comment_reaction + items: + type: string + type: array + x-stream-index: "002" + enabled: + type: boolean + x-stream-index: "001" + type: object PushNotificationFields: properties: apn: @@ -16498,11 +21829,25 @@ components: description: Disable push notifications till a certain time format: date-time type: number + x-stream-index: "007" + feeds_events: + $ref: '#/components/schemas/FeedsEventPreferencesInput' + description: Set granular feeds event preferences for reactions, comments, + new followers, and mentions + x-stream-index: "006" + feeds_level: + description: Set the level of feeds push notifications for the user. One + of all, none, default + enum: + - all + - none + - default + type: string x-stream-index: "005" remove_disable: description: Remove the disabled until time. (IE stop snoozing notifications) type: boolean - x-stream-index: "006" + x-stream-index: "008" user_id: description: The user id for which to set the push preferences. Required when using server side auths, defaults to current user with client side @@ -16521,6 +21866,12 @@ components: disabled_until: format: date-time type: number + x-stream-index: "005" + feeds_events: + $ref: '#/components/schemas/FeedsEventPreferences' + x-stream-index: "004" + feeds_level: + type: string x-stream-index: "003" type: object PushProvider: @@ -16733,6 +22084,12 @@ components: - message.updated - reaction.new - notification.reminder_due + - feeds.activity.added + - feeds.comment.added + - feeds.activity.reaction.added + - feeds.comment.reaction.added + - feeds.follow.created + - feeds.notification_feed.updated type: string x-stream-index: "005" template: @@ -16794,6 +22151,117 @@ components: required: - daily type: object + QueryActivitiesRequest: + nullable: true + properties: + filter: + additionalProperties: {} + description: Filters to apply to the query. Supports location-based queries + with 'near' and 'within_bounds' operators. + title: Filter + type: object + x-stream-index: "001" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "003.001" + next: + type: string + x-stream-index: "003.002" + prev: + type: string + x-stream-index: "003.003" + sort: + description: Sorting parameters for the query + items: + $ref: '#/components/schemas/SortParamRequest' + maximum: 5 + title: Sort + type: array + x-stream-index: "002" + title: Query Activities Request + type: object + QueryActivitiesResponse: + nullable: true + properties: + activities: + description: List of activities matching the query + items: + $ref: '#/components/schemas/ActivityResponse' + title: Activities + type: array + x-stream-index: "001" + duration: + type: string + x-stream-index: "003.001" + next: + description: Cursor for next page + title: Next + type: string + x-stream-index: "002.001" + prev: + description: Cursor for previous page + title: Previous + type: string + x-stream-index: "002.002" + required: + - activities + - duration + title: Query Activities Response + type: object + QueryActivityReactionsRequest: + nullable: true + properties: + filter: + additionalProperties: {} + type: object + x-stream-index: "002" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "004.001" + next: + type: string + x-stream-index: "004.002" + prev: + type: string + x-stream-index: "004.003" + sort: + items: + $ref: '#/components/schemas/SortParamRequest' + maximum: 5 + type: array + x-stream-index: "003" + type: object + QueryActivityReactionsResponse: + description: Basic response information + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "003.001" + next: + type: string + x-stream-index: "002.001" + prev: + type: string + x-stream-index: "002.002" + reactions: + items: + $ref: '#/components/schemas/FeedsReactionResponse' + type: array + x-stream-index: "001" + required: + - reactions + - duration + title: Response + type: object QueryAggregateCallStatsRequest: nullable: true properties: @@ -16905,6 +22373,123 @@ components: - bans - duration type: object + QueryBookmarkFoldersRequest: + nullable: true + properties: + filter: + additionalProperties: {} + description: Filters to apply to the query + title: Filter + type: object + x-stream-index: "001" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "003.001" + next: + type: string + x-stream-index: "003.002" + prev: + type: string + x-stream-index: "003.003" + sort: + description: Sorting parameters for the query + items: + $ref: '#/components/schemas/SortParamRequest' + title: Sort + type: array + x-stream-index: "002" + title: Query Bookmark Folders Request + type: object + QueryBookmarkFoldersResponse: + nullable: true + properties: + bookmark_folders: + description: List of bookmark folders matching the query + items: + $ref: '#/components/schemas/BookmarkFolderResponse' + title: Bookmark Folders + type: array + x-stream-index: "001" + duration: + type: string + x-stream-index: "003.001" + next: + description: Cursor for next page + title: Next + type: string + x-stream-index: "002.001" + prev: + description: Cursor for previous page + title: Previous + type: string + x-stream-index: "002.002" + required: + - bookmark_folders + - duration + title: Query Bookmark Folders Response + type: object + QueryBookmarksRequest: + nullable: true + properties: + filter: + additionalProperties: {} + description: Filters to apply to the query + title: Filter + type: object + x-stream-index: "001" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "003.001" + next: + type: string + x-stream-index: "003.002" + prev: + type: string + x-stream-index: "003.003" + sort: + description: Sorting parameters for the query + items: + $ref: '#/components/schemas/SortParamRequest' + maximum: 5 + title: Sort + type: array + x-stream-index: "002" + title: Query Bookmarks Request + type: object + QueryBookmarksResponse: + nullable: true + properties: + bookmarks: + description: List of bookmarks matching the query + items: + $ref: '#/components/schemas/BookmarkResponse' + title: Bookmarks + type: array + x-stream-index: "001" + duration: + type: string + x-stream-index: "003.001" + next: + description: Cursor for next page + title: Next + type: string + x-stream-index: "002.001" + prev: + description: Cursor for previous page + title: Previous + type: string + x-stream-index: "002.002" + required: + - bookmarks + - duration + title: Query Bookmarks Response + type: object QueryCallMembersRequest: nullable: true properties: @@ -17252,6 +22837,123 @@ components: - duration title: Channels list type: object + QueryCommentReactionsRequest: + nullable: true + properties: + filter: + additionalProperties: {} + type: object + x-stream-index: "002" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "004.001" + next: + type: string + x-stream-index: "004.002" + prev: + type: string + x-stream-index: "004.003" + sort: + items: + $ref: '#/components/schemas/SortParamRequest' + maximum: 5 + type: array + x-stream-index: "003" + type: object + QueryCommentReactionsResponse: + description: Basic response information + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "003.001" + next: + type: string + x-stream-index: "002.001" + prev: + type: string + x-stream-index: "002.002" + reactions: + items: + $ref: '#/components/schemas/FeedsReactionResponse' + type: array + x-stream-index: "001" + required: + - reactions + - duration + title: Response + type: object + QueryCommentsRequest: + nullable: true + properties: + filter: + additionalProperties: {} + description: MongoDB-style filter for querying comments + title: Filter + type: object + x-stream-index: "001" + limit: + description: Maximum number of comments to return + format: int32 + maximum: 100 + minimum: 0 + title: Limit + type: integer + x-stream-index: "003.001" + next: + type: string + x-stream-index: "003.002" + prev: + type: string + x-stream-index: "003.003" + sort: + description: first (oldest), last (newest) or top + enum: + - first + - last + - top + - best + - controversial + title: Sort Order + type: string + x-stream-index: "002" + required: + - filter + title: Query Comments Request + type: object + QueryCommentsResponse: + nullable: true + properties: + comments: + description: List of comments matching the query + items: + $ref: '#/components/schemas/CommentResponse' + title: Comments + type: array + x-stream-index: "001" + duration: + type: string + x-stream-index: "003.001" + next: + description: Cursor for next page + title: Next + type: string + x-stream-index: "002.001" + prev: + description: Cursor for previous page + title: Previous + type: string + x-stream-index: "002.002" + required: + - comments + - duration + title: Query Comments Response + type: object QueryDraftsRequest: nullable: true properties: @@ -17314,6 +23016,63 @@ components: - drafts - duration type: object + QueryFeedMembersRequest: + nullable: true + properties: + filter: + additionalProperties: {} + description: Filter parameters for the query + title: object + type: object + x-stream-index: "003" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "005.001" + next: + type: string + x-stream-index: "005.002" + prev: + type: string + x-stream-index: "005.003" + sort: + description: Sort parameters for the query + items: + $ref: '#/components/schemas/SortParamRequest' + maximum: 5 + title: array + type: array + x-stream-index: "004" + type: object + QueryFeedMembersResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "003.001" + members: + description: List of feed members + items: + $ref: '#/components/schemas/FeedMemberResponse' + title: array + type: array + x-stream-index: "001" + next: + description: Cursor for next page + title: Next + type: string + x-stream-index: "002.001" + prev: + description: Cursor for previous page + title: Previous + type: string + x-stream-index: "002.002" + required: + - members + - duration + type: object QueryFeedModerationTemplate: properties: config: @@ -17360,6 +23119,129 @@ components: - templates - duration type: object + QueryFeedsRequest: + nullable: true + properties: + filter: + additionalProperties: {} + description: Filters to apply to the query + title: Filter + type: object + x-stream-index: "001" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "004.001" + next: + type: string + x-stream-index: "004.002" + prev: + type: string + x-stream-index: "004.003" + sort: + description: Sorting parameters for the query + items: + $ref: '#/components/schemas/SortParamRequest' + maximum: 5 + title: Sort + type: array + x-stream-index: "003" + watch: + description: Whether to subscribe to realtime updates + title: Watch + type: boolean + x-stream-index: "002" + title: Query Feeds Request + type: object + QueryFeedsResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "003.001" + feeds: + description: List of feeds matching the query + items: + $ref: '#/components/schemas/FeedResponse' + title: Feeds + type: array + x-stream-index: "001" + next: + description: Cursor for next page + title: Next + type: string + x-stream-index: "002.001" + prev: + description: Cursor for previous page + title: Previous + type: string + x-stream-index: "002.002" + required: + - feeds + - duration + title: Query Feeds Response + type: object + QueryFollowsRequest: + nullable: true + properties: + filter: + additionalProperties: {} + description: Filters to apply to the query + title: Filter + type: object + x-stream-index: "001" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "003.001" + next: + type: string + x-stream-index: "003.002" + prev: + type: string + x-stream-index: "003.003" + sort: + description: Sorting parameters for the query + items: + $ref: '#/components/schemas/SortParamRequest' + maximum: 5 + title: Sort + type: array + x-stream-index: "002" + title: Query Follows Request + type: object + QueryFollowsResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "003.001" + follows: + description: List of follow relationships matching the query + items: + $ref: '#/components/schemas/FollowResponse' + title: Follows + type: array + x-stream-index: "001" + next: + description: Cursor for next page + title: Next + type: string + x-stream-index: "002.001" + prev: + description: Cursor for previous page + title: Previous + type: string + x-stream-index: "002.002" + required: + - follows + - duration + title: Query Follows Response + type: object QueryMembersPayload: description: Client request properties: @@ -17408,6 +23290,63 @@ components: - filter_conditions title: ClientRequest type: object + QueryMembershipLevelsRequest: + nullable: true + properties: + filter: + additionalProperties: {} + description: Filters to apply to the query + title: Filter + type: object + x-stream-index: "001" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "003.001" + next: + type: string + x-stream-index: "003.002" + prev: + type: string + x-stream-index: "003.003" + sort: + description: Sorting parameters for the query + items: + $ref: '#/components/schemas/SortParamRequest' + maximum: 5 + title: Sort + type: array + x-stream-index: "002" + title: Query Membership Levels Request + type: object + QueryMembershipLevelsResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "003.001" + membership_levels: + items: + $ref: '#/components/schemas/MembershipLevelResponse' + type: array + x-stream-index: "001" + next: + description: Cursor for next page + title: Next + type: string + x-stream-index: "002.001" + prev: + description: Cursor for previous page + title: Previous + type: string + x-stream-index: "002.002" + required: + - membership_levels + - duration + title: Query Membership Levels Response + type: object QueryMessageFlagsPayload: properties: filter_conditions: @@ -17689,6 +23628,72 @@ components: - logs - duration type: object + QueryModerationRulesRequest: + nullable: true + properties: + filter: + additionalProperties: {} + description: Filter conditions for moderation rules + title: Filter + type: object + x-stream-index: "001" + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "003.001" + next: + type: string + x-stream-index: "003.002" + prev: + type: string + x-stream-index: "003.003" + sort: + description: Sorting parameters for the results + items: + $ref: '#/components/schemas/SortParamRequest' + title: Sort + type: array + x-stream-index: "002" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "004.002" + user_id: + type: string + x-stream-index: "004.001" + type: object + QueryModerationRulesResponse: + nullable: true + properties: + default_llm_labels: + additionalProperties: + type: string + description: Default LLM label descriptions + title: DefaultLLMLabels + type: object + x-stream-index: "002" + duration: + type: string + x-stream-index: "004.001" + next: + type: string + x-stream-index: "003.001" + prev: + type: string + x-stream-index: "003.002" + rules: + description: List of moderation rules + items: + $ref: '#/components/schemas/ModerationRuleV2Response' + title: Rules + type: array + x-stream-index: "001" + required: + - rules + - default_llm_labels + - duration + type: object QueryPollVotesRequest: nullable: true properties: @@ -18445,6 +24450,33 @@ components: - layout title: RTMPSettingsResponse type: object + RankingConfig: + properties: + defaults: + additionalProperties: {} + description: Default values for ranking + title: Defaults + type: object + x-stream-index: "003" + functions: + additionalProperties: + $ref: '#/components/schemas/DecayFunctionConfig' + description: Decay functions configuration + title: Functions + type: object + x-stream-index: "004" + score: + description: Scoring formula + title: Score + type: string + x-stream-index: "002" + type: + description: Type of ranking algorithm + title: Type + type: string + x-stream-index: "001" + title: Ranking Configuration + type: object Reaction: nullable: true properties: @@ -18984,6 +25016,69 @@ components: $ref: '#/components/schemas/VideoOrientation' x-stream-index: "009" type: object + RejectFeedMemberInviteRequest: + nullable: true + properties: + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "003.002" + user_id: + type: string + x-stream-index: "003.001" + title: Reject Feed Member Request + type: object + RejectFeedMemberInviteResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + member: + $ref: '#/components/schemas/FeedMemberResponse' + description: The feed member after rejecting the invite + title: Feed Member + x-stream-index: "001" + required: + - member + - duration + title: Reject Feed Member Response + type: object + RejectFollowRequest: + nullable: true + properties: + source: + description: Fully qualified ID of the source feed + maxLength: 255 + title: Source Feed ID + type: string + x-stream-index: "001" + target: + description: Fully qualified ID of the target feed + maxLength: 255 + title: Target Feed ID + type: string + x-stream-index: "002" + required: + - source + - target + title: Reject Follow Request + type: object + RejectFollowResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + follow: + $ref: '#/components/schemas/FollowResponse' + description: The rejected follow relationship + title: Follow + x-stream-index: "001" + required: + - follow + - duration + title: Reject Follow Response + type: object ReminderCreatedEvent: description: Emitted when a reminder is created. nullable: true @@ -19273,6 +25368,38 @@ components: x-stream-event-doc-group: other x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent + RepliesMeta: + description: Cursor & depth information for a comment's direct replies. Mirrors + Reddit's 'load more replies' semantics. + properties: + depth_truncated: + description: True if the subtree was cut because the requested depth was + reached. + title: Depth Truncated + type: boolean + x-stream-index: "004" + has_more: + description: True if more siblings exist in the database. + title: Has More + type: boolean + x-stream-index: "001" + next_cursor: + description: Opaque cursor to request the next page of siblings. + title: Next Cursor + type: string + x-stream-index: "002" + remaining: + description: Number of unread siblings that match current filters. + format: int32 + title: Remaining + type: integer + x-stream-index: "003" + required: + - has_more + - remaining + - depth_truncated + title: Replies Meta + type: object ReportByHistogramBucket: properties: category: @@ -19529,7 +25656,7 @@ components: flags: description: The flags associated with this review queue item items: - $ref: '#/components/schemas/FlagResponse' + $ref: '#/components/schemas/ModerationFlagResponse' title: Flags type: array x-stream-index: "003" @@ -19636,7 +25763,7 @@ components: flags: description: Associated flag records items: - $ref: '#/components/schemas/FlagResponse' + $ref: '#/components/schemas/ModerationFlagResponse' title: Flags type: array x-stream-index: "023" @@ -19746,7 +25873,7 @@ components: flags: description: The flags associated with this review queue item items: - $ref: '#/components/schemas/FlagResponse' + $ref: '#/components/schemas/ModerationFlagResponse' title: Flags type: array x-stream-index: "003" @@ -19901,8 +26028,6 @@ components: type: type: string x-stream-index: "001" - required: - - type type: object RuleBuilderCondition: properties: @@ -19931,6 +26056,9 @@ components: user_created_within_params: $ref: '#/components/schemas/UserCreatedWithinParameters' x-stream-index: "011" + user_custom_property_params: + $ref: '#/components/schemas/UserCustomPropertyParameters' + x-stream-index: "012" user_rule_params: $ref: '#/components/schemas/UserRuleParameters' x-stream-index: "006" @@ -19940,8 +26068,6 @@ components: video_rule_params: $ref: '#/components/schemas/VideoRuleParameters' x-stream-index: "005" - required: - - type type: object RuleBuilderConditionGroup: properties: @@ -19953,9 +26079,6 @@ components: logic: type: string x-stream-index: "001" - required: - - logic - - conditions type: object RuleBuilderConfig: properties: @@ -19967,48 +26090,37 @@ components: $ref: '#/components/schemas/RuleBuilderRule' type: array x-stream-index: "002" - required: - - rules type: object RuleBuilderRule: properties: action: $ref: '#/components/schemas/RuleBuilderAction' - x-stream-index: "007" + x-stream-index: "006" conditions: items: $ref: '#/components/schemas/RuleBuilderCondition' type: array - x-stream-index: "004" + x-stream-index: "003" cooldown_period: type: string - x-stream-index: "009" - enabled: - type: boolean - x-stream-index: "008" + x-stream-index: "007" groups: items: $ref: '#/components/schemas/RuleBuilderConditionGroup' type: array - x-stream-index: "006" + x-stream-index: "005" id: type: string x-stream-index: "001" logic: type: string - x-stream-index: "005" - name: - type: string - x-stream-index: "002" + x-stream-index: "004" rule_type: type: string - x-stream-index: "003" + x-stream-index: "002" required: - - id - - name - rule_type - action - - enabled type: object S3Request: description: Config for creating Amazon S3 storage. @@ -20276,6 +26388,9 @@ components: format: date-time type: number x-stream-index: "001.025" + deleted_for_me: + type: boolean + x-stream-index: "001.044" deleted_reply_count: format: int32 type: integer @@ -20985,6 +27100,22 @@ components: - duration title: Response type: object + SingleFollowResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + follow: + $ref: '#/components/schemas/FollowResponse' + description: The created follow relationship + title: Follow + x-stream-index: "001" + required: + - follow + - duration + title: Follow Response + type: object SortParam: nullable: true properties: @@ -21441,6 +27572,20 @@ components: - duration title: Response type: object + StoriesConfig: + properties: + expiration_behaviour: + description: Behavior when stories expire + title: Expiration Behavior + type: string + x-stream-index: "001" + skip_watched: + description: Whether to skip already watched stories + title: Skip Watched + type: boolean + x-stream-index: "002" + title: Stories Configuration + type: object SubmitActionRequest: nullable: true properties: @@ -21625,18 +27770,23 @@ components: items: type: string type: array - x-stream-index: "004" + x-stream-index: "005" contains_url: type: boolean - x-stream-index: "002" + x-stream-index: "003" harm_labels: items: type: string type: array x-stream-index: "001" + llm_harm_labels: + additionalProperties: + type: string + type: object + x-stream-index: "002" severity: type: string - x-stream-index: "003" + x-stream-index: "004" type: object TextRuleParameters: properties: @@ -21644,18 +27794,23 @@ components: items: type: string type: array - x-stream-index: "006" + x-stream-index: "007" contains_url: type: boolean - x-stream-index: "004" + x-stream-index: "005" harm_labels: items: type: string type: array x-stream-index: "003" + llm_harm_labels: + additionalProperties: + type: string + type: object + x-stream-index: "004" severity: type: string - x-stream-index: "005" + x-stream-index: "006" threshold: format: int32 type: integer @@ -21663,9 +27818,6 @@ components: time_window: type: string x-stream-index: "002" - required: - - threshold - - time_window type: object ThreadParticipant: description: Represents a user that is participating in a thread. @@ -21980,6 +28132,132 @@ components: x-stream-event-doc-group: other x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent + ThreadedCommentResponse: + description: A comment with an optional, depth‑limited slice of nested replies. + properties: + attachments: + items: + $ref: '#/components/schemas/Attachment' + type: array + x-stream-index: "001.011" + confidence_score: + format: float + type: number + x-stream-index: "001.022" + controversy_score: + format: float + type: number + x-stream-index: "001.023" + created_at: + format: date-time + type: number + x-stream-index: "001.014" + custom: + additionalProperties: {} + type: object + x-stream-index: "001.006" + deleted_at: + format: date-time + type: number + x-stream-index: "001.016" + downvote_count: + format: int32 + type: integer + x-stream-index: "001.020" + id: + type: string + x-stream-index: "001.001" + latest_reactions: + items: + $ref: '#/components/schemas/FeedsReactionResponse' + type: array + x-stream-index: "001.009" + mentioned_users: + items: + $ref: '#/components/schemas/UserResponse' + type: array + x-stream-index: "001.012" + meta: + $ref: '#/components/schemas/RepliesMeta' + description: Pagination & depth info for this node's direct replies. + title: Replies Meta + x-stream-index: "002" + moderation: + $ref: '#/components/schemas/ModerationV2Response' + x-stream-index: "001.017" + object_id: + type: string + x-stream-index: "001.002" + object_type: + type: string + x-stream-index: "001.003" + own_reactions: + items: + $ref: '#/components/schemas/FeedsReactionResponse' + type: array + x-stream-index: "001.024" + parent_id: + type: string + x-stream-index: "001.007" + reaction_count: + format: int32 + type: integer + x-stream-index: "001.008" + reaction_groups: + additionalProperties: + $ref: '#/components/schemas/ReactionGroupResponse' + type: object + x-stream-index: "001.010" + replies: + description: Slice of nested comments (may be empty). + items: + $ref: '#/components/schemas/ThreadedCommentResponse' + title: Replies + type: array + x-stream-index: "003" + reply_count: + format: int32 + type: integer + x-stream-index: "001.018" + score: + format: int32 + type: integer + x-stream-index: "001.021" + status: + type: string + x-stream-index: "001.013" + text: + type: string + x-stream-index: "001.005" + updated_at: + format: date-time + type: number + x-stream-index: "001.015" + upvote_count: + format: int32 + type: integer + x-stream-index: "001.019" + user: + $ref: '#/components/schemas/UserResponse' + x-stream-index: "001.004" + required: + - id + - object_id + - object_type + - user + - reaction_count + - mentioned_users + - status + - created_at + - updated_at + - reply_count + - upvote_count + - downvote_count + - score + - confidence_score + - own_reactions + title: Threaded Comment + type: object Thresholds: description: Sets thresholds for AI moderation properties: @@ -22492,6 +28770,56 @@ components: x-stream-event-doc-group: call x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent + UnfollowBatchRequest: + nullable: true + properties: + follows: + description: List of follow relationships to remove + items: + $ref: '#/components/schemas/FollowPair' + maximum: 100 + minimum: 1 + title: Follows + type: array + x-stream-index: "001" + required: + - follows + title: Unfollow Batch Request + type: object + UnfollowBatchResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + follows: + description: List of follow relationships that were removed + items: + $ref: '#/components/schemas/FollowResponse' + title: Follows + type: array + x-stream-index: "001" + required: + - follows + - duration + title: Unfollow Batch Response + type: object + UnfollowResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + follow: + $ref: '#/components/schemas/FollowResponse' + description: The deleted follow relationship + title: Follow + x-stream-index: "001" + required: + - follow + - duration + title: Unfollow Response + type: object UnmuteChannelRequest: nullable: true properties: @@ -22553,6 +28881,34 @@ components: - duration title: Response type: object + UnpinActivityResponse: + nullable: true + properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + description: The unpinned activity + title: Activity + x-stream-index: "001" + duration: + type: string + x-stream-index: "004.001" + feed: + description: Fully qualified ID of the feed the activity was unpinned from + title: Feed ID + type: string + x-stream-index: "002" + user_id: + description: ID of the user who unpinned the activity + title: User ID + type: string + x-stream-index: "003" + required: + - activity + - feed + - user_id + - duration + title: Unpin Activity Response + type: object UnpinRequest: description: UnpinRequest is the payload for unpinning a message. nullable: true @@ -22713,6 +29069,122 @@ components: - last_read_message_id - parent_message_id type: object + UpdateActivityPartialRequest: + nullable: true + properties: + set: + additionalProperties: {} + description: Map of dot-notation field paths to new values + title: object + type: object + x-stream-index: "002" + unset: + description: List of dot-notation paths to remove + items: + type: string + title: '[]string' + type: array + x-stream-index: "003" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "005.002" + user_id: + type: string + x-stream-index: "005.001" + type: object + UpdateActivityPartialResponse: + nullable: true + properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + description: The updated activity + title: ActivityResponse + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - activity + - duration + type: object + UpdateActivityRequest: + nullable: true + properties: + attachments: + description: List of attachments for the activity + items: + $ref: '#/components/schemas/Attachment' + title: '[]ActivityAttachment' + type: array + x-stream-index: "003" + custom: + additionalProperties: {} + description: Custom data for the activity + title: object + type: object + x-stream-index: "004" + expires_at: + description: Time when the activity will expire + format: date-time + title: string + type: number + x-stream-index: "007" + filter_tags: + description: Tags used for filtering the activity + items: + type: string + title: '[]string' + type: array + x-stream-index: "008" + interest_tags: + description: Tags indicating interest categories + items: + type: string + title: '[]string' + type: array + x-stream-index: "009" + location: + $ref: '#/components/schemas/ActivityLocation' + description: Geographic location for the activity + title: ActivityLocation + x-stream-index: "006" + poll_id: + description: Poll ID + title: string + type: string + x-stream-index: "010" + text: + description: The text content of the activity + title: string + type: string + x-stream-index: "002" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "012.002" + user_id: + type: string + x-stream-index: "012.001" + visibility: + description: Visibility setting for the activity + title: string + type: string + x-stream-index: "005" + type: object + UpdateActivityResponse: + nullable: true + properties: + activity: + $ref: '#/components/schemas/ActivityResponse' + description: The updated activity + title: ActivityResponse + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - activity + - duration + type: object UpdateAppRequest: nullable: true properties: @@ -22810,6 +29282,10 @@ components: image_upload_config: $ref: '#/components/schemas/FileUploadConfig' x-stream-index: "001.029" + max_aggregated_activities_length: + format: int32 + type: integer + x-stream-index: "001.049" migrate_permissions_to_v2: type: boolean x-stream-index: "001.035" @@ -22920,6 +29396,91 @@ components: - duration title: Response type: object + UpdateBookmarkFolderRequest: + nullable: true + properties: + custom: + additionalProperties: {} + description: Custom data for the folder + title: Custom Data + type: object + x-stream-index: "003" + name: + description: Name of the folder + maxLength: 255 + title: Name + type: string + x-stream-index: "002" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "004.002" + user_id: + type: string + x-stream-index: "004.001" + title: Update Bookmark Folder Request + type: object + UpdateBookmarkFolderResponse: + nullable: true + properties: + bookmark_folder: + $ref: '#/components/schemas/BookmarkFolderResponse' + description: The updated bookmark folder + title: Bookmark Folder + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - bookmark_folder + - duration + title: Update Bookmark Folder Response + type: object + UpdateBookmarkRequest: + nullable: true + properties: + custom: + additionalProperties: {} + description: Custom data for the bookmark + title: Custom Data + type: object + x-stream-index: "005" + folder_id: + description: ID of the folder to move the bookmark to + maxLength: 255 + title: Folder ID + type: string + x-stream-index: "002" + new_folder: + $ref: '#/components/schemas/AddFolderRequest' + x-stream-index: "004" + new_folder_id: + maxLength: 255 + type: string + x-stream-index: "003" + user: + $ref: '#/components/schemas/UserRequest' + x-stream-index: "006.002" + user_id: + type: string + x-stream-index: "006.001" + title: Update Bookmark Request + type: object + UpdateBookmarkResponse: + nullable: true + properties: + bookmark: + $ref: '#/components/schemas/BookmarkResponse' + description: The updated bookmark + title: Bookmark + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - bookmark + - duration + title: Update Bookmark Response + type: object UpdateCallMembersRequest: description: Update call members nullable: true @@ -23269,39 +29830,39 @@ components: items: type: string type: array - x-stream-index: 009.001.026 + x-stream-index: 009.001.027 automod: enum: - disabled - simple - AI type: string - x-stream-index: 009.001.021 + x-stream-index: 009.001.022 automod_behavior: enum: - flag - block - shadow_block type: string - x-stream-index: 009.001.022 + x-stream-index: 009.001.023 automod_thresholds: $ref: '#/components/schemas/Thresholds' - x-stream-index: 009.001.027 + x-stream-index: 009.001.028 blocklist: type: string - x-stream-index: 009.001.023 + x-stream-index: 009.001.024 blocklist_behavior: enum: - flag - block - shadow_block type: string - x-stream-index: 009.001.024 + x-stream-index: 009.001.025 blocklists: items: $ref: '#/components/schemas/BlockListOptions' type: array - x-stream-index: 009.001.025 + x-stream-index: 009.001.026 commands: description: List of commands that channel supports items: @@ -23312,6 +29873,9 @@ components: connect_events: type: boolean x-stream-index: 009.001.004 + count_messages: + type: boolean + x-stream-index: 009.001.019 custom_events: type: boolean x-stream-index: 009.001.012 @@ -23329,7 +29893,7 @@ components: format: int32 maximum: 20000 type: integer - x-stream-index: 009.001.020 + x-stream-index: 009.001.021 mutes: type: boolean x-stream-index: 009.001.009 @@ -23378,7 +29942,7 @@ components: x-stream-index: 009.001.018 skip_last_msg_update_for_system_msgs: type: boolean - x-stream-index: 009.001.030 + x-stream-index: 009.001.031 typing_events: type: boolean x-stream-index: 009.001.002 @@ -23403,39 +29967,39 @@ components: items: type: string type: array - x-stream-index: 003.001.026 + x-stream-index: 003.001.027 automod: enum: - disabled - simple - AI type: string - x-stream-index: 003.001.021 + x-stream-index: 003.001.022 automod_behavior: enum: - flag - block - shadow_block type: string - x-stream-index: 003.001.022 + x-stream-index: 003.001.023 automod_thresholds: $ref: '#/components/schemas/Thresholds' - x-stream-index: 003.001.027 + x-stream-index: 003.001.028 blocklist: type: string - x-stream-index: 003.001.023 + x-stream-index: 003.001.024 blocklist_behavior: enum: - flag - block - shadow_block type: string - x-stream-index: 003.001.024 + x-stream-index: 003.001.025 blocklists: items: $ref: '#/components/schemas/BlockListOptions' type: array - x-stream-index: 003.001.025 + x-stream-index: 003.001.026 commands: items: type: string @@ -23444,6 +30008,9 @@ components: connect_events: type: boolean x-stream-index: 003.001.004 + count_messages: + type: boolean + x-stream-index: 003.001.019 created_at: format: date-time type: number @@ -23468,7 +30035,7 @@ components: format: int32 maximum: 20000 type: integer - x-stream-index: 003.001.020 + x-stream-index: 003.001.021 mutes: type: boolean x-stream-index: 003.001.009 @@ -23478,13 +30045,13 @@ components: partition_size: format: int32 type: integer - x-stream-index: 003.001.028 + x-stream-index: 003.001.029 partition_ttl: example: 24h format: duration nullable: true type: string - x-stream-index: 003.001.029 + x-stream-index: 003.001.030 permissions: items: $ref: '#/components/schemas/PolicyRequest' @@ -23519,7 +30086,7 @@ components: x-stream-index: 003.001.018 skip_last_msg_update_for_system_msgs: type: boolean - x-stream-index: 003.001.030 + x-stream-index: 003.001.031 typing_events: type: boolean x-stream-index: 003.001.002 @@ -23557,6 +30124,7 @@ components: - polls - user_message_reminders - shared_locations + - count_messages - message_retention - max_message_length - automod @@ -23607,6 +30175,41 @@ components: - duration title: UpdateCommandResponse type: object + UpdateCommentRequest: + nullable: true + properties: + comment: + description: Updated text content of the comment + title: Comment + type: string + x-stream-index: "002" + custom: + additionalProperties: {} + description: Updated custom data for the comment + title: Custom Data + type: object + x-stream-index: "003" + skip_push: + type: boolean + x-stream-index: "004" + title: Update Comment Request + type: object + UpdateCommentResponse: + nullable: true + properties: + comment: + $ref: '#/components/schemas/CommentResponse' + description: The updated comment + title: Comment + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - comment + - duration + title: Update Comment Response + type: object UpdateExternalStorageRequest: description: External storage nullable: true @@ -23681,6 +30284,271 @@ components: - duration title: Response type: object + UpdateFeedGroupRequest: + nullable: true + properties: + activity_processors: + description: Configuration for activity processors (max 10) + items: + $ref: '#/components/schemas/ActivityProcessorConfig' + maximum: 10 + title: Activity Processors + type: array + x-stream-index: "005" + activity_selectors: + description: Configuration for activity selectors (max 10) + items: + $ref: '#/components/schemas/ActivitySelectorConfig' + maximum: 10 + title: Activity Selectors + type: array + x-stream-index: "006" + aggregation: + $ref: '#/components/schemas/AggregationConfig' + description: Configuration for activity aggregation + title: Aggregation + x-stream-index: "008" + custom: + additionalProperties: {} + description: Custom data for the feed group + title: Custom Data + type: object + x-stream-index: "004" + notification: + $ref: '#/components/schemas/NotificationConfig' + description: Configuration for notifications + title: Notification + x-stream-index: "002" + push_notification: + $ref: '#/components/schemas/PushNotificationConfig' + x-stream-index: "003" + ranking: + $ref: '#/components/schemas/RankingConfig' + description: Configuration for activity ranking + title: Ranking + x-stream-index: "007" + title: Update Feed Group Request + type: object + UpdateFeedGroupResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + feed_group: + $ref: '#/components/schemas/FeedGroupResponse' + description: The updated feed group + title: Feed Group + x-stream-index: "001" + required: + - feed_group + - duration + title: Update Feed Group Response + type: object + UpdateFeedMembersRequest: + nullable: true + properties: + limit: + format: int32 + maximum: 100 + minimum: 0 + type: integer + x-stream-index: "006.001" + members: + description: List of members to upsert, remove, or set + items: + $ref: '#/components/schemas/FeedMemberRequest' + title: Members + type: array + x-stream-index: "004" + next: + type: string + x-stream-index: "006.002" + operation: + description: Type of update operation to perform + enum: + - upsert + - remove + - set + title: Operation + type: string + x-stream-index: "003" + prev: + type: string + x-stream-index: "006.003" + required: + - operation + title: Update Feed Members Request + type: object + UpdateFeedMembersResponse: + description: Basic response information + nullable: true + properties: + added: + items: + $ref: '#/components/schemas/FeedMemberResponse' + type: array + x-stream-index: "001" + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "004.001" + removed_ids: + items: + type: string + type: array + x-stream-index: "003" + updated: + items: + $ref: '#/components/schemas/FeedMemberResponse' + type: array + x-stream-index: "002" + required: + - added + - updated + - removed_ids + - duration + title: Response + type: object + UpdateFeedRequest: + nullable: true + properties: + created_by_id: + description: ID of the new feed creator (owner) + title: Created By ID + type: string + x-stream-index: "003" + custom: + additionalProperties: {} + description: Custom data for the feed + title: Custom Data + type: object + x-stream-index: "004" + title: Update Feed Request + type: object + UpdateFeedResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + feed: + $ref: '#/components/schemas/FeedResponse' + description: The updated feed + title: Feed + x-stream-index: "001" + required: + - feed + - duration + title: Update Feed Response + type: object + UpdateFeedViewRequest: + nullable: true + properties: + activity_processors: + description: Updated activity processors + items: + $ref: '#/components/schemas/ActivityProcessorConfig' + title: Activity Processors + type: array + x-stream-index: "002.002" + activity_selectors: + description: Updated configuration for selecting activities + items: + $ref: '#/components/schemas/ActivitySelectorConfig' + title: Activity Selectors + type: array + x-stream-index: "002.001" + aggregation: + $ref: '#/components/schemas/AggregationConfig' + description: Updated configuration for aggregating activities + title: Aggregation + x-stream-index: "002.004" + ranking: + $ref: '#/components/schemas/RankingConfig' + description: Updated configuration for ranking activities + title: Ranking + x-stream-index: "002.003" + title: Update Feed View Request + type: object + UpdateFeedViewResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + feed_view: + $ref: '#/components/schemas/FeedViewResponse' + description: The updated feed view + title: Feed View + x-stream-index: "001" + required: + - feed_view + - duration + title: Update Feed View Response + type: object + UpdateFollowRequest: + nullable: true + properties: + create_notification_activity: + description: Whether to create a notification activity for this follow + title: Create Notification Activity + type: boolean + x-stream-index: "001.004" + custom: + additionalProperties: {} + description: Custom data for the follow relationship + title: Custom Data + type: object + x-stream-index: "001.002" + follower_role: + type: string + x-stream-index: "002" + push_preference: + description: Push preference for the follow relationship + enum: + - all + - none + title: Push Preference + type: string + x-stream-index: "001.003" + skip_push: + type: boolean + x-stream-index: "001.005" + source: + description: Fully qualified ID of the source feed + maxLength: 255 + title: Source Feed + type: string + x-stream-index: 001.001.001 + target: + description: Fully qualified ID of the target feed + maxLength: 255 + title: Target Feed + type: string + x-stream-index: 001.001.002 + required: + - source + - target + title: Update Follow Request + type: object + UpdateFollowResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + follow: + $ref: '#/components/schemas/FollowResponse' + description: Details of the updated follow relationship + title: Follow + x-stream-index: "001" + required: + - follow + - duration + title: Update Follow Response + type: object UpdateLiveLocationRequest: nullable: true properties: @@ -23743,6 +30611,62 @@ components: required: - duration type: object + UpdateMembershipLevelRequest: + description: Partial update request for membership level fields. Only specified + fields will be updated. + nullable: true + properties: + custom: + additionalProperties: {} + description: Custom data for the membership level + title: Custom Data + type: object + x-stream-index: "006" + description: + description: Optional description of the membership level + maxLength: 1000 + title: Description + type: string + x-stream-index: "003" + name: + description: Display name for the membership level + maxLength: 255 + title: Name + type: string + x-stream-index: "002" + priority: + description: Priority level (higher numbers = higher priority) + format: int32 + minimum: 0 + title: Priority + type: integer + x-stream-index: "004" + tags: + description: Activity tags this membership level gives access to + items: + type: string + maximum: 255 + title: Tags + type: array + x-stream-index: "005" + title: Update Membership Level Request + type: object + UpdateMembershipLevelResponse: + nullable: true + properties: + duration: + type: string + x-stream-index: "002.001" + membership_level: + $ref: '#/components/schemas/MembershipLevelResponse' + description: The updated membership level + title: Membership Level + x-stream-index: "001" + required: + - membership_level + - duration + title: Update Membership Level Response + type: object UpdateMessagePartialRequest: nullable: true properties: @@ -24191,6 +31115,40 @@ components: x-stream-event-doc-group: call x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent + UpsertActivitiesRequest: + nullable: true + properties: + activities: + description: List of activities to create or update + items: + $ref: '#/components/schemas/ActivityRequest' + maximum: 100 + minimum: 1 + title: Activities + type: array + x-stream-index: "001" + required: + - activities + title: Upsert Activities Request + type: object + UpsertActivitiesResponse: + nullable: true + properties: + activities: + description: List of created or updated activities + items: + $ref: '#/components/schemas/ActivityResponse' + title: Activities + type: array + x-stream-index: "001" + duration: + type: string + x-stream-index: "002.001" + required: + - activities + - duration + title: Upsert Activities Response + type: object UpsertConfigRequest: nullable: true properties: @@ -24198,7 +31156,7 @@ components: $ref: '#/components/schemas/AIImageConfig' description: Configuration for AI image analysis title: AI Image Config - x-stream-index: "010" + x-stream-index: "011" ai_text_config: $ref: '#/components/schemas/AITextConfig' description: Configuration for AI text analysis @@ -24208,7 +31166,7 @@ components: $ref: '#/components/schemas/AIVideoConfig' description: Configuration for AI video analysis title: AI Video Config - x-stream-index: "011" + x-stream-index: "012" async: description: Whether moderation should be performed asynchronously title: Async @@ -24231,7 +31189,7 @@ components: x-stream-index: "004" aws_rekognition_config: $ref: '#/components/schemas/AIImageConfig' - x-stream-index: "015" + x-stream-index: "016" block_list_config: $ref: '#/components/schemas/BlockListConfig' description: Configuration for block list filtering @@ -24239,23 +31197,28 @@ components: x-stream-index: "007" bodyguard_config: $ref: '#/components/schemas/AITextConfig' - x-stream-index: "014" + x-stream-index: "015" google_vision_config: $ref: '#/components/schemas/GoogleVisionConfig' description: Configuration for Google Vision integration title: Google Vision Config - x-stream-index: "009" + x-stream-index: "010" key: description: Unique identifier for the moderation configuration title: Key type: string x-stream-index: "001" + llm_config: + $ref: '#/components/schemas/LLMConfig' + description: Configuration for customer-configured LLM moderation + title: LLM Config + x-stream-index: "009" rule_builder_config: $ref: '#/components/schemas/RuleBuilderConfig' description: Configuration for custom rule builder (max 3 rules, max 5 conditions per rule) title: Rule Builder Config - x-stream-index: "013" + x-stream-index: "014" team: description: Team associated with the configuration maxLength: 128 @@ -24265,18 +31228,18 @@ components: x-stream-index: "002" user: $ref: '#/components/schemas/UserRequest' - x-stream-index: "017.002" + x-stream-index: "018.002" user_id: type: string - x-stream-index: "017.001" + x-stream-index: "018.001" velocity_filter_config: $ref: '#/components/schemas/VelocityFilterConfig' description: Configuration for velocity-based filtering title: Velocity Filter Config - x-stream-index: "012" + x-stream-index: "013" video_call_rule_config: $ref: '#/components/schemas/VideoCallRuleConfig' - x-stream-index: "016" + x-stream-index: "017" required: - key type: object @@ -24294,6 +31257,69 @@ components: required: - duration type: object + UpsertModerationRuleRequest: + nullable: true + properties: + action: + $ref: '#/components/schemas/RuleBuilderAction' + x-stream-index: "009" + conditions: + items: + $ref: '#/components/schemas/RuleBuilderCondition' + type: array + x-stream-index: "006" + config_keys: + items: + type: string + type: array + x-stream-index: "003" + cooldown_period: + type: string + x-stream-index: "010" + description: + type: string + x-stream-index: "002" + enabled: + type: boolean + x-stream-index: "011" + groups: + items: + $ref: '#/components/schemas/RuleBuilderConditionGroup' + type: array + x-stream-index: "008" + logic: + type: string + x-stream-index: "007" + name: + type: string + x-stream-index: "001" + rule_type: + type: string + x-stream-index: "005" + team: + type: string + x-stream-index: "004" + required: + - name + - rule_type + - action + type: object + UpsertModerationRuleResponse: + description: Basic response information + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "001.001" + rule: + $ref: '#/components/schemas/ModerationRuleV2Response' + x-stream-index: "002" + required: + - duration + title: Response + type: object UpsertModerationTemplateRequest: nullable: true properties: @@ -24427,6 +31453,12 @@ components: - message.updated - reaction.new - notification.reminder_due + - feeds.activity.added + - feeds.comment.added + - feeds.activity.reaction.added + - feeds.comment.reaction.added + - feeds.follow.created + - feeds.notification_feed.updated title: string type: string x-stream-index: "003" @@ -24627,6 +31659,15 @@ components: required: - type type: object + UserCustomPropertyParameters: + properties: + operator: + type: string + x-stream-index: "002" + property_key: + type: string + x-stream-index: "001" + type: object UserDeactivatedEvent: properties: created_at: @@ -24784,6 +31825,84 @@ components: x-stream-event-doc-group: other x-stream-is-event: true x-stream-ws-base-event-name: VideoEvent + UserMessagesDeletedEvent: + description: This event is sent when a user's message get deleted. The event + contains information about the user whose messages got deleted. + nullable: true + properties: + channel_custom: + additionalProperties: {} + type: object + x-stream-index: 001.001.005 + channel_id: + description: The ID of the channel where the target user's messages were + deleted + title: Channel ID + type: string + x-stream-index: 001.002.002 + channel_member_count: + format: int32 + type: integer + x-stream-index: 001.001.004 + channel_type: + description: The type of the channel where the target user's messages were + deleted + title: Channel Type + type: string + x-stream-index: 001.002.001 + cid: + description: The CID of the channel where the target user's messages were + deleted + 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: number + x-stream-index: 001.001.001.001.003 + custom: + additionalProperties: {} + type: object + x-stream-index: 001.001.001.001.007 + hard_delete: + description: Whether Messages were hard deleted + title: Hard Delete + type: boolean + x-stream-index: "003" + received_at: + format: date-time + type: number + x-stream-index: 001.001.001.001.004 + team: + description: The team of the channel where the target user's messages were + deleted + title: Team + type: string + x-stream-index: 001.001.003 + type: + default: user.messages.deleted + description: 'The type of event: "user.messages.deleted" in this case' + title: Event Type + type: string + x-stream-index: 001.001.001.001.002 + user: + $ref: '#/components/schemas/UserResponseCommonFields' + description: The target user whose messages got deleted + title: User + x-stream-index: "002.001" + required: + - type + - created_at + - custom + - user + title: UserMessagesDeletedEvent + 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 UserMute: nullable: true properties: @@ -25601,9 +32720,6 @@ components: time_window: type: string x-stream-index: "002" - required: - - threshold - - time_window type: object VideoSettings: properties: @@ -25811,6 +32927,7 @@ components: call.hls_broadcasting_failed: '#/components/schemas/CallHLSBroadcastingFailedEvent' call.hls_broadcasting_started: '#/components/schemas/CallHLSBroadcastingStartedEvent' call.hls_broadcasting_stopped: '#/components/schemas/CallHLSBroadcastingStoppedEvent' + call.kicked_user: '#/components/schemas/KickedUserEvent' call.live_started: '#/components/schemas/CallLiveStartedEvent' call.member_added: '#/components/schemas/CallMemberAddedEvent' call.member_removed: '#/components/schemas/CallMemberRemovedEvent' @@ -25867,6 +32984,39 @@ components: export.moderation_logs.success: '#/components/schemas/AsyncExportModerationLogsEvent' export.users.error: '#/components/schemas/AsyncExportErrorEvent' export.users.success: '#/components/schemas/AsyncExportUsersEvent' + feeds.activity.added: '#/components/schemas/ActivityAddedEvent' + feeds.activity.deleted: '#/components/schemas/ActivityDeletedEvent' + feeds.activity.marked: '#/components/schemas/ActivityMarkEvent' + feeds.activity.pinned: '#/components/schemas/ActivityPinnedEvent' + feeds.activity.reaction.added: '#/components/schemas/ActivityReactionAddedEvent' + feeds.activity.reaction.deleted: '#/components/schemas/ActivityReactionDeletedEvent' + feeds.activity.reaction.updated: '#/components/schemas/ActivityReactionUpdatedEvent' + feeds.activity.removed_from_feed: '#/components/schemas/ActivityRemovedFromFeedEvent' + feeds.activity.unpinned: '#/components/schemas/ActivityUnpinnedEvent' + feeds.activity.updated: '#/components/schemas/ActivityUpdatedEvent' + feeds.bookmark.added: '#/components/schemas/BookmarkAddedEvent' + feeds.bookmark.deleted: '#/components/schemas/BookmarkDeletedEvent' + feeds.bookmark.updated: '#/components/schemas/BookmarkUpdatedEvent' + feeds.bookmark_folder.deleted: '#/components/schemas/BookmarkFolderDeletedEvent' + feeds.bookmark_folder.updated: '#/components/schemas/BookmarkFolderUpdatedEvent' + feeds.comment.added: '#/components/schemas/CommentAddedEvent' + feeds.comment.deleted: '#/components/schemas/CommentDeletedEvent' + feeds.comment.reaction.added: '#/components/schemas/CommentReactionAddedEvent' + feeds.comment.reaction.deleted: '#/components/schemas/CommentReactionDeletedEvent' + feeds.comment.reaction.updated: '#/components/schemas/CommentReactionUpdatedEvent' + feeds.comment.updated: '#/components/schemas/CommentUpdatedEvent' + feeds.feed.created: '#/components/schemas/FeedCreatedEvent' + feeds.feed.deleted: '#/components/schemas/FeedDeletedEvent' + feeds.feed.updated: '#/components/schemas/FeedUpdatedEvent' + feeds.feed_group.changed: '#/components/schemas/FeedGroupChangedEvent' + feeds.feed_group.deleted: '#/components/schemas/FeedGroupDeletedEvent' + feeds.feed_member.added: '#/components/schemas/FeedMemberAddedEvent' + feeds.feed_member.removed: '#/components/schemas/FeedMemberRemovedEvent' + feeds.feed_member.updated: '#/components/schemas/FeedMemberUpdatedEvent' + feeds.follow.created: '#/components/schemas/FollowCreatedEvent' + feeds.follow.deleted: '#/components/schemas/FollowDeletedEvent' + feeds.follow.updated: '#/components/schemas/FollowUpdatedEvent' + feeds.notification_feed.updated: '#/components/schemas/NotificationFeedUpdatedEvent' flag.updated: '#/components/schemas/FlagUpdatedEvent' member.added: '#/components/schemas/MemberAddedEvent' member.removed: '#/components/schemas/MemberRemovedEvent' @@ -25899,6 +33049,7 @@ components: user.deactivated: '#/components/schemas/UserDeactivatedEvent' user.deleted: '#/components/schemas/UserDeletedEvent' user.flagged: '#/components/schemas/UserFlaggedEvent' + user.messages.deleted: '#/components/schemas/UserMessagesDeletedEvent' user.muted: '#/components/schemas/UserMutedEvent' user.reactivated: '#/components/schemas/UserReactivatedEvent' user.unbanned: '#/components/schemas/UserUnbannedEvent' @@ -25907,7 +33058,17 @@ components: user.updated: '#/components/schemas/UserUpdatedEvent' propertyName: type oneOf: + - $ref: '#/components/schemas/ActivityAddedEvent' + - $ref: '#/components/schemas/ActivityDeletedEvent' + - $ref: '#/components/schemas/ActivityMarkEvent' - $ref: '#/components/schemas/ActivityMarkedEvent' + - $ref: '#/components/schemas/ActivityPinnedEvent' + - $ref: '#/components/schemas/ActivityReactionAddedEvent' + - $ref: '#/components/schemas/ActivityReactionDeletedEvent' + - $ref: '#/components/schemas/ActivityReactionUpdatedEvent' + - $ref: '#/components/schemas/ActivityRemovedFromFeedEvent' + - $ref: '#/components/schemas/ActivityUnpinnedEvent' + - $ref: '#/components/schemas/ActivityUpdatedEvent' - $ref: '#/components/schemas/AnyEvent' - $ref: '#/components/schemas/AsyncBulkImageModerationEvent' - $ref: '#/components/schemas/AsyncExportChannelsEvent' @@ -25918,6 +33079,11 @@ components: - $ref: '#/components/schemas/AsyncExportModerationLogsEvent' - $ref: '#/components/schemas/AsyncExportUsersEvent' - $ref: '#/components/schemas/BlockedUserEvent' + - $ref: '#/components/schemas/BookmarkAddedEvent' + - $ref: '#/components/schemas/BookmarkDeletedEvent' + - $ref: '#/components/schemas/BookmarkFolderDeletedEvent' + - $ref: '#/components/schemas/BookmarkFolderUpdatedEvent' + - $ref: '#/components/schemas/BookmarkUpdatedEvent' - $ref: '#/components/schemas/CallAcceptedEvent' - $ref: '#/components/schemas/CallClosedCaptionsFailedEvent' - $ref: '#/components/schemas/CallClosedCaptionsStartedEvent' @@ -25977,8 +33143,26 @@ components: - $ref: '#/components/schemas/ChannelUpdatedEvent' - $ref: '#/components/schemas/ChannelVisibleEvent' - $ref: '#/components/schemas/ClosedCaptionEvent' + - $ref: '#/components/schemas/CommentAddedEvent' + - $ref: '#/components/schemas/CommentDeletedEvent' + - $ref: '#/components/schemas/CommentReactionAddedEvent' + - $ref: '#/components/schemas/CommentReactionDeletedEvent' + - $ref: '#/components/schemas/CommentReactionUpdatedEvent' + - $ref: '#/components/schemas/CommentUpdatedEvent' - $ref: '#/components/schemas/CustomVideoEvent' + - $ref: '#/components/schemas/FeedCreatedEvent' + - $ref: '#/components/schemas/FeedDeletedEvent' + - $ref: '#/components/schemas/FeedGroupChangedEvent' + - $ref: '#/components/schemas/FeedGroupDeletedEvent' + - $ref: '#/components/schemas/FeedMemberAddedEvent' + - $ref: '#/components/schemas/FeedMemberRemovedEvent' + - $ref: '#/components/schemas/FeedMemberUpdatedEvent' + - $ref: '#/components/schemas/FeedUpdatedEvent' - $ref: '#/components/schemas/FlagUpdatedEvent' + - $ref: '#/components/schemas/FollowCreatedEvent' + - $ref: '#/components/schemas/FollowDeletedEvent' + - $ref: '#/components/schemas/FollowUpdatedEvent' + - $ref: '#/components/schemas/KickedUserEvent' - $ref: '#/components/schemas/MemberAddedEvent' - $ref: '#/components/schemas/MemberRemovedEvent' - $ref: '#/components/schemas/MemberUpdatedEvent' @@ -25994,6 +33178,7 @@ components: - $ref: '#/components/schemas/ModerationCustomActionEvent' - $ref: '#/components/schemas/ModerationFlaggedEvent' - $ref: '#/components/schemas/ModerationMarkReviewedEvent' + - $ref: '#/components/schemas/NotificationFeedUpdatedEvent' - $ref: '#/components/schemas/NotificationMarkUnreadEvent' - $ref: '#/components/schemas/PendingMessageEvent' - $ref: '#/components/schemas/PermissionRequestEvent' @@ -26013,6 +33198,7 @@ components: - $ref: '#/components/schemas/UserDeactivatedEvent' - $ref: '#/components/schemas/UserDeletedEvent' - $ref: '#/components/schemas/UserFlaggedEvent' + - $ref: '#/components/schemas/UserMessagesDeletedEvent' - $ref: '#/components/schemas/UserMutedEvent' - $ref: '#/components/schemas/UserReactivatedEvent' - $ref: '#/components/schemas/UserUnbannedEvent' @@ -26134,20 +33320,3186 @@ components: type: apiKey info: title: Stream API - version: v187.13.0 + version: v191.1.0 openapi: 3.0.3 paths: /api/v2/app: get: description: | - This Method returns the application settings - operationId: GetApp + This Method returns the application settings + operationId: GetApp + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/GetApplicationResponse' + 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: Get App Settings + tags: + - product:common + patch: + description: | + This Method updates one or more application settings + operationId: UpdateApp + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateAppRequest' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/Response' + 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: Update App Settings + tags: + - product:common + /api/v2/blocklists: + get: + description: | + Returns all available block lists + operationId: ListBlockLists + parameters: + - in: query + name: team + schema: + type: string + writeOnly: true + x-stream-index: "001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/ListBlockListResponse' + 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: List block lists + tags: + - product:common + post: + description: | + Creates a new application blocklist, once created the blocklist can be used by any channel type + operationId: CreateBlockList + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateBlockListRequest' + description: Block list + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/CreateBlockListResponse' + 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: Create block list + tags: + - product:common + /api/v2/blocklists/{name}: + delete: + description: | + Deletes previously created application blocklist + operationId: DeleteBlockList + parameters: + - in: path + name: name + required: true + schema: + type: string + writeOnly: true + x-stream-index: "001" + - in: query + name: team + schema: + type: string + x-stream-index: "002" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/Response' + 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: Delete block list + tags: + - product:common + get: + description: | + Returns block list by given name + operationId: GetBlockList + parameters: + - in: path + name: name + required: true + schema: + description: Block list name + title: Name + type: string + writeOnly: true + x-stream-index: "001" + - in: query + name: team + schema: + type: string + writeOnly: true + x-stream-index: "002" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/GetBlockListResponse' + description: GetBlockListResponse + "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: Get block list + tags: + - product:common + put: + description: | + Updates contents of the block list + operationId: UpdateBlockList + parameters: + - in: path + name: name + required: true + schema: + description: Block list name + title: Name + type: string + writeOnly: true + x-stream-index: "001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateBlockListRequest' + description: Update block list + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateBlockListResponse' + 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: Update block list + tags: + - product:common + /api/v2/chat/campaigns/{id}: + get: + description: | + Get campaign by ID. + operationId: GetCampaign + parameters: + - in: path + name: id + required: true + schema: + description: The ID of the campaign (uuid) + maxLength: 255 + title: Campaign ID + type: string + writeOnly: true + x-stream-index: "001" + - in: query + name: prev + schema: + description: Token for the previous page of campaign users + title: Previous Users Page + type: string + writeOnly: true + x-stream-index: "002.001" + - in: query + name: next + schema: + description: Token for the next page of campaign users + title: Next Users Page + type: string + writeOnly: true + x-stream-index: "002.002" + - in: query + name: limit + schema: + description: 'Maximum number of campaign users to return in a single request + (max: 1000)' + format: int32 + maximum: 1000 + minimum: 0 + title: Users Limit + type: integer + writeOnly: true + x-stream-index: "002.003" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/GetCampaignResponse' + 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: Get campaign + tags: + - product:chat + /api/v2/chat/campaigns/{id}/start: + post: + description: | + Starts or schedules a campaign + operationId: StartCampaign + parameters: + - in: path + name: id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/StartCampaignRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/StartCampaignResponse' + 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: Start/schedule campaign + tags: + - product:chat + /api/v2/chat/campaigns/{id}/stop: + post: + description: | + Stops a campaign + operationId: ScheduleCampaign + parameters: + - in: path + name: id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/StopCampaignRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/CampaignResponse' + description: Successful 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: Stop campaign + tags: + - product:chat + /api/v2/chat/campaigns/query: + post: + description: | + Query campaigns with filter query + operationId: QueryCampaigns + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueryCampaignsRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/QueryCampaignsResponse' + 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: Query campaigns + tags: + - product:chat + /api/v2/chat/channels: + post: + description: | + Query channels with filter query + operationId: QueryChannels + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueryChannelsRequest' + description: Query Channels Request + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/QueryChannelsResponse' + description: Channels list + "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: Query channels + tags: + - product:chat + /api/v2/chat/channels/{type}/{id}: + delete: + description: | + Deletes channel + + Sends events: + - channel.deleted + - channel.deleted + operationId: DeleteChannel + parameters: + - in: path + name: type + required: true + schema: + description: Channel type to interact with + title: Channel type + type: string + writeOnly: true + x-stream-index: "001.001" + - in: path + name: id + required: true + schema: + description: Channel ID to interact with + title: Channel ID + type: string + writeOnly: true + x-stream-index: "001.002" + - in: query + name: hard_delete + schema: + type: boolean + x-stream-index: "002" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteChannelResponse' + 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: Delete channel + tags: + - product:chat + patch: + description: | + Updates certain fields of the channel + + Sends events: + - channel.updated + - channel.updated + operationId: UpdateChannelPartial + parameters: + - in: path + name: type + required: true + schema: + description: Channel type to interact with + title: Channel type + type: string + writeOnly: true + x-stream-index: "001.001" + - in: path + name: id + required: true + schema: + description: Channel ID to interact with + title: Channel ID + type: string + writeOnly: true + x-stream-index: "001.002" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateChannelPartialRequest' + description: UpdateChannelPartialRequest + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateChannelPartialResponse' + description: Successful 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: Partially update channel + tags: + - product:chat + post: + description: | + Change channel data + + Sends events: + - channel.updated + - member.added + - member.removed + - member.updated + - message.new + - channel.updated + - member.added + - member.removed + - member.updated + - message.new + operationId: UpdateChannel + parameters: + - in: path + name: type + required: true + schema: + type: string + writeOnly: true + x-stream-index: 013.002.001 + - in: path + name: id + required: true + schema: + type: string + writeOnly: true + x-stream-index: 013.002.002 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateChannelRequest' + description: Channel update request + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateChannelResponse' + description: Successful 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: Update channel + tags: + - product:chat + /api/v2/chat/channels/{type}/{id}/draft: + delete: + description: | + Deletes a draft + + Sends events: + - draft.deleted + operationId: DeleteDraft + parameters: + - in: path + name: type + required: true + schema: + type: string + writeOnly: true + x-stream-index: "002.001" + - in: path + name: id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "002.002" + - in: query + name: parent_id + schema: + description: Parent message ID + title: string + type: string + writeOnly: true + x-stream-index: "001" + - in: query + name: user_id + schema: + type: string + writeOnly: true + x-stream-index: "003.001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/Response' + 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: Delete draft + tags: + - product:chat + get: + description: | + Get a draft + operationId: GetDraft + parameters: + - in: path + name: type + required: true + schema: + type: string + writeOnly: true + x-stream-index: "002.001" + - in: path + name: id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "002.002" + - in: query + name: parent_id + schema: + description: Parent message ID + title: string + type: string + writeOnly: true + x-stream-index: "001" + - in: query + name: user_id + schema: + type: string + writeOnly: true + x-stream-index: "003.001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/GetDraftResponse' + 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: Get draft + tags: + - product:chat + /api/v2/chat/channels/{type}/{id}/event: + post: + description: | + Sends event to the channel + operationId: SendEvent + parameters: + - in: path + name: type + required: true + schema: + description: Channel type to interact with + title: Channel type + type: string + writeOnly: true + x-stream-index: "002.001" + - in: path + name: id + required: true + schema: + description: Channel ID to interact with + title: Channel ID + type: string + writeOnly: true + x-stream-index: "002.002" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SendEventRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/EventResponse' + 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: Send event + tags: + - product:chat + /api/v2/chat/channels/{type}/{id}/file: + delete: + description: | + Deletes previously uploaded file + operationId: DeleteFile + parameters: + - in: path + name: type + required: true + schema: + description: The type of file + title: Type + type: string + writeOnly: true + x-stream-index: "002.001" + - in: path + name: id + required: true + schema: + description: File ID + title: ID + type: string + writeOnly: true + x-stream-index: "002.002" + - in: query + name: url + schema: + description: File URL to delete + title: URL + type: string + writeOnly: true + x-stream-index: "001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/Response' + 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: Delete file + tags: + - product:chat + post: + description: | + Uploads file + operationId: UploadFile + parameters: + - in: path + name: type + required: true + schema: + type: string + writeOnly: true + x-stream-index: "001.001" + - in: path + name: id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "001.002" + requestBody: + content: + multipart/form-data: + schema: + $ref: '#/components/schemas/FileUploadRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/FileUploadResponse' + description: Successful 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: Upload file + tags: + - product:chat + /api/v2/chat/channels/{type}/{id}/hide: + post: + description: | + Marks channel as hidden for current user + + Sends events: + - channel.hidden + - channel.hidden + operationId: HideChannel + parameters: + - in: path + name: type + required: true + schema: + type: string + writeOnly: true + x-stream-index: "002.001" + - in: path + name: id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "002.002" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/HideChannelRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/HideChannelResponse' + 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: Hide channel + tags: + - product:chat + /api/v2/chat/channels/{type}/{id}/image: + delete: + description: | + Deletes previously uploaded image + operationId: DeleteImage + parameters: + - in: path + name: type + required: true + schema: + description: The type of file + title: Type + type: string + writeOnly: true + x-stream-index: "002.001" + - in: path + name: id + required: true + schema: + description: File ID + title: ID + type: string + writeOnly: true + x-stream-index: "002.002" + - in: query + name: url + schema: + description: File URL to delete + title: URL + type: string + writeOnly: true + x-stream-index: "001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/Response' + 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: Delete image + tags: + - product:chat + post: + description: | + Uploads image + operationId: UploadImage + parameters: + - in: path + name: type + required: true + schema: + type: string + writeOnly: true + x-stream-index: 001.001.001 + - in: path + name: id + required: true + schema: + type: string + writeOnly: true + x-stream-index: 001.001.002 + requestBody: + content: + multipart/form-data: + schema: + $ref: '#/components/schemas/ImageUploadRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/ImageUploadResponse' + description: Successful 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: Upload image + tags: + - product:chat + /api/v2/chat/channels/{type}/{id}/member: + patch: + description: |2+ + + operationId: UpdateMemberPartial + parameters: + - in: path + name: type + required: true + schema: + type: string + writeOnly: true + x-stream-index: "003.001" + - in: path + name: id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "003.002" + - in: query + name: user_id + schema: + type: string + writeOnly: true + x-stream-index: "005.001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateMemberPartialRequest' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateMemberPartialResponse' + description: Successful 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: Partially channel member update + tags: + - product:chat + /api/v2/chat/channels/{type}/{id}/message: + post: + description: | + Sends new message to the specified channel + + Sends events: + - message.new + - message.updated + - message.new + - message.updated + operationId: SendMessage + parameters: + - in: path + name: type + required: true + schema: + description: Channel type to interact with + title: Channel type + type: string + writeOnly: true + x-stream-index: "009.001" + - in: path + name: id + required: true + schema: + description: Channel ID to interact with + title: Channel ID + type: string + writeOnly: true + x-stream-index: "009.002" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SendMessageRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/SendMessageResponse' + description: Successful 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: Send new message + tags: + - product:chat + /api/v2/chat/channels/{type}/{id}/messages: + get: + description: | + Returns list messages found by IDs + operationId: GetManyMessages + parameters: + - in: path + name: type + required: true + schema: + type: string + writeOnly: true + x-stream-index: "002.001" + - in: path + name: id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "002.002" + - in: query + name: ids + required: true + schema: + description: List of comma-separated IDs + items: + type: string + maximum: 50 + minimum: 1 + title: IDs + type: array + writeOnly: true + x-stream-index: "001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/GetManyMessagesResponse' + description: Successful 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: Get many messages + tags: + - product:chat + /api/v2/chat/channels/{type}/{id}/query: + post: + description: | + This Method creates a channel or returns an existing one with matching attributes + + Sends events: + - channel.created + - member.added + - member.removed + - member.updated + - user.watching.start + operationId: GetOrCreateChannel + parameters: + - in: path + name: type + required: true + schema: + description: Channel type + maxLength: 64 + title: Type + type: string + writeOnly: true + x-stream-index: "001" + - in: path + name: id + required: true + schema: + description: Channel ID (maximum length of 64 characters) + title: ID + type: string + writeOnly: true + x-stream-index: "002" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChannelGetOrCreateRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/ChannelStateResponse' + description: Successful 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: Get or create channel + tags: + - product:chat + /api/v2/chat/channels/{type}/{id}/read: + post: + description: | + Marks channel as read up to the specific message + + Sends events: + - message.read + - message.read + operationId: MarkRead + parameters: + - in: path + name: type + required: true + schema: + type: string + writeOnly: true + x-stream-index: "003.001" + - in: path + name: id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "003.002" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MarkReadRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/MarkReadResponse' + description: Successful 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 read + tags: + - product:chat + /api/v2/chat/channels/{type}/{id}/show: + post: + description: | + Shows previously hidden channel + + Sends events: + - channel.visible + - channel.visible + operationId: ShowChannel + parameters: + - in: path + name: type + required: true + schema: + description: Channel type to interact with + title: Channel type + type: string + writeOnly: true + x-stream-index: "001.001" + - in: path + name: id + required: true + schema: + description: Channel ID to interact with + title: Channel ID + type: string + writeOnly: true + x-stream-index: "001.002" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ShowChannelRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/ShowChannelResponse' + 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: Show channel + tags: + - product:chat + /api/v2/chat/channels/{type}/{id}/truncate: + post: + description: | + Truncates messages from a channel. Can be applied to the entire channel or scoped to specific members. + + Sends events: + - channel.truncated + - channel.truncated + operationId: TruncateChannel + parameters: + - in: path + name: type + required: true + schema: + type: string + writeOnly: true + x-stream-index: "001.001" + - in: path + name: id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "001.002" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TruncateChannelRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/TruncateChannelResponse' + description: Successful 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: Truncate channel + tags: + - product:chat + /api/v2/chat/channels/{type}/{id}/unread: + post: + description: | + Marks channel as unread from a specific message + operationId: MarkUnread + parameters: + - in: path + name: type + required: true + schema: + type: string + writeOnly: true + x-stream-index: "002.001" + - in: path + name: id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "002.002" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MarkUnreadRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/Response' + 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 unread + tags: + - product:chat + /api/v2/chat/channels/{type}/query: + post: + description: | + This Method creates a channel or returns an existing one with matching attributes + + Sends events: + - channel.created + - member.added + - member.removed + - member.updated + - user.watching.start + operationId: GetOrCreateDistinctChannel + parameters: + - in: path + name: type + required: true + schema: + description: Channel type + maxLength: 64 + title: Type + type: string + writeOnly: true + x-stream-index: "001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChannelGetOrCreateRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/ChannelStateResponse' + description: Successful 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: Get or create channel + tags: + - product:chat + /api/v2/chat/channels/delete: + post: + description: | + Allows to delete several channels at once asynchronously + + Sends events: + - channel.deleted + - channel.deleted + operationId: DeleteChannels + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteChannelsRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteChannelsResponse' + description: Successful 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: Deletes channels asynchronously + tags: + - product:chat + /api/v2/chat/channels/read: + post: + description: | + Marks channels as read up to the specific message. If no channels is given, mark all channel as read + + Sends events: + - message.read + - message.read + operationId: MarkChannelsRead + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MarkChannelsReadRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/MarkReadResponse' + description: Successful 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 channels as read + tags: + - product:chat + /api/v2/chat/channeltypes: + get: + description: | + Lists all available channel types + operationId: ListChannelTypes + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/ListChannelTypesResponse' + description: ListChannelTypesResponse + "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: List channel types + tags: + - product:chat + post: + description: | + Creates new channel type + operationId: CreateChannelType + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateChannelTypeRequest' + description: CreateChannelTypeRequest + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/CreateChannelTypeResponse' + description: Successful 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: Create channel type + tags: + - product:chat + /api/v2/chat/channeltypes/{name}: + delete: + description: | + Deletes channel type + operationId: DeleteChannelType + parameters: + - in: path + name: name + required: true + schema: + description: Channel type name + title: Name + type: string + writeOnly: true + x-stream-index: "001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/Response' + 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: Delete channel type + tags: + - product:chat + get: + description: | + Gets channel type + operationId: GetChannelType + parameters: + - in: path + name: name + required: true + schema: + description: Channel type name + title: Name + type: string + writeOnly: true + x-stream-index: "001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/GetChannelTypeResponse' + 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: Get channel type + tags: + - product:chat + put: + description: | + Updates channel type + operationId: UpdateChannelType + parameters: + - in: path + name: name + required: true + schema: + type: string + writeOnly: true + x-stream-index: "001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateChannelTypeRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateChannelTypeResponse' + description: Successful 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: Update channel type + tags: + - product:chat + /api/v2/chat/commands: + get: + description: | + Returns all custom commands + operationId: ListCommands + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/ListCommandsResponse' + description: ListCommandsResponse + "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: List commands + tags: + - product:chat + post: + description: | + Creates custom chat command + operationId: CreateCommand + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateCommandRequest' + description: CreateCommandRequest + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/CreateCommandResponse' + description: CreateCommandResponse + "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: Create command + tags: + - product:chat + /api/v2/chat/commands/{name}: + delete: + description: | + Deletes custom chat command + operationId: DeleteCommand + parameters: + - in: path + name: name + required: true + schema: + description: Command name + title: Name + type: string + x-stream-index: "001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteCommandResponse' + description: DeleteCommandResponse + "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: Delete command + tags: + - product:chat + get: + description: | + Returns custom command by its name + operationId: GetCommand + parameters: + - in: path + name: name + required: true + schema: + description: Command name + title: Name + type: string + x-stream-index: "001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/GetCommandResponse' + description: GetCommandResponse + "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: Get command + tags: + - product:chat + put: + description: | + Updates custom chat command + operationId: UpdateCommand + parameters: + - in: path + name: name + required: true + schema: + description: Unique command name + title: Name + type: string + writeOnly: true + x-stream-index: "001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateCommandRequest' + description: UpdateCommandRequest + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateCommandResponse' + description: UpdateCommandResponse + "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: Update command + tags: + - product:chat + /api/v2/chat/drafts/query: + post: + description: | + Queries draft messages for a user + operationId: QueryDrafts + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueryDraftsRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/QueryDraftsResponse' + description: Successful 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: Query draft messages + tags: + - product:chat + /api/v2/chat/export_channels: + post: + description: | + Exports channel data to JSON file + operationId: ExportChannels + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ExportChannelsRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/ExportChannelsResponse' + description: Successful 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: Export channels + tags: + - product:chat + /api/v2/chat/members: + get: + description: | + Find and filter channel members + operationId: QueryMembers + parameters: + - content: + application/json: + schema: + $ref: '#/components/schemas/QueryMembersPayload' + x-stream-index: "001" + in: query + name: payload + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/MembersResponse' + description: Successful 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: Query members + tags: + - product:chat + /api/v2/chat/messages/{id}: + delete: + description: | + Deletes message + + Sends events: + - message.deleted + - message.deleted + operationId: DeleteMessage + parameters: + - in: path + name: id + required: true + schema: + description: Message ID to delete + title: ID + type: string + writeOnly: true + x-stream-index: "001" + - in: query + name: hard + schema: + description: Delete all message reactions and replies as well + title: Hard + type: boolean + writeOnly: true + x-stream-index: "002" + - in: query + name: deleted_by + schema: + type: string + writeOnly: true + x-stream-index: "003" + - in: query + name: delete_for_me + schema: + description: Delete the message only for the user making the request + title: Delete for me + type: boolean + writeOnly: true + x-stream-index: "004" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteMessageResponse' + 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: Delete message + tags: + - product:chat + get: + description: | + Returns message by ID + operationId: GetMessage + parameters: + - in: path + name: id + required: true + schema: + description: ID of the message + title: ID + type: string + writeOnly: true + x-stream-index: "001" + - in: query + name: show_deleted_message + schema: + description: Whether to show deleted message + title: Show deleted message + type: boolean + writeOnly: true + x-stream-index: "002" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/GetMessageResponse' + 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: Get message + tags: + - product:chat + post: + description: | + Updates message with new data + + Sends events: + - message.updated + - message.updated + operationId: UpdateMessage + parameters: + - in: path + name: id + required: true + schema: + description: Message ID + title: ID + type: string + writeOnly: true + x-stream-index: "004.001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateMessageRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateMessageResponse' + 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: Update message + tags: + - product:chat + put: + description: | + Updates certain fields of the message + + Sends events: + - message.updated + - message.updated + operationId: UpdateMessagePartial + parameters: + - in: path + name: id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "003.001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateMessagePartialRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateMessagePartialResponse' + description: Successful 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: Partially message update + tags: + - product:chat + /api/v2/chat/messages/{id}/action: + post: + description: | + Executes message command action with given parameters + + Sends events: + - message.new + - message.new + operationId: RunMessageAction + parameters: + - in: path + name: id + required: true + schema: + description: Message ID + title: ID + type: string + writeOnly: true + x-stream-index: "001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MessageActionRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/MessageResponse' + 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: Run message command action + tags: + - product:chat + /api/v2/chat/messages/{id}/commit: + post: + description: | + Commits a pending message, which will make it visible in the channel + + Sends events: + - message.new + - message.updated + - message.new + - message.updated + operationId: CommitMessage + parameters: + - in: path + name: id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CommitMessageRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/MessageResponse' + 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: Commit message + tags: + - product:chat + /api/v2/chat/messages/{id}/reaction: + post: + description: | + Sends reaction to specified message + + Sends events: + - reaction.new + - reaction.updated + operationId: SendReaction + parameters: + - in: path + name: id + required: true + schema: + description: Message ID to send reaction for + title: ID + type: string + writeOnly: true + x-stream-index: "001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SendReactionRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/SendReactionResponse' + 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: Send reaction + tags: + - product:chat + /api/v2/chat/messages/{id}/reaction/{type}: + delete: + description: | + Removes user reaction from the message + + Sends events: + - reaction.deleted + operationId: DeleteReaction + parameters: + - in: path + name: id + required: true + schema: + description: Message ID to remove reaction from + title: ID + type: string + writeOnly: true + x-stream-index: "001" + - in: path + name: type + required: true + schema: + description: Reaction type to remove + title: Type + type: string + writeOnly: true + x-stream-index: "002" + - in: query + name: user_id + schema: + description: '**Server-side only**. User ID which server acts upon' + title: User ID + type: string + writeOnly: true + x-stream-index: "003" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteReactionResponse' + 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: Delete reaction + tags: + - product:chat + /api/v2/chat/messages/{id}/reactions: + get: + description: | + Returns list of reactions of specific message + operationId: GetReactions + parameters: + - in: path + name: id + required: true + schema: + description: Message ID + title: ID + type: string + writeOnly: true + x-stream-index: "001" + - in: query + name: limit + schema: + description: Number of records to return + format: int32 + title: Limit + type: integer + writeOnly: true + x-stream-index: "002" + - in: query + name: offset + schema: + description: Number of records to offset + format: int32 + title: Offset + type: integer + writeOnly: true + x-stream-index: "003" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/GetReactionsResponse' + description: Successful 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: Get reactions + tags: + - product:chat + post: + description: | + Get reactions on a message + operationId: QueryReactions + parameters: + - in: path + name: id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueryReactionsRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/QueryReactionsResponse' + 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 + tags: + - product:chat + /api/v2/chat/messages/{id}/translate: + post: + description: | + Translates message to a given language using automated translation software + + Sends events: + - message.updated + - message.updated + operationId: TranslateMessage + parameters: + - in: path + name: id + required: true + schema: + description: Message ID + title: ID + type: string + writeOnly: true + x-stream-index: "002.001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TranslateMessageRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/MessageResponse' + 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: Translate message + tags: + - product:chat + /api/v2/chat/messages/{id}/undelete: + post: + description: | + Undelete a message that was previously soft-deleted + + Sends events: + - message.undeleted + - message.undeleted + operationId: UndeleteMessage + parameters: + - in: path + name: id + required: true + schema: + description: Message ID + title: ID + type: string + writeOnly: true + x-stream-index: "004.001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateMessageRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateMessageResponse' + 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: Undelete message + tags: + - product:chat + /api/v2/chat/messages/{message_id}/polls/{poll_id}/vote: + post: + description: | + Cast a vote on a poll + + Sends events: + - feeds.poll.vote_casted + - feeds.poll.vote_changed + - feeds.poll.vote_removed + - poll.vote_casted + - poll.vote_changed + - poll.vote_removed + operationId: CastPollVote + parameters: + - in: path + name: message_id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "001" + - in: path + name: poll_id + required: true + schema: + description: Poll ID + maxLength: 255 + title: string + type: string + x-stream-index: "003" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CastPollVoteRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/PollVoteResponse' + description: Successful 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: Cast vote + tags: + - product:chat + /api/v2/chat/messages/{message_id}/polls/{poll_id}/vote/{vote_id}: + delete: + description: | + Delete a vote from a poll + + Sends events: + - feeds.poll.vote_removed + - poll.vote_removed + operationId: DeletePollVote + parameters: + - in: path + name: message_id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "002" + - in: path + name: poll_id + required: true + schema: + description: Poll ID + maxLength: 255 + title: string + type: string + x-stream-index: "004" + - in: path + name: vote_id + required: true + schema: + description: Vote ID + maxLength: 255 + title: string + type: string + x-stream-index: "005" + - in: query + name: user_id + schema: + type: string + writeOnly: true + x-stream-index: "001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/PollVoteResponse' + description: Successful 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: Delete vote + tags: + - product:chat + /api/v2/chat/messages/{message_id}/reminders: + delete: + description: | + Deletes a user's created reminder + + Sends events: + - reminder.deleted + operationId: DeleteReminder + parameters: + - in: path + name: message_id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "002" + - in: query + name: user_id + schema: + type: string + writeOnly: true + x-stream-index: "001" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteReminderResponse' + 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: Delete reminder + tags: + - product:chat + patch: + description: | + Updates an existing reminder + + Sends events: + - reminder.updated + operationId: UpdateReminder + parameters: + - in: path + name: message_id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "002" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateReminderRequest' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateReminderResponse' + 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: Updates Reminder + tags: + - product:chat + post: + description: | + Creates a new reminder + + Sends events: + - reminder.created + operationId: CreateReminder + parameters: + - in: path + name: message_id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "002" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateReminderRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/ReminderResponseData' + description: Successful 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: Create reminder + tags: + - product:chat + /api/v2/chat/messages/{parent_id}/replies: + get: + description: | + Returns replies (thread) of the message + operationId: GetReplies + parameters: + - in: path + name: parent_id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "001" + - in: query + name: sort + schema: + items: + $ref: '#/components/schemas/SortParamRequest' + maximum: 1 + type: array + writeOnly: true + x-stream-index: "002" + - in: query + name: limit + schema: + description: 'The maximum number of messages to return (max limit ' + format: int32 + minimum: 0 + title: Limit + type: integer + x-stream-index: "003.001" + - in: query + name: offset + schema: + description: The offset to start from + format: int32 + title: Offset + type: integer + x-stream-index: "003.002" + - in: query + name: id_gte + schema: + description: The ID of the message to get messages with a timestamp greater + than or equal to + title: IDGTE + type: string + x-stream-index: "003.003" + - in: query + name: id_gt + schema: + description: The ID of the message to get messages with a timestamp greater + than + title: IDGT + type: string + x-stream-index: "003.004" + - in: query + name: id_lte + schema: + description: The ID of the message to get messages with a timestamp smaller + than or equal to + title: IDLTE + type: string + x-stream-index: "003.005" + - in: query + name: id_lt + schema: + description: The ID of the message to get messages with a timestamp smaller + than + title: IDLT + type: string + x-stream-index: "003.006" + - in: query + name: created_at_after_or_equal + schema: + description: The timestamp to get messages with a created_at timestamp greater + than or equal to + format: date-time + title: Created_at after or equal + type: number + x-stream-index: "003.007" + - in: query + name: created_at_after + schema: + description: The timestamp to get messages with a created_at timestamp greater + than + format: date-time + title: Created_at after + type: number + x-stream-index: "003.008" + - in: query + name: created_at_before_or_equal + schema: + description: The timestamp to get messages with a created_at timestamp smaller + than or equal to + format: date-time + title: Created_at after before or equal + type: number + x-stream-index: "003.009" + - in: query + name: created_at_before + schema: + description: The timestamp to get messages with a created_at timestamp smaller + than + format: date-time + title: Created_at after before + type: number + x-stream-index: "003.010" + - in: query + name: id_around + schema: + description: The result will be a set of messages, that are both older and + newer than the message with the provided ID, and the message with the + ID provided will be in the middle of the set + title: Id around + type: string + x-stream-index: "003.011" + - in: query + name: created_at_around + schema: + description: The result will be a set of messages, that are both older and + newer than the created_at timestamp provided, distributed evenly around + the timestamp + format: date-time + title: Created_at around + type: number + x-stream-index: "003.012" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/GetRepliesResponse' + 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: Get replies + tags: + - product:chat + /api/v2/chat/messages/history: + post: + description: | + Queries history for one message + operationId: QueryMessageHistory + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueryMessageHistoryRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/QueryMessageHistoryResponse' + description: Successful 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: Query message history + tags: + - product:chat + /api/v2/chat/moderation/flags/message: + get: + description: | + Find and filter message flags + operationId: QueryMessageFlags + parameters: + - content: + application/json: + schema: + $ref: '#/components/schemas/QueryMessageFlagsPayload' + description: JSON object with query message flags payload + title: Payload + x-stream-index: "001" + in: query + name: payload + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/QueryMessageFlagsResponse' + description: QueryMessageFlagsResponse + "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: Query Message Flags + tags: + - product:chat + /api/v2/chat/moderation/mute/channel: + post: + description: | + Mutes channel for user + + Sends events: + - channel.muted + - channel.muted + operationId: MuteChannel + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MuteChannelRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/MuteChannelResponse' + description: Successful 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: Mute channel + tags: + - product:chat + /api/v2/chat/moderation/unmute/channel: + post: + description: | + Unmutes channel for user + + Sends events: + - channel.unmuted + - channel.unmuted + operationId: UnmuteChannel + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UnmuteChannelRequest' + required: true responses: - "200": + "201": content: application/json: schema: - $ref: '#/components/schemas/GetApplicationResponse' + $ref: '#/components/schemas/UnmuteResponse' description: Response "400": content: @@ -26161,26 +36513,27 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Get App Settings + summary: Unmute channel tags: - - product:common - patch: + - product:chat + /api/v2/chat/push_preferences: + post: description: | - This Method updates one or more application settings - operationId: UpdateApp + Update the push preferences for a user and or channel member. Set to all, mentions or none + operationId: UpdatePushNotificationPreferences requestBody: content: application/json: schema: - $ref: '#/components/schemas/UpdateAppRequest' + $ref: '#/components/schemas/UpsertPushPreferencesRequest' required: true responses: - "200": + "201": content: application/json: schema: - $ref: '#/components/schemas/Response' - description: Response + $ref: '#/components/schemas/UpsertPushPreferencesResponse' + description: Successful response "400": content: application/json: @@ -26193,27 +36546,41 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Update App Settings + summary: Push notification preferences tags: - - product:common - /api/v2/blocklists: + - product:chat + /api/v2/chat/push_templates: get: description: | - Returns all available block lists - operationId: ListBlockLists + Retrieve push notification templates for Chat. + operationId: GetPushTemplates parameters: - in: query - name: team + name: push_provider_name schema: + description: Push provider name to filter templates + title: string type: string writeOnly: true - x-stream-index: "001" + x-stream-index: "002" + - in: query + name: push_provider_type + required: true + schema: + description: Push provider type (firebase, apn) to filter templates + enum: + - firebase + - apn + title: string + type: string + writeOnly: true + x-stream-index: "003" responses: "200": content: application/json: schema: - $ref: '#/components/schemas/ListBlockListResponse' + $ref: '#/components/schemas/GetPushTemplatesResponse' description: Response "400": content: @@ -26227,26 +36594,25 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: List block lists + summary: Get push notification templates tags: - - product:common + - product:chat post: description: | - Creates a new application blocklist, once created the blocklist can be used by any channel type - operationId: CreateBlockList + Create or update a push notification template for a specific event type and push provider + operationId: UpsertPushTemplate requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateBlockListRequest' - description: Block list + $ref: '#/components/schemas/UpsertPushTemplateRequest' required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/CreateBlockListResponse' + $ref: '#/components/schemas/UpsertPushTemplateResponse' description: Response "400": content: @@ -26260,27 +36626,130 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Create block list + summary: Upsert a push notification template tags: - - product:common - /api/v2/blocklists/{name}: + - product:chat + /api/v2/chat/query_banned_users: + get: + description: | + Find and filter channel scoped or global user bans + operationId: QueryBannedUsers + parameters: + - content: + application/json: + schema: + $ref: '#/components/schemas/QueryBannedUsersPayload' + description: JSON object with query user bans payload + title: Payload + x-stream-index: "001" + in: query + name: payload + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/QueryBannedUsersResponse' + description: Successful 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: Query Banned Users + tags: + - product:chat + /api/v2/chat/reminders/query: + post: + description: | + Queries reminders + operationId: QueryReminders + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueryRemindersRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/QueryRemindersResponse' + description: Successful 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: Query reminders + tags: + - product:chat + /api/v2/chat/search: + get: + description: | + Search messages across channels + operationId: Search + parameters: + - content: + application/json: + schema: + $ref: '#/components/schemas/SearchPayload' + description: JSON object with search payload + title: Payload + x-stream-index: "001" + in: query + name: payload + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/SearchResponse' + description: Successful 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: Search messages + tags: + - product:chat + /api/v2/chat/segments/{id}: delete: description: | - Deletes previously created application blocklist - operationId: DeleteBlockList + Delete a segment + operationId: DeleteSegment parameters: - in: path - name: name + name: id required: true schema: + maxLength: 255 type: string writeOnly: true x-stream-index: "001" - - in: query - name: team - schema: - type: string - x-stream-index: "002" responses: "200": content: @@ -26300,36 +36769,29 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Delete block list + summary: Delete segment tags: - - product:common + - product:chat get: description: | - Returns block list by given name - operationId: GetBlockList + Get segment + operationId: GetSegment parameters: - in: path - name: name + name: id required: true schema: - description: Block list name - title: Name + maxLength: 255 type: string writeOnly: true x-stream-index: "001" - - in: query - name: team - schema: - type: string - writeOnly: true - x-stream-index: "002" responses: "200": content: application/json: schema: - $ref: '#/components/schemas/GetBlockListResponse' - description: GetBlockListResponse + $ref: '#/components/schemas/GetSegmentResponse' + description: Successful response "400": content: application/json: @@ -26342,20 +36804,20 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Get block list + summary: Get segment tags: - - product:common - put: + - product:chat + /api/v2/chat/segments/{id}/deletetargets: + post: description: | - Updates contents of the block list - operationId: UpdateBlockList + Delete targets from a segment + operationId: DeleteSegmentTargets parameters: - in: path - name: name + name: id required: true schema: - description: Block list name - title: Name + maxLength: 255 type: string writeOnly: true x-stream-index: "001" @@ -26363,15 +36825,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/UpdateBlockListRequest' - description: Update block list + $ref: '#/components/schemas/DeleteSegmentTargetsRequest' required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/UpdateBlockListResponse' + $ref: '#/components/schemas/Response' description: Response "400": content: @@ -26385,59 +36846,36 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Update block list + summary: Delete targets from a segment tags: - - product:common - /api/v2/chat/campaigns/{id}: + - product:chat + /api/v2/chat/segments/{id}/target/{target_id}: get: description: | - Get campaign by ID. - operationId: GetCampaign + Check whether a target exists in a segment. Returns 200 if the target exists, 404 otherwise + operationId: SegmentTargetExists parameters: - in: path name: id required: true schema: - description: The ID of the campaign (uuid) maxLength: 255 - title: Campaign ID type: string writeOnly: true x-stream-index: "001" - - in: query - name: prev - schema: - description: Token for the previous page of campaign users - title: Previous Users Page - type: string - writeOnly: true - x-stream-index: "002.001" - - in: query - name: next + - in: path + name: target_id + required: true schema: - description: Token for the next page of campaign users - title: Next Users Page type: string writeOnly: true - x-stream-index: "002.002" - - in: query - name: limit - schema: - description: 'Maximum number of campaign users to return in a single request - (max: 1000)' - format: int32 - maximum: 1000 - minimum: 0 - title: Users Limit - type: integer - writeOnly: true - x-stream-index: "002.003" + x-stream-index: "002" responses: "200": content: application/json: schema: - $ref: '#/components/schemas/GetCampaignResponse' + $ref: '#/components/schemas/Response' description: Response "400": content: @@ -26451,14 +36889,14 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Get campaign + summary: Check whether a target exists in a segment tags: - product:chat - /api/v2/chat/campaigns/{id}/start: + /api/v2/chat/segments/{id}/targets/query: post: description: | - Starts or schedules a campaign - operationId: StartCampaign + Query segment targets + operationId: QuerySegmentTargets parameters: - in: path name: id @@ -26472,15 +36910,15 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/StartCampaignRequest' + $ref: '#/components/schemas/QuerySegmentTargetsRequest' required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/StartCampaignResponse' - description: Response + $ref: '#/components/schemas/QuerySegmentTargetsResponse' + description: Successful response "400": content: application/json: @@ -26493,20 +36931,155 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Start/schedule campaign + summary: Query segment targets tags: - product:chat - /api/v2/chat/campaigns/{id}/stop: + /api/v2/chat/segments/query: post: description: | - Stops a campaign - operationId: ScheduleCampaign + Query segments + operationId: QuerySegments + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QuerySegmentsRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/QuerySegmentsResponse' + description: Successful 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: Query segments + tags: + - product:chat + /api/v2/chat/threads: + post: + description: | + Returns the list of threads for specific user + operationId: QueryThreads + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueryThreadsRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/QueryThreadsResponse' + description: Successful 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: Query Threads + tags: + - product:chat + /api/v2/chat/threads/{message_id}: + get: + description: | + Return a specific thread + operationId: GetThread parameters: - in: path - name: id + name: message_id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "001" + - in: query + name: reply_limit + schema: + description: Limit the number of replies returned + format: int32 + minimum: 0 + title: Reply limit + type: integer + writeOnly: true + x-stream-index: "004" + - in: query + name: participant_limit + schema: + description: Limit the number of participants returned + format: int32 + maximum: 100 + minimum: 0 + title: Participant limit + type: integer + writeOnly: true + x-stream-index: "005" + - in: query + name: member_limit + schema: + description: Limit the number of members returned per thread channel + format: int32 + maximum: 100 + minimum: 0 + title: Member limit + type: integer + writeOnly: true + x-stream-index: "006" + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/GetThreadResponse' + description: Successful 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: Get Thread + tags: + - product:chat + patch: + description: | + Updates certain fields of the thread + + Sends events: + - thread.updated + - thread.updated + operationId: UpdateThreadPartial + parameters: + - in: path + name: message_id required: true schema: - maxLength: 255 type: string writeOnly: true x-stream-index: "001" @@ -26514,14 +37087,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/StopCampaignRequest' + $ref: '#/components/schemas/UpdateThreadPartialRequest' required: true responses: - "201": + "200": content: application/json: schema: - $ref: '#/components/schemas/CampaignResponse' + $ref: '#/components/schemas/UpdateThreadPartialResponse' description: Successful response "400": content: @@ -26535,26 +37108,53 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Stop campaign + summary: Partially update thread tags: - product:chat - /api/v2/chat/campaigns/query: + /api/v2/chat/unread: + get: + description: | + Fetch unread counts for a single user + operationId: UnreadCounts + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/WrappedUnreadCountsResponse' + 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: Unread counts + tags: + - product:chat + /api/v2/chat/unread_batch: post: description: | - Query campaigns with filter query - operationId: QueryCampaigns + Fetch unread counts in batch for multiple users in one call + operationId: UnreadCountsBatch requestBody: content: application/json: schema: - $ref: '#/components/schemas/QueryCampaignsRequest' + $ref: '#/components/schemas/UnreadCountsBatchRequest' required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/QueryCampaignsResponse' + $ref: '#/components/schemas/UnreadCountsBatchResponse' description: Response "400": content: @@ -26568,28 +37168,38 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Query campaigns + summary: Batch unread counts tags: - product:chat - /api/v2/chat/channels: + /api/v2/chat/users/{user_id}/event: post: description: | - Query channels with filter query - operationId: QueryChannels + Sends a custom event to a user + + Sends events: + - * + operationId: SendUserCustomEvent + parameters: + - in: path + name: user_id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "002" requestBody: content: application/json: schema: - $ref: '#/components/schemas/QueryChannelsRequest' - description: Query Channels Request + $ref: '#/components/schemas/SendUserCustomEventRequest' required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/QueryChannelsResponse' - description: Channels list + $ref: '#/components/schemas/Response' + description: Response "400": content: application/json: @@ -26602,49 +37212,28 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Query channels + summary: Send user event tags: - product:chat - /api/v2/chat/channels/{type}/{id}: - delete: + /api/v2/check_push: + post: description: | - Deletes channel - - Sends events: - - channel.deleted - - channel.deleted - operationId: DeleteChannel - parameters: - - in: path - name: type - required: true - schema: - description: Channel type to interact with - title: Channel type - type: string - writeOnly: true - x-stream-index: "001.001" - - in: path - name: id + Sends a test message via push, this is a test endpoint to verify your push settings + operationId: CheckPush + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CheckPushRequest' + description: CheckPushRequest required: true - schema: - description: Channel ID to interact with - title: Channel ID - type: string - writeOnly: true - x-stream-index: "001.002" - - in: query - name: hard_delete - schema: - type: boolean - x-stream-index: "002" responses: - "200": + "201": content: application/json: schema: - $ref: '#/components/schemas/DeleteChannelResponse' - description: Response + $ref: '#/components/schemas/CheckPushResponse' + description: Successful response "400": content: application/json: @@ -26657,49 +37246,26 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Delete channel + summary: Check push tags: - - product:chat - patch: + - product:common + /api/v2/check_sns: + post: description: | - Updates certain fields of the channel - - Sends events: - - channel.updated - - channel.updated - operationId: UpdateChannelPartial - parameters: - - in: path - name: type - required: true - schema: - description: Channel type to interact with - title: Channel type - type: string - writeOnly: true - x-stream-index: "001.001" - - in: path - name: id - required: true - schema: - description: Channel ID to interact with - title: Channel ID - type: string - writeOnly: true - x-stream-index: "001.002" + Validates Amazon SNS configuration + operationId: CheckSNS requestBody: content: application/json: schema: - $ref: '#/components/schemas/UpdateChannelPartialRequest' - description: UpdateChannelPartialRequest + $ref: '#/components/schemas/CheckSNSRequest' required: true responses: - "200": + "201": content: application/json: schema: - $ref: '#/components/schemas/UpdateChannelPartialResponse' + $ref: '#/components/schemas/CheckSNSResponse' description: Successful response "400": content: @@ -26713,53 +37279,26 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Partially update channel + summary: Check SNS tags: - - product:chat + - product:common + /api/v2/check_sqs: post: description: | - Change channel data - - Sends events: - - channel.updated - - member.added - - member.removed - - member.updated - - message.new - - channel.updated - - member.added - - member.removed - - member.updated - - message.new - operationId: UpdateChannel - parameters: - - in: path - name: type - required: true - schema: - type: string - writeOnly: true - x-stream-index: 013.002.001 - - in: path - name: id - required: true - schema: - type: string - writeOnly: true - x-stream-index: 013.002.002 + Validates Amazon SQS credentials + operationId: CheckSQS requestBody: content: application/json: schema: - $ref: '#/components/schemas/UpdateChannelRequest' - description: Channel update request + $ref: '#/components/schemas/CheckSQSRequest' required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/UpdateChannelResponse' + $ref: '#/components/schemas/CheckSQSResponse' description: Successful response "400": content: @@ -26773,46 +37312,32 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Update channel + summary: Check SQS tags: - - product:chat - /api/v2/chat/channels/{type}/{id}/draft: + - product:common + /api/v2/devices: delete: description: | - Deletes a draft - - Sends events: - - draft.deleted - operationId: DeleteDraft + Deletes one device + operationId: DeleteDevice parameters: - - in: path - name: type - required: true - schema: - type: string - writeOnly: true - x-stream-index: "002.001" - - in: path + - in: query name: id required: true schema: - type: string - writeOnly: true - x-stream-index: "002.002" - - in: query - name: parent_id - schema: - description: Parent message ID - title: string + description: Device ID to delete + title: ID type: string writeOnly: true x-stream-index: "001" - in: query name: user_id schema: + description: '**Server-side only**. User ID which server acts upon' + title: User ID type: string writeOnly: true - x-stream-index: "003.001" + x-stream-index: "002.001" responses: "200": content: @@ -26832,49 +37357,29 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Delete draft + summary: Delete device tags: - - product:chat + - product:common get: description: | - Get a draft - operationId: GetDraft + Returns all available devices + operationId: ListDevices parameters: - - in: path - name: type - required: true - schema: - type: string - writeOnly: true - x-stream-index: "002.001" - - in: path - name: id - required: true - schema: - type: string - writeOnly: true - x-stream-index: "002.002" - - in: query - name: parent_id - schema: - description: Parent message ID - title: string - type: string - writeOnly: true - x-stream-index: "001" - in: query name: user_id schema: + description: '**Server-side only**. User ID which server acts upon' + title: User ID type: string writeOnly: true - x-stream-index: "003.001" + x-stream-index: "001.001" responses: "200": content: application/json: schema: - $ref: '#/components/schemas/GetDraftResponse' - description: Response + $ref: '#/components/schemas/ListDevicesResponse' + description: ListDevicesResponse "400": content: application/json: @@ -26887,45 +37392,26 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Get draft + summary: List devices tags: - - product:chat - /api/v2/chat/channels/{type}/{id}/event: + - product:common post: description: | - Sends event to the channel - operationId: SendEvent - parameters: - - in: path - name: type - required: true - schema: - description: Channel type to interact with - title: Channel type - type: string - writeOnly: true - x-stream-index: "002.001" - - in: path - name: id - required: true - schema: - description: Channel ID to interact with - title: Channel ID - type: string - writeOnly: true - x-stream-index: "002.002" + Adds a new device to a user, if the same device already exists the call will have no effect + operationId: CreateDevice requestBody: content: application/json: schema: - $ref: '#/components/schemas/SendEventRequest' + $ref: '#/components/schemas/CreateDeviceRequest' + description: CreateDeviceRequest required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/EventResponse' + $ref: '#/components/schemas/Response' description: Response "400": content: @@ -26939,47 +37425,26 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Send event + summary: Create device tags: - - product:chat - /api/v2/chat/channels/{type}/{id}/file: - delete: + - product:common + /api/v2/export/users: + post: description: | - Deletes previously uploaded file - operationId: DeleteFile - parameters: - - in: path - name: type - required: true - schema: - description: The type of file - title: Type - type: string - writeOnly: true - x-stream-index: "002.001" - - in: path - name: id + Exports user profile, reactions and messages for list of given users + operationId: ExportUsers + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ExportUsersRequest' required: true - schema: - description: File ID - title: ID - type: string - writeOnly: true - x-stream-index: "002.002" - - in: query - name: url - schema: - description: File URL to delete - title: URL - type: string - writeOnly: true - x-stream-index: "001" responses: - "200": + "201": content: application/json: schema: - $ref: '#/components/schemas/Response' + $ref: '#/components/schemas/ExportUsersResponse' description: Response "400": content: @@ -26993,41 +37458,21 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Delete file + summary: Export users tags: - - product:chat - post: + - product:common + /api/v2/external_storage: + get: description: | - Uploads file - operationId: UploadFile - parameters: - - in: path - name: type - required: true - schema: - type: string - writeOnly: true - x-stream-index: "001.001" - - in: path - name: id - required: true - schema: - type: string - writeOnly: true - x-stream-index: "001.002" - requestBody: - content: - multipart/form-data: - schema: - $ref: '#/components/schemas/FileUploadRequest' - required: true + Lists external storage + operationId: ListExternalStorage responses: - "201": + "200": content: application/json: schema: - $ref: '#/components/schemas/FileUploadResponse' - description: Successful response + $ref: '#/components/schemas/ListExternalStorageResponse' + description: Response "400": content: application/json: @@ -27040,45 +37485,26 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Upload file + summary: List external storage tags: - - product:chat - /api/v2/chat/channels/{type}/{id}/hide: + - product:common post: description: | - Marks channel as hidden for current user - - Sends events: - - channel.hidden - - channel.hidden - operationId: HideChannel - parameters: - - in: path - name: type - required: true - schema: - type: string - writeOnly: true - x-stream-index: "002.001" - - in: path - name: id - required: true - schema: - type: string - writeOnly: true - x-stream-index: "002.002" + Creates new external storage + operationId: CreateExternalStorage requestBody: content: application/json: schema: - $ref: '#/components/schemas/HideChannelRequest' + $ref: '#/components/schemas/CreateExternalStorageRequest' + description: CreateExternalStorageRequest required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/HideChannelResponse' + $ref: '#/components/schemas/CreateExternalStorageResponse' description: Response "400": content: @@ -27092,47 +37518,28 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Hide channel + summary: Create external storage tags: - - product:chat - /api/v2/chat/channels/{type}/{id}/image: + - product:common + /api/v2/external_storage/{name}: delete: description: | - Deletes previously uploaded image - operationId: DeleteImage + Deletes external storage + operationId: DeleteExternalStorage parameters: - in: path - name: type - required: true - schema: - description: The type of file - title: Type - type: string - writeOnly: true - x-stream-index: "002.001" - - in: path - name: id + name: name required: true schema: - description: File ID - title: ID - type: string - writeOnly: true - x-stream-index: "002.002" - - in: query - name: url - schema: - description: File URL to delete - title: URL type: string writeOnly: true - x-stream-index: "001" + x-stream-index: "002" responses: "200": content: application/json: schema: - $ref: '#/components/schemas/Response' + $ref: '#/components/schemas/DeleteExternalStorageResponse' description: Response "400": content: @@ -27146,41 +37553,35 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Delete image + summary: Delete external storage tags: - - product:chat - post: - description: | - Uploads image - operationId: UploadImage + - product:common + put: + description: |2+ + + operationId: UpdateExternalStorage parameters: - in: path - name: type - required: true - schema: - type: string - writeOnly: true - x-stream-index: 001.001.001 - - in: path - name: id + name: name required: true schema: type: string writeOnly: true - x-stream-index: 001.001.002 + x-stream-index: "001" requestBody: content: - multipart/form-data: + application/json: schema: - $ref: '#/components/schemas/ImageUploadRequest' + $ref: '#/components/schemas/UpdateExternalStorageRequest' + description: ExternalStorageRequest required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/ImageUploadResponse' - description: Successful response + $ref: '#/components/schemas/UpdateExternalStorageResponse' + description: Response "400": content: application/json: @@ -27193,48 +37594,29 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Upload image + summary: Update External Storage tags: - - product:chat - /api/v2/chat/channels/{type}/{id}/member: - patch: + - product:common + /api/v2/external_storage/{name}/check: + get: description: |2+ - operationId: UpdateMemberPartial + operationId: CheckExternalStorage parameters: - in: path - name: type - required: true - schema: - type: string - writeOnly: true - x-stream-index: "003.001" - - in: path - name: id + name: name required: true schema: type: string writeOnly: true - x-stream-index: "003.002" - - in: query - name: user_id - schema: - type: string - writeOnly: true - x-stream-index: "005.001" - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/UpdateMemberPartialRequest' - required: true + x-stream-index: "002" responses: "200": content: application/json: schema: - $ref: '#/components/schemas/UpdateMemberPartialResponse' - description: Successful response + $ref: '#/components/schemas/CheckExternalStorageResponse' + description: Response "400": content: application/json: @@ -27247,52 +37629,28 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Partially channel member update + summary: Check External Storage tags: - - product:chat - /api/v2/chat/channels/{type}/{id}/message: + - product:common + /api/v2/feeds/activities: post: - description: | - Sends new message to the specified channel - - Sends events: - - message.new - - message.updated - - message.new - - message.updated - operationId: SendMessage - parameters: - - in: path - name: type - required: true - schema: - description: Channel type to interact with - title: Channel type - type: string - writeOnly: true - x-stream-index: "009.001" - - in: path - name: id - required: true - schema: - description: Channel ID to interact with - title: Channel ID - type: string - writeOnly: true - x-stream-index: "009.002" + description: | + Create a new activity or update an existing one + operationId: AddActivity requestBody: content: application/json: schema: - $ref: '#/components/schemas/SendMessageRequest' + $ref: '#/components/schemas/AddActivityRequest' + description: Activity Request required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/SendMessageResponse' - description: Successful response + $ref: '#/components/schemas/AddActivityResponse' + description: Add Activity Response "400": content: application/json: @@ -27305,49 +37663,43 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Send new message + summary: Add a single activity tags: - - product:chat - /api/v2/chat/channels/{type}/{id}/messages: - get: + - product:feeds + /api/v2/feeds/activities/{activity_id}/bookmarks: + delete: description: | - Returns list messages found by IDs - operationId: GetManyMessages + Deletes a bookmark from an activity + operationId: DeleteBookmark parameters: - in: path - name: type + name: activity_id required: true schema: + maxLength: 255 type: string writeOnly: true - x-stream-index: "002.001" - - in: path - name: id - required: true + x-stream-index: "001" + - in: query + name: folder_id schema: + maxLength: 255 type: string writeOnly: true - x-stream-index: "002.002" + x-stream-index: "002" - in: query - name: ids - required: true + name: user_id schema: - description: List of comma-separated IDs - items: - type: string - maximum: 50 - minimum: 1 - title: IDs - type: array + type: string writeOnly: true - x-stream-index: "001" + x-stream-index: "003.001" responses: "200": content: application/json: schema: - $ref: '#/components/schemas/GetManyMessagesResponse' - description: Successful response + $ref: '#/components/schemas/DeleteBookmarkResponse' + description: Delete Bookmark Response "400": content: application/json: @@ -27360,54 +37712,38 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Get many messages + summary: Delete a bookmark tags: - - product:chat - /api/v2/chat/channels/{type}/{id}/query: - post: + - product:feeds + patch: description: | - This Method creates a channel or returns an existing one with matching attributes - - Sends events: - - channel.created - - member.added - - member.removed - - member.updated - - user.watching.start - operationId: GetOrCreateChannel + Updates a bookmark for an activity + operationId: UpdateBookmark parameters: - in: path - name: type + name: activity_id required: true schema: - description: Channel type - maxLength: 64 - title: Type + description: ID of the activity + maxLength: 255 + title: Activity ID type: string writeOnly: true x-stream-index: "001" - - in: path - name: id - required: true - schema: - description: Channel ID (maximum length of 64 characters) - title: ID - type: string - writeOnly: true - x-stream-index: "002" requestBody: content: application/json: schema: - $ref: '#/components/schemas/ChannelGetOrCreateRequest' + $ref: '#/components/schemas/UpdateBookmarkRequest' + description: Update Bookmark Request required: true responses: - "201": + "200": content: application/json: schema: - $ref: '#/components/schemas/ChannelStateResponse' - description: Successful response + $ref: '#/components/schemas/UpdateBookmarkResponse' + description: Update Bookmark Response "400": content: application/json: @@ -27420,46 +37756,36 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Get or create channel + summary: Update bookmark tags: - - product:chat - /api/v2/chat/channels/{type}/{id}/read: + - product:feeds post: description: | - Marks channel as read up to the specific message - - Sends events: - - message.read - - message.read - operationId: MarkRead + Adds a bookmark to an activity + operationId: AddBookmark parameters: - in: path - name: type - required: true - schema: - type: string - writeOnly: true - x-stream-index: "003.001" - - in: path - name: id + name: activity_id required: true schema: + maxLength: 255 type: string writeOnly: true - x-stream-index: "003.002" + x-stream-index: "001" requestBody: content: application/json: schema: - $ref: '#/components/schemas/MarkReadRequest' + $ref: '#/components/schemas/AddBookmarkRequest' + description: Add Bookmark Request required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/MarkReadResponse' - description: Successful response + $ref: '#/components/schemas/AddBookmarkResponse' + description: Add Bookmark Response "400": content: application/json: @@ -27472,50 +37798,37 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Mark read + summary: Add bookmark tags: - - product:chat - /api/v2/chat/channels/{type}/{id}/show: + - product:feeds + /api/v2/feeds/activities/{activity_id}/feedback: post: description: | - Shows previously hidden channel - - Sends events: - - channel.visible - - channel.visible - operationId: ShowChannel + Submit feedback for an activity including options to show less, hide, report, or mute the user + operationId: ActivityFeedback parameters: - in: path - name: type - required: true - schema: - description: Channel type to interact with - title: Channel type - type: string - writeOnly: true - x-stream-index: "001.001" - - in: path - name: id + name: activity_id required: true schema: - description: Channel ID to interact with - title: Channel ID + maxLength: 255 type: string writeOnly: true - x-stream-index: "001.002" + x-stream-index: "001" requestBody: content: application/json: schema: - $ref: '#/components/schemas/ShowChannelRequest' + $ref: '#/components/schemas/ActivityFeedbackRequest' + description: Activity Feedback Request required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/ShowChannelResponse' - description: Response + $ref: '#/components/schemas/ActivityFeedbackResponse' + description: Activity Feedback Response "400": content: application/json: @@ -27528,45 +37841,51 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Show channel + summary: Provide feedback on an activity tags: - - product:chat - /api/v2/chat/channels/{type}/{id}/truncate: + - product:feeds + /api/v2/feeds/activities/{activity_id}/polls/{poll_id}/vote: post: description: | - Truncates messages from a channel. Can be applied to the entire channel or scoped to specific members. + Cast a vote on a poll Sends events: - - channel.truncated - - channel.truncated - operationId: TruncateChannel + - feeds.poll.vote_casted + - feeds.poll.vote_changed + - feeds.poll.vote_removed + - poll.vote_casted + - poll.vote_changed + - poll.vote_removed + operationId: CastPollVote parameters: - in: path - name: type + name: activity_id required: true schema: type: string writeOnly: true - x-stream-index: "001.001" + x-stream-index: "002" - in: path - name: id + name: poll_id required: true schema: + description: Poll ID + maxLength: 255 + title: string type: string - writeOnly: true - x-stream-index: "001.002" + x-stream-index: "003" requestBody: content: application/json: schema: - $ref: '#/components/schemas/TruncateChannelRequest' + $ref: '#/components/schemas/CastPollVoteRequest' required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/TruncateChannelResponse' + $ref: '#/components/schemas/PollVoteResponse' description: Successful response "400": content: @@ -27580,42 +37899,57 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Truncate channel + summary: Cast vote tags: - - product:chat - /api/v2/chat/channels/{type}/{id}/unread: - post: + - product:feeds + /api/v2/feeds/activities/{activity_id}/polls/{poll_id}/vote/{vote_id}: + delete: description: | - Marks channel as unread from a specific message - operationId: MarkUnread + Delete a vote from a poll + + Sends events: + - feeds.poll.vote_removed + - poll.vote_removed + operationId: DeletePollVote parameters: - in: path - name: type + name: activity_id required: true schema: type: string writeOnly: true - x-stream-index: "002.001" + x-stream-index: "003" - in: path - name: id + name: poll_id required: true schema: + description: Poll ID + maxLength: 255 + title: string type: string - writeOnly: true - x-stream-index: "002.002" - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MarkUnreadRequest' + x-stream-index: "004" + - in: path + name: vote_id required: true + schema: + description: Vote ID + maxLength: 255 + title: string + type: string + x-stream-index: "005" + - in: query + name: user_id + schema: + type: string + writeOnly: true + x-stream-index: "001" responses: - "201": + "200": content: application/json: schema: - $ref: '#/components/schemas/Response' - description: Response + $ref: '#/components/schemas/PollVoteResponse' + description: Successful response "400": content: application/json: @@ -27628,29 +37962,20 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Mark unread + summary: Delete vote tags: - - product:chat - /api/v2/chat/channels/{type}/query: + - product:feeds + /api/v2/feeds/activities/{activity_id}/reactions: post: description: | - This Method creates a channel or returns an existing one with matching attributes - - Sends events: - - channel.created - - member.added - - member.removed - - member.updated - - user.watching.start - operationId: GetOrCreateDistinctChannel + Adds a reaction to an activity + operationId: AddReaction parameters: - in: path - name: type + name: activity_id required: true schema: - description: Channel type - maxLength: 64 - title: Type + maxLength: 255 type: string writeOnly: true x-stream-index: "001" @@ -27658,15 +37983,16 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ChannelGetOrCreateRequest' + $ref: '#/components/schemas/AddReactionRequest' + description: Add Reaction Request required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/ChannelStateResponse' - description: Successful response + $ref: '#/components/schemas/AddReactionResponse' + description: Add Reaction Response "400": content: application/json: @@ -27679,31 +38005,44 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Get or create channel + summary: Add reaction tags: - - product:chat - /api/v2/chat/channels/delete: - post: + - product:feeds + /api/v2/feeds/activities/{activity_id}/reactions/{type}: + delete: description: | - Allows to delete several channels at once asynchronously - - Sends events: - - channel.deleted - - channel.deleted - operationId: DeleteChannels - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/DeleteChannelsRequest' + Removes a reaction from an activity + operationId: DeleteActivityReaction + parameters: + - in: path + name: activity_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + - in: path + name: type required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "002" + - in: query + name: user_id + schema: + type: string + writeOnly: true + x-stream-index: "003.001" responses: - "201": + "200": content: application/json: schema: - $ref: '#/components/schemas/DeleteChannelsResponse' - description: Successful response + $ref: '#/components/schemas/DeleteActivityReactionResponse' + description: Delete Activity Reaction Response "400": content: application/json: @@ -27716,58 +38055,35 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Deletes channels asynchronously + summary: Remove reaction tags: - - product:chat - /api/v2/chat/channels/read: + - product:feeds + /api/v2/feeds/activities/{activity_id}/reactions/query: post: description: | - Marks channels as read up to the specific message. If no channels is given, mark all channel as read - - Sends events: - - message.read - - message.read - operationId: MarkChannelsRead + Query activity reactions + operationId: QueryActivityReactions + parameters: + - in: path + name: activity_id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "001" requestBody: content: application/json: schema: - $ref: '#/components/schemas/MarkChannelsReadRequest' + $ref: '#/components/schemas/QueryActivityReactionsRequest' required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/MarkReadResponse' - description: Successful 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 channels as read - tags: - - product:chat - /api/v2/chat/channeltypes: - get: - description: | - Lists all available channel types - operationId: ListChannelTypes - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/ListChannelTypesResponse' - description: ListChannelTypesResponse + $ref: '#/components/schemas/QueryActivityReactionsResponse' + description: Response "400": content: application/json: @@ -27780,27 +38096,39 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: List channel types + summary: Query activity reactions tags: - - product:chat - post: + - product:feeds + /api/v2/feeds/activities/{id}: + delete: description: | - Creates new channel type - operationId: CreateChannelType - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CreateChannelTypeRequest' - description: CreateChannelTypeRequest + Delete a single activity by its ID + operationId: DeleteActivity + parameters: + - in: path + name: id required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + - in: query + name: hard_delete + schema: + description: Whether to permanently delete the activity instead of soft + delete + title: boolean + type: boolean + writeOnly: true + x-stream-index: "002" responses: - "201": + "200": content: application/json: schema: - $ref: '#/components/schemas/CreateChannelTypeResponse' - description: Successful response + $ref: '#/components/schemas/DeleteActivityResponse' + description: Delete Activity Response "400": content: application/json: @@ -27813,21 +38141,18 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Create channel type + summary: Delete a single activity tags: - - product:chat - /api/v2/chat/channeltypes/{name}: - delete: + - product:feeds + get: description: | - Deletes channel type - operationId: DeleteChannelType + Returns activity by ID + operationId: GetActivity parameters: - in: path - name: name + name: id required: true schema: - description: Channel type name - title: Name type: string writeOnly: true x-stream-index: "001" @@ -27836,8 +38161,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Response' - description: Response + $ref: '#/components/schemas/GetActivityResponse' + description: Get Activity Response "400": content: application/json: @@ -27850,30 +38175,38 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Delete channel type + summary: Get activity tags: - - product:chat - get: + - product:feeds + patch: description: | - Gets channel type - operationId: GetChannelType + Updates certain fields of the activity + + Sends events: + - feeds.activity.updated + operationId: UpdateActivityPartial parameters: - in: path - name: name + name: id required: true schema: - description: Channel type name - title: Name + maxLength: 255 type: string writeOnly: true x-stream-index: "001" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateActivityPartialRequest' + required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/GetChannelTypeResponse' - description: Response + $ref: '#/components/schemas/UpdateActivityPartialResponse' + description: Successful response "400": content: application/json: @@ -27886,18 +38219,22 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Get channel type + summary: Partially activity update tags: - - product:chat + - product:feeds put: description: | - Updates channel type - operationId: UpdateChannelType + Replaces an activity with the provided data + + Sends events: + - feeds.activity.updated + operationId: UpdateActivity parameters: - in: path - name: name + name: id required: true schema: + maxLength: 255 type: string writeOnly: true x-stream-index: "001" @@ -27905,14 +38242,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/UpdateChannelTypeRequest' + $ref: '#/components/schemas/UpdateActivityRequest' required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/UpdateChannelTypeResponse' + $ref: '#/components/schemas/UpdateActivityResponse' description: Successful response "400": content: @@ -27926,21 +38263,28 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Update channel type + summary: Full activity update tags: - - product:chat - /api/v2/chat/commands: - get: + - product:feeds + /api/v2/feeds/activities/batch: + post: description: | - Returns all custom commands - operationId: ListCommands + Create new activities or update existing ones in a batch operation + operationId: UpsertActivities + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpsertActivitiesRequest' + description: Upsert Activities Request + required: true responses: - "200": + "201": content: application/json: schema: - $ref: '#/components/schemas/ListCommandsResponse' - description: ListCommandsResponse + $ref: '#/components/schemas/UpsertActivitiesResponse' + description: Upsert Activities Response "400": content: application/json: @@ -27953,27 +38297,28 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: List commands + summary: Upsert multiple activities tags: - - product:chat + - product:feeds + /api/v2/feeds/activities/delete: post: description: | - Creates custom chat command - operationId: CreateCommand + Delete one or more activities by their IDs + operationId: DeleteActivities requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateCommandRequest' - description: CreateCommandRequest + $ref: '#/components/schemas/DeleteActivitiesRequest' + description: Delete Activities Request required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/CreateCommandResponse' - description: CreateCommandResponse + $ref: '#/components/schemas/DeleteActivitiesResponse' + description: Delete Activities Response "400": content: application/json: @@ -27986,30 +38331,28 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Create command + summary: Remove multiple activities tags: - - product:chat - /api/v2/chat/commands/{name}: - delete: + - product:feeds + /api/v2/feeds/activities/query: + post: description: | - Deletes custom chat command - operationId: DeleteCommand - parameters: - - in: path - name: name + Query activities based on filters with pagination and sorting options + operationId: QueryActivities + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueryActivitiesRequest' + description: Query Activities Request required: true - schema: - description: Command name - title: Name - type: string - x-stream-index: "001" responses: - "200": + "201": content: application/json: schema: - $ref: '#/components/schemas/DeleteCommandResponse' - description: DeleteCommandResponse + $ref: '#/components/schemas/QueryActivitiesResponse' + description: Query Activities Response "400": content: application/json: @@ -28022,29 +38365,30 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Delete command + summary: Query activities tags: - - product:chat - get: + - product:feeds + /api/v2/feeds/bookmark_folders/{folder_id}: + delete: description: | - Returns custom command by its name - operationId: GetCommand + Delete a bookmark folder by its ID + operationId: DeleteBookmarkFolder parameters: - in: path - name: name + name: folder_id required: true schema: - description: Command name - title: Name + maxLength: 255 type: string + writeOnly: true x-stream-index: "001" responses: "200": content: application/json: schema: - $ref: '#/components/schemas/GetCommandResponse' - description: GetCommandResponse + $ref: '#/components/schemas/DeleteBookmarkFolderResponse' + description: Delete Bookmark Folder Response "400": content: application/json: @@ -28057,20 +38401,19 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Get command + summary: Delete a bookmark folder tags: - - product:chat - put: + - product:feeds + patch: description: | - Updates custom chat command - operationId: UpdateCommand + Update a bookmark folder by its ID + operationId: UpdateBookmarkFolder parameters: - in: path - name: name + name: folder_id required: true schema: - description: Unique command name - title: Name + maxLength: 255 type: string writeOnly: true x-stream-index: "001" @@ -28078,49 +38421,16 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/UpdateCommandRequest' - description: UpdateCommandRequest - required: true - responses: - "201": - content: - application/json: - schema: - $ref: '#/components/schemas/UpdateCommandResponse' - description: UpdateCommandResponse - "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: Update command - tags: - - product:chat - /api/v2/chat/drafts/query: - post: - description: | - Queries draft messages for a user - operationId: QueryDrafts - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/QueryDraftsRequest' + $ref: '#/components/schemas/UpdateBookmarkFolderRequest' + description: Update Bookmark Folder Request required: true responses: - "201": + "200": content: application/json: schema: - $ref: '#/components/schemas/QueryDraftsResponse' - description: Successful response + $ref: '#/components/schemas/UpdateBookmarkFolderResponse' + description: Update Bookmark Folder Response "400": content: application/json: @@ -28133,27 +38443,28 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Query draft messages + summary: Update a bookmark folder tags: - - product:chat - /api/v2/chat/export_channels: + - product:feeds + /api/v2/feeds/bookmark_folders/query: post: description: | - Exports channel data to JSON file - operationId: ExportChannels + Query bookmark folders with filter query + operationId: QueryBookmarkFolders requestBody: content: application/json: schema: - $ref: '#/components/schemas/ExportChannelsRequest' + $ref: '#/components/schemas/QueryBookmarkFoldersRequest' + description: Query Bookmark Folders Request required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/ExportChannelsResponse' - description: Successful response + $ref: '#/components/schemas/QueryBookmarkFoldersResponse' + description: Query Bookmark Folders Response "400": content: application/json: @@ -28166,29 +38477,28 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Export channels - tags: - - product:chat - /api/v2/chat/members: - get: - description: | - Find and filter channel members - operationId: QueryMembers - parameters: - - content: + summary: Query bookmark folders + tags: + - product:feeds + /api/v2/feeds/bookmarks/query: + post: + description: | + Query bookmarks with filter query + operationId: QueryBookmarks + requestBody: + content: application/json: schema: - $ref: '#/components/schemas/QueryMembersPayload' - x-stream-index: "001" - in: query - name: payload + $ref: '#/components/schemas/QueryBookmarksRequest' + description: Query Bookmarks Request + required: true responses: - "200": + "201": content: application/json: schema: - $ref: '#/components/schemas/MembersResponse' - description: Successful response + $ref: '#/components/schemas/QueryBookmarksResponse' + description: Query Bookmarks Response "400": content: application/json: @@ -28201,49 +38511,97 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Query members + summary: Query bookmarks tags: - - product:chat - /api/v2/chat/messages/{id}: - delete: + - product:feeds + /api/v2/feeds/comments: + get: description: | - Deletes message - - Sends events: - - message.deleted - - message.deleted - operationId: DeleteMessage + Retrieve a threaded list of comments for a specific object (e.g., activity), with configurable depth, sorting, and pagination + operationId: GetComments parameters: - - in: path - name: id + - in: query + name: object_id required: true schema: - description: Message ID to delete - title: ID + description: ID of the object to get comments for + title: Object ID type: string writeOnly: true x-stream-index: "001" - in: query - name: hard + name: object_type + required: true schema: - description: Delete all message reactions and replies as well - title: Hard - type: boolean + description: Type of the object to get comments for + title: Object Type + type: string writeOnly: true x-stream-index: "002" - in: query - name: deleted_by + name: depth schema: - type: string + description: Maximum nested depth to return (0 = only first level) + format: int32 + maximum: 5 + minimum: 0 + title: Max Depth + type: integer writeOnly: true x-stream-index: "003" + - in: query + name: sort + schema: + description: Sort order for the comments + enum: + - first + - last + - top + - best + - controversial + title: Sort Order + type: string + writeOnly: true + x-stream-index: "004" + - in: query + name: replies_limit + schema: + format: int32 + maximum: 20 + minimum: 0 + type: integer + writeOnly: true + x-stream-index: "005" + - in: query + name: limit + schema: + description: Max number of top‑level comments to return + format: int32 + maximum: 100 + minimum: 0 + title: Root Limit + type: integer + writeOnly: true + x-stream-index: "006.001" + - in: query + name: prev + schema: + type: string + writeOnly: true + x-stream-index: "006.002" + - in: query + name: next + schema: + type: string + writeOnly: true + x-stream-index: "006.003" responses: "200": content: application/json: schema: - $ref: '#/components/schemas/DeleteMessageResponse' - description: Response + $ref: '#/components/schemas/GetCommentsResponse' + description: Get Comments Response "400": content: application/json: @@ -28256,28 +38614,60 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Delete message + summary: Get comments for an object tags: - - product:chat - get: + - product:feeds + post: description: | - Returns message by ID - operationId: GetMessage + Adds a comment to an object (e.g., activity) or a reply to an existing comment, and broadcasts appropriate events + operationId: AddComment + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AddCommentRequest' + description: Add Comment Request + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/AddCommentResponse' + description: Add Comment 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: Add a comment or reply + tags: + - product:feeds + /api/v2/feeds/comments/{id}: + delete: + description: | + Deletes a comment from an object (e.g., activity) and broadcasts appropriate events + operationId: DeleteComment parameters: - in: path name: id required: true schema: - description: ID of the message - title: ID type: string writeOnly: true x-stream-index: "001" - in: query - name: show_deleted_message + name: hard_delete schema: - description: Whether to show deleted message - title: Show deleted message + description: Whether to permanently delete the comment instead of soft delete + title: Hard Delete type: boolean writeOnly: true x-stream-index: "002" @@ -28286,8 +38676,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GetMessageResponse' - description: Response + $ref: '#/components/schemas/DeleteCommentResponse' + description: Delete Comment Response "400": content: application/json: @@ -28300,40 +38690,28 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Get message + summary: Delete a comment tags: - - product:chat - post: + - product:feeds + get: description: | - Updates message with new data - - Sends events: - - message.updated - - message.updated - operationId: UpdateMessage + Get a comment by ID + operationId: GetComment parameters: - in: path name: id required: true schema: - description: Message ID - title: ID type: string writeOnly: true - x-stream-index: "004.001" - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/UpdateMessageRequest' - required: true + x-stream-index: "001" responses: - "201": + "200": content: application/json: schema: - $ref: '#/components/schemas/UpdateMessageResponse' - description: Response + $ref: '#/components/schemas/GetCommentResponse' + description: Get Comment Response "400": content: application/json: @@ -28346,17 +38724,13 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Update message + summary: Get comment tags: - - product:chat - put: + - product:feeds + patch: description: | - Updates certain fields of the message - - Sends events: - - message.updated - - message.updated - operationId: UpdateMessagePartial + Updates a comment on an object (e.g., activity) and broadcasts appropriate events + operationId: UpdateComment parameters: - in: path name: id @@ -28364,20 +38738,21 @@ paths: schema: type: string writeOnly: true - x-stream-index: "003.001" + x-stream-index: "001" requestBody: content: application/json: schema: - $ref: '#/components/schemas/UpdateMessagePartialRequest' + $ref: '#/components/schemas/UpdateCommentRequest' + description: Update Comment Request required: true responses: - "201": + "200": content: application/json: schema: - $ref: '#/components/schemas/UpdateMessagePartialResponse' - description: Successful response + $ref: '#/components/schemas/UpdateCommentResponse' + description: Update Comment Response "400": content: application/json: @@ -28390,25 +38765,20 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Partially message update + summary: Update a comment tags: - - product:chat - /api/v2/chat/messages/{id}/action: + - product:feeds + /api/v2/feeds/comments/{id}/reactions: post: description: | - Executes message command action with given parameters - - Sends events: - - message.new - - message.new - operationId: RunMessageAction + Adds a reaction to a comment + operationId: AddCommentReaction parameters: - in: path name: id required: true schema: - description: Message ID - title: ID + maxLength: 255 type: string writeOnly: true x-stream-index: "001" @@ -28416,15 +38786,15 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MessageActionRequest' + $ref: '#/components/schemas/AddCommentReactionRequest' required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/MessageResponse' - description: Response + $ref: '#/components/schemas/AddCommentReactionResponse' + description: Successful response "400": content: application/json: @@ -28437,41 +38807,44 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Run message command action + summary: Add comment reaction tags: - - product:chat - /api/v2/chat/messages/{id}/commit: - post: + - product:feeds + /api/v2/feeds/comments/{id}/reactions/{type}: + delete: description: | - Commits a pending message, which will make it visible in the channel - - Sends events: - - message.new - - message.updated - - message.new - - message.updated - operationId: CommitMessage + Deletes a reaction from a comment + operationId: DeleteCommentReaction parameters: - in: path name: id required: true schema: + maxLength: 255 type: string writeOnly: true x-stream-index: "001" - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CommitMessageRequest' + - in: path + name: type required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "002" + - in: query + name: user_id + schema: + type: string + writeOnly: true + x-stream-index: "003.001" responses: - "201": + "200": content: application/json: schema: - $ref: '#/components/schemas/MessageResponse' - description: Response + $ref: '#/components/schemas/DeleteCommentReactionResponse' + description: Delete Comment Reaction Response "400": content: application/json: @@ -28484,25 +38857,19 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Commit message + summary: Delete comment reaction tags: - - product:chat - /api/v2/chat/messages/{id}/reaction: + - product:feeds + /api/v2/feeds/comments/{id}/reactions/query: post: description: | - Sends reaction to specified message - - Sends events: - - reaction.new - - reaction.updated - operationId: SendReaction + Query comment reactions + operationId: QueryCommentReactions parameters: - in: path name: id required: true schema: - description: Message ID to send reaction for - title: ID type: string writeOnly: true x-stream-index: "001" @@ -28510,14 +38877,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SendReactionRequest' + $ref: '#/components/schemas/QueryCommentReactionsRequest' required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/SendReactionResponse' + $ref: '#/components/schemas/QueryCommentReactionsResponse' description: Response "400": content: @@ -28531,51 +38898,87 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Send reaction + summary: Query comment reactions tags: - - product:chat - /api/v2/chat/messages/{id}/reaction/{type}: - delete: + - product:feeds + /api/v2/feeds/comments/{id}/replies: + get: description: | - Removes user reaction from the message - - Sends events: - - reaction.deleted - operationId: DeleteReaction + Retrieve a threaded list of replies for a single comment, with configurable depth, sorting, and pagination + operationId: GetCommentReplies parameters: - in: path name: id required: true schema: - description: Message ID to remove reaction from - title: ID type: string writeOnly: true x-stream-index: "001" - - in: path - name: type - required: true + - in: query + name: depth schema: - description: Reaction type to remove - title: Type - type: string + description: Maximum nested depth to return (0 = unlimited) + format: int32 + maximum: 5 + minimum: 0 + title: Max Depth + type: integer writeOnly: true x-stream-index: "002" - in: query - name: user_id + name: sort schema: - description: '**Server-side only**. User ID which server acts upon' - title: User ID + description: first (oldest), last (newest) or top + enum: + - first + - last + - top + - best + - controversial + title: Sort Order type: string writeOnly: true x-stream-index: "003" + - in: query + name: replies_limit + schema: + description: Max number of replies to return + format: int32 + minimum: 0 + title: Replies Limit + type: integer + writeOnly: true + x-stream-index: "004" + - in: query + name: limit + schema: + description: Max number of direct replies to return + format: int32 + maximum: 100 + minimum: 0 + title: Reply Limit + type: integer + writeOnly: true + x-stream-index: "005.001" + - in: query + name: prev + schema: + type: string + writeOnly: true + x-stream-index: "005.002" + - in: query + name: next + schema: + type: string + writeOnly: true + x-stream-index: "005.003" responses: "200": content: application/json: schema: - $ref: '#/components/schemas/DeleteReactionResponse' - description: Response + $ref: '#/components/schemas/GetCommentRepliesResponse' + description: Get Comment Replies Response "400": content: application/json: @@ -28588,49 +38991,28 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Delete reaction + summary: Get replies for a comment tags: - - product:chat - /api/v2/chat/messages/{id}/reactions: - get: + - product:feeds + /api/v2/feeds/comments/batch: + post: description: | - Returns list of reactions of specific message - operationId: GetReactions - parameters: - - in: path - name: id + Adds multiple comments in a single request. Each comment must specify the object type and ID. + operationId: AddCommentsBatch + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AddCommentsBatchRequest' + description: Add Comments Batch Request required: true - schema: - description: Message ID - title: ID - type: string - writeOnly: true - x-stream-index: "001" - - in: query - name: limit - schema: - description: Number of records to return - format: int32 - title: Limit - type: integer - writeOnly: true - x-stream-index: "002" - - in: query - name: offset - schema: - description: Number of records to offset - format: int32 - title: Offset - type: integer - writeOnly: true - x-stream-index: "003" responses: - "200": + "201": content: application/json: schema: - $ref: '#/components/schemas/GetReactionsResponse' - description: Successful response + $ref: '#/components/schemas/AddCommentsBatchResponse' + description: Add Comments Batch Response "400": content: application/json: @@ -28643,33 +39025,54 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Get reactions + summary: Add multiple comments in a batch tags: - - product:chat + - product:feeds + /api/v2/feeds/comments/query: post: description: | - Get reactions on a message - operationId: QueryReactions - parameters: - - in: path - name: id - required: true - schema: - type: string - writeOnly: true - x-stream-index: "001" + Query comments using MongoDB-style filters with pagination and sorting options + operationId: QueryComments requestBody: content: application/json: schema: - $ref: '#/components/schemas/QueryReactionsRequest' + $ref: '#/components/schemas/QueryCommentsRequest' + description: Query Comments Request required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/QueryReactionsResponse' + $ref: '#/components/schemas/QueryCommentsResponse' + description: Query Comments 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: Query comments + tags: + - product:feeds + /api/v2/feeds/feed_groups: + get: + description: | + List all feed groups for the application + operationId: ListFeedGroups + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/ListFeedGroupsResponse' description: Response "400": content: @@ -28683,40 +39086,27 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests + summary: List all feed groups tags: - - product:chat - /api/v2/chat/messages/{id}/translate: + - product:feeds post: description: | - Translates message to a given language using automated translation software - - Sends events: - - message.updated - - message.updated - operationId: TranslateMessage - parameters: - - in: path - name: id - required: true - schema: - description: Message ID - title: ID - type: string - writeOnly: true - x-stream-index: "002.001" + Creates a new feed group with the specified configuration + operationId: CreateFeedGroup requestBody: content: application/json: schema: - $ref: '#/components/schemas/TranslateMessageRequest' + $ref: '#/components/schemas/CreateFeedGroupRequest' + description: Create Feed Group Request required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/MessageResponse' - description: Response + $ref: '#/components/schemas/CreateFeedGroupResponse' + description: Upsert Feed Group Response "400": content: application/json: @@ -28729,41 +39119,46 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Translate message + summary: Create a new feed group tags: - - product:chat - /api/v2/chat/messages/{id}/undelete: - post: + - product:feeds + /api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}: + delete: description: | - Undelete a message that was previously soft-deleted - - Sends events: - - message.undeleted - - message.undeleted - operationId: UndeleteMessage + Delete a single feed by its ID + operationId: DeleteFeed parameters: - in: path - name: id + name: feed_group_id required: true schema: - description: Message ID - title: ID + maxLength: 255 type: string writeOnly: true - x-stream-index: "004.001" - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/UpdateMessageRequest' + x-stream-index: "001" + - in: path + name: feed_id required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "002" + - in: query + name: hard_delete + schema: + description: Whether to permanently delete the feed instead of soft delete + title: boolean + type: boolean + writeOnly: true + x-stream-index: "003" responses: - "201": + "200": content: application/json: schema: - $ref: '#/components/schemas/UpdateMessageResponse' - description: Response + $ref: '#/components/schemas/DeleteFeedResponse' + description: Delete Feed Response "400": content: application/json: @@ -28776,52 +39171,44 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Undelete message + summary: Delete a single feed tags: - - product:chat - /api/v2/chat/messages/{message_id}/polls/{poll_id}/vote: + - product:feeds post: description: | - Cast a vote on a poll - - Sends events: - - feeds.poll.vote_casted - - feeds.poll.vote_changed - - feeds.poll.vote_removed - - poll.vote_casted - - poll.vote_changed - - poll.vote_removed - operationId: CastPollVote + Create a single feed for a given feed group + operationId: GetOrCreateFeed parameters: - in: path - name: message_id + name: feed_group_id required: true schema: + maxLength: 255 type: string writeOnly: true x-stream-index: "001" - in: path - name: poll_id + name: feed_id required: true schema: - description: Poll ID maxLength: 255 - title: string type: string - x-stream-index: "003" + writeOnly: true + x-stream-index: "002" requestBody: content: application/json: schema: - $ref: '#/components/schemas/CastPollVoteRequest' + $ref: '#/components/schemas/GetOrCreateFeedRequest' + description: ClientRequest required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/PollVoteResponse' - description: Successful response + $ref: '#/components/schemas/GetOrCreateFeedResponse' + description: Response "400": content: application/json: @@ -28834,57 +39221,44 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Cast vote + summary: Create a new feed tags: - - product:chat - /api/v2/chat/messages/{message_id}/polls/{poll_id}/vote/{vote_id}: - delete: + - product:feeds + put: description: | - Delete a vote from a poll - - Sends events: - - feeds.poll.vote_removed - - poll.vote_removed - operationId: DeletePollVote + Update an existing feed + operationId: UpdateFeed parameters: - in: path - name: message_id - required: true - schema: - type: string - writeOnly: true - x-stream-index: "002" - - in: path - name: poll_id + name: feed_group_id required: true schema: - description: Poll ID maxLength: 255 - title: string type: string - x-stream-index: "004" + writeOnly: true + x-stream-index: "001" - in: path - name: vote_id + name: feed_id required: true schema: - description: Vote ID maxLength: 255 - title: string - type: string - x-stream-index: "005" - - in: query - name: user_id - schema: type: string writeOnly: true - x-stream-index: "001" + x-stream-index: "002" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateFeedRequest' + description: Update Feed Request + required: true responses: - "200": + "201": content: application/json: schema: - $ref: '#/components/schemas/PollVoteResponse' - description: Successful response + $ref: '#/components/schemas/UpdateFeedResponse' + description: Update Feed Response "400": content: application/json: @@ -28897,38 +39271,51 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Delete vote + summary: Update a feed tags: - - product:chat - /api/v2/chat/messages/{message_id}/reminders: + - product:feeds + /api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/activities/{activity_id}/pin: delete: description: | - Deletes a user's created reminder - - Sends events: - - reminder.deleted - operationId: DeleteReminder + Unpin an activity from a feed. This removes the pin, so the activity will no longer be displayed at the top of the feed. + operationId: UnpinActivity parameters: - in: path - name: message_id + name: feed_group_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + - in: path + name: feed_id required: true schema: + maxLength: 255 type: string writeOnly: true x-stream-index: "002" + - in: path + name: activity_id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "003" - in: query name: user_id schema: type: string writeOnly: true - x-stream-index: "001" + x-stream-index: "004.001" responses: "200": content: application/json: schema: - $ref: '#/components/schemas/DeleteReminderResponse' - description: Response + $ref: '#/components/schemas/UnpinActivityResponse' + description: Unpin Activity Response "400": content: application/json: @@ -28941,37 +39328,51 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Delete reminder + summary: Unpin an activity from a feed tags: - - product:chat - patch: + - product:feeds + post: description: | - Updates an existing reminder - - Sends events: - - reminder.updated - operationId: UpdateReminder + Pin an activity to a feed. Pinned activities are typically displayed at the top of a feed. + operationId: PinActivity parameters: - in: path - name: message_id + name: feed_group_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + - in: path + name: feed_id required: true schema: + maxLength: 255 type: string writeOnly: true x-stream-index: "002" + - in: path + name: activity_id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "003" requestBody: content: application/json: schema: - $ref: '#/components/schemas/UpdateReminderRequest' + $ref: '#/components/schemas/PinActivityRequest' + description: Pin Activity Request required: true responses: - "200": + "201": content: application/json: schema: - $ref: '#/components/schemas/UpdateReminderResponse' - description: Response + $ref: '#/components/schemas/PinActivityResponse' + description: Pin Activity Response "400": content: application/json: @@ -28984,21 +39385,28 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Updates Reminder + summary: Pin an activity to a feed tags: - - product:chat + - product:feeds + /api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/activities/mark/batch: post: description: | - Creates a new reminder - - Sends events: - - reminder.created - operationId: CreateReminder + Mark activities as read/seen/watched. Can mark by timestamp (seen), activity IDs (read), or all as read. + operationId: MarkActivity parameters: - in: path - name: message_id + name: feed_group_id required: true schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + - in: path + name: feed_id + required: true + schema: + maxLength: 255 type: string writeOnly: true x-stream-index: "002" @@ -29006,15 +39414,16 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/CreateReminderRequest' + $ref: '#/components/schemas/MarkActivityRequest' + description: Mark Activity Request required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/ReminderResponseData' - description: Successful response + $ref: '#/components/schemas/Response' + description: Response "400": content: application/json: @@ -29027,141 +39436,44 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Create reminder + summary: Mark activities as read/seen/watched tags: - - product:chat - /api/v2/chat/messages/{parent_id}/replies: - get: + - product:feeds + /api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/members: + patch: description: | - Returns replies (thread) of the message - operationId: GetReplies + Add, remove, or set members for a feed + operationId: UpdateFeedMembers parameters: - in: path - name: parent_id + name: feed_group_id required: true schema: + maxLength: 255 type: string writeOnly: true x-stream-index: "001" - - in: query - name: sort + - in: path + name: feed_id + required: true schema: - items: - $ref: '#/components/schemas/SortParamRequest' - maximum: 1 - type: array + maxLength: 255 + type: string writeOnly: true x-stream-index: "002" - - in: query - name: limit - schema: - description: 'The maximum number of messages to return (max limit ' - format: int32 - minimum: 0 - title: Limit - type: integer - x-stream-index: "003.001" - - in: query - name: offset - schema: - description: The offset to start from - format: int32 - title: Offset - type: integer - x-stream-index: "003.002" - - in: query - name: id_gte - schema: - description: The ID of the message to get messages with a timestamp greater - than or equal to - title: IDGTE - type: string - x-stream-index: "003.003" - - in: query - name: id_gt - schema: - description: The ID of the message to get messages with a timestamp greater - than - title: IDGT - type: string - x-stream-index: "003.004" - - in: query - name: id_lte - schema: - description: The ID of the message to get messages with a timestamp smaller - than or equal to - title: IDLTE - type: string - x-stream-index: "003.005" - - in: query - name: id_lt - schema: - description: The ID of the message to get messages with a timestamp smaller - than - title: IDLT - type: string - x-stream-index: "003.006" - - in: query - name: created_at_after_or_equal - schema: - description: The timestamp to get messages with a created_at timestamp greater - than or equal to - format: date-time - title: Created_at after or equal - type: number - x-stream-index: "003.007" - - in: query - name: created_at_after - schema: - description: The timestamp to get messages with a created_at timestamp greater - than - format: date-time - title: Created_at after - type: number - x-stream-index: "003.008" - - in: query - name: created_at_before_or_equal - schema: - description: The timestamp to get messages with a created_at timestamp smaller - than or equal to - format: date-time - title: Created_at after before or equal - type: number - x-stream-index: "003.009" - - in: query - name: created_at_before - schema: - description: The timestamp to get messages with a created_at timestamp smaller - than - format: date-time - title: Created_at after before - type: number - x-stream-index: "003.010" - - in: query - name: id_around - schema: - description: The result will be a set of messages, that are both older and - newer than the message with the provided ID, and the message with the - ID provided will be in the middle of the set - title: Id around - type: string - x-stream-index: "003.011" - - in: query - name: created_at_around - schema: - description: The result will be a set of messages, that are both older and - newer than the created_at timestamp provided, distributed evenly around - the timestamp - format: date-time - title: Created_at around - type: number - x-stream-index: "003.012" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateFeedMembersRequest' + description: Update Feed Members Request + required: true responses: "200": content: application/json: schema: - $ref: '#/components/schemas/GetRepliesResponse' + $ref: '#/components/schemas/UpdateFeedMembersResponse' description: Response "400": content: @@ -29175,64 +39487,45 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Get replies + summary: Update feed members tags: - - product:chat - /api/v2/chat/messages/history: + - product:feeds + /api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/members/accept: post: description: | - Queries history for one message - operationId: QueryMessageHistory + Accepts a pending feed member request + operationId: AcceptFeedMemberInvite + parameters: + - in: path + name: feed_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + - in: path + name: feed_group_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "002" requestBody: content: application/json: schema: - $ref: '#/components/schemas/QueryMessageHistoryRequest' + $ref: '#/components/schemas/AcceptFeedMemberInviteRequest' + description: Accept Feed Member Invite Request required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/QueryMessageHistoryResponse' - description: Successful 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: Query message history - tags: - - product:chat - /api/v2/chat/moderation/flags/message: - get: - description: | - Find and filter message flags - operationId: QueryMessageFlags - parameters: - - content: - application/json: - schema: - $ref: '#/components/schemas/QueryMessageFlagsPayload' - description: JSON object with query message flags payload - title: Payload - x-stream-index: "001" - in: query - name: payload - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/QueryMessageFlagsResponse' - description: QueryMessageFlagsResponse + $ref: '#/components/schemas/AcceptFeedMemberInviteResponse' + description: Accept Feed Member Invite Response "400": content: application/json: @@ -29245,30 +39538,43 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Query Message Flags + summary: Accept a feed member request tags: - - product:chat - /api/v2/chat/moderation/mute/channel: + - product:feeds + /api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/members/query: post: description: | - Mutes channel for user - - Sends events: - - channel.muted - - channel.muted - operationId: MuteChannel + Query feed members based on filters with pagination and sorting options + operationId: QueryFeedMembers + parameters: + - in: path + name: feed_group_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + - in: path + name: feed_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "002" requestBody: content: application/json: schema: - $ref: '#/components/schemas/MuteChannelRequest' + $ref: '#/components/schemas/QueryFeedMembersRequest' required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/MuteChannelResponse' + $ref: '#/components/schemas/QueryFeedMembersResponse' description: Successful response "400": content: @@ -29282,31 +39588,45 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Mute channel + summary: Query feed members tags: - - product:chat - /api/v2/chat/moderation/unmute/channel: + - product:feeds + /api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/members/reject: post: description: | - Unmutes channel for user - - Sends events: - - channel.unmuted - - channel.unmuted - operationId: UnmuteChannel + Rejects a pending feed member request + operationId: RejectFeedMemberInvite + parameters: + - in: path + name: feed_group_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "001" + - in: path + name: feed_id + required: true + schema: + maxLength: 255 + type: string + writeOnly: true + x-stream-index: "002" requestBody: content: application/json: schema: - $ref: '#/components/schemas/UnmuteChannelRequest' + $ref: '#/components/schemas/RejectFeedMemberInviteRequest' + description: Reject Feed Member Request required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/UnmuteResponse' - description: Response + $ref: '#/components/schemas/RejectFeedMemberInviteResponse' + description: Reject Feed Member Response "400": content: application/json: @@ -29319,27 +39639,52 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Unmute channel + summary: Reject an invite to become a feed member tags: - - product:chat - /api/v2/chat/push_preferences: - post: + - product:feeds + /api/v2/feeds/feed_groups/{feed_group_id}/follow_suggestions: + get: description: | - Update the push preferences for a user and or channel member. Set to all, mentions or none - operationId: UpdatePushNotificationPreferences - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/UpsertPushPreferencesRequest' + Get follow suggestions for a feed group + operationId: GetFollowSuggestions + parameters: + - in: path + name: feed_group_id required: true + schema: + description: The ID of the feed group to get suggestions for + maxLength: 255 + title: Feed Group ID + type: string + writeOnly: true + x-stream-index: "001" + - in: query + name: limit + schema: + description: Maximum number of suggestions to return + format: int32 + maximum: 100 + minimum: 1 + title: Limit + type: integer + writeOnly: true + x-stream-index: "002" + - in: query + name: user_id + schema: + description: The ID of the user requesting suggestions (optional, defaults + to current user) + title: User ID + type: string + writeOnly: true + x-stream-index: "003.001" responses: - "201": + "200": content: application/json: schema: - $ref: '#/components/schemas/UpsertPushPreferencesResponse' - description: Successful response + $ref: '#/components/schemas/GetFollowSuggestionsResponse' + description: Follow Suggestions Response "400": content: application/json: @@ -29352,41 +39697,38 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Push notification preferences + summary: Get follow suggestions tags: - - product:chat - /api/v2/chat/push_templates: - get: + - product:feeds + /api/v2/feeds/feed_groups/{id}: + delete: description: | - Retrieve push notification templates for Chat. - operationId: GetPushTemplates + Delete a feed group by its ID. Can perform a soft delete (default) or hard delete. + operationId: DeleteFeedGroup parameters: - - in: query - name: push_provider_name + - in: path + name: id + required: true schema: - description: Push provider name to filter templates - title: string + maxLength: 255 type: string writeOnly: true - x-stream-index: "002" + x-stream-index: "001" - in: query - name: push_provider_type - required: true + name: hard_delete schema: - description: Push provider type (firebase, apn) to filter templates - enum: - - firebase - - apn - title: string - type: string + description: Whether to perform a hard delete (true) or soft delete (false, + default) + title: boolean + type: boolean writeOnly: true - x-stream-index: "003" + x-stream-index: "002" responses: "200": content: application/json: schema: - $ref: '#/components/schemas/GetPushTemplatesResponse' + $ref: '#/components/schemas/DeleteFeedGroupResponse' description: Response "400": content: @@ -29400,26 +39742,28 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Get push notification templates + summary: Delete a feed group tags: - - product:chat - post: + - product:feeds + get: description: | - Create or update a push notification template for a specific event type and push provider - operationId: UpsertPushTemplate - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/UpsertPushTemplateRequest' + Get a feed group by ID + operationId: GetFeedGroup + parameters: + - in: path + name: id required: true + schema: + type: string + writeOnly: true + x-stream-index: "001" responses: - "201": + "200": content: application/json: schema: - $ref: '#/components/schemas/UpsertPushTemplateResponse' - description: Response + $ref: '#/components/schemas/GetFeedGroupResponse' + description: Get Feed Group Response "400": content: application/json: @@ -29432,31 +39776,38 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Upsert a push notification template + summary: Get a feed group tags: - - product:chat - /api/v2/chat/query_banned_users: - get: + - product:feeds + post: description: | - Find and filter channel scoped or global user bans - operationId: QueryBannedUsers + Get an existing feed group or create a new one if it doesn't exist + operationId: GetOrCreateFeedGroup parameters: - - content: + - in: path + name: id + required: true + schema: + description: Unique identifier for the feed group + maxLength: 255 + title: Feed Group ID + type: string + writeOnly: true + x-stream-index: "001" + requestBody: + content: application/json: schema: - $ref: '#/components/schemas/QueryBannedUsersPayload' - description: JSON object with query user bans payload - title: Payload - x-stream-index: "001" - in: query - name: payload + $ref: '#/components/schemas/GetOrCreateFeedGroupRequest' + description: Get Or Create Feed Group Request + required: true responses: - "200": + "201": content: application/json: schema: - $ref: '#/components/schemas/QueryBannedUsersResponse' - description: Successful response + $ref: '#/components/schemas/GetOrCreateFeedGroupResponse' + description: Get Or Create Feed Group Response "400": content: application/json: @@ -29469,27 +39820,35 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Query Banned Users + summary: Get or create a feed group tags: - - product:chat - /api/v2/chat/reminders/query: - post: + - product:feeds + put: description: | - Queries reminders - operationId: QueryReminders + Update a feed group by ID + operationId: UpdateFeedGroup + parameters: + - in: path + name: id + required: true + schema: + type: string + writeOnly: true + x-stream-index: "001" requestBody: content: application/json: schema: - $ref: '#/components/schemas/QueryRemindersRequest' + $ref: '#/components/schemas/UpdateFeedGroupRequest' + description: Update Feed Group Request required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/QueryRemindersResponse' - description: Successful response + $ref: '#/components/schemas/UpdateFeedGroupResponse' + description: Update Feed Group Response "400": content: application/json: @@ -29502,31 +39861,21 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Query reminders + summary: Update a feed group tags: - - product:chat - /api/v2/chat/search: + - product:feeds + /api/v2/feeds/feed_views: get: description: | - Search messages across channels - operationId: Search - parameters: - - content: - application/json: - schema: - $ref: '#/components/schemas/SearchPayload' - description: JSON object with search payload - title: Payload - x-stream-index: "001" - in: query - name: payload + List all feed views for a feed group + operationId: ListFeedViews responses: "200": content: application/json: schema: - $ref: '#/components/schemas/SearchResponse' - description: Successful response + $ref: '#/components/schemas/ListFeedViewsResponse' + description: List Feed Views Response "400": content: application/json: @@ -29539,30 +39888,27 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Search messages + summary: List all feed views tags: - - product:chat - /api/v2/chat/segments/{id}: - delete: + - product:feeds + post: description: | - Delete a segment - operationId: DeleteSegment - parameters: - - in: path - name: id + Create a custom view for a feed group with specific selectors, ranking, or aggregation options + operationId: CreateFeedView + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateFeedViewRequest' + description: Create Feed View Request required: true - schema: - maxLength: 255 - type: string - writeOnly: true - x-stream-index: "001" responses: - "200": + "201": content: application/json: schema: - $ref: '#/components/schemas/Response' - description: Response + $ref: '#/components/schemas/CreateFeedViewResponse' + description: Create Feed View Response "400": content: application/json: @@ -29575,13 +39921,14 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Delete segment + summary: Create a new feed view tags: - - product:chat - get: + - product:feeds + /api/v2/feeds/feed_views/{id}: + delete: description: | - Get segment - operationId: GetSegment + Delete an existing custom feed view + operationId: DeleteFeedView parameters: - in: path name: id @@ -29596,8 +39943,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GetSegmentResponse' - description: Successful response + $ref: '#/components/schemas/DeleteFeedViewResponse' + description: Delete Feed View Response "400": content: application/json: @@ -29610,14 +39957,13 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Get segment + summary: Delete a feed view tags: - - product:chat - /api/v2/chat/segments/{id}/deletetargets: - post: + - product:feeds + get: description: | - Delete targets from a segment - operationId: DeleteSegmentTargets + Get a feed view by its ID + operationId: GetFeedView parameters: - in: path name: id @@ -29627,19 +39973,13 @@ paths: type: string writeOnly: true x-stream-index: "001" - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/DeleteSegmentTargetsRequest' - required: true responses: - "201": + "200": content: application/json: schema: - $ref: '#/components/schemas/Response' - description: Response + $ref: '#/components/schemas/GetFeedViewResponse' + description: Get Feed View Response "400": content: application/json: @@ -29652,14 +39992,13 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Delete targets from a segment + summary: Get a feed view tags: - - product:chat - /api/v2/chat/segments/{id}/target/{target_id}: - get: + - product:feeds + post: description: | - Check whether a target exists in a segment. Returns 200 if the target exists, 404 otherwise - operationId: SegmentTargetExists + Get an existing feed view or create a new one if it doesn't exist + operationId: GetOrCreateFeedView parameters: - in: path name: id @@ -29669,20 +40008,20 @@ paths: type: string writeOnly: true x-stream-index: "001" - - in: path - name: target_id + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GetOrCreateFeedViewRequest' + description: Get Or Create Feed View Request required: true - schema: - type: string - writeOnly: true - x-stream-index: "002" responses: - "200": + "201": content: application/json: schema: - $ref: '#/components/schemas/Response' - description: Response + $ref: '#/components/schemas/GetOrCreateFeedViewResponse' + description: Get Or Create Feed View Response "400": content: application/json: @@ -29695,14 +40034,13 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Check whether a target exists in a segment + summary: Get or create a feed view tags: - - product:chat - /api/v2/chat/segments/{id}/targets/query: - post: + - product:feeds + put: description: | - Query segment targets - operationId: QuerySegmentTargets + Update an existing custom feed view with new selectors, ranking, or aggregation options + operationId: UpdateFeedView parameters: - in: path name: id @@ -29716,15 +40054,16 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/QuerySegmentTargetsRequest' + $ref: '#/components/schemas/UpdateFeedViewRequest' + description: Update Feed View Request required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/QuerySegmentTargetsResponse' - description: Successful response + $ref: '#/components/schemas/UpdateFeedViewResponse' + description: Update Feed View Response "400": content: application/json: @@ -29737,27 +40076,28 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Query segment targets + summary: Update a feed view tags: - - product:chat - /api/v2/chat/segments/query: + - product:feeds + /api/v2/feeds/feeds/batch: post: description: | - Query segments - operationId: QuerySegments + Create multiple feeds at once for a given feed group + operationId: CreateFeedsBatch requestBody: content: application/json: schema: - $ref: '#/components/schemas/QuerySegmentsRequest' + $ref: '#/components/schemas/CreateFeedsBatchRequest' + description: Create Feeds Batch Request required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/QuerySegmentsResponse' - description: Successful response + $ref: '#/components/schemas/CreateFeedsBatchResponse' + description: Create Feeds Batch Response "400": content: application/json: @@ -29770,27 +40110,28 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Query segments + summary: Create multiple feeds at once tags: - - product:chat - /api/v2/chat/threads: + - product:feeds + /api/v2/feeds/feeds/query: post: description: | - Returns the list of threads for specific user - operationId: QueryThreads + Query feeds with filter query + operationId: QueryFeeds requestBody: content: application/json: schema: - $ref: '#/components/schemas/QueryThreadsRequest' + $ref: '#/components/schemas/QueryFeedsRequest' + description: Query Feeds Request required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/QueryThreadsResponse' - description: Successful response + $ref: '#/components/schemas/QueryFeedsResponse' + description: Query Feeds Response "400": content: application/json: @@ -29803,61 +40144,28 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Query Threads + summary: Query feeds tags: - - product:chat - /api/v2/chat/threads/{message_id}: - get: + - product:feeds + /api/v2/feeds/follows: + patch: description: | - Return a specific thread - operationId: GetThread - parameters: - - in: path - name: message_id + Updates a follow's custom data, push preference, and follower role. Source owner can update custom data and push preference. Target owner can update follower role. + operationId: UpdateFollow + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateFollowRequest' + description: Update Follow Request required: true - schema: - type: string - writeOnly: true - x-stream-index: "001" - - in: query - name: reply_limit - schema: - description: Limit the number of replies returned - format: int32 - minimum: 0 - title: Reply limit - type: integer - writeOnly: true - x-stream-index: "004" - - in: query - name: participant_limit - schema: - description: Limit the number of participants returned - format: int32 - maximum: 100 - minimum: 0 - title: Participant limit - type: integer - writeOnly: true - x-stream-index: "005" - - in: query - name: member_limit - schema: - description: Limit the number of members returned per thread channel - format: int32 - maximum: 100 - minimum: 0 - title: Member limit - type: integer - writeOnly: true - x-stream-index: "006" responses: "200": content: application/json: schema: - $ref: '#/components/schemas/GetThreadResponse' - description: Successful response + $ref: '#/components/schemas/UpdateFollowResponse' + description: Update Follow Response "400": content: application/json: @@ -29870,38 +40178,27 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Get Thread + summary: Update a follow tags: - - product:chat - patch: + - product:feeds + post: description: | - Updates certain fields of the thread - - Sends events: - - thread.updated - - thread.updated - operationId: UpdateThreadPartial - parameters: - - in: path - name: message_id - required: true - schema: - type: string - writeOnly: true - x-stream-index: "001" + Creates a follow and broadcasts FollowAddedEvent + operationId: Follow requestBody: content: application/json: schema: - $ref: '#/components/schemas/UpdateThreadPartialRequest' + $ref: '#/components/schemas/FollowRequest' + description: Follow Request required: true responses: - "200": + "201": content: application/json: schema: - $ref: '#/components/schemas/UpdateThreadPartialResponse' - description: Successful response + $ref: '#/components/schemas/SingleFollowResponse' + description: Follow Response "400": content: application/json: @@ -29914,21 +40211,42 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Partially update thread + summary: Create a follow tags: - - product:chat - /api/v2/chat/unread: - get: + - product:feeds + /api/v2/feeds/follows/{source}/{target}: + delete: description: | - Fetch unread counts for a single user - operationId: UnreadCounts + Removes a follow and broadcasts FollowRemovedEvent + operationId: Unfollow + parameters: + - in: path + name: source + required: true + schema: + description: Fully qualified ID of the source feed + maxLength: 255 + title: Source Feed + type: string + writeOnly: true + x-stream-index: "001" + - in: path + name: target + required: true + schema: + description: Fully qualified ID of the target feed + maxLength: 255 + title: Target Feed + type: string + writeOnly: true + x-stream-index: "002" responses: "200": content: application/json: schema: - $ref: '#/components/schemas/WrappedUnreadCountsResponse' - description: Response + $ref: '#/components/schemas/UnfollowResponse' + description: Unfollow Response "400": content: application/json: @@ -29941,27 +40259,28 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Unread counts + summary: Unfollow a feed tags: - - product:chat - /api/v2/chat/unread_batch: + - product:feeds + /api/v2/feeds/follows/accept: post: description: | - Fetch unread counts in batch for multiple users in one call - operationId: UnreadCountsBatch + Accepts a pending follow request + operationId: AcceptFollow requestBody: content: application/json: schema: - $ref: '#/components/schemas/UnreadCountsBatchRequest' + $ref: '#/components/schemas/AcceptFollowRequest' + description: Accept Follow Request required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/UnreadCountsBatchResponse' - description: Response + $ref: '#/components/schemas/AcceptFollowResponse' + description: Accept Follow Response "400": content: application/json: @@ -29974,38 +40293,28 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Batch unread counts + summary: Accept a follow request tags: - - product:chat - /api/v2/chat/users/{user_id}/event: + - product:feeds + /api/v2/feeds/follows/batch: post: description: | - Sends a custom event to a user - - Sends events: - - * - operationId: SendUserCustomEvent - parameters: - - in: path - name: user_id - required: true - schema: - type: string - writeOnly: true - x-stream-index: "002" + Creates multiple follows at once and broadcasts FollowAddedEvent for each follow + operationId: FollowBatch requestBody: content: application/json: schema: - $ref: '#/components/schemas/SendUserCustomEventRequest' + $ref: '#/components/schemas/FollowBatchRequest' + description: Follow Batch Request required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/Response' - description: Response + $ref: '#/components/schemas/FollowBatchResponse' + description: Follow Batch Response "400": content: application/json: @@ -30018,28 +40327,28 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Send user event + summary: Create multiple follows at once tags: - - product:chat - /api/v2/check_push: + - product:feeds + /api/v2/feeds/follows/query: post: description: | - Sends a test message via push, this is a test endpoint to verify your push settings - operationId: CheckPush + Query follows based on filters with pagination and sorting options + operationId: QueryFollows requestBody: content: application/json: schema: - $ref: '#/components/schemas/CheckPushRequest' - description: CheckPushRequest + $ref: '#/components/schemas/QueryFollowsRequest' + description: Query Follows Request required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/CheckPushResponse' - description: Successful response + $ref: '#/components/schemas/QueryFollowsResponse' + description: Query Follows Response "400": content: application/json: @@ -30052,27 +40361,28 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Check push + summary: Query follows tags: - - product:common - /api/v2/check_sns: + - product:feeds + /api/v2/feeds/follows/reject: post: description: | - Validates Amazon SNS configuration - operationId: CheckSNS + Rejects a pending follow request + operationId: RejectFollow requestBody: content: application/json: schema: - $ref: '#/components/schemas/CheckSNSRequest' + $ref: '#/components/schemas/RejectFollowRequest' + description: Reject Follow Request required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/CheckSNSResponse' - description: Successful response + $ref: '#/components/schemas/RejectFollowResponse' + description: Reject Follow Response "400": content: application/json: @@ -30085,27 +40395,28 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Check SNS + summary: Reject a follow request tags: - - product:common - /api/v2/check_sqs: + - product:feeds + /api/v2/feeds/membership_levels: post: description: | - Validates Amazon SQS credentials - operationId: CheckSQS + Create a new membership level with tag-based access controls + operationId: CreateMembershipLevel requestBody: content: application/json: schema: - $ref: '#/components/schemas/CheckSQSRequest' + $ref: '#/components/schemas/CreateMembershipLevelRequest' + description: Create Membership Level Request required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/CheckSQSResponse' - description: Successful response + $ref: '#/components/schemas/CreateMembershipLevelResponse' + description: Create Membership Level Response "400": content: application/json: @@ -30118,32 +40429,25 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Check SQS + summary: Create membership level tags: - - product:common - /api/v2/devices: + - product:feeds + /api/v2/feeds/membership_levels/{id}: delete: description: | - Deletes one device - operationId: DeleteDevice + Delete a membership level by its UUID. This operation is irreversible. + operationId: DeleteMembershipLevel parameters: - - in: query + - in: path name: id required: true schema: - description: Device ID to delete - title: ID + description: The UUID of the membership level to delete + maxLength: 255 + title: string type: string writeOnly: true x-stream-index: "001" - - in: query - name: user_id - schema: - description: '**Server-side only**. User ID which server acts upon' - title: User ID - type: string - writeOnly: true - x-stream-index: "002.001" responses: "200": content: @@ -30163,62 +40467,35 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Delete device + summary: Delete membership level tags: - - product:common - get: + - product:feeds + patch: description: | - Returns all available devices - operationId: ListDevices + Update a membership level with partial updates. Only specified fields will be updated. + operationId: UpdateMembershipLevel parameters: - - in: query - name: user_id + - in: path + name: id + required: true schema: - description: '**Server-side only**. User ID which server acts upon' - title: User ID type: string writeOnly: true - x-stream-index: "001.001" - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/ListDevicesResponse' - description: ListDevicesResponse - "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: List devices - tags: - - product:common - post: - description: | - Adds a new device to a user, if the same device already exists the call will have no effect - operationId: CreateDevice + x-stream-index: "001" requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateDeviceRequest' - description: CreateDeviceRequest + $ref: '#/components/schemas/UpdateMembershipLevelRequest' + description: Update Membership Level Request required: true responses: - "201": + "200": content: application/json: schema: - $ref: '#/components/schemas/Response' - description: Response + $ref: '#/components/schemas/UpdateMembershipLevelResponse' + description: Update Membership Level Response "400": content: application/json: @@ -30231,54 +40508,28 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Create device + summary: Update membership level tags: - - product:common - /api/v2/export/users: + - product:feeds + /api/v2/feeds/membership_levels/query: post: description: | - Exports user profile, reactions and messages for list of given users - operationId: ExportUsers + Query membership levels with filter query + operationId: QueryMembershipLevels requestBody: content: application/json: schema: - $ref: '#/components/schemas/ExportUsersRequest' + $ref: '#/components/schemas/QueryMembershipLevelsRequest' + description: Query Membership Levels Request required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/ExportUsersResponse' - 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: Export users - tags: - - product:common - /api/v2/external_storage: - get: - description: | - Lists external storage - operationId: ListExternalStorage - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/ListExternalStorageResponse' - description: Response + $ref: '#/components/schemas/QueryMembershipLevelsResponse' + description: Query Membership Levels Response "400": content: application/json: @@ -30291,27 +40542,28 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: List external storage + summary: Query membership levels tags: - - product:common + - product:feeds + /api/v2/feeds/unfollow/batch: post: description: | - Creates new external storage - operationId: CreateExternalStorage + Removes multiple follows at once and broadcasts FollowRemovedEvent for each one + operationId: UnfollowBatch requestBody: content: application/json: schema: - $ref: '#/components/schemas/CreateExternalStorageRequest' - description: CreateExternalStorageRequest + $ref: '#/components/schemas/UnfollowBatchRequest' + description: Unfollow Batch Request required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/CreateExternalStorageResponse' - description: Response + $ref: '#/components/schemas/UnfollowBatchResponse' + description: Unfollow Batch Response "400": content: application/json: @@ -30324,29 +40576,29 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Create external storage + summary: Unfollow multiple feeds at once tags: - - product:common - /api/v2/external_storage/{name}: + - product:feeds + /api/v2/feeds/users/{user_id}/delete: delete: description: | - Deletes external storage - operationId: DeleteExternalStorage + Delete all activities, reactions, comments, and bookmarks for a user + operationId: DeleteFeedUserData parameters: - in: path - name: name + name: user_id required: true schema: type: string writeOnly: true - x-stream-index: "002" + x-stream-index: "001" responses: "200": content: application/json: schema: - $ref: '#/components/schemas/DeleteExternalStorageResponse' - description: Response + $ref: '#/components/schemas/DeleteFeedUserDataResponse' + description: Successful response "400": content: application/json: @@ -30359,70 +40611,29 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Delete external storage + summary: Delete all feed data for a user tags: - - product:common - put: - description: |2+ - - operationId: UpdateExternalStorage + - product:feeds + /api/v2/feeds/users/{user_id}/export: + post: + description: | + Export all activities, reactions, comments, and bookmarks for a user + operationId: ExportFeedUserData parameters: - in: path - name: name + name: user_id required: true schema: type: string writeOnly: true x-stream-index: "001" - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/UpdateExternalStorageRequest' - description: ExternalStorageRequest - required: true responses: "201": content: application/json: schema: - $ref: '#/components/schemas/UpdateExternalStorageResponse' - 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: Update External Storage - tags: - - product:common - /api/v2/external_storage/{name}/check: - get: - description: |2+ - - operationId: CheckExternalStorage - parameters: - - in: path - name: name - required: true - schema: - type: string - writeOnly: true - x-stream-index: "002" - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/CheckExternalStorageResponse' - description: Response + $ref: '#/components/schemas/ExportFeedUserDataResponse' + description: Successful response "400": content: application/json: @@ -30435,9 +40646,9 @@ paths: schema: $ref: '#/components/schemas/APIError' description: Too many requests - summary: Check External Storage + summary: Export all feed data for a user tags: - - product:common + - product:feeds /api/v2/guest: post: description: |2+ @@ -31065,6 +41276,125 @@ paths: summary: Query moderation action logs tags: - product:moderation + /api/v2/moderation/moderation_rule: + post: + description: | + Create or update a moderation rule that can apply app-wide or to specific moderation configs + operationId: upsert_moderation_rule + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpsertModerationRuleRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/UpsertModerationRuleResponse' + 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: Upsert moderation rule + tags: + - product:moderation + /api/v2/moderation/moderation_rule/{id}: + delete: + description: | + Delete an existing moderation rule + operationId: delete_moderation_rule + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteModerationRuleResponse' + 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: Delete moderation rule + tags: + - product:moderation + get: + description: | + Get a specific moderation rule by ID + operationId: get_moderation_rule + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/GetModerationRuleResponse' + 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: Get moderation rule + tags: + - product:moderation + /api/v2/moderation/moderation_rules: + post: + description: | + Search and filter moderation rules across your application. This endpoint is designed for building moderation dashboards and managing multiple rule sets. + operationId: query_moderation_rules + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueryModerationRulesRequest' + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/QueryModerationRulesResponse' + description: Successful 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: Query moderation rules + tags: + - product:moderation /api/v2/moderation/mute: post: description: | @@ -33524,6 +43854,65 @@ paths: summary: Set call as live tags: - product:video + /api/v2/video/call/{type}/{id}/kick: + post: + description: | + Kicks a user from the call. Optionally block the user from rejoining by setting block=true. + + Sends events: + - call.blocked_user + - call.kicked_user + operationId: KickUser + parameters: + - in: path + name: type + required: true + schema: + description: The type of call + maxLength: 64 + title: Type + type: string + writeOnly: true + x-stream-index: "002.001" + - in: path + name: id + required: true + schema: + description: Call ID + maxLength: 64 + title: ID + type: string + writeOnly: true + x-stream-index: "002.002" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/KickUserRequest' + description: KickUserRequest + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/KickUserResponse' + description: KickUserResponse + "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: Kick user from a call + tags: + - product:video /api/v2/video/call/{type}/{id}/mark_ended: post: description: |2 diff --git a/openapi/v2/video-clientside-api.json b/openapi/v2/video-clientside-api.json index 2e2265421..44cfd1012 100644 --- a/openapi/v2/video-clientside-api.json +++ b/openapi/v2/video-clientside-api.json @@ -1 +1 @@ -{"components":{"schemas":{"APIError":{"properties":{"StatusCode":{"description":"Response HTTP status code","format":"int32","title":"Status code","type":"integer","x-stream-index":"004"},"code":{"description":"API error code","format":"int32","title":"Code","type":"integer","x-stream-index":"001"},"details":{"description":"Additional error-specific information","items":{"type":"integer"},"title":"Details","type":"array","x-stream-index":"007"},"duration":{"description":"Request duration","title":"Duration","type":"string","x-stream-index":"005"},"exception_fields":{"additionalProperties":{"type":"string"},"description":"Additional error info","title":"Exception fields","type":"object","x-stream-index":"003"},"message":{"description":"Message describing an error","title":"Message","type":"string","x-stream-index":"002"},"more_info":{"description":"URL with additional information","title":"More info","type":"string","x-stream-index":"006"},"unrecoverable":{"description":"Flag that indicates if the error is unrecoverable, requests that return unrecoverable errors should not be retried, this error only applies to the request that caused it","title":"Unrecoverable","type":"boolean","x-stream-index":"008"}},"required":["code","message","StatusCode","duration","more_info","details"],"title":"Error response","type":"object"},"AcceptCallRequest":{"description":"AcceptCallRequest is the payload for accepting a call.","nullable":true,"title":"AcceptCallRequest","type":"object"},"AcceptCallResponse":{"description":"AcceptCallResponse is the payload for accepting a call.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"AcceptCallResponse","type":"object"},"Action":{"nullable":true,"properties":{"name":{"type":"string","x-stream-index":"001"},"style":{"type":"string","x-stream-index":"003"},"text":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"004"},"value":{"type":"string","x-stream-index":"005"}},"required":["name","text","type"],"type":"object"},"AppEventResponse":{"properties":{"async_url_enrich_enabled":{"description":"boolean","title":"Async URL Enrichment Enabled","type":"boolean","x-stream-index":"002"},"auto_translation_enabled":{"description":"boolean","title":"Auto Translation Enabled","type":"boolean","x-stream-index":"003"},"file_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","description":"file upload config","title":"File Upload Config","x-stream-index":"004"},"image_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","description":"file upload config","title":"Image Upload Config","x-stream-index":"005"},"name":{"description":"string","title":"App name","type":"string","x-stream-index":"001"}},"required":["name","auto_translation_enabled"],"type":"object"},"AppResponseFields":{"properties":{"async_url_enrich_enabled":{"type":"boolean","x-stream-index":"017"},"auto_translation_enabled":{"type":"boolean","x-stream-index":"020"},"file_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","x-stream-index":"030"},"image_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","x-stream-index":"031"},"name":{"type":"string","x-stream-index":"001"}},"required":["name","organization","push_notifications","webhook_url","moderation_webhook_url","channel_configs","call_types","policies","suspended","suspended_explanation","disable_auth_checks","disable_permissions_checks","permission_version","user_search_disallowed_roles","multi_tenant_enabled","image_moderation_enabled","async_url_enrich_enabled","auto_translation_enabled","custom_action_handler_url","enforce_unique_usernames","sqs_url","sqs_key","sqs_secret","sns_topic_arn","sns_key","sns_secret","file_upload_config","image_upload_config","grants","campaign_enabled","webhook_events","reminders_interval","cdn_expiration_seconds","video_provider","moderation_enabled","moderation_multitenant_blocklist_enabled","guest_user_creation_disabled","event_hooks","use_hook_v2","user_response_time_enabled","moderation_bulk_submit_action_enabled"],"type":"object"},"AppUpdatedEvent":{"description":"Emitted when app settings are updated","nullable":true,"properties":{"app":{"$ref":"#/components/schemas/AppEventResponse","description":"application configuration","title":"App settings","x-stream-index":"002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"type":{"default":"app.updated","description":"The type of event: \"app.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.002"}},"required":["type","created_at","custom","app"],"title":"AppUpdatedEvent","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"},"Attachment":{"description":"An attachment is a message object that represents a file uploaded by a user.","nullable":true,"properties":{"actions":{"items":{"$ref":"#/components/schemas/Action"},"type":"array","x-stream-index":"015"},"asset_url":{"type":"string","x-stream-index":"017"},"author_icon":{"type":"string","x-stream-index":"007"},"author_link":{"type":"string","x-stream-index":"006"},"author_name":{"type":"string","x-stream-index":"005"},"color":{"type":"string","x-stream-index":"003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"018"},"fallback":{"type":"string","x-stream-index":"002"},"fields":{"items":{"$ref":"#/components/schemas/Field"},"type":"array","x-stream-index":"016"},"footer":{"type":"string","x-stream-index":"013"},"footer_icon":{"type":"string","x-stream-index":"014"},"giphy":{"$ref":"#/components/schemas/Images","x-stream-index":"019"},"image_url":{"type":"string","x-stream-index":"011"},"og_scrape_url":{"type":"string","x-stream-index":"020"},"original_height":{"format":"int32","type":"integer","x-stream-index":"022"},"original_width":{"format":"int32","type":"integer","x-stream-index":"021"},"pretext":{"type":"string","x-stream-index":"004"},"text":{"type":"string","x-stream-index":"010"},"thumb_url":{"type":"string","x-stream-index":"012"},"title":{"type":"string","x-stream-index":"008"},"title_link":{"type":"string","x-stream-index":"009"},"type":{"description":"Attachment type (e.g. image, video, url)","title":"Type","type":"string","x-stream-index":"001"}},"required":["custom"],"title":"Attachment","type":"object","x-stream-docs-page-id":"file_uploads"},"AudioSettingsRequest":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"001"},"default_device":{"enum":["speaker","earpiece"],"type":"string","x-stream-index":"006"},"mic_default_on":{"type":"boolean","x-stream-index":"004"},"noise_cancellation":{"$ref":"#/components/schemas/NoiseCancellationSettings","x-stream-index":"007"},"opus_dtx_enabled":{"type":"boolean","x-stream-index":"002"},"redundant_coding_enabled":{"type":"boolean","x-stream-index":"003"},"speaker_default_on":{"type":"boolean","x-stream-index":"005"}},"required":["default_device"],"type":"object"},"AudioSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"001"},"default_device":{"enum":["speaker","earpiece"],"type":"string","x-stream-index":"006"},"mic_default_on":{"type":"boolean","x-stream-index":"004"},"noise_cancellation":{"$ref":"#/components/schemas/NoiseCancellationSettings","x-stream-index":"007"},"opus_dtx_enabled":{"type":"boolean","x-stream-index":"002"},"redundant_coding_enabled":{"type":"boolean","x-stream-index":"003"},"speaker_default_on":{"type":"boolean","x-stream-index":"005"}},"required":["access_request_enabled","opus_dtx_enabled","redundant_coding_enabled","mic_default_on","speaker_default_on","default_device"],"type":"object"},"BackstageSettingsRequest":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"002"}},"type":"object"},"BackstageSettingsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"BlockListOptions":{"properties":{"behavior":{"description":"Blocklist behavior","enum":["flag","block","shadow_block"],"title":"Behavior","type":"string","x-stream-index":"002"},"blocklist":{"description":"Blocklist name","title":"Blocklist","type":"string","x-stream-index":"001"}},"required":["blocklist","behavior"],"type":"object"},"BlockListResponse":{"description":"Block list contains restricted words","properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001"},"id":{"type":"string","x-stream-index":"003"},"name":{"description":"Block list name","title":"Name","type":"string","x-stream-index":"004"},"team":{"type":"string","x-stream-index":"007"},"type":{"description":"Block list type.","title":"Type","type":"string","x-stream-index":"005"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"002"},"words":{"description":"List of words to block","items":{"type":"string"},"title":"Words","type":"array","x-stream-index":"006"}},"required":["name","type","words"],"title":"Block list","type":"object","x-stream-docs-page-id":"block_lists"},"BlockUserRequest":{"description":"BlockUserRequest is the payload for blocking a user.","nullable":true,"properties":{"user_id":{"description":"the user to block","title":"UserID","type":"string","x-stream-index":"003"}},"required":["user_id"],"title":"BlockUserRequest","type":"object"},"BlockUserResponse":{"description":"BlockUserResponse is the payload for blocking a user.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"BlockUserResponse","type":"object"},"BlockUsersRequest":{"nullable":true,"properties":{"blocked_user_id":{"description":"User id to block","title":"BlockedUserID","type":"string","x-stream-index":"001"}},"required":["blocked_user_id"],"type":"object"},"BlockUsersResponse":{"nullable":true,"properties":{"blocked_by_user_id":{"description":"User id who blocked another user","title":"BlockedByUserID","type":"string","x-stream-index":"002"},"blocked_user_id":{"description":"User id who got blocked","title":"BlockedUserID","type":"string","x-stream-index":"003"},"created_at":{"description":"Timestamp when the user was blocked","format":"date-time","title":"CreatedAt","type":"number","x-stream-index":"004"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration","blocked_by_user_id","blocked_user_id","created_at"],"type":"object"},"BlockedUserEvent":{"description":"This event is sent to call participants to notify when a user is blocked on a call, clients can use this event to show a notification.\nIf the user is the current user, the client should leave the call screen as well","properties":{"blocked_by_user":{"$ref":"#/components/schemas/UserResponse","description":"The user that blocked the user, null if the user was blocked by server-side","title":"Blocked by","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.blocked_user","description":"The type of event: \"call.blocked_user\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user that was blocked","title":"User","x-stream-index":"003"}},"required":["type","created_at","call_cid","user"],"title":"BlockedUserEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"BlockedUserResponse":{"nullable":true,"properties":{"blocked_user":{"$ref":"#/components/schemas/UserResponse","description":"User who got blocked","title":"User","x-stream-index":"003"},"blocked_user_id":{"description":"ID of the user who got blocked","title":"UserID","type":"string","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who blocked another user","title":"User","x-stream-index":"001"},"user_id":{"description":"ID of the user who blocked another user","title":"UserID","type":"string","x-stream-index":"002"}},"required":["user","user_id","blocked_user","blocked_user_id","created_at"],"type":"object"},"Bound":{"properties":{"inclusive":{"type":"boolean","x-stream-index":"002"},"value":{"format":"float","type":"number","x-stream-index":"001"}},"required":["value","inclusive"],"type":"object"},"BroadcastSettingsRequest":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettingsRequest","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettingsRequest","x-stream-index":"003"}},"type":"object"},"BroadcastSettingsResponse":{"description":"BroadcastSettingsResponse is the payload for broadcasting settings","properties":{"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettingsResponse","title":"HLS","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettingsResponse","title":"RTMP","x-stream-index":"003"}},"required":["enabled","hls","rtmp"],"title":"BroadcastSettingsResponse","type":"object"},"CallAcceptedEvent":{"description":"This event is sent when a user accepts a notification to join a call.","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.accepted","description":"The type of event: \"call.accepted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who accepted the call","title":"User","x-stream-index":"004"}},"required":["type","created_at","call_cid","call","user"],"title":"CallAcceptedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallClosedCaption":{"description":"CallClosedCaption represents a closed caption of a call.","properties":{"end_time":{"format":"date-time","title":"The end time of the closed caption.","type":"number","x-stream-index":"003"},"speaker_id":{"title":"The speaker ID of the closed caption.","type":"string","x-stream-index":"004"},"start_time":{"format":"date-time","title":"The start time of the closed caption.","type":"number","x-stream-index":"002"},"text":{"title":"The text of the closed caption.","type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserResponse","title":"The full user for the closed caption.","x-stream-index":"005"}},"required":["text","start_time","end_time","speaker_id","user"],"title":"CallClosedCaption","type":"object"},"CallClosedCaptionsFailedEvent":{"description":"This event is sent when call closed captions has failed","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.closed_captions_failed","description":"The type of event: \"call.closed_captions_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallClosedCaptionsFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallClosedCaptionsStartedEvent":{"description":"This event is sent when call closed caption has started","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.closed_captions_started","description":"The type of event: \"call.closed_captions_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallClosedCaptionsStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallClosedCaptionsStoppedEvent":{"description":"This event is sent when call closed captions has stopped","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.closed_captions_stopped","description":"The type of event: \"call.transcription_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallClosedCaptionsStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallCreatedEvent":{"description":"This event is sent when a call is created. Clients receiving this event should check if the ringing\nfield is set to true and if so, show the call screen","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"the members added to this call","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"004"},"type":{"default":"call.created","description":"The type of event: \"call.created\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","members"],"title":"CallCreatedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallDeletedEvent":{"description":"This event is sent when a call is deleted. Clients receiving this event should leave the call screen","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.deleted","description":"The type of event: \"call.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call"],"title":"CallDeletedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallDurationReport":{"properties":{"histogram":{"items":{"$ref":"#/components/schemas/ReportByHistogramBucket"},"type":"array","x-stream-index":"001"}},"required":["histogram"],"type":"object"},"CallDurationReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateCallDurationReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"CallEndedEvent":{"description":"This event is sent when a call is mark as ended for all its participants. Clients receiving this event should leave the call screen","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"reason":{"description":"The reason why the call ended, if available","title":"CallEndedReason","type":"string","x-stream-index":"005"},"type":{"default":"call.ended","description":"The type of event: \"call.ended\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who ended the call, null if the call was ended by the server","title":"User","x-stream-index":"004"}},"required":["type","created_at","call_cid","call"],"title":"CallEndedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallFrameRecordingFailedEvent":{"description":"This event is sent when frame recording has failed","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.frame_recording_failed","description":"The type of event: \"call.frame_recording_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","egress_id"],"title":"CallFrameRecordingFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallFrameRecordingFrameReadyEvent":{"description":"This event is sent when a frame is captured from a call","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"captured_at":{"description":"The time the frame was captured","format":"date-time","title":"CapturedAt","type":"number","x-stream-index":"006"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"008"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"track_type":{"description":"The type of the track frame was captured from (TRACK_TYPE_VIDEO|TRACK_TYPE_SCREEN_SHARE)","title":"TrackType","type":"string","x-stream-index":"004"},"type":{"default":"call.frame_recording_ready","description":"The type of event: \"call.frame_recording_ready\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"url":{"description":"The URL of the frame","title":"URL","type":"string","x-stream-index":"005"},"users":{"additionalProperties":{"$ref":"#/components/schemas/UserResponse"},"description":"The users in the frame","title":"Users","type":"object","x-stream-index":"007"}},"required":["type","created_at","call_cid","session_id","track_type","url","captured_at","users","egress_id"],"title":"CallFrameRecordingFrameReadyEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallFrameRecordingStartedEvent":{"description":"This event is sent when frame recording has started","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.frame_recording_started","description":"The type of event: \"call.frame_recording_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","egress_id"],"title":"CallFrameRecordingStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallFrameRecordingStoppedEvent":{"description":"This event is sent when frame recording has stopped","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.frame_recording_stopped","description":"The type of event: \"call.frame_recording_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","egress_id"],"title":"CallFrameRecordingStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallHLSBroadcastingFailedEvent":{"description":"This event is sent when HLS broadcasting has failed","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.hls_broadcasting_failed","description":"The type of event: \"call.hls_broadcasting_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallHLSBroadcastingFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallHLSBroadcastingStartedEvent":{"description":"This event is sent when HLS broadcasting has started","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"hls_playlist_url":{"type":"string","x-stream-index":"004"},"type":{"default":"call.hls_broadcasting_started","description":"The type of event: \"call.hls_broadcasting_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","hls_playlist_url"],"title":"CallHLSBroadcastingStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallHLSBroadcastingStoppedEvent":{"description":"This event is sent when HLS broadcasting has stopped","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.hls_broadcasting_stopped","description":"The type of event: \"call.hls_broadcasting_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallHLSBroadcastingStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallIngressResponse":{"description":"CallIngressResponse is the payload for ingress settings","properties":{"rtmp":{"$ref":"#/components/schemas/RTMPIngress","title":"RTMP","x-stream-index":"001"}},"required":["rtmp"],"title":"CallIngressResponse","type":"object"},"CallLiveStartedEvent":{"description":"This event is sent when a call is started. Clients receiving this event should start the call.","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.live_started","description":"The type of event: \"call.live_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call"],"title":"CallLiveStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMemberAddedEvent":{"description":"This event is sent when one or more members are added to a call","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"the members added to this call","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"004"},"type":{"default":"call.member_added","description":"The type of event: \"call.member_added\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","members"],"title":"CallMemberAddedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMemberRemovedEvent":{"description":"This event is sent when one or more members are removed from a call","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"the list of member IDs removed from the call","items":{"type":"string"},"title":"Members","type":"array","x-stream-index":"004"},"type":{"default":"call.member_removed","description":"The type of event: \"call.member_removed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","members"],"title":"CallMemberRemovedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMemberUpdatedEvent":{"description":"This event is sent when one or more members are updated","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"The list of members that were updated","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"004"},"type":{"default":"call.member_updated","description":"The type of event: \"call.member_updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","members"],"title":"CallMemberUpdatedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMemberUpdatedPermissionEvent":{"description":"This event is sent when one or more members get its role updated","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"capabilities_by_role":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"The capabilities by role for this call","title":"CapabilitiesByRole","type":"object","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"The list of members that were updated","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"005"},"type":{"default":"call.member_updated_permission","description":"The type of event: \"call.member_added\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","capabilities_by_role","members"],"title":"CallMemberUpdatedPermissionEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMissedEvent":{"description":"This event is sent to call members who did not accept/reject/join the call to notify they missed the call","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"List of members who missed the call","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"005"},"notify_user":{"type":"boolean","x-stream-index":"007"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.missed","description":"The type of event: \"call.notification\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The caller from whom the call was missed","title":"User","x-stream-index":"006"}},"required":["type","created_at","call_cid","session_id","call","members","user","notify_user"],"title":"CallMissedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallModerationBlurEvent":{"properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"type":{"default":"call.moderation_blur","type":"string","x-stream-index":"001.001"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["type","created_at","call_cid","user_id","custom"],"title":"CallModerationBlurEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallModerationWarningEvent":{"properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"message":{"type":"string","x-stream-index":"004"},"type":{"default":"call.moderation_warning","type":"string","x-stream-index":"001.001"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["type","created_at","call_cid","user_id","message","custom"],"title":"CallModerationWarningEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallNotificationEvent":{"description":"This event is sent to all call members to notify they are getting called","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"Call members","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"005"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.notification","description":"The type of event: \"call.notification\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user that sent the call notification","title":"User","x-stream-index":"006"}},"required":["type","created_at","call_cid","session_id","call","members","user"],"title":"CallNotificationEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallParticipantCountReport":{"properties":{"histogram":{"items":{"$ref":"#/components/schemas/ReportByHistogramBucket"},"type":"array","x-stream-index":"001"}},"required":["histogram"],"type":"object"},"CallParticipantCountReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateCallParticipantCountReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"CallParticipantResponse":{"properties":{"joined_at":{"format":"date-time","type":"number","x-stream-index":"004"},"role":{"type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"},"user_session_id":{"type":"string","x-stream-index":"002"}},"required":["user","user_session_id","role","joined_at"],"type":"object"},"CallReactionEvent":{"description":"This event is sent when a reaction is sent in a call, clients should use this to show the reaction in the call screen","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"reaction":{"$ref":"#/components/schemas/ReactionResponse","description":"the reaction object sent by the user on the call","title":"reaction","x-stream-index":"003"},"type":{"default":"call.reaction_new","description":"The type of event: \"call.reaction_new\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","reaction"],"title":"CallReactionEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRecording":{"description":"CallRecording represents a recording of a call.","properties":{"end_time":{"format":"date-time","title":"The end time of the recording.","type":"number","x-stream-index":"004"},"filename":{"title":"The filename of the recording.","type":"string","x-stream-index":"001"},"session_id":{"title":"The session ID of the recording.","type":"string","x-stream-index":"005"},"start_time":{"format":"date-time","title":"The start time of the recording.","type":"number","x-stream-index":"003"},"url":{"title":"The URL of the recording.","type":"string","x-stream-index":"002"}},"required":["filename","url","start_time","end_time","session_id"],"title":"CallRecording","type":"object"},"CallRecordingFailedEvent":{"description":"This event is sent when call recording has failed","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"003"},"type":{"default":"call.recording_failed","description":"The type of event: \"call.recording_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","egress_id"],"title":"CallRecordingFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRecordingReadyEvent":{"description":"This event is sent when call recording is ready","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"call_recording":{"$ref":"#/components/schemas/CallRecording","description":"The call recording object","title":"CallRecording","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.recording_ready","description":"The type of event: \"call.recording_ready\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call_recording","egress_id"],"title":"CallRecordingReadyEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRecordingStartedEvent":{"description":"This event is sent when call recording has started","properties":{"call_cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"egress_id":{"type":"string","x-stream-index":"001"},"type":{"default":"call.recording_started","description":"The type of event: \"call.recording_started\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001"}},"required":["egress_id","type","created_at","call_cid"],"title":"CallRecordingStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRecordingStoppedEvent":{"description":"This event is sent when call recording has stopped","properties":{"call_cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"egress_id":{"type":"string","x-stream-index":"001"},"type":{"default":"call.recording_stopped","description":"The type of event: \"call.recording_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001"}},"required":["egress_id","type","created_at","call_cid"],"title":"CallRecordingStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRejectedEvent":{"description":"This event is sent when a user rejects a notification to join a call.","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"reason":{"description":"Provides information about why the call was rejected. You can provide any value, but the Stream API and SDKs use these default values: rejected, cancel, timeout and busy","title":"Reason","type":"string","x-stream-index":"005"},"type":{"default":"call.rejected","description":"The type of event: \"call.rejected\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who rejected the call","title":"User","x-stream-index":"004"}},"required":["type","created_at","call_cid","call","user"],"title":"CallRejectedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallReportResponse":{"properties":{"ended_at":{"format":"date-time","type":"number","x-stream-index":"003"},"score":{"format":"float","type":"number","x-stream-index":"001"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002"}},"required":["score"],"type":"object"},"CallRequest":{"description":"CallRequest is the payload for creating a call.","properties":{"channel_cid":{"type":"string","x-stream-index":"009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"members":{"items":{"$ref":"#/components/schemas/MemberRequest"},"maximum":100,"type":"array","x-stream-index":"005"},"settings_override":{"$ref":"#/components/schemas/CallSettingsRequest","x-stream-index":"006"},"starts_at":{"format":"date-time","type":"number","x-stream-index":"007"},"team":{"type":"string","x-stream-index":"001"},"video":{"type":"boolean","x-stream-index":"008"}},"title":"CallRequest","type":"object"},"CallResponse":{"description":"Represents a call","properties":{"backstage":{"type":"boolean","x-stream-index":"016"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"018"},"captioning":{"type":"boolean","x-stream-index":"013"},"channel_cid":{"type":"string","x-stream-index":"024"},"cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"The user that created the call","title":"Created By","x-stream-index":"007"},"current_session_id":{"type":"string","x-stream-index":"005"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"008"},"egress":{"$ref":"#/components/schemas/EgressResponse","x-stream-index":"021"},"ended_at":{"description":"Date/time when the call ended","format":"date-time","title":"Ended At","type":"number","x-stream-index":"014"},"id":{"description":"Call ID","title":"ID","type":"string","x-stream-index":"003"},"ingress":{"$ref":"#/components/schemas/CallIngressResponse","x-stream-index":"019"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"023"},"recording":{"type":"boolean","x-stream-index":"011"},"session":{"$ref":"#/components/schemas/CallSessionResponse","x-stream-index":"020"},"settings":{"$ref":"#/components/schemas/CallSettingsResponse","x-stream-index":"017"},"starts_at":{"description":"Date/time when the call will start","format":"date-time","title":"Starts At","type":"number","x-stream-index":"015"},"team":{"type":"string","x-stream-index":"006"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailResponse","x-stream-index":"022"},"transcribing":{"type":"boolean","x-stream-index":"012"},"type":{"description":"The type of call","title":"Type","type":"string","x-stream-index":"002"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"}},"required":["type","id","cid","current_session_id","created_by","custom","created_at","updated_at","recording","transcribing","captioning","backstage","settings","blocked_user_ids","ingress","egress"],"title":"CallResponse","type":"object"},"CallRingEvent":{"description":"This event is sent to all call members to notify they are getting called","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"005"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"Call members","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"006"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.ring","description":"The type of event: \"call.notification\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user that sent the call notification","title":"User","x-stream-index":"007"},"video":{"type":"boolean","x-stream-index":"008"}},"required":["type","created_at","call_cid","session_id","call","members","user","video"],"title":"CallRingEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRtmpBroadcastFailedEvent":{"description":"This event is sent when a call RTMP broadcast has failed","properties":{"call_cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"002.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.002"},"name":{"description":"Name of the given RTMP broadcast","title":"Name","type":"string","x-stream-index":"003"},"type":{"default":"call.rtmp_broadcast_failed","description":"The type of event: \"call.rtmp_broadcast_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","name"],"title":"CallRtmpBroadcastFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRtmpBroadcastStartedEvent":{"description":"This event is sent when RTMP broadcast has started","properties":{"call_cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"002.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.002"},"name":{"description":"Name of the given RTMP broadcast","title":"Name","type":"string","x-stream-index":"003"},"type":{"default":"call.rtmp_broadcast_started","description":"The type of event: \"call.rtmp_broadcast_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","name"],"title":"CallRtmpBroadcastStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRtmpBroadcastStoppedEvent":{"description":"This event is sent when RTMP broadcast has stopped","properties":{"call_cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"002.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.002"},"name":{"description":"Name of the given RTMP broadcast","title":"Name","type":"string","x-stream-index":"003"},"type":{"default":"call.rtmp_broadcast_stopped","description":"The type of event: \"call.rtmp_broadcast_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","name"],"title":"CallRtmpBroadcastStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSessionEndedEvent":{"description":"This event is sent when a call session ends","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_ended","description":"The type of event: \"call.session_ended\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","call"],"title":"CallSessionEndedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSessionParticipantCountsUpdatedEvent":{"description":"This event is sent when the participant counts in a call session are updated","properties":{"anonymous_participant_count":{"format":"int32","type":"integer","x-stream-index":"005"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"participants_count_by_role":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"004"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_participant_count_updated","description":"The type of event: \"call.session_participant_count_updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","participants_count_by_role","anonymous_participant_count"],"title":"CallSessionParticipantCountsUpdatedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSessionParticipantJoinedEvent":{"description":"This event is sent when a participant joins a call session","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"participant":{"$ref":"#/components/schemas/CallParticipantResponse","description":"The participant that joined the session","title":"Participant","x-stream-index":"004"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_participant_joined","description":"The type of event: \"call.session_participant_joined\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","participant"],"title":"CallSessionParticipantJoinedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSessionParticipantLeftEvent":{"description":"This event is sent when a participant leaves a call session","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"duration_seconds":{"description":"The duration participant was in the session in seconds","format":"int32","title":"Duration","type":"integer","x-stream-index":"005"},"participant":{"$ref":"#/components/schemas/CallParticipantResponse","description":"The participant that left the session","title":"Participant","x-stream-index":"004"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_participant_left","description":"The type of event: \"call.session_participant_left\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","participant","duration_seconds"],"title":"CallSessionParticipantLeftEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSessionResponse":{"properties":{"accepted_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"008"},"anonymous_participant_count":{"format":"int32","type":"integer","x-stream-index":"006"},"ended_at":{"format":"date-time","type":"number","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"live_ended_at":{"format":"date-time","type":"number","x-stream-index":"011"},"live_started_at":{"format":"date-time","type":"number","x-stream-index":"010"},"missed_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"009"},"participants":{"items":{"$ref":"#/components/schemas/CallParticipantResponse"},"type":"array","x-stream-index":"004"},"participants_count_by_role":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"005"},"rejected_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"007"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002"},"timer_ends_at":{"format":"date-time","type":"number","x-stream-index":"012"}},"required":["id","participants","participants_count_by_role","anonymous_participant_count","rejected_by","accepted_by","missed_by"],"type":"object"},"CallSessionStartedEvent":{"description":"This event is sent when a call session starts","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_started","description":"The type of event: \"call.session_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","call"],"title":"CallSessionStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSettingsRequest":{"properties":{"audio":{"$ref":"#/components/schemas/AudioSettingsRequest","x-stream-index":"001"},"backstage":{"$ref":"#/components/schemas/BackstageSettingsRequest","x-stream-index":"002"},"broadcasting":{"$ref":"#/components/schemas/BroadcastSettingsRequest","x-stream-index":"010"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordingSettingsRequest","x-stream-index":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettingsRequest","x-stream-index":"003"},"ingress":{"$ref":"#/components/schemas/IngressSettingsRequest","x-stream-index":"014"},"limits":{"$ref":"#/components/schemas/LimitsSettingsRequest","x-stream-index":"012"},"recording":{"$ref":"#/components/schemas/RecordSettingsRequest","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettingsRequest","x-stream-index":"007"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettingsRequest","x-stream-index":"008"},"session":{"$ref":"#/components/schemas/SessionSettingsRequest","x-stream-index":"013"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettingsRequest","x-stream-index":"011"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettingsRequest","x-stream-index":"009"},"video":{"$ref":"#/components/schemas/VideoSettingsRequest","x-stream-index":"004"}},"type":"object"},"CallSettingsResponse":{"properties":{"audio":{"$ref":"#/components/schemas/AudioSettingsResponse","x-stream-index":"001"},"backstage":{"$ref":"#/components/schemas/BackstageSettingsResponse","x-stream-index":"002"},"broadcasting":{"$ref":"#/components/schemas/BroadcastSettingsResponse","x-stream-index":"003"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordingSettingsResponse","x-stream-index":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettingsResponse","x-stream-index":"004"},"ingress":{"$ref":"#/components/schemas/IngressSettingsResponse","x-stream-index":"014"},"limits":{"$ref":"#/components/schemas/LimitsSettingsResponse","x-stream-index":"012"},"recording":{"$ref":"#/components/schemas/RecordSettingsResponse","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettingsResponse","x-stream-index":"007"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettingsResponse","x-stream-index":"008"},"session":{"$ref":"#/components/schemas/SessionSettingsResponse","x-stream-index":"013"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettingsResponse","x-stream-index":"011"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettingsResponse","x-stream-index":"009"},"video":{"$ref":"#/components/schemas/VideoSettingsResponse","x-stream-index":"010"}},"required":["audio","backstage","broadcasting","geofencing","recording","frame_recording","ring","screensharing","transcription","video","thumbnails","limits","session"],"type":"object"},"CallStateResponseFields":{"description":"CallStateResponseFields is the payload for call state response","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001"},"members":{"description":"List of call members","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"002"},"membership":{"$ref":"#/components/schemas/MemberResponse","description":"Current user membership object","title":"Membership","x-stream-index":"003"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"004"}},"required":["call","members","own_capabilities","blocked_users"],"title":"CallStateResponseFields","type":"object"},"CallStatsReportReadyEvent":{"description":"This event is sent when the insights report is ready","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.stats_report_ready","description":"The type of event, \"call.report_ready\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id"],"title":"CallStatsReportReadyEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallStatsReportSummaryResponse":{"properties":{"call_cid":{"type":"string","x-stream-index":"001"},"call_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"008"},"call_session_id":{"type":"string","x-stream-index":"002"},"call_status":{"type":"string","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"first_stats_time":{"format":"date-time","type":"number","x-stream-index":"003"},"min_user_rating":{"format":"int32","type":"integer","x-stream-index":"006"},"quality_score":{"format":"int32","type":"integer","x-stream-index":"005"}},"required":["call_cid","call_session_id","first_stats_time","call_status","call_duration_seconds"],"type":"object"},"CallTranscription":{"description":"CallTranscription represents a transcription of a call.","properties":{"end_time":{"format":"date-time","title":"The end time of the transcription.","type":"number","x-stream-index":"004"},"filename":{"title":"The filename of the transcription.","type":"string","x-stream-index":"001"},"session_id":{"title":"The session ID of the transcription.","type":"string","x-stream-index":"005"},"start_time":{"format":"date-time","title":"The start time of the transcription.","type":"number","x-stream-index":"003"},"url":{"title":"The URL of the transcription.","type":"string","x-stream-index":"002"}},"required":["filename","url","start_time","end_time","session_id"],"title":"CallTranscription","type":"object"},"CallTranscriptionFailedEvent":{"description":"This event is sent when call transcription has failed","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"003"},"error":{"description":"The error message detailing why transcription failed.","title":"string","type":"string","x-stream-index":"004"},"type":{"default":"call.transcription_failed","description":"The type of event: \"call.transcription_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","egress_id"],"title":"CallTranscriptionFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallTranscriptionReadyEvent":{"description":"This event is sent when call transcription is ready","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"call_transcription":{"$ref":"#/components/schemas/CallTranscription","description":"The call transcription object","title":"CallTranscription","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.transcription_ready","description":"The type of event: \"call.transcription_ready\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call_transcription","egress_id"],"title":"CallTranscriptionReadyEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallTranscriptionStartedEvent":{"description":"This event is sent when call transcription has started","properties":{"call_cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"egress_id":{"type":"string","x-stream-index":"001"},"type":{"default":"call.transcription_started","description":"The type of event: \"call.transcription_started\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001"}},"required":["egress_id","type","created_at","call_cid"],"title":"CallTranscriptionStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallTranscriptionStoppedEvent":{"description":"This event is sent when call transcription has stopped","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"003"},"type":{"default":"call.transcription_stopped","description":"The type of event: \"call.transcription_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","egress_id"],"title":"CallTranscriptionStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallUpdatedEvent":{"description":"This event is sent when a call is updated, clients should use this update the local state of the call.\nThis event also contains the capabilities by role for the call, clients should update the own_capability for the current.","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"capabilities_by_role":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"The capabilities by role for this call","title":"CapabilitiesByRole","type":"object","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.updated","description":"The type of event: \"call.ended\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","capabilities_by_role"],"title":"CallUpdatedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallUserFeedbackSubmittedEvent":{"description":"This event is sent when a user submits feedback for a call.","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"custom":{"additionalProperties":{},"description":"Custom data provided by the user","title":"Custom","type":"object","x-stream-index":"007"},"rating":{"description":"The rating given by the user (1-5)","format":"int32","title":"Rating","type":"integer","x-stream-index":"005"},"reason":{"description":"The reason provided by the user for the rating","title":"Reason","type":"string","x-stream-index":"006"},"sdk":{"type":"string","x-stream-index":"008"},"sdk_version":{"type":"string","x-stream-index":"009"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.user_feedback_submitted","description":"The type of event, \"call.user_feedback\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who submitted the feedback","title":"User","x-stream-index":"004"}},"required":["type","created_at","call_cid","session_id","user","rating"],"title":"CallUserFeedbackSubmittedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallUserMutedEvent":{"description":"This event is sent when a call member is muted","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"from_user_id":{"type":"string","x-stream-index":"003"},"muted_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"type":{"default":"call.user_muted","description":"The type of event: \"call.user_muted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","from_user_id","muted_user_ids"],"title":"CallUserMutedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallsPerDayReport":{"properties":{"count":{"format":"int64","type":"integer","x-stream-index":"001"}},"required":["count"],"type":"object"},"CallsPerDayReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateCallsPerDayReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"Channel":{"properties":{"active_live_locations":{"items":{"$ref":"#/components/schemas/SharedLocation"},"type":"array","x-stream-index":"034"},"auto_translation_enabled":{"type":"boolean","x-stream-index":"029"},"auto_translation_language":{"type":"string","x-stream-index":"030"},"cid":{"type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/ChannelConfig","x-stream-index":"026"},"config_overrides":{"$ref":"#/components/schemas/ConfigOverrides","x-stream-index":"027"},"cooldown":{"format":"int32","type":"integer","x-stream-index":"031"},"created_at":{"format":"date-time","type":"number","x-stream-index":"009"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"019"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"disabled":{"type":"boolean","x-stream-index":"017"},"frozen":{"type":"boolean","x-stream-index":"016"},"id":{"type":"string","x-stream-index":"004"},"invites":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"022"},"last_campaigns":{"type":"string","x-stream-index":"032"},"last_message_at":{"format":"date-time","type":"number","x-stream-index":"006"},"member_count":{"format":"int32","type":"integer","x-stream-index":"021"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"020"},"team":{"type":"string","x-stream-index":"028"},"truncated_by":{"$ref":"#/components/schemas/User","x-stream-index":"015"},"type":{"type":"string","x-stream-index":"005"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"010"}},"required":["cid","id","type","created_at","updated_at","frozen","disabled","custom","auto_translation_language"],"type":"object"},"ChannelConfig":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.026"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.021"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.022"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.027"},"blocklist":{"type":"string","x-stream-index":"001.023"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.024"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.025"},"commands":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"connect_events":{"type":"boolean","x-stream-index":"001.004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"custom_events":{"type":"boolean","x-stream-index":"001.012"},"mark_messages_pending":{"type":"boolean","x-stream-index":"001.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"001.020"},"mutes":{"type":"boolean","x-stream-index":"001.009"},"name":{"type":"string","x-stream-index":"001.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"001.028"},"partition_ttl":{"type":"integer","x-stream-index":"001.029"},"polls":{"type":"boolean","x-stream-index":"001.016"},"push_notifications":{"type":"boolean","x-stream-index":"001.013"},"quotes":{"type":"boolean","x-stream-index":"001.008"},"reactions":{"type":"boolean","x-stream-index":"001.006"},"read_events":{"type":"boolean","x-stream-index":"001.003"},"reminders":{"type":"boolean","x-stream-index":"001.014"},"replies":{"type":"boolean","x-stream-index":"001.007"},"search":{"type":"boolean","x-stream-index":"001.005"},"shared_locations":{"type":"boolean","x-stream-index":"001.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.030"},"typing_events":{"type":"boolean","x-stream-index":"001.002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"002.004"},"uploads":{"type":"boolean","x-stream-index":"001.010"},"url_enrichment":{"type":"boolean","x-stream-index":"001.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"001.017"}},"required":["name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","created_at","updated_at","commands"],"type":"object"},"ChannelConfigWithInfo":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.002.026"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.002.021"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.022"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.002.027"},"blocklist":{"type":"string","x-stream-index":"001.002.023"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.024"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.002.025"},"commands":{"items":{"$ref":"#/components/schemas/Command"},"type":"array","x-stream-index":"001.003"},"connect_events":{"type":"boolean","x-stream-index":"001.002.004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.001.003"},"custom_events":{"type":"boolean","x-stream-index":"001.002.012"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"002"},"mark_messages_pending":{"type":"boolean","x-stream-index":"001.002.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"001.002.020"},"mutes":{"type":"boolean","x-stream-index":"001.002.009"},"name":{"type":"string","x-stream-index":"001.002.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"001.002.028"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"001.002.029"},"polls":{"type":"boolean","x-stream-index":"001.002.016"},"push_notifications":{"type":"boolean","x-stream-index":"001.002.013"},"quotes":{"type":"boolean","x-stream-index":"001.002.008"},"reactions":{"type":"boolean","x-stream-index":"001.002.006"},"read_events":{"type":"boolean","x-stream-index":"001.002.003"},"reminders":{"type":"boolean","x-stream-index":"001.002.014"},"replies":{"type":"boolean","x-stream-index":"001.002.007"},"search":{"type":"boolean","x-stream-index":"001.002.005"},"shared_locations":{"type":"boolean","x-stream-index":"001.002.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.002.030"},"typing_events":{"type":"boolean","x-stream-index":"001.002.002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"uploads":{"type":"boolean","x-stream-index":"001.002.010"},"url_enrichment":{"type":"boolean","x-stream-index":"001.002.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"001.002.017"}},"required":["created_at","updated_at","name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","commands"],"type":"object"},"ChannelMember":{"nullable":true,"properties":{"archived_at":{"format":"date-time","type":"number","x-stream-index":"015"},"ban_expires":{"description":"Expiration date of the ban","format":"date-time","title":"Ban expires","type":"number","x-stream-index":"013"},"banned":{"description":"Whether member is banned this channel or not","title":"Banned","type":"boolean","x-stream-index":"012"},"channel_role":{"description":"Role of the member in the channel","title":"Channel Role","type":"string","x-stream-index":"018"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"invite_accepted_at":{"description":"Date when invite was accepted","format":"date-time","title":"Invited accepted at","type":"number","x-stream-index":"006"},"invite_rejected_at":{"description":"Date when invite was rejected","format":"date-time","title":"Invited rejected at","type":"number","x-stream-index":"007"},"invited":{"description":"Whether member was invited or not","title":"Invited","type":"boolean","x-stream-index":"005"},"is_moderator":{"description":"Whether member is channel moderator or not","title":"Is moderator","type":"boolean","x-stream-index":"003"},"notifications_muted":{"type":"boolean","x-stream-index":"019"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"016"},"role":{"description":"Permission level of the member in the channel (DEPRECATED: use channel_role instead)","enum":["member","moderator","admin","owner"],"title":"Role","type":"string","x-stream-index":"017"},"shadow_banned":{"description":"Whether member is shadow banned in this channel or not","title":"Shadow banned","type":"boolean","x-stream-index":"014"},"status":{"type":"string","x-stream-index":"008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"},"user_id":{"title":"User ID","type":"string","x-stream-index":"001"}},"required":["custom","created_at","updated_at","banned","shadow_banned","channel_role","notifications_muted"],"title":"Channel member","type":"object"},"ChannelMute":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel that is muted","title":"Channel","x-stream-index":"002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"004"},"expires":{"description":"Date/time of mute expiration","format":"date-time","title":"Expires","type":"number","x-stream-index":"003"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Owner of channel mute","title":"User","x-stream-index":"001"}},"required":["created_at","updated_at"],"type":"object"},"ChannelOwnCapability":{"description":"All possibility of string to use","enum":["ban-channel-members","cast-poll-vote","connect-events","create-attachment","delete-any-message","delete-channel","delete-own-message","flag-message","freeze-channel","join-channel","leave-channel","mute-channel","pin-message","query-poll-votes","quote-message","read-events","search-messages","send-custom-events","send-links","send-message","send-poll","send-reaction","send-reply","send-restricted-visibility-message","send-typing-events","set-channel-cooldown","share-location","skip-slow-mode","slow-mode","typing-events","update-any-message","update-channel","update-channel-members","update-own-message","update-thread","upload-file"],"title":"ChannelOwnCapability","type":"string"},"ChannelResponse":{"description":"Represents channel in chat","properties":{"auto_translation_enabled":{"description":"Whether auto translation is enabled or not","title":"Auto translation","type":"boolean","x-stream-index":"017"},"auto_translation_language":{"description":"Language to translate to when auto translation is active","title":"Auto translation language","type":"string","x-stream-index":"018"},"blocked":{"description":"Whether this channel is blocked by current user or not","title":"Blocked","type":"boolean","x-stream-index":"023"},"cid":{"description":"Channel CID (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/ChannelConfigWithInfo","description":"Channel configuration","title":"ChannelConfigWithInfo","x-stream-index":"013"},"cooldown":{"description":"Cooldown period after sending each message","format":"int32","title":"Cooldown","type":"integer","x-stream-index":"020"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"005"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"Creator of the channel","title":"UserResponse","x-stream-index":"008"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"026"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"007"},"disabled":{"type":"boolean","x-stream-index":"010"},"frozen":{"description":"Whether channel is frozen or not","title":"Frozen","type":"boolean","x-stream-index":"009"},"hidden":{"description":"Whether this channel is hidden by current user or not","title":"Hidden","type":"boolean","x-stream-index":"022"},"hide_messages_before":{"description":"Date since when the message history is accessible","format":"date-time","title":"Hide messages before","type":"number","x-stream-index":"019"},"id":{"description":"Channel unique ID","title":"ID","type":"string","x-stream-index":"001"},"last_message_at":{"description":"Date of the last message sent","format":"date-time","title":"Last message at","type":"number","x-stream-index":"004"},"member_count":{"description":"Number of members in the channel","format":"int32","title":"Member count","type":"integer","x-stream-index":"012"},"members":{"description":"List of channel members (max 100)","items":{"$ref":"#/components/schemas/ChannelMember"},"title":"ChannelMembers","type":"array","x-stream-index":"011"},"mute_expires_at":{"description":"Date of mute expiration","format":"date-time","title":"Mute expires at","type":"number","x-stream-index":"015"},"muted":{"description":"Whether this channel is muted or not","title":"Muted","type":"boolean","x-stream-index":"014"},"own_capabilities":{"description":"List of channel capabilities of authenticated user","items":{"$ref":"#/components/schemas/ChannelOwnCapability"},"title":"ChannelOwnCapability","type":"array","x-stream-index":"021"},"team":{"description":"Team the channel belongs to (multi-tenant only)","title":"Team","type":"string","x-stream-index":"016"},"truncated_at":{"description":"Date of the latest truncation of the channel","format":"date-time","title":"UserResponse","type":"number","x-stream-index":"024"},"truncated_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"025"},"type":{"description":"Type of the channel","title":"Type","type":"string","x-stream-docs-page-id":"channel_features","x-stream-index":"002"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"006"}},"required":["id","type","cid","created_at","updated_at","frozen","disabled","custom"],"title":"Channel","type":"object"},"ChatActivityStatsResponse":{"properties":{"Messages":{"$ref":"#/components/schemas/MessageStatsResponse","x-stream-index":"001"}},"type":"object"},"ClosedCaptionEvent":{"description":"This event is sent when closed captions are being sent in a call, clients should use this to show the closed captions in the call screen","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"closed_caption":{"$ref":"#/components/schemas/CallClosedCaption","description":"The closed caption object","title":"CallClosedCaption","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.closed_caption","description":"The type of event: \"call.closed_caption\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","closed_caption"],"title":"ClosedCaptionEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CollectUserFeedbackRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"009"},"rating":{"format":"int32","maximum":5,"minimum":1,"type":"integer","x-stream-index":"007"},"reason":{"maxLength":1000,"type":"string","x-stream-index":"008"},"sdk":{"maxLength":50,"type":"string","x-stream-index":"005"},"sdk_version":{"maxLength":50,"type":"string","x-stream-index":"006"},"user_session_id":{"maxLength":50,"type":"string","x-stream-index":"004"}},"required":["sdk","sdk_version","rating"],"type":"object"},"CollectUserFeedbackResponse":{"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"},"Command":{"description":"Represents custom chat command","nullable":true,"properties":{"args":{"description":"Arguments help text, shown in commands auto-completion","title":"Arguments","type":"string","x-stream-index":"006"},"created_at":{"description":"Date/time of creation","format":"date-time","readOnly":true,"title":"Created at","type":"number","x-stream-index":"001"},"description":{"description":"Description, shown in commands auto-completion","title":"Description","type":"string","x-stream-index":"005"},"name":{"description":"Unique command name","title":"Name","type":"string","x-stream-index":"004"},"set":{"description":"Set name used for grouping commands","title":"Set","type":"string","x-stream-index":"007"},"updated_at":{"description":"Date/time of the last update","format":"date-time","readOnly":true,"title":"Updated at","type":"number","x-stream-index":"002"}},"required":["name","description","args","set"],"title":"Command","type":"object"},"ConfigOverrides":{"properties":{"blocklist":{"type":"string","x-stream-index":"008"},"blocklist_behavior":{"enum":["flag","block"],"type":"string","x-stream-index":"009"},"commands":{"items":{"type":"string"},"type":"array","x-stream-index":"011"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"010"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"007"},"quotes":{"type":"boolean","x-stream-index":"004"},"reactions":{"type":"boolean","x-stream-index":"002"},"replies":{"type":"boolean","x-stream-index":"003"},"shared_locations":{"type":"boolean","x-stream-index":"013"},"typing_events":{"type":"boolean","x-stream-index":"001"},"uploads":{"type":"boolean","x-stream-index":"005"},"url_enrichment":{"type":"boolean","x-stream-index":"006"},"user_message_reminders":{"type":"boolean","x-stream-index":"012"}},"required":["grants","commands"],"type":"object"},"ConnectUserDetailsRequest":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001"},"image":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"006"},"language":{"type":"string","x-stream-index":"005"},"name":{"type":"string","x-stream-index":"002"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"007"}},"required":["id"],"type":"object"},"ConnectedEvent":{"description":"This event is sent when the WS connection is established and authenticated, this event contains the full user object as it is stored on the server","properties":{"connection_id":{"description":"The connection_id for this client","title":"Connection ID","type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"me":{"$ref":"#/components/schemas/OwnUserResponse","description":"The full user object as it is stored on the server","title":"OwnUserResponse","x-stream-index":"003"},"type":{"default":"connection.ok","description":"The type of event: \"connection.ok\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","connection_id","me"],"title":"ConnectedEvent","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"},"ConnectionErrorEvent":{"description":"This event is sent when the WS connection fails","properties":{"connection_id":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"error":{"$ref":"#/components/schemas/APIError","description":"The error that caused the connection to fail","title":"Error","x-stream-index":"003"},"type":{"default":"connection.error","description":"The type of event: \"connection.ok\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","connection_id","error"],"title":"ConnectionErrorEvent","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"},"CountByMinuteResponse":{"nullable":true,"properties":{"count":{"format":"int32","type":"integer","x-stream-index":"002"},"start_ts":{"format":"date-time","type":"number","x-stream-index":"001"}},"required":["start_ts","count"],"type":"object"},"CreateBlockListRequest":{"description":"Block list contains restricted words","nullable":true,"properties":{"name":{"description":"Block list name","maxLength":255,"title":"Name","type":"string","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"004"},"type":{"description":"Block list type.","enum":["regex","domain","domain_allowlist","email","word"],"title":"Type","type":"string","x-stream-index":"003"},"words":{"description":"List of words to block","items":{"type":"string"},"minimum":1,"title":"Words","type":"array","x-stream-index":"002"}},"required":["name","words"],"title":"Block list","type":"object","x-stream-docs-page-id":"block_lists"},"CreateBlockListResponse":{"description":"Basic response information","nullable":true,"properties":{"blocklist":{"$ref":"#/components/schemas/BlockListResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["duration"],"title":"Response","type":"object"},"CreateDeviceRequest":{"description":"Create device request","nullable":true,"properties":{"id":{"description":"Device ID","maxLength":255,"minLength":1,"title":"ID","type":"string","x-stream-index":"001"},"push_provider":{"description":"Push provider","enum":["firebase","apn","huawei","xiaomi"],"title":"PushProvider","type":"string","x-stream-index":"002"},"push_provider_name":{"description":"Push provider name","title":"PushProviderName","type":"string","x-stream-index":"003"},"voip_token":{"description":"When true the token is for Apple VoIP push notifications","title":"VoipToken","type":"boolean","x-stream-index":"004"}},"required":["id","push_provider"],"title":"CreateDeviceRequest","type":"object"},"CreateGuestRequest":{"nullable":true,"properties":{"user":{"$ref":"#/components/schemas/UserRequest","description":"User object which server acts upon","title":"User","x-stream-index":"001"}},"required":["user"],"type":"object"},"CreateGuestResponse":{"nullable":true,"properties":{"access_token":{"description":"the access token to authenticate the user","title":"Access token","type":"string","x-stream-index":"002"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User object which server acts upon","title":"User","x-stream-index":"001"}},"required":["user","access_token","duration"],"type":"object"},"CreatePollOptionRequest":{"nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"003"},"text":{"description":"Option text","title":"string","type":"string","x-stream-index":"002"}},"required":["text"],"type":"object"},"CreatePollRequest":{"description":"Contains all information needed to create a new poll","nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"011"},"allow_answers":{"description":"Indicates whether users can suggest user defined answers","title":"Allow answers","type":"boolean","x-stream-index":"009"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"008"},"description":{"description":"A description of the poll","title":"Description","type":"string","x-stream-index":"003"},"enforce_unique_vote":{"description":"Indicates whether users can cast multiple votes","title":"Multiple choice","type":"boolean","x-stream-index":"006"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"is_closed":{"description":"Indicates whether the poll is open for voting","title":"Is closed","type":"boolean","x-stream-index":"010"},"max_votes_allowed":{"description":"Indicates the maximum amount of votes a user can cast","format":"int32","maximum":10,"title":"Maximum votes allowed","type":"integer","x-stream-index":"007"},"name":{"description":"The name of the poll","title":"Name","type":"string","x-stream-index":"002"},"options":{"items":{"$ref":"#/components/schemas/PollOptionInput"},"maximum":100,"type":"array","x-stream-index":"004"},"voting_visibility":{"enum":["anonymous","public"],"type":"string","x-stream-index":"005"}},"required":["name"],"title":"Create Poll Request","type":"object"},"Credentials":{"properties":{"ice_servers":{"items":{"$ref":"#/components/schemas/ICEServer"},"type":"array","x-stream-index":"003"},"server":{"$ref":"#/components/schemas/SFUResponse","x-stream-index":"001"},"token":{"type":"string","x-stream-index":"002"}},"required":["server","token","ice_servers"],"type":"object"},"CustomVideoEvent":{"description":"A custom event, this event is used to send custom events to other participants in the call.","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"003"},"type":{"default":"custom","description":"The type of event, \"custom\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"004"}},"required":["type","created_at","call_cid","custom","user"],"title":"CustomVideoEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"DailyAggregateCallDurationReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/CallDurationReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateCallParticipantCountReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/CallParticipantCountReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateCallsPerDayReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/CallsPerDayReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateQualityScoreReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/QualityScoreReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateSDKUsageReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/SDKUsageReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateUserFeedbackReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/UserFeedbackReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DeleteCallRequest":{"description":"DeleteCallRequest is the payload for deleting a call.","nullable":true,"properties":{"hard":{"description":"if true the call will be hard deleted along with all related data","title":"Hard","type":"boolean","x-stream-index":"001"}},"title":"DeleteCallRequest","type":"object"},"DeleteCallResponse":{"description":"DeleteCallResponse is the payload for deleting a call.","nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","title":"Call","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"task_id":{"title":"TaskID","type":"string","x-stream-index":"002"}},"required":["call","duration"],"title":"DeleteCallResponse","type":"object"},"DeleteRecordingResponse":{"description":"Response for DeleteRecording","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"DeleteRecordingResponse","type":"object"},"DeleteTranscriptionResponse":{"description":"DeleteTranscriptionResponse is the payload for deleting a transcription.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"DeleteTranscriptionResponse","type":"object"},"DeviceResponse":{"description":"Response for Device","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"004"},"disabled":{"description":"Whether device is disabled or not","title":"Disabled","type":"boolean","x-stream-index":"005"},"disabled_reason":{"description":"Reason explaining why device had been disabled","title":"Reason","type":"string","x-stream-index":"006"},"id":{"description":"Device ID","title":"ID","type":"string","x-stream-index":"003"},"push_provider":{"description":"Push provider","title":"PushProvider","type":"string","x-stream-index":"001"},"push_provider_name":{"description":"Push provider name","title":"PushProviderName","type":"string","x-stream-index":"002"},"user_id":{"description":"User ID","title":"UserID","type":"string","x-stream-index":"008"},"voip":{"description":"When true the token is for Apple VoIP push notifications","title":"Voip","type":"boolean","x-stream-index":"007"}},"required":["push_provider","id","created_at","user_id"],"title":"DeviceResponse","type":"object"},"DraftPayloadResponse":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"html":{"type":"string","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"001"},"mentioned_users":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"008"},"mml":{"type":"string","x-stream-index":"003"},"parent_id":{"type":"string","x-stream-index":"005"},"poll_id":{"type":"string","x-stream-index":"013"},"quoted_message_id":{"type":"string","x-stream-index":"009"},"show_in_channel":{"type":"boolean","x-stream-index":"006"},"silent":{"type":"boolean","x-stream-index":"012"},"text":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"011"}},"required":["id","text","custom"],"type":"object"},"DraftResponse":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003"},"channel_cid":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"message":{"$ref":"#/components/schemas/DraftPayloadResponse","x-stream-index":"001"},"parent_id":{"type":"string","x-stream-index":"004"},"parent_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"005"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"006"}},"required":["message","channel_cid","created_at"],"type":"object"},"EdgeResponse":{"properties":{"continent_code":{"type":"string","x-stream-index":"007.003"},"country_iso_code":{"type":"string","x-stream-index":"007.002"},"green":{"format":"int32","type":"integer","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"latency_test_url":{"type":"string","x-stream-index":"002"},"latitude":{"format":"float","type":"number","x-stream-index":"006.001"},"longitude":{"format":"float","type":"number","x-stream-index":"006.002"},"red":{"format":"int32","type":"integer","x-stream-index":"005"},"subdivision_iso_code":{"type":"string","x-stream-index":"007.001"},"yellow":{"format":"int32","type":"integer","x-stream-index":"004"}},"required":["id","latency_test_url","green","yellow","red","latitude","longitude","subdivision_iso_code","country_iso_code","continent_code"],"type":"object"},"EgressHLSResponse":{"properties":{"playlist_url":{"type":"string","x-stream-index":"001"},"status":{"type":"string","x-stream-index":"002"}},"required":["playlist_url","status"],"type":"object"},"EgressRTMPResponse":{"properties":{"name":{"type":"string","x-stream-index":"001"},"started_at":{"format":"date-time","type":"number","x-stream-index":"004"},"stream_key":{"type":"string","x-stream-index":"003"},"stream_url":{"type":"string","x-stream-index":"002"}},"required":["name","started_at"],"type":"object"},"EgressResponse":{"properties":{"broadcasting":{"type":"boolean","x-stream-index":"001"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordingResponse","x-stream-index":"004"},"hls":{"$ref":"#/components/schemas/EgressHLSResponse","x-stream-index":"002"},"rtmps":{"items":{"$ref":"#/components/schemas/EgressRTMPResponse"},"type":"array","x-stream-index":"003"}},"required":["broadcasting","rtmps"],"type":"object"},"EndCallRequest":{"description":"Request for ending a call","nullable":true,"title":"EndCallRequest","type":"object"},"EndCallResponse":{"description":"Response for ending a call","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"EndCallResponse","type":"object"},"Field":{"nullable":true,"properties":{"short":{"type":"boolean","x-stream-index":"003"},"title":{"type":"string","x-stream-index":"001"},"value":{"type":"string","x-stream-index":"002"}},"required":["title","value","short"],"type":"object"},"FileUploadConfig":{"properties":{"allowed_file_extensions":{"items":{"type":"string"},"type":"array","x-stream-index":"001"},"allowed_mime_types":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"blocked_file_extensions":{"items":{"type":"string"},"type":"array","x-stream-index":"002"},"blocked_mime_types":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"size_limit":{"format":"int32","maximum":104857600,"minimum":0,"type":"integer","x-stream-index":"005"}},"required":["allowed_file_extensions","blocked_file_extensions","allowed_mime_types","blocked_mime_types","size_limit"],"type":"object"},"FileUploadRequest":{"nullable":true,"properties":{"file":{"description":"file field","title":"File","type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/OnlyUserID","description":"user for the request **server side only**","title":"User","x-stream-index":"002"}},"type":"object"},"FileUploadResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"file":{"description":"URL to the uploaded asset. Should be used to put to `asset_url` attachment field","title":"File","type":"string","x-stream-index":"001"},"thumb_url":{"description":"URL of the file thumbnail for supported file formats. Should be put to `thumb_url` attachment field","title":"Thumbnail URL","type":"string","x-stream-index":"002"}},"required":["duration"],"type":"object"},"FrameRecordingResponse":{"properties":{"status":{"type":"string","x-stream-index":"001"}},"required":["status"],"type":"object"},"FrameRecordingSettingsRequest":{"properties":{"capture_interval_in_seconds":{"format":"int32","maximum":60,"minimum":2,"type":"integer","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"},"quality":{"enum":["360p","480p","720p","1080p","1440p"],"type":"string","x-stream-index":"002"}},"required":["mode","capture_interval_in_seconds"],"type":"object"},"FrameRecordingSettingsResponse":{"properties":{"capture_interval_in_seconds":{"format":"int32","maximum":60,"minimum":2,"type":"integer","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"},"quality":{"type":"string","x-stream-index":"002"}},"required":["mode","capture_interval_in_seconds"],"type":"object"},"FullUserResponse":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"015"},"banned":{"type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"014"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.011"},"devices":{"items":{"$ref":"#/components/schemas/DeviceResponse"},"type":"array","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001.001"},"image":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"005"},"language":{"type":"string","x-stream-index":"001.005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"001.014"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"012"},"mutes":{"items":{"$ref":"#/components/schemas/UserMuteResponse"},"type":"array","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"001.002"},"online":{"type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"003"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.015"},"role":{"type":"string","x-stream-index":"001.006"},"shadow_banned":{"type":"boolean","x-stream-index":"013"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"009"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"010"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"008"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"011"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","devices","invisible","mutes","channel_mutes","unread_count","total_unread_count","unread_channels","unread_threads","shadow_banned","blocked_user_ids"],"type":"object"},"GeofenceSettingsRequest":{"properties":{"names":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"type":"object"},"GeofenceSettingsResponse":{"properties":{"names":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"required":["names"],"type":"object"},"GetApplicationResponse":{"description":"Basic response information","nullable":true,"properties":{"app":{"$ref":"#/components/schemas/AppResponseFields","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["app","duration"],"title":"Response","type":"object"},"GetBlockedUsersResponse":{"nullable":true,"properties":{"blocks":{"description":"Array of blocked user object","items":{"$ref":"#/components/schemas/BlockedUserResponse"},"title":"Blocks","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["blocks","duration"],"type":"object"},"GetCallReportResponse":{"description":"Basic response information","nullable":true,"properties":{"chat_activity":{"$ref":"#/components/schemas/ChatActivityStatsResponse","x-stream-index":"004"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"report":{"$ref":"#/components/schemas/ReportResponse","x-stream-index":"003"},"session_id":{"type":"string","x-stream-index":"002"},"video_reactions":{"items":{"$ref":"#/components/schemas/VideoReactionsResponse"},"type":"array","x-stream-index":"005"}},"required":["duration","session_id","report"],"title":"Response","type":"object"},"GetCallResponse":{"nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001.001"},"duration":{"type":"string","x-stream-index":"002.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001.002"},"membership":{"$ref":"#/components/schemas/MemberResponse","x-stream-index":"001.003"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"001.004"}},"required":["call","members","own_capabilities","blocked_users","duration"],"title":"GetCallResponse","type":"object"},"GetEdgesResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"edges":{"items":{"$ref":"#/components/schemas/EdgeResponse"},"type":"array","x-stream-index":"001"}},"required":["edges","duration"],"title":"Response","type":"object"},"GetOGResponse":{"nullable":true,"properties":{"actions":{"items":{"$ref":"#/components/schemas/Action"},"type":"array","x-stream-index":"001.015"},"asset_url":{"description":"URL of detected video or audio","title":"Image URL","type":"string","x-stream-index":"001.017"},"author_icon":{"type":"string","x-stream-index":"001.007"},"author_link":{"description":"og:site","title":"Author Link","type":"string","x-stream-index":"001.006"},"author_name":{"description":"og:site_name","title":"Author Name","type":"string","x-stream-index":"001.005"},"color":{"type":"string","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.018"},"duration":{"type":"string","x-stream-index":"002.001"},"fallback":{"type":"string","x-stream-index":"001.002"},"fields":{"items":{"$ref":"#/components/schemas/Field"},"type":"array","x-stream-index":"001.016"},"footer":{"type":"string","x-stream-index":"001.013"},"footer_icon":{"type":"string","x-stream-index":"001.014"},"giphy":{"$ref":"#/components/schemas/Images","x-stream-index":"001.019"},"image_url":{"description":"URL of detected image","title":"Image URL","type":"string","x-stream-index":"001.011"},"og_scrape_url":{"description":"extracted url from the text","title":"OG Scrape URL","type":"string","x-stream-index":"001.020"},"original_height":{"format":"int32","type":"integer","x-stream-index":"001.022"},"original_width":{"format":"int32","type":"integer","x-stream-index":"001.021"},"pretext":{"type":"string","x-stream-index":"001.004"},"text":{"description":"og:description","title":"Text","type":"string","x-stream-index":"001.010"},"thumb_url":{"description":"URL of detected thumb image","title":"Image URL","type":"string","x-stream-index":"001.012"},"title":{"description":"og:title","title":"Title","type":"string","x-stream-index":"001.008"},"title_link":{"description":"og:url","title":"Title Link","type":"string","x-stream-index":"001.009"},"type":{"description":"Attachment type, could be empty, image, audio or video","title":"Type","type":"string","x-stream-index":"001.001"}},"required":["custom","duration"],"title":"Get OG Attachment","type":"object","x-stream-docs-page-id":"og"},"GetOrCreateCallRequest":{"nullable":true,"properties":{"data":{"$ref":"#/components/schemas/CallRequest","title":"ReadOnlyData","x-stream-index":"003"},"members_limit":{"format":"int32","maximum":100,"type":"integer","x-stream-index":"007"},"notify":{"description":"if provided it sends a notification event to the members for this call","title":"Notify","type":"boolean","x-stream-index":"005"},"ring":{"description":"if provided it sends a ring event to the members for this call","title":"Ring","type":"boolean","x-stream-index":"004"},"video":{"type":"boolean","x-stream-index":"006"}},"title":"GetOrCreateCallRequest","type":"object"},"GetOrCreateCallResponse":{"nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001.001"},"created":{"type":"boolean","x-stream-index":"002"},"duration":{"type":"string","x-stream-index":"003.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001.002"},"membership":{"$ref":"#/components/schemas/MemberResponse","x-stream-index":"001.003"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"001.004"}},"required":["call","members","own_capabilities","blocked_users","created","duration"],"title":"GetOrCreateCallResponse","type":"object"},"GoLiveRequest":{"nullable":true,"properties":{"recording_storage_name":{"type":"string","x-stream-index":"005"},"start_closed_caption":{"type":"boolean","x-stream-index":"008"},"start_hls":{"type":"boolean","x-stream-index":"003"},"start_recording":{"type":"boolean","x-stream-index":"004"},"start_transcription":{"type":"boolean","x-stream-index":"007"},"transcription_storage_name":{"type":"string","x-stream-index":"006"}},"title":"GoLiveRequest","type":"object"},"GoLiveResponse":{"description":"Basic response information","nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["call","duration"],"title":"Response","type":"object"},"GroupedStatsResponse":{"nullable":true,"properties":{"name":{"type":"string","x-stream-index":"001"},"unique":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["name","unique"],"type":"object"},"HLSSettingsRequest":{"properties":{"auto_on":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"quality_tracks":{"items":{"type":"string"},"maximum":3,"minimum":1,"type":"array","x-stream-index":"003"}},"required":["quality_tracks"],"title":"HLSSettingsRequest","type":"object"},"HLSSettingsResponse":{"description":"HLSSettings is the payload for HLS settings","properties":{"auto_on":{"title":"Auto On","type":"boolean","x-stream-index":"001"},"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"002"},"quality_tracks":{"items":{"type":"string"},"title":"Quality Tracks","type":"array","x-stream-index":"003"}},"required":["auto_on","enabled","quality_tracks","layout"],"title":"HLSSettingsResponse","type":"object"},"HealthCheckEvent":{"nullable":true,"properties":{"cid":{"type":"string","x-stream-index":"003"},"connection_id":{"type":"string","x-stream-index":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004.007"},"me":{"$ref":"#/components/schemas/OwnUserResponse","x-stream-index":"002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"004.004"},"type":{"default":"health.check","type":"string","x-stream-index":"004.002"}},"required":["connection_id","type","created_at","custom"],"title":"HealthCheckEvent","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"},"ICEServer":{"properties":{"password":{"type":"string","x-stream-index":"003"},"urls":{"items":{"type":"string"},"type":"array","x-stream-index":"001"},"username":{"type":"string","x-stream-index":"002"}},"required":["urls","username","password"],"type":"object"},"ImageData":{"properties":{"frames":{"type":"string","x-stream-index":"005"},"height":{"type":"string","x-stream-index":"003"},"size":{"type":"string","x-stream-index":"004"},"url":{"type":"string","x-stream-index":"001"},"width":{"type":"string","x-stream-index":"002"}},"required":["url","width","height","size","frames"],"type":"object"},"ImageSize":{"properties":{"crop":{"description":"Crop mode","enum":["top","bottom","left","right","center"],"title":"Crop","type":"string","x-stream-index":"001"},"height":{"description":"Target image height","format":"int32","title":"Height","type":"integer","x-stream-index":"003"},"resize":{"description":"Resize method","enum":["clip","crop","scale","fill"],"title":"Resize","type":"string","x-stream-index":"002"},"width":{"description":"Target image width","format":"int32","title":"Width","type":"integer","x-stream-index":"004"}},"title":"Image size configuration","type":"object"},"ImageUploadRequest":{"nullable":true,"properties":{"file":{"type":"string","x-stream-index":"001.001"},"upload_sizes":{"description":"field with JSON-encoded array of image size configurations","items":{"$ref":"#/components/schemas/ImageSize"},"title":"Upload sizes","type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/OnlyUserID","x-stream-index":"001.002"}},"type":"object"},"ImageUploadResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.003.001"},"file":{"type":"string","x-stream-index":"001.001"},"thumb_url":{"type":"string","x-stream-index":"001.002"},"upload_sizes":{"description":"Array of image size configurations","items":{"$ref":"#/components/schemas/ImageSize"},"title":"Upload sizes","type":"array","x-stream-index":"002"}},"required":["duration"],"type":"object"},"Images":{"properties":{"fixed_height":{"$ref":"#/components/schemas/ImageData","x-stream-index":"002"},"fixed_height_downsampled":{"$ref":"#/components/schemas/ImageData","x-stream-index":"004"},"fixed_height_still":{"$ref":"#/components/schemas/ImageData","x-stream-index":"003"},"fixed_width":{"$ref":"#/components/schemas/ImageData","x-stream-index":"005"},"fixed_width_downsampled":{"$ref":"#/components/schemas/ImageData","x-stream-index":"007"},"fixed_width_still":{"$ref":"#/components/schemas/ImageData","x-stream-index":"006"},"original":{"$ref":"#/components/schemas/ImageData","x-stream-index":"001"}},"required":["original","fixed_height","fixed_height_still","fixed_height_downsampled","fixed_width","fixed_width_still","fixed_width_downsampled"],"type":"object"},"IngressAudioEncodingOptionsRequest":{"properties":{"bitrate":{"maximum":128000,"minimum":16000,"type":"integer","x-stream-index":"003"},"channels":{"enum":["1","2"],"format":"int32","type":"integer","x-stream-index":"001"},"enable_dtx":{"type":"boolean","x-stream-index":"002"}},"required":["channels","bitrate"],"type":"object"},"IngressAudioEncodingResponse":{"properties":{"bitrate":{"format":"int32","type":"integer","x-stream-index":"003"},"channels":{"format":"int32","type":"integer","x-stream-index":"001"},"enable_dtx":{"type":"boolean","x-stream-index":"002"}},"required":["channels","enable_dtx","bitrate"],"type":"object"},"IngressSettingsRequest":{"properties":{"audio_encoding_options":{"$ref":"#/components/schemas/IngressAudioEncodingOptionsRequest","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"video_encoding_options":{"additionalProperties":{"$ref":"#/components/schemas/IngressVideoEncodingOptionsRequest"},"type":"object","x-stream-index":"003"}},"type":"object"},"IngressSettingsResponse":{"properties":{"audio_encoding_options":{"$ref":"#/components/schemas/IngressAudioEncodingResponse","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"video_encoding_options":{"additionalProperties":{"$ref":"#/components/schemas/IngressVideoEncodingResponse"},"type":"object","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"IngressVideoEncodingOptionsRequest":{"properties":{"layers":{"items":{"$ref":"#/components/schemas/IngressVideoLayerRequest"},"minimum":1,"type":"array","x-stream-index":"001"}},"required":["layers"],"type":"object"},"IngressVideoEncodingResponse":{"properties":{"layers":{"items":{"$ref":"#/components/schemas/IngressVideoLayerResponse"},"type":"array","x-stream-index":"001"}},"required":["layers"],"type":"object"},"IngressVideoLayerRequest":{"nullable":true,"properties":{"bitrate":{"format":"int32","minimum":1000,"type":"integer","x-stream-index":"002"},"codec":{"enum":["h264","vp8"],"type":"string","x-stream-index":"001"},"frame_rate_limit":{"maximum":60,"minimum":1,"type":"integer","x-stream-index":"005"},"max_dimension":{"minimum":240,"type":"integer","x-stream-index":"004"},"min_dimension":{"minimum":240,"type":"integer","x-stream-index":"003"}},"required":["codec","bitrate","min_dimension","max_dimension","frame_rate_limit"],"type":"object"},"IngressVideoLayerResponse":{"nullable":true,"properties":{"bitrate":{"type":"integer","x-stream-index":"002"},"codec":{"type":"string","x-stream-index":"001"},"frame_rate_limit":{"type":"integer","x-stream-index":"005"},"max_dimension":{"type":"integer","x-stream-index":"004"},"min_dimension":{"type":"integer","x-stream-index":"003"}},"required":["codec","bitrate","min_dimension","max_dimension","frame_rate_limit"],"type":"object"},"JoinCallRequest":{"nullable":true,"properties":{"create":{"description":"if true the call will be created if it doesn't exist","title":"Create","type":"boolean","x-stream-index":"002"},"data":{"$ref":"#/components/schemas/CallRequest","x-stream-index":"003"},"location":{"title":"Location","type":"string","x-stream-index":"009"},"members_limit":{"format":"int32","maximum":100,"title":"The amount of members that should be returned","type":"integer","x-stream-index":"007"},"migrating_from":{"description":"If the participant is migrating from another SFU, then this is the ID of the previous SFU","title":"MigratingFrom","type":"string","x-stream-index":"010"},"notify":{"type":"boolean","x-stream-index":"005"},"ring":{"description":"if true and the call is created, the notification will include ring=true","title":"Ring","type":"boolean","x-stream-index":"004"},"video":{"type":"boolean","x-stream-index":"006"}},"required":["location"],"title":"JoinCallRequest","type":"object"},"JoinCallResponse":{"nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001.001"},"created":{"title":"Created","type":"boolean","x-stream-index":"002"},"credentials":{"$ref":"#/components/schemas/Credentials","title":"Credentials","x-stream-index":"003"},"duration":{"type":"string","x-stream-index":"005.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001.002"},"membership":{"$ref":"#/components/schemas/MemberResponse","x-stream-index":"001.003"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"001.004"},"stats_options":{"$ref":"#/components/schemas/StatsOptions","x-stream-index":"004"}},"required":["call","members","own_capabilities","blocked_users","created","credentials","stats_options","duration"],"title":"JoinCallResponse","type":"object"},"LabelThresholds":{"properties":{"block":{"description":"Threshold for automatic message block","format":"float","maximum":1,"minimum":0,"title":"Block","type":"number","x-stream-index":"002"},"flag":{"description":"Threshold for automatic message flag","format":"float","maximum":1,"minimum":0,"title":"Flag","type":"number","x-stream-index":"001"}},"type":"object"},"LayoutSettingsRequest":{"properties":{"detect_orientation":{"type":"boolean","x-stream-index":"005"},"external_app_url":{"type":"string","x-stream-index":"003"},"external_css_url":{"type":"string","x-stream-index":"004"},"name":{"enum":["spotlight","grid","single-participant","mobile","custom"],"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"required":["name"],"type":"object"},"LimitsSettingsRequest":{"properties":{"max_duration_seconds":{"format":"int32","minimum":0,"type":"integer","x-stream-index":"004"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"},"max_participants_exclude_owner":{"type":"boolean","x-stream-index":"003"},"max_participants_exclude_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"002"}},"type":"object"},"LimitsSettingsResponse":{"properties":{"max_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"004"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"},"max_participants_exclude_owner":{"type":"boolean","x-stream-index":"003"},"max_participants_exclude_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"002"}},"required":["max_participants_exclude_roles"],"type":"object"},"ListBlockListResponse":{"description":"Basic response information","nullable":true,"properties":{"blocklists":{"items":{"$ref":"#/components/schemas/BlockListResponse"},"type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["blocklists","duration"],"title":"Response","type":"object"},"ListDevicesResponse":{"description":"List devices response","nullable":true,"properties":{"devices":{"description":"List of devices","items":{"$ref":"#/components/schemas/DeviceResponse"},"title":"Devices","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["devices","duration"],"title":"ListDevicesResponse","type":"object"},"ListRecordingsResponse":{"description":"Response for listing recordings","nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"},"recordings":{"items":{"$ref":"#/components/schemas/CallRecording"},"title":"The list of recordings.","type":"array","x-stream-index":"002"}},"required":["duration","recordings"],"title":"ListRecordingsResponse","type":"object"},"ListTranscriptionsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"},"transcriptions":{"description":"List of transcriptions for the call","items":{"$ref":"#/components/schemas/CallTranscription"},"title":"Transcriptions","type":"array","x-stream-index":"002"}},"required":["duration","transcriptions"],"title":"ListTranscriptionsResponse","type":"object"},"MemberRequest":{"description":"MemberRequest is the payload for adding a member to a call.","properties":{"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"003"},"role":{"title":"Role","type":"string","x-stream-index":"002"},"user_id":{"minLength":1,"title":"User ID","type":"string","x-stream-index":"001"}},"required":["user_id"],"title":"MemberRequest","type":"object"},"MemberResponse":{"description":"MemberResponse is the payload for a member of a call.","properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"005"},"custom":{"additionalProperties":{},"description":"Custom member response data","title":"Custom","type":"object","x-stream-index":"004"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"007"},"role":{"title":"Role","type":"string","x-stream-index":"003"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"006"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"},"user_id":{"type":"string","x-stream-index":"002"}},"required":["user","user_id","custom","created_at","updated_at"],"title":"MemberResponse","type":"object"},"Message":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"012"},"before_message_send_failed":{"type":"boolean","x-stream-index":"046"},"cid":{"type":"string","x-stream-index":"028"},"command":{"type":"string","x-stream-index":"006"},"created_at":{"format":"date-time","type":"number","x-stream-index":"030"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"034"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"033"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"023"},"html":{"type":"string","x-stream-index":"007"},"i18n":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"044"},"id":{"type":"string","x-stream-index":"002"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"040"},"latest_reactions":{"items":{"$ref":"#/components/schemas/Reaction"},"type":"array","x-stream-index":"013"},"mentioned_users":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"043"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"052"},"mml":{"type":"string","x-stream-index":"005"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"056"},"own_reactions":{"items":{"$ref":"#/components/schemas/Reaction"},"type":"array","x-stream-index":"014"},"parent_id":{"type":"string","x-stream-index":"019"},"pin_expires":{"format":"date-time","type":"number","x-stream-index":"051"},"pinned":{"type":"boolean","x-stream-index":"047"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"048"},"pinned_by":{"$ref":"#/components/schemas/User","x-stream-index":"050"},"poll":{"$ref":"#/components/schemas/Poll","x-stream-index":"054"},"poll_id":{"type":"string","x-stream-index":"053"},"quoted_message":{"$ref":"#/components/schemas/Message","x-stream-index":"025"},"quoted_message_id":{"type":"string","x-stream-index":"024"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"015"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"017"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"016"},"reminder":{"$ref":"#/components/schemas/MessageReminder","x-stream-index":"058"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"022"},"restricted_visibility":{"items":{"type":"string"},"type":"array","x-stream-index":"011"},"shadowed":{"type":"boolean","x-stream-index":"036"},"shared_location":{"$ref":"#/components/schemas/SharedLocation","x-stream-index":"055"},"show_in_channel":{"type":"boolean","x-stream-index":"021"},"silent":{"type":"boolean","x-stream-index":"045"},"text":{"type":"string","x-stream-index":"004"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"027"},"type":{"type":"string","x-stream-index":"008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"031"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"010"}},"required":["id","text","html","type","restricted_visibility","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reaction_groups","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned"],"type":"object"},"MessageReminder":{"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"004"},"channel_cid":{"type":"string","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"011"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"006"},"message_id":{"type":"string","x-stream-index":"005"},"remind_at":{"format":"date-time","type":"number","x-stream-index":"009"},"task_id":{"type":"string","x-stream-index":"010"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"012"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"user_id":{"type":"string","x-stream-index":"007"}},"required":["channel_cid","message_id","user_id","task_id","created_at","updated_at"],"type":"object"},"MessageResponse":{"description":"Represents any chat message","properties":{"attachments":{"description":"Array of message attachments","items":{"$ref":"#/components/schemas/Attachment"},"title":"Message attachments","type":"array","x-stream-docs-page-id":"message_format#attachment-format","x-stream-index":"008"},"cid":{"description":"Channel unique identifier in \u003ctype\u003e:\u003cid\u003e format","title":"Channel CID","type":"string","x-stream-index":"022"},"command":{"description":"Contains provided slash command","title":"Command","type":"string","x-stream-docs-page-id":"custom_commands_webhook","x-stream-index":"004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"023"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"026"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"025"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"018"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"041"},"html":{"description":"Contains HTML markup of the message. Can only be set when using server-side API","title":"HTML content","type":"string","x-stream-index":"005"},"i18n":{"additionalProperties":{"type":"string"},"description":"Object with translations. Key `language` contains the original language key. Other keys contain translations","title":"Internationalization info","type":"object","x-stream-docs-page-id":"translation","x-stream-index":"030"},"id":{"description":"Message ID is unique string identifier of the message","title":"ID","type":"string","x-stream-index":"001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"Contains image moderation information","title":"Image moderation labels","type":"object","x-stream-index":"028"},"latest_reactions":{"description":"List of 10 latest reactions to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Latest reactions","type":"array","x-stream-index":"009"},"mentioned_users":{"description":"List of mentioned users","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Mentioned Users","type":"array","x-stream-index":"029"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"036"},"mml":{"description":"Should be empty if `text` is provided. Can only be set when using server-side API","title":"Messaging Markup Language","type":"string","x-stream-docs-page-id":"mml_overview","x-stream-index":"003"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"039"},"own_reactions":{"description":"List of 10 latest reactions of authenticated user to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Own reactions","type":"array","x-stream-index":"010"},"parent_id":{"description":"ID of parent message (thread)","title":"Parent message ID","type":"string","x-stream-docs-page-id":"threads","x-stream-index":"015"},"pin_expires":{"description":"Date when pinned message expires","format":"date-time","title":"Pin expiration date","type":"number","x-stream-docs-page-id":"pinned_messages","x-stream-index":"035"},"pinned":{"description":"Whether message is pinned or not","title":"Pinned","type":"boolean","x-stream-docs-page-id":"pinned_messages","x-stream-index":"032"},"pinned_at":{"description":"Date when message got pinned","format":"date-time","title":"Pinned at","type":"number","x-stream-docs-page-id":"pinned_messages","x-stream-index":"033"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","description":"Contains user who pinned the message","title":"Pinned by","x-stream-docs-page-id":"pinned_messages","x-stream-index":"034"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"038"},"poll_id":{"description":"Identifier of the poll to include in the message","title":"Poll ID","type":"string","x-stream-index":"037"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","description":"Contains quoted message","title":"Quoted message","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"020"},"quoted_message_id":{"title":"ID of quoted message","type":"string","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"019"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing number of reactions of each type. Key: reaction type (string), value: number of reactions (int)","title":"Reaction counts","type":"object","x-stream-index":"011"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"014"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing scores of reactions of each type. Key: reaction type (string), value: total score of reactions (int)","title":"Reaction scores","type":"object","x-stream-index":"012"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"042"},"reply_count":{"description":"Number of replies to this message","format":"int32","title":"Reply count","type":"integer","x-stream-index":"017"},"restricted_visibility":{"description":"A list of user ids that have restricted visibility to the message, if the list is not empty, the message is only visible to the users in the list","items":{"type":"string"},"title":"Restricted visibility","type":"array","x-stream-index":"040"},"shadowed":{"description":"Whether the message was shadowed or not","title":"Shadowed","type":"boolean","x-stream-docs-page-id":"moderation#shadow-ban","x-stream-index":"027"},"shared_location":{"$ref":"#/components/schemas/SharedLocationResponseData","description":"Contains shared location data","title":"Shared Location","x-stream-index":"043"},"show_in_channel":{"description":"Whether thread reply should be shown in the channel as well","title":"Show in channel","type":"boolean","x-stream-docs-page-id":"threads","x-stream-index":"016"},"silent":{"description":"Whether message is silent or not","title":"Silent","type":"boolean","x-stream-index":"031"},"text":{"description":"Text of the message. Should be empty if `mml` is provided","title":"Text","type":"string","x-stream-index":"002"},"thread_participants":{"description":"List of users who participate in thread","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Thread participants","type":"array","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"021"},"type":{"description":"Contains type of the message","enum":["regular","ephemeral","error","reply","system","deleted"],"title":"Message Type","type":"string","x-stream-docs-page-id":"message_format#message-types","x-stream-index":"006"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"024"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Sender of the message. Required when using server-side API","title":"User object","x-stream-index":"007"}},"required":["id","text","html","type","user","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned","restricted_visibility"],"title":"Message","type":"object","x-stream-docs-page-id":"send_message"},"MessageStatsResponse":{"properties":{"count_over_time":{"items":{"$ref":"#/components/schemas/CountByMinuteResponse"},"type":"array","x-stream-index":"001"}},"type":"object"},"ModerationV2Response":{"properties":{"action":{"type":"string","x-stream-index":"001"},"blocklist_matched":{"type":"string","x-stream-index":"005"},"image_harms":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"original_text":{"type":"string","x-stream-index":"002"},"platform_circumvented":{"type":"boolean","x-stream-index":"007"},"semantic_filter_matched":{"type":"string","x-stream-index":"006"},"text_harms":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"required":["action","original_text"],"type":"object"},"MuteUsersRequest":{"nullable":true,"properties":{"audio":{"title":"Audio","type":"boolean","x-stream-index":"005"},"mute_all_users":{"type":"boolean","x-stream-index":"003"},"screenshare":{"title":"Screenshare","type":"boolean","x-stream-index":"007"},"screenshare_audio":{"title":"ScreenshareAudio","type":"boolean","x-stream-index":"008"},"user_ids":{"items":{"type":"string"},"title":"UserIDs","type":"array","x-stream-index":"004"},"video":{"title":"Video","type":"boolean","x-stream-index":"006"}},"title":"MuteUsersRequest","type":"object"},"MuteUsersResponse":{"description":"MuteUsersResponse is the response payload for the mute users endpoint.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"MuteUsersResponse","type":"object"},"NetworkMetricsReportResponse":{"properties":{"average_connection_time":{"format":"float","type":"number","x-stream-index":"003"},"average_jitter":{"format":"float","type":"number","x-stream-index":"002"},"average_latency":{"format":"float","type":"number","x-stream-index":"001"},"average_time_to_reconnect":{"format":"float","type":"number","x-stream-index":"004"}},"type":"object"},"NoiseCancellationSettings":{"properties":{"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode"],"type":"object"},"OnlyUserID":{"properties":{"id":{"type":"string","x-stream-index":"001"}},"required":["id"],"type":"object"},"OwnCapability":{"description":"All possibility of string to use","enum":["block-users","change-max-duration","create-call","create-reaction","enable-noise-cancellation","end-call","join-backstage","join-call","join-ended-call","mute-users","pin-for-everyone","read-call","remove-call-member","screenshare","send-audio","send-video","start-broadcast-call","start-closed-captions-call","start-frame-record-call","start-record-call","start-transcription-call","stop-broadcast-call","stop-closed-captions-call","stop-frame-record-call","stop-record-call","stop-transcription-call","update-call","update-call-member","update-call-permissions","update-call-settings"],"title":"OwnCapability","type":"string"},"OwnUserResponse":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"banned":{"type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"015"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.011"},"devices":{"items":{"$ref":"#/components/schemas/DeviceResponse"},"title":"Devices","type":"array","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001.001"},"image":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"005"},"language":{"type":"string","x-stream-index":"001.005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"001.014"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"013"},"mutes":{"items":{"$ref":"#/components/schemas/UserMuteResponse"},"type":"array","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"001.002"},"online":{"type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"003"},"push_preferences":{"$ref":"#/components/schemas/PushPreferences","x-stream-index":"002"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.015"},"role":{"type":"string","x-stream-index":"001.006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"009"},"total_unread_count_by_team":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"010"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"011"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"008"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"012"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","devices","invisible","mutes","channel_mutes","unread_count","total_unread_count","unread_channels","unread_threads"],"type":"object"},"ParticipantCountByMinuteResponse":{"nullable":true,"properties":{"first":{"format":"int32","type":"integer","x-stream-index":"002"},"last":{"format":"int32","type":"integer","x-stream-index":"003"},"max":{"format":"int32","type":"integer","x-stream-index":"004"},"min":{"format":"int32","type":"integer","x-stream-index":"005"},"start_ts":{"format":"date-time","type":"number","x-stream-index":"001"}},"required":["start_ts","first","last","max","min"],"type":"object"},"ParticipantCountOverTimeResponse":{"properties":{"by_minute":{"items":{"$ref":"#/components/schemas/ParticipantCountByMinuteResponse"},"type":"array","x-stream-index":"001"}},"type":"object"},"ParticipantReportResponse":{"properties":{"by_browser":{"items":{"$ref":"#/components/schemas/GroupedStatsResponse"},"type":"array","x-stream-index":"008"},"by_country":{"items":{"$ref":"#/components/schemas/GroupedStatsResponse"},"type":"array","x-stream-index":"005"},"by_device":{"items":{"$ref":"#/components/schemas/GroupedStatsResponse"},"type":"array","x-stream-index":"006"},"by_operating_system":{"items":{"$ref":"#/components/schemas/GroupedStatsResponse"},"type":"array","x-stream-index":"007"},"count_over_time":{"$ref":"#/components/schemas/ParticipantCountOverTimeResponse","x-stream-index":"004"},"max_concurrent":{"format":"int32","type":"integer","x-stream-index":"003"},"publishers":{"$ref":"#/components/schemas/PublisherStatsResponse","x-stream-index":"009"},"subscribers":{"$ref":"#/components/schemas/SubscriberStatsResponse","x-stream-index":"010"},"sum":{"format":"int32","type":"integer","x-stream-index":"001"},"unique":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["sum","unique"],"type":"object"},"PerSDKUsageReport":{"nullable":true,"properties":{"by_version":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"002"},"total":{"format":"int32","type":"integer","x-stream-index":"001"}},"required":["total","by_version"],"type":"object"},"PermissionRequestEvent":{"description":"This event is sent when a user requests access to a feature on a call,\nclients receiving this event should display a permission request to the user","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"permissions":{"description":"The list of permissions requested by the user","items":{"type":"string"},"title":"Permissions","type":"array","x-stream-index":"004"},"type":{"default":"call.permission_request","description":"The type of event: \"call.permission_request\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who sent the permission request","title":"User","x-stream-index":"003"}},"required":["type","created_at","call_cid","user","permissions"],"title":"PermissionRequestEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"PinRequest":{"description":"PinRequest is the payload for pinning a message.","nullable":true,"properties":{"session_id":{"description":"the session ID of the user who pinned the message","title":"SessionID","type":"string","x-stream-index":"003"},"user_id":{"description":"the user ID of the user who pinned the message","title":"UserID","type":"string","x-stream-index":"002"}},"required":["user_id","session_id"],"title":"PinRequest","type":"object"},"PinResponse":{"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"},"Poll":{"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"023"},"allow_answers":{"type":"boolean","x-stream-index":"010"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"009"},"answers_count":{"format":"int32","type":"integer","x-stream-index":"015"},"created_at":{"format":"date-time","type":"number","x-stream-index":"021"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"020"},"created_by_id":{"type":"string","x-stream-index":"019"},"description":{"type":"string","x-stream-index":"005"},"enforce_unique_vote":{"type":"boolean","x-stream-index":"007"},"id":{"type":"string","x-stream-index":"003"},"is_closed":{"type":"boolean","x-stream-index":"011"},"latest_answers":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array","x-stream-index":"017"},"latest_votes_by_option":{"additionalProperties":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array"},"type":"object","x-stream-index":"016"},"max_votes_allowed":{"format":"int32","type":"integer","x-stream-index":"008"},"name":{"type":"string","x-stream-index":"004"},"options":{"items":{"$ref":"#/components/schemas/PollOption"},"type":"array","x-stream-index":"013"},"own_votes":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array","x-stream-index":"018"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"022"},"vote_count":{"format":"int32","type":"integer","x-stream-index":"012"},"vote_counts_by_option":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"014"},"voting_visibility":{"type":"string","x-stream-index":"006"}},"required":["id","name","description","enforce_unique_vote","allow_user_suggested_options","allow_answers","vote_count","options","vote_counts_by_option","answers_count","latest_votes_by_option","latest_answers","own_votes","created_by_id","created_at","updated_at","Custom"],"type":"object"},"PollOption":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id","text","custom"],"type":"object"},"PollOptionInput":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"text":{"type":"string","x-stream-index":"002"}},"type":"object"},"PollOptionRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id"],"type":"object"},"PollOptionResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"poll_option":{"$ref":"#/components/schemas/PollOptionResponseData","description":"Poll option","title":"PollOptionResponseData","x-stream-index":"001"}},"required":["poll_option","duration"],"type":"object"},"PollOptionResponseData":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id","text","custom"],"type":"object"},"PollResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"poll":{"$ref":"#/components/schemas/PollResponseData","description":"Poll","title":"PollResponseData","x-stream-index":"001"}},"required":["poll","duration"],"type":"object"},"PollResponseData":{"properties":{"allow_answers":{"type":"boolean","x-stream-index":"008"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"007"},"answers_count":{"format":"int32","type":"integer","x-stream-index":"012"},"created_at":{"format":"date-time","type":"number","x-stream-index":"019"},"created_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"018"},"created_by_id":{"type":"string","x-stream-index":"017"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"021"},"description":{"type":"string","x-stream-index":"003"},"enforce_unique_vote":{"type":"boolean","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"is_closed":{"type":"boolean","x-stream-index":"009"},"latest_answers":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array","x-stream-index":"015"},"latest_votes_by_option":{"additionalProperties":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array"},"type":"object","x-stream-index":"014"},"max_votes_allowed":{"format":"int32","type":"integer","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"002"},"options":{"items":{"$ref":"#/components/schemas/PollOptionResponseData"},"type":"array","x-stream-index":"011"},"own_votes":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array","x-stream-index":"016"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"020"},"vote_count":{"format":"int32","type":"integer","x-stream-index":"010"},"vote_counts_by_option":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"013"},"voting_visibility":{"type":"string","x-stream-index":"004"}},"required":["id","name","description","voting_visibility","enforce_unique_vote","allow_user_suggested_options","allow_answers","vote_count","options","answers_count","vote_counts_by_option","latest_votes_by_option","latest_answers","own_votes","created_by_id","created_at","updated_at","custom"],"type":"object"},"PollVote":{"nullable":true,"properties":{"answer_text":{"type":"string","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"004"},"is_answer":{"type":"boolean","x-stream-index":"006"},"option_id":{"type":"string","x-stream-index":"005"},"poll_id":{"type":"string","x-stream-index":"003"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"011"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"009"},"user_id":{"type":"string","x-stream-index":"008"}},"required":["poll_id","id","option_id","created_at","updated_at"],"type":"object"},"PollVoteResponseData":{"nullable":true,"properties":{"answer_text":{"type":"string","x-stream-index":"005"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"id":{"type":"string","x-stream-index":"002"},"is_answer":{"type":"boolean","x-stream-index":"004"},"option_id":{"type":"string","x-stream-index":"003"},"poll_id":{"type":"string","x-stream-index":"001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"007"},"user_id":{"type":"string","x-stream-index":"006"}},"required":["poll_id","id","option_id","created_at","updated_at"],"type":"object"},"PollVotesResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"votes":{"description":"Poll votes","items":{"$ref":"#/components/schemas/PollVoteResponseData"},"title":"PollVoteResponseList","type":"array","x-stream-index":"001"}},"required":["votes","duration"],"type":"object"},"PrivacySettings":{"properties":{"read_receipts":{"$ref":"#/components/schemas/ReadReceipts","x-stream-index":"002"},"typing_indicators":{"$ref":"#/components/schemas/TypingIndicators","x-stream-index":"001"}},"type":"object"},"PrivacySettingsResponse":{"properties":{"read_receipts":{"$ref":"#/components/schemas/ReadReceiptsResponse","x-stream-index":"002"},"typing_indicators":{"$ref":"#/components/schemas/TypingIndicatorsResponse","x-stream-index":"001"}},"type":"object"},"PublisherStatsResponse":{"properties":{"by_track":{"items":{"$ref":"#/components/schemas/TrackStatsResponse"},"type":"array","x-stream-index":"003"},"total":{"format":"int32","type":"integer","x-stream-index":"001"},"unique":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["total","unique"],"type":"object"},"PushPreferences":{"properties":{"call_level":{"type":"string","x-stream-index":"002"},"chat_level":{"type":"string","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"number","x-stream-index":"003"}},"type":"object"},"QualityScoreReport":{"properties":{"histogram":{"items":{"$ref":"#/components/schemas/ReportByHistogramBucket"},"type":"array","x-stream-index":"001"}},"required":["histogram"],"type":"object"},"QualityScoreReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateQualityScoreReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"QueryAggregateCallStatsRequest":{"nullable":true,"properties":{"from":{"type":"string","x-stream-index":"002"},"report_types":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"to":{"type":"string","x-stream-index":"003"}},"type":"object"},"QueryAggregateCallStatsResponse":{"description":"Basic response information","nullable":true,"properties":{"call_duration_report":{"$ref":"#/components/schemas/CallDurationReportResponse","x-stream-index":"002"},"call_participant_count_report":{"$ref":"#/components/schemas/CallParticipantCountReportResponse","x-stream-index":"004"},"calls_per_day_report":{"$ref":"#/components/schemas/CallsPerDayReportResponse","x-stream-index":"003"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"network_metrics_report":{"$ref":"#/components/schemas/NetworkMetricsReportResponse","x-stream-index":"008"},"quality_score_report":{"$ref":"#/components/schemas/QualityScoreReportResponse","x-stream-index":"005"},"sdk_usage_report":{"$ref":"#/components/schemas/SDKUsageReportResponse","x-stream-index":"006"},"user_feedback_report":{"$ref":"#/components/schemas/UserFeedbackReportResponse","x-stream-index":"007"}},"required":["duration"],"title":"Response","type":"object"},"QueryCallMembersRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"002"},"id":{"maxLength":64,"type":"string","x-stream-index":"001.002"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"004.001"},"next":{"type":"string","x-stream-index":"004.002"},"prev":{"type":"string","x-stream-index":"004.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":1,"type":"array","x-stream-index":"003"},"type":{"maxLength":64,"type":"string","x-stream-index":"001.001"}},"required":["type","id"],"type":"object"},"QueryCallMembersResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["members","duration"],"title":"Response","type":"object"},"QueryCallParticipantsRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"003"}},"type":"object"},"QueryCallParticipantsResponse":{"nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001.001"},"duration":{"type":"string","x-stream-index":"004.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001.002"},"membership":{"$ref":"#/components/schemas/MemberResponse","x-stream-index":"001.003"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"001.004"},"participants":{"description":"List of call participants","items":{"$ref":"#/components/schemas/CallParticipantResponse"},"title":"[]CallParticipantResponse","type":"array","x-stream-index":"002"},"total_participants":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["call","members","own_capabilities","blocked_users","participants","total_participants","duration"],"type":"object"},"QueryCallStatsRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"004.001"},"next":{"type":"string","x-stream-index":"004.002"},"prev":{"type":"string","x-stream-index":"004.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":2,"type":"array","x-stream-index":"002"}},"type":"object"},"QueryCallStatsResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"next":{"type":"string","x-stream-index":"003.001"},"prev":{"type":"string","x-stream-index":"003.002"},"reports":{"items":{"$ref":"#/components/schemas/CallStatsReportSummaryResponse"},"type":"array","x-stream-index":"001"}},"required":["reports","duration"],"title":"Response","type":"object"},"QueryCallsRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"title":"Filters","type":"object","x-stream-index":"003"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"006.001"},"next":{"type":"string","x-stream-index":"006.002"},"prev":{"type":"string","x-stream-index":"006.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":2,"title":"Sort","type":"array","x-stream-index":"004"},"watch":{"title":"Watch","type":"boolean","x-stream-index":"001"}},"title":"QueryCallsRequest","type":"object"},"QueryCallsResponse":{"nullable":true,"properties":{"calls":{"items":{"$ref":"#/components/schemas/CallStateResponseFields"},"title":"Calls","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["calls","duration"],"title":"QueryCallsResponse","type":"object"},"QueryPollVotesRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","title":"Filter","type":"object","x-stream-index":"003"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"004"}},"type":"object"},"QueryPollsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","title":"Filter","type":"object","x-stream-index":"002"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"003"}},"type":"object"},"QueryPollsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"polls":{"description":"Polls data returned by the query","items":{"$ref":"#/components/schemas/PollResponseData"},"title":"PollsResponseData","type":"array","x-stream-index":"001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["polls","duration"],"type":"object"},"QueryUsersPayload":{"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"include_deactivated_users":{"type":"boolean","x-stream-index":"004"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.003"},"offset":{"format":"int32","maximum":1000,"type":"integer","x-stream-index":"005.004"},"presence":{"type":"boolean","x-stream-index":"003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"type":"array","x-stream-index":"002"}},"required":["filter_conditions"],"type":"object"},"QueryUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"users":{"description":"Array of users as result of filters applied.","items":{"$ref":"#/components/schemas/FullUserResponse"},"title":"Users","type":"array","x-stream-index":"001"}},"required":["users","duration"],"type":"object"},"RTMPBroadcastRequest":{"description":"RTMPBroadcastRequest is the payload for starting an RTMP broadcast.","properties":{"layout":{"$ref":"#/components/schemas/LayoutSettingsRequest","description":"If provided, will override the call's RTMP settings layout","title":"Layout","x-stream-index":"005"},"name":{"description":"Name identifier for RTMP broadcast, must be unique in call","maxLength":255,"title":"Name","type":"string","x-stream-index":"001"},"quality":{"description":"If provided, will override the call's RTMP settings quality","enum":["360p","480p","720p","1080p","1440p","portrait-360x640","portrait-480x854","portrait-720x1280","portrait-1080x1920","portrait-1440x2560"],"title":"Quality","type":"string","x-stream-index":"004"},"stream_key":{"description":"If provided, will be appended at the end of stream_url","title":"Stream Key","type":"string","x-stream-index":"003"},"stream_url":{"description":"URL for the RTMP server to send the call to","maxLength":255,"title":"Stream URL","type":"string","x-stream-index":"002"}},"required":["name","stream_url"],"title":"RTMPBroadcastRequest","type":"object"},"RTMPIngress":{"description":"RTMP input settings","properties":{"address":{"title":"Address","type":"string","x-stream-index":"001"}},"required":["address"],"title":"RTMPIngress","type":"object"},"RTMPSettingsRequest":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"quality":{"description":"Resolution to set for the RTMP stream","enum":["360p","480p","720p","1080p","1440p","portrait-360x640","portrait-480x854","portrait-720x1280","portrait-1080x1920","portrait-1440x2560"],"title":"Quality","type":"string","x-stream-index":"002"}},"title":"RTMPSettingsRequest","type":"object"},"RTMPSettingsResponse":{"description":"RTMPSettingsResponse is the payload for RTMP settings","properties":{"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"001"},"quality":{"title":"Quality","type":"string","x-stream-index":"002"}},"required":["enabled","quality","layout"],"title":"RTMPSettingsResponse","type":"object"},"Reaction":{"nullable":true,"properties":{"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"message_id":{"type":"string","x-stream-index":"003"},"score":{"format":"int32","type":"integer","x-stream-index":"007"},"type":{"maxLength":30,"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["message_id","type","score","created_at","updated_at","custom"],"type":"object"},"ReactionGroupResponse":{"description":"ReactionGroupResponse contains all information about a reaction of the same type.","nullable":true,"properties":{"count":{"description":"Count is the number of reactions of this type.","format":"int32","title":"Count","type":"integer","x-stream-index":"001"},"first_reaction_at":{"description":"FirstReactionAt is the time of the first reaction of this type. This is the same also if all reaction of this type are deleted, because if someone will react again with the same type, will be preserved the sorting.","format":"date-time","title":"FirstReactionAt","type":"number","x-stream-index":"003"},"last_reaction_at":{"description":"LastReactionAt is the time of the last reaction of this type.","format":"date-time","title":"LastReactionAt","type":"number","x-stream-index":"004"},"sum_scores":{"description":"SumScores is the sum of all scores of reactions of this type. Medium allows you to clap articles more than once and shows the sum of all claps from all users. For example, you can send `clap` x5 using `score: 5`.","format":"int32","title":"SumScores","type":"integer","x-stream-index":"002"}},"required":["count","sum_scores","first_reaction_at","last_reaction_at"],"title":"ReactionGroupResponse","type":"object"},"ReactionResponse":{"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"006"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"008"},"message_id":{"description":"Message ID","title":"Message ID","type":"string","x-stream-index":"001"},"score":{"description":"Score of the reaction","format":"int32","title":"Score","type":"integer","x-stream-index":"005"},"type":{"description":"Type of reaction","title":"Type","type":"string","x-stream-index":"004"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"007"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User","title":"UserResponse","x-stream-index":"003"},"user_id":{"description":"User ID","title":"User ID","type":"string","x-stream-index":"002"}},"required":["message_id","user_id","user","type","score","created_at","updated_at","custom"],"type":"object"},"ReadReceipts":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"ReadReceiptsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"RecordSettingsRequest":{"properties":{"audio_only":{"type":"boolean","x-stream-index":"001"},"mode":{"enum":["available","disabled","auto-on"],"title":"Mode","type":"string","x-stream-index":"002"},"quality":{"enum":["360p","480p","720p","1080p","1440p","portrait-360x640","portrait-480x854","portrait-720x1280","portrait-1080x1920","portrait-1440x2560"],"type":"string","x-stream-index":"003"}},"required":["mode"],"title":"RecordSettingsRequest","type":"object"},"RecordSettingsResponse":{"description":"RecordSettings is the payload for recording settings","properties":{"audio_only":{"title":"Audio Only","type":"boolean","x-stream-index":"001"},"mode":{"title":"Mode","type":"string","x-stream-index":"002"},"quality":{"title":"Quality","type":"string","x-stream-index":"003"}},"required":["audio_only","mode","quality","layout"],"title":"RecordSettingsResponse","type":"object"},"RejectCallRequest":{"nullable":true,"properties":{"reason":{"description":"Reason for rejecting the call","title":"Reason","type":"string","x-stream-index":"003"}},"title":"RejectCallRequest","type":"object"},"RejectCallResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"RejectCallResponse","type":"object"},"ReminderResponseData":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003"},"channel_cid":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"005"},"message_id":{"type":"string","x-stream-index":"004"},"remind_at":{"format":"date-time","type":"number","x-stream-index":"001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007"},"user_id":{"type":"string","x-stream-index":"006"}},"required":["channel_cid","message_id","user_id","created_at","updated_at"],"type":"object"},"ReportByHistogramBucket":{"properties":{"category":{"type":"string","x-stream-index":"001"},"count":{"format":"int32","type":"integer","x-stream-index":"005"},"lower_bound":{"$ref":"#/components/schemas/Bound","x-stream-index":"002"},"sum":{"format":"float","type":"number","x-stream-index":"004"},"upper_bound":{"$ref":"#/components/schemas/Bound","x-stream-index":"003"}},"required":["category","sum","count"],"type":"object"},"ReportResponse":{"properties":{"call":{"$ref":"#/components/schemas/CallReportResponse","x-stream-index":"003"},"participants":{"$ref":"#/components/schemas/ParticipantReportResponse","x-stream-index":"001"},"user_ratings":{"$ref":"#/components/schemas/UserRatingReportResponse","x-stream-index":"002"}},"required":["participants","user_ratings","call"],"type":"object"},"RequestPermissionRequest":{"nullable":true,"properties":{"permissions":{"items":{"type":"string"},"title":"Permissions","type":"array","x-stream-index":"003"}},"required":["permissions"],"title":"RequestPermissionRequest","type":"object"},"RequestPermissionResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"RequestPermissionResponse","type":"object"},"Response":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001"}},"required":["duration"],"title":"Response","type":"object"},"RingSettingsRequest":{"properties":{"auto_cancel_timeout_ms":{"description":"When none of the callees accept a ring call in this time a rejection will be sent by the caller with reason 'timeout' by the SDKs","format":"int32","maximum":180000,"minimum":5000,"title":"AutoCancelTimeoutMs","type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"description":"When a callee is online but doesn't answer a ring call in this time a rejection will be sent with reason 'timeout' by the SDKs","format":"int32","maximum":180000,"minimum":5000,"title":"IncomingCallTimeoutMs","type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"description":"When a callee doesn't accept or reject a ring call in this time a missed call event will be sent","format":"int32","maximum":180000,"minimum":5000,"title":"MissedCallTimeoutMs","type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_timeout_ms"],"title":"RingSettingsRequest","type":"object"},"RingSettingsResponse":{"properties":{"auto_cancel_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_timeout_ms","missed_call_timeout_ms"],"type":"object"},"SDKUsageReport":{"properties":{"per_sdk_usage":{"additionalProperties":{"$ref":"#/components/schemas/PerSDKUsageReport"},"type":"object","x-stream-index":"001"}},"required":["per_sdk_usage"],"type":"object"},"SDKUsageReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateSDKUsageReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"SFUResponse":{"properties":{"edge_name":{"type":"string","x-stream-index":"001"},"url":{"type":"string","x-stream-index":"002"},"ws_endpoint":{"type":"string","x-stream-index":"003"}},"required":["edge_name","url","ws_endpoint"],"type":"object"},"ScreensharingSettingsRequest":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"type":"object"},"ScreensharingSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled"],"type":"object"},"SendCallEventRequest":{"description":"Send a call event to the other user","nullable":true,"properties":{"custom":{"additionalProperties":{},"title":"Custom","type":"object","x-stream-index":"004"}},"title":"SendCallEventRequest","type":"object"},"SendCallEventResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"SendCallEventResponse","type":"object"},"SendReactionRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.003"},"emoji_code":{"type":"string","x-stream-index":"003.002"},"type":{"maxLength":64,"type":"string","x-stream-index":"003.001"}},"required":["type"],"type":"object"},"SendReactionResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"reaction":{"$ref":"#/components/schemas/ReactionResponse","x-stream-index":"001"}},"required":["reaction","duration"],"title":"Response","type":"object"},"SessionSettingsRequest":{"properties":{"inactivity_timeout_seconds":{"format":"int32","maximum":900,"minimum":5,"type":"integer","x-stream-index":"001"}},"required":["inactivity_timeout_seconds"],"type":"object"},"SessionSettingsResponse":{"properties":{"inactivity_timeout_seconds":{"format":"int32","maximum":900,"minimum":5,"type":"integer","x-stream-index":"001"}},"required":["inactivity_timeout_seconds"],"type":"object"},"SharedLocation":{"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"013"},"channel_cid":{"type":"string","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"010"},"created_by_device_id":{"type":"string","x-stream-index":"008"},"end_at":{"format":"date-time","type":"number","x-stream-index":"009"},"latitude":{"format":"float","maximum":90,"minimum":18446744073709552000,"type":"number","x-stream-index":"006"},"longitude":{"format":"float","maximum":180,"minimum":18446744073709552000,"type":"number","x-stream-index":"007"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"012"},"message_id":{"type":"string","x-stream-index":"004"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"011"},"user_id":{"type":"string","x-stream-index":"005"}},"required":["channel_cid","message_id","user_id","created_by_device_id","created_at","updated_at"],"type":"object"},"SharedLocationResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001.011"},"channel_cid":{"description":"Channel CID","title":"string","type":"string","x-stream-index":"001.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.008"},"created_by_device_id":{"description":"Device ID that created the live location","title":"string","type":"string","x-stream-index":"001.006"},"duration":{"type":"string","x-stream-index":"002.001"},"end_at":{"description":"Time when the live location expires","format":"date-time","title":"string","type":"number","x-stream-index":"001.007"},"latitude":{"description":"Latitude coordinate","format":"float","title":"number","type":"number","x-stream-index":"001.004"},"longitude":{"description":"Longitude coordinate","format":"float","title":"number","type":"number","x-stream-index":"001.005"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001.010"},"message_id":{"description":"Message ID","title":"string","type":"string","x-stream-index":"001.002"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.009"},"user_id":{"description":"User ID","title":"string","type":"string","x-stream-index":"001.003"}},"required":["channel_cid","message_id","user_id","latitude","longitude","created_by_device_id","created_at","updated_at","duration"],"type":"object"},"SharedLocationResponseData":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"011"},"channel_cid":{"type":"string","x-stream-index":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"created_by_device_id":{"type":"string","x-stream-index":"006"},"end_at":{"format":"date-time","type":"number","x-stream-index":"007"},"latitude":{"format":"float","type":"number","x-stream-index":"004"},"longitude":{"format":"float","type":"number","x-stream-index":"005"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"010"},"message_id":{"type":"string","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["channel_cid","message_id","user_id","latitude","longitude","created_by_device_id","created_at","updated_at"],"type":"object"},"SharedLocationsResponse":{"nullable":true,"properties":{"active_live_locations":{"items":{"$ref":"#/components/schemas/SharedLocationResponseData"},"type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["active_live_locations","duration"],"type":"object"},"SortParamRequest":{"nullable":true,"properties":{"direction":{"description":"Direction of sorting, 1 for Ascending, -1 for Descending, default is 1","format":"int32","title":"Direction","type":"integer","x-stream-index":"002"},"field":{"description":"Name of field to sort by","title":"Field","type":"string","x-stream-index":"001"}},"type":"object"},"StartClosedCaptionsRequest":{"nullable":true,"properties":{"enable_transcription":{"description":"Enable transcriptions along with closed captions","title":"Enable Transcription","type":"boolean","x-stream-index":"002"},"external_storage":{"description":"Which external storage to use for transcriptions (only applicable if enable_transcription is true)","title":"External Storage","type":"string","x-stream-index":"003"},"language":{"description":"The spoken language in the call, if not provided the language defined in the transcription settings will be used","enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"title":"Language","type":"string","x-stream-index":"004"}},"type":"object"},"StartClosedCaptionsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"StartFrameRecordingRequest":{"nullable":true,"properties":{"recording_external_storage":{"type":"string","x-stream-index":"002"}},"title":"StartFrameRecordingRequest","type":"object"},"StartFrameRecordingResponse":{"description":"StartFrameRecordingResponse is the response payload for the start frame recording endpoint.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StartFrameRecordingResponse","type":"object"},"StartHLSBroadcastingRequest":{"description":"StartHLSBroadcastingRequest is the payload for starting an HLS broadcasting.","nullable":true,"title":"StartHLSBroadcastingRequest","type":"object"},"StartHLSBroadcastingResponse":{"description":"StartHLSBroadcastingResponse is the payload for starting an HLS broadcasting.","nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"},"playlist_url":{"description":"the URL of the HLS playlist","title":"PlaylistURL","type":"string","x-stream-index":"002"}},"required":["duration","playlist_url"],"title":"StartHLSBroadcastingResponse","type":"object"},"StartRTMPBroadcastsRequest":{"description":"StartRTMPBroadcastsRequest is the payload for starting RTMP broadcasts.","nullable":true,"properties":{"broadcasts":{"description":"List of broadcasts to start","items":{"$ref":"#/components/schemas/RTMPBroadcastRequest"},"maximum":1,"minimum":1,"title":"Broadcasts","type":"array","x-stream-index":"002"}},"required":["broadcasts"],"title":"StartRTMPBroadcastsRequest","type":"object"},"StartRTMPBroadcastsResponse":{"description":"StartRTMPBroadcastsResponse is the payload for starting an RTMP broadcast.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StartRTMPBroadcastsResponse","type":"object"},"StartRecordingRequest":{"nullable":true,"properties":{"recording_external_storage":{"type":"string","x-stream-index":"002"}},"title":"StartRecordingRequest","type":"object"},"StartRecordingResponse":{"description":"StartRecordingResponse is the response payload for the start recording endpoint.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StartRecordingResponse","type":"object"},"StartTranscriptionRequest":{"nullable":true,"properties":{"enable_closed_captions":{"description":"Enable closed captions along with transcriptions","title":"Enable Closed Captions","type":"boolean","x-stream-index":"003"},"language":{"description":"The spoken language in the call, if not provided the language defined in the transcription settings will be used","enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"title":"Language","type":"string","x-stream-index":"004"},"transcription_external_storage":{"description":"Store transcriptions in this external storage","title":"External Storage","type":"string","x-stream-index":"002"}},"type":"object"},"StartTranscriptionResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StartTranscriptionResponse","type":"object"},"StatsOptions":{"properties":{"enable_rtc_stats":{"type":"boolean","x-stream-index":"002"},"reporting_interval_ms":{"format":"int32","type":"integer","x-stream-index":"001"}},"required":["reporting_interval_ms","enable_rtc_stats"],"type":"object"},"StopAllRTMPBroadcastsRequest":{"nullable":true,"title":"StopAllRTMPBroadcastsRequest","type":"object"},"StopAllRTMPBroadcastsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StopAllRTMPBroadcastsResponse","type":"object"},"StopClosedCaptionsRequest":{"nullable":true,"properties":{"stop_transcription":{"type":"boolean","x-stream-index":"003"}},"type":"object"},"StopClosedCaptionsResponse":{"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"},"StopFrameRecordingRequest":{"nullable":true,"type":"object"},"StopFrameRecordingResponse":{"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"},"StopHLSBroadcastingRequest":{"nullable":true,"type":"object"},"StopHLSBroadcastingResponse":{"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"},"StopLiveRequest":{"nullable":true,"properties":{"continue_closed_caption":{"type":"boolean","x-stream-index":"006"},"continue_hls":{"type":"boolean","x-stream-index":"003"},"continue_recording":{"type":"boolean","x-stream-index":"004"},"continue_rtmp_broadcasts":{"type":"boolean","x-stream-index":"007"},"continue_transcription":{"type":"boolean","x-stream-index":"005"}},"title":"StopLiveRequest","type":"object"},"StopLiveResponse":{"nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"The call that was stopped","title":"Call","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["call","duration"],"title":"StopLiveResponse","type":"object"},"StopRTMPBroadcastsRequest":{"description":"Request for stopping RTMP broadcasts","nullable":true,"title":"StopRTMPBroadcastsRequest","type":"object"},"StopRTMPBroadcastsResponse":{"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"},"StopRecordingRequest":{"nullable":true,"type":"object"},"StopRecordingResponse":{"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"},"StopTranscriptionRequest":{"nullable":true,"properties":{"stop_closed_captions":{"type":"boolean","x-stream-index":"003"}},"type":"object"},"StopTranscriptionResponse":{"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"},"SubscriberStatsResponse":{"properties":{"total":{"format":"int32","type":"integer","x-stream-index":"001"},"total_subscribed_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"003"},"unique":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["total","unique","total_subscribed_duration_seconds"],"type":"object"},"TargetResolution":{"properties":{"bitrate":{"format":"int32","maximum":6000000,"type":"integer","x-stream-index":"003"},"height":{"format":"int32","maximum":3840,"minimum":240,"type":"integer","x-stream-index":"002"},"width":{"format":"int32","maximum":3840,"minimum":240,"type":"integer","x-stream-index":"001"}},"required":["width","height"],"type":"object"},"Thresholds":{"description":"Sets thresholds for AI moderation","properties":{"explicit":{"$ref":"#/components/schemas/LabelThresholds","description":"Thresholds for explicit messages","title":"LabelThresholds","x-stream-index":"001"},"spam":{"$ref":"#/components/schemas/LabelThresholds","description":"Thresholds for spam","title":"LabelThresholds","x-stream-index":"002"},"toxic":{"$ref":"#/components/schemas/LabelThresholds","description":"Thresholds for toxic messages","title":"LabelThresholds","x-stream-index":"003"}},"title":"Auto moderation thresholds","type":"object"},"ThumbnailResponse":{"properties":{"image_url":{"type":"string","x-stream-index":"001"}},"required":["image_url"],"type":"object"},"ThumbnailsSettingsRequest":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"ThumbnailsSettingsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"TrackStatsResponse":{"nullable":true,"properties":{"duration_seconds":{"format":"int32","type":"integer","x-stream-index":"002"},"track_type":{"type":"string","x-stream-index":"001"}},"required":["track_type","duration_seconds"],"type":"object"},"TranscriptionSettingsRequest":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"002"},"language":{"enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"type":"string","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode"],"type":"object"},"TranscriptionSettingsResponse":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"002"},"language":{"enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"type":"string","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode","closed_caption_mode","languages","language"],"type":"object"},"TypingIndicators":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"TypingIndicatorsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"UnblockUserRequest":{"description":"UnblockUserRequest is the payload for unblocking a user.","nullable":true,"properties":{"user_id":{"description":"the user to unblock","title":"UserID","type":"string","x-stream-index":"003"}},"required":["user_id"],"title":"UnblockUserRequest","type":"object"},"UnblockUserResponse":{"description":"UnblockUserResponse is the payload for unblocking a user.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"UnblockUserResponse","type":"object"},"UnblockUsersRequest":{"nullable":true,"properties":{"blocked_user_id":{"type":"string","x-stream-index":"001"}},"required":["blocked_user_id"],"type":"object"},"UnblockUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"UnblockedUserEvent":{"description":"This event is sent when a user is unblocked on a call,\nthis can be useful to notify the user that they can now join the call again","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.unblocked_user","description":"The type of event: \"call.unblocked_user\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user that was unblocked","title":"User","x-stream-index":"003"}},"required":["type","created_at","call_cid","user"],"title":"UnblockedUserEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"UnpinRequest":{"description":"UnpinRequest is the payload for unpinning a message.","nullable":true,"properties":{"session_id":{"description":"the session ID of the user who pinned the message","title":"SessionID","type":"string","x-stream-index":"003"},"user_id":{"description":"the user ID of the user who pinned the message","title":"UserID","type":"string","x-stream-index":"002"}},"required":["user_id","session_id"],"title":"UnpinRequest","type":"object"},"UnpinResponse":{"description":"UnpinResponse is the payload for unpinning a message.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"UnpinResponse","type":"object"},"UpdateBlockListRequest":{"nullable":true,"properties":{"team":{"type":"string","x-stream-index":"002"},"words":{"description":"List of words to block","items":{"type":"string"},"minimum":1,"title":"Words","type":"array","x-stream-index":"003"}},"title":"Update block list","type":"object","x-stream-docs-page-id":"update_block_list"},"UpdateBlockListResponse":{"description":"Basic response information","nullable":true,"properties":{"blocklist":{"$ref":"#/components/schemas/BlockListResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["duration"],"title":"Response","type":"object"},"UpdateCallMembersRequest":{"description":"Update call members","nullable":true,"properties":{"remove_members":{"description":"List of userID to remove","items":{"type":"string"},"maximum":100,"title":"Remove Members","type":"array","x-stream-index":"003"},"update_members":{"description":"List of members to update or insert","items":{"$ref":"#/components/schemas/MemberRequest"},"maximum":100,"title":"Update Members","type":"array","x-stream-index":"004"}},"title":"UpdateCallMembersRequest","type":"object"},"UpdateCallMembersResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"002"}},"required":["duration","members"],"title":"Response","type":"object"},"UpdateCallRequest":{"description":"Request for updating a call","nullable":true,"properties":{"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"003"},"settings_override":{"$ref":"#/components/schemas/CallSettingsRequest","description":"the settings to change for this call","title":"Settings Override","x-stream-index":"004"},"starts_at":{"description":"the time the call is scheduled to start","format":"date-time","title":"Starts At","type":"number","x-stream-index":"005"}},"title":"UpdateCallRequest","type":"object"},"UpdateCallResponse":{"description":"Response for updating a call","nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001.001"},"duration":{"type":"string","x-stream-index":"002.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001.002"},"membership":{"$ref":"#/components/schemas/MemberResponse","x-stream-index":"001.003"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"001.004"}},"required":["call","members","own_capabilities","blocked_users","duration"],"title":"UpdateCallResponse","type":"object"},"UpdateLiveLocationRequest":{"nullable":true,"properties":{"end_at":{"description":"Time when the live location expires","format":"date-time","title":"string","type":"number","x-stream-index":"004"},"latitude":{"description":"Latitude coordinate","format":"float","maximum":90,"minimum":18446744073709552000,"title":"number","type":"number","x-stream-index":"002"},"longitude":{"description":"Longitude coordinate","format":"float","maximum":180,"minimum":18446744073709552000,"title":"number","type":"number","x-stream-index":"003"},"message_id":{"description":"Live location ID","title":"string","type":"string","x-stream-index":"001"}},"required":["message_id"],"type":"object"},"UpdatePollOptionRequest":{"nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"004"},"id":{"description":"Option ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"},"text":{"description":"Option text","title":"string","type":"string","x-stream-index":"003"}},"required":["id","text"],"type":"object"},"UpdatePollPartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"description":"Sets new field values","title":"Set","type":"object","x-stream-index":"002.001","x-stream-map":{"key":"field","title":"Value","description":"New value to set"}},"unset":{"description":"Array of field names to unset","items":{"type":"string"},"title":"Unset","type":"array","x-stream-index":"002.002"}},"type":"object"},"UpdatePollRequest":{"nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"011"},"allow_answers":{"description":"Allow answers","title":"boolean","type":"boolean","x-stream-index":"009"},"allow_user_suggested_options":{"description":"Allow user suggested options","title":"boolean","type":"boolean","x-stream-index":"008"},"description":{"description":"Poll description","title":"string","type":"string","x-stream-index":"003"},"enforce_unique_vote":{"description":"Enforce unique vote","title":"boolean","type":"boolean","x-stream-index":"005"},"id":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"},"is_closed":{"description":"Is closed","title":"boolean","type":"boolean","x-stream-index":"010"},"max_votes_allowed":{"description":"Max votes allowed","format":"int32","maximum":10,"title":"integer","type":"integer","x-stream-index":"007"},"name":{"description":"Poll name","title":"string","type":"string","x-stream-index":"002"},"options":{"description":"Poll options","items":{"$ref":"#/components/schemas/PollOptionRequest"},"maximum":100,"title":"PollOptions","type":"array","x-stream-index":"004"},"voting_visibility":{"description":"Voting visibility","enum":["anonymous","public"],"title":"string","type":"string","x-stream-index":"006"}},"required":["id","name"],"type":"object"},"UpdateUserPartialRequest":{"properties":{"id":{"description":"User ID to update","title":"ID","type":"string","x-stream-index":"001"},"set":{"additionalProperties":{},"type":"object","x-stream-index":"002.001"},"unset":{"items":{"type":"string"},"type":"array","x-stream-index":"002.002"}},"required":["id"],"type":"object"},"UpdateUserPermissionsRequest":{"nullable":true,"properties":{"grant_permissions":{"items":{"type":"string"},"type":"array","x-stream-index":"002"},"revoke_permissions":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"user_id":{"type":"string","x-stream-index":"001"}},"required":["user_id"],"type":"object"},"UpdateUserPermissionsResponse":{"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"},"UpdateUsersPartialRequest":{"nullable":true,"properties":{"users":{"items":{"$ref":"#/components/schemas/UpdateUserPartialRequest"},"maximum":100,"type":"array","x-stream-index":"001"}},"required":["users"],"type":"object"},"UpdateUsersRequest":{"nullable":true,"properties":{"users":{"additionalProperties":{"$ref":"#/components/schemas/UserRequest"},"description":"Object containing users","title":"Users","type":"object","x-stream-index":"001","x-stream-map":{"key":"user_id"}}},"required":["users"],"type":"object"},"UpdateUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"membership_deletion_task_id":{"type":"string","x-stream-index":"002"},"users":{"additionalProperties":{"$ref":"#/components/schemas/FullUserResponse"},"description":"Object containing users","title":"Users","type":"object","x-stream-index":"001","x-stream-map":{"key":"user_id"}}},"required":["users","membership_deletion_task_id","duration"],"type":"object"},"UpdatedCallPermissionsEvent":{"description":"This event is sent to notify about permission changes for a user, clients receiving this event should update their UI accordingly","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"own_capabilities":{"description":"The capabilities of the current user","items":{"$ref":"#/components/schemas/OwnCapability"},"title":"Own capabilities","type":"array","x-stream-index":"004"},"type":{"default":"call.permissions_updated","description":"The type of event: \"call.permissions_updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who received the new permissions","title":"User","x-stream-index":"003"}},"required":["type","created_at","call_cid","user","own_capabilities"],"title":"UpdatedCallPermissionsEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"User":{"properties":{"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"046"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"017"},"banned":{"type":"boolean","x-stream-index":"016"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"013"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"023"},"language":{"type":"string","x-stream-index":"035"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"026"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"042"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"005"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"009"}},"required":["id","role","teams_role","custom","banned","online"],"type":"object"},"UserBannedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"006.002"},"channel_type":{"type":"string","x-stream-index":"006.003"},"cid":{"type":"string","x-stream-index":"006.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008.002"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"001"},"expiration":{"format":"date-time","type":"number","x-stream-index":"003"},"reason":{"type":"string","x-stream-index":"004"},"shadow":{"type":"boolean","x-stream-index":"002"},"team":{"type":"string","x-stream-index":"005.001"},"type":{"default":"user.banned","type":"string","x-stream-index":"008.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007.001"}},"required":["created_by","shadow","cid","channel_id","channel_type","type","created_at"],"title":"UserBannedEvent","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"},"UserDeactivatedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"001"},"type":{"default":"user.deactivated","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["created_by","type","created_at"],"title":"UserDeactivatedEvent","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"},"UserFeedbackReport":{"properties":{"count_by_rating":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001"},"unreported_count":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["count_by_rating","unreported_count"],"type":"object"},"UserFeedbackReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateUserFeedbackReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"UserMuteResponse":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"expires":{"format":"date-time","type":"number","x-stream-index":"003"},"target":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"}},"required":["created_at","updated_at"],"type":"object"},"UserMutedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"target_user":{"type":"string","x-stream-index":"001"},"target_users":{"items":{"type":"string"},"type":"array","x-stream-index":"002"},"type":{"default":"user.muted","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"UserMutedEvent","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"},"UserRatingReportResponse":{"properties":{"average":{"format":"float","type":"number","x-stream-index":"002"},"count":{"format":"int32","type":"integer","x-stream-index":"001"}},"required":["count","average"],"type":"object"},"UserReactivatedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"type":{"default":"user.reactivated","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"001"}},"required":["type","created_at"],"title":"UserReactivatedEvent","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"},"UserRequest":{"description":"User request object","properties":{"custom":{"additionalProperties":{},"description":"Custom user data","title":"Custom","type":"object","x-stream-index":"004"},"id":{"description":"User ID","title":"ID","type":"string","x-stream-index":"001"},"image":{"description":"User's profile image URL","title":"Image","type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"006"},"language":{"type":"string","x-stream-index":"005"},"name":{"description":"Optional name of user","title":"Name","type":"string","x-stream-index":"002"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"007"}},"required":["id"],"title":"UserRequest","type":"object"},"UserResponse":{"description":"User response object","properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"banned":{"description":"Whether a user is banned or not","title":"Banned","type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.017"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"001.004"},"deactivated_at":{"description":"Date of deactivation","format":"date-time","title":"Deactivated at","type":"number","x-stream-index":"001.016"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"001.011"},"id":{"description":"Unique user identifier","title":"ID","type":"string","x-stream-index":"001.001"},"image":{"title":"Image","type":"string","x-stream-index":"001.003"},"language":{"description":"Preferred language of a user","title":"Language","type":"string","x-stream-index":"001.005"},"last_active":{"description":"Date of last activity","format":"date-time","title":"Last active","type":"number","x-stream-index":"001.014"},"name":{"description":"Optional name of user","title":"Name","type":"string","x-stream-index":"001.002"},"online":{"description":"Whether a user online or not","title":"Online","type":"boolean","x-stream-index":"001.013"},"revoke_tokens_issued_before":{"description":"Revocation date for tokens","format":"date-time","title":"Revoke tokens issued before","type":"number","x-stream-index":"001.015"},"role":{"description":"Determines the set of user permissions","title":"Role","type":"string","x-stream-index":"001.006"},"teams":{"description":"List of teams user is a part of","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids","shadow_banned","invisible"],"title":"UserResponse","type":"object"},"UserResponsePrivacyFields":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"banned":{"type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.017"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.011"},"id":{"type":"string","x-stream-index":"001.001"},"image":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"003"},"language":{"type":"string","x-stream-index":"001.005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"001.014"},"name":{"type":"string","x-stream-index":"001.002"},"online":{"type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"002"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.015"},"role":{"type":"string","x-stream-index":"001.006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids"],"type":"object"},"UserUpdatedEvent":{"description":"This event is sent when a user gets updated. The event contains information about the updated user.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"type":{"default":"user.updated","description":"The type of event: \"user.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.002"},"user":{"$ref":"#/components/schemas/UserResponsePrivacyFields","description":"The updated user","title":"User","x-stream-index":"002.001"}},"required":["type","created_at","custom","user"],"title":"UserUpdatedEvent","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"},"VideoReactionOverTimeResponse":{"properties":{"by_minute":{"items":{"$ref":"#/components/schemas/CountByMinuteResponse"},"type":"array","x-stream-index":"001"}},"type":"object"},"VideoReactionsResponse":{"nullable":true,"properties":{"count_over_time":{"$ref":"#/components/schemas/VideoReactionOverTimeResponse","x-stream-index":"002"},"reaction":{"type":"string","x-stream-index":"001"}},"required":["reaction"],"type":"object"},"VideoSettingsRequest":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"camera_default_on":{"type":"boolean","x-stream-index":"004"},"camera_facing":{"enum":["front","back","external"],"type":"string","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"type":"object"},"VideoSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"camera_default_on":{"type":"boolean","x-stream-index":"004"},"camera_facing":{"enum":["front","back","external"],"type":"string","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled","target_resolution","camera_default_on","camera_facing"],"type":"object"},"WSAuthMessage":{"description":"Websocket auth message","nullable":true,"properties":{"products":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"token":{"title":"Token","type":"string","x-stream-index":"002"},"user_details":{"$ref":"#/components/schemas/ConnectUserDetailsRequest","x-stream-index":"001"}},"required":["user_details","token"],"title":"WSAuthMessage","type":"object"},"WSClientEvent":{"description":"The discriminator object for all websocket client events, it maps events' payload to the final type","discriminator":{"mapping":{"app.updated":"#/components/schemas/AppUpdatedEvent","health.check":"#/components/schemas/HealthCheckEvent","user.updated":"#/components/schemas/UserUpdatedEvent"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/AppUpdatedEvent"},{"$ref":"#/components/schemas/HealthCheckEvent"},{"$ref":"#/components/schemas/UserUpdatedEvent"}]},"WSEvent":{"description":"The discriminator object for all websocket events, it maps events' payload to the final type","discriminator":{"mapping":{"app.updated":"#/components/schemas/AppUpdatedEvent","call.accepted":"#/components/schemas/CallAcceptedEvent","call.blocked_user":"#/components/schemas/BlockedUserEvent","call.closed_caption":"#/components/schemas/ClosedCaptionEvent","call.closed_captions_failed":"#/components/schemas/CallClosedCaptionsFailedEvent","call.closed_captions_started":"#/components/schemas/CallClosedCaptionsStartedEvent","call.closed_captions_stopped":"#/components/schemas/CallClosedCaptionsStoppedEvent","call.created":"#/components/schemas/CallCreatedEvent","call.deleted":"#/components/schemas/CallDeletedEvent","call.ended":"#/components/schemas/CallEndedEvent","call.frame_recording_failed":"#/components/schemas/CallFrameRecordingFailedEvent","call.frame_recording_ready":"#/components/schemas/CallFrameRecordingFrameReadyEvent","call.frame_recording_started":"#/components/schemas/CallFrameRecordingStartedEvent","call.frame_recording_stopped":"#/components/schemas/CallFrameRecordingStoppedEvent","call.hls_broadcasting_failed":"#/components/schemas/CallHLSBroadcastingFailedEvent","call.hls_broadcasting_started":"#/components/schemas/CallHLSBroadcastingStartedEvent","call.hls_broadcasting_stopped":"#/components/schemas/CallHLSBroadcastingStoppedEvent","call.live_started":"#/components/schemas/CallLiveStartedEvent","call.member_added":"#/components/schemas/CallMemberAddedEvent","call.member_removed":"#/components/schemas/CallMemberRemovedEvent","call.member_updated":"#/components/schemas/CallMemberUpdatedEvent","call.member_updated_permission":"#/components/schemas/CallMemberUpdatedPermissionEvent","call.missed":"#/components/schemas/CallMissedEvent","call.moderation_blur":"#/components/schemas/CallModerationBlurEvent","call.moderation_warning":"#/components/schemas/CallModerationWarningEvent","call.notification":"#/components/schemas/CallNotificationEvent","call.permission_request":"#/components/schemas/PermissionRequestEvent","call.permissions_updated":"#/components/schemas/UpdatedCallPermissionsEvent","call.reaction_new":"#/components/schemas/CallReactionEvent","call.recording_failed":"#/components/schemas/CallRecordingFailedEvent","call.recording_ready":"#/components/schemas/CallRecordingReadyEvent","call.recording_started":"#/components/schemas/CallRecordingStartedEvent","call.recording_stopped":"#/components/schemas/CallRecordingStoppedEvent","call.rejected":"#/components/schemas/CallRejectedEvent","call.ring":"#/components/schemas/CallRingEvent","call.rtmp_broadcast_failed":"#/components/schemas/CallRtmpBroadcastFailedEvent","call.rtmp_broadcast_started":"#/components/schemas/CallRtmpBroadcastStartedEvent","call.rtmp_broadcast_stopped":"#/components/schemas/CallRtmpBroadcastStoppedEvent","call.session_ended":"#/components/schemas/CallSessionEndedEvent","call.session_participant_count_updated":"#/components/schemas/CallSessionParticipantCountsUpdatedEvent","call.session_participant_joined":"#/components/schemas/CallSessionParticipantJoinedEvent","call.session_participant_left":"#/components/schemas/CallSessionParticipantLeftEvent","call.session_started":"#/components/schemas/CallSessionStartedEvent","call.stats_report_ready":"#/components/schemas/CallStatsReportReadyEvent","call.transcription_failed":"#/components/schemas/CallTranscriptionFailedEvent","call.transcription_ready":"#/components/schemas/CallTranscriptionReadyEvent","call.transcription_started":"#/components/schemas/CallTranscriptionStartedEvent","call.transcription_stopped":"#/components/schemas/CallTranscriptionStoppedEvent","call.unblocked_user":"#/components/schemas/UnblockedUserEvent","call.updated":"#/components/schemas/CallUpdatedEvent","call.user_feedback_submitted":"#/components/schemas/CallUserFeedbackSubmittedEvent","call.user_muted":"#/components/schemas/CallUserMutedEvent","connection.error":"#/components/schemas/ConnectionErrorEvent","connection.ok":"#/components/schemas/ConnectedEvent","custom":"#/components/schemas/CustomVideoEvent","health.check":"#/components/schemas/HealthCheckEvent","user.banned":"#/components/schemas/UserBannedEvent","user.deactivated":"#/components/schemas/UserDeactivatedEvent","user.muted":"#/components/schemas/UserMutedEvent","user.reactivated":"#/components/schemas/UserReactivatedEvent","user.updated":"#/components/schemas/UserUpdatedEvent"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/AppUpdatedEvent"},{"$ref":"#/components/schemas/BlockedUserEvent"},{"$ref":"#/components/schemas/CallAcceptedEvent"},{"$ref":"#/components/schemas/CallClosedCaptionsFailedEvent"},{"$ref":"#/components/schemas/CallClosedCaptionsStartedEvent"},{"$ref":"#/components/schemas/CallClosedCaptionsStoppedEvent"},{"$ref":"#/components/schemas/CallCreatedEvent"},{"$ref":"#/components/schemas/CallDeletedEvent"},{"$ref":"#/components/schemas/CallEndedEvent"},{"$ref":"#/components/schemas/CallFrameRecordingFailedEvent"},{"$ref":"#/components/schemas/CallFrameRecordingFrameReadyEvent"},{"$ref":"#/components/schemas/CallFrameRecordingStartedEvent"},{"$ref":"#/components/schemas/CallFrameRecordingStoppedEvent"},{"$ref":"#/components/schemas/CallHLSBroadcastingFailedEvent"},{"$ref":"#/components/schemas/CallHLSBroadcastingStartedEvent"},{"$ref":"#/components/schemas/CallHLSBroadcastingStoppedEvent"},{"$ref":"#/components/schemas/CallLiveStartedEvent"},{"$ref":"#/components/schemas/CallMemberAddedEvent"},{"$ref":"#/components/schemas/CallMemberRemovedEvent"},{"$ref":"#/components/schemas/CallMemberUpdatedEvent"},{"$ref":"#/components/schemas/CallMemberUpdatedPermissionEvent"},{"$ref":"#/components/schemas/CallMissedEvent"},{"$ref":"#/components/schemas/CallModerationBlurEvent"},{"$ref":"#/components/schemas/CallModerationWarningEvent"},{"$ref":"#/components/schemas/CallNotificationEvent"},{"$ref":"#/components/schemas/CallReactionEvent"},{"$ref":"#/components/schemas/CallRecordingFailedEvent"},{"$ref":"#/components/schemas/CallRecordingReadyEvent"},{"$ref":"#/components/schemas/CallRecordingStartedEvent"},{"$ref":"#/components/schemas/CallRecordingStoppedEvent"},{"$ref":"#/components/schemas/CallRejectedEvent"},{"$ref":"#/components/schemas/CallRingEvent"},{"$ref":"#/components/schemas/CallRtmpBroadcastFailedEvent"},{"$ref":"#/components/schemas/CallRtmpBroadcastStartedEvent"},{"$ref":"#/components/schemas/CallRtmpBroadcastStoppedEvent"},{"$ref":"#/components/schemas/CallSessionEndedEvent"},{"$ref":"#/components/schemas/CallSessionParticipantCountsUpdatedEvent"},{"$ref":"#/components/schemas/CallSessionParticipantJoinedEvent"},{"$ref":"#/components/schemas/CallSessionParticipantLeftEvent"},{"$ref":"#/components/schemas/CallSessionStartedEvent"},{"$ref":"#/components/schemas/CallStatsReportReadyEvent"},{"$ref":"#/components/schemas/CallTranscriptionFailedEvent"},{"$ref":"#/components/schemas/CallTranscriptionReadyEvent"},{"$ref":"#/components/schemas/CallTranscriptionStartedEvent"},{"$ref":"#/components/schemas/CallTranscriptionStoppedEvent"},{"$ref":"#/components/schemas/CallUpdatedEvent"},{"$ref":"#/components/schemas/CallUserFeedbackSubmittedEvent"},{"$ref":"#/components/schemas/CallUserMutedEvent"},{"$ref":"#/components/schemas/ClosedCaptionEvent"},{"$ref":"#/components/schemas/ConnectedEvent"},{"$ref":"#/components/schemas/ConnectionErrorEvent"},{"$ref":"#/components/schemas/CustomVideoEvent"},{"$ref":"#/components/schemas/HealthCheckEvent"},{"$ref":"#/components/schemas/PermissionRequestEvent"},{"$ref":"#/components/schemas/UnblockedUserEvent"},{"$ref":"#/components/schemas/UpdatedCallPermissionsEvent"},{"$ref":"#/components/schemas/UserBannedEvent"},{"$ref":"#/components/schemas/UserDeactivatedEvent"},{"$ref":"#/components/schemas/UserMutedEvent"},{"$ref":"#/components/schemas/UserReactivatedEvent"},{"$ref":"#/components/schemas/UserUpdatedEvent"}]}},"securitySchemes":{"JWT":{"description":"JWT should be always provided when stream-auth-type=jwt.\n\nUsing JWT auth request could be authenticated as user or as server-side.\n\nWhen using user authentication permission checking is going to be applied to requests based on the user that is\nperforming a request.\n\nThe `authorization` header should be a JWT string signed using the secret attached to the API key used to perform\nrequests.\n\n**WARNING** all client-side official SDK do not ship with token generation; this is to make sure that the API secret is not\nshared with an untrusted party such as a browser or a iOS/Android application. Tokens **must** be generated server-side.\nIf you wish, you can configure your application to ignore authentication (see `disable_auth_check`)\nThe JWT string must include only the user_id claim and can include any built-in JWT claim such as iat, exp as well.\n","in":"header","name":"Authorization","type":"apiKey"},"api_key":{"description":"Application API key should be always set in order to authenticate the request.","in":"query","name":"api_key","type":"apiKey"},"stream-auth-type":{"description":"Stream-Auth-Type should be always set in order to authenticate the request. Possible\nvalues: `jwt` or `anonymous`.\n\n`jwt` allows you to authenticate as a user. With this auth type you should also provide valid JWT in Authorization\nheader.\n\n`anonymous` allows you to authenticate as anonymous user. Please note that most advanced features are not available\nto anonymous users.","in":"header","name":"Stream-Auth-Type","type":"apiKey"}}},"info":{"title":"Stream API","version":"v187.13.0"},"openapi":"3.0.3","paths":{"/api/v2/app":{"get":{"description":"This Method returns the application settings\n","operationId":"GetApp","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetApplicationResponse"}}},"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":"Get App Settings","tags":["product:common"]}},"/api/v2/blocklists":{"get":{"description":"Returns all available block lists\n","operationId":"ListBlockLists","parameters":[{"in":"query","name":"team","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListBlockListResponse"}}},"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":"List block lists","tags":["product:common"]},"post":{"description":"Creates a new application blocklist, once created the blocklist can be used by any channel type\n","operationId":"CreateBlockList","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBlockListRequest"}}},"description":"Block list","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBlockListResponse"}}},"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":"Create block list","tags":["product:common"]}},"/api/v2/blocklists/{name}":{"delete":{"description":"Deletes previously created application blocklist\n","operationId":"DeleteBlockList","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"team","schema":{"type":"string","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete block list","tags":["product:common"]},"put":{"description":"Updates contents of the block list\n","operationId":"UpdateBlockList","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Block list name","title":"Name","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBlockListRequest"}}},"description":"Update block list","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBlockListResponse"}}},"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":"Update block list","tags":["product:common"]}},"/api/v2/devices":{"delete":{"description":"Deletes one device\n","operationId":"DeleteDevice","parameters":[{"in":"query","name":"id","required":true,"schema":{"description":"Device ID to delete","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete device","tags":["product:common"]},"get":{"description":"Returns all available devices\n","operationId":"ListDevices","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDevicesResponse"}}},"description":"ListDevicesResponse"},"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":"List devices","tags":["product:common"]},"post":{"description":"Adds a new device to a user, if the same device already exists the call will have no effect\n","operationId":"CreateDevice","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDeviceRequest"}}},"description":"CreateDeviceRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Create device","tags":["product:common"]}},"/api/v2/guest":{"post":{"description":"\n","operationId":"CreateGuest","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGuestRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGuestResponse"}}},"description":"Successful 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":"Create Guest","tags":["product:common"]}},"/api/v2/longpoll":{"get":{"description":"WebSocket fallback transport endpoint\n\nSends events:\n- user.updated\n","operationId":"LongPoll","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WSAuthMessage","x-stream-index":"001"}}},"in":"query","name":"json"},{"in":"query","name":"connection_id","schema":{"maxLength":36,"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"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":"Long Poll (Transport)","tags":["product:common"]}},"/api/v2/og":{"get":{"description":"Get an OpenGraph attachment for a link\n","operationId":"GetOG","parameters":[{"in":"query","name":"url","required":true,"schema":{"description":"URL to be scraped","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOGResponse"}}},"description":"Get OG Attachment"},"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":"Get OG","tags":["product:common"]}},"/api/v2/polls":{"post":{"description":"Creates a new poll\n","operationId":"CreatePoll","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePollRequest"}}},"description":"Create Poll Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Create poll","tags":["product:common"]},"put":{"description":"Updates a poll\n\nSends events:\n- feeds.poll.closed\n- feeds.poll.updated\n- poll.closed\n- poll.updated\n","operationId":"UpdatePoll","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePollRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Update poll","tags":["product:common"]}},"/api/v2/polls/query":{"post":{"description":"Queries polls\n","operationId":"QueryPolls","parameters":[{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryPollsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryPollsResponse"}}},"description":"Successful 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":"Query polls","tags":["product:common"]}},"/api/v2/polls/{poll_id}":{"delete":{"description":"Deletes a poll\n\nSends events:\n- feeds.poll.deleted\n- poll.deleted\n","operationId":"DeletePoll","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete poll","tags":["product:common"]},"get":{"description":"Retrieves a poll\n","operationId":"GetPoll","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Get poll","tags":["product:common"]},"patch":{"description":"Updates a poll partially\n\nSends events:\n- feeds.poll.closed\n- feeds.poll.updated\n- poll.closed\n- poll.updated\n","operationId":"UpdatePollPartial","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePollPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Partial update poll","tags":["product:common"]}},"/api/v2/polls/{poll_id}/options":{"post":{"description":"Creates a poll option\n\nSends events:\n- feeds.poll.updated\n- poll.updated\n","operationId":"CreatePollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePollOptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollOptionResponse"}}},"description":"Successful 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":"Create poll option","tags":["product:common"]},"put":{"description":"Updates a poll option\n\nSends events:\n- feeds.poll.updated\n- poll.updated\n","operationId":"UpdatePollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePollOptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollOptionResponse"}}},"description":"Successful 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":"Update poll option","tags":["product:common"]}},"/api/v2/polls/{poll_id}/options/{option_id}":{"delete":{"description":"Deletes a poll option\n\nSends events:\n- feeds.poll.updated\n- poll.updated\n","operationId":"DeletePollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"path","name":"option_id","required":true,"schema":{"description":"Option ID","maxLength":255,"title":"string","type":"string","x-stream-index":"003"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete poll option","tags":["product:common"]},"get":{"description":"Retrieves a poll option\n","operationId":"GetPollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"path","name":"option_id","required":true,"schema":{"description":"Option ID","maxLength":255,"title":"string","type":"string","x-stream-index":"003"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollOptionResponse"}}},"description":"Successful 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":"Get poll option","tags":["product:common"]}},"/api/v2/polls/{poll_id}/votes":{"post":{"description":"Queries votes\n","operationId":"QueryPollVotes","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryPollVotesRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollVotesResponse"}}},"description":"Successful 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":"Query votes","tags":["product:common"]}},"/api/v2/uploads/file":{"delete":{"description":"Deletes previously uploaded file\n","operationId":"DeleteFileGlobal","parameters":[{"in":"query","name":"url","schema":{"description":"File URL to delete","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete file","tags":["product:common"],"x-stream-sdk-name":"DeleteFile"},"post":{"description":"Uploads file\n","operationId":"UploadFileGlobal","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/FileUploadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileUploadResponse"}}},"description":"Successful 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":"Upload file","tags":["product:common"],"x-stream-sdk-name":"UploadFile"}},"/api/v2/uploads/image":{"delete":{"description":"Deletes previously uploaded image\n","operationId":"DeleteImageGlobal","parameters":[{"in":"query","name":"url","schema":{"description":"File URL to delete","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete image","tags":["product:common"],"x-stream-sdk-name":"DeleteImage"},"post":{"description":"Uploads image\n","operationId":"UploadImageGlobal","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/ImageUploadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageUploadResponse"}}},"description":"Successful 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":"Upload image","tags":["product:common"],"x-stream-sdk-name":"UploadImage"}},"/api/v2/users":{"get":{"description":"Find and filter users\n","operationId":"QueryUsers","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryUsersPayload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryUsersResponse"}}},"description":"Successful 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":"Query users","tags":["product:common"]},"patch":{"description":"Updates certain fields of the user\n\nSends events:\n- user.presence.changed\n- user.updated\n- user.presence.changed\n","operationId":"UpdateUsersPartial","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersResponse"}}},"description":"Successful 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":"Partially update user","tags":["product:common"]},"post":{"description":"Update or create users in bulk\n\nSends events:\n- user.updated\n","operationId":"UpdateUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersResponse"}}},"description":"Successful 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":"Upsert users","tags":["product:common"]}},"/api/v2/users/block":{"get":{"description":"Get list of blocked Users\n","operationId":"GetBlockedUsers","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBlockedUsersResponse"}}},"description":"Successful 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":"Get list of blocked Users","tags":["product:common"]},"post":{"description":"Block users\n","operationId":"BlockUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUsersResponse"}}},"description":"Successful 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":"Block user","tags":["product:common"]}},"/api/v2/users/live_locations":{"get":{"description":"Retrieves all active live locations for a user\n","operationId":"GetUserLiveLocations","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SharedLocationsResponse"}}},"description":"Successful 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":"Get user live locations","tags":["product:common"]},"put":{"description":"Updates an existing live location with new coordinates or expiration time\n","operationId":"UpdateLiveLocation","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateLiveLocationRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SharedLocationResponse"}}},"description":"Successful 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":"Update live location","tags":["product:common"]}},"/api/v2/users/unblock":{"post":{"description":"Unblock users\n","operationId":"UnblockUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUsersResponse"}}},"description":"Successful 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":"Unblock user","tags":["product:common"]}},"/api/v2/video/call/members":{"post":{"description":"Query call members with filter query\n","operationId":"QueryCallMembers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallMembersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallMembersResponse"}}},"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":"Query call members","tags":["product:video"]}},"/api/v2/video/call/stats":{"post":{"description":"\n","operationId":"QueryCallStats","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallStatsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallStatsResponse"}}},"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":"Query Call Stats","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}":{"get":{"description":"\n","operationId":"GetCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"query","name":"connection_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"003"}},{"in":"query","name":"members_limit","schema":{"format":"int32","maximum":100,"minimum":0,"type":"integer","writeOnly":true,"x-stream-index":"004"}},{"in":"query","name":"ring","schema":{"type":"boolean","writeOnly":true,"x-stream-index":"005"}},{"in":"query","name":"notify","schema":{"type":"boolean","writeOnly":true,"x-stream-index":"006"}},{"in":"query","name":"video","schema":{"type":"boolean","writeOnly":true,"x-stream-index":"007"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCallResponse"}}},"description":"GetCallResponse"},"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":"Get Call","tags":["product:video"]},"patch":{"description":"\n\nSends events:\n- call.updated\n","operationId":"UpdateCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallRequest"}}},"description":"UpdateCallRequest","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallResponse"}}},"description":"UpdateCallResponse"},"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":"Update Call","tags":["product:video"]},"post":{"description":"Gets or creates a new call\n\nSends events:\n- call.created\n- call.notification\n- call.ring\n","operationId":"GetOrCreateCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"connection_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"008"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrCreateCallRequest"}}},"description":"GetOrCreateCallRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrCreateCallResponse"}}},"description":"GetOrCreateCallResponse"},"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":"Get or create a call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/accept":{"post":{"description":"\n\nSends events:\n- call.accepted\n","operationId":"AcceptCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcceptCallResponse"}}},"description":"AcceptCallResponse"},"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":"Accept Call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/block":{"post":{"description":"Block a user, preventing them from joining the call until they are unblocked.\n\nSends events:\n- call.blocked_user\n","operationId":"BlockUser","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUserRequest"}}},"description":"BlockUserRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUserResponse"}}},"description":"BlockUserResponse"},"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":"Block user on a call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/delete":{"post":{"description":"\n\nSends events:\n- call.deleted\n","operationId":"DeleteCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCallRequest"}}},"description":"DeleteCallRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCallResponse"}}},"description":"DeleteCallResponse"},"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":"Delete Call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/event":{"post":{"description":"Sends custom event to the call\n\nSends events:\n- custom\n","operationId":"SendCallEvent","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendCallEventRequest"}}},"description":"SendCallEventRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendCallEventResponse"}}},"description":"SendCallEventResponse"},"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":"Send custom event","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/feedback":{"post":{"description":"\n\nSends events:\n- call.user_feedback_submitted\n","operationId":"CollectUserFeedback","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectUserFeedbackRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectUserFeedbackResponse"}}},"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":"Collect user feedback","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/go_live":{"post":{"description":"\n\nSends events:\n- call.live_started\n","operationId":"GoLive","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoLiveRequest"}}},"description":"GoLiveRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoLiveResponse"}}},"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":"Set call as live","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/join":{"post":{"description":"Request to join a call\n","operationId":"JoinCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"query","name":"connection_id","schema":{"title":"ConnectionID","type":"string","writeOnly":true,"x-stream-index":"008"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JoinCallRequest"}}},"description":"JoinCallRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JoinCallResponse"}}},"description":"JoinCallResponse"},"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":"Join call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/mark_ended":{"post":{"description":"\n\nSends events:\n- call.ended\n","operationId":"EndCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EndCallResponse"}}},"description":"EndCallResponse"},"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":"End call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/members":{"post":{"description":"\n\nSends events:\n- call.member_added\n- call.member_removed\n- call.member_updated\n","operationId":"UpdateCallMembers","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallMembersRequest"}}},"description":"UpdateCallMembersRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallMembersResponse"}}},"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":"Update Call Member","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/mute_users":{"post":{"description":"Mutes users in a call\n","operationId":"MuteUsers","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteUsersRequest"}}},"description":"MuteUsersRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteUsersResponse"}}},"description":"MuteUsersResponse"},"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":"Mute users","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/participants":{"post":{"description":"Returns a list of participants connected to the call\n","operationId":"QueryCallParticipants","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"type","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"limit","schema":{"format":"int32","maximum":100,"type":"integer","x-stream-index":"004"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallParticipantsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallParticipantsResponse"}}},"description":"Successful 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":"Query call participants","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/pin":{"post":{"description":"Pins a track for all users in the call.\n","operationId":"VideoPin","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PinRequest"}}},"description":"PinRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PinResponse"}}},"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":"Pin","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/reaction":{"post":{"description":"Sends reaction to the call\n\nSends events:\n- call.reaction_new\n","operationId":"SendVideoReaction","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendReactionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendReactionResponse"}}},"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":"Send reaction to the call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/recordings":{"get":{"description":"Lists recordings\n","operationId":"ListRecordings","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListRecordingsResponse"}}},"description":"ListRecordingsResponse"},"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":"List recordings","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/reject":{"post":{"description":"\n\nSends events:\n- call.rejected\n","operationId":"RejectCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RejectCallRequest"}}},"description":"RejectCallRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RejectCallResponse"}}},"description":"RejectCallResponse"},"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":"Reject Call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/report":{"get":{"description":"\n","operationId":"GetCallReport","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"query","name":"session_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCallReportResponse"}}},"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":"Get call report","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/request_permission":{"post":{"description":"Request permission to perform an action\n\nSends events:\n- call.permission_request\n","operationId":"RequestPermission","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestPermissionRequest"}}},"description":"RequestPermissionRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestPermissionResponse"}}},"description":"RequestPermissionResponse"},"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":"Request permission","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/rtmp_broadcasts":{"post":{"description":"Starts RTMP broadcasts for the provided RTMP destinations\n","operationId":"StartRTMPBroadcasts","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRTMPBroadcastsRequest"}}},"description":"StartRTMPBroadcastsRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRTMPBroadcastsResponse"}}},"description":"StartRTMPBroadcastsResponse"},"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":"Start RTMP broadcasts","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/rtmp_broadcasts/stop":{"post":{"description":"Stop all RTMP broadcasts for the provided call\n","operationId":"StopAllRTMPBroadcasts","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopAllRTMPBroadcastsResponse"}}},"description":"StopAllRTMPBroadcastsResponse"},"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":"Stop all RTMP broadcasts for a call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/rtmp_broadcasts/{name}/stop":{"post":{"description":"Stop RTMP broadcasts for the provided RTMP destinations\n","operationId":"StopRTMPBroadcast","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopRTMPBroadcastsRequest"}}},"description":"StopRTMPBroadcastsRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopRTMPBroadcastsResponse"}}},"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":"Stop RTMP broadcasts","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/start_broadcasting":{"post":{"description":"Starts HLS broadcasting\n","operationId":"StartHLSBroadcasting","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartHLSBroadcastingResponse"}}},"description":"StartHLSBroadcastingResponse"},"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":"Start HLS broadcasting","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/start_closed_captions":{"post":{"description":"Starts closed captions\n","operationId":"StartClosedCaptions","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartClosedCaptionsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartClosedCaptionsResponse"}}},"description":"Successful 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":"Start closed captions","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/start_frame_recording":{"post":{"description":"Starts frame by frame recording\n\nSends events:\n- call.frame_recording_started\n","operationId":"StartFrameRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartFrameRecordingRequest"}}},"description":"StartFrameRecordingRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartFrameRecordingResponse"}}},"description":"StartFrameRecordingResponse"},"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":"Start frame recording","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/start_recording":{"post":{"description":"Starts recording\n\nSends events:\n- call.recording_started\n","operationId":"StartRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRecordingRequest"}}},"description":"StartRecordingRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRecordingResponse"}}},"description":"StartRecordingResponse"},"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":"Start recording","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/start_transcription":{"post":{"description":"Starts transcription\n","operationId":"StartTranscription","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartTranscriptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartTranscriptionResponse"}}},"description":"StartTranscriptionResponse"},"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":"Start transcription","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_broadcasting":{"post":{"description":"Stops HLS broadcasting\n","operationId":"StopHLSBroadcasting","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopHLSBroadcastingResponse"}}},"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":"Stop HLS broadcasting","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_closed_captions":{"post":{"description":"Stops closed captions\n\nSends events:\n- call.transcription_stopped\n","operationId":"StopClosedCaptions","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopClosedCaptionsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopClosedCaptionsResponse"}}},"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":"Stop closed captions","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_frame_recording":{"post":{"description":"Stops frame recording\n\nSends events:\n- call.frame_recording_stopped\n","operationId":"StopFrameRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopFrameRecordingResponse"}}},"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":"Stop frame recording","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_live":{"post":{"description":"\n\nSends events:\n- call.updated\n","operationId":"StopLive","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopLiveRequest"}}},"description":"StopLiveRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopLiveResponse"}}},"description":"StopLiveResponse"},"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":"Set call as not live","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_recording":{"post":{"description":"Stops recording\n\nSends events:\n- call.recording_stopped\n","operationId":"StopRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopRecordingResponse"}}},"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":"Stop recording","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_transcription":{"post":{"description":"Stops transcription\n\nSends events:\n- call.transcription_stopped\n","operationId":"StopTranscription","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopTranscriptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopTranscriptionResponse"}}},"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":"Stop transcription","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/transcriptions":{"get":{"description":"Lists transcriptions\n","operationId":"ListTranscriptions","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTranscriptionsResponse"}}},"description":"ListTranscriptionsResponse"},"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":"List transcriptions","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/unblock":{"post":{"description":"Removes the block for a user on a call. The user will be able to join the call again.\n\nSends events:\n- call.unblocked_user\n","operationId":"UnblockUser","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUserRequest"}}},"description":"UnblockUserRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUserResponse"}}},"description":"UnblockUserResponse"},"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":"Unblocks user on a call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/unpin":{"post":{"description":"Unpins a track for all users in the call.\n","operationId":"VideoUnpin","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnpinRequest"}}},"description":"UnpinRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnpinResponse"}}},"description":"UnpinResponse"},"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":"Unpin","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/user_permissions":{"post":{"description":"Updates user permissions\n\nSends events:\n- call.permissions_updated\n","operationId":"UpdateUserPermissions","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"005.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"005.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUserPermissionsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUserPermissionsResponse"}}},"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":"Update user permissions","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/{session}/recordings/{filename}":{"delete":{"description":"Deletes recording\n","operationId":"DeleteRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"path","name":"session","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"003"}},{"in":"path","name":"filename","required":true,"schema":{"maxLength":256,"type":"string","writeOnly":true,"x-stream-index":"004"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteRecordingResponse"}}},"description":"DeleteRecordingResponse"},"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":"Delete recording","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/{session}/transcriptions/{filename}":{"delete":{"description":"Deletes transcription\n","operationId":"DeleteTranscription","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"path","name":"session","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"003"}},{"in":"path","name":"filename","required":true,"schema":{"maxLength":256,"type":"string","writeOnly":true,"x-stream-index":"004"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteTranscriptionResponse"}}},"description":"DeleteTranscriptionResponse"},"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":"Delete transcription","tags":["product:video"]}},"/api/v2/video/calls":{"post":{"description":"Query calls with filter query\n","operationId":"QueryCalls","parameters":[{"in":"query","name":"connection_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallsRequest"}}},"description":"QueryCallsRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallsResponse"}}},"description":"QueryCallsResponse"},"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":"Query call","tags":["product:video"]}},"/api/v2/video/edges":{"get":{"description":"Returns the list of all edges available for video calls.\n","operationId":"GetEdges","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetEdgesResponse"}}},"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":"Get Edges","tags":["product:video"]}},"/api/v2/video/stats":{"post":{"description":"\n","operationId":"QueryAggregateCallStats","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryAggregateCallStatsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryAggregateCallStatsResponse"}}},"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":"Query Aggregate call Stats","tags":["product:video"]}}},"security":[{"JWT":[],"api_key":[],"stream-auth-type":[]},{"api_key":[],"stream-auth-type":[]}],"servers":[{"description":"Stream API","url":"https://chat.stream-io-api.com"}]} \ No newline at end of file +{"components":{"schemas":{"APIError":{"properties":{"StatusCode":{"description":"Response HTTP status code","format":"int32","title":"Status code","type":"integer","x-stream-index":"004"},"code":{"description":"API error code","format":"int32","title":"Code","type":"integer","x-stream-index":"001"},"details":{"description":"Additional error-specific information","items":{"type":"integer"},"title":"Details","type":"array","x-stream-index":"007"},"duration":{"description":"Request duration","title":"Duration","type":"string","x-stream-index":"005"},"exception_fields":{"additionalProperties":{"type":"string"},"description":"Additional error info","title":"Exception fields","type":"object","x-stream-index":"003"},"message":{"description":"Message describing an error","title":"Message","type":"string","x-stream-index":"002"},"more_info":{"description":"URL with additional information","title":"More info","type":"string","x-stream-index":"006"},"unrecoverable":{"description":"Flag that indicates if the error is unrecoverable, requests that return unrecoverable errors should not be retried, this error only applies to the request that caused it","title":"Unrecoverable","type":"boolean","x-stream-index":"008"}},"required":["code","message","StatusCode","duration","more_info","details"],"title":"Error response","type":"object"},"AcceptCallRequest":{"description":"AcceptCallRequest is the payload for accepting a call.","nullable":true,"title":"AcceptCallRequest","type":"object"},"AcceptCallResponse":{"description":"AcceptCallResponse is the payload for accepting a call.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"AcceptCallResponse","type":"object"},"Action":{"nullable":true,"properties":{"name":{"type":"string","x-stream-index":"001"},"style":{"type":"string","x-stream-index":"003"},"text":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"004"},"value":{"type":"string","x-stream-index":"005"}},"required":["name","text","type"],"type":"object"},"AppEventResponse":{"properties":{"async_url_enrich_enabled":{"description":"boolean","title":"Async URL Enrichment Enabled","type":"boolean","x-stream-index":"002"},"auto_translation_enabled":{"description":"boolean","title":"Auto Translation Enabled","type":"boolean","x-stream-index":"003"},"file_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","description":"file upload config","title":"File Upload Config","x-stream-index":"004"},"image_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","description":"file upload config","title":"Image Upload Config","x-stream-index":"005"},"name":{"description":"string","title":"App name","type":"string","x-stream-index":"001"}},"required":["name","auto_translation_enabled"],"type":"object"},"AppResponseFields":{"properties":{"async_url_enrich_enabled":{"type":"boolean","x-stream-index":"017"},"auto_translation_enabled":{"type":"boolean","x-stream-index":"020"},"file_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","x-stream-index":"030"},"image_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","x-stream-index":"031"},"name":{"type":"string","x-stream-index":"001"}},"required":["name","organization","push_notifications","webhook_url","moderation_webhook_url","channel_configs","call_types","policies","suspended","suspended_explanation","disable_auth_checks","disable_permissions_checks","permission_version","user_search_disallowed_roles","multi_tenant_enabled","image_moderation_enabled","async_url_enrich_enabled","auto_translation_enabled","custom_action_handler_url","enforce_unique_usernames","sqs_url","sqs_key","sqs_secret","sns_topic_arn","sns_key","sns_secret","file_upload_config","image_upload_config","grants","campaign_enabled","webhook_events","reminders_interval","cdn_expiration_seconds","video_provider","moderation_enabled","moderation_multitenant_blocklist_enabled","guest_user_creation_disabled","event_hooks","use_hook_v2","user_response_time_enabled","moderation_bulk_submit_action_enabled","moderation_llm_configurability_enabled"],"type":"object"},"AppUpdatedEvent":{"description":"Emitted when app settings are updated","nullable":true,"properties":{"app":{"$ref":"#/components/schemas/AppEventResponse","description":"application configuration","title":"App settings","x-stream-index":"002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"type":{"default":"app.updated","description":"The type of event: \"app.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.002"}},"required":["type","created_at","custom","app"],"title":"AppUpdatedEvent","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"},"Attachment":{"description":"An attachment is a message object that represents a file uploaded by a user.","nullable":true,"properties":{"actions":{"items":{"$ref":"#/components/schemas/Action"},"type":"array","x-stream-index":"015"},"asset_url":{"type":"string","x-stream-index":"017"},"author_icon":{"type":"string","x-stream-index":"007"},"author_link":{"type":"string","x-stream-index":"006"},"author_name":{"type":"string","x-stream-index":"005"},"color":{"type":"string","x-stream-index":"003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"018"},"fallback":{"type":"string","x-stream-index":"002"},"fields":{"items":{"$ref":"#/components/schemas/Field"},"type":"array","x-stream-index":"016"},"footer":{"type":"string","x-stream-index":"013"},"footer_icon":{"type":"string","x-stream-index":"014"},"giphy":{"$ref":"#/components/schemas/Images","x-stream-index":"019"},"image_url":{"type":"string","x-stream-index":"011"},"og_scrape_url":{"type":"string","x-stream-index":"020"},"original_height":{"format":"int32","type":"integer","x-stream-index":"022"},"original_width":{"format":"int32","type":"integer","x-stream-index":"021"},"pretext":{"type":"string","x-stream-index":"004"},"text":{"type":"string","x-stream-index":"010"},"thumb_url":{"type":"string","x-stream-index":"012"},"title":{"type":"string","x-stream-index":"008"},"title_link":{"type":"string","x-stream-index":"009"},"type":{"description":"Attachment type (e.g. image, video, url)","title":"Type","type":"string","x-stream-index":"001"}},"required":["custom"],"title":"Attachment","type":"object","x-stream-docs-page-id":"file_uploads"},"AudioSettingsRequest":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"001"},"default_device":{"enum":["speaker","earpiece"],"type":"string","x-stream-index":"006"},"mic_default_on":{"type":"boolean","x-stream-index":"004"},"noise_cancellation":{"$ref":"#/components/schemas/NoiseCancellationSettings","x-stream-index":"007"},"opus_dtx_enabled":{"type":"boolean","x-stream-index":"002"},"redundant_coding_enabled":{"type":"boolean","x-stream-index":"003"},"speaker_default_on":{"type":"boolean","x-stream-index":"005"}},"required":["default_device"],"type":"object"},"AudioSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"001"},"default_device":{"enum":["speaker","earpiece"],"type":"string","x-stream-index":"006"},"mic_default_on":{"type":"boolean","x-stream-index":"004"},"noise_cancellation":{"$ref":"#/components/schemas/NoiseCancellationSettings","x-stream-index":"007"},"opus_dtx_enabled":{"type":"boolean","x-stream-index":"002"},"redundant_coding_enabled":{"type":"boolean","x-stream-index":"003"},"speaker_default_on":{"type":"boolean","x-stream-index":"005"}},"required":["access_request_enabled","opus_dtx_enabled","redundant_coding_enabled","mic_default_on","speaker_default_on","default_device"],"type":"object"},"BackstageSettingsRequest":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"002"}},"type":"object"},"BackstageSettingsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"BlockListOptions":{"properties":{"behavior":{"description":"Blocklist behavior","enum":["flag","block","shadow_block"],"title":"Behavior","type":"string","x-stream-index":"002"},"blocklist":{"description":"Blocklist name","title":"Blocklist","type":"string","x-stream-index":"001"}},"required":["blocklist","behavior"],"type":"object"},"BlockListResponse":{"description":"Block list contains restricted words","properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001"},"id":{"type":"string","x-stream-index":"003"},"name":{"description":"Block list name","title":"Name","type":"string","x-stream-index":"004"},"team":{"type":"string","x-stream-index":"007"},"type":{"description":"Block list type.","title":"Type","type":"string","x-stream-index":"005"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"002"},"words":{"description":"List of words to block","items":{"type":"string"},"title":"Words","type":"array","x-stream-index":"006"}},"required":["name","type","words"],"title":"Block list","type":"object","x-stream-docs-page-id":"block_lists"},"BlockUserRequest":{"description":"BlockUserRequest is the payload for blocking a user.","nullable":true,"properties":{"user_id":{"description":"the user to block","title":"UserID","type":"string","x-stream-index":"003"}},"required":["user_id"],"title":"BlockUserRequest","type":"object"},"BlockUserResponse":{"description":"BlockUserResponse is the payload for blocking a user.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"BlockUserResponse","type":"object"},"BlockUsersRequest":{"nullable":true,"properties":{"blocked_user_id":{"description":"User id to block","title":"BlockedUserID","type":"string","x-stream-index":"001"}},"required":["blocked_user_id"],"type":"object"},"BlockUsersResponse":{"nullable":true,"properties":{"blocked_by_user_id":{"description":"User id who blocked another user","title":"BlockedByUserID","type":"string","x-stream-index":"002"},"blocked_user_id":{"description":"User id who got blocked","title":"BlockedUserID","type":"string","x-stream-index":"003"},"created_at":{"description":"Timestamp when the user was blocked","format":"date-time","title":"CreatedAt","type":"number","x-stream-index":"004"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration","blocked_by_user_id","blocked_user_id","created_at"],"type":"object"},"BlockedUserEvent":{"description":"This event is sent to call participants to notify when a user is blocked on a call, clients can use this event to show a notification.\nIf the user is the current user, the client should leave the call screen as well","properties":{"blocked_by_user":{"$ref":"#/components/schemas/UserResponse","description":"The user that blocked the user, null if the user was blocked by server-side","title":"Blocked by","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.blocked_user","description":"The type of event: \"call.blocked_user\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user that was blocked","title":"User","x-stream-index":"003"}},"required":["type","created_at","call_cid","user"],"title":"BlockedUserEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"BlockedUserResponse":{"nullable":true,"properties":{"blocked_user":{"$ref":"#/components/schemas/UserResponse","description":"User who got blocked","title":"User","x-stream-index":"003"},"blocked_user_id":{"description":"ID of the user who got blocked","title":"UserID","type":"string","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who blocked another user","title":"User","x-stream-index":"001"},"user_id":{"description":"ID of the user who blocked another user","title":"UserID","type":"string","x-stream-index":"002"}},"required":["user","user_id","blocked_user","blocked_user_id","created_at"],"type":"object"},"Bound":{"properties":{"inclusive":{"type":"boolean","x-stream-index":"002"},"value":{"format":"float","type":"number","x-stream-index":"001"}},"required":["value","inclusive"],"type":"object"},"BroadcastSettingsRequest":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettingsRequest","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettingsRequest","x-stream-index":"003"}},"type":"object"},"BroadcastSettingsResponse":{"description":"BroadcastSettingsResponse is the payload for broadcasting settings","properties":{"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettingsResponse","title":"HLS","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettingsResponse","title":"RTMP","x-stream-index":"003"}},"required":["enabled","hls","rtmp"],"title":"BroadcastSettingsResponse","type":"object"},"CallAcceptedEvent":{"description":"This event is sent when a user accepts a notification to join a call.","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.accepted","description":"The type of event: \"call.accepted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who accepted the call","title":"User","x-stream-index":"004"}},"required":["type","created_at","call_cid","call","user"],"title":"CallAcceptedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallClosedCaption":{"description":"CallClosedCaption represents a closed caption of a call.","properties":{"end_time":{"format":"date-time","title":"The end time of the closed caption.","type":"number","x-stream-index":"003"},"speaker_id":{"title":"The speaker ID of the closed caption.","type":"string","x-stream-index":"004"},"start_time":{"format":"date-time","title":"The start time of the closed caption.","type":"number","x-stream-index":"002"},"text":{"title":"The text of the closed caption.","type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserResponse","title":"The full user for the closed caption.","x-stream-index":"005"}},"required":["text","start_time","end_time","speaker_id","user"],"title":"CallClosedCaption","type":"object"},"CallClosedCaptionsFailedEvent":{"description":"This event is sent when call closed captions has failed","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.closed_captions_failed","description":"The type of event: \"call.closed_captions_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallClosedCaptionsFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallClosedCaptionsStartedEvent":{"description":"This event is sent when call closed caption has started","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.closed_captions_started","description":"The type of event: \"call.closed_captions_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallClosedCaptionsStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallClosedCaptionsStoppedEvent":{"description":"This event is sent when call closed captions has stopped","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.closed_captions_stopped","description":"The type of event: \"call.transcription_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallClosedCaptionsStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallCreatedEvent":{"description":"This event is sent when a call is created. Clients receiving this event should check if the ringing\nfield is set to true and if so, show the call screen","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"the members added to this call","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"004"},"type":{"default":"call.created","description":"The type of event: \"call.created\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","members"],"title":"CallCreatedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallDeletedEvent":{"description":"This event is sent when a call is deleted. Clients receiving this event should leave the call screen","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.deleted","description":"The type of event: \"call.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call"],"title":"CallDeletedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallDurationReport":{"properties":{"histogram":{"items":{"$ref":"#/components/schemas/ReportByHistogramBucket"},"type":"array","x-stream-index":"001"}},"required":["histogram"],"type":"object"},"CallDurationReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateCallDurationReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"CallEndedEvent":{"description":"This event is sent when a call is mark as ended for all its participants. Clients receiving this event should leave the call screen","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"reason":{"description":"The reason why the call ended, if available","title":"CallEndedReason","type":"string","x-stream-index":"005"},"type":{"default":"call.ended","description":"The type of event: \"call.ended\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who ended the call, null if the call was ended by the server","title":"User","x-stream-index":"004"}},"required":["type","created_at","call_cid","call"],"title":"CallEndedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallFrameRecordingFailedEvent":{"description":"This event is sent when frame recording has failed","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.frame_recording_failed","description":"The type of event: \"call.frame_recording_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","egress_id"],"title":"CallFrameRecordingFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallFrameRecordingFrameReadyEvent":{"description":"This event is sent when a frame is captured from a call","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"captured_at":{"description":"The time the frame was captured","format":"date-time","title":"CapturedAt","type":"number","x-stream-index":"006"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"008"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"track_type":{"description":"The type of the track frame was captured from (TRACK_TYPE_VIDEO|TRACK_TYPE_SCREEN_SHARE)","title":"TrackType","type":"string","x-stream-index":"004"},"type":{"default":"call.frame_recording_ready","description":"The type of event: \"call.frame_recording_ready\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"url":{"description":"The URL of the frame","title":"URL","type":"string","x-stream-index":"005"},"users":{"additionalProperties":{"$ref":"#/components/schemas/UserResponse"},"description":"The users in the frame","title":"Users","type":"object","x-stream-index":"007"}},"required":["type","created_at","call_cid","session_id","track_type","url","captured_at","users","egress_id"],"title":"CallFrameRecordingFrameReadyEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallFrameRecordingStartedEvent":{"description":"This event is sent when frame recording has started","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.frame_recording_started","description":"The type of event: \"call.frame_recording_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","egress_id"],"title":"CallFrameRecordingStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallFrameRecordingStoppedEvent":{"description":"This event is sent when frame recording has stopped","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.frame_recording_stopped","description":"The type of event: \"call.frame_recording_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","egress_id"],"title":"CallFrameRecordingStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallHLSBroadcastingFailedEvent":{"description":"This event is sent when HLS broadcasting has failed","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.hls_broadcasting_failed","description":"The type of event: \"call.hls_broadcasting_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallHLSBroadcastingFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallHLSBroadcastingStartedEvent":{"description":"This event is sent when HLS broadcasting has started","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"hls_playlist_url":{"type":"string","x-stream-index":"004"},"type":{"default":"call.hls_broadcasting_started","description":"The type of event: \"call.hls_broadcasting_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","hls_playlist_url"],"title":"CallHLSBroadcastingStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallHLSBroadcastingStoppedEvent":{"description":"This event is sent when HLS broadcasting has stopped","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.hls_broadcasting_stopped","description":"The type of event: \"call.hls_broadcasting_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallHLSBroadcastingStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallIngressResponse":{"description":"CallIngressResponse is the payload for ingress settings","properties":{"rtmp":{"$ref":"#/components/schemas/RTMPIngress","title":"RTMP","x-stream-index":"001"}},"required":["rtmp"],"title":"CallIngressResponse","type":"object"},"CallLiveStartedEvent":{"description":"This event is sent when a call is started. Clients receiving this event should start the call.","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.live_started","description":"The type of event: \"call.live_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call"],"title":"CallLiveStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMemberAddedEvent":{"description":"This event is sent when one or more members are added to a call","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"the members added to this call","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"004"},"type":{"default":"call.member_added","description":"The type of event: \"call.member_added\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","members"],"title":"CallMemberAddedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMemberRemovedEvent":{"description":"This event is sent when one or more members are removed from a call","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"the list of member IDs removed from the call","items":{"type":"string"},"title":"Members","type":"array","x-stream-index":"004"},"type":{"default":"call.member_removed","description":"The type of event: \"call.member_removed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","members"],"title":"CallMemberRemovedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMemberUpdatedEvent":{"description":"This event is sent when one or more members are updated","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"The list of members that were updated","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"004"},"type":{"default":"call.member_updated","description":"The type of event: \"call.member_updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","members"],"title":"CallMemberUpdatedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMemberUpdatedPermissionEvent":{"description":"This event is sent when one or more members get its role updated","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"capabilities_by_role":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"The capabilities by role for this call","title":"CapabilitiesByRole","type":"object","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"The list of members that were updated","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"005"},"type":{"default":"call.member_updated_permission","description":"The type of event: \"call.member_added\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","capabilities_by_role","members"],"title":"CallMemberUpdatedPermissionEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMissedEvent":{"description":"This event is sent to call members who did not accept/reject/join the call to notify they missed the call","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"List of members who missed the call","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"005"},"notify_user":{"type":"boolean","x-stream-index":"007"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.missed","description":"The type of event: \"call.notification\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The caller from whom the call was missed","title":"User","x-stream-index":"006"}},"required":["type","created_at","call_cid","session_id","call","members","user","notify_user"],"title":"CallMissedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallModerationBlurEvent":{"properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"type":{"default":"call.moderation_blur","type":"string","x-stream-index":"001.001"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["type","created_at","call_cid","user_id","custom"],"title":"CallModerationBlurEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallModerationWarningEvent":{"properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"message":{"type":"string","x-stream-index":"004"},"type":{"default":"call.moderation_warning","type":"string","x-stream-index":"001.001"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["type","created_at","call_cid","user_id","message","custom"],"title":"CallModerationWarningEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallNotificationEvent":{"description":"This event is sent to all call members to notify they are getting called","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"Call members","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"005"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.notification","description":"The type of event: \"call.notification\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user that sent the call notification","title":"User","x-stream-index":"006"}},"required":["type","created_at","call_cid","session_id","call","members","user"],"title":"CallNotificationEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallParticipantCountReport":{"properties":{"histogram":{"items":{"$ref":"#/components/schemas/ReportByHistogramBucket"},"type":"array","x-stream-index":"001"}},"required":["histogram"],"type":"object"},"CallParticipantCountReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateCallParticipantCountReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"CallParticipantResponse":{"properties":{"joined_at":{"format":"date-time","type":"number","x-stream-index":"004"},"role":{"type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"},"user_session_id":{"type":"string","x-stream-index":"002"}},"required":["user","user_session_id","role","joined_at"],"type":"object"},"CallReactionEvent":{"description":"This event is sent when a reaction is sent in a call, clients should use this to show the reaction in the call screen","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"reaction":{"$ref":"#/components/schemas/ReactionResponse","description":"the reaction object sent by the user on the call","title":"reaction","x-stream-index":"003"},"type":{"default":"call.reaction_new","description":"The type of event: \"call.reaction_new\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","reaction"],"title":"CallReactionEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRecording":{"description":"CallRecording represents a recording of a call.","properties":{"end_time":{"format":"date-time","title":"The end time of the recording.","type":"number","x-stream-index":"004"},"filename":{"title":"The filename of the recording.","type":"string","x-stream-index":"001"},"session_id":{"title":"The session ID of the recording.","type":"string","x-stream-index":"005"},"start_time":{"format":"date-time","title":"The start time of the recording.","type":"number","x-stream-index":"003"},"url":{"title":"The URL of the recording.","type":"string","x-stream-index":"002"}},"required":["filename","url","start_time","end_time","session_id"],"title":"CallRecording","type":"object"},"CallRecordingFailedEvent":{"description":"This event is sent when call recording has failed","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"003"},"type":{"default":"call.recording_failed","description":"The type of event: \"call.recording_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","egress_id"],"title":"CallRecordingFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRecordingReadyEvent":{"description":"This event is sent when call recording is ready","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"call_recording":{"$ref":"#/components/schemas/CallRecording","description":"The call recording object","title":"CallRecording","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.recording_ready","description":"The type of event: \"call.recording_ready\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call_recording","egress_id"],"title":"CallRecordingReadyEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRecordingStartedEvent":{"description":"This event is sent when call recording has started","properties":{"call_cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"egress_id":{"type":"string","x-stream-index":"001"},"type":{"default":"call.recording_started","description":"The type of event: \"call.recording_started\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001"}},"required":["egress_id","type","created_at","call_cid"],"title":"CallRecordingStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRecordingStoppedEvent":{"description":"This event is sent when call recording has stopped","properties":{"call_cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"egress_id":{"type":"string","x-stream-index":"001"},"type":{"default":"call.recording_stopped","description":"The type of event: \"call.recording_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001"}},"required":["egress_id","type","created_at","call_cid"],"title":"CallRecordingStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRejectedEvent":{"description":"This event is sent when a user rejects a notification to join a call.","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"reason":{"description":"Provides information about why the call was rejected. You can provide any value, but the Stream API and SDKs use these default values: rejected, cancel, timeout and busy","title":"Reason","type":"string","x-stream-index":"005"},"type":{"default":"call.rejected","description":"The type of event: \"call.rejected\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who rejected the call","title":"User","x-stream-index":"004"}},"required":["type","created_at","call_cid","call","user"],"title":"CallRejectedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallReportResponse":{"properties":{"ended_at":{"format":"date-time","type":"number","x-stream-index":"003"},"score":{"format":"float","type":"number","x-stream-index":"001"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002"}},"required":["score"],"type":"object"},"CallRequest":{"description":"CallRequest is the payload for creating a call.","properties":{"channel_cid":{"type":"string","x-stream-index":"009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"members":{"items":{"$ref":"#/components/schemas/MemberRequest"},"maximum":100,"type":"array","x-stream-index":"005"},"settings_override":{"$ref":"#/components/schemas/CallSettingsRequest","x-stream-index":"006"},"starts_at":{"format":"date-time","type":"number","x-stream-index":"007"},"team":{"type":"string","x-stream-index":"001"},"video":{"type":"boolean","x-stream-index":"008"}},"title":"CallRequest","type":"object"},"CallResponse":{"description":"Represents a call","properties":{"backstage":{"type":"boolean","x-stream-index":"016"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"018"},"captioning":{"type":"boolean","x-stream-index":"013"},"channel_cid":{"type":"string","x-stream-index":"024"},"cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"The user that created the call","title":"Created By","x-stream-index":"007"},"current_session_id":{"type":"string","x-stream-index":"005"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"008"},"egress":{"$ref":"#/components/schemas/EgressResponse","x-stream-index":"021"},"ended_at":{"description":"Date/time when the call ended","format":"date-time","title":"Ended At","type":"number","x-stream-index":"014"},"id":{"description":"Call ID","title":"ID","type":"string","x-stream-index":"003"},"ingress":{"$ref":"#/components/schemas/CallIngressResponse","x-stream-index":"019"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"023"},"recording":{"type":"boolean","x-stream-index":"011"},"session":{"$ref":"#/components/schemas/CallSessionResponse","x-stream-index":"020"},"settings":{"$ref":"#/components/schemas/CallSettingsResponse","x-stream-index":"017"},"starts_at":{"description":"Date/time when the call will start","format":"date-time","title":"Starts At","type":"number","x-stream-index":"015"},"team":{"type":"string","x-stream-index":"006"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailResponse","x-stream-index":"022"},"transcribing":{"type":"boolean","x-stream-index":"012"},"type":{"description":"The type of call","title":"Type","type":"string","x-stream-index":"002"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"}},"required":["type","id","cid","current_session_id","created_by","custom","created_at","updated_at","recording","transcribing","captioning","backstage","settings","blocked_user_ids","ingress","egress"],"title":"CallResponse","type":"object"},"CallRingEvent":{"description":"This event is sent to all call members to notify they are getting called","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"005"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"Call members","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"006"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.ring","description":"The type of event: \"call.notification\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user that sent the call notification","title":"User","x-stream-index":"007"},"video":{"type":"boolean","x-stream-index":"008"}},"required":["type","created_at","call_cid","session_id","call","members","user","video"],"title":"CallRingEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRtmpBroadcastFailedEvent":{"description":"This event is sent when a call RTMP broadcast has failed","properties":{"call_cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"002.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.002"},"name":{"description":"Name of the given RTMP broadcast","title":"Name","type":"string","x-stream-index":"003"},"type":{"default":"call.rtmp_broadcast_failed","description":"The type of event: \"call.rtmp_broadcast_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","name"],"title":"CallRtmpBroadcastFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRtmpBroadcastStartedEvent":{"description":"This event is sent when RTMP broadcast has started","properties":{"call_cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"002.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.002"},"name":{"description":"Name of the given RTMP broadcast","title":"Name","type":"string","x-stream-index":"003"},"type":{"default":"call.rtmp_broadcast_started","description":"The type of event: \"call.rtmp_broadcast_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","name"],"title":"CallRtmpBroadcastStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRtmpBroadcastStoppedEvent":{"description":"This event is sent when RTMP broadcast has stopped","properties":{"call_cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"002.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.002"},"name":{"description":"Name of the given RTMP broadcast","title":"Name","type":"string","x-stream-index":"003"},"type":{"default":"call.rtmp_broadcast_stopped","description":"The type of event: \"call.rtmp_broadcast_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","name"],"title":"CallRtmpBroadcastStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSessionEndedEvent":{"description":"This event is sent when a call session ends","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_ended","description":"The type of event: \"call.session_ended\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","call"],"title":"CallSessionEndedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSessionParticipantCountsUpdatedEvent":{"description":"This event is sent when the participant counts in a call session are updated","properties":{"anonymous_participant_count":{"format":"int32","type":"integer","x-stream-index":"005"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"participants_count_by_role":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"004"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_participant_count_updated","description":"The type of event: \"call.session_participant_count_updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","participants_count_by_role","anonymous_participant_count"],"title":"CallSessionParticipantCountsUpdatedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSessionParticipantJoinedEvent":{"description":"This event is sent when a participant joins a call session","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"participant":{"$ref":"#/components/schemas/CallParticipantResponse","description":"The participant that joined the session","title":"Participant","x-stream-index":"004"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_participant_joined","description":"The type of event: \"call.session_participant_joined\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","participant"],"title":"CallSessionParticipantJoinedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSessionParticipantLeftEvent":{"description":"This event is sent when a participant leaves a call session","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"duration_seconds":{"description":"The duration participant was in the session in seconds","format":"int32","title":"Duration","type":"integer","x-stream-index":"005"},"participant":{"$ref":"#/components/schemas/CallParticipantResponse","description":"The participant that left the session","title":"Participant","x-stream-index":"004"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_participant_left","description":"The type of event: \"call.session_participant_left\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","participant","duration_seconds"],"title":"CallSessionParticipantLeftEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSessionResponse":{"properties":{"accepted_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"008"},"anonymous_participant_count":{"format":"int32","type":"integer","x-stream-index":"006"},"ended_at":{"format":"date-time","type":"number","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"live_ended_at":{"format":"date-time","type":"number","x-stream-index":"011"},"live_started_at":{"format":"date-time","type":"number","x-stream-index":"010"},"missed_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"009"},"participants":{"items":{"$ref":"#/components/schemas/CallParticipantResponse"},"type":"array","x-stream-index":"004"},"participants_count_by_role":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"005"},"rejected_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"007"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002"},"timer_ends_at":{"format":"date-time","type":"number","x-stream-index":"012"}},"required":["id","participants","participants_count_by_role","anonymous_participant_count","rejected_by","accepted_by","missed_by"],"type":"object"},"CallSessionStartedEvent":{"description":"This event is sent when a call session starts","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_started","description":"The type of event: \"call.session_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","call"],"title":"CallSessionStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSettingsRequest":{"properties":{"audio":{"$ref":"#/components/schemas/AudioSettingsRequest","x-stream-index":"001"},"backstage":{"$ref":"#/components/schemas/BackstageSettingsRequest","x-stream-index":"002"},"broadcasting":{"$ref":"#/components/schemas/BroadcastSettingsRequest","x-stream-index":"010"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordingSettingsRequest","x-stream-index":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettingsRequest","x-stream-index":"003"},"ingress":{"$ref":"#/components/schemas/IngressSettingsRequest","x-stream-index":"014"},"limits":{"$ref":"#/components/schemas/LimitsSettingsRequest","x-stream-index":"012"},"recording":{"$ref":"#/components/schemas/RecordSettingsRequest","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettingsRequest","x-stream-index":"007"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettingsRequest","x-stream-index":"008"},"session":{"$ref":"#/components/schemas/SessionSettingsRequest","x-stream-index":"013"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettingsRequest","x-stream-index":"011"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettingsRequest","x-stream-index":"009"},"video":{"$ref":"#/components/schemas/VideoSettingsRequest","x-stream-index":"004"}},"type":"object"},"CallSettingsResponse":{"properties":{"audio":{"$ref":"#/components/schemas/AudioSettingsResponse","x-stream-index":"001"},"backstage":{"$ref":"#/components/schemas/BackstageSettingsResponse","x-stream-index":"002"},"broadcasting":{"$ref":"#/components/schemas/BroadcastSettingsResponse","x-stream-index":"003"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordingSettingsResponse","x-stream-index":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettingsResponse","x-stream-index":"004"},"ingress":{"$ref":"#/components/schemas/IngressSettingsResponse","x-stream-index":"014"},"limits":{"$ref":"#/components/schemas/LimitsSettingsResponse","x-stream-index":"012"},"recording":{"$ref":"#/components/schemas/RecordSettingsResponse","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettingsResponse","x-stream-index":"007"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettingsResponse","x-stream-index":"008"},"session":{"$ref":"#/components/schemas/SessionSettingsResponse","x-stream-index":"013"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettingsResponse","x-stream-index":"011"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettingsResponse","x-stream-index":"009"},"video":{"$ref":"#/components/schemas/VideoSettingsResponse","x-stream-index":"010"}},"required":["audio","backstage","broadcasting","geofencing","recording","frame_recording","ring","screensharing","transcription","video","thumbnails","limits","session"],"type":"object"},"CallStateResponseFields":{"description":"CallStateResponseFields is the payload for call state response","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001"},"members":{"description":"List of call members","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"002"},"membership":{"$ref":"#/components/schemas/MemberResponse","description":"Current user membership object","title":"Membership","x-stream-index":"003"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"004"}},"required":["call","members","own_capabilities","blocked_users"],"title":"CallStateResponseFields","type":"object"},"CallStatsReportReadyEvent":{"description":"This event is sent when the insights report is ready","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.stats_report_ready","description":"The type of event, \"call.report_ready\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id"],"title":"CallStatsReportReadyEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallStatsReportSummaryResponse":{"properties":{"call_cid":{"type":"string","x-stream-index":"001"},"call_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"008"},"call_session_id":{"type":"string","x-stream-index":"002"},"call_status":{"type":"string","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"first_stats_time":{"format":"date-time","type":"number","x-stream-index":"003"},"min_user_rating":{"format":"int32","type":"integer","x-stream-index":"006"},"quality_score":{"format":"int32","type":"integer","x-stream-index":"005"}},"required":["call_cid","call_session_id","first_stats_time","call_status","call_duration_seconds"],"type":"object"},"CallTranscription":{"description":"CallTranscription represents a transcription of a call.","properties":{"end_time":{"format":"date-time","title":"The end time of the transcription.","type":"number","x-stream-index":"004"},"filename":{"title":"The filename of the transcription.","type":"string","x-stream-index":"001"},"session_id":{"title":"The session ID of the transcription.","type":"string","x-stream-index":"005"},"start_time":{"format":"date-time","title":"The start time of the transcription.","type":"number","x-stream-index":"003"},"url":{"title":"The URL of the transcription.","type":"string","x-stream-index":"002"}},"required":["filename","url","start_time","end_time","session_id"],"title":"CallTranscription","type":"object"},"CallTranscriptionFailedEvent":{"description":"This event is sent when call transcription has failed","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"003"},"error":{"description":"The error message detailing why transcription failed.","title":"string","type":"string","x-stream-index":"004"},"type":{"default":"call.transcription_failed","description":"The type of event: \"call.transcription_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","egress_id"],"title":"CallTranscriptionFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallTranscriptionReadyEvent":{"description":"This event is sent when call transcription is ready","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"call_transcription":{"$ref":"#/components/schemas/CallTranscription","description":"The call transcription object","title":"CallTranscription","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.transcription_ready","description":"The type of event: \"call.transcription_ready\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call_transcription","egress_id"],"title":"CallTranscriptionReadyEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallTranscriptionStartedEvent":{"description":"This event is sent when call transcription has started","properties":{"call_cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"egress_id":{"type":"string","x-stream-index":"001"},"type":{"default":"call.transcription_started","description":"The type of event: \"call.transcription_started\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001"}},"required":["egress_id","type","created_at","call_cid"],"title":"CallTranscriptionStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallTranscriptionStoppedEvent":{"description":"This event is sent when call transcription has stopped","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"003"},"type":{"default":"call.transcription_stopped","description":"The type of event: \"call.transcription_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","egress_id"],"title":"CallTranscriptionStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallUpdatedEvent":{"description":"This event is sent when a call is updated, clients should use this update the local state of the call.\nThis event also contains the capabilities by role for the call, clients should update the own_capability for the current.","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"capabilities_by_role":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"The capabilities by role for this call","title":"CapabilitiesByRole","type":"object","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.updated","description":"The type of event: \"call.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","capabilities_by_role"],"title":"CallUpdatedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallUserFeedbackSubmittedEvent":{"description":"This event is sent when a user submits feedback for a call.","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"custom":{"additionalProperties":{},"description":"Custom data provided by the user","title":"Custom","type":"object","x-stream-index":"007"},"rating":{"description":"The rating given by the user (1-5)","format":"int32","title":"Rating","type":"integer","x-stream-index":"005"},"reason":{"description":"The reason provided by the user for the rating","title":"Reason","type":"string","x-stream-index":"006"},"sdk":{"type":"string","x-stream-index":"008"},"sdk_version":{"type":"string","x-stream-index":"009"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.user_feedback_submitted","description":"The type of event, \"call.user_feedback\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who submitted the feedback","title":"User","x-stream-index":"004"}},"required":["type","created_at","call_cid","session_id","user","rating"],"title":"CallUserFeedbackSubmittedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallUserMutedEvent":{"description":"This event is sent when a call member is muted","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"from_user_id":{"type":"string","x-stream-index":"003"},"muted_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"type":{"default":"call.user_muted","description":"The type of event: \"call.user_muted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","from_user_id","muted_user_ids"],"title":"CallUserMutedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallsPerDayReport":{"properties":{"count":{"format":"int64","type":"integer","x-stream-index":"001"}},"required":["count"],"type":"object"},"CallsPerDayReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateCallsPerDayReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"Channel":{"properties":{"active_live_locations":{"items":{"$ref":"#/components/schemas/SharedLocation"},"type":"array","x-stream-index":"034"},"auto_translation_enabled":{"type":"boolean","x-stream-index":"029"},"auto_translation_language":{"type":"string","x-stream-index":"030"},"cid":{"type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/ChannelConfig","x-stream-index":"026"},"config_overrides":{"$ref":"#/components/schemas/ConfigOverrides","x-stream-index":"027"},"cooldown":{"format":"int32","type":"integer","x-stream-index":"031"},"created_at":{"format":"date-time","type":"number","x-stream-index":"009"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"019"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"disabled":{"type":"boolean","x-stream-index":"017"},"frozen":{"type":"boolean","x-stream-index":"016"},"id":{"type":"string","x-stream-index":"004"},"invites":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"022"},"last_campaigns":{"type":"string","x-stream-index":"032"},"last_message_at":{"format":"date-time","type":"number","x-stream-index":"006"},"member_count":{"format":"int32","type":"integer","x-stream-index":"021"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"020"},"message_count":{"format":"int64","type":"integer","x-stream-index":"035"},"message_count_updated_at":{"format":"date-time","type":"number","x-stream-index":"036"},"team":{"type":"string","x-stream-index":"028"},"truncated_by":{"$ref":"#/components/schemas/User","x-stream-index":"015"},"type":{"type":"string","x-stream-index":"005"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"010"}},"required":["cid","id","type","created_at","updated_at","frozen","disabled","custom","auto_translation_language"],"type":"object"},"ChannelConfig":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.027"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.022"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.023"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.028"},"blocklist":{"type":"string","x-stream-index":"001.024"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.025"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.026"},"commands":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"connect_events":{"type":"boolean","x-stream-index":"001.004"},"count_messages":{"type":"boolean","x-stream-index":"001.019"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"custom_events":{"type":"boolean","x-stream-index":"001.012"},"mark_messages_pending":{"type":"boolean","x-stream-index":"001.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"001.021"},"mutes":{"type":"boolean","x-stream-index":"001.009"},"name":{"type":"string","x-stream-index":"001.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"001.029"},"partition_ttl":{"type":"integer","x-stream-index":"001.030"},"polls":{"type":"boolean","x-stream-index":"001.016"},"push_notifications":{"type":"boolean","x-stream-index":"001.013"},"quotes":{"type":"boolean","x-stream-index":"001.008"},"reactions":{"type":"boolean","x-stream-index":"001.006"},"read_events":{"type":"boolean","x-stream-index":"001.003"},"reminders":{"type":"boolean","x-stream-index":"001.014"},"replies":{"type":"boolean","x-stream-index":"001.007"},"search":{"type":"boolean","x-stream-index":"001.005"},"shared_locations":{"type":"boolean","x-stream-index":"001.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.031"},"typing_events":{"type":"boolean","x-stream-index":"001.002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"002.004"},"uploads":{"type":"boolean","x-stream-index":"001.010"},"url_enrichment":{"type":"boolean","x-stream-index":"001.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"001.017"}},"required":["name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","count_messages","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","created_at","updated_at","commands"],"type":"object"},"ChannelConfigWithInfo":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.002.027"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.002.022"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.023"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.002.028"},"blocklist":{"type":"string","x-stream-index":"001.002.024"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.025"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.002.026"},"commands":{"items":{"$ref":"#/components/schemas/Command"},"type":"array","x-stream-index":"001.003"},"connect_events":{"type":"boolean","x-stream-index":"001.002.004"},"count_messages":{"type":"boolean","x-stream-index":"001.002.019"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.001.003"},"custom_events":{"type":"boolean","x-stream-index":"001.002.012"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"002"},"mark_messages_pending":{"type":"boolean","x-stream-index":"001.002.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"001.002.021"},"mutes":{"type":"boolean","x-stream-index":"001.002.009"},"name":{"type":"string","x-stream-index":"001.002.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"001.002.029"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"001.002.030"},"polls":{"type":"boolean","x-stream-index":"001.002.016"},"push_notifications":{"type":"boolean","x-stream-index":"001.002.013"},"quotes":{"type":"boolean","x-stream-index":"001.002.008"},"reactions":{"type":"boolean","x-stream-index":"001.002.006"},"read_events":{"type":"boolean","x-stream-index":"001.002.003"},"reminders":{"type":"boolean","x-stream-index":"001.002.014"},"replies":{"type":"boolean","x-stream-index":"001.002.007"},"search":{"type":"boolean","x-stream-index":"001.002.005"},"shared_locations":{"type":"boolean","x-stream-index":"001.002.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.002.031"},"typing_events":{"type":"boolean","x-stream-index":"001.002.002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"uploads":{"type":"boolean","x-stream-index":"001.002.010"},"url_enrichment":{"type":"boolean","x-stream-index":"001.002.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"001.002.017"}},"required":["created_at","updated_at","name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","count_messages","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","commands"],"type":"object"},"ChannelMember":{"nullable":true,"properties":{"archived_at":{"format":"date-time","type":"number","x-stream-index":"015"},"ban_expires":{"description":"Expiration date of the ban","format":"date-time","title":"Ban expires","type":"number","x-stream-index":"013"},"banned":{"description":"Whether member is banned this channel or not","title":"Banned","type":"boolean","x-stream-index":"012"},"channel_role":{"description":"Role of the member in the channel","title":"Channel Role","type":"string","x-stream-index":"018"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"deleted_messages":{"items":{"type":"string"},"type":"array","x-stream-index":"020"},"invite_accepted_at":{"description":"Date when invite was accepted","format":"date-time","title":"Invited accepted at","type":"number","x-stream-index":"006"},"invite_rejected_at":{"description":"Date when invite was rejected","format":"date-time","title":"Invited rejected at","type":"number","x-stream-index":"007"},"invited":{"description":"Whether member was invited or not","title":"Invited","type":"boolean","x-stream-index":"005"},"is_moderator":{"description":"Whether member is channel moderator or not","title":"Is moderator","type":"boolean","x-stream-index":"003"},"notifications_muted":{"type":"boolean","x-stream-index":"019"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"016"},"role":{"description":"Permission level of the member in the channel (DEPRECATED: use channel_role instead)","enum":["member","moderator","admin","owner"],"title":"Role","type":"string","x-stream-index":"017"},"shadow_banned":{"description":"Whether member is shadow banned in this channel or not","title":"Shadow banned","type":"boolean","x-stream-index":"014"},"status":{"type":"string","x-stream-index":"008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"},"user_id":{"title":"User ID","type":"string","x-stream-index":"001"}},"required":["custom","created_at","updated_at","banned","shadow_banned","channel_role","notifications_muted"],"title":"Channel member","type":"object"},"ChannelMute":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel that is muted","title":"Channel","x-stream-index":"002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"004"},"expires":{"description":"Date/time of mute expiration","format":"date-time","title":"Expires","type":"number","x-stream-index":"003"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Owner of channel mute","title":"User","x-stream-index":"001"}},"required":["created_at","updated_at"],"type":"object"},"ChannelOwnCapability":{"description":"All possibility of string to use","enum":["ban-channel-members","cast-poll-vote","connect-events","create-attachment","delete-any-message","delete-channel","delete-own-message","flag-message","freeze-channel","join-channel","leave-channel","mute-channel","pin-message","query-poll-votes","quote-message","read-events","search-messages","send-custom-events","send-links","send-message","send-poll","send-reaction","send-reply","send-restricted-visibility-message","send-typing-events","set-channel-cooldown","share-location","skip-slow-mode","slow-mode","typing-events","update-any-message","update-channel","update-channel-members","update-own-message","update-thread","upload-file"],"title":"ChannelOwnCapability","type":"string"},"ChannelResponse":{"description":"Represents channel in chat","properties":{"auto_translation_enabled":{"description":"Whether auto translation is enabled or not","title":"Auto translation","type":"boolean","x-stream-index":"017"},"auto_translation_language":{"description":"Language to translate to when auto translation is active","title":"Auto translation language","type":"string","x-stream-index":"018"},"blocked":{"description":"Whether this channel is blocked by current user or not","title":"Blocked","type":"boolean","x-stream-index":"023"},"cid":{"description":"Channel CID (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/ChannelConfigWithInfo","description":"Channel configuration","title":"ChannelConfigWithInfo","x-stream-index":"013"},"cooldown":{"description":"Cooldown period after sending each message","format":"int32","title":"Cooldown","type":"integer","x-stream-index":"020"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"005"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"Creator of the channel","title":"UserResponse","x-stream-index":"008"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"026"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"007"},"disabled":{"type":"boolean","x-stream-index":"010"},"frozen":{"description":"Whether channel is frozen or not","title":"Frozen","type":"boolean","x-stream-index":"009"},"hidden":{"description":"Whether this channel is hidden by current user or not","title":"Hidden","type":"boolean","x-stream-index":"022"},"hide_messages_before":{"description":"Date since when the message history is accessible","format":"date-time","title":"Hide messages before","type":"number","x-stream-index":"019"},"id":{"description":"Channel unique ID","title":"ID","type":"string","x-stream-index":"001"},"last_message_at":{"description":"Date of the last message sent","format":"date-time","title":"Last message at","type":"number","x-stream-index":"004"},"member_count":{"description":"Number of members in the channel","format":"int32","title":"Member count","type":"integer","x-stream-index":"012"},"members":{"description":"List of channel members (max 100)","items":{"$ref":"#/components/schemas/ChannelMember"},"title":"ChannelMembers","type":"array","x-stream-index":"011"},"message_count":{"description":"Number of messages in the channel","format":"int64","title":"Message count","type":"integer","x-stream-index":"027"},"mute_expires_at":{"description":"Date of mute expiration","format":"date-time","title":"Mute expires at","type":"number","x-stream-index":"015"},"muted":{"description":"Whether this channel is muted or not","title":"Muted","type":"boolean","x-stream-index":"014"},"own_capabilities":{"description":"List of channel capabilities of authenticated user","items":{"$ref":"#/components/schemas/ChannelOwnCapability"},"title":"ChannelOwnCapability","type":"array","x-stream-index":"021"},"team":{"description":"Team the channel belongs to (multi-tenant only)","title":"Team","type":"string","x-stream-index":"016"},"truncated_at":{"description":"Date of the latest truncation of the channel","format":"date-time","title":"UserResponse","type":"number","x-stream-index":"024"},"truncated_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"025"},"type":{"description":"Type of the channel","title":"Type","type":"string","x-stream-docs-page-id":"channel_features","x-stream-index":"002"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"006"}},"required":["id","type","cid","created_at","updated_at","frozen","disabled","custom"],"title":"Channel","type":"object"},"ChatActivityStatsResponse":{"properties":{"Messages":{"$ref":"#/components/schemas/MessageStatsResponse","x-stream-index":"001"}},"type":"object"},"ClosedCaptionEvent":{"description":"This event is sent when closed captions are being sent in a call, clients should use this to show the closed captions in the call screen","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"closed_caption":{"$ref":"#/components/schemas/CallClosedCaption","description":"The closed caption object","title":"CallClosedCaption","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.closed_caption","description":"The type of event: \"call.closed_caption\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","closed_caption"],"title":"ClosedCaptionEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CollectUserFeedbackRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"009"},"rating":{"format":"int32","maximum":5,"minimum":1,"type":"integer","x-stream-index":"007"},"reason":{"maxLength":1000,"type":"string","x-stream-index":"008"},"sdk":{"maxLength":50,"type":"string","x-stream-index":"005"},"sdk_version":{"maxLength":50,"type":"string","x-stream-index":"006"},"user_session_id":{"maxLength":50,"type":"string","x-stream-index":"004"}},"required":["sdk","sdk_version","rating"],"type":"object"},"CollectUserFeedbackResponse":{"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"},"Command":{"description":"Represents custom chat command","nullable":true,"properties":{"args":{"description":"Arguments help text, shown in commands auto-completion","title":"Arguments","type":"string","x-stream-index":"006"},"created_at":{"description":"Date/time of creation","format":"date-time","readOnly":true,"title":"Created at","type":"number","x-stream-index":"001"},"description":{"description":"Description, shown in commands auto-completion","title":"Description","type":"string","x-stream-index":"005"},"name":{"description":"Unique command name","title":"Name","type":"string","x-stream-index":"004"},"set":{"description":"Set name used for grouping commands","title":"Set","type":"string","x-stream-index":"007"},"updated_at":{"description":"Date/time of the last update","format":"date-time","readOnly":true,"title":"Updated at","type":"number","x-stream-index":"002"}},"required":["name","description","args","set"],"title":"Command","type":"object"},"ConfigOverrides":{"properties":{"blocklist":{"type":"string","x-stream-index":"008"},"blocklist_behavior":{"enum":["flag","block"],"type":"string","x-stream-index":"009"},"commands":{"items":{"type":"string"},"type":"array","x-stream-index":"011"},"count_messages":{"type":"boolean","x-stream-index":"014"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"010"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"007"},"quotes":{"type":"boolean","x-stream-index":"004"},"reactions":{"type":"boolean","x-stream-index":"002"},"replies":{"type":"boolean","x-stream-index":"003"},"shared_locations":{"type":"boolean","x-stream-index":"013"},"typing_events":{"type":"boolean","x-stream-index":"001"},"uploads":{"type":"boolean","x-stream-index":"005"},"url_enrichment":{"type":"boolean","x-stream-index":"006"},"user_message_reminders":{"type":"boolean","x-stream-index":"012"}},"required":["grants","commands"],"type":"object"},"ConnectUserDetailsRequest":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001"},"image":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"006"},"language":{"type":"string","x-stream-index":"005"},"name":{"type":"string","x-stream-index":"002"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"007"}},"required":["id"],"type":"object"},"ConnectedEvent":{"description":"This event is sent when the WS connection is established and authenticated, this event contains the full user object as it is stored on the server","properties":{"connection_id":{"description":"The connection_id for this client","title":"Connection ID","type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"me":{"$ref":"#/components/schemas/OwnUserResponse","description":"The full user object as it is stored on the server","title":"OwnUserResponse","x-stream-index":"003"},"type":{"default":"connection.ok","description":"The type of event: \"connection.ok\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","connection_id","me"],"title":"ConnectedEvent","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"},"ConnectionErrorEvent":{"description":"This event is sent when the WS connection fails","properties":{"connection_id":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"error":{"$ref":"#/components/schemas/APIError","description":"The error that caused the connection to fail","title":"Error","x-stream-index":"003"},"type":{"default":"connection.error","description":"The type of event: \"connection.ok\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","connection_id","error"],"title":"ConnectionErrorEvent","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"},"CountByMinuteResponse":{"nullable":true,"properties":{"count":{"format":"int32","type":"integer","x-stream-index":"002"},"start_ts":{"format":"date-time","type":"number","x-stream-index":"001"}},"required":["start_ts","count"],"type":"object"},"CreateBlockListRequest":{"description":"Block list contains restricted words","nullable":true,"properties":{"name":{"description":"Block list name","maxLength":255,"title":"Name","type":"string","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"004"},"type":{"description":"Block list type.","enum":["regex","domain","domain_allowlist","email","word"],"title":"Type","type":"string","x-stream-index":"003"},"words":{"description":"List of words to block","items":{"type":"string"},"minimum":1,"title":"Words","type":"array","x-stream-index":"002"}},"required":["name","words"],"title":"Block list","type":"object","x-stream-docs-page-id":"block_lists"},"CreateBlockListResponse":{"description":"Basic response information","nullable":true,"properties":{"blocklist":{"$ref":"#/components/schemas/BlockListResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["duration"],"title":"Response","type":"object"},"CreateDeviceRequest":{"description":"Create device request","nullable":true,"properties":{"id":{"description":"Device ID","maxLength":255,"minLength":1,"title":"ID","type":"string","x-stream-index":"001"},"push_provider":{"description":"Push provider","enum":["firebase","apn","huawei","xiaomi"],"title":"PushProvider","type":"string","x-stream-index":"002"},"push_provider_name":{"description":"Push provider name","title":"PushProviderName","type":"string","x-stream-index":"003"},"voip_token":{"description":"When true the token is for Apple VoIP push notifications","title":"VoipToken","type":"boolean","x-stream-index":"004"}},"required":["id","push_provider"],"title":"CreateDeviceRequest","type":"object"},"CreateGuestRequest":{"nullable":true,"properties":{"user":{"$ref":"#/components/schemas/UserRequest","description":"User object which server acts upon","title":"User","x-stream-index":"001"}},"required":["user"],"type":"object"},"CreateGuestResponse":{"nullable":true,"properties":{"access_token":{"description":"the access token to authenticate the user","title":"Access token","type":"string","x-stream-index":"002"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User object which server acts upon","title":"User","x-stream-index":"001"}},"required":["user","access_token","duration"],"type":"object"},"CreatePollOptionRequest":{"nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"003"},"text":{"description":"Option text","title":"string","type":"string","x-stream-index":"002"}},"required":["text"],"type":"object"},"CreatePollRequest":{"description":"Contains all information needed to create a new poll","nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"011"},"allow_answers":{"description":"Indicates whether users can suggest user defined answers","title":"Allow answers","type":"boolean","x-stream-index":"009"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"008"},"description":{"description":"A description of the poll","title":"Description","type":"string","x-stream-index":"003"},"enforce_unique_vote":{"description":"Indicates whether users can cast multiple votes","title":"Multiple choice","type":"boolean","x-stream-index":"006"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"is_closed":{"description":"Indicates whether the poll is open for voting","title":"Is closed","type":"boolean","x-stream-index":"010"},"max_votes_allowed":{"description":"Indicates the maximum amount of votes a user can cast","format":"int32","maximum":10,"title":"Maximum votes allowed","type":"integer","x-stream-index":"007"},"name":{"description":"The name of the poll","title":"Name","type":"string","x-stream-index":"002"},"options":{"items":{"$ref":"#/components/schemas/PollOptionInput"},"maximum":100,"type":"array","x-stream-index":"004"},"voting_visibility":{"enum":["anonymous","public"],"type":"string","x-stream-index":"005"}},"required":["name"],"title":"Create Poll Request","type":"object"},"Credentials":{"properties":{"ice_servers":{"items":{"$ref":"#/components/schemas/ICEServer"},"type":"array","x-stream-index":"003"},"server":{"$ref":"#/components/schemas/SFUResponse","x-stream-index":"001"},"token":{"type":"string","x-stream-index":"002"}},"required":["server","token","ice_servers"],"type":"object"},"CustomVideoEvent":{"description":"A custom event, this event is used to send custom events to other participants in the call.","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"003"},"type":{"default":"custom","description":"The type of event, \"custom\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"004"}},"required":["type","created_at","call_cid","custom","user"],"title":"CustomVideoEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"DailyAggregateCallDurationReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/CallDurationReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateCallParticipantCountReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/CallParticipantCountReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateCallsPerDayReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/CallsPerDayReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateQualityScoreReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/QualityScoreReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateSDKUsageReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/SDKUsageReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateUserFeedbackReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/UserFeedbackReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DeleteCallRequest":{"description":"DeleteCallRequest is the payload for deleting a call.","nullable":true,"properties":{"hard":{"description":"if true the call will be hard deleted along with all related data","title":"Hard","type":"boolean","x-stream-index":"001"}},"title":"DeleteCallRequest","type":"object"},"DeleteCallResponse":{"description":"DeleteCallResponse is the payload for deleting a call.","nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","title":"Call","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"task_id":{"title":"TaskID","type":"string","x-stream-index":"002"}},"required":["call","duration"],"title":"DeleteCallResponse","type":"object"},"DeleteRecordingResponse":{"description":"Response for DeleteRecording","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"DeleteRecordingResponse","type":"object"},"DeleteTranscriptionResponse":{"description":"DeleteTranscriptionResponse is the payload for deleting a transcription.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"DeleteTranscriptionResponse","type":"object"},"DeviceResponse":{"description":"Response for Device","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"004"},"disabled":{"description":"Whether device is disabled or not","title":"Disabled","type":"boolean","x-stream-index":"005"},"disabled_reason":{"description":"Reason explaining why device had been disabled","title":"Reason","type":"string","x-stream-index":"006"},"id":{"description":"Device ID","title":"ID","type":"string","x-stream-index":"003"},"push_provider":{"description":"Push provider","title":"PushProvider","type":"string","x-stream-index":"001"},"push_provider_name":{"description":"Push provider name","title":"PushProviderName","type":"string","x-stream-index":"002"},"user_id":{"description":"User ID","title":"UserID","type":"string","x-stream-index":"008"},"voip":{"description":"When true the token is for Apple VoIP push notifications","title":"Voip","type":"boolean","x-stream-index":"007"}},"required":["push_provider","id","created_at","user_id"],"title":"DeviceResponse","type":"object"},"DraftPayloadResponse":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"html":{"type":"string","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"001"},"mentioned_users":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"008"},"mml":{"type":"string","x-stream-index":"003"},"parent_id":{"type":"string","x-stream-index":"005"},"poll_id":{"type":"string","x-stream-index":"013"},"quoted_message_id":{"type":"string","x-stream-index":"009"},"show_in_channel":{"type":"boolean","x-stream-index":"006"},"silent":{"type":"boolean","x-stream-index":"012"},"text":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"011"}},"required":["id","text","custom"],"type":"object"},"DraftResponse":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003"},"channel_cid":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"message":{"$ref":"#/components/schemas/DraftPayloadResponse","x-stream-index":"001"},"parent_id":{"type":"string","x-stream-index":"004"},"parent_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"005"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"006"}},"required":["message","channel_cid","created_at"],"type":"object"},"EdgeResponse":{"properties":{"continent_code":{"type":"string","x-stream-index":"007.003"},"country_iso_code":{"type":"string","x-stream-index":"007.002"},"green":{"format":"int32","type":"integer","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"latency_test_url":{"type":"string","x-stream-index":"002"},"latitude":{"format":"float","type":"number","x-stream-index":"006.001"},"longitude":{"format":"float","type":"number","x-stream-index":"006.002"},"red":{"format":"int32","type":"integer","x-stream-index":"005"},"subdivision_iso_code":{"type":"string","x-stream-index":"007.001"},"yellow":{"format":"int32","type":"integer","x-stream-index":"004"}},"required":["id","latency_test_url","green","yellow","red","latitude","longitude","subdivision_iso_code","country_iso_code","continent_code"],"type":"object"},"EgressHLSResponse":{"properties":{"playlist_url":{"type":"string","x-stream-index":"001"},"status":{"type":"string","x-stream-index":"002"}},"required":["playlist_url","status"],"type":"object"},"EgressRTMPResponse":{"properties":{"name":{"type":"string","x-stream-index":"001"},"started_at":{"format":"date-time","type":"number","x-stream-index":"004"},"stream_key":{"type":"string","x-stream-index":"003"},"stream_url":{"type":"string","x-stream-index":"002"}},"required":["name","started_at"],"type":"object"},"EgressResponse":{"properties":{"broadcasting":{"type":"boolean","x-stream-index":"001"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordingResponse","x-stream-index":"004"},"hls":{"$ref":"#/components/schemas/EgressHLSResponse","x-stream-index":"002"},"rtmps":{"items":{"$ref":"#/components/schemas/EgressRTMPResponse"},"type":"array","x-stream-index":"003"}},"required":["broadcasting","rtmps"],"type":"object"},"EndCallRequest":{"description":"Request for ending a call","nullable":true,"title":"EndCallRequest","type":"object"},"EndCallResponse":{"description":"Response for ending a call","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"EndCallResponse","type":"object"},"FeedsEventPreferences":{"properties":{"comments":{"type":"string","x-stream-index":"002"},"mentions":{"type":"string","x-stream-index":"004"},"new_followers":{"type":"string","x-stream-index":"003"},"reactions":{"type":"string","x-stream-index":"001"}},"type":"object"},"Field":{"nullable":true,"properties":{"short":{"type":"boolean","x-stream-index":"003"},"title":{"type":"string","x-stream-index":"001"},"value":{"type":"string","x-stream-index":"002"}},"required":["title","value","short"],"type":"object"},"FileUploadConfig":{"properties":{"allowed_file_extensions":{"items":{"type":"string"},"type":"array","x-stream-index":"001"},"allowed_mime_types":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"blocked_file_extensions":{"items":{"type":"string"},"type":"array","x-stream-index":"002"},"blocked_mime_types":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"size_limit":{"format":"int32","maximum":104857600,"minimum":0,"type":"integer","x-stream-index":"005"}},"required":["allowed_file_extensions","blocked_file_extensions","allowed_mime_types","blocked_mime_types","size_limit"],"type":"object"},"FileUploadRequest":{"nullable":true,"properties":{"file":{"description":"file field","title":"File","type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/OnlyUserID","description":"user for the request **server side only**","title":"User","x-stream-index":"002"}},"type":"object"},"FileUploadResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"file":{"description":"URL to the uploaded asset. Should be used to put to `asset_url` attachment field","title":"File","type":"string","x-stream-index":"001"},"thumb_url":{"description":"URL of the file thumbnail for supported file formats. Should be put to `thumb_url` attachment field","title":"Thumbnail URL","type":"string","x-stream-index":"002"}},"required":["duration"],"type":"object"},"FrameRecordingResponse":{"properties":{"status":{"type":"string","x-stream-index":"001"}},"required":["status"],"type":"object"},"FrameRecordingSettingsRequest":{"properties":{"capture_interval_in_seconds":{"format":"int32","maximum":60,"minimum":2,"type":"integer","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"},"quality":{"enum":["360p","480p","720p","1080p","1440p"],"type":"string","x-stream-index":"002"}},"required":["mode","capture_interval_in_seconds"],"type":"object"},"FrameRecordingSettingsResponse":{"properties":{"capture_interval_in_seconds":{"format":"int32","maximum":60,"minimum":2,"type":"integer","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"},"quality":{"type":"string","x-stream-index":"002"}},"required":["mode","capture_interval_in_seconds"],"type":"object"},"FullUserResponse":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"015"},"banned":{"type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"014"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.011"},"devices":{"items":{"$ref":"#/components/schemas/DeviceResponse"},"type":"array","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001.001"},"image":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"005"},"language":{"type":"string","x-stream-index":"001.005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"001.014"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"012"},"mutes":{"items":{"$ref":"#/components/schemas/UserMuteResponse"},"type":"array","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"001.002"},"online":{"type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"003"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.015"},"role":{"type":"string","x-stream-index":"001.006"},"shadow_banned":{"type":"boolean","x-stream-index":"013"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"009"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"010"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"008"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"011"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","devices","invisible","mutes","channel_mutes","unread_count","total_unread_count","unread_channels","unread_threads","shadow_banned","blocked_user_ids"],"type":"object"},"GeofenceSettingsRequest":{"properties":{"names":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"type":"object"},"GeofenceSettingsResponse":{"properties":{"names":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"required":["names"],"type":"object"},"GetApplicationResponse":{"description":"Basic response information","nullable":true,"properties":{"app":{"$ref":"#/components/schemas/AppResponseFields","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["app","duration"],"title":"Response","type":"object"},"GetBlockedUsersResponse":{"nullable":true,"properties":{"blocks":{"description":"Array of blocked user object","items":{"$ref":"#/components/schemas/BlockedUserResponse"},"title":"Blocks","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["blocks","duration"],"type":"object"},"GetCallReportResponse":{"description":"Basic response information","nullable":true,"properties":{"chat_activity":{"$ref":"#/components/schemas/ChatActivityStatsResponse","x-stream-index":"004"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"report":{"$ref":"#/components/schemas/ReportResponse","x-stream-index":"003"},"session_id":{"type":"string","x-stream-index":"002"},"video_reactions":{"items":{"$ref":"#/components/schemas/VideoReactionsResponse"},"type":"array","x-stream-index":"005"}},"required":["duration","session_id","report"],"title":"Response","type":"object"},"GetCallResponse":{"nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001.001"},"duration":{"type":"string","x-stream-index":"002.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001.002"},"membership":{"$ref":"#/components/schemas/MemberResponse","x-stream-index":"001.003"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"001.004"}},"required":["call","members","own_capabilities","blocked_users","duration"],"title":"GetCallResponse","type":"object"},"GetEdgesResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"edges":{"items":{"$ref":"#/components/schemas/EdgeResponse"},"type":"array","x-stream-index":"001"}},"required":["edges","duration"],"title":"Response","type":"object"},"GetOGResponse":{"nullable":true,"properties":{"actions":{"items":{"$ref":"#/components/schemas/Action"},"type":"array","x-stream-index":"001.015"},"asset_url":{"description":"URL of detected video or audio","title":"Image URL","type":"string","x-stream-index":"001.017"},"author_icon":{"type":"string","x-stream-index":"001.007"},"author_link":{"description":"og:site","title":"Author Link","type":"string","x-stream-index":"001.006"},"author_name":{"description":"og:site_name","title":"Author Name","type":"string","x-stream-index":"001.005"},"color":{"type":"string","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.018"},"duration":{"type":"string","x-stream-index":"002.001"},"fallback":{"type":"string","x-stream-index":"001.002"},"fields":{"items":{"$ref":"#/components/schemas/Field"},"type":"array","x-stream-index":"001.016"},"footer":{"type":"string","x-stream-index":"001.013"},"footer_icon":{"type":"string","x-stream-index":"001.014"},"giphy":{"$ref":"#/components/schemas/Images","x-stream-index":"001.019"},"image_url":{"description":"URL of detected image","title":"Image URL","type":"string","x-stream-index":"001.011"},"og_scrape_url":{"description":"extracted url from the text","title":"OG Scrape URL","type":"string","x-stream-index":"001.020"},"original_height":{"format":"int32","type":"integer","x-stream-index":"001.022"},"original_width":{"format":"int32","type":"integer","x-stream-index":"001.021"},"pretext":{"type":"string","x-stream-index":"001.004"},"text":{"description":"og:description","title":"Text","type":"string","x-stream-index":"001.010"},"thumb_url":{"description":"URL of detected thumb image","title":"Image URL","type":"string","x-stream-index":"001.012"},"title":{"description":"og:title","title":"Title","type":"string","x-stream-index":"001.008"},"title_link":{"description":"og:url","title":"Title Link","type":"string","x-stream-index":"001.009"},"type":{"description":"Attachment type, could be empty, image, audio or video","title":"Type","type":"string","x-stream-index":"001.001"}},"required":["custom","duration"],"title":"Get OG Attachment","type":"object","x-stream-docs-page-id":"og"},"GetOrCreateCallRequest":{"nullable":true,"properties":{"data":{"$ref":"#/components/schemas/CallRequest","title":"ReadOnlyData","x-stream-index":"003"},"members_limit":{"format":"int32","maximum":100,"type":"integer","x-stream-index":"007"},"notify":{"description":"if provided it sends a notification event to the members for this call","title":"Notify","type":"boolean","x-stream-index":"005"},"ring":{"description":"if provided it sends a ring event to the members for this call","title":"Ring","type":"boolean","x-stream-index":"004"},"video":{"type":"boolean","x-stream-index":"006"}},"title":"GetOrCreateCallRequest","type":"object"},"GetOrCreateCallResponse":{"nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001.001"},"created":{"type":"boolean","x-stream-index":"002"},"duration":{"type":"string","x-stream-index":"003.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001.002"},"membership":{"$ref":"#/components/schemas/MemberResponse","x-stream-index":"001.003"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"001.004"}},"required":["call","members","own_capabilities","blocked_users","created","duration"],"title":"GetOrCreateCallResponse","type":"object"},"GoLiveRequest":{"nullable":true,"properties":{"recording_storage_name":{"type":"string","x-stream-index":"005"},"start_closed_caption":{"type":"boolean","x-stream-index":"008"},"start_hls":{"type":"boolean","x-stream-index":"003"},"start_recording":{"type":"boolean","x-stream-index":"004"},"start_transcription":{"type":"boolean","x-stream-index":"007"},"transcription_storage_name":{"type":"string","x-stream-index":"006"}},"title":"GoLiveRequest","type":"object"},"GoLiveResponse":{"description":"Basic response information","nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["call","duration"],"title":"Response","type":"object"},"GroupedStatsResponse":{"nullable":true,"properties":{"name":{"type":"string","x-stream-index":"001"},"unique":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["name","unique"],"type":"object"},"HLSSettingsRequest":{"properties":{"auto_on":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"quality_tracks":{"items":{"type":"string"},"maximum":3,"minimum":1,"type":"array","x-stream-index":"003"}},"required":["quality_tracks"],"title":"HLSSettingsRequest","type":"object"},"HLSSettingsResponse":{"description":"HLSSettings is the payload for HLS settings","properties":{"auto_on":{"title":"Auto On","type":"boolean","x-stream-index":"001"},"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"002"},"quality_tracks":{"items":{"type":"string"},"title":"Quality Tracks","type":"array","x-stream-index":"003"}},"required":["auto_on","enabled","quality_tracks","layout"],"title":"HLSSettingsResponse","type":"object"},"HealthCheckEvent":{"nullable":true,"properties":{"cid":{"type":"string","x-stream-index":"003"},"connection_id":{"type":"string","x-stream-index":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004.007"},"me":{"$ref":"#/components/schemas/OwnUserResponse","x-stream-index":"002"},"received_at":{"format":"date-time","type":"number","x-stream-index":"004.004"},"type":{"default":"health.check","type":"string","x-stream-index":"004.002"}},"required":["connection_id","type","created_at","custom"],"title":"HealthCheckEvent","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"},"ICEServer":{"properties":{"password":{"type":"string","x-stream-index":"003"},"urls":{"items":{"type":"string"},"type":"array","x-stream-index":"001"},"username":{"type":"string","x-stream-index":"002"}},"required":["urls","username","password"],"type":"object"},"ImageData":{"properties":{"frames":{"type":"string","x-stream-index":"005"},"height":{"type":"string","x-stream-index":"003"},"size":{"type":"string","x-stream-index":"004"},"url":{"type":"string","x-stream-index":"001"},"width":{"type":"string","x-stream-index":"002"}},"required":["url","width","height","size","frames"],"type":"object"},"ImageSize":{"properties":{"crop":{"description":"Crop mode","enum":["top","bottom","left","right","center"],"title":"Crop","type":"string","x-stream-index":"001"},"height":{"description":"Target image height","format":"int32","title":"Height","type":"integer","x-stream-index":"003"},"resize":{"description":"Resize method","enum":["clip","crop","scale","fill"],"title":"Resize","type":"string","x-stream-index":"002"},"width":{"description":"Target image width","format":"int32","title":"Width","type":"integer","x-stream-index":"004"}},"title":"Image size configuration","type":"object"},"ImageUploadRequest":{"nullable":true,"properties":{"file":{"type":"string","x-stream-index":"001.001"},"upload_sizes":{"description":"field with JSON-encoded array of image size configurations","items":{"$ref":"#/components/schemas/ImageSize"},"title":"Upload sizes","type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/OnlyUserID","x-stream-index":"001.002"}},"type":"object"},"ImageUploadResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.003.001"},"file":{"type":"string","x-stream-index":"001.001"},"thumb_url":{"type":"string","x-stream-index":"001.002"},"upload_sizes":{"description":"Array of image size configurations","items":{"$ref":"#/components/schemas/ImageSize"},"title":"Upload sizes","type":"array","x-stream-index":"002"}},"required":["duration"],"type":"object"},"Images":{"properties":{"fixed_height":{"$ref":"#/components/schemas/ImageData","x-stream-index":"002"},"fixed_height_downsampled":{"$ref":"#/components/schemas/ImageData","x-stream-index":"004"},"fixed_height_still":{"$ref":"#/components/schemas/ImageData","x-stream-index":"003"},"fixed_width":{"$ref":"#/components/schemas/ImageData","x-stream-index":"005"},"fixed_width_downsampled":{"$ref":"#/components/schemas/ImageData","x-stream-index":"007"},"fixed_width_still":{"$ref":"#/components/schemas/ImageData","x-stream-index":"006"},"original":{"$ref":"#/components/schemas/ImageData","x-stream-index":"001"}},"required":["original","fixed_height","fixed_height_still","fixed_height_downsampled","fixed_width","fixed_width_still","fixed_width_downsampled"],"type":"object"},"IngressAudioEncodingOptionsRequest":{"properties":{"bitrate":{"maximum":128000,"minimum":16000,"type":"integer","x-stream-index":"003"},"channels":{"enum":["1","2"],"format":"int32","type":"integer","x-stream-index":"001"},"enable_dtx":{"type":"boolean","x-stream-index":"002"}},"required":["channels","bitrate"],"type":"object"},"IngressAudioEncodingResponse":{"properties":{"bitrate":{"format":"int32","type":"integer","x-stream-index":"003"},"channels":{"format":"int32","type":"integer","x-stream-index":"001"},"enable_dtx":{"type":"boolean","x-stream-index":"002"}},"required":["channels","enable_dtx","bitrate"],"type":"object"},"IngressSettingsRequest":{"properties":{"audio_encoding_options":{"$ref":"#/components/schemas/IngressAudioEncodingOptionsRequest","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"video_encoding_options":{"additionalProperties":{"$ref":"#/components/schemas/IngressVideoEncodingOptionsRequest"},"type":"object","x-stream-index":"003"}},"type":"object"},"IngressSettingsResponse":{"properties":{"audio_encoding_options":{"$ref":"#/components/schemas/IngressAudioEncodingResponse","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"video_encoding_options":{"additionalProperties":{"$ref":"#/components/schemas/IngressVideoEncodingResponse"},"type":"object","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"IngressVideoEncodingOptionsRequest":{"properties":{"layers":{"items":{"$ref":"#/components/schemas/IngressVideoLayerRequest"},"minimum":1,"type":"array","x-stream-index":"001"}},"required":["layers"],"type":"object"},"IngressVideoEncodingResponse":{"properties":{"layers":{"items":{"$ref":"#/components/schemas/IngressVideoLayerResponse"},"type":"array","x-stream-index":"001"}},"required":["layers"],"type":"object"},"IngressVideoLayerRequest":{"nullable":true,"properties":{"bitrate":{"format":"int32","minimum":1000,"type":"integer","x-stream-index":"002"},"codec":{"enum":["h264","vp8"],"type":"string","x-stream-index":"001"},"frame_rate_limit":{"maximum":60,"minimum":1,"type":"integer","x-stream-index":"005"},"max_dimension":{"minimum":240,"type":"integer","x-stream-index":"004"},"min_dimension":{"minimum":240,"type":"integer","x-stream-index":"003"}},"required":["codec","bitrate","min_dimension","max_dimension","frame_rate_limit"],"type":"object"},"IngressVideoLayerResponse":{"nullable":true,"properties":{"bitrate":{"type":"integer","x-stream-index":"002"},"codec":{"type":"string","x-stream-index":"001"},"frame_rate_limit":{"type":"integer","x-stream-index":"005"},"max_dimension":{"type":"integer","x-stream-index":"004"},"min_dimension":{"type":"integer","x-stream-index":"003"}},"required":["codec","bitrate","min_dimension","max_dimension","frame_rate_limit"],"type":"object"},"JoinCallRequest":{"nullable":true,"properties":{"create":{"description":"if true the call will be created if it doesn't exist","title":"Create","type":"boolean","x-stream-index":"002"},"data":{"$ref":"#/components/schemas/CallRequest","x-stream-index":"003"},"location":{"title":"Location","type":"string","x-stream-index":"009"},"members_limit":{"format":"int32","maximum":100,"title":"The amount of members that should be returned","type":"integer","x-stream-index":"007"},"migrating_from":{"description":"If the participant is migrating from another SFU, then this is the ID of the previous SFU","title":"MigratingFrom","type":"string","x-stream-index":"010"},"notify":{"type":"boolean","x-stream-index":"005"},"ring":{"description":"if true and the call is created, the notification will include ring=true","title":"Ring","type":"boolean","x-stream-index":"004"},"video":{"type":"boolean","x-stream-index":"006"}},"required":["location"],"title":"JoinCallRequest","type":"object"},"JoinCallResponse":{"nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001.001"},"created":{"title":"Created","type":"boolean","x-stream-index":"002"},"credentials":{"$ref":"#/components/schemas/Credentials","title":"Credentials","x-stream-index":"003"},"duration":{"type":"string","x-stream-index":"005.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001.002"},"membership":{"$ref":"#/components/schemas/MemberResponse","x-stream-index":"001.003"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"001.004"},"stats_options":{"$ref":"#/components/schemas/StatsOptions","x-stream-index":"004"}},"required":["call","members","own_capabilities","blocked_users","created","credentials","stats_options","duration"],"title":"JoinCallResponse","type":"object"},"KickUserRequest":{"description":"KickUserRequest is the payload for kicking a user from a call. Optionally block the user as well.","nullable":true,"properties":{"block":{"description":"If true, also block the user from rejoining the call","title":"Block","type":"boolean","x-stream-index":"004"},"user_id":{"description":"The user to kick","title":"UserID","type":"string","x-stream-index":"003"}},"required":["user_id"],"title":"KickUserRequest","type":"object"},"KickUserResponse":{"description":"KickUserResponse is the payload for kicking a user from a call.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"KickUserResponse","type":"object"},"KickedUserEvent":{"description":"This event is sent to call participants to notify when a user is kicked from a call. Clients should make the kicked user leave the call UI.","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"kicked_by_user":{"$ref":"#/components/schemas/UserResponse","description":"The user that kicked the participant, null if server-side","title":"Kicked by","x-stream-index":"004"},"type":{"default":"call.kicked_user","description":"The type of event: \"call.kicked_user\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user that was kicked","title":"User","x-stream-index":"003"}},"required":["type","created_at","call_cid","user"],"title":"KickedUserEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"LabelThresholds":{"properties":{"block":{"description":"Threshold for automatic message block","format":"float","maximum":1,"minimum":0,"title":"Block","type":"number","x-stream-index":"002"},"flag":{"description":"Threshold for automatic message flag","format":"float","maximum":1,"minimum":0,"title":"Flag","type":"number","x-stream-index":"001"}},"type":"object"},"LayoutSettingsRequest":{"properties":{"detect_orientation":{"type":"boolean","x-stream-index":"005"},"external_app_url":{"type":"string","x-stream-index":"003"},"external_css_url":{"type":"string","x-stream-index":"004"},"name":{"enum":["spotlight","grid","single-participant","mobile","custom"],"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"required":["name"],"type":"object"},"LimitsSettingsRequest":{"properties":{"max_duration_seconds":{"format":"int32","minimum":0,"type":"integer","x-stream-index":"004"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"},"max_participants_exclude_owner":{"type":"boolean","x-stream-index":"003"},"max_participants_exclude_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"002"}},"type":"object"},"LimitsSettingsResponse":{"properties":{"max_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"004"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"},"max_participants_exclude_owner":{"type":"boolean","x-stream-index":"003"},"max_participants_exclude_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"002"}},"required":["max_participants_exclude_roles"],"type":"object"},"ListBlockListResponse":{"description":"Basic response information","nullable":true,"properties":{"blocklists":{"items":{"$ref":"#/components/schemas/BlockListResponse"},"type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["blocklists","duration"],"title":"Response","type":"object"},"ListDevicesResponse":{"description":"List devices response","nullable":true,"properties":{"devices":{"description":"List of devices","items":{"$ref":"#/components/schemas/DeviceResponse"},"title":"Devices","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["devices","duration"],"title":"ListDevicesResponse","type":"object"},"ListRecordingsResponse":{"description":"Response for listing recordings","nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"},"recordings":{"items":{"$ref":"#/components/schemas/CallRecording"},"title":"The list of recordings.","type":"array","x-stream-index":"002"}},"required":["duration","recordings"],"title":"ListRecordingsResponse","type":"object"},"ListTranscriptionsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"},"transcriptions":{"description":"List of transcriptions for the call","items":{"$ref":"#/components/schemas/CallTranscription"},"title":"Transcriptions","type":"array","x-stream-index":"002"}},"required":["duration","transcriptions"],"title":"ListTranscriptionsResponse","type":"object"},"MemberRequest":{"description":"MemberRequest is the payload for adding a member to a call.","properties":{"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"003"},"role":{"title":"Role","type":"string","x-stream-index":"002"},"user_id":{"minLength":1,"title":"User ID","type":"string","x-stream-index":"001"}},"required":["user_id"],"title":"MemberRequest","type":"object"},"MemberResponse":{"description":"MemberResponse is the payload for a member of a call.","properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"005"},"custom":{"additionalProperties":{},"description":"Custom member response data","title":"Custom","type":"object","x-stream-index":"004"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"007"},"role":{"title":"Role","type":"string","x-stream-index":"003"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"006"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"},"user_id":{"type":"string","x-stream-index":"002"}},"required":["user","user_id","custom","created_at","updated_at"],"title":"MemberResponse","type":"object"},"Message":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"012"},"before_message_send_failed":{"type":"boolean","x-stream-index":"046"},"cid":{"type":"string","x-stream-index":"028"},"command":{"type":"string","x-stream-index":"006"},"created_at":{"format":"date-time","type":"number","x-stream-index":"030"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"034"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"033"},"deleted_for_me":{"type":"boolean","x-stream-index":"059"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"023"},"html":{"type":"string","x-stream-index":"007"},"i18n":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"044"},"id":{"type":"string","x-stream-index":"002"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"040"},"latest_reactions":{"items":{"$ref":"#/components/schemas/Reaction"},"type":"array","x-stream-index":"013"},"mentioned_users":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"043"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"052"},"mml":{"type":"string","x-stream-index":"005"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"056"},"own_reactions":{"items":{"$ref":"#/components/schemas/Reaction"},"type":"array","x-stream-index":"014"},"parent_id":{"type":"string","x-stream-index":"019"},"pin_expires":{"format":"date-time","type":"number","x-stream-index":"051"},"pinned":{"type":"boolean","x-stream-index":"047"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"048"},"pinned_by":{"$ref":"#/components/schemas/User","x-stream-index":"050"},"poll":{"$ref":"#/components/schemas/Poll","x-stream-index":"054"},"poll_id":{"type":"string","x-stream-index":"053"},"quoted_message":{"$ref":"#/components/schemas/Message","x-stream-index":"025"},"quoted_message_id":{"type":"string","x-stream-index":"024"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"015"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"017"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"016"},"reminder":{"$ref":"#/components/schemas/MessageReminder","x-stream-index":"058"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"022"},"restricted_visibility":{"items":{"type":"string"},"type":"array","x-stream-index":"011"},"shadowed":{"type":"boolean","x-stream-index":"036"},"shared_location":{"$ref":"#/components/schemas/SharedLocation","x-stream-index":"055"},"show_in_channel":{"type":"boolean","x-stream-index":"021"},"silent":{"type":"boolean","x-stream-index":"045"},"text":{"type":"string","x-stream-index":"004"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"027"},"type":{"type":"string","x-stream-index":"008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"031"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"010"}},"required":["id","text","html","type","restricted_visibility","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reaction_groups","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned"],"type":"object"},"MessageReminder":{"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"004"},"channel_cid":{"type":"string","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"011"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"006"},"message_id":{"type":"string","x-stream-index":"005"},"remind_at":{"format":"date-time","type":"number","x-stream-index":"009"},"task_id":{"type":"string","x-stream-index":"010"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"012"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"user_id":{"type":"string","x-stream-index":"007"}},"required":["channel_cid","message_id","user_id","task_id","created_at","updated_at"],"type":"object"},"MessageResponse":{"description":"Represents any chat message","properties":{"attachments":{"description":"Array of message attachments","items":{"$ref":"#/components/schemas/Attachment"},"title":"Message attachments","type":"array","x-stream-docs-page-id":"message_format#attachment-format","x-stream-index":"008"},"cid":{"description":"Channel unique identifier in \u003ctype\u003e:\u003cid\u003e format","title":"Channel CID","type":"string","x-stream-index":"022"},"command":{"description":"Contains provided slash command","title":"Command","type":"string","x-stream-docs-page-id":"custom_commands_webhook","x-stream-index":"004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"023"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"026"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"025"},"deleted_for_me":{"type":"boolean","x-stream-index":"044"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"018"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"041"},"html":{"description":"Contains HTML markup of the message. Can only be set when using server-side API","title":"HTML content","type":"string","x-stream-index":"005"},"i18n":{"additionalProperties":{"type":"string"},"description":"Object with translations. Key `language` contains the original language key. Other keys contain translations","title":"Internationalization info","type":"object","x-stream-docs-page-id":"translation","x-stream-index":"030"},"id":{"description":"Message ID is unique string identifier of the message","title":"ID","type":"string","x-stream-index":"001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"Contains image moderation information","title":"Image moderation labels","type":"object","x-stream-index":"028"},"latest_reactions":{"description":"List of 10 latest reactions to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Latest reactions","type":"array","x-stream-index":"009"},"mentioned_users":{"description":"List of mentioned users","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Mentioned Users","type":"array","x-stream-index":"029"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"036"},"mml":{"description":"Should be empty if `text` is provided. Can only be set when using server-side API","title":"Messaging Markup Language","type":"string","x-stream-docs-page-id":"mml_overview","x-stream-index":"003"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"039"},"own_reactions":{"description":"List of 10 latest reactions of authenticated user to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Own reactions","type":"array","x-stream-index":"010"},"parent_id":{"description":"ID of parent message (thread)","title":"Parent message ID","type":"string","x-stream-docs-page-id":"threads","x-stream-index":"015"},"pin_expires":{"description":"Date when pinned message expires","format":"date-time","title":"Pin expiration date","type":"number","x-stream-docs-page-id":"pinned_messages","x-stream-index":"035"},"pinned":{"description":"Whether message is pinned or not","title":"Pinned","type":"boolean","x-stream-docs-page-id":"pinned_messages","x-stream-index":"032"},"pinned_at":{"description":"Date when message got pinned","format":"date-time","title":"Pinned at","type":"number","x-stream-docs-page-id":"pinned_messages","x-stream-index":"033"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","description":"Contains user who pinned the message","title":"Pinned by","x-stream-docs-page-id":"pinned_messages","x-stream-index":"034"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"038"},"poll_id":{"description":"Identifier of the poll to include in the message","title":"Poll ID","type":"string","x-stream-index":"037"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","description":"Contains quoted message","title":"Quoted message","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"020"},"quoted_message_id":{"title":"ID of quoted message","type":"string","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"019"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing number of reactions of each type. Key: reaction type (string), value: number of reactions (int)","title":"Reaction counts","type":"object","x-stream-index":"011"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"014"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing scores of reactions of each type. Key: reaction type (string), value: total score of reactions (int)","title":"Reaction scores","type":"object","x-stream-index":"012"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"042"},"reply_count":{"description":"Number of replies to this message","format":"int32","title":"Reply count","type":"integer","x-stream-index":"017"},"restricted_visibility":{"description":"A list of user ids that have restricted visibility to the message, if the list is not empty, the message is only visible to the users in the list","items":{"type":"string"},"title":"Restricted visibility","type":"array","x-stream-index":"040"},"shadowed":{"description":"Whether the message was shadowed or not","title":"Shadowed","type":"boolean","x-stream-docs-page-id":"moderation#shadow-ban","x-stream-index":"027"},"shared_location":{"$ref":"#/components/schemas/SharedLocationResponseData","description":"Contains shared location data","title":"Shared Location","x-stream-index":"043"},"show_in_channel":{"description":"Whether thread reply should be shown in the channel as well","title":"Show in channel","type":"boolean","x-stream-docs-page-id":"threads","x-stream-index":"016"},"silent":{"description":"Whether message is silent or not","title":"Silent","type":"boolean","x-stream-index":"031"},"text":{"description":"Text of the message. Should be empty if `mml` is provided","title":"Text","type":"string","x-stream-index":"002"},"thread_participants":{"description":"List of users who participate in thread","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Thread participants","type":"array","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"021"},"type":{"description":"Contains type of the message","enum":["regular","ephemeral","error","reply","system","deleted"],"title":"Message Type","type":"string","x-stream-docs-page-id":"message_format#message-types","x-stream-index":"006"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"024"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Sender of the message. Required when using server-side API","title":"User object","x-stream-index":"007"}},"required":["id","text","html","type","user","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned","restricted_visibility"],"title":"Message","type":"object","x-stream-docs-page-id":"send_message"},"MessageStatsResponse":{"properties":{"count_over_time":{"items":{"$ref":"#/components/schemas/CountByMinuteResponse"},"type":"array","x-stream-index":"001"}},"type":"object"},"ModerationV2Response":{"properties":{"action":{"type":"string","x-stream-index":"001"},"blocklist_matched":{"type":"string","x-stream-index":"005"},"image_harms":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"original_text":{"type":"string","x-stream-index":"002"},"platform_circumvented":{"type":"boolean","x-stream-index":"007"},"semantic_filter_matched":{"type":"string","x-stream-index":"006"},"text_harms":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"required":["action","original_text"],"type":"object"},"MuteUsersRequest":{"nullable":true,"properties":{"audio":{"title":"Audio","type":"boolean","x-stream-index":"005"},"mute_all_users":{"type":"boolean","x-stream-index":"003"},"screenshare":{"title":"Screenshare","type":"boolean","x-stream-index":"007"},"screenshare_audio":{"title":"ScreenshareAudio","type":"boolean","x-stream-index":"008"},"user_ids":{"items":{"type":"string"},"title":"UserIDs","type":"array","x-stream-index":"004"},"video":{"title":"Video","type":"boolean","x-stream-index":"006"}},"title":"MuteUsersRequest","type":"object"},"MuteUsersResponse":{"description":"MuteUsersResponse is the response payload for the mute users endpoint.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"MuteUsersResponse","type":"object"},"NetworkMetricsReportResponse":{"properties":{"average_connection_time":{"format":"float","type":"number","x-stream-index":"003"},"average_jitter":{"format":"float","type":"number","x-stream-index":"002"},"average_latency":{"format":"float","type":"number","x-stream-index":"001"},"average_time_to_reconnect":{"format":"float","type":"number","x-stream-index":"004"}},"type":"object"},"NoiseCancellationSettings":{"properties":{"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode"],"type":"object"},"OnlyUserID":{"properties":{"id":{"type":"string","x-stream-index":"001"}},"required":["id"],"type":"object"},"OwnCapability":{"description":"All possibility of string to use","enum":["block-users","change-max-duration","create-call","create-reaction","enable-noise-cancellation","end-call","join-backstage","join-call","join-ended-call","kick-user","mute-users","pin-for-everyone","read-call","remove-call-member","screenshare","send-audio","send-video","start-broadcast-call","start-closed-captions-call","start-frame-record-call","start-record-call","start-transcription-call","stop-broadcast-call","stop-closed-captions-call","stop-frame-record-call","stop-record-call","stop-transcription-call","update-call","update-call-member","update-call-permissions","update-call-settings"],"title":"OwnCapability","type":"string"},"OwnUserResponse":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"banned":{"type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"015"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.011"},"devices":{"items":{"$ref":"#/components/schemas/DeviceResponse"},"title":"Devices","type":"array","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001.001"},"image":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"005"},"language":{"type":"string","x-stream-index":"001.005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"001.014"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"013"},"mutes":{"items":{"$ref":"#/components/schemas/UserMuteResponse"},"type":"array","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"001.002"},"online":{"type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"003"},"push_preferences":{"$ref":"#/components/schemas/PushPreferences","x-stream-index":"002"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.015"},"role":{"type":"string","x-stream-index":"001.006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"009"},"total_unread_count_by_team":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"010"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"011"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"008"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"012"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","devices","invisible","mutes","channel_mutes","unread_count","total_unread_count","unread_channels","unread_threads"],"type":"object"},"ParticipantCountByMinuteResponse":{"nullable":true,"properties":{"first":{"format":"int32","type":"integer","x-stream-index":"002"},"last":{"format":"int32","type":"integer","x-stream-index":"003"},"max":{"format":"int32","type":"integer","x-stream-index":"004"},"min":{"format":"int32","type":"integer","x-stream-index":"005"},"start_ts":{"format":"date-time","type":"number","x-stream-index":"001"}},"required":["start_ts","first","last","max","min"],"type":"object"},"ParticipantCountOverTimeResponse":{"properties":{"by_minute":{"items":{"$ref":"#/components/schemas/ParticipantCountByMinuteResponse"},"type":"array","x-stream-index":"001"}},"type":"object"},"ParticipantReportResponse":{"properties":{"by_browser":{"items":{"$ref":"#/components/schemas/GroupedStatsResponse"},"type":"array","x-stream-index":"008"},"by_country":{"items":{"$ref":"#/components/schemas/GroupedStatsResponse"},"type":"array","x-stream-index":"005"},"by_device":{"items":{"$ref":"#/components/schemas/GroupedStatsResponse"},"type":"array","x-stream-index":"006"},"by_operating_system":{"items":{"$ref":"#/components/schemas/GroupedStatsResponse"},"type":"array","x-stream-index":"007"},"count_over_time":{"$ref":"#/components/schemas/ParticipantCountOverTimeResponse","x-stream-index":"004"},"max_concurrent":{"format":"int32","type":"integer","x-stream-index":"003"},"publishers":{"$ref":"#/components/schemas/PublisherStatsResponse","x-stream-index":"009"},"subscribers":{"$ref":"#/components/schemas/SubscriberStatsResponse","x-stream-index":"010"},"sum":{"format":"int32","type":"integer","x-stream-index":"001"},"unique":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["sum","unique"],"type":"object"},"PerSDKUsageReport":{"nullable":true,"properties":{"by_version":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"002"},"total":{"format":"int32","type":"integer","x-stream-index":"001"}},"required":["total","by_version"],"type":"object"},"PermissionRequestEvent":{"description":"This event is sent when a user requests access to a feature on a call,\nclients receiving this event should display a permission request to the user","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"permissions":{"description":"The list of permissions requested by the user","items":{"type":"string"},"title":"Permissions","type":"array","x-stream-index":"004"},"type":{"default":"call.permission_request","description":"The type of event: \"call.permission_request\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who sent the permission request","title":"User","x-stream-index":"003"}},"required":["type","created_at","call_cid","user","permissions"],"title":"PermissionRequestEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"PinRequest":{"description":"PinRequest is the payload for pinning a message.","nullable":true,"properties":{"session_id":{"description":"the session ID of the user who pinned the message","title":"SessionID","type":"string","x-stream-index":"003"},"user_id":{"description":"the user ID of the user who pinned the message","title":"UserID","type":"string","x-stream-index":"002"}},"required":["user_id","session_id"],"title":"PinRequest","type":"object"},"PinResponse":{"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"},"Poll":{"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"023"},"allow_answers":{"type":"boolean","x-stream-index":"010"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"009"},"answers_count":{"format":"int32","type":"integer","x-stream-index":"015"},"created_at":{"format":"date-time","type":"number","x-stream-index":"021"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"020"},"created_by_id":{"type":"string","x-stream-index":"019"},"description":{"type":"string","x-stream-index":"005"},"enforce_unique_vote":{"type":"boolean","x-stream-index":"007"},"id":{"type":"string","x-stream-index":"003"},"is_closed":{"type":"boolean","x-stream-index":"011"},"latest_answers":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array","x-stream-index":"017"},"latest_votes_by_option":{"additionalProperties":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array"},"type":"object","x-stream-index":"016"},"max_votes_allowed":{"format":"int32","type":"integer","x-stream-index":"008"},"name":{"type":"string","x-stream-index":"004"},"options":{"items":{"$ref":"#/components/schemas/PollOption"},"type":"array","x-stream-index":"013"},"own_votes":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array","x-stream-index":"018"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"022"},"vote_count":{"format":"int32","type":"integer","x-stream-index":"012"},"vote_counts_by_option":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"014"},"voting_visibility":{"type":"string","x-stream-index":"006"}},"required":["id","name","description","enforce_unique_vote","allow_user_suggested_options","allow_answers","vote_count","options","vote_counts_by_option","answers_count","latest_votes_by_option","latest_answers","own_votes","created_by_id","created_at","updated_at","Custom"],"type":"object"},"PollOption":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id","text","custom"],"type":"object"},"PollOptionInput":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"text":{"type":"string","x-stream-index":"002"}},"type":"object"},"PollOptionRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id"],"type":"object"},"PollOptionResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"poll_option":{"$ref":"#/components/schemas/PollOptionResponseData","description":"Poll option","title":"PollOptionResponseData","x-stream-index":"001"}},"required":["poll_option","duration"],"type":"object"},"PollOptionResponseData":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id","text","custom"],"type":"object"},"PollResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"poll":{"$ref":"#/components/schemas/PollResponseData","description":"Poll","title":"PollResponseData","x-stream-index":"001"}},"required":["poll","duration"],"type":"object"},"PollResponseData":{"properties":{"allow_answers":{"type":"boolean","x-stream-index":"008"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"007"},"answers_count":{"format":"int32","type":"integer","x-stream-index":"012"},"created_at":{"format":"date-time","type":"number","x-stream-index":"019"},"created_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"018"},"created_by_id":{"type":"string","x-stream-index":"017"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"021"},"description":{"type":"string","x-stream-index":"003"},"enforce_unique_vote":{"type":"boolean","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"is_closed":{"type":"boolean","x-stream-index":"009"},"latest_answers":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array","x-stream-index":"015"},"latest_votes_by_option":{"additionalProperties":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array"},"type":"object","x-stream-index":"014"},"max_votes_allowed":{"format":"int32","type":"integer","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"002"},"options":{"items":{"$ref":"#/components/schemas/PollOptionResponseData"},"type":"array","x-stream-index":"011"},"own_votes":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array","x-stream-index":"016"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"020"},"vote_count":{"format":"int32","type":"integer","x-stream-index":"010"},"vote_counts_by_option":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"013"},"voting_visibility":{"type":"string","x-stream-index":"004"}},"required":["id","name","description","voting_visibility","enforce_unique_vote","allow_user_suggested_options","allow_answers","vote_count","options","answers_count","vote_counts_by_option","latest_votes_by_option","latest_answers","own_votes","created_by_id","created_at","updated_at","custom"],"type":"object"},"PollVote":{"nullable":true,"properties":{"answer_text":{"type":"string","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"004"},"is_answer":{"type":"boolean","x-stream-index":"006"},"option_id":{"type":"string","x-stream-index":"005"},"poll_id":{"type":"string","x-stream-index":"003"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"011"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"009"},"user_id":{"type":"string","x-stream-index":"008"}},"required":["poll_id","id","option_id","created_at","updated_at"],"type":"object"},"PollVoteResponseData":{"nullable":true,"properties":{"answer_text":{"type":"string","x-stream-index":"005"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"id":{"type":"string","x-stream-index":"002"},"is_answer":{"type":"boolean","x-stream-index":"004"},"option_id":{"type":"string","x-stream-index":"003"},"poll_id":{"type":"string","x-stream-index":"001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"007"},"user_id":{"type":"string","x-stream-index":"006"}},"required":["poll_id","id","option_id","created_at","updated_at"],"type":"object"},"PollVotesResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"votes":{"description":"Poll votes","items":{"$ref":"#/components/schemas/PollVoteResponseData"},"title":"PollVoteResponseList","type":"array","x-stream-index":"001"}},"required":["votes","duration"],"type":"object"},"PrivacySettings":{"properties":{"read_receipts":{"$ref":"#/components/schemas/ReadReceipts","x-stream-index":"002"},"typing_indicators":{"$ref":"#/components/schemas/TypingIndicators","x-stream-index":"001"}},"type":"object"},"PrivacySettingsResponse":{"properties":{"read_receipts":{"$ref":"#/components/schemas/ReadReceiptsResponse","x-stream-index":"002"},"typing_indicators":{"$ref":"#/components/schemas/TypingIndicatorsResponse","x-stream-index":"001"}},"type":"object"},"PublisherStatsResponse":{"properties":{"by_track":{"items":{"$ref":"#/components/schemas/TrackStatsResponse"},"type":"array","x-stream-index":"003"},"total":{"format":"int32","type":"integer","x-stream-index":"001"},"unique":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["total","unique"],"type":"object"},"PushPreferences":{"properties":{"call_level":{"type":"string","x-stream-index":"002"},"chat_level":{"type":"string","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"number","x-stream-index":"005"},"feeds_events":{"$ref":"#/components/schemas/FeedsEventPreferences","x-stream-index":"004"},"feeds_level":{"type":"string","x-stream-index":"003"}},"type":"object"},"QualityScoreReport":{"properties":{"histogram":{"items":{"$ref":"#/components/schemas/ReportByHistogramBucket"},"type":"array","x-stream-index":"001"}},"required":["histogram"],"type":"object"},"QualityScoreReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateQualityScoreReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"QueryAggregateCallStatsRequest":{"nullable":true,"properties":{"from":{"type":"string","x-stream-index":"002"},"report_types":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"to":{"type":"string","x-stream-index":"003"}},"type":"object"},"QueryAggregateCallStatsResponse":{"description":"Basic response information","nullable":true,"properties":{"call_duration_report":{"$ref":"#/components/schemas/CallDurationReportResponse","x-stream-index":"002"},"call_participant_count_report":{"$ref":"#/components/schemas/CallParticipantCountReportResponse","x-stream-index":"004"},"calls_per_day_report":{"$ref":"#/components/schemas/CallsPerDayReportResponse","x-stream-index":"003"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"network_metrics_report":{"$ref":"#/components/schemas/NetworkMetricsReportResponse","x-stream-index":"008"},"quality_score_report":{"$ref":"#/components/schemas/QualityScoreReportResponse","x-stream-index":"005"},"sdk_usage_report":{"$ref":"#/components/schemas/SDKUsageReportResponse","x-stream-index":"006"},"user_feedback_report":{"$ref":"#/components/schemas/UserFeedbackReportResponse","x-stream-index":"007"}},"required":["duration"],"title":"Response","type":"object"},"QueryCallMembersRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"002"},"id":{"maxLength":64,"type":"string","x-stream-index":"001.002"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"004.001"},"next":{"type":"string","x-stream-index":"004.002"},"prev":{"type":"string","x-stream-index":"004.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":1,"type":"array","x-stream-index":"003"},"type":{"maxLength":64,"type":"string","x-stream-index":"001.001"}},"required":["type","id"],"type":"object"},"QueryCallMembersResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["members","duration"],"title":"Response","type":"object"},"QueryCallParticipantsRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"003"}},"type":"object"},"QueryCallParticipantsResponse":{"nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001.001"},"duration":{"type":"string","x-stream-index":"004.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001.002"},"membership":{"$ref":"#/components/schemas/MemberResponse","x-stream-index":"001.003"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"001.004"},"participants":{"description":"List of call participants","items":{"$ref":"#/components/schemas/CallParticipantResponse"},"title":"[]CallParticipantResponse","type":"array","x-stream-index":"002"},"total_participants":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["call","members","own_capabilities","blocked_users","participants","total_participants","duration"],"type":"object"},"QueryCallStatsRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"004.001"},"next":{"type":"string","x-stream-index":"004.002"},"prev":{"type":"string","x-stream-index":"004.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":2,"type":"array","x-stream-index":"002"}},"type":"object"},"QueryCallStatsResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"next":{"type":"string","x-stream-index":"003.001"},"prev":{"type":"string","x-stream-index":"003.002"},"reports":{"items":{"$ref":"#/components/schemas/CallStatsReportSummaryResponse"},"type":"array","x-stream-index":"001"}},"required":["reports","duration"],"title":"Response","type":"object"},"QueryCallsRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"title":"Filters","type":"object","x-stream-index":"003"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"006.001"},"next":{"type":"string","x-stream-index":"006.002"},"prev":{"type":"string","x-stream-index":"006.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":2,"title":"Sort","type":"array","x-stream-index":"004"},"watch":{"title":"Watch","type":"boolean","x-stream-index":"001"}},"title":"QueryCallsRequest","type":"object"},"QueryCallsResponse":{"nullable":true,"properties":{"calls":{"items":{"$ref":"#/components/schemas/CallStateResponseFields"},"title":"Calls","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["calls","duration"],"title":"QueryCallsResponse","type":"object"},"QueryPollVotesRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","title":"Filter","type":"object","x-stream-index":"003"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"004"}},"type":"object"},"QueryPollsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","title":"Filter","type":"object","x-stream-index":"002"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"003"}},"type":"object"},"QueryPollsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"polls":{"description":"Polls data returned by the query","items":{"$ref":"#/components/schemas/PollResponseData"},"title":"PollsResponseData","type":"array","x-stream-index":"001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["polls","duration"],"type":"object"},"QueryUsersPayload":{"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"include_deactivated_users":{"type":"boolean","x-stream-index":"004"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.003"},"offset":{"format":"int32","maximum":1000,"type":"integer","x-stream-index":"005.004"},"presence":{"type":"boolean","x-stream-index":"003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"type":"array","x-stream-index":"002"}},"required":["filter_conditions"],"type":"object"},"QueryUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"users":{"description":"Array of users as result of filters applied.","items":{"$ref":"#/components/schemas/FullUserResponse"},"title":"Users","type":"array","x-stream-index":"001"}},"required":["users","duration"],"type":"object"},"RTMPBroadcastRequest":{"description":"RTMPBroadcastRequest is the payload for starting an RTMP broadcast.","properties":{"layout":{"$ref":"#/components/schemas/LayoutSettingsRequest","description":"If provided, will override the call's RTMP settings layout","title":"Layout","x-stream-index":"005"},"name":{"description":"Name identifier for RTMP broadcast, must be unique in call","maxLength":255,"title":"Name","type":"string","x-stream-index":"001"},"quality":{"description":"If provided, will override the call's RTMP settings quality","enum":["360p","480p","720p","1080p","1440p","portrait-360x640","portrait-480x854","portrait-720x1280","portrait-1080x1920","portrait-1440x2560"],"title":"Quality","type":"string","x-stream-index":"004"},"stream_key":{"description":"If provided, will be appended at the end of stream_url","title":"Stream Key","type":"string","x-stream-index":"003"},"stream_url":{"description":"URL for the RTMP server to send the call to","maxLength":255,"title":"Stream URL","type":"string","x-stream-index":"002"}},"required":["name","stream_url"],"title":"RTMPBroadcastRequest","type":"object"},"RTMPIngress":{"description":"RTMP input settings","properties":{"address":{"title":"Address","type":"string","x-stream-index":"001"}},"required":["address"],"title":"RTMPIngress","type":"object"},"RTMPSettingsRequest":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"quality":{"description":"Resolution to set for the RTMP stream","enum":["360p","480p","720p","1080p","1440p","portrait-360x640","portrait-480x854","portrait-720x1280","portrait-1080x1920","portrait-1440x2560"],"title":"Quality","type":"string","x-stream-index":"002"}},"title":"RTMPSettingsRequest","type":"object"},"RTMPSettingsResponse":{"description":"RTMPSettingsResponse is the payload for RTMP settings","properties":{"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"001"},"quality":{"title":"Quality","type":"string","x-stream-index":"002"}},"required":["enabled","quality","layout"],"title":"RTMPSettingsResponse","type":"object"},"Reaction":{"nullable":true,"properties":{"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"message_id":{"type":"string","x-stream-index":"003"},"score":{"format":"int32","type":"integer","x-stream-index":"007"},"type":{"maxLength":30,"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["message_id","type","score","created_at","updated_at","custom"],"type":"object"},"ReactionGroupResponse":{"description":"ReactionGroupResponse contains all information about a reaction of the same type.","nullable":true,"properties":{"count":{"description":"Count is the number of reactions of this type.","format":"int32","title":"Count","type":"integer","x-stream-index":"001"},"first_reaction_at":{"description":"FirstReactionAt is the time of the first reaction of this type. This is the same also if all reaction of this type are deleted, because if someone will react again with the same type, will be preserved the sorting.","format":"date-time","title":"FirstReactionAt","type":"number","x-stream-index":"003"},"last_reaction_at":{"description":"LastReactionAt is the time of the last reaction of this type.","format":"date-time","title":"LastReactionAt","type":"number","x-stream-index":"004"},"sum_scores":{"description":"SumScores is the sum of all scores of reactions of this type. Medium allows you to clap articles more than once and shows the sum of all claps from all users. For example, you can send `clap` x5 using `score: 5`.","format":"int32","title":"SumScores","type":"integer","x-stream-index":"002"}},"required":["count","sum_scores","first_reaction_at","last_reaction_at"],"title":"ReactionGroupResponse","type":"object"},"ReactionResponse":{"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"006"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"008"},"message_id":{"description":"Message ID","title":"Message ID","type":"string","x-stream-index":"001"},"score":{"description":"Score of the reaction","format":"int32","title":"Score","type":"integer","x-stream-index":"005"},"type":{"description":"Type of reaction","title":"Type","type":"string","x-stream-index":"004"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"007"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User","title":"UserResponse","x-stream-index":"003"},"user_id":{"description":"User ID","title":"User ID","type":"string","x-stream-index":"002"}},"required":["message_id","user_id","user","type","score","created_at","updated_at","custom"],"type":"object"},"ReadReceipts":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"ReadReceiptsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"RecordSettingsRequest":{"properties":{"audio_only":{"type":"boolean","x-stream-index":"001"},"mode":{"enum":["available","disabled","auto-on"],"title":"Mode","type":"string","x-stream-index":"002"},"quality":{"enum":["360p","480p","720p","1080p","1440p","portrait-360x640","portrait-480x854","portrait-720x1280","portrait-1080x1920","portrait-1440x2560"],"type":"string","x-stream-index":"003"}},"required":["mode"],"title":"RecordSettingsRequest","type":"object"},"RecordSettingsResponse":{"description":"RecordSettings is the payload for recording settings","properties":{"audio_only":{"title":"Audio Only","type":"boolean","x-stream-index":"001"},"mode":{"title":"Mode","type":"string","x-stream-index":"002"},"quality":{"title":"Quality","type":"string","x-stream-index":"003"}},"required":["audio_only","mode","quality","layout"],"title":"RecordSettingsResponse","type":"object"},"RejectCallRequest":{"nullable":true,"properties":{"reason":{"description":"Reason for rejecting the call","title":"Reason","type":"string","x-stream-index":"003"}},"title":"RejectCallRequest","type":"object"},"RejectCallResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"RejectCallResponse","type":"object"},"ReminderResponseData":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003"},"channel_cid":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"005"},"message_id":{"type":"string","x-stream-index":"004"},"remind_at":{"format":"date-time","type":"number","x-stream-index":"001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007"},"user_id":{"type":"string","x-stream-index":"006"}},"required":["channel_cid","message_id","user_id","created_at","updated_at"],"type":"object"},"ReportByHistogramBucket":{"properties":{"category":{"type":"string","x-stream-index":"001"},"count":{"format":"int32","type":"integer","x-stream-index":"005"},"lower_bound":{"$ref":"#/components/schemas/Bound","x-stream-index":"002"},"sum":{"format":"float","type":"number","x-stream-index":"004"},"upper_bound":{"$ref":"#/components/schemas/Bound","x-stream-index":"003"}},"required":["category","sum","count"],"type":"object"},"ReportResponse":{"properties":{"call":{"$ref":"#/components/schemas/CallReportResponse","x-stream-index":"003"},"participants":{"$ref":"#/components/schemas/ParticipantReportResponse","x-stream-index":"001"},"user_ratings":{"$ref":"#/components/schemas/UserRatingReportResponse","x-stream-index":"002"}},"required":["participants","user_ratings","call"],"type":"object"},"RequestPermissionRequest":{"nullable":true,"properties":{"permissions":{"items":{"type":"string"},"title":"Permissions","type":"array","x-stream-index":"003"}},"required":["permissions"],"title":"RequestPermissionRequest","type":"object"},"RequestPermissionResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"RequestPermissionResponse","type":"object"},"Response":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001"}},"required":["duration"],"title":"Response","type":"object"},"RingSettingsRequest":{"properties":{"auto_cancel_timeout_ms":{"description":"When none of the callees accept a ring call in this time a rejection will be sent by the caller with reason 'timeout' by the SDKs","format":"int32","maximum":180000,"minimum":5000,"title":"AutoCancelTimeoutMs","type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"description":"When a callee is online but doesn't answer a ring call in this time a rejection will be sent with reason 'timeout' by the SDKs","format":"int32","maximum":180000,"minimum":5000,"title":"IncomingCallTimeoutMs","type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"description":"When a callee doesn't accept or reject a ring call in this time a missed call event will be sent","format":"int32","maximum":180000,"minimum":5000,"title":"MissedCallTimeoutMs","type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_timeout_ms"],"title":"RingSettingsRequest","type":"object"},"RingSettingsResponse":{"properties":{"auto_cancel_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_timeout_ms","missed_call_timeout_ms"],"type":"object"},"SDKUsageReport":{"properties":{"per_sdk_usage":{"additionalProperties":{"$ref":"#/components/schemas/PerSDKUsageReport"},"type":"object","x-stream-index":"001"}},"required":["per_sdk_usage"],"type":"object"},"SDKUsageReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateSDKUsageReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"SFUResponse":{"properties":{"edge_name":{"type":"string","x-stream-index":"001"},"url":{"type":"string","x-stream-index":"002"},"ws_endpoint":{"type":"string","x-stream-index":"003"}},"required":["edge_name","url","ws_endpoint"],"type":"object"},"ScreensharingSettingsRequest":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"type":"object"},"ScreensharingSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled"],"type":"object"},"SendCallEventRequest":{"description":"Send a call event to the other user","nullable":true,"properties":{"custom":{"additionalProperties":{},"title":"Custom","type":"object","x-stream-index":"004"}},"title":"SendCallEventRequest","type":"object"},"SendCallEventResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"SendCallEventResponse","type":"object"},"SendReactionRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.003"},"emoji_code":{"type":"string","x-stream-index":"003.002"},"type":{"maxLength":64,"type":"string","x-stream-index":"003.001"}},"required":["type"],"type":"object"},"SendReactionResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"reaction":{"$ref":"#/components/schemas/ReactionResponse","x-stream-index":"001"}},"required":["reaction","duration"],"title":"Response","type":"object"},"SessionSettingsRequest":{"properties":{"inactivity_timeout_seconds":{"format":"int32","maximum":900,"minimum":5,"type":"integer","x-stream-index":"001"}},"required":["inactivity_timeout_seconds"],"type":"object"},"SessionSettingsResponse":{"properties":{"inactivity_timeout_seconds":{"format":"int32","maximum":900,"minimum":5,"type":"integer","x-stream-index":"001"}},"required":["inactivity_timeout_seconds"],"type":"object"},"SharedLocation":{"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"013"},"channel_cid":{"type":"string","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"010"},"created_by_device_id":{"type":"string","x-stream-index":"008"},"end_at":{"format":"date-time","type":"number","x-stream-index":"009"},"latitude":{"format":"float","maximum":90,"minimum":18446744073709552000,"type":"number","x-stream-index":"006"},"longitude":{"format":"float","maximum":180,"minimum":18446744073709552000,"type":"number","x-stream-index":"007"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"012"},"message_id":{"type":"string","x-stream-index":"004"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"011"},"user_id":{"type":"string","x-stream-index":"005"}},"required":["channel_cid","message_id","user_id","created_by_device_id","created_at","updated_at"],"type":"object"},"SharedLocationResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001.011"},"channel_cid":{"description":"Channel CID","title":"string","type":"string","x-stream-index":"001.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.008"},"created_by_device_id":{"description":"Device ID that created the live location","title":"string","type":"string","x-stream-index":"001.006"},"duration":{"type":"string","x-stream-index":"002.001"},"end_at":{"description":"Time when the live location expires","format":"date-time","title":"string","type":"number","x-stream-index":"001.007"},"latitude":{"description":"Latitude coordinate","format":"float","title":"number","type":"number","x-stream-index":"001.004"},"longitude":{"description":"Longitude coordinate","format":"float","title":"number","type":"number","x-stream-index":"001.005"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001.010"},"message_id":{"description":"Message ID","title":"string","type":"string","x-stream-index":"001.002"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.009"},"user_id":{"description":"User ID","title":"string","type":"string","x-stream-index":"001.003"}},"required":["channel_cid","message_id","user_id","latitude","longitude","created_by_device_id","created_at","updated_at","duration"],"type":"object"},"SharedLocationResponseData":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"011"},"channel_cid":{"type":"string","x-stream-index":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"created_by_device_id":{"type":"string","x-stream-index":"006"},"end_at":{"format":"date-time","type":"number","x-stream-index":"007"},"latitude":{"format":"float","type":"number","x-stream-index":"004"},"longitude":{"format":"float","type":"number","x-stream-index":"005"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"010"},"message_id":{"type":"string","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["channel_cid","message_id","user_id","latitude","longitude","created_by_device_id","created_at","updated_at"],"type":"object"},"SharedLocationsResponse":{"nullable":true,"properties":{"active_live_locations":{"items":{"$ref":"#/components/schemas/SharedLocationResponseData"},"type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["active_live_locations","duration"],"type":"object"},"SortParamRequest":{"nullable":true,"properties":{"direction":{"description":"Direction of sorting, 1 for Ascending, -1 for Descending, default is 1","format":"int32","title":"Direction","type":"integer","x-stream-index":"002"},"field":{"description":"Name of field to sort by","title":"Field","type":"string","x-stream-index":"001"}},"type":"object"},"StartClosedCaptionsRequest":{"nullable":true,"properties":{"enable_transcription":{"description":"Enable transcriptions along with closed captions","title":"Enable Transcription","type":"boolean","x-stream-index":"002"},"external_storage":{"description":"Which external storage to use for transcriptions (only applicable if enable_transcription is true)","title":"External Storage","type":"string","x-stream-index":"003"},"language":{"description":"The spoken language in the call, if not provided the language defined in the transcription settings will be used","enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"title":"Language","type":"string","x-stream-index":"004"}},"type":"object"},"StartClosedCaptionsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"StartFrameRecordingRequest":{"nullable":true,"properties":{"recording_external_storage":{"type":"string","x-stream-index":"002"}},"title":"StartFrameRecordingRequest","type":"object"},"StartFrameRecordingResponse":{"description":"StartFrameRecordingResponse is the response payload for the start frame recording endpoint.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StartFrameRecordingResponse","type":"object"},"StartHLSBroadcastingRequest":{"description":"StartHLSBroadcastingRequest is the payload for starting an HLS broadcasting.","nullable":true,"title":"StartHLSBroadcastingRequest","type":"object"},"StartHLSBroadcastingResponse":{"description":"StartHLSBroadcastingResponse is the payload for starting an HLS broadcasting.","nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"},"playlist_url":{"description":"the URL of the HLS playlist","title":"PlaylistURL","type":"string","x-stream-index":"002"}},"required":["duration","playlist_url"],"title":"StartHLSBroadcastingResponse","type":"object"},"StartRTMPBroadcastsRequest":{"description":"StartRTMPBroadcastsRequest is the payload for starting RTMP broadcasts.","nullable":true,"properties":{"broadcasts":{"description":"List of broadcasts to start","items":{"$ref":"#/components/schemas/RTMPBroadcastRequest"},"maximum":1,"minimum":1,"title":"Broadcasts","type":"array","x-stream-index":"002"}},"required":["broadcasts"],"title":"StartRTMPBroadcastsRequest","type":"object"},"StartRTMPBroadcastsResponse":{"description":"StartRTMPBroadcastsResponse is the payload for starting an RTMP broadcast.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StartRTMPBroadcastsResponse","type":"object"},"StartRecordingRequest":{"nullable":true,"properties":{"recording_external_storage":{"type":"string","x-stream-index":"002"}},"title":"StartRecordingRequest","type":"object"},"StartRecordingResponse":{"description":"StartRecordingResponse is the response payload for the start recording endpoint.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StartRecordingResponse","type":"object"},"StartTranscriptionRequest":{"nullable":true,"properties":{"enable_closed_captions":{"description":"Enable closed captions along with transcriptions","title":"Enable Closed Captions","type":"boolean","x-stream-index":"003"},"language":{"description":"The spoken language in the call, if not provided the language defined in the transcription settings will be used","enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"title":"Language","type":"string","x-stream-index":"004"},"transcription_external_storage":{"description":"Store transcriptions in this external storage","title":"External Storage","type":"string","x-stream-index":"002"}},"type":"object"},"StartTranscriptionResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StartTranscriptionResponse","type":"object"},"StatsOptions":{"properties":{"enable_rtc_stats":{"type":"boolean","x-stream-index":"002"},"reporting_interval_ms":{"format":"int32","type":"integer","x-stream-index":"001"}},"required":["reporting_interval_ms","enable_rtc_stats"],"type":"object"},"StopAllRTMPBroadcastsRequest":{"nullable":true,"title":"StopAllRTMPBroadcastsRequest","type":"object"},"StopAllRTMPBroadcastsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StopAllRTMPBroadcastsResponse","type":"object"},"StopClosedCaptionsRequest":{"nullable":true,"properties":{"stop_transcription":{"type":"boolean","x-stream-index":"003"}},"type":"object"},"StopClosedCaptionsResponse":{"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"},"StopFrameRecordingRequest":{"nullable":true,"type":"object"},"StopFrameRecordingResponse":{"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"},"StopHLSBroadcastingRequest":{"nullable":true,"type":"object"},"StopHLSBroadcastingResponse":{"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"},"StopLiveRequest":{"nullable":true,"properties":{"continue_closed_caption":{"type":"boolean","x-stream-index":"006"},"continue_hls":{"type":"boolean","x-stream-index":"003"},"continue_recording":{"type":"boolean","x-stream-index":"004"},"continue_rtmp_broadcasts":{"type":"boolean","x-stream-index":"007"},"continue_transcription":{"type":"boolean","x-stream-index":"005"}},"title":"StopLiveRequest","type":"object"},"StopLiveResponse":{"nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"The call that was stopped","title":"Call","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["call","duration"],"title":"StopLiveResponse","type":"object"},"StopRTMPBroadcastsRequest":{"description":"Request for stopping RTMP broadcasts","nullable":true,"title":"StopRTMPBroadcastsRequest","type":"object"},"StopRTMPBroadcastsResponse":{"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"},"StopRecordingRequest":{"nullable":true,"type":"object"},"StopRecordingResponse":{"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"},"StopTranscriptionRequest":{"nullable":true,"properties":{"stop_closed_captions":{"type":"boolean","x-stream-index":"003"}},"type":"object"},"StopTranscriptionResponse":{"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"},"SubscriberStatsResponse":{"properties":{"total":{"format":"int32","type":"integer","x-stream-index":"001"},"total_subscribed_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"003"},"unique":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["total","unique","total_subscribed_duration_seconds"],"type":"object"},"TargetResolution":{"properties":{"bitrate":{"format":"int32","maximum":6000000,"type":"integer","x-stream-index":"003"},"height":{"format":"int32","maximum":3840,"minimum":240,"type":"integer","x-stream-index":"002"},"width":{"format":"int32","maximum":3840,"minimum":240,"type":"integer","x-stream-index":"001"}},"required":["width","height"],"type":"object"},"Thresholds":{"description":"Sets thresholds for AI moderation","properties":{"explicit":{"$ref":"#/components/schemas/LabelThresholds","description":"Thresholds for explicit messages","title":"LabelThresholds","x-stream-index":"001"},"spam":{"$ref":"#/components/schemas/LabelThresholds","description":"Thresholds for spam","title":"LabelThresholds","x-stream-index":"002"},"toxic":{"$ref":"#/components/schemas/LabelThresholds","description":"Thresholds for toxic messages","title":"LabelThresholds","x-stream-index":"003"}},"title":"Auto moderation thresholds","type":"object"},"ThumbnailResponse":{"properties":{"image_url":{"type":"string","x-stream-index":"001"}},"required":["image_url"],"type":"object"},"ThumbnailsSettingsRequest":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"ThumbnailsSettingsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"TrackStatsResponse":{"nullable":true,"properties":{"duration_seconds":{"format":"int32","type":"integer","x-stream-index":"002"},"track_type":{"type":"string","x-stream-index":"001"}},"required":["track_type","duration_seconds"],"type":"object"},"TranscriptionSettingsRequest":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"002"},"language":{"enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"type":"string","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode"],"type":"object"},"TranscriptionSettingsResponse":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"002"},"language":{"enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"type":"string","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode","closed_caption_mode","languages","language"],"type":"object"},"TypingIndicators":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"TypingIndicatorsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"UnblockUserRequest":{"description":"UnblockUserRequest is the payload for unblocking a user.","nullable":true,"properties":{"user_id":{"description":"the user to unblock","title":"UserID","type":"string","x-stream-index":"003"}},"required":["user_id"],"title":"UnblockUserRequest","type":"object"},"UnblockUserResponse":{"description":"UnblockUserResponse is the payload for unblocking a user.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"UnblockUserResponse","type":"object"},"UnblockUsersRequest":{"nullable":true,"properties":{"blocked_user_id":{"type":"string","x-stream-index":"001"}},"required":["blocked_user_id"],"type":"object"},"UnblockUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"UnblockedUserEvent":{"description":"This event is sent when a user is unblocked on a call,\nthis can be useful to notify the user that they can now join the call again","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.unblocked_user","description":"The type of event: \"call.unblocked_user\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user that was unblocked","title":"User","x-stream-index":"003"}},"required":["type","created_at","call_cid","user"],"title":"UnblockedUserEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"UnpinRequest":{"description":"UnpinRequest is the payload for unpinning a message.","nullable":true,"properties":{"session_id":{"description":"the session ID of the user who pinned the message","title":"SessionID","type":"string","x-stream-index":"003"},"user_id":{"description":"the user ID of the user who pinned the message","title":"UserID","type":"string","x-stream-index":"002"}},"required":["user_id","session_id"],"title":"UnpinRequest","type":"object"},"UnpinResponse":{"description":"UnpinResponse is the payload for unpinning a message.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"UnpinResponse","type":"object"},"UpdateBlockListRequest":{"nullable":true,"properties":{"team":{"type":"string","x-stream-index":"002"},"words":{"description":"List of words to block","items":{"type":"string"},"minimum":1,"title":"Words","type":"array","x-stream-index":"003"}},"title":"Update block list","type":"object","x-stream-docs-page-id":"update_block_list"},"UpdateBlockListResponse":{"description":"Basic response information","nullable":true,"properties":{"blocklist":{"$ref":"#/components/schemas/BlockListResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["duration"],"title":"Response","type":"object"},"UpdateCallMembersRequest":{"description":"Update call members","nullable":true,"properties":{"remove_members":{"description":"List of userID to remove","items":{"type":"string"},"maximum":100,"title":"Remove Members","type":"array","x-stream-index":"003"},"update_members":{"description":"List of members to update or insert","items":{"$ref":"#/components/schemas/MemberRequest"},"maximum":100,"title":"Update Members","type":"array","x-stream-index":"004"}},"title":"UpdateCallMembersRequest","type":"object"},"UpdateCallMembersResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"002"}},"required":["duration","members"],"title":"Response","type":"object"},"UpdateCallRequest":{"description":"Request for updating a call","nullable":true,"properties":{"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"003"},"settings_override":{"$ref":"#/components/schemas/CallSettingsRequest","description":"the settings to change for this call","title":"Settings Override","x-stream-index":"004"},"starts_at":{"description":"the time the call is scheduled to start","format":"date-time","title":"Starts At","type":"number","x-stream-index":"005"}},"title":"UpdateCallRequest","type":"object"},"UpdateCallResponse":{"description":"Response for updating a call","nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001.001"},"duration":{"type":"string","x-stream-index":"002.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001.002"},"membership":{"$ref":"#/components/schemas/MemberResponse","x-stream-index":"001.003"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"001.004"}},"required":["call","members","own_capabilities","blocked_users","duration"],"title":"UpdateCallResponse","type":"object"},"UpdateLiveLocationRequest":{"nullable":true,"properties":{"end_at":{"description":"Time when the live location expires","format":"date-time","title":"string","type":"number","x-stream-index":"004"},"latitude":{"description":"Latitude coordinate","format":"float","maximum":90,"minimum":18446744073709552000,"title":"number","type":"number","x-stream-index":"002"},"longitude":{"description":"Longitude coordinate","format":"float","maximum":180,"minimum":18446744073709552000,"title":"number","type":"number","x-stream-index":"003"},"message_id":{"description":"Live location ID","title":"string","type":"string","x-stream-index":"001"}},"required":["message_id"],"type":"object"},"UpdatePollOptionRequest":{"nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"004"},"id":{"description":"Option ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"},"text":{"description":"Option text","title":"string","type":"string","x-stream-index":"003"}},"required":["id","text"],"type":"object"},"UpdatePollPartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"description":"Sets new field values","title":"Set","type":"object","x-stream-index":"002.001","x-stream-map":{"key":"field","title":"Value","description":"New value to set"}},"unset":{"description":"Array of field names to unset","items":{"type":"string"},"title":"Unset","type":"array","x-stream-index":"002.002"}},"type":"object"},"UpdatePollRequest":{"nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"011"},"allow_answers":{"description":"Allow answers","title":"boolean","type":"boolean","x-stream-index":"009"},"allow_user_suggested_options":{"description":"Allow user suggested options","title":"boolean","type":"boolean","x-stream-index":"008"},"description":{"description":"Poll description","title":"string","type":"string","x-stream-index":"003"},"enforce_unique_vote":{"description":"Enforce unique vote","title":"boolean","type":"boolean","x-stream-index":"005"},"id":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"},"is_closed":{"description":"Is closed","title":"boolean","type":"boolean","x-stream-index":"010"},"max_votes_allowed":{"description":"Max votes allowed","format":"int32","maximum":10,"title":"integer","type":"integer","x-stream-index":"007"},"name":{"description":"Poll name","title":"string","type":"string","x-stream-index":"002"},"options":{"description":"Poll options","items":{"$ref":"#/components/schemas/PollOptionRequest"},"maximum":100,"title":"PollOptions","type":"array","x-stream-index":"004"},"voting_visibility":{"description":"Voting visibility","enum":["anonymous","public"],"title":"string","type":"string","x-stream-index":"006"}},"required":["id","name"],"type":"object"},"UpdateUserPartialRequest":{"properties":{"id":{"description":"User ID to update","title":"ID","type":"string","x-stream-index":"001"},"set":{"additionalProperties":{},"type":"object","x-stream-index":"002.001"},"unset":{"items":{"type":"string"},"type":"array","x-stream-index":"002.002"}},"required":["id"],"type":"object"},"UpdateUserPermissionsRequest":{"nullable":true,"properties":{"grant_permissions":{"items":{"type":"string"},"type":"array","x-stream-index":"002"},"revoke_permissions":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"user_id":{"type":"string","x-stream-index":"001"}},"required":["user_id"],"type":"object"},"UpdateUserPermissionsResponse":{"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"},"UpdateUsersPartialRequest":{"nullable":true,"properties":{"users":{"items":{"$ref":"#/components/schemas/UpdateUserPartialRequest"},"maximum":100,"type":"array","x-stream-index":"001"}},"required":["users"],"type":"object"},"UpdateUsersRequest":{"nullable":true,"properties":{"users":{"additionalProperties":{"$ref":"#/components/schemas/UserRequest"},"description":"Object containing users","title":"Users","type":"object","x-stream-index":"001","x-stream-map":{"key":"user_id"}}},"required":["users"],"type":"object"},"UpdateUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"membership_deletion_task_id":{"type":"string","x-stream-index":"002"},"users":{"additionalProperties":{"$ref":"#/components/schemas/FullUserResponse"},"description":"Object containing users","title":"Users","type":"object","x-stream-index":"001","x-stream-map":{"key":"user_id"}}},"required":["users","membership_deletion_task_id","duration"],"type":"object"},"UpdatedCallPermissionsEvent":{"description":"This event is sent to notify about permission changes for a user, clients receiving this event should update their UI accordingly","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"own_capabilities":{"description":"The capabilities of the current user","items":{"$ref":"#/components/schemas/OwnCapability"},"title":"Own capabilities","type":"array","x-stream-index":"004"},"type":{"default":"call.permissions_updated","description":"The type of event: \"call.permissions_updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who received the new permissions","title":"User","x-stream-index":"003"}},"required":["type","created_at","call_cid","user","own_capabilities"],"title":"UpdatedCallPermissionsEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"User":{"properties":{"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"046"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"017"},"banned":{"type":"boolean","x-stream-index":"016"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"013"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"023"},"language":{"type":"string","x-stream-index":"035"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"026"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"042"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"005"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"009"}},"required":["id","role","teams_role","custom","banned","online"],"type":"object"},"UserBannedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"006.002"},"channel_type":{"type":"string","x-stream-index":"006.003"},"cid":{"type":"string","x-stream-index":"006.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008.002"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"001"},"expiration":{"format":"date-time","type":"number","x-stream-index":"003"},"reason":{"type":"string","x-stream-index":"004"},"shadow":{"type":"boolean","x-stream-index":"002"},"team":{"type":"string","x-stream-index":"005.001"},"type":{"default":"user.banned","type":"string","x-stream-index":"008.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007.001"}},"required":["created_by","shadow","cid","channel_id","channel_type","type","created_at"],"title":"UserBannedEvent","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"},"UserDeactivatedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"001"},"type":{"default":"user.deactivated","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["created_by","type","created_at"],"title":"UserDeactivatedEvent","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"},"UserFeedbackReport":{"properties":{"count_by_rating":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001"},"unreported_count":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["count_by_rating","unreported_count"],"type":"object"},"UserFeedbackReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateUserFeedbackReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"UserMuteResponse":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"expires":{"format":"date-time","type":"number","x-stream-index":"003"},"target":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"}},"required":["created_at","updated_at"],"type":"object"},"UserMutedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"target_user":{"type":"string","x-stream-index":"001"},"target_users":{"items":{"type":"string"},"type":"array","x-stream-index":"002"},"type":{"default":"user.muted","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"UserMutedEvent","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"},"UserRatingReportResponse":{"properties":{"average":{"format":"float","type":"number","x-stream-index":"002"},"count":{"format":"int32","type":"integer","x-stream-index":"001"}},"required":["count","average"],"type":"object"},"UserReactivatedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"type":{"default":"user.reactivated","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"001"}},"required":["type","created_at"],"title":"UserReactivatedEvent","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"},"UserRequest":{"description":"User request object","properties":{"custom":{"additionalProperties":{},"description":"Custom user data","title":"Custom","type":"object","x-stream-index":"004"},"id":{"description":"User ID","title":"ID","type":"string","x-stream-index":"001"},"image":{"description":"User's profile image URL","title":"Image","type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"006"},"language":{"type":"string","x-stream-index":"005"},"name":{"description":"Optional name of user","title":"Name","type":"string","x-stream-index":"002"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"007"}},"required":["id"],"title":"UserRequest","type":"object"},"UserResponse":{"description":"User response object","properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"banned":{"description":"Whether a user is banned or not","title":"Banned","type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.017"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"001.004"},"deactivated_at":{"description":"Date of deactivation","format":"date-time","title":"Deactivated at","type":"number","x-stream-index":"001.016"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"001.011"},"id":{"description":"Unique user identifier","title":"ID","type":"string","x-stream-index":"001.001"},"image":{"title":"Image","type":"string","x-stream-index":"001.003"},"language":{"description":"Preferred language of a user","title":"Language","type":"string","x-stream-index":"001.005"},"last_active":{"description":"Date of last activity","format":"date-time","title":"Last active","type":"number","x-stream-index":"001.014"},"name":{"description":"Optional name of user","title":"Name","type":"string","x-stream-index":"001.002"},"online":{"description":"Whether a user online or not","title":"Online","type":"boolean","x-stream-index":"001.013"},"revoke_tokens_issued_before":{"description":"Revocation date for tokens","format":"date-time","title":"Revoke tokens issued before","type":"number","x-stream-index":"001.015"},"role":{"description":"Determines the set of user permissions","title":"Role","type":"string","x-stream-index":"001.006"},"teams":{"description":"List of teams user is a part of","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids","shadow_banned","invisible"],"title":"UserResponse","type":"object"},"UserResponsePrivacyFields":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"banned":{"type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.017"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.011"},"id":{"type":"string","x-stream-index":"001.001"},"image":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"003"},"language":{"type":"string","x-stream-index":"001.005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"001.014"},"name":{"type":"string","x-stream-index":"001.002"},"online":{"type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"002"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.015"},"role":{"type":"string","x-stream-index":"001.006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids"],"type":"object"},"UserUpdatedEvent":{"description":"This event is sent when a user gets updated. The event contains information about the updated user.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"type":{"default":"user.updated","description":"The type of event: \"user.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.002"},"user":{"$ref":"#/components/schemas/UserResponsePrivacyFields","description":"The updated user","title":"User","x-stream-index":"002.001"}},"required":["type","created_at","custom","user"],"title":"UserUpdatedEvent","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"},"VideoReactionOverTimeResponse":{"properties":{"by_minute":{"items":{"$ref":"#/components/schemas/CountByMinuteResponse"},"type":"array","x-stream-index":"001"}},"type":"object"},"VideoReactionsResponse":{"nullable":true,"properties":{"count_over_time":{"$ref":"#/components/schemas/VideoReactionOverTimeResponse","x-stream-index":"002"},"reaction":{"type":"string","x-stream-index":"001"}},"required":["reaction"],"type":"object"},"VideoSettingsRequest":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"camera_default_on":{"type":"boolean","x-stream-index":"004"},"camera_facing":{"enum":["front","back","external"],"type":"string","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"type":"object"},"VideoSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"camera_default_on":{"type":"boolean","x-stream-index":"004"},"camera_facing":{"enum":["front","back","external"],"type":"string","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled","target_resolution","camera_default_on","camera_facing"],"type":"object"},"WSAuthMessage":{"description":"Websocket auth message","nullable":true,"properties":{"products":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"token":{"title":"Token","type":"string","x-stream-index":"002"},"user_details":{"$ref":"#/components/schemas/ConnectUserDetailsRequest","x-stream-index":"001"}},"required":["user_details","token"],"title":"WSAuthMessage","type":"object"},"WSClientEvent":{"description":"The discriminator object for all websocket client events, it maps events' payload to the final type","discriminator":{"mapping":{"app.updated":"#/components/schemas/AppUpdatedEvent","health.check":"#/components/schemas/HealthCheckEvent","user.updated":"#/components/schemas/UserUpdatedEvent"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/AppUpdatedEvent"},{"$ref":"#/components/schemas/HealthCheckEvent"},{"$ref":"#/components/schemas/UserUpdatedEvent"}]},"WSEvent":{"description":"The discriminator object for all websocket events, it maps events' payload to the final type","discriminator":{"mapping":{"app.updated":"#/components/schemas/AppUpdatedEvent","call.accepted":"#/components/schemas/CallAcceptedEvent","call.blocked_user":"#/components/schemas/BlockedUserEvent","call.closed_caption":"#/components/schemas/ClosedCaptionEvent","call.closed_captions_failed":"#/components/schemas/CallClosedCaptionsFailedEvent","call.closed_captions_started":"#/components/schemas/CallClosedCaptionsStartedEvent","call.closed_captions_stopped":"#/components/schemas/CallClosedCaptionsStoppedEvent","call.created":"#/components/schemas/CallCreatedEvent","call.deleted":"#/components/schemas/CallDeletedEvent","call.ended":"#/components/schemas/CallEndedEvent","call.frame_recording_failed":"#/components/schemas/CallFrameRecordingFailedEvent","call.frame_recording_ready":"#/components/schemas/CallFrameRecordingFrameReadyEvent","call.frame_recording_started":"#/components/schemas/CallFrameRecordingStartedEvent","call.frame_recording_stopped":"#/components/schemas/CallFrameRecordingStoppedEvent","call.hls_broadcasting_failed":"#/components/schemas/CallHLSBroadcastingFailedEvent","call.hls_broadcasting_started":"#/components/schemas/CallHLSBroadcastingStartedEvent","call.hls_broadcasting_stopped":"#/components/schemas/CallHLSBroadcastingStoppedEvent","call.kicked_user":"#/components/schemas/KickedUserEvent","call.live_started":"#/components/schemas/CallLiveStartedEvent","call.member_added":"#/components/schemas/CallMemberAddedEvent","call.member_removed":"#/components/schemas/CallMemberRemovedEvent","call.member_updated":"#/components/schemas/CallMemberUpdatedEvent","call.member_updated_permission":"#/components/schemas/CallMemberUpdatedPermissionEvent","call.missed":"#/components/schemas/CallMissedEvent","call.moderation_blur":"#/components/schemas/CallModerationBlurEvent","call.moderation_warning":"#/components/schemas/CallModerationWarningEvent","call.notification":"#/components/schemas/CallNotificationEvent","call.permission_request":"#/components/schemas/PermissionRequestEvent","call.permissions_updated":"#/components/schemas/UpdatedCallPermissionsEvent","call.reaction_new":"#/components/schemas/CallReactionEvent","call.recording_failed":"#/components/schemas/CallRecordingFailedEvent","call.recording_ready":"#/components/schemas/CallRecordingReadyEvent","call.recording_started":"#/components/schemas/CallRecordingStartedEvent","call.recording_stopped":"#/components/schemas/CallRecordingStoppedEvent","call.rejected":"#/components/schemas/CallRejectedEvent","call.ring":"#/components/schemas/CallRingEvent","call.rtmp_broadcast_failed":"#/components/schemas/CallRtmpBroadcastFailedEvent","call.rtmp_broadcast_started":"#/components/schemas/CallRtmpBroadcastStartedEvent","call.rtmp_broadcast_stopped":"#/components/schemas/CallRtmpBroadcastStoppedEvent","call.session_ended":"#/components/schemas/CallSessionEndedEvent","call.session_participant_count_updated":"#/components/schemas/CallSessionParticipantCountsUpdatedEvent","call.session_participant_joined":"#/components/schemas/CallSessionParticipantJoinedEvent","call.session_participant_left":"#/components/schemas/CallSessionParticipantLeftEvent","call.session_started":"#/components/schemas/CallSessionStartedEvent","call.stats_report_ready":"#/components/schemas/CallStatsReportReadyEvent","call.transcription_failed":"#/components/schemas/CallTranscriptionFailedEvent","call.transcription_ready":"#/components/schemas/CallTranscriptionReadyEvent","call.transcription_started":"#/components/schemas/CallTranscriptionStartedEvent","call.transcription_stopped":"#/components/schemas/CallTranscriptionStoppedEvent","call.unblocked_user":"#/components/schemas/UnblockedUserEvent","call.updated":"#/components/schemas/CallUpdatedEvent","call.user_feedback_submitted":"#/components/schemas/CallUserFeedbackSubmittedEvent","call.user_muted":"#/components/schemas/CallUserMutedEvent","connection.error":"#/components/schemas/ConnectionErrorEvent","connection.ok":"#/components/schemas/ConnectedEvent","custom":"#/components/schemas/CustomVideoEvent","health.check":"#/components/schemas/HealthCheckEvent","user.banned":"#/components/schemas/UserBannedEvent","user.deactivated":"#/components/schemas/UserDeactivatedEvent","user.muted":"#/components/schemas/UserMutedEvent","user.reactivated":"#/components/schemas/UserReactivatedEvent","user.updated":"#/components/schemas/UserUpdatedEvent"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/AppUpdatedEvent"},{"$ref":"#/components/schemas/BlockedUserEvent"},{"$ref":"#/components/schemas/CallAcceptedEvent"},{"$ref":"#/components/schemas/CallClosedCaptionsFailedEvent"},{"$ref":"#/components/schemas/CallClosedCaptionsStartedEvent"},{"$ref":"#/components/schemas/CallClosedCaptionsStoppedEvent"},{"$ref":"#/components/schemas/CallCreatedEvent"},{"$ref":"#/components/schemas/CallDeletedEvent"},{"$ref":"#/components/schemas/CallEndedEvent"},{"$ref":"#/components/schemas/CallFrameRecordingFailedEvent"},{"$ref":"#/components/schemas/CallFrameRecordingFrameReadyEvent"},{"$ref":"#/components/schemas/CallFrameRecordingStartedEvent"},{"$ref":"#/components/schemas/CallFrameRecordingStoppedEvent"},{"$ref":"#/components/schemas/CallHLSBroadcastingFailedEvent"},{"$ref":"#/components/schemas/CallHLSBroadcastingStartedEvent"},{"$ref":"#/components/schemas/CallHLSBroadcastingStoppedEvent"},{"$ref":"#/components/schemas/CallLiveStartedEvent"},{"$ref":"#/components/schemas/CallMemberAddedEvent"},{"$ref":"#/components/schemas/CallMemberRemovedEvent"},{"$ref":"#/components/schemas/CallMemberUpdatedEvent"},{"$ref":"#/components/schemas/CallMemberUpdatedPermissionEvent"},{"$ref":"#/components/schemas/CallMissedEvent"},{"$ref":"#/components/schemas/CallModerationBlurEvent"},{"$ref":"#/components/schemas/CallModerationWarningEvent"},{"$ref":"#/components/schemas/CallNotificationEvent"},{"$ref":"#/components/schemas/CallReactionEvent"},{"$ref":"#/components/schemas/CallRecordingFailedEvent"},{"$ref":"#/components/schemas/CallRecordingReadyEvent"},{"$ref":"#/components/schemas/CallRecordingStartedEvent"},{"$ref":"#/components/schemas/CallRecordingStoppedEvent"},{"$ref":"#/components/schemas/CallRejectedEvent"},{"$ref":"#/components/schemas/CallRingEvent"},{"$ref":"#/components/schemas/CallRtmpBroadcastFailedEvent"},{"$ref":"#/components/schemas/CallRtmpBroadcastStartedEvent"},{"$ref":"#/components/schemas/CallRtmpBroadcastStoppedEvent"},{"$ref":"#/components/schemas/CallSessionEndedEvent"},{"$ref":"#/components/schemas/CallSessionParticipantCountsUpdatedEvent"},{"$ref":"#/components/schemas/CallSessionParticipantJoinedEvent"},{"$ref":"#/components/schemas/CallSessionParticipantLeftEvent"},{"$ref":"#/components/schemas/CallSessionStartedEvent"},{"$ref":"#/components/schemas/CallStatsReportReadyEvent"},{"$ref":"#/components/schemas/CallTranscriptionFailedEvent"},{"$ref":"#/components/schemas/CallTranscriptionReadyEvent"},{"$ref":"#/components/schemas/CallTranscriptionStartedEvent"},{"$ref":"#/components/schemas/CallTranscriptionStoppedEvent"},{"$ref":"#/components/schemas/CallUpdatedEvent"},{"$ref":"#/components/schemas/CallUserFeedbackSubmittedEvent"},{"$ref":"#/components/schemas/CallUserMutedEvent"},{"$ref":"#/components/schemas/ClosedCaptionEvent"},{"$ref":"#/components/schemas/ConnectedEvent"},{"$ref":"#/components/schemas/ConnectionErrorEvent"},{"$ref":"#/components/schemas/CustomVideoEvent"},{"$ref":"#/components/schemas/HealthCheckEvent"},{"$ref":"#/components/schemas/KickedUserEvent"},{"$ref":"#/components/schemas/PermissionRequestEvent"},{"$ref":"#/components/schemas/UnblockedUserEvent"},{"$ref":"#/components/schemas/UpdatedCallPermissionsEvent"},{"$ref":"#/components/schemas/UserBannedEvent"},{"$ref":"#/components/schemas/UserDeactivatedEvent"},{"$ref":"#/components/schemas/UserMutedEvent"},{"$ref":"#/components/schemas/UserReactivatedEvent"},{"$ref":"#/components/schemas/UserUpdatedEvent"}]}},"securitySchemes":{"JWT":{"description":"JWT should be always provided when stream-auth-type=jwt.\n\nUsing JWT auth request could be authenticated as user or as server-side.\n\nWhen using user authentication permission checking is going to be applied to requests based on the user that is\nperforming a request.\n\nThe `authorization` header should be a JWT string signed using the secret attached to the API key used to perform\nrequests.\n\n**WARNING** all client-side official SDK do not ship with token generation; this is to make sure that the API secret is not\nshared with an untrusted party such as a browser or a iOS/Android application. Tokens **must** be generated server-side.\nIf you wish, you can configure your application to ignore authentication (see `disable_auth_check`)\nThe JWT string must include only the user_id claim and can include any built-in JWT claim such as iat, exp as well.\n","in":"header","name":"Authorization","type":"apiKey"},"api_key":{"description":"Application API key should be always set in order to authenticate the request.","in":"query","name":"api_key","type":"apiKey"},"stream-auth-type":{"description":"Stream-Auth-Type should be always set in order to authenticate the request. Possible\nvalues: `jwt` or `anonymous`.\n\n`jwt` allows you to authenticate as a user. With this auth type you should also provide valid JWT in Authorization\nheader.\n\n`anonymous` allows you to authenticate as anonymous user. Please note that most advanced features are not available\nto anonymous users.","in":"header","name":"Stream-Auth-Type","type":"apiKey"}}},"info":{"title":"Stream API","version":"v191.1.0"},"openapi":"3.0.3","paths":{"/api/v2/app":{"get":{"description":"This Method returns the application settings\n","operationId":"GetApp","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetApplicationResponse"}}},"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":"Get App Settings","tags":["product:common"]}},"/api/v2/blocklists":{"get":{"description":"Returns all available block lists\n","operationId":"ListBlockLists","parameters":[{"in":"query","name":"team","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListBlockListResponse"}}},"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":"List block lists","tags":["product:common"]},"post":{"description":"Creates a new application blocklist, once created the blocklist can be used by any channel type\n","operationId":"CreateBlockList","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBlockListRequest"}}},"description":"Block list","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBlockListResponse"}}},"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":"Create block list","tags":["product:common"]}},"/api/v2/blocklists/{name}":{"delete":{"description":"Deletes previously created application blocklist\n","operationId":"DeleteBlockList","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"team","schema":{"type":"string","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete block list","tags":["product:common"]},"put":{"description":"Updates contents of the block list\n","operationId":"UpdateBlockList","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Block list name","title":"Name","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBlockListRequest"}}},"description":"Update block list","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBlockListResponse"}}},"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":"Update block list","tags":["product:common"]}},"/api/v2/devices":{"delete":{"description":"Deletes one device\n","operationId":"DeleteDevice","parameters":[{"in":"query","name":"id","required":true,"schema":{"description":"Device ID to delete","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete device","tags":["product:common"]},"get":{"description":"Returns all available devices\n","operationId":"ListDevices","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDevicesResponse"}}},"description":"ListDevicesResponse"},"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":"List devices","tags":["product:common"]},"post":{"description":"Adds a new device to a user, if the same device already exists the call will have no effect\n","operationId":"CreateDevice","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDeviceRequest"}}},"description":"CreateDeviceRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Create device","tags":["product:common"]}},"/api/v2/guest":{"post":{"description":"\n","operationId":"CreateGuest","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGuestRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGuestResponse"}}},"description":"Successful 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":"Create Guest","tags":["product:common"]}},"/api/v2/longpoll":{"get":{"description":"WebSocket fallback transport endpoint\n\nSends events:\n- user.updated\n","operationId":"LongPoll","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WSAuthMessage","x-stream-index":"001"}}},"in":"query","name":"json"},{"in":"query","name":"connection_id","schema":{"maxLength":36,"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"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":"Long Poll (Transport)","tags":["product:common"]}},"/api/v2/og":{"get":{"description":"Get an OpenGraph attachment for a link\n","operationId":"GetOG","parameters":[{"in":"query","name":"url","required":true,"schema":{"description":"URL to be scraped","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOGResponse"}}},"description":"Get OG Attachment"},"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":"Get OG","tags":["product:common"]}},"/api/v2/polls":{"post":{"description":"Creates a new poll\n","operationId":"CreatePoll","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePollRequest"}}},"description":"Create Poll Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Create poll","tags":["product:common"]},"put":{"description":"Updates a poll\n\nSends events:\n- feeds.poll.closed\n- feeds.poll.updated\n- poll.closed\n- poll.updated\n","operationId":"UpdatePoll","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePollRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Update poll","tags":["product:common"]}},"/api/v2/polls/query":{"post":{"description":"Queries polls\n","operationId":"QueryPolls","parameters":[{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryPollsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryPollsResponse"}}},"description":"Successful 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":"Query polls","tags":["product:common"]}},"/api/v2/polls/{poll_id}":{"delete":{"description":"Deletes a poll\n\nSends events:\n- feeds.poll.deleted\n- poll.deleted\n","operationId":"DeletePoll","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete poll","tags":["product:common"]},"get":{"description":"Retrieves a poll\n","operationId":"GetPoll","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Get poll","tags":["product:common"]},"patch":{"description":"Updates a poll partially\n\nSends events:\n- feeds.poll.closed\n- feeds.poll.updated\n- poll.closed\n- poll.updated\n","operationId":"UpdatePollPartial","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePollPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Partial update poll","tags":["product:common"]}},"/api/v2/polls/{poll_id}/options":{"post":{"description":"Creates a poll option\n\nSends events:\n- feeds.poll.updated\n- poll.updated\n","operationId":"CreatePollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePollOptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollOptionResponse"}}},"description":"Successful 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":"Create poll option","tags":["product:common"]},"put":{"description":"Updates a poll option\n\nSends events:\n- feeds.poll.updated\n- poll.updated\n","operationId":"UpdatePollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePollOptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollOptionResponse"}}},"description":"Successful 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":"Update poll option","tags":["product:common"]}},"/api/v2/polls/{poll_id}/options/{option_id}":{"delete":{"description":"Deletes a poll option\n\nSends events:\n- feeds.poll.updated\n- poll.updated\n","operationId":"DeletePollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"path","name":"option_id","required":true,"schema":{"description":"Option ID","maxLength":255,"title":"string","type":"string","x-stream-index":"003"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete poll option","tags":["product:common"]},"get":{"description":"Retrieves a poll option\n","operationId":"GetPollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"path","name":"option_id","required":true,"schema":{"description":"Option ID","maxLength":255,"title":"string","type":"string","x-stream-index":"003"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollOptionResponse"}}},"description":"Successful 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":"Get poll option","tags":["product:common"]}},"/api/v2/polls/{poll_id}/votes":{"post":{"description":"Queries votes\n","operationId":"QueryPollVotes","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryPollVotesRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollVotesResponse"}}},"description":"Successful 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":"Query votes","tags":["product:common"]}},"/api/v2/uploads/file":{"delete":{"description":"Deletes previously uploaded file\n","operationId":"DeleteFileGlobal","parameters":[{"in":"query","name":"url","schema":{"description":"File URL to delete","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete file","tags":["product:common"],"x-stream-sdk-name":"DeleteFile"},"post":{"description":"Uploads file\n","operationId":"UploadFileGlobal","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/FileUploadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileUploadResponse"}}},"description":"Successful 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":"Upload file","tags":["product:common"],"x-stream-sdk-name":"UploadFile"}},"/api/v2/uploads/image":{"delete":{"description":"Deletes previously uploaded image\n","operationId":"DeleteImageGlobal","parameters":[{"in":"query","name":"url","schema":{"description":"File URL to delete","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete image","tags":["product:common"],"x-stream-sdk-name":"DeleteImage"},"post":{"description":"Uploads image\n","operationId":"UploadImageGlobal","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/ImageUploadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageUploadResponse"}}},"description":"Successful 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":"Upload image","tags":["product:common"],"x-stream-sdk-name":"UploadImage"}},"/api/v2/users":{"get":{"description":"Find and filter users\n","operationId":"QueryUsers","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryUsersPayload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryUsersResponse"}}},"description":"Successful 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":"Query users","tags":["product:common"]},"patch":{"description":"Updates certain fields of the user\n\nSends events:\n- user.presence.changed\n- user.updated\n- user.presence.changed\n","operationId":"UpdateUsersPartial","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersResponse"}}},"description":"Successful 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":"Partially update user","tags":["product:common"]},"post":{"description":"Update or create users in bulk\n\nSends events:\n- user.updated\n","operationId":"UpdateUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersResponse"}}},"description":"Successful 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":"Upsert users","tags":["product:common"]}},"/api/v2/users/block":{"get":{"description":"Get list of blocked Users\n","operationId":"GetBlockedUsers","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBlockedUsersResponse"}}},"description":"Successful 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":"Get list of blocked Users","tags":["product:common"]},"post":{"description":"Block users\n","operationId":"BlockUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUsersResponse"}}},"description":"Successful 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":"Block user","tags":["product:common"]}},"/api/v2/users/live_locations":{"get":{"description":"Retrieves all active live locations for a user\n","operationId":"GetUserLiveLocations","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SharedLocationsResponse"}}},"description":"Successful 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":"Get user live locations","tags":["product:common"]},"put":{"description":"Updates an existing live location with new coordinates or expiration time\n","operationId":"UpdateLiveLocation","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateLiveLocationRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SharedLocationResponse"}}},"description":"Successful 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":"Update live location","tags":["product:common"]}},"/api/v2/users/unblock":{"post":{"description":"Unblock users\n","operationId":"UnblockUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUsersResponse"}}},"description":"Successful 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":"Unblock user","tags":["product:common"]}},"/api/v2/video/call/members":{"post":{"description":"Query call members with filter query\n","operationId":"QueryCallMembers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallMembersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallMembersResponse"}}},"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":"Query call members","tags":["product:video"]}},"/api/v2/video/call/stats":{"post":{"description":"\n","operationId":"QueryCallStats","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallStatsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallStatsResponse"}}},"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":"Query Call Stats","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}":{"get":{"description":"\n","operationId":"GetCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"query","name":"connection_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"003"}},{"in":"query","name":"members_limit","schema":{"format":"int32","maximum":100,"minimum":0,"type":"integer","writeOnly":true,"x-stream-index":"004"}},{"in":"query","name":"ring","schema":{"type":"boolean","writeOnly":true,"x-stream-index":"005"}},{"in":"query","name":"notify","schema":{"type":"boolean","writeOnly":true,"x-stream-index":"006"}},{"in":"query","name":"video","schema":{"type":"boolean","writeOnly":true,"x-stream-index":"007"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCallResponse"}}},"description":"GetCallResponse"},"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":"Get Call","tags":["product:video"]},"patch":{"description":"\n\nSends events:\n- call.updated\n","operationId":"UpdateCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallRequest"}}},"description":"UpdateCallRequest","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallResponse"}}},"description":"UpdateCallResponse"},"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":"Update Call","tags":["product:video"]},"post":{"description":"Gets or creates a new call\n\nSends events:\n- call.created\n- call.notification\n- call.ring\n","operationId":"GetOrCreateCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"connection_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"008"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrCreateCallRequest"}}},"description":"GetOrCreateCallRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrCreateCallResponse"}}},"description":"GetOrCreateCallResponse"},"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":"Get or create a call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/accept":{"post":{"description":"\n\nSends events:\n- call.accepted\n","operationId":"AcceptCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcceptCallResponse"}}},"description":"AcceptCallResponse"},"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":"Accept Call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/block":{"post":{"description":"Block a user, preventing them from joining the call until they are unblocked.\n\nSends events:\n- call.blocked_user\n","operationId":"BlockUser","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUserRequest"}}},"description":"BlockUserRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUserResponse"}}},"description":"BlockUserResponse"},"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":"Block user on a call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/delete":{"post":{"description":"\n\nSends events:\n- call.deleted\n","operationId":"DeleteCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCallRequest"}}},"description":"DeleteCallRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCallResponse"}}},"description":"DeleteCallResponse"},"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":"Delete Call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/event":{"post":{"description":"Sends custom event to the call\n\nSends events:\n- custom\n","operationId":"SendCallEvent","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendCallEventRequest"}}},"description":"SendCallEventRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendCallEventResponse"}}},"description":"SendCallEventResponse"},"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":"Send custom event","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/feedback":{"post":{"description":"\n\nSends events:\n- call.user_feedback_submitted\n","operationId":"CollectUserFeedback","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectUserFeedbackRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectUserFeedbackResponse"}}},"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":"Collect user feedback","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/go_live":{"post":{"description":"\n\nSends events:\n- call.live_started\n","operationId":"GoLive","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoLiveRequest"}}},"description":"GoLiveRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoLiveResponse"}}},"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":"Set call as live","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/join":{"post":{"description":"Request to join a call\n","operationId":"JoinCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"query","name":"connection_id","schema":{"title":"ConnectionID","type":"string","writeOnly":true,"x-stream-index":"008"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JoinCallRequest"}}},"description":"JoinCallRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JoinCallResponse"}}},"description":"JoinCallResponse"},"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":"Join call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/kick":{"post":{"description":"Kicks a user from the call. Optionally block the user from rejoining by setting block=true.\n\nSends events:\n- call.blocked_user\n- call.kicked_user\n","operationId":"KickUser","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KickUserRequest"}}},"description":"KickUserRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KickUserResponse"}}},"description":"KickUserResponse"},"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":"Kick user from a call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/mark_ended":{"post":{"description":"\n\nSends events:\n- call.ended\n","operationId":"EndCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EndCallResponse"}}},"description":"EndCallResponse"},"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":"End call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/members":{"post":{"description":"\n\nSends events:\n- call.member_added\n- call.member_removed\n- call.member_updated\n","operationId":"UpdateCallMembers","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallMembersRequest"}}},"description":"UpdateCallMembersRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallMembersResponse"}}},"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":"Update Call Member","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/mute_users":{"post":{"description":"Mutes users in a call\n","operationId":"MuteUsers","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteUsersRequest"}}},"description":"MuteUsersRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteUsersResponse"}}},"description":"MuteUsersResponse"},"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":"Mute users","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/participants":{"post":{"description":"Returns a list of participants connected to the call\n","operationId":"QueryCallParticipants","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"type","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"limit","schema":{"format":"int32","maximum":100,"type":"integer","x-stream-index":"004"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallParticipantsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallParticipantsResponse"}}},"description":"Successful 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":"Query call participants","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/pin":{"post":{"description":"Pins a track for all users in the call.\n","operationId":"VideoPin","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PinRequest"}}},"description":"PinRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PinResponse"}}},"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":"Pin","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/reaction":{"post":{"description":"Sends reaction to the call\n\nSends events:\n- call.reaction_new\n","operationId":"SendVideoReaction","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendReactionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendReactionResponse"}}},"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":"Send reaction to the call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/recordings":{"get":{"description":"Lists recordings\n","operationId":"ListRecordings","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListRecordingsResponse"}}},"description":"ListRecordingsResponse"},"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":"List recordings","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/reject":{"post":{"description":"\n\nSends events:\n- call.rejected\n","operationId":"RejectCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RejectCallRequest"}}},"description":"RejectCallRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RejectCallResponse"}}},"description":"RejectCallResponse"},"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":"Reject Call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/report":{"get":{"description":"\n","operationId":"GetCallReport","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"query","name":"session_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCallReportResponse"}}},"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":"Get call report","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/request_permission":{"post":{"description":"Request permission to perform an action\n\nSends events:\n- call.permission_request\n","operationId":"RequestPermission","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestPermissionRequest"}}},"description":"RequestPermissionRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestPermissionResponse"}}},"description":"RequestPermissionResponse"},"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":"Request permission","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/rtmp_broadcasts":{"post":{"description":"Starts RTMP broadcasts for the provided RTMP destinations\n","operationId":"StartRTMPBroadcasts","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRTMPBroadcastsRequest"}}},"description":"StartRTMPBroadcastsRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRTMPBroadcastsResponse"}}},"description":"StartRTMPBroadcastsResponse"},"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":"Start RTMP broadcasts","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/rtmp_broadcasts/stop":{"post":{"description":"Stop all RTMP broadcasts for the provided call\n","operationId":"StopAllRTMPBroadcasts","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopAllRTMPBroadcastsResponse"}}},"description":"StopAllRTMPBroadcastsResponse"},"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":"Stop all RTMP broadcasts for a call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/rtmp_broadcasts/{name}/stop":{"post":{"description":"Stop RTMP broadcasts for the provided RTMP destinations\n","operationId":"StopRTMPBroadcast","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopRTMPBroadcastsRequest"}}},"description":"StopRTMPBroadcastsRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopRTMPBroadcastsResponse"}}},"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":"Stop RTMP broadcasts","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/start_broadcasting":{"post":{"description":"Starts HLS broadcasting\n","operationId":"StartHLSBroadcasting","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartHLSBroadcastingResponse"}}},"description":"StartHLSBroadcastingResponse"},"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":"Start HLS broadcasting","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/start_closed_captions":{"post":{"description":"Starts closed captions\n","operationId":"StartClosedCaptions","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartClosedCaptionsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartClosedCaptionsResponse"}}},"description":"Successful 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":"Start closed captions","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/start_frame_recording":{"post":{"description":"Starts frame by frame recording\n\nSends events:\n- call.frame_recording_started\n","operationId":"StartFrameRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartFrameRecordingRequest"}}},"description":"StartFrameRecordingRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartFrameRecordingResponse"}}},"description":"StartFrameRecordingResponse"},"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":"Start frame recording","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/start_recording":{"post":{"description":"Starts recording\n\nSends events:\n- call.recording_started\n","operationId":"StartRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRecordingRequest"}}},"description":"StartRecordingRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRecordingResponse"}}},"description":"StartRecordingResponse"},"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":"Start recording","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/start_transcription":{"post":{"description":"Starts transcription\n","operationId":"StartTranscription","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartTranscriptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartTranscriptionResponse"}}},"description":"StartTranscriptionResponse"},"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":"Start transcription","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_broadcasting":{"post":{"description":"Stops HLS broadcasting\n","operationId":"StopHLSBroadcasting","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopHLSBroadcastingResponse"}}},"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":"Stop HLS broadcasting","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_closed_captions":{"post":{"description":"Stops closed captions\n\nSends events:\n- call.transcription_stopped\n","operationId":"StopClosedCaptions","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopClosedCaptionsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopClosedCaptionsResponse"}}},"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":"Stop closed captions","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_frame_recording":{"post":{"description":"Stops frame recording\n\nSends events:\n- call.frame_recording_stopped\n","operationId":"StopFrameRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopFrameRecordingResponse"}}},"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":"Stop frame recording","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_live":{"post":{"description":"\n\nSends events:\n- call.updated\n","operationId":"StopLive","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopLiveRequest"}}},"description":"StopLiveRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopLiveResponse"}}},"description":"StopLiveResponse"},"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":"Set call as not live","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_recording":{"post":{"description":"Stops recording\n\nSends events:\n- call.recording_stopped\n","operationId":"StopRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopRecordingResponse"}}},"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":"Stop recording","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_transcription":{"post":{"description":"Stops transcription\n\nSends events:\n- call.transcription_stopped\n","operationId":"StopTranscription","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopTranscriptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopTranscriptionResponse"}}},"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":"Stop transcription","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/transcriptions":{"get":{"description":"Lists transcriptions\n","operationId":"ListTranscriptions","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTranscriptionsResponse"}}},"description":"ListTranscriptionsResponse"},"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":"List transcriptions","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/unblock":{"post":{"description":"Removes the block for a user on a call. The user will be able to join the call again.\n\nSends events:\n- call.unblocked_user\n","operationId":"UnblockUser","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUserRequest"}}},"description":"UnblockUserRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUserResponse"}}},"description":"UnblockUserResponse"},"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":"Unblocks user on a call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/unpin":{"post":{"description":"Unpins a track for all users in the call.\n","operationId":"VideoUnpin","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnpinRequest"}}},"description":"UnpinRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnpinResponse"}}},"description":"UnpinResponse"},"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":"Unpin","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/user_permissions":{"post":{"description":"Updates user permissions\n\nSends events:\n- call.permissions_updated\n","operationId":"UpdateUserPermissions","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"005.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"005.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUserPermissionsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUserPermissionsResponse"}}},"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":"Update user permissions","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/{session}/recordings/{filename}":{"delete":{"description":"Deletes recording\n","operationId":"DeleteRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"path","name":"session","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"003"}},{"in":"path","name":"filename","required":true,"schema":{"maxLength":256,"type":"string","writeOnly":true,"x-stream-index":"004"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteRecordingResponse"}}},"description":"DeleteRecordingResponse"},"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":"Delete recording","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/{session}/transcriptions/{filename}":{"delete":{"description":"Deletes transcription\n","operationId":"DeleteTranscription","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"path","name":"session","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"003"}},{"in":"path","name":"filename","required":true,"schema":{"maxLength":256,"type":"string","writeOnly":true,"x-stream-index":"004"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteTranscriptionResponse"}}},"description":"DeleteTranscriptionResponse"},"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":"Delete transcription","tags":["product:video"]}},"/api/v2/video/calls":{"post":{"description":"Query calls with filter query\n","operationId":"QueryCalls","parameters":[{"in":"query","name":"connection_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallsRequest"}}},"description":"QueryCallsRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallsResponse"}}},"description":"QueryCallsResponse"},"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":"Query call","tags":["product:video"]}},"/api/v2/video/edges":{"get":{"description":"Returns the list of all edges available for video calls.\n","operationId":"GetEdges","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetEdgesResponse"}}},"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":"Get Edges","tags":["product:video"]}},"/api/v2/video/stats":{"post":{"description":"\n","operationId":"QueryAggregateCallStats","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryAggregateCallStatsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryAggregateCallStatsResponse"}}},"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":"Query Aggregate call Stats","tags":["product:video"]}}},"security":[{"JWT":[],"api_key":[],"stream-auth-type":[]},{"api_key":[],"stream-auth-type":[]}],"servers":[{"description":"Stream API","url":"https://chat.stream-io-api.com"}]} \ No newline at end of file diff --git a/openapi/v2/video-clientside-api.yaml b/openapi/v2/video-clientside-api.yaml index 1e4a1b5e6..6670c693d 100644 --- a/openapi/v2/video-clientside-api.yaml +++ b/openapi/v2/video-clientside-api.yaml @@ -190,6 +190,7 @@ components: - use_hook_v2 - user_response_time_enabled - moderation_bulk_submit_action_enabled + - moderation_llm_configurability_enabled type: object AppUpdatedEvent: description: Emitted when app settings are updated @@ -2865,7 +2866,7 @@ components: x-stream-index: "001.002" type: default: call.updated - description: 'The type of event: "call.ended" in this case' + description: 'The type of event: "call.updated" in this case' title: Event Type type: string x-stream-index: "001.001" @@ -3069,6 +3070,14 @@ components: $ref: '#/components/schemas/ChannelMember' type: array x-stream-index: "020" + message_count: + format: int64 + type: integer + x-stream-index: "035" + message_count_updated_at: + format: date-time + type: number + x-stream-index: "036" team: type: string x-stream-index: "028" @@ -3099,39 +3108,39 @@ components: items: type: string type: array - x-stream-index: "001.026" + x-stream-index: "001.027" automod: enum: - disabled - simple - AI type: string - x-stream-index: "001.021" + x-stream-index: "001.022" automod_behavior: enum: - flag - block - shadow_block type: string - x-stream-index: "001.022" + x-stream-index: "001.023" automod_thresholds: $ref: '#/components/schemas/Thresholds' - x-stream-index: "001.027" + x-stream-index: "001.028" blocklist: type: string - x-stream-index: "001.023" + x-stream-index: "001.024" blocklist_behavior: enum: - flag - block - shadow_block type: string - x-stream-index: "001.024" + x-stream-index: "001.025" blocklists: items: $ref: '#/components/schemas/BlockListOptions' type: array - x-stream-index: "001.025" + x-stream-index: "001.026" commands: items: type: string @@ -3140,6 +3149,9 @@ components: connect_events: type: boolean x-stream-index: "001.004" + count_messages: + type: boolean + x-stream-index: "001.019" created_at: format: date-time type: number @@ -3154,7 +3166,7 @@ components: format: int32 maximum: 20000 type: integer - x-stream-index: "001.020" + x-stream-index: "001.021" mutes: type: boolean x-stream-index: "001.009" @@ -3164,10 +3176,10 @@ components: partition_size: format: int32 type: integer - x-stream-index: "001.028" + x-stream-index: "001.029" partition_ttl: type: integer - x-stream-index: "001.029" + x-stream-index: "001.030" polls: type: boolean x-stream-index: "001.016" @@ -3197,7 +3209,7 @@ components: x-stream-index: "001.018" skip_last_msg_update_for_system_msgs: type: boolean - x-stream-index: "001.030" + x-stream-index: "001.031" typing_events: type: boolean x-stream-index: "001.002" @@ -3233,6 +3245,7 @@ components: - polls - user_message_reminders - shared_locations + - count_messages - message_retention - max_message_length - automod @@ -3248,39 +3261,39 @@ components: items: type: string type: array - x-stream-index: 001.002.026 + x-stream-index: 001.002.027 automod: enum: - disabled - simple - AI type: string - x-stream-index: 001.002.021 + x-stream-index: 001.002.022 automod_behavior: enum: - flag - block - shadow_block type: string - x-stream-index: 001.002.022 + x-stream-index: 001.002.023 automod_thresholds: $ref: '#/components/schemas/Thresholds' - x-stream-index: 001.002.027 + x-stream-index: 001.002.028 blocklist: type: string - x-stream-index: 001.002.023 + x-stream-index: 001.002.024 blocklist_behavior: enum: - flag - block - shadow_block type: string - x-stream-index: 001.002.024 + x-stream-index: 001.002.025 blocklists: items: $ref: '#/components/schemas/BlockListOptions' type: array - x-stream-index: 001.002.025 + x-stream-index: 001.002.026 commands: items: $ref: '#/components/schemas/Command' @@ -3289,6 +3302,9 @@ components: connect_events: type: boolean x-stream-index: 001.002.004 + count_messages: + type: boolean + x-stream-index: 001.002.019 created_at: format: date-time type: number @@ -3310,7 +3326,7 @@ components: format: int32 maximum: 20000 type: integer - x-stream-index: 001.002.020 + x-stream-index: 001.002.021 mutes: type: boolean x-stream-index: 001.002.009 @@ -3320,13 +3336,13 @@ components: partition_size: format: int32 type: integer - x-stream-index: 001.002.028 + x-stream-index: 001.002.029 partition_ttl: example: 24h format: duration nullable: true type: string - x-stream-index: 001.002.029 + x-stream-index: 001.002.030 polls: type: boolean x-stream-index: 001.002.016 @@ -3356,7 +3372,7 @@ components: x-stream-index: 001.002.018 skip_last_msg_update_for_system_msgs: type: boolean - x-stream-index: 001.002.030 + x-stream-index: 001.002.031 typing_events: type: boolean x-stream-index: 001.002.002 @@ -3394,6 +3410,7 @@ components: - polls - user_message_reminders - shared_locations + - count_messages - message_retention - max_message_length - automod @@ -3438,6 +3455,11 @@ components: format: date-time type: number x-stream-index: "011" + deleted_messages: + items: + type: string + type: array + x-stream-index: "020" invite_accepted_at: description: Date when invite was accepted format: date-time @@ -3685,6 +3707,12 @@ components: title: ChannelMembers type: array x-stream-index: "011" + message_count: + description: Number of messages in the channel + format: int64 + title: Message count + type: integer + x-stream-index: "027" mute_expires_at: description: Date of mute expiration format: date-time @@ -3887,6 +3915,9 @@ components: type: string type: array x-stream-index: "011" + count_messages: + type: boolean + x-stream-index: "014" grants: additionalProperties: items: @@ -4676,6 +4707,21 @@ components: - duration title: EndCallResponse type: object + FeedsEventPreferences: + properties: + comments: + type: string + x-stream-index: "002" + mentions: + type: string + x-stream-index: "004" + new_followers: + type: string + x-stream-index: "003" + reactions: + type: string + x-stream-index: "001" + type: object Field: nullable: true properties: @@ -5786,6 +5832,76 @@ components: - duration title: JoinCallResponse type: object + KickUserRequest: + description: KickUserRequest is the payload for kicking a user from a call. + Optionally block the user as well. + nullable: true + properties: + block: + description: If true, also block the user from rejoining the call + title: Block + type: boolean + x-stream-index: "004" + user_id: + description: The user to kick + title: UserID + type: string + x-stream-index: "003" + required: + - user_id + title: KickUserRequest + type: object + KickUserResponse: + description: KickUserResponse is the payload for kicking a user from a call. + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "001.001" + required: + - duration + title: KickUserResponse + type: object + KickedUserEvent: + description: This event is sent to call participants to notify when a user is + kicked from a call. Clients should make the kicked user leave the call UI. + properties: + call_cid: + type: string + x-stream-index: "002.001" + created_at: + format: date-time + type: number + x-stream-index: "001.002" + kicked_by_user: + $ref: '#/components/schemas/UserResponse' + description: The user that kicked the participant, null if server-side + title: Kicked by + x-stream-index: "004" + type: + default: call.kicked_user + description: 'The type of event: "call.kicked_user" in this case' + title: Event Type + type: string + x-stream-index: "001.001" + user: + $ref: '#/components/schemas/UserResponse' + description: The user that was kicked + title: User + x-stream-index: "003" + required: + - type + - created_at + - call_cid + - user + title: KickedUserEvent + type: object + x-stream-event-call-type: true + x-stream-event-doc-group: call + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent LabelThresholds: properties: block: @@ -6042,6 +6158,9 @@ components: format: date-time type: number x-stream-index: "033" + deleted_for_me: + type: boolean + x-stream-index: "059" deleted_reply_count: format: int32 type: integer @@ -6281,6 +6400,9 @@ components: title: Deleted at type: number x-stream-index: "025" + deleted_for_me: + type: boolean + x-stream-index: "044" deleted_reply_count: format: int32 type: integer @@ -6661,6 +6783,7 @@ components: - join-backstage - join-call - join-ended-call + - kick-user - mute-users - pin-for-everyone - read-call @@ -7459,6 +7582,12 @@ components: disabled_until: format: date-time type: number + x-stream-index: "005" + feeds_events: + $ref: '#/components/schemas/FeedsEventPreferences' + x-stream-index: "004" + feeds_level: + type: string x-stream-index: "003" type: object QualityScoreReport: @@ -10603,6 +10732,7 @@ components: call.hls_broadcasting_failed: '#/components/schemas/CallHLSBroadcastingFailedEvent' call.hls_broadcasting_started: '#/components/schemas/CallHLSBroadcastingStartedEvent' call.hls_broadcasting_stopped: '#/components/schemas/CallHLSBroadcastingStoppedEvent' + call.kicked_user: '#/components/schemas/KickedUserEvent' call.live_started: '#/components/schemas/CallLiveStartedEvent' call.member_added: '#/components/schemas/CallMemberAddedEvent' call.member_removed: '#/components/schemas/CallMemberRemovedEvent' @@ -10702,6 +10832,7 @@ components: - $ref: '#/components/schemas/ConnectionErrorEvent' - $ref: '#/components/schemas/CustomVideoEvent' - $ref: '#/components/schemas/HealthCheckEvent' + - $ref: '#/components/schemas/KickedUserEvent' - $ref: '#/components/schemas/PermissionRequestEvent' - $ref: '#/components/schemas/UnblockedUserEvent' - $ref: '#/components/schemas/UpdatedCallPermissionsEvent' @@ -10751,7 +10882,7 @@ components: type: apiKey info: title: Stream API - version: v187.13.0 + version: v191.1.0 openapi: 3.0.3 paths: /api/v2/app: @@ -12759,6 +12890,65 @@ paths: summary: Join call tags: - product:video + /api/v2/video/call/{type}/{id}/kick: + post: + description: | + Kicks a user from the call. Optionally block the user from rejoining by setting block=true. + + Sends events: + - call.blocked_user + - call.kicked_user + operationId: KickUser + parameters: + - in: path + name: type + required: true + schema: + description: The type of call + maxLength: 64 + title: Type + type: string + writeOnly: true + x-stream-index: "002.001" + - in: path + name: id + required: true + schema: + description: Call ID + maxLength: 64 + title: ID + type: string + writeOnly: true + x-stream-index: "002.002" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/KickUserRequest' + description: KickUserRequest + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/KickUserResponse' + description: KickUserResponse + "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: Kick user from a call + tags: + - product:video /api/v2/video/call/{type}/{id}/mark_ended: post: description: |2 diff --git a/openapi/v2/video-serverside-api.json b/openapi/v2/video-serverside-api.json index 13704401c..7f1389b16 100644 --- a/openapi/v2/video-serverside-api.json +++ b/openapi/v2/video-serverside-api.json @@ -1 +1 @@ -{"components":{"schemas":{"APIError":{"nullable":true,"properties":{"StatusCode":{"description":"Response HTTP status code","format":"int32","title":"Status code","type":"integer","x-stream-index":"004"},"code":{"description":"API error code","format":"int32","title":"Code","type":"integer","x-stream-index":"001"},"details":{"description":"Additional error-specific information","items":{"type":"integer"},"title":"Details","type":"array","x-stream-index":"007"},"duration":{"description":"Request duration","title":"Duration","type":"string","x-stream-index":"005"},"exception_fields":{"additionalProperties":{"type":"string"},"description":"Additional error info","title":"Exception fields","type":"object","x-stream-index":"003"},"message":{"description":"Message describing an error","title":"Message","type":"string","x-stream-index":"002"},"more_info":{"description":"URL with additional information","title":"More info","type":"string","x-stream-index":"006"},"unrecoverable":{"description":"Flag that indicates if the error is unrecoverable, requests that return unrecoverable errors should not be retried, this error only applies to the request that caused it","title":"Unrecoverable","type":"boolean","x-stream-index":"008"}},"required":["code","message","StatusCode","duration","more_info","details"],"title":"Error response","type":"object"},"APNConfig":{"properties":{"Disabled":{"type":"boolean","writeOnly":true,"x-stream-index":"005"},"auth_key":{"type":"string","x-stream-index":"006.001"},"auth_type":{"enum":["certificate","token"],"type":"string","x-stream-index":"001"},"bundle_id":{"type":"string","x-stream-index":"004"},"development":{"type":"boolean","x-stream-index":"002"},"host":{"type":"string","x-stream-index":"003"},"key_id":{"type":"string","x-stream-index":"006.002"},"notification_template":{"type":"string","x-stream-index":"008"},"p12_cert":{"type":"string","x-stream-index":"007.001"},"team_id":{"type":"string","x-stream-index":"006.003"}},"type":"object"},"APNConfigFields":{"properties":{"auth_key":{"type":"string","x-stream-index":"009"},"auth_type":{"type":"string","x-stream-index":"003"},"bundle_id":{"type":"string","x-stream-index":"006"},"development":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"host":{"type":"string","x-stream-index":"005"},"key_id":{"type":"string","x-stream-index":"008"},"notification_template":{"type":"string","x-stream-index":"004"},"p12_cert":{"type":"string","x-stream-index":"010"},"team_id":{"type":"string","x-stream-index":"007"}},"required":["enabled","development"],"type":"object"},"APNS":{"properties":{"body":{"type":"string","x-stream-index":"002"},"content-available":{"format":"int32","type":"integer","x-stream-index":"004"},"data":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"mutable-content":{"format":"int32","type":"integer","x-stream-index":"005"},"sound":{"type":"string","x-stream-index":"003"},"title":{"type":"string","x-stream-index":"001"}},"required":["title","body"],"type":"object"},"Action":{"nullable":true,"properties":{"name":{"type":"string","x-stream-index":"001"},"style":{"type":"string","x-stream-index":"003"},"text":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"004"},"value":{"type":"string","x-stream-index":"005"}},"required":["name","text","type"],"type":"object"},"ActiveCallsFPSStats":{"properties":{"p05":{"format":"float","type":"number","x-stream-index":"001"},"p10":{"format":"float","type":"number","x-stream-index":"002"},"p50":{"format":"float","type":"number","x-stream-index":"003"},"p90":{"format":"float","type":"number","x-stream-index":"004"}},"required":["p05","p10","p50","p90"],"type":"object"},"ActiveCallsLatencyStats":{"properties":{"p50":{"format":"float","type":"number","x-stream-index":"001"},"p90":{"format":"float","type":"number","x-stream-index":"002"}},"required":["p50","p90"],"type":"object"},"ActiveCallsMetrics":{"properties":{"join_call_api":{"$ref":"#/components/schemas/JoinCallAPIMetrics","x-stream-index":"001"},"publishers":{"$ref":"#/components/schemas/PublishersMetrics","x-stream-index":"002"},"subscribers":{"$ref":"#/components/schemas/SubscribersMetrics","x-stream-index":"003"}},"type":"object"},"ActiveCallsSummary":{"properties":{"active_calls":{"format":"int32","type":"integer","x-stream-index":"001"},"active_publishers":{"format":"int32","type":"integer","x-stream-index":"002"},"active_subscribers":{"format":"int32","type":"integer","x-stream-index":"003"},"participants":{"format":"int32","type":"integer","x-stream-index":"004"}},"required":["active_calls","active_publishers","active_subscribers","participants"],"type":"object"},"AppResponseFields":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"019"},"async_url_enrich_enabled":{"type":"boolean","x-stream-index":"017"},"auto_translation_enabled":{"type":"boolean","x-stream-index":"020"},"before_message_send_hook_url":{"type":"string","x-stream-index":"021"},"call_types":{"additionalProperties":{"$ref":"#/components/schemas/CallType"},"type":"object","x-stream-index":"007"},"campaign_enabled":{"type":"boolean","x-stream-index":"034"},"cdn_expiration_seconds":{"format":"int32","type":"integer","x-stream-index":"037"},"channel_configs":{"additionalProperties":{"$ref":"#/components/schemas/ChannelConfig"},"type":"object","x-stream-index":"006"},"custom_action_handler_url":{"type":"string","x-stream-index":"022"},"datadog_info":{"$ref":"#/components/schemas/DataDogInfo","x-stream-index":"040"},"disable_auth_checks":{"type":"boolean","x-stream-index":"011"},"disable_permissions_checks":{"type":"boolean","x-stream-index":"012"},"enforce_unique_usernames":{"type":"string","x-stream-index":"023"},"event_hooks":{"items":{"$ref":"#/components/schemas/EventHook"},"type":"array","x-stream-index":"045"},"file_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","x-stream-index":"030"},"geofences":{"items":{"$ref":"#/components/schemas/GeofenceResponse"},"type":"array","x-stream-index":"039"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"033"},"guest_user_creation_disabled":{"type":"boolean","x-stream-index":"043"},"image_moderation_enabled":{"type":"boolean","x-stream-index":"016"},"image_moderation_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"018"},"image_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","x-stream-index":"031"},"moderation_bulk_submit_action_enabled":{"type":"boolean","x-stream-index":"048"},"moderation_dashboard_preferences":{"$ref":"#/components/schemas/ModerationDashboardPreferences","x-stream-index":"044"},"moderation_enabled":{"type":"boolean","x-stream-index":"041"},"moderation_multitenant_blocklist_enabled":{"type":"boolean","x-stream-index":"042"},"moderation_webhook_url":{"type":"string","x-stream-index":"005"},"multi_tenant_enabled":{"type":"boolean","x-stream-index":"015"},"name":{"type":"string","x-stream-index":"001"},"organization":{"type":"string","x-stream-index":"002"},"permission_version":{"type":"string","x-stream-index":"013"},"policies":{"additionalProperties":{"items":{"$ref":"#/components/schemas/Policy"},"type":"array"},"type":"object","x-stream-index":"008"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationFields","x-stream-index":"003"},"reminders_interval":{"format":"int32","type":"integer","x-stream-index":"036"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"032"},"sns_key":{"type":"string","x-stream-index":"028"},"sns_secret":{"type":"string","x-stream-index":"029"},"sns_topic_arn":{"type":"string","x-stream-index":"027"},"sqs_key":{"type":"string","x-stream-index":"025"},"sqs_secret":{"type":"string","x-stream-index":"026"},"sqs_url":{"type":"string","x-stream-index":"024"},"suspended":{"type":"boolean","x-stream-index":"009"},"suspended_explanation":{"type":"string","x-stream-index":"010"},"use_hook_v2":{"type":"boolean","x-stream-index":"046"},"user_response_time_enabled":{"type":"boolean","x-stream-index":"047"},"user_search_disallowed_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"014"},"webhook_events":{"items":{"type":"string"},"type":"array","x-stream-index":"035"},"webhook_url":{"type":"string","x-stream-index":"004"}},"required":["name","organization","push_notifications","webhook_url","moderation_webhook_url","channel_configs","call_types","policies","suspended","suspended_explanation","disable_auth_checks","disable_permissions_checks","permission_version","user_search_disallowed_roles","multi_tenant_enabled","image_moderation_enabled","async_url_enrich_enabled","auto_translation_enabled","custom_action_handler_url","enforce_unique_usernames","sqs_url","sqs_key","sqs_secret","sns_topic_arn","sns_key","sns_secret","file_upload_config","image_upload_config","grants","campaign_enabled","webhook_events","reminders_interval","cdn_expiration_seconds","video_provider","moderation_enabled","moderation_multitenant_blocklist_enabled","guest_user_creation_disabled","event_hooks","use_hook_v2","user_response_time_enabled","moderation_bulk_submit_action_enabled"],"type":"object"},"AsyncExportChannelsEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"003.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.007"},"finished_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.004"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"task_id":{"type":"string","x-stream-index":"002.001"},"type":{"default":"export.channels.success","type":"string","x-stream-index":"003.002"},"url":{"type":"string","x-stream-index":"001"}},"required":["url","task_id","started_at","finished_at","type","created_at","custom"],"title":"AsyncExportChannelsEvent","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"},"AsyncExportErrorEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"003.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.007"},"error":{"type":"string","x-stream-index":"001"},"finished_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.004"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"task_id":{"type":"string","x-stream-index":"002.001"},"type":{"default":"export.users.error","type":"string","x-stream-index":"003.002"}},"required":["error","task_id","started_at","finished_at","type","created_at","custom"],"title":"AsyncExportErrorEvent","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"},"AsyncExportUsersEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"003.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.007"},"finished_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.004"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"task_id":{"type":"string","x-stream-index":"002.001"},"type":{"default":"export.users.success","type":"string","x-stream-index":"003.002"},"url":{"type":"string","x-stream-index":"001"}},"required":["url","task_id","started_at","finished_at","type","created_at","custom"],"title":"AsyncExportUsersEvent","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"},"AsyncModerationCallbackConfig":{"properties":{"mode":{"enum":["CALLBACK_MODE_NONE","CALLBACK_MODE_REST","CALLBACK_MODE_TWIRP"],"type":"string","x-stream-index":"002"},"server_url":{"type":"string","x-stream-index":"001"}},"type":"object"},"AsyncModerationConfiguration":{"properties":{"callback":{"$ref":"#/components/schemas/AsyncModerationCallbackConfig","x-stream-index":"002"},"timeout_ms":{"format":"int32","type":"integer","x-stream-index":"001"}},"type":"object"},"Attachment":{"description":"An attachment is a message object that represents a file uploaded by a user.","nullable":true,"properties":{"actions":{"items":{"$ref":"#/components/schemas/Action"},"type":"array","x-stream-index":"015"},"asset_url":{"type":"string","x-stream-index":"017"},"author_icon":{"type":"string","x-stream-index":"007"},"author_link":{"type":"string","x-stream-index":"006"},"author_name":{"type":"string","x-stream-index":"005"},"color":{"type":"string","x-stream-index":"003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"018"},"fallback":{"type":"string","x-stream-index":"002"},"fields":{"items":{"$ref":"#/components/schemas/Field"},"type":"array","x-stream-index":"016"},"footer":{"type":"string","x-stream-index":"013"},"footer_icon":{"type":"string","x-stream-index":"014"},"giphy":{"$ref":"#/components/schemas/Images","x-stream-index":"019"},"image_url":{"type":"string","x-stream-index":"011"},"og_scrape_url":{"type":"string","x-stream-index":"020"},"original_height":{"format":"int32","type":"integer","x-stream-index":"022"},"original_width":{"format":"int32","type":"integer","x-stream-index":"021"},"pretext":{"type":"string","x-stream-index":"004"},"text":{"type":"string","x-stream-index":"010"},"thumb_url":{"type":"string","x-stream-index":"012"},"title":{"type":"string","x-stream-index":"008"},"title_link":{"type":"string","x-stream-index":"009"},"type":{"description":"Attachment type (e.g. image, video, url)","title":"Type","type":"string","x-stream-index":"001"}},"required":["custom"],"title":"Attachment","type":"object","x-stream-docs-page-id":"file_uploads"},"AudioSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"001"},"default_device":{"enum":["speaker","earpiece"],"type":"string","x-stream-index":"006"},"mic_default_on":{"type":"boolean","x-stream-index":"004"},"noise_cancellation":{"$ref":"#/components/schemas/NoiseCancellationSettings","x-stream-index":"007"},"opus_dtx_enabled":{"type":"boolean","x-stream-index":"002"},"redundant_coding_enabled":{"type":"boolean","x-stream-index":"003"},"speaker_default_on":{"type":"boolean","x-stream-index":"005"}},"required":["access_request_enabled","opus_dtx_enabled","redundant_coding_enabled","mic_default_on","speaker_default_on","default_device"],"type":"object"},"AudioSettingsRequest":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"001"},"default_device":{"enum":["speaker","earpiece"],"type":"string","x-stream-index":"006"},"mic_default_on":{"type":"boolean","x-stream-index":"004"},"noise_cancellation":{"$ref":"#/components/schemas/NoiseCancellationSettings","x-stream-index":"007"},"opus_dtx_enabled":{"type":"boolean","x-stream-index":"002"},"redundant_coding_enabled":{"type":"boolean","x-stream-index":"003"},"speaker_default_on":{"type":"boolean","x-stream-index":"005"}},"required":["default_device"],"type":"object"},"AudioSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"001"},"default_device":{"enum":["speaker","earpiece"],"type":"string","x-stream-index":"006"},"mic_default_on":{"type":"boolean","x-stream-index":"004"},"noise_cancellation":{"$ref":"#/components/schemas/NoiseCancellationSettings","x-stream-index":"007"},"opus_dtx_enabled":{"type":"boolean","x-stream-index":"002"},"redundant_coding_enabled":{"type":"boolean","x-stream-index":"003"},"speaker_default_on":{"type":"boolean","x-stream-index":"005"}},"required":["access_request_enabled","opus_dtx_enabled","redundant_coding_enabled","mic_default_on","speaker_default_on","default_device"],"type":"object"},"AzureRequest":{"description":"Config for creating Azure Blob Storage storage","properties":{"abs_account_name":{"description":"The account name","title":"AccountName","type":"string","x-stream-index":"001"},"abs_client_id":{"description":"The client id","title":"ClientID","type":"string","x-stream-index":"003"},"abs_client_secret":{"description":"The client secret","title":"ClientSecret","type":"string","x-stream-index":"004"},"abs_tenant_id":{"description":"The tenant id","title":"TenantID","type":"string","x-stream-index":"002"}},"required":["abs_account_name","abs_tenant_id","abs_client_id","abs_client_secret"],"title":"AzureRequest","type":"object"},"BackstageSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"BackstageSettingsRequest":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"002"}},"type":"object"},"BackstageSettingsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"BlockListOptions":{"properties":{"behavior":{"description":"Blocklist behavior","enum":["flag","block","shadow_block"],"title":"Behavior","type":"string","x-stream-index":"002"},"blocklist":{"description":"Blocklist name","title":"Blocklist","type":"string","x-stream-index":"001"}},"required":["blocklist","behavior"],"type":"object"},"BlockListResponse":{"description":"Block list contains restricted words","properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001"},"id":{"type":"string","x-stream-index":"003"},"name":{"description":"Block list name","title":"Name","type":"string","x-stream-index":"004"},"team":{"type":"string","x-stream-index":"007"},"type":{"description":"Block list type.","title":"Type","type":"string","x-stream-index":"005"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"002"},"words":{"description":"List of words to block","items":{"type":"string"},"title":"Words","type":"array","x-stream-index":"006"}},"required":["name","type","words"],"title":"Block list","type":"object","x-stream-docs-page-id":"block_lists"},"BlockUserRequest":{"description":"BlockUserRequest is the payload for blocking a user.","nullable":true,"properties":{"user_id":{"description":"the user to block","title":"UserID","type":"string","x-stream-index":"003"}},"required":["user_id"],"title":"BlockUserRequest","type":"object"},"BlockUserResponse":{"description":"BlockUserResponse is the payload for blocking a user.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"BlockUserResponse","type":"object"},"BlockUsersRequest":{"nullable":true,"properties":{"blocked_user_id":{"description":"User id to block","title":"BlockedUserID","type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"required":["blocked_user_id"],"type":"object"},"BlockUsersResponse":{"nullable":true,"properties":{"blocked_by_user_id":{"description":"User id who blocked another user","title":"BlockedByUserID","type":"string","x-stream-index":"002"},"blocked_user_id":{"description":"User id who got blocked","title":"BlockedUserID","type":"string","x-stream-index":"003"},"created_at":{"description":"Timestamp when the user was blocked","format":"date-time","title":"CreatedAt","type":"number","x-stream-index":"004"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration","blocked_by_user_id","blocked_user_id","created_at"],"type":"object"},"BlockedUserEvent":{"description":"This event is sent to call participants to notify when a user is blocked on a call, clients can use this event to show a notification.\nIf the user is the current user, the client should leave the call screen as well","properties":{"blocked_by_user":{"$ref":"#/components/schemas/UserResponse","description":"The user that blocked the user, null if the user was blocked by server-side","title":"Blocked by","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.blocked_user","description":"The type of event: \"call.blocked_user\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user that was blocked","title":"User","x-stream-index":"003"}},"required":["type","created_at","call_cid","user"],"title":"BlockedUserEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"BlockedUserResponse":{"nullable":true,"properties":{"blocked_user":{"$ref":"#/components/schemas/UserResponse","description":"User who got blocked","title":"User","x-stream-index":"003"},"blocked_user_id":{"description":"ID of the user who got blocked","title":"UserID","type":"string","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who blocked another user","title":"User","x-stream-index":"001"},"user_id":{"description":"ID of the user who blocked another user","title":"UserID","type":"string","x-stream-index":"002"}},"required":["user","user_id","blocked_user","blocked_user_id","created_at"],"type":"object"},"Bound":{"properties":{"inclusive":{"type":"boolean","x-stream-index":"002"},"value":{"format":"float","type":"number","x-stream-index":"001"}},"required":["value","inclusive"],"type":"object"},"BroadcastSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettings","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettings","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"BroadcastSettingsRequest":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettingsRequest","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettingsRequest","x-stream-index":"003"}},"type":"object"},"BroadcastSettingsResponse":{"description":"BroadcastSettingsResponse is the payload for broadcasting settings","properties":{"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettingsResponse","title":"HLS","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettingsResponse","title":"RTMP","x-stream-index":"003"}},"required":["enabled","hls","rtmp"],"title":"BroadcastSettingsResponse","type":"object"},"BrowserDataResponse":{"properties":{"name":{"type":"string","x-stream-index":"001"},"version":{"type":"string","x-stream-index":"002"}},"type":"object"},"CallAcceptedEvent":{"description":"This event is sent when a user accepts a notification to join a call.","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.accepted","description":"The type of event: \"call.accepted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who accepted the call","title":"User","x-stream-index":"004"}},"required":["type","created_at","call_cid","call","user"],"title":"CallAcceptedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallClosedCaption":{"description":"CallClosedCaption represents a closed caption of a call.","properties":{"end_time":{"format":"date-time","title":"The end time of the closed caption.","type":"number","x-stream-index":"003"},"speaker_id":{"title":"The speaker ID of the closed caption.","type":"string","x-stream-index":"004"},"start_time":{"format":"date-time","title":"The start time of the closed caption.","type":"number","x-stream-index":"002"},"text":{"title":"The text of the closed caption.","type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserResponse","title":"The full user for the closed caption.","x-stream-index":"005"}},"required":["text","start_time","end_time","speaker_id","user"],"title":"CallClosedCaption","type":"object"},"CallClosedCaptionsFailedEvent":{"description":"This event is sent when call closed captions has failed","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.closed_captions_failed","description":"The type of event: \"call.closed_captions_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallClosedCaptionsFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallClosedCaptionsStartedEvent":{"description":"This event is sent when call closed caption has started","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.closed_captions_started","description":"The type of event: \"call.closed_captions_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallClosedCaptionsStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallClosedCaptionsStoppedEvent":{"description":"This event is sent when call closed captions has stopped","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.closed_captions_stopped","description":"The type of event: \"call.transcription_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallClosedCaptionsStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallCreatedEvent":{"description":"This event is sent when a call is created. Clients receiving this event should check if the ringing\nfield is set to true and if so, show the call screen","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"the members added to this call","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"004"},"type":{"default":"call.created","description":"The type of event: \"call.created\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","members"],"title":"CallCreatedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallDeletedEvent":{"description":"This event is sent when a call is deleted. Clients receiving this event should leave the call screen","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.deleted","description":"The type of event: \"call.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call"],"title":"CallDeletedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallDurationReport":{"properties":{"histogram":{"items":{"$ref":"#/components/schemas/ReportByHistogramBucket"},"type":"array","x-stream-index":"001"}},"required":["histogram"],"type":"object"},"CallDurationReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateCallDurationReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"CallEndedEvent":{"description":"This event is sent when a call is mark as ended for all its participants. Clients receiving this event should leave the call screen","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"reason":{"description":"The reason why the call ended, if available","title":"CallEndedReason","type":"string","x-stream-index":"005"},"type":{"default":"call.ended","description":"The type of event: \"call.ended\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who ended the call, null if the call was ended by the server","title":"User","x-stream-index":"004"}},"required":["type","created_at","call_cid","call"],"title":"CallEndedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallFrameRecordingFailedEvent":{"description":"This event is sent when frame recording has failed","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.frame_recording_failed","description":"The type of event: \"call.frame_recording_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","egress_id"],"title":"CallFrameRecordingFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallFrameRecordingFrameReadyEvent":{"description":"This event is sent when a frame is captured from a call","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"captured_at":{"description":"The time the frame was captured","format":"date-time","title":"CapturedAt","type":"number","x-stream-index":"006"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"008"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"track_type":{"description":"The type of the track frame was captured from (TRACK_TYPE_VIDEO|TRACK_TYPE_SCREEN_SHARE)","title":"TrackType","type":"string","x-stream-index":"004"},"type":{"default":"call.frame_recording_ready","description":"The type of event: \"call.frame_recording_ready\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"url":{"description":"The URL of the frame","title":"URL","type":"string","x-stream-index":"005"},"users":{"additionalProperties":{"$ref":"#/components/schemas/UserResponse"},"description":"The users in the frame","title":"Users","type":"object","x-stream-index":"007"}},"required":["type","created_at","call_cid","session_id","track_type","url","captured_at","users","egress_id"],"title":"CallFrameRecordingFrameReadyEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallFrameRecordingStartedEvent":{"description":"This event is sent when frame recording has started","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.frame_recording_started","description":"The type of event: \"call.frame_recording_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","egress_id"],"title":"CallFrameRecordingStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallFrameRecordingStoppedEvent":{"description":"This event is sent when frame recording has stopped","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.frame_recording_stopped","description":"The type of event: \"call.frame_recording_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","egress_id"],"title":"CallFrameRecordingStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallHLSBroadcastingFailedEvent":{"description":"This event is sent when HLS broadcasting has failed","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.hls_broadcasting_failed","description":"The type of event: \"call.hls_broadcasting_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallHLSBroadcastingFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallHLSBroadcastingStartedEvent":{"description":"This event is sent when HLS broadcasting has started","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"hls_playlist_url":{"type":"string","x-stream-index":"004"},"type":{"default":"call.hls_broadcasting_started","description":"The type of event: \"call.hls_broadcasting_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","hls_playlist_url"],"title":"CallHLSBroadcastingStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallHLSBroadcastingStoppedEvent":{"description":"This event is sent when HLS broadcasting has stopped","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.hls_broadcasting_stopped","description":"The type of event: \"call.hls_broadcasting_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallHLSBroadcastingStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallIngressResponse":{"description":"CallIngressResponse is the payload for ingress settings","properties":{"rtmp":{"$ref":"#/components/schemas/RTMPIngress","title":"RTMP","x-stream-index":"001"}},"required":["rtmp"],"title":"CallIngressResponse","type":"object"},"CallLiveStartedEvent":{"description":"This event is sent when a call is started. Clients receiving this event should start the call.","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.live_started","description":"The type of event: \"call.live_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call"],"title":"CallLiveStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMemberAddedEvent":{"description":"This event is sent when one or more members are added to a call","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"the members added to this call","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"004"},"type":{"default":"call.member_added","description":"The type of event: \"call.member_added\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","members"],"title":"CallMemberAddedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMemberRemovedEvent":{"description":"This event is sent when one or more members are removed from a call","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"the list of member IDs removed from the call","items":{"type":"string"},"title":"Members","type":"array","x-stream-index":"004"},"type":{"default":"call.member_removed","description":"The type of event: \"call.member_removed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","members"],"title":"CallMemberRemovedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMemberUpdatedEvent":{"description":"This event is sent when one or more members are updated","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"The list of members that were updated","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"004"},"type":{"default":"call.member_updated","description":"The type of event: \"call.member_updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","members"],"title":"CallMemberUpdatedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMemberUpdatedPermissionEvent":{"description":"This event is sent when one or more members get its role updated","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"capabilities_by_role":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"The capabilities by role for this call","title":"CapabilitiesByRole","type":"object","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"The list of members that were updated","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"005"},"type":{"default":"call.member_updated_permission","description":"The type of event: \"call.member_added\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","capabilities_by_role","members"],"title":"CallMemberUpdatedPermissionEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMissedEvent":{"description":"This event is sent to call members who did not accept/reject/join the call to notify they missed the call","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"List of members who missed the call","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"005"},"notify_user":{"type":"boolean","x-stream-index":"007"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.missed","description":"The type of event: \"call.notification\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The caller from whom the call was missed","title":"User","x-stream-index":"006"}},"required":["type","created_at","call_cid","session_id","call","members","user","notify_user"],"title":"CallMissedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallModerationBlurEvent":{"properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"type":{"default":"call.moderation_blur","type":"string","x-stream-index":"001.001"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["type","created_at","call_cid","user_id","custom"],"title":"CallModerationBlurEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallModerationWarningEvent":{"properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"message":{"type":"string","x-stream-index":"004"},"type":{"default":"call.moderation_warning","type":"string","x-stream-index":"001.001"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["type","created_at","call_cid","user_id","message","custom"],"title":"CallModerationWarningEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallNotificationEvent":{"description":"This event is sent to all call members to notify they are getting called","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"Call members","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"005"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.notification","description":"The type of event: \"call.notification\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user that sent the call notification","title":"User","x-stream-index":"006"}},"required":["type","created_at","call_cid","session_id","call","members","user"],"title":"CallNotificationEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallParticipantCountReport":{"properties":{"histogram":{"items":{"$ref":"#/components/schemas/ReportByHistogramBucket"},"type":"array","x-stream-index":"001"}},"required":["histogram"],"type":"object"},"CallParticipantCountReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateCallParticipantCountReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"CallParticipantResponse":{"properties":{"joined_at":{"format":"date-time","type":"number","x-stream-index":"004"},"role":{"type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"},"user_session_id":{"type":"string","x-stream-index":"002"}},"required":["user","user_session_id","role","joined_at"],"type":"object"},"CallReactionEvent":{"description":"This event is sent when a reaction is sent in a call, clients should use this to show the reaction in the call screen","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"reaction":{"$ref":"#/components/schemas/ReactionResponse","description":"the reaction object sent by the user on the call","title":"reaction","x-stream-index":"003"},"type":{"default":"call.reaction_new","description":"The type of event: \"call.reaction_new\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","reaction"],"title":"CallReactionEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRecording":{"description":"CallRecording represents a recording of a call.","properties":{"end_time":{"format":"date-time","title":"The end time of the recording.","type":"number","x-stream-index":"004"},"filename":{"title":"The filename of the recording.","type":"string","x-stream-index":"001"},"session_id":{"title":"The session ID of the recording.","type":"string","x-stream-index":"005"},"start_time":{"format":"date-time","title":"The start time of the recording.","type":"number","x-stream-index":"003"},"url":{"title":"The URL of the recording.","type":"string","x-stream-index":"002"}},"required":["filename","url","start_time","end_time","session_id"],"title":"CallRecording","type":"object"},"CallRecordingFailedEvent":{"description":"This event is sent when call recording has failed","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"003"},"type":{"default":"call.recording_failed","description":"The type of event: \"call.recording_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","egress_id"],"title":"CallRecordingFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRecordingReadyEvent":{"description":"This event is sent when call recording is ready","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"call_recording":{"$ref":"#/components/schemas/CallRecording","description":"The call recording object","title":"CallRecording","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.recording_ready","description":"The type of event: \"call.recording_ready\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call_recording","egress_id"],"title":"CallRecordingReadyEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRecordingStartedEvent":{"description":"This event is sent when call recording has started","properties":{"call_cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"egress_id":{"type":"string","x-stream-index":"001"},"type":{"default":"call.recording_started","description":"The type of event: \"call.recording_started\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001"}},"required":["egress_id","type","created_at","call_cid"],"title":"CallRecordingStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRecordingStoppedEvent":{"description":"This event is sent when call recording has stopped","properties":{"call_cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"egress_id":{"type":"string","x-stream-index":"001"},"type":{"default":"call.recording_stopped","description":"The type of event: \"call.recording_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001"}},"required":["egress_id","type","created_at","call_cid"],"title":"CallRecordingStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRejectedEvent":{"description":"This event is sent when a user rejects a notification to join a call.","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"reason":{"description":"Provides information about why the call was rejected. You can provide any value, but the Stream API and SDKs use these default values: rejected, cancel, timeout and busy","title":"Reason","type":"string","x-stream-index":"005"},"type":{"default":"call.rejected","description":"The type of event: \"call.rejected\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who rejected the call","title":"User","x-stream-index":"004"}},"required":["type","created_at","call_cid","call","user"],"title":"CallRejectedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallReportResponse":{"properties":{"ended_at":{"format":"date-time","type":"number","x-stream-index":"003"},"score":{"format":"float","type":"number","x-stream-index":"001"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002"}},"required":["score"],"type":"object"},"CallRequest":{"description":"CallRequest is the payload for creating a call.","properties":{"channel_cid":{"type":"string","x-stream-index":"009"},"created_by":{"$ref":"#/components/schemas/UserRequest","title":"The user that create this call","x-stream-index":"002"},"created_by_id":{"title":"The id of the user that create this call","type":"string","x-stream-index":"003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"members":{"items":{"$ref":"#/components/schemas/MemberRequest"},"maximum":100,"type":"array","x-stream-index":"005"},"settings_override":{"$ref":"#/components/schemas/CallSettingsRequest","x-stream-index":"006"},"starts_at":{"format":"date-time","type":"number","x-stream-index":"007"},"team":{"type":"string","x-stream-index":"001"},"video":{"type":"boolean","x-stream-index":"008"}},"title":"CallRequest","type":"object"},"CallResponse":{"description":"Represents a call","properties":{"backstage":{"type":"boolean","x-stream-index":"016"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"018"},"captioning":{"type":"boolean","x-stream-index":"013"},"channel_cid":{"type":"string","x-stream-index":"024"},"cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"The user that created the call","title":"Created By","x-stream-index":"007"},"current_session_id":{"type":"string","x-stream-index":"005"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"008"},"egress":{"$ref":"#/components/schemas/EgressResponse","x-stream-index":"021"},"ended_at":{"description":"Date/time when the call ended","format":"date-time","title":"Ended At","type":"number","x-stream-index":"014"},"id":{"description":"Call ID","title":"ID","type":"string","x-stream-index":"003"},"ingress":{"$ref":"#/components/schemas/CallIngressResponse","x-stream-index":"019"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"023"},"recording":{"type":"boolean","x-stream-index":"011"},"session":{"$ref":"#/components/schemas/CallSessionResponse","x-stream-index":"020"},"settings":{"$ref":"#/components/schemas/CallSettingsResponse","x-stream-index":"017"},"starts_at":{"description":"Date/time when the call will start","format":"date-time","title":"Starts At","type":"number","x-stream-index":"015"},"team":{"type":"string","x-stream-index":"006"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailResponse","x-stream-index":"022"},"transcribing":{"type":"boolean","x-stream-index":"012"},"type":{"description":"The type of call","title":"Type","type":"string","x-stream-index":"002"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"}},"required":["type","id","cid","current_session_id","created_by","custom","created_at","updated_at","recording","transcribing","captioning","backstage","settings","blocked_user_ids","ingress","egress"],"title":"CallResponse","type":"object"},"CallRingEvent":{"description":"This event is sent to all call members to notify they are getting called","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"005"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"Call members","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"006"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.ring","description":"The type of event: \"call.notification\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user that sent the call notification","title":"User","x-stream-index":"007"},"video":{"type":"boolean","x-stream-index":"008"}},"required":["type","created_at","call_cid","session_id","call","members","user","video"],"title":"CallRingEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRtmpBroadcastFailedEvent":{"description":"This event is sent when a call RTMP broadcast has failed","properties":{"call_cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"002.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.002"},"name":{"description":"Name of the given RTMP broadcast","title":"Name","type":"string","x-stream-index":"003"},"type":{"default":"call.rtmp_broadcast_failed","description":"The type of event: \"call.rtmp_broadcast_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","name"],"title":"CallRtmpBroadcastFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRtmpBroadcastStartedEvent":{"description":"This event is sent when RTMP broadcast has started","properties":{"call_cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"002.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.002"},"name":{"description":"Name of the given RTMP broadcast","title":"Name","type":"string","x-stream-index":"003"},"type":{"default":"call.rtmp_broadcast_started","description":"The type of event: \"call.rtmp_broadcast_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","name"],"title":"CallRtmpBroadcastStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRtmpBroadcastStoppedEvent":{"description":"This event is sent when RTMP broadcast has stopped","properties":{"call_cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"002.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.002"},"name":{"description":"Name of the given RTMP broadcast","title":"Name","type":"string","x-stream-index":"003"},"type":{"default":"call.rtmp_broadcast_stopped","description":"The type of event: \"call.rtmp_broadcast_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","name"],"title":"CallRtmpBroadcastStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSessionEndedEvent":{"description":"This event is sent when a call session ends","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_ended","description":"The type of event: \"call.session_ended\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","call"],"title":"CallSessionEndedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSessionParticipantCountsUpdatedEvent":{"description":"This event is sent when the participant counts in a call session are updated","properties":{"anonymous_participant_count":{"format":"int32","type":"integer","x-stream-index":"005"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"participants_count_by_role":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"004"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_participant_count_updated","description":"The type of event: \"call.session_participant_count_updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","participants_count_by_role","anonymous_participant_count"],"title":"CallSessionParticipantCountsUpdatedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSessionParticipantJoinedEvent":{"description":"This event is sent when a participant joins a call session","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"participant":{"$ref":"#/components/schemas/CallParticipantResponse","description":"The participant that joined the session","title":"Participant","x-stream-index":"004"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_participant_joined","description":"The type of event: \"call.session_participant_joined\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","participant"],"title":"CallSessionParticipantJoinedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSessionParticipantLeftEvent":{"description":"This event is sent when a participant leaves a call session","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"duration_seconds":{"description":"The duration participant was in the session in seconds","format":"int32","title":"Duration","type":"integer","x-stream-index":"005"},"participant":{"$ref":"#/components/schemas/CallParticipantResponse","description":"The participant that left the session","title":"Participant","x-stream-index":"004"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_participant_left","description":"The type of event: \"call.session_participant_left\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","participant","duration_seconds"],"title":"CallSessionParticipantLeftEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSessionResponse":{"properties":{"accepted_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"008"},"anonymous_participant_count":{"format":"int32","type":"integer","x-stream-index":"006"},"ended_at":{"format":"date-time","type":"number","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"live_ended_at":{"format":"date-time","type":"number","x-stream-index":"011"},"live_started_at":{"format":"date-time","type":"number","x-stream-index":"010"},"missed_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"009"},"participants":{"items":{"$ref":"#/components/schemas/CallParticipantResponse"},"type":"array","x-stream-index":"004"},"participants_count_by_role":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"005"},"rejected_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"007"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002"},"timer_ends_at":{"format":"date-time","type":"number","x-stream-index":"012"}},"required":["id","participants","participants_count_by_role","anonymous_participant_count","rejected_by","accepted_by","missed_by"],"type":"object"},"CallSessionStartedEvent":{"description":"This event is sent when a call session starts","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_started","description":"The type of event: \"call.session_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","call"],"title":"CallSessionStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSettings":{"properties":{"audio":{"$ref":"#/components/schemas/AudioSettings","x-stream-index":"001"},"backstage":{"$ref":"#/components/schemas/BackstageSettings","x-stream-index":"002"},"broadcasting":{"$ref":"#/components/schemas/BroadcastSettings","x-stream-index":"007"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordSettings","x-stream-index":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettings","x-stream-index":"008"},"ingress":{"$ref":"#/components/schemas/IngressSettings","x-stream-index":"014"},"limits":{"$ref":"#/components/schemas/LimitsSettings","x-stream-index":"012"},"recording":{"$ref":"#/components/schemas/RecordSettings","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettings","x-stream-index":"010"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettings","x-stream-index":"004"},"session":{"$ref":"#/components/schemas/SessionSettings","x-stream-index":"013"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettings","x-stream-index":"011"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettings","x-stream-index":"009"},"video":{"$ref":"#/components/schemas/VideoSettings","x-stream-index":"003"}},"type":"object"},"CallSettingsRequest":{"properties":{"audio":{"$ref":"#/components/schemas/AudioSettingsRequest","x-stream-index":"001"},"backstage":{"$ref":"#/components/schemas/BackstageSettingsRequest","x-stream-index":"002"},"broadcasting":{"$ref":"#/components/schemas/BroadcastSettingsRequest","x-stream-index":"010"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordingSettingsRequest","x-stream-index":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettingsRequest","x-stream-index":"003"},"ingress":{"$ref":"#/components/schemas/IngressSettingsRequest","x-stream-index":"014"},"limits":{"$ref":"#/components/schemas/LimitsSettingsRequest","x-stream-index":"012"},"recording":{"$ref":"#/components/schemas/RecordSettingsRequest","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettingsRequest","x-stream-index":"007"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettingsRequest","x-stream-index":"008"},"session":{"$ref":"#/components/schemas/SessionSettingsRequest","x-stream-index":"013"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettingsRequest","x-stream-index":"011"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettingsRequest","x-stream-index":"009"},"video":{"$ref":"#/components/schemas/VideoSettingsRequest","x-stream-index":"004"}},"type":"object"},"CallSettingsResponse":{"properties":{"audio":{"$ref":"#/components/schemas/AudioSettingsResponse","x-stream-index":"001"},"backstage":{"$ref":"#/components/schemas/BackstageSettingsResponse","x-stream-index":"002"},"broadcasting":{"$ref":"#/components/schemas/BroadcastSettingsResponse","x-stream-index":"003"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordingSettingsResponse","x-stream-index":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettingsResponse","x-stream-index":"004"},"ingress":{"$ref":"#/components/schemas/IngressSettingsResponse","x-stream-index":"014"},"limits":{"$ref":"#/components/schemas/LimitsSettingsResponse","x-stream-index":"012"},"recording":{"$ref":"#/components/schemas/RecordSettingsResponse","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettingsResponse","x-stream-index":"007"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettingsResponse","x-stream-index":"008"},"session":{"$ref":"#/components/schemas/SessionSettingsResponse","x-stream-index":"013"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettingsResponse","x-stream-index":"011"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettingsResponse","x-stream-index":"009"},"video":{"$ref":"#/components/schemas/VideoSettingsResponse","x-stream-index":"010"}},"required":["audio","backstage","broadcasting","geofencing","recording","frame_recording","ring","screensharing","transcription","video","thumbnails","limits","session"],"type":"object"},"CallStateResponseFields":{"description":"CallStateResponseFields is the payload for call state response","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001"},"members":{"description":"List of call members","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"002"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"004"}},"required":["call","members","own_capabilities","blocked_users"],"title":"CallStateResponseFields","type":"object"},"CallStatsReportReadyEvent":{"description":"This event is sent when the insights report is ready","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.stats_report_ready","description":"The type of event, \"call.report_ready\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id"],"title":"CallStatsReportReadyEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallStatsReportSummaryResponse":{"properties":{"call_cid":{"type":"string","x-stream-index":"001"},"call_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"008"},"call_session_id":{"type":"string","x-stream-index":"002"},"call_status":{"type":"string","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"first_stats_time":{"format":"date-time","type":"number","x-stream-index":"003"},"min_user_rating":{"format":"int32","type":"integer","x-stream-index":"006"},"quality_score":{"format":"int32","type":"integer","x-stream-index":"005"}},"required":["call_cid","call_session_id","first_stats_time","call_status","call_duration_seconds"],"type":"object"},"CallTranscription":{"description":"CallTranscription represents a transcription of a call.","properties":{"end_time":{"format":"date-time","title":"The end time of the transcription.","type":"number","x-stream-index":"004"},"filename":{"title":"The filename of the transcription.","type":"string","x-stream-index":"001"},"session_id":{"title":"The session ID of the transcription.","type":"string","x-stream-index":"005"},"start_time":{"format":"date-time","title":"The start time of the transcription.","type":"number","x-stream-index":"003"},"url":{"title":"The URL of the transcription.","type":"string","x-stream-index":"002"}},"required":["filename","url","start_time","end_time","session_id"],"title":"CallTranscription","type":"object"},"CallTranscriptionFailedEvent":{"description":"This event is sent when call transcription has failed","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"003"},"error":{"description":"The error message detailing why transcription failed.","title":"string","type":"string","x-stream-index":"004"},"type":{"default":"call.transcription_failed","description":"The type of event: \"call.transcription_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","egress_id"],"title":"CallTranscriptionFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallTranscriptionReadyEvent":{"description":"This event is sent when call transcription is ready","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"call_transcription":{"$ref":"#/components/schemas/CallTranscription","description":"The call transcription object","title":"CallTranscription","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.transcription_ready","description":"The type of event: \"call.transcription_ready\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call_transcription","egress_id"],"title":"CallTranscriptionReadyEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallTranscriptionStartedEvent":{"description":"This event is sent when call transcription has started","properties":{"call_cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"egress_id":{"type":"string","x-stream-index":"001"},"type":{"default":"call.transcription_started","description":"The type of event: \"call.transcription_started\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001"}},"required":["egress_id","type","created_at","call_cid"],"title":"CallTranscriptionStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallTranscriptionStoppedEvent":{"description":"This event is sent when call transcription has stopped","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"003"},"type":{"default":"call.transcription_stopped","description":"The type of event: \"call.transcription_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","egress_id"],"title":"CallTranscriptionStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallType":{"nullable":true,"properties":{"AppPK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"003"},"CreatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"005"},"ExternalStorage":{"type":"string","writeOnly":true,"x-stream-index":"009"},"Name":{"type":"string","writeOnly":true,"x-stream-index":"004"},"NotificationSettings":{"$ref":"#/components/schemas/NotificationSettings","x-stream-index":"008"},"PK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"002"},"Settings":{"$ref":"#/components/schemas/CallSettings","x-stream-index":"007"},"UpdatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"006"}},"required":["PK","AppPK","Name","CreatedAt","UpdatedAt","ExternalStorage"],"type":"object"},"CallTypeResponse":{"description":"CallTypeResponse is the payload for a call type.","properties":{"created_at":{"description":"the time the call type was created","format":"date-time","title":"CreatedAt","type":"number","x-stream-index":"005"},"external_storage":{"description":"the external storage for the call type","title":"ExternalStorage","type":"string","x-stream-index":"007"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"the permissions granted to each role","title":"Grants","type":"object","x-stream-index":"002"},"name":{"description":"the name of the call type","title":"Name","type":"string","x-stream-index":"001"},"notification_settings":{"$ref":"#/components/schemas/NotificationSettings","description":"the notification settings for the call type","title":"NotificationSettings","x-stream-index":"004"},"settings":{"$ref":"#/components/schemas/CallSettingsResponse","description":"the settings for the call type","title":"Settings","x-stream-index":"003"},"updated_at":{"description":"the time the call type was last updated","format":"date-time","title":"UpdatedAt","type":"number","x-stream-index":"006"}},"required":["name","grants","settings","notification_settings","created_at","updated_at"],"title":"CallTypeResponse","type":"object"},"CallUpdatedEvent":{"description":"This event is sent when a call is updated, clients should use this update the local state of the call.\nThis event also contains the capabilities by role for the call, clients should update the own_capability for the current.","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"capabilities_by_role":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"The capabilities by role for this call","title":"CapabilitiesByRole","type":"object","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.updated","description":"The type of event: \"call.ended\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","capabilities_by_role"],"title":"CallUpdatedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallUserFeedbackSubmittedEvent":{"description":"This event is sent when a user submits feedback for a call.","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"custom":{"additionalProperties":{},"description":"Custom data provided by the user","title":"Custom","type":"object","x-stream-index":"007"},"rating":{"description":"The rating given by the user (1-5)","format":"int32","title":"Rating","type":"integer","x-stream-index":"005"},"reason":{"description":"The reason provided by the user for the rating","title":"Reason","type":"string","x-stream-index":"006"},"sdk":{"type":"string","x-stream-index":"008"},"sdk_version":{"type":"string","x-stream-index":"009"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.user_feedback_submitted","description":"The type of event, \"call.user_feedback\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who submitted the feedback","title":"User","x-stream-index":"004"}},"required":["type","created_at","call_cid","session_id","user","rating"],"title":"CallUserFeedbackSubmittedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallUserMutedEvent":{"description":"This event is sent when a call member is muted","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"from_user_id":{"type":"string","x-stream-index":"003"},"muted_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"type":{"default":"call.user_muted","description":"The type of event: \"call.user_muted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","from_user_id","muted_user_ids"],"title":"CallUserMutedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallsPerDayReport":{"properties":{"count":{"format":"int64","type":"integer","x-stream-index":"001"}},"required":["count"],"type":"object"},"CallsPerDayReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateCallsPerDayReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"Channel":{"properties":{"active_live_locations":{"items":{"$ref":"#/components/schemas/SharedLocation"},"type":"array","x-stream-index":"034"},"auto_translation_enabled":{"type":"boolean","x-stream-index":"029"},"auto_translation_language":{"type":"string","x-stream-index":"030"},"cid":{"type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/ChannelConfig","x-stream-index":"026"},"config_overrides":{"$ref":"#/components/schemas/ConfigOverrides","x-stream-index":"027"},"cooldown":{"format":"int32","type":"integer","x-stream-index":"031"},"created_at":{"format":"date-time","type":"number","x-stream-index":"009"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"019"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"disabled":{"type":"boolean","x-stream-index":"017"},"frozen":{"type":"boolean","x-stream-index":"016"},"id":{"type":"string","x-stream-index":"004"},"invites":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"022"},"last_campaigns":{"type":"string","x-stream-index":"032"},"last_message_at":{"format":"date-time","type":"number","x-stream-index":"006"},"member_count":{"format":"int32","type":"integer","x-stream-index":"021"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"020"},"team":{"type":"string","x-stream-index":"028"},"truncated_by":{"$ref":"#/components/schemas/User","x-stream-index":"015"},"type":{"type":"string","x-stream-index":"005"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"010"}},"required":["cid","id","type","created_at","updated_at","frozen","disabled","custom","auto_translation_language"],"type":"object"},"ChannelConfig":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.026"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.021"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.022"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.027"},"blocklist":{"type":"string","x-stream-index":"001.023"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.024"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.025"},"commands":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"connect_events":{"type":"boolean","x-stream-index":"001.004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"custom_events":{"type":"boolean","x-stream-index":"001.012"},"mark_messages_pending":{"type":"boolean","x-stream-index":"001.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"001.020"},"mutes":{"type":"boolean","x-stream-index":"001.009"},"name":{"type":"string","x-stream-index":"001.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"001.028"},"partition_ttl":{"type":"integer","x-stream-index":"001.029"},"polls":{"type":"boolean","x-stream-index":"001.016"},"push_notifications":{"type":"boolean","x-stream-index":"001.013"},"quotes":{"type":"boolean","x-stream-index":"001.008"},"reactions":{"type":"boolean","x-stream-index":"001.006"},"read_events":{"type":"boolean","x-stream-index":"001.003"},"reminders":{"type":"boolean","x-stream-index":"001.014"},"replies":{"type":"boolean","x-stream-index":"001.007"},"search":{"type":"boolean","x-stream-index":"001.005"},"shared_locations":{"type":"boolean","x-stream-index":"001.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.030"},"typing_events":{"type":"boolean","x-stream-index":"001.002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"002.004"},"uploads":{"type":"boolean","x-stream-index":"001.010"},"url_enrichment":{"type":"boolean","x-stream-index":"001.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"001.017"}},"required":["name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","created_at","updated_at","commands"],"type":"object"},"ChannelConfigWithInfo":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.002.026"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.002.021"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.022"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.002.027"},"blocklist":{"type":"string","x-stream-index":"001.002.023"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.024"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.002.025"},"commands":{"items":{"$ref":"#/components/schemas/Command"},"type":"array","x-stream-index":"001.003"},"connect_events":{"type":"boolean","x-stream-index":"001.002.004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.001.003"},"custom_events":{"type":"boolean","x-stream-index":"001.002.012"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"002"},"mark_messages_pending":{"type":"boolean","x-stream-index":"001.002.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"001.002.020"},"mutes":{"type":"boolean","x-stream-index":"001.002.009"},"name":{"type":"string","x-stream-index":"001.002.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"001.002.028"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"001.002.029"},"polls":{"type":"boolean","x-stream-index":"001.002.016"},"push_notifications":{"type":"boolean","x-stream-index":"001.002.013"},"quotes":{"type":"boolean","x-stream-index":"001.002.008"},"reactions":{"type":"boolean","x-stream-index":"001.002.006"},"read_events":{"type":"boolean","x-stream-index":"001.002.003"},"reminders":{"type":"boolean","x-stream-index":"001.002.014"},"replies":{"type":"boolean","x-stream-index":"001.002.007"},"search":{"type":"boolean","x-stream-index":"001.002.005"},"shared_locations":{"type":"boolean","x-stream-index":"001.002.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.002.030"},"typing_events":{"type":"boolean","x-stream-index":"001.002.002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"uploads":{"type":"boolean","x-stream-index":"001.002.010"},"url_enrichment":{"type":"boolean","x-stream-index":"001.002.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"001.002.017"}},"required":["created_at","updated_at","name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","commands"],"type":"object"},"ChannelMember":{"nullable":true,"properties":{"archived_at":{"format":"date-time","type":"number","x-stream-index":"015"},"ban_expires":{"description":"Expiration date of the ban","format":"date-time","title":"Ban expires","type":"number","x-stream-index":"013"},"banned":{"description":"Whether member is banned this channel or not","title":"Banned","type":"boolean","x-stream-index":"012"},"channel_role":{"description":"Role of the member in the channel","title":"Channel Role","type":"string","x-stream-index":"018"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"invite_accepted_at":{"description":"Date when invite was accepted","format":"date-time","title":"Invited accepted at","type":"number","x-stream-index":"006"},"invite_rejected_at":{"description":"Date when invite was rejected","format":"date-time","title":"Invited rejected at","type":"number","x-stream-index":"007"},"invited":{"description":"Whether member was invited or not","title":"Invited","type":"boolean","x-stream-index":"005"},"is_moderator":{"description":"Whether member is channel moderator or not","title":"Is moderator","type":"boolean","x-stream-index":"003"},"notifications_muted":{"type":"boolean","x-stream-index":"019"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"016"},"role":{"description":"Permission level of the member in the channel (DEPRECATED: use channel_role instead)","enum":["member","moderator","admin","owner"],"title":"Role","type":"string","x-stream-index":"017"},"shadow_banned":{"description":"Whether member is shadow banned in this channel or not","title":"Shadow banned","type":"boolean","x-stream-index":"014"},"status":{"type":"string","x-stream-index":"008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"},"user_id":{"title":"User ID","type":"string","x-stream-index":"001"}},"required":["custom","created_at","updated_at","banned","shadow_banned","channel_role","notifications_muted"],"title":"Channel member","type":"object"},"ChannelMute":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel that is muted","title":"Channel","x-stream-index":"002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"004"},"expires":{"description":"Date/time of mute expiration","format":"date-time","title":"Expires","type":"number","x-stream-index":"003"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Owner of channel mute","title":"User","x-stream-index":"001"}},"required":["created_at","updated_at"],"type":"object"},"ChannelOwnCapability":{"description":"All possibility of string to use","enum":["ban-channel-members","cast-poll-vote","connect-events","create-attachment","delete-any-message","delete-channel","delete-own-message","flag-message","freeze-channel","join-channel","leave-channel","mute-channel","pin-message","query-poll-votes","quote-message","read-events","search-messages","send-custom-events","send-links","send-message","send-poll","send-reaction","send-reply","send-restricted-visibility-message","send-typing-events","set-channel-cooldown","share-location","skip-slow-mode","slow-mode","typing-events","update-any-message","update-channel","update-channel-members","update-own-message","update-thread","upload-file"],"title":"ChannelOwnCapability","type":"string"},"ChannelResponse":{"description":"Represents channel in chat","properties":{"auto_translation_enabled":{"description":"Whether auto translation is enabled or not","title":"Auto translation","type":"boolean","x-stream-index":"017"},"auto_translation_language":{"description":"Language to translate to when auto translation is active","title":"Auto translation language","type":"string","x-stream-index":"018"},"blocked":{"description":"Whether this channel is blocked by current user or not","title":"Blocked","type":"boolean","x-stream-index":"023"},"cid":{"description":"Channel CID (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/ChannelConfigWithInfo","description":"Channel configuration","title":"ChannelConfigWithInfo","x-stream-index":"013"},"cooldown":{"description":"Cooldown period after sending each message","format":"int32","title":"Cooldown","type":"integer","x-stream-index":"020"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"005"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"Creator of the channel","title":"UserResponse","x-stream-index":"008"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"026"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"007"},"disabled":{"type":"boolean","x-stream-index":"010"},"frozen":{"description":"Whether channel is frozen or not","title":"Frozen","type":"boolean","x-stream-index":"009"},"hidden":{"description":"Whether this channel is hidden by current user or not","title":"Hidden","type":"boolean","x-stream-index":"022"},"hide_messages_before":{"description":"Date since when the message history is accessible","format":"date-time","title":"Hide messages before","type":"number","x-stream-index":"019"},"id":{"description":"Channel unique ID","title":"ID","type":"string","x-stream-index":"001"},"last_message_at":{"description":"Date of the last message sent","format":"date-time","title":"Last message at","type":"number","x-stream-index":"004"},"member_count":{"description":"Number of members in the channel","format":"int32","title":"Member count","type":"integer","x-stream-index":"012"},"members":{"description":"List of channel members (max 100)","items":{"$ref":"#/components/schemas/ChannelMember"},"title":"ChannelMembers","type":"array","x-stream-index":"011"},"mute_expires_at":{"description":"Date of mute expiration","format":"date-time","title":"Mute expires at","type":"number","x-stream-index":"015"},"muted":{"description":"Whether this channel is muted or not","title":"Muted","type":"boolean","x-stream-index":"014"},"own_capabilities":{"description":"List of channel capabilities of authenticated user","items":{"$ref":"#/components/schemas/ChannelOwnCapability"},"title":"ChannelOwnCapability","type":"array","x-stream-index":"021"},"team":{"description":"Team the channel belongs to (multi-tenant only)","title":"Team","type":"string","x-stream-index":"016"},"truncated_at":{"description":"Date of the latest truncation of the channel","format":"date-time","title":"UserResponse","type":"number","x-stream-index":"024"},"truncated_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"025"},"type":{"description":"Type of the channel","title":"Type","type":"string","x-stream-docs-page-id":"channel_features","x-stream-index":"002"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"006"}},"required":["id","type","cid","created_at","updated_at","frozen","disabled","custom"],"title":"Channel","type":"object"},"ChatActivityStatsResponse":{"properties":{"Messages":{"$ref":"#/components/schemas/MessageStatsResponse","x-stream-index":"001"}},"type":"object"},"CheckExternalStorageResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"file_url":{"type":"string","x-stream-index":"002"}},"required":["duration","file_url"],"title":"Response","type":"object"},"CheckPushRequest":{"description":"Check push request","nullable":true,"properties":{"apn_template":{"description":"Push message template for APN","title":"APN template","type":"string","x-stream-docs-page-id":"push_template","x-stream-index":"002"},"event_type":{"description":"Type of event for push templates (default: message.new)","enum":["message.new","message.updated","reaction.new","reaction.updated","notification.reminder_due"],"title":"Event type","type":"string","x-stream-index":"008"},"firebase_data_template":{"description":"Push message data template for Firebase","title":"Firebase data template","type":"string","x-stream-docs-page-id":"push_template","x-stream-index":"004"},"firebase_template":{"description":"Push message template for Firebase","title":"Firebase template","type":"string","x-stream-docs-page-id":"push_template","x-stream-index":"003"},"message_id":{"description":"Message ID to send push notification for","title":"Message ID","type":"string","x-stream-index":"001"},"push_provider_name":{"description":"Name of push provider","title":"Name of push provider","type":"string","x-stream-index":"007"},"push_provider_type":{"description":"Push provider type","enum":["firebase","apn","huawei","xiaomi"],"title":"Type of push provider","type":"string","x-stream-index":"006"},"skip_devices":{"description":"Don't require existing devices to render templates","title":"Skip devices","type":"boolean","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"009.002"},"user_id":{"type":"string","x-stream-index":"009.001"}},"title":"CheckPushRequest","type":"object"},"CheckPushResponse":{"nullable":true,"properties":{"device_errors":{"additionalProperties":{"$ref":"#/components/schemas/DeviceErrorInfo"},"description":"Object with device errors","title":"Device errors","type":"object","x-stream-index":"001","x-stream-map":{"key":"device_id"}},"duration":{"type":"string","x-stream-index":"008.001"},"event_type":{"description":"The event type that was tested","title":"Event type","type":"string","x-stream-index":"004"},"general_errors":{"description":"List of general errors","items":{"type":"string"},"title":"General errors","type":"array","x-stream-index":"002"},"rendered_apn_template":{"title":"Rendered APN template","type":"string","x-stream-index":"005"},"rendered_firebase_template":{"title":"Rendered Firebase template","type":"string","x-stream-index":"006"},"rendered_message":{"additionalProperties":{"type":"string"},"title":"Rendered message","type":"object","x-stream-index":"007"},"skip_devices":{"description":"Don't require existing devices to render templates","title":"Skip devices","type":"boolean","x-stream-index":"003"}},"required":["duration"],"type":"object"},"CheckSNSRequest":{"nullable":true,"properties":{"sns_key":{"description":"AWS SNS access key","title":"SNS key","type":"string","x-stream-index":"002"},"sns_secret":{"description":"AWS SNS key secret","title":"SNS secret","type":"string","x-stream-index":"003"},"sns_topic_arn":{"description":"AWS SNS topic ARN","title":"SNS Topic ARN","type":"string","x-stream-index":"001"}},"type":"object"},"CheckSNSResponse":{"nullable":true,"properties":{"data":{"additionalProperties":{},"description":"Error data","title":"ReadOnlyData","type":"object","x-stream-index":"003"},"duration":{"type":"string","x-stream-index":"004.001"},"error":{"description":"Error text","title":"Error","type":"string","x-stream-index":"002"},"status":{"description":"Validation result","enum":["ok","error"],"title":"Status","type":"string","x-stream-index":"001"}},"required":["status","duration"],"type":"object"},"CheckSQSRequest":{"nullable":true,"properties":{"sqs_key":{"description":"AWS SQS access key","title":"SQS key","type":"string","x-stream-index":"002"},"sqs_secret":{"description":"AWS SQS key secret","title":"SQS secret","type":"string","x-stream-index":"003"},"sqs_url":{"description":"AWS SQS endpoint URL","title":"SQS URL","type":"string","x-stream-index":"001"}},"type":"object"},"CheckSQSResponse":{"nullable":true,"properties":{"data":{"additionalProperties":{},"description":"Error data","title":"ReadOnlyData","type":"object","x-stream-index":"003"},"duration":{"type":"string","x-stream-index":"004.001"},"error":{"description":"Error text","title":"Error","type":"string","x-stream-index":"002"},"status":{"description":"Validation result","enum":["ok","error"],"title":"Status","type":"string","x-stream-index":"001"}},"required":["status","duration"],"type":"object"},"ClientOSDataResponse":{"properties":{"architecture":{"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"version":{"type":"string","x-stream-index":"002"}},"type":"object"},"ClosedCaptionEvent":{"description":"This event is sent when closed captions are being sent in a call, clients should use this to show the closed captions in the call screen","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"closed_caption":{"$ref":"#/components/schemas/CallClosedCaption","description":"The closed caption object","title":"CallClosedCaption","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.closed_caption","description":"The type of event: \"call.closed_caption\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","closed_caption"],"title":"ClosedCaptionEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CollectUserFeedbackRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"009"},"rating":{"format":"int32","maximum":5,"minimum":1,"type":"integer","x-stream-index":"007"},"reason":{"maxLength":1000,"type":"string","x-stream-index":"008"},"sdk":{"maxLength":50,"type":"string","x-stream-index":"005"},"sdk_version":{"maxLength":50,"type":"string","x-stream-index":"006"},"user_session_id":{"maxLength":50,"type":"string","x-stream-index":"004"}},"required":["sdk","sdk_version","rating"],"type":"object"},"CollectUserFeedbackResponse":{"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"},"Command":{"description":"Represents custom chat command","nullable":true,"properties":{"args":{"description":"Arguments help text, shown in commands auto-completion","title":"Arguments","type":"string","x-stream-index":"006"},"created_at":{"description":"Date/time of creation","format":"date-time","readOnly":true,"title":"Created at","type":"number","x-stream-index":"001"},"description":{"description":"Description, shown in commands auto-completion","title":"Description","type":"string","x-stream-index":"005"},"name":{"description":"Unique command name","title":"Name","type":"string","x-stream-index":"004"},"set":{"description":"Set name used for grouping commands","title":"Set","type":"string","x-stream-index":"007"},"updated_at":{"description":"Date/time of the last update","format":"date-time","readOnly":true,"title":"Updated at","type":"number","x-stream-index":"002"}},"required":["name","description","args","set"],"title":"Command","type":"object"},"ConfigOverrides":{"properties":{"blocklist":{"type":"string","x-stream-index":"008"},"blocklist_behavior":{"enum":["flag","block"],"type":"string","x-stream-index":"009"},"commands":{"items":{"type":"string"},"type":"array","x-stream-index":"011"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"010"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"007"},"quotes":{"type":"boolean","x-stream-index":"004"},"reactions":{"type":"boolean","x-stream-index":"002"},"replies":{"type":"boolean","x-stream-index":"003"},"shared_locations":{"type":"boolean","x-stream-index":"013"},"typing_events":{"type":"boolean","x-stream-index":"001"},"uploads":{"type":"boolean","x-stream-index":"005"},"url_enrichment":{"type":"boolean","x-stream-index":"006"},"user_message_reminders":{"type":"boolean","x-stream-index":"012"}},"required":["grants","commands"],"type":"object"},"CountByMinuteResponse":{"nullable":true,"properties":{"count":{"format":"int32","type":"integer","x-stream-index":"002"},"start_ts":{"format":"date-time","type":"number","x-stream-index":"001"}},"required":["start_ts","count"],"type":"object"},"CreateBlockListRequest":{"description":"Block list contains restricted words","nullable":true,"properties":{"name":{"description":"Block list name","maxLength":255,"title":"Name","type":"string","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"004"},"type":{"description":"Block list type.","enum":["regex","domain","domain_allowlist","email","word"],"title":"Type","type":"string","x-stream-index":"003"},"words":{"description":"List of words to block","items":{"type":"string"},"minimum":1,"title":"Words","type":"array","x-stream-index":"002"}},"required":["name","words"],"title":"Block list","type":"object","x-stream-docs-page-id":"block_lists"},"CreateBlockListResponse":{"description":"Basic response information","nullable":true,"properties":{"blocklist":{"$ref":"#/components/schemas/BlockListResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["duration"],"title":"Response","type":"object"},"CreateCallTypeRequest":{"description":"Request for creating a call type","nullable":true,"properties":{"external_storage":{"description":"the external storage for the call type","title":"ExternalStorage","type":"string","x-stream-index":"002.004"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"the permissions granted to each role","title":"Grants","type":"object","x-stream-index":"002.001"},"name":{"type":"string","x-stream-index":"001"},"notification_settings":{"$ref":"#/components/schemas/NotificationSettings","description":"the notification settings for the call type","title":"NotificationSettings","x-stream-index":"002.002"},"settings":{"$ref":"#/components/schemas/CallSettingsRequest","description":"the settings for the call type","title":"Settings","x-stream-index":"002.003"}},"required":["name"],"title":"CreateCallTypeRequest","type":"object"},"CreateCallTypeResponse":{"description":"Response for creating a call type","nullable":true,"properties":{"created_at":{"description":"the time the call type was created","format":"date-time","title":"CreatedAt","type":"number","x-stream-index":"001.005"},"duration":{"type":"string","x-stream-index":"002.001"},"external_storage":{"description":"the external storage for the call type","title":"ExternalStorage","type":"string","x-stream-index":"001.007"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"the permissions granted to each role","title":"Grants","type":"object","x-stream-index":"001.002"},"name":{"description":"the name of the call type","title":"Name","type":"string","x-stream-index":"001.001"},"notification_settings":{"$ref":"#/components/schemas/NotificationSettings","description":"the notification settings for the call type","title":"NotificationSettings","x-stream-index":"001.004"},"settings":{"$ref":"#/components/schemas/CallSettingsResponse","description":"the settings for the call type","title":"Settings","x-stream-index":"001.003"},"updated_at":{"description":"the time the call type was last updated","format":"date-time","title":"UpdatedAt","type":"number","x-stream-index":"001.006"}},"required":["name","grants","settings","notification_settings","created_at","updated_at","duration"],"title":"CreateCallTypeResponse","type":"object"},"CreateDeviceRequest":{"description":"Create device request","nullable":true,"properties":{"id":{"description":"Device ID","maxLength":255,"minLength":1,"title":"ID","type":"string","x-stream-index":"001"},"push_provider":{"description":"Push provider","enum":["firebase","apn","huawei","xiaomi"],"title":"PushProvider","type":"string","x-stream-index":"002"},"push_provider_name":{"description":"Push provider name","title":"PushProviderName","type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"005.002"},"user_id":{"description":"**Server-side only**. User ID which server acts upon","title":"User ID","type":"string","x-stream-index":"005.001"},"voip_token":{"description":"When true the token is for Apple VoIP push notifications","title":"VoipToken","type":"boolean","x-stream-index":"004"}},"required":["id","push_provider"],"title":"CreateDeviceRequest","type":"object"},"CreateExternalStorageRequest":{"description":"Create external storage","nullable":true,"properties":{"aws_s3":{"$ref":"#/components/schemas/S3Request","description":"Only required if you want to create an Amazon S3 storage","title":"AwsS3","x-stream-index":"003.004"},"azure_blob":{"$ref":"#/components/schemas/AzureRequest","description":"Only required if you want to create an Azure Blob Storage","title":"AzureBlob","x-stream-index":"003.006"},"bucket":{"description":"The name of the bucket on the service provider","title":"Bucket","type":"string","x-stream-index":"003.002"},"gcs_credentials":{"type":"string","x-stream-index":"003.005"},"name":{"description":"The name of the provider, this must be unique","title":"Name","type":"string","x-stream-index":"001"},"path":{"description":"The path prefix to use for storing files","title":"Path","type":"string","x-stream-index":"003.003"},"storage_type":{"description":"The type of storage to use","enum":["s3","gcs","abs"],"title":"StorageType","type":"string","x-stream-index":"003.001"}},"required":["name","storage_type","bucket"],"title":"CreateExternalStorageRequest","type":"object"},"CreateExternalStorageResponse":{"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"},"CreateGuestRequest":{"nullable":true,"properties":{"user":{"$ref":"#/components/schemas/UserRequest","description":"User object which server acts upon","title":"User","x-stream-index":"001"}},"required":["user"],"type":"object"},"CreateGuestResponse":{"nullable":true,"properties":{"access_token":{"description":"the access token to authenticate the user","title":"Access token","type":"string","x-stream-index":"002"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User object which server acts upon","title":"User","x-stream-index":"001"}},"required":["user","access_token","duration"],"type":"object"},"CreateImportRequest":{"nullable":true,"properties":{"mode":{"enum":["insert","upsert"],"type":"string","x-stream-index":"002"},"path":{"type":"string","x-stream-index":"001"}},"required":["path","mode"],"type":"object"},"CreateImportResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"import_task":{"$ref":"#/components/schemas/ImportTask","x-stream-index":"001"}},"required":["duration"],"title":"Response","type":"object"},"CreateImportURLRequest":{"nullable":true,"properties":{"filename":{"type":"string","x-stream-index":"001"}},"type":"object"},"CreateImportURLResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"path":{"type":"string","x-stream-index":"001"},"upload_url":{"type":"string","x-stream-index":"002"}},"required":["path","upload_url","duration"],"title":"Response","type":"object"},"CreatePollOptionRequest":{"nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"003"},"text":{"description":"Option text","title":"string","type":"string","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"required":["text"],"type":"object"},"CreatePollRequest":{"description":"Contains all information needed to create a new poll","nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"011"},"allow_answers":{"description":"Indicates whether users can suggest user defined answers","title":"Allow answers","type":"boolean","x-stream-index":"009"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"008"},"description":{"description":"A description of the poll","title":"Description","type":"string","x-stream-index":"003"},"enforce_unique_vote":{"description":"Indicates whether users can cast multiple votes","title":"Multiple choice","type":"boolean","x-stream-index":"006"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"is_closed":{"description":"Indicates whether the poll is open for voting","title":"Is closed","type":"boolean","x-stream-index":"010"},"max_votes_allowed":{"description":"Indicates the maximum amount of votes a user can cast","format":"int32","maximum":10,"title":"Maximum votes allowed","type":"integer","x-stream-index":"007"},"name":{"description":"The name of the poll","title":"Name","type":"string","x-stream-index":"002"},"options":{"items":{"$ref":"#/components/schemas/PollOptionInput"},"maximum":100,"type":"array","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"012.002"},"user_id":{"type":"string","x-stream-index":"012.001"},"voting_visibility":{"enum":["anonymous","public"],"type":"string","x-stream-index":"005"}},"required":["name"],"title":"Create Poll Request","type":"object"},"CreateRoleRequest":{"nullable":true,"properties":{"name":{"description":"Role name","maxLength":64,"title":"Name","type":"string","x-stream-index":"001"}},"required":["name"],"type":"object"},"CreateRoleResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"role":{"$ref":"#/components/schemas/Role","x-stream-index":"002"}},"required":["duration","role"],"title":"Response","type":"object"},"CustomVideoEvent":{"description":"A custom event, this event is used to send custom events to other participants in the call.","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"003"},"type":{"default":"custom","description":"The type of event, \"custom\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"004"}},"required":["type","created_at","call_cid","custom","user"],"title":"CustomVideoEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"DailyAggregateCallDurationReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/CallDurationReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateCallParticipantCountReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/CallParticipantCountReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateCallsPerDayReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/CallsPerDayReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateQualityScoreReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/QualityScoreReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateSDKUsageReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/SDKUsageReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateUserFeedbackReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/UserFeedbackReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DataDogInfo":{"properties":{"api_key":{"type":"string","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"003"},"site":{"type":"string","x-stream-index":"002"}},"type":"object"},"DeactivateUserRequest":{"nullable":true,"properties":{"created_by_id":{"description":"ID of the user who deactivated the user","title":"Created by ID","type":"string","x-stream-index":"003"},"mark_messages_deleted":{"description":"Makes messages appear to be deleted","title":"Mark messages deleted","type":"boolean","x-stream-index":"002"}},"type":"object"},"DeactivateUserResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Deactivated user object","title":"User","x-stream-index":"001"}},"required":["duration"],"type":"object"},"DeactivateUsersRequest":{"description":"Deactivate users request","nullable":true,"properties":{"created_by_id":{"description":"ID of the user who deactivated the users","title":"Created by ID","type":"string","x-stream-index":"003"},"mark_channels_deleted":{"type":"boolean","x-stream-index":"004"},"mark_messages_deleted":{"description":"Makes messages appear to be deleted","title":"Mark messages deleted","type":"boolean","x-stream-index":"002"},"user_ids":{"description":"User IDs to deactivate","items":{"type":"string"},"maximum":100,"minimum":1,"title":"User IDs","type":"array","x-stream-index":"001"}},"required":["user_ids"],"title":"DeactivateUsersRequest","type":"object"},"DeactivateUsersResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"task_id":{"type":"string","x-stream-index":"001"}},"required":["task_id","duration"],"title":"Response","type":"object"},"DeleteCallRequest":{"description":"DeleteCallRequest is the payload for deleting a call.","nullable":true,"properties":{"hard":{"description":"if true the call will be hard deleted along with all related data","title":"Hard","type":"boolean","x-stream-index":"001"}},"title":"DeleteCallRequest","type":"object"},"DeleteCallResponse":{"description":"DeleteCallResponse is the payload for deleting a call.","nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","title":"Call","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"task_id":{"title":"TaskID","type":"string","x-stream-index":"002"}},"required":["call","duration"],"title":"DeleteCallResponse","type":"object"},"DeleteExternalStorageResponse":{"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"},"DeleteRecordingResponse":{"description":"Response for DeleteRecording","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"DeleteRecordingResponse","type":"object"},"DeleteTranscriptionResponse":{"description":"DeleteTranscriptionResponse is the payload for deleting a transcription.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"DeleteTranscriptionResponse","type":"object"},"DeleteUsersRequest":{"nullable":true,"properties":{"calls":{"description":"Calls delete mode.\nAffected calls are those that include exactly two members, one of whom is the user being deleted.\n\n* null or empty string - doesn't delete any calls\n* soft - marks user's calls and their related data as deleted (soft-delete)\n* hard - deletes user's calls and their data completely (hard-delete)\n","enum":["soft","hard"],"title":"Delete User's calls","type":"string","x-stream-index":"001.002.004"},"conversations":{"description":"Conversation channels delete mode.\nConversation channel is any channel which only has two members one of which is the user being deleted.\n\n* null or empty string - doesn't delete any conversation channels\n* soft - marks all conversation channels as deleted (same effect as Delete Channels with 'hard' option disabled)\n* hard - deletes channel and all its data completely including messages (same effect as Delete Channels with 'hard' option enabled)\n","enum":["soft","hard"],"title":"Delete Conversations","type":"string","x-stream-index":"001.002.003"},"files":{"description":"Delete user files.\n* false or empty string - doesn't delete any files\n* true - deletes all files uploaded by the user, including images and attachments.\n","title":"Delete User's files","type":"boolean","x-stream-index":"001.002.005"},"messages":{"description":"Message delete mode.\n\n* null or empty string - doesn't delete user messages\n* soft - marks all user messages as deleted without removing any related message data\n* pruning - marks all user messages as deleted, nullifies message information and removes some message data such as reactions and flags\n* hard - deletes messages completely with all related information\n","enum":["soft","pruning","hard"],"title":"Delete Messages","type":"string","x-stream-index":"001.002.002"},"new_call_owner_id":{"type":"string","x-stream-index":"001.002.007"},"new_channel_owner_id":{"type":"string","x-stream-index":"001.002.006"},"user":{"description":"User delete mode.\n\n* soft - marks user as deleted and retains all user data\n* pruning - marks user as deleted and nullifies user information\n* hard - deletes user completely. Requires 'hard' option for messages and conversations as well\n","enum":["soft","pruning","hard"],"title":"Delete User","type":"string","x-stream-index":"001.002.001"},"user_ids":{"description":"IDs of users to delete","items":{"type":"string"},"maximum":100,"minimum":1,"title":"User IDs","type":"array","x-stream-index":"001.001"}},"required":["user_ids"],"type":"object"},"DeleteUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"task_id":{"description":"ID of the task to delete users","title":"Task ID","type":"string","x-stream-index":"001"}},"required":["task_id","duration"],"type":"object"},"DeviceDataResponse":{"properties":{"name":{"type":"string","x-stream-index":"001"},"version":{"type":"string","x-stream-index":"002"}},"type":"object"},"DeviceErrorInfo":{"properties":{"error_message":{"type":"string","x-stream-index":"003"},"provider":{"type":"string","x-stream-index":"001"},"provider_name":{"type":"string","x-stream-index":"002"}},"required":["provider","provider_name","error_message"],"type":"object"},"DeviceResponse":{"description":"Response for Device","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"004"},"disabled":{"description":"Whether device is disabled or not","title":"Disabled","type":"boolean","x-stream-index":"005"},"disabled_reason":{"description":"Reason explaining why device had been disabled","title":"Reason","type":"string","x-stream-index":"006"},"id":{"description":"Device ID","title":"ID","type":"string","x-stream-index":"003"},"push_provider":{"description":"Push provider","title":"PushProvider","type":"string","x-stream-index":"001"},"push_provider_name":{"description":"Push provider name","title":"PushProviderName","type":"string","x-stream-index":"002"},"user_id":{"description":"User ID","title":"UserID","type":"string","x-stream-index":"008"},"voip":{"description":"When true the token is for Apple VoIP push notifications","title":"Voip","type":"boolean","x-stream-index":"007"}},"required":["push_provider","id","created_at","user_id"],"title":"DeviceResponse","type":"object"},"DraftPayloadResponse":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"html":{"type":"string","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"001"},"mentioned_users":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"008"},"mml":{"type":"string","x-stream-index":"003"},"parent_id":{"type":"string","x-stream-index":"005"},"poll_id":{"type":"string","x-stream-index":"013"},"quoted_message_id":{"type":"string","x-stream-index":"009"},"show_in_channel":{"type":"boolean","x-stream-index":"006"},"silent":{"type":"boolean","x-stream-index":"012"},"text":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"011"}},"required":["id","text","custom"],"type":"object"},"DraftResponse":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003"},"channel_cid":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"message":{"$ref":"#/components/schemas/DraftPayloadResponse","x-stream-index":"001"},"parent_id":{"type":"string","x-stream-index":"004"},"parent_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"005"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"006"}},"required":["message","channel_cid","created_at"],"type":"object"},"EdgeResponse":{"properties":{"continent_code":{"type":"string","x-stream-index":"007.003"},"country_iso_code":{"type":"string","x-stream-index":"007.002"},"green":{"format":"int32","type":"integer","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"latency_test_url":{"type":"string","x-stream-index":"002"},"latitude":{"format":"float","type":"number","x-stream-index":"006.001"},"longitude":{"format":"float","type":"number","x-stream-index":"006.002"},"red":{"format":"int32","type":"integer","x-stream-index":"005"},"subdivision_iso_code":{"type":"string","x-stream-index":"007.001"},"yellow":{"format":"int32","type":"integer","x-stream-index":"004"}},"required":["id","latency_test_url","green","yellow","red","latitude","longitude","subdivision_iso_code","country_iso_code","continent_code"],"type":"object"},"EgressHLSResponse":{"properties":{"playlist_url":{"type":"string","x-stream-index":"001"},"status":{"type":"string","x-stream-index":"002"}},"required":["playlist_url","status"],"type":"object"},"EgressRTMPResponse":{"properties":{"name":{"type":"string","x-stream-index":"001"},"started_at":{"format":"date-time","type":"number","x-stream-index":"004"},"stream_key":{"type":"string","x-stream-index":"003"},"stream_url":{"type":"string","x-stream-index":"002"}},"required":["name","started_at"],"type":"object"},"EgressResponse":{"properties":{"broadcasting":{"type":"boolean","x-stream-index":"001"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordingResponse","x-stream-index":"004"},"hls":{"$ref":"#/components/schemas/EgressHLSResponse","x-stream-index":"002"},"rtmps":{"items":{"$ref":"#/components/schemas/EgressRTMPResponse"},"type":"array","x-stream-index":"003"}},"required":["broadcasting","rtmps"],"type":"object"},"EndCallRequest":{"description":"Request for ending a call","nullable":true,"title":"EndCallRequest","type":"object"},"EndCallResponse":{"description":"Response for ending a call","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"EndCallResponse","type":"object"},"ErrorResult":{"properties":{"stacktrace":{"type":"string","x-stream-index":"003"},"type":{"type":"string","x-stream-index":"001"},"version":{"type":"string","x-stream-index":"004"}},"required":["type","description"],"type":"object"},"EventHook":{"nullable":true,"properties":{"callback":{"$ref":"#/components/schemas/AsyncModerationCallbackConfig","x-stream-index":"018.001.002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"019"},"enabled":{"type":"boolean","x-stream-index":"003"},"event_types":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"hook_type":{"type":"string","x-stream-index":"002"},"id":{"type":"string","x-stream-index":"001"},"sns_auth_type":{"type":"string","x-stream-index":"014"},"sns_key":{"type":"string","x-stream-index":"015"},"sns_region":{"type":"string","x-stream-index":"013"},"sns_role_arn":{"type":"string","x-stream-index":"017"},"sns_secret":{"type":"string","x-stream-index":"016"},"sns_topic_arn":{"type":"string","x-stream-index":"012"},"sqs_auth_type":{"type":"string","x-stream-index":"008"},"sqs_key":{"type":"string","x-stream-index":"009"},"sqs_queue_url":{"type":"string","x-stream-index":"006"},"sqs_region":{"type":"string","x-stream-index":"007"},"sqs_role_arn":{"type":"string","x-stream-index":"011"},"sqs_secret":{"type":"string","x-stream-index":"010"},"timeout_ms":{"format":"int32","type":"integer","x-stream-index":"018.001.001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"020"},"webhook_url":{"type":"string","x-stream-index":"005"}},"type":"object"},"EventNotificationSettings":{"properties":{"apns":{"$ref":"#/components/schemas/APNS","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"fcm":{"$ref":"#/components/schemas/FCM","x-stream-index":"003"}},"required":["enabled","apns","fcm"],"type":"object"},"ExportUserResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"004.001"},"messages":{"description":"List of exported messages","items":{"$ref":"#/components/schemas/MessageResponse"},"title":"Messages","type":"array","x-stream-index":"002"},"reactions":{"description":"List of exported reactions","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Reactions","type":"array","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Exported user object","title":"User","x-stream-index":"001"}},"required":["duration"],"type":"object"},"ExportUsersRequest":{"nullable":true,"properties":{"user_ids":{"items":{"type":"string"},"maximum":25,"minimum":1,"type":"array","x-stream-index":"001"}},"required":["user_ids"],"type":"object"},"ExportUsersResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"task_id":{"type":"string","x-stream-index":"001"}},"required":["task_id","duration"],"title":"Response","type":"object"},"ExternalStorageResponse":{"properties":{"bucket":{"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"path":{"type":"string","x-stream-index":"004"},"type":{"enum":["s3","gcs","abs"],"type":"string","x-stream-index":"002"}},"required":["name","type","bucket","path"],"type":"object"},"FCM":{"properties":{"data":{"additionalProperties":{},"type":"object","x-stream-index":"001"}},"type":"object"},"Field":{"nullable":true,"properties":{"short":{"type":"boolean","x-stream-index":"003"},"title":{"type":"string","x-stream-index":"001"},"value":{"type":"string","x-stream-index":"002"}},"required":["title","value","short"],"type":"object"},"FileUploadConfig":{"properties":{"allowed_file_extensions":{"items":{"type":"string"},"type":"array","x-stream-index":"001"},"allowed_mime_types":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"blocked_file_extensions":{"items":{"type":"string"},"type":"array","x-stream-index":"002"},"blocked_mime_types":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"size_limit":{"format":"int32","maximum":104857600,"minimum":0,"type":"integer","x-stream-index":"005"}},"required":["size_limit"],"type":"object"},"FileUploadRequest":{"nullable":true,"properties":{"file":{"description":"file field","title":"File","type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/OnlyUserID","description":"user for the request **server side only**","title":"User","x-stream-index":"002"}},"type":"object"},"FileUploadResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"file":{"description":"URL to the uploaded asset. Should be used to put to `asset_url` attachment field","title":"File","type":"string","x-stream-index":"001"},"thumb_url":{"description":"URL of the file thumbnail for supported file formats. Should be put to `thumb_url` attachment field","title":"Thumbnail URL","type":"string","x-stream-index":"002"}},"required":["duration"],"type":"object"},"FirebaseConfig":{"properties":{"Disabled":{"type":"boolean","writeOnly":true,"x-stream-index":"001"},"apn_template":{"type":"string","x-stream-index":"005"},"credentials_json":{"type":"string","x-stream-index":"006"},"data_template":{"type":"string","x-stream-index":"004"},"notification_template":{"type":"string","x-stream-index":"003"},"server_key":{"type":"string","x-stream-index":"002"}},"type":"object"},"FirebaseConfigFields":{"properties":{"apn_template":{"type":"string","x-stream-index":"004"},"credentials_json":{"type":"string","x-stream-index":"006"},"data_template":{"type":"string","x-stream-index":"003"},"enabled":{"type":"boolean","x-stream-index":"001"},"notification_template":{"type":"string","x-stream-index":"002"},"server_key":{"type":"string","x-stream-index":"005"}},"required":["enabled"],"type":"object"},"FrameRecordSettings":{"properties":{"capture_interval_in_seconds":{"format":"int32","maximum":60,"minimum":2,"type":"integer","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"},"quality":{"type":"string","x-stream-index":"002"}},"required":["mode","capture_interval_in_seconds"],"type":"object"},"FrameRecordingResponse":{"properties":{"status":{"type":"string","x-stream-index":"001"}},"required":["status"],"type":"object"},"FrameRecordingSettingsRequest":{"properties":{"capture_interval_in_seconds":{"format":"int32","maximum":60,"minimum":2,"type":"integer","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"},"quality":{"enum":["360p","480p","720p","1080p","1440p"],"type":"string","x-stream-index":"002"}},"required":["mode","capture_interval_in_seconds"],"type":"object"},"FrameRecordingSettingsResponse":{"properties":{"capture_interval_in_seconds":{"format":"int32","maximum":60,"minimum":2,"type":"integer","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"},"quality":{"type":"string","x-stream-index":"002"}},"required":["mode","capture_interval_in_seconds"],"type":"object"},"FullUserResponse":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"015"},"banned":{"type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"014"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.011"},"devices":{"items":{"$ref":"#/components/schemas/DeviceResponse"},"type":"array","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001.001"},"image":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"005"},"language":{"type":"string","x-stream-index":"001.005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"001.014"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"012"},"mutes":{"items":{"$ref":"#/components/schemas/UserMuteResponse"},"type":"array","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"001.002"},"online":{"type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"003"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.015"},"role":{"type":"string","x-stream-index":"001.006"},"shadow_banned":{"type":"boolean","x-stream-index":"013"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"009"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"010"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"008"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"011"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","devices","invisible","mutes","channel_mutes","unread_count","total_unread_count","unread_channels","unread_threads","shadow_banned","blocked_user_ids"],"type":"object"},"GeofenceResponse":{"nullable":true,"properties":{"country_codes":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"description":{"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"type":{"type":"string","x-stream-index":"002"}},"required":["name"],"type":"object"},"GeofenceSettings":{"properties":{"names":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"required":["names"],"type":"object"},"GeofenceSettingsRequest":{"properties":{"names":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"type":"object"},"GeofenceSettingsResponse":{"properties":{"names":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"required":["names"],"type":"object"},"GetActiveCallsStatusResponse":{"description":"Response containing active calls status information","nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"},"end_time":{"description":"End time of the status period","format":"date-time","title":"time.Time","type":"number","x-stream-index":"003"},"metrics":{"$ref":"#/components/schemas/ActiveCallsMetrics","description":"Detailed metrics","title":"*ActiveCallsMetrics","x-stream-index":"005"},"start_time":{"description":"Start time of the status period","format":"date-time","title":"time.Time","type":"number","x-stream-index":"002"},"summary":{"$ref":"#/components/schemas/ActiveCallsSummary","description":"Summary of active calls","title":"*ActiveCallsSummary","x-stream-index":"004"}},"required":["duration","start_time","end_time"],"title":"GetActiveCallsStatusResponse","type":"object"},"GetApplicationResponse":{"description":"Basic response information","nullable":true,"properties":{"app":{"$ref":"#/components/schemas/AppResponseFields","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["app","duration"],"title":"Response","type":"object"},"GetBlockListResponse":{"description":"Response for get block list","nullable":true,"properties":{"blocklist":{"$ref":"#/components/schemas/BlockListResponse","description":"Block list object","title":"BlockListResponse","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["duration"],"title":"GetBlockListResponse","type":"object","x-stream-docs-page-id":"get_block_list"},"GetBlockedUsersResponse":{"nullable":true,"properties":{"blocks":{"description":"Array of blocked user object","items":{"$ref":"#/components/schemas/BlockedUserResponse"},"title":"Blocks","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["blocks","duration"],"type":"object"},"GetCallReportResponse":{"description":"Basic response information","nullable":true,"properties":{"chat_activity":{"$ref":"#/components/schemas/ChatActivityStatsResponse","x-stream-index":"004"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"report":{"$ref":"#/components/schemas/ReportResponse","x-stream-index":"003"},"session_id":{"type":"string","x-stream-index":"002"},"video_reactions":{"items":{"$ref":"#/components/schemas/VideoReactionsResponse"},"type":"array","x-stream-index":"005"}},"required":["duration","session_id","report"],"title":"Response","type":"object"},"GetCallResponse":{"nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001.001"},"duration":{"type":"string","x-stream-index":"002.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001.002"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"001.004"}},"required":["call","members","own_capabilities","blocked_users","duration"],"title":"GetCallResponse","type":"object"},"GetCallTypeResponse":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.005"},"duration":{"type":"string","x-stream-index":"002.001"},"external_storage":{"type":"string","x-stream-index":"001.007"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"001.002"},"name":{"type":"string","x-stream-index":"001.001"},"notification_settings":{"$ref":"#/components/schemas/NotificationSettings","x-stream-index":"001.004"},"settings":{"$ref":"#/components/schemas/CallSettingsResponse","x-stream-index":"001.003"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.006"}},"required":["name","grants","settings","notification_settings","created_at","updated_at","duration"],"title":"GetCallTypeResponse","type":"object"},"GetCustomPermissionResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"permission":{"$ref":"#/components/schemas/Permission","x-stream-index":"001"}},"required":["permission","duration"],"title":"Response","type":"object"},"GetEdgesResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"edges":{"items":{"$ref":"#/components/schemas/EdgeResponse"},"type":"array","x-stream-index":"001"}},"required":["edges","duration"],"title":"Response","type":"object"},"GetImportResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"import_task":{"$ref":"#/components/schemas/ImportTask","x-stream-index":"001"}},"required":["duration"],"title":"Response","type":"object"},"GetOGResponse":{"nullable":true,"properties":{"actions":{"items":{"$ref":"#/components/schemas/Action"},"type":"array","x-stream-index":"001.015"},"asset_url":{"description":"URL of detected video or audio","title":"Image URL","type":"string","x-stream-index":"001.017"},"author_icon":{"type":"string","x-stream-index":"001.007"},"author_link":{"description":"og:site","title":"Author Link","type":"string","x-stream-index":"001.006"},"author_name":{"description":"og:site_name","title":"Author Name","type":"string","x-stream-index":"001.005"},"color":{"type":"string","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.018"},"duration":{"type":"string","x-stream-index":"002.001"},"fallback":{"type":"string","x-stream-index":"001.002"},"fields":{"items":{"$ref":"#/components/schemas/Field"},"type":"array","x-stream-index":"001.016"},"footer":{"type":"string","x-stream-index":"001.013"},"footer_icon":{"type":"string","x-stream-index":"001.014"},"giphy":{"$ref":"#/components/schemas/Images","x-stream-index":"001.019"},"image_url":{"description":"URL of detected image","title":"Image URL","type":"string","x-stream-index":"001.011"},"og_scrape_url":{"description":"extracted url from the text","title":"OG Scrape URL","type":"string","x-stream-index":"001.020"},"original_height":{"format":"int32","type":"integer","x-stream-index":"001.022"},"original_width":{"format":"int32","type":"integer","x-stream-index":"001.021"},"pretext":{"type":"string","x-stream-index":"001.004"},"text":{"description":"og:description","title":"Text","type":"string","x-stream-index":"001.010"},"thumb_url":{"description":"URL of detected thumb image","title":"Image URL","type":"string","x-stream-index":"001.012"},"title":{"description":"og:title","title":"Title","type":"string","x-stream-index":"001.008"},"title_link":{"description":"og:url","title":"Title Link","type":"string","x-stream-index":"001.009"},"type":{"description":"Attachment type, could be empty, image, audio or video","title":"Type","type":"string","x-stream-index":"001.001"}},"required":["custom","duration"],"title":"Get OG Attachment","type":"object","x-stream-docs-page-id":"og"},"GetOrCreateCallRequest":{"nullable":true,"properties":{"data":{"$ref":"#/components/schemas/CallRequest","title":"ReadOnlyData","x-stream-index":"003"},"members_limit":{"format":"int32","maximum":100,"type":"integer","x-stream-index":"007"},"notify":{"description":"if provided it sends a notification event to the members for this call","title":"Notify","type":"boolean","x-stream-index":"005"},"ring":{"description":"if provided it sends a ring event to the members for this call","title":"Ring","type":"boolean","x-stream-index":"004"},"video":{"type":"boolean","x-stream-index":"006"}},"title":"GetOrCreateCallRequest","type":"object"},"GetOrCreateCallResponse":{"nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001.001"},"created":{"type":"boolean","x-stream-index":"002"},"duration":{"type":"string","x-stream-index":"003.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001.002"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"001.004"}},"required":["call","members","own_capabilities","blocked_users","created","duration"],"title":"GetOrCreateCallResponse","type":"object"},"GetRateLimitsResponse":{"nullable":true,"properties":{"android":{"additionalProperties":{"$ref":"#/components/schemas/LimitInfo"},"description":"Map of endpoint rate limits for the Android platform","title":"Android","type":"object","x-stream-index":"002","x-stream-map":{"key":"endpoint","title":"Endpoint name","description":"The name of the endpoint for which the limits apply"}},"duration":{"type":"string","x-stream-index":"005.001"},"ios":{"additionalProperties":{"$ref":"#/components/schemas/LimitInfo"},"description":"Map of endpoint rate limits for the iOS platform","title":"iOS","type":"object","x-stream-index":"003","x-stream-map":{"key":"endpoint","title":"Endpoint name","description":"The name of the endpoint for which the limits apply"}},"server_side":{"additionalProperties":{"$ref":"#/components/schemas/LimitInfo"},"description":"Map of endpoint rate limits for the server-side platform","title":"Server-side","type":"object","x-stream-index":"001","x-stream-map":{"key":"endpoint","title":"Endpoint name","description":"The name of the endpoint for which the limits apply"}},"web":{"additionalProperties":{"$ref":"#/components/schemas/LimitInfo"},"description":"Map of endpoint rate limits for the web platform","title":"Web","type":"object","x-stream-index":"004","x-stream-map":{"key":"endpoint","title":"Endpoint name","description":"The name of the endpoint for which the limits apply"}}},"required":["duration"],"title":"Get Rate Limits Response","type":"object","x-stream-docs-page-id":"rate_limits"},"GetTaskResponse":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.003"},"duration":{"type":"string","x-stream-index":"004.001"},"error":{"$ref":"#/components/schemas/ErrorResult","description":"Error produced by task","title":"Error","x-stream-index":"003"},"result":{"additionalProperties":{},"description":"Result produced by task after completion","title":"Result","type":"object","x-stream-index":"002"},"status":{"description":"Current status of task","title":"Status","type":"string","x-stream-index":"001.002"},"task_id":{"description":"ID of task","title":"Task ID","type":"string","x-stream-index":"001.001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.004"}},"required":["task_id","status","created_at","updated_at","duration"],"title":"Get Task Response","type":"object","x-stream-docs-page-id":"tasks"},"GoLiveRequest":{"nullable":true,"properties":{"recording_storage_name":{"type":"string","x-stream-index":"005"},"start_closed_caption":{"type":"boolean","x-stream-index":"008"},"start_hls":{"type":"boolean","x-stream-index":"003"},"start_recording":{"type":"boolean","x-stream-index":"004"},"start_transcription":{"type":"boolean","x-stream-index":"007"},"transcription_storage_name":{"type":"string","x-stream-index":"006"}},"title":"GoLiveRequest","type":"object"},"GoLiveResponse":{"description":"Basic response information","nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["call","duration"],"title":"Response","type":"object"},"GroupedStatsResponse":{"nullable":true,"properties":{"name":{"type":"string","x-stream-index":"001"},"unique":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["name","unique"],"type":"object"},"HLSSettings":{"properties":{"auto_on":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"004"},"quality_tracks":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"required":["auto_on","enabled","quality_tracks"],"type":"object"},"HLSSettingsRequest":{"properties":{"auto_on":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"layout":{"$ref":"#/components/schemas/LayoutSettingsRequest","title":"LayoutSettings","x-stream-index":"004"},"quality_tracks":{"items":{"type":"string"},"maximum":3,"minimum":1,"type":"array","x-stream-index":"003"}},"required":["quality_tracks"],"title":"HLSSettingsRequest","type":"object"},"HLSSettingsResponse":{"description":"HLSSettings is the payload for HLS settings","properties":{"auto_on":{"title":"Auto On","type":"boolean","x-stream-index":"001"},"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"002"},"layout":{"$ref":"#/components/schemas/LayoutSettingsResponse","title":"Layout","x-stream-index":"004"},"quality_tracks":{"items":{"type":"string"},"title":"Quality Tracks","type":"array","x-stream-index":"003"}},"required":["auto_on","enabled","quality_tracks","layout"],"title":"HLSSettingsResponse","type":"object"},"HuaweiConfig":{"properties":{"Disabled":{"type":"boolean","writeOnly":true,"x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"secret":{"type":"string","x-stream-index":"002"}},"type":"object"},"HuaweiConfigFields":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"id":{"type":"string","x-stream-index":"002"},"secret":{"type":"string","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"ImageData":{"properties":{"frames":{"type":"string","x-stream-index":"005"},"height":{"type":"string","x-stream-index":"003"},"size":{"type":"string","x-stream-index":"004"},"url":{"type":"string","x-stream-index":"001"},"width":{"type":"string","x-stream-index":"002"}},"required":["url","width","height","size","frames"],"type":"object"},"ImageSize":{"properties":{"crop":{"description":"Crop mode","enum":["top","bottom","left","right","center"],"title":"Crop","type":"string","x-stream-index":"001"},"height":{"description":"Target image height","format":"int32","title":"Height","type":"integer","x-stream-index":"003"},"resize":{"description":"Resize method","enum":["clip","crop","scale","fill"],"title":"Resize","type":"string","x-stream-index":"002"},"width":{"description":"Target image width","format":"int32","title":"Width","type":"integer","x-stream-index":"004"}},"title":"Image size configuration","type":"object"},"ImageUploadRequest":{"nullable":true,"properties":{"file":{"type":"string","x-stream-index":"001.001"},"upload_sizes":{"description":"field with JSON-encoded array of image size configurations","items":{"$ref":"#/components/schemas/ImageSize"},"title":"Upload sizes","type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/OnlyUserID","x-stream-index":"001.002"}},"type":"object"},"ImageUploadResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.003.001"},"file":{"type":"string","x-stream-index":"001.001"},"thumb_url":{"type":"string","x-stream-index":"001.002"},"upload_sizes":{"description":"Array of image size configurations","items":{"$ref":"#/components/schemas/ImageSize"},"title":"Upload sizes","type":"array","x-stream-index":"002"}},"required":["duration"],"type":"object"},"Images":{"properties":{"fixed_height":{"$ref":"#/components/schemas/ImageData","x-stream-index":"002"},"fixed_height_downsampled":{"$ref":"#/components/schemas/ImageData","x-stream-index":"004"},"fixed_height_still":{"$ref":"#/components/schemas/ImageData","x-stream-index":"003"},"fixed_width":{"$ref":"#/components/schemas/ImageData","x-stream-index":"005"},"fixed_width_downsampled":{"$ref":"#/components/schemas/ImageData","x-stream-index":"007"},"fixed_width_still":{"$ref":"#/components/schemas/ImageData","x-stream-index":"006"},"original":{"$ref":"#/components/schemas/ImageData","x-stream-index":"001"}},"required":["original","fixed_height","fixed_height_still","fixed_height_downsampled","fixed_width","fixed_width_still","fixed_width_downsampled"],"type":"object"},"ImportTask":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"011"},"history":{"items":{"$ref":"#/components/schemas/ImportTaskHistory"},"type":"array","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"003"},"mode":{"type":"string","x-stream-index":"006"},"path":{"type":"string","x-stream-index":"005"},"size":{"format":"int64","type":"integer","x-stream-index":"007"},"state":{"type":"string","x-stream-index":"008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"012"}},"required":["id","path","mode","state","history","created_at","updated_at"],"type":"object"},"ImportTaskHistory":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"next_state":{"type":"string","x-stream-index":"006"},"prev_state":{"type":"string","x-stream-index":"005"}},"required":["prev_state","next_state","created_at"],"type":"object"},"IngressAudioEncodingOptions":{"properties":{"bitrate":{"maximum":128000,"minimum":16000,"type":"integer","x-stream-index":"003"},"channels":{"enum":["1","2"],"format":"int32","type":"integer","x-stream-index":"001"},"enable_dtx":{"type":"boolean","x-stream-index":"002"}},"required":["channels","enable_dtx","bitrate"],"type":"object"},"IngressAudioEncodingOptionsRequest":{"properties":{"bitrate":{"maximum":128000,"minimum":16000,"type":"integer","x-stream-index":"003"},"channels":{"enum":["1","2"],"format":"int32","type":"integer","x-stream-index":"001"},"enable_dtx":{"type":"boolean","x-stream-index":"002"}},"required":["channels","bitrate"],"type":"object"},"IngressAudioEncodingResponse":{"properties":{"bitrate":{"format":"int32","type":"integer","x-stream-index":"003"},"channels":{"format":"int32","type":"integer","x-stream-index":"001"},"enable_dtx":{"type":"boolean","x-stream-index":"002"}},"required":["channels","enable_dtx","bitrate"],"type":"object"},"IngressSettings":{"properties":{"audio_encoding_options":{"$ref":"#/components/schemas/IngressAudioEncodingOptions","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"video_encoding_options":{"additionalProperties":{"$ref":"#/components/schemas/IngressVideoEncodingOptions"},"type":"object","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"IngressSettingsRequest":{"properties":{"audio_encoding_options":{"$ref":"#/components/schemas/IngressAudioEncodingOptionsRequest","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"video_encoding_options":{"additionalProperties":{"$ref":"#/components/schemas/IngressVideoEncodingOptionsRequest"},"type":"object","x-stream-index":"003"}},"type":"object"},"IngressSettingsResponse":{"properties":{"audio_encoding_options":{"$ref":"#/components/schemas/IngressAudioEncodingResponse","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"video_encoding_options":{"additionalProperties":{"$ref":"#/components/schemas/IngressVideoEncodingResponse"},"type":"object","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"IngressVideoEncodingOptions":{"properties":{"layers":{"items":{"$ref":"#/components/schemas/IngressVideoLayer"},"minimum":1,"type":"array","x-stream-index":"001"}},"required":["layers"],"type":"object"},"IngressVideoEncodingOptionsRequest":{"properties":{"layers":{"items":{"$ref":"#/components/schemas/IngressVideoLayerRequest"},"minimum":1,"type":"array","x-stream-index":"001"}},"required":["layers"],"type":"object"},"IngressVideoEncodingResponse":{"properties":{"layers":{"items":{"$ref":"#/components/schemas/IngressVideoLayerResponse"},"type":"array","x-stream-index":"001"}},"required":["layers"],"type":"object"},"IngressVideoLayer":{"nullable":true,"properties":{"bitrate":{"minimum":1000,"type":"integer","x-stream-index":"002"},"codec":{"enum":["h264","vp8"],"type":"string","x-stream-index":"001"},"frame_rate":{"maximum":60,"minimum":1,"type":"integer","x-stream-index":"003"},"max_dimension":{"minimum":240,"type":"integer","x-stream-index":"005"},"min_dimension":{"minimum":240,"type":"integer","x-stream-index":"004"}},"required":["codec","bitrate","frame_rate","min_dimension","max_dimension"],"type":"object"},"IngressVideoLayerRequest":{"nullable":true,"properties":{"bitrate":{"format":"int32","minimum":1000,"type":"integer","x-stream-index":"002"},"codec":{"enum":["h264","vp8"],"type":"string","x-stream-index":"001"},"frame_rate_limit":{"maximum":60,"minimum":1,"type":"integer","x-stream-index":"005"},"max_dimension":{"minimum":240,"type":"integer","x-stream-index":"004"},"min_dimension":{"minimum":240,"type":"integer","x-stream-index":"003"}},"required":["codec","bitrate","min_dimension","max_dimension","frame_rate_limit"],"type":"object"},"IngressVideoLayerResponse":{"nullable":true,"properties":{"bitrate":{"type":"integer","x-stream-index":"002"},"codec":{"type":"string","x-stream-index":"001"},"frame_rate_limit":{"type":"integer","x-stream-index":"005"},"max_dimension":{"type":"integer","x-stream-index":"004"},"min_dimension":{"type":"integer","x-stream-index":"003"}},"required":["codec","bitrate","min_dimension","max_dimension","frame_rate_limit"],"type":"object"},"JoinCallAPIMetrics":{"properties":{"failures":{"format":"float","type":"number","x-stream-index":"002"},"latency":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"003"},"total":{"format":"float","type":"number","x-stream-index":"001"}},"required":["total","failures"],"type":"object"},"LabelThresholds":{"properties":{"block":{"description":"Threshold for automatic message block","format":"float","maximum":1,"minimum":0,"title":"Block","type":"number","x-stream-index":"002"},"flag":{"description":"Threshold for automatic message flag","format":"float","maximum":1,"minimum":0,"title":"Flag","type":"number","x-stream-index":"001"}},"type":"object"},"LayoutSettings":{"properties":{"detect_orientation":{"type":"boolean","x-stream-index":"005"},"external_app_url":{"type":"string","x-stream-index":"003"},"external_css_url":{"type":"string","x-stream-index":"004"},"name":{"enum":["spotlight","grid","single-participant","mobile","custom"],"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"required":["name","external_app_url","external_css_url"],"type":"object"},"LayoutSettingsRequest":{"properties":{"detect_orientation":{"type":"boolean","x-stream-index":"005"},"external_app_url":{"type":"string","x-stream-index":"003"},"external_css_url":{"type":"string","x-stream-index":"004"},"name":{"enum":["spotlight","grid","single-participant","mobile","custom"],"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"required":["name"],"type":"object"},"LayoutSettingsResponse":{"properties":{"detect_orientation":{"type":"boolean","x-stream-index":"005"},"external_app_url":{"type":"string","x-stream-index":"003"},"external_css_url":{"type":"string","x-stream-index":"004"},"name":{"enum":["spotlight","grid","single-participant","mobile","custom"],"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"required":["name","external_app_url","external_css_url"],"type":"object"},"LimitInfo":{"properties":{"limit":{"description":"The maximum number of calls allowed for the time window","format":"int32","title":"Limit","type":"integer","x-stream-index":"001"},"remaining":{"description":"The number of remaining calls in the current window","format":"int64","title":"Remaining","type":"integer","x-stream-index":"002"},"reset":{"description":"The Unix timestamp of the next window","format":"int64","title":"Reset","type":"integer","x-stream-index":"003"}},"required":["limit","remaining","reset"],"title":"Rate Limit info","type":"object","x-stream-docs-page-id":"rate_limits"},"LimitsSettings":{"properties":{"max_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"004"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"},"max_participants_exclude_owner":{"type":"boolean","x-stream-index":"003"},"max_participants_exclude_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"002"}},"required":["max_participants_exclude_roles"],"type":"object"},"LimitsSettingsRequest":{"properties":{"max_duration_seconds":{"format":"int32","minimum":0,"type":"integer","x-stream-index":"004"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"},"max_participants_exclude_owner":{"type":"boolean","x-stream-index":"003"},"max_participants_exclude_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"002"}},"type":"object"},"LimitsSettingsResponse":{"properties":{"max_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"004"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"},"max_participants_exclude_owner":{"type":"boolean","x-stream-index":"003"},"max_participants_exclude_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"002"}},"required":["max_participants_exclude_roles"],"type":"object"},"ListBlockListResponse":{"description":"Basic response information","nullable":true,"properties":{"blocklists":{"items":{"$ref":"#/components/schemas/BlockListResponse"},"type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["blocklists","duration"],"title":"Response","type":"object"},"ListCallTypeResponse":{"description":"Response for ListCallType","nullable":true,"properties":{"call_types":{"additionalProperties":{"$ref":"#/components/schemas/CallTypeResponse"},"type":"object","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["call_types","duration"],"title":"ListCallTypeResponse","type":"object"},"ListDevicesResponse":{"description":"List devices response","nullable":true,"properties":{"devices":{"description":"List of devices","items":{"$ref":"#/components/schemas/DeviceResponse"},"title":"Devices","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["devices","duration"],"title":"ListDevicesResponse","type":"object"},"ListExternalStorageResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"external_storages":{"additionalProperties":{"$ref":"#/components/schemas/ExternalStorageResponse"},"type":"object","x-stream-index":"002"}},"required":["duration","external_storages"],"title":"Response","type":"object"},"ListImportsResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"import_tasks":{"items":{"$ref":"#/components/schemas/ImportTask"},"type":"array","x-stream-index":"001"}},"required":["import_tasks","duration"],"title":"Response","type":"object"},"ListPermissionsResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"permissions":{"items":{"$ref":"#/components/schemas/Permission"},"type":"array","x-stream-index":"001"}},"required":["permissions","duration"],"title":"Response","type":"object"},"ListPushProvidersResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"push_providers":{"items":{"$ref":"#/components/schemas/PushProviderResponse"},"type":"array","x-stream-index":"001"}},"required":["push_providers","duration"],"title":"Response","type":"object"},"ListRecordingsResponse":{"description":"Response for listing recordings","nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"},"recordings":{"items":{"$ref":"#/components/schemas/CallRecording"},"title":"The list of recordings.","type":"array","x-stream-index":"002"}},"required":["duration","recordings"],"title":"ListRecordingsResponse","type":"object"},"ListRolesResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"roles":{"items":{"$ref":"#/components/schemas/Role"},"type":"array","x-stream-index":"001"}},"required":["roles","duration"],"title":"Response","type":"object"},"ListTranscriptionsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"},"transcriptions":{"description":"List of transcriptions for the call","items":{"$ref":"#/components/schemas/CallTranscription"},"title":"Transcriptions","type":"array","x-stream-index":"002"}},"required":["duration","transcriptions"],"title":"ListTranscriptionsResponse","type":"object"},"MemberRequest":{"description":"MemberRequest is the payload for adding a member to a call.","properties":{"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"003"},"role":{"title":"Role","type":"string","x-stream-index":"002"},"user_id":{"minLength":1,"title":"User ID","type":"string","x-stream-index":"001"}},"required":["user_id"],"title":"MemberRequest","type":"object"},"MemberResponse":{"description":"MemberResponse is the payload for a member of a call.","properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"005"},"custom":{"additionalProperties":{},"description":"Custom member response data","title":"Custom","type":"object","x-stream-index":"004"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"007"},"role":{"title":"Role","type":"string","x-stream-index":"003"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"006"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"},"user_id":{"type":"string","x-stream-index":"002"}},"required":["user","user_id","custom","created_at","updated_at"],"title":"MemberResponse","type":"object"},"Message":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"012"},"before_message_send_failed":{"type":"boolean","x-stream-index":"046"},"cid":{"type":"string","x-stream-index":"028"},"command":{"type":"string","x-stream-index":"006"},"created_at":{"format":"date-time","type":"number","x-stream-index":"030"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"034"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"033"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"023"},"html":{"type":"string","x-stream-index":"007"},"i18n":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"044"},"id":{"type":"string","x-stream-index":"002"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"040"},"latest_reactions":{"items":{"$ref":"#/components/schemas/Reaction"},"type":"array","x-stream-index":"013"},"mentioned_users":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"043"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"052"},"mml":{"type":"string","x-stream-index":"005"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"056"},"own_reactions":{"items":{"$ref":"#/components/schemas/Reaction"},"type":"array","x-stream-index":"014"},"parent_id":{"type":"string","x-stream-index":"019"},"pin_expires":{"format":"date-time","type":"number","x-stream-index":"051"},"pinned":{"type":"boolean","x-stream-index":"047"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"048"},"pinned_by":{"$ref":"#/components/schemas/User","x-stream-index":"050"},"poll":{"$ref":"#/components/schemas/Poll","x-stream-index":"054"},"poll_id":{"type":"string","x-stream-index":"053"},"quoted_message":{"$ref":"#/components/schemas/Message","x-stream-index":"025"},"quoted_message_id":{"type":"string","x-stream-index":"024"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"015"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"017"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"016"},"reminder":{"$ref":"#/components/schemas/MessageReminder","x-stream-index":"058"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"022"},"restricted_visibility":{"items":{"type":"string"},"type":"array","x-stream-index":"011"},"shadowed":{"type":"boolean","x-stream-index":"036"},"shared_location":{"$ref":"#/components/schemas/SharedLocation","x-stream-index":"055"},"show_in_channel":{"type":"boolean","x-stream-index":"021"},"silent":{"type":"boolean","x-stream-index":"045"},"text":{"type":"string","x-stream-index":"004"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"027"},"type":{"type":"string","x-stream-index":"008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"031"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"010"}},"required":["id","text","html","type","restricted_visibility","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reaction_groups","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned"],"type":"object"},"MessageReminder":{"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"004"},"channel_cid":{"type":"string","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"011"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"006"},"message_id":{"type":"string","x-stream-index":"005"},"remind_at":{"format":"date-time","type":"number","x-stream-index":"009"},"task_id":{"type":"string","x-stream-index":"010"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"012"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"user_id":{"type":"string","x-stream-index":"007"}},"required":["channel_cid","message_id","user_id","task_id","created_at","updated_at"],"type":"object"},"MessageResponse":{"description":"Represents any chat message","properties":{"attachments":{"description":"Array of message attachments","items":{"$ref":"#/components/schemas/Attachment"},"title":"Message attachments","type":"array","x-stream-docs-page-id":"message_format#attachment-format","x-stream-index":"008"},"cid":{"description":"Channel unique identifier in \u003ctype\u003e:\u003cid\u003e format","title":"Channel CID","type":"string","x-stream-index":"022"},"command":{"description":"Contains provided slash command","title":"Command","type":"string","x-stream-docs-page-id":"custom_commands_webhook","x-stream-index":"004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"023"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"026"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"025"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"018"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"041"},"html":{"description":"Contains HTML markup of the message. Can only be set when using server-side API","title":"HTML content","type":"string","x-stream-index":"005"},"i18n":{"additionalProperties":{"type":"string"},"description":"Object with translations. Key `language` contains the original language key. Other keys contain translations","title":"Internationalization info","type":"object","x-stream-docs-page-id":"translation","x-stream-index":"030"},"id":{"description":"Message ID is unique string identifier of the message","title":"ID","type":"string","x-stream-index":"001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"Contains image moderation information","title":"Image moderation labels","type":"object","x-stream-index":"028"},"latest_reactions":{"description":"List of 10 latest reactions to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Latest reactions","type":"array","x-stream-index":"009"},"mentioned_users":{"description":"List of mentioned users","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Mentioned Users","type":"array","x-stream-index":"029"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"036"},"mml":{"description":"Should be empty if `text` is provided. Can only be set when using server-side API","title":"Messaging Markup Language","type":"string","x-stream-docs-page-id":"mml_overview","x-stream-index":"003"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"039"},"own_reactions":{"description":"List of 10 latest reactions of authenticated user to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Own reactions","type":"array","x-stream-index":"010"},"parent_id":{"description":"ID of parent message (thread)","title":"Parent message ID","type":"string","x-stream-docs-page-id":"threads","x-stream-index":"015"},"pin_expires":{"description":"Date when pinned message expires","format":"date-time","title":"Pin expiration date","type":"number","x-stream-docs-page-id":"pinned_messages","x-stream-index":"035"},"pinned":{"description":"Whether message is pinned or not","title":"Pinned","type":"boolean","x-stream-docs-page-id":"pinned_messages","x-stream-index":"032"},"pinned_at":{"description":"Date when message got pinned","format":"date-time","title":"Pinned at","type":"number","x-stream-docs-page-id":"pinned_messages","x-stream-index":"033"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","description":"Contains user who pinned the message","title":"Pinned by","x-stream-docs-page-id":"pinned_messages","x-stream-index":"034"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"038"},"poll_id":{"description":"Identifier of the poll to include in the message","title":"Poll ID","type":"string","x-stream-index":"037"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","description":"Contains quoted message","title":"Quoted message","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"020"},"quoted_message_id":{"title":"ID of quoted message","type":"string","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"019"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing number of reactions of each type. Key: reaction type (string), value: number of reactions (int)","title":"Reaction counts","type":"object","x-stream-index":"011"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"014"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing scores of reactions of each type. Key: reaction type (string), value: total score of reactions (int)","title":"Reaction scores","type":"object","x-stream-index":"012"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"042"},"reply_count":{"description":"Number of replies to this message","format":"int32","title":"Reply count","type":"integer","x-stream-index":"017"},"restricted_visibility":{"description":"A list of user ids that have restricted visibility to the message, if the list is not empty, the message is only visible to the users in the list","items":{"type":"string"},"title":"Restricted visibility","type":"array","x-stream-index":"040"},"shadowed":{"description":"Whether the message was shadowed or not","title":"Shadowed","type":"boolean","x-stream-docs-page-id":"moderation#shadow-ban","x-stream-index":"027"},"shared_location":{"$ref":"#/components/schemas/SharedLocationResponseData","description":"Contains shared location data","title":"Shared Location","x-stream-index":"043"},"show_in_channel":{"description":"Whether thread reply should be shown in the channel as well","title":"Show in channel","type":"boolean","x-stream-docs-page-id":"threads","x-stream-index":"016"},"silent":{"description":"Whether message is silent or not","title":"Silent","type":"boolean","x-stream-index":"031"},"text":{"description":"Text of the message. Should be empty if `mml` is provided","title":"Text","type":"string","x-stream-index":"002"},"thread_participants":{"description":"List of users who participate in thread","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Thread participants","type":"array","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"021"},"type":{"description":"Contains type of the message","enum":["regular","ephemeral","error","reply","system","deleted"],"title":"Message Type","type":"string","x-stream-docs-page-id":"message_format#message-types","x-stream-index":"006"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"024"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Sender of the message. Required when using server-side API","title":"User object","x-stream-index":"007"}},"required":["id","text","html","type","user","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned","restricted_visibility"],"title":"Message","type":"object","x-stream-docs-page-id":"send_message"},"MessageStatsResponse":{"properties":{"count_over_time":{"items":{"$ref":"#/components/schemas/CountByMinuteResponse"},"type":"array","x-stream-index":"001"}},"type":"object"},"ModerationDashboardPreferences":{"properties":{"flag_user_on_flagged_content":{"type":"boolean","x-stream-index":"002"},"media_queue_blur_enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"ModerationV2Response":{"properties":{"action":{"type":"string","x-stream-index":"001"},"blocklist_matched":{"type":"string","x-stream-index":"005"},"image_harms":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"original_text":{"type":"string","x-stream-index":"002"},"platform_circumvented":{"type":"boolean","x-stream-index":"007"},"semantic_filter_matched":{"type":"string","x-stream-index":"006"},"text_harms":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"required":["action","original_text"],"type":"object"},"MuteUsersRequest":{"nullable":true,"properties":{"audio":{"title":"Audio","type":"boolean","x-stream-index":"005"},"mute_all_users":{"type":"boolean","x-stream-index":"003"},"muted_by":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"010"},"muted_by_id":{"type":"string","x-stream-index":"009"},"screenshare":{"title":"Screenshare","type":"boolean","x-stream-index":"007"},"screenshare_audio":{"title":"ScreenshareAudio","type":"boolean","x-stream-index":"008"},"user_ids":{"items":{"type":"string"},"title":"UserIDs","type":"array","x-stream-index":"004"},"video":{"title":"Video","type":"boolean","x-stream-index":"006"}},"title":"MuteUsersRequest","type":"object"},"MuteUsersResponse":{"description":"MuteUsersResponse is the response payload for the mute users endpoint.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"MuteUsersResponse","type":"object"},"NetworkMetricsReportResponse":{"properties":{"average_connection_time":{"format":"float","type":"number","x-stream-index":"003"},"average_jitter":{"format":"float","type":"number","x-stream-index":"002"},"average_latency":{"format":"float","type":"number","x-stream-index":"001"},"average_time_to_reconnect":{"format":"float","type":"number","x-stream-index":"004"}},"type":"object"},"NoiseCancellationSettings":{"properties":{"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode"],"type":"object"},"NotificationSettings":{"properties":{"call_live_started":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"002"},"call_missed":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"006"},"call_notification":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"004"},"call_ring":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"session_started":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"003"}},"required":["enabled","call_live_started","session_started","call_notification","call_ring","call_missed"],"type":"object"},"OnlyUserID":{"properties":{"id":{"type":"string","x-stream-index":"001"}},"required":["id"],"type":"object"},"OwnCapability":{"description":"All possibility of string to use","enum":["block-users","change-max-duration","create-call","create-reaction","enable-noise-cancellation","end-call","join-backstage","join-call","join-ended-call","mute-users","pin-for-everyone","read-call","remove-call-member","screenshare","send-audio","send-video","start-broadcast-call","start-closed-captions-call","start-frame-record-call","start-record-call","start-transcription-call","stop-broadcast-call","stop-closed-captions-call","stop-frame-record-call","stop-record-call","stop-transcription-call","update-call","update-call-member","update-call-permissions","update-call-settings"],"title":"OwnCapability","type":"string"},"ParticipantCountByMinuteResponse":{"nullable":true,"properties":{"first":{"format":"int32","type":"integer","x-stream-index":"002"},"last":{"format":"int32","type":"integer","x-stream-index":"003"},"max":{"format":"int32","type":"integer","x-stream-index":"004"},"min":{"format":"int32","type":"integer","x-stream-index":"005"},"start_ts":{"format":"date-time","type":"number","x-stream-index":"001"}},"required":["start_ts","first","last","max","min"],"type":"object"},"ParticipantCountOverTimeResponse":{"properties":{"by_minute":{"items":{"$ref":"#/components/schemas/ParticipantCountByMinuteResponse"},"type":"array","x-stream-index":"001"}},"type":"object"},"ParticipantReportResponse":{"properties":{"by_browser":{"items":{"$ref":"#/components/schemas/GroupedStatsResponse"},"type":"array","x-stream-index":"008"},"by_country":{"items":{"$ref":"#/components/schemas/GroupedStatsResponse"},"type":"array","x-stream-index":"005"},"by_device":{"items":{"$ref":"#/components/schemas/GroupedStatsResponse"},"type":"array","x-stream-index":"006"},"by_operating_system":{"items":{"$ref":"#/components/schemas/GroupedStatsResponse"},"type":"array","x-stream-index":"007"},"count_over_time":{"$ref":"#/components/schemas/ParticipantCountOverTimeResponse","x-stream-index":"004"},"max_concurrent":{"format":"int32","type":"integer","x-stream-index":"003"},"publishers":{"$ref":"#/components/schemas/PublisherStatsResponse","x-stream-index":"009"},"subscribers":{"$ref":"#/components/schemas/SubscriberStatsResponse","x-stream-index":"010"},"sum":{"format":"int32","type":"integer","x-stream-index":"001"},"unique":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["sum","unique"],"type":"object"},"PerSDKUsageReport":{"nullable":true,"properties":{"by_version":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"002"},"total":{"format":"int32","type":"integer","x-stream-index":"001"}},"required":["total","by_version"],"type":"object"},"Permission":{"properties":{"action":{"description":"Action name this permission is for (e.g. SendMessage)","title":"Action","type":"string","x-stream-index":"004"},"condition":{"additionalProperties":{},"description":"MongoDB style condition which decides whether or not the permission is granted","title":"Condition","type":"object","x-stream-index":"007"},"custom":{"description":"Whether this is a custom permission or built-in","title":"Custom","type":"boolean","x-stream-index":"009"},"description":{"description":"Description of the permission","title":"Description","type":"string","x-stream-index":"003"},"id":{"description":"Unique permission ID","title":"ID","type":"string","x-stream-index":"001"},"level":{"description":"Level at which permission could be applied (app or channel)","enum":["app","channel"],"title":"Level","type":"string","x-stream-index":"010"},"name":{"description":"Name of the permission","title":"Name","type":"string","x-stream-index":"002"},"owner":{"description":"Whether this permission applies to resource owner or not","title":"Owner","type":"boolean","x-stream-index":"005"},"same_team":{"description":"Whether this permission applies to teammates (multi-tenancy mode only)","title":"Same team","type":"boolean","x-stream-index":"006"},"tags":{"description":"List of tags of the permission","items":{"type":"string"},"title":"Tags","type":"array","x-stream-index":"011"}},"required":["id","name","description","action","owner","same_team","custom","level","tags"],"type":"object"},"PermissionRequestEvent":{"description":"This event is sent when a user requests access to a feature on a call,\nclients receiving this event should display a permission request to the user","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"permissions":{"description":"The list of permissions requested by the user","items":{"type":"string"},"title":"Permissions","type":"array","x-stream-index":"004"},"type":{"default":"call.permission_request","description":"The type of event: \"call.permission_request\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who sent the permission request","title":"User","x-stream-index":"003"}},"required":["type","created_at","call_cid","user","permissions"],"title":"PermissionRequestEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"PinRequest":{"description":"PinRequest is the payload for pinning a message.","nullable":true,"properties":{"session_id":{"description":"the session ID of the user who pinned the message","title":"SessionID","type":"string","x-stream-index":"003"},"user_id":{"description":"the user ID of the user who pinned the message","title":"UserID","type":"string","x-stream-index":"002"}},"required":["user_id","session_id"],"title":"PinRequest","type":"object"},"PinResponse":{"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"},"PlatformDataResponse":{"properties":{"browser":{"$ref":"#/components/schemas/BrowserDataResponse","x-stream-index":"003"},"device":{"$ref":"#/components/schemas/DeviceDataResponse","x-stream-index":"002"},"os":{"$ref":"#/components/schemas/ClientOSDataResponse","x-stream-index":"001"}},"required":["os","device","browser"],"type":"object"},"Policy":{"properties":{"action":{"type":"integer","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"010"},"name":{"type":"string","x-stream-index":"004"},"owner":{"type":"boolean","x-stream-index":"008"},"priority":{"format":"int32","type":"integer","x-stream-index":"009"},"resources":{"items":{"type":"string"},"type":"array","x-stream-index":"005"},"roles":{"items":{"type":"string"},"type":"array","x-stream-index":"006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"011"}},"required":["name","resources","roles","action","owner","priority","created_at","updated_at"],"type":"object"},"Poll":{"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"023"},"allow_answers":{"type":"boolean","x-stream-index":"010"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"009"},"answers_count":{"format":"int32","type":"integer","x-stream-index":"015"},"created_at":{"format":"date-time","type":"number","x-stream-index":"021"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"020"},"created_by_id":{"type":"string","x-stream-index":"019"},"description":{"type":"string","x-stream-index":"005"},"enforce_unique_vote":{"type":"boolean","x-stream-index":"007"},"id":{"type":"string","x-stream-index":"003"},"is_closed":{"type":"boolean","x-stream-index":"011"},"latest_answers":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array","x-stream-index":"017"},"latest_votes_by_option":{"additionalProperties":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array"},"type":"object","x-stream-index":"016"},"max_votes_allowed":{"format":"int32","type":"integer","x-stream-index":"008"},"name":{"type":"string","x-stream-index":"004"},"options":{"items":{"$ref":"#/components/schemas/PollOption"},"type":"array","x-stream-index":"013"},"own_votes":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array","x-stream-index":"018"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"022"},"vote_count":{"format":"int32","type":"integer","x-stream-index":"012"},"vote_counts_by_option":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"014"},"voting_visibility":{"type":"string","x-stream-index":"006"}},"required":["id","name","description","enforce_unique_vote","allow_user_suggested_options","allow_answers","vote_count","options","vote_counts_by_option","answers_count","latest_votes_by_option","latest_answers","own_votes","created_by_id","created_at","updated_at","Custom"],"type":"object"},"PollOption":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id","text","custom"],"type":"object"},"PollOptionInput":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"text":{"type":"string","x-stream-index":"002"}},"type":"object"},"PollOptionRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id"],"type":"object"},"PollOptionResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"poll_option":{"$ref":"#/components/schemas/PollOptionResponseData","description":"Poll option","title":"PollOptionResponseData","x-stream-index":"001"}},"required":["poll_option","duration"],"type":"object"},"PollOptionResponseData":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id","text","custom"],"type":"object"},"PollResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"poll":{"$ref":"#/components/schemas/PollResponseData","description":"Poll","title":"PollResponseData","x-stream-index":"001"}},"required":["poll","duration"],"type":"object"},"PollResponseData":{"properties":{"allow_answers":{"type":"boolean","x-stream-index":"008"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"007"},"answers_count":{"format":"int32","type":"integer","x-stream-index":"012"},"created_at":{"format":"date-time","type":"number","x-stream-index":"019"},"created_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"018"},"created_by_id":{"type":"string","x-stream-index":"017"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"021"},"description":{"type":"string","x-stream-index":"003"},"enforce_unique_vote":{"type":"boolean","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"is_closed":{"type":"boolean","x-stream-index":"009"},"latest_answers":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array","x-stream-index":"015"},"latest_votes_by_option":{"additionalProperties":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array"},"type":"object","x-stream-index":"014"},"max_votes_allowed":{"format":"int32","type":"integer","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"002"},"options":{"items":{"$ref":"#/components/schemas/PollOptionResponseData"},"type":"array","x-stream-index":"011"},"own_votes":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array","x-stream-index":"016"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"020"},"vote_count":{"format":"int32","type":"integer","x-stream-index":"010"},"vote_counts_by_option":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"013"},"voting_visibility":{"type":"string","x-stream-index":"004"}},"required":["id","name","description","voting_visibility","enforce_unique_vote","allow_user_suggested_options","allow_answers","vote_count","options","answers_count","vote_counts_by_option","latest_votes_by_option","latest_answers","own_votes","created_by_id","created_at","updated_at","custom"],"type":"object"},"PollVote":{"nullable":true,"properties":{"answer_text":{"type":"string","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"004"},"is_answer":{"type":"boolean","x-stream-index":"006"},"option_id":{"type":"string","x-stream-index":"005"},"poll_id":{"type":"string","x-stream-index":"003"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"011"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"009"},"user_id":{"type":"string","x-stream-index":"008"}},"required":["poll_id","id","option_id","created_at","updated_at"],"type":"object"},"PollVoteResponseData":{"nullable":true,"properties":{"answer_text":{"type":"string","x-stream-index":"005"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"id":{"type":"string","x-stream-index":"002"},"is_answer":{"type":"boolean","x-stream-index":"004"},"option_id":{"type":"string","x-stream-index":"003"},"poll_id":{"type":"string","x-stream-index":"001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"007"},"user_id":{"type":"string","x-stream-index":"006"}},"required":["poll_id","id","option_id","created_at","updated_at"],"type":"object"},"PollVotesResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"votes":{"description":"Poll votes","items":{"$ref":"#/components/schemas/PollVoteResponseData"},"title":"PollVoteResponseList","type":"array","x-stream-index":"001"}},"required":["votes","duration"],"type":"object"},"PrivacySettings":{"properties":{"read_receipts":{"$ref":"#/components/schemas/ReadReceipts","x-stream-index":"002"},"typing_indicators":{"$ref":"#/components/schemas/TypingIndicators","x-stream-index":"001"}},"type":"object"},"PrivacySettingsResponse":{"properties":{"read_receipts":{"$ref":"#/components/schemas/ReadReceiptsResponse","x-stream-index":"002"},"typing_indicators":{"$ref":"#/components/schemas/TypingIndicatorsResponse","x-stream-index":"001"}},"type":"object"},"PublisherAllMetrics":{"properties":{"audio":{"$ref":"#/components/schemas/PublisherAudioMetrics","x-stream-index":"001"},"rtt_ms":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"003"},"video":{"$ref":"#/components/schemas/PublisherVideoMetrics","x-stream-index":"002"}},"type":"object"},"PublisherAudioMetrics":{"properties":{"jitter_ms":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"001"}},"type":"object"},"PublisherStatsResponse":{"properties":{"by_track":{"items":{"$ref":"#/components/schemas/TrackStatsResponse"},"type":"array","x-stream-index":"003"},"total":{"format":"int32","type":"integer","x-stream-index":"001"},"unique":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["total","unique"],"type":"object"},"PublisherVideoMetrics":{"properties":{"fps_30":{"$ref":"#/components/schemas/ActiveCallsFPSStats","x-stream-index":"002"},"frame_encoding_time_ms":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"003"},"jitter_ms":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"001"}},"type":"object"},"PublishersMetrics":{"properties":{"all":{"$ref":"#/components/schemas/PublisherAllMetrics","x-stream-index":"001"}},"type":"object"},"PushConfig":{"properties":{"offline_only":{"type":"boolean","x-stream-index":"002"},"version":{"enum":["v1","v2","v3"],"type":"string","x-stream-index":"001"}},"required":["version"],"type":"object"},"PushNotificationFields":{"properties":{"apn":{"$ref":"#/components/schemas/APNConfigFields","x-stream-index":"002"},"firebase":{"$ref":"#/components/schemas/FirebaseConfigFields","x-stream-index":"003"},"huawei":{"$ref":"#/components/schemas/HuaweiConfigFields","x-stream-index":"004"},"offline_only":{"type":"boolean","x-stream-index":"001.002"},"providers":{"items":{"$ref":"#/components/schemas/PushProvider"},"type":"array","x-stream-index":"006"},"version":{"type":"string","x-stream-index":"001.001"},"xiaomi":{"$ref":"#/components/schemas/XiaomiConfigFields","x-stream-index":"005"}},"required":["version","offline_only","apn","firebase","huawei","xiaomi"],"type":"object"},"PushNotificationSettingsResponse":{"properties":{"disabled":{"type":"boolean","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"number","x-stream-index":"002"}},"type":"object"},"PushProvider":{"nullable":true,"properties":{"apn_auth_key":{"type":"string","x-stream-index":"012"},"apn_auth_type":{"type":"string","x-stream-index":"017"},"apn_development":{"type":"boolean","x-stream-index":"018"},"apn_host":{"type":"string","x-stream-index":"019"},"apn_key_id":{"type":"string","x-stream-index":"013"},"apn_notification_template":{"type":"string","x-stream-index":"020"},"apn_p12_cert":{"type":"string","x-stream-index":"014"},"apn_team_id":{"type":"string","x-stream-index":"015"},"apn_topic":{"type":"string","x-stream-index":"016"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"description":{"maxLength":128,"type":"string","x-stream-index":"007"},"disabled_at":{"format":"date-time","type":"number","x-stream-index":"010"},"disabled_reason":{"maxLength":255,"type":"string","x-stream-index":"011"},"firebase_apn_template":{"type":"string","x-stream-index":"025"},"firebase_credentials":{"type":"string","x-stream-index":"022"},"firebase_data_template":{"type":"string","x-stream-index":"023"},"firebase_host":{"type":"string","x-stream-index":"026"},"firebase_notification_template":{"type":"string","x-stream-index":"024"},"firebase_server_key":{"type":"string","x-stream-index":"021"},"huawei_app_id":{"type":"string","x-stream-index":"027"},"huawei_app_secret":{"type":"string","x-stream-index":"028"},"name":{"maxLength":36,"minLength":1,"type":"string","x-stream-index":"005"},"push_templates":{"items":{"$ref":"#/components/schemas/PushTemplate"},"type":"array","x-stream-index":"031"},"type":{"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"xiaomi_app_secret":{"type":"string","x-stream-index":"030"},"xiaomi_package_name":{"type":"string","x-stream-index":"029"}},"required":["name","type","created_at","updated_at"],"type":"object"},"PushProviderResponse":{"properties":{"apn_auth_key":{"type":"string","x-stream-index":"008"},"apn_auth_type":{"type":"string","x-stream-index":"013"},"apn_development":{"type":"boolean","x-stream-index":"014"},"apn_host":{"type":"string","x-stream-index":"015"},"apn_key_id":{"type":"string","x-stream-index":"009"},"apn_p12_cert":{"type":"string","x-stream-index":"010"},"apn_sandbox_certificate":{"type":"boolean","x-stream-index":"016"},"apn_supports_remote_notifications":{"type":"boolean","x-stream-index":"018"},"apn_supports_voip_notifications":{"type":"boolean","x-stream-index":"017"},"apn_team_id":{"type":"string","x-stream-index":"011"},"apn_topic":{"type":"string","x-stream-index":"012"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"description":{"type":"string","x-stream-index":"003"},"disabled_at":{"format":"date-time","type":"number","x-stream-index":"006"},"disabled_reason":{"type":"string","x-stream-index":"007"},"firebase_apn_template":{"type":"string","x-stream-index":"023"},"firebase_credentials":{"type":"string","x-stream-index":"020"},"firebase_data_template":{"type":"string","x-stream-index":"021"},"firebase_host":{"type":"string","x-stream-index":"024"},"firebase_notification_template":{"type":"string","x-stream-index":"022"},"firebase_server_key":{"type":"string","x-stream-index":"019"},"huawei_app_id":{"type":"string","x-stream-index":"025"},"huawei_app_secret":{"type":"string","x-stream-index":"026"},"name":{"type":"string","x-stream-index":"001"},"type":{"type":"string","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"005"},"xiaomi_app_secret":{"type":"string","x-stream-index":"028"},"xiaomi_package_name":{"type":"string","x-stream-index":"027"}},"required":["name","type","created_at","updated_at"],"type":"object"},"PushTemplate":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"enable_push":{"type":"boolean","x-stream-index":"003"},"event_type":{"enum":["message.new","message.updated","reaction.new","notification.reminder_due"],"type":"string","x-stream-index":"005"},"template":{"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"008"}},"required":["enable_push","event_type","created_at","updated_at"],"type":"object"},"QualityScoreReport":{"properties":{"histogram":{"items":{"$ref":"#/components/schemas/ReportByHistogramBucket"},"type":"array","x-stream-index":"001"}},"required":["histogram"],"type":"object"},"QualityScoreReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateQualityScoreReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"QueryAggregateCallStatsRequest":{"nullable":true,"properties":{"from":{"type":"string","x-stream-index":"002"},"report_types":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"to":{"type":"string","x-stream-index":"003"}},"type":"object"},"QueryAggregateCallStatsResponse":{"description":"Basic response information","nullable":true,"properties":{"call_duration_report":{"$ref":"#/components/schemas/CallDurationReportResponse","x-stream-index":"002"},"call_participant_count_report":{"$ref":"#/components/schemas/CallParticipantCountReportResponse","x-stream-index":"004"},"calls_per_day_report":{"$ref":"#/components/schemas/CallsPerDayReportResponse","x-stream-index":"003"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"network_metrics_report":{"$ref":"#/components/schemas/NetworkMetricsReportResponse","x-stream-index":"008"},"quality_score_report":{"$ref":"#/components/schemas/QualityScoreReportResponse","x-stream-index":"005"},"sdk_usage_report":{"$ref":"#/components/schemas/SDKUsageReportResponse","x-stream-index":"006"},"user_feedback_report":{"$ref":"#/components/schemas/UserFeedbackReportResponse","x-stream-index":"007"}},"required":["duration"],"title":"Response","type":"object"},"QueryCallMembersRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"002"},"id":{"maxLength":64,"type":"string","x-stream-index":"001.002"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"004.001"},"next":{"type":"string","x-stream-index":"004.002"},"prev":{"type":"string","x-stream-index":"004.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":1,"type":"array","x-stream-index":"003"},"type":{"maxLength":64,"type":"string","x-stream-index":"001.001"}},"required":["type","id"],"type":"object"},"QueryCallMembersResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["members","duration"],"title":"Response","type":"object"},"QueryCallParticipantsRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"003"}},"type":"object"},"QueryCallParticipantsResponse":{"nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001.001"},"duration":{"type":"string","x-stream-index":"004.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001.002"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"001.004"},"participants":{"description":"List of call participants","items":{"$ref":"#/components/schemas/CallParticipantResponse"},"title":"[]CallParticipantResponse","type":"array","x-stream-index":"002"},"total_participants":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["call","members","own_capabilities","blocked_users","participants","total_participants","duration"],"type":"object"},"QueryCallStatsRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"004.001"},"next":{"type":"string","x-stream-index":"004.002"},"prev":{"type":"string","x-stream-index":"004.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":2,"type":"array","x-stream-index":"002"}},"type":"object"},"QueryCallStatsResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"next":{"type":"string","x-stream-index":"003.001"},"prev":{"type":"string","x-stream-index":"003.002"},"reports":{"items":{"$ref":"#/components/schemas/CallStatsReportSummaryResponse"},"type":"array","x-stream-index":"001"}},"required":["reports","duration"],"title":"Response","type":"object"},"QueryCallsRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"title":"Filters","type":"object","x-stream-index":"003"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"006.001"},"next":{"type":"string","x-stream-index":"006.002"},"prev":{"type":"string","x-stream-index":"006.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":2,"title":"Sort","type":"array","x-stream-index":"004"}},"title":"QueryCallsRequest","type":"object"},"QueryCallsResponse":{"nullable":true,"properties":{"calls":{"items":{"$ref":"#/components/schemas/CallStateResponseFields"},"title":"Calls","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["calls","duration"],"title":"QueryCallsResponse","type":"object"},"QueryPollVotesRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","title":"Filter","type":"object","x-stream-index":"003"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"004"}},"type":"object"},"QueryPollsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","title":"Filter","type":"object","x-stream-index":"002"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"003"}},"type":"object"},"QueryPollsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"polls":{"description":"Polls data returned by the query","items":{"$ref":"#/components/schemas/PollResponseData"},"title":"PollsResponseData","type":"array","x-stream-index":"001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["polls","duration"],"type":"object"},"QueryUserFeedbackRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":2,"type":"array","x-stream-index":"002"}},"type":"object"},"QueryUserFeedbackResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"next":{"type":"string","x-stream-index":"003.001"},"prev":{"type":"string","x-stream-index":"003.002"},"user_feedback":{"items":{"$ref":"#/components/schemas/UserFeedbackResponse"},"type":"array","x-stream-index":"001"}},"required":["user_feedback","duration"],"title":"Response","type":"object"},"QueryUsersPayload":{"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"include_deactivated_users":{"type":"boolean","x-stream-index":"004"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.003"},"offset":{"format":"int32","maximum":1000,"type":"integer","x-stream-index":"005.004"},"presence":{"type":"boolean","x-stream-index":"003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"006.002"},"user_id":{"type":"string","x-stream-index":"006.001"}},"required":["filter_conditions"],"type":"object"},"QueryUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"users":{"description":"Array of users as result of filters applied.","items":{"$ref":"#/components/schemas/FullUserResponse"},"title":"Users","type":"array","x-stream-index":"001"}},"required":["users","duration"],"type":"object"},"RTMPBroadcastRequest":{"description":"RTMPBroadcastRequest is the payload for starting an RTMP broadcast.","properties":{"layout":{"$ref":"#/components/schemas/LayoutSettingsRequest","description":"If provided, will override the call's RTMP settings layout","title":"Layout","x-stream-index":"005"},"name":{"description":"Name identifier for RTMP broadcast, must be unique in call","maxLength":255,"title":"Name","type":"string","x-stream-index":"001"},"quality":{"description":"If provided, will override the call's RTMP settings quality","enum":["360p","480p","720p","1080p","1440p","portrait-360x640","portrait-480x854","portrait-720x1280","portrait-1080x1920","portrait-1440x2560"],"title":"Quality","type":"string","x-stream-index":"004"},"stream_key":{"description":"If provided, will be appended at the end of stream_url","title":"Stream Key","type":"string","x-stream-index":"003"},"stream_url":{"description":"URL for the RTMP server to send the call to","maxLength":255,"title":"Stream URL","type":"string","x-stream-index":"002"}},"required":["name","stream_url"],"title":"RTMPBroadcastRequest","type":"object"},"RTMPIngress":{"description":"RTMP input settings","properties":{"address":{"title":"Address","type":"string","x-stream-index":"001"}},"required":["address"],"title":"RTMPIngress","type":"object"},"RTMPLocation":{"properties":{"name":{"type":"string","x-stream-index":"001"},"stream_key":{"type":"string","x-stream-index":"003"},"stream_url":{"type":"string","x-stream-index":"002"}},"required":["name","stream_url","stream_key"],"type":"object"},"RTMPSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"003"},"location":{"$ref":"#/components/schemas/RTMPLocation","x-stream-index":"004"},"quality_name":{"type":"string","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"RTMPSettingsRequest":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettingsRequest","description":"Layout for the composed RTMP stream","title":"LayoutSettings","x-stream-index":"003"},"quality":{"description":"Resolution to set for the RTMP stream","enum":["360p","480p","720p","1080p","1440p","portrait-360x640","portrait-480x854","portrait-720x1280","portrait-1080x1920","portrait-1440x2560"],"title":"Quality","type":"string","x-stream-index":"002"}},"title":"RTMPSettingsRequest","type":"object"},"RTMPSettingsResponse":{"description":"RTMPSettingsResponse is the payload for RTMP settings","properties":{"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettingsResponse","title":"Layout","x-stream-index":"003"},"quality":{"title":"Quality","type":"string","x-stream-index":"002"}},"required":["enabled","quality","layout"],"title":"RTMPSettingsResponse","type":"object"},"Reaction":{"nullable":true,"properties":{"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"message_id":{"type":"string","x-stream-index":"003"},"score":{"format":"int32","type":"integer","x-stream-index":"007"},"type":{"maxLength":30,"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["message_id","type","score","created_at","updated_at","custom"],"type":"object"},"ReactionGroupResponse":{"description":"ReactionGroupResponse contains all information about a reaction of the same type.","nullable":true,"properties":{"count":{"description":"Count is the number of reactions of this type.","format":"int32","title":"Count","type":"integer","x-stream-index":"001"},"first_reaction_at":{"description":"FirstReactionAt is the time of the first reaction of this type. This is the same also if all reaction of this type are deleted, because if someone will react again with the same type, will be preserved the sorting.","format":"date-time","title":"FirstReactionAt","type":"number","x-stream-index":"003"},"last_reaction_at":{"description":"LastReactionAt is the time of the last reaction of this type.","format":"date-time","title":"LastReactionAt","type":"number","x-stream-index":"004"},"sum_scores":{"description":"SumScores is the sum of all scores of reactions of this type. Medium allows you to clap articles more than once and shows the sum of all claps from all users. For example, you can send `clap` x5 using `score: 5`.","format":"int32","title":"SumScores","type":"integer","x-stream-index":"002"}},"required":["count","sum_scores","first_reaction_at","last_reaction_at"],"title":"ReactionGroupResponse","type":"object"},"ReactionResponse":{"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"006"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"008"},"message_id":{"description":"Message ID","title":"Message ID","type":"string","x-stream-index":"001"},"score":{"description":"Score of the reaction","format":"int32","title":"Score","type":"integer","x-stream-index":"005"},"type":{"description":"Type of reaction","title":"Type","type":"string","x-stream-index":"004"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"007"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User","title":"UserResponse","x-stream-index":"003"},"user_id":{"description":"User ID","title":"User ID","type":"string","x-stream-index":"002"}},"required":["message_id","user_id","user","type","score","created_at","updated_at","custom"],"type":"object"},"ReactivateUserRequest":{"nullable":true,"properties":{"created_by_id":{"description":"ID of the user who's reactivating the user","title":"Created by ID","type":"string","x-stream-index":"004"},"name":{"description":"Set this field to put new name for the user","title":"Name","type":"string","x-stream-index":"003"},"restore_messages":{"description":"Restore previously deleted messages","title":"Restore messages","type":"boolean","x-stream-index":"002"}},"type":"object"},"ReactivateUserResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.002.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Deactivated user object","title":"User","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"ReactivateUsersRequest":{"description":"Reactivate users in batches","nullable":true,"properties":{"created_by_id":{"description":"ID of the user who's reactivating the users","title":"Created by ID","type":"string","x-stream-index":"003"},"restore_channels":{"type":"boolean","x-stream-index":"004"},"restore_messages":{"description":"Restore previously deleted messages","title":"Restore messages","type":"boolean","x-stream-index":"002"},"user_ids":{"description":"User IDs to reactivate","items":{"type":"string"},"maximum":100,"minimum":1,"title":"User IDs","type":"array","x-stream-index":"001"}},"required":["user_ids"],"title":"ReactivateUsersRequest","type":"object"},"ReactivateUsersResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.002.001"},"task_id":{"type":"string","x-stream-index":"001.001"}},"required":["task_id","duration"],"title":"Response","type":"object"},"ReadReceipts":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"ReadReceiptsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"RecordSettings":{"properties":{"audio_only":{"type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"004"},"mode":{"type":"string","x-stream-index":"002"},"quality":{"type":"string","x-stream-index":"003"}},"required":["mode"],"type":"object"},"RecordSettingsRequest":{"properties":{"audio_only":{"type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettingsRequest","title":"LayoutSettings","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"title":"Mode","type":"string","x-stream-index":"002"},"quality":{"enum":["360p","480p","720p","1080p","1440p","portrait-360x640","portrait-480x854","portrait-720x1280","portrait-1080x1920","portrait-1440x2560"],"type":"string","x-stream-index":"003"}},"required":["mode"],"title":"RecordSettingsRequest","type":"object"},"RecordSettingsResponse":{"description":"RecordSettings is the payload for recording settings","properties":{"audio_only":{"title":"Audio Only","type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettingsResponse","title":"Layout","x-stream-index":"004"},"mode":{"title":"Mode","type":"string","x-stream-index":"002"},"quality":{"title":"Quality","type":"string","x-stream-index":"003"}},"required":["audio_only","mode","quality","layout"],"title":"RecordSettingsResponse","type":"object"},"ReminderResponseData":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003"},"channel_cid":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"005"},"message_id":{"type":"string","x-stream-index":"004"},"remind_at":{"format":"date-time","type":"number","x-stream-index":"001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007"},"user_id":{"type":"string","x-stream-index":"006"}},"required":["channel_cid","message_id","user_id","created_at","updated_at"],"type":"object"},"ReportByHistogramBucket":{"properties":{"category":{"type":"string","x-stream-index":"001"},"count":{"format":"int32","type":"integer","x-stream-index":"005"},"lower_bound":{"$ref":"#/components/schemas/Bound","x-stream-index":"002"},"sum":{"format":"float","type":"number","x-stream-index":"004"},"upper_bound":{"$ref":"#/components/schemas/Bound","x-stream-index":"003"}},"required":["category","sum","count"],"type":"object"},"ReportResponse":{"properties":{"call":{"$ref":"#/components/schemas/CallReportResponse","x-stream-index":"003"},"participants":{"$ref":"#/components/schemas/ParticipantReportResponse","x-stream-index":"001"},"user_ratings":{"$ref":"#/components/schemas/UserRatingReportResponse","x-stream-index":"002"}},"required":["participants","user_ratings","call"],"type":"object"},"Response":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001"}},"required":["duration"],"title":"Response","type":"object"},"RestoreUsersRequest":{"nullable":true,"properties":{"user_ids":{"items":{"type":"string"},"maximum":100,"minimum":1,"type":"array","x-stream-index":"001"}},"required":["user_ids"],"type":"object"},"RingSettings":{"properties":{"auto_cancel_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_timeout_ms","missed_call_timeout_ms"],"type":"object"},"RingSettingsRequest":{"properties":{"auto_cancel_timeout_ms":{"description":"When none of the callees accept a ring call in this time a rejection will be sent by the caller with reason 'timeout' by the SDKs","format":"int32","maximum":180000,"minimum":5000,"title":"AutoCancelTimeoutMs","type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"description":"When a callee is online but doesn't answer a ring call in this time a rejection will be sent with reason 'timeout' by the SDKs","format":"int32","maximum":180000,"minimum":5000,"title":"IncomingCallTimeoutMs","type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"description":"When a callee doesn't accept or reject a ring call in this time a missed call event will be sent","format":"int32","maximum":180000,"minimum":5000,"title":"MissedCallTimeoutMs","type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_timeout_ms"],"title":"RingSettingsRequest","type":"object"},"RingSettingsResponse":{"properties":{"auto_cancel_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_timeout_ms","missed_call_timeout_ms"],"type":"object"},"Role":{"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"004"},"custom":{"description":"Whether this is a custom role or built-in","title":"Custom","type":"boolean","x-stream-index":"002"},"name":{"description":"Unique role name","title":"Name","type":"string","x-stream-index":"001"},"scopes":{"description":"List of scopes where this role is currently present. `.app` means that role is present in app-level grants","items":{"type":"string"},"title":"Scopes","type":"array","x-stream-index":"003"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"005"}},"required":["name","custom","scopes","created_at","updated_at"],"type":"object"},"S3Request":{"description":"Config for creating Amazon S3 storage.","properties":{"s3_api_key":{"description":"The AWS API key. To use Amazon S3 as your storage provider, you have two authentication options: IAM role or API key. If you do not specify the `s3_api_key` parameter, Stream will use IAM role authentication. In that case make sure to have the correct IAM role configured for your application.","title":"S3ApiKey","type":"string","x-stream-index":"002"},"s3_custom_endpoint_url":{"description":"The custom endpoint for S3. If you want to use a custom endpoint, you must also provide the `s3_api_key` and `s3_secret` parameters.","title":"S3CustomEndpointURL","type":"string","x-stream-index":"004"},"s3_region":{"description":"The AWS region where the bucket is hosted","title":"S3Region","type":"string","x-stream-index":"001"},"s3_secret":{"description":"The AWS API Secret","title":"S3Secret","type":"string","x-stream-index":"003"}},"required":["s3_region"],"title":"S3Request","type":"object"},"SDKUsageReport":{"properties":{"per_sdk_usage":{"additionalProperties":{"$ref":"#/components/schemas/PerSDKUsageReport"},"type":"object","x-stream-index":"001"}},"required":["per_sdk_usage"],"type":"object"},"SDKUsageReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateSDKUsageReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"ScreensharingSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled"],"type":"object"},"ScreensharingSettingsRequest":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"type":"object"},"ScreensharingSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled"],"type":"object"},"SendCallEventRequest":{"description":"Send a call event to the other user","nullable":true,"properties":{"custom":{"additionalProperties":{},"title":"Custom","type":"object","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"title":"SendCallEventRequest","type":"object"},"SendCallEventResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"SendCallEventResponse","type":"object"},"SessionSettings":{"properties":{"inactivity_timeout_seconds":{"format":"int32","maximum":900,"minimum":5,"type":"integer","x-stream-index":"001"}},"required":["inactivity_timeout_seconds"],"type":"object"},"SessionSettingsRequest":{"properties":{"inactivity_timeout_seconds":{"format":"int32","maximum":900,"minimum":5,"type":"integer","x-stream-index":"001"}},"required":["inactivity_timeout_seconds"],"type":"object"},"SessionSettingsResponse":{"properties":{"inactivity_timeout_seconds":{"format":"int32","maximum":900,"minimum":5,"type":"integer","x-stream-index":"001"}},"required":["inactivity_timeout_seconds"],"type":"object"},"SharedLocation":{"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"013"},"channel_cid":{"type":"string","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"010"},"created_by_device_id":{"type":"string","x-stream-index":"008"},"end_at":{"format":"date-time","type":"number","x-stream-index":"009"},"latitude":{"format":"float","maximum":90,"minimum":18446744073709552000,"type":"number","x-stream-index":"006"},"longitude":{"format":"float","maximum":180,"minimum":18446744073709552000,"type":"number","x-stream-index":"007"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"012"},"message_id":{"type":"string","x-stream-index":"004"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"011"},"user_id":{"type":"string","x-stream-index":"005"}},"required":["channel_cid","message_id","user_id","created_by_device_id","created_at","updated_at"],"type":"object"},"SharedLocationResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001.011"},"channel_cid":{"description":"Channel CID","title":"string","type":"string","x-stream-index":"001.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.008"},"created_by_device_id":{"description":"Device ID that created the live location","title":"string","type":"string","x-stream-index":"001.006"},"duration":{"type":"string","x-stream-index":"002.001"},"end_at":{"description":"Time when the live location expires","format":"date-time","title":"string","type":"number","x-stream-index":"001.007"},"latitude":{"description":"Latitude coordinate","format":"float","title":"number","type":"number","x-stream-index":"001.004"},"longitude":{"description":"Longitude coordinate","format":"float","title":"number","type":"number","x-stream-index":"001.005"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001.010"},"message_id":{"description":"Message ID","title":"string","type":"string","x-stream-index":"001.002"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.009"},"user_id":{"description":"User ID","title":"string","type":"string","x-stream-index":"001.003"}},"required":["channel_cid","message_id","user_id","latitude","longitude","created_by_device_id","created_at","updated_at","duration"],"type":"object"},"SharedLocationResponseData":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"011"},"channel_cid":{"type":"string","x-stream-index":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"created_by_device_id":{"type":"string","x-stream-index":"006"},"end_at":{"format":"date-time","type":"number","x-stream-index":"007"},"latitude":{"format":"float","type":"number","x-stream-index":"004"},"longitude":{"format":"float","type":"number","x-stream-index":"005"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"010"},"message_id":{"type":"string","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["channel_cid","message_id","user_id","latitude","longitude","created_by_device_id","created_at","updated_at"],"type":"object"},"SharedLocationsResponse":{"nullable":true,"properties":{"active_live_locations":{"items":{"$ref":"#/components/schemas/SharedLocationResponseData"},"type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["active_live_locations","duration"],"type":"object"},"SortParamRequest":{"nullable":true,"properties":{"direction":{"description":"Direction of sorting, 1 for Ascending, -1 for Descending, default is 1","format":"int32","title":"Direction","type":"integer","x-stream-index":"002"},"field":{"description":"Name of field to sort by","title":"Field","type":"string","x-stream-index":"001"}},"type":"object"},"StartClosedCaptionsRequest":{"nullable":true,"properties":{"enable_transcription":{"description":"Enable transcriptions along with closed captions","title":"Enable Transcription","type":"boolean","x-stream-index":"002"},"external_storage":{"description":"Which external storage to use for transcriptions (only applicable if enable_transcription is true)","title":"External Storage","type":"string","x-stream-index":"003"},"language":{"description":"The spoken language in the call, if not provided the language defined in the transcription settings will be used","enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"title":"Language","type":"string","x-stream-index":"004"}},"type":"object"},"StartClosedCaptionsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"StartFrameRecordingRequest":{"nullable":true,"properties":{"recording_external_storage":{"type":"string","x-stream-index":"002"}},"title":"StartFrameRecordingRequest","type":"object"},"StartFrameRecordingResponse":{"description":"StartFrameRecordingResponse is the response payload for the start frame recording endpoint.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StartFrameRecordingResponse","type":"object"},"StartHLSBroadcastingRequest":{"description":"StartHLSBroadcastingRequest is the payload for starting an HLS broadcasting.","nullable":true,"title":"StartHLSBroadcastingRequest","type":"object"},"StartHLSBroadcastingResponse":{"description":"StartHLSBroadcastingResponse is the payload for starting an HLS broadcasting.","nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"},"playlist_url":{"description":"the URL of the HLS playlist","title":"PlaylistURL","type":"string","x-stream-index":"002"}},"required":["duration","playlist_url"],"title":"StartHLSBroadcastingResponse","type":"object"},"StartRTMPBroadcastsRequest":{"description":"StartRTMPBroadcastsRequest is the payload for starting RTMP broadcasts.","nullable":true,"properties":{"broadcasts":{"description":"List of broadcasts to start","items":{"$ref":"#/components/schemas/RTMPBroadcastRequest"},"maximum":1,"minimum":1,"title":"Broadcasts","type":"array","x-stream-index":"002"}},"required":["broadcasts"],"title":"StartRTMPBroadcastsRequest","type":"object"},"StartRTMPBroadcastsResponse":{"description":"StartRTMPBroadcastsResponse is the payload for starting an RTMP broadcast.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StartRTMPBroadcastsResponse","type":"object"},"StartRecordingRequest":{"nullable":true,"properties":{"recording_external_storage":{"type":"string","x-stream-index":"002"}},"title":"StartRecordingRequest","type":"object"},"StartRecordingResponse":{"description":"StartRecordingResponse is the response payload for the start recording endpoint.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StartRecordingResponse","type":"object"},"StartTranscriptionRequest":{"nullable":true,"properties":{"enable_closed_captions":{"description":"Enable closed captions along with transcriptions","title":"Enable Closed Captions","type":"boolean","x-stream-index":"003"},"language":{"description":"The spoken language in the call, if not provided the language defined in the transcription settings will be used","enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"title":"Language","type":"string","x-stream-index":"004"},"transcription_external_storage":{"description":"Store transcriptions in this external storage","title":"External Storage","type":"string","x-stream-index":"002"}},"type":"object"},"StartTranscriptionResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StartTranscriptionResponse","type":"object"},"StopAllRTMPBroadcastsRequest":{"nullable":true,"title":"StopAllRTMPBroadcastsRequest","type":"object"},"StopAllRTMPBroadcastsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StopAllRTMPBroadcastsResponse","type":"object"},"StopClosedCaptionsRequest":{"nullable":true,"properties":{"stop_transcription":{"type":"boolean","x-stream-index":"003"}},"type":"object"},"StopClosedCaptionsResponse":{"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"},"StopFrameRecordingRequest":{"nullable":true,"type":"object"},"StopFrameRecordingResponse":{"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"},"StopHLSBroadcastingRequest":{"nullable":true,"type":"object"},"StopHLSBroadcastingResponse":{"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"},"StopLiveRequest":{"nullable":true,"properties":{"continue_closed_caption":{"type":"boolean","x-stream-index":"006"},"continue_hls":{"type":"boolean","x-stream-index":"003"},"continue_recording":{"type":"boolean","x-stream-index":"004"},"continue_rtmp_broadcasts":{"type":"boolean","x-stream-index":"007"},"continue_transcription":{"type":"boolean","x-stream-index":"005"}},"title":"StopLiveRequest","type":"object"},"StopLiveResponse":{"nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"The call that was stopped","title":"Call","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["call","duration"],"title":"StopLiveResponse","type":"object"},"StopRTMPBroadcastsRequest":{"description":"Request for stopping RTMP broadcasts","nullable":true,"title":"StopRTMPBroadcastsRequest","type":"object"},"StopRTMPBroadcastsResponse":{"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"},"StopRecordingRequest":{"nullable":true,"type":"object"},"StopRecordingResponse":{"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"},"StopTranscriptionRequest":{"nullable":true,"properties":{"stop_closed_captions":{"type":"boolean","x-stream-index":"003"}},"type":"object"},"StopTranscriptionResponse":{"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"},"SubscriberAllMetrics":{"properties":{"audio":{"$ref":"#/components/schemas/SubscriberAudioMetrics","x-stream-index":"001"},"rtt_ms":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"003"},"video":{"$ref":"#/components/schemas/SubscriberVideoMetrics","x-stream-index":"002"}},"type":"object"},"SubscriberAudioMetrics":{"properties":{"concealment_pct":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"003"},"jitter_ms":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"001"},"packets_lost_pct":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"002"}},"type":"object"},"SubscriberStatsResponse":{"properties":{"total":{"format":"int32","type":"integer","x-stream-index":"001"},"total_subscribed_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"003"},"unique":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["total","unique","total_subscribed_duration_seconds"],"type":"object"},"SubscriberVideoMetrics":{"properties":{"fps_30":{"$ref":"#/components/schemas/ActiveCallsFPSStats","x-stream-index":"002"},"jitter_ms":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"001"},"packets_lost_pct":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"003"}},"type":"object"},"SubscribersMetrics":{"properties":{"all":{"$ref":"#/components/schemas/SubscriberAllMetrics","x-stream-index":"001"}},"type":"object"},"TargetResolution":{"properties":{"bitrate":{"format":"int32","maximum":6000000,"type":"integer","x-stream-index":"003"},"height":{"format":"int32","maximum":3840,"minimum":240,"type":"integer","x-stream-index":"002"},"width":{"format":"int32","maximum":3840,"minimum":240,"type":"integer","x-stream-index":"001"}},"required":["width","height","bitrate"],"type":"object"},"Thresholds":{"description":"Sets thresholds for AI moderation","properties":{"explicit":{"$ref":"#/components/schemas/LabelThresholds","description":"Thresholds for explicit messages","title":"LabelThresholds","x-stream-index":"001"},"spam":{"$ref":"#/components/schemas/LabelThresholds","description":"Thresholds for spam","title":"LabelThresholds","x-stream-index":"002"},"toxic":{"$ref":"#/components/schemas/LabelThresholds","description":"Thresholds for toxic messages","title":"LabelThresholds","x-stream-index":"003"}},"title":"Auto moderation thresholds","type":"object"},"ThumbnailResponse":{"properties":{"image_url":{"type":"string","x-stream-index":"001"}},"required":["image_url"],"type":"object"},"ThumbnailsSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"ThumbnailsSettingsRequest":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"ThumbnailsSettingsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"TrackStatsResponse":{"nullable":true,"properties":{"duration_seconds":{"format":"int32","type":"integer","x-stream-index":"002"},"track_type":{"type":"string","x-stream-index":"001"}},"required":["track_type","duration_seconds"],"type":"object"},"TranscriptionSettings":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"title":"Mode","type":"string","x-stream-index":"002"},"language":{"description":"The language used in this call as a two letter code","enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"title":"Language","type":"string","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"title":"Mode","type":"string","x-stream-index":"001"}},"required":["mode","closed_caption_mode","languages","language"],"type":"object"},"TranscriptionSettingsRequest":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"002"},"language":{"enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"type":"string","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode"],"type":"object"},"TranscriptionSettingsResponse":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"002"},"language":{"enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"type":"string","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode","closed_caption_mode","languages","language"],"type":"object"},"TypingIndicators":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"TypingIndicatorsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"UnblockUserRequest":{"description":"UnblockUserRequest is the payload for unblocking a user.","nullable":true,"properties":{"user_id":{"description":"the user to unblock","title":"UserID","type":"string","x-stream-index":"003"}},"required":["user_id"],"title":"UnblockUserRequest","type":"object"},"UnblockUserResponse":{"description":"UnblockUserResponse is the payload for unblocking a user.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"UnblockUserResponse","type":"object"},"UnblockUsersRequest":{"nullable":true,"properties":{"blocked_user_id":{"type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"required":["blocked_user_id"],"type":"object"},"UnblockUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"UnblockedUserEvent":{"description":"This event is sent when a user is unblocked on a call,\nthis can be useful to notify the user that they can now join the call again","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.unblocked_user","description":"The type of event: \"call.unblocked_user\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user that was unblocked","title":"User","x-stream-index":"003"}},"required":["type","created_at","call_cid","user"],"title":"UnblockedUserEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"UnpinRequest":{"description":"UnpinRequest is the payload for unpinning a message.","nullable":true,"properties":{"session_id":{"description":"the session ID of the user who pinned the message","title":"SessionID","type":"string","x-stream-index":"003"},"user_id":{"description":"the user ID of the user who pinned the message","title":"UserID","type":"string","x-stream-index":"002"}},"required":["user_id","session_id"],"title":"UnpinRequest","type":"object"},"UnpinResponse":{"description":"UnpinResponse is the payload for unpinning a message.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"UnpinResponse","type":"object"},"UpdateAppRequest":{"nullable":true,"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.017"},"apn_config":{"$ref":"#/components/schemas/APNConfig","x-stream-index":"001.003"},"async_moderation_config":{"$ref":"#/components/schemas/AsyncModerationConfiguration","x-stream-index":"001.039"},"async_url_enrich_enabled":{"type":"boolean","x-stream-index":"001.019"},"auto_translation_enabled":{"type":"boolean","x-stream-index":"001.018"},"before_message_send_hook_url":{"type":"string","x-stream-index":"001.020"},"cdn_expiration_seconds":{"format":"int32","maximum":1209600,"minimum":14400,"type":"integer","x-stream-index":"001.038"},"channel_hide_members_only":{"type":"boolean","x-stream-index":"001.033"},"custom_action_handler_url":{"type":"string","x-stream-index":"001.021"},"datadog_info":{"$ref":"#/components/schemas/DataDogInfo","x-stream-index":"001.040"},"disable_auth_checks":{"type":"boolean","x-stream-index":"001.001"},"disable_permissions_checks":{"type":"boolean","x-stream-index":"001.002"},"enforce_unique_usernames":{"enum":["no","app","team"],"type":"string","x-stream-index":"001.022"},"event_hooks":{"items":{"$ref":"#/components/schemas/EventHook"},"type":"array","x-stream-index":"001.046"},"feeds_moderation_enabled":{"type":"boolean","x-stream-index":"001.042"},"feeds_v2_region":{"type":"string","x-stream-index":"001.041"},"file_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","x-stream-index":"001.030"},"firebase_config":{"$ref":"#/components/schemas/FirebaseConfig","x-stream-index":"001.004"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"001.034"},"guest_user_creation_disabled":{"type":"boolean","x-stream-index":"001.043"},"huawei_config":{"$ref":"#/components/schemas/HuaweiConfig","x-stream-index":"001.005"},"image_moderation_block_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001.015"},"image_moderation_enabled":{"type":"boolean","x-stream-index":"001.016"},"image_moderation_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001.014"},"image_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","x-stream-index":"001.029"},"migrate_permissions_to_v2":{"type":"boolean","x-stream-index":"001.035"},"moderation_dashboard_preferences":{"$ref":"#/components/schemas/ModerationDashboardPreferences","x-stream-index":"001.044"},"moderation_enabled":{"type":"boolean","x-stream-index":"001.009"},"moderation_webhook_url":{"type":"string","x-stream-index":"001.010"},"multi_tenant_enabled":{"type":"boolean","x-stream-index":"001.013"},"permission_version":{"enum":["v1","v2"],"type":"string","x-stream-index":"001.011"},"push_config":{"$ref":"#/components/schemas/PushConfig","x-stream-index":"001.007"},"reminders_interval":{"format":"int32","maximum":86400,"minimum":60,"type":"integer","x-stream-index":"001.036"},"reminders_max_members":{"format":"int32","minimum":2,"type":"integer","x-stream-index":"001.037"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.031"},"sns_key":{"type":"string","x-stream-index":"001.027"},"sns_secret":{"type":"string","x-stream-index":"001.028"},"sns_topic_arn":{"type":"string","x-stream-index":"001.026"},"sqs_key":{"type":"string","x-stream-index":"001.024"},"sqs_secret":{"type":"string","x-stream-index":"001.025"},"sqs_url":{"type":"string","x-stream-index":"001.023"},"user_response_time_enabled":{"type":"boolean","x-stream-index":"001.048"},"user_search_disallowed_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"001.012"},"webhook_events":{"items":{"type":"string"},"type":"array","x-stream-index":"001.032"},"webhook_url":{"type":"string","x-stream-index":"001.008"},"xiaomi_config":{"$ref":"#/components/schemas/XiaomiConfig","x-stream-index":"001.006"}},"type":"object"},"UpdateBlockListRequest":{"nullable":true,"properties":{"team":{"type":"string","x-stream-index":"002"},"words":{"description":"List of words to block","items":{"type":"string"},"minimum":1,"title":"Words","type":"array","x-stream-index":"003"}},"title":"Update block list","type":"object","x-stream-docs-page-id":"update_block_list"},"UpdateBlockListResponse":{"description":"Basic response information","nullable":true,"properties":{"blocklist":{"$ref":"#/components/schemas/BlockListResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["duration"],"title":"Response","type":"object"},"UpdateCallMembersRequest":{"description":"Update call members","nullable":true,"properties":{"remove_members":{"description":"List of userID to remove","items":{"type":"string"},"maximum":100,"title":"Remove Members","type":"array","x-stream-index":"003"},"update_members":{"description":"List of members to update or insert","items":{"$ref":"#/components/schemas/MemberRequest"},"maximum":100,"title":"Update Members","type":"array","x-stream-index":"004"}},"title":"UpdateCallMembersRequest","type":"object"},"UpdateCallMembersResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"002"}},"required":["duration","members"],"title":"Response","type":"object"},"UpdateCallRequest":{"description":"Request for updating a call","nullable":true,"properties":{"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"003"},"settings_override":{"$ref":"#/components/schemas/CallSettingsRequest","description":"the settings to change for this call","title":"Settings Override","x-stream-index":"004"},"starts_at":{"description":"the time the call is scheduled to start","format":"date-time","title":"Starts At","type":"number","x-stream-index":"005"}},"title":"UpdateCallRequest","type":"object"},"UpdateCallResponse":{"description":"Response for updating a call","nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001.001"},"duration":{"type":"string","x-stream-index":"002.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001.002"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"001.004"}},"required":["call","members","own_capabilities","blocked_users","duration"],"title":"UpdateCallResponse","type":"object"},"UpdateCallTypeRequest":{"description":"UpdateCallTypeRequest is the payload for updating a call type.","nullable":true,"properties":{"external_storage":{"type":"string","x-stream-index":"002.004"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"002.001"},"notification_settings":{"$ref":"#/components/schemas/NotificationSettings","x-stream-index":"002.002"},"settings":{"$ref":"#/components/schemas/CallSettingsRequest","x-stream-index":"002.003"}},"title":"UpdateCallTypeRequest","type":"object"},"UpdateCallTypeResponse":{"description":"UpdateCallTypeResponse is the payload for updating a call type.","nullable":true,"properties":{"created_at":{"description":"the time the call type was created","format":"date-time","title":"CreatedAt","type":"number","x-stream-index":"001.005"},"duration":{"type":"string","x-stream-index":"002.001"},"external_storage":{"description":"the external storage for the call type","title":"ExternalStorage","type":"string","x-stream-index":"001.007"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"the permissions granted to each role","title":"Grants","type":"object","x-stream-index":"001.002"},"name":{"description":"the name of the call type","title":"Name","type":"string","x-stream-index":"001.001"},"notification_settings":{"$ref":"#/components/schemas/NotificationSettings","description":"the notification settings for the call type","title":"NotificationSettings","x-stream-index":"001.004"},"settings":{"$ref":"#/components/schemas/CallSettingsResponse","description":"the settings for the call type","title":"Settings","x-stream-index":"001.003"},"updated_at":{"description":"the time the call type was last updated","format":"date-time","title":"UpdatedAt","type":"number","x-stream-index":"001.006"}},"required":["name","grants","settings","notification_settings","created_at","updated_at","duration"],"title":"UpdateCallTypeResponse","type":"object"},"UpdateExternalStorageRequest":{"description":"External storage","nullable":true,"properties":{"aws_s3":{"$ref":"#/components/schemas/S3Request","description":"Only required if you want to create an Amazon S3 storage","title":"AwsS3","x-stream-index":"003.004"},"azure_blob":{"$ref":"#/components/schemas/AzureRequest","description":"Only required if you want to create an Azure Blob Storage","title":"AzureBlob","x-stream-index":"003.006"},"bucket":{"description":"The name of the bucket on the service provider","title":"Bucket","type":"string","x-stream-index":"003.002"},"gcs_credentials":{"type":"string","x-stream-index":"003.005"},"path":{"description":"The path prefix to use for storing files","title":"Path","type":"string","x-stream-index":"003.003"},"storage_type":{"description":"The type of storage to use","enum":["s3","gcs","abs"],"title":"StorageType","type":"string","x-stream-index":"003.001"}},"required":["storage_type","bucket"],"title":"ExternalStorageRequest","type":"object"},"UpdateExternalStorageResponse":{"description":"Basic response information","nullable":true,"properties":{"bucket":{"type":"string","x-stream-index":"001.003"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"name":{"type":"string","x-stream-index":"001.001"},"path":{"type":"string","x-stream-index":"001.004"},"type":{"enum":["s3","gcs","abs"],"type":"string","x-stream-index":"001.002"}},"required":["name","type","bucket","path","duration"],"title":"Response","type":"object"},"UpdateLiveLocationRequest":{"nullable":true,"properties":{"end_at":{"description":"Time when the live location expires","format":"date-time","title":"string","type":"number","x-stream-index":"004"},"latitude":{"description":"Latitude coordinate","format":"float","maximum":90,"minimum":18446744073709552000,"title":"number","type":"number","x-stream-index":"002"},"longitude":{"description":"Longitude coordinate","format":"float","maximum":180,"minimum":18446744073709552000,"title":"number","type":"number","x-stream-index":"003"},"message_id":{"description":"Live location ID","title":"string","type":"string","x-stream-index":"001"}},"required":["message_id"],"type":"object"},"UpdatePollOptionRequest":{"nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"004"},"id":{"description":"Option ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"},"text":{"description":"Option text","title":"string","type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"005.002"},"user_id":{"type":"string","x-stream-index":"005.001"}},"required":["id","text"],"type":"object"},"UpdatePollPartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"description":"Sets new field values","title":"Set","type":"object","x-stream-index":"002.001","x-stream-map":{"key":"field","title":"Value","description":"New value to set"}},"unset":{"description":"Array of field names to unset","items":{"type":"string"},"title":"Unset","type":"array","x-stream-index":"002.002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"type":"object"},"UpdatePollRequest":{"nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"011"},"allow_answers":{"description":"Allow answers","title":"boolean","type":"boolean","x-stream-index":"009"},"allow_user_suggested_options":{"description":"Allow user suggested options","title":"boolean","type":"boolean","x-stream-index":"008"},"description":{"description":"Poll description","title":"string","type":"string","x-stream-index":"003"},"enforce_unique_vote":{"description":"Enforce unique vote","title":"boolean","type":"boolean","x-stream-index":"005"},"id":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"},"is_closed":{"description":"Is closed","title":"boolean","type":"boolean","x-stream-index":"010"},"max_votes_allowed":{"description":"Max votes allowed","format":"int32","maximum":10,"title":"integer","type":"integer","x-stream-index":"007"},"name":{"description":"Poll name","title":"string","type":"string","x-stream-index":"002"},"options":{"description":"Poll options","items":{"$ref":"#/components/schemas/PollOptionRequest"},"maximum":100,"title":"PollOptions","type":"array","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"012.002"},"user_id":{"type":"string","x-stream-index":"012.001"},"voting_visibility":{"description":"Voting visibility","enum":["anonymous","public"],"title":"string","type":"string","x-stream-index":"006"}},"required":["id","name"],"type":"object"},"UpdateUserPartialRequest":{"properties":{"id":{"description":"User ID to update","title":"ID","type":"string","x-stream-index":"001"},"set":{"additionalProperties":{},"type":"object","x-stream-index":"002.001"},"unset":{"items":{"type":"string"},"type":"array","x-stream-index":"002.002"}},"required":["id"],"type":"object"},"UpdateUserPermissionsRequest":{"nullable":true,"properties":{"grant_permissions":{"items":{"type":"string"},"type":"array","x-stream-index":"002"},"revoke_permissions":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"user_id":{"type":"string","x-stream-index":"001"}},"required":["user_id"],"type":"object"},"UpdateUserPermissionsResponse":{"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"},"UpdateUsersPartialRequest":{"nullable":true,"properties":{"users":{"items":{"$ref":"#/components/schemas/UpdateUserPartialRequest"},"maximum":100,"type":"array","x-stream-index":"001"}},"required":["users"],"type":"object"},"UpdateUsersRequest":{"nullable":true,"properties":{"users":{"additionalProperties":{"$ref":"#/components/schemas/UserRequest"},"description":"Object containing users","title":"Users","type":"object","x-stream-index":"001","x-stream-map":{"key":"user_id"}}},"required":["users"],"type":"object"},"UpdateUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"membership_deletion_task_id":{"type":"string","x-stream-index":"002"},"users":{"additionalProperties":{"$ref":"#/components/schemas/FullUserResponse"},"description":"Object containing users","title":"Users","type":"object","x-stream-index":"001","x-stream-map":{"key":"user_id"}}},"required":["users","membership_deletion_task_id","duration"],"type":"object"},"UpdatedCallPermissionsEvent":{"description":"This event is sent to notify about permission changes for a user, clients receiving this event should update their UI accordingly","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"own_capabilities":{"description":"The capabilities of the current user","items":{"$ref":"#/components/schemas/OwnCapability"},"title":"Own capabilities","type":"array","x-stream-index":"004"},"type":{"default":"call.permissions_updated","description":"The type of event: \"call.permissions_updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who received the new permissions","title":"User","x-stream-index":"003"}},"required":["type","created_at","call_cid","user","own_capabilities"],"title":"UpdatedCallPermissionsEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"UpsertPushProviderRequest":{"nullable":true,"properties":{"push_provider":{"$ref":"#/components/schemas/PushProvider","x-stream-index":"001"}},"type":"object"},"UpsertPushProviderResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"push_provider":{"$ref":"#/components/schemas/PushProviderResponse","x-stream-index":"001"}},"required":["push_provider","duration"],"title":"Response","type":"object"},"User":{"properties":{"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"046"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"017"},"banned":{"type":"boolean","x-stream-index":"016"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"013"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"023"},"language":{"type":"string","x-stream-index":"035"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"026"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"042"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"005"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"009"}},"required":["id","role","teams_role","custom","banned","online"],"type":"object"},"UserBannedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"006.002"},"channel_type":{"type":"string","x-stream-index":"006.003"},"cid":{"type":"string","x-stream-index":"006.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008.002"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"001"},"expiration":{"format":"date-time","type":"number","x-stream-index":"003"},"reason":{"type":"string","x-stream-index":"004"},"shadow":{"type":"boolean","x-stream-index":"002"},"team":{"type":"string","x-stream-index":"005.001"},"type":{"default":"user.banned","type":"string","x-stream-index":"008.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007.001"}},"required":["created_by","shadow","cid","channel_id","channel_type","type","created_at"],"title":"UserBannedEvent","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"},"UserDeactivatedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"001"},"type":{"default":"user.deactivated","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["created_by","type","created_at"],"title":"UserDeactivatedEvent","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"},"UserFeedbackReport":{"properties":{"count_by_rating":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001"},"unreported_count":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["count_by_rating","unreported_count"],"type":"object"},"UserFeedbackReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateUserFeedbackReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"UserFeedbackResponse":{"properties":{"cid":{"type":"string","x-stream-index":"001"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"009"},"platform":{"$ref":"#/components/schemas/PlatformDataResponse","x-stream-index":"008"},"rating":{"format":"int32","type":"integer","x-stream-index":"004"},"reason":{"type":"string","x-stream-index":"005"},"sdk":{"type":"string","x-stream-index":"006"},"sdk_version":{"type":"string","x-stream-index":"007"},"session_id":{"type":"string","x-stream-index":"002"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["cid","session_id","user_id","rating","reason","sdk","sdk_version","platform"],"type":"object"},"UserMuteResponse":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"expires":{"format":"date-time","type":"number","x-stream-index":"003"},"target":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"}},"required":["created_at","updated_at"],"type":"object"},"UserMutedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"target_user":{"type":"string","x-stream-index":"001"},"target_users":{"items":{"type":"string"},"type":"array","x-stream-index":"002"},"type":{"default":"user.muted","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"UserMutedEvent","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"},"UserRatingReportResponse":{"properties":{"average":{"format":"float","type":"number","x-stream-index":"002"},"count":{"format":"int32","type":"integer","x-stream-index":"001"}},"required":["count","average"],"type":"object"},"UserReactivatedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"type":{"default":"user.reactivated","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"001"}},"required":["type","created_at"],"title":"UserReactivatedEvent","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"},"UserRequest":{"description":"User request object","properties":{"custom":{"additionalProperties":{},"description":"Custom user data","title":"Custom","type":"object","x-stream-index":"004"},"id":{"description":"User ID","title":"ID","type":"string","x-stream-index":"001"},"image":{"description":"User's profile image URL","title":"Image","type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"006"},"language":{"type":"string","x-stream-index":"005"},"name":{"description":"Optional name of user","title":"Name","type":"string","x-stream-index":"002"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"007"},"role":{"description":"User's global role","title":"Role","type":"string","x-stream-index":"008"},"teams":{"description":"List of teams the user belongs to","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"010"},"teams_role":{"additionalProperties":{"type":"string"},"description":"Map of team-specific roles for the user","title":"TeamsRole","type":"object","x-stream-index":"009"}},"required":["id"],"title":"UserRequest","type":"object"},"UserResponse":{"description":"User response object","properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"ban_expires":{"description":"Date when ban expires","format":"date-time","title":"Ban expires","type":"number","x-stream-index":"003"},"banned":{"description":"Whether a user is banned or not","title":"Banned","type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.017"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"001.004"},"deactivated_at":{"description":"Date of deactivation","format":"date-time","title":"Deactivated at","type":"number","x-stream-index":"001.016"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"001.011"},"devices":{"description":"List of devices user is using","items":{"$ref":"#/components/schemas/DeviceResponse"},"title":"Devices","type":"array","x-stream-index":"006"},"id":{"description":"Unique user identifier","title":"ID","type":"string","x-stream-index":"001.001"},"image":{"title":"Image","type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"007"},"language":{"description":"Preferred language of a user","title":"Language","type":"string","x-stream-index":"001.005"},"last_active":{"description":"Date of last activity","format":"date-time","title":"Last active","type":"number","x-stream-index":"001.014"},"name":{"description":"Optional name of user","title":"Name","type":"string","x-stream-index":"001.002"},"online":{"description":"Whether a user online or not","title":"Online","type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","description":"User privacy settings","title":"Privacy settings","x-stream-index":"005"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettingsResponse","description":"User push notification settings","title":"Push notifications","x-stream-index":"004"},"revoke_tokens_issued_before":{"description":"Revocation date for tokens","format":"date-time","title":"Revoke tokens issued before","type":"number","x-stream-index":"001.015"},"role":{"description":"Determines the set of user permissions","title":"Role","type":"string","x-stream-index":"001.006"},"shadow_banned":{"description":"Whether a user is shadow banned","title":"Shadow banned","type":"boolean","x-stream-index":"002"},"teams":{"description":"List of teams user is a part of","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids","shadow_banned","invisible"],"title":"UserResponse","type":"object"},"UserResponsePrivacyFields":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"banned":{"type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.017"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.011"},"id":{"type":"string","x-stream-index":"001.001"},"image":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"003"},"language":{"type":"string","x-stream-index":"001.005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"001.014"},"name":{"type":"string","x-stream-index":"001.002"},"online":{"type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"002"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.015"},"role":{"type":"string","x-stream-index":"001.006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids"],"type":"object"},"UserUpdatedEvent":{"description":"This event is sent when a user gets updated. The event contains information about the updated user.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"type":{"default":"user.updated","description":"The type of event: \"user.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.002"},"user":{"$ref":"#/components/schemas/UserResponsePrivacyFields","description":"The updated user","title":"User","x-stream-index":"002.001"}},"required":["type","created_at","custom","user"],"title":"UserUpdatedEvent","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"},"VideoReactionOverTimeResponse":{"properties":{"by_minute":{"items":{"$ref":"#/components/schemas/CountByMinuteResponse"},"type":"array","x-stream-index":"001"}},"type":"object"},"VideoReactionsResponse":{"nullable":true,"properties":{"count_over_time":{"$ref":"#/components/schemas/VideoReactionOverTimeResponse","x-stream-index":"002"},"reaction":{"type":"string","x-stream-index":"001"}},"required":["reaction"],"type":"object"},"VideoSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"camera_default_on":{"type":"boolean","x-stream-index":"004"},"camera_facing":{"enum":["front","back","external"],"type":"string","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled","target_resolution","camera_default_on","camera_facing"],"type":"object"},"VideoSettingsRequest":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"camera_default_on":{"type":"boolean","x-stream-index":"004"},"camera_facing":{"enum":["front","back","external"],"type":"string","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"type":"object"},"VideoSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"camera_default_on":{"type":"boolean","x-stream-index":"004"},"camera_facing":{"enum":["front","back","external"],"type":"string","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled","target_resolution","camera_default_on","camera_facing"],"type":"object"},"WebhookEvent":{"description":"The discriminator object for all webhook events, it maps events' payload to the final type","discriminator":{"mapping":{"call.accepted":"#/components/schemas/CallAcceptedEvent","call.blocked_user":"#/components/schemas/BlockedUserEvent","call.closed_caption":"#/components/schemas/ClosedCaptionEvent","call.closed_captions_failed":"#/components/schemas/CallClosedCaptionsFailedEvent","call.closed_captions_started":"#/components/schemas/CallClosedCaptionsStartedEvent","call.closed_captions_stopped":"#/components/schemas/CallClosedCaptionsStoppedEvent","call.created":"#/components/schemas/CallCreatedEvent","call.deleted":"#/components/schemas/CallDeletedEvent","call.ended":"#/components/schemas/CallEndedEvent","call.frame_recording_failed":"#/components/schemas/CallFrameRecordingFailedEvent","call.frame_recording_ready":"#/components/schemas/CallFrameRecordingFrameReadyEvent","call.frame_recording_started":"#/components/schemas/CallFrameRecordingStartedEvent","call.frame_recording_stopped":"#/components/schemas/CallFrameRecordingStoppedEvent","call.hls_broadcasting_failed":"#/components/schemas/CallHLSBroadcastingFailedEvent","call.hls_broadcasting_started":"#/components/schemas/CallHLSBroadcastingStartedEvent","call.hls_broadcasting_stopped":"#/components/schemas/CallHLSBroadcastingStoppedEvent","call.live_started":"#/components/schemas/CallLiveStartedEvent","call.member_added":"#/components/schemas/CallMemberAddedEvent","call.member_removed":"#/components/schemas/CallMemberRemovedEvent","call.member_updated":"#/components/schemas/CallMemberUpdatedEvent","call.member_updated_permission":"#/components/schemas/CallMemberUpdatedPermissionEvent","call.missed":"#/components/schemas/CallMissedEvent","call.moderation_blur":"#/components/schemas/CallModerationBlurEvent","call.moderation_warning":"#/components/schemas/CallModerationWarningEvent","call.notification":"#/components/schemas/CallNotificationEvent","call.permission_request":"#/components/schemas/PermissionRequestEvent","call.permissions_updated":"#/components/schemas/UpdatedCallPermissionsEvent","call.reaction_new":"#/components/schemas/CallReactionEvent","call.recording_failed":"#/components/schemas/CallRecordingFailedEvent","call.recording_ready":"#/components/schemas/CallRecordingReadyEvent","call.recording_started":"#/components/schemas/CallRecordingStartedEvent","call.recording_stopped":"#/components/schemas/CallRecordingStoppedEvent","call.rejected":"#/components/schemas/CallRejectedEvent","call.ring":"#/components/schemas/CallRingEvent","call.rtmp_broadcast_failed":"#/components/schemas/CallRtmpBroadcastFailedEvent","call.rtmp_broadcast_started":"#/components/schemas/CallRtmpBroadcastStartedEvent","call.rtmp_broadcast_stopped":"#/components/schemas/CallRtmpBroadcastStoppedEvent","call.session_ended":"#/components/schemas/CallSessionEndedEvent","call.session_participant_count_updated":"#/components/schemas/CallSessionParticipantCountsUpdatedEvent","call.session_participant_joined":"#/components/schemas/CallSessionParticipantJoinedEvent","call.session_participant_left":"#/components/schemas/CallSessionParticipantLeftEvent","call.session_started":"#/components/schemas/CallSessionStartedEvent","call.stats_report_ready":"#/components/schemas/CallStatsReportReadyEvent","call.transcription_failed":"#/components/schemas/CallTranscriptionFailedEvent","call.transcription_ready":"#/components/schemas/CallTranscriptionReadyEvent","call.transcription_started":"#/components/schemas/CallTranscriptionStartedEvent","call.transcription_stopped":"#/components/schemas/CallTranscriptionStoppedEvent","call.unblocked_user":"#/components/schemas/UnblockedUserEvent","call.updated":"#/components/schemas/CallUpdatedEvent","call.user_feedback_submitted":"#/components/schemas/CallUserFeedbackSubmittedEvent","call.user_muted":"#/components/schemas/CallUserMutedEvent","custom":"#/components/schemas/CustomVideoEvent","export.channels.error":"#/components/schemas/AsyncExportErrorEvent","export.channels.success":"#/components/schemas/AsyncExportChannelsEvent","export.users.error":"#/components/schemas/AsyncExportErrorEvent","export.users.success":"#/components/schemas/AsyncExportUsersEvent","user.banned":"#/components/schemas/UserBannedEvent","user.deactivated":"#/components/schemas/UserDeactivatedEvent","user.muted":"#/components/schemas/UserMutedEvent","user.reactivated":"#/components/schemas/UserReactivatedEvent","user.updated":"#/components/schemas/UserUpdatedEvent"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/AsyncExportChannelsEvent"},{"$ref":"#/components/schemas/AsyncExportErrorEvent"},{"$ref":"#/components/schemas/AsyncExportErrorEvent"},{"$ref":"#/components/schemas/AsyncExportUsersEvent"},{"$ref":"#/components/schemas/BlockedUserEvent"},{"$ref":"#/components/schemas/CallAcceptedEvent"},{"$ref":"#/components/schemas/CallClosedCaptionsFailedEvent"},{"$ref":"#/components/schemas/CallClosedCaptionsStartedEvent"},{"$ref":"#/components/schemas/CallClosedCaptionsStoppedEvent"},{"$ref":"#/components/schemas/CallCreatedEvent"},{"$ref":"#/components/schemas/CallDeletedEvent"},{"$ref":"#/components/schemas/CallEndedEvent"},{"$ref":"#/components/schemas/CallFrameRecordingFailedEvent"},{"$ref":"#/components/schemas/CallFrameRecordingFrameReadyEvent"},{"$ref":"#/components/schemas/CallFrameRecordingStartedEvent"},{"$ref":"#/components/schemas/CallFrameRecordingStoppedEvent"},{"$ref":"#/components/schemas/CallHLSBroadcastingFailedEvent"},{"$ref":"#/components/schemas/CallHLSBroadcastingStartedEvent"},{"$ref":"#/components/schemas/CallHLSBroadcastingStoppedEvent"},{"$ref":"#/components/schemas/CallLiveStartedEvent"},{"$ref":"#/components/schemas/CallMemberAddedEvent"},{"$ref":"#/components/schemas/CallMemberRemovedEvent"},{"$ref":"#/components/schemas/CallMemberUpdatedEvent"},{"$ref":"#/components/schemas/CallMemberUpdatedPermissionEvent"},{"$ref":"#/components/schemas/CallMissedEvent"},{"$ref":"#/components/schemas/CallModerationBlurEvent"},{"$ref":"#/components/schemas/CallModerationWarningEvent"},{"$ref":"#/components/schemas/CallNotificationEvent"},{"$ref":"#/components/schemas/CallReactionEvent"},{"$ref":"#/components/schemas/CallRecordingFailedEvent"},{"$ref":"#/components/schemas/CallRecordingReadyEvent"},{"$ref":"#/components/schemas/CallRecordingStartedEvent"},{"$ref":"#/components/schemas/CallRecordingStoppedEvent"},{"$ref":"#/components/schemas/CallRejectedEvent"},{"$ref":"#/components/schemas/CallRingEvent"},{"$ref":"#/components/schemas/CallRtmpBroadcastFailedEvent"},{"$ref":"#/components/schemas/CallRtmpBroadcastStartedEvent"},{"$ref":"#/components/schemas/CallRtmpBroadcastStoppedEvent"},{"$ref":"#/components/schemas/CallSessionEndedEvent"},{"$ref":"#/components/schemas/CallSessionParticipantCountsUpdatedEvent"},{"$ref":"#/components/schemas/CallSessionParticipantJoinedEvent"},{"$ref":"#/components/schemas/CallSessionParticipantLeftEvent"},{"$ref":"#/components/schemas/CallSessionStartedEvent"},{"$ref":"#/components/schemas/CallStatsReportReadyEvent"},{"$ref":"#/components/schemas/CallTranscriptionFailedEvent"},{"$ref":"#/components/schemas/CallTranscriptionReadyEvent"},{"$ref":"#/components/schemas/CallTranscriptionStartedEvent"},{"$ref":"#/components/schemas/CallTranscriptionStoppedEvent"},{"$ref":"#/components/schemas/CallUpdatedEvent"},{"$ref":"#/components/schemas/CallUserFeedbackSubmittedEvent"},{"$ref":"#/components/schemas/CallUserMutedEvent"},{"$ref":"#/components/schemas/ClosedCaptionEvent"},{"$ref":"#/components/schemas/CustomVideoEvent"},{"$ref":"#/components/schemas/PermissionRequestEvent"},{"$ref":"#/components/schemas/UnblockedUserEvent"},{"$ref":"#/components/schemas/UpdatedCallPermissionsEvent"},{"$ref":"#/components/schemas/UserBannedEvent"},{"$ref":"#/components/schemas/UserDeactivatedEvent"},{"$ref":"#/components/schemas/UserMutedEvent"},{"$ref":"#/components/schemas/UserReactivatedEvent"},{"$ref":"#/components/schemas/UserUpdatedEvent"}]},"XiaomiConfig":{"properties":{"Disabled":{"type":"boolean","writeOnly":true,"x-stream-index":"003"},"package_name":{"type":"string","x-stream-index":"001"},"secret":{"type":"string","x-stream-index":"002"}},"type":"object"},"XiaomiConfigFields":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"package_name":{"type":"string","x-stream-index":"002"},"secret":{"type":"string","x-stream-index":"003"}},"required":["enabled"],"type":"object"}},"securitySchemes":{"JWT":{"description":"JWT should be always provided when stream-auth-type=jwt.\n\nUsing JWT auth request could be authenticated as user or as server-side.\n\nWhen using user authentication permission checking is going to be applied to requests based on the user that is\nperforming a request.\n\nThe `authorization` header should be a JWT string signed using the secret attached to the API key used to perform\nrequests.\n\n**WARNING** all client-side official SDK do not ship with token generation; this is to make sure that the API secret is not\nshared with an untrusted party such as a browser or a iOS/Android application. Tokens **must** be generated server-side.\nIf you wish, you can configure your application to ignore authentication (see `disable_auth_check`)\nThe JWT string must include only the user_id claim and can include any built-in JWT claim such as iat, exp as well.\n","in":"header","name":"Authorization","type":"apiKey"},"api_key":{"description":"Application API key should be always set in order to authenticate the request.","in":"query","name":"api_key","type":"apiKey"},"stream-auth-type":{"description":"Stream-Auth-Type should be always set in order to authenticate the request. Possible\nvalues: `jwt` or `anonymous`.\n\n`jwt` allows you to authenticate as a user. With this auth type you should also provide valid JWT in Authorization\nheader.\n\n`anonymous` allows you to authenticate as anonymous user. Please note that most advanced features are not available\nto anonymous users.","in":"header","name":"Stream-Auth-Type","type":"apiKey"}}},"info":{"title":"Stream API","version":"v187.13.0"},"openapi":"3.0.3","paths":{"/api/v2/app":{"get":{"description":"This Method returns the application settings\n","operationId":"GetApp","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetApplicationResponse"}}},"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":"Get App Settings","tags":["product:common"]},"patch":{"description":"This Method updates one or more application settings\n","operationId":"UpdateApp","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAppRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Update App Settings","tags":["product:common"]}},"/api/v2/blocklists":{"get":{"description":"Returns all available block lists\n","operationId":"ListBlockLists","parameters":[{"in":"query","name":"team","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListBlockListResponse"}}},"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":"List block lists","tags":["product:common"]},"post":{"description":"Creates a new application blocklist, once created the blocklist can be used by any channel type\n","operationId":"CreateBlockList","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBlockListRequest"}}},"description":"Block list","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBlockListResponse"}}},"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":"Create block list","tags":["product:common"]}},"/api/v2/blocklists/{name}":{"delete":{"description":"Deletes previously created application blocklist\n","operationId":"DeleteBlockList","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"team","schema":{"type":"string","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete block list","tags":["product:common"]},"get":{"description":"Returns block list by given name\n","operationId":"GetBlockList","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Block list name","title":"Name","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"team","schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBlockListResponse"}}},"description":"GetBlockListResponse"},"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":"Get block list","tags":["product:common"]},"put":{"description":"Updates contents of the block list\n","operationId":"UpdateBlockList","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Block list name","title":"Name","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBlockListRequest"}}},"description":"Update block list","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBlockListResponse"}}},"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":"Update block list","tags":["product:common"]}},"/api/v2/check_push":{"post":{"description":"Sends a test message via push, this is a test endpoint to verify your push settings\n","operationId":"CheckPush","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckPushRequest"}}},"description":"CheckPushRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckPushResponse"}}},"description":"Successful 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":"Check push","tags":["product:common"]}},"/api/v2/check_sns":{"post":{"description":"Validates Amazon SNS configuration\n","operationId":"CheckSNS","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSNSRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSNSResponse"}}},"description":"Successful 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":"Check SNS","tags":["product:common"]}},"/api/v2/check_sqs":{"post":{"description":"Validates Amazon SQS credentials\n","operationId":"CheckSQS","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSQSRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSQSResponse"}}},"description":"Successful 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":"Check SQS","tags":["product:common"]}},"/api/v2/devices":{"delete":{"description":"Deletes one device\n","operationId":"DeleteDevice","parameters":[{"in":"query","name":"id","required":true,"schema":{"description":"Device ID to delete","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"user_id","schema":{"description":"**Server-side only**. User ID which server acts upon","title":"User ID","type":"string","writeOnly":true,"x-stream-index":"002.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete device","tags":["product:common"]},"get":{"description":"Returns all available devices\n","operationId":"ListDevices","parameters":[{"in":"query","name":"user_id","schema":{"description":"**Server-side only**. User ID which server acts upon","title":"User ID","type":"string","writeOnly":true,"x-stream-index":"001.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDevicesResponse"}}},"description":"ListDevicesResponse"},"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":"List devices","tags":["product:common"]},"post":{"description":"Adds a new device to a user, if the same device already exists the call will have no effect\n","operationId":"CreateDevice","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDeviceRequest"}}},"description":"CreateDeviceRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Create device","tags":["product:common"]}},"/api/v2/export/users":{"post":{"description":"Exports user profile, reactions and messages for list of given users\n","operationId":"ExportUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportUsersResponse"}}},"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":"Export users","tags":["product:common"]}},"/api/v2/external_storage":{"get":{"description":"Lists external storage\n","operationId":"ListExternalStorage","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListExternalStorageResponse"}}},"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":"List external storage","tags":["product:common"]},"post":{"description":"Creates new external storage\n","operationId":"CreateExternalStorage","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateExternalStorageRequest"}}},"description":"CreateExternalStorageRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateExternalStorageResponse"}}},"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":"Create external storage","tags":["product:common"]}},"/api/v2/external_storage/{name}":{"delete":{"description":"Deletes external storage\n","operationId":"DeleteExternalStorage","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteExternalStorageResponse"}}},"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":"Delete external storage","tags":["product:common"]},"put":{"description":"\n","operationId":"UpdateExternalStorage","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateExternalStorageRequest"}}},"description":"ExternalStorageRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateExternalStorageResponse"}}},"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":"Update External Storage","tags":["product:common"]}},"/api/v2/external_storage/{name}/check":{"get":{"description":"\n","operationId":"CheckExternalStorage","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckExternalStorageResponse"}}},"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":"Check External Storage","tags":["product:common"]}},"/api/v2/guest":{"post":{"description":"\n","operationId":"CreateGuest","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGuestRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGuestResponse"}}},"description":"Successful 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":"Create Guest","tags":["product:common"]}},"/api/v2/import_urls":{"post":{"description":"Creates a new import URL\n","operationId":"CreateImportURL","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateImportURLRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateImportURLResponse"}}},"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":"Create import URL","tags":["product:common"]}},"/api/v2/imports":{"get":{"description":"Gets an import\n","operationId":"ListImports","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListImportsResponse"}}},"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":"Get import","tags":["product:common"]},"post":{"description":"Creates a new import\n","operationId":"CreateImport","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateImportRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateImportResponse"}}},"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":"Create import","tags":["product:common"]}},"/api/v2/imports/{id}":{"get":{"description":"Gets an import\n","operationId":"GetImport","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetImportResponse"}}},"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":"Get import","tags":["product:common"]}},"/api/v2/og":{"get":{"description":"Get an OpenGraph attachment for a link\n","operationId":"GetOG","parameters":[{"in":"query","name":"url","required":true,"schema":{"description":"URL to be scraped","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOGResponse"}}},"description":"Get OG Attachment"},"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":"Get OG","tags":["product:common"]}},"/api/v2/permissions":{"get":{"description":"Lists all available permissions\n","operationId":"ListPermissions","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPermissionsResponse"}}},"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":"List permissions","tags":["product:common"]}},"/api/v2/permissions/{id}":{"get":{"description":"Gets custom permission\n","operationId":"GetPermission","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Permission ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCustomPermissionResponse"}}},"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":"Get permission","tags":["product:common"]}},"/api/v2/polls":{"post":{"description":"Creates a new poll\n","operationId":"CreatePoll","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePollRequest"}}},"description":"Create Poll Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Create poll","tags":["product:common"]},"put":{"description":"Updates a poll\n\nSends events:\n- feeds.poll.closed\n- feeds.poll.updated\n- poll.closed\n- poll.updated\n","operationId":"UpdatePoll","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePollRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Update poll","tags":["product:common"]}},"/api/v2/polls/query":{"post":{"description":"Queries polls\n","operationId":"QueryPolls","parameters":[{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryPollsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryPollsResponse"}}},"description":"Successful 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":"Query polls","tags":["product:common"]}},"/api/v2/polls/{poll_id}":{"delete":{"description":"Deletes a poll\n\nSends events:\n- feeds.poll.deleted\n- poll.deleted\n","operationId":"DeletePoll","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete poll","tags":["product:common"]},"get":{"description":"Retrieves a poll\n","operationId":"GetPoll","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Get poll","tags":["product:common"]},"patch":{"description":"Updates a poll partially\n\nSends events:\n- feeds.poll.closed\n- feeds.poll.updated\n- poll.closed\n- poll.updated\n","operationId":"UpdatePollPartial","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePollPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Partial update poll","tags":["product:common"]}},"/api/v2/polls/{poll_id}/options":{"post":{"description":"Creates a poll option\n\nSends events:\n- feeds.poll.updated\n- poll.updated\n","operationId":"CreatePollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePollOptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollOptionResponse"}}},"description":"Successful 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":"Create poll option","tags":["product:common"]},"put":{"description":"Updates a poll option\n\nSends events:\n- feeds.poll.updated\n- poll.updated\n","operationId":"UpdatePollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePollOptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollOptionResponse"}}},"description":"Successful 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":"Update poll option","tags":["product:common"]}},"/api/v2/polls/{poll_id}/options/{option_id}":{"delete":{"description":"Deletes a poll option\n\nSends events:\n- feeds.poll.updated\n- poll.updated\n","operationId":"DeletePollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"path","name":"option_id","required":true,"schema":{"description":"Option ID","maxLength":255,"title":"string","type":"string","x-stream-index":"003"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete poll option","tags":["product:common"]},"get":{"description":"Retrieves a poll option\n","operationId":"GetPollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"path","name":"option_id","required":true,"schema":{"description":"Option ID","maxLength":255,"title":"string","type":"string","x-stream-index":"003"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollOptionResponse"}}},"description":"Successful 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":"Get poll option","tags":["product:common"]}},"/api/v2/polls/{poll_id}/votes":{"post":{"description":"Queries votes\n","operationId":"QueryPollVotes","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryPollVotesRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollVotesResponse"}}},"description":"Successful 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":"Query votes","tags":["product:common"]}},"/api/v2/push_providers":{"get":{"description":"List details of all push providers.\n","operationId":"ListPushProviders","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPushProvidersResponse"}}},"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":"List push providers","tags":["product:common"]},"post":{"description":"Upsert a push provider for v2 with multi bundle/package support\n","operationId":"UpsertPushProvider","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertPushProviderRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertPushProviderResponse"}}},"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":"Upsert a push provider","tags":["product:common"]}},"/api/v2/push_providers/{type}/{name}":{"delete":{"description":"Delete a push provider from v2 with multi bundle/package support. v1 isn't supported in this endpoint\n","operationId":"DeletePushProvider","parameters":[{"in":"path","name":"type","required":true,"schema":{"enum":["apn","firebase","huawei","xiaomi"],"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"name","required":true,"schema":{"maxLength":36,"minLength":1,"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete a push provider","tags":["product:common"]}},"/api/v2/rate_limits":{"get":{"description":"Get rate limits usage and quotas\n","operationId":"GetRateLimits","parameters":[{"in":"query","name":"server_side","schema":{"description":"Whether to include server-side platform limits or not","title":"Server-side","type":"boolean","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"android","schema":{"description":"Whether to include Android platform limits or not","title":"Android","type":"boolean","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"ios","schema":{"description":"Whether to include iOS platform limits or not","title":"iOS","type":"boolean","writeOnly":true,"x-stream-index":"003"}},{"in":"query","name":"web","schema":{"description":"Whether to include web platform limits or not","title":"Web","type":"boolean","writeOnly":true,"x-stream-index":"004"}},{"in":"query","name":"endpoints","schema":{"description":"Specific endpoints to show limits for, as a comma-separated list of values","title":"Endpoints","type":"string","writeOnly":true,"x-stream-index":"005"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRateLimitsResponse"}}},"description":"Get Rate Limits 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":"Get rate limits","tags":["product:common"]}},"/api/v2/roles":{"get":{"description":"Lists all available roles\n","operationId":"ListRoles","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListRolesResponse"}}},"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":"List roles","tags":["product:common"]},"post":{"description":"Creates custom role\n","operationId":"CreateRole","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRoleRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRoleResponse"}}},"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":"Create role","tags":["product:common"]}},"/api/v2/roles/{name}":{"delete":{"description":"Deletes custom role\n","operationId":"DeleteRole","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Role name","title":"Name","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete role","tags":["product:common"]}},"/api/v2/tasks/{id}":{"get":{"description":"Gets status of a task\n","operationId":"GetTask","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Task ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetTaskResponse"}}},"description":"Get Task 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":"Get status of a task","tags":["product:common"]}},"/api/v2/uploads/file":{"delete":{"description":"Deletes previously uploaded file\n","operationId":"DeleteFileGlobal","parameters":[{"in":"query","name":"url","schema":{"description":"File URL to delete","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete file","tags":["product:common"],"x-stream-sdk-name":"DeleteFile"},"post":{"description":"Uploads file\n","operationId":"UploadFileGlobal","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/FileUploadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileUploadResponse"}}},"description":"Successful 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":"Upload file","tags":["product:common"],"x-stream-sdk-name":"UploadFile"}},"/api/v2/uploads/image":{"delete":{"description":"Deletes previously uploaded image\n","operationId":"DeleteImageGlobal","parameters":[{"in":"query","name":"url","schema":{"description":"File URL to delete","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete image","tags":["product:common"],"x-stream-sdk-name":"DeleteImage"},"post":{"description":"Uploads image\n","operationId":"UploadImageGlobal","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/ImageUploadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageUploadResponse"}}},"description":"Successful 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":"Upload image","tags":["product:common"],"x-stream-sdk-name":"UploadImage"}},"/api/v2/users":{"get":{"description":"Find and filter users\n","operationId":"QueryUsers","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryUsersPayload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryUsersResponse"}}},"description":"Successful 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":"Query users","tags":["product:common"]},"patch":{"description":"Updates certain fields of the user\n\nSends events:\n- user.presence.changed\n- user.updated\n- user.presence.changed\n","operationId":"UpdateUsersPartial","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersResponse"}}},"description":"Successful 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":"Partially update user","tags":["product:common"]},"post":{"description":"Update or create users in bulk\n\nSends events:\n- user.updated\n","operationId":"UpdateUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersResponse"}}},"description":"Successful 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":"Upsert users","tags":["product:common"]}},"/api/v2/users/block":{"get":{"description":"Get list of blocked Users\n","operationId":"GetBlockedUsers","parameters":[{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBlockedUsersResponse"}}},"description":"Successful 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":"Get list of blocked Users","tags":["product:common"]},"post":{"description":"Block users\n","operationId":"BlockUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUsersResponse"}}},"description":"Successful 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":"Block user","tags":["product:common"]}},"/api/v2/users/deactivate":{"post":{"description":"Deactivate users in batches\n\nSends events:\n- user.deactivated\n","operationId":"DeactivateUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeactivateUsersRequest"}}},"description":"DeactivateUsersRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeactivateUsersResponse"}}},"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":"Deactivate users","tags":["product:common"]}},"/api/v2/users/delete":{"post":{"description":"Deletes users and optionally all their belongings asynchronously.\n\nSends events:\n- channel.deleted\n- user.deleted\n","operationId":"DeleteUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteUsersResponse"}}},"description":"Successful 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":"Delete Users","tags":["product:common"]}},"/api/v2/users/live_locations":{"get":{"description":"Retrieves all active live locations for a user\n","operationId":"GetUserLiveLocations","parameters":[{"in":"query","name":"user_id","schema":{"description":"User ID to get live locations for. If not provided, returns live locations for the authenticated user.","title":"string","type":"string","writeOnly":true,"x-stream-index":"001.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SharedLocationsResponse"}}},"description":"Successful 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":"Get user live locations","tags":["product:common"]},"put":{"description":"Updates an existing live location with new coordinates or expiration time\n","operationId":"UpdateLiveLocation","parameters":[{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"005.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateLiveLocationRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SharedLocationResponse"}}},"description":"Successful 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":"Update live location","tags":["product:common"]}},"/api/v2/users/reactivate":{"post":{"description":"Reactivate users in batches\n\nSends events:\n- user.reactivated\n- user.reactivated\n","operationId":"ReactivateUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReactivateUsersRequest"}}},"description":"ReactivateUsersRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReactivateUsersResponse"}}},"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":"Reactivate users","tags":["product:common"]}},"/api/v2/users/restore":{"post":{"description":"Restore soft deleted users\n","operationId":"RestoreUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestoreUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Restore users","tags":["product:common"]}},"/api/v2/users/unblock":{"post":{"description":"Unblock users\n","operationId":"UnblockUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUsersResponse"}}},"description":"Successful 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":"Unblock user","tags":["product:common"]}},"/api/v2/users/{user_id}/deactivate":{"post":{"description":"Deactivates user with possibility to activate it back\n\nSends events:\n- user.deactivated\n","operationId":"DeactivateUser","parameters":[{"in":"path","name":"user_id","required":true,"schema":{"title":"User ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeactivateUserRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeactivateUserResponse"}}},"description":"Successful 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":"Deactivate user","tags":["product:common"]}},"/api/v2/users/{user_id}/export":{"get":{"description":"Exports the user's profile, reactions and messages. Raises an error if a user has more than 10k messages or reactions\n","operationId":"ExportUser","parameters":[{"in":"path","name":"user_id","required":true,"schema":{"title":"User ID","type":"string","x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportUserResponse"}}},"description":"Successful 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":"Export user","tags":["product:common"]}},"/api/v2/users/{user_id}/reactivate":{"post":{"description":"Activates user who's been deactivated previously\n\nSends events:\n- user.reactivated\n","operationId":"ReactivateUser","parameters":[{"in":"path","name":"user_id","required":true,"schema":{"title":"User ID","type":"string","x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReactivateUserRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReactivateUserResponse"}}},"description":"Successful 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":"Reactivate user","tags":["product:common"]}},"/api/v2/video/active_calls_status":{"get":{"description":"Get the current status of all active calls including metrics and summary information\n","operationId":"GetActiveCallsStatus","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetActiveCallsStatusResponse"}}},"description":"GetActiveCallsStatusResponse"},"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":"Get active calls status","tags":["product:video"]}},"/api/v2/video/call/feedback":{"post":{"description":"\n","operationId":"QueryUserFeedback","parameters":[{"in":"query","name":"full","schema":{"type":"boolean","writeOnly":true,"x-stream-index":"003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryUserFeedbackRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryUserFeedbackResponse"}}},"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":"Query user reported feedback for the calls","tags":["product:video"]}},"/api/v2/video/call/members":{"post":{"description":"Query call members with filter query\n","operationId":"QueryCallMembers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallMembersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallMembersResponse"}}},"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":"Query call members","tags":["product:video"]}},"/api/v2/video/call/stats":{"post":{"description":"\n","operationId":"QueryCallStats","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallStatsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallStatsResponse"}}},"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":"Query Call Stats","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}":{"get":{"description":"\n","operationId":"GetCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"query","name":"members_limit","schema":{"format":"int32","maximum":100,"minimum":0,"type":"integer","writeOnly":true,"x-stream-index":"004"}},{"in":"query","name":"ring","schema":{"type":"boolean","writeOnly":true,"x-stream-index":"005"}},{"in":"query","name":"notify","schema":{"type":"boolean","writeOnly":true,"x-stream-index":"006"}},{"in":"query","name":"video","schema":{"type":"boolean","writeOnly":true,"x-stream-index":"007"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCallResponse"}}},"description":"GetCallResponse"},"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":"Get Call","tags":["product:video"]},"patch":{"description":"\n\nSends events:\n- call.updated\n","operationId":"UpdateCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallRequest"}}},"description":"UpdateCallRequest","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallResponse"}}},"description":"UpdateCallResponse"},"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":"Update Call","tags":["product:video"]},"post":{"description":"Gets or creates a new call\n\nSends events:\n- call.created\n- call.notification\n- call.ring\n","operationId":"GetOrCreateCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrCreateCallRequest"}}},"description":"GetOrCreateCallRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrCreateCallResponse"}}},"description":"GetOrCreateCallResponse"},"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":"Get or create a call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/block":{"post":{"description":"Block a user, preventing them from joining the call until they are unblocked.\n\nSends events:\n- call.blocked_user\n","operationId":"BlockUser","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUserRequest"}}},"description":"BlockUserRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUserResponse"}}},"description":"BlockUserResponse"},"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":"Block user on a call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/delete":{"post":{"description":"\n\nSends events:\n- call.deleted\n","operationId":"DeleteCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCallRequest"}}},"description":"DeleteCallRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCallResponse"}}},"description":"DeleteCallResponse"},"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":"Delete Call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/event":{"post":{"description":"Sends custom event to the call\n\nSends events:\n- custom\n","operationId":"SendCallEvent","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendCallEventRequest"}}},"description":"SendCallEventRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendCallEventResponse"}}},"description":"SendCallEventResponse"},"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":"Send custom event","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/feedback":{"post":{"description":"\n\nSends events:\n- call.user_feedback_submitted\n","operationId":"CollectUserFeedback","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectUserFeedbackRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectUserFeedbackResponse"}}},"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":"Collect user feedback","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/go_live":{"post":{"description":"\n\nSends events:\n- call.live_started\n","operationId":"GoLive","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoLiveRequest"}}},"description":"GoLiveRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoLiveResponse"}}},"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":"Set call as live","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/mark_ended":{"post":{"description":"\n\nSends events:\n- call.ended\n","operationId":"EndCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EndCallResponse"}}},"description":"EndCallResponse"},"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":"End call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/members":{"post":{"description":"\n\nSends events:\n- call.member_added\n- call.member_removed\n- call.member_updated\n","operationId":"UpdateCallMembers","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallMembersRequest"}}},"description":"UpdateCallMembersRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallMembersResponse"}}},"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":"Update Call Member","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/mute_users":{"post":{"description":"Mutes users in a call\n","operationId":"MuteUsers","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteUsersRequest"}}},"description":"MuteUsersRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteUsersResponse"}}},"description":"MuteUsersResponse"},"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":"Mute users","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/participants":{"post":{"description":"Returns a list of participants connected to the call\n","operationId":"QueryCallParticipants","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"type","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"limit","schema":{"format":"int32","maximum":100,"type":"integer","x-stream-index":"004"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallParticipantsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallParticipantsResponse"}}},"description":"Successful 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":"Query call participants","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/pin":{"post":{"description":"Pins a track for all users in the call.\n","operationId":"VideoPin","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PinRequest"}}},"description":"PinRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PinResponse"}}},"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":"Pin","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/recordings":{"get":{"description":"Lists recordings\n","operationId":"ListRecordings","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListRecordingsResponse"}}},"description":"ListRecordingsResponse"},"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":"List recordings","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/report":{"get":{"description":"\n","operationId":"GetCallReport","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"query","name":"session_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCallReportResponse"}}},"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":"Get call report","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/rtmp_broadcasts":{"post":{"description":"Starts RTMP broadcasts for the provided RTMP destinations\n","operationId":"StartRTMPBroadcasts","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRTMPBroadcastsRequest"}}},"description":"StartRTMPBroadcastsRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRTMPBroadcastsResponse"}}},"description":"StartRTMPBroadcastsResponse"},"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":"Start RTMP broadcasts","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/rtmp_broadcasts/stop":{"post":{"description":"Stop all RTMP broadcasts for the provided call\n","operationId":"StopAllRTMPBroadcasts","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopAllRTMPBroadcastsResponse"}}},"description":"StopAllRTMPBroadcastsResponse"},"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":"Stop all RTMP broadcasts for a call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/rtmp_broadcasts/{name}/stop":{"post":{"description":"Stop RTMP broadcasts for the provided RTMP destinations\n","operationId":"StopRTMPBroadcast","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopRTMPBroadcastsRequest"}}},"description":"StopRTMPBroadcastsRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopRTMPBroadcastsResponse"}}},"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":"Stop RTMP broadcasts","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/start_broadcasting":{"post":{"description":"Starts HLS broadcasting\n","operationId":"StartHLSBroadcasting","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartHLSBroadcastingResponse"}}},"description":"StartHLSBroadcastingResponse"},"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":"Start HLS broadcasting","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/start_closed_captions":{"post":{"description":"Starts closed captions\n","operationId":"StartClosedCaptions","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartClosedCaptionsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartClosedCaptionsResponse"}}},"description":"Successful 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":"Start closed captions","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/start_frame_recording":{"post":{"description":"Starts frame by frame recording\n\nSends events:\n- call.frame_recording_started\n","operationId":"StartFrameRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartFrameRecordingRequest"}}},"description":"StartFrameRecordingRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartFrameRecordingResponse"}}},"description":"StartFrameRecordingResponse"},"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":"Start frame recording","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/start_recording":{"post":{"description":"Starts recording\n\nSends events:\n- call.recording_started\n","operationId":"StartRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRecordingRequest"}}},"description":"StartRecordingRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRecordingResponse"}}},"description":"StartRecordingResponse"},"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":"Start recording","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/start_transcription":{"post":{"description":"Starts transcription\n","operationId":"StartTranscription","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartTranscriptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartTranscriptionResponse"}}},"description":"StartTranscriptionResponse"},"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":"Start transcription","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_broadcasting":{"post":{"description":"Stops HLS broadcasting\n","operationId":"StopHLSBroadcasting","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopHLSBroadcastingResponse"}}},"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":"Stop HLS broadcasting","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_closed_captions":{"post":{"description":"Stops closed captions\n\nSends events:\n- call.transcription_stopped\n","operationId":"StopClosedCaptions","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopClosedCaptionsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopClosedCaptionsResponse"}}},"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":"Stop closed captions","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_frame_recording":{"post":{"description":"Stops frame recording\n\nSends events:\n- call.frame_recording_stopped\n","operationId":"StopFrameRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopFrameRecordingResponse"}}},"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":"Stop frame recording","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_live":{"post":{"description":"\n\nSends events:\n- call.updated\n","operationId":"StopLive","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopLiveRequest"}}},"description":"StopLiveRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopLiveResponse"}}},"description":"StopLiveResponse"},"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":"Set call as not live","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_recording":{"post":{"description":"Stops recording\n\nSends events:\n- call.recording_stopped\n","operationId":"StopRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopRecordingResponse"}}},"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":"Stop recording","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_transcription":{"post":{"description":"Stops transcription\n\nSends events:\n- call.transcription_stopped\n","operationId":"StopTranscription","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopTranscriptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopTranscriptionResponse"}}},"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":"Stop transcription","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/transcriptions":{"get":{"description":"Lists transcriptions\n","operationId":"ListTranscriptions","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTranscriptionsResponse"}}},"description":"ListTranscriptionsResponse"},"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":"List transcriptions","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/unblock":{"post":{"description":"Removes the block for a user on a call. The user will be able to join the call again.\n\nSends events:\n- call.unblocked_user\n","operationId":"UnblockUser","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUserRequest"}}},"description":"UnblockUserRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUserResponse"}}},"description":"UnblockUserResponse"},"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":"Unblocks user on a call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/unpin":{"post":{"description":"Unpins a track for all users in the call.\n","operationId":"VideoUnpin","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnpinRequest"}}},"description":"UnpinRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnpinResponse"}}},"description":"UnpinResponse"},"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":"Unpin","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/user_permissions":{"post":{"description":"Updates user permissions\n\nSends events:\n- call.permissions_updated\n","operationId":"UpdateUserPermissions","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"005.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"005.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUserPermissionsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUserPermissionsResponse"}}},"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":"Update user permissions","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/{session}/recordings/{filename}":{"delete":{"description":"Deletes recording\n","operationId":"DeleteRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"path","name":"session","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"003"}},{"in":"path","name":"filename","required":true,"schema":{"maxLength":256,"type":"string","writeOnly":true,"x-stream-index":"004"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteRecordingResponse"}}},"description":"DeleteRecordingResponse"},"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":"Delete recording","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/{session}/transcriptions/{filename}":{"delete":{"description":"Deletes transcription\n","operationId":"DeleteTranscription","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"path","name":"session","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"003"}},{"in":"path","name":"filename","required":true,"schema":{"maxLength":256,"type":"string","writeOnly":true,"x-stream-index":"004"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteTranscriptionResponse"}}},"description":"DeleteTranscriptionResponse"},"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":"Delete transcription","tags":["product:video"]}},"/api/v2/video/calls":{"post":{"description":"Query calls with filter query\n","operationId":"QueryCalls","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallsRequest"}}},"description":"QueryCallsRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallsResponse"}}},"description":"QueryCallsResponse"},"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":"Query call","tags":["product:video"]}},"/api/v2/video/calltypes":{"get":{"description":"\n","operationId":"ListCallTypes","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListCallTypeResponse"}}},"description":"ListCallTypeResponse"},"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":"List Call Type","tags":["product:video"]},"post":{"description":"\n","operationId":"CreateCallType","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCallTypeRequest"}}},"description":"CreateCallTypeRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCallTypeResponse"}}},"description":"CreateCallTypeResponse"},"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":"Create Call Type","tags":["product:video"]}},"/api/v2/video/calltypes/{name}":{"delete":{"description":"\n","operationId":"DeleteCallType","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete Call Type","tags":["product:video"]},"get":{"description":"\n","operationId":"GetCallType","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCallTypeResponse"}}},"description":"GetCallTypeResponse"},"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":"Get Call Type","tags":["product:video"]},"put":{"description":"\n","operationId":"UpdateCallType","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallTypeRequest"}}},"description":"UpdateCallTypeRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallTypeResponse"}}},"description":"UpdateCallTypeResponse"},"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":"Update Call Type","tags":["product:video"]}},"/api/v2/video/edges":{"get":{"description":"Returns the list of all edges available for video calls.\n","operationId":"GetEdges","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetEdgesResponse"}}},"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":"Get Edges","tags":["product:video"]}},"/api/v2/video/stats":{"post":{"description":"\n","operationId":"QueryAggregateCallStats","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryAggregateCallStatsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryAggregateCallStatsResponse"}}},"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":"Query Aggregate call Stats","tags":["product:video"]}}},"security":[{"JWT":[],"api_key":[],"stream-auth-type":[]},{"api_key":[],"stream-auth-type":[]}],"servers":[{"description":"Stream API","url":"https://chat.stream-io-api.com"}]} \ No newline at end of file +{"components":{"schemas":{"APIError":{"nullable":true,"properties":{"StatusCode":{"description":"Response HTTP status code","format":"int32","title":"Status code","type":"integer","x-stream-index":"004"},"code":{"description":"API error code","format":"int32","title":"Code","type":"integer","x-stream-index":"001"},"details":{"description":"Additional error-specific information","items":{"type":"integer"},"title":"Details","type":"array","x-stream-index":"007"},"duration":{"description":"Request duration","title":"Duration","type":"string","x-stream-index":"005"},"exception_fields":{"additionalProperties":{"type":"string"},"description":"Additional error info","title":"Exception fields","type":"object","x-stream-index":"003"},"message":{"description":"Message describing an error","title":"Message","type":"string","x-stream-index":"002"},"more_info":{"description":"URL with additional information","title":"More info","type":"string","x-stream-index":"006"},"unrecoverable":{"description":"Flag that indicates if the error is unrecoverable, requests that return unrecoverable errors should not be retried, this error only applies to the request that caused it","title":"Unrecoverable","type":"boolean","x-stream-index":"008"}},"required":["code","message","StatusCode","duration","more_info","details"],"title":"Error response","type":"object"},"APNConfig":{"properties":{"Disabled":{"type":"boolean","writeOnly":true,"x-stream-index":"005"},"auth_key":{"type":"string","x-stream-index":"006.001"},"auth_type":{"enum":["certificate","token"],"type":"string","x-stream-index":"001"},"bundle_id":{"type":"string","x-stream-index":"004"},"development":{"type":"boolean","x-stream-index":"002"},"host":{"type":"string","x-stream-index":"003"},"key_id":{"type":"string","x-stream-index":"006.002"},"notification_template":{"type":"string","x-stream-index":"008"},"p12_cert":{"type":"string","x-stream-index":"007.001"},"team_id":{"type":"string","x-stream-index":"006.003"}},"type":"object"},"APNConfigFields":{"properties":{"auth_key":{"type":"string","x-stream-index":"009"},"auth_type":{"type":"string","x-stream-index":"003"},"bundle_id":{"type":"string","x-stream-index":"006"},"development":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"host":{"type":"string","x-stream-index":"005"},"key_id":{"type":"string","x-stream-index":"008"},"notification_template":{"type":"string","x-stream-index":"004"},"p12_cert":{"type":"string","x-stream-index":"010"},"team_id":{"type":"string","x-stream-index":"007"}},"required":["enabled","development"],"type":"object"},"APNS":{"properties":{"body":{"type":"string","x-stream-index":"002"},"content-available":{"format":"int32","type":"integer","x-stream-index":"004"},"data":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"mutable-content":{"format":"int32","type":"integer","x-stream-index":"005"},"sound":{"type":"string","x-stream-index":"003"},"title":{"type":"string","x-stream-index":"001"}},"required":["title","body"],"type":"object"},"Action":{"nullable":true,"properties":{"name":{"type":"string","x-stream-index":"001"},"style":{"type":"string","x-stream-index":"003"},"text":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"004"},"value":{"type":"string","x-stream-index":"005"}},"required":["name","text","type"],"type":"object"},"ActiveCallsBitrateStats":{"properties":{"p10":{"format":"float","type":"number","x-stream-index":"001"},"p50":{"format":"float","type":"number","x-stream-index":"002"}},"required":["p10","p50"],"type":"object"},"ActiveCallsFPSStats":{"properties":{"p05":{"format":"float","type":"number","x-stream-index":"001"},"p10":{"format":"float","type":"number","x-stream-index":"002"},"p50":{"format":"float","type":"number","x-stream-index":"003"},"p90":{"format":"float","type":"number","x-stream-index":"004"}},"required":["p05","p10","p50","p90"],"type":"object"},"ActiveCallsLatencyStats":{"properties":{"p50":{"format":"float","type":"number","x-stream-index":"001"},"p90":{"format":"float","type":"number","x-stream-index":"002"}},"required":["p50","p90"],"type":"object"},"ActiveCallsMetrics":{"properties":{"join_call_api":{"$ref":"#/components/schemas/JoinCallAPIMetrics","x-stream-index":"001"},"publishers":{"$ref":"#/components/schemas/PublishersMetrics","x-stream-index":"002"},"subscribers":{"$ref":"#/components/schemas/SubscribersMetrics","x-stream-index":"003"}},"type":"object"},"ActiveCallsResolutionStats":{"properties":{"p10":{"format":"float","type":"number","x-stream-index":"001"},"p50":{"format":"float","type":"number","x-stream-index":"002"}},"required":["p10","p50"],"type":"object"},"ActiveCallsSummary":{"properties":{"active_calls":{"format":"int32","type":"integer","x-stream-index":"001"},"active_publishers":{"format":"int32","type":"integer","x-stream-index":"002"},"active_subscribers":{"format":"int32","type":"integer","x-stream-index":"003"},"participants":{"format":"int32","type":"integer","x-stream-index":"004"}},"required":["active_calls","active_publishers","active_subscribers","participants"],"type":"object"},"AppResponseFields":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"019"},"async_url_enrich_enabled":{"type":"boolean","x-stream-index":"017"},"auto_translation_enabled":{"type":"boolean","x-stream-index":"020"},"before_message_send_hook_url":{"type":"string","x-stream-index":"021"},"call_types":{"additionalProperties":{"$ref":"#/components/schemas/CallType"},"type":"object","x-stream-index":"007"},"campaign_enabled":{"type":"boolean","x-stream-index":"034"},"cdn_expiration_seconds":{"format":"int32","type":"integer","x-stream-index":"037"},"channel_configs":{"additionalProperties":{"$ref":"#/components/schemas/ChannelConfig"},"type":"object","x-stream-index":"006"},"custom_action_handler_url":{"type":"string","x-stream-index":"022"},"datadog_info":{"$ref":"#/components/schemas/DataDogInfo","x-stream-index":"040"},"disable_auth_checks":{"type":"boolean","x-stream-index":"011"},"disable_permissions_checks":{"type":"boolean","x-stream-index":"012"},"enforce_unique_usernames":{"type":"string","x-stream-index":"023"},"event_hooks":{"items":{"$ref":"#/components/schemas/EventHook"},"type":"array","x-stream-index":"045"},"file_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","x-stream-index":"030"},"geofences":{"items":{"$ref":"#/components/schemas/GeofenceResponse"},"type":"array","x-stream-index":"039"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"033"},"guest_user_creation_disabled":{"type":"boolean","x-stream-index":"043"},"image_moderation_enabled":{"type":"boolean","x-stream-index":"016"},"image_moderation_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"018"},"image_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","x-stream-index":"031"},"moderation_bulk_submit_action_enabled":{"type":"boolean","x-stream-index":"048"},"moderation_dashboard_preferences":{"$ref":"#/components/schemas/ModerationDashboardPreferences","x-stream-index":"044"},"moderation_enabled":{"type":"boolean","x-stream-index":"041"},"moderation_llm_configurability_enabled":{"type":"boolean","x-stream-index":"049"},"moderation_multitenant_blocklist_enabled":{"type":"boolean","x-stream-index":"042"},"moderation_webhook_url":{"type":"string","x-stream-index":"005"},"multi_tenant_enabled":{"type":"boolean","x-stream-index":"015"},"name":{"type":"string","x-stream-index":"001"},"organization":{"type":"string","x-stream-index":"002"},"permission_version":{"type":"string","x-stream-index":"013"},"policies":{"additionalProperties":{"items":{"$ref":"#/components/schemas/Policy"},"type":"array"},"type":"object","x-stream-index":"008"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationFields","x-stream-index":"003"},"reminders_interval":{"format":"int32","type":"integer","x-stream-index":"036"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"032"},"sns_key":{"type":"string","x-stream-index":"028"},"sns_secret":{"type":"string","x-stream-index":"029"},"sns_topic_arn":{"type":"string","x-stream-index":"027"},"sqs_key":{"type":"string","x-stream-index":"025"},"sqs_secret":{"type":"string","x-stream-index":"026"},"sqs_url":{"type":"string","x-stream-index":"024"},"suspended":{"type":"boolean","x-stream-index":"009"},"suspended_explanation":{"type":"string","x-stream-index":"010"},"use_hook_v2":{"type":"boolean","x-stream-index":"046"},"user_response_time_enabled":{"type":"boolean","x-stream-index":"047"},"user_search_disallowed_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"014"},"webhook_events":{"items":{"type":"string"},"type":"array","x-stream-index":"035"},"webhook_url":{"type":"string","x-stream-index":"004"}},"required":["name","organization","push_notifications","webhook_url","moderation_webhook_url","channel_configs","call_types","policies","suspended","suspended_explanation","disable_auth_checks","disable_permissions_checks","permission_version","user_search_disallowed_roles","multi_tenant_enabled","image_moderation_enabled","async_url_enrich_enabled","auto_translation_enabled","custom_action_handler_url","enforce_unique_usernames","sqs_url","sqs_key","sqs_secret","sns_topic_arn","sns_key","sns_secret","file_upload_config","image_upload_config","grants","campaign_enabled","webhook_events","reminders_interval","cdn_expiration_seconds","video_provider","moderation_enabled","moderation_multitenant_blocklist_enabled","guest_user_creation_disabled","event_hooks","use_hook_v2","user_response_time_enabled","moderation_bulk_submit_action_enabled","moderation_llm_configurability_enabled"],"type":"object"},"AsyncExportChannelsEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"003.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.007"},"finished_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.004"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"task_id":{"type":"string","x-stream-index":"002.001"},"type":{"default":"export.channels.success","type":"string","x-stream-index":"003.002"},"url":{"type":"string","x-stream-index":"001"}},"required":["url","task_id","started_at","finished_at","type","created_at","custom"],"title":"AsyncExportChannelsEvent","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"},"AsyncExportErrorEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"003.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.007"},"error":{"type":"string","x-stream-index":"001"},"finished_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.004"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"task_id":{"type":"string","x-stream-index":"002.001"},"type":{"default":"export.users.error","type":"string","x-stream-index":"003.002"}},"required":["error","task_id","started_at","finished_at","type","created_at","custom"],"title":"AsyncExportErrorEvent","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"},"AsyncExportUsersEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"003.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.007"},"finished_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"number","x-stream-index":"003.004"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"task_id":{"type":"string","x-stream-index":"002.001"},"type":{"default":"export.users.success","type":"string","x-stream-index":"003.002"},"url":{"type":"string","x-stream-index":"001"}},"required":["url","task_id","started_at","finished_at","type","created_at","custom"],"title":"AsyncExportUsersEvent","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"},"AsyncModerationCallbackConfig":{"properties":{"mode":{"enum":["CALLBACK_MODE_NONE","CALLBACK_MODE_REST","CALLBACK_MODE_TWIRP"],"type":"string","x-stream-index":"002"},"server_url":{"type":"string","x-stream-index":"001"}},"type":"object"},"AsyncModerationConfiguration":{"properties":{"callback":{"$ref":"#/components/schemas/AsyncModerationCallbackConfig","x-stream-index":"002"},"timeout_ms":{"format":"int32","type":"integer","x-stream-index":"001"}},"type":"object"},"Attachment":{"description":"An attachment is a message object that represents a file uploaded by a user.","nullable":true,"properties":{"actions":{"items":{"$ref":"#/components/schemas/Action"},"type":"array","x-stream-index":"015"},"asset_url":{"type":"string","x-stream-index":"017"},"author_icon":{"type":"string","x-stream-index":"007"},"author_link":{"type":"string","x-stream-index":"006"},"author_name":{"type":"string","x-stream-index":"005"},"color":{"type":"string","x-stream-index":"003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"018"},"fallback":{"type":"string","x-stream-index":"002"},"fields":{"items":{"$ref":"#/components/schemas/Field"},"type":"array","x-stream-index":"016"},"footer":{"type":"string","x-stream-index":"013"},"footer_icon":{"type":"string","x-stream-index":"014"},"giphy":{"$ref":"#/components/schemas/Images","x-stream-index":"019"},"image_url":{"type":"string","x-stream-index":"011"},"og_scrape_url":{"type":"string","x-stream-index":"020"},"original_height":{"format":"int32","type":"integer","x-stream-index":"022"},"original_width":{"format":"int32","type":"integer","x-stream-index":"021"},"pretext":{"type":"string","x-stream-index":"004"},"text":{"type":"string","x-stream-index":"010"},"thumb_url":{"type":"string","x-stream-index":"012"},"title":{"type":"string","x-stream-index":"008"},"title_link":{"type":"string","x-stream-index":"009"},"type":{"description":"Attachment type (e.g. image, video, url)","title":"Type","type":"string","x-stream-index":"001"}},"required":["custom"],"title":"Attachment","type":"object","x-stream-docs-page-id":"file_uploads"},"AudioSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"001"},"default_device":{"enum":["speaker","earpiece"],"type":"string","x-stream-index":"006"},"mic_default_on":{"type":"boolean","x-stream-index":"004"},"noise_cancellation":{"$ref":"#/components/schemas/NoiseCancellationSettings","x-stream-index":"007"},"opus_dtx_enabled":{"type":"boolean","x-stream-index":"002"},"redundant_coding_enabled":{"type":"boolean","x-stream-index":"003"},"speaker_default_on":{"type":"boolean","x-stream-index":"005"}},"required":["access_request_enabled","opus_dtx_enabled","redundant_coding_enabled","mic_default_on","speaker_default_on","default_device"],"type":"object"},"AudioSettingsRequest":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"001"},"default_device":{"enum":["speaker","earpiece"],"type":"string","x-stream-index":"006"},"mic_default_on":{"type":"boolean","x-stream-index":"004"},"noise_cancellation":{"$ref":"#/components/schemas/NoiseCancellationSettings","x-stream-index":"007"},"opus_dtx_enabled":{"type":"boolean","x-stream-index":"002"},"redundant_coding_enabled":{"type":"boolean","x-stream-index":"003"},"speaker_default_on":{"type":"boolean","x-stream-index":"005"}},"required":["default_device"],"type":"object"},"AudioSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"001"},"default_device":{"enum":["speaker","earpiece"],"type":"string","x-stream-index":"006"},"mic_default_on":{"type":"boolean","x-stream-index":"004"},"noise_cancellation":{"$ref":"#/components/schemas/NoiseCancellationSettings","x-stream-index":"007"},"opus_dtx_enabled":{"type":"boolean","x-stream-index":"002"},"redundant_coding_enabled":{"type":"boolean","x-stream-index":"003"},"speaker_default_on":{"type":"boolean","x-stream-index":"005"}},"required":["access_request_enabled","opus_dtx_enabled","redundant_coding_enabled","mic_default_on","speaker_default_on","default_device"],"type":"object"},"AzureRequest":{"description":"Config for creating Azure Blob Storage storage","properties":{"abs_account_name":{"description":"The account name","title":"AccountName","type":"string","x-stream-index":"001"},"abs_client_id":{"description":"The client id","title":"ClientID","type":"string","x-stream-index":"003"},"abs_client_secret":{"description":"The client secret","title":"ClientSecret","type":"string","x-stream-index":"004"},"abs_tenant_id":{"description":"The tenant id","title":"TenantID","type":"string","x-stream-index":"002"}},"required":["abs_account_name","abs_tenant_id","abs_client_id","abs_client_secret"],"title":"AzureRequest","type":"object"},"BackstageSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"BackstageSettingsRequest":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"002"}},"type":"object"},"BackstageSettingsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"BlockListOptions":{"properties":{"behavior":{"description":"Blocklist behavior","enum":["flag","block","shadow_block"],"title":"Behavior","type":"string","x-stream-index":"002"},"blocklist":{"description":"Blocklist name","title":"Blocklist","type":"string","x-stream-index":"001"}},"required":["blocklist","behavior"],"type":"object"},"BlockListResponse":{"description":"Block list contains restricted words","properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001"},"id":{"type":"string","x-stream-index":"003"},"name":{"description":"Block list name","title":"Name","type":"string","x-stream-index":"004"},"team":{"type":"string","x-stream-index":"007"},"type":{"description":"Block list type.","title":"Type","type":"string","x-stream-index":"005"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"002"},"words":{"description":"List of words to block","items":{"type":"string"},"title":"Words","type":"array","x-stream-index":"006"}},"required":["name","type","words"],"title":"Block list","type":"object","x-stream-docs-page-id":"block_lists"},"BlockUserRequest":{"description":"BlockUserRequest is the payload for blocking a user.","nullable":true,"properties":{"user_id":{"description":"the user to block","title":"UserID","type":"string","x-stream-index":"003"}},"required":["user_id"],"title":"BlockUserRequest","type":"object"},"BlockUserResponse":{"description":"BlockUserResponse is the payload for blocking a user.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"BlockUserResponse","type":"object"},"BlockUsersRequest":{"nullable":true,"properties":{"blocked_user_id":{"description":"User id to block","title":"BlockedUserID","type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"required":["blocked_user_id"],"type":"object"},"BlockUsersResponse":{"nullable":true,"properties":{"blocked_by_user_id":{"description":"User id who blocked another user","title":"BlockedByUserID","type":"string","x-stream-index":"002"},"blocked_user_id":{"description":"User id who got blocked","title":"BlockedUserID","type":"string","x-stream-index":"003"},"created_at":{"description":"Timestamp when the user was blocked","format":"date-time","title":"CreatedAt","type":"number","x-stream-index":"004"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration","blocked_by_user_id","blocked_user_id","created_at"],"type":"object"},"BlockedUserEvent":{"description":"This event is sent to call participants to notify when a user is blocked on a call, clients can use this event to show a notification.\nIf the user is the current user, the client should leave the call screen as well","properties":{"blocked_by_user":{"$ref":"#/components/schemas/UserResponse","description":"The user that blocked the user, null if the user was blocked by server-side","title":"Blocked by","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.blocked_user","description":"The type of event: \"call.blocked_user\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user that was blocked","title":"User","x-stream-index":"003"}},"required":["type","created_at","call_cid","user"],"title":"BlockedUserEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"BlockedUserResponse":{"nullable":true,"properties":{"blocked_user":{"$ref":"#/components/schemas/UserResponse","description":"User who got blocked","title":"User","x-stream-index":"003"},"blocked_user_id":{"description":"ID of the user who got blocked","title":"UserID","type":"string","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User who blocked another user","title":"User","x-stream-index":"001"},"user_id":{"description":"ID of the user who blocked another user","title":"UserID","type":"string","x-stream-index":"002"}},"required":["user","user_id","blocked_user","blocked_user_id","created_at"],"type":"object"},"Bound":{"properties":{"inclusive":{"type":"boolean","x-stream-index":"002"},"value":{"format":"float","type":"number","x-stream-index":"001"}},"required":["value","inclusive"],"type":"object"},"BroadcastSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettings","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettings","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"BroadcastSettingsRequest":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettingsRequest","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettingsRequest","x-stream-index":"003"}},"type":"object"},"BroadcastSettingsResponse":{"description":"BroadcastSettingsResponse is the payload for broadcasting settings","properties":{"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettingsResponse","title":"HLS","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettingsResponse","title":"RTMP","x-stream-index":"003"}},"required":["enabled","hls","rtmp"],"title":"BroadcastSettingsResponse","type":"object"},"BrowserDataResponse":{"properties":{"name":{"type":"string","x-stream-index":"001"},"version":{"type":"string","x-stream-index":"002"}},"type":"object"},"CallAcceptedEvent":{"description":"This event is sent when a user accepts a notification to join a call.","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.accepted","description":"The type of event: \"call.accepted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who accepted the call","title":"User","x-stream-index":"004"}},"required":["type","created_at","call_cid","call","user"],"title":"CallAcceptedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallClosedCaption":{"description":"CallClosedCaption represents a closed caption of a call.","properties":{"end_time":{"format":"date-time","title":"The end time of the closed caption.","type":"number","x-stream-index":"003"},"speaker_id":{"title":"The speaker ID of the closed caption.","type":"string","x-stream-index":"004"},"start_time":{"format":"date-time","title":"The start time of the closed caption.","type":"number","x-stream-index":"002"},"text":{"title":"The text of the closed caption.","type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserResponse","title":"The full user for the closed caption.","x-stream-index":"005"}},"required":["text","start_time","end_time","speaker_id","user"],"title":"CallClosedCaption","type":"object"},"CallClosedCaptionsFailedEvent":{"description":"This event is sent when call closed captions has failed","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.closed_captions_failed","description":"The type of event: \"call.closed_captions_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallClosedCaptionsFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallClosedCaptionsStartedEvent":{"description":"This event is sent when call closed caption has started","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.closed_captions_started","description":"The type of event: \"call.closed_captions_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallClosedCaptionsStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallClosedCaptionsStoppedEvent":{"description":"This event is sent when call closed captions has stopped","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.closed_captions_stopped","description":"The type of event: \"call.transcription_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallClosedCaptionsStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallCreatedEvent":{"description":"This event is sent when a call is created. Clients receiving this event should check if the ringing\nfield is set to true and if so, show the call screen","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"the members added to this call","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"004"},"type":{"default":"call.created","description":"The type of event: \"call.created\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","members"],"title":"CallCreatedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallDeletedEvent":{"description":"This event is sent when a call is deleted. Clients receiving this event should leave the call screen","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.deleted","description":"The type of event: \"call.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call"],"title":"CallDeletedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallDurationReport":{"properties":{"histogram":{"items":{"$ref":"#/components/schemas/ReportByHistogramBucket"},"type":"array","x-stream-index":"001"}},"required":["histogram"],"type":"object"},"CallDurationReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateCallDurationReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"CallEndedEvent":{"description":"This event is sent when a call is mark as ended for all its participants. Clients receiving this event should leave the call screen","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"reason":{"description":"The reason why the call ended, if available","title":"CallEndedReason","type":"string","x-stream-index":"005"},"type":{"default":"call.ended","description":"The type of event: \"call.ended\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who ended the call, null if the call was ended by the server","title":"User","x-stream-index":"004"}},"required":["type","created_at","call_cid","call"],"title":"CallEndedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallFrameRecordingFailedEvent":{"description":"This event is sent when frame recording has failed","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.frame_recording_failed","description":"The type of event: \"call.frame_recording_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","egress_id"],"title":"CallFrameRecordingFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallFrameRecordingFrameReadyEvent":{"description":"This event is sent when a frame is captured from a call","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"captured_at":{"description":"The time the frame was captured","format":"date-time","title":"CapturedAt","type":"number","x-stream-index":"006"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"008"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"track_type":{"description":"The type of the track frame was captured from (TRACK_TYPE_VIDEO|TRACK_TYPE_SCREEN_SHARE)","title":"TrackType","type":"string","x-stream-index":"004"},"type":{"default":"call.frame_recording_ready","description":"The type of event: \"call.frame_recording_ready\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"url":{"description":"The URL of the frame","title":"URL","type":"string","x-stream-index":"005"},"users":{"additionalProperties":{"$ref":"#/components/schemas/UserResponse"},"description":"The users in the frame","title":"Users","type":"object","x-stream-index":"007"}},"required":["type","created_at","call_cid","session_id","track_type","url","captured_at","users","egress_id"],"title":"CallFrameRecordingFrameReadyEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallFrameRecordingStartedEvent":{"description":"This event is sent when frame recording has started","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.frame_recording_started","description":"The type of event: \"call.frame_recording_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","egress_id"],"title":"CallFrameRecordingStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallFrameRecordingStoppedEvent":{"description":"This event is sent when frame recording has stopped","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.frame_recording_stopped","description":"The type of event: \"call.frame_recording_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","egress_id"],"title":"CallFrameRecordingStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallHLSBroadcastingFailedEvent":{"description":"This event is sent when HLS broadcasting has failed","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.hls_broadcasting_failed","description":"The type of event: \"call.hls_broadcasting_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallHLSBroadcastingFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallHLSBroadcastingStartedEvent":{"description":"This event is sent when HLS broadcasting has started","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"hls_playlist_url":{"type":"string","x-stream-index":"004"},"type":{"default":"call.hls_broadcasting_started","description":"The type of event: \"call.hls_broadcasting_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","hls_playlist_url"],"title":"CallHLSBroadcastingStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallHLSBroadcastingStoppedEvent":{"description":"This event is sent when HLS broadcasting has stopped","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.hls_broadcasting_stopped","description":"The type of event: \"call.hls_broadcasting_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallHLSBroadcastingStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallIngressResponse":{"description":"CallIngressResponse is the payload for ingress settings","properties":{"rtmp":{"$ref":"#/components/schemas/RTMPIngress","title":"RTMP","x-stream-index":"001"}},"required":["rtmp"],"title":"CallIngressResponse","type":"object"},"CallLiveStartedEvent":{"description":"This event is sent when a call is started. Clients receiving this event should start the call.","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.live_started","description":"The type of event: \"call.live_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call"],"title":"CallLiveStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMemberAddedEvent":{"description":"This event is sent when one or more members are added to a call","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"the members added to this call","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"004"},"type":{"default":"call.member_added","description":"The type of event: \"call.member_added\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","members"],"title":"CallMemberAddedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMemberRemovedEvent":{"description":"This event is sent when one or more members are removed from a call","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"the list of member IDs removed from the call","items":{"type":"string"},"title":"Members","type":"array","x-stream-index":"004"},"type":{"default":"call.member_removed","description":"The type of event: \"call.member_removed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","members"],"title":"CallMemberRemovedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMemberUpdatedEvent":{"description":"This event is sent when one or more members are updated","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"The list of members that were updated","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"004"},"type":{"default":"call.member_updated","description":"The type of event: \"call.member_updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","members"],"title":"CallMemberUpdatedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMemberUpdatedPermissionEvent":{"description":"This event is sent when one or more members get its role updated","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"capabilities_by_role":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"The capabilities by role for this call","title":"CapabilitiesByRole","type":"object","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"The list of members that were updated","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"005"},"type":{"default":"call.member_updated_permission","description":"The type of event: \"call.member_added\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","capabilities_by_role","members"],"title":"CallMemberUpdatedPermissionEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMissedEvent":{"description":"This event is sent to call members who did not accept/reject/join the call to notify they missed the call","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"List of members who missed the call","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"005"},"notify_user":{"type":"boolean","x-stream-index":"007"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.missed","description":"The type of event: \"call.notification\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The caller from whom the call was missed","title":"User","x-stream-index":"006"}},"required":["type","created_at","call_cid","session_id","call","members","user","notify_user"],"title":"CallMissedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallModerationBlurEvent":{"properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"type":{"default":"call.moderation_blur","type":"string","x-stream-index":"001.001"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["type","created_at","call_cid","user_id","custom"],"title":"CallModerationBlurEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallModerationWarningEvent":{"properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"message":{"type":"string","x-stream-index":"004"},"type":{"default":"call.moderation_warning","type":"string","x-stream-index":"001.001"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["type","created_at","call_cid","user_id","message","custom"],"title":"CallModerationWarningEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallNotificationEvent":{"description":"This event is sent to all call members to notify they are getting called","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"Call members","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"005"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.notification","description":"The type of event: \"call.notification\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user that sent the call notification","title":"User","x-stream-index":"006"}},"required":["type","created_at","call_cid","session_id","call","members","user"],"title":"CallNotificationEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallParticipantCountReport":{"properties":{"histogram":{"items":{"$ref":"#/components/schemas/ReportByHistogramBucket"},"type":"array","x-stream-index":"001"}},"required":["histogram"],"type":"object"},"CallParticipantCountReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateCallParticipantCountReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"CallParticipantResponse":{"properties":{"joined_at":{"format":"date-time","type":"number","x-stream-index":"004"},"role":{"type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"},"user_session_id":{"type":"string","x-stream-index":"002"}},"required":["user","user_session_id","role","joined_at"],"type":"object"},"CallReactionEvent":{"description":"This event is sent when a reaction is sent in a call, clients should use this to show the reaction in the call screen","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"reaction":{"$ref":"#/components/schemas/ReactionResponse","description":"the reaction object sent by the user on the call","title":"reaction","x-stream-index":"003"},"type":{"default":"call.reaction_new","description":"The type of event: \"call.reaction_new\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","reaction"],"title":"CallReactionEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRecording":{"description":"CallRecording represents a recording of a call.","properties":{"end_time":{"format":"date-time","title":"The end time of the recording.","type":"number","x-stream-index":"004"},"filename":{"title":"The filename of the recording.","type":"string","x-stream-index":"001"},"session_id":{"title":"The session ID of the recording.","type":"string","x-stream-index":"005"},"start_time":{"format":"date-time","title":"The start time of the recording.","type":"number","x-stream-index":"003"},"url":{"title":"The URL of the recording.","type":"string","x-stream-index":"002"}},"required":["filename","url","start_time","end_time","session_id"],"title":"CallRecording","type":"object"},"CallRecordingFailedEvent":{"description":"This event is sent when call recording has failed","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"003"},"type":{"default":"call.recording_failed","description":"The type of event: \"call.recording_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","egress_id"],"title":"CallRecordingFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRecordingReadyEvent":{"description":"This event is sent when call recording is ready","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"call_recording":{"$ref":"#/components/schemas/CallRecording","description":"The call recording object","title":"CallRecording","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.recording_ready","description":"The type of event: \"call.recording_ready\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call_recording","egress_id"],"title":"CallRecordingReadyEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRecordingStartedEvent":{"description":"This event is sent when call recording has started","properties":{"call_cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"egress_id":{"type":"string","x-stream-index":"001"},"type":{"default":"call.recording_started","description":"The type of event: \"call.recording_started\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001"}},"required":["egress_id","type","created_at","call_cid"],"title":"CallRecordingStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRecordingStoppedEvent":{"description":"This event is sent when call recording has stopped","properties":{"call_cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"egress_id":{"type":"string","x-stream-index":"001"},"type":{"default":"call.recording_stopped","description":"The type of event: \"call.recording_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001"}},"required":["egress_id","type","created_at","call_cid"],"title":"CallRecordingStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRejectedEvent":{"description":"This event is sent when a user rejects a notification to join a call.","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"reason":{"description":"Provides information about why the call was rejected. You can provide any value, but the Stream API and SDKs use these default values: rejected, cancel, timeout and busy","title":"Reason","type":"string","x-stream-index":"005"},"type":{"default":"call.rejected","description":"The type of event: \"call.rejected\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who rejected the call","title":"User","x-stream-index":"004"}},"required":["type","created_at","call_cid","call","user"],"title":"CallRejectedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallReportResponse":{"properties":{"ended_at":{"format":"date-time","type":"number","x-stream-index":"003"},"score":{"format":"float","type":"number","x-stream-index":"001"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002"}},"required":["score"],"type":"object"},"CallRequest":{"description":"CallRequest is the payload for creating a call.","properties":{"channel_cid":{"type":"string","x-stream-index":"009"},"created_by":{"$ref":"#/components/schemas/UserRequest","title":"The user that create this call","x-stream-index":"002"},"created_by_id":{"title":"The id of the user that create this call","type":"string","x-stream-index":"003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"members":{"items":{"$ref":"#/components/schemas/MemberRequest"},"maximum":100,"type":"array","x-stream-index":"005"},"settings_override":{"$ref":"#/components/schemas/CallSettingsRequest","x-stream-index":"006"},"starts_at":{"format":"date-time","type":"number","x-stream-index":"007"},"team":{"type":"string","x-stream-index":"001"},"video":{"type":"boolean","x-stream-index":"008"}},"title":"CallRequest","type":"object"},"CallResponse":{"description":"Represents a call","properties":{"backstage":{"type":"boolean","x-stream-index":"016"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"018"},"captioning":{"type":"boolean","x-stream-index":"013"},"channel_cid":{"type":"string","x-stream-index":"024"},"cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"The user that created the call","title":"Created By","x-stream-index":"007"},"current_session_id":{"type":"string","x-stream-index":"005"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"008"},"egress":{"$ref":"#/components/schemas/EgressResponse","x-stream-index":"021"},"ended_at":{"description":"Date/time when the call ended","format":"date-time","title":"Ended At","type":"number","x-stream-index":"014"},"id":{"description":"Call ID","title":"ID","type":"string","x-stream-index":"003"},"ingress":{"$ref":"#/components/schemas/CallIngressResponse","x-stream-index":"019"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"023"},"recording":{"type":"boolean","x-stream-index":"011"},"session":{"$ref":"#/components/schemas/CallSessionResponse","x-stream-index":"020"},"settings":{"$ref":"#/components/schemas/CallSettingsResponse","x-stream-index":"017"},"starts_at":{"description":"Date/time when the call will start","format":"date-time","title":"Starts At","type":"number","x-stream-index":"015"},"team":{"type":"string","x-stream-index":"006"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailResponse","x-stream-index":"022"},"transcribing":{"type":"boolean","x-stream-index":"012"},"type":{"description":"The type of call","title":"Type","type":"string","x-stream-index":"002"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"}},"required":["type","id","cid","current_session_id","created_by","custom","created_at","updated_at","recording","transcribing","captioning","backstage","settings","blocked_user_ids","ingress","egress"],"title":"CallResponse","type":"object"},"CallRingEvent":{"description":"This event is sent to all call members to notify they are getting called","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"005"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"members":{"description":"Call members","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"006"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.ring","description":"The type of event: \"call.notification\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user that sent the call notification","title":"User","x-stream-index":"007"},"video":{"type":"boolean","x-stream-index":"008"}},"required":["type","created_at","call_cid","session_id","call","members","user","video"],"title":"CallRingEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRtmpBroadcastFailedEvent":{"description":"This event is sent when a call RTMP broadcast has failed","properties":{"call_cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"002.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.002"},"name":{"description":"Name of the given RTMP broadcast","title":"Name","type":"string","x-stream-index":"003"},"type":{"default":"call.rtmp_broadcast_failed","description":"The type of event: \"call.rtmp_broadcast_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","name"],"title":"CallRtmpBroadcastFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRtmpBroadcastStartedEvent":{"description":"This event is sent when RTMP broadcast has started","properties":{"call_cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"002.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.002"},"name":{"description":"Name of the given RTMP broadcast","title":"Name","type":"string","x-stream-index":"003"},"type":{"default":"call.rtmp_broadcast_started","description":"The type of event: \"call.rtmp_broadcast_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","name"],"title":"CallRtmpBroadcastStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRtmpBroadcastStoppedEvent":{"description":"This event is sent when RTMP broadcast has stopped","properties":{"call_cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"002.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.002"},"name":{"description":"Name of the given RTMP broadcast","title":"Name","type":"string","x-stream-index":"003"},"type":{"default":"call.rtmp_broadcast_stopped","description":"The type of event: \"call.rtmp_broadcast_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","name"],"title":"CallRtmpBroadcastStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSessionEndedEvent":{"description":"This event is sent when a call session ends","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_ended","description":"The type of event: \"call.session_ended\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","call"],"title":"CallSessionEndedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSessionParticipantCountsUpdatedEvent":{"description":"This event is sent when the participant counts in a call session are updated","properties":{"anonymous_participant_count":{"format":"int32","type":"integer","x-stream-index":"005"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"participants_count_by_role":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"004"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_participant_count_updated","description":"The type of event: \"call.session_participant_count_updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","participants_count_by_role","anonymous_participant_count"],"title":"CallSessionParticipantCountsUpdatedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSessionParticipantJoinedEvent":{"description":"This event is sent when a participant joins a call session","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"participant":{"$ref":"#/components/schemas/CallParticipantResponse","description":"The participant that joined the session","title":"Participant","x-stream-index":"004"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_participant_joined","description":"The type of event: \"call.session_participant_joined\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","participant"],"title":"CallSessionParticipantJoinedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSessionParticipantLeftEvent":{"description":"This event is sent when a participant leaves a call session","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"duration_seconds":{"description":"The duration participant was in the session in seconds","format":"int32","title":"Duration","type":"integer","x-stream-index":"005"},"participant":{"$ref":"#/components/schemas/CallParticipantResponse","description":"The participant that left the session","title":"Participant","x-stream-index":"004"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_participant_left","description":"The type of event: \"call.session_participant_left\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","participant","duration_seconds"],"title":"CallSessionParticipantLeftEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSessionResponse":{"properties":{"accepted_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"008"},"anonymous_participant_count":{"format":"int32","type":"integer","x-stream-index":"006"},"ended_at":{"format":"date-time","type":"number","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"live_ended_at":{"format":"date-time","type":"number","x-stream-index":"011"},"live_started_at":{"format":"date-time","type":"number","x-stream-index":"010"},"missed_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"009"},"participants":{"items":{"$ref":"#/components/schemas/CallParticipantResponse"},"type":"array","x-stream-index":"004"},"participants_count_by_role":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"005"},"rejected_by":{"additionalProperties":{"format":"date-time","type":"number"},"type":"object","x-stream-index":"007"},"started_at":{"format":"date-time","type":"number","x-stream-index":"002"},"timer_ends_at":{"format":"date-time","type":"number","x-stream-index":"012"}},"required":["id","participants","participants_count_by_role","anonymous_participant_count","rejected_by","accepted_by","missed_by"],"type":"object"},"CallSessionStartedEvent":{"description":"This event is sent when a call session starts","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_started","description":"The type of event: \"call.session_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","call"],"title":"CallSessionStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSettings":{"properties":{"audio":{"$ref":"#/components/schemas/AudioSettings","x-stream-index":"001"},"backstage":{"$ref":"#/components/schemas/BackstageSettings","x-stream-index":"002"},"broadcasting":{"$ref":"#/components/schemas/BroadcastSettings","x-stream-index":"007"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordSettings","x-stream-index":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettings","x-stream-index":"008"},"ingress":{"$ref":"#/components/schemas/IngressSettings","x-stream-index":"014"},"limits":{"$ref":"#/components/schemas/LimitsSettings","x-stream-index":"012"},"recording":{"$ref":"#/components/schemas/RecordSettings","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettings","x-stream-index":"010"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettings","x-stream-index":"004"},"session":{"$ref":"#/components/schemas/SessionSettings","x-stream-index":"013"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettings","x-stream-index":"011"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettings","x-stream-index":"009"},"video":{"$ref":"#/components/schemas/VideoSettings","x-stream-index":"003"}},"type":"object"},"CallSettingsRequest":{"properties":{"audio":{"$ref":"#/components/schemas/AudioSettingsRequest","x-stream-index":"001"},"backstage":{"$ref":"#/components/schemas/BackstageSettingsRequest","x-stream-index":"002"},"broadcasting":{"$ref":"#/components/schemas/BroadcastSettingsRequest","x-stream-index":"010"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordingSettingsRequest","x-stream-index":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettingsRequest","x-stream-index":"003"},"ingress":{"$ref":"#/components/schemas/IngressSettingsRequest","x-stream-index":"014"},"limits":{"$ref":"#/components/schemas/LimitsSettingsRequest","x-stream-index":"012"},"recording":{"$ref":"#/components/schemas/RecordSettingsRequest","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettingsRequest","x-stream-index":"007"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettingsRequest","x-stream-index":"008"},"session":{"$ref":"#/components/schemas/SessionSettingsRequest","x-stream-index":"013"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettingsRequest","x-stream-index":"011"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettingsRequest","x-stream-index":"009"},"video":{"$ref":"#/components/schemas/VideoSettingsRequest","x-stream-index":"004"}},"type":"object"},"CallSettingsResponse":{"properties":{"audio":{"$ref":"#/components/schemas/AudioSettingsResponse","x-stream-index":"001"},"backstage":{"$ref":"#/components/schemas/BackstageSettingsResponse","x-stream-index":"002"},"broadcasting":{"$ref":"#/components/schemas/BroadcastSettingsResponse","x-stream-index":"003"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordingSettingsResponse","x-stream-index":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettingsResponse","x-stream-index":"004"},"ingress":{"$ref":"#/components/schemas/IngressSettingsResponse","x-stream-index":"014"},"limits":{"$ref":"#/components/schemas/LimitsSettingsResponse","x-stream-index":"012"},"recording":{"$ref":"#/components/schemas/RecordSettingsResponse","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettingsResponse","x-stream-index":"007"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettingsResponse","x-stream-index":"008"},"session":{"$ref":"#/components/schemas/SessionSettingsResponse","x-stream-index":"013"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettingsResponse","x-stream-index":"011"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettingsResponse","x-stream-index":"009"},"video":{"$ref":"#/components/schemas/VideoSettingsResponse","x-stream-index":"010"}},"required":["audio","backstage","broadcasting","geofencing","recording","frame_recording","ring","screensharing","transcription","video","thumbnails","limits","session"],"type":"object"},"CallStateResponseFields":{"description":"CallStateResponseFields is the payload for call state response","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001"},"members":{"description":"List of call members","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"002"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"004"}},"required":["call","members","own_capabilities","blocked_users"],"title":"CallStateResponseFields","type":"object"},"CallStatsReportReadyEvent":{"description":"This event is sent when the insights report is ready","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.stats_report_ready","description":"The type of event, \"call.report_ready\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id"],"title":"CallStatsReportReadyEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallStatsReportSummaryResponse":{"properties":{"call_cid":{"type":"string","x-stream-index":"001"},"call_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"008"},"call_session_id":{"type":"string","x-stream-index":"002"},"call_status":{"type":"string","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"first_stats_time":{"format":"date-time","type":"number","x-stream-index":"003"},"min_user_rating":{"format":"int32","type":"integer","x-stream-index":"006"},"quality_score":{"format":"int32","type":"integer","x-stream-index":"005"}},"required":["call_cid","call_session_id","first_stats_time","call_status","call_duration_seconds"],"type":"object"},"CallTranscription":{"description":"CallTranscription represents a transcription of a call.","properties":{"end_time":{"format":"date-time","title":"The end time of the transcription.","type":"number","x-stream-index":"004"},"filename":{"title":"The filename of the transcription.","type":"string","x-stream-index":"001"},"session_id":{"title":"The session ID of the transcription.","type":"string","x-stream-index":"005"},"start_time":{"format":"date-time","title":"The start time of the transcription.","type":"number","x-stream-index":"003"},"url":{"title":"The URL of the transcription.","type":"string","x-stream-index":"002"}},"required":["filename","url","start_time","end_time","session_id"],"title":"CallTranscription","type":"object"},"CallTranscriptionFailedEvent":{"description":"This event is sent when call transcription has failed","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"003"},"error":{"description":"The error message detailing why transcription failed.","title":"string","type":"string","x-stream-index":"004"},"type":{"default":"call.transcription_failed","description":"The type of event: \"call.transcription_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","egress_id"],"title":"CallTranscriptionFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallTranscriptionReadyEvent":{"description":"This event is sent when call transcription is ready","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"call_transcription":{"$ref":"#/components/schemas/CallTranscription","description":"The call transcription object","title":"CallTranscription","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.transcription_ready","description":"The type of event: \"call.transcription_ready\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call_transcription","egress_id"],"title":"CallTranscriptionReadyEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallTranscriptionStartedEvent":{"description":"This event is sent when call transcription has started","properties":{"call_cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"egress_id":{"type":"string","x-stream-index":"001"},"type":{"default":"call.transcription_started","description":"The type of event: \"call.transcription_started\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001"}},"required":["egress_id","type","created_at","call_cid"],"title":"CallTranscriptionStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallTranscriptionStoppedEvent":{"description":"This event is sent when call transcription has stopped","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"003"},"type":{"default":"call.transcription_stopped","description":"The type of event: \"call.transcription_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","egress_id"],"title":"CallTranscriptionStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallType":{"nullable":true,"properties":{"AppPK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"003"},"CreatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"005"},"ExternalStorage":{"type":"string","writeOnly":true,"x-stream-index":"009"},"Name":{"type":"string","writeOnly":true,"x-stream-index":"004"},"NotificationSettings":{"$ref":"#/components/schemas/NotificationSettings","x-stream-index":"008"},"PK":{"format":"int32","type":"integer","writeOnly":true,"x-stream-index":"002"},"Settings":{"$ref":"#/components/schemas/CallSettings","x-stream-index":"007"},"UpdatedAt":{"format":"date-time","type":"number","writeOnly":true,"x-stream-index":"006"}},"required":["PK","AppPK","Name","CreatedAt","UpdatedAt","ExternalStorage"],"type":"object"},"CallTypeResponse":{"description":"CallTypeResponse is the payload for a call type.","properties":{"created_at":{"description":"the time the call type was created","format":"date-time","title":"CreatedAt","type":"number","x-stream-index":"005"},"external_storage":{"description":"the external storage for the call type","title":"ExternalStorage","type":"string","x-stream-index":"007"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"the permissions granted to each role","title":"Grants","type":"object","x-stream-index":"002"},"name":{"description":"the name of the call type","title":"Name","type":"string","x-stream-index":"001"},"notification_settings":{"$ref":"#/components/schemas/NotificationSettings","description":"the notification settings for the call type","title":"NotificationSettings","x-stream-index":"004"},"settings":{"$ref":"#/components/schemas/CallSettingsResponse","description":"the settings for the call type","title":"Settings","x-stream-index":"003"},"updated_at":{"description":"the time the call type was last updated","format":"date-time","title":"UpdatedAt","type":"number","x-stream-index":"006"}},"required":["name","grants","settings","notification_settings","created_at","updated_at"],"title":"CallTypeResponse","type":"object"},"CallUpdatedEvent":{"description":"This event is sent when a call is updated, clients should use this update the local state of the call.\nThis event also contains the capabilities by role for the call, clients should update the own_capability for the current.","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"capabilities_by_role":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"The capabilities by role for this call","title":"CapabilitiesByRole","type":"object","x-stream-index":"004"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.updated","description":"The type of event: \"call.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","capabilities_by_role"],"title":"CallUpdatedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallUserFeedbackSubmittedEvent":{"description":"This event is sent when a user submits feedback for a call.","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"custom":{"additionalProperties":{},"description":"Custom data provided by the user","title":"Custom","type":"object","x-stream-index":"007"},"rating":{"description":"The rating given by the user (1-5)","format":"int32","title":"Rating","type":"integer","x-stream-index":"005"},"reason":{"description":"The reason provided by the user for the rating","title":"Reason","type":"string","x-stream-index":"006"},"sdk":{"type":"string","x-stream-index":"008"},"sdk_version":{"type":"string","x-stream-index":"009"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.user_feedback_submitted","description":"The type of event, \"call.user_feedback\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who submitted the feedback","title":"User","x-stream-index":"004"}},"required":["type","created_at","call_cid","session_id","user","rating"],"title":"CallUserFeedbackSubmittedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallUserMutedEvent":{"description":"This event is sent when a call member is muted","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"from_user_id":{"type":"string","x-stream-index":"003"},"muted_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"type":{"default":"call.user_muted","description":"The type of event: \"call.user_muted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","from_user_id","muted_user_ids"],"title":"CallUserMutedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallsPerDayReport":{"properties":{"count":{"format":"int64","type":"integer","x-stream-index":"001"}},"required":["count"],"type":"object"},"CallsPerDayReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateCallsPerDayReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"Channel":{"properties":{"active_live_locations":{"items":{"$ref":"#/components/schemas/SharedLocation"},"type":"array","x-stream-index":"034"},"auto_translation_enabled":{"type":"boolean","x-stream-index":"029"},"auto_translation_language":{"type":"string","x-stream-index":"030"},"cid":{"type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/ChannelConfig","x-stream-index":"026"},"config_overrides":{"$ref":"#/components/schemas/ConfigOverrides","x-stream-index":"027"},"cooldown":{"format":"int32","type":"integer","x-stream-index":"031"},"created_at":{"format":"date-time","type":"number","x-stream-index":"009"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"019"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"disabled":{"type":"boolean","x-stream-index":"017"},"frozen":{"type":"boolean","x-stream-index":"016"},"id":{"type":"string","x-stream-index":"004"},"invites":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"022"},"last_campaigns":{"type":"string","x-stream-index":"032"},"last_message_at":{"format":"date-time","type":"number","x-stream-index":"006"},"member_count":{"format":"int32","type":"integer","x-stream-index":"021"},"members":{"items":{"$ref":"#/components/schemas/ChannelMember"},"type":"array","x-stream-index":"020"},"message_count":{"format":"int64","type":"integer","x-stream-index":"035"},"message_count_updated_at":{"format":"date-time","type":"number","x-stream-index":"036"},"team":{"type":"string","x-stream-index":"028"},"truncated_by":{"$ref":"#/components/schemas/User","x-stream-index":"015"},"type":{"type":"string","x-stream-index":"005"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"010"}},"required":["cid","id","type","created_at","updated_at","frozen","disabled","custom","auto_translation_language"],"type":"object"},"ChannelConfig":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.027"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.022"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.023"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.028"},"blocklist":{"type":"string","x-stream-index":"001.024"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.025"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.026"},"commands":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"connect_events":{"type":"boolean","x-stream-index":"001.004"},"count_messages":{"type":"boolean","x-stream-index":"001.019"},"created_at":{"format":"date-time","type":"number","x-stream-index":"002.003"},"custom_events":{"type":"boolean","x-stream-index":"001.012"},"mark_messages_pending":{"type":"boolean","x-stream-index":"001.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"001.021"},"mutes":{"type":"boolean","x-stream-index":"001.009"},"name":{"type":"string","x-stream-index":"001.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"001.029"},"partition_ttl":{"type":"integer","x-stream-index":"001.030"},"polls":{"type":"boolean","x-stream-index":"001.016"},"push_notifications":{"type":"boolean","x-stream-index":"001.013"},"quotes":{"type":"boolean","x-stream-index":"001.008"},"reactions":{"type":"boolean","x-stream-index":"001.006"},"read_events":{"type":"boolean","x-stream-index":"001.003"},"reminders":{"type":"boolean","x-stream-index":"001.014"},"replies":{"type":"boolean","x-stream-index":"001.007"},"search":{"type":"boolean","x-stream-index":"001.005"},"shared_locations":{"type":"boolean","x-stream-index":"001.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.031"},"typing_events":{"type":"boolean","x-stream-index":"001.002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"002.004"},"uploads":{"type":"boolean","x-stream-index":"001.010"},"url_enrichment":{"type":"boolean","x-stream-index":"001.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"001.017"}},"required":["name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","count_messages","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","created_at","updated_at","commands"],"type":"object"},"ChannelConfigWithInfo":{"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.002.027"},"automod":{"enum":["disabled","simple","AI"],"type":"string","x-stream-index":"001.002.022"},"automod_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.023"},"automod_thresholds":{"$ref":"#/components/schemas/Thresholds","x-stream-index":"001.002.028"},"blocklist":{"type":"string","x-stream-index":"001.002.024"},"blocklist_behavior":{"enum":["flag","block","shadow_block"],"type":"string","x-stream-index":"001.002.025"},"blocklists":{"items":{"$ref":"#/components/schemas/BlockListOptions"},"type":"array","x-stream-index":"001.002.026"},"commands":{"items":{"$ref":"#/components/schemas/Command"},"type":"array","x-stream-index":"001.003"},"connect_events":{"type":"boolean","x-stream-index":"001.002.004"},"count_messages":{"type":"boolean","x-stream-index":"001.002.019"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.001.003"},"custom_events":{"type":"boolean","x-stream-index":"001.002.012"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"002"},"mark_messages_pending":{"type":"boolean","x-stream-index":"001.002.015"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"001.002.021"},"mutes":{"type":"boolean","x-stream-index":"001.002.009"},"name":{"type":"string","x-stream-index":"001.002.001"},"partition_size":{"format":"int32","type":"integer","x-stream-index":"001.002.029"},"partition_ttl":{"example":"24h","format":"duration","nullable":true,"type":"string","x-stream-index":"001.002.030"},"polls":{"type":"boolean","x-stream-index":"001.002.016"},"push_notifications":{"type":"boolean","x-stream-index":"001.002.013"},"quotes":{"type":"boolean","x-stream-index":"001.002.008"},"reactions":{"type":"boolean","x-stream-index":"001.002.006"},"read_events":{"type":"boolean","x-stream-index":"001.002.003"},"reminders":{"type":"boolean","x-stream-index":"001.002.014"},"replies":{"type":"boolean","x-stream-index":"001.002.007"},"search":{"type":"boolean","x-stream-index":"001.002.005"},"shared_locations":{"type":"boolean","x-stream-index":"001.002.018"},"skip_last_msg_update_for_system_msgs":{"type":"boolean","x-stream-index":"001.002.031"},"typing_events":{"type":"boolean","x-stream-index":"001.002.002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.001.004"},"uploads":{"type":"boolean","x-stream-index":"001.002.010"},"url_enrichment":{"type":"boolean","x-stream-index":"001.002.011"},"user_message_reminders":{"type":"boolean","x-stream-index":"001.002.017"}},"required":["created_at","updated_at","name","typing_events","read_events","connect_events","search","reactions","replies","quotes","mutes","uploads","url_enrichment","custom_events","push_notifications","reminders","mark_messages_pending","polls","user_message_reminders","shared_locations","count_messages","message_retention","max_message_length","automod","automod_behavior","skip_last_msg_update_for_system_msgs","commands"],"type":"object"},"ChannelMember":{"nullable":true,"properties":{"archived_at":{"format":"date-time","type":"number","x-stream-index":"015"},"ban_expires":{"description":"Expiration date of the ban","format":"date-time","title":"Ban expires","type":"number","x-stream-index":"013"},"banned":{"description":"Whether member is banned this channel or not","title":"Banned","type":"boolean","x-stream-index":"012"},"channel_role":{"description":"Role of the member in the channel","title":"Channel Role","type":"string","x-stream-index":"018"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"011"},"deleted_messages":{"items":{"type":"string"},"type":"array","x-stream-index":"020"},"invite_accepted_at":{"description":"Date when invite was accepted","format":"date-time","title":"Invited accepted at","type":"number","x-stream-index":"006"},"invite_rejected_at":{"description":"Date when invite was rejected","format":"date-time","title":"Invited rejected at","type":"number","x-stream-index":"007"},"invited":{"description":"Whether member was invited or not","title":"Invited","type":"boolean","x-stream-index":"005"},"is_moderator":{"description":"Whether member is channel moderator or not","title":"Is moderator","type":"boolean","x-stream-index":"003"},"notifications_muted":{"type":"boolean","x-stream-index":"019"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"016"},"role":{"description":"Permission level of the member in the channel (DEPRECATED: use channel_role instead)","enum":["member","moderator","admin","owner"],"title":"Role","type":"string","x-stream-index":"017"},"shadow_banned":{"description":"Whether member is shadow banned in this channel or not","title":"Shadow banned","type":"boolean","x-stream-index":"014"},"status":{"type":"string","x-stream-index":"008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"010"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"},"user_id":{"title":"User ID","type":"string","x-stream-index":"001"}},"required":["custom","created_at","updated_at","banned","shadow_banned","channel_role","notifications_muted"],"title":"Channel member","type":"object"},"ChannelMute":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","description":"Channel that is muted","title":"Channel","x-stream-index":"002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"004"},"expires":{"description":"Date/time of mute expiration","format":"date-time","title":"Expires","type":"number","x-stream-index":"003"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Owner of channel mute","title":"User","x-stream-index":"001"}},"required":["created_at","updated_at"],"type":"object"},"ChannelOwnCapability":{"description":"All possibility of string to use","enum":["ban-channel-members","cast-poll-vote","connect-events","create-attachment","delete-any-message","delete-channel","delete-own-message","flag-message","freeze-channel","join-channel","leave-channel","mute-channel","pin-message","query-poll-votes","quote-message","read-events","search-messages","send-custom-events","send-links","send-message","send-poll","send-reaction","send-reply","send-restricted-visibility-message","send-typing-events","set-channel-cooldown","share-location","skip-slow-mode","slow-mode","typing-events","update-any-message","update-channel","update-channel-members","update-own-message","update-thread","upload-file"],"title":"ChannelOwnCapability","type":"string"},"ChannelResponse":{"description":"Represents channel in chat","properties":{"auto_translation_enabled":{"description":"Whether auto translation is enabled or not","title":"Auto translation","type":"boolean","x-stream-index":"017"},"auto_translation_language":{"description":"Language to translate to when auto translation is active","title":"Auto translation language","type":"string","x-stream-index":"018"},"blocked":{"description":"Whether this channel is blocked by current user or not","title":"Blocked","type":"boolean","x-stream-index":"023"},"cid":{"description":"Channel CID (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"003"},"config":{"$ref":"#/components/schemas/ChannelConfigWithInfo","description":"Channel configuration","title":"ChannelConfigWithInfo","x-stream-index":"013"},"cooldown":{"description":"Cooldown period after sending each message","format":"int32","title":"Cooldown","type":"integer","x-stream-index":"020"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"005"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"Creator of the channel","title":"UserResponse","x-stream-index":"008"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"026"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"007"},"disabled":{"type":"boolean","x-stream-index":"010"},"frozen":{"description":"Whether channel is frozen or not","title":"Frozen","type":"boolean","x-stream-index":"009"},"hidden":{"description":"Whether this channel is hidden by current user or not","title":"Hidden","type":"boolean","x-stream-index":"022"},"hide_messages_before":{"description":"Date since when the message history is accessible","format":"date-time","title":"Hide messages before","type":"number","x-stream-index":"019"},"id":{"description":"Channel unique ID","title":"ID","type":"string","x-stream-index":"001"},"last_message_at":{"description":"Date of the last message sent","format":"date-time","title":"Last message at","type":"number","x-stream-index":"004"},"member_count":{"description":"Number of members in the channel","format":"int32","title":"Member count","type":"integer","x-stream-index":"012"},"members":{"description":"List of channel members (max 100)","items":{"$ref":"#/components/schemas/ChannelMember"},"title":"ChannelMembers","type":"array","x-stream-index":"011"},"message_count":{"description":"Number of messages in the channel","format":"int64","title":"Message count","type":"integer","x-stream-index":"027"},"mute_expires_at":{"description":"Date of mute expiration","format":"date-time","title":"Mute expires at","type":"number","x-stream-index":"015"},"muted":{"description":"Whether this channel is muted or not","title":"Muted","type":"boolean","x-stream-index":"014"},"own_capabilities":{"description":"List of channel capabilities of authenticated user","items":{"$ref":"#/components/schemas/ChannelOwnCapability"},"title":"ChannelOwnCapability","type":"array","x-stream-index":"021"},"team":{"description":"Team the channel belongs to (multi-tenant only)","title":"Team","type":"string","x-stream-index":"016"},"truncated_at":{"description":"Date of the latest truncation of the channel","format":"date-time","title":"UserResponse","type":"number","x-stream-index":"024"},"truncated_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"025"},"type":{"description":"Type of the channel","title":"Type","type":"string","x-stream-docs-page-id":"channel_features","x-stream-index":"002"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"006"}},"required":["id","type","cid","created_at","updated_at","frozen","disabled","custom"],"title":"Channel","type":"object"},"ChatActivityStatsResponse":{"properties":{"Messages":{"$ref":"#/components/schemas/MessageStatsResponse","x-stream-index":"001"}},"type":"object"},"CheckExternalStorageResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"file_url":{"type":"string","x-stream-index":"002"}},"required":["duration","file_url"],"title":"Response","type":"object"},"CheckPushRequest":{"description":"Check push request","nullable":true,"properties":{"apn_template":{"description":"Push message template for APN","title":"APN template","type":"string","x-stream-docs-page-id":"push_template","x-stream-index":"002"},"event_type":{"description":"Type of event for push templates (default: message.new)","enum":["message.new","message.updated","reaction.new","reaction.updated","notification.reminder_due"],"title":"Event type","type":"string","x-stream-index":"008"},"firebase_data_template":{"description":"Push message data template for Firebase","title":"Firebase data template","type":"string","x-stream-docs-page-id":"push_template","x-stream-index":"004"},"firebase_template":{"description":"Push message template for Firebase","title":"Firebase template","type":"string","x-stream-docs-page-id":"push_template","x-stream-index":"003"},"message_id":{"description":"Message ID to send push notification for","title":"Message ID","type":"string","x-stream-index":"001"},"push_provider_name":{"description":"Name of push provider","title":"Name of push provider","type":"string","x-stream-index":"007"},"push_provider_type":{"description":"Push provider type","enum":["firebase","apn","huawei","xiaomi"],"title":"Type of push provider","type":"string","x-stream-index":"006"},"skip_devices":{"description":"Don't require existing devices to render templates","title":"Skip devices","type":"boolean","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"009.002"},"user_id":{"type":"string","x-stream-index":"009.001"}},"title":"CheckPushRequest","type":"object"},"CheckPushResponse":{"nullable":true,"properties":{"device_errors":{"additionalProperties":{"$ref":"#/components/schemas/DeviceErrorInfo"},"description":"Object with device errors","title":"Device errors","type":"object","x-stream-index":"001","x-stream-map":{"key":"device_id"}},"duration":{"type":"string","x-stream-index":"008.001"},"event_type":{"description":"The event type that was tested","title":"Event type","type":"string","x-stream-index":"004"},"general_errors":{"description":"List of general errors","items":{"type":"string"},"title":"General errors","type":"array","x-stream-index":"002"},"rendered_apn_template":{"title":"Rendered APN template","type":"string","x-stream-index":"005"},"rendered_firebase_template":{"title":"Rendered Firebase template","type":"string","x-stream-index":"006"},"rendered_message":{"additionalProperties":{"type":"string"},"title":"Rendered message","type":"object","x-stream-index":"007"},"skip_devices":{"description":"Don't require existing devices to render templates","title":"Skip devices","type":"boolean","x-stream-index":"003"}},"required":["duration"],"type":"object"},"CheckSNSRequest":{"nullable":true,"properties":{"sns_key":{"description":"AWS SNS access key","title":"SNS key","type":"string","x-stream-index":"002"},"sns_secret":{"description":"AWS SNS key secret","title":"SNS secret","type":"string","x-stream-index":"003"},"sns_topic_arn":{"description":"AWS SNS topic ARN","title":"SNS Topic ARN","type":"string","x-stream-index":"001"}},"type":"object"},"CheckSNSResponse":{"nullable":true,"properties":{"data":{"additionalProperties":{},"description":"Error data","title":"ReadOnlyData","type":"object","x-stream-index":"003"},"duration":{"type":"string","x-stream-index":"004.001"},"error":{"description":"Error text","title":"Error","type":"string","x-stream-index":"002"},"status":{"description":"Validation result","enum":["ok","error"],"title":"Status","type":"string","x-stream-index":"001"}},"required":["status","duration"],"type":"object"},"CheckSQSRequest":{"nullable":true,"properties":{"sqs_key":{"description":"AWS SQS access key","title":"SQS key","type":"string","x-stream-index":"002"},"sqs_secret":{"description":"AWS SQS key secret","title":"SQS secret","type":"string","x-stream-index":"003"},"sqs_url":{"description":"AWS SQS endpoint URL","title":"SQS URL","type":"string","x-stream-index":"001"}},"type":"object"},"CheckSQSResponse":{"nullable":true,"properties":{"data":{"additionalProperties":{},"description":"Error data","title":"ReadOnlyData","type":"object","x-stream-index":"003"},"duration":{"type":"string","x-stream-index":"004.001"},"error":{"description":"Error text","title":"Error","type":"string","x-stream-index":"002"},"status":{"description":"Validation result","enum":["ok","error"],"title":"Status","type":"string","x-stream-index":"001"}},"required":["status","duration"],"type":"object"},"ClientOSDataResponse":{"properties":{"architecture":{"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"version":{"type":"string","x-stream-index":"002"}},"type":"object"},"ClosedCaptionEvent":{"description":"This event is sent when closed captions are being sent in a call, clients should use this to show the closed captions in the call screen","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"closed_caption":{"$ref":"#/components/schemas/CallClosedCaption","description":"The closed caption object","title":"CallClosedCaption","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.closed_caption","description":"The type of event: \"call.closed_caption\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","closed_caption"],"title":"ClosedCaptionEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CollectUserFeedbackRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"009"},"rating":{"format":"int32","maximum":5,"minimum":1,"type":"integer","x-stream-index":"007"},"reason":{"maxLength":1000,"type":"string","x-stream-index":"008"},"sdk":{"maxLength":50,"type":"string","x-stream-index":"005"},"sdk_version":{"maxLength":50,"type":"string","x-stream-index":"006"},"user_session_id":{"maxLength":50,"type":"string","x-stream-index":"004"}},"required":["sdk","sdk_version","rating"],"type":"object"},"CollectUserFeedbackResponse":{"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"},"Command":{"description":"Represents custom chat command","nullable":true,"properties":{"args":{"description":"Arguments help text, shown in commands auto-completion","title":"Arguments","type":"string","x-stream-index":"006"},"created_at":{"description":"Date/time of creation","format":"date-time","readOnly":true,"title":"Created at","type":"number","x-stream-index":"001"},"description":{"description":"Description, shown in commands auto-completion","title":"Description","type":"string","x-stream-index":"005"},"name":{"description":"Unique command name","title":"Name","type":"string","x-stream-index":"004"},"set":{"description":"Set name used for grouping commands","title":"Set","type":"string","x-stream-index":"007"},"updated_at":{"description":"Date/time of the last update","format":"date-time","readOnly":true,"title":"Updated at","type":"number","x-stream-index":"002"}},"required":["name","description","args","set"],"title":"Command","type":"object"},"ConfigOverrides":{"properties":{"blocklist":{"type":"string","x-stream-index":"008"},"blocklist_behavior":{"enum":["flag","block"],"type":"string","x-stream-index":"009"},"commands":{"items":{"type":"string"},"type":"array","x-stream-index":"011"},"count_messages":{"type":"boolean","x-stream-index":"014"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"010"},"max_message_length":{"format":"int32","maximum":20000,"type":"integer","x-stream-index":"007"},"quotes":{"type":"boolean","x-stream-index":"004"},"reactions":{"type":"boolean","x-stream-index":"002"},"replies":{"type":"boolean","x-stream-index":"003"},"shared_locations":{"type":"boolean","x-stream-index":"013"},"typing_events":{"type":"boolean","x-stream-index":"001"},"uploads":{"type":"boolean","x-stream-index":"005"},"url_enrichment":{"type":"boolean","x-stream-index":"006"},"user_message_reminders":{"type":"boolean","x-stream-index":"012"}},"required":["grants","commands"],"type":"object"},"CountByMinuteResponse":{"nullable":true,"properties":{"count":{"format":"int32","type":"integer","x-stream-index":"002"},"start_ts":{"format":"date-time","type":"number","x-stream-index":"001"}},"required":["start_ts","count"],"type":"object"},"CreateBlockListRequest":{"description":"Block list contains restricted words","nullable":true,"properties":{"name":{"description":"Block list name","maxLength":255,"title":"Name","type":"string","x-stream-index":"001"},"team":{"type":"string","x-stream-index":"004"},"type":{"description":"Block list type.","enum":["regex","domain","domain_allowlist","email","word"],"title":"Type","type":"string","x-stream-index":"003"},"words":{"description":"List of words to block","items":{"type":"string"},"minimum":1,"title":"Words","type":"array","x-stream-index":"002"}},"required":["name","words"],"title":"Block list","type":"object","x-stream-docs-page-id":"block_lists"},"CreateBlockListResponse":{"description":"Basic response information","nullable":true,"properties":{"blocklist":{"$ref":"#/components/schemas/BlockListResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["duration"],"title":"Response","type":"object"},"CreateCallTypeRequest":{"description":"Request for creating a call type","nullable":true,"properties":{"external_storage":{"description":"the external storage for the call type","title":"ExternalStorage","type":"string","x-stream-index":"002.004"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"the permissions granted to each role","title":"Grants","type":"object","x-stream-index":"002.001"},"name":{"type":"string","x-stream-index":"001"},"notification_settings":{"$ref":"#/components/schemas/NotificationSettings","description":"the notification settings for the call type","title":"NotificationSettings","x-stream-index":"002.002"},"settings":{"$ref":"#/components/schemas/CallSettingsRequest","description":"the settings for the call type","title":"Settings","x-stream-index":"002.003"}},"required":["name"],"title":"CreateCallTypeRequest","type":"object"},"CreateCallTypeResponse":{"description":"Response for creating a call type","nullable":true,"properties":{"created_at":{"description":"the time the call type was created","format":"date-time","title":"CreatedAt","type":"number","x-stream-index":"001.005"},"duration":{"type":"string","x-stream-index":"002.001"},"external_storage":{"description":"the external storage for the call type","title":"ExternalStorage","type":"string","x-stream-index":"001.007"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"the permissions granted to each role","title":"Grants","type":"object","x-stream-index":"001.002"},"name":{"description":"the name of the call type","title":"Name","type":"string","x-stream-index":"001.001"},"notification_settings":{"$ref":"#/components/schemas/NotificationSettings","description":"the notification settings for the call type","title":"NotificationSettings","x-stream-index":"001.004"},"settings":{"$ref":"#/components/schemas/CallSettingsResponse","description":"the settings for the call type","title":"Settings","x-stream-index":"001.003"},"updated_at":{"description":"the time the call type was last updated","format":"date-time","title":"UpdatedAt","type":"number","x-stream-index":"001.006"}},"required":["name","grants","settings","notification_settings","created_at","updated_at","duration"],"title":"CreateCallTypeResponse","type":"object"},"CreateDeviceRequest":{"description":"Create device request","nullable":true,"properties":{"id":{"description":"Device ID","maxLength":255,"minLength":1,"title":"ID","type":"string","x-stream-index":"001"},"push_provider":{"description":"Push provider","enum":["firebase","apn","huawei","xiaomi"],"title":"PushProvider","type":"string","x-stream-index":"002"},"push_provider_name":{"description":"Push provider name","title":"PushProviderName","type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"005.002"},"user_id":{"description":"**Server-side only**. User ID which server acts upon","title":"User ID","type":"string","x-stream-index":"005.001"},"voip_token":{"description":"When true the token is for Apple VoIP push notifications","title":"VoipToken","type":"boolean","x-stream-index":"004"}},"required":["id","push_provider"],"title":"CreateDeviceRequest","type":"object"},"CreateExternalStorageRequest":{"description":"Create external storage","nullable":true,"properties":{"aws_s3":{"$ref":"#/components/schemas/S3Request","description":"Only required if you want to create an Amazon S3 storage","title":"AwsS3","x-stream-index":"003.004"},"azure_blob":{"$ref":"#/components/schemas/AzureRequest","description":"Only required if you want to create an Azure Blob Storage","title":"AzureBlob","x-stream-index":"003.006"},"bucket":{"description":"The name of the bucket on the service provider","title":"Bucket","type":"string","x-stream-index":"003.002"},"gcs_credentials":{"type":"string","x-stream-index":"003.005"},"name":{"description":"The name of the provider, this must be unique","title":"Name","type":"string","x-stream-index":"001"},"path":{"description":"The path prefix to use for storing files","title":"Path","type":"string","x-stream-index":"003.003"},"storage_type":{"description":"The type of storage to use","enum":["s3","gcs","abs"],"title":"StorageType","type":"string","x-stream-index":"003.001"}},"required":["name","storage_type","bucket"],"title":"CreateExternalStorageRequest","type":"object"},"CreateExternalStorageResponse":{"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"},"CreateGuestRequest":{"nullable":true,"properties":{"user":{"$ref":"#/components/schemas/UserRequest","description":"User object which server acts upon","title":"User","x-stream-index":"001"}},"required":["user"],"type":"object"},"CreateGuestResponse":{"nullable":true,"properties":{"access_token":{"description":"the access token to authenticate the user","title":"Access token","type":"string","x-stream-index":"002"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User object which server acts upon","title":"User","x-stream-index":"001"}},"required":["user","access_token","duration"],"type":"object"},"CreateImportRequest":{"nullable":true,"properties":{"mode":{"enum":["insert","upsert"],"type":"string","x-stream-index":"002"},"path":{"type":"string","x-stream-index":"001"}},"required":["path","mode"],"type":"object"},"CreateImportResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"import_task":{"$ref":"#/components/schemas/ImportTask","x-stream-index":"001"}},"required":["duration"],"title":"Response","type":"object"},"CreateImportURLRequest":{"nullable":true,"properties":{"filename":{"type":"string","x-stream-index":"001"}},"type":"object"},"CreateImportURLResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"path":{"type":"string","x-stream-index":"001"},"upload_url":{"type":"string","x-stream-index":"002"}},"required":["path","upload_url","duration"],"title":"Response","type":"object"},"CreatePollOptionRequest":{"nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"003"},"text":{"description":"Option text","title":"string","type":"string","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"004.002"},"user_id":{"type":"string","x-stream-index":"004.001"}},"required":["text"],"type":"object"},"CreatePollRequest":{"description":"Contains all information needed to create a new poll","nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"011"},"allow_answers":{"description":"Indicates whether users can suggest user defined answers","title":"Allow answers","type":"boolean","x-stream-index":"009"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"008"},"description":{"description":"A description of the poll","title":"Description","type":"string","x-stream-index":"003"},"enforce_unique_vote":{"description":"Indicates whether users can cast multiple votes","title":"Multiple choice","type":"boolean","x-stream-index":"006"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"is_closed":{"description":"Indicates whether the poll is open for voting","title":"Is closed","type":"boolean","x-stream-index":"010"},"max_votes_allowed":{"description":"Indicates the maximum amount of votes a user can cast","format":"int32","maximum":10,"title":"Maximum votes allowed","type":"integer","x-stream-index":"007"},"name":{"description":"The name of the poll","title":"Name","type":"string","x-stream-index":"002"},"options":{"items":{"$ref":"#/components/schemas/PollOptionInput"},"maximum":100,"type":"array","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"012.002"},"user_id":{"type":"string","x-stream-index":"012.001"},"voting_visibility":{"enum":["anonymous","public"],"type":"string","x-stream-index":"005"}},"required":["name"],"title":"Create Poll Request","type":"object"},"CreateRoleRequest":{"nullable":true,"properties":{"name":{"description":"Role name","maxLength":64,"title":"Name","type":"string","x-stream-index":"001"}},"required":["name"],"type":"object"},"CreateRoleResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"role":{"$ref":"#/components/schemas/Role","x-stream-index":"002"}},"required":["duration","role"],"title":"Response","type":"object"},"CustomVideoEvent":{"description":"A custom event, this event is used to send custom events to other participants in the call.","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"003"},"type":{"default":"custom","description":"The type of event, \"custom\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"004"}},"required":["type","created_at","call_cid","custom","user"],"title":"CustomVideoEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"DailyAggregateCallDurationReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/CallDurationReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateCallParticipantCountReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/CallParticipantCountReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateCallsPerDayReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/CallsPerDayReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateQualityScoreReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/QualityScoreReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateSDKUsageReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/SDKUsageReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateUserFeedbackReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/UserFeedbackReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DataDogInfo":{"properties":{"api_key":{"type":"string","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"003"},"site":{"type":"string","x-stream-index":"002"}},"type":"object"},"DeactivateUserRequest":{"nullable":true,"properties":{"created_by_id":{"description":"ID of the user who deactivated the user","title":"Created by ID","type":"string","x-stream-index":"003"},"mark_messages_deleted":{"description":"Makes messages appear to be deleted","title":"Mark messages deleted","type":"boolean","x-stream-index":"002"}},"type":"object"},"DeactivateUserResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Deactivated user object","title":"User","x-stream-index":"001"}},"required":["duration"],"type":"object"},"DeactivateUsersRequest":{"description":"Deactivate users request","nullable":true,"properties":{"created_by_id":{"description":"ID of the user who deactivated the users","title":"Created by ID","type":"string","x-stream-index":"003"},"mark_channels_deleted":{"type":"boolean","x-stream-index":"004"},"mark_messages_deleted":{"description":"Makes messages appear to be deleted","title":"Mark messages deleted","type":"boolean","x-stream-index":"002"},"user_ids":{"description":"User IDs to deactivate","items":{"type":"string"},"maximum":100,"minimum":1,"title":"User IDs","type":"array","x-stream-index":"001"}},"required":["user_ids"],"title":"DeactivateUsersRequest","type":"object"},"DeactivateUsersResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"task_id":{"type":"string","x-stream-index":"001"}},"required":["task_id","duration"],"title":"Response","type":"object"},"DeleteCallRequest":{"description":"DeleteCallRequest is the payload for deleting a call.","nullable":true,"properties":{"hard":{"description":"if true the call will be hard deleted along with all related data","title":"Hard","type":"boolean","x-stream-index":"001"}},"title":"DeleteCallRequest","type":"object"},"DeleteCallResponse":{"description":"DeleteCallResponse is the payload for deleting a call.","nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","title":"Call","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"task_id":{"title":"TaskID","type":"string","x-stream-index":"002"}},"required":["call","duration"],"title":"DeleteCallResponse","type":"object"},"DeleteExternalStorageResponse":{"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"},"DeleteRecordingResponse":{"description":"Response for DeleteRecording","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"DeleteRecordingResponse","type":"object"},"DeleteTranscriptionResponse":{"description":"DeleteTranscriptionResponse is the payload for deleting a transcription.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"DeleteTranscriptionResponse","type":"object"},"DeleteUsersRequest":{"nullable":true,"properties":{"calls":{"description":"Calls delete mode.\nAffected calls are those that include exactly two members, one of whom is the user being deleted.\n\n* null or empty string - doesn't delete any calls\n* soft - marks user's calls and their related data as deleted (soft-delete)\n* hard - deletes user's calls and their data completely (hard-delete)\n","enum":["soft","hard"],"title":"Delete User's calls","type":"string","x-stream-index":"001.002.004"},"conversations":{"description":"Conversation channels delete mode.\nConversation channel is any channel which only has two members one of which is the user being deleted.\n\n* null or empty string - doesn't delete any conversation channels\n* soft - marks all conversation channels as deleted (same effect as Delete Channels with 'hard' option disabled)\n* hard - deletes channel and all its data completely including messages (same effect as Delete Channels with 'hard' option enabled)\n","enum":["soft","hard"],"title":"Delete Conversations","type":"string","x-stream-index":"001.002.003"},"files":{"description":"Delete user files.\n* false or empty string - doesn't delete any files\n* true - deletes all files uploaded by the user, including images and attachments.\n","title":"Delete User's files","type":"boolean","x-stream-index":"001.002.005"},"messages":{"description":"Message delete mode.\n\n* null or empty string - doesn't delete user messages\n* soft - marks all user messages as deleted without removing any related message data\n* pruning - marks all user messages as deleted, nullifies message information and removes some message data such as reactions and flags\n* hard - deletes messages completely with all related information\n","enum":["soft","pruning","hard"],"title":"Delete Messages","type":"string","x-stream-index":"001.002.002"},"new_call_owner_id":{"type":"string","x-stream-index":"001.002.007"},"new_channel_owner_id":{"type":"string","x-stream-index":"001.002.006"},"user":{"description":"User delete mode.\n\n* soft - marks user as deleted and retains all user data\n* pruning - marks user as deleted and nullifies user information\n* hard - deletes user completely. Requires 'hard' option for messages and conversations as well\n","enum":["soft","pruning","hard"],"title":"Delete User","type":"string","x-stream-index":"001.002.001"},"user_ids":{"description":"IDs of users to delete","items":{"type":"string"},"maximum":100,"minimum":1,"title":"User IDs","type":"array","x-stream-index":"001.001"}},"required":["user_ids"],"type":"object"},"DeleteUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"task_id":{"description":"ID of the task to delete users","title":"Task ID","type":"string","x-stream-index":"001"}},"required":["task_id","duration"],"type":"object"},"DeviceDataResponse":{"properties":{"name":{"type":"string","x-stream-index":"001"},"version":{"type":"string","x-stream-index":"002"}},"type":"object"},"DeviceErrorInfo":{"properties":{"error_message":{"type":"string","x-stream-index":"003"},"provider":{"type":"string","x-stream-index":"001"},"provider_name":{"type":"string","x-stream-index":"002"}},"required":["provider","provider_name","error_message"],"type":"object"},"DeviceResponse":{"description":"Response for Device","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"004"},"disabled":{"description":"Whether device is disabled or not","title":"Disabled","type":"boolean","x-stream-index":"005"},"disabled_reason":{"description":"Reason explaining why device had been disabled","title":"Reason","type":"string","x-stream-index":"006"},"id":{"description":"Device ID","title":"ID","type":"string","x-stream-index":"003"},"push_provider":{"description":"Push provider","title":"PushProvider","type":"string","x-stream-index":"001"},"push_provider_name":{"description":"Push provider name","title":"PushProviderName","type":"string","x-stream-index":"002"},"user_id":{"description":"User ID","title":"UserID","type":"string","x-stream-index":"008"},"voip":{"description":"When true the token is for Apple VoIP push notifications","title":"Voip","type":"boolean","x-stream-index":"007"}},"required":["push_provider","id","created_at","user_id"],"title":"DeviceResponse","type":"object"},"DraftPayloadResponse":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"004"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"007"},"html":{"type":"string","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"001"},"mentioned_users":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","x-stream-index":"008"},"mml":{"type":"string","x-stream-index":"003"},"parent_id":{"type":"string","x-stream-index":"005"},"poll_id":{"type":"string","x-stream-index":"013"},"quoted_message_id":{"type":"string","x-stream-index":"009"},"show_in_channel":{"type":"boolean","x-stream-index":"006"},"silent":{"type":"boolean","x-stream-index":"012"},"text":{"type":"string","x-stream-index":"002"},"type":{"type":"string","x-stream-index":"011"}},"required":["id","text","custom"],"type":"object"},"DraftResponse":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003"},"channel_cid":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"message":{"$ref":"#/components/schemas/DraftPayloadResponse","x-stream-index":"001"},"parent_id":{"type":"string","x-stream-index":"004"},"parent_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"005"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"006"}},"required":["message","channel_cid","created_at"],"type":"object"},"EdgeResponse":{"properties":{"continent_code":{"type":"string","x-stream-index":"007.003"},"country_iso_code":{"type":"string","x-stream-index":"007.002"},"green":{"format":"int32","type":"integer","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"latency_test_url":{"type":"string","x-stream-index":"002"},"latitude":{"format":"float","type":"number","x-stream-index":"006.001"},"longitude":{"format":"float","type":"number","x-stream-index":"006.002"},"red":{"format":"int32","type":"integer","x-stream-index":"005"},"subdivision_iso_code":{"type":"string","x-stream-index":"007.001"},"yellow":{"format":"int32","type":"integer","x-stream-index":"004"}},"required":["id","latency_test_url","green","yellow","red","latitude","longitude","subdivision_iso_code","country_iso_code","continent_code"],"type":"object"},"EgressHLSResponse":{"properties":{"playlist_url":{"type":"string","x-stream-index":"001"},"status":{"type":"string","x-stream-index":"002"}},"required":["playlist_url","status"],"type":"object"},"EgressRTMPResponse":{"properties":{"name":{"type":"string","x-stream-index":"001"},"started_at":{"format":"date-time","type":"number","x-stream-index":"004"},"stream_key":{"type":"string","x-stream-index":"003"},"stream_url":{"type":"string","x-stream-index":"002"}},"required":["name","started_at"],"type":"object"},"EgressResponse":{"properties":{"broadcasting":{"type":"boolean","x-stream-index":"001"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordingResponse","x-stream-index":"004"},"hls":{"$ref":"#/components/schemas/EgressHLSResponse","x-stream-index":"002"},"rtmps":{"items":{"$ref":"#/components/schemas/EgressRTMPResponse"},"type":"array","x-stream-index":"003"}},"required":["broadcasting","rtmps"],"type":"object"},"EndCallRequest":{"description":"Request for ending a call","nullable":true,"title":"EndCallRequest","type":"object"},"EndCallResponse":{"description":"Response for ending a call","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"EndCallResponse","type":"object"},"ErrorResult":{"properties":{"stacktrace":{"type":"string","x-stream-index":"003"},"type":{"type":"string","x-stream-index":"001"},"version":{"type":"string","x-stream-index":"004"}},"required":["type","description"],"type":"object"},"EventHook":{"nullable":true,"properties":{"callback":{"$ref":"#/components/schemas/AsyncModerationCallbackConfig","x-stream-index":"019.001.002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"020"},"enabled":{"type":"boolean","x-stream-index":"003"},"event_types":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"hook_type":{"type":"string","x-stream-index":"002"},"id":{"type":"string","x-stream-index":"001"},"product":{"type":"string","x-stream-index":"018"},"sns_auth_type":{"type":"string","x-stream-index":"014"},"sns_key":{"type":"string","x-stream-index":"015"},"sns_region":{"type":"string","x-stream-index":"013"},"sns_role_arn":{"type":"string","x-stream-index":"017"},"sns_secret":{"type":"string","x-stream-index":"016"},"sns_topic_arn":{"type":"string","x-stream-index":"012"},"sqs_auth_type":{"type":"string","x-stream-index":"008"},"sqs_key":{"type":"string","x-stream-index":"009"},"sqs_queue_url":{"type":"string","x-stream-index":"006"},"sqs_region":{"type":"string","x-stream-index":"007"},"sqs_role_arn":{"type":"string","x-stream-index":"011"},"sqs_secret":{"type":"string","x-stream-index":"010"},"timeout_ms":{"format":"int32","type":"integer","x-stream-index":"019.001.001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"021"},"webhook_url":{"type":"string","x-stream-index":"005"}},"type":"object"},"EventNotificationSettings":{"properties":{"apns":{"$ref":"#/components/schemas/APNS","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"fcm":{"$ref":"#/components/schemas/FCM","x-stream-index":"003"}},"required":["enabled","apns","fcm"],"type":"object"},"ExportUserResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"004.001"},"messages":{"description":"List of exported messages","items":{"$ref":"#/components/schemas/MessageResponse"},"title":"Messages","type":"array","x-stream-index":"002"},"reactions":{"description":"List of exported reactions","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Reactions","type":"array","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Exported user object","title":"User","x-stream-index":"001"}},"required":["duration"],"type":"object"},"ExportUsersRequest":{"nullable":true,"properties":{"user_ids":{"items":{"type":"string"},"maximum":25,"minimum":1,"type":"array","x-stream-index":"001"}},"required":["user_ids"],"type":"object"},"ExportUsersResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"task_id":{"type":"string","x-stream-index":"001"}},"required":["task_id","duration"],"title":"Response","type":"object"},"ExternalStorageResponse":{"properties":{"bucket":{"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"path":{"type":"string","x-stream-index":"004"},"type":{"enum":["s3","gcs","abs"],"type":"string","x-stream-index":"002"}},"required":["name","type","bucket","path"],"type":"object"},"FCM":{"properties":{"data":{"additionalProperties":{},"type":"object","x-stream-index":"001"}},"type":"object"},"Field":{"nullable":true,"properties":{"short":{"type":"boolean","x-stream-index":"003"},"title":{"type":"string","x-stream-index":"001"},"value":{"type":"string","x-stream-index":"002"}},"required":["title","value","short"],"type":"object"},"FileUploadConfig":{"properties":{"allowed_file_extensions":{"items":{"type":"string"},"type":"array","x-stream-index":"001"},"allowed_mime_types":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"blocked_file_extensions":{"items":{"type":"string"},"type":"array","x-stream-index":"002"},"blocked_mime_types":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"size_limit":{"format":"int32","maximum":104857600,"minimum":0,"type":"integer","x-stream-index":"005"}},"required":["size_limit"],"type":"object"},"FileUploadRequest":{"nullable":true,"properties":{"file":{"description":"file field","title":"File","type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/OnlyUserID","description":"user for the request **server side only**","title":"User","x-stream-index":"002"}},"type":"object"},"FileUploadResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"file":{"description":"URL to the uploaded asset. Should be used to put to `asset_url` attachment field","title":"File","type":"string","x-stream-index":"001"},"thumb_url":{"description":"URL of the file thumbnail for supported file formats. Should be put to `thumb_url` attachment field","title":"Thumbnail URL","type":"string","x-stream-index":"002"}},"required":["duration"],"type":"object"},"FirebaseConfig":{"properties":{"Disabled":{"type":"boolean","writeOnly":true,"x-stream-index":"001"},"apn_template":{"type":"string","x-stream-index":"005"},"credentials_json":{"type":"string","x-stream-index":"006"},"data_template":{"type":"string","x-stream-index":"004"},"notification_template":{"type":"string","x-stream-index":"003"},"server_key":{"type":"string","x-stream-index":"002"}},"type":"object"},"FirebaseConfigFields":{"properties":{"apn_template":{"type":"string","x-stream-index":"004"},"credentials_json":{"type":"string","x-stream-index":"006"},"data_template":{"type":"string","x-stream-index":"003"},"enabled":{"type":"boolean","x-stream-index":"001"},"notification_template":{"type":"string","x-stream-index":"002"},"server_key":{"type":"string","x-stream-index":"005"}},"required":["enabled"],"type":"object"},"FrameRecordSettings":{"properties":{"capture_interval_in_seconds":{"format":"int32","maximum":60,"minimum":2,"type":"integer","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"},"quality":{"type":"string","x-stream-index":"002"}},"required":["mode","capture_interval_in_seconds"],"type":"object"},"FrameRecordingResponse":{"properties":{"status":{"type":"string","x-stream-index":"001"}},"required":["status"],"type":"object"},"FrameRecordingSettingsRequest":{"properties":{"capture_interval_in_seconds":{"format":"int32","maximum":60,"minimum":2,"type":"integer","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"},"quality":{"enum":["360p","480p","720p","1080p","1440p"],"type":"string","x-stream-index":"002"}},"required":["mode","capture_interval_in_seconds"],"type":"object"},"FrameRecordingSettingsResponse":{"properties":{"capture_interval_in_seconds":{"format":"int32","maximum":60,"minimum":2,"type":"integer","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"},"quality":{"type":"string","x-stream-index":"002"}},"required":["mode","capture_interval_in_seconds"],"type":"object"},"FullUserResponse":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"015"},"banned":{"type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"014"},"channel_mutes":{"items":{"$ref":"#/components/schemas/ChannelMute"},"type":"array","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.011"},"devices":{"items":{"$ref":"#/components/schemas/DeviceResponse"},"type":"array","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001.001"},"image":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"005"},"language":{"type":"string","x-stream-index":"001.005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"001.014"},"latest_hidden_channels":{"items":{"type":"string"},"type":"array","x-stream-index":"012"},"mutes":{"items":{"$ref":"#/components/schemas/UserMuteResponse"},"type":"array","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"001.002"},"online":{"type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"003"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.015"},"role":{"type":"string","x-stream-index":"001.006"},"shadow_banned":{"type":"boolean","x-stream-index":"013"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"total_unread_count":{"format":"int32","type":"integer","x-stream-index":"009"},"unread_channels":{"format":"int32","type":"integer","x-stream-index":"010"},"unread_count":{"format":"int32","type":"integer","x-stream-index":"008"},"unread_threads":{"format":"int32","type":"integer","x-stream-index":"011"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","devices","invisible","mutes","channel_mutes","unread_count","total_unread_count","unread_channels","unread_threads","shadow_banned","blocked_user_ids"],"type":"object"},"GeofenceResponse":{"nullable":true,"properties":{"country_codes":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"description":{"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"type":{"type":"string","x-stream-index":"002"}},"required":["name"],"type":"object"},"GeofenceSettings":{"properties":{"names":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"required":["names"],"type":"object"},"GeofenceSettingsRequest":{"properties":{"names":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"type":"object"},"GeofenceSettingsResponse":{"properties":{"names":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"required":["names"],"type":"object"},"GetActiveCallsStatusResponse":{"description":"Response containing active calls status information","nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"},"end_time":{"description":"End time of the status period","format":"date-time","title":"time.Time","type":"number","x-stream-index":"003"},"metrics":{"$ref":"#/components/schemas/ActiveCallsMetrics","description":"Detailed metrics","title":"*ActiveCallsMetrics","x-stream-index":"005"},"start_time":{"description":"Start time of the status period","format":"date-time","title":"time.Time","type":"number","x-stream-index":"002"},"summary":{"$ref":"#/components/schemas/ActiveCallsSummary","description":"Summary of active calls","title":"*ActiveCallsSummary","x-stream-index":"004"}},"required":["duration","start_time","end_time"],"title":"GetActiveCallsStatusResponse","type":"object"},"GetApplicationResponse":{"description":"Basic response information","nullable":true,"properties":{"app":{"$ref":"#/components/schemas/AppResponseFields","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["app","duration"],"title":"Response","type":"object"},"GetBlockListResponse":{"description":"Response for get block list","nullable":true,"properties":{"blocklist":{"$ref":"#/components/schemas/BlockListResponse","description":"Block list object","title":"BlockListResponse","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["duration"],"title":"GetBlockListResponse","type":"object","x-stream-docs-page-id":"get_block_list"},"GetBlockedUsersResponse":{"nullable":true,"properties":{"blocks":{"description":"Array of blocked user object","items":{"$ref":"#/components/schemas/BlockedUserResponse"},"title":"Blocks","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["blocks","duration"],"type":"object"},"GetCallReportResponse":{"description":"Basic response information","nullable":true,"properties":{"chat_activity":{"$ref":"#/components/schemas/ChatActivityStatsResponse","x-stream-index":"004"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"report":{"$ref":"#/components/schemas/ReportResponse","x-stream-index":"003"},"session_id":{"type":"string","x-stream-index":"002"},"video_reactions":{"items":{"$ref":"#/components/schemas/VideoReactionsResponse"},"type":"array","x-stream-index":"005"}},"required":["duration","session_id","report"],"title":"Response","type":"object"},"GetCallResponse":{"nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001.001"},"duration":{"type":"string","x-stream-index":"002.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001.002"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"001.004"}},"required":["call","members","own_capabilities","blocked_users","duration"],"title":"GetCallResponse","type":"object"},"GetCallTypeResponse":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.005"},"duration":{"type":"string","x-stream-index":"002.001"},"external_storage":{"type":"string","x-stream-index":"001.007"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"001.002"},"name":{"type":"string","x-stream-index":"001.001"},"notification_settings":{"$ref":"#/components/schemas/NotificationSettings","x-stream-index":"001.004"},"settings":{"$ref":"#/components/schemas/CallSettingsResponse","x-stream-index":"001.003"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.006"}},"required":["name","grants","settings","notification_settings","created_at","updated_at","duration"],"title":"GetCallTypeResponse","type":"object"},"GetCustomPermissionResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"permission":{"$ref":"#/components/schemas/Permission","x-stream-index":"001"}},"required":["permission","duration"],"title":"Response","type":"object"},"GetEdgesResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"edges":{"items":{"$ref":"#/components/schemas/EdgeResponse"},"type":"array","x-stream-index":"001"}},"required":["edges","duration"],"title":"Response","type":"object"},"GetImportResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"import_task":{"$ref":"#/components/schemas/ImportTask","x-stream-index":"001"}},"required":["duration"],"title":"Response","type":"object"},"GetOGResponse":{"nullable":true,"properties":{"actions":{"items":{"$ref":"#/components/schemas/Action"},"type":"array","x-stream-index":"001.015"},"asset_url":{"description":"URL of detected video or audio","title":"Image URL","type":"string","x-stream-index":"001.017"},"author_icon":{"type":"string","x-stream-index":"001.007"},"author_link":{"description":"og:site","title":"Author Link","type":"string","x-stream-index":"001.006"},"author_name":{"description":"og:site_name","title":"Author Name","type":"string","x-stream-index":"001.005"},"color":{"type":"string","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.018"},"duration":{"type":"string","x-stream-index":"002.001"},"fallback":{"type":"string","x-stream-index":"001.002"},"fields":{"items":{"$ref":"#/components/schemas/Field"},"type":"array","x-stream-index":"001.016"},"footer":{"type":"string","x-stream-index":"001.013"},"footer_icon":{"type":"string","x-stream-index":"001.014"},"giphy":{"$ref":"#/components/schemas/Images","x-stream-index":"001.019"},"image_url":{"description":"URL of detected image","title":"Image URL","type":"string","x-stream-index":"001.011"},"og_scrape_url":{"description":"extracted url from the text","title":"OG Scrape URL","type":"string","x-stream-index":"001.020"},"original_height":{"format":"int32","type":"integer","x-stream-index":"001.022"},"original_width":{"format":"int32","type":"integer","x-stream-index":"001.021"},"pretext":{"type":"string","x-stream-index":"001.004"},"text":{"description":"og:description","title":"Text","type":"string","x-stream-index":"001.010"},"thumb_url":{"description":"URL of detected thumb image","title":"Image URL","type":"string","x-stream-index":"001.012"},"title":{"description":"og:title","title":"Title","type":"string","x-stream-index":"001.008"},"title_link":{"description":"og:url","title":"Title Link","type":"string","x-stream-index":"001.009"},"type":{"description":"Attachment type, could be empty, image, audio or video","title":"Type","type":"string","x-stream-index":"001.001"}},"required":["custom","duration"],"title":"Get OG Attachment","type":"object","x-stream-docs-page-id":"og"},"GetOrCreateCallRequest":{"nullable":true,"properties":{"data":{"$ref":"#/components/schemas/CallRequest","title":"ReadOnlyData","x-stream-index":"003"},"members_limit":{"format":"int32","maximum":100,"type":"integer","x-stream-index":"007"},"notify":{"description":"if provided it sends a notification event to the members for this call","title":"Notify","type":"boolean","x-stream-index":"005"},"ring":{"description":"if provided it sends a ring event to the members for this call","title":"Ring","type":"boolean","x-stream-index":"004"},"video":{"type":"boolean","x-stream-index":"006"}},"title":"GetOrCreateCallRequest","type":"object"},"GetOrCreateCallResponse":{"nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001.001"},"created":{"type":"boolean","x-stream-index":"002"},"duration":{"type":"string","x-stream-index":"003.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001.002"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"001.004"}},"required":["call","members","own_capabilities","blocked_users","created","duration"],"title":"GetOrCreateCallResponse","type":"object"},"GetRateLimitsResponse":{"nullable":true,"properties":{"android":{"additionalProperties":{"$ref":"#/components/schemas/LimitInfo"},"description":"Map of endpoint rate limits for the Android platform","title":"Android","type":"object","x-stream-index":"002","x-stream-map":{"key":"endpoint","title":"Endpoint name","description":"The name of the endpoint for which the limits apply"}},"duration":{"type":"string","x-stream-index":"005.001"},"ios":{"additionalProperties":{"$ref":"#/components/schemas/LimitInfo"},"description":"Map of endpoint rate limits for the iOS platform","title":"iOS","type":"object","x-stream-index":"003","x-stream-map":{"key":"endpoint","title":"Endpoint name","description":"The name of the endpoint for which the limits apply"}},"server_side":{"additionalProperties":{"$ref":"#/components/schemas/LimitInfo"},"description":"Map of endpoint rate limits for the server-side platform","title":"Server-side","type":"object","x-stream-index":"001","x-stream-map":{"key":"endpoint","title":"Endpoint name","description":"The name of the endpoint for which the limits apply"}},"web":{"additionalProperties":{"$ref":"#/components/schemas/LimitInfo"},"description":"Map of endpoint rate limits for the web platform","title":"Web","type":"object","x-stream-index":"004","x-stream-map":{"key":"endpoint","title":"Endpoint name","description":"The name of the endpoint for which the limits apply"}}},"required":["duration"],"title":"Get Rate Limits Response","type":"object","x-stream-docs-page-id":"rate_limits"},"GetTaskResponse":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"001.003"},"duration":{"type":"string","x-stream-index":"004.001"},"error":{"$ref":"#/components/schemas/ErrorResult","description":"Error produced by task","title":"Error","x-stream-index":"003"},"result":{"additionalProperties":{},"description":"Result produced by task after completion","title":"Result","type":"object","x-stream-index":"002"},"status":{"description":"Current status of task","title":"Status","type":"string","x-stream-index":"001.002"},"task_id":{"description":"ID of task","title":"Task ID","type":"string","x-stream-index":"001.001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.004"}},"required":["task_id","status","created_at","updated_at","duration"],"title":"Get Task Response","type":"object","x-stream-docs-page-id":"tasks"},"GoLiveRequest":{"nullable":true,"properties":{"recording_storage_name":{"type":"string","x-stream-index":"005"},"start_closed_caption":{"type":"boolean","x-stream-index":"008"},"start_hls":{"type":"boolean","x-stream-index":"003"},"start_recording":{"type":"boolean","x-stream-index":"004"},"start_transcription":{"type":"boolean","x-stream-index":"007"},"transcription_storage_name":{"type":"string","x-stream-index":"006"}},"title":"GoLiveRequest","type":"object"},"GoLiveResponse":{"description":"Basic response information","nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["call","duration"],"title":"Response","type":"object"},"GroupedStatsResponse":{"nullable":true,"properties":{"name":{"type":"string","x-stream-index":"001"},"unique":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["name","unique"],"type":"object"},"HLSSettings":{"properties":{"auto_on":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"004"},"quality_tracks":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"required":["auto_on","enabled","quality_tracks"],"type":"object"},"HLSSettingsRequest":{"properties":{"auto_on":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"layout":{"$ref":"#/components/schemas/LayoutSettingsRequest","title":"LayoutSettings","x-stream-index":"004"},"quality_tracks":{"items":{"type":"string"},"maximum":3,"minimum":1,"type":"array","x-stream-index":"003"}},"required":["quality_tracks"],"title":"HLSSettingsRequest","type":"object"},"HLSSettingsResponse":{"description":"HLSSettings is the payload for HLS settings","properties":{"auto_on":{"title":"Auto On","type":"boolean","x-stream-index":"001"},"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"002"},"layout":{"$ref":"#/components/schemas/LayoutSettingsResponse","title":"Layout","x-stream-index":"004"},"quality_tracks":{"items":{"type":"string"},"title":"Quality Tracks","type":"array","x-stream-index":"003"}},"required":["auto_on","enabled","quality_tracks","layout"],"title":"HLSSettingsResponse","type":"object"},"HuaweiConfig":{"properties":{"Disabled":{"type":"boolean","writeOnly":true,"x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"secret":{"type":"string","x-stream-index":"002"}},"type":"object"},"HuaweiConfigFields":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"id":{"type":"string","x-stream-index":"002"},"secret":{"type":"string","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"ImageData":{"properties":{"frames":{"type":"string","x-stream-index":"005"},"height":{"type":"string","x-stream-index":"003"},"size":{"type":"string","x-stream-index":"004"},"url":{"type":"string","x-stream-index":"001"},"width":{"type":"string","x-stream-index":"002"}},"required":["url","width","height","size","frames"],"type":"object"},"ImageSize":{"properties":{"crop":{"description":"Crop mode","enum":["top","bottom","left","right","center"],"title":"Crop","type":"string","x-stream-index":"001"},"height":{"description":"Target image height","format":"int32","title":"Height","type":"integer","x-stream-index":"003"},"resize":{"description":"Resize method","enum":["clip","crop","scale","fill"],"title":"Resize","type":"string","x-stream-index":"002"},"width":{"description":"Target image width","format":"int32","title":"Width","type":"integer","x-stream-index":"004"}},"title":"Image size configuration","type":"object"},"ImageUploadRequest":{"nullable":true,"properties":{"file":{"type":"string","x-stream-index":"001.001"},"upload_sizes":{"description":"field with JSON-encoded array of image size configurations","items":{"$ref":"#/components/schemas/ImageSize"},"title":"Upload sizes","type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/OnlyUserID","x-stream-index":"001.002"}},"type":"object"},"ImageUploadResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.003.001"},"file":{"type":"string","x-stream-index":"001.001"},"thumb_url":{"type":"string","x-stream-index":"001.002"},"upload_sizes":{"description":"Array of image size configurations","items":{"$ref":"#/components/schemas/ImageSize"},"title":"Upload sizes","type":"array","x-stream-index":"002"}},"required":["duration"],"type":"object"},"Images":{"properties":{"fixed_height":{"$ref":"#/components/schemas/ImageData","x-stream-index":"002"},"fixed_height_downsampled":{"$ref":"#/components/schemas/ImageData","x-stream-index":"004"},"fixed_height_still":{"$ref":"#/components/schemas/ImageData","x-stream-index":"003"},"fixed_width":{"$ref":"#/components/schemas/ImageData","x-stream-index":"005"},"fixed_width_downsampled":{"$ref":"#/components/schemas/ImageData","x-stream-index":"007"},"fixed_width_still":{"$ref":"#/components/schemas/ImageData","x-stream-index":"006"},"original":{"$ref":"#/components/schemas/ImageData","x-stream-index":"001"}},"required":["original","fixed_height","fixed_height_still","fixed_height_downsampled","fixed_width","fixed_width_still","fixed_width_downsampled"],"type":"object"},"ImportTask":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"011"},"history":{"items":{"$ref":"#/components/schemas/ImportTaskHistory"},"type":"array","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"003"},"mode":{"type":"string","x-stream-index":"006"},"path":{"type":"string","x-stream-index":"005"},"size":{"format":"int64","type":"integer","x-stream-index":"007"},"state":{"type":"string","x-stream-index":"008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"012"}},"required":["id","path","mode","state","history","created_at","updated_at"],"type":"object"},"ImportTaskHistory":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"next_state":{"type":"string","x-stream-index":"006"},"prev_state":{"type":"string","x-stream-index":"005"}},"required":["prev_state","next_state","created_at"],"type":"object"},"IngressAudioEncodingOptions":{"properties":{"bitrate":{"maximum":128000,"minimum":16000,"type":"integer","x-stream-index":"003"},"channels":{"enum":["1","2"],"format":"int32","type":"integer","x-stream-index":"001"},"enable_dtx":{"type":"boolean","x-stream-index":"002"}},"required":["channels","enable_dtx","bitrate"],"type":"object"},"IngressAudioEncodingOptionsRequest":{"properties":{"bitrate":{"maximum":128000,"minimum":16000,"type":"integer","x-stream-index":"003"},"channels":{"enum":["1","2"],"format":"int32","type":"integer","x-stream-index":"001"},"enable_dtx":{"type":"boolean","x-stream-index":"002"}},"required":["channels","bitrate"],"type":"object"},"IngressAudioEncodingResponse":{"properties":{"bitrate":{"format":"int32","type":"integer","x-stream-index":"003"},"channels":{"format":"int32","type":"integer","x-stream-index":"001"},"enable_dtx":{"type":"boolean","x-stream-index":"002"}},"required":["channels","enable_dtx","bitrate"],"type":"object"},"IngressSettings":{"properties":{"audio_encoding_options":{"$ref":"#/components/schemas/IngressAudioEncodingOptions","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"video_encoding_options":{"additionalProperties":{"$ref":"#/components/schemas/IngressVideoEncodingOptions"},"type":"object","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"IngressSettingsRequest":{"properties":{"audio_encoding_options":{"$ref":"#/components/schemas/IngressAudioEncodingOptionsRequest","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"video_encoding_options":{"additionalProperties":{"$ref":"#/components/schemas/IngressVideoEncodingOptionsRequest"},"type":"object","x-stream-index":"003"}},"type":"object"},"IngressSettingsResponse":{"properties":{"audio_encoding_options":{"$ref":"#/components/schemas/IngressAudioEncodingResponse","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"video_encoding_options":{"additionalProperties":{"$ref":"#/components/schemas/IngressVideoEncodingResponse"},"type":"object","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"IngressVideoEncodingOptions":{"properties":{"layers":{"items":{"$ref":"#/components/schemas/IngressVideoLayer"},"minimum":1,"type":"array","x-stream-index":"001"}},"required":["layers"],"type":"object"},"IngressVideoEncodingOptionsRequest":{"properties":{"layers":{"items":{"$ref":"#/components/schemas/IngressVideoLayerRequest"},"minimum":1,"type":"array","x-stream-index":"001"}},"required":["layers"],"type":"object"},"IngressVideoEncodingResponse":{"properties":{"layers":{"items":{"$ref":"#/components/schemas/IngressVideoLayerResponse"},"type":"array","x-stream-index":"001"}},"required":["layers"],"type":"object"},"IngressVideoLayer":{"nullable":true,"properties":{"bitrate":{"minimum":1000,"type":"integer","x-stream-index":"002"},"codec":{"enum":["h264","vp8"],"type":"string","x-stream-index":"001"},"frame_rate":{"maximum":60,"minimum":1,"type":"integer","x-stream-index":"003"},"max_dimension":{"minimum":240,"type":"integer","x-stream-index":"005"},"min_dimension":{"minimum":240,"type":"integer","x-stream-index":"004"}},"required":["codec","bitrate","frame_rate","min_dimension","max_dimension"],"type":"object"},"IngressVideoLayerRequest":{"nullable":true,"properties":{"bitrate":{"format":"int32","minimum":1000,"type":"integer","x-stream-index":"002"},"codec":{"enum":["h264","vp8"],"type":"string","x-stream-index":"001"},"frame_rate_limit":{"maximum":60,"minimum":1,"type":"integer","x-stream-index":"005"},"max_dimension":{"minimum":240,"type":"integer","x-stream-index":"004"},"min_dimension":{"minimum":240,"type":"integer","x-stream-index":"003"}},"required":["codec","bitrate","min_dimension","max_dimension","frame_rate_limit"],"type":"object"},"IngressVideoLayerResponse":{"nullable":true,"properties":{"bitrate":{"type":"integer","x-stream-index":"002"},"codec":{"type":"string","x-stream-index":"001"},"frame_rate_limit":{"type":"integer","x-stream-index":"005"},"max_dimension":{"type":"integer","x-stream-index":"004"},"min_dimension":{"type":"integer","x-stream-index":"003"}},"required":["codec","bitrate","min_dimension","max_dimension","frame_rate_limit"],"type":"object"},"JoinCallAPIMetrics":{"properties":{"failures":{"format":"float","type":"number","x-stream-index":"002"},"latency":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"003"},"total":{"format":"float","type":"number","x-stream-index":"001"}},"required":["total","failures"],"type":"object"},"KickUserRequest":{"description":"KickUserRequest is the payload for kicking a user from a call. Optionally block the user as well.","nullable":true,"properties":{"block":{"description":"If true, also block the user from rejoining the call","title":"Block","type":"boolean","x-stream-index":"004"},"kicked_by":{"$ref":"#/components/schemas/UserRequest","description":"Server-side: user performing the action","title":"KickedBy","x-stream-index":"006"},"kicked_by_id":{"description":"Server-side: ID of the user performing the action","title":"KickedByID","type":"string","x-stream-index":"005"},"user_id":{"description":"The user to kick","title":"UserID","type":"string","x-stream-index":"003"}},"required":["user_id"],"title":"KickUserRequest","type":"object"},"KickUserResponse":{"description":"KickUserResponse is the payload for kicking a user from a call.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"KickUserResponse","type":"object"},"KickedUserEvent":{"description":"This event is sent to call participants to notify when a user is kicked from a call. Clients should make the kicked user leave the call UI.","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"kicked_by_user":{"$ref":"#/components/schemas/UserResponse","description":"The user that kicked the participant, null if server-side","title":"Kicked by","x-stream-index":"004"},"type":{"default":"call.kicked_user","description":"The type of event: \"call.kicked_user\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user that was kicked","title":"User","x-stream-index":"003"}},"required":["type","created_at","call_cid","user"],"title":"KickedUserEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"LabelThresholds":{"properties":{"block":{"description":"Threshold for automatic message block","format":"float","maximum":1,"minimum":0,"title":"Block","type":"number","x-stream-index":"002"},"flag":{"description":"Threshold for automatic message flag","format":"float","maximum":1,"minimum":0,"title":"Flag","type":"number","x-stream-index":"001"}},"type":"object"},"LayoutSettings":{"properties":{"detect_orientation":{"type":"boolean","x-stream-index":"005"},"external_app_url":{"type":"string","x-stream-index":"003"},"external_css_url":{"type":"string","x-stream-index":"004"},"name":{"enum":["spotlight","grid","single-participant","mobile","custom"],"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"required":["name","external_app_url","external_css_url"],"type":"object"},"LayoutSettingsRequest":{"properties":{"detect_orientation":{"type":"boolean","x-stream-index":"005"},"external_app_url":{"type":"string","x-stream-index":"003"},"external_css_url":{"type":"string","x-stream-index":"004"},"name":{"enum":["spotlight","grid","single-participant","mobile","custom"],"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"required":["name"],"type":"object"},"LayoutSettingsResponse":{"properties":{"detect_orientation":{"type":"boolean","x-stream-index":"005"},"external_app_url":{"type":"string","x-stream-index":"003"},"external_css_url":{"type":"string","x-stream-index":"004"},"name":{"enum":["spotlight","grid","single-participant","mobile","custom"],"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"required":["name","external_app_url","external_css_url"],"type":"object"},"LimitInfo":{"properties":{"limit":{"description":"The maximum number of calls allowed for the time window","format":"int32","title":"Limit","type":"integer","x-stream-index":"001"},"remaining":{"description":"The number of remaining calls in the current window","format":"int64","title":"Remaining","type":"integer","x-stream-index":"002"},"reset":{"description":"The Unix timestamp of the next window","format":"int64","title":"Reset","type":"integer","x-stream-index":"003"}},"required":["limit","remaining","reset"],"title":"Rate Limit info","type":"object","x-stream-docs-page-id":"rate_limits"},"LimitsSettings":{"properties":{"max_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"004"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"},"max_participants_exclude_owner":{"type":"boolean","x-stream-index":"003"},"max_participants_exclude_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"002"}},"required":["max_participants_exclude_roles"],"type":"object"},"LimitsSettingsRequest":{"properties":{"max_duration_seconds":{"format":"int32","minimum":0,"type":"integer","x-stream-index":"004"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"},"max_participants_exclude_owner":{"type":"boolean","x-stream-index":"003"},"max_participants_exclude_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"002"}},"type":"object"},"LimitsSettingsResponse":{"properties":{"max_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"004"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"},"max_participants_exclude_owner":{"type":"boolean","x-stream-index":"003"},"max_participants_exclude_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"002"}},"required":["max_participants_exclude_roles"],"type":"object"},"ListBlockListResponse":{"description":"Basic response information","nullable":true,"properties":{"blocklists":{"items":{"$ref":"#/components/schemas/BlockListResponse"},"type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["blocklists","duration"],"title":"Response","type":"object"},"ListCallTypeResponse":{"description":"Response for ListCallType","nullable":true,"properties":{"call_types":{"additionalProperties":{"$ref":"#/components/schemas/CallTypeResponse"},"type":"object","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["call_types","duration"],"title":"ListCallTypeResponse","type":"object"},"ListDevicesResponse":{"description":"List devices response","nullable":true,"properties":{"devices":{"description":"List of devices","items":{"$ref":"#/components/schemas/DeviceResponse"},"title":"Devices","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["devices","duration"],"title":"ListDevicesResponse","type":"object"},"ListExternalStorageResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"external_storages":{"additionalProperties":{"$ref":"#/components/schemas/ExternalStorageResponse"},"type":"object","x-stream-index":"002"}},"required":["duration","external_storages"],"title":"Response","type":"object"},"ListImportsResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"import_tasks":{"items":{"$ref":"#/components/schemas/ImportTask"},"type":"array","x-stream-index":"001"}},"required":["import_tasks","duration"],"title":"Response","type":"object"},"ListPermissionsResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"permissions":{"items":{"$ref":"#/components/schemas/Permission"},"type":"array","x-stream-index":"001"}},"required":["permissions","duration"],"title":"Response","type":"object"},"ListPushProvidersResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"push_providers":{"items":{"$ref":"#/components/schemas/PushProviderResponse"},"type":"array","x-stream-index":"001"}},"required":["push_providers","duration"],"title":"Response","type":"object"},"ListRecordingsResponse":{"description":"Response for listing recordings","nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"},"recordings":{"items":{"$ref":"#/components/schemas/CallRecording"},"title":"The list of recordings.","type":"array","x-stream-index":"002"}},"required":["duration","recordings"],"title":"ListRecordingsResponse","type":"object"},"ListRolesResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"roles":{"items":{"$ref":"#/components/schemas/Role"},"type":"array","x-stream-index":"001"}},"required":["roles","duration"],"title":"Response","type":"object"},"ListTranscriptionsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"},"transcriptions":{"description":"List of transcriptions for the call","items":{"$ref":"#/components/schemas/CallTranscription"},"title":"Transcriptions","type":"array","x-stream-index":"002"}},"required":["duration","transcriptions"],"title":"ListTranscriptionsResponse","type":"object"},"MemberRequest":{"description":"MemberRequest is the payload for adding a member to a call.","properties":{"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"003"},"role":{"title":"Role","type":"string","x-stream-index":"002"},"user_id":{"minLength":1,"title":"User ID","type":"string","x-stream-index":"001"}},"required":["user_id"],"title":"MemberRequest","type":"object"},"MemberResponse":{"description":"MemberResponse is the payload for a member of a call.","properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"005"},"custom":{"additionalProperties":{},"description":"Custom member response data","title":"Custom","type":"object","x-stream-index":"004"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"007"},"role":{"title":"Role","type":"string","x-stream-index":"003"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"006"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"},"user_id":{"type":"string","x-stream-index":"002"}},"required":["user","user_id","custom","created_at","updated_at"],"title":"MemberResponse","type":"object"},"Message":{"properties":{"attachments":{"items":{"$ref":"#/components/schemas/Attachment"},"type":"array","x-stream-index":"012"},"before_message_send_failed":{"type":"boolean","x-stream-index":"046"},"cid":{"type":"string","x-stream-index":"028"},"command":{"type":"string","x-stream-index":"006"},"created_at":{"format":"date-time","type":"number","x-stream-index":"030"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"034"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"033"},"deleted_for_me":{"type":"boolean","x-stream-index":"059"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"023"},"html":{"type":"string","x-stream-index":"007"},"i18n":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"044"},"id":{"type":"string","x-stream-index":"002"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"040"},"latest_reactions":{"items":{"$ref":"#/components/schemas/Reaction"},"type":"array","x-stream-index":"013"},"mentioned_users":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"043"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"052"},"mml":{"type":"string","x-stream-index":"005"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"056"},"own_reactions":{"items":{"$ref":"#/components/schemas/Reaction"},"type":"array","x-stream-index":"014"},"parent_id":{"type":"string","x-stream-index":"019"},"pin_expires":{"format":"date-time","type":"number","x-stream-index":"051"},"pinned":{"type":"boolean","x-stream-index":"047"},"pinned_at":{"format":"date-time","type":"number","x-stream-index":"048"},"pinned_by":{"$ref":"#/components/schemas/User","x-stream-index":"050"},"poll":{"$ref":"#/components/schemas/Poll","x-stream-index":"054"},"poll_id":{"type":"string","x-stream-index":"053"},"quoted_message":{"$ref":"#/components/schemas/Message","x-stream-index":"025"},"quoted_message_id":{"type":"string","x-stream-index":"024"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"015"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"017"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"016"},"reminder":{"$ref":"#/components/schemas/MessageReminder","x-stream-index":"058"},"reply_count":{"format":"int32","type":"integer","x-stream-index":"022"},"restricted_visibility":{"items":{"type":"string"},"type":"array","x-stream-index":"011"},"shadowed":{"type":"boolean","x-stream-index":"036"},"shared_location":{"$ref":"#/components/schemas/SharedLocation","x-stream-index":"055"},"show_in_channel":{"type":"boolean","x-stream-index":"021"},"silent":{"type":"boolean","x-stream-index":"045"},"text":{"type":"string","x-stream-index":"004"},"thread_participants":{"items":{"$ref":"#/components/schemas/User"},"type":"array","x-stream-index":"027"},"type":{"type":"string","x-stream-index":"008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"031"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"010"}},"required":["id","text","html","type","restricted_visibility","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reaction_groups","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned"],"type":"object"},"MessageReminder":{"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"004"},"channel_cid":{"type":"string","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"011"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"006"},"message_id":{"type":"string","x-stream-index":"005"},"remind_at":{"format":"date-time","type":"number","x-stream-index":"009"},"task_id":{"type":"string","x-stream-index":"010"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"012"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"008"},"user_id":{"type":"string","x-stream-index":"007"}},"required":["channel_cid","message_id","user_id","task_id","created_at","updated_at"],"type":"object"},"MessageResponse":{"description":"Represents any chat message","properties":{"attachments":{"description":"Array of message attachments","items":{"$ref":"#/components/schemas/Attachment"},"title":"Message attachments","type":"array","x-stream-docs-page-id":"message_format#attachment-format","x-stream-index":"008"},"cid":{"description":"Channel unique identifier in \u003ctype\u003e:\u003cid\u003e format","title":"Channel CID","type":"string","x-stream-index":"022"},"command":{"description":"Contains provided slash command","title":"Command","type":"string","x-stream-docs-page-id":"custom_commands_webhook","x-stream-index":"004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"023"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"026"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"025"},"deleted_for_me":{"type":"boolean","x-stream-index":"044"},"deleted_reply_count":{"format":"int32","type":"integer","x-stream-index":"018"},"draft":{"$ref":"#/components/schemas/DraftResponse","x-stream-index":"041"},"html":{"description":"Contains HTML markup of the message. Can only be set when using server-side API","title":"HTML content","type":"string","x-stream-index":"005"},"i18n":{"additionalProperties":{"type":"string"},"description":"Object with translations. Key `language` contains the original language key. Other keys contain translations","title":"Internationalization info","type":"object","x-stream-docs-page-id":"translation","x-stream-index":"030"},"id":{"description":"Message ID is unique string identifier of the message","title":"ID","type":"string","x-stream-index":"001"},"image_labels":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"Contains image moderation information","title":"Image moderation labels","type":"object","x-stream-index":"028"},"latest_reactions":{"description":"List of 10 latest reactions to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Latest reactions","type":"array","x-stream-index":"009"},"mentioned_users":{"description":"List of mentioned users","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Mentioned Users","type":"array","x-stream-index":"029"},"message_text_updated_at":{"format":"date-time","type":"number","x-stream-index":"036"},"mml":{"description":"Should be empty if `text` is provided. Can only be set when using server-side API","title":"Messaging Markup Language","type":"string","x-stream-docs-page-id":"mml_overview","x-stream-index":"003"},"moderation":{"$ref":"#/components/schemas/ModerationV2Response","x-stream-index":"039"},"own_reactions":{"description":"List of 10 latest reactions of authenticated user to this message","items":{"$ref":"#/components/schemas/ReactionResponse"},"title":"Own reactions","type":"array","x-stream-index":"010"},"parent_id":{"description":"ID of parent message (thread)","title":"Parent message ID","type":"string","x-stream-docs-page-id":"threads","x-stream-index":"015"},"pin_expires":{"description":"Date when pinned message expires","format":"date-time","title":"Pin expiration date","type":"number","x-stream-docs-page-id":"pinned_messages","x-stream-index":"035"},"pinned":{"description":"Whether message is pinned or not","title":"Pinned","type":"boolean","x-stream-docs-page-id":"pinned_messages","x-stream-index":"032"},"pinned_at":{"description":"Date when message got pinned","format":"date-time","title":"Pinned at","type":"number","x-stream-docs-page-id":"pinned_messages","x-stream-index":"033"},"pinned_by":{"$ref":"#/components/schemas/UserResponse","description":"Contains user who pinned the message","title":"Pinned by","x-stream-docs-page-id":"pinned_messages","x-stream-index":"034"},"poll":{"$ref":"#/components/schemas/PollResponseData","x-stream-index":"038"},"poll_id":{"description":"Identifier of the poll to include in the message","title":"Poll ID","type":"string","x-stream-index":"037"},"quoted_message":{"$ref":"#/components/schemas/MessageResponse","description":"Contains quoted message","title":"Quoted message","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"020"},"quoted_message_id":{"title":"ID of quoted message","type":"string","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"019"},"reaction_counts":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing number of reactions of each type. Key: reaction type (string), value: number of reactions (int)","title":"Reaction counts","type":"object","x-stream-index":"011"},"reaction_groups":{"additionalProperties":{"$ref":"#/components/schemas/ReactionGroupResponse"},"type":"object","x-stream-index":"014"},"reaction_scores":{"additionalProperties":{"format":"int32","type":"integer"},"description":"An object containing scores of reactions of each type. Key: reaction type (string), value: total score of reactions (int)","title":"Reaction scores","type":"object","x-stream-index":"012"},"reminder":{"$ref":"#/components/schemas/ReminderResponseData","x-stream-index":"042"},"reply_count":{"description":"Number of replies to this message","format":"int32","title":"Reply count","type":"integer","x-stream-index":"017"},"restricted_visibility":{"description":"A list of user ids that have restricted visibility to the message, if the list is not empty, the message is only visible to the users in the list","items":{"type":"string"},"title":"Restricted visibility","type":"array","x-stream-index":"040"},"shadowed":{"description":"Whether the message was shadowed or not","title":"Shadowed","type":"boolean","x-stream-docs-page-id":"moderation#shadow-ban","x-stream-index":"027"},"shared_location":{"$ref":"#/components/schemas/SharedLocationResponseData","description":"Contains shared location data","title":"Shared Location","x-stream-index":"043"},"show_in_channel":{"description":"Whether thread reply should be shown in the channel as well","title":"Show in channel","type":"boolean","x-stream-docs-page-id":"threads","x-stream-index":"016"},"silent":{"description":"Whether message is silent or not","title":"Silent","type":"boolean","x-stream-index":"031"},"text":{"description":"Text of the message. Should be empty if `mml` is provided","title":"Text","type":"string","x-stream-index":"002"},"thread_participants":{"description":"List of users who participate in thread","items":{"$ref":"#/components/schemas/UserResponse"},"title":"Thread participants","type":"array","x-stream-docs-page-id":"threads#quote-message","x-stream-index":"021"},"type":{"description":"Contains type of the message","enum":["regular","ephemeral","error","reply","system","deleted"],"title":"Message Type","type":"string","x-stream-docs-page-id":"message_format#message-types","x-stream-index":"006"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"024"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Sender of the message. Required when using server-side API","title":"User object","x-stream-index":"007"}},"required":["id","text","html","type","user","attachments","latest_reactions","own_reactions","reaction_counts","reaction_scores","reply_count","deleted_reply_count","cid","created_at","updated_at","custom","shadowed","mentioned_users","silent","pinned","restricted_visibility"],"title":"Message","type":"object","x-stream-docs-page-id":"send_message"},"MessageStatsResponse":{"properties":{"count_over_time":{"items":{"$ref":"#/components/schemas/CountByMinuteResponse"},"type":"array","x-stream-index":"001"}},"type":"object"},"ModerationDashboardPreferences":{"properties":{"flag_user_on_flagged_content":{"type":"boolean","x-stream-index":"002"},"media_queue_blur_enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"ModerationV2Response":{"properties":{"action":{"type":"string","x-stream-index":"001"},"blocklist_matched":{"type":"string","x-stream-index":"005"},"image_harms":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"original_text":{"type":"string","x-stream-index":"002"},"platform_circumvented":{"type":"boolean","x-stream-index":"007"},"semantic_filter_matched":{"type":"string","x-stream-index":"006"},"text_harms":{"items":{"type":"string"},"type":"array","x-stream-index":"003"}},"required":["action","original_text"],"type":"object"},"MuteUsersRequest":{"nullable":true,"properties":{"audio":{"title":"Audio","type":"boolean","x-stream-index":"005"},"mute_all_users":{"type":"boolean","x-stream-index":"003"},"muted_by":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"010"},"muted_by_id":{"type":"string","x-stream-index":"009"},"screenshare":{"title":"Screenshare","type":"boolean","x-stream-index":"007"},"screenshare_audio":{"title":"ScreenshareAudio","type":"boolean","x-stream-index":"008"},"user_ids":{"items":{"type":"string"},"title":"UserIDs","type":"array","x-stream-index":"004"},"video":{"title":"Video","type":"boolean","x-stream-index":"006"}},"title":"MuteUsersRequest","type":"object"},"MuteUsersResponse":{"description":"MuteUsersResponse is the response payload for the mute users endpoint.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"MuteUsersResponse","type":"object"},"NetworkMetricsReportResponse":{"properties":{"average_connection_time":{"format":"float","type":"number","x-stream-index":"003"},"average_jitter":{"format":"float","type":"number","x-stream-index":"002"},"average_latency":{"format":"float","type":"number","x-stream-index":"001"},"average_time_to_reconnect":{"format":"float","type":"number","x-stream-index":"004"}},"type":"object"},"NoiseCancellationSettings":{"properties":{"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode"],"type":"object"},"NotificationSettings":{"properties":{"call_live_started":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"002"},"call_missed":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"006"},"call_notification":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"004"},"call_ring":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"session_started":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"003"}},"required":["enabled","call_live_started","session_started","call_notification","call_ring","call_missed"],"type":"object"},"OnlyUserID":{"properties":{"id":{"type":"string","x-stream-index":"001"}},"required":["id"],"type":"object"},"OwnCapability":{"description":"All possibility of string to use","enum":["block-users","change-max-duration","create-call","create-reaction","enable-noise-cancellation","end-call","join-backstage","join-call","join-ended-call","kick-user","mute-users","pin-for-everyone","read-call","remove-call-member","screenshare","send-audio","send-video","start-broadcast-call","start-closed-captions-call","start-frame-record-call","start-record-call","start-transcription-call","stop-broadcast-call","stop-closed-captions-call","stop-frame-record-call","stop-record-call","stop-transcription-call","update-call","update-call-member","update-call-permissions","update-call-settings"],"title":"OwnCapability","type":"string"},"ParticipantCountByMinuteResponse":{"nullable":true,"properties":{"first":{"format":"int32","type":"integer","x-stream-index":"002"},"last":{"format":"int32","type":"integer","x-stream-index":"003"},"max":{"format":"int32","type":"integer","x-stream-index":"004"},"min":{"format":"int32","type":"integer","x-stream-index":"005"},"start_ts":{"format":"date-time","type":"number","x-stream-index":"001"}},"required":["start_ts","first","last","max","min"],"type":"object"},"ParticipantCountOverTimeResponse":{"properties":{"by_minute":{"items":{"$ref":"#/components/schemas/ParticipantCountByMinuteResponse"},"type":"array","x-stream-index":"001"}},"type":"object"},"ParticipantReportResponse":{"properties":{"by_browser":{"items":{"$ref":"#/components/schemas/GroupedStatsResponse"},"type":"array","x-stream-index":"008"},"by_country":{"items":{"$ref":"#/components/schemas/GroupedStatsResponse"},"type":"array","x-stream-index":"005"},"by_device":{"items":{"$ref":"#/components/schemas/GroupedStatsResponse"},"type":"array","x-stream-index":"006"},"by_operating_system":{"items":{"$ref":"#/components/schemas/GroupedStatsResponse"},"type":"array","x-stream-index":"007"},"count_over_time":{"$ref":"#/components/schemas/ParticipantCountOverTimeResponse","x-stream-index":"004"},"max_concurrent":{"format":"int32","type":"integer","x-stream-index":"003"},"publishers":{"$ref":"#/components/schemas/PublisherStatsResponse","x-stream-index":"009"},"subscribers":{"$ref":"#/components/schemas/SubscriberStatsResponse","x-stream-index":"010"},"sum":{"format":"int32","type":"integer","x-stream-index":"001"},"unique":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["sum","unique"],"type":"object"},"PerSDKUsageReport":{"nullable":true,"properties":{"by_version":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"002"},"total":{"format":"int32","type":"integer","x-stream-index":"001"}},"required":["total","by_version"],"type":"object"},"Permission":{"properties":{"action":{"description":"Action name this permission is for (e.g. SendMessage)","title":"Action","type":"string","x-stream-index":"004"},"condition":{"additionalProperties":{},"description":"MongoDB style condition which decides whether or not the permission is granted","title":"Condition","type":"object","x-stream-index":"007"},"custom":{"description":"Whether this is a custom permission or built-in","title":"Custom","type":"boolean","x-stream-index":"009"},"description":{"description":"Description of the permission","title":"Description","type":"string","x-stream-index":"003"},"id":{"description":"Unique permission ID","title":"ID","type":"string","x-stream-index":"001"},"level":{"description":"Level at which permission could be applied (app or channel)","enum":["app","channel"],"title":"Level","type":"string","x-stream-index":"010"},"name":{"description":"Name of the permission","title":"Name","type":"string","x-stream-index":"002"},"owner":{"description":"Whether this permission applies to resource owner or not","title":"Owner","type":"boolean","x-stream-index":"005"},"same_team":{"description":"Whether this permission applies to teammates (multi-tenancy mode only)","title":"Same team","type":"boolean","x-stream-index":"006"},"tags":{"description":"List of tags of the permission","items":{"type":"string"},"title":"Tags","type":"array","x-stream-index":"011"}},"required":["id","name","description","action","owner","same_team","custom","level","tags"],"type":"object"},"PermissionRequestEvent":{"description":"This event is sent when a user requests access to a feature on a call,\nclients receiving this event should display a permission request to the user","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"permissions":{"description":"The list of permissions requested by the user","items":{"type":"string"},"title":"Permissions","type":"array","x-stream-index":"004"},"type":{"default":"call.permission_request","description":"The type of event: \"call.permission_request\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who sent the permission request","title":"User","x-stream-index":"003"}},"required":["type","created_at","call_cid","user","permissions"],"title":"PermissionRequestEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"PinRequest":{"description":"PinRequest is the payload for pinning a message.","nullable":true,"properties":{"session_id":{"description":"the session ID of the user who pinned the message","title":"SessionID","type":"string","x-stream-index":"003"},"user_id":{"description":"the user ID of the user who pinned the message","title":"UserID","type":"string","x-stream-index":"002"}},"required":["user_id","session_id"],"title":"PinRequest","type":"object"},"PinResponse":{"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"},"PlatformDataResponse":{"properties":{"browser":{"$ref":"#/components/schemas/BrowserDataResponse","x-stream-index":"003"},"device":{"$ref":"#/components/schemas/DeviceDataResponse","x-stream-index":"002"},"os":{"$ref":"#/components/schemas/ClientOSDataResponse","x-stream-index":"001"}},"required":["os","device","browser"],"type":"object"},"Policy":{"properties":{"action":{"type":"integer","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"010"},"name":{"type":"string","x-stream-index":"004"},"owner":{"type":"boolean","x-stream-index":"008"},"priority":{"format":"int32","type":"integer","x-stream-index":"009"},"resources":{"items":{"type":"string"},"type":"array","x-stream-index":"005"},"roles":{"items":{"type":"string"},"type":"array","x-stream-index":"006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"011"}},"required":["name","resources","roles","action","owner","priority","created_at","updated_at"],"type":"object"},"Poll":{"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"023"},"allow_answers":{"type":"boolean","x-stream-index":"010"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"009"},"answers_count":{"format":"int32","type":"integer","x-stream-index":"015"},"created_at":{"format":"date-time","type":"number","x-stream-index":"021"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"020"},"created_by_id":{"type":"string","x-stream-index":"019"},"description":{"type":"string","x-stream-index":"005"},"enforce_unique_vote":{"type":"boolean","x-stream-index":"007"},"id":{"type":"string","x-stream-index":"003"},"is_closed":{"type":"boolean","x-stream-index":"011"},"latest_answers":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array","x-stream-index":"017"},"latest_votes_by_option":{"additionalProperties":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array"},"type":"object","x-stream-index":"016"},"max_votes_allowed":{"format":"int32","type":"integer","x-stream-index":"008"},"name":{"type":"string","x-stream-index":"004"},"options":{"items":{"$ref":"#/components/schemas/PollOption"},"type":"array","x-stream-index":"013"},"own_votes":{"items":{"$ref":"#/components/schemas/PollVote"},"type":"array","x-stream-index":"018"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"022"},"vote_count":{"format":"int32","type":"integer","x-stream-index":"012"},"vote_counts_by_option":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"014"},"voting_visibility":{"type":"string","x-stream-index":"006"}},"required":["id","name","description","enforce_unique_vote","allow_user_suggested_options","allow_answers","vote_count","options","vote_counts_by_option","answers_count","latest_votes_by_option","latest_answers","own_votes","created_by_id","created_at","updated_at","Custom"],"type":"object"},"PollOption":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id","text","custom"],"type":"object"},"PollOptionInput":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"text":{"type":"string","x-stream-index":"002"}},"type":"object"},"PollOptionRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"maxLength":255,"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id"],"type":"object"},"PollOptionResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"poll_option":{"$ref":"#/components/schemas/PollOptionResponseData","description":"Poll option","title":"PollOptionResponseData","x-stream-index":"001"}},"required":["poll_option","duration"],"type":"object"},"PollOptionResponseData":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"text":{"type":"string","x-stream-index":"002"}},"required":["id","text","custom"],"type":"object"},"PollResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"poll":{"$ref":"#/components/schemas/PollResponseData","description":"Poll","title":"PollResponseData","x-stream-index":"001"}},"required":["poll","duration"],"type":"object"},"PollResponseData":{"properties":{"allow_answers":{"type":"boolean","x-stream-index":"008"},"allow_user_suggested_options":{"type":"boolean","x-stream-index":"007"},"answers_count":{"format":"int32","type":"integer","x-stream-index":"012"},"created_at":{"format":"date-time","type":"number","x-stream-index":"019"},"created_by":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"018"},"created_by_id":{"type":"string","x-stream-index":"017"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"021"},"description":{"type":"string","x-stream-index":"003"},"enforce_unique_vote":{"type":"boolean","x-stream-index":"005"},"id":{"type":"string","x-stream-index":"001"},"is_closed":{"type":"boolean","x-stream-index":"009"},"latest_answers":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array","x-stream-index":"015"},"latest_votes_by_option":{"additionalProperties":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array"},"type":"object","x-stream-index":"014"},"max_votes_allowed":{"format":"int32","type":"integer","x-stream-index":"006"},"name":{"type":"string","x-stream-index":"002"},"options":{"items":{"$ref":"#/components/schemas/PollOptionResponseData"},"type":"array","x-stream-index":"011"},"own_votes":{"items":{"$ref":"#/components/schemas/PollVoteResponseData"},"type":"array","x-stream-index":"016"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"020"},"vote_count":{"format":"int32","type":"integer","x-stream-index":"010"},"vote_counts_by_option":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"013"},"voting_visibility":{"type":"string","x-stream-index":"004"}},"required":["id","name","description","voting_visibility","enforce_unique_vote","allow_user_suggested_options","allow_answers","vote_count","options","answers_count","vote_counts_by_option","latest_votes_by_option","latest_answers","own_votes","created_by_id","created_at","updated_at","custom"],"type":"object"},"PollVote":{"nullable":true,"properties":{"answer_text":{"type":"string","x-stream-index":"007"},"created_at":{"format":"date-time","type":"number","x-stream-index":"010"},"id":{"type":"string","x-stream-index":"004"},"is_answer":{"type":"boolean","x-stream-index":"006"},"option_id":{"type":"string","x-stream-index":"005"},"poll_id":{"type":"string","x-stream-index":"003"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"011"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"009"},"user_id":{"type":"string","x-stream-index":"008"}},"required":["poll_id","id","option_id","created_at","updated_at"],"type":"object"},"PollVoteResponseData":{"nullable":true,"properties":{"answer_text":{"type":"string","x-stream-index":"005"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"id":{"type":"string","x-stream-index":"002"},"is_answer":{"type":"boolean","x-stream-index":"004"},"option_id":{"type":"string","x-stream-index":"003"},"poll_id":{"type":"string","x-stream-index":"001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"007"},"user_id":{"type":"string","x-stream-index":"006"}},"required":["poll_id","id","option_id","created_at","updated_at"],"type":"object"},"PollVotesResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"},"votes":{"description":"Poll votes","items":{"$ref":"#/components/schemas/PollVoteResponseData"},"title":"PollVoteResponseList","type":"array","x-stream-index":"001"}},"required":["votes","duration"],"type":"object"},"PrivacySettings":{"properties":{"read_receipts":{"$ref":"#/components/schemas/ReadReceipts","x-stream-index":"002"},"typing_indicators":{"$ref":"#/components/schemas/TypingIndicators","x-stream-index":"001"}},"type":"object"},"PrivacySettingsResponse":{"properties":{"read_receipts":{"$ref":"#/components/schemas/ReadReceiptsResponse","x-stream-index":"002"},"typing_indicators":{"$ref":"#/components/schemas/TypingIndicatorsResponse","x-stream-index":"001"}},"type":"object"},"PublisherAllMetrics":{"properties":{"audio":{"$ref":"#/components/schemas/PublisherAudioMetrics","x-stream-index":"001"},"rtt_ms":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"003"},"video":{"$ref":"#/components/schemas/PublisherVideoMetrics","x-stream-index":"002"}},"type":"object"},"PublisherAudioMetrics":{"properties":{"jitter_ms":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"001"}},"type":"object"},"PublisherStatsResponse":{"properties":{"by_track":{"items":{"$ref":"#/components/schemas/TrackStatsResponse"},"type":"array","x-stream-index":"003"},"total":{"format":"int32","type":"integer","x-stream-index":"001"},"unique":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["total","unique"],"type":"object"},"PublisherVideoMetrics":{"properties":{"bitrate":{"$ref":"#/components/schemas/ActiveCallsBitrateStats","x-stream-index":"005"},"fps_30":{"$ref":"#/components/schemas/ActiveCallsFPSStats","x-stream-index":"002"},"frame_encoding_time_ms":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"003"},"jitter_ms":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"001"},"resolution":{"$ref":"#/components/schemas/ActiveCallsResolutionStats","x-stream-index":"004"}},"type":"object"},"PublishersMetrics":{"properties":{"all":{"$ref":"#/components/schemas/PublisherAllMetrics","x-stream-index":"001"}},"type":"object"},"PushConfig":{"properties":{"offline_only":{"type":"boolean","x-stream-index":"002"},"version":{"enum":["v1","v2","v3"],"type":"string","x-stream-index":"001"}},"required":["version"],"type":"object"},"PushNotificationFields":{"properties":{"apn":{"$ref":"#/components/schemas/APNConfigFields","x-stream-index":"002"},"firebase":{"$ref":"#/components/schemas/FirebaseConfigFields","x-stream-index":"003"},"huawei":{"$ref":"#/components/schemas/HuaweiConfigFields","x-stream-index":"004"},"offline_only":{"type":"boolean","x-stream-index":"001.002"},"providers":{"items":{"$ref":"#/components/schemas/PushProvider"},"type":"array","x-stream-index":"006"},"version":{"type":"string","x-stream-index":"001.001"},"xiaomi":{"$ref":"#/components/schemas/XiaomiConfigFields","x-stream-index":"005"}},"required":["version","offline_only","apn","firebase","huawei","xiaomi"],"type":"object"},"PushNotificationSettingsResponse":{"properties":{"disabled":{"type":"boolean","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"number","x-stream-index":"002"}},"type":"object"},"PushProvider":{"nullable":true,"properties":{"apn_auth_key":{"type":"string","x-stream-index":"012"},"apn_auth_type":{"type":"string","x-stream-index":"017"},"apn_development":{"type":"boolean","x-stream-index":"018"},"apn_host":{"type":"string","x-stream-index":"019"},"apn_key_id":{"type":"string","x-stream-index":"013"},"apn_notification_template":{"type":"string","x-stream-index":"020"},"apn_p12_cert":{"type":"string","x-stream-index":"014"},"apn_team_id":{"type":"string","x-stream-index":"015"},"apn_topic":{"type":"string","x-stream-index":"016"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"description":{"maxLength":128,"type":"string","x-stream-index":"007"},"disabled_at":{"format":"date-time","type":"number","x-stream-index":"010"},"disabled_reason":{"maxLength":255,"type":"string","x-stream-index":"011"},"firebase_apn_template":{"type":"string","x-stream-index":"025"},"firebase_credentials":{"type":"string","x-stream-index":"022"},"firebase_data_template":{"type":"string","x-stream-index":"023"},"firebase_host":{"type":"string","x-stream-index":"026"},"firebase_notification_template":{"type":"string","x-stream-index":"024"},"firebase_server_key":{"type":"string","x-stream-index":"021"},"huawei_app_id":{"type":"string","x-stream-index":"027"},"huawei_app_secret":{"type":"string","x-stream-index":"028"},"name":{"maxLength":36,"minLength":1,"type":"string","x-stream-index":"005"},"push_templates":{"items":{"$ref":"#/components/schemas/PushTemplate"},"type":"array","x-stream-index":"031"},"type":{"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"xiaomi_app_secret":{"type":"string","x-stream-index":"030"},"xiaomi_package_name":{"type":"string","x-stream-index":"029"}},"required":["name","type","created_at","updated_at"],"type":"object"},"PushProviderResponse":{"properties":{"apn_auth_key":{"type":"string","x-stream-index":"008"},"apn_auth_type":{"type":"string","x-stream-index":"013"},"apn_development":{"type":"boolean","x-stream-index":"014"},"apn_host":{"type":"string","x-stream-index":"015"},"apn_key_id":{"type":"string","x-stream-index":"009"},"apn_p12_cert":{"type":"string","x-stream-index":"010"},"apn_sandbox_certificate":{"type":"boolean","x-stream-index":"016"},"apn_supports_remote_notifications":{"type":"boolean","x-stream-index":"018"},"apn_supports_voip_notifications":{"type":"boolean","x-stream-index":"017"},"apn_team_id":{"type":"string","x-stream-index":"011"},"apn_topic":{"type":"string","x-stream-index":"012"},"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"description":{"type":"string","x-stream-index":"003"},"disabled_at":{"format":"date-time","type":"number","x-stream-index":"006"},"disabled_reason":{"type":"string","x-stream-index":"007"},"firebase_apn_template":{"type":"string","x-stream-index":"023"},"firebase_credentials":{"type":"string","x-stream-index":"020"},"firebase_data_template":{"type":"string","x-stream-index":"021"},"firebase_host":{"type":"string","x-stream-index":"024"},"firebase_notification_template":{"type":"string","x-stream-index":"022"},"firebase_server_key":{"type":"string","x-stream-index":"019"},"huawei_app_id":{"type":"string","x-stream-index":"025"},"huawei_app_secret":{"type":"string","x-stream-index":"026"},"name":{"type":"string","x-stream-index":"001"},"type":{"type":"string","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"005"},"xiaomi_app_secret":{"type":"string","x-stream-index":"028"},"xiaomi_package_name":{"type":"string","x-stream-index":"027"}},"required":["name","type","created_at","updated_at"],"type":"object"},"PushTemplate":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"007"},"enable_push":{"type":"boolean","x-stream-index":"003"},"event_type":{"enum":["message.new","message.updated","reaction.new","notification.reminder_due","feeds.activity.added","feeds.comment.added","feeds.activity.reaction.added","feeds.comment.reaction.added","feeds.follow.created","feeds.notification_feed.updated"],"type":"string","x-stream-index":"005"},"template":{"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"008"}},"required":["enable_push","event_type","created_at","updated_at"],"type":"object"},"QualityScoreReport":{"properties":{"histogram":{"items":{"$ref":"#/components/schemas/ReportByHistogramBucket"},"type":"array","x-stream-index":"001"}},"required":["histogram"],"type":"object"},"QualityScoreReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateQualityScoreReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"QueryAggregateCallStatsRequest":{"nullable":true,"properties":{"from":{"type":"string","x-stream-index":"002"},"report_types":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"to":{"type":"string","x-stream-index":"003"}},"type":"object"},"QueryAggregateCallStatsResponse":{"description":"Basic response information","nullable":true,"properties":{"call_duration_report":{"$ref":"#/components/schemas/CallDurationReportResponse","x-stream-index":"002"},"call_participant_count_report":{"$ref":"#/components/schemas/CallParticipantCountReportResponse","x-stream-index":"004"},"calls_per_day_report":{"$ref":"#/components/schemas/CallsPerDayReportResponse","x-stream-index":"003"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"network_metrics_report":{"$ref":"#/components/schemas/NetworkMetricsReportResponse","x-stream-index":"008"},"quality_score_report":{"$ref":"#/components/schemas/QualityScoreReportResponse","x-stream-index":"005"},"sdk_usage_report":{"$ref":"#/components/schemas/SDKUsageReportResponse","x-stream-index":"006"},"user_feedback_report":{"$ref":"#/components/schemas/UserFeedbackReportResponse","x-stream-index":"007"}},"required":["duration"],"title":"Response","type":"object"},"QueryCallMembersRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"002"},"id":{"maxLength":64,"type":"string","x-stream-index":"001.002"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"004.001"},"next":{"type":"string","x-stream-index":"004.002"},"prev":{"type":"string","x-stream-index":"004.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":1,"type":"array","x-stream-index":"003"},"type":{"maxLength":64,"type":"string","x-stream-index":"001.001"}},"required":["type","id"],"type":"object"},"QueryCallMembersResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["members","duration"],"title":"Response","type":"object"},"QueryCallParticipantsRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"003"}},"type":"object"},"QueryCallParticipantsResponse":{"nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001.001"},"duration":{"type":"string","x-stream-index":"004.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001.002"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"001.004"},"participants":{"description":"List of call participants","items":{"$ref":"#/components/schemas/CallParticipantResponse"},"title":"[]CallParticipantResponse","type":"array","x-stream-index":"002"},"total_participants":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["call","members","own_capabilities","blocked_users","participants","total_participants","duration"],"type":"object"},"QueryCallStatsRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"004.001"},"next":{"type":"string","x-stream-index":"004.002"},"prev":{"type":"string","x-stream-index":"004.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":2,"type":"array","x-stream-index":"002"}},"type":"object"},"QueryCallStatsResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"next":{"type":"string","x-stream-index":"003.001"},"prev":{"type":"string","x-stream-index":"003.002"},"reports":{"items":{"$ref":"#/components/schemas/CallStatsReportSummaryResponse"},"type":"array","x-stream-index":"001"}},"required":["reports","duration"],"title":"Response","type":"object"},"QueryCallsRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"title":"Filters","type":"object","x-stream-index":"003"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"006.001"},"next":{"type":"string","x-stream-index":"006.002"},"prev":{"type":"string","x-stream-index":"006.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":2,"title":"Sort","type":"array","x-stream-index":"004"}},"title":"QueryCallsRequest","type":"object"},"QueryCallsResponse":{"nullable":true,"properties":{"calls":{"items":{"$ref":"#/components/schemas/CallStateResponseFields"},"title":"Calls","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["calls","duration"],"title":"QueryCallsResponse","type":"object"},"QueryPollVotesRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","title":"Filter","type":"object","x-stream-index":"003"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"004"}},"type":"object"},"QueryPollsRequest":{"nullable":true,"properties":{"filter":{"additionalProperties":{},"description":"Filter to apply to the query","title":"Filter","type":"object","x-stream-index":"002"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"title":"Sort","type":"array","x-stream-index":"003"}},"type":"object"},"QueryPollsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"polls":{"description":"Polls data returned by the query","items":{"$ref":"#/components/schemas/PollResponseData"},"title":"PollsResponseData","type":"array","x-stream-index":"001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["polls","duration"],"type":"object"},"QueryUserFeedbackRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":2,"type":"array","x-stream-index":"002"}},"type":"object"},"QueryUserFeedbackResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"next":{"type":"string","x-stream-index":"003.001"},"prev":{"type":"string","x-stream-index":"003.002"},"user_feedback":{"items":{"$ref":"#/components/schemas/UserFeedbackResponse"},"type":"array","x-stream-index":"001"}},"required":["user_feedback","duration"],"title":"Response","type":"object"},"QueryUsersPayload":{"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"include_deactivated_users":{"type":"boolean","x-stream-index":"004"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.003"},"offset":{"format":"int32","maximum":1000,"type":"integer","x-stream-index":"005.004"},"presence":{"type":"boolean","x-stream-index":"003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":5,"type":"array","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"006.002"},"user_id":{"type":"string","x-stream-index":"006.001"}},"required":["filter_conditions"],"type":"object"},"QueryUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"users":{"description":"Array of users as result of filters applied.","items":{"$ref":"#/components/schemas/FullUserResponse"},"title":"Users","type":"array","x-stream-index":"001"}},"required":["users","duration"],"type":"object"},"RTMPBroadcastRequest":{"description":"RTMPBroadcastRequest is the payload for starting an RTMP broadcast.","properties":{"layout":{"$ref":"#/components/schemas/LayoutSettingsRequest","description":"If provided, will override the call's RTMP settings layout","title":"Layout","x-stream-index":"005"},"name":{"description":"Name identifier for RTMP broadcast, must be unique in call","maxLength":255,"title":"Name","type":"string","x-stream-index":"001"},"quality":{"description":"If provided, will override the call's RTMP settings quality","enum":["360p","480p","720p","1080p","1440p","portrait-360x640","portrait-480x854","portrait-720x1280","portrait-1080x1920","portrait-1440x2560"],"title":"Quality","type":"string","x-stream-index":"004"},"stream_key":{"description":"If provided, will be appended at the end of stream_url","title":"Stream Key","type":"string","x-stream-index":"003"},"stream_url":{"description":"URL for the RTMP server to send the call to","maxLength":255,"title":"Stream URL","type":"string","x-stream-index":"002"}},"required":["name","stream_url"],"title":"RTMPBroadcastRequest","type":"object"},"RTMPIngress":{"description":"RTMP input settings","properties":{"address":{"title":"Address","type":"string","x-stream-index":"001"}},"required":["address"],"title":"RTMPIngress","type":"object"},"RTMPLocation":{"properties":{"name":{"type":"string","x-stream-index":"001"},"stream_key":{"type":"string","x-stream-index":"003"},"stream_url":{"type":"string","x-stream-index":"002"}},"required":["name","stream_url","stream_key"],"type":"object"},"RTMPSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"003"},"location":{"$ref":"#/components/schemas/RTMPLocation","x-stream-index":"004"},"quality_name":{"type":"string","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"RTMPSettingsRequest":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettingsRequest","description":"Layout for the composed RTMP stream","title":"LayoutSettings","x-stream-index":"003"},"quality":{"description":"Resolution to set for the RTMP stream","enum":["360p","480p","720p","1080p","1440p","portrait-360x640","portrait-480x854","portrait-720x1280","portrait-1080x1920","portrait-1440x2560"],"title":"Quality","type":"string","x-stream-index":"002"}},"title":"RTMPSettingsRequest","type":"object"},"RTMPSettingsResponse":{"description":"RTMPSettingsResponse is the payload for RTMP settings","properties":{"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettingsResponse","title":"Layout","x-stream-index":"003"},"quality":{"title":"Quality","type":"string","x-stream-index":"002"}},"required":["enabled","quality","layout"],"title":"RTMPSettingsResponse","type":"object"},"Reaction":{"nullable":true,"properties":{"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"010"},"message_id":{"type":"string","x-stream-index":"003"},"score":{"format":"int32","type":"integer","x-stream-index":"007"},"type":{"maxLength":30,"type":"string","x-stream-index":"006"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"005"},"user_id":{"type":"string","x-stream-index":"004"}},"required":["message_id","type","score","created_at","updated_at","custom"],"type":"object"},"ReactionGroupResponse":{"description":"ReactionGroupResponse contains all information about a reaction of the same type.","nullable":true,"properties":{"count":{"description":"Count is the number of reactions of this type.","format":"int32","title":"Count","type":"integer","x-stream-index":"001"},"first_reaction_at":{"description":"FirstReactionAt is the time of the first reaction of this type. This is the same also if all reaction of this type are deleted, because if someone will react again with the same type, will be preserved the sorting.","format":"date-time","title":"FirstReactionAt","type":"number","x-stream-index":"003"},"last_reaction_at":{"description":"LastReactionAt is the time of the last reaction of this type.","format":"date-time","title":"LastReactionAt","type":"number","x-stream-index":"004"},"sum_scores":{"description":"SumScores is the sum of all scores of reactions of this type. Medium allows you to clap articles more than once and shows the sum of all claps from all users. For example, you can send `clap` x5 using `score: 5`.","format":"int32","title":"SumScores","type":"integer","x-stream-index":"002"}},"required":["count","sum_scores","first_reaction_at","last_reaction_at"],"title":"ReactionGroupResponse","type":"object"},"ReactionResponse":{"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"006"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"008"},"message_id":{"description":"Message ID","title":"Message ID","type":"string","x-stream-index":"001"},"score":{"description":"Score of the reaction","format":"int32","title":"Score","type":"integer","x-stream-index":"005"},"type":{"description":"Type of reaction","title":"Type","type":"string","x-stream-index":"004"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"007"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User","title":"UserResponse","x-stream-index":"003"},"user_id":{"description":"User ID","title":"User ID","type":"string","x-stream-index":"002"}},"required":["message_id","user_id","user","type","score","created_at","updated_at","custom"],"type":"object"},"ReactivateUserRequest":{"nullable":true,"properties":{"created_by_id":{"description":"ID of the user who's reactivating the user","title":"Created by ID","type":"string","x-stream-index":"004"},"name":{"description":"Set this field to put new name for the user","title":"Name","type":"string","x-stream-index":"003"},"restore_messages":{"description":"Restore previously deleted messages","title":"Restore messages","type":"boolean","x-stream-index":"002"}},"type":"object"},"ReactivateUserResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.002.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"Deactivated user object","title":"User","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"ReactivateUsersRequest":{"description":"Reactivate users in batches","nullable":true,"properties":{"created_by_id":{"description":"ID of the user who's reactivating the users","title":"Created by ID","type":"string","x-stream-index":"003"},"restore_channels":{"type":"boolean","x-stream-index":"004"},"restore_messages":{"description":"Restore previously deleted messages","title":"Restore messages","type":"boolean","x-stream-index":"002"},"user_ids":{"description":"User IDs to reactivate","items":{"type":"string"},"maximum":100,"minimum":1,"title":"User IDs","type":"array","x-stream-index":"001"}},"required":["user_ids"],"title":"ReactivateUsersRequest","type":"object"},"ReactivateUsersResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.002.001"},"task_id":{"type":"string","x-stream-index":"001.001"}},"required":["task_id","duration"],"title":"Response","type":"object"},"ReadReceipts":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"ReadReceiptsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"RecordSettings":{"properties":{"audio_only":{"type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettings","x-stream-index":"004"},"mode":{"type":"string","x-stream-index":"002"},"quality":{"type":"string","x-stream-index":"003"}},"required":["mode"],"type":"object"},"RecordSettingsRequest":{"properties":{"audio_only":{"type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettingsRequest","title":"LayoutSettings","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"title":"Mode","type":"string","x-stream-index":"002"},"quality":{"enum":["360p","480p","720p","1080p","1440p","portrait-360x640","portrait-480x854","portrait-720x1280","portrait-1080x1920","portrait-1440x2560"],"type":"string","x-stream-index":"003"}},"required":["mode"],"title":"RecordSettingsRequest","type":"object"},"RecordSettingsResponse":{"description":"RecordSettings is the payload for recording settings","properties":{"audio_only":{"title":"Audio Only","type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettingsResponse","title":"Layout","x-stream-index":"004"},"mode":{"title":"Mode","type":"string","x-stream-index":"002"},"quality":{"title":"Quality","type":"string","x-stream-index":"003"}},"required":["audio_only","mode","quality","layout"],"title":"RecordSettingsResponse","type":"object"},"ReminderResponseData":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"003"},"channel_cid":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"005"},"message_id":{"type":"string","x-stream-index":"004"},"remind_at":{"format":"date-time","type":"number","x-stream-index":"001"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007"},"user_id":{"type":"string","x-stream-index":"006"}},"required":["channel_cid","message_id","user_id","created_at","updated_at"],"type":"object"},"ReportByHistogramBucket":{"properties":{"category":{"type":"string","x-stream-index":"001"},"count":{"format":"int32","type":"integer","x-stream-index":"005"},"lower_bound":{"$ref":"#/components/schemas/Bound","x-stream-index":"002"},"sum":{"format":"float","type":"number","x-stream-index":"004"},"upper_bound":{"$ref":"#/components/schemas/Bound","x-stream-index":"003"}},"required":["category","sum","count"],"type":"object"},"ReportResponse":{"properties":{"call":{"$ref":"#/components/schemas/CallReportResponse","x-stream-index":"003"},"participants":{"$ref":"#/components/schemas/ParticipantReportResponse","x-stream-index":"001"},"user_ratings":{"$ref":"#/components/schemas/UserRatingReportResponse","x-stream-index":"002"}},"required":["participants","user_ratings","call"],"type":"object"},"Response":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001"}},"required":["duration"],"title":"Response","type":"object"},"RestoreUsersRequest":{"nullable":true,"properties":{"user_ids":{"items":{"type":"string"},"maximum":100,"minimum":1,"type":"array","x-stream-index":"001"}},"required":["user_ids"],"type":"object"},"RingSettings":{"properties":{"auto_cancel_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_timeout_ms","missed_call_timeout_ms"],"type":"object"},"RingSettingsRequest":{"properties":{"auto_cancel_timeout_ms":{"description":"When none of the callees accept a ring call in this time a rejection will be sent by the caller with reason 'timeout' by the SDKs","format":"int32","maximum":180000,"minimum":5000,"title":"AutoCancelTimeoutMs","type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"description":"When a callee is online but doesn't answer a ring call in this time a rejection will be sent with reason 'timeout' by the SDKs","format":"int32","maximum":180000,"minimum":5000,"title":"IncomingCallTimeoutMs","type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"description":"When a callee doesn't accept or reject a ring call in this time a missed call event will be sent","format":"int32","maximum":180000,"minimum":5000,"title":"MissedCallTimeoutMs","type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_timeout_ms"],"title":"RingSettingsRequest","type":"object"},"RingSettingsResponse":{"properties":{"auto_cancel_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_timeout_ms","missed_call_timeout_ms"],"type":"object"},"Role":{"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"004"},"custom":{"description":"Whether this is a custom role or built-in","title":"Custom","type":"boolean","x-stream-index":"002"},"name":{"description":"Unique role name","title":"Name","type":"string","x-stream-index":"001"},"scopes":{"description":"List of scopes where this role is currently present. `.app` means that role is present in app-level grants","items":{"type":"string"},"title":"Scopes","type":"array","x-stream-index":"003"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"005"}},"required":["name","custom","scopes","created_at","updated_at"],"type":"object"},"S3Request":{"description":"Config for creating Amazon S3 storage.","properties":{"s3_api_key":{"description":"The AWS API key. To use Amazon S3 as your storage provider, you have two authentication options: IAM role or API key. If you do not specify the `s3_api_key` parameter, Stream will use IAM role authentication. In that case make sure to have the correct IAM role configured for your application.","title":"S3ApiKey","type":"string","x-stream-index":"002"},"s3_custom_endpoint_url":{"description":"The custom endpoint for S3. If you want to use a custom endpoint, you must also provide the `s3_api_key` and `s3_secret` parameters.","title":"S3CustomEndpointURL","type":"string","x-stream-index":"004"},"s3_region":{"description":"The AWS region where the bucket is hosted","title":"S3Region","type":"string","x-stream-index":"001"},"s3_secret":{"description":"The AWS API Secret","title":"S3Secret","type":"string","x-stream-index":"003"}},"required":["s3_region"],"title":"S3Request","type":"object"},"SDKUsageReport":{"properties":{"per_sdk_usage":{"additionalProperties":{"$ref":"#/components/schemas/PerSDKUsageReport"},"type":"object","x-stream-index":"001"}},"required":["per_sdk_usage"],"type":"object"},"SDKUsageReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateSDKUsageReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"ScreensharingSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled"],"type":"object"},"ScreensharingSettingsRequest":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"type":"object"},"ScreensharingSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled"],"type":"object"},"SendCallEventRequest":{"description":"Send a call event to the other user","nullable":true,"properties":{"custom":{"additionalProperties":{},"title":"Custom","type":"object","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"title":"SendCallEventRequest","type":"object"},"SendCallEventResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"SendCallEventResponse","type":"object"},"SessionSettings":{"properties":{"inactivity_timeout_seconds":{"format":"int32","maximum":900,"minimum":5,"type":"integer","x-stream-index":"001"}},"required":["inactivity_timeout_seconds"],"type":"object"},"SessionSettingsRequest":{"properties":{"inactivity_timeout_seconds":{"format":"int32","maximum":900,"minimum":5,"type":"integer","x-stream-index":"001"}},"required":["inactivity_timeout_seconds"],"type":"object"},"SessionSettingsResponse":{"properties":{"inactivity_timeout_seconds":{"format":"int32","maximum":900,"minimum":5,"type":"integer","x-stream-index":"001"}},"required":["inactivity_timeout_seconds"],"type":"object"},"SharedLocation":{"properties":{"channel":{"$ref":"#/components/schemas/Channel","x-stream-index":"013"},"channel_cid":{"type":"string","x-stream-index":"003"},"created_at":{"format":"date-time","type":"number","x-stream-index":"010"},"created_by_device_id":{"type":"string","x-stream-index":"008"},"end_at":{"format":"date-time","type":"number","x-stream-index":"009"},"latitude":{"format":"float","maximum":90,"minimum":18446744073709552000,"type":"number","x-stream-index":"006"},"longitude":{"format":"float","maximum":180,"minimum":18446744073709552000,"type":"number","x-stream-index":"007"},"message":{"$ref":"#/components/schemas/Message","x-stream-index":"012"},"message_id":{"type":"string","x-stream-index":"004"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"011"},"user_id":{"type":"string","x-stream-index":"005"}},"required":["channel_cid","message_id","user_id","created_by_device_id","created_at","updated_at"],"type":"object"},"SharedLocationResponse":{"nullable":true,"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"001.011"},"channel_cid":{"description":"Channel CID","title":"string","type":"string","x-stream-index":"001.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.008"},"created_by_device_id":{"description":"Device ID that created the live location","title":"string","type":"string","x-stream-index":"001.006"},"duration":{"type":"string","x-stream-index":"002.001"},"end_at":{"description":"Time when the live location expires","format":"date-time","title":"string","type":"number","x-stream-index":"001.007"},"latitude":{"description":"Latitude coordinate","format":"float","title":"number","type":"number","x-stream-index":"001.004"},"longitude":{"description":"Longitude coordinate","format":"float","title":"number","type":"number","x-stream-index":"001.005"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"001.010"},"message_id":{"description":"Message ID","title":"string","type":"string","x-stream-index":"001.002"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.009"},"user_id":{"description":"User ID","title":"string","type":"string","x-stream-index":"001.003"}},"required":["channel_cid","message_id","user_id","latitude","longitude","created_by_device_id","created_at","updated_at","duration"],"type":"object"},"SharedLocationResponseData":{"properties":{"channel":{"$ref":"#/components/schemas/ChannelResponse","x-stream-index":"011"},"channel_cid":{"type":"string","x-stream-index":"001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008"},"created_by_device_id":{"type":"string","x-stream-index":"006"},"end_at":{"format":"date-time","type":"number","x-stream-index":"007"},"latitude":{"format":"float","type":"number","x-stream-index":"004"},"longitude":{"format":"float","type":"number","x-stream-index":"005"},"message":{"$ref":"#/components/schemas/MessageResponse","x-stream-index":"010"},"message_id":{"type":"string","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"009"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["channel_cid","message_id","user_id","latitude","longitude","created_by_device_id","created_at","updated_at"],"type":"object"},"SharedLocationsResponse":{"nullable":true,"properties":{"active_live_locations":{"items":{"$ref":"#/components/schemas/SharedLocationResponseData"},"type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["active_live_locations","duration"],"type":"object"},"SortParamRequest":{"nullable":true,"properties":{"direction":{"description":"Direction of sorting, 1 for Ascending, -1 for Descending, default is 1","format":"int32","title":"Direction","type":"integer","x-stream-index":"002"},"field":{"description":"Name of field to sort by","title":"Field","type":"string","x-stream-index":"001"}},"type":"object"},"StartClosedCaptionsRequest":{"nullable":true,"properties":{"enable_transcription":{"description":"Enable transcriptions along with closed captions","title":"Enable Transcription","type":"boolean","x-stream-index":"002"},"external_storage":{"description":"Which external storage to use for transcriptions (only applicable if enable_transcription is true)","title":"External Storage","type":"string","x-stream-index":"003"},"language":{"description":"The spoken language in the call, if not provided the language defined in the transcription settings will be used","enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"title":"Language","type":"string","x-stream-index":"004"}},"type":"object"},"StartClosedCaptionsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"StartFrameRecordingRequest":{"nullable":true,"properties":{"recording_external_storage":{"type":"string","x-stream-index":"002"}},"title":"StartFrameRecordingRequest","type":"object"},"StartFrameRecordingResponse":{"description":"StartFrameRecordingResponse is the response payload for the start frame recording endpoint.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StartFrameRecordingResponse","type":"object"},"StartHLSBroadcastingRequest":{"description":"StartHLSBroadcastingRequest is the payload for starting an HLS broadcasting.","nullable":true,"title":"StartHLSBroadcastingRequest","type":"object"},"StartHLSBroadcastingResponse":{"description":"StartHLSBroadcastingResponse is the payload for starting an HLS broadcasting.","nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"},"playlist_url":{"description":"the URL of the HLS playlist","title":"PlaylistURL","type":"string","x-stream-index":"002"}},"required":["duration","playlist_url"],"title":"StartHLSBroadcastingResponse","type":"object"},"StartRTMPBroadcastsRequest":{"description":"StartRTMPBroadcastsRequest is the payload for starting RTMP broadcasts.","nullable":true,"properties":{"broadcasts":{"description":"List of broadcasts to start","items":{"$ref":"#/components/schemas/RTMPBroadcastRequest"},"maximum":1,"minimum":1,"title":"Broadcasts","type":"array","x-stream-index":"002"}},"required":["broadcasts"],"title":"StartRTMPBroadcastsRequest","type":"object"},"StartRTMPBroadcastsResponse":{"description":"StartRTMPBroadcastsResponse is the payload for starting an RTMP broadcast.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StartRTMPBroadcastsResponse","type":"object"},"StartRecordingRequest":{"nullable":true,"properties":{"recording_external_storage":{"type":"string","x-stream-index":"002"}},"title":"StartRecordingRequest","type":"object"},"StartRecordingResponse":{"description":"StartRecordingResponse is the response payload for the start recording endpoint.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StartRecordingResponse","type":"object"},"StartTranscriptionRequest":{"nullable":true,"properties":{"enable_closed_captions":{"description":"Enable closed captions along with transcriptions","title":"Enable Closed Captions","type":"boolean","x-stream-index":"003"},"language":{"description":"The spoken language in the call, if not provided the language defined in the transcription settings will be used","enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"title":"Language","type":"string","x-stream-index":"004"},"transcription_external_storage":{"description":"Store transcriptions in this external storage","title":"External Storage","type":"string","x-stream-index":"002"}},"type":"object"},"StartTranscriptionResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StartTranscriptionResponse","type":"object"},"StopAllRTMPBroadcastsRequest":{"nullable":true,"title":"StopAllRTMPBroadcastsRequest","type":"object"},"StopAllRTMPBroadcastsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StopAllRTMPBroadcastsResponse","type":"object"},"StopClosedCaptionsRequest":{"nullable":true,"properties":{"stop_transcription":{"type":"boolean","x-stream-index":"003"}},"type":"object"},"StopClosedCaptionsResponse":{"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"},"StopFrameRecordingRequest":{"nullable":true,"type":"object"},"StopFrameRecordingResponse":{"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"},"StopHLSBroadcastingRequest":{"nullable":true,"type":"object"},"StopHLSBroadcastingResponse":{"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"},"StopLiveRequest":{"nullable":true,"properties":{"continue_closed_caption":{"type":"boolean","x-stream-index":"006"},"continue_hls":{"type":"boolean","x-stream-index":"003"},"continue_recording":{"type":"boolean","x-stream-index":"004"},"continue_rtmp_broadcasts":{"type":"boolean","x-stream-index":"007"},"continue_transcription":{"type":"boolean","x-stream-index":"005"}},"title":"StopLiveRequest","type":"object"},"StopLiveResponse":{"nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"The call that was stopped","title":"Call","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["call","duration"],"title":"StopLiveResponse","type":"object"},"StopRTMPBroadcastsRequest":{"description":"Request for stopping RTMP broadcasts","nullable":true,"title":"StopRTMPBroadcastsRequest","type":"object"},"StopRTMPBroadcastsResponse":{"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"},"StopRecordingRequest":{"nullable":true,"type":"object"},"StopRecordingResponse":{"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"},"StopTranscriptionRequest":{"nullable":true,"properties":{"stop_closed_captions":{"type":"boolean","x-stream-index":"003"}},"type":"object"},"StopTranscriptionResponse":{"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"},"SubscriberAllMetrics":{"properties":{"audio":{"$ref":"#/components/schemas/SubscriberAudioMetrics","x-stream-index":"001"},"rtt_ms":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"003"},"video":{"$ref":"#/components/schemas/SubscriberVideoMetrics","x-stream-index":"002"}},"type":"object"},"SubscriberAudioMetrics":{"properties":{"concealment_pct":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"003"},"jitter_ms":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"001"},"packets_lost_pct":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"002"}},"type":"object"},"SubscriberStatsResponse":{"properties":{"total":{"format":"int32","type":"integer","x-stream-index":"001"},"total_subscribed_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"003"},"unique":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["total","unique","total_subscribed_duration_seconds"],"type":"object"},"SubscriberVideoMetrics":{"properties":{"fps_30":{"$ref":"#/components/schemas/ActiveCallsFPSStats","x-stream-index":"002"},"jitter_ms":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"001"},"packets_lost_pct":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"003"}},"type":"object"},"SubscribersMetrics":{"properties":{"all":{"$ref":"#/components/schemas/SubscriberAllMetrics","x-stream-index":"001"}},"type":"object"},"TargetResolution":{"properties":{"bitrate":{"format":"int32","maximum":6000000,"type":"integer","x-stream-index":"003"},"height":{"format":"int32","maximum":3840,"minimum":240,"type":"integer","x-stream-index":"002"},"width":{"format":"int32","maximum":3840,"minimum":240,"type":"integer","x-stream-index":"001"}},"required":["width","height","bitrate"],"type":"object"},"Thresholds":{"description":"Sets thresholds for AI moderation","properties":{"explicit":{"$ref":"#/components/schemas/LabelThresholds","description":"Thresholds for explicit messages","title":"LabelThresholds","x-stream-index":"001"},"spam":{"$ref":"#/components/schemas/LabelThresholds","description":"Thresholds for spam","title":"LabelThresholds","x-stream-index":"002"},"toxic":{"$ref":"#/components/schemas/LabelThresholds","description":"Thresholds for toxic messages","title":"LabelThresholds","x-stream-index":"003"}},"title":"Auto moderation thresholds","type":"object"},"ThumbnailResponse":{"properties":{"image_url":{"type":"string","x-stream-index":"001"}},"required":["image_url"],"type":"object"},"ThumbnailsSettings":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"ThumbnailsSettingsRequest":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"ThumbnailsSettingsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"TrackStatsResponse":{"nullable":true,"properties":{"duration_seconds":{"format":"int32","type":"integer","x-stream-index":"002"},"track_type":{"type":"string","x-stream-index":"001"}},"required":["track_type","duration_seconds"],"type":"object"},"TranscriptionSettings":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"title":"Mode","type":"string","x-stream-index":"002"},"language":{"description":"The language used in this call as a two letter code","enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"title":"Language","type":"string","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"title":"Mode","type":"string","x-stream-index":"001"}},"required":["mode","closed_caption_mode","languages","language"],"type":"object"},"TranscriptionSettingsRequest":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"002"},"language":{"enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"type":"string","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode"],"type":"object"},"TranscriptionSettingsResponse":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"002"},"language":{"enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"type":"string","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode","closed_caption_mode","languages","language"],"type":"object"},"TypingIndicators":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"TypingIndicatorsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"UnblockUserRequest":{"description":"UnblockUserRequest is the payload for unblocking a user.","nullable":true,"properties":{"user_id":{"description":"the user to unblock","title":"UserID","type":"string","x-stream-index":"003"}},"required":["user_id"],"title":"UnblockUserRequest","type":"object"},"UnblockUserResponse":{"description":"UnblockUserResponse is the payload for unblocking a user.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"UnblockUserResponse","type":"object"},"UnblockUsersRequest":{"nullable":true,"properties":{"blocked_user_id":{"type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"required":["blocked_user_id"],"type":"object"},"UnblockUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"UnblockedUserEvent":{"description":"This event is sent when a user is unblocked on a call,\nthis can be useful to notify the user that they can now join the call again","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"type":{"default":"call.unblocked_user","description":"The type of event: \"call.unblocked_user\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user that was unblocked","title":"User","x-stream-index":"003"}},"required":["type","created_at","call_cid","user"],"title":"UnblockedUserEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"UnpinRequest":{"description":"UnpinRequest is the payload for unpinning a message.","nullable":true,"properties":{"session_id":{"description":"the session ID of the user who pinned the message","title":"SessionID","type":"string","x-stream-index":"003"},"user_id":{"description":"the user ID of the user who pinned the message","title":"UserID","type":"string","x-stream-index":"002"}},"required":["user_id","session_id"],"title":"UnpinRequest","type":"object"},"UnpinResponse":{"description":"UnpinResponse is the payload for unpinning a message.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"UnpinResponse","type":"object"},"UpdateAppRequest":{"nullable":true,"properties":{"allowed_flag_reasons":{"items":{"type":"string"},"type":"array","x-stream-index":"001.017"},"apn_config":{"$ref":"#/components/schemas/APNConfig","x-stream-index":"001.003"},"async_moderation_config":{"$ref":"#/components/schemas/AsyncModerationConfiguration","x-stream-index":"001.039"},"async_url_enrich_enabled":{"type":"boolean","x-stream-index":"001.019"},"auto_translation_enabled":{"type":"boolean","x-stream-index":"001.018"},"before_message_send_hook_url":{"type":"string","x-stream-index":"001.020"},"cdn_expiration_seconds":{"format":"int32","maximum":1209600,"minimum":14400,"type":"integer","x-stream-index":"001.038"},"channel_hide_members_only":{"type":"boolean","x-stream-index":"001.033"},"custom_action_handler_url":{"type":"string","x-stream-index":"001.021"},"datadog_info":{"$ref":"#/components/schemas/DataDogInfo","x-stream-index":"001.040"},"disable_auth_checks":{"type":"boolean","x-stream-index":"001.001"},"disable_permissions_checks":{"type":"boolean","x-stream-index":"001.002"},"enforce_unique_usernames":{"enum":["no","app","team"],"type":"string","x-stream-index":"001.022"},"event_hooks":{"items":{"$ref":"#/components/schemas/EventHook"},"type":"array","x-stream-index":"001.046"},"feeds_moderation_enabled":{"type":"boolean","x-stream-index":"001.042"},"feeds_v2_region":{"type":"string","x-stream-index":"001.041"},"file_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","x-stream-index":"001.030"},"firebase_config":{"$ref":"#/components/schemas/FirebaseConfig","x-stream-index":"001.004"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"001.034"},"guest_user_creation_disabled":{"type":"boolean","x-stream-index":"001.043"},"huawei_config":{"$ref":"#/components/schemas/HuaweiConfig","x-stream-index":"001.005"},"image_moderation_block_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001.015"},"image_moderation_enabled":{"type":"boolean","x-stream-index":"001.016"},"image_moderation_labels":{"items":{"type":"string"},"type":"array","x-stream-index":"001.014"},"image_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","x-stream-index":"001.029"},"max_aggregated_activities_length":{"format":"int32","type":"integer","x-stream-index":"001.049"},"migrate_permissions_to_v2":{"type":"boolean","x-stream-index":"001.035"},"moderation_dashboard_preferences":{"$ref":"#/components/schemas/ModerationDashboardPreferences","x-stream-index":"001.044"},"moderation_enabled":{"type":"boolean","x-stream-index":"001.009"},"moderation_webhook_url":{"type":"string","x-stream-index":"001.010"},"multi_tenant_enabled":{"type":"boolean","x-stream-index":"001.013"},"permission_version":{"enum":["v1","v2"],"type":"string","x-stream-index":"001.011"},"push_config":{"$ref":"#/components/schemas/PushConfig","x-stream-index":"001.007"},"reminders_interval":{"format":"int32","maximum":86400,"minimum":60,"type":"integer","x-stream-index":"001.036"},"reminders_max_members":{"format":"int32","minimum":2,"type":"integer","x-stream-index":"001.037"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.031"},"sns_key":{"type":"string","x-stream-index":"001.027"},"sns_secret":{"type":"string","x-stream-index":"001.028"},"sns_topic_arn":{"type":"string","x-stream-index":"001.026"},"sqs_key":{"type":"string","x-stream-index":"001.024"},"sqs_secret":{"type":"string","x-stream-index":"001.025"},"sqs_url":{"type":"string","x-stream-index":"001.023"},"user_response_time_enabled":{"type":"boolean","x-stream-index":"001.048"},"user_search_disallowed_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"001.012"},"webhook_events":{"items":{"type":"string"},"type":"array","x-stream-index":"001.032"},"webhook_url":{"type":"string","x-stream-index":"001.008"},"xiaomi_config":{"$ref":"#/components/schemas/XiaomiConfig","x-stream-index":"001.006"}},"type":"object"},"UpdateBlockListRequest":{"nullable":true,"properties":{"team":{"type":"string","x-stream-index":"002"},"words":{"description":"List of words to block","items":{"type":"string"},"minimum":1,"title":"Words","type":"array","x-stream-index":"003"}},"title":"Update block list","type":"object","x-stream-docs-page-id":"update_block_list"},"UpdateBlockListResponse":{"description":"Basic response information","nullable":true,"properties":{"blocklist":{"$ref":"#/components/schemas/BlockListResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["duration"],"title":"Response","type":"object"},"UpdateCallMembersRequest":{"description":"Update call members","nullable":true,"properties":{"remove_members":{"description":"List of userID to remove","items":{"type":"string"},"maximum":100,"title":"Remove Members","type":"array","x-stream-index":"003"},"update_members":{"description":"List of members to update or insert","items":{"$ref":"#/components/schemas/MemberRequest"},"maximum":100,"title":"Update Members","type":"array","x-stream-index":"004"}},"title":"UpdateCallMembersRequest","type":"object"},"UpdateCallMembersResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"002"}},"required":["duration","members"],"title":"Response","type":"object"},"UpdateCallRequest":{"description":"Request for updating a call","nullable":true,"properties":{"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"003"},"settings_override":{"$ref":"#/components/schemas/CallSettingsRequest","description":"the settings to change for this call","title":"Settings Override","x-stream-index":"004"},"starts_at":{"description":"the time the call is scheduled to start","format":"date-time","title":"Starts At","type":"number","x-stream-index":"005"}},"title":"UpdateCallRequest","type":"object"},"UpdateCallResponse":{"description":"Response for updating a call","nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001.001"},"duration":{"type":"string","x-stream-index":"002.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001.002"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"001.004"}},"required":["call","members","own_capabilities","blocked_users","duration"],"title":"UpdateCallResponse","type":"object"},"UpdateCallTypeRequest":{"description":"UpdateCallTypeRequest is the payload for updating a call type.","nullable":true,"properties":{"external_storage":{"type":"string","x-stream-index":"002.004"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"002.001"},"notification_settings":{"$ref":"#/components/schemas/NotificationSettings","x-stream-index":"002.002"},"settings":{"$ref":"#/components/schemas/CallSettingsRequest","x-stream-index":"002.003"}},"title":"UpdateCallTypeRequest","type":"object"},"UpdateCallTypeResponse":{"description":"UpdateCallTypeResponse is the payload for updating a call type.","nullable":true,"properties":{"created_at":{"description":"the time the call type was created","format":"date-time","title":"CreatedAt","type":"number","x-stream-index":"001.005"},"duration":{"type":"string","x-stream-index":"002.001"},"external_storage":{"description":"the external storage for the call type","title":"ExternalStorage","type":"string","x-stream-index":"001.007"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"the permissions granted to each role","title":"Grants","type":"object","x-stream-index":"001.002"},"name":{"description":"the name of the call type","title":"Name","type":"string","x-stream-index":"001.001"},"notification_settings":{"$ref":"#/components/schemas/NotificationSettings","description":"the notification settings for the call type","title":"NotificationSettings","x-stream-index":"001.004"},"settings":{"$ref":"#/components/schemas/CallSettingsResponse","description":"the settings for the call type","title":"Settings","x-stream-index":"001.003"},"updated_at":{"description":"the time the call type was last updated","format":"date-time","title":"UpdatedAt","type":"number","x-stream-index":"001.006"}},"required":["name","grants","settings","notification_settings","created_at","updated_at","duration"],"title":"UpdateCallTypeResponse","type":"object"},"UpdateExternalStorageRequest":{"description":"External storage","nullable":true,"properties":{"aws_s3":{"$ref":"#/components/schemas/S3Request","description":"Only required if you want to create an Amazon S3 storage","title":"AwsS3","x-stream-index":"003.004"},"azure_blob":{"$ref":"#/components/schemas/AzureRequest","description":"Only required if you want to create an Azure Blob Storage","title":"AzureBlob","x-stream-index":"003.006"},"bucket":{"description":"The name of the bucket on the service provider","title":"Bucket","type":"string","x-stream-index":"003.002"},"gcs_credentials":{"type":"string","x-stream-index":"003.005"},"path":{"description":"The path prefix to use for storing files","title":"Path","type":"string","x-stream-index":"003.003"},"storage_type":{"description":"The type of storage to use","enum":["s3","gcs","abs"],"title":"StorageType","type":"string","x-stream-index":"003.001"}},"required":["storage_type","bucket"],"title":"ExternalStorageRequest","type":"object"},"UpdateExternalStorageResponse":{"description":"Basic response information","nullable":true,"properties":{"bucket":{"type":"string","x-stream-index":"001.003"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"name":{"type":"string","x-stream-index":"001.001"},"path":{"type":"string","x-stream-index":"001.004"},"type":{"enum":["s3","gcs","abs"],"type":"string","x-stream-index":"001.002"}},"required":["name","type","bucket","path","duration"],"title":"Response","type":"object"},"UpdateLiveLocationRequest":{"nullable":true,"properties":{"end_at":{"description":"Time when the live location expires","format":"date-time","title":"string","type":"number","x-stream-index":"004"},"latitude":{"description":"Latitude coordinate","format":"float","maximum":90,"minimum":18446744073709552000,"title":"number","type":"number","x-stream-index":"002"},"longitude":{"description":"Longitude coordinate","format":"float","maximum":180,"minimum":18446744073709552000,"title":"number","type":"number","x-stream-index":"003"},"message_id":{"description":"Live location ID","title":"string","type":"string","x-stream-index":"001"}},"required":["message_id"],"type":"object"},"UpdatePollOptionRequest":{"nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"004"},"id":{"description":"Option ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"},"text":{"description":"Option text","title":"string","type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"005.002"},"user_id":{"type":"string","x-stream-index":"005.001"}},"required":["id","text"],"type":"object"},"UpdatePollPartialRequest":{"nullable":true,"properties":{"set":{"additionalProperties":{},"description":"Sets new field values","title":"Set","type":"object","x-stream-index":"002.001","x-stream-map":{"key":"field","title":"Value","description":"New value to set"}},"unset":{"description":"Array of field names to unset","items":{"type":"string"},"title":"Unset","type":"array","x-stream-index":"002.002"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"type":"object"},"UpdatePollRequest":{"nullable":true,"properties":{"Custom":{"additionalProperties":{},"type":"object","writeOnly":true,"x-stream-index":"011"},"allow_answers":{"description":"Allow answers","title":"boolean","type":"boolean","x-stream-index":"009"},"allow_user_suggested_options":{"description":"Allow user suggested options","title":"boolean","type":"boolean","x-stream-index":"008"},"description":{"description":"Poll description","title":"string","type":"string","x-stream-index":"003"},"enforce_unique_vote":{"description":"Enforce unique vote","title":"boolean","type":"boolean","x-stream-index":"005"},"id":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"},"is_closed":{"description":"Is closed","title":"boolean","type":"boolean","x-stream-index":"010"},"max_votes_allowed":{"description":"Max votes allowed","format":"int32","maximum":10,"title":"integer","type":"integer","x-stream-index":"007"},"name":{"description":"Poll name","title":"string","type":"string","x-stream-index":"002"},"options":{"description":"Poll options","items":{"$ref":"#/components/schemas/PollOptionRequest"},"maximum":100,"title":"PollOptions","type":"array","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"012.002"},"user_id":{"type":"string","x-stream-index":"012.001"},"voting_visibility":{"description":"Voting visibility","enum":["anonymous","public"],"title":"string","type":"string","x-stream-index":"006"}},"required":["id","name"],"type":"object"},"UpdateUserPartialRequest":{"properties":{"id":{"description":"User ID to update","title":"ID","type":"string","x-stream-index":"001"},"set":{"additionalProperties":{},"type":"object","x-stream-index":"002.001"},"unset":{"items":{"type":"string"},"type":"array","x-stream-index":"002.002"}},"required":["id"],"type":"object"},"UpdateUserPermissionsRequest":{"nullable":true,"properties":{"grant_permissions":{"items":{"type":"string"},"type":"array","x-stream-index":"002"},"revoke_permissions":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"user_id":{"type":"string","x-stream-index":"001"}},"required":["user_id"],"type":"object"},"UpdateUserPermissionsResponse":{"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"},"UpdateUsersPartialRequest":{"nullable":true,"properties":{"users":{"items":{"$ref":"#/components/schemas/UpdateUserPartialRequest"},"maximum":100,"type":"array","x-stream-index":"001"}},"required":["users"],"type":"object"},"UpdateUsersRequest":{"nullable":true,"properties":{"users":{"additionalProperties":{"$ref":"#/components/schemas/UserRequest"},"description":"Object containing users","title":"Users","type":"object","x-stream-index":"001","x-stream-map":{"key":"user_id"}}},"required":["users"],"type":"object"},"UpdateUsersResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"membership_deletion_task_id":{"type":"string","x-stream-index":"002"},"users":{"additionalProperties":{"$ref":"#/components/schemas/FullUserResponse"},"description":"Object containing users","title":"Users","type":"object","x-stream-index":"001","x-stream-map":{"key":"user_id"}}},"required":["users","membership_deletion_task_id","duration"],"type":"object"},"UpdatedCallPermissionsEvent":{"description":"This event is sent to notify about permission changes for a user, clients receiving this event should update their UI accordingly","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.002"},"own_capabilities":{"description":"The capabilities of the current user","items":{"$ref":"#/components/schemas/OwnCapability"},"title":"Own capabilities","type":"array","x-stream-index":"004"},"type":{"default":"call.permissions_updated","description":"The type of event: \"call.permissions_updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who received the new permissions","title":"User","x-stream-index":"003"}},"required":["type","created_at","call_cid","user","own_capabilities"],"title":"UpdatedCallPermissionsEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"UpsertPushProviderRequest":{"nullable":true,"properties":{"push_provider":{"$ref":"#/components/schemas/PushProvider","x-stream-index":"001"}},"type":"object"},"UpsertPushProviderResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"push_provider":{"$ref":"#/components/schemas/PushProviderResponse","x-stream-index":"001"}},"required":["push_provider","duration"],"title":"Response","type":"object"},"User":{"properties":{"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"046"},"ban_expires":{"format":"date-time","type":"number","x-stream-index":"017"},"banned":{"type":"boolean","x-stream-index":"016"},"created_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"013"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"023"},"language":{"type":"string","x-stream-index":"035"},"last_active":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"026"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"042"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"005"},"updated_at":{"format":"date-time","readOnly":true,"type":"number","x-stream-index":"009"}},"required":["id","role","teams_role","custom","banned","online"],"type":"object"},"UserBannedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"006.002"},"channel_type":{"type":"string","x-stream-index":"006.003"},"cid":{"type":"string","x-stream-index":"006.001"},"created_at":{"format":"date-time","type":"number","x-stream-index":"008.002"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"001"},"expiration":{"format":"date-time","type":"number","x-stream-index":"003"},"reason":{"type":"string","x-stream-index":"004"},"shadow":{"type":"boolean","x-stream-index":"002"},"team":{"type":"string","x-stream-index":"005.001"},"type":{"default":"user.banned","type":"string","x-stream-index":"008.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007.001"}},"required":["created_by","shadow","cid","channel_id","channel_type","type","created_at"],"title":"UserBannedEvent","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"},"UserDeactivatedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"003.002"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"001"},"type":{"default":"user.deactivated","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["created_by","type","created_at"],"title":"UserDeactivatedEvent","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"},"UserFeedbackReport":{"properties":{"count_by_rating":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001"},"unreported_count":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["count_by_rating","unreported_count"],"type":"object"},"UserFeedbackReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateUserFeedbackReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"UserFeedbackResponse":{"properties":{"cid":{"type":"string","x-stream-index":"001"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"009"},"platform":{"$ref":"#/components/schemas/PlatformDataResponse","x-stream-index":"008"},"rating":{"format":"int32","type":"integer","x-stream-index":"004"},"reason":{"type":"string","x-stream-index":"005"},"sdk":{"type":"string","x-stream-index":"006"},"sdk_version":{"type":"string","x-stream-index":"007"},"session_id":{"type":"string","x-stream-index":"002"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["cid","session_id","user_id","rating","reason","sdk","sdk_version","platform"],"type":"object"},"UserMuteResponse":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004"},"expires":{"format":"date-time","type":"number","x-stream-index":"003"},"target":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"002"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"005"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"}},"required":["created_at","updated_at"],"type":"object"},"UserMutedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"004.002"},"target_user":{"type":"string","x-stream-index":"001"},"target_users":{"items":{"type":"string"},"type":"array","x-stream-index":"002"},"type":{"default":"user.muted","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"UserMutedEvent","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"},"UserRatingReportResponse":{"properties":{"average":{"format":"float","type":"number","x-stream-index":"002"},"count":{"format":"int32","type":"integer","x-stream-index":"001"}},"required":["count","average"],"type":"object"},"UserReactivatedEvent":{"properties":{"created_at":{"format":"date-time","type":"number","x-stream-index":"002.002"},"type":{"default":"user.reactivated","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"001"}},"required":["type","created_at"],"title":"UserReactivatedEvent","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"},"UserRequest":{"description":"User request object","properties":{"custom":{"additionalProperties":{},"description":"Custom user data","title":"Custom","type":"object","x-stream-index":"004"},"id":{"description":"User ID","title":"ID","type":"string","x-stream-index":"001"},"image":{"description":"User's profile image URL","title":"Image","type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"006"},"language":{"type":"string","x-stream-index":"005"},"name":{"description":"Optional name of user","title":"Name","type":"string","x-stream-index":"002"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"007"},"role":{"description":"User's global role","title":"Role","type":"string","x-stream-index":"008"},"teams":{"description":"List of teams the user belongs to","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"010"},"teams_role":{"additionalProperties":{"type":"string"},"description":"Map of team-specific roles for the user","title":"TeamsRole","type":"object","x-stream-index":"009"}},"required":["id"],"title":"UserRequest","type":"object"},"UserResponse":{"description":"User response object","properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"ban_expires":{"description":"Date when ban expires","format":"date-time","title":"Ban expires","type":"number","x-stream-index":"003"},"banned":{"description":"Whether a user is banned or not","title":"Banned","type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.017"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"001.004"},"deactivated_at":{"description":"Date of deactivation","format":"date-time","title":"Deactivated at","type":"number","x-stream-index":"001.016"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"number","x-stream-index":"001.011"},"devices":{"description":"List of devices user is using","items":{"$ref":"#/components/schemas/DeviceResponse"},"title":"Devices","type":"array","x-stream-index":"006"},"id":{"description":"Unique user identifier","title":"ID","type":"string","x-stream-index":"001.001"},"image":{"title":"Image","type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"007"},"language":{"description":"Preferred language of a user","title":"Language","type":"string","x-stream-index":"001.005"},"last_active":{"description":"Date of last activity","format":"date-time","title":"Last active","type":"number","x-stream-index":"001.014"},"name":{"description":"Optional name of user","title":"Name","type":"string","x-stream-index":"001.002"},"online":{"description":"Whether a user online or not","title":"Online","type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","description":"User privacy settings","title":"Privacy settings","x-stream-index":"005"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettingsResponse","description":"User push notification settings","title":"Push notifications","x-stream-index":"004"},"revoke_tokens_issued_before":{"description":"Revocation date for tokens","format":"date-time","title":"Revoke tokens issued before","type":"number","x-stream-index":"001.015"},"role":{"description":"Determines the set of user permissions","title":"Role","type":"string","x-stream-index":"001.006"},"shadow_banned":{"description":"Whether a user is shadow banned","title":"Shadow banned","type":"boolean","x-stream-index":"002"},"teams":{"description":"List of teams user is a part of","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"number","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids","shadow_banned","invisible"],"title":"UserResponse","type":"object"},"UserResponsePrivacyFields":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"banned":{"type":"boolean","x-stream-index":"001.012"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.017"},"created_at":{"format":"date-time","type":"number","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"number","x-stream-index":"001.016"},"deleted_at":{"format":"date-time","type":"number","x-stream-index":"001.011"},"id":{"type":"string","x-stream-index":"001.001"},"image":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"003"},"language":{"type":"string","x-stream-index":"001.005"},"last_active":{"format":"date-time","type":"number","x-stream-index":"001.014"},"name":{"type":"string","x-stream-index":"001.002"},"online":{"type":"boolean","x-stream-index":"001.013"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"002"},"revoke_tokens_issued_before":{"format":"date-time","type":"number","x-stream-index":"001.015"},"role":{"type":"string","x-stream-index":"001.006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"updated_at":{"format":"date-time","type":"number","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids"],"type":"object"},"UserUpdatedEvent":{"description":"This event is sent when a user gets updated. The event contains information about the updated user.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"number","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"received_at":{"format":"date-time","type":"number","x-stream-index":"001.004"},"type":{"default":"user.updated","description":"The type of event: \"user.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.002"},"user":{"$ref":"#/components/schemas/UserResponsePrivacyFields","description":"The updated user","title":"User","x-stream-index":"002.001"}},"required":["type","created_at","custom","user"],"title":"UserUpdatedEvent","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"},"VideoReactionOverTimeResponse":{"properties":{"by_minute":{"items":{"$ref":"#/components/schemas/CountByMinuteResponse"},"type":"array","x-stream-index":"001"}},"type":"object"},"VideoReactionsResponse":{"nullable":true,"properties":{"count_over_time":{"$ref":"#/components/schemas/VideoReactionOverTimeResponse","x-stream-index":"002"},"reaction":{"type":"string","x-stream-index":"001"}},"required":["reaction"],"type":"object"},"VideoSettings":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"camera_default_on":{"type":"boolean","x-stream-index":"004"},"camera_facing":{"enum":["front","back","external"],"type":"string","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled","target_resolution","camera_default_on","camera_facing"],"type":"object"},"VideoSettingsRequest":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"camera_default_on":{"type":"boolean","x-stream-index":"004"},"camera_facing":{"enum":["front","back","external"],"type":"string","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"type":"object"},"VideoSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"camera_default_on":{"type":"boolean","x-stream-index":"004"},"camera_facing":{"enum":["front","back","external"],"type":"string","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled","target_resolution","camera_default_on","camera_facing"],"type":"object"},"WebhookEvent":{"description":"The discriminator object for all webhook events, it maps events' payload to the final type","discriminator":{"mapping":{"call.accepted":"#/components/schemas/CallAcceptedEvent","call.blocked_user":"#/components/schemas/BlockedUserEvent","call.closed_caption":"#/components/schemas/ClosedCaptionEvent","call.closed_captions_failed":"#/components/schemas/CallClosedCaptionsFailedEvent","call.closed_captions_started":"#/components/schemas/CallClosedCaptionsStartedEvent","call.closed_captions_stopped":"#/components/schemas/CallClosedCaptionsStoppedEvent","call.created":"#/components/schemas/CallCreatedEvent","call.deleted":"#/components/schemas/CallDeletedEvent","call.ended":"#/components/schemas/CallEndedEvent","call.frame_recording_failed":"#/components/schemas/CallFrameRecordingFailedEvent","call.frame_recording_ready":"#/components/schemas/CallFrameRecordingFrameReadyEvent","call.frame_recording_started":"#/components/schemas/CallFrameRecordingStartedEvent","call.frame_recording_stopped":"#/components/schemas/CallFrameRecordingStoppedEvent","call.hls_broadcasting_failed":"#/components/schemas/CallHLSBroadcastingFailedEvent","call.hls_broadcasting_started":"#/components/schemas/CallHLSBroadcastingStartedEvent","call.hls_broadcasting_stopped":"#/components/schemas/CallHLSBroadcastingStoppedEvent","call.kicked_user":"#/components/schemas/KickedUserEvent","call.live_started":"#/components/schemas/CallLiveStartedEvent","call.member_added":"#/components/schemas/CallMemberAddedEvent","call.member_removed":"#/components/schemas/CallMemberRemovedEvent","call.member_updated":"#/components/schemas/CallMemberUpdatedEvent","call.member_updated_permission":"#/components/schemas/CallMemberUpdatedPermissionEvent","call.missed":"#/components/schemas/CallMissedEvent","call.moderation_blur":"#/components/schemas/CallModerationBlurEvent","call.moderation_warning":"#/components/schemas/CallModerationWarningEvent","call.notification":"#/components/schemas/CallNotificationEvent","call.permission_request":"#/components/schemas/PermissionRequestEvent","call.permissions_updated":"#/components/schemas/UpdatedCallPermissionsEvent","call.reaction_new":"#/components/schemas/CallReactionEvent","call.recording_failed":"#/components/schemas/CallRecordingFailedEvent","call.recording_ready":"#/components/schemas/CallRecordingReadyEvent","call.recording_started":"#/components/schemas/CallRecordingStartedEvent","call.recording_stopped":"#/components/schemas/CallRecordingStoppedEvent","call.rejected":"#/components/schemas/CallRejectedEvent","call.ring":"#/components/schemas/CallRingEvent","call.rtmp_broadcast_failed":"#/components/schemas/CallRtmpBroadcastFailedEvent","call.rtmp_broadcast_started":"#/components/schemas/CallRtmpBroadcastStartedEvent","call.rtmp_broadcast_stopped":"#/components/schemas/CallRtmpBroadcastStoppedEvent","call.session_ended":"#/components/schemas/CallSessionEndedEvent","call.session_participant_count_updated":"#/components/schemas/CallSessionParticipantCountsUpdatedEvent","call.session_participant_joined":"#/components/schemas/CallSessionParticipantJoinedEvent","call.session_participant_left":"#/components/schemas/CallSessionParticipantLeftEvent","call.session_started":"#/components/schemas/CallSessionStartedEvent","call.stats_report_ready":"#/components/schemas/CallStatsReportReadyEvent","call.transcription_failed":"#/components/schemas/CallTranscriptionFailedEvent","call.transcription_ready":"#/components/schemas/CallTranscriptionReadyEvent","call.transcription_started":"#/components/schemas/CallTranscriptionStartedEvent","call.transcription_stopped":"#/components/schemas/CallTranscriptionStoppedEvent","call.unblocked_user":"#/components/schemas/UnblockedUserEvent","call.updated":"#/components/schemas/CallUpdatedEvent","call.user_feedback_submitted":"#/components/schemas/CallUserFeedbackSubmittedEvent","call.user_muted":"#/components/schemas/CallUserMutedEvent","custom":"#/components/schemas/CustomVideoEvent","export.channels.error":"#/components/schemas/AsyncExportErrorEvent","export.channels.success":"#/components/schemas/AsyncExportChannelsEvent","export.users.error":"#/components/schemas/AsyncExportErrorEvent","export.users.success":"#/components/schemas/AsyncExportUsersEvent","user.banned":"#/components/schemas/UserBannedEvent","user.deactivated":"#/components/schemas/UserDeactivatedEvent","user.muted":"#/components/schemas/UserMutedEvent","user.reactivated":"#/components/schemas/UserReactivatedEvent","user.updated":"#/components/schemas/UserUpdatedEvent"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/AsyncExportChannelsEvent"},{"$ref":"#/components/schemas/AsyncExportErrorEvent"},{"$ref":"#/components/schemas/AsyncExportErrorEvent"},{"$ref":"#/components/schemas/AsyncExportUsersEvent"},{"$ref":"#/components/schemas/BlockedUserEvent"},{"$ref":"#/components/schemas/CallAcceptedEvent"},{"$ref":"#/components/schemas/CallClosedCaptionsFailedEvent"},{"$ref":"#/components/schemas/CallClosedCaptionsStartedEvent"},{"$ref":"#/components/schemas/CallClosedCaptionsStoppedEvent"},{"$ref":"#/components/schemas/CallCreatedEvent"},{"$ref":"#/components/schemas/CallDeletedEvent"},{"$ref":"#/components/schemas/CallEndedEvent"},{"$ref":"#/components/schemas/CallFrameRecordingFailedEvent"},{"$ref":"#/components/schemas/CallFrameRecordingFrameReadyEvent"},{"$ref":"#/components/schemas/CallFrameRecordingStartedEvent"},{"$ref":"#/components/schemas/CallFrameRecordingStoppedEvent"},{"$ref":"#/components/schemas/CallHLSBroadcastingFailedEvent"},{"$ref":"#/components/schemas/CallHLSBroadcastingStartedEvent"},{"$ref":"#/components/schemas/CallHLSBroadcastingStoppedEvent"},{"$ref":"#/components/schemas/CallLiveStartedEvent"},{"$ref":"#/components/schemas/CallMemberAddedEvent"},{"$ref":"#/components/schemas/CallMemberRemovedEvent"},{"$ref":"#/components/schemas/CallMemberUpdatedEvent"},{"$ref":"#/components/schemas/CallMemberUpdatedPermissionEvent"},{"$ref":"#/components/schemas/CallMissedEvent"},{"$ref":"#/components/schemas/CallModerationBlurEvent"},{"$ref":"#/components/schemas/CallModerationWarningEvent"},{"$ref":"#/components/schemas/CallNotificationEvent"},{"$ref":"#/components/schemas/CallReactionEvent"},{"$ref":"#/components/schemas/CallRecordingFailedEvent"},{"$ref":"#/components/schemas/CallRecordingReadyEvent"},{"$ref":"#/components/schemas/CallRecordingStartedEvent"},{"$ref":"#/components/schemas/CallRecordingStoppedEvent"},{"$ref":"#/components/schemas/CallRejectedEvent"},{"$ref":"#/components/schemas/CallRingEvent"},{"$ref":"#/components/schemas/CallRtmpBroadcastFailedEvent"},{"$ref":"#/components/schemas/CallRtmpBroadcastStartedEvent"},{"$ref":"#/components/schemas/CallRtmpBroadcastStoppedEvent"},{"$ref":"#/components/schemas/CallSessionEndedEvent"},{"$ref":"#/components/schemas/CallSessionParticipantCountsUpdatedEvent"},{"$ref":"#/components/schemas/CallSessionParticipantJoinedEvent"},{"$ref":"#/components/schemas/CallSessionParticipantLeftEvent"},{"$ref":"#/components/schemas/CallSessionStartedEvent"},{"$ref":"#/components/schemas/CallStatsReportReadyEvent"},{"$ref":"#/components/schemas/CallTranscriptionFailedEvent"},{"$ref":"#/components/schemas/CallTranscriptionReadyEvent"},{"$ref":"#/components/schemas/CallTranscriptionStartedEvent"},{"$ref":"#/components/schemas/CallTranscriptionStoppedEvent"},{"$ref":"#/components/schemas/CallUpdatedEvent"},{"$ref":"#/components/schemas/CallUserFeedbackSubmittedEvent"},{"$ref":"#/components/schemas/CallUserMutedEvent"},{"$ref":"#/components/schemas/ClosedCaptionEvent"},{"$ref":"#/components/schemas/CustomVideoEvent"},{"$ref":"#/components/schemas/KickedUserEvent"},{"$ref":"#/components/schemas/PermissionRequestEvent"},{"$ref":"#/components/schemas/UnblockedUserEvent"},{"$ref":"#/components/schemas/UpdatedCallPermissionsEvent"},{"$ref":"#/components/schemas/UserBannedEvent"},{"$ref":"#/components/schemas/UserDeactivatedEvent"},{"$ref":"#/components/schemas/UserMutedEvent"},{"$ref":"#/components/schemas/UserReactivatedEvent"},{"$ref":"#/components/schemas/UserUpdatedEvent"}]},"XiaomiConfig":{"properties":{"Disabled":{"type":"boolean","writeOnly":true,"x-stream-index":"003"},"package_name":{"type":"string","x-stream-index":"001"},"secret":{"type":"string","x-stream-index":"002"}},"type":"object"},"XiaomiConfigFields":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"package_name":{"type":"string","x-stream-index":"002"},"secret":{"type":"string","x-stream-index":"003"}},"required":["enabled"],"type":"object"}},"securitySchemes":{"JWT":{"description":"JWT should be always provided when stream-auth-type=jwt.\n\nUsing JWT auth request could be authenticated as user or as server-side.\n\nWhen using user authentication permission checking is going to be applied to requests based on the user that is\nperforming a request.\n\nThe `authorization` header should be a JWT string signed using the secret attached to the API key used to perform\nrequests.\n\n**WARNING** all client-side official SDK do not ship with token generation; this is to make sure that the API secret is not\nshared with an untrusted party such as a browser or a iOS/Android application. Tokens **must** be generated server-side.\nIf you wish, you can configure your application to ignore authentication (see `disable_auth_check`)\nThe JWT string must include only the user_id claim and can include any built-in JWT claim such as iat, exp as well.\n","in":"header","name":"Authorization","type":"apiKey"},"api_key":{"description":"Application API key should be always set in order to authenticate the request.","in":"query","name":"api_key","type":"apiKey"},"stream-auth-type":{"description":"Stream-Auth-Type should be always set in order to authenticate the request. Possible\nvalues: `jwt` or `anonymous`.\n\n`jwt` allows you to authenticate as a user. With this auth type you should also provide valid JWT in Authorization\nheader.\n\n`anonymous` allows you to authenticate as anonymous user. Please note that most advanced features are not available\nto anonymous users.","in":"header","name":"Stream-Auth-Type","type":"apiKey"}}},"info":{"title":"Stream API","version":"v191.1.0"},"openapi":"3.0.3","paths":{"/api/v2/app":{"get":{"description":"This Method returns the application settings\n","operationId":"GetApp","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetApplicationResponse"}}},"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":"Get App Settings","tags":["product:common"]},"patch":{"description":"This Method updates one or more application settings\n","operationId":"UpdateApp","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAppRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Update App Settings","tags":["product:common"]}},"/api/v2/blocklists":{"get":{"description":"Returns all available block lists\n","operationId":"ListBlockLists","parameters":[{"in":"query","name":"team","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListBlockListResponse"}}},"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":"List block lists","tags":["product:common"]},"post":{"description":"Creates a new application blocklist, once created the blocklist can be used by any channel type\n","operationId":"CreateBlockList","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBlockListRequest"}}},"description":"Block list","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBlockListResponse"}}},"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":"Create block list","tags":["product:common"]}},"/api/v2/blocklists/{name}":{"delete":{"description":"Deletes previously created application blocklist\n","operationId":"DeleteBlockList","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"team","schema":{"type":"string","x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete block list","tags":["product:common"]},"get":{"description":"Returns block list by given name\n","operationId":"GetBlockList","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Block list name","title":"Name","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"team","schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBlockListResponse"}}},"description":"GetBlockListResponse"},"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":"Get block list","tags":["product:common"]},"put":{"description":"Updates contents of the block list\n","operationId":"UpdateBlockList","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Block list name","title":"Name","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBlockListRequest"}}},"description":"Update block list","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBlockListResponse"}}},"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":"Update block list","tags":["product:common"]}},"/api/v2/check_push":{"post":{"description":"Sends a test message via push, this is a test endpoint to verify your push settings\n","operationId":"CheckPush","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckPushRequest"}}},"description":"CheckPushRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckPushResponse"}}},"description":"Successful 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":"Check push","tags":["product:common"]}},"/api/v2/check_sns":{"post":{"description":"Validates Amazon SNS configuration\n","operationId":"CheckSNS","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSNSRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSNSResponse"}}},"description":"Successful 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":"Check SNS","tags":["product:common"]}},"/api/v2/check_sqs":{"post":{"description":"Validates Amazon SQS credentials\n","operationId":"CheckSQS","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSQSRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSQSResponse"}}},"description":"Successful 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":"Check SQS","tags":["product:common"]}},"/api/v2/devices":{"delete":{"description":"Deletes one device\n","operationId":"DeleteDevice","parameters":[{"in":"query","name":"id","required":true,"schema":{"description":"Device ID to delete","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"user_id","schema":{"description":"**Server-side only**. User ID which server acts upon","title":"User ID","type":"string","writeOnly":true,"x-stream-index":"002.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete device","tags":["product:common"]},"get":{"description":"Returns all available devices\n","operationId":"ListDevices","parameters":[{"in":"query","name":"user_id","schema":{"description":"**Server-side only**. User ID which server acts upon","title":"User ID","type":"string","writeOnly":true,"x-stream-index":"001.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDevicesResponse"}}},"description":"ListDevicesResponse"},"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":"List devices","tags":["product:common"]},"post":{"description":"Adds a new device to a user, if the same device already exists the call will have no effect\n","operationId":"CreateDevice","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDeviceRequest"}}},"description":"CreateDeviceRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Create device","tags":["product:common"]}},"/api/v2/export/users":{"post":{"description":"Exports user profile, reactions and messages for list of given users\n","operationId":"ExportUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportUsersResponse"}}},"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":"Export users","tags":["product:common"]}},"/api/v2/external_storage":{"get":{"description":"Lists external storage\n","operationId":"ListExternalStorage","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListExternalStorageResponse"}}},"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":"List external storage","tags":["product:common"]},"post":{"description":"Creates new external storage\n","operationId":"CreateExternalStorage","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateExternalStorageRequest"}}},"description":"CreateExternalStorageRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateExternalStorageResponse"}}},"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":"Create external storage","tags":["product:common"]}},"/api/v2/external_storage/{name}":{"delete":{"description":"Deletes external storage\n","operationId":"DeleteExternalStorage","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteExternalStorageResponse"}}},"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":"Delete external storage","tags":["product:common"]},"put":{"description":"\n","operationId":"UpdateExternalStorage","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateExternalStorageRequest"}}},"description":"ExternalStorageRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateExternalStorageResponse"}}},"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":"Update External Storage","tags":["product:common"]}},"/api/v2/external_storage/{name}/check":{"get":{"description":"\n","operationId":"CheckExternalStorage","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckExternalStorageResponse"}}},"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":"Check External Storage","tags":["product:common"]}},"/api/v2/guest":{"post":{"description":"\n","operationId":"CreateGuest","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGuestRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGuestResponse"}}},"description":"Successful 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":"Create Guest","tags":["product:common"]}},"/api/v2/import_urls":{"post":{"description":"Creates a new import URL\n","operationId":"CreateImportURL","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateImportURLRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateImportURLResponse"}}},"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":"Create import URL","tags":["product:common"]}},"/api/v2/imports":{"get":{"description":"Gets an import\n","operationId":"ListImports","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListImportsResponse"}}},"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":"Get import","tags":["product:common"]},"post":{"description":"Creates a new import\n","operationId":"CreateImport","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateImportRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateImportResponse"}}},"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":"Create import","tags":["product:common"]}},"/api/v2/imports/{id}":{"get":{"description":"Gets an import\n","operationId":"GetImport","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetImportResponse"}}},"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":"Get import","tags":["product:common"]}},"/api/v2/og":{"get":{"description":"Get an OpenGraph attachment for a link\n","operationId":"GetOG","parameters":[{"in":"query","name":"url","required":true,"schema":{"description":"URL to be scraped","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOGResponse"}}},"description":"Get OG Attachment"},"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":"Get OG","tags":["product:common"]}},"/api/v2/permissions":{"get":{"description":"Lists all available permissions\n","operationId":"ListPermissions","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPermissionsResponse"}}},"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":"List permissions","tags":["product:common"]}},"/api/v2/permissions/{id}":{"get":{"description":"Gets custom permission\n","operationId":"GetPermission","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Permission ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCustomPermissionResponse"}}},"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":"Get permission","tags":["product:common"]}},"/api/v2/polls":{"post":{"description":"Creates a new poll\n","operationId":"CreatePoll","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePollRequest"}}},"description":"Create Poll Request","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Create poll","tags":["product:common"]},"put":{"description":"Updates a poll\n\nSends events:\n- feeds.poll.closed\n- feeds.poll.updated\n- poll.closed\n- poll.updated\n","operationId":"UpdatePoll","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePollRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Update poll","tags":["product:common"]}},"/api/v2/polls/query":{"post":{"description":"Queries polls\n","operationId":"QueryPolls","parameters":[{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryPollsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryPollsResponse"}}},"description":"Successful 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":"Query polls","tags":["product:common"]}},"/api/v2/polls/{poll_id}":{"delete":{"description":"Deletes a poll\n\nSends events:\n- feeds.poll.deleted\n- poll.deleted\n","operationId":"DeletePoll","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete poll","tags":["product:common"]},"get":{"description":"Retrieves a poll\n","operationId":"GetPoll","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Get poll","tags":["product:common"]},"patch":{"description":"Updates a poll partially\n\nSends events:\n- feeds.poll.closed\n- feeds.poll.updated\n- poll.closed\n- poll.updated\n","operationId":"UpdatePollPartial","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePollPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollResponse"}}},"description":"Successful 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":"Partial update poll","tags":["product:common"]}},"/api/v2/polls/{poll_id}/options":{"post":{"description":"Creates a poll option\n\nSends events:\n- feeds.poll.updated\n- poll.updated\n","operationId":"CreatePollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePollOptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollOptionResponse"}}},"description":"Successful 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":"Create poll option","tags":["product:common"]},"put":{"description":"Updates a poll option\n\nSends events:\n- feeds.poll.updated\n- poll.updated\n","operationId":"UpdatePollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePollOptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollOptionResponse"}}},"description":"Successful 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":"Update poll option","tags":["product:common"]}},"/api/v2/polls/{poll_id}/options/{option_id}":{"delete":{"description":"Deletes a poll option\n\nSends events:\n- feeds.poll.updated\n- poll.updated\n","operationId":"DeletePollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"path","name":"option_id","required":true,"schema":{"description":"Option ID","maxLength":255,"title":"string","type":"string","x-stream-index":"003"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete poll option","tags":["product:common"]},"get":{"description":"Retrieves a poll option\n","operationId":"GetPollOption","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"path","name":"option_id","required":true,"schema":{"description":"Option ID","maxLength":255,"title":"string","type":"string","x-stream-index":"003"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollOptionResponse"}}},"description":"Successful 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":"Get poll option","tags":["product:common"]}},"/api/v2/polls/{poll_id}/votes":{"post":{"description":"Queries votes\n","operationId":"QueryPollVotes","parameters":[{"in":"path","name":"poll_id","required":true,"schema":{"description":"Poll ID","maxLength":255,"title":"string","type":"string","x-stream-index":"002"}},{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryPollVotesRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PollVotesResponse"}}},"description":"Successful 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":"Query votes","tags":["product:common"]}},"/api/v2/push_providers":{"get":{"description":"List details of all push providers.\n","operationId":"ListPushProviders","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPushProvidersResponse"}}},"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":"List push providers","tags":["product:common"]},"post":{"description":"Upsert a push provider for v2 with multi bundle/package support\n","operationId":"UpsertPushProvider","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertPushProviderRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertPushProviderResponse"}}},"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":"Upsert a push provider","tags":["product:common"]}},"/api/v2/push_providers/{type}/{name}":{"delete":{"description":"Delete a push provider from v2 with multi bundle/package support. v1 isn't supported in this endpoint\n","operationId":"DeletePushProvider","parameters":[{"in":"path","name":"type","required":true,"schema":{"enum":["apn","firebase","huawei","xiaomi"],"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"name","required":true,"schema":{"maxLength":36,"minLength":1,"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete a push provider","tags":["product:common"]}},"/api/v2/rate_limits":{"get":{"description":"Get rate limits usage and quotas\n","operationId":"GetRateLimits","parameters":[{"in":"query","name":"server_side","schema":{"description":"Whether to include server-side platform limits or not","title":"Server-side","type":"boolean","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"android","schema":{"description":"Whether to include Android platform limits or not","title":"Android","type":"boolean","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"ios","schema":{"description":"Whether to include iOS platform limits or not","title":"iOS","type":"boolean","writeOnly":true,"x-stream-index":"003"}},{"in":"query","name":"web","schema":{"description":"Whether to include web platform limits or not","title":"Web","type":"boolean","writeOnly":true,"x-stream-index":"004"}},{"in":"query","name":"endpoints","schema":{"description":"Specific endpoints to show limits for, as a comma-separated list of values","title":"Endpoints","type":"string","writeOnly":true,"x-stream-index":"005"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRateLimitsResponse"}}},"description":"Get Rate Limits 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":"Get rate limits","tags":["product:common"]}},"/api/v2/roles":{"get":{"description":"Lists all available roles\n","operationId":"ListRoles","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListRolesResponse"}}},"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":"List roles","tags":["product:common"]},"post":{"description":"Creates custom role\n","operationId":"CreateRole","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRoleRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRoleResponse"}}},"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":"Create role","tags":["product:common"]}},"/api/v2/roles/{name}":{"delete":{"description":"Deletes custom role\n","operationId":"DeleteRole","parameters":[{"in":"path","name":"name","required":true,"schema":{"description":"Role name","title":"Name","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete role","tags":["product:common"]}},"/api/v2/tasks/{id}":{"get":{"description":"Gets status of a task\n","operationId":"GetTask","parameters":[{"in":"path","name":"id","required":true,"schema":{"description":"Task ID","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetTaskResponse"}}},"description":"Get Task 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":"Get status of a task","tags":["product:common"]}},"/api/v2/uploads/file":{"delete":{"description":"Deletes previously uploaded file\n","operationId":"DeleteFileGlobal","parameters":[{"in":"query","name":"url","schema":{"description":"File URL to delete","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete file","tags":["product:common"],"x-stream-sdk-name":"DeleteFile"},"post":{"description":"Uploads file\n","operationId":"UploadFileGlobal","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/FileUploadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileUploadResponse"}}},"description":"Successful 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":"Upload file","tags":["product:common"],"x-stream-sdk-name":"UploadFile"}},"/api/v2/uploads/image":{"delete":{"description":"Deletes previously uploaded image\n","operationId":"DeleteImageGlobal","parameters":[{"in":"query","name":"url","schema":{"description":"File URL to delete","title":"URL","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete image","tags":["product:common"],"x-stream-sdk-name":"DeleteImage"},"post":{"description":"Uploads image\n","operationId":"UploadImageGlobal","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/ImageUploadRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageUploadResponse"}}},"description":"Successful 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":"Upload image","tags":["product:common"],"x-stream-sdk-name":"UploadImage"}},"/api/v2/users":{"get":{"description":"Find and filter users\n","operationId":"QueryUsers","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryUsersPayload","x-stream-index":"001"}}},"in":"query","name":"payload"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryUsersResponse"}}},"description":"Successful 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":"Query users","tags":["product:common"]},"patch":{"description":"Updates certain fields of the user\n\nSends events:\n- user.presence.changed\n- user.updated\n- user.presence.changed\n","operationId":"UpdateUsersPartial","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersPartialRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersResponse"}}},"description":"Successful 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":"Partially update user","tags":["product:common"]},"post":{"description":"Update or create users in bulk\n\nSends events:\n- user.updated\n","operationId":"UpdateUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUsersResponse"}}},"description":"Successful 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":"Upsert users","tags":["product:common"]}},"/api/v2/users/block":{"get":{"description":"Get list of blocked Users\n","operationId":"GetBlockedUsers","parameters":[{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"002.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBlockedUsersResponse"}}},"description":"Successful 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":"Get list of blocked Users","tags":["product:common"]},"post":{"description":"Block users\n","operationId":"BlockUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUsersResponse"}}},"description":"Successful 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":"Block user","tags":["product:common"]}},"/api/v2/users/deactivate":{"post":{"description":"Deactivate users in batches\n\nSends events:\n- user.deactivated\n","operationId":"DeactivateUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeactivateUsersRequest"}}},"description":"DeactivateUsersRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeactivateUsersResponse"}}},"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":"Deactivate users","tags":["product:common"]}},"/api/v2/users/delete":{"post":{"description":"Deletes users and optionally all their belongings asynchronously.\n\nSends events:\n- channel.deleted\n- user.deleted\n","operationId":"DeleteUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteUsersResponse"}}},"description":"Successful 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":"Delete Users","tags":["product:common"]}},"/api/v2/users/live_locations":{"get":{"description":"Retrieves all active live locations for a user\n","operationId":"GetUserLiveLocations","parameters":[{"in":"query","name":"user_id","schema":{"description":"User ID to get live locations for. If not provided, returns live locations for the authenticated user.","title":"string","type":"string","writeOnly":true,"x-stream-index":"001.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SharedLocationsResponse"}}},"description":"Successful 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":"Get user live locations","tags":["product:common"]},"put":{"description":"Updates an existing live location with new coordinates or expiration time\n","operationId":"UpdateLiveLocation","parameters":[{"in":"query","name":"user_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"005.001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateLiveLocationRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SharedLocationResponse"}}},"description":"Successful 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":"Update live location","tags":["product:common"]}},"/api/v2/users/reactivate":{"post":{"description":"Reactivate users in batches\n\nSends events:\n- user.reactivated\n- user.reactivated\n","operationId":"ReactivateUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReactivateUsersRequest"}}},"description":"ReactivateUsersRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReactivateUsersResponse"}}},"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":"Reactivate users","tags":["product:common"]}},"/api/v2/users/restore":{"post":{"description":"Restore soft deleted users\n","operationId":"RestoreUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestoreUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Restore users","tags":["product:common"]}},"/api/v2/users/unblock":{"post":{"description":"Unblock users\n","operationId":"UnblockUsers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUsersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUsersResponse"}}},"description":"Successful 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":"Unblock user","tags":["product:common"]}},"/api/v2/users/{user_id}/deactivate":{"post":{"description":"Deactivates user with possibility to activate it back\n\nSends events:\n- user.deactivated\n","operationId":"DeactivateUser","parameters":[{"in":"path","name":"user_id","required":true,"schema":{"title":"User ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeactivateUserRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeactivateUserResponse"}}},"description":"Successful 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":"Deactivate user","tags":["product:common"]}},"/api/v2/users/{user_id}/export":{"get":{"description":"Exports the user's profile, reactions and messages. Raises an error if a user has more than 10k messages or reactions\n","operationId":"ExportUser","parameters":[{"in":"path","name":"user_id","required":true,"schema":{"title":"User ID","type":"string","x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportUserResponse"}}},"description":"Successful 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":"Export user","tags":["product:common"]}},"/api/v2/users/{user_id}/reactivate":{"post":{"description":"Activates user who's been deactivated previously\n\nSends events:\n- user.reactivated\n","operationId":"ReactivateUser","parameters":[{"in":"path","name":"user_id","required":true,"schema":{"title":"User ID","type":"string","x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReactivateUserRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReactivateUserResponse"}}},"description":"Successful 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":"Reactivate user","tags":["product:common"]}},"/api/v2/video/active_calls_status":{"get":{"description":"Get the current status of all active calls including metrics and summary information\n","operationId":"GetActiveCallsStatus","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetActiveCallsStatusResponse"}}},"description":"GetActiveCallsStatusResponse"},"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":"Get active calls status","tags":["product:video"]}},"/api/v2/video/call/feedback":{"post":{"description":"\n","operationId":"QueryUserFeedback","parameters":[{"in":"query","name":"full","schema":{"type":"boolean","writeOnly":true,"x-stream-index":"003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryUserFeedbackRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryUserFeedbackResponse"}}},"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":"Query user reported feedback for the calls","tags":["product:video"]}},"/api/v2/video/call/members":{"post":{"description":"Query call members with filter query\n","operationId":"QueryCallMembers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallMembersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallMembersResponse"}}},"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":"Query call members","tags":["product:video"]}},"/api/v2/video/call/stats":{"post":{"description":"\n","operationId":"QueryCallStats","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallStatsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallStatsResponse"}}},"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":"Query Call Stats","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}":{"get":{"description":"\n","operationId":"GetCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"query","name":"members_limit","schema":{"format":"int32","maximum":100,"minimum":0,"type":"integer","writeOnly":true,"x-stream-index":"004"}},{"in":"query","name":"ring","schema":{"type":"boolean","writeOnly":true,"x-stream-index":"005"}},{"in":"query","name":"notify","schema":{"type":"boolean","writeOnly":true,"x-stream-index":"006"}},{"in":"query","name":"video","schema":{"type":"boolean","writeOnly":true,"x-stream-index":"007"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCallResponse"}}},"description":"GetCallResponse"},"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":"Get Call","tags":["product:video"]},"patch":{"description":"\n\nSends events:\n- call.updated\n","operationId":"UpdateCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallRequest"}}},"description":"UpdateCallRequest","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallResponse"}}},"description":"UpdateCallResponse"},"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":"Update Call","tags":["product:video"]},"post":{"description":"Gets or creates a new call\n\nSends events:\n- call.created\n- call.notification\n- call.ring\n","operationId":"GetOrCreateCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrCreateCallRequest"}}},"description":"GetOrCreateCallRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrCreateCallResponse"}}},"description":"GetOrCreateCallResponse"},"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":"Get or create a call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/block":{"post":{"description":"Block a user, preventing them from joining the call until they are unblocked.\n\nSends events:\n- call.blocked_user\n","operationId":"BlockUser","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUserRequest"}}},"description":"BlockUserRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUserResponse"}}},"description":"BlockUserResponse"},"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":"Block user on a call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/delete":{"post":{"description":"\n\nSends events:\n- call.deleted\n","operationId":"DeleteCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCallRequest"}}},"description":"DeleteCallRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCallResponse"}}},"description":"DeleteCallResponse"},"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":"Delete Call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/event":{"post":{"description":"Sends custom event to the call\n\nSends events:\n- custom\n","operationId":"SendCallEvent","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendCallEventRequest"}}},"description":"SendCallEventRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendCallEventResponse"}}},"description":"SendCallEventResponse"},"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":"Send custom event","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/feedback":{"post":{"description":"\n\nSends events:\n- call.user_feedback_submitted\n","operationId":"CollectUserFeedback","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectUserFeedbackRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectUserFeedbackResponse"}}},"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":"Collect user feedback","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/go_live":{"post":{"description":"\n\nSends events:\n- call.live_started\n","operationId":"GoLive","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoLiveRequest"}}},"description":"GoLiveRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoLiveResponse"}}},"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":"Set call as live","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/kick":{"post":{"description":"Kicks a user from the call. Optionally block the user from rejoining by setting block=true.\n\nSends events:\n- call.blocked_user\n- call.kicked_user\n","operationId":"KickUser","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KickUserRequest"}}},"description":"KickUserRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KickUserResponse"}}},"description":"KickUserResponse"},"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":"Kick user from a call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/mark_ended":{"post":{"description":"\n\nSends events:\n- call.ended\n","operationId":"EndCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EndCallResponse"}}},"description":"EndCallResponse"},"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":"End call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/members":{"post":{"description":"\n\nSends events:\n- call.member_added\n- call.member_removed\n- call.member_updated\n","operationId":"UpdateCallMembers","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallMembersRequest"}}},"description":"UpdateCallMembersRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallMembersResponse"}}},"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":"Update Call Member","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/mute_users":{"post":{"description":"Mutes users in a call\n","operationId":"MuteUsers","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteUsersRequest"}}},"description":"MuteUsersRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteUsersResponse"}}},"description":"MuteUsersResponse"},"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":"Mute users","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/participants":{"post":{"description":"Returns a list of participants connected to the call\n","operationId":"QueryCallParticipants","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"type","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"limit","schema":{"format":"int32","maximum":100,"type":"integer","x-stream-index":"004"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallParticipantsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallParticipantsResponse"}}},"description":"Successful 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":"Query call participants","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/pin":{"post":{"description":"Pins a track for all users in the call.\n","operationId":"VideoPin","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PinRequest"}}},"description":"PinRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PinResponse"}}},"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":"Pin","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/recordings":{"get":{"description":"Lists recordings\n","operationId":"ListRecordings","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListRecordingsResponse"}}},"description":"ListRecordingsResponse"},"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":"List recordings","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/report":{"get":{"description":"\n","operationId":"GetCallReport","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"query","name":"session_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCallReportResponse"}}},"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":"Get call report","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/rtmp_broadcasts":{"post":{"description":"Starts RTMP broadcasts for the provided RTMP destinations\n","operationId":"StartRTMPBroadcasts","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRTMPBroadcastsRequest"}}},"description":"StartRTMPBroadcastsRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRTMPBroadcastsResponse"}}},"description":"StartRTMPBroadcastsResponse"},"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":"Start RTMP broadcasts","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/rtmp_broadcasts/stop":{"post":{"description":"Stop all RTMP broadcasts for the provided call\n","operationId":"StopAllRTMPBroadcasts","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopAllRTMPBroadcastsResponse"}}},"description":"StopAllRTMPBroadcastsResponse"},"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":"Stop all RTMP broadcasts for a call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/rtmp_broadcasts/{name}/stop":{"post":{"description":"Stop RTMP broadcasts for the provided RTMP destinations\n","operationId":"StopRTMPBroadcast","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopRTMPBroadcastsRequest"}}},"description":"StopRTMPBroadcastsRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopRTMPBroadcastsResponse"}}},"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":"Stop RTMP broadcasts","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/start_broadcasting":{"post":{"description":"Starts HLS broadcasting\n","operationId":"StartHLSBroadcasting","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartHLSBroadcastingResponse"}}},"description":"StartHLSBroadcastingResponse"},"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":"Start HLS broadcasting","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/start_closed_captions":{"post":{"description":"Starts closed captions\n","operationId":"StartClosedCaptions","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartClosedCaptionsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartClosedCaptionsResponse"}}},"description":"Successful 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":"Start closed captions","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/start_frame_recording":{"post":{"description":"Starts frame by frame recording\n\nSends events:\n- call.frame_recording_started\n","operationId":"StartFrameRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartFrameRecordingRequest"}}},"description":"StartFrameRecordingRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartFrameRecordingResponse"}}},"description":"StartFrameRecordingResponse"},"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":"Start frame recording","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/start_recording":{"post":{"description":"Starts recording\n\nSends events:\n- call.recording_started\n","operationId":"StartRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRecordingRequest"}}},"description":"StartRecordingRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRecordingResponse"}}},"description":"StartRecordingResponse"},"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":"Start recording","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/start_transcription":{"post":{"description":"Starts transcription\n","operationId":"StartTranscription","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartTranscriptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartTranscriptionResponse"}}},"description":"StartTranscriptionResponse"},"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":"Start transcription","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_broadcasting":{"post":{"description":"Stops HLS broadcasting\n","operationId":"StopHLSBroadcasting","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopHLSBroadcastingResponse"}}},"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":"Stop HLS broadcasting","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_closed_captions":{"post":{"description":"Stops closed captions\n\nSends events:\n- call.transcription_stopped\n","operationId":"StopClosedCaptions","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopClosedCaptionsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopClosedCaptionsResponse"}}},"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":"Stop closed captions","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_frame_recording":{"post":{"description":"Stops frame recording\n\nSends events:\n- call.frame_recording_stopped\n","operationId":"StopFrameRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopFrameRecordingResponse"}}},"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":"Stop frame recording","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_live":{"post":{"description":"\n\nSends events:\n- call.updated\n","operationId":"StopLive","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopLiveRequest"}}},"description":"StopLiveRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopLiveResponse"}}},"description":"StopLiveResponse"},"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":"Set call as not live","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_recording":{"post":{"description":"Stops recording\n\nSends events:\n- call.recording_stopped\n","operationId":"StopRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopRecordingResponse"}}},"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":"Stop recording","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/stop_transcription":{"post":{"description":"Stops transcription\n\nSends events:\n- call.transcription_stopped\n","operationId":"StopTranscription","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopTranscriptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopTranscriptionResponse"}}},"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":"Stop transcription","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/transcriptions":{"get":{"description":"Lists transcriptions\n","operationId":"ListTranscriptions","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTranscriptionsResponse"}}},"description":"ListTranscriptionsResponse"},"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":"List transcriptions","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/unblock":{"post":{"description":"Removes the block for a user on a call. The user will be able to join the call again.\n\nSends events:\n- call.unblocked_user\n","operationId":"UnblockUser","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUserRequest"}}},"description":"UnblockUserRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUserResponse"}}},"description":"UnblockUserResponse"},"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":"Unblocks user on a call","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/unpin":{"post":{"description":"Unpins a track for all users in the call.\n","operationId":"VideoUnpin","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnpinRequest"}}},"description":"UnpinRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnpinResponse"}}},"description":"UnpinResponse"},"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":"Unpin","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/user_permissions":{"post":{"description":"Updates user permissions\n\nSends events:\n- call.permissions_updated\n","operationId":"UpdateUserPermissions","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"005.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"005.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUserPermissionsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUserPermissionsResponse"}}},"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":"Update user permissions","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/{session}/recordings/{filename}":{"delete":{"description":"Deletes recording\n","operationId":"DeleteRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"path","name":"session","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"003"}},{"in":"path","name":"filename","required":true,"schema":{"maxLength":256,"type":"string","writeOnly":true,"x-stream-index":"004"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteRecordingResponse"}}},"description":"DeleteRecordingResponse"},"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":"Delete recording","tags":["product:video"]}},"/api/v2/video/call/{type}/{id}/{session}/transcriptions/{filename}":{"delete":{"description":"Deletes transcription\n","operationId":"DeleteTranscription","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"path","name":"session","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"003"}},{"in":"path","name":"filename","required":true,"schema":{"maxLength":256,"type":"string","writeOnly":true,"x-stream-index":"004"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteTranscriptionResponse"}}},"description":"DeleteTranscriptionResponse"},"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":"Delete transcription","tags":["product:video"]}},"/api/v2/video/calls":{"post":{"description":"Query calls with filter query\n","operationId":"QueryCalls","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallsRequest"}}},"description":"QueryCallsRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallsResponse"}}},"description":"QueryCallsResponse"},"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":"Query call","tags":["product:video"]}},"/api/v2/video/calltypes":{"get":{"description":"\n","operationId":"ListCallTypes","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListCallTypeResponse"}}},"description":"ListCallTypeResponse"},"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":"List Call Type","tags":["product:video"]},"post":{"description":"\n","operationId":"CreateCallType","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCallTypeRequest"}}},"description":"CreateCallTypeRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCallTypeResponse"}}},"description":"CreateCallTypeResponse"},"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":"Create Call Type","tags":["product:video"]}},"/api/v2/video/calltypes/{name}":{"delete":{"description":"\n","operationId":"DeleteCallType","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete Call Type","tags":["product:video"]},"get":{"description":"\n","operationId":"GetCallType","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCallTypeResponse"}}},"description":"GetCallTypeResponse"},"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":"Get Call Type","tags":["product:video"]},"put":{"description":"\n","operationId":"UpdateCallType","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallTypeRequest"}}},"description":"UpdateCallTypeRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallTypeResponse"}}},"description":"UpdateCallTypeResponse"},"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":"Update Call Type","tags":["product:video"]}},"/api/v2/video/edges":{"get":{"description":"Returns the list of all edges available for video calls.\n","operationId":"GetEdges","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetEdgesResponse"}}},"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":"Get Edges","tags":["product:video"]}},"/api/v2/video/stats":{"post":{"description":"\n","operationId":"QueryAggregateCallStats","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryAggregateCallStatsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryAggregateCallStatsResponse"}}},"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":"Query Aggregate call Stats","tags":["product:video"]}}},"security":[{"JWT":[],"api_key":[],"stream-auth-type":[]},{"api_key":[],"stream-auth-type":[]}],"servers":[{"description":"Stream API","url":"https://chat.stream-io-api.com"}]} \ No newline at end of file diff --git a/openapi/v2/video-serverside-api.yaml b/openapi/v2/video-serverside-api.yaml index 319d5795d..ed3ff569d 100644 --- a/openapi/v2/video-serverside-api.yaml +++ b/openapi/v2/video-serverside-api.yaml @@ -183,6 +183,20 @@ components: - text - type type: object + ActiveCallsBitrateStats: + properties: + p10: + format: float + type: number + x-stream-index: "001" + p50: + format: float + type: number + x-stream-index: "002" + required: + - p10 + - p50 + type: object ActiveCallsFPSStats: properties: p05: @@ -233,6 +247,20 @@ components: $ref: '#/components/schemas/SubscribersMetrics' x-stream-index: "003" type: object + ActiveCallsResolutionStats: + properties: + p10: + format: float + type: number + x-stream-index: "001" + p50: + format: float + type: number + x-stream-index: "002" + required: + - p10 + - p50 + type: object ActiveCallsSummary: properties: active_calls: @@ -348,6 +376,9 @@ components: moderation_enabled: type: boolean x-stream-index: "041" + moderation_llm_configurability_enabled: + type: boolean + x-stream-index: "049" moderation_multitenant_blocklist_enabled: type: boolean x-stream-index: "042" @@ -469,6 +500,7 @@ components: - use_hook_v2 - user_response_time_enabled - moderation_bulk_submit_action_enabled + - moderation_llm_configurability_enabled type: object AsyncExportChannelsEvent: nullable: true @@ -3519,7 +3551,7 @@ components: x-stream-index: "001.002" type: default: call.updated - description: 'The type of event: "call.ended" in this case' + description: 'The type of event: "call.updated" in this case' title: Event Type type: string x-stream-index: "001.001" @@ -3723,6 +3755,14 @@ components: $ref: '#/components/schemas/ChannelMember' type: array x-stream-index: "020" + message_count: + format: int64 + type: integer + x-stream-index: "035" + message_count_updated_at: + format: date-time + type: number + x-stream-index: "036" team: type: string x-stream-index: "028" @@ -3753,39 +3793,39 @@ components: items: type: string type: array - x-stream-index: "001.026" + x-stream-index: "001.027" automod: enum: - disabled - simple - AI type: string - x-stream-index: "001.021" + x-stream-index: "001.022" automod_behavior: enum: - flag - block - shadow_block type: string - x-stream-index: "001.022" + x-stream-index: "001.023" automod_thresholds: $ref: '#/components/schemas/Thresholds' - x-stream-index: "001.027" + x-stream-index: "001.028" blocklist: type: string - x-stream-index: "001.023" + x-stream-index: "001.024" blocklist_behavior: enum: - flag - block - shadow_block type: string - x-stream-index: "001.024" + x-stream-index: "001.025" blocklists: items: $ref: '#/components/schemas/BlockListOptions' type: array - x-stream-index: "001.025" + x-stream-index: "001.026" commands: items: type: string @@ -3794,6 +3834,9 @@ components: connect_events: type: boolean x-stream-index: "001.004" + count_messages: + type: boolean + x-stream-index: "001.019" created_at: format: date-time type: number @@ -3808,7 +3851,7 @@ components: format: int32 maximum: 20000 type: integer - x-stream-index: "001.020" + x-stream-index: "001.021" mutes: type: boolean x-stream-index: "001.009" @@ -3818,10 +3861,10 @@ components: partition_size: format: int32 type: integer - x-stream-index: "001.028" + x-stream-index: "001.029" partition_ttl: type: integer - x-stream-index: "001.029" + x-stream-index: "001.030" polls: type: boolean x-stream-index: "001.016" @@ -3851,7 +3894,7 @@ components: x-stream-index: "001.018" skip_last_msg_update_for_system_msgs: type: boolean - x-stream-index: "001.030" + x-stream-index: "001.031" typing_events: type: boolean x-stream-index: "001.002" @@ -3887,6 +3930,7 @@ components: - polls - user_message_reminders - shared_locations + - count_messages - message_retention - max_message_length - automod @@ -3902,39 +3946,39 @@ components: items: type: string type: array - x-stream-index: 001.002.026 + x-stream-index: 001.002.027 automod: enum: - disabled - simple - AI type: string - x-stream-index: 001.002.021 + x-stream-index: 001.002.022 automod_behavior: enum: - flag - block - shadow_block type: string - x-stream-index: 001.002.022 + x-stream-index: 001.002.023 automod_thresholds: $ref: '#/components/schemas/Thresholds' - x-stream-index: 001.002.027 + x-stream-index: 001.002.028 blocklist: type: string - x-stream-index: 001.002.023 + x-stream-index: 001.002.024 blocklist_behavior: enum: - flag - block - shadow_block type: string - x-stream-index: 001.002.024 + x-stream-index: 001.002.025 blocklists: items: $ref: '#/components/schemas/BlockListOptions' type: array - x-stream-index: 001.002.025 + x-stream-index: 001.002.026 commands: items: $ref: '#/components/schemas/Command' @@ -3943,6 +3987,9 @@ components: connect_events: type: boolean x-stream-index: 001.002.004 + count_messages: + type: boolean + x-stream-index: 001.002.019 created_at: format: date-time type: number @@ -3964,7 +4011,7 @@ components: format: int32 maximum: 20000 type: integer - x-stream-index: 001.002.020 + x-stream-index: 001.002.021 mutes: type: boolean x-stream-index: 001.002.009 @@ -3974,13 +4021,13 @@ components: partition_size: format: int32 type: integer - x-stream-index: 001.002.028 + x-stream-index: 001.002.029 partition_ttl: example: 24h format: duration nullable: true type: string - x-stream-index: 001.002.029 + x-stream-index: 001.002.030 polls: type: boolean x-stream-index: 001.002.016 @@ -4010,7 +4057,7 @@ components: x-stream-index: 001.002.018 skip_last_msg_update_for_system_msgs: type: boolean - x-stream-index: 001.002.030 + x-stream-index: 001.002.031 typing_events: type: boolean x-stream-index: 001.002.002 @@ -4048,6 +4095,7 @@ components: - polls - user_message_reminders - shared_locations + - count_messages - message_retention - max_message_length - automod @@ -4092,6 +4140,11 @@ components: format: date-time type: number x-stream-index: "011" + deleted_messages: + items: + type: string + type: array + x-stream-index: "020" invite_accepted_at: description: Date when invite was accepted format: date-time @@ -4339,6 +4392,12 @@ components: title: ChannelMembers type: array x-stream-index: "011" + message_count: + description: Number of messages in the channel + format: int64 + title: Message count + type: integer + x-stream-index: "027" mute_expires_at: description: Date of mute expiration format: date-time @@ -4781,6 +4840,9 @@ components: type: string type: array x-stream-index: "011" + count_messages: + type: boolean + x-stream-index: "014" grants: additionalProperties: items: @@ -5970,11 +6032,11 @@ components: properties: callback: $ref: '#/components/schemas/AsyncModerationCallbackConfig' - x-stream-index: 018.001.002 + x-stream-index: 019.001.002 created_at: format: date-time type: number - x-stream-index: "019" + x-stream-index: "020" enabled: type: boolean x-stream-index: "003" @@ -5989,6 +6051,9 @@ components: id: type: string x-stream-index: "001" + product: + type: string + x-stream-index: "018" sns_auth_type: type: string x-stream-index: "014" @@ -6028,11 +6093,11 @@ components: timeout_ms: format: int32 type: integer - x-stream-index: 018.001.001 + x-stream-index: 019.001.001 updated_at: format: date-time type: number - x-stream-index: "020" + x-stream-index: "021" webhook_url: type: string x-stream-index: "005" @@ -7637,6 +7702,86 @@ components: - total - failures type: object + KickUserRequest: + description: KickUserRequest is the payload for kicking a user from a call. + Optionally block the user as well. + nullable: true + properties: + block: + description: If true, also block the user from rejoining the call + title: Block + type: boolean + x-stream-index: "004" + kicked_by: + $ref: '#/components/schemas/UserRequest' + description: 'Server-side: user performing the action' + title: KickedBy + x-stream-index: "006" + kicked_by_id: + description: 'Server-side: ID of the user performing the action' + title: KickedByID + type: string + x-stream-index: "005" + user_id: + description: The user to kick + title: UserID + type: string + x-stream-index: "003" + required: + - user_id + title: KickUserRequest + type: object + KickUserResponse: + description: KickUserResponse is the payload for kicking a user from a call. + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "001.001" + required: + - duration + title: KickUserResponse + type: object + KickedUserEvent: + description: This event is sent to call participants to notify when a user is + kicked from a call. Clients should make the kicked user leave the call UI. + properties: + call_cid: + type: string + x-stream-index: "002.001" + created_at: + format: date-time + type: number + x-stream-index: "001.002" + kicked_by_user: + $ref: '#/components/schemas/UserResponse' + description: The user that kicked the participant, null if server-side + title: Kicked by + x-stream-index: "004" + type: + default: call.kicked_user + description: 'The type of event: "call.kicked_user" in this case' + title: Event Type + type: string + x-stream-index: "001.001" + user: + $ref: '#/components/schemas/UserResponse' + description: The user that was kicked + title: User + x-stream-index: "003" + required: + - type + - created_at + - call_cid + - user + title: KickedUserEvent + type: object + x-stream-event-call-type: true + x-stream-event-doc-group: call + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent LabelThresholds: properties: block: @@ -8111,6 +8256,9 @@ components: format: date-time type: number x-stream-index: "033" + deleted_for_me: + type: boolean + x-stream-index: "059" deleted_reply_count: format: int32 type: integer @@ -8350,6 +8498,9 @@ components: title: Deleted at type: number x-stream-index: "025" + deleted_for_me: + type: boolean + x-stream-index: "044" deleted_reply_count: format: int32 type: integer @@ -8773,6 +8924,7 @@ components: - join-backstage - join-call - join-ended-call + - kick-user - mute-users - pin-for-everyone - read-call @@ -9569,6 +9721,9 @@ components: type: object PublisherVideoMetrics: properties: + bitrate: + $ref: '#/components/schemas/ActiveCallsBitrateStats' + x-stream-index: "005" fps_30: $ref: '#/components/schemas/ActiveCallsFPSStats' x-stream-index: "002" @@ -9578,6 +9733,9 @@ components: jitter_ms: $ref: '#/components/schemas/ActiveCallsLatencyStats' x-stream-index: "001" + resolution: + $ref: '#/components/schemas/ActiveCallsResolutionStats' + x-stream-index: "004" type: object PublishersMetrics: properties: @@ -9853,6 +10011,12 @@ components: - message.updated - reaction.new - notification.reminder_due + - feeds.activity.added + - feeds.comment.added + - feeds.activity.reaction.added + - feeds.comment.reaction.added + - feeds.follow.created + - feeds.notification_feed.updated type: string x-stream-index: "005" template: @@ -12339,6 +12503,10 @@ components: image_upload_config: $ref: '#/components/schemas/FileUploadConfig' x-stream-index: "001.029" + max_aggregated_activities_length: + format: int32 + type: integer + x-stream-index: "001.049" migrate_permissions_to_v2: type: boolean x-stream-index: "001.035" @@ -13804,6 +13972,7 @@ components: call.hls_broadcasting_failed: '#/components/schemas/CallHLSBroadcastingFailedEvent' call.hls_broadcasting_started: '#/components/schemas/CallHLSBroadcastingStartedEvent' call.hls_broadcasting_stopped: '#/components/schemas/CallHLSBroadcastingStoppedEvent' + call.kicked_user: '#/components/schemas/KickedUserEvent' call.live_started: '#/components/schemas/CallLiveStartedEvent' call.member_added: '#/components/schemas/CallMemberAddedEvent' call.member_removed: '#/components/schemas/CallMemberRemovedEvent' @@ -13904,6 +14073,7 @@ components: - $ref: '#/components/schemas/CallUserMutedEvent' - $ref: '#/components/schemas/ClosedCaptionEvent' - $ref: '#/components/schemas/CustomVideoEvent' + - $ref: '#/components/schemas/KickedUserEvent' - $ref: '#/components/schemas/PermissionRequestEvent' - $ref: '#/components/schemas/UnblockedUserEvent' - $ref: '#/components/schemas/UpdatedCallPermissionsEvent' @@ -13980,7 +14150,7 @@ components: type: apiKey info: title: Stream API - version: v187.13.0 + version: v191.1.0 openapi: 3.0.3 paths: /api/v2/app: @@ -17040,6 +17210,65 @@ paths: summary: Set call as live tags: - product:video + /api/v2/video/call/{type}/{id}/kick: + post: + description: | + Kicks a user from the call. Optionally block the user from rejoining by setting block=true. + + Sends events: + - call.blocked_user + - call.kicked_user + operationId: KickUser + parameters: + - in: path + name: type + required: true + schema: + description: The type of call + maxLength: 64 + title: Type + type: string + writeOnly: true + x-stream-index: "002.001" + - in: path + name: id + required: true + schema: + description: Call ID + maxLength: 64 + title: ID + type: string + writeOnly: true + x-stream-index: "002.002" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/KickUserRequest' + description: KickUserRequest + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/KickUserResponse' + description: KickUserResponse + "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: Kick user from a call + tags: + - product:video /api/v2/video/call/{type}/{id}/mark_ended: post: description: |2 diff --git a/openapi/video-openapi-clientside.json b/openapi/video-openapi-clientside.json index ccbdfc54e..548b49ac0 100644 --- a/openapi/video-openapi-clientside.json +++ b/openapi/video-openapi-clientside.json @@ -1 +1 @@ -{"components":{"schemas":{"APIError":{"properties":{"StatusCode":{"description":"Response HTTP status code","format":"int32","title":"Status code","type":"integer","x-stream-index":"004"},"code":{"description":"API error code","format":"int32","title":"Code","type":"integer","x-stream-index":"001"},"details":{"description":"Additional error-specific information","items":{"type":"integer"},"title":"Details","type":"array","x-stream-index":"007"},"duration":{"description":"Request duration","title":"Duration","type":"string","x-stream-index":"005"},"exception_fields":{"additionalProperties":{"type":"string"},"description":"Additional error info","title":"Exception fields","type":"object","x-stream-index":"003"},"message":{"description":"Message describing an error","title":"Message","type":"string","x-stream-index":"002"},"more_info":{"description":"URL with additional information","title":"More info","type":"string","x-stream-index":"006"},"unrecoverable":{"description":"Flag that indicates if the error is unrecoverable, requests that return unrecoverable errors should not be retried, this error only applies to the request that caused it","title":"Unrecoverable","type":"boolean","x-stream-index":"008"}},"required":["code","message","StatusCode","duration","more_info","details"],"title":"Error response","type":"object"},"AcceptCallRequest":{"description":"AcceptCallRequest is the payload for accepting a call.","nullable":true,"title":"AcceptCallRequest","type":"object"},"AcceptCallResponse":{"description":"AcceptCallResponse is the payload for accepting a call.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"AcceptCallResponse","type":"object"},"AppEventResponse":{"properties":{"async_url_enrich_enabled":{"description":"boolean","title":"Async URL Enrichment Enabled","type":"boolean","x-stream-index":"002"},"auto_translation_enabled":{"description":"boolean","title":"Auto Translation Enabled","type":"boolean","x-stream-index":"003"},"file_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","description":"file upload config","title":"File Upload Config","x-stream-index":"004"},"image_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","description":"file upload config","title":"Image Upload Config","x-stream-index":"005"},"name":{"description":"string","title":"App name","type":"string","x-stream-index":"001"}},"required":["name","auto_translation_enabled"],"type":"object"},"AppUpdatedEvent":{"description":"Emitted when app settings are updated","nullable":true,"properties":{"app":{"$ref":"#/components/schemas/AppEventResponse","description":"application configuration","title":"App settings","x-stream-index":"002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"received_at":{"format":"date-time","type":"string","x-stream-index":"001.004"},"type":{"default":"app.updated","description":"The type of event: \"app.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.002"}},"required":["type","created_at","custom","app"],"title":"AppUpdatedEvent","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"},"AudioSettingsRequest":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"001"},"default_device":{"enum":["speaker","earpiece"],"type":"string","x-stream-index":"006"},"mic_default_on":{"type":"boolean","x-stream-index":"004"},"noise_cancellation":{"$ref":"#/components/schemas/NoiseCancellationSettings","x-stream-index":"007"},"opus_dtx_enabled":{"type":"boolean","x-stream-index":"002"},"redundant_coding_enabled":{"type":"boolean","x-stream-index":"003"},"speaker_default_on":{"type":"boolean","x-stream-index":"005"}},"required":["default_device"],"type":"object"},"AudioSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"001"},"default_device":{"enum":["speaker","earpiece"],"type":"string","x-stream-index":"006"},"mic_default_on":{"type":"boolean","x-stream-index":"004"},"noise_cancellation":{"$ref":"#/components/schemas/NoiseCancellationSettings","x-stream-index":"007"},"opus_dtx_enabled":{"type":"boolean","x-stream-index":"002"},"redundant_coding_enabled":{"type":"boolean","x-stream-index":"003"},"speaker_default_on":{"type":"boolean","x-stream-index":"005"}},"required":["access_request_enabled","opus_dtx_enabled","redundant_coding_enabled","mic_default_on","speaker_default_on","default_device"],"type":"object"},"BackstageSettingsRequest":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"002"}},"type":"object"},"BackstageSettingsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"BlockUserRequest":{"description":"BlockUserRequest is the payload for blocking a user.","nullable":true,"properties":{"user_id":{"description":"the user to block","title":"UserID","type":"string","x-stream-index":"003"}},"required":["user_id"],"title":"BlockUserRequest","type":"object"},"BlockUserResponse":{"description":"BlockUserResponse is the payload for blocking a user.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"BlockUserResponse","type":"object"},"BlockedUserEvent":{"description":"This event is sent to call participants to notify when a user is blocked on a call, clients can use this event to show a notification.\nIf the user is the current user, the client should leave the call screen as well","properties":{"blocked_by_user":{"$ref":"#/components/schemas/UserResponse","description":"The user that blocked the user, null if the user was blocked by server-side","title":"Blocked by","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"call.blocked_user","description":"The type of event: \"call.blocked_user\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user that was blocked","title":"User","x-stream-index":"003"}},"required":["type","created_at","call_cid","user"],"title":"BlockedUserEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"Bound":{"properties":{"inclusive":{"type":"boolean","x-stream-index":"002"},"value":{"format":"float","type":"number","x-stream-index":"001"}},"required":["value","inclusive"],"type":"object"},"BroadcastSettingsRequest":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettingsRequest","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettingsRequest","x-stream-index":"003"}},"type":"object"},"BroadcastSettingsResponse":{"description":"BroadcastSettingsResponse is the payload for broadcasting settings","properties":{"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettingsResponse","title":"HLS","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettingsResponse","title":"RTMP","x-stream-index":"003"}},"required":["enabled","hls","rtmp"],"title":"BroadcastSettingsResponse","type":"object"},"CallAcceptedEvent":{"description":"This event is sent when a user accepts a notification to join a call.","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"call.accepted","description":"The type of event: \"call.accepted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who accepted the call","title":"User","x-stream-index":"004"}},"required":["type","created_at","call_cid","call","user"],"title":"CallAcceptedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallClosedCaption":{"description":"CallClosedCaption represents a closed caption of a call.","properties":{"end_time":{"format":"date-time","title":"The end time of the closed caption.","type":"string","x-stream-index":"003"},"speaker_id":{"title":"The speaker ID of the closed caption.","type":"string","x-stream-index":"004"},"start_time":{"format":"date-time","title":"The start time of the closed caption.","type":"string","x-stream-index":"002"},"text":{"title":"The text of the closed caption.","type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserResponse","title":"The full user for the closed caption.","x-stream-index":"005"}},"required":["text","start_time","end_time","speaker_id","user"],"title":"CallClosedCaption","type":"object"},"CallClosedCaptionsFailedEvent":{"description":"This event is sent when call closed captions has failed","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"call.closed_captions_failed","description":"The type of event: \"call.closed_captions_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallClosedCaptionsFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallClosedCaptionsStartedEvent":{"description":"This event is sent when call closed caption has started","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"call.closed_captions_started","description":"The type of event: \"call.closed_captions_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallClosedCaptionsStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallClosedCaptionsStoppedEvent":{"description":"This event is sent when call closed captions has stopped","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"call.closed_captions_stopped","description":"The type of event: \"call.transcription_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallClosedCaptionsStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallCreatedEvent":{"description":"This event is sent when a call is created. Clients receiving this event should check if the ringing\nfield is set to true and if so, show the call screen","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"members":{"description":"the members added to this call","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"004"},"type":{"default":"call.created","description":"The type of event: \"call.created\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","members"],"title":"CallCreatedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallDeletedEvent":{"description":"This event is sent when a call is deleted. Clients receiving this event should leave the call screen","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"call.deleted","description":"The type of event: \"call.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call"],"title":"CallDeletedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallDurationReport":{"properties":{"histogram":{"items":{"$ref":"#/components/schemas/ReportByHistogramBucket"},"type":"array","x-stream-index":"001"}},"required":["histogram"],"type":"object"},"CallDurationReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateCallDurationReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"CallEndedEvent":{"description":"This event is sent when a call is mark as ended for all its participants. Clients receiving this event should leave the call screen","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"reason":{"description":"The reason why the call ended, if available","title":"CallEndedReason","type":"string","x-stream-index":"005"},"type":{"default":"call.ended","description":"The type of event: \"call.ended\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who ended the call, null if the call was ended by the server","title":"User","x-stream-index":"004"}},"required":["type","created_at","call_cid","call"],"title":"CallEndedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallFrameRecordingFailedEvent":{"description":"This event is sent when frame recording has failed","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.frame_recording_failed","description":"The type of event: \"call.frame_recording_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","egress_id"],"title":"CallFrameRecordingFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallFrameRecordingFrameReadyEvent":{"description":"This event is sent when a frame is captured from a call","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"captured_at":{"description":"The time the frame was captured","format":"date-time","title":"CapturedAt","type":"string","x-stream-index":"006"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"008"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"track_type":{"description":"The type of the track frame was captured from (TRACK_TYPE_VIDEO|TRACK_TYPE_SCREEN_SHARE)","title":"TrackType","type":"string","x-stream-index":"004"},"type":{"default":"call.frame_recording_ready","description":"The type of event: \"call.frame_recording_ready\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"url":{"description":"The URL of the frame","title":"URL","type":"string","x-stream-index":"005"},"users":{"additionalProperties":{"$ref":"#/components/schemas/UserResponse"},"description":"The users in the frame","title":"Users","type":"object","x-stream-index":"007"}},"required":["type","created_at","call_cid","session_id","track_type","url","captured_at","users","egress_id"],"title":"CallFrameRecordingFrameReadyEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallFrameRecordingStartedEvent":{"description":"This event is sent when frame recording has started","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.frame_recording_started","description":"The type of event: \"call.frame_recording_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","egress_id"],"title":"CallFrameRecordingStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallFrameRecordingStoppedEvent":{"description":"This event is sent when frame recording has stopped","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.frame_recording_stopped","description":"The type of event: \"call.frame_recording_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","egress_id"],"title":"CallFrameRecordingStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallHLSBroadcastingFailedEvent":{"description":"This event is sent when HLS broadcasting has failed","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"call.hls_broadcasting_failed","description":"The type of event: \"call.hls_broadcasting_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallHLSBroadcastingFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallHLSBroadcastingStartedEvent":{"description":"This event is sent when HLS broadcasting has started","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"hls_playlist_url":{"type":"string","x-stream-index":"004"},"type":{"default":"call.hls_broadcasting_started","description":"The type of event: \"call.hls_broadcasting_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","hls_playlist_url"],"title":"CallHLSBroadcastingStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallHLSBroadcastingStoppedEvent":{"description":"This event is sent when HLS broadcasting has stopped","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"call.hls_broadcasting_stopped","description":"The type of event: \"call.hls_broadcasting_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallHLSBroadcastingStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallIngressResponse":{"description":"CallIngressResponse is the payload for ingress settings","properties":{"rtmp":{"$ref":"#/components/schemas/RTMPIngress","title":"RTMP","x-stream-index":"001"}},"required":["rtmp"],"title":"CallIngressResponse","type":"object"},"CallLiveStartedEvent":{"description":"This event is sent when a call is started. Clients receiving this event should start the call.","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"call.live_started","description":"The type of event: \"call.live_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call"],"title":"CallLiveStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMemberAddedEvent":{"description":"This event is sent when one or more members are added to a call","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"members":{"description":"the members added to this call","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"004"},"type":{"default":"call.member_added","description":"The type of event: \"call.member_added\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","members"],"title":"CallMemberAddedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMemberRemovedEvent":{"description":"This event is sent when one or more members are removed from a call","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"members":{"description":"the list of member IDs removed from the call","items":{"type":"string"},"title":"Members","type":"array","x-stream-index":"004"},"type":{"default":"call.member_removed","description":"The type of event: \"call.member_removed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","members"],"title":"CallMemberRemovedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMemberUpdatedEvent":{"description":"This event is sent when one or more members are updated","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"members":{"description":"The list of members that were updated","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"004"},"type":{"default":"call.member_updated","description":"The type of event: \"call.member_updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","members"],"title":"CallMemberUpdatedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMemberUpdatedPermissionEvent":{"description":"This event is sent when one or more members get its role updated","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"capabilities_by_role":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"The capabilities by role for this call","title":"CapabilitiesByRole","type":"object","x-stream-index":"004"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"members":{"description":"The list of members that were updated","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"005"},"type":{"default":"call.member_updated_permission","description":"The type of event: \"call.member_added\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","capabilities_by_role","members"],"title":"CallMemberUpdatedPermissionEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMissedEvent":{"description":"This event is sent to call members who did not accept/reject/join the call to notify they missed the call","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"members":{"description":"List of members who missed the call","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"005"},"notify_user":{"type":"boolean","x-stream-index":"007"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.missed","description":"The type of event: \"call.notification\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The caller from whom the call was missed","title":"User","x-stream-index":"006"}},"required":["type","created_at","call_cid","session_id","call","members","user","notify_user"],"title":"CallMissedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallModerationBlurEvent":{"properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"type":{"default":"call.moderation_blur","type":"string","x-stream-index":"001.001"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["type","created_at","call_cid","user_id","custom"],"title":"CallModerationBlurEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallModerationWarningEvent":{"properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"message":{"type":"string","x-stream-index":"004"},"type":{"default":"call.moderation_warning","type":"string","x-stream-index":"001.001"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["type","created_at","call_cid","user_id","message","custom"],"title":"CallModerationWarningEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallNotificationEvent":{"description":"This event is sent to all call members to notify they are getting called","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"members":{"description":"Call members","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"005"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.notification","description":"The type of event: \"call.notification\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user that sent the call notification","title":"User","x-stream-index":"006"}},"required":["type","created_at","call_cid","session_id","call","members","user"],"title":"CallNotificationEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallParticipantCountReport":{"properties":{"histogram":{"items":{"$ref":"#/components/schemas/ReportByHistogramBucket"},"type":"array","x-stream-index":"001"}},"required":["histogram"],"type":"object"},"CallParticipantCountReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateCallParticipantCountReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"CallParticipantResponse":{"properties":{"joined_at":{"format":"date-time","type":"string","x-stream-index":"004"},"role":{"type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"},"user_session_id":{"type":"string","x-stream-index":"002"}},"required":["user","user_session_id","role","joined_at"],"type":"object"},"CallReactionEvent":{"description":"This event is sent when a reaction is sent in a call, clients should use this to show the reaction in the call screen","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"reaction":{"$ref":"#/components/schemas/ReactionResponse","description":"the reaction object sent by the user on the call","title":"reaction","x-stream-index":"003"},"type":{"default":"call.reaction_new","description":"The type of event: \"call.reaction_new\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","reaction"],"title":"CallReactionEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRecording":{"description":"CallRecording represents a recording of a call.","properties":{"end_time":{"format":"date-time","title":"The end time of the recording.","type":"string","x-stream-index":"004"},"filename":{"title":"The filename of the recording.","type":"string","x-stream-index":"001"},"session_id":{"title":"The session ID of the recording.","type":"string","x-stream-index":"005"},"start_time":{"format":"date-time","title":"The start time of the recording.","type":"string","x-stream-index":"003"},"url":{"title":"The URL of the recording.","type":"string","x-stream-index":"002"}},"required":["filename","url","start_time","end_time","session_id"],"title":"CallRecording","type":"object"},"CallRecordingFailedEvent":{"description":"This event is sent when call recording has failed","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"003"},"type":{"default":"call.recording_failed","description":"The type of event: \"call.recording_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","egress_id"],"title":"CallRecordingFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRecordingReadyEvent":{"description":"This event is sent when call recording is ready","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"call_recording":{"$ref":"#/components/schemas/CallRecording","description":"The call recording object","title":"CallRecording","x-stream-index":"003"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.recording_ready","description":"The type of event: \"call.recording_ready\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call_recording","egress_id"],"title":"CallRecordingReadyEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRecordingStartedEvent":{"description":"This event is sent when call recording has started","properties":{"call_cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"002.002"},"egress_id":{"type":"string","x-stream-index":"001"},"type":{"default":"call.recording_started","description":"The type of event: \"call.recording_started\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001"}},"required":["egress_id","type","created_at","call_cid"],"title":"CallRecordingStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRecordingStoppedEvent":{"description":"This event is sent when call recording has stopped","properties":{"call_cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"002.002"},"egress_id":{"type":"string","x-stream-index":"001"},"type":{"default":"call.recording_stopped","description":"The type of event: \"call.recording_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001"}},"required":["egress_id","type","created_at","call_cid"],"title":"CallRecordingStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRejectedEvent":{"description":"This event is sent when a user rejects a notification to join a call.","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"reason":{"description":"Provides information about why the call was rejected. You can provide any value, but the Stream API and SDKs use these default values: rejected, cancel, timeout and busy","title":"Reason","type":"string","x-stream-index":"005"},"type":{"default":"call.rejected","description":"The type of event: \"call.rejected\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who rejected the call","title":"User","x-stream-index":"004"}},"required":["type","created_at","call_cid","call","user"],"title":"CallRejectedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallReportResponse":{"properties":{"ended_at":{"format":"date-time","type":"string","x-stream-index":"003"},"score":{"format":"float","type":"number","x-stream-index":"001"},"started_at":{"format":"date-time","type":"string","x-stream-index":"002"}},"required":["score"],"type":"object"},"CallRequest":{"description":"CallRequest is the payload for creating a call.","properties":{"channel_cid":{"type":"string","x-stream-index":"009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"members":{"items":{"$ref":"#/components/schemas/MemberRequest"},"maximum":100,"type":"array","x-stream-index":"005"},"settings_override":{"$ref":"#/components/schemas/CallSettingsRequest","x-stream-index":"006"},"starts_at":{"format":"date-time","type":"string","x-stream-index":"007"},"team":{"type":"string","x-stream-index":"001"},"video":{"type":"boolean","x-stream-index":"008"}},"title":"CallRequest","type":"object"},"CallResponse":{"description":"Represents a call","properties":{"backstage":{"type":"boolean","x-stream-index":"016"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"018"},"captioning":{"type":"boolean","x-stream-index":"013"},"channel_cid":{"type":"string","x-stream-index":"024"},"cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"009"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"The user that created the call","title":"Created By","x-stream-index":"007"},"current_session_id":{"type":"string","x-stream-index":"005"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"008"},"egress":{"$ref":"#/components/schemas/EgressResponse","x-stream-index":"021"},"ended_at":{"description":"Date/time when the call ended","format":"date-time","title":"Ended At","type":"string","x-stream-index":"014"},"id":{"description":"Call ID","title":"ID","type":"string","x-stream-index":"003"},"ingress":{"$ref":"#/components/schemas/CallIngressResponse","x-stream-index":"019"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"023"},"recording":{"type":"boolean","x-stream-index":"011"},"session":{"$ref":"#/components/schemas/CallSessionResponse","x-stream-index":"020"},"settings":{"$ref":"#/components/schemas/CallSettingsResponse","x-stream-index":"017"},"starts_at":{"description":"Date/time when the call will start","format":"date-time","title":"Starts At","type":"string","x-stream-index":"015"},"team":{"type":"string","x-stream-index":"006"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailResponse","x-stream-index":"022"},"transcribing":{"type":"boolean","x-stream-index":"012"},"type":{"description":"The type of call","title":"Type","type":"string","x-stream-index":"002"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"010"}},"required":["type","id","cid","current_session_id","created_by","custom","created_at","updated_at","recording","transcribing","captioning","backstage","settings","blocked_user_ids","ingress","egress"],"title":"CallResponse","type":"object"},"CallRingEvent":{"description":"This event is sent to all call members to notify they are getting called","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"005"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"members":{"description":"Call members","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"006"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.ring","description":"The type of event: \"call.notification\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user that sent the call notification","title":"User","x-stream-index":"007"},"video":{"type":"boolean","x-stream-index":"008"}},"required":["type","created_at","call_cid","session_id","call","members","user","video"],"title":"CallRingEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRtmpBroadcastFailedEvent":{"description":"This event is sent when a call RTMP broadcast has failed","properties":{"call_cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"002.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.002"},"name":{"description":"Name of the given RTMP broadcast","title":"Name","type":"string","x-stream-index":"003"},"type":{"default":"call.rtmp_broadcast_failed","description":"The type of event: \"call.rtmp_broadcast_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","name"],"title":"CallRtmpBroadcastFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRtmpBroadcastStartedEvent":{"description":"This event is sent when RTMP broadcast has started","properties":{"call_cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"002.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.002"},"name":{"description":"Name of the given RTMP broadcast","title":"Name","type":"string","x-stream-index":"003"},"type":{"default":"call.rtmp_broadcast_started","description":"The type of event: \"call.rtmp_broadcast_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","name"],"title":"CallRtmpBroadcastStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRtmpBroadcastStoppedEvent":{"description":"This event is sent when RTMP broadcast has stopped","properties":{"call_cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"002.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.002"},"name":{"description":"Name of the given RTMP broadcast","title":"Name","type":"string","x-stream-index":"003"},"type":{"default":"call.rtmp_broadcast_stopped","description":"The type of event: \"call.rtmp_broadcast_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","name"],"title":"CallRtmpBroadcastStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSessionEndedEvent":{"description":"This event is sent when a call session ends","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_ended","description":"The type of event: \"call.session_ended\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","call"],"title":"CallSessionEndedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSessionParticipantCountsUpdatedEvent":{"description":"This event is sent when the participant counts in a call session are updated","properties":{"anonymous_participant_count":{"format":"int32","type":"integer","x-stream-index":"005"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"participants_count_by_role":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"004"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_participant_count_updated","description":"The type of event: \"call.session_participant_count_updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","participants_count_by_role","anonymous_participant_count"],"title":"CallSessionParticipantCountsUpdatedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSessionParticipantJoinedEvent":{"description":"This event is sent when a participant joins a call session","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"participant":{"$ref":"#/components/schemas/CallParticipantResponse","description":"The participant that joined the session","title":"Participant","x-stream-index":"004"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_participant_joined","description":"The type of event: \"call.session_participant_joined\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","participant"],"title":"CallSessionParticipantJoinedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSessionParticipantLeftEvent":{"description":"This event is sent when a participant leaves a call session","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"duration_seconds":{"description":"The duration participant was in the session in seconds","format":"int32","title":"Duration","type":"integer","x-stream-index":"005"},"participant":{"$ref":"#/components/schemas/CallParticipantResponse","description":"The participant that left the session","title":"Participant","x-stream-index":"004"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_participant_left","description":"The type of event: \"call.session_participant_left\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","participant","duration_seconds"],"title":"CallSessionParticipantLeftEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSessionResponse":{"properties":{"accepted_by":{"additionalProperties":{"format":"date-time","type":"string"},"type":"object","x-stream-index":"008"},"anonymous_participant_count":{"format":"int32","type":"integer","x-stream-index":"006"},"ended_at":{"format":"date-time","type":"string","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"live_ended_at":{"format":"date-time","type":"string","x-stream-index":"011"},"live_started_at":{"format":"date-time","type":"string","x-stream-index":"010"},"missed_by":{"additionalProperties":{"format":"date-time","type":"string"},"type":"object","x-stream-index":"009"},"participants":{"items":{"$ref":"#/components/schemas/CallParticipantResponse"},"type":"array","x-stream-index":"004"},"participants_count_by_role":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"005"},"rejected_by":{"additionalProperties":{"format":"date-time","type":"string"},"type":"object","x-stream-index":"007"},"started_at":{"format":"date-time","type":"string","x-stream-index":"002"},"timer_ends_at":{"format":"date-time","type":"string","x-stream-index":"012"}},"required":["id","participants","participants_count_by_role","anonymous_participant_count","rejected_by","accepted_by","missed_by"],"type":"object"},"CallSessionStartedEvent":{"description":"This event is sent when a call session starts","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_started","description":"The type of event: \"call.session_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","call"],"title":"CallSessionStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSettingsRequest":{"properties":{"audio":{"$ref":"#/components/schemas/AudioSettingsRequest","x-stream-index":"001"},"backstage":{"$ref":"#/components/schemas/BackstageSettingsRequest","x-stream-index":"002"},"broadcasting":{"$ref":"#/components/schemas/BroadcastSettingsRequest","x-stream-index":"010"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordingSettingsRequest","x-stream-index":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettingsRequest","x-stream-index":"003"},"ingress":{"$ref":"#/components/schemas/IngressSettingsRequest","x-stream-index":"014"},"limits":{"$ref":"#/components/schemas/LimitsSettingsRequest","x-stream-index":"012"},"recording":{"$ref":"#/components/schemas/RecordSettingsRequest","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettingsRequest","x-stream-index":"007"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettingsRequest","x-stream-index":"008"},"session":{"$ref":"#/components/schemas/SessionSettingsRequest","x-stream-index":"013"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettingsRequest","x-stream-index":"011"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettingsRequest","x-stream-index":"009"},"video":{"$ref":"#/components/schemas/VideoSettingsRequest","x-stream-index":"004"}},"type":"object"},"CallSettingsResponse":{"properties":{"audio":{"$ref":"#/components/schemas/AudioSettingsResponse","x-stream-index":"001"},"backstage":{"$ref":"#/components/schemas/BackstageSettingsResponse","x-stream-index":"002"},"broadcasting":{"$ref":"#/components/schemas/BroadcastSettingsResponse","x-stream-index":"003"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordingSettingsResponse","x-stream-index":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettingsResponse","x-stream-index":"004"},"ingress":{"$ref":"#/components/schemas/IngressSettingsResponse","x-stream-index":"014"},"limits":{"$ref":"#/components/schemas/LimitsSettingsResponse","x-stream-index":"012"},"recording":{"$ref":"#/components/schemas/RecordSettingsResponse","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettingsResponse","x-stream-index":"007"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettingsResponse","x-stream-index":"008"},"session":{"$ref":"#/components/schemas/SessionSettingsResponse","x-stream-index":"013"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettingsResponse","x-stream-index":"011"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettingsResponse","x-stream-index":"009"},"video":{"$ref":"#/components/schemas/VideoSettingsResponse","x-stream-index":"010"}},"required":["audio","backstage","broadcasting","geofencing","recording","frame_recording","ring","screensharing","transcription","video","thumbnails","limits","session"],"type":"object"},"CallStateResponseFields":{"description":"CallStateResponseFields is the payload for call state response","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001"},"members":{"description":"List of call members","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"002"},"membership":{"$ref":"#/components/schemas/MemberResponse","description":"Current user membership object","title":"Membership","x-stream-index":"003"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"004"}},"required":["call","members","own_capabilities","blocked_users"],"title":"CallStateResponseFields","type":"object"},"CallStatsReportReadyEvent":{"description":"This event is sent when the insights report is ready","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.stats_report_ready","description":"The type of event, \"call.report_ready\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id"],"title":"CallStatsReportReadyEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallStatsReportSummaryResponse":{"properties":{"call_cid":{"type":"string","x-stream-index":"001"},"call_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"008"},"call_session_id":{"type":"string","x-stream-index":"002"},"call_status":{"type":"string","x-stream-index":"004"},"created_at":{"format":"date-time","type":"string","x-stream-index":"007"},"first_stats_time":{"format":"date-time","type":"string","x-stream-index":"003"},"min_user_rating":{"format":"int32","type":"integer","x-stream-index":"006"},"quality_score":{"format":"int32","type":"integer","x-stream-index":"005"}},"required":["call_cid","call_session_id","first_stats_time","call_status","call_duration_seconds"],"type":"object"},"CallTranscription":{"description":"CallTranscription represents a transcription of a call.","properties":{"end_time":{"format":"date-time","title":"The end time of the transcription.","type":"string","x-stream-index":"004"},"filename":{"title":"The filename of the transcription.","type":"string","x-stream-index":"001"},"session_id":{"title":"The session ID of the transcription.","type":"string","x-stream-index":"005"},"start_time":{"format":"date-time","title":"The start time of the transcription.","type":"string","x-stream-index":"003"},"url":{"title":"The URL of the transcription.","type":"string","x-stream-index":"002"}},"required":["filename","url","start_time","end_time","session_id"],"title":"CallTranscription","type":"object"},"CallTranscriptionFailedEvent":{"description":"This event is sent when call transcription has failed","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"003"},"error":{"description":"The error message detailing why transcription failed.","title":"string","type":"string","x-stream-index":"004"},"type":{"default":"call.transcription_failed","description":"The type of event: \"call.transcription_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","egress_id"],"title":"CallTranscriptionFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallTranscriptionReadyEvent":{"description":"This event is sent when call transcription is ready","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"call_transcription":{"$ref":"#/components/schemas/CallTranscription","description":"The call transcription object","title":"CallTranscription","x-stream-index":"003"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.transcription_ready","description":"The type of event: \"call.transcription_ready\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call_transcription","egress_id"],"title":"CallTranscriptionReadyEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallTranscriptionStartedEvent":{"description":"This event is sent when call transcription has started","properties":{"call_cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"002.002"},"egress_id":{"type":"string","x-stream-index":"001"},"type":{"default":"call.transcription_started","description":"The type of event: \"call.transcription_started\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001"}},"required":["egress_id","type","created_at","call_cid"],"title":"CallTranscriptionStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallTranscriptionStoppedEvent":{"description":"This event is sent when call transcription has stopped","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"003"},"type":{"default":"call.transcription_stopped","description":"The type of event: \"call.transcription_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","egress_id"],"title":"CallTranscriptionStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallUpdatedEvent":{"description":"This event is sent when a call is updated, clients should use this update the local state of the call.\nThis event also contains the capabilities by role for the call, clients should update the own_capability for the current.","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"capabilities_by_role":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"The capabilities by role for this call","title":"CapabilitiesByRole","type":"object","x-stream-index":"004"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"call.updated","description":"The type of event: \"call.ended\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","capabilities_by_role"],"title":"CallUpdatedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallUserFeedbackSubmittedEvent":{"description":"This event is sent when a user submits feedback for a call.","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"custom":{"additionalProperties":{},"description":"Custom data provided by the user","title":"Custom","type":"object","x-stream-index":"007"},"rating":{"description":"The rating given by the user (1-5)","format":"int32","title":"Rating","type":"integer","x-stream-index":"005"},"reason":{"description":"The reason provided by the user for the rating","title":"Reason","type":"string","x-stream-index":"006"},"sdk":{"type":"string","x-stream-index":"008"},"sdk_version":{"type":"string","x-stream-index":"009"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.user_feedback_submitted","description":"The type of event, \"call.user_feedback\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who submitted the feedback","title":"User","x-stream-index":"004"}},"required":["type","created_at","call_cid","session_id","user","rating"],"title":"CallUserFeedbackSubmittedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallUserMutedEvent":{"description":"This event is sent when a call member is muted","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"from_user_id":{"type":"string","x-stream-index":"003"},"muted_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"type":{"default":"call.user_muted","description":"The type of event: \"call.user_muted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","from_user_id","muted_user_ids"],"title":"CallUserMutedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallsPerDayReport":{"properties":{"count":{"format":"int64","type":"integer","x-stream-index":"001"}},"required":["count"],"type":"object"},"CallsPerDayReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateCallsPerDayReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"ChatActivityStatsResponse":{"properties":{"Messages":{"$ref":"#/components/schemas/MessageStatsResponse","x-stream-index":"001"}},"type":"object"},"ClosedCaptionEvent":{"description":"This event is sent when closed captions are being sent in a call, clients should use this to show the closed captions in the call screen","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"closed_caption":{"$ref":"#/components/schemas/CallClosedCaption","description":"The closed caption object","title":"CallClosedCaption","x-stream-index":"003"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"call.closed_caption","description":"The type of event: \"call.closed_caption\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","closed_caption"],"title":"ClosedCaptionEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CollectUserFeedbackRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"009"},"rating":{"format":"int32","maximum":5,"minimum":1,"type":"integer","x-stream-index":"007"},"reason":{"maxLength":1000,"type":"string","x-stream-index":"008"},"sdk":{"maxLength":50,"type":"string","x-stream-index":"005"},"sdk_version":{"maxLength":50,"type":"string","x-stream-index":"006"},"user_session_id":{"maxLength":50,"type":"string","x-stream-index":"004"}},"required":["sdk","sdk_version","rating"],"type":"object"},"CollectUserFeedbackResponse":{"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"},"ConnectUserDetailsRequest":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001"},"image":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"006"},"language":{"type":"string","x-stream-index":"005"},"name":{"type":"string","x-stream-index":"002"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"007"}},"required":["id"],"type":"object"},"ConnectedEvent":{"description":"This event is sent when the WS connection is established and authenticated, this event contains the full user object as it is stored on the server","properties":{"connection_id":{"description":"The connection_id for this client","title":"Connection ID","type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"me":{"$ref":"#/components/schemas/OwnUserResponse","description":"The full user object as it is stored on the server","title":"OwnUserResponse","x-stream-index":"003"},"type":{"default":"connection.ok","description":"The type of event: \"connection.ok\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","connection_id","me"],"title":"ConnectedEvent","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"},"ConnectionErrorEvent":{"description":"This event is sent when the WS connection fails","properties":{"connection_id":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"error":{"$ref":"#/components/schemas/APIError","description":"The error that caused the connection to fail","title":"Error","x-stream-index":"003"},"type":{"default":"connection.error","description":"The type of event: \"connection.ok\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","connection_id","error"],"title":"ConnectionErrorEvent","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"},"CountByMinuteResponse":{"nullable":true,"properties":{"count":{"format":"int32","type":"integer","x-stream-index":"002"},"start_ts":{"format":"date-time","type":"string","x-stream-index":"001"}},"required":["start_ts","count"],"type":"object"},"CreateDeviceRequest":{"description":"Create device request","nullable":true,"properties":{"id":{"description":"Device ID","maxLength":255,"minLength":1,"title":"ID","type":"string","x-stream-index":"001"},"push_provider":{"description":"Push provider","enum":["firebase","apn","huawei","xiaomi"],"title":"PushProvider","type":"string","x-stream-index":"002"},"push_provider_name":{"description":"Push provider name","title":"PushProviderName","type":"string","x-stream-index":"003"},"voip_token":{"description":"When true the token is for Apple VoIP push notifications","title":"VoipToken","type":"boolean","x-stream-index":"004"}},"required":["id","push_provider"],"title":"CreateDeviceRequest","type":"object"},"CreateGuestRequest":{"nullable":true,"properties":{"user":{"$ref":"#/components/schemas/UserRequest","description":"User object which server acts upon","title":"User","x-stream-index":"001"}},"required":["user"],"type":"object"},"CreateGuestResponse":{"nullable":true,"properties":{"access_token":{"description":"the access token to authenticate the user","title":"Access token","type":"string","x-stream-index":"002"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User object which server acts upon","title":"User","x-stream-index":"001"}},"required":["user","access_token","duration"],"type":"object"},"Credentials":{"properties":{"ice_servers":{"items":{"$ref":"#/components/schemas/ICEServer"},"type":"array","x-stream-index":"003"},"server":{"$ref":"#/components/schemas/SFUResponse","x-stream-index":"001"},"token":{"type":"string","x-stream-index":"002"}},"required":["server","token","ice_servers"],"type":"object"},"CustomVideoEvent":{"description":"A custom event, this event is used to send custom events to other participants in the call.","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"003"},"type":{"default":"custom","description":"The type of event, \"custom\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"004"}},"required":["type","created_at","call_cid","custom","user"],"title":"CustomVideoEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"DailyAggregateCallDurationReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/CallDurationReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateCallParticipantCountReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/CallParticipantCountReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateCallsPerDayReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/CallsPerDayReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateQualityScoreReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/QualityScoreReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateSDKUsageReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/SDKUsageReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateUserFeedbackReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/UserFeedbackReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DeleteCallRequest":{"description":"DeleteCallRequest is the payload for deleting a call.","nullable":true,"properties":{"hard":{"description":"if true the call will be hard deleted along with all related data","title":"Hard","type":"boolean","x-stream-index":"001"}},"title":"DeleteCallRequest","type":"object"},"DeleteCallResponse":{"description":"DeleteCallResponse is the payload for deleting a call.","nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","title":"Call","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"task_id":{"title":"TaskID","type":"string","x-stream-index":"002"}},"required":["call","duration"],"title":"DeleteCallResponse","type":"object"},"DeleteRecordingResponse":{"description":"Response for DeleteRecording","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"DeleteRecordingResponse","type":"object"},"DeleteTranscriptionResponse":{"description":"DeleteTranscriptionResponse is the payload for deleting a transcription.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"DeleteTranscriptionResponse","type":"object"},"DeviceResponse":{"description":"Response for Device","properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"004"},"disabled":{"description":"Whether device is disabled or not","title":"Disabled","type":"boolean","x-stream-index":"005"},"disabled_reason":{"description":"Reason explaining why device had been disabled","title":"Reason","type":"string","x-stream-index":"006"},"id":{"description":"Device ID","title":"ID","type":"string","x-stream-index":"003"},"push_provider":{"description":"Push provider","title":"PushProvider","type":"string","x-stream-index":"001"},"push_provider_name":{"description":"Push provider name","title":"PushProviderName","type":"string","x-stream-index":"002"},"user_id":{"description":"User ID","title":"UserID","type":"string","x-stream-index":"008"},"voip":{"description":"When true the token is for Apple VoIP push notifications","title":"Voip","type":"boolean","x-stream-index":"007"}},"required":["push_provider","id","created_at","user_id"],"title":"DeviceResponse","type":"object"},"EdgeResponse":{"properties":{"continent_code":{"type":"string","x-stream-index":"007.003"},"country_iso_code":{"type":"string","x-stream-index":"007.002"},"green":{"format":"int32","type":"integer","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"latency_test_url":{"type":"string","x-stream-index":"002"},"latitude":{"format":"float","type":"number","x-stream-index":"006.001"},"longitude":{"format":"float","type":"number","x-stream-index":"006.002"},"red":{"format":"int32","type":"integer","x-stream-index":"005"},"subdivision_iso_code":{"type":"string","x-stream-index":"007.001"},"yellow":{"format":"int32","type":"integer","x-stream-index":"004"}},"required":["id","latency_test_url","green","yellow","red","latitude","longitude","subdivision_iso_code","country_iso_code","continent_code"],"type":"object"},"EgressHLSResponse":{"properties":{"playlist_url":{"type":"string","x-stream-index":"001"},"status":{"type":"string","x-stream-index":"002"}},"required":["playlist_url","status"],"type":"object"},"EgressRTMPResponse":{"properties":{"name":{"type":"string","x-stream-index":"001"},"started_at":{"format":"date-time","type":"string","x-stream-index":"004"},"stream_key":{"type":"string","x-stream-index":"003"},"stream_url":{"type":"string","x-stream-index":"002"}},"required":["name","started_at"],"type":"object"},"EgressResponse":{"properties":{"broadcasting":{"type":"boolean","x-stream-index":"001"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordingResponse","x-stream-index":"004"},"hls":{"$ref":"#/components/schemas/EgressHLSResponse","x-stream-index":"002"},"rtmps":{"items":{"$ref":"#/components/schemas/EgressRTMPResponse"},"type":"array","x-stream-index":"003"}},"required":["broadcasting","rtmps"],"type":"object"},"EndCallRequest":{"description":"Request for ending a call","nullable":true,"title":"EndCallRequest","type":"object"},"EndCallResponse":{"description":"Response for ending a call","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"EndCallResponse","type":"object"},"FileUploadConfig":{"properties":{"allowed_file_extensions":{"items":{"type":"string"},"type":"array","x-stream-index":"001"},"allowed_mime_types":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"blocked_file_extensions":{"items":{"type":"string"},"type":"array","x-stream-index":"002"},"blocked_mime_types":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"size_limit":{"format":"int32","maximum":104857600,"minimum":0,"type":"integer","x-stream-index":"005"}},"required":["allowed_file_extensions","blocked_file_extensions","allowed_mime_types","blocked_mime_types","size_limit"],"type":"object"},"FrameRecordingResponse":{"properties":{"status":{"type":"string","x-stream-index":"001"}},"required":["status"],"type":"object"},"FrameRecordingSettingsRequest":{"properties":{"capture_interval_in_seconds":{"format":"int32","maximum":60,"minimum":2,"type":"integer","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"},"quality":{"enum":["360p","480p","720p","1080p","1440p"],"type":"string","x-stream-index":"002"}},"required":["mode","capture_interval_in_seconds"],"type":"object"},"FrameRecordingSettingsResponse":{"properties":{"capture_interval_in_seconds":{"format":"int32","maximum":60,"minimum":2,"type":"integer","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"},"quality":{"type":"string","x-stream-index":"002"}},"required":["mode","capture_interval_in_seconds"],"type":"object"},"GeofenceSettingsRequest":{"properties":{"names":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"type":"object"},"GeofenceSettingsResponse":{"properties":{"names":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"required":["names"],"type":"object"},"GetCallReportResponse":{"description":"Basic response information","nullable":true,"properties":{"chat_activity":{"$ref":"#/components/schemas/ChatActivityStatsResponse","x-stream-index":"004"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"report":{"$ref":"#/components/schemas/ReportResponse","x-stream-index":"003"},"session_id":{"type":"string","x-stream-index":"002"},"video_reactions":{"items":{"$ref":"#/components/schemas/VideoReactionsResponse"},"type":"array","x-stream-index":"005"}},"required":["duration","session_id","report"],"title":"Response","type":"object"},"GetCallResponse":{"nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001.001"},"duration":{"type":"string","x-stream-index":"002.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001.002"},"membership":{"$ref":"#/components/schemas/MemberResponse","x-stream-index":"001.003"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"001.004"}},"required":["call","members","own_capabilities","blocked_users","duration"],"title":"GetCallResponse","type":"object"},"GetEdgesResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"edges":{"items":{"$ref":"#/components/schemas/EdgeResponse"},"type":"array","x-stream-index":"001"}},"required":["edges","duration"],"title":"Response","type":"object"},"GetOrCreateCallRequest":{"nullable":true,"properties":{"data":{"$ref":"#/components/schemas/CallRequest","title":"ReadOnlyData","x-stream-index":"003"},"members_limit":{"format":"int32","maximum":100,"type":"integer","x-stream-index":"007"},"notify":{"description":"if provided it sends a notification event to the members for this call","title":"Notify","type":"boolean","x-stream-index":"005"},"ring":{"description":"if provided it sends a ring event to the members for this call","title":"Ring","type":"boolean","x-stream-index":"004"},"video":{"type":"boolean","x-stream-index":"006"}},"title":"GetOrCreateCallRequest","type":"object"},"GetOrCreateCallResponse":{"nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001.001"},"created":{"type":"boolean","x-stream-index":"002"},"duration":{"type":"string","x-stream-index":"003.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001.002"},"membership":{"$ref":"#/components/schemas/MemberResponse","x-stream-index":"001.003"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"001.004"}},"required":["call","members","own_capabilities","blocked_users","created","duration"],"title":"GetOrCreateCallResponse","type":"object"},"GoLiveRequest":{"nullable":true,"properties":{"recording_storage_name":{"type":"string","x-stream-index":"005"},"start_closed_caption":{"type":"boolean","x-stream-index":"008"},"start_hls":{"type":"boolean","x-stream-index":"003"},"start_recording":{"type":"boolean","x-stream-index":"004"},"start_transcription":{"type":"boolean","x-stream-index":"007"},"transcription_storage_name":{"type":"string","x-stream-index":"006"}},"title":"GoLiveRequest","type":"object"},"GoLiveResponse":{"description":"Basic response information","nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["call","duration"],"title":"Response","type":"object"},"GroupedStatsResponse":{"nullable":true,"properties":{"name":{"type":"string","x-stream-index":"001"},"unique":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["name","unique"],"type":"object"},"HLSSettingsRequest":{"properties":{"auto_on":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"quality_tracks":{"items":{"type":"string"},"maximum":3,"minimum":1,"type":"array","x-stream-index":"003"}},"required":["quality_tracks"],"title":"HLSSettingsRequest","type":"object"},"HLSSettingsResponse":{"description":"HLSSettings is the payload for HLS settings","properties":{"auto_on":{"title":"Auto On","type":"boolean","x-stream-index":"001"},"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"002"},"quality_tracks":{"items":{"type":"string"},"title":"Quality Tracks","type":"array","x-stream-index":"003"}},"required":["auto_on","enabled","quality_tracks","layout"],"title":"HLSSettingsResponse","type":"object"},"HealthCheckEvent":{"nullable":true,"properties":{"cid":{"type":"string","x-stream-index":"003"},"connection_id":{"type":"string","x-stream-index":"001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"004.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004.007"},"received_at":{"format":"date-time","type":"string","x-stream-index":"004.004"},"type":{"default":"health.check","type":"string","x-stream-index":"004.002"}},"required":["connection_id","type","created_at","custom"],"title":"HealthCheckEvent","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"},"ICEServer":{"properties":{"password":{"type":"string","x-stream-index":"003"},"urls":{"items":{"type":"string"},"type":"array","x-stream-index":"001"},"username":{"type":"string","x-stream-index":"002"}},"required":["urls","username","password"],"type":"object"},"IngressAudioEncodingOptionsRequest":{"properties":{"bitrate":{"maximum":128000,"minimum":16000,"type":"integer","x-stream-index":"003"},"channels":{"enum":["1","2"],"format":"int32","type":"integer","x-stream-index":"001"},"enable_dtx":{"type":"boolean","x-stream-index":"002"}},"required":["channels","bitrate"],"type":"object"},"IngressAudioEncodingResponse":{"properties":{"bitrate":{"format":"int32","type":"integer","x-stream-index":"003"},"channels":{"format":"int32","type":"integer","x-stream-index":"001"},"enable_dtx":{"type":"boolean","x-stream-index":"002"}},"required":["channels","enable_dtx","bitrate"],"type":"object"},"IngressSettingsRequest":{"properties":{"audio_encoding_options":{"$ref":"#/components/schemas/IngressAudioEncodingOptionsRequest","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"video_encoding_options":{"additionalProperties":{"$ref":"#/components/schemas/IngressVideoEncodingOptionsRequest"},"type":"object","x-stream-index":"003"}},"type":"object"},"IngressSettingsResponse":{"properties":{"audio_encoding_options":{"$ref":"#/components/schemas/IngressAudioEncodingResponse","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"video_encoding_options":{"additionalProperties":{"$ref":"#/components/schemas/IngressVideoEncodingResponse"},"type":"object","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"IngressVideoEncodingOptionsRequest":{"properties":{"layers":{"items":{"$ref":"#/components/schemas/IngressVideoLayerRequest"},"minimum":1,"type":"array","x-stream-index":"001"}},"required":["layers"],"type":"object"},"IngressVideoEncodingResponse":{"properties":{"layers":{"items":{"$ref":"#/components/schemas/IngressVideoLayerResponse"},"type":"array","x-stream-index":"001"}},"required":["layers"],"type":"object"},"IngressVideoLayerRequest":{"nullable":true,"properties":{"bitrate":{"format":"int32","minimum":1000,"type":"integer","x-stream-index":"002"},"codec":{"enum":["h264","vp8"],"type":"string","x-stream-index":"001"},"frame_rate_limit":{"maximum":60,"minimum":1,"type":"integer","x-stream-index":"005"},"max_dimension":{"minimum":240,"type":"integer","x-stream-index":"004"},"min_dimension":{"minimum":240,"type":"integer","x-stream-index":"003"}},"required":["codec","bitrate","min_dimension","max_dimension","frame_rate_limit"],"type":"object"},"IngressVideoLayerResponse":{"nullable":true,"properties":{"bitrate":{"type":"integer","x-stream-index":"002"},"codec":{"type":"string","x-stream-index":"001"},"frame_rate_limit":{"type":"integer","x-stream-index":"005"},"max_dimension":{"type":"integer","x-stream-index":"004"},"min_dimension":{"type":"integer","x-stream-index":"003"}},"required":["codec","bitrate","min_dimension","max_dimension","frame_rate_limit"],"type":"object"},"JoinCallRequest":{"nullable":true,"properties":{"create":{"description":"if true the call will be created if it doesn't exist","title":"Create","type":"boolean","x-stream-index":"002"},"data":{"$ref":"#/components/schemas/CallRequest","x-stream-index":"003"},"location":{"title":"Location","type":"string","x-stream-index":"009"},"members_limit":{"format":"int32","maximum":100,"title":"The amount of members that should be returned","type":"integer","x-stream-index":"007"},"migrating_from":{"description":"If the participant is migrating from another SFU, then this is the ID of the previous SFU","title":"MigratingFrom","type":"string","x-stream-index":"010"},"notify":{"type":"boolean","x-stream-index":"005"},"ring":{"description":"if true and the call is created, the notification will include ring=true","title":"Ring","type":"boolean","x-stream-index":"004"},"video":{"type":"boolean","x-stream-index":"006"}},"required":["location"],"title":"JoinCallRequest","type":"object"},"JoinCallResponse":{"nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001.001"},"created":{"title":"Created","type":"boolean","x-stream-index":"002"},"credentials":{"$ref":"#/components/schemas/Credentials","title":"Credentials","x-stream-index":"003"},"duration":{"type":"string","x-stream-index":"005.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001.002"},"membership":{"$ref":"#/components/schemas/MemberResponse","x-stream-index":"001.003"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"001.004"},"stats_options":{"$ref":"#/components/schemas/StatsOptions","x-stream-index":"004"}},"required":["call","members","own_capabilities","blocked_users","created","credentials","stats_options","duration"],"title":"JoinCallResponse","type":"object"},"LayoutSettingsRequest":{"properties":{"detect_orientation":{"type":"boolean","x-stream-index":"005"},"external_app_url":{"type":"string","x-stream-index":"003"},"external_css_url":{"type":"string","x-stream-index":"004"},"name":{"enum":["spotlight","grid","single-participant","mobile","custom"],"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"required":["name"],"type":"object"},"LimitsSettingsRequest":{"properties":{"max_duration_seconds":{"format":"int32","minimum":0,"type":"integer","x-stream-index":"004"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"},"max_participants_exclude_owner":{"type":"boolean","x-stream-index":"003"},"max_participants_exclude_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"002"}},"type":"object"},"LimitsSettingsResponse":{"properties":{"max_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"004"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"},"max_participants_exclude_owner":{"type":"boolean","x-stream-index":"003"},"max_participants_exclude_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"002"}},"required":["max_participants_exclude_roles"],"type":"object"},"ListDevicesResponse":{"description":"List devices response","nullable":true,"properties":{"devices":{"description":"List of devices","items":{"$ref":"#/components/schemas/DeviceResponse"},"title":"Devices","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["devices","duration"],"title":"ListDevicesResponse","type":"object"},"ListRecordingsResponse":{"description":"Response for listing recordings","nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"},"recordings":{"items":{"$ref":"#/components/schemas/CallRecording"},"title":"The list of recordings.","type":"array","x-stream-index":"002"}},"required":["duration","recordings"],"title":"ListRecordingsResponse","type":"object"},"ListTranscriptionsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"},"transcriptions":{"description":"List of transcriptions for the call","items":{"$ref":"#/components/schemas/CallTranscription"},"title":"Transcriptions","type":"array","x-stream-index":"002"}},"required":["duration","transcriptions"],"title":"ListTranscriptionsResponse","type":"object"},"MemberRequest":{"description":"MemberRequest is the payload for adding a member to a call.","properties":{"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"003"},"role":{"title":"Role","type":"string","x-stream-index":"002"},"user_id":{"minLength":1,"title":"User ID","type":"string","x-stream-index":"001"}},"required":["user_id"],"title":"MemberRequest","type":"object"},"MemberResponse":{"description":"MemberResponse is the payload for a member of a call.","properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"005"},"custom":{"additionalProperties":{},"description":"Custom member response data","title":"Custom","type":"object","x-stream-index":"004"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"string","x-stream-index":"007"},"role":{"title":"Role","type":"string","x-stream-index":"003"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"006"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"},"user_id":{"type":"string","x-stream-index":"002"}},"required":["user","user_id","custom","created_at","updated_at"],"title":"MemberResponse","type":"object"},"MessageStatsResponse":{"properties":{"count_over_time":{"items":{"$ref":"#/components/schemas/CountByMinuteResponse"},"type":"array","x-stream-index":"001"}},"type":"object"},"MuteUsersRequest":{"nullable":true,"properties":{"audio":{"title":"Audio","type":"boolean","x-stream-index":"005"},"mute_all_users":{"type":"boolean","x-stream-index":"003"},"screenshare":{"title":"Screenshare","type":"boolean","x-stream-index":"007"},"screenshare_audio":{"title":"ScreenshareAudio","type":"boolean","x-stream-index":"008"},"user_ids":{"items":{"type":"string"},"title":"UserIDs","type":"array","x-stream-index":"004"},"video":{"title":"Video","type":"boolean","x-stream-index":"006"}},"title":"MuteUsersRequest","type":"object"},"MuteUsersResponse":{"description":"MuteUsersResponse is the response payload for the mute users endpoint.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"MuteUsersResponse","type":"object"},"NetworkMetricsReportResponse":{"properties":{"average_connection_time":{"format":"float","type":"number","x-stream-index":"003"},"average_jitter":{"format":"float","type":"number","x-stream-index":"002"},"average_latency":{"format":"float","type":"number","x-stream-index":"001"},"average_time_to_reconnect":{"format":"float","type":"number","x-stream-index":"004"}},"type":"object"},"NoiseCancellationSettings":{"properties":{"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode"],"type":"object"},"OwnCapability":{"description":"All possibility of string to use","enum":["block-users","change-max-duration","create-call","create-reaction","enable-noise-cancellation","end-call","join-backstage","join-call","join-ended-call","mute-users","pin-for-everyone","read-call","remove-call-member","screenshare","send-audio","send-video","start-broadcast-call","start-closed-captions-call","start-frame-record-call","start-record-call","start-transcription-call","stop-broadcast-call","stop-closed-captions-call","stop-frame-record-call","stop-record-call","stop-transcription-call","update-call","update-call-member","update-call-permissions","update-call-settings"],"title":"OwnCapability","type":"string"},"OwnUserResponse":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"015"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"string","x-stream-index":"001.016"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"001.011"},"devices":{"items":{"$ref":"#/components/schemas/DeviceResponse"},"title":"Devices","type":"array","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001.001"},"image":{"type":"string","x-stream-index":"001.003"},"language":{"type":"string","x-stream-index":"001.005"},"last_active":{"format":"date-time","type":"string","x-stream-index":"001.014"},"name":{"type":"string","x-stream-index":"001.002"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"003"},"push_preferences":{"$ref":"#/components/schemas/PushPreferences","x-stream-index":"002"},"revoke_tokens_issued_before":{"format":"date-time","type":"string","x-stream-index":"001.015"},"role":{"type":"string","x-stream-index":"001.006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","devices","invisible","mutes","channel_mutes","unread_count","total_unread_count","unread_channels","unread_threads"],"type":"object"},"ParticipantCountByMinuteResponse":{"nullable":true,"properties":{"first":{"format":"int32","type":"integer","x-stream-index":"002"},"last":{"format":"int32","type":"integer","x-stream-index":"003"},"max":{"format":"int32","type":"integer","x-stream-index":"004"},"min":{"format":"int32","type":"integer","x-stream-index":"005"},"start_ts":{"format":"date-time","type":"string","x-stream-index":"001"}},"required":["start_ts","first","last","max","min"],"type":"object"},"ParticipantCountOverTimeResponse":{"properties":{"by_minute":{"items":{"$ref":"#/components/schemas/ParticipantCountByMinuteResponse"},"type":"array","x-stream-index":"001"}},"type":"object"},"ParticipantReportResponse":{"properties":{"by_browser":{"items":{"$ref":"#/components/schemas/GroupedStatsResponse"},"type":"array","x-stream-index":"008"},"by_country":{"items":{"$ref":"#/components/schemas/GroupedStatsResponse"},"type":"array","x-stream-index":"005"},"by_device":{"items":{"$ref":"#/components/schemas/GroupedStatsResponse"},"type":"array","x-stream-index":"006"},"by_operating_system":{"items":{"$ref":"#/components/schemas/GroupedStatsResponse"},"type":"array","x-stream-index":"007"},"count_over_time":{"$ref":"#/components/schemas/ParticipantCountOverTimeResponse","x-stream-index":"004"},"max_concurrent":{"format":"int32","type":"integer","x-stream-index":"003"},"publishers":{"$ref":"#/components/schemas/PublisherStatsResponse","x-stream-index":"009"},"subscribers":{"$ref":"#/components/schemas/SubscriberStatsResponse","x-stream-index":"010"},"sum":{"format":"int32","type":"integer","x-stream-index":"001"},"unique":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["sum","unique"],"type":"object"},"PerSDKUsageReport":{"nullable":true,"properties":{"by_version":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"002"},"total":{"format":"int32","type":"integer","x-stream-index":"001"}},"required":["total","by_version"],"type":"object"},"PermissionRequestEvent":{"description":"This event is sent when a user requests access to a feature on a call,\nclients receiving this event should display a permission request to the user","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"permissions":{"description":"The list of permissions requested by the user","items":{"type":"string"},"title":"Permissions","type":"array","x-stream-index":"004"},"type":{"default":"call.permission_request","description":"The type of event: \"call.permission_request\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who sent the permission request","title":"User","x-stream-index":"003"}},"required":["type","created_at","call_cid","user","permissions"],"title":"PermissionRequestEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"PinRequest":{"description":"PinRequest is the payload for pinning a message.","nullable":true,"properties":{"session_id":{"description":"the session ID of the user who pinned the message","title":"SessionID","type":"string","x-stream-index":"003"},"user_id":{"description":"the user ID of the user who pinned the message","title":"UserID","type":"string","x-stream-index":"002"}},"required":["user_id","session_id"],"title":"PinRequest","type":"object"},"PinResponse":{"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"},"PrivacySettings":{"properties":{"read_receipts":{"$ref":"#/components/schemas/ReadReceipts","x-stream-index":"002"},"typing_indicators":{"$ref":"#/components/schemas/TypingIndicators","x-stream-index":"001"}},"type":"object"},"PrivacySettingsResponse":{"type":"object"},"PublisherStatsResponse":{"properties":{"by_track":{"items":{"$ref":"#/components/schemas/TrackStatsResponse"},"type":"array","x-stream-index":"003"},"total":{"format":"int32","type":"integer","x-stream-index":"001"},"unique":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["total","unique"],"type":"object"},"PushPreferences":{"properties":{"call_level":{"type":"string","x-stream-index":"002"},"chat_level":{"type":"string","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"string","x-stream-index":"003"}},"type":"object"},"QualityScoreReport":{"properties":{"histogram":{"items":{"$ref":"#/components/schemas/ReportByHistogramBucket"},"type":"array","x-stream-index":"001"}},"required":["histogram"],"type":"object"},"QualityScoreReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateQualityScoreReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"QueryAggregateCallStatsRequest":{"nullable":true,"properties":{"from":{"type":"string","x-stream-index":"002"},"report_types":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"to":{"type":"string","x-stream-index":"003"}},"type":"object"},"QueryAggregateCallStatsResponse":{"description":"Basic response information","nullable":true,"properties":{"call_duration_report":{"$ref":"#/components/schemas/CallDurationReportResponse","x-stream-index":"002"},"call_participant_count_report":{"$ref":"#/components/schemas/CallParticipantCountReportResponse","x-stream-index":"004"},"calls_per_day_report":{"$ref":"#/components/schemas/CallsPerDayReportResponse","x-stream-index":"003"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"network_metrics_report":{"$ref":"#/components/schemas/NetworkMetricsReportResponse","x-stream-index":"008"},"quality_score_report":{"$ref":"#/components/schemas/QualityScoreReportResponse","x-stream-index":"005"},"sdk_usage_report":{"$ref":"#/components/schemas/SDKUsageReportResponse","x-stream-index":"006"},"user_feedback_report":{"$ref":"#/components/schemas/UserFeedbackReportResponse","x-stream-index":"007"}},"required":["duration"],"title":"Response","type":"object"},"QueryCallMembersRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"002"},"id":{"maxLength":64,"type":"string","x-stream-index":"001.002"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"004.001"},"next":{"type":"string","x-stream-index":"004.002"},"prev":{"type":"string","x-stream-index":"004.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":1,"type":"array","x-stream-index":"003"},"type":{"maxLength":64,"type":"string","x-stream-index":"001.001"}},"required":["type","id"],"type":"object"},"QueryCallMembersResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["members","duration"],"title":"Response","type":"object"},"QueryCallParticipantsRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"003"}},"type":"object"},"QueryCallParticipantsResponse":{"nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001.001"},"duration":{"type":"string","x-stream-index":"004.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001.002"},"membership":{"$ref":"#/components/schemas/MemberResponse","x-stream-index":"001.003"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"001.004"},"participants":{"description":"List of call participants","items":{"$ref":"#/components/schemas/CallParticipantResponse"},"title":"[]CallParticipantResponse","type":"array","x-stream-index":"002"},"total_participants":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["call","members","own_capabilities","blocked_users","participants","total_participants","duration"],"type":"object"},"QueryCallStatsRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"004.001"},"next":{"type":"string","x-stream-index":"004.002"},"prev":{"type":"string","x-stream-index":"004.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":2,"type":"array","x-stream-index":"002"}},"type":"object"},"QueryCallStatsResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"next":{"type":"string","x-stream-index":"003.001"},"prev":{"type":"string","x-stream-index":"003.002"},"reports":{"items":{"$ref":"#/components/schemas/CallStatsReportSummaryResponse"},"type":"array","x-stream-index":"001"}},"required":["reports","duration"],"title":"Response","type":"object"},"QueryCallsRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"title":"Filters","type":"object","x-stream-index":"003"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"006.001"},"next":{"type":"string","x-stream-index":"006.002"},"prev":{"type":"string","x-stream-index":"006.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":2,"title":"Sort","type":"array","x-stream-index":"004"},"watch":{"title":"Watch","type":"boolean","x-stream-index":"001"}},"title":"QueryCallsRequest","type":"object"},"QueryCallsResponse":{"nullable":true,"properties":{"calls":{"items":{"$ref":"#/components/schemas/CallStateResponseFields"},"title":"Calls","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["calls","duration"],"title":"QueryCallsResponse","type":"object"},"RTMPBroadcastRequest":{"description":"RTMPBroadcastRequest is the payload for starting an RTMP broadcast.","properties":{"layout":{"$ref":"#/components/schemas/LayoutSettingsRequest","description":"If provided, will override the call's RTMP settings layout","title":"Layout","x-stream-index":"005"},"name":{"description":"Name identifier for RTMP broadcast, must be unique in call","maxLength":255,"title":"Name","type":"string","x-stream-index":"001"},"quality":{"description":"If provided, will override the call's RTMP settings quality","enum":["360p","480p","720p","1080p","1440p","portrait-360x640","portrait-480x854","portrait-720x1280","portrait-1080x1920","portrait-1440x2560"],"title":"Quality","type":"string","x-stream-index":"004"},"stream_key":{"description":"If provided, will be appended at the end of stream_url","title":"Stream Key","type":"string","x-stream-index":"003"},"stream_url":{"description":"URL for the RTMP server to send the call to","maxLength":255,"title":"Stream URL","type":"string","x-stream-index":"002"}},"required":["name","stream_url"],"title":"RTMPBroadcastRequest","type":"object"},"RTMPIngress":{"description":"RTMP input settings","properties":{"address":{"title":"Address","type":"string","x-stream-index":"001"}},"required":["address"],"title":"RTMPIngress","type":"object"},"RTMPSettingsRequest":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"quality":{"description":"Resolution to set for the RTMP stream","enum":["360p","480p","720p","1080p","1440p","portrait-360x640","portrait-480x854","portrait-720x1280","portrait-1080x1920","portrait-1440x2560"],"title":"Quality","type":"string","x-stream-index":"002"}},"title":"RTMPSettingsRequest","type":"object"},"RTMPSettingsResponse":{"description":"RTMPSettingsResponse is the payload for RTMP settings","properties":{"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"001"},"quality":{"title":"Quality","type":"string","x-stream-index":"002"}},"required":["enabled","quality","layout"],"title":"RTMPSettingsResponse","type":"object"},"ReactionResponse":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"emoji_code":{"type":"string","x-stream-index":"003"},"type":{"type":"string","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"}},"required":["user","type"],"type":"object"},"ReadReceipts":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"RecordSettingsRequest":{"properties":{"audio_only":{"type":"boolean","x-stream-index":"001"},"mode":{"enum":["available","disabled","auto-on"],"title":"Mode","type":"string","x-stream-index":"002"},"quality":{"enum":["360p","480p","720p","1080p","1440p","portrait-360x640","portrait-480x854","portrait-720x1280","portrait-1080x1920","portrait-1440x2560"],"type":"string","x-stream-index":"003"}},"required":["mode"],"title":"RecordSettingsRequest","type":"object"},"RecordSettingsResponse":{"description":"RecordSettings is the payload for recording settings","properties":{"audio_only":{"title":"Audio Only","type":"boolean","x-stream-index":"001"},"mode":{"title":"Mode","type":"string","x-stream-index":"002"},"quality":{"title":"Quality","type":"string","x-stream-index":"003"}},"required":["audio_only","mode","quality","layout"],"title":"RecordSettingsResponse","type":"object"},"RejectCallRequest":{"nullable":true,"properties":{"reason":{"description":"Reason for rejecting the call","title":"Reason","type":"string","x-stream-index":"003"}},"title":"RejectCallRequest","type":"object"},"RejectCallResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"RejectCallResponse","type":"object"},"ReportByHistogramBucket":{"properties":{"category":{"type":"string","x-stream-index":"001"},"count":{"format":"int32","type":"integer","x-stream-index":"005"},"lower_bound":{"$ref":"#/components/schemas/Bound","x-stream-index":"002"},"sum":{"format":"float","type":"number","x-stream-index":"004"},"upper_bound":{"$ref":"#/components/schemas/Bound","x-stream-index":"003"}},"required":["category","sum","count"],"type":"object"},"ReportResponse":{"properties":{"call":{"$ref":"#/components/schemas/CallReportResponse","x-stream-index":"003"},"participants":{"$ref":"#/components/schemas/ParticipantReportResponse","x-stream-index":"001"},"user_ratings":{"$ref":"#/components/schemas/UserRatingReportResponse","x-stream-index":"002"}},"required":["participants","user_ratings","call"],"type":"object"},"RequestPermissionRequest":{"nullable":true,"properties":{"permissions":{"items":{"type":"string"},"title":"Permissions","type":"array","x-stream-index":"003"}},"required":["permissions"],"title":"RequestPermissionRequest","type":"object"},"RequestPermissionResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"RequestPermissionResponse","type":"object"},"Response":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001"}},"required":["duration"],"title":"Response","type":"object"},"RingSettingsRequest":{"properties":{"auto_cancel_timeout_ms":{"description":"When none of the callees accept a ring call in this time a rejection will be sent by the caller with reason 'timeout' by the SDKs","format":"int32","maximum":180000,"minimum":5000,"title":"AutoCancelTimeoutMs","type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"description":"When a callee is online but doesn't answer a ring call in this time a rejection will be sent with reason 'timeout' by the SDKs","format":"int32","maximum":180000,"minimum":5000,"title":"IncomingCallTimeoutMs","type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"description":"When a callee doesn't accept or reject a ring call in this time a missed call event will be sent","format":"int32","maximum":180000,"minimum":5000,"title":"MissedCallTimeoutMs","type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_timeout_ms"],"title":"RingSettingsRequest","type":"object"},"RingSettingsResponse":{"properties":{"auto_cancel_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_timeout_ms","missed_call_timeout_ms"],"type":"object"},"SDKUsageReport":{"properties":{"per_sdk_usage":{"additionalProperties":{"$ref":"#/components/schemas/PerSDKUsageReport"},"type":"object","x-stream-index":"001"}},"required":["per_sdk_usage"],"type":"object"},"SDKUsageReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateSDKUsageReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"SFUResponse":{"properties":{"edge_name":{"type":"string","x-stream-index":"001"},"url":{"type":"string","x-stream-index":"002"},"ws_endpoint":{"type":"string","x-stream-index":"003"}},"required":["edge_name","url","ws_endpoint"],"type":"object"},"ScreensharingSettingsRequest":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"type":"object"},"ScreensharingSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled"],"type":"object"},"SendCallEventRequest":{"description":"Send a call event to the other user","nullable":true,"properties":{"custom":{"additionalProperties":{},"title":"Custom","type":"object","x-stream-index":"004"}},"title":"SendCallEventRequest","type":"object"},"SendCallEventResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"SendCallEventResponse","type":"object"},"SendReactionRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.003"},"emoji_code":{"type":"string","x-stream-index":"003.002"},"type":{"maxLength":64,"type":"string","x-stream-index":"003.001"}},"required":["type"],"type":"object"},"SendReactionResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"reaction":{"$ref":"#/components/schemas/ReactionResponse","x-stream-index":"001"}},"required":["reaction","duration"],"title":"Response","type":"object"},"SessionSettingsRequest":{"properties":{"inactivity_timeout_seconds":{"format":"int32","maximum":900,"minimum":5,"type":"integer","x-stream-index":"001"}},"required":["inactivity_timeout_seconds"],"type":"object"},"SessionSettingsResponse":{"properties":{"inactivity_timeout_seconds":{"format":"int32","maximum":900,"minimum":5,"type":"integer","x-stream-index":"001"}},"required":["inactivity_timeout_seconds"],"type":"object"},"SortParamRequest":{"nullable":true,"properties":{"direction":{"description":"Direction of sorting, 1 for Ascending, -1 for Descending, default is 1","format":"int32","title":"Direction","type":"integer","x-stream-index":"002"},"field":{"description":"Name of field to sort by","title":"Field","type":"string","x-stream-index":"001"}},"type":"object"},"StartClosedCaptionsRequest":{"nullable":true,"properties":{"enable_transcription":{"description":"Enable transcriptions along with closed captions","title":"Enable Transcription","type":"boolean","x-stream-index":"002"},"external_storage":{"description":"Which external storage to use for transcriptions (only applicable if enable_transcription is true)","title":"External Storage","type":"string","x-stream-index":"003"},"language":{"description":"The spoken language in the call, if not provided the language defined in the transcription settings will be used","enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"title":"Language","type":"string","x-stream-index":"004"}},"type":"object"},"StartClosedCaptionsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"StartFrameRecordingRequest":{"nullable":true,"properties":{"recording_external_storage":{"type":"string","x-stream-index":"002"}},"title":"StartFrameRecordingRequest","type":"object"},"StartFrameRecordingResponse":{"description":"StartFrameRecordingResponse is the response payload for the start frame recording endpoint.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StartFrameRecordingResponse","type":"object"},"StartHLSBroadcastingRequest":{"description":"StartHLSBroadcastingRequest is the payload for starting an HLS broadcasting.","nullable":true,"title":"StartHLSBroadcastingRequest","type":"object"},"StartHLSBroadcastingResponse":{"description":"StartHLSBroadcastingResponse is the payload for starting an HLS broadcasting.","nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"},"playlist_url":{"description":"the URL of the HLS playlist","title":"PlaylistURL","type":"string","x-stream-index":"002"}},"required":["duration","playlist_url"],"title":"StartHLSBroadcastingResponse","type":"object"},"StartRTMPBroadcastsRequest":{"description":"StartRTMPBroadcastsRequest is the payload for starting RTMP broadcasts.","nullable":true,"properties":{"broadcasts":{"description":"List of broadcasts to start","items":{"$ref":"#/components/schemas/RTMPBroadcastRequest"},"maximum":1,"minimum":1,"title":"Broadcasts","type":"array","x-stream-index":"002"}},"required":["broadcasts"],"title":"StartRTMPBroadcastsRequest","type":"object"},"StartRTMPBroadcastsResponse":{"description":"StartRTMPBroadcastsResponse is the payload for starting an RTMP broadcast.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StartRTMPBroadcastsResponse","type":"object"},"StartRecordingRequest":{"nullable":true,"properties":{"recording_external_storage":{"type":"string","x-stream-index":"002"}},"title":"StartRecordingRequest","type":"object"},"StartRecordingResponse":{"description":"StartRecordingResponse is the response payload for the start recording endpoint.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StartRecordingResponse","type":"object"},"StartTranscriptionRequest":{"nullable":true,"properties":{"enable_closed_captions":{"description":"Enable closed captions along with transcriptions","title":"Enable Closed Captions","type":"boolean","x-stream-index":"003"},"language":{"description":"The spoken language in the call, if not provided the language defined in the transcription settings will be used","enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"title":"Language","type":"string","x-stream-index":"004"},"transcription_external_storage":{"description":"Store transcriptions in this external storage","title":"External Storage","type":"string","x-stream-index":"002"}},"type":"object"},"StartTranscriptionResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StartTranscriptionResponse","type":"object"},"StatsOptions":{"properties":{"enable_rtc_stats":{"type":"boolean","x-stream-index":"002"},"reporting_interval_ms":{"format":"int32","type":"integer","x-stream-index":"001"}},"required":["reporting_interval_ms","enable_rtc_stats"],"type":"object"},"StopAllRTMPBroadcastsRequest":{"nullable":true,"title":"StopAllRTMPBroadcastsRequest","type":"object"},"StopAllRTMPBroadcastsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StopAllRTMPBroadcastsResponse","type":"object"},"StopClosedCaptionsRequest":{"nullable":true,"properties":{"stop_transcription":{"type":"boolean","x-stream-index":"003"}},"type":"object"},"StopClosedCaptionsResponse":{"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"},"StopFrameRecordingRequest":{"nullable":true,"type":"object"},"StopFrameRecordingResponse":{"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"},"StopHLSBroadcastingRequest":{"nullable":true,"type":"object"},"StopHLSBroadcastingResponse":{"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"},"StopLiveRequest":{"nullable":true,"properties":{"continue_closed_caption":{"type":"boolean","x-stream-index":"006"},"continue_hls":{"type":"boolean","x-stream-index":"003"},"continue_recording":{"type":"boolean","x-stream-index":"004"},"continue_rtmp_broadcasts":{"type":"boolean","x-stream-index":"007"},"continue_transcription":{"type":"boolean","x-stream-index":"005"}},"title":"StopLiveRequest","type":"object"},"StopLiveResponse":{"nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"The call that was stopped","title":"Call","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["call","duration"],"title":"StopLiveResponse","type":"object"},"StopRTMPBroadcastsRequest":{"description":"Request for stopping RTMP broadcasts","nullable":true,"title":"StopRTMPBroadcastsRequest","type":"object"},"StopRTMPBroadcastsResponse":{"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"},"StopRecordingRequest":{"nullable":true,"type":"object"},"StopRecordingResponse":{"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"},"StopTranscriptionRequest":{"nullable":true,"properties":{"stop_closed_captions":{"type":"boolean","x-stream-index":"003"}},"type":"object"},"StopTranscriptionResponse":{"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"},"SubscriberStatsResponse":{"properties":{"total":{"format":"int32","type":"integer","x-stream-index":"001"},"total_subscribed_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"003"},"unique":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["total","unique","total_subscribed_duration_seconds"],"type":"object"},"TargetResolution":{"properties":{"bitrate":{"format":"int32","maximum":6000000,"type":"integer","x-stream-index":"003"},"height":{"format":"int32","maximum":3840,"minimum":240,"type":"integer","x-stream-index":"002"},"width":{"format":"int32","maximum":3840,"minimum":240,"type":"integer","x-stream-index":"001"}},"required":["width","height"],"type":"object"},"ThumbnailResponse":{"properties":{"image_url":{"type":"string","x-stream-index":"001"}},"required":["image_url"],"type":"object"},"ThumbnailsSettingsRequest":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"ThumbnailsSettingsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"TrackStatsResponse":{"nullable":true,"properties":{"duration_seconds":{"format":"int32","type":"integer","x-stream-index":"002"},"track_type":{"type":"string","x-stream-index":"001"}},"required":["track_type","duration_seconds"],"type":"object"},"TranscriptionSettingsRequest":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"002"},"language":{"enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"type":"string","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode"],"type":"object"},"TranscriptionSettingsResponse":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"002"},"language":{"enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"type":"string","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode","closed_caption_mode","languages","language"],"type":"object"},"TypingIndicators":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"UnblockUserRequest":{"description":"UnblockUserRequest is the payload for unblocking a user.","nullable":true,"properties":{"user_id":{"description":"the user to unblock","title":"UserID","type":"string","x-stream-index":"003"}},"required":["user_id"],"title":"UnblockUserRequest","type":"object"},"UnblockUserResponse":{"description":"UnblockUserResponse is the payload for unblocking a user.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"UnblockUserResponse","type":"object"},"UnblockedUserEvent":{"description":"This event is sent when a user is unblocked on a call,\nthis can be useful to notify the user that they can now join the call again","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"call.unblocked_user","description":"The type of event: \"call.unblocked_user\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user that was unblocked","title":"User","x-stream-index":"003"}},"required":["type","created_at","call_cid","user"],"title":"UnblockedUserEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"UnpinRequest":{"description":"UnpinRequest is the payload for unpinning a message.","nullable":true,"properties":{"session_id":{"description":"the session ID of the user who pinned the message","title":"SessionID","type":"string","x-stream-index":"003"},"user_id":{"description":"the user ID of the user who pinned the message","title":"UserID","type":"string","x-stream-index":"002"}},"required":["user_id","session_id"],"title":"UnpinRequest","type":"object"},"UnpinResponse":{"description":"UnpinResponse is the payload for unpinning a message.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"UnpinResponse","type":"object"},"UpdateCallMembersRequest":{"description":"Update call members","nullable":true,"properties":{"remove_members":{"description":"List of userID to remove","items":{"type":"string"},"maximum":100,"title":"Remove Members","type":"array","x-stream-index":"003"},"update_members":{"description":"List of members to update or insert","items":{"$ref":"#/components/schemas/MemberRequest"},"maximum":100,"title":"Update Members","type":"array","x-stream-index":"004"}},"title":"UpdateCallMembersRequest","type":"object"},"UpdateCallMembersResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"002"}},"required":["duration","members"],"title":"Response","type":"object"},"UpdateCallRequest":{"description":"Request for updating a call","nullable":true,"properties":{"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"003"},"settings_override":{"$ref":"#/components/schemas/CallSettingsRequest","description":"the settings to change for this call","title":"Settings Override","x-stream-index":"004"},"starts_at":{"description":"the time the call is scheduled to start","format":"date-time","title":"Starts At","type":"string","x-stream-index":"005"}},"title":"UpdateCallRequest","type":"object"},"UpdateCallResponse":{"description":"Response for updating a call","nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001.001"},"duration":{"type":"string","x-stream-index":"002.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001.002"},"membership":{"$ref":"#/components/schemas/MemberResponse","x-stream-index":"001.003"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"001.004"}},"required":["call","members","own_capabilities","blocked_users","duration"],"title":"UpdateCallResponse","type":"object"},"UpdateUserPermissionsRequest":{"nullable":true,"properties":{"grant_permissions":{"items":{"type":"string"},"type":"array","x-stream-index":"002"},"revoke_permissions":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"user_id":{"type":"string","x-stream-index":"001"}},"required":["user_id"],"type":"object"},"UpdateUserPermissionsResponse":{"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"},"UpdatedCallPermissionsEvent":{"description":"This event is sent to notify about permission changes for a user, clients receiving this event should update their UI accordingly","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"own_capabilities":{"description":"The capabilities of the current user","items":{"$ref":"#/components/schemas/OwnCapability"},"title":"Own capabilities","type":"array","x-stream-index":"004"},"type":{"default":"call.permissions_updated","description":"The type of event: \"call.permissions_updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who received the new permissions","title":"User","x-stream-index":"003"}},"required":["type","created_at","call_cid","user","own_capabilities"],"title":"UpdatedCallPermissionsEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"User":{"properties":{"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"046"},"ban_expires":{"format":"date-time","type":"string","x-stream-index":"017"},"banned":{"type":"boolean","x-stream-index":"016"},"created_at":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"013"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"023"},"language":{"type":"string","x-stream-index":"035"},"last_active":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"026"},"revoke_tokens_issued_before":{"format":"date-time","type":"string","x-stream-index":"042"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"005"},"updated_at":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"009"}},"required":["id","role","teams_role","custom","banned","online"],"type":"object"},"UserBannedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"006.002"},"channel_type":{"type":"string","x-stream-index":"006.003"},"cid":{"type":"string","x-stream-index":"006.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"008.002"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"001"},"expiration":{"format":"date-time","type":"string","x-stream-index":"003"},"reason":{"type":"string","x-stream-index":"004"},"shadow":{"type":"boolean","x-stream-index":"002"},"team":{"type":"string","x-stream-index":"005.001"},"type":{"default":"user.banned","type":"string","x-stream-index":"008.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007.001"}},"required":["created_by","shadow","cid","channel_id","channel_type","type","created_at"],"title":"UserBannedEvent","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"},"UserDeactivatedEvent":{"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"003.002"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"001"},"type":{"default":"user.deactivated","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["created_by","type","created_at"],"title":"UserDeactivatedEvent","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"},"UserFeedbackReport":{"properties":{"count_by_rating":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001"},"unreported_count":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["count_by_rating","unreported_count"],"type":"object"},"UserFeedbackReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateUserFeedbackReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"UserMutedEvent":{"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"004.002"},"target_user":{"type":"string","x-stream-index":"001"},"target_users":{"items":{"type":"string"},"type":"array","x-stream-index":"002"},"type":{"default":"user.muted","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"UserMutedEvent","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"},"UserRatingReportResponse":{"properties":{"average":{"format":"float","type":"number","x-stream-index":"002"},"count":{"format":"int32","type":"integer","x-stream-index":"001"}},"required":["count","average"],"type":"object"},"UserReactivatedEvent":{"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"002.002"},"type":{"default":"user.reactivated","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"001"}},"required":["type","created_at"],"title":"UserReactivatedEvent","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"},"UserRequest":{"description":"User request object","properties":{"custom":{"additionalProperties":{},"description":"Custom user data","title":"Custom","type":"object","x-stream-index":"004"},"id":{"description":"User ID","title":"ID","type":"string","x-stream-index":"001"},"image":{"description":"User's profile image URL","title":"Image","type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"006"},"language":{"type":"string","x-stream-index":"005"},"name":{"description":"Optional name of user","title":"Name","type":"string","x-stream-index":"002"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"007"}},"required":["id"],"title":"UserRequest","type":"object"},"UserResponse":{"description":"User response object","properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.017"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"001.004"},"deactivated_at":{"description":"Date of deactivation","format":"date-time","title":"Deactivated at","type":"string","x-stream-index":"001.016"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"string","x-stream-index":"001.011"},"id":{"description":"Unique user identifier","title":"ID","type":"string","x-stream-index":"001.001"},"image":{"title":"Image","type":"string","x-stream-index":"001.003"},"language":{"description":"Preferred language of a user","title":"Language","type":"string","x-stream-index":"001.005"},"last_active":{"description":"Date of last activity","format":"date-time","title":"Last active","type":"string","x-stream-index":"001.014"},"name":{"description":"Optional name of user","title":"Name","type":"string","x-stream-index":"001.002"},"revoke_tokens_issued_before":{"description":"Revocation date for tokens","format":"date-time","title":"Revoke tokens issued before","type":"string","x-stream-index":"001.015"},"role":{"description":"Determines the set of user permissions","title":"Role","type":"string","x-stream-index":"001.006"},"teams":{"description":"List of teams user is a part of","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids","shadow_banned","invisible"],"title":"UserResponse","type":"object"},"UserResponsePrivacyFields":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.017"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"string","x-stream-index":"001.016"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"001.011"},"id":{"type":"string","x-stream-index":"001.001"},"image":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"003"},"language":{"type":"string","x-stream-index":"001.005"},"last_active":{"format":"date-time","type":"string","x-stream-index":"001.014"},"name":{"type":"string","x-stream-index":"001.002"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"002"},"revoke_tokens_issued_before":{"format":"date-time","type":"string","x-stream-index":"001.015"},"role":{"type":"string","x-stream-index":"001.006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids"],"type":"object"},"UserUpdatedEvent":{"description":"This event is sent when a user gets updated. The event contains information about the updated user.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"received_at":{"format":"date-time","type":"string","x-stream-index":"001.004"},"type":{"default":"user.updated","description":"The type of event: \"user.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.002"},"user":{"$ref":"#/components/schemas/UserResponsePrivacyFields","description":"The updated user","title":"User","x-stream-index":"002.001"}},"required":["type","created_at","custom","user"],"title":"UserUpdatedEvent","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"},"VideoEvent":{"description":"The discriminator object for all websocket events, it maps events' payload to the final type","discriminator":{"mapping":{"app.updated":"#/components/schemas/AppUpdatedEvent","call.accepted":"#/components/schemas/CallAcceptedEvent","call.blocked_user":"#/components/schemas/BlockedUserEvent","call.closed_caption":"#/components/schemas/ClosedCaptionEvent","call.closed_captions_failed":"#/components/schemas/CallClosedCaptionsFailedEvent","call.closed_captions_started":"#/components/schemas/CallClosedCaptionsStartedEvent","call.closed_captions_stopped":"#/components/schemas/CallClosedCaptionsStoppedEvent","call.created":"#/components/schemas/CallCreatedEvent","call.deleted":"#/components/schemas/CallDeletedEvent","call.ended":"#/components/schemas/CallEndedEvent","call.frame_recording_failed":"#/components/schemas/CallFrameRecordingFailedEvent","call.frame_recording_ready":"#/components/schemas/CallFrameRecordingFrameReadyEvent","call.frame_recording_started":"#/components/schemas/CallFrameRecordingStartedEvent","call.frame_recording_stopped":"#/components/schemas/CallFrameRecordingStoppedEvent","call.hls_broadcasting_failed":"#/components/schemas/CallHLSBroadcastingFailedEvent","call.hls_broadcasting_started":"#/components/schemas/CallHLSBroadcastingStartedEvent","call.hls_broadcasting_stopped":"#/components/schemas/CallHLSBroadcastingStoppedEvent","call.live_started":"#/components/schemas/CallLiveStartedEvent","call.member_added":"#/components/schemas/CallMemberAddedEvent","call.member_removed":"#/components/schemas/CallMemberRemovedEvent","call.member_updated":"#/components/schemas/CallMemberUpdatedEvent","call.member_updated_permission":"#/components/schemas/CallMemberUpdatedPermissionEvent","call.missed":"#/components/schemas/CallMissedEvent","call.moderation_blur":"#/components/schemas/CallModerationBlurEvent","call.moderation_warning":"#/components/schemas/CallModerationWarningEvent","call.notification":"#/components/schemas/CallNotificationEvent","call.permission_request":"#/components/schemas/PermissionRequestEvent","call.permissions_updated":"#/components/schemas/UpdatedCallPermissionsEvent","call.reaction_new":"#/components/schemas/CallReactionEvent","call.recording_failed":"#/components/schemas/CallRecordingFailedEvent","call.recording_ready":"#/components/schemas/CallRecordingReadyEvent","call.recording_started":"#/components/schemas/CallRecordingStartedEvent","call.recording_stopped":"#/components/schemas/CallRecordingStoppedEvent","call.rejected":"#/components/schemas/CallRejectedEvent","call.ring":"#/components/schemas/CallRingEvent","call.rtmp_broadcast_failed":"#/components/schemas/CallRtmpBroadcastFailedEvent","call.rtmp_broadcast_started":"#/components/schemas/CallRtmpBroadcastStartedEvent","call.rtmp_broadcast_stopped":"#/components/schemas/CallRtmpBroadcastStoppedEvent","call.session_ended":"#/components/schemas/CallSessionEndedEvent","call.session_participant_count_updated":"#/components/schemas/CallSessionParticipantCountsUpdatedEvent","call.session_participant_joined":"#/components/schemas/CallSessionParticipantJoinedEvent","call.session_participant_left":"#/components/schemas/CallSessionParticipantLeftEvent","call.session_started":"#/components/schemas/CallSessionStartedEvent","call.stats_report_ready":"#/components/schemas/CallStatsReportReadyEvent","call.transcription_failed":"#/components/schemas/CallTranscriptionFailedEvent","call.transcription_ready":"#/components/schemas/CallTranscriptionReadyEvent","call.transcription_started":"#/components/schemas/CallTranscriptionStartedEvent","call.transcription_stopped":"#/components/schemas/CallTranscriptionStoppedEvent","call.unblocked_user":"#/components/schemas/UnblockedUserEvent","call.updated":"#/components/schemas/CallUpdatedEvent","call.user_feedback_submitted":"#/components/schemas/CallUserFeedbackSubmittedEvent","call.user_muted":"#/components/schemas/CallUserMutedEvent","connection.error":"#/components/schemas/ConnectionErrorEvent","connection.ok":"#/components/schemas/ConnectedEvent","custom":"#/components/schemas/CustomVideoEvent","health.check":"#/components/schemas/HealthCheckEvent","user.banned":"#/components/schemas/UserBannedEvent","user.deactivated":"#/components/schemas/UserDeactivatedEvent","user.muted":"#/components/schemas/UserMutedEvent","user.reactivated":"#/components/schemas/UserReactivatedEvent","user.updated":"#/components/schemas/UserUpdatedEvent"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/AppUpdatedEvent"},{"$ref":"#/components/schemas/BlockedUserEvent"},{"$ref":"#/components/schemas/CallAcceptedEvent"},{"$ref":"#/components/schemas/CallClosedCaptionsFailedEvent"},{"$ref":"#/components/schemas/CallClosedCaptionsStartedEvent"},{"$ref":"#/components/schemas/CallClosedCaptionsStoppedEvent"},{"$ref":"#/components/schemas/CallCreatedEvent"},{"$ref":"#/components/schemas/CallDeletedEvent"},{"$ref":"#/components/schemas/CallEndedEvent"},{"$ref":"#/components/schemas/CallFrameRecordingFailedEvent"},{"$ref":"#/components/schemas/CallFrameRecordingFrameReadyEvent"},{"$ref":"#/components/schemas/CallFrameRecordingStartedEvent"},{"$ref":"#/components/schemas/CallFrameRecordingStoppedEvent"},{"$ref":"#/components/schemas/CallHLSBroadcastingFailedEvent"},{"$ref":"#/components/schemas/CallHLSBroadcastingStartedEvent"},{"$ref":"#/components/schemas/CallHLSBroadcastingStoppedEvent"},{"$ref":"#/components/schemas/CallLiveStartedEvent"},{"$ref":"#/components/schemas/CallMemberAddedEvent"},{"$ref":"#/components/schemas/CallMemberRemovedEvent"},{"$ref":"#/components/schemas/CallMemberUpdatedEvent"},{"$ref":"#/components/schemas/CallMemberUpdatedPermissionEvent"},{"$ref":"#/components/schemas/CallMissedEvent"},{"$ref":"#/components/schemas/CallModerationBlurEvent"},{"$ref":"#/components/schemas/CallModerationWarningEvent"},{"$ref":"#/components/schemas/CallNotificationEvent"},{"$ref":"#/components/schemas/CallReactionEvent"},{"$ref":"#/components/schemas/CallRecordingFailedEvent"},{"$ref":"#/components/schemas/CallRecordingReadyEvent"},{"$ref":"#/components/schemas/CallRecordingStartedEvent"},{"$ref":"#/components/schemas/CallRecordingStoppedEvent"},{"$ref":"#/components/schemas/CallRejectedEvent"},{"$ref":"#/components/schemas/CallRingEvent"},{"$ref":"#/components/schemas/CallRtmpBroadcastFailedEvent"},{"$ref":"#/components/schemas/CallRtmpBroadcastStartedEvent"},{"$ref":"#/components/schemas/CallRtmpBroadcastStoppedEvent"},{"$ref":"#/components/schemas/CallSessionEndedEvent"},{"$ref":"#/components/schemas/CallSessionParticipantCountsUpdatedEvent"},{"$ref":"#/components/schemas/CallSessionParticipantJoinedEvent"},{"$ref":"#/components/schemas/CallSessionParticipantLeftEvent"},{"$ref":"#/components/schemas/CallSessionStartedEvent"},{"$ref":"#/components/schemas/CallStatsReportReadyEvent"},{"$ref":"#/components/schemas/CallTranscriptionFailedEvent"},{"$ref":"#/components/schemas/CallTranscriptionReadyEvent"},{"$ref":"#/components/schemas/CallTranscriptionStartedEvent"},{"$ref":"#/components/schemas/CallTranscriptionStoppedEvent"},{"$ref":"#/components/schemas/CallUpdatedEvent"},{"$ref":"#/components/schemas/CallUserFeedbackSubmittedEvent"},{"$ref":"#/components/schemas/CallUserMutedEvent"},{"$ref":"#/components/schemas/ClosedCaptionEvent"},{"$ref":"#/components/schemas/ConnectedEvent"},{"$ref":"#/components/schemas/ConnectionErrorEvent"},{"$ref":"#/components/schemas/CustomVideoEvent"},{"$ref":"#/components/schemas/HealthCheckEvent"},{"$ref":"#/components/schemas/PermissionRequestEvent"},{"$ref":"#/components/schemas/UnblockedUserEvent"},{"$ref":"#/components/schemas/UpdatedCallPermissionsEvent"},{"$ref":"#/components/schemas/UserBannedEvent"},{"$ref":"#/components/schemas/UserDeactivatedEvent"},{"$ref":"#/components/schemas/UserMutedEvent"},{"$ref":"#/components/schemas/UserReactivatedEvent"},{"$ref":"#/components/schemas/UserUpdatedEvent"}]},"VideoReactionOverTimeResponse":{"properties":{"by_minute":{"items":{"$ref":"#/components/schemas/CountByMinuteResponse"},"type":"array","x-stream-index":"001"}},"type":"object"},"VideoReactionsResponse":{"nullable":true,"properties":{"count_over_time":{"$ref":"#/components/schemas/VideoReactionOverTimeResponse","x-stream-index":"002"},"reaction":{"type":"string","x-stream-index":"001"}},"required":["reaction"],"type":"object"},"VideoSettingsRequest":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"camera_default_on":{"type":"boolean","x-stream-index":"004"},"camera_facing":{"enum":["front","back","external"],"type":"string","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"type":"object"},"VideoSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"camera_default_on":{"type":"boolean","x-stream-index":"004"},"camera_facing":{"enum":["front","back","external"],"type":"string","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled","target_resolution","camera_default_on","camera_facing"],"type":"object"},"WSAuthMessage":{"description":"Websocket auth message","nullable":true,"properties":{"products":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"token":{"title":"Token","type":"string","x-stream-index":"002"},"user_details":{"$ref":"#/components/schemas/ConnectUserDetailsRequest","x-stream-index":"001"}},"required":["user_details","token"],"title":"WSAuthMessage","type":"object"}},"securitySchemes":{"JWT":{"description":"JWT should be always provided when stream-auth-type=jwt.\n\nUsing JWT auth request could be authenticated as user or as server-side.\n\nWhen using user authentication permission checking is going to be applied to requests based on the user that is\nperforming a request.\n\nThe `authorization` header should be a JWT string signed using the secret attached to the API key used to perform\nrequests.\n\n**WARNING** all client-side official SDK do not ship with token generation; this is to make sure that the API secret is not\nshared with an untrusted party such as a browser or a iOS/Android application. Tokens **must** be generated server-side.\nIf you wish, you can configure your application to ignore authentication (see `disable_auth_check`)\nThe JWT string must include only the user_id claim and can include any built-in JWT claim such as iat, exp as well.\n","in":"header","name":"Authorization","type":"apiKey"},"api_key":{"description":"Application API key should be always set in order to authenticate the request.","in":"query","name":"api_key","type":"apiKey"},"stream-auth-type":{"description":"Stream-Auth-Type should be always set in order to authenticate the request. Possible\nvalues: `jwt` or `anonymous`.\n\n`jwt` allows you to authenticate as a user. With this auth type you should also provide valid JWT in Authorization\nheader.\n\n`anonymous` allows you to authenticate as anonymous user. Please note that most advanced features are not available\nto anonymous users.","in":"header","name":"Stream-Auth-Type","type":"apiKey"}}},"info":{"title":"Stream API","version":"v187.13.0"},"openapi":"3.0.3","paths":{"/video/call/members":{"post":{"description":"Query call members with filter query\n","operationId":"QueryCallMembers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallMembersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallMembersResponse"}}},"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":"Query call members","tags":["product:video"]}},"/video/call/stats":{"post":{"description":"\n","operationId":"QueryCallStats","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallStatsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallStatsResponse"}}},"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":"Query Call Stats","tags":["product:video"]}},"/video/call/{type}/{id}":{"get":{"description":"\n","operationId":"GetCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"query","name":"connection_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"003"}},{"in":"query","name":"members_limit","schema":{"format":"int32","maximum":100,"minimum":0,"type":"integer","writeOnly":true,"x-stream-index":"004"}},{"in":"query","name":"ring","schema":{"type":"boolean","writeOnly":true,"x-stream-index":"005"}},{"in":"query","name":"notify","schema":{"type":"boolean","writeOnly":true,"x-stream-index":"006"}},{"in":"query","name":"video","schema":{"type":"boolean","writeOnly":true,"x-stream-index":"007"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCallResponse"}}},"description":"GetCallResponse"},"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":"Get Call","tags":["product:video"]},"patch":{"description":"\n\nSends events:\n- call.updated\n","operationId":"UpdateCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallRequest"}}},"description":"UpdateCallRequest","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallResponse"}}},"description":"UpdateCallResponse"},"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":"Update Call","tags":["product:video"]},"post":{"description":"Gets or creates a new call\n\nSends events:\n- call.created\n- call.notification\n- call.ring\n","operationId":"GetOrCreateCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"connection_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"008"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrCreateCallRequest"}}},"description":"GetOrCreateCallRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrCreateCallResponse"}}},"description":"GetOrCreateCallResponse"},"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":"Get or create a call","tags":["product:video"]}},"/video/call/{type}/{id}/accept":{"post":{"description":"\n\nSends events:\n- call.accepted\n","operationId":"AcceptCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcceptCallResponse"}}},"description":"AcceptCallResponse"},"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":"Accept Call","tags":["product:video"]}},"/video/call/{type}/{id}/block":{"post":{"description":"Block a user, preventing them from joining the call until they are unblocked.\n\nSends events:\n- call.blocked_user\n","operationId":"BlockUser","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUserRequest"}}},"description":"BlockUserRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUserResponse"}}},"description":"BlockUserResponse"},"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":"Block user on a call","tags":["product:video"]}},"/video/call/{type}/{id}/delete":{"post":{"description":"\n\nSends events:\n- call.deleted\n","operationId":"DeleteCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCallRequest"}}},"description":"DeleteCallRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCallResponse"}}},"description":"DeleteCallResponse"},"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":"Delete Call","tags":["product:video"]}},"/video/call/{type}/{id}/event":{"post":{"description":"Sends custom event to the call\n\nSends events:\n- custom\n","operationId":"SendCallEvent","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendCallEventRequest"}}},"description":"SendCallEventRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendCallEventResponse"}}},"description":"SendCallEventResponse"},"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":"Send custom event","tags":["product:video"]}},"/video/call/{type}/{id}/feedback":{"post":{"description":"\n\nSends events:\n- call.user_feedback_submitted\n","operationId":"CollectUserFeedback","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectUserFeedbackRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectUserFeedbackResponse"}}},"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":"Collect user feedback","tags":["product:video"]}},"/video/call/{type}/{id}/go_live":{"post":{"description":"\n\nSends events:\n- call.live_started\n","operationId":"GoLive","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoLiveRequest"}}},"description":"GoLiveRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoLiveResponse"}}},"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":"Set call as live","tags":["product:video"]}},"/video/call/{type}/{id}/join":{"post":{"description":"Request to join a call\n","operationId":"JoinCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"query","name":"connection_id","schema":{"title":"ConnectionID","type":"string","writeOnly":true,"x-stream-index":"008"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JoinCallRequest"}}},"description":"JoinCallRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JoinCallResponse"}}},"description":"JoinCallResponse"},"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":"Join call","tags":["product:video"]}},"/video/call/{type}/{id}/mark_ended":{"post":{"description":"\n\nSends events:\n- call.ended\n","operationId":"EndCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EndCallResponse"}}},"description":"EndCallResponse"},"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":"End call","tags":["product:video"]}},"/video/call/{type}/{id}/members":{"post":{"description":"\n\nSends events:\n- call.member_added\n- call.member_removed\n- call.member_updated\n","operationId":"UpdateCallMembers","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallMembersRequest"}}},"description":"UpdateCallMembersRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallMembersResponse"}}},"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":"Update Call Member","tags":["product:video"]}},"/video/call/{type}/{id}/mute_users":{"post":{"description":"Mutes users in a call\n","operationId":"MuteUsers","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteUsersRequest"}}},"description":"MuteUsersRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteUsersResponse"}}},"description":"MuteUsersResponse"},"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":"Mute users","tags":["product:video"]}},"/video/call/{type}/{id}/participants":{"post":{"description":"Returns a list of participants connected to the call\n","operationId":"QueryCallParticipants","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"type","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"limit","schema":{"format":"int32","maximum":100,"type":"integer","x-stream-index":"004"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallParticipantsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallParticipantsResponse"}}},"description":"Successful 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":"Query call participants","tags":["product:video"]}},"/video/call/{type}/{id}/pin":{"post":{"description":"Pins a track for all users in the call.\n","operationId":"VideoPin","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PinRequest"}}},"description":"PinRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PinResponse"}}},"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":"Pin","tags":["product:video"]}},"/video/call/{type}/{id}/reaction":{"post":{"description":"Sends reaction to the call\n\nSends events:\n- call.reaction_new\n","operationId":"SendVideoReaction","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendReactionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendReactionResponse"}}},"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":"Send reaction to the call","tags":["product:video"]}},"/video/call/{type}/{id}/recordings":{"get":{"description":"Lists recordings\n","operationId":"ListRecordings","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListRecordingsResponse"}}},"description":"ListRecordingsResponse"},"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":"List recordings","tags":["product:video"]}},"/video/call/{type}/{id}/reject":{"post":{"description":"\n\nSends events:\n- call.rejected\n","operationId":"RejectCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RejectCallRequest"}}},"description":"RejectCallRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RejectCallResponse"}}},"description":"RejectCallResponse"},"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":"Reject Call","tags":["product:video"]}},"/video/call/{type}/{id}/report":{"get":{"description":"\n","operationId":"GetCallReport","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"query","name":"session_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCallReportResponse"}}},"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":"Get call report","tags":["product:video"]}},"/video/call/{type}/{id}/request_permission":{"post":{"description":"Request permission to perform an action\n\nSends events:\n- call.permission_request\n","operationId":"RequestPermission","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestPermissionRequest"}}},"description":"RequestPermissionRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestPermissionResponse"}}},"description":"RequestPermissionResponse"},"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":"Request permission","tags":["product:video"]}},"/video/call/{type}/{id}/rtmp_broadcasts":{"post":{"description":"Starts RTMP broadcasts for the provided RTMP destinations\n","operationId":"StartRTMPBroadcasts","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRTMPBroadcastsRequest"}}},"description":"StartRTMPBroadcastsRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRTMPBroadcastsResponse"}}},"description":"StartRTMPBroadcastsResponse"},"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":"Start RTMP broadcasts","tags":["product:video"]}},"/video/call/{type}/{id}/rtmp_broadcasts/stop":{"post":{"description":"Stop all RTMP broadcasts for the provided call\n","operationId":"StopAllRTMPBroadcasts","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopAllRTMPBroadcastsResponse"}}},"description":"StopAllRTMPBroadcastsResponse"},"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":"Stop all RTMP broadcasts for a call","tags":["product:video"]}},"/video/call/{type}/{id}/rtmp_broadcasts/{name}/stop":{"post":{"description":"Stop RTMP broadcasts for the provided RTMP destinations\n","operationId":"StopRTMPBroadcast","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopRTMPBroadcastsRequest"}}},"description":"StopRTMPBroadcastsRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopRTMPBroadcastsResponse"}}},"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":"Stop RTMP broadcasts","tags":["product:video"]}},"/video/call/{type}/{id}/start_broadcasting":{"post":{"description":"Starts HLS broadcasting\n","operationId":"StartHLSBroadcasting","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartHLSBroadcastingResponse"}}},"description":"StartHLSBroadcastingResponse"},"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":"Start HLS broadcasting","tags":["product:video"]}},"/video/call/{type}/{id}/start_closed_captions":{"post":{"description":"Starts closed captions\n","operationId":"StartClosedCaptions","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartClosedCaptionsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartClosedCaptionsResponse"}}},"description":"Successful 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":"Start closed captions","tags":["product:video"]}},"/video/call/{type}/{id}/start_frame_recording":{"post":{"description":"Starts frame by frame recording\n\nSends events:\n- call.frame_recording_started\n","operationId":"StartFrameRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartFrameRecordingRequest"}}},"description":"StartFrameRecordingRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartFrameRecordingResponse"}}},"description":"StartFrameRecordingResponse"},"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":"Start frame recording","tags":["product:video"]}},"/video/call/{type}/{id}/start_recording":{"post":{"description":"Starts recording\n\nSends events:\n- call.recording_started\n","operationId":"StartRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRecordingRequest"}}},"description":"StartRecordingRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRecordingResponse"}}},"description":"StartRecordingResponse"},"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":"Start recording","tags":["product:video"]}},"/video/call/{type}/{id}/start_transcription":{"post":{"description":"Starts transcription\n","operationId":"StartTranscription","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartTranscriptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartTranscriptionResponse"}}},"description":"StartTranscriptionResponse"},"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":"Start transcription","tags":["product:video"]}},"/video/call/{type}/{id}/stop_broadcasting":{"post":{"description":"Stops HLS broadcasting\n","operationId":"StopHLSBroadcasting","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopHLSBroadcastingResponse"}}},"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":"Stop HLS broadcasting","tags":["product:video"]}},"/video/call/{type}/{id}/stop_closed_captions":{"post":{"description":"Stops closed captions\n\nSends events:\n- call.transcription_stopped\n","operationId":"StopClosedCaptions","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopClosedCaptionsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopClosedCaptionsResponse"}}},"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":"Stop closed captions","tags":["product:video"]}},"/video/call/{type}/{id}/stop_frame_recording":{"post":{"description":"Stops frame recording\n\nSends events:\n- call.frame_recording_stopped\n","operationId":"StopFrameRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopFrameRecordingResponse"}}},"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":"Stop frame recording","tags":["product:video"]}},"/video/call/{type}/{id}/stop_live":{"post":{"description":"\n\nSends events:\n- call.updated\n","operationId":"StopLive","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopLiveRequest"}}},"description":"StopLiveRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopLiveResponse"}}},"description":"StopLiveResponse"},"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":"Set call as not live","tags":["product:video"]}},"/video/call/{type}/{id}/stop_recording":{"post":{"description":"Stops recording\n\nSends events:\n- call.recording_stopped\n","operationId":"StopRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopRecordingResponse"}}},"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":"Stop recording","tags":["product:video"]}},"/video/call/{type}/{id}/stop_transcription":{"post":{"description":"Stops transcription\n\nSends events:\n- call.transcription_stopped\n","operationId":"StopTranscription","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopTranscriptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopTranscriptionResponse"}}},"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":"Stop transcription","tags":["product:video"]}},"/video/call/{type}/{id}/transcriptions":{"get":{"description":"Lists transcriptions\n","operationId":"ListTranscriptions","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTranscriptionsResponse"}}},"description":"ListTranscriptionsResponse"},"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":"List transcriptions","tags":["product:video"]}},"/video/call/{type}/{id}/unblock":{"post":{"description":"Removes the block for a user on a call. The user will be able to join the call again.\n\nSends events:\n- call.unblocked_user\n","operationId":"UnblockUser","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUserRequest"}}},"description":"UnblockUserRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUserResponse"}}},"description":"UnblockUserResponse"},"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":"Unblocks user on a call","tags":["product:video"]}},"/video/call/{type}/{id}/unpin":{"post":{"description":"Unpins a track for all users in the call.\n","operationId":"VideoUnpin","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnpinRequest"}}},"description":"UnpinRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnpinResponse"}}},"description":"UnpinResponse"},"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":"Unpin","tags":["product:video"]}},"/video/call/{type}/{id}/user_permissions":{"post":{"description":"Updates user permissions\n\nSends events:\n- call.permissions_updated\n","operationId":"UpdateUserPermissions","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"005.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"005.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUserPermissionsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUserPermissionsResponse"}}},"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":"Update user permissions","tags":["product:video"]}},"/video/call/{type}/{id}/{session}/recordings/{filename}":{"delete":{"description":"Deletes recording\n","operationId":"DeleteRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"path","name":"session","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"003"}},{"in":"path","name":"filename","required":true,"schema":{"maxLength":256,"type":"string","writeOnly":true,"x-stream-index":"004"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteRecordingResponse"}}},"description":"DeleteRecordingResponse"},"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":"Delete recording","tags":["product:video"]}},"/video/call/{type}/{id}/{session}/transcriptions/{filename}":{"delete":{"description":"Deletes transcription\n","operationId":"DeleteTranscription","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"path","name":"session","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"003"}},{"in":"path","name":"filename","required":true,"schema":{"maxLength":256,"type":"string","writeOnly":true,"x-stream-index":"004"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteTranscriptionResponse"}}},"description":"DeleteTranscriptionResponse"},"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":"Delete transcription","tags":["product:video"]}},"/video/calls":{"post":{"description":"Query calls with filter query\n","operationId":"QueryCalls","parameters":[{"in":"query","name":"connection_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallsRequest"}}},"description":"QueryCallsRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallsResponse"}}},"description":"QueryCallsResponse"},"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":"Query call","tags":["product:video"]}},"/video/devices":{"delete":{"description":"Deletes one device\n","operationId":"DeleteDevice","parameters":[{"in":"query","name":"id","required":true,"schema":{"description":"Device ID to delete","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete device","tags":["product:video"]},"get":{"description":"Returns all available devices\n","operationId":"ListDevices","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDevicesResponse"}}},"description":"ListDevicesResponse"},"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":"List devices","tags":["product:video"]},"post":{"description":"Adds a new device to a user, if the same device already exists the call will have no effect\n","operationId":"CreateDevice","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDeviceRequest"}}},"description":"CreateDeviceRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Create device","tags":["product:video"]}},"/video/edges":{"get":{"description":"Returns the list of all edges available for video calls.\n","operationId":"GetEdges","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetEdgesResponse"}}},"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":"Get Edges","tags":["product:video"]}},"/video/guest":{"post":{"description":"\n","operationId":"CreateGuest","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGuestRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGuestResponse"}}},"description":"Successful 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":"Create Guest","tags":["product:video"]}},"/video/longpoll":{"get":{"description":"Establishes WebSocket connection for user to video\n\nSends events:\n- health.check\n- connection.ok\n","operationId":"VideoConnect","responses":{"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":"Video Connect (WebSocket)","tags":["product:video"]}},"/video/stats":{"post":{"description":"\n","operationId":"QueryAggregateCallStats","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryAggregateCallStatsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryAggregateCallStatsResponse"}}},"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":"Query Aggregate call Stats","tags":["product:video"]}}},"security":[{"JWT":[],"api_key":[],"stream-auth-type":[]},{"api_key":[],"stream-auth-type":[]}],"servers":[{"description":"Stream API","url":"https://chat.stream-io-api.com"}]} \ No newline at end of file +{"components":{"schemas":{"APIError":{"properties":{"StatusCode":{"description":"Response HTTP status code","format":"int32","title":"Status code","type":"integer","x-stream-index":"004"},"code":{"description":"API error code","format":"int32","title":"Code","type":"integer","x-stream-index":"001"},"details":{"description":"Additional error-specific information","items":{"type":"integer"},"title":"Details","type":"array","x-stream-index":"007"},"duration":{"description":"Request duration","title":"Duration","type":"string","x-stream-index":"005"},"exception_fields":{"additionalProperties":{"type":"string"},"description":"Additional error info","title":"Exception fields","type":"object","x-stream-index":"003"},"message":{"description":"Message describing an error","title":"Message","type":"string","x-stream-index":"002"},"more_info":{"description":"URL with additional information","title":"More info","type":"string","x-stream-index":"006"},"unrecoverable":{"description":"Flag that indicates if the error is unrecoverable, requests that return unrecoverable errors should not be retried, this error only applies to the request that caused it","title":"Unrecoverable","type":"boolean","x-stream-index":"008"}},"required":["code","message","StatusCode","duration","more_info","details"],"title":"Error response","type":"object"},"AcceptCallRequest":{"description":"AcceptCallRequest is the payload for accepting a call.","nullable":true,"title":"AcceptCallRequest","type":"object"},"AcceptCallResponse":{"description":"AcceptCallResponse is the payload for accepting a call.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"AcceptCallResponse","type":"object"},"AppEventResponse":{"properties":{"async_url_enrich_enabled":{"description":"boolean","title":"Async URL Enrichment Enabled","type":"boolean","x-stream-index":"002"},"auto_translation_enabled":{"description":"boolean","title":"Auto Translation Enabled","type":"boolean","x-stream-index":"003"},"file_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","description":"file upload config","title":"File Upload Config","x-stream-index":"004"},"image_upload_config":{"$ref":"#/components/schemas/FileUploadConfig","description":"file upload config","title":"Image Upload Config","x-stream-index":"005"},"name":{"description":"string","title":"App name","type":"string","x-stream-index":"001"}},"required":["name","auto_translation_enabled"],"type":"object"},"AppUpdatedEvent":{"description":"Emitted when app settings are updated","nullable":true,"properties":{"app":{"$ref":"#/components/schemas/AppEventResponse","description":"application configuration","title":"App settings","x-stream-index":"002"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"received_at":{"format":"date-time","type":"string","x-stream-index":"001.004"},"type":{"default":"app.updated","description":"The type of event: \"app.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.002"}},"required":["type","created_at","custom","app"],"title":"AppUpdatedEvent","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"},"AudioSettingsRequest":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"001"},"default_device":{"enum":["speaker","earpiece"],"type":"string","x-stream-index":"006"},"mic_default_on":{"type":"boolean","x-stream-index":"004"},"noise_cancellation":{"$ref":"#/components/schemas/NoiseCancellationSettings","x-stream-index":"007"},"opus_dtx_enabled":{"type":"boolean","x-stream-index":"002"},"redundant_coding_enabled":{"type":"boolean","x-stream-index":"003"},"speaker_default_on":{"type":"boolean","x-stream-index":"005"}},"required":["default_device"],"type":"object"},"AudioSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"001"},"default_device":{"enum":["speaker","earpiece"],"type":"string","x-stream-index":"006"},"mic_default_on":{"type":"boolean","x-stream-index":"004"},"noise_cancellation":{"$ref":"#/components/schemas/NoiseCancellationSettings","x-stream-index":"007"},"opus_dtx_enabled":{"type":"boolean","x-stream-index":"002"},"redundant_coding_enabled":{"type":"boolean","x-stream-index":"003"},"speaker_default_on":{"type":"boolean","x-stream-index":"005"}},"required":["access_request_enabled","opus_dtx_enabled","redundant_coding_enabled","mic_default_on","speaker_default_on","default_device"],"type":"object"},"BackstageSettingsRequest":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"002"}},"type":"object"},"BackstageSettingsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"BlockUserRequest":{"description":"BlockUserRequest is the payload for blocking a user.","nullable":true,"properties":{"user_id":{"description":"the user to block","title":"UserID","type":"string","x-stream-index":"003"}},"required":["user_id"],"title":"BlockUserRequest","type":"object"},"BlockUserResponse":{"description":"BlockUserResponse is the payload for blocking a user.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"BlockUserResponse","type":"object"},"BlockedUserEvent":{"description":"This event is sent to call participants to notify when a user is blocked on a call, clients can use this event to show a notification.\nIf the user is the current user, the client should leave the call screen as well","properties":{"blocked_by_user":{"$ref":"#/components/schemas/UserResponse","description":"The user that blocked the user, null if the user was blocked by server-side","title":"Blocked by","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"call.blocked_user","description":"The type of event: \"call.blocked_user\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user that was blocked","title":"User","x-stream-index":"003"}},"required":["type","created_at","call_cid","user"],"title":"BlockedUserEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"Bound":{"properties":{"inclusive":{"type":"boolean","x-stream-index":"002"},"value":{"format":"float","type":"number","x-stream-index":"001"}},"required":["value","inclusive"],"type":"object"},"BroadcastSettingsRequest":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettingsRequest","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettingsRequest","x-stream-index":"003"}},"type":"object"},"BroadcastSettingsResponse":{"description":"BroadcastSettingsResponse is the payload for broadcasting settings","properties":{"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettingsResponse","title":"HLS","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettingsResponse","title":"RTMP","x-stream-index":"003"}},"required":["enabled","hls","rtmp"],"title":"BroadcastSettingsResponse","type":"object"},"CallAcceptedEvent":{"description":"This event is sent when a user accepts a notification to join a call.","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"call.accepted","description":"The type of event: \"call.accepted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who accepted the call","title":"User","x-stream-index":"004"}},"required":["type","created_at","call_cid","call","user"],"title":"CallAcceptedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallClosedCaption":{"description":"CallClosedCaption represents a closed caption of a call.","properties":{"end_time":{"format":"date-time","title":"The end time of the closed caption.","type":"string","x-stream-index":"003"},"speaker_id":{"title":"The speaker ID of the closed caption.","type":"string","x-stream-index":"004"},"start_time":{"format":"date-time","title":"The start time of the closed caption.","type":"string","x-stream-index":"002"},"text":{"title":"The text of the closed caption.","type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserResponse","title":"The full user for the closed caption.","x-stream-index":"005"}},"required":["text","start_time","end_time","speaker_id","user"],"title":"CallClosedCaption","type":"object"},"CallClosedCaptionsFailedEvent":{"description":"This event is sent when call closed captions has failed","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"call.closed_captions_failed","description":"The type of event: \"call.closed_captions_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallClosedCaptionsFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallClosedCaptionsStartedEvent":{"description":"This event is sent when call closed caption has started","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"call.closed_captions_started","description":"The type of event: \"call.closed_captions_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallClosedCaptionsStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallClosedCaptionsStoppedEvent":{"description":"This event is sent when call closed captions has stopped","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"call.closed_captions_stopped","description":"The type of event: \"call.transcription_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallClosedCaptionsStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallCreatedEvent":{"description":"This event is sent when a call is created. Clients receiving this event should check if the ringing\nfield is set to true and if so, show the call screen","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"members":{"description":"the members added to this call","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"004"},"type":{"default":"call.created","description":"The type of event: \"call.created\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","members"],"title":"CallCreatedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallDeletedEvent":{"description":"This event is sent when a call is deleted. Clients receiving this event should leave the call screen","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"call.deleted","description":"The type of event: \"call.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call"],"title":"CallDeletedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallDurationReport":{"properties":{"histogram":{"items":{"$ref":"#/components/schemas/ReportByHistogramBucket"},"type":"array","x-stream-index":"001"}},"required":["histogram"],"type":"object"},"CallDurationReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateCallDurationReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"CallEndedEvent":{"description":"This event is sent when a call is mark as ended for all its participants. Clients receiving this event should leave the call screen","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"reason":{"description":"The reason why the call ended, if available","title":"CallEndedReason","type":"string","x-stream-index":"005"},"type":{"default":"call.ended","description":"The type of event: \"call.ended\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who ended the call, null if the call was ended by the server","title":"User","x-stream-index":"004"}},"required":["type","created_at","call_cid","call"],"title":"CallEndedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallFrameRecordingFailedEvent":{"description":"This event is sent when frame recording has failed","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.frame_recording_failed","description":"The type of event: \"call.frame_recording_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","egress_id"],"title":"CallFrameRecordingFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallFrameRecordingFrameReadyEvent":{"description":"This event is sent when a frame is captured from a call","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"captured_at":{"description":"The time the frame was captured","format":"date-time","title":"CapturedAt","type":"string","x-stream-index":"006"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"008"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"track_type":{"description":"The type of the track frame was captured from (TRACK_TYPE_VIDEO|TRACK_TYPE_SCREEN_SHARE)","title":"TrackType","type":"string","x-stream-index":"004"},"type":{"default":"call.frame_recording_ready","description":"The type of event: \"call.frame_recording_ready\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"url":{"description":"The URL of the frame","title":"URL","type":"string","x-stream-index":"005"},"users":{"additionalProperties":{"$ref":"#/components/schemas/UserResponse"},"description":"The users in the frame","title":"Users","type":"object","x-stream-index":"007"}},"required":["type","created_at","call_cid","session_id","track_type","url","captured_at","users","egress_id"],"title":"CallFrameRecordingFrameReadyEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallFrameRecordingStartedEvent":{"description":"This event is sent when frame recording has started","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.frame_recording_started","description":"The type of event: \"call.frame_recording_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","egress_id"],"title":"CallFrameRecordingStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallFrameRecordingStoppedEvent":{"description":"This event is sent when frame recording has stopped","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.frame_recording_stopped","description":"The type of event: \"call.frame_recording_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","egress_id"],"title":"CallFrameRecordingStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallHLSBroadcastingFailedEvent":{"description":"This event is sent when HLS broadcasting has failed","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"call.hls_broadcasting_failed","description":"The type of event: \"call.hls_broadcasting_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallHLSBroadcastingFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallHLSBroadcastingStartedEvent":{"description":"This event is sent when HLS broadcasting has started","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"hls_playlist_url":{"type":"string","x-stream-index":"004"},"type":{"default":"call.hls_broadcasting_started","description":"The type of event: \"call.hls_broadcasting_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","hls_playlist_url"],"title":"CallHLSBroadcastingStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallHLSBroadcastingStoppedEvent":{"description":"This event is sent when HLS broadcasting has stopped","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"call.hls_broadcasting_stopped","description":"The type of event: \"call.hls_broadcasting_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallHLSBroadcastingStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallIngressResponse":{"description":"CallIngressResponse is the payload for ingress settings","properties":{"rtmp":{"$ref":"#/components/schemas/RTMPIngress","title":"RTMP","x-stream-index":"001"}},"required":["rtmp"],"title":"CallIngressResponse","type":"object"},"CallLiveStartedEvent":{"description":"This event is sent when a call is started. Clients receiving this event should start the call.","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"call.live_started","description":"The type of event: \"call.live_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call"],"title":"CallLiveStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMemberAddedEvent":{"description":"This event is sent when one or more members are added to a call","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"members":{"description":"the members added to this call","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"004"},"type":{"default":"call.member_added","description":"The type of event: \"call.member_added\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","members"],"title":"CallMemberAddedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMemberRemovedEvent":{"description":"This event is sent when one or more members are removed from a call","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"members":{"description":"the list of member IDs removed from the call","items":{"type":"string"},"title":"Members","type":"array","x-stream-index":"004"},"type":{"default":"call.member_removed","description":"The type of event: \"call.member_removed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","members"],"title":"CallMemberRemovedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMemberUpdatedEvent":{"description":"This event is sent when one or more members are updated","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"members":{"description":"The list of members that were updated","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"004"},"type":{"default":"call.member_updated","description":"The type of event: \"call.member_updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","members"],"title":"CallMemberUpdatedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMemberUpdatedPermissionEvent":{"description":"This event is sent when one or more members get its role updated","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"capabilities_by_role":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"The capabilities by role for this call","title":"CapabilitiesByRole","type":"object","x-stream-index":"004"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"members":{"description":"The list of members that were updated","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"005"},"type":{"default":"call.member_updated_permission","description":"The type of event: \"call.member_added\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","capabilities_by_role","members"],"title":"CallMemberUpdatedPermissionEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMissedEvent":{"description":"This event is sent to call members who did not accept/reject/join the call to notify they missed the call","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"members":{"description":"List of members who missed the call","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"005"},"notify_user":{"type":"boolean","x-stream-index":"007"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.missed","description":"The type of event: \"call.notification\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The caller from whom the call was missed","title":"User","x-stream-index":"006"}},"required":["type","created_at","call_cid","session_id","call","members","user","notify_user"],"title":"CallMissedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallModerationBlurEvent":{"properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"type":{"default":"call.moderation_blur","type":"string","x-stream-index":"001.001"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["type","created_at","call_cid","user_id","custom"],"title":"CallModerationBlurEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallModerationWarningEvent":{"properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"message":{"type":"string","x-stream-index":"004"},"type":{"default":"call.moderation_warning","type":"string","x-stream-index":"001.001"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["type","created_at","call_cid","user_id","message","custom"],"title":"CallModerationWarningEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallNotificationEvent":{"description":"This event is sent to all call members to notify they are getting called","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"members":{"description":"Call members","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"005"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.notification","description":"The type of event: \"call.notification\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user that sent the call notification","title":"User","x-stream-index":"006"}},"required":["type","created_at","call_cid","session_id","call","members","user"],"title":"CallNotificationEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallParticipantCountReport":{"properties":{"histogram":{"items":{"$ref":"#/components/schemas/ReportByHistogramBucket"},"type":"array","x-stream-index":"001"}},"required":["histogram"],"type":"object"},"CallParticipantCountReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateCallParticipantCountReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"CallParticipantResponse":{"properties":{"joined_at":{"format":"date-time","type":"string","x-stream-index":"004"},"role":{"type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"},"user_session_id":{"type":"string","x-stream-index":"002"}},"required":["user","user_session_id","role","joined_at"],"type":"object"},"CallReactionEvent":{"description":"This event is sent when a reaction is sent in a call, clients should use this to show the reaction in the call screen","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"reaction":{"$ref":"#/components/schemas/ReactionResponse","description":"the reaction object sent by the user on the call","title":"reaction","x-stream-index":"003"},"type":{"default":"call.reaction_new","description":"The type of event: \"call.reaction_new\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","reaction"],"title":"CallReactionEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRecording":{"description":"CallRecording represents a recording of a call.","properties":{"end_time":{"format":"date-time","title":"The end time of the recording.","type":"string","x-stream-index":"004"},"filename":{"title":"The filename of the recording.","type":"string","x-stream-index":"001"},"session_id":{"title":"The session ID of the recording.","type":"string","x-stream-index":"005"},"start_time":{"format":"date-time","title":"The start time of the recording.","type":"string","x-stream-index":"003"},"url":{"title":"The URL of the recording.","type":"string","x-stream-index":"002"}},"required":["filename","url","start_time","end_time","session_id"],"title":"CallRecording","type":"object"},"CallRecordingFailedEvent":{"description":"This event is sent when call recording has failed","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"003"},"type":{"default":"call.recording_failed","description":"The type of event: \"call.recording_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","egress_id"],"title":"CallRecordingFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRecordingReadyEvent":{"description":"This event is sent when call recording is ready","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"call_recording":{"$ref":"#/components/schemas/CallRecording","description":"The call recording object","title":"CallRecording","x-stream-index":"003"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.recording_ready","description":"The type of event: \"call.recording_ready\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call_recording","egress_id"],"title":"CallRecordingReadyEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRecordingStartedEvent":{"description":"This event is sent when call recording has started","properties":{"call_cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"002.002"},"egress_id":{"type":"string","x-stream-index":"001"},"type":{"default":"call.recording_started","description":"The type of event: \"call.recording_started\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001"}},"required":["egress_id","type","created_at","call_cid"],"title":"CallRecordingStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRecordingStoppedEvent":{"description":"This event is sent when call recording has stopped","properties":{"call_cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"002.002"},"egress_id":{"type":"string","x-stream-index":"001"},"type":{"default":"call.recording_stopped","description":"The type of event: \"call.recording_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001"}},"required":["egress_id","type","created_at","call_cid"],"title":"CallRecordingStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRejectedEvent":{"description":"This event is sent when a user rejects a notification to join a call.","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"reason":{"description":"Provides information about why the call was rejected. You can provide any value, but the Stream API and SDKs use these default values: rejected, cancel, timeout and busy","title":"Reason","type":"string","x-stream-index":"005"},"type":{"default":"call.rejected","description":"The type of event: \"call.rejected\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who rejected the call","title":"User","x-stream-index":"004"}},"required":["type","created_at","call_cid","call","user"],"title":"CallRejectedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallReportResponse":{"properties":{"ended_at":{"format":"date-time","type":"string","x-stream-index":"003"},"score":{"format":"float","type":"number","x-stream-index":"001"},"started_at":{"format":"date-time","type":"string","x-stream-index":"002"}},"required":["score"],"type":"object"},"CallRequest":{"description":"CallRequest is the payload for creating a call.","properties":{"channel_cid":{"type":"string","x-stream-index":"009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"members":{"items":{"$ref":"#/components/schemas/MemberRequest"},"maximum":100,"type":"array","x-stream-index":"005"},"settings_override":{"$ref":"#/components/schemas/CallSettingsRequest","x-stream-index":"006"},"starts_at":{"format":"date-time","type":"string","x-stream-index":"007"},"team":{"type":"string","x-stream-index":"001"},"video":{"type":"boolean","x-stream-index":"008"}},"title":"CallRequest","type":"object"},"CallResponse":{"description":"Represents a call","properties":{"backstage":{"type":"boolean","x-stream-index":"016"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"018"},"captioning":{"type":"boolean","x-stream-index":"013"},"channel_cid":{"type":"string","x-stream-index":"024"},"cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"009"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"The user that created the call","title":"Created By","x-stream-index":"007"},"current_session_id":{"type":"string","x-stream-index":"005"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"008"},"egress":{"$ref":"#/components/schemas/EgressResponse","x-stream-index":"021"},"ended_at":{"description":"Date/time when the call ended","format":"date-time","title":"Ended At","type":"string","x-stream-index":"014"},"id":{"description":"Call ID","title":"ID","type":"string","x-stream-index":"003"},"ingress":{"$ref":"#/components/schemas/CallIngressResponse","x-stream-index":"019"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"023"},"recording":{"type":"boolean","x-stream-index":"011"},"session":{"$ref":"#/components/schemas/CallSessionResponse","x-stream-index":"020"},"settings":{"$ref":"#/components/schemas/CallSettingsResponse","x-stream-index":"017"},"starts_at":{"description":"Date/time when the call will start","format":"date-time","title":"Starts At","type":"string","x-stream-index":"015"},"team":{"type":"string","x-stream-index":"006"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailResponse","x-stream-index":"022"},"transcribing":{"type":"boolean","x-stream-index":"012"},"type":{"description":"The type of call","title":"Type","type":"string","x-stream-index":"002"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"010"}},"required":["type","id","cid","current_session_id","created_by","custom","created_at","updated_at","recording","transcribing","captioning","backstage","settings","blocked_user_ids","ingress","egress"],"title":"CallResponse","type":"object"},"CallRingEvent":{"description":"This event is sent to all call members to notify they are getting called","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"005"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"members":{"description":"Call members","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"006"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.ring","description":"The type of event: \"call.notification\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user that sent the call notification","title":"User","x-stream-index":"007"},"video":{"type":"boolean","x-stream-index":"008"}},"required":["type","created_at","call_cid","session_id","call","members","user","video"],"title":"CallRingEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRtmpBroadcastFailedEvent":{"description":"This event is sent when a call RTMP broadcast has failed","properties":{"call_cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"002.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.002"},"name":{"description":"Name of the given RTMP broadcast","title":"Name","type":"string","x-stream-index":"003"},"type":{"default":"call.rtmp_broadcast_failed","description":"The type of event: \"call.rtmp_broadcast_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","name"],"title":"CallRtmpBroadcastFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRtmpBroadcastStartedEvent":{"description":"This event is sent when RTMP broadcast has started","properties":{"call_cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"002.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.002"},"name":{"description":"Name of the given RTMP broadcast","title":"Name","type":"string","x-stream-index":"003"},"type":{"default":"call.rtmp_broadcast_started","description":"The type of event: \"call.rtmp_broadcast_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","name"],"title":"CallRtmpBroadcastStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRtmpBroadcastStoppedEvent":{"description":"This event is sent when RTMP broadcast has stopped","properties":{"call_cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"002.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.002"},"name":{"description":"Name of the given RTMP broadcast","title":"Name","type":"string","x-stream-index":"003"},"type":{"default":"call.rtmp_broadcast_stopped","description":"The type of event: \"call.rtmp_broadcast_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","name"],"title":"CallRtmpBroadcastStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSessionEndedEvent":{"description":"This event is sent when a call session ends","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_ended","description":"The type of event: \"call.session_ended\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","call"],"title":"CallSessionEndedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSessionParticipantCountsUpdatedEvent":{"description":"This event is sent when the participant counts in a call session are updated","properties":{"anonymous_participant_count":{"format":"int32","type":"integer","x-stream-index":"005"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"participants_count_by_role":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"004"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_participant_count_updated","description":"The type of event: \"call.session_participant_count_updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","participants_count_by_role","anonymous_participant_count"],"title":"CallSessionParticipantCountsUpdatedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSessionParticipantJoinedEvent":{"description":"This event is sent when a participant joins a call session","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"participant":{"$ref":"#/components/schemas/CallParticipantResponse","description":"The participant that joined the session","title":"Participant","x-stream-index":"004"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_participant_joined","description":"The type of event: \"call.session_participant_joined\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","participant"],"title":"CallSessionParticipantJoinedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSessionParticipantLeftEvent":{"description":"This event is sent when a participant leaves a call session","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"duration_seconds":{"description":"The duration participant was in the session in seconds","format":"int32","title":"Duration","type":"integer","x-stream-index":"005"},"participant":{"$ref":"#/components/schemas/CallParticipantResponse","description":"The participant that left the session","title":"Participant","x-stream-index":"004"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_participant_left","description":"The type of event: \"call.session_participant_left\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","participant","duration_seconds"],"title":"CallSessionParticipantLeftEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSessionResponse":{"properties":{"accepted_by":{"additionalProperties":{"format":"date-time","type":"string"},"type":"object","x-stream-index":"008"},"anonymous_participant_count":{"format":"int32","type":"integer","x-stream-index":"006"},"ended_at":{"format":"date-time","type":"string","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"live_ended_at":{"format":"date-time","type":"string","x-stream-index":"011"},"live_started_at":{"format":"date-time","type":"string","x-stream-index":"010"},"missed_by":{"additionalProperties":{"format":"date-time","type":"string"},"type":"object","x-stream-index":"009"},"participants":{"items":{"$ref":"#/components/schemas/CallParticipantResponse"},"type":"array","x-stream-index":"004"},"participants_count_by_role":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"005"},"rejected_by":{"additionalProperties":{"format":"date-time","type":"string"},"type":"object","x-stream-index":"007"},"started_at":{"format":"date-time","type":"string","x-stream-index":"002"},"timer_ends_at":{"format":"date-time","type":"string","x-stream-index":"012"}},"required":["id","participants","participants_count_by_role","anonymous_participant_count","rejected_by","accepted_by","missed_by"],"type":"object"},"CallSessionStartedEvent":{"description":"This event is sent when a call session starts","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_started","description":"The type of event: \"call.session_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","call"],"title":"CallSessionStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSettingsRequest":{"properties":{"audio":{"$ref":"#/components/schemas/AudioSettingsRequest","x-stream-index":"001"},"backstage":{"$ref":"#/components/schemas/BackstageSettingsRequest","x-stream-index":"002"},"broadcasting":{"$ref":"#/components/schemas/BroadcastSettingsRequest","x-stream-index":"010"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordingSettingsRequest","x-stream-index":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettingsRequest","x-stream-index":"003"},"ingress":{"$ref":"#/components/schemas/IngressSettingsRequest","x-stream-index":"014"},"limits":{"$ref":"#/components/schemas/LimitsSettingsRequest","x-stream-index":"012"},"recording":{"$ref":"#/components/schemas/RecordSettingsRequest","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettingsRequest","x-stream-index":"007"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettingsRequest","x-stream-index":"008"},"session":{"$ref":"#/components/schemas/SessionSettingsRequest","x-stream-index":"013"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettingsRequest","x-stream-index":"011"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettingsRequest","x-stream-index":"009"},"video":{"$ref":"#/components/schemas/VideoSettingsRequest","x-stream-index":"004"}},"type":"object"},"CallSettingsResponse":{"properties":{"audio":{"$ref":"#/components/schemas/AudioSettingsResponse","x-stream-index":"001"},"backstage":{"$ref":"#/components/schemas/BackstageSettingsResponse","x-stream-index":"002"},"broadcasting":{"$ref":"#/components/schemas/BroadcastSettingsResponse","x-stream-index":"003"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordingSettingsResponse","x-stream-index":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettingsResponse","x-stream-index":"004"},"ingress":{"$ref":"#/components/schemas/IngressSettingsResponse","x-stream-index":"014"},"limits":{"$ref":"#/components/schemas/LimitsSettingsResponse","x-stream-index":"012"},"recording":{"$ref":"#/components/schemas/RecordSettingsResponse","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettingsResponse","x-stream-index":"007"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettingsResponse","x-stream-index":"008"},"session":{"$ref":"#/components/schemas/SessionSettingsResponse","x-stream-index":"013"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettingsResponse","x-stream-index":"011"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettingsResponse","x-stream-index":"009"},"video":{"$ref":"#/components/schemas/VideoSettingsResponse","x-stream-index":"010"}},"required":["audio","backstage","broadcasting","geofencing","recording","frame_recording","ring","screensharing","transcription","video","thumbnails","limits","session"],"type":"object"},"CallStateResponseFields":{"description":"CallStateResponseFields is the payload for call state response","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001"},"members":{"description":"List of call members","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"002"},"membership":{"$ref":"#/components/schemas/MemberResponse","description":"Current user membership object","title":"Membership","x-stream-index":"003"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"004"}},"required":["call","members","own_capabilities","blocked_users"],"title":"CallStateResponseFields","type":"object"},"CallStatsReportReadyEvent":{"description":"This event is sent when the insights report is ready","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.stats_report_ready","description":"The type of event, \"call.report_ready\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id"],"title":"CallStatsReportReadyEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallStatsReportSummaryResponse":{"properties":{"call_cid":{"type":"string","x-stream-index":"001"},"call_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"008"},"call_session_id":{"type":"string","x-stream-index":"002"},"call_status":{"type":"string","x-stream-index":"004"},"created_at":{"format":"date-time","type":"string","x-stream-index":"007"},"first_stats_time":{"format":"date-time","type":"string","x-stream-index":"003"},"min_user_rating":{"format":"int32","type":"integer","x-stream-index":"006"},"quality_score":{"format":"int32","type":"integer","x-stream-index":"005"}},"required":["call_cid","call_session_id","first_stats_time","call_status","call_duration_seconds"],"type":"object"},"CallTranscription":{"description":"CallTranscription represents a transcription of a call.","properties":{"end_time":{"format":"date-time","title":"The end time of the transcription.","type":"string","x-stream-index":"004"},"filename":{"title":"The filename of the transcription.","type":"string","x-stream-index":"001"},"session_id":{"title":"The session ID of the transcription.","type":"string","x-stream-index":"005"},"start_time":{"format":"date-time","title":"The start time of the transcription.","type":"string","x-stream-index":"003"},"url":{"title":"The URL of the transcription.","type":"string","x-stream-index":"002"}},"required":["filename","url","start_time","end_time","session_id"],"title":"CallTranscription","type":"object"},"CallTranscriptionFailedEvent":{"description":"This event is sent when call transcription has failed","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"003"},"error":{"description":"The error message detailing why transcription failed.","title":"string","type":"string","x-stream-index":"004"},"type":{"default":"call.transcription_failed","description":"The type of event: \"call.transcription_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","egress_id"],"title":"CallTranscriptionFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallTranscriptionReadyEvent":{"description":"This event is sent when call transcription is ready","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"call_transcription":{"$ref":"#/components/schemas/CallTranscription","description":"The call transcription object","title":"CallTranscription","x-stream-index":"003"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.transcription_ready","description":"The type of event: \"call.transcription_ready\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call_transcription","egress_id"],"title":"CallTranscriptionReadyEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallTranscriptionStartedEvent":{"description":"This event is sent when call transcription has started","properties":{"call_cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"002.002"},"egress_id":{"type":"string","x-stream-index":"001"},"type":{"default":"call.transcription_started","description":"The type of event: \"call.transcription_started\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001"}},"required":["egress_id","type","created_at","call_cid"],"title":"CallTranscriptionStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallTranscriptionStoppedEvent":{"description":"This event is sent when call transcription has stopped","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"003"},"type":{"default":"call.transcription_stopped","description":"The type of event: \"call.transcription_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","egress_id"],"title":"CallTranscriptionStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallUpdatedEvent":{"description":"This event is sent when a call is updated, clients should use this update the local state of the call.\nThis event also contains the capabilities by role for the call, clients should update the own_capability for the current.","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"capabilities_by_role":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"The capabilities by role for this call","title":"CapabilitiesByRole","type":"object","x-stream-index":"004"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"call.updated","description":"The type of event: \"call.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","capabilities_by_role"],"title":"CallUpdatedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallUserFeedbackSubmittedEvent":{"description":"This event is sent when a user submits feedback for a call.","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"custom":{"additionalProperties":{},"description":"Custom data provided by the user","title":"Custom","type":"object","x-stream-index":"007"},"rating":{"description":"The rating given by the user (1-5)","format":"int32","title":"Rating","type":"integer","x-stream-index":"005"},"reason":{"description":"The reason provided by the user for the rating","title":"Reason","type":"string","x-stream-index":"006"},"sdk":{"type":"string","x-stream-index":"008"},"sdk_version":{"type":"string","x-stream-index":"009"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.user_feedback_submitted","description":"The type of event, \"call.user_feedback\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who submitted the feedback","title":"User","x-stream-index":"004"}},"required":["type","created_at","call_cid","session_id","user","rating"],"title":"CallUserFeedbackSubmittedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallUserMutedEvent":{"description":"This event is sent when a call member is muted","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"from_user_id":{"type":"string","x-stream-index":"003"},"muted_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"type":{"default":"call.user_muted","description":"The type of event: \"call.user_muted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","from_user_id","muted_user_ids"],"title":"CallUserMutedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallsPerDayReport":{"properties":{"count":{"format":"int64","type":"integer","x-stream-index":"001"}},"required":["count"],"type":"object"},"CallsPerDayReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateCallsPerDayReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"ChatActivityStatsResponse":{"properties":{"Messages":{"$ref":"#/components/schemas/MessageStatsResponse","x-stream-index":"001"}},"type":"object"},"ClosedCaptionEvent":{"description":"This event is sent when closed captions are being sent in a call, clients should use this to show the closed captions in the call screen","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"closed_caption":{"$ref":"#/components/schemas/CallClosedCaption","description":"The closed caption object","title":"CallClosedCaption","x-stream-index":"003"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"call.closed_caption","description":"The type of event: \"call.closed_caption\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","closed_caption"],"title":"ClosedCaptionEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CollectUserFeedbackRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"009"},"rating":{"format":"int32","maximum":5,"minimum":1,"type":"integer","x-stream-index":"007"},"reason":{"maxLength":1000,"type":"string","x-stream-index":"008"},"sdk":{"maxLength":50,"type":"string","x-stream-index":"005"},"sdk_version":{"maxLength":50,"type":"string","x-stream-index":"006"},"user_session_id":{"maxLength":50,"type":"string","x-stream-index":"004"}},"required":["sdk","sdk_version","rating"],"type":"object"},"CollectUserFeedbackResponse":{"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"},"ConnectUserDetailsRequest":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001"},"image":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"006"},"language":{"type":"string","x-stream-index":"005"},"name":{"type":"string","x-stream-index":"002"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"007"}},"required":["id"],"type":"object"},"ConnectedEvent":{"description":"This event is sent when the WS connection is established and authenticated, this event contains the full user object as it is stored on the server","properties":{"connection_id":{"description":"The connection_id for this client","title":"Connection ID","type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"me":{"$ref":"#/components/schemas/OwnUserResponse","description":"The full user object as it is stored on the server","title":"OwnUserResponse","x-stream-index":"003"},"type":{"default":"connection.ok","description":"The type of event: \"connection.ok\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","connection_id","me"],"title":"ConnectedEvent","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"},"ConnectionErrorEvent":{"description":"This event is sent when the WS connection fails","properties":{"connection_id":{"type":"string","x-stream-index":"002"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"error":{"$ref":"#/components/schemas/APIError","description":"The error that caused the connection to fail","title":"Error","x-stream-index":"003"},"type":{"default":"connection.error","description":"The type of event: \"connection.ok\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","connection_id","error"],"title":"ConnectionErrorEvent","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"},"CountByMinuteResponse":{"nullable":true,"properties":{"count":{"format":"int32","type":"integer","x-stream-index":"002"},"start_ts":{"format":"date-time","type":"string","x-stream-index":"001"}},"required":["start_ts","count"],"type":"object"},"CreateDeviceRequest":{"description":"Create device request","nullable":true,"properties":{"id":{"description":"Device ID","maxLength":255,"minLength":1,"title":"ID","type":"string","x-stream-index":"001"},"push_provider":{"description":"Push provider","enum":["firebase","apn","huawei","xiaomi"],"title":"PushProvider","type":"string","x-stream-index":"002"},"push_provider_name":{"description":"Push provider name","title":"PushProviderName","type":"string","x-stream-index":"003"},"voip_token":{"description":"When true the token is for Apple VoIP push notifications","title":"VoipToken","type":"boolean","x-stream-index":"004"}},"required":["id","push_provider"],"title":"CreateDeviceRequest","type":"object"},"CreateGuestRequest":{"nullable":true,"properties":{"user":{"$ref":"#/components/schemas/UserRequest","description":"User object which server acts upon","title":"User","x-stream-index":"001"}},"required":["user"],"type":"object"},"CreateGuestResponse":{"nullable":true,"properties":{"access_token":{"description":"the access token to authenticate the user","title":"Access token","type":"string","x-stream-index":"002"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User object which server acts upon","title":"User","x-stream-index":"001"}},"required":["user","access_token","duration"],"type":"object"},"Credentials":{"properties":{"ice_servers":{"items":{"$ref":"#/components/schemas/ICEServer"},"type":"array","x-stream-index":"003"},"server":{"$ref":"#/components/schemas/SFUResponse","x-stream-index":"001"},"token":{"type":"string","x-stream-index":"002"}},"required":["server","token","ice_servers"],"type":"object"},"CustomVideoEvent":{"description":"A custom event, this event is used to send custom events to other participants in the call.","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"003"},"type":{"default":"custom","description":"The type of event, \"custom\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"004"}},"required":["type","created_at","call_cid","custom","user"],"title":"CustomVideoEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"DailyAggregateCallDurationReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/CallDurationReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateCallParticipantCountReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/CallParticipantCountReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateCallsPerDayReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/CallsPerDayReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateQualityScoreReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/QualityScoreReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateSDKUsageReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/SDKUsageReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateUserFeedbackReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/UserFeedbackReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DeleteCallRequest":{"description":"DeleteCallRequest is the payload for deleting a call.","nullable":true,"properties":{"hard":{"description":"if true the call will be hard deleted along with all related data","title":"Hard","type":"boolean","x-stream-index":"001"}},"title":"DeleteCallRequest","type":"object"},"DeleteCallResponse":{"description":"DeleteCallResponse is the payload for deleting a call.","nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","title":"Call","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"task_id":{"title":"TaskID","type":"string","x-stream-index":"002"}},"required":["call","duration"],"title":"DeleteCallResponse","type":"object"},"DeleteRecordingResponse":{"description":"Response for DeleteRecording","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"DeleteRecordingResponse","type":"object"},"DeleteTranscriptionResponse":{"description":"DeleteTranscriptionResponse is the payload for deleting a transcription.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"DeleteTranscriptionResponse","type":"object"},"DeviceResponse":{"description":"Response for Device","properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"004"},"disabled":{"description":"Whether device is disabled or not","title":"Disabled","type":"boolean","x-stream-index":"005"},"disabled_reason":{"description":"Reason explaining why device had been disabled","title":"Reason","type":"string","x-stream-index":"006"},"id":{"description":"Device ID","title":"ID","type":"string","x-stream-index":"003"},"push_provider":{"description":"Push provider","title":"PushProvider","type":"string","x-stream-index":"001"},"push_provider_name":{"description":"Push provider name","title":"PushProviderName","type":"string","x-stream-index":"002"},"user_id":{"description":"User ID","title":"UserID","type":"string","x-stream-index":"008"},"voip":{"description":"When true the token is for Apple VoIP push notifications","title":"Voip","type":"boolean","x-stream-index":"007"}},"required":["push_provider","id","created_at","user_id"],"title":"DeviceResponse","type":"object"},"EdgeResponse":{"properties":{"continent_code":{"type":"string","x-stream-index":"007.003"},"country_iso_code":{"type":"string","x-stream-index":"007.002"},"green":{"format":"int32","type":"integer","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"latency_test_url":{"type":"string","x-stream-index":"002"},"latitude":{"format":"float","type":"number","x-stream-index":"006.001"},"longitude":{"format":"float","type":"number","x-stream-index":"006.002"},"red":{"format":"int32","type":"integer","x-stream-index":"005"},"subdivision_iso_code":{"type":"string","x-stream-index":"007.001"},"yellow":{"format":"int32","type":"integer","x-stream-index":"004"}},"required":["id","latency_test_url","green","yellow","red","latitude","longitude","subdivision_iso_code","country_iso_code","continent_code"],"type":"object"},"EgressHLSResponse":{"properties":{"playlist_url":{"type":"string","x-stream-index":"001"},"status":{"type":"string","x-stream-index":"002"}},"required":["playlist_url","status"],"type":"object"},"EgressRTMPResponse":{"properties":{"name":{"type":"string","x-stream-index":"001"},"started_at":{"format":"date-time","type":"string","x-stream-index":"004"},"stream_key":{"type":"string","x-stream-index":"003"},"stream_url":{"type":"string","x-stream-index":"002"}},"required":["name","started_at"],"type":"object"},"EgressResponse":{"properties":{"broadcasting":{"type":"boolean","x-stream-index":"001"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordingResponse","x-stream-index":"004"},"hls":{"$ref":"#/components/schemas/EgressHLSResponse","x-stream-index":"002"},"rtmps":{"items":{"$ref":"#/components/schemas/EgressRTMPResponse"},"type":"array","x-stream-index":"003"}},"required":["broadcasting","rtmps"],"type":"object"},"EndCallRequest":{"description":"Request for ending a call","nullable":true,"title":"EndCallRequest","type":"object"},"EndCallResponse":{"description":"Response for ending a call","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"EndCallResponse","type":"object"},"FeedsEventPreferences":{"properties":{"comments":{"type":"string","x-stream-index":"002"},"mentions":{"type":"string","x-stream-index":"004"},"new_followers":{"type":"string","x-stream-index":"003"},"reactions":{"type":"string","x-stream-index":"001"}},"type":"object"},"FileUploadConfig":{"properties":{"allowed_file_extensions":{"items":{"type":"string"},"type":"array","x-stream-index":"001"},"allowed_mime_types":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"blocked_file_extensions":{"items":{"type":"string"},"type":"array","x-stream-index":"002"},"blocked_mime_types":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"size_limit":{"format":"int32","maximum":104857600,"minimum":0,"type":"integer","x-stream-index":"005"}},"required":["allowed_file_extensions","blocked_file_extensions","allowed_mime_types","blocked_mime_types","size_limit"],"type":"object"},"FrameRecordingResponse":{"properties":{"status":{"type":"string","x-stream-index":"001"}},"required":["status"],"type":"object"},"FrameRecordingSettingsRequest":{"properties":{"capture_interval_in_seconds":{"format":"int32","maximum":60,"minimum":2,"type":"integer","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"},"quality":{"enum":["360p","480p","720p","1080p","1440p"],"type":"string","x-stream-index":"002"}},"required":["mode","capture_interval_in_seconds"],"type":"object"},"FrameRecordingSettingsResponse":{"properties":{"capture_interval_in_seconds":{"format":"int32","maximum":60,"minimum":2,"type":"integer","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"},"quality":{"type":"string","x-stream-index":"002"}},"required":["mode","capture_interval_in_seconds"],"type":"object"},"GeofenceSettingsRequest":{"properties":{"names":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"type":"object"},"GeofenceSettingsResponse":{"properties":{"names":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"required":["names"],"type":"object"},"GetCallReportResponse":{"description":"Basic response information","nullable":true,"properties":{"chat_activity":{"$ref":"#/components/schemas/ChatActivityStatsResponse","x-stream-index":"004"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"report":{"$ref":"#/components/schemas/ReportResponse","x-stream-index":"003"},"session_id":{"type":"string","x-stream-index":"002"},"video_reactions":{"items":{"$ref":"#/components/schemas/VideoReactionsResponse"},"type":"array","x-stream-index":"005"}},"required":["duration","session_id","report"],"title":"Response","type":"object"},"GetCallResponse":{"nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001.001"},"duration":{"type":"string","x-stream-index":"002.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001.002"},"membership":{"$ref":"#/components/schemas/MemberResponse","x-stream-index":"001.003"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"001.004"}},"required":["call","members","own_capabilities","blocked_users","duration"],"title":"GetCallResponse","type":"object"},"GetEdgesResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"edges":{"items":{"$ref":"#/components/schemas/EdgeResponse"},"type":"array","x-stream-index":"001"}},"required":["edges","duration"],"title":"Response","type":"object"},"GetOrCreateCallRequest":{"nullable":true,"properties":{"data":{"$ref":"#/components/schemas/CallRequest","title":"ReadOnlyData","x-stream-index":"003"},"members_limit":{"format":"int32","maximum":100,"type":"integer","x-stream-index":"007"},"notify":{"description":"if provided it sends a notification event to the members for this call","title":"Notify","type":"boolean","x-stream-index":"005"},"ring":{"description":"if provided it sends a ring event to the members for this call","title":"Ring","type":"boolean","x-stream-index":"004"},"video":{"type":"boolean","x-stream-index":"006"}},"title":"GetOrCreateCallRequest","type":"object"},"GetOrCreateCallResponse":{"nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001.001"},"created":{"type":"boolean","x-stream-index":"002"},"duration":{"type":"string","x-stream-index":"003.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001.002"},"membership":{"$ref":"#/components/schemas/MemberResponse","x-stream-index":"001.003"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"001.004"}},"required":["call","members","own_capabilities","blocked_users","created","duration"],"title":"GetOrCreateCallResponse","type":"object"},"GoLiveRequest":{"nullable":true,"properties":{"recording_storage_name":{"type":"string","x-stream-index":"005"},"start_closed_caption":{"type":"boolean","x-stream-index":"008"},"start_hls":{"type":"boolean","x-stream-index":"003"},"start_recording":{"type":"boolean","x-stream-index":"004"},"start_transcription":{"type":"boolean","x-stream-index":"007"},"transcription_storage_name":{"type":"string","x-stream-index":"006"}},"title":"GoLiveRequest","type":"object"},"GoLiveResponse":{"description":"Basic response information","nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["call","duration"],"title":"Response","type":"object"},"GroupedStatsResponse":{"nullable":true,"properties":{"name":{"type":"string","x-stream-index":"001"},"unique":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["name","unique"],"type":"object"},"HLSSettingsRequest":{"properties":{"auto_on":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"quality_tracks":{"items":{"type":"string"},"maximum":3,"minimum":1,"type":"array","x-stream-index":"003"}},"required":["quality_tracks"],"title":"HLSSettingsRequest","type":"object"},"HLSSettingsResponse":{"description":"HLSSettings is the payload for HLS settings","properties":{"auto_on":{"title":"Auto On","type":"boolean","x-stream-index":"001"},"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"002"},"quality_tracks":{"items":{"type":"string"},"title":"Quality Tracks","type":"array","x-stream-index":"003"}},"required":["auto_on","enabled","quality_tracks","layout"],"title":"HLSSettingsResponse","type":"object"},"HealthCheckEvent":{"nullable":true,"properties":{"cid":{"type":"string","x-stream-index":"003"},"connection_id":{"type":"string","x-stream-index":"001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"004.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004.007"},"received_at":{"format":"date-time","type":"string","x-stream-index":"004.004"},"type":{"default":"health.check","type":"string","x-stream-index":"004.002"}},"required":["connection_id","type","created_at","custom"],"title":"HealthCheckEvent","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"},"ICEServer":{"properties":{"password":{"type":"string","x-stream-index":"003"},"urls":{"items":{"type":"string"},"type":"array","x-stream-index":"001"},"username":{"type":"string","x-stream-index":"002"}},"required":["urls","username","password"],"type":"object"},"IngressAudioEncodingOptionsRequest":{"properties":{"bitrate":{"maximum":128000,"minimum":16000,"type":"integer","x-stream-index":"003"},"channels":{"enum":["1","2"],"format":"int32","type":"integer","x-stream-index":"001"},"enable_dtx":{"type":"boolean","x-stream-index":"002"}},"required":["channels","bitrate"],"type":"object"},"IngressAudioEncodingResponse":{"properties":{"bitrate":{"format":"int32","type":"integer","x-stream-index":"003"},"channels":{"format":"int32","type":"integer","x-stream-index":"001"},"enable_dtx":{"type":"boolean","x-stream-index":"002"}},"required":["channels","enable_dtx","bitrate"],"type":"object"},"IngressSettingsRequest":{"properties":{"audio_encoding_options":{"$ref":"#/components/schemas/IngressAudioEncodingOptionsRequest","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"video_encoding_options":{"additionalProperties":{"$ref":"#/components/schemas/IngressVideoEncodingOptionsRequest"},"type":"object","x-stream-index":"003"}},"type":"object"},"IngressSettingsResponse":{"properties":{"audio_encoding_options":{"$ref":"#/components/schemas/IngressAudioEncodingResponse","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"video_encoding_options":{"additionalProperties":{"$ref":"#/components/schemas/IngressVideoEncodingResponse"},"type":"object","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"IngressVideoEncodingOptionsRequest":{"properties":{"layers":{"items":{"$ref":"#/components/schemas/IngressVideoLayerRequest"},"minimum":1,"type":"array","x-stream-index":"001"}},"required":["layers"],"type":"object"},"IngressVideoEncodingResponse":{"properties":{"layers":{"items":{"$ref":"#/components/schemas/IngressVideoLayerResponse"},"type":"array","x-stream-index":"001"}},"required":["layers"],"type":"object"},"IngressVideoLayerRequest":{"nullable":true,"properties":{"bitrate":{"format":"int32","minimum":1000,"type":"integer","x-stream-index":"002"},"codec":{"enum":["h264","vp8"],"type":"string","x-stream-index":"001"},"frame_rate_limit":{"maximum":60,"minimum":1,"type":"integer","x-stream-index":"005"},"max_dimension":{"minimum":240,"type":"integer","x-stream-index":"004"},"min_dimension":{"minimum":240,"type":"integer","x-stream-index":"003"}},"required":["codec","bitrate","min_dimension","max_dimension","frame_rate_limit"],"type":"object"},"IngressVideoLayerResponse":{"nullable":true,"properties":{"bitrate":{"type":"integer","x-stream-index":"002"},"codec":{"type":"string","x-stream-index":"001"},"frame_rate_limit":{"type":"integer","x-stream-index":"005"},"max_dimension":{"type":"integer","x-stream-index":"004"},"min_dimension":{"type":"integer","x-stream-index":"003"}},"required":["codec","bitrate","min_dimension","max_dimension","frame_rate_limit"],"type":"object"},"JoinCallRequest":{"nullable":true,"properties":{"create":{"description":"if true the call will be created if it doesn't exist","title":"Create","type":"boolean","x-stream-index":"002"},"data":{"$ref":"#/components/schemas/CallRequest","x-stream-index":"003"},"location":{"title":"Location","type":"string","x-stream-index":"009"},"members_limit":{"format":"int32","maximum":100,"title":"The amount of members that should be returned","type":"integer","x-stream-index":"007"},"migrating_from":{"description":"If the participant is migrating from another SFU, then this is the ID of the previous SFU","title":"MigratingFrom","type":"string","x-stream-index":"010"},"notify":{"type":"boolean","x-stream-index":"005"},"ring":{"description":"if true and the call is created, the notification will include ring=true","title":"Ring","type":"boolean","x-stream-index":"004"},"video":{"type":"boolean","x-stream-index":"006"}},"required":["location"],"title":"JoinCallRequest","type":"object"},"JoinCallResponse":{"nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001.001"},"created":{"title":"Created","type":"boolean","x-stream-index":"002"},"credentials":{"$ref":"#/components/schemas/Credentials","title":"Credentials","x-stream-index":"003"},"duration":{"type":"string","x-stream-index":"005.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001.002"},"membership":{"$ref":"#/components/schemas/MemberResponse","x-stream-index":"001.003"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"001.004"},"stats_options":{"$ref":"#/components/schemas/StatsOptions","x-stream-index":"004"}},"required":["call","members","own_capabilities","blocked_users","created","credentials","stats_options","duration"],"title":"JoinCallResponse","type":"object"},"KickUserRequest":{"description":"KickUserRequest is the payload for kicking a user from a call. Optionally block the user as well.","nullable":true,"properties":{"block":{"description":"If true, also block the user from rejoining the call","title":"Block","type":"boolean","x-stream-index":"004"},"user_id":{"description":"The user to kick","title":"UserID","type":"string","x-stream-index":"003"}},"required":["user_id"],"title":"KickUserRequest","type":"object"},"KickUserResponse":{"description":"KickUserResponse is the payload for kicking a user from a call.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"KickUserResponse","type":"object"},"KickedUserEvent":{"description":"This event is sent to call participants to notify when a user is kicked from a call. Clients should make the kicked user leave the call UI.","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"kicked_by_user":{"$ref":"#/components/schemas/UserResponse","description":"The user that kicked the participant, null if server-side","title":"Kicked by","x-stream-index":"004"},"type":{"default":"call.kicked_user","description":"The type of event: \"call.kicked_user\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user that was kicked","title":"User","x-stream-index":"003"}},"required":["type","created_at","call_cid","user"],"title":"KickedUserEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"LayoutSettingsRequest":{"properties":{"detect_orientation":{"type":"boolean","x-stream-index":"005"},"external_app_url":{"type":"string","x-stream-index":"003"},"external_css_url":{"type":"string","x-stream-index":"004"},"name":{"enum":["spotlight","grid","single-participant","mobile","custom"],"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"required":["name"],"type":"object"},"LimitsSettingsRequest":{"properties":{"max_duration_seconds":{"format":"int32","minimum":0,"type":"integer","x-stream-index":"004"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"},"max_participants_exclude_owner":{"type":"boolean","x-stream-index":"003"},"max_participants_exclude_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"002"}},"type":"object"},"LimitsSettingsResponse":{"properties":{"max_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"004"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"},"max_participants_exclude_owner":{"type":"boolean","x-stream-index":"003"},"max_participants_exclude_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"002"}},"required":["max_participants_exclude_roles"],"type":"object"},"ListDevicesResponse":{"description":"List devices response","nullable":true,"properties":{"devices":{"description":"List of devices","items":{"$ref":"#/components/schemas/DeviceResponse"},"title":"Devices","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["devices","duration"],"title":"ListDevicesResponse","type":"object"},"ListRecordingsResponse":{"description":"Response for listing recordings","nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"},"recordings":{"items":{"$ref":"#/components/schemas/CallRecording"},"title":"The list of recordings.","type":"array","x-stream-index":"002"}},"required":["duration","recordings"],"title":"ListRecordingsResponse","type":"object"},"ListTranscriptionsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"},"transcriptions":{"description":"List of transcriptions for the call","items":{"$ref":"#/components/schemas/CallTranscription"},"title":"Transcriptions","type":"array","x-stream-index":"002"}},"required":["duration","transcriptions"],"title":"ListTranscriptionsResponse","type":"object"},"MemberRequest":{"description":"MemberRequest is the payload for adding a member to a call.","properties":{"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"003"},"role":{"title":"Role","type":"string","x-stream-index":"002"},"user_id":{"minLength":1,"title":"User ID","type":"string","x-stream-index":"001"}},"required":["user_id"],"title":"MemberRequest","type":"object"},"MemberResponse":{"description":"MemberResponse is the payload for a member of a call.","properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"005"},"custom":{"additionalProperties":{},"description":"Custom member response data","title":"Custom","type":"object","x-stream-index":"004"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"string","x-stream-index":"007"},"role":{"title":"Role","type":"string","x-stream-index":"003"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"006"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"},"user_id":{"type":"string","x-stream-index":"002"}},"required":["user","user_id","custom","created_at","updated_at"],"title":"MemberResponse","type":"object"},"MessageStatsResponse":{"properties":{"count_over_time":{"items":{"$ref":"#/components/schemas/CountByMinuteResponse"},"type":"array","x-stream-index":"001"}},"type":"object"},"MuteUsersRequest":{"nullable":true,"properties":{"audio":{"title":"Audio","type":"boolean","x-stream-index":"005"},"mute_all_users":{"type":"boolean","x-stream-index":"003"},"screenshare":{"title":"Screenshare","type":"boolean","x-stream-index":"007"},"screenshare_audio":{"title":"ScreenshareAudio","type":"boolean","x-stream-index":"008"},"user_ids":{"items":{"type":"string"},"title":"UserIDs","type":"array","x-stream-index":"004"},"video":{"title":"Video","type":"boolean","x-stream-index":"006"}},"title":"MuteUsersRequest","type":"object"},"MuteUsersResponse":{"description":"MuteUsersResponse is the response payload for the mute users endpoint.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"MuteUsersResponse","type":"object"},"NetworkMetricsReportResponse":{"properties":{"average_connection_time":{"format":"float","type":"number","x-stream-index":"003"},"average_jitter":{"format":"float","type":"number","x-stream-index":"002"},"average_latency":{"format":"float","type":"number","x-stream-index":"001"},"average_time_to_reconnect":{"format":"float","type":"number","x-stream-index":"004"}},"type":"object"},"NoiseCancellationSettings":{"properties":{"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode"],"type":"object"},"OwnCapability":{"description":"All possibility of string to use","enum":["block-users","change-max-duration","create-call","create-reaction","enable-noise-cancellation","end-call","join-backstage","join-call","join-ended-call","kick-user","mute-users","pin-for-everyone","read-call","remove-call-member","screenshare","send-audio","send-video","start-broadcast-call","start-closed-captions-call","start-frame-record-call","start-record-call","start-transcription-call","stop-broadcast-call","stop-closed-captions-call","stop-frame-record-call","stop-record-call","stop-transcription-call","update-call","update-call-member","update-call-permissions","update-call-settings"],"title":"OwnCapability","type":"string"},"OwnUserResponse":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"015"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"string","x-stream-index":"001.016"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"001.011"},"devices":{"items":{"$ref":"#/components/schemas/DeviceResponse"},"title":"Devices","type":"array","x-stream-index":"004"},"id":{"type":"string","x-stream-index":"001.001"},"image":{"type":"string","x-stream-index":"001.003"},"language":{"type":"string","x-stream-index":"001.005"},"last_active":{"format":"date-time","type":"string","x-stream-index":"001.014"},"name":{"type":"string","x-stream-index":"001.002"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"003"},"push_preferences":{"$ref":"#/components/schemas/PushPreferences","x-stream-index":"002"},"revoke_tokens_issued_before":{"format":"date-time","type":"string","x-stream-index":"001.015"},"role":{"type":"string","x-stream-index":"001.006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","devices","invisible","mutes","channel_mutes","unread_count","total_unread_count","unread_channels","unread_threads"],"type":"object"},"ParticipantCountByMinuteResponse":{"nullable":true,"properties":{"first":{"format":"int32","type":"integer","x-stream-index":"002"},"last":{"format":"int32","type":"integer","x-stream-index":"003"},"max":{"format":"int32","type":"integer","x-stream-index":"004"},"min":{"format":"int32","type":"integer","x-stream-index":"005"},"start_ts":{"format":"date-time","type":"string","x-stream-index":"001"}},"required":["start_ts","first","last","max","min"],"type":"object"},"ParticipantCountOverTimeResponse":{"properties":{"by_minute":{"items":{"$ref":"#/components/schemas/ParticipantCountByMinuteResponse"},"type":"array","x-stream-index":"001"}},"type":"object"},"ParticipantReportResponse":{"properties":{"by_browser":{"items":{"$ref":"#/components/schemas/GroupedStatsResponse"},"type":"array","x-stream-index":"008"},"by_country":{"items":{"$ref":"#/components/schemas/GroupedStatsResponse"},"type":"array","x-stream-index":"005"},"by_device":{"items":{"$ref":"#/components/schemas/GroupedStatsResponse"},"type":"array","x-stream-index":"006"},"by_operating_system":{"items":{"$ref":"#/components/schemas/GroupedStatsResponse"},"type":"array","x-stream-index":"007"},"count_over_time":{"$ref":"#/components/schemas/ParticipantCountOverTimeResponse","x-stream-index":"004"},"max_concurrent":{"format":"int32","type":"integer","x-stream-index":"003"},"publishers":{"$ref":"#/components/schemas/PublisherStatsResponse","x-stream-index":"009"},"subscribers":{"$ref":"#/components/schemas/SubscriberStatsResponse","x-stream-index":"010"},"sum":{"format":"int32","type":"integer","x-stream-index":"001"},"unique":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["sum","unique"],"type":"object"},"PerSDKUsageReport":{"nullable":true,"properties":{"by_version":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"002"},"total":{"format":"int32","type":"integer","x-stream-index":"001"}},"required":["total","by_version"],"type":"object"},"PermissionRequestEvent":{"description":"This event is sent when a user requests access to a feature on a call,\nclients receiving this event should display a permission request to the user","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"permissions":{"description":"The list of permissions requested by the user","items":{"type":"string"},"title":"Permissions","type":"array","x-stream-index":"004"},"type":{"default":"call.permission_request","description":"The type of event: \"call.permission_request\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who sent the permission request","title":"User","x-stream-index":"003"}},"required":["type","created_at","call_cid","user","permissions"],"title":"PermissionRequestEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"PinRequest":{"description":"PinRequest is the payload for pinning a message.","nullable":true,"properties":{"session_id":{"description":"the session ID of the user who pinned the message","title":"SessionID","type":"string","x-stream-index":"003"},"user_id":{"description":"the user ID of the user who pinned the message","title":"UserID","type":"string","x-stream-index":"002"}},"required":["user_id","session_id"],"title":"PinRequest","type":"object"},"PinResponse":{"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"},"PrivacySettings":{"properties":{"read_receipts":{"$ref":"#/components/schemas/ReadReceipts","x-stream-index":"002"},"typing_indicators":{"$ref":"#/components/schemas/TypingIndicators","x-stream-index":"001"}},"type":"object"},"PrivacySettingsResponse":{"type":"object"},"PublisherStatsResponse":{"properties":{"by_track":{"items":{"$ref":"#/components/schemas/TrackStatsResponse"},"type":"array","x-stream-index":"003"},"total":{"format":"int32","type":"integer","x-stream-index":"001"},"unique":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["total","unique"],"type":"object"},"PushPreferences":{"properties":{"call_level":{"type":"string","x-stream-index":"002"},"chat_level":{"type":"string","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"string","x-stream-index":"005"},"feeds_events":{"$ref":"#/components/schemas/FeedsEventPreferences","x-stream-index":"004"},"feeds_level":{"type":"string","x-stream-index":"003"}},"type":"object"},"QualityScoreReport":{"properties":{"histogram":{"items":{"$ref":"#/components/schemas/ReportByHistogramBucket"},"type":"array","x-stream-index":"001"}},"required":["histogram"],"type":"object"},"QualityScoreReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateQualityScoreReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"QueryAggregateCallStatsRequest":{"nullable":true,"properties":{"from":{"type":"string","x-stream-index":"002"},"report_types":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"to":{"type":"string","x-stream-index":"003"}},"type":"object"},"QueryAggregateCallStatsResponse":{"description":"Basic response information","nullable":true,"properties":{"call_duration_report":{"$ref":"#/components/schemas/CallDurationReportResponse","x-stream-index":"002"},"call_participant_count_report":{"$ref":"#/components/schemas/CallParticipantCountReportResponse","x-stream-index":"004"},"calls_per_day_report":{"$ref":"#/components/schemas/CallsPerDayReportResponse","x-stream-index":"003"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"network_metrics_report":{"$ref":"#/components/schemas/NetworkMetricsReportResponse","x-stream-index":"008"},"quality_score_report":{"$ref":"#/components/schemas/QualityScoreReportResponse","x-stream-index":"005"},"sdk_usage_report":{"$ref":"#/components/schemas/SDKUsageReportResponse","x-stream-index":"006"},"user_feedback_report":{"$ref":"#/components/schemas/UserFeedbackReportResponse","x-stream-index":"007"}},"required":["duration"],"title":"Response","type":"object"},"QueryCallMembersRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"002"},"id":{"maxLength":64,"type":"string","x-stream-index":"001.002"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"004.001"},"next":{"type":"string","x-stream-index":"004.002"},"prev":{"type":"string","x-stream-index":"004.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":1,"type":"array","x-stream-index":"003"},"type":{"maxLength":64,"type":"string","x-stream-index":"001.001"}},"required":["type","id"],"type":"object"},"QueryCallMembersResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["members","duration"],"title":"Response","type":"object"},"QueryCallParticipantsRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"003"}},"type":"object"},"QueryCallParticipantsResponse":{"nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001.001"},"duration":{"type":"string","x-stream-index":"004.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001.002"},"membership":{"$ref":"#/components/schemas/MemberResponse","x-stream-index":"001.003"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"001.004"},"participants":{"description":"List of call participants","items":{"$ref":"#/components/schemas/CallParticipantResponse"},"title":"[]CallParticipantResponse","type":"array","x-stream-index":"002"},"total_participants":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["call","members","own_capabilities","blocked_users","participants","total_participants","duration"],"type":"object"},"QueryCallStatsRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"004.001"},"next":{"type":"string","x-stream-index":"004.002"},"prev":{"type":"string","x-stream-index":"004.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":2,"type":"array","x-stream-index":"002"}},"type":"object"},"QueryCallStatsResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"next":{"type":"string","x-stream-index":"003.001"},"prev":{"type":"string","x-stream-index":"003.002"},"reports":{"items":{"$ref":"#/components/schemas/CallStatsReportSummaryResponse"},"type":"array","x-stream-index":"001"}},"required":["reports","duration"],"title":"Response","type":"object"},"QueryCallsRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"title":"Filters","type":"object","x-stream-index":"003"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"006.001"},"next":{"type":"string","x-stream-index":"006.002"},"prev":{"type":"string","x-stream-index":"006.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":2,"title":"Sort","type":"array","x-stream-index":"004"},"watch":{"title":"Watch","type":"boolean","x-stream-index":"001"}},"title":"QueryCallsRequest","type":"object"},"QueryCallsResponse":{"nullable":true,"properties":{"calls":{"items":{"$ref":"#/components/schemas/CallStateResponseFields"},"title":"Calls","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["calls","duration"],"title":"QueryCallsResponse","type":"object"},"RTMPBroadcastRequest":{"description":"RTMPBroadcastRequest is the payload for starting an RTMP broadcast.","properties":{"layout":{"$ref":"#/components/schemas/LayoutSettingsRequest","description":"If provided, will override the call's RTMP settings layout","title":"Layout","x-stream-index":"005"},"name":{"description":"Name identifier for RTMP broadcast, must be unique in call","maxLength":255,"title":"Name","type":"string","x-stream-index":"001"},"quality":{"description":"If provided, will override the call's RTMP settings quality","enum":["360p","480p","720p","1080p","1440p","portrait-360x640","portrait-480x854","portrait-720x1280","portrait-1080x1920","portrait-1440x2560"],"title":"Quality","type":"string","x-stream-index":"004"},"stream_key":{"description":"If provided, will be appended at the end of stream_url","title":"Stream Key","type":"string","x-stream-index":"003"},"stream_url":{"description":"URL for the RTMP server to send the call to","maxLength":255,"title":"Stream URL","type":"string","x-stream-index":"002"}},"required":["name","stream_url"],"title":"RTMPBroadcastRequest","type":"object"},"RTMPIngress":{"description":"RTMP input settings","properties":{"address":{"title":"Address","type":"string","x-stream-index":"001"}},"required":["address"],"title":"RTMPIngress","type":"object"},"RTMPSettingsRequest":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"quality":{"description":"Resolution to set for the RTMP stream","enum":["360p","480p","720p","1080p","1440p","portrait-360x640","portrait-480x854","portrait-720x1280","portrait-1080x1920","portrait-1440x2560"],"title":"Quality","type":"string","x-stream-index":"002"}},"title":"RTMPSettingsRequest","type":"object"},"RTMPSettingsResponse":{"description":"RTMPSettingsResponse is the payload for RTMP settings","properties":{"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"001"},"quality":{"title":"Quality","type":"string","x-stream-index":"002"}},"required":["enabled","quality","layout"],"title":"RTMPSettingsResponse","type":"object"},"ReactionResponse":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"emoji_code":{"type":"string","x-stream-index":"003"},"type":{"type":"string","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"}},"required":["user","type"],"type":"object"},"ReadReceipts":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"RecordSettingsRequest":{"properties":{"audio_only":{"type":"boolean","x-stream-index":"001"},"mode":{"enum":["available","disabled","auto-on"],"title":"Mode","type":"string","x-stream-index":"002"},"quality":{"enum":["360p","480p","720p","1080p","1440p","portrait-360x640","portrait-480x854","portrait-720x1280","portrait-1080x1920","portrait-1440x2560"],"type":"string","x-stream-index":"003"}},"required":["mode"],"title":"RecordSettingsRequest","type":"object"},"RecordSettingsResponse":{"description":"RecordSettings is the payload for recording settings","properties":{"audio_only":{"title":"Audio Only","type":"boolean","x-stream-index":"001"},"mode":{"title":"Mode","type":"string","x-stream-index":"002"},"quality":{"title":"Quality","type":"string","x-stream-index":"003"}},"required":["audio_only","mode","quality","layout"],"title":"RecordSettingsResponse","type":"object"},"RejectCallRequest":{"nullable":true,"properties":{"reason":{"description":"Reason for rejecting the call","title":"Reason","type":"string","x-stream-index":"003"}},"title":"RejectCallRequest","type":"object"},"RejectCallResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"RejectCallResponse","type":"object"},"ReportByHistogramBucket":{"properties":{"category":{"type":"string","x-stream-index":"001"},"count":{"format":"int32","type":"integer","x-stream-index":"005"},"lower_bound":{"$ref":"#/components/schemas/Bound","x-stream-index":"002"},"sum":{"format":"float","type":"number","x-stream-index":"004"},"upper_bound":{"$ref":"#/components/schemas/Bound","x-stream-index":"003"}},"required":["category","sum","count"],"type":"object"},"ReportResponse":{"properties":{"call":{"$ref":"#/components/schemas/CallReportResponse","x-stream-index":"003"},"participants":{"$ref":"#/components/schemas/ParticipantReportResponse","x-stream-index":"001"},"user_ratings":{"$ref":"#/components/schemas/UserRatingReportResponse","x-stream-index":"002"}},"required":["participants","user_ratings","call"],"type":"object"},"RequestPermissionRequest":{"nullable":true,"properties":{"permissions":{"items":{"type":"string"},"title":"Permissions","type":"array","x-stream-index":"003"}},"required":["permissions"],"title":"RequestPermissionRequest","type":"object"},"RequestPermissionResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"RequestPermissionResponse","type":"object"},"Response":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001"}},"required":["duration"],"title":"Response","type":"object"},"RingSettingsRequest":{"properties":{"auto_cancel_timeout_ms":{"description":"When none of the callees accept a ring call in this time a rejection will be sent by the caller with reason 'timeout' by the SDKs","format":"int32","maximum":180000,"minimum":5000,"title":"AutoCancelTimeoutMs","type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"description":"When a callee is online but doesn't answer a ring call in this time a rejection will be sent with reason 'timeout' by the SDKs","format":"int32","maximum":180000,"minimum":5000,"title":"IncomingCallTimeoutMs","type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"description":"When a callee doesn't accept or reject a ring call in this time a missed call event will be sent","format":"int32","maximum":180000,"minimum":5000,"title":"MissedCallTimeoutMs","type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_timeout_ms"],"title":"RingSettingsRequest","type":"object"},"RingSettingsResponse":{"properties":{"auto_cancel_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_timeout_ms","missed_call_timeout_ms"],"type":"object"},"SDKUsageReport":{"properties":{"per_sdk_usage":{"additionalProperties":{"$ref":"#/components/schemas/PerSDKUsageReport"},"type":"object","x-stream-index":"001"}},"required":["per_sdk_usage"],"type":"object"},"SDKUsageReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateSDKUsageReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"SFUResponse":{"properties":{"edge_name":{"type":"string","x-stream-index":"001"},"url":{"type":"string","x-stream-index":"002"},"ws_endpoint":{"type":"string","x-stream-index":"003"}},"required":["edge_name","url","ws_endpoint"],"type":"object"},"ScreensharingSettingsRequest":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"type":"object"},"ScreensharingSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled"],"type":"object"},"SendCallEventRequest":{"description":"Send a call event to the other user","nullable":true,"properties":{"custom":{"additionalProperties":{},"title":"Custom","type":"object","x-stream-index":"004"}},"title":"SendCallEventRequest","type":"object"},"SendCallEventResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"SendCallEventResponse","type":"object"},"SendReactionRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.003"},"emoji_code":{"type":"string","x-stream-index":"003.002"},"type":{"maxLength":64,"type":"string","x-stream-index":"003.001"}},"required":["type"],"type":"object"},"SendReactionResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"reaction":{"$ref":"#/components/schemas/ReactionResponse","x-stream-index":"001"}},"required":["reaction","duration"],"title":"Response","type":"object"},"SessionSettingsRequest":{"properties":{"inactivity_timeout_seconds":{"format":"int32","maximum":900,"minimum":5,"type":"integer","x-stream-index":"001"}},"required":["inactivity_timeout_seconds"],"type":"object"},"SessionSettingsResponse":{"properties":{"inactivity_timeout_seconds":{"format":"int32","maximum":900,"minimum":5,"type":"integer","x-stream-index":"001"}},"required":["inactivity_timeout_seconds"],"type":"object"},"SortParamRequest":{"nullable":true,"properties":{"direction":{"description":"Direction of sorting, 1 for Ascending, -1 for Descending, default is 1","format":"int32","title":"Direction","type":"integer","x-stream-index":"002"},"field":{"description":"Name of field to sort by","title":"Field","type":"string","x-stream-index":"001"}},"type":"object"},"StartClosedCaptionsRequest":{"nullable":true,"properties":{"enable_transcription":{"description":"Enable transcriptions along with closed captions","title":"Enable Transcription","type":"boolean","x-stream-index":"002"},"external_storage":{"description":"Which external storage to use for transcriptions (only applicable if enable_transcription is true)","title":"External Storage","type":"string","x-stream-index":"003"},"language":{"description":"The spoken language in the call, if not provided the language defined in the transcription settings will be used","enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"title":"Language","type":"string","x-stream-index":"004"}},"type":"object"},"StartClosedCaptionsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"StartFrameRecordingRequest":{"nullable":true,"properties":{"recording_external_storage":{"type":"string","x-stream-index":"002"}},"title":"StartFrameRecordingRequest","type":"object"},"StartFrameRecordingResponse":{"description":"StartFrameRecordingResponse is the response payload for the start frame recording endpoint.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StartFrameRecordingResponse","type":"object"},"StartHLSBroadcastingRequest":{"description":"StartHLSBroadcastingRequest is the payload for starting an HLS broadcasting.","nullable":true,"title":"StartHLSBroadcastingRequest","type":"object"},"StartHLSBroadcastingResponse":{"description":"StartHLSBroadcastingResponse is the payload for starting an HLS broadcasting.","nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"},"playlist_url":{"description":"the URL of the HLS playlist","title":"PlaylistURL","type":"string","x-stream-index":"002"}},"required":["duration","playlist_url"],"title":"StartHLSBroadcastingResponse","type":"object"},"StartRTMPBroadcastsRequest":{"description":"StartRTMPBroadcastsRequest is the payload for starting RTMP broadcasts.","nullable":true,"properties":{"broadcasts":{"description":"List of broadcasts to start","items":{"$ref":"#/components/schemas/RTMPBroadcastRequest"},"maximum":1,"minimum":1,"title":"Broadcasts","type":"array","x-stream-index":"002"}},"required":["broadcasts"],"title":"StartRTMPBroadcastsRequest","type":"object"},"StartRTMPBroadcastsResponse":{"description":"StartRTMPBroadcastsResponse is the payload for starting an RTMP broadcast.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StartRTMPBroadcastsResponse","type":"object"},"StartRecordingRequest":{"nullable":true,"properties":{"recording_external_storage":{"type":"string","x-stream-index":"002"}},"title":"StartRecordingRequest","type":"object"},"StartRecordingResponse":{"description":"StartRecordingResponse is the response payload for the start recording endpoint.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StartRecordingResponse","type":"object"},"StartTranscriptionRequest":{"nullable":true,"properties":{"enable_closed_captions":{"description":"Enable closed captions along with transcriptions","title":"Enable Closed Captions","type":"boolean","x-stream-index":"003"},"language":{"description":"The spoken language in the call, if not provided the language defined in the transcription settings will be used","enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"title":"Language","type":"string","x-stream-index":"004"},"transcription_external_storage":{"description":"Store transcriptions in this external storage","title":"External Storage","type":"string","x-stream-index":"002"}},"type":"object"},"StartTranscriptionResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StartTranscriptionResponse","type":"object"},"StatsOptions":{"properties":{"enable_rtc_stats":{"type":"boolean","x-stream-index":"002"},"reporting_interval_ms":{"format":"int32","type":"integer","x-stream-index":"001"}},"required":["reporting_interval_ms","enable_rtc_stats"],"type":"object"},"StopAllRTMPBroadcastsRequest":{"nullable":true,"title":"StopAllRTMPBroadcastsRequest","type":"object"},"StopAllRTMPBroadcastsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StopAllRTMPBroadcastsResponse","type":"object"},"StopClosedCaptionsRequest":{"nullable":true,"properties":{"stop_transcription":{"type":"boolean","x-stream-index":"003"}},"type":"object"},"StopClosedCaptionsResponse":{"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"},"StopFrameRecordingRequest":{"nullable":true,"type":"object"},"StopFrameRecordingResponse":{"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"},"StopHLSBroadcastingRequest":{"nullable":true,"type":"object"},"StopHLSBroadcastingResponse":{"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"},"StopLiveRequest":{"nullable":true,"properties":{"continue_closed_caption":{"type":"boolean","x-stream-index":"006"},"continue_hls":{"type":"boolean","x-stream-index":"003"},"continue_recording":{"type":"boolean","x-stream-index":"004"},"continue_rtmp_broadcasts":{"type":"boolean","x-stream-index":"007"},"continue_transcription":{"type":"boolean","x-stream-index":"005"}},"title":"StopLiveRequest","type":"object"},"StopLiveResponse":{"nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"The call that was stopped","title":"Call","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["call","duration"],"title":"StopLiveResponse","type":"object"},"StopRTMPBroadcastsRequest":{"description":"Request for stopping RTMP broadcasts","nullable":true,"title":"StopRTMPBroadcastsRequest","type":"object"},"StopRTMPBroadcastsResponse":{"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"},"StopRecordingRequest":{"nullable":true,"type":"object"},"StopRecordingResponse":{"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"},"StopTranscriptionRequest":{"nullable":true,"properties":{"stop_closed_captions":{"type":"boolean","x-stream-index":"003"}},"type":"object"},"StopTranscriptionResponse":{"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"},"SubscriberStatsResponse":{"properties":{"total":{"format":"int32","type":"integer","x-stream-index":"001"},"total_subscribed_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"003"},"unique":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["total","unique","total_subscribed_duration_seconds"],"type":"object"},"TargetResolution":{"properties":{"bitrate":{"format":"int32","maximum":6000000,"type":"integer","x-stream-index":"003"},"height":{"format":"int32","maximum":3840,"minimum":240,"type":"integer","x-stream-index":"002"},"width":{"format":"int32","maximum":3840,"minimum":240,"type":"integer","x-stream-index":"001"}},"required":["width","height"],"type":"object"},"ThumbnailResponse":{"properties":{"image_url":{"type":"string","x-stream-index":"001"}},"required":["image_url"],"type":"object"},"ThumbnailsSettingsRequest":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"ThumbnailsSettingsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"TrackStatsResponse":{"nullable":true,"properties":{"duration_seconds":{"format":"int32","type":"integer","x-stream-index":"002"},"track_type":{"type":"string","x-stream-index":"001"}},"required":["track_type","duration_seconds"],"type":"object"},"TranscriptionSettingsRequest":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"002"},"language":{"enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"type":"string","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode"],"type":"object"},"TranscriptionSettingsResponse":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"002"},"language":{"enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"type":"string","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode","closed_caption_mode","languages","language"],"type":"object"},"TypingIndicators":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"UnblockUserRequest":{"description":"UnblockUserRequest is the payload for unblocking a user.","nullable":true,"properties":{"user_id":{"description":"the user to unblock","title":"UserID","type":"string","x-stream-index":"003"}},"required":["user_id"],"title":"UnblockUserRequest","type":"object"},"UnblockUserResponse":{"description":"UnblockUserResponse is the payload for unblocking a user.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"UnblockUserResponse","type":"object"},"UnblockedUserEvent":{"description":"This event is sent when a user is unblocked on a call,\nthis can be useful to notify the user that they can now join the call again","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"call.unblocked_user","description":"The type of event: \"call.unblocked_user\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user that was unblocked","title":"User","x-stream-index":"003"}},"required":["type","created_at","call_cid","user"],"title":"UnblockedUserEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"UnpinRequest":{"description":"UnpinRequest is the payload for unpinning a message.","nullable":true,"properties":{"session_id":{"description":"the session ID of the user who pinned the message","title":"SessionID","type":"string","x-stream-index":"003"},"user_id":{"description":"the user ID of the user who pinned the message","title":"UserID","type":"string","x-stream-index":"002"}},"required":["user_id","session_id"],"title":"UnpinRequest","type":"object"},"UnpinResponse":{"description":"UnpinResponse is the payload for unpinning a message.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"UnpinResponse","type":"object"},"UpdateCallMembersRequest":{"description":"Update call members","nullable":true,"properties":{"remove_members":{"description":"List of userID to remove","items":{"type":"string"},"maximum":100,"title":"Remove Members","type":"array","x-stream-index":"003"},"update_members":{"description":"List of members to update or insert","items":{"$ref":"#/components/schemas/MemberRequest"},"maximum":100,"title":"Update Members","type":"array","x-stream-index":"004"}},"title":"UpdateCallMembersRequest","type":"object"},"UpdateCallMembersResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"002"}},"required":["duration","members"],"title":"Response","type":"object"},"UpdateCallRequest":{"description":"Request for updating a call","nullable":true,"properties":{"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"003"},"settings_override":{"$ref":"#/components/schemas/CallSettingsRequest","description":"the settings to change for this call","title":"Settings Override","x-stream-index":"004"},"starts_at":{"description":"the time the call is scheduled to start","format":"date-time","title":"Starts At","type":"string","x-stream-index":"005"}},"title":"UpdateCallRequest","type":"object"},"UpdateCallResponse":{"description":"Response for updating a call","nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001.001"},"duration":{"type":"string","x-stream-index":"002.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001.002"},"membership":{"$ref":"#/components/schemas/MemberResponse","x-stream-index":"001.003"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"001.004"}},"required":["call","members","own_capabilities","blocked_users","duration"],"title":"UpdateCallResponse","type":"object"},"UpdateUserPermissionsRequest":{"nullable":true,"properties":{"grant_permissions":{"items":{"type":"string"},"type":"array","x-stream-index":"002"},"revoke_permissions":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"user_id":{"type":"string","x-stream-index":"001"}},"required":["user_id"],"type":"object"},"UpdateUserPermissionsResponse":{"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"},"UpdatedCallPermissionsEvent":{"description":"This event is sent to notify about permission changes for a user, clients receiving this event should update their UI accordingly","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"own_capabilities":{"description":"The capabilities of the current user","items":{"$ref":"#/components/schemas/OwnCapability"},"title":"Own capabilities","type":"array","x-stream-index":"004"},"type":{"default":"call.permissions_updated","description":"The type of event: \"call.permissions_updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who received the new permissions","title":"User","x-stream-index":"003"}},"required":["type","created_at","call_cid","user","own_capabilities"],"title":"UpdatedCallPermissionsEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"User":{"properties":{"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"046"},"ban_expires":{"format":"date-time","type":"string","x-stream-index":"017"},"banned":{"type":"boolean","x-stream-index":"016"},"created_at":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"013"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"023"},"language":{"type":"string","x-stream-index":"035"},"last_active":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"026"},"revoke_tokens_issued_before":{"format":"date-time","type":"string","x-stream-index":"042"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"005"},"updated_at":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"009"}},"required":["id","role","teams_role","custom","banned","online"],"type":"object"},"UserBannedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"006.002"},"channel_type":{"type":"string","x-stream-index":"006.003"},"cid":{"type":"string","x-stream-index":"006.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"008.002"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"001"},"expiration":{"format":"date-time","type":"string","x-stream-index":"003"},"reason":{"type":"string","x-stream-index":"004"},"shadow":{"type":"boolean","x-stream-index":"002"},"team":{"type":"string","x-stream-index":"005.001"},"type":{"default":"user.banned","type":"string","x-stream-index":"008.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007.001"}},"required":["created_by","shadow","cid","channel_id","channel_type","type","created_at"],"title":"UserBannedEvent","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"},"UserDeactivatedEvent":{"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"003.002"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"001"},"type":{"default":"user.deactivated","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["created_by","type","created_at"],"title":"UserDeactivatedEvent","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"},"UserFeedbackReport":{"properties":{"count_by_rating":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001"},"unreported_count":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["count_by_rating","unreported_count"],"type":"object"},"UserFeedbackReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateUserFeedbackReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"UserMutedEvent":{"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"004.002"},"target_user":{"type":"string","x-stream-index":"001"},"target_users":{"items":{"type":"string"},"type":"array","x-stream-index":"002"},"type":{"default":"user.muted","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"UserMutedEvent","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"},"UserRatingReportResponse":{"properties":{"average":{"format":"float","type":"number","x-stream-index":"002"},"count":{"format":"int32","type":"integer","x-stream-index":"001"}},"required":["count","average"],"type":"object"},"UserReactivatedEvent":{"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"002.002"},"type":{"default":"user.reactivated","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"001"}},"required":["type","created_at"],"title":"UserReactivatedEvent","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"},"UserRequest":{"description":"User request object","properties":{"custom":{"additionalProperties":{},"description":"Custom user data","title":"Custom","type":"object","x-stream-index":"004"},"id":{"description":"User ID","title":"ID","type":"string","x-stream-index":"001"},"image":{"description":"User's profile image URL","title":"Image","type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"006"},"language":{"type":"string","x-stream-index":"005"},"name":{"description":"Optional name of user","title":"Name","type":"string","x-stream-index":"002"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"007"}},"required":["id"],"title":"UserRequest","type":"object"},"UserResponse":{"description":"User response object","properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.017"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"001.004"},"deactivated_at":{"description":"Date of deactivation","format":"date-time","title":"Deactivated at","type":"string","x-stream-index":"001.016"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"string","x-stream-index":"001.011"},"id":{"description":"Unique user identifier","title":"ID","type":"string","x-stream-index":"001.001"},"image":{"title":"Image","type":"string","x-stream-index":"001.003"},"language":{"description":"Preferred language of a user","title":"Language","type":"string","x-stream-index":"001.005"},"last_active":{"description":"Date of last activity","format":"date-time","title":"Last active","type":"string","x-stream-index":"001.014"},"name":{"description":"Optional name of user","title":"Name","type":"string","x-stream-index":"001.002"},"revoke_tokens_issued_before":{"description":"Revocation date for tokens","format":"date-time","title":"Revoke tokens issued before","type":"string","x-stream-index":"001.015"},"role":{"description":"Determines the set of user permissions","title":"Role","type":"string","x-stream-index":"001.006"},"teams":{"description":"List of teams user is a part of","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids","shadow_banned","invisible"],"title":"UserResponse","type":"object"},"UserResponsePrivacyFields":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.017"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"string","x-stream-index":"001.016"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"001.011"},"id":{"type":"string","x-stream-index":"001.001"},"image":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"003"},"language":{"type":"string","x-stream-index":"001.005"},"last_active":{"format":"date-time","type":"string","x-stream-index":"001.014"},"name":{"type":"string","x-stream-index":"001.002"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"002"},"revoke_tokens_issued_before":{"format":"date-time","type":"string","x-stream-index":"001.015"},"role":{"type":"string","x-stream-index":"001.006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids"],"type":"object"},"UserUpdatedEvent":{"description":"This event is sent when a user gets updated. The event contains information about the updated user.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"received_at":{"format":"date-time","type":"string","x-stream-index":"001.004"},"type":{"default":"user.updated","description":"The type of event: \"user.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.002"},"user":{"$ref":"#/components/schemas/UserResponsePrivacyFields","description":"The updated user","title":"User","x-stream-index":"002.001"}},"required":["type","created_at","custom","user"],"title":"UserUpdatedEvent","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"},"VideoEvent":{"description":"The discriminator object for all websocket events, it maps events' payload to the final type","discriminator":{"mapping":{"app.updated":"#/components/schemas/AppUpdatedEvent","call.accepted":"#/components/schemas/CallAcceptedEvent","call.blocked_user":"#/components/schemas/BlockedUserEvent","call.closed_caption":"#/components/schemas/ClosedCaptionEvent","call.closed_captions_failed":"#/components/schemas/CallClosedCaptionsFailedEvent","call.closed_captions_started":"#/components/schemas/CallClosedCaptionsStartedEvent","call.closed_captions_stopped":"#/components/schemas/CallClosedCaptionsStoppedEvent","call.created":"#/components/schemas/CallCreatedEvent","call.deleted":"#/components/schemas/CallDeletedEvent","call.ended":"#/components/schemas/CallEndedEvent","call.frame_recording_failed":"#/components/schemas/CallFrameRecordingFailedEvent","call.frame_recording_ready":"#/components/schemas/CallFrameRecordingFrameReadyEvent","call.frame_recording_started":"#/components/schemas/CallFrameRecordingStartedEvent","call.frame_recording_stopped":"#/components/schemas/CallFrameRecordingStoppedEvent","call.hls_broadcasting_failed":"#/components/schemas/CallHLSBroadcastingFailedEvent","call.hls_broadcasting_started":"#/components/schemas/CallHLSBroadcastingStartedEvent","call.hls_broadcasting_stopped":"#/components/schemas/CallHLSBroadcastingStoppedEvent","call.kicked_user":"#/components/schemas/KickedUserEvent","call.live_started":"#/components/schemas/CallLiveStartedEvent","call.member_added":"#/components/schemas/CallMemberAddedEvent","call.member_removed":"#/components/schemas/CallMemberRemovedEvent","call.member_updated":"#/components/schemas/CallMemberUpdatedEvent","call.member_updated_permission":"#/components/schemas/CallMemberUpdatedPermissionEvent","call.missed":"#/components/schemas/CallMissedEvent","call.moderation_blur":"#/components/schemas/CallModerationBlurEvent","call.moderation_warning":"#/components/schemas/CallModerationWarningEvent","call.notification":"#/components/schemas/CallNotificationEvent","call.permission_request":"#/components/schemas/PermissionRequestEvent","call.permissions_updated":"#/components/schemas/UpdatedCallPermissionsEvent","call.reaction_new":"#/components/schemas/CallReactionEvent","call.recording_failed":"#/components/schemas/CallRecordingFailedEvent","call.recording_ready":"#/components/schemas/CallRecordingReadyEvent","call.recording_started":"#/components/schemas/CallRecordingStartedEvent","call.recording_stopped":"#/components/schemas/CallRecordingStoppedEvent","call.rejected":"#/components/schemas/CallRejectedEvent","call.ring":"#/components/schemas/CallRingEvent","call.rtmp_broadcast_failed":"#/components/schemas/CallRtmpBroadcastFailedEvent","call.rtmp_broadcast_started":"#/components/schemas/CallRtmpBroadcastStartedEvent","call.rtmp_broadcast_stopped":"#/components/schemas/CallRtmpBroadcastStoppedEvent","call.session_ended":"#/components/schemas/CallSessionEndedEvent","call.session_participant_count_updated":"#/components/schemas/CallSessionParticipantCountsUpdatedEvent","call.session_participant_joined":"#/components/schemas/CallSessionParticipantJoinedEvent","call.session_participant_left":"#/components/schemas/CallSessionParticipantLeftEvent","call.session_started":"#/components/schemas/CallSessionStartedEvent","call.stats_report_ready":"#/components/schemas/CallStatsReportReadyEvent","call.transcription_failed":"#/components/schemas/CallTranscriptionFailedEvent","call.transcription_ready":"#/components/schemas/CallTranscriptionReadyEvent","call.transcription_started":"#/components/schemas/CallTranscriptionStartedEvent","call.transcription_stopped":"#/components/schemas/CallTranscriptionStoppedEvent","call.unblocked_user":"#/components/schemas/UnblockedUserEvent","call.updated":"#/components/schemas/CallUpdatedEvent","call.user_feedback_submitted":"#/components/schemas/CallUserFeedbackSubmittedEvent","call.user_muted":"#/components/schemas/CallUserMutedEvent","connection.error":"#/components/schemas/ConnectionErrorEvent","connection.ok":"#/components/schemas/ConnectedEvent","custom":"#/components/schemas/CustomVideoEvent","health.check":"#/components/schemas/HealthCheckEvent","user.banned":"#/components/schemas/UserBannedEvent","user.deactivated":"#/components/schemas/UserDeactivatedEvent","user.muted":"#/components/schemas/UserMutedEvent","user.reactivated":"#/components/schemas/UserReactivatedEvent","user.updated":"#/components/schemas/UserUpdatedEvent"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/AppUpdatedEvent"},{"$ref":"#/components/schemas/BlockedUserEvent"},{"$ref":"#/components/schemas/CallAcceptedEvent"},{"$ref":"#/components/schemas/CallClosedCaptionsFailedEvent"},{"$ref":"#/components/schemas/CallClosedCaptionsStartedEvent"},{"$ref":"#/components/schemas/CallClosedCaptionsStoppedEvent"},{"$ref":"#/components/schemas/CallCreatedEvent"},{"$ref":"#/components/schemas/CallDeletedEvent"},{"$ref":"#/components/schemas/CallEndedEvent"},{"$ref":"#/components/schemas/CallFrameRecordingFailedEvent"},{"$ref":"#/components/schemas/CallFrameRecordingFrameReadyEvent"},{"$ref":"#/components/schemas/CallFrameRecordingStartedEvent"},{"$ref":"#/components/schemas/CallFrameRecordingStoppedEvent"},{"$ref":"#/components/schemas/CallHLSBroadcastingFailedEvent"},{"$ref":"#/components/schemas/CallHLSBroadcastingStartedEvent"},{"$ref":"#/components/schemas/CallHLSBroadcastingStoppedEvent"},{"$ref":"#/components/schemas/CallLiveStartedEvent"},{"$ref":"#/components/schemas/CallMemberAddedEvent"},{"$ref":"#/components/schemas/CallMemberRemovedEvent"},{"$ref":"#/components/schemas/CallMemberUpdatedEvent"},{"$ref":"#/components/schemas/CallMemberUpdatedPermissionEvent"},{"$ref":"#/components/schemas/CallMissedEvent"},{"$ref":"#/components/schemas/CallModerationBlurEvent"},{"$ref":"#/components/schemas/CallModerationWarningEvent"},{"$ref":"#/components/schemas/CallNotificationEvent"},{"$ref":"#/components/schemas/CallReactionEvent"},{"$ref":"#/components/schemas/CallRecordingFailedEvent"},{"$ref":"#/components/schemas/CallRecordingReadyEvent"},{"$ref":"#/components/schemas/CallRecordingStartedEvent"},{"$ref":"#/components/schemas/CallRecordingStoppedEvent"},{"$ref":"#/components/schemas/CallRejectedEvent"},{"$ref":"#/components/schemas/CallRingEvent"},{"$ref":"#/components/schemas/CallRtmpBroadcastFailedEvent"},{"$ref":"#/components/schemas/CallRtmpBroadcastStartedEvent"},{"$ref":"#/components/schemas/CallRtmpBroadcastStoppedEvent"},{"$ref":"#/components/schemas/CallSessionEndedEvent"},{"$ref":"#/components/schemas/CallSessionParticipantCountsUpdatedEvent"},{"$ref":"#/components/schemas/CallSessionParticipantJoinedEvent"},{"$ref":"#/components/schemas/CallSessionParticipantLeftEvent"},{"$ref":"#/components/schemas/CallSessionStartedEvent"},{"$ref":"#/components/schemas/CallStatsReportReadyEvent"},{"$ref":"#/components/schemas/CallTranscriptionFailedEvent"},{"$ref":"#/components/schemas/CallTranscriptionReadyEvent"},{"$ref":"#/components/schemas/CallTranscriptionStartedEvent"},{"$ref":"#/components/schemas/CallTranscriptionStoppedEvent"},{"$ref":"#/components/schemas/CallUpdatedEvent"},{"$ref":"#/components/schemas/CallUserFeedbackSubmittedEvent"},{"$ref":"#/components/schemas/CallUserMutedEvent"},{"$ref":"#/components/schemas/ClosedCaptionEvent"},{"$ref":"#/components/schemas/ConnectedEvent"},{"$ref":"#/components/schemas/ConnectionErrorEvent"},{"$ref":"#/components/schemas/CustomVideoEvent"},{"$ref":"#/components/schemas/HealthCheckEvent"},{"$ref":"#/components/schemas/KickedUserEvent"},{"$ref":"#/components/schemas/PermissionRequestEvent"},{"$ref":"#/components/schemas/UnblockedUserEvent"},{"$ref":"#/components/schemas/UpdatedCallPermissionsEvent"},{"$ref":"#/components/schemas/UserBannedEvent"},{"$ref":"#/components/schemas/UserDeactivatedEvent"},{"$ref":"#/components/schemas/UserMutedEvent"},{"$ref":"#/components/schemas/UserReactivatedEvent"},{"$ref":"#/components/schemas/UserUpdatedEvent"}]},"VideoReactionOverTimeResponse":{"properties":{"by_minute":{"items":{"$ref":"#/components/schemas/CountByMinuteResponse"},"type":"array","x-stream-index":"001"}},"type":"object"},"VideoReactionsResponse":{"nullable":true,"properties":{"count_over_time":{"$ref":"#/components/schemas/VideoReactionOverTimeResponse","x-stream-index":"002"},"reaction":{"type":"string","x-stream-index":"001"}},"required":["reaction"],"type":"object"},"VideoSettingsRequest":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"camera_default_on":{"type":"boolean","x-stream-index":"004"},"camera_facing":{"enum":["front","back","external"],"type":"string","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"type":"object"},"VideoSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"camera_default_on":{"type":"boolean","x-stream-index":"004"},"camera_facing":{"enum":["front","back","external"],"type":"string","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled","target_resolution","camera_default_on","camera_facing"],"type":"object"},"WSAuthMessage":{"description":"Websocket auth message","nullable":true,"properties":{"products":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"token":{"title":"Token","type":"string","x-stream-index":"002"},"user_details":{"$ref":"#/components/schemas/ConnectUserDetailsRequest","x-stream-index":"001"}},"required":["user_details","token"],"title":"WSAuthMessage","type":"object"}},"securitySchemes":{"JWT":{"description":"JWT should be always provided when stream-auth-type=jwt.\n\nUsing JWT auth request could be authenticated as user or as server-side.\n\nWhen using user authentication permission checking is going to be applied to requests based on the user that is\nperforming a request.\n\nThe `authorization` header should be a JWT string signed using the secret attached to the API key used to perform\nrequests.\n\n**WARNING** all client-side official SDK do not ship with token generation; this is to make sure that the API secret is not\nshared with an untrusted party such as a browser or a iOS/Android application. Tokens **must** be generated server-side.\nIf you wish, you can configure your application to ignore authentication (see `disable_auth_check`)\nThe JWT string must include only the user_id claim and can include any built-in JWT claim such as iat, exp as well.\n","in":"header","name":"Authorization","type":"apiKey"},"api_key":{"description":"Application API key should be always set in order to authenticate the request.","in":"query","name":"api_key","type":"apiKey"},"stream-auth-type":{"description":"Stream-Auth-Type should be always set in order to authenticate the request. Possible\nvalues: `jwt` or `anonymous`.\n\n`jwt` allows you to authenticate as a user. With this auth type you should also provide valid JWT in Authorization\nheader.\n\n`anonymous` allows you to authenticate as anonymous user. Please note that most advanced features are not available\nto anonymous users.","in":"header","name":"Stream-Auth-Type","type":"apiKey"}}},"info":{"title":"Stream API","version":"v191.1.0"},"openapi":"3.0.3","paths":{"/video/call/members":{"post":{"description":"Query call members with filter query\n","operationId":"QueryCallMembers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallMembersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallMembersResponse"}}},"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":"Query call members","tags":["product:video"]}},"/video/call/stats":{"post":{"description":"\n","operationId":"QueryCallStats","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallStatsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallStatsResponse"}}},"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":"Query Call Stats","tags":["product:video"]}},"/video/call/{type}/{id}":{"get":{"description":"\n","operationId":"GetCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"query","name":"connection_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"003"}},{"in":"query","name":"members_limit","schema":{"format":"int32","maximum":100,"minimum":0,"type":"integer","writeOnly":true,"x-stream-index":"004"}},{"in":"query","name":"ring","schema":{"type":"boolean","writeOnly":true,"x-stream-index":"005"}},{"in":"query","name":"notify","schema":{"type":"boolean","writeOnly":true,"x-stream-index":"006"}},{"in":"query","name":"video","schema":{"type":"boolean","writeOnly":true,"x-stream-index":"007"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCallResponse"}}},"description":"GetCallResponse"},"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":"Get Call","tags":["product:video"]},"patch":{"description":"\n\nSends events:\n- call.updated\n","operationId":"UpdateCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallRequest"}}},"description":"UpdateCallRequest","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallResponse"}}},"description":"UpdateCallResponse"},"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":"Update Call","tags":["product:video"]},"post":{"description":"Gets or creates a new call\n\nSends events:\n- call.created\n- call.notification\n- call.ring\n","operationId":"GetOrCreateCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}},{"in":"query","name":"connection_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"008"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrCreateCallRequest"}}},"description":"GetOrCreateCallRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrCreateCallResponse"}}},"description":"GetOrCreateCallResponse"},"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":"Get or create a call","tags":["product:video"]}},"/video/call/{type}/{id}/accept":{"post":{"description":"\n\nSends events:\n- call.accepted\n","operationId":"AcceptCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcceptCallResponse"}}},"description":"AcceptCallResponse"},"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":"Accept Call","tags":["product:video"]}},"/video/call/{type}/{id}/block":{"post":{"description":"Block a user, preventing them from joining the call until they are unblocked.\n\nSends events:\n- call.blocked_user\n","operationId":"BlockUser","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUserRequest"}}},"description":"BlockUserRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUserResponse"}}},"description":"BlockUserResponse"},"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":"Block user on a call","tags":["product:video"]}},"/video/call/{type}/{id}/delete":{"post":{"description":"\n\nSends events:\n- call.deleted\n","operationId":"DeleteCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCallRequest"}}},"description":"DeleteCallRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCallResponse"}}},"description":"DeleteCallResponse"},"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":"Delete Call","tags":["product:video"]}},"/video/call/{type}/{id}/event":{"post":{"description":"Sends custom event to the call\n\nSends events:\n- custom\n","operationId":"SendCallEvent","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendCallEventRequest"}}},"description":"SendCallEventRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendCallEventResponse"}}},"description":"SendCallEventResponse"},"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":"Send custom event","tags":["product:video"]}},"/video/call/{type}/{id}/feedback":{"post":{"description":"\n\nSends events:\n- call.user_feedback_submitted\n","operationId":"CollectUserFeedback","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectUserFeedbackRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectUserFeedbackResponse"}}},"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":"Collect user feedback","tags":["product:video"]}},"/video/call/{type}/{id}/go_live":{"post":{"description":"\n\nSends events:\n- call.live_started\n","operationId":"GoLive","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoLiveRequest"}}},"description":"GoLiveRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoLiveResponse"}}},"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":"Set call as live","tags":["product:video"]}},"/video/call/{type}/{id}/join":{"post":{"description":"Request to join a call\n","operationId":"JoinCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"query","name":"connection_id","schema":{"title":"ConnectionID","type":"string","writeOnly":true,"x-stream-index":"008"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JoinCallRequest"}}},"description":"JoinCallRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JoinCallResponse"}}},"description":"JoinCallResponse"},"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":"Join call","tags":["product:video"]}},"/video/call/{type}/{id}/kick":{"post":{"description":"Kicks a user from the call. Optionally block the user from rejoining by setting block=true.\n\nSends events:\n- call.blocked_user\n- call.kicked_user\n","operationId":"KickUser","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KickUserRequest"}}},"description":"KickUserRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KickUserResponse"}}},"description":"KickUserResponse"},"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":"Kick user from a call","tags":["product:video"]}},"/video/call/{type}/{id}/mark_ended":{"post":{"description":"\n\nSends events:\n- call.ended\n","operationId":"EndCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EndCallResponse"}}},"description":"EndCallResponse"},"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":"End call","tags":["product:video"]}},"/video/call/{type}/{id}/members":{"post":{"description":"\n\nSends events:\n- call.member_added\n- call.member_removed\n- call.member_updated\n","operationId":"UpdateCallMembers","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallMembersRequest"}}},"description":"UpdateCallMembersRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallMembersResponse"}}},"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":"Update Call Member","tags":["product:video"]}},"/video/call/{type}/{id}/mute_users":{"post":{"description":"Mutes users in a call\n","operationId":"MuteUsers","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteUsersRequest"}}},"description":"MuteUsersRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteUsersResponse"}}},"description":"MuteUsersResponse"},"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":"Mute users","tags":["product:video"]}},"/video/call/{type}/{id}/participants":{"post":{"description":"Returns a list of participants connected to the call\n","operationId":"QueryCallParticipants","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"type","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"limit","schema":{"format":"int32","maximum":100,"type":"integer","x-stream-index":"004"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallParticipantsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallParticipantsResponse"}}},"description":"Successful 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":"Query call participants","tags":["product:video"]}},"/video/call/{type}/{id}/pin":{"post":{"description":"Pins a track for all users in the call.\n","operationId":"VideoPin","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PinRequest"}}},"description":"PinRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PinResponse"}}},"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":"Pin","tags":["product:video"]}},"/video/call/{type}/{id}/reaction":{"post":{"description":"Sends reaction to the call\n\nSends events:\n- call.reaction_new\n","operationId":"SendVideoReaction","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendReactionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendReactionResponse"}}},"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":"Send reaction to the call","tags":["product:video"]}},"/video/call/{type}/{id}/recordings":{"get":{"description":"Lists recordings\n","operationId":"ListRecordings","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListRecordingsResponse"}}},"description":"ListRecordingsResponse"},"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":"List recordings","tags":["product:video"]}},"/video/call/{type}/{id}/reject":{"post":{"description":"\n\nSends events:\n- call.rejected\n","operationId":"RejectCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RejectCallRequest"}}},"description":"RejectCallRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RejectCallResponse"}}},"description":"RejectCallResponse"},"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":"Reject Call","tags":["product:video"]}},"/video/call/{type}/{id}/report":{"get":{"description":"\n","operationId":"GetCallReport","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"query","name":"session_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCallReportResponse"}}},"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":"Get call report","tags":["product:video"]}},"/video/call/{type}/{id}/request_permission":{"post":{"description":"Request permission to perform an action\n\nSends events:\n- call.permission_request\n","operationId":"RequestPermission","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestPermissionRequest"}}},"description":"RequestPermissionRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestPermissionResponse"}}},"description":"RequestPermissionResponse"},"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":"Request permission","tags":["product:video"]}},"/video/call/{type}/{id}/rtmp_broadcasts":{"post":{"description":"Starts RTMP broadcasts for the provided RTMP destinations\n","operationId":"StartRTMPBroadcasts","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRTMPBroadcastsRequest"}}},"description":"StartRTMPBroadcastsRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRTMPBroadcastsResponse"}}},"description":"StartRTMPBroadcastsResponse"},"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":"Start RTMP broadcasts","tags":["product:video"]}},"/video/call/{type}/{id}/rtmp_broadcasts/stop":{"post":{"description":"Stop all RTMP broadcasts for the provided call\n","operationId":"StopAllRTMPBroadcasts","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopAllRTMPBroadcastsResponse"}}},"description":"StopAllRTMPBroadcastsResponse"},"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":"Stop all RTMP broadcasts for a call","tags":["product:video"]}},"/video/call/{type}/{id}/rtmp_broadcasts/{name}/stop":{"post":{"description":"Stop RTMP broadcasts for the provided RTMP destinations\n","operationId":"StopRTMPBroadcast","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopRTMPBroadcastsRequest"}}},"description":"StopRTMPBroadcastsRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopRTMPBroadcastsResponse"}}},"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":"Stop RTMP broadcasts","tags":["product:video"]}},"/video/call/{type}/{id}/start_broadcasting":{"post":{"description":"Starts HLS broadcasting\n","operationId":"StartHLSBroadcasting","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartHLSBroadcastingResponse"}}},"description":"StartHLSBroadcastingResponse"},"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":"Start HLS broadcasting","tags":["product:video"]}},"/video/call/{type}/{id}/start_closed_captions":{"post":{"description":"Starts closed captions\n","operationId":"StartClosedCaptions","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartClosedCaptionsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartClosedCaptionsResponse"}}},"description":"Successful 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":"Start closed captions","tags":["product:video"]}},"/video/call/{type}/{id}/start_frame_recording":{"post":{"description":"Starts frame by frame recording\n\nSends events:\n- call.frame_recording_started\n","operationId":"StartFrameRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartFrameRecordingRequest"}}},"description":"StartFrameRecordingRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartFrameRecordingResponse"}}},"description":"StartFrameRecordingResponse"},"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":"Start frame recording","tags":["product:video"]}},"/video/call/{type}/{id}/start_recording":{"post":{"description":"Starts recording\n\nSends events:\n- call.recording_started\n","operationId":"StartRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRecordingRequest"}}},"description":"StartRecordingRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRecordingResponse"}}},"description":"StartRecordingResponse"},"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":"Start recording","tags":["product:video"]}},"/video/call/{type}/{id}/start_transcription":{"post":{"description":"Starts transcription\n","operationId":"StartTranscription","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartTranscriptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartTranscriptionResponse"}}},"description":"StartTranscriptionResponse"},"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":"Start transcription","tags":["product:video"]}},"/video/call/{type}/{id}/stop_broadcasting":{"post":{"description":"Stops HLS broadcasting\n","operationId":"StopHLSBroadcasting","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopHLSBroadcastingResponse"}}},"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":"Stop HLS broadcasting","tags":["product:video"]}},"/video/call/{type}/{id}/stop_closed_captions":{"post":{"description":"Stops closed captions\n\nSends events:\n- call.transcription_stopped\n","operationId":"StopClosedCaptions","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopClosedCaptionsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopClosedCaptionsResponse"}}},"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":"Stop closed captions","tags":["product:video"]}},"/video/call/{type}/{id}/stop_frame_recording":{"post":{"description":"Stops frame recording\n\nSends events:\n- call.frame_recording_stopped\n","operationId":"StopFrameRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopFrameRecordingResponse"}}},"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":"Stop frame recording","tags":["product:video"]}},"/video/call/{type}/{id}/stop_live":{"post":{"description":"\n\nSends events:\n- call.updated\n","operationId":"StopLive","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopLiveRequest"}}},"description":"StopLiveRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopLiveResponse"}}},"description":"StopLiveResponse"},"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":"Set call as not live","tags":["product:video"]}},"/video/call/{type}/{id}/stop_recording":{"post":{"description":"Stops recording\n\nSends events:\n- call.recording_stopped\n","operationId":"StopRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopRecordingResponse"}}},"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":"Stop recording","tags":["product:video"]}},"/video/call/{type}/{id}/stop_transcription":{"post":{"description":"Stops transcription\n\nSends events:\n- call.transcription_stopped\n","operationId":"StopTranscription","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopTranscriptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopTranscriptionResponse"}}},"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":"Stop transcription","tags":["product:video"]}},"/video/call/{type}/{id}/transcriptions":{"get":{"description":"Lists transcriptions\n","operationId":"ListTranscriptions","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTranscriptionsResponse"}}},"description":"ListTranscriptionsResponse"},"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":"List transcriptions","tags":["product:video"]}},"/video/call/{type}/{id}/unblock":{"post":{"description":"Removes the block for a user on a call. The user will be able to join the call again.\n\nSends events:\n- call.unblocked_user\n","operationId":"UnblockUser","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUserRequest"}}},"description":"UnblockUserRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUserResponse"}}},"description":"UnblockUserResponse"},"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":"Unblocks user on a call","tags":["product:video"]}},"/video/call/{type}/{id}/unpin":{"post":{"description":"Unpins a track for all users in the call.\n","operationId":"VideoUnpin","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnpinRequest"}}},"description":"UnpinRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnpinResponse"}}},"description":"UnpinResponse"},"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":"Unpin","tags":["product:video"]}},"/video/call/{type}/{id}/user_permissions":{"post":{"description":"Updates user permissions\n\nSends events:\n- call.permissions_updated\n","operationId":"UpdateUserPermissions","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"005.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"005.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUserPermissionsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUserPermissionsResponse"}}},"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":"Update user permissions","tags":["product:video"]}},"/video/call/{type}/{id}/{session}/recordings/{filename}":{"delete":{"description":"Deletes recording\n","operationId":"DeleteRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"path","name":"session","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"003"}},{"in":"path","name":"filename","required":true,"schema":{"maxLength":256,"type":"string","writeOnly":true,"x-stream-index":"004"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteRecordingResponse"}}},"description":"DeleteRecordingResponse"},"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":"Delete recording","tags":["product:video"]}},"/video/call/{type}/{id}/{session}/transcriptions/{filename}":{"delete":{"description":"Deletes transcription\n","operationId":"DeleteTranscription","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"path","name":"session","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"003"}},{"in":"path","name":"filename","required":true,"schema":{"maxLength":256,"type":"string","writeOnly":true,"x-stream-index":"004"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteTranscriptionResponse"}}},"description":"DeleteTranscriptionResponse"},"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":"Delete transcription","tags":["product:video"]}},"/video/calls":{"post":{"description":"Query calls with filter query\n","operationId":"QueryCalls","parameters":[{"in":"query","name":"connection_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallsRequest"}}},"description":"QueryCallsRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallsResponse"}}},"description":"QueryCallsResponse"},"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":"Query call","tags":["product:video"]}},"/video/devices":{"delete":{"description":"Deletes one device\n","operationId":"DeleteDevice","parameters":[{"in":"query","name":"id","required":true,"schema":{"description":"Device ID to delete","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete device","tags":["product:video"]},"get":{"description":"Returns all available devices\n","operationId":"ListDevices","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDevicesResponse"}}},"description":"ListDevicesResponse"},"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":"List devices","tags":["product:video"]},"post":{"description":"Adds a new device to a user, if the same device already exists the call will have no effect\n","operationId":"CreateDevice","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDeviceRequest"}}},"description":"CreateDeviceRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Create device","tags":["product:video"]}},"/video/edges":{"get":{"description":"Returns the list of all edges available for video calls.\n","operationId":"GetEdges","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetEdgesResponse"}}},"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":"Get Edges","tags":["product:video"]}},"/video/guest":{"post":{"description":"\n","operationId":"CreateGuest","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGuestRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGuestResponse"}}},"description":"Successful 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":"Create Guest","tags":["product:video"]}},"/video/longpoll":{"get":{"description":"Establishes WebSocket connection for user to video\n\nSends events:\n- health.check\n- connection.ok\n","operationId":"VideoConnect","responses":{"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":"Video Connect (WebSocket)","tags":["product:video"]}},"/video/stats":{"post":{"description":"\n","operationId":"QueryAggregateCallStats","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryAggregateCallStatsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryAggregateCallStatsResponse"}}},"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":"Query Aggregate call Stats","tags":["product:video"]}}},"security":[{"JWT":[],"api_key":[],"stream-auth-type":[]},{"api_key":[],"stream-auth-type":[]}],"servers":[{"description":"Stream API","url":"https://chat.stream-io-api.com"}]} \ No newline at end of file diff --git a/openapi/video-openapi-clientside.yaml b/openapi/video-openapi-clientside.yaml index a8912c3da..f7aabfa8b 100644 --- a/openapi/video-openapi-clientside.yaml +++ b/openapi/video-openapi-clientside.yaml @@ -2557,7 +2557,7 @@ components: x-stream-index: "001.002" type: default: call.updated - description: 'The type of event: "call.ended" in this case' + description: 'The type of event: "call.updated" in this case' title: Event Type type: string x-stream-index: "001.001" @@ -3310,6 +3310,21 @@ components: - duration title: EndCallResponse type: object + FeedsEventPreferences: + properties: + comments: + type: string + x-stream-index: "002" + mentions: + type: string + x-stream-index: "004" + new_followers: + type: string + x-stream-index: "003" + reactions: + type: string + x-stream-index: "001" + type: object FileUploadConfig: properties: allowed_file_extensions: @@ -3948,6 +3963,76 @@ components: - duration title: JoinCallResponse type: object + KickUserRequest: + description: KickUserRequest is the payload for kicking a user from a call. + Optionally block the user as well. + nullable: true + properties: + block: + description: If true, also block the user from rejoining the call + title: Block + type: boolean + x-stream-index: "004" + user_id: + description: The user to kick + title: UserID + type: string + x-stream-index: "003" + required: + - user_id + title: KickUserRequest + type: object + KickUserResponse: + description: KickUserResponse is the payload for kicking a user from a call. + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "001.001" + required: + - duration + title: KickUserResponse + type: object + KickedUserEvent: + description: This event is sent to call participants to notify when a user is + kicked from a call. Clients should make the kicked user leave the call UI. + properties: + call_cid: + type: string + x-stream-index: "002.001" + created_at: + format: date-time + type: string + x-stream-index: "001.002" + kicked_by_user: + $ref: '#/components/schemas/UserResponse' + description: The user that kicked the participant, null if server-side + title: Kicked by + x-stream-index: "004" + type: + default: call.kicked_user + description: 'The type of event: "call.kicked_user" in this case' + title: Event Type + type: string + x-stream-index: "001.001" + user: + $ref: '#/components/schemas/UserResponse' + description: The user that was kicked + title: User + x-stream-index: "003" + required: + - type + - created_at + - call_cid + - user + title: KickedUserEvent + type: object + x-stream-event-call-type: true + x-stream-event-doc-group: call + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent LayoutSettingsRequest: properties: detect_orientation: @@ -4232,6 +4317,7 @@ components: - join-backstage - join-call - join-ended-call + - kick-user - mute-users - pin-for-everyone - read-call @@ -4566,6 +4652,12 @@ components: x-stream-index: "001" disabled_until: format: date-time + type: string + x-stream-index: "005" + feeds_events: + $ref: '#/components/schemas/FeedsEventPreferences' + x-stream-index: "004" + feeds_level: type: string x-stream-index: "003" type: object @@ -6771,6 +6863,7 @@ components: call.hls_broadcasting_failed: '#/components/schemas/CallHLSBroadcastingFailedEvent' call.hls_broadcasting_started: '#/components/schemas/CallHLSBroadcastingStartedEvent' call.hls_broadcasting_stopped: '#/components/schemas/CallHLSBroadcastingStoppedEvent' + call.kicked_user: '#/components/schemas/KickedUserEvent' call.live_started: '#/components/schemas/CallLiveStartedEvent' call.member_added: '#/components/schemas/CallMemberAddedEvent' call.member_removed: '#/components/schemas/CallMemberRemovedEvent' @@ -6870,6 +6963,7 @@ components: - $ref: '#/components/schemas/ConnectionErrorEvent' - $ref: '#/components/schemas/CustomVideoEvent' - $ref: '#/components/schemas/HealthCheckEvent' + - $ref: '#/components/schemas/KickedUserEvent' - $ref: '#/components/schemas/PermissionRequestEvent' - $ref: '#/components/schemas/UnblockedUserEvent' - $ref: '#/components/schemas/UpdatedCallPermissionsEvent' @@ -7010,7 +7104,7 @@ components: type: apiKey info: title: Stream API - version: v187.13.0 + version: v191.1.0 openapi: 3.0.3 paths: /video/call/{type}/{id}: @@ -7740,6 +7834,65 @@ paths: summary: Join call tags: - product:video + /video/call/{type}/{id}/kick: + post: + description: | + Kicks a user from the call. Optionally block the user from rejoining by setting block=true. + + Sends events: + - call.blocked_user + - call.kicked_user + operationId: KickUser + parameters: + - in: path + name: type + required: true + schema: + description: The type of call + maxLength: 64 + title: Type + type: string + writeOnly: true + x-stream-index: "002.001" + - in: path + name: id + required: true + schema: + description: Call ID + maxLength: 64 + title: ID + type: string + writeOnly: true + x-stream-index: "002.002" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/KickUserRequest' + description: KickUserRequest + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/KickUserResponse' + description: KickUserResponse + "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: Kick user from a call + tags: + - product:video /video/call/{type}/{id}/mark_ended: post: description: |2 diff --git a/openapi/video-openapi.json b/openapi/video-openapi.json index 4d694c8da..26a06816e 100644 --- a/openapi/video-openapi.json +++ b/openapi/video-openapi.json @@ -1 +1 @@ -{"components":{"schemas":{"APIError":{"nullable":true,"properties":{"StatusCode":{"description":"Response HTTP status code","format":"int32","title":"Status code","type":"integer","x-stream-index":"004"},"code":{"description":"API error code","format":"int32","title":"Code","type":"integer","x-stream-index":"001"},"details":{"description":"Additional error-specific information","items":{"type":"integer"},"title":"Details","type":"array","x-stream-index":"007"},"duration":{"description":"Request duration","title":"Duration","type":"string","x-stream-index":"005"},"exception_fields":{"additionalProperties":{"type":"string"},"description":"Additional error info","title":"Exception fields","type":"object","x-stream-index":"003"},"message":{"description":"Message describing an error","title":"Message","type":"string","x-stream-index":"002"},"more_info":{"description":"URL with additional information","title":"More info","type":"string","x-stream-index":"006"},"unrecoverable":{"description":"Flag that indicates if the error is unrecoverable, requests that return unrecoverable errors should not be retried, this error only applies to the request that caused it","title":"Unrecoverable","type":"boolean","x-stream-index":"008"}},"required":["code","message","StatusCode","duration","more_info","details"],"title":"Error response","type":"object"},"APNS":{"properties":{"body":{"type":"string","x-stream-index":"002"},"content-available":{"format":"int32","type":"integer","x-stream-index":"004"},"data":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"mutable-content":{"format":"int32","type":"integer","x-stream-index":"005"},"sound":{"type":"string","x-stream-index":"003"},"title":{"type":"string","x-stream-index":"001"}},"type":"object"},"ActiveCallsFPSStats":{"properties":{"p05":{"format":"float","type":"number","x-stream-index":"001"},"p10":{"format":"float","type":"number","x-stream-index":"002"},"p50":{"format":"float","type":"number","x-stream-index":"003"},"p90":{"format":"float","type":"number","x-stream-index":"004"}},"required":["p05","p10","p50","p90"],"type":"object"},"ActiveCallsLatencyStats":{"properties":{"p50":{"format":"float","type":"number","x-stream-index":"001"},"p90":{"format":"float","type":"number","x-stream-index":"002"}},"required":["p50","p90"],"type":"object"},"ActiveCallsMetrics":{"properties":{"join_call_api":{"$ref":"#/components/schemas/JoinCallAPIMetrics","x-stream-index":"001"},"publishers":{"$ref":"#/components/schemas/PublishersMetrics","x-stream-index":"002"},"subscribers":{"$ref":"#/components/schemas/SubscribersMetrics","x-stream-index":"003"}},"type":"object"},"ActiveCallsSummary":{"properties":{"active_calls":{"format":"int32","type":"integer","x-stream-index":"001"},"active_publishers":{"format":"int32","type":"integer","x-stream-index":"002"},"active_subscribers":{"format":"int32","type":"integer","x-stream-index":"003"},"participants":{"format":"int32","type":"integer","x-stream-index":"004"}},"required":["active_calls","active_publishers","active_subscribers","participants"],"type":"object"},"AsyncExportChannelsEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"003.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.007"},"finished_at":{"format":"date-time","type":"string","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"string","x-stream-index":"003.004"},"started_at":{"format":"date-time","type":"string","x-stream-index":"002.002"},"task_id":{"type":"string","x-stream-index":"002.001"},"type":{"default":"export.channels.success","type":"string","x-stream-index":"003.002"},"url":{"type":"string","x-stream-index":"001"}},"required":["url","task_id","started_at","finished_at","type","created_at","custom"],"title":"AsyncExportChannelsEvent","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"},"AsyncExportErrorEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"003.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.007"},"error":{"type":"string","x-stream-index":"001"},"finished_at":{"format":"date-time","type":"string","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"string","x-stream-index":"003.004"},"started_at":{"format":"date-time","type":"string","x-stream-index":"002.002"},"task_id":{"type":"string","x-stream-index":"002.001"},"type":{"default":"export.users.error","type":"string","x-stream-index":"003.002"}},"required":["error","task_id","started_at","finished_at","type","created_at","custom"],"title":"AsyncExportErrorEvent","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"},"AsyncExportUsersEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"003.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.007"},"finished_at":{"format":"date-time","type":"string","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"string","x-stream-index":"003.004"},"started_at":{"format":"date-time","type":"string","x-stream-index":"002.002"},"task_id":{"type":"string","x-stream-index":"002.001"},"type":{"default":"export.users.success","type":"string","x-stream-index":"003.002"},"url":{"type":"string","x-stream-index":"001"}},"required":["url","task_id","started_at","finished_at","type","created_at","custom"],"title":"AsyncExportUsersEvent","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"},"AudioSettingsRequest":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"001"},"default_device":{"enum":["speaker","earpiece"],"type":"string","x-stream-index":"006"},"mic_default_on":{"type":"boolean","x-stream-index":"004"},"noise_cancellation":{"$ref":"#/components/schemas/NoiseCancellationSettings","x-stream-index":"007"},"opus_dtx_enabled":{"type":"boolean","x-stream-index":"002"},"redundant_coding_enabled":{"type":"boolean","x-stream-index":"003"},"speaker_default_on":{"type":"boolean","x-stream-index":"005"}},"required":["default_device"],"type":"object"},"AudioSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"001"},"default_device":{"enum":["speaker","earpiece"],"type":"string","x-stream-index":"006"},"mic_default_on":{"type":"boolean","x-stream-index":"004"},"noise_cancellation":{"$ref":"#/components/schemas/NoiseCancellationSettings","x-stream-index":"007"},"opus_dtx_enabled":{"type":"boolean","x-stream-index":"002"},"redundant_coding_enabled":{"type":"boolean","x-stream-index":"003"},"speaker_default_on":{"type":"boolean","x-stream-index":"005"}},"required":["access_request_enabled","opus_dtx_enabled","redundant_coding_enabled","mic_default_on","speaker_default_on","default_device"],"type":"object"},"AzureRequest":{"description":"Config for creating Azure Blob Storage storage","properties":{"abs_account_name":{"description":"The account name","title":"AccountName","type":"string","x-stream-index":"001"},"abs_client_id":{"description":"The client id","title":"ClientID","type":"string","x-stream-index":"003"},"abs_client_secret":{"description":"The client secret","title":"ClientSecret","type":"string","x-stream-index":"004"},"abs_tenant_id":{"description":"The tenant id","title":"TenantID","type":"string","x-stream-index":"002"}},"required":["abs_account_name","abs_tenant_id","abs_client_id","abs_client_secret"],"title":"AzureRequest","type":"object"},"BackstageSettingsRequest":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"002"}},"type":"object"},"BackstageSettingsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"BlockUserRequest":{"description":"BlockUserRequest is the payload for blocking a user.","nullable":true,"properties":{"user_id":{"description":"the user to block","title":"UserID","type":"string","x-stream-index":"003"}},"required":["user_id"],"title":"BlockUserRequest","type":"object"},"BlockUserResponse":{"description":"BlockUserResponse is the payload for blocking a user.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"BlockUserResponse","type":"object"},"BlockedUserEvent":{"description":"This event is sent to call participants to notify when a user is blocked on a call, clients can use this event to show a notification.\nIf the user is the current user, the client should leave the call screen as well","properties":{"blocked_by_user":{"$ref":"#/components/schemas/UserResponse","description":"The user that blocked the user, null if the user was blocked by server-side","title":"Blocked by","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"call.blocked_user","description":"The type of event: \"call.blocked_user\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user that was blocked","title":"User","x-stream-index":"003"}},"required":["type","created_at","call_cid","user"],"title":"BlockedUserEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"Bound":{"properties":{"inclusive":{"type":"boolean","x-stream-index":"002"},"value":{"format":"float","type":"number","x-stream-index":"001"}},"required":["value","inclusive"],"type":"object"},"BroadcastSettingsRequest":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettingsRequest","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettingsRequest","x-stream-index":"003"}},"type":"object"},"BroadcastSettingsResponse":{"description":"BroadcastSettingsResponse is the payload for broadcasting settings","properties":{"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettingsResponse","title":"HLS","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettingsResponse","title":"RTMP","x-stream-index":"003"}},"required":["enabled","hls","rtmp"],"title":"BroadcastSettingsResponse","type":"object"},"BrowserDataResponse":{"properties":{"name":{"type":"string","x-stream-index":"001"},"version":{"type":"string","x-stream-index":"002"}},"type":"object"},"CallAcceptedEvent":{"description":"This event is sent when a user accepts a notification to join a call.","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"call.accepted","description":"The type of event: \"call.accepted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who accepted the call","title":"User","x-stream-index":"004"}},"required":["type","created_at","call_cid","call","user"],"title":"CallAcceptedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallClosedCaption":{"description":"CallClosedCaption represents a closed caption of a call.","properties":{"end_time":{"format":"date-time","title":"The end time of the closed caption.","type":"string","x-stream-index":"003"},"speaker_id":{"title":"The speaker ID of the closed caption.","type":"string","x-stream-index":"004"},"start_time":{"format":"date-time","title":"The start time of the closed caption.","type":"string","x-stream-index":"002"},"text":{"title":"The text of the closed caption.","type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserResponse","title":"The full user for the closed caption.","x-stream-index":"005"}},"required":["text","start_time","end_time","speaker_id","user"],"title":"CallClosedCaption","type":"object"},"CallClosedCaptionsFailedEvent":{"description":"This event is sent when call closed captions has failed","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"call.closed_captions_failed","description":"The type of event: \"call.closed_captions_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallClosedCaptionsFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallClosedCaptionsStartedEvent":{"description":"This event is sent when call closed caption has started","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"call.closed_captions_started","description":"The type of event: \"call.closed_captions_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallClosedCaptionsStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallClosedCaptionsStoppedEvent":{"description":"This event is sent when call closed captions has stopped","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"call.closed_captions_stopped","description":"The type of event: \"call.transcription_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallClosedCaptionsStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallCreatedEvent":{"description":"This event is sent when a call is created. Clients receiving this event should check if the ringing\nfield is set to true and if so, show the call screen","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"members":{"description":"the members added to this call","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"004"},"type":{"default":"call.created","description":"The type of event: \"call.created\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","members"],"title":"CallCreatedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallDeletedEvent":{"description":"This event is sent when a call is deleted. Clients receiving this event should leave the call screen","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"call.deleted","description":"The type of event: \"call.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call"],"title":"CallDeletedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallDurationReport":{"properties":{"histogram":{"items":{"$ref":"#/components/schemas/ReportByHistogramBucket"},"type":"array","x-stream-index":"001"}},"required":["histogram"],"type":"object"},"CallDurationReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateCallDurationReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"CallEndedEvent":{"description":"This event is sent when a call is mark as ended for all its participants. Clients receiving this event should leave the call screen","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"reason":{"description":"The reason why the call ended, if available","title":"CallEndedReason","type":"string","x-stream-index":"005"},"type":{"default":"call.ended","description":"The type of event: \"call.ended\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who ended the call, null if the call was ended by the server","title":"User","x-stream-index":"004"}},"required":["type","created_at","call_cid","call"],"title":"CallEndedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallFrameRecordingFailedEvent":{"description":"This event is sent when frame recording has failed","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.frame_recording_failed","description":"The type of event: \"call.frame_recording_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","egress_id"],"title":"CallFrameRecordingFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallFrameRecordingFrameReadyEvent":{"description":"This event is sent when a frame is captured from a call","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"captured_at":{"description":"The time the frame was captured","format":"date-time","title":"CapturedAt","type":"string","x-stream-index":"006"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"008"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"track_type":{"description":"The type of the track frame was captured from (TRACK_TYPE_VIDEO|TRACK_TYPE_SCREEN_SHARE)","title":"TrackType","type":"string","x-stream-index":"004"},"type":{"default":"call.frame_recording_ready","description":"The type of event: \"call.frame_recording_ready\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"url":{"description":"The URL of the frame","title":"URL","type":"string","x-stream-index":"005"},"users":{"additionalProperties":{"$ref":"#/components/schemas/UserResponse"},"description":"The users in the frame","title":"Users","type":"object","x-stream-index":"007"}},"required":["type","created_at","call_cid","session_id","track_type","url","captured_at","users","egress_id"],"title":"CallFrameRecordingFrameReadyEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallFrameRecordingStartedEvent":{"description":"This event is sent when frame recording has started","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.frame_recording_started","description":"The type of event: \"call.frame_recording_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","egress_id"],"title":"CallFrameRecordingStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallFrameRecordingStoppedEvent":{"description":"This event is sent when frame recording has stopped","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.frame_recording_stopped","description":"The type of event: \"call.frame_recording_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","egress_id"],"title":"CallFrameRecordingStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallHLSBroadcastingFailedEvent":{"description":"This event is sent when HLS broadcasting has failed","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"call.hls_broadcasting_failed","description":"The type of event: \"call.hls_broadcasting_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallHLSBroadcastingFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallHLSBroadcastingStartedEvent":{"description":"This event is sent when HLS broadcasting has started","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"hls_playlist_url":{"type":"string","x-stream-index":"004"},"type":{"default":"call.hls_broadcasting_started","description":"The type of event: \"call.hls_broadcasting_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","hls_playlist_url"],"title":"CallHLSBroadcastingStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallHLSBroadcastingStoppedEvent":{"description":"This event is sent when HLS broadcasting has stopped","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"call.hls_broadcasting_stopped","description":"The type of event: \"call.hls_broadcasting_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallHLSBroadcastingStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallIngressResponse":{"description":"CallIngressResponse is the payload for ingress settings","properties":{"rtmp":{"$ref":"#/components/schemas/RTMPIngress","title":"RTMP","x-stream-index":"001"}},"required":["rtmp"],"title":"CallIngressResponse","type":"object"},"CallLiveStartedEvent":{"description":"This event is sent when a call is started. Clients receiving this event should start the call.","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"call.live_started","description":"The type of event: \"call.live_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call"],"title":"CallLiveStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMemberAddedEvent":{"description":"This event is sent when one or more members are added to a call","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"members":{"description":"the members added to this call","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"004"},"type":{"default":"call.member_added","description":"The type of event: \"call.member_added\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","members"],"title":"CallMemberAddedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMemberRemovedEvent":{"description":"This event is sent when one or more members are removed from a call","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"members":{"description":"the list of member IDs removed from the call","items":{"type":"string"},"title":"Members","type":"array","x-stream-index":"004"},"type":{"default":"call.member_removed","description":"The type of event: \"call.member_removed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","members"],"title":"CallMemberRemovedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMemberUpdatedEvent":{"description":"This event is sent when one or more members are updated","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"members":{"description":"The list of members that were updated","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"004"},"type":{"default":"call.member_updated","description":"The type of event: \"call.member_updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","members"],"title":"CallMemberUpdatedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMemberUpdatedPermissionEvent":{"description":"This event is sent when one or more members get its role updated","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"capabilities_by_role":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"The capabilities by role for this call","title":"CapabilitiesByRole","type":"object","x-stream-index":"004"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"members":{"description":"The list of members that were updated","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"005"},"type":{"default":"call.member_updated_permission","description":"The type of event: \"call.member_added\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","capabilities_by_role","members"],"title":"CallMemberUpdatedPermissionEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMissedEvent":{"description":"This event is sent to call members who did not accept/reject/join the call to notify they missed the call","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"members":{"description":"List of members who missed the call","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"005"},"notify_user":{"type":"boolean","x-stream-index":"007"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.missed","description":"The type of event: \"call.notification\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The caller from whom the call was missed","title":"User","x-stream-index":"006"}},"required":["type","created_at","call_cid","session_id","call","members","user","notify_user"],"title":"CallMissedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallModerationBlurEvent":{"properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"type":{"default":"call.moderation_blur","type":"string","x-stream-index":"001.001"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["type","created_at","call_cid","user_id","custom"],"title":"CallModerationBlurEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallModerationWarningEvent":{"properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"message":{"type":"string","x-stream-index":"004"},"type":{"default":"call.moderation_warning","type":"string","x-stream-index":"001.001"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["type","created_at","call_cid","user_id","message","custom"],"title":"CallModerationWarningEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallNotificationEvent":{"description":"This event is sent to all call members to notify they are getting called","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"members":{"description":"Call members","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"005"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.notification","description":"The type of event: \"call.notification\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user that sent the call notification","title":"User","x-stream-index":"006"}},"required":["type","created_at","call_cid","session_id","call","members","user"],"title":"CallNotificationEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallParticipantCountReport":{"properties":{"histogram":{"items":{"$ref":"#/components/schemas/ReportByHistogramBucket"},"type":"array","x-stream-index":"001"}},"required":["histogram"],"type":"object"},"CallParticipantCountReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateCallParticipantCountReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"CallParticipantResponse":{"properties":{"joined_at":{"format":"date-time","type":"string","x-stream-index":"004"},"role":{"type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"},"user_session_id":{"type":"string","x-stream-index":"002"}},"required":["user","user_session_id","role","joined_at"],"type":"object"},"CallReactionEvent":{"description":"This event is sent when a reaction is sent in a call, clients should use this to show the reaction in the call screen","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"reaction":{"$ref":"#/components/schemas/ReactionResponse","description":"the reaction object sent by the user on the call","title":"reaction","x-stream-index":"003"},"type":{"default":"call.reaction_new","description":"The type of event: \"call.reaction_new\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","reaction"],"title":"CallReactionEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRecording":{"description":"CallRecording represents a recording of a call.","properties":{"end_time":{"format":"date-time","title":"The end time of the recording.","type":"string","x-stream-index":"004"},"filename":{"title":"The filename of the recording.","type":"string","x-stream-index":"001"},"session_id":{"title":"The session ID of the recording.","type":"string","x-stream-index":"005"},"start_time":{"format":"date-time","title":"The start time of the recording.","type":"string","x-stream-index":"003"},"url":{"title":"The URL of the recording.","type":"string","x-stream-index":"002"}},"required":["filename","url","start_time","end_time","session_id"],"title":"CallRecording","type":"object"},"CallRecordingFailedEvent":{"description":"This event is sent when call recording has failed","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"003"},"type":{"default":"call.recording_failed","description":"The type of event: \"call.recording_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","egress_id"],"title":"CallRecordingFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRecordingReadyEvent":{"description":"This event is sent when call recording is ready","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"call_recording":{"$ref":"#/components/schemas/CallRecording","description":"The call recording object","title":"CallRecording","x-stream-index":"003"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.recording_ready","description":"The type of event: \"call.recording_ready\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call_recording","egress_id"],"title":"CallRecordingReadyEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRecordingStartedEvent":{"description":"This event is sent when call recording has started","properties":{"call_cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"002.002"},"egress_id":{"type":"string","x-stream-index":"001"},"type":{"default":"call.recording_started","description":"The type of event: \"call.recording_started\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001"}},"required":["egress_id","type","created_at","call_cid"],"title":"CallRecordingStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRecordingStoppedEvent":{"description":"This event is sent when call recording has stopped","properties":{"call_cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"002.002"},"egress_id":{"type":"string","x-stream-index":"001"},"type":{"default":"call.recording_stopped","description":"The type of event: \"call.recording_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001"}},"required":["egress_id","type","created_at","call_cid"],"title":"CallRecordingStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRejectedEvent":{"description":"This event is sent when a user rejects a notification to join a call.","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"reason":{"description":"Provides information about why the call was rejected. You can provide any value, but the Stream API and SDKs use these default values: rejected, cancel, timeout and busy","title":"Reason","type":"string","x-stream-index":"005"},"type":{"default":"call.rejected","description":"The type of event: \"call.rejected\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who rejected the call","title":"User","x-stream-index":"004"}},"required":["type","created_at","call_cid","call","user"],"title":"CallRejectedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallReportResponse":{"properties":{"ended_at":{"format":"date-time","type":"string","x-stream-index":"003"},"score":{"format":"float","type":"number","x-stream-index":"001"},"started_at":{"format":"date-time","type":"string","x-stream-index":"002"}},"required":["score"],"type":"object"},"CallRequest":{"description":"CallRequest is the payload for creating a call.","properties":{"channel_cid":{"type":"string","x-stream-index":"009"},"created_by":{"$ref":"#/components/schemas/UserRequest","title":"The user that create this call","x-stream-index":"002"},"created_by_id":{"title":"The id of the user that create this call","type":"string","x-stream-index":"003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"members":{"items":{"$ref":"#/components/schemas/MemberRequest"},"maximum":100,"type":"array","x-stream-index":"005"},"settings_override":{"$ref":"#/components/schemas/CallSettingsRequest","x-stream-index":"006"},"starts_at":{"format":"date-time","type":"string","x-stream-index":"007"},"team":{"type":"string","x-stream-index":"001"},"video":{"type":"boolean","x-stream-index":"008"}},"title":"CallRequest","type":"object"},"CallResponse":{"description":"Represents a call","properties":{"backstage":{"type":"boolean","x-stream-index":"016"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"018"},"captioning":{"type":"boolean","x-stream-index":"013"},"channel_cid":{"type":"string","x-stream-index":"024"},"cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"009"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"The user that created the call","title":"Created By","x-stream-index":"007"},"current_session_id":{"type":"string","x-stream-index":"005"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"008"},"egress":{"$ref":"#/components/schemas/EgressResponse","x-stream-index":"021"},"ended_at":{"description":"Date/time when the call ended","format":"date-time","title":"Ended At","type":"string","x-stream-index":"014"},"id":{"description":"Call ID","title":"ID","type":"string","x-stream-index":"003"},"ingress":{"$ref":"#/components/schemas/CallIngressResponse","x-stream-index":"019"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"023"},"recording":{"type":"boolean","x-stream-index":"011"},"session":{"$ref":"#/components/schemas/CallSessionResponse","x-stream-index":"020"},"settings":{"$ref":"#/components/schemas/CallSettingsResponse","x-stream-index":"017"},"starts_at":{"description":"Date/time when the call will start","format":"date-time","title":"Starts At","type":"string","x-stream-index":"015"},"team":{"type":"string","x-stream-index":"006"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailResponse","x-stream-index":"022"},"transcribing":{"type":"boolean","x-stream-index":"012"},"type":{"description":"The type of call","title":"Type","type":"string","x-stream-index":"002"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"010"}},"required":["type","id","cid","current_session_id","created_by","custom","created_at","updated_at","recording","transcribing","captioning","backstage","settings","blocked_user_ids","ingress","egress"],"title":"CallResponse","type":"object"},"CallRingEvent":{"description":"This event is sent to all call members to notify they are getting called","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"005"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"members":{"description":"Call members","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"006"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.ring","description":"The type of event: \"call.notification\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user that sent the call notification","title":"User","x-stream-index":"007"},"video":{"type":"boolean","x-stream-index":"008"}},"required":["type","created_at","call_cid","session_id","call","members","user","video"],"title":"CallRingEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRtmpBroadcastFailedEvent":{"description":"This event is sent when a call RTMP broadcast has failed","properties":{"call_cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"002.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.002"},"name":{"description":"Name of the given RTMP broadcast","title":"Name","type":"string","x-stream-index":"003"},"type":{"default":"call.rtmp_broadcast_failed","description":"The type of event: \"call.rtmp_broadcast_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","name"],"title":"CallRtmpBroadcastFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRtmpBroadcastStartedEvent":{"description":"This event is sent when RTMP broadcast has started","properties":{"call_cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"002.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.002"},"name":{"description":"Name of the given RTMP broadcast","title":"Name","type":"string","x-stream-index":"003"},"type":{"default":"call.rtmp_broadcast_started","description":"The type of event: \"call.rtmp_broadcast_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","name"],"title":"CallRtmpBroadcastStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRtmpBroadcastStoppedEvent":{"description":"This event is sent when RTMP broadcast has stopped","properties":{"call_cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"002.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.002"},"name":{"description":"Name of the given RTMP broadcast","title":"Name","type":"string","x-stream-index":"003"},"type":{"default":"call.rtmp_broadcast_stopped","description":"The type of event: \"call.rtmp_broadcast_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","name"],"title":"CallRtmpBroadcastStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSessionEndedEvent":{"description":"This event is sent when a call session ends","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_ended","description":"The type of event: \"call.session_ended\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","call"],"title":"CallSessionEndedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSessionParticipantCountsUpdatedEvent":{"description":"This event is sent when the participant counts in a call session are updated","properties":{"anonymous_participant_count":{"format":"int32","type":"integer","x-stream-index":"005"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"participants_count_by_role":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"004"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_participant_count_updated","description":"The type of event: \"call.session_participant_count_updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","participants_count_by_role","anonymous_participant_count"],"title":"CallSessionParticipantCountsUpdatedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSessionParticipantJoinedEvent":{"description":"This event is sent when a participant joins a call session","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"participant":{"$ref":"#/components/schemas/CallParticipantResponse","description":"The participant that joined the session","title":"Participant","x-stream-index":"004"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_participant_joined","description":"The type of event: \"call.session_participant_joined\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","participant"],"title":"CallSessionParticipantJoinedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSessionParticipantLeftEvent":{"description":"This event is sent when a participant leaves a call session","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"duration_seconds":{"description":"The duration participant was in the session in seconds","format":"int32","title":"Duration","type":"integer","x-stream-index":"005"},"participant":{"$ref":"#/components/schemas/CallParticipantResponse","description":"The participant that left the session","title":"Participant","x-stream-index":"004"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_participant_left","description":"The type of event: \"call.session_participant_left\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","participant","duration_seconds"],"title":"CallSessionParticipantLeftEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSessionResponse":{"properties":{"accepted_by":{"additionalProperties":{"format":"date-time","type":"string"},"type":"object","x-stream-index":"008"},"anonymous_participant_count":{"format":"int32","type":"integer","x-stream-index":"006"},"ended_at":{"format":"date-time","type":"string","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"live_ended_at":{"format":"date-time","type":"string","x-stream-index":"011"},"live_started_at":{"format":"date-time","type":"string","x-stream-index":"010"},"missed_by":{"additionalProperties":{"format":"date-time","type":"string"},"type":"object","x-stream-index":"009"},"participants":{"items":{"$ref":"#/components/schemas/CallParticipantResponse"},"type":"array","x-stream-index":"004"},"participants_count_by_role":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"005"},"rejected_by":{"additionalProperties":{"format":"date-time","type":"string"},"type":"object","x-stream-index":"007"},"started_at":{"format":"date-time","type":"string","x-stream-index":"002"},"timer_ends_at":{"format":"date-time","type":"string","x-stream-index":"012"}},"required":["id","participants","participants_count_by_role","anonymous_participant_count","rejected_by","accepted_by","missed_by"],"type":"object"},"CallSessionStartedEvent":{"description":"This event is sent when a call session starts","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_started","description":"The type of event: \"call.session_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","call"],"title":"CallSessionStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSettingsRequest":{"properties":{"audio":{"$ref":"#/components/schemas/AudioSettingsRequest","x-stream-index":"001"},"backstage":{"$ref":"#/components/schemas/BackstageSettingsRequest","x-stream-index":"002"},"broadcasting":{"$ref":"#/components/schemas/BroadcastSettingsRequest","x-stream-index":"010"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordingSettingsRequest","x-stream-index":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettingsRequest","x-stream-index":"003"},"ingress":{"$ref":"#/components/schemas/IngressSettingsRequest","x-stream-index":"014"},"limits":{"$ref":"#/components/schemas/LimitsSettingsRequest","x-stream-index":"012"},"recording":{"$ref":"#/components/schemas/RecordSettingsRequest","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettingsRequest","x-stream-index":"007"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettingsRequest","x-stream-index":"008"},"session":{"$ref":"#/components/schemas/SessionSettingsRequest","x-stream-index":"013"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettingsRequest","x-stream-index":"011"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettingsRequest","x-stream-index":"009"},"video":{"$ref":"#/components/schemas/VideoSettingsRequest","x-stream-index":"004"}},"type":"object"},"CallSettingsResponse":{"properties":{"audio":{"$ref":"#/components/schemas/AudioSettingsResponse","x-stream-index":"001"},"backstage":{"$ref":"#/components/schemas/BackstageSettingsResponse","x-stream-index":"002"},"broadcasting":{"$ref":"#/components/schemas/BroadcastSettingsResponse","x-stream-index":"003"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordingSettingsResponse","x-stream-index":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettingsResponse","x-stream-index":"004"},"ingress":{"$ref":"#/components/schemas/IngressSettingsResponse","x-stream-index":"014"},"limits":{"$ref":"#/components/schemas/LimitsSettingsResponse","x-stream-index":"012"},"recording":{"$ref":"#/components/schemas/RecordSettingsResponse","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettingsResponse","x-stream-index":"007"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettingsResponse","x-stream-index":"008"},"session":{"$ref":"#/components/schemas/SessionSettingsResponse","x-stream-index":"013"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettingsResponse","x-stream-index":"011"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettingsResponse","x-stream-index":"009"},"video":{"$ref":"#/components/schemas/VideoSettingsResponse","x-stream-index":"010"}},"required":["audio","backstage","broadcasting","geofencing","recording","frame_recording","ring","screensharing","transcription","video","thumbnails","limits","session"],"type":"object"},"CallStateResponseFields":{"description":"CallStateResponseFields is the payload for call state response","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001"},"members":{"description":"List of call members","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"002"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"004"}},"required":["call","members","own_capabilities","blocked_users"],"title":"CallStateResponseFields","type":"object"},"CallStatsReportReadyEvent":{"description":"This event is sent when the insights report is ready","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.stats_report_ready","description":"The type of event, \"call.report_ready\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id"],"title":"CallStatsReportReadyEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallStatsReportSummaryResponse":{"properties":{"call_cid":{"type":"string","x-stream-index":"001"},"call_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"008"},"call_session_id":{"type":"string","x-stream-index":"002"},"call_status":{"type":"string","x-stream-index":"004"},"created_at":{"format":"date-time","type":"string","x-stream-index":"007"},"first_stats_time":{"format":"date-time","type":"string","x-stream-index":"003"},"min_user_rating":{"format":"int32","type":"integer","x-stream-index":"006"},"quality_score":{"format":"int32","type":"integer","x-stream-index":"005"}},"required":["call_cid","call_session_id","first_stats_time","call_status","call_duration_seconds"],"type":"object"},"CallTranscription":{"description":"CallTranscription represents a transcription of a call.","properties":{"end_time":{"format":"date-time","title":"The end time of the transcription.","type":"string","x-stream-index":"004"},"filename":{"title":"The filename of the transcription.","type":"string","x-stream-index":"001"},"session_id":{"title":"The session ID of the transcription.","type":"string","x-stream-index":"005"},"start_time":{"format":"date-time","title":"The start time of the transcription.","type":"string","x-stream-index":"003"},"url":{"title":"The URL of the transcription.","type":"string","x-stream-index":"002"}},"required":["filename","url","start_time","end_time","session_id"],"title":"CallTranscription","type":"object"},"CallTranscriptionFailedEvent":{"description":"This event is sent when call transcription has failed","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"003"},"error":{"description":"The error message detailing why transcription failed.","title":"string","type":"string","x-stream-index":"004"},"type":{"default":"call.transcription_failed","description":"The type of event: \"call.transcription_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","egress_id"],"title":"CallTranscriptionFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallTranscriptionReadyEvent":{"description":"This event is sent when call transcription is ready","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"call_transcription":{"$ref":"#/components/schemas/CallTranscription","description":"The call transcription object","title":"CallTranscription","x-stream-index":"003"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.transcription_ready","description":"The type of event: \"call.transcription_ready\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call_transcription","egress_id"],"title":"CallTranscriptionReadyEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallTranscriptionStartedEvent":{"description":"This event is sent when call transcription has started","properties":{"call_cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"002.002"},"egress_id":{"type":"string","x-stream-index":"001"},"type":{"default":"call.transcription_started","description":"The type of event: \"call.transcription_started\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001"}},"required":["egress_id","type","created_at","call_cid"],"title":"CallTranscriptionStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallTranscriptionStoppedEvent":{"description":"This event is sent when call transcription has stopped","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"003"},"type":{"default":"call.transcription_stopped","description":"The type of event: \"call.transcription_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","egress_id"],"title":"CallTranscriptionStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallTypeResponse":{"description":"CallTypeResponse is the payload for a call type.","properties":{"created_at":{"description":"the time the call type was created","format":"date-time","title":"CreatedAt","type":"string","x-stream-index":"005"},"external_storage":{"description":"the external storage for the call type","title":"ExternalStorage","type":"string","x-stream-index":"007"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"the permissions granted to each role","title":"Grants","type":"object","x-stream-index":"002"},"name":{"description":"the name of the call type","title":"Name","type":"string","x-stream-index":"001"},"notification_settings":{"$ref":"#/components/schemas/NotificationSettings","description":"the notification settings for the call type","title":"NotificationSettings","x-stream-index":"004"},"settings":{"$ref":"#/components/schemas/CallSettingsResponse","description":"the settings for the call type","title":"Settings","x-stream-index":"003"},"updated_at":{"description":"the time the call type was last updated","format":"date-time","title":"UpdatedAt","type":"string","x-stream-index":"006"}},"required":["name","grants","settings","notification_settings","created_at","updated_at"],"title":"CallTypeResponse","type":"object"},"CallUpdatedEvent":{"description":"This event is sent when a call is updated, clients should use this update the local state of the call.\nThis event also contains the capabilities by role for the call, clients should update the own_capability for the current.","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"capabilities_by_role":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"The capabilities by role for this call","title":"CapabilitiesByRole","type":"object","x-stream-index":"004"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"call.updated","description":"The type of event: \"call.ended\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","capabilities_by_role"],"title":"CallUpdatedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallUserFeedbackSubmittedEvent":{"description":"This event is sent when a user submits feedback for a call.","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"custom":{"additionalProperties":{},"description":"Custom data provided by the user","title":"Custom","type":"object","x-stream-index":"007"},"rating":{"description":"The rating given by the user (1-5)","format":"int32","title":"Rating","type":"integer","x-stream-index":"005"},"reason":{"description":"The reason provided by the user for the rating","title":"Reason","type":"string","x-stream-index":"006"},"sdk":{"type":"string","x-stream-index":"008"},"sdk_version":{"type":"string","x-stream-index":"009"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.user_feedback_submitted","description":"The type of event, \"call.user_feedback\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who submitted the feedback","title":"User","x-stream-index":"004"}},"required":["type","created_at","call_cid","session_id","user","rating"],"title":"CallUserFeedbackSubmittedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallUserMutedEvent":{"description":"This event is sent when a call member is muted","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"from_user_id":{"type":"string","x-stream-index":"003"},"muted_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"type":{"default":"call.user_muted","description":"The type of event: \"call.user_muted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","from_user_id","muted_user_ids"],"title":"CallUserMutedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallsPerDayReport":{"properties":{"count":{"format":"int64","type":"integer","x-stream-index":"001"}},"required":["count"],"type":"object"},"CallsPerDayReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateCallsPerDayReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"ChatActivityStatsResponse":{"properties":{"Messages":{"$ref":"#/components/schemas/MessageStatsResponse","x-stream-index":"001"}},"type":"object"},"CheckExternalStorageResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"file_url":{"type":"string","x-stream-index":"002"}},"required":["duration","file_url"],"title":"Response","type":"object"},"ClientOSDataResponse":{"properties":{"architecture":{"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"version":{"type":"string","x-stream-index":"002"}},"type":"object"},"ClosedCaptionEvent":{"description":"This event is sent when closed captions are being sent in a call, clients should use this to show the closed captions in the call screen","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"closed_caption":{"$ref":"#/components/schemas/CallClosedCaption","description":"The closed caption object","title":"CallClosedCaption","x-stream-index":"003"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"call.closed_caption","description":"The type of event: \"call.closed_caption\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","closed_caption"],"title":"ClosedCaptionEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CollectUserFeedbackRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"009"},"rating":{"format":"int32","maximum":5,"minimum":1,"type":"integer","x-stream-index":"007"},"reason":{"maxLength":1000,"type":"string","x-stream-index":"008"},"sdk":{"maxLength":50,"type":"string","x-stream-index":"005"},"sdk_version":{"maxLength":50,"type":"string","x-stream-index":"006"},"user_session_id":{"maxLength":50,"type":"string","x-stream-index":"004"}},"required":["sdk","sdk_version","rating"],"type":"object"},"CollectUserFeedbackResponse":{"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"},"CountByMinuteResponse":{"nullable":true,"properties":{"count":{"format":"int32","type":"integer","x-stream-index":"002"},"start_ts":{"format":"date-time","type":"string","x-stream-index":"001"}},"required":["start_ts","count"],"type":"object"},"CreateCallTypeRequest":{"description":"Request for creating a call type","nullable":true,"properties":{"external_storage":{"description":"the external storage for the call type","title":"ExternalStorage","type":"string","x-stream-index":"002.004"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"the permissions granted to each role","title":"Grants","type":"object","x-stream-index":"002.001"},"name":{"type":"string","x-stream-index":"001"},"notification_settings":{"$ref":"#/components/schemas/NotificationSettings","description":"the notification settings for the call type","title":"NotificationSettings","x-stream-index":"002.002"},"settings":{"$ref":"#/components/schemas/CallSettingsRequest","description":"the settings for the call type","title":"Settings","x-stream-index":"002.003"}},"required":["name"],"title":"CreateCallTypeRequest","type":"object"},"CreateCallTypeResponse":{"description":"Response for creating a call type","nullable":true,"properties":{"created_at":{"description":"the time the call type was created","format":"date-time","title":"CreatedAt","type":"string","x-stream-index":"001.005"},"duration":{"type":"string","x-stream-index":"002.001"},"external_storage":{"description":"the external storage for the call type","title":"ExternalStorage","type":"string","x-stream-index":"001.007"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"the permissions granted to each role","title":"Grants","type":"object","x-stream-index":"001.002"},"name":{"description":"the name of the call type","title":"Name","type":"string","x-stream-index":"001.001"},"notification_settings":{"$ref":"#/components/schemas/NotificationSettings","description":"the notification settings for the call type","title":"NotificationSettings","x-stream-index":"001.004"},"settings":{"$ref":"#/components/schemas/CallSettingsResponse","description":"the settings for the call type","title":"Settings","x-stream-index":"001.003"},"updated_at":{"description":"the time the call type was last updated","format":"date-time","title":"UpdatedAt","type":"string","x-stream-index":"001.006"}},"required":["name","grants","settings","notification_settings","created_at","updated_at","duration"],"title":"CreateCallTypeResponse","type":"object"},"CreateDeviceRequest":{"description":"Create device request","nullable":true,"properties":{"id":{"description":"Device ID","maxLength":255,"minLength":1,"title":"ID","type":"string","x-stream-index":"001"},"push_provider":{"description":"Push provider","enum":["firebase","apn","huawei","xiaomi"],"title":"PushProvider","type":"string","x-stream-index":"002"},"push_provider_name":{"description":"Push provider name","title":"PushProviderName","type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"005.002"},"user_id":{"description":"**Server-side only**. User ID which server acts upon","title":"User ID","type":"string","x-stream-index":"005.001"},"voip_token":{"description":"When true the token is for Apple VoIP push notifications","title":"VoipToken","type":"boolean","x-stream-index":"004"}},"required":["id","push_provider"],"title":"CreateDeviceRequest","type":"object"},"CreateExternalStorageRequest":{"description":"Create external storage","nullable":true,"properties":{"aws_s3":{"$ref":"#/components/schemas/S3Request","description":"Only required if you want to create an Amazon S3 storage","title":"AwsS3","x-stream-index":"003.004"},"azure_blob":{"$ref":"#/components/schemas/AzureRequest","description":"Only required if you want to create an Azure Blob Storage","title":"AzureBlob","x-stream-index":"003.006"},"bucket":{"description":"The name of the bucket on the service provider","title":"Bucket","type":"string","x-stream-index":"003.002"},"gcs_credentials":{"type":"string","x-stream-index":"003.005"},"name":{"description":"The name of the provider, this must be unique","title":"Name","type":"string","x-stream-index":"001"},"path":{"description":"The path prefix to use for storing files","title":"Path","type":"string","x-stream-index":"003.003"},"storage_type":{"description":"The type of storage to use","enum":["s3","gcs","abs"],"title":"StorageType","type":"string","x-stream-index":"003.001"}},"required":["name","storage_type","bucket"],"title":"CreateExternalStorageRequest","type":"object"},"CreateExternalStorageResponse":{"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"},"CreateGuestRequest":{"nullable":true,"properties":{"user":{"$ref":"#/components/schemas/UserRequest","description":"User object which server acts upon","title":"User","x-stream-index":"001"}},"required":["user"],"type":"object"},"CreateGuestResponse":{"nullable":true,"properties":{"access_token":{"description":"the access token to authenticate the user","title":"Access token","type":"string","x-stream-index":"002"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User object which server acts upon","title":"User","x-stream-index":"001"}},"required":["user","access_token","duration"],"type":"object"},"CustomVideoEvent":{"description":"A custom event, this event is used to send custom events to other participants in the call.","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"003"},"type":{"default":"custom","description":"The type of event, \"custom\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"004"}},"required":["type","created_at","call_cid","custom","user"],"title":"CustomVideoEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"DailyAggregateCallDurationReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/CallDurationReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateCallParticipantCountReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/CallParticipantCountReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateCallsPerDayReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/CallsPerDayReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateQualityScoreReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/QualityScoreReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateSDKUsageReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/SDKUsageReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateUserFeedbackReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/UserFeedbackReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DeleteCallRequest":{"description":"DeleteCallRequest is the payload for deleting a call.","nullable":true,"properties":{"hard":{"description":"if true the call will be hard deleted along with all related data","title":"Hard","type":"boolean","x-stream-index":"001"}},"title":"DeleteCallRequest","type":"object"},"DeleteCallResponse":{"description":"DeleteCallResponse is the payload for deleting a call.","nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","title":"Call","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"task_id":{"title":"TaskID","type":"string","x-stream-index":"002"}},"required":["call","duration"],"title":"DeleteCallResponse","type":"object"},"DeleteExternalStorageResponse":{"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"},"DeleteRecordingResponse":{"description":"Response for DeleteRecording","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"DeleteRecordingResponse","type":"object"},"DeleteTranscriptionResponse":{"description":"DeleteTranscriptionResponse is the payload for deleting a transcription.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"DeleteTranscriptionResponse","type":"object"},"DeviceDataResponse":{"properties":{"name":{"type":"string","x-stream-index":"001"},"version":{"type":"string","x-stream-index":"002"}},"type":"object"},"DeviceResponse":{"description":"Response for Device","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"004"},"disabled":{"description":"Whether device is disabled or not","title":"Disabled","type":"boolean","x-stream-index":"005"},"disabled_reason":{"description":"Reason explaining why device had been disabled","title":"Reason","type":"string","x-stream-index":"006"},"id":{"description":"Device ID","title":"ID","type":"string","x-stream-index":"003"},"push_provider":{"description":"Push provider","title":"PushProvider","type":"string","x-stream-index":"001"},"push_provider_name":{"description":"Push provider name","title":"PushProviderName","type":"string","x-stream-index":"002"},"user_id":{"description":"User ID","title":"UserID","type":"string","x-stream-index":"008"},"voip":{"description":"When true the token is for Apple VoIP push notifications","title":"Voip","type":"boolean","x-stream-index":"007"}},"required":["push_provider","id","created_at","user_id"],"title":"DeviceResponse","type":"object"},"EdgeResponse":{"properties":{"continent_code":{"type":"string","x-stream-index":"007.003"},"country_iso_code":{"type":"string","x-stream-index":"007.002"},"green":{"format":"int32","type":"integer","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"latency_test_url":{"type":"string","x-stream-index":"002"},"latitude":{"format":"float","type":"number","x-stream-index":"006.001"},"longitude":{"format":"float","type":"number","x-stream-index":"006.002"},"red":{"format":"int32","type":"integer","x-stream-index":"005"},"subdivision_iso_code":{"type":"string","x-stream-index":"007.001"},"yellow":{"format":"int32","type":"integer","x-stream-index":"004"}},"required":["id","latency_test_url","green","yellow","red","latitude","longitude","subdivision_iso_code","country_iso_code","continent_code"],"type":"object"},"EgressHLSResponse":{"properties":{"playlist_url":{"type":"string","x-stream-index":"001"},"status":{"type":"string","x-stream-index":"002"}},"required":["playlist_url","status"],"type":"object"},"EgressRTMPResponse":{"properties":{"name":{"type":"string","x-stream-index":"001"},"started_at":{"format":"date-time","type":"string","x-stream-index":"004"},"stream_key":{"type":"string","x-stream-index":"003"},"stream_url":{"type":"string","x-stream-index":"002"}},"required":["name","started_at"],"type":"object"},"EgressResponse":{"properties":{"broadcasting":{"type":"boolean","x-stream-index":"001"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordingResponse","x-stream-index":"004"},"hls":{"$ref":"#/components/schemas/EgressHLSResponse","x-stream-index":"002"},"rtmps":{"items":{"$ref":"#/components/schemas/EgressRTMPResponse"},"type":"array","x-stream-index":"003"}},"required":["broadcasting","rtmps"],"type":"object"},"EndCallRequest":{"description":"Request for ending a call","nullable":true,"title":"EndCallRequest","type":"object"},"EndCallResponse":{"description":"Response for ending a call","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"EndCallResponse","type":"object"},"EventNotificationSettings":{"properties":{"apns":{"$ref":"#/components/schemas/APNS","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"fcm":{"$ref":"#/components/schemas/FCM","x-stream-index":"003"}},"type":"object"},"ExternalStorageResponse":{"properties":{"bucket":{"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"path":{"type":"string","x-stream-index":"004"},"type":{"enum":["s3","gcs","abs"],"type":"string","x-stream-index":"002"}},"required":["name","type","bucket","path"],"type":"object"},"FCM":{"properties":{"data":{"additionalProperties":{},"type":"object","x-stream-index":"001"}},"type":"object"},"FrameRecordingResponse":{"properties":{"status":{"type":"string","x-stream-index":"001"}},"required":["status"],"type":"object"},"FrameRecordingSettingsRequest":{"properties":{"capture_interval_in_seconds":{"format":"int32","maximum":60,"minimum":2,"type":"integer","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"},"quality":{"enum":["360p","480p","720p","1080p","1440p"],"type":"string","x-stream-index":"002"}},"required":["mode","capture_interval_in_seconds"],"type":"object"},"FrameRecordingSettingsResponse":{"properties":{"capture_interval_in_seconds":{"format":"int32","maximum":60,"minimum":2,"type":"integer","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"},"quality":{"type":"string","x-stream-index":"002"}},"required":["mode","capture_interval_in_seconds"],"type":"object"},"GeofenceSettingsRequest":{"properties":{"names":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"type":"object"},"GeofenceSettingsResponse":{"properties":{"names":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"required":["names"],"type":"object"},"GetActiveCallsStatusResponse":{"description":"Response containing active calls status information","nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"},"end_time":{"description":"End time of the status period","format":"date-time","title":"time.Time","type":"string","x-stream-index":"003"},"metrics":{"$ref":"#/components/schemas/ActiveCallsMetrics","description":"Detailed metrics","title":"*ActiveCallsMetrics","x-stream-index":"005"},"start_time":{"description":"Start time of the status period","format":"date-time","title":"time.Time","type":"string","x-stream-index":"002"},"summary":{"$ref":"#/components/schemas/ActiveCallsSummary","description":"Summary of active calls","title":"*ActiveCallsSummary","x-stream-index":"004"}},"required":["duration","start_time","end_time"],"title":"GetActiveCallsStatusResponse","type":"object"},"GetCallReportResponse":{"description":"Basic response information","nullable":true,"properties":{"chat_activity":{"$ref":"#/components/schemas/ChatActivityStatsResponse","x-stream-index":"004"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"report":{"$ref":"#/components/schemas/ReportResponse","x-stream-index":"003"},"session_id":{"type":"string","x-stream-index":"002"},"video_reactions":{"items":{"$ref":"#/components/schemas/VideoReactionsResponse"},"type":"array","x-stream-index":"005"}},"required":["duration","session_id","report"],"title":"Response","type":"object"},"GetCallResponse":{"nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001.001"},"duration":{"type":"string","x-stream-index":"002.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001.002"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"001.004"}},"required":["call","members","own_capabilities","blocked_users","duration"],"title":"GetCallResponse","type":"object"},"GetCallTypeResponse":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"001.005"},"duration":{"type":"string","x-stream-index":"002.001"},"external_storage":{"type":"string","x-stream-index":"001.007"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"001.002"},"name":{"type":"string","x-stream-index":"001.001"},"notification_settings":{"$ref":"#/components/schemas/NotificationSettings","x-stream-index":"001.004"},"settings":{"$ref":"#/components/schemas/CallSettingsResponse","x-stream-index":"001.003"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"001.006"}},"required":["name","grants","settings","notification_settings","created_at","updated_at","duration"],"title":"GetCallTypeResponse","type":"object"},"GetEdgesResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"edges":{"items":{"$ref":"#/components/schemas/EdgeResponse"},"type":"array","x-stream-index":"001"}},"required":["edges","duration"],"title":"Response","type":"object"},"GetOrCreateCallRequest":{"nullable":true,"properties":{"data":{"$ref":"#/components/schemas/CallRequest","title":"ReadOnlyData","x-stream-index":"003"},"members_limit":{"format":"int32","maximum":100,"type":"integer","x-stream-index":"007"},"notify":{"description":"if provided it sends a notification event to the members for this call","title":"Notify","type":"boolean","x-stream-index":"005"},"ring":{"description":"if provided it sends a ring event to the members for this call","title":"Ring","type":"boolean","x-stream-index":"004"},"video":{"type":"boolean","x-stream-index":"006"}},"title":"GetOrCreateCallRequest","type":"object"},"GetOrCreateCallResponse":{"nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001.001"},"created":{"type":"boolean","x-stream-index":"002"},"duration":{"type":"string","x-stream-index":"003.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001.002"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"001.004"}},"required":["call","members","own_capabilities","blocked_users","created","duration"],"title":"GetOrCreateCallResponse","type":"object"},"GoLiveRequest":{"nullable":true,"properties":{"recording_storage_name":{"type":"string","x-stream-index":"005"},"start_closed_caption":{"type":"boolean","x-stream-index":"008"},"start_hls":{"type":"boolean","x-stream-index":"003"},"start_recording":{"type":"boolean","x-stream-index":"004"},"start_transcription":{"type":"boolean","x-stream-index":"007"},"transcription_storage_name":{"type":"string","x-stream-index":"006"}},"title":"GoLiveRequest","type":"object"},"GoLiveResponse":{"description":"Basic response information","nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["call","duration"],"title":"Response","type":"object"},"GroupedStatsResponse":{"nullable":true,"properties":{"name":{"type":"string","x-stream-index":"001"},"unique":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["name","unique"],"type":"object"},"HLSSettingsRequest":{"properties":{"auto_on":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"layout":{"$ref":"#/components/schemas/LayoutSettingsRequest","title":"LayoutSettings","x-stream-index":"004"},"quality_tracks":{"items":{"type":"string"},"maximum":3,"minimum":1,"type":"array","x-stream-index":"003"}},"required":["quality_tracks"],"title":"HLSSettingsRequest","type":"object"},"HLSSettingsResponse":{"description":"HLSSettings is the payload for HLS settings","properties":{"auto_on":{"title":"Auto On","type":"boolean","x-stream-index":"001"},"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"002"},"layout":{"$ref":"#/components/schemas/LayoutSettingsResponse","title":"Layout","x-stream-index":"004"},"quality_tracks":{"items":{"type":"string"},"title":"Quality Tracks","type":"array","x-stream-index":"003"}},"required":["auto_on","enabled","quality_tracks","layout"],"title":"HLSSettingsResponse","type":"object"},"IngressAudioEncodingOptionsRequest":{"properties":{"bitrate":{"maximum":128000,"minimum":16000,"type":"integer","x-stream-index":"003"},"channels":{"enum":["1","2"],"format":"int32","type":"integer","x-stream-index":"001"},"enable_dtx":{"type":"boolean","x-stream-index":"002"}},"required":["channels","bitrate"],"type":"object"},"IngressAudioEncodingResponse":{"properties":{"bitrate":{"format":"int32","type":"integer","x-stream-index":"003"},"channels":{"format":"int32","type":"integer","x-stream-index":"001"},"enable_dtx":{"type":"boolean","x-stream-index":"002"}},"required":["channels","enable_dtx","bitrate"],"type":"object"},"IngressSettingsRequest":{"properties":{"audio_encoding_options":{"$ref":"#/components/schemas/IngressAudioEncodingOptionsRequest","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"video_encoding_options":{"additionalProperties":{"$ref":"#/components/schemas/IngressVideoEncodingOptionsRequest"},"type":"object","x-stream-index":"003"}},"type":"object"},"IngressSettingsResponse":{"properties":{"audio_encoding_options":{"$ref":"#/components/schemas/IngressAudioEncodingResponse","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"video_encoding_options":{"additionalProperties":{"$ref":"#/components/schemas/IngressVideoEncodingResponse"},"type":"object","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"IngressVideoEncodingOptionsRequest":{"properties":{"layers":{"items":{"$ref":"#/components/schemas/IngressVideoLayerRequest"},"minimum":1,"type":"array","x-stream-index":"001"}},"required":["layers"],"type":"object"},"IngressVideoEncodingResponse":{"properties":{"layers":{"items":{"$ref":"#/components/schemas/IngressVideoLayerResponse"},"type":"array","x-stream-index":"001"}},"required":["layers"],"type":"object"},"IngressVideoLayerRequest":{"nullable":true,"properties":{"bitrate":{"format":"int32","minimum":1000,"type":"integer","x-stream-index":"002"},"codec":{"enum":["h264","vp8"],"type":"string","x-stream-index":"001"},"frame_rate_limit":{"maximum":60,"minimum":1,"type":"integer","x-stream-index":"005"},"max_dimension":{"minimum":240,"type":"integer","x-stream-index":"004"},"min_dimension":{"minimum":240,"type":"integer","x-stream-index":"003"}},"required":["codec","bitrate","min_dimension","max_dimension","frame_rate_limit"],"type":"object"},"IngressVideoLayerResponse":{"nullable":true,"properties":{"bitrate":{"type":"integer","x-stream-index":"002"},"codec":{"type":"string","x-stream-index":"001"},"frame_rate_limit":{"type":"integer","x-stream-index":"005"},"max_dimension":{"type":"integer","x-stream-index":"004"},"min_dimension":{"type":"integer","x-stream-index":"003"}},"required":["codec","bitrate","min_dimension","max_dimension","frame_rate_limit"],"type":"object"},"JoinCallAPIMetrics":{"properties":{"failures":{"format":"float","type":"number","x-stream-index":"002"},"latency":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"003"},"total":{"format":"float","type":"number","x-stream-index":"001"}},"required":["total","failures"],"type":"object"},"LayoutSettingsRequest":{"properties":{"detect_orientation":{"type":"boolean","x-stream-index":"005"},"external_app_url":{"type":"string","x-stream-index":"003"},"external_css_url":{"type":"string","x-stream-index":"004"},"name":{"enum":["spotlight","grid","single-participant","mobile","custom"],"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"required":["name"],"type":"object"},"LayoutSettingsResponse":{"properties":{"detect_orientation":{"type":"boolean","x-stream-index":"005"},"external_app_url":{"type":"string","x-stream-index":"003"},"external_css_url":{"type":"string","x-stream-index":"004"},"name":{"enum":["spotlight","grid","single-participant","mobile","custom"],"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"required":["name","external_app_url","external_css_url"],"type":"object"},"LimitsSettingsRequest":{"properties":{"max_duration_seconds":{"format":"int32","minimum":0,"type":"integer","x-stream-index":"004"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"},"max_participants_exclude_owner":{"type":"boolean","x-stream-index":"003"},"max_participants_exclude_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"002"}},"type":"object"},"LimitsSettingsResponse":{"properties":{"max_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"004"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"},"max_participants_exclude_owner":{"type":"boolean","x-stream-index":"003"},"max_participants_exclude_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"002"}},"required":["max_participants_exclude_roles"],"type":"object"},"ListCallTypeResponse":{"description":"Response for ListCallType","nullable":true,"properties":{"call_types":{"additionalProperties":{"$ref":"#/components/schemas/CallTypeResponse"},"type":"object","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["call_types","duration"],"title":"ListCallTypeResponse","type":"object"},"ListDevicesResponse":{"description":"List devices response","nullable":true,"properties":{"devices":{"description":"List of devices","items":{"$ref":"#/components/schemas/DeviceResponse"},"title":"Devices","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["devices","duration"],"title":"ListDevicesResponse","type":"object"},"ListExternalStorageResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"external_storages":{"additionalProperties":{"$ref":"#/components/schemas/ExternalStorageResponse"},"type":"object","x-stream-index":"002"}},"required":["duration","external_storages"],"title":"Response","type":"object"},"ListRecordingsResponse":{"description":"Response for listing recordings","nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"},"recordings":{"items":{"$ref":"#/components/schemas/CallRecording"},"title":"The list of recordings.","type":"array","x-stream-index":"002"}},"required":["duration","recordings"],"title":"ListRecordingsResponse","type":"object"},"ListTranscriptionsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"},"transcriptions":{"description":"List of transcriptions for the call","items":{"$ref":"#/components/schemas/CallTranscription"},"title":"Transcriptions","type":"array","x-stream-index":"002"}},"required":["duration","transcriptions"],"title":"ListTranscriptionsResponse","type":"object"},"MemberRequest":{"description":"MemberRequest is the payload for adding a member to a call.","properties":{"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"003"},"role":{"title":"Role","type":"string","x-stream-index":"002"},"user_id":{"minLength":1,"title":"User ID","type":"string","x-stream-index":"001"}},"required":["user_id"],"title":"MemberRequest","type":"object"},"MemberResponse":{"description":"MemberResponse is the payload for a member of a call.","properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"005"},"custom":{"additionalProperties":{},"description":"Custom member response data","title":"Custom","type":"object","x-stream-index":"004"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"string","x-stream-index":"007"},"role":{"title":"Role","type":"string","x-stream-index":"003"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"006"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"},"user_id":{"type":"string","x-stream-index":"002"}},"required":["user","user_id","custom","created_at","updated_at"],"title":"MemberResponse","type":"object"},"MessageStatsResponse":{"properties":{"count_over_time":{"items":{"$ref":"#/components/schemas/CountByMinuteResponse"},"type":"array","x-stream-index":"001"}},"type":"object"},"MuteUsersRequest":{"nullable":true,"properties":{"audio":{"title":"Audio","type":"boolean","x-stream-index":"005"},"mute_all_users":{"type":"boolean","x-stream-index":"003"},"muted_by":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"010"},"muted_by_id":{"type":"string","x-stream-index":"009"},"screenshare":{"title":"Screenshare","type":"boolean","x-stream-index":"007"},"screenshare_audio":{"title":"ScreenshareAudio","type":"boolean","x-stream-index":"008"},"user_ids":{"items":{"type":"string"},"title":"UserIDs","type":"array","x-stream-index":"004"},"video":{"title":"Video","type":"boolean","x-stream-index":"006"}},"title":"MuteUsersRequest","type":"object"},"MuteUsersResponse":{"description":"MuteUsersResponse is the response payload for the mute users endpoint.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"MuteUsersResponse","type":"object"},"NetworkMetricsReportResponse":{"properties":{"average_connection_time":{"format":"float","type":"number","x-stream-index":"003"},"average_jitter":{"format":"float","type":"number","x-stream-index":"002"},"average_latency":{"format":"float","type":"number","x-stream-index":"001"},"average_time_to_reconnect":{"format":"float","type":"number","x-stream-index":"004"}},"type":"object"},"NoiseCancellationSettings":{"properties":{"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode"],"type":"object"},"NotificationSettings":{"properties":{"call_live_started":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"002"},"call_missed":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"006"},"call_notification":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"004"},"call_ring":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"session_started":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"003"}},"type":"object"},"OwnCapability":{"description":"All possibility of string to use","enum":["block-users","change-max-duration","create-call","create-reaction","enable-noise-cancellation","end-call","join-backstage","join-call","join-ended-call","mute-users","pin-for-everyone","read-call","remove-call-member","screenshare","send-audio","send-video","start-broadcast-call","start-closed-captions-call","start-frame-record-call","start-record-call","start-transcription-call","stop-broadcast-call","stop-closed-captions-call","stop-frame-record-call","stop-record-call","stop-transcription-call","update-call","update-call-member","update-call-permissions","update-call-settings"],"title":"OwnCapability","type":"string"},"ParticipantCountByMinuteResponse":{"nullable":true,"properties":{"first":{"format":"int32","type":"integer","x-stream-index":"002"},"last":{"format":"int32","type":"integer","x-stream-index":"003"},"max":{"format":"int32","type":"integer","x-stream-index":"004"},"min":{"format":"int32","type":"integer","x-stream-index":"005"},"start_ts":{"format":"date-time","type":"string","x-stream-index":"001"}},"required":["start_ts","first","last","max","min"],"type":"object"},"ParticipantCountOverTimeResponse":{"properties":{"by_minute":{"items":{"$ref":"#/components/schemas/ParticipantCountByMinuteResponse"},"type":"array","x-stream-index":"001"}},"type":"object"},"ParticipantReportResponse":{"properties":{"by_browser":{"items":{"$ref":"#/components/schemas/GroupedStatsResponse"},"type":"array","x-stream-index":"008"},"by_country":{"items":{"$ref":"#/components/schemas/GroupedStatsResponse"},"type":"array","x-stream-index":"005"},"by_device":{"items":{"$ref":"#/components/schemas/GroupedStatsResponse"},"type":"array","x-stream-index":"006"},"by_operating_system":{"items":{"$ref":"#/components/schemas/GroupedStatsResponse"},"type":"array","x-stream-index":"007"},"count_over_time":{"$ref":"#/components/schemas/ParticipantCountOverTimeResponse","x-stream-index":"004"},"max_concurrent":{"format":"int32","type":"integer","x-stream-index":"003"},"publishers":{"$ref":"#/components/schemas/PublisherStatsResponse","x-stream-index":"009"},"subscribers":{"$ref":"#/components/schemas/SubscriberStatsResponse","x-stream-index":"010"},"sum":{"format":"int32","type":"integer","x-stream-index":"001"},"unique":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["sum","unique"],"type":"object"},"PerSDKUsageReport":{"nullable":true,"properties":{"by_version":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"002"},"total":{"format":"int32","type":"integer","x-stream-index":"001"}},"required":["total","by_version"],"type":"object"},"PermissionRequestEvent":{"description":"This event is sent when a user requests access to a feature on a call,\nclients receiving this event should display a permission request to the user","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"permissions":{"description":"The list of permissions requested by the user","items":{"type":"string"},"title":"Permissions","type":"array","x-stream-index":"004"},"type":{"default":"call.permission_request","description":"The type of event: \"call.permission_request\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who sent the permission request","title":"User","x-stream-index":"003"}},"required":["type","created_at","call_cid","user","permissions"],"title":"PermissionRequestEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"PinRequest":{"description":"PinRequest is the payload for pinning a message.","nullable":true,"properties":{"session_id":{"description":"the session ID of the user who pinned the message","title":"SessionID","type":"string","x-stream-index":"003"},"user_id":{"description":"the user ID of the user who pinned the message","title":"UserID","type":"string","x-stream-index":"002"}},"required":["user_id","session_id"],"title":"PinRequest","type":"object"},"PinResponse":{"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"},"PlatformDataResponse":{"properties":{"browser":{"$ref":"#/components/schemas/BrowserDataResponse","x-stream-index":"003"},"device":{"$ref":"#/components/schemas/DeviceDataResponse","x-stream-index":"002"},"os":{"$ref":"#/components/schemas/ClientOSDataResponse","x-stream-index":"001"}},"required":["os","device","browser"],"type":"object"},"PrivacySettings":{"properties":{"read_receipts":{"$ref":"#/components/schemas/ReadReceipts","x-stream-index":"002"},"typing_indicators":{"$ref":"#/components/schemas/TypingIndicators","x-stream-index":"001"}},"type":"object"},"PrivacySettingsResponse":{"type":"object"},"PublisherAllMetrics":{"properties":{"audio":{"$ref":"#/components/schemas/PublisherAudioMetrics","x-stream-index":"001"},"rtt_ms":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"003"},"video":{"$ref":"#/components/schemas/PublisherVideoMetrics","x-stream-index":"002"}},"type":"object"},"PublisherAudioMetrics":{"properties":{"jitter_ms":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"001"}},"type":"object"},"PublisherStatsResponse":{"properties":{"by_track":{"items":{"$ref":"#/components/schemas/TrackStatsResponse"},"type":"array","x-stream-index":"003"},"total":{"format":"int32","type":"integer","x-stream-index":"001"},"unique":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["total","unique"],"type":"object"},"PublisherVideoMetrics":{"properties":{"fps_30":{"$ref":"#/components/schemas/ActiveCallsFPSStats","x-stream-index":"002"},"frame_encoding_time_ms":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"003"},"jitter_ms":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"001"}},"type":"object"},"PublishersMetrics":{"properties":{"all":{"$ref":"#/components/schemas/PublisherAllMetrics","x-stream-index":"001"}},"type":"object"},"PushNotificationSettingsResponse":{"properties":{"disabled":{"type":"boolean","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"string","x-stream-index":"002"}},"type":"object"},"QualityScoreReport":{"properties":{"histogram":{"items":{"$ref":"#/components/schemas/ReportByHistogramBucket"},"type":"array","x-stream-index":"001"}},"required":["histogram"],"type":"object"},"QualityScoreReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateQualityScoreReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"QueryAggregateCallStatsRequest":{"nullable":true,"properties":{"from":{"type":"string","x-stream-index":"002"},"report_types":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"to":{"type":"string","x-stream-index":"003"}},"type":"object"},"QueryAggregateCallStatsResponse":{"description":"Basic response information","nullable":true,"properties":{"call_duration_report":{"$ref":"#/components/schemas/CallDurationReportResponse","x-stream-index":"002"},"call_participant_count_report":{"$ref":"#/components/schemas/CallParticipantCountReportResponse","x-stream-index":"004"},"calls_per_day_report":{"$ref":"#/components/schemas/CallsPerDayReportResponse","x-stream-index":"003"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"network_metrics_report":{"$ref":"#/components/schemas/NetworkMetricsReportResponse","x-stream-index":"008"},"quality_score_report":{"$ref":"#/components/schemas/QualityScoreReportResponse","x-stream-index":"005"},"sdk_usage_report":{"$ref":"#/components/schemas/SDKUsageReportResponse","x-stream-index":"006"},"user_feedback_report":{"$ref":"#/components/schemas/UserFeedbackReportResponse","x-stream-index":"007"}},"required":["duration"],"title":"Response","type":"object"},"QueryCallMembersRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"002"},"id":{"maxLength":64,"type":"string","x-stream-index":"001.002"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"004.001"},"next":{"type":"string","x-stream-index":"004.002"},"prev":{"type":"string","x-stream-index":"004.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":1,"type":"array","x-stream-index":"003"},"type":{"maxLength":64,"type":"string","x-stream-index":"001.001"}},"required":["type","id"],"type":"object"},"QueryCallMembersResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["members","duration"],"title":"Response","type":"object"},"QueryCallParticipantsRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"003"}},"type":"object"},"QueryCallParticipantsResponse":{"nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001.001"},"duration":{"type":"string","x-stream-index":"004.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001.002"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"001.004"},"participants":{"description":"List of call participants","items":{"$ref":"#/components/schemas/CallParticipantResponse"},"title":"[]CallParticipantResponse","type":"array","x-stream-index":"002"},"total_participants":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["call","members","own_capabilities","blocked_users","participants","total_participants","duration"],"type":"object"},"QueryCallStatsRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"004.001"},"next":{"type":"string","x-stream-index":"004.002"},"prev":{"type":"string","x-stream-index":"004.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":2,"type":"array","x-stream-index":"002"}},"type":"object"},"QueryCallStatsResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"next":{"type":"string","x-stream-index":"003.001"},"prev":{"type":"string","x-stream-index":"003.002"},"reports":{"items":{"$ref":"#/components/schemas/CallStatsReportSummaryResponse"},"type":"array","x-stream-index":"001"}},"required":["reports","duration"],"title":"Response","type":"object"},"QueryCallsRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"title":"Filters","type":"object","x-stream-index":"003"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"006.001"},"next":{"type":"string","x-stream-index":"006.002"},"prev":{"type":"string","x-stream-index":"006.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":2,"title":"Sort","type":"array","x-stream-index":"004"}},"title":"QueryCallsRequest","type":"object"},"QueryCallsResponse":{"nullable":true,"properties":{"calls":{"items":{"$ref":"#/components/schemas/CallStateResponseFields"},"title":"Calls","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["calls","duration"],"title":"QueryCallsResponse","type":"object"},"QueryUserFeedbackRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":2,"type":"array","x-stream-index":"002"}},"type":"object"},"QueryUserFeedbackResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"next":{"type":"string","x-stream-index":"003.001"},"prev":{"type":"string","x-stream-index":"003.002"},"user_feedback":{"items":{"$ref":"#/components/schemas/UserFeedbackResponse"},"type":"array","x-stream-index":"001"}},"required":["user_feedback","duration"],"title":"Response","type":"object"},"RTMPBroadcastRequest":{"description":"RTMPBroadcastRequest is the payload for starting an RTMP broadcast.","properties":{"layout":{"$ref":"#/components/schemas/LayoutSettingsRequest","description":"If provided, will override the call's RTMP settings layout","title":"Layout","x-stream-index":"005"},"name":{"description":"Name identifier for RTMP broadcast, must be unique in call","maxLength":255,"title":"Name","type":"string","x-stream-index":"001"},"quality":{"description":"If provided, will override the call's RTMP settings quality","enum":["360p","480p","720p","1080p","1440p","portrait-360x640","portrait-480x854","portrait-720x1280","portrait-1080x1920","portrait-1440x2560"],"title":"Quality","type":"string","x-stream-index":"004"},"stream_key":{"description":"If provided, will be appended at the end of stream_url","title":"Stream Key","type":"string","x-stream-index":"003"},"stream_url":{"description":"URL for the RTMP server to send the call to","maxLength":255,"title":"Stream URL","type":"string","x-stream-index":"002"}},"required":["name","stream_url"],"title":"RTMPBroadcastRequest","type":"object"},"RTMPIngress":{"description":"RTMP input settings","properties":{"address":{"title":"Address","type":"string","x-stream-index":"001"}},"required":["address"],"title":"RTMPIngress","type":"object"},"RTMPSettingsRequest":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettingsRequest","description":"Layout for the composed RTMP stream","title":"LayoutSettings","x-stream-index":"003"},"quality":{"description":"Resolution to set for the RTMP stream","enum":["360p","480p","720p","1080p","1440p","portrait-360x640","portrait-480x854","portrait-720x1280","portrait-1080x1920","portrait-1440x2560"],"title":"Quality","type":"string","x-stream-index":"002"}},"title":"RTMPSettingsRequest","type":"object"},"RTMPSettingsResponse":{"description":"RTMPSettingsResponse is the payload for RTMP settings","properties":{"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettingsResponse","title":"Layout","x-stream-index":"003"},"quality":{"title":"Quality","type":"string","x-stream-index":"002"}},"required":["enabled","quality","layout"],"title":"RTMPSettingsResponse","type":"object"},"ReactionResponse":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"emoji_code":{"type":"string","x-stream-index":"003"},"type":{"type":"string","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"}},"required":["user","type"],"type":"object"},"ReadReceipts":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"RecordSettingsRequest":{"properties":{"audio_only":{"type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettingsRequest","title":"LayoutSettings","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"title":"Mode","type":"string","x-stream-index":"002"},"quality":{"enum":["360p","480p","720p","1080p","1440p","portrait-360x640","portrait-480x854","portrait-720x1280","portrait-1080x1920","portrait-1440x2560"],"type":"string","x-stream-index":"003"}},"required":["mode"],"title":"RecordSettingsRequest","type":"object"},"RecordSettingsResponse":{"description":"RecordSettings is the payload for recording settings","properties":{"audio_only":{"title":"Audio Only","type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettingsResponse","title":"Layout","x-stream-index":"004"},"mode":{"title":"Mode","type":"string","x-stream-index":"002"},"quality":{"title":"Quality","type":"string","x-stream-index":"003"}},"required":["audio_only","mode","quality","layout"],"title":"RecordSettingsResponse","type":"object"},"ReportByHistogramBucket":{"properties":{"category":{"type":"string","x-stream-index":"001"},"count":{"format":"int32","type":"integer","x-stream-index":"005"},"lower_bound":{"$ref":"#/components/schemas/Bound","x-stream-index":"002"},"sum":{"format":"float","type":"number","x-stream-index":"004"},"upper_bound":{"$ref":"#/components/schemas/Bound","x-stream-index":"003"}},"required":["category","sum","count"],"type":"object"},"ReportResponse":{"properties":{"call":{"$ref":"#/components/schemas/CallReportResponse","x-stream-index":"003"},"participants":{"$ref":"#/components/schemas/ParticipantReportResponse","x-stream-index":"001"},"user_ratings":{"$ref":"#/components/schemas/UserRatingReportResponse","x-stream-index":"002"}},"required":["participants","user_ratings","call"],"type":"object"},"Response":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001"}},"required":["duration"],"title":"Response","type":"object"},"RingSettingsRequest":{"properties":{"auto_cancel_timeout_ms":{"description":"When none of the callees accept a ring call in this time a rejection will be sent by the caller with reason 'timeout' by the SDKs","format":"int32","maximum":180000,"minimum":5000,"title":"AutoCancelTimeoutMs","type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"description":"When a callee is online but doesn't answer a ring call in this time a rejection will be sent with reason 'timeout' by the SDKs","format":"int32","maximum":180000,"minimum":5000,"title":"IncomingCallTimeoutMs","type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"description":"When a callee doesn't accept or reject a ring call in this time a missed call event will be sent","format":"int32","maximum":180000,"minimum":5000,"title":"MissedCallTimeoutMs","type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_timeout_ms"],"title":"RingSettingsRequest","type":"object"},"RingSettingsResponse":{"properties":{"auto_cancel_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_timeout_ms","missed_call_timeout_ms"],"type":"object"},"S3Request":{"description":"Config for creating Amazon S3 storage.","properties":{"s3_api_key":{"description":"The AWS API key. To use Amazon S3 as your storage provider, you have two authentication options: IAM role or API key. If you do not specify the `s3_api_key` parameter, Stream will use IAM role authentication. In that case make sure to have the correct IAM role configured for your application.","title":"S3ApiKey","type":"string","x-stream-index":"002"},"s3_custom_endpoint_url":{"description":"The custom endpoint for S3. If you want to use a custom endpoint, you must also provide the `s3_api_key` and `s3_secret` parameters.","title":"S3CustomEndpointURL","type":"string","x-stream-index":"004"},"s3_region":{"description":"The AWS region where the bucket is hosted","title":"S3Region","type":"string","x-stream-index":"001"},"s3_secret":{"description":"The AWS API Secret","title":"S3Secret","type":"string","x-stream-index":"003"}},"required":["s3_region"],"title":"S3Request","type":"object"},"SDKUsageReport":{"properties":{"per_sdk_usage":{"additionalProperties":{"$ref":"#/components/schemas/PerSDKUsageReport"},"type":"object","x-stream-index":"001"}},"required":["per_sdk_usage"],"type":"object"},"SDKUsageReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateSDKUsageReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"ScreensharingSettingsRequest":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"type":"object"},"ScreensharingSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled"],"type":"object"},"SendCallEventRequest":{"description":"Send a call event to the other user","nullable":true,"properties":{"custom":{"additionalProperties":{},"title":"Custom","type":"object","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"title":"SendCallEventRequest","type":"object"},"SendCallEventResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"SendCallEventResponse","type":"object"},"SessionSettingsRequest":{"properties":{"inactivity_timeout_seconds":{"format":"int32","maximum":900,"minimum":5,"type":"integer","x-stream-index":"001"}},"required":["inactivity_timeout_seconds"],"type":"object"},"SessionSettingsResponse":{"properties":{"inactivity_timeout_seconds":{"format":"int32","maximum":900,"minimum":5,"type":"integer","x-stream-index":"001"}},"required":["inactivity_timeout_seconds"],"type":"object"},"SortParamRequest":{"nullable":true,"properties":{"direction":{"description":"Direction of sorting, 1 for Ascending, -1 for Descending, default is 1","format":"int32","title":"Direction","type":"integer","x-stream-index":"002"},"field":{"description":"Name of field to sort by","title":"Field","type":"string","x-stream-index":"001"}},"type":"object"},"StartClosedCaptionsRequest":{"nullable":true,"properties":{"enable_transcription":{"description":"Enable transcriptions along with closed captions","title":"Enable Transcription","type":"boolean","x-stream-index":"002"},"external_storage":{"description":"Which external storage to use for transcriptions (only applicable if enable_transcription is true)","title":"External Storage","type":"string","x-stream-index":"003"},"language":{"description":"The spoken language in the call, if not provided the language defined in the transcription settings will be used","enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"title":"Language","type":"string","x-stream-index":"004"}},"type":"object"},"StartClosedCaptionsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"StartFrameRecordingRequest":{"nullable":true,"properties":{"recording_external_storage":{"type":"string","x-stream-index":"002"}},"title":"StartFrameRecordingRequest","type":"object"},"StartFrameRecordingResponse":{"description":"StartFrameRecordingResponse is the response payload for the start frame recording endpoint.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StartFrameRecordingResponse","type":"object"},"StartHLSBroadcastingRequest":{"description":"StartHLSBroadcastingRequest is the payload for starting an HLS broadcasting.","nullable":true,"title":"StartHLSBroadcastingRequest","type":"object"},"StartHLSBroadcastingResponse":{"description":"StartHLSBroadcastingResponse is the payload for starting an HLS broadcasting.","nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"},"playlist_url":{"description":"the URL of the HLS playlist","title":"PlaylistURL","type":"string","x-stream-index":"002"}},"required":["duration","playlist_url"],"title":"StartHLSBroadcastingResponse","type":"object"},"StartRTMPBroadcastsRequest":{"description":"StartRTMPBroadcastsRequest is the payload for starting RTMP broadcasts.","nullable":true,"properties":{"broadcasts":{"description":"List of broadcasts to start","items":{"$ref":"#/components/schemas/RTMPBroadcastRequest"},"maximum":1,"minimum":1,"title":"Broadcasts","type":"array","x-stream-index":"002"}},"required":["broadcasts"],"title":"StartRTMPBroadcastsRequest","type":"object"},"StartRTMPBroadcastsResponse":{"description":"StartRTMPBroadcastsResponse is the payload for starting an RTMP broadcast.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StartRTMPBroadcastsResponse","type":"object"},"StartRecordingRequest":{"nullable":true,"properties":{"recording_external_storage":{"type":"string","x-stream-index":"002"}},"title":"StartRecordingRequest","type":"object"},"StartRecordingResponse":{"description":"StartRecordingResponse is the response payload for the start recording endpoint.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StartRecordingResponse","type":"object"},"StartTranscriptionRequest":{"nullable":true,"properties":{"enable_closed_captions":{"description":"Enable closed captions along with transcriptions","title":"Enable Closed Captions","type":"boolean","x-stream-index":"003"},"language":{"description":"The spoken language in the call, if not provided the language defined in the transcription settings will be used","enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"title":"Language","type":"string","x-stream-index":"004"},"transcription_external_storage":{"description":"Store transcriptions in this external storage","title":"External Storage","type":"string","x-stream-index":"002"}},"type":"object"},"StartTranscriptionResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StartTranscriptionResponse","type":"object"},"StopAllRTMPBroadcastsRequest":{"nullable":true,"title":"StopAllRTMPBroadcastsRequest","type":"object"},"StopAllRTMPBroadcastsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StopAllRTMPBroadcastsResponse","type":"object"},"StopClosedCaptionsRequest":{"nullable":true,"properties":{"stop_transcription":{"type":"boolean","x-stream-index":"003"}},"type":"object"},"StopClosedCaptionsResponse":{"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"},"StopFrameRecordingRequest":{"nullable":true,"type":"object"},"StopFrameRecordingResponse":{"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"},"StopHLSBroadcastingRequest":{"nullable":true,"type":"object"},"StopHLSBroadcastingResponse":{"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"},"StopLiveRequest":{"nullable":true,"properties":{"continue_closed_caption":{"type":"boolean","x-stream-index":"006"},"continue_hls":{"type":"boolean","x-stream-index":"003"},"continue_recording":{"type":"boolean","x-stream-index":"004"},"continue_rtmp_broadcasts":{"type":"boolean","x-stream-index":"007"},"continue_transcription":{"type":"boolean","x-stream-index":"005"}},"title":"StopLiveRequest","type":"object"},"StopLiveResponse":{"nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"The call that was stopped","title":"Call","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["call","duration"],"title":"StopLiveResponse","type":"object"},"StopRTMPBroadcastsRequest":{"description":"Request for stopping RTMP broadcasts","nullable":true,"title":"StopRTMPBroadcastsRequest","type":"object"},"StopRTMPBroadcastsResponse":{"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"},"StopRecordingRequest":{"nullable":true,"type":"object"},"StopRecordingResponse":{"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"},"StopTranscriptionRequest":{"nullable":true,"properties":{"stop_closed_captions":{"type":"boolean","x-stream-index":"003"}},"type":"object"},"StopTranscriptionResponse":{"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"},"SubscriberAllMetrics":{"properties":{"audio":{"$ref":"#/components/schemas/SubscriberAudioMetrics","x-stream-index":"001"},"rtt_ms":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"003"},"video":{"$ref":"#/components/schemas/SubscriberVideoMetrics","x-stream-index":"002"}},"type":"object"},"SubscriberAudioMetrics":{"properties":{"concealment_pct":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"003"},"jitter_ms":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"001"},"packets_lost_pct":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"002"}},"type":"object"},"SubscriberStatsResponse":{"properties":{"total":{"format":"int32","type":"integer","x-stream-index":"001"},"total_subscribed_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"003"},"unique":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["total","unique","total_subscribed_duration_seconds"],"type":"object"},"SubscriberVideoMetrics":{"properties":{"fps_30":{"$ref":"#/components/schemas/ActiveCallsFPSStats","x-stream-index":"002"},"jitter_ms":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"001"},"packets_lost_pct":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"003"}},"type":"object"},"SubscribersMetrics":{"properties":{"all":{"$ref":"#/components/schemas/SubscriberAllMetrics","x-stream-index":"001"}},"type":"object"},"TargetResolution":{"properties":{"bitrate":{"format":"int32","maximum":6000000,"type":"integer","x-stream-index":"003"},"height":{"format":"int32","maximum":3840,"minimum":240,"type":"integer","x-stream-index":"002"},"width":{"format":"int32","maximum":3840,"minimum":240,"type":"integer","x-stream-index":"001"}},"required":["width","height"],"type":"object"},"ThumbnailResponse":{"properties":{"image_url":{"type":"string","x-stream-index":"001"}},"required":["image_url"],"type":"object"},"ThumbnailsSettingsRequest":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"ThumbnailsSettingsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"TrackStatsResponse":{"nullable":true,"properties":{"duration_seconds":{"format":"int32","type":"integer","x-stream-index":"002"},"track_type":{"type":"string","x-stream-index":"001"}},"required":["track_type","duration_seconds"],"type":"object"},"TranscriptionSettingsRequest":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"002"},"language":{"enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"type":"string","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode"],"type":"object"},"TranscriptionSettingsResponse":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"002"},"language":{"enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"type":"string","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode","closed_caption_mode","languages","language"],"type":"object"},"TypingIndicators":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"UnblockUserRequest":{"description":"UnblockUserRequest is the payload for unblocking a user.","nullable":true,"properties":{"user_id":{"description":"the user to unblock","title":"UserID","type":"string","x-stream-index":"003"}},"required":["user_id"],"title":"UnblockUserRequest","type":"object"},"UnblockUserResponse":{"description":"UnblockUserResponse is the payload for unblocking a user.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"UnblockUserResponse","type":"object"},"UnblockedUserEvent":{"description":"This event is sent when a user is unblocked on a call,\nthis can be useful to notify the user that they can now join the call again","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"call.unblocked_user","description":"The type of event: \"call.unblocked_user\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user that was unblocked","title":"User","x-stream-index":"003"}},"required":["type","created_at","call_cid","user"],"title":"UnblockedUserEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"UnpinRequest":{"description":"UnpinRequest is the payload for unpinning a message.","nullable":true,"properties":{"session_id":{"description":"the session ID of the user who pinned the message","title":"SessionID","type":"string","x-stream-index":"003"},"user_id":{"description":"the user ID of the user who pinned the message","title":"UserID","type":"string","x-stream-index":"002"}},"required":["user_id","session_id"],"title":"UnpinRequest","type":"object"},"UnpinResponse":{"description":"UnpinResponse is the payload for unpinning a message.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"UnpinResponse","type":"object"},"UpdateCallMembersRequest":{"description":"Update call members","nullable":true,"properties":{"remove_members":{"description":"List of userID to remove","items":{"type":"string"},"maximum":100,"title":"Remove Members","type":"array","x-stream-index":"003"},"update_members":{"description":"List of members to update or insert","items":{"$ref":"#/components/schemas/MemberRequest"},"maximum":100,"title":"Update Members","type":"array","x-stream-index":"004"}},"title":"UpdateCallMembersRequest","type":"object"},"UpdateCallMembersResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"002"}},"required":["duration","members"],"title":"Response","type":"object"},"UpdateCallRequest":{"description":"Request for updating a call","nullable":true,"properties":{"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"003"},"settings_override":{"$ref":"#/components/schemas/CallSettingsRequest","description":"the settings to change for this call","title":"Settings Override","x-stream-index":"004"},"starts_at":{"description":"the time the call is scheduled to start","format":"date-time","title":"Starts At","type":"string","x-stream-index":"005"}},"title":"UpdateCallRequest","type":"object"},"UpdateCallResponse":{"description":"Response for updating a call","nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001.001"},"duration":{"type":"string","x-stream-index":"002.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001.002"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"001.004"}},"required":["call","members","own_capabilities","blocked_users","duration"],"title":"UpdateCallResponse","type":"object"},"UpdateCallTypeRequest":{"description":"UpdateCallTypeRequest is the payload for updating a call type.","nullable":true,"properties":{"external_storage":{"type":"string","x-stream-index":"002.004"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"002.001"},"notification_settings":{"$ref":"#/components/schemas/NotificationSettings","x-stream-index":"002.002"},"settings":{"$ref":"#/components/schemas/CallSettingsRequest","x-stream-index":"002.003"}},"title":"UpdateCallTypeRequest","type":"object"},"UpdateCallTypeResponse":{"description":"UpdateCallTypeResponse is the payload for updating a call type.","nullable":true,"properties":{"created_at":{"description":"the time the call type was created","format":"date-time","title":"CreatedAt","type":"string","x-stream-index":"001.005"},"duration":{"type":"string","x-stream-index":"002.001"},"external_storage":{"description":"the external storage for the call type","title":"ExternalStorage","type":"string","x-stream-index":"001.007"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"the permissions granted to each role","title":"Grants","type":"object","x-stream-index":"001.002"},"name":{"description":"the name of the call type","title":"Name","type":"string","x-stream-index":"001.001"},"notification_settings":{"$ref":"#/components/schemas/NotificationSettings","description":"the notification settings for the call type","title":"NotificationSettings","x-stream-index":"001.004"},"settings":{"$ref":"#/components/schemas/CallSettingsResponse","description":"the settings for the call type","title":"Settings","x-stream-index":"001.003"},"updated_at":{"description":"the time the call type was last updated","format":"date-time","title":"UpdatedAt","type":"string","x-stream-index":"001.006"}},"required":["name","grants","settings","notification_settings","created_at","updated_at","duration"],"title":"UpdateCallTypeResponse","type":"object"},"UpdateExternalStorageRequest":{"description":"External storage","nullable":true,"properties":{"aws_s3":{"$ref":"#/components/schemas/S3Request","description":"Only required if you want to create an Amazon S3 storage","title":"AwsS3","x-stream-index":"003.004"},"azure_blob":{"$ref":"#/components/schemas/AzureRequest","description":"Only required if you want to create an Azure Blob Storage","title":"AzureBlob","x-stream-index":"003.006"},"bucket":{"description":"The name of the bucket on the service provider","title":"Bucket","type":"string","x-stream-index":"003.002"},"gcs_credentials":{"type":"string","x-stream-index":"003.005"},"path":{"description":"The path prefix to use for storing files","title":"Path","type":"string","x-stream-index":"003.003"},"storage_type":{"description":"The type of storage to use","enum":["s3","gcs","abs"],"title":"StorageType","type":"string","x-stream-index":"003.001"}},"required":["storage_type","bucket"],"title":"ExternalStorageRequest","type":"object"},"UpdateExternalStorageResponse":{"description":"Basic response information","nullable":true,"properties":{"bucket":{"type":"string","x-stream-index":"001.003"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"name":{"type":"string","x-stream-index":"001.001"},"path":{"type":"string","x-stream-index":"001.004"},"type":{"enum":["s3","gcs","abs"],"type":"string","x-stream-index":"001.002"}},"required":["name","type","bucket","path","duration"],"title":"Response","type":"object"},"UpdateUserPermissionsRequest":{"nullable":true,"properties":{"grant_permissions":{"items":{"type":"string"},"type":"array","x-stream-index":"002"},"revoke_permissions":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"user_id":{"type":"string","x-stream-index":"001"}},"required":["user_id"],"type":"object"},"UpdateUserPermissionsResponse":{"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"},"UpdatedCallPermissionsEvent":{"description":"This event is sent to notify about permission changes for a user, clients receiving this event should update their UI accordingly","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"own_capabilities":{"description":"The capabilities of the current user","items":{"$ref":"#/components/schemas/OwnCapability"},"title":"Own capabilities","type":"array","x-stream-index":"004"},"type":{"default":"call.permissions_updated","description":"The type of event: \"call.permissions_updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who received the new permissions","title":"User","x-stream-index":"003"}},"required":["type","created_at","call_cid","user","own_capabilities"],"title":"UpdatedCallPermissionsEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"User":{"properties":{"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"046"},"ban_expires":{"format":"date-time","type":"string","x-stream-index":"017"},"banned":{"type":"boolean","x-stream-index":"016"},"created_at":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"013"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"023"},"language":{"type":"string","x-stream-index":"035"},"last_active":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"026"},"revoke_tokens_issued_before":{"format":"date-time","type":"string","x-stream-index":"042"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"005"},"updated_at":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"009"}},"required":["id","role","teams_role","custom","banned","online"],"type":"object"},"UserBannedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"006.002"},"channel_type":{"type":"string","x-stream-index":"006.003"},"cid":{"type":"string","x-stream-index":"006.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"008.002"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"001"},"expiration":{"format":"date-time","type":"string","x-stream-index":"003"},"reason":{"type":"string","x-stream-index":"004"},"shadow":{"type":"boolean","x-stream-index":"002"},"team":{"type":"string","x-stream-index":"005.001"},"type":{"default":"user.banned","type":"string","x-stream-index":"008.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007.001"}},"required":["created_by","shadow","cid","channel_id","channel_type","type","created_at"],"title":"UserBannedEvent","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"},"UserDeactivatedEvent":{"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"003.002"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"001"},"type":{"default":"user.deactivated","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["created_by","type","created_at"],"title":"UserDeactivatedEvent","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"},"UserFeedbackReport":{"properties":{"count_by_rating":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001"},"unreported_count":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["count_by_rating","unreported_count"],"type":"object"},"UserFeedbackReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateUserFeedbackReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"UserFeedbackResponse":{"properties":{"cid":{"type":"string","x-stream-index":"001"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"009"},"platform":{"$ref":"#/components/schemas/PlatformDataResponse","x-stream-index":"008"},"rating":{"format":"int32","type":"integer","x-stream-index":"004"},"reason":{"type":"string","x-stream-index":"005"},"sdk":{"type":"string","x-stream-index":"006"},"sdk_version":{"type":"string","x-stream-index":"007"},"session_id":{"type":"string","x-stream-index":"002"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["cid","session_id","user_id","rating","reason","sdk","sdk_version","platform"],"type":"object"},"UserMutedEvent":{"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"004.002"},"target_user":{"type":"string","x-stream-index":"001"},"target_users":{"items":{"type":"string"},"type":"array","x-stream-index":"002"},"type":{"default":"user.muted","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"UserMutedEvent","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"},"UserRatingReportResponse":{"properties":{"average":{"format":"float","type":"number","x-stream-index":"002"},"count":{"format":"int32","type":"integer","x-stream-index":"001"}},"required":["count","average"],"type":"object"},"UserReactivatedEvent":{"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"002.002"},"type":{"default":"user.reactivated","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"001"}},"required":["type","created_at"],"title":"UserReactivatedEvent","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"},"UserRequest":{"description":"User request object","properties":{"custom":{"additionalProperties":{},"description":"Custom user data","title":"Custom","type":"object","x-stream-index":"004"},"id":{"description":"User ID","title":"ID","type":"string","x-stream-index":"001"},"image":{"description":"User's profile image URL","title":"Image","type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"006"},"language":{"type":"string","x-stream-index":"005"},"name":{"description":"Optional name of user","title":"Name","type":"string","x-stream-index":"002"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"007"},"role":{"description":"User's global role","title":"Role","type":"string","x-stream-index":"008"},"teams":{"description":"List of teams the user belongs to","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"010"},"teams_role":{"additionalProperties":{"type":"string"},"description":"Map of team-specific roles for the user","title":"TeamsRole","type":"object","x-stream-index":"009"}},"required":["id"],"title":"UserRequest","type":"object"},"UserResponse":{"description":"User response object","properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"ban_expires":{"description":"Date when ban expires","format":"date-time","title":"Ban expires","type":"string","x-stream-index":"003"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.017"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"001.004"},"deactivated_at":{"description":"Date of deactivation","format":"date-time","title":"Deactivated at","type":"string","x-stream-index":"001.016"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"string","x-stream-index":"001.011"},"devices":{"description":"List of devices user is using","items":{"$ref":"#/components/schemas/DeviceResponse"},"title":"Devices","type":"array","x-stream-index":"006"},"id":{"description":"Unique user identifier","title":"ID","type":"string","x-stream-index":"001.001"},"image":{"title":"Image","type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"007"},"language":{"description":"Preferred language of a user","title":"Language","type":"string","x-stream-index":"001.005"},"last_active":{"description":"Date of last activity","format":"date-time","title":"Last active","type":"string","x-stream-index":"001.014"},"name":{"description":"Optional name of user","title":"Name","type":"string","x-stream-index":"001.002"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","description":"User privacy settings","title":"Privacy settings","x-stream-index":"005"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettingsResponse","description":"User push notification settings","title":"Push notifications","x-stream-index":"004"},"revoke_tokens_issued_before":{"description":"Revocation date for tokens","format":"date-time","title":"Revoke tokens issued before","type":"string","x-stream-index":"001.015"},"role":{"description":"Determines the set of user permissions","title":"Role","type":"string","x-stream-index":"001.006"},"shadow_banned":{"description":"Whether a user is shadow banned","title":"Shadow banned","type":"boolean","x-stream-index":"002"},"teams":{"description":"List of teams user is a part of","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids","shadow_banned","invisible"],"title":"UserResponse","type":"object"},"UserResponsePrivacyFields":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.017"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"string","x-stream-index":"001.016"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"001.011"},"id":{"type":"string","x-stream-index":"001.001"},"image":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"003"},"language":{"type":"string","x-stream-index":"001.005"},"last_active":{"format":"date-time","type":"string","x-stream-index":"001.014"},"name":{"type":"string","x-stream-index":"001.002"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"002"},"revoke_tokens_issued_before":{"format":"date-time","type":"string","x-stream-index":"001.015"},"role":{"type":"string","x-stream-index":"001.006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids"],"type":"object"},"UserUpdatedEvent":{"description":"This event is sent when a user gets updated. The event contains information about the updated user.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"received_at":{"format":"date-time","type":"string","x-stream-index":"001.004"},"type":{"default":"user.updated","description":"The type of event: \"user.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.002"},"user":{"$ref":"#/components/schemas/UserResponsePrivacyFields","description":"The updated user","title":"User","x-stream-index":"002.001"}},"required":["type","created_at","custom","user"],"title":"UserUpdatedEvent","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"},"VideoReactionOverTimeResponse":{"properties":{"by_minute":{"items":{"$ref":"#/components/schemas/CountByMinuteResponse"},"type":"array","x-stream-index":"001"}},"type":"object"},"VideoReactionsResponse":{"nullable":true,"properties":{"count_over_time":{"$ref":"#/components/schemas/VideoReactionOverTimeResponse","x-stream-index":"002"},"reaction":{"type":"string","x-stream-index":"001"}},"required":["reaction"],"type":"object"},"VideoSettingsRequest":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"camera_default_on":{"type":"boolean","x-stream-index":"004"},"camera_facing":{"enum":["front","back","external"],"type":"string","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"type":"object"},"VideoSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"camera_default_on":{"type":"boolean","x-stream-index":"004"},"camera_facing":{"enum":["front","back","external"],"type":"string","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled","target_resolution","camera_default_on","camera_facing"],"type":"object"},"WebhookEvent":{"description":"The discriminator object for all webhook events, it maps events' payload to the final type","discriminator":{"mapping":{"call.accepted":"#/components/schemas/CallAcceptedEvent","call.blocked_user":"#/components/schemas/BlockedUserEvent","call.closed_caption":"#/components/schemas/ClosedCaptionEvent","call.closed_captions_failed":"#/components/schemas/CallClosedCaptionsFailedEvent","call.closed_captions_started":"#/components/schemas/CallClosedCaptionsStartedEvent","call.closed_captions_stopped":"#/components/schemas/CallClosedCaptionsStoppedEvent","call.created":"#/components/schemas/CallCreatedEvent","call.deleted":"#/components/schemas/CallDeletedEvent","call.ended":"#/components/schemas/CallEndedEvent","call.frame_recording_failed":"#/components/schemas/CallFrameRecordingFailedEvent","call.frame_recording_ready":"#/components/schemas/CallFrameRecordingFrameReadyEvent","call.frame_recording_started":"#/components/schemas/CallFrameRecordingStartedEvent","call.frame_recording_stopped":"#/components/schemas/CallFrameRecordingStoppedEvent","call.hls_broadcasting_failed":"#/components/schemas/CallHLSBroadcastingFailedEvent","call.hls_broadcasting_started":"#/components/schemas/CallHLSBroadcastingStartedEvent","call.hls_broadcasting_stopped":"#/components/schemas/CallHLSBroadcastingStoppedEvent","call.live_started":"#/components/schemas/CallLiveStartedEvent","call.member_added":"#/components/schemas/CallMemberAddedEvent","call.member_removed":"#/components/schemas/CallMemberRemovedEvent","call.member_updated":"#/components/schemas/CallMemberUpdatedEvent","call.member_updated_permission":"#/components/schemas/CallMemberUpdatedPermissionEvent","call.missed":"#/components/schemas/CallMissedEvent","call.moderation_blur":"#/components/schemas/CallModerationBlurEvent","call.moderation_warning":"#/components/schemas/CallModerationWarningEvent","call.notification":"#/components/schemas/CallNotificationEvent","call.permission_request":"#/components/schemas/PermissionRequestEvent","call.permissions_updated":"#/components/schemas/UpdatedCallPermissionsEvent","call.reaction_new":"#/components/schemas/CallReactionEvent","call.recording_failed":"#/components/schemas/CallRecordingFailedEvent","call.recording_ready":"#/components/schemas/CallRecordingReadyEvent","call.recording_started":"#/components/schemas/CallRecordingStartedEvent","call.recording_stopped":"#/components/schemas/CallRecordingStoppedEvent","call.rejected":"#/components/schemas/CallRejectedEvent","call.ring":"#/components/schemas/CallRingEvent","call.rtmp_broadcast_failed":"#/components/schemas/CallRtmpBroadcastFailedEvent","call.rtmp_broadcast_started":"#/components/schemas/CallRtmpBroadcastStartedEvent","call.rtmp_broadcast_stopped":"#/components/schemas/CallRtmpBroadcastStoppedEvent","call.session_ended":"#/components/schemas/CallSessionEndedEvent","call.session_participant_count_updated":"#/components/schemas/CallSessionParticipantCountsUpdatedEvent","call.session_participant_joined":"#/components/schemas/CallSessionParticipantJoinedEvent","call.session_participant_left":"#/components/schemas/CallSessionParticipantLeftEvent","call.session_started":"#/components/schemas/CallSessionStartedEvent","call.stats_report_ready":"#/components/schemas/CallStatsReportReadyEvent","call.transcription_failed":"#/components/schemas/CallTranscriptionFailedEvent","call.transcription_ready":"#/components/schemas/CallTranscriptionReadyEvent","call.transcription_started":"#/components/schemas/CallTranscriptionStartedEvent","call.transcription_stopped":"#/components/schemas/CallTranscriptionStoppedEvent","call.unblocked_user":"#/components/schemas/UnblockedUserEvent","call.updated":"#/components/schemas/CallUpdatedEvent","call.user_feedback_submitted":"#/components/schemas/CallUserFeedbackSubmittedEvent","call.user_muted":"#/components/schemas/CallUserMutedEvent","custom":"#/components/schemas/CustomVideoEvent","export.channels.error":"#/components/schemas/AsyncExportErrorEvent","export.channels.success":"#/components/schemas/AsyncExportChannelsEvent","export.users.error":"#/components/schemas/AsyncExportErrorEvent","export.users.success":"#/components/schemas/AsyncExportUsersEvent","user.banned":"#/components/schemas/UserBannedEvent","user.deactivated":"#/components/schemas/UserDeactivatedEvent","user.muted":"#/components/schemas/UserMutedEvent","user.reactivated":"#/components/schemas/UserReactivatedEvent","user.updated":"#/components/schemas/UserUpdatedEvent"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/AsyncExportChannelsEvent"},{"$ref":"#/components/schemas/AsyncExportErrorEvent"},{"$ref":"#/components/schemas/AsyncExportErrorEvent"},{"$ref":"#/components/schemas/AsyncExportUsersEvent"},{"$ref":"#/components/schemas/BlockedUserEvent"},{"$ref":"#/components/schemas/CallAcceptedEvent"},{"$ref":"#/components/schemas/CallClosedCaptionsFailedEvent"},{"$ref":"#/components/schemas/CallClosedCaptionsStartedEvent"},{"$ref":"#/components/schemas/CallClosedCaptionsStoppedEvent"},{"$ref":"#/components/schemas/CallCreatedEvent"},{"$ref":"#/components/schemas/CallDeletedEvent"},{"$ref":"#/components/schemas/CallEndedEvent"},{"$ref":"#/components/schemas/CallFrameRecordingFailedEvent"},{"$ref":"#/components/schemas/CallFrameRecordingFrameReadyEvent"},{"$ref":"#/components/schemas/CallFrameRecordingStartedEvent"},{"$ref":"#/components/schemas/CallFrameRecordingStoppedEvent"},{"$ref":"#/components/schemas/CallHLSBroadcastingFailedEvent"},{"$ref":"#/components/schemas/CallHLSBroadcastingStartedEvent"},{"$ref":"#/components/schemas/CallHLSBroadcastingStoppedEvent"},{"$ref":"#/components/schemas/CallLiveStartedEvent"},{"$ref":"#/components/schemas/CallMemberAddedEvent"},{"$ref":"#/components/schemas/CallMemberRemovedEvent"},{"$ref":"#/components/schemas/CallMemberUpdatedEvent"},{"$ref":"#/components/schemas/CallMemberUpdatedPermissionEvent"},{"$ref":"#/components/schemas/CallMissedEvent"},{"$ref":"#/components/schemas/CallModerationBlurEvent"},{"$ref":"#/components/schemas/CallModerationWarningEvent"},{"$ref":"#/components/schemas/CallNotificationEvent"},{"$ref":"#/components/schemas/CallReactionEvent"},{"$ref":"#/components/schemas/CallRecordingFailedEvent"},{"$ref":"#/components/schemas/CallRecordingReadyEvent"},{"$ref":"#/components/schemas/CallRecordingStartedEvent"},{"$ref":"#/components/schemas/CallRecordingStoppedEvent"},{"$ref":"#/components/schemas/CallRejectedEvent"},{"$ref":"#/components/schemas/CallRingEvent"},{"$ref":"#/components/schemas/CallRtmpBroadcastFailedEvent"},{"$ref":"#/components/schemas/CallRtmpBroadcastStartedEvent"},{"$ref":"#/components/schemas/CallRtmpBroadcastStoppedEvent"},{"$ref":"#/components/schemas/CallSessionEndedEvent"},{"$ref":"#/components/schemas/CallSessionParticipantCountsUpdatedEvent"},{"$ref":"#/components/schemas/CallSessionParticipantJoinedEvent"},{"$ref":"#/components/schemas/CallSessionParticipantLeftEvent"},{"$ref":"#/components/schemas/CallSessionStartedEvent"},{"$ref":"#/components/schemas/CallStatsReportReadyEvent"},{"$ref":"#/components/schemas/CallTranscriptionFailedEvent"},{"$ref":"#/components/schemas/CallTranscriptionReadyEvent"},{"$ref":"#/components/schemas/CallTranscriptionStartedEvent"},{"$ref":"#/components/schemas/CallTranscriptionStoppedEvent"},{"$ref":"#/components/schemas/CallUpdatedEvent"},{"$ref":"#/components/schemas/CallUserFeedbackSubmittedEvent"},{"$ref":"#/components/schemas/CallUserMutedEvent"},{"$ref":"#/components/schemas/ClosedCaptionEvent"},{"$ref":"#/components/schemas/CustomVideoEvent"},{"$ref":"#/components/schemas/PermissionRequestEvent"},{"$ref":"#/components/schemas/UnblockedUserEvent"},{"$ref":"#/components/schemas/UpdatedCallPermissionsEvent"},{"$ref":"#/components/schemas/UserBannedEvent"},{"$ref":"#/components/schemas/UserDeactivatedEvent"},{"$ref":"#/components/schemas/UserMutedEvent"},{"$ref":"#/components/schemas/UserReactivatedEvent"},{"$ref":"#/components/schemas/UserUpdatedEvent"}]}},"securitySchemes":{"JWT":{"description":"JWT should be always provided when stream-auth-type=jwt.\n\nUsing JWT auth request could be authenticated as user or as server-side.\n\nWhen using user authentication permission checking is going to be applied to requests based on the user that is\nperforming a request.\n\nThe `authorization` header should be a JWT string signed using the secret attached to the API key used to perform\nrequests.\n\n**WARNING** all client-side official SDK do not ship with token generation; this is to make sure that the API secret is not\nshared with an untrusted party such as a browser or a iOS/Android application. Tokens **must** be generated server-side.\nIf you wish, you can configure your application to ignore authentication (see `disable_auth_check`)\nThe JWT string must include only the user_id claim and can include any built-in JWT claim such as iat, exp as well.\n","in":"header","name":"Authorization","type":"apiKey"},"api_key":{"description":"Application API key should be always set in order to authenticate the request.","in":"query","name":"api_key","type":"apiKey"},"stream-auth-type":{"description":"Stream-Auth-Type should be always set in order to authenticate the request. Possible\nvalues: `jwt` or `anonymous`.\n\n`jwt` allows you to authenticate as a user. With this auth type you should also provide valid JWT in Authorization\nheader.\n\n`anonymous` allows you to authenticate as anonymous user. Please note that most advanced features are not available\nto anonymous users.","in":"header","name":"Stream-Auth-Type","type":"apiKey"}}},"info":{"title":"Stream API","version":"v187.13.0"},"openapi":"3.0.3","paths":{"/video/active_calls_status":{"get":{"description":"Get the current status of all active calls including metrics and summary information\n","operationId":"GetActiveCallsStatus","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetActiveCallsStatusResponse"}}},"description":"GetActiveCallsStatusResponse"},"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":"Get active calls status","tags":["product:video"]}},"/video/call/feedback":{"post":{"description":"\n","operationId":"QueryUserFeedback","parameters":[{"in":"query","name":"full","schema":{"type":"boolean","writeOnly":true,"x-stream-index":"003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryUserFeedbackRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryUserFeedbackResponse"}}},"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":"Query user reported feedback for the calls","tags":["product:video"]}},"/video/call/members":{"post":{"description":"Query call members with filter query\n","operationId":"QueryCallMembers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallMembersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallMembersResponse"}}},"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":"Query call members","tags":["product:video"]}},"/video/call/stats":{"post":{"description":"\n","operationId":"QueryCallStats","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallStatsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallStatsResponse"}}},"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":"Query Call Stats","tags":["product:video"]}},"/video/call/{type}/{id}":{"get":{"description":"\n","operationId":"GetCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"query","name":"members_limit","schema":{"format":"int32","maximum":100,"minimum":0,"type":"integer","writeOnly":true,"x-stream-index":"004"}},{"in":"query","name":"ring","schema":{"type":"boolean","writeOnly":true,"x-stream-index":"005"}},{"in":"query","name":"notify","schema":{"type":"boolean","writeOnly":true,"x-stream-index":"006"}},{"in":"query","name":"video","schema":{"type":"boolean","writeOnly":true,"x-stream-index":"007"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCallResponse"}}},"description":"GetCallResponse"},"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":"Get Call","tags":["product:video"]},"patch":{"description":"\n\nSends events:\n- call.updated\n","operationId":"UpdateCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallRequest"}}},"description":"UpdateCallRequest","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallResponse"}}},"description":"UpdateCallResponse"},"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":"Update Call","tags":["product:video"]},"post":{"description":"Gets or creates a new call\n\nSends events:\n- call.created\n- call.notification\n- call.ring\n","operationId":"GetOrCreateCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrCreateCallRequest"}}},"description":"GetOrCreateCallRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrCreateCallResponse"}}},"description":"GetOrCreateCallResponse"},"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":"Get or create a call","tags":["product:video"]}},"/video/call/{type}/{id}/block":{"post":{"description":"Block a user, preventing them from joining the call until they are unblocked.\n\nSends events:\n- call.blocked_user\n","operationId":"BlockUser","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUserRequest"}}},"description":"BlockUserRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUserResponse"}}},"description":"BlockUserResponse"},"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":"Block user on a call","tags":["product:video"]}},"/video/call/{type}/{id}/delete":{"post":{"description":"\n\nSends events:\n- call.deleted\n","operationId":"DeleteCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCallRequest"}}},"description":"DeleteCallRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCallResponse"}}},"description":"DeleteCallResponse"},"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":"Delete Call","tags":["product:video"]}},"/video/call/{type}/{id}/event":{"post":{"description":"Sends custom event to the call\n\nSends events:\n- custom\n","operationId":"SendCallEvent","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendCallEventRequest"}}},"description":"SendCallEventRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendCallEventResponse"}}},"description":"SendCallEventResponse"},"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":"Send custom event","tags":["product:video"]}},"/video/call/{type}/{id}/feedback":{"post":{"description":"\n\nSends events:\n- call.user_feedback_submitted\n","operationId":"CollectUserFeedback","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectUserFeedbackRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectUserFeedbackResponse"}}},"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":"Collect user feedback","tags":["product:video"]}},"/video/call/{type}/{id}/go_live":{"post":{"description":"\n\nSends events:\n- call.live_started\n","operationId":"GoLive","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoLiveRequest"}}},"description":"GoLiveRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoLiveResponse"}}},"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":"Set call as live","tags":["product:video"]}},"/video/call/{type}/{id}/mark_ended":{"post":{"description":"\n\nSends events:\n- call.ended\n","operationId":"EndCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EndCallResponse"}}},"description":"EndCallResponse"},"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":"End call","tags":["product:video"]}},"/video/call/{type}/{id}/members":{"post":{"description":"\n\nSends events:\n- call.member_added\n- call.member_removed\n- call.member_updated\n","operationId":"UpdateCallMembers","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallMembersRequest"}}},"description":"UpdateCallMembersRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallMembersResponse"}}},"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":"Update Call Member","tags":["product:video"]}},"/video/call/{type}/{id}/mute_users":{"post":{"description":"Mutes users in a call\n","operationId":"MuteUsers","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteUsersRequest"}}},"description":"MuteUsersRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteUsersResponse"}}},"description":"MuteUsersResponse"},"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":"Mute users","tags":["product:video"]}},"/video/call/{type}/{id}/participants":{"post":{"description":"Returns a list of participants connected to the call\n","operationId":"QueryCallParticipants","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"type","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"limit","schema":{"format":"int32","maximum":100,"type":"integer","x-stream-index":"004"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallParticipantsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallParticipantsResponse"}}},"description":"Successful 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":"Query call participants","tags":["product:video"]}},"/video/call/{type}/{id}/pin":{"post":{"description":"Pins a track for all users in the call.\n","operationId":"VideoPin","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PinRequest"}}},"description":"PinRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PinResponse"}}},"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":"Pin","tags":["product:video"]}},"/video/call/{type}/{id}/recordings":{"get":{"description":"Lists recordings\n","operationId":"ListRecordings","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListRecordingsResponse"}}},"description":"ListRecordingsResponse"},"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":"List recordings","tags":["product:video"]}},"/video/call/{type}/{id}/report":{"get":{"description":"\n","operationId":"GetCallReport","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"query","name":"session_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCallReportResponse"}}},"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":"Get call report","tags":["product:video"]}},"/video/call/{type}/{id}/rtmp_broadcasts":{"post":{"description":"Starts RTMP broadcasts for the provided RTMP destinations\n","operationId":"StartRTMPBroadcasts","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRTMPBroadcastsRequest"}}},"description":"StartRTMPBroadcastsRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRTMPBroadcastsResponse"}}},"description":"StartRTMPBroadcastsResponse"},"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":"Start RTMP broadcasts","tags":["product:video"]}},"/video/call/{type}/{id}/rtmp_broadcasts/stop":{"post":{"description":"Stop all RTMP broadcasts for the provided call\n","operationId":"StopAllRTMPBroadcasts","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopAllRTMPBroadcastsResponse"}}},"description":"StopAllRTMPBroadcastsResponse"},"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":"Stop all RTMP broadcasts for a call","tags":["product:video"]}},"/video/call/{type}/{id}/rtmp_broadcasts/{name}/stop":{"post":{"description":"Stop RTMP broadcasts for the provided RTMP destinations\n","operationId":"StopRTMPBroadcast","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopRTMPBroadcastsRequest"}}},"description":"StopRTMPBroadcastsRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopRTMPBroadcastsResponse"}}},"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":"Stop RTMP broadcasts","tags":["product:video"]}},"/video/call/{type}/{id}/start_broadcasting":{"post":{"description":"Starts HLS broadcasting\n","operationId":"StartHLSBroadcasting","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartHLSBroadcastingResponse"}}},"description":"StartHLSBroadcastingResponse"},"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":"Start HLS broadcasting","tags":["product:video"]}},"/video/call/{type}/{id}/start_closed_captions":{"post":{"description":"Starts closed captions\n","operationId":"StartClosedCaptions","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartClosedCaptionsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartClosedCaptionsResponse"}}},"description":"Successful 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":"Start closed captions","tags":["product:video"]}},"/video/call/{type}/{id}/start_frame_recording":{"post":{"description":"Starts frame by frame recording\n\nSends events:\n- call.frame_recording_started\n","operationId":"StartFrameRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartFrameRecordingRequest"}}},"description":"StartFrameRecordingRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartFrameRecordingResponse"}}},"description":"StartFrameRecordingResponse"},"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":"Start frame recording","tags":["product:video"]}},"/video/call/{type}/{id}/start_recording":{"post":{"description":"Starts recording\n\nSends events:\n- call.recording_started\n","operationId":"StartRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRecordingRequest"}}},"description":"StartRecordingRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRecordingResponse"}}},"description":"StartRecordingResponse"},"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":"Start recording","tags":["product:video"]}},"/video/call/{type}/{id}/start_transcription":{"post":{"description":"Starts transcription\n","operationId":"StartTranscription","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartTranscriptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartTranscriptionResponse"}}},"description":"StartTranscriptionResponse"},"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":"Start transcription","tags":["product:video"]}},"/video/call/{type}/{id}/stop_broadcasting":{"post":{"description":"Stops HLS broadcasting\n","operationId":"StopHLSBroadcasting","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopHLSBroadcastingResponse"}}},"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":"Stop HLS broadcasting","tags":["product:video"]}},"/video/call/{type}/{id}/stop_closed_captions":{"post":{"description":"Stops closed captions\n\nSends events:\n- call.transcription_stopped\n","operationId":"StopClosedCaptions","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopClosedCaptionsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopClosedCaptionsResponse"}}},"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":"Stop closed captions","tags":["product:video"]}},"/video/call/{type}/{id}/stop_frame_recording":{"post":{"description":"Stops frame recording\n\nSends events:\n- call.frame_recording_stopped\n","operationId":"StopFrameRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopFrameRecordingResponse"}}},"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":"Stop frame recording","tags":["product:video"]}},"/video/call/{type}/{id}/stop_live":{"post":{"description":"\n\nSends events:\n- call.updated\n","operationId":"StopLive","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopLiveRequest"}}},"description":"StopLiveRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopLiveResponse"}}},"description":"StopLiveResponse"},"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":"Set call as not live","tags":["product:video"]}},"/video/call/{type}/{id}/stop_recording":{"post":{"description":"Stops recording\n\nSends events:\n- call.recording_stopped\n","operationId":"StopRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopRecordingResponse"}}},"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":"Stop recording","tags":["product:video"]}},"/video/call/{type}/{id}/stop_transcription":{"post":{"description":"Stops transcription\n\nSends events:\n- call.transcription_stopped\n","operationId":"StopTranscription","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopTranscriptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopTranscriptionResponse"}}},"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":"Stop transcription","tags":["product:video"]}},"/video/call/{type}/{id}/transcriptions":{"get":{"description":"Lists transcriptions\n","operationId":"ListTranscriptions","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTranscriptionsResponse"}}},"description":"ListTranscriptionsResponse"},"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":"List transcriptions","tags":["product:video"]}},"/video/call/{type}/{id}/unblock":{"post":{"description":"Removes the block for a user on a call. The user will be able to join the call again.\n\nSends events:\n- call.unblocked_user\n","operationId":"UnblockUser","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUserRequest"}}},"description":"UnblockUserRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUserResponse"}}},"description":"UnblockUserResponse"},"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":"Unblocks user on a call","tags":["product:video"]}},"/video/call/{type}/{id}/unpin":{"post":{"description":"Unpins a track for all users in the call.\n","operationId":"VideoUnpin","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnpinRequest"}}},"description":"UnpinRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnpinResponse"}}},"description":"UnpinResponse"},"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":"Unpin","tags":["product:video"]}},"/video/call/{type}/{id}/user_permissions":{"post":{"description":"Updates user permissions\n\nSends events:\n- call.permissions_updated\n","operationId":"UpdateUserPermissions","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"005.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"005.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUserPermissionsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUserPermissionsResponse"}}},"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":"Update user permissions","tags":["product:video"]}},"/video/call/{type}/{id}/{session}/recordings/{filename}":{"delete":{"description":"Deletes recording\n","operationId":"DeleteRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"path","name":"session","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"003"}},{"in":"path","name":"filename","required":true,"schema":{"maxLength":256,"type":"string","writeOnly":true,"x-stream-index":"004"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteRecordingResponse"}}},"description":"DeleteRecordingResponse"},"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":"Delete recording","tags":["product:video"]}},"/video/call/{type}/{id}/{session}/transcriptions/{filename}":{"delete":{"description":"Deletes transcription\n","operationId":"DeleteTranscription","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"path","name":"session","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"003"}},{"in":"path","name":"filename","required":true,"schema":{"maxLength":256,"type":"string","writeOnly":true,"x-stream-index":"004"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteTranscriptionResponse"}}},"description":"DeleteTranscriptionResponse"},"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":"Delete transcription","tags":["product:video"]}},"/video/calls":{"post":{"description":"Query calls with filter query\n","operationId":"QueryCalls","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallsRequest"}}},"description":"QueryCallsRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallsResponse"}}},"description":"QueryCallsResponse"},"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":"Query call","tags":["product:video"]}},"/video/calltypes":{"get":{"description":"\n","operationId":"ListCallTypes","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListCallTypeResponse"}}},"description":"ListCallTypeResponse"},"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":"List Call Type","tags":["product:video"]},"post":{"description":"\n","operationId":"CreateCallType","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCallTypeRequest"}}},"description":"CreateCallTypeRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCallTypeResponse"}}},"description":"CreateCallTypeResponse"},"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":"Create Call Type","tags":["product:video"]}},"/video/calltypes/{name}":{"delete":{"description":"\n","operationId":"DeleteCallType","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete Call Type","tags":["product:video"]},"get":{"description":"\n","operationId":"GetCallType","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCallTypeResponse"}}},"description":"GetCallTypeResponse"},"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":"Get Call Type","tags":["product:video"]},"put":{"description":"\n","operationId":"UpdateCallType","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallTypeRequest"}}},"description":"UpdateCallTypeRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallTypeResponse"}}},"description":"UpdateCallTypeResponse"},"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":"Update Call Type","tags":["product:video"]}},"/video/devices":{"delete":{"description":"Deletes one device\n","operationId":"DeleteDevice","parameters":[{"in":"query","name":"id","required":true,"schema":{"description":"Device ID to delete","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"user_id","schema":{"description":"**Server-side only**. User ID which server acts upon","title":"User ID","type":"string","writeOnly":true,"x-stream-index":"002.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete device","tags":["product:video"]},"get":{"description":"Returns all available devices\n","operationId":"ListDevices","parameters":[{"in":"query","name":"user_id","schema":{"description":"**Server-side only**. User ID which server acts upon","title":"User ID","type":"string","writeOnly":true,"x-stream-index":"001.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDevicesResponse"}}},"description":"ListDevicesResponse"},"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":"List devices","tags":["product:video"]},"post":{"description":"Adds a new device to a user, if the same device already exists the call will have no effect\n","operationId":"CreateDevice","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDeviceRequest"}}},"description":"CreateDeviceRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Create device","tags":["product:video"]}},"/video/edges":{"get":{"description":"Returns the list of all edges available for video calls.\n","operationId":"GetEdges","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetEdgesResponse"}}},"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":"Get Edges","tags":["product:video"]}},"/video/external_storage":{"get":{"description":"Lists external storage\n","operationId":"ListExternalStorage","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListExternalStorageResponse"}}},"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":"List external storage","tags":["product:video"]},"post":{"description":"Creates new external storage\n","operationId":"CreateExternalStorage","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateExternalStorageRequest"}}},"description":"CreateExternalStorageRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateExternalStorageResponse"}}},"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":"Create external storage","tags":["product:video"]}},"/video/external_storage/{name}":{"delete":{"description":"Deletes external storage\n","operationId":"DeleteExternalStorage","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteExternalStorageResponse"}}},"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":"Delete external storage","tags":["product:video"]},"put":{"description":"\n","operationId":"UpdateExternalStorage","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateExternalStorageRequest"}}},"description":"ExternalStorageRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateExternalStorageResponse"}}},"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":"Update External Storage","tags":["product:video"]}},"/video/external_storage/{name}/check":{"get":{"description":"\n","operationId":"CheckExternalStorage","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckExternalStorageResponse"}}},"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":"Check External Storage","tags":["product:video"]}},"/video/guest":{"post":{"description":"\n","operationId":"CreateGuest","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGuestRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGuestResponse"}}},"description":"Successful 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":"Create Guest","tags":["product:video"]}},"/video/stats":{"post":{"description":"\n","operationId":"QueryAggregateCallStats","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryAggregateCallStatsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryAggregateCallStatsResponse"}}},"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":"Query Aggregate call Stats","tags":["product:video"]}}},"security":[{"JWT":[],"api_key":[],"stream-auth-type":[]},{"api_key":[],"stream-auth-type":[]}],"servers":[{"description":"Stream API","url":"https://chat.stream-io-api.com"}]} \ No newline at end of file +{"components":{"schemas":{"APIError":{"nullable":true,"properties":{"StatusCode":{"description":"Response HTTP status code","format":"int32","title":"Status code","type":"integer","x-stream-index":"004"},"code":{"description":"API error code","format":"int32","title":"Code","type":"integer","x-stream-index":"001"},"details":{"description":"Additional error-specific information","items":{"type":"integer"},"title":"Details","type":"array","x-stream-index":"007"},"duration":{"description":"Request duration","title":"Duration","type":"string","x-stream-index":"005"},"exception_fields":{"additionalProperties":{"type":"string"},"description":"Additional error info","title":"Exception fields","type":"object","x-stream-index":"003"},"message":{"description":"Message describing an error","title":"Message","type":"string","x-stream-index":"002"},"more_info":{"description":"URL with additional information","title":"More info","type":"string","x-stream-index":"006"},"unrecoverable":{"description":"Flag that indicates if the error is unrecoverable, requests that return unrecoverable errors should not be retried, this error only applies to the request that caused it","title":"Unrecoverable","type":"boolean","x-stream-index":"008"}},"required":["code","message","StatusCode","duration","more_info","details"],"title":"Error response","type":"object"},"APNS":{"properties":{"body":{"type":"string","x-stream-index":"002"},"content-available":{"format":"int32","type":"integer","x-stream-index":"004"},"data":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"mutable-content":{"format":"int32","type":"integer","x-stream-index":"005"},"sound":{"type":"string","x-stream-index":"003"},"title":{"type":"string","x-stream-index":"001"}},"type":"object"},"ActiveCallsBitrateStats":{"properties":{"p10":{"format":"float","type":"number","x-stream-index":"001"},"p50":{"format":"float","type":"number","x-stream-index":"002"}},"required":["p10","p50"],"type":"object"},"ActiveCallsFPSStats":{"properties":{"p05":{"format":"float","type":"number","x-stream-index":"001"},"p10":{"format":"float","type":"number","x-stream-index":"002"},"p50":{"format":"float","type":"number","x-stream-index":"003"},"p90":{"format":"float","type":"number","x-stream-index":"004"}},"required":["p05","p10","p50","p90"],"type":"object"},"ActiveCallsLatencyStats":{"properties":{"p50":{"format":"float","type":"number","x-stream-index":"001"},"p90":{"format":"float","type":"number","x-stream-index":"002"}},"required":["p50","p90"],"type":"object"},"ActiveCallsMetrics":{"properties":{"join_call_api":{"$ref":"#/components/schemas/JoinCallAPIMetrics","x-stream-index":"001"},"publishers":{"$ref":"#/components/schemas/PublishersMetrics","x-stream-index":"002"},"subscribers":{"$ref":"#/components/schemas/SubscribersMetrics","x-stream-index":"003"}},"type":"object"},"ActiveCallsResolutionStats":{"properties":{"p10":{"format":"float","type":"number","x-stream-index":"001"},"p50":{"format":"float","type":"number","x-stream-index":"002"}},"required":["p10","p50"],"type":"object"},"ActiveCallsSummary":{"properties":{"active_calls":{"format":"int32","type":"integer","x-stream-index":"001"},"active_publishers":{"format":"int32","type":"integer","x-stream-index":"002"},"active_subscribers":{"format":"int32","type":"integer","x-stream-index":"003"},"participants":{"format":"int32","type":"integer","x-stream-index":"004"}},"required":["active_calls","active_publishers","active_subscribers","participants"],"type":"object"},"AsyncExportChannelsEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"003.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.007"},"finished_at":{"format":"date-time","type":"string","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"string","x-stream-index":"003.004"},"started_at":{"format":"date-time","type":"string","x-stream-index":"002.002"},"task_id":{"type":"string","x-stream-index":"002.001"},"type":{"default":"export.channels.success","type":"string","x-stream-index":"003.002"},"url":{"type":"string","x-stream-index":"001"}},"required":["url","task_id","started_at","finished_at","type","created_at","custom"],"title":"AsyncExportChannelsEvent","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"},"AsyncExportErrorEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"003.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.007"},"error":{"type":"string","x-stream-index":"001"},"finished_at":{"format":"date-time","type":"string","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"string","x-stream-index":"003.004"},"started_at":{"format":"date-time","type":"string","x-stream-index":"002.002"},"task_id":{"type":"string","x-stream-index":"002.001"},"type":{"default":"export.users.error","type":"string","x-stream-index":"003.002"}},"required":["error","task_id","started_at","finished_at","type","created_at","custom"],"title":"AsyncExportErrorEvent","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"},"AsyncExportUsersEvent":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"003.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"003.007"},"finished_at":{"format":"date-time","type":"string","x-stream-index":"002.003"},"received_at":{"format":"date-time","type":"string","x-stream-index":"003.004"},"started_at":{"format":"date-time","type":"string","x-stream-index":"002.002"},"task_id":{"type":"string","x-stream-index":"002.001"},"type":{"default":"export.users.success","type":"string","x-stream-index":"003.002"},"url":{"type":"string","x-stream-index":"001"}},"required":["url","task_id","started_at","finished_at","type","created_at","custom"],"title":"AsyncExportUsersEvent","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"},"AudioSettingsRequest":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"001"},"default_device":{"enum":["speaker","earpiece"],"type":"string","x-stream-index":"006"},"mic_default_on":{"type":"boolean","x-stream-index":"004"},"noise_cancellation":{"$ref":"#/components/schemas/NoiseCancellationSettings","x-stream-index":"007"},"opus_dtx_enabled":{"type":"boolean","x-stream-index":"002"},"redundant_coding_enabled":{"type":"boolean","x-stream-index":"003"},"speaker_default_on":{"type":"boolean","x-stream-index":"005"}},"required":["default_device"],"type":"object"},"AudioSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"001"},"default_device":{"enum":["speaker","earpiece"],"type":"string","x-stream-index":"006"},"mic_default_on":{"type":"boolean","x-stream-index":"004"},"noise_cancellation":{"$ref":"#/components/schemas/NoiseCancellationSettings","x-stream-index":"007"},"opus_dtx_enabled":{"type":"boolean","x-stream-index":"002"},"redundant_coding_enabled":{"type":"boolean","x-stream-index":"003"},"speaker_default_on":{"type":"boolean","x-stream-index":"005"}},"required":["access_request_enabled","opus_dtx_enabled","redundant_coding_enabled","mic_default_on","speaker_default_on","default_device"],"type":"object"},"AzureRequest":{"description":"Config for creating Azure Blob Storage storage","properties":{"abs_account_name":{"description":"The account name","title":"AccountName","type":"string","x-stream-index":"001"},"abs_client_id":{"description":"The client id","title":"ClientID","type":"string","x-stream-index":"003"},"abs_client_secret":{"description":"The client secret","title":"ClientSecret","type":"string","x-stream-index":"004"},"abs_tenant_id":{"description":"The tenant id","title":"TenantID","type":"string","x-stream-index":"002"}},"required":["abs_account_name","abs_tenant_id","abs_client_id","abs_client_secret"],"title":"AzureRequest","type":"object"},"BackstageSettingsRequest":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"002"}},"type":"object"},"BackstageSettingsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["enabled"],"type":"object"},"BlockUserRequest":{"description":"BlockUserRequest is the payload for blocking a user.","nullable":true,"properties":{"user_id":{"description":"the user to block","title":"UserID","type":"string","x-stream-index":"003"}},"required":["user_id"],"title":"BlockUserRequest","type":"object"},"BlockUserResponse":{"description":"BlockUserResponse is the payload for blocking a user.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"BlockUserResponse","type":"object"},"BlockedUserEvent":{"description":"This event is sent to call participants to notify when a user is blocked on a call, clients can use this event to show a notification.\nIf the user is the current user, the client should leave the call screen as well","properties":{"blocked_by_user":{"$ref":"#/components/schemas/UserResponse","description":"The user that blocked the user, null if the user was blocked by server-side","title":"Blocked by","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"call.blocked_user","description":"The type of event: \"call.blocked_user\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user that was blocked","title":"User","x-stream-index":"003"}},"required":["type","created_at","call_cid","user"],"title":"BlockedUserEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"Bound":{"properties":{"inclusive":{"type":"boolean","x-stream-index":"002"},"value":{"format":"float","type":"number","x-stream-index":"001"}},"required":["value","inclusive"],"type":"object"},"BroadcastSettingsRequest":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettingsRequest","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettingsRequest","x-stream-index":"003"}},"type":"object"},"BroadcastSettingsResponse":{"description":"BroadcastSettingsResponse is the payload for broadcasting settings","properties":{"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"001"},"hls":{"$ref":"#/components/schemas/HLSSettingsResponse","title":"HLS","x-stream-index":"002"},"rtmp":{"$ref":"#/components/schemas/RTMPSettingsResponse","title":"RTMP","x-stream-index":"003"}},"required":["enabled","hls","rtmp"],"title":"BroadcastSettingsResponse","type":"object"},"BrowserDataResponse":{"properties":{"name":{"type":"string","x-stream-index":"001"},"version":{"type":"string","x-stream-index":"002"}},"type":"object"},"CallAcceptedEvent":{"description":"This event is sent when a user accepts a notification to join a call.","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"call.accepted","description":"The type of event: \"call.accepted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who accepted the call","title":"User","x-stream-index":"004"}},"required":["type","created_at","call_cid","call","user"],"title":"CallAcceptedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallClosedCaption":{"description":"CallClosedCaption represents a closed caption of a call.","properties":{"end_time":{"format":"date-time","title":"The end time of the closed caption.","type":"string","x-stream-index":"003"},"speaker_id":{"title":"The speaker ID of the closed caption.","type":"string","x-stream-index":"004"},"start_time":{"format":"date-time","title":"The start time of the closed caption.","type":"string","x-stream-index":"002"},"text":{"title":"The text of the closed caption.","type":"string","x-stream-index":"001"},"user":{"$ref":"#/components/schemas/UserResponse","title":"The full user for the closed caption.","x-stream-index":"005"}},"required":["text","start_time","end_time","speaker_id","user"],"title":"CallClosedCaption","type":"object"},"CallClosedCaptionsFailedEvent":{"description":"This event is sent when call closed captions has failed","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"call.closed_captions_failed","description":"The type of event: \"call.closed_captions_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallClosedCaptionsFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallClosedCaptionsStartedEvent":{"description":"This event is sent when call closed caption has started","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"call.closed_captions_started","description":"The type of event: \"call.closed_captions_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallClosedCaptionsStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallClosedCaptionsStoppedEvent":{"description":"This event is sent when call closed captions has stopped","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"call.closed_captions_stopped","description":"The type of event: \"call.transcription_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallClosedCaptionsStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallCreatedEvent":{"description":"This event is sent when a call is created. Clients receiving this event should check if the ringing\nfield is set to true and if so, show the call screen","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"members":{"description":"the members added to this call","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"004"},"type":{"default":"call.created","description":"The type of event: \"call.created\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","members"],"title":"CallCreatedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallDeletedEvent":{"description":"This event is sent when a call is deleted. Clients receiving this event should leave the call screen","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"call.deleted","description":"The type of event: \"call.deleted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call"],"title":"CallDeletedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallDurationReport":{"properties":{"histogram":{"items":{"$ref":"#/components/schemas/ReportByHistogramBucket"},"type":"array","x-stream-index":"001"}},"required":["histogram"],"type":"object"},"CallDurationReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateCallDurationReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"CallEndedEvent":{"description":"This event is sent when a call is mark as ended for all its participants. Clients receiving this event should leave the call screen","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"reason":{"description":"The reason why the call ended, if available","title":"CallEndedReason","type":"string","x-stream-index":"005"},"type":{"default":"call.ended","description":"The type of event: \"call.ended\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who ended the call, null if the call was ended by the server","title":"User","x-stream-index":"004"}},"required":["type","created_at","call_cid","call"],"title":"CallEndedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallFrameRecordingFailedEvent":{"description":"This event is sent when frame recording has failed","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.frame_recording_failed","description":"The type of event: \"call.frame_recording_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","egress_id"],"title":"CallFrameRecordingFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallFrameRecordingFrameReadyEvent":{"description":"This event is sent when a frame is captured from a call","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"captured_at":{"description":"The time the frame was captured","format":"date-time","title":"CapturedAt","type":"string","x-stream-index":"006"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"008"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"track_type":{"description":"The type of the track frame was captured from (TRACK_TYPE_VIDEO|TRACK_TYPE_SCREEN_SHARE)","title":"TrackType","type":"string","x-stream-index":"004"},"type":{"default":"call.frame_recording_ready","description":"The type of event: \"call.frame_recording_ready\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"url":{"description":"The URL of the frame","title":"URL","type":"string","x-stream-index":"005"},"users":{"additionalProperties":{"$ref":"#/components/schemas/UserResponse"},"description":"The users in the frame","title":"Users","type":"object","x-stream-index":"007"}},"required":["type","created_at","call_cid","session_id","track_type","url","captured_at","users","egress_id"],"title":"CallFrameRecordingFrameReadyEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallFrameRecordingStartedEvent":{"description":"This event is sent when frame recording has started","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.frame_recording_started","description":"The type of event: \"call.frame_recording_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","egress_id"],"title":"CallFrameRecordingStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallFrameRecordingStoppedEvent":{"description":"This event is sent when frame recording has stopped","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.frame_recording_stopped","description":"The type of event: \"call.frame_recording_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","egress_id"],"title":"CallFrameRecordingStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallHLSBroadcastingFailedEvent":{"description":"This event is sent when HLS broadcasting has failed","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"call.hls_broadcasting_failed","description":"The type of event: \"call.hls_broadcasting_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallHLSBroadcastingFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallHLSBroadcastingStartedEvent":{"description":"This event is sent when HLS broadcasting has started","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"hls_playlist_url":{"type":"string","x-stream-index":"004"},"type":{"default":"call.hls_broadcasting_started","description":"The type of event: \"call.hls_broadcasting_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","hls_playlist_url"],"title":"CallHLSBroadcastingStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallHLSBroadcastingStoppedEvent":{"description":"This event is sent when HLS broadcasting has stopped","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"call.hls_broadcasting_stopped","description":"The type of event: \"call.hls_broadcasting_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid"],"title":"CallHLSBroadcastingStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallIngressResponse":{"description":"CallIngressResponse is the payload for ingress settings","properties":{"rtmp":{"$ref":"#/components/schemas/RTMPIngress","title":"RTMP","x-stream-index":"001"}},"required":["rtmp"],"title":"CallIngressResponse","type":"object"},"CallLiveStartedEvent":{"description":"This event is sent when a call is started. Clients receiving this event should start the call.","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"call.live_started","description":"The type of event: \"call.live_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call"],"title":"CallLiveStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMemberAddedEvent":{"description":"This event is sent when one or more members are added to a call","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"members":{"description":"the members added to this call","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"004"},"type":{"default":"call.member_added","description":"The type of event: \"call.member_added\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","members"],"title":"CallMemberAddedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMemberRemovedEvent":{"description":"This event is sent when one or more members are removed from a call","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"members":{"description":"the list of member IDs removed from the call","items":{"type":"string"},"title":"Members","type":"array","x-stream-index":"004"},"type":{"default":"call.member_removed","description":"The type of event: \"call.member_removed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","members"],"title":"CallMemberRemovedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMemberUpdatedEvent":{"description":"This event is sent when one or more members are updated","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"members":{"description":"The list of members that were updated","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"004"},"type":{"default":"call.member_updated","description":"The type of event: \"call.member_updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","members"],"title":"CallMemberUpdatedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMemberUpdatedPermissionEvent":{"description":"This event is sent when one or more members get its role updated","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"capabilities_by_role":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"The capabilities by role for this call","title":"CapabilitiesByRole","type":"object","x-stream-index":"004"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"members":{"description":"The list of members that were updated","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"005"},"type":{"default":"call.member_updated_permission","description":"The type of event: \"call.member_added\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","capabilities_by_role","members"],"title":"CallMemberUpdatedPermissionEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallMissedEvent":{"description":"This event is sent to call members who did not accept/reject/join the call to notify they missed the call","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"members":{"description":"List of members who missed the call","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"005"},"notify_user":{"type":"boolean","x-stream-index":"007"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.missed","description":"The type of event: \"call.notification\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The caller from whom the call was missed","title":"User","x-stream-index":"006"}},"required":["type","created_at","call_cid","session_id","call","members","user","notify_user"],"title":"CallMissedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallModerationBlurEvent":{"properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"type":{"default":"call.moderation_blur","type":"string","x-stream-index":"001.001"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["type","created_at","call_cid","user_id","custom"],"title":"CallModerationBlurEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallModerationWarningEvent":{"properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"005"},"message":{"type":"string","x-stream-index":"004"},"type":{"default":"call.moderation_warning","type":"string","x-stream-index":"001.001"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["type","created_at","call_cid","user_id","message","custom"],"title":"CallModerationWarningEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallNotificationEvent":{"description":"This event is sent to all call members to notify they are getting called","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"members":{"description":"Call members","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"005"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.notification","description":"The type of event: \"call.notification\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user that sent the call notification","title":"User","x-stream-index":"006"}},"required":["type","created_at","call_cid","session_id","call","members","user"],"title":"CallNotificationEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallParticipantCountReport":{"properties":{"histogram":{"items":{"$ref":"#/components/schemas/ReportByHistogramBucket"},"type":"array","x-stream-index":"001"}},"required":["histogram"],"type":"object"},"CallParticipantCountReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateCallParticipantCountReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"CallParticipantResponse":{"properties":{"joined_at":{"format":"date-time","type":"string","x-stream-index":"004"},"role":{"type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"},"user_session_id":{"type":"string","x-stream-index":"002"}},"required":["user","user_session_id","role","joined_at"],"type":"object"},"CallReactionEvent":{"description":"This event is sent when a reaction is sent in a call, clients should use this to show the reaction in the call screen","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"reaction":{"$ref":"#/components/schemas/ReactionResponse","description":"the reaction object sent by the user on the call","title":"reaction","x-stream-index":"003"},"type":{"default":"call.reaction_new","description":"The type of event: \"call.reaction_new\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","reaction"],"title":"CallReactionEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRecording":{"description":"CallRecording represents a recording of a call.","properties":{"end_time":{"format":"date-time","title":"The end time of the recording.","type":"string","x-stream-index":"004"},"filename":{"title":"The filename of the recording.","type":"string","x-stream-index":"001"},"session_id":{"title":"The session ID of the recording.","type":"string","x-stream-index":"005"},"start_time":{"format":"date-time","title":"The start time of the recording.","type":"string","x-stream-index":"003"},"url":{"title":"The URL of the recording.","type":"string","x-stream-index":"002"}},"required":["filename","url","start_time","end_time","session_id"],"title":"CallRecording","type":"object"},"CallRecordingFailedEvent":{"description":"This event is sent when call recording has failed","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"003"},"type":{"default":"call.recording_failed","description":"The type of event: \"call.recording_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","egress_id"],"title":"CallRecordingFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRecordingReadyEvent":{"description":"This event is sent when call recording is ready","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"call_recording":{"$ref":"#/components/schemas/CallRecording","description":"The call recording object","title":"CallRecording","x-stream-index":"003"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.recording_ready","description":"The type of event: \"call.recording_ready\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call_recording","egress_id"],"title":"CallRecordingReadyEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRecordingStartedEvent":{"description":"This event is sent when call recording has started","properties":{"call_cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"002.002"},"egress_id":{"type":"string","x-stream-index":"001"},"type":{"default":"call.recording_started","description":"The type of event: \"call.recording_started\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001"}},"required":["egress_id","type","created_at","call_cid"],"title":"CallRecordingStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRecordingStoppedEvent":{"description":"This event is sent when call recording has stopped","properties":{"call_cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"002.002"},"egress_id":{"type":"string","x-stream-index":"001"},"type":{"default":"call.recording_stopped","description":"The type of event: \"call.recording_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001"}},"required":["egress_id","type","created_at","call_cid"],"title":"CallRecordingStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"recording","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRejectedEvent":{"description":"This event is sent when a user rejects a notification to join a call.","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"reason":{"description":"Provides information about why the call was rejected. You can provide any value, but the Stream API and SDKs use these default values: rejected, cancel, timeout and busy","title":"Reason","type":"string","x-stream-index":"005"},"type":{"default":"call.rejected","description":"The type of event: \"call.rejected\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who rejected the call","title":"User","x-stream-index":"004"}},"required":["type","created_at","call_cid","call","user"],"title":"CallRejectedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallReportResponse":{"properties":{"ended_at":{"format":"date-time","type":"string","x-stream-index":"003"},"score":{"format":"float","type":"number","x-stream-index":"001"},"started_at":{"format":"date-time","type":"string","x-stream-index":"002"}},"required":["score"],"type":"object"},"CallRequest":{"description":"CallRequest is the payload for creating a call.","properties":{"channel_cid":{"type":"string","x-stream-index":"009"},"created_by":{"$ref":"#/components/schemas/UserRequest","title":"The user that create this call","x-stream-index":"002"},"created_by_id":{"title":"The id of the user that create this call","type":"string","x-stream-index":"003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"members":{"items":{"$ref":"#/components/schemas/MemberRequest"},"maximum":100,"type":"array","x-stream-index":"005"},"settings_override":{"$ref":"#/components/schemas/CallSettingsRequest","x-stream-index":"006"},"starts_at":{"format":"date-time","type":"string","x-stream-index":"007"},"team":{"type":"string","x-stream-index":"001"},"video":{"type":"boolean","x-stream-index":"008"}},"title":"CallRequest","type":"object"},"CallResponse":{"description":"Represents a call","properties":{"backstage":{"type":"boolean","x-stream-index":"016"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"018"},"captioning":{"type":"boolean","x-stream-index":"013"},"channel_cid":{"type":"string","x-stream-index":"024"},"cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"004"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"009"},"created_by":{"$ref":"#/components/schemas/UserResponse","description":"The user that created the call","title":"Created By","x-stream-index":"007"},"current_session_id":{"type":"string","x-stream-index":"005"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"008"},"egress":{"$ref":"#/components/schemas/EgressResponse","x-stream-index":"021"},"ended_at":{"description":"Date/time when the call ended","format":"date-time","title":"Ended At","type":"string","x-stream-index":"014"},"id":{"description":"Call ID","title":"ID","type":"string","x-stream-index":"003"},"ingress":{"$ref":"#/components/schemas/CallIngressResponse","x-stream-index":"019"},"join_ahead_time_seconds":{"format":"int32","type":"integer","x-stream-index":"023"},"recording":{"type":"boolean","x-stream-index":"011"},"session":{"$ref":"#/components/schemas/CallSessionResponse","x-stream-index":"020"},"settings":{"$ref":"#/components/schemas/CallSettingsResponse","x-stream-index":"017"},"starts_at":{"description":"Date/time when the call will start","format":"date-time","title":"Starts At","type":"string","x-stream-index":"015"},"team":{"type":"string","x-stream-index":"006"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailResponse","x-stream-index":"022"},"transcribing":{"type":"boolean","x-stream-index":"012"},"type":{"description":"The type of call","title":"Type","type":"string","x-stream-index":"002"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"010"}},"required":["type","id","cid","current_session_id","created_by","custom","created_at","updated_at","recording","transcribing","captioning","backstage","settings","blocked_user_ids","ingress","egress"],"title":"CallResponse","type":"object"},"CallRingEvent":{"description":"This event is sent to all call members to notify they are getting called","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"005"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"members":{"description":"Call members","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"006"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.ring","description":"The type of event: \"call.notification\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user that sent the call notification","title":"User","x-stream-index":"007"},"video":{"type":"boolean","x-stream-index":"008"}},"required":["type","created_at","call_cid","session_id","call","members","user","video"],"title":"CallRingEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"ring","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRtmpBroadcastFailedEvent":{"description":"This event is sent when a call RTMP broadcast has failed","properties":{"call_cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"002.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.002"},"name":{"description":"Name of the given RTMP broadcast","title":"Name","type":"string","x-stream-index":"003"},"type":{"default":"call.rtmp_broadcast_failed","description":"The type of event: \"call.rtmp_broadcast_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","name"],"title":"CallRtmpBroadcastFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRtmpBroadcastStartedEvent":{"description":"This event is sent when RTMP broadcast has started","properties":{"call_cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"002.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.002"},"name":{"description":"Name of the given RTMP broadcast","title":"Name","type":"string","x-stream-index":"003"},"type":{"default":"call.rtmp_broadcast_started","description":"The type of event: \"call.rtmp_broadcast_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","name"],"title":"CallRtmpBroadcastStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallRtmpBroadcastStoppedEvent":{"description":"This event is sent when RTMP broadcast has stopped","properties":{"call_cid":{"description":"The unique identifier for a call (\u003ctype\u003e:\u003cid\u003e)","title":"CID","type":"string","x-stream-index":"002.001"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.002"},"name":{"description":"Name of the given RTMP broadcast","title":"Name","type":"string","x-stream-index":"003"},"type":{"default":"call.rtmp_broadcast_stopped","description":"The type of event: \"call.rtmp_broadcast_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","name"],"title":"CallRtmpBroadcastStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"streaming","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSessionEndedEvent":{"description":"This event is sent when a call session ends","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_ended","description":"The type of event: \"call.session_ended\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","call"],"title":"CallSessionEndedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSessionParticipantCountsUpdatedEvent":{"description":"This event is sent when the participant counts in a call session are updated","properties":{"anonymous_participant_count":{"format":"int32","type":"integer","x-stream-index":"005"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"participants_count_by_role":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"004"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_participant_count_updated","description":"The type of event: \"call.session_participant_count_updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","participants_count_by_role","anonymous_participant_count"],"title":"CallSessionParticipantCountsUpdatedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSessionParticipantJoinedEvent":{"description":"This event is sent when a participant joins a call session","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"participant":{"$ref":"#/components/schemas/CallParticipantResponse","description":"The participant that joined the session","title":"Participant","x-stream-index":"004"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_participant_joined","description":"The type of event: \"call.session_participant_joined\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","participant"],"title":"CallSessionParticipantJoinedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSessionParticipantLeftEvent":{"description":"This event is sent when a participant leaves a call session","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"duration_seconds":{"description":"The duration participant was in the session in seconds","format":"int32","title":"Duration","type":"integer","x-stream-index":"005"},"participant":{"$ref":"#/components/schemas/CallParticipantResponse","description":"The participant that left the session","title":"Participant","x-stream-index":"004"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_participant_left","description":"The type of event: \"call.session_participant_left\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","participant","duration_seconds"],"title":"CallSessionParticipantLeftEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSessionResponse":{"properties":{"accepted_by":{"additionalProperties":{"format":"date-time","type":"string"},"type":"object","x-stream-index":"008"},"anonymous_participant_count":{"format":"int32","type":"integer","x-stream-index":"006"},"ended_at":{"format":"date-time","type":"string","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"live_ended_at":{"format":"date-time","type":"string","x-stream-index":"011"},"live_started_at":{"format":"date-time","type":"string","x-stream-index":"010"},"missed_by":{"additionalProperties":{"format":"date-time","type":"string"},"type":"object","x-stream-index":"009"},"participants":{"items":{"$ref":"#/components/schemas/CallParticipantResponse"},"type":"array","x-stream-index":"004"},"participants_count_by_role":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"005"},"rejected_by":{"additionalProperties":{"format":"date-time","type":"string"},"type":"object","x-stream-index":"007"},"started_at":{"format":"date-time","type":"string","x-stream-index":"002"},"timer_ends_at":{"format":"date-time","type":"string","x-stream-index":"012"}},"required":["id","participants","participants_count_by_role","anonymous_participant_count","rejected_by","accepted_by","missed_by"],"type":"object"},"CallSessionStartedEvent":{"description":"This event is sent when a call session starts","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"004"},"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.session_started","description":"The type of event: \"call.session_started\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id","call"],"title":"CallSessionStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"session","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallSettingsRequest":{"properties":{"audio":{"$ref":"#/components/schemas/AudioSettingsRequest","x-stream-index":"001"},"backstage":{"$ref":"#/components/schemas/BackstageSettingsRequest","x-stream-index":"002"},"broadcasting":{"$ref":"#/components/schemas/BroadcastSettingsRequest","x-stream-index":"010"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordingSettingsRequest","x-stream-index":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettingsRequest","x-stream-index":"003"},"ingress":{"$ref":"#/components/schemas/IngressSettingsRequest","x-stream-index":"014"},"limits":{"$ref":"#/components/schemas/LimitsSettingsRequest","x-stream-index":"012"},"recording":{"$ref":"#/components/schemas/RecordSettingsRequest","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettingsRequest","x-stream-index":"007"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettingsRequest","x-stream-index":"008"},"session":{"$ref":"#/components/schemas/SessionSettingsRequest","x-stream-index":"013"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettingsRequest","x-stream-index":"011"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettingsRequest","x-stream-index":"009"},"video":{"$ref":"#/components/schemas/VideoSettingsRequest","x-stream-index":"004"}},"type":"object"},"CallSettingsResponse":{"properties":{"audio":{"$ref":"#/components/schemas/AudioSettingsResponse","x-stream-index":"001"},"backstage":{"$ref":"#/components/schemas/BackstageSettingsResponse","x-stream-index":"002"},"broadcasting":{"$ref":"#/components/schemas/BroadcastSettingsResponse","x-stream-index":"003"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordingSettingsResponse","x-stream-index":"006"},"geofencing":{"$ref":"#/components/schemas/GeofenceSettingsResponse","x-stream-index":"004"},"ingress":{"$ref":"#/components/schemas/IngressSettingsResponse","x-stream-index":"014"},"limits":{"$ref":"#/components/schemas/LimitsSettingsResponse","x-stream-index":"012"},"recording":{"$ref":"#/components/schemas/RecordSettingsResponse","x-stream-index":"005"},"ring":{"$ref":"#/components/schemas/RingSettingsResponse","x-stream-index":"007"},"screensharing":{"$ref":"#/components/schemas/ScreensharingSettingsResponse","x-stream-index":"008"},"session":{"$ref":"#/components/schemas/SessionSettingsResponse","x-stream-index":"013"},"thumbnails":{"$ref":"#/components/schemas/ThumbnailsSettingsResponse","x-stream-index":"011"},"transcription":{"$ref":"#/components/schemas/TranscriptionSettingsResponse","x-stream-index":"009"},"video":{"$ref":"#/components/schemas/VideoSettingsResponse","x-stream-index":"010"}},"required":["audio","backstage","broadcasting","geofencing","recording","frame_recording","ring","screensharing","transcription","video","thumbnails","limits","session"],"type":"object"},"CallStateResponseFields":{"description":"CallStateResponseFields is the payload for call state response","properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001"},"members":{"description":"List of call members","items":{"$ref":"#/components/schemas/MemberResponse"},"title":"Members","type":"array","x-stream-index":"002"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"004"}},"required":["call","members","own_capabilities","blocked_users"],"title":"CallStateResponseFields","type":"object"},"CallStatsReportReadyEvent":{"description":"This event is sent when the insights report is ready","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.stats_report_ready","description":"The type of event, \"call.report_ready\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","session_id"],"title":"CallStatsReportReadyEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallStatsReportSummaryResponse":{"properties":{"call_cid":{"type":"string","x-stream-index":"001"},"call_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"008"},"call_session_id":{"type":"string","x-stream-index":"002"},"call_status":{"type":"string","x-stream-index":"004"},"created_at":{"format":"date-time","type":"string","x-stream-index":"007"},"first_stats_time":{"format":"date-time","type":"string","x-stream-index":"003"},"min_user_rating":{"format":"int32","type":"integer","x-stream-index":"006"},"quality_score":{"format":"int32","type":"integer","x-stream-index":"005"}},"required":["call_cid","call_session_id","first_stats_time","call_status","call_duration_seconds"],"type":"object"},"CallTranscription":{"description":"CallTranscription represents a transcription of a call.","properties":{"end_time":{"format":"date-time","title":"The end time of the transcription.","type":"string","x-stream-index":"004"},"filename":{"title":"The filename of the transcription.","type":"string","x-stream-index":"001"},"session_id":{"title":"The session ID of the transcription.","type":"string","x-stream-index":"005"},"start_time":{"format":"date-time","title":"The start time of the transcription.","type":"string","x-stream-index":"003"},"url":{"title":"The URL of the transcription.","type":"string","x-stream-index":"002"}},"required":["filename","url","start_time","end_time","session_id"],"title":"CallTranscription","type":"object"},"CallTranscriptionFailedEvent":{"description":"This event is sent when call transcription has failed","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"003"},"error":{"description":"The error message detailing why transcription failed.","title":"string","type":"string","x-stream-index":"004"},"type":{"default":"call.transcription_failed","description":"The type of event: \"call.transcription_failed\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","egress_id"],"title":"CallTranscriptionFailedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallTranscriptionReadyEvent":{"description":"This event is sent when call transcription is ready","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"call_transcription":{"$ref":"#/components/schemas/CallTranscription","description":"The call transcription object","title":"CallTranscription","x-stream-index":"003"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"004"},"type":{"default":"call.transcription_ready","description":"The type of event: \"call.transcription_ready\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call_transcription","egress_id"],"title":"CallTranscriptionReadyEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallTranscriptionStartedEvent":{"description":"This event is sent when call transcription has started","properties":{"call_cid":{"type":"string","x-stream-index":"003.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"002.002"},"egress_id":{"type":"string","x-stream-index":"001"},"type":{"default":"call.transcription_started","description":"The type of event: \"call.transcription_started\" in this case","title":"Event Type","type":"string","x-stream-index":"002.001"}},"required":["egress_id","type","created_at","call_cid"],"title":"CallTranscriptionStartedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallTranscriptionStoppedEvent":{"description":"This event is sent when call transcription has stopped","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"egress_id":{"type":"string","x-stream-index":"003"},"type":{"default":"call.transcription_stopped","description":"The type of event: \"call.transcription_stopped\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","egress_id"],"title":"CallTranscriptionStoppedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallTypeResponse":{"description":"CallTypeResponse is the payload for a call type.","properties":{"created_at":{"description":"the time the call type was created","format":"date-time","title":"CreatedAt","type":"string","x-stream-index":"005"},"external_storage":{"description":"the external storage for the call type","title":"ExternalStorage","type":"string","x-stream-index":"007"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"the permissions granted to each role","title":"Grants","type":"object","x-stream-index":"002"},"name":{"description":"the name of the call type","title":"Name","type":"string","x-stream-index":"001"},"notification_settings":{"$ref":"#/components/schemas/NotificationSettings","description":"the notification settings for the call type","title":"NotificationSettings","x-stream-index":"004"},"settings":{"$ref":"#/components/schemas/CallSettingsResponse","description":"the settings for the call type","title":"Settings","x-stream-index":"003"},"updated_at":{"description":"the time the call type was last updated","format":"date-time","title":"UpdatedAt","type":"string","x-stream-index":"006"}},"required":["name","grants","settings","notification_settings","created_at","updated_at"],"title":"CallTypeResponse","type":"object"},"CallUpdatedEvent":{"description":"This event is sent when a call is updated, clients should use this update the local state of the call.\nThis event also contains the capabilities by role for the call, clients should update the own_capability for the current.","properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"Call object","title":"Call","x-stream-index":"003"},"call_cid":{"type":"string","x-stream-index":"002.001"},"capabilities_by_role":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"The capabilities by role for this call","title":"CapabilitiesByRole","type":"object","x-stream-index":"004"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"call.updated","description":"The type of event: \"call.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","call","capabilities_by_role"],"title":"CallUpdatedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallUserFeedbackSubmittedEvent":{"description":"This event is sent when a user submits feedback for a call.","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"custom":{"additionalProperties":{},"description":"Custom data provided by the user","title":"Custom","type":"object","x-stream-index":"007"},"rating":{"description":"The rating given by the user (1-5)","format":"int32","title":"Rating","type":"integer","x-stream-index":"005"},"reason":{"description":"The reason provided by the user for the rating","title":"Reason","type":"string","x-stream-index":"006"},"sdk":{"type":"string","x-stream-index":"008"},"sdk_version":{"type":"string","x-stream-index":"009"},"session_id":{"description":"Call session ID","title":"Session ID","type":"string","x-stream-index":"003.001"},"type":{"default":"call.user_feedback_submitted","description":"The type of event, \"call.user_feedback\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who submitted the feedback","title":"User","x-stream-index":"004"}},"required":["type","created_at","call_cid","session_id","user","rating"],"title":"CallUserFeedbackSubmittedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallUserMutedEvent":{"description":"This event is sent when a call member is muted","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"from_user_id":{"type":"string","x-stream-index":"003"},"muted_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"type":{"default":"call.user_muted","description":"The type of event: \"call.user_muted\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","from_user_id","muted_user_ids"],"title":"CallUserMutedEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CallsPerDayReport":{"properties":{"count":{"format":"int64","type":"integer","x-stream-index":"001"}},"required":["count"],"type":"object"},"CallsPerDayReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateCallsPerDayReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"ChatActivityStatsResponse":{"properties":{"Messages":{"$ref":"#/components/schemas/MessageStatsResponse","x-stream-index":"001"}},"type":"object"},"CheckExternalStorageResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"file_url":{"type":"string","x-stream-index":"002"}},"required":["duration","file_url"],"title":"Response","type":"object"},"ClientOSDataResponse":{"properties":{"architecture":{"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"version":{"type":"string","x-stream-index":"002"}},"type":"object"},"ClosedCaptionEvent":{"description":"This event is sent when closed captions are being sent in a call, clients should use this to show the closed captions in the call screen","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"closed_caption":{"$ref":"#/components/schemas/CallClosedCaption","description":"The closed caption object","title":"CallClosedCaption","x-stream-index":"003"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"call.closed_caption","description":"The type of event: \"call.closed_caption\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"}},"required":["type","created_at","call_cid","closed_caption"],"title":"ClosedCaptionEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"transcription","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"CollectUserFeedbackRequest":{"nullable":true,"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"009"},"rating":{"format":"int32","maximum":5,"minimum":1,"type":"integer","x-stream-index":"007"},"reason":{"maxLength":1000,"type":"string","x-stream-index":"008"},"sdk":{"maxLength":50,"type":"string","x-stream-index":"005"},"sdk_version":{"maxLength":50,"type":"string","x-stream-index":"006"},"user_session_id":{"maxLength":50,"type":"string","x-stream-index":"004"}},"required":["sdk","sdk_version","rating"],"type":"object"},"CollectUserFeedbackResponse":{"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"},"CountByMinuteResponse":{"nullable":true,"properties":{"count":{"format":"int32","type":"integer","x-stream-index":"002"},"start_ts":{"format":"date-time","type":"string","x-stream-index":"001"}},"required":["start_ts","count"],"type":"object"},"CreateCallTypeRequest":{"description":"Request for creating a call type","nullable":true,"properties":{"external_storage":{"description":"the external storage for the call type","title":"ExternalStorage","type":"string","x-stream-index":"002.004"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"the permissions granted to each role","title":"Grants","type":"object","x-stream-index":"002.001"},"name":{"type":"string","x-stream-index":"001"},"notification_settings":{"$ref":"#/components/schemas/NotificationSettings","description":"the notification settings for the call type","title":"NotificationSettings","x-stream-index":"002.002"},"settings":{"$ref":"#/components/schemas/CallSettingsRequest","description":"the settings for the call type","title":"Settings","x-stream-index":"002.003"}},"required":["name"],"title":"CreateCallTypeRequest","type":"object"},"CreateCallTypeResponse":{"description":"Response for creating a call type","nullable":true,"properties":{"created_at":{"description":"the time the call type was created","format":"date-time","title":"CreatedAt","type":"string","x-stream-index":"001.005"},"duration":{"type":"string","x-stream-index":"002.001"},"external_storage":{"description":"the external storage for the call type","title":"ExternalStorage","type":"string","x-stream-index":"001.007"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"the permissions granted to each role","title":"Grants","type":"object","x-stream-index":"001.002"},"name":{"description":"the name of the call type","title":"Name","type":"string","x-stream-index":"001.001"},"notification_settings":{"$ref":"#/components/schemas/NotificationSettings","description":"the notification settings for the call type","title":"NotificationSettings","x-stream-index":"001.004"},"settings":{"$ref":"#/components/schemas/CallSettingsResponse","description":"the settings for the call type","title":"Settings","x-stream-index":"001.003"},"updated_at":{"description":"the time the call type was last updated","format":"date-time","title":"UpdatedAt","type":"string","x-stream-index":"001.006"}},"required":["name","grants","settings","notification_settings","created_at","updated_at","duration"],"title":"CreateCallTypeResponse","type":"object"},"CreateDeviceRequest":{"description":"Create device request","nullable":true,"properties":{"id":{"description":"Device ID","maxLength":255,"minLength":1,"title":"ID","type":"string","x-stream-index":"001"},"push_provider":{"description":"Push provider","enum":["firebase","apn","huawei","xiaomi"],"title":"PushProvider","type":"string","x-stream-index":"002"},"push_provider_name":{"description":"Push provider name","title":"PushProviderName","type":"string","x-stream-index":"003"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"005.002"},"user_id":{"description":"**Server-side only**. User ID which server acts upon","title":"User ID","type":"string","x-stream-index":"005.001"},"voip_token":{"description":"When true the token is for Apple VoIP push notifications","title":"VoipToken","type":"boolean","x-stream-index":"004"}},"required":["id","push_provider"],"title":"CreateDeviceRequest","type":"object"},"CreateExternalStorageRequest":{"description":"Create external storage","nullable":true,"properties":{"aws_s3":{"$ref":"#/components/schemas/S3Request","description":"Only required if you want to create an Amazon S3 storage","title":"AwsS3","x-stream-index":"003.004"},"azure_blob":{"$ref":"#/components/schemas/AzureRequest","description":"Only required if you want to create an Azure Blob Storage","title":"AzureBlob","x-stream-index":"003.006"},"bucket":{"description":"The name of the bucket on the service provider","title":"Bucket","type":"string","x-stream-index":"003.002"},"gcs_credentials":{"type":"string","x-stream-index":"003.005"},"name":{"description":"The name of the provider, this must be unique","title":"Name","type":"string","x-stream-index":"001"},"path":{"description":"The path prefix to use for storing files","title":"Path","type":"string","x-stream-index":"003.003"},"storage_type":{"description":"The type of storage to use","enum":["s3","gcs","abs"],"title":"StorageType","type":"string","x-stream-index":"003.001"}},"required":["name","storage_type","bucket"],"title":"CreateExternalStorageRequest","type":"object"},"CreateExternalStorageResponse":{"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"},"CreateGuestRequest":{"nullable":true,"properties":{"user":{"$ref":"#/components/schemas/UserRequest","description":"User object which server acts upon","title":"User","x-stream-index":"001"}},"required":["user"],"type":"object"},"CreateGuestResponse":{"nullable":true,"properties":{"access_token":{"description":"the access token to authenticate the user","title":"Access token","type":"string","x-stream-index":"002"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"User object which server acts upon","title":"User","x-stream-index":"001"}},"required":["user","access_token","duration"],"type":"object"},"CustomVideoEvent":{"description":"A custom event, this event is used to send custom events to other participants in the call.","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"003"},"type":{"default":"custom","description":"The type of event, \"custom\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"004"}},"required":["type","created_at","call_cid","custom","user"],"title":"CustomVideoEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"other","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"DailyAggregateCallDurationReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/CallDurationReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateCallParticipantCountReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/CallParticipantCountReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateCallsPerDayReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/CallsPerDayReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateQualityScoreReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/QualityScoreReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateSDKUsageReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/SDKUsageReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DailyAggregateUserFeedbackReportResponse":{"properties":{"date":{"type":"string","x-stream-index":"001"},"report":{"$ref":"#/components/schemas/UserFeedbackReport","x-stream-index":"002"}},"required":["date","report"],"type":"object"},"DeleteCallRequest":{"description":"DeleteCallRequest is the payload for deleting a call.","nullable":true,"properties":{"hard":{"description":"if true the call will be hard deleted along with all related data","title":"Hard","type":"boolean","x-stream-index":"001"}},"title":"DeleteCallRequest","type":"object"},"DeleteCallResponse":{"description":"DeleteCallResponse is the payload for deleting a call.","nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","title":"Call","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"003.001"},"task_id":{"title":"TaskID","type":"string","x-stream-index":"002"}},"required":["call","duration"],"title":"DeleteCallResponse","type":"object"},"DeleteExternalStorageResponse":{"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"},"DeleteRecordingResponse":{"description":"Response for DeleteRecording","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"DeleteRecordingResponse","type":"object"},"DeleteTranscriptionResponse":{"description":"DeleteTranscriptionResponse is the payload for deleting a transcription.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"DeleteTranscriptionResponse","type":"object"},"DeviceDataResponse":{"properties":{"name":{"type":"string","x-stream-index":"001"},"version":{"type":"string","x-stream-index":"002"}},"type":"object"},"DeviceResponse":{"description":"Response for Device","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"004"},"disabled":{"description":"Whether device is disabled or not","title":"Disabled","type":"boolean","x-stream-index":"005"},"disabled_reason":{"description":"Reason explaining why device had been disabled","title":"Reason","type":"string","x-stream-index":"006"},"id":{"description":"Device ID","title":"ID","type":"string","x-stream-index":"003"},"push_provider":{"description":"Push provider","title":"PushProvider","type":"string","x-stream-index":"001"},"push_provider_name":{"description":"Push provider name","title":"PushProviderName","type":"string","x-stream-index":"002"},"user_id":{"description":"User ID","title":"UserID","type":"string","x-stream-index":"008"},"voip":{"description":"When true the token is for Apple VoIP push notifications","title":"Voip","type":"boolean","x-stream-index":"007"}},"required":["push_provider","id","created_at","user_id"],"title":"DeviceResponse","type":"object"},"EdgeResponse":{"properties":{"continent_code":{"type":"string","x-stream-index":"007.003"},"country_iso_code":{"type":"string","x-stream-index":"007.002"},"green":{"format":"int32","type":"integer","x-stream-index":"003"},"id":{"type":"string","x-stream-index":"001"},"latency_test_url":{"type":"string","x-stream-index":"002"},"latitude":{"format":"float","type":"number","x-stream-index":"006.001"},"longitude":{"format":"float","type":"number","x-stream-index":"006.002"},"red":{"format":"int32","type":"integer","x-stream-index":"005"},"subdivision_iso_code":{"type":"string","x-stream-index":"007.001"},"yellow":{"format":"int32","type":"integer","x-stream-index":"004"}},"required":["id","latency_test_url","green","yellow","red","latitude","longitude","subdivision_iso_code","country_iso_code","continent_code"],"type":"object"},"EgressHLSResponse":{"properties":{"playlist_url":{"type":"string","x-stream-index":"001"},"status":{"type":"string","x-stream-index":"002"}},"required":["playlist_url","status"],"type":"object"},"EgressRTMPResponse":{"properties":{"name":{"type":"string","x-stream-index":"001"},"started_at":{"format":"date-time","type":"string","x-stream-index":"004"},"stream_key":{"type":"string","x-stream-index":"003"},"stream_url":{"type":"string","x-stream-index":"002"}},"required":["name","started_at"],"type":"object"},"EgressResponse":{"properties":{"broadcasting":{"type":"boolean","x-stream-index":"001"},"frame_recording":{"$ref":"#/components/schemas/FrameRecordingResponse","x-stream-index":"004"},"hls":{"$ref":"#/components/schemas/EgressHLSResponse","x-stream-index":"002"},"rtmps":{"items":{"$ref":"#/components/schemas/EgressRTMPResponse"},"type":"array","x-stream-index":"003"}},"required":["broadcasting","rtmps"],"type":"object"},"EndCallRequest":{"description":"Request for ending a call","nullable":true,"title":"EndCallRequest","type":"object"},"EndCallResponse":{"description":"Response for ending a call","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"EndCallResponse","type":"object"},"EventNotificationSettings":{"properties":{"apns":{"$ref":"#/components/schemas/APNS","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"fcm":{"$ref":"#/components/schemas/FCM","x-stream-index":"003"}},"type":"object"},"ExternalStorageResponse":{"properties":{"bucket":{"type":"string","x-stream-index":"003"},"name":{"type":"string","x-stream-index":"001"},"path":{"type":"string","x-stream-index":"004"},"type":{"enum":["s3","gcs","abs"],"type":"string","x-stream-index":"002"}},"required":["name","type","bucket","path"],"type":"object"},"FCM":{"properties":{"data":{"additionalProperties":{},"type":"object","x-stream-index":"001"}},"type":"object"},"FrameRecordingResponse":{"properties":{"status":{"type":"string","x-stream-index":"001"}},"required":["status"],"type":"object"},"FrameRecordingSettingsRequest":{"properties":{"capture_interval_in_seconds":{"format":"int32","maximum":60,"minimum":2,"type":"integer","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"},"quality":{"enum":["360p","480p","720p","1080p","1440p"],"type":"string","x-stream-index":"002"}},"required":["mode","capture_interval_in_seconds"],"type":"object"},"FrameRecordingSettingsResponse":{"properties":{"capture_interval_in_seconds":{"format":"int32","maximum":60,"minimum":2,"type":"integer","x-stream-index":"003"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"},"quality":{"type":"string","x-stream-index":"002"}},"required":["mode","capture_interval_in_seconds"],"type":"object"},"GeofenceSettingsRequest":{"properties":{"names":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"type":"object"},"GeofenceSettingsResponse":{"properties":{"names":{"items":{"type":"string"},"type":"array","x-stream-index":"001"}},"required":["names"],"type":"object"},"GetActiveCallsStatusResponse":{"description":"Response containing active calls status information","nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"},"end_time":{"description":"End time of the status period","format":"date-time","title":"time.Time","type":"string","x-stream-index":"003"},"metrics":{"$ref":"#/components/schemas/ActiveCallsMetrics","description":"Detailed metrics","title":"*ActiveCallsMetrics","x-stream-index":"005"},"start_time":{"description":"Start time of the status period","format":"date-time","title":"time.Time","type":"string","x-stream-index":"002"},"summary":{"$ref":"#/components/schemas/ActiveCallsSummary","description":"Summary of active calls","title":"*ActiveCallsSummary","x-stream-index":"004"}},"required":["duration","start_time","end_time"],"title":"GetActiveCallsStatusResponse","type":"object"},"GetCallReportResponse":{"description":"Basic response information","nullable":true,"properties":{"chat_activity":{"$ref":"#/components/schemas/ChatActivityStatsResponse","x-stream-index":"004"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"report":{"$ref":"#/components/schemas/ReportResponse","x-stream-index":"003"},"session_id":{"type":"string","x-stream-index":"002"},"video_reactions":{"items":{"$ref":"#/components/schemas/VideoReactionsResponse"},"type":"array","x-stream-index":"005"}},"required":["duration","session_id","report"],"title":"Response","type":"object"},"GetCallResponse":{"nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001.001"},"duration":{"type":"string","x-stream-index":"002.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001.002"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"001.004"}},"required":["call","members","own_capabilities","blocked_users","duration"],"title":"GetCallResponse","type":"object"},"GetCallTypeResponse":{"nullable":true,"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"001.005"},"duration":{"type":"string","x-stream-index":"002.001"},"external_storage":{"type":"string","x-stream-index":"001.007"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"001.002"},"name":{"type":"string","x-stream-index":"001.001"},"notification_settings":{"$ref":"#/components/schemas/NotificationSettings","x-stream-index":"001.004"},"settings":{"$ref":"#/components/schemas/CallSettingsResponse","x-stream-index":"001.003"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"001.006"}},"required":["name","grants","settings","notification_settings","created_at","updated_at","duration"],"title":"GetCallTypeResponse","type":"object"},"GetEdgesResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"edges":{"items":{"$ref":"#/components/schemas/EdgeResponse"},"type":"array","x-stream-index":"001"}},"required":["edges","duration"],"title":"Response","type":"object"},"GetOrCreateCallRequest":{"nullable":true,"properties":{"data":{"$ref":"#/components/schemas/CallRequest","title":"ReadOnlyData","x-stream-index":"003"},"members_limit":{"format":"int32","maximum":100,"type":"integer","x-stream-index":"007"},"notify":{"description":"if provided it sends a notification event to the members for this call","title":"Notify","type":"boolean","x-stream-index":"005"},"ring":{"description":"if provided it sends a ring event to the members for this call","title":"Ring","type":"boolean","x-stream-index":"004"},"video":{"type":"boolean","x-stream-index":"006"}},"title":"GetOrCreateCallRequest","type":"object"},"GetOrCreateCallResponse":{"nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001.001"},"created":{"type":"boolean","x-stream-index":"002"},"duration":{"type":"string","x-stream-index":"003.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001.002"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"001.004"}},"required":["call","members","own_capabilities","blocked_users","created","duration"],"title":"GetOrCreateCallResponse","type":"object"},"GoLiveRequest":{"nullable":true,"properties":{"recording_storage_name":{"type":"string","x-stream-index":"005"},"start_closed_caption":{"type":"boolean","x-stream-index":"008"},"start_hls":{"type":"boolean","x-stream-index":"003"},"start_recording":{"type":"boolean","x-stream-index":"004"},"start_transcription":{"type":"boolean","x-stream-index":"007"},"transcription_storage_name":{"type":"string","x-stream-index":"006"}},"title":"GoLiveRequest","type":"object"},"GoLiveResponse":{"description":"Basic response information","nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"}},"required":["call","duration"],"title":"Response","type":"object"},"GroupedStatsResponse":{"nullable":true,"properties":{"name":{"type":"string","x-stream-index":"001"},"unique":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["name","unique"],"type":"object"},"HLSSettingsRequest":{"properties":{"auto_on":{"type":"boolean","x-stream-index":"001"},"enabled":{"type":"boolean","x-stream-index":"002"},"layout":{"$ref":"#/components/schemas/LayoutSettingsRequest","title":"LayoutSettings","x-stream-index":"004"},"quality_tracks":{"items":{"type":"string"},"maximum":3,"minimum":1,"type":"array","x-stream-index":"003"}},"required":["quality_tracks"],"title":"HLSSettingsRequest","type":"object"},"HLSSettingsResponse":{"description":"HLSSettings is the payload for HLS settings","properties":{"auto_on":{"title":"Auto On","type":"boolean","x-stream-index":"001"},"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"002"},"layout":{"$ref":"#/components/schemas/LayoutSettingsResponse","title":"Layout","x-stream-index":"004"},"quality_tracks":{"items":{"type":"string"},"title":"Quality Tracks","type":"array","x-stream-index":"003"}},"required":["auto_on","enabled","quality_tracks","layout"],"title":"HLSSettingsResponse","type":"object"},"IngressAudioEncodingOptionsRequest":{"properties":{"bitrate":{"maximum":128000,"minimum":16000,"type":"integer","x-stream-index":"003"},"channels":{"enum":["1","2"],"format":"int32","type":"integer","x-stream-index":"001"},"enable_dtx":{"type":"boolean","x-stream-index":"002"}},"required":["channels","bitrate"],"type":"object"},"IngressAudioEncodingResponse":{"properties":{"bitrate":{"format":"int32","type":"integer","x-stream-index":"003"},"channels":{"format":"int32","type":"integer","x-stream-index":"001"},"enable_dtx":{"type":"boolean","x-stream-index":"002"}},"required":["channels","enable_dtx","bitrate"],"type":"object"},"IngressSettingsRequest":{"properties":{"audio_encoding_options":{"$ref":"#/components/schemas/IngressAudioEncodingOptionsRequest","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"video_encoding_options":{"additionalProperties":{"$ref":"#/components/schemas/IngressVideoEncodingOptionsRequest"},"type":"object","x-stream-index":"003"}},"type":"object"},"IngressSettingsResponse":{"properties":{"audio_encoding_options":{"$ref":"#/components/schemas/IngressAudioEncodingResponse","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"video_encoding_options":{"additionalProperties":{"$ref":"#/components/schemas/IngressVideoEncodingResponse"},"type":"object","x-stream-index":"003"}},"required":["enabled"],"type":"object"},"IngressVideoEncodingOptionsRequest":{"properties":{"layers":{"items":{"$ref":"#/components/schemas/IngressVideoLayerRequest"},"minimum":1,"type":"array","x-stream-index":"001"}},"required":["layers"],"type":"object"},"IngressVideoEncodingResponse":{"properties":{"layers":{"items":{"$ref":"#/components/schemas/IngressVideoLayerResponse"},"type":"array","x-stream-index":"001"}},"required":["layers"],"type":"object"},"IngressVideoLayerRequest":{"nullable":true,"properties":{"bitrate":{"format":"int32","minimum":1000,"type":"integer","x-stream-index":"002"},"codec":{"enum":["h264","vp8"],"type":"string","x-stream-index":"001"},"frame_rate_limit":{"maximum":60,"minimum":1,"type":"integer","x-stream-index":"005"},"max_dimension":{"minimum":240,"type":"integer","x-stream-index":"004"},"min_dimension":{"minimum":240,"type":"integer","x-stream-index":"003"}},"required":["codec","bitrate","min_dimension","max_dimension","frame_rate_limit"],"type":"object"},"IngressVideoLayerResponse":{"nullable":true,"properties":{"bitrate":{"type":"integer","x-stream-index":"002"},"codec":{"type":"string","x-stream-index":"001"},"frame_rate_limit":{"type":"integer","x-stream-index":"005"},"max_dimension":{"type":"integer","x-stream-index":"004"},"min_dimension":{"type":"integer","x-stream-index":"003"}},"required":["codec","bitrate","min_dimension","max_dimension","frame_rate_limit"],"type":"object"},"JoinCallAPIMetrics":{"properties":{"failures":{"format":"float","type":"number","x-stream-index":"002"},"latency":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"003"},"total":{"format":"float","type":"number","x-stream-index":"001"}},"required":["total","failures"],"type":"object"},"KickUserRequest":{"description":"KickUserRequest is the payload for kicking a user from a call. Optionally block the user as well.","nullable":true,"properties":{"block":{"description":"If true, also block the user from rejoining the call","title":"Block","type":"boolean","x-stream-index":"004"},"kicked_by":{"$ref":"#/components/schemas/UserRequest","description":"Server-side: user performing the action","title":"KickedBy","x-stream-index":"006"},"kicked_by_id":{"description":"Server-side: ID of the user performing the action","title":"KickedByID","type":"string","x-stream-index":"005"},"user_id":{"description":"The user to kick","title":"UserID","type":"string","x-stream-index":"003"}},"required":["user_id"],"title":"KickUserRequest","type":"object"},"KickUserResponse":{"description":"KickUserResponse is the payload for kicking a user from a call.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"KickUserResponse","type":"object"},"KickedUserEvent":{"description":"This event is sent to call participants to notify when a user is kicked from a call. Clients should make the kicked user leave the call UI.","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"kicked_by_user":{"$ref":"#/components/schemas/UserResponse","description":"The user that kicked the participant, null if server-side","title":"Kicked by","x-stream-index":"004"},"type":{"default":"call.kicked_user","description":"The type of event: \"call.kicked_user\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user that was kicked","title":"User","x-stream-index":"003"}},"required":["type","created_at","call_cid","user"],"title":"KickedUserEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"LayoutSettingsRequest":{"properties":{"detect_orientation":{"type":"boolean","x-stream-index":"005"},"external_app_url":{"type":"string","x-stream-index":"003"},"external_css_url":{"type":"string","x-stream-index":"004"},"name":{"enum":["spotlight","grid","single-participant","mobile","custom"],"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"required":["name"],"type":"object"},"LayoutSettingsResponse":{"properties":{"detect_orientation":{"type":"boolean","x-stream-index":"005"},"external_app_url":{"type":"string","x-stream-index":"003"},"external_css_url":{"type":"string","x-stream-index":"004"},"name":{"enum":["spotlight","grid","single-participant","mobile","custom"],"type":"string","x-stream-index":"001"},"options":{"additionalProperties":{},"type":"object","x-stream-index":"002"}},"required":["name","external_app_url","external_css_url"],"type":"object"},"LimitsSettingsRequest":{"properties":{"max_duration_seconds":{"format":"int32","minimum":0,"type":"integer","x-stream-index":"004"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"},"max_participants_exclude_owner":{"type":"boolean","x-stream-index":"003"},"max_participants_exclude_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"002"}},"type":"object"},"LimitsSettingsResponse":{"properties":{"max_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"004"},"max_participants":{"format":"int32","type":"integer","x-stream-index":"001"},"max_participants_exclude_owner":{"type":"boolean","x-stream-index":"003"},"max_participants_exclude_roles":{"items":{"type":"string"},"type":"array","x-stream-index":"002"}},"required":["max_participants_exclude_roles"],"type":"object"},"ListCallTypeResponse":{"description":"Response for ListCallType","nullable":true,"properties":{"call_types":{"additionalProperties":{"$ref":"#/components/schemas/CallTypeResponse"},"type":"object","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["call_types","duration"],"title":"ListCallTypeResponse","type":"object"},"ListDevicesResponse":{"description":"List devices response","nullable":true,"properties":{"devices":{"description":"List of devices","items":{"$ref":"#/components/schemas/DeviceResponse"},"title":"Devices","type":"array","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["devices","duration"],"title":"ListDevicesResponse","type":"object"},"ListExternalStorageResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"external_storages":{"additionalProperties":{"$ref":"#/components/schemas/ExternalStorageResponse"},"type":"object","x-stream-index":"002"}},"required":["duration","external_storages"],"title":"Response","type":"object"},"ListRecordingsResponse":{"description":"Response for listing recordings","nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"},"recordings":{"items":{"$ref":"#/components/schemas/CallRecording"},"title":"The list of recordings.","type":"array","x-stream-index":"002"}},"required":["duration","recordings"],"title":"ListRecordingsResponse","type":"object"},"ListTranscriptionsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"},"transcriptions":{"description":"List of transcriptions for the call","items":{"$ref":"#/components/schemas/CallTranscription"},"title":"Transcriptions","type":"array","x-stream-index":"002"}},"required":["duration","transcriptions"],"title":"ListTranscriptionsResponse","type":"object"},"MemberRequest":{"description":"MemberRequest is the payload for adding a member to a call.","properties":{"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"003"},"role":{"title":"Role","type":"string","x-stream-index":"002"},"user_id":{"minLength":1,"title":"User ID","type":"string","x-stream-index":"001"}},"required":["user_id"],"title":"MemberRequest","type":"object"},"MemberResponse":{"description":"MemberResponse is the payload for a member of a call.","properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"005"},"custom":{"additionalProperties":{},"description":"Custom member response data","title":"Custom","type":"object","x-stream-index":"004"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"string","x-stream-index":"007"},"role":{"title":"Role","type":"string","x-stream-index":"003"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"006"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"},"user_id":{"type":"string","x-stream-index":"002"}},"required":["user","user_id","custom","created_at","updated_at"],"title":"MemberResponse","type":"object"},"MessageStatsResponse":{"properties":{"count_over_time":{"items":{"$ref":"#/components/schemas/CountByMinuteResponse"},"type":"array","x-stream-index":"001"}},"type":"object"},"MuteUsersRequest":{"nullable":true,"properties":{"audio":{"title":"Audio","type":"boolean","x-stream-index":"005"},"mute_all_users":{"type":"boolean","x-stream-index":"003"},"muted_by":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"010"},"muted_by_id":{"type":"string","x-stream-index":"009"},"screenshare":{"title":"Screenshare","type":"boolean","x-stream-index":"007"},"screenshare_audio":{"title":"ScreenshareAudio","type":"boolean","x-stream-index":"008"},"user_ids":{"items":{"type":"string"},"title":"UserIDs","type":"array","x-stream-index":"004"},"video":{"title":"Video","type":"boolean","x-stream-index":"006"}},"title":"MuteUsersRequest","type":"object"},"MuteUsersResponse":{"description":"MuteUsersResponse is the response payload for the mute users endpoint.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"MuteUsersResponse","type":"object"},"NetworkMetricsReportResponse":{"properties":{"average_connection_time":{"format":"float","type":"number","x-stream-index":"003"},"average_jitter":{"format":"float","type":"number","x-stream-index":"002"},"average_latency":{"format":"float","type":"number","x-stream-index":"001"},"average_time_to_reconnect":{"format":"float","type":"number","x-stream-index":"004"}},"type":"object"},"NoiseCancellationSettings":{"properties":{"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode"],"type":"object"},"NotificationSettings":{"properties":{"call_live_started":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"002"},"call_missed":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"006"},"call_notification":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"004"},"call_ring":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"session_started":{"$ref":"#/components/schemas/EventNotificationSettings","x-stream-index":"003"}},"type":"object"},"OwnCapability":{"description":"All possibility of string to use","enum":["block-users","change-max-duration","create-call","create-reaction","enable-noise-cancellation","end-call","join-backstage","join-call","join-ended-call","kick-user","mute-users","pin-for-everyone","read-call","remove-call-member","screenshare","send-audio","send-video","start-broadcast-call","start-closed-captions-call","start-frame-record-call","start-record-call","start-transcription-call","stop-broadcast-call","stop-closed-captions-call","stop-frame-record-call","stop-record-call","stop-transcription-call","update-call","update-call-member","update-call-permissions","update-call-settings"],"title":"OwnCapability","type":"string"},"ParticipantCountByMinuteResponse":{"nullable":true,"properties":{"first":{"format":"int32","type":"integer","x-stream-index":"002"},"last":{"format":"int32","type":"integer","x-stream-index":"003"},"max":{"format":"int32","type":"integer","x-stream-index":"004"},"min":{"format":"int32","type":"integer","x-stream-index":"005"},"start_ts":{"format":"date-time","type":"string","x-stream-index":"001"}},"required":["start_ts","first","last","max","min"],"type":"object"},"ParticipantCountOverTimeResponse":{"properties":{"by_minute":{"items":{"$ref":"#/components/schemas/ParticipantCountByMinuteResponse"},"type":"array","x-stream-index":"001"}},"type":"object"},"ParticipantReportResponse":{"properties":{"by_browser":{"items":{"$ref":"#/components/schemas/GroupedStatsResponse"},"type":"array","x-stream-index":"008"},"by_country":{"items":{"$ref":"#/components/schemas/GroupedStatsResponse"},"type":"array","x-stream-index":"005"},"by_device":{"items":{"$ref":"#/components/schemas/GroupedStatsResponse"},"type":"array","x-stream-index":"006"},"by_operating_system":{"items":{"$ref":"#/components/schemas/GroupedStatsResponse"},"type":"array","x-stream-index":"007"},"count_over_time":{"$ref":"#/components/schemas/ParticipantCountOverTimeResponse","x-stream-index":"004"},"max_concurrent":{"format":"int32","type":"integer","x-stream-index":"003"},"publishers":{"$ref":"#/components/schemas/PublisherStatsResponse","x-stream-index":"009"},"subscribers":{"$ref":"#/components/schemas/SubscriberStatsResponse","x-stream-index":"010"},"sum":{"format":"int32","type":"integer","x-stream-index":"001"},"unique":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["sum","unique"],"type":"object"},"PerSDKUsageReport":{"nullable":true,"properties":{"by_version":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"002"},"total":{"format":"int32","type":"integer","x-stream-index":"001"}},"required":["total","by_version"],"type":"object"},"PermissionRequestEvent":{"description":"This event is sent when a user requests access to a feature on a call,\nclients receiving this event should display a permission request to the user","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"permissions":{"description":"The list of permissions requested by the user","items":{"type":"string"},"title":"Permissions","type":"array","x-stream-index":"004"},"type":{"default":"call.permission_request","description":"The type of event: \"call.permission_request\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who sent the permission request","title":"User","x-stream-index":"003"}},"required":["type","created_at","call_cid","user","permissions"],"title":"PermissionRequestEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"PinRequest":{"description":"PinRequest is the payload for pinning a message.","nullable":true,"properties":{"session_id":{"description":"the session ID of the user who pinned the message","title":"SessionID","type":"string","x-stream-index":"003"},"user_id":{"description":"the user ID of the user who pinned the message","title":"UserID","type":"string","x-stream-index":"002"}},"required":["user_id","session_id"],"title":"PinRequest","type":"object"},"PinResponse":{"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"},"PlatformDataResponse":{"properties":{"browser":{"$ref":"#/components/schemas/BrowserDataResponse","x-stream-index":"003"},"device":{"$ref":"#/components/schemas/DeviceDataResponse","x-stream-index":"002"},"os":{"$ref":"#/components/schemas/ClientOSDataResponse","x-stream-index":"001"}},"required":["os","device","browser"],"type":"object"},"PrivacySettings":{"properties":{"read_receipts":{"$ref":"#/components/schemas/ReadReceipts","x-stream-index":"002"},"typing_indicators":{"$ref":"#/components/schemas/TypingIndicators","x-stream-index":"001"}},"type":"object"},"PrivacySettingsResponse":{"type":"object"},"PublisherAllMetrics":{"properties":{"audio":{"$ref":"#/components/schemas/PublisherAudioMetrics","x-stream-index":"001"},"rtt_ms":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"003"},"video":{"$ref":"#/components/schemas/PublisherVideoMetrics","x-stream-index":"002"}},"type":"object"},"PublisherAudioMetrics":{"properties":{"jitter_ms":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"001"}},"type":"object"},"PublisherStatsResponse":{"properties":{"by_track":{"items":{"$ref":"#/components/schemas/TrackStatsResponse"},"type":"array","x-stream-index":"003"},"total":{"format":"int32","type":"integer","x-stream-index":"001"},"unique":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["total","unique"],"type":"object"},"PublisherVideoMetrics":{"properties":{"bitrate":{"$ref":"#/components/schemas/ActiveCallsBitrateStats","x-stream-index":"005"},"fps_30":{"$ref":"#/components/schemas/ActiveCallsFPSStats","x-stream-index":"002"},"frame_encoding_time_ms":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"003"},"jitter_ms":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"001"},"resolution":{"$ref":"#/components/schemas/ActiveCallsResolutionStats","x-stream-index":"004"}},"type":"object"},"PublishersMetrics":{"properties":{"all":{"$ref":"#/components/schemas/PublisherAllMetrics","x-stream-index":"001"}},"type":"object"},"PushNotificationSettingsResponse":{"properties":{"disabled":{"type":"boolean","x-stream-index":"001"},"disabled_until":{"format":"date-time","type":"string","x-stream-index":"002"}},"type":"object"},"QualityScoreReport":{"properties":{"histogram":{"items":{"$ref":"#/components/schemas/ReportByHistogramBucket"},"type":"array","x-stream-index":"001"}},"required":["histogram"],"type":"object"},"QualityScoreReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateQualityScoreReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"QueryAggregateCallStatsRequest":{"nullable":true,"properties":{"from":{"type":"string","x-stream-index":"002"},"report_types":{"items":{"type":"string"},"type":"array","x-stream-index":"004"},"to":{"type":"string","x-stream-index":"003"}},"type":"object"},"QueryAggregateCallStatsResponse":{"description":"Basic response information","nullable":true,"properties":{"call_duration_report":{"$ref":"#/components/schemas/CallDurationReportResponse","x-stream-index":"002"},"call_participant_count_report":{"$ref":"#/components/schemas/CallParticipantCountReportResponse","x-stream-index":"004"},"calls_per_day_report":{"$ref":"#/components/schemas/CallsPerDayReportResponse","x-stream-index":"003"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"network_metrics_report":{"$ref":"#/components/schemas/NetworkMetricsReportResponse","x-stream-index":"008"},"quality_score_report":{"$ref":"#/components/schemas/QualityScoreReportResponse","x-stream-index":"005"},"sdk_usage_report":{"$ref":"#/components/schemas/SDKUsageReportResponse","x-stream-index":"006"},"user_feedback_report":{"$ref":"#/components/schemas/UserFeedbackReportResponse","x-stream-index":"007"}},"required":["duration"],"title":"Response","type":"object"},"QueryCallMembersRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"002"},"id":{"maxLength":64,"type":"string","x-stream-index":"001.002"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"004.001"},"next":{"type":"string","x-stream-index":"004.002"},"prev":{"type":"string","x-stream-index":"004.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":1,"type":"array","x-stream-index":"003"},"type":{"maxLength":64,"type":"string","x-stream-index":"001.001"}},"required":["type","id"],"type":"object"},"QueryCallMembersResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["members","duration"],"title":"Response","type":"object"},"QueryCallParticipantsRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"003"}},"type":"object"},"QueryCallParticipantsResponse":{"nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001.001"},"duration":{"type":"string","x-stream-index":"004.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001.002"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"001.004"},"participants":{"description":"List of call participants","items":{"$ref":"#/components/schemas/CallParticipantResponse"},"title":"[]CallParticipantResponse","type":"array","x-stream-index":"002"},"total_participants":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["call","members","own_capabilities","blocked_users","participants","total_participants","duration"],"type":"object"},"QueryCallStatsRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"004.001"},"next":{"type":"string","x-stream-index":"004.002"},"prev":{"type":"string","x-stream-index":"004.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":2,"type":"array","x-stream-index":"002"}},"type":"object"},"QueryCallStatsResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"next":{"type":"string","x-stream-index":"003.001"},"prev":{"type":"string","x-stream-index":"003.002"},"reports":{"items":{"$ref":"#/components/schemas/CallStatsReportSummaryResponse"},"type":"array","x-stream-index":"001"}},"required":["reports","duration"],"title":"Response","type":"object"},"QueryCallsRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"title":"Filters","type":"object","x-stream-index":"003"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"006.001"},"next":{"type":"string","x-stream-index":"006.002"},"prev":{"type":"string","x-stream-index":"006.003"},"sort":{"description":"Array of sort parameters","items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":2,"title":"Sort","type":"array","x-stream-index":"004"}},"title":"QueryCallsRequest","type":"object"},"QueryCallsResponse":{"nullable":true,"properties":{"calls":{"items":{"$ref":"#/components/schemas/CallStateResponseFields"},"title":"Calls","type":"array","x-stream-index":"001"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"003.001"},"next":{"type":"string","x-stream-index":"002.001"},"prev":{"type":"string","x-stream-index":"002.002"}},"required":["calls","duration"],"title":"QueryCallsResponse","type":"object"},"QueryUserFeedbackRequest":{"nullable":true,"properties":{"filter_conditions":{"additionalProperties":{},"type":"object","x-stream-index":"001"},"limit":{"format":"int32","maximum":100,"minimum":0,"type":"integer","x-stream-index":"005.001"},"next":{"type":"string","x-stream-index":"005.002"},"prev":{"type":"string","x-stream-index":"005.003"},"sort":{"items":{"$ref":"#/components/schemas/SortParamRequest"},"maximum":2,"type":"array","x-stream-index":"002"}},"type":"object"},"QueryUserFeedbackResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"next":{"type":"string","x-stream-index":"003.001"},"prev":{"type":"string","x-stream-index":"003.002"},"user_feedback":{"items":{"$ref":"#/components/schemas/UserFeedbackResponse"},"type":"array","x-stream-index":"001"}},"required":["user_feedback","duration"],"title":"Response","type":"object"},"RTMPBroadcastRequest":{"description":"RTMPBroadcastRequest is the payload for starting an RTMP broadcast.","properties":{"layout":{"$ref":"#/components/schemas/LayoutSettingsRequest","description":"If provided, will override the call's RTMP settings layout","title":"Layout","x-stream-index":"005"},"name":{"description":"Name identifier for RTMP broadcast, must be unique in call","maxLength":255,"title":"Name","type":"string","x-stream-index":"001"},"quality":{"description":"If provided, will override the call's RTMP settings quality","enum":["360p","480p","720p","1080p","1440p","portrait-360x640","portrait-480x854","portrait-720x1280","portrait-1080x1920","portrait-1440x2560"],"title":"Quality","type":"string","x-stream-index":"004"},"stream_key":{"description":"If provided, will be appended at the end of stream_url","title":"Stream Key","type":"string","x-stream-index":"003"},"stream_url":{"description":"URL for the RTMP server to send the call to","maxLength":255,"title":"Stream URL","type":"string","x-stream-index":"002"}},"required":["name","stream_url"],"title":"RTMPBroadcastRequest","type":"object"},"RTMPIngress":{"description":"RTMP input settings","properties":{"address":{"title":"Address","type":"string","x-stream-index":"001"}},"required":["address"],"title":"RTMPIngress","type":"object"},"RTMPSettingsRequest":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettingsRequest","description":"Layout for the composed RTMP stream","title":"LayoutSettings","x-stream-index":"003"},"quality":{"description":"Resolution to set for the RTMP stream","enum":["360p","480p","720p","1080p","1440p","portrait-360x640","portrait-480x854","portrait-720x1280","portrait-1080x1920","portrait-1440x2560"],"title":"Quality","type":"string","x-stream-index":"002"}},"title":"RTMPSettingsRequest","type":"object"},"RTMPSettingsResponse":{"description":"RTMPSettingsResponse is the payload for RTMP settings","properties":{"enabled":{"title":"Enabled","type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettingsResponse","title":"Layout","x-stream-index":"003"},"quality":{"title":"Quality","type":"string","x-stream-index":"002"}},"required":["enabled","quality","layout"],"title":"RTMPSettingsResponse","type":"object"},"ReactionResponse":{"properties":{"custom":{"additionalProperties":{},"type":"object","x-stream-index":"004"},"emoji_code":{"type":"string","x-stream-index":"003"},"type":{"type":"string","x-stream-index":"002"},"user":{"$ref":"#/components/schemas/UserResponse","x-stream-index":"001"}},"required":["user","type"],"type":"object"},"ReadReceipts":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"RecordSettingsRequest":{"properties":{"audio_only":{"type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettingsRequest","title":"LayoutSettings","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"title":"Mode","type":"string","x-stream-index":"002"},"quality":{"enum":["360p","480p","720p","1080p","1440p","portrait-360x640","portrait-480x854","portrait-720x1280","portrait-1080x1920","portrait-1440x2560"],"type":"string","x-stream-index":"003"}},"required":["mode"],"title":"RecordSettingsRequest","type":"object"},"RecordSettingsResponse":{"description":"RecordSettings is the payload for recording settings","properties":{"audio_only":{"title":"Audio Only","type":"boolean","x-stream-index":"001"},"layout":{"$ref":"#/components/schemas/LayoutSettingsResponse","title":"Layout","x-stream-index":"004"},"mode":{"title":"Mode","type":"string","x-stream-index":"002"},"quality":{"title":"Quality","type":"string","x-stream-index":"003"}},"required":["audio_only","mode","quality","layout"],"title":"RecordSettingsResponse","type":"object"},"ReportByHistogramBucket":{"properties":{"category":{"type":"string","x-stream-index":"001"},"count":{"format":"int32","type":"integer","x-stream-index":"005"},"lower_bound":{"$ref":"#/components/schemas/Bound","x-stream-index":"002"},"sum":{"format":"float","type":"number","x-stream-index":"004"},"upper_bound":{"$ref":"#/components/schemas/Bound","x-stream-index":"003"}},"required":["category","sum","count"],"type":"object"},"ReportResponse":{"properties":{"call":{"$ref":"#/components/schemas/CallReportResponse","x-stream-index":"003"},"participants":{"$ref":"#/components/schemas/ParticipantReportResponse","x-stream-index":"001"},"user_ratings":{"$ref":"#/components/schemas/UserRatingReportResponse","x-stream-index":"002"}},"required":["participants","user_ratings","call"],"type":"object"},"Response":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001"}},"required":["duration"],"title":"Response","type":"object"},"RingSettingsRequest":{"properties":{"auto_cancel_timeout_ms":{"description":"When none of the callees accept a ring call in this time a rejection will be sent by the caller with reason 'timeout' by the SDKs","format":"int32","maximum":180000,"minimum":5000,"title":"AutoCancelTimeoutMs","type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"description":"When a callee is online but doesn't answer a ring call in this time a rejection will be sent with reason 'timeout' by the SDKs","format":"int32","maximum":180000,"minimum":5000,"title":"IncomingCallTimeoutMs","type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"description":"When a callee doesn't accept or reject a ring call in this time a missed call event will be sent","format":"int32","maximum":180000,"minimum":5000,"title":"MissedCallTimeoutMs","type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_timeout_ms"],"title":"RingSettingsRequest","type":"object"},"RingSettingsResponse":{"properties":{"auto_cancel_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"002"},"incoming_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"001"},"missed_call_timeout_ms":{"format":"int32","type":"integer","x-stream-index":"003"}},"required":["incoming_call_timeout_ms","auto_cancel_timeout_ms","missed_call_timeout_ms"],"type":"object"},"S3Request":{"description":"Config for creating Amazon S3 storage.","properties":{"s3_api_key":{"description":"The AWS API key. To use Amazon S3 as your storage provider, you have two authentication options: IAM role or API key. If you do not specify the `s3_api_key` parameter, Stream will use IAM role authentication. In that case make sure to have the correct IAM role configured for your application.","title":"S3ApiKey","type":"string","x-stream-index":"002"},"s3_custom_endpoint_url":{"description":"The custom endpoint for S3. If you want to use a custom endpoint, you must also provide the `s3_api_key` and `s3_secret` parameters.","title":"S3CustomEndpointURL","type":"string","x-stream-index":"004"},"s3_region":{"description":"The AWS region where the bucket is hosted","title":"S3Region","type":"string","x-stream-index":"001"},"s3_secret":{"description":"The AWS API Secret","title":"S3Secret","type":"string","x-stream-index":"003"}},"required":["s3_region"],"title":"S3Request","type":"object"},"SDKUsageReport":{"properties":{"per_sdk_usage":{"additionalProperties":{"$ref":"#/components/schemas/PerSDKUsageReport"},"type":"object","x-stream-index":"001"}},"required":["per_sdk_usage"],"type":"object"},"SDKUsageReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateSDKUsageReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"ScreensharingSettingsRequest":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"type":"object"},"ScreensharingSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled"],"type":"object"},"SendCallEventRequest":{"description":"Send a call event to the other user","nullable":true,"properties":{"custom":{"additionalProperties":{},"title":"Custom","type":"object","x-stream-index":"004"},"user":{"$ref":"#/components/schemas/UserRequest","x-stream-index":"003.002"},"user_id":{"type":"string","x-stream-index":"003.001"}},"title":"SendCallEventRequest","type":"object"},"SendCallEventResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"SendCallEventResponse","type":"object"},"SessionSettingsRequest":{"properties":{"inactivity_timeout_seconds":{"format":"int32","maximum":900,"minimum":5,"type":"integer","x-stream-index":"001"}},"required":["inactivity_timeout_seconds"],"type":"object"},"SessionSettingsResponse":{"properties":{"inactivity_timeout_seconds":{"format":"int32","maximum":900,"minimum":5,"type":"integer","x-stream-index":"001"}},"required":["inactivity_timeout_seconds"],"type":"object"},"SortParamRequest":{"nullable":true,"properties":{"direction":{"description":"Direction of sorting, 1 for Ascending, -1 for Descending, default is 1","format":"int32","title":"Direction","type":"integer","x-stream-index":"002"},"field":{"description":"Name of field to sort by","title":"Field","type":"string","x-stream-index":"001"}},"type":"object"},"StartClosedCaptionsRequest":{"nullable":true,"properties":{"enable_transcription":{"description":"Enable transcriptions along with closed captions","title":"Enable Transcription","type":"boolean","x-stream-index":"002"},"external_storage":{"description":"Which external storage to use for transcriptions (only applicable if enable_transcription is true)","title":"External Storage","type":"string","x-stream-index":"003"},"language":{"description":"The spoken language in the call, if not provided the language defined in the transcription settings will be used","enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"title":"Language","type":"string","x-stream-index":"004"}},"type":"object"},"StartClosedCaptionsResponse":{"nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"}},"required":["duration"],"type":"object"},"StartFrameRecordingRequest":{"nullable":true,"properties":{"recording_external_storage":{"type":"string","x-stream-index":"002"}},"title":"StartFrameRecordingRequest","type":"object"},"StartFrameRecordingResponse":{"description":"StartFrameRecordingResponse is the response payload for the start frame recording endpoint.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StartFrameRecordingResponse","type":"object"},"StartHLSBroadcastingRequest":{"description":"StartHLSBroadcastingRequest is the payload for starting an HLS broadcasting.","nullable":true,"title":"StartHLSBroadcastingRequest","type":"object"},"StartHLSBroadcastingResponse":{"description":"StartHLSBroadcastingResponse is the payload for starting an HLS broadcasting.","nullable":true,"properties":{"duration":{"type":"string","x-stream-index":"001.001"},"playlist_url":{"description":"the URL of the HLS playlist","title":"PlaylistURL","type":"string","x-stream-index":"002"}},"required":["duration","playlist_url"],"title":"StartHLSBroadcastingResponse","type":"object"},"StartRTMPBroadcastsRequest":{"description":"StartRTMPBroadcastsRequest is the payload for starting RTMP broadcasts.","nullable":true,"properties":{"broadcasts":{"description":"List of broadcasts to start","items":{"$ref":"#/components/schemas/RTMPBroadcastRequest"},"maximum":1,"minimum":1,"title":"Broadcasts","type":"array","x-stream-index":"002"}},"required":["broadcasts"],"title":"StartRTMPBroadcastsRequest","type":"object"},"StartRTMPBroadcastsResponse":{"description":"StartRTMPBroadcastsResponse is the payload for starting an RTMP broadcast.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StartRTMPBroadcastsResponse","type":"object"},"StartRecordingRequest":{"nullable":true,"properties":{"recording_external_storage":{"type":"string","x-stream-index":"002"}},"title":"StartRecordingRequest","type":"object"},"StartRecordingResponse":{"description":"StartRecordingResponse is the response payload for the start recording endpoint.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StartRecordingResponse","type":"object"},"StartTranscriptionRequest":{"nullable":true,"properties":{"enable_closed_captions":{"description":"Enable closed captions along with transcriptions","title":"Enable Closed Captions","type":"boolean","x-stream-index":"003"},"language":{"description":"The spoken language in the call, if not provided the language defined in the transcription settings will be used","enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"title":"Language","type":"string","x-stream-index":"004"},"transcription_external_storage":{"description":"Store transcriptions in this external storage","title":"External Storage","type":"string","x-stream-index":"002"}},"type":"object"},"StartTranscriptionResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StartTranscriptionResponse","type":"object"},"StopAllRTMPBroadcastsRequest":{"nullable":true,"title":"StopAllRTMPBroadcastsRequest","type":"object"},"StopAllRTMPBroadcastsResponse":{"nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"StopAllRTMPBroadcastsResponse","type":"object"},"StopClosedCaptionsRequest":{"nullable":true,"properties":{"stop_transcription":{"type":"boolean","x-stream-index":"003"}},"type":"object"},"StopClosedCaptionsResponse":{"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"},"StopFrameRecordingRequest":{"nullable":true,"type":"object"},"StopFrameRecordingResponse":{"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"},"StopHLSBroadcastingRequest":{"nullable":true,"type":"object"},"StopHLSBroadcastingResponse":{"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"},"StopLiveRequest":{"nullable":true,"properties":{"continue_closed_caption":{"type":"boolean","x-stream-index":"006"},"continue_hls":{"type":"boolean","x-stream-index":"003"},"continue_recording":{"type":"boolean","x-stream-index":"004"},"continue_rtmp_broadcasts":{"type":"boolean","x-stream-index":"007"},"continue_transcription":{"type":"boolean","x-stream-index":"005"}},"title":"StopLiveRequest","type":"object"},"StopLiveResponse":{"nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","description":"The call that was stopped","title":"Call","x-stream-index":"001"},"duration":{"type":"string","x-stream-index":"002.001"}},"required":["call","duration"],"title":"StopLiveResponse","type":"object"},"StopRTMPBroadcastsRequest":{"description":"Request for stopping RTMP broadcasts","nullable":true,"title":"StopRTMPBroadcastsRequest","type":"object"},"StopRTMPBroadcastsResponse":{"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"},"StopRecordingRequest":{"nullable":true,"type":"object"},"StopRecordingResponse":{"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"},"StopTranscriptionRequest":{"nullable":true,"properties":{"stop_closed_captions":{"type":"boolean","x-stream-index":"003"}},"type":"object"},"StopTranscriptionResponse":{"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"},"SubscriberAllMetrics":{"properties":{"audio":{"$ref":"#/components/schemas/SubscriberAudioMetrics","x-stream-index":"001"},"rtt_ms":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"003"},"video":{"$ref":"#/components/schemas/SubscriberVideoMetrics","x-stream-index":"002"}},"type":"object"},"SubscriberAudioMetrics":{"properties":{"concealment_pct":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"003"},"jitter_ms":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"001"},"packets_lost_pct":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"002"}},"type":"object"},"SubscriberStatsResponse":{"properties":{"total":{"format":"int32","type":"integer","x-stream-index":"001"},"total_subscribed_duration_seconds":{"format":"int32","type":"integer","x-stream-index":"003"},"unique":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["total","unique","total_subscribed_duration_seconds"],"type":"object"},"SubscriberVideoMetrics":{"properties":{"fps_30":{"$ref":"#/components/schemas/ActiveCallsFPSStats","x-stream-index":"002"},"jitter_ms":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"001"},"packets_lost_pct":{"$ref":"#/components/schemas/ActiveCallsLatencyStats","x-stream-index":"003"}},"type":"object"},"SubscribersMetrics":{"properties":{"all":{"$ref":"#/components/schemas/SubscriberAllMetrics","x-stream-index":"001"}},"type":"object"},"TargetResolution":{"properties":{"bitrate":{"format":"int32","maximum":6000000,"type":"integer","x-stream-index":"003"},"height":{"format":"int32","maximum":3840,"minimum":240,"type":"integer","x-stream-index":"002"},"width":{"format":"int32","maximum":3840,"minimum":240,"type":"integer","x-stream-index":"001"}},"required":["width","height"],"type":"object"},"ThumbnailResponse":{"properties":{"image_url":{"type":"string","x-stream-index":"001"}},"required":["image_url"],"type":"object"},"ThumbnailsSettingsRequest":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"type":"object"},"ThumbnailsSettingsResponse":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"TrackStatsResponse":{"nullable":true,"properties":{"duration_seconds":{"format":"int32","type":"integer","x-stream-index":"002"},"track_type":{"type":"string","x-stream-index":"001"}},"required":["track_type","duration_seconds"],"type":"object"},"TranscriptionSettingsRequest":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"002"},"language":{"enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"type":"string","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode"],"type":"object"},"TranscriptionSettingsResponse":{"properties":{"closed_caption_mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"002"},"language":{"enum":["auto","en","fr","es","de","it","nl","pt","pl","ca","cs","da","el","fi","id","ja","ru","sv","ta","th","tr","hu","ro","zh","ar","tl","he","hi","hr","ko","ms","no","uk","bg","et","sl","sk"],"type":"string","x-stream-index":"004"},"mode":{"enum":["available","disabled","auto-on"],"type":"string","x-stream-index":"001"}},"required":["mode","closed_caption_mode","languages","language"],"type":"object"},"TypingIndicators":{"properties":{"enabled":{"type":"boolean","x-stream-index":"001"}},"required":["enabled"],"type":"object"},"UnblockUserRequest":{"description":"UnblockUserRequest is the payload for unblocking a user.","nullable":true,"properties":{"user_id":{"description":"the user to unblock","title":"UserID","type":"string","x-stream-index":"003"}},"required":["user_id"],"title":"UnblockUserRequest","type":"object"},"UnblockUserResponse":{"description":"UnblockUserResponse is the payload for unblocking a user.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"UnblockUserResponse","type":"object"},"UnblockedUserEvent":{"description":"This event is sent when a user is unblocked on a call,\nthis can be useful to notify the user that they can now join the call again","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"type":{"default":"call.unblocked_user","description":"The type of event: \"call.unblocked_user\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user that was unblocked","title":"User","x-stream-index":"003"}},"required":["type","created_at","call_cid","user"],"title":"UnblockedUserEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"UnpinRequest":{"description":"UnpinRequest is the payload for unpinning a message.","nullable":true,"properties":{"session_id":{"description":"the session ID of the user who pinned the message","title":"SessionID","type":"string","x-stream-index":"003"},"user_id":{"description":"the user ID of the user who pinned the message","title":"UserID","type":"string","x-stream-index":"002"}},"required":["user_id","session_id"],"title":"UnpinRequest","type":"object"},"UnpinResponse":{"description":"UnpinResponse is the payload for unpinning a message.","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"}},"required":["duration"],"title":"UnpinResponse","type":"object"},"UpdateCallMembersRequest":{"description":"Update call members","nullable":true,"properties":{"remove_members":{"description":"List of userID to remove","items":{"type":"string"},"maximum":100,"title":"Remove Members","type":"array","x-stream-index":"003"},"update_members":{"description":"List of members to update or insert","items":{"$ref":"#/components/schemas/MemberRequest"},"maximum":100,"title":"Update Members","type":"array","x-stream-index":"004"}},"title":"UpdateCallMembersRequest","type":"object"},"UpdateCallMembersResponse":{"description":"Basic response information","nullable":true,"properties":{"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"001.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"002"}},"required":["duration","members"],"title":"Response","type":"object"},"UpdateCallRequest":{"description":"Request for updating a call","nullable":true,"properties":{"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"003"},"settings_override":{"$ref":"#/components/schemas/CallSettingsRequest","description":"the settings to change for this call","title":"Settings Override","x-stream-index":"004"},"starts_at":{"description":"the time the call is scheduled to start","format":"date-time","title":"Starts At","type":"string","x-stream-index":"005"}},"title":"UpdateCallRequest","type":"object"},"UpdateCallResponse":{"description":"Response for updating a call","nullable":true,"properties":{"call":{"$ref":"#/components/schemas/CallResponse","x-stream-index":"001.001"},"duration":{"type":"string","x-stream-index":"002.001"},"members":{"items":{"$ref":"#/components/schemas/MemberResponse"},"type":"array","x-stream-index":"001.002"},"own_capabilities":{"items":{"$ref":"#/components/schemas/OwnCapability"},"type":"array","x-stream-index":"001.004"}},"required":["call","members","own_capabilities","blocked_users","duration"],"title":"UpdateCallResponse","type":"object"},"UpdateCallTypeRequest":{"description":"UpdateCallTypeRequest is the payload for updating a call type.","nullable":true,"properties":{"external_storage":{"type":"string","x-stream-index":"002.004"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","x-stream-index":"002.001"},"notification_settings":{"$ref":"#/components/schemas/NotificationSettings","x-stream-index":"002.002"},"settings":{"$ref":"#/components/schemas/CallSettingsRequest","x-stream-index":"002.003"}},"title":"UpdateCallTypeRequest","type":"object"},"UpdateCallTypeResponse":{"description":"UpdateCallTypeResponse is the payload for updating a call type.","nullable":true,"properties":{"created_at":{"description":"the time the call type was created","format":"date-time","title":"CreatedAt","type":"string","x-stream-index":"001.005"},"duration":{"type":"string","x-stream-index":"002.001"},"external_storage":{"description":"the external storage for the call type","title":"ExternalStorage","type":"string","x-stream-index":"001.007"},"grants":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"the permissions granted to each role","title":"Grants","type":"object","x-stream-index":"001.002"},"name":{"description":"the name of the call type","title":"Name","type":"string","x-stream-index":"001.001"},"notification_settings":{"$ref":"#/components/schemas/NotificationSettings","description":"the notification settings for the call type","title":"NotificationSettings","x-stream-index":"001.004"},"settings":{"$ref":"#/components/schemas/CallSettingsResponse","description":"the settings for the call type","title":"Settings","x-stream-index":"001.003"},"updated_at":{"description":"the time the call type was last updated","format":"date-time","title":"UpdatedAt","type":"string","x-stream-index":"001.006"}},"required":["name","grants","settings","notification_settings","created_at","updated_at","duration"],"title":"UpdateCallTypeResponse","type":"object"},"UpdateExternalStorageRequest":{"description":"External storage","nullable":true,"properties":{"aws_s3":{"$ref":"#/components/schemas/S3Request","description":"Only required if you want to create an Amazon S3 storage","title":"AwsS3","x-stream-index":"003.004"},"azure_blob":{"$ref":"#/components/schemas/AzureRequest","description":"Only required if you want to create an Azure Blob Storage","title":"AzureBlob","x-stream-index":"003.006"},"bucket":{"description":"The name of the bucket on the service provider","title":"Bucket","type":"string","x-stream-index":"003.002"},"gcs_credentials":{"type":"string","x-stream-index":"003.005"},"path":{"description":"The path prefix to use for storing files","title":"Path","type":"string","x-stream-index":"003.003"},"storage_type":{"description":"The type of storage to use","enum":["s3","gcs","abs"],"title":"StorageType","type":"string","x-stream-index":"003.001"}},"required":["storage_type","bucket"],"title":"ExternalStorageRequest","type":"object"},"UpdateExternalStorageResponse":{"description":"Basic response information","nullable":true,"properties":{"bucket":{"type":"string","x-stream-index":"001.003"},"duration":{"description":"Duration of the request in milliseconds","title":"Duration","type":"string","x-stream-index":"002.001"},"name":{"type":"string","x-stream-index":"001.001"},"path":{"type":"string","x-stream-index":"001.004"},"type":{"enum":["s3","gcs","abs"],"type":"string","x-stream-index":"001.002"}},"required":["name","type","bucket","path","duration"],"title":"Response","type":"object"},"UpdateUserPermissionsRequest":{"nullable":true,"properties":{"grant_permissions":{"items":{"type":"string"},"type":"array","x-stream-index":"002"},"revoke_permissions":{"items":{"type":"string"},"type":"array","x-stream-index":"003"},"user_id":{"type":"string","x-stream-index":"001"}},"required":["user_id"],"type":"object"},"UpdateUserPermissionsResponse":{"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"},"UpdatedCallPermissionsEvent":{"description":"This event is sent to notify about permission changes for a user, clients receiving this event should update their UI accordingly","properties":{"call_cid":{"type":"string","x-stream-index":"002.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.002"},"own_capabilities":{"description":"The capabilities of the current user","items":{"$ref":"#/components/schemas/OwnCapability"},"title":"Own capabilities","type":"array","x-stream-index":"004"},"type":{"default":"call.permissions_updated","description":"The type of event: \"call.permissions_updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.001"},"user":{"$ref":"#/components/schemas/UserResponse","description":"The user who received the new permissions","title":"User","x-stream-index":"003"}},"required":["type","created_at","call_cid","user","own_capabilities"],"title":"UpdatedCallPermissionsEvent","type":"object","x-stream-event-call-type":true,"x-stream-event-doc-group":"call","x-stream-is-event":true,"x-stream-ws-base-event-name":"VideoEvent"},"User":{"properties":{"avg_response_time":{"format":"int32","readOnly":true,"type":"integer","x-stream-index":"046"},"ban_expires":{"format":"date-time","type":"string","x-stream-index":"017"},"banned":{"type":"boolean","x-stream-index":"016"},"created_at":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"008"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"006"},"deactivated_at":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"014"},"deleted_at":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"013"},"id":{"type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"023"},"language":{"type":"string","x-stream-index":"035"},"last_active":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"011"},"last_engaged_at":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"012"},"online":{"readOnly":true,"type":"boolean","x-stream-index":"022"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettings","x-stream-index":"026"},"revoke_tokens_issued_before":{"format":"date-time","type":"string","x-stream-index":"042"},"role":{"type":"string","x-stream-index":"004"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"036"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"005"},"updated_at":{"format":"date-time","readOnly":true,"type":"string","x-stream-index":"009"}},"required":["id","role","teams_role","custom","banned","online"],"type":"object"},"UserBannedEvent":{"properties":{"channel_id":{"type":"string","x-stream-index":"006.002"},"channel_type":{"type":"string","x-stream-index":"006.003"},"cid":{"type":"string","x-stream-index":"006.001"},"created_at":{"format":"date-time","type":"string","x-stream-index":"008.002"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"001"},"expiration":{"format":"date-time","type":"string","x-stream-index":"003"},"reason":{"type":"string","x-stream-index":"004"},"shadow":{"type":"boolean","x-stream-index":"002"},"team":{"type":"string","x-stream-index":"005.001"},"type":{"default":"user.banned","type":"string","x-stream-index":"008.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"007.001"}},"required":["created_by","shadow","cid","channel_id","channel_type","type","created_at"],"title":"UserBannedEvent","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"},"UserDeactivatedEvent":{"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"003.002"},"created_by":{"$ref":"#/components/schemas/User","x-stream-index":"001"},"type":{"default":"user.deactivated","type":"string","x-stream-index":"003.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"002.001"}},"required":["created_by","type","created_at"],"title":"UserDeactivatedEvent","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"},"UserFeedbackReport":{"properties":{"count_by_rating":{"additionalProperties":{"format":"int32","type":"integer"},"type":"object","x-stream-index":"001"},"unreported_count":{"format":"int32","type":"integer","x-stream-index":"002"}},"required":["count_by_rating","unreported_count"],"type":"object"},"UserFeedbackReportResponse":{"properties":{"daily":{"items":{"$ref":"#/components/schemas/DailyAggregateUserFeedbackReportResponse"},"type":"array","x-stream-index":"001"}},"required":["daily"],"type":"object"},"UserFeedbackResponse":{"properties":{"cid":{"type":"string","x-stream-index":"001"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"009"},"platform":{"$ref":"#/components/schemas/PlatformDataResponse","x-stream-index":"008"},"rating":{"format":"int32","type":"integer","x-stream-index":"004"},"reason":{"type":"string","x-stream-index":"005"},"sdk":{"type":"string","x-stream-index":"006"},"sdk_version":{"type":"string","x-stream-index":"007"},"session_id":{"type":"string","x-stream-index":"002"},"user_id":{"type":"string","x-stream-index":"003"}},"required":["cid","session_id","user_id","rating","reason","sdk","sdk_version","platform"],"type":"object"},"UserMutedEvent":{"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"004.002"},"target_user":{"type":"string","x-stream-index":"001"},"target_users":{"items":{"type":"string"},"type":"array","x-stream-index":"002"},"type":{"default":"user.muted","type":"string","x-stream-index":"004.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"003.001"}},"required":["type","created_at"],"title":"UserMutedEvent","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"},"UserRatingReportResponse":{"properties":{"average":{"format":"float","type":"number","x-stream-index":"002"},"count":{"format":"int32","type":"integer","x-stream-index":"001"}},"required":["count","average"],"type":"object"},"UserReactivatedEvent":{"properties":{"created_at":{"format":"date-time","type":"string","x-stream-index":"002.002"},"type":{"default":"user.reactivated","type":"string","x-stream-index":"002.001"},"user":{"$ref":"#/components/schemas/User","x-stream-index":"001"}},"required":["type","created_at"],"title":"UserReactivatedEvent","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"},"UserRequest":{"description":"User request object","properties":{"custom":{"additionalProperties":{},"description":"Custom user data","title":"Custom","type":"object","x-stream-index":"004"},"id":{"description":"User ID","title":"ID","type":"string","x-stream-index":"001"},"image":{"description":"User's profile image URL","title":"Image","type":"string","x-stream-index":"003"},"invisible":{"type":"boolean","x-stream-index":"006"},"language":{"type":"string","x-stream-index":"005"},"name":{"description":"Optional name of user","title":"Name","type":"string","x-stream-index":"002"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"007"},"role":{"description":"User's global role","title":"Role","type":"string","x-stream-index":"008"},"teams":{"description":"List of teams the user belongs to","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"010"},"teams_role":{"additionalProperties":{"type":"string"},"description":"Map of team-specific roles for the user","title":"TeamsRole","type":"object","x-stream-index":"009"}},"required":["id"],"title":"UserRequest","type":"object"},"UserResponse":{"description":"User response object","properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"ban_expires":{"description":"Date when ban expires","format":"date-time","title":"Ban expires","type":"string","x-stream-index":"003"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.017"},"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"description":"Custom data for this object","title":"Custom data","type":"object","x-stream-index":"001.004"},"deactivated_at":{"description":"Date of deactivation","format":"date-time","title":"Deactivated at","type":"string","x-stream-index":"001.016"},"deleted_at":{"description":"Date/time of deletion","format":"date-time","title":"Deleted at","type":"string","x-stream-index":"001.011"},"devices":{"description":"List of devices user is using","items":{"$ref":"#/components/schemas/DeviceResponse"},"title":"Devices","type":"array","x-stream-index":"006"},"id":{"description":"Unique user identifier","title":"ID","type":"string","x-stream-index":"001.001"},"image":{"title":"Image","type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"007"},"language":{"description":"Preferred language of a user","title":"Language","type":"string","x-stream-index":"001.005"},"last_active":{"description":"Date of last activity","format":"date-time","title":"Last active","type":"string","x-stream-index":"001.014"},"name":{"description":"Optional name of user","title":"Name","type":"string","x-stream-index":"001.002"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","description":"User privacy settings","title":"Privacy settings","x-stream-index":"005"},"push_notifications":{"$ref":"#/components/schemas/PushNotificationSettingsResponse","description":"User push notification settings","title":"Push notifications","x-stream-index":"004"},"revoke_tokens_issued_before":{"description":"Revocation date for tokens","format":"date-time","title":"Revoke tokens issued before","type":"string","x-stream-index":"001.015"},"role":{"description":"Determines the set of user permissions","title":"Role","type":"string","x-stream-index":"001.006"},"shadow_banned":{"description":"Whether a user is shadow banned","title":"Shadow banned","type":"boolean","x-stream-index":"002"},"teams":{"description":"List of teams user is a part of","items":{"type":"string"},"title":"Teams","type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"updated_at":{"description":"Date/time of the last update","format":"date-time","title":"Updated at","type":"string","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids","shadow_banned","invisible"],"title":"UserResponse","type":"object"},"UserResponsePrivacyFields":{"properties":{"avg_response_time":{"format":"int32","type":"integer","x-stream-index":"001.018"},"blocked_user_ids":{"items":{"type":"string"},"type":"array","x-stream-index":"001.017"},"created_at":{"format":"date-time","type":"string","x-stream-index":"001.009"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.004"},"deactivated_at":{"format":"date-time","type":"string","x-stream-index":"001.016"},"deleted_at":{"format":"date-time","type":"string","x-stream-index":"001.011"},"id":{"type":"string","x-stream-index":"001.001"},"image":{"type":"string","x-stream-index":"001.003"},"invisible":{"type":"boolean","x-stream-index":"003"},"language":{"type":"string","x-stream-index":"001.005"},"last_active":{"format":"date-time","type":"string","x-stream-index":"001.014"},"name":{"type":"string","x-stream-index":"001.002"},"privacy_settings":{"$ref":"#/components/schemas/PrivacySettingsResponse","x-stream-index":"002"},"revoke_tokens_issued_before":{"format":"date-time","type":"string","x-stream-index":"001.015"},"role":{"type":"string","x-stream-index":"001.006"},"teams":{"items":{"type":"string"},"type":"array","x-stream-index":"001.007"},"teams_role":{"additionalProperties":{"type":"string"},"type":"object","x-stream-index":"001.008"},"updated_at":{"format":"date-time","type":"string","x-stream-index":"001.010"}},"required":["id","custom","language","role","teams","created_at","updated_at","banned","online","blocked_user_ids"],"type":"object"},"UserUpdatedEvent":{"description":"This event is sent when a user gets updated. The event contains information about the updated user.","nullable":true,"properties":{"created_at":{"description":"Date/time of creation","format":"date-time","title":"Created at","type":"string","x-stream-index":"001.003"},"custom":{"additionalProperties":{},"type":"object","x-stream-index":"001.007"},"received_at":{"format":"date-time","type":"string","x-stream-index":"001.004"},"type":{"default":"user.updated","description":"The type of event: \"user.updated\" in this case","title":"Event Type","type":"string","x-stream-index":"001.002"},"user":{"$ref":"#/components/schemas/UserResponsePrivacyFields","description":"The updated user","title":"User","x-stream-index":"002.001"}},"required":["type","created_at","custom","user"],"title":"UserUpdatedEvent","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"},"VideoReactionOverTimeResponse":{"properties":{"by_minute":{"items":{"$ref":"#/components/schemas/CountByMinuteResponse"},"type":"array","x-stream-index":"001"}},"type":"object"},"VideoReactionsResponse":{"nullable":true,"properties":{"count_over_time":{"$ref":"#/components/schemas/VideoReactionOverTimeResponse","x-stream-index":"002"},"reaction":{"type":"string","x-stream-index":"001"}},"required":["reaction"],"type":"object"},"VideoSettingsRequest":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"camera_default_on":{"type":"boolean","x-stream-index":"004"},"camera_facing":{"enum":["front","back","external"],"type":"string","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"type":"object"},"VideoSettingsResponse":{"properties":{"access_request_enabled":{"type":"boolean","x-stream-index":"002"},"camera_default_on":{"type":"boolean","x-stream-index":"004"},"camera_facing":{"enum":["front","back","external"],"type":"string","x-stream-index":"005"},"enabled":{"type":"boolean","x-stream-index":"001"},"target_resolution":{"$ref":"#/components/schemas/TargetResolution","x-stream-index":"003"}},"required":["enabled","access_request_enabled","target_resolution","camera_default_on","camera_facing"],"type":"object"},"WebhookEvent":{"description":"The discriminator object for all webhook events, it maps events' payload to the final type","discriminator":{"mapping":{"call.accepted":"#/components/schemas/CallAcceptedEvent","call.blocked_user":"#/components/schemas/BlockedUserEvent","call.closed_caption":"#/components/schemas/ClosedCaptionEvent","call.closed_captions_failed":"#/components/schemas/CallClosedCaptionsFailedEvent","call.closed_captions_started":"#/components/schemas/CallClosedCaptionsStartedEvent","call.closed_captions_stopped":"#/components/schemas/CallClosedCaptionsStoppedEvent","call.created":"#/components/schemas/CallCreatedEvent","call.deleted":"#/components/schemas/CallDeletedEvent","call.ended":"#/components/schemas/CallEndedEvent","call.frame_recording_failed":"#/components/schemas/CallFrameRecordingFailedEvent","call.frame_recording_ready":"#/components/schemas/CallFrameRecordingFrameReadyEvent","call.frame_recording_started":"#/components/schemas/CallFrameRecordingStartedEvent","call.frame_recording_stopped":"#/components/schemas/CallFrameRecordingStoppedEvent","call.hls_broadcasting_failed":"#/components/schemas/CallHLSBroadcastingFailedEvent","call.hls_broadcasting_started":"#/components/schemas/CallHLSBroadcastingStartedEvent","call.hls_broadcasting_stopped":"#/components/schemas/CallHLSBroadcastingStoppedEvent","call.kicked_user":"#/components/schemas/KickedUserEvent","call.live_started":"#/components/schemas/CallLiveStartedEvent","call.member_added":"#/components/schemas/CallMemberAddedEvent","call.member_removed":"#/components/schemas/CallMemberRemovedEvent","call.member_updated":"#/components/schemas/CallMemberUpdatedEvent","call.member_updated_permission":"#/components/schemas/CallMemberUpdatedPermissionEvent","call.missed":"#/components/schemas/CallMissedEvent","call.moderation_blur":"#/components/schemas/CallModerationBlurEvent","call.moderation_warning":"#/components/schemas/CallModerationWarningEvent","call.notification":"#/components/schemas/CallNotificationEvent","call.permission_request":"#/components/schemas/PermissionRequestEvent","call.permissions_updated":"#/components/schemas/UpdatedCallPermissionsEvent","call.reaction_new":"#/components/schemas/CallReactionEvent","call.recording_failed":"#/components/schemas/CallRecordingFailedEvent","call.recording_ready":"#/components/schemas/CallRecordingReadyEvent","call.recording_started":"#/components/schemas/CallRecordingStartedEvent","call.recording_stopped":"#/components/schemas/CallRecordingStoppedEvent","call.rejected":"#/components/schemas/CallRejectedEvent","call.ring":"#/components/schemas/CallRingEvent","call.rtmp_broadcast_failed":"#/components/schemas/CallRtmpBroadcastFailedEvent","call.rtmp_broadcast_started":"#/components/schemas/CallRtmpBroadcastStartedEvent","call.rtmp_broadcast_stopped":"#/components/schemas/CallRtmpBroadcastStoppedEvent","call.session_ended":"#/components/schemas/CallSessionEndedEvent","call.session_participant_count_updated":"#/components/schemas/CallSessionParticipantCountsUpdatedEvent","call.session_participant_joined":"#/components/schemas/CallSessionParticipantJoinedEvent","call.session_participant_left":"#/components/schemas/CallSessionParticipantLeftEvent","call.session_started":"#/components/schemas/CallSessionStartedEvent","call.stats_report_ready":"#/components/schemas/CallStatsReportReadyEvent","call.transcription_failed":"#/components/schemas/CallTranscriptionFailedEvent","call.transcription_ready":"#/components/schemas/CallTranscriptionReadyEvent","call.transcription_started":"#/components/schemas/CallTranscriptionStartedEvent","call.transcription_stopped":"#/components/schemas/CallTranscriptionStoppedEvent","call.unblocked_user":"#/components/schemas/UnblockedUserEvent","call.updated":"#/components/schemas/CallUpdatedEvent","call.user_feedback_submitted":"#/components/schemas/CallUserFeedbackSubmittedEvent","call.user_muted":"#/components/schemas/CallUserMutedEvent","custom":"#/components/schemas/CustomVideoEvent","export.channels.error":"#/components/schemas/AsyncExportErrorEvent","export.channels.success":"#/components/schemas/AsyncExportChannelsEvent","export.users.error":"#/components/schemas/AsyncExportErrorEvent","export.users.success":"#/components/schemas/AsyncExportUsersEvent","user.banned":"#/components/schemas/UserBannedEvent","user.deactivated":"#/components/schemas/UserDeactivatedEvent","user.muted":"#/components/schemas/UserMutedEvent","user.reactivated":"#/components/schemas/UserReactivatedEvent","user.updated":"#/components/schemas/UserUpdatedEvent"},"propertyName":"type"},"oneOf":[{"$ref":"#/components/schemas/AsyncExportChannelsEvent"},{"$ref":"#/components/schemas/AsyncExportErrorEvent"},{"$ref":"#/components/schemas/AsyncExportErrorEvent"},{"$ref":"#/components/schemas/AsyncExportUsersEvent"},{"$ref":"#/components/schemas/BlockedUserEvent"},{"$ref":"#/components/schemas/CallAcceptedEvent"},{"$ref":"#/components/schemas/CallClosedCaptionsFailedEvent"},{"$ref":"#/components/schemas/CallClosedCaptionsStartedEvent"},{"$ref":"#/components/schemas/CallClosedCaptionsStoppedEvent"},{"$ref":"#/components/schemas/CallCreatedEvent"},{"$ref":"#/components/schemas/CallDeletedEvent"},{"$ref":"#/components/schemas/CallEndedEvent"},{"$ref":"#/components/schemas/CallFrameRecordingFailedEvent"},{"$ref":"#/components/schemas/CallFrameRecordingFrameReadyEvent"},{"$ref":"#/components/schemas/CallFrameRecordingStartedEvent"},{"$ref":"#/components/schemas/CallFrameRecordingStoppedEvent"},{"$ref":"#/components/schemas/CallHLSBroadcastingFailedEvent"},{"$ref":"#/components/schemas/CallHLSBroadcastingStartedEvent"},{"$ref":"#/components/schemas/CallHLSBroadcastingStoppedEvent"},{"$ref":"#/components/schemas/CallLiveStartedEvent"},{"$ref":"#/components/schemas/CallMemberAddedEvent"},{"$ref":"#/components/schemas/CallMemberRemovedEvent"},{"$ref":"#/components/schemas/CallMemberUpdatedEvent"},{"$ref":"#/components/schemas/CallMemberUpdatedPermissionEvent"},{"$ref":"#/components/schemas/CallMissedEvent"},{"$ref":"#/components/schemas/CallModerationBlurEvent"},{"$ref":"#/components/schemas/CallModerationWarningEvent"},{"$ref":"#/components/schemas/CallNotificationEvent"},{"$ref":"#/components/schemas/CallReactionEvent"},{"$ref":"#/components/schemas/CallRecordingFailedEvent"},{"$ref":"#/components/schemas/CallRecordingReadyEvent"},{"$ref":"#/components/schemas/CallRecordingStartedEvent"},{"$ref":"#/components/schemas/CallRecordingStoppedEvent"},{"$ref":"#/components/schemas/CallRejectedEvent"},{"$ref":"#/components/schemas/CallRingEvent"},{"$ref":"#/components/schemas/CallRtmpBroadcastFailedEvent"},{"$ref":"#/components/schemas/CallRtmpBroadcastStartedEvent"},{"$ref":"#/components/schemas/CallRtmpBroadcastStoppedEvent"},{"$ref":"#/components/schemas/CallSessionEndedEvent"},{"$ref":"#/components/schemas/CallSessionParticipantCountsUpdatedEvent"},{"$ref":"#/components/schemas/CallSessionParticipantJoinedEvent"},{"$ref":"#/components/schemas/CallSessionParticipantLeftEvent"},{"$ref":"#/components/schemas/CallSessionStartedEvent"},{"$ref":"#/components/schemas/CallStatsReportReadyEvent"},{"$ref":"#/components/schemas/CallTranscriptionFailedEvent"},{"$ref":"#/components/schemas/CallTranscriptionReadyEvent"},{"$ref":"#/components/schemas/CallTranscriptionStartedEvent"},{"$ref":"#/components/schemas/CallTranscriptionStoppedEvent"},{"$ref":"#/components/schemas/CallUpdatedEvent"},{"$ref":"#/components/schemas/CallUserFeedbackSubmittedEvent"},{"$ref":"#/components/schemas/CallUserMutedEvent"},{"$ref":"#/components/schemas/ClosedCaptionEvent"},{"$ref":"#/components/schemas/CustomVideoEvent"},{"$ref":"#/components/schemas/KickedUserEvent"},{"$ref":"#/components/schemas/PermissionRequestEvent"},{"$ref":"#/components/schemas/UnblockedUserEvent"},{"$ref":"#/components/schemas/UpdatedCallPermissionsEvent"},{"$ref":"#/components/schemas/UserBannedEvent"},{"$ref":"#/components/schemas/UserDeactivatedEvent"},{"$ref":"#/components/schemas/UserMutedEvent"},{"$ref":"#/components/schemas/UserReactivatedEvent"},{"$ref":"#/components/schemas/UserUpdatedEvent"}]}},"securitySchemes":{"JWT":{"description":"JWT should be always provided when stream-auth-type=jwt.\n\nUsing JWT auth request could be authenticated as user or as server-side.\n\nWhen using user authentication permission checking is going to be applied to requests based on the user that is\nperforming a request.\n\nThe `authorization` header should be a JWT string signed using the secret attached to the API key used to perform\nrequests.\n\n**WARNING** all client-side official SDK do not ship with token generation; this is to make sure that the API secret is not\nshared with an untrusted party such as a browser or a iOS/Android application. Tokens **must** be generated server-side.\nIf you wish, you can configure your application to ignore authentication (see `disable_auth_check`)\nThe JWT string must include only the user_id claim and can include any built-in JWT claim such as iat, exp as well.\n","in":"header","name":"Authorization","type":"apiKey"},"api_key":{"description":"Application API key should be always set in order to authenticate the request.","in":"query","name":"api_key","type":"apiKey"},"stream-auth-type":{"description":"Stream-Auth-Type should be always set in order to authenticate the request. Possible\nvalues: `jwt` or `anonymous`.\n\n`jwt` allows you to authenticate as a user. With this auth type you should also provide valid JWT in Authorization\nheader.\n\n`anonymous` allows you to authenticate as anonymous user. Please note that most advanced features are not available\nto anonymous users.","in":"header","name":"Stream-Auth-Type","type":"apiKey"}}},"info":{"title":"Stream API","version":"v191.1.0"},"openapi":"3.0.3","paths":{"/video/active_calls_status":{"get":{"description":"Get the current status of all active calls including metrics and summary information\n","operationId":"GetActiveCallsStatus","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetActiveCallsStatusResponse"}}},"description":"GetActiveCallsStatusResponse"},"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":"Get active calls status","tags":["product:video"]}},"/video/call/feedback":{"post":{"description":"\n","operationId":"QueryUserFeedback","parameters":[{"in":"query","name":"full","schema":{"type":"boolean","writeOnly":true,"x-stream-index":"003"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryUserFeedbackRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryUserFeedbackResponse"}}},"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":"Query user reported feedback for the calls","tags":["product:video"]}},"/video/call/members":{"post":{"description":"Query call members with filter query\n","operationId":"QueryCallMembers","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallMembersRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallMembersResponse"}}},"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":"Query call members","tags":["product:video"]}},"/video/call/stats":{"post":{"description":"\n","operationId":"QueryCallStats","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallStatsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallStatsResponse"}}},"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":"Query Call Stats","tags":["product:video"]}},"/video/call/{type}/{id}":{"get":{"description":"\n","operationId":"GetCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"query","name":"members_limit","schema":{"format":"int32","maximum":100,"minimum":0,"type":"integer","writeOnly":true,"x-stream-index":"004"}},{"in":"query","name":"ring","schema":{"type":"boolean","writeOnly":true,"x-stream-index":"005"}},{"in":"query","name":"notify","schema":{"type":"boolean","writeOnly":true,"x-stream-index":"006"}},{"in":"query","name":"video","schema":{"type":"boolean","writeOnly":true,"x-stream-index":"007"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCallResponse"}}},"description":"GetCallResponse"},"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":"Get Call","tags":["product:video"]},"patch":{"description":"\n\nSends events:\n- call.updated\n","operationId":"UpdateCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallRequest"}}},"description":"UpdateCallRequest","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallResponse"}}},"description":"UpdateCallResponse"},"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":"Update Call","tags":["product:video"]},"post":{"description":"Gets or creates a new call\n\nSends events:\n- call.created\n- call.notification\n- call.ring\n","operationId":"GetOrCreateCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrCreateCallRequest"}}},"description":"GetOrCreateCallRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrCreateCallResponse"}}},"description":"GetOrCreateCallResponse"},"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":"Get or create a call","tags":["product:video"]}},"/video/call/{type}/{id}/block":{"post":{"description":"Block a user, preventing them from joining the call until they are unblocked.\n\nSends events:\n- call.blocked_user\n","operationId":"BlockUser","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUserRequest"}}},"description":"BlockUserRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlockUserResponse"}}},"description":"BlockUserResponse"},"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":"Block user on a call","tags":["product:video"]}},"/video/call/{type}/{id}/delete":{"post":{"description":"\n\nSends events:\n- call.deleted\n","operationId":"DeleteCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCallRequest"}}},"description":"DeleteCallRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCallResponse"}}},"description":"DeleteCallResponse"},"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":"Delete Call","tags":["product:video"]}},"/video/call/{type}/{id}/event":{"post":{"description":"Sends custom event to the call\n\nSends events:\n- custom\n","operationId":"SendCallEvent","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendCallEventRequest"}}},"description":"SendCallEventRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendCallEventResponse"}}},"description":"SendCallEventResponse"},"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":"Send custom event","tags":["product:video"]}},"/video/call/{type}/{id}/feedback":{"post":{"description":"\n\nSends events:\n- call.user_feedback_submitted\n","operationId":"CollectUserFeedback","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectUserFeedbackRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectUserFeedbackResponse"}}},"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":"Collect user feedback","tags":["product:video"]}},"/video/call/{type}/{id}/go_live":{"post":{"description":"\n\nSends events:\n- call.live_started\n","operationId":"GoLive","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoLiveRequest"}}},"description":"GoLiveRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoLiveResponse"}}},"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":"Set call as live","tags":["product:video"]}},"/video/call/{type}/{id}/kick":{"post":{"description":"Kicks a user from the call. Optionally block the user from rejoining by setting block=true.\n\nSends events:\n- call.blocked_user\n- call.kicked_user\n","operationId":"KickUser","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KickUserRequest"}}},"description":"KickUserRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KickUserResponse"}}},"description":"KickUserResponse"},"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":"Kick user from a call","tags":["product:video"]}},"/video/call/{type}/{id}/mark_ended":{"post":{"description":"\n\nSends events:\n- call.ended\n","operationId":"EndCall","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EndCallResponse"}}},"description":"EndCallResponse"},"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":"End call","tags":["product:video"]}},"/video/call/{type}/{id}/members":{"post":{"description":"\n\nSends events:\n- call.member_added\n- call.member_removed\n- call.member_updated\n","operationId":"UpdateCallMembers","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallMembersRequest"}}},"description":"UpdateCallMembersRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallMembersResponse"}}},"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":"Update Call Member","tags":["product:video"]}},"/video/call/{type}/{id}/mute_users":{"post":{"description":"Mutes users in a call\n","operationId":"MuteUsers","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteUsersRequest"}}},"description":"MuteUsersRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MuteUsersResponse"}}},"description":"MuteUsersResponse"},"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":"Mute users","tags":["product:video"]}},"/video/call/{type}/{id}/participants":{"post":{"description":"Returns a list of participants connected to the call\n","operationId":"QueryCallParticipants","parameters":[{"in":"path","name":"id","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"type","required":true,"schema":{"maxLength":255,"type":"string","writeOnly":true,"x-stream-index":"002"}},{"in":"query","name":"limit","schema":{"format":"int32","maximum":100,"type":"integer","x-stream-index":"004"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallParticipantsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallParticipantsResponse"}}},"description":"Successful 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":"Query call participants","tags":["product:video"]}},"/video/call/{type}/{id}/pin":{"post":{"description":"Pins a track for all users in the call.\n","operationId":"VideoPin","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PinRequest"}}},"description":"PinRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PinResponse"}}},"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":"Pin","tags":["product:video"]}},"/video/call/{type}/{id}/recordings":{"get":{"description":"Lists recordings\n","operationId":"ListRecordings","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListRecordingsResponse"}}},"description":"ListRecordingsResponse"},"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":"List recordings","tags":["product:video"]}},"/video/call/{type}/{id}/report":{"get":{"description":"\n","operationId":"GetCallReport","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"query","name":"session_id","schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCallReportResponse"}}},"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":"Get call report","tags":["product:video"]}},"/video/call/{type}/{id}/rtmp_broadcasts":{"post":{"description":"Starts RTMP broadcasts for the provided RTMP destinations\n","operationId":"StartRTMPBroadcasts","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRTMPBroadcastsRequest"}}},"description":"StartRTMPBroadcastsRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRTMPBroadcastsResponse"}}},"description":"StartRTMPBroadcastsResponse"},"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":"Start RTMP broadcasts","tags":["product:video"]}},"/video/call/{type}/{id}/rtmp_broadcasts/stop":{"post":{"description":"Stop all RTMP broadcasts for the provided call\n","operationId":"StopAllRTMPBroadcasts","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopAllRTMPBroadcastsResponse"}}},"description":"StopAllRTMPBroadcastsResponse"},"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":"Stop all RTMP broadcasts for a call","tags":["product:video"]}},"/video/call/{type}/{id}/rtmp_broadcasts/{name}/stop":{"post":{"description":"Stop RTMP broadcasts for the provided RTMP destinations\n","operationId":"StopRTMPBroadcast","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopRTMPBroadcastsRequest"}}},"description":"StopRTMPBroadcastsRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopRTMPBroadcastsResponse"}}},"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":"Stop RTMP broadcasts","tags":["product:video"]}},"/video/call/{type}/{id}/start_broadcasting":{"post":{"description":"Starts HLS broadcasting\n","operationId":"StartHLSBroadcasting","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartHLSBroadcastingResponse"}}},"description":"StartHLSBroadcastingResponse"},"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":"Start HLS broadcasting","tags":["product:video"]}},"/video/call/{type}/{id}/start_closed_captions":{"post":{"description":"Starts closed captions\n","operationId":"StartClosedCaptions","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartClosedCaptionsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartClosedCaptionsResponse"}}},"description":"Successful 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":"Start closed captions","tags":["product:video"]}},"/video/call/{type}/{id}/start_frame_recording":{"post":{"description":"Starts frame by frame recording\n\nSends events:\n- call.frame_recording_started\n","operationId":"StartFrameRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartFrameRecordingRequest"}}},"description":"StartFrameRecordingRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartFrameRecordingResponse"}}},"description":"StartFrameRecordingResponse"},"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":"Start frame recording","tags":["product:video"]}},"/video/call/{type}/{id}/start_recording":{"post":{"description":"Starts recording\n\nSends events:\n- call.recording_started\n","operationId":"StartRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRecordingRequest"}}},"description":"StartRecordingRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRecordingResponse"}}},"description":"StartRecordingResponse"},"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":"Start recording","tags":["product:video"]}},"/video/call/{type}/{id}/start_transcription":{"post":{"description":"Starts transcription\n","operationId":"StartTranscription","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartTranscriptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartTranscriptionResponse"}}},"description":"StartTranscriptionResponse"},"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":"Start transcription","tags":["product:video"]}},"/video/call/{type}/{id}/stop_broadcasting":{"post":{"description":"Stops HLS broadcasting\n","operationId":"StopHLSBroadcasting","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopHLSBroadcastingResponse"}}},"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":"Stop HLS broadcasting","tags":["product:video"]}},"/video/call/{type}/{id}/stop_closed_captions":{"post":{"description":"Stops closed captions\n\nSends events:\n- call.transcription_stopped\n","operationId":"StopClosedCaptions","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopClosedCaptionsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopClosedCaptionsResponse"}}},"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":"Stop closed captions","tags":["product:video"]}},"/video/call/{type}/{id}/stop_frame_recording":{"post":{"description":"Stops frame recording\n\nSends events:\n- call.frame_recording_stopped\n","operationId":"StopFrameRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopFrameRecordingResponse"}}},"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":"Stop frame recording","tags":["product:video"]}},"/video/call/{type}/{id}/stop_live":{"post":{"description":"\n\nSends events:\n- call.updated\n","operationId":"StopLive","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"002.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopLiveRequest"}}},"description":"StopLiveRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopLiveResponse"}}},"description":"StopLiveResponse"},"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":"Set call as not live","tags":["product:video"]}},"/video/call/{type}/{id}/stop_recording":{"post":{"description":"Stops recording\n\nSends events:\n- call.recording_stopped\n","operationId":"StopRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopRecordingResponse"}}},"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":"Stop recording","tags":["product:video"]}},"/video/call/{type}/{id}/stop_transcription":{"post":{"description":"Stops transcription\n\nSends events:\n- call.transcription_stopped\n","operationId":"StopTranscription","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopTranscriptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopTranscriptionResponse"}}},"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":"Stop transcription","tags":["product:video"]}},"/video/call/{type}/{id}/transcriptions":{"get":{"description":"Lists transcriptions\n","operationId":"ListTranscriptions","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTranscriptionsResponse"}}},"description":"ListTranscriptionsResponse"},"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":"List transcriptions","tags":["product:video"]}},"/video/call/{type}/{id}/unblock":{"post":{"description":"Removes the block for a user on a call. The user will be able to join the call again.\n\nSends events:\n- call.unblocked_user\n","operationId":"UnblockUser","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUserRequest"}}},"description":"UnblockUserRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockUserResponse"}}},"description":"UnblockUserResponse"},"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":"Unblocks user on a call","tags":["product:video"]}},"/video/call/{type}/{id}/unpin":{"post":{"description":"Unpins a track for all users in the call.\n","operationId":"VideoUnpin","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"001.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnpinRequest"}}},"description":"UnpinRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnpinResponse"}}},"description":"UnpinResponse"},"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":"Unpin","tags":["product:video"]}},"/video/call/{type}/{id}/user_permissions":{"post":{"description":"Updates user permissions\n\nSends events:\n- call.permissions_updated\n","operationId":"UpdateUserPermissions","parameters":[{"in":"path","name":"type","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"005.001"}},{"in":"path","name":"id","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"005.002"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUserPermissionsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUserPermissionsResponse"}}},"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":"Update user permissions","tags":["product:video"]}},"/video/call/{type}/{id}/{session}/recordings/{filename}":{"delete":{"description":"Deletes recording\n","operationId":"DeleteRecording","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"path","name":"session","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"003"}},{"in":"path","name":"filename","required":true,"schema":{"maxLength":256,"type":"string","writeOnly":true,"x-stream-index":"004"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteRecordingResponse"}}},"description":"DeleteRecordingResponse"},"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":"Delete recording","tags":["product:video"]}},"/video/call/{type}/{id}/{session}/transcriptions/{filename}":{"delete":{"description":"Deletes transcription\n","operationId":"DeleteTranscription","parameters":[{"in":"path","name":"type","required":true,"schema":{"description":"The type of call","maxLength":64,"title":"Type","type":"string","writeOnly":true,"x-stream-index":"001.001"}},{"in":"path","name":"id","required":true,"schema":{"description":"Call ID","maxLength":64,"title":"ID","type":"string","writeOnly":true,"x-stream-index":"001.002"}},{"in":"path","name":"session","required":true,"schema":{"maxLength":64,"type":"string","writeOnly":true,"x-stream-index":"003"}},{"in":"path","name":"filename","required":true,"schema":{"maxLength":256,"type":"string","writeOnly":true,"x-stream-index":"004"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteTranscriptionResponse"}}},"description":"DeleteTranscriptionResponse"},"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":"Delete transcription","tags":["product:video"]}},"/video/calls":{"post":{"description":"Query calls with filter query\n","operationId":"QueryCalls","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallsRequest"}}},"description":"QueryCallsRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCallsResponse"}}},"description":"QueryCallsResponse"},"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":"Query call","tags":["product:video"]}},"/video/calltypes":{"get":{"description":"\n","operationId":"ListCallTypes","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListCallTypeResponse"}}},"description":"ListCallTypeResponse"},"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":"List Call Type","tags":["product:video"]},"post":{"description":"\n","operationId":"CreateCallType","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCallTypeRequest"}}},"description":"CreateCallTypeRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCallTypeResponse"}}},"description":"CreateCallTypeResponse"},"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":"Create Call Type","tags":["product:video"]}},"/video/calltypes/{name}":{"delete":{"description":"\n","operationId":"DeleteCallType","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete Call Type","tags":["product:video"]},"get":{"description":"\n","operationId":"GetCallType","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCallTypeResponse"}}},"description":"GetCallTypeResponse"},"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":"Get Call Type","tags":["product:video"]},"put":{"description":"\n","operationId":"UpdateCallType","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallTypeRequest"}}},"description":"UpdateCallTypeRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallTypeResponse"}}},"description":"UpdateCallTypeResponse"},"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":"Update Call Type","tags":["product:video"]}},"/video/devices":{"delete":{"description":"Deletes one device\n","operationId":"DeleteDevice","parameters":[{"in":"query","name":"id","required":true,"schema":{"description":"Device ID to delete","title":"ID","type":"string","writeOnly":true,"x-stream-index":"001"}},{"in":"query","name":"user_id","schema":{"description":"**Server-side only**. User ID which server acts upon","title":"User ID","type":"string","writeOnly":true,"x-stream-index":"002.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Delete device","tags":["product:video"]},"get":{"description":"Returns all available devices\n","operationId":"ListDevices","parameters":[{"in":"query","name":"user_id","schema":{"description":"**Server-side only**. User ID which server acts upon","title":"User ID","type":"string","writeOnly":true,"x-stream-index":"001.001"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDevicesResponse"}}},"description":"ListDevicesResponse"},"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":"List devices","tags":["product:video"]},"post":{"description":"Adds a new device to a user, if the same device already exists the call will have no effect\n","operationId":"CreateDevice","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDeviceRequest"}}},"description":"CreateDeviceRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}},"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":"Create device","tags":["product:video"]}},"/video/edges":{"get":{"description":"Returns the list of all edges available for video calls.\n","operationId":"GetEdges","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetEdgesResponse"}}},"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":"Get Edges","tags":["product:video"]}},"/video/external_storage":{"get":{"description":"Lists external storage\n","operationId":"ListExternalStorage","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListExternalStorageResponse"}}},"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":"List external storage","tags":["product:video"]},"post":{"description":"Creates new external storage\n","operationId":"CreateExternalStorage","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateExternalStorageRequest"}}},"description":"CreateExternalStorageRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateExternalStorageResponse"}}},"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":"Create external storage","tags":["product:video"]}},"/video/external_storage/{name}":{"delete":{"description":"Deletes external storage\n","operationId":"DeleteExternalStorage","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteExternalStorageResponse"}}},"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":"Delete external storage","tags":["product:video"]},"put":{"description":"\n","operationId":"UpdateExternalStorage","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"001"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateExternalStorageRequest"}}},"description":"ExternalStorageRequest","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateExternalStorageResponse"}}},"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":"Update External Storage","tags":["product:video"]}},"/video/external_storage/{name}/check":{"get":{"description":"\n","operationId":"CheckExternalStorage","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string","writeOnly":true,"x-stream-index":"002"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckExternalStorageResponse"}}},"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":"Check External Storage","tags":["product:video"]}},"/video/guest":{"post":{"description":"\n","operationId":"CreateGuest","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGuestRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGuestResponse"}}},"description":"Successful 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":"Create Guest","tags":["product:video"]}},"/video/stats":{"post":{"description":"\n","operationId":"QueryAggregateCallStats","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryAggregateCallStatsRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryAggregateCallStatsResponse"}}},"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":"Query Aggregate call Stats","tags":["product:video"]}}},"security":[{"JWT":[],"api_key":[],"stream-auth-type":[]},{"api_key":[],"stream-auth-type":[]}],"servers":[{"description":"Stream API","url":"https://chat.stream-io-api.com"}]} \ No newline at end of file diff --git a/openapi/video-openapi.yaml b/openapi/video-openapi.yaml index ebaa88f6b..b373a06c1 100644 --- a/openapi/video-openapi.yaml +++ b/openapi/video-openapi.yaml @@ -84,6 +84,20 @@ components: type: string x-stream-index: "001" type: object + ActiveCallsBitrateStats: + properties: + p10: + format: float + type: number + x-stream-index: "001" + p50: + format: float + type: number + x-stream-index: "002" + required: + - p10 + - p50 + type: object ActiveCallsFPSStats: properties: p05: @@ -134,6 +148,20 @@ components: $ref: '#/components/schemas/SubscribersMetrics' x-stream-index: "003" type: object + ActiveCallsResolutionStats: + properties: + p10: + format: float + type: number + x-stream-index: "001" + p50: + format: float + type: number + x-stream-index: "002" + required: + - p10 + - p50 + type: object ActiveCallsSummary: properties: active_calls: @@ -2803,7 +2831,7 @@ components: x-stream-index: "001.002" type: default: call.updated - description: 'The type of event: "call.ended" in this case' + description: 'The type of event: "call.updated" in this case' title: Event Type type: string x-stream-index: "001.001" @@ -4259,6 +4287,86 @@ components: - total - failures type: object + KickUserRequest: + description: KickUserRequest is the payload for kicking a user from a call. + Optionally block the user as well. + nullable: true + properties: + block: + description: If true, also block the user from rejoining the call + title: Block + type: boolean + x-stream-index: "004" + kicked_by: + $ref: '#/components/schemas/UserRequest' + description: 'Server-side: user performing the action' + title: KickedBy + x-stream-index: "006" + kicked_by_id: + description: 'Server-side: ID of the user performing the action' + title: KickedByID + type: string + x-stream-index: "005" + user_id: + description: The user to kick + title: UserID + type: string + x-stream-index: "003" + required: + - user_id + title: KickUserRequest + type: object + KickUserResponse: + description: KickUserResponse is the payload for kicking a user from a call. + nullable: true + properties: + duration: + description: Duration of the request in milliseconds + title: Duration + type: string + x-stream-index: "001.001" + required: + - duration + title: KickUserResponse + type: object + KickedUserEvent: + description: This event is sent to call participants to notify when a user is + kicked from a call. Clients should make the kicked user leave the call UI. + properties: + call_cid: + type: string + x-stream-index: "002.001" + created_at: + format: date-time + type: string + x-stream-index: "001.002" + kicked_by_user: + $ref: '#/components/schemas/UserResponse' + description: The user that kicked the participant, null if server-side + title: Kicked by + x-stream-index: "004" + type: + default: call.kicked_user + description: 'The type of event: "call.kicked_user" in this case' + title: Event Type + type: string + x-stream-index: "001.001" + user: + $ref: '#/components/schemas/UserResponse' + description: The user that was kicked + title: User + x-stream-index: "003" + required: + - type + - created_at + - call_cid + - user + title: KickedUserEvent + type: object + x-stream-event-call-type: true + x-stream-event-doc-group: call + x-stream-is-event: true + x-stream-ws-base-event-name: VideoEvent LayoutSettingsRequest: properties: detect_orientation: @@ -4635,6 +4743,7 @@ components: - join-backstage - join-call - join-ended-call + - kick-user - mute-users - pin-for-everyone - read-call @@ -4900,6 +5009,9 @@ components: type: object PublisherVideoMetrics: properties: + bitrate: + $ref: '#/components/schemas/ActiveCallsBitrateStats' + x-stream-index: "005" fps_30: $ref: '#/components/schemas/ActiveCallsFPSStats' x-stream-index: "002" @@ -4909,6 +5021,9 @@ components: jitter_ms: $ref: '#/components/schemas/ActiveCallsLatencyStats' x-stream-index: "001" + resolution: + $ref: '#/components/schemas/ActiveCallsResolutionStats' + x-stream-index: "004" type: object PublishersMetrics: properties: @@ -7470,6 +7585,7 @@ components: call.hls_broadcasting_failed: '#/components/schemas/CallHLSBroadcastingFailedEvent' call.hls_broadcasting_started: '#/components/schemas/CallHLSBroadcastingStartedEvent' call.hls_broadcasting_stopped: '#/components/schemas/CallHLSBroadcastingStoppedEvent' + call.kicked_user: '#/components/schemas/KickedUserEvent' call.live_started: '#/components/schemas/CallLiveStartedEvent' call.member_added: '#/components/schemas/CallMemberAddedEvent' call.member_removed: '#/components/schemas/CallMemberRemovedEvent' @@ -7570,6 +7686,7 @@ components: - $ref: '#/components/schemas/CallUserMutedEvent' - $ref: '#/components/schemas/ClosedCaptionEvent' - $ref: '#/components/schemas/CustomVideoEvent' + - $ref: '#/components/schemas/KickedUserEvent' - $ref: '#/components/schemas/PermissionRequestEvent' - $ref: '#/components/schemas/UnblockedUserEvent' - $ref: '#/components/schemas/UpdatedCallPermissionsEvent' @@ -7619,7 +7736,7 @@ components: type: apiKey info: title: Stream API - version: v187.13.0 + version: v191.1.0 openapi: 3.0.3 paths: /video/active_calls_status: @@ -8251,6 +8368,65 @@ paths: summary: Set call as live tags: - product:video + /video/call/{type}/{id}/kick: + post: + description: | + Kicks a user from the call. Optionally block the user from rejoining by setting block=true. + + Sends events: + - call.blocked_user + - call.kicked_user + operationId: KickUser + parameters: + - in: path + name: type + required: true + schema: + description: The type of call + maxLength: 64 + title: Type + type: string + writeOnly: true + x-stream-index: "002.001" + - in: path + name: id + required: true + schema: + description: Call ID + maxLength: 64 + title: ID + type: string + writeOnly: true + x-stream-index: "002.002" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/KickUserRequest' + description: KickUserRequest + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/KickUserResponse' + description: KickUserResponse + "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: Kick user from a call + tags: + - product:video /video/call/{type}/{id}/mark_ended: post: description: |2